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