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
9 * Full author contact details are available in file CREDITS.
14 #include "MathMacro.h"
15 #include "MathSupport.h"
16 #include "MathExtern.h"
17 #include "MathStream.h"
22 #include "BufferView.h"
23 #include "LaTeXFeatures.h"
24 #include "frontends/Painter.h"
33 /// This class is the value of a macro argument, technically
34 /// a wrapper of the cells of MathMacro.
35 class MathMacroArgumentValue : public InsetMath {
38 MathMacroArgumentValue(MathMacro const & mathMacro, size_t idx)
39 : mathMacro_(mathMacro), idx_(idx) {}
41 bool metrics(MetricsInfo & mi, Dimension & dim) const;
43 void draw(PainterInfo &, int x, int y) const;
45 int kerning() const { return mathMacro_.cell(idx_).kerning(); }
48 Inset * clone() const;
49 MathMacro const & mathMacro_;
54 Inset * MathMacroArgumentValue::clone() const
56 return new MathMacroArgumentValue(*this);
60 bool MathMacroArgumentValue::metrics(MetricsInfo & mi, Dimension & dim) const
62 // unlock outer macro in arguments, and lock it again later
63 MacroData const & macro = MacroTable::globalMacros().get(mathMacro_.name());
65 mathMacro_.cell(idx_).metrics(mi, dim);
74 void MathMacroArgumentValue::draw(PainterInfo & pi, int x, int y) const
76 // unlock outer macro in arguments, and lock it again later
77 MacroData const & macro = MacroTable::globalMacros().get(mathMacro_.name());
79 mathMacro_.cell(idx_).draw(pi, x, y);
84 MathMacro::MathMacro(docstring const & name, int numargs)
85 : InsetMathNest(numargs), name_(name), editing_(false)
89 Inset * MathMacro::clone() const
91 MathMacro * x = new MathMacro(*this);
92 x->expanded_ = MathData();
93 x->macroBackup_ = MacroData();
98 docstring MathMacro::name() const
104 void MathMacro::cursorPos(BufferView const & bv,
105 CursorSlice const & sl, bool boundary, int & x, int & y) const
107 // We may have 0 arguments, but InsetMathNest requires at least one.
109 InsetMathNest::cursorPos(bv, sl, boundary, x, y);
113 bool MathMacro::metrics(MetricsInfo & mi, Dimension & dim) const
116 if (!MacroTable::globalMacros().has(name())) {
117 mathed_string_dim(mi.base.font, "Unknown: " + name(), dim);
119 MacroData const & macro = MacroTable::globalMacros().get(name());
121 if (macroBackup_ != macro)
124 if (macro.locked()) {
125 mathed_string_dim(mi.base.font, "Self reference: " + name(), dim);
126 } else if (editing(mi.base.bv)) {
127 Font font = mi.base.font;
128 augmentFont(font, from_ascii("lyxtex"));
129 tmpl_.metrics(mi, dim);
131 dim.wid += mathed_string_width(font, name()) + 10;
133 int ww = mathed_string_width(font, from_ascii("#1: "));
134 for (idx_type i = 0; i < nargs(); ++i) {
135 MathData const & c = cell(i);
137 dim.wid = max(dim.wid, c.width() + ww);
138 dim.des += c.height() + 10;
143 expanded_.metrics(mi, dim);
145 kerning_ = expanded_.kerning();
156 void MathMacro::draw(PainterInfo & pi, int x, int y) const
158 if (!MacroTable::globalMacros().has(name())) {
160 drawStrRed(pi, x, y, "Unknown: " + name());
162 MacroData const & macro = MacroTable::globalMacros().get(name());
165 for (size_t i = 0; i < nargs(); ++i)
166 cell(i).setXY(*pi.base.bv, x, y);
168 if (macro.locked()) {
170 drawStrRed(pi, x, y, "Self reference: " + name());
171 } else if (editing_) {
172 Font font = pi.base.font;
173 augmentFont(font, from_ascii("lyxtex"));
174 int h = y - dim_.ascent() + 2 + tmpl_.ascent();
175 pi.pain.text(x + 3, h, name(), font);
176 int const w = mathed_string_width(font, name());
177 tmpl_.draw(pi, x + w + 12, h);
178 h += tmpl_.descent();
180 docstring t = from_ascii("#1: ");
181 mathed_string_dim(font, t, ldim);
182 for (idx_type i = 0; i < nargs(); ++i) {
183 MathData const & c = cell(i);
184 h += max(c.ascent(), ldim.asc) + 5;
185 c.draw(pi, x + ldim.wid, h);
186 char_type str[] = { '#', '1', ':', '\0' };
187 str[1] += static_cast<char_type>(i);
188 pi.pain.text(x + 3, h, str, font);
189 h += max(c.descent(), ldim.des) + 5;
193 expanded_.draw(pi, x, y);
197 // edit mode changed?
198 if (editing_ != editing(pi.base.bv) || macroBackup_ != macro)
199 pi.base.bv->cursor().updateFlags(Update::Force);
204 void MathMacro::drawSelection(PainterInfo & pi, int x, int y) const
206 // We may have 0 arguments, but InsetMathNest requires at least one.
208 InsetMathNest::drawSelection(pi, x, y);
212 void MathMacro::validate(LaTeXFeatures & features) const
214 string const require = MacroTable::globalMacros().get(name()).requires();
215 if (!require.empty())
216 features.require(require);
218 if (name() == "binom" || name() == "mathcircumflex")
219 features.require(to_utf8(name()));
223 Inset * MathMacro::editXY(Cursor & cur, int x, int y)
225 // We may have 0 arguments, but InsetMathNest requires at least one.
227 // Prevent crash due to cold coordcache
228 // FIXME: This is only a workaround, the call of
229 // InsetMathNest::editXY is correct. The correct fix would
230 // ensure that the coordcache of the arguments is valid.
231 if (!editing(&cur.bv())) {
235 return InsetMathNest::editXY(cur, x, y);
241 bool MathMacro::idxFirst(Cursor & cur) const
243 cur.updateFlags(Update::Force);
244 return InsetMathNest::idxFirst(cur);
248 bool MathMacro::idxLast(Cursor & cur) const
250 cur.updateFlags(Update::Force);
251 return InsetMathNest::idxLast(cur);
255 bool MathMacro::idxUpDown(Cursor & cur, bool up) const
262 if (cur.idx() + 1 >= nargs())
266 cur.pos() = cell(cur.idx()).x2pos(cur.x_target());
271 bool MathMacro::notifyCursorLeaves(Cursor & cur)
273 cur.updateFlags(Update::Force);
274 return InsetMathNest::notifyCursorLeaves(cur);
278 void MathMacro::maple(MapleStream & os) const
281 lyx::maple(expanded_, os);
285 void MathMacro::mathmlize(MathStream & os) const
288 lyx::mathmlize(expanded_, os);
292 void MathMacro::octave(OctaveStream & os) const
295 lyx::octave(expanded_, os);
299 void MathMacro::updateExpansion() const
301 MacroData const & macro = MacroTable::globalMacros().get(name());
303 // create MathMacroArgumentValue object pointing to the cells of the macro
304 std::vector<MathData> values(nargs());
305 for (size_t i = 0; i != nargs(); ++i)
306 values[i].insert(0, MathAtom(new MathMacroArgumentValue(*this, i)));
307 macro.expand(values, expanded_);
308 asArray(macro.def(), tmpl_);
309 macroBackup_ = macro;
313 void MathMacro::infoize(odocstream & os) const
315 os << "Macro: " << name();
319 void MathMacro::infoize2(odocstream & os) const
321 os << "Macro: " << name();