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 "MathClass.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         hullUnknown
  37 };
  38
  39 HullType hullType(docstring const & name);
  40 docstring hullName(HullType type);
  41
  42
  43 enum Limits {
  44         // what is obtained with \c \\nolimits
  45         NO_LIMITS = -1,
  46         // the default
  47         AUTO_LIMITS = 0,
  48         // what is obtained with \c \\limits
  49         LIMITS = 1
  50 };
  51
  52
  53 /**
  54
  55 Abstract base class for all math objects.  A math insets is for use of the
  56 math editor only, it isn't a general LyX inset. It's used to represent all
  57 the math objects.
  58
  59 Math insets do not know their parents, a cursor position or things
  60 like that. They are dumb objects that are contained in other math insets
  61 (InsetMathNests, in fact) thus forming a tree. The root of this tree is
  62 always a InsetMathHull, which provides an interface to the Outer World by
  63 inclusion in the "real LyX insets" FormulaInset and FormulaMacroInset.
  64
  65 */
  66
  67 class Cursor;
  68 class OutputParams;
  69 class MetricsInfo;
  70
  71 class InsetMathArray;
  72 class InsetMathAMSArray;
  73 class InsetMathBrace;
  74 class InsetMathChar;
  75 class InsetMathDelim;
  76 class InsetMathFracBase;
  77 class InsetMathFrac;
  78 class InsetMathFont;
  79 class InsetMathGrid;
  80 class InsetMathHull;
  81 class InsetMathMatrix;
  82 class InsetMathNest;
  83 class InsetMathScript;
  84 class InsetMathString;
  85 class InsetMathSpace;
  86 class InsetMathSpecialChar;
  87 class InsetMathSymbol;
  88 class InsetMathSubstack;
  89 class InsetMathUnknown;
  90 class InsetMathRef;
  91
  92 class HtmlStream;
  93 class NormalStream;
  94 class OctaveStream;
  95 class MapleStream;
  96 class MaximaStream;
  97 class MathematicaStream;
  98 class MathStream;
  99 class WriteStream;
 100
 101 class MathData;
 102 class InsetMathMacroTemplate;
 103 class InsetMathMacro;
 104 class MathRow;
 105 class TextPainter;
 106 class TextMetricsInfo;
 107 class ReplaceData;
 108
 109 /// Type of unique identifiers for math insets (used in TexRow)
 110 typedef void const * uid_type;
 111
 112
 113 class InsetMath : public Inset {
 114 public:
 115         ///
 116         explicit InsetMath(Buffer * buf = 0) : Inset(buf) {}
 117         /// identification as math inset
 118         InsetMath * asInsetMath() { return this; }
 119         /// identification as math inset
 120         InsetMath const * asInsetMath() const { return this; }
 121         /// this is overridden in math text insets (i.e. mbox)
 122         bool inMathed() const { return true; }
 123         ///
 124         virtual docstring name() const;
 125
 126         /// this is overridden by specific insets
 127         virtual mode_type currentMode() const { return MATH_MODE; }
 128
 129         // The possible marker types for math insets
 130         enum marker_type { NO_MARKER, MARKER2, MARKER, BOX_MARKER };
 131         /// this is overridden by insets with specific edit marker type
 132         virtual marker_type marker(BufferView const *) const;
 133
 134         /// the ascent of the inset above the baseline
 135         /// compute the size of the object for text based drawing
 136         virtual void metricsT(TextMetricsInfo const & mi, Dimension & dim) const;
 137         /// draw the object as text
 138         virtual void drawT(TextPainter &, int x, int y) const;
 139
 140         /// return cell given its number
 141         virtual MathData & cell(idx_type);
 142         /// return cell given its number
 143         virtual MathData const & cell(idx_type) const;
 144
 145         /// identifies certain types of insets
 146         virtual InsetMathAMSArray       * asAMSArrayInset()       { return nullptr; }
 147         virtual InsetMathAMSArray const * asAMSArrayInset() const { return nullptr; }
 148         virtual InsetMathArray          * asArrayInset()          { return nullptr; }
 149         virtual InsetMathArray const    * asArrayInset() const    { return nullptr; }
 150         virtual InsetMathBrace          * asBraceInset()          { return nullptr; }
 151         virtual InsetMathBrace const    * asBraceInset() const    { return nullptr; }
 152         virtual InsetMathChar const     * asCharInset() const     { return nullptr; }
 153         virtual InsetMathDelim          * asDelimInset()          { return nullptr; }
 154         virtual InsetMathDelim const    * asDelimInset() const    { return nullptr; }
 155         virtual InsetMathFracBase       * asFracBaseInset()       { return nullptr; }
 156         virtual InsetMathFracBase const * asFracBaseInset() const { return nullptr; }
 157         virtual InsetMathFrac           * asFracInset()           { return nullptr; }
 158         virtual InsetMathFrac const     * asFracInset() const     { return nullptr; }
 159         virtual InsetMathFont           * asFontInset()           { return nullptr; }
 160         virtual InsetMathFont const     * asFontInset() const     { return nullptr; }
 161         virtual InsetMathGrid           * asGridInset()           { return nullptr; }
 162         virtual InsetMathGrid const     * asGridInset() const     { return nullptr; }
 163         virtual InsetMathHull           * asHullInset()           { return nullptr; }
 164         virtual InsetMathHull const     * asHullInset() const     { return nullptr; }
 165         virtual InsetMathMacro               * asMacro()               { return nullptr; }
 166         virtual InsetMathMacro const         * asMacro() const         { return nullptr; }
 167         virtual InsetMathMacroTemplate       * asMacroTemplate()       { return nullptr; }
 168         virtual InsetMathMacroTemplate const * asMacroTemplate() const { return nullptr; }
 169         virtual InsetMathMatrix const   * asMatrixInset() const   { return nullptr; }
 170         virtual InsetMathNest           * asNestInset()           { return nullptr; }
 171         virtual InsetMathNest const     * asNestInset() const     { return nullptr; }
 172         virtual InsetMathScript         * asScriptInset()         { return nullptr; }
 173         virtual InsetMathScript const   * asScriptInset() const   { return nullptr; }
 174         virtual InsetMathSpace          * asSpaceInset()          { return nullptr; }
 175         virtual InsetMathSpace const    * asSpaceInset() const    { return nullptr; }
 176         virtual InsetMathString         * asStringInset()         { return nullptr; }
 177         virtual InsetMathString const   * asStringInset() const   { return nullptr; }
 178         virtual InsetMathSubstack       * asSubstackInset()       { return nullptr; }
 179         virtual InsetMathSubstack const * asSubstackInset() const { return nullptr; }
 180         virtual InsetMathSymbol const   * asSymbolInset() const   { return nullptr; }
 181         virtual InsetMathUnknown        * asUnknownInset()        { return nullptr; }
 182         virtual InsetMathUnknown const  * asUnknownInset() const  { return nullptr; }
 183         virtual InsetMathRef            * asRefInset()            { return nullptr; }
 184         virtual InsetMathSpecialChar const * asSpecialCharInset() const { return nullptr; }
 185
 186         /// The class of the math object (used primarily for spacing)
 187         virtual MathClass mathClass() const { return MC_ORD; }
 188         /// Add this inset to a math row. Return true if contents got added
 189         virtual bool addToMathRow(MathRow &, MetricsInfo & mi) const;
 190         /// Hook that is run before metrics computation starts
 191         virtual void beforeMetrics() const {}
 192         /// Hook that is run after metrics computation
 193         virtual void afterMetrics() const {}
 194         /// Hook that is run before actual drawing
 195         virtual void beforeDraw(PainterInfo const &) const {}
 196         /// Hook that is run after drawing
 197         virtual void afterDraw(PainterInfo const &) const {}
 198
 199         /// will this get written as a single block in {..}
 200         virtual bool extraBraces() const { return false; }
 201
 202         /// return the content as char if the inset is able to do so
 203         virtual char_type getChar() const { return 0; }
 204
 205         /// Whether the inset allows \(no)limits
 206         bool allowsLimitsChange() const { return mathClass() == MC_OP; }
 207         /// The default limits value
 208         virtual Limits defaultLimits() const { return NO_LIMITS; }
 209         /// whether the inset has limit-like sub/superscript
 210         virtual Limits limits() const { return AUTO_LIMITS; }
 211         /// sets types of sub/superscripts
 212         virtual void limits(Limits) {}
 213         /// write limits status for LaTeX and LyX code
 214         void writeLimits(WriteStream & os) const;
 215
 216         /// replace things by other things
 217         virtual void replace(ReplaceData &) {}
 218         /// do we contain a given subsequence?
 219         virtual bool contains(MathData const &) const { return false; }
 220         /// access to the lock (only nest array have one)
 221         virtual bool lock() const { return false; }
 222         /// access to the lock (only nest array have one)
 223         virtual void lock(bool) {}
 224
 225         // Indicate that we do not want to hide the normal version of
 226         // write(). This is to shut off a clang warning.
 227         using Inset::write;
 228         /// write LaTeX and LyX code
 229         virtual void write(WriteStream & os) const;
 230         /// write normalized content
 231         virtual void normalize(NormalStream &) const;
 232         /// write content as something readable by Maple
 233         virtual void maple(MapleStream &) const;
 234         /// write content as something readable by Maxima
 235         virtual void maxima(MaximaStream &) const;
 236         /// write content as something readable by Mathematica
 237         virtual void mathematica(MathematicaStream &) const;
 238         /// write content as MathML
 239         virtual void mathmlize(MathStream &) const;
 240         /// write content as HTML, best we can.
 241         /// the idea for this, and some of the details, come from
 242         /// eLyXer, written by Alex Fernandez. no code is borrowed. rather,
 243         /// we try to mimic how eLyXer outputs some math.
 244         virtual void htmlize(HtmlStream &) const;
 245         /// write content as something readable by Octave
 246         virtual void octave(OctaveStream &) const;
 247
 248         /// plain text output in ucs4 encoding
 249         int plaintext(odocstringstream &, OutputParams const &, size_t) const;
 250
 251         /// dump content to stderr for debugging
 252         virtual void dump() const;
 253
 254         /// LyXInset stuff
 255         virtual bool numberedType() const { return false; }
 256         /// hull type
 257         virtual HullType getType() const;
 258         /// change type
 259         virtual void mutate(HullType /*newtype*/) {}
 260
 261         /// math stuff usually isn't allowed in text mode
 262         virtual bool allowedIn(mode_type mode) const { return mode == MATH_MODE; }
 263
 264         /// Italic correction as described in InsetMathScript.h
 265         virtual int kerning(BufferView const *) const { return 0; }
 266         ///
 267         bool isInToc() const { return true; }
 268         ///
 269         InsetCode lyxCode() const { return MATH_CODE; }
 270         ///
 271         uid_type id() const { return this; }
 272 };
 273
 274 ///
 275 std::ostream & operator<<(std::ostream &, MathAtom const &);
 276 ///
 277 odocstream & operator<<(odocstream &, MathAtom const &);
 278
 279 // initialize math
 280 void initMath();
 281
 282
 283 } // namespace lyx
 284
 285 #endif