src/mathed/InsetMath.h

   1 // -*- C++ -*-
   2 /**
   3  * \file InsetMath.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Alejandro Aguilar Sierra
   8  * \author André Pönitz
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #ifndef MATH_INSET_H
  14 #define MATH_INSET_H
  15
  16 #include "MathArray.h"
  17
  18 #include "insets/InsetBase.h"
  19
  20
  21 namespace lyx {
  22
  23 enum HullType {
  24         hullNone,
  25         hullSimple,
  26         hullEquation,
  27         hullEqnArray,
  28         hullAlign,
  29         hullAlignAt,
  30         hullXAlignAt,
  31         hullXXAlignAt,
  32         hullFlAlign,
  33         hullMultline,
  34         hullGather
  35 };
  36
  37 HullType hullType(docstring const & name);
  38 docstring hullName(HullType type);
  39
  40 /**
  41
  42 Abstract base class for all math objects.  A math insets is for use of the
  43 math editor only, it isn't a general LyX inset. It's used to represent all
  44 the math objects.
  45
  46 Math insets do not know there parents, a cursor position or things
  47 like that. The are dumb object that are contained in other math insets
  48 (InsetMathNests, in fact) thus forming a tree. The root of this tree is
  49 always a InsetMathHull, which provides an interface to the Outer World by
  50 inclusion in the "real LyX insets" FormulaInset and FormulaMacroInset.
  51
  52 */
  53
  54 class OutputParams;
  55 class InsetMathArray;
  56 class InsetMathAMSArray;
  57 class InsetMathBrace;
  58 class InsetMathChar;
  59 class InsetMathDelim;
  60 class InsetMathFrac;
  61 class InsetMathFont;
  62 class InsetMathGrid;
  63 class InsetMathHull;
  64 class InsetMathMatrix;
  65 class InsetMathNest;
  66 class InsetMathParbox;
  67 class InsetMathScript;
  68 class InsetMathString;
  69 class InsetMathSpace;
  70 class InsetMathSymbol;
  71 class InsetMathUnknown;
  72
  73 class RefInset;
  74
  75 class NormalStream;
  76 class OctaveStream;
  77 class MapleStream;
  78 class MaximaStream;
  79 class MathematicaStream;
  80 class MathStream;
  81 class WriteStream;
  82 class InfoStream;
  83
  84 class MathMacroTemplate;
  85 class MathMacro;
  86 class MathPosFinder;
  87 class Cursor;
  88 class TextPainter;
  89 class TextMetricsInfo;
  90 class ReplaceData;
  91
  92
  93 class InsetMath : public InsetBase {
  94 public:
  95         /// identification as math inset
  96         InsetMath * asInsetMath() { return this; }
  97         /// this is overridden in math text insets (i.e. mbox)
  98         bool inMathed() const { return true; }
  99
 100         /// the ascent of the inset above the baseline
 101         /// compute the size of the object for text based drawing
 102         virtual void metricsT(TextMetricsInfo const & mi, Dimension & dim) const;
 103         /// draw the object as text
 104         virtual void drawT(TextPainter &, int x, int y) const;
 105
 106         /// return cell given its number
 107         virtual MathArray & cell(idx_type);
 108         /// return cell given its number
 109         virtual MathArray const & cell(idx_type) const;
 110
 111         /// identifies certain types of insets
 112         virtual InsetMathAMSArray       * asAMSArrayInset()       { return 0; }
 113         virtual InsetMathAMSArray const * asAMSArrayInset() const { return 0; }
 114         virtual InsetMathArray          * asArrayInset()          { return 0; }
 115         virtual InsetMathArray const    * asArrayInset() const    { return 0; }
 116         virtual InsetMathBrace const    * asBraceInset() const    { return 0; }
 117         virtual InsetMathChar const     * asCharInset() const     { return 0; }
 118         virtual InsetMathDelim          * asDelimInset()          { return 0; }
 119         virtual InsetMathDelim const    * asDelimInset() const    { return 0; }
 120         virtual InsetMathFrac           * asFracInset()           { return 0; }
 121         virtual InsetMathFrac const     * asFracInset() const     { return 0; }
 122         virtual InsetMathFont           * asFontInset()           { return 0; }
 123         virtual InsetMathFont const     * asFontInset() const     { return 0; }
 124         virtual InsetMathGrid           * asGridInset()           { return 0; }
 125         virtual InsetMathGrid const     * asGridInset() const     { return 0; }
 126         virtual InsetMathHull           * asHullInset()           { return 0; }
 127         virtual InsetMathHull const     * asHullInset() const     { return 0; }
 128         virtual MathMacro               * asMacro()               { return 0; }
 129         virtual MathMacro const         * asMacro() const         { return 0; }
 130         virtual MathMacroTemplate       * asMacroTemplate()       { return 0; }
 131         virtual MathMacroTemplate const * asMacroTemplate() const { return 0; }
 132         virtual InsetMathMatrix const   * asMatrixInset() const   { return 0; }
 133         virtual InsetMathNest           * asNestInset()           { return 0; }
 134         virtual InsetMathNest const     * asNestInset() const     { return 0; }
 135         virtual InsetMathParbox         * asParboxInset()         { return 0; }
 136         virtual InsetMathScript         * asScriptInset()         { return 0; }
 137         virtual InsetMathScript const   * asScriptInset() const   { return 0; }
 138         virtual InsetMathSpace          * asSpaceInset()          { return 0; }
 139         virtual InsetMathSpace const    * asSpaceInset() const    { return 0; }
 140         virtual InsetMathString         * asStringInset()         { return 0; }
 141         virtual InsetMathString const   * asStringInset() const   { return 0; }
 142         virtual InsetMathSymbol const   * asSymbolInset() const   { return 0; }
 143         virtual InsetMathUnknown        * asUnknownInset()        { return 0; }
 144         virtual InsetMathUnknown const  * asUnknownInset() const  { return 0; }
 145         virtual RefInset                * asRefInset()            { return 0; }
 146
 147         /// identifies things that can get scripts
 148         virtual bool isScriptable() const { return false; }
 149         /// is the a relational operator (used for splitting equations)
 150         virtual bool isRelOp() const { return false; }
 151         /// will this get written as a single block in {..}
 152         virtual bool extraBraces() const { return false; }
 153
 154         /// return the content as char if the inset is able to do so
 155         virtual char_type getChar() const { return 0; }
 156         /// identifies things that can get \limits or \nolimits
 157         virtual bool takesLimits() const { return false; }
 158
 159         /// char char code if possible
 160         virtual void handleFont(docstring const &) {}
 161         /// replace things by other things
 162         virtual void replace(ReplaceData &) {}
 163         /// do we contain a given subsequence?
 164         virtual bool contains(MathArray const &) const { return false; }
 165         /// access to the lock (only nest array have one)
 166         virtual bool lock() const { return false; }
 167         /// access to the lock (only nest array have one)
 168         virtual void lock(bool) {}
 169
 170         /// write LaTeX and Lyx code
 171         virtual void write(WriteStream & os) const;
 172         /// write normalized content
 173         virtual void normalize(NormalStream &) const;
 174         /// write content as something readable by Maple
 175         virtual void maple(MapleStream &) const;
 176         /// write content as something readable by Maxima
 177         virtual void maxima(MaximaStream &) const;
 178         /// write content as something readable by Mathematica
 179         virtual void mathematica(MathematicaStream &) const;
 180         /// write content as something resembling MathML
 181         virtual void mathmlize(MathStream &) const;
 182         /// write content as something readable by Octave
 183         virtual void octave(OctaveStream &) const;
 184
 185         /// plain text output in ucs4 encoding
 186         int plaintext(Buffer const &, odocstream &,
 187                       OutputParams const &) const;
 188
 189         /// dump content to stderr for debugging
 190         virtual void dump() const;
 191
 192         /// LyXInset stuff
 193         virtual bool numberedType() const { return false; }
 194         /// hull type
 195         virtual HullType getType() const;
 196         /// change type
 197         virtual void mutate(HullType /*newtype*/) {}
 198         /// usually the latex name
 199         virtual docstring name() const;
 200
 201         /// math stuff usually isn't allowed in text mode
 202         virtual bool allowedIn(mode_type mode) const { return mode == MATH_MODE; }
 203
 204         /// superscript kerning
 205         virtual int kerning() const { return 0; }
 206 };
 207
 208 ///
 209 std::ostream & operator<<(std::ostream &, MathAtom const &);
 210 ///
 211 odocstream & operator<<(odocstream &, MathAtom const &);
 212
 213 // initialize math
 214 void initMath();
 215
 216
 217 } // namespace lyx
 218
 219 #endif