* \author Jean-Marc Lasgouttes
* \author Angus Leeming
* \author Abdelrazak Younes
+ * \author Guillaume Munch
*
* Full author contact details are available in file CREDITS.
- *
- * TocBackend mainly used in toc.[Ch]
*/
#ifndef TOC_BACKEND_H
#define TOC_BACKEND_H
-#include <map>
-#include <iosfwd>
-#include <vector>
-#include <string>
+#include "DocIterator.h"
+#include "FuncRequest.h"
+#include "OutputEnums.h"
+#include "Toc.h"
-#include "pariterator.h"
+#include "support/strfwd.h"
+#include "support/unique_ptr.h"
+
+#include <stack>
-class Buffer;
-class LyXView;
-class Paragraph;
-class FuncRequest;
-class LCursor;
+
+using std::shared_ptr;
namespace lyx {
+class Buffer;
+
+
+/* FIXME: toc types are currently identified by strings. It cannot be converted
+ * into an enum because of the user-configurable indexing categories and
+ * the user-definable float types provided by layout files.
+ *
+ * I leave this for documentation purposes for the moment.
+ *
+enum TocType {
+ TABLE_OF_CONTENTS,//"tableofcontents"
+ CHILD,//"child"
+ GRAPHICS,//"graphics"
+ NOTE,//"note"
+ BRANCH,//"branch"
+ CHANGE,//"change"
+ LABEL,//"label"
+ CITATION,//"citation"
+ EQUATION,//"equation"
+ FOOTNOTE,//"footnote"
+ MARGINAL_NOTE,//"marginalnote"
+ INDEX,//"index", "index:<user-str>" (from interface)
+ NOMENCL,//"nomencl"
+ LISTING,//"listings"
+ FLOAT,//"figure", "table", "algorithm", user-defined (from layout?)
+ MATH_MACRO,//"math-macro"
+ EXTERNAL,//"external"
+ SENSELESS,//"senseless"
+ TOC_TYPE_COUNT
+}
+ */
+
///
/**
*/
-class TocBackend
+class TocItem
{
-public:
+ friend class TocBackend;
+ friend class TocBuilder;
+public:
+ /// Default constructor for STL containers.
+ TocItem() : dit_(0), depth_(0), output_(false) {}
///
- /**
- */
- class Item
- {
- friend class TocBackend;
- friend bool operator==(Item const & a, Item const & b);
-
- public:
- ///
- Item(
- ParConstIterator const & par_it = ParConstIterator(),
- int d = -1,
- std::string const & s = std::string());
- ///
- ~Item() {}
- ///
- bool const isValid() const;
- ///
- int const id() const;
- ///
- int const depth() const;
- ///
- std::string const & str() const;
- ///
- std::string const asString() const;
- /// set cursor in LyXView to this Item
- void goTo(LyXView & lv_) const;
- /// the action corresponding to the goTo above
- FuncRequest action() const;
-
- protected:
- /// Current position of item.
- ParConstIterator par_it_;
-
- /// nesting depth
- int depth_;
-
- /// Full item string
- std::string str_;
- };
-
+ TocItem(DocIterator const & dit,
+ int depth,
+ docstring const & s,
+ bool output_active,
+ docstring const & t = docstring(),
+ FuncRequest action = FuncRequest(LFUN_UNKNOWN_ACTION));
///
- typedef std::vector<Item> Toc;
- typedef std::vector<Item>::const_iterator TocIterator;
+ ~TocItem() {}
///
- typedef std::map<std::string, Toc> TocList;
-
-public:
- ///
- TocBackend(Buffer const * buffer = NULL): buffer_(buffer) {}
+ int id() const;
///
- ~TocBackend() {}
+ int depth() const { return depth_; }
///
- void setBuffer(Buffer const * buffer)
- { buffer_ = buffer; }
+ docstring const & str() const { return str_; }
///
- bool addType(std::string const & type);
+ void str(docstring const & s) { str_ = s; }
///
- void update();
+ docstring const & tooltip() const;
+ /// String for display, e.g. it has a mark if output is inactive
+ docstring const asString() const;
///
- TocList const & tocs()
- { return tocs_; }
+ DocIterator const & dit() const { return dit_; }
///
- std::vector<std::string> const & types()
- { return types_; }
+ bool isOutput() const { return output_; }
///
- Toc const & toc(std::string const & type);
- /// Return the first Toc Item before the cursor
- TocIterator const item(std::string const & type, ParConstIterator const &);
+ void setAction(FuncRequest a) { action_ = a; }
+ /// custom action, or the default one (paragraph-goto) if not customised
+ FuncRequest action() const;
- void asciiTocList(std::string const & type, std::ostream & os) const;
+protected:
+ /// Current position of item.
+ DocIterator dit_;
private:
- ///
- TocList tocs_;
+ /// nesting depth
+ int depth_;
+ /// Full item string
+ docstring str_;
+ /// The tooltip string
+ docstring tooltip_;
+ /// Is this item in a note, inactive branch, etc?
+ bool output_;
+ /// Custom action
+ FuncRequest action_;
+};
+
+
+/// Caption-enabled TOC builders
+class TocBuilder
+{
+public:
+ TocBuilder(shared_ptr<Toc> const toc);
+ /// When entering a float
+ void pushItem(DocIterator const & dit, docstring const & s,
+ bool output_active, bool is_captioned = false);
+ /// When encountering a caption
+ void captionItem(DocIterator const & dit, docstring const & s,
+ bool output_active);
+ /// When exiting a float
+ void pop();
+private:
+ TocBuilder(){}
///
- std::vector<std::string> types_;
+ struct frame {
+ Toc::size_type pos;
+ bool is_captioned;
+ };
///
- Buffer const * buffer_;
+ shared_ptr<Toc> const toc_;
+ ///
+ std::stack<frame> stack_;
+};
-}; // TocBackend
-inline
-bool operator==(TocBackend::Item const & a, TocBackend::Item const & b)
+/// Class to build and access the Tocs of a particular buffer.
+class TocBackend
{
- return a.id() == b.id() && a.str() == b.str();
- // No need to compare depth.
-}
+public:
+ static Toc::const_iterator findItem(Toc const & toc,
+ DocIterator const & dit);
+ /// Look for a TocItem given its depth and string.
+ /// \return The first matching item.
+ /// \retval end() if no item was found.
+ static Toc::iterator findItem(Toc & toc, int depth, docstring const & str);
+ ///
+ TocBackend(Buffer const * buffer) : buffer_(buffer) {}
+ ///
+ void setBuffer(Buffer const * buffer) { buffer_ = buffer; }
+ ///
+ void update(bool output_active, UpdateType utype);
+ /// \return true if the item was updated.
+ bool updateItem(DocIterator const & pit);
+ ///
+ TocList const & tocs() const { return tocs_; }
+ /// never null
+ shared_ptr<Toc const> toc(std::string const & type) const;
+ /// never null
+ shared_ptr<Toc> toc(std::string const & type);
+ /// \return the current TocBuilder for the Toc of type \param type, or
+ /// creates one if it does not already exist.
+ TocBuilder & builder(std::string const & type);
+ /// \return the first Toc Item before the cursor.
+ /// \param type: Type of Toc.
+ /// \param dit: The cursor location in the document.
+ Toc::const_iterator
+ item(std::string const & type, DocIterator const & dit) const;
+ ///
+ void writePlaintextTocList(std::string const & type,
+ odocstringstream & os, size_t max_length) const;
+ ///
+ docstring outlinerName(std::string const & type) const;
-inline
-bool operator!=(TocBackend::Item const & a, TocBackend::Item const & b)
-{
- return !(a == b);
-}
+private:
+ ///
+ TocList tocs_;
+ ///
+ std::map<std::string, unique_ptr<TocBuilder>> builders_;
+ ///
+ Buffer const * buffer_;
+}; // TocBackend
} // namespace lyx
projects / lyx.git / blobdiff