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"
16 #include "MathSupport.h"
17 #include "MathExtern.h"
18 #include "MathStream.h"
21 #include "BufferView.h"
23 #include "support/debug.h"
24 #include "LaTeXFeatures.h"
25 #include "FuncStatus.h"
26 #include "FuncRequest.h"
29 #include "frontends/Painter.h"
39 /// A proxy for the macro values
40 class ArgumentProxy : public InsetMath {
43 ArgumentProxy(MathMacro & mathMacro, size_t idx)
44 : mathMacro_(mathMacro), idx_(idx) {}
46 ArgumentProxy(MathMacro & mathMacro, size_t idx, docstring const & def)
47 : mathMacro_(mathMacro), idx_(idx)
52 void metrics(MetricsInfo & mi, Dimension & dim) const {
53 mathMacro_.macro()->unlock();
54 mathMacro_.cell(idx_).metrics(mi, dim);
55 if (!mathMacro_.editing(mi.base.bv) && !def_.empty())
56 def_.metrics(mi, dim);
57 mathMacro_.macro()->lock();
60 void draw(PainterInfo & pi, int x, int y) const {
61 if (mathMacro_.editing(pi.base.bv)) {
62 // The only way a ArgumentProxy can appear is in a cell of the
63 // MathMacro. Moreover the cells are only drawn in the DISPLAY_FOLDED
64 // mode and then, in the case of "editing_ == true" the monochrome
65 // mode is entered by the MathMacro before calling the cells' draw
66 // method. Then eventually this code is reached and the proxy leaves
67 // monochrome mode temporarely. Hence, if it is not in monochrome
68 // here (and the assert triggers in pain.leaveMonochromeMode())
70 pi.pain.leaveMonochromeMode();
71 mathMacro_.cell(idx_).draw(pi, x, y);
72 pi.pain.enterMonochromeMode(Color_mathbg, Color_mathmacroblend);
75 mathMacro_.cell(idx_).draw(pi, x, y);
77 mathMacro_.cell(idx_).setXY(*pi.base.bv, x, y);
83 size_t idx() const { return idx_; }
85 int kerning(BufferView const * bv) const { return mathMacro_.cell(idx_).kerning(bv); }
91 return new ArgumentProxy(*this);
94 MathMacro & mathMacro_;
102 MathMacro::MathMacro(docstring const & name)
103 : InsetMathNest(0), name_(name), displayMode_(DISPLAY_INIT),
104 attachedArgsNum_(0), optionals_(0), nextFoldMode_(true),
105 macro_(0), needsUpdate_(false)
109 Inset * MathMacro::clone() const
111 MathMacro * copy = new MathMacro(*this);
112 copy->needsUpdate_ = true;
113 copy->expanded_.cell(0).clear();
118 docstring MathMacro::name() const
120 if (displayMode_ == DISPLAY_UNFOLDED)
121 return asString(cell(0));
127 void MathMacro::cursorPos(BufferView const & bv,
128 CursorSlice const & sl, bool boundary, int & x, int & y) const
130 // We may have 0 arguments, but InsetMathNest requires at least one.
132 InsetMathNest::cursorPos(bv, sl, boundary, x, y);
136 int MathMacro::cursorIdx(Cursor const & cur) const {
137 for (size_t i = 0; i != cur.depth(); ++i)
138 if (&cur[i].inset() == this)
144 bool MathMacro::editMode(Cursor const & cur) const {
145 // find this in cursor trace
146 for (size_t i = 0; i != cur.depth(); ++i)
147 if (&cur[i].inset() == this) {
148 // look if there is no other macro in edit mode above
150 for (; i != cur.depth(); ++i) {
151 MathMacro const * macro = dynamic_cast<MathMacro const *>(&cur[i].inset());
152 if (macro && macro->displayMode() == DISPLAY_NORMAL)
156 // ok, none found, I am the highest one
164 void MathMacro::metrics(MetricsInfo & mi, Dimension & dim) const
166 // set edit mode for which we will have calculated metrics
167 editing_[mi.base.bv] = editMode(mi.base.bv->cursor());
169 // calculate new metrics according to display mode
170 if (displayMode_ == DISPLAY_INIT || displayMode_ == DISPLAY_INTERACTIVE_INIT) {
171 mathed_string_dim(mi.base.font, from_ascii("\\") + name(), dim);
172 } else if (displayMode_ == DISPLAY_UNFOLDED) {
173 cell(0).metrics(mi, dim);
175 mathed_string_dim(mi.base.font, from_ascii("\\"), bsdim);
176 dim.wid += bsdim.width() + 1;
177 dim.asc = max(bsdim.ascent(), dim.ascent());
178 dim.des = max(bsdim.descent(), dim.descent());
181 BOOST_ASSERT(macro_ != 0);
183 // calculate metric finally
185 expanded_.cell(0).metrics(mi, dim);
188 // calculate dimension with label while editing
189 if (editing_[mi.base.bv]) {
190 FontInfo font = mi.base.font;
191 augmentFont(font, from_ascii("lyxtex"));
193 mathed_string_dim(font, name(), namedim);
195 dim.wid += 2 + namedim.wid + 2 + 2;
196 dim.asc = max(dim.asc, namedim.asc) + 2;
197 dim.des = max(dim.des, namedim.des) + 2;
199 dim.wid = max(1 + namedim.wid + 1, 2 + dim.wid + 2);
200 dim.asc += 1 + namedim.height() + 1;
205 // Cache the inset dimension.
206 setDimCache(mi, dim);
210 int MathMacro::kerning(BufferView const * bv) const {
211 if (displayMode_ == DISPLAY_NORMAL && !editing(bv))
212 return expanded_.kerning(bv);
218 void MathMacro::updateMacro(MacroContext const & mc)
221 macro_ = mc.get(name());
222 if (macro_ && macroBackup_ != *macro_) {
223 macroBackup_ = *macro_;
232 void MathMacro::updateRepresentation(Cursor const * bvCur)
234 // index of child where the cursor is (or -1 if none is edited)
237 curIdx = cursorIdx(*bvCur);
238 previousCurIdx_[&bvCur->bv()] = curIdx;
246 requires_ = macro_->requires();
248 // non-normal mode? We are done!
249 if (displayMode_ != DISPLAY_NORMAL)
254 needsUpdate_ = false;
256 // get default values of macro
257 vector<docstring> const & defaults = macro_->defaults();
259 // create MathMacroArgumentValue objects pointing to the cells of the macro
260 vector<MathData> values(nargs());
261 for (size_t i = 0; i < nargs(); ++i) {
262 ArgumentProxy * proxy;
264 || i >= defaults.size()
265 || defaults[i].empty()
267 proxy = new ArgumentProxy(*this, i);
269 proxy = new ArgumentProxy(*this, i, defaults[i]);
270 values[i].insert(0, MathAtom(proxy));
273 // expanding macro with the values
274 macro_->expand(values, expanded_.cell(0));
279 void MathMacro::draw(PainterInfo & pi, int x, int y) const
281 Dimension const dim = dimension(*pi.base.bv);
283 setPosCache(pi, x, y);
287 if (displayMode_ == DISPLAY_INIT || displayMode_ == DISPLAY_INTERACTIVE_INIT) {
288 PainterInfo pi2(pi.base.bv, pi.pain);
289 pi2.base.font.setColor(macro_ ? Color_latex : Color_error);
290 //pi2.base.style = LM_ST_TEXT;
291 pi2.pain.text(x, y, from_ascii("\\") + name(), pi2.base.font);
292 } else if (displayMode_ == DISPLAY_UNFOLDED) {
293 PainterInfo pi2(pi.base.bv, pi.pain);
294 pi2.base.font.setColor(macro_ ? Color_latex : Color_error);
295 //pi2.base.style = LM_ST_TEXT;
296 pi2.pain.text(x, y, from_ascii("\\"), pi2.base.font);
297 x += mathed_string_width(pi2.base.font, from_ascii("\\")) + 1;
298 cell(0).draw(pi2, x, y);
299 drawMarkers(pi2, expx, expy);
302 for (size_t i = 0; i < nargs(); ++i)
303 cell(i).setXY(*pi.base.bv, x, y);
305 if (editing_[pi.base.bv]) {
306 // draw header and rectangle around
307 FontInfo font = pi.base.font;
308 augmentFont(font, from_ascii("lyxtex"));
309 font.setSize(FONT_SIZE_TINY);
310 font.setColor(Color_mathmacrolabel);
312 mathed_string_dim(font, name(), namedim);
314 pi.pain.fillRectangle(x, y - dim.asc, 2 + namedim.width() + 2, dim.height(), Color_mathmacrobg);
315 pi.pain.text(x + 2, y, name(), font);
316 expx += 2 + namew + 2;
318 pi.pain.fillRectangle(x, y - dim.asc, dim.wid, 1 + namedim.height() + 1, Color_mathmacrobg);
319 pi.pain.text(x + 1, y - dim.asc + namedim.asc + 2, name(), font);
320 expx += (dim.wid - expanded_.cell(0).dimension(*pi.base.bv).width()) / 2;
322 pi.pain.enterMonochromeMode(Color_mathbg, Color_mathmacroblend);
323 expanded_.cell(0).draw(pi, expx, expy);
324 pi.pain.leaveMonochromeMode();
326 expanded_.cell(0).draw(pi, expx, expy);
328 // draw frame while editing
329 if (editing_[pi.base.bv])
330 pi.pain.rectangle(x, y - dim.asc, dim.wid, dim.height(), Color_mathmacroframe);
333 // another argument selected or edit mode changed?
334 idx_type curIdx = cursorIdx(pi.base.bv->cursor());
335 if (previousCurIdx_[pi.base.bv] != curIdx
336 || editing_[pi.base.bv] != editMode(pi.base.bv->cursor()))
337 pi.base.bv->cursor().updateFlags(Update::Force);
341 void MathMacro::drawSelection(PainterInfo & pi, int x, int y) const
343 // We may have 0 arguments, but InsetMathNest requires at least one.
344 if (cells_.size() > 0)
345 InsetMathNest::drawSelection(pi, x, y);
349 void MathMacro::setDisplayMode(MathMacro::DisplayMode mode)
351 if (displayMode_ != mode) {
352 // transfer name if changing from or to DISPLAY_UNFOLDED
353 if (mode == DISPLAY_UNFOLDED) {
355 asArray(name_, cell(0));
356 } else if (displayMode_ == DISPLAY_UNFOLDED) {
357 name_ = asString(cell(0));
367 MathMacro::DisplayMode MathMacro::computeDisplayMode() const
369 if (nextFoldMode_ == true && macro_ && !macro_->locked())
370 return DISPLAY_NORMAL;
372 return DISPLAY_UNFOLDED;
376 bool MathMacro::validName() const
378 docstring n = name();
384 // converting back and force doesn't swallow anything?
387 if (asString(ma) != n)
391 for (size_t i = 0; i<n.size(); ++i) {
392 if (!(n[i] >= 'a' && n[i] <= 'z') &&
393 !(n[i] >= 'A' && n[i] <= 'Z'))
401 void MathMacro::validate(LaTeXFeatures & features) const
403 if (!requires_.empty())
404 features.require(requires_);
406 if (name() == "binom" || name() == "mathcircumflex")
407 features.require(to_utf8(name()));
411 void MathMacro::edit(Cursor & cur, bool left)
413 cur.updateFlags(Update::Force);
414 InsetMathNest::edit(cur, left);
418 Inset * MathMacro::editXY(Cursor & cur, int x, int y)
420 // We may have 0 arguments, but InsetMathNest requires at least one.
422 cur.updateFlags(Update::Force);
423 return InsetMathNest::editXY(cur, x, y);
429 void MathMacro::removeArgument(Inset::pos_type pos) {
430 if (displayMode_ == DISPLAY_NORMAL) {
431 BOOST_ASSERT(size_t(pos) < cells_.size());
432 cells_.erase(cells_.begin() + pos);
433 if (size_t(pos) < attachedArgsNum_)
435 if (size_t(pos) < optionals_) {
444 void MathMacro::insertArgument(Inset::pos_type pos) {
445 if (displayMode_ == DISPLAY_NORMAL) {
446 BOOST_ASSERT(size_t(pos) <= cells_.size());
447 cells_.insert(cells_.begin() + pos, MathData());
448 if (size_t(pos) < attachedArgsNum_)
450 if (size_t(pos) < optionals_)
458 void MathMacro::detachArguments(vector<MathData> & args, bool strip)
460 BOOST_ASSERT(displayMode_ == DISPLAY_NORMAL);
463 // strip off empty cells, but not more than arity-attachedArgsNum_
466 for (i = cells_.size(); i > attachedArgsNum_; --i)
467 if (!cell(i - 1).empty()) break;
471 attachedArgsNum_ = 0;
472 expanded_.cell(0) = MathData();
479 void MathMacro::attachArguments(vector<MathData> const & args, size_t arity, int optionals)
481 BOOST_ASSERT(displayMode_ == DISPLAY_NORMAL);
483 attachedArgsNum_ = args.size();
484 cells_.resize(arity);
485 expanded_.cell(0) = MathData();
486 optionals_ = optionals;
492 bool MathMacro::idxFirst(Cursor & cur) const
494 cur.updateFlags(Update::Force);
495 return InsetMathNest::idxFirst(cur);
499 bool MathMacro::idxLast(Cursor & cur) const
501 cur.updateFlags(Update::Force);
502 return InsetMathNest::idxLast(cur);
506 bool MathMacro::notifyCursorLeaves(Cursor & cur)
508 cur.updateFlags(Update::Force);
509 return InsetMathNest::notifyCursorLeaves(cur);
513 void MathMacro::fold(Cursor & cur)
515 if (!nextFoldMode_) {
516 nextFoldMode_ = true;
517 cur.updateFlags(Update::Force);
522 void MathMacro::unfold(Cursor & cur)
525 nextFoldMode_ = false;
526 cur.updateFlags(Update::Force);
531 bool MathMacro::folded() const
533 return nextFoldMode_;
537 void MathMacro::write(WriteStream & os) const
540 if (displayMode_ != DISPLAY_NORMAL) {
541 os << "\\" << name() << " ";
542 os.pendingSpace(true);
547 BOOST_ASSERT(macro_);
549 // optional arguments make macros fragile
550 if (optionals_ > 0 && os.fragile())
553 os << "\\" << name();
557 // Use macroBackup_ instead of macro_ here, because
558 // this is outside the metrics/draw calls, hence the macro_
559 // variable can point to a MacroData which was freed already.
560 vector<docstring> const & defaults = macroBackup_.defaults();
564 // Print first optional in LaTeX semantics
565 if (i < optionals_) {
566 // the first real optional, the others are non-optional in latex
567 if (!cell(i).empty()) {
569 os << "[" << cell(0) << "]";
575 // In lyx mode print all in any case
576 for (; i < cells_.size() && i < optionals_; ++i) {
578 os << "[" << cell(i) << "]";
582 // Print remaining macros
583 // (also the further optional parameters in LaTeX mode!)
584 for (; i < cells_.size(); ++i) {
585 if (cell(i).empty() && i < optionals_)
586 os << "{" << defaults[i] << "}";
587 else if (cell(i).size() == 1
588 && cell(i)[0].nucleus()->asCharInset()) {
593 os << "{" << cell(i) << "}";
597 // add space if there was no argument
599 os.pendingSpace(true);
603 void MathMacro::maple(MapleStream & os) const
605 lyx::maple(expanded_.cell(0), os);
609 void MathMacro::mathmlize(MathStream & os) const
611 lyx::mathmlize(expanded_.cell(0), os);
615 void MathMacro::octave(OctaveStream & os) const
617 lyx::octave(expanded_.cell(0), os);
621 void MathMacro::infoize(odocstream & os) const
623 os << "Macro: " << name();
627 void MathMacro::infoize2(odocstream & os) const
629 os << "Macro: " << name();