]> git.lyx.org Git - lyx.git/blobdiff - src/mathed/InsetMathHull.cpp
Assure correct spacing of colored items in mathed
[lyx.git] / src / mathed / InsetMathHull.cpp
index 75e0a41f9ce83490856787b9d4dccb867f782819..d0e11fe2ab1118b9b4401ac8f1eb91f460c1bce9 100644 (file)
 #include "InsetMathMacro.h"
 #include "InsetMathMacroTemplate.h"
 #include "MetricsInfo.h"
-#include "output_xhtml.h"
+#include "xml.h"
 #include "Paragraph.h"
 #include "ParIterator.h"
-#include "sgml.h"
+#include "xml.h"
 #include "TexRow.h"
 #include "TextClass.h"
 #include "TextPainter.h"
@@ -279,7 +279,7 @@ namespace {
 } // namespace
 
 
-void InsetMathHull::updateBuffer(ParIterator const & it, UpdateType utype)
+void InsetMathHull::updateBuffer(ParIterator const & it, UpdateType utype, bool const deleted)
 {
        if (!buffer_) {
                //FIXME: buffer_ should be set at creation for this inset! Problem is
@@ -327,10 +327,10 @@ void InsetMathHull::updateBuffer(ParIterator const & it, UpdateType utype)
        // now the labels
        for (size_t i = 0; i != label_.size(); ++i) {
                if (label_[i])
-                       label_[i]->updateBuffer(it, utype);
+                       label_[i]->updateBuffer(it, utype, deleted);
        }
        // pass down
-       InsetMathGrid::updateBuffer(it, utype);
+       InsetMathGrid::updateBuffer(it, utype, deleted);
 }
 
 
@@ -511,11 +511,9 @@ bool InsetMathHull::previewState(const BufferView *const bv) const
 namespace {
 const int ERROR_FRAME_WIDTH = 2;
 
-bool previewTooSmall(MetricsBase const & mb, Dimension const & dim)
+bool previewTooSmall(Dimension const & dim)
 {
-       // Value was hardcoded to 10 pixels
-       int const minval = mb.bv->zoomedPixels(10);
-       return dim.width() <= minval && dim.height() <= minval;
+       return dim.width() <= 10 && dim.height() <= 10;
 }
 }
 
@@ -528,7 +526,7 @@ void InsetMathHull::metrics(MetricsInfo & mi, Dimension & dim) const
 
        if (previewState(mi.base.bv)) {
                preview_->metrics(mi, dim);
-               if (previewTooSmall(mi.base, dim)) {
+               if (previewTooSmall(dim)) {
                        // preview image is too small
                        dim.wid += 2 * ERROR_FRAME_WIDTH;
                        dim.asc += 2 * ERROR_FRAME_WIDTH;
@@ -593,7 +591,7 @@ ColorCode InsetMathHull::backgroundColor(PainterInfo const & pi) const
        BufferView const * const bv = pi.base.bv;
        if (previewState(bv)) {
                Dimension const dim = dimension(*pi.base.bv);
-               if (previewTooSmall(pi.base, dim))
+               if (previewTooSmall(dim))
                        return Color_error;
                return graphics::PreviewLoader::backgroundColor();
        }
@@ -623,7 +621,7 @@ void InsetMathHull::drawMarkers(PainterInfo & pi, int x, int y) const
 void InsetMathHull::drawBackground(PainterInfo & pi, int x, int y) const
 {
        Dimension const dim = dimension(*pi.base.bv);
-       if (previewTooSmall(pi.base, dim)) {
+       if (previewTooSmall(dim)) {
                pi.pain.fillRectangle(x, y - 2 * ERROR_FRAME_WIDTH,
                    dim.wid, dim.asc + dim.des, backgroundColor(pi));
                return;
@@ -650,9 +648,9 @@ 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 dummy = !canPaintChange(*bv) ? make_change(pi.change, Change())
                        : Changer();
-               if (previewTooSmall(pi.base, dim)) {
+               if (previewTooSmall(dim)) {
                        // we have an extra frame
                        preview_->draw(pi, x + ERROR_FRAME_WIDTH, y);
                } else {
@@ -700,7 +698,7 @@ void InsetMathHull::draw(PainterInfo & pi, int x, int y) const
        if (canPaintChange(*bv)) {
                // like in metrics()
                int const display_margin = display() ? pi.base.inPixels(Length(12, Length::PT)) : 0;
-               pi.change_.paintCue(pi, x + 1, y + 1 - dim.asc + display_margin,
+               pi.change.paintCue(pi, x + 1, y + 1 - dim.asc + display_margin,
                                    x + dim.wid, y + dim.des - display_margin);
        }
 }
@@ -1017,7 +1015,7 @@ bool InsetMathHull::outerDisplay() const
 }
 
 
-Inset::DisplayType InsetMathHull::display() const
+Inset::RowFlags InsetMathHull::rowFlags() const
 {
        switch (type_) {
        case hullUnknown:
@@ -1035,12 +1033,12 @@ Inset::DisplayType InsetMathHull::display() const
        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;
 }
 
 
@@ -1048,7 +1046,7 @@ int InsetMathHull::indent(BufferView const & bv) const
 {
        // 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);
@@ -1101,8 +1099,7 @@ void InsetMathHull::validate(LaTeXFeatures & features) const
                                + bgcol + "}{\\ensuremath{\\mathtt{#1}}}}");
                        features.addPreambleSnippet(
                                from_ascii("\\newcommand{\\endregexp}{}"));
-               } else if (outerDisplay() && features.inDeletedInset()
-                          && !features.mustProvide("ct-dvipost")) {
+               } else if (outerDisplay() && features.inDeletedInset()) {
                                features.require("tikz");
                                features.require("ct-tikz-object-sout");
                }
@@ -2107,15 +2104,15 @@ bool InsetMathHull::getStatus(Cursor & cur, FuncRequest const & cmd,
                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;
 
@@ -2124,7 +2121,7 @@ bool InsetMathHull::getStatus(Cursor & cur, FuncRequest const & cmd,
                // 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));
@@ -2407,60 +2404,70 @@ int InsetMathHull::plaintext(odocstringstream & os,
 }
 
 
-int InsetMathHull::docbook(odocstream & os, OutputParams const & runparams) const
+void InsetMathHull::docbook(XMLStream & xs, OutputParams const & runparams) const
 {
-       MathStream ms(os);
-       int res = 0;
+       // Choose the tag around the MathML equation.
        docstring name;
        if (getType() == hullSimple)
                name = from_ascii("inlineequation");
        else
                name = from_ascii("informalequation");
 
-       docstring bname = name;
-       if (!label(0).empty())
-               bname += " id='" + sgml::cleanID(buffer(), runparams, label(0)) + "'";
+       // DocBook also has <equation>, but it comes with a title.
 
-       ++ms.tab(); ms.cr(); ms.os() << '<' << bname << '>';
+       docstring attr;
+       for (row_type i = 0; i < nrows(); ++i) {
+               if (!label(i).empty()) {
+                       attr = "xml:id=\"" + xml::cleanID(label(i)) + "\"";
+                       break;
+               }
+       }
+
+       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".
+       // Output everything in a separate stream so that this does not interfere with the standard flow of DocBook tags.
+       odocstringstream osmath;
+       MathStream ms(osmath, "m", true);
+
+       // Output the MathML subtree.
        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()), "&", "&amp;"), "<", "&lt;"));
-               ms << ETag("alt");
-               ms << MTag("math");
-               ms << ETag("alt");
+
+       // 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);
+       InsetMathGrid::write(wi);
+       ms << from_utf8(subst(subst(to_utf8(ls.str()), "&", "&amp;"), "<", "&lt;"));
+       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.
+               odocstringstream ostmp;
+               MathStream mstmp(ostmp, ms.xmlns(), ms.xmlMode());
+               InsetMathGrid::mathmlize(mstmp);
+
+               // Then, output it (but only if the generation can be done without errors!).
                ms << MTag("math");
-               InsetMathGrid::mathmlize(ms);
+               ms.cr();
+               osmath << ostmp.str(); // osmath is not a XMLStream, so no need for XMLStream::ESCAPE_NONE.
                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()), "&", "&amp;"), "<", "&lt;"));
-               ms << ETag("alt");
+       } catch (MathExportException const &) {
+               osmath << "MathML export failed. Please report this as a bug.";
        }
 
-       ms << from_ascii("<graphic fileref=\"eqn/");
-       if (!label(0).empty())
-               ms << sgml::cleanID(buffer(), runparams, label(0));
-       else
-               ms << sgml::uniqueID(from_ascii("anon"));
-
-       if (runparams.flavor == OutputParams::XML)
-               ms << from_ascii("\"/>");
-       else
-               ms << from_ascii("\">");
-
-       ms.cr(); --ms.tab(); ms.os() << "</" << name << '>';
-
-       return ms.line() + res;
+       // Output the complete formula to the DocBook stream.
+       xs << XMLStream::ESCAPE_NONE << osmath.str();
+       xs << xml::CR();
+       xs << xml::EndTag(name);
 }
 
 
@@ -2520,13 +2527,13 @@ 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 & os) const
+void InsetMathHull::mathmlize(MathStream & ms) const
 {
        bool const havenumbers = haveNumbers();
        bool const havetable = havenumbers || nrows() > 1 || ncols() > 1;
 
        if (havetable)
-               os << MTag("mtable");
+               ms << MTag("mtable");
        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.
@@ -2534,25 +2541,25 @@ void InsetMathHull::mathmlize(MathStream & os) const
        char const * const rowtag = "mtr";
        for (row_type row = 0; row < nrows(); ++row) {
                if (havetable)
-                       os << MTag(rowtag);
+                       ms << MTag(rowtag);
                for (col_type col = 0; col < ncols(); ++col) {
-                       os << MTag(celltag)
+                       ms << MTag(celltag)
                           << cell(index(row, col))
                           << ETag(celltag);
                }
                // fleqn?
                if (havenumbers) {
-                       os << MTag("mtd");
+                       ms << MTag("mtd");
                        docstring const & num = numbers_[row];
                        if (!num.empty())
-                               os << '(' << num << ')';
-                 os << ETag("mtd");
+                               ms << '(' << num << ')';
+                 ms << ETag("mtd");
                }
                if (havetable)
-                       os << ETag(rowtag);
+                       ms << ETag(rowtag);
        }
        if (havetable)
-               os << ETag("mtable");
+               ms << ETag("mtable");
 }
 
 
@@ -2588,7 +2595,7 @@ void InsetMathHull::mathAsLatex(WriteStream & os) const
 }
 
 
-docstring InsetMathHull::xhtml(XHTMLStream & xs, OutputParams const & op) const
+docstring InsetMathHull::xhtml(XMLStream & xs, OutputParams const & op) const
 {
        BufferParams::MathOutput const mathtype =
                buffer().masterBuffer()->params().html_math_output;
@@ -2614,14 +2621,14 @@ docstring InsetMathHull::xhtml(XHTMLStream & xs, OutputParams const & op) const
                } catch (MathExportException const &) {}
                if (success) {
                        if (getType() == hullSimple)
-                               xs << html::StartTag("math",
+                               xs << xml::StartTag("math",
                                                        "xmlns=\"http://www.w3.org/1998/Math/MathML\"", true);
                        else
-                               xs << html::StartTag("math",
+                               xs << xml::StartTag("math",
                                      "display=\"block\" xmlns=\"http://www.w3.org/1998/Math/MathML\"", true);
-                       xs << XHTMLStream::ESCAPE_NONE
+                       xs << XMLStream::ESCAPE_NONE
                                 << os.str()
-                                << html::EndTag("math");
+                                << xml::EndTag("math");
                }
        } else if (mathtype == BufferParams::HTML) {
                odocstringstream os;
@@ -2632,10 +2639,10 @@ docstring InsetMathHull::xhtml(XHTMLStream & xs, OutputParams const & op) const
                } catch (MathExportException const &) {}
                if (success) {
                        string const tag = (getType() == hullSimple) ? "span" : "div";
-                       xs << html::StartTag(tag, "class='formula'", true)
-                          << XHTMLStream::ESCAPE_NONE
+                       xs << xml::StartTag(tag, "class='formula'", true)
+                          << XMLStream::ESCAPE_NONE
                           << os.str()
-                          << html::EndTag(tag);
+                          << xml::EndTag(tag);
                }
        }
 
@@ -2675,11 +2682,11 @@ docstring InsetMathHull::xhtml(XHTMLStream & xs, OutputParams const & op) const
                        }
 
                        string const tag = (getType() == hullSimple) ? "span" : "div";
-                       xs << html::CR()
-                          << html::StartTag(tag, "style = \"text-align: center;\"")
-                                << html::CompTag("img", "src=\"" + filename + "\" alt=\"Mathematical Equation\"")
-                                << html::EndTag(tag)
-                                << html::CR();
+                       xs << xml::CR()
+                          << xml::StartTag(tag, "style = \"text-align: center;\"")
+                                << xml::CompTag("img", "src=\"" + filename + "\" alt=\"Mathematical Equation\"")
+                                << xml::EndTag(tag)
+                                << xml::CR();
                        success = true;
                }
        }
@@ -2702,10 +2709,10 @@ docstring InsetMathHull::xhtml(XHTMLStream & xs, OutputParams const & op) const
                // FIXME XHTML
                // probably should allow for some kind of customization here
                string const tag = (getType() == hullSimple) ? "span" : "div";
-               xs << html::StartTag(tag, "class='math'")
+               xs << xml::StartTag(tag, "class='math'")
                   << latex
-                  << html::EndTag(tag)
-                  << html::CR();
+                  << xml::EndTag(tag)
+                  << xml::CR();
        }
        return docstring();
 }
@@ -2746,7 +2753,7 @@ void InsetMathHull::recordLocation(DocIterator const & di)
 bool InsetMathHull::canPaintChange(BufferView const &) const
 {
        // We let RowPainter do it seamlessly for inline insets
-       return display() != Inline;
+       return display();
 }