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