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