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"
23 #include "support/strfwd.h"
24 #include "support/unique_ptr.h"
29 using std::shared_ptr;
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 MATH_MACRO,//"math-macro"
60 SENSELESS,//"senseless"
70 friend class TocBackend;
71 friend class TocBuilder;
74 /// Default constructor for STL containers.
75 TocItem() : dit_(0), depth_(0), output_(false) {}
77 TocItem(DocIterator const & dit,
81 docstring const & t = docstring(),
82 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?
124 /// Caption-enabled TOC builders
128 TocBuilder(shared_ptr<Toc> const toc);
129 /// When entering a float
130 void pushItem(DocIterator const & dit, docstring const & s,
131 bool output_active, bool is_captioned = false);
132 /// When encountering a caption
133 void captionItem(DocIterator const & dit, docstring const & s,
135 /// When exiting a float
145 shared_ptr<Toc> const toc_;
147 std::stack<frame> stack_;
151 /// Class to build and access the Tocs of a particular buffer.
155 static Toc::const_iterator findItem(Toc const & toc,
156 DocIterator const & dit);
157 /// Look for a TocItem given its depth and string.
158 /// \return The first matching item.
159 /// \retval end() if no item was found.
160 static Toc::iterator findItem(Toc & toc, int depth, docstring const & str);
162 TocBackend(Buffer const * buffer) : buffer_(buffer) {}
164 void setBuffer(Buffer const * buffer) { buffer_ = buffer; }
166 void update(bool output_active, UpdateType utype);
167 /// \return true if the item was updated.
168 bool updateItem(DocIterator const & pit);
170 TocList const & tocs() const { return tocs_; }
172 shared_ptr<Toc const> toc(std::string const & type) const;
174 shared_ptr<Toc> toc(std::string const & type);
175 /// \return the current TocBuilder for the Toc of type \param type, or
176 /// creates one if it does not already exist.
177 TocBuilder & builder(std::string const & type);
178 /// \return the first Toc Item before the cursor.
179 /// \param type: Type of Toc.
180 /// \param dit: The cursor location in the document.
182 item(std::string const & type, DocIterator const & dit) const;
185 void writePlaintextTocList(std::string const & type,
186 odocstringstream & os, size_t max_length) const;
188 docstring outlinerName(std::string const & type) const;
194 std::map<std::string, unique_ptr<TocBuilder>> builders_;
196 Buffer const * buffer_;
202 #endif // TOC_BACKEND_H