#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 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,
- FuncRequest action = FuncRequest(LFUN_UNKNOWN_ACTION)
+ 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; }
+ 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
};
-/// Caption-enabled TOC builders
-class TocBuilder
-{
-public:
- TocBuilder(std::shared_ptr<Toc> toc);
- /// When entering a float or flex or paragraph (with AddToToc)
- void pushItem(DocIterator const & dit, docstring const & s,
- bool output_active, bool is_captioned = false);
- /// When encountering a float caption
- void captionItem(DocIterator const & dit, docstring const & s,
- bool output_active);
- /// When encountering an argument (with isTocCaption) for flex or paragraph
- void argumentItem(docstring const & arg_str);
- /// When exiting a float or flex or paragraph
- 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
{
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);
///
///
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