]> git.lyx.org Git - lyx.git/blobdiff - src/mathed/InsetMathHull.cpp
We only support gcc >= 4.9.
[lyx.git] / src / mathed / InsetMathHull.cpp
index 5dd492cbfb794bc925baf07c855faf8ba750d8f9..a53b33d6bb3c0c232ef685b02b89d01b6df5cceb 100644 (file)
@@ -11,7 +11,6 @@
 #include <config.h>
 
 #include "InsetMathHull.h"
-
 #include "InsetMathChar.h"
 #include "InsetMathColor.h"
 #include "InsetMathFrac.h"
@@ -26,6 +25,7 @@
 #include "BufferParams.h"
 #include "BufferView.h"
 #include "ColorSet.h"
+#include "Cursor.h"
 #include "CutAndPaste.h"
 #include "Encoding.h"
 #include "Exporter.h"
@@ -38,7 +38,6 @@
 #include "InsetMathMacro.h"
 #include "InsetMathMacroTemplate.h"
 #include "MetricsInfo.h"
-#include "xml.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"
@@ -64,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>
 
@@ -121,76 +120,34 @@ 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";
        }
 
-
 } // 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)
@@ -227,8 +184,8 @@ InsetMathHull::InsetMathHull(InsetMathHull const & other) : InsetMathGrid(other)
 
 InsetMathHull::~InsetMathHull()
 {
-       for (size_t i = 0; i < label_.size(); ++i)
-               delete label_[i];
+       for (auto & i : label_)
+               delete i;
 }
 
 
@@ -247,8 +204,8 @@ InsetMathHull & InsetMathHull::operator=(InsetMathHull const & other)
        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])
@@ -520,9 +477,15 @@ bool previewTooSmall(Dimension const & dim)
 
 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);
@@ -535,8 +498,8 @@ void InsetMathHull::metrics(MetricsInfo & mi, Dimension & dim) const
                        // 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;
@@ -577,8 +540,8 @@ void InsetMathHull::metrics(MetricsInfo & mi, Dimension & dim) const
 
 
        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.
@@ -604,7 +567,7 @@ void InsetMathHull::drawMarkers(PainterInfo & pi, int x, int y) const
        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);
@@ -648,8 +611,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);
@@ -667,7 +630,7 @@ void InsetMathHull::draw(PainterInfo & pi, int x, int y) const
                                ? 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) {
@@ -711,7 +674,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;
@@ -727,7 +690,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());
        }
@@ -746,7 +709,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();
 }
@@ -985,8 +948,8 @@ bool InsetMathHull::ams() const
        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;
 }
@@ -1124,9 +1087,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:
@@ -1145,9 +1108,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;
                }
        }
@@ -1155,7 +1118,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();
 
@@ -1221,7 +1184,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();
 
@@ -1569,7 +1532,7 @@ void InsetMathHull::mutate(HullType newtype)
                        numbered(0, false);
                } else {
                        setType(hullEquation);
-                       numbered(0, label_[0] ? true : false);
+                       numbered(0, label_[0] != nullptr);
                        mutate(newtype);
                }
                break;
@@ -1731,7 +1694,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);
@@ -2337,7 +2300,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());
@@ -2381,7 +2344,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)
@@ -2404,42 +2367,66 @@ 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;
        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");
+       }
 
        // DocBook also has <equation>, but it comes with a title.
+       // 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;
                }
        }
 
+       if (doCR)
+               if (!xs.isLastTagCR())
+                       xs << xml::CR();
+
        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") << ">";
@@ -2451,7 +2438,7 @@ void InsetMathHull::docbook(XMLStream & xs, OutputParams const & runparams) cons
        try {
                // First, generate the MathML expression.
                odocstringstream ostmp;
-               MathStream mstmp(ostmp, ms.xmlns(), ms.xmlMode());
+               MathMLStream mstmp(ostmp, ms.xmlns(), ms.xmlMode());
                InsetMathGrid::mathmlize(mstmp);
 
                // Then, output it (but only if the generation can be done without errors!).
@@ -2460,12 +2447,17 @@ void InsetMathHull::docbook(XMLStream & xs, OutputParams const & runparams) cons
                osmath << ostmp.str(); // osmath is not a XMLStream, so no need for XMLStream::ESCAPE_NONE.
                ms << ETag("math");
        } catch (MathExportException const &) {
-               osmath << "MathML export failed. Please report this as a bug.";
+               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();
 }
 
 
@@ -2525,7 +2517,7 @@ 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;
@@ -2561,7 +2553,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();
@@ -2612,7 +2604,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;
@@ -2682,9 +2674,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;
                }
        }
@@ -2697,7 +2689,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();