X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Fmathed%2FMathStream.h;h=ad1baada353dcd214b682442db7def4527a3a0d2;hb=efaae780dbbe3685e26e040ed4255e5abf268106;hp=81449cf76d4dce8e36dfe6cb6c3b8f408c1dff55;hpb=f1cba8ff64b369792fd49f5ddf90e8126ab476ac;p=lyx.git diff --git a/src/mathed/MathStream.h b/src/mathed/MathStream.h index 81449cf76d..ad1baada35 100644 --- a/src/mathed/MathStream.h +++ b/src/mathed/MathStream.h @@ -33,7 +33,13 @@ class MathData; class WriteStream { public: /// - WriteStream(odocstream & os, bool fragile, bool latex, bool dryrun, + enum OutputType { + wsDefault, + wsDryrun, + wsPreview + }; + /// + WriteStream(odocstream & os, bool fragile, bool latex, OutputType output, Encoding const * encoding = 0); /// explicit WriteStream(odocstream & os); @@ -46,13 +52,17 @@ public: /// bool latex() const { return latex_; } /// - bool dryrun() const { return dryrun_; } + OutputType output() const { return output_; } /// odocstream & os() { return os_; } /// 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_; } /// writes space if next thing is isalpha() void pendingSpace(bool how); /// writes space if next thing is isalpha() @@ -65,6 +75,14 @@ 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_; } private: @@ -76,14 +94,20 @@ private: 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_; /// int line_; /// @@ -109,7 +133,7 @@ WriteStream & operator<<(WriteStream &, unsigned int); bool ensureMath(WriteStream & os, bool needs_math_mode = true, bool macro = false); /// ensure the requested mode, possibly by closing \ensuremath -bool ensureMode(WriteStream & os, InsetMath::mode_type mode); +int ensureMode(WriteStream & os, InsetMath::mode_type mode, bool locked, bool ascii); /** @@ -169,12 +193,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 +225,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 +251,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 +267,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 +289,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 +307,11 @@ private: /// int line_; /// - char lastchar_; + bool in_text_; + /// + odocstringstream deferred_; + /// + friend class SetMode; }; /// @@ -251,11 +325,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