#define TOC_BACKEND_H
#include <map>
-#include <iosfwd>
#include <vector>
#include <string>
#include "pariterator.h"
-class Buffer;
-class LyXView;
-class Paragraph;
-class FuncRequest;
-class LCursor;
+#include "support/docstream.h"
+
namespace lyx {
+class Buffer;
+class FuncRequest;
+
///
/**
*/
-class TocBackend
+class TocItem
{
-public:
+ friend class TocBackend;
+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,
- 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_;
- };
-
+ TocItem(ParConstIterator const & par_it = ParConstIterator(),
+ int d = -1,
+ docstring const & s = docstring());
+ ///
+ ~TocItem() {}
+ ///
+ bool const isValid() const;
+ ///
+ int const id() const;
///
- typedef std::vector<Item> Toc;
- typedef std::vector<Item>::const_iterator TocIterator;
+ int const depth() const;
///
- typedef std::map<std::string, Toc> TocList;
+ 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_;
+};
+
+///
+typedef std::vector<TocItem> Toc;
+typedef Toc::const_iterator TocIterator;
+/// The ToC list.
+/// A class and no typedef because we want to forward declare it.
+class TocList : public std::map<std::string, Toc>
+{
+};
+
+
+///
+/**
+*/
+class TocBackend
+{
public:
///
TocBackend(Buffer const * buffer = NULL): buffer_(buffer) {}
void setBuffer(Buffer const * buffer)
{ buffer_ = buffer; }
///
- bool addType(std::string const & type);
- ///
void update();
///
- TocList const & tocs()
- { return tocs_; }
+ void updateItem(ParConstIterator const & pit);
+
///
- std::vector<std::string> const & types()
- { return types_; }
+ TocList const & tocs() const
+ { return tocs_; }
+
///
- Toc const & toc(std::string const & type);
+ 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 &);
+ TocIterator const item(std::string const & type, ParConstIterator const &) const;
- void asciiTocList(std::string const & type, lyx::odocstream & os) const;
+ void writePlaintextTocList(std::string const & type, odocstream & os) const;
private:
///
TocList tocs_;
///
- std::vector<std::string> types_;
- ///
Buffer const * buffer_;
}; // TocBackend
inline
-bool operator==(TocBackend::Item const & a, TocBackend::Item const & b)
+bool operator==(TocItem const & a, TocItem 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)
+bool operator!=(TocItem const & a, TocItem const & b)
{
return !(a == b);
}