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"
30 DocIterator doc_iterator_begin(Buffer const * buf, Inset const * inset = 0);
31 DocIterator doc_iterator_end(Buffer const * buf, Inset const * inset = 0);
37 /// type for cell number in inset
38 typedef CursorSlice::idx_type idx_type;
39 /// type for row indices
40 typedef CursorSlice::row_type row_type;
41 /// type for col indices
42 typedef CursorSlice::col_type col_type;
48 explicit DocIterator(Buffer *buf);
50 /// access to owning buffer
51 Buffer * buffer() const { return buffer_; }
52 /// access to owning buffer
53 void setBuffer(Buffer * buf) { buffer_ = buf; }
55 /// Clone this for given \p buffer.
56 /// \p buffer must be a clone of buffer_.
57 DocIterator clone(Buffer * buffer) const;
59 /// access slice at position \p i
60 CursorSlice const & operator[](size_t i) const { return slices_[i]; }
61 /// access slice at position \p i
62 CursorSlice & operator[](size_t i) { return slices_[i]; }
63 /// chop a few slices from the iterator
64 void resize(size_t i) { slices_.resize(i); }
66 /// is the iterator valid?
67 explicit operator bool() const { return !empty(); }
69 /// does this iterator have any content?
70 bool empty() const { return slices_.empty(); }
71 /// is this the end position?
72 bool atEnd() const { return slices_.empty(); }
73 /// is this the last possible position?
74 bool atLastPos() const { return pit() == lastpit() && pos() == lastpos(); }
76 /// checks the cursor slices for disabled spell checker insets
77 bool allowSpellCheck() const;
80 // access to slice at tip
83 CursorSlice & top() { return slices_.back(); }
85 CursorSlice const & top() const { return slices_.back(); }
86 /// access to outermost slice
87 CursorSlice & bottom() { return slices_.front(); }
88 /// access to outermost slice
89 CursorSlice const & bottom() const { return slices_.front(); }
90 /// how many nested insets do we have?
91 size_t depth() const { return slices_.size(); }
92 /// the containing inset
93 Inset & inset() const { return top().inset(); }
94 /// return the cell of the inset this cursor is in
95 idx_type idx() const { return top().idx(); }
96 /// return the cell of the inset this cursor is in
97 idx_type & idx() { return top().idx(); }
98 /// return the last possible cell in this inset
99 idx_type lastidx() const;
100 /// return the paragraph this cursor is in
101 pit_type pit() const { return top().pit(); }
102 /// return the paragraph this cursor is in
103 pit_type & pit() { return top().pit(); }
104 /// return the last possible paragraph in this inset
105 pit_type lastpit() const;
106 /// return the position within the paragraph
107 pos_type pos() const { return top().pos(); }
108 /// return the position within the paragraph
109 pos_type & pos() { return top().pos(); }
110 /// return the last position within the paragraph
111 pos_type lastpos() const;
113 /// return the number of embedded cells
114 size_t nargs() const;
115 /// return the number of embedded cells
116 size_t ncols() const;
117 /// return the number of embedded cells
118 size_t nrows() const;
119 /// return the grid row of the top cell
120 row_type row() const;
121 /// return the last row of the top grid
122 row_type lastrow() const { return nrows() - 1; }
123 /// return the grid column of the top cell
124 col_type col() const;
125 /// return the last column of the top grid
126 col_type lastcol() const { return ncols() - 1; }
127 /// the inset just behind the cursor
128 Inset * nextInset() const;
129 /// the inset just in front of the cursor
130 Inset * prevInset() const;
132 bool boundary() const { return boundary_; }
134 void boundary(bool b) { boundary_ = b; }
136 // the two methods below have been inlined out because of
137 // profiling results under linux when opening a document.
138 /// are we in mathed?.
139 bool inMathed() const
140 { return !empty() && inset().inMathed(); }
141 /// are we in texted?.
142 bool inTexted() const
143 { return !empty() && !inset().inMathed(); }
144 /// are we in regexp-mode ?
145 bool inRegexped() const;
148 // math-specific part
150 /// return the mathed cell this cursor is in
151 MathData & cell() const;
152 /// the mathatom left of the cursor
153 MathAtom & prevAtom() const;
154 /// the mathatom right of the cursor
155 MathAtom & nextAtom() const;
157 // text-specific part
159 /// the paragraph we're in in text mode.
160 /// \warning only works within text!
161 Paragraph & paragraph() const;
162 /// the paragraph we're in in any case.
163 /// This method will give the containing paragraph even
164 /// if not in text mode (ex: in mathed).
165 Paragraph & innerParagraph() const;
166 /// return the inner text slice.
167 CursorSlice const & innerTextSlice() const;
168 // convert a DocIterator into an argument to LFUN_PARAGRAPH_GOTO
169 docstring paragraphGotoArgument() const;
170 /// returns a DocIterator for the containing text inset
171 DocIterator getInnerText() const;
172 /// the first and last positions of a word at top cursor slice
173 /// \warning only works within text!
174 FontSpan locateWord(word_location const loc) const;
177 /// the containing inset or the cell, respectively
178 Inset * realInset() const;
180 Inset * innerInsetOfType(int code) const;
182 Text * innerText() const;
188 * move on one logical position, descend into nested insets
189 * including collapsed insets
193 * move on one logical position, descend into nested insets
194 * skip collapsed insets
196 void forwardPosIgnoreCollapsed();
197 /// move on one physical character or inset
199 /// move on one paragraph
201 /// move on one inset
203 /// move backward one logical position
205 /// move backward one physical character or inset
207 /// move backward one paragraph
209 /// move backward one inset
210 /// not used currently, uncomment if you need it
211 //void backwardInset();
213 /// are we some 'extension' (i.e. deeper nested) of the given iterator
214 bool hasPart(DocIterator const & it) const;
217 friend std::ostream &
218 operator<<(std::ostream & os, DocIterator const & cur);
219 friend LyXErr & operator<<(LyXErr & os, DocIterator const & it);
221 friend bool operator==(DocIterator const &, DocIterator const &);
222 friend bool operator<(DocIterator const &, DocIterator const &);
223 friend bool operator>(DocIterator const &, DocIterator const &);
224 friend bool operator<=(DocIterator const &, DocIterator const &);
226 friend class StableDocIterator;
229 void clear() { slices_.clear(); }
231 void push_back(CursorSlice const & sl) { slices_.push_back(sl); }
233 void pop_back() { slices_.pop_back(); }
234 /// recompute the inset parts of the cursor from the document data
235 void updateInsets(Inset * inset);
236 /// fix DocIterator in circumstances that should never happen.
237 /// \return true if the DocIterator was fixed.
239 /// Repopulate the slices insets from bottom to top. Useful
240 /// for stable iterators or Undo data.
243 /// find index of CursorSlice with &cell() == &cell (or -1 if not found)
244 int find(MathData const & cell) const;
245 /// find index of CursorSlice with inset() == inset (or -1 of not found)
246 int find(Inset const * inset) const;
247 /// cut off CursorSlices with index > above and store cut off slices in cut.
248 void cutOff(int above, std::vector<CursorSlice> & cut);
249 /// cut off CursorSlices with index > above
250 void cutOff(int above);
251 /// push CursorSlices on top
252 void append(std::vector<CursorSlice> const & x);
253 /// push one CursorSlice on top and set its index and position
254 void append(idx_type idx, pos_type pos);
257 friend class InsetIterator;
258 friend DocIterator doc_iterator_begin(Buffer const * buf, Inset const * inset);
259 friend DocIterator doc_iterator_end(Buffer const * buf, Inset const * inset);
261 explicit DocIterator(Buffer * buf, Inset * inset);
263 * Normally, when the cursor is at position i, it is painted *before*
264 * the character at position i. However, what if we want the cursor
265 * painted *after* position i? That's what boundary_ is for: if
266 * boundary_==true, the cursor is painted *after* position i-1, instead
267 * of before position i.
269 * Note 1: Usually, after i-1 or before i are actually the same place!
270 * However, this is not the case when i-1 and i are not painted
271 * contiguously, and in these cases we sometimes do want to have control
272 * over whether to paint before i or after i-1.
273 * Some concrete examples of where this happens:
274 * a. i-1 at the end of one row, i at the beginning of next row
275 * b. in bidi text, at transitions between RTL and LTR or vice versa
277 * Note 2: Why i and i-1? Why, if boundary_==false means: *before* i,
278 * couldn't boundary_==true mean: *after* i?
279 * Well, the reason is this: cursor position is not used only for
280 * painting the cursor, but it also affects other things, for example:
281 * where the next insertion will be placed (it is inserted at the current
282 * position, pushing anything at the current position and beyond forward).
283 * Now, when the current position is i and boundary_==true, insertion would
284 * happen *before* i. If the cursor, however, were painted *after* i, that
285 * would be very unnatural...
289 std::vector<CursorSlice> const & internalData() const { return slices_; }
291 std::vector<CursorSlice> slices_;
299 inline bool operator==(DocIterator const & di1, DocIterator const & di2)
301 return di1.slices_ == di2.slices_;
305 inline bool operator!=(DocIterator const & di1, DocIterator const & di2)
307 return !(di1 == di2);
312 bool operator<(DocIterator const & p, DocIterator const & q)
314 size_t depth = std::min(p.depth(), q.depth());
315 for (size_t i = 0 ; i < depth ; ++i) {
319 return p.depth() < q.depth();
324 bool operator>(DocIterator const & p, DocIterator const & q)
331 bool operator<=(DocIterator const & p, DocIterator const & q)
338 bool operator>=(DocIterator const & p, DocIterator const & q)
344 // The difference to a ('non stable') DocIterator is the removed
345 // (overwritten by 0...) part of the CursorSlice data items. So this thing
346 // is suitable for external storage, but not for iteration as such.
348 class StableDocIterator
352 StableDocIterator() {}
353 /// non-explicit intended
354 StableDocIterator(const DocIterator & it);
356 DocIterator asDocIterator(Buffer * buf) const;
358 size_t size() const { return data_.size(); }
359 /// return the position within the paragraph
360 pos_type pos() const { return data_.back().pos(); }
361 /// return the position within the paragraph
362 pos_type & pos() { return data_.back().pos(); }
364 friend std::ostream &
365 operator<<(std::ostream & os, StableDocIterator const & cur);
367 friend std::istream &
368 operator>>(std::istream & is, StableDocIterator & cur);
371 operator==(StableDocIterator const &, StableDocIterator const &);
373 std::vector<CursorSlice> data_;
378 #endif // DOCITERATOR_H