4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Jean-Marc Lasgouttes
8 * \author Angus Leeming
9 * \author Abdelrazak Younes
10 * \author Guillaume Munch
12 * Full author contact details are available in file CREDITS.
18 #include "DocIterator.h"
19 #include "FuncRequest.h"
20 #include "OutputEnums.h"
22 #include "support/shared_ptr.h"
23 #include "support/strfwd.h"
36 /* FIXME: toc types are currently identified by strings. It cannot be converted
37 * into an enum because of the user-configurable indexing categories and
38 * the user-definable float types provided by layout files.
40 * I leave this for documentation purposes for the moment.
43 TABLE_OF_CONTENTS,//"tableofcontents"
53 MARGINAL_NOTE,//"marginalnote"
54 INDEX,//"index", "index:<user-str>" (from interface)
57 FLOAT,//"figure", "table", "algorithm", user-defined (from layout?)
58 SENSELESS,//"senseless"
69 friend class TocBackend;
70 friend class TocBuilder;
73 /// Default constructor for STL containers.
74 TocItem() : dit_(0), depth_(0), output_(false) {}
76 TocItem(DocIterator const & dit,
80 docstring const & t = docstring(),
81 FuncRequest action = FuncRequest(LFUN_UNKNOWN_ACTION)
88 int depth() const { return depth_; }
90 docstring const & str() const { return str_; }
92 void str(docstring const & s) { str_ = s; }
94 docstring const & tooltip() const;
95 /// String for display, e.g. it has a mark if output is inactive
96 docstring const asString() const;
98 DocIterator const & dit() const { return dit_; }
100 bool isOutput() const { return output_; }
102 void setAction(FuncRequest a) { action_ = a; }
103 /// custom action, or the default one (paragraph-goto) if not customised
104 FuncRequest action() const;
107 /// Current position of item.
115 /// The tooltip string
117 /// Is this item in a note, inactive branch, etc?
125 class Toc : public std::vector<TocItem>
128 typedef std::vector<TocItem>::const_iterator const_iterator;
129 typedef std::vector<TocItem>::iterator iterator;
130 const_iterator item(DocIterator const & dit) const;
131 /// Look for a TocItem given its depth and string.
132 /// \return The first matching item.
133 /// \retval end() if no item was found.
134 iterator item(int depth, docstring const & str);
137 typedef Toc::const_iterator TocIterator;
140 /// Caption-enabled TOC builders
144 TocBuilder(shared_ptr<Toc> const toc);
145 /// When entering a float
146 void pushItem(DocIterator const & dit, docstring const & s,
147 bool output_active, bool is_captioned = false);
148 /// When encountering a caption
149 void captionItem(DocIterator const & dit, docstring const & s,
151 /// When exiting a float
161 shared_ptr<Toc> const toc_;
163 std::stack<frame> stack_;
168 /// A class and no typedef because we want to forward declare it.
169 class TocList : public std::map<std::string, shared_ptr<Toc> >
172 // this can create null pointers
173 using std::map<std::string, shared_ptr<Toc> >::operator[];
178 class TocBuilderStore
181 TocBuilderStore() {};
183 shared_ptr<TocBuilder> get(std::string const & type, shared_ptr<Toc> toc);
185 void clear() { map_.clear(); };
187 typedef std::map<std::string, shared_ptr<TocBuilder> > map_t;
199 TocBackend(Buffer const * buffer) : buffer_(buffer) {}
201 void setBuffer(Buffer const * buffer) { buffer_ = buffer; }
203 void update(bool output_active, UpdateType utype);
204 /// \return true if the item was updated.
205 bool updateItem(DocIterator const & pit);
207 TocList const & tocs() const { return tocs_; }
209 shared_ptr<Toc const> toc(std::string const & type) const;
210 shared_ptr<Toc> toc(std::string const & type);
212 shared_ptr<TocBuilder> builder(std::string const & type);
213 /// Return the first Toc Item before the cursor
215 std::string const & type, ///< Type of Toc.
216 DocIterator const & dit ///< The cursor location in the document.
220 void writePlaintextTocList(std::string const & type,
221 odocstringstream & os, size_t max_length) const;
227 TocBuilderStore builders_;
229 Buffer const * buffer_;
235 #endif // TOC_BACKEND_H