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.
18 #include "insets/Inset.h"
38 HullType hullType(docstring const & name);
39 docstring hullName(HullType type);
43 Abstract base class for all math objects. A math insets is for use of the
44 math editor only, it isn't a general LyX inset. It's used to represent all
47 Math insets do not know there parents, a cursor position or things
48 like that. The are dumb object that are contained in other math insets
49 (InsetMathNests, in fact) thus forming a tree. The root of this tree is
50 always a InsetMathHull, which provides an interface to the Outer World by
51 inclusion in the "real LyX insets" FormulaInset and FormulaMacroInset.
57 class InsetMathAMSArray;
65 class InsetMathMatrix;
67 class InsetMathScript;
68 class InsetMathString;
70 class InsetMathSpecialChar;
71 class InsetMathSubstack;
72 class InsetMathSymbol;
73 class InsetMathTabular;
74 class InsetMathUnknown;
75 class InsetMathXYMatrix;
84 class MathematicaStream;
89 class MathMacroTemplate;
94 class TextMetricsInfo;
98 class InsetMath : public Inset {
101 InsetMath(Buffer * buf = 0) : Inset(buf) {}
102 /// identification as math inset
103 InsetMath * asInsetMath() { return this; }
104 /// identification as math inset
105 InsetMath const * asInsetMath() const { return this; }
106 /// this is overridden in math text insets (i.e. mbox)
107 bool inMathed() const { return true; }
109 /// this is overridden by specific insets
110 virtual mode_type currentMode() const { return MATH_MODE; }
112 /// the ascent of the inset above the baseline
113 /// compute the size of the object for text based drawing
114 virtual void metricsT(TextMetricsInfo const & mi, Dimension & dim) const;
115 /// draw the object as text
116 virtual void drawT(TextPainter &, int x, int y) const;
118 /// return cell given its number
119 virtual MathData & cell(idx_type);
120 /// return cell given its number
121 virtual MathData const & cell(idx_type) const;
123 /// identifies certain types of insets
124 virtual InsetMathAMSArray * asAMSArrayInset() { return 0; }
125 virtual InsetMathAMSArray const * asAMSArrayInset() const { return 0; }
126 virtual InsetMathArray * asArrayInset() { return 0; }
127 virtual InsetMathArray const * asArrayInset() const { return 0; }
128 virtual InsetMathBrace * asBraceInset() { return 0; }
129 virtual InsetMathBrace const * asBraceInset() const { return 0; }
130 virtual InsetMathChar const * asCharInset() const { return 0; }
131 virtual InsetMathDelim * asDelimInset() { return 0; }
132 virtual InsetMathDelim const * asDelimInset() const { return 0; }
133 virtual InsetMathFrac * asFracInset() { return 0; }
134 virtual InsetMathFrac const * asFracInset() const { return 0; }
135 virtual InsetMathFont * asFontInset() { return 0; }
136 virtual InsetMathFont const * asFontInset() const { return 0; }
137 virtual InsetMathGrid * asGridInset() { return 0; }
138 virtual InsetMathGrid const * asGridInset() const { return 0; }
139 virtual InsetMathHull * asHullInset() { return 0; }
140 virtual InsetMathHull const * asHullInset() const { return 0; }
141 virtual MathMacro * asMacro() { return 0; }
142 virtual MathMacro const * asMacro() const { return 0; }
143 virtual MathMacroTemplate * asMacroTemplate() { return 0; }
144 virtual MathMacroTemplate const * asMacroTemplate() const { return 0; }
145 virtual InsetMathMatrix const * asMatrixInset() const { return 0; }
146 virtual InsetMathNest * asNestInset() { return 0; }
147 virtual InsetMathNest const * asNestInset() const { return 0; }
148 virtual InsetMathScript * asScriptInset() { return 0; }
149 virtual InsetMathScript const * asScriptInset() const { return 0; }
150 virtual InsetMathSpace * asSpaceInset() { return 0; }
151 virtual InsetMathSpace const * asSpaceInset() const { return 0; }
152 virtual InsetMathString * asStringInset() { return 0; }
153 virtual InsetMathString const * asStringInset() const { return 0; }
154 virtual InsetMathSubstack * asSubstackInset() { return 0; }
155 virtual InsetMathSubstack const * asSubstackInset() const { return 0; }
156 virtual InsetMathSymbol const * asSymbolInset() const { return 0; }
157 virtual InsetMathTabular * asTabularInset() { return 0; }
158 virtual InsetMathTabular const * asTabularInset() const { return 0; }
159 virtual InsetMathUnknown * asUnknownInset() { return 0; }
160 virtual InsetMathUnknown const * asUnknownInset() const { return 0; }
161 virtual InsetMathXYMatrix * asXYMatrixInset() { return 0; }
162 virtual InsetMathXYMatrix const * asXYMatrixInset() const { return 0; }
163 virtual InsetMathRef * asRefInset() { return 0; }
164 virtual InsetMathSpecialChar const * asSpecialCharInset() const { return 0; }
166 /// identifies things that can get scripts
167 virtual bool isScriptable() const { return false; }
168 /// is the a relational operator (used for splitting equations)
169 virtual bool isRelOp() const { return false; }
170 /// will this get written as a single block in {..}
171 virtual bool extraBraces() const { return false; }
173 /// return the content as char if the inset is able to do so
174 virtual char_type getChar() const { return 0; }
175 /// identifies things that can get \limits or \nolimits
176 virtual bool takesLimits() const { return false; }
178 /// char char code if possible
179 virtual void handleFont(docstring const &) {}
180 /// replace things by other things
181 virtual void replace(ReplaceData &) {}
182 /// do we contain a given subsequence?
183 virtual bool contains(MathData const &) const { return false; }
184 /// access to the lock (only nest array have one)
185 virtual bool lock() const { return false; }
186 /// access to the lock (only nest array have one)
187 virtual void lock(bool) {}
189 /// write LaTeX and Lyx code
190 virtual void write(WriteStream & os) const;
191 /// write normalized content
192 virtual void normalize(NormalStream &) const;
193 /// write content as something readable by Maple
194 virtual void maple(MapleStream &) const;
195 /// write content as something readable by Maxima
196 virtual void maxima(MaximaStream &) const;
197 /// write content as something readable by Mathematica
198 virtual void mathematica(MathematicaStream &) const;
199 /// write content as MathML
200 virtual void mathmlize(MathStream &) const;
201 /// write content as HTML, best we can.
202 /// the idea for this, and some of the details, come from
203 /// eLyXer, written by Alex Fernandez. no code is borrowed. rather,
204 /// we try to mimic how eLyXer outputs some math.
205 virtual void htmlize(HtmlStream &) const;
206 /// write content as something readable by Octave
207 virtual void octave(OctaveStream &) const;
209 /// plain text output in ucs4 encoding
210 int plaintext(odocstream &, OutputParams const &) const;
212 /// dump content to stderr for debugging
213 virtual void dump() const;
216 virtual bool numberedType() const { return false; }
218 virtual HullType getType() const;
220 virtual void mutate(HullType /*newtype*/) {}
222 /// math stuff usually isn't allowed in text mode
223 virtual bool allowedIn(mode_type mode) const { return mode == MATH_MODE; }
225 /// superscript kerning
226 virtual int kerning(BufferView const *) const { return 0; }
228 InsetCode lyxCode() const { return MATH_CODE; }
232 std::ostream & operator<<(std::ostream &, MathAtom const &);
234 odocstream & operator<<(odocstream &, MathAtom const &);