#include "FuncRequest.h"
#include "OutputEnums.h"
#include "Toc.h"
+#include "TocBuilder.h"
#include "support/strfwd.h"
-
-#include <stack>
+#include "support/unique_ptr.h"
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
*
- * I leave this for documentation purposes for the moment.
+ * Non-customizable (used without TocBuilder): "tableofcontents", "change",
+ * "citation", "label", "senseless".
*
-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
-}
+ * 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
{
- friend class TocBackend;
- friend class TocBuilder;
-
public:
/// Default constructor for STL containers.
TocItem() : dit_(0), depth_(0), output_(false) {}
int depth,
docstring const & s,
bool output_active,
- docstring const & t = docstring(),
FuncRequest action = FuncRequest(LFUN_UNKNOWN_ACTION)
);
///
- ~TocItem() {}
- ///
- int id() const;
+ DocIterator const & dit() const { return dit_; }
///
int depth() const { return depth_; }
///
///
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;
- ///
- 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
docstring str_;
- /// The tooltip string
- docstring tooltip_;
/// Is this item in a note, inactive branch, etc?
bool output_;
/// Custom 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(){}
- ///
- struct frame {
- Toc::size_type pos;
- bool is_captioned;
- };
- ///
- 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:
///
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,
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_;
///
- TocBuilderStore builders_;
+ 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
projects / lyx.git / blobdiff