X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=src%2FTocBackend.cpp;h=2bbdab3c12252620c5a4ab96c4e3aa560b520e2c;hb=57b69a5efddf9f3c148007322f00dad6c253a2ed;hp=c2515a7529f3fb99fafa030665f94ad511fbfd9e;hpb=f2c9b56fb4e4abd5183858984dd9329453004c96;p=lyx.git diff --git a/src/TocBackend.cpp b/src/TocBackend.cpp index c2515a7529..2bbdab3c12 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,234 +17,332 @@ #include "Buffer.h" #include "BufferParams.h" +#include "Cursor.h" #include "FloatList.h" #include "FuncRequest.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 +#include "support/gettext.h" +#include "support/lassert.h" +#include "support/lstrings.h" using namespace std; 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, docstring const & t, FuncRequest action) + : dit_(dit), depth_(d), str_(s), tooltip_(t), output_(output_active), + action_(action) { } int TocItem::id() const { - return par_it_->id(); + return dit_.paragraph().id(); } -int TocItem::depth() const +docstring const & TocItem::tooltip() const { - return depth_; + return tooltip_.empty() ? str_ : tooltip_; } -docstring const & TocItem::str() const +docstring const TocItem::asString() const { - return 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_; } +namespace { -docstring const TocItem::asString() const +// convert a DocIterator into an argument to LFUN_PARAGRAPH_GOTO +docstring paragraph_goto_arg(DocIterator const & dit) { - return docstring(4 * depth_, ' ') + str_; + CursorSlice const & s = dit.innerTextSlice(); + return convert(s.paragraph().id()) + ' ' + + convert(s.pos()); } +} // namespace anon FuncRequest TocItem::action() const { - return FuncRequest(LFUN_PARAGRAPH_GOTO, convert(id())); + if (action_.action() == LFUN_UNKNOWN_ACTION) { + return FuncRequest(LFUN_PARAGRAPH_GOTO, paragraph_goto_arg(dit_)); + } else + return action_; +} + + +/////////////////////////////////////////////////////////////////////////// +// +// Toc implementation +// +/////////////////////////////////////////////////////////////////////////// + +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; +} + + +/////////////////////////////////////////////////////////////////////////// +// +// 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(); } + /////////////////////////////////////////////////////////////////////////// // // TocBackend implementation // /////////////////////////////////////////////////////////////////////////// -Toc const & TocBackend::toc(string const & type) const +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; } -Toc & TocBackend::toc(string const & type) +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) { - return tocs_[type]; + auto p = make_unique(toc(type)); + return * builders_.insert(make_pair(type, move(p))).first->second; } -void TocBackend::updateItem(ParConstIterator const & par_it) +// 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) { - if (toc("tableofcontents").empty()) { + // 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 LYXERR0("TocBackend::updateItem called but the TOC is empty!"); - return; + return false; } BufferParams const & bufparams = buffer_->params(); 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(); + // + // FIXME: This is supposed to accomplish the same as the body of + // InsetText::iterateForToc(), probably + 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) { + if (inset.lyxCode() == ARG_CODE) { + tocstring = par.labelString(); if (!tocstring.empty()) - break; - Paragraph const & par = - *static_cast(inset).paragraphs().begin(); - if (!toc_item->par_it_->labelString().empty()) - tocstring = toc_item->par_it_->labelString() + ' '; - tocstring += par.asString(false); + tocstring += ' '; + inset.asInsetText()->text().forOutliner(tocstring,TOC_ENTRY_LENGTH); break; } } - int const toclevel = toc_item->par_it_->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 = toc_item->par_it_->asString(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.documentClass().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; - //lyxerr << (void*)&inset << " code: " << inset.lyxCode() << std::endl; - inset.addToToc(pit); - switch (inset.lyxCode()) { - case OPTARG_CODE: { - if (!tocstring.empty()) - break; - Paragraph const & par = - *static_cast(inset).paragraphs().begin(); - if (!pit->labelString().empty()) - tocstring = pit->labelString() + ' '; - tocstring += par.asString(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(true); - toc.push_back(TocItem(pit, toclevel - min_toclevel, - tocstring)); - } + builders_.clear(); + if (!buffer_->isInternal()) { + DocIterator dit; + buffer_->inset().addToToc(dit, output_active, utype); } } -TocIterator TocBackend::item(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()); - - Toc const & toc_vector = toclist_it->second; - TocIterator last = toc_vector.begin(); - TocIterator it = toc_vector.end(); - if (it == last) - return it; - - --it; - - ParConstIterator par_it_text = par_it; - if (par_it_text.inMathed()) { - // We are only interested in text so remove the math CursorSlice. - while (par_it_text.inMathed()) - par_it_text.pop_back(); - } - - 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; - } - - // We are before the first Toc Item: - return last; + // 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); } -void TocBackend::writePlaintextTocList(string const & type, odocstream & os) const +void TocBackend::writePlaintextTocList(string const & type, + odocstringstream & os, size_t max_length) const { 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) + 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; + } } } +docstring TocBackend::outlinerName(string const & type) const +{ + return translateIfPossible( + buffer_->params().documentClass().outlinerName(type)); +} + + } // namespace lyx