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 & mi) const;
115 virtual void draw(MathPainterInfo & pi, int x, int y) const;
116 /// draw selection between two positions
117 virtual void drawSelection(MathPainterInfo & pi,
118 idx_type idx1, pos_type pos1, idx_type idx2, pos_type pos2) const;
119 /// the ascent of the inset above the baseline
120 /// compute the size of the object for text based drawing
121 virtual void metricsT(TextMetricsInfo const & st) const;
122 /// draw the object as text
123 virtual void drawT(TextPainter &, int x, int y) const;
124 /// the ascent of the inset above the baseline
125 virtual int ascent() const { return 1; }
126 /// the descent of the inset below the baseline
127 virtual int descent() const { return 1; }
129 virtual int width() const { return 2; }
131 virtual void dimensions(Dimension & dim) const;
132 /// total height (== ascent + descent)
133 virtual int height() const;
135 /// Where should we go when we press the up or down cursor key?
136 virtual bool idxUpDown(idx_type & idx, pos_type & pos, bool up) const;
138 virtual bool idxLeft(idx_type & idx, pos_type & pos) const;
140 virtual bool idxRight(idx_type & idx, pos_type & pos) const;
142 /// Move one physical cell up
143 virtual bool idxNext(idx_type & idx, pos_type & pos) const;
144 /// Move one physical cell down
145 virtual bool idxPrev(idx_type & idx, pos_type & pos) const;
147 /// Target pos when we enter the inset from the left by pressing "Right"
148 virtual bool idxFirst(idx_type & idx, pos_type & pos) const;
149 /// Target pos when we enter the inset from the right by pressing "Left"
150 virtual bool idxLast(idx_type & idx, pos_type & pos) const;
152 /// Where should we go if we press home?
153 virtual bool idxHome(idx_type & idx, pos_type & pos) const;
154 /// Where should we go if we press end?
155 virtual bool idxEnd(idx_type & idx, pos_type & pos) const;
157 /// Delete a cell and move cursor
158 virtual bool idxDelete(idx_type &) { return false; }
159 /// pulls cell after pressing erase
160 virtual void idxGlue(idx_type) {}
161 // returns list of cell indices that are "between" from and to for
162 // selection purposes
163 virtual std::vector<idx_type> idxBetween(idx_type from, idx_type to) const;
165 /// the number of nested cells this inset owns
166 virtual idx_type nargs() const;
168 /// return cell given its number
169 virtual MathArray & cell(idx_type);
170 /// return cell given its number
171 virtual MathArray const & cell(idx_type) const;
172 /// return cell plus drawing cache given its number
173 virtual MathXArray & xcell(idx_type);
174 /// return cell plus drawing cache given its number
175 virtual MathXArray const & xcell(idx_type) const;
177 /// the number of columns of this inset if it is grid-like
178 virtual col_type ncols() const { return 1; }
179 /// the number of rows of this inset if it is grid-like
180 virtual row_type nrows() const { return 1; }
181 /// to which column belongs a cell with a given index?
182 virtual col_type col(idx_type) const { return 0; }
183 /// to which row belongs a cell with a given index?
184 virtual row_type row(idx_type) const { return 0; }
185 /// cell idex corresponding to row and column;
186 virtual idx_type index(row_type row, col_type col) const;
187 /// any additional x-offset when drawing a cell?
188 virtual int cellXOffset(idx_type) const { return 0; }
189 /// any additional y-offset when drawing a cell?
190 virtual int cellYOffset(idx_type) const { return 0; }
191 /// can we enter this cell?
192 virtual bool validCell(idx_type) const { return true; }
194 virtual void getPos(idx_type idx, pos_type pos, int & x, int & y) const;
196 /// identifies certain types of insets
197 virtual MathAMSArrayInset * asAMSArrayInset() { return 0; }
198 virtual MathArrayInset * asArrayInset() { return 0; }
199 virtual MathCharInset const * asCharInset() const { return 0; }
200 virtual MathDelimInset * asDelimInset() { return 0; }
201 virtual MathDelimInset const * asDelimInset() const { return 0; }
202 virtual MathFracInset * asFracInset() { return 0; }
203 virtual MathGridInset * asGridInset() { return 0; }
204 virtual MathHullInset * asHullInset() { return 0; }
205 virtual MathHullInset const * asHullInset() const { return 0; }
206 virtual MathMacroTemplate * asMacroTemplate() { return 0; }
207 virtual MathMatrixInset const * asMatrixInset() const { return 0; }
208 virtual MathNestInset * asNestInset() { return 0; }
209 virtual MathParboxInset * asParboxInset() { return 0; }
210 virtual MathScriptInset * asScriptInset() { return 0; }
211 virtual MathScriptInset const * asScriptInset() const { return 0; }
212 virtual MathSpaceInset * asSpaceInset() { return 0; }
213 virtual MathStringInset * asStringInset() { return 0; }
214 virtual MathSymbolInset const * asSymbolInset() const { return 0; }
215 virtual MathUnknownInset * asUnknownInset() { return 0; }
216 virtual MathUnknownInset const * asUnknownInset() const { return 0; }
217 virtual MathXYMatrixInset const* asXYMatrixInset() const{ return 0; }
218 virtual InsetRef * asInsetRef() { return 0; }
220 /// identifies things that can get scripts
221 virtual bool isScriptable() const { return false; }
222 /// thing that can be moved into
223 virtual bool isActive() const { return nargs() > 0; }
224 /// is the a relational operator (used for splitting equations)
225 virtual bool isRelOp() const { return false; }
226 /// -1: text mode, 1: math mode, 0 undecided
227 enum mode_type {UNDECIDED_MODE, TEXT_MODE, MATH_MODE};
228 virtual mode_type currentMode() const { return UNDECIDED_MODE; }
229 /// will this get written as a single block in {..}
230 virtual bool extraBraces() const { return false; }
232 /// return the content as char if the inset is able to do so
233 virtual char getChar() const { return 0; }
234 /// identifies things that can get \limits or \nolimits
235 virtual bool takesLimits() const { return false; }
238 virtual void edit(BufferView *, int, int, mouse_button::state) {}
240 /// request "external features"
241 virtual void validate(LaTeXFeatures & features) const;
242 /// char char code if possible
243 virtual void handleFont(string const &) {}
244 /// is this inset equal to a given other inset?
245 virtual bool match(MathInset *) const { return false; }
246 /// replace things by other things
247 virtual void replace(ReplaceData &) {}
248 /// do we contain a given subsequence?
249 virtual bool contains(MathArray const &) { return false; }
250 /// access to the lock (only nest array have one)
251 virtual bool lock() const { return false; }
252 /// access to the lock (only nest array have one)
253 virtual void lock(bool) {}
254 /// get notification when the cursor leaves this inset
255 virtual void notifyCursorLeaves() {}
257 /// write LaTeX and Lyx code
258 virtual void write(WriteStream & os) const;
259 /// write normalized content
260 virtual void normalize(NormalStream &) const;
261 /// write content as something readable by Maple
262 virtual void maplize(MapleStream &) const;
263 /// write content as something readable by Mathematica
264 virtual void mathematicize(MathematicaStream &) const;
265 /// write content as something resembling MathML
266 virtual void mathmlize(MathMLStream &) const;
267 /// write content as something readable by Octave
268 virtual void octavize(OctaveStream &) const;
270 virtual void infoize(std::ostream &) const {}
271 /// plain ascii output
272 virtual int ascii(std::ostream & os, int) const;
274 virtual int linuxdoc(std::ostream & os) const;
276 virtual int docbook(std::ostream & os, bool) const;
278 /// dump content to stderr for debugging
279 virtual void dump() const;
281 virtual int dispatch(string const & cmd, idx_type idx, pos_type pos);
284 virtual std::vector<string> getLabelList() const;
286 virtual bool numberedType() const { return false; }
288 virtual string const & getType() const;
290 virtual void mutate(string const &) {}
291 /// how is the inset called in the .lyx file?
292 virtual string fileInsetLabel() const { return "Formula"; }
295 std::ostream & operator<<(std::ostream &, MathInset const &);
296 std::ostream & operator<<(std::ostream &, MathAtom const &);
298 string asString(MathArray const & ar);
299 MathArray asArray(string const & str);
302 /// here to ssave a few includes in the insets
306 Dialogs * getDialogs();
307 LyXFunc * getLyXFunc();