]> git.lyx.org Git - lyx.git/blobdiff - src/mathed/InsetMath.h
Please Coverity (code should be equivalent)
[lyx.git] / src / mathed / InsetMath.h
index aae7d7474e4eba0e6dc89e766a068954e5a341cb..088fce6c2be97a281bf32112be25ebf8fbf1cffb 100644 (file)
@@ -5,7 +5,7 @@
  * 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.
  */
@@ -17,6 +17,8 @@
 
 #include "insets/Inset.h"
 
+#include "TexRow.h"
+
 
 namespace lyx {
 
@@ -31,7 +33,9 @@ enum HullType {
        hullXXAlignAt,
        hullFlAlign,
        hullMultline,
-       hullGather
+       hullGather,
+       hullRegexp,
+       hullUnknown
 };
 
 HullType hullType(docstring const & name);
@@ -43,8 +47,8 @@ Abstract base class for all math objects.  A math insets is for use of the
 math editor only, it isn't a general LyX inset. It's used to represent all
 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
+Math insets do not know their parents, a cursor position or things
+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.
@@ -57,6 +61,7 @@ class InsetMathAMSArray;
 class InsetMathBrace;
 class InsetMathChar;
 class InsetMathDelim;
+class InsetMathFracBase;
 class InsetMathFrac;
 class InsetMathFont;
 class InsetMathGrid;
@@ -66,11 +71,13 @@ class InsetMathNest;
 class InsetMathScript;
 class InsetMathString;
 class InsetMathSpace;
+class InsetMathSpecialChar;
 class InsetMathSymbol;
 class InsetMathUnknown;
 
 class InsetMathRef;
 
+class HtmlStream;
 class NormalStream;
 class OctaveStream;
 class MapleStream;
@@ -78,11 +85,9 @@ class MaximaStream;
 class MathematicaStream;
 class MathStream;
 class WriteStream;
-class InfoStream;
 
 class MathMacroTemplate;
 class MathMacro;
-class MathPosFinder;
 class Cursor;
 class TextPainter;
 class TextMetricsInfo;
@@ -91,10 +96,19 @@ class ReplaceData;
 
 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
@@ -117,6 +131,8 @@ public:
        virtual InsetMathChar const     * asCharInset() const     { return 0; }
        virtual InsetMathDelim          * asDelimInset()          { return 0; }
        virtual InsetMathDelim const    * asDelimInset() const    { return 0; }
+       virtual InsetMathFracBase       * asFracBaseInset()       { return 0; }
+       virtual InsetMathFracBase const * asFracBaseInset() const { return 0; }
        virtual InsetMathFrac           * asFracInset()           { return 0; }
        virtual InsetMathFrac const     * asFracInset() const     { return 0; }
        virtual InsetMathFont           * asFontInset()           { return 0; }
@@ -142,11 +158,16 @@ public:
        virtual InsetMathUnknown        * asUnknownInset()        { return 0; }
        virtual InsetMathUnknown const  * asUnknownInset() const  { 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; }
-       /// is the a relational operator (used for splitting equations)
-       virtual bool isRelOp() const { return false; }
+       /// identifies a binary operators (used for spacing)
+       virtual bool isMathBin() const { return false; }
+       /// identifies relational operators (used for spacing and splitting equations)
+       virtual bool isMathRel() const { return false; }
+       /// identifies punctuation (used for spacing)
+       virtual bool isMathPunct() const { return false; }
        /// will this get written as a single block in {..}
        virtual bool extraBraces() const { return false; }
 
@@ -155,8 +176,6 @@ public:
        /// identifies things that can get \limits or \nolimits
        virtual bool takesLimits() const { return false; }
 
-       /// char char code if possible
-       virtual void handleFont(docstring const &) {}
        /// replace things by other things
        virtual void replace(ReplaceData &) {}
        /// do we contain a given subsequence?
@@ -166,7 +185,10 @@ public:
        /// 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;
@@ -176,16 +198,18 @@ public:
        virtual void maxima(MaximaStream &) const;
        /// write content as something readable by Mathematica
        virtual void mathematica(MathematicaStream &) const;
-       /// write content as something resembling MathML
+       /// 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;
 
-       /// ensure math mode when writing LaTeX
-       bool ensureMath(WriteStream & os, bool needs_math_mode = true) const;
-
        /// plain text output in ucs4 encoding
-       int plaintext(odocstream &, OutputParams const &) const;
+       int plaintext(odocstringstream &, OutputParams const &, size_t) const;
 
        /// dump content to stderr for debugging
        virtual void dump() const;
@@ -202,6 +226,12 @@ public:
 
        /// superscript kerning
        virtual int kerning(BufferView const *) const { return 0; }
+       ///
+       bool isInToc() const { return true; }
+       ///
+       InsetCode lyxCode() const { return MATH_CODE; }
+       ///
+       uid_type id() const { return this; }
 };
 
 ///