X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FCursor.h;h=d84db92b409826f9f1508d1409d25e09014ac5b6;hb=0899e957c39a0d7157a809059afb08389f205d2d;hp=0ed6981f267cfc055fcc1609ab64f29a1abe20b5;hpb=7bf3d5cad03e650d50e45c15f58c9f1ef461a391;p=lyx.git diff --git a/src/Cursor.h b/src/Cursor.h index 0ed6981f26..d84db92b40 100644 --- a/src/Cursor.h +++ b/src/Cursor.h @@ -34,12 +34,59 @@ class Row; class InsetMathUnknown; class Encoding; +/** + * This class describes the position of a cursor within a document, + * but does not contain any detail about the view. It is currently + * only used to save cursor position in Undo, but culd be extended to + * handle the methods that only need this data. + **/ +class CursorData : public DocIterator +{ +public: + /// + CursorData(); + /// + explicit CursorData(Buffer * buffer); + /// + explicit CursorData(DocIterator const & dit); +protected: + /// the anchor position + DocIterator anchor_; + /// + mutable DispatchResult disp_; + /// do we have a selection? + bool selection_; + /// are we on the way to get one? + bool mark_; + /// are we in word-selection mode? This is set when double clicking. + bool word_selection_; + /// If true, we are behind the previous char, otherwise we are in front + // of the next char. This only make a difference when we are in front + // of a big inset spanning a whole row and computing coordinates for + // displaying the cursor. + bool logicalpos_; -/// The cursor class describes the position of a cursor within a document. +// FIXME: make them protected. +public: + /// the current font settings + Font current_font; + /// the current font + Font real_current_font; + +protected: -// The public inheritance should go in favour of a suitable data member -// (or maybe private inheritance) at some point of time. -class Cursor : public DocIterator + // + // math specific stuff that could be promoted to "global" later + // + /// do we allow autocorrection + bool autocorrect_; + /// are we entering a macro name? + bool macromode_; +}; + + +/// The cursor class describes the position of a cursor within a document. +class Cursor : public CursorData { public: /// create the cursor of a BufferView @@ -50,7 +97,7 @@ public: /// dispatch from innermost inset upwards void dispatch(FuncRequest const & cmd); /// get the resut of the last dispatch - DispatchResult result() const; + DispatchResult const & result() const; /// add a new cursor slice void push(Inset & inset); /// add a new cursor slice, place cursor at front (move backwards) @@ -63,9 +110,11 @@ public: bool popForward(); /// make sure we are outside of given inset void leaveInset(Inset const & inset); + /// set the cursor data + void setCursorData(CursorData const & data); /// sets cursor part void setCursor(DocIterator const & it); - /// sets the cursor to the anchor + /// sets the cursor to the normalized selection anchor void setCursorToAnchor(); /// @@ -84,6 +133,10 @@ public: /// do we have a multiline selection? bool selIsMultiLine() const { return selection_ && selBegin().pit() != selEnd().pit(); } + /// + void setWordSelection(bool set) { word_selection_ = set; } + /// + bool wordSelection() { return word_selection_; } /// did we place the anchor? bool mark() const { return mark_; } /// did we place the anchor? @@ -110,7 +163,7 @@ public: */ bool selHandle(bool selecting); /// - docstring selectionAsString(bool label) const; + docstring selectionAsString(bool with_label) const; /// docstring currentState() const; @@ -197,7 +250,11 @@ public: int textTargetOffset() const; /// access to normalized selection anchor - CursorSlice anchor() const; + CursorSlice normalAnchor() const; + // FIXME: this can't be a const & and a const function because + // LFUN_TAB_* wants to move the real anchor. + /// access to real selection anchor + DocIterator & realAnchor(); /// sets anchor to cursor position void resetAnchor(); /// access to owning BufferView @@ -220,11 +277,17 @@ public: * Right Thing (even if my getStatus partner said that I can do it). * It is sort of a kludge that should be used only rarely... */ - void undispatched(); + void undispatched() const; /// the event was already dispatched - void dispatched(); - /// Set which update should be done - void updateFlags(Update::flags f); + void dispatched() const; + /// Set which screen update should be done + void screenUpdateFlags(Update::flags f) const; + /// Forces an updateBuffer() call + void forceBufferUpdate() const; + /// Removes any pending updateBuffer() call + void clearBufferUpdate() const; + /// Do we need to call updateBuffer()? + bool needBufferUpdate() const; /** * don't call update() when done * @@ -233,12 +296,17 @@ public: * not need to be re-drawn and all entries in the coord cache stay * valid (and there are no other things to put in the coord cache). * This is a fairly rare event as well and only some optimization. - * Not using noUpdate() should never be wrong. + * Not using noScreenUpdate() should never be wrong. */ - void noUpdate(); + void noScreenUpdate() const; + /// + Update::flags screenUpdate() const { return disp_.screenUpdate(); } /// fix cursor in circumstances that should never happen. /// \retval true if a fix occured. bool fixIfBroken(); + /// Repopulate the slices insets from bottom to top. Useful + /// for stable iterators or Undo data. + void sanitize(); /// output friend std::ostream & operator<<(std::ostream & os, Cursor const & cur); @@ -269,7 +337,8 @@ public: void recordUndo(UndoKind kind = ATOMIC_UNDO) const; /// Convenience: prepare undo for the inset containing the cursor - void recordUndoInset(UndoKind kind = ATOMIC_UNDO) const; + void recordUndoInset(UndoKind kind = ATOMIC_UNDO, + Inset const * inset = 0) const; /// Convenience: prepare undo for the whole buffer void recordUndoFullDocument() const; @@ -280,19 +349,34 @@ public: /// void checkBufferStructure(); + /// hook for text input to maintain the "new born word" + void markNewWordPosition(); + + /// The position of the new born word + /// As the user is entering a word without leaving it + /// the result is not empty. When not in text mode + /// and after leaving the word the result is empty. + DocIterator newWord() const { return new_word_; } + public: - /// - BufferView * bv_; //private: - /// the anchor position - DocIterator anchor_; /// - DispatchResult disp_; + DocIterator const & beforeDispatchCursor() const { return beforeDispatchCursor_; } /// - DocIterator const & beforeDispatchCursor() { return beforeDispatchCursor_; } - + void saveBeforeDispatchPosXY(); + private: + /// validate the "new born word" position + void checkNewWordPosition(); + /// clear the "new born word" position + void clearNewWordPosition(); + +private: + /// + BufferView * bv_; + /// + mutable DispatchResult disp_; /** * The target x position of the cursor. This is used for when * we have text like : @@ -308,35 +392,13 @@ private: int x_target_; /// if a x_target cannot be hit exactly in a text, put the difference here int textTargetOffset_; - /// do we have a selection? - bool selection_; - /// are we on the way to get one? - bool mark_; - /// If true, we are behind the previous char, otherwise we are in front - // of the next char. This only make a difference when we are in front - // of a big inset spanning a whole row and computing coordinates for - // displaying the cursor. - bool logicalpos_; + /// the start of the new born word + DocIterator new_word_; /// position before dispatch started DocIterator beforeDispatchCursor_; - -// FIXME: make them private. -public: - /// the current font settings - Font current_font; - /// the current font - Font real_current_font; - -private: - - // - // math specific stuff that could be promoted to "global" later - // - /// do we allow autocorrection - bool autocorrect_; - /// are we entering a macro name? - bool macromode_; - + /// cursor screen coordinates before dispatch started + int beforeDispatchPosX_; + int beforeDispatchPosY_; /////////////////////////////////////////////////////////////////// // @@ -376,8 +438,9 @@ public: void plainInsert(MathAtom const & at); /// void niceInsert(MathAtom const & at); - /// - void niceInsert(docstring const & str, Parse::flags f = Parse::NORMAL); + /// return the number of inserted array items + int niceInsert(docstring const & str, Parse::flags f = Parse::NORMAL, + bool enter = true); /// in pixels from top of screen void setScreenPos(int x, int y);