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;
79 /// short of anything else reasonable
80 typedef MathArray::size_type size_type;
81 /// type for cursor positions within a cell
82 typedef MathArray::size_type pos_type;
83 /// type for cell indices
84 typedef size_type idx_type;
85 /// type for row numbers
86 typedef size_type row_type;
87 /// type for column numbers
88 typedef size_type col_type;
90 /// our members behave nicely...
92 /// the virtual base destructor
93 virtual ~MathInset() {}
96 virtual void draw(Painter &, int x, int y) const;
97 /// write LaTeX and Lyx code
98 virtual void write(WriteStream & os) const;
100 virtual MathInset * clone() const = 0;
101 /// substitutes macro arguments if necessary
102 virtual void substitute(MathMacro const & macro);
103 /// compute the size of the object, sets ascend_, descend_ and width_
104 // updates the (xo,yo)-caches of all contained cells
105 virtual void metrics(MathMetricsInfo const & st) const;
106 /// the ascent of the inset above the baseline
107 virtual int ascent() const { return 1; }
108 /// the descent of the inset below the baseline
109 virtual int descent() const { return 1; }
111 virtual int width() const { return 2; }
112 /// total height (== ascent + descent)
113 virtual int height() const;
115 /// Where should we go when we press the up cursor key?
116 virtual bool idxUp(idx_type & idx, pos_type & pos) const;
118 virtual bool idxDown(idx_type & idx, pos_type & pos) const;
120 virtual bool idxLeft(idx_type & idx, pos_type & pos) const;
122 virtual bool idxRight(idx_type & idx, pos_type & pos) const;
124 /// Move one physical cell up
125 virtual bool idxNext(idx_type & idx, pos_type & pos) const;
126 /// Move one physical cell down
127 virtual bool idxPrev(idx_type & idx, pos_type & pos) const;
129 /// Target pos when we enter the inset from the left by pressing "Right"
130 virtual bool idxFirst(idx_type & idx, pos_type & pos) const;
131 /// Target pos when we enter the inset from the left by pressing "Up"
132 virtual bool idxFirstUp(idx_type & idx, pos_type & pos) const;
133 /// Target pos when we enter the inset from the left by pressing "Down"
134 virtual bool idxFirstDown(idx_type & idx, pos_type & pos) const;
135 /// Target pos when we enter the inset from the right by pressing "Left"
136 virtual bool idxLast(idx_type & idx, pos_type & pos) const;
137 /// Target pos when we enter the inset from the right by pressing "Up"
138 virtual bool idxLastUp(idx_type & idx, pos_type & pos) const;
139 /// Target pos when we enter the inset from the right by pressing "Down"
140 virtual bool idxLastDown(idx_type & idx, pos_type & pos) const;
142 /// Where should we go if we press home?
143 virtual bool idxHome(idx_type & idx, pos_type & pos) const;
144 /// Where should we go if we press end?
145 virtual bool idxEnd(idx_type & idx, pos_type & pos) const;
147 /// Delete a cell and move cursor
148 // the return value indicates whether the cursor should leave the inset
149 // and/or the whole inset should be deleted
150 virtual void idxDelete(idx_type & idx, bool & popit, bool & deleteit);
151 // deletes a cell range and moves the cursor
152 virtual void idxDeleteRange(idx_type from, idx_type to);
153 // returns list of cell indices that are "between" from and to for
154 // selection purposes
155 virtual std::vector<idx_type> idxBetween(idx_type from, idx_type to) const;
157 /// the number of nested cells this inset owns
158 virtual idx_type nargs() const;
160 /// return cell given its number
161 virtual MathArray & cell(idx_type);
162 /// return cell given its number
163 virtual MathArray const & cell(idx_type) const;
164 /// return cell plus drawing cache given its number
165 virtual MathXArray & xcell(idx_type);
166 /// return cell plus drawing cache given its number
167 virtual MathXArray const & xcell(idx_type) const;
169 /// the number of columns of this inset if it is grid-like
170 virtual col_type ncols() const { return 1; }
171 /// the number of rows of this inset if it is grid-like
172 virtual row_type nrows() const { return 1; }
173 /// to which column belongs a cell with a given index?
174 virtual col_type col(idx_type) const { return 0; }
175 /// to which row belongs a cell with a given index?
176 virtual row_type row(idx_type) const { return 0; }
177 /// any additional x-offset when drawing a cell?
178 virtual int cellXOffset(idx_type) const { return 0; }
179 /// any additional y-offset when drawing a cell?
180 virtual int cellYOffset(idx_type) const { return 0; }
181 /// add a row after a given one
182 virtual void addRow(row_type) {}
183 /// delete a given row
184 virtual void delRow(row_type) {}
185 /// add a column after a given one
186 virtual void addCol(col_type) {}
187 /// delete a given row
188 virtual void delCol(col_type) {}
190 /// does this inset cover the pixel at (x,y)?
191 virtual bool covers(int x, int y) const;
193 /// identifies certain types of insets
194 virtual MathArrayInset * asArrayInset() { return 0; }
195 virtual MathBoxInset * asBoxInset() { return 0; }
196 virtual MathCharInset const * asCharInset() const { return 0; }
197 virtual MathDelimInset * asDelimInset() { return 0; }
198 virtual MathDelimInset const * asDelimInset() const { return 0; }
199 virtual MathFuncInset * asFuncInset() { return 0; }
200 virtual MathFracInset * asFracInset() { return 0; }
201 virtual MathGridInset * asGridInset() { return 0; }
202 virtual MathHullInset * asHullInset() { return 0; }
203 virtual MathHullInset const * asHullInset() const { return 0; }
204 virtual MathMacroTemplate * asMacroTemplate() { return 0; }
205 virtual MathMatrixInset const * asMatrixInset() const { return 0; }
206 virtual MathNestInset * asNestInset() { return 0; }
207 virtual MathScriptInset * asScriptInset() { return 0; }
208 virtual MathScriptInset const * asScriptInset() const { return 0; }
209 virtual MathSpaceInset * asSpaceInset() { return 0; }
210 virtual MathStringInset * asStringInset() { return 0; }
211 virtual MathSymbolInset const * asSymbolInset() const { return 0; }
212 virtual UpdatableInset * asHyperActiveInset() const { return 0; }
214 /// identifies things that can get scripts
215 virtual bool isScriptable() const { return false; }
216 /// thing that can be moved into
217 virtual bool isActive() const { return nargs() > 0; }
218 /// identifies insets from the outer world
219 virtual bool isHyperActive() const { return 0; }
220 /// is the a relational operator (used for splitting equations)
221 virtual bool isRelOp() const { return false; }
223 /// return the content as char if the inset is able to do so
224 virtual char getChar() const { return 0; }
225 /// return the content's char code if it has one
226 virtual MathTextCodes code() const { return LM_TC_MIN; }
227 /// identifies things that can get \limits or \nolimits
228 virtual bool takesLimits() const { return false; }
231 virtual void edit(BufferView *, int, int, unsigned int) {}
233 /// request "external features"
234 virtual void validate(LaTeXFeatures & features) const;
235 /// char char code if possible
236 virtual void handleFont(MathTextCodes) {}
237 /// is this inset equal to a given other inset?
238 virtual bool match(MathInset *) const { return false; }
239 /// replace things by other things
240 virtual void replace(ReplaceData &) {}
242 /// write normalized content
243 virtual void normalize(NormalStream &) const;
244 /// write content as something readable by Maple
245 virtual void maplize(MapleStream &) const;
246 /// write content as something resembling MathML
247 virtual void mathmlize(MathMLStream &) const;
248 /// write content as something readable by Octave
249 virtual void octavize(OctaveStream &) const;
251 /// dump content to stderr for debugging
252 virtual void dump() const;
255 std::ostream & operator<<(std::ostream &, MathInset const &);