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 "MathData.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 Dimension;
  88 class LCursor;
  89 class TextPainter;
  90 class TextMetricsInfo;
  91 class ReplaceData;
  92
  93
  94 class InsetMath : public InsetBase {
  95 public:
  96         /// identification as math inset
  97         InsetMath * asInsetMath() { return this; }
  98         /// this is overridden in math text insets (i.e. mbox)
  99         bool inMathed() const { return true; }
 100
 101         /// the ascent of the inset above the baseline
 102         /// compute the size of the object for text based drawing
 103         virtual void metricsT(TextMetricsInfo const & mi, Dimension & dim) const;
 104         /// draw the object as text
 105         virtual void drawT(TextPainter &, int x, int y) const;
 106
 107         /// return cell given its number
 108         virtual MathArray & cell(idx_type);
 109         /// return cell given its number
 110         virtual MathArray const & cell(idx_type) const;
 111
 112         /// identifies certain types of insets
 113         virtual InsetMathAMSArray       * asAMSArrayInset()       { return 0; }
 114         virtual InsetMathAMSArray const * asAMSArrayInset() const { return 0; }
 115         virtual InsetMathArray          * asArrayInset()          { return 0; }
 116         virtual InsetMathArray const    * asArrayInset() const    { return 0; }
 117         virtual InsetMathBrace const    * asBraceInset() const    { return 0; }
 118         virtual InsetMathChar const     * asCharInset() const     { return 0; }
 119         virtual InsetMathDelim          * asDelimInset()          { return 0; }
 120         virtual InsetMathDelim const    * asDelimInset() const    { return 0; }
 121         virtual InsetMathFrac           * asFracInset()           { return 0; }
 122         virtual InsetMathFrac const     * asFracInset() const     { return 0; }
 123         virtual InsetMathFont           * asFontInset()           { return 0; }
 124         virtual InsetMathFont const     * asFontInset() const     { return 0; }
 125         virtual InsetMathGrid           * asGridInset()           { return 0; }
 126         virtual InsetMathGrid const     * asGridInset() const     { return 0; }
 127         virtual InsetMathHull           * asHullInset()           { return 0; }
 128         virtual InsetMathHull const     * asHullInset() const     { return 0; }
 129         virtual MathMacro               * asMacro()               { return 0; }
 130         virtual MathMacro const         * asMacro() const         { return 0; }
 131         virtual MathMacroTemplate       * asMacroTemplate()       { return 0; }
 132         virtual MathMacroTemplate const * asMacroTemplate() const { return 0; }
 133         virtual InsetMathMatrix const   * asMatrixInset() const   { return 0; }
 134         virtual InsetMathNest           * asNestInset()           { return 0; }
 135         virtual InsetMathNest const     * asNestInset() const     { return 0; }
 136         virtual InsetMathParbox         * asParboxInset()         { return 0; }
 137         virtual InsetMathScript         * asScriptInset()         { return 0; }
 138         virtual InsetMathScript const   * asScriptInset() const   { return 0; }
 139         virtual InsetMathSpace          * asSpaceInset()          { return 0; }
 140         virtual InsetMathSpace const    * asSpaceInset() const    { return 0; }
 141         virtual InsetMathString         * asStringInset()         { return 0; }
 142         virtual InsetMathString const   * asStringInset() const   { return 0; }
 143         virtual InsetMathSymbol const   * asSymbolInset() const   { return 0; }
 144         virtual InsetMathUnknown        * asUnknownInset()        { return 0; }
 145         virtual InsetMathUnknown const  * asUnknownInset() const  { return 0; }
 146         virtual RefInset                * asRefInset()            { return 0; }
 147
 148         /// identifies things that can get scripts
 149         virtual bool isScriptable() const { return false; }
 150         /// is the a relational operator (used for splitting equations)
 151         virtual bool isRelOp() const { return false; }
 152         /// will this get written as a single block in {..}
 153         virtual bool extraBraces() const { return false; }
 154
 155         /// return the content as char if the inset is able to do so
 156         virtual char_type getChar() const { return 0; }
 157         /// identifies things that can get \limits or \nolimits
 158         virtual bool takesLimits() const { return false; }
 159
 160         /// char char code if possible
 161         virtual void handleFont(docstring const &) {}
 162         /// replace things by other things
 163         virtual void replace(ReplaceData &) {}
 164         /// do we contain a given subsequence?
 165         virtual bool contains(MathArray const &) const { return false; }
 166         /// access to the lock (only nest array have one)
 167         virtual bool lock() const { return false; }
 168         /// access to the lock (only nest array have one)
 169         virtual void lock(bool) {}
 170
 171         /// write LaTeX and Lyx code
 172         virtual void write(WriteStream & os) const;
 173         /// write normalized content
 174         virtual void normalize(NormalStream &) const;
 175         /// write content as something readable by Maple
 176         virtual void maple(MapleStream &) const;
 177         /// write content as something readable by Maxima
 178         virtual void maxima(MaximaStream &) const;
 179         /// write content as something readable by Mathematica
 180         virtual void mathematica(MathematicaStream &) const;
 181         /// write content as something resembling MathML
 182         virtual void mathmlize(MathStream &) const;
 183         /// write content as something readable by Octave
 184         virtual void octave(OctaveStream &) const;
 185
 186         /// dump content to stderr for debugging
 187         virtual void dump() const;
 188
 189         /// LyXInset stuff
 190         virtual bool numberedType() const { return false; }
 191         /// hull type
 192         virtual HullType getType() const;
 193         /// change type
 194         virtual void mutate(HullType /*newtype*/) {}
 195         /// usually the latex name
 196         virtual docstring name() const;
 197
 198         /// math stuff usually isn't allowed in text mode
 199         virtual bool allowedIn(mode_type mode) const { return mode == MATH_MODE; }
 200 };
 201
 202 ///
 203 std::ostream & operator<<(std::ostream &, MathAtom const &);
 204 ///
 205 odocstream & operator<<(odocstream &, MathAtom const &);
 206
 207 // initialize math
 208 void initMath();
 209
 210
 211 } // namespace lyx
 212
 213 #endif