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