3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Jean-Marc Lasgouttes
8 * Full author contact details are available in file CREDITS.
15 #include "InsetMath.h"
16 #include "MathClass.h"
18 #include "MathSupport.h"
20 #include "BufferView.h"
22 #include "CoordCache.h"
23 #include "MetricsInfo.h"
25 #include "frontends/FontMetrics.h"
26 #include "frontends/Painter.h"
28 #include "support/debug.h"
29 #include "support/docstring.h"
30 #include "support/lassert.h"
40 MathRow::Element::Element(MetricsInfo const & mi, Type t, MathClass mc)
41 : type(t), mclass(mc), before(0), after(0), macro_nesting(mi.base.macro_nesting),
42 marker(InsetMath::NO_MARKER), inset(0), compl_unique_to(0), ar(0),
49 // Helper functions for markers
51 int markerMargin(MathRow::Element const & e)
54 case InsetMath::MARKER:
55 case InsetMath::MARKER2:
56 case InsetMath::BOX_MARKER:
58 case InsetMath::NO_MARKER:
66 void afterMetricsMarkers(MetricsInfo const & , MathRow::Element & e,
69 // handle vertical space for markers
71 case InsetMath::NO_MARKER:
73 case InsetMath::MARKER:
76 case InsetMath::MARKER2:
80 case InsetMath::BOX_MARKER:
82 font.setSize(TINY_SIZE);
84 mathed_string_dim(font, e.inset->name(), namedim);
85 int const namewid = 1 + namedim.wid + 1;
87 if (namewid > dim.wid)
88 e.after += namewid - dim.wid;
90 dim.des += 3 + namedim.height();
95 void drawMarkers(PainterInfo const & pi, MathRow::Element const & e,
96 int const x, int const y)
98 if (e.marker == InsetMath::NO_MARKER)
101 CoordCache const & coords = pi.base.bv->coordCache();
102 Dimension const dim = coords.getInsets().dim(e.inset);
104 // the marker is before/after the inset. Necessary space has been reserved already.
105 int const l = x + e.before - (markerMargin(e) > 0 ? 1 : 0);
106 int const r = x + dim.width() - e.after;
109 if (e.marker == InsetMath::BOX_MARKER) {
110 // draw header and rectangle around
112 font.setSize(TINY_SIZE);
113 font.setColor(Color_mathmacrolabel);
115 mathed_string_dim(font, e.inset->name(), namedim);
116 pi.pain.fillRectangle(l, y + dim.des - namedim.height() - 2,
117 dim.wid, namedim.height() + 2, Color_mathmacrobg);
118 pi.pain.text(l, y + dim.des - namedim.des - 1, e.inset->name(), font);
122 bool const highlight = e.inset->mouseHovered(pi.base.bv)
123 || e.inset->editing(pi.base.bv);
124 ColorCode const pen_color = highlight ? Color_mathframe : Color_mathcorners;
125 // If the corners have the same color as the background, do not paint them.
126 if (lcolor.getX11Name(Color_mathbg) == lcolor.getX11Name(pen_color))
129 // Lower corners in all cases
130 int const d = y + dim.descent();
131 pi.pain.line(l, d - 3, l, d, pen_color);
132 pi.pain.line(r, d - 3, r, d, pen_color);
133 pi.pain.line(l, d, l + 3, d, pen_color);
134 pi.pain.line(r - 3, d, r, d, pen_color);
137 if (e.marker == InsetMath::BOX_MARKER
138 || e.marker == InsetMath::MARKER2) {
139 int const a = y - dim.ascent();
140 pi.pain.line(l, a + 3, l, a, pen_color);
141 pi.pain.line(r, a + 3, r, a, pen_color);
142 pi.pain.line(l, a, l + 3, a, pen_color);
143 pi.pain.line(r - 3, a, r, a, pen_color);
150 MathRow::MathRow(MetricsInfo & mi, MathData const * ar)
152 // First there is a dummy element of type "open"
153 push_back(Element(mi, DUMMY, MC_OPEN));
155 // Then insert the MathData argument
156 bool const has_contents = ar->addToMathRow(*this, mi);
158 // A MathRow should not be completely empty
160 Element e(mi, BOX, MC_ORD);
161 // empty arrays are visible when they are editable
162 e.color = mi.base.macro_nesting == 0 ? Color_mathline : Color_none;
166 // Finally there is a dummy element of type "close"
167 push_back(Element(mi, DUMMY, MC_CLOSE));
169 /* Do spacing only in math mode. This test is a bit clumsy,
170 * but it is used in other places for guessing the current mode.
172 bool const dospacing = isMathFont(mi.base.fontname);
176 for (int i = 1 ; i != static_cast<int>(elements_.size()) - 1 ; ++i) {
177 if (elements_[i].mclass != MC_UNKNOWN)
178 update_class(elements_[i].mclass, elements_[before(i)].mclass,
179 elements_[after(i)].mclass);
184 // We go to the end to handle spacing at the end of equation
185 for (int i = 1 ; i != static_cast<int>(elements_.size()) ; ++i) {
186 Element & e = elements_[i];
188 Element & bef = elements_[before(i)];
189 if (dospacing && e.mclass != MC_UNKNOWN) {
190 int spc = class_spacing(bef.mclass, e.mclass, mi.base);
191 bef.after += spc / 2;
192 // this is better than spc / 2 to avoid rounding problems
193 e.before += spc - spc / 2;
196 // finally reserve space for markers
197 bef.after = max(bef.after, markerMargin(bef));
198 if (e.mclass != MC_UNKNOWN)
199 e.before = max(e.before, markerMargin(e));
200 // for linearized insets (macros...) too
202 bef.after = max(bef.after, markerMargin(e));
203 if (e.type == END && e.marker != InsetMath::NO_MARKER) {
204 Element & aft = elements_[after(i)];
205 aft.before = max(aft.before, markerMargin(e));
209 // Do not lose spacing allocated to extremities
210 if (!elements_.empty()) {
211 elements_[after(0)].before += elements_.front().after;
212 elements_[before(elements_.size() - 1)].after += elements_.back().before;
217 int MathRow::before(int i) const
221 while (elements_[i].mclass == MC_UNKNOWN);
227 int MathRow::after(int i) const
231 while (elements_[i].mclass == MC_UNKNOWN);
237 void MathRow::metrics(MetricsInfo & mi, Dimension & dim)
240 // In order to compute the dimension of macros and their
241 // arguments, it is necessary to keep track of them.
242 vector<pair<InsetMath const *, Dimension>> dim_insets;
243 vector<pair<MathData const *, Dimension>> dim_arrays;
244 CoordCache & coords = mi.base.bv->coordCache();
245 for (Element & e : elements_) {
246 mi.base.macro_nesting = e.macro_nesting;
252 e.inset->metrics(mi, d);
253 d.wid += e.before + e.after;
254 coords.insets().add(e.inset, d);
258 dim_insets.push_back(make_pair(e.inset, Dimension()));
259 dim_insets.back().second.wid += e.before + e.after;
260 d.wid = e.before + e.after;
261 e.inset->beforeMetrics();
264 dim_arrays.push_back(make_pair(e.ar, Dimension()));
268 e.inset->afterMetrics();
269 LATTEST(dim_insets.back().first == e.inset);
270 d = dim_insets.back().second;
271 afterMetricsMarkers(mi, e, d);
272 d.wid += e.before + e.after;
273 coords.insets().add(e.inset, d);
274 dim_insets.pop_back();
275 // We do not want to count the width again, but the
276 // padding and the vertical dimension are meaningful.
277 d.wid = e.before + e.after;
280 LATTEST(dim_arrays.back().first == e.ar);
281 coords.arrays().add(e.ar, dim_arrays.back().second);
282 dim_arrays.pop_back();
286 d = theFontMetrics(mi.base.font).dimension('I');
287 if (e.color != Color_none) {
288 // allow for one pixel before/after the box.
289 d.wid += e.before + e.after + 2;
291 // hide the box, but keep its height
299 // Now add the dimension to current macros and arguments.
300 for (auto & dim_macro : dim_insets)
301 dim_macro.second += d;
302 for (auto & dim_array : dim_arrays)
303 dim_array.second += d;
306 if (e.compl_text.empty())
308 FontInfo font = mi.base.font;
309 augmentFont(font, "mathnormal");
310 dim.wid += mathed_string_width(font, e.compl_text);
312 LATTEST(dim_insets.empty() && dim_arrays.empty());
316 void MathRow::draw(PainterInfo & pi, int x, int const y) const
318 CoordCache & coords = pi.base.bv->coordCache();
319 for (Element const & e : elements_) {
322 // This is hackish: the math inset does not know that space
323 // has been added before and after it; we alter its dimension
324 // while it is drawing, because it relies on this value.
325 Dimension const d = coords.insets().dim(e.inset);
327 d2.wid -= e.before + e.after;
328 coords.insets().add(e.inset, d2);
329 if (pi.pain.develMode() && !e.inset->isBufferValid())
330 pi.pain.fillRectangle(x + e.before, y - d2.ascent(),
331 d2.width(), d2.height(), Color_error);
332 e.inset->draw(pi, x + e.before, y);
333 coords.insets().add(e.inset, x, y);
334 coords.insets().add(e.inset, d);
335 drawMarkers(pi, e, x, y);
341 coords.arrays().add(e.ar, x, y);
342 e.ar->drawSelection(pi, x, y);
345 coords.insets().add(e.inset, x, y);
346 drawMarkers(pi, e, x, y);
347 e.inset->beforeDraw(pi);
349 x += e.before + e.after;
353 e.inset->afterDraw(pi);
354 x += e.before + e.after;
357 if (e.color == Color_none)
359 Dimension const d = theFontMetrics(pi.base.font).dimension('I');
360 pi.pain.rectangle(x + e.before + 1, y - d.ascent(),
361 d.width() - 1, d.height() - 1, e.color);
362 x += d.wid + 2 + e.before + e.after;
369 if (e.compl_text.empty())
371 FontInfo f = pi.base.font;
372 augmentFont(f, "mathnormal");
374 // draw the unique and the non-unique completion part
375 // Note: this is not time-critical as it is
376 // only done once per screen.
377 docstring const s1 = e.compl_text.substr(0, e.compl_unique_to);
378 docstring const s2 = e.compl_text.substr(e.compl_unique_to);
381 f.setColor(Color_inlinecompletion);
382 // offset the text by e.after to make sure that the
383 // spacing is after the completion, not before.
384 pi.pain.text(x - e.after, y, s1, f);
385 x += mathed_string_width(f, s1);
388 f.setColor(Color_nonunique_inlinecompletion);
389 pi.pain.text(x - e.after, y, s2, f);
390 x += mathed_string_width(f, s2);
396 int MathRow::kerning(BufferView const * bv) const
398 if (elements_.empty())
400 InsetMath const * inset = elements_[before(elements_.size() - 1)].inset;
401 return inset ? inset->kerning(bv) : 0;
405 ostream & operator<<(ostream & os, MathRow::Element const & e)
409 os << (e.mclass == MC_OPEN ? "{" : "}");
412 os << "<" << e.before << "-"
413 << to_utf8(class_to_string(e.mclass))
414 << "-" << e.after << ">";
418 os << "\\" << to_utf8(e.inset->name())
419 << "^" << e.macro_nesting << "[";
430 os << "<" << e.before << "-[]-" << e.after << ">";
437 ostream & operator<<(ostream & os, MathRow const & mrow)
439 for (MathRow::Element const & e : mrow)