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);
137 void TocBackend::updateItem(ParConstIterator const & par_it)
139 BufferParams const & bufparams = buffer_->params();
140 const int min_toclevel = bufparams.getLyXTextClass().min_toclevel();
142 TocIterator toc_item = item("tableofcontents", par_it);
146 // For each paragraph, traverse its insets and let them add
148 InsetList::const_iterator it = toc_item->par_it_->insetlist.begin();
149 InsetList::const_iterator end = toc_item->par_it_->insetlist.end();
150 for (; it != end; ++it) {
151 InsetBase & inset = *it->inset;
152 if (inset.lyxCode() == InsetBase::OPTARG_CODE) {
153 if (!tocstring.empty())
155 Paragraph const & par =
156 *static_cast<InsetOptArg&>(inset).paragraphs().begin();
157 if (!toc_item->par_it_->getLabelstring().empty())
158 tocstring = toc_item->par_it_->getLabelstring() + ' ';
159 tocstring += par.asString(*buffer_, false);
164 int const toclevel = toc_item->par_it_->layout()->toclevel;
165 if (toclevel != LyXLayout::NOT_IN_TOC
166 && toclevel >= min_toclevel
167 && toclevel <= bufparams.tocdepth
168 && tocstring.empty())
169 tocstring = toc_item->par_it_->asString(*buffer_, true);
171 const_cast<TocItem &>(*toc_item).str_ = tocstring;
175 void TocBackend::update()
180 BufferParams const & bufparams = buffer_->params();
181 const int min_toclevel = bufparams.getLyXTextClass().min_toclevel();
183 Toc & toc = tocs_["tableofcontents"];
184 ParConstIterator pit = buffer_->par_iterator_begin();
185 ParConstIterator end = buffer_->par_iterator_end();
186 for (; pit != end; ++pit) {
188 // the string that goes to the toc (could be the optarg)
191 // For each paragraph, traverse its insets and let them add
193 InsetList::const_iterator it = pit->insetlist.begin();
194 InsetList::const_iterator end = pit->insetlist.end();
195 for (; it != end; ++it) {
196 InsetBase & inset = *it->inset;
197 inset.addToToc(tocs_, *buffer_);
198 switch (inset.lyxCode()) {
199 case InsetBase::OPTARG_CODE: {
200 if (!tocstring.empty())
202 Paragraph const & par =
203 *static_cast<InsetOptArg&>(inset).paragraphs().begin();
204 if (!pit->getLabelstring().empty())
205 tocstring = pit->getLabelstring() + ' ';
206 tocstring += par.asString(*buffer_, false);
214 /// now the toc entry for the paragraph
215 int const toclevel = pit->layout()->toclevel;
216 if (toclevel != LyXLayout::NOT_IN_TOC
217 && toclevel >= min_toclevel
218 && toclevel <= bufparams.tocdepth) {
219 // insert this into the table of contents
220 if (tocstring.empty())
221 tocstring = pit->asString(*buffer_, true);
223 TocItem(pit, toclevel - min_toclevel, tocstring));
227 TocList::iterator it = tocs_.begin();
228 for (; it != tocs_.end(); ++it)
229 types_.push_back(it->first);
233 TocIterator const TocBackend::item(
234 std::string const & type, ParConstIterator const & par_it) const
236 TocList::const_iterator toclist_it = tocs_.find(type);
237 // Is the type supported?
238 BOOST_ASSERT(toclist_it != tocs_.end());
240 Toc const & toc_vector = toclist_it->second;
241 TocIterator last = toc_vector.begin();
242 TocIterator it = toc_vector.end();
248 ParConstIterator par_it_text = par_it;
249 if (par_it_text.inMathed())
250 // It would be better to do
251 // par_it_text.backwardInset();
252 // but this method does not exist.
253 while (par_it_text.inMathed())
254 par_it_text.backwardPos();
256 for (; it != last; --it) {
258 // A good solution for Items inside insets would be to do:
260 //if (std::distance(it->par_it_, current) <= 0)
263 // But for an unknown reason, std::distance(current, it->par_it_) always
264 // returns a positive value and std::distance(it->par_it_, current) takes forever...
265 // So for now, we do:
266 if (it->par_it_.pit() <= par_it_text.pit())
270 // We are before the first Toc Item:
275 void TocBackend::writePlaintextTocList(string const & type, odocstream & os) const
277 TocList::const_iterator cit = tocs_.find(type);
278 if (cit != tocs_.end()) {
279 TocIterator ccit = cit->second.begin();
280 TocIterator end = cit->second.end();
281 for (; ccit != end; ++ccit)
282 os << ccit->asString() << '\n';