]> git.lyx.org Git - lyx.git/blobdiff - src/DocIterator.h
Account for old versions of Pygments
[lyx.git] / src / DocIterator.h
index 737cbd3b13b2b8a80578b131770f2fbe48024bbe..cde876cd86f1382a4a6938bfd7f3a91d876eca31 100644 (file)
@@ -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;
@@ -355,7 +377,6 @@ private:
        std::vector<CursorSlice> data_;
 };
 
-
 } // namespace lyx
 
 #endif // DOCITERATOR_H