2 * \file MathMacroTemplate.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 "MathMacroTemplate.h"
16 #include "DocIterator.h"
17 #include "LaTeXFeatures.h"
18 #include "InsetMathBrace.h"
19 #include "InsetMathChar.h"
20 #include "InsetMathSqrt.h"
21 #include "MathMacro.h"
22 #include "MathMacroArgument.h"
23 #include "MathStream.h"
24 #include "MathParser.h"
25 #include "MathSupport.h"
26 #include "MathMacroArgument.h"
29 #include "BufferView.h"
32 #include "DispatchResult.h"
33 #include "FuncRequest.h"
34 #include "FuncStatus.h"
38 #include "frontends/Painter.h"
40 #include "support/lassert.h"
41 #include "support/convert.h"
42 #include "support/debug.h"
43 #include "support/gettext.h"
44 #include "support/docstream.h"
45 #include "support/lstrings.h"
53 using support::bformat;
55 //////////////////////////////////////////////////////////////////////
57 class InsetLabelBox : public InsetMathNest {
60 InsetLabelBox(MathAtom const & atom, docstring label,
61 MathMacroTemplate const & parent, bool frame = false);
62 InsetLabelBox(docstring label, MathMacroTemplate const & parent,
65 void metrics(MetricsInfo & mi, Dimension & dim) const;
67 void draw(PainterInfo &, int x, int y) const;
71 MathMacroTemplate const & parent_;
73 Inset * clone() const;
75 docstring const label_;
81 InsetLabelBox::InsetLabelBox(MathAtom const & atom, docstring label,
82 MathMacroTemplate const & parent, bool frame)
83 : InsetMathNest(1), parent_(parent), label_(label), frame_(frame)
85 cell(0).insert(0, atom);
89 InsetLabelBox::InsetLabelBox(docstring label,
90 MathMacroTemplate const & parent, bool frame)
91 : InsetMathNest(1), parent_(parent), label_(label), frame_(frame)
96 Inset * InsetLabelBox::clone() const
98 return new InsetLabelBox(*this);
102 void InsetLabelBox::metrics(MetricsInfo & mi, Dimension & dim) const
105 cell(0).metrics(mi, dim);
114 // adjust to common height in main metrics phase
115 if (!parent_.premetrics()) {
116 dim.asc = max(dim.asc, parent_.commonLabelBoxAscent());
117 dim.des = max(dim.des, parent_.commonLabelBoxDescent());
121 if (parent_.editing(mi.base.bv) && label_.length() > 0) {
123 FontInfo font = sane_font;
124 font.setSize(FONT_SIZE_TINY);
125 font.setColor(Color_mathmacrolabel);
127 // make space for label and box
128 int lwid = mathed_string_width(font, label_);
131 math_font_max_dim(font, maxasc, maxdes);
133 dim.wid = max(dim.wid, lwid + 2);
135 // space for the label
136 if (!parent_.premetrics())
137 dim.des += maxasc + maxdes + 1;
142 void InsetLabelBox::draw(PainterInfo & pi, int x, int y) const
144 Dimension const dim = dimension(*pi.base.bv);
145 Dimension const cdim = cell(0).dimension(*pi.base.bv);
148 cell(0).draw(pi, x + (dim.wid - cdim.wid) / 2, y);
151 if (parent_.editing(pi.base.bv) && label_.length() > 0) {
153 FontInfo font = sane_font;
154 font.setSize(FONT_SIZE_TINY);
155 font.setColor(Color_mathmacrolabel);
157 // make space for label and box
158 int lwid = mathed_string_width(font, label_);
161 math_font_max_dim(font, maxasc, maxdes);
164 pi.pain.text(x + (dim.wid - lwid) / 2, y + dim.des - maxdes, label_, font);
166 pi.pain.text(x, y + dim.des - maxdes, label_, font);
170 int boxHeight = parent_.commonLabelBoxAscent() + parent_.commonLabelBoxDescent();
172 pi.pain.rectangle(x + 1, y - dim.ascent() + 1,
173 dim.wid - 2, boxHeight - 2,
179 //////////////////////////////////////////////////////////////////////
181 class DisplayLabelBox : public InsetLabelBox {
184 DisplayLabelBox(MathAtom const & atom, docstring label,
185 MathMacroTemplate const & parent);
188 void metrics(MetricsInfo & mi, Dimension & dim) const;
190 void draw(PainterInfo &, int x, int y) const;
194 Inset * clone() const;
198 DisplayLabelBox::DisplayLabelBox(MathAtom const & atom,
200 MathMacroTemplate const & parent)
201 : InsetLabelBox(atom, label, parent, true)
207 Inset * DisplayLabelBox::clone() const
209 return new DisplayLabelBox(*this);
213 void DisplayLabelBox::metrics(MetricsInfo & mi, Dimension & dim) const
215 InsetLabelBox::metrics(mi, dim);
216 if (!parent_.editing(mi.base.bv)
217 && parent_.cell(parent_.displayIdx()).empty()) {
225 void DisplayLabelBox::draw(PainterInfo & pi, int x, int y) const
227 if (parent_.editing(pi.base.bv)
228 || !parent_.cell(parent_.displayIdx()).empty()) {
229 InsetLabelBox::draw(pi, x, y);
231 bool enabled = pi.pain.isDrawingEnabled();
232 pi.pain.setDrawingEnabled(false);
233 InsetLabelBox::draw(pi, x, y);
234 pi.pain.setDrawingEnabled(enabled);
239 //////////////////////////////////////////////////////////////////////
241 class InsetMathWrapper : public InsetMath {
244 InsetMathWrapper(MathData const * value) : value_(value) {}
246 void metrics(MetricsInfo & mi, Dimension & dim) const;
248 void draw(PainterInfo &, int x, int y) const;
252 Inset * clone() const;
254 MathData const * value_;
258 Inset * InsetMathWrapper::clone() const
260 return new InsetMathWrapper(*this);
264 void InsetMathWrapper::metrics(MetricsInfo & mi, Dimension & dim) const
266 value_->metrics(mi, dim);
267 //metricsMarkers2(dim);
271 void InsetMathWrapper::draw(PainterInfo & pi, int x, int y) const
273 value_->draw(pi, x, y);
274 //drawMarkers(pi, x, y);
278 ///////////////////////////////////////////////////////////////////////
279 class InsetColoredCell : public InsetMathNest {
282 InsetColoredCell(ColorCode min, ColorCode max);
284 InsetColoredCell(ColorCode min, ColorCode max, MathAtom const & atom);
286 void draw(PainterInfo &, int x, int y) const;
288 void metrics(MetricsInfo & mi, Dimension & dim) const;
292 Inset * clone() const;
300 InsetColoredCell::InsetColoredCell(ColorCode min, ColorCode max)
301 : InsetMathNest(1), min_(min), max_(max)
306 InsetColoredCell::InsetColoredCell(ColorCode min, ColorCode max, MathAtom const & atom)
307 : InsetMathNest(1), min_(min), max_(max)
309 cell(0).insert(0, atom);
313 Inset * InsetColoredCell::clone() const
315 return new InsetColoredCell(*this);
319 void InsetColoredCell::metrics(MetricsInfo & mi, Dimension & dim) const
321 cell(0).metrics(mi, dim);
325 void InsetColoredCell::draw(PainterInfo & pi, int x, int y) const
327 pi.pain.enterMonochromeMode(min_, max_);
328 cell(0).draw(pi, x, y);
329 pi.pain.leaveMonochromeMode();
333 ///////////////////////////////////////////////////////////////////////
335 class InsetNameWrapper : public InsetMathWrapper {
338 InsetNameWrapper(MathData const * value, MathMacroTemplate const & parent);
340 void metrics(MetricsInfo & mi, Dimension & dim) const;
342 void draw(PainterInfo &, int x, int y) const;
346 MathMacroTemplate const & parent_;
348 Inset * clone() const;
352 InsetNameWrapper::InsetNameWrapper(MathData const * value,
353 MathMacroTemplate const & parent)
354 : InsetMathWrapper(value), parent_(parent)
359 Inset * InsetNameWrapper::clone() const
361 return new InsetNameWrapper(*this);
365 void InsetNameWrapper::metrics(MetricsInfo & mi, Dimension & dim) const
367 InsetMathWrapper::metrics(mi, dim);
368 dim.wid += mathed_string_width(mi.base.font, from_ascii("\\"));
372 void InsetNameWrapper::draw(PainterInfo & pi, int x, int y) const
375 PainterInfo namepi = pi;
376 if (parent_.validMacro())
377 namepi.base.font.setColor(Color_latex);
379 namepi.base.font.setColor(Color_error);
382 pi.pain.text(x, y, from_ascii("\\"), namepi.base.font);
383 x += mathed_string_width(namepi.base.font, from_ascii("\\"));
386 InsetMathWrapper::draw(namepi, x, y);
390 ///////////////////////////////////////////////////////////////////////
393 MathMacroTemplate::MathMacroTemplate()
394 : InsetMathNest(3), numargs_(0), argsInLook_(0), optionals_(0),
395 type_(MacroTypeNewcommand), lookOutdated_(true)
401 MathMacroTemplate::MathMacroTemplate(docstring const & name, int numargs,
402 int optionals, MacroType type,
403 vector<MathData> const & optionalValues,
404 MathData const & def, MathData const & display)
405 : InsetMathNest(optionals + 3), numargs_(numargs), argsInLook_(numargs),
406 optionals_(optionals), optionalValues_(optionalValues),
407 type_(type), lookOutdated_(true)
412 lyxerr << "MathMacroTemplate::MathMacroTemplate: wrong # of arguments: "
415 asArray(name, cell(0));
416 optionalValues_.resize(9);
417 for (int i = 0; i < optionals_; ++i)
418 cell(optIdx(i)) = optionalValues_[i];
419 cell(defIdx()) = def;
420 cell(displayIdx()) = display;
426 MathMacroTemplate::MathMacroTemplate(docstring const & str)
427 : InsetMathNest(3), numargs_(0), optionals_(0),
428 type_(MacroTypeNewcommand), lookOutdated_(true)
433 mathed_parse_cell(ar, str);
434 if (ar.size() != 1 || !ar[0]->asMacroTemplate()) {
435 lyxerr << "Cannot read macro from '" << ar << "'" << endl;
436 asArray(from_ascii("invalidmacro"), cell(0));
437 // FIXME: The macro template does not make sense after this.
438 // The whole parsing should not be in a constructor which
439 // has no chance to report failure.
442 operator=( *(ar[0]->asMacroTemplate()) );
448 Inset * MathMacroTemplate::clone() const
450 MathMacroTemplate * inset = new MathMacroTemplate(*this);
451 // the parent pointers of the proxy insets above will point to
452 // to the old template. Hence, the look must be updated.
458 docstring MathMacroTemplate::name() const
460 return asString(cell(0));
464 void MathMacroTemplate::updateToContext(MacroContext const & mc) const
466 redefinition_ = mc.get(name()) != 0;
470 void MathMacroTemplate::updateLook() const
472 lookOutdated_ = true;
476 void MathMacroTemplate::createLook(int args) const
482 look_.push_back(MathAtom(new InsetLabelBox(_("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(new InsetLabelBox(_("optional"), *this, false)));
491 MathData * optData = &look_[look_.size() - 1].nucleus()->cell(0);
492 for (; i < optionals_; ++i) {
493 // color it light grey, if it is to be removed when the cursor leaves
494 if (i == argsInLook_) {
495 optData->push_back(MathAtom(
496 new InsetColoredCell(Color_mathbg, Color_mathmacrooldarg)));
497 optData = &(*optData)[optData->size() - 1].nucleus()->cell(0);
500 optData->push_back(MathAtom(new InsetMathChar('[')));
501 optData->push_back(MathAtom(new InsetMathWrapper(&cell(1 + i))));
502 optData->push_back(MathAtom(new InsetMathChar(']')));
507 for (; i < numargs_; ++i) {
509 arg.push_back(MathAtom(new MathMacroArgument(i + 1)));
510 if (i >= argsInLook_) {
511 look_.push_back(MathAtom(new InsetColoredCell(
512 Color_mathbg, Color_mathmacrooldarg,
513 MathAtom(new InsetMathBrace(arg)))));
515 look_.push_back(MathAtom(new InsetMathBrace(arg)));
517 for (; i < argsInLook_; ++i) {
519 arg.push_back(MathAtom(new MathMacroArgument(i + 1)));
520 look_.push_back(MathAtom(new InsetColoredCell(
521 Color_mathbg, Color_mathmacronewarg,
522 MathAtom(new InsetMathBrace(arg)))));
526 look_.push_back(MathAtom(new InsetMathChar(':')));
527 look_.push_back(MathAtom(new InsetMathChar('=')));
530 look_.push_back(MathAtom(
531 new InsetLabelBox(MathAtom(
532 new InsetMathWrapper(&cell(defIdx()))), _("TeX"), *this, true)));
535 look_.push_back(MathAtom(
536 new DisplayLabelBox(MathAtom(
537 new InsetMathWrapper(&cell(displayIdx()))), _("LyX"), *this)));
541 void MathMacroTemplate::metrics(MetricsInfo & mi, Dimension & dim) const
543 FontSetChanger dummy1(mi.base, from_ascii("mathnormal"));
544 StyleChanger dummy2(mi.base, LM_ST_TEXT);
547 MacroData const * macro = 0;
549 macro = mi.macrocontext.get(name());
551 // updateToContext() - avoids another lookup
552 redefinition_ = macro != 0;
556 int argsInDef = maxArgumentInDefinition();
557 if (lookOutdated_ || argsInDef != argsInLook_) {
558 lookOutdated_ = false;
559 createLook(argsInDef);
562 /// metrics for inset contents
566 // first phase, premetric:
568 look_.metrics(mi, dim);
569 labelBoxAscent_ = dim.asc;
570 labelBoxDescent_ = dim.des;
572 // second phase, main metric:
574 look_.metrics(mi, dim);
583 setDimCache(mi, dim);
587 void MathMacroTemplate::draw(PainterInfo & pi, int x, int y) const
589 FontSetChanger dummy1(pi.base, from_ascii("mathnormal"));
590 StyleChanger dummy2(pi.base, LM_ST_TEXT);
592 setPosCache(pi, x, y);
593 Dimension const dim = dimension(*pi.base.bv);
596 int const a = y - dim.asc + 1;
597 int const w = dim.wid - 2;
598 int const h = dim.height() - 2;
599 pi.pain.rectangle(x, a, w, h, Color_mathframe);
601 // just to be sure: set some dummy values for coord cache
602 for (idx_type i = 0; i < nargs(); ++i)
603 cell(i).setXY(*pi.base.bv, x, y);
606 look_.draw(pi, x + 3, y);
610 void MathMacroTemplate::edit(Cursor & cur, bool front, EntryDirection entry_from)
613 cur.updateFlags(Update::SinglePar);
614 InsetMathNest::edit(cur, front, entry_from);
618 bool MathMacroTemplate::notifyCursorLeaves(Cursor const & old, Cursor & cur)
620 // find this in cursor old
621 Cursor insetCur = old;
622 int scriptSlice = insetCur.find(this);
623 LASSERT(scriptSlice != -1, /**/);
624 insetCur.cutOff(scriptSlice);
626 commitEditChanges(insetCur);
628 cur.updateFlags(Update::Force);
629 return InsetMathNest::notifyCursorLeaves(old, cur);
633 void MathMacroTemplate::removeArguments(Cursor & cur, int from, int to)
635 for (DocIterator it = doc_iterator_begin(&buffer(), this); it; it.forwardChar()) {
638 if (it.nextInset()->lyxCode() != MATH_MACROARG_CODE)
640 MathMacroArgument * arg = static_cast<MathMacroArgument*>(it.nextInset());
641 int n = arg->number() - 1;
642 if (from <= n && n <= to) {
643 int cellSlice = cur.find(it.cell());
644 if (cellSlice != -1 && cur[cellSlice].pos() > it.pos())
645 --cur[cellSlice].pos();
647 it.cell().erase(it.pos());
655 void MathMacroTemplate::shiftArguments(size_t from, int by)
657 for (DocIterator it = doc_iterator_begin(&buffer(), this); it; it.forwardChar()) {
660 if (it.nextInset()->lyxCode() != MATH_MACROARG_CODE)
662 MathMacroArgument * arg = static_cast<MathMacroArgument*>(it.nextInset());
663 if (arg->number() >= int(from) + 1)
664 arg->setNumber(arg->number() + by);
671 int MathMacroTemplate::maxArgumentInDefinition() const
673 // We don't have a buffer when pasting from the clipboard (bug 6014).
674 Buffer const * macro_buffer = this->isBufferValid() ? &buffer() : 0;
676 DocIterator it = doc_iterator_begin(macro_buffer, this);
678 for (; it; it.forwardChar()) {
681 if (it.nextInset()->lyxCode() != MATH_MACROARG_CODE)
683 MathMacroArgument * arg = static_cast<MathMacroArgument*>(it.nextInset());
684 maxArg = std::max(int(arg->number()), maxArg);
690 void MathMacroTemplate::insertMissingArguments(int maxArg)
692 bool found[9] = { false, false, false, false, false, false, false, false, false };
693 idx_type idx = cell(displayIdx()).empty() ? defIdx() : displayIdx();
695 // search for #n macros arguments
696 DocIterator it = doc_iterator_begin(&buffer(), this);
698 for (; it && it[0].idx() == idx; it.forwardChar()) {
701 if (it.nextInset()->lyxCode() != MATH_MACROARG_CODE)
703 MathMacroArgument * arg = static_cast<MathMacroArgument*>(it.nextInset());
704 found[arg->number() - 1] = true;
708 for (int i = 0; i < maxArg; ++i) {
712 cell(idx).push_back(MathAtom(new MathMacroArgument(i + 1)));
717 void MathMacroTemplate::changeArity(Cursor & cur, int newNumArg)
719 // remove parameter which do not appear anymore in the definition
720 for (int i = numargs_; i > newNumArg; --i)
721 removeParameter(cur, numargs_ - 1, false);
723 // add missing parameter
724 for (int i = numargs_; i < newNumArg; ++i)
725 insertParameter(cur, numargs_, false, false);
729 void MathMacroTemplate::commitEditChanges(Cursor & cur)
731 int argsInDef = maxArgumentInDefinition();
732 if (argsInDef != numargs_) {
733 cur.recordUndoFullDocument();
734 changeArity(cur, argsInDef);
736 insertMissingArguments(argsInDef);
740 // FIXME: factorize those functions here with a functional style, maybe using Boost's function
743 void fixMacroInstancesAddRemove(Cursor const & from, docstring const & name, int n, bool insert) {
746 for (; dit; dit.forwardPos()) {
747 // only until a macro is redefined
748 if (dit.inset().lyxCode() == MATHMACRO_CODE) {
749 MathMacroTemplate const & macroTemplate
750 = static_cast<MathMacroTemplate const &>(dit.inset());
751 if (macroTemplate.name() == name)
755 // in front of macro instance?
756 Inset * inset = dit.nextInset();
759 InsetMath * insetMath = inset->asInsetMath();
763 MathMacro * macro = insetMath->asMacro();
764 if (macro && macro->name() == name && macro->folded()) {
765 // found macro instance
767 macro->insertArgument(n);
769 macro->removeArgument(n);
775 void fixMacroInstancesOptional(Cursor const & from, docstring const & name, int optionals) {
778 for (; dit; dit.forwardPos()) {
779 // only until a macro is redefined
780 if (dit.inset().lyxCode() == MATHMACRO_CODE) {
781 MathMacroTemplate const & macroTemplate
782 = static_cast<MathMacroTemplate const &>(dit.inset());
783 if (macroTemplate.name() == name)
787 // in front of macro instance?
788 Inset * inset = dit.nextInset();
791 InsetMath * insetMath = inset->asInsetMath();
794 MathMacro * macro = insetMath->asMacro();
795 if (macro && macro->name() == name && macro->folded()) {
796 // found macro instance
797 macro->setOptionals(optionals);
804 void fixMacroInstancesFunctional(Cursor const & from,
805 docstring const & name, F & fix) {
808 for (; dit; dit.forwardPos()) {
809 // only until a macro is redefined
810 if (dit.inset().lyxCode() == MATHMACRO_CODE) {
811 MathMacroTemplate const & macroTemplate
812 = static_cast<MathMacroTemplate const &>(dit.inset());
813 if (macroTemplate.name() == name)
817 // in front of macro instance?
818 Inset * inset = dit.nextInset();
821 InsetMath * insetMath = inset->asInsetMath();
824 MathMacro * macro = insetMath->asMacro();
825 if (macro && macro->name() == name && macro->folded())
831 void MathMacroTemplate::insertParameter(Cursor & cur, int pos, bool greedy, bool addarg)
833 if (pos <= numargs_ && pos >= optionals_ && numargs_ < 9) {
838 shiftArguments(pos, 1);
840 cell(defIdx()).push_back(MathAtom(new MathMacroArgument(pos + 1)));
841 if (!cell(displayIdx()).empty())
842 cell(displayIdx()).push_back(MathAtom(new MathMacroArgument(pos + 1)));
847 dit.leaveInset(*this);
848 // TODO: this was dit.forwardPosNoDescend before. Check that this is the same
849 dit.top().forwardPos();
851 // fix macro instances
852 fixMacroInstancesAddRemove(dit, name(), pos, true);
860 void MathMacroTemplate::removeParameter(Cursor & cur, int pos, bool greedy)
862 if (pos < numargs_ && pos >= 0) {
864 removeArguments(cur, pos, pos);
865 shiftArguments(pos + 1, -1);
867 // removed optional parameter?
868 if (pos < optionals_) {
870 optionalValues_[pos] = cell(optIdx(pos));
871 cells_.erase(cells_.begin() + optIdx(pos));
874 int macroSlice = cur.find(this);
875 if (macroSlice != -1) {
876 if (cur[macroSlice].idx() == optIdx(pos)) {
877 cur.cutOff(macroSlice);
878 cur[macroSlice].idx() = 1;
879 cur[macroSlice].pos() = 0;
880 } else if (cur[macroSlice].idx() > optIdx(pos))
881 --cur[macroSlice].idx();
886 // fix macro instances
887 //boost::function<void(MathMacro *)> fix = _1->insertArgument(n);
888 //fixMacroInstancesFunctional(dit, name(), fix);
890 dit.leaveInset(*this);
891 // TODO: this was dit.forwardPosNoDescend before. Check that this is the same
892 dit.top().forwardPos();
893 fixMacroInstancesAddRemove(dit, name(), pos, false);
901 void MathMacroTemplate::makeOptional(Cursor & cur) {
902 if (numargs_ > 0 && optionals_ < numargs_) {
904 cells_.insert(cells_.begin() + optIdx(optionals_ - 1), optionalValues_[optionals_ - 1]);
906 int macroSlice = cur.find(this);
907 if (macroSlice != -1 && cur[macroSlice].idx() >= optIdx(optionals_ - 1))
908 ++cur[macroSlice].idx();
910 // fix macro instances
912 dit.leaveInset(*this);
913 // TODO: this was dit.forwardPosNoDescend before. Check that this is the same
914 dit.top().forwardPos();
915 fixMacroInstancesOptional(dit, name(), optionals_);
922 void MathMacroTemplate::makeNonOptional(Cursor & cur) {
923 if (numargs_ > 0 && optionals_ > 0) {
926 // store default value for later if the user changes his mind
927 optionalValues_[optionals_] = cell(optIdx(optionals_));
928 cells_.erase(cells_.begin() + optIdx(optionals_));
931 int macroSlice = cur.find(this);
932 if (macroSlice != -1) {
933 if (cur[macroSlice].idx() > optIdx(optionals_))
934 --cur[macroSlice].idx();
935 else if (cur[macroSlice].idx() == optIdx(optionals_)) {
936 cur.cutOff(macroSlice);
937 cur[macroSlice].idx() = optIdx(optionals_);
938 cur[macroSlice].pos() = 0;
942 // fix macro instances
944 dit.leaveInset(*this);
945 // TODO: this was dit.forwardPosNoDescend before. Check that this is the same
946 dit.top().forwardPos();
947 fixMacroInstancesOptional(dit, name(), optionals_);
954 void MathMacroTemplate::doDispatch(Cursor & cur, FuncRequest & cmd)
956 string const arg = to_utf8(cmd.argument());
957 switch (cmd.action) {
959 case LFUN_MATH_MACRO_ADD_PARAM:
961 commitEditChanges(cur);
962 cur.recordUndoFullDocument();
963 size_t pos = numargs_;
965 pos = (size_t)convert<int>(arg) - 1; // it is checked for >=0 in getStatus
966 insertParameter(cur, pos);
971 case LFUN_MATH_MACRO_REMOVE_PARAM:
973 commitEditChanges(cur);
974 cur.recordUndoFullDocument();
975 size_t pos = numargs_ - 1;
977 pos = (size_t)convert<int>(arg) - 1; // it is checked for >=0 in getStatus
978 removeParameter(cur, pos);
982 case LFUN_MATH_MACRO_APPEND_GREEDY_PARAM:
984 commitEditChanges(cur);
985 cur.recordUndoFullDocument();
986 insertParameter(cur, numargs_, true);
990 case LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM:
992 commitEditChanges(cur);
993 cur.recordUndoFullDocument();
994 removeParameter(cur, numargs_ - 1, true);
998 case LFUN_MATH_MACRO_MAKE_OPTIONAL:
999 commitEditChanges(cur);
1000 cur.recordUndoFullDocument();
1004 case LFUN_MATH_MACRO_MAKE_NONOPTIONAL:
1005 commitEditChanges(cur);
1006 cur.recordUndoFullDocument();
1007 makeNonOptional(cur);
1010 case LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM:
1012 commitEditChanges(cur);
1013 cur.recordUndoFullDocument();
1014 insertParameter(cur, optionals_);
1019 case LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM:
1020 if (optionals_ > 0) {
1021 commitEditChanges(cur);
1022 cur.recordUndoFullDocument();
1023 removeParameter(cur, optionals_ - 1);
1026 case LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM:
1027 if (numargs_ == optionals_) {
1028 commitEditChanges(cur);
1029 cur.recordUndoFullDocument();
1030 insertParameter(cur, 0, true);
1036 InsetMathNest::doDispatch(cur, cmd);
1042 bool MathMacroTemplate::getStatus(Cursor & /*cur*/, FuncRequest const & cmd,
1043 FuncStatus & flag) const
1046 string const arg = to_utf8(cmd.argument());
1047 switch (cmd.action) {
1048 case LFUN_MATH_MACRO_ADD_PARAM: {
1049 int num = numargs_ + 1;
1050 if (arg.size() != 0)
1051 num = convert<int>(arg);
1052 bool on = (num >= optionals_
1053 && numargs_ < 9 && num <= numargs_ + 1);
1054 flag.setEnabled(on);
1058 case LFUN_MATH_MACRO_APPEND_GREEDY_PARAM:
1059 flag.setEnabled(numargs_ < 9);
1062 case LFUN_MATH_MACRO_REMOVE_PARAM: {
1064 if (arg.size() != 0)
1065 num = convert<int>(arg);
1066 flag.setEnabled(num >= 1 && num <= numargs_);
1070 case LFUN_MATH_MACRO_MAKE_OPTIONAL:
1071 flag.setEnabled(numargs_ > 0
1072 && optionals_ < numargs_
1073 && type_ != MacroTypeDef);
1076 case LFUN_MATH_MACRO_MAKE_NONOPTIONAL:
1077 flag.setEnabled(optionals_ > 0
1078 && type_ != MacroTypeDef);
1081 case LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM:
1082 flag.setEnabled(numargs_ < 9);
1085 case LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM:
1086 flag.setEnabled(optionals_ > 0);
1089 case LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM:
1090 flag.setEnabled(numargs_ == 0
1091 && type_ != MacroTypeDef);
1094 case LFUN_IN_MATHMACROTEMPLATE:
1095 flag.setEnabled(true);
1106 void MathMacroTemplate::read(Lexer & lex)
1109 mathed_parse_cell(ar, lex.getStream());
1110 if (ar.size() != 1 || !ar[0]->asMacroTemplate()) {
1111 lyxerr << "Cannot read macro from '" << ar << "'" << endl;
1112 lyxerr << "Read: " << to_utf8(asString(ar)) << endl;
1115 operator=( *(ar[0]->asMacroTemplate()) );
1121 void MathMacroTemplate::write(ostream & os) const
1123 odocstringstream oss;
1124 WriteStream wi(oss, false, false, false);
1125 oss << "FormulaMacro\n";
1127 os << to_utf8(oss.str());
1131 void MathMacroTemplate::write(WriteStream & os) const
1137 void MathMacroTemplate::write(WriteStream & os, bool overwriteRedefinition) const
1140 if (optionals_ > 0) {
1141 // macros with optionals use the xargs package, e.g.:
1142 // \newcommandx{\foo}[2][usedefault, addprefix=\global,1=default]{#1,#2}
1143 // \long is implicit by xargs
1144 if (redefinition_ && !overwriteRedefinition)
1145 os << "\\renewcommandx";
1147 os << "\\newcommandx";
1149 os << "\\" << name()
1150 << "[" << numargs_ << "]"
1151 << "[usedefault, addprefix=\\global";
1152 for (int i = 0; i < optionals_; ++i) {
1153 docstring optValue = asString(cell(optIdx(i)));
1154 if (optValue.find(']') != docstring::npos
1155 || optValue.find(',') != docstring::npos)
1156 os << ", " << i + 1 << "="
1157 << "{" << cell(optIdx(i)) << "}";
1159 os << ", " << i + 1 << "="
1164 // Macros without optionals use standard _global_ \def macros:
1165 // \global\def\long\foo#1#2{#1,#2}
1166 // We use the \long prefix as this is the equivalent to \newcommand.
1167 // We cannot use \newcommand directly because \global does not work with it.
1168 os << "\\global\\long\\def\\" << name();
1169 docstring param = from_ascii("#0");
1170 for (int i = 1; i <= numargs_; ++i) {
1176 // in LyX output we use some pseudo syntax which is implementation
1177 // independent, e.g.
1178 // \newcommand{\foo}[2][default]{#1,#2}
1179 if (redefinition_ && !overwriteRedefinition)
1180 os << "\\renewcommand";
1182 os << "\\newcommand";
1183 os << "{\\" << name() << '}';
1185 os << '[' << numargs_ << ']';
1187 for (int i = 0; i < optionals_; ++i) {
1188 docstring optValue = asString(cell(optIdx(i)));
1189 if (optValue.find(']') != docstring::npos)
1190 os << "[{" << cell(optIdx(i)) << "}]";
1192 os << "[" << cell(optIdx(i)) << "]";
1196 os << "{" << cell(defIdx()) << "}";
1199 // writing .tex. done.
1202 // writing .lyx, write special .tex export only if necessary
1203 if (!cell(displayIdx()).empty())
1204 os << "\n{" << cell(displayIdx()) << '}';
1209 int MathMacroTemplate::plaintext(odocstream & os,
1210 OutputParams const &) const
1212 static docstring const str = '[' + buffer().B_("math macro") + ']';
1219 bool MathMacroTemplate::validName() const
1221 docstring n = name();
1227 // converting back and force doesn't swallow anything?
1230 if (asString(ma) != n)
1233 // valid characters?
1234 for (size_t i = 0; i < n.size(); ++i) {
1235 if (!(n[i] >= 'a' && n[i] <= 'z')
1236 && !(n[i] >= 'A' && n[i] <= 'Z')
1245 bool MathMacroTemplate::validMacro() const
1251 bool MathMacroTemplate::fixNameAndCheckIfValid()
1253 // check all the characters/insets in the name cell
1255 MathData & data = cell(0);
1256 while (i < data.size()) {
1257 InsetMathChar const * cinset = data[i]->asCharInset();
1259 // valid character in [a-zA-Z]?
1260 char_type c = cinset->getChar();
1261 if ((c >= 'a' && c <= 'z')
1262 || (c >= 'A' && c <= 'Z')) {
1272 // now it should be valid if anything in the name survived
1273 return data.size() > 0;
1277 void MathMacroTemplate::validate(LaTeXFeatures & features) const
1279 // we need global optional macro arguments. They are not available
1280 // with \def, and \newcommand does not support global macros. So we
1281 // are bound to xargs also for the single-optional-parameter case.
1283 features.require("xargs");
1286 void MathMacroTemplate::getDefaults(vector<docstring> & defaults) const
1288 defaults.resize(numargs_);
1289 for (int i = 0; i < optionals_; ++i)
1290 defaults[i] = asString(cell(optIdx(i)));
1294 docstring MathMacroTemplate::definition() const
1296 return asString(cell(defIdx()));
1300 docstring MathMacroTemplate::displayDefinition() const
1302 return asString(cell(displayIdx()));
1306 size_t MathMacroTemplate::numArgs() const
1312 size_t MathMacroTemplate::numOptionals() const
1318 void MathMacroTemplate::infoize(odocstream & os) const
1320 os << "Math Macro: \\" << name();
1324 docstring MathMacroTemplate::contextMenu(BufferView const &, int, int) const
1326 return from_ascii("context-math-macro-definition");