]> git.lyx.org Git - features.git/blobdiff - src/mathed/math_cursor.h
Replace LString.h with support/std_string.h,
[features.git] / src / mathed / math_cursor.h
index fae5867490b95784e71310b1fa48571092feedb2..4df0b822d8eec69a7a87ab539c53ad663990070e 100644 (file)
@@ -1,42 +1,34 @@
 // -*- C++ -*-
-/*
- *  File:        math_cursor.h
- *  Purpose:     Declaration of interaction classes for mathed
- *  Author:      Alejandro Aguilar Sierra <asierra@servidor.unam.mx>
- *  Created:     January 1996
- *  Description: MathCursor control all user interaction
- *
- *  Dependencies: Xlib, XForms
+/**
+ * \file math_cursor.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
  *
- *  Copyright: 1996, Alejandro Aguilar Sierra
+ * \author Alejandro Aguilar Sierra
+ * \author André Pönitz
  *
- *   You are free to use and modify this code under the terms of
- *   the GNU General Public Licence version 2 or later.
+ * Full author contact details are available in file CREDITS.
  */
 
 #ifndef MATH_CURSOR
 #define MATH_CURSOR
 
-#ifdef __GNUG__
-#pragma interface
-#endif
 
 #include "math_inset.h"
 #include "math_iterator.h"
-#include "LString.h"
+#include "support/std_string.h"
 
 class InsetFormulaBase;
 class BufferView;
-class MathPainterInfo;
+class PainterInfo;
 class MathUnknownInset;
-class Selection;
 
 /**
 
 [Have a look at math_inset.h first]
 
 The MathCursor is different from the kind of cursor used in the Outer
-World. It contains a stack of MathCursorPos, each of which is made
+World. It contains a stack of CursorPos, each of which is made
 up of a inset pointer, an index and a position offset, marking a path from
 this formula's MathHullInset to the current position.
 
@@ -47,6 +39,8 @@ class MathCursor {
 public:
        /// short of anything else reasonable
        typedef MathInset::size_type       size_type;
+       /// type for column numbers
+       typedef MathArray::difference_type difference_type;
        /// type for cursor positions within a cell
        typedef MathInset::pos_type        pos_type;
        /// type for cell indices
@@ -65,13 +59,13 @@ public:
        ///
        void insert(MathArray const &);
        ///
-       void paste(MathArray const &);
+       void insert2(string const &);
        ///
-       void paste(MathGridInset const & data);
-       ///
-       void erase();
-       ///
-       void backspace();
+       void paste(string const & data);
+       /// return false for empty math insets
+       bool erase();
+       /// return false for empty math insets
+       bool backspace();
        /// called for LFUN_HOME etc
        bool home(bool sel = false);
        /// called for LFUN_END etc
@@ -98,23 +92,27 @@ public:
        void plainInsert(MathAtom const &);
        ///
        void niceInsert(MathAtom const &);
-
        ///
-       void delLine();
+       void niceInsert(string const &);
+
        /// in pixels from top of screen
        void setPos(int x, int y);
        /// in pixels from top of screen
-       void getPos(int & x, int & y);
+       void getPos(int & x, int & y) const;
+       /// in pixels from left of screen
+       int targetX() const;
        /// current inset
-       MathInset * par() const;
+       MathInset * inset() const;
        /// return the next enclosing grid inset and the cursor's index in it
        MathGridInset * enclosingGrid(idx_type & idx) const;
-       /// return the next enclosing hull inset and the cursor's index in it
-       MathHullInset * enclosingHull(idx_type & idx) const;
        /// go up to enclosing grid
        void popToEnclosingGrid();
        /// go up to the hull inset
        void popToEnclosingHull();
+       /// go up to the hull inset
+       void popToHere(MathInset const * p);
+       /// adjust anchor position after deletions/insertions
+       void adjust(pos_type from, difference_type diff);
        ///
        InsetFormulaBase * formula() const;
        /// current offset in the current cell
@@ -126,11 +124,7 @@ public:
        ///
        bool script(bool);
        ///
-       bool interpret(string const &);
-       /// 
        bool interpret(char);
-       ///
-       bool toggleLimits();
        /// interpret name a name of a macro
        void macroModeClose();
        /// are we currently typing the name of a macro?
@@ -153,8 +147,8 @@ public:
        void selCut();
        ///
        void selDel();
-       ///
-       void selPaste();
+       /// pastes n-th element of cut buffer
+       void selPaste(size_t n);
        ///
        void selHandle(bool);
        ///
@@ -163,18 +157,10 @@ public:
        void selClear();
        /// clears or deletes selection depending on lyxrc setting
        void selClearOrDel();
-       ///
-       void selGet(MathArray & ar);
-       ///
-       void drawSelection(MathPainterInfo & pain) const;
+       /// draws light-blue selection background
+       void drawSelection(PainterInfo & pi) const;
        ///
        void handleNest(MathAtom const & at);
-       /// splits cells and shifts right part to the next cell
-       void splitCell();
-       /// splits line and insert new row of cell
-       void breakLine();
-       /// read contents of line into an array
-       void readLine(MathArray & ar) const;
        /// remove this as soon as LyXFunc::getStatus is "localized"
        string getLastCode() const { return "mathnormal"; }
        ///
@@ -183,14 +169,6 @@ public:
        char valign() const;
        ///
        char halign() const;
-       ///
-       col_type hullCol() const;
-       ///
-       row_type hullRow() const;
-       ///
-       col_type gridCol() const;
-       ///
-       row_type gridRow() const;
 
        /// make sure cursor position is valid
        void normalize();
@@ -226,19 +204,19 @@ public:
        MathAtom & nextAtom();
 
        /// returns the selection
-       void getSelection(MathCursorPos &, MathCursorPos &) const;
+       void getSelection(CursorPos &, CursorPos &) const;
        /// returns the normalized anchor of the selection
-       MathCursorPos normalAnchor() const;
+       CursorPos normalAnchor() const;
 
        /// reference to the last item of the path, i.e. "The Cursor"
-       MathCursorPos & cursor();
+       CursorPos & cursor();
        /// reference to the last item of the path, i.e. "The Cursor"
-       MathCursorPos const & cursor() const;
+       CursorPos const & cursor() const;
        /// how deep are we nested?
        unsigned depth() const;
 
        /// local dispatcher
-       int dispatch(string const & cmd);
+       dispatch_result dispatch(FuncRequest const & cmd);
        /// describe the situation
        string info() const;
        /// dump selection information for debugging
@@ -247,6 +225,10 @@ public:
        void dump(char const * str) const;
        /// moves on
        void setSelection(MathIterator const & where, size_type n);
+       /// grab selection marked by anchor and current cursor
+       string grabSelection() const;
+       /// guess what
+       string grabAndEraseSelection();
        ///
        void insert(char c);
        ///
@@ -257,21 +239,16 @@ public:
        /// hack for reveal codes
        void markInsert();
        void markErase();
-       void handleExtern(string const & arg);
-
-       ///
-       friend class Selection;
-
-
-private:
        /// injects content of a cell into parent
        void pullArg();
+       /// split font inset etc
+       void handleFont(string const & font);
+
+private:
        /// moves cursor index one cell to the left
        bool idxLeft();
        /// moves cursor index one cell to the right
        bool idxRight();
-       /// moves cursor to beginning first cell of current line
-       bool idxLineFirst();
        /// moves cursor to end of last cell of current line
        bool idxLineLast();
        /// moves cursor position one cell to the left
@@ -280,23 +257,20 @@ private:
        bool posRight();
        /// moves position somehow up or down
        bool goUpDown(bool up);
-       /// moves position into box
-       bool bruteFind(int xo, int yo, int xlow, int xhigh, int ylow, int yhigh);
+       /// moves position closest to (x, y) in given box
+       bool bruteFind(int x, int y, int xlow, int xhigh, int ylow, int yhigh);
+       /// moves position closest to (x, y) in current cell
+       void bruteFind2(int x, int y);
        /// are we in a nucleus of a script inset?
        bool inNucleus() const;
 
-
-       /// grab grid marked by anchor and current cursor 
-       MathGridInset grabSelection() const;
        /// erase the selected part and re-sets the cursor
        void eraseSelection();
-       /// guess what
-       MathGridInset grabAndEraseSelection();
 
-       ///
+       /// the name of the macro we are currently inputting
        string macroName() const;
-       ///
-       MathInset::difference_type macroNamePos() const;
+       /// where in the curent cell does the macro name start?
+       difference_type macroNamePos() const;
        /// can we enter the inset?
        bool openable(MathAtom const &, bool selection) const;
        /// write access to cursor cell position