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
29 #include "frontends/mouse_state.h"
30 #include "insets/insetbase.h"
31 #include "math_data.h"
35 Abstract base class for all math objects. A math insets is for use of the
36 math editor only, it isn't a general LyX inset. It's used to represent all
39 Math insets do not know there parents, a cursor position or things
40 like that. The are dumb object that are contained in other math insets
41 (mathNestInsets, in fact) thus forming a tree. The root of this tree is
42 always a mathHullInset, which provides an interface to the Outer World by
43 inclusion in the "real LyX insets" FormulaInset and FormulaMacroInset.
49 class MathAMSArrayInset;
56 class MathMatrixInset;
58 class MathParboxInset;
59 class MathScriptInset;
60 class MathStringInset;
62 class MathSymbolInset;
63 class MathUnknownInset;
71 class MathematicaStream;
80 class MathMacroTemplate;
86 class MathInset : public InsetBase {
88 /// short of anything else reasonable
89 typedef MathArray::size_type size_type;
90 /// type for cursor positions differences within a cell
91 typedef MathArray::difference_type difference_type;
92 /// type for cursor positions within a cell
93 typedef MathArray::size_type pos_type;
94 /// type for cell indices
95 typedef size_type idx_type;
96 /// type for row numbers
97 typedef size_type row_type;
98 /// type for column numbers
99 typedef size_type col_type;
101 typedef InsetBase::dispatch_result result_type;
103 /// our members behave nicely...
105 /// the virtual base destructor
106 virtual ~MathInset() {}
109 virtual MathInset * clone() const = 0;
110 /// substitutes macro arguments if necessary
111 virtual void substitute(MathMacro const & macro);
112 /// compute the size of the object, sets ascend_, descend_ and width_
113 // updates the (xo,yo)-caches of all contained cells
114 virtual void metrics(MathMetricsInfo & mi) const;
116 virtual void draw(MathPainterInfo & pi, int x, int y) const;
117 /// draw selection between two positions
118 virtual void drawSelection(MathPainterInfo & pi,
119 idx_type idx1, pos_type pos1, idx_type idx2, pos_type pos2) const;
120 /// the ascent of the inset above the baseline
121 /// compute the size of the object for text based drawing
122 virtual void metricsT(TextMetricsInfo const & st) const;
123 /// draw the object as text
124 virtual void drawT(TextPainter &, int x, int y) const;
125 /// the ascent of the inset above the baseline
126 virtual int ascent() const { return 1; }
127 /// the descent of the inset below the baseline
128 virtual int descent() const { return 1; }
130 virtual int width() const { return 2; }
132 virtual Dimension dimensions() const;
133 /// total height (== ascent + descent)
134 virtual int height() const;
136 /// Where should we go when we press the up or down cursor key?
137 virtual bool idxUpDown(idx_type & idx, pos_type & pos, bool up,
140 virtual bool idxLeft(idx_type & idx, pos_type & pos) const;
142 virtual bool idxRight(idx_type & idx, pos_type & pos) const;
144 /// Move one physical cell up
145 virtual bool idxNext(idx_type & idx, pos_type & pos) const;
146 /// Move one physical cell down
147 virtual bool idxPrev(idx_type & idx, pos_type & pos) const;
149 /// Target pos when we enter the inset from the left by pressing "Right"
150 virtual bool idxFirst(idx_type & idx, pos_type & pos) const;
151 /// Target pos when we enter the inset from the right by pressing "Left"
152 virtual bool idxLast(idx_type & idx, pos_type & pos) const;
154 /// Where should we go if we press home?
155 virtual bool idxHome(idx_type & idx, pos_type & pos) const;
156 /// Where should we go if we press end?
157 virtual bool idxEnd(idx_type & idx, pos_type & pos) const;
159 /// Delete a cell and move cursor
160 virtual bool idxDelete(idx_type &) { return false; }
161 /// pulls cell after pressing erase
162 virtual void idxGlue(idx_type) {}
163 // returns list of cell indices that are "between" from and to for
164 // selection purposes
165 virtual bool idxBetween(idx_type idx, idx_type from, idx_type to) const;
167 /// the number of nested cells this inset owns
168 virtual idx_type nargs() const;
170 /// return cell given its number
171 virtual MathArray & cell(idx_type);
172 /// return cell given its number
173 virtual MathArray const & cell(idx_type) const;
175 /// the number of columns of this inset if it is grid-like
176 virtual col_type ncols() const { return 1; }
177 /// the number of rows of this inset if it is grid-like
178 virtual row_type nrows() const { return 1; }
179 /// to which column belongs a cell with a given index?
180 virtual col_type col(idx_type) const { return 0; }
181 /// to which row belongs a cell with a given index?
182 virtual row_type row(idx_type) const { return 0; }
183 /// cell idex corresponding to row and column;
184 virtual idx_type index(row_type row, col_type col) const;
185 /// any additional x-offset when drawing a cell?
186 virtual int cellXOffset(idx_type) const { return 0; }
187 /// any additional y-offset when drawing a cell?
188 virtual int cellYOffset(idx_type) const { return 0; }
189 /// can we enter this cell?
190 virtual bool validCell(idx_type) const { return true; }
192 virtual void getPos(idx_type idx, pos_type pos, int & x, int & y) const;
194 /// identifies certain types of insets
195 virtual MathAMSArrayInset * asAMSArrayInset() { return 0; }
196 virtual MathAMSArrayInset const * asAMSArrayInset() const { return 0; }
197 virtual MathArrayInset * asArrayInset() { return 0; }
198 virtual MathArrayInset const * asArrayInset() const { 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 MathFracInset const * asFracInset() const { return 0; }
204 virtual MathFontInset * asFontInset() { return 0; }
205 virtual MathFontInset const * asFontInset() const { return 0; }
206 virtual MathGridInset * asGridInset() { return 0; }
207 virtual MathGridInset const * asGridInset() const { return 0; }
208 virtual MathHullInset * asHullInset() { return 0; }
209 virtual MathHullInset const * asHullInset() const { return 0; }
210 virtual MathMacroTemplate * asMacroTemplate() { return 0; }
211 virtual MathMacroTemplate const * asMacroTemplate() const { return 0; }
212 virtual MathMatrixInset const * asMatrixInset() const { return 0; }
213 virtual MathNestInset * asNestInset() { return 0; }
214 virtual MathNestInset const * asNestInset() const { return 0; }
215 virtual MathParboxInset * asParboxInset() { return 0; }
216 virtual MathScriptInset * asScriptInset() { return 0; }
217 virtual MathScriptInset const * asScriptInset() const { return 0; }
218 virtual MathSpaceInset * asSpaceInset() { return 0; }
219 virtual MathSpaceInset const * asSpaceInset() const { return 0; }
220 virtual MathStringInset * asStringInset() { return 0; }
221 virtual MathStringInset const * asStringInset() const { return 0; }
222 virtual MathSymbolInset const * asSymbolInset() const { return 0; }
223 virtual MathUnknownInset * asUnknownInset() { return 0; }
224 virtual MathUnknownInset const * asUnknownInset() const { return 0; }
225 virtual InsetRef * asInsetRef() { return 0; }
227 /// identifies things that can get scripts
228 virtual bool isScriptable() const { return false; }
229 /// thing that can be moved into
230 virtual bool isActive() const { return nargs() > 0; }
231 /// is the a relational operator (used for splitting equations)
232 virtual bool isRelOp() const { return false; }
233 /// -1: text mode, 1: math mode, 0 undecided
234 enum mode_type {UNDECIDED_MODE, TEXT_MODE, MATH_MODE};
236 virtual mode_type currentMode() const { return UNDECIDED_MODE; }
237 /// will this get written as a single block in {..}
238 virtual bool extraBraces() const { return false; }
240 /// return the content as char if the inset is able to do so
241 virtual char getChar() const { return 0; }
242 /// identifies things that can get \limits or \nolimits
243 virtual bool takesLimits() const { return false; }
246 virtual void edit(BufferView *, int, int, mouse_button::state) {}
248 /// request "external features"
249 virtual void validate(LaTeXFeatures &) const {}
250 /// char char code if possible
251 virtual void handleFont(string const &) {}
252 /// is this inset equal to a given other inset?
253 virtual bool match(MathAtom const &) const { return false; }
254 /// replace things by other things
255 virtual void replace(ReplaceData &) {}
256 /// do we contain a given subsequence?
257 virtual bool contains(MathArray const &) const { return false; }
258 /// access to the lock (only nest array have one)
259 virtual bool lock() const { return false; }
260 /// access to the lock (only nest array have one)
261 virtual void lock(bool) {}
262 /// get notification when the cursor leaves this inset
263 virtual void notifyCursorLeaves(idx_type) {}
265 /// write LaTeX and Lyx code
266 virtual void write(WriteStream & os) const;
267 /// write normalized content
268 virtual void normalize(NormalStream &) const;
269 /// write content as something readable by Maple
270 virtual void maple(MapleStream &) const;
271 /// write content as something readable by Maxima
272 virtual void maxima(MaximaStream &) const;
273 /// write content as something readable by Mathematica
274 virtual void mathematica(MathematicaStream &) const;
275 /// write content as something resembling MathML
276 virtual void mathmlize(MathMLStream &) const;
277 /// write content as something readable by Octave
278 virtual void octave(OctaveStream &) const;
279 /// describe content if cursor inside
280 virtual void infoize(std::ostream &) const {}
281 /// describe content if cursor behind
282 virtual void infoize2(std::ostream &) const {}
283 /// plain ascii output
284 virtual int ascii(std::ostream & os, int) const;
286 virtual int linuxdoc(std::ostream & os) const;
288 virtual int docbook(std::ostream & os, bool) const;
290 /// dump content to stderr for debugging
291 virtual void dump() const;
293 virtual result_type dispatch
294 (FuncRequest const & cmd, idx_type & idx, pos_type & pos);
297 /// write labels into a list
298 virtual void getLabelList(std::vector<string> &) const {}
300 virtual bool numberedType() const { return false; }
302 virtual string const & getType() const;
304 virtual void mutate(string const &) {}
305 /// how is the inset called in the .lyx file?
306 virtual string fileInsetLabel() const { return "Formula"; }
307 /// usually the latex name
308 virtual string name() const;
311 std::ostream & operator<<(std::ostream &, MathAtom const &);
313 // converts single cell to string
314 string asString(MathArray const & ar);
315 // converts string to single cell
316 MathArray asArray(string const & str);
321 /// here to ssave a few includes in the insets
323 Dialogs & getDialogs();