2 * \file InsetMathMacroTemplate.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
7 * \author Stefan Schimanski
9 * Full author contact details are available in file CREDITS.
14 #include "InsetMathMacroTemplate.h"
16 #include "InsetMathBrace.h"
17 #include "InsetMathChar.h"
18 #include "InsetMathHull.h"
19 #include "InsetMathSqrt.h"
20 #include "InsetMathMacro.h"
21 #include "InsetMathMacroArgument.h"
22 #include "MathStream.h"
23 #include "MathParser.h"
24 #include "MathSupport.h"
27 #include "BufferView.h"
30 #include "DispatchResult.h"
31 #include "DocIterator.h"
32 #include "FuncRequest.h"
33 #include "FuncStatus.h"
34 #include "LaTeXFeatures.h"
36 #include "MetricsInfo.h"
37 #include "TocBackend.h"
39 #include "frontends/Painter.h"
41 #include "insets/RenderPreview.h"
43 #include "support/lassert.h"
44 #include "support/convert.h"
45 #include "support/debug.h"
46 #include "support/gettext.h"
47 #include "support/docstream.h"
48 #include "support/lstrings.h"
57 using support::bformat;
59 //////////////////////////////////////////////////////////////////////
61 class InsetLabelBox : public InsetMathNest {
64 InsetLabelBox(Buffer * buf, MathAtom const & atom, docstring label,
65 InsetMathMacroTemplate const & parent, bool frame = false);
66 InsetLabelBox(Buffer * buf, docstring label, InsetMathMacroTemplate const & parent,
69 void metrics(MetricsInfo & mi, Dimension & dim) const override;
71 void draw(PainterInfo &, int x, int y) const override;
75 InsetMathMacroTemplate const & parent_;
77 Inset * clone() const override;
79 docstring const label_;
85 InsetLabelBox::InsetLabelBox(Buffer * buf, MathAtom const & atom, docstring label,
86 InsetMathMacroTemplate const & parent, bool frame)
87 : InsetMathNest(buf, 1), parent_(parent), label_(label), frame_(frame)
89 cell(0).insert(0, atom);
93 InsetLabelBox::InsetLabelBox(Buffer * buf, docstring label,
94 InsetMathMacroTemplate const & parent, bool frame)
95 : InsetMathNest(buf, 1), parent_(parent), label_(label), frame_(frame)
100 Inset * InsetLabelBox::clone() const
102 return new InsetLabelBox(*this);
106 void InsetLabelBox::metrics(MetricsInfo & mi, Dimension & dim) const
109 cell(0).metrics(mi, dim);
118 // adjust to common height in main metrics phase
119 if (!parent_.premetrics()) {
120 dim.asc = max(dim.asc, parent_.commonLabelBoxAscent());
121 dim.des = max(dim.des, parent_.commonLabelBoxDescent());
125 if (parent_.editing(mi.base.bv) && label_.length() > 0) {
127 FontInfo font = sane_font;
128 font.setSize(TINY_SIZE);
129 font.setColor(Color_mathmacrolabel);
131 // make space for label and box
132 int lwid = mathed_string_width(font, label_);
135 math_font_max_dim(font, maxasc, maxdes);
137 dim.wid = max(dim.wid, lwid + 2);
139 // space for the label
140 if (!parent_.premetrics())
141 dim.des += maxasc + maxdes + 1;
146 void InsetLabelBox::draw(PainterInfo & pi, int x, int y) const
148 Dimension const dim = dimension(*pi.base.bv);
149 Dimension const cdim = cell(0).dimension(*pi.base.bv);
152 cell(0).draw(pi, x + (dim.wid - cdim.wid) / 2, y);
155 if (parent_.editing(pi.base.bv) && label_.length() > 0) {
157 FontInfo font = sane_font;
158 font.setSize(TINY_SIZE);
159 font.setColor(Color_mathmacrolabel);
161 // make space for label and box
162 int lwid = mathed_string_width(font, label_);
165 math_font_max_dim(font, maxasc, maxdes);
168 pi.pain.text(x + (dim.wid - lwid) / 2, y + dim.des - maxdes, label_, font);
170 pi.pain.text(x, y + dim.des - maxdes, label_, font);
174 int boxHeight = parent_.commonLabelBoxAscent() + parent_.commonLabelBoxDescent();
176 pi.pain.rectangle(x + 1, y - dim.ascent() + 1,
177 dim.wid - 2, boxHeight - 2,
183 //////////////////////////////////////////////////////////////////////
185 class InsetDisplayLabelBox : public InsetLabelBox {
188 InsetDisplayLabelBox(Buffer * buf, MathAtom const & atom, docstring label,
189 InsetMathMacroTemplate const & parent);
192 marker_type marker(BufferView const *) const override;
194 void metrics(MetricsInfo & mi, Dimension & dim) const override;
196 void draw(PainterInfo &, int x, int y) const override;
200 Inset * clone() const override;
204 InsetDisplayLabelBox::InsetDisplayLabelBox(Buffer * buf, MathAtom const & atom,
206 InsetMathMacroTemplate const & parent)
207 : InsetLabelBox(buf, atom, label, parent, true)
213 Inset * InsetDisplayLabelBox::clone() const
215 return new InsetDisplayLabelBox(*this);
219 marker_type InsetDisplayLabelBox::marker(BufferView const * bv) const
221 if (parent_.editing(bv)
222 || !parent_.cell(parent_.displayIdx()).empty())
223 return marker_type::MARKER;
225 return marker_type::NO_MARKER;
229 void InsetDisplayLabelBox::metrics(MetricsInfo & mi, Dimension & dim) const
231 InsetLabelBox::metrics(mi, dim);
232 if (!parent_.editing(mi.base.bv)
233 && parent_.cell(parent_.displayIdx()).empty())
238 void InsetDisplayLabelBox::draw(PainterInfo & pi, int x, int y) const
240 if (parent_.editing(pi.base.bv)
241 || !parent_.cell(parent_.displayIdx()).empty()
243 InsetLabelBox::draw(pi, x, y);
247 //////////////////////////////////////////////////////////////////////
249 class InsetMathWrapper : public InsetMath {
252 explicit InsetMathWrapper(MathData const * value) : value_(value) {}
254 void metrics(MetricsInfo & mi, Dimension & dim) const override;
256 void draw(PainterInfo &, int x, int y) const override;
260 Inset * clone() const override;
262 MathData const * value_;
266 Inset * InsetMathWrapper::clone() const
268 return new InsetMathWrapper(*this);
272 void InsetMathWrapper::metrics(MetricsInfo & mi, Dimension & dim) const
274 value_->metrics(mi, dim);
278 void InsetMathWrapper::draw(PainterInfo & pi, int x, int y) const
280 value_->draw(pi, x, y);
284 ///////////////////////////////////////////////////////////////////////
285 class InsetColoredCell : public InsetMathNest {
288 InsetColoredCell(Buffer * buf, ColorCode blend);
290 InsetColoredCell(Buffer * buf, ColorCode blend, MathAtom const & atom);
292 void draw(PainterInfo &, int x, int y) const override;
294 void metrics(MetricsInfo & mi, Dimension & dim) const override;
298 Inset * clone() const override;
304 InsetColoredCell::InsetColoredCell(Buffer * buf, ColorCode blend)
305 : InsetMathNest(buf, 1), blend_(blend)
310 InsetColoredCell::InsetColoredCell(Buffer * buf, ColorCode blend, MathAtom const & atom)
311 : InsetMathNest(buf, 1), blend_(blend)
313 cell(0).insert(0, atom);
317 Inset * InsetColoredCell::clone() const
319 return new InsetColoredCell(*this);
323 void InsetColoredCell::metrics(MetricsInfo & mi, Dimension & dim) const
325 cell(0).metrics(mi, dim);
329 void InsetColoredCell::draw(PainterInfo & pi, int x, int y) const
331 pi.pain.enterMonochromeMode(blend_);
332 cell(0).draw(pi, x, y);
333 pi.pain.leaveMonochromeMode();
337 ///////////////////////////////////////////////////////////////////////
339 class InsetNameWrapper : public InsetMathWrapper {
342 InsetNameWrapper(MathData const * value, InsetMathMacroTemplate const & parent);
344 void metrics(MetricsInfo & mi, Dimension & dim) const override;
346 void draw(PainterInfo &, int x, int y) const override;
350 InsetMathMacroTemplate const & parent_;
352 Inset * clone() const override;
356 InsetNameWrapper::InsetNameWrapper(MathData const * value,
357 InsetMathMacroTemplate const & parent)
358 : InsetMathWrapper(value), parent_(parent)
363 Inset * InsetNameWrapper::clone() const
365 return new InsetNameWrapper(*this);
369 void InsetNameWrapper::metrics(MetricsInfo & mi, Dimension & dim) const
371 Changer dummy = mi.base.changeFontSet("textit");
372 InsetMathWrapper::metrics(mi, dim);
373 dim.wid += mathed_string_width(mi.base.font, from_ascii("\\"));
377 void InsetNameWrapper::draw(PainterInfo & pi, int x, int y) const
379 ColorCode const color = parent_.validMacro() ? Color_latex : Color_error;
381 Changer dummy = pi.base.changeFontSet("textit");
382 Changer dummy2 = pi.base.font.changeColor(color);
385 pi.pain.text(x, y, from_ascii("\\"), pi.base.font);
386 x += mathed_string_width(pi.base.font, from_ascii("\\"));
389 InsetMathWrapper::draw(pi, x, y);
393 ///////////////////////////////////////////////////////////////////////
396 InsetMathMacroTemplate::InsetMathMacroTemplate(Buffer * buf)
397 : InsetMathNest(buf, 3), numargs_(0), argsInLook_(0), optionals_(0),
398 type_(MacroTypeNewcommand), redefinition_(false), lookOutdated_(true),
399 premetrics_(false), labelBoxAscent_(0), labelBoxDescent_(0)
405 InsetMathMacroTemplate::InsetMathMacroTemplate(Buffer * buf, docstring const & name, int numargs,
406 int optionals, MacroType type, vector<MathData> const & optionalValues,
407 MathData const & def, MathData const & display)
408 : InsetMathNest(buf, optionals + 3), numargs_(numargs), argsInLook_(numargs),
409 optionals_(optionals), optionalValues_(optionalValues),
410 type_(type), redefinition_(false), lookOutdated_(true),
411 premetrics_(false), labelBoxAscent_(0), labelBoxDescent_(0)
416 lyxerr << "InsetMathMacroTemplate::InsetMathMacroTemplate: wrong # of arguments: "
419 asArray(name, cell(0));
420 optionalValues_.resize(9);
421 for (int i = 0; i < optionals_; ++i)
422 cell(optIdx(i)) = optionalValues_[i];
423 cell(defIdx()) = def;
424 cell(displayIdx()) = display;
430 bool InsetMathMacroTemplate::fromString(docstring const & str)
432 MathData ar(buffer_);
433 mathed_parse_cell(ar, str, Parse::NORMAL);
434 if (ar.size() != 1 || !ar[0]->asMacroTemplate()) {
435 lyxerr << "Cannot read macro from '" << ar << "'" << endl;
436 asArray(from_ascii("invalidmacro"), cell(0));
437 // The macro template does not make sense after this.
440 operator=( *(ar[0]->asMacroTemplate()) );
447 Inset * InsetMathMacroTemplate::clone() const
449 InsetMathMacroTemplate * inset = new InsetMathMacroTemplate(*this);
450 // the parent pointers of the proxy insets above will point to
451 // to the old template. Hence, the look must be updated.
457 docstring InsetMathMacroTemplate::name() const
459 return asString(cell(0));
463 void InsetMathMacroTemplate::updateToContext(MacroContext const & mc)
465 redefinition_ = mc.get(name()) != 0;
469 void InsetMathMacroTemplate::updateLook() const
471 lookOutdated_ = true;
475 void InsetMathMacroTemplate::createLook(int args) const
481 look_.push_back(MathAtom(
482 new InsetLabelBox(buffer_, _("Name"), *this, false)));
483 MathData & nameData = look_[look_.size() - 1].nucleus()->cell(0);
484 nameData.push_back(MathAtom(new InsetNameWrapper(&cell(0), *this)));
488 if (optionals_ > 0) {
489 look_.push_back(MathAtom(
490 new InsetLabelBox(buffer_, _("optional"), *this, false)));
492 MathData * optData = &look_[look_.size() - 1].nucleus()->cell(0);
493 for (; i < optionals_; ++i) {
494 // color it light grey, if it is to be removed when the cursor leaves
495 if (i == argsInLook_) {
496 optData->push_back(MathAtom(
497 new InsetColoredCell(buffer_, Color_mathmacrooldarg)));
498 optData = &(*optData)[optData->size() - 1].nucleus()->cell(0);
501 optData->push_back(MathAtom(new InsetMathChar('[')));
502 optData->push_back(MathAtom(new InsetMathWrapper(&cell(1 + i))));
503 optData->push_back(MathAtom(new InsetMathChar(']')));
508 for (; i < numargs_; ++i) {
510 arg.push_back(MathAtom(new InsetMathMacroArgument(i + 1)));
511 if (i >= argsInLook_) {
512 look_.push_back(MathAtom(new InsetColoredCell(buffer_,
513 Color_mathmacrooldarg,
514 MathAtom(new InsetMathBrace(arg)))));
516 look_.push_back(MathAtom(new InsetMathBrace(arg)));
518 for (; i < argsInLook_; ++i) {
520 arg.push_back(MathAtom(new InsetMathMacroArgument(i + 1)));
521 look_.push_back(MathAtom(new InsetColoredCell(buffer_,
522 Color_mathmacronewarg,
523 MathAtom(new InsetMathBrace(arg)))));
527 look_.push_back(MathAtom(new InsetMathChar(':')));
528 look_.push_back(MathAtom(new InsetMathChar('=')));
531 look_.push_back(MathAtom(
532 new InsetLabelBox(buffer_, MathAtom(
533 new InsetMathWrapper(&cell(defIdx()))), _("TeX"), *this, true)));
536 look_.push_back(MathAtom(
537 new InsetDisplayLabelBox(buffer_, MathAtom(
538 new InsetMathWrapper(&cell(displayIdx()))), _("LyX"), *this)));
542 void InsetMathMacroTemplate::metrics(MetricsInfo & mi, Dimension & dim) const
544 Changer dummy1 = mi.base.changeFontSet("mathnormal");
545 Changer dummy2 = mi.base.font.changeStyle(TEXT_STYLE);
548 MacroData const * macro = 0;
550 macro = mi.macrocontext.get(name());
553 int argsInDef = maxArgumentInDefinition();
554 if (lookOutdated_ || argsInDef != argsInLook_) {
555 lookOutdated_ = false;
556 createLook(argsInDef);
559 /// metrics for inset contents
563 // first phase, premetric:
565 look_.metrics(mi, dim);
566 labelBoxAscent_ = dim.asc;
567 labelBoxDescent_ = dim.des;
569 // second phase, main metric:
571 look_.metrics(mi, dim);
576 dim.wid += leftOffset(mi.base.bv) + rightOffset(mi.base.bv);
577 dim.des += bottomOffset(mi.base.bv);
578 dim.asc += topOffset(mi.base.bv);
582 void InsetMathMacroTemplate::draw(PainterInfo & pi, int x, int y) const
584 // FIXME: Calling Changer on the same object repeatedly is inefficient.
585 Changer dummy0 = pi.base.font.changeColor(Color_math);
586 Changer dummy1 = pi.base.changeFontSet("mathnormal");
587 Changer dummy2 = pi.base.font.changeStyle(TEXT_STYLE);
589 Dimension const dim = dimension(*pi.base.bv);
592 int const hoffset = leftOffset(pi.base.bv) + rightOffset(pi.base.bv);
593 int const voffset = topOffset(pi.base.bv) + bottomOffset(pi.base.bv);
594 int const a = y - dim.asc + topOffset(pi.base.bv) / 2;
595 int const w = dim.wid - (hoffset - hoffset / 2);
596 int const h = dim.height() - (voffset - voffset / 2);
597 pi.pain.rectangle(x + leftOffset(pi.base.bv) / 2, a, w, h, Color_mathframe);
599 // just to be sure: set some dummy values for coord cache
600 for (idx_type i = 0; i < nargs(); ++i)
601 cell(i).setXY(*pi.base.bv, x, y);
604 look_.draw(pi, x + leftOffset(pi.base.bv), y);
608 void InsetMathMacroTemplate::edit(Cursor & cur, bool front, EntryDirection entry_from)
611 cur.screenUpdateFlags(Update::SinglePar);
612 InsetMathNest::edit(cur, front, entry_from);
616 bool InsetMathMacroTemplate::notifyCursorLeaves(Cursor const & old, Cursor & cur)
618 unsigned int const nargs_before = nargs();
619 commitEditChanges(cur, old);
621 cur.screenUpdateFlags(Update::Force);
622 // If we have removed a cell, we might have invalidated the cursor
623 return InsetMathNest::notifyCursorLeaves(old, cur)
624 || nargs() < nargs_before;
628 void InsetMathMacroTemplate::removeArguments(Cursor & cur,
629 DocIterator const & /*inset_pos*/, int from, int to)
631 DocIterator it = doc_iterator_begin(&buffer(), this);
632 for (; it; it.forwardChar()) {
635 if (it.nextInset()->lyxCode() != MATH_MACROARG_CODE)
637 InsetMathMacroArgument * arg = static_cast<InsetMathMacroArgument*>(it.nextInset());
638 int n = arg->number() - 1;
639 if (from <= n && n <= to) {
640 int cellSlice = cur.find(it.cell());
641 if (cellSlice != -1 && cur[cellSlice].pos() > it.pos())
642 --cur[cellSlice].pos();
644 it.cell().erase(it.pos());
652 void InsetMathMacroTemplate::shiftArguments(size_t from, int by)
654 for (DocIterator it = doc_iterator_begin(&buffer(), this); it; it.forwardChar()) {
657 if (it.nextInset()->lyxCode() != MATH_MACROARG_CODE)
659 InsetMathMacroArgument * arg = static_cast<InsetMathMacroArgument*>(it.nextInset());
660 if (arg->number() >= int(from) + 1)
661 arg->setNumber(arg->number() + by);
668 int InsetMathMacroTemplate::maxArgumentInDefinition() const
670 // We don't have a buffer when pasting from the clipboard (bug 6014).
671 Buffer const * macro_buffer = isBufferLoaded() ? &buffer() : 0;
673 DocIterator it = doc_iterator_begin(macro_buffer, this);
675 for (; it; it.forwardChar()) {
678 if (it.nextInset()->lyxCode() != MATH_MACROARG_CODE)
680 InsetMathMacroArgument * arg = static_cast<InsetMathMacroArgument*>(it.nextInset());
681 maxArg = std::max(arg->number(), maxArg);
687 void InsetMathMacroTemplate::insertMissingArguments(int maxArg)
689 bool found[9] = { false, false, false, false, false, false, false, false, false };
690 idx_type idx = cell(displayIdx()).empty() ? defIdx() : displayIdx();
692 // search for #n macros arguments
693 DocIterator it = doc_iterator_begin(&buffer(), this);
695 for (; it && it[0].idx() == idx; it.forwardChar()) {
698 if (it.nextInset()->lyxCode() != MATH_MACROARG_CODE)
700 InsetMathMacroArgument * arg = static_cast<InsetMathMacroArgument*>(it.nextInset());
701 found[arg->number() - 1] = true;
705 for (int i = 0; i < maxArg; ++i) {
709 cell(idx).push_back(MathAtom(new InsetMathMacroArgument(i + 1)));
714 void InsetMathMacroTemplate::changeArity(Cursor & cur,
715 DocIterator const & inset_pos, int newNumArg)
717 // remove parameter which do not appear anymore in the definition
718 for (int i = numargs_; i > newNumArg; --i)
719 removeParameter(cur, inset_pos, numargs_ - 1, true);
721 // add missing parameter
722 for (int i = numargs_; i < newNumArg; ++i)
723 insertParameter(cur, inset_pos, numargs_, true, false);
728 class AddRemoveMacroInstanceFix
732 AddRemoveMacroInstanceFix(int n, bool insert) : n_(n), insert_(insert) {}
734 void operator()(InsetMathMacro * macro)
736 if (macro->folded()) {
738 macro->insertArgument(n_);
740 macro->removeArgument(n_);
753 class OptionalsMacroInstanceFix
757 explicit OptionalsMacroInstanceFix(int optionals) : optionals_(optionals) {}
759 void operator()(InsetMathMacro * macro)
761 macro->setOptionals(optionals_);
771 class NullMacroInstanceFix
775 void operator()(InsetMathMacro * ) {}
780 void fixMacroInstances(Cursor & cur, DocIterator const & inset_pos,
781 docstring const & name, F & fix)
783 // goto position behind macro template
784 DocIterator dit = inset_pos;
786 dit.top().forwardPos();
788 // remember hull to trigger preview reload
789 DocIterator hull(dit.buffer());
790 bool preview_reload_needed = false;
791 set<DocIterator> preview_hulls;
793 // iterate over all positions until macro is redefined
794 for (; dit; dit.forwardPos()) {
795 // left the outer hull?
796 if (!hull.empty() && dit.depth() == hull.depth()) {
797 // schedule reload of the preview if necessary
798 if (preview_reload_needed) {
799 preview_hulls.insert(hull);
800 preview_reload_needed = false;
805 // only until a macro is redefined
806 if (dit.inset().lyxCode() == MATHMACRO_CODE) {
807 InsetMathMacroTemplate const & macroTemplate
808 = static_cast<InsetMathMacroTemplate const &>(dit.inset());
809 if (macroTemplate.name() == name)
813 // in front of macro instance?
814 Inset * inset = dit.nextInset();
817 InsetMath * insetMath = inset->asInsetMath();
821 // in front of outer hull?
822 InsetMathHull * inset_hull = insetMath->asHullInset();
823 if (inset_hull && hull.empty()) {
824 // remember this for later preview reload
828 InsetMathMacro * macro = insetMath->asMacro();
829 if (macro && macro->name() == name && macro->folded()) {
831 if (RenderPreview::previewMath())
832 preview_reload_needed = true;
836 if (!preview_hulls.empty()) {
837 // reload the scheduled previews
838 set<DocIterator>::const_iterator sit = preview_hulls.begin();
839 set<DocIterator>::const_iterator end = preview_hulls.end();
840 for (; sit != end; ++sit) {
841 InsetMathHull * inset_hull =
842 sit->nextInset()->asInsetMath()->asHullInset();
844 inset_hull->reloadPreview(*sit);
846 cur.screenUpdateFlags(Update::Force);
851 void InsetMathMacroTemplate::commitEditChanges(Cursor & cur,
852 DocIterator const & inset_pos)
854 int args_in_def = maxArgumentInDefinition();
855 if (args_in_def != numargs_) {
856 // FIXME: implement precise undo handling (only a few places
858 cur.recordUndoFullBuffer();
859 changeArity(cur, inset_pos, args_in_def);
861 insertMissingArguments(args_in_def);
863 // make sure the preview are up to date
864 NullMacroInstanceFix fix;
865 fixMacroInstances(cur, inset_pos, name(), fix);
869 void InsetMathMacroTemplate::insertParameter(Cursor & cur,
870 DocIterator const & inset_pos, int pos, bool greedy, bool addarg)
872 if (pos <= numargs_ && pos >= optionals_ && numargs_ < 9) {
877 shiftArguments(pos, 1);
879 cell(defIdx()).push_back(MathAtom(new InsetMathMacroArgument(pos + 1)));
880 if (!cell(displayIdx()).empty())
881 cell(displayIdx()).push_back(MathAtom(new InsetMathMacroArgument(pos + 1)));
885 // fix macro instances
886 AddRemoveMacroInstanceFix fix(pos, true);
887 fixMacroInstances(cur, inset_pos, name(), fix);
895 void InsetMathMacroTemplate::removeParameter(Cursor & cur,
896 DocIterator const & inset_pos, int pos, bool greedy)
898 if (pos < numargs_ && pos >= 0) {
900 removeArguments(cur, inset_pos, pos, pos);
901 shiftArguments(pos + 1, -1);
903 // removed optional parameter?
904 if (pos < optionals_) {
906 optionalValues_[pos] = cell(optIdx(pos));
907 cells_.erase(cells_.begin() + optIdx(pos));
910 int macroSlice = cur.find(this);
911 if (macroSlice != -1) {
912 if (cur[macroSlice].idx() == optIdx(pos)) {
913 cur.cutOff(macroSlice);
914 cur[macroSlice].idx() = 1;
915 cur[macroSlice].pos() = 0;
916 } else if (cur[macroSlice].idx() > optIdx(pos))
917 --cur[macroSlice].idx();
922 // fix macro instances
923 AddRemoveMacroInstanceFix fix(pos, false);
924 fixMacroInstances(cur, inset_pos, name(), fix);
932 void InsetMathMacroTemplate::makeOptional(Cursor & cur,
933 DocIterator const & inset_pos)
935 if (numargs_ > 0 && optionals_ < numargs_) {
937 cells_.insert(cells_.begin() + optIdx(optionals_ - 1), optionalValues_[optionals_ - 1]);
939 int macroSlice = cur.find(this);
940 if (macroSlice != -1 && cur[macroSlice].idx() >= optIdx(optionals_ - 1))
941 ++cur[macroSlice].idx();
943 // fix macro instances
944 OptionalsMacroInstanceFix fix(optionals_);
945 fixMacroInstances(cur, inset_pos, name(), fix);
952 void InsetMathMacroTemplate::makeNonOptional(Cursor & cur,
953 DocIterator const & inset_pos)
955 if (numargs_ > 0 && optionals_ > 0) {
958 // store default value for later if the user changes his mind
959 optionalValues_[optionals_] = cell(optIdx(optionals_));
960 cells_.erase(cells_.begin() + optIdx(optionals_));
963 int macroSlice = cur.find(this);
964 if (macroSlice != -1) {
965 if (cur[macroSlice].idx() > optIdx(optionals_))
966 --cur[macroSlice].idx();
967 else if (cur[macroSlice].idx() == optIdx(optionals_)) {
968 cur.cutOff(macroSlice);
969 cur[macroSlice].idx() = optIdx(optionals_);
970 cur[macroSlice].pos() = 0;
974 // fix macro instances
975 OptionalsMacroInstanceFix fix(optionals_);
976 fixMacroInstances(cur, inset_pos, name(), fix);
983 void InsetMathMacroTemplate::doDispatch(Cursor & cur, FuncRequest & cmd)
985 string const arg = to_utf8(cmd.argument());
986 switch (cmd.action()) {
988 case LFUN_MATH_MACRO_ADD_PARAM:
990 commitEditChanges(cur, cur);
991 // FIXME: implement precise undo handling (only a few places
993 cur.recordUndoFullBuffer();
994 size_t pos = numargs_;
996 pos = (size_t)convert<int>(arg) - 1; // it is checked for >=0 in getStatus
997 insertParameter(cur, cur, pos);
1002 case LFUN_MATH_MACRO_REMOVE_PARAM:
1004 commitEditChanges(cur, cur);
1005 // FIXME: implement precise undo handling (only a few places
1007 cur.recordUndoFullBuffer();
1008 size_t pos = numargs_ - 1;
1010 pos = (size_t)convert<int>(arg) - 1; // it is checked for >=0 in getStatus
1011 removeParameter(cur, cur, pos);
1015 case LFUN_MATH_MACRO_APPEND_GREEDY_PARAM:
1017 commitEditChanges(cur, cur);
1018 // FIXME: implement precise undo handling (only a few places
1020 cur.recordUndoFullBuffer();
1021 insertParameter(cur, cur, numargs_, true);
1025 case LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM:
1027 commitEditChanges(cur, cur);
1028 // FIXME: implement precise undo handling (only a few places
1030 cur.recordUndoFullBuffer();
1031 removeParameter(cur, cur, numargs_ - 1, true);
1035 case LFUN_MATH_MACRO_MAKE_OPTIONAL:
1036 commitEditChanges(cur, cur);
1037 // FIXME: implement precise undo handling (only a few places
1039 cur.recordUndoFullBuffer();
1040 makeOptional(cur, cur);
1043 case LFUN_MATH_MACRO_MAKE_NONOPTIONAL:
1044 commitEditChanges(cur, cur);
1045 // FIXME: implement precise undo handling (only a few places
1047 cur.recordUndoFullBuffer();
1048 makeNonOptional(cur, cur);
1051 case LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM:
1053 commitEditChanges(cur, cur);
1054 // FIXME: implement precise undo handling (only a few places
1056 cur.recordUndoFullBuffer();
1057 insertParameter(cur, cur, optionals_);
1058 makeOptional(cur, cur);
1062 case LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM:
1063 if (optionals_ > 0) {
1064 commitEditChanges(cur, cur);
1065 // FIXME: implement precise undo handling (only a few places
1067 cur.recordUndoFullBuffer();
1068 removeParameter(cur, cur, optionals_ - 1);
1071 case LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM:
1072 if (numargs_ == optionals_) {
1073 commitEditChanges(cur, cur);
1074 // FIXME: implement precise undo handling (only a few places
1076 cur.recordUndoFullBuffer();
1077 insertParameter(cur, cur, 0, true);
1078 makeOptional(cur, cur);
1083 InsetMathNest::doDispatch(cur, cmd);
1089 bool InsetMathMacroTemplate::getStatus(Cursor & cur, FuncRequest const & cmd,
1090 FuncStatus & status) const
1093 string const arg = to_utf8(cmd.argument());
1094 switch (cmd.action()) {
1095 case LFUN_MATH_MACRO_ADD_PARAM: {
1096 int num = numargs_ + 1;
1098 num = convert<int>(arg);
1099 bool on = (num >= optionals_
1100 && numargs_ < 9 && num <= numargs_ + 1);
1101 status.setEnabled(on);
1105 case LFUN_MATH_MACRO_APPEND_GREEDY_PARAM:
1106 status.setEnabled(numargs_ < 9);
1109 case LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM:
1110 case LFUN_MATH_MACRO_REMOVE_PARAM: {
1113 num = convert<int>(arg);
1114 status.setEnabled(num >= 1 && num <= numargs_);
1118 case LFUN_MATH_MACRO_MAKE_OPTIONAL:
1119 status.setEnabled(numargs_ > 0
1120 && optionals_ < numargs_
1121 && type_ != MacroTypeDef);
1124 case LFUN_MATH_MACRO_MAKE_NONOPTIONAL:
1125 status.setEnabled(optionals_ > 0
1126 && type_ != MacroTypeDef);
1129 case LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM:
1130 status.setEnabled(numargs_ < 9);
1133 case LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM:
1134 status.setEnabled(optionals_ > 0);
1137 case LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM:
1138 status.setEnabled(numargs_ == 0
1139 && type_ != MacroTypeDef);
1142 case LFUN_IN_MATHMACROTEMPLATE:
1143 status.setEnabled(true);
1147 ret = InsetMathNest::getStatus(cur, cmd, status);
1154 void InsetMathMacroTemplate::read(Lexer & lex)
1156 MathData ar(buffer_);
1157 mathed_parse_cell(ar, lex.getStream(), Parse::TRACKMACRO);
1158 if (ar.size() != 1 || !ar[0]->asMacroTemplate()) {
1159 lyxerr << "Cannot read macro from '" << ar << "'" << endl;
1160 lyxerr << "Read: " << to_utf8(asString(ar)) << endl;
1163 operator=( *(ar[0]->asMacroTemplate()) );
1169 void InsetMathMacroTemplate::write(ostream & os) const
1171 odocstringstream oss;
1172 otexrowstream ots(oss);
1173 TeXMathStream wi(ots, false, false, TeXMathStream::wsDefault);
1174 oss << "FormulaMacro\n";
1176 os << to_utf8(oss.str());
1180 void InsetMathMacroTemplate::write(TeXMathStream & os) const
1186 int InsetMathMacroTemplate::write(TeXMathStream & os, bool overwriteRedefinition) const
1191 if (optionals_ > 0) {
1192 // macros with optionals use the xargs package, e.g.:
1193 // \newcommandx{\foo}[2][usedefault, addprefix=\global,1=default]{#1,#2}
1194 // \long is implicit by xargs
1195 if (redefinition_ && !overwriteRedefinition)
1196 os << "\\renewcommandx";
1198 os << "\\newcommandx";
1200 os << "\\" << name()
1201 << "[" << numargs_ << "]"
1202 << "[usedefault, addprefix=\\global";
1203 for (int i = 0; i < optionals_; ++i) {
1204 docstring optValue = asString(cell(optIdx(i)));
1205 if (optValue.find(']') != docstring::npos
1206 || optValue.find(',') != docstring::npos)
1207 os << ", " << i + 1 << "="
1208 << "{" << cell(optIdx(i)) << "}";
1210 os << ", " << i + 1 << "="
1215 // Macros without optionals use standard _global_ \def macros:
1216 // \global\def\long\foo#1#2{#1,#2}
1217 // We use the \long prefix as this is the equivalent to \newcommand.
1218 // We cannot use \newcommand directly because \global does not work with it.
1219 os << "\n\\global\\long\\def\\" << name();
1220 docstring param = from_ascii("#0");
1221 for (int i = 1; i <= numargs_; ++i) {
1227 // in LyX output we use some pseudo syntax which is implementation
1228 // independent, e.g.
1229 // \newcommand{\foo}[2][default]{#1,#2}
1230 if (redefinition_ && !overwriteRedefinition)
1231 os << "\\renewcommand";
1233 os << "\\newcommand";
1234 os << "{\\" << name() << '}';
1236 os << '[' << numargs_ << ']';
1238 for (int i = 0; i < optionals_; ++i) {
1239 docstring optValue = asString(cell(optIdx(i)));
1240 if (optValue.find(']') != docstring::npos)
1241 os << "[{" << cell(optIdx(i)) << "}]";
1243 os << "[" << cell(optIdx(i)) << "]";
1247 os << "{" << cell(defIdx()) << "}";
1250 // writing .tex. done.
1254 // writing .lyx, write special .tex export only if necessary
1255 if (!cell(displayIdx()).empty()) {
1256 os << "\n{" << cell(displayIdx()) << '}';
1265 docstring InsetMathMacroTemplate::xhtml(XMLStream &, OutputParams const &) const
1270 int InsetMathMacroTemplate::plaintext(odocstringstream & os,
1271 OutputParams const &, size_t) const
1273 docstring const str = '[' + buffer().B_("math macro") + ']';
1280 bool InsetMathMacroTemplate::validName() const
1282 docstring n = name();
1287 // converting back and force doesn't swallow anything?
1290 if (asString(ma) != n)
1293 // valid characters?
1295 for (char_type c : n) {
1296 if (!(c >= 'a' && c <= 'z')
1297 && !(c >= 'A' && c <= 'Z')
1307 bool InsetMathMacroTemplate::validMacro() const
1313 bool InsetMathMacroTemplate::fixNameAndCheckIfValid()
1315 // check all the characters/insets in the name cell
1317 MathData & data = cell(0);
1318 while (i < data.size()) {
1319 InsetMathChar const * cinset = data[i]->asCharInset();
1321 // valid character in [a-zA-Z]?
1322 char_type c = cinset->getChar();
1323 if ((c >= 'a' && c <= 'z')
1324 || (c >= 'A' && c <= 'Z')) {
1334 // now it should be valid if anything in the name survived
1335 return !data.empty();
1339 void InsetMathMacroTemplate::validate(LaTeXFeatures & features) const
1341 // we need global optional macro arguments. They are not available
1342 // with \def, and \newcommand does not support global macros. So we
1343 // are bound to xargs also for the single-optional-parameter case.
1345 features.require("xargs");
1348 void InsetMathMacroTemplate::getDefaults(vector<docstring> & defaults) const
1350 defaults.resize(numargs_);
1351 for (int i = 0; i < optionals_; ++i)
1352 defaults[i] = asString(cell(optIdx(i)));
1356 docstring InsetMathMacroTemplate::definition() const
1358 return asString(cell(defIdx()));
1362 docstring InsetMathMacroTemplate::displayDefinition() const
1364 return asString(cell(displayIdx()));
1368 size_t InsetMathMacroTemplate::numArgs() const
1374 size_t InsetMathMacroTemplate::numOptionals() const
1380 void InsetMathMacroTemplate::infoize(odocstream & os) const
1382 os << bformat(_("Math Macro: \\%1$s"), name());
1386 string InsetMathMacroTemplate::contextMenuName() const
1388 return "context-math-macro-definition";
1392 void InsetMathMacroTemplate::addToToc(DocIterator const & pit, bool output_active,
1393 UpdateType, TocBackend & backend) const
1397 str = bformat(_("Invalid macro! \\%1$s"), name());
1399 str = "\\" + name();
1400 TocBuilder & b = backend.builder("math-macro");
1401 b.pushItem(pit, str, output_active);