* 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.
*/
#define CURSORSLICE_H
#include "support/types.h"
+#include "support/strfwd.h"
#include "insets/Inset.h"
-#include <cstddef>
-#include <iosfwd>
-
namespace lyx {
class Inset;
class MathData;
-class LyXText;
+class Text;
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
-// that of MathData and LyXText should vanish. They are conceptually the
+// 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:
+ /// \name Those needs inset_ access.
+ //@{
+ friend class DocIterator;
+ friend class StableDocIterator;
+ //@}
+
/// type for cell number in inset
typedef size_t idx_type;
/// type for row indices
///
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
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 within the ParagraphList
+ pit_type lastpit() const;
/// increments the paragraph this cursor is in
void incrementPar();
/// decrements the paragraph this cursor is in
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(); }
/// texted specific stuff
///
/// returns text corresponding to this position
- LyXText * text() { return inset_->getText(idx_); }
- /// returns text corresponding to this position
- LyXText const * text() const { return inset_->getText(idx_); }
- /// paragraph in this cell
- Paragraph & paragraph();
+ Text * text() const { return inset_->getText(idx_); }
/// paragraph in this cell
- Paragraph const & paragraph() const;
+ Paragraph & paragraph() const;
+ ///
+ void setPitPos(pit_type pit, pos_type pos);
///
/// mathed specific stuff
/// write some debug information to \p os
friend std::ostream & operator<<(std::ostream &, CursorSlice const &);
-public:
+ /// 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.
Inset * inset_;
-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
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
projects / lyx.git / blobdiff