3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Jean-Marc Lasgouttes
7 * \author Angus Leeming
8 * \author Abdelrazak Younes
9 * \author Guillaume Munch
11 * Full author contact details are available in file CREDITS.
16 #include "TocBackend.h"
19 #include "BufferParams.h"
20 #include "IndicesList.h"
21 #include "InsetList.h"
22 #include "Paragraph.h"
23 #include "TextClass.h"
25 #include "insets/InsetArgument.h"
27 #include "support/debug.h"
28 #include "support/docstream.h"
29 #include "support/gettext.h"
30 #include "support/lassert.h"
31 #include "support/lstrings.h"
39 ///////////////////////////////////////////////////////////////////////////
41 // TocItem implementation
43 ///////////////////////////////////////////////////////////////////////////
45 TocItem::TocItem(DocIterator const & dit, int d, docstring const & s,
46 bool output_active, FuncRequest const & action)
47 : dit_(dit), depth_(d), str_(s), output_(output_active),
53 int TocItem::id() const
55 return dit_.paragraph().id();
59 docstring const TocItem::asString() const
61 static char_type const cross = 0x2716; // ✖ U+2716 HEAVY MULTIPLICATION X
62 static char_type const thin = 0x2009; // U+2009 THIN SPACE
72 FuncRequest TocItem::action() const
74 if (action_.action() == LFUN_UNKNOWN_ACTION) {
75 return FuncRequest(LFUN_PARAGRAPH_GOTO, dit_.paragraphGotoArgument());
81 ///////////////////////////////////////////////////////////////////////////
83 // TocBackend implementation
85 ///////////////////////////////////////////////////////////////////////////
87 Toc::const_iterator TocBackend::findItem(Toc const & toc,
88 DocIterator const & dit)
90 Toc::const_iterator last = toc.begin();
91 Toc::const_iterator it = toc.end();
95 DocIterator dit_text = dit.getInnerText();
97 for (; it != last; --it) {
98 // We verify that we don't compare contents of two
99 // different document. This happens when you
100 // have parent and child documents.
101 if (&it->dit()[0].inset() != &dit_text[0].inset())
103 if (it->dit() <= dit_text)
107 // We are before the first Toc Item:
112 Toc::iterator TocBackend::findItem(Toc & toc, int depth, docstring const & str)
116 Toc::iterator it = toc.begin();
117 Toc::iterator itend = toc.end();
118 for (; it != itend; ++it) {
119 if (it->depth() == depth && it->str() == str)
126 shared_ptr<Toc const> TocBackend::toc(string const & type) const
128 // Is the type already supported?
129 TocList::const_iterator it = tocs_.find(type);
130 LASSERT(it != tocs_.end(), { return make_shared<Toc>(); });
135 shared_ptr<Toc> TocBackend::toc(string const & type)
137 // std::map::insert only really performs the insertion if the key is not
138 // already bound, and otherwise returns an iterator to the element already
139 // there, see manual.
140 return tocs_.insert({type, make_shared<Toc>()}).first->second;
144 TocBuilder & TocBackend::builder(string const & type)
146 auto p = lyx::make_unique<TocBuilder>(toc(type));
147 return * builders_.insert(make_pair(type, move(p))).first->second;
151 // FIXME: This function duplicates functionality from InsetText::iterateForToc.
152 // Both have their own way of computing the TocItem for "tableofcontents". The
153 // TocItem creation and update should be made in a dedicated function and
154 // updateItem should be rewritten to uniformly update the matching items from
156 bool TocBackend::updateItem(DocIterator const & dit_in) const
158 if (dit_in.buffer() && dit_in.buffer()->isInternal())
162 DocIterator dit = dit_in.getInnerText();
164 if (dit.text()->getTocLevel(dit.pit()) == Layout::NOT_IN_TOC)
167 if (toc("tableofcontents")->empty()) {
168 // FIXME: should not happen,
169 // a call to TocBackend::update() is missing somewhere
170 LYXERR0("TocBackend::updateItem called but the TOC is empty!");
174 BufferParams const & bufparams = buffer_->params();
175 const int min_toclevel = bufparams.documentClass().min_toclevel();
177 Toc::const_iterator toc_item = item("tableofcontents", dit);
181 // For each paragraph, traverse its insets and let them add
184 // FIXME: This is supposed to accomplish the same as the body of
185 // InsetText::iterateForToc(), probably
186 Paragraph const & par = toc_item->dit().paragraph();
187 for (auto const & table : par.insetList())
188 if (InsetArgument const * arg = table.inset->asInsetArgument()) {
189 tocstring = par.labelString();
190 if (!tocstring.empty())
192 arg->text().forOutliner(tocstring,TOC_ENTRY_LENGTH);
196 int const toclevel = toc_item->dit().text()->
197 getTocLevel(toc_item->dit().pit());
198 if (toclevel != Layout::NOT_IN_TOC && toclevel >= min_toclevel
199 && tocstring.empty())
200 par.forOutliner(tocstring, TOC_ENTRY_LENGTH);
202 support::truncateWithEllipsis(tocstring, TOC_ENTRY_LENGTH);
203 const_cast<TocItem &>(*toc_item).str(tocstring);
205 buffer_->updateTocItem("tableofcontents", dit);
210 void TocBackend::reset()
212 for (auto const & t: tocs_)
216 resetOutlinerNames();
220 void TocBackend::update(bool output_active, UpdateType utype)
223 if (buffer_->isInternal())
227 buffer_->inset().addToToc(dit, output_active, utype, *this);
231 Toc::const_iterator TocBackend::item(string const & type,
232 DocIterator const & dit) const
234 TocList::const_iterator toclist_it = tocs_.find(type);
235 // Is the type supported?
236 // We will try to make the best of it in release mode
237 LASSERT(toclist_it != tocs_.end(), toclist_it = tocs_.begin());
238 return findItem(*toclist_it->second, dit);
242 void TocBackend::writePlaintextTocList(string const & type,
243 odocstringstream & os, size_t max_length) const
245 TocList::const_iterator cit = tocs_.find(type);
246 if (cit != tocs_.end()) {
247 Toc::const_iterator ccit = cit->second->begin();
248 Toc::const_iterator end = cit->second->end();
249 for (; ccit != end; ++ccit) {
250 os << ccit->asString() << from_utf8("\n");
251 if (os.str().size() > max_length)
258 docstring TocBackend::outlinerName(string const & type) const
260 map<string, docstring>::const_iterator const it
261 = outliner_names_.find(type);
262 if (it != outliner_names_.end())
265 // Legacy treatment of index:... type
266 if (support::prefixIs(type, "index:")) {
267 string const itype = support::split(type, ':');
268 IndicesList const & indiceslist = buffer_->params().indiceslist();
269 Index const * index = indiceslist.findShortcut(from_utf8(itype));
270 docstring indextype = _("unknown type!");
272 indextype = index->index();
273 return support::bformat(_("Index Entries (%1$s)"), indextype);
276 LYXERR0("Missing OutlinerName for " << type << "!");
277 return from_utf8(type);
281 void TocBackend::resetOutlinerNames()
283 outliner_names_.clear();
284 // names from this document class
285 for (auto const & name
286 : buffer_->params().documentClass().outlinerNames())
287 addName(name.first, translateIfPossible(name.second));
289 addName("tableofcontents", _("Table of Contents"));
290 addName("change", _("Changes"));
291 addName("senseless", _("Senseless"));
292 addName("citation", _("Citations"));
293 addName("label", _("Labels and References"));
294 addName("brokenrefs", _("Broken References and Citations"));
295 // Customizable, but the corresponding insets have no layout definition
296 addName("child", _("Child Documents"));
297 addName("graphics", _("Graphics[[listof]]"));
298 addName("equation", _("Equations"));
299 addName("external", _("External Material"));
300 addName("math-macro", _("Math Macros"));
301 addName("nomencl", _("Nomenclature Entries"));
305 void TocBackend::addName(string const & type, docstring const & name)
309 // only inserts if the key does not exist
310 outliner_names_.insert({type, name});
314 bool TocBackend::isOther(std::string const & type)
316 return type == "graphics"
321 || type == "citation"
322 || type == "equation"
323 || type == "footnote"
324 || type == "marginalnote"
326 || type == "listings"
327 || type == "math-macro"
328 || type == "external"
329 || type == "senseless"
331 || type.substr(0,6) == "index:";