src/mathed/math_inset.h

   1 // -*- C++ -*-
   2 /**
   3  * \file math_inset.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 "insets/insetbase.h"
  17
  18 #include <string>
  19
  20 /**
  21
  22 Abstract base class for all math objects.  A math insets is for use of the
  23 math editor only, it isn't a general LyX inset. It's used to represent all
  24 the math objects.
  25
  26 Math insets do not know there parents, a cursor position or things
  27 like that. The are dumb object that are contained in other math insets
  28 (MathNestInsets, in fact) thus forming a tree. The root of this tree is
  29 always a MathHullInset, which provides an interface to the Outer World by
  30 inclusion in the "real LyX insets" FormulaInset and FormulaMacroInset.
  31
  32 */
  33
  34 class OutputParams;
  35 class MathArrayInset;
  36 class MathAMSArrayInset;
  37 class MathCharInset;
  38 class MathDelimInset;
  39 class MathFracInset;
  40 class MathFontInset;
  41 class MathGridInset;
  42 class MathHullInset;
  43 class MathMatrixInset;
  44 class MathNestInset;
  45 class MathParboxInset;
  46 class MathScriptInset;
  47 class MathStringInset;
  48 class MathSpaceInset;
  49 class MathSymbolInset;
  50 class MathUnknownInset;
  51
  52 class RefInset;
  53
  54 class MathArray;
  55 class MathAtom;
  56
  57 class NormalStream;
  58 class OctaveStream;
  59 class MapleStream;
  60 class MaximaStream;
  61 class MathematicaStream;
  62 class MathMLStream;
  63 class WriteStream;
  64 class InfoStream;
  65
  66 class MathMacroTemplate;
  67 class MathMacro;
  68 class MathPosFinder;
  69 class Dimension;
  70 class LCursor;
  71 class TextPainter;
  72 class TextMetricsInfo;
  73 class ReplaceData;
  74
  75
  76 class MathInset : public InsetBase {
  77 public:
  78         /// identification as math inset
  79         MathInset * asMathInset() { return this; }
  80         /// this is overridden in math text insets (i.e. mbox)
  81         bool inMathed() const { return true; }
  82
  83         /// substitutes macro arguments if necessary
  84         virtual void substitute(MathMacro const & macro);
  85         /// the ascent of the inset above the baseline
  86         /// compute the size of the object for text based drawing
  87         virtual void metricsT(TextMetricsInfo const & mi, Dimension & dim) const;
  88         /// draw the object as text
  89         virtual void drawT(TextPainter &, int x, int y) const;
  90
  91         /// return cell given its number
  92         virtual MathArray & cell(idx_type);
  93         /// return cell given its number
  94         virtual MathArray const & cell(idx_type) const;
  95
  96         /// identifies certain types of insets
  97         virtual MathAMSArrayInset       * asAMSArrayInset()       { return 0; }
  98         virtual MathAMSArrayInset const * asAMSArrayInset() const { return 0; }
  99         virtual MathArrayInset          * asArrayInset()          { return 0; }
 100         virtual MathArrayInset const    * asArrayInset() const    { return 0; }
 101         virtual MathCharInset const     * asCharInset() const     { return 0; }
 102         virtual MathDelimInset          * asDelimInset()          { return 0; }
 103         virtual MathDelimInset const    * asDelimInset() const    { return 0; }
 104         virtual MathFracInset           * asFracInset()           { return 0; }
 105         virtual MathFracInset const     * asFracInset() const     { return 0; }
 106         virtual MathFontInset           * asFontInset()           { return 0; }
 107         virtual MathFontInset const     * asFontInset() const     { return 0; }
 108         virtual MathGridInset           * asGridInset()           { return 0; }
 109         virtual MathGridInset const     * asGridInset() const     { return 0; }
 110         virtual MathHullInset           * asHullInset()           { return 0; }
 111         virtual MathHullInset const     * asHullInset() const     { return 0; }
 112         virtual MathMacroTemplate       * asMacroTemplate()       { return 0; }
 113         virtual MathMacroTemplate const * asMacroTemplate() const { return 0; }
 114         virtual MathMatrixInset const   * asMatrixInset() const   { return 0; }
 115         virtual MathNestInset           * asNestInset()           { return 0; }
 116         virtual MathNestInset const     * asNestInset() const     { return 0; }
 117         virtual MathParboxInset         * asParboxInset()         { return 0; }
 118         virtual MathScriptInset         * asScriptInset()         { return 0; }
 119         virtual MathScriptInset const   * asScriptInset() const   { return 0; }
 120         virtual MathSpaceInset          * asSpaceInset()          { return 0; }
 121         virtual MathSpaceInset const    * asSpaceInset() const    { return 0; }
 122         virtual MathStringInset         * asStringInset()         { return 0; }
 123         virtual MathStringInset const   * asStringInset() const   { return 0; }
 124         virtual MathSymbolInset const   * asSymbolInset() const   { return 0; }
 125         virtual MathUnknownInset        * asUnknownInset()        { return 0; }
 126         virtual MathUnknownInset const  * asUnknownInset() const  { return 0; }
 127         virtual RefInset                * asRefInset()            { return 0; }
 128
 129         /// identifies things that can get scripts
 130         virtual bool isScriptable() const { return false; }
 131         /// is the a relational operator (used for splitting equations)
 132         virtual bool isRelOp() const { return false; }
 133         /// will this get written as a single block in {..}
 134         virtual bool extraBraces() const { return false; }
 135
 136         /// return the content as char if the inset is able to do so
 137         virtual char getChar() const { return 0; }
 138         /// identifies things that can get \limits or \nolimits
 139         virtual bool takesLimits() const { return false; }
 140
 141         /// char char code if possible
 142         virtual void handleFont(std::string const &) {}
 143         /// replace things by other things
 144         virtual void replace(ReplaceData &) {}
 145         /// do we contain a given subsequence?
 146         virtual bool contains(MathArray const &) const { return false; }
 147         /// access to the lock (only nest array have one)
 148         virtual bool lock() const { return false; }
 149         /// access to the lock (only nest array have one)
 150         virtual void lock(bool) {}
 151
 152         /// write LaTeX and Lyx code
 153         virtual void write(WriteStream & os) const;
 154         /// write normalized content
 155         virtual void normalize(NormalStream &) const;
 156         /// write content as something readable by Maple
 157         virtual void maple(MapleStream &) const;
 158         /// write content as something readable by Maxima
 159         virtual void maxima(MaximaStream &) const;
 160         /// write content as something readable by Mathematica
 161         virtual void mathematica(MathematicaStream &) const;
 162         /// write content as something resembling MathML
 163         virtual void mathmlize(MathMLStream &) const;
 164         /// write content as something readable by Octave
 165         virtual void octave(OctaveStream &) const;
 166
 167         /// dump content to stderr for debugging
 168         virtual void dump() const;
 169
 170         /// LyXInset stuff
 171         virtual bool numberedType() const { return false; }
 172         /// hull type
 173         virtual std::string const & getType() const;
 174         /// change type
 175         virtual void mutate(std::string const &) {}
 176         /// usually the latex name
 177         virtual std::string name() const;
 178 };
 179
 180 std::ostream & operator<<(std::ostream &, MathAtom const &);
 181
 182 // initialize math
 183 void initMath();
 184
 185 #endif