src/DocIterator.h

   1 // -*- C++ -*-
   2 /**
   3  * \file DocIterator.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author André Pönitz
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef DOCITERATOR_H
  13 #define DOCITERATOR_H
  14
  15 #include "CursorSlice.h"
  16
  17 #include <vector>
  18 #include <iosfwd>
  19
  20
  21 namespace lyx {
  22
  23 class Text;
  24 class MathAtom;
  25 class Paragraph;
  26
  27
  28 // only needed for gcc 2.95, remove when support terminated
  29 template <typename A, typename B>
  30 bool ptr_cmp(A const * a, B const * b)
  31 {
  32         return a == b;
  33 }
  34
  35
  36 // The public inheritance should go in favour of a suitable data member
  37 // (or maybe private inheritance) at some point of time.
  38 class DocIterator // : public std::vector<CursorSlice>
  39 {
  40 public:
  41         /// type for cell number in inset
  42         typedef CursorSlice::idx_type idx_type;
  43         /// type for row indices
  44         typedef CursorSlice::row_type row_type;
  45         /// type for col indices
  46         typedef CursorSlice::col_type col_type;
  47
  48 public:
  49         ///
  50         DocIterator();
  51         ///
  52         explicit DocIterator(Inset & inset);
  53
  54         /// access slice at position \p i
  55         CursorSlice const & operator[](size_t i) const { return slices_[i]; }
  56         /// access slice at position \p i
  57         CursorSlice & operator[](size_t i) { return slices_[i]; }
  58         /// chop a few slices from the iterator
  59         void resize(size_t i) { slices_.resize(i); }
  60
  61         /// is the iterator valid?
  62         operator const void*() const { return empty() ? 0 : this; }
  63         /// is this iterator invalid?
  64         bool operator!() const { return empty(); }
  65
  66         /// does this iterator have any content?
  67         bool empty() const { return slices_.empty(); }
  68
  69         //
  70         // access to slice at tip
  71         //
  72         /// access to tip
  73         CursorSlice & top() { return slices_.back(); }
  74         /// access to tip
  75         CursorSlice const & top() const { return slices_.back(); }
  76         /// access to outermost slice
  77         CursorSlice & bottom() { return slices_.front(); }
  78         /// access to outermost slice
  79         CursorSlice const & bottom() const { return slices_.front(); }
  80         /// how many nested insets do we have?
  81         size_t depth() const { return slices_.size(); }
  82         /// the containing inset
  83         Inset & inset() const { return top().inset(); }
  84         /// return the cell of the inset this cursor is in
  85         idx_type idx() const { return top().idx(); }
  86         /// return the cell of the inset this cursor is in
  87         idx_type & idx() { return top().idx(); }
  88         /// return the last possible cell in this inset
  89         idx_type lastidx() const;
  90         /// return the paragraph this cursor is in
  91         pit_type pit() const { return top().pit(); }
  92         /// return the paragraph this cursor is in
  93         pit_type & pit() { return top().pit(); }
  94         /// return the last possible paragraph in this inset
  95         pit_type lastpit() const;
  96         /// return the position within the paragraph
  97         pos_type pos() const { return top().pos(); }
  98         /// return the position within the paragraph
  99         pos_type & pos() { return top().pos(); }
 100         /// return the last position within the paragraph
 101         pos_type lastpos() const;
 102
 103         /// return the number of embedded cells
 104         size_t nargs() const;
 105         /// return the number of embedded cells
 106         size_t ncols() const;
 107         /// return the number of embedded cells
 108         size_t nrows() const;
 109         /// return the grid row of the top cell
 110         row_type row() const;
 111         /// return the last row of the top grid
 112         row_type lastrow() const { return nrows() - 1; }
 113         /// return the grid column of the top cell
 114         col_type col() const;
 115         /// return the last column of the top grid
 116         col_type lastcol() const { return ncols() - 1; }
 117         /// the inset just behind the cursor
 118         Inset * nextInset() const;
 119         /// the inset just in front of the cursor
 120         Inset * prevInset() const;
 121         ///
 122         bool boundary() const { return boundary_; }
 123         ///
 124         void boundary(bool b) { boundary_ = b; }
 125
 126         // the two methods below have been inlined out because of
 127         // profiling results under linux when opening a document.
 128         /// are we in mathed?.
 129         bool inMathed() const
 130         { return !empty() && inset().inMathed(); }
 131         /// are we in texted?.
 132         bool inTexted() const
 133         { return !empty() && !inset().inMathed(); }
 134
 135         //
 136         // math-specific part
 137         //
 138         /// return the mathed cell this cursor is in
 139         MathData & cell() const;
 140         /// the mathatom left of the cursor
 141         MathAtom & prevAtom() const;
 142         /// the mathatom right of the cursor
 143         MathAtom & nextAtom() const;
 144
 145         // text-specific part
 146         //
 147         /// the paragraph we're in in text mode.
 148         /// \warning only works within text!
 149         Paragraph & paragraph() const;
 150         /// the paragraph we're in in any case.
 151         /// This method will give the containing paragraph even
 152         /// if not in text mode (ex: in mathed).
 153         Paragraph & innerParagraph() const;
 154         /// return the inner text slice.
 155         CursorSlice const & innerTextSlice() const;
 156         ///
 157         Text * text() const;
 158         /// the containing inset or the cell, respectively
 159         Inset * realInset() const;
 160         ///
 161         Inset * innerInsetOfType(int code) const;
 162         ///
 163         Text * innerText() const;
 164
 165         //
 166         // elementary moving
 167         //
 168         /**
 169          * move on one logical position, descend into nested insets
 170          * skip collapsed insets if \p ignorecollapsed is true
 171          */
 172         void forwardPos(bool ignorecollapsed = false);
 173         /// move on one physical character or inset
 174         void forwardChar();
 175         /// move on one paragraph
 176         void forwardPar();
 177         /// move on one inset
 178         void forwardInset();
 179         /// move backward one logical position
 180         void backwardPos();
 181         /// move backward one physical character or inset
 182         void backwardChar();
 183         /// move backward one paragraph
 184         void backwardPar();
 185         /// move backward one inset
 186         /// FIXME: This is not implemented!
 187         //void backwardInset();
 188
 189         /// are we some 'extension' (i.e. deeper nested) of the given iterator
 190         bool hasPart(DocIterator const & it) const;
 191
 192         /// output
 193         friend std::ostream &
 194         operator<<(std::ostream & os, DocIterator const & cur);
 195         ///
 196         friend bool operator==(DocIterator const &, DocIterator const &);
 197         friend bool operator<(DocIterator const &, DocIterator const &);
 198         friend bool operator>(DocIterator const &, DocIterator const &);
 199         friend bool operator<=(DocIterator const &, DocIterator const &);
 200         ///
 201         friend class StableDocIterator;
 202 //protected:
 203         ///
 204         void clear() { slices_.clear(); }
 205         ///
 206         void push_back(CursorSlice const & sl) { slices_.push_back(sl); }
 207         ///
 208         void pop_back() { slices_.pop_back(); }
 209         /// recompute the inset parts of the cursor from the document data
 210         void updateInsets(Inset * inset);
 211         /// fix DocIterator in circumstances that should never happen.
 212         /// \return true if the DocIterator was fixed.
 213         bool fixIfBroken();
 214
 215         /// find index of CursorSlice with &cell() == &cell (or -1 if not found)
 216         idx_type find(MathData const & cell) const;
 217         /// find index of CursorSlice with inset() == inset (or -1 of not found)
 218         idx_type find(InsetMath const * inset) const;
 219         /// cut off CursorSlices with index > above and store cut off slices in cut
 220         void cutOff(idx_type above, std::vector<CursorSlice> & cut);
 221         /// cut off CursorSlices with index > above
 222         void cutOff(idx_type above);
 223         /// push CursorSlices on top
 224         void append(std::vector<CursorSlice> const & x);
 225         /// push one CursorSlice on top and set its index and position
 226         void append(idx_type idx, pos_type pos);
 227
 228 private:
 229         /**
 230          * When the cursor position is i, is the cursor after the i-th char
 231          * or before the i+1-th char ? Normally, these two interpretations are
 232          * equivalent, except when the fonts of the i-th and i+1-th char
 233          * differ.
 234          * We use boundary_ to distinguish between the two options:
 235          * If boundary_=true, then the cursor is after the i-th char
 236          * and if boundary_=false, then the cursor is before the i+1-th char.
 237          *
 238          * We currently use the boundary only when the language direction of
 239          * the i-th char is different than the one of the i+1-th char.
 240          * In this case it is important to distinguish between the two
 241          * cursor interpretations, in order to give a reasonable behavior to
 242          * the user.
 243          */
 244         bool boundary_;
 245         ///
 246         std::vector<CursorSlice> const & internalData() const {
 247                 return slices_;
 248         }
 249         ///
 250         std::vector<CursorSlice> slices_;
 251         ///
 252         Inset * inset_;
 253 };
 254
 255
 256 DocIterator doc_iterator_begin(Inset & inset);
 257 DocIterator doc_iterator_end(Inset & inset);
 258
 259
 260 inline
 261 bool operator==(DocIterator const & di1, DocIterator const & di2)
 262 {
 263         return di1.slices_ == di2.slices_;
 264 }
 265
 266
 267 inline
 268 bool operator!=(DocIterator const & di1, DocIterator const & di2)
 269 {
 270         return !(di1 == di2);
 271 }
 272
 273
 274 // The difference to a ('non stable') DocIterator is the removed
 275 // (overwritten by 0...) part of the CursorSlice data items. So this thing
 276 // is suitable for external storage, but not for iteration as such.
 277
 278 class StableDocIterator {
 279 public:
 280         ///
 281         StableDocIterator() {}
 282         /// non-explicit intended
 283         StableDocIterator(const DocIterator & it);
 284         ///
 285         DocIterator asDocIterator(Inset * start) const;
 286         ///
 287         size_t size() const { return data_.size(); }
 288         ///  return the position within the paragraph
 289         pos_type pos() const { return data_.back().pos(); }
 290         ///  return the position within the paragraph
 291         pos_type & pos() { return data_.back().pos(); }
 292         ///
 293         friend std::ostream &
 294         operator<<(std::ostream & os, StableDocIterator const & cur);
 295         ///
 296         friend std::istream &
 297         operator>>(std::istream & is, StableDocIterator & cur);
 298         ///
 299         friend bool
 300         operator==(StableDocIterator const &, StableDocIterator const &);
 301 private:
 302         std::vector<CursorSlice> data_;
 303 };
 304
 305
 306 } // namespace lyx
 307
 308 #endif