src/mathed/math_cursor.h

   1 // -*- C++ -*-
   2 /*
   3  *  File:        math_cursor.h
   4  *  Purpose:     Declaration of interaction classes for mathed
   5  *  Author:      Alejandro Aguilar Sierra <asierra@servidor.unam.mx>
   6  *  Created:     January 1996
   7  *  Description: MathCursor control all user interaction
   8  *
   9  *  Dependencies: Xlib, XForms
  10  *
  11  *  Copyright: 1996, Alejandro Aguilar Sierra
  12  *
  13  *   You are free to use and modify this code under the terms of
  14  *   the GNU General Public Licence version 2 or later.
  15  */
  16
  17 #ifndef MATH_CURSOR
  18 #define MATH_CURSOR
  19
  20 #ifdef __GNUG__
  21 #pragma interface
  22 #endif
  23
  24 #include "math_defs.h"
  25 #include "math_inset.h"
  26 #include "math_pos.h"
  27 #include "LString.h"
  28
  29 class InsetFormulaBase;
  30 class Painter;
  31 class Selection;
  32
  33 /**
  34
  35 [Have a look at math_inset.h first]
  36
  37 The MathCursor is different from the kind of cursor used in the Outer
  38 World. It contains a stack of MathCursorPositions, each of which is made
  39 up of a inset pointer, an index and a position offset, marking a path from
  40 this formula's mathHullInset to the current position.
  41
  42 */
  43
  44
  45 class MathCursor {
  46 public:
  47         /// short of anything else reasonable
  48         typedef MathInset::size_type       size_type;
  49         /// type for cursor positions within a cell
  50         typedef MathInset::pos_type        pos_type;
  51         /// type for cell indices
  52         typedef MathInset::idx_type        idx_type;
  53         /// type for row numbers
  54         typedef MathInset::row_type        row_type;
  55         /// type for column numbers
  56         typedef MathInset::col_type        col_type;
  57         /// how to store a cursor
  58         typedef std::vector<MathCursorPos> cursor_type;
  59
  60         ///
  61         explicit MathCursor(InsetFormulaBase *, bool left);
  62         ///
  63         void insert(MathAtom const &);
  64         ///
  65         void insert(MathArray const &);
  66         ///
  67         void paste(MathArray const &);
  68         ///
  69         void erase();
  70         ///
  71         void backspace();
  72         /// called for LFUN_HOME etc
  73         void home(bool sel = false);
  74         /// called for LFUN_END etc
  75         void end(bool sel = false);
  76         /// called for LFUN_RIGHT and LFUN_RIGHTSEL
  77         bool right(bool sel = false);
  78         /// called for LFUN_LEFT etc
  79         bool left(bool sel = false);
  80         /// called for LFUN_UP etc
  81         bool up(bool sel = false);
  82         /// called for LFUN_DOWN etc
  83         bool down(bool sel = false);
  84         /// Put the cursor in the first position
  85         void first();
  86         /// Put the cursor in the last position
  87         void last();
  88         /// move to next cell in current inset
  89         void idxNext();
  90         /// move to previous cell in current inset
  91         void idxPrev();
  92         ///
  93         void plainErase();
  94         ///
  95         void plainInsert(MathAtom const &);
  96         ///
  97         void niceInsert(MathAtom const &);
  98
  99         ///
 100         void delLine();
 101         /// in pixels from top of screen
 102         void setPos(int x, int y);
 103         /// in pixels from top of screen
 104         void getPos(int & x, int & y);
 105         ///
 106         MathAtom & par() const;
 107         /// return the next enclosing grid inset and the cursor's index in it
 108         MathGridInset * enclosingGrid(idx_type &) const;
 109         ///
 110         InsetFormulaBase * formula();
 111         /// current offset in the current cell
 112         pos_type pos() const;
 113         /// current cell
 114         idx_type idx() const;
 115         /// size of current cell
 116         size_type size() const;
 117         ///
 118         bool interpret(string const &);
 119         ///
 120         bool interpret(char);
 121         ///
 122         bool toggleLimits();
 123         /// interpret name a name of a macro
 124         void macroModeClose();
 125         ///
 126         bool inMacroMode() const;
 127
 128         // Local selection methods
 129         ///
 130         bool selection() const;
 131         ///
 132         void selCopy();
 133         ///
 134         void selCut();
 135         ///
 136         void selDel();
 137         ///
 138         void selPaste();
 139         ///
 140         void selHandle(bool);
 141         ///
 142         void selStart();
 143         ///
 144         void selClear();
 145         ///
 146         void selGet(MathArray & ar);
 147         ///
 148         void drawSelection(Painter & pain) const;
 149         ///
 150         void handleFont(MathTextCodes t);
 151         ///
 152         void handleDelim(string const & l, string const & r);
 153         ///
 154         void handleNest(MathInset * p);
 155         /// splits cells and shifts right part to the next cell
 156         void splitCell();
 157         /// splits line and insert new row of cell
 158         void breakLine();
 159         /// read contents of line into an array
 160         void readLine(MathArray & ar) const;
 161         ///
 162         MathTextCodes getLastCode() const;
 163         ///
 164         void pullArg(bool goright);
 165         ///
 166         bool isInside(MathInset const *) const;
 167         ///
 168         MathTextCodes nextCode() const;
 169         ///
 170         char valign() const;
 171         ///
 172         char halign() const;
 173         ///
 174         col_type ncols() const;
 175         ///
 176         col_type col() const;
 177         ///
 178         row_type row() const;
 179
 180         /// make sure cursor position is valid
 181         void normalize() const;
 182         ///
 183         UpdatableInset * asHyperActiveInset() const;
 184
 185         /// enter a MathInset
 186         void push(MathAtom & par);
 187         /// enter a MathInset from the front
 188         void pushLeft(MathAtom & par);
 189         /// enter a MathInset from the back
 190         void pushRight(MathAtom & par);
 191         /// leave current MathInset to the left
 192         bool popLeft();
 193         /// leave current MathInset to the left
 194         bool popRight();
 195
 196         ///
 197         MathArray & array() const;
 198         ///
 199         MathXArray & xarray() const;
 200         ///
 201         bool hasPrevAtom() const;
 202         ///
 203         bool hasNextAtom() const;
 204         ///
 205         MathAtom const & prevAtom() const;
 206         ///
 207         MathAtom & prevAtom();
 208         ///
 209         MathAtom const & nextAtom() const;
 210         ///
 211         MathAtom & nextAtom();
 212
 213         /// returns the selection
 214         void getSelection(MathCursorPos &, MathCursorPos &) const;
 215         /// returns the normalized anchor of the selection
 216         MathCursorPos normalAnchor() const;
 217
 218         /// path of positions the cursor had to go if it were leving each inset
 219         cursor_type Cursor_;
 220         /// path of positions the anchor had to go if it were leving each inset
 221         cursor_type Anchor_;
 222
 223         /// reference to the last item of the path, i.e. "The Cursor"
 224         MathCursorPos & cursor();
 225         /// reference to the last item of the path, i.e. "The Cursor"
 226         MathCursorPos const & cursor() const;
 227
 228         /// dump selection information for debugging
 229         void seldump(char const * str) const;
 230         /// dump selection information for debugging
 231         void dump(char const * str) const;
 232         ///
 233         void stripFromLastEqualSign();
 234
 235         ///
 236         friend class Selection;
 237
 238 private:
 239         /// moves cursor position one cell to the left
 240         bool posLeft();
 241         /// moves cursor position one cell to the right
 242         bool posRight();
 243         /// moves cursor index one cell to the left
 244         bool idxLeft();
 245         /// moves cursor index one cell to the right
 246         bool idxRight();
 247         /// moves position somehow up
 248         bool goUp();
 249         /// moves position somehow down
 250         bool goDown();
 251         /// moves position into box
 252         bool bruteFind(int xlow, int xhigh, int ylow, int yhigh);
 253
 254         ///
 255         string macroName() const;
 256         ///
 257         int macroNamePos() const;
 258         ///
 259         void insert(char, MathTextCodes t);
 260         /// can we enter the inset?
 261         bool openable(MathAtom const &, bool selection) const;
 262         /// write access to cursor cell position
 263         pos_type & pos();
 264         /// write access to cursor cell index
 265         idx_type & idx();
 266
 267         ///
 268         InsetFormulaBase * formula_;
 269         ///
 270         MathTextCodes lastcode_;
 271         // Selection stuff
 272         /// do we currently select
 273         bool selection_;
 274 };
 275
 276 extern MathCursor * mathcursor;
 277
 278 #endif