src/mathed/math_cursor.h

   1 // -*- C++ -*-
   2 /**
   3  * \file math_cursor.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Alejandro Aguilar Sierra
   8  * \author André Pönitz
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #ifndef MATH_CURSOR
  14 #define MATH_CURSOR
  15
  16
  17 #include "math_inset.h"
  18 #include "math_iterator.h"
  19
  20 #include <string>
  21
  22
  23 class InsetFormulaBase;
  24 class BufferView;
  25 class PainterInfo;
  26 class MathUnknownInset;
  27
  28 /**
  29
  30 [Have a look at math_inset.h first]
  31
  32 The MathCursor is different from the kind of cursor used in the Outer
  33 World. It contains a stack of CursorPos, each of which is made
  34 up of a inset pointer, an index and a position offset, marking a path from
  35 this formula's MathHullInset to the current position.
  36
  37 */
  38
  39
  40 class MathCursor {
  41 public:
  42         /// short of anything else reasonable
  43         typedef MathInset::size_type       size_type;
  44         /// type for column numbers
  45         typedef MathArray::difference_type difference_type;
  46         /// type for cursor positions within a cell
  47         typedef MathInset::pos_type        pos_type;
  48         /// type for cell indices
  49         typedef MathInset::idx_type        idx_type;
  50         /// type for row numbers
  51         typedef MathInset::row_type        row_type;
  52         /// type for column numbers
  53         typedef MathInset::col_type        col_type;
  54
  55         ///
  56         explicit MathCursor(InsetFormulaBase *, bool left);
  57         ///
  58         ~MathCursor();
  59         ///
  60         void insert(MathAtom const &);
  61         ///
  62         void insert(MathArray const &);
  63         ///
  64         void insert2(std::string const &);
  65         ///
  66         void paste(std::string const & data);
  67         /// return false for empty math insets
  68         bool erase();
  69         /// return false for empty math insets
  70         bool backspace();
  71         /// called for LFUN_HOME etc
  72         bool home(bool sel = false);
  73         /// called for LFUN_END etc
  74         bool end(bool sel = false);
  75         /// called for LFUN_RIGHT and LFUN_RIGHTSEL
  76         bool right(bool sel = false);
  77         /// called for LFUN_LEFT etc
  78         bool left(bool sel = false);
  79         /// called for LFUN_UP etc
  80         bool up(bool sel = false);
  81         /// called for LFUN_DOWN etc
  82         bool down(bool sel = false);
  83         /// Put the cursor in the first position
  84         void first();
  85         /// Put the cursor in the last position
  86         void last();
  87         /// move to next cell in current inset
  88         void idxNext();
  89         /// move to previous cell in current inset
  90         void idxPrev();
  91         ///
  92         void plainErase();
  93         ///
  94         void plainInsert(MathAtom const &);
  95         ///
  96         void niceInsert(MathAtom const &);
  97         ///
  98         void niceInsert(std::string const &);
  99
 100         /// in pixels from top of screen
 101         void setPos(int x, int y);
 102         /// in pixels from top of screen
 103         void getPos(int & x, int & y) const;
 104         /// in pixels from left of screen
 105         int targetX() const;
 106         /// current inset
 107         MathInset * inset() const;
 108         /// return the next enclosing grid inset and the cursor's index in it
 109         MathGridInset * enclosingGrid(idx_type & idx) const;
 110         /// go up to enclosing grid
 111         void popToEnclosingGrid();
 112         /// go up to the hull inset
 113         void popToEnclosingHull();
 114         /// go up to the hull inset
 115         void popToHere(MathInset const * p);
 116         /// adjust anchor position after deletions/insertions
 117         void adjust(pos_type from, difference_type diff);
 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         /// pastes n-th element of cut buffer
 153         void selPaste(size_t n);
 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(PainterInfo & pi) const;
 164         /// replace selected stuff with at, placing the former
 165         // selection in given cell of atom
 166         void handleNest(MathAtom const & at, int cell = 0);
 167         /// remove this as soon as LyXFunc::getStatus is "localized"
 168         std::string getLastCode() const { return "mathnormal"; }
 169         ///
 170         bool isInside(MathInset const *) const;
 171         ///
 172         char valign() const;
 173         ///
 174         char halign() const;
 175
 176         /// make sure cursor position is valid
 177         void normalize();
 178         /// mark current cursor trace for redraw
 179         void touch();
 180         ///
 181         UpdatableInset * asHyperActiveInset() const;
 182
 183         /// enter a MathInset
 184         void push(MathAtom & par);
 185         /// enter a MathInset from the front
 186         void pushLeft(MathAtom & par);
 187         /// enter a MathInset from the back
 188         void pushRight(MathAtom & par);
 189         /// leave current MathInset to the left
 190         bool popLeft();
 191         /// leave current MathInset to the left
 192         bool popRight();
 193
 194         ///
 195         MathArray & array() const;
 196         ///
 197         bool hasPrevAtom() const;
 198         ///
 199         bool hasNextAtom() const;
 200         ///
 201         MathAtom const & prevAtom() const;
 202         ///
 203         MathAtom & prevAtom();
 204         ///
 205         MathAtom const & nextAtom() const;
 206         ///
 207         MathAtom & nextAtom();
 208
 209         /// returns the selection
 210         void getSelection(CursorPos &, CursorPos &) const;
 211         /// returns the normalized anchor of the selection
 212         CursorPos normalAnchor() const;
 213
 214         /// reference to the last item of the path, i.e. "The Cursor"
 215         CursorPos & cursor();
 216         /// reference to the last item of the path, i.e. "The Cursor"
 217         CursorPos const & cursor() const;
 218         /// how deep are we nested?
 219         unsigned depth() const;
 220         /// describe the situation
 221         std::string info() const;
 222         /// dump selection information for debugging
 223         void seldump(char const * str) const;
 224         /// dump selection information for debugging
 225         void dump(char const * str) const;
 226         /// moves on
 227         void setSelection(MathIterator const & where, size_type n);
 228         /// grab selection marked by anchor and current cursor
 229         std::string grabSelection() const;
 230         /// guess what
 231         std::string grabAndEraseSelection();
 232         ///
 233         void insert(char c);
 234         ///
 235         void insert(std::string const & str);
 236         /// lock/unlock inset
 237         void insetToggle();
 238
 239         /// hack for reveal codes
 240         void markInsert();
 241         void markErase();
 242         /// injects content of a cell into parent
 243         void pullArg();
 244         /// split font inset etc
 245         void handleFont(std::string const & font);
 246         ///
 247         DispatchResult
 248         dispatch(FuncRequest const & cmd);
 249 private:
 250         /// moves cursor index one cell to the left
 251         bool idxLeft();
 252         /// moves cursor index one cell to the right
 253         bool idxRight();
 254         /// moves cursor to end of last cell of current line
 255         bool idxLineLast();
 256         /// moves cursor position one cell to the left
 257         bool posLeft();
 258         /// moves cursor position one cell to the right
 259         bool posRight();
 260         /// moves position somehow up or down
 261         bool goUpDown(bool up);
 262         /// moves position closest to (x, y) in given box
 263         bool bruteFind(int x, int y, int xlow, int xhigh, int ylow, int yhigh);
 264         /// moves position closest to (x, y) in current cell
 265         void bruteFind2(int x, int y);
 266         /// are we in a nucleus of a script inset?
 267         bool inNucleus() const;
 268
 269         /// erase the selected part and re-sets the cursor
 270         void eraseSelection();
 271
 272         /// the name of the macro we are currently inputting
 273         std::string macroName() const;
 274         /// where in the curent cell does the macro name start?
 275         difference_type macroNamePos() const;
 276         /// can we enter the inset?
 277         bool openable(MathAtom const &, bool selection) const;
 278         /// write access to cursor cell position
 279         pos_type & pos();
 280         /// write access to cursor cell index
 281         idx_type & idx();
 282
 283         /// path of positions the cursor had to go if it were leaving each inset
 284         MathIterator Cursor_;
 285         /// path of positions the anchor had to go if it were leaving each inset
 286         mutable MathIterator Anchor_;
 287         /// pointer to enclsing LyX inset
 288         InsetFormulaBase * formula_;
 289         // Selection stuff
 290         /// text code of last char entered
 291         //MathTextCodes lastcode_;
 292         /// do we allow autocorrection
 293         bool autocorrect_;
 294         /// do we currently select
 295         bool selection_;
 296         /// are we entering a macro name?
 297         bool macromode_;
 298         /// are we targeting a certain x coordinate, if so, which one?
 299         int targetx_;
 300 };
 301
 302 extern MathCursor * mathcursor;
 303 void releaseMathCursor(BufferView * bv);
 304
 305 #endif