4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
9 * Full author contact details are available in file CREDITS.
15 #include "cursor_slice.h"
29 // only needed for gcc 2.95, remove when support terminated
30 template <typename A, typename B>
31 bool ptr_cmp(A const * a, B const * b)
37 // The public inheritance should go in favour of a suitable data member
38 // (or maybe private inheritance) at some point of time.
39 class DocIterator // : public std::vector<CursorSlice>
42 /// type for cell number in inset
43 typedef CursorSlice::idx_type idx_type;
44 /// type for row indices
45 typedef CursorSlice::row_type row_type;
46 /// type for col indices
47 typedef CursorSlice::col_type col_type;
53 explicit DocIterator(InsetBase & inset);
55 /// access slice at position \p i
56 CursorSlice const & operator[](size_t i) const { return slices_[i]; }
57 /// access slice at position \p i
58 CursorSlice & operator[](size_t i) { return slices_[i]; }
59 /// chop a few slices from the iterator
60 void resize(size_t i) { slices_.resize(i); }
62 /// is the iterator valid?
63 operator const void*() const { return empty() ? 0 : this; }
64 /// is this iterator invalid?
65 bool operator!() const { return empty(); }
67 /// does this iterator have any content?
68 bool empty() const { return slices_.empty(); }
71 // access to slice at tip
74 CursorSlice & top() { return slices_.back(); }
76 CursorSlice const & top() const { return slices_.back(); }
77 /// access to outermost slice
78 CursorSlice & bottom() { return slices_.front(); }
79 /// access to outermost slice
80 CursorSlice const & bottom() const { return slices_.front(); }
81 /// how many nested insets do we have?
82 size_t depth() const { return slices_.size(); }
83 /// the containing inset
84 InsetBase & inset() const { return top().inset(); }
85 /// return the cell of the inset this cursor is in
86 idx_type idx() const { return top().idx(); }
87 /// return the cell of the inset this cursor is in
88 idx_type & idx() { return top().idx(); }
89 /// return the last possible cell in this inset
90 idx_type lastidx() const;
91 /// return the paragraph this cursor is in
92 pit_type pit() const { return top().pit(); }
93 /// return the paragraph this cursor is in
94 pit_type & pit() { return top().pit(); }
95 /// return the last possible paragraph in this inset
96 pit_type lastpit() const;
97 /// return the position within the paragraph
98 pos_type pos() const { return top().pos(); }
99 /// return the position within the paragraph
100 pos_type & pos() { return top().pos(); }
101 /// return the last position within the paragraph
102 pos_type lastpos() const;
104 /// return the number of embedded cells
105 size_t nargs() const;
106 /// return the number of embedded cells
107 size_t ncols() const;
108 /// return the number of embedded cells
109 size_t nrows() const;
110 /// return the grid row of the top cell
111 row_type row() const;
112 /// return the last row of the top grid
113 row_type lastrow() const { return nrows() - 1; }
114 /// return the grid column of the top cell
115 col_type col() const;
116 /// return the last column of the top grid
117 col_type lastcol() const { return ncols() - 1; }
118 /// the inset just behind the cursor
119 InsetBase * nextInset();
120 /// the inset just in front of the cursor
121 InsetBase * prevInset();
122 /// the inset just in front of the cursor
123 InsetBase const * prevInset() const;
125 bool boundary() const { return boundary_; }
127 void boundary(bool b) { boundary_ = b; }
129 /// are we in mathed?
130 bool inMathed() const;
131 /// are we in texted?
132 bool inTexted() const;
135 // math-specific part
137 /// return the mathed cell this cursor is in
138 MathArray const & cell() const;
139 /// return the mathed cell this cursor is in
141 /// the mathatom left of the cursor
142 MathAtom const & prevAtom() const;
143 /// the mathatom left of the cursor
144 MathAtom & prevAtom();
145 /// the mathatom right of the cursor
146 MathAtom const & nextAtom() const;
147 /// the mathatom right of the cursor
148 MathAtom & nextAtom();
151 // text-specific part
153 /// the paragraph we're in
154 Paragraph & paragraph();
155 /// the paragraph we're in
156 Paragraph const & paragraph() const;
157 /// the row in the paragraph we're in
159 /// the row in the paragraph we're in
160 Row const & textRow() const;
164 LyXText const * text() const;
165 /// the containing inset or the cell, respectively
166 InsetBase * realInset() const;
168 InsetBase * innerInsetOfType(int code) const;
170 LyXText * innerText();
172 LyXText const * innerText() const;
177 /// move on one logical position, do not descend into nested insets
178 void forwardPosNoDescend();
180 * move on one logical position, descend into nested insets
181 * skip collapsed insets if \p ignorecollapsed is true
183 void forwardPos(bool ignorecollapsed = false);
184 /// move on one physical character or inset
186 /// move on one paragraph
190 /// move on one inset
192 /// move backward one logical position
194 /// move backward one physical character or inset
196 /// move backward one paragraph
198 /// move backward one cell
200 /// move backward one inset
201 void backwardInset();
203 /// are we some 'extension' (i.e. deeper nested) of the given iterator
204 bool hasPart(DocIterator const & it) const;
207 friend std::ostream &
208 operator<<(std::ostream & os, DocIterator const & cur);
210 friend bool operator==(DocIterator const &, DocIterator const &);
212 friend class StableDocIterator;
215 void clear() { slices_.clear(); }
217 void push_back(CursorSlice const & sl) { slices_.push_back(sl); }
219 void pop_back() { slices_.pop_back(); }
220 /// recompute the inset parts of the cursor from the document data
221 void updateInsets(InsetBase * inset);
225 * When the cursor position is i, is the cursor after the i-th char
226 * or before the i+1-th char ? Normally, these two interpretations are
227 * equivalent, except when the fonts of the i-th and i+1-th char
229 * We use boundary_ to distinguish between the two options:
230 * If boundary_=true, then the cursor is after the i-th char
231 * and if boundary_=false, then the cursor is before the i+1-th char.
233 * We currently use the boundary only when the language direction of
234 * the i-th char is different than the one of the i+1-th char.
235 * In this case it is important to distinguish between the two
236 * cursor interpretations, in order to give a reasonable behavior to
241 std::vector<CursorSlice> const & internalData() const {
245 std::vector<CursorSlice> slices_;
251 DocIterator doc_iterator_begin(InsetBase & inset);
252 DocIterator doc_iterator_end(InsetBase & inset);
256 bool operator==(DocIterator const & di1, DocIterator const & di2)
258 return di1.slices_ == di2.slices_;
263 bool operator!=(DocIterator const & di1, DocIterator const & di2)
265 return !(di1 == di2);
269 // The difference to a ('non stable') DocIterator is the removed
270 // (overwritte by 0...) part of the CursorSlice data items. So this thing
271 // is suitable for external storage, but not for iteration as such.
273 class StableDocIterator {
276 StableDocIterator() {}
277 /// non-explicit intended
278 StableDocIterator(const DocIterator & it);
280 DocIterator asDocIterator(InsetBase * start) const;
282 size_t size() const { return data_.size(); }
283 /// return the position within the paragraph
284 pos_type pos() const { return data_.back().pos(); }
285 /// return the position within the paragraph
286 pos_type & pos() { return data_.back().pos(); }
288 friend std::ostream &
289 operator<<(std::ostream & os, StableDocIterator const & cur);
291 friend std::istream &
292 operator>>(std::istream & is, StableDocIterator & cur);
295 operator==(StableDocIterator const &, StableDocIterator const &);
297 std::vector<CursorSlice> data_;