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 InsetMathSymbol;
72 class InsetMathUnknown;
80 class MathematicaStream;
85 class MathMacroTemplate;
90 class TextMetricsInfo;
94 class InsetMath : public Inset {
96 /// identification as math inset
97 InsetMath * asInsetMath() { return this; }
98 /// this is overridden in math text insets (i.e. mbox)
99 bool inMathed() const { return true; }
101 /// the ascent of the inset above the baseline
102 /// compute the size of the object for text based drawing
103 virtual void metricsT(TextMetricsInfo const & mi, Dimension & dim) const;
104 /// draw the object as text
105 virtual void drawT(TextPainter &, int x, int y) const;
107 /// return cell given its number
108 virtual MathData & cell(idx_type);
109 /// return cell given its number
110 virtual MathData const & cell(idx_type) const;
112 /// identifies certain types of insets
113 virtual InsetMathAMSArray * asAMSArrayInset() { return 0; }
114 virtual InsetMathAMSArray const * asAMSArrayInset() const { return 0; }
115 virtual InsetMathArray * asArrayInset() { return 0; }
116 virtual InsetMathArray const * asArrayInset() const { return 0; }
117 virtual InsetMathBrace * asBraceInset() { return 0; }
118 virtual InsetMathBrace const * asBraceInset() const { return 0; }
119 virtual InsetMathChar const * asCharInset() const { return 0; }
120 virtual InsetMathDelim * asDelimInset() { return 0; }
121 virtual InsetMathDelim const * asDelimInset() const { return 0; }
122 virtual InsetMathFrac * asFracInset() { return 0; }
123 virtual InsetMathFrac const * asFracInset() const { return 0; }
124 virtual InsetMathFont * asFontInset() { return 0; }
125 virtual InsetMathFont const * asFontInset() const { return 0; }
126 virtual InsetMathGrid * asGridInset() { return 0; }
127 virtual InsetMathGrid const * asGridInset() const { return 0; }
128 virtual InsetMathHull * asHullInset() { return 0; }
129 virtual InsetMathHull const * asHullInset() const { return 0; }
130 virtual MathMacro * asMacro() { return 0; }
131 virtual MathMacro const * asMacro() const { return 0; }
132 virtual MathMacroTemplate * asMacroTemplate() { return 0; }
133 virtual MathMacroTemplate const * asMacroTemplate() const { return 0; }
134 virtual InsetMathMatrix const * asMatrixInset() const { return 0; }
135 virtual InsetMathNest * asNestInset() { return 0; }
136 virtual InsetMathNest const * asNestInset() const { return 0; }
137 virtual InsetMathScript * asScriptInset() { return 0; }
138 virtual InsetMathScript const * asScriptInset() const { return 0; }
139 virtual InsetMathSpace * asSpaceInset() { return 0; }
140 virtual InsetMathSpace const * asSpaceInset() const { return 0; }
141 virtual InsetMathString * asStringInset() { return 0; }
142 virtual InsetMathString const * asStringInset() const { return 0; }
143 virtual InsetMathSymbol const * asSymbolInset() const { return 0; }
144 virtual InsetMathUnknown * asUnknownInset() { return 0; }
145 virtual InsetMathUnknown const * asUnknownInset() const { return 0; }
146 virtual InsetMathRef * asRefInset() { return 0; }
147 virtual InsetMathSpecialChar const * asSpecialCharInset() const { return 0; }
149 /// identifies things that can get scripts
150 virtual bool isScriptable() const { return false; }
151 /// is the a relational operator (used for splitting equations)
152 virtual bool isRelOp() const { return false; }
153 /// will this get written as a single block in {..}
154 virtual bool extraBraces() const { return false; }
156 /// return the content as char if the inset is able to do so
157 virtual char_type getChar() const { return 0; }
158 /// identifies things that can get \limits or \nolimits
159 virtual bool takesLimits() const { return false; }
161 /// char char code if possible
162 virtual void handleFont(docstring const &) {}
163 /// replace things by other things
164 virtual void replace(ReplaceData &) {}
165 /// do we contain a given subsequence?
166 virtual bool contains(MathData const &) const { return false; }
167 /// access to the lock (only nest array have one)
168 virtual bool lock() const { return false; }
169 /// access to the lock (only nest array have one)
170 virtual void lock(bool) {}
172 /// write LaTeX and Lyx code
173 virtual void write(WriteStream & os) const;
174 /// write normalized content
175 virtual void normalize(NormalStream &) const;
176 /// write content as something readable by Maple
177 virtual void maple(MapleStream &) const;
178 /// write content as something readable by Maxima
179 virtual void maxima(MaximaStream &) const;
180 /// write content as something readable by Mathematica
181 virtual void mathematica(MathematicaStream &) const;
182 /// write content as something resembling MathML
183 virtual void mathmlize(MathStream &) const;
184 /// write content as something readable by Octave
185 virtual void octave(OctaveStream &) const;
187 /// plain text output in ucs4 encoding
188 int plaintext(odocstream &, OutputParams const &) const;
190 /// dump content to stderr for debugging
191 virtual void dump() const;
194 virtual bool numberedType() const { return false; }
196 virtual HullType getType() const;
198 virtual void mutate(HullType /*newtype*/) {}
200 /// math stuff usually isn't allowed in text mode
201 virtual bool allowedIn(mode_type mode) const { return mode == MATH_MODE; }
203 /// superscript kerning
204 virtual int kerning(BufferView const *) const { return 0; }
208 std::ostream & operator<<(std::ostream &, MathAtom const &);
210 odocstream & operator<<(odocstream &, MathAtom const &);