X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FDocIterator.h;h=b73a61ec8ef6bce3846939bda412cf45810f5c5d;hb=a5b01f8f96efc95633a8da1cf4748aa473a89f1a;hp=e36092af748f1697f4b823d9b217c05022fc517d;hpb=57d2f9c0ad96baca7675e1c22e4f1349f849cca7;p=lyx.git diff --git a/src/DocIterator.h b/src/DocIterator.h index e36092af74..b73a61ec8e 100644 --- a/src/DocIterator.h +++ b/src/DocIterator.h @@ -4,7 +4,7 @@ * This file is part of LyX, the document processor. * Licence details can be found in the file COPYING. * - * \author André Pönitz + * \author André Pönitz * * Full author contact details are available in file CREDITS. */ @@ -19,15 +19,18 @@ namespace lyx { +class DocIterator; class LyXErr; class MathAtom; class Paragraph; class Text; +class InsetIterator; +DocIterator doc_iterator_begin(Buffer const * buf, Inset const * inset = 0); +DocIterator doc_iterator_end(Buffer const * buf, Inset const * inset = 0); -// 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 + +class DocIterator { public: /// type for cell number in inset @@ -41,7 +44,16 @@ public: /// DocIterator(); /// - explicit DocIterator(Inset & inset); + explicit DocIterator(Buffer *buf); + + /// access to owning buffer + Buffer * buffer() const { return buffer_; } + /// access to owning buffer + void setBuffer(Buffer * buf) { buffer_ = buf; } + + /// Clone this for given \p buffer. + /// \p buffer must be a clone of buffer_. + DocIterator clone(Buffer * buffer) const; /// access slice at position \p i CursorSlice const & operator[](size_t i) const { return slices_[i]; } @@ -57,6 +69,8 @@ public: /// does this iterator have any content? bool empty() const { return slices_.empty(); } + /// is this the end position? + bool atEnd() const { return slices_.empty(); } // // access to slice at tip @@ -123,6 +137,8 @@ public: /// are we in texted?. bool inTexted() const { return !empty() && !inset().inMathed(); } + /// are we in regexp-mode ? + bool inRegexped() const; // // math-specific part @@ -211,50 +227,61 @@ public: bool fixIfBroken(); /// find index of CursorSlice with &cell() == &cell (or -1 if not found) - idx_type find(MathData const & cell) const; + int find(MathData const & cell) const; /// find index of CursorSlice with inset() == inset (or -1 of not found) - idx_type find(InsetMath const * inset) const; - /// cut off CursorSlices with index > above and store cut off slices in cut - void cutOff(idx_type above, std::vector & cut); + int find(Inset const * inset) const; + /// cut off CursorSlices with index > above and store cut off slices in cut. + void cutOff(int above, std::vector & cut); /// cut off CursorSlices with index > above - void cutOff(idx_type above); + void cutOff(int above); /// push CursorSlices on top void append(std::vector const & x); /// push one CursorSlice on top and set its index and position void append(idx_type idx, pos_type pos); private: + friend class InsetIterator; + 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); /** - * 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. + * Normally, when the cursor is at position i, it is painted *before* + * the character at position i. However, what if we want the cursor + * painted *after* position i? That's what boundary_ is for: if + * boundary_==true, the cursor is painted *after* position i-1, instead + * of before position i. * - * 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. + * Note 1: Usually, after i-1 or before i are actually the same place! + * However, this is not the case when i-1 and i are not painted + * contiguously, and in these cases we sometimes do want to have control + * over whether to paint before i or after i-1. + * Some concrete examples of where this happens: + * a. i-1 at the end of one row, i at the beginning of next row + * b. in bidi text, at transitions between RTL and LTR or vice versa + * + * Note 2: Why i and i-1? Why, if boundary_==false means: *before* i, + * couldn't boundary_==true mean: *after* i? + * Well, the reason is this: cursor position is not used only for + * painting the cursor, but it also affects other things, for example: + * where the next insertion will be placed (it is inserted at the current + * position, pushing anything at the current position and beyond forward). + * Now, when the current position is i and boundary_==true, insertion would + * happen *before* i. If the cursor, however, were painted *after* i, that + * would be very unnatural... */ bool boundary_; /// - std::vector const & internalData() const { - return slices_; - } + std::vector const & internalData() const { return slices_; } /// std::vector slices_; /// Inset * inset_; + /// + Buffer * buffer_; }; -DocIterator doc_iterator_begin(Inset & inset); -DocIterator doc_iterator_end(Inset & inset); - - inline bool operator==(DocIterator const & di1, DocIterator const & di2) { return di1.slices_ == di2.slices_; @@ -293,18 +320,26 @@ bool operator<=(DocIterator const & p, DocIterator const & q) } +inline +bool operator>=(DocIterator const & p, DocIterator const & q) +{ + return !(p < q); +} + + // The difference to a ('non stable') DocIterator is the removed // (overwritten by 0...) part of the CursorSlice data items. So this thing // is suitable for external storage, but not for iteration as such. -class StableDocIterator { +class StableDocIterator +{ public: /// StableDocIterator() {} /// non-explicit intended StableDocIterator(const DocIterator & it); /// - DocIterator asDocIterator(Inset * start) const; + DocIterator asDocIterator(Buffer * buf) const; /// size_t size() const { return data_.size(); } /// return the position within the paragraph @@ -324,7 +359,6 @@ private: std::vector data_; }; - } // namespace lyx -#endif +#endif // DOCITERATOR_H