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  * \author Guillaume Munch
  11  *
  12  * Full author contact details are available in file CREDITS.
  13  */
  14
  15 #ifndef TOC_BACKEND_H
  16 #define TOC_BACKEND_H
  17
  18 #include "DocIterator.h"
  19 #include "FuncRequest.h"
  20 #include "OutputEnums.h"
  21
  22 #include "support/shared_ptr.h"
  23 #include "support/strfwd.h"
  24
  25 #include <map>
  26 #include <vector>
  27 #include <stack>
  28 #include <string>
  29
  30
  31 namespace lyx {
  32
  33 class Buffer;
  34
  35
  36 /* FIXME: toc types are currently identified by strings. It cannot be converted
  37  * into an enum because of the user-configurable indexing categories and
  38  * the user-definable float types provided by layout files.
  39  *
  40  * I leave this for documentation purposes for the moment.
  41  *
  42 enum TocType {
  43         TABLE_OF_CONTENTS,//"tableofcontents"
  44         CHILD,//"child"
  45         GRAPHICS,//"graphics"
  46         NOTE,//"note"
  47         BRANCH,//"branch"
  48         CHANGE,//"change"
  49         LABEL,//"label"
  50         CITATION,//"citation"
  51         EQUATION,//"equation"
  52         FOOTNOTE,//"footnote"
  53         MARGINAL_NOTE,//"marginalnote"
  54         INDEX,//"index", "index:<user-str>" (from interface)
  55         NOMENCL,//"nomencl"
  56         LISTING,//"listings"
  57         FLOAT,//"figure", "table", "algorithm", user-defined (from layout?)
  58         MATH_MACRO,//"math-macro"
  59         EXTERNAL,//"external"
  60         SENSELESS,//"senseless"
  61         TOC_TYPE_COUNT
  62 }
  63  */
  64
  65 ///
  66 /**
  67 */
  68 class TocItem
  69 {
  70         friend class Toc;
  71         friend class TocBackend;
  72         friend class TocBuilder;
  73
  74 public:
  75         /// Default constructor for STL containers.
  76         TocItem() : dit_(0), depth_(0), output_(false) {}
  77         ///
  78         TocItem(DocIterator const & dit,
  79                 int depth,
  80                 docstring const & s,
  81                 bool output_active,
  82                 docstring const & t = docstring(),
  83                 FuncRequest action = FuncRequest(LFUN_UNKNOWN_ACTION)
  84                 );
  85         ///
  86         ~TocItem() {}
  87         ///
  88         int id() const;
  89         ///
  90         int depth() const { return depth_; }
  91         ///
  92         docstring const & str() const { return str_; }
  93         ///
  94         void str(docstring const & s) { str_ = s; }
  95         ///
  96         docstring const & tooltip() const;
  97         /// String for display, e.g. it has a mark if output is inactive
  98         docstring const asString() const;
  99         ///
 100         DocIterator const & dit() const { return dit_; }
 101         ///
 102         bool isOutput() const { return output_; }
 103         ///
 104         void setAction(FuncRequest a) { action_ = a; }
 105         /// custom action, or the default one (paragraph-goto) if not customised
 106         FuncRequest action() const;
 107
 108 protected:
 109         /// Current position of item.
 110         DocIterator dit_;
 111
 112 private:
 113         /// nesting depth
 114         int depth_;
 115         /// Full item string
 116         docstring str_;
 117         /// The tooltip string
 118         docstring tooltip_;
 119         /// Is this item in a note, inactive branch, etc?
 120         bool output_;
 121         /// Custom action
 122         FuncRequest action_;
 123 };
 124
 125
 126 ///
 127 class Toc : public std::vector<TocItem>
 128 {
 129 public:
 130         typedef std::vector<TocItem>::const_iterator const_iterator;
 131         typedef std::vector<TocItem>::iterator iterator;
 132         const_iterator item(DocIterator const & dit) const;
 133         /// Look for a TocItem given its depth and string.
 134         /// \return The first matching item.
 135         /// \retval end() if no item was found.
 136         iterator item(int depth, docstring const & str);
 137 };
 138
 139 typedef Toc::const_iterator TocIterator;
 140
 141
 142 /// Caption-enabled TOC builders
 143 class TocBuilder
 144 {
 145 public:
 146         TocBuilder(shared_ptr<Toc> const toc);
 147         /// When entering a float
 148         void pushItem(DocIterator const & dit, docstring const & s,
 149                                   bool output_active, bool is_captioned = false);
 150         /// When encountering a caption
 151         void captionItem(DocIterator const & dit, docstring const & s,
 152                                          bool output_active);
 153         /// When exiting a float
 154         void pop();
 155 private:
 156         TocBuilder(){}
 157         ///
 158         struct frame {
 159                 Toc::size_type pos;
 160                 bool is_captioned;
 161         };
 162         ///
 163         shared_ptr<Toc> const toc_;
 164         ///
 165         std::stack<frame> stack_;
 166 };
 167
 168
 169 /// The ToC list.
 170 /// A class and no typedef because we want to forward declare it.
 171 class TocList : public std::map<std::string, shared_ptr<Toc> >
 172 {
 173 private:
 174         // this can create null pointers
 175         using std::map<std::string, shared_ptr<Toc> >::operator[];
 176 };
 177
 178
 179 ///
 180 class TocBuilderStore
 181 {
 182 public:
 183         TocBuilderStore() {};
 184         ///
 185         shared_ptr<TocBuilder> get(std::string const & type, shared_ptr<Toc> toc);
 186         ///
 187         void clear() { map_.clear(); };
 188 private:
 189         typedef std::map<std::string, shared_ptr<TocBuilder> > map_t;
 190         map_t map_;
 191 };
 192
 193
 194 ///
 195 /**
 196 */
 197 class TocBackend
 198 {
 199 public:
 200         ///
 201         TocBackend(Buffer const * buffer) : buffer_(buffer) {}
 202         ///
 203         void setBuffer(Buffer const * buffer) { buffer_ = buffer; }
 204         ///
 205         void update(bool output_active, UpdateType utype);
 206         /// \return true if the item was updated.
 207         bool updateItem(DocIterator const & pit);
 208         ///
 209         TocList const & tocs() const { return tocs_; }
 210         /// never null
 211         shared_ptr<Toc const> toc(std::string const & type) const;
 212         shared_ptr<Toc> toc(std::string const & type);
 213         /// nevel null
 214         shared_ptr<TocBuilder> builder(std::string const & type);
 215         /// Return the first Toc Item before the cursor
 216         TocIterator item(
 217                 std::string const & type, ///< Type of Toc.
 218                 DocIterator const & dit ///< The cursor location in the document.
 219         ) const;
 220
 221         ///
 222         void writePlaintextTocList(std::string const & type,
 223                 odocstringstream & os, size_t max_length) const;
 224
 225 private:
 226         ///
 227         TocList tocs_;
 228         ///
 229         TocBuilderStore builders_;
 230         ///
 231         Buffer const * buffer_;
 232 }; // TocBackend
 233
 234
 235 } // namespace lyx
 236
 237 #endif // TOC_BACKEND_H