X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Fmathed%2FMathStream.h;h=153e7df3c584404a43b68ebae48db36a6ba2edce;hb=d9082639080b9de993742bd352f92e5183058cf5;hp=87868890859dd10c06af32203c9ad97bd4a18a71;hpb=a694de895effa49df79cb9b2fd00d6dce03fd0b2;p=lyx.git

diff --git a/src/mathed/MathStream.h b/src/mathed/MathStream.h
index 8786889085..153e7df3c5 100644
--- a/src/mathed/MathStream.h
+++ b/src/mathed/MathStream.h
@@ -4,7 +4,7 @@
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *
- * \author André Pönitz
+ * \author André Pönitz
  *
  * Full author contact details are available in file CREDITS.
  */
@@ -12,30 +12,45 @@
 #ifndef MATH_MATHMLSTREAM_H
 #define MATH_MATHMLSTREAM_H
 
-#include "support/strfwd.h"
+#include "InsetMath.h"
+
+#include "TexRow.h"
+#include "texstream.h"
 
-// FIXME: Move to individual insets
-#include "MetricsInfo.h"
+#include "support/Changer.h"
+#include "support/strfwd.h"
 
 
 namespace lyx {
 
-class MathData;
-class InsetMath;
+class Encoding;
 class MathAtom;
+class MathData;
 
 //
 // LaTeX/LyX
 //
 
-class WriteStream {
+class TeXMathStream {
 public:
 	///
-	WriteStream(odocstream & os, bool fragile, bool latex, bool dryrun);
+	enum OutputType {
+		wsDefault,
+		wsDryrun,
+		wsPreview
+	};
 	///
-	explicit WriteStream(odocstream & os);
+	enum UlemCmdType {
+		NONE,
+		UNDERLINE,
+		STRIKEOUT
+	};
 	///
-	~WriteStream();
+	explicit TeXMathStream(otexrowstream & os, bool fragile = false,
+	                       bool latex = false, OutputType output = wsDefault,
+	                       Encoding const * encoding = nullptr);
+	///
+	~TeXMathStream();
 	///
 	int line() const { return line_; }
 	///
@@ -43,48 +58,244 @@ 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);
+	void pendingSpace(bool space);
 	/// writes space if next thing is isalpha()
 	bool pendingSpace() const { return pendingspace_; }
+	/// write braces if a space is pending and next char is [
+	void useBraces(bool braces);
+	/// write braces if a space is pending and next char is [
+	bool useBraces() const { return usebraces_; }
+	/// tell whether to write the closing brace of \ensuremath
+	void pendingBrace(bool brace);
+	/// tell whether to write the closing brace of \ensuremath
+	bool pendingBrace() const { return pendingbrace_; }
+	/// tell whether we are in text mode or not when producing latex code
+	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_; }
+	/// tell whether we are in a MathClass inset
+	void inMathClass(bool mathclass) { mathclass_ = mathclass; };
+	/// tell whether we are in a MathClass inset
+	bool inMathClass() const { return mathclass_; }
+	/// 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_;
+	bool fragile_ = false;
 	/// are we at the beginning of an MathData?
-	bool firstitem_;
+	bool firstitem_ = false;
 	/// are we writing to .tex?
-	int latex_;
-	/// is it for preview?
-	bool dryrun_;
+	int latex_ = false;
+	/// output type (default, source preview, instant preview)?
+	OutputType output_ = wsDefault;
 	/// do we have a space pending?
-	bool pendingspace_;
-	///
-	int line_;
+	bool pendingspace_ = false;
+	/// do we have to write braces when a space is pending and [ follows?
+	bool usebraces_ = false;
+	/// do we have a brace pending?
+	bool pendingbrace_ = false;
+	/// are we in text mode when producing latex code?
+	bool textmode_ = false;
+	/// are we allowed to switch mode when producing latex code?
+	bool locked_ = false;
+	/// should we use only ascii chars when producing latex code?
+	bool ascii_ = false;
+	/// are we allowed to output an immediately following newline?
+	bool canbreakline_ = true;
+	/// should we take care for striking out display math?
+	bool mathsout_ = false;
+	/// what ulem command are we inside (none, underline, strikeout)?
+	UlemCmdType ulemcmd_ = NONE;
+	///
+	int line_ = 0;
+	///
+	Encoding const * encoding_ = nullptr;
+	/// Row entry we are in
+	TexRow::RowEntry row_entry_ = TexRow::row_none;
+	/// whether we are in a MathClass inset
+	bool mathclass_ = false;
 };
 
 ///
-WriteStream & operator<<(WriteStream &, MathAtom const &);
+TeXMathStream & operator<<(TeXMathStream &, MathAtom const &);
 ///
-WriteStream & operator<<(WriteStream &, MathData const &);
+TeXMathStream & operator<<(TeXMathStream &, MathData const &);
 ///
-WriteStream & operator<<(WriteStream &, docstring const &);
+TeXMathStream & operator<<(TeXMathStream &, docstring const &);
 ///
-WriteStream & operator<<(WriteStream &, char const * const);
+TeXMathStream & operator<<(TeXMathStream &, char const * const);
 ///
-WriteStream & operator<<(WriteStream &, char);
+TeXMathStream & operator<<(TeXMathStream &, char);
 ///
-WriteStream & operator<<(WriteStream &, int);
+TeXMathStream & operator<<(TeXMathStream &, int);
 ///
-WriteStream & operator<<(WriteStream &, unsigned int);
+TeXMathStream & operator<<(TeXMathStream &, unsigned int);
+
+/// ensure correct mode, possibly by opening \ensuremath or \lyxmathsym
+bool ensureMath(TeXMathStream & os, bool needs_mathmode = true,
+                bool macro = false, bool textmode_macro = false);
+
+/// ensure the requested mode, possibly by closing \ensuremath or \lyxmathsym
+int ensureMode(TeXMathStream & os, InsetMath::mode_type mode, bool locked, bool ascii);
+
+
+/**
+ * MathEnsurer - utility class for ensuring math 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:
+ *
+ *      MathEnsurer ensurer(os);
+ *
+ * If not already in math mode, inserts an \ensuremath command followed
+ * by an open brace. This brace will be automatically closed when exiting
+ * math mode. Math mode is automatically exited when writing something
+ * that doesn't explicitly require math mode.
+ *
+ * Example 2:
+ *
+ *      MathEnsurer ensurer(os, false);
+ *
+ * Simply suspend writing a closing brace until the end of ensurer's scope.
+ *
+ * Example 3:
+ *
+ *      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.
+ *
+ * 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(TeXMathStream & 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:
+	///
+	TeXMathStream & os_;
+	///
+	bool brace_;
+};
+
+
+/**
+ * ModeSpecifier - utility class for specifying a given mode (math or text)
+ *
+ * A local variable of this type can be used to specify that a command or
+ * 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 1:
+ *
+ *      ModeSpecifier specifier(os, 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.
+ */
+class ModeSpecifier
+{
+public:
+	///
+	explicit ModeSpecifier(TeXMathStream & os, InsetMath::mode_type mode,
+	                       bool locked = false, bool ascii = false)
+		: os_(os), oldmodes_(ensureMode(os, mode, locked, ascii)) {}
+	///
+	~ModeSpecifier()
+	{
+		os_.textMode(oldmodes_ & 0x01);
+		os_.lockedMode(oldmodes_ & 0x02);
+		os_.asciiOnly(oldmodes_ & 0x04);
+	}
+private:
+	///
+	TeXMathStream & os_;
+	///
+	int oldmodes_;
+};
 
 
 
@@ -92,26 +303,54 @@ WriteStream & operator<<(WriteStream &, unsigned int);
 //  MathML
 //
 
+
+/// Start tag.
 class MTag {
 public:
 	///
-	MTag(char const * const tag) : tag_(tag) {}
+	MTag(char const * const tag, std::string const & attr = std::string())
+		: tag_(tag), attr_(attr) {}
 	///
 	char const * const tag_;
+	///
+	std::string attr_;
 };
 
+
+/// End tag.
 class ETag {
 public:
 	///
-	ETag(char const * const tag) : tag_(tag) {}
+	explicit ETag(char const * const tag) : tag_(tag) {}
 	///
 	char const * const tag_;
 };
 
-class MathStream {
+
+/// Compound tag (no content, directly closed).
+class CTag {
 public:
 	///
-	explicit MathStream(odocstream & os);
+	CTag(char const * const tag, std::string const & attr = "")
+            : tag_(tag), attr_(attr) {}
+	///
+	char const * const tag_;
+    ///
+    std::string attr_;
+};
+
+
+/// 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 MathMLStream {
+public:
+	/// Builds a stream proxy for os; the MathML namespace is given by xmlns (supposed to be already defined elsewhere in the document).
+	explicit MathMLStream(odocstream & os, std::string const & xmlns = "", bool xmlMode = false);
 	///
 	void cr();
 	///
@@ -121,8 +360,104 @@ public:
 	///
 	int & tab() { return tab_; }
 	///
-	friend MathStream & operator<<(MathStream &, char const *);
+	friend MathMLStream & operator<<(MathMLStream &, char const *);
+	///
+	void defer(docstring const &);
+	///
+	void defer(std::string const &);
+	///
+	docstring deferred() const;
+	///
+	bool inText() const { return in_text_; }
+	///
+	std::string xmlns() const { return xmlns_; }
+	///
+	bool xmlMode() const { return xml_mode_; }
+	/// Returns the tag name prefixed by the name space if needed.
+	std::string namespacedTag(std::string const & tag) const {
+		return (xmlns().empty() ? "" : xmlns() + ":") + tag;
+	}
+private:
+	///
+	void setTextMode(bool t) { in_text_ = t; }
+	///
+	odocstream & os_;
+	///
+	int tab_;
+	///
+	int line_;
+	///
+	bool in_text_;
+	///
+	odocstringstream deferred_;
+	///
+	std::string xmlns_;
+	///
+	bool xml_mode_;
+	///
+	friend class SetMode;
+};
+
+///
+MathMLStream & operator<<(MathMLStream &, MathAtom const &);
+///
+MathMLStream & operator<<(MathMLStream &, MathData const &);
+///
+MathMLStream & operator<<(MathMLStream &, docstring const &);
+///
+MathMLStream & operator<<(MathMLStream &, char const *);
+///
+MathMLStream & operator<<(MathMLStream &, char);
+///
+MathMLStream & operator<<(MathMLStream &, char_type);
+///
+MathMLStream & operator<<(MathMLStream &, MTag const &);
+///
+MathMLStream & operator<<(MathMLStream &, ETag const &);
+///
+MathMLStream & operator<<(MathMLStream &, CTag const &);
+
+
+/// A simpler version of ModeSpecifier, for MathML
+class SetMode {
+public:
+	///
+	explicit SetMode(MathMLStream & ms, bool text);
+	///
+	~SetMode();
 private:
+	///
+	MathMLStream & ms_;
+	///
+	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_;
 	///
@@ -130,25 +465,44 @@ private:
 	///
 	int line_;
 	///
-	char lastchar_;
+	bool in_text_;
+	///
+	odocstringstream deferred_;
+	///
+	friend class SetHTMLMode;
 };
 
 ///
-MathStream & operator<<(MathStream &, MathAtom const &);
+HtmlStream & operator<<(HtmlStream &, MathAtom const &);
+///
+HtmlStream & operator<<(HtmlStream &, MathData const &);
 ///
-MathStream & operator<<(MathStream &, MathData const &);
+HtmlStream & operator<<(HtmlStream &, docstring const &);
 ///
-MathStream & operator<<(MathStream &, docstring const &);
+HtmlStream & operator<<(HtmlStream &, char const *);
 ///
-MathStream & operator<<(MathStream &, char const *);
+HtmlStream & operator<<(HtmlStream &, char);
 ///
-MathStream & operator<<(MathStream &, char);
+HtmlStream & operator<<(HtmlStream &, char_type);
 ///
-MathStream & operator<<(MathStream &, MTag const &);
+HtmlStream & operator<<(HtmlStream &, MTag const &);
 ///
-MathStream & operator<<(MathStream &, ETag const &);
+HtmlStream & operator<<(HtmlStream &, ETag const &);
 
 
+class SetHTMLMode {
+public:
+	///
+	explicit SetHTMLMode(HtmlStream & os, bool text);
+	///
+	~SetHTMLMode();
+private:
+	///
+	HtmlStream & os_;
+	///
+	bool was_text_;
+};
+
 
 //
 // Debugging
@@ -307,6 +661,9 @@ OctaveStream & operator<<(OctaveStream &, char);
 ///
 OctaveStream & operator<<(OctaveStream &, int);
 
+
+docstring convertDelimToXMLEscape(docstring const & name, bool xmlmode);
+
 } // namespace lyx
 
 #endif