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 "FloatList.h"
21 #include "FuncRequest.h"
22 #include "InsetList.h"
24 #include "LyXAction.h"
25 #include "Paragraph.h"
26 #include "ParIterator.h"
27 #include "TextClass.h"
29 #include "insets/InsetArgument.h"
31 #include "support/convert.h"
32 #include "support/debug.h"
33 #include "support/docstream.h"
34 #include "support/lassert.h"
35 #include "support/lstrings.h"
43 ///////////////////////////////////////////////////////////////////////////
45 // TocItem implementation
47 ///////////////////////////////////////////////////////////////////////////
49 TocItem::TocItem(DocIterator const & dit, int d, docstring const & s,
50 bool output_active, docstring const & t, FuncRequest action) :
51 dit_(dit), depth_(d), str_(s), tooltip_(t), output_(output_active),
57 int TocItem::id() const
59 return dit_.paragraph().id();
63 docstring const & TocItem::tooltip() const
65 return tooltip_.empty() ? str_ : tooltip_;
69 docstring const TocItem::asString() const
71 // U+2327 X IN A RECTANGLE BOX
72 // char_type const cross = 0x2327;
73 // U+274E NEGATIVE SQUARED CROSS MARK
74 char_type const cross = 0x274e;
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)
273 if (dit.text()->getTocLevel(dit.pit()) == Layout::NOT_IN_TOC)
276 if (toc("tableofcontents")->empty()) {
277 // FIXME: should not happen,
278 // a call to TocBackend::update() is missing somewhere
279 LYXERR0("TocBackend::updateItem called but the TOC is empty!");
283 BufferParams const & bufparams = buffer_->params();
284 const int min_toclevel = bufparams.documentClass().min_toclevel();
286 TocIterator toc_item = item("tableofcontents", dit);
290 // For each paragraph, traverse its insets and let them add
293 // FIXME: This is supposed to accomplish the same as the body of
294 // InsetText::iterateForToc(), probably
295 Paragraph & par = toc_item->dit_.paragraph();
296 InsetList::const_iterator it = par.insetList().begin();
297 InsetList::const_iterator end = par.insetList().end();
298 for (; it != end; ++it) {
299 Inset & inset = *it->inset;
300 if (inset.lyxCode() == ARG_CODE) {
301 tocstring = par.labelString();
302 if (!tocstring.empty())
304 inset.asInsetText()->text().forOutliner(tocstring,TOC_ENTRY_LENGTH);
309 int const toclevel = toc_item->dit_.text()->
310 getTocLevel(toc_item->dit_.pit());
311 if (toclevel != Layout::NOT_IN_TOC && toclevel >= min_toclevel
312 && tocstring.empty())
313 par.forOutliner(tocstring, TOC_ENTRY_LENGTH);
315 support::truncateWithEllipsis(tocstring, TOC_ENTRY_LENGTH);
316 const_cast<TocItem &>(*toc_item).str(tocstring);
318 buffer_->updateTocItem("tableofcontents", dit);
323 void TocBackend::update(bool output_active, UpdateType utype)
325 for (TocList::iterator it = tocs_.begin(); it != tocs_.end(); ++it)
329 if (!buffer_->isInternal()) {
331 buffer_->inset().addToToc(dit, output_active, utype);
336 TocIterator TocBackend::item(string const & type,
337 DocIterator const & dit) const
339 TocList::const_iterator toclist_it = tocs_.find(type);
340 // Is the type supported?
341 // We will try to make the best of it in release mode
342 LASSERT(toclist_it != tocs_.end(), toclist_it = tocs_.begin());
343 return toclist_it->second->item(dit);
347 void TocBackend::writePlaintextTocList(string const & type,
348 odocstringstream & os, size_t max_length) const
350 TocList::const_iterator cit = tocs_.find(type);
351 if (cit != tocs_.end()) {
352 TocIterator ccit = cit->second->begin();
353 TocIterator end = cit->second->end();
354 for (; ccit != end; ++ccit) {
355 os << ccit->asString() << from_utf8("\n");
356 if (os.str().size() > max_length)