src/cursor.h

   1 // -*- C++ -*-
   2 /**
   3  * \file 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 André Pönitz
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef CURSOR_H
  13 #define CURSOR_H
  14
  15 #include "dispatchresult.h"
  16 #include "dociterator.h"
  17
  18 #include <iosfwd>
  19 #include <vector>
  20
  21 class BufferView;
  22 class FuncStatus;
  23 class FuncRequest;
  24
  25 // these should go
  26 class MathUnknownInset;
  27 class Encoding;
  28
  29
  30 /// The cursor class describes the position of a cursor within a document.
  31
  32 // The public inheritance should go in favour of a suitable data member
  33 // (or maybe private inheritance) at some point of time.
  34 class LCursor : public DocIterator {
  35 public:
  36         /// create the cursor of a BufferView
  37         explicit LCursor(BufferView & bv);
  38
  39         /// dispatch from innermost inset upwards
  40         DispatchResult dispatch(FuncRequest const & cmd);
  41         /// are we willing to handle this event?
  42         bool getStatus(FuncRequest const & cmd, FuncStatus & flag);
  43
  44         /// add a new cursor slice
  45         void push(InsetBase & inset);
  46         /// add a new cursor slice, place cursor on left end
  47         void pushLeft(InsetBase & inset);
  48         /// pop one level off the cursor
  49         void pop();
  50         /// pop one slice off the cursor stack and go left
  51         bool popLeft();
  52         /// pop one slice off the cursor stack and go right
  53         bool popRight();
  54         /// sets cursor part
  55         void setCursor(DocIterator const & it, bool sel);
  56
  57         //
  58         // selection
  59         //
  60         /// selection active?
  61         bool selection() const { return selection_; }
  62         /// selection active?
  63         bool & selection() { return selection_; }
  64         /// did we place the anchor?
  65         bool mark() const { return mark_; }
  66         /// did we place the anchor?
  67         bool & mark() { return mark_; }
  68         ///
  69         void setSelection();
  70         /// set selection at given position
  71         void setSelection(DocIterator const & where, size_t n);
  72         ///
  73         void clearSelection();
  74         /// access start of selection
  75         CursorSlice selBegin() const;
  76         /// access end of selection
  77         CursorSlice selEnd() const;
  78         /// access start of selection
  79         DocIterator selectionBegin() const;
  80         /// access start of selection
  81         DocIterator selectionEnd() const;
  82         ///
  83         std::string grabSelection();
  84         ///
  85         void eraseSelection();
  86         ///
  87         std::string grabAndEraseSelection();
  88         // other selection methods
  89         ///
  90         void selCopy();
  91         ///
  92         void selCut();
  93         ///
  94         void selDel();
  95         /// pastes n-th element of cut buffer
  96         void selPaste(size_t n);
  97         ///
  98         void selHandle(bool selecting);
  99         /// clears or deletes selection depending on lyxrc setting
 100         void selClearOrDel();
 101         //
 102         std::string selectionAsString(bool label) const;
 103         ///
 104         void paste(std::string const & data);
 105         ///
 106         std::string currentState();
 107
 108         /// auto-correct mode
 109         bool autocorrect() const { return autocorrect_; }
 110         /// auto-correct mode
 111         bool & autocorrect() { return autocorrect_; }
 112         /// are we entering a macro name?
 113         bool macromode() const { return macromode_; }
 114         /// are we entering a macro name?
 115         bool & macromode() { return macromode_; }
 116         /// returns x,y position
 117         void getPos(int & x, int & y) const;
 118         /// returns cursor dimension
 119         void getDim(int & asc, int & desc) const;
 120
 121         //
 122         // common part
 123         //
 124         /// move one step to the left
 125         bool posLeft();
 126         /// move one step to the right
 127         bool posRight();
 128
 129         /// insert an inset
 130         void insert(InsetBase *);
 131         /// insert a single char
 132         void insert(char c);
 133         /// insert a string
 134         void insert(std::string const & str);
 135
 136         /// write acess to target x position of cursor
 137         int & x_target();
 138         /// return target x position of cursor
 139         int x_target() const;
 140         /// clear target x position of cursor
 141         void clearTargetX();
 142
 143         /// access to normalized selection anchor
 144         CursorSlice anchor() const;
 145         /// sets anchor to cursor position
 146         void resetAnchor();
 147         /// access to owning BufferView
 148         BufferView & bv() const;
 149         /// get some interesting description of top position
 150         void info(std::ostream & os) const;
 151         /// are we in math mode (2), text mode (1) or unsure (0)?
 152         int currentMode();
 153         /// reset cursor bottom to the beginning of the given inset
 154         // (sort of 'chroot' environment...)
 155         void reset(InsetBase &);
 156         /// for spellchecking
 157         void replaceWord(std::string const & replacestring);
 158         /// update our view
 159         void update();
 160         /// the event was not (yet) dispatched
 161         void undispatched();
 162         /// the event was already dispatched
 163         void dispatched();
 164         /// don't call update() when done
 165         void noUpdate();
 166
 167         /// output
 168         friend std::ostream & operator<<(std::ostream & os, LCursor const & cur);
 169
 170 public:
 171         ///
 172         BufferView * bv_;
 173 //private:
 174         /// the anchor position
 175         DocIterator anchor_;
 176
 177         ///
 178         DispatchResult disp_;
 179
 180 private:
 181         /**
 182          * The target x position of the cursor. This is used for when
 183          * we have text like :
 184          *
 185          * blah blah blah blah| blah blah blah
 186          * blah blah blah
 187          * blah blah blah blah blah blah
 188          *
 189          * When we move onto row 3, we would like to be vertically aligned
 190          * with where we were in row 1, despite the fact that row 2 is
 191          * shorter than x()
 192          */
 193         int x_target_;
 194         /// do we have a selection?
 195         bool selection_;
 196         /// are we on the way to get one?
 197         bool mark_;
 198
 199         //
 200         // math specific stuff that could be promoted to "global" later
 201         //
 202         /// do we allow autocorrection
 203         bool autocorrect_;
 204         /// are we entering a macro name?
 205         bool macromode_;
 206
 207
 208 ///////////////////////////////////////////////////////////////////
 209 //
 210 // The part below is the non-integrated rest of the original math
 211 // cursor. This should be either generalized for texted or moved
 212 // back to the math insets.
 213 //
 214 ///////////////////////////////////////////////////////////////////
 215
 216 public:
 217         ///
 218         void insert(MathAtom const &);
 219         ///
 220         void insert(MathArray const &);
 221         /// return false for empty math insets
 222         bool erase();
 223         /// return false for empty math insets
 224         bool backspace();
 225         /// called for LFUN_UP etc
 226         bool up();
 227         /// called for LFUN_DOWN etc
 228         bool down();
 229         ///
 230         void plainErase();
 231         ///
 232         void plainInsert(MathAtom const & at);
 233         ///
 234         void niceInsert(MathAtom const & at);
 235         ///
 236         void niceInsert(std::string const & str);
 237
 238         /// in pixels from top of screen
 239         void setScreenPos(int x, int y);
 240         /// in pixels from left of screen
 241         int targetX() const;
 242         /// current offset in the top cell
 243         /// interpret name a name of a macro
 244         void macroModeClose();
 245         /// are we currently typing the name of a macro?
 246         bool inMacroMode() const;
 247         /// get access to the macro we are currently typing
 248         MathUnknownInset * activeMacro();
 249
 250         /// replace selected stuff with at, placing the former
 251         // selection in given cell of atom
 252         void handleNest(MathAtom const & at, int cell = 0);
 253         ///
 254         bool isInside(InsetBase const *);
 255
 256         /// make sure cursor position is valid
 257         void normalize();
 258         /// mark current cursor trace for redraw
 259         void touch();
 260
 261         /// hack for reveal codes
 262         void markInsert();
 263         void markErase();
 264         /// injects content of a cell into parent
 265         void pullArg();
 266         /// split font inset etc
 267         void handleFont(std::string const & font);
 268
 269         /// display a message
 270         void message(std::string const & msg) const;
 271         /// display an error message
 272         void errorMessage(std::string const & msg) const;
 273         ///
 274         std::string getPossibleLabel();
 275
 276         /// moves position somehow up or down
 277         bool goUpDown(bool up);
 278
 279         /// the name of the macro we are currently inputting
 280         std::string macroName();
 281         /// where in the curent cell does the macro name start?
 282         int macroNamePos();
 283         /// can we enter the inset?
 284         bool openable(MathAtom const &) const;
 285         ///
 286         Encoding const * getEncoding() const;
 287
 288 private:
 289         /// moves position closest to (x, y) in current cell
 290         void bruteFind2(int x, int y);
 291         /// moves position closest to (x, y) in given box
 292         bool bruteFind(int x, int y, int xlow, int xhigh, int ylow, int yhigh);
 293 };
 294
 295 #endif // LYXCURSOR_H