X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FTocBackend.cpp;h=dc347a6539bf26ae192ddf8eb29142f66f93fb92;hb=268ae66e3c7df04effc329373dc887715d9c6f06;hp=f0750c61bda9ac16a2a84a73ce3158ebf5b366d9;hpb=d5a5fbb8ee87d4a8ae1c55f9ba72819251bb6fb7;p=lyx.git diff --git a/src/TocBackend.cpp b/src/TocBackend.cpp index f0750c61bd..dc347a6539 100644 --- a/src/TocBackend.cpp +++ b/src/TocBackend.cpp @@ -17,22 +17,18 @@ #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/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; @@ -47,9 +43,9 @@ namespace lyx { /////////////////////////////////////////////////////////////////////////// TocItem::TocItem(DocIterator const & dit, int d, docstring const & s, - bool output_active, docstring const & t, FuncRequest action) : - dit_(dit), depth_(d), str_(s), tooltip_(t), output_(output_active), - action_(action) + bool output_active, FuncRequest action) + : dit_(dit), depth_(d), str_(s), output_(output_active), + action_(action) { } @@ -60,38 +56,23 @@ int TocItem::id() const } -docstring const & TocItem::tooltip() const -{ - return tooltip_.empty() ? str_ : tooltip_; -} - - docstring const TocItem::asString() const { - // U+2327 X IN A RECTANGLE BOX - // char_type const cross = 0x2327; - // U+274E NEGATIVE SQUARED CROSS MARK - char_type const cross = 0x274e; + 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 += " "; + prefix += thin; } return prefix + str_; } -// convert a DocIterator into an argument to LFUN_PARAGRAPH_GOTO -docstring paragraph_goto_arg(DocIterator const & dit) -{ - CursorSlice const & s = dit.innerTextSlice(); - return convert(s.paragraph().id()) + ' ' + - convert(s.pos()); -} FuncRequest TocItem::action() const { if (action_.action() == LFUN_UNKNOWN_ACTION) { - return FuncRequest(LFUN_PARAGRAPH_GOTO, paragraph_goto_arg(dit_)); + return FuncRequest(LFUN_PARAGRAPH_GOTO, dit_.paragraphGotoArgument()); } else return action_; } @@ -99,33 +80,27 @@ FuncRequest TocItem::action() const /////////////////////////////////////////////////////////////////////////// // -// Toc implementation +// TocBackend implementation // /////////////////////////////////////////////////////////////////////////// -TocIterator Toc::item(DocIterator const & dit) const +Toc::const_iterator TocBackend::findItem(Toc const & toc, + DocIterator const & dit) { - TocIterator last = begin(); - TocIterator it = end(); + Toc::const_iterator last = toc.begin(); + Toc::const_iterator it = toc.end(); if (it == last) return it; - --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(); - } + 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()) + if (&it->dit()[0].inset() != &dit_text[0].inset()) continue; - if (it->dit_ <= dit_text) + if (it->dit() <= dit_text) return it; } @@ -134,12 +109,12 @@ TocIterator Toc::item(DocIterator const & dit) const } -Toc::iterator Toc::item(int depth, docstring const & str) +Toc::iterator TocBackend::findItem(Toc & toc, int depth, docstring const & str) { - if (empty()) - return end(); - iterator it = begin(); - iterator itend = end(); + 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; @@ -148,92 +123,6 @@ Toc::iterator Toc::item(int depth, docstring const & str) } -/////////////////////////////////////////////////////////////////////////// -// -// TocBuilder implementation -// -/////////////////////////////////////////////////////////////////////////// - -TocBuilder::TocBuilder(shared_ptr toc) - : toc_(toc ? toc : make_shared()), - stack_() -{ - LATTEST(toc); -} - -void TocBuilder::pushItem(DocIterator const & dit, docstring const & s, - bool output_active, bool is_captioned) -{ - toc_->push_back(TocItem(dit, stack_.size(), s, output_active)); - frame f = { - toc_->size() - 1, //pos - is_captioned, //is_captioned - }; - stack_.push(f); -} - -void TocBuilder::captionItem(DocIterator const & dit, docstring const & s, - bool output_active) -{ - // first show the float before moving to the caption - docstring arg = "paragraph-goto " + paragraph_goto_arg(dit); - if (!stack_.empty()) - arg = "paragraph-goto " + - paragraph_goto_arg((*toc_)[stack_.top().pos].dit_) + ";" + arg; - FuncRequest func(LFUN_COMMAND_SEQUENCE, arg); - - if (!stack_.empty() && !stack_.top().is_captioned) { - // The float we entered has not yet been assigned a caption. - // Assign the caption string to it. - TocItem & captionable = (*toc_)[stack_.top().pos]; - captionable.str(s); - captionable.setAction(func); - stack_.top().is_captioned = true; - } else { - // This is a new entry. - pop(); - // the dit is at the float's level, e.g. for the contextual menu of - // outliner entries - DocIterator captionable_dit = dit; - captionable_dit.pop_back(); - pushItem(captionable_dit, s, output_active, true); - (*toc_)[stack_.top().pos].setAction(func); - } -} - -void TocBuilder::pop() -{ - if (!stack_.empty()) - stack_.pop(); -} - - - -/////////////////////////////////////////////////////////////////////////// -// -// TocBuilderStore implementation -// -/////////////////////////////////////////////////////////////////////////// - -shared_ptr TocBuilderStore::get(string const & type, - shared_ptr toc) -{ - map_t::const_iterator it = map_.find(type); - if (it == map_.end()) { - it = map_.insert(std::make_pair(type, - make_shared(toc))).first; - } - return it->second; -} - - - -/////////////////////////////////////////////////////////////////////////// -// -// TocBackend implementation -// -/////////////////////////////////////////////////////////////////////////// - shared_ptr TocBackend::toc(string const & type) const { // Is the type already supported? @@ -245,22 +134,30 @@ shared_ptr TocBackend::toc(string const & type) const shared_ptr TocBackend::toc(string const & type) { - TocList::const_iterator it = tocs_.find(type); - if (it == tocs_.end()) { - it = tocs_.insert(std::make_pair(type, make_shared())).first; - } - return it->second; + // 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; } -shared_ptr TocBackend::builder(string const & type) +TocBuilder & TocBackend::builder(string const & type) { - return builders_.get(type, toc(type)); + auto p = make_unique(toc(type)); + return * builders_.insert(make_pair(type, move(p))).first->second; } -bool TocBackend::updateItem(DocIterator const & dit) +// 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; @@ -274,34 +171,32 @@ 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() == ARG_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(AS_STR_INSETS); + tocstring += ' '; + arg->text().forOutliner(tocstring,TOC_ENTRY_LENGTH); break; } - } - int const toclevel = toc_item->dit_.text()->getTocLevel(toc_item->dit_.pit()); + 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 | AS_STR_INSETS); + par.forOutliner(tocstring, TOC_ENTRY_LENGTH); + support::truncateWithEllipsis(tocstring, TOC_ENTRY_LENGTH); const_cast(*toc_item).str(tocstring); buffer_->updateTocItem("tableofcontents", dit); @@ -315,21 +210,22 @@ void TocBackend::update(bool output_active, UpdateType utype) it->second->clear(); tocs_.clear(); builders_.clear(); + resetOutlinerNames(); if (!buffer_->isInternal()) { DocIterator dit; - buffer_->inset().addToToc(dit, output_active, utype); + 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? // We will try to make the best of it in release mode LASSERT(toclist_it != tocs_.end(), toclist_it = tocs_.begin()); - return toclist_it->second->item(dit); + return findItem(*toclist_it->second, dit); } @@ -338,8 +234,8 @@ void TocBackend::writePlaintextTocList(string const & type, { TocList::const_iterator cit = tocs_.find(type); if (cit != tocs_.end()) { - TocIterator ccit = cit->second->begin(); - TocIterator end = cit->second->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) @@ -349,4 +245,80 @@ void TocBackend::writePlaintextTocList(string const & type, } +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); + } + + LYXERR0("Missing OutlinerName for " << type << "!"); + return from_utf8(type); +} + + +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::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:"; +} + + } // namespace lyx