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"
21 #include "FloatList.h"
22 #include "FuncRequest.h"
23 #include "InsetList.h"
25 #include "LyXAction.h"
26 #include "Paragraph.h"
27 #include "ParIterator.h"
28 #include "TextClass.h"
30 #include "insets/InsetArgument.h"
32 #include "support/convert.h"
33 #include "support/debug.h"
34 #include "support/docstream.h"
35 #include "support/gettext.h"
36 #include "support/lassert.h"
37 #include "support/lstrings.h"
45 ///////////////////////////////////////////////////////////////////////////
47 // TocItem implementation
49 ///////////////////////////////////////////////////////////////////////////
51 TocItem::TocItem(DocIterator const & dit, int d, docstring const & s,
52 bool output_active, docstring const & t, FuncRequest action) :
53 dit_(dit), depth_(d), str_(s), tooltip_(t), output_(output_active),
59 int TocItem::id() const
61 return dit_.paragraph().id();
65 docstring const & TocItem::tooltip() const
67 return tooltip_.empty() ? str_ : tooltip_;
71 docstring const TocItem::asString() const
73 static char_type const cross = 0x2716; // ✖ U+2716 HEAVY MULTIPLICATION X
74 static char_type const thin = 0x2009; // U+2009 THIN SPACE
85 // convert a DocIterator into an argument to LFUN_PARAGRAPH_GOTO
86 docstring paragraph_goto_arg(DocIterator const & dit)
88 CursorSlice const & s = dit.innerTextSlice();
89 return convert<docstring>(s.paragraph().id()) + ' ' +
90 convert<docstring>(s.pos());
95 FuncRequest TocItem::action() const
97 if (action_.action() == LFUN_UNKNOWN_ACTION) {
98 return FuncRequest(LFUN_PARAGRAPH_GOTO, paragraph_goto_arg(dit_));
104 ///////////////////////////////////////////////////////////////////////////
106 // Toc implementation
108 ///////////////////////////////////////////////////////////////////////////
110 TocIterator Toc::item(DocIterator const & dit) const
112 TocIterator last = begin();
113 TocIterator it = end();
119 DocIterator dit_text = dit;
120 if (dit_text.inMathed()) {
121 // We are only interested in text so remove the math CursorSlice.
122 while (dit_text.inMathed())
126 for (; it != last; --it) {
127 // We verify that we don't compare contents of two
128 // different document. This happens when you
129 // have parent and child documents.
130 if (&it->dit_[0].inset() != &dit_text[0].inset())
132 if (it->dit_ <= dit_text)
136 // We are before the first Toc Item:
141 Toc::iterator Toc::item(int depth, docstring const & str)
145 iterator it = begin();
146 iterator itend = end();
147 for (; it != itend; ++it) {
148 if (it->depth() == depth && it->str() == str)
155 ///////////////////////////////////////////////////////////////////////////
157 // TocBuilder implementation
159 ///////////////////////////////////////////////////////////////////////////
161 TocBuilder::TocBuilder(shared_ptr<Toc> toc)
162 : toc_(toc ? toc : lyx::make_shared<Toc>()),
168 void TocBuilder::pushItem(DocIterator const & dit, docstring const & s,
169 bool output_active, bool is_captioned)
171 toc_->push_back(TocItem(dit, stack_.size(), s, output_active));
173 toc_->size() - 1, //pos
174 is_captioned, //is_captioned
179 void TocBuilder::captionItem(DocIterator const & dit, docstring const & s,
182 // first show the float before moving to the caption
183 docstring arg = "paragraph-goto " + paragraph_goto_arg(dit);
185 arg = "paragraph-goto " +
186 paragraph_goto_arg((*toc_)[stack_.top().pos].dit_) + ";" + arg;
187 FuncRequest func(LFUN_COMMAND_SEQUENCE, arg);
189 if (!stack_.empty() && !stack_.top().is_captioned) {
190 // The float we entered has not yet been assigned a caption.
191 // Assign the caption string to it.
192 TocItem & captionable = (*toc_)[stack_.top().pos];
194 captionable.setAction(func);
195 stack_.top().is_captioned = true;
197 // This is a new entry.
199 // the dit is at the float's level, e.g. for the contextual menu of
201 DocIterator captionable_dit = dit;
202 captionable_dit.pop_back();
203 pushItem(captionable_dit, s, output_active, true);
204 (*toc_)[stack_.top().pos].setAction(func);
208 void TocBuilder::pop()
216 ///////////////////////////////////////////////////////////////////////////
218 // TocBuilderStore implementation
220 ///////////////////////////////////////////////////////////////////////////
222 shared_ptr<TocBuilder> TocBuilderStore::get(string const & type,
225 map_t::const_iterator it = map_.find(type);
226 if (it == map_.end()) {
227 it = map_.insert(std::make_pair(type,
228 lyx::make_shared<TocBuilder>(toc))).first;
235 ///////////////////////////////////////////////////////////////////////////
237 // TocBackend implementation
239 ///////////////////////////////////////////////////////////////////////////
241 shared_ptr<Toc const> TocBackend::toc(string const & type) const
243 // Is the type already supported?
244 TocList::const_iterator it = tocs_.find(type);
245 LASSERT(it != tocs_.end(), { return lyx::make_shared<Toc>(); });
250 shared_ptr<Toc> TocBackend::toc(string const & type)
252 TocList::const_iterator it = tocs_.find(type);
253 if (it == tocs_.end()) {
254 it = tocs_.insert(std::make_pair(type, lyx::make_shared<Toc>())).first;
260 shared_ptr<TocBuilder> TocBackend::builder(string const & type)
262 return builders_.get(type, toc(type));
266 // FIXME: This function duplicates functionality from InsetText::iterateForToc.
267 // Both have their own way of computing the TocItem for "tableofcontents". The
268 // TocItem creation and update should be made in a dedicated function and
269 // updateItem should be rewritten to uniformly update the matching items from
271 bool TocBackend::updateItem(DocIterator const & dit_in)
274 DocIterator dit = dit_in.getInnerText();
276 if (dit.text()->getTocLevel(dit.pit()) == Layout::NOT_IN_TOC)
279 if (toc("tableofcontents")->empty()) {
280 // FIXME: should not happen,
281 // a call to TocBackend::update() is missing somewhere
282 LYXERR0("TocBackend::updateItem called but the TOC is empty!");
286 BufferParams const & bufparams = buffer_->params();
287 const int min_toclevel = bufparams.documentClass().min_toclevel();
289 TocIterator toc_item = item("tableofcontents", dit);
293 // For each paragraph, traverse its insets and let them add
296 // FIXME: This is supposed to accomplish the same as the body of
297 // InsetText::iterateForToc(), probably
298 Paragraph & par = toc_item->dit_.paragraph();
299 InsetList::const_iterator it = par.insetList().begin();
300 InsetList::const_iterator end = par.insetList().end();
301 for (; it != end; ++it) {
302 Inset & inset = *it->inset;
303 if (inset.lyxCode() == ARG_CODE) {
304 tocstring = par.labelString();
305 if (!tocstring.empty())
307 inset.asInsetText()->text().forOutliner(tocstring,TOC_ENTRY_LENGTH);
312 int const toclevel = toc_item->dit_.text()->
313 getTocLevel(toc_item->dit_.pit());
314 if (toclevel != Layout::NOT_IN_TOC && toclevel >= min_toclevel
315 && tocstring.empty())
316 par.forOutliner(tocstring, TOC_ENTRY_LENGTH);
318 support::truncateWithEllipsis(tocstring, TOC_ENTRY_LENGTH);
319 const_cast<TocItem &>(*toc_item).str(tocstring);
321 buffer_->updateTocItem("tableofcontents", dit);
326 void TocBackend::update(bool output_active, UpdateType utype)
328 for (TocList::iterator it = tocs_.begin(); it != tocs_.end(); ++it)
332 if (!buffer_->isInternal()) {
334 buffer_->inset().addToToc(dit, output_active, utype);
339 TocIterator TocBackend::item(string const & type,
340 DocIterator const & dit) const
342 TocList::const_iterator toclist_it = tocs_.find(type);
343 // Is the type supported?
344 // We will try to make the best of it in release mode
345 LASSERT(toclist_it != tocs_.end(), toclist_it = tocs_.begin());
346 return toclist_it->second->item(dit);
350 void TocBackend::writePlaintextTocList(string const & type,
351 odocstringstream & os, size_t max_length) const
353 TocList::const_iterator cit = tocs_.find(type);
354 if (cit != tocs_.end()) {
355 TocIterator ccit = cit->second->begin();
356 TocIterator end = cit->second->end();
357 for (; ccit != end; ++ccit) {
358 os << ccit->asString() << from_utf8("\n");
359 if (os.str().size() > max_length)
366 docstring TocBackend::outlinerName(std::string const & type) const
368 return translateIfPossible(
369 buffer_->params().documentClass().outlinerName(type));