4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
9 * Full author contact details are available in file CREDITS.
13 First some explanation about what a Cursor really is. I try to go from
14 more local to general.
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 Texted)
21 * pos(): the position in the current paragraph (or in the math
23 * inset(): the inset in which the cursor is.
25 * a DocIterator indicated the position of the cursor in the document.
26 It knows about the current buffer (buffer() method) and contains a
27 vector of CursorSlices that describes the nesting of insets up to the
28 point of interest. Note that operator<< has been implemented, so that
29 one can send a DocIterator to a stream to see its value. Try it, it is
30 very helpful to understand the cursor layout.
31 * when using idx/pit/pos on a DocIterator, one gets the information
32 from the inner slice (this slice can be accessed as top())
33 * inMathed() returns true when the cursor is in a math formula
34 * inTexted() returns true when the cursor is in text
35 * innerTextSlice() returns the deepest slice that is text (useful
36 when one is in a math equation and looks for the enclosing text)
38 * A CursorData is a descendent of Dociterator that contains
39 * a second DocIterator object, the anchor, that is useful when
41 * some other data not interesting here
42 This class is used only for undo and contains the Cursor element that
43 are not GUI-related. In LyX 2.0, Cursor was directly deriving from
46 * A Cursor is a descendant of CursorData that contains interesting
47 display-related information, in particular targetX(), the horizontal
48 position of the cursor in pixels.
49 * one interesting method for what you want to do is textRow(), that
50 returns the inner Row object that contains the cursor
56 #include "DispatchResult.h"
57 #include "DocIterator.h"
61 #include "mathed/MathParser_flags.h"
73 class InsetMathUnknown;
77 * This class describes the position of a cursor within a document,
78 * but does not contain any detail about the view. It is currently
79 * only used to save cursor position in Undo, but culd be extended to
80 * handle the methods that only need this data.
82 class CursorData : public DocIterator
88 explicit CursorData(Buffer * buffer);
90 explicit CursorData(DocIterator const & dit);
92 friend std::ostream & operator<<(std::ostream & os, CursorData const & cur);
93 friend LyXErr & operator<<(LyXErr & os, CursorData const & cur);
96 /// the anchor position
99 mutable DispatchResult disp_;
100 /// do we have a selection?
102 /// are we on the way to get one?
104 /// are we in word-selection mode? This is set when double clicking.
105 bool word_selection_;
106 /// If true, we are behind the previous char, otherwise we are in front
107 // of the next char. This only make a difference when we are in front
108 // of a big inset spanning a whole row and computing coordinates for
109 // displaying the cursor.
112 // FIXME: make them protected.
114 /// the current font settings
117 Font real_current_font;
122 // math specific stuff that could be promoted to "global" later
124 /// do we allow autocorrection
126 /// are we entering a macro name?
131 /// The cursor class describes the position of a cursor within a document.
132 class Cursor : public CursorData
135 /// create the cursor of a BufferView
136 explicit Cursor(BufferView & bv);
138 /// returns true if we made a decision
139 bool getStatus(FuncRequest const & cmd, FuncStatus & flag) const;
140 /// dispatch from innermost inset upwards
141 void dispatch(FuncRequest const & cmd);
142 /// get the resut of the last dispatch
143 DispatchResult const & result() const;
144 /// add a new cursor slice
145 void push(Inset & inset);
146 /// add a new cursor slice, place cursor at front (move backwards)
147 void pushBackward(Inset & inset);
148 /// pop one level off the cursor
150 /// pop one slice off the cursor stack and go backwards
152 /// pop one slice off the cursor stack and go forward
154 /// make sure we are outside of given inset
155 void leaveInset(Inset const & inset);
156 /// set the cursor data
157 void setCursorData(CursorData const & data);
159 void setCursor(DocIterator const & it);
160 /// sets the cursor to the normalized selection anchor
161 void setCursorToAnchor();
164 void setCurrentFont();
169 /// selection active?
170 bool selection() const { return selection_; }
172 void setSelection(bool sel) { selection_ = sel; }
173 /// do we have a multicell selection?
174 bool selIsMultiCell() const
175 { return selection_ && selBegin().idx() != selEnd().idx(); }
176 /// do we have a multiline selection?
177 bool selIsMultiLine() const
178 { return selection_ && selBegin().pit() != selEnd().pit(); }
180 void setWordSelection(bool set) { word_selection_ = set; }
182 bool wordSelection() { return word_selection_; }
183 /// did we place the anchor?
184 bool mark() const { return mark_; }
185 /// did we place the anchor?
186 void setMark(bool mark) { mark_ = mark; }
189 /// set selection at given position
190 void setSelection(DocIterator const & where, int n);
192 void clearSelection();
193 /// access start of selection
194 CursorSlice selBegin() const;
195 /// access end of selection
196 CursorSlice selEnd() const;
197 /// access start of selection
198 DocIterator selectionBegin() const;
199 /// access end of selection
200 DocIterator selectionEnd() const;
202 * Update the selection status and save permanent
203 * selection if needed.
204 * @param selecting the new selection status
205 * @return whether the selection status has changed
207 bool selHandle(bool selecting);
209 docstring selectionAsString(bool with_label) const;
211 docstring currentState() const;
213 /// auto-correct mode
214 bool autocorrect() const { return autocorrect_; }
215 /// auto-correct mode
216 bool & autocorrect() { return autocorrect_; }
217 /// are we entering a macro name?
218 bool macromode() const { return macromode_; }
219 /// are we entering a macro name?
220 bool & macromode() { return macromode_; }
221 /// returns x,y position
222 void getPos(int & x, int & y) const;
223 /// return logical positions between which the cursor is situated
225 * If the cursor is at the edge of a row, the position which is "over the
226 * edge" will be returned as -1.
228 void getSurroundingPos(pos_type & left_pos, pos_type & right_pos);
229 /// the row in the paragraph we're in
230 Row const & textRow() const;
235 /// move one step backwards
237 /// move one step forward
239 /// move visually one step to the right
241 * @note: This method may move into an inset unless skip_inset == true.
242 * @note: This method may move into a new paragraph.
243 * @note: This method may move out of the current slice.
244 * @return: true if moved, false if not moved
246 bool posVisRight(bool skip_inset = false);
247 /// move visually one step to the left
249 * @note: This method may move into an inset unless skip_inset == true.
250 * @note: This method may move into a new paragraph.
251 * @note: This method may move out of the current slice.
252 * @return: true if moved, false if not moved
254 bool posVisLeft(bool skip_inset = false);
255 /// move visually to next/previous row
257 * Assuming we were to keep moving left (right) from the current cursor
258 * position, place the cursor at the rightmost (leftmost) edge of the
259 * new row to which we would move according to visual-mode cursor movement.
260 * This could be either the next or the previous row, depending on the
261 * direction in which we're moving, and whether we're in an LTR or RTL
263 * @note: The new position may even be in a new paragraph.
264 * @note: This method will not move out of the current slice.
265 * @return: false if not moved (no more rows to move to in given direction)
266 * @return: true if moved
268 bool posVisToNewRow(bool movingLeft);
269 /// move to right or left extremity of the current row
270 void posVisToRowExtremity(bool left);
271 /// Should interpretation of the arrow keys be reversed?
272 bool reverseDirectionNeeded() const;
275 void insert(Inset *);
276 /// insert a single char
277 void insert(char_type c);
279 void insert(docstring const & str);
281 /// FIXME: rename to something sensible showing difference to x_target()
282 /// in pixels from left of screen, set to current position if unset
284 /// set the targetX to x
285 void setTargetX(int x);
286 /// return targetX or -1 if unset
287 int x_target() const;
288 /// set targetX to current position
290 /// clear targetX, i.e. set it to -1
292 /// set offset to actual position - targetX
293 void updateTextTargetOffset();
294 /// distance between actual and targeted position during last up/down in text
295 int textTargetOffset() const;
297 /// access to normalized selection anchor
298 CursorSlice normalAnchor() const;
299 // FIXME: this can't be a const & and a const function because
300 // LFUN_TAB_* wants to move the real anchor.
301 /// access to real selection anchor
302 DocIterator & realAnchor();
303 /// sets anchor to cursor position
305 /// access to owning BufferView
306 BufferView & bv() const;
307 /// get some interesting description of top position
308 void info(odocstream & os) const;
309 /// are we in math mode (2), text mode (1) or unsure (0)?
311 /// reset cursor bottom to the beginning of the top inset
312 // (sort of 'chroot' environment...)
314 /// for spellchecking
315 void replaceWord(std::string const & replacestring);
317 * the event was not (yet) dispatched.
319 * Should only be called by an inset's doDispatch() method. It means:
320 * I, the doDispatch() method of InsetFoo, hereby declare that I am
321 * not able to handle that request and trust my parent will do the
322 * Right Thing (even if my getStatus partner said that I can do it).
323 * It is sort of a kludge that should be used only rarely...
325 void undispatched() const;
326 /// the event was already dispatched
327 void dispatched() const;
328 /// Set which screen update should be done
329 void screenUpdateFlags(Update::flags f) const;
330 /// Forces an updateBuffer() call
331 void forceBufferUpdate() const;
332 /// Removes any pending updateBuffer() call
333 void clearBufferUpdate() const;
334 /// Do we need to call updateBuffer()?
335 bool needBufferUpdate() const;
337 * don't call update() when done
339 * Should only be called by an inset's doDispatch() method. It means:
340 * I handled that request and I can reassure you that the screen does
341 * not need to be re-drawn and all entries in the coord cache stay
342 * valid (and there are no other things to put in the coord cache).
343 * This is a fairly rare event as well and only some optimization.
344 * Not using noScreenUpdate() should never be wrong.
346 void noScreenUpdate() const;
347 /// fix cursor in circumstances that should never happen.
348 /// \retval true if a fix occurred.
350 /// Repopulate the slices insets from bottom to top. Useful
351 /// for stable iterators or Undo data.
359 /// makes sure the next operation will be stored
360 void finishUndo() const;
362 /// open a new group of undo operations. Groups can be nested.
363 void beginUndoGroup() const;
365 /// end the current undo group
366 void endUndoGroup() const;
368 /// The general case: prepare undo for an arbitrary range.
369 void recordUndo(pit_type from, pit_type to) const;
371 /// Convenience: prepare undo for the range between 'from' and cursor.
372 void recordUndo(pit_type from) const;
374 /// Convenience: prepare undo for the single paragraph or cell
375 /// containing the cursor
376 void recordUndo(UndoKind kind = ATOMIC_UNDO) const;
378 /// Convenience: prepare undo for the inset containing the cursor
379 void recordUndoInset(Inset const * inset = 0) const;
381 /// Convenience: prepare undo for the whole buffer
382 void recordUndoFullBuffer() const;
384 /// Convenience: prepare undo for buffer parameters
385 void recordUndoBufferParams() const;
387 /// Convenience: prepare undo for the selected paragraphs or cells
388 void recordUndoSelection() const;
391 void checkBufferStructure();
393 /// hook for text input to maintain the "new born word"
394 void markNewWordPosition();
396 /// The position of the new born word
397 /// As the user is entering a word without leaving it
398 /// the result is not empty. When not in text mode
399 /// and after leaving the word the result is empty.
400 DocIterator newWord() const { return new_word_; }
406 DocIterator const & beforeDispatchCursor() const { return beforeDispatchCursor_; }
408 void saveBeforeDispatchPosXY();
411 /// validate the "new born word" position
412 void checkNewWordPosition();
413 /// clear the "new born word" position
414 void clearNewWordPosition();
420 mutable DispatchResult disp_;
422 * The target x position of the cursor. This is used for when
423 * we have text like :
425 * blah blah blah blah| blah blah blah
427 * blah blah blah blah blah blah
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
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_;
444 ///////////////////////////////////////////////////////////////////
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.
450 ///////////////////////////////////////////////////////////////////
454 void insert(MathAtom const &);
456 void insert(MathData const &);
457 /// return false for empty math insets
459 /// return false for empty math insets
461 /// move the cursor up by sending an internal LFUN_UP
462 /// return true if fullscreen update is needed
464 /// move the cursor up by sending an internal LFUN_DOWN,
465 /// return true if fullscreen update is needed
467 /// whether the cursor is either at the first or last row
468 bool atFirstOrLastRow(bool up);
469 /// move up/down in a text inset, called for LFUN_UP/DOWN,
470 /// return true if successful, updateNeeded set to true if fullscreen
471 /// update is needed, otherwise it's not touched
472 bool upDownInText(bool up, bool & updateNeeded);
473 /// move up/down in math or any non text inset, call for LFUN_UP/DOWN
474 /// return true if successful
475 bool upDownInMath(bool up);
479 void plainInsert(MathAtom const & at);
481 void niceInsert(MathAtom const & at);
482 /// return the number of inserted array items
483 int niceInsert(docstring const & str, Parse::flags f = Parse::NORMAL,
486 /// in pixels from top of screen
487 void setScreenPos(int x, int y);
488 /// current offset in the top cell
490 /// interpret name a name of a macro. Returns true if
491 /// something got inserted.
492 bool macroModeClose();
493 /// are we currently typing the name of a macro?
494 bool inMacroMode() const;
495 /// get access to the macro we are currently typing
496 InsetMathUnknown * activeMacro();
497 /// get access to the macro we are currently typing
498 InsetMathUnknown const * activeMacro() const;
500 /// replace selected stuff with at, placing the former
501 // selection in given cell of atom
502 void handleNest(MathAtom const & at, int cell = 0);
504 bool isInside(Inset const *) const;
506 /// make sure cursor position is valid
507 /// FIXME: It does a subset of fixIfBroken. Maybe merge them?
509 /// mark current cursor trace for redraw
512 /// hack for reveal codes
515 /// injects content of a cell into parent
517 /// split font inset etc
518 void handleFont(std::string const & font);
520 /// display a message
521 void message(docstring const & msg) const;
522 /// display an error message
523 void errorMessage(docstring const & msg) const;
525 docstring getPossibleLabel() const;
527 /// the name of the macro we are currently inputting
528 docstring macroName();
529 /// where in the curent cell does the macro name start?
531 /// can we enter the inset?
532 bool openable(MathAtom const &) const;
534 Encoding const * getEncoding() const;
535 /// font at cursor position
536 Font getFont() const;
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.
547 bool notifyCursorLeavesOrEnters(Cursor const & old, Cursor & cur);
552 #endif // LYXLCURSOR_H