X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Fmathed%2FMathStream.h;h=271330ea0de201da5543cf332e457dd31ebe8708;hb=cdc847fd304019a19425a0d5d9d42a556a937097;hp=8dc9c4628da69595636616c9f96a1dd9ffe9fdc0;hpb=4479a7f689d5fadc741f7798f85fec540d4970ea;p=lyx.git diff --git a/src/mathed/MathStream.h b/src/mathed/MathStream.h index 8dc9c4628d..271330ea0d 100644 --- a/src/mathed/MathStream.h +++ b/src/mathed/MathStream.h @@ -12,11 +12,14 @@ #ifndef MATH_MATHMLSTREAM_H #define MATH_MATHMLSTREAM_H -#include "support/strfwd.h" - #include "InsetMath.h" -// FIXME: Move to individual insets -#include "MetricsInfo.h" + +#include "TexRow.h" +#include "texstream.h" + +#include "support/Changer.h" +#include "support/strfwd.h" +#include "support/unique_ptr.h" namespace lyx { @@ -39,10 +42,15 @@ public: wsPreview }; /// - WriteStream(odocstream & os, bool fragile, bool latex, OutputType output, - Encoding const * encoding = 0); + enum UlemCmdType { + NONE, + UNDERLINE, + STRIKEOUT + }; /// - explicit WriteStream(odocstream & os); + explicit WriteStream(otexrowstream & os, bool fragile = false, + bool latex = false, OutputType output = wsDefault, + Encoding const * encoding = 0); /// ~WriteStream(); /// @@ -54,11 +62,29 @@ public: /// OutputType output() const { return output_; } /// - odocstream & os() { return os_; } + otexrowstream & os() { return os_; } + /// + TexRow & texrow() { return os_.texrow(); } /// bool & firstitem() { return firstitem_; } /// void addlines(unsigned int); + /// record whether we can write an immediately following newline char + 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() @@ -75,11 +101,21 @@ public: void lockedMode(bool locked); /// tell whether we are allowed to switch mode when producing latex code bool lockedMode() const { return locked_; } + /// tell whether to use only ascii chars when producing latex code + void asciiOnly(bool ascii); + /// tell whether to use only ascii chars when producing latex code + bool asciiOnly() const { return ascii_; } /// LaTeX encoding Encoding const * encoding() const { return encoding_; } + + /// Temporarily change the TexRow information about the outer row 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(); private: /// - odocstream & os_; + otexrowstream & os_; /// do we have to write \\protect sometimes bool fragile_; /// are we at the beginning of an MathData? @@ -88,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? @@ -96,10 +134,20 @@ private: bool textmode_; /// are we allowed to switch mode when producing latex code? bool locked_; + /// should we use only ascii chars when producing latex code? + 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 + TexRow::RowEntry row_entry_; }; /// @@ -117,11 +165,12 @@ 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 -int ensureMode(WriteStream & os, InsetMath::mode_type mode, bool locked); +/// ensure the requested mode, possibly by closing \ensuremath or \lyxmathsym +int ensureMode(WriteStream & os, InsetMath::mode_type mode, bool locked, bool ascii); /** @@ -129,6 +178,8 @@ int ensureMode(WriteStream & os, InsetMath::mode_type mode, bool locked); * * 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: * @@ -147,23 +198,35 @@ int ensureMode(WriteStream & os, InsetMath::mode_type mode, bool locked); * * 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. * - * 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 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. + * + * 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: @@ -185,6 +248,8 @@ private: * the mode needs being temporarily switched when a command would not work * in the current mode. As there are cases where this switching is to be * avoided, the optional third parameter can be used to lock the mode. + * When the mode is locked, the optional fourth parameter specifies whether + * strings are to be output by using a suitable ascii representation. * * Example 1: * @@ -198,6 +263,13 @@ private: * * Sets the current mode to text mode and disallows mode switching. * + * Example 3: + * + * ModeSpecifier specifier(os, TEXT_MODE, true, true); + * + * Sets the current mode to text mode, disallows mode switching, and outputs + * strings as ascii only. + * * At the end of specifier's scope the mode is reset to its previous value. */ class ModeSpecifier @@ -205,13 +277,14 @@ class ModeSpecifier public: /// explicit ModeSpecifier(WriteStream & os, InsetMath::mode_type mode, - bool locked = false) - : os_(os), oldmodes_(ensureMode(os, mode, locked)) {} + bool locked = false, bool ascii = false) + : os_(os), oldmodes_(ensureMode(os, mode, locked, ascii)) {} /// ~ModeSpecifier() { - os_.textMode(oldmodes_ & 1); - os_.lockedMode(oldmodes_ & 2); + os_.textMode(oldmodes_ & 0x01); + os_.lockedMode(oldmodes_ & 0x02); + os_.asciiOnly(oldmodes_ & 0x04); } private: /// @@ -229,9 +302,12 @@ private: class MTag { public: /// - MTag(char const * const tag) : tag_(tag) {} + MTag(char const * const tag, std::string attr = "") + : tag_(tag), attr_(attr) {} /// char const * const tag_; + /// + std::string attr_; }; class ETag { @@ -243,6 +319,13 @@ public: }; +/// Throw MathExportException to signal that the attempt to export +/// some math in the current format did not succeed. E.g., we can't +/// export xymatrix as MathML, so that will throw, and we'll fall back +/// to images. +class MathExportException : public std::exception {}; + + class MathStream { public: /// @@ -264,12 +347,10 @@ public: /// docstring deferred() const; /// - void setTextMode() { in_text_ = true; } - /// - void setMathMode() { in_text_ = false; } - /// bool inText() const { return in_text_; } private: + /// + void setTextMode(bool t) { in_text_ = t; } /// odocstream & os_; /// @@ -277,11 +358,11 @@ private: /// int line_; /// - char lastchar_; - /// bool in_text_; /// odocstringstream deferred_; + /// + friend class SetMode; }; /// @@ -302,27 +383,13 @@ MathStream & operator<<(MathStream &, MTag const &); MathStream & operator<<(MathStream &, ETag const &); -// A simpler version of ModeSpecifier, for MathML +/// A simpler version of ModeSpecifier, for MathML class SetMode { public: /// - explicit SetMode(MathStream & os, bool text) - : os_(os) - { - was_text_ = os.inText(); - if (text) - os.setTextMode(); - else - os.setMathMode(); - } + explicit SetMode(MathStream & os, bool text); /// - ~SetMode() - { - if (was_text_) - os_.setTextMode(); - else - os_.setMathMode(); - } + ~SetMode(); private: /// MathStream & os_; @@ -331,6 +398,77 @@ private: }; +class HtmlStream { +public: + /// + explicit HtmlStream(odocstream & os); + /// + void cr(); + /// + odocstream & os() { return os_; } + /// + int line() const { return line_; } + /// + int & tab() { return tab_; } + /// + friend HtmlStream & operator<<(HtmlStream &, char const *); + /// + void defer(docstring const &); + /// + void defer(std::string const &); + /// + docstring deferred() const; + /// + bool inText() const { return in_text_; } +private: + /// + void setTextMode(bool t) { in_text_ = t; } + /// + odocstream & os_; + /// + int tab_; + /// + int line_; + /// + bool in_text_; + /// + odocstringstream deferred_; + /// + friend class SetHTMLMode; +}; + +/// +HtmlStream & operator<<(HtmlStream &, MathAtom const &); +/// +HtmlStream & operator<<(HtmlStream &, MathData const &); +/// +HtmlStream & operator<<(HtmlStream &, docstring const &); +/// +HtmlStream & operator<<(HtmlStream &, char const *); +/// +HtmlStream & operator<<(HtmlStream &, char); +/// +HtmlStream & operator<<(HtmlStream &, char_type); +/// +HtmlStream & operator<<(HtmlStream &, MTag const &); +/// +HtmlStream & operator<<(HtmlStream &, ETag const &); + + +class SetHTMLMode { +public: + /// + explicit SetHTMLMode(HtmlStream & os, bool text); + /// + ~SetHTMLMode(); +private: + /// + HtmlStream & os_; + /// + bool was_text_; +}; + + // // Debugging // @@ -488,6 +626,9 @@ OctaveStream & operator<<(OctaveStream &, char); /// OctaveStream & operator<<(OctaveStream &, int); + +docstring convertDelimToXMLEscape(docstring const & name); + } // namespace lyx #endif