Disable CheckTeX while buffer is processed

[lyx.git] / src / TocBackend.h

diff --git a/src/TocBackend.h b/src/TocBackend.h
index e13773fa23abba978880583563f049b760cd5b4b..a38a972834f9c2155af1dbb6f1f512a3eb5a8efc 100644 (file)
--- a/src/TocBackend.h
+++ b/src/TocBackend.h
@@ -19,51 +19,33 @@
 #include "FuncRequest.h"
 #include "OutputEnums.h"
 #include "Toc.h"
+#include "TocBuilder.h"
 
 #include "support/strfwd.h"
 #include "support/unique_ptr.h"
 
-#include <stack>
-
 
 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.
+/* 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".
  *
- * I leave this for documentation purposes for the moment.
+ * 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).
  *
-enum TocType {
-// Non-customizable (does not use TocBuilder)
-       //The following is used for XHTML output
-       TABLE_OF_CONTENTS,//"tableofcontents"
-       CHANGE,//"change"
-       //The following is used for XHTML output
-       CITATION,//"citation"
-       LABEL,//"label"
-       SENSELESS,//"senseless"
-// Built-in but customizable
-       CHILD,//"child"
-       GRAPHICS,//"graphics"
-       EQUATION,//"equation"
-       INDEX,//"index", "index:<user-str>" (from interface)
-       NOMENCL,//"nomencl"
-       LISTING,//"listings"
-       //The following are used for XHTML output
-       FLOAT,//"figure", "table", "algorithm", user-defined (from layout?)
-       MATH_MACRO,//"math-macro"
-       EXTERNAL,//"external"
-// Defined in layouts
-       NOTE,//"note"
-       FOOTNOTE,//"footnote"
-       MARGINAL_NOTE,//"marginalnote"
-       BRANCH,//"branch"
-       USER_DEFINED //any value 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.
  */
 
 ///
@@ -71,9 +53,6 @@ enum TocType {
 */
 class TocItem
 {
-       friend class TocBackend;
-       friend class TocBuilder;
-
 public:
        /// Default constructor for STL containers.
        TocItem() : dit_(0), depth_(0), output_(false) {}
@@ -85,31 +64,28 @@ public:
                FuncRequest action = FuncRequest(LFUN_UNKNOWN_ACTION)
                );
        ///
-       ~TocItem() {}
-       ///
-       int id() const;
+       DocIterator const & dit() const { return dit_; }
        ///
        int depth() const { return depth_; }
        ///
        docstring const & str() const { return str_; }
        ///
        void str(docstring const & s) { str_ = s; }
-       /// String for display, e.g. it has a mark if output is inactive
-       docstring const asString() const;
-       ///
-       DocIterator const & dit() const { return dit_; }
        ///
        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;
 
-protected:
+private:
        /// Current position of item.
        DocIterator dit_;
-
-private:
        /// nesting depth
        int depth_;
        /// Full item string
@@ -121,35 +97,6 @@ private:
 };
 
 
-/// Caption-enabled TOC builders
-class TocBuilder
-{
-public:
-       TocBuilder(std::shared_ptr<Toc> toc);
-       /// When entering a float or flex or paragraph (with AddToToc)
-       void pushItem(DocIterator const & dit, docstring const & s,
-                     bool output_active, bool is_captioned = false);
-       /// When encountering a float caption
-       void captionItem(DocIterator const & dit, docstring const & s,
-                        bool output_active);
-       /// When encountering an argument (with isTocCaption) for flex or paragraph
-       void argumentItem(docstring const & arg_str);
-       /// When exiting a float or flex or paragraph
-       void pop();
-private:
-       TocBuilder(){}
-       ///
-       struct frame {
-               Toc::size_type pos;
-               bool is_captioned;
-       };
-       ///
-       std::shared_ptr<Toc> const toc_;
-       ///
-       std::stack<frame> stack_;
-};
-
-
 /// Class to build and access the Tocs of a particular buffer.
 class TocBackend
 {
@@ -186,17 +133,23 @@ public:
        ///
        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