]> git.lyx.org Git - lyx.git/blobdiff - src/dociterator.h
Continue to improve GtkLengthEntry
[lyx.git] / src / dociterator.h
index 50d8d4e72df044b1f8274fc2949c7718a426e6d1..f8f4b490f52cb6c2bc82dc74c534bf9770402141 100644 (file)
@@ -34,7 +34,7 @@ bool ptr_cmp(A const * a, B const * b)
 
 // 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 std::vector<CursorSlice>
 {
 public:
        /// type for cell number in inset
@@ -54,48 +54,54 @@ public:
        ///
        explicit DocIterator(InsetBase & inset);
 
+       /// access slice at position \p i
+       CursorSlice const & operator[](size_t i) const { return slices_[i]; }
+       /// access slice at position \p i
+       CursorSlice & operator[](size_t i) { return slices_[i]; }
+       /// chop a few slices from the iterator
+       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(); }
 
+       /// does this iterator have any content?
+       bool empty() const { return slices_.empty(); }
+
        //
        // access to slice at tip
        //
        /// access to tip
-       CursorSlice & top() { return back(); }
+       CursorSlice & top() { return slices_.back(); }
        /// access to tip
-       CursorSlice const & top() const { return back(); }
+       CursorSlice const & top() const { return slices_.back(); }
        /// access to outermost slice
-       CursorSlice & bottom() { return front(); }
-       /// access to  outermost slicetip
-       CursorSlice const & bottom() const { return front(); }
+       CursorSlice & bottom() { return slices_.front(); }
+       /// access to outermost slice
+       CursorSlice const & bottom() const { return slices_.front(); }
        /// how many nested insets do we have?
-       size_t depth() const { return size(); }
+       size_t depth() const { return slices_.size(); }
        /// the containing inset
-       InsetBase & inset() const { return back().inset(); }
+       InsetBase & inset() const { return top().inset(); }
        /// return the cell of the inset this cursor is in
-       idx_type idx() const { return back().idx(); }
+       idx_type idx() const { return top().idx(); }
        /// return the cell of the inset this cursor is in
-       idx_type & idx() { return back().idx(); }
+       idx_type & idx() { return top().idx(); }
        /// return the last possible cell in this inset
        idx_type lastidx() const;
        /// return the paragraph this cursor is in
-       pit_type pit() const { return back().pit(); }
+       pit_type pit() const { return top().pit(); }
        /// return the paragraph this cursor is in
-       pit_type & pit() { return back().pit(); }
+       pit_type & pit() { return top().pit(); }
        /// return the last possible paragraph in this inset
        pit_type lastpit() const;
        /// return the position within the paragraph
-       pos_type pos() const { return back().pos(); }
+       pos_type pos() const { return top().pos(); }
        /// return the position within the paragraph
-       pos_type & pos() { return back().pos(); }
+       pos_type & pos() { return top().pos(); }
        /// return the last position within the paragraph
        pos_type lastpos() const;
-       /// return the display row of the cursor with in the top par
-       row_type crow() const;
-       /// return the display row of the cursor with in the top par
-       row_type lastcrow() const;
 
        /// return the number of embedded cells
        size_t nargs() const;
@@ -117,6 +123,10 @@ public:
        InsetBase * prevInset();
        /// the inset just in front of the cursor
        InsetBase const * prevInset() const;
+       ///
+       bool boundary() const { return boundary_; }
+       ///
+       void boundary(bool b) { boundary_ = b; }
 
        /// are we in mathed?
        bool inMathed() const;
@@ -142,10 +152,6 @@ public:
        //
        // text-specific part
        //
-       /// see comment for boundary_ below
-       bool boundary() const { return top().boundary(); }
-       /// see comment for boundary_ below
-       bool & boundary() { return top().boundary(); }
        /// the paragraph we're in
        Paragraph & paragraph();
        /// the paragraph we're in
@@ -155,17 +161,28 @@ public:
        /// the row in the paragraph we're in
        Row const & textRow() const;
        ///
-       LyXText * text() const;
+       LyXText * text();
+       ///
+       LyXText const * text() const;
+       /// the containing inset or the cell, respectively
+       InsetBase * realInset() const;
        ///
        InsetBase * innerInsetOfType(int code) const;
        ///
-       LyXText * innerText() const;
+       LyXText * innerText();
+       ///
+       LyXText const * innerText() const;
 
        //
        // elementary moving
        //
-       /// move on one logical position
-       void forwardPos();
+       /// move on one logical position, do not descend into nested insets
+       void forwardPosNoDescend();
+       /**
+        * move on one logical position, descend into nested insets
+        * skip collapsed insets if \p ignorecollapsed is true
+        */
+       void forwardPos(bool ignorecollapsed = false);
        /// move on one physical character or inset
        void forwardChar();
        /// move on one paragraph
@@ -191,7 +208,44 @@ public:
        /// output
        friend std::ostream &
        operator<<(std::ostream & os, DocIterator const & cur);
+       ///
+       friend bool operator==(DocIterator const &, DocIterator const &);
+       ///
+       friend class StableDocIterator;
+//protected:
+       ///
+       void clear() { slices_.clear(); }
+       ///
+       void push_back(CursorSlice const & sl) { slices_.push_back(sl); }
+       ///
+       void pop_back() { slices_.pop_back(); }
+       /// recompute the inset parts of the cursor from the document data
+       void updateInsets(InsetBase * inset);
+
 private:
+       /**
+        * When the cursor position is i, is the cursor after the i-th char
+        * or before the i+1-th char ? Normally, these two interpretations are
+        * equivalent, except when the fonts of the i-th and i+1-th char
+        * differ.
+        * We use boundary_ to distinguish between the two options:
+        * If boundary_=true, then the cursor is after the i-th char
+        * and if boundary_=false, then the cursor is before the i+1-th char.
+        *
+        * We currently use the boundary only when the language direction of
+        * the i-th char is different than the one of the i+1-th char.
+        * In this case it is important to distinguish between the two
+        * cursor interpretations, in order to give a reasonable behavior to
+        * the user.
+        */
+       bool boundary_;
+       ///
+       std::vector<CursorSlice> const & internalData() const {
+               return slices_;
+       }
+       ///
+       std::vector<CursorSlice> slices_;
+       ///
        InsetBase * inset_;
 };
 
@@ -200,6 +254,20 @@ DocIterator doc_iterator_begin(InsetBase & inset);
 DocIterator doc_iterator_end(InsetBase & inset);
 
 
+inline
+bool operator==(DocIterator const & di1, DocIterator const & di2)
+{
+       return di1.slices_ == di2.slices_;
+}
+
+
+inline
+bool operator!=(DocIterator const & di1, DocIterator const & di2)
+{
+       return !(di1 == di2);
+}
+
+
 // The difference to a ('non stable') DocIterator is the removed
 // (overwritte by 0...) part of the CursorSlice data items. So this thing
 // is suitable for external storage, but not for iteration as such.
@@ -214,16 +282,23 @@ public:
        DocIterator asDocIterator(InsetBase * start) const;
        ///
        size_t size() const { return data_.size(); }
+       /// type for cursor positions within a cell
+       typedef CursorSlice::pos_type pos_type;
+       ///  return the position within the paragraph
+       pos_type pos() const { return data_.back().pos(); }
+       ///  return the position within the paragraph
+       pos_type & pos() { return data_.back().pos(); }
        ///
        friend std::ostream &
        operator<<(std::ostream & os, StableDocIterator const & cur);
        ///
        friend std::istream &
        operator>>(std::istream & is, StableDocIterator & cur);
+       ///
+       friend bool
+       operator==(StableDocIterator const &, StableDocIterator const &);
 private:
        std::vector<CursorSlice> data_;
 };
 
-bool operator==(StableDocIterator const &, StableDocIterator const &);
-
 #endif