]> git.lyx.org Git - lyx.git/blobdiff - src/mathed/math_cursor.h
make \newcommand{\bb}[1]{\mathbf{#1}} work for read/write/display.
[lyx.git] / src / mathed / math_cursor.h
index c46852cf3e681aad45b560a243abdc4927e75b9d..6e2742fd6505e64415185e9b946663798f44836f 100644 (file)
 #endif
 
 #include "math_defs.h"
+#include "math_inset.h"
+#include "math_pos.h"
+#include "LString.h"
 
-class MathInset;
-class MathFuncInset;
-class MathUpDownInset;
 class InsetFormulaBase;
-class MathArray;
-class MathXArray;
 class Painter;
+class Selection;
 
-/// Description of a position 
-struct MathCursorPos {
-       /// inset
-       MathInset * par_;
-       /// cell index
-       int idx_;
-       /// cell position
-       int pos_;
-       /// returns cell corresponding to this position
-       MathArray & cell() const;
-       /// returns cell corresponding to this position
-       MathArray & cell(int idx) const;
-       /// returns xcell corresponding to this position
-       MathXArray & xcell() const;
-       /// returns xcell corresponding to this position
-       MathXArray & xcell(int idx) const;
-       /// moves position on cell to the left
-       bool idxLeft();
-       /// moves position on cell to the right
-       bool idxRight();
-       /// moves position on cell up
-       bool idxUp();
-       /// moves position on cell up
-       bool idxDown();
-};
+/**
+
+[Have a look at math_inset.h first]
 
-/// 
-bool operator==(MathCursorPos const &, MathCursorPos const &);
-/// 
-bool operator<(MathCursorPos const &, MathCursorPos const &);
+The MathCursor is different from the kind of cursor used in the Outer
+World. It contains a stack of MathCursorPositions, each of which is made
+up of a inset pointer, an index and a position offset, marking a path from
+this formula's mathHullInset to the current position.
+
+*/
 
 
-/// This is the external interface of Math's subkernel
 class MathCursor {
 public:
+       /// short of anything else reasonable
+       typedef MathInset::size_type       size_type;
+       /// type for cursor positions within a cell
+       typedef MathInset::pos_type        pos_type;
+       /// type for cell indices
+       typedef MathInset::idx_type        idx_type;
+       /// type for row numbers
+       typedef MathInset::row_type        row_type;
+       /// type for column numbers
+       typedef MathInset::col_type        col_type;
+       /// how to store a cursor
+       typedef std::vector<MathCursorPos> cursor_type;
+
        ///
-       explicit MathCursor(InsetFormulaBase *);
-       ///
-       void insert(char, MathTextCodes t = LM_TC_MIN);
+       explicit MathCursor(InsetFormulaBase *, bool left);
        ///
-       void insert(MathInset *);
+       void insert(MathAtom const &);
        ///
        void insert(MathArray const &);
        ///
-       void Home();
-       ///
-       void End();
-       ///
-       bool Right(bool sel = false);
-       ///
-       bool Left(bool sel = false);
-       ///
-       bool Up(bool sel = false);
-       ///
-       bool Down(bool sel = false);
+       void paste(MathArray const &);
+       ///
+       void erase();
+       ///
+       void backspace();
+       /// called for LFUN_HOME etc
+       void home(bool sel = false);
+       /// called for LFUN_END etc
+       void end(bool sel = false);
+       /// called for LFUN_RIGHT and LFUN_RIGHTSEL
+       bool right(bool sel = false);
+       /// called for LFUN_LEFT etc
+       bool left(bool sel = false);
+       /// called for LFUN_UP etc
+       bool up(bool sel = false);
+       /// called for LFUN_DOWN etc
+       bool down(bool sel = false);
        /// Put the cursor in the first position
        void first();
        /// Put the cursor in the last position
        void last();
+       /// move to next cell in current inset
+       void idxNext();
+       /// move to previous cell in current inset
+       void idxPrev();
        ///
-       bool plainLeft();
-       ///
-       bool plainRight();
-       ///
-       void Delete();
+       void plainErase();
        ///
-       void DelLine();
-       /// This is in pixels from (maybe?) the top of inset
-       void SetPos(int, int);
+       void plainInsert(MathAtom const &);
        ///
-       void GetPos(int & x, int & y);
+       void niceInsert(MathAtom const &);
+
        ///
+       void delLine();
+       /// in pixels from top of screen
+       void setPos(int x, int y);
+       /// in pixels from top of screen
+       void getPos(int & x, int & y);
+       /// current inset
        MathInset * par() const;
-       /// return the next enclosing par of the given type and the cursor's
-       //index in it
-       MathInset * enclosing(MathInsetTypes, int &) const;
+       /// return the next enclosing grid inset and the cursor's index in it
+       MathGridInset * enclosingGrid(idx_type &) const;
        ///
-       InsetFormulaBase const * formula();
+       InsetFormulaBase * formula();
+       /// current offset in the current cell
+       pos_type pos() const;
+       /// current cell
+       idx_type idx() const;
+       /// size of current cell
+       size_type size() const;
        ///
-       int pos() const;
+       bool script(bool);
        ///
-       void Interpret(string const &);
+       bool interpret(string const &);
        ///
-       void SetSize(MathStyles);
+       bool interpret(char);
        ///
        bool toggleLimits();
+       /// interpret name a name of a macro
+       void macroModeClose();
        ///
-       // Macro mode methods
-       void MacroModeOpen();
-       ///
-       void MacroModeClose();
-       ///
-       bool InMacroMode() const;
+       bool inMacroMode() const;
        
        // Local selection methods
        ///
-       bool Selection() const;
+       bool selection() const;
        ///
-       void SelCopy();
+       void selCopy();
        ///
-       void SelCut();
+       void selCut();
        ///
-       void SelDel();
+       void selDel();
        ///
-       void SelPaste();
+       void selPaste();
        ///
-       void SelHandle(bool);
+       void selHandle(bool);
        ///
-       void SelStart();
+       void selStart();
        ///
-       void SelClear();
+       void selClear();
        ///
-       void drawSelection(Painter & pain) const;
-       ///
-       void clearLastCode();
+       void selGet(MathArray & ar);
        ///
-       void setLastCode(MathTextCodes t);
+       void drawSelection(Painter & pain) const;
        ///
        void handleFont(MathTextCodes t);
        ///
-       void handleAccent(string const & name, int code);
+       void handleDelim(string const & l, string const & r);
        ///
-       void handleDelim(int l, int r);
-       /// Splits cells and shifts right part to the next cell
+       void handleNest(MathInset * p);
+       /// splits cells and shifts right part to the next cell
        void splitCell();
-       /// Splits line and insert new row of cell 
+       /// splits line and insert new row of cell 
        void breakLine();
+       /// read contents of line into an array
+       void readLine(MathArray & ar) const;
+       /// remove this as soon as LyXFunc::getStatus is "localized"
+       MathTextCodes getLastCode() const { return lastcode_; }
        ///
-       MathTextCodes getLastCode() const;
+       void pullArg(bool goright);
        ///
-       int idx() const { return cursor().idx_; }
-       ///
-       void idxNext();
-       ///
-       void idxPrev();
-       ///
-       void pullArg();
-       ///
-       bool isInside(MathInset *) const;
+       bool isInside(MathInset const *) const;
        ///
        MathTextCodes nextCode() const;
        ///
-       MathTextCodes prevCode() const;
-       ///
        char valign() const;
        ///
        char halign() const;
        ///
-       int col() const;
+       col_type hullCol() const;
        ///
-       int row() const;
-
+       row_type hullRow() const;
        ///
-       MathStyles style() const;
-       /// Make sure cursor position is valid
-       void normalize() const;
-       
-       /// Enter a new MathInset from the front or the back
-       void push(MathInset * par, bool first);
-       /// Leave current MathInset
-       bool pop();
-
-//private:
+       col_type gridCol() const;
        ///
-       bool macro_mode;
-       
-       // Selection stuff
-       /// do we currently select
-       bool selection;
+       row_type gridRow() const;
 
+       /// make sure cursor position is valid
+       void normalize();
        ///
-       InsetFormulaBase * const formula_;
-       ///
-       MathTextCodes lastcode;
+       UpdatableInset * asHyperActiveInset() const;
+
+       /// enter a MathInset 
+       void push(MathAtom & par);
+       /// enter a MathInset from the front
+       void pushLeft(MathAtom & par);
+       /// enter a MathInset from the back
+       void pushRight(MathAtom & par);
+       /// leave current MathInset to the left
+       bool popLeft();
+       /// leave current MathInset to the left
+       bool popRight();
 
        ///
        MathArray & array() const;
        ///
        MathXArray & xarray() const;
+       ///
+       bool hasPrevAtom() const;
+       ///
+       bool hasNextAtom() const;
+       ///
+       MathAtom const & prevAtom() const;
+       ///
+       MathAtom & prevAtom();
+       ///
+       MathAtom const & nextAtom() const;
+       ///
+       MathAtom & nextAtom();
 
-       /// returns the first position of the (normalized) selection
-       MathCursorPos firstSelectionPos() const;
-       /// returns the last position of the (normalized) selection
-       MathCursorPos lastSelectionPos() const;
        /// returns the selection
        void getSelection(MathCursorPos &, MathCursorPos &) const;
        /// returns the normalized anchor of the selection
        MathCursorPos normalAnchor() const;
-       /// returns the normalized anchor of the selection
-       bool openable(MathInset *, bool selection, bool useupdown) const;
 
        /// path of positions the cursor had to go if it were leving each inset
-       std::vector<MathCursorPos> Cursor_;
+       cursor_type Cursor_;
        /// path of positions the anchor had to go if it were leving each inset
-       std::vector<MathCursorPos> Anchor_;
+       mutable cursor_type Anchor_;
 
-       /// reference to the last item of the path
+       /// reference to the last item of the path, i.e. "The Cursor"
        MathCursorPos & cursor();
-       ///
+       /// reference to the last item of the path, i.e. "The Cursor"
        MathCursorPos const & cursor() const;
 
-
-       ///  
-       int last() const;
-       ///
-       MathInset * parInset(int i) const;
-       ///
+       /// dump selection information for debugging
        void seldump(char const * str) const;
-       ///
+       /// dump selection information for debugging
        void dump(char const * str) const;
-
-       ///
-       int xpos() const;
        ///
-       void gotoX(int x);
+       void stripFromLastEqualSign();
+       /// moves on 
+       void setSelection(cursor_type const & where, size_type n);
 
        ///
-       bool nextIsInset() const;
-       ///
-       bool prevIsInset() const;
-       ///
-       void merge(MathArray const & arr);
+       friend class Selection;
+
+private:
+       /// moves cursor position one cell to the left
+       bool posLeft();
+       /// moves cursor position one cell to the right
+       bool posRight();
+       /// moves cursor index one cell to the left
+       bool idxLeft();
+       /// moves cursor index one cell to the right
+       bool idxRight();
+       /// moves position somehow up or down
+       bool goUpDown(bool up);
+       /// moves position into box
+       bool bruteFind(int xo, int yo, int xlow, int xhigh, int ylow, int yhigh);
+
        ///
-       MathInset * nextInset() const;
+       string macroName() const;
        ///
-       MathInset * prevInset() const;
+       MathInset::difference_type macroNamePos() const;
        ///
-       MathUpDownInset * nearbyUpDownInset() const;
+       void insert(char, MathTextCodes t);
+       /// can we enter the inset? 
+       bool openable(MathAtom const &, bool selection) const;
+       /// write access to cursor cell position
+       pos_type & pos();
+       /// write access to cursor cell index
+       idx_type & idx();
 
        ///
-       MathFuncInset * imacro;
+       InsetFormulaBase * formula_;
+       ///
+       MathTextCodes lastcode_;
+       // Selection stuff
+       /// do we currently select
+       bool selection_;
 };
 
 extern MathCursor * mathcursor;