X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FDocIterator.h;h=4aff05cd0b62e43a5cd27bb4a241f7d5bdfcd568;hb=745b43784ce1b6981fd31f6c5f5fbd489eef51f4;hp=14baf2566fd38e8da45a48f36e3ebe054417cb22;hpb=1ec0b390f5eab86253f121e5a098ce4f3c97a98b;p=lyx.git

diff --git a/src/DocIterator.h b/src/DocIterator.h
index 14baf2566f..4aff05cd0b 100644
--- a/src/DocIterator.h
+++ b/src/DocIterator.h
@@ -15,7 +15,7 @@
 #include "CursorSlice.h"
 
 #include <vector>
-
+#include <algorithm>
 
 namespace lyx {
 
@@ -25,6 +25,7 @@ class MathAtom;
 class Paragraph;
 class Text;
 class InsetIterator;
+class FontSpan;
 
 DocIterator doc_iterator_begin(Buffer const * buf, Inset const * inset = 0);
 DocIterator doc_iterator_end(Buffer const * buf, Inset const * inset = 0);
@@ -51,6 +52,10 @@ public:
 	/// access to owning buffer
 	void setBuffer(Buffer * buf) { buffer_ = buf; }
 
+	/// Clone this for given \p buffer.
+	/// \p buffer must be a clone of buffer_.
+	DocIterator clone(Buffer * buffer) const;
+
 	/// access slice at position \p i
 	CursorSlice const & operator[](size_t i) const { return slices_[i]; }
 	/// access slice at position \p i
@@ -59,14 +64,17 @@ public:
 	void resize(size_t i) { slices_.resize(i); }
 
 	/// is the iterator valid?
-	operator const void*() const { return empty() ? 0 : this; }
-	/// is this iterator invalid?
-	bool operator!() const { return empty(); }
+	explicit operator bool() const { return !empty(); }
 
 	/// does this iterator have any content?
 	bool empty() const { return slices_.empty(); }
 	/// is this the end position?
 	bool atEnd() const { return slices_.empty(); }
+	/// is this the last possible position?
+	bool atLastPos() const { return pit() == lastpit() && pos() == lastpos(); }
+
+	/// checks the cursor slices for disabled spell checker insets
+	bool allowSpellCheck() const;
 
 	//
 	// access to slice at tip
@@ -157,6 +165,13 @@ public:
 	Paragraph & innerParagraph() const;
 	/// return the inner text slice.
 	CursorSlice const & innerTextSlice() const;
+	// convert a DocIterator into an argument to LFUN_PARAGRAPH_GOTO
+	docstring paragraphGotoArgument() const;
+	/// returns a DocIterator for the containing text inset
+	DocIterator getInnerText() const;
+	/// the first and last positions of a word at top cursor slice
+	/// \warning only works within text!
+	FontSpan locateWord(word_location const loc) const;
 	///
 	Text * text() const;
 	/// the containing inset or the cell, respectively
@@ -169,6 +184,10 @@ public:
 	//
 	// elementary moving
 	//
+	/// move one step backwards
+	bool posBackward();
+	/// move one step forward
+	bool posForward();
 	/**
 	 * move on one logical position, descend into nested insets
 	 * including collapsed insets
@@ -192,7 +211,7 @@ public:
 	/// move backward one paragraph
 	void backwardPar();
 	/// move backward one inset
-	/// FIXME: This is not implemented!
+	/// not used currently, uncomment if you need it
 	//void backwardInset();
 
 	/// are we some 'extension' (i.e. deeper nested) of the given iterator
@@ -221,6 +240,9 @@ public:
 	/// fix DocIterator in circumstances that should never happen.
 	/// \return true if the DocIterator was fixed.
 	bool fixIfBroken();
+	/// Repopulate the slices insets from bottom to top. Useful
+	/// for stable iterators or Undo data.
+	void sanitize();
 
 	/// find index of CursorSlice with &cell() == &cell (or -1 if not found)
 	int find(MathData const & cell) const;
@@ -243,22 +265,22 @@ private:
 	explicit DocIterator(Buffer * buf, Inset * inset);
 	/**
 	 * Normally, when the cursor is at position i, it is painted *before*
-	 * the character at position i. However, what if we want the cursor 
+	 * the character at position i. However, what if we want the cursor
 	 * painted *after* position i? That's what boundary_ is for: if
 	 * boundary_==true, the cursor is painted *after* position i-1, instead
 	 * of before position i.
 	 *
 	 * Note 1: Usually, after i-1 or before i are actually the same place!
-	 * However, this is not the case when i-1 and i are not painted 
+	 * However, this is not the case when i-1 and i are not painted
 	 * contiguously, and in these cases we sometimes do want to have control
 	 * over whether to paint before i or after i-1.
 	 * Some concrete examples of where this happens:
 	 * a. i-1 at the end of one row, i at the beginning of next row
 	 * b. in bidi text, at transitions between RTL and LTR or vice versa
 	 *
-	 * Note 2: Why i and i-1? Why, if boundary_==false means: *before* i, 
-	 * couldn't boundary_==true mean: *after* i? 
-	 * Well, the reason is this: cursor position is not used only for 
+	 * Note 2: Why i and i-1? Why, if boundary_==false means: *before* i,
+	 * couldn't boundary_==true mean: *after* i?
+	 * Well, the reason is this: cursor position is not used only for
 	 * painting the cursor, but it also affects other things, for example:
 	 * where the next insertion will be placed (it is inserted at the current
 	 * position, pushing anything at the current position and beyond forward).
@@ -302,21 +324,21 @@ bool operator<(DocIterator const & p, DocIterator const & q)
 }
 
 
-inline	
+inline
 bool operator>(DocIterator const & p, DocIterator const & q)
 {
 	return q < p;
 }
 
 
-inline	
+inline
 bool operator<=(DocIterator const & p, DocIterator const & q)
 {
 	return !(q < p);
 }
 
 
-inline	
+inline
 bool operator>=(DocIterator const & p, DocIterator const & q)
 {
 	return !(p < q);
@@ -355,10 +377,6 @@ private:
 	std::vector<CursorSlice> data_;
 };
 
-/// Indicate if the character pointed by dit is a letter.
-/// This function takes care of spellchecker escape chars.
-bool isLetter(DocIterator const & dit);
-
 } // namespace lyx
 
 #endif // DOCITERATOR_H