*
* Copyright: 1996, 1997 Alejandro Aguilar Sierra
*
- * Version: 0.8beta, Mathed & Lyx project.
+ * Version: 0.8beta, Math & Lyx project.
*
* You are free to use and modify this code under the terms of
* the GNU General Public Licence version 2 or later.
*/
-// Note: These math insets are internal to Mathed and are not derived
+// Note: These math insets are internal to Math and are not derived
// from lyx inset.
-#ifndef MATH_INSET
-#define MATH_INSET
+#ifndef MATH_INSET_H
+#define MATH_INSET_H
+
+#include <config.h>
#ifdef __GNUG__
#pragma interface
#endif
-#include "math_defs.h"
-#include "symbol_def.h"
#include "LString.h"
+#include "symbol_def.h"
+#include "xarray.h"
-/**
- Functions or LaTeX names for objects that I don't know how to draw.
- */
-class MathFuncInset: public MathedInset {
-public:
- ///
- explicit
- MathFuncInset(string const & nm,
- short ot = LM_OT_FUNC, short st = LM_ST_TEXT);
- ///
- ~MathFuncInset();
- ///
- MathedInset * Clone();
- ///
- void draw(Painter &, int, int);
- ///
- void Write(std::ostream &, bool fragile);
- ///
- void Metrics();
- ///
- inline bool GetLimits() const;
-protected:
- ///
- int ln;
- ///
- bool lims;
- ///
- string fname;
-};
-
+/** Abstract base class for all math objects.
+ A math insets is for use of the math editor only, it isn't a
+ general LyX inset. It's used to represent all the math objects.
+ The formulaInset (a LyX inset) encapsulates a math inset.
+*/
-/// Accents
-class MathAccentInset: public MathedInset {
-public:
- ///
- MathAccentInset(byte, MathedTextCodes, int, short st = LM_ST_TEXT);
- ///
- MathAccentInset(MathedInset *, int, short st = LM_ST_TEXT);
- ///
- ~MathAccentInset();
- ///
- MathedInset * Clone();
- ///
- void draw(Painter &, int, int);
- ///
- void Write(std::ostream &, bool fragile);
- ///
- void Metrics();
- ///
- int getAccentCode() const { return code; }
-
-protected:
- ///
- byte c;
- ///
- MathedTextCodes fn;
- ///
- int code;
- ///
- MathedInset * inset;
- ///
- int dh, dy;
-};
+class LaTeXFeatures;
-///
-class MathDotsInset: public MathedInset {
-public:
- ///
- MathDotsInset(string const &, int, short st = LM_ST_TEXT);
- ///
- MathedInset * Clone();
- ///
- void draw(Painter &, int, int);
- ///
- void Write(std::ostream &, bool fragile);
- ///
- void Metrics();
-protected:
+class MathInset {
+public:
///
- int dh, code;
-};
+ explicit MathInset(string const & nm = string());
+ /// the virtual base destructor
+ virtual ~MathInset() {}
-/// Smart spaces
-class MathSpaceInset: public MathedInset {
-public:
+ /// draw the object, sets xo_ and yo_ cached values
+ virtual void draw(Painter &, int x, int baseline) = 0;
+ /// write LaTeX and Lyx code
+ virtual void write(std::ostream &, bool fragile) const = 0;
+ /// 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;
+ /// compute the size of the object, sets ascend_, descend_ and width_
+ virtual void metrics(MathStyles st) = 0;
+ ///
+ virtual int ascent() const;
///
- MathSpaceInset(int sp, short ot = LM_OT_SPACE, short st = LM_ST_TEXT);
+ virtual int descent() const;
///
- MathedInset * Clone();
+ virtual int width() const;
///
- void draw(Painter &, int, int);
+ virtual int height() const;
///
- void Write(std::ostream &, bool fragile);
+ string const & name() const;
///
- inline void Metrics();
+ virtual void setName(string const & n);
///
- inline void SetSpace(int sp);
- ///
- int GetSpace() { return space; }
-protected:
- ///
- int space;
-};
+ virtual MathStyles size() const;
+ /// Where should we go when we press the up cursor key?
+ virtual bool idxUp(int & idx, int & pos) const;
+ /// The down key
+ virtual bool idxDown(int & idx, int & pos) const;
+ /// The left key
+ virtual bool idxLeft(int & idx, int & pos) const;
+ /// The right key
+ virtual bool idxRight(int & idx, int & pos) const;
-/// big operators
-class MathBigopInset: public MathedInset {
-public:
- ///
- MathBigopInset(string const &, int, short st = LM_ST_TEXT);
- ///
- MathedInset * Clone();
- ///
- void draw(Painter &, int, int);
- ///
- void Write(std::ostream &, bool fragile);
- ///
- void Metrics();
- ///
- inline bool GetLimits() const;
- ///
- inline void SetLimits(bool);
-protected:
- ///
- int lims;
- ///
- int sym;
-};
+ /// Move one physical cell up
+ virtual bool idxNext(int & idx, int & pos) const;
+ /// Move one physical cell down
+ virtual bool idxPrev(int & idx, int & pos) const;
-
-//------- All editable insets must be derived from MathParInset.
+ /// 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;
-///
-class MathSqrtInset: public MathParInset {
-public:
- ///
- MathSqrtInset(short st = LM_ST_TEXT);
- ///
- MathedInset * Clone();
- ///
- void draw(Painter &, int x, int baseline);
- ///
- void Write(std::ostream &, bool fragile);
- ///
- void Metrics();
- ///
- bool Inside(int, int);
-private:
- ///
- int hmax, wbody;
-};
+ /// 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;
+
+ /// Where should we go if we press home?
+ virtual bool idxHome(int & idx, int & pos) const;
+ /// Where should we go if we press end?
+ virtual bool idxEnd(int & idx, int & 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);
+ // deletes a cell range and moves the cursor
+ virtual void idxDeleteRange(int from, int 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;
-/// Fraction like objects (frac, stackrel, binom)
-class MathFracInset: public MathParInset {
-public:
///
- MathFracInset(short ot = LM_OT_FRAC);
+ virtual int nargs() const;
+
///
- ~MathFracInset();
+ virtual MathArray & cell(int);
///
- MathedInset * Clone();
+ virtual MathArray const & cell(int) const;
///
- void draw(Painter &, int x, int baseline);
+ virtual MathXArray & xcell(int);
///
- void Write(std::ostream &, bool fragile);
+ virtual MathXArray const & xcell(int) const;
+
///
- void Metrics();
-
- /** This does the same that SetData(LyxArrayBase*) but for both
- numerator and denominator at once.
- */
- void SetData(LyxArrayBase *, LyxArrayBase *);
+ virtual int xo() const;
///
- void SetData(LyxArrayBase *);
+ virtual int yo() const;
///
- void GetXY(int & x, int & y) const;
+ virtual void xo(int tx);
///
- void SetFocus(int, int);
+ virtual void yo(int ty);
///
- bool Inside(int, int);
+
///
- LyxArrayBase * GetData();
+ virtual int ncols() const { return 1; }
///
- bool setArgumentIdx(int i); // was bool Up/down(void);
+ virtual int nrows() const { return 1; }
///
- int getArgumentIdx() { return int(idx); }
+ virtual int col(int) const { return 0; }
///
- int getMaxArgumentIdx() { return 1; }
+ virtual int row(int) const { return 0; }
///
- void SetStyle(short);
-protected:
+ virtual void addRow(int) {}
///
- short idx;
+ virtual void delRow(int) {}
///
- MathParInset * den;
+ virtual void addCol(int) {}
///
- int w0, w1, des0, dh;
-};
-
+ virtual void delCol(int) {}
-/// A delimiter
-class MathDelimInset: public MathParInset {
-public:
- ///
- MathDelimInset(int, int, short st = LM_ST_TEXT);
- ///
- MathedInset * Clone();
- ///
- void draw(Painter &, int, int);
- ///
- void Write(std::ostream &, bool fragile);
- ///
- void Metrics();
-protected:
- ///
- int left, right;
///
- int dw, dh;
-};
-
+ virtual void userSetSize(MathStyles &) {}
-/// Decorations over (below) a math object
-class MathDecorationInset: public MathParInset {
-public:
- ///
- MathDecorationInset(int, short st = LM_ST_TEXT);
///
- MathedInset * Clone();
+ virtual void getXY(int & x, int & y) const;
///
- void draw(Painter &, int, int);
+ virtual bool covers(int x, int y) const;
+ /// identifies things that can get scripts
+ virtual bool isScriptable() const { return false; }
+ /// identifies ScriptInsets
+ virtual bool isScriptInset() const { return false; }
+ /// identifies SpaceInsets
+ virtual bool isSpaceInset() const { return false; }
+ /// identifies GridInsets
+ virtual bool isGrid() const { return false; }
+ /// identifies ArrayInsets
+ virtual bool isArray() const { return false; }
+ /// identifies Charinsets
+ virtual bool isCharInset() const { return false; }
///
- void Write(std::ostream &, bool fragile);
+ virtual bool isActive() const { return nargs() > 0; }
///
- void Metrics();
- ///
- inline bool GetLimits() const;
-protected:
+ virtual char getChar() const { return 0; }
+
///
- int deco;
+ virtual void push_back(MathInset *);
///
- bool upper;
+ virtual void push_back(unsigned char ch, MathTextCodes fcode);
///
- int dw, dh, dy;
-};
-
-
-// -------------------- Inline functions ---------------------
-
-
-inline
-MathFuncInset::~MathFuncInset()
-{}
-
-
-inline
-bool MathFuncInset::GetLimits() const
-{
- return bool(lims && (GetStyle() == LM_ST_DISPLAY));
-}
-
-
-inline
-void MathFuncInset::Write(std::ostream & os, bool /* fragile */)
-{
- os << "\\" << name << ' ';
-}
-
-
-inline
-void MathSpaceInset::Metrics()
-{
- width = space ? space * 2 : 2;
- if (space > 3) width *= 2;
- if (space == 5) width *= 2;
- width += 4;
- ascent = 4; descent = 0;
-}
-
-
-inline
-void MathSpaceInset::SetSpace(int sp)
-{
- space = sp;
- Metrics();
-}
+ virtual void dump() const;
+ ///
+ virtual void validate(LaTeXFeatures & features) const;
-inline
-bool MathBigopInset::GetLimits() const
-{
- // Default case
- if (lims < 0) {
- return sym != LM_int && sym != LM_oint && GetStyle() == LM_ST_DISPLAY;
- }
-
- // Custom
- return lims > 0;
-}
+ ///
+ static int workwidth;
+ /// the inherited text style
+ virtual MathTextCodes code() const;
+ ///
+ virtual void code(MathTextCodes t);
-inline
-void MathBigopInset::SetLimits(bool ls)
-{
- lims = ls ? 1 : 0;
-}
+protected:
+ /// usually the LaTeX name of the thingy
+ string name_;
+ /// the width of this inset as computed by metrics()
+ int width_;
+ ///
+ int ascent_;
+ ///
+ int descent_;
+ ///
+ void size(MathStyles s);
+ /// the used font size
+ MathStyles size_;
+ /// the inherited text style
+ MathTextCodes code_;
+private:
+ /// the following are used for positioning the cursor with the mouse
+ /// cached cursor start position in pixels from the document left
+ int xo_;
+ /// cached cursor start position in pixels from the document top
+ int yo_;
+};
-inline
-bool MathDecorationInset::GetLimits() const
-{
- return deco == LM_underbrace || deco == LM_overbrace;
-}
+std::ostream & operator<<(std::ostream &, MathInset const &);
#endif
projects / lyx.git / blobdiff