3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Alejandro Aguilar Sierra
8 * \author Stefan Schimanski
10 * Full author contact details are available in file CREDITS.
15 #include "MathMacro.h"
17 #include "InsetMathChar.h"
18 #include "MathCompletionList.h"
19 #include "MathExtern.h"
20 #include "MathFactory.h"
21 #include "MathStream.h"
22 #include "MathSupport.h"
25 #include "BufferView.h"
26 #include "CoordCache.h"
28 #include "FuncStatus.h"
29 #include "FuncRequest.h"
30 #include "LaTeXFeatures.h"
33 #include "MetricsInfo.h"
35 #include "frontends/Painter.h"
37 #include "support/debug.h"
38 #include "support/gettext.h"
39 #include "support/lassert.h"
40 #include "support/lstrings.h"
41 #include "support/RefChanger.h"
42 #include "support/textutils.h"
47 using namespace lyx::support;
53 /// A proxy for the macro values
54 class ArgumentProxy : public InsetMath {
57 ArgumentProxy(MathMacro * mathMacro, size_t idx)
58 : mathMacro_(mathMacro), idx_(idx) {}
60 ArgumentProxy(MathMacro * mathMacro, size_t idx, docstring const & def)
61 : mathMacro_(mathMacro), idx_(idx)
66 void setOwner(MathMacro * mathMacro) { mathMacro_ = mathMacro; }
68 MathMacro const * owner() { return mathMacro_; }
70 marker_type marker() const { return NO_MARKER; }
72 InsetCode lyxCode() const { return ARGUMENT_PROXY_CODE; }
73 /// The math data to use for display
74 MathData const & displayCell(BufferView const * bv) const
76 // handle default macro arguments
77 bool use_def_arg = !mathMacro_->editMetrics(bv)
78 && mathMacro_->cell(idx_).empty();
79 return use_def_arg ? def_ : mathMacro_->cell(idx_);
82 bool addToMathRow(MathRow & mrow, MetricsInfo & mi) const
84 // macro arguments are in macros
85 LATTEST(mathMacro_->nesting() > 0);
86 /// The macro nesting can change display of insets. Change it locally.
87 Changer chg = make_change(mi.base.macro_nesting,
88 mathMacro_->nesting() == 1 ? 0 : mathMacro_->nesting());
90 MathRow::Element e_beg(mi, MathRow::BEGIN);
92 e_beg.ar = &mathMacro_->cell(idx_);
93 mrow.push_back(e_beg);
95 mathMacro_->macro()->unlock();
96 bool has_contents = displayCell(mi.base.bv).addToMathRow(mrow, mi);
97 mathMacro_->macro()->lock();
99 // if there was no contents, and the contents is editable,
100 // then we insert a box instead.
101 if (!has_contents && mathMacro_->nesting() == 1) {
102 // mathclass is ord because it should be spaced as a normal atom
103 MathRow::Element e(mi, MathRow::BOX, MC_ORD);
104 e.color = Color_mathline;
109 MathRow::Element e_end(mi, MathRow::END);
111 e_end.ar = &mathMacro_->cell(idx_);
112 mrow.push_back(e_end);
117 void beforeMetrics() const
119 mathMacro_->macro()->unlock();
122 void afterMetrics() const
124 mathMacro_->macro()->lock();
127 void beforeDraw(PainterInfo const & pi) const
129 // if the macro is being edited, then the painter is in
131 if (mathMacro_->editMetrics(pi.base.bv))
132 pi.pain.leaveMonochromeMode();
135 void afterDraw(PainterInfo const & pi) const
137 if (mathMacro_->editMetrics(pi.base.bv))
138 pi.pain.enterMonochromeMode(Color_mathbg, Color_mathmacroblend);
141 void metrics(MetricsInfo &, Dimension &) const {
142 // This should never be invoked, since ArgumentProxy insets are linearized
146 void draw(PainterInfo &, int, int) const {
147 // This should never be invoked, since ArgumentProxy insets are linearized
151 int kerning(BufferView const * bv) const
153 return displayCell(bv).kerning(bv);
155 // write(), normalize(), infoize() and infoize2() are not needed since
156 // MathMacro uses the definition and not the expanded cells.
158 void maple(MapleStream & ms) const { ms << mathMacro_->cell(idx_); }
160 void maxima(MaximaStream & ms) const { ms << mathMacro_->cell(idx_); }
162 void mathematica(MathematicaStream & ms) const { ms << mathMacro_->cell(idx_); }
164 void mathmlize(MathStream & ms) const { ms << mathMacro_->cell(idx_); }
166 void htmlize(HtmlStream & ms) const { ms << mathMacro_->cell(idx_); }
168 void octave(OctaveStream & os) const { os << mathMacro_->cell(idx_); }
170 MathClass mathClass() const
173 // This can be refined once the pointer issues are fixed. I did not
174 // notice any immediate crash with the following code, but it is risky
176 //return mathMacro_->cell(idx_).mathClass();
181 Inset * clone() const
183 return new ArgumentProxy(*this);
186 MathMacro * mathMacro_;
194 /// Private implementation of MathMacro
195 class MathMacro::Private {
197 Private(Buffer * buf, docstring const & name)
198 : name_(name), displayMode_(DISPLAY_INIT),
199 expanded_(buf), definition_(buf), attachedArgsNum_(0),
200 optionals_(0), nextFoldMode_(true), macroBackup_(buf),
201 macro_(0), needsUpdate_(false), isUpdating_(false),
205 /// Update the pointers to our owner of all expanded macros.
206 /// This needs to be called every time a copy of the owner is created
208 void updateChildren(MathMacro * owner);
209 /// Recursively update the pointers of all expanded macros
210 /// appearing in the arguments of the current macro
211 void updateNestedChildren(MathMacro * owner, InsetMathNest * ni);
214 /// current display mode
215 DisplayMode displayMode_;
216 /// expanded macro with ArgumentProxies
218 /// macro definition with #1,#2,.. insets
219 MathData definition_;
220 /// number of arguments that were really attached
221 size_t attachedArgsNum_;
222 /// optional argument attached? (only in DISPLAY_NORMAL mode)
224 /// fold mode to be set in next metrics call?
226 /// if macro_ == true, then here is a copy of the macro
227 /// don't use it for locking
228 MacroData macroBackup_;
229 /// if macroNotFound_ == false, then here is a reference to the macro
230 /// this might invalidate after metrics was called
231 MacroData const * macro_;
233 mutable std::map<BufferView const *, bool> editing_;
235 std::string requires_;
236 /// update macro representation
240 /// maximal number of arguments the macro is greedy for
242 /// Level of nesting in macros (including this one)
247 void MathMacro::Private::updateChildren(MathMacro * owner)
249 for (size_t i = 0; i < expanded_.size(); ++i) {
250 ArgumentProxy * p = dynamic_cast<ArgumentProxy *>(expanded_[i].nucleus());
254 InsetMathNest * ni = expanded_[i].nucleus()->asNestInset();
256 updateNestedChildren(owner, ni);
260 // The macro_ pointer is updated when MathData::metrics() is
261 // called. However, when instant preview is on or the macro is
262 // not on screen, MathData::metrics() is not called and we may
263 // have a dangling pointer. As a safety measure, when a macro
264 // is copied, always let macro_ point to the backup copy of the
265 // MacroData structure. This backup is updated every time the
266 // macro is changed, so it will not become stale.
267 macro_ = ¯oBackup_;
272 void MathMacro::Private::updateNestedChildren(MathMacro * owner, InsetMathNest * ni)
274 for (size_t i = 0; i < ni->nargs(); ++i) {
275 MathData & ar = ni->cell(i);
276 for (size_t j = 0; j < ar.size(); ++j) {
277 ArgumentProxy * ap = dynamic_cast
278 <ArgumentProxy *>(ar[j].nucleus());
280 MathMacro::Private * md = ap->owner()->d;
282 md->macro_ = &md->macroBackup_;
285 InsetMathNest * imn = ar[j].nucleus()->asNestInset();
287 updateNestedChildren(owner, imn);
293 MathMacro::MathMacro(Buffer * buf, docstring const & name)
294 : InsetMathNest(buf, 0), d(new Private(buf, name))
298 MathMacro::MathMacro(MathMacro const & that)
299 : InsetMathNest(that), d(new Private(*that.d))
301 setBuffer(*that.buffer_);
302 d->updateChildren(this);
306 MathMacro & MathMacro::operator=(MathMacro const & that)
310 InsetMathNest::operator=(that);
312 d->updateChildren(this);
317 MathMacro::~MathMacro()
323 bool MathMacro::addToMathRow(MathRow & mrow, MetricsInfo & mi) const
325 // set edit mode for which we will have calculated row.
326 // This is the same as what is done in metrics().
327 d->editing_[mi.base.bv] = editMode(mi.base.bv);
329 // For now we do not linearize in the following cases (can be improved)
330 // - display mode different from normal
331 // - editing with parameter list
332 // - editing with box around macro
333 if (displayMode() != MathMacro::DISPLAY_NORMAL
334 || (d->editing_[mi.base.bv] && lyxrc.macro_edit_style != LyXRC::MACRO_EDIT_INLINE))
335 return InsetMath::addToMathRow(mrow, mi);
337 /// The macro nesting can change display of insets. Change it locally.
338 Changer chg = make_change(mi.base.macro_nesting, d->nesting_);
340 MathRow::Element e_beg(mi, MathRow::BEGIN);
342 e_beg.marker = (d->nesting_ == 1 && nargs()) ? marker() : NO_MARKER;
343 mrow.push_back(e_beg);
346 bool has_contents = d->expanded_.addToMathRow(mrow, mi);
349 // if there was no contents and the array is editable, then we
350 // insert a grey box instead.
351 if (!has_contents && mi.base.macro_nesting == 1) {
352 // mathclass is unknown because it is irrelevant for spacing
353 MathRow::Element e(mi, MathRow::BOX);
354 e.color = Color_mathmacroblend;
359 MathRow::Element e_end(mi, MathRow::END);
361 mrow.push_back(e_end);
366 void MathMacro::beforeMetrics() const
372 void MathMacro::afterMetrics() const
378 void MathMacro::beforeDraw(PainterInfo const & pi) const
380 if (d->editing_[pi.base.bv])
381 pi.pain.enterMonochromeMode(Color_mathbg, Color_mathmacroblend);
385 void MathMacro::afterDraw(PainterInfo const & pi) const
387 if (d->editing_[pi.base.bv])
388 pi.pain.leaveMonochromeMode();
392 Inset * MathMacro::clone() const
394 MathMacro * copy = new MathMacro(*this);
395 copy->d->needsUpdate_ = true;
396 //copy->d->expanded_.clear();
401 void MathMacro::normalize(NormalStream & os) const
403 os << "[macro " << name();
404 for (size_t i = 0; i < nargs(); ++i)
405 os << ' ' << cell(i);
410 MathMacro::DisplayMode MathMacro::displayMode() const
412 return d->displayMode_;
416 bool MathMacro::extraBraces() const
418 return d->displayMode_ == DISPLAY_NORMAL && arity() > 0;
422 docstring MathMacro::name() const
424 if (d->displayMode_ == DISPLAY_UNFOLDED)
425 return asString(cell(0));
431 docstring MathMacro::macroName() const
437 int MathMacro::nesting() const
443 void MathMacro::cursorPos(BufferView const & bv,
444 CursorSlice const & sl, bool boundary, int & x, int & y) const
446 // We may have 0 arguments, but InsetMathNest requires at least one.
448 InsetMathNest::cursorPos(bv, sl, boundary, x, y);
452 bool MathMacro::editMode(BufferView const * bv) const {
453 // find this in cursor trace
454 Cursor const & cur = bv->cursor();
455 for (size_t i = 0; i != cur.depth(); ++i)
456 if (&cur[i].inset() == this) {
457 // look if there is no other macro in edit mode above
459 for (; i != cur.depth(); ++i) {
460 InsetMath * im = cur[i].asInsetMath();
462 MathMacro const * macro = im->asMacro();
463 if (macro && macro->displayMode() == DISPLAY_NORMAL)
468 // ok, none found, I am the highest one
476 MacroData const * MathMacro::macro() const
482 bool MathMacro::editMetrics(BufferView const * bv) const
484 return d->editing_[bv];
488 Inset::marker_type MathMacro::marker() const
490 switch (d->displayMode_) {
492 case DISPLAY_INTERACTIVE_INIT:
494 case DISPLAY_UNFOLDED:
497 switch (lyxrc.macro_edit_style) {
498 case LyXRC::MACRO_EDIT_LIST:
500 case LyXRC::MACRO_EDIT_INLINE_BOX:
509 void MathMacro::metrics(MetricsInfo & mi, Dimension & dim) const
511 /// The macro nesting can change display of insets. Change it locally.
512 Changer chg = make_change(mi.base.macro_nesting, d->nesting_);
514 // set edit mode for which we will have calculated metrics. But only
515 d->editing_[mi.base.bv] = editMode(mi.base.bv);
517 // calculate new metrics according to display mode
518 if (d->displayMode_ == DISPLAY_INIT || d->displayMode_ == DISPLAY_INTERACTIVE_INIT) {
519 Changer dummy = mi.base.changeFontSet("lyxtex");
520 mathed_string_dim(mi.base.font, from_ascii("\\") + name(), dim);
521 } else if (d->displayMode_ == DISPLAY_UNFOLDED) {
522 Changer dummy = mi.base.changeFontSet("lyxtex");
523 cell(0).metrics(mi, dim);
525 mathed_string_dim(mi.base.font, from_ascii("\\"), bsdim);
526 dim.wid += bsdim.width() + 1;
527 dim.asc = max(bsdim.ascent(), dim.ascent());
528 dim.des = max(bsdim.descent(), dim.descent());
529 } else if (lyxrc.macro_edit_style == LyXRC::MACRO_EDIT_LIST
530 && d->editing_[mi.base.bv]) {
531 // Macro will be edited in a old-style list mode here:
535 FontInfo labelFont = sane_font;
536 math_font_max_dim(labelFont, fontDim.asc, fontDim.des);
538 // get dimension of components of list view
540 nameDim.wid = mathed_string_width(mi.base.font, from_ascii("Macro \\") + name() + ": ");
541 nameDim.asc = fontDim.asc;
542 nameDim.des = fontDim.des;
545 argDim.wid = mathed_string_width(labelFont, from_ascii("#9: "));
546 argDim.asc = fontDim.asc;
547 argDim.des = fontDim.des;
550 d->definition_.metrics(mi, defDim);
553 dim.wid = nameDim.wid + defDim.wid;
554 dim.asc = max(nameDim.asc, defDim.asc);
555 dim.des = max(nameDim.des, defDim.des);
557 for (idx_type i = 0; i < nargs(); ++i) {
559 cell(i).metrics(mi, cdim);
560 dim.des += max(argDim.height(), cdim.height()) + 1;
561 dim.wid = max(dim.wid, argDim.wid + cdim.wid);
564 // make space for box and markers, 2 pixels
571 // calculate metrics, hoping that all cells are seen
573 d->expanded_.metrics(mi, dim);
575 // otherwise do a manual metrics call
576 CoordCache & coords = mi.base.bv->coordCache();
577 for (idx_type i = 0; i < nargs(); ++i) {
578 if (!coords.getArrays().hasDim(&cell(i))) {
580 cell(i).metrics(mi, tdim);
585 // calculate dimension with label while editing
586 if (lyxrc.macro_edit_style == LyXRC::MACRO_EDIT_INLINE_BOX
587 && d->editing_[mi.base.bv]) {
589 font.setSize(FONT_SIZE_TINY);
591 mathed_string_dim(font, name(), namedim);
593 dim.wid += 2 + namedim.wid + 2 + 2;
594 dim.asc = max(dim.asc, namedim.asc) + 2;
595 dim.des = max(dim.des, namedim.des) + 2;
597 dim.wid = max(1 + namedim.wid + 1, 2 + dim.wid + 2);
598 dim.asc += 1 + namedim.height() + 1;
605 int MathMacro::kerning(BufferView const * bv) const {
606 if (d->displayMode_ == DISPLAY_NORMAL && !d->editing_[bv])
607 return d->expanded_.kerning(bv);
613 void MathMacro::updateMacro(MacroContext const & mc)
616 d->macro_ = mc.get(name());
617 if (d->macro_ && d->macroBackup_ != *d->macro_) {
618 d->macroBackup_ = *d->macro_;
619 d->needsUpdate_ = true;
627 class MathMacro::UpdateLocker
630 explicit UpdateLocker(MathMacro & mm) : mac(mm)
632 mac.d->isUpdating_ = true;
634 ~UpdateLocker() { mac.d->isUpdating_ = false; }
638 /** Avoid wrong usage of UpdateLocker.
639 To avoid wrong usage:
640 UpdateLocker(...); // wrong
641 UpdateLocker locker(...); // right
643 #define UpdateLocker(x) unnamed_UpdateLocker;
644 // Tip gotten from Bobby Schmidt's column in C/C++ Users Journal
647 void MathMacro::updateRepresentation(Cursor * cur, MacroContext const & mc,
648 UpdateType utype, int nesting)
650 // block recursive calls (bug 8999)
654 UpdateLocker locker(*this);
660 // remember nesting level of this macro
661 d->nesting_ = nesting;
664 d->requires_ = d->macro_->requires();
667 // non-normal mode? We are done!
668 || (d->displayMode_ != DISPLAY_NORMAL))
671 d->needsUpdate_ = false;
673 // get default values of macro
674 vector<docstring> const & defaults = d->macro_->defaults();
676 // create MathMacroArgumentValue objects pointing to the cells of the macro
677 vector<MathData> values(nargs());
678 for (size_t i = 0; i < nargs(); ++i) {
679 ArgumentProxy * proxy;
680 if (i < defaults.size())
681 proxy = new ArgumentProxy(this, i, defaults[i]);
683 proxy = new ArgumentProxy(this, i);
684 values[i].insert(0, MathAtom(proxy));
686 // expanding macro with the values
687 // Only update the argument macros if anything was expanded, otherwise
688 // we would get an endless loop (bug 9140). UpdateLocker does not work
689 // in this case, since MacroData::expand() creates new MathMacro
690 // objects, so this would be a different recursion path than the one
691 // protected by UpdateLocker.
692 if (d->macro_->expand(values, d->expanded_)) {
693 if (utype == OutputUpdate && !d->expanded_.empty())
694 d->expanded_.updateMacros(cur, mc, utype, nesting);
696 // get definition for list edit mode
697 docstring const & display = d->macro_->display();
698 asArray(display.empty() ? d->macro_->definition() : display,
699 d->definition_, Parse::QUIET);
703 void MathMacro::draw(PainterInfo & pi, int x, int y) const
705 Dimension const dim = dimension(*pi.base.bv);
710 if (d->displayMode_ == DISPLAY_INIT || d->displayMode_ == DISPLAY_INTERACTIVE_INIT) {
711 Changer dummy = pi.base.changeFontSet("lyxtex");
712 pi.pain.text(x, y, from_ascii("\\") + name(), pi.base.font);
713 } else if (d->displayMode_ == DISPLAY_UNFOLDED) {
714 Changer dummy = pi.base.changeFontSet("lyxtex");
715 pi.pain.text(x, y, from_ascii("\\"), pi.base.font);
716 x += mathed_string_width(pi.base.font, from_ascii("\\")) + 1;
717 cell(0).draw(pi, x, y);
718 } else if (lyxrc.macro_edit_style == LyXRC::MACRO_EDIT_LIST
719 && d->editing_[pi.base.bv]) {
720 // Macro will be edited in a old-style list mode here:
722 CoordCache const & coords = pi.base.bv->coordCache();
723 FontInfo const & labelFont = sane_font;
725 // box needs one pixel
728 // get maximal font height
730 math_font_max_dim(pi.base.font, fontDim.asc, fontDim.des);
733 docstring label = from_ascii("Macro \\") + name() + from_ascii(": ");
734 pi.pain.text(x, y, label, labelFont);
735 x += mathed_string_width(labelFont, label);
738 d->definition_.draw(pi, x, y);
739 Dimension const & defDim = coords.getArrays().dim(&d->definition_);
740 y += max(fontDim.des, defDim.des);
743 docstring str = from_ascii("#9");
744 int strw1 = mathed_string_width(labelFont, from_ascii("#9"));
745 int strw2 = mathed_string_width(labelFont, from_ascii(": "));
747 for (idx_type i = 0; i < nargs(); ++i) {
749 Dimension const & cdim = coords.getArrays().dim(&cell(i));
751 y += max(fontDim.asc, cdim.asc) + 1;
755 pi.pain.text(x, y, str, labelFont);
757 pi.pain.text(x, y, from_ascii(":"), labelFont);
761 cell(i).draw(pi, x, y);
764 y += max(fontDim.des, cdim.des);
767 pi.pain.rectangle(expx, expy - dim.asc + 1, dim.wid - 1,
768 dim.height() - 2, Color_mathmacroframe);
770 bool drawBox = lyxrc.macro_edit_style == LyXRC::MACRO_EDIT_INLINE_BOX
771 && d->editing_[pi.base.bv];
774 for (size_t i = 0; i < nargs(); ++i)
775 cell(i).setXY(*pi.base.bv, x, y);
778 // draw header and rectangle around
780 font.setSize(FONT_SIZE_TINY);
781 font.setColor(Color_mathmacrolabel);
783 mathed_string_dim(font, name(), namedim);
785 pi.pain.fillRectangle(x, y - dim.asc, dim.wid, 1 + namedim.height() + 1, Color_mathmacrobg);
786 pi.pain.text(x + 1, y - dim.asc + namedim.asc + 2, name(), font);
787 expx += (dim.wid - d->expanded_.dimension(*pi.base.bv).width()) / 2;
791 d->expanded_.draw(pi, expx, expy);
795 pi.pain.rectangle(x, y - dim.asc, dim.wid,
796 dim.height(), Color_mathmacroframe);
799 // edit mode changed?
800 if (d->editing_[pi.base.bv] != editMode(pi.base.bv))
801 pi.base.bv->cursor().screenUpdateFlags(Update::SinglePar);
805 void MathMacro::drawSelection(PainterInfo & pi, int x, int y) const
807 // We may have 0 arguments, but InsetMathNest requires at least one.
809 InsetMathNest::drawSelection(pi, x, y);
813 void MathMacro::setDisplayMode(MathMacro::DisplayMode mode, int appetite)
815 if (d->displayMode_ != mode) {
816 // transfer name if changing from or to DISPLAY_UNFOLDED
817 if (mode == DISPLAY_UNFOLDED) {
819 asArray(d->name_, cell(0));
820 } else if (d->displayMode_ == DISPLAY_UNFOLDED) {
821 d->name_ = asString(cell(0));
825 d->displayMode_ = mode;
826 d->needsUpdate_ = true;
829 // the interactive init mode is non-greedy by default
831 d->appetite_ = (mode == DISPLAY_INTERACTIVE_INIT) ? 0 : 9;
833 d->appetite_ = size_t(appetite);
837 MathMacro::DisplayMode MathMacro::computeDisplayMode() const
839 if (d->nextFoldMode_ == true && d->macro_ && !d->macro_->locked())
840 return DISPLAY_NORMAL;
842 return DISPLAY_UNFOLDED;
846 bool MathMacro::validName() const
848 docstring n = name();
853 // converting back and force doesn't swallow anything?
856 if (asString(ma) != n)
860 for (size_t i = 0; i<n.size(); ++i) {
861 if (!(n[i] >= 'a' && n[i] <= 'z')
862 && !(n[i] >= 'A' && n[i] <= 'Z')
871 size_t MathMacro::arity() const
873 if (d->displayMode_ == DISPLAY_NORMAL )
874 return cells_.size();
880 size_t MathMacro::optionals() const
882 return d->optionals_;
886 void MathMacro::setOptionals(int n)
888 if (n <= int(nargs()))
893 size_t MathMacro::appetite() const
899 MathClass MathMacro::mathClass() const
901 // This can be just a heuristic, since it is only considered for display
902 // when the macro is not linearised. Therefore it affects:
903 // * The spacing of the inset while being edited,
904 // * Intelligent splitting
905 // * Cursor word movement (Ctrl-Arrow).
906 if (MacroData const * m = macroBackup()) {
907 // If it is a global macro and is defined explicitly
909 MathClass mc = string_to_class(m->symbol()->extra);
910 if (mc != MC_UNKNOWN)
914 // Otherwise guess from the expanded macro
915 return d->expanded_.mathClass();
919 InsetMath::mode_type MathMacro::currentMode() const
921 // There is no way to guess the mode of user defined macros, so they are
922 // always assumed to be mathmode. Only the global macros defined in
923 // lib/symbols may be textmode.
924 mode_type mode = modeToEnsure();
925 return (mode == UNDECIDED_MODE) ? MATH_MODE : mode;
929 InsetMath::mode_type MathMacro::modeToEnsure() const
931 // User defined macros can be either text mode or math mode for output and
932 // display. There is no way to guess. For global macros defined in
933 // lib/symbols, we ensure textmode if flagged as such, otherwise we ensure
935 if (MacroData const * m = macroBackup())
937 return (m->symbol()->extra == "textmode") ? TEXT_MODE : MATH_MODE;
938 return UNDECIDED_MODE;
942 MacroData const * MathMacro::macroBackup() const
945 return &d->macroBackup_;
946 if (MacroData const * data = MacroTable::globalMacros().get(name()))
952 void MathMacro::validate(LaTeXFeatures & features) const
954 // Immediately after a document is loaded, in some cases the MacroData
955 // of the global macros defined in the lib/symbols file may still not
956 // be known to the macro machinery because it will be set only after
957 // the first call to updateMacros(). This is not a problem unless
958 // instant preview is on for math, in which case we will be missing
959 // the corresponding requirements.
960 // In this case, we get the required info from the global macro table.
961 if (!d->requires_.empty())
962 features.require(d->requires_);
963 else if (!d->macro_) {
964 // Update requires for known global macros.
965 MacroData const * data = MacroTable::globalMacros().get(name());
966 if (data && !data->requires().empty())
967 features.require(data->requires());
970 if (name() == "binom")
971 features.require("binom");
973 // validate the cells and the definition
974 if (displayMode() == DISPLAY_NORMAL) {
975 d->definition_.validate(features);
976 InsetMathNest::validate(features);
981 void MathMacro::edit(Cursor & cur, bool front, EntryDirection entry_from)
983 cur.screenUpdateFlags(Update::SinglePar);
984 InsetMathNest::edit(cur, front, entry_from);
988 Inset * MathMacro::editXY(Cursor & cur, int x, int y)
990 // We may have 0 arguments, but InsetMathNest requires at least one.
992 cur.screenUpdateFlags(Update::SinglePar);
993 return InsetMathNest::editXY(cur, x, y);
999 void MathMacro::removeArgument(Inset::pos_type pos) {
1000 if (d->displayMode_ == DISPLAY_NORMAL) {
1001 LASSERT(size_t(pos) < cells_.size(), return);
1002 cells_.erase(cells_.begin() + pos);
1003 if (size_t(pos) < d->attachedArgsNum_)
1004 --d->attachedArgsNum_;
1005 if (size_t(pos) < d->optionals_) {
1009 d->needsUpdate_ = true;
1014 void MathMacro::insertArgument(Inset::pos_type pos) {
1015 if (d->displayMode_ == DISPLAY_NORMAL) {
1016 LASSERT(size_t(pos) <= cells_.size(), return);
1017 cells_.insert(cells_.begin() + pos, MathData());
1018 if (size_t(pos) < d->attachedArgsNum_)
1019 ++d->attachedArgsNum_;
1020 if (size_t(pos) < d->optionals_)
1023 d->needsUpdate_ = true;
1028 void MathMacro::detachArguments(vector<MathData> & args, bool strip)
1030 LASSERT(d->displayMode_ == DISPLAY_NORMAL, return);
1033 // strip off empty cells, but not more than arity-attachedArgsNum_
1036 for (i = cells_.size(); i > d->attachedArgsNum_; --i)
1037 if (!cell(i - 1).empty()) break;
1041 d->attachedArgsNum_ = 0;
1042 d->expanded_ = MathData();
1045 d->needsUpdate_ = true;
1049 void MathMacro::attachArguments(vector<MathData> const & args, size_t arity, int optionals)
1051 LASSERT(d->displayMode_ == DISPLAY_NORMAL, return);
1053 d->attachedArgsNum_ = args.size();
1054 cells_.resize(arity);
1055 d->expanded_ = MathData();
1056 d->optionals_ = optionals;
1058 d->needsUpdate_ = true;
1062 bool MathMacro::idxFirst(Cursor & cur) const
1064 cur.screenUpdateFlags(Update::SinglePar);
1065 return InsetMathNest::idxFirst(cur);
1069 bool MathMacro::idxLast(Cursor & cur) const
1071 cur.screenUpdateFlags(Update::SinglePar);
1072 return InsetMathNest::idxLast(cur);
1076 bool MathMacro::notifyCursorLeaves(Cursor const & old, Cursor & cur)
1078 if (d->displayMode_ == DISPLAY_UNFOLDED) {
1079 docstring const & unfolded_name = name();
1080 if (unfolded_name != d->name_) {
1081 // The macro name was changed
1082 Cursor inset_cursor = old;
1083 int macroSlice = inset_cursor.find(this);
1084 // returning true means the cursor is "now" invalid,
1086 LASSERT(macroSlice != -1, return true);
1087 inset_cursor.cutOff(macroSlice);
1088 inset_cursor.recordUndoInset();
1090 inset_cursor.cell().erase(inset_cursor.pos());
1091 inset_cursor.cell().insert(inset_cursor.pos(),
1092 createInsetMath(unfolded_name, cur.buffer()));
1094 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
1098 cur.screenUpdateFlags(Update::Force);
1099 return InsetMathNest::notifyCursorLeaves(old, cur);
1103 void MathMacro::fold(Cursor & cur)
1105 if (!d->nextFoldMode_) {
1106 d->nextFoldMode_ = true;
1107 cur.screenUpdateFlags(Update::SinglePar);
1112 void MathMacro::unfold(Cursor & cur)
1114 if (d->nextFoldMode_) {
1115 d->nextFoldMode_ = false;
1116 cur.screenUpdateFlags(Update::SinglePar);
1121 bool MathMacro::folded() const
1123 return d->nextFoldMode_;
1127 void MathMacro::write(WriteStream & os) const
1129 mode_type mode = modeToEnsure();
1130 bool textmode_macro = mode == TEXT_MODE;
1131 bool needs_mathmode = mode == MATH_MODE;
1132 MathEnsurer ensurer(os, needs_mathmode, true, textmode_macro);
1135 if (d->displayMode_ != DISPLAY_NORMAL) {
1136 os << "\\" << name();
1137 if (name().size() != 1 || isAlphaASCII(name()[0]))
1138 os.pendingSpace(true);
1143 // we should be ok to continue even if this fails.
1146 // We may already be in the argument of a macro
1147 bool const inside_macro = os.insideMacro();
1148 os.insideMacro(true);
1150 // Enclose in braces to avoid latex errors with xargs if we have
1151 // optional arguments and are in the optional argument of a macro
1152 if (d->optionals_ && inside_macro)
1155 // Always protect macros in a fragile environment
1159 os << "\\" << name();
1162 // Optional arguments:
1163 // First find last non-empty optional argument
1164 idx_type emptyOptFrom = 0;
1166 for (; i < cells_.size() && i < d->optionals_; ++i) {
1167 if (!cell(i).empty())
1168 emptyOptFrom = i + 1;
1171 // print out optionals
1172 for (i=0; i < cells_.size() && i < emptyOptFrom; ++i) {
1174 os << "[" << cell(i) << "]";
1177 // skip the tailing empty optionals
1180 // Print remaining arguments
1181 for (; i < cells_.size(); ++i) {
1182 if (cell(i).size() == 1
1183 && cell(i)[0].nucleus()->asCharInset()
1184 && isASCII(cell(i)[0].nucleus()->asCharInset()->getChar())) {
1189 os << "{" << cell(i) << "}";
1193 // Close the opened brace or add space if there was no argument
1194 if (d->optionals_ && inside_macro)
1197 os.pendingSpace(true);
1199 os.insideMacro(inside_macro);
1203 void MathMacro::maple(MapleStream & os) const
1205 lyx::maple(d->expanded_, os);
1209 void MathMacro::maxima(MaximaStream & os) const
1211 lyx::maxima(d->expanded_, os);
1215 void MathMacro::mathematica(MathematicaStream & os) const
1217 lyx::mathematica(d->expanded_, os);
1221 void MathMacro::mathmlize(MathStream & os) const
1223 // macro_ is 0 if this is an unknown macro
1224 LATTEST(d->macro_ || d->displayMode_ != DISPLAY_NORMAL);
1226 docstring const xmlname = d->macro_->xmlname();
1227 if (!xmlname.empty()) {
1228 char const * type = d->macro_->MathMLtype();
1229 os << '<' << type << "> " << xmlname << " </"
1234 if (d->expanded_.empty()) {
1235 // this means that we do not recognize the macro
1236 throw MathExportException();
1242 void MathMacro::htmlize(HtmlStream & os) const
1244 // macro_ is 0 if this is an unknown macro
1245 LATTEST(d->macro_ || d->displayMode_ != DISPLAY_NORMAL);
1247 docstring const xmlname = d->macro_->xmlname();
1248 if (!xmlname.empty()) {
1249 os << ' ' << xmlname << ' ';
1253 if (d->expanded_.empty()) {
1254 // this means that we do not recognize the macro
1255 throw MathExportException();
1261 void MathMacro::octave(OctaveStream & os) const
1263 lyx::octave(d->expanded_, os);
1267 void MathMacro::infoize(odocstream & os) const
1269 os << bformat(_("Macro: %1$s"), name());
1273 void MathMacro::infoize2(odocstream & os) const
1275 os << bformat(_("Macro: %1$s"), name());
1279 bool MathMacro::completionSupported(Cursor const & cur) const
1281 if (displayMode() != DISPLAY_UNFOLDED)
1282 return InsetMathNest::completionSupported(cur);
1284 return lyxrc.completion_popup_math
1285 && displayMode() == DISPLAY_UNFOLDED
1286 && cur.bv().cursor().pos() == int(name().size());
1290 bool MathMacro::inlineCompletionSupported(Cursor const & cur) const
1292 if (displayMode() != DISPLAY_UNFOLDED)
1293 return InsetMathNest::inlineCompletionSupported(cur);
1295 return lyxrc.completion_inline_math
1296 && displayMode() == DISPLAY_UNFOLDED
1297 && cur.bv().cursor().pos() == int(name().size());
1301 bool MathMacro::automaticInlineCompletion() const
1303 if (displayMode() != DISPLAY_UNFOLDED)
1304 return InsetMathNest::automaticInlineCompletion();
1306 return lyxrc.completion_inline_math;
1310 bool MathMacro::automaticPopupCompletion() const
1312 if (displayMode() != DISPLAY_UNFOLDED)
1313 return InsetMathNest::automaticPopupCompletion();
1315 return lyxrc.completion_popup_math;
1319 CompletionList const *
1320 MathMacro::createCompletionList(Cursor const & cur) const
1322 if (displayMode() != DISPLAY_UNFOLDED)
1323 return InsetMathNest::createCompletionList(cur);
1325 return new MathCompletionList(cur.bv().cursor());
1329 docstring MathMacro::completionPrefix(Cursor const & cur) const
1331 if (displayMode() != DISPLAY_UNFOLDED)
1332 return InsetMathNest::completionPrefix(cur);
1334 if (!completionSupported(cur))
1337 return "\\" + name();
1341 bool MathMacro::insertCompletion(Cursor & cur, docstring const & s,
1344 if (displayMode() != DISPLAY_UNFOLDED)
1345 return InsetMathNest::insertCompletion(cur, s, finished);
1347 if (!completionSupported(cur))
1350 // append completion
1351 docstring newName = name() + s;
1352 asArray(newName, cell(0));
1353 cur.bv().cursor().pos() = name().size();
1354 cur.screenUpdateFlags(Update::SinglePar);
1358 cur.bv().cursor().pop();
1359 ++cur.bv().cursor().pos();
1360 cur.screenUpdateFlags(Update::SinglePar);
1367 void MathMacro::completionPosAndDim(Cursor const & cur, int & x, int & y,
1368 Dimension & dim) const
1370 if (displayMode() != DISPLAY_UNFOLDED)
1371 InsetMathNest::completionPosAndDim(cur, x, y, dim);
1373 // get inset dimensions
1374 dim = cur.bv().coordCache().insets().dim(this);
1375 // FIXME: these 3 are no accurate, but should depend on the font.
1376 // Now the popup jumps down if you enter a char with descent > 0.
1382 = cur.bv().coordCache().insets().xy(this);