]> git.lyx.org Git - lyx.git/blobdiff - src/mathed/MathMacro.cpp
Fixup 89662a68: remove markers that should not be there
[lyx.git] / src / mathed / MathMacro.cpp
index 6a5c904df7161855c8c9286df8e7e95142355870..c3bbcabbf229e2fb47a9a60a7964aa2a873b2d84 100644 (file)
@@ -67,6 +67,8 @@ public:
        ///
        MathMacro const * owner() { return mathMacro_; }
        ///
+       marker_type marker() const { return NO_MARKER; }
+       ///
        InsetCode lyxCode() const { return ARGUMENT_PROXY_CODE; }
        /// The math data to use for display
        MathData const & displayCell(BufferView const * bv) const
@@ -82,10 +84,11 @@ public:
                // macro arguments are in macros
                LATTEST(mathMacro_->nesting() > 0);
                /// The macro nesting can change display of insets. Change it locally.
-               Changer chg = make_change(mi.base.macro_nesting, mathMacro_->nesting());
+               Changer chg = make_change(mi.base.macro_nesting,
+                                         mathMacro_->nesting() == 1 ? 0 : mathMacro_->nesting());
 
-               MathRow::Element e_beg(MathRow::BEG_ARG);
-               e_beg.macro = mathMacro_;
+               MathRow::Element e_beg(mi, MathRow::BEGIN);
+               e_beg.inset = this;
                e_beg.ar = &mathMacro_->cell(idx_);
                mrow.push_back(e_beg);
 
@@ -97,35 +100,58 @@ public:
                // then we insert a box instead.
                if (!has_contents && mathMacro_->nesting() == 1) {
                        // mathclass is ord because it should be spaced as a normal atom
-                       MathRow::Element e(MathRow::BOX, MC_ORD);
+                       MathRow::Element e(mi, MathRow::BOX, MC_ORD);
                        e.color = Color_mathline;
                        mrow.push_back(e);
                        has_contents = true;
                }
 
-               MathRow::Element e_end(MathRow::END_ARG);
-               e_end.macro = mathMacro_;
+               MathRow::Element e_end(mi, MathRow::END);
+               e_end.inset = this;
                e_end.ar = &mathMacro_->cell(idx_);
-
                mrow.push_back(e_end);
 
                return has_contents;
        }
        ///
-       void metrics(MetricsInfo &, Dimension &) const {
-               // This should never be invoked, since ArgumentProxy insets are linearized
-               LATTEST(false);
+       void beforeMetrics() const
+       {
+               mathMacro_->macro()->unlock();
        }
        ///
-       int kerning(BufferView const * bv) const
+       void afterMetrics() const
        {
-               return displayCell(bv).kerning(bv);
+               mathMacro_->macro()->lock();
+       }
+       ///
+       void beforeDraw(PainterInfo const & pi) const
+       {
+               // if the macro is being edited, then the painter is in
+               // monochrome mode.
+               if (mathMacro_->editMetrics(pi.base.bv))
+                       pi.pain.leaveMonochromeMode();
+       }
+       ///
+       void afterDraw(PainterInfo const & pi) const
+       {
+               if (mathMacro_->editMetrics(pi.base.bv))
+                       pi.pain.enterMonochromeMode(Color_mathbg, Color_mathmacroblend);
+       }
+       ///
+       void metrics(MetricsInfo &, Dimension &) const {
+               // This should never be invoked, since ArgumentProxy insets are linearized
+               LATTEST(false);
        }
        ///
        void draw(PainterInfo &, int, int) const {
                // This should never be invoked, since ArgumentProxy insets are linearized
                LATTEST(false);
        }
+       ///
+       int kerning(BufferView const * bv) const
+       {
+               return displayCell(bv).kerning(bv);
+       }
        // write(), normalize(), infoize() and infoize2() are not needed since
        // MathMacro uses the definition and not the expanded cells.
        ///
@@ -140,6 +166,15 @@ public:
        void htmlize(HtmlStream & ms) const { ms << mathMacro_->cell(idx_); }
        ///
        void octave(OctaveStream & os) const { os << mathMacro_->cell(idx_); }
+       ///
+       MathClass mathClass() const
+       {
+               return MC_UNKNOWN;
+               // This can be refined once the pointer issues are fixed. I did not
+               // notice any immediate crash with the following code, but it is risky
+               // nevertheless:
+               //return mathMacro_->cell(idx_).mathClass();
+       }
 
 private:
        ///
@@ -291,15 +326,20 @@ bool MathMacro::addToMathRow(MathRow & mrow, MetricsInfo & mi) const
        // This is the same as what is done in metrics().
        d->editing_[mi.base.bv] = editMode(mi.base.bv);
 
-       /// The macro nesting can change display of insets. Change it locally.
-       Changer chg = make_change(mi.base.macro_nesting, d->nesting_);
-
+       // For now we do not linearize in the following cases (can be improved)
+       // - display mode different from normal
+       // - editing with parameter list
+       // - editing with box around macro
        if (displayMode() != MathMacro::DISPLAY_NORMAL
-           || d->editing_[mi.base.bv])
+               || (d->editing_[mi.base.bv] && lyxrc.macro_edit_style != LyXRC::MACRO_EDIT_INLINE))
                return InsetMath::addToMathRow(mrow, mi);
 
-       MathRow::Element e_beg(MathRow::BEG_MACRO);
-       e_beg.macro = this;
+       /// The macro nesting can change display of insets. Change it locally.
+       Changer chg = make_change(mi.base.macro_nesting, d->nesting_);
+
+       MathRow::Element e_beg(mi, MathRow::BEGIN);
+       e_beg.inset = this;
+       e_beg.marker = (d->nesting_ == 1 && nargs()) ? marker() : NO_MARKER;
        mrow.push_back(e_beg);
 
        d->macro_->lock();
@@ -310,19 +350,44 @@ bool MathMacro::addToMathRow(MathRow & mrow, MetricsInfo & mi) const
        // insert a grey box instead.
        if (!has_contents && mi.base.macro_nesting == 1) {
                // mathclass is unknown because it is irrelevant for spacing
-               MathRow::Element e(MathRow::BOX);
+               MathRow::Element e(mi, MathRow::BOX);
                e.color = Color_mathmacroblend;
                mrow.push_back(e);
                has_contents = true;
        }
 
-       MathRow::Element e_end(MathRow::END_MACRO);
-       e_end.macro = this;
+       MathRow::Element e_end(mi, MathRow::END);
+       e_end.inset = this;
        mrow.push_back(e_end);
 
        return has_contents;
 }
 
+void MathMacro::beforeMetrics() const
+{
+       d->macro_->lock();
+}
+
+
+void MathMacro::afterMetrics() const
+{
+       d->macro_->unlock();
+}
+
+
+void MathMacro::beforeDraw(PainterInfo const & pi) const
+{
+       if (d->editing_[pi.base.bv])
+               pi.pain.enterMonochromeMode(Color_mathbg, Color_mathmacroblend);
+}
+
+
+void MathMacro::afterDraw(PainterInfo const & pi) const
+{
+       if (d->editing_[pi.base.bv])
+               pi.pain.leaveMonochromeMode();
+}
+
 
 Inset * MathMacro::clone() const
 {
@@ -420,6 +485,27 @@ bool MathMacro::editMetrics(BufferView const * bv) const
 }
 
 
+Inset::marker_type MathMacro::marker() const
+{
+       switch (d->displayMode_) {
+       case DISPLAY_INIT:
+       case DISPLAY_INTERACTIVE_INIT:
+               return NO_MARKER;
+       case DISPLAY_UNFOLDED:
+               return MARKER;
+       default:
+               switch (lyxrc.macro_edit_style) {
+               case LyXRC::MACRO_EDIT_LIST:
+                       return MARKER2;
+               case LyXRC::MACRO_EDIT_INLINE_BOX:
+                       return NO_MARKER;
+               default:
+                       return MARKER;
+               }
+       }
+}
+
+
 void MathMacro::metrics(MetricsInfo & mi, Dimension & dim) const
 {
        /// The macro nesting can change display of insets. Change it locally.
@@ -440,7 +526,6 @@ void MathMacro::metrics(MetricsInfo & mi, Dimension & dim) const
                dim.wid += bsdim.width() + 1;
                dim.asc = max(bsdim.ascent(), dim.ascent());
                dim.des = max(bsdim.descent(), dim.descent());
-               metricsMarkers(mi, dim);
        } else if (lyxrc.macro_edit_style == LyXRC::MACRO_EDIT_LIST
                   && d->editing_[mi.base.bv]) {
                // Macro will be edited in a old-style list mode here:
@@ -480,14 +565,9 @@ void MathMacro::metrics(MetricsInfo & mi, Dimension & dim) const
                dim.asc += 1;
                dim.des += 1;
                dim.wid += 2;
-               metricsMarkers2(mi, dim);
        } else {
                LBUFERR(d->macro_);
 
-               Changer dummy = (currentMode() == TEXT_MODE)
-                       ? mi.base.font.changeShape(UP_SHAPE)
-                       : Changer();
-
                // calculate metrics, hoping that all cells are seen
                d->macro_->lock();
                d->expanded_.metrics(mi, dim);
@@ -635,16 +715,15 @@ void MathMacro::draw(PainterInfo & pi, int x, int y) const
                pi.pain.text(x, y, from_ascii("\\"), pi.base.font);
                x += mathed_string_width(pi.base.font, from_ascii("\\")) + 1;
                cell(0).draw(pi, x, y);
-               drawMarkers(pi, expx, expy);
        } else if (lyxrc.macro_edit_style == LyXRC::MACRO_EDIT_LIST
-                  && d->editing_[pi.base.bv]) {
+                  && d->editing_[pi.base.bv]) {
                // Macro will be edited in a old-style list mode here:
 
                CoordCache const & coords = pi.base.bv->coordCache();
                FontInfo const & labelFont = sane_font;
 
-               // markers and box needs two pixels
-               x += 2;
+               // box needs one pixel
+               x += 1;
 
                // get maximal font height
                Dimension fontDim;
@@ -668,7 +747,7 @@ void MathMacro::draw(PainterInfo & pi, int x, int y) const
                for (idx_type i = 0; i < nargs(); ++i) {
                        // position of label
                        Dimension const & cdim = coords.getArrays().dim(&cell(i));
-                       x = expx + 2;
+                       x = expx + 1;
                        y += max(fontDim.asc, cdim.asc) + 1;
 
                        // draw label
@@ -685,20 +764,17 @@ void MathMacro::draw(PainterInfo & pi, int x, int y) const
                        y += max(fontDim.des, cdim.des);
                }
 
-               pi.pain.rectangle(expx + 1, expy - dim.asc + 1, dim.wid - 3,
+               pi.pain.rectangle(expx, expy - dim.asc + 1, dim.wid - 1,
                                  dim.height() - 2, Color_mathmacroframe);
-               drawMarkers2(pi, expx, expy);
        } else {
-               bool drawBox = lyxrc.macro_edit_style == LyXRC::MACRO_EDIT_INLINE_BOX;
-               Changer dummy = (currentMode() == TEXT_MODE)
-                       ? pi.base.font.changeShape(UP_SHAPE)
-                       : Changer();
+               bool drawBox = lyxrc.macro_edit_style == LyXRC::MACRO_EDIT_INLINE_BOX
+                       && d->editing_[pi.base.bv];
 
                // warm up cells
                for (size_t i = 0; i < nargs(); ++i)
                        cell(i).setXY(*pi.base.bv, x, y);
 
-               if (drawBox && d->editing_[pi.base.bv]) {
+               if (drawBox) {
                        // draw header and rectangle around
                        FontInfo font = pi.base.font;
                        augmentFont(font, "lyxtex");
@@ -712,20 +788,13 @@ void MathMacro::draw(PainterInfo & pi, int x, int y) const
                        expx += (dim.wid - d->expanded_.dimension(*pi.base.bv).width()) / 2;
                }
 
-               if (d->editing_[pi.base.bv]) {
-                       pi.pain.enterMonochromeMode(Color_mathbg, Color_mathmacroblend);
-                       d->expanded_.draw(pi, expx, expy);
-                       pi.pain.leaveMonochromeMode();
-
-                       if (drawBox)
-                               pi.pain.rectangle(x, y - dim.asc, dim.wid,
-                                                 dim.height(), Color_mathmacroframe);
-               } else
-                       d->expanded_.draw(pi, expx, expy);
-
-               if (!drawBox)
-                       drawMarkers(pi, x, y);
+               beforeDraw(pi);
+               d->expanded_.draw(pi, expx, expy);
+               afterDraw(pi);
 
+               if (drawBox)
+                       pi.pain.rectangle(x, y - dim.asc, dim.wid,
+                                         dim.height(), Color_mathmacroframe);
        }
 
        // edit mode changed?
@@ -828,14 +897,56 @@ size_t MathMacro::appetite() const
 }
 
 
+MathClass MathMacro::mathClass() const
+{
+       // This can be just a heuristic, since it is only considered for display
+       // when the macro is not linearised. Therefore it affects:
+       // * The spacing of the inset while being edited,
+       // * Intelligent splitting
+       // * Cursor word movement (Ctrl-Arrow).
+       if (MacroData const * m = macroBackup()) {
+               // If it is a global macro and is defined explicitly
+               if (m->symbol()) {
+                       MathClass mc = string_to_class(m->symbol()->extra);
+                       if (mc != MC_UNKNOWN)
+                               return mc;
+               }
+       }
+       // Otherwise guess from the expanded macro
+       return d->expanded_.mathClass();
+}
+
+
 InsetMath::mode_type MathMacro::currentMode() const
 {
-       // User defined macros are always assumed to be mathmode macros.
-       // Only the global macros defined in lib/symbols may be textmode.
+       // There is no way to guess the mode of user defined macros, so they are
+       // always assumed to be mathmode.  Only the global macros defined in
+       // lib/symbols may be textmode.
+       mode_type mode = modeToEnsure();
+       return (mode == UNDECIDED_MODE) ? MATH_MODE : mode;
+}
+
+
+InsetMath::mode_type MathMacro::modeToEnsure() const
+{
+       // User defined macros can be either text mode or math mode for output and
+       // display. There is no way to guess. For global macros defined in
+       // lib/symbols, we ensure textmode if flagged as such, otherwise we ensure
+       // math mode.
+       if (MacroData const * m = macroBackup())
+               if (m->symbol())
+                       return (m->symbol()->extra == "textmode") ? TEXT_MODE : MATH_MODE;
+       return UNDECIDED_MODE;
+}
+
 
-       MacroData const * data = MacroTable::globalMacros().get(name());
-       bool textmode = data && data->symbol() && data->symbol()->extra == "textmode";
-       return textmode ? TEXT_MODE : MATH_MODE;
+MacroData const * MathMacro::macroBackup() const
+{
+       if (macro())
+               return &d->macroBackup_;
+       if (MacroData const * data = MacroTable::globalMacros().get(name()))
+               return data;
+       return nullptr;
 }
 
 
@@ -1016,12 +1127,9 @@ bool MathMacro::folded() const
 
 void MathMacro::write(WriteStream & os) const
 {
-       MacroData const * data = MacroTable::globalMacros().get(name());
-       bool textmode_macro = data && data->symbol()
-                                  && data->symbol()->extra == "textmode";
-       bool needs_mathmode = data && (!data->symbol()
-                                      || data->symbol()->extra != "textmode");
-
+       mode_type mode = modeToEnsure();
+       bool textmode_macro = mode == TEXT_MODE;
+       bool needs_mathmode = mode == MATH_MODE;
        MathEnsurer ensurer(os, needs_mathmode, true, textmode_macro);
 
        // non-normal mode