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