// -*- C++ -*-
/*
* File: math_inset.h
- * Purpose: Declaration of insets for mathed
- * Author: Alejandro Aguilar Sierra <asierra@servidor.unam.mx>
+ * Purpose: Declaration of insets for mathed
+ * Author: Alejandro Aguilar Sierra <asierra@servidor.unam.mx>
* Created: January 1996
* Description: Math paragraph and objects for a WYSIWYG math editor.
*
#pragma interface
#endif
-#include "LString.h"
-#include "symbol_def.h"
-#include "xarray.h"
+#include "math_xdata.h"
+#include "math_defs.h"
+
+/**
+
+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.
+
+Math insets do not know there parents, a cursor position or things
+like that. The are dumb object that are contained in other math insets
+(mathNestInsets, in fact) thus forming a tree. The root of this tree is
+always a mathHullInset, which provides an interface to the Outer World by
+inclusion in the "real LyX insets" FormulaInset and FormulaMacroInset.
-/** 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.
*/
+class MathArrayInset;
+class MathBraceInset;
+class MathBoxInset;
+class MathCharInset;
+class MathDelimInset;
+class MathFuncInset;
+class MathGridInset;
+class MathFracInset;
+class MathHullInset;
+class MathMatrixInset;
+class MathNestInset;
+class MathScriptInset;
+class MathStringInset;
+class MathSpaceInset;
+class MathSymbolInset;
+class MathUnknownInset;
+class MathXYMatrixInset;
+
+class NormalStream;
+class OctaveStream;
+class MapleStream;
+class MathMLStream;
+class WriteStream;
+class InfoStream;
+class MathArray;
+
+class LaTeXFeatures;
+class BufferView;
+class UpdatableInset;
+class MathMacroTemplate;
+class MathPosFinder;
+
+
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);
+public:
+ /// short of anything else reasonable
+ typedef MathArray::size_type size_type;
+ /// type for cursor positions differences within a cell
+ typedef MathArray::difference_type difference_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;
- /// The virtual base destructor
+ /// our members behave nicely...
+ MathInset() {}
+ /// 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
+ /// 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
- virtual void Metrics(MathStyles st, int = 0, int = 0) = 0;
- ///
- virtual int ascent() const;
- ///
- virtual int descent() const;
- ///
- virtual int width() const;
- ///
+ /// substitutes macro arguments if necessary
+ virtual void substitute(MathMacro const & macro);
+ /// compute the size of the object, sets ascend_, descend_ and width_
+ // updates the (xo,yo)-caches of all contained cells
+ virtual void metrics(MathMetricsInfo const & st) const;
+ /// draw the object
+ virtual void draw(Painter &, int x, int y) const;
+ /// the ascent of the inset above the baseline
+ /// compute the size of the object for text based drawing
+ virtual void metricsT(TextMetricsInfo const & st) const;
+ /// draw the object as text
+ virtual void drawT(TextPainter &, int x, int y) const;
+ /// the ascent of the inset above the baseline
+ virtual int ascent() const { return 1; }
+ /// the descent of the inset below the baseline
+ virtual int descent() const { return 1; }
+ /// total width
+ virtual int width() const { return 2; }
+ /// total height (== ascent + descent)
virtual int height() const;
- ///
- virtual int limits() const;
- ///
- virtual void limits(int);
- ///
- string const & name() const;
- ///
- MathInsetTypes GetType() const;
- //Man: Avoid to use these functions if it's not strictly necessary
- ///
- virtual void SetType(MathInsetTypes t);
- ///
- virtual void SetName(string const & n);
- ///
- 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;
+ /// Where should we go when we press the up or down cursor key?
+ virtual bool idxUpDown(idx_type & idx, bool up) 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 bool idxDelete(idx_type &) { return false; }
+ /// pulls cell after pressing erase
+ virtual void idxGlue(idx_type) {}
+ // 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;
+ /// the number of nested cells this inset owns
+ virtual idx_type nargs() const;
- ///
- MathArray & cell(int);
- ///
- MathArray const & cell(int) const;
- ///
- MathXArray & xcell(int);
- ///
- MathXArray const & xcell(int) const;
-
- ///
- int xo() const;
- ///
- int yo() const;
- ///
- void xo(int tx);
- ///
- void yo(int ty);
- ///
+ /// return cell given its number
+ virtual MathArray & cell(idx_type);
+ /// return cell given its number
+ virtual MathArray const & cell(idx_type) const;
+ /// return cell plus drawing cache given its number
+ virtual MathXArray & xcell(idx_type);
+ /// return cell plus drawing cache given its number
+ virtual MathXArray const & xcell(idx_type) const;
- ///
- virtual int ncols() const { return 1; }
- ///
- virtual int nrows() const { return 1; }
- ///
- virtual int col(int) const { return 0; }
- ///
- virtual int row(int) const { return 0; }
- ///
- virtual void addRow(int) {}
- ///
- virtual void delRow(int) {}
- ///
- virtual void addCol(int) {}
- ///
- virtual void delCol(int) {}
+ /// the number of columns of this inset if it is grid-like
+ virtual col_type ncols() const { return 1; }
+ /// the number of rows of this inset if it is grid-like
+ virtual row_type nrows() const { return 1; }
+ /// to which column belongs a cell with a given index?
+ virtual col_type col(idx_type) const { return 0; }
+ /// to which row belongs a cell with a given index?
+ virtual row_type row(idx_type) const { return 0; }
+ /// cell idex corresponding to row and column;
+ virtual idx_type index(row_type row, col_type col) const;
+ /// any additional x-offset when drawing a cell?
+ virtual int cellXOffset(idx_type) const { return 0; }
+ /// any additional y-offset when drawing a cell?
+ virtual int cellYOffset(idx_type) const { return 0; }
+ /// can we enter this cell?
+ virtual bool validCell(idx_type) const { return true; }
- ///
- virtual void UserSetSize(MathStyles &) {}
+ /// identifies certain types of insets
+ virtual MathArrayInset * asArrayInset() { return 0; }
+ virtual MathBraceInset * asBraceInset() { return 0; }
+ virtual MathBoxInset * asBoxInset() { return 0; }
+ virtual MathBoxInset const * asBoxInset() const { return 0; }
+ virtual MathCharInset const * asCharInset() const { return 0; }
+ virtual MathDelimInset * asDelimInset() { return 0; }
+ virtual MathDelimInset const * asDelimInset() const { return 0; }
+ virtual MathFuncInset * asFuncInset() { return 0; }
+ virtual MathFracInset * asFracInset() { return 0; }
+ virtual MathGridInset * asGridInset() { return 0; }
+ virtual MathHullInset * asHullInset() { return 0; }
+ virtual MathHullInset const * asHullInset() const { return 0; }
+ virtual MathMacroTemplate * asMacroTemplate() { return 0; }
+ virtual MathMatrixInset const * asMatrixInset() const { return 0; }
+ virtual MathNestInset * asNestInset() { return 0; }
+ virtual MathScriptInset * asScriptInset() { return 0; }
+ virtual MathScriptInset const * asScriptInset() const { return 0; }
+ virtual MathSpaceInset * asSpaceInset() { return 0; }
+ virtual MathStringInset * asStringInset() { return 0; }
+ virtual MathSymbolInset const * asSymbolInset() const { return 0; }
+ virtual MathUnknownInset const * asUnknownInset() const { return 0; }
+ virtual MathXYMatrixInset const* asXYMatrixInset() const{ return 0; }
+ virtual UpdatableInset * asHyperActiveInset() const { return 0; }
- ///
- void GetXY(int & x, int & y) const;
- ///
- bool covers(int x, int y) const;
- /// Identifies ScriptInsets
- virtual bool isUpDownInset() const { return false; }
- /// Identifies BigopInsets
- virtual bool isBigopInset() const { return false; }
- ///
+ /// identifies things that can get scripts
+ virtual bool isScriptable() const { return false; }
+ /// thing that can be moved into
virtual bool isActive() const { return nargs() > 0; }
+ /// identifies insets from the outer world
+ virtual bool isHyperActive() const { return 0; }
+ /// is the a relational operator (used for splitting equations)
+ virtual bool isRelOp() const { return false; }
+ /// return the content as char if the inset is able to do so
+ virtual char getChar() const { return 0; }
+ /// return the content's char code if it has one
+ virtual MathTextCodes code() const { return LM_TC_MIN; }
+ /// identifies things that can get \limits or \nolimits
+ virtual bool takesLimits() const { return false; }
+ /// identifies complicated things that need braces if used as arg
+ virtual bool needsBraces() const { return true; }
///
- void push_back(MathInset *);
- ///
- void push_back(byte ch, MathTextCodes fcode);
- ///
- void dump() const;
+ virtual void edit(BufferView *, int, int, unsigned int) {}
- ///
- ///
- static int workwidth;
-protected:
- ///
- string name_;
- ///
- MathInsetTypes objtype;
- ///
- int width_;
- ///
- int ascent_;
- ///
- int descent_;
- ///
- void size(MathStyles s);
- ///
- MathStyles size_;
+ /// request "external features"
+ virtual void validate(LaTeXFeatures & features) const;
+ /// char char code if possible
+ virtual void handleFont(MathTextCodes) {}
+ /// is this inset equal to a given other inset?
+ virtual bool match(MathInset *) const { return false; }
+ /// replace things by other things
+ virtual void replace(ReplaceData &) {}
+ /// do we contain a given subsequence?
+ virtual bool contains(MathArray const &) { return false; }
-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_;
-
-private:
- /// Cursor start position in pixels from the document top
- int xo_;
- ///
- int yo_;
+ /// write LaTeX and Lyx code
+ virtual void write(WriteStream & os) const;
+ /// write normalized content
+ virtual void normalize(NormalStream &) const;
+ /// write content as something readable by Maple
+ virtual void maplize(MapleStream &) const;
+ /// write content as something resembling MathML
+ virtual void mathmlize(MathMLStream &) const;
+ /// write content as something readable by Octave
+ virtual void octavize(OctaveStream &) const;
+ /// describe content
+ virtual void infoize(std::ostream &) const {}
+
+ /// dump content to stderr for debugging
+ virtual void dump() const;
};
std::ostream & operator<<(std::ostream &, MathInset const &);
projects / lyx.git / blobdiff