Simplify DocIterator

[lyx.git] / src / DocIterator.h

diff --git a/src/DocIterator.h b/src/DocIterator.h
index 9582ea30f95b6e4fdd6fe9913c7c7e5c4d771ea7..5e6ae6c166232ae1ba8e51a2119b1e0996f4558e 100644 (file)
--- a/src/DocIterator.h
+++ b/src/DocIterator.h
@@ -15,7 +15,7 @@
 #include "CursorSlice.h"
 
 #include <vector>
-#include <algorithm>
+#include <algorithm> // std::min in MSVC 2017
 
 namespace lyx {
 
@@ -35,18 +35,14 @@ DocIterator doc_iterator_end(Buffer const * buf, Inset const * inset = 0);
 class DocIterator
 {
 public:
-       /// type for cell number in inset
-       typedef CursorSlice::idx_type idx_type;
-       /// type for row indices
-       typedef CursorSlice::row_type row_type;
-       /// type for col indices
-       typedef CursorSlice::col_type col_type;
-
-public:
-       ///
-       DocIterator();
        ///
-       explicit DocIterator(Buffer *buf);
+       DocIterator() = default;
+
+       // We could be able to get rid of this if only every BufferView were
+       // associated to a buffer on construction.
+       explicit DocIterator(Buffer *buf)
+               : buffer_(buf)
+       {}
 
        /// access to owning buffer
        Buffer * buffer() const { return buffer_; }
@@ -69,10 +65,10 @@ public:
 
        /// does this iterator have any content?
        bool empty() const { return slices_.empty(); }
+       /// is this the begin position?
+       bool atBegin() const { return depth() == 1 && pit() == 0 && pos() == 0; }
        /// 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;
@@ -126,6 +122,7 @@ public:
        /// return the last column of the top grid
        col_type lastcol() const { return ncols() - 1; }
        /// the inset just behind the cursor
+       /// returns 0 if there is no inset (e.g. normal text)
        Inset * nextInset() const;
        /// the inset just in front of the cursor
        Inset * prevInset() const;
@@ -207,10 +204,12 @@ public:
        void forwardChar();
        /// move on one paragraph
        void forwardPar();
-       /// move on one inset
+       /// move on to the next closest inset
        void forwardInset();
        /// move backward one logical position
        void backwardPos();
+       /// move backward one logical position, skip collapsed insets
+       void backwardPosIgnoreCollapsed();
        /// move backward one physical character or inset
        void backwardChar();
        /// move backward one paragraph
@@ -248,6 +247,10 @@ public:
        /// Repopulate the slices insets from bottom to top. Useful
        /// for stable iterators or Undo data.
        void sanitize();
+       ///
+       bool isInside(Inset const *) const;
+       /// make sure we are outside of given inset
+       void leaveInset(Inset const & inset);
 
        /// find index of CursorSlice with &cell() == &cell (or -1 if not found)
        int find(MathData const & cell) const;
@@ -272,7 +275,10 @@ private:
        friend DocIterator doc_iterator_begin(Buffer const * buf, Inset const * inset);
        friend DocIterator doc_iterator_end(Buffer const * buf, Inset const * inset);
        ///
-       explicit DocIterator(Buffer * buf, Inset * inset);
+       explicit DocIterator(Buffer * buf, Inset * inset)
+               : inset_(inset), buffer_(buf)
+       {}
+       
        /**
         * Normally, when the cursor is at position i, it is painted *before*
         * the character at position i. However, what if we want the cursor
@@ -298,15 +304,15 @@ private:
         * happen *before* i. If the cursor, however, were painted *after* i, that
         * would be very unnatural...
         */
-       bool boundary_;
+       bool boundary_ = false;
        ///
        std::vector<CursorSlice> const & internalData() const { return slices_; }
        ///
        std::vector<CursorSlice> slices_;
        ///
-       Inset * inset_;
+       Inset * inset_ = nullptr;
        ///
-       Buffer * buffer_;
+       Buffer * buffer_ = nullptr;
 };