2 * \file InsetMathFracBase.cpp
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
10 * Full author contact details are available in file CREDITS.
15 #include "InsetMathFrac.h"
18 #include "MathParser.h"
19 #include "MathStream.h"
20 #include "MathSupport.h"
23 #include "LaTeXFeatures.h"
24 #include "MetricsInfo.h"
25 #include "TextPainter.h"
27 #include "frontends/FontMetrics.h"
28 #include "frontends/Painter.h"
30 #include "support/lassert.h"
37 /////////////////////////////////////////////////////////////////////
41 /////////////////////////////////////////////////////////////////////
44 InsetMathFracBase::InsetMathFracBase(Buffer * buf, idx_type ncells)
45 : InsetMathNest(buf, ncells)
49 bool InsetMathFracBase::idxUpDown(Cursor & cur, bool up) const
51 // If we only have one cell, target = 0, otherwise
52 // target = up ? 0 : 1, since upper cell has idx 0
53 InsetMath::idx_type target = nargs() > 1 ? !up : 0;
54 if (cur.idx() == target)
57 cur.pos() = cell(target).x2pos(&cur.bv(), cur.x_target());
63 /////////////////////////////////////////////////////////////////////
67 /////////////////////////////////////////////////////////////////////
70 InsetMathFrac::InsetMathFrac(Buffer * buf, Kind kind, InsetMath::idx_type ncells)
71 : InsetMathFracBase(buf, ncells), kind_(kind)
75 Inset * InsetMathFrac::clone() const
77 return new InsetMathFrac(*this);
81 InsetMathFrac * InsetMathFrac::asFracInset()
83 return kind_ == ATOP ? 0 : this;
87 InsetMathFrac const * InsetMathFrac::asFracInset() const
89 return kind_ == ATOP ? 0 : this;
93 bool InsetMathFrac::idxForward(Cursor & cur) const
95 InsetMath::idx_type target = 0;
96 if (kind_ == UNIT || (kind_ == UNITFRAC && nargs() == 3)) {
99 else if (nargs() == 2)
103 if (cur.idx() == target)
106 cur.pos() = cell(target).x2pos(&cur.bv(), cur.x_target());
111 bool InsetMathFrac::idxBackward(Cursor & cur) const
113 InsetMath::idx_type target = 0;
114 if (kind_ == UNIT || (kind_ == UNITFRAC && nargs() == 3)) {
117 else if (nargs() == 2)
121 if (cur.idx() == target)
124 cur.pos() = cell(target).x2pos(&cur.bv(), cur.x_target());
129 MathClass InsetMathFrac::mathClass() const
131 // Generalized fractions are of inner class (see The TeXbook, p. 292)
132 // But stuff from the unit/nicefrac packages are not real fractions.
133 MathClass mc = MC_ORD;
157 // align frac to minus character
158 int dy_for_frac(MetricsBase & mb)
160 Changer dummy = mb.changeFontSet("mathnormal");
161 return theFontMetrics(mb.font).ascent('-') - 1;
165 // align the top of M in the cell with the top of M in the surrounding font
166 int dy_for_nicefrac(MetricsBase & mb)
168 // this is according to nicefrac.sty
169 int big_m = theFontMetrics(mb.font).ascent('M');
170 Changer dummy = mb.changeScript();
171 int small_m = theFontMetrics(mb.font).ascent('M');
172 return big_m - small_m;
176 // symbol for nicefrac solidus
177 latexkeys const * slash_symbol()
179 return in_word_set(from_ascii("slash"));
186 void InsetMathFrac::metrics(MetricsInfo & mi, Dimension & dim) const
188 Dimension dim0, dim1, dim2;
189 Changer dummy3 = mi.base.changeEnsureMath();
193 // \unitone, \unittwo
196 // is there an extra cell holding the value being given a dimension?
197 // (this is \unittwo)
199 cell(0).metrics(mi, dim1);
200 dim.wid += dim1.wid + 4;
203 Changer dummy = mi.base.font.changeShape(UP_SHAPE);
204 cell(unit_cell).metrics(mi, dim0);
205 dim.wid += dim0.width() + 1;
206 dim.asc = max(dim0.asc, dim1.asc);
207 dim.des = max(dim0.des, dim1.des);
213 // \unitfrac, \unitfracthree, \nicefrac
217 int const dy = dy_for_nicefrac(mi.base);
218 // is there an extra cell holding the value being given a dimension?
219 // (this is \unitfracthree)
220 if (kind_ == UNITFRAC && nargs() == 3) {
221 cell(2).metrics(mi, dim2);
222 dim.wid += dim2.wid + 4;
226 Changer dummy = (kind_ == UNITFRAC) ? mi.base.font.changeShape(UP_SHAPE)
228 Changer dummy2 = mi.base.changeScript();
229 if (latexkeys const * slash = slash_symbol()) {
231 mathedSymbolDim(mi.base, dimslash, slash);
232 dim.wid += dimslash.wid - mathed_mu(mi.base.font, 3.0);
233 dim.asc = max(dim.asc, dimslash.asc);
234 dim.des = max(dim.des, dimslash.des);
236 cell(0).metrics(mi, dim0);
237 cell(1).metrics(mi, dim1);
238 dim.wid += dim0.wid + dim1.wid + 2;
239 dim.asc = max(max(dim.asc, dim0.asc + dy), dim1.asc);
240 dim.des = max(max(dim.des, dim0.des - dy), dim1.des);
252 int const dy = dy_for_frac(mi.base);
254 // \tfrac is always in text size
255 (kind_ == TFRAC) ? mi.base.font.changeStyle(LM_ST_SCRIPT) :
256 // \cfrac and \dfrac are always in display size
258 || kind_ == CFRACLEFT
259 || kind_ == CFRACRIGHT
260 || kind_ == DFRAC) ? mi.base.font.changeStyle(LM_ST_DISPLAY) :
262 mi.base.changeFrac();
263 Changer dummy2 = mi.base.changeEnsureMath();
264 cell(0).metrics(mi, dim0);
265 cell(1).metrics(mi, dim1);
266 dim.wid = max(dim0.wid, dim1.wid) + 2;
267 dim.asc = dim0.height() + dy/2 + dy;
268 int const t = mi.base.solidLineThickness();
269 dim.des = max(0, dim1.height() + dy/2 - dy + t);
272 metricsMarkers(mi, dim);
276 void InsetMathFrac::draw(PainterInfo & pi, int x, int y) const
278 Changer dummy3 = pi.base.changeEnsureMath();
279 Dimension const dim = dimension(*pi.base.bv);
280 Dimension const dim0 = cell(0).dimension(*pi.base.bv);
283 // \unitone, \unittwo
286 // is there an extra cell holding the value being given a dimension?
287 // (this is \unittwo)
289 cell(0).draw(pi, x + 1, y);
293 Changer dummy = pi.base.font.changeShape(UP_SHAPE);
294 cell(unit_cell).draw(pi, xx + 1, y);
300 // \unitfrac, \unitfracthree, \nicefrac
302 int const dy = dy_for_nicefrac(pi.base);
303 // is there an extra cell holding the value being given a dimension?
304 // (this is \unitfracthree)
305 if (kind_ == UNITFRAC && nargs() == 3) {
306 cell(2).draw(pi, x + 1, y);
307 xx += cell(2).dimension(*pi.base.bv).wid + 4;
309 Changer dummy = (kind_ == UNITFRAC) ? pi.base.font.changeShape(UP_SHAPE)
312 Changer dummy2 = pi.base.changeScript();
313 cell(0).draw(pi, xx + 2, y - dy);
314 // reference LaTeX code from nicefrac.sty:
315 // \mkern-2mu/\mkern-1mu
316 if (latexkeys const * slash = slash_symbol()) {
317 int mkern = mathed_mu(pi.base.font, 2.0);
318 mathedSymbolDraw(pi, xx + 2 + dim0.wid - mkern, y, slash);
320 mathedSymbolDim(pi.base, dimslash, slash);
321 xx += dimslash.wid - mathed_mu(pi.base.font, 3.0);
323 cell(1).draw(pi, xx + 2 + dim0.wid, y);
335 int const dy = dy_for_frac(pi.base);
337 // \tfrac is always in text size
338 (kind_ == TFRAC) ? pi.base.font.changeStyle(LM_ST_SCRIPT) :
339 // \cfrac and \dfrac are always in display size
341 || kind_ == CFRACLEFT
342 || kind_ == CFRACRIGHT
343 || kind_ == DFRAC) ? pi.base.font.changeStyle(LM_ST_DISPLAY) :
345 pi.base.changeFrac();
346 Dimension const dim1 = cell(1).dimension(*pi.base.bv);
347 int const m = x + dim.wid / 2;
350 (kind_ == CFRACLEFT) ? x + 2 :
352 (kind_ == CFRACRIGHT) ? x + dim.wid - dim0.wid - 2 :
355 int const t = pi.base.solidLineThickness();
356 // take dy/2 for the spacing around the horizontal line. This is
357 // arbitrary. In LaTeX it is more complicated to ensure that displayed
358 // fractions line up next to each other.
359 // For more accurate implementation refer to the TeXbook, Appendix G,
361 cell(0).draw(pi, xx, y - dim0.des - dy/2 - dy);
363 cell(1).draw(pi, m - dim1.wid / 2, y + dim1.asc + dy/2 - dy + t);
366 pi.pain.line(x + 1, y - dy, x + dim.wid - 2, y - dy,
367 pi.base.font.color(), pi.pain.line_solid, t);
370 drawMarkers(pi, x, y);
374 void InsetMathFrac::metricsT(TextMetricsInfo const & mi, Dimension & dim) const
376 Dimension dim0, dim1;
377 cell(0).metricsT(mi, dim0);
378 cell(1).metricsT(mi, dim1);
379 dim.wid = max(dim0.width(), dim1.wid);
380 dim.asc = dim0.height() + 1;
381 dim.des = dim1.height();
385 void InsetMathFrac::drawT(TextPainter & /*pain*/, int /*x*/, int /*y*/) const
390 int m = x + dim.width() / 2;
391 cell(0).drawT(pain, m - dim0.width() / 2, y - dim0.des - 1);
392 cell(1).drawT(pain, m - dim1.wid / 2, y + dim1.asc);
393 // ASCII art: ignore niceties
394 if (kind_ == FRAC || kind_ == OVER || kind_ == NICEFRAC || kind_ == UNITFRAC)
395 pain.horizontalLine(x, y, dim.width());
400 void InsetMathFrac::write(WriteStream & os) const
402 MathEnsurer ensurer(os);
405 // \\atop is only for compatibility, \\binom is the
407 os << '{' << cell(0) << "\\atop " << cell(1) << '}';
410 // \\over is only for compatibility, normalize this to \\frac
411 os << "\\frac{" << cell(0) << "}{" << cell(1) << '}';
420 InsetMathNest::write(os);
422 os << "\\unitfrac[" << cell(2) << "]{" << cell(0) << "}{" << cell(1) << '}';
426 os << "\\unit[" << cell(0) << "]{" << cell(1) << '}';
428 os << "\\unit{" << cell(0) << '}';
431 os << "\\cfrac[l]{" << cell(0) << "}{" << cell(1) << '}';
434 os << "\\cfrac[r]{" << cell(0) << "}{" << cell(1) << '}';
440 docstring InsetMathFrac::name() const
444 return from_ascii("frac");
448 return from_ascii("cfrac");
450 return from_ascii("dfrac");
452 return from_ascii("tfrac");
454 return from_ascii("over");
456 return from_ascii("nicefrac");
458 return from_ascii("unitfrac");
460 return from_ascii("unit");
462 return from_ascii("atop");
464 // shut up stupid compiler
469 bool InsetMathFrac::extraBraces() const
471 return kind_ == ATOP || kind_ == OVER;
475 void InsetMathFrac::maple(MapleStream & os) const
478 // Someone who knows about maple should fix this.
479 LASSERT(false, return);
481 os << '(' << cell(0) << ")/(" << cell(1) << ')';
485 void InsetMathFrac::mathematica(MathematicaStream & os) const
488 // Someone who knows about mathematica should fix this.
489 LASSERT(false, return);
491 os << '(' << cell(0) << ")/(" << cell(1) << ')';
495 void InsetMathFrac::octave(OctaveStream & os) const
498 // Someone who knows about octave should fix this.
499 LASSERT(false, return);
501 os << '(' << cell(0) << ")/(" << cell(1) << ')';
505 void InsetMathFrac::mathmlize(MathStream & os) const
509 os << MTag("mfrac", "linethickeness='0'")
510 << MTag("mrow") << cell(0) << ETag("mrow")
511 << MTag("mrow") << cell(1) << ETag("mrow")
515 // we do not presently distinguish these
524 << MTag("mrow") << cell(0) << ETag("mrow")
525 << MTag("mrow") << cell(1) << ETag("mrow")
530 os << MTag("mfrac", "bevelled='true'")
531 << MTag("mrow") << cell(0) << ETag("mrow")
532 << MTag("mrow") << cell(1) << ETag("mrow")
539 os << MTag("mfrac", "bevelled='true'")
540 << MTag("mrow") << cell(0) << ETag("mrow")
541 << MTag("mrow") << cell(1) << ETag("mrow")
546 // FIXME This is not right, because we still output mi, etc,
547 // when we output the cell. So we need to prevent that somehow.
550 << MTag("mstyle mathvariant='normal'")
554 os << MTag("mstyle mathvariant='normal'")
561 void InsetMathFrac::htmlize(HtmlStream & os) const
565 os << MTag("span", "class='frac'")
566 << MTag("span", "class='numer'") << cell(0) << ETag("span")
567 << MTag("span", "class='numer'") << cell(1) << ETag("span")
571 // we do not presently distinguish these
579 os << MTag("span", "class='frac'")
580 << MTag("span", "class='numer'") << cell(0) << ETag("span")
581 << MTag("span", "class='denom'") << cell(1) << ETag("span")
586 os << cell(0) << '/' << cell(1);
591 os << cell(2) << ' ';
592 os << cell(0) << '/' << cell(1);
596 // FIXME This is not right, because we still output i, etc,
597 // when we output the cell. So we need to prevent that somehow.
611 void InsetMathFrac::validate(LaTeXFeatures & features) const
613 if (kind_ == NICEFRAC || kind_ == UNITFRAC || kind_ == UNIT)
614 features.require("units");
615 if (kind_ == CFRAC || kind_ == CFRACLEFT || kind_ == CFRACRIGHT
616 || kind_ == DFRAC || kind_ == TFRAC)
617 features.require("amsmath");
618 if (features.runparams().math_flavor == OutputParams::MathAsHTML)
619 // CSS adapted from eLyXer
620 features.addCSSSnippet(
621 "span.frac{display: inline-block; vertical-align: middle; text-align:center;}\n"
622 "span.numer{display: block;}\n"
623 "span.denom{display: block; border-top: thin solid #000040;}");
624 InsetMathNest::validate(features);
628 /////////////////////////////////////////////////////////////////////
632 /////////////////////////////////////////////////////////////////////
635 InsetMathBinom::InsetMathBinom(Buffer * buf, Kind kind)
636 : InsetMathFracBase(buf), kind_(kind)
640 Inset * InsetMathBinom::clone() const
642 return new InsetMathBinom(*this);
646 int InsetMathBinom::dw(int height) const
657 void InsetMathBinom::metrics(MetricsInfo & mi, Dimension & dim) const
659 Changer dummy2 = mi.base.changeEnsureMath();
660 Dimension dim0, dim1;
661 int const dy = dy_for_frac(mi.base);
663 (kind_ == DBINOM) ? mi.base.font.changeStyle(LM_ST_DISPLAY) :
664 (kind_ == TBINOM) ? mi.base.font.changeStyle(LM_ST_SCRIPT) :
665 mi.base.changeFrac();
666 cell(0).metrics(mi, dim0);
667 cell(1).metrics(mi, dim1);
668 dim.asc = dim0.height() + 1 + dy/2 + dy;
669 dim.des = max(0, dim1.height() + 1 + dy/2 - dy);
670 dim.wid = max(dim0.wid, dim1.wid) + 2 * dw(dim.height()) + 4;
671 metricsMarkers2(mi, dim);
675 void InsetMathBinom::draw(PainterInfo & pi, int x, int y) const
677 Changer dummy2 = pi.base.changeEnsureMath();
678 Dimension const dim = dimension(*pi.base.bv);
679 Dimension const & dim0 = cell(0).dimension(*pi.base.bv);
680 Dimension const & dim1 = cell(1).dimension(*pi.base.bv);
681 int const dy = dy_for_frac(pi.base);
682 // define the binom brackets
683 docstring const bra = kind_ == BRACE ? from_ascii("{") :
684 kind_ == BRACK ? from_ascii("[") : from_ascii("(");
685 docstring const ket = kind_ == BRACE ? from_ascii("}") :
686 kind_ == BRACK ? from_ascii("]") : from_ascii(")");
688 int m = x + dim.width() / 2;
691 (kind_ == DBINOM) ? pi.base.font.changeStyle(LM_ST_DISPLAY) :
692 (kind_ == TBINOM) ? pi.base.font.changeStyle(LM_ST_SCRIPT) :
693 pi.base.changeFrac();
694 // take dy both for the vertical alignment and for the spacing between
696 cell(0).draw(pi, m - dim0.wid / 2, y - dim0.des - dy/2 - dy);
697 cell(1).draw(pi, m - dim1.wid / 2, y + dim1.asc + dy/2 - dy);
699 // draw the brackets and the marker
700 mathed_draw_deco(pi, x, y - dim.ascent(), dw(dim.height()),
702 mathed_draw_deco(pi, x + dim.width() - dw(dim.height()),
703 y - dim.ascent(), dw(dim.height()), dim.height(), ket);
704 drawMarkers2(pi, x, y);
708 bool InsetMathBinom::extraBraces() const
710 return kind_ == CHOOSE || kind_ == BRACE || kind_ == BRACK;
714 void InsetMathBinom::write(WriteStream & os) const
716 MathEnsurer ensurer(os);
719 os << "\\binom{" << cell(0) << "}{" << cell(1) << '}';
722 os << "\\dbinom{" << cell(0) << "}{" << cell(1) << '}';
725 os << "\\tbinom{" << cell(0) << "}{" << cell(1) << '}';
728 os << '{' << cell(0) << " \\choose " << cell(1) << '}';
731 os << '{' << cell(0) << " \\brace " << cell(1) << '}';
734 os << '{' << cell(0) << " \\brack " << cell(1) << '}';
740 void InsetMathBinom::normalize(NormalStream & os) const
742 os << "[binom " << cell(0) << ' ' << cell(1) << ']';
746 void InsetMathBinom::mathmlize(MathStream & os) const
767 os << "<mo fence='true' stretchy='true' form='prefix'>" << ldelim << "</mo>"
768 << "<mfrac linethickness='0'>"
769 << cell(0) << cell(1)
771 << "<mo fence='true' stretchy='true' form='postfix'>" << rdelim << "</mo>";
775 void InsetMathBinom::htmlize(HtmlStream & os) const
796 os << MTag("span", "class='binomdelim'") << ldelim << ETag("span") << '\n'
797 << MTag("span", "class='binom'") << '\n'
798 << MTag("span") << cell(0) << ETag("span") << '\n'
799 << MTag("span") << cell(1) << ETag("span") << '\n'
800 << ETag("span") << '\n'
801 << MTag("span", "class='binomdelim'") << rdelim << ETag("span") << '\n';
805 void InsetMathBinom::validate(LaTeXFeatures & features) const
807 if (features.runparams().isLaTeX()) {
809 features.require("binom");
810 if (kind_ == DBINOM || kind_ == TBINOM)
811 features.require("amsmath");
812 } else if (features.runparams().math_flavor == OutputParams::MathAsHTML)
813 features.addCSSSnippet(
814 "span.binom{display: inline-block; vertical-align: bottom; text-align:center;}\n"
815 "span.binom span{display: block;}\n"
816 "span.binomdelim{font-size: 2em;}");
817 InsetMathNest::validate(features);