* 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.
*/
#include "support/strfwd.h"
+#include "InsetMath.h"
// FIXME: Move to individual insets
#include "MetricsInfo.h"
namespace lyx {
-class MathData;
+class Encoding;
class InsetMath;
class MathAtom;
+class MathData;
//
// LaTeX/LyX
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);
///
///
bool latex() const { return latex_; }
///
- bool dryrun() const { return dryrun_; }
+ OutputType output() const { return output_; }
///
odocstream & os() { return os_; }
///
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_; }
+ /// LaTeX encoding
+ Encoding const * encoding() const { return encoding_; }
private:
///
odocstream & os_;
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_;
///
int line_;
+ ///
+ Encoding const * encoding_;
};
///
///
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 the requested mode, possibly by closing \ensuremath
+int ensureMode(WriteStream & os, InsetMath::mode_type mode, bool locked);
+
+
+/**
+ * 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.
+ *
+ * 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_math_mode, true);
+ *
+ * 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).
+ */
+class MathEnsurer
+{
+public:
+ ///
+ explicit MathEnsurer(WriteStream & os, bool needs_math_mode = true, bool macro = false)
+ : os_(os), brace_(ensureMath(os, needs_math_mode, macro)) {}
+ ///
+ ~MathEnsurer() { os_.pendingBrace(brace_); }
+private:
+ ///
+ WriteStream & 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.
+ *
+ * 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.
+ *
+ * At the end of specifier's scope the mode is reset to its previous value.
+ */
+class ModeSpecifier
+{
+public:
+ ///
+ explicit ModeSpecifier(WriteStream & os, InsetMath::mode_type mode,
+ bool locked = false)
+ : os_(os), oldmodes_(ensureMode(os, mode, locked)) {}
+ ///
+ ~ModeSpecifier()
+ {
+ os_.textMode(oldmodes_ & 1);
+ os_.lockedMode(oldmodes_ & 2);
+ }
+private:
+ ///
+ WriteStream & os_;
+ ///
+ int oldmodes_;
+};
+
//
char const * const tag_;
};
+
class MathStream {
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() { in_text_ = true; }
+ ///
+ void setMathMode() { in_text_ = false; }
///
odocstream & os_;
///
int line_;
///
char lastchar_;
+ ///
+ bool in_text_;
+ ///
+ odocstringstream deferred_;
+ ///
+ friend class SetMode;
};
///
///
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
+// FIXME There are still problems here with nesting, at least
+// potentially. The problem is that true nesting of text mode isn't
+// actually possible. I.e., we can't have:
+// <mtext><mtext></mtext></mtext>
+// So we have to have:
+// <mtext></mtext><mtext></mtext><mtext></mtext>
+// instead, where the last is really a continuation of the first.
+// We'll need some kind of stack to remember all that.
+class SetMode {
+public:
+ ///
+ explicit SetMode(MathStream & os, bool text, docstring attrs);
+ ///
+ explicit SetMode(MathStream & os, bool text);
+ ///
+ ~SetMode();
+private:
+ ///
+ void init(bool, docstring);
+ ///
+ MathStream & os_;
+ ///
+ bool opened_;
+ ///
+ bool was_text_;
+};
+
//
// Debugging
projects / lyx.git / blobdiff