Remove hardcoded values

[lyx.git] / src / TocBackend.h

diff --git a/src/TocBackend.h b/src/TocBackend.h
index 2520927406dd15a2cebbf5aa86d4cf9d9be96c2d..10bfff1ea09a4b9f5aebc9843a87fae840f98b5d 100644 (file)
--- a/src/TocBackend.h
+++ b/src/TocBackend.h
@@ -21,6 +21,7 @@
 #include "Toc.h"
 
 #include "support/strfwd.h"
+#include "support/unique_ptr.h"
 
 #include <stack>
 
@@ -75,7 +76,6 @@ public:
                int depth,
                docstring const & s,
                bool output_active,
-               docstring const & t = docstring(),
                FuncRequest action = FuncRequest(LFUN_UNKNOWN_ACTION)
                );
        ///
@@ -88,8 +88,6 @@ public:
        docstring const & str() const { return str_; }
        ///
        void str(docstring const & s) { str_ = s; }
-       ///
-       docstring const & tooltip() const;
        /// String for display, e.g. it has a mark if output is inactive
        docstring const asString() const;
        ///
@@ -110,8 +108,6 @@ private:
        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
@@ -123,13 +119,13 @@ private:
 class TocBuilder
 {
 public:
-       TocBuilder(shared_ptr<Toc> const toc);
+       TocBuilder(std::shared_ptr<Toc> const toc);
        /// When entering a float
        void pushItem(DocIterator const & dit, docstring const & s,
-                                 bool output_active, bool is_captioned = false);
+                     bool output_active, bool is_captioned = false);
        /// When encountering a caption
        void captionItem(DocIterator const & dit, docstring const & s,
-                                        bool output_active);
+                        bool output_active);
        /// When exiting a float
        void pop();
 private:
@@ -140,30 +136,13 @@ private:
                bool is_captioned;
        };
        ///
-       shared_ptr<Toc> const toc_;
+       std::shared_ptr<Toc> const toc_;
        ///
        std::stack<frame> stack_;
 };
 
 
-///
-class TocBuilderStore
-{
-public:
-       TocBuilderStore() {};
-       ///
-       shared_ptr<TocBuilder> get(std::string const & type, shared_ptr<Toc> toc);
-       ///
-       void clear() { map_.clear(); };
-private:
-       typedef std::map<std::string, shared_ptr<TocBuilder> > map_t;
-       map_t map_;
-};
-
-
-///
-/**
-*/
+/// Class to build and access the Tocs of a particular buffer.
 class TocBackend
 {
 public:
@@ -184,15 +163,17 @@ public:
        ///
        TocList const & tocs() const { return tocs_; }
        /// never null
-       shared_ptr<Toc const> toc(std::string const & type) const;
-       shared_ptr<Toc> toc(std::string const & type);
-       /// nevel null
-       shared_ptr<TocBuilder> builder(std::string const & type);
-       /// Return the first Toc Item before the cursor
-       Toc::const_iterator item(
-               std::string const & type, ///< Type of Toc.
-               DocIterator const & dit ///< The cursor location in the document.
-       ) const;
+       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,
@@ -204,7 +185,7 @@ private:
        ///
        TocList tocs_;
        ///
-       TocBuilderStore builders_;
+       std::map<std::string, unique_ptr<TocBuilder>> builders_;
        ///
        Buffer const * buffer_;
 }; // TocBackend