]> 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 1772357f3e953b4843aded20067013977a5219e6..6e2742fd6505e64415185e9b946663798f44836f 100644 (file)
@@ -8,9 +8,7 @@
  *
  *  Dependencies: Xlib, XForms
  *
- *  Copyright: (c) 1996, Alejandro Aguilar Sierra
- *
- *   Version: 0.8beta, Mathed & Lyx project.
+ *  Copyright: 1996, Alejandro Aguilar Sierra
  *
  *   You are free to use and modify this code under the terms of
  *   the GNU General Public Licence version 2 or later.
 #pragma interface
 #endif
 
-#include "math_iter.h" 
+#include "math_defs.h"
 #include "math_inset.h"
+#include "math_pos.h"
+#include "LString.h"
 
+class InsetFormulaBase;
+class Painter;
+class Selection;
 
-/// This is the external interface of Mathed's subkernel
-class MathedCursor {
- public:
-    ///
-    MathedCursor(MathParInset * p);
-    ///
-    ~MathedCursor() { };
-    ///
-    void Insert(byte, MathedTextCodes t = LM_TC_MIN);
-    ///
-    void Insert(MathedInset*, int t = LM_TC_INSET);
-    ///
-    void Home();
-    ///
-    void End();
-    ///
-    bool Right(bool sel = false);
-    ///
-    bool Left(bool sel = false);
-    ///
-    bool Up(bool sel = false);
-    ///
-    bool Down(bool sel = false);
-    ///
-    bool Pop();
-    ///
-    bool Push();
-    /// Pull out an argument from its container inset
-    bool pullArg();
-    ///
-    void Draw(long unsigned pm, int x, int y);
-    ///
-    void Redraw();
-    ///
-    void Delete();
-    ///
-    void DelLine();
-    ///
-    void SetPos(int, int);
-    ///
-    void GetPos(int & x, int & y) { cursor->GetPos(x, y); }
-    ///
-    short GetFCode() { return cursor->FCode(); }
-    ///
-    MathParInset * GetPar() { return par; }
-    ///
-    MathParInset * getCurrentPar() const { return cursor->p; }
-    ///
-    void SetPar(MathParInset *);
-    ///
-    void Interpret(char const *);
-    ///
-    void SetSize(short);
-    ///
-    void setNumbered();
-    void setLabel(char const *);
-    ///
-    bool Limits();
-    /// Set accent: if argument = 0 it's considered consumed 
-    void setAccent(int ac = 0);
-    /// Returns last accent
-    int getAccent() const;
-    ///
-    bool IsEnd() const { return !cursor->OK(); }
-    // Macro mode methods
-    ///
-    void MacroModeOpen();
-    ///
-    void MacroModeClose();
-    ///
-    bool InMacroMode() { return macro_mode; }
-    
-    // Local selection methods
-    ///
-    bool Selection() { return selection; }
-    ///
-    void SelCopy();
-    ///
-    void SelCut();
-    ///
-    void SelDel();
-    ///
-    void SelPaste();
-    ///
-    void SelStart();
-    ///
-    void SelClear();
-    ///
-    void SelBalance();  
-    ///
-    XPoint * SelGetArea(int &);
-    ///
-    void clearLastCode() { lastcode = LM_TC_MIN; }
-    ///
-    void setLastCode(MathedTextCodes t) { lastcode = t; }
-    ///
-    MathedTextCodes getLastCode() const { return lastcode; }
-    
- protected:
-    ///
-    bool macro_mode;
-    ///
-    void MacroModeBack();
-    ///
-    void MacroModeInsert(char);
-    
-    // Selection stuff
-    ///
-    bool selection;
-    ///
-    int  selpos;
-    ///
-    MathedXIter cursel, * anchor;
-    ///
-//    LyxArrayBase *selarray; 
-    ///
-    Bool is_visible;
-    ///
-    long unsigned win;
-    ///
-    MathParInset * par;
-    ///
-    MathedXIter * cursor;
-    ///
-    int xc, yc;
-    ///
-    void doAccent(byte c, MathedTextCodes t);
-    ///
-    void doAccent(MathedInset * p);
-    ///
-    int accent;
-       ///
-    int nestaccent[8];
-       ///
-    MathedTextCodes lastcode;
-
- private:
-       ///
-    char macrobf[80];
-       ///
-    int macroln;
-       ///
-    MathFuncInset * imacro;
-};
+/**
+
+[Have a look at math_inset.h first]
+
+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.
+
+*/
 
 
-//--------------------   Inline Functions  -------------------------// 
+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 *, bool left);
+       ///
+       void insert(MathAtom const &);
+       ///
+       void insert(MathArray const &);
+       ///
+       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();
+       ///
+       void plainErase();
+       ///
+       void plainInsert(MathAtom const &);
+       ///
+       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 grid inset and the cursor's index in it
+       MathGridInset * enclosingGrid(idx_type &) const;
+       ///
+       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;
+       ///
+       bool script(bool);
+       ///
+       bool interpret(string const &);
+       ///
+       bool interpret(char);
+       ///
+       bool toggleLimits();
+       /// interpret name a name of a macro
+       void macroModeClose();
+       ///
+       bool inMacroMode() const;
+       
+       // Local selection methods
+       ///
+       bool selection() const;
+       ///
+       void selCopy();
+       ///
+       void selCut();
+       ///
+       void selDel();
+       ///
+       void selPaste();
+       ///
+       void selHandle(bool);
+       ///
+       void selStart();
+       ///
+       void selClear();
+       ///
+       void selGet(MathArray & ar);
+       ///
+       void drawSelection(Painter & pain) const;
+       ///
+       void handleFont(MathTextCodes t);
+       ///
+       void handleDelim(string const & l, string const & r);
+       ///
+       void handleNest(MathInset * p);
+       /// splits cells and shifts right part to the next cell
+       void splitCell();
+       /// 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_; }
+       ///
+       void pullArg(bool goright);
+       ///
+       bool isInside(MathInset const *) const;
+       ///
+       MathTextCodes nextCode() const;
+       ///
+       char valign() const;
+       ///
+       char halign() const;
+       ///
+       col_type hullCol() const;
+       ///
+       row_type hullRow() const;
+       ///
+       col_type gridCol() const;
+       ///
+       row_type gridRow() const;
+
+       /// make sure cursor position is valid
+       void normalize();
+       ///
+       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 selection
+       void getSelection(MathCursorPos &, MathCursorPos &) const;
+       /// returns the normalized anchor of the selection
+       MathCursorPos normalAnchor() const;
+
+       /// path of positions the cursor had to go if it were leving each inset
+       cursor_type Cursor_;
+       /// path of positions the anchor had to go if it were leving each inset
+       mutable cursor_type Anchor_;
+
+       /// 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;
+
+       /// dump selection information for debugging
+       void seldump(char const * str) const;
+       /// dump selection information for debugging
+       void dump(char const * str) const;
+       ///
+       void stripFromLastEqualSign();
+       /// moves on 
+       void setSelection(cursor_type const & where, size_type n);
+
+       ///
+       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);
+
+       ///
+       string macroName() const;
+       ///
+       MathInset::difference_type macroNamePos() 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();
+
+       ///
+       InsetFormulaBase * formula_;
+       ///
+       MathTextCodes lastcode_;
+       // Selection stuff
+       /// do we currently select
+       bool selection_;
+};
 
+extern MathCursor * mathcursor;
 
 #endif