// -*- 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.
*
#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.
- The formulaInset (a LyX inset) encapsulates a math inset.
+/**
+
+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.
+
*/
class MathArrayInset;
+class MathBraceInset;
class MathBoxInset;
class MathCharInset;
class MathDelimInset;
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:
+public:
/// short of anything else reasonable
- typedef MathArray::size_type size_type;
+ 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;
+ typedef MathArray::size_type pos_type;
/// type for cell indices
- typedef size_type idx_type;
+ typedef size_type idx_type;
/// type for row numbers
- typedef size_type row_type;
+ typedef size_type row_type;
/// type for column numbers
- typedef size_type col_type;
+ typedef size_type col_type;
- ///
- MathInset();
+ /// our members behave nicely...
+ MathInset() {}
/// the virtual base destructor
- virtual ~MathInset();
+ virtual ~MathInset() {}
- /// draw the object
- virtual void draw(Painter &, int x, int y) const;
- /// write LaTeX and Lyx code
- virtual void write(WriteStream & os) const;
/// reproduce itself
virtual MathInset * clone() const = 0;
/// substitutes macro arguments if necessary
/// 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
/// total height (== ascent + descent)
virtual int height() const;
- /// Where should we go when we press the up cursor key?
- virtual bool idxUp(idx_type & idx, pos_type & pos) const;
- /// The down key
- virtual bool idxDown(idx_type & idx, pos_type & 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(idx_type & idx, pos_type & pos) const;
/// The right key
/// Target pos when we enter the inset from the left by pressing "Right"
virtual bool idxFirst(idx_type & idx, pos_type & pos) const;
- /// Target pos when we enter the inset from the left by pressing "Up"
- virtual bool idxFirstUp(idx_type & idx, pos_type & pos) const;
- /// Target pos when we enter the inset from the left by pressing "Down"
- virtual bool idxFirstDown(idx_type & idx, pos_type & pos) const;
/// Target pos when we enter the inset from the right by pressing "Left"
virtual bool idxLast(idx_type & idx, pos_type & pos) const;
- /// Target pos when we enter the inset from the right by pressing "Up"
- virtual bool idxLastUp(idx_type & idx, pos_type & pos) const;
- /// Target pos when we enter the inset from the right by pressing "Down"
- virtual bool idxLastDown(idx_type & idx, pos_type & pos) const;
/// Where should we go if we press home?
virtual bool idxHome(idx_type & idx, pos_type & 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(idx_type & idx, bool & popit, bool & deleteit);
- // deletes a cell range and moves the cursor
- virtual void idxDeleteRange(idx_type from, idx_type to);
+ 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;
virtual MathXArray & xcell(idx_type);
/// return cell plus drawing cache given its number
virtual MathXArray const & xcell(idx_type) const;
-
+
/// 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 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; }
- /// add a row after a given one
- virtual void addRow(row_type) {}
- /// delete a given row
- virtual void delRow(row_type) {}
- /// add a column after a given one
- virtual void addCol(col_type) {}
- /// delete a given row
- virtual void delCol(col_type) {}
-
- /// does this inset cover the pixel at (x,y)?
- virtual bool covers(int x, int y) const;
+ /// can we enter this cell?
+ virtual bool validCell(idx_type) const { return true; }
/// identifies certain types of insets
- virtual MathArrayInset * asArrayInset() { return 0; }
- virtual MathBoxInset * asBoxInset() { 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 UpdatableInset * asHyperActiveInset() const { return 0; }
+ 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; }
/// identifies things that can get scripts
virtual bool isScriptable() const { return false; }
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; }
///
virtual void edit(BufferView *, int, int, unsigned int) {}
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; }
+ /// 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 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;
projects / lyx.git / blobdiff