X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FTocBackend.h;h=0671f046f039f8a5fbec4e688b7ff07a08f5ed20;hb=ddda1369247a562684a4ec59f320f16b7938a6d6;hp=4a03493db888aa79a6731ff466d6c843178ccf25;hpb=479e9054dbba9753a1a5e03e12ffab970caf4557;p=lyx.git diff --git a/src/TocBackend.h b/src/TocBackend.h index 4a03493db8..0671f046f0 100644 --- a/src/TocBackend.h +++ b/src/TocBackend.h @@ -7,131 +7,192 @@ * \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 "DocIterator.h" +#include "FuncRequest.h" +#include "OutputEnums.h" +#include "Toc.h" -#include "pariterator.h" +#include "support/strfwd.h" +#include "support/unique_ptr.h" -#include "support/docstream.h" +#include namespace lyx { class Buffer; -class Paragraph; -class FuncRequest; -class LCursor; + + +/* 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. + * + * I leave this for documentation purposes for the moment. + * +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:" (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 +} + */ /// /** */ -class TocBackend +class TocItem { -public: - /// - /** - */ - class Item - { - friend class TocBackend; - friend bool operator==(Item const & a, Item const & b); - - public: - /// - Item( - ParConstIterator const & par_it = ParConstIterator(), - int d = -1, - docstring const & s = docstring()); - /// - ~Item() {} - /// - bool const isValid() const; - /// - int const id() const; - /// - int const depth() const; - /// - docstring const & str() const; - /// - docstring const asString() 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 - docstring str_; - }; + friend class TocBackend; + friend class TocBuilder; +public: + /// Default constructor for STL containers. + TocItem() : dit_(0), depth_(0), output_(false) {} /// - typedef std::vector Toc; - typedef std::vector::const_iterator TocIterator; + TocItem(DocIterator const & dit, + int depth, + docstring const & s, + bool output_active, + docstring const & t = docstring(), + FuncRequest action = FuncRequest(LFUN_UNKNOWN_ACTION)); /// - typedef std::map TocList; - -public: + ~TocItem() {} /// - TocBackend(Buffer const * buffer = NULL): buffer_(buffer) {} + int id() const; /// - ~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(); + docstring const & tooltip() const; + /// String for display, e.g. it has a mark if output is inactive + docstring const asString() const; /// - TocList const & tocs() const - { return tocs_; } + DocIterator const & dit() const { return dit_; } /// - std::vector const & types() const - { return types_; } + bool isOutput() const { return output_; } /// - Toc const & toc(std::string const & type) const; - /// Return the first Toc Item before the cursor - TocIterator const item(std::string const & type, ParConstIterator const &) const; + void setAction(FuncRequest a) { action_ = a; } + /// custom action, or the default one (paragraph-goto) if not customised + FuncRequest action() const; - void asciiTocList(std::string const & type, odocstream & os) const; +protected: + /// Current position of item. + DocIterator dit_; private: - /// - TocList tocs_; + /// 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 + FuncRequest action_; +}; + + +/// Caption-enabled TOC builders +class TocBuilder +{ +public: + TocBuilder(std::shared_ptr 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(){} /// - std::vector types_; + struct frame { + Toc::size_type pos; + bool is_captioned; + }; /// - Buffer const * buffer_; + std::shared_ptr const toc_; + /// + std::stack stack_; +}; -}; // TocBackend -inline -bool operator==(TocBackend::Item const & a, TocBackend::Item const & b) +/// Class to build and access the Tocs of a particular buffer. +class TocBackend { - return a.id() == b.id() && a.str() == b.str() && a.depth() == b.depth(); -} +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); + /// + 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 writePlaintextTocList(std::string const & type, + odocstringstream & os, size_t max_length) const; + /// + docstring outlinerName(std::string const & type) const; -inline -bool operator!=(TocBackend::Item const & a, TocBackend::Item const & b) -{ - return !(a == b); -} +private: + /// + TocList tocs_; + /// + std::map> builders_; + /// + Buffer const * buffer_; +}; // TocBackend } // namespace lyx