X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FTocBackend.cpp;h=4bb91816e89aca3906af2a5931ce690a24800072;hb=c7d29be153debac82e3d2e8865fcc849f0a5f40d;hp=ba72b747b99aa7db9162051b19f310ee4cd84ccd;hpb=6725b2db59fbc23f08962c187c5aac283fe9efbb;p=lyx.git diff --git a/src/TocBackend.cpp b/src/TocBackend.cpp index ba72b747b9..4bb91816e8 100644 --- a/src/TocBackend.cpp +++ b/src/TocBackend.cpp @@ -6,6 +6,7 @@ * \author Jean-Marc Lasgouttes * \author Angus Leeming * \author Abdelrazak Younes + * \author Guillaume Munch * * Full author contact details are available in file CREDITS. */ @@ -16,62 +17,64 @@ #include "Buffer.h" #include "BufferParams.h" -#include "debug.h" -#include "FloatList.h" -#include "FuncRequest.h" +#include "IndicesList.h" #include "InsetList.h" -#include "Layout.h" -#include "LyXAction.h" #include "Paragraph.h" +#include "TextClass.h" -#include "insets/InsetOptArg.h" +#include "insets/InsetArgument.h" -#include "support/convert.h" +#include "support/debug.h" +#include "support/docstream.h" +#include "support/gettext.h" +#include "support/lassert.h" +#include "support/lstrings.h" + +using namespace std; -using std::string; namespace lyx { + /////////////////////////////////////////////////////////////////////////// // // TocItem implementation // /////////////////////////////////////////////////////////////////////////// -TocItem::TocItem(ParConstIterator const & par_it, int d, - docstring const & s) - : par_it_(par_it), depth_(d), str_(s) +TocItem::TocItem(DocIterator const & dit, int d, docstring const & s, + bool output_active, FuncRequest action) + : dit_(dit), depth_(d), str_(s), output_(output_active), + action_(action) { } int TocItem::id() const { - return par_it_->id(); -} - - -int TocItem::depth() const -{ - return depth_; -} - - -docstring const & TocItem::str() const -{ - return str_; + return dit_.paragraph().id(); } docstring const TocItem::asString() const { - return docstring(4 * depth_, ' ') + str_; + static char_type const cross = 0x2716; // ✖ U+2716 HEAVY MULTIPLICATION X + static char_type const thin = 0x2009; // U+2009 THIN SPACE + docstring prefix; + if (!output_) { + prefix += cross; + prefix += thin; + } + return prefix + str_; } FuncRequest TocItem::action() const { - return FuncRequest(LFUN_PARAGRAPH_GOTO, convert(id())); + if (action_.action() == LFUN_UNKNOWN_ACTION) { + return FuncRequest(LFUN_PARAGRAPH_GOTO, dit_.paragraphGotoArgument()); + } else + return action_; } @@ -81,160 +84,240 @@ FuncRequest TocItem::action() const // /////////////////////////////////////////////////////////////////////////// -Toc const & TocBackend::toc(std::string const & type) const +Toc::const_iterator TocBackend::findItem(Toc const & toc, + DocIterator const & dit) +{ + Toc::const_iterator last = toc.begin(); + Toc::const_iterator it = toc.end(); + if (it == last) + return it; + --it; + DocIterator dit_text = dit.getInnerText(); + + for (; it != last; --it) { + // We verify that we don't compare contents of two + // different document. This happens when you + // have parent and child documents. + if (&it->dit()[0].inset() != &dit_text[0].inset()) + continue; + if (it->dit() <= dit_text) + return it; + } + + // We are before the first Toc Item: + return last; +} + + +Toc::iterator TocBackend::findItem(Toc & toc, int depth, docstring const & str) +{ + if (toc.empty()) + return toc.end(); + Toc::iterator it = toc.begin(); + Toc::iterator itend = toc.end(); + for (; it != itend; ++it) { + if (it->depth() == depth && it->str() == str) + break; + } + return it; +} + + +shared_ptr TocBackend::toc(string const & type) const { // Is the type already supported? TocList::const_iterator it = tocs_.find(type); - BOOST_ASSERT(it != tocs_.end()); - + LASSERT(it != tocs_.end(), { return make_shared(); }); return it->second; } -void TocBackend::updateItem(ParConstIterator const & par_it) +shared_ptr TocBackend::toc(string const & type) +{ + // std::map::insert only really performs the insertion if the key is not + // already bound, and otherwise returns an iterator to the element already + // there, see manual. + return tocs_.insert({type, make_shared()}).first->second; +} + + +TocBuilder & TocBackend::builder(string const & type) { - if (toc("tableofcontents").empty()) { - // FIXME: should not happen, + auto p = make_unique(toc(type)); + return * builders_.insert(make_pair(type, move(p))).first->second; +} + + +// FIXME: This function duplicates functionality from InsetText::iterateForToc. +// Both have their own way of computing the TocItem for "tableofcontents". The +// TocItem creation and update should be made in a dedicated function and +// updateItem should be rewritten to uniformly update the matching items from +// all TOCs. +bool TocBackend::updateItem(DocIterator const & dit_in) +{ + // we need a text + DocIterator dit = dit_in.getInnerText(); + + if (dit.text()->getTocLevel(dit.pit()) == Layout::NOT_IN_TOC) + return false; + + if (toc("tableofcontents")->empty()) { + // FIXME: should not happen, // a call to TocBackend::update() is missing somewhere - lyxerr << "TocBackend::updateItem called but the TOC is empty!" - << std::endl; - return; + LYXERR0("TocBackend::updateItem called but the TOC is empty!"); + return false; } BufferParams const & bufparams = buffer_->params(); - const int min_toclevel = bufparams.getTextClass().min_toclevel(); + const int min_toclevel = bufparams.documentClass().min_toclevel(); - TocIterator toc_item = item("tableofcontents", par_it); + Toc::const_iterator toc_item = item("tableofcontents", dit); docstring tocstring; // For each paragraph, traverse its insets and let them add // their toc items - InsetList::const_iterator it = toc_item->par_it_->insetList().begin(); - InsetList::const_iterator end = toc_item->par_it_->insetList().end(); - for (; it != end; ++it) { - Inset & inset = *it->inset; - if (inset.lyxCode() == OPTARG_CODE) { + // + // FIXME: This is supposed to accomplish the same as the body of + // InsetText::iterateForToc(), probably + Paragraph & par = toc_item->dit().paragraph(); + for (auto const & table : par.insetList()) + if (InsetArgument const * arg = table.inset->asInsetArgument()) { + tocstring = par.labelString(); if (!tocstring.empty()) - break; - Paragraph const & par = - *static_cast(inset).paragraphs().begin(); - if (!toc_item->par_it_->getLabelstring().empty()) - tocstring = toc_item->par_it_->getLabelstring() + ' '; - tocstring += par.asString(*buffer_, false); + tocstring += ' '; + arg->text().forOutliner(tocstring,TOC_ENTRY_LENGTH); break; } - } - int const toclevel = toc_item->par_it_->layout()->toclevel; - if (toclevel != Layout::NOT_IN_TOC - && toclevel >= min_toclevel + int const toclevel = toc_item->dit().text()-> + getTocLevel(toc_item->dit().pit()); + if (toclevel != Layout::NOT_IN_TOC && toclevel >= min_toclevel && tocstring.empty()) - tocstring = toc_item->par_it_->asString(*buffer_, true); + par.forOutliner(tocstring, TOC_ENTRY_LENGTH); + + support::truncateWithEllipsis(tocstring, TOC_ENTRY_LENGTH); + const_cast(*toc_item).str(tocstring); - const_cast(*toc_item).str_ = tocstring; + buffer_->updateTocItem("tableofcontents", dit); + return true; } -void TocBackend::update() +void TocBackend::update(bool output_active, UpdateType utype) { + for (TocList::iterator it = tocs_.begin(); it != tocs_.end(); ++it) + it->second->clear(); tocs_.clear(); - - BufferParams const & bufparams = buffer_->params(); - const int min_toclevel = bufparams.getTextClass().min_toclevel(); - - Toc & toc = tocs_["tableofcontents"]; - ParConstIterator pit = buffer_->par_iterator_begin(); - ParConstIterator end = buffer_->par_iterator_end(); - for (; pit != end; ++pit) { - - // the string that goes to the toc (could be the optarg) - docstring tocstring; - - // For each paragraph, traverse its insets and let them add - // their toc items - InsetList::const_iterator it = pit->insetList().begin(); - InsetList::const_iterator end = pit->insetList().end(); - for (; it != end; ++it) { - Inset & inset = *it->inset; - inset.addToToc(tocs_, *buffer_, pit); - switch (inset.lyxCode()) { - case OPTARG_CODE: { - if (!tocstring.empty()) - break; - Paragraph const & par = - *static_cast(inset).paragraphs().begin(); - if (!pit->getLabelstring().empty()) - tocstring = pit->getLabelstring() + ' '; - tocstring += par.asString(*buffer_, false); - break; - } - default: - break; - } - } - - /// now the toc entry for the paragraph - int const toclevel = pit->layout()->toclevel; - if (toclevel != Layout::NOT_IN_TOC - && toclevel >= min_toclevel) { - // insert this into the table of contents - if (tocstring.empty()) - tocstring = pit->asString(*buffer_, true); - toc.push_back(TocItem(pit, toclevel - min_toclevel, - tocstring)); - } + builders_.clear(); + resetOutlinerNames(); + if (!buffer_->isInternal()) { + DocIterator dit; + buffer_->inset().addToToc(dit, output_active, utype, *this); } } -TocIterator const TocBackend::item(std::string const & type, - ParConstIterator const & par_it) const +Toc::const_iterator TocBackend::item(string const & type, + DocIterator const & dit) const { TocList::const_iterator toclist_it = tocs_.find(type); // Is the type supported? - BOOST_ASSERT(toclist_it != tocs_.end()); + // We will try to make the best of it in release mode + LASSERT(toclist_it != tocs_.end(), toclist_it = tocs_.begin()); + return findItem(*toclist_it->second, dit); +} - Toc const & toc_vector = toclist_it->second; - TocIterator last = toc_vector.begin(); - TocIterator it = toc_vector.end(); - if (it == last) - return it; - --it; +void TocBackend::writePlaintextTocList(string const & type, + odocstringstream & os, size_t max_length) const +{ + TocList::const_iterator cit = tocs_.find(type); + if (cit != tocs_.end()) { + Toc::const_iterator ccit = cit->second->begin(); + Toc::const_iterator end = cit->second->end(); + for (; ccit != end; ++ccit) { + os << ccit->asString() << from_utf8("\n"); + if (os.str().size() > max_length) + break; + } + } +} - ParConstIterator par_it_text = par_it; - if (par_it_text.inMathed()) - // It would be better to do - // par_it_text.backwardInset(); - // but this method does not exist. - while (par_it_text.inMathed()) - par_it_text.backwardPos(); - for (; it != last; --it) { - // We verify that we don't compare contents of two - // different document. This happens when you - // have parent and child documents. - if (&it->par_it_[0].inset() != &par_it_text[0].inset()) - continue; - if (it->par_it_ <= par_it_text) - return it; +docstring TocBackend::outlinerName(string const & type) const +{ + map::const_iterator const it + = outliner_names_.find(type); + if (it != outliner_names_.end()) + return it->second; + + // Legacy treatment of index:... type + if (support::prefixIs(type, "index:")) { + string const itype = support::split(type, ':'); + IndicesList const & indiceslist = buffer_->params().indiceslist(); + Index const * index = indiceslist.findShortcut(from_utf8(itype)); + docstring indextype = _("unknown type!"); + if (index) + indextype = index->index(); + return support::bformat(_("Index Entries (%1$s)"), indextype); } - // We are before the first Toc Item: - return last; + LYXERR0("Missing OutlinerName for " << type << "!"); + return from_utf8(type); } -void TocBackend::writePlaintextTocList(string const & type, odocstream & os) const +void TocBackend::resetOutlinerNames() { - TocList::const_iterator cit = tocs_.find(type); - if (cit != tocs_.end()) { - TocIterator ccit = cit->second.begin(); - TocIterator end = cit->second.end(); - for (; ccit != end; ++ccit) - os << ccit->asString() << '\n'; - } + outliner_names_.clear(); + // names from this document class + for (pair const & name + : buffer_->params().documentClass().outlinerNames()) + addName(name.first, translateIfPossible(name.second)); + // Hardcoded types + addName("tableofcontents", _("Table of Contents")); + addName("change", _("Changes")); + addName("senseless", _("Senseless")); + addName("citation", _("Citations")); + addName("label", _("Labels and References")); + // Customizable, but the corresponding insets have no layout definition + addName("child", _("Child Documents")); + addName("graphics", _("Graphics")); + addName("equation", _("Equations")); + addName("external", _("External Material")); + addName("math-macro", _("Math Macros")); + addName("nomencl", _("Nomenclature Entries")); +} + + +void TocBackend::addName(string const & type, docstring const & name) +{ + if (name.empty()) + return; + // only inserts if the key does not exist + outliner_names_.insert({type, name}); +} + + +bool TocBackend::isOther(std::string const & type) +{ + return type == "graphics" + || type == "note" + || type == "branch" + || type == "change" + || type == "label" + || type == "citation" + || type == "equation" + || type == "footnote" + || type == "marginalnote" + || type == "nomencl" + || type == "listings" + || type == "math-macro" + || type == "external" + || type == "senseless" + || type == "index" + || type.substr(0,6) == "index:"; }