X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Fmathed%2FMathStream.h;h=b7e79434af1c02bea66f460abc4b39e215fe7648;hb=999831043e6da50b3095a2dfec7000d4209e586c;hp=81449cf76d4dce8e36dfe6cb6c3b8f408c1dff55;hpb=f1cba8ff64b369792fd49f5ddf90e8126ab476ac;p=lyx.git diff --git a/src/mathed/MathStream.h b/src/mathed/MathStream.h index 81449cf76d..b7e79434af 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 { @@ -33,10 +36,21 @@ class MathData; class WriteStream { public: /// - WriteStream(odocstream & os, bool fragile, bool latex, bool dryrun, - Encoding const * encoding = 0); + enum OutputType { + wsDefault, + wsDryrun, + wsPreview + }; + /// + 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(); /// @@ -46,13 +60,27 @@ public: /// bool latex() const { return latex_; } /// - bool dryrun() const { return dryrun_; } + 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_; } /// writes space if next thing is isalpha() void pendingSpace(bool how); /// writes space if next thing is isalpha() @@ -65,29 +93,55 @@ public: void textMode(bool textmode); /// tell whether we are in text mode or not when producing latex code bool textMode() const { return textmode_; } + /// tell whether we are allowed to switch mode when producing latex code + 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? bool firstitem_; /// are we writing to .tex? int latex_; - /// is it for preview? - bool dryrun_; + /// output type (default, source preview, instant preview)? + OutputType output_; /// do we have a space pending? bool pendingspace_; /// do we have a brace pending? bool pendingbrace_; /// are we in text mode when producing latex code? 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_; }; /// @@ -105,11 +159,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 -bool ensureMode(WriteStream & os, InsetMath::mode_type mode); +/// ensure the requested mode, possibly by closing \ensuremath or \lyxmathsym +int ensureMode(WriteStream & os, InsetMath::mode_type mode, bool locked, bool ascii); /** @@ -117,6 +172,8 @@ bool ensureMode(WriteStream & os, InsetMath::mode_type mode); * * 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 InsetMathMacro is always assumed needing a math mode environment, while + * no assumption is made for macros defined through \newcommand or \def. * * Example 1: * @@ -135,23 +192,35 @@ bool ensureMode(WriteStream & os, InsetMath::mode_type mode); * * 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 InsetMathMacro or a macro not tagged as textmode. * - * 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 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: @@ -169,12 +238,31 @@ private: * environment works in a given mode. For example, \mbox works in text * mode, but \boxed works in math mode. Note that no mode changing commands * are needed, but we have to track the current mode, hence this class. + * This is only used when exporting to latex and helps determining whether + * 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: + * Example 1: * * ModeSpecifier specifier(os, TEXT_MODE); * - * Sets the current mode to text mode. + * Sets the current mode to text mode and allows mode switching. + * + * Example 2: + * + * ModeSpecifier specifier(os, TEXT_MODE, true); + * + * 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. */ @@ -182,15 +270,21 @@ class ModeSpecifier { public: /// - explicit ModeSpecifier(WriteStream & os, InsetMath::mode_type mode) - : os_(os), textmode_(ensureMode(os, mode)) {} + explicit ModeSpecifier(WriteStream & os, InsetMath::mode_type mode, + bool locked = false, bool ascii = false) + : os_(os), oldmodes_(ensureMode(os, mode, locked, ascii)) {} /// - ~ModeSpecifier() { os_.textMode(textmode_); } + ~ModeSpecifier() + { + os_.textMode(oldmodes_ & 0x01); + os_.lockedMode(oldmodes_ & 0x02); + os_.asciiOnly(oldmodes_ & 0x04); + } private: /// WriteStream & os_; /// - bool textmode_; + int oldmodes_; }; @@ -202,9 +296,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 { @@ -215,6 +312,14 @@ public: char const * const tag_; }; + +/// 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: /// @@ -229,7 +334,17 @@ public: int & tab() { return tab_; } /// friend MathStream & operator<<(MathStream &, 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_; /// @@ -237,7 +352,11 @@ private: /// int line_; /// - char lastchar_; + bool in_text_; + /// + odocstringstream deferred_; + /// + friend class SetMode; }; /// @@ -251,11 +370,98 @@ MathStream & operator<<(MathStream &, char const *); /// MathStream & operator<<(MathStream &, char); /// +MathStream & operator<<(MathStream &, char_type); +/// MathStream & operator<<(MathStream &, MTag const &); /// MathStream & operator<<(MathStream &, ETag const &); +/// A simpler version of ModeSpecifier, for MathML +class SetMode { +public: + /// + explicit SetMode(MathStream & os, bool text); + /// + ~SetMode(); +private: + /// + MathStream & os_; + /// + bool was_text_; +}; + + +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 @@ -414,6 +620,9 @@ OctaveStream & operator<<(OctaveStream &, char); /// OctaveStream & operator<<(OctaveStream &, int); + +docstring convertDelimToXMLEscape(docstring const & name); + } // namespace lyx #endif