X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FTocBackend.h;h=c3a178d12ff32900da9df475aa283f2500b4ab5b;hb=e26a60edef3eae39c2e8379f395febedc5ba7efa;hp=10bfff1ea09a4b9f5aebc9843a87fae840f98b5d;hpb=d1dddde6d800834eb6b8c7626da4d251e7c74f08;p=features.git

diff --git a/src/TocBackend.h b/src/TocBackend.h
index 10bfff1ea0..c3a178d12f 100644
--- a/src/TocBackend.h
+++ b/src/TocBackend.h
@@ -19,45 +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".
+ *
+ * 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).
  *
- * I leave this for documentation purposes for the moment.
+ * The following are used for XHTML output: "tableofcontents" (InsetText),
+ * "citation" (InsetCitation), any float type.
  *
-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
-}
+ * Other types are defined in the layouts.
  */
 
 ///
@@ -65,83 +53,55 @@ enum TocType {
 */
 class TocItem
 {
-	friend class TocBackend;
-	friend class TocBuilder;
-
 public:
 	/// Default constructor for STL containers.
-	TocItem() : dit_(0), depth_(0), output_(false) {}
+	TocItem() : dit_(0), depth_(0), output_(false), missing_(false) {}
 	///
 	TocItem(DocIterator const & dit,
 		int depth,
 		docstring const & s,
 		bool output_active,
-		FuncRequest action = FuncRequest(LFUN_UNKNOWN_ACTION)
+		bool missing = false,
+		FuncRequest const & 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; }
+	bool isMissing() const { return missing_; }
+	///
+	void setAction(FuncRequest const & 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
 	docstring str_;
 	/// Is this item in a note, inactive branch, etc?
 	bool output_;
+	/// Is this item missing, e.g. missing label?
+	bool missing_;
 	/// Custom action
 	FuncRequest action_;
 };
 
 
-/// Caption-enabled TOC builders
-class TocBuilder
-{
-public:
-	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);
-	/// When encountering a caption
-	void captionItem(DocIterator const & dit, docstring const & s,
-	                 bool output_active);
-	/// When exiting a float
-	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
 {
@@ -158,8 +118,10 @@ public:
 	void setBuffer(Buffer const * buffer) { buffer_ = buffer; }
 	///
 	void update(bool output_active, UpdateType utype);
+	///
+	void reset();
 	/// \return true if the item was updated.
-	bool updateItem(DocIterator const & pit);
+	bool updateItem(DocIterator const & pit) const;
 	///
 	TocList const & tocs() const { return tocs_; }
 	/// never null
@@ -178,14 +140,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_;
+    std::map<std::string, std::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