X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FDocIterator.h;h=9475fcfb78e44c18d795816f6f438bbcd9017fb0;hb=c013799887eb5c330f3cff4d51542028683fe1bb;hp=01b16bbabe91da339b6c9f9be9b8c9682b41d6ff;hpb=f630be890494c849981e4fb52ea4740506e92bed;p=lyx.git diff --git a/src/DocIterator.h b/src/DocIterator.h index 01b16bbabe..9475fcfb78 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. */ @@ -15,41 +15,43 @@ #include "CursorSlice.h" #include -#include - +#include // std::min in MSVC 2017 namespace lyx { -class LyXText; +class DocIterator; +class Encoding; +class FontSpan; +class InsetIterator; +class LyXErr; class MathAtom; class Paragraph; +class Text; - -// only needed for gcc 2.95, remove when support terminated -template -bool ptr_cmp(A const * a, B const * b) -{ - return a == b; -} +DocIterator doc_iterator_begin(Buffer const * buf, Inset const * inset = nullptr); +DocIterator doc_iterator_end(Buffer const * buf, Inset const * inset = nullptr); -// 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 - typedef CursorSlice::idx_type idx_type; - /// type for row indices - typedef CursorSlice::row_type row_type; - /// type for col indices - typedef CursorSlice::col_type col_type; - -public: - /// - DocIterator(); /// - explicit DocIterator(InsetBase & inset); + DocIterator() = default; + + // We could be able to get rid of this if only every BufferView were + // associated to a buffer on construction. + explicit DocIterator(Buffer *buf) + : 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]; } @@ -59,12 +61,17 @@ public: 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(); } + explicit operator bool() const { return !empty(); } /// does this iterator have any content? bool empty() const { return slices_.empty(); } + /// is this the begin position? + bool atBegin() const { return depth() == 1 && pit() == 0 && pos() == 0; } + /// is this the end position? + bool atEnd() const { return slices_.empty(); } + + /// checks the cursor slices for disabled spell checker insets + bool allowSpellCheck() const; // // access to slice at tip @@ -80,7 +87,7 @@ public: /// how many nested insets do we have? size_t depth() const { return slices_.size(); } /// the containing inset - InsetBase & inset() const { return top().inset(); } + Inset & inset() const { return top().inset(); } /// return the cell of the inset this cursor is in idx_type idx() const { return top().idx(); } /// return the cell of the inset this cursor is in @@ -115,11 +122,10 @@ public: /// return the last column of the top grid col_type lastcol() const { return ncols() - 1; } /// the inset just behind the cursor - InsetBase * nextInset(); + /// returns 0 if there is no inset (e.g. normal text) + Inset * nextInset() const; /// the inset just in front of the cursor - InsetBase * prevInset(); - /// the inset just in front of the cursor - InsetBase const * prevInset() const; + Inset * prevInset() const; /// bool boundary() const { return boundary_; } /// @@ -133,72 +139,83 @@ public: /// are we in texted?. bool inTexted() const { return !empty() && !inset().inMathed(); } + /// are we in regexp-mode ? + bool inRegexped() const; // // math-specific part // /// return the mathed cell this cursor is in - MathArray const & cell() const; - /// return the mathed cell this cursor is in - MathArray & cell(); - /// the mathatom left of the cursor - MathAtom const & prevAtom() const; + MathData & cell() const; + /// + InsetMath & nextMath(); + /// + InsetMath & prevMath(); /// the mathatom left of the cursor - MathAtom & prevAtom(); + MathAtom & prevAtom() const; /// the mathatom right of the cursor - MathAtom const & nextAtom() const; - /// the mathatom right of the cursor - MathAtom & nextAtom(); + MathAtom & nextAtom() const; - // // text-specific part // - /// the paragraph we're in - Paragraph & paragraph(); - /// the paragraph we're in - Paragraph const & paragraph() const; + /// the paragraph we're in in text mode. + /// \warning only works within text! + Paragraph & paragraph() const; + /// the paragraph we're in in any case. + /// This method will give the containing paragraph even + /// if not in text mode (ex: in mathed). + Paragraph & innerParagraph() const; + /// return the inner text slice. + CursorSlice const & innerTextSlice() const; + // convert a DocIterator into an argument to LFUN_PARAGRAPH_GOTO + docstring paragraphGotoArgument() const; + /// returns a DocIterator for the containing text inset + DocIterator getInnerText() const; + /// the first and last positions of a word at top cursor slice + /// \warning only works within text! + FontSpan locateWord(word_location const loc) const; /// - LyXText * text(); - /// - LyXText const * text() const; + Text * text() const; /// the containing inset or the cell, respectively - InsetBase * realInset() const; - /// - InsetBase * innerInsetOfType(int code) const; + Inset * realInset() const; /// - LyXText * innerText(); + Inset * innerInsetOfType(int code) const; /// - LyXText const * innerText() const; + Text * innerText() const; // // elementary moving // - /// move on one logical position, do not descend into nested insets - void forwardPosNoDescend(); + /// move one step backwards + bool posBackward(); + /// move one step forward + bool posForward(); /** * move on one logical position, descend into nested insets - * skip collapsed insets if \p ignorecollapsed is true + * including collapsed insets */ - void forwardPos(bool ignorecollapsed = false); + void forwardPos(); + /** + * move on one logical position, descend into nested insets + * skip collapsed insets + */ + void forwardPosIgnoreCollapsed(); /// move on one physical character or inset void forwardChar(); /// move on one paragraph void forwardPar(); - /// move on one cell - void forwardIdx(); - /// move on one inset + /// move on to the next closest inset void forwardInset(); /// move backward one logical position void backwardPos(); + /// move backward one logical position, skip collapsed insets + void backwardPosIgnoreCollapsed(); /// move backward one physical character or inset void backwardChar(); /// move backward one paragraph void backwardPar(); - /// move backward one cell - void backwardIdx(); /// move backward one inset - /// FIXME: This is not implemented! - //void backwardInset(); + void backwardInset(); /// are we some 'extension' (i.e. deeper nested) of the given iterator bool hasPart(DocIterator const & it) const; @@ -206,8 +223,12 @@ public: /// output friend std::ostream & operator<<(std::ostream & os, DocIterator const & cur); + friend LyXErr & operator<<(LyXErr & os, DocIterator const & it); /// friend bool operator==(DocIterator const &, DocIterator const &); + friend bool operator<(DocIterator const &, DocIterator const &); + friend bool operator>(DocIterator const &, DocIterator const &); + friend bool operator<=(DocIterator const &, DocIterator const &); /// friend class StableDocIterator; //protected: @@ -218,51 +239,124 @@ public: /// void pop_back() { slices_.pop_back(); } /// recompute the inset parts of the cursor from the document data - void updateInsets(InsetBase * inset); + void updateInsets(Inset * inset); + /// fix DocIterator in circumstances that should never happen. + /// \return true if the DocIterator was fixed. + bool fixIfBroken(); + /// Repopulate the slices insets from bottom to top. Useful + /// for stable iterators or Undo data. + void sanitize(); + /// + bool isInside(Inset const *) const; + /// make sure we are outside of given inset + void leaveInset(Inset const & inset); + + /// find index of CursorSlice with &cell() == &cell (or -1 if not found) + int find(MathData const & cell) const; + /// find index of CursorSlice with inset() == inset (or -1 of not found) + 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(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); + /// + docstring getPossibleLabel() const; + + /// + Encoding const * getEncoding() const; 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) + : inset_(inset), buffer_(buf) + {} + /** - * 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. + * + * 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 * - * 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 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_; + bool boundary_ = false; /// - std::vector const & internalData() const { - return slices_; - } + std::vector const & internalData() const { return slices_; } /// std::vector slices_; /// - InsetBase * inset_; + Inset * inset_ = nullptr; + /// + Buffer * buffer_ = nullptr; }; -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); +} inline -bool operator==(DocIterator const & di1, DocIterator const & di2) +bool operator<(DocIterator const & p, DocIterator const & q) { - return di1.slices_ == di2.slices_; + size_t depth = std::min(p.depth(), q.depth()); + for (size_t i = 0 ; i < depth ; ++i) { + if (p[i] != q[i]) + return p[i] < q[i]; + } + return p.depth() < q.depth(); } inline -bool operator!=(DocIterator const & di1, DocIterator const & di2) +bool operator>(DocIterator const & p, DocIterator const & q) { - return !(di1 == di2); + return q < p; +} + + +inline +bool operator<=(DocIterator const & p, DocIterator const & q) +{ + return !(q < p); +} + + +inline +bool operator>=(DocIterator const & p, DocIterator const & q) +{ + return !(p < q); } @@ -270,14 +364,15 @@ bool operator!=(DocIterator const & di1, DocIterator const & di2) // (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(InsetBase * start) const; + DocIterator asDocIterator(Buffer * buf) const; /// size_t size() const { return data_.size(); } /// return the position within the paragraph @@ -297,7 +392,6 @@ private: std::vector data_; }; - } // namespace lyx -#endif +#endif // DOCITERATOR_H