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 <cstddef>
  21 #include <iosfwd>
  22
  23 #include "support/types.h"
  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::paroffset_type par_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;
  63         /// return the cell this cursor is in
  64         idx_type & idx();
  65         /// return the last cell in this inset
  66         idx_type lastidx() const { return nargs() - 1; }
  67         /// return the paragraph this cursor is in
  68         par_type par() const;
  69         /// return the paragraph this cursor is in
  70         par_type & par();
  71         /// return the position within the paragraph
  72         pos_type pos() const;
  73         /// return the position within the paragraph
  74         pos_type & pos();
  75         /// return the last position within the paragraph
  76         pos_type lastpos() const;
  77         /// return the number of embedded cells
  78         size_t nargs() const;
  79         /// return the number of embedded cells
  80         size_t ncols() const;
  81         /// return the number of embedded cells
  82         size_t nrows() const;
  83         /// return the grid row of the current cell
  84         row_type row() const;
  85         /// return the grid row of the current cell
  86         col_type col() const;
  87
  88         ///
  89         /// texted specific stuff
  90         ///
  91         /// see comment for the member
  92         bool boundary() const;
  93         /// see comment for the member
  94         bool & boundary();
  95         ///
  96         LyXText * text() const;
  97         ///
  98         UpdatableInset * asUpdatableInset() const;
  99         ///
 100         Paragraph & paragraph();
 101         ///
 102         Paragraph const & paragraph() const;
 103
 104         ///
 105         /// mathed specific stuff
 106         ///
 107         /// returns cell corresponding to this position
 108         MathArray & cell() const;
 109         ///
 110         MathInset * asMathInset() const;
 111
 112         ///
 113         friend std::ostream & operator<<(std::ostream &, CursorSlice const &);
 114 public:
 115         /// pointer to 'owning' inset
 116         InsetBase * inset_;
 117         /// cell index of a position in this inset
 118         idx_type idx_;
 119         /// paragraph in this cell (used by texted)
 120         par_type par_;
 121         /// position in this cell
 122         pos_type pos_;
 123         /**
 124          * When the cursor position is i, is the cursor is after the i-th char
 125          * or before the i+1-th char ? Normally, these two interpretations are
 126          * equivalent, except when the fonts of the i-th and i+1-th char
 127          * differ.
 128          * We use boundary_ to distinguish between the two options:
 129          * If boundary_=true, then the cursor is after the i-th char
 130          * and if boundary_=false, then the cursor is before the i+1-th char.
 131          *
 132          * We currently use the boundary only when the language direction of
 133          * the i-th char is different than the one of the i+1-th char.
 134          * In this case it is important to distinguish between the two
 135          * cursor interpretations, in order to give a reasonable behavior to
 136          * the user.
 137          */
 138         bool boundary_;
 139 };
 140
 141 /// test for equality
 142 bool operator==(CursorSlice const &, CursorSlice const &);
 143 /// test for inequality
 144 bool operator!=(CursorSlice const &, CursorSlice const &);
 145 /// test for order
 146 bool operator<(CursorSlice const &, CursorSlice const &);
 147 /// test for order
 148 bool operator>(CursorSlice const &, CursorSlice const &);
 149
 150 #endif