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