]> git.lyx.org Git - lyx.git/blobdiff - src/mathed/InsetMathHull.cpp
typo
[lyx.git] / src / mathed / InsetMathHull.cpp
index 43f49584afcc236866c5540356343576420b3085..97d95da03b3876372634d41e2f5113ef15e79b09 100644 (file)
@@ -11,7 +11,6 @@
 #include <config.h>
 
 #include "InsetMathHull.h"
-
 #include "InsetMathChar.h"
 #include "InsetMathColor.h"
 #include "InsetMathFrac.h"
@@ -51,7 +50,6 @@
 #include "insets/InsetRef.h"
 #include "insets/RenderPreview.h"
 
-#include "graphics/GraphicsImage.h"
 #include "graphics/PreviewImage.h"
 #include "graphics/PreviewLoader.h"
 
@@ -65,7 +63,7 @@
 #include "support/filetools.h"
 #include "support/lassert.h"
 #include "support/lstrings.h"
-#include "support/RefChanger.h"
+#include "support/Changer.h"
 
 #include <sstream>
 
@@ -122,28 +120,28 @@ namespace {
 
 
        // 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";
        }
 
@@ -481,12 +479,9 @@ void InsetMathHull::metrics(MetricsInfo & mi, Dimension & dim) const
 {
        /* Compute \(above|below)displayskip
           true value in LaTeX is 10pt plus 2pt minus 5pt (in normal size at 10pt)
-          FIXME: make this dependent of current size? (minor improvement)
-          FIXME: if would be nice if this was not part of the inset, but
-                 just increased the row ascent/descent.
-          FIXME: even better would be to handle the short skip case.
+          But we use a fixed number of pixels and scale them with zoom.
        */
-       int const bottom_display_margin = mi.base.inPixels(Length(10, Length::PT));
+       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)
@@ -594,13 +589,9 @@ void InsetMathHull::drawBackground(PainterInfo & pi, int x, int y) const
                    dim.wid, dim.asc + dim.des, backgroundColor(pi));
                return;
        }
-       // If there are numbers, the margins around the (displayed)
-       // equation have to be cleared.
-       if (numberedType())
-               pi.pain.fillRectangle(pi.leftx, y - dim.asc,
-                               pi.rightx - pi.leftx, dim.height(), pi.background_color);
+
        pi.pain.fillRectangle(x + 1, y - dim.asc + 1, dim.wid - 2,
-                       dim.asc + dim.des - 1, pi.backgroundColor(this));
+                             dim.height() - 1, pi.backgroundColor(this));
 }
 
 
@@ -616,8 +607,8 @@ void InsetMathHull::draw(PainterInfo & pi, int x, int y) const
        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);
@@ -631,11 +622,6 @@ void InsetMathHull::draw(PainterInfo & pi, int x, int y) const
        }
 
        // First draw the numbers
-       ColorCode color = pi.selected && lyxrc.use_system_colors
-                               ? 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();
        if (numberedType()) {
                BufferParams::MathNumber const math_number = buffer().params().getMathNumber();
                for (row_type row = 0; row < nrows(); ++row) {
@@ -644,18 +630,37 @@ void InsetMathHull::draw(PainterInfo & pi, int x, int y) const
                        Dimension dimnl;
                        mathed_string_dim(pi.base.font, nl, dimnl);
                        if (math_number == BufferParams::LEFT) {
+                               ColorCode const col = pi.selected_left
+                                       ? Color_selectiontext
+                                       : pi.base.font.color();
+                               Changer dummy0 = pi.base.font.changeColor(col);
                                if (dimnl.wid > x - pi.leftx)
                                        yy += rowinfo(row).descent + dimnl.asc;
+                               pi.pain.fillRectangle(pi.leftx, yy - dimnl.asc,
+                                       dimnl.width(), dimnl.height(),
+                                       pi.selected_left ? Color_selection : pi.background_color);
                                pi.draw(pi.leftx, yy, nl);
                        } else {
+                               ColorCode const col = pi.selected_right
+                                       ? Color_selectiontext
+                                       : pi.base.font.color();
+                               Changer dummy0 = pi.base.font.changeColor(col);
                                if (dimnl.wid > pi.rightx - x - dim.wid)
                                        yy += rowinfo(row).descent + dimnl.asc;
+                               pi.pain.fillRectangle(pi.rightx - dimnl.wid, yy - dimnl.asc,
+                                       dimnl.width(), dimnl.height(),
+                                       pi.selected_right ? Color_selection : pi.background_color);
                                pi.draw(pi.rightx - dimnl.wid, yy, nl);
                        }
                }
        }
 
        // Then the equations
+       ColorCode color = pi.selected && lyxrc.use_system_colors
+               ? Color_selectiontext : standardColor();
+       bool const really_change_color = pi.base.font.color() == Color_none;
+       Changer dummy0 = really_change_color ? pi.base.font.changeColor(color)
+               : noChange();
        Changer dummy1 = pi.base.changeFontSet(standardFont());
        Changer dummy2 = pi.base.font.changeStyle(display() ? DISPLAY_STYLE
                                                            : TEXT_STYLE);
@@ -679,7 +684,7 @@ void InsetMathHull::metricsT(TextMetricsInfo const & mi, Dimension & dim) const
        } 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;
@@ -695,7 +700,7 @@ void InsetMathHull::drawT(TextPainter & pain, int x, int y) const
        } 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());
        }
@@ -714,7 +719,7 @@ static docstring latexString(InsetMathHull const & inset)
        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();
 }
@@ -1092,9 +1097,9 @@ void InsetMathHull::validate(LaTeXFeatures & features) const
 }
 
 
-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:
@@ -1113,9 +1118,9 @@ OutputParams::CtObject InsetMathHull::CtObject(OutputParams const & runparams) c
        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;
                }
        }
@@ -1123,7 +1128,7 @@ OutputParams::CtObject InsetMathHull::CtObject(OutputParams const & runparams) c
 }
 
 
-void InsetMathHull::header_write(WriteStream & os) const
+void InsetMathHull::header_write(TeXMathStream & os) const
 {
        bool n = numberedType();
 
@@ -1189,7 +1194,7 @@ void InsetMathHull::header_write(WriteStream & os) const
 }
 
 
-void InsetMathHull::footer_write(WriteStream & os) const
+void InsetMathHull::footer_write(TeXMathStream & os) const
 {
        bool n = numberedType();
 
@@ -1699,7 +1704,7 @@ docstring InsetMathHull::eolString(row_type row, bool fragile, bool latex,
        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);
@@ -2305,7 +2310,7 @@ void InsetMathHull::write(ostream & os) const
 {
        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());
@@ -2349,7 +2354,7 @@ int InsetMathHull::plaintext(odocstringstream & os,
        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)
@@ -2372,8 +2377,7 @@ int InsetMathHull::plaintext(odocstringstream & os,
 }
 
 
-void InsetMathHull::docbook(XMLStream & xs, OutputParams const & runparams) const
-{
+void InsetMathHull::docbook(XMLStream & xs, OutputParams const & runparams) const {
        // Choose the tag around the MathML equation.
        docstring name;
        bool doCR = false;
@@ -2388,9 +2392,17 @@ void InsetMathHull::docbook(XMLStream & xs, OutputParams const & runparams) cons
        // TODO: recognise \tag from amsmath? This would allow having <equation> with a proper title.
 
        docstring attr;
+
+       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()) {
-                       attr = "xml:id=\"" + xml::cleanID(label(i)) + "\"";
+                       if (!attr.empty())
+                               attr += " ";
+
+                       attr += "xml:id=\"" + xml::cleanID(label(i)) + "\"";
                        break;
                }
        }
@@ -2402,21 +2414,29 @@ void InsetMathHull::docbook(XMLStream & xs, OutputParams const & runparams) cons
        xs << xml::StartTag(name, attr);
        xs << xml::CR();
 
-       // With DocBook 5, MathML must be within its own namespace; defined in Buffer.cpp::writeDocBookSource as "m".
+       // 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";
+       }
+
        odocstringstream osmath;
-       MathStream ms(osmath, "m", true);
+       MathMLStream ms(osmath, mathmlNamespacePrefix, true);
 
        // Output the MathML subtree.
-       odocstringstream ls;
-       otexstream ols(ls);
-
        // 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
-       WriteStream wi(ols, false, false, WriteStream::wsDefault, runparams.encoding);
+       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()), "&", "&amp;"), "<", "&lt;"));
        ms << "</" << from_ascii("alt") << ">";
@@ -2426,19 +2446,28 @@ void InsetMathHull::docbook(XMLStream & xs, OutputParams const & runparams) cons
        // 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.
+               // 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;
-               MathStream mstmp(ostmp, ms.xmlns(), ms.xmlMode());
-               InsetMathGrid::mathmlize(mstmp);
+               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 it (but only if the generation can be done without errors!).
-               ms << MTag("math");
+               // 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.</mathphrase>";
+               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.
@@ -2506,13 +2535,20 @@ void InsetMathHull::htmlize(HtmlStream & os) const
 // 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.
@@ -2531,7 +2567,7 @@ void InsetMathHull::mathmlize(MathStream & ms) const
                        ms << MTag("mtd");
                        docstring const & num = numbers_[row];
                        if (!num.empty())
-                               ms << '(' << num << ')';
+                               ms << MTagInline("mtext") << '(' << num << ')' << ETagInline("mtext");
                  ms << ETag("mtd");
                }
                if (havetable)
@@ -2542,7 +2578,7 @@ void InsetMathHull::mathmlize(MathStream & ms) const
 }
 
 
-void InsetMathHull::mathAsLatex(WriteStream & os) const
+void InsetMathHull::mathAsLatex(TeXMathStream & os) const
 {
        MathEnsurer ensurer(os, false);
        bool havenumbers = haveNumbers();
@@ -2593,7 +2629,7 @@ docstring InsetMathHull::xhtml(XMLStream & xs, OutputParams const & op) const
        // 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;
@@ -2663,9 +2699,9 @@ docstring InsetMathHull::xhtml(XMLStream & xs, OutputParams const & op) const
                        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;
                }
        }
@@ -2678,7 +2714,7 @@ docstring InsetMathHull::xhtml(XMLStream & xs, OutputParams const & op) const
                // $...$ 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();