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 void 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 void 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);
70 void MathMacroArgumentValue::draw(PainterInfo & pi, int x, int y) const
72 // unlock outer macro in arguments, and lock it again later
73 MacroData const & macro = MacroTable::globalMacros().get(mathMacro_.name());
75 mathMacro_.cell(idx_).draw(pi, x, y);
80 MathMacro::MathMacro(docstring const & name, int numargs)
81 : InsetMathNest(numargs), name_(name), editing_(false)
85 Inset * MathMacro::clone() const
87 MathMacro * x = new MathMacro(*this);
88 x->expanded_ = MathData();
89 x->macroBackup_ = MacroData();
94 docstring MathMacro::name() const
100 void MathMacro::cursorPos(BufferView const & bv,
101 CursorSlice const & sl, bool boundary, int & x, int & y) const
103 // We may have 0 arguments, but InsetMathNest requires at least one.
105 InsetMathNest::cursorPos(bv, sl, boundary, x, y);
109 void MathMacro::metrics(MetricsInfo & mi, Dimension & dim) const
112 if (!MacroTable::globalMacros().has(name())) {
113 mathed_string_dim(mi.base.font, "Unknown: " + name(), dim);
115 MacroData const & macro = MacroTable::globalMacros().get(name());
117 if (macroBackup_ != macro)
120 if (macro.locked()) {
121 mathed_string_dim(mi.base.font, "Self reference: " + name(), dim);
122 } else if (editing(mi.base.bv)) {
123 FontInfo font = mi.base.font;
124 augmentFont(font, from_ascii("lyxtex"));
125 tmpl_.metrics(mi, dim);
127 dim.wid += mathed_string_width(font, name()) + 10;
129 int ww = mathed_string_width(font, from_ascii("#1: "));
130 for (idx_type i = 0; i < nargs(); ++i) {
131 MathData const & c = cell(i);
134 dim.wid = max(dim.wid, dimc.width() + ww);
135 dim.des += dimc.height() + 10;
140 expanded_.metrics(mi, dim);
142 kerning_ = expanded_.kerning();
146 // Cache the inset dimension.
147 setDimCache(mi, dim);
151 void MathMacro::draw(PainterInfo & pi, int x, int y) const
153 if (!MacroTable::globalMacros().has(name())) {
155 drawStrRed(pi, x, y, "Unknown: " + name());
157 MacroData const & macro = MacroTable::globalMacros().get(name());
160 for (size_t i = 0; i < nargs(); ++i)
161 cell(i).setXY(*pi.base.bv, x, y);
163 if (macro.locked()) {
165 drawStrRed(pi, x, y, "Self reference: " + name());
166 } else if (editing_) {
167 FontInfo font = pi.base.font;
168 augmentFont(font, from_ascii("lyxtex"));
169 Dimension const dim = dimension(*pi.base.bv);
170 Dimension const & dim_tmpl = tmpl_.dimension(*pi.base.bv);
171 int h = y - dim.ascent() + 2 + dim_tmpl.ascent();
172 pi.pain.text(x + 3, h, name(), font);
173 int const w = mathed_string_width(font, name());
174 tmpl_.draw(pi, x + w + 12, h);
175 h += dim_tmpl.descent();
177 docstring t = from_ascii("#1: ");
178 mathed_string_dim(font, t, ldim);
179 for (idx_type i = 0; i < nargs(); ++i) {
180 MathData const & c = cell(i);
181 Dimension const & dimc = c.dimension(*pi.base.bv);
182 h += max(dimc.ascent(), ldim.asc) + 5;
183 c.draw(pi, x + ldim.wid, h);
184 char_type str[] = { '#', '1', ':', '\0' };
185 str[1] += static_cast<char_type>(i);
186 pi.pain.text(x + 3, h, str, font);
187 h += max(dimc.descent(), ldim.des) + 5;
191 expanded_.draw(pi, x, y);
195 // edit mode changed?
196 if (editing_ != editing(pi.base.bv) || macroBackup_ != macro)
197 pi.base.bv->cursor().updateFlags(Update::Force);
202 void MathMacro::drawSelection(PainterInfo & pi, int x, int y) const
204 // We may have 0 arguments, but InsetMathNest requires at least one.
206 InsetMathNest::drawSelection(pi, x, y);
210 void MathMacro::validate(LaTeXFeatures & features) const
212 string const require = MacroTable::globalMacros().get(name()).requires();
213 if (!require.empty())
214 features.require(require);
216 if (name() == "binom" || name() == "mathcircumflex")
217 features.require(to_utf8(name()));
221 Inset * MathMacro::editXY(Cursor & cur, int x, int y)
223 // We may have 0 arguments, but InsetMathNest requires at least one.
225 // Prevent crash due to cold coordcache
226 // FIXME: This is only a workaround, the call of
227 // InsetMathNest::editXY is correct. The correct fix would
228 // ensure that the coordcache of the arguments is valid.
229 if (!editing(&cur.bv())) {
233 return InsetMathNest::editXY(cur, x, y);
239 bool MathMacro::idxFirst(Cursor & cur) const
241 cur.updateFlags(Update::Force);
242 return InsetMathNest::idxFirst(cur);
246 bool MathMacro::idxLast(Cursor & cur) const
248 cur.updateFlags(Update::Force);
249 return InsetMathNest::idxLast(cur);
253 bool MathMacro::idxUpDown(Cursor & cur, bool up) const
260 if (cur.idx() + 1 >= nargs())
264 cur.pos() = cell(cur.idx()).x2pos(cur.x_target());
269 bool MathMacro::notifyCursorLeaves(Cursor & cur)
271 cur.updateFlags(Update::Force);
272 return InsetMathNest::notifyCursorLeaves(cur);
276 void MathMacro::maple(MapleStream & os) const
279 lyx::maple(expanded_, os);
283 void MathMacro::mathmlize(MathStream & os) const
286 lyx::mathmlize(expanded_, os);
290 void MathMacro::octave(OctaveStream & os) const
293 lyx::octave(expanded_, os);
297 void MathMacro::updateExpansion() const
299 MacroData const & macro = MacroTable::globalMacros().get(name());
301 // create MathMacroArgumentValue object pointing to the cells of the macro
302 std::vector<MathData> values(nargs());
303 for (size_t i = 0; i != nargs(); ++i)
304 values[i].insert(0, MathAtom(new MathMacroArgumentValue(*this, i)));
305 macro.expand(values, expanded_);
306 asArray(macro.def(), tmpl_);
307 macroBackup_ = macro;
311 void MathMacro::infoize(odocstream & os) const
313 os << "Macro: " << name();
317 void MathMacro::infoize2(odocstream & os) const
319 os << "Macro: " << name();