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 void TocBackend::updateItem(ParConstIterator const & par_it)
126 BufferParams const & bufparams = buffer_->params();
127 const int min_toclevel = bufparams.getTextClass().min_toclevel();
129 TocIterator toc_item = item("tableofcontents", par_it);
133 // For each paragraph, traverse its insets and let them add
135 InsetList::const_iterator it = toc_item->par_it_->insetlist.begin();
136 InsetList::const_iterator end = toc_item->par_it_->insetlist.end();
137 for (; it != end; ++it) {
138 Inset & inset = *it->inset;
139 if (inset.lyxCode() == Inset::OPTARG_CODE) {
140 if (!tocstring.empty())
142 Paragraph const & par =
143 *static_cast<InsetOptArg&>(inset).paragraphs().begin();
144 if (!toc_item->par_it_->getLabelstring().empty())
145 tocstring = toc_item->par_it_->getLabelstring() + ' ';
146 tocstring += par.asString(*buffer_, false);
151 int const toclevel = toc_item->par_it_->layout()->toclevel;
152 if (toclevel != Layout::NOT_IN_TOC
153 && toclevel >= min_toclevel
154 && toclevel <= bufparams.tocdepth
155 && tocstring.empty())
156 tocstring = toc_item->par_it_->asString(*buffer_, true);
158 const_cast<TocItem &>(*toc_item).str_ = tocstring;
162 void TocBackend::update()
166 BufferParams const & bufparams = buffer_->params();
167 const int min_toclevel = bufparams.getTextClass().min_toclevel();
169 Toc & toc = tocs_["tableofcontents"];
170 ParConstIterator pit = buffer_->par_iterator_begin();
171 ParConstIterator end = buffer_->par_iterator_end();
172 for (; pit != end; ++pit) {
174 // the string that goes to the toc (could be the optarg)
177 // For each paragraph, traverse its insets and let them add
179 InsetList::const_iterator it = pit->insetlist.begin();
180 InsetList::const_iterator end = pit->insetlist.end();
181 for (; it != end; ++it) {
182 Inset & inset = *it->inset;
183 inset.addToToc(tocs_, *buffer_);
184 switch (inset.lyxCode()) {
185 case Inset::OPTARG_CODE: {
186 if (!tocstring.empty())
188 Paragraph const & par =
189 *static_cast<InsetOptArg&>(inset).paragraphs().begin();
190 if (!pit->getLabelstring().empty())
191 tocstring = pit->getLabelstring() + ' ';
192 tocstring += par.asString(*buffer_, false);
200 /// now the toc entry for the paragraph
201 int const toclevel = pit->layout()->toclevel;
202 if (toclevel != Layout::NOT_IN_TOC
203 && toclevel >= min_toclevel
204 && toclevel <= bufparams.tocdepth) {
205 // insert this into the table of contents
206 if (tocstring.empty())
207 tocstring = pit->asString(*buffer_, true);
209 TocItem(pit, toclevel - min_toclevel, tocstring));
215 TocIterator const TocBackend::item(
216 std::string const & type, ParConstIterator const & par_it) const
218 TocList::const_iterator toclist_it = tocs_.find(type);
219 // Is the type supported?
220 BOOST_ASSERT(toclist_it != tocs_.end());
222 Toc const & toc_vector = toclist_it->second;
223 TocIterator last = toc_vector.begin();
224 TocIterator it = toc_vector.end();
230 ParConstIterator par_it_text = par_it;
231 if (par_it_text.inMathed())
232 // It would be better to do
233 // par_it_text.backwardInset();
234 // but this method does not exist.
235 while (par_it_text.inMathed())
236 par_it_text.backwardPos();
238 for (; it != last; --it) {
240 // A good solution for Items inside insets would be to do:
242 //if (std::distance(it->par_it_, current) <= 0)
245 // But for an unknown reason, std::distance(current, it->par_it_) always
246 // returns a positive value and std::distance(it->par_it_, current) takes forever...
247 // So for now, we do:
248 if (it->par_it_.pit() <= par_it_text.pit())
252 // We are before the first Toc Item:
257 void TocBackend::writePlaintextTocList(string const & type, odocstream & os) const
259 TocList::const_iterator cit = tocs_.find(type);
260 if (cit != tocs_.end()) {
261 TocIterator ccit = cit->second.begin();
262 TocIterator end = cit->second.end();
263 for (; ccit != end; ++ccit)
264 os << ccit->asString() << '\n';