]> git.lyx.org Git - lyx.git/blobdiff - src/mathed/MathRow.cpp
Force a Buffer * argument to math insets constructor
[lyx.git] / src / mathed / MathRow.cpp
index cfb41642d476d6506cb30f797fa4d7cf6403c8e1..b8d8f63d8ec915805078ab2805840fc805d7c3ba 100644 (file)
 
 #include "MathRow.h"
 
-#include "InsetMath.h"
-#include "MathClass.h"
 #include "MathData.h"
-#include "MathMacro.h"
 #include "MathSupport.h"
 
 #include "BufferView.h"
+#include "ColorSet.h"
 #include "CoordCache.h"
+#include "Cursor.h"
+#include "LyXRC.h"
 #include "MetricsInfo.h"
 
+#include "mathed/InsetMath.h"
+
 #include "frontends/FontMetrics.h"
 #include "frontends/Painter.h"
 
@@ -29,6 +31,7 @@
 #include "support/docstring.h"
 #include "support/lassert.h"
 
+#include <algorithm>
 #include <ostream>
 
 using namespace std;
@@ -38,11 +41,114 @@ namespace lyx {
 
 MathRow::Element::Element(MetricsInfo const & mi, Type t, MathClass mc)
        : type(t), mclass(mc), before(0), after(0), macro_nesting(mi.base.macro_nesting),
-         marker(InsetMath::NO_MARKER), inset(0), compl_unique_to(0),
-         macro(0), color(Color_red)
+         marker(marker_type::NO_MARKER), inset(nullptr), compl_unique_to(0), ar(nullptr),
+         color(Color_red)
 {}
 
 
+namespace {
+
+// Helper functions for markers
+
+int markerMargin(MathRow::Element const & e)
+{
+       switch(e.marker) {
+       case marker_type::MARKER:
+       case marker_type::MARKER2:
+       case marker_type::BOX_MARKER:
+               return 2;
+       case marker_type::NO_MARKER:
+               return 0;
+       }
+       // should not happen
+       return 0;
+}
+
+
+void afterMetricsMarkers(MetricsInfo const & , MathRow::Element & e,
+                            Dimension & dim)
+{
+       // handle vertical space for markers
+       switch(e.marker) {
+       case marker_type::NO_MARKER:
+               break;
+       case marker_type::MARKER:
+               ++dim.des;
+               break;
+       case marker_type::MARKER2:
+               ++dim.asc;
+               ++dim.des;
+               break;
+       case marker_type::BOX_MARKER:
+               FontInfo font;
+               font.setSize(TINY_SIZE);
+               Dimension namedim;
+               mathed_string_dim(font, e.inset->name(), namedim);
+               int const namewid = 1 + namedim.wid + 1;
+
+               if (namewid > dim.wid)
+                       e.after += namewid - dim.wid;
+               ++dim.asc;
+               dim.des += 3 + namedim.height();
+       }
+}
+
+
+void drawMarkers(PainterInfo const & pi, MathRow::Element const & e,
+                 int const x, int const y)
+{
+       if (e.marker == marker_type::NO_MARKER)
+               return;
+
+       CoordCache const & coords = pi.base.bv->coordCache();
+       Dimension const dim = coords.getInsets().dim(e.inset);
+
+       // the marker is before/after the inset. Necessary space has been reserved already.
+       int const l = x + e.before - (markerMargin(e) > 0 ? 1 : 0);
+       int const r = x + dim.width() - e.after;
+
+       // Grey lower box
+       if (e.marker == marker_type::BOX_MARKER) {
+               // draw header and rectangle around
+               FontInfo font;
+               font.setSize(TINY_SIZE);
+               font.setColor(Color_mathmacrolabel);
+               Dimension namedim;
+               mathed_string_dim(font, e.inset->name(), namedim);
+               pi.pain.fillRectangle(l, y + dim.des - namedim.height() - 2,
+                                     dim.wid, namedim.height() + 2, Color_mathmacrobg);
+               pi.pain.text(l, y + dim.des - namedim.des - 1, e.inset->name(), font);
+       }
+
+       // Color for corners
+       bool const highlight = e.inset->mouseHovered(pi.base.bv)
+                              || e.inset->editing(pi.base.bv);
+       ColorCode const pen_color = highlight ? Color_mathframe : Color_mathcorners;
+       // If the corners have the same color as the background, do not paint them.
+       if (lcolor.getX11HexName(Color_mathbg) == lcolor.getX11HexName(pen_color))
+               return;
+
+       // Lower corners in all cases
+       int const d = y + dim.descent();
+       pi.pain.line(l, d - 3, l, d, pen_color);
+       pi.pain.line(r, d - 3, r, d, pen_color);
+       pi.pain.line(l, d, l + 3, d, pen_color);
+       pi.pain.line(r - 3, d, r, d, pen_color);
+
+       // Upper corners
+       if (e.marker == marker_type::BOX_MARKER
+           || e.marker == marker_type::MARKER2) {
+               int const a = y - dim.ascent();
+               pi.pain.line(l, a + 3, l, a, pen_color);
+               pi.pain.line(r, a + 3, r, a, pen_color);
+               pi.pain.line(l, a, l + 3, a, pen_color);
+               pi.pain.line(r - 3, a, r, a, pen_color);
+       }
+}
+
+} // namespace
+
+
 MathRow::MathRow(MetricsInfo & mi, MathData const * ar)
 {
        // First there is a dummy element of type "open"
@@ -51,10 +157,10 @@ MathRow::MathRow(MetricsInfo & mi, MathData const * ar)
        // Then insert the MathData argument
        bool const has_contents = ar->addToMathRow(*this, mi);
 
-       // empty arrays are visible when they are editable
-       // we reserve the necessary space anyway (even if nothing gets drawn)
+       // A MathRow should not be completely empty
        if (!has_contents) {
                Element e(mi, BOX, MC_ORD);
+               // empty arrays are visible when they are editable
                e.color = mi.base.macro_nesting == 0 ? Color_mathline : Color_none;
                push_back(e);
        }
@@ -80,12 +186,9 @@ MathRow::MathRow(MetricsInfo & mi, MathData const * ar)
        // We go to the end to handle spacing at the end of equation
        for (int i = 1 ; i != static_cast<int>(elements_.size()) ; ++i) {
                Element & e = elements_[i];
-
-               if (e.mclass == MC_UNKNOWN)
-                       continue;
-
                Element & bef = elements_[before(i)];
-               if (dospacing) {
+
+               if (dospacing && e.mclass != MC_UNKNOWN) {
                        int spc = class_spacing(bef.mclass, e.mclass, mi.base);
                        bef.after += spc / 2;
                        // this is better than spc / 2 to avoid rounding problems
@@ -93,10 +196,24 @@ MathRow::MathRow(MetricsInfo & mi, MathData const * ar)
                }
 
                // finally reserve space for markers
-               if (bef.marker != Inset::NO_MARKER)
-                       bef.after = max(bef.after, 1);
-               if (e.marker != Inset::NO_MARKER)
-                       e.before = max(e.before, 1);
+               /* FIXME : the test below avoids that the spacing grows grows
+                * when a BEGIN/END_SEL element is added (typically start or
+                * end a selection after a fraction). I would think that the
+                * code should just go under the e.mclass != MC_UNKNOWN branch
+                * below, but I am not sure why it has not been done before.
+                * Therefore, until we double check this, be very conservative
+                */
+               if (e.type != BEGIN_SEL && e.type != END_SEL)
+                       bef.after = max(bef.after, markerMargin(bef));
+               if (e.mclass != MC_UNKNOWN)
+                       e.before = max(e.before, markerMargin(e));
+               // for linearized insets (macros...) too
+               if (e.type == BEGIN)
+                       bef.after = max(bef.after, markerMargin(e));
+               if (e.type == END && e.marker != marker_type::NO_MARKER) {
+                       Element & aft = elements_[after(i)];
+                       aft.before = max(aft.before, markerMargin(e));
+               }
        }
 
        // Do not lose spacing allocated to extremities
@@ -127,74 +244,72 @@ int MathRow::after(int i) const
 }
 
 
-void MathRow::metrics(MetricsInfo & mi, Dimension & dim) const
+void MathRow::metrics(MetricsInfo & mi, Dimension & dim)
 {
-       dim.asc = 0;
        dim.wid = 0;
        // In order to compute the dimension of macros and their
        // arguments, it is necessary to keep track of them.
-       map<MathMacro const *, Dimension> dim_macros;
-       map<MathData const *, Dimension> dim_arrays;
+       vector<pair<InsetMath const *, Dimension>> dim_insets;
+       vector<pair<MathData const *, Dimension>> dim_arrays;
        CoordCache & coords = mi.base.bv->coordCache();
-       for (Element const & e : elements_) {
+       for (Element & e : elements_) {
                mi.base.macro_nesting = e.macro_nesting;
                Dimension d;
                switch (e.type) {
                case DUMMY:
+               case BEGIN_SEL:
+               case END_SEL:
                        break;
                case INSET:
                        e.inset->metrics(mi, d);
                        d.wid += e.before + e.after;
                        coords.insets().add(e.inset, d);
                        break;
-               case BEG_MACRO:
-                       e.macro->macro()->lock();
-                       // Add a macro to current list
-                       dim_macros[e.macro] = Dimension();
-                       break;
-               case END_MACRO:
-                       LATTEST(dim_macros.find(e.macro) != dim_macros.end());
-                       e.macro->macro()->unlock();
-                       // Cache the dimension of the macro and remove it from
-                       // tracking map.
-                       coords.insets().add(e.macro, dim_macros[e.macro]);
-                       dim_macros.erase(e.macro);
-                       break;
-                       // This is basically like macros
-               case BEG_ARG:
-                       if (e.macro)
-                               e.macro->macro()->unlock();
-                       dim_arrays[e.ar] = Dimension();
+               case BEGIN:
+                       if (e.inset) {
+                               dim_insets.push_back(make_pair(e.inset, Dimension()));
+                               dim_insets.back().second.wid += e.before + e.after;
+                               d.wid = e.before + e.after;
+                               e.inset->beforeMetrics();
+                       }
+                       if (e.ar)
+                               dim_arrays.push_back(make_pair(e.ar, Dimension()));
                        break;
-               case END_ARG:
-                       LATTEST(dim_arrays.find(e.ar) != dim_arrays.end());
-                       if (e.macro)
-                               e.macro->macro()->lock();
-                       coords.arrays().add(e.ar, dim_arrays[e.ar]);
-                       dim_arrays.erase(e.ar);
+               case END:
+                       if (e.inset) {
+                               e.inset->afterMetrics();
+                               LATTEST(dim_insets.back().first == e.inset);
+                               d = dim_insets.back().second;
+                               afterMetricsMarkers(mi, e, d);
+                               d.wid += e.before + e.after;
+                               coords.insets().add(e.inset, d);
+                               dim_insets.pop_back();
+                               // We do not want to count the width again, but the
+                               // padding and the vertical dimension are meaningful.
+                               d.wid = e.before + e.after;
+                       }
+                       if (e.ar) {
+                               LATTEST(dim_arrays.back().first == e.ar);
+                               coords.arrays().add(e.ar, dim_arrays.back().second);
+                               dim_arrays.pop_back();
+                       }
                        break;
                case BOX:
                        d = theFontMetrics(mi.base.font).dimension('I');
-                       d.wid += e.before + e.after;
-                       break;
-               }
-
-               // handle vertical space for markers
-               switch(e.marker) {
-               case InsetMath::NO_MARKER:
-                       break;
-               case InsetMath::MARKER:
-                       ++d.des;
+                       if (e.color != Color_none) {
+                               // allow for one pixel before/after the box.
+                               d.wid += e.before + e.after + 2;
+                       } else {
+                               // hide the box, but keep its height
+                               d.wid = 0;
+                       }
                        break;
-               case InsetMath::MARKER2:
-                       ++d.asc;
-                       ++d.des;
                }
 
                if (!d.empty()) {
                        dim += d;
                        // Now add the dimension to current macros and arguments.
-                       for (auto & dim_macro : dim_macros)
+                       for (auto & dim_macro : dim_insets)
                                dim_macro.second += d;
                        for (auto & dim_array : dim_arrays)
                                dim_array.second += d;
@@ -206,49 +321,13 @@ void MathRow::metrics(MetricsInfo & mi, Dimension & dim) const
                augmentFont(font, "mathnormal");
                dim.wid += mathed_string_width(font, e.compl_text);
        }
-       LATTEST(dim_macros.empty() && dim_arrays.empty());
-}
-
-
-namespace {
-
-void drawMarkers(PainterInfo const & pi, MathRow::Element const & e, int const x, int const y)
-{
-       if (e.marker == InsetMath::NO_MARKER)
-               return;
-
-       CoordCache const & coords = pi.base.bv->coordCache();
-       Dimension const dim = coords.getInsets().dim(e.inset);
-
-       // the marker is before/after the inset. Normally some space has been reserved already.
-       int const l = x + e.before - 1;
-       int const r = x + dim.width() - e.after;
-
-       // Duplicated from Inset.cpp and adapted. It is believed that the
-       // Inset version should die eventually
-       ColorCode pen_color = e.inset->mouseHovered(pi.base.bv) || e.inset->editing(pi.base.bv)?
-               Color_mathframe : Color_mathcorners;
-
-       int const d = y + dim.descent();
-       pi.pain.line(l, d - 3, l, d, pen_color);
-       pi.pain.line(r, d - 3, r, d, pen_color);
-       pi.pain.line(l, d, l + 3, d, pen_color);
-       pi.pain.line(r - 3, d, r, d, pen_color);
-
-       if (e.marker == InsetMath::MARKER)
-               return;
-
-       int const a = y - dim.ascent();
-       pi.pain.line(l, a + 3, l, a, pen_color);
-       pi.pain.line(r, a + 3, r, a, pen_color);
-       pi.pain.line(l, a, l + 3, a, pen_color);
-       pi.pain.line(r - 3, a, r, a, pen_color);
+       LATTEST(dim_insets.empty() && dim_arrays.empty());
 }
 
-}
 
 void MathRow::draw(PainterInfo & pi, int x, int const y) const
 {
+       Changer change_color;
        CoordCache & coords = pi.base.bv->coordCache();
        for (Element const & e : elements_) {
                switch (e.type) {
@@ -256,45 +335,57 @@ void MathRow::draw(PainterInfo & pi, int x, int const y) const
                        // This is hackish: the math inset does not know that space
                        // has been added before and after it; we alter its dimension
                        // while it is drawing, because it relies on this value.
-                       Dimension const d = coords.insets().dim(e.inset);
-                       Dimension d2 = d;
-                       d2.wid -= e.before + e.after;
-                       coords.insets().add(e.inset, d2);
-                       e.inset->drawSelection(pi, x + e.before, y);
+                       Geometry & g = coords.insets().geometry(e.inset);
+                       g.dim.wid -= e.before + e.after;
+                       if (pi.pain.develMode() && !e.inset->isBufferValid()) {
+                               pi.pain.fillRectangle(x + e.before, y - g.dim.ascent(),
+                                                     g.dim.width(), g.dim.height(), Color_error);
+                               LYXERR0("Unset Buffer memeber in " << insetName(e.inset->lyxCode()));
+                       }
                        e.inset->draw(pi, x + e.before, y);
-                       coords.insets().add(e.inset, x, y);
-                       coords.insets().add(e.inset, d);
+                       g.pos = {x, y};
+                       g.dim.wid += e.before + e.after;
                        drawMarkers(pi, e, x, y);
-                       x += d.wid;
+                       x += g.dim.wid;
                        break;
                }
-               case BEG_MACRO:
-                       coords.insets().add(e.macro, x, y);
-
-                       drawMarkers(pi, e, x, y);
+               case BEGIN:
+                       if (e.ar) {
+                               coords.arrays().add(e.ar, x, y);
+                               e.ar->drawSelection(pi, x, y);
+                       }
+                       if (e.inset) {
+                               coords.insets().add(e.inset, x, y);
+                               drawMarkers(pi, e, x, y);
+                               e.inset->beforeDraw(pi);
+                       }
+                       x += e.before + e.after;
+                       break;
+               case END:
+                       if (e.inset)
+                               e.inset->afterDraw(pi);
+                       x += e.before + e.after;
                        break;
-               case BEG_ARG:
-                       coords.arrays().add(e.ar, x, y);
-                       // if the macro is being edited, then the painter is in
-                       // monochrome mode.
-                       if (e.macro->editMetrics(pi.base.bv))
-                               pi.pain.leaveMonochromeMode();
+               case BEGIN_SEL:
+                       // Change the color if the selection is indeed active
+                       // FIXME: it would be better to make sure that metrics are
+                       //   computed again when selection status changes.
+                       if (pi.base.bv->cursor().selection())
+                               change_color = pi.base.font.changeColor(Color_selectionmath);
                        break;
-               case END_ARG:
-                       if (e.macro->editMetrics(pi.base.bv))
-                               pi.pain.enterMonochromeMode(Color_mathbg, Color_mathmacroblend);
+               case END_SEL:
+                       change_color = noChange();
                        break;
                case BOX: {
+                       if (e.color == Color_none)
+                               break;
                        Dimension const d = theFontMetrics(pi.base.font).dimension('I');
-                       // the box is not visible in non-editable context (except for grey macro boxes).
-                       if (e.color != Color_none)
-                               pi.pain.rectangle(x + e.before, y - d.ascent(),
-                                                 d.width(), d.height(), e.color);
-                       x += d.wid + e.before + e.after;
+                       pi.pain.rectangle(x + e.before + 1, y - d.ascent(),
+                                         d.width() - 1, d.height() - 1, e.color);
+                       x += d.wid + 2 + e.before + e.after;
                        break;
                }
                case DUMMY:
-               case END_MACRO:
                        break;
                }
 
@@ -311,12 +402,14 @@ void MathRow::draw(PainterInfo & pi, int x, int const y) const
 
                if (!s1.empty()) {
                        f.setColor(Color_inlinecompletion);
-                       pi.pain.text(x, y, s1, f);
+                       // offset the text by e.after to make sure that the
+                       // spacing is after the completion, not before.
+                       pi.pain.text(x - e.after, y, s1, f);
                        x += mathed_string_width(f, s1);
                }
                if (!s2.empty()) {
                        f.setColor(Color_nonunique_inlinecompletion);
-                       pi.pain.text(x, y, s2, f);
+                       pi.pain.text(x - e.after, y, s2, f);
                        x += mathed_string_width(f, s2);
                }
        }
@@ -343,18 +436,24 @@ ostream & operator<<(ostream & os, MathRow::Element const & e)
                   << to_utf8(class_to_string(e.mclass))
                   << "-" << e.after << ">";
                break;
-       case MathRow::BEG_MACRO:
-               os << "\\" << to_utf8(e.macro->name())
-                  << "^" << e.macro->nesting() << "[";
+       case MathRow::BEGIN:
+               if (e.inset)
+                       os << "\\" << to_utf8(e.inset->name())
+                          << "^" << e.macro_nesting << "[";
+               if (e.ar)
+                       os << "(";
                break;
-       case MathRow::END_MACRO:
-               os << "]";
+       case MathRow::END:
+               if (e.ar)
+                       os << ")";
+               if (e.inset)
+                       os << "]";
                break;
-       case MathRow::BEG_ARG:
-               os << "#(";
+       case MathRow::BEGIN_SEL:
+               os << "<sel>";
                break;
-       case MathRow::END_ARG:
-               os << ")";
+       case MathRow::END_SEL:
+               os << "</sel>" ;
                break;
        case MathRow::BOX:
                os << "<" << e.before << "-[]-" << e.after << ">";