#include <config.h>
#include "InsetMathHull.h"
-
#include "InsetMathChar.h"
#include "InsetMathColor.h"
#include "InsetMathFrac.h"
#include "BufferParams.h"
#include "BufferView.h"
#include "ColorSet.h"
+#include "Cursor.h"
#include "CutAndPaste.h"
#include "Encoding.h"
#include "Exporter.h"
#include "InsetMathMacro.h"
#include "InsetMathMacroTemplate.h"
#include "MetricsInfo.h"
-#include "output_xhtml.h"
#include "Paragraph.h"
#include "ParIterator.h"
#include "xml.h"
#include "insets/InsetRef.h"
#include "insets/RenderPreview.h"
-#include "graphics/GraphicsImage.h"
#include "graphics/PreviewImage.h"
#include "graphics/PreviewLoader.h"
#include "frontends/alert.h"
+#include "frontends/FontMetrics.h"
#include "frontends/Painter.h"
#include "support/convert.h"
#include "support/filetools.h"
#include "support/lassert.h"
#include "support/lstrings.h"
-#include "support/RefChanger.h"
+#include "support/Changer.h"
#include <sstream>
// writes a preamble for underlined or struck out math display
- void writeMathdisplayPreamble(WriteStream & os)
+ void writeMathdisplayPreamble(TeXMathStream & os)
{
if (os.strikeoutMath())
return;
- if (os.ulemCmd() == WriteStream::UNDERLINE)
+ if (os.ulemCmd() == TeXMathStream::UNDERLINE)
os << "\\raisebox{-\\belowdisplayshortskip}{"
"\\parbox[b]{\\linewidth}{";
- else if (os.ulemCmd() == WriteStream::STRIKEOUT)
+ else if (os.ulemCmd() == TeXMathStream::STRIKEOUT)
os << "\\parbox{\\linewidth}{";
}
// writes a postamble for underlined or struck out math display
- void writeMathdisplayPostamble(WriteStream & os)
+ void writeMathdisplayPostamble(TeXMathStream & os)
{
if (os.strikeoutMath())
return;
- if (os.ulemCmd() == WriteStream::UNDERLINE)
+ if (os.ulemCmd() == TeXMathStream::UNDERLINE)
os << "}}\\\\\n";
- else if (os.ulemCmd() == WriteStream::STRIKEOUT)
+ else if (os.ulemCmd() == TeXMathStream::STRIKEOUT)
os << "}\\\\\n";
}
-
} // namespace
-HullType hullType(docstring const & s)
-{
- if (s == "none") return hullNone;
- if (s == "simple") return hullSimple;
- if (s == "equation") return hullEquation;
- if (s == "eqnarray") return hullEqnArray;
- if (s == "align") return hullAlign;
- if (s == "alignat") return hullAlignAt;
- if (s == "xalignat") return hullXAlignAt;
- if (s == "xxalignat") return hullXXAlignAt;
- if (s == "multline") return hullMultline;
- if (s == "gather") return hullGather;
- if (s == "flalign") return hullFlAlign;
- if (s == "regexp") return hullRegexp;
- lyxerr << "unknown hull type '" << to_utf8(s) << "'" << endl;
- return hullUnknown;
-}
-
-
-docstring hullName(HullType type)
-{
- switch (type) {
- case hullNone: return from_ascii("none");
- case hullSimple: return from_ascii("simple");
- case hullEquation: return from_ascii("equation");
- case hullEqnArray: return from_ascii("eqnarray");
- case hullAlign: return from_ascii("align");
- case hullAlignAt: return from_ascii("alignat");
- case hullXAlignAt: return from_ascii("xalignat");
- case hullXXAlignAt: return from_ascii("xxalignat");
- case hullMultline: return from_ascii("multline");
- case hullGather: return from_ascii("gather");
- case hullFlAlign: return from_ascii("flalign");
- case hullRegexp: return from_ascii("regexp");
- case hullUnknown:
- lyxerr << "unknown hull type" << endl;
- break;
- }
- return from_ascii("none");
-}
-
static InsetLabel * dummy_pointer = 0;
InsetMathHull::InsetMathHull(Buffer * buf)
InsetMathHull::~InsetMathHull()
{
- for (size_t i = 0; i < label_.size(); ++i)
- delete label_[i];
+ for (auto & i : label_)
+ delete i;
}
numbered_ = other.numbered_;
numbers_ = other.numbers_;
buffer_ = other.buffer_;
- for (size_t i = 0; i < label_.size(); ++i)
- delete label_[i];
+ for (auto & i : label_)
+ delete i;
label_ = other.label_;
for (size_t i = 0; i != label_.size(); ++i) {
if (label_[i])
void InsetMathHull::metrics(MetricsInfo & mi, Dimension & dim) const
{
- // true value in LaTeX is 12pt plus 3pt minus 9pt
- // FIXME: even better would be to handle the short skip case.
- int const display_margin = display() ? mi.base.inPixels(Length(12, Length::PT)) : 0;
+ /* Compute \(above|below)displayskip
+ true value in LaTeX is 10pt plus 2pt minus 5pt (in normal size at 10pt)
+ But we use a fixed number of pixels and scale them with zoom.
+ */
+ int const bottom_display_margin = mi.base.bv->zoomedPixels(6);
+ int top_display_margin = bottom_display_margin;
+ // at start of paragraph, add an empty line
+ if (mi.vmode)
+ top_display_margin += theFontMetrics(mi.base.font).maxHeight() + 2;
if (previewState(mi.base.bv)) {
preview_->metrics(mi, dim);
// value was hardcoded to 1 pixel
dim.wid += mi.base.bv->zoomedPixels(1) ;
if (display()) {
- dim.asc += display_margin;
- dim.des += display_margin;
+ dim.asc += top_display_margin;
+ dim.des += bottom_display_margin;
}
}
return;
if (display()) {
- dim.asc += display_margin;
- dim.des += display_margin;
+ dim.asc += top_display_margin;
+ dim.des += bottom_display_margin;
}
// reserve some space for marker.
ColorCode pen_color = mouseHovered(pi.base.bv) || editing(pi.base.bv)?
Color_mathframe : Color_mathcorners;
// If the corners have the same color as the background, do not paint them.
- if (lcolor.getX11Name(Color_mathbg) == lcolor.getX11Name(pen_color))
+ if (lcolor.getX11HexName(Color_mathbg) == lcolor.getX11HexName(pen_color))
return;
Inset::drawMarkers(pi, x, y);
if (previewState(bv)) {
// Do not draw change tracking cue if taken care of by RowPainter
// already.
- Changer dummy = !canPaintChange(*bv) ? make_change(pi.change, Change())
- : Changer();
+ Changer dummy = !canPaintChange(*bv) ? changeVar(pi.change, Change())
+ : noChange();
if (previewTooSmall(dim)) {
// we have an extra frame
preview_->draw(pi, x + ERROR_FRAME_WIDTH, y);
? Color_selectiontext : standardColor();
bool const really_change_color = pi.base.font.color() == Color_none;
Changer dummy0 = really_change_color ? pi.base.font.changeColor(color)
- : Changer();
+ : noChange();
if (numberedType()) {
BufferParams::MathNumber const math_number = buffer().params().getMathNumber();
for (row_type row = 0; row < nrows(); ++row) {
} else {
odocstringstream os;
otexrowstream ots(os);
- WriteStream wi(ots, false, true, WriteStream::wsDefault);
+ TeXMathStream wi(ots, false, true, TeXMathStream::wsDefault);
write(wi);
dim.wid = os.str().size();
dim.asc = 1;
} else {
odocstringstream os;
otexrowstream ots(os);
- WriteStream wi(ots, false, true, WriteStream::wsDefault);
+ TeXMathStream wi(ots, false, true, TeXMathStream::wsDefault);
write(wi);
pain.draw(x, y, os.str().c_str());
}
if (inset.isBufferValid())
encoding = &(inset.buffer().params().encoding());
otexrowstream ots(ls);
- WriteStream wi(ots, false, true, WriteStream::wsPreview, encoding);
+ TeXMathStream wi(ots, false, true, TeXMathStream::wsPreview, encoding);
inset.write(wi);
return ls.str();
}
case hullEqnArray:
break;
}
- for (size_t row = 0; row < numbered_.size(); ++row)
- if (numbered_[row] == NOTAG)
+ for (auto const & row : numbered_)
+ if (row == NOTAG)
return true;
return false;
}
}
-Inset::DisplayType InsetMathHull::display() const
+Inset::RowFlags InsetMathHull::rowFlags() const
{
switch (type_) {
case hullUnknown:
case hullMultline:
case hullGather:
if (buffer().params().is_math_indent)
- return AlignLeft;
+ return Display | AlignLeft;
else
- return AlignCenter;
+ return Display;
}
// avoid warning
- return AlignCenter;
+ return Display;
}
{
// FIXME: set this in the textclass. This value is what the article class uses.
static Length default_indent(2.5, Length::EM);
- if (display() != Inline && buffer().params().is_math_indent) {
+ if (display() && buffer().params().is_math_indent) {
Length const & len = buffer().params().getMathIndent();
if (len.empty())
return bv.inPixels(default_indent);
}
-OutputParams::CtObject InsetMathHull::CtObject(OutputParams const & runparams) const
+CtObject InsetMathHull::getCtObject(OutputParams const & runparams) const
{
- OutputParams::CtObject res = OutputParams::CT_NORMAL;
+ CtObject res = CtObject::Normal;
switch(type_) {
case hullNone:
case hullSimple:
case hullMultline: {
if (runparams.inulemcmd
&& (!runparams.local_font || runparams.local_font->fontInfo().strikeout() != FONT_ON))
- res = OutputParams::CT_UDISPLAYOBJECT;
+ res = CtObject::UDisplayObject;
else
- res = OutputParams::CT_DISPLAYOBJECT;
+ res = CtObject::DisplayObject;
break;
}
}
}
-void InsetMathHull::header_write(WriteStream & os) const
+void InsetMathHull::header_write(TeXMathStream & os) const
{
bool n = numberedType();
}
-void InsetMathHull::footer_write(WriteStream & os) const
+void InsetMathHull::footer_write(TeXMathStream & os) const
{
bool n = numberedType();
numbered(0, false);
} else {
setType(hullEquation);
- numbered(0, label_[0] ? true : false);
+ numbered(0, label_[0] != nullptr);
mutate(newtype);
}
break;
return res + InsetMathGrid::eolString(row, fragile, latex, last_eoln);
}
-void InsetMathHull::write(WriteStream & os) const
+void InsetMathHull::write(TeXMathStream & os) const
{
ModeSpecifier specifier(os, MATH_MODE);
header_write(os);
return true;
}
case LFUN_MATH_DISPLAY: {
- status.setEnabled(display() != Inline || allowDisplayMath(cur));
- status.setOnOff(display() != Inline);
+ status.setEnabled(display() || allowDisplayMath(cur));
+ status.setOnOff(display());
return true;
}
case LFUN_MATH_NUMBER_TOGGLE:
// FIXME: what is the right test, this or the one of
// LABEL_INSERT?
- status.setEnabled(display() != Inline);
+ status.setEnabled(display());
status.setOnOff(numberedType());
return true;
// LABEL_INSERT?
bool const enable = (type_ == hullMultline)
? (nrows() - 1 == cur.row())
- : display() != Inline;
+ : display();
row_type const r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
status.setEnabled(enable);
status.setOnOff(enable && numbered(r));
{
odocstringstream oss;
otexrowstream ots(oss);
- WriteStream wi(ots, false, false, WriteStream::wsDefault);
+ TeXMathStream wi(ots, false, false, TeXMathStream::wsDefault);
oss << "Formula ";
write(wi);
os << to_utf8(oss.str());
odocstringstream oss;
otexrowstream ots(oss);
Encoding const * const enc = encodings.fromLyXName("utf8");
- WriteStream wi(ots, false, true, WriteStream::wsDefault, enc);
+ TeXMathStream wi(ots, false, true, TeXMathStream::wsDefault, enc);
// Fix Bug #6139
if (type_ == hullRegexp)
}
-int InsetMathHull::docbook(odocstream & os, OutputParams const & runparams) const
-{
- MathStream ms(os);
- int res = 0;
+void InsetMathHull::docbook(XMLStream & xs, OutputParams const & runparams) const {
+ // Choose the tag around the MathML equation.
docstring name;
+ bool doCR = false;
if (getType() == hullSimple)
name = from_ascii("inlineequation");
- else
+ else {
+ doCR = true; // This is a block equation, always have <informalequation> on its own line.
name = from_ascii("informalequation");
+ }
- docstring bname = name;
- if (!label(0).empty())
- bname += " id='" + xml::cleanID(label(0)) + "'";
+ // DocBook also has <equation>, but it comes with a title.
+ // TODO: recognise \tag from amsmath? This would allow having <equation> with a proper title.
- ++ms.tab(); ms.cr(); ms.os() << '<' << bname << '>';
+ docstring attr;
- odocstringstream ls;
- otexstream ols(ls);
- if (runparams.flavor == OutputParams::XML) {
- ms << MTag("alt role='tex' ");
- // Workaround for db2latex: db2latex always includes equations with
- // \ensuremath{} or \begin{display}\end{display}
- // so we strip LyX' math environment
- WriteStream wi(ols, false, false, WriteStream::wsDefault, runparams.encoding);
- InsetMathGrid::write(wi);
- ms << from_utf8(subst(subst(to_utf8(ls.str()), "&", "&"), "<", "<"));
- ms << ETag("alt");
- ms << MTag("math");
- ms << ETag("alt");
- ms << MTag("math");
- InsetMathGrid::mathmlize(ms);
- ms << ETag("math");
- } else {
- ms << MTag("alt role='tex'");
- latex(ols, runparams);
- res = ols.texrow().rows();
- ms << from_utf8(subst(subst(to_utf8(ls.str()), "&", "&"), "<", "<"));
- ms << ETag("alt");
+ bool mathmlNamespaceInline = buffer().params().docbook_mathml_prefix == BufferParams::NoPrefix;
+ if (mathmlNamespaceInline)
+ attr += "xmlns=\"http://www.w3.org/1998/Math/MathML\"";
+
+ for (row_type i = 0; i < nrows(); ++i) {
+ if (!label(i).empty()) {
+ if (!attr.empty())
+ attr += " ";
+
+ attr += "xml:id=\"" + xml::cleanID(label(i)) + "\"";
+ break;
+ }
}
- ms << from_ascii("<graphic fileref=\"eqn/");
- if (!label(0).empty())
- ms << xml::cleanID(label(0));
- else
- ms << xml::uniqueID(from_ascii("anon"));
+ if (doCR)
+ if (!xs.isLastTagCR())
+ xs << xml::CR();
+
+ xs << xml::StartTag(name, attr);
+ xs << xml::CR();
- if (runparams.flavor == OutputParams::XML)
- ms << from_ascii("\"/>");
- else
- ms << from_ascii("\">");
+ // With DocBook 5, MathML must be within its own namespace (defined in Buffer.cpp::writeDocBookSource, except when
+ // it should be inlined).
+ // Output everything in a separate stream so that this does not interfere with the standard flow of DocBook tags.
+ std::string mathmlNamespacePrefix;
+ if (!mathmlNamespaceInline) {
+ if (buffer().params().docbook_mathml_prefix == BufferParams::MPrefix)
+ mathmlNamespacePrefix = "m";
+ else if (buffer().params().docbook_mathml_prefix == BufferParams::MMLPrefix)
+ mathmlNamespacePrefix = "mml";
+ }
- ms.cr(); --ms.tab(); ms.os() << "</" << name << '>';
+ odocstringstream osmath;
+ MathMLStream ms(osmath, mathmlNamespacePrefix, true);
- return ms.line() + res;
+ // Output the MathML subtree.
+ // TeX transcription. Avoid MTag/ETag so that there are no extraneous spaces.
+ ms << "<" << from_ascii("alt") << " role='tex'" << ">";
+ // Workaround for db2latex: db2latex always includes equations with
+ // \ensuremath{} or \begin{display}\end{display}
+ // so we strip LyX' math environment
+ odocstringstream ls;
+ otexstream ols(ls);
+ TeXMathStream wi(ols, false, false, TeXMathStream::wsDefault, runparams.encoding);
+ InsetMathGrid::write(wi);
+ ms << from_utf8(subst(subst(to_utf8(ls.str()), "&", "&"), "<", "<"));
+ ms << "</" << from_ascii("alt") << ">";
+
+ // Actual transformation of the formula into MathML. This translation may fail (for example, due to custom macros).
+ // The new output stream is required to deal with the errors: first write completely the formula into this
+ // temporary stream; then, if it is possible without error, then copy it back to the "real" stream. Otherwise,
+ // some incomplete tags might be put into the real stream.
+ try {
+ // First, generate the MathML expression. If there is an error in the generation, this block is not fully
+ // executed, and the formula is not output to the DocBook stream.
+ odocstringstream ostmp;
+ MathMLStream mstmp(ostmp, ms.xmlns(), ms.xmlMode());
+ mathmlize(mstmp);
+
+ // Choose the display style for the formula, to be output as an attribute near the formula root.
+ std::string mathmlAttr;
+ if (getType() == hullSimple)
+ mathmlAttr = "display=\"inline\"";
+ else
+ mathmlAttr = "display=\"block\"";
+
+ // Then, output the formula.
+ ms << MTag("math", mathmlAttr);
+ ms.cr();
+ osmath << ostmp.str(); // osmath is not a XMLStream, so no need for XMLStream::ESCAPE_NONE.
+ ms << ETag("math");
+ } catch (MathExportException const &) {
+ ms.cr();
+ osmath << "<mathphrase>MathML export failed. Please report this as a bug to the LyX developers: "
+ "https://www.lyx.org/trac.</mathphrase>";
+ }
+
+ // Output the complete formula to the DocBook stream.
+ xs << XMLStream::ESCAPE_NONE << osmath.str();
+ xs << xml::CR();
+ xs << xml::EndTag(name);
+ if (doCR)
+ xs << xml::CR();
}
// this duplicates code from InsetMathGrid, but
// we need access here to number information,
// and we simply do not have that in InsetMathGrid.
-void InsetMathHull::mathmlize(MathStream & ms) const
+void InsetMathHull::mathmlize(MathMLStream & ms) const
{
bool const havenumbers = haveNumbers();
bool const havetable = havenumbers || nrows() > 1 || ncols() > 1;
- if (havetable)
- ms << MTag("mtable");
+ if (havetable) {
+ if (getType() == hullSimple)
+ ms << MTag("mtable");
+ else if (getType() >= hullAlign && getType() <= hullXXAlignAt)
+ ms << MTag("mtable", "displaystyle='true' columnalign='right left'");
+ else
+ ms << MTag("mtable", "displaystyle='true'");
+ }
+
char const * const celltag = havetable ? "mtd" : "mrow";
// FIXME There does not seem to be wide support at the moment
// for mlabeledtr, so we have to use just mtr for now.
ms << MTag("mtd");
docstring const & num = numbers_[row];
if (!num.empty())
- ms << '(' << num << ')';
+ ms << MTagInline("mtext") << '(' << num << ')' << ETagInline("mtext");
ms << ETag("mtd");
}
if (havetable)
}
-void InsetMathHull::mathAsLatex(WriteStream & os) const
+void InsetMathHull::mathAsLatex(TeXMathStream & os) const
{
MathEnsurer ensurer(os, false);
bool havenumbers = haveNumbers();
// FIXME Eventually we would like to do this inset by inset.
if (mathtype == BufferParams::MathML) {
odocstringstream os;
- MathStream ms(os);
+ MathMLStream ms(os);
try {
mathmlize(ms);
success = true;
string const tag = (getType() == hullSimple) ? "span" : "div";
xs << xml::CR()
<< xml::StartTag(tag, "style = \"text-align: center;\"")
- << xml::CompTag("img", "src=\"" + filename + "\" alt=\"Mathematical Equation\"")
- << xml::EndTag(tag)
- << xml::CR();
+ << xml::CompTag("img", "src=\"" + filename + "\" alt=\"Mathematical Equation\"")
+ << xml::EndTag(tag)
+ << xml::CR();
success = true;
}
}
// $...$ or whatever.
odocstringstream ls;
otexrowstream ots(ls);
- WriteStream wi(ots, false, true, WriteStream::wsPreview);
+ TeXMathStream wi(ots, false, true, TeXMathStream::wsPreview);
ModeSpecifier specifier(wi, MATH_MODE);
mathAsLatex(wi);
docstring const latex = ls.str();
bool InsetMathHull::canPaintChange(BufferView const &) const
{
// We let RowPainter do it seamlessly for inline insets
- return display() != Inline;
+ return display();
}