]> git.lyx.org Git - lyx.git/blobdiff - src/mathed/MathMacro.cpp
Fix display and output of math macros with optional arguments
[lyx.git] / src / mathed / MathMacro.cpp
index c4401d2b69ee8bfbee87ae952fc4d5b96e1ce2ff..afc40a4910e9764df40ada1a4dae062c9baa4744 100644 (file)
@@ -68,28 +68,49 @@ public:
        ///
        InsetCode lyxCode() const { return ARGUMENT_PROXY_CODE; }
        ///
-       bool addToMathRow(MathRow & mrow, MetricsInfo const & mi) const
+       bool addToMathRow(MathRow & mrow, MetricsInfo & mi) const
        {
-               MathRow::Element e(MathRow::BEG_ARG);
-               e.macro = mathMacro_;
-               e.ar = &mathMacro_->cell(idx_);
-               mrow.push_back(e);
+               // macro arguments are in macros
+               LATTEST(mi.base.macro_nesting > 0);
+               if (mi.base.macro_nesting == 1)
+                       mi.base.macro_nesting = 0;
+
+               MathRow::Element e_beg(MathRow::BEG_ARG, mi);
+               e_beg.macro = mathMacro_;
+               e_beg.ar = &mathMacro_->cell(idx_);
+               mrow.push_back(e_beg);
 
                mathMacro_->macro()->unlock();
-               bool const has_contents = mathMacro_->cell(idx_).addToMathRow(mrow, mi);
+               bool has_contents = mathMacro_->cell(idx_).addToMathRow(mrow, mi);
                mathMacro_->macro()->lock();
 
-               e.type = MathRow::END_ARG;
-               mrow.push_back(e);
+               // if there was no contents, and the contents is editable,
+               // then we insert a box instead.
+               if (!has_contents && mi.base.macro_nesting == 0) {
+                       MathRow::Element e(MathRow::BOX, mi);
+                       e.color = Color_mathline;
+                       mrow.push_back(e);
+                       has_contents = true;
+               }
 
-               if (has_contents)
-                       return true;
-               // if there was no contents, then we insert the empty macro inset
-               // instead.
-               return InsetMath::addToMathRow(mrow, mi);
+               if (mi.base.macro_nesting == 0)
+                       mi.base.macro_nesting = 1;
+
+               MathRow::Element e_end(MathRow::END_ARG, mi);
+               e_end.macro = mathMacro_;
+               e_end.ar = &mathMacro_->cell(idx_);
+
+               mrow.push_back(e_end);
+
+               return has_contents;
        }
        ///
        void metrics(MetricsInfo & mi, Dimension & dim) const {
+               // macro arguments are in macros
+               LATTEST(mi.base.macro_nesting > 0);
+               if (mi.base.macro_nesting == 1)
+                       mi.base.macro_nesting = 0;
+
                mathMacro_->macro()->unlock();
                mathMacro_->cell(idx_).metrics(mi, dim);
 
@@ -98,6 +119,8 @@ public:
                        def_.metrics(mi, dim);
 
                mathMacro_->macro()->lock();
+               if (mi.base.macro_nesting == 0)
+                       mi.base.macro_nesting = 1;
        }
        // write(), normalize(), infoize() and infoize2() are not needed since
        // MathMacro uses the definition and not the expanded cells.
@@ -115,6 +138,10 @@ public:
        void octave(OctaveStream & os) const { os << mathMacro_->cell(idx_); }
        ///
        void draw(PainterInfo & pi, int x, int y) const {
+               LATTEST(pi.base.macro_nesting > 0);
+               if (pi.base.macro_nesting == 1)
+                       pi.base.macro_nesting = 0;
+
                if (mathMacro_->editMetrics(pi.base.bv)) {
                        // The only way a ArgumentProxy can appear is in a cell of the
                        // MathMacro. Moreover the cells are only drawn in the DISPLAY_FOLDED
@@ -132,6 +159,9 @@ public:
                        def_.draw(pi, x, y);
                } else
                        mathMacro_->cell(idx_).draw(pi, x, y);
+
+               if (pi.base.macro_nesting == 0)
+                       pi.base.macro_nesting = 1;
        }
        ///
        size_t idx() const { return idx_; }
@@ -287,31 +317,42 @@ MathMacro::~MathMacro()
 }
 
 
-bool MathMacro::addToMathRow(MathRow & mrow, MetricsInfo const & mi) const
+bool MathMacro::addToMathRow(MathRow & mrow, MetricsInfo & mi) const
 {
        // set edit mode for which we will have calculated row.
        // This is the same as what is done in metrics().
        d->editing_[mi.base.bv] = editMode(mi.base.bv);
 
-       if (displayMode() == MathMacro::DISPLAY_NORMAL
-           && !d->editing_[mi.base.bv]) {
-               MathRow::Element e(MathRow::BEG_MACRO);
-               e.macro = this;
-               mrow.push_back(e);
+       if (displayMode() != MathMacro::DISPLAY_NORMAL
+           || d->editing_[mi.base.bv])
+               return InsetMath::addToMathRow(mrow, mi);
 
-               d->macro_->lock();
-               bool const has_contents = d->expanded_.addToMathRow(mrow, mi);
-               d->macro_->unlock();
+       MathRow::Element e_beg(MathRow::BEG_MACRO, mi);
+       e_beg.macro = this;
+       mrow.push_back(e_beg);
 
-               e.type = MathRow::END_MACRO;
-               mrow.push_back(e);
+       ++mi.base.macro_nesting;
 
-               if (has_contents)
-                       return true;
-               // if there was no contents, then we insert the empty macro inset
-               // instead.
+       d->macro_->lock();
+       bool has_contents = d->expanded_.addToMathRow(mrow, mi);
+       d->macro_->unlock();
+
+       // if there was no contents and the array is editable, then we
+       // insert a grey box instead.
+       if (!has_contents && mi.base.macro_nesting == 1) {
+               MathRow::Element e(MathRow::BOX, mi);
+               e.color = Color_mathmacroblend;
+               mrow.push_back(e);
+               has_contents = true;
        }
-       return InsetMath::addToMathRow(mrow, mi);
+
+       --mi.base.macro_nesting;
+
+       MathRow::Element e_end(MathRow::END_MACRO, mi);
+       e_end.macro = this;
+       mrow.push_back(e_end);
+
+       return has_contents;
 }
 
 
@@ -407,20 +448,25 @@ bool MathMacro::editMetrics(BufferView const * bv) const
 
 void MathMacro::metrics(MetricsInfo & mi, Dimension & dim) const
 {
+       // the macro contents is not editable (except the arguments)
+       ++mi.base.macro_nesting;
+
        // set edit mode for which we will have calculated metrics. But only
        d->editing_[mi.base.bv] = editMode(mi.base.bv);
 
        // calculate new metrics according to display mode
        if (d->displayMode_ == DISPLAY_INIT || d->displayMode_ == DISPLAY_INTERACTIVE_INIT) {
+               Changer dummy = mi.base.changeFontSet("lyxtex");
                mathed_string_dim(mi.base.font, from_ascii("\\") + name(), dim);
        } else if (d->displayMode_ == DISPLAY_UNFOLDED) {
+               Changer dummy = mi.base.changeFontSet("lyxtex");
                cell(0).metrics(mi, dim);
                Dimension bsdim;
                mathed_string_dim(mi.base.font, from_ascii("\\"), bsdim);
                dim.wid += bsdim.width() + 1;
                dim.asc = max(bsdim.ascent(), dim.ascent());
                dim.des = max(bsdim.descent(), dim.descent());
-               metricsMarkers(dim);
+               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:
@@ -460,10 +506,14 @@ void MathMacro::metrics(MetricsInfo & mi, Dimension & dim) const
                dim.asc += 1;
                dim.des += 1;
                dim.wid += 2;
-               metricsMarkers2(dim);
+               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);
@@ -495,6 +545,9 @@ void MathMacro::metrics(MetricsInfo & mi, Dimension & dim) const
                        dim.des += 2;
                }
        }
+
+       // restore macro nesting
+       --mi.base.macro_nesting;
 }
 
 
@@ -663,10 +716,13 @@ void MathMacro::draw(PainterInfo & pi, int x, int y) const
                                  dim.height() - 2, Color_mathmacroframe);
                drawMarkers2(pi, expx, expy);
        } else {
+               // the macro contents is not editable (except the arguments)
+               ++pi.base.macro_nesting;
+
                bool drawBox = lyxrc.macro_edit_style == LyXRC::MACRO_EDIT_INLINE_BOX;
-               bool upshape = currentMode() == TEXT_MODE;
-               Changer dummy = pi.base.font.changeShape(upshape ? UP_SHAPE
-                                                       : pi.base.font.shape());
+               Changer dummy = (currentMode() == TEXT_MODE)
+                       ? pi.base.font.changeShape(UP_SHAPE)
+                       : Changer();
 
                // warm up cells
                for (size_t i = 0; i < nargs(); ++i)
@@ -697,8 +753,11 @@ void MathMacro::draw(PainterInfo & pi, int x, int y) const
                } else
                        d->expanded_.draw(pi, expx, expy);
 
+               --pi.base.macro_nesting;
+
                if (!drawBox)
                        drawMarkers(pi, x, y);
+
        }
 
        // edit mode changed?
@@ -1009,6 +1068,15 @@ void MathMacro::write(WriteStream & os) const
        // we should be ok to continue even if this fails.
        LATTEST(d->macro_);
 
+       // We may already be in the argument of a macro
+       bool const inside_macro = os.insideMacro();
+       os.insideMacro(true);
+
+       // Enclose in braces to avoid latex errors with xargs if we have
+       // optional arguments and are in the optional argument of a macro
+       if (d->optionals_ && inside_macro)
+               os << '{';
+
        // Always protect macros in a fragile environment
        if (os.fragile())
                os << "\\protect";
@@ -1047,9 +1115,13 @@ void MathMacro::write(WriteStream & os) const
                first = false;
        }
 
-       // add space if there was no argument
-       if (first)
+       // Close the opened brace or add space if there was no argument
+       if (d->optionals_ && inside_macro)
+               os << '}';
+       else if (first)
                os.pendingSpace(true);
+
+       os.insideMacro(inside_macro);
 }