get rid of broken_header.h and some unneeded tests

[lyx.git] / src / cursor_slice.h

diff --git a/src/cursor_slice.h b/src/cursor_slice.h
index 6824916a3765363ec61f493840a720cd9c20b39a..30f0b95888496a413a63a2673fa589aa29192eff 100644 (file)
--- a/src/cursor_slice.h
+++ b/src/cursor_slice.h
@@ -4,7 +4,12 @@
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *
+ * \author Lars Gullik Bjønnes
+ * \author Matthias Ettrich
+ * \author John Levon
  * \author André Pönitz
+ * \author Dekel Tsur
+ * \author Jürgen Vigna
  *
  * Full author contact details are available in file CREDITS.
  */
@@ -12,14 +17,18 @@
 #ifndef CURSORSLICE_H
 #define CURSORSLICE_H
 
-#include <iosfwd>
+#include "support/types.h"
+
 #include <cstddef>
+#include <iosfwd>
 
+class BufferView;
 class InsetBase;
-class UpdatableInset;
 class MathInset;
-class LyXText;
 class MathArray;
+class LyXText;
+class Paragraph;
+class UpdatableInset;
 
 
 /// This encapsulates a single slice of a document iterator as used e.g.
@@ -34,48 +43,106 @@ public:
        /// type for cell number in inset
        typedef size_t idx_type;
        /// type for paragraph numbers positions within a cell
-       typedef size_t par_type;
+       typedef lyx::pit_type pit_type;
        /// type for cursor positions within a cell
-       typedef size_t pos_type;
+       typedef lyx::pos_type pos_type;
+       /// type for row indices
+       typedef size_t row_type;
+       /// type for col indices
+       typedef size_t col_type;
 
        ///
        CursorSlice();
        ///
-       explicit CursorSlice(InsetBase *);
+       explicit CursorSlice(InsetBase &);
+
+       /// the current inset
+       InsetBase & inset() const { return *inset_; }
+       /// return the cell this cursor is in
+       idx_type idx() const { return idx_; }
+       /// return the cell this cursor is in
+       idx_type & idx() { return idx_; }
+       /// return the last cell in this inset
+       idx_type lastidx() const { return nargs() - 1; }
+       /// return the offset of the paragraph this cursor is in
+       pit_type pit() const { return pit_; }
+       /// set the offset of the paragraph this cursor is in
+       pit_type & pit() { return pit_; }
+       /// increments the paragraph this cursor is in
+       void incrementPar();
+       /// increments the paragraph this cursor is in
+       void decrementPar();
+       /// return the position within the paragraph
+       pos_type pos() const { return pos_; }
+       /// return the position within the paragraph
+       pos_type & pos() { return pos_; }
+       /// return the last position within the paragraph
+       pos_type lastpos() const;
+       /// return the number of embedded cells
+       size_t nargs() const;
+       /// return the number of embedded cells
+       size_t ncols() const;
+       /// return the number of embedded cells
+       size_t nrows() const;
+       /// return the grid row of the current cell
+       row_type row() const;
+       /// return the grid row of the current cell
+       col_type col() const;
 
        ///
        /// texted specific stuff
        ///
+       /// see comment for the member
+       bool boundary() const { return boundary_; }
+       /// see comment for the member
+       bool & boundary() { return boundary_; }
        ///
        LyXText * text() const;
        ///
        UpdatableInset * asUpdatableInset() const;
+       ///
+       Paragraph & paragraph();
+       ///
+       Paragraph const & paragraph() const;
 
        ///
        /// mathed specific stuff
        ///
        /// returns cell corresponding to this position
        MathArray & cell() const;
-       /// returns cell corresponding to this position
-       MathArray & cell(idx_type idx) const;
-       /// gets screen position of the thing
-       void getPos(int & x, int & y) const;
-       /// set position
-       void setPos(int pos);
        ///
        MathInset * asMathInset() const;
 
        ///
        friend std::ostream & operator<<(std::ostream &, CursorSlice const &);
 public:
-       /// pointer to an inset
+       /// pointer to 'owning' inset. This is some kind of cache.
        InsetBase * inset_;
+private:
        /// cell index of a position in this inset
        idx_type idx_;
        /// paragraph in this cell (used by texted)
-       par_type par_;
+       pit_type pit_;
+       /// true of 'pit' was properly initialized
+       bool pit_valid_;
        /// position in this cell
        pos_type pos_;
+       /**
+        * When the cursor position is i, is the cursor is after the i-th char
+        * or before the i+1-th char ? Normally, these two interpretations are
+        * equivalent, except when the fonts of the i-th and i+1-th char
+        * differ.
+        * We use boundary_ to distinguish between the two options:
+        * If boundary_=true, then the cursor is after the i-th char
+        * and if boundary_=false, then the cursor is before the i+1-th char.
+        *
+        * We currently use the boundary only when the language direction of
+        * the i-th char is different than the one of the i+1-th char.
+        * In this case it is important to distinguish between the two
+        * cursor interpretations, in order to give a reasonable behavior to
+        * the user.
+        */
+       bool boundary_;
 };
 
 /// test for equality
@@ -84,5 +151,9 @@ bool operator==(CursorSlice const &, CursorSlice const &);
 bool operator!=(CursorSlice const &, CursorSlice const &);
 /// test for order
 bool operator<(CursorSlice const &, CursorSlice const &);
+/// test for order
+bool operator>(CursorSlice const &, CursorSlice const &);
+/// test for order
+bool operator<=(CursorSlice const &, CursorSlice const &);
 
 #endif