4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
9 * Full author contact details are available in file CREDITS.
12 #ifndef MATH_MATHMLSTREAM_H
13 #define MATH_MATHMLSTREAM_H
15 #include "InsetMath.h"
18 #include "texstream.h"
20 #include "support/Changer.h"
21 #include "support/strfwd.h"
22 #include "support/unique_ptr.h"
51 explicit WriteStream(otexrowstream & os, bool fragile = false,
52 bool latex = false, OutputType output = wsDefault,
53 Encoding const * encoding = 0);
57 int line() const { return line_; }
59 bool fragile() const { return fragile_; }
61 bool latex() const { return latex_; }
63 OutputType output() const { return output_; }
65 otexrowstream & os() { return os_; }
67 TexRow & texrow() { return os_.texrow(); }
69 bool & firstitem() { return firstitem_; }
71 void addlines(unsigned int);
72 /// record whether we can write an immediately following newline char
73 void canBreakLine(bool breakline) { canbreakline_ = breakline; }
74 /// tell whether we can write an immediately following newline char
75 bool canBreakLine() const { return canbreakline_; }
76 /// record whether we have to take care for striking out display math
77 void strikeoutMath(bool mathsout) { mathsout_ = mathsout; }
78 /// tell whether we have to take care for striking out display math
79 bool strikeoutMath() const { return mathsout_; }
80 /// record which ulem command type we are inside
81 void ulemCmd(UlemCmdType ulemcmd) { ulemcmd_ = ulemcmd; }
82 /// tell which ulem command type we are inside
83 UlemCmdType ulemCmd() const { return ulemcmd_; }
84 /// writes space if next thing is isalpha()
85 void pendingSpace(bool how);
86 /// writes space if next thing is isalpha()
87 bool pendingSpace() const { return pendingspace_; }
88 /// tell whether to write the closing brace of \ensuremath
89 void pendingBrace(bool brace);
90 /// tell whether to write the closing brace of \ensuremath
91 bool pendingBrace() const { return pendingbrace_; }
92 /// tell whether we are in text mode or not when producing latex code
93 void textMode(bool textmode);
94 /// tell whether we are in text mode or not when producing latex code
95 bool textMode() const { return textmode_; }
96 /// tell whether we are allowed to switch mode when producing latex code
97 void lockedMode(bool locked);
98 /// tell whether we are allowed to switch mode when producing latex code
99 bool lockedMode() const { return locked_; }
100 /// tell whether to use only ascii chars when producing latex code
101 void asciiOnly(bool ascii);
102 /// tell whether to use only ascii chars when producing latex code
103 bool asciiOnly() const { return ascii_; }
104 /// tell whether we are in a MathClass inset
105 void inMathClass(bool mathclass) { mathclass_ = mathclass; };
106 /// tell whether we are in a MathClass inset
107 bool inMathClass() const { return mathclass_; }
109 Encoding const * encoding() const { return encoding_; }
111 /// Temporarily change the TexRow information about the outer row entry.
112 Changer changeRowEntry(TexRow::RowEntry entry);
113 /// TexRow::starts the innermost outer math inset
114 /// returns true if the outer row entry will appear at this line
115 bool startOuterRow();
119 /// do we have to write \\protect sometimes
121 /// are we at the beginning of an MathData?
123 /// are we writing to .tex?
125 /// output type (default, source preview, instant preview)?
127 /// do we have a space pending?
129 /// do we have a brace pending?
131 /// are we in text mode when producing latex code?
133 /// are we allowed to switch mode when producing latex code?
135 /// should we use only ascii chars when producing latex code?
137 /// are we allowed to output an immediately following newline?
139 /// should we take care for striking out display math?
141 /// what ulem command are we inside (none, underline, strikeout)?
142 UlemCmdType ulemcmd_;
146 Encoding const * encoding_;
147 /// Row entry we are in
148 TexRow::RowEntry row_entry_;
149 /// whether we are in a MathClass inset
154 WriteStream & operator<<(WriteStream &, MathAtom const &);
156 WriteStream & operator<<(WriteStream &, MathData const &);
158 WriteStream & operator<<(WriteStream &, docstring const &);
160 WriteStream & operator<<(WriteStream &, char const * const);
162 WriteStream & operator<<(WriteStream &, char);
164 WriteStream & operator<<(WriteStream &, int);
166 WriteStream & operator<<(WriteStream &, unsigned int);
168 /// ensure correct mode, possibly by opening \ensuremath or \lyxmathsym
169 bool ensureMath(WriteStream & os, bool needs_mathmode = true,
170 bool macro = false, bool textmode_macro = false);
172 /// ensure the requested mode, possibly by closing \ensuremath or \lyxmathsym
173 int ensureMode(WriteStream & os, InsetMath::mode_type mode, bool locked, bool ascii);
177 * MathEnsurer - utility class for ensuring math mode
179 * A local variable of this type can be used to either ensure math mode
180 * or delay the writing of a pending brace when outputting LaTeX.
181 * A LyX InsetMathMacro is always assumed needing a math mode environment, while
182 * no assumption is made for macros defined through \newcommand or \def.
186 * MathEnsurer ensurer(os);
188 * If not already in math mode, inserts an \ensuremath command followed
189 * by an open brace. This brace will be automatically closed when exiting
190 * math mode. Math mode is automatically exited when writing something
191 * that doesn't explicitly require math mode.
195 * MathEnsurer ensurer(os, false);
197 * Simply suspend writing a closing brace until the end of ensurer's scope.
201 * MathEnsurer ensurer(os, needs_mathmode, true, textmode_macro);
203 * This form is mainly used for math macros as they are treated specially.
204 * In essence, the macros defined in the lib/symbols file and tagged as
205 * textmode will be enclosed in \lyxmathsym if they appear in a math mode
206 * environment, while macros defined in the preamble or ERT are left as is.
207 * The third parameter must be set to true and the fourth parameter has also
208 * to be specified. Only the following 3 different cases are handled.
210 * When the needs_mathmode parameter is true the behavior is as in Example 1.
211 * This is the case for a LyX InsetMathMacro or a macro not tagged as textmode.
213 * When the needs_mathmode and textmode_macro parameters are both false the
214 * macro is left in the same (text or math mode) environment it was entered.
215 * This is because it is assumed that the macro was designed for that mode
216 * and we have no way to tell the contrary.
217 * This is the case for macros defined by using \newcommand or \def in ERT.
219 * When the needs_mathmode parameter is false while textmode_macro is true the
220 * macro will be enclosed in \lyxmathsym if it appears in a math mode environment.
221 * This is the case for the macros tagged as textmode in lib/symbols.
227 explicit MathEnsurer(WriteStream & os, bool needs_mathmode = true,
228 bool macro = false, bool textmode_macro = false)
229 : os_(os), brace_(ensureMath(os, needs_mathmode, macro, textmode_macro)) {}
231 ~MathEnsurer() { os_.pendingBrace(brace_); }
241 * ModeSpecifier - utility class for specifying a given mode (math or text)
243 * A local variable of this type can be used to specify that a command or
244 * environment works in a given mode. For example, \mbox works in text
245 * mode, but \boxed works in math mode. Note that no mode changing commands
246 * are needed, but we have to track the current mode, hence this class.
247 * This is only used when exporting to latex and helps determining whether
248 * the mode needs being temporarily switched when a command would not work
249 * in the current mode. As there are cases where this switching is to be
250 * avoided, the optional third parameter can be used to lock the mode.
251 * When the mode is locked, the optional fourth parameter specifies whether
252 * strings are to be output by using a suitable ascii representation.
256 * ModeSpecifier specifier(os, TEXT_MODE);
258 * Sets the current mode to text mode and allows mode switching.
262 * ModeSpecifier specifier(os, TEXT_MODE, true);
264 * Sets the current mode to text mode and disallows mode switching.
268 * ModeSpecifier specifier(os, TEXT_MODE, true, true);
270 * Sets the current mode to text mode, disallows mode switching, and outputs
271 * strings as ascii only.
273 * At the end of specifier's scope the mode is reset to its previous value.
279 explicit ModeSpecifier(WriteStream & os, InsetMath::mode_type mode,
280 bool locked = false, bool ascii = false)
281 : os_(os), oldmodes_(ensureMode(os, mode, locked, ascii)) {}
285 os_.textMode(oldmodes_ & 0x01);
286 os_.lockedMode(oldmodes_ & 0x02);
287 os_.asciiOnly(oldmodes_ & 0x04);
307 MTag(char const * const tag, std::string const & attr = std::string())
308 : tag_(tag), attr_(attr) {}
310 char const * const tag_;
320 explicit ETag(char const * const tag) : tag_(tag) {}
322 char const * const tag_;
326 /// Compound tag (no content, directly closed).
330 CTag(char const * const tag, std::string const & attr = "")
331 : tag_(tag), attr_(attr) {}
333 char const * const tag_;
339 /// Throw MathExportException to signal that the attempt to export
340 /// some math in the current format did not succeed. E.g., we can't
341 /// export xymatrix as MathML, so that will throw, and we'll fall back
343 class MathExportException : public std::exception {};
348 /// Builds a stream proxy for os; the MathML namespace is given by xmlns (supposed to be already defined elsewhere in the document).
349 explicit MathStream(odocstream & os, std::string const & xmlns = "", bool xmlMode = false);
353 odocstream & os() { return os_; }
355 int line() const { return line_; }
357 int & tab() { return tab_; }
359 friend MathStream & operator<<(MathStream &, char const *);
361 void defer(docstring const &);
363 void defer(std::string const &);
365 docstring deferred() const;
367 bool inText() const { return in_text_; }
369 std::string xmlns() const { return xmlns_; }
371 bool xmlMode() const { return xml_mode_; }
372 /// Returns the tag name prefixed by the name space if needed.
373 std::string namespacedTag(std::string const & tag) const {
374 return (xmlns().empty() ? "" : xmlns() + ":") + tag;
378 void setTextMode(bool t) { in_text_ = t; }
388 odocstringstream deferred_;
394 friend class SetMode;
398 MathStream & operator<<(MathStream &, MathAtom const &);
400 MathStream & operator<<(MathStream &, MathData const &);
402 MathStream & operator<<(MathStream &, docstring const &);
404 MathStream & operator<<(MathStream &, char const *);
406 MathStream & operator<<(MathStream &, char);
408 MathStream & operator<<(MathStream &, char_type);
410 MathStream & operator<<(MathStream &, MTag const &);
412 MathStream & operator<<(MathStream &, ETag const &);
414 MathStream & operator<<(MathStream &, CTag const &);
417 /// A simpler version of ModeSpecifier, for MathML
421 explicit SetMode(MathStream & ms, bool text);
435 explicit HtmlStream(odocstream & os);
439 odocstream & os() { return os_; }
441 int line() const { return line_; }
443 int & tab() { return tab_; }
445 friend HtmlStream & operator<<(HtmlStream &, char const *);
447 void defer(docstring const &);
449 void defer(std::string const &);
451 docstring deferred() const;
453 bool inText() const { return in_text_; }
456 void setTextMode(bool t) { in_text_ = t; }
466 odocstringstream deferred_;
468 friend class SetHTMLMode;
472 HtmlStream & operator<<(HtmlStream &, MathAtom const &);
474 HtmlStream & operator<<(HtmlStream &, MathData const &);
476 HtmlStream & operator<<(HtmlStream &, docstring const &);
478 HtmlStream & operator<<(HtmlStream &, char const *);
480 HtmlStream & operator<<(HtmlStream &, char);
482 HtmlStream & operator<<(HtmlStream &, char_type);
484 HtmlStream & operator<<(HtmlStream &, MTag const &);
486 HtmlStream & operator<<(HtmlStream &, ETag const &);
492 explicit SetHTMLMode(HtmlStream & os, bool text);
510 explicit NormalStream(odocstream & os) : os_(os) {}
512 odocstream & os() { return os_; }
519 NormalStream & operator<<(NormalStream &, MathAtom const &);
521 NormalStream & operator<<(NormalStream &, MathData const &);
523 NormalStream & operator<<(NormalStream &, docstring const &);
525 NormalStream & operator<<(NormalStream &, char const *);
527 NormalStream & operator<<(NormalStream &, char);
529 NormalStream & operator<<(NormalStream &, int);
540 explicit MapleStream(odocstream & os) : os_(os) {}
542 odocstream & os() { return os_; }
550 MapleStream & operator<<(MapleStream &, MathAtom const &);
552 MapleStream & operator<<(MapleStream &, MathData const &);
554 MapleStream & operator<<(MapleStream &, docstring const &);
556 MapleStream & operator<<(MapleStream &, char_type);
558 MapleStream & operator<<(MapleStream &, char const *);
560 MapleStream & operator<<(MapleStream &, char);
562 MapleStream & operator<<(MapleStream &, int);
573 explicit MaximaStream(odocstream & os) : os_(os) {}
575 odocstream & os() { return os_; }
583 MaximaStream & operator<<(MaximaStream &, MathAtom const &);
585 MaximaStream & operator<<(MaximaStream &, MathData const &);
587 MaximaStream & operator<<(MaximaStream &, docstring const &);
589 MaximaStream & operator<<(MaximaStream &, char_type);
591 MaximaStream & operator<<(MaximaStream &, char const *);
593 MaximaStream & operator<<(MaximaStream &, char);
595 MaximaStream & operator<<(MaximaStream &, int);
603 class MathematicaStream {
606 explicit MathematicaStream(odocstream & os) : os_(os) {}
608 odocstream & os() { return os_; }
616 MathematicaStream & operator<<(MathematicaStream &, MathAtom const &);
618 MathematicaStream & operator<<(MathematicaStream &, MathData const &);
620 MathematicaStream & operator<<(MathematicaStream &, docstring const &);
622 MathematicaStream & operator<<(MathematicaStream &, char const *);
624 MathematicaStream & operator<<(MathematicaStream &, char);
626 MathematicaStream & operator<<(MathematicaStream &, int);
637 explicit OctaveStream(odocstream & os) : os_(os) {}
639 odocstream & os() { return os_; }
646 OctaveStream & operator<<(OctaveStream &, MathAtom const &);
648 OctaveStream & operator<<(OctaveStream &, MathData const &);
650 OctaveStream & operator<<(OctaveStream &, docstring const &);
652 OctaveStream & operator<<(OctaveStream &, char_type);
654 OctaveStream & operator<<(OctaveStream &, char const *);
656 OctaveStream & operator<<(OctaveStream &, char);
658 OctaveStream & operator<<(OctaveStream &, int);
661 docstring convertDelimToXMLEscape(docstring const & name, bool xmlmode);