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
28 #include "insets/insetbase.h"
29 #include "math_data.h"
33 Abstract base class for all math objects. A math insets is for use of the
34 math editor only, it isn't a general LyX inset. It's used to represent all
37 Math insets do not know there parents, a cursor position or things
38 like that. The are dumb object that are contained in other math insets
39 (mathNestInsets, in fact) thus forming a tree. The root of this tree is
40 always a mathHullInset, which provides an interface to the Outer World by
41 inclusion in the "real LyX insets" FormulaInset and FormulaMacroInset.
47 class MathAMSArrayInset;
54 class MathMatrixInset;
56 class MathParboxInset;
57 class MathScriptInset;
58 class MathStringInset;
60 class MathSymbolInset;
61 class MathUnknownInset;
69 class MathematicaStream;
78 class MathMacroTemplate;
84 class MathInset : public InsetBase {
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...
103 virtual MathInset * clone() const = 0;
104 /// substitutes macro arguments if necessary
105 virtual void substitute(MathMacro const & macro);
106 /// compute the size of the object, sets ascend_, descend_ and width_
107 // updates the (xo,yo)-caches of all contained cells
108 virtual void metrics(MetricsInfo & mi) const;
110 virtual void draw(PainterInfo & pi, int x, int y) const;
111 /// draw selection between two positions
112 virtual void drawSelection(PainterInfo & pi,
113 idx_type idx1, pos_type pos1, idx_type idx2, pos_type pos2) const;
114 /// the ascent of the inset above the baseline
115 /// compute the size of the object for text based drawing
116 virtual void metricsT(TextMetricsInfo const & st) const;
117 /// draw the object as text
118 virtual void drawT(TextPainter &, int x, int y) const;
119 /// the ascent of the inset above the baseline
120 virtual int ascent() const { return 1; }
121 /// the descent of the inset below the baseline
122 virtual int descent() const { return 1; }
124 virtual int width() const { return 2; }
126 virtual Dimension dimensions() const;
127 /// total height (== ascent + descent)
128 virtual int height() const;
130 /// Where should we go when we press the up or down cursor key?
131 virtual bool idxUpDown(idx_type & idx, pos_type & pos, bool up,
133 /// Where should we go when we press the up or down cursor key?
134 virtual bool idxUpDown2(idx_type & idx, pos_type & pos, bool up,
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 bool idxBetween(idx_type idx, 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;
172 /// the number of columns of this inset if it is grid-like
173 virtual col_type ncols() const { return 1; }
174 /// the number of rows of this inset if it is grid-like
175 virtual row_type nrows() const { return 1; }
176 /// to which column belongs a cell with a given index?
177 virtual col_type col(idx_type) const { return 0; }
178 /// to which row belongs a cell with a given index?
179 virtual row_type row(idx_type) const { return 0; }
180 /// cell idex corresponding to row and column;
181 virtual idx_type index(row_type row, col_type col) const;
182 /// any additional x-offset when drawing a cell?
183 virtual int cellXOffset(idx_type) const { return 0; }
184 /// any additional y-offset when drawing a cell?
185 virtual int cellYOffset(idx_type) const { return 0; }
186 /// can we enter this cell?
187 virtual bool validCell(idx_type) const { return true; }
189 virtual void getPos(idx_type idx, pos_type pos, int & x, int & y) const;
191 /// identifies certain types of insets
192 virtual MathAMSArrayInset * asAMSArrayInset() { return 0; }
193 virtual MathAMSArrayInset const * asAMSArrayInset() const { return 0; }
194 virtual MathArrayInset * asArrayInset() { return 0; }
195 virtual MathArrayInset const * asArrayInset() const { 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 MathFracInset const * asFracInset() const { return 0; }
201 virtual MathFontInset * asFontInset() { return 0; }
202 virtual MathFontInset const * asFontInset() const { return 0; }
203 virtual MathGridInset * asGridInset() { return 0; }
204 virtual MathGridInset const * asGridInset() const { return 0; }
205 virtual MathHullInset * asHullInset() { return 0; }
206 virtual MathHullInset const * asHullInset() const { return 0; }
207 virtual MathMacroTemplate * asMacroTemplate() { return 0; }
208 virtual MathMacroTemplate const * asMacroTemplate() const { return 0; }
209 virtual MathMatrixInset const * asMatrixInset() const { return 0; }
210 virtual MathNestInset * asNestInset() { return 0; }
211 virtual MathNestInset const * asNestInset() const { return 0; }
212 virtual MathParboxInset * asParboxInset() { return 0; }
213 virtual MathScriptInset * asScriptInset() { return 0; }
214 virtual MathScriptInset const * asScriptInset() const { return 0; }
215 virtual MathSpaceInset * asSpaceInset() { return 0; }
216 virtual MathSpaceInset const * asSpaceInset() const { return 0; }
217 virtual MathStringInset * asStringInset() { return 0; }
218 virtual MathStringInset const * asStringInset() const { return 0; }
219 virtual MathSymbolInset const * asSymbolInset() const { return 0; }
220 virtual MathUnknownInset * asUnknownInset() { return 0; }
221 virtual MathUnknownInset const * asUnknownInset() const { return 0; }
222 virtual RefInset * asRefInset() { return 0; }
224 /// identifies things that can get scripts
225 virtual bool isScriptable() const { return false; }
226 /// thing that can be moved into
227 virtual bool isActive() const { return nargs() > 0; }
228 /// is the a relational operator (used for splitting equations)
229 virtual bool isRelOp() const { return false; }
230 /// -1: text mode, 1: math mode, 0 undecided
231 enum mode_type {UNDECIDED_MODE, TEXT_MODE, MATH_MODE};
233 virtual mode_type currentMode() const { return UNDECIDED_MODE; }
234 /// will this get written as a single block in {..}
235 virtual bool extraBraces() const { return false; }
237 /// return the content as char if the inset is able to do so
238 virtual char getChar() const { return 0; }
239 /// identifies things that can get \limits or \nolimits
240 virtual bool takesLimits() const { return false; }
242 /// request "external features"
243 virtual void validate(LaTeXFeatures &) const {}
244 /// char char code if possible
245 virtual void handleFont(string const &) {}
246 /// is this inset equal to a given other inset?
247 virtual bool match(MathAtom const &) const { return false; }
248 /// replace things by other things
249 virtual void replace(ReplaceData &) {}
250 /// do we contain a given subsequence?
251 virtual bool contains(MathArray const &) const { return false; }
252 /// access to the lock (only nest array have one)
253 virtual bool lock() const { return false; }
254 /// access to the lock (only nest array have one)
255 virtual void lock(bool) {}
256 /// get notification when the cursor leaves this inset
257 virtual void notifyCursorLeaves(idx_type) {}
259 /// write LaTeX and Lyx code
260 virtual void write(WriteStream & os) const;
261 /// write normalized content
262 virtual void normalize(NormalStream &) const;
263 /// write content as something readable by Maple
264 virtual void maple(MapleStream &) const;
265 /// write content as something readable by Maxima
266 virtual void maxima(MaximaStream &) const;
267 /// write content as something readable by Mathematica
268 virtual void mathematica(MathematicaStream &) const;
269 /// write content as something resembling MathML
270 virtual void mathmlize(MathMLStream &) const;
271 /// write content as something readable by Octave
272 virtual void octave(OctaveStream &) const;
273 /// describe content if cursor inside
274 virtual void infoize(std::ostream &) const {}
275 /// describe content if cursor behind
276 virtual void infoize2(std::ostream &) const {}
277 /// plain ascii output
278 virtual int ascii(std::ostream & os, int) const;
280 virtual int linuxdoc(std::ostream & os) const;
282 virtual int docbook(std::ostream & os, bool) const;
284 /// dump content to stderr for debugging
285 virtual void dump() const;
288 /// write labels into a list
289 virtual void getLabelList(std::vector<string> &) const {}
291 virtual bool numberedType() const { return false; }
293 virtual string const & getType() const;
295 virtual void mutate(string const &) {}
296 /// how is the inset called in the .lyx file?
297 virtual string fileInsetLabel() const;
298 /// usually the latex name
299 virtual string name() const;
303 BufferView * view() const;
306 std::ostream & operator<<(std::ostream &, MathAtom const &);
308 // converts single cell to string
309 string asString(MathArray const & ar);
310 // converts string to single cell
311 MathArray asArray(string const & str);