X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FDocIterator.h;h=9475fcfb78e44c18d795816f6f438bbcd9017fb0;hb=c013799887eb5c330f3cff4d51542028683fe1bb;hp=5e157ef9072c05d79134608758d7c18141989d9e;hpb=86021437754916198229d0c2a52a5ab9572b274d;p=lyx.git diff --git a/src/DocIterator.h b/src/DocIterator.h index 5e157ef907..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,32 +15,43 @@ #include "CursorSlice.h" #include - +#include // std::min in MSVC 2017 namespace lyx { +class DocIterator; +class Encoding; +class FontSpan; +class InsetIterator; class LyXErr; class MathAtom; class Paragraph; class Text; -class InsetIterator; +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 -{ -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; +class DocIterator +{ public: /// - DocIterator(); + 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]; } @@ -50,15 +61,18 @@ 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 // @@ -108,6 +122,7 @@ public: /// return the last column of the top grid col_type lastcol() const { return ncols() - 1; } /// the inset just behind the cursor + /// returns 0 if there is no inset (e.g. normal text) Inset * nextInset() const; /// the inset just in front of the cursor Inset * prevInset() const; @@ -124,12 +139,18 @@ 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 MathData & cell() const; + /// + InsetMath & nextMath(); + /// + InsetMath & prevMath(); /// the mathatom left of the cursor MathAtom & prevAtom() const; /// the mathatom right of the cursor @@ -146,6 +167,13 @@ public: 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; /// Text * text() const; /// the containing inset or the cell, respectively @@ -158,6 +186,10 @@ public: // // elementary moving // + /// move one step backwards + bool posBackward(); + /// move one step forward + bool posForward(); /** * move on one logical position, descend into nested insets * including collapsed insets @@ -172,17 +204,18 @@ public: void forwardChar(); /// move on one paragraph void forwardPar(); - /// 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 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; @@ -210,6 +243,13 @@ public: /// 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; @@ -224,30 +264,38 @@ public: /// 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(Inset & inset); - friend DocIterator doc_iterator_end(Inset & inset); + friend DocIterator doc_iterator_begin(Buffer const * buf, Inset const * inset); + friend DocIterator doc_iterator_end(Buffer const * buf, Inset const * inset); /// - explicit DocIterator(Inset & inset); + explicit DocIterator(Buffer * buf, Inset * inset) + : inset_(inset), buffer_(buf) + {} + /** * Normally, when the cursor is at position i, it is painted *before* - * the character at position i. However, what if we want the cursor + * 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 + * 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 + * 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). @@ -255,22 +303,18 @@ private: * 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_; /// - Inset * inset_; + Inset * inset_ = nullptr; + /// + Buffer * buffer_ = nullptr; }; -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_; @@ -295,21 +339,21 @@ bool operator<(DocIterator const & p, DocIterator const & q) } -inline +inline bool operator>(DocIterator const & p, DocIterator const & q) { return q < p; } -inline +inline bool operator<=(DocIterator const & p, DocIterator const & q) { return !(q < p); } -inline +inline bool operator>=(DocIterator const & p, DocIterator const & q) { return !(p < q); @@ -320,14 +364,15 @@ bool operator>=(DocIterator const & p, DocIterator const & q) // (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 @@ -347,7 +392,6 @@ private: std::vector data_; }; - } // namespace lyx -#endif +#endif // DOCITERATOR_H