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_inset.h"
  25 #include "math_iterator.h"
  26 #include "LString.h"
  27
  28 class InsetFormulaBase;
  29 class BufferView;
  30 class MathPainterInfo;
  31 class MathUnknownInset;
  32 class Selection;
  33
  34 /**
  35
  36 [Have a look at math_inset.h first]
  37
  38 The MathCursor is different from the kind of cursor used in the Outer
  39 World. It contains a stack of MathCursorPos, each of which is made
  40 up of a inset pointer, an index and a position offset, marking a path from
  41 this formula's MathHullInset to the current position.
  42
  43 */
  44
  45
  46 class MathCursor {
  47 public:
  48         /// short of anything else reasonable
  49         typedef MathInset::size_type       size_type;
  50         /// type for cursor positions within a cell
  51         typedef MathInset::pos_type        pos_type;
  52         /// type for cell indices
  53         typedef MathInset::idx_type        idx_type;
  54         /// type for row numbers
  55         typedef MathInset::row_type        row_type;
  56         /// type for column numbers
  57         typedef MathInset::col_type        col_type;
  58
  59         ///
  60         explicit MathCursor(InsetFormulaBase *, bool left);
  61         ///
  62         ~MathCursor();
  63         ///
  64         void insert(MathAtom const &);
  65         ///
  66         void insert(MathArray const &);
  67         ///
  68         void paste(string const & data);
  69         ///
  70         void erase();
  71         ///
  72         void backspace();
  73         /// called for LFUN_HOME etc
  74         bool home(bool sel = false);
  75         /// called for LFUN_END etc
  76         bool end(bool sel = false);
  77         /// called for LFUN_RIGHT and LFUN_RIGHTSEL
  78         bool right(bool sel = false);
  79         /// called for LFUN_LEFT etc
  80         bool left(bool sel = false);
  81         /// called for LFUN_UP etc
  82         bool up(bool sel = false);
  83         /// called for LFUN_DOWN etc
  84         bool down(bool sel = false);
  85         /// Put the cursor in the first position
  86         void first();
  87         /// Put the cursor in the last position
  88         void last();
  89         /// move to next cell in current inset
  90         void idxNext();
  91         /// move to previous cell in current inset
  92         void idxPrev();
  93         ///
  94         void plainErase();
  95         ///
  96         void plainInsert(MathAtom const &);
  97         ///
  98         void niceInsert(MathAtom const &);
  99         ///
 100         void niceInsert(string const &);
 101
 102         /// in pixels from top of screen
 103         void setPos(int x, int y);
 104         /// in pixels from top of screen
 105         void getPos(int & x, int & y) const;
 106         /// in pixels from left of screen
 107         int targetX() const;
 108         /// current inset
 109         MathInset * par() const;
 110         /// return the next enclosing grid inset and the cursor's index in it
 111         MathGridInset * enclosingGrid(idx_type & idx) const;
 112         /// go up to enclosing grid
 113         void popToEnclosingGrid();
 114         /// go up to the hull inset
 115         void popToEnclosingHull();
 116         /// go up to the hull inset
 117         void popToHere(MathInset const * p);
 118         ///
 119         InsetFormulaBase * formula() const;
 120         /// current offset in the current cell
 121         pos_type pos() const;
 122         /// current cell
 123         idx_type idx() const;
 124         /// size of current cell
 125         size_type size() const;
 126         ///
 127         bool script(bool);
 128         ///
 129         bool interpret(char);
 130         /// interpret name a name of a macro
 131         void macroModeClose();
 132         /// are we currently typing the name of a macro?
 133         bool inMacroMode() const;
 134         /// get access to the macro we are currently typing
 135         MathUnknownInset * activeMacro();
 136         /// get access to the macro we are currently typing
 137         MathUnknownInset const * activeMacro() const;
 138         /// are we currently typing '#1' or '#2' or...?
 139         bool inMacroArgMode() const;
 140         /// are we in math mode (1), text mode (-1) or unsure?
 141         MathInset::mode_type currentMode() const;
 142
 143         // Local selection methods
 144         ///
 145         bool selection() const;
 146         ///
 147         void selCopy();
 148         ///
 149         void selCut();
 150         ///
 151         void selDel();
 152         ///
 153         void selPaste();
 154         ///
 155         void selHandle(bool);
 156         ///
 157         void selStart();
 158         ///
 159         void selClear();
 160         /// clears or deletes selection depending on lyxrc setting
 161         void selClearOrDel();
 162         /// draws light-blue selection background
 163         void drawSelection(MathPainterInfo & pi) const;
 164         ///
 165         void handleNest(MathAtom const & at);
 166         /// remove this as soon as LyXFunc::getStatus is "localized"
 167         string getLastCode() const { return "mathnormal"; }
 168         ///
 169         bool isInside(MathInset const *) const;
 170         ///
 171         char valign() const;
 172         ///
 173         char halign() const;
 174
 175         /// make sure cursor position is valid
 176         void normalize();
 177         /// mark current cursor trace for redraw
 178         void touch();
 179         ///
 180         UpdatableInset * asHyperActiveInset() const;
 181
 182         /// enter a MathInset
 183         void push(MathAtom & par);
 184         /// enter a MathInset from the front
 185         void pushLeft(MathAtom & par);
 186         /// enter a MathInset from the back
 187         void pushRight(MathAtom & par);
 188         /// leave current MathInset to the left
 189         bool popLeft();
 190         /// leave current MathInset to the left
 191         bool popRight();
 192
 193         ///
 194         MathArray & array() const;
 195         ///
 196         bool hasPrevAtom() const;
 197         ///
 198         bool hasNextAtom() const;
 199         ///
 200         MathAtom const & prevAtom() const;
 201         ///
 202         MathAtom & prevAtom();
 203         ///
 204         MathAtom const & nextAtom() const;
 205         ///
 206         MathAtom & nextAtom();
 207
 208         /// returns the selection
 209         void getSelection(MathCursorPos &, MathCursorPos &) const;
 210         /// returns the normalized anchor of the selection
 211         MathCursorPos normalAnchor() const;
 212
 213         /// reference to the last item of the path, i.e. "The Cursor"
 214         MathCursorPos & cursor();
 215         /// reference to the last item of the path, i.e. "The Cursor"
 216         MathCursorPos const & cursor() const;
 217         /// how deep are we nested?
 218         unsigned depth() const;
 219
 220         /// local dispatcher
 221         MathInset::result_type dispatch(FuncRequest const & cmd);
 222         /// describe the situation
 223         string info() const;
 224         /// dump selection information for debugging
 225         void seldump(char const * str) const;
 226         /// dump selection information for debugging
 227         void dump(char const * str) const;
 228         /// moves on
 229         void setSelection(MathIterator const & where, size_type n);
 230         ///
 231         void insert(char c);
 232         ///
 233         void insert(string const & str);
 234         /// lock/unlock inset
 235         void insetToggle();
 236
 237         /// hack for reveal codes
 238         void markInsert();
 239         void markErase();
 240         //void handleExtern(string const & arg);
 241
 242         ///
 243         friend class Selection;
 244
 245
 246 private:
 247         /// injects content of a cell into parent
 248         void pullArg();
 249         /// moves cursor index one cell to the left
 250         bool idxLeft();
 251         /// moves cursor index one cell to the right
 252         bool idxRight();
 253         /// moves cursor to end of last cell of current line
 254         bool idxLineLast();
 255         /// moves cursor position one cell to the left
 256         bool posLeft();
 257         /// moves cursor position one cell to the right
 258         bool posRight();
 259         /// moves position somehow up or down
 260         bool goUpDown(bool up);
 261         /// moves position closest to (x, y) in given box
 262         bool bruteFind(int x, int y, int xlow, int xhigh, int ylow, int yhigh);
 263         /// moves position closest to (x, y) in current cell
 264         void bruteFind2(int x, int y);
 265         /// are we in a nucleus of a script inset?
 266         bool inNucleus() const;
 267
 268         /// grab selection marked by anchor and current cursor
 269         string grabSelection() const;
 270         /// erase the selected part and re-sets the cursor
 271         void eraseSelection();
 272         /// guess what
 273         string grabAndEraseSelection();
 274
 275         /// the name of the macro we are currently inputting
 276         string macroName() const;
 277         /// where in the curent cell does the macro name start?
 278         MathInset::difference_type macroNamePos() const;
 279         /// can we enter the inset?
 280         bool openable(MathAtom const &, bool selection) const;
 281         /// write access to cursor cell position
 282         pos_type & pos();
 283         /// write access to cursor cell index
 284         idx_type & idx();
 285
 286         /// path of positions the cursor had to go if it were leaving each inset
 287         MathIterator Cursor_;
 288         /// path of positions the anchor had to go if it were leaving each inset
 289         mutable MathIterator Anchor_;
 290         /// pointer to enclsing LyX inset
 291         InsetFormulaBase * formula_;
 292         // Selection stuff
 293         /// text code of last char entered
 294         //MathTextCodes lastcode_;
 295         /// do we allow autocorrection
 296         bool autocorrect_;
 297         /// do we currently select
 298         bool selection_;
 299         /// are we entering a macro name?
 300         bool macromode_;
 301         /// are we targeting a certain x coordinate, if so, which one?
 302         int targetx_;
 303 };
 304
 305 extern MathCursor * mathcursor;
 306 void releaseMathCursor(BufferView * bv);
 307
 308 #endif