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 "MathClass.h"
18 #include "insets/Inset.h"
39 HullType hullType(docstring const & name);
40 docstring hullName(HullType type);
44 // what is obtained with \c \\nolimits
48 // what is obtained with \c \\limits
55 Abstract base class for all math objects. A math insets is for use of the
56 math editor only, it isn't a general LyX inset. It's used to represent all
59 Math insets do not know their parents, a cursor position or things
60 like that. They are dumb objects that are contained in other math insets
61 (InsetMathNests, in fact) thus forming a tree. The root of this tree is
62 always a InsetMathHull, which provides an interface to the Outer World by
63 inclusion in the "real LyX insets" FormulaInset and FormulaMacroInset.
71 class InsetMathAMSArray;
76 class InsetMathFracBase;
81 class InsetMathMatrix;
83 class InsetMathScript;
84 class InsetMathString;
86 class InsetMathSpecialChar;
87 class InsetMathSymbol;
88 class InsetMathSubstack;
89 class InsetMathUnknown;
97 class MathematicaStream;
102 class InsetMathMacroTemplate;
103 class InsetMathMacro;
106 class TextMetricsInfo;
109 /// Type of unique identifiers for math insets (used in TexRow)
110 typedef void const * uid_type;
113 class InsetMath : public Inset {
116 explicit InsetMath(Buffer * buf = 0) : Inset(buf) {}
117 /// identification as math inset
118 InsetMath * asInsetMath() override { return this; }
119 /// identification as math inset
120 InsetMath const * asInsetMath() const override { return this; }
121 /// this is overridden in math text insets (i.e. mbox)
122 bool inMathed() const override { return true; }
124 virtual docstring name() const;
126 /// this is overridden by specific insets
127 mode_type currentMode() const override { return MATH_MODE; }
129 // The possible marker types for math insets
130 enum marker_type { NO_MARKER, MARKER2, MARKER, BOX_MARKER };
131 /// this is overridden by insets with specific edit marker type
132 virtual marker_type marker(BufferView const *) const;
134 /// the ascent of the inset above the baseline
135 /// compute the size of the object for text based drawing
136 virtual void metricsT(TextMetricsInfo const & mi, Dimension & dim) const;
137 /// draw the object as text
138 virtual void drawT(TextPainter &, int x, int y) const;
140 /// return cell given its number
141 virtual MathData & cell(idx_type);
142 /// return cell given its number
143 virtual MathData const & cell(idx_type) const;
145 /// identifies certain types of insets
146 virtual InsetMathAMSArray * asAMSArrayInset() { return nullptr; }
147 virtual InsetMathAMSArray const * asAMSArrayInset() const { return nullptr; }
148 virtual InsetMathArray * asArrayInset() { return nullptr; }
149 virtual InsetMathArray const * asArrayInset() const { return nullptr; }
150 virtual InsetMathBrace * asBraceInset() { return nullptr; }
151 virtual InsetMathBrace const * asBraceInset() const { return nullptr; }
152 virtual InsetMathChar const * asCharInset() const { return nullptr; }
153 virtual InsetMathClass const * asClassInset() const { return nullptr; }
154 virtual InsetMathDelim * asDelimInset() { return nullptr; }
155 virtual InsetMathDelim const * asDelimInset() const { return nullptr; }
156 virtual InsetMathFracBase * asFracBaseInset() { return nullptr; }
157 virtual InsetMathFracBase const * asFracBaseInset() const { return nullptr; }
158 virtual InsetMathFrac * asFracInset() { return nullptr; }
159 virtual InsetMathFrac const * asFracInset() const { return nullptr; }
160 virtual InsetMathFont * asFontInset() { return nullptr; }
161 virtual InsetMathFont const * asFontInset() const { return nullptr; }
162 virtual InsetMathGrid * asGridInset() { return nullptr; }
163 virtual InsetMathGrid const * asGridInset() const { return nullptr; }
164 virtual InsetMathHull * asHullInset() { return nullptr; }
165 virtual InsetMathHull const * asHullInset() const { return nullptr; }
166 virtual InsetMathMacro * asMacro() { return nullptr; }
167 virtual InsetMathMacro const * asMacro() const { return nullptr; }
168 virtual InsetMathMacroTemplate * asMacroTemplate() { return nullptr; }
169 virtual InsetMathMacroTemplate const * asMacroTemplate() const { return nullptr; }
170 virtual InsetMathMatrix const * asMatrixInset() const { return nullptr; }
171 virtual InsetMathNest * asNestInset() { return nullptr; }
172 virtual InsetMathNest const * asNestInset() const { return nullptr; }
173 virtual InsetMathScript * asScriptInset() { return nullptr; }
174 virtual InsetMathScript const * asScriptInset() const { return nullptr; }
175 virtual InsetMathSpace * asSpaceInset() { return nullptr; }
176 virtual InsetMathSpace const * asSpaceInset() const { return nullptr; }
177 virtual InsetMathString * asStringInset() { return nullptr; }
178 virtual InsetMathString const * asStringInset() const { return nullptr; }
179 virtual InsetMathSubstack * asSubstackInset() { return nullptr; }
180 virtual InsetMathSubstack const * asSubstackInset() const { return nullptr; }
181 virtual InsetMathSymbol const * asSymbolInset() const { return nullptr; }
182 virtual InsetMathUnknown * asUnknownInset() { return nullptr; }
183 virtual InsetMathUnknown const * asUnknownInset() const { return nullptr; }
184 virtual InsetMathRef * asRefInset() { return nullptr; }
185 virtual InsetMathSpecialChar const * asSpecialCharInset() const { return nullptr; }
187 /// The class of the math object (used primarily for spacing)
188 virtual MathClass mathClass() const { return MC_ORD; }
189 /// Add this inset to a math row. Return true if contents got added
190 virtual bool addToMathRow(MathRow &, MetricsInfo & mi) const;
191 /// Hook that is run before metrics computation starts
192 virtual void beforeMetrics() const {}
193 /// Hook that is run after metrics computation
194 virtual void afterMetrics() const {}
195 /// Hook that is run before actual drawing
196 virtual void beforeDraw(PainterInfo const &) const {}
197 /// Hook that is run after drawing
198 virtual void afterDraw(PainterInfo const &) const {}
200 /// will this get written as a single block in {..}
201 virtual bool extraBraces() const { return false; }
203 /// return the content as char if the inset is able to do so
204 virtual char_type getChar() const { return 0; }
206 /// Whether the inset allows \(no)limits
207 bool allowsLimitsChange() const { return mathClass() == MC_OP; }
208 /// The default limits value
209 virtual Limits defaultLimits() const { return NO_LIMITS; }
210 /// whether the inset has limit-like sub/superscript
211 virtual Limits limits() const { return AUTO_LIMITS; }
212 /// sets types of sub/superscripts
213 virtual void limits(Limits) {}
214 /// write limits status for LaTeX and LyX code
215 void writeLimits(WriteStream & os) const;
217 /// replace things by other things
218 virtual void replace(ReplaceData &) {}
219 /// do we contain a given subsequence?
220 virtual bool contains(MathData const &) const { return false; }
221 /// access to the lock (only nest array have one)
222 virtual bool lock() const { return false; }
223 /// access to the lock (only nest array have one)
224 virtual void lock(bool) {}
226 // Indicate that we do not want to hide the normal version of
227 // write(). This is to shut off a clang warning.
229 /// write LaTeX and LyX code
230 virtual void write(WriteStream & os) const;
231 /// write normalized content
232 virtual void normalize(NormalStream &) const;
233 /// write content as something readable by Maple
234 virtual void maple(MapleStream &) const;
235 /// write content as something readable by Maxima
236 virtual void maxima(MaximaStream &) const;
237 /// write content as something readable by Mathematica
238 virtual void mathematica(MathematicaStream &) const;
239 /// write content as MathML
240 virtual void mathmlize(MathStream &) const;
241 /// write content as HTML, best we can.
242 /// the idea for this, and some of the details, come from
243 /// eLyXer, written by Alex Fernandez. no code is borrowed. rather,
244 /// we try to mimic how eLyXer outputs some math.
245 virtual void htmlize(HtmlStream &) const;
246 /// write content as something readable by Octave
247 virtual void octave(OctaveStream &) const;
249 /// plain text output in ucs4 encoding
250 int plaintext(odocstringstream &, OutputParams const &, size_t) const override;
252 /// dump content to stderr for debugging
253 void dump() const override;
256 virtual bool numberedType() const { return false; }
258 virtual HullType getType() const;
260 virtual void mutate(HullType /*newtype*/) {}
262 /// math stuff usually isn't allowed in text mode
263 bool allowedIn(mode_type mode) const override { return mode == MATH_MODE; }
265 /// Italic correction as described in InsetMathScript.h
266 virtual int kerning(BufferView const *) const { return 0; }
268 bool isInToc() const override { return true; }
270 InsetCode lyxCode() const override { return MATH_CODE; }
272 uid_type id() const { return this; }
276 std::ostream & operator<<(std::ostream &, MathAtom const &);
278 odocstream & operator<<(odocstream &, MathAtom const &);