X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=src%2FTocBackend.h;h=a38a972834f9c2155af1dbb6f1f512a3eb5a8efc;hb=28be7d552f62cc02fa86d7f79201d089bfb2d7b5;hp=a2643e82add6b822edce4569dab9d2dba7e69f15;hpb=34b7650cbbe6a9ed2de812e75771451b8c8fe983;p=lyx.git diff --git a/src/TocBackend.h b/src/TocBackend.h index a2643e82ad..a38a972834 100644 --- a/src/TocBackend.h +++ b/src/TocBackend.h @@ -7,133 +7,153 @@ * \author Jean-Marc Lasgouttes * \author Angus Leeming * \author Abdelrazak Younes + * \author Guillaume Munch * * Full author contact details are available in file CREDITS. - * - * TocBackend mainly used in toc.[Ch] */ #ifndef TOC_BACKEND_H #define TOC_BACKEND_H -#include -#include -#include -#include +#include "DocIterator.h" +#include "FuncRequest.h" +#include "OutputEnums.h" +#include "Toc.h" +#include "TocBuilder.h" -#include "pariterator.h" +#include "support/strfwd.h" +#include "support/unique_ptr.h" -class Buffer; -class LyXView; -class Paragraph; -class FuncRequest; -class LCursor; 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:", "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 TocBackend +class TocItem { public: - + /// Default constructor for STL containers. + TocItem() : dit_(0), depth_(0), output_(false) {} /// - /** - */ - class Item - { - friend class TocBackend; - friend bool operator==(Item const & a, Item const & b); - - public: - /// - Item( - ParConstIterator const & par_it = ParConstIterator(), - int d = -1, - lyx::docstring const & s = lyx::docstring()); - /// - ~Item() {} - /// - bool const isValid() const; - /// - int const id() const; - /// - int const depth() const; - /// - lyx::docstring const & str() const; - /// - lyx::docstring const asString() const; - /// set cursor in LyXView to this Item - void goTo(LyXView & lv_) const; - /// the action corresponding to the goTo above - FuncRequest action() const; - - protected: - /// Current position of item. - ParConstIterator par_it_; - - /// nesting depth - int depth_; - - /// Full item string - lyx::docstring str_; - }; - - /// - typedef std::vector Toc; - typedef std::vector::const_iterator TocIterator; - /// - typedef std::map TocList; - -public: + TocItem(DocIterator const & dit, + int depth, + docstring const & s, + bool output_active, + FuncRequest action = FuncRequest(LFUN_UNKNOWN_ACTION) + ); /// - TocBackend(Buffer const * buffer = NULL): buffer_(buffer) {} + DocIterator const & dit() const { return dit_; } /// - ~TocBackend() {} + int depth() const { return depth_; } /// - void setBuffer(Buffer const * buffer) - { buffer_ = buffer; } + docstring const & str() const { return str_; } /// - bool addType(std::string const & type); + void str(docstring const & s) { str_ = s; } /// - void update(); + bool isOutput() const { return output_; } /// - TocList const & tocs() - { return tocs_; } + void setAction(FuncRequest a) { action_ = a; } + + /// custom action, or the default one (paragraph-goto) if not customised + FuncRequest action() const; /// - std::vector const & types() - { return types_; } + 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); /// - Toc const & toc(std::string const & type); - /// Return the first Toc Item before the cursor - TocIterator const item(std::string const & type, ParConstIterator const &); + 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(std::string const & type) const; + /// never null + std::shared_ptr 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 asciiTocList(std::string const & type, lyx::odocstream & os) 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::vector types_; + std::map> builders_; + /// Stores localised outliner names from this buffer and its children + std::map outliner_names_; /// Buffer const * buffer_; - }; // TocBackend -inline -bool operator==(TocBackend::Item const & a, TocBackend::Item const & b) -{ - return a.id() == b.id() && a.str() == b.str() && a.depth() == b.depth(); -} - - -inline -bool operator!=(TocBackend::Item const & a, TocBackend::Item const & b) -{ - return !(a == b); -} - } // namespace lyx