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 the top of M in the cell with the top of M in the surrounding font
158 int dy_for_nicefrac(MetricsBase & mb)
160 // this is according to nicefrac.sty
161 int big_m = theFontMetrics(mb.font).ascent('M');
162 Changer dummy = mb.changeScript();
163 int small_m = theFontMetrics(mb.font).ascent('M');
164 return big_m - small_m;
168 // symbol for nicefrac solidus
169 latexkeys const * slash_symbol()
171 return in_word_set(from_ascii("slash"));
178 void InsetMathFrac::metrics(MetricsInfo & mi, Dimension & dim) const
180 Dimension dim0, dim1, dim2;
181 Changer dummy3 = mi.base.changeEnsureMath();
185 // \unitone, \unittwo
188 // is there an extra cell holding the value being given a dimension?
189 // (this is \unittwo)
191 cell(0).metrics(mi, dim1);
192 dim.wid += dim1.wid + 4;
195 Changer dummy = mi.base.font.changeShape(UP_SHAPE);
196 cell(unit_cell).metrics(mi, dim0);
197 dim.wid += dim0.width() + 1;
198 dim.asc = max(dim0.asc, dim1.asc);
199 dim.des = max(dim0.des, dim1.des);
205 // \unitfrac, \unitfracthree, \nicefrac
209 int const dy = dy_for_nicefrac(mi.base);
210 // is there an extra cell holding the value being given a dimension?
211 // (this is \unitfracthree)
212 if (kind_ == UNITFRAC && nargs() == 3) {
213 cell(2).metrics(mi, dim2);
214 dim.wid += dim2.wid + 4;
218 Changer dummy = (kind_ == UNITFRAC) ? mi.base.font.changeShape(UP_SHAPE)
220 Changer dummy2 = mi.base.changeScript();
221 if (latexkeys const * slash = slash_symbol()) {
223 mathedSymbolDim(mi.base, dimslash, slash);
224 dim.wid += dimslash.wid - mathed_mu(mi.base.font, 3.0);
225 dim.asc = max(dim.asc, dimslash.asc);
226 dim.des = max(dim.des, dimslash.des);
228 cell(0).metrics(mi, dim0);
229 cell(1).metrics(mi, dim1);
230 dim.wid += dim0.wid + dim1.wid + 2;
231 dim.asc = max(max(dim.asc, dim0.asc + dy), dim1.asc);
232 dim.des = max(max(dim.des, dim0.des - dy), dim1.des);
244 int const dy = axis_height(mi.base);
246 // \tfrac is always in text size
247 (kind_ == TFRAC) ? mi.base.font.changeStyle(LM_ST_SCRIPT) :
248 // \cfrac and \dfrac are always in display size
250 || kind_ == CFRACLEFT
251 || kind_ == CFRACRIGHT
252 || kind_ == DFRAC) ? mi.base.font.changeStyle(LM_ST_DISPLAY) :
254 mi.base.changeFrac();
255 Changer dummy2 = mi.base.changeEnsureMath();
256 cell(0).metrics(mi, dim0);
257 cell(1).metrics(mi, dim1);
258 dim.wid = max(dim0.wid, dim1.wid) + 2;
259 dim.asc = dim0.height() + dy/2 + dy;
260 int const t = mi.base.solidLineThickness();
261 dim.des = max(0, dim1.height() + dy/2 - dy + t);
267 void InsetMathFrac::draw(PainterInfo & pi, int x, int y) const
269 Changer dummy3 = pi.base.changeEnsureMath();
270 Dimension const dim = dimension(*pi.base.bv);
271 Dimension const dim0 = cell(0).dimension(*pi.base.bv);
274 // \unitone, \unittwo
277 // is there an extra cell holding the value being given a dimension?
278 // (this is \unittwo)
280 cell(0).draw(pi, x, y);
284 Changer dummy = pi.base.font.changeShape(UP_SHAPE);
285 cell(unit_cell).draw(pi, xx, y);
291 // \unitfrac, \unitfracthree, \nicefrac
293 int const dy = dy_for_nicefrac(pi.base);
294 // is there an extra cell holding the value being given a dimension?
295 // (this is \unitfracthree)
296 if (kind_ == UNITFRAC && nargs() == 3) {
297 cell(2).draw(pi, x, y);
298 xx += cell(2).dimension(*pi.base.bv).wid + 4;
300 Changer dummy = (kind_ == UNITFRAC) ? pi.base.font.changeShape(UP_SHAPE)
303 Changer dummy2 = pi.base.changeScript();
304 cell(0).draw(pi, xx + 1, y - dy);
305 // reference LaTeX code from nicefrac.sty:
306 // \mkern-2mu/\mkern-1mu
307 if (latexkeys const * slash = slash_symbol()) {
308 int mkern = mathed_mu(pi.base.font, 2.0);
309 mathedSymbolDraw(pi, xx + 1 + dim0.wid - mkern, y, slash);
311 mathedSymbolDim(pi.base, dimslash, slash);
312 xx += dimslash.wid - mathed_mu(pi.base.font, 3.0);
314 cell(1).draw(pi, xx + 1 + dim0.wid, y);
326 int const dy = axis_height(pi.base);
328 // \tfrac is always in text size
329 (kind_ == TFRAC) ? pi.base.font.changeStyle(LM_ST_SCRIPT) :
330 // \cfrac and \dfrac are always in display size
332 || kind_ == CFRACLEFT
333 || kind_ == CFRACRIGHT
334 || kind_ == DFRAC) ? pi.base.font.changeStyle(LM_ST_DISPLAY) :
336 pi.base.changeFrac();
337 Dimension const dim1 = cell(1).dimension(*pi.base.bv);
338 int const m = x + dim.wid / 2;
341 (kind_ == CFRACLEFT) ? x + 1 :
343 (kind_ == CFRACRIGHT) ? x + dim.wid - dim0.wid - 2 :
346 int const t = pi.base.solidLineThickness();
347 // take dy/2 for the spacing around the horizontal line. This is
348 // arbitrary. In LaTeX it is more complicated to ensure that displayed
349 // fractions line up next to each other.
350 // For more accurate implementation refer to the TeXbook, Appendix G,
352 cell(0).draw(pi, xx, y - dim0.des - dy/2 - dy);
354 cell(1).draw(pi, m - dim1.wid / 2, y + dim1.asc + dy/2 - dy + t);
357 pi.pain.line(x, y - dy, x + dim.wid, y - dy,
358 pi.base.font.color(), pi.pain.line_solid, t);
364 void InsetMathFrac::metricsT(TextMetricsInfo const & mi, Dimension & dim) const
366 Dimension dim0, dim1;
367 cell(0).metricsT(mi, dim0);
368 cell(1).metricsT(mi, dim1);
369 dim.wid = max(dim0.width(), dim1.wid);
370 dim.asc = dim0.height() + 1;
371 dim.des = dim1.height();
375 void InsetMathFrac::drawT(TextPainter & /*pain*/, int /*x*/, int /*y*/) const
380 int m = x + dim.width() / 2;
381 cell(0).drawT(pain, m - dim0.width() / 2, y - dim0.des - 1);
382 cell(1).drawT(pain, m - dim1.wid / 2, y + dim1.asc);
383 // ASCII art: ignore niceties
384 if (kind_ == FRAC || kind_ == OVER || kind_ == NICEFRAC || kind_ == UNITFRAC)
385 pain.horizontalLine(x, y, dim.width());
390 void InsetMathFrac::write(WriteStream & os) const
392 MathEnsurer ensurer(os);
395 // \\atop is only for compatibility, \\binom is the
397 os << '{' << cell(0) << "\\atop " << cell(1) << '}';
400 // \\over is only for compatibility, normalize this to \\frac
401 os << "\\frac{" << cell(0) << "}{" << cell(1) << '}';
410 InsetMathNest::write(os);
412 os << "\\unitfrac[" << cell(2) << "]{" << cell(0) << "}{" << cell(1) << '}';
416 os << "\\unit[" << cell(0) << "]{" << cell(1) << '}';
418 os << "\\unit{" << cell(0) << '}';
421 os << "\\cfrac[l]{" << cell(0) << "}{" << cell(1) << '}';
424 os << "\\cfrac[r]{" << cell(0) << "}{" << cell(1) << '}';
430 docstring InsetMathFrac::name() const
434 return from_ascii("frac");
438 return from_ascii("cfrac");
440 return from_ascii("dfrac");
442 return from_ascii("tfrac");
444 return from_ascii("over");
446 return from_ascii("nicefrac");
448 return from_ascii("unitfrac");
450 return from_ascii("unit");
452 return from_ascii("atop");
454 // shut up stupid compiler
459 bool InsetMathFrac::extraBraces() const
461 return kind_ == ATOP || kind_ == OVER;
465 void InsetMathFrac::maple(MapleStream & os) const
468 // Someone who knows about maple should fix this.
469 LASSERT(false, return);
471 os << '(' << cell(0) << ")/(" << cell(1) << ')';
475 void InsetMathFrac::mathematica(MathematicaStream & os) const
478 // Someone who knows about mathematica should fix this.
479 LASSERT(false, return);
481 os << '(' << cell(0) << ")/(" << cell(1) << ')';
485 void InsetMathFrac::octave(OctaveStream & os) const
488 // Someone who knows about octave should fix this.
489 LASSERT(false, return);
491 os << '(' << cell(0) << ")/(" << cell(1) << ')';
495 void InsetMathFrac::mathmlize(MathStream & os) const
499 os << MTag("mfrac", "linethickeness='0'")
500 << MTag("mrow") << cell(0) << ETag("mrow")
501 << MTag("mrow") << cell(1) << ETag("mrow")
505 // we do not presently distinguish these
514 << MTag("mrow") << cell(0) << ETag("mrow")
515 << MTag("mrow") << cell(1) << ETag("mrow")
520 os << MTag("mfrac", "bevelled='true'")
521 << MTag("mrow") << cell(0) << ETag("mrow")
522 << MTag("mrow") << cell(1) << ETag("mrow")
529 os << MTag("mfrac", "bevelled='true'")
530 << MTag("mrow") << cell(0) << ETag("mrow")
531 << MTag("mrow") << cell(1) << ETag("mrow")
536 // FIXME This is not right, because we still output mi, etc,
537 // when we output the cell. So we need to prevent that somehow.
540 << MTag("mstyle mathvariant='normal'")
544 os << MTag("mstyle mathvariant='normal'")
551 void InsetMathFrac::htmlize(HtmlStream & os) const
555 os << MTag("span", "class='frac'")
556 << MTag("span", "class='numer'") << cell(0) << ETag("span")
557 << MTag("span", "class='numer'") << cell(1) << ETag("span")
561 // we do not presently distinguish these
569 os << MTag("span", "class='frac'")
570 << MTag("span", "class='numer'") << cell(0) << ETag("span")
571 << MTag("span", "class='denom'") << cell(1) << ETag("span")
576 os << cell(0) << '/' << cell(1);
581 os << cell(2) << ' ';
582 os << cell(0) << '/' << cell(1);
586 // FIXME This is not right, because we still output i, etc,
587 // when we output the cell. So we need to prevent that somehow.
601 void InsetMathFrac::validate(LaTeXFeatures & features) const
603 if (kind_ == NICEFRAC || kind_ == UNITFRAC || kind_ == UNIT)
604 features.require("units");
605 if (kind_ == CFRAC || kind_ == CFRACLEFT || kind_ == CFRACRIGHT
606 || kind_ == DFRAC || kind_ == TFRAC)
607 features.require("amsmath");
608 if (features.runparams().math_flavor == OutputParams::MathAsHTML)
609 // CSS adapted from eLyXer
610 features.addCSSSnippet(
611 "span.frac{display: inline-block; vertical-align: middle; text-align:center;}\n"
612 "span.numer{display: block;}\n"
613 "span.denom{display: block; border-top: thin solid #000040;}");
614 InsetMathNest::validate(features);
618 /////////////////////////////////////////////////////////////////////
622 /////////////////////////////////////////////////////////////////////
625 InsetMathBinom::InsetMathBinom(Buffer * buf, Kind kind)
626 : InsetMathFracBase(buf), kind_(kind)
630 Inset * InsetMathBinom::clone() const
632 return new InsetMathBinom(*this);
636 int InsetMathBinom::dw(int height) const
647 void InsetMathBinom::metrics(MetricsInfo & mi, Dimension & dim) const
649 Changer dummy2 = mi.base.changeEnsureMath();
650 Dimension dim0, dim1;
651 int const dy = axis_height(mi.base);
653 (kind_ == DBINOM) ? mi.base.font.changeStyle(LM_ST_DISPLAY) :
654 (kind_ == TBINOM) ? mi.base.font.changeStyle(LM_ST_SCRIPT) :
655 mi.base.changeFrac();
656 cell(0).metrics(mi, dim0);
657 cell(1).metrics(mi, dim1);
658 dim.asc = dim0.height() + 1 + dy/2 + dy;
659 dim.des = max(0, dim1.height() + 1 + dy/2 - dy);
660 dim.wid = max(dim0.wid, dim1.wid) + 2 * dw(dim.height()) + 4;
664 void InsetMathBinom::draw(PainterInfo & pi, int x, int y) const
666 Changer dummy2 = pi.base.changeEnsureMath();
667 Dimension const dim = dimension(*pi.base.bv);
668 Dimension const & dim0 = cell(0).dimension(*pi.base.bv);
669 Dimension const & dim1 = cell(1).dimension(*pi.base.bv);
670 int const dy = axis_height(pi.base);
671 // define the binom brackets
672 docstring const bra = kind_ == BRACE ? from_ascii("{") :
673 kind_ == BRACK ? from_ascii("[") : from_ascii("(");
674 docstring const ket = kind_ == BRACE ? from_ascii("}") :
675 kind_ == BRACK ? from_ascii("]") : from_ascii(")");
677 int m = x + dim.width() / 2;
680 (kind_ == DBINOM) ? pi.base.font.changeStyle(LM_ST_DISPLAY) :
681 (kind_ == TBINOM) ? pi.base.font.changeStyle(LM_ST_SCRIPT) :
682 pi.base.changeFrac();
683 // take dy both for the vertical alignment and for the spacing between
685 cell(0).draw(pi, m - dim0.wid / 2, y - dim0.des - dy/2 - dy);
686 cell(1).draw(pi, m - dim1.wid / 2, y + dim1.asc + dy/2 - dy);
688 // draw the brackets and the marker
689 mathed_draw_deco(pi, x, y - dim.ascent(), dw(dim.height()),
691 mathed_draw_deco(pi, x + dim.width() - dw(dim.height()),
692 y - dim.ascent(), dw(dim.height()), dim.height(), ket);
696 bool InsetMathBinom::extraBraces() const
698 return kind_ == CHOOSE || kind_ == BRACE || kind_ == BRACK;
702 void InsetMathBinom::write(WriteStream & os) const
704 MathEnsurer ensurer(os);
707 os << "\\binom{" << cell(0) << "}{" << cell(1) << '}';
710 os << "\\dbinom{" << cell(0) << "}{" << cell(1) << '}';
713 os << "\\tbinom{" << cell(0) << "}{" << cell(1) << '}';
716 os << '{' << cell(0) << " \\choose " << cell(1) << '}';
719 os << '{' << cell(0) << " \\brace " << cell(1) << '}';
722 os << '{' << cell(0) << " \\brack " << cell(1) << '}';
728 void InsetMathBinom::normalize(NormalStream & os) const
730 os << "[binom " << cell(0) << ' ' << cell(1) << ']';
734 void InsetMathBinom::mathmlize(MathStream & os) const
755 os << "<mo fence='true' stretchy='true' form='prefix'>" << ldelim << "</mo>"
756 << "<mfrac linethickness='0'>"
757 << cell(0) << cell(1)
759 << "<mo fence='true' stretchy='true' form='postfix'>" << rdelim << "</mo>";
763 void InsetMathBinom::htmlize(HtmlStream & os) const
784 os << MTag("span", "class='binomdelim'") << ldelim << ETag("span") << '\n'
785 << MTag("span", "class='binom'") << '\n'
786 << MTag("span") << cell(0) << ETag("span") << '\n'
787 << MTag("span") << cell(1) << ETag("span") << '\n'
788 << ETag("span") << '\n'
789 << MTag("span", "class='binomdelim'") << rdelim << ETag("span") << '\n';
793 void InsetMathBinom::validate(LaTeXFeatures & features) const
795 if (features.runparams().isLaTeX()) {
797 features.require("binom");
798 if (kind_ == DBINOM || kind_ == TBINOM)
799 features.require("amsmath");
800 } else if (features.runparams().math_flavor == OutputParams::MathAsHTML)
801 features.addCSSSnippet(
802 "span.binom{display: inline-block; vertical-align: bottom; text-align:center;}\n"
803 "span.binom span{display: block;}\n"
804 "span.binomdelim{font-size: 2em;}");
805 InsetMathNest::validate(features);