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"));
177 void InsetMathFrac::metrics(MetricsInfo & mi, Dimension & dim) const
179 Dimension dim0, dim1, dim2;
180 Changer dummy3 = mi.base.changeEnsureMath();
184 // \unitone, \unittwo
187 // is there an extra cell holding the value being given a dimension?
188 // (this is \unittwo)
190 cell(0).metrics(mi, dim1);
191 dim.wid += dim1.wid + 4;
194 Changer dummy = mi.base.font.changeShape(UP_SHAPE);
195 cell(unit_cell).metrics(mi, dim0);
196 dim.wid += dim0.width() + 1;
197 dim.asc = max(dim0.asc, dim1.asc);
198 dim.des = max(dim0.des, dim1.des);
204 // \unitfrac, \unitfracthree, \nicefrac
208 int const dy = dy_for_nicefrac(mi.base);
209 // is there an extra cell holding the value being given a dimension?
210 // (this is \unitfracthree)
211 if (kind_ == UNITFRAC && nargs() == 3) {
212 cell(2).metrics(mi, dim2);
213 dim.wid += dim2.wid + 4;
217 Changer dummy = (kind_ == UNITFRAC) ? mi.base.font.changeShape(UP_SHAPE)
219 Changer dummy2 = mi.base.changeScript();
220 if (latexkeys const * slash = slash_symbol()) {
222 mathedSymbolDim(mi.base, dimslash, slash);
223 dim.wid += dimslash.wid - mathed_mu(mi.base.font, 3.0);
224 dim.asc = max(dim.asc, dimslash.asc);
225 dim.des = max(dim.des, dimslash.des);
227 cell(0).metrics(mi, dim0);
228 cell(1).metrics(mi, dim1);
229 dim.wid += dim0.wid + dim1.wid + 2;
230 dim.asc = max(max(dim.asc, dim0.asc + dy), dim1.asc);
231 dim.des = max(max(dim.des, dim0.des - dy), dim1.des);
243 int const dy = axis_height(mi.base);
245 // \tfrac is always in text size
246 (kind_ == TFRAC) ? mi.base.font.changeStyle(LM_ST_SCRIPT) :
247 // \cfrac and \dfrac are always in display size
249 || kind_ == CFRACLEFT
250 || kind_ == CFRACRIGHT
251 || kind_ == DFRAC) ? mi.base.font.changeStyle(LM_ST_DISPLAY) :
253 mi.base.changeFrac();
254 Changer dummy2 = mi.base.changeEnsureMath();
255 cell(0).metrics(mi, dim0);
256 cell(1).metrics(mi, dim1);
257 dim.wid = max(dim0.wid, dim1.wid) + 2;
258 dim.asc = dim0.height() + dy/2 + dy;
259 int const t = mi.base.solidLineThickness();
260 dim.des = max(0, dim1.height() + dy/2 - dy + t);
266 void InsetMathFrac::draw(PainterInfo & pi, int x, int y) const
268 Changer dummy3 = pi.base.changeEnsureMath();
269 Dimension const dim = dimension(*pi.base.bv);
270 Dimension const dim0 = cell(0).dimension(*pi.base.bv);
273 // \unitone, \unittwo
276 // is there an extra cell holding the value being given a dimension?
277 // (this is \unittwo)
279 cell(0).draw(pi, x, y);
283 Changer dummy = pi.base.font.changeShape(UP_SHAPE);
284 cell(unit_cell).draw(pi, xx, y);
290 // \unitfrac, \unitfracthree, \nicefrac
292 int const dy = dy_for_nicefrac(pi.base);
293 // is there an extra cell holding the value being given a dimension?
294 // (this is \unitfracthree)
295 if (kind_ == UNITFRAC && nargs() == 3) {
296 cell(2).draw(pi, x, y);
297 xx += cell(2).dimension(*pi.base.bv).wid + 4;
299 Changer dummy = (kind_ == UNITFRAC) ? pi.base.font.changeShape(UP_SHAPE)
302 Changer dummy2 = pi.base.changeScript();
303 cell(0).draw(pi, xx + 1, y - dy);
304 // reference LaTeX code from nicefrac.sty:
305 // \mkern-2mu/\mkern-1mu
306 if (latexkeys const * slash = slash_symbol()) {
307 int mkern = mathed_mu(pi.base.font, 2.0);
308 mathedSymbolDraw(pi, xx + 1 + dim0.wid - mkern, y, slash);
310 mathedSymbolDim(pi.base, dimslash, slash);
311 xx += dimslash.wid - mathed_mu(pi.base.font, 3.0);
313 cell(1).draw(pi, xx + 1 + dim0.wid, y);
325 int const dy = axis_height(pi.base);
327 // \tfrac is always in text size
328 (kind_ == TFRAC) ? pi.base.font.changeStyle(LM_ST_SCRIPT) :
329 // \cfrac and \dfrac are always in display size
331 || kind_ == CFRACLEFT
332 || kind_ == CFRACRIGHT
333 || kind_ == DFRAC) ? pi.base.font.changeStyle(LM_ST_DISPLAY) :
335 pi.base.changeFrac();
336 Dimension const dim1 = cell(1).dimension(*pi.base.bv);
337 int const m = x + dim.wid / 2;
340 (kind_ == CFRACLEFT) ? x + 1 :
342 (kind_ == CFRACRIGHT) ? x + dim.wid - dim0.wid - 2 :
345 int const t = pi.base.solidLineThickness();
346 // take dy/2 for the spacing around the horizontal line. This is
347 // arbitrary. In LaTeX it is more complicated to ensure that displayed
348 // fractions line up next to each other.
349 // For more accurate implementation refer to the TeXbook, Appendix G,
351 cell(0).draw(pi, xx, y - dim0.des - dy/2 - dy);
353 cell(1).draw(pi, m - dim1.wid / 2, y + dim1.asc + dy/2 - dy + t);
356 pi.pain.line(x, y - dy, x + dim.wid, y - dy,
357 pi.base.font.color(), pi.pain.line_solid, t);
363 void InsetMathFrac::metricsT(TextMetricsInfo const & mi, Dimension & dim) const
365 Dimension dim0, dim1;
366 cell(0).metricsT(mi, dim0);
367 cell(1).metricsT(mi, dim1);
368 dim.wid = max(dim0.width(), dim1.wid);
369 dim.asc = dim0.height() + 1;
370 dim.des = dim1.height();
374 void InsetMathFrac::drawT(TextPainter & /*pain*/, int /*x*/, int /*y*/) const
379 int m = x + dim.width() / 2;
380 cell(0).drawT(pain, m - dim0.width() / 2, y - dim0.des - 1);
381 cell(1).drawT(pain, m - dim1.wid / 2, y + dim1.asc);
382 // ASCII art: ignore niceties
383 if (kind_ == FRAC || kind_ == OVER || kind_ == NICEFRAC || kind_ == UNITFRAC)
384 pain.horizontalLine(x, y, dim.width());
389 void InsetMathFrac::write(WriteStream & os) const
391 MathEnsurer ensurer(os);
394 // \\atop is only for compatibility, \\binom is the
396 os << '{' << cell(0) << "\\atop " << cell(1) << '}';
399 // \\over is only for compatibility, normalize this to \\frac
400 os << "\\frac{" << cell(0) << "}{" << cell(1) << '}';
409 InsetMathNest::write(os);
411 os << "\\unitfrac[" << cell(2) << "]{" << cell(0) << "}{" << cell(1) << '}';
415 os << "\\unit[" << cell(0) << "]{" << cell(1) << '}';
417 os << "\\unit{" << cell(0) << '}';
420 os << "\\cfrac[l]{" << cell(0) << "}{" << cell(1) << '}';
423 os << "\\cfrac[r]{" << cell(0) << "}{" << cell(1) << '}';
429 docstring InsetMathFrac::name() const
433 return from_ascii("frac");
437 return from_ascii("cfrac");
439 return from_ascii("dfrac");
441 return from_ascii("tfrac");
443 return from_ascii("over");
445 return from_ascii("nicefrac");
447 return from_ascii("unitfrac");
449 return from_ascii("unit");
451 return from_ascii("atop");
453 // shut up stupid compiler
458 bool InsetMathFrac::extraBraces() const
460 return kind_ == ATOP || kind_ == OVER;
464 void InsetMathFrac::maple(MapleStream & os) const
467 // Someone who knows about maple should fix this.
468 LASSERT(false, return);
470 os << '(' << cell(0) << ")/(" << cell(1) << ')';
474 void InsetMathFrac::mathematica(MathematicaStream & os) const
477 // Someone who knows about mathematica should fix this.
478 LASSERT(false, return);
480 os << '(' << cell(0) << ")/(" << cell(1) << ')';
484 void InsetMathFrac::octave(OctaveStream & os) const
487 // Someone who knows about octave should fix this.
488 LASSERT(false, return);
490 os << '(' << cell(0) << ")/(" << cell(1) << ')';
494 void InsetMathFrac::mathmlize(MathStream & os) const
498 os << MTag("mfrac", "linethickeness='0'")
499 << MTag("mrow") << cell(0) << ETag("mrow")
500 << MTag("mrow") << cell(1) << ETag("mrow")
504 // we do not presently distinguish these
513 << MTag("mrow") << cell(0) << ETag("mrow")
514 << MTag("mrow") << cell(1) << ETag("mrow")
519 os << MTag("mfrac", "bevelled='true'")
520 << MTag("mrow") << cell(0) << ETag("mrow")
521 << 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")
535 // FIXME This is not right, because we still output mi, etc,
536 // when we output the cell. So we need to prevent that somehow.
539 << MTag("mstyle mathvariant='normal'")
543 os << MTag("mstyle mathvariant='normal'")
550 void InsetMathFrac::htmlize(HtmlStream & os) const
554 os << MTag("span", "class='frac'")
555 << MTag("span", "class='numer'") << cell(0) << ETag("span")
556 << MTag("span", "class='numer'") << cell(1) << ETag("span")
560 // we do not presently distinguish these
568 os << MTag("span", "class='frac'")
569 << MTag("span", "class='numer'") << cell(0) << ETag("span")
570 << MTag("span", "class='denom'") << cell(1) << ETag("span")
575 os << cell(0) << '/' << cell(1);
580 os << cell(2) << ' ';
581 os << cell(0) << '/' << cell(1);
585 // FIXME This is not right, because we still output i, etc,
586 // when we output the cell. So we need to prevent that somehow.
600 void InsetMathFrac::validate(LaTeXFeatures & features) const
602 if (kind_ == NICEFRAC || kind_ == UNITFRAC || kind_ == UNIT)
603 features.require("units");
604 if (kind_ == CFRAC || kind_ == CFRACLEFT || kind_ == CFRACRIGHT
605 || kind_ == DFRAC || kind_ == TFRAC)
606 features.require("amsmath");
607 if (features.runparams().math_flavor == OutputParams::MathAsHTML)
608 // CSS adapted from eLyXer
609 features.addCSSSnippet(
610 "span.frac{display: inline-block; vertical-align: middle; text-align:center;}\n"
611 "span.numer{display: block;}\n"
612 "span.denom{display: block; border-top: thin solid #000040;}");
613 InsetMathNest::validate(features);
617 /////////////////////////////////////////////////////////////////////
621 /////////////////////////////////////////////////////////////////////
624 InsetMathBinom::InsetMathBinom(Buffer * buf, Kind kind)
625 : InsetMathFracBase(buf), kind_(kind)
629 Inset * InsetMathBinom::clone() const
631 return new InsetMathBinom(*this);
635 int InsetMathBinom::dw(int height) const
646 void InsetMathBinom::metrics(MetricsInfo & mi, Dimension & dim) const
648 Changer dummy2 = mi.base.changeEnsureMath();
649 Dimension dim0, dim1;
650 int const dy = axis_height(mi.base);
652 (kind_ == DBINOM) ? mi.base.font.changeStyle(LM_ST_DISPLAY) :
653 (kind_ == TBINOM) ? mi.base.font.changeStyle(LM_ST_SCRIPT) :
654 mi.base.changeFrac();
655 cell(0).metrics(mi, dim0);
656 cell(1).metrics(mi, dim1);
657 dim.asc = dim0.height() + 1 + dy/2 + dy;
658 dim.des = max(0, dim1.height() + 1 + dy/2 - dy);
659 dim.wid = max(dim0.wid, dim1.wid) + 2 * dw(dim.height()) + 4;
663 void InsetMathBinom::draw(PainterInfo & pi, int x, int y) const
665 Changer dummy2 = pi.base.changeEnsureMath();
666 Dimension const dim = dimension(*pi.base.bv);
667 Dimension const & dim0 = cell(0).dimension(*pi.base.bv);
668 Dimension const & dim1 = cell(1).dimension(*pi.base.bv);
669 int const dy = axis_height(pi.base);
670 // define the binom brackets
671 docstring const bra = kind_ == BRACE ? from_ascii("{") :
672 kind_ == BRACK ? from_ascii("[") : from_ascii("(");
673 docstring const ket = kind_ == BRACE ? from_ascii("}") :
674 kind_ == BRACK ? from_ascii("]") : from_ascii(")");
676 int m = x + dim.width() / 2;
679 (kind_ == DBINOM) ? pi.base.font.changeStyle(LM_ST_DISPLAY) :
680 (kind_ == TBINOM) ? pi.base.font.changeStyle(LM_ST_SCRIPT) :
681 pi.base.changeFrac();
682 // take dy both for the vertical alignment and for the spacing between
684 cell(0).draw(pi, m - dim0.wid / 2, y - dim0.des - dy/2 - dy);
685 cell(1).draw(pi, m - dim1.wid / 2, y + dim1.asc + dy/2 - dy);
687 // draw the brackets and the marker
688 mathed_draw_deco(pi, x, y - dim.ascent(), dw(dim.height()),
690 mathed_draw_deco(pi, x + dim.width() - dw(dim.height()),
691 y - dim.ascent(), dw(dim.height()), dim.height(), ket);
695 bool InsetMathBinom::extraBraces() const
697 return kind_ == CHOOSE || kind_ == BRACE || kind_ == BRACK;
701 void InsetMathBinom::write(WriteStream & os) const
703 MathEnsurer ensurer(os);
706 os << "\\binom{" << cell(0) << "}{" << cell(1) << '}';
709 os << "\\dbinom{" << cell(0) << "}{" << cell(1) << '}';
712 os << "\\tbinom{" << cell(0) << "}{" << cell(1) << '}';
715 os << '{' << cell(0) << " \\choose " << cell(1) << '}';
718 os << '{' << cell(0) << " \\brace " << cell(1) << '}';
721 os << '{' << cell(0) << " \\brack " << cell(1) << '}';
727 void InsetMathBinom::normalize(NormalStream & os) const
729 os << "[binom " << cell(0) << ' ' << cell(1) << ']';
733 void InsetMathBinom::mathmlize(MathStream & os) const
754 os << "<mo fence='true' stretchy='true' form='prefix'>" << ldelim << "</mo>"
755 << "<mfrac linethickness='0'>"
756 << cell(0) << cell(1)
758 << "<mo fence='true' stretchy='true' form='postfix'>" << rdelim << "</mo>";
762 void InsetMathBinom::htmlize(HtmlStream & os) const
783 os << MTag("span", "class='binomdelim'") << ldelim << ETag("span") << '\n'
784 << MTag("span", "class='binom'") << '\n'
785 << MTag("span") << cell(0) << ETag("span") << '\n'
786 << MTag("span") << cell(1) << ETag("span") << '\n'
787 << ETag("span") << '\n'
788 << MTag("span", "class='binomdelim'") << rdelim << ETag("span") << '\n';
792 void InsetMathBinom::validate(LaTeXFeatures & features) const
794 if (features.runparams().isLaTeX()) {
796 features.require("binom");
797 if (kind_ == DBINOM || kind_ == TBINOM)
798 features.require("amsmath");
799 } else if (features.runparams().math_flavor == OutputParams::MathAsHTML)
800 features.addCSSSnippet(
801 "span.binom{display: inline-block; vertical-align: bottom; text-align:center;}\n"
802 "span.binom span{display: block;}\n"
803 "span.binomdelim{font-size: 2em;}");
804 InsetMathNest::validate(features);