src/Cursor.h

   1 // -*- C++ -*-
   2 /**
   3  * \file Cursor.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author André Pönitz
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 /*
  13 First some explanation about what a Cursor really is, from local to
  14 global.
  15
  16 * a CursorSlice indicates the position of the cursor at local level.
  17   It contains in particular:
  18   * idx(): the cell that contains the cursor (for Tabular or math
  19            arrays). Always 0 for 'plain' insets
  20   * pit(): the index of the current paragraph (only for text)
  21   * pos(): the position in the current paragraph (or in the math
  22            equation in mathed).
  23   * inset(): the inset in which the cursor is. For a InsetTabular,
  24     this is the tabular itself, not the cell inset (which is an
  25     InsetTableCell).
  26
  27 * a DocIterator indicated the position of the cursor in the document.
  28   It knows about the current buffer (buffer() method) and contains a
  29   vector of CursorSlices that describes the nesting of insets up to the
  30   point of interest. Note that operator<< has been implemented, so that
  31   one can send a DocIterator to a stream to see its value. Try it, it is
  32   very helpful to understand the cursor layout.
  33   * when using idx/pit/pos on a DocIterator, one gets the information
  34     from the inner slice (this slice can be accessed as top())
  35   * inMathed() returns true when the cursor is in a math formula
  36   * inTexted() returns true when the cursor is in text
  37   * innerTextSlice() returns the deepest slice that is text (useful
  38     when one is in a math equation and looks for the enclosing text)
  39
  40 * A CursorData is a descendant of Dociterator that contains
  41   * a second DocIterator object, the anchor, that is useful when
  42     selecting.
  43   * some other data that describes current selection, cursor font, etc.
  44
  45   This class is mostly used only for undo and contains the Cursor
  46   elements that are not GUI-related. In LyX 2.0, Cursor was directly
  47   deriving from DocIterator
  48
  49 * A Cursor is a descendant of CursorData that contains interesting
  50   display-related information, in particular targetX(), the horizontal
  51   position of the cursor in pixels.
  52 */
  53
  54 #ifndef LCURSOR_H
  55 #define LCURSOR_H
  56
  57 #include "DispatchResult.h"
  58 #include "DocIterator.h"
  59 #include "Font.h"
  60 #include "Undo.h"
  61
  62 #include "mathed/MathParser_flags.h"
  63
  64
  65 namespace lyx {
  66
  67 class Buffer;
  68 class BufferView;
  69 class FuncStatus;
  70 class FuncRequest;
  71 class Row;
  72
  73 // these should go
  74 class InsetMathUnknown;
  75
  76 /**
  77  * This class describes the position of a cursor within a document,
  78  * but does not contain any detail about the view. It is currently
  79  * only used to save cursor position in Undo, but culd be extended to
  80  * handle the methods that only need this data.
  81  **/
  82 class CursorData : public DocIterator
  83 {
  84 public:
  85         ///
  86         CursorData();
  87         ///
  88         explicit CursorData(Buffer * buffer);
  89         ///
  90         explicit CursorData(DocIterator const & dit);
  91         /// output
  92         friend std::ostream & operator<<(std::ostream & os, CursorData const & cur);
  93         friend LyXErr & operator<<(LyXErr & os, CursorData const & cur);
  94
  95 protected:
  96         /// the anchor position
  97         DocIterator anchor_;
  98         /// do we have a selection?
  99         bool selection_;
 100         /// are we on the way to get one?
 101         bool mark_;
 102         /// are we in word-selection mode? This is set when double clicking.
 103         bool word_selection_;
 104
 105 // FIXME: make them protected.
 106 public:
 107         /// the current font settings
 108         Font current_font;
 109         /// the current font
 110         Font real_current_font;
 111
 112 protected:
 113
 114         //
 115         // math specific stuff that could be promoted to "global" later
 116         //
 117         /// do we allow autocorrection
 118         bool autocorrect_;
 119         /// are we entering a macro name?
 120         bool macromode_;
 121 };
 122
 123
 124 /// The cursor class describes the position of a cursor within a document.
 125 class Cursor : public CursorData
 126 {
 127 public:
 128         /// create the cursor of a BufferView
 129         explicit Cursor(BufferView & bv);
 130
 131         /// returns true if we made a decision
 132         bool getStatus(FuncRequest const & cmd, FuncStatus & flag) const;
 133         /// dispatch from innermost inset upwards
 134         void dispatch(FuncRequest const & cmd);
 135         /// get the resut of the last dispatch
 136         DispatchResult const & result() const;
 137         /// add a new cursor slice
 138         void push(Inset & inset);
 139         /// add a new cursor slice, place cursor at front (move backwards)
 140         void pushBackward(Inset & inset);
 141         /// pop one level off the cursor
 142         void pop();
 143         /// pop one slice off the cursor stack and go backwards
 144         bool popBackward();
 145         /// pop one slice off the cursor stack and go forward
 146         bool popForward();
 147         /// make sure we are outside of given inset
 148         void leaveInset(Inset const & inset);
 149         /// set the cursor data
 150         void setCursorData(CursorData const & data);
 151         /// sets cursor part
 152         /// this (intentionally) does neither touch anchor nor selection status
 153         void setCursor(DocIterator const & it);
 154         /// set the cursor to dit normalised against the anchor, and set selection.
 155         void setCursorSelectionTo(DocIterator dit);
 156         /// sets the cursor to the normalized selection anchor
 157         void setCursorToAnchor();
 158
 159         ///
 160         void setCurrentFont();
 161
 162         //
 163         // selection
 164         //
 165         /// selection active?
 166         bool selection() const { return selection_; }
 167         /// set selection; this is lower level than (set|clear)Selection
 168         void selection(bool sel) { selection_ = sel; }
 169         /// do we have a multicell selection?
 170         bool selIsMultiCell() const
 171                 { return selection_ && selBegin().idx() != selEnd().idx(); }
 172         /// do we have a multiline selection?
 173         bool selIsMultiLine() const
 174                 { return selection_ && selBegin().pit() != selEnd().pit(); }
 175         ///
 176         void setWordSelection(bool set) { word_selection_ = set; }
 177         ///
 178         bool wordSelection() { return word_selection_; }
 179         /// did we place the anchor?
 180         bool mark() const { return mark_; }
 181         /// did we place the anchor?
 182         void setMark(bool mark) { mark_ = mark; }
 183         ///
 184         void setSelection();
 185         /// set selection at given position
 186         void setSelection(DocIterator const & where, int n);
 187         ///
 188         void clearSelection();
 189         /// access start of selection
 190         CursorSlice selBegin() const;
 191         /// access end of selection
 192         CursorSlice selEnd() const;
 193         /// access start of selection
 194         DocIterator selectionBegin() const;
 195         /// access end of selection
 196         DocIterator selectionEnd() const;
 197         /**
 198          * Update the selection status and save permanent
 199          * selection if needed.
 200          * @param selecting the new selection status
 201          * @return whether the selection status has changed
 202          */
 203         bool selHandle(bool selecting);
 204         ///
 205         docstring selectionAsString(bool with_label) const;
 206         ///
 207         docstring currentState(bool devel_mode) const;
 208
 209         /// auto-correct mode
 210         bool autocorrect() const { return autocorrect_; }
 211         /// auto-correct mode
 212         bool & autocorrect() { return autocorrect_; }
 213         /// are we entering a macro name?
 214         bool macromode() const { return macromode_; }
 215         /// are we entering a macro name?
 216         bool & macromode() { return macromode_; }
 217
 218         /// returns x,y position
 219         void getPos(int & x, int & y) const;
 220         /// return logical positions between which the cursor is situated
 221         /**
 222          * If the cursor is at the edge of a row, the position which is "over the
 223          * edge" will be returned as -1.
 224          */
 225         void getSurroundingPos(pos_type & left_pos, pos_type & right_pos) const;
 226         /// the row in the paragraph we're in
 227         Row const & textRow() const;
 228
 229         //
 230         // common part
 231         //
 232         /// move visually one step to the right
 233         /**
 234          * @note: This method may move into an inset unless skip_inset == true.
 235          * @note: This method may move into a new paragraph.
 236          * @note: This method may move out of the current slice.
 237          * @return: true if moved, false if not moved
 238          */
 239         bool posVisRight(bool skip_inset = false);
 240         /// move visually one step to the left
 241         /**
 242          * @note: This method may move into an inset unless skip_inset == true.
 243          * @note: This method may move into a new paragraph.
 244          * @note: This method may move out of the current slice.
 245          * @return: true if moved, false if not moved
 246          */
 247         bool posVisLeft(bool skip_inset = false);
 248         /// move visually to next/previous row
 249         /**
 250          * Assuming we were to keep moving left (right) from the current cursor
 251          * position, place the cursor at the rightmost (leftmost) edge of the
 252          * new row to which we would move according to visual-mode cursor movement.
 253          * This could be either the next or the previous row, depending on the
 254          * direction in which we're moving, and whether we're in an LTR or RTL
 255          * paragraph.
 256          * @note: The new position may even be in a new paragraph.
 257          * @note: This method will not move out of the current slice.
 258          * @return: false if not moved (no more rows to move to in given direction)
 259          * @return: true if moved
 260          */
 261         bool posVisToNewRow(bool movingLeft);
 262         /// move to right or left extremity of the current row
 263         void posVisToRowExtremity(bool left);
 264         /// Should interpretation of the arrow keys be reversed?
 265         bool reverseDirectionNeeded() const;
 266
 267         /// insert an inset
 268         void insert(Inset *);
 269         /// insert a single char
 270         void insert(char_type c);
 271         /// insert a string
 272         void insert(docstring const & str);
 273
 274         /// FIXME: rename to something sensible showing difference to x_target()
 275         /// in pixels from left of screen, set to current position if unset
 276         int targetX() const;
 277         /// set the targetX to x
 278         void setTargetX(int x);
 279         /// return targetX or -1 if unset
 280         int x_target() const;
 281         /// set targetX to current position
 282         void setTargetX();
 283         /// clear targetX, i.e. set it to -1
 284         void clearTargetX();
 285         /// set offset to actual position - targetX
 286         void updateTextTargetOffset();
 287         /// distance between actual and targeted position during last up/down in text
 288         int textTargetOffset() const;
 289
 290         /// access to normalized selection anchor
 291         CursorSlice normalAnchor() const;
 292         /// access to real selection anchor
 293         DocIterator const & realAnchor() const { return anchor_; }
 294         DocIterator & realAnchor() { return anchor_; }
 295         /// sets anchor to cursor position
 296         void resetAnchor();
 297         /// access to owning BufferView
 298         BufferView & bv() const;
 299         /// get some interesting description of top position
 300         void info(odocstream & os, bool devel_mode) const;
 301         /// are we in math mode (2), text mode (1) or unsure (0)?
 302         int currentMode();
 303         /// reset cursor bottom to the beginning of the top inset
 304         // (sort of 'chroot' environment...)
 305         void reset();
 306         /// for spellchecking
 307         void replaceWord(std::string const & replacestring);
 308         /**
 309          * the event was not (yet) dispatched.
 310          *
 311          * Should only be called by an inset's doDispatch() method. It means:
 312          * I, the doDispatch() method of InsetFoo, hereby declare that I am
 313          * not able to handle that request and trust my parent will do the
 314          * Right Thing (even if my getStatus partner said that I can do it).
 315          * It is sort of a kludge that should be used only rarely...
 316          */
 317         void undispatched() const;
 318         /// the event was already dispatched
 319         void dispatched() const;
 320         /// Set which screen update should be done
 321         void screenUpdateFlags(Update::flags f) const;
 322         /// Forces an updateBuffer() call
 323         void forceBufferUpdate() const;
 324         /// Removes any pending updateBuffer() call
 325         void clearBufferUpdate() const;
 326         /// Do we need to call updateBuffer()?
 327         bool needBufferUpdate() const;
 328         /**
 329          * don't call update() when done
 330          *
 331          * Should only be called by an inset's doDispatch() method. It means:
 332          * I handled that request and I can reassure you that the screen does
 333          * not need to be re-drawn and all entries in the coord cache stay
 334          * valid (and there are no other things to put in the coord cache).
 335          * This is a fairly rare event as well and only some optimization.
 336          * Not using noScreenUpdate() should never be wrong.
 337          */
 338         void noScreenUpdate() const;
 339         /// fix cursor in circumstances that should never happen.
 340         /// \retval true if a fix occurred.
 341         bool fixIfBroken();
 342         /// Repopulate the slices insets from bottom to top. Useful
 343         /// for stable iterators or Undo data.
 344         void sanitize();
 345
 346         ///
 347         bool textUndo();
 348         ///
 349         bool textRedo();
 350
 351         /// makes sure the next operation will be stored
 352         void finishUndo() const;
 353
 354         /// open a new group of undo operations. Groups can be nested.
 355         void beginUndoGroup() const;
 356
 357         /// end the current undo group
 358         void endUndoGroup() const;
 359
 360         /// The general case: prepare undo for an arbitrary range.
 361         void recordUndo(pit_type from, pit_type to) const;
 362
 363         /// Convenience: prepare undo for the range between 'from' and cursor.
 364         void recordUndo(pit_type from) const;
 365
 366         /// Convenience: prepare undo for the single paragraph or cell
 367         /// containing the cursor
 368         void recordUndo(UndoKind kind = ATOMIC_UNDO) const;
 369
 370         /// Convenience: prepare undo for the inset containing the cursor
 371         void recordUndoInset(Inset const * inset = 0) const;
 372
 373         /// Convenience: prepare undo for the whole buffer
 374         void recordUndoFullBuffer() const;
 375
 376         /// Convenience: prepare undo for buffer parameters
 377         void recordUndoBufferParams() const;
 378
 379         /// Convenience: prepare undo for the selected paragraphs or cells
 380         void recordUndoSelection() const;
 381
 382         ///
 383         void checkBufferStructure();
 384
 385         /// hook for text input to maintain the "new born word"
 386         void markNewWordPosition();
 387
 388         /// The position of the new born word
 389         /// As the user is entering a word without leaving it
 390         /// the result is not empty. When not in text mode
 391         /// and after leaving the word the result is empty.
 392         DocIterator newWord() const { return new_word_; }
 393
 394         /// Return true if the next or previous inset has confirmDeletion depending
 395         /// on the boolean before. If there is a selection, return true if at least
 396         /// one inset in the selection has confirmDeletion.
 397         bool confirmDeletion(bool before = false) const;
 398
 399         /// Determine if x falls to the left or to the side of the middle of the
 400         /// inset, and advance the cursor to match this position. If edit is true,
 401         /// keep the cursor in front of the inset if it matter for dialogs.
 402         /// Note: it does not handle RTL text yet, and is only used in math for now.
 403         void moveToClosestEdge(int x, bool edit = false);
 404
 405 public:
 406 //private:
 407
 408         ///
 409         DocIterator const & beforeDispatchCursor() const { return beforeDispatchCursor_; }
 410         ///
 411         void saveBeforeDispatchPosXY();
 412
 413 private:
 414         /// validate the "new born word" position
 415         void checkNewWordPosition();
 416         /// clear the "new born word" position
 417         void clearNewWordPosition();
 418
 419 private:
 420         ///
 421         BufferView * bv_;
 422         ///
 423         mutable DispatchResult disp_;
 424         /**
 425          * The target x position of the cursor. This is used for when
 426          * we have text like :
 427          *
 428          * blah blah blah blah| blah blah blah
 429          * blah blah blah
 430          * blah blah blah blah blah blah
 431          *
 432          * When we move onto row 3, we would like to be vertically aligned
 433          * with where we were in row 1, despite the fact that row 2 is
 434          * shorter than x()
 435          */
 436         int x_target_;
 437         /// if a x_target cannot be hit exactly in a text, put the difference here
 438         int textTargetOffset_;
 439         /// the start of the new born word
 440         DocIterator new_word_;
 441         /// position before dispatch started
 442         DocIterator beforeDispatchCursor_;
 443         /// cursor screen coordinates before dispatch started
 444         int beforeDispatchPosX_;
 445         int beforeDispatchPosY_;
 446
 447 ///////////////////////////////////////////////////////////////////
 448 //
 449 // The part below is the non-integrated rest of the original math
 450 // cursor. This should be either generalized for texted or moved
 451 // back to the math insets.
 452 //
 453 ///////////////////////////////////////////////////////////////////
 454
 455 public:
 456         ///
 457         void insert(MathAtom const &);
 458         ///
 459         void insert(MathData const &);
 460         /// return false for empty math insets
 461         /// Use force to skip the confirmDeletion check.
 462         bool erase(bool force = false);
 463         bool backspace(bool force = false);
 464
 465         /// move the cursor up by sending an internal LFUN_UP
 466         /// return true if fullscreen update is needed
 467         bool up();
 468         /// move the cursor up by sending an internal LFUN_DOWN,
 469         /// return true if fullscreen update is needed
 470         bool down();
 471         /// whether the cursor is either at the first or last row
 472         bool atFirstOrLastRow(bool up);
 473         /// move up/down in a text inset, called for LFUN_UP/DOWN,
 474         /// return true if successful, updateNeeded set to true if fullscreen
 475         /// update is needed, otherwise it's not touched
 476         bool upDownInText(bool up, bool & updateNeeded);
 477         /// move up/down in math or any non text inset, call for LFUN_UP/DOWN
 478         /// return true if successful
 479         bool upDownInMath(bool up);
 480         ///
 481         InsetMath & nextMath();
 482         ///
 483         InsetMath & prevMath();
 484         /// move forward in math. word: whether to skip a whole "word" (insets with
 485         /// the same mathclass)
 486         bool mathForward(bool word);
 487         ///
 488         bool mathBackward(bool word);
 489         ///
 490         void plainErase();
 491         ///
 492         void plainInsert(MathAtom const & at);
 493         ///
 494         void niceInsert(MathAtom const & at);
 495         /// return the number of inserted array items
 496         int niceInsert(docstring const & str, Parse::flags f = Parse::NORMAL,
 497                         bool enter = true);
 498
 499         /// in pixels from top of screen
 500         void setScreenPos(int x, int y);
 501         /// current offset in the top cell
 502
 503         /// interpret name of a macro or ditch it if \c cancel is true.
 504         /// Returns true if something got inserted.
 505         bool macroModeClose(bool cancel = false);
 506         /// are we currently typing the name of a macro?
 507         bool inMacroMode() const;
 508         /// get access to the macro we are currently typing
 509         InsetMathUnknown * activeMacro();
 510         /// get access to the macro we are currently typing
 511         InsetMathUnknown const * activeMacro() const;
 512
 513         /// replace selected stuff with at, placing the former
 514         // selection in given cell of atom
 515         void handleNest(MathAtom const & at, int cell = 0);
 516         ///
 517         bool isInside(Inset const *) const;
 518
 519         /// make sure cursor position is valid
 520         /// FIXME: It does a subset of fixIfBroken. Maybe merge them?
 521         void normalize();
 522         /// mark current cursor trace for redraw
 523         void touch();
 524
 525         /// hack for reveal codes
 526         void markInsert();
 527         void markErase();
 528         /// injects content of a cell into parent
 529         void pullArg();
 530         /// split font inset etc
 531         void handleFont(std::string const & font);
 532
 533         /// display a message
 534         void message(docstring const & msg) const;
 535         /// display an error message
 536         void errorMessage(docstring const & msg) const;
 537         ///
 538         docstring getPossibleLabel() const;
 539
 540         /// the name of the macro we are currently inputting
 541         docstring macroName();
 542         /// where in the curent cell does the macro name start?
 543         int macroNamePos();
 544         /// can we enter the inset?
 545         bool openable(MathAtom const &) const;
 546         /// font at cursor position
 547         Font getFont() const;
 548 };
 549
 550
 551 /**
 552  * Notifies all insets which appear in \c old, but not in \c cur. And then
 553  * notify all insets which appear in \c cur, but not in \c old.
 554  * \returns true if cursor is now invalid, e.g. if some insets in
 555  *   higher cursor slices of \c old do not exist anymore. In this case
 556  *   it may be necessary to use Use Cursor::fixIfBroken.
 557  */
 558 bool notifyCursorLeavesOrEnters(Cursor const & old, Cursor & cur);
 559
 560
 561 } // namespace lyx
 562
 563 #endif // LYXLCURSOR_H