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
32 #include "frontends/mouse_state.h"
33 #include "math_xdata.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;
57 class MathMatrixInset;
59 class MathParboxInset;
60 class MathScriptInset;
61 class MathStringInset;
63 class MathSymbolInset;
64 class MathUnknownInset;
65 class MathXYMatrixInset;
66 class MathXYMatrixInset;
73 class MathematicaStream;
82 class MathMacroTemplate;
89 /// short of anything else reasonable
90 typedef MathArray::size_type size_type;
91 /// type for cursor positions differences within a cell
92 typedef MathArray::difference_type difference_type;
93 /// type for cursor positions within a cell
94 typedef MathArray::size_type pos_type;
95 /// type for cell indices
96 typedef size_type idx_type;
97 /// type for row numbers
98 typedef size_type row_type;
99 /// type for column numbers
100 typedef size_type col_type;
102 /// our members behave nicely...
104 /// the virtual base destructor
105 virtual ~MathInset() {}
108 virtual MathInset * clone() const = 0;
109 /// substitutes macro arguments if necessary
110 virtual void substitute(MathMacro const & macro);
111 /// compute the size of the object, sets ascend_, descend_ and width_
112 // updates the (xo,yo)-caches of all contained cells
113 virtual void metrics(MathMetricsInfo & st) const;
115 virtual void draw(MathPainterInfo &, int x, int y) const;
116 /// the ascent of the inset above the baseline
117 /// compute the size of the object for text based drawing
118 virtual void metricsT(TextMetricsInfo const & st) const;
119 /// draw the object as text
120 virtual void drawT(TextPainter &, int x, int y) const;
121 /// the ascent of the inset above the baseline
122 virtual int ascent() const { return 1; }
123 /// the descent of the inset below the baseline
124 virtual int descent() const { return 1; }
126 virtual int width() const { return 2; }
128 virtual void dimensions(Dimension & dim) const;
129 /// total height (== ascent + descent)
130 virtual int height() const;
131 /// get cursor position
132 virtual void getPos(idx_type idx, pos_type pos, int & x, int & y) const;
134 /// Where should we go when we press the up or down cursor key?
135 virtual bool idxUpDown(idx_type & idx, bool up) const;
137 virtual bool idxLeft(idx_type & idx, pos_type & pos) const;
139 virtual bool idxRight(idx_type & idx, pos_type & pos) const;
141 /// Move one physical cell up
142 virtual bool idxNext(idx_type & idx, pos_type & pos) const;
143 /// Move one physical cell down
144 virtual bool idxPrev(idx_type & idx, pos_type & pos) const;
146 /// Target pos when we enter the inset from the left by pressing "Right"
147 virtual bool idxFirst(idx_type & idx, pos_type & pos) const;
148 /// Target pos when we enter the inset from the right by pressing "Left"
149 virtual bool idxLast(idx_type & idx, pos_type & pos) const;
151 /// Where should we go if we press home?
152 virtual bool idxHome(idx_type & idx, pos_type & pos) const;
153 /// Where should we go if we press end?
154 virtual bool idxEnd(idx_type & idx, pos_type & pos) const;
156 /// Delete a cell and move cursor
157 virtual bool idxDelete(idx_type &) { return false; }
158 /// pulls cell after pressing erase
159 virtual void idxGlue(idx_type) {}
160 // returns list of cell indices that are "between" from and to for
161 // selection purposes
162 virtual std::vector<idx_type> idxBetween(idx_type from, idx_type to) const;
164 /// the number of nested cells this inset owns
165 virtual idx_type nargs() const;
167 /// return cell given its number
168 virtual MathArray & cell(idx_type);
169 /// return cell given its number
170 virtual MathArray const & cell(idx_type) const;
171 /// return cell plus drawing cache given its number
172 virtual MathXArray & xcell(idx_type);
173 /// return cell plus drawing cache given its number
174 virtual MathXArray const & xcell(idx_type) const;
176 /// the number of columns of this inset if it is grid-like
177 virtual col_type ncols() const { return 1; }
178 /// the number of rows of this inset if it is grid-like
179 virtual row_type nrows() const { return 1; }
180 /// to which column belongs a cell with a given index?
181 virtual col_type col(idx_type) const { return 0; }
182 /// to which row belongs a cell with a given index?
183 virtual row_type row(idx_type) const { return 0; }
184 /// cell idex corresponding to row and column;
185 virtual idx_type index(row_type row, col_type col) const;
186 /// any additional x-offset when drawing a cell?
187 virtual int cellXOffset(idx_type) const { return 0; }
188 /// any additional y-offset when drawing a cell?
189 virtual int cellYOffset(idx_type) const { return 0; }
190 /// can we enter this cell?
191 virtual bool validCell(idx_type) const { return true; }
193 /// identifies certain types of insets
194 virtual MathAMSArrayInset * asAMSArrayInset() { return 0; }
195 virtual MathArrayInset * asArrayInset() { 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 MathFracInset * asFracInset() { return 0; }
200 virtual MathGridInset * asGridInset() { return 0; }
201 virtual MathHullInset * asHullInset() { return 0; }
202 virtual MathHullInset const * asHullInset() const { return 0; }
203 virtual MathMacroTemplate * asMacroTemplate() { return 0; }
204 virtual MathMatrixInset const * asMatrixInset() const { return 0; }
205 virtual MathNestInset * asNestInset() { return 0; }
206 virtual MathParboxInset * asParboxInset() { 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 MathUnknownInset * asUnknownInset() { return 0; }
213 virtual MathUnknownInset const * asUnknownInset() const { return 0; }
214 virtual MathXYMatrixInset const* asXYMatrixInset() const{ return 0; }
215 virtual InsetRef * asInsetRef() { return 0; }
217 /// identifies things that can get scripts
218 virtual bool isScriptable() const { return false; }
219 /// thing that can be moved into
220 virtual bool isActive() const { return nargs() > 0; }
221 /// is the a relational operator (used for splitting equations)
222 virtual bool isRelOp() const { return false; }
223 /// -1: text mode, 1: math mode, 0 undecided
224 enum mode_type {UNDECIDED_MODE, TEXT_MODE, MATH_MODE};
225 virtual mode_type currentMode() const { return UNDECIDED_MODE; }
226 /// will this get written as a single block in {..}
227 virtual bool extraBraces() const { return false; }
229 /// return the content as char if the inset is able to do so
230 virtual char getChar() const { return 0; }
231 /// identifies things that can get \limits or \nolimits
232 virtual bool takesLimits() const { return false; }
235 virtual void edit(BufferView *, int, int, mouse_button::state) {}
237 /// request "external features"
238 virtual void validate(LaTeXFeatures & features) const;
239 /// char char code if possible
240 virtual void handleFont(string const &) {}
241 /// is this inset equal to a given other inset?
242 virtual bool match(MathInset *) const { return false; }
243 /// replace things by other things
244 virtual void replace(ReplaceData &) {}
245 /// do we contain a given subsequence?
246 virtual bool contains(MathArray const &) { return false; }
247 /// access to the lock (only nest array have one)
248 virtual bool lock() const { return false; }
249 /// access to the lock (only nest array have one)
250 virtual void lock(bool) {}
251 /// get notification when the cursor leaves this inset
252 virtual void notifyCursorLeaves() {}
254 /// write LaTeX and Lyx code
255 virtual void write(WriteStream & os) const;
256 /// write normalized content
257 virtual void normalize(NormalStream &) const;
258 /// write content as something readable by Maple
259 virtual void maplize(MapleStream &) const;
260 /// write content as something readable by Mathematica
261 virtual void mathematicize(MathematicaStream &) const;
262 /// write content as something resembling MathML
263 virtual void mathmlize(MathMLStream &) const;
264 /// write content as something readable by Octave
265 virtual void octavize(OctaveStream &) const;
267 virtual void infoize(std::ostream &) const {}
268 /// plain ascii output
269 virtual int ascii(std::ostream & os, int) const;
271 virtual int linuxdoc(std::ostream & os) const;
273 virtual int docbook(std::ostream & os, bool) const;
275 /// dump content to stderr for debugging
276 virtual void dump() const;
278 virtual int dispatch(string const & cmd, idx_type idx, pos_type pos);
281 virtual std::vector<string> getLabelList() const;
283 virtual bool numberedType() const { return false; }
285 virtual string const & getType() const;
287 virtual void mutate(string const &) {}
288 /// how is the inset called in the .lyx file?
289 virtual string fileInsetLabel() const { return "Formula"; }
292 std::ostream & operator<<(std::ostream &, MathInset const &);
293 std::ostream & operator<<(std::ostream &, MathAtom const &);
295 string asString(MathArray const & ar);
296 MathArray asArray(string const & str);
299 /// here to ssave a few includes in the insets
303 Dialogs * getDialogs();
304 LyXFunc * getLyXFunc();