src/TocBackend.h

   1 // -*- C++ -*-
   2 /**
   3  * \file TocBackend.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Jean-Marc Lasgouttes
   8  * \author Angus Leeming
   9  * \author Abdelrazak Younes
  10  *
  11  * Full author contact details are available in file CREDITS.
  12  */
  13
  14 #ifndef TOC_BACKEND_H
  15 #define TOC_BACKEND_H
  16
  17 #include "DocIterator.h"
  18
  19 #include "support/strfwd.h"
  20
  21 #include <map>
  22 #include <vector>
  23 #include <string>
  24
  25
  26 namespace lyx {
  27
  28 class Buffer;
  29 class FuncRequest;
  30
  31 ///
  32 /**
  33 */
  34 class TocItem
  35 {
  36         friend class Toc;
  37         friend class TocBackend;
  38
  39 public:
  40         /// Default constructor for STL containers.
  41         TocItem() : dit_(0) {}
  42         ///
  43         TocItem(DocIterator const & dit,
  44                 int depth,
  45                 docstring const & s
  46                 );
  47         ///
  48         ~TocItem() {}
  49         ///
  50         int id() const;
  51         ///
  52         int depth() const;
  53         ///
  54         docstring const & str() const;
  55         ///
  56         docstring const asString() const;
  57         ///
  58         DocIterator const & dit() const;
  59
  60         /// the action corresponding to the goTo above
  61         FuncRequest action() const;
  62
  63 protected:
  64         /// Current position of item.
  65         DocIterator dit_;
  66
  67         /// nesting depth
  68         int depth_;
  69
  70         /// Full item string
  71         docstring str_;
  72 };
  73
  74
  75 ///
  76 class Toc : public std::vector<TocItem>
  77 {
  78 public:
  79         typedef std::vector<TocItem>::const_iterator const_iterator;
  80         typedef std::vector<TocItem>::iterator iterator;
  81         const_iterator item(DocIterator const & dit) const;
  82         /// Look for a TocItem given its depth and string.
  83         /// \return The first matching item.
  84         /// \retval end() if no item was found.
  85         iterator item(int depth, docstring const & str);
  86 };
  87
  88 typedef Toc::const_iterator TocIterator;
  89
  90 /// The ToC list.
  91 /// A class and no typedef because we want to forward declare it.
  92 class TocList : public std::map<std::string, Toc> {};
  93
  94
  95 ///
  96 /**
  97 */
  98 class TocBackend
  99 {
 100 public:
 101         ///
 102         TocBackend(Buffer const * buffer) : buffer_(buffer) {}
 103         ///
 104         void setBuffer(Buffer const * buffer) { buffer_ = buffer; }
 105         ///
 106         void update();
 107         /// \return true if the item was updated.
 108         bool updateItem(DocIterator const & pit);
 109
 110         ///
 111         TocList const & tocs() const { return tocs_; }
 112         TocList & tocs() { return tocs_; }
 113
 114         ///
 115         Toc const & toc(std::string const & type) const;
 116         Toc & toc(std::string const & type);
 117
 118         /// Return the first Toc Item before the cursor
 119         TocIterator item(
 120                 std::string const & type, ///< Type of Toc.
 121                 DocIterator const & dit ///< The cursor location in the document.
 122         ) const;
 123
 124         ///
 125         void writePlaintextTocList(std::string const & type, odocstream & os) const;
 126
 127 private:
 128         ///
 129         TocList tocs_;
 130         ///
 131         Buffer const * buffer_;
 132 }; // TocBackend
 133
 134 inline bool operator==(TocItem const & a, TocItem const & b)
 135 {
 136         return a.id() == b.id() && a.str() == b.str() && a.depth() == b.depth();
 137 }
 138
 139
 140 inline bool operator!=(TocItem const & a, TocItem const & b)
 141 {
 142         return !(a == b);
 143 }
 144
 145
 146 } // namespace lyx
 147
 148 #endif // TOC_BACKEND_H