#ifndef MATH_INSET_H
#define MATH_INSET_H
+#include <config.h>
+
#ifdef __GNUG__
#pragma interface
#endif
-#include "LString.h"
-#include "symbol_def.h"
#include "xarray.h"
/** Abstract base class for all math objects.
*/
-class MathInset {
-public:
- /** A math inset has a name (usually its LaTeX name),
- type and font-size
- */
- ///
- 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) = 0;
- ///
- virtual int ascent() const;
+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)
+ {}
///
- virtual int descent() const;
+ MathMetricsInfo(BufferView * v, LyXFont const * f, MathStyles s)
+ : view(v), font(f), size(s)
+ {}
+
///
- virtual int width() const;
+ BufferView * view;
///
- virtual int height() const;
+ LyXFont const * font;
///
- virtual bool hasLimits() const;
+ MathStyles size;
+};
+
+
+struct MathWriteInfo {
///
- virtual int limits() const;
+ MathWriteInfo(Buffer const * buffer_, std::ostream & os_, bool fragile_)
+ : buffer(buffer_), os(os_), fragile(fragile_)
+ {}
///
- virtual void limits(int);
+ explicit MathWriteInfo(std::ostream & os_)
+ : buffer(0), os(os_), fragile(false)
+ {}
+
///
- string const & name() const;
+ template <class T>
+ MathWriteInfo & operator<<(T const & T)
+ {
+ os << T;
+ return *this;
+ }
+ ///
+ MathWriteInfo & operator<<(MathArray const & ar)
+ {
+ ar.write(*this);
+ return *this;
+ }
+
+
///
- MathInsetTypes GetType() const;
- //Man: Avoid to use these functions if it's not strictly necessary
+ Buffer const * buffer;
///
- virtual void SetType(MathInsetTypes t);
+ std::ostream & os;
///
- virtual void SetName(string const & n);
+ 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;
+
///
- MathStyles size() const;
+ MathInset();
+ /// the virtual base destructor
+ 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(MathWriteInfo & os) const;
+ /// write normalized content
+ virtual void writeNormal(std::ostream &) const;
+ /// reproduce itself
+ virtual MathInset * clone() const = 0;
+ ///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(MathMetricsInfo const & st) const;
+ ///
+ virtual int ascent() const { return 1; }
+ ///
+ virtual int descent() const { return 1; }
+ ///
+ virtual int width() const { return 2; }
+ ///
+ virtual int height() const;
+ ///
+ 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
- // a return value true indicates that the whole inset should be deleted
- virtual bool idxDelete(int idx);
+ // the return value indicates whether the cursor should leave the inset
+ // and/or the whole inset should be deleted
+ virtual void idxDelete(idx_type & idx, bool & popit, bool & deleteit);
+ // deletes a cell range and moves the cursor
+ 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<idx_type> idxBetween(idx_type from, idx_type to) const;
///
- int nargs() const;
+ virtual idx_type nargs() const;
///
- MathArray & cell(int);
- ///
- MathArray const & cell(int) const;
+ virtual MathArray & cell(idx_type);
///
- MathXArray & xcell(int);
+ virtual MathArray const & cell(idx_type) const;
///
- MathXArray const & xcell(int) const;
+ virtual MathXArray & xcell(idx_type);
///
- void setData(MathArray const &, int);
+ virtual MathXArray const & xcell(idx_type) const;
///
- int xo() const;
+ virtual int xo() const;
///
- int yo() const;
+ virtual int yo() const;
///
- void xo(int tx);
+ virtual void xo(int tx) const;
///
- void yo(int ty);
+ virtual void yo(int ty) const;
///
///
- 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 void addRow(int) {}
+ virtual int cellXOffset(row_type) const { return 0; }
///
- virtual void delRow(int) {}
+ virtual int cellYOffset(row_type) const { return 0; }
///
- virtual void addCol(int) {}
+ virtual void addRow(row_type) {}
///
- virtual void delCol(int) {}
-
+ virtual void delRow(row_type) {}
+ ///
+ virtual void addCol(col_type) {}
///
- virtual void UserSetSize(MathStyles &) {}
+ virtual void delCol(col_type) {}
///
- void GetXY(int & x, int & y) const;
+ virtual void userSetSize(MathStyles &) {}
+
///
- bool covers(int x, int y) const;
- /// Identifies ScriptInsets
- virtual bool isScriptInset() const { return false; }
- /// Identifies AccentInsets
- virtual bool isAccentInset() const { return false; }
+ virtual void getXY(int & x, int & y) const;
///
- virtual bool isActive() const { return nargs() > 0; }
+ virtual bool covers(int x, int y) const;
+ /// 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 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 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; }
///
- void push_back(MathInset *);
+ virtual bool isActive() const { return nargs() > 0; }
///
- void push_back(byte ch, MathTextCodes fcode);
+ virtual bool isRelOp() const { return false; }
///
- void dump() const;
+ virtual bool isMacro() const { return false; }
///
+ virtual char getChar() const { return 0; }
///
- static int workwidth;
-protected:
- ///
- string name_;
+ virtual MathTextCodes code() const { return LM_TC_MIN; }
+ /// identifies things that can get \limits or \nolimits
+ virtual bool takesLimits() const { return false; }
+
///
- MathInsetTypes objtype;
+ virtual void push_back(MathInset *);
///
- int width_;
+ virtual void push_back(unsigned char c, MathTextCodes code);
///
- int ascent_;
+ virtual void dump() const;
+
///
- int descent_;
+ virtual void validate(LaTeXFeatures & features) const;
///
- void size(MathStyles s);
+ virtual void handleFont(MathTextCodes) {}
+
///
- MathStyles size_;
+ static int workwidth;
protected:
- ///
- 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_;
+ /// the used font size
+ mutable MathMetricsInfo size_;
private:
- /// Cursor start position in pixels from the document top
- int xo_;
- ///
- int yo_;
+ /// the following are used for positioning the cursor with the mouse
+ /// cached cursor start position in pixels from the document left
+ mutable int xo_;
+ /// cached cursor start position in pixels from the document top
+ mutable int yo_;
};
std::ostream & operator<<(std::ostream &, MathInset const &);
projects / lyx.git / blobdiff