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 "frontends/mouse_state.h"
32 #include "math_xdata.h"
33 #include "math_defs.h"
37 Abstract base class for all math objects. A math insets is for use of the
38 math editor only, it isn't a general LyX inset. It's used to represent all
41 Math insets do not know there parents, a cursor position or things
42 like that. The are dumb object that are contained in other math insets
43 (mathNestInsets, in fact) thus forming a tree. The root of this tree is
44 always a mathHullInset, which provides an interface to the Outer World by
45 inclusion in the "real LyX insets" FormulaInset and FormulaMacroInset.
51 class MathAMSArrayInset;
60 class MathMatrixInset;
62 class MathScriptInset;
63 class MathStringInset;
65 class MathSymbolInset;
66 class MathUnknownInset;
67 class MathXYMatrixInset;
80 class MathMacroTemplate;
86 /// short of anything else reasonable
87 typedef MathArray::size_type size_type;
88 /// type for cursor positions differences within a cell
89 typedef MathArray::difference_type difference_type;
90 /// type for cursor positions within a cell
91 typedef MathArray::size_type pos_type;
92 /// type for cell indices
93 typedef size_type idx_type;
94 /// type for row numbers
95 typedef size_type row_type;
96 /// type for column numbers
97 typedef size_type col_type;
99 /// our members behave nicely...
101 /// the virtual base destructor
102 virtual ~MathInset() {}
105 virtual MathInset * clone() const = 0;
106 /// substitutes macro arguments if necessary
107 virtual void substitute(MathMacro const & macro);
108 /// compute the size of the object, sets ascend_, descend_ and width_
109 // updates the (xo,yo)-caches of all contained cells
110 virtual void metrics(MathMetricsInfo const & st) const;
112 virtual void draw(Painter &, int x, int y) const;
113 /// the ascent of the inset above the baseline
114 /// compute the size of the object for text based drawing
115 virtual void metricsT(TextMetricsInfo const & st) const;
116 /// draw the object as text
117 virtual void drawT(TextPainter &, int x, int y) const;
118 /// the ascent of the inset above the baseline
119 virtual int ascent() const { return 1; }
120 /// the descent of the inset below the baseline
121 virtual int descent() const { return 1; }
123 virtual int width() const { return 2; }
124 /// total height (== ascent + descent)
125 virtual int height() const;
127 /// Where should we go when we press the up or down cursor key?
128 virtual bool idxUpDown(idx_type & idx, bool up) const;
130 virtual bool idxLeft(idx_type & idx, pos_type & pos) const;
132 virtual bool idxRight(idx_type & idx, pos_type & pos) const;
134 /// Move one physical cell up
135 virtual bool idxNext(idx_type & idx, pos_type & pos) const;
136 /// Move one physical cell down
137 virtual bool idxPrev(idx_type & idx, pos_type & pos) const;
139 /// Target pos when we enter the inset from the left by pressing "Right"
140 virtual bool idxFirst(idx_type & idx, pos_type & pos) const;
141 /// Target pos when we enter the inset from the right by pressing "Left"
142 virtual bool idxLast(idx_type & idx, pos_type & pos) const;
144 /// Where should we go if we press home?
145 virtual bool idxHome(idx_type & idx, pos_type & pos) const;
146 /// Where should we go if we press end?
147 virtual bool idxEnd(idx_type & idx, pos_type & pos) const;
149 /// Delete a cell and move cursor
150 virtual bool idxDelete(idx_type &) { return false; }
151 /// pulls cell after pressing erase
152 virtual void idxGlue(idx_type) {}
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 /// cell idex corresponding to row and column;
178 virtual idx_type index(row_type row, col_type col) const;
179 /// any additional x-offset when drawing a cell?
180 virtual int cellXOffset(idx_type) const { return 0; }
181 /// any additional y-offset when drawing a cell?
182 virtual int cellYOffset(idx_type) const { return 0; }
183 /// can we enter this cell?
184 virtual bool validCell(idx_type) const { return true; }
186 /// identifies certain types of insets
187 virtual MathAMSArrayInset * asAMSArrayInset() { return 0; }
188 virtual MathArrayInset * asArrayInset() { return 0; }
189 virtual MathBraceInset * asBraceInset() { return 0; }
190 virtual MathBoxInset * asBoxInset() { return 0; }
191 virtual MathBoxInset const * asBoxInset() const { return 0; }
192 virtual MathCharInset const * asCharInset() const { return 0; }
193 virtual MathDelimInset * asDelimInset() { return 0; }
194 virtual MathDelimInset const * asDelimInset() const { return 0; }
195 virtual MathFuncInset * asFuncInset() { return 0; }
196 virtual MathFracInset * asFracInset() { return 0; }
197 virtual MathGridInset * asGridInset() { return 0; }
198 virtual MathHullInset * asHullInset() { return 0; }
199 virtual MathHullInset const * asHullInset() const { return 0; }
200 virtual MathMacroTemplate * asMacroTemplate() { return 0; }
201 virtual MathMatrixInset const * asMatrixInset() const { return 0; }
202 virtual MathNestInset * asNestInset() { return 0; }
203 virtual MathScriptInset * asScriptInset() { return 0; }
204 virtual MathScriptInset const * asScriptInset() const { return 0; }
205 virtual MathSpaceInset * asSpaceInset() { return 0; }
206 virtual MathStringInset * asStringInset() { return 0; }
207 virtual MathSymbolInset const * asSymbolInset() const { return 0; }
208 virtual MathUnknownInset const * asUnknownInset() const { return 0; }
209 virtual MathXYMatrixInset const* asXYMatrixInset() const{ return 0; }
211 /// identifies things that can get scripts
212 virtual bool isScriptable() const { return false; }
213 /// thing that can be moved into
214 virtual bool isActive() const { return nargs() > 0; }
215 /// is the a relational operator (used for splitting equations)
216 virtual bool isRelOp() const { return false; }
218 /// return the content as char if the inset is able to do so
219 virtual char getChar() const { return 0; }
220 /// return the content's char code if it has one
221 virtual MathTextCodes code() const { return LM_TC_MIN; }
222 /// identifies things that can get \limits or \nolimits
223 virtual bool takesLimits() const { return false; }
224 /// identifies complicated things that need braces if used as arg
225 virtual bool needsBraces() const { return true; }
228 virtual void edit(BufferView *, int, int, mouse_button::state) {}
230 /// request "external features"
231 virtual void validate(LaTeXFeatures & features) const;
232 /// char char code if possible
233 virtual void handleFont(MathTextCodes) {}
234 /// is this inset equal to a given other inset?
235 virtual bool match(MathInset *) const { return false; }
236 /// replace things by other things
237 virtual void replace(ReplaceData &) {}
238 /// do we contain a given subsequence?
239 virtual bool contains(MathArray const &) { return false; }
241 /// write LaTeX and Lyx code
242 virtual void write(WriteStream & os) const;
243 /// write normalized content
244 virtual void normalize(NormalStream &) const;
245 /// write content as something readable by Maple
246 virtual void maplize(MapleStream &) const;
247 /// write content as something resembling MathML
248 virtual void mathmlize(MathMLStream &) const;
249 /// write content as something readable by Octave
250 virtual void octavize(OctaveStream &) const;
252 virtual void infoize(std::ostream &) const {}
254 /// dump content to stderr for debugging
255 virtual void dump() const;
258 std::ostream & operator<<(std::ostream &, MathInset const &);
259 std::ostream & operator<<(std::ostream &, MathAtom const &);