* Licence details can be found in the file COPYING.
*
* \author Alejandro Aguilar Sierra
- * \author André Pönitz
+ * \author André Pönitz
*
* Full author contact details are available in file CREDITS.
*/
#include "MathData.h"
-#include "insets/insetbase.h"
+#include "insets/Inset.h"
-#include <string>
+
+namespace lyx {
enum HullType {
hullNone,
hullXXAlignAt,
hullFlAlign,
hullMultline,
- hullGather
+ hullGather,
+ hullRegexp
};
-HullType hullType(std::string const & name);
-std::string hullName(HullType type);
+HullType hullType(docstring const & name);
+docstring hullName(HullType type);
/**
the math objects.
Math insets do not know there parents, a cursor position or things
-like that. The are dumb object that are contained in other math insets
+like that. They are dumb objects that are contained in other math insets
(InsetMathNests, in fact) thus forming a tree. The root of this tree is
always a InsetMathHull, which provides an interface to the Outer World by
inclusion in the "real LyX insets" FormulaInset and FormulaMacroInset.
class InsetMathHull;
class InsetMathMatrix;
class InsetMathNest;
-class InsetMathParbox;
class InsetMathScript;
class InsetMathString;
class InsetMathSpace;
+class InsetMathSpecialChar;
class InsetMathSymbol;
class InsetMathUnknown;
-class RefInset;
+class InsetMathRef;
+class HtmlStream;
class NormalStream;
class OctaveStream;
class MapleStream;
class MaximaStream;
class MathematicaStream;
-class MathMLStream;
+class MathStream;
class WriteStream;
class InfoStream;
class MathMacroTemplate;
class MathMacro;
class MathPosFinder;
-class Dimension;
-class LCursor;
+class Cursor;
class TextPainter;
class TextMetricsInfo;
class ReplaceData;
-class InsetMath : public InsetBase {
+class InsetMath : public Inset {
public:
+ ///
+ InsetMath(Buffer * buf = 0) : Inset(buf) {}
/// identification as math inset
InsetMath * asInsetMath() { return this; }
+ /// identification as math inset
+ InsetMath const * asInsetMath() const { return this; }
/// this is overridden in math text insets (i.e. mbox)
bool inMathed() const { return true; }
+ ///
+ virtual docstring name() const;
+
+ /// this is overridden by specific insets
+ virtual mode_type currentMode() const { return MATH_MODE; }
/// the ascent of the inset above the baseline
/// compute the size of the object for text based drawing
virtual void drawT(TextPainter &, int x, int y) const;
/// return cell given its number
- virtual MathArray & cell(idx_type);
+ virtual MathData & cell(idx_type);
/// return cell given its number
- virtual MathArray const & cell(idx_type) const;
+ virtual MathData const & cell(idx_type) const;
/// identifies certain types of insets
virtual InsetMathAMSArray * asAMSArrayInset() { return 0; }
virtual InsetMathAMSArray const * asAMSArrayInset() const { return 0; }
virtual InsetMathArray * asArrayInset() { return 0; }
virtual InsetMathArray const * asArrayInset() const { return 0; }
+ virtual InsetMathBrace * asBraceInset() { return 0; }
virtual InsetMathBrace const * asBraceInset() const { return 0; }
virtual InsetMathChar const * asCharInset() const { return 0; }
virtual InsetMathDelim * asDelimInset() { return 0; }
virtual InsetMathMatrix const * asMatrixInset() const { return 0; }
virtual InsetMathNest * asNestInset() { return 0; }
virtual InsetMathNest const * asNestInset() const { return 0; }
- virtual InsetMathParbox * asParboxInset() { return 0; }
virtual InsetMathScript * asScriptInset() { return 0; }
virtual InsetMathScript const * asScriptInset() const { return 0; }
virtual InsetMathSpace * asSpaceInset() { return 0; }
virtual InsetMathSymbol const * asSymbolInset() const { return 0; }
virtual InsetMathUnknown * asUnknownInset() { return 0; }
virtual InsetMathUnknown const * asUnknownInset() const { return 0; }
- virtual RefInset * asRefInset() { return 0; }
+ virtual InsetMathRef * asRefInset() { return 0; }
+ virtual InsetMathSpecialChar const * asSpecialCharInset() const { return 0; }
/// identifies things that can get scripts
virtual bool isScriptable() const { return false; }
virtual bool extraBraces() const { return false; }
/// return the content as char if the inset is able to do so
- virtual char getChar() const { return 0; }
+ virtual char_type getChar() const { return 0; }
/// identifies things that can get \limits or \nolimits
virtual bool takesLimits() const { return false; }
- /// char char code if possible
- virtual void handleFont(std::string const &) {}
/// replace things by other things
virtual void replace(ReplaceData &) {}
/// do we contain a given subsequence?
- virtual bool contains(MathArray const &) const { return false; }
+ virtual bool contains(MathData const &) const { return false; }
/// access to the lock (only nest array have one)
virtual bool lock() const { return false; }
/// access to the lock (only nest array have one)
virtual void lock(bool) {}
- /// write LaTeX and Lyx code
+ // Indicate that we do not want to hide the normal version of
+ // write(). This is to shut off a clang warning.
+ using Inset::write;
+ /// write LaTeX and LyX code
virtual void write(WriteStream & os) const;
/// write normalized content
virtual void normalize(NormalStream &) const;
virtual void maxima(MaximaStream &) const;
/// write content as something readable by Mathematica
virtual void mathematica(MathematicaStream &) const;
- /// write content as something resembling MathML
- virtual void mathmlize(MathMLStream &) const;
+ /// write content as MathML
+ virtual void mathmlize(MathStream &) const;
+ /// write content as HTML, best we can.
+ /// the idea for this, and some of the details, come from
+ /// eLyXer, written by Alex Fernandez. no code is borrowed. rather,
+ /// we try to mimic how eLyXer outputs some math.
+ virtual void htmlize(HtmlStream &) const;
/// write content as something readable by Octave
virtual void octave(OctaveStream &) const;
+ /// plain text output in ucs4 encoding
+ int plaintext(odocstringstream &, OutputParams const &, size_t) const;
+
/// dump content to stderr for debugging
virtual void dump() const;
virtual HullType getType() const;
/// change type
virtual void mutate(HullType /*newtype*/) {}
- /// usually the latex name
- virtual std::string name() const;
/// math stuff usually isn't allowed in text mode
virtual bool allowedIn(mode_type mode) const { return mode == MATH_MODE; }
+
+ /// superscript kerning
+ virtual int kerning(BufferView const *) const { return 0; }
+ ///
+ bool isInToc() const { return true; }
+ ///
+ InsetCode lyxCode() const { return MATH_CODE; }
};
+///
std::ostream & operator<<(std::ostream &, MathAtom const &);
+///
+odocstream & operator<<(odocstream &, MathAtom const &);
// initialize math
void initMath();
+
+} // namespace lyx
+
#endif