src/cursor_slice.h

   1 // -*- C++ -*-
   2 /**
   3  * \file cursor_slice.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Lars Gullik Bjønnes
   8  * \author Matthias Ettrich
   9  * \author John Levon
  10  * \author André Pönitz
  11  * \author Dekel Tsur
  12  * \author Jürgen Vigna
  13  *
  14  * Full author contact details are available in file CREDITS.
  15  */
  16
  17 #ifndef CURSORSLICE_H
  18 #define CURSORSLICE_H
  19
  20 #include "support/types.h"
  21
  22 #include <cstddef>
  23 #include <iosfwd>
  24
  25 class BufferView;
  26 class InsetBase;
  27 class MathInset;
  28 class MathArray;
  29 class LyXText;
  30 class Paragraph;
  31 class UpdatableInset;
  32
  33
  34 /// This encapsulates a single slice of a document iterator as used e.g.
  35 /// for cursors.
  36
  37 // After IU, the distinction of MathInset and UpdatableInset as well as
  38 // that of MathArray and LyXText should vanish. They are conceptually the
  39 // same (now...)
  40
  41 class CursorSlice {
  42 public:
  43         /// type for cell number in inset
  44         typedef size_t idx_type;
  45         /// type for paragraph numbers positions within a cell
  46         typedef lyx::pit_type pit_type;
  47         /// type for cursor positions within a cell
  48         typedef lyx::pos_type pos_type;
  49         /// type for row indices
  50         typedef size_t row_type;
  51         /// type for col indices
  52         typedef size_t col_type;
  53
  54         ///
  55         CursorSlice();
  56         ///
  57         explicit CursorSlice(InsetBase &);
  58
  59         /// the current inset
  60         InsetBase & inset() const { return *inset_; }
  61         /// return the cell this cursor is in
  62         idx_type idx() const { return idx_; }
  63         /// return the cell this cursor is in
  64         idx_type & idx() { return idx_; }
  65         /// return the last cell in this inset
  66         idx_type lastidx() const { return nargs() - 1; }
  67         /// return the offset of the paragraph this cursor is in
  68         pit_type pit() const { return pit_; }
  69         /// set the offset of the paragraph this cursor is in
  70         pit_type & pit() { return pit_; }
  71         /// increments the paragraph this cursor is in
  72         void incrementPar();
  73         /// decrements the paragraph this cursor is in
  74         void decrementPar();
  75         /// return the position within the paragraph
  76         pos_type pos() const { return pos_; }
  77         /// return the position within the paragraph
  78         pos_type & pos() { return pos_; }
  79         /// return the last position within the paragraph
  80         pos_type lastpos() const;
  81         /// return the number of embedded cells
  82         size_t nargs() const;
  83         /*!
  84          * \return the number of columns.
  85          * This does only make sense in grid like insets.
  86          */
  87         size_t ncols() const;
  88         /*!
  89          * \return the number of rows.
  90          * This does only make sense in grid like insets.
  91          */
  92         size_t nrows() const;
  93         /*!
  94          * \return the grid row of the current cell.
  95          * This does only make sense in grid like insets.
  96          */
  97         row_type row() const;
  98         /*!
  99          * \return the grid column of the current cell.
 100          * This does only make sense in grid like insets.
 101          */
 102         col_type col() const;
 103
 104         ///
 105         /// texted specific stuff
 106         ///
 107         /// \sa boundary_
 108         bool boundary() const { return boundary_; }
 109         /// \sa boundary_
 110         bool & boundary() { return boundary_; }
 111         /// returns text corresponding to this position
 112         LyXText * text();
 113         /// returns text corresponding to this position
 114         LyXText const * text() const;
 115         /// returns the owning inset if it is an UpdatableInset, else 0
 116         UpdatableInset * asUpdatableInset() const;
 117         /// paragraph in this cell
 118         Paragraph & paragraph();
 119         /// paragraph in this cell
 120         Paragraph const & paragraph() const;
 121
 122         ///
 123         /// mathed specific stuff
 124         ///
 125         /// returns cell corresponding to this position
 126         MathArray & cell() const;
 127         /// returns the owning inset if it is a MathInset, else 0
 128         MathInset * asMathInset() const;
 129
 130         /// write some debug information to \p os
 131         friend std::ostream & operator<<(std::ostream &, CursorSlice const &);
 132 public:
 133         /// pointer to 'owning' inset. This is some kind of cache.
 134         InsetBase * inset_;
 135 private:
 136         /*!
 137          * Cell index of a position in this inset.
 138          * This is the primary cell information also for grid like insets,
 139          * although we have the convenience functions row() and col() for
 140          * those.
 141          * This means that the corresponding idx_ of a cell in a given row
 142          * and column changes every time the number of columns or number of
 143          * rows changes. Normally the cursor should stay in the same cell,
 144          * so these changes should typically be performed like the following:
 145          * \code
 146          * row_type const r = cur.row();
 147          * col_type const c = cur.col();
 148          * // change nrows() and/or ncols()
 149          * cur.idx = index(r, c);
 150          * \endcode
 151          */
 152         idx_type idx_;
 153         /// paragraph in this cell (used by texted)
 154         pit_type pit_;
 155         /// true if 'pit' was properly initialized
 156         bool pit_valid_;
 157         /// position in this cell
 158         pos_type pos_;
 159         /**
 160          * When the cursor position is i, is the cursor after the i-th char
 161          * or before the i+1-th char ? Normally, these two interpretations are
 162          * equivalent, except when the fonts of the i-th and i+1-th char
 163          * differ.
 164          * We use boundary_ to distinguish between the two options:
 165          * If boundary_=true, then the cursor is after the i-th char
 166          * and if boundary_=false, then the cursor is before the i+1-th char.
 167          *
 168          * We currently use the boundary only when the language direction of
 169          * the i-th char is different than the one of the i+1-th char.
 170          * In this case it is important to distinguish between the two
 171          * cursor interpretations, in order to give a reasonable behavior to
 172          * the user.
 173          */
 174         bool boundary_;
 175 };
 176
 177 /// test for equality
 178 bool operator==(CursorSlice const &, CursorSlice const &);
 179 /// test for inequality
 180 bool operator!=(CursorSlice const &, CursorSlice const &);
 181 /// test for order
 182 bool operator<(CursorSlice const &, CursorSlice const &);
 183 /// test for order
 184 bool operator>(CursorSlice const &, CursorSlice const &);
 185 /// test for order
 186 bool operator<=(CursorSlice const &, CursorSlice const &);
 187
 188 #endif