X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Fmathed%2FInsetMath.h;h=578b29fdcfd671926789bf3036b3859003c21941;hb=a68e5b777487b495feeefa53700834ecec6ec196;hp=aae24abd0ddb2a275fcc969489bcc18bff20a2a4;hpb=7eeb664bbb563b15256452da77aaabff51bb1431;p=lyx.git diff --git a/src/mathed/InsetMath.h b/src/mathed/InsetMath.h index aae24abd0d..578b29fdcf 100644 --- a/src/mathed/InsetMath.h +++ b/src/mathed/InsetMath.h @@ -13,7 +13,7 @@ #ifndef MATH_INSET_H #define MATH_INSET_H -#include "MathData.h" +#include "MathClass.h" #include "insets/Inset.h" @@ -32,7 +32,8 @@ enum HullType { hullFlAlign, hullMultline, hullGather, - hullRegexp + hullRegexp, + hullUnknown }; HullType hullType(docstring const & name); @@ -44,20 +45,24 @@ Abstract base class for all math objects. A math insets is for use of the math editor only, it isn't a general LyX inset. It's used to represent all the math objects. -Math insets do not know there parents, a cursor position or things -like that. The are dumb object that are contained in other math insets +Math insets do not know their parents, a cursor position or things +like that. They are dumb objects that are contained in other math insets (InsetMathNests, in fact) thus forming a tree. The root of this tree is always a InsetMathHull, which provides an interface to the Outer World by inclusion in the "real LyX insets" FormulaInset and FormulaMacroInset. */ +class Cursor; class OutputParams; +class MetricsInfo; + class InsetMathArray; class InsetMathAMSArray; class InsetMathBrace; class InsetMathChar; class InsetMathDelim; +class InsetMathFracBase; class InsetMathFrac; class InsetMathFont; class InsetMathGrid; @@ -68,12 +73,8 @@ class InsetMathScript; class InsetMathString; class InsetMathSpace; class InsetMathSpecialChar; -class InsetMathSubstack; class InsetMathSymbol; -class InsetMathTabular; class InsetMathUnknown; -class InsetMathXYMatrix; - class InsetMathRef; class HtmlStream; @@ -84,16 +85,18 @@ class MaximaStream; class MathematicaStream; class MathStream; class WriteStream; -class InfoStream; -class MathMacroTemplate; -class MathMacro; -class MathPosFinder; -class Cursor; +class MathData; +class InsetMathMacroTemplate; +class InsetMathMacro; +class MathRow; class TextPainter; class TextMetricsInfo; class ReplaceData; +/// Type of unique identifiers for math insets (used in TexRow) +typedef void const * uid_type; + class InsetMath : public Inset { public: @@ -105,10 +108,17 @@ public: InsetMath const * asInsetMath() const { return this; } /// this is overridden in math text insets (i.e. mbox) bool inMathed() const { return true; } + /// + virtual docstring name() const; /// this is overridden by specific insets virtual mode_type currentMode() const { return MATH_MODE; } + // The possible marker types for math insets + enum marker_type { NO_MARKER, MARKER2, MARKER, BOX_MARKER }; + /// this is overridden by insets with specific edit marker type + virtual marker_type marker(BufferView const *) const; + /// the ascent of the inset above the baseline /// compute the size of the object for text based drawing virtual void metricsT(TextMetricsInfo const & mi, Dimension & dim) const; @@ -130,6 +140,8 @@ public: virtual InsetMathChar const * asCharInset() const { return 0; } virtual InsetMathDelim * asDelimInset() { return 0; } virtual InsetMathDelim const * asDelimInset() const { return 0; } + virtual InsetMathFracBase * asFracBaseInset() { return 0; } + virtual InsetMathFracBase const * asFracBaseInset() const { return 0; } virtual InsetMathFrac * asFracInset() { return 0; } virtual InsetMathFrac const * asFracInset() const { return 0; } virtual InsetMathFont * asFontInset() { return 0; } @@ -138,10 +150,10 @@ public: virtual InsetMathGrid const * asGridInset() const { return 0; } virtual InsetMathHull * asHullInset() { return 0; } virtual InsetMathHull const * asHullInset() const { return 0; } - virtual MathMacro * asMacro() { return 0; } - virtual MathMacro const * asMacro() const { return 0; } - virtual MathMacroTemplate * asMacroTemplate() { return 0; } - virtual MathMacroTemplate const * asMacroTemplate() const { return 0; } + virtual InsetMathMacro * asMacro() { return 0; } + virtual InsetMathMacro const * asMacro() const { return 0; } + virtual InsetMathMacroTemplate * asMacroTemplate() { return 0; } + virtual InsetMathMacroTemplate const * asMacroTemplate() const { return 0; } virtual InsetMathMatrix const * asMatrixInset() const { return 0; } virtual InsetMathNest * asNestInset() { return 0; } virtual InsetMathNest const * asNestInset() const { return 0; } @@ -151,22 +163,27 @@ public: virtual InsetMathSpace const * asSpaceInset() const { return 0; } virtual InsetMathString * asStringInset() { return 0; } virtual InsetMathString const * asStringInset() const { return 0; } - virtual InsetMathSubstack * asSubstackInset() { return 0; } - virtual InsetMathSubstack const * asSubstackInset() const { return 0; } virtual InsetMathSymbol const * asSymbolInset() const { return 0; } - virtual InsetMathTabular * asTabularInset() { return 0; } - virtual InsetMathTabular const * asTabularInset() const { return 0; } virtual InsetMathUnknown * asUnknownInset() { return 0; } virtual InsetMathUnknown const * asUnknownInset() const { return 0; } - virtual InsetMathXYMatrix * asXYMatrixInset() { return 0; } - virtual InsetMathXYMatrix const * asXYMatrixInset() const { return 0; } virtual InsetMathRef * asRefInset() { return 0; } virtual InsetMathSpecialChar const * asSpecialCharInset() const { return 0; } + /// The class of the math object (used primarily for spacing) + virtual MathClass mathClass() const; + /// Add this inset to a math row. Return true if contents got added + virtual bool addToMathRow(MathRow &, MetricsInfo & mi) const; + /// Hook that is run before metrics computation starts + virtual void beforeMetrics() const {} + /// Hook that is run after metrics computation + virtual void afterMetrics() const {} + /// Hook that is run before actual drawing + virtual void beforeDraw(PainterInfo const &) const {} + /// Hook that is run after drawing + virtual void afterDraw(PainterInfo const &) const {} + /// identifies things that can get scripts virtual bool isScriptable() const { return false; } - /// is the a relational operator (used for splitting equations) - virtual bool isRelOp() const { return false; } /// will this get written as a single block in {..} virtual bool extraBraces() const { return false; } @@ -175,8 +192,6 @@ public: /// identifies things that can get \limits or \nolimits virtual bool takesLimits() const { return false; } - /// char char code if possible - virtual void handleFont(docstring const &) {} /// replace things by other things virtual void replace(ReplaceData &) {} /// do we contain a given subsequence? @@ -186,7 +201,10 @@ public: /// access to the lock (only nest array have one) virtual void lock(bool) {} - /// write LaTeX and Lyx code + // Indicate that we do not want to hide the normal version of + // write(). This is to shut off a clang warning. + using Inset::write; + /// write LaTeX and LyX code virtual void write(WriteStream & os) const; /// write normalized content virtual void normalize(NormalStream &) const; @@ -207,7 +225,7 @@ public: virtual void octave(OctaveStream &) const; /// plain text output in ucs4 encoding - int plaintext(odocstream &, OutputParams const &) const; + int plaintext(odocstringstream &, OutputParams const &, size_t) const; /// dump content to stderr for debugging virtual void dump() const; @@ -222,10 +240,14 @@ public: /// math stuff usually isn't allowed in text mode virtual bool allowedIn(mode_type mode) const { return mode == MATH_MODE; } - /// superscript kerning + /// Italic correction as described in InsetMathScript.h virtual int kerning(BufferView const *) const { return 0; } /// + bool isInToc() const { return true; } + /// InsetCode lyxCode() const { return MATH_CODE; } + /// + uid_type id() const { return this; } }; ///