X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FCursor.h;h=a0f5ec14bf14f4ac434163f7690f6e264bbe17b6;hb=3628ceec480c3d8fa9673f80f781eb1153fb9e1f;hp=81b2d9b97e472df9ba9c64c6b3f72127947ef2e6;hpb=326a035a5bd04376bbcf585e60437d299b2b96cf;p=lyx.git diff --git a/src/Cursor.h b/src/Cursor.h index 81b2d9b97e..a0f5ec14bf 100644 --- a/src/Cursor.h +++ b/src/Cursor.h @@ -9,6 +9,47 @@ * Full author contact details are available in file CREDITS. */ +/* +First some explanation about what a Cursor really is. I try to go from +more local to general. + +* a CursorSlice indicates the position of the cursor at local level. +It contains in particular: + * idx(): the cell that contains the cursor (for Tabular or math + arrays). Always 0 for 'plain' insets + * pit(): the index of the current paragraph (only for Texted) + * pos(): the position in the current paragraph (or in the math + equation in Mathed). + * inset(): the inset in which the cursor is. + +* a DocIterator indicated the position of the cursor in the document. + It knows about the current buffer (buffer() method) and contains a + vector of CursorSlices that describes the nesting of insets up to the + point of interest. Note that operator<< has been implemented, so that + one can send a DocIterator to a stream to see its value. Try it, it is + very helpful to understand the cursor layout. + * when using idx/pit/pos on a DocIterator, one gets the information + from the inner slice (this slice can be accessed as top()) + * inMathed() returns true when the cursor is in a math formula + * inTexted() returns true when the cursor is in text + * innerTextSlice() returns the deepest slice that is text (useful + when one is in a math equation and looks for the enclosing text) + +* A CursorData is a descendent of Dociterator that contains + * a second DocIterator object, the anchor, that is useful when + selecting. + * some other data not interesting here +This class is used only for undo and contains the Cursor element that +are not GUI-related. In LyX 2.0, Cursor was directly deriving from +DocIterator + +* A Cursor is a descendant of CursorData that contains interesting + display-related information, in particular targetX(), the horizontal + position of the cursor in pixels. + * one interesting method for what you want to do is textRow(), that + returns the inner Row object that contains the cursor +*/ + #ifndef LCURSOR_H #define LCURSOR_H @@ -19,8 +60,6 @@ #include "mathed/MathParser_flags.h" -#include - namespace lyx { @@ -34,21 +73,72 @@ 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); + /// output + friend std::ostream & operator<<(std::ostream & os, CursorData const & cur); + friend LyXErr & operator<<(LyXErr & os, CursorData const & cur); -/// The cursor class describes the position of a cursor within a document. +protected: + /// the anchor position + DocIterator anchor_; + /// 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 public inheritance should go in favour of a suitable data member -// (or maybe private inheritance) at some point of time. -class Cursor : public DocIterator +// FIXME: make them protected. +public: + /// the current font settings + Font current_font; + /// the current font + Font real_current_font; + +protected: + + // + // 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 explicit Cursor(BufferView & bv); + /// returns true if we made a decision + bool getStatus(FuncRequest const & cmd, FuncStatus & flag) const; /// 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) @@ -61,9 +151,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(); /// @@ -82,6 +174,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? @@ -98,7 +194,7 @@ public: CursorSlice selEnd() const; /// access start of selection DocIterator selectionBegin() const; - /// access start of selection + /// access end of selection DocIterator selectionEnd() const; /** * Update the selection status and save permanent @@ -108,7 +204,7 @@ public: */ bool selHandle(bool selecting); /// - docstring selectionAsString(bool label) const; + docstring selectionAsString(bool with_label) const; /// docstring currentState() const; @@ -120,6 +216,9 @@ public: bool macromode() const { return macromode_; } /// are we entering a macro name? bool & macromode() { return macromode_; } + + /// returns true when all insets in cursor stack are in cache + bool inCoordCache() const; /// returns x,y position void getPos(int & x, int & y) const; /// return logical positions between which the cursor is situated @@ -127,7 +226,7 @@ public: * If the cursor is at the edge of a row, the position which is "over the * edge" will be returned as -1. */ - void getSurroundingPos(pos_type & left_pos, pos_type & right_pos); + void getSurroundingPos(pos_type & left_pos, pos_type & right_pos) const; /// the row in the paragraph we're in Row const & textRow() const; @@ -170,6 +269,8 @@ public: bool posVisToNewRow(bool movingLeft); /// move to right or left extremity of the current row void posVisToRowExtremity(bool left); + /// Should interpretation of the arrow keys be reversed? + bool reverseDirectionNeeded() const; /// insert an inset void insert(Inset *); @@ -195,7 +296,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 @@ -204,9 +309,9 @@ public: void info(odocstream & os) const; /// are we in math mode (2), text mode (1) or unsure (0)? int currentMode(); - /// reset cursor bottom to the beginning of the given inset + /// reset cursor bottom to the beginning of the top inset // (sort of 'chroot' environment...) - void reset(Inset &); + void reset(); /// for spellchecking void replaceWord(std::string const & replacestring); /** @@ -218,11 +323,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 * @@ -231,16 +342,15 @@ 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; /// fix cursor in circumstances that should never happen. - /// \retval true if a fix occured. + /// \retval true if a fix occurred. bool fixIfBroken(); - - /// output - friend std::ostream & operator<<(std::ostream & os, Cursor const & cur); - friend LyXErr & operator<<(LyXErr & os, Cursor const & cur); + /// Repopulate the slices insets from bottom to top. Useful + /// for stable iterators or Undo data. + void sanitize(); /// bool textUndo(); @@ -257,20 +367,23 @@ public: void endUndoGroup() const; /// The general case: prepare undo for an arbitrary range. - void recordUndo(UndoKind kind, pit_type from, pit_type to) const; + void recordUndo(pit_type from, pit_type to) const; /// Convenience: prepare undo for the range between 'from' and cursor. - void recordUndo(UndoKind kind, pit_type from) const; + void recordUndo(pit_type from) const; /// Convenience: prepare undo for the single paragraph or cell /// containing the cursor 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(Inset const * inset = 0) const; /// Convenience: prepare undo for the whole buffer - void recordUndoFullDocument() const; + void recordUndoFullBuffer() const; + + /// Convenience: prepare undo for buffer parameters + void recordUndoBufferParams() const; /// Convenience: prepare undo for the selected paragraphs or cells void recordUndoSelection() const; @@ -278,19 +391,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 : @@ -306,35 +434,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_; /////////////////////////////////////////////////////////////////// // @@ -374,8 +480,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); @@ -432,10 +539,11 @@ public: /** - * Notifies all insets which appear in old, but not in cur. And then - * notify all insets which appear in cur, but not in old. - * Make sure that the cursor old is valid, i.e. all inset pointers - * point to valid insets! Use Cursor::fixIfBroken if necessary. + * Notifies all insets which appear in \c old, but not in \c cur. And then + * notify all insets which appear in \c cur, but not in \c old. + * \returns true if cursor is now invalid, e.g. if some insets in + * higher cursor slices of \c old do not exist anymore. In this case + * it may be necessary to use Use Cursor::fixIfBroken. */ bool notifyCursorLeavesOrEnters(Cursor const & old, Cursor & cur);