]> git.lyx.org Git - lyx.git/blobdiff - src/mathed/math_inset.h
use stream-like syntax for LaTeX output
[lyx.git] / src / mathed / math_inset.h
index d5d5774254d5db0598504a9a1958a5783feeb316..323deadb75e97a7642d22d578bd4e34e23df2a7c 100644 (file)
@@ -28,7 +28,6 @@
 #pragma interface
 #endif
 
-#include "symbol_def.h"
 #include "xarray.h"
 
 /** Abstract base class for all math objects.
 */
 
 
+class MathArrayInset;
+class MathBoxInset;
+class MathCharInset;
+class MathGridInset;
+class MathNestInset;
+class MathMatrixInset;
+class MathScriptInset;
+class MathSpaceInset;
+class MathMacroTemplate;
+
 class LaTeXFeatures;
+class Buffer;
+class BufferView;
+class LyXFont;
+
+
+struct MathMetricsInfo {
+       ///
+       MathMetricsInfo()
+               : view(0), font(0), size(LM_ST_TEXT)
+       {}
+       ///
+       MathMetricsInfo(BufferView * v, LyXFont const * f, MathStyles s)
+               : view(v), font(f), size(s)
+       {}
+
+       ///
+       BufferView * view;
+       ///
+       LyXFont const * font;
+       ///
+       MathStyles size;
+};
+
+
+struct MathWriteInfo {
+       ///
+       MathWriteInfo(Buffer const * buffer_, std::ostream & os_, bool fragile_)
+               : buffer(buffer_), os(os_), fragile(fragile_)
+       {}
+       ///
+       explicit MathWriteInfo(std::ostream & os_)
+               : buffer(0), os(os_), fragile(false)
+       {}
+
+       ///
+       template <class T>
+       MathWriteInfo & operator<<(T const & T)
+       {
+               os << T;
+               return *this;
+       }
+       ///
+       MathWriteInfo & operator<<(MathArray const & ar)
+       {
+               ar.write(*this);
+               return *this;
+       }
+
+
+       ///
+       Buffer const * buffer;
+       ///
+       std::ostream & os;
+       ///
+       bool fragile;
+};
+
 
 class MathInset {
 public: 
+       /// short of anything else reasonable
+       typedef MathArray::size_type     size_type;
+       /// type for cursor positions within a cell
+       typedef MathArray::size_type     pos_type;
+       /// type for cell indices
+       typedef size_type                idx_type;
+       /// type for row numbers
+       typedef size_type                row_type;
+       /// type for column numbers
+       typedef size_type                col_type;
+
        ///
        MathInset();
-
        /// the virtual base destructor
-       virtual ~MathInset() {}
+       virtual ~MathInset()
 
        /// draw the object, sets xo_ and yo_ cached values 
        virtual void draw(Painter &, int x, int y) const;
        /// write LaTeX and Lyx code
-       virtual void write(std::ostream &, bool fragile) const;
+       virtual void write(MathWriteInfo & os) const;
        /// write normalized content
        virtual void writeNormal(std::ostream &) const;
        /// reproduce itself
        virtual MathInset * clone() const = 0;
-       /// appends itself with macro arguments substituted
-       virtual void substitute(MathArray & array, MathMacro const & macro) const;
+       ///substitutes macro arguments if necessary
+       virtual void substitute(MathMacro const & macro);
        /// compute the size of the object, sets ascend_, descend_ and width_
-       virtual void metrics(MathStyles st) const;
+       virtual void metrics(MathMetricsInfo const & st) const;
        /// 
        virtual int ascent() const { return 1; }
        ///
@@ -72,59 +148,50 @@ public:
        virtual MathStyles size() const;
 
        /// Where should we go when we press the up cursor key?
-       virtual bool idxUp(int & idx, int & pos) const;
+       virtual bool idxUp(idx_type & idx, pos_type & pos) const;
        /// The down key
-       virtual bool idxDown(int & idx, int & pos) const;
+       virtual bool idxDown(idx_type & idx, pos_type & pos) const;
        /// The left key
-       virtual bool idxLeft(int & idx, int & pos) const;
+       virtual bool idxLeft(idx_type & idx, pos_type & pos) const;
        /// The right key
-       virtual bool idxRight(int & idx, int & pos) const;
+       virtual bool idxRight(idx_type & idx, pos_type & pos) const;
 
        /// Move one physical cell up
-       virtual bool idxNext(int & idx, int & pos) const;
+       virtual bool idxNext(idx_type & idx, pos_type & pos) const;
        /// Move one physical cell down
-       virtual bool idxPrev(int & idx, int & pos) const;
+       virtual bool idxPrev(idx_type & idx, pos_type & pos) const;
 
        /// Target pos when we enter the inset from the left by pressing "Right"
-       virtual bool idxFirst(int & idx, int & pos) const;
-       /// Target pos when we enter the inset from the left by pressing "Up"
-       virtual bool idxFirstUp(int & idx, int & pos) const;
-       /// Target pos when we enter the inset from the left by pressing "Down"
-       virtual bool idxFirstDown(int & idx, int & pos) const;
-
+       virtual bool idxFirst(idx_type & idx, pos_type & pos) const;
        /// Target pos when we enter the inset from the right by pressing "Left"
-       virtual bool idxLast(int & idx, int & pos) const;
-       /// Target pos when we enter the inset from the right by pressing "Up"
-       virtual bool idxLastUp(int & idx, int & pos) const;
-       /// Target pos when we enter the inset from the right by pressing "Down"
-       virtual bool idxLastDown(int & idx, int & pos) const;
+       virtual bool idxLast(idx_type & idx, pos_type & pos) const;
 
        /// Where should we go if we press home?
-       virtual bool idxHome(int & idx, int & pos) const;
+       virtual bool idxHome(idx_type & idx, pos_type & pos) const;
        /// Where should we go if we press end?
-       virtual bool idxEnd(int & idx, int & pos) const;
+       virtual bool idxEnd(idx_type & idx, pos_type & pos) const;
 
        /// Delete a cell and move cursor
        // the return value indicates whether the cursor should leave the inset
        // and/or the whole inset should be deleted
-       virtual void idxDelete(int & idx, bool & popit, bool & deleteit);
+       virtual void idxDelete(idx_type & idx, bool & popit, bool & deleteit);
        // deletes a cell range and moves the cursor 
-       virtual void idxDeleteRange(int from, int to);
+       virtual void idxDeleteRange(idx_type from, idx_type to);
        // returns list of cell indices that are "between" from and to for
        // selection purposes
-       virtual std::vector<int> idxBetween(int from, int to) const;
+       virtual std::vector<idx_type> idxBetween(idx_type from, idx_type to) const;
 
        ///
-       virtual int nargs() const;
+       virtual idx_type nargs() const;
 
        ///
-       virtual MathArray & cell(int);
+       virtual MathArray & cell(idx_type);
        ///
-       virtual MathArray const & cell(int) const;
+       virtual MathArray const & cell(idx_type) const;
        ///
-       virtual MathXArray & xcell(int);
+       virtual MathXArray & xcell(idx_type);
        ///
-       virtual MathXArray const & xcell(int) const;
+       virtual MathXArray const & xcell(idx_type) const;
                        
        ///
        virtual int xo() const;
@@ -137,25 +204,25 @@ public:
        ///
 
        ///
-       virtual int ncols() const { return 1; }
+       virtual col_type ncols() const { return 1; }
        ///
-       virtual int nrows() const { return 1; }
+       virtual row_type nrows() const { return 1; }
        ///
-       virtual int col(int) const { return 0; }
+       virtual col_type col(row_type) const { return 0; }
        ///
-       virtual int row(int) const { return 0; }
+       virtual row_type row(row_type) const { return 0; }
        ///
-       virtual int cellXOffset(int) const { return 0; }
+       virtual int cellXOffset(row_type) const { return 0; }
        ///
-       virtual int cellYOffset(int) const { return 0; }
+       virtual int cellYOffset(row_type) const { return 0; }
        ///
-       virtual void addRow(int) {}
+       virtual void addRow(row_type) {}
        ///
-       virtual void delRow(int) {}
+       virtual void delRow(row_type) {}
        ///
-       virtual void addCol(int) {}
+       virtual void addCol(col_type) {}
        ///
-       virtual void delCol(int) {}
+       virtual void delCol(col_type) {}
 
        ///
        virtual void userSetSize(MathStyles &) {}
@@ -164,28 +231,45 @@ public:
        virtual void getXY(int & x, int & y) const;
        ///
        virtual bool covers(int x, int y) const;
-       /// identifies things that can get scripts
-       virtual bool isScriptable() const { return false; }
+
+       /// identifies NestInsets
+       virtual MathNestInset * asNestInset() { return 0; }
+       /// identifies CharInsets
+       virtual MathCharInset const * asCharInset() const { return 0; }
+       /// identifies ScriptInsets
+       virtual MathScriptInset const * asScriptInset() const { return 0; }
        /// identifies ScriptInsets
-       virtual bool isScriptInset() const { return false; }
-       /// identifies SpaceInsets
-       virtual bool isSpaceInset() const { return false; }
-       /// identifies GridInsets
-       virtual bool isGrid() const { return false; }
+       virtual MathScriptInset * asScriptInset() { return 0; }
+       /// identifies MatrixInsets
+       virtual MathMatrixInset const * asMatrixInset() const { return 0; }
+       /// identifies MatrixInsets
+       virtual MathMatrixInset * asMatrixInset() { return 0; }
+       /// identifies SpaceInset
+       virtual MathSpaceInset * asSpaceInset() { return 0; }
+       /// identifies GridInset
+       virtual MathGridInset * asGridInset() { return 0; }
        /// identifies ArrayInsets
-       virtual bool isArray() const { return false; }
-       /// identifies Charinsets
-       virtual bool isCharInset() const { return false; }
+       virtual MathArrayInset * asArrayInset() { return 0; }
+       /// identifies BoxInsets
+       virtual MathBoxInset * asBoxInset() { return 0; }
+       /// identifies macro templates
+       virtual MathMacroTemplate * asMacroTemplate() { return 0; }
+
+       /// identifies things that can get scripts
+       virtual bool isScriptable() const { return false; }
        ///
        virtual bool isActive() const { return nargs() > 0; }
        ///
        virtual bool isRelOp() const { return false; }
        ///
        virtual bool isMacro() const { return false; }
+
        ///
        virtual char getChar() const { return 0; }
        ///
        virtual MathTextCodes code() const { return LM_TC_MIN; }
+       /// identifies things that can get \limits or \nolimits
+       virtual bool takesLimits() const { return false; }
 
        ///
        virtual void push_back(MathInset *);
@@ -203,10 +287,8 @@ public:
        static int workwidth;
 
 protected:
-       /// _sets_ style
-       void size(MathStyles s) const;
        /// the used font size
-       mutable MathStyles size_;
+       mutable MathMetricsInfo size_;
 
 private:
        /// the following are used for positioning the cursor with the mouse