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"
35 #include "frontends/Painter.h"
37 #include "support/debug.h"
38 #include "support/lassert.h"
39 #include "support/textutils.h"
49 /// A proxy for the macro values
50 class ArgumentProxy : public InsetMath {
53 ArgumentProxy(MathMacro & mathMacro, size_t idx)
54 : mathMacro_(mathMacro), idx_(idx) {}
56 ArgumentProxy(MathMacro & mathMacro, size_t idx, docstring const & def)
57 : mathMacro_(mathMacro), idx_(idx)
62 InsetCode lyxCode() const { return ARGUMENT_PROXY_CODE; }
64 void metrics(MetricsInfo & mi, Dimension & dim) const {
65 mathMacro_.macro()->unlock();
66 mathMacro_.cell(idx_).metrics(mi, dim);
68 if (!mathMacro_.editMetrics(mi.base.bv)
69 && mathMacro_.cell(idx_).empty())
70 def_.metrics(mi, dim);
72 mathMacro_.macro()->lock();
74 // FIXME Other external things need similar treatment.
76 void mathmlize(MathStream & ms) const { ms << mathMacro_.cell(idx_); }
78 void draw(PainterInfo & pi, int x, int y) const {
79 if (mathMacro_.editMetrics(pi.base.bv)) {
80 // The only way a ArgumentProxy can appear is in a cell of the
81 // MathMacro. Moreover the cells are only drawn in the DISPLAY_FOLDED
82 // mode and then, if the macro is edited the monochrome
83 // mode is entered by the MathMacro before calling the cells' draw
84 // method. Then eventually this code is reached and the proxy leaves
85 // monochrome mode temporarely. Hence, if it is not in monochrome
86 // here (and the assert triggers in pain.leaveMonochromeMode())
88 pi.pain.leaveMonochromeMode();
89 mathMacro_.cell(idx_).draw(pi, x, y);
90 pi.pain.enterMonochromeMode(Color_mathbg, Color_mathmacroblend);
91 } else if (mathMacro_.cell(idx_).empty()) {
92 mathMacro_.cell(idx_).setXY(*pi.base.bv, x, y);
95 mathMacro_.cell(idx_).draw(pi, x, y);
98 size_t idx() const { return idx_; }
100 int kerning(BufferView const * bv) const
102 if (mathMacro_.editMetrics(bv)
103 || !mathMacro_.cell(idx_).empty())
104 return mathMacro_.cell(idx_).kerning(bv);
106 return def_.kerning(bv);
111 Inset * clone() const
113 return new ArgumentProxy(*this);
116 MathMacro & mathMacro_;
124 MathMacro::MathMacro(Buffer * buf, docstring const & name)
125 : InsetMathNest(buf, 0), name_(name), displayMode_(DISPLAY_INIT),
126 expanded_(buf), attachedArgsNum_(0), optionals_(0), nextFoldMode_(true),
127 macroBackup_(buf), macro_(0), needsUpdate_(false), appetite_(9)
131 Inset * MathMacro::clone() const
133 MathMacro * copy = new MathMacro(*this);
134 copy->needsUpdate_ = true;
135 //copy->expanded_.cell(0).clear();
140 docstring MathMacro::name() const
142 if (displayMode_ == DISPLAY_UNFOLDED)
143 return asString(cell(0));
149 void MathMacro::cursorPos(BufferView const & bv,
150 CursorSlice const & sl, bool boundary, int & x, int & y) const
152 // We may have 0 arguments, but InsetMathNest requires at least one.
154 InsetMathNest::cursorPos(bv, sl, boundary, x, y);
158 bool MathMacro::editMode(BufferView const * bv) const {
159 // find this in cursor trace
160 Cursor const & cur = bv->cursor();
161 for (size_t i = 0; i != cur.depth(); ++i)
162 if (&cur[i].inset() == this) {
163 // look if there is no other macro in edit mode above
165 for (; i != cur.depth(); ++i) {
166 MathMacro const * macro = dynamic_cast<MathMacro const *>(&cur[i].inset());
167 if (macro && macro->displayMode() == DISPLAY_NORMAL)
171 // ok, none found, I am the highest one
179 bool MathMacro::editMetrics(BufferView const * bv) const
185 void MathMacro::metrics(MetricsInfo & mi, Dimension & dim) const
187 // set edit mode for which we will have calculated metrics. But only
188 editing_[mi.base.bv] = editMode(mi.base.bv);
190 // calculate new metrics according to display mode
191 if (displayMode_ == DISPLAY_INIT || displayMode_ == DISPLAY_INTERACTIVE_INIT) {
192 mathed_string_dim(mi.base.font, from_ascii("\\") + name(), dim);
193 } else if (displayMode_ == DISPLAY_UNFOLDED) {
194 cell(0).metrics(mi, dim);
196 mathed_string_dim(mi.base.font, from_ascii("\\"), bsdim);
197 dim.wid += bsdim.width() + 1;
198 dim.asc = max(bsdim.ascent(), dim.ascent());
199 dim.des = max(bsdim.descent(), dim.descent());
201 } else if (lyxrc.macro_edit_style == LyXRC::MACRO_EDIT_LIST
202 && editing_[mi.base.bv]) {
203 // Macro will be edited in a old-style list mode here:
205 LASSERT(macro_ != 0, /**/);
207 FontInfo labelFont = sane_font;
208 math_font_max_dim(labelFont, fontDim.asc, fontDim.des);
210 // get dimension of components of list view
212 nameDim.wid = mathed_string_width(mi.base.font, from_ascii("Macro \\") + name() + ": ");
213 nameDim.asc = fontDim.asc;
214 nameDim.des = fontDim.des;
217 argDim.wid = mathed_string_width(labelFont, from_ascii("#9: "));
218 argDim.asc = fontDim.asc;
219 argDim.des = fontDim.des;
222 definition_.metrics(mi, defDim);
225 dim.wid = nameDim.wid + defDim.wid;
226 dim.asc = max(nameDim.asc, defDim.asc);
227 dim.des = max(nameDim.des, defDim.des);
229 for (idx_type i = 0; i < nargs(); ++i) {
231 cell(i).metrics(mi, cdim);
232 dim.des += max(argDim.height(), cdim.height()) + 1;
233 dim.wid = max(dim.wid, argDim.wid + cdim.wid);
236 // make space for box and markers, 2 pixels
240 metricsMarkers2(dim);
242 LASSERT(macro_ != 0, /**/);
244 // calculate metrics, hoping that all cells are seen
246 expanded_.cell(0).metrics(mi, dim);
248 // otherwise do a manual metrics call
249 CoordCache & coords = mi.base.bv->coordCache();
250 for (idx_type i = 0; i < nargs(); ++i) {
251 if (!coords.getArrays().has(&cell(i))) {
253 cell(i).metrics(mi, tdim);
258 // calculate dimension with label while editing
259 if (lyxrc.macro_edit_style == LyXRC::MACRO_EDIT_INLINE_BOX
260 && editing_[mi.base.bv]) {
261 FontInfo font = mi.base.font;
262 augmentFont(font, from_ascii("lyxtex"));
264 mathed_string_dim(font, name(), namedim);
266 dim.wid += 2 + namedim.wid + 2 + 2;
267 dim.asc = max(dim.asc, namedim.asc) + 2;
268 dim.des = max(dim.des, namedim.des) + 2;
270 dim.wid = max(1 + namedim.wid + 1, 2 + dim.wid + 2);
271 dim.asc += 1 + namedim.height() + 1;
279 int MathMacro::kerning(BufferView const * bv) const {
280 if (displayMode_ == DISPLAY_NORMAL && !editing_[bv])
281 return expanded_.kerning(bv);
287 void MathMacro::updateMacro(MacroContext const & mc)
290 macro_ = mc.get(name());
291 if (macro_ && macroBackup_ != *macro_) {
292 macroBackup_ = *macro_;
301 void MathMacro::updateRepresentation()
308 requires_ = macro_->requires();
311 // non-normal mode? We are done!
312 || (displayMode_ != DISPLAY_NORMAL))
315 needsUpdate_ = false;
317 // get default values of macro
318 vector<docstring> const & defaults = macro_->defaults();
320 // create MathMacroArgumentValue objects pointing to the cells of the macro
321 vector<MathData> values(nargs());
322 for (size_t i = 0; i < nargs(); ++i) {
323 ArgumentProxy * proxy;
324 if (i < defaults.size())
325 proxy = new ArgumentProxy(*this, i, defaults[i]);
327 proxy = new ArgumentProxy(*this, i);
328 values[i].insert(0, MathAtom(proxy));
330 // expanding macro with the values
331 macro_->expand(values, expanded_.cell(0));
332 // get definition for list edit mode
333 docstring const & display = macro_->display();
334 asArray(display.empty() ? macro_->definition() : display, definition_);
338 void MathMacro::draw(PainterInfo & pi, int x, int y) const
340 Dimension const dim = dimension(*pi.base.bv);
342 setPosCache(pi, x, y);
346 if (displayMode_ == DISPLAY_INIT || displayMode_ == DISPLAY_INTERACTIVE_INIT) {
347 FontSetChanger dummy(pi.base, "lyxtex");
348 pi.pain.text(x, y, from_ascii("\\") + name(), pi.base.font);
349 } else if (displayMode_ == DISPLAY_UNFOLDED) {
350 FontSetChanger dummy(pi.base, "lyxtex");
351 pi.pain.text(x, y, from_ascii("\\"), pi.base.font);
352 x += mathed_string_width(pi.base.font, from_ascii("\\")) + 1;
353 cell(0).draw(pi, x, y);
354 drawMarkers(pi, expx, expy);
355 } else if (lyxrc.macro_edit_style == LyXRC::MACRO_EDIT_LIST
356 && editing_[pi.base.bv]) {
357 // Macro will be edited in a old-style list mode here:
359 CoordCache const & coords = pi.base.bv->coordCache();
360 FontInfo const & labelFont = sane_font;
362 // markers and box needs two pixels
365 // get maximal font height
367 math_font_max_dim(pi.base.font, fontDim.asc, fontDim.des);
370 docstring label = from_ascii("Macro \\") + name() + from_ascii(": ");
371 pi.pain.text(x, y, label, labelFont);
372 x += mathed_string_width(labelFont, label);
375 definition_.draw(pi, x, y);
376 Dimension const & defDim = coords.getArrays().dim(&definition_);
377 y += max(fontDim.des, defDim.des);
380 docstring str = from_ascii("#9");
381 int strw1 = mathed_string_width(labelFont, from_ascii("#9"));
382 int strw2 = mathed_string_width(labelFont, from_ascii(": "));
384 for (idx_type i = 0; i < nargs(); ++i) {
386 Dimension const & cdim = coords.getArrays().dim(&cell(i));
388 y += max(fontDim.asc, cdim.asc) + 1;
392 pi.pain.text(x, y, str, labelFont);
394 pi.pain.text(x, y, from_ascii(":"), labelFont);
398 cell(i).draw(pi, x, y);
401 y += max(fontDim.des, cdim.des);
404 pi.pain.rectangle(expx + 1, expy - dim.asc + 1, dim.wid - 3,
405 dim.height() - 2, Color_mathmacroframe);
406 drawMarkers2(pi, expx, expy);
408 bool drawBox = lyxrc.macro_edit_style == LyXRC::MACRO_EDIT_INLINE_BOX;
411 for (size_t i = 0; i < nargs(); ++i)
412 cell(i).setXY(*pi.base.bv, x, y);
414 if (drawBox && editing_[pi.base.bv]) {
415 // draw header and rectangle around
416 FontInfo font = pi.base.font;
417 augmentFont(font, from_ascii("lyxtex"));
418 font.setSize(FONT_SIZE_TINY);
419 font.setColor(Color_mathmacrolabel);
421 mathed_string_dim(font, name(), namedim);
423 pi.pain.fillRectangle(x, y - dim.asc, dim.wid, 1 + namedim.height() + 1, Color_mathmacrobg);
424 pi.pain.text(x + 1, y - dim.asc + namedim.asc + 2, name(), font);
425 expx += (dim.wid - expanded_.cell(0).dimension(*pi.base.bv).width()) / 2;
428 if (editing_[pi.base.bv]) {
429 pi.pain.enterMonochromeMode(Color_mathbg, Color_mathmacroblend);
430 expanded_.cell(0).draw(pi, expx, expy);
431 pi.pain.leaveMonochromeMode();
434 pi.pain.rectangle(x, y - dim.asc, dim.wid,
435 dim.height(), Color_mathmacroframe);
437 expanded_.cell(0).draw(pi, expx, expy);
440 drawMarkers(pi, x, y);
443 // edit mode changed?
444 if (editing_[pi.base.bv] != editMode(pi.base.bv))
445 pi.base.bv->cursor().updateFlags(Update::SinglePar);
449 void MathMacro::drawSelection(PainterInfo & pi, int x, int y) const
451 // We may have 0 arguments, but InsetMathNest requires at least one.
452 if (cells_.size() > 0)
453 InsetMathNest::drawSelection(pi, x, y);
457 void MathMacro::setDisplayMode(MathMacro::DisplayMode mode, int appetite)
459 if (displayMode_ != mode) {
460 // transfer name if changing from or to DISPLAY_UNFOLDED
461 if (mode == DISPLAY_UNFOLDED) {
463 asArray(name_, cell(0));
464 } else if (displayMode_ == DISPLAY_UNFOLDED) {
465 name_ = asString(cell(0));
473 // the interactive init mode is non-greedy by default
475 appetite_ = (mode == DISPLAY_INTERACTIVE_INIT) ? 0 : 9;
477 appetite_ = size_t(appetite);
481 MathMacro::DisplayMode MathMacro::computeDisplayMode() const
483 if (nextFoldMode_ == true && macro_ && !macro_->locked())
484 return DISPLAY_NORMAL;
486 return DISPLAY_UNFOLDED;
490 bool MathMacro::validName() const
492 docstring n = name();
498 // converting back and force doesn't swallow anything?
501 if (asString(ma) != n)
505 for (size_t i = 0; i<n.size(); ++i) {
506 if (!(n[i] >= 'a' && n[i] <= 'z')
507 && !(n[i] >= 'A' && n[i] <= 'Z')
516 void MathMacro::validate(LaTeXFeatures & features) const
518 if (!requires_.empty())
519 features.require(requires_);
521 if (name() == "binom")
522 features.require("binom");
524 // validate the cells and the definition
525 if (displayMode() == DISPLAY_NORMAL) {
526 definition_.validate(features);
527 InsetMathNest::validate(features);
532 void MathMacro::edit(Cursor & cur, bool front, EntryDirection entry_from)
534 cur.updateFlags(Update::SinglePar);
535 InsetMathNest::edit(cur, front, entry_from);
539 Inset * MathMacro::editXY(Cursor & cur, int x, int y)
541 // We may have 0 arguments, but InsetMathNest requires at least one.
543 cur.updateFlags(Update::SinglePar);
544 return InsetMathNest::editXY(cur, x, y);
550 void MathMacro::removeArgument(Inset::pos_type pos) {
551 if (displayMode_ == DISPLAY_NORMAL) {
552 LASSERT(size_t(pos) < cells_.size(), /**/);
553 cells_.erase(cells_.begin() + pos);
554 if (size_t(pos) < attachedArgsNum_)
556 if (size_t(pos) < optionals_) {
565 void MathMacro::insertArgument(Inset::pos_type pos) {
566 if (displayMode_ == DISPLAY_NORMAL) {
567 LASSERT(size_t(pos) <= cells_.size(), /**/);
568 cells_.insert(cells_.begin() + pos, MathData());
569 if (size_t(pos) < attachedArgsNum_)
571 if (size_t(pos) < optionals_)
579 void MathMacro::detachArguments(vector<MathData> & args, bool strip)
581 LASSERT(displayMode_ == DISPLAY_NORMAL, /**/);
584 // strip off empty cells, but not more than arity-attachedArgsNum_
587 for (i = cells_.size(); i > attachedArgsNum_; --i)
588 if (!cell(i - 1).empty()) break;
592 attachedArgsNum_ = 0;
593 expanded_.cell(0) = MathData();
600 void MathMacro::attachArguments(vector<MathData> const & args, size_t arity, int optionals)
602 LASSERT(displayMode_ == DISPLAY_NORMAL, /**/);
604 attachedArgsNum_ = args.size();
605 cells_.resize(arity);
606 expanded_.cell(0) = MathData();
607 optionals_ = optionals;
613 bool MathMacro::idxFirst(Cursor & cur) const
615 cur.updateFlags(Update::SinglePar);
616 return InsetMathNest::idxFirst(cur);
620 bool MathMacro::idxLast(Cursor & cur) const
622 cur.updateFlags(Update::SinglePar);
623 return InsetMathNest::idxLast(cur);
627 bool MathMacro::notifyCursorLeaves(Cursor const & old, Cursor & cur)
629 if (displayMode_ == DISPLAY_UNFOLDED) {
630 docstring const & unfolded_name = name();
631 if (unfolded_name != name_) {
632 // The macro name was changed
633 Cursor inset_cursor = old;
634 int macroSlice = inset_cursor.find(this);
635 LASSERT(macroSlice != -1, /**/);
636 inset_cursor.cutOff(macroSlice);
637 inset_cursor.recordUndoInset();
639 inset_cursor.cell().erase(inset_cursor.pos());
640 inset_cursor.cell().insert(inset_cursor.pos(),
641 createInsetMath(unfolded_name, cur.buffer()));
642 cur.updateFlags(cur.disp_.update() | Update::SinglePar);
646 cur.updateFlags(Update::Force);
647 return InsetMathNest::notifyCursorLeaves(old, cur);
651 void MathMacro::fold(Cursor & cur)
653 if (!nextFoldMode_) {
654 nextFoldMode_ = true;
655 cur.updateFlags(Update::SinglePar);
660 void MathMacro::unfold(Cursor & cur)
663 nextFoldMode_ = false;
664 cur.updateFlags(Update::SinglePar);
669 bool MathMacro::folded() const
671 return nextFoldMode_;
675 void MathMacro::write(WriteStream & os) const
677 MathEnsurer ensurer(os, macro_ != 0, true);
680 if (displayMode_ != DISPLAY_NORMAL) {
681 os << "\\" << name();
682 if (name().size() != 1 || isAlphaASCII(name()[0]))
683 os.pendingSpace(true);
688 LASSERT(macro_, /**/);
690 // optional arguments make macros fragile
691 if (optionals_ > 0 && os.fragile())
694 os << "\\" << name();
697 // Optional arguments:
698 // First find last non-empty optional argument
699 idx_type emptyOptFrom = 0;
701 for (; i < cells_.size() && i < optionals_; ++i) {
702 if (!cell(i).empty())
703 emptyOptFrom = i + 1;
706 // print out optionals
707 for (i=0; i < cells_.size() && i < emptyOptFrom; ++i) {
709 os << "[" << cell(i) << "]";
712 // skip the tailing empty optionals
715 // Print remaining arguments
716 for (; i < cells_.size(); ++i) {
717 if (cell(i).size() == 1
718 && cell(i)[0].nucleus()->asCharInset()
719 && cell(i)[0].nucleus()->asCharInset()->getChar() < 0x80) {
724 os << "{" << cell(i) << "}";
728 // add space if there was no argument
730 os.pendingSpace(true);
734 void MathMacro::maple(MapleStream & os) const
736 lyx::maple(expanded_.cell(0), os);
740 void MathMacro::mathmlize(MathStream & os) const
742 os << expanded_.cell(0);
746 void MathMacro::octave(OctaveStream & os) const
748 lyx::octave(expanded_.cell(0), os);
752 void MathMacro::infoize(odocstream & os) const
754 os << "Macro: " << name();
758 void MathMacro::infoize2(odocstream & os) const
760 os << "Macro: " << name();
765 bool MathMacro::completionSupported(Cursor const & cur) const
767 if (displayMode() != DISPLAY_UNFOLDED)
768 return InsetMathNest::completionSupported(cur);
770 return lyxrc.completion_popup_math
771 && displayMode() == DISPLAY_UNFOLDED
772 && cur.bv().cursor().pos() == int(name().size());
776 bool MathMacro::inlineCompletionSupported(Cursor const & cur) const
778 if (displayMode() != DISPLAY_UNFOLDED)
779 return InsetMathNest::inlineCompletionSupported(cur);
781 return lyxrc.completion_inline_math
782 && displayMode() == DISPLAY_UNFOLDED
783 && cur.bv().cursor().pos() == int(name().size());
787 bool MathMacro::automaticInlineCompletion() const
789 if (displayMode() != DISPLAY_UNFOLDED)
790 return InsetMathNest::automaticInlineCompletion();
792 return lyxrc.completion_inline_math;
796 bool MathMacro::automaticPopupCompletion() const
798 if (displayMode() != DISPLAY_UNFOLDED)
799 return InsetMathNest::automaticPopupCompletion();
801 return lyxrc.completion_popup_math;
805 CompletionList const *
806 MathMacro::createCompletionList(Cursor const & cur) const
808 if (displayMode() != DISPLAY_UNFOLDED)
809 return InsetMathNest::createCompletionList(cur);
811 return new MathCompletionList(cur.bv().cursor());
815 docstring MathMacro::completionPrefix(Cursor const & cur) const
817 if (displayMode() != DISPLAY_UNFOLDED)
818 return InsetMathNest::completionPrefix(cur);
820 if (!completionSupported(cur))
823 return "\\" + name();
827 bool MathMacro::insertCompletion(Cursor & cur, docstring const & s,
830 if (displayMode() != DISPLAY_UNFOLDED)
831 return InsetMathNest::insertCompletion(cur, s, finished);
833 if (!completionSupported(cur))
837 docstring newName = name() + s;
838 asArray(newName, cell(0));
839 cur.bv().cursor().pos() = name().size();
840 cur.updateFlags(Update::SinglePar);
844 cur.bv().cursor().pop();
845 ++cur.bv().cursor().pos();
846 cur.updateFlags(Update::SinglePar);
853 void MathMacro::completionPosAndDim(Cursor const & cur, int & x, int & y,
854 Dimension & dim) const
856 if (displayMode() != DISPLAY_UNFOLDED)
857 InsetMathNest::completionPosAndDim(cur, x, y, dim);
859 // get inset dimensions
860 dim = cur.bv().coordCache().insets().dim(this);
861 // FIXME: these 3 are no accurate, but should depend on the font.
862 // Now the popup jumps down if you enter a char with descent > 0.
868 = cur.bv().coordCache().insets().xy(this);