]> git.lyx.org Git - lyx.git/blobdiff - src/TocBackend.cpp
Remove tooltips from the data of Toc Items
[lyx.git] / src / TocBackend.cpp
index f3511be8e582ae18f11bd0867435e1f2f2c5ff06..2b13d1febfa8d37de5a673ed6d41be971abe4345 100644 (file)
@@ -17,6 +17,7 @@
 
 #include "Buffer.h"
 #include "BufferParams.h"
+#include "Cursor.h"
 #include "FloatList.h"
 #include "FuncRequest.h"
 #include "InsetList.h"
@@ -31,8 +32,9 @@
 #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 +49,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,26 +62,20 @@ 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_;
 }
 
+namespace {
+
 // convert a DocIterator into an argument to LFUN_PARAGRAPH_GOTO 
 docstring paragraph_goto_arg(DocIterator const & dit)
 {
@@ -88,6 +84,8 @@ docstring paragraph_goto_arg(DocIterator const & dit)
                convert<docstring>(s.pos());
 }
 
+} // namespace anon
+
 FuncRequest TocItem::action() const
 {
        if (action_.action() == LFUN_UNKNOWN_ACTION) {
@@ -103,21 +101,15 @@ FuncRequest TocItem::action() const
 //
 ///////////////////////////////////////////////////////////////////////////
 
-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
@@ -134,12 +126,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;
@@ -155,14 +147,14 @@ Toc::iterator Toc::item(int depth, docstring const & str)
 ///////////////////////////////////////////////////////////////////////////
 
 TocBuilder::TocBuilder(shared_ptr<Toc> toc)
-       : toc_(toc ? toc : lyx::make_shared<Toc>()),
+       : toc_(toc ? toc : make_shared<Toc>()),
          stack_()
 {
        LATTEST(toc);
 }
 
 void TocBuilder::pushItem(DocIterator const & dit, docstring const & s,
-                                                 bool output_active, bool is_captioned)
+                          bool output_active, bool is_captioned)
 {
        toc_->push_back(TocItem(dit, stack_.size(), s, output_active));
        frame f = {
@@ -173,7 +165,7 @@ void TocBuilder::pushItem(DocIterator const & dit, docstring const & s,
 }
 
 void TocBuilder::captionItem(DocIterator const & dit, docstring const & s,
-                                                        bool output_active)
+                             bool output_active)
 {
        // first show the float before moving to the caption
        docstring arg = "paragraph-goto " + paragraph_goto_arg(dit);
@@ -181,7 +173,7 @@ void TocBuilder::captionItem(DocIterator const & dit, docstring const & s,
                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.
@@ -209,25 +201,6 @@ void TocBuilder::pop()
 
 
 
-///////////////////////////////////////////////////////////////////////////
-//
-// TocBuilderStore implementation
-//
-///////////////////////////////////////////////////////////////////////////
-
-shared_ptr<TocBuilder> TocBuilderStore::get(string const & type,
-                                                                                       shared_ptr<Toc> toc)
-{
-       map_t::const_iterator it = map_.find(type);
-       if (it == map_.end()) {
-               it = map_.insert(std::make_pair(type,
-                                                                       lyx::make_shared<TocBuilder>(toc))).first;
-       }
-       return it->second;
-}
-
-
-
 ///////////////////////////////////////////////////////////////////////////
 //
 // TocBackend implementation
@@ -238,29 +211,37 @@ shared_ptr<Toc const> TocBackend::toc(string const & type) const
 {
        // Is the type already supported?
        TocList::const_iterator it = tocs_.find(type);
-       LASSERT(it != tocs_.end(), { return lyx::make_shared<Toc>(); });
+       LASSERT(it != tocs_.end(), { return make_shared<Toc>(); });
        return it->second;
 }
 
 
 shared_ptr<Toc> TocBackend::toc(string const & type)
 {
-       TocList::const_iterator it = tocs_.find(type);
-       if (it == tocs_.end()) {
-               it = tocs_.insert(std::make_pair(type, lyx::make_shared<Toc>())).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<Toc>()}).first->second;
 }
 
 
-shared_ptr<TocBuilder> TocBackend::builder(string const & type)
+TocBuilder & TocBackend::builder(string const & type)
 {
-       return builders_.get(type, toc(type));
+       auto p = make_unique<TocBuilder>(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 +255,36 @@ 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
+       //
+       // 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() == ARG_CODE) {
+                       tocstring = par.labelString();
                        if (!tocstring.empty())
-                               break;
-                       Paragraph const & inset_par =
-                               *static_cast<InsetArgument&>(inset).paragraphs().begin();
-                       if (!par.labelString().empty())
-                               tocstring = par.labelString() + ' ';
-                       tocstring += inset_par.asString(AS_STR_INSETS);
+                               tocstring += ' ';
+                       inset.asInsetText()->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<TocItem &>(*toc_item).str(tocstring);
 
        buffer_->updateTocItem("tableofcontents", dit);
@@ -322,14 +305,14 @@ void TocBackend::update(bool output_active, UpdateType utype)
 }
 
 
-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 +321,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 +332,11 @@ void TocBackend::writePlaintextTocList(string const & type,
 }
 
 
+docstring TocBackend::outlinerName(string const & type) const
+{
+       return translateIfPossible(
+           buffer_->params().documentClass().outlinerName(type));
+}
+
+
 } // namespace lyx