X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Fmathed%2FMathStream.h;h=271330ea0de201da5543cf332e457dd31ebe8708;hb=1f352b390c897d583bffaad695c04b613b88a139;hp=d1cfb9406840a2ea7dadfca64a3b5baf4236fe5e;hpb=670efa8f646218f2a378f0cc614c4c37a9f6b89a;p=lyx.git diff --git a/src/mathed/MathStream.h b/src/mathed/MathStream.h index d1cfb94068..271330ea0d 100644 --- a/src/mathed/MathStream.h +++ b/src/mathed/MathStream.h @@ -13,6 +13,8 @@ #define MATH_MATHMLSTREAM_H #include "InsetMath.h" + +#include "TexRow.h" #include "texstream.h" #include "support/Changer.h" @@ -26,7 +28,6 @@ class Encoding; class InsetMath; class MathAtom; class MathData; -class RowEntry; // // LaTeX/LyX @@ -41,6 +42,12 @@ public: wsPreview }; /// + enum UlemCmdType { + NONE, + UNDERLINE, + STRIKEOUT + }; + /// explicit WriteStream(otexrowstream & os, bool fragile = false, bool latex = false, OutputType output = wsDefault, Encoding const * encoding = 0); @@ -66,6 +73,18 @@ public: void canBreakLine(bool breakline) { canbreakline_ = breakline; } /// tell whether we can write an immediately following newline char bool canBreakLine() const { return canbreakline_; } + /// record whether we have to take care for striking out display math + void strikeoutMath(bool mathsout) { mathsout_ = mathsout; } + /// tell whether we have to take care for striking out display math + bool strikeoutMath() const { return mathsout_; } + /// record which ulem command type we are inside + void ulemCmd(UlemCmdType ulemcmd) { ulemcmd_ = ulemcmd; } + /// tell which ulem command type we are inside + UlemCmdType ulemCmd() const { return ulemcmd_; } + /// record whether we are in the argument of a math macro + void insideMacro(bool insidemacro) { insidemacro_ = insidemacro; } + /// tell whether we are in the argument of a math macro + bool insideMacro() const { return insidemacro_; } /// writes space if next thing is isalpha() void pendingSpace(bool how); /// writes space if next thing is isalpha() @@ -90,7 +109,7 @@ public: Encoding const * encoding() const { return encoding_; } /// Temporarily change the TexRow information about the outer row entry. - Changer changeRowEntry(RowEntry entry); + Changer changeRowEntry(TexRow::RowEntry entry); /// TexRow::starts the innermost outer math inset /// returns true if the outer row entry will appear at this line bool startOuterRow(); @@ -105,6 +124,8 @@ private: int latex_; /// output type (default, source preview, instant preview)? OutputType output_; + /// are we in the argument of a math macro? + bool insidemacro_; /// do we have a space pending? bool pendingspace_; /// do we have a brace pending? @@ -117,13 +138,16 @@ private: bool ascii_; /// are we allowed to output an immediately following newline? bool canbreakline_; + /// should we take care for striking out display math? + bool mathsout_; + /// what ulem command are we inside (none, underline, strikeout)? + UlemCmdType ulemcmd_; /// int line_; /// Encoding const * encoding_; /// Row entry we are in - /// (it is a pointer to allow forward-declaration) - unique_ptr row_entry_; + TexRow::RowEntry row_entry_; }; /// @@ -141,10 +165,11 @@ WriteStream & operator<<(WriteStream &, int); /// WriteStream & operator<<(WriteStream &, unsigned int); -/// ensure math mode, possibly by opening \ensuremath -bool ensureMath(WriteStream & os, bool needs_math_mode = true, bool macro = false); +/// ensure correct mode, possibly by opening \ensuremath or \lyxmathsym +bool ensureMath(WriteStream & os, bool needs_mathmode = true, + bool macro = false, bool textmode_macro = false); -/// ensure the requested mode, possibly by closing \ensuremath +/// ensure the requested mode, possibly by closing \ensuremath or \lyxmathsym int ensureMode(WriteStream & os, InsetMath::mode_type mode, bool locked, bool ascii); @@ -153,6 +178,8 @@ int ensureMode(WriteStream & os, InsetMath::mode_type mode, bool locked, bool as * * A local variable of this type can be used to either ensure math mode * or delay the writing of a pending brace when outputting LaTeX. + * A LyX MathMacro is always assumed needing a math mode environment, while + * no assumption is made for macros defined through \newcommand or \def. * * Example 1: * @@ -171,23 +198,35 @@ int ensureMode(WriteStream & os, InsetMath::mode_type mode, bool locked, bool as * * Example 3: * - * MathEnsurer ensurer(os, needs_math_mode, true); + * MathEnsurer ensurer(os, needs_mathmode, true, textmode_macro); + * + * This form is mainly used for math macros as they are treated specially. + * In essence, the macros defined in the lib/symbols file and tagged as + * textmode will be enclosed in \lyxmathsym if they appear in a math mode + * environment, while macros defined in the preamble or ERT are left as is. + * The third parameter must be set to true and the fourth parameter has also + * to be specified. Only the following 3 different cases are handled. + * + * When the needs_mathmode parameter is true the behavior is as in Example 1. + * This is the case for a LyX MathMacro or a macro not tagged as textmode. + * + * When the needs_mathmode and textmode_macro parameters are both false the + * macro is left in the same (text or math mode) environment it was entered. + * This is because it is assumed that the macro was designed for that mode + * and we have no way to tell the contrary. + * This is the case for macros defined by using \newcommand or \def in ERT. * - * The third parameter is set to true only for a user defined macro, which - * needs special handling. When it is a MathMacro, the needs_math_mode - * parameter is true and the behavior is as in Example 1. When the - * needs_math_mode parameter is false (not a MathMacro) and the macro - * was entered in a text box and we are in math mode, the mode is reset - * to text. This is because the macro was probably designed for text mode - * (given that it was entered in text mode and we have no way to tell the - * contrary). + * When the needs_mathmode parameter is false while textmode_macro is true the + * macro will be enclosed in \lyxmathsym if it appears in a math mode environment. + * This is the case for the macros tagged as textmode in lib/symbols. */ class MathEnsurer { public: /// - explicit MathEnsurer(WriteStream & os, bool needs_math_mode = true, bool macro = false) - : os_(os), brace_(ensureMath(os, needs_math_mode, macro)) {} + explicit MathEnsurer(WriteStream & os, bool needs_mathmode = true, + bool macro = false, bool textmode_macro = false) + : os_(os), brace_(ensureMath(os, needs_mathmode, macro, textmode_macro)) {} /// ~MathEnsurer() { os_.pendingBrace(brace_); } private: