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
10 * Full author contact details are available in file CREDITS.
15 #include "TocBackend.h"
18 #include "bufferparams.h"
19 #include "FloatList.h"
20 #include "funcrequest.h"
21 #include "LyXAction.h"
22 #include "paragraph.h"
25 #include "insets/insetoptarg.h"
27 #include "support/convert.h"
36 ///////////////////////////////////////////////////////////////////////////
37 // TocItem implementation
39 TocItem::TocItem(ParConstIterator const & par_it, int d,
41 : par_it_(par_it), depth_(d), str_(s)
47 size_t pos = s.find(" ");
48 if (pos == string::npos) {
54 string s2 = s.substr(0, pos);
56 if (s2 == "Chapter" || s2 == "Part") {
57 size_t pos2 = s.find(" ", pos + 1);
58 if (pos2 == string::npos) {
59 // Unnumbered Chapter?? This should not happen.
60 uid_ = s.substr(pos + 1);
64 uid_ = s.substr(pos2 + 1);
68 uid_ = s.substr(pos + 1);
72 bool const TocItem::isValid() const
78 int const TocItem::id() const
84 int const TocItem::depth() const
90 docstring const & TocItem::str() const
96 docstring const TocItem::asString() const
98 return docstring(4 * depth_, ' ') + str_;
102 FuncRequest TocItem::action() const
104 return FuncRequest(LFUN_PARAGRAPH_GOTO, convert<string>(id()));
111 ///////////////////////////////////////////////////////////////////////////
112 // TocBackend implementation
114 Toc const & TocBackend::toc(std::string const & type) const
116 // Is the type already supported?
117 TocList::const_iterator it = tocs_.find(type);
118 BOOST_ASSERT(it != tocs_.end());
124 bool TocBackend::addType(std::string const & type)
126 // Is the type already supported?
127 TocList::iterator toclist_it = tocs_.find(type);
128 if (toclist_it != tocs_.end())
131 tocs_.insert(make_pair(type, Toc()));
132 types_.push_back(type);
138 void TocBackend::update()
143 BufferParams const & bufparams = buffer_->params();
144 const int min_toclevel = bufparams.getLyXTextClass().min_toclevel();
146 ParConstIterator pit = buffer_->par_iterator_begin();
147 ParConstIterator end = buffer_->par_iterator_end();
148 for (; pit != end; ++pit) {
150 // the string that goes to the toc (could be the optarg)
153 // For each paragraph, traverse its insets and let them add
155 InsetList::const_iterator it = pit->insetlist.begin();
156 InsetList::const_iterator end = pit->insetlist.end();
157 for (; it != end; ++it) {
158 it->inset->addToToc(tocs_, *buffer_);
159 switch (it->inset->lyxCode()) {
160 case InsetBase::OPTARG_CODE: {
161 if (!tocstring.empty())
163 Paragraph const & par = *static_cast<InsetOptArg*>(it->inset)->paragraphs().begin();
164 if (!pit->getLabelstring().empty())
165 tocstring = pit->getLabelstring() + ' ';
166 tocstring += par.asString(*buffer_, false);
174 /// now the toc entry for the paragraph
175 int const toclevel = pit->layout()->toclevel;
176 if (toclevel != LyXLayout::NOT_IN_TOC
177 && toclevel >= min_toclevel
178 && toclevel <= bufparams.tocdepth) {
179 // insert this into the table of contents
180 if (tocstring.empty())
181 tocstring = pit->asString(*buffer_, true);
182 TocItem const item(pit, toclevel - min_toclevel, tocstring);
183 tocs_["tableofcontents"].push_back(item);
187 TocList::iterator it = tocs_.begin();
188 for (; it != tocs_.end(); ++it)
189 types_.push_back(it->first);
193 TocIterator const TocBackend::item(
194 std::string const & type, ParConstIterator const & par_it) const
196 TocList::const_iterator toclist_it = tocs_.find(type);
197 // Is the type supported?
198 BOOST_ASSERT(toclist_it != tocs_.end());
200 Toc const & toc_vector = toclist_it->second;
201 TocIterator last = toc_vector.begin();
202 TocIterator it = toc_vector.end();
205 for (; it != last; --it) {
207 // A good solution for Items inside insets would be to do:
209 //if (std::distance(it->par_it_, current) <= 0)
212 // But for an unknown reason, std::distance(current, it->par_it_) always
213 // returns a positive value and std::distance(it->par_it_, current) takes forever...
214 // So for now, we do:
215 if (it->par_it_.pit() <= par_it.pit())
219 // We are before the first Toc Item:
224 void TocBackend::asciiTocList(string const & type, odocstream & os) const
226 TocList::const_iterator cit = tocs_.find(type);
227 if (cit != tocs_.end()) {
228 TocIterator ccit = cit->second.begin();
229 TocIterator end = cit->second.end();
230 for (; ccit != end; ++ccit)
231 os << ccit->asString() << '\n';