X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FTocBackend.cpp;h=dc347a6539bf26ae192ddf8eb29142f66f93fb92;hb=28be7d552f62cc02fa86d7f79201d089bfb2d7b5;hp=6ce5f4044bef194c450b62631464e963d7c51679;hpb=5731e7faae567496abb147d1edcad244b321a7a5;p=lyx.git diff --git a/src/TocBackend.cpp b/src/TocBackend.cpp index 6ce5f4044b..dc347a6539 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,36 +17,35 @@ #include "Buffer.h" #include "BufferParams.h" -#include "FloatList.h" -#include "FuncRequest.h" +#include "IndicesList.h" #include "InsetList.h" -#include "Layout.h" -#include "LyXAction.h" #include "Paragraph.h" -#include "ParIterator.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; namespace lyx { + /////////////////////////////////////////////////////////////////////////// // // TocItem implementation // /////////////////////////////////////////////////////////////////////////// -TocItem::TocItem(DocIterator const & dit, int d, docstring const & s) - : dit_(dit), 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) { } @@ -56,29 +56,25 @@ int TocItem::id() const } -int TocItem::depth() const -{ - return depth_; -} - - -docstring const & TocItem::str() const -{ - return str_; -} - - 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 { - string const arg = convert(dit_.paragraph().id()) - + ' ' + convert(dit_.pos()); - return FuncRequest(LFUN_PARAGRAPH_GOTO, arg); + if (action_.action() == LFUN_UNKNOWN_ACTION) { + return FuncRequest(LFUN_PARAGRAPH_GOTO, dit_.paragraphGotoArgument()); + } else + return action_; } @@ -88,28 +84,84 @@ FuncRequest TocItem::action() const // /////////////////////////////////////////////////////////////////////////// -Toc const & TocBackend::toc(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); - LASSERT(it != tocs_.end(), /**/); - + LASSERT(it != tocs_.end(), { return make_shared(); }); return it->second; } -Toc & TocBackend::toc(string const & type) +shared_ptr TocBackend::toc(string const & type) { - return tocs_[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; } -bool TocBackend::updateItem(DocIterator const & dit) +TocBuilder & TocBackend::builder(string const & type) { - if (dit.paragraph().layout().toclevel == Layout::NOT_IN_TOC) + 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()) { + if (toc("tableofcontents")->empty()) { // FIXME: should not happen, // a call to TocBackend::update() is missing somewhere LYXERR0("TocBackend::updateItem called but the TOC is empty!"); @@ -119,98 +171,153 @@ bool TocBackend::updateItem(DocIterator const & dit) BufferParams const & bufparams = buffer_->params(); const int min_toclevel = bufparams.documentClass().min_toclevel(); - TocIterator toc_item = item("tableofcontents", dit); + Toc::const_iterator toc_item = item("tableofcontents", dit); docstring tocstring; // For each paragraph, traverse its insets and let them add // their toc items - Paragraph & par = toc_item->dit_.paragraph(); - InsetList::const_iterator it = par.insetList().begin(); - InsetList::const_iterator end = par.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 & inset_par = - *static_cast(inset).paragraphs().begin(); - if (!par.labelString().empty()) - tocstring = par.labelString() + ' '; - tocstring += inset_par.asString(); + tocstring += ' '; + arg->text().forOutliner(tocstring,TOC_ENTRY_LENGTH); break; } - } - int const toclevel = par.layout().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 = par.asString(AS_STR_LABEL); + par.forOutliner(tocstring, TOC_ENTRY_LENGTH); - const_cast(*toc_item).str_ = tocstring; + support::truncateWithEllipsis(tocstring, TOC_ENTRY_LENGTH); + 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(); - DocIterator dit; - buffer_->inset().addToToc(dit); + builders_.clear(); + resetOutlinerNames(); + if (!buffer_->isInternal()) { + DocIterator dit; + buffer_->inset().addToToc(dit, output_active, utype, *this); + } } -TocIterator TocBackend::item(string const & type, - DocIterator const & dit) 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? - LASSERT(toclist_it != tocs_.end(), /**/); - return toclist_it->second.item(dit); + // 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); } -TocIterator Toc::item(DocIterator const & dit) const +void TocBackend::writePlaintextTocList(string const & type, + odocstringstream & os, size_t max_length) const { - TocIterator last = begin(); - TocIterator it = end(); - if (it == last) - return it; + 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; + } + } +} - --it; - DocIterator dit_text = dit; - if (dit_text.inMathed()) { - // We are only interested in text so remove the math CursorSlice. - while (dit_text.inMathed()) - dit_text.pop_back(); +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); } - 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; - } + LYXERR0("Missing OutlinerName for " << type << "!"); + return from_utf8(type); +} - // We are before the first Toc Item: - return last; + +void TocBackend::resetOutlinerNames() +{ + 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::writePlaintextTocList(string const & type, odocstream & os) const +void TocBackend::addName(string const & type, docstring const & name) { - 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() << from_utf8("\n"); - } + 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:"; }