*
* 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"
-using std::ostream;
+/** 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.
+*/
-/**
- Functions or LaTeX names for objects that I don't know how to draw.
- */
-class MathFuncInset: public MathedInset {
-public:
- ///
- MathFuncInset(char const * nm,
- short ot = LM_OT_FUNC, short st = LM_ST_TEXT);
- ///
- ~MathFuncInset();
- ///
- MathedInset * Clone();
- ///
- void draw(Painter &, int, int);
- ///
- void Write(ostream &);
- ///
- void Metrics();
- ///
- inline bool GetLimits() const;
-protected:
- ///
- int ln;
- ///
- bool lims;
- ///
- char * fname;
-};
+class LaTeXFeatures;
-/// Accents
-class MathAccentInset: public MathedInset {
-public:
- ///
- MathAccentInset(byte, MathedTextCodes, int, short st = LM_ST_TEXT);
- ///
- MathAccentInset(MathedInset *, int, short st = LM_ST_TEXT);
+class MathInset {
+public:
+ /** A math inset has a name (usually its LaTeX name),
+ type and font-size
+ */
///
- ~MathAccentInset();
+ explicit MathInset
+ (int na = 0, string const & nm = string(), MathInsetTypes ot = LM_OT_SIMPLE);
+
+ /// The virtual base destructor
+ virtual ~MathInset() {}
+
+ /// Draw the object
+ 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;
+ /// Reproduces 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
+ virtual void Metrics(MathStyles st, int = 0, int = 0) = 0;
+ ///
+ virtual int ascent() const;
///
- MathedInset * Clone();
+ virtual int descent() const;
///
- void draw(Painter &, int, int);
+ virtual int width() const;
///
- void Write(ostream &);
+ virtual int height() const;
///
- void Metrics();
+ virtual int limits() const;
///
- int getAccentCode() const { return code; }
-
-protected:
+ virtual void limits(int);
///
- byte c;
+ string const & name() const;
///
- MathedTextCodes fn;
+ MathInsetTypes GetType() const;
+ //Man: Avoid to use these functions if it's not strictly necessary
///
- int code;
+ virtual void SetType(MathInsetTypes t);
///
- MathedInset * inset;
+ virtual void SetName(string const & n);
///
- int dh, dy;
-};
+ 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;
-///
-class MathDotsInset: public MathedInset {
-public:
- ///
- MathDotsInset(char const *, int, short st = LM_ST_TEXT);
- ///
- MathedInset * Clone();
- ///
- void draw(Painter &, int, int);
- ///
- void Write(ostream &);
- ///
- void Metrics();
-protected:
- ///
- int dh, code;
-};
+ /// 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;
+ /// 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;
-/// Smart spaces
-class MathSpaceInset: public MathedInset {
-public:
- ///
- MathSpaceInset(int sp, short ot = LM_OT_SPACE, short st = LM_ST_TEXT);
- ///
- MathedInset * Clone();
- ///
- void draw(Painter &, int, int);
- ///
- void Write(ostream &);
- ///
- inline void Metrics();
- ///
- inline void SetSpace(int sp);
- ///
- int GetSpace() { return space; }
-protected:
- ///
- int space;
-};
-
+ /// 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;
-/// big operators
-class MathBigopInset: public MathedInset {
-public:
- ///
- MathBigopInset(char const *, int, short st = LM_ST_TEXT);
- ///
- MathedInset * Clone();
- ///
- void draw(Painter &, int, int);
- ///
- void Write(ostream &);
- ///
- void Metrics();
- ///
- inline bool GetLimits() const;
- ///
- inline void SetLimits(bool);
-protected:
- ///
- int lims;
- ///
- int sym;
-};
+ /// 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;
-
-//------- All editable insets must be derived from MathParInset.
+ /// 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
+ // selction purposes
+ virtual std::vector<int> idxBetween(int from, int to) const;
-///
-class MathSqrtInset: public MathParInset {
-public:
- ///
- MathSqrtInset(short st = LM_ST_TEXT);
///
- MathedInset * Clone();
- ///
- void draw(Painter &, int x, int baseline);
- ///
- void Write(ostream &);
+ int nargs() const;
+
///
- void Metrics();
+ MathArray & cell(int);
///
- bool Inside(int, int);
-private:
+ MathArray const & cell(int) const;
///
- int hmax, wbody;
-};
-
-
-/// Fraction like objects (frac, stackrel, binom)
-class MathFracInset: public MathParInset {
-public:
+ MathXArray & xcell(int);
///
- MathFracInset(short ot = LM_OT_FRAC);
+ MathXArray const & xcell(int) const;
+
///
- ~MathFracInset();
+ int xo() const;
///
- MathedInset * Clone();
+ int yo() const;
///
- void draw(Painter &, int x, int baseline);
+ void xo(int tx);
///
- void Write(ostream &);
+ void yo(int ty);
///
- void Metrics();
-
- /** This does the same that SetData(LyxArrayBase*) but for both
- numerator and denominator at once.
- */
- void SetData(LyxArrayBase *, LyxArrayBase *);
+
///
- void SetData(LyxArrayBase *);
+ virtual int ncols() const { return 1; }
///
- void GetXY(int & x, int & y) const;
+ virtual int nrows() const { return 1; }
///
- void SetFocus(int, int);
+ virtual int col(int) const { return 0; }
///
- bool Inside(int, int);
+ virtual int row(int) const { return 0; }
///
- LyxArrayBase * GetData();
+ virtual void addRow(int) {}
///
- bool setArgumentIdx(int i); // was bool Up/down(void);
+ virtual void delRow(int) {}
///
- int getArgumentIdx() { return int(idx); }
+ virtual void addCol(int) {}
///
- int getMaxArgumentIdx() { return 1; }
+ virtual void delCol(int) {}
+
///
- void SetStyle(short);
-protected:
+ virtual void UserSetSize(MathStyles &) {}
+
///
- short idx;
+ void GetXY(int & x, int & y) const;
///
- MathParInset * den;
+ bool covers(int x, int y) const;
+ /// Identifies ScriptInsets
+ virtual bool isUpDownInset() const { return false; }
+ /// Identifies BigopInsets
+ virtual bool isBigopInset() const { return false; }
///
- int w0, w1, des0, dh;
-};
+ virtual bool isActive() const { return nargs() > 0; }
-/// A delimiter
-class MathDelimInset: public MathParInset {
-public:
///
- MathDelimInset(int, int, short st = LM_ST_TEXT);
+ void push_back(MathInset *);
///
- MathedInset * Clone();
+ void push_back(unsigned char ch, MathTextCodes fcode);
///
- void draw(Painter &, int, int);
+ void dump() const;
+
///
- void Write(ostream &);
+ void Validate(LaTeXFeatures & features) const;
+
///
- void Metrics();
+ static int workwidth;
protected:
///
- int left, right;
+ string name_;
///
- int dw, dh;
-};
-
-
-/// Decorations over (below) a math object
-class MathDecorationInset: public MathParInset {
-public:
- ///
- MathDecorationInset(int, short st = LM_ST_TEXT);
+ MathInsetTypes objtype;
///
- MathedInset * Clone();
+ int width_;
///
- void draw(Painter &, int, int);
+ int ascent_;
///
- void Write(ostream &);
+ int descent_;
///
- void Metrics();
+ void size(MathStyles s);
///
- inline bool GetLimits() const;
+ MathStyles size_;
+
protected:
///
- int deco;
- ///
- bool upper;
+ typedef std::vector<MathXArray> cells_type;
+ /**
+ * The contents of the inset are contained here.
+ * Each inset is build from a number of insets.
+ * For instance, a
+ */
+ cells_type cells_;
+
+private:
+ /// Cursor start position in pixels from the document top
+ int xo_;
///
- int dw, dh, dy;
+ int yo_;
};
-
-// -------------------- Inline functions ---------------------
-
-
-inline
-MathFuncInset::~MathFuncInset()
-{
- if (fname && GetType() == LM_OT_UNDEF) delete[] fname;
-}
-
-
-inline
-bool MathFuncInset::GetLimits() const
-{
- return bool(lims && (GetStyle() == LM_ST_DISPLAY));
-}
-
-
-inline
-void MathFuncInset::Write(ostream & os)
-{
- 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();
-}
-
-
-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;
-}
-
-
-inline
-void MathBigopInset::SetLimits(bool ls)
-{
- lims = ls ? 1 : 0;
-}
-
-
-inline
-bool MathDecorationInset::GetLimits() const
-{
- return deco == LM_underbrace || deco == LM_overbrace;
-}
+std::ostream & operator<<(std::ostream &, MathInset const &);
#endif
projects / lyx.git / blobdiff