X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FCursorSlice.h;h=f6d60d8ce627430d35e2d8468460f43a595abcb2;hb=88034d3d8987a9601b0779bf0115b5105b16fd6e;hp=a9326f1cce1b2d00bc6ad0918a4ff021b3dd7e02;hpb=d5f8004189e31579f4dc2ef9c38549a08671f5c4;p=lyx.git

diff --git a/src/CursorSlice.h b/src/CursorSlice.h
index a9326f1cce..f6d60d8ce6 100644
--- a/src/CursorSlice.h
+++ b/src/CursorSlice.h
@@ -4,12 +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 Lars Gullik Bjønnes
  * \author Matthias Ettrich
  * \author John Levon
- * \author André Pönitz
+ * \author André Pönitz
  * \author Dekel Tsur
- * \author Jürgen Vigna
+ * \author Jürgen Vigna
  *
  * Full author contact details are available in file CREDITS.
  */
@@ -18,11 +18,9 @@
 #define CURSORSLICE_H
 
 #include "support/types.h"
+#include "support/strfwd.h"
 #include "insets/Inset.h"
 
-#include <cstddef>
-#include <iosfwd>
-
 
 namespace lyx {
 
@@ -34,17 +32,17 @@ class Paragraph;
 /// This encapsulates a single slice of a document iterator as used e.g.
 /// for cursors.
 
-// After IU, the distinction of MathInset and InsetOld as well as
+// After inset unification, the distinction of InsetMath and Inset as well as
 // that of MathData and Text should vanish. They are conceptually the
 // same (now...)
 
 class CursorSlice {
 public:
-	/// Those needs inset_ access.
-	///@{
+	/// \name Those needs inset_ access.
+	//@{
 	friend class DocIterator;
 	friend class StableDocIterator;
-	///@}
+	//@}
 
 	/// type for cell number in inset
 	typedef size_t idx_type;
@@ -58,6 +56,17 @@ public:
 	///
 	explicit CursorSlice(Inset &);
 
+	/// \name Comparison operators.
+	//@{
+	friend bool operator==(CursorSlice const &, CursorSlice const &);
+	friend bool operator!=(CursorSlice const &, CursorSlice const &);
+	friend bool operator<(CursorSlice const &, CursorSlice const &);
+	friend bool operator>(CursorSlice const &, CursorSlice const &);
+	friend bool operator<=(CursorSlice const &, CursorSlice const &);
+	//@}
+
+	/// return true if the slice has not been initialized
+	bool empty() const { return !inset_; }
 	/// the current inset
 	Inset & inset() const { return *inset_; }
 	/// return the cell this cursor is in
@@ -70,7 +79,7 @@ public:
 	pit_type pit() const { return pit_; }
 	/// set the offset of the paragraph this cursor is in
 	pit_type & pit() { return pit_; }
-	/// return the last paragraph offset this cursor is in
+	/// return the last paragraph offset within the ParagraphList
 	pit_type lastpit() const;
 	/// increments the paragraph this cursor is in
 	void incrementPar();
@@ -80,7 +89,11 @@ public:
 	pos_type pos() const { return pos_; }
 	/// return the position within the paragraph
 	pos_type & pos() { return pos_; }
-	/// return the last position within the paragraph
+	/*!
+	 * \return the last position within the paragraph.
+	 * Note that this is the position behind the last character or inset,
+	 * i.e. you cannot dereference it.
+	 */
 	pos_type lastpos() const;
 	/// return the number of embedded cells
 	size_t nargs() const { return inset_->nargs(); }
@@ -103,13 +116,11 @@ public:
 	/// texted specific stuff
 	///
 	/// returns text corresponding to this position
-	Text * text() { return inset_->getText(idx_); }
-	/// returns text corresponding to this position
-	Text const * text() const { return inset_->getText(idx_); }
+	Text * text() const { return inset_->getText(idx_); }
 	/// paragraph in this cell
-	Paragraph & paragraph();
-	/// paragraph in this cell
-	Paragraph const & paragraph() const;
+	Paragraph & paragraph() const;
+	///
+	void setPitPos(pit_type pit, pos_type pos);
 
 	///
 	/// mathed specific stuff
@@ -121,6 +132,23 @@ public:
 
 	/// write some debug information to \p os
 	friend std::ostream & operator<<(std::ostream &, CursorSlice const &);
+	/// move to next position
+	void forwardPos();
+	/// move to previous position
+	void backwardPos();
+	/// move to next cell
+	void forwardIdx();
+	/// move to previous cell
+	void backwardIdx();
+	/// are we at the end of the cell
+	bool at_cell_end() const;
+	/// are we at the start of the cell
+	bool at_cell_begin() const;
+	/// are we at the end of this slice
+	bool at_end() const;
+	/// are we at the start of this slice
+	bool at_begin() const;
+
 private:
 
 	/// pointer to 'owning' inset. This is some kind of cache.
@@ -130,7 +158,9 @@ private:
 	 * Cell index of a position in this inset.
 	 * This is the primary cell information also for grid like insets,
 	 * although we have the convenience functions row() and col() for
-	 * those * and column changes every time the number of columns ornumber
+	 * those.
+	 * This means that the corresponding idx_ of a cell in a given row
+	 * and column changes every time the number of columns or number
 	 * of rows changes. Normally the cursor should stay in the same cell,
 	 * so these changes should typically be performed like the following:
 	 * \code
@@ -143,23 +173,10 @@ private:
 	idx_type idx_;
 	/// paragraph in this cell (used by texted)
 	pit_type pit_;
-	/// true if 'pit' was properly initialized
-	bool pit_valid_;
 	/// position in this cell
 	pos_type pos_;
 };
 
-/// test for equality
-bool operator==(CursorSlice const &, CursorSlice const &);
-/// test for inequality
-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 &);
-
 
 } // namespace lyx