X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FCursor.h;h=bb789e3a4c516263dc8a7de1afdf9962e543c66a;hb=2455bc258f3b62c29ec4a41cb88070ff8518e842;hp=9c98fa3d2c6cb2ccd7563607cf8aaaf9c80e154a;hpb=fc6ce7cd08562fd7bab4427880b46390bb7d2f07;p=lyx.git

diff --git a/src/Cursor.h b/src/Cursor.h
index 9c98fa3d2c..bb789e3a4c 100644
--- a/src/Cursor.h
+++ b/src/Cursor.h
@@ -14,8 +14,9 @@
 
 #include "DispatchResult.h"
 #include "DocIterator.h"
+#include "Font.h"
+#include "Undo.h"
 
-#include <iosfwd>
 #include <vector>
 
 
@@ -25,7 +26,6 @@ class Buffer;
 class BufferView;
 class FuncStatus;
 class FuncRequest;
-class Font;
 class Row;
 
 // these should go
@@ -48,19 +48,22 @@ public:
 	DispatchResult result() const;
 	/// add a new cursor slice
 	void push(Inset & inset);
-	/// add a new cursor slice, place cursor on left end
-	void pushLeft(Inset & inset);
+	/// add a new cursor slice, place cursor at front (move backwards)
+	void pushBackward(Inset & inset);
 	/// pop one level off the cursor
 	void pop();
-	/// pop one slice off the cursor stack and go left
-	bool popLeft();
-	/// pop one slice off the cursor stack and go right
-	bool popRight();
+	/// pop one slice off the cursor stack and go backwards
+	bool popBackward();
+	/// pop one slice off the cursor stack and go forward
+	bool popForward();
 	/// make sure we are outside of given inset
 	void leaveInset(Inset const & inset);
 	/// sets cursor part
 	void setCursor(DocIterator const & it);
 
+	///
+	void setCurrentFont();
+
 	//
 	// selection
 	//
@@ -86,9 +89,9 @@ public:
 	DocIterator selectionBegin() const;
 	/// access start of selection
 	DocIterator selectionEnd() const;
-	///
+	/// FIXME: document this
 	bool selHandle(bool selecting);
-	//
+	///
 	docstring selectionAsString(bool label) const;
 	///
 	docstring currentState();
@@ -103,16 +106,54 @@ public:
 	bool & macromode() { return macromode_; }
 	/// returns x,y position
 	void getPos(int & x, int & y) const;
+	/// return logical positions between which the cursor is situated
+	/**
+	 * If the cursor is at the edge of a row, the position which is "over the 
+	 * edge" will be returned as -1.
+	 */
+	void getSurroundingPos(pos_type & left_pos, pos_type & right_pos);
 	/// the row in the paragraph we're in
 	Row const & textRow() const;
 
 	//
 	// common part
 	//
-	/// move one step to the left
-	bool posLeft();
-	/// move one step to the right
-	bool posRight();
+	/// move one step backwards
+	bool posBackward();
+	/// move one step forward
+	bool posForward();
+	/// move visually one step to the right
+	/**
+	 * @note: This method may move into an inset unless skip_inset == true.
+	 * @note: This method may move into a new paragraph.
+	 * @note: This method may move out of the current slice.
+	 * @return: true if moved, false if not moved
+	 */
+	bool posVisRight(bool skip_inset = false);
+	/// move visually one step to the left
+	/**
+	 * @note: This method may move into an inset unless skip_inset == true.
+	 * @note: This method may move into a new paragraph.
+	 * @note: This method may move out of the current slice.
+	 * @return: true if moved, false if not moved
+	 */
+	bool posVisLeft(bool skip_inset = false);
+	/// move visually to next/previous row
+	/**
+	 * Assuming we were to keep moving left (right) from the current cursor
+	 * position, place the cursor at the rightmost (leftmost) edge of the 
+	 * new row to which we would move according to visual-mode cursor movement.
+	 * This could be either the next or the previous row, depending on the
+	 * direction in which we're moving, and whether we're in an LTR or RTL 
+	 * paragraph. 
+	 * @note: The new position may even be in a new paragraph.
+	 * @note: This method will not move out of the current slice.
+	 * @return: false if not moved (no more rows to move to in given direction)
+	 * @return: true if moved
+	 */
+	bool posVisToNewRow(bool movingLeft);
+	/// move to right or left extremity of the current row
+	void posVisToRowExtremity(bool left);
 
 	/// insert an inset
 	void insert(Inset *);
@@ -121,16 +162,21 @@ public:
 	/// insert a string
 	void insert(docstring const & str);
 
-	/// in pixels from left of screen
+	/// FIXME: rename to something sensible showing difference to x_target()
+	/// in pixels from left of screen, set to current position if unset
 	int targetX() const;
-	/// write acess to target x position of cursor
-	int & x_target();
-	/// return target x position of cursor
+	/// set the targetX to x
+	void setTargetX(int x);
+	/// return targetX or -1 if unset
 	int x_target() const;
-	/// set targetX in current position
+	/// set targetX to current position
 	void setTargetX();
-	/// clear target x position of cursor
+	/// clear targetX, i.e. set it to -1
 	void clearTargetX();
+	/// set offset to actual position - targetX
+	void updateTextTargetOffset();
+	/// distance between actual and targeted position during last up/down in text
+	int textTargetOffset() const;
 
 	/// access to normalized selection anchor
 	CursorSlice anchor() const;
@@ -174,11 +220,43 @@ public:
 	 * Not using noUpdate() should never be wrong.
 	 */
 	void noUpdate();
-	/// fix cursor in circumstances that should never happen
-	void fixIfBroken();
+	/// fix cursor in circumstances that should never happen.
+	/// \retval true if a fix occured.
+	bool fixIfBroken();
 
 	/// output
 	friend std::ostream & operator<<(std::ostream & os, Cursor const & cur);
+	friend LyXErr & operator<<(LyXErr & os, Cursor const & cur);
+
+	///
+	bool textUndo();
+	///
+	bool textRedo();
+
+	/// makes sure the next operation will be stored
+	void finishUndo();
+
+	/// The general case: prepare undo for an arbitrary range.
+	void recordUndo(UndoKind kind, pit_type from, pit_type to);
+
+	/// Convenience: prepare undo for the range between 'from' and cursor.
+	void recordUndo(UndoKind kind, pit_type from);
+
+	/// Convenience: prepare undo for the single paragraph or cell
+	/// containing the cursor
+	void recordUndo(UndoKind kind = ATOMIC_UNDO);
+
+	/// Convenience: prepare undo for the inset containing the cursor
+	void recordUndoInset(UndoKind kind = ATOMIC_UNDO);
+
+	/// Convenience: prepare undo for the whole buffer
+	void recordUndoFullDocument();
+
+	/// Convenience: prepare undo for the selected paragraphs or cells
+	void recordUndoSelection();
+
+	///
+	void checkBufferStructure();
 
 public:
 	///
@@ -186,11 +264,12 @@ public:
 //private:
 	/// the anchor position
 	DocIterator anchor_;
-
+	
 	///
 	DispatchResult disp_;
-
-
+	///
+	DocIterator const & beforeDispatchCursor() { return beforeDispatchCursor_; }
+	
 private:
 	/**
 	 * The target x position of the cursor. This is used for when
@@ -205,6 +284,8 @@ private:
 	 * shorter than x()
 	 */
 	int x_target_;
+	/// if a x_target cannot be hit exactly in a text, put the difference here
+	int textTargetOffset_;
 	/// do we have a selection?
 	bool selection_;
 	/// are we on the way to get one?
@@ -214,6 +295,15 @@ private:
 	// of a big inset spanning a whole row and computing coordinates for
 	// displaying the cursor.
 	bool logicalpos_;
+	/// position before dispatch started
+	DocIterator beforeDispatchCursor_;
+
+// FIXME: make them private.
+public:
+	/// the current font settings
+	Font current_font;
+	/// the current font
+	Font real_current_font;
 
 private:
 
@@ -243,10 +333,19 @@ public:
 	bool erase();
 	/// return false for empty math insets
 	bool backspace();
-	/// called for LFUN_UP etc
+	/// move the cursor up by sending an internal LFUN_UP
+	/// return true if fullscreen update is needed
 	bool up();
-	/// called for LFUN_DOWN etc
+	/// move the cursor up by sending an internal LFUN_DOWN,
+	/// return true if fullscreen update is needed
 	bool down();
+	/// move up/down in a text inset, called for LFUN_UP/DOWN,
+	/// return true if successful, updateNeeded set to true if fullscreen
+	/// update is needed, otherwise it's not touched
+	bool upDownInText(bool up, bool & updateNeeded);
+	/// move up/down in math or any non text inset, call for LFUN_UP/DOWN
+	/// return true if successful
+	bool upDownInMath(bool up);
 	///
 	void plainErase();
 	///
@@ -267,14 +366,17 @@ public:
 	bool inMacroMode() const;
 	/// get access to the macro we are currently typing
 	InsetMathUnknown * activeMacro();
+	/// get access to the macro we are currently typing
+	InsetMathUnknown const * activeMacro() const;
 
 	/// replace selected stuff with at, placing the former
 	// selection in given cell of atom
 	void handleNest(MathAtom const & at, int cell = 0);
 	///
-	bool isInside(Inset const *);
+	bool isInside(Inset const *) const;
 
 	/// make sure cursor position is valid
+	/// FIXME: It does a subset of fixIfBroken. Maybe merge them?
 	void normalize();
 	/// mark current cursor trace for redraw
 	void touch();
@@ -294,9 +396,6 @@ public:
 	///
 	docstring getPossibleLabel();
 
-	/// moves position somehow up or down
-	bool goUpDown(bool up);
-
 	/// the name of the macro we are currently inputting
 	docstring macroName();
 	/// where in the curent cell does the macro name start?
@@ -307,11 +406,16 @@ public:
 	Encoding const * getEncoding() const;
 	/// font at cursor position
 	Font getFont() const;
-	///
-	bool isRTL() const;
 };
 
 
+/**
+ * Notifies all insets which appear in old, but not in cur. Make
+ * Sure that the cursor old is valid, i.e. all inset pointers
+ * point to valid insets! Use Cursor::fixIfBroken if necessary.
+ */
+bool notifyCursorLeaves(Cursor const & old, Cursor & cur);
+
 
 } // namespace lyx