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