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 "InsetMathBrace.h"
17 #include "InsetMathChar.h"
18 #include "InsetMathHull.h"
19 #include "InsetMathSqrt.h"
20 #include "MathMacro.h"
21 #include "MathMacroArgument.h"
22 #include "MathStream.h"
23 #include "MathParser.h"
24 #include "MathSupport.h"
25 #include "MathMacroArgument.h"
28 #include "BufferView.h"
31 #include "DispatchResult.h"
32 #include "DocIterator.h"
33 #include "FuncRequest.h"
34 #include "FuncStatus.h"
35 #include "LaTeXFeatures.h"
37 #include "MetricsInfo.h"
38 #include "TocBackend.h"
40 #include "frontends/Painter.h"
42 #include "insets/RenderPreview.h"
44 #include "support/lassert.h"
45 #include "support/convert.h"
46 #include "support/debug.h"
47 #include "support/gettext.h"
48 #include "support/docstream.h"
49 #include "support/lstrings.h"
58 using support::bformat;
60 //////////////////////////////////////////////////////////////////////
62 class InsetLabelBox : public InsetMathNest {
65 InsetLabelBox(Buffer * buf, MathAtom const & atom, docstring label,
66 MathMacroTemplate const & parent, bool frame = false);
67 InsetLabelBox(Buffer * buf, docstring label, MathMacroTemplate const & parent,
70 void metrics(MetricsInfo & mi, Dimension & dim) const;
72 void draw(PainterInfo &, int x, int y) const;
76 MathMacroTemplate const & parent_;
78 Inset * clone() const;
80 docstring const label_;
86 InsetLabelBox::InsetLabelBox(Buffer * buf, MathAtom const & atom, docstring label,
87 MathMacroTemplate const & parent, bool frame)
88 : InsetMathNest(buf, 1), parent_(parent), label_(label), frame_(frame)
90 cell(0).insert(0, atom);
94 InsetLabelBox::InsetLabelBox(Buffer * buf, docstring label,
95 MathMacroTemplate const & parent, bool frame)
96 : InsetMathNest(buf, 1), parent_(parent), label_(label), frame_(frame)
101 Inset * InsetLabelBox::clone() const
103 return new InsetLabelBox(*this);
107 void InsetLabelBox::metrics(MetricsInfo & mi, Dimension & dim) const
110 cell(0).metrics(mi, dim);
119 // adjust to common height in main metrics phase
120 if (!parent_.premetrics()) {
121 dim.asc = max(dim.asc, parent_.commonLabelBoxAscent());
122 dim.des = max(dim.des, parent_.commonLabelBoxDescent());
126 if (parent_.editing(mi.base.bv) && label_.length() > 0) {
128 FontInfo font = sane_font;
129 font.setSize(FONT_SIZE_TINY);
130 font.setColor(Color_mathmacrolabel);
132 // make space for label and box
133 int lwid = mathed_string_width(font, label_);
136 math_font_max_dim(font, maxasc, maxdes);
138 dim.wid = max(dim.wid, lwid + 2);
140 // space for the label
141 if (!parent_.premetrics())
142 dim.des += maxasc + maxdes + 1;
147 void InsetLabelBox::draw(PainterInfo & pi, int x, int y) const
149 Dimension const dim = dimension(*pi.base.bv);
150 Dimension const cdim = cell(0).dimension(*pi.base.bv);
153 cell(0).draw(pi, x + (dim.wid - cdim.wid) / 2, y);
156 if (parent_.editing(pi.base.bv) && label_.length() > 0) {
158 FontInfo font = sane_font;
159 font.setSize(FONT_SIZE_TINY);
160 font.setColor(Color_mathmacrolabel);
162 // make space for label and box
163 int lwid = mathed_string_width(font, label_);
166 math_font_max_dim(font, maxasc, maxdes);
169 pi.pain.text(x + (dim.wid - lwid) / 2, y + dim.des - maxdes, label_, font);
171 pi.pain.text(x, y + dim.des - maxdes, label_, font);
175 int boxHeight = parent_.commonLabelBoxAscent() + parent_.commonLabelBoxDescent();
177 pi.pain.rectangle(x + 1, y - dim.ascent() + 1,
178 dim.wid - 2, boxHeight - 2,
184 //////////////////////////////////////////////////////////////////////
186 class DisplayLabelBox : public InsetLabelBox {
189 DisplayLabelBox(Buffer * buf, MathAtom const & atom, docstring label,
190 MathMacroTemplate const & parent);
193 void metrics(MetricsInfo & mi, Dimension & dim) const;
195 void draw(PainterInfo &, int x, int y) const;
199 Inset * clone() const;
203 DisplayLabelBox::DisplayLabelBox(Buffer * buf, MathAtom const & atom,
205 MathMacroTemplate const & parent)
206 : InsetLabelBox(buf, atom, label, parent, true)
212 Inset * DisplayLabelBox::clone() const
214 return new DisplayLabelBox(*this);
218 void DisplayLabelBox::metrics(MetricsInfo & mi, Dimension & dim) const
220 InsetLabelBox::metrics(mi, dim);
221 if (!parent_.editing(mi.base.bv)
222 && parent_.cell(parent_.displayIdx()).empty()) {
230 void DisplayLabelBox::draw(PainterInfo & pi, int x, int y) const
232 if (parent_.editing(pi.base.bv)
233 || !parent_.cell(parent_.displayIdx()).empty()) {
234 InsetLabelBox::draw(pi, x, y);
236 bool enabled = pi.pain.isDrawingEnabled();
237 pi.pain.setDrawingEnabled(false);
238 InsetLabelBox::draw(pi, x, y);
239 pi.pain.setDrawingEnabled(enabled);
244 //////////////////////////////////////////////////////////////////////
246 class InsetMathWrapper : public InsetMath {
249 InsetMathWrapper(MathData const * value) : value_(value) {}
251 void metrics(MetricsInfo & mi, Dimension & dim) const;
253 void draw(PainterInfo &, int x, int y) const;
257 Inset * clone() const;
259 MathData const * value_;
263 Inset * InsetMathWrapper::clone() const
265 return new InsetMathWrapper(*this);
269 void InsetMathWrapper::metrics(MetricsInfo & mi, Dimension & dim) const
271 value_->metrics(mi, dim);
272 //metricsMarkers2(mi, dim);
276 void InsetMathWrapper::draw(PainterInfo & pi, int x, int y) const
278 value_->draw(pi, x, y);
279 //drawMarkers(pi, x, y);
283 ///////////////////////////////////////////////////////////////////////
284 class InsetColoredCell : public InsetMathNest {
287 InsetColoredCell(Buffer * buf, ColorCode min, ColorCode max);
289 InsetColoredCell(Buffer * buf, ColorCode min, ColorCode max, MathAtom const & atom);
291 void draw(PainterInfo &, int x, int y) const;
293 void metrics(MetricsInfo & mi, Dimension & dim) const;
297 Inset * clone() const;
305 InsetColoredCell::InsetColoredCell(Buffer * buf, ColorCode min, ColorCode max)
306 : InsetMathNest(buf, 1), min_(min), max_(max)
311 InsetColoredCell::InsetColoredCell(Buffer * buf, ColorCode min, ColorCode max, MathAtom const & atom)
312 : InsetMathNest(buf, 1), min_(min), max_(max)
314 cell(0).insert(0, atom);
318 Inset * InsetColoredCell::clone() const
320 return new InsetColoredCell(*this);
324 void InsetColoredCell::metrics(MetricsInfo & mi, Dimension & dim) const
326 cell(0).metrics(mi, dim);
330 void InsetColoredCell::draw(PainterInfo & pi, int x, int y) const
332 pi.pain.enterMonochromeMode(min_, max_);
333 cell(0).draw(pi, x, y);
334 pi.pain.leaveMonochromeMode();
338 ///////////////////////////////////////////////////////////////////////
340 class InsetNameWrapper : public InsetMathWrapper {
343 InsetNameWrapper(MathData const * value, MathMacroTemplate const & parent);
345 void metrics(MetricsInfo & mi, Dimension & dim) const;
347 void draw(PainterInfo &, int x, int y) const;
351 MathMacroTemplate const & parent_;
353 Inset * clone() const;
357 InsetNameWrapper::InsetNameWrapper(MathData const * value,
358 MathMacroTemplate const & parent)
359 : InsetMathWrapper(value), parent_(parent)
364 Inset * InsetNameWrapper::clone() const
366 return new InsetNameWrapper(*this);
370 void InsetNameWrapper::metrics(MetricsInfo & mi, Dimension & dim) const
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
380 PainterInfo namepi = pi;
381 if (parent_.validMacro())
382 namepi.base.font.setColor(Color_latex);
384 namepi.base.font.setColor(Color_error);
387 pi.pain.text(x, y, from_ascii("\\"), namepi.base.font);
388 x += mathed_string_width(namepi.base.font, from_ascii("\\"));
391 InsetMathWrapper::draw(namepi, x, y);
395 ///////////////////////////////////////////////////////////////////////
398 MathMacroTemplate::MathMacroTemplate(Buffer * buf)
399 : InsetMathNest(buf, 3), numargs_(0), argsInLook_(0), optionals_(0),
400 type_(MacroTypeNewcommand), redefinition_(false), lookOutdated_(true),
401 premetrics_(false), labelBoxAscent_(0), labelBoxDescent_(0)
407 MathMacroTemplate::MathMacroTemplate(Buffer * buf, docstring const & name, int numargs,
408 int optionals, MacroType type, vector<MathData> const & optionalValues,
409 MathData const & def, MathData const & display)
410 : InsetMathNest(buf, optionals + 3), numargs_(numargs), argsInLook_(numargs),
411 optionals_(optionals), optionalValues_(optionalValues),
412 type_(type), redefinition_(false), lookOutdated_(true),
413 premetrics_(false), labelBoxAscent_(0), labelBoxDescent_(0)
418 lyxerr << "MathMacroTemplate::MathMacroTemplate: wrong # of arguments: "
421 asArray(name, cell(0));
422 optionalValues_.resize(9);
423 for (int i = 0; i < optionals_; ++i)
424 cell(optIdx(i)) = optionalValues_[i];
425 cell(defIdx()) = def;
426 cell(displayIdx()) = display;
432 bool MathMacroTemplate::fromString(docstring const & str)
434 MathData ar(buffer_);
435 mathed_parse_cell(ar, str, Parse::NORMAL);
436 if (ar.size() != 1 || !ar[0]->asMacroTemplate()) {
437 lyxerr << "Cannot read macro from '" << ar << "'" << endl;
438 asArray(from_ascii("invalidmacro"), cell(0));
439 // The macro template does not make sense after this.
442 operator=( *(ar[0]->asMacroTemplate()) );
449 Inset * MathMacroTemplate::clone() const
451 MathMacroTemplate * inset = new MathMacroTemplate(*this);
452 // the parent pointers of the proxy insets above will point to
453 // to the old template. Hence, the look must be updated.
459 docstring MathMacroTemplate::name() const
461 return asString(cell(0));
465 void MathMacroTemplate::updateToContext(MacroContext const & mc)
467 redefinition_ = mc.get(name()) != 0;
471 void MathMacroTemplate::updateLook() const
473 lookOutdated_ = true;
477 void MathMacroTemplate::createLook(int args) const
483 look_.push_back(MathAtom(
484 new InsetLabelBox(buffer_, _("Name"), *this, false)));
485 MathData & nameData = look_[look_.size() - 1].nucleus()->cell(0);
486 nameData.push_back(MathAtom(new InsetNameWrapper(&cell(0), *this)));
490 if (optionals_ > 0) {
491 look_.push_back(MathAtom(
492 new InsetLabelBox(buffer_, _("optional"), *this, false)));
494 MathData * optData = &look_[look_.size() - 1].nucleus()->cell(0);
495 for (; i < optionals_; ++i) {
496 // color it light grey, if it is to be removed when the cursor leaves
497 if (i == argsInLook_) {
498 optData->push_back(MathAtom(
499 new InsetColoredCell(buffer_, Color_mathbg, Color_mathmacrooldarg)));
500 optData = &(*optData)[optData->size() - 1].nucleus()->cell(0);
503 optData->push_back(MathAtom(new InsetMathChar('[')));
504 optData->push_back(MathAtom(new InsetMathWrapper(&cell(1 + i))));
505 optData->push_back(MathAtom(new InsetMathChar(']')));
510 for (; i < numargs_; ++i) {
512 arg.push_back(MathAtom(new MathMacroArgument(i + 1)));
513 if (i >= argsInLook_) {
514 look_.push_back(MathAtom(new InsetColoredCell(buffer_,
515 Color_mathbg, Color_mathmacrooldarg,
516 MathAtom(new InsetMathBrace(arg)))));
518 look_.push_back(MathAtom(new InsetMathBrace(arg)));
520 for (; i < argsInLook_; ++i) {
522 arg.push_back(MathAtom(new MathMacroArgument(i + 1)));
523 look_.push_back(MathAtom(new InsetColoredCell(buffer_,
524 Color_mathbg, Color_mathmacronewarg,
525 MathAtom(new InsetMathBrace(arg)))));
529 look_.push_back(MathAtom(new InsetMathChar(':')));
530 look_.push_back(MathAtom(new InsetMathChar('=')));
533 look_.push_back(MathAtom(
534 new InsetLabelBox(buffer_, MathAtom(
535 new InsetMathWrapper(&cell(defIdx()))), _("TeX"), *this, true)));
538 look_.push_back(MathAtom(
539 new DisplayLabelBox(buffer_, MathAtom(
540 new InsetMathWrapper(&cell(displayIdx()))), _("LyX"), *this)));
544 void MathMacroTemplate::metrics(MetricsInfo & mi, Dimension & dim) const
546 Changer dummy1 = mi.base.changeFontSet("mathnormal");
547 Changer dummy2 = mi.base.font.changeStyle(LM_ST_TEXT);
550 MacroData const * macro = 0;
552 macro = mi.macrocontext.get(name());
555 int argsInDef = maxArgumentInDefinition();
556 if (lookOutdated_ || argsInDef != argsInLook_) {
557 lookOutdated_ = false;
558 createLook(argsInDef);
561 /// metrics for inset contents
565 // first phase, premetric:
567 look_.metrics(mi, dim);
568 labelBoxAscent_ = dim.asc;
569 labelBoxDescent_ = dim.des;
571 // second phase, main metric:
573 look_.metrics(mi, dim);
584 void MathMacroTemplate::draw(PainterInfo & pi, int x, int y) const
586 // FIXME: Calling Changer on the same object repeatedly is inefficient.
587 Changer dummy0 = pi.base.font.changeColor(Color_math);
588 Changer dummy1 = pi.base.changeFontSet("mathnormal");
589 Changer dummy2 = pi.base.font.changeStyle(LM_ST_TEXT);
591 Dimension const dim = dimension(*pi.base.bv);
594 int const a = y - dim.asc + 1;
595 int const w = dim.wid - 2;
596 int const h = dim.height() - 2;
597 pi.pain.rectangle(x + 1, 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 + 3, y);
608 void MathMacroTemplate::edit(Cursor & cur, bool front, EntryDirection entry_from)
611 cur.screenUpdateFlags(Update::SinglePar);
612 InsetMathNest::edit(cur, front, entry_from);
616 bool MathMacroTemplate::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 MathMacroTemplate::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 MathMacroArgument * arg = static_cast<MathMacroArgument*>(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 MathMacroTemplate::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 MathMacroArgument * arg = static_cast<MathMacroArgument*>(it.nextInset());
660 if (arg->number() >= int(from) + 1)
661 arg->setNumber(arg->number() + by);
668 int MathMacroTemplate::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 MathMacroArgument * arg = static_cast<MathMacroArgument*>(it.nextInset());
681 maxArg = std::max(int(arg->number()), maxArg);
687 void MathMacroTemplate::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 MathMacroArgument * arg = static_cast<MathMacroArgument*>(it.nextInset());
701 found[arg->number() - 1] = true;
705 for (int i = 0; i < maxArg; ++i) {
709 cell(idx).push_back(MathAtom(new MathMacroArgument(i + 1)));
714 void MathMacroTemplate::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()(MathMacro * macro)
736 if (macro->folded()) {
738 macro->insertArgument(n_);
740 macro->removeArgument(n_);
753 class OptionalsMacroInstanceFix
757 OptionalsMacroInstanceFix(int optionals) : optionals_(optionals) {}
759 void operator()(MathMacro * macro)
761 macro->setOptionals(optionals_);
771 class NullMacroInstanceFix
775 void operator()(MathMacro * ) {}
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 MathMacroTemplate const & macroTemplate
808 = static_cast<MathMacroTemplate 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 MathMacro * 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 MathMacroTemplate::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 MathMacroTemplate::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 MathMacroArgument(pos + 1)));
880 if (!cell(displayIdx()).empty())
881 cell(displayIdx()).push_back(MathAtom(new MathMacroArgument(pos + 1)));
885 // fix macro instances
886 AddRemoveMacroInstanceFix fix(pos, true);
887 fixMacroInstances(cur, inset_pos, name(), fix);
895 void MathMacroTemplate::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 MathMacroTemplate::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 MathMacroTemplate::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 MathMacroTemplate::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 MathMacroTemplate::getStatus(Cursor & cur, FuncRequest const & cmd,
1090 FuncStatus & flag) 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 flag.setEnabled(on);
1105 case LFUN_MATH_MACRO_APPEND_GREEDY_PARAM:
1106 flag.setEnabled(numargs_ < 9);
1109 case LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM:
1110 case LFUN_MATH_MACRO_REMOVE_PARAM: {
1113 num = convert<int>(arg);
1114 flag.setEnabled(num >= 1 && num <= numargs_);
1118 case LFUN_MATH_MACRO_MAKE_OPTIONAL:
1119 flag.setEnabled(numargs_ > 0
1120 && optionals_ < numargs_
1121 && type_ != MacroTypeDef);
1124 case LFUN_MATH_MACRO_MAKE_NONOPTIONAL:
1125 flag.setEnabled(optionals_ > 0
1126 && type_ != MacroTypeDef);
1129 case LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM:
1130 flag.setEnabled(numargs_ < 9);
1133 case LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM:
1134 flag.setEnabled(optionals_ > 0);
1137 case LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM:
1138 flag.setEnabled(numargs_ == 0
1139 && type_ != MacroTypeDef);
1142 case LFUN_IN_MATHMACROTEMPLATE:
1143 flag.setEnabled(true);
1147 ret = InsetMathNest::getStatus(cur, cmd, flag);
1154 void MathMacroTemplate::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 MathMacroTemplate::write(ostream & os) const
1171 odocstringstream oss;
1172 otexrowstream ots(oss);
1173 WriteStream wi(ots, false, false, WriteStream::wsDefault);
1174 oss << "FormulaMacro\n";
1176 os << to_utf8(oss.str());
1180 void MathMacroTemplate::write(WriteStream & os) const
1186 int MathMacroTemplate::write(WriteStream & 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 << "\\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 MathMacroTemplate::xhtml(XHTMLStream &, OutputParams const &) const
1270 int MathMacroTemplate::plaintext(odocstringstream & os,
1271 OutputParams const &, size_t) const
1273 docstring const str = '[' + buffer().B_("math macro") + ']';
1280 bool MathMacroTemplate::validName() const
1282 docstring n = name();
1287 // converting back and force doesn't swallow anything?
1290 if (asString(ma) != n)
1293 // valid characters?
1294 for (size_t i = 0; i < n.size(); ++i) {
1295 if (!(n[i] >= 'a' && n[i] <= 'z')
1296 && !(n[i] >= 'A' && n[i] <= 'Z')
1305 bool MathMacroTemplate::validMacro() const
1311 bool MathMacroTemplate::fixNameAndCheckIfValid()
1313 // check all the characters/insets in the name cell
1315 MathData & data = cell(0);
1316 while (i < data.size()) {
1317 InsetMathChar const * cinset = data[i]->asCharInset();
1319 // valid character in [a-zA-Z]?
1320 char_type c = cinset->getChar();
1321 if ((c >= 'a' && c <= 'z')
1322 || (c >= 'A' && c <= 'Z')) {
1332 // now it should be valid if anything in the name survived
1333 return !data.empty();
1337 void MathMacroTemplate::validate(LaTeXFeatures & features) const
1339 // we need global optional macro arguments. They are not available
1340 // with \def, and \newcommand does not support global macros. So we
1341 // are bound to xargs also for the single-optional-parameter case.
1343 features.require("xargs");
1346 void MathMacroTemplate::getDefaults(vector<docstring> & defaults) const
1348 defaults.resize(numargs_);
1349 for (int i = 0; i < optionals_; ++i)
1350 defaults[i] = asString(cell(optIdx(i)));
1354 docstring MathMacroTemplate::definition() const
1356 return asString(cell(defIdx()));
1360 docstring MathMacroTemplate::displayDefinition() const
1362 return asString(cell(displayIdx()));
1366 size_t MathMacroTemplate::numArgs() const
1372 size_t MathMacroTemplate::numOptionals() const
1378 void MathMacroTemplate::infoize(odocstream & os) const
1380 os << bformat(_("Math Macro: \\%1$s"), name());
1384 string MathMacroTemplate::contextMenuName() const
1386 return "context-math-macro-definition";
1389 void MathMacroTemplate::addToToc(DocIterator const & pit, bool output_active,
1392 shared_ptr<Toc> toc = buffer().tocBackend().toc("math-macro");
1395 str = bformat(_("Invalid macro! \\%1$s"), name());
1397 str = "\\" + name();
1398 toc->push_back(TocItem(pit, 0, str, output_active));