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