X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FDocIterator.h;h=cfb31f487f248e3c33404456da79f1a24917e3e8;hb=5b341055140b30f0dd6a5469ca4a654c7dd305cd;hp=3f718697ad35cd761c618766f547823bc97212c2;hpb=f0959cc292c4bea1171114e83696aa6fc661db7c;p=lyx.git diff --git a/src/DocIterator.h b/src/DocIterator.h index 3f718697ad..cfb31f487f 100644 --- a/src/DocIterator.h +++ b/src/DocIterator.h @@ -15,37 +15,34 @@ #include "CursorSlice.h" #include -#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; -class FontSpan; -DocIterator doc_iterator_begin(Buffer const * buf, Inset const * inset = 0); -DocIterator doc_iterator_end(Buffer const * buf, Inset const * inset = 0); +DocIterator doc_iterator_begin(Buffer const * buf, Inset const * inset = nullptr); +DocIterator doc_iterator_end(Buffer const * buf, Inset const * inset = nullptr); 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(Buffer *buf); + 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_; } @@ -68,10 +65,10 @@ public: /// 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(); } - /// is this the last possible position? - bool atLastPos() const { return pit() == lastpit() && pos() == lastpos(); } /// checks the cursor slices for disabled spell checker insets bool allowSpellCheck() const; @@ -125,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; @@ -149,6 +147,10 @@ public: // /// 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 @@ -165,6 +167,8 @@ 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 @@ -182,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 @@ -196,10 +204,12 @@ 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 @@ -237,6 +247,10 @@ public: /// 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; @@ -251,30 +265,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(Buffer const * buf, Inset const * inset); friend DocIterator doc_iterator_end(Buffer const * buf, Inset const * inset); /// - explicit DocIterator(Buffer * buf, 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). @@ -282,15 +304,15 @@ 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 slices_; /// - Inset * inset_; + Inset * inset_ = nullptr; /// - Buffer * buffer_; + Buffer * buffer_ = nullptr; }; @@ -318,21 +340,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);