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"
40 HullType hullType(docstring const & name);
41 docstring hullName(HullType type);
45 Abstract base class for all math objects. A math insets is for use of the
46 math editor only, it isn't a general LyX inset. It's used to represent all
49 Math insets do not know their parents, a cursor position or things
50 like that. They are dumb objects that are contained in other math insets
51 (InsetMathNests, in fact) thus forming a tree. The root of this tree is
52 always a InsetMathHull, which provides an interface to the Outer World by
53 inclusion in the "real LyX insets" FormulaInset and FormulaMacroInset.
59 class InsetMathAMSArray;
63 class InsetMathFracBase;
68 class InsetMathMatrix;
70 class InsetMathScript;
71 class InsetMathString;
73 class InsetMathSpecialChar;
74 class InsetMathSymbol;
75 class InsetMathUnknown;
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 virtual docstring name() const;
111 /// this is overridden by specific insets
112 virtual mode_type currentMode() const { return MATH_MODE; }
114 /// the ascent of the inset above the baseline
115 /// compute the size of the object for text based drawing
116 virtual void metricsT(TextMetricsInfo const & mi, Dimension & dim) const;
117 /// draw the object as text
118 virtual void drawT(TextPainter &, int x, int y) const;
120 /// return cell given its number
121 virtual MathData & cell(idx_type);
122 /// return cell given its number
123 virtual MathData const & cell(idx_type) const;
125 /// identifies certain types of insets
126 virtual InsetMathAMSArray * asAMSArrayInset() { return 0; }
127 virtual InsetMathAMSArray const * asAMSArrayInset() const { return 0; }
128 virtual InsetMathArray * asArrayInset() { return 0; }
129 virtual InsetMathArray const * asArrayInset() const { return 0; }
130 virtual InsetMathBrace * asBraceInset() { return 0; }
131 virtual InsetMathBrace const * asBraceInset() const { return 0; }
132 virtual InsetMathChar const * asCharInset() const { return 0; }
133 virtual InsetMathDelim * asDelimInset() { return 0; }
134 virtual InsetMathDelim const * asDelimInset() const { return 0; }
135 virtual InsetMathFracBase * asFracBaseInset() { return 0; }
136 virtual InsetMathFracBase const * asFracBaseInset() const { return 0; }
137 virtual InsetMathFrac * asFracInset() { return 0; }
138 virtual InsetMathFrac const * asFracInset() const { return 0; }
139 virtual InsetMathFont * asFontInset() { return 0; }
140 virtual InsetMathFont const * asFontInset() const { return 0; }
141 virtual InsetMathGrid * asGridInset() { return 0; }
142 virtual InsetMathGrid const * asGridInset() const { return 0; }
143 virtual InsetMathHull * asHullInset() { return 0; }
144 virtual InsetMathHull const * asHullInset() const { return 0; }
145 virtual MathMacro * asMacro() { return 0; }
146 virtual MathMacro const * asMacro() const { return 0; }
147 virtual MathMacroTemplate * asMacroTemplate() { return 0; }
148 virtual MathMacroTemplate const * asMacroTemplate() const { return 0; }
149 virtual InsetMathMatrix const * asMatrixInset() const { return 0; }
150 virtual InsetMathNest * asNestInset() { return 0; }
151 virtual InsetMathNest const * asNestInset() const { return 0; }
152 virtual InsetMathScript * asScriptInset() { return 0; }
153 virtual InsetMathScript const * asScriptInset() const { return 0; }
154 virtual InsetMathSpace * asSpaceInset() { return 0; }
155 virtual InsetMathSpace const * asSpaceInset() const { return 0; }
156 virtual InsetMathString * asStringInset() { return 0; }
157 virtual InsetMathString const * asStringInset() const { return 0; }
158 virtual InsetMathSymbol const * asSymbolInset() const { return 0; }
159 virtual InsetMathUnknown * asUnknownInset() { return 0; }
160 virtual InsetMathUnknown const * asUnknownInset() const { return 0; }
161 virtual InsetMathRef * asRefInset() { return 0; }
162 virtual InsetMathSpecialChar const * asSpecialCharInset() const { return 0; }
164 /// identifies things that can get scripts
165 virtual bool isScriptable() const { return false; }
166 /// is the a relational operator (used for splitting equations)
167 virtual bool isRelOp() const { return false; }
168 /// will this get written as a single block in {..}
169 virtual bool extraBraces() const { return false; }
171 /// return the content as char if the inset is able to do so
172 virtual char_type getChar() const { return 0; }
173 /// identifies things that can get \limits or \nolimits
174 virtual bool takesLimits() const { return false; }
176 /// replace things by other things
177 virtual void replace(ReplaceData &) {}
178 /// do we contain a given subsequence?
179 virtual bool contains(MathData const &) const { return false; }
180 /// access to the lock (only nest array have one)
181 virtual bool lock() const { return false; }
182 /// access to the lock (only nest array have one)
183 virtual void lock(bool) {}
185 // Indicate that we do not want to hide the normal version of
186 // write(). This is to shut off a clang warning.
188 /// write LaTeX and LyX code
189 virtual void write(WriteStream & os) const;
190 /// write normalized content
191 virtual void normalize(NormalStream &) const;
192 /// write content as something readable by Maple
193 virtual void maple(MapleStream &) const;
194 /// write content as something readable by Maxima
195 virtual void maxima(MaximaStream &) const;
196 /// write content as something readable by Mathematica
197 virtual void mathematica(MathematicaStream &) const;
198 /// write content as MathML
199 virtual void mathmlize(MathStream &) const;
200 /// write content as HTML, best we can.
201 /// the idea for this, and some of the details, come from
202 /// eLyXer, written by Alex Fernandez. no code is borrowed. rather,
203 /// we try to mimic how eLyXer outputs some math.
204 virtual void htmlize(HtmlStream &) const;
205 /// write content as something readable by Octave
206 virtual void octave(OctaveStream &) const;
208 /// plain text output in ucs4 encoding
209 int plaintext(odocstringstream &, OutputParams const &, size_t) const;
211 /// dump content to stderr for debugging
212 virtual void dump() const;
215 virtual bool numberedType() const { return false; }
217 virtual HullType getType() const;
219 virtual void mutate(HullType /*newtype*/) {}
221 /// math stuff usually isn't allowed in text mode
222 virtual bool allowedIn(mode_type mode) const { return mode == MATH_MODE; }
224 /// superscript kerning
225 virtual int kerning(BufferView const *) const { return 0; }
227 bool isInToc() const { return true; }
229 InsetCode lyxCode() const { return MATH_CODE; }
231 uid_type id() const { return this; }
235 std::ostream & operator<<(std::ostream &, MathAtom const &);
237 odocstream & operator<<(odocstream &, MathAtom const &);