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 "MathStream.h"
21 #include "MathSupport.h"
24 #include "BufferView.h"
25 #include "CoordCache.h"
27 #include "FuncStatus.h"
28 #include "FuncRequest.h"
29 #include "LaTeXFeatures.h"
34 #include "frontends/Painter.h"
36 #include "support/debug.h"
37 #include "support/lassert.h"
38 #include "support/textutils.h"
48 /// A proxy for the macro values
49 class ArgumentProxy : public InsetMath {
52 ArgumentProxy(MathMacro & mathMacro, size_t idx)
53 : mathMacro_(mathMacro), idx_(idx) {}
55 ArgumentProxy(MathMacro & mathMacro, size_t idx, docstring const & def)
56 : mathMacro_(mathMacro), idx_(idx)
61 void metrics(MetricsInfo & mi, Dimension & dim) const {
62 mathMacro_.macro()->unlock();
63 mathMacro_.cell(idx_).metrics(mi, dim);
65 if (!mathMacro_.editMetrics(mi.base.bv)
66 && mathMacro_.cell(idx_).empty())
67 def_.metrics(mi, dim);
69 mathMacro_.macro()->lock();
72 void draw(PainterInfo & pi, int x, int y) const {
73 if (mathMacro_.editMetrics(pi.base.bv)) {
74 // The only way a ArgumentProxy can appear is in a cell of the
75 // MathMacro. Moreover the cells are only drawn in the DISPLAY_FOLDED
76 // mode and then, if the macro is edited the monochrome
77 // mode is entered by the MathMacro before calling the cells' draw
78 // method. Then eventually this code is reached and the proxy leaves
79 // monochrome mode temporarely. Hence, if it is not in monochrome
80 // here (and the assert triggers in pain.leaveMonochromeMode())
82 pi.pain.leaveMonochromeMode();
83 mathMacro_.cell(idx_).draw(pi, x, y);
84 pi.pain.enterMonochromeMode(Color_mathbg, Color_mathmacroblend);
85 } else if (mathMacro_.cell(idx_).empty()) {
86 mathMacro_.cell(idx_).setXY(*pi.base.bv, x, y);
89 mathMacro_.cell(idx_).draw(pi, x, y);
92 size_t idx() const { return idx_; }
94 int kerning(BufferView const * bv) const
96 if (mathMacro_.editMetrics(bv)
97 || !mathMacro_.cell(idx_).empty())
98 return mathMacro_.cell(idx_).kerning(bv);
100 return def_.kerning(bv);
105 Inset * clone() const
107 return new ArgumentProxy(*this);
110 MathMacro & mathMacro_;
118 MathMacro::MathMacro(docstring const & name)
119 : InsetMathNest(0), name_(name), displayMode_(DISPLAY_INIT),
120 attachedArgsNum_(0), optionals_(0), nextFoldMode_(true),
121 macro_(0), needsUpdate_(false), appetite_(9)
125 Inset * MathMacro::clone() const
127 MathMacro * copy = new MathMacro(*this);
128 copy->needsUpdate_ = true;
129 copy->expanded_.cell(0).clear();
134 docstring MathMacro::name() const
136 if (displayMode_ == DISPLAY_UNFOLDED)
137 return asString(cell(0));
143 void MathMacro::cursorPos(BufferView const & bv,
144 CursorSlice const & sl, bool boundary, int & x, int & y) const
146 // We may have 0 arguments, but InsetMathNest requires at least one.
148 InsetMathNest::cursorPos(bv, sl, boundary, x, y);
152 bool MathMacro::editMode(BufferView const * bv) const {
153 // find this in cursor trace
154 Cursor const & cur = bv->cursor();
155 for (size_t i = 0; i != cur.depth(); ++i)
156 if (&cur[i].inset() == this) {
157 // look if there is no other macro in edit mode above
159 for (; i != cur.depth(); ++i) {
160 MathMacro const * macro = dynamic_cast<MathMacro const *>(&cur[i].inset());
161 if (macro && macro->displayMode() == DISPLAY_NORMAL)
165 // ok, none found, I am the highest one
173 bool MathMacro::editMetrics(BufferView const * bv) const
179 void MathMacro::metrics(MetricsInfo & mi, Dimension & dim) const
181 // set edit mode for which we will have calculated metrics. But only
182 editing_[mi.base.bv] = editMode(mi.base.bv);
184 // calculate new metrics according to display mode
185 if (displayMode_ == DISPLAY_INIT || displayMode_ == DISPLAY_INTERACTIVE_INIT) {
186 mathed_string_dim(mi.base.font, from_ascii("\\") + name(), dim);
187 } else if (displayMode_ == DISPLAY_UNFOLDED) {
188 cell(0).metrics(mi, dim);
190 mathed_string_dim(mi.base.font, from_ascii("\\"), bsdim);
191 dim.wid += bsdim.width() + 1;
192 dim.asc = max(bsdim.ascent(), dim.ascent());
193 dim.des = max(bsdim.descent(), dim.descent());
195 } else if (lyxrc.macro_edit_style == LyXRC::MACRO_EDIT_LIST
196 && editing_[mi.base.bv]) {
197 // Macro will be edited in a old-style list mode here:
199 LASSERT(macro_ != 0, /**/);
201 FontInfo labelFont = sane_font;
202 math_font_max_dim(labelFont, fontDim.asc, fontDim.des);
204 // get dimension of components of list view
206 nameDim.wid = mathed_string_width(mi.base.font, from_ascii("Macro \\") + name() + ": ");
207 nameDim.asc = fontDim.asc;
208 nameDim.des = fontDim.des;
211 argDim.wid = mathed_string_width(labelFont, from_ascii("#9: "));
212 argDim.asc = fontDim.asc;
213 argDim.des = fontDim.des;
216 definition_.metrics(mi, defDim);
219 dim.wid = nameDim.wid + defDim.wid;
220 dim.asc = max(nameDim.asc, defDim.asc);
221 dim.des = max(nameDim.des, defDim.des);
223 for (idx_type i = 0; i < nargs(); ++i) {
225 cell(i).metrics(mi, cdim);
226 dim.des += max(argDim.height(), cdim.height()) + 1;
227 dim.wid = max(dim.wid, argDim.wid + cdim.wid);
230 // make space for box and markers, 2 pixels
234 metricsMarkers2(dim);
236 LASSERT(macro_ != 0, /**/);
238 // calculate metrics, hoping that all cells are seen
240 expanded_.cell(0).metrics(mi, dim);
242 // otherwise do a manual metrics call
243 CoordCache & coords = mi.base.bv->coordCache();
244 for (idx_type i = 0; i < nargs(); ++i) {
245 if (!coords.getArrays().has(&cell(i))) {
247 cell(i).metrics(mi, tdim);
252 // calculate dimension with label while editing
253 if (lyxrc.macro_edit_style == LyXRC::MACRO_EDIT_INLINE_BOX
254 && editing_[mi.base.bv]) {
255 FontInfo font = mi.base.font;
256 augmentFont(font, from_ascii("lyxtex"));
258 mathed_string_dim(font, name(), namedim);
260 dim.wid += 2 + namedim.wid + 2 + 2;
261 dim.asc = max(dim.asc, namedim.asc) + 2;
262 dim.des = max(dim.des, namedim.des) + 2;
264 dim.wid = max(1 + namedim.wid + 1, 2 + dim.wid + 2);
265 dim.asc += 1 + namedim.height() + 1;
273 int MathMacro::kerning(BufferView const * bv) const {
274 if (displayMode_ == DISPLAY_NORMAL && !editing_[bv])
275 return expanded_.kerning(bv);
281 void MathMacro::updateMacro(MacroContext const & mc)
284 macro_ = mc.get(name());
285 if (macro_ && macroBackup_ != *macro_) {
286 macroBackup_ = *macro_;
295 void MathMacro::updateRepresentation()
302 requires_ = macro_->requires();
304 // non-normal mode? We are done!
305 if (displayMode_ != DISPLAY_NORMAL)
312 needsUpdate_ = false;
314 // get default values of macro
315 vector<docstring> const & defaults = macro_->defaults();
317 // create MathMacroArgumentValue objects pointing to the cells of the macro
318 vector<MathData> values(nargs());
319 for (size_t i = 0; i < nargs(); ++i) {
320 ArgumentProxy * proxy;
321 if (i < defaults.size())
322 proxy = new ArgumentProxy(*this, i, defaults[i]);
324 proxy = new ArgumentProxy(*this, i);
325 values[i].insert(0, MathAtom(proxy));
328 // expanding macro with the values
329 macro_->expand(values, expanded_.cell(0));
330 // get definition for list edit mode
331 docstring const & display = macro_->display();
332 asArray(display.empty() ? macro_->definition() : display, definition_);
336 void MathMacro::draw(PainterInfo & pi, int x, int y) const
338 Dimension const dim = dimension(*pi.base.bv);
340 setPosCache(pi, x, y);
344 if (displayMode_ == DISPLAY_INIT || displayMode_ == DISPLAY_INTERACTIVE_INIT) {
345 FontSetChanger dummy(pi.base, "lyxtex");
346 pi.pain.text(x, y, from_ascii("\\") + name(), pi.base.font);
347 } else if (displayMode_ == DISPLAY_UNFOLDED) {
348 FontSetChanger dummy(pi.base, "lyxtex");
349 pi.pain.text(x, y, from_ascii("\\"), pi.base.font);
350 x += mathed_string_width(pi.base.font, from_ascii("\\")) + 1;
351 cell(0).draw(pi, x, y);
352 drawMarkers(pi, expx, expy);
353 } else if (lyxrc.macro_edit_style == LyXRC::MACRO_EDIT_LIST
354 && editing_[pi.base.bv]) {
355 // Macro will be edited in a old-style list mode here:
357 CoordCache const & coords = pi.base.bv->coordCache();
358 FontInfo const & labelFont = sane_font;
360 // markers and box needs two pixels
363 // get maximal font height
365 math_font_max_dim(pi.base.font, fontDim.asc, fontDim.des);
368 docstring label = from_ascii("Macro \\") + name() + from_ascii(": ");
369 pi.pain.text(x, y, label, labelFont);
370 x += mathed_string_width(labelFont, label);
373 definition_.draw(pi, x, y);
374 Dimension const & defDim = coords.getArrays().dim(&definition_);
375 y += max(fontDim.des, defDim.des);
378 docstring str = from_ascii("#9");
379 int strw1 = mathed_string_width(labelFont, from_ascii("#9"));
380 int strw2 = mathed_string_width(labelFont, from_ascii(": "));
382 for (idx_type i = 0; i < nargs(); ++i) {
384 Dimension const & cdim = coords.getArrays().dim(&cell(i));
386 y += max(fontDim.asc, cdim.asc) + 1;
390 pi.pain.text(x, y, str, labelFont);
392 pi.pain.text(x, y, from_ascii(":"), labelFont);
396 cell(i).draw(pi, x, y);
399 y += max(fontDim.des, cdim.des);
402 pi.pain.rectangle(expx + 1, expy - dim.asc + 1, dim.wid - 3,
403 dim.height() - 2, Color_mathmacroframe);
404 drawMarkers2(pi, expx, expy);
406 bool drawBox = lyxrc.macro_edit_style == LyXRC::MACRO_EDIT_INLINE_BOX;
409 for (size_t i = 0; i < nargs(); ++i)
410 cell(i).setXY(*pi.base.bv, x, y);
412 if (drawBox && editing_[pi.base.bv]) {
413 // draw header and rectangle around
414 FontInfo font = pi.base.font;
415 augmentFont(font, from_ascii("lyxtex"));
416 font.setSize(FONT_SIZE_TINY);
417 font.setColor(Color_mathmacrolabel);
419 mathed_string_dim(font, name(), namedim);
421 pi.pain.fillRectangle(x, y - dim.asc, dim.wid, 1 + namedim.height() + 1, Color_mathmacrobg);
422 pi.pain.text(x + 1, y - dim.asc + namedim.asc + 2, name(), font);
423 expx += (dim.wid - expanded_.cell(0).dimension(*pi.base.bv).width()) / 2;
426 if (editing_[pi.base.bv]) {
427 pi.pain.enterMonochromeMode(Color_mathbg, Color_mathmacroblend);
428 expanded_.cell(0).draw(pi, expx, expy);
429 pi.pain.leaveMonochromeMode();
432 pi.pain.rectangle(x, y - dim.asc, dim.wid,
433 dim.height(), Color_mathmacroframe);
435 expanded_.cell(0).draw(pi, expx, expy);
438 drawMarkers(pi, x, y);
441 // edit mode changed?
442 if (editing_[pi.base.bv] != editMode(pi.base.bv))
443 pi.base.bv->cursor().updateFlags(Update::SinglePar);
447 void MathMacro::drawSelection(PainterInfo & pi, int x, int y) const
449 // We may have 0 arguments, but InsetMathNest requires at least one.
450 if (cells_.size() > 0)
451 InsetMathNest::drawSelection(pi, x, y);
455 void MathMacro::setDisplayMode(MathMacro::DisplayMode mode, int appetite)
457 if (displayMode_ != mode) {
458 // transfer name if changing from or to DISPLAY_UNFOLDED
459 if (mode == DISPLAY_UNFOLDED) {
461 asArray(name_, cell(0));
462 } else if (displayMode_ == DISPLAY_UNFOLDED) {
463 name_ = asString(cell(0));
471 // the interactive init mode is non-greedy by default
473 appetite_ = (mode == DISPLAY_INTERACTIVE_INIT) ? 0 : 9;
475 appetite_ = size_t(appetite);
479 MathMacro::DisplayMode MathMacro::computeDisplayMode() const
481 if (nextFoldMode_ == true && macro_ && !macro_->locked())
482 return DISPLAY_NORMAL;
484 return DISPLAY_UNFOLDED;
488 bool MathMacro::validName() const
490 docstring n = name();
496 // converting back and force doesn't swallow anything?
499 if (asString(ma) != n)
503 for (size_t i = 0; i<n.size(); ++i) {
504 if (!(n[i] >= 'a' && n[i] <= 'z')
505 && !(n[i] >= 'A' && n[i] <= 'Z')
514 void MathMacro::validate(LaTeXFeatures & features) const
516 if (!requires_.empty())
517 features.require(requires_);
519 if (name() == "binom")
520 features.require("binom");
522 // validate the cells and the definition
523 if (displayMode() == DISPLAY_NORMAL) {
524 definition_.validate(features);
525 InsetMathNest::validate(features);
530 void MathMacro::edit(Cursor & cur, bool front, EntryDirection entry_from)
532 cur.updateFlags(Update::SinglePar);
533 InsetMathNest::edit(cur, front, entry_from);
537 Inset * MathMacro::editXY(Cursor & cur, int x, int y)
539 // We may have 0 arguments, but InsetMathNest requires at least one.
541 cur.updateFlags(Update::SinglePar);
542 return InsetMathNest::editXY(cur, x, y);
548 void MathMacro::removeArgument(Inset::pos_type pos) {
549 if (displayMode_ == DISPLAY_NORMAL) {
550 LASSERT(size_t(pos) < cells_.size(), /**/);
551 cells_.erase(cells_.begin() + pos);
552 if (size_t(pos) < attachedArgsNum_)
554 if (size_t(pos) < optionals_) {
563 void MathMacro::insertArgument(Inset::pos_type pos) {
564 if (displayMode_ == DISPLAY_NORMAL) {
565 LASSERT(size_t(pos) <= cells_.size(), /**/);
566 cells_.insert(cells_.begin() + pos, MathData());
567 if (size_t(pos) < attachedArgsNum_)
569 if (size_t(pos) < optionals_)
577 void MathMacro::detachArguments(vector<MathData> & args, bool strip)
579 LASSERT(displayMode_ == DISPLAY_NORMAL, /**/);
582 // strip off empty cells, but not more than arity-attachedArgsNum_
585 for (i = cells_.size(); i > attachedArgsNum_; --i)
586 if (!cell(i - 1).empty()) break;
590 attachedArgsNum_ = 0;
591 expanded_.cell(0) = MathData();
598 void MathMacro::attachArguments(vector<MathData> const & args, size_t arity, int optionals)
600 LASSERT(displayMode_ == DISPLAY_NORMAL, /**/);
602 attachedArgsNum_ = args.size();
603 cells_.resize(arity);
604 expanded_.cell(0) = MathData();
605 optionals_ = optionals;
611 bool MathMacro::idxFirst(Cursor & cur) const
613 cur.updateFlags(Update::SinglePar);
614 return InsetMathNest::idxFirst(cur);
618 bool MathMacro::idxLast(Cursor & cur) const
620 cur.updateFlags(Update::SinglePar);
621 return InsetMathNest::idxLast(cur);
625 bool MathMacro::notifyCursorLeaves(Cursor const & old, Cursor & cur)
627 cur.updateFlags(Update::Force);
628 return InsetMathNest::notifyCursorLeaves(old, cur);
632 void MathMacro::fold(Cursor & cur)
634 if (!nextFoldMode_) {
635 nextFoldMode_ = true;
636 cur.updateFlags(Update::SinglePar);
641 void MathMacro::unfold(Cursor & cur)
644 nextFoldMode_ = false;
645 cur.updateFlags(Update::SinglePar);
650 bool MathMacro::folded() const
652 return nextFoldMode_;
656 void MathMacro::write(WriteStream & os) const
658 MathEnsurer ensurer(os, macro_ != 0, true);
661 if (displayMode_ != DISPLAY_NORMAL) {
662 os << "\\" << name();
663 if (name().size() != 1 || isAlphaASCII(name()[0]))
664 os.pendingSpace(true);
669 LASSERT(macro_, /**/);
671 // optional arguments make macros fragile
672 if (optionals_ > 0 && os.fragile())
675 os << "\\" << name();
678 // Optional arguments:
679 // First find last non-empty optional argument
680 idx_type emptyOptFrom = 0;
682 for (; i < cells_.size() && i < optionals_; ++i) {
683 if (!cell(i).empty())
684 emptyOptFrom = i + 1;
687 // print out optionals
688 for (i=0; i < cells_.size() && i < emptyOptFrom; ++i) {
690 os << "[" << cell(i) << "]";
693 // skip the tailing empty optionals
696 // Print remaining macros
697 for (; i < cells_.size(); ++i) {
698 if (cell(i).size() == 1
699 && cell(i)[0].nucleus()->asCharInset()
700 && cell(i)[0].nucleus()->asCharInset()->getChar() < 0x80) {
705 os << "{" << cell(i) << "}";
709 // add space if there was no argument
711 os.pendingSpace(true);
715 void MathMacro::maple(MapleStream & os) const
717 lyx::maple(expanded_.cell(0), os);
721 void MathMacro::mathmlize(MathStream & os) const
723 lyx::mathmlize(expanded_.cell(0), os);
727 void MathMacro::octave(OctaveStream & os) const
729 lyx::octave(expanded_.cell(0), os);
733 void MathMacro::infoize(odocstream & os) const
735 os << "Macro: " << name();
739 void MathMacro::infoize2(odocstream & os) const
741 os << "Macro: " << name();
746 bool MathMacro::completionSupported(Cursor const & cur) const
748 if (displayMode() != DISPLAY_UNFOLDED)
749 return InsetMathNest::completionSupported(cur);
751 return lyxrc.completion_popup_math
752 && displayMode() == DISPLAY_UNFOLDED
753 && cur.bv().cursor().pos() == int(name().size());
757 bool MathMacro::inlineCompletionSupported(Cursor const & cur) const
759 if (displayMode() != DISPLAY_UNFOLDED)
760 return InsetMathNest::inlineCompletionSupported(cur);
762 return lyxrc.completion_inline_math
763 && displayMode() == DISPLAY_UNFOLDED
764 && cur.bv().cursor().pos() == int(name().size());
768 bool MathMacro::automaticInlineCompletion() const
770 if (displayMode() != DISPLAY_UNFOLDED)
771 return InsetMathNest::automaticInlineCompletion();
773 return lyxrc.completion_inline_math;
777 bool MathMacro::automaticPopupCompletion() const
779 if (displayMode() != DISPLAY_UNFOLDED)
780 return InsetMathNest::automaticPopupCompletion();
782 return lyxrc.completion_popup_math;
786 CompletionList const *
787 MathMacro::createCompletionList(Cursor const & cur) const
789 if (displayMode() != DISPLAY_UNFOLDED)
790 return InsetMathNest::createCompletionList(cur);
792 return new MathCompletionList(cur.bv().cursor());
796 docstring MathMacro::completionPrefix(Cursor const & cur) const
798 if (displayMode() != DISPLAY_UNFOLDED)
799 return InsetMathNest::completionPrefix(cur);
801 if (!completionSupported(cur))
804 return "\\" + name();
808 bool MathMacro::insertCompletion(Cursor & cur, docstring const & s,
811 if (displayMode() != DISPLAY_UNFOLDED)
812 return InsetMathNest::insertCompletion(cur, s, finished);
814 if (!completionSupported(cur))
818 docstring newName = name() + s;
819 asArray(newName, cell(0));
820 cur.bv().cursor().pos() = name().size();
821 cur.updateFlags(Update::SinglePar);
825 cur.bv().cursor().pop();
826 ++cur.bv().cursor().pos();
827 cur.updateFlags(Update::SinglePar);
834 void MathMacro::completionPosAndDim(Cursor const & cur, int & x, int & y,
835 Dimension & dim) const
837 if (displayMode() != DISPLAY_UNFOLDED)
838 InsetMathNest::completionPosAndDim(cur, x, y, dim);
840 // get inset dimensions
841 dim = cur.bv().coordCache().insets().dim(this);
842 // FIXME: these 3 are no accurate, but should depend on the font.
843 // Now the popup jumps down if you enter a char with descent > 0.
849 = cur.bv().coordCache().insets().xy(this);