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;
192 // \unitone, \unittwo
195 // is there an extra cell holding the value being given a dimension?
196 // (this is \unittwo)
198 cell(0).metrics(mi, dim1);
199 dim.wid += dim1.wid + 4;
202 Changer dummy = mi.base.font.changeShape(UP_SHAPE);
203 cell(unit_cell).metrics(mi, dim0);
204 dim.wid += dim0.width() + 1;
205 dim.asc = max(dim0.asc, dim1.asc);
206 dim.des = max(dim0.des, dim1.des);
212 // \unitfrac, \unitfracthree, \nicefrac
216 int const dy = dy_for_nicefrac(mi.base);
217 // is there an extra cell holding the value being given a dimension?
218 // (this is \unitfracthree)
219 if (kind_ == UNITFRAC && nargs() == 3) {
220 cell(2).metrics(mi, dim2);
221 dim.wid += dim2.wid + 4;
225 Changer dummy = (kind_ == UNITFRAC) ? mi.base.font.changeShape(UP_SHAPE)
227 Changer dummy2 = mi.base.changeScript();
228 if (latexkeys const * slash = slash_symbol()) {
230 mathedSymbolDim(mi.base, dimslash, slash);
231 dim.wid += dimslash.wid - mathed_mu(mi.base.font, 3.0);
232 dim.asc = max(dim.asc, dimslash.asc);
233 dim.des = max(dim.des, dimslash.des);
235 cell(0).metrics(mi, dim0);
236 cell(1).metrics(mi, dim1);
237 dim.wid += dim0.wid + dim1.wid + 2;
238 dim.asc = max(max(dim.asc, dim0.asc + dy), dim1.asc);
239 dim.des = max(max(dim.des, dim0.des - dy), dim1.des);
251 int const dy = dy_for_frac(mi.base);
253 // \tfrac is always in text size
254 (kind_ == TFRAC) ? mi.base.font.changeStyle(LM_ST_SCRIPT) :
255 // \cfrac and \dfrac are always in display size
257 || kind_ == CFRACLEFT
258 || kind_ == CFRACRIGHT
259 || kind_ == DFRAC) ? mi.base.font.changeStyle(LM_ST_DISPLAY) :
261 mi.base.changeFrac();
262 cell(0).metrics(mi, dim0);
263 cell(1).metrics(mi, dim1);
264 dim.wid = max(dim0.wid, dim1.wid) + 2;
265 dim.asc = dim0.height() + dy/2 + dy;
266 int const t = mi.base.solidLineThickness();
267 dim.des = max(0, dim1.height() + dy/2 - dy + t);
270 metricsMarkers(mi, dim);
274 void InsetMathFrac::draw(PainterInfo & pi, int x, int y) const
276 setPosCache(pi, x, y);
277 Dimension const dim = dimension(*pi.base.bv);
278 Dimension const dim0 = cell(0).dimension(*pi.base.bv);
281 // \unitone, \unittwo
284 // is there an extra cell holding the value being given a dimension?
285 // (this is \unittwo)
287 cell(0).draw(pi, x + 1, y);
291 Changer dummy = pi.base.font.changeShape(UP_SHAPE);
292 cell(unit_cell).draw(pi, xx + 1, y);
298 // \unitfrac, \unitfracthree, \nicefrac
300 int const dy = dy_for_nicefrac(pi.base);
301 // is there an extra cell holding the value being given a dimension?
302 // (this is \unitfracthree)
303 if (kind_ == UNITFRAC && nargs() == 3) {
304 cell(2).draw(pi, x + 1, y);
305 xx += cell(2).dimension(*pi.base.bv).wid + 4;
307 Changer dummy = (kind_ == UNITFRAC) ? pi.base.font.changeShape(UP_SHAPE)
310 Changer dummy2 = pi.base.changeScript();
311 cell(0).draw(pi, xx + 2, y - dy);
312 // reference LaTeX code from nicefrac.sty:
313 // \mkern-2mu/\mkern-1mu
314 if (latexkeys const * slash = slash_symbol()) {
315 int mkern = mathed_mu(pi.base.font, 2.0);
316 mathedSymbolDraw(pi, xx + 2 + dim0.wid - mkern, y, slash);
318 mathedSymbolDim(pi.base, dimslash, slash);
319 xx += dimslash.wid - mathed_mu(pi.base.font, 3.0);
321 cell(1).draw(pi, xx + 2 + dim0.wid, y);
333 int const dy = dy_for_frac(pi.base);
335 // \tfrac is always in text size
336 (kind_ == TFRAC) ? pi.base.font.changeStyle(LM_ST_SCRIPT) :
337 // \cfrac and \dfrac are always in display size
339 || kind_ == CFRACLEFT
340 || kind_ == CFRACRIGHT
341 || kind_ == DFRAC) ? pi.base.font.changeStyle(LM_ST_DISPLAY) :
343 pi.base.changeFrac();
344 Dimension const dim1 = cell(1).dimension(*pi.base.bv);
345 int const m = x + dim.wid / 2;
348 (kind_ == CFRACLEFT) ? x + 2 :
350 (kind_ == CFRACRIGHT) ? x + dim.wid - dim0.wid - 2 :
353 int const t = pi.base.solidLineThickness();
354 // take dy/2 for the spacing around the horizontal line. This is
355 // arbitrary. In LaTeX it is more complicated to ensure that displayed
356 // fractions line up next to each other.
357 // For more accurate implementation refer to the TeXbook, Appendix G,
359 cell(0).draw(pi, xx, y - dim0.des - dy/2 - dy);
361 cell(1).draw(pi, m - dim1.wid / 2, y + dim1.asc + dy/2 - dy + t);
364 pi.pain.line(x + 1, y - dy, x + dim.wid - 2, y - dy,
365 pi.base.font.color(), pi.pain.line_solid, t);
368 drawMarkers(pi, x, y);
372 void InsetMathFrac::metricsT(TextMetricsInfo const & mi, Dimension & dim) const
374 Dimension dim0, dim1;
375 cell(0).metricsT(mi, dim0);
376 cell(1).metricsT(mi, dim1);
377 dim.wid = max(dim0.width(), dim1.wid);
378 dim.asc = dim0.height() + 1;
379 dim.des = dim1.height();
383 void InsetMathFrac::drawT(TextPainter & /*pain*/, int /*x*/, int /*y*/) const
388 int m = x + dim.width() / 2;
389 cell(0).drawT(pain, m - dim0.width() / 2, y - dim0.des - 1);
390 cell(1).drawT(pain, m - dim1.wid / 2, y + dim1.asc);
391 // ASCII art: ignore niceties
392 if (kind_ == FRAC || kind_ == OVER || kind_ == NICEFRAC || kind_ == UNITFRAC)
393 pain.horizontalLine(x, y, dim.width());
398 void InsetMathFrac::write(WriteStream & os) const
400 MathEnsurer ensurer(os);
403 // \\atop is only for compatibility, \\binom is the
405 os << '{' << cell(0) << "\\atop " << cell(1) << '}';
408 // \\over is only for compatibility, normalize this to \\frac
409 os << "\\frac{" << cell(0) << "}{" << cell(1) << '}';
418 InsetMathNest::write(os);
420 os << "\\unitfrac[" << cell(2) << "]{" << cell(0) << "}{" << cell(1) << '}';
424 os << "\\unit[" << cell(0) << "]{" << cell(1) << '}';
426 os << "\\unit{" << cell(0) << '}';
429 os << "\\cfrac[l]{" << cell(0) << "}{" << cell(1) << '}';
432 os << "\\cfrac[r]{" << cell(0) << "}{" << cell(1) << '}';
438 docstring InsetMathFrac::name() const
442 return from_ascii("frac");
446 return from_ascii("cfrac");
448 return from_ascii("dfrac");
450 return from_ascii("tfrac");
452 return from_ascii("over");
454 return from_ascii("nicefrac");
456 return from_ascii("unitfrac");
458 return from_ascii("unit");
460 return from_ascii("atop");
462 // shut up stupid compiler
467 bool InsetMathFrac::extraBraces() const
469 return kind_ == ATOP || kind_ == OVER;
473 void InsetMathFrac::maple(MapleStream & os) const
476 // Someone who knows about maple should fix this.
477 LASSERT(false, return);
479 os << '(' << cell(0) << ")/(" << cell(1) << ')';
483 void InsetMathFrac::mathematica(MathematicaStream & os) const
486 // Someone who knows about mathematica should fix this.
487 LASSERT(false, return);
489 os << '(' << cell(0) << ")/(" << cell(1) << ')';
493 void InsetMathFrac::octave(OctaveStream & os) const
496 // Someone who knows about octave should fix this.
497 LASSERT(false, return);
499 os << '(' << cell(0) << ")/(" << cell(1) << ')';
503 void InsetMathFrac::mathmlize(MathStream & os) const
507 os << MTag("mfrac", "linethickeness='0'")
508 << MTag("mrow") << cell(0) << ETag("mrow")
509 << MTag("mrow") << cell(1) << ETag("mrow")
513 // we do not presently distinguish these
522 << MTag("mrow") << cell(0) << ETag("mrow")
523 << MTag("mrow") << cell(1) << ETag("mrow")
528 os << MTag("mfrac", "bevelled='true'")
529 << MTag("mrow") << cell(0) << ETag("mrow")
530 << MTag("mrow") << cell(1) << ETag("mrow")
537 os << MTag("mfrac", "bevelled='true'")
538 << MTag("mrow") << cell(0) << ETag("mrow")
539 << MTag("mrow") << cell(1) << ETag("mrow")
544 // FIXME This is not right, because we still output mi, etc,
545 // when we output the cell. So we need to prevent that somehow.
548 << MTag("mstyle mathvariant='normal'")
552 os << MTag("mstyle mathvariant='normal'")
559 void InsetMathFrac::htmlize(HtmlStream & os) const
563 os << MTag("span", "class='frac'")
564 << MTag("span", "class='numer'") << cell(0) << ETag("span")
565 << MTag("span", "class='numer'") << cell(1) << ETag("span")
569 // we do not presently distinguish these
577 os << MTag("span", "class='frac'")
578 << MTag("span", "class='numer'") << cell(0) << ETag("span")
579 << MTag("span", "class='denom'") << cell(1) << ETag("span")
584 os << cell(0) << '/' << cell(1);
589 os << cell(2) << ' ';
590 os << cell(0) << '/' << cell(1);
594 // FIXME This is not right, because we still output i, etc,
595 // when we output the cell. So we need to prevent that somehow.
609 void InsetMathFrac::validate(LaTeXFeatures & features) const
611 if (kind_ == NICEFRAC || kind_ == UNITFRAC || kind_ == UNIT)
612 features.require("units");
613 if (kind_ == CFRAC || kind_ == CFRACLEFT || kind_ == CFRACRIGHT
614 || kind_ == DFRAC || kind_ == TFRAC)
615 features.require("amsmath");
616 if (features.runparams().math_flavor == OutputParams::MathAsHTML)
617 // CSS adapted from eLyXer
618 features.addCSSSnippet(
619 "span.frac{display: inline-block; vertical-align: middle; text-align:center;}\n"
620 "span.numer{display: block;}\n"
621 "span.denom{display: block; border-top: thin solid #000040;}");
622 InsetMathNest::validate(features);
626 /////////////////////////////////////////////////////////////////////
630 /////////////////////////////////////////////////////////////////////
633 InsetMathBinom::InsetMathBinom(Buffer * buf, Kind kind)
634 : InsetMathFracBase(buf), kind_(kind)
638 Inset * InsetMathBinom::clone() const
640 return new InsetMathBinom(*this);
644 int InsetMathBinom::dw(int height) const
655 void InsetMathBinom::metrics(MetricsInfo & mi, Dimension & dim) const
657 Dimension dim0, dim1;
658 int const dy = dy_for_frac(mi.base);
660 (kind_ == DBINOM) ? mi.base.font.changeStyle(LM_ST_DISPLAY) :
661 (kind_ == TBINOM) ? mi.base.font.changeStyle(LM_ST_SCRIPT) :
662 mi.base.changeFrac();
663 cell(0).metrics(mi, dim0);
664 cell(1).metrics(mi, dim1);
665 dim.asc = dim0.height() + 1 + dy/2 + dy;
666 dim.des = max(0, dim1.height() + 1 + dy/2 - dy);
667 dim.wid = max(dim0.wid, dim1.wid) + 2 * dw(dim.height()) + 4;
668 metricsMarkers2(mi, dim);
672 void InsetMathBinom::draw(PainterInfo & pi, int x, int y) const
674 Dimension const dim = dimension(*pi.base.bv);
675 Dimension const & dim0 = cell(0).dimension(*pi.base.bv);
676 Dimension const & dim1 = cell(1).dimension(*pi.base.bv);
677 int const dy = dy_for_frac(pi.base);
678 // define the binom brackets
679 docstring const bra = kind_ == BRACE ? from_ascii("{") :
680 kind_ == BRACK ? from_ascii("[") : from_ascii("(");
681 docstring const ket = kind_ == BRACE ? from_ascii("}") :
682 kind_ == BRACK ? from_ascii("]") : from_ascii(")");
684 int m = x + dim.width() / 2;
687 (kind_ == DBINOM) ? pi.base.font.changeStyle(LM_ST_DISPLAY) :
688 (kind_ == TBINOM) ? pi.base.font.changeStyle(LM_ST_SCRIPT) :
689 pi.base.changeFrac();
690 // take dy both for the vertical alignment and for the spacing between
692 cell(0).draw(pi, m - dim0.wid / 2, y - dim0.des - dy/2 - dy);
693 cell(1).draw(pi, m - dim1.wid / 2, y + dim1.asc + dy/2 - dy);
695 // draw the brackets and the marker
696 mathed_draw_deco(pi, x, y - dim.ascent(), dw(dim.height()),
698 mathed_draw_deco(pi, x + dim.width() - dw(dim.height()),
699 y - dim.ascent(), dw(dim.height()), dim.height(), ket);
700 drawMarkers2(pi, x, y);
704 bool InsetMathBinom::extraBraces() const
706 return kind_ == CHOOSE || kind_ == BRACE || kind_ == BRACK;
710 void InsetMathBinom::write(WriteStream & os) const
712 MathEnsurer ensurer(os);
715 os << "\\binom{" << cell(0) << "}{" << cell(1) << '}';
718 os << "\\dbinom{" << cell(0) << "}{" << cell(1) << '}';
721 os << "\\tbinom{" << cell(0) << "}{" << cell(1) << '}';
724 os << '{' << cell(0) << " \\choose " << cell(1) << '}';
727 os << '{' << cell(0) << " \\brace " << cell(1) << '}';
730 os << '{' << cell(0) << " \\brack " << cell(1) << '}';
736 void InsetMathBinom::normalize(NormalStream & os) const
738 os << "[binom " << cell(0) << ' ' << cell(1) << ']';
742 void InsetMathBinom::mathmlize(MathStream & os) const
763 os << "<mo fence='true' stretchy='true' form='prefix'>" << ldelim << "</mo>"
764 << "<mfrac linethickness='0'>"
765 << cell(0) << cell(1)
767 << "<mo fence='true' stretchy='true' form='postfix'>" << rdelim << "</mo>";
771 void InsetMathBinom::htmlize(HtmlStream & os) const
792 os << MTag("span", "class='binomdelim'") << ldelim << ETag("span") << '\n'
793 << MTag("span", "class='binom'") << '\n'
794 << MTag("span") << cell(0) << ETag("span") << '\n'
795 << MTag("span") << cell(1) << ETag("span") << '\n'
796 << ETag("span") << '\n'
797 << MTag("span", "class='binomdelim'") << rdelim << ETag("span") << '\n';
801 void InsetMathBinom::validate(LaTeXFeatures & features) const
803 if (features.runparams().isLaTeX()) {
805 features.require("binom");
806 if (kind_ == DBINOM || kind_ == TBINOM)
807 features.require("amsmath");
808 } else if (features.runparams().math_flavor == OutputParams::MathAsHTML)
809 features.addCSSSnippet(
810 "span.binom{display: inline-block; vertical-align: bottom; text-align:center;}\n"
811 "span.binom span{display: block;}\n"
812 "span.binomdelim{font-size: 2em;}");
813 InsetMathNest::validate(features);