* \author Abdelrazak Younes
*
* Full author contact details are available in file CREDITS.
- *
- * TocBackend mainly used in toc.[Ch]
*/
#ifndef TOC_BACKEND_H
#define TOC_BACKEND_H
+#include "DocIterator.h"
+
+#include "support/strfwd.h"
+
#include <map>
-#include <iosfwd>
#include <vector>
#include <string>
-#include "pariterator.h"
+
+namespace lyx {
class Buffer;
-class LyXView;
-class Paragraph;
class FuncRequest;
-class LCursor;
-
-namespace lyx {
///
/**
*/
-class TocBackend
+class TocItem
{
-public:
+ friend class Toc;
+ friend class TocBackend;
+public:
+ /// Default constructor for STL containers.
+ TocItem() : dit_(0) {}
///
- /**
- */
- 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(DocIterator const & dit,
+ int depth,
+ docstring const & s
+ );
///
- typedef std::vector<Item> Toc;
- typedef std::vector<Item>::const_iterator TocIterator;
+ ~TocItem() {}
///
- typedef std::map<std::string, Toc> TocList;
-
-public:
+ int id() const;
///
- TocBackend(Buffer const * buffer = NULL): buffer_(buffer) {}
+ int depth() const;
///
- ~TocBackend() {}
+ docstring const & str() const;
///
- void setBuffer(Buffer const * buffer)
- { buffer_ = buffer; }
+ docstring const asString() const;
+
+ /// the action corresponding to the goTo above
+ FuncRequest action() const;
+
+protected:
+ /// Current position of item.
+ DocIterator dit_;
+
+ /// nesting depth
+ int depth_;
+
+ /// Full item string
+ docstring str_;
+};
+
+
+///
+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;
+
+/// 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:
///
- bool addType(std::string const & type);
+ TocBackend(Buffer const * buffer) : buffer_(buffer) {}
///
- void update();
+ void setBuffer(Buffer const * buffer) { buffer_ = buffer; }
///
- TocList const & tocs()
- { return tocs_; }
+ void update();
+ /// \return true if the item was updated.
+ bool updateItem(DocIterator const & pit);
+
///
- std::vector<std::string> const & types()
- { return types_; }
+ TocList const & tocs() const { return tocs_; }
+ TocList & tocs() { return tocs_; }
+
///
- Toc const & toc(std::string const & type);
+ Toc const & toc(std::string const & type) const;
+ Toc & toc(std::string const & type);
+
/// Return the first Toc Item before the cursor
- TocIterator const item(std::string const & type, ParConstIterator const &);
+ TocIterator item(
+ std::string const & type, ///< Type of Toc.
+ DocIterator const & dit ///< The cursor location in the document.
+ ) 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_;
+ TocList tocs_;
///
Buffer const * buffer_;
-
}; // TocBackend
-inline
-bool operator==(TocBackend::Item const & a, TocBackend::Item const & b)
+inline 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)
+inline bool operator!=(TocItem const & a, TocItem const & b)
{
return !(a == b);
}