-// -*- C++ -*-\r
-/**\r
- * \file TocBackend.h\r
- * This file is part of LyX, the document processor.\r
- * Licence details can be found in the file COPYING.\r
- *\r
- * \author Jean-Marc Lasgouttes\r
- * \author Angus Leeming\r
- * \author Abdelrazak Younes\r
- *\r
- * Full author contact details are available in file CREDITS.\r
- *\r
- * TocBackend mainly used in toc.[Ch]\r
- */\r
-\r
-#ifndef TOC_BACKEND_H\r
-#define TOC_BACKEND_H\r
-\r
-#include <map>\r
-#include <iosfwd>\r
-#include <vector>\r
-#include <string>\r
-\r
-#include "pariterator.h"\r
-\r
-class Buffer;\r
-class LyXView;\r
-class Paragraph;\r
-class FuncRequest;\r
-class LCursor;\r
-\r
-namespace lyx {\r
-\r
-///\r
-/**\r
-*/\r
-class TocBackend\r
-{\r
-public:\r
-\r
- ///\r
- /**\r
- */\r
- class Item\r
- {\r
- friend class TocBackend;\r
- friend bool operator==(Item const & a, Item const & b);\r
-\r
- public:\r
- ///\r
- Item(\r
- ParConstIterator const & par_it = ParConstIterator(),\r
- int d = -1,\r
- std::string const & s = std::string());\r
- ///\r
- ~Item() {}\r
- ///\r
- bool const isValid() const;\r
- ///\r
- int const id() const;\r
- ///\r
- int const depth() const;\r
- ///\r
- std::string const & str() const;\r
- ///\r
- std::string const asString() const;\r
- /// set cursor in LyXView to this Item\r
- void goTo(LyXView & lv_) const;\r
- /// the action corresponding to the goTo above\r
- FuncRequest action() const;\r
- \r
- protected:\r
- /// Current position of item.\r
- ParConstIterator par_it_;\r
-\r
- /// nesting depth\r
- int depth_;\r
-\r
- /// Full item string\r
- std::string str_;\r
- };\r
-\r
- ///\r
- typedef std::vector<Item> Toc;\r
- typedef std::vector<Item>::const_iterator TocIterator;\r
- ///\r
- typedef std::map<std::string, Toc> TocList;\r
-\r
-public:\r
- ///\r
- TocBackend(Buffer const * buffer = NULL): buffer_(buffer) {}\r
- ///\r
- ~TocBackend() {}\r
- ///\r
- void setBuffer(Buffer const * buffer)\r
- { buffer_ = buffer; }\r
- ///\r
- bool addType(std::string const & type);\r
- ///\r
- void update();\r
- ///\r
- TocList const & tocs()\r
- { return tocs_; }\r
- ///\r
- std::vector<std::string> const & types()\r
- { return types_; }\r
- ///\r
- Toc const & toc(std::string const & type);\r
- /// Return the first Toc Item before the cursor\r
- TocIterator const item(std::string const & type, ParConstIterator const &);\r
-\r
- void asciiTocList(std::string const & type, std::ostream & os) const;\r
-\r
-private:\r
- /// \r
- TocList tocs_;\r
- ///\r
- std::vector<std::string> types_;\r
- ///\r
- Buffer const * buffer_;\r
-\r
-}; // TocBackend\r
-\r
-inline\r
-bool operator==(TocBackend::Item const & a, TocBackend::Item const & b)\r
-{\r
- return a.id() == b.id() && a.str() == b.str();\r
- // No need to compare depth.\r
-}\r
-\r
-\r
-inline\r
-bool operator!=(TocBackend::Item const & a, TocBackend::Item const & b)\r
-{\r
- return !(a == b);\r
-}\r
-\r
-\r
-} // namespace lyx\r
-\r
-#endif // TOC_BACKEND_H\r
+// -*- C++ -*-
+/**
+ * \file TocBackend.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
+ *
+ * \author Jean-Marc Lasgouttes
+ * \author Angus Leeming
+ * \author Abdelrazak Younes
+ * \author Guillaume Munch
+ *
+ * Full author contact details are available in file CREDITS.
+ */
+
+#ifndef TOC_BACKEND_H
+#define TOC_BACKEND_H
+
+#include "DocIterator.h"
+#include "FuncRequest.h"
+#include "OutputEnums.h"
+#include "Toc.h"
+#include "TocBuilder.h"
+
+#include "support/strfwd.h"
+#include "support/unique_ptr.h"
+
+
+namespace lyx {
+
+class Buffer;
+
+/* Toc types are described by strings. They cannot be converted into an enum
+ * because of the user-configurable categories for index and the user-definable
+ * toc types provided in layout files.
+ *
+ * Here is a summary of built-in toc types
+ *
+ * Non-customizable (used without TocBuilder): "tableofcontents", "change",
+ * "citation", "label", "senseless".
+ *
+ * Built-in but customizable (used with TocBuilder): "child", "graphics",
+ * "equation", "index", "index:<user-str>", "nomencl", "listings", "math-macro",
+ * "external", any float type (as defined in the layouts).
+ *
+ * The following are used for XHTML output: "tableofcontents" (InsetText),
+ * "citation" (InsetCitation), any float type.
+ *
+ * Other types are defined in the layouts.
+ */
+
+///
+/**
+*/
+class TocItem
+{
+public:
+ /// Default constructor for STL containers.
+ TocItem() : dit_(0), depth_(0), output_(false) {}
+ ///
+ TocItem(DocIterator const & dit,
+ int depth,
+ docstring const & s,
+ bool output_active,
+ FuncRequest action = FuncRequest(LFUN_UNKNOWN_ACTION)
+ );
+ ///
+ DocIterator const & dit() const { return dit_; }
+ ///
+ int depth() const { return depth_; }
+ ///
+ docstring const & str() const { return str_; }
+ ///
+ void str(docstring const & s) { str_ = s; }
+ ///
+ bool isOutput() const { return output_; }
+ ///
+ void setAction(FuncRequest a) { action_ = a; }
+
+ /// custom action, or the default one (paragraph-goto) if not customised
+ FuncRequest action() const;
+ ///
+ int id() const;
+ /// String for display, e.g. it has a mark if output is inactive
+ docstring const asString() const;
+
+private:
+ /// Current position of item.
+ DocIterator dit_;
+ /// nesting depth
+ int depth_;
+ /// Full item string
+ docstring str_;
+ /// Is this item in a note, inactive branch, etc?
+ bool output_;
+ /// Custom action
+ FuncRequest action_;
+};
+
+
+/// Class to build and access the Tocs of a particular buffer.
+class TocBackend
+{
+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
+ std::shared_ptr<Toc const> toc(std::string const & type) const;
+ /// never null
+ std::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;
+ /// Localised name for type
+ docstring outlinerName(std::string const & type) const;
+ /// Add a new (localised) name if yet unknown
+ void addName(std::string const & type, docstring const & name);
+ /// Whether a toc type is less important and appears in the "Other lists"
+ /// submenu
+ static bool isOther(std::string const & type);
+
+private:
+ ///
+ void resetOutlinerNames();
+ ///
+ TocList tocs_;
+ ///
+ std::map<std::string, unique_ptr<TocBuilder>> builders_;
+ /// Stores localised outliner names from this buffer and its children
+ std::map<std::string, docstring> outliner_names_;
+ ///
+ Buffer const * buffer_;
+}; // TocBackend
+
+
+} // namespace lyx
+
+#endif // TOC_BACKEND_H
projects / lyx.git / blobdiff