X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FDocIterator.h;h=cde876cd86f1382a4a6938bfd7f3a91d876eca31;hb=28be7d552f62cc02fa86d7f79201d089bfb2d7b5;hp=dd314499fbf9c1b9a2fb3de75a13c2e2930a9277;hpb=f1cba8ff64b369792fd49f5ddf90e8126ab476ac;p=lyx.git

diff --git a/src/DocIterator.h b/src/DocIterator.h
index dd314499fb..cde876cd86 100644
--- a/src/DocIterator.h
+++ b/src/DocIterator.h
@@ -15,20 +15,23 @@
 #include "CursorSlice.h"
 
 #include <vector>
-
+#include <algorithm>
 
 namespace lyx {
 
+class DocIterator;
 class LyXErr;
 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);
 
 
-// The public inheritance should go in favour of a suitable data member
-// (or maybe private inheritance) at some point of time.
-class DocIterator // : public std::vector<CursorSlice>
+class DocIterator
 {
 public:
 	/// type for cell number in inset
@@ -41,6 +44,17 @@ public:
 public:
 	///
 	DocIterator();
+	///
+	explicit DocIterator(Buffer *buf);
+
+	/// access to owning buffer
+	Buffer * buffer() const { return buffer_; }
+	/// 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]; }
@@ -50,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
@@ -124,6 +141,8 @@ public:
 	/// are we in texted?.
 	bool inTexted() const
 	{ return !empty() && !inset().inMathed(); }
+	/// are we in regexp-mode ?
+	bool inRegexped() const;
 
 	//
 	// math-specific part
@@ -146,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
@@ -158,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
@@ -181,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
@@ -210,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;
@@ -226,10 +259,10 @@ public:
 
 private:
 	friend class InsetIterator;
-	friend DocIterator doc_iterator_begin(Inset & inset);
-	friend DocIterator doc_iterator_end(Inset & inset);
+	friend DocIterator doc_iterator_begin(Buffer const * buf, Inset const * inset);
+	friend DocIterator doc_iterator_end(Buffer const * buf, Inset const * inset);
 	///
-	explicit DocIterator(Inset & inset);
+	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 
@@ -257,20 +290,16 @@ private:
 	 */
 	bool boundary_;
 	///
-	std::vector<CursorSlice> const & internalData() const {
-		return slices_;
-	}
+	std::vector<CursorSlice> const & internalData() const { return slices_; }
 	///
 	std::vector<CursorSlice> slices_;
 	///
 	Inset * inset_;
+	///
+	Buffer * buffer_;
 };
 
 
-DocIterator doc_iterator_begin(Inset & inset);
-DocIterator doc_iterator_end(Inset & inset);
-
-
 inline bool operator==(DocIterator const & di1, DocIterator const & di2)
 {
 	return di1.slices_ == di2.slices_;
@@ -320,14 +349,15 @@ bool operator>=(DocIterator const & p, DocIterator const & q)
 // (overwritten by 0...) part of the CursorSlice data items. So this thing
 // is suitable for external storage, but not for iteration as such.
 
-class StableDocIterator {
+class StableDocIterator
+{
 public:
 	///
 	StableDocIterator() {}
 	/// non-explicit intended
 	StableDocIterator(const DocIterator & it);
 	///
-	DocIterator asDocIterator(Inset * start) const;
+	DocIterator asDocIterator(Buffer * buf) const;
 	///
 	size_t size() const { return data_.size(); }
 	///  return the position within the paragraph
@@ -347,7 +377,6 @@ private:
 	std::vector<CursorSlice> data_;
 };
 
-
 } // namespace lyx
 
-#endif
+#endif // DOCITERATOR_H