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"
22 #include "CoordCache.h"
24 #include "support/debug.h"
25 #include "LaTeXFeatures.h"
26 #include "FuncStatus.h"
27 #include "FuncRequest.h"
30 #include "frontends/Painter.h"
40 /// A proxy for the macro values
41 class ArgumentProxy : public InsetMath {
44 ArgumentProxy(MathMacro & mathMacro, size_t idx)
45 : mathMacro_(mathMacro), idx_(idx) {}
47 ArgumentProxy(MathMacro & mathMacro, size_t idx, docstring const & def)
48 : mathMacro_(mathMacro), idx_(idx)
53 void metrics(MetricsInfo & mi, Dimension & dim) const {
54 mathMacro_.macro()->unlock();
55 if (!mathMacro_.editMetrics(mi.base.bv)
56 && mathMacro_.cell(idx_).empty())
57 def_.metrics(mi, dim);
59 CoordCache & coords = mi.base.bv->coordCache();
60 dim = coords.arrays().dim(&mathMacro_.cell(idx_));
62 mathMacro_.macro()->lock();
65 void draw(PainterInfo & pi, int x, int y) const {
66 if (mathMacro_.editMetrics(pi.base.bv)) {
67 // The only way a ArgumentProxy can appear is in a cell of the
68 // MathMacro. Moreover the cells are only drawn in the DISPLAY_FOLDED
69 // mode and then, if the macro is edited the monochrome
70 // mode is entered by the MathMacro before calling the cells' draw
71 // method. Then eventually this code is reached and the proxy leaves
72 // monochrome mode temporarely. Hence, if it is not in monochrome
73 // here (and the assert triggers in pain.leaveMonochromeMode())
75 pi.pain.leaveMonochromeMode();
76 mathMacro_.cell(idx_).draw(pi, x, y);
77 pi.pain.enterMonochromeMode(Color_mathbg, Color_mathmacroblend);
78 } else if (mathMacro_.cell(idx_).empty()) {
79 mathMacro_.cell(idx_).setXY(*pi.base.bv, x, y);
82 mathMacro_.cell(idx_).draw(pi, x, y);
85 size_t idx() const { return idx_; }
87 int kerning(BufferView const * bv) const
89 if (mathMacro_.editMetrics(bv)
90 || !mathMacro_.cell(idx_).empty())
91 return mathMacro_.cell(idx_).kerning(bv);
93 return def_.kerning(bv);
100 return new ArgumentProxy(*this);
103 MathMacro & mathMacro_;
111 MathMacro::MathMacro(docstring const & name)
112 : InsetMathNest(0), name_(name), displayMode_(DISPLAY_INIT),
113 attachedArgsNum_(0), optionals_(0), nextFoldMode_(true),
114 macro_(0), needsUpdate_(false)
118 Inset * MathMacro::clone() const
120 MathMacro * copy = new MathMacro(*this);
121 copy->needsUpdate_ = true;
122 copy->expanded_.cell(0).clear();
127 docstring MathMacro::name() const
129 if (displayMode_ == DISPLAY_UNFOLDED)
130 return asString(cell(0));
136 void MathMacro::cursorPos(BufferView const & bv,
137 CursorSlice const & sl, bool boundary, int & x, int & y) const
139 // We may have 0 arguments, but InsetMathNest requires at least one.
141 InsetMathNest::cursorPos(bv, sl, boundary, x, y);
145 bool MathMacro::editMode(BufferView const * bv) const {
146 // find this in cursor trace
147 Cursor const & cur = bv->cursor();
148 for (size_t i = 0; i != cur.depth(); ++i)
149 if (&cur[i].inset() == this) {
150 // look if there is no other macro in edit mode above
152 for (; i != cur.depth(); ++i) {
153 MathMacro const * macro = dynamic_cast<MathMacro const *>(&cur[i].inset());
154 if (macro && macro->displayMode() == DISPLAY_NORMAL)
158 // ok, none found, I am the highest one
166 bool MathMacro::editMetrics(BufferView const * bv) const
172 void MathMacro::metrics(MetricsInfo & mi, Dimension & dim) const
174 // set edit mode for which we will have calculated metrics. But only
175 editing_[mi.base.bv] = editMode(mi.base.bv);
177 // calculate new metrics according to display mode
178 if (displayMode_ == DISPLAY_INIT || displayMode_ == DISPLAY_INTERACTIVE_INIT) {
179 mathed_string_dim(mi.base.font, from_ascii("\\") + name(), dim);
180 } else if (displayMode_ == DISPLAY_UNFOLDED) {
181 cell(0).metrics(mi, dim);
183 mathed_string_dim(mi.base.font, from_ascii("\\"), bsdim);
184 dim.wid += bsdim.width() + 1;
185 dim.asc = max(bsdim.ascent(), dim.ascent());
186 dim.des = max(bsdim.descent(), dim.descent());
189 BOOST_ASSERT(macro_ != 0);
191 // metrics are computed here for the cells,
192 // in the proxy we will then use the dim from the cache
193 InsetMathNest::metrics(mi);
195 // calculate metrics finally
197 expanded_.cell(0).metrics(mi, dim);
200 // calculate dimension with label while editing
201 if (editing_[mi.base.bv]) {
202 FontInfo font = mi.base.font;
203 augmentFont(font, from_ascii("lyxtex"));
205 mathed_string_dim(font, name(), namedim);
207 dim.wid += 2 + namedim.wid + 2 + 2;
208 dim.asc = max(dim.asc, namedim.asc) + 2;
209 dim.des = max(dim.des, namedim.des) + 2;
211 dim.wid = max(1 + namedim.wid + 1, 2 + dim.wid + 2);
212 dim.asc += 1 + namedim.height() + 1;
219 int MathMacro::kerning(BufferView const * bv) const {
220 if (displayMode_ == DISPLAY_NORMAL && !editing_[bv])
221 return expanded_.kerning(bv);
227 void MathMacro::updateMacro(MacroContext const & mc)
230 macro_ = mc.get(name());
231 if (macro_ && macroBackup_ != *macro_) {
232 macroBackup_ = *macro_;
241 void MathMacro::updateRepresentation(Cursor const * bvCur)
248 requires_ = macro_->requires();
250 // non-normal mode? We are done!
251 if (displayMode_ != DISPLAY_NORMAL)
256 needsUpdate_ = false;
258 // get default values of macro
259 vector<docstring> const & defaults = macro_->defaults();
261 // create MathMacroArgumentValue objects pointing to the cells of the macro
262 vector<MathData> values(nargs());
263 for (size_t i = 0; i < nargs(); ++i) {
264 ArgumentProxy * proxy;
265 if (i < defaults.size())
266 proxy = new ArgumentProxy(*this, i, defaults[i]);
268 proxy = new ArgumentProxy(*this, i);
269 values[i].insert(0, MathAtom(proxy));
272 // expanding macro with the values
273 macro_->expand(values, expanded_.cell(0));
278 void MathMacro::draw(PainterInfo & pi, int x, int y) const
280 Dimension const dim = dimension(*pi.base.bv);
282 setPosCache(pi, x, y);
286 if (displayMode_ == DISPLAY_INIT || displayMode_ == DISPLAY_INTERACTIVE_INIT) {
287 PainterInfo pi2(pi.base.bv, pi.pain);
288 pi2.base.font.setColor(macro_ ? Color_latex : Color_error);
289 //pi2.base.style = LM_ST_TEXT;
290 pi2.pain.text(x, y, from_ascii("\\") + name(), pi2.base.font);
291 } else if (displayMode_ == DISPLAY_UNFOLDED) {
292 PainterInfo pi2(pi.base.bv, pi.pain);
293 pi2.base.font.setColor(macro_ ? Color_latex : Color_error);
294 //pi2.base.style = LM_ST_TEXT;
295 pi2.pain.text(x, y, from_ascii("\\"), pi2.base.font);
296 x += mathed_string_width(pi2.base.font, from_ascii("\\")) + 1;
297 cell(0).draw(pi2, x, y);
298 drawMarkers(pi2, expx, expy);
301 for (size_t i = 0; i < nargs(); ++i)
302 cell(i).setXY(*pi.base.bv, x, y);
304 if (editing_[pi.base.bv]) {
305 // draw header and rectangle around
306 FontInfo font = pi.base.font;
307 augmentFont(font, from_ascii("lyxtex"));
308 font.setSize(FONT_SIZE_TINY);
309 font.setColor(Color_mathmacrolabel);
311 mathed_string_dim(font, name(), namedim);
313 pi.pain.fillRectangle(x, y - dim.asc, 2 + namedim.width() + 2, dim.height(), Color_mathmacrobg);
314 pi.pain.text(x + 2, y, name(), font);
315 expx += 2 + namew + 2;
317 pi.pain.fillRectangle(x, y - dim.asc, dim.wid, 1 + namedim.height() + 1, Color_mathmacrobg);
318 pi.pain.text(x + 1, y - dim.asc + namedim.asc + 2, name(), font);
319 expx += (dim.wid - expanded_.cell(0).dimension(*pi.base.bv).width()) / 2;
321 pi.pain.enterMonochromeMode(Color_mathbg, Color_mathmacroblend);
322 expanded_.cell(0).draw(pi, expx, expy);
323 pi.pain.leaveMonochromeMode();
325 expanded_.cell(0).draw(pi, expx, expy);
327 // draw frame while editing
328 if (editing_[pi.base.bv])
329 pi.pain.rectangle(x, y - dim.asc, dim.wid, dim.height(), Color_mathmacroframe);
332 // edit mode changed?
333 if (editing_[pi.base.bv] != editMode(pi.base.bv))
334 pi.base.bv->cursor().updateFlags(Update::Force);
338 void MathMacro::drawSelection(PainterInfo & pi, int x, int y) const
340 // We may have 0 arguments, but InsetMathNest requires at least one.
341 if (cells_.size() > 0)
342 InsetMathNest::drawSelection(pi, x, y);
346 void MathMacro::setDisplayMode(MathMacro::DisplayMode mode)
348 if (displayMode_ != mode) {
349 // transfer name if changing from or to DISPLAY_UNFOLDED
350 if (mode == DISPLAY_UNFOLDED) {
352 asArray(name_, cell(0));
353 } else if (displayMode_ == DISPLAY_UNFOLDED) {
354 name_ = asString(cell(0));
364 MathMacro::DisplayMode MathMacro::computeDisplayMode() const
366 if (nextFoldMode_ == true && macro_ && !macro_->locked())
367 return DISPLAY_NORMAL;
369 return DISPLAY_UNFOLDED;
373 bool MathMacro::validName() const
375 docstring n = name();
381 // converting back and force doesn't swallow anything?
384 if (asString(ma) != n)
388 for (size_t i = 0; i<n.size(); ++i) {
389 if (!(n[i] >= 'a' && n[i] <= 'z') &&
390 !(n[i] >= 'A' && n[i] <= 'Z'))
398 void MathMacro::validate(LaTeXFeatures & features) const
400 if (!requires_.empty())
401 features.require(requires_);
403 if (name() == "binom" || name() == "mathcircumflex")
404 features.require(to_utf8(name()));
408 void MathMacro::edit(Cursor & cur, bool left)
410 cur.updateFlags(Update::Force);
411 InsetMathNest::edit(cur, left);
415 Inset * MathMacro::editXY(Cursor & cur, int x, int y)
417 // We may have 0 arguments, but InsetMathNest requires at least one.
419 cur.updateFlags(Update::Force);
420 return InsetMathNest::editXY(cur, x, y);
426 void MathMacro::removeArgument(Inset::pos_type pos) {
427 if (displayMode_ == DISPLAY_NORMAL) {
428 BOOST_ASSERT(size_t(pos) < cells_.size());
429 cells_.erase(cells_.begin() + pos);
430 if (size_t(pos) < attachedArgsNum_)
432 if (size_t(pos) < optionals_) {
441 void MathMacro::insertArgument(Inset::pos_type pos) {
442 if (displayMode_ == DISPLAY_NORMAL) {
443 BOOST_ASSERT(size_t(pos) <= cells_.size());
444 cells_.insert(cells_.begin() + pos, MathData());
445 if (size_t(pos) < attachedArgsNum_)
447 if (size_t(pos) < optionals_)
455 void MathMacro::detachArguments(vector<MathData> & args, bool strip)
457 BOOST_ASSERT(displayMode_ == DISPLAY_NORMAL);
460 // strip off empty cells, but not more than arity-attachedArgsNum_
463 for (i = cells_.size(); i > attachedArgsNum_; --i)
464 if (!cell(i - 1).empty()) break;
468 attachedArgsNum_ = 0;
469 expanded_.cell(0) = MathData();
476 void MathMacro::attachArguments(vector<MathData> const & args, size_t arity, int optionals)
478 BOOST_ASSERT(displayMode_ == DISPLAY_NORMAL);
480 attachedArgsNum_ = args.size();
481 cells_.resize(arity);
482 expanded_.cell(0) = MathData();
483 optionals_ = optionals;
489 bool MathMacro::idxFirst(Cursor & cur) const
491 cur.updateFlags(Update::Force);
492 return InsetMathNest::idxFirst(cur);
496 bool MathMacro::idxLast(Cursor & cur) const
498 cur.updateFlags(Update::Force);
499 return InsetMathNest::idxLast(cur);
503 bool MathMacro::notifyCursorLeaves(Cursor & cur)
505 cur.updateFlags(Update::Force);
506 return InsetMathNest::notifyCursorLeaves(cur);
510 void MathMacro::fold(Cursor & cur)
512 if (!nextFoldMode_) {
513 nextFoldMode_ = true;
514 cur.updateFlags(Update::Force);
519 void MathMacro::unfold(Cursor & cur)
522 nextFoldMode_ = false;
523 cur.updateFlags(Update::Force);
528 bool MathMacro::folded() const
530 return nextFoldMode_;
534 void MathMacro::write(WriteStream & os) const
537 if (displayMode_ != DISPLAY_NORMAL) {
538 os << "\\" << name() << " ";
539 os.pendingSpace(true);
544 BOOST_ASSERT(macro_);
546 // optional arguments make macros fragile
547 if (optionals_ > 0 && os.fragile())
550 os << "\\" << name();
553 // Optional arguments:
554 // First find last non-empty optional argument
555 idx_type emptyOptFrom = 0;
557 for (; i < cells_.size() && i < optionals_; ++i) {
558 if (!cell(i).empty())
559 emptyOptFrom = i + 1;
562 // print out optionals
563 for (i=0; i < cells_.size() && i < emptyOptFrom; ++i) {
565 os << "[" << cell(i) << "]";
568 // skip the tailing empty optionals
571 // Print remaining macros
572 for (; i < cells_.size(); ++i) {
573 if (cell(i).size() == 1
574 && cell(i)[0].nucleus()->asCharInset()) {
579 os << "{" << cell(i) << "}";
583 // add space if there was no argument
585 os.pendingSpace(true);
589 void MathMacro::maple(MapleStream & os) const
591 lyx::maple(expanded_.cell(0), os);
595 void MathMacro::mathmlize(MathStream & os) const
597 lyx::mathmlize(expanded_.cell(0), os);
601 void MathMacro::octave(OctaveStream & os) const
603 lyx::octave(expanded_.cell(0), os);
607 void MathMacro::infoize(odocstream & os) const
609 os << "Macro: " << name();
613 void MathMacro::infoize2(odocstream & os) const
615 os << "Macro: " << name();