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 if (toc("tableofcontents").empty()) {
127 // TODO should not happen,
128 // a call to TocBackend::update() is missing somewhere
130 << "TocBackend.cpp: TocBackend::updateItem"
131 << "called but the TOC is empty" << std::endl;
135 BufferParams const & bufparams = buffer_->params();
136 const int min_toclevel = bufparams.getTextClass().min_toclevel();
138 TocIterator toc_item = item("tableofcontents", par_it);
142 // For each paragraph, traverse its insets and let them add
144 InsetList::const_iterator it = toc_item->par_it_->insetlist.begin();
145 InsetList::const_iterator end = toc_item->par_it_->insetlist.end();
146 for (; it != end; ++it) {
147 Inset & inset = *it->inset;
148 if (inset.lyxCode() == Inset::OPTARG_CODE) {
149 if (!tocstring.empty())
151 Paragraph const & par =
152 *static_cast<InsetOptArg&>(inset).paragraphs().begin();
153 if (!toc_item->par_it_->getLabelstring().empty())
154 tocstring = toc_item->par_it_->getLabelstring() + ' ';
155 tocstring += par.asString(*buffer_, false);
160 int const toclevel = toc_item->par_it_->layout()->toclevel;
161 if (toclevel != Layout::NOT_IN_TOC
162 && toclevel >= min_toclevel
163 && tocstring.empty())
164 tocstring = toc_item->par_it_->asString(*buffer_, true);
166 const_cast<TocItem &>(*toc_item).str_ = tocstring;
170 void TocBackend::update()
174 BufferParams const & bufparams = buffer_->params();
175 const int min_toclevel = bufparams.getTextClass().min_toclevel();
177 Toc & toc = tocs_["tableofcontents"];
178 ParConstIterator pit = buffer_->par_iterator_begin();
179 ParConstIterator end = buffer_->par_iterator_end();
180 for (; pit != end; ++pit) {
182 // the string that goes to the toc (could be the optarg)
185 // For each paragraph, traverse its insets and let them add
187 InsetList::const_iterator it = pit->insetlist.begin();
188 InsetList::const_iterator end = pit->insetlist.end();
189 for (; it != end; ++it) {
190 Inset & inset = *it->inset;
191 inset.addToToc(tocs_, *buffer_);
192 switch (inset.lyxCode()) {
193 case Inset::OPTARG_CODE: {
194 if (!tocstring.empty())
196 Paragraph const & par =
197 *static_cast<InsetOptArg&>(inset).paragraphs().begin();
198 if (!pit->getLabelstring().empty())
199 tocstring = pit->getLabelstring() + ' ';
200 tocstring += par.asString(*buffer_, false);
208 /// now the toc entry for the paragraph
209 int const toclevel = pit->layout()->toclevel;
210 if (toclevel != Layout::NOT_IN_TOC
211 && toclevel >= min_toclevel) {
212 // insert this into the table of contents
213 if (tocstring.empty())
214 tocstring = pit->asString(*buffer_, true);
216 TocItem(pit, toclevel - min_toclevel, tocstring));
222 TocIterator const TocBackend::item(
223 std::string const & type, ParConstIterator const & par_it) const
225 TocList::const_iterator toclist_it = tocs_.find(type);
226 // Is the type supported?
227 BOOST_ASSERT(toclist_it != tocs_.end());
229 Toc const & toc_vector = toclist_it->second;
230 TocIterator last = toc_vector.begin();
231 TocIterator it = toc_vector.end();
237 ParConstIterator par_it_text = par_it;
238 if (par_it_text.inMathed())
239 // It would be better to do
240 // par_it_text.backwardInset();
241 // but this method does not exist.
242 while (par_it_text.inMathed())
243 par_it_text.backwardPos();
245 for (; it != last; --it) {
247 // A good solution for Items inside insets would be to do:
249 //if (std::distance(it->par_it_, current) <= 0)
252 // But for an unknown reason, std::distance(current, it->par_it_) always
253 // returns a positive value and std::distance(it->par_it_, current) takes forever...
254 // So for now, we do:
255 if (it->par_it_.pit() <= par_it_text.pit())
259 // We are before the first Toc Item:
264 void TocBackend::writePlaintextTocList(string const & type, odocstream & os) const
266 TocList::const_iterator cit = tocs_.find(type);
267 if (cit != tocs_.end()) {
268 TocIterator ccit = cit->second.begin();
269 TocIterator end = cit->second.end();
270 for (; ccit != end; ++ccit)
271 os << ccit->asString() << '\n';