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_data.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;
71 class MathematicaStream;
80 class MathMacroTemplate;
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 /// our members behave nicely...
103 /// the virtual base destructor
104 virtual ~MathInset() {}
107 virtual MathInset * clone() const = 0;
108 /// substitutes macro arguments if necessary
109 virtual void substitute(MathMacro const & macro);
110 /// compute the size of the object, sets ascend_, descend_ and width_
111 // updates the (xo,yo)-caches of all contained cells
112 virtual void metrics(MathMetricsInfo & mi) const;
114 virtual void draw(MathPainterInfo & pi, int x, int y) const;
115 /// draw selection between two positions
116 virtual void drawSelection(MathPainterInfo & pi,
117 idx_type idx1, pos_type pos1, idx_type idx2, pos_type pos2) const;
118 /// the ascent of the inset above the baseline
119 /// compute the size of the object for text based drawing
120 virtual void metricsT(TextMetricsInfo const & st) const;
121 /// draw the object as text
122 virtual void drawT(TextPainter &, int x, int y) const;
123 /// the ascent of the inset above the baseline
124 virtual int ascent() const { return 1; }
125 /// the descent of the inset below the baseline
126 virtual int descent() const { return 1; }
128 virtual int width() const { return 2; }
130 virtual Dimension dimensions() const;
131 /// total height (== ascent + descent)
132 virtual int height() const;
134 /// Where should we go when we press the up or down cursor key?
135 virtual bool idxUpDown(idx_type & idx, pos_type & pos, bool up,
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 bool idxBetween(idx_type idx, 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;
173 /// the number of columns of this inset if it is grid-like
174 virtual col_type ncols() const { return 1; }
175 /// the number of rows of this inset if it is grid-like
176 virtual row_type nrows() const { return 1; }
177 /// to which column belongs a cell with a given index?
178 virtual col_type col(idx_type) const { return 0; }
179 /// to which row belongs a cell with a given index?
180 virtual row_type row(idx_type) const { return 0; }
181 /// cell idex corresponding to row and column;
182 virtual idx_type index(row_type row, col_type col) const;
183 /// any additional x-offset when drawing a cell?
184 virtual int cellXOffset(idx_type) const { return 0; }
185 /// any additional y-offset when drawing a cell?
186 virtual int cellYOffset(idx_type) const { return 0; }
187 /// can we enter this cell?
188 virtual bool validCell(idx_type) const { return true; }
190 virtual void getPos(idx_type idx, pos_type pos, int & x, int & y) const;
192 /// identifies certain types of insets
193 virtual MathAMSArrayInset * asAMSArrayInset() { return 0; }
194 virtual MathAMSArrayInset const * asAMSArrayInset() const { return 0; }
195 virtual MathArrayInset * asArrayInset() { return 0; }
196 virtual MathArrayInset const * asArrayInset() const { return 0; }
197 virtual MathCharInset const * asCharInset() const { return 0; }
198 virtual MathDelimInset * asDelimInset() { return 0; }
199 virtual MathDelimInset const * asDelimInset() const { return 0; }
200 virtual MathFracInset * asFracInset() { return 0; }
201 virtual MathFracInset const * asFracInset() const { return 0; }
202 virtual MathGridInset * asGridInset() { return 0; }
203 virtual MathGridInset const * asGridInset() const { return 0; }
204 virtual MathHullInset * asHullInset() { return 0; }
205 virtual MathHullInset const * asHullInset() const { return 0; }
206 virtual MathMacroTemplate * asMacroTemplate() { return 0; }
207 virtual MathMacroTemplate const * asMacroTemplate() const { return 0; }
208 virtual MathMatrixInset const * asMatrixInset() const { return 0; }
209 virtual MathNestInset * asNestInset() { return 0; }
210 virtual MathNestInset const * asNestInset() const { return 0; }
211 virtual MathParboxInset * asParboxInset() { return 0; }
212 virtual MathScriptInset * asScriptInset() { return 0; }
213 virtual MathScriptInset const * asScriptInset() const { return 0; }
214 virtual MathSpaceInset * asSpaceInset() { return 0; }
215 virtual MathSpaceInset const * asSpaceInset() const { return 0; }
216 virtual MathStringInset * asStringInset() { return 0; }
217 virtual MathStringInset const * asStringInset() const { return 0; }
218 virtual MathSymbolInset const * asSymbolInset() const { return 0; }
219 virtual MathUnknownInset * asUnknownInset() { return 0; }
220 virtual MathUnknownInset const * asUnknownInset() const { return 0; }
221 virtual InsetRef * asInsetRef() { return 0; }
223 /// identifies things that can get scripts
224 virtual bool isScriptable() const { return false; }
225 /// thing that can be moved into
226 virtual bool isActive() const { return nargs() > 0; }
227 /// is the a relational operator (used for splitting equations)
228 virtual bool isRelOp() const { return false; }
229 /// -1: text mode, 1: math mode, 0 undecided
230 enum mode_type {UNDECIDED_MODE, TEXT_MODE, MATH_MODE, VERBATIM_MODE};
231 /// Dispatch result codes, see inset/inset.h
233 UNDISPATCHED = 0, DISPATCHED, DISPATCHED_NOUPDATE,
234 FINISHED, FINISHED_RIGHT, FINISHED_UP, FINISHED_DOWN,
238 virtual mode_type currentMode() const { return UNDECIDED_MODE; }
239 /// will this get written as a single block in {..}
240 virtual bool extraBraces() const { return false; }
242 /// return the content as char if the inset is able to do so
243 virtual char getChar() const { return 0; }
244 /// identifies things that can get \limits or \nolimits
245 virtual bool takesLimits() const { return false; }
248 virtual void edit(BufferView *, int, int, mouse_button::state) {}
250 /// request "external features"
251 virtual void validate(LaTeXFeatures &) const {}
252 /// char char code if possible
253 virtual void handleFont(string const &) {}
254 /// is this inset equal to a given other inset?
255 virtual bool match(MathAtom const &) const { return false; }
256 /// replace things by other things
257 virtual void replace(ReplaceData &) {}
258 /// do we contain a given subsequence?
259 virtual bool contains(MathArray const &) const { return false; }
260 /// access to the lock (only nest array have one)
261 virtual bool lock() const { return false; }
262 /// access to the lock (only nest array have one)
263 virtual void lock(bool) {}
264 /// get notification when the cursor leaves this inset
265 virtual void notifyCursorLeaves() {}
267 /// write LaTeX and Lyx code
268 virtual void write(WriteStream & os) const;
269 /// write normalized content
270 virtual void normalize(NormalStream &) const;
271 /// write content as something readable by Maple
272 virtual void maplize(MapleStream &) const;
273 /// write content as something readable by Mathematica
274 virtual void mathematicize(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 octavize(OctaveStream &) const;
280 virtual void infoize(std::ostream &) const {}
281 /// plain ascii output
282 virtual int ascii(std::ostream & os, int) const;
284 virtual int linuxdoc(std::ostream & os) const;
286 virtual int docbook(std::ostream & os, bool) const;
288 /// dump content to stderr for debugging
289 virtual void dump() const;
291 virtual result_type dispatch
292 (FuncRequest const & cmd, idx_type & idx, pos_type & pos);
295 /// write labels into a list
296 virtual void getLabelList(std::vector<string> &) const {}
298 virtual bool numberedType() const { return false; }
300 virtual string const & getType() const;
302 virtual void mutate(string const &) {}
303 /// how is the inset called in the .lyx file?
304 virtual string fileInsetLabel() const { return "Formula"; }
305 /// usually the latex name
306 virtual string name() const;
309 std::ostream & operator<<(std::ostream &, MathAtom const &);
311 // converts single cell to string
312 string asString(MathArray const & ar);
313 // converts string to single cell
314 MathArray asArray(string const & str);
319 /// here to ssave a few includes in the insets
321 Dialogs & getDialogs();