#include "DocIterator.h"
#include "FuncRequest.h"
#include "OutputEnums.h"
+#include "Toc.h"
-#include "support/shared_ptr.h"
#include "support/strfwd.h"
+#include "support/unique_ptr.h"
-#include <map>
-#include <vector>
#include <stack>
-#include <string>
namespace lyx {
*/
class TocItem
{
- friend class Toc;
friend class TocBackend;
friend class TocBuilder;
int depth,
docstring const & s,
bool output_active,
- docstring const & t = docstring(),
FuncRequest action = FuncRequest(LFUN_UNKNOWN_ACTION)
);
///
docstring const & str() const { return str_; }
///
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;
///
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
};
-///
-class Toc : public std::vector<TocItem>
-{
-public:
- typedef std::vector<TocItem>::const_iterator const_iterator;
- typedef std::vector<TocItem>::iterator iterator;
- const_iterator item(DocIterator const & dit) const;
- /// Look for a TocItem given its depth and string.
- /// \return The first matching item.
- /// \retval end() if no item was found.
- iterator item(int depth, docstring const & str);
-};
-
-typedef Toc::const_iterator TocIterator;
-
-
/// Caption-enabled TOC builders
class TocBuilder
{
public:
- TocBuilder(shared_ptr<Toc> const toc);
+ 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);
+ bool output_active, bool is_captioned = false);
/// When encountering a caption
void captionItem(DocIterator const & dit, docstring const & s,
- bool output_active);
+ bool output_active);
/// When exiting a float
void pop();
private:
bool is_captioned;
};
///
- shared_ptr<Toc> const toc_;
+ std::shared_ptr<Toc> const toc_;
///
std::stack<frame> stack_;
};
-/// The ToC list.
-/// A class and no typedef because we want to forward declare it.
-class TocList : public std::map<std::string, shared_ptr<Toc> >
-{
-private:
- // this can create null pointers
- using std::map<std::string, shared_ptr<Toc> >::operator[];
-};
-
-
-///
-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:
+ 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) {}
///
///
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
- TocIterator 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;
+ ///
+ docstring outlinerName(std::string const & type) const;
private:
///
TocList tocs_;
///
- TocBuilderStore builders_;
+ std::map<std::string, unique_ptr<TocBuilder>> builders_;
///
Buffer const * buffer_;
}; // TocBackend