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
31 #include "math_xdata.h"
32 #include "math_defs.h"
34 /** Abstract base class for all math objects.
35 A math insets is for use of the math editor only, it isn't a
36 general LyX inset. It's used to represent all the math objects.
37 The formulaInset (a LyX inset) encapsulates a math inset.
49 class MathMatrixInset;
51 class MathScriptInset;
52 class MathStringInset;
54 class MathSymbolInset;
66 class MathMacroTemplate;
71 /// short of anything else reasonable
72 typedef MathArray::size_type size_type;
73 /// type for cursor positions within a cell
74 typedef MathArray::size_type pos_type;
75 /// type for cell indices
76 typedef size_type idx_type;
77 /// type for row numbers
78 typedef size_type row_type;
79 /// type for column numbers
80 typedef size_type col_type;
84 /// the virtual base destructor
88 virtual void draw(Painter &, int x, int y) const;
89 /// write LaTeX and Lyx code
90 virtual void write(WriteStream & os) const;
92 virtual MathInset * clone() const = 0;
93 ///substitutes macro arguments if necessary
94 virtual void substitute(MathMacro const & macro);
95 /// compute the size of the object, sets ascend_, descend_ and width_
96 virtual void metrics(MathMetricsInfo const & st) const;
98 virtual int ascent() const { return 1; }
100 virtual int descent() const { return 1; }
102 virtual int width() const { return 2; }
104 virtual int height() const;
106 /// Where should we go when we press the up cursor key?
107 virtual bool idxUp(idx_type & idx, pos_type & pos) const;
109 virtual bool idxDown(idx_type & idx, pos_type & pos) const;
111 virtual bool idxLeft(idx_type & idx, pos_type & pos) const;
113 virtual bool idxRight(idx_type & idx, pos_type & pos) const;
115 /// Move one physical cell up
116 virtual bool idxNext(idx_type & idx, pos_type & pos) const;
117 /// Move one physical cell down
118 virtual bool idxPrev(idx_type & idx, pos_type & pos) const;
120 /// Target pos when we enter the inset from the left by pressing "Right"
121 virtual bool idxFirst(idx_type & idx, pos_type & pos) const;
122 /// Target pos when we enter the inset from the left by pressing "Up"
123 virtual bool idxFirstUp(idx_type & idx, pos_type & pos) const;
124 /// Target pos when we enter the inset from the left by pressing "Down"
125 virtual bool idxFirstDown(idx_type & idx, pos_type & pos) const;
126 /// Target pos when we enter the inset from the right by pressing "Left"
127 virtual bool idxLast(idx_type & idx, pos_type & pos) const;
128 /// Target pos when we enter the inset from the right by pressing "Up"
129 virtual bool idxLastUp(idx_type & idx, pos_type & pos) const;
130 /// Target pos when we enter the inset from the right by pressing "Down"
131 virtual bool idxLastDown(idx_type & idx, pos_type & pos) const;
133 /// Where should we go if we press home?
134 virtual bool idxHome(idx_type & idx, pos_type & pos) const;
135 /// Where should we go if we press end?
136 virtual bool idxEnd(idx_type & idx, pos_type & pos) const;
138 /// Delete a cell and move cursor
139 // the return value indicates whether the cursor should leave the inset
140 // and/or the whole inset should be deleted
141 virtual void idxDelete(idx_type & idx, bool & popit, bool & deleteit);
142 // deletes a cell range and moves the cursor
143 virtual void idxDeleteRange(idx_type from, idx_type to);
144 // returns list of cell indices that are "between" from and to for
145 // selection purposes
146 virtual std::vector<idx_type> idxBetween(idx_type from, idx_type to) const;
149 virtual idx_type nargs() const;
152 virtual MathArray & cell(idx_type);
154 virtual MathArray const & cell(idx_type) const;
156 virtual MathXArray & xcell(idx_type);
158 virtual MathXArray const & xcell(idx_type) const;
161 virtual col_type ncols() const { return 1; }
163 virtual row_type nrows() const { return 1; }
165 virtual col_type col(row_type) const { return 0; }
167 virtual row_type row(row_type) const { return 0; }
169 virtual int cellXOffset(row_type) const { return 0; }
171 virtual int cellYOffset(row_type) const { return 0; }
173 virtual void addRow(row_type) {}
175 virtual void delRow(row_type) {}
177 virtual void addCol(col_type) {}
179 virtual void delCol(col_type) {}
182 virtual bool covers(int x, int y) const;
184 /// identifies certain types of insets
185 virtual MathArrayInset * asArrayInset() { return 0; }
186 virtual MathBoxInset * asBoxInset() { return 0; }
187 virtual MathCharInset const * asCharInset() const { return 0; }
188 virtual MathDelimInset * asDelimInset() { return 0; }
189 virtual MathDelimInset const * asDelimInset() const { return 0; }
190 virtual MathFuncInset * asFuncInset() { return 0; }
191 virtual MathFracInset * asFracInset() { return 0; }
192 virtual MathGridInset * asGridInset() { return 0; }
193 virtual MathHullInset * asHullInset() { return 0; }
194 virtual MathHullInset const * asHullInset() const { return 0; }
195 virtual MathMacroTemplate * asMacroTemplate() { return 0; }
196 virtual MathMatrixInset const * asMatrixInset() const { return 0; }
197 virtual MathNestInset * asNestInset() { return 0; }
198 virtual MathScriptInset * asScriptInset() { return 0; }
199 virtual MathScriptInset const * asScriptInset() const { return 0; }
200 virtual MathSpaceInset * asSpaceInset() { return 0; }
201 virtual MathStringInset * asStringInset() { return 0; }
202 virtual MathSymbolInset * asSymbolInset() { return 0; }
203 virtual UpdatableInset * asHyperActiveInset() const { return 0; }
205 /// identifies things that can get scripts
206 virtual bool isScriptable() const { return false; }
207 /// thing that can be moved into
208 virtual bool isActive() const { return nargs() > 0; }
209 /// identifies insets from the outer world
210 virtual bool isHyperActive() const { return 0; }
212 virtual bool isRelOp() const { return false; }
214 virtual bool isMacro() const { return false; }
217 virtual char getChar() const { return 0; }
219 virtual MathTextCodes code() const { return LM_TC_MIN; }
220 /// identifies things that can get \limits or \nolimits
221 virtual bool takesLimits() const { return false; }
224 virtual void dump() const;
226 virtual void edit(BufferView *, int, int, unsigned int) {}
229 virtual void validate(LaTeXFeatures & features) const;
231 virtual void handleFont(MathTextCodes) {}
233 /// write normalized content
234 virtual void normalize(NormalStream &) const;
236 virtual void maplize(MapleStream &) const;
238 virtual void mathmlize(MathMLStream &) const;
240 virtual void octavize(OctaveStream &) const;
243 std::ostream & operator<<(std::ostream &, MathInset const &);