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 "CursorSlice.h"
28 // only needed for gcc 2.95, remove when support terminated
29 template <typename A, typename B>
30 bool ptr_cmp(A const * a, B const * b)
36 // The public inheritance should go in favour of a suitable data member
37 // (or maybe private inheritance) at some point of time.
38 class DocIterator // : public std::vector<CursorSlice>
41 /// type for cell number in inset
42 typedef CursorSlice::idx_type idx_type;
43 /// type for row indices
44 typedef CursorSlice::row_type row_type;
45 /// type for col indices
46 typedef CursorSlice::col_type col_type;
52 explicit DocIterator(Inset & inset);
54 /// access slice at position \p i
55 CursorSlice const & operator[](size_t i) const { return slices_[i]; }
56 /// access slice at position \p i
57 CursorSlice & operator[](size_t i) { return slices_[i]; }
58 /// chop a few slices from the iterator
59 void resize(size_t i) { slices_.resize(i); }
61 /// is the iterator valid?
62 operator const void*() const { return empty() ? 0 : this; }
63 /// is this iterator invalid?
64 bool operator!() const { return empty(); }
66 /// does this iterator have any content?
67 bool empty() const { return slices_.empty(); }
70 // access to slice at tip
73 CursorSlice & top() { return slices_.back(); }
75 CursorSlice const & top() const { return slices_.back(); }
76 /// access to outermost slice
77 CursorSlice & bottom() { return slices_.front(); }
78 /// access to outermost slice
79 CursorSlice const & bottom() const { return slices_.front(); }
80 /// how many nested insets do we have?
81 size_t depth() const { return slices_.size(); }
82 /// the containing inset
83 Inset & inset() const { return top().inset(); }
84 /// return the cell of the inset this cursor is in
85 idx_type idx() const { return top().idx(); }
86 /// return the cell of the inset this cursor is in
87 idx_type & idx() { return top().idx(); }
88 /// return the last possible cell in this inset
89 idx_type lastidx() const;
90 /// return the paragraph this cursor is in
91 pit_type pit() const { return top().pit(); }
92 /// return the paragraph this cursor is in
93 pit_type & pit() { return top().pit(); }
94 /// return the last possible paragraph in this inset
95 pit_type lastpit() const;
96 /// return the position within the paragraph
97 pos_type pos() const { return top().pos(); }
98 /// return the position within the paragraph
99 pos_type & pos() { return top().pos(); }
100 /// return the last position within the paragraph
101 pos_type lastpos() const;
103 /// return the number of embedded cells
104 size_t nargs() const;
105 /// return the number of embedded cells
106 size_t ncols() const;
107 /// return the number of embedded cells
108 size_t nrows() const;
109 /// return the grid row of the top cell
110 row_type row() const;
111 /// return the last row of the top grid
112 row_type lastrow() const { return nrows() - 1; }
113 /// return the grid column of the top cell
114 col_type col() const;
115 /// return the last column of the top grid
116 col_type lastcol() const { return ncols() - 1; }
117 /// the inset just behind the cursor
118 Inset * nextInset() const;
119 /// the inset just in front of the cursor
120 Inset * prevInset() const;
122 bool boundary() const { return boundary_; }
124 void boundary(bool b) { boundary_ = b; }
126 // the two methods below have been inlined out because of
127 // profiling results under linux when opening a document.
128 /// are we in mathed?.
129 bool inMathed() const
130 { return !empty() && inset().inMathed(); }
131 /// are we in texted?.
132 bool inTexted() const
133 { return !empty() && !inset().inMathed(); }
136 // math-specific part
138 /// return the mathed cell this cursor is in
139 MathData & cell() const;
140 /// the mathatom left of the cursor
141 MathAtom & prevAtom() const;
142 /// the mathatom right of the cursor
143 MathAtom & nextAtom() const;
145 // text-specific part
147 /// the paragraph we're in in text mode.
148 /// \warning only works within text!
149 Paragraph & paragraph() const;
150 /// the paragraph we're in in any case.
151 /// This method will give the containing paragraph if
152 /// in not in text mode (ex: in mathed).
153 Paragraph & innerParagraph() const;
156 /// the containing inset or the cell, respectively
157 Inset * realInset() const;
159 Inset * innerInsetOfType(int code) const;
161 Text * innerText() const;
167 * move on one logical position, descend into nested insets
168 * skip collapsed insets if \p ignorecollapsed is true
170 void forwardPos(bool ignorecollapsed = false);
171 /// move on one physical character or inset
173 /// move on one paragraph
175 /// move on one inset
177 /// move backward one logical position
179 /// move backward one physical character or inset
181 /// move backward one paragraph
183 /// move backward one inset
184 /// FIXME: This is not implemented!
185 //void backwardInset();
187 /// are we some 'extension' (i.e. deeper nested) of the given iterator
188 bool hasPart(DocIterator const & it) const;
191 friend std::ostream &
192 operator<<(std::ostream & os, DocIterator const & cur);
194 friend bool operator==(DocIterator const &, DocIterator const &);
195 friend bool operator<(DocIterator const &, DocIterator const &);
196 friend bool operator>(DocIterator const &, DocIterator const &);
197 friend bool operator<=(DocIterator const &, DocIterator const &);
199 friend class StableDocIterator;
202 void clear() { slices_.clear(); }
204 void push_back(CursorSlice const & sl) { slices_.push_back(sl); }
206 void pop_back() { slices_.pop_back(); }
207 /// recompute the inset parts of the cursor from the document data
208 void updateInsets(Inset * inset);
209 /// fix DocIterator in circumstances that should never happen.
210 /// \return true if the DocIterator was fixed.
215 * When the cursor position is i, is the cursor after the i-th char
216 * or before the i+1-th char ? Normally, these two interpretations are
217 * equivalent, except when the fonts of the i-th and i+1-th char
219 * We use boundary_ to distinguish between the two options:
220 * If boundary_=true, then the cursor is after the i-th char
221 * and if boundary_=false, then the cursor is before the i+1-th char.
223 * We currently use the boundary only when the language direction of
224 * the i-th char is different than the one of the i+1-th char.
225 * In this case it is important to distinguish between the two
226 * cursor interpretations, in order to give a reasonable behavior to
231 std::vector<CursorSlice> const & internalData() const {
235 std::vector<CursorSlice> slices_;
241 DocIterator doc_iterator_begin(Inset & inset);
242 DocIterator doc_iterator_end(Inset & inset);
246 bool operator==(DocIterator const & di1, DocIterator const & di2)
248 return di1.slices_ == di2.slices_;
253 bool operator!=(DocIterator const & di1, DocIterator const & di2)
255 return !(di1 == di2);
259 // The difference to a ('non stable') DocIterator is the removed
260 // (overwritten by 0...) part of the CursorSlice data items. So this thing
261 // is suitable for external storage, but not for iteration as such.
263 class StableDocIterator {
266 StableDocIterator() {}
267 /// non-explicit intended
268 StableDocIterator(const DocIterator & it);
270 DocIterator asDocIterator(Inset * start) const;
272 size_t size() const { return data_.size(); }
273 /// return the position within the paragraph
274 pos_type pos() const { return data_.back().pos(); }
275 /// return the position within the paragraph
276 pos_type & pos() { return data_.back().pos(); }
278 friend std::ostream &
279 operator<<(std::ostream & os, StableDocIterator const & cur);
281 friend std::istream &
282 operator>>(std::istream & is, StableDocIterator & cur);
285 operator==(StableDocIterator const &, StableDocIterator const &);
287 std::vector<CursorSlice> data_;