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
98 /// do we have a selection?
100 /// are we on the way to get one?
102 /// are we in word-selection mode? This is set when double clicking.
103 bool word_selection_;
105 // FIXME: make them protected.
107 /// the current font settings
110 Font real_current_font;
115 // math specific stuff that could be promoted to "global" later
117 /// do we allow autocorrection
119 /// are we entering a macro name?
124 /// The cursor class describes the position of a cursor within a document.
125 class Cursor : public CursorData
128 /// create the cursor of a BufferView
129 explicit Cursor(BufferView & bv);
131 /// returns true if we made a decision
132 bool getStatus(FuncRequest const & cmd, FuncStatus & flag) const;
133 /// dispatch from innermost inset upwards
134 void dispatch(FuncRequest const & cmd);
135 /// get the resut of the last dispatch
136 DispatchResult const & result() const;
137 /// add a new cursor slice
138 void push(Inset & inset);
139 /// add a new cursor slice, place cursor at front (move backwards)
140 void pushBackward(Inset & inset);
141 /// pop one level off the cursor
143 /// pop one slice off the cursor stack and go backwards
145 /// pop one slice off the cursor stack and go forward
147 /// make sure we are outside of given inset
148 void leaveInset(Inset const & inset);
149 /// set the cursor data
150 void setCursorData(CursorData const & data);
152 void setCursor(DocIterator const & it);
153 /// sets the cursor to the normalized selection anchor
154 void setCursorToAnchor();
157 void setCurrentFont();
162 /// selection active?
163 bool selection() const { return selection_; }
164 /// set selection; this is lower level than (set|clear)Selection
165 void selection(bool sel) { selection_ = sel; }
166 /// do we have a multicell selection?
167 bool selIsMultiCell() const
168 { return selection_ && selBegin().idx() != selEnd().idx(); }
169 /// do we have a multiline selection?
170 bool selIsMultiLine() const
171 { return selection_ && selBegin().pit() != selEnd().pit(); }
173 void setWordSelection(bool set) { word_selection_ = set; }
175 bool wordSelection() { return word_selection_; }
176 /// did we place the anchor?
177 bool mark() const { return mark_; }
178 /// did we place the anchor?
179 void setMark(bool mark) { mark_ = mark; }
182 /// set selection at given position
183 void setSelection(DocIterator const & where, int n);
185 void clearSelection();
186 /// access start of selection
187 CursorSlice selBegin() const;
188 /// access end of selection
189 CursorSlice selEnd() const;
190 /// access start of selection
191 DocIterator selectionBegin() const;
192 /// access end of selection
193 DocIterator selectionEnd() const;
195 * Update the selection status and save permanent
196 * selection if needed.
197 * @param selecting the new selection status
198 * @return whether the selection status has changed
200 bool selHandle(bool selecting);
202 docstring selectionAsString(bool with_label) const;
204 docstring currentState() const;
206 /// auto-correct mode
207 bool autocorrect() const { return autocorrect_; }
208 /// auto-correct mode
209 bool & autocorrect() { return autocorrect_; }
210 /// are we entering a macro name?
211 bool macromode() const { return macromode_; }
212 /// are we entering a macro name?
213 bool & macromode() { return macromode_; }
215 /// returns true when all insets in cursor stack are in cache
216 bool inCoordCache() const;
217 /// returns x,y position
218 void getPos(int & x, int & y) const;
219 /// return logical positions between which the cursor is situated
221 * If the cursor is at the edge of a row, the position which is "over the
222 * edge" will be returned as -1.
224 void getSurroundingPos(pos_type & left_pos, pos_type & right_pos) const;
225 /// the row in the paragraph we're in
226 Row const & textRow() const;
231 /// move one step backwards
233 /// move one step forward
235 /// move visually one step to the right
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
242 bool posVisRight(bool skip_inset = false);
243 /// move visually one step to the left
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
250 bool posVisLeft(bool skip_inset = false);
251 /// move visually to next/previous row
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
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
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;
271 void insert(Inset *);
272 /// insert a single char
273 void insert(char_type c);
275 void insert(docstring const & str);
277 /// FIXME: rename to something sensible showing difference to x_target()
278 /// in pixels from left of screen, set to current position if unset
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
286 /// clear targetX, i.e. set it to -1
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;
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
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)?
306 /// reset cursor bottom to the beginning of the top inset
307 // (sort of 'chroot' environment...)
309 /// for spellchecking
310 void replaceWord(std::string const & replacestring);
312 * the event was not (yet) dispatched.
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...
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;
332 * don't call update() when done
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.
341 void noScreenUpdate() const;
342 /// fix cursor in circumstances that should never happen.
343 /// \retval true if a fix occurred.
345 /// Repopulate the slices insets from bottom to top. Useful
346 /// for stable iterators or Undo data.
354 /// makes sure the next operation will be stored
355 void finishUndo() const;
357 /// open a new group of undo operations. Groups can be nested.
358 void beginUndoGroup() const;
360 /// end the current undo group
361 void endUndoGroup() const;
363 /// The general case: prepare undo for an arbitrary range.
364 void recordUndo(pit_type from, pit_type to) const;
366 /// Convenience: prepare undo for the range between 'from' and cursor.
367 void recordUndo(pit_type from) const;
369 /// Convenience: prepare undo for the single paragraph or cell
370 /// containing the cursor
371 void recordUndo(UndoKind kind = ATOMIC_UNDO) const;
373 /// Convenience: prepare undo for the inset containing the cursor
374 void recordUndoInset(Inset const * inset = 0) const;
376 /// Convenience: prepare undo for the whole buffer
377 void recordUndoFullBuffer() const;
379 /// Convenience: prepare undo for buffer parameters
380 void recordUndoBufferParams() const;
382 /// Convenience: prepare undo for the selected paragraphs or cells
383 void recordUndoSelection() const;
386 void checkBufferStructure();
388 /// hook for text input to maintain the "new born word"
389 void markNewWordPosition();
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_; }
401 DocIterator const & beforeDispatchCursor() const { return beforeDispatchCursor_; }
403 void saveBeforeDispatchPosXY();
406 /// validate the "new born word" position
407 void checkNewWordPosition();
408 /// clear the "new born word" position
409 void clearNewWordPosition();
415 mutable DispatchResult disp_;
417 * The target x position of the cursor. This is used for when
418 * we have text like :
420 * blah blah blah blah| blah blah blah
422 * blah blah blah blah blah blah
424 * When we move onto row 3, we would like to be vertically aligned
425 * with where we were in row 1, despite the fact that row 2 is
429 /// if a x_target cannot be hit exactly in a text, put the difference here
430 int textTargetOffset_;
431 /// the start of the new born word
432 DocIterator new_word_;
433 /// position before dispatch started
434 DocIterator beforeDispatchCursor_;
435 /// cursor screen coordinates before dispatch started
436 int beforeDispatchPosX_;
437 int beforeDispatchPosY_;
439 ///////////////////////////////////////////////////////////////////
441 // The part below is the non-integrated rest of the original math
442 // cursor. This should be either generalized for texted or moved
443 // back to the math insets.
445 ///////////////////////////////////////////////////////////////////
449 void insert(MathAtom const &);
451 void insert(MathData const &);
452 /// return false for empty math insets
454 /// return false for empty math insets
456 /// move the cursor up by sending an internal LFUN_UP
457 /// return true if fullscreen update is needed
459 /// move the cursor up by sending an internal LFUN_DOWN,
460 /// return true if fullscreen update is needed
462 /// whether the cursor is either at the first or last row
463 bool atFirstOrLastRow(bool up);
464 /// move up/down in a text inset, called for LFUN_UP/DOWN,
465 /// return true if successful, updateNeeded set to true if fullscreen
466 /// update is needed, otherwise it's not touched
467 bool upDownInText(bool up, bool & updateNeeded);
468 /// move up/down in math or any non text inset, call for LFUN_UP/DOWN
469 /// return true if successful
470 bool upDownInMath(bool up);
474 void plainInsert(MathAtom const & at);
476 void niceInsert(MathAtom const & at);
477 /// return the number of inserted array items
478 int niceInsert(docstring const & str, Parse::flags f = Parse::NORMAL,
481 /// in pixels from top of screen
482 void setScreenPos(int x, int y);
483 /// current offset in the top cell
485 /// interpret name a name of a macro. Returns true if
486 /// something got inserted.
487 bool macroModeClose();
488 /// are we currently typing the name of a macro?
489 bool inMacroMode() const;
490 /// get access to the macro we are currently typing
491 InsetMathUnknown * activeMacro();
492 /// get access to the macro we are currently typing
493 InsetMathUnknown const * activeMacro() const;
495 /// replace selected stuff with at, placing the former
496 // selection in given cell of atom
497 void handleNest(MathAtom const & at, int cell = 0);
499 bool isInside(Inset const *) const;
501 /// make sure cursor position is valid
502 /// FIXME: It does a subset of fixIfBroken. Maybe merge them?
504 /// mark current cursor trace for redraw
507 /// hack for reveal codes
510 /// injects content of a cell into parent
512 /// split font inset etc
513 void handleFont(std::string const & font);
515 /// display a message
516 void message(docstring const & msg) const;
517 /// display an error message
518 void errorMessage(docstring const & msg) const;
520 docstring getPossibleLabel() const;
522 /// the name of the macro we are currently inputting
523 docstring macroName();
524 /// where in the curent cell does the macro name start?
526 /// can we enter the inset?
527 bool openable(MathAtom const &) const;
529 Encoding const * getEncoding() const;
530 /// font at cursor position
531 Font getFont() const;
536 * Notifies all insets which appear in \c old, but not in \c cur. And then
537 * notify all insets which appear in \c cur, but not in \c old.
538 * \returns true if cursor is now invalid, e.g. if some insets in
539 * higher cursor slices of \c old do not exist anymore. In this case
540 * it may be necessary to use Use Cursor::fixIfBroken.
542 bool notifyCursorLeavesOrEnters(Cursor const & old, Cursor & cur);
547 #endif // LYXLCURSOR_H