// -*- C++ -*- /** * \file Cursor.h * This file is part of LyX, the document processor. * Licence details can be found in the file COPYING. * * \author André Pönitz * * Full author contact details are available in file CREDITS. */ #ifndef LCURSOR_H #define LCURSOR_H #include "DispatchResult.h" #include "DocIterator.h" #include "Font.h" #include "Undo.h" #include "mathed/MathParser_flags.h" #include namespace lyx { class Buffer; class BufferView; class FuncStatus; class FuncRequest; class Row; // these should go class InsetMathUnknown; class Encoding; /// The cursor class describes the position of a cursor within a document. // The public inheritance should go in favour of a suitable data member // (or maybe private inheritance) at some point of time. class Cursor : public DocIterator { public: /// create the cursor of a BufferView explicit Cursor(BufferView & bv); /// dispatch from innermost inset upwards void dispatch(FuncRequest const & cmd); /// get the resut of the last dispatch DispatchResult result() const; /// add a new cursor slice void push(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 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 // /// selection active? bool selection() const { return selection_; } /// set selection; void setSelection(bool sel) { selection_ = sel; } /// do we have a multicell selection? bool selIsMultiCell() const { return selection_ && selBegin().idx() != selEnd().idx(); } /// do we have a multiline selection? bool selIsMultiLine() const { return selection_ && selBegin().pit() != selEnd().pit(); } /// did we place the anchor? bool mark() const { return mark_; } /// did we place the anchor? void setMark(bool mark) { mark_ = mark; } /// void setSelection(); /// set selection at given position void setSelection(DocIterator const & where, int n); /// void clearSelection(); /// access start of selection CursorSlice selBegin() const; /// access end of selection CursorSlice selEnd() const; /// access start of selection DocIterator selectionBegin() const; /// access start of selection DocIterator selectionEnd() const; /** * Update the selection status and save permanent * selection if needed. * @param selecting the new selection status * @return whether the selection status has changed */ bool selHandle(bool selecting); /// docstring selectionAsString(bool label) const; /// docstring currentState() const; /// auto-correct mode bool autocorrect() const { return autocorrect_; } /// auto-correct mode bool & autocorrect() { return autocorrect_; } /// are we entering a macro name? bool macromode() const { return macromode_; } /// are we entering a macro name? 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 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 *); /// insert a single char void insert(char_type c); /// insert a string void insert(docstring const & str); /// 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; /// set the targetX to x void setTargetX(int x); /// return targetX or -1 if unset int x_target() const; /// set targetX to current position void setTargetX(); /// 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; /// sets anchor to cursor position void resetAnchor(); /// access to owning BufferView BufferView & bv() const; /// access to owning Buffer Buffer & buffer() const; /// get some interesting description of top position void info(odocstream & os) const; /// are we in math mode (2), text mode (1) or unsure (0)? int currentMode(); /// reset cursor bottom to the beginning of the given inset // (sort of 'chroot' environment...) void reset(Inset &); /// for spellchecking void replaceWord(std::string const & replacestring); /** * the event was not (yet) dispatched. * * Should only be called by an inset's doDispatch() method. It means: * I, the doDispatch() method of InsetFoo, hereby declare that I am * not able to handle that request and trust my parent will do the * Right Thing (even if my getStatus partner said that I can do it). * It is sort of a kludge that should be used only rarely... */ void undispatched(); /// the event was already dispatched void dispatched(); /// Set which update should be done void updateFlags(Update::flags f); /** * don't call update() when done * * Should only be called by an inset's doDispatch() method. It means: * I handled that request and I can reassure you that the screen does * not need to be re-drawn and all entries in the coord cache stay * valid (and there are no other things to put in the coord cache). * This is a fairly rare event as well and only some optimization. * Not using noUpdate() should never be wrong. */ void noUpdate(); /// 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() const; /// open a new group of undo operations. Groups can be nested. void beginUndoGroup() const; /// end the current undo group void endUndoGroup() const; /// The general case: prepare undo for an arbitrary range. void recordUndo(UndoKind kind, pit_type from, pit_type to) const; /// Convenience: prepare undo for the range between 'from' and cursor. void recordUndo(UndoKind kind, pit_type from) const; /// Convenience: prepare undo for the single paragraph or cell /// containing the cursor void recordUndo(UndoKind kind = ATOMIC_UNDO) const; /// Convenience: prepare undo for the inset containing the cursor void recordUndoInset(UndoKind kind = ATOMIC_UNDO) const; /// Convenience: prepare undo for the whole buffer void recordUndoFullDocument() const; /// Convenience: prepare undo for the selected paragraphs or cells void recordUndoSelection() const; /// void checkBufferStructure(); public: /// BufferView * bv_; //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 * we have text like : * * blah blah blah blah| blah blah blah * blah blah blah * blah blah blah blah blah blah * * When we move onto row 3, we would like to be vertically aligned * with where we were in row 1, despite the fact that row 2 is * 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? bool mark_; /// If true, we are behind the previous char, otherwise we are in front // of the next char. This only make a difference when we are in front // 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: // // math specific stuff that could be promoted to "global" later // /// do we allow autocorrection bool autocorrect_; /// are we entering a macro name? bool macromode_; /////////////////////////////////////////////////////////////////// // // The part below is the non-integrated rest of the original math // cursor. This should be either generalized for texted or moved // back to the math insets. // /////////////////////////////////////////////////////////////////// public: /// void insert(MathAtom const &); /// void insert(MathData const &); /// return false for empty math insets bool erase(); /// return false for empty math insets bool backspace(); /// move the cursor up by sending an internal LFUN_UP /// return true if fullscreen update is needed bool up(); /// move the cursor up by sending an internal LFUN_DOWN, /// return true if fullscreen update is needed bool down(); /// whether the cursor is either at the first or last row bool atFirstOrLastRow(bool up); /// 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(); /// void plainInsert(MathAtom const & at); /// void niceInsert(MathAtom const & at); /// void niceInsert(docstring const & str, Parse::flags f = Parse::NORMAL); /// in pixels from top of screen void setScreenPos(int x, int y); /// current offset in the top cell /// interpret name a name of a macro. Returns true if /// something got inserted. bool macroModeClose(); /// are we currently typing the name of a macro? 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 *) 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(); /// hack for reveal codes void markInsert(); void markErase(); /// injects content of a cell into parent void pullArg(); /// split font inset etc void handleFont(std::string const & font); /// display a message void message(docstring const & msg) const; /// display an error message void errorMessage(docstring const & msg) const; /// docstring getPossibleLabel() const; /// the name of the macro we are currently inputting docstring macroName(); /// where in the curent cell does the macro name start? int macroNamePos(); /// can we enter the inset? bool openable(MathAtom const &) const; /// Encoding const * getEncoding() const; /// font at cursor position Font getFont() 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 #endif // LYXLCURSOR_H