4 * Purpose: Declaration of insets for mathed
5 * Author: Alejandro Aguilar Sierra <asierra@servidor.unam.mx>
6 * Created: January 1996
7 * Description: Math paragraph and objects for a WYSIWYG math editor.
9 * Dependencies: Xlib, XForms
11 * Copyright: 1996, 1997 Alejandro Aguilar Sierra
13 * Version: 0.8beta, Math & Lyx project.
15 * You are free to use and modify this code under the terms of
16 * the GNU General Public Licence version 2 or later.
19 // Note: These math insets are internal to Math and are not derived
31 #include "math_xdata.h"
32 #include "math_defs.h"
36 Abstract base class for all math objects. A math insets is for use of the
37 math editor only, it isn't a general LyX inset. It's used to represent all
40 Math insets do not know there parents, a cursor position or things
41 like that. The are dumb object that are contained in other math insets
42 (mathNestInsets, in fact) thus forming a tree. The root of this tree is
43 always a mathHullInset, which provides an interface to the Outer World by
44 inclusion in the "real LyX insets" FormulaInset and FormulaMacroInset.
57 class MathMatrixInset;
59 class MathScriptInset;
60 class MathStringInset;
62 class MathSymbolInset;
74 class MathMacroTemplate;
80 /// short of anything else reasonable
81 typedef MathArray::size_type size_type;
82 /// type for cursor positions within a cell
83 typedef MathArray::size_type pos_type;
84 /// type for cell indices
85 typedef size_type idx_type;
86 /// type for row numbers
87 typedef size_type row_type;
88 /// type for column numbers
89 typedef size_type col_type;
91 /// our members behave nicely...
93 /// the virtual base destructor
94 virtual ~MathInset() {}
97 virtual void draw(Painter &, int x, int y) const;
98 /// write LaTeX and Lyx code
99 virtual void write(WriteStream & os) const;
101 virtual MathInset * clone() const = 0;
102 /// substitutes macro arguments if necessary
103 virtual void substitute(MathMacro const & macro);
104 /// compute the size of the object, sets ascend_, descend_ and width_
105 // updates the (xo,yo)-caches of all contained cells
106 virtual void metrics(MathMetricsInfo const & st) const;
107 /// the ascent of the inset above the baseline
108 virtual int ascent() const { return 1; }
109 /// the descent of the inset below the baseline
110 virtual int descent() const { return 1; }
112 virtual int width() const { return 2; }
113 /// total height (== ascent + descent)
114 virtual int height() const;
116 /// Where should we go when we press the up cursor key?
117 virtual bool idxUp(idx_type & idx) const;
119 virtual bool idxDown(idx_type & idx) const;
121 virtual bool idxLeft(idx_type & idx, pos_type & pos) const;
123 virtual bool idxRight(idx_type & idx, pos_type & pos) const;
125 /// Move one physical cell up
126 virtual bool idxNext(idx_type & idx, pos_type & pos) const;
127 /// Move one physical cell down
128 virtual bool idxPrev(idx_type & idx, pos_type & pos) const;
130 /// Target pos when we enter the inset from the left by pressing "Right"
131 virtual bool idxFirst(idx_type & idx, pos_type & pos) const;
132 /// Target pos when we enter the inset from the right by pressing "Left"
133 virtual bool idxLast(idx_type & idx, pos_type & pos) const;
135 /// Where should we go if we press home?
136 virtual bool idxHome(idx_type & idx, pos_type & pos) const;
137 /// Where should we go if we press end?
138 virtual bool idxEnd(idx_type & idx, pos_type & pos) const;
140 /// Delete a cell and move cursor
141 // the return value indicates whether the cursor should leave the inset
142 // and/or the whole inset should be deleted
143 virtual void idxDelete(idx_type & idx, bool & popit, bool & deleteit);
144 // deletes a cell range and moves the cursor
145 virtual void idxDeleteRange(idx_type from, idx_type to);
146 // returns list of cell indices that are "between" from and to for
147 // selection purposes
148 virtual std::vector<idx_type> idxBetween(idx_type from, idx_type to) const;
150 /// the number of nested cells this inset owns
151 virtual idx_type nargs() const;
153 /// return cell given its number
154 virtual MathArray & cell(idx_type);
155 /// return cell given its number
156 virtual MathArray const & cell(idx_type) const;
157 /// return cell plus drawing cache given its number
158 virtual MathXArray & xcell(idx_type);
159 /// return cell plus drawing cache given its number
160 virtual MathXArray const & xcell(idx_type) const;
162 /// the number of columns of this inset if it is grid-like
163 virtual col_type ncols() const { return 1; }
164 /// the number of rows of this inset if it is grid-like
165 virtual row_type nrows() const { return 1; }
166 /// to which column belongs a cell with a given index?
167 virtual col_type col(idx_type) const { return 0; }
168 /// to which row belongs a cell with a given index?
169 virtual row_type row(idx_type) const { return 0; }
170 /// any additional x-offset when drawing a cell?
171 virtual int cellXOffset(idx_type) const { return 0; }
172 /// any additional y-offset when drawing a cell?
173 virtual int cellYOffset(idx_type) const { return 0; }
175 /// identifies certain types of insets
176 virtual MathArrayInset * asArrayInset() { return 0; }
177 virtual MathBoxInset * asBoxInset() { return 0; }
178 virtual MathCharInset const * asCharInset() const { return 0; }
179 virtual MathDelimInset * asDelimInset() { return 0; }
180 virtual MathDelimInset const * asDelimInset() const { return 0; }
181 virtual MathFuncInset * asFuncInset() { return 0; }
182 virtual MathFracInset * asFracInset() { return 0; }
183 virtual MathGridInset * asGridInset() { return 0; }
184 virtual MathHullInset * asHullInset() { return 0; }
185 virtual MathHullInset const * asHullInset() const { return 0; }
186 virtual MathMacroTemplate * asMacroTemplate() { return 0; }
187 virtual MathMatrixInset const * asMatrixInset() const { return 0; }
188 virtual MathNestInset * asNestInset() { return 0; }
189 virtual MathScriptInset * asScriptInset() { return 0; }
190 virtual MathScriptInset const * asScriptInset() const { return 0; }
191 virtual MathSpaceInset * asSpaceInset() { return 0; }
192 virtual MathStringInset * asStringInset() { return 0; }
193 virtual MathSymbolInset const * asSymbolInset() const { return 0; }
194 virtual UpdatableInset * asHyperActiveInset() const { return 0; }
196 /// identifies things that can get scripts
197 virtual bool isScriptable() const { return false; }
198 /// thing that can be moved into
199 virtual bool isActive() const { return nargs() > 0; }
200 /// identifies insets from the outer world
201 virtual bool isHyperActive() const { return 0; }
202 /// is the a relational operator (used for splitting equations)
203 virtual bool isRelOp() const { return false; }
205 /// return the content as char if the inset is able to do so
206 virtual char getChar() const { return 0; }
207 /// return the content's char code if it has one
208 virtual MathTextCodes code() const { return LM_TC_MIN; }
209 /// identifies things that can get \limits or \nolimits
210 virtual bool takesLimits() const { return false; }
213 virtual void edit(BufferView *, int, int, unsigned int) {}
215 /// request "external features"
216 virtual void validate(LaTeXFeatures & features) const;
217 /// char char code if possible
218 virtual void handleFont(MathTextCodes) {}
219 /// is this inset equal to a given other inset?
220 virtual bool match(MathInset *) const { return false; }
221 /// replace things by other things
222 virtual void replace(ReplaceData &) {}
224 /// write normalized content
225 virtual void normalize(NormalStream &) const;
226 /// write content as something readable by Maple
227 virtual void maplize(MapleStream &) const;
228 /// write content as something resembling MathML
229 virtual void mathmlize(MathMLStream &) const;
230 /// write content as something readable by Octave
231 virtual void octavize(OctaveStream &) const;
233 /// dump content to stderr for debugging
234 virtual void dump() const;
237 std::ostream & operator<<(std::ostream &, MathInset const &);