X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FCursor.h;h=1da9dbd17c606f6fa822c4d7eb57a9c237ff168c;hb=c7d29be153debac82e3d2e8865fcc849f0a5f40d;hp=7f4201ad8581415b4709018df48f351f9e7b57d0;hpb=b3128dc63b2c3ae44736da5427a9469932ac522e;p=lyx.git diff --git a/src/Cursor.h b/src/Cursor.h index 7f4201ad85..1da9dbd17c 100644 --- a/src/Cursor.h +++ b/src/Cursor.h @@ -9,6 +9,48 @@ * Full author contact details are available in file CREDITS. */ +/* +First some explanation about what a Cursor really is, from local to +global. + +* 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 text) + * pos(): the position in the current paragraph (or in the math + equation in mathed). + * inset(): the inset in which the cursor is. For a InsetTabular, + this is the tabular itself, not the cell inset (which is an + InsetTableCell). + +* 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 descendant of Dociterator that contains + * a second DocIterator object, the anchor, that is useful when + selecting. + * some other data that describes current selection, cursor font, etc. + + This class is mostly used only for undo and contains the Cursor + elements 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. +*/ + #ifndef LCURSOR_H #define LCURSOR_H @@ -19,8 +61,6 @@ #include "mathed/MathParser_flags.h" -#include - namespace lyx { @@ -32,14 +72,57 @@ class Row; // these should go 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); + +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_; + +// 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. -// 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 +/// 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 +133,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 +146,14 @@ 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 + /// this (intentionally) does neither touch anchor nor selection status void setCursor(DocIterator const & it); - /// sets the cursor to the anchor + /// set the cursor to dit normalised against the anchor, and set selection. + void setCursorSelectionTo(DocIterator dit); + /// sets the cursor to the normalized selection anchor void setCursorToAnchor(); /// @@ -76,15 +164,15 @@ public: // /// selection active? bool selection() const { return selection_; } - /// set selection; - void setSelection(bool sel) { selection_ = sel; } + /// set selection; this is lower level than (set|clear)Selection + void selection(bool sel) { selection_ = sel; } /// do we have a multicell selection? - bool selIsMultiCell() const + bool selIsMultiCell() const { return selection_ && selBegin().idx() != selEnd().idx(); } /// do we have a multiline selection? - bool selIsMultiLine() const + bool selIsMultiLine() const { return selection_ && selBegin().pit() != selEnd().pit(); } - /// + /// void setWordSelection(bool set) { word_selection_ = set; } /// bool wordSelection() { return word_selection_; } @@ -98,13 +186,19 @@ public: void setSelection(DocIterator const & where, int n); /// void clearSelection(); + /// check whether selection contains specific type of inset + /// returns 0 if no selection was made + bool insetInSelection(InsetCode const & inset); + /// count occurences of specific inset type in the selection + /// returns 0 if no selection was made + int countInsetsInSelection(InsetCode const & inset); /// access start of selection CursorSlice selBegin() const; /// access end of selection 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 @@ -114,9 +208,9 @@ public: */ bool selHandle(bool selecting); /// - docstring selectionAsString(bool label) const; + docstring selectionAsString(bool with_label) const; /// - docstring currentState() const; + docstring currentState(bool devel_mode) const; /// auto-correct mode bool autocorrect() const { return autocorrect_; } @@ -126,24 +220,21 @@ public: bool macromode() const { return macromode_; } /// are we entering a macro name? bool & macromode() { return macromode_; } + /// returns x,y position void getPos(int & x, int & y) const; /// return logical positions between which the cursor is situated /** - * If the cursor is at the edge of a row, the position which is "over the + * 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; // // common part // - /// move one step backwards - bool posBackward(); - /// move one step forward - bool posForward(); /// move visually one step to the right /** * @note: This method may move into an inset unless skip_inset == true. @@ -163,11 +254,11 @@ public: /// move visually to next/previous row /** * Assuming we were to keep moving left (right) from the current cursor - * position, place the cursor at the rightmost (leftmost) edge of the + * position, place the cursor at the rightmost (leftmost) edge of the * new row to which we would move according to visual-mode cursor movement. * This could be either the next or the previous row, depending on the - * direction in which we're moving, and whether we're in an LTR or RTL - * paragraph. + * direction in which we're moving, and whether we're in an LTR or RTL + * paragraph. * @note: The new position may even be in a new paragraph. * @note: This method will not move out of the current slice. * @return: false if not moved (no more rows to move to in given direction) @@ -176,6 +267,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 *); @@ -201,13 +294,16 @@ public: int textTargetOffset() const; /// access to normalized selection anchor - CursorSlice anchor() const; + CursorSlice normalAnchor() const; + /// access to real selection anchor + DocIterator const & realAnchor() const { return anchor_; } + DocIterator & realAnchor() { return anchor_; } /// sets anchor to cursor position void resetAnchor(); /// access to owning BufferView BufferView & bv() const; /// get some interesting description of top position - void info(odocstream & os) const; + void info(odocstream & os, bool devel_mode) const; /// are we in math mode (2), text mode (1) or unsure (0)? int currentMode(); /// reset cursor bottom to the beginning of the top inset @@ -224,11 +320,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 * @@ -237,16 +339,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(); @@ -263,20 +364,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; @@ -284,19 +388,45 @@ 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_; } + + /// Return true if the next or previous inset has confirmDeletion depending + /// on the boolean before. If there is a selection, return true if at least + /// one inset in the selection has confirmDeletion. + bool confirmDeletion(bool before = false) const; + + /// Determine if x falls to the left or to the side of the middle of the + /// inset, and advance the cursor to match this position. If edit is true, + /// keep the cursor in front of the inset if it matter for dialogs. + /// Note: it does not handle RTL text yet, and is only used in math for now. + void moveToClosestEdge(int x, bool edit = false); + 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 : @@ -312,37 +442,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_; - /// 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 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_; /////////////////////////////////////////////////////////////////// // @@ -358,9 +464,10 @@ public: /// void insert(MathData const &); /// return false for empty math insets - bool erase(); - /// return false for empty math insets - bool backspace(); + /// Use force to skip the confirmDeletion check. + bool erase(bool force = false); + bool backspace(bool force = false); + /// move the cursor up by sending an internal LFUN_UP /// return true if fullscreen update is needed bool up(); @@ -377,22 +484,31 @@ public: /// return true if successful bool upDownInMath(bool up); /// + InsetMath & nextMath(); + /// + InsetMath & prevMath(); + /// move forward in math. word: whether to skip a whole "word" (insets with + /// the same mathclass) + bool mathForward(bool word); + /// + bool mathBackward(bool word); + /// void plainErase(); /// 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); /// current offset in the top cell - /// interpret name a name of a macro. Returns true if - /// something got inserted. - bool macroModeClose(); + /// interpret name of a macro or ditch it if \c cancel is true. + /// Returns true if something got inserted. + bool macroModeClose(bool cancel = false); /// are we currently typing the name of a macro? bool inMacroMode() const; /// get access to the macro we are currently typing @@ -433,18 +549,17 @@ public: int macroNamePos(); /// can we enter the inset? bool openable(MathAtom const &) const; - /// - Encoding const * getEncoding() const; /// font at cursor position Font getFont() const; }; /** - * 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);