4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Alejandro Aguilar Sierra
10 * Full author contact details are available in file CREDITS.
19 #include "insets/insetbase.h"
23 Abstract base class for all math objects. A math insets is for use of the
24 math editor only, it isn't a general LyX inset. It's used to represent all
27 Math insets do not know there parents, a cursor position or things
28 like that. The are dumb object that are contained in other math insets
29 (MathNestInsets, in fact) thus forming a tree. The root of this tree is
30 always a MathHullInset, which provides an interface to the Outer World by
31 inclusion in the "real LyX insets" FormulaInset and FormulaMacroInset.
37 class MathAMSArrayInset;
44 class MathMatrixInset;
46 class MathParboxInset;
47 class MathScriptInset;
48 class MathStringInset;
50 class MathSymbolInset;
51 class MathUnknownInset;
62 class MathematicaStream;
69 class MathMacroTemplate;
75 class TextMetricsInfo;
79 class MathInset : public InsetBase {
81 /// our members behave nicely...
84 /// substitutes macro arguments if necessary
85 virtual void substitute(MathMacro const & macro);
86 /// draw selection between two positions
87 virtual void drawSelection(PainterInfo & pi,
88 idx_type idx1, pos_type pos1, idx_type idx2, pos_type pos2) const;
89 /// the ascent of the inset above the baseline
90 /// compute the size of the object for text based drawing
91 virtual void metricsT(TextMetricsInfo const & mi, Dimension & dim) const;
92 /// draw the object as text
93 virtual void drawT(TextPainter &, int x, int y) const;
95 /// Where should we go when we press the up or down cursor key?
96 virtual bool idxUpDown(idx_type & idx, pos_type & pos, bool up,
98 /// Where should we go when we press the up or down cursor key?
99 virtual bool idxUpDown2(idx_type & idx, pos_type & pos, bool up,
102 virtual bool idxLeft(idx_type & idx, pos_type & pos) const;
104 virtual bool idxRight(idx_type & idx, pos_type & pos) const;
106 /// Move one physical cell up
107 virtual bool idxNext(idx_type & idx, pos_type & pos) const;
108 /// Move one physical cell down
109 virtual bool idxPrev(idx_type & idx, pos_type & pos) const;
111 /// Target pos when we enter the inset from the left by pressing "Right"
112 virtual bool idxFirst(idx_type & idx, pos_type & pos) const;
113 /// Target pos when we enter the inset from the right by pressing "Left"
114 virtual bool idxLast(idx_type & idx, pos_type & pos) const;
116 /// Where should we go if we press home?
117 virtual bool idxHome(idx_type & idx, pos_type & pos) const;
118 /// Where should we go if we press end?
119 virtual bool idxEnd(idx_type & idx, pos_type & pos) const;
121 /// Delete a cell and move cursor
122 virtual bool idxDelete(idx_type &) { return false; }
123 /// pulls cell after pressing erase
124 virtual void idxGlue(idx_type) {}
125 // returns list of cell indices that are "between" from and to for
126 // selection purposes
127 virtual bool idxBetween(idx_type idx, idx_type from, idx_type to) const;
129 /// the number of nested cells this inset owns
130 virtual idx_type nargs() const;
132 /// return cell given its number
133 virtual MathArray & cell(idx_type);
134 /// return cell given its number
135 virtual MathArray const & cell(idx_type) const;
137 /// the number of columns of this inset if it is grid-like
138 virtual col_type ncols() const { return 1; }
139 /// the number of rows of this inset if it is grid-like
140 virtual row_type nrows() const { return 1; }
141 /// to which column belongs a cell with a given index?
142 virtual col_type col(idx_type) const { return 0; }
143 /// to which row belongs a cell with a given index?
144 virtual row_type row(idx_type) const { return 0; }
145 /// cell idex corresponding to row and column;
146 virtual idx_type index(row_type row, col_type col) const;
147 /// any additional x-offset when drawing a cell?
148 virtual int cellXOffset(idx_type) const { return 0; }
149 /// any additional y-offset when drawing a cell?
150 virtual int cellYOffset(idx_type) const { return 0; }
151 /// can we enter this cell?
152 virtual bool validCell(idx_type) const { return true; }
154 virtual void getPos(idx_type idx, pos_type pos, int & x, int & y) const;
156 /// identifies certain types of insets
157 virtual MathAMSArrayInset * asAMSArrayInset() { return 0; }
158 virtual MathAMSArrayInset const * asAMSArrayInset() const { return 0; }
159 virtual MathArrayInset * asArrayInset() { return 0; }
160 virtual MathArrayInset const * asArrayInset() const { return 0; }
161 virtual MathCharInset const * asCharInset() const { return 0; }
162 virtual MathDelimInset * asDelimInset() { return 0; }
163 virtual MathDelimInset const * asDelimInset() const { return 0; }
164 virtual MathFracInset * asFracInset() { return 0; }
165 virtual MathFracInset const * asFracInset() const { return 0; }
166 virtual MathFontInset * asFontInset() { return 0; }
167 virtual MathFontInset const * asFontInset() const { return 0; }
168 virtual MathGridInset * asGridInset() { return 0; }
169 virtual MathGridInset const * asGridInset() const { return 0; }
170 virtual MathHullInset * asHullInset() { return 0; }
171 virtual MathHullInset const * asHullInset() const { return 0; }
172 virtual MathMacroTemplate * asMacroTemplate() { return 0; }
173 virtual MathMacroTemplate const * asMacroTemplate() const { return 0; }
174 virtual MathMatrixInset const * asMatrixInset() const { return 0; }
175 virtual MathNestInset * asNestInset() { return 0; }
176 virtual MathNestInset const * asNestInset() const { return 0; }
177 virtual MathParboxInset * asParboxInset() { return 0; }
178 virtual MathScriptInset * asScriptInset() { return 0; }
179 virtual MathScriptInset const * asScriptInset() const { return 0; }
180 virtual MathSpaceInset * asSpaceInset() { return 0; }
181 virtual MathSpaceInset const * asSpaceInset() const { return 0; }
182 virtual MathStringInset * asStringInset() { return 0; }
183 virtual MathStringInset const * asStringInset() const { return 0; }
184 virtual MathSymbolInset const * asSymbolInset() const { return 0; }
185 virtual MathUnknownInset * asUnknownInset() { return 0; }
186 virtual MathUnknownInset const * asUnknownInset() const { return 0; }
187 virtual RefInset * asRefInset() { return 0; }
189 /// identifies things that can get scripts
190 virtual bool isScriptable() const { return false; }
191 /// thing that can be moved into
192 virtual bool isActive() const { return nargs() > 0; }
193 /// is the a relational operator (used for splitting equations)
194 virtual bool isRelOp() const { return false; }
195 /// -1: text mode, 1: math mode, 0 undecided
196 enum mode_type {UNDECIDED_MODE, TEXT_MODE, MATH_MODE};
198 virtual mode_type currentMode() const { return UNDECIDED_MODE; }
199 /// will this get written as a single block in {..}
200 virtual bool extraBraces() const { return false; }
202 /// return the content as char if the inset is able to do so
203 virtual char getChar() const { return 0; }
204 /// identifies things that can get \limits or \nolimits
205 virtual bool takesLimits() const { return false; }
207 /// char char code if possible
208 virtual void handleFont(string const &) {}
209 /// is this inset equal to a given other inset?
210 virtual bool match(MathAtom const &) const { return false; }
211 /// replace things by other things
212 virtual void replace(ReplaceData &) {}
213 /// do we contain a given subsequence?
214 virtual bool contains(MathArray const &) const { return false; }
215 /// access to the lock (only nest array have one)
216 virtual bool lock() const { return false; }
217 /// access to the lock (only nest array have one)
218 virtual void lock(bool) {}
219 /// get notification when the cursor leaves this inset
220 virtual void notifyCursorLeaves(idx_type) {}
222 /// write LaTeX and Lyx code
223 virtual void write(WriteStream & os) const;
224 /// write normalized content
225 virtual void normalize(NormalStream &) const;
226 /// write content as something readable by Maple
227 virtual void maple(MapleStream &) const;
228 /// write content as something readable by Maxima
229 virtual void maxima(MaximaStream &) const;
230 /// write content as something readable by Mathematica
231 virtual void mathematica(MathematicaStream &) const;
232 /// write content as something resembling MathML
233 virtual void mathmlize(MathMLStream &) const;
234 /// write content as something readable by Octave
235 virtual void octave(OctaveStream &) const;
236 /// describe content if cursor inside
237 virtual void infoize(std::ostream &) const {}
238 /// describe content if cursor behind
239 virtual void infoize2(std::ostream &) const {}
240 /// plain ascii output
241 virtual int ascii(std::ostream & os, int) const;
243 virtual int linuxdoc(std::ostream & os) const;
245 virtual int docbook(std::ostream & os, bool) const;
247 /// dump content to stderr for debugging
248 virtual void dump() const;
251 virtual bool numberedType() const { return false; }
253 virtual string const & getType() const;
255 virtual void mutate(string const &) {}
256 /// how is the inset called in the .lyx file?
257 virtual string fileInsetLabel() const;
258 /// usually the latex name
259 virtual string name() const;
263 BufferView * view() const;
266 std::ostream & operator<<(std::ostream &, MathAtom const &);