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);
264 metricsMarkers(mi, dim);
268 void InsetMathFrac::draw(PainterInfo & pi, int x, int y) const
270 Changer dummy3 = pi.base.changeEnsureMath();
271 Dimension const dim = dimension(*pi.base.bv);
272 Dimension const dim0 = cell(0).dimension(*pi.base.bv);
275 // \unitone, \unittwo
278 // is there an extra cell holding the value being given a dimension?
279 // (this is \unittwo)
281 cell(0).draw(pi, x + 1, y);
285 Changer dummy = pi.base.font.changeShape(UP_SHAPE);
286 cell(unit_cell).draw(pi, xx + 1, y);
292 // \unitfrac, \unitfracthree, \nicefrac
294 int const dy = dy_for_nicefrac(pi.base);
295 // is there an extra cell holding the value being given a dimension?
296 // (this is \unitfracthree)
297 if (kind_ == UNITFRAC && nargs() == 3) {
298 cell(2).draw(pi, x + 1, y);
299 xx += cell(2).dimension(*pi.base.bv).wid + 4;
301 Changer dummy = (kind_ == UNITFRAC) ? pi.base.font.changeShape(UP_SHAPE)
304 Changer dummy2 = pi.base.changeScript();
305 cell(0).draw(pi, xx + 2, y - dy);
306 // reference LaTeX code from nicefrac.sty:
307 // \mkern-2mu/\mkern-1mu
308 if (latexkeys const * slash = slash_symbol()) {
309 int mkern = mathed_mu(pi.base.font, 2.0);
310 mathedSymbolDraw(pi, xx + 2 + dim0.wid - mkern, y, slash);
312 mathedSymbolDim(pi.base, dimslash, slash);
313 xx += dimslash.wid - mathed_mu(pi.base.font, 3.0);
315 cell(1).draw(pi, xx + 2 + dim0.wid, y);
327 int const dy = axis_height(pi.base);
329 // \tfrac is always in text size
330 (kind_ == TFRAC) ? pi.base.font.changeStyle(LM_ST_SCRIPT) :
331 // \cfrac and \dfrac are always in display size
333 || kind_ == CFRACLEFT
334 || kind_ == CFRACRIGHT
335 || kind_ == DFRAC) ? pi.base.font.changeStyle(LM_ST_DISPLAY) :
337 pi.base.changeFrac();
338 Dimension const dim1 = cell(1).dimension(*pi.base.bv);
339 int const m = x + dim.wid / 2;
342 (kind_ == CFRACLEFT) ? x + 2 :
344 (kind_ == CFRACRIGHT) ? x + dim.wid - dim0.wid - 2 :
347 int const t = pi.base.solidLineThickness();
348 // take dy/2 for the spacing around the horizontal line. This is
349 // arbitrary. In LaTeX it is more complicated to ensure that displayed
350 // fractions line up next to each other.
351 // For more accurate implementation refer to the TeXbook, Appendix G,
353 cell(0).draw(pi, xx, y - dim0.des - dy/2 - dy);
355 cell(1).draw(pi, m - dim1.wid / 2, y + dim1.asc + dy/2 - dy + t);
358 pi.pain.line(x + 1, y - dy, x + dim.wid - 2, y - dy,
359 pi.base.font.color(), pi.pain.line_solid, t);
362 drawMarkers(pi, x, y);
366 void InsetMathFrac::metricsT(TextMetricsInfo const & mi, Dimension & dim) const
368 Dimension dim0, dim1;
369 cell(0).metricsT(mi, dim0);
370 cell(1).metricsT(mi, dim1);
371 dim.wid = max(dim0.width(), dim1.wid);
372 dim.asc = dim0.height() + 1;
373 dim.des = dim1.height();
377 void InsetMathFrac::drawT(TextPainter & /*pain*/, int /*x*/, int /*y*/) const
382 int m = x + dim.width() / 2;
383 cell(0).drawT(pain, m - dim0.width() / 2, y - dim0.des - 1);
384 cell(1).drawT(pain, m - dim1.wid / 2, y + dim1.asc);
385 // ASCII art: ignore niceties
386 if (kind_ == FRAC || kind_ == OVER || kind_ == NICEFRAC || kind_ == UNITFRAC)
387 pain.horizontalLine(x, y, dim.width());
392 void InsetMathFrac::write(WriteStream & os) const
394 MathEnsurer ensurer(os);
397 // \\atop is only for compatibility, \\binom is the
399 os << '{' << cell(0) << "\\atop " << cell(1) << '}';
402 // \\over is only for compatibility, normalize this to \\frac
403 os << "\\frac{" << cell(0) << "}{" << cell(1) << '}';
412 InsetMathNest::write(os);
414 os << "\\unitfrac[" << cell(2) << "]{" << cell(0) << "}{" << cell(1) << '}';
418 os << "\\unit[" << cell(0) << "]{" << cell(1) << '}';
420 os << "\\unit{" << cell(0) << '}';
423 os << "\\cfrac[l]{" << cell(0) << "}{" << cell(1) << '}';
426 os << "\\cfrac[r]{" << cell(0) << "}{" << cell(1) << '}';
432 docstring InsetMathFrac::name() const
436 return from_ascii("frac");
440 return from_ascii("cfrac");
442 return from_ascii("dfrac");
444 return from_ascii("tfrac");
446 return from_ascii("over");
448 return from_ascii("nicefrac");
450 return from_ascii("unitfrac");
452 return from_ascii("unit");
454 return from_ascii("atop");
456 // shut up stupid compiler
461 bool InsetMathFrac::extraBraces() const
463 return kind_ == ATOP || kind_ == OVER;
467 void InsetMathFrac::maple(MapleStream & os) const
470 // Someone who knows about maple should fix this.
471 LASSERT(false, return);
473 os << '(' << cell(0) << ")/(" << cell(1) << ')';
477 void InsetMathFrac::mathematica(MathematicaStream & os) const
480 // Someone who knows about mathematica should fix this.
481 LASSERT(false, return);
483 os << '(' << cell(0) << ")/(" << cell(1) << ')';
487 void InsetMathFrac::octave(OctaveStream & os) const
490 // Someone who knows about octave should fix this.
491 LASSERT(false, return);
493 os << '(' << cell(0) << ")/(" << cell(1) << ')';
497 void InsetMathFrac::mathmlize(MathStream & os) const
501 os << MTag("mfrac", "linethickeness='0'")
502 << MTag("mrow") << cell(0) << ETag("mrow")
503 << MTag("mrow") << cell(1) << ETag("mrow")
507 // we do not presently distinguish these
516 << MTag("mrow") << cell(0) << ETag("mrow")
517 << MTag("mrow") << cell(1) << ETag("mrow")
522 os << MTag("mfrac", "bevelled='true'")
523 << MTag("mrow") << cell(0) << ETag("mrow")
524 << MTag("mrow") << cell(1) << ETag("mrow")
531 os << MTag("mfrac", "bevelled='true'")
532 << MTag("mrow") << cell(0) << ETag("mrow")
533 << MTag("mrow") << cell(1) << ETag("mrow")
538 // FIXME This is not right, because we still output mi, etc,
539 // when we output the cell. So we need to prevent that somehow.
542 << MTag("mstyle mathvariant='normal'")
546 os << MTag("mstyle mathvariant='normal'")
553 void InsetMathFrac::htmlize(HtmlStream & os) const
557 os << MTag("span", "class='frac'")
558 << MTag("span", "class='numer'") << cell(0) << ETag("span")
559 << MTag("span", "class='numer'") << cell(1) << ETag("span")
563 // we do not presently distinguish these
571 os << MTag("span", "class='frac'")
572 << MTag("span", "class='numer'") << cell(0) << ETag("span")
573 << MTag("span", "class='denom'") << cell(1) << ETag("span")
578 os << cell(0) << '/' << cell(1);
583 os << cell(2) << ' ';
584 os << cell(0) << '/' << cell(1);
588 // FIXME This is not right, because we still output i, etc,
589 // when we output the cell. So we need to prevent that somehow.
603 void InsetMathFrac::validate(LaTeXFeatures & features) const
605 if (kind_ == NICEFRAC || kind_ == UNITFRAC || kind_ == UNIT)
606 features.require("units");
607 if (kind_ == CFRAC || kind_ == CFRACLEFT || kind_ == CFRACRIGHT
608 || kind_ == DFRAC || kind_ == TFRAC)
609 features.require("amsmath");
610 if (features.runparams().math_flavor == OutputParams::MathAsHTML)
611 // CSS adapted from eLyXer
612 features.addCSSSnippet(
613 "span.frac{display: inline-block; vertical-align: middle; text-align:center;}\n"
614 "span.numer{display: block;}\n"
615 "span.denom{display: block; border-top: thin solid #000040;}");
616 InsetMathNest::validate(features);
620 /////////////////////////////////////////////////////////////////////
624 /////////////////////////////////////////////////////////////////////
627 InsetMathBinom::InsetMathBinom(Buffer * buf, Kind kind)
628 : InsetMathFracBase(buf), kind_(kind)
632 Inset * InsetMathBinom::clone() const
634 return new InsetMathBinom(*this);
638 int InsetMathBinom::dw(int height) const
649 void InsetMathBinom::metrics(MetricsInfo & mi, Dimension & dim) const
651 Changer dummy2 = mi.base.changeEnsureMath();
652 Dimension dim0, dim1;
653 int const dy = axis_height(mi.base);
655 (kind_ == DBINOM) ? mi.base.font.changeStyle(LM_ST_DISPLAY) :
656 (kind_ == TBINOM) ? mi.base.font.changeStyle(LM_ST_SCRIPT) :
657 mi.base.changeFrac();
658 cell(0).metrics(mi, dim0);
659 cell(1).metrics(mi, dim1);
660 dim.asc = dim0.height() + 1 + dy/2 + dy;
661 dim.des = max(0, dim1.height() + 1 + dy/2 - dy);
662 dim.wid = max(dim0.wid, dim1.wid) + 2 * dw(dim.height()) + 4;
663 metricsMarkers2(mi, dim);
667 void InsetMathBinom::draw(PainterInfo & pi, int x, int y) const
669 Changer dummy2 = pi.base.changeEnsureMath();
670 Dimension const dim = dimension(*pi.base.bv);
671 Dimension const & dim0 = cell(0).dimension(*pi.base.bv);
672 Dimension const & dim1 = cell(1).dimension(*pi.base.bv);
673 int const dy = axis_height(pi.base);
674 // define the binom brackets
675 docstring const bra = kind_ == BRACE ? from_ascii("{") :
676 kind_ == BRACK ? from_ascii("[") : from_ascii("(");
677 docstring const ket = kind_ == BRACE ? from_ascii("}") :
678 kind_ == BRACK ? from_ascii("]") : from_ascii(")");
680 int m = x + dim.width() / 2;
683 (kind_ == DBINOM) ? pi.base.font.changeStyle(LM_ST_DISPLAY) :
684 (kind_ == TBINOM) ? pi.base.font.changeStyle(LM_ST_SCRIPT) :
685 pi.base.changeFrac();
686 // take dy both for the vertical alignment and for the spacing between
688 cell(0).draw(pi, m - dim0.wid / 2, y - dim0.des - dy/2 - dy);
689 cell(1).draw(pi, m - dim1.wid / 2, y + dim1.asc + dy/2 - dy);
691 // draw the brackets and the marker
692 mathed_draw_deco(pi, x, y - dim.ascent(), dw(dim.height()),
694 mathed_draw_deco(pi, x + dim.width() - dw(dim.height()),
695 y - dim.ascent(), dw(dim.height()), dim.height(), ket);
696 drawMarkers2(pi, x, y);
700 bool InsetMathBinom::extraBraces() const
702 return kind_ == CHOOSE || kind_ == BRACE || kind_ == BRACK;
706 void InsetMathBinom::write(WriteStream & os) const
708 MathEnsurer ensurer(os);
711 os << "\\binom{" << cell(0) << "}{" << cell(1) << '}';
714 os << "\\dbinom{" << cell(0) << "}{" << cell(1) << '}';
717 os << "\\tbinom{" << cell(0) << "}{" << cell(1) << '}';
720 os << '{' << cell(0) << " \\choose " << cell(1) << '}';
723 os << '{' << cell(0) << " \\brace " << cell(1) << '}';
726 os << '{' << cell(0) << " \\brack " << cell(1) << '}';
732 void InsetMathBinom::normalize(NormalStream & os) const
734 os << "[binom " << cell(0) << ' ' << cell(1) << ']';
738 void InsetMathBinom::mathmlize(MathStream & os) const
759 os << "<mo fence='true' stretchy='true' form='prefix'>" << ldelim << "</mo>"
760 << "<mfrac linethickness='0'>"
761 << cell(0) << cell(1)
763 << "<mo fence='true' stretchy='true' form='postfix'>" << rdelim << "</mo>";
767 void InsetMathBinom::htmlize(HtmlStream & os) const
788 os << MTag("span", "class='binomdelim'") << ldelim << ETag("span") << '\n'
789 << MTag("span", "class='binom'") << '\n'
790 << MTag("span") << cell(0) << ETag("span") << '\n'
791 << MTag("span") << cell(1) << ETag("span") << '\n'
792 << ETag("span") << '\n'
793 << MTag("span", "class='binomdelim'") << rdelim << ETag("span") << '\n';
797 void InsetMathBinom::validate(LaTeXFeatures & features) const
799 if (features.runparams().isLaTeX()) {
801 features.require("binom");
802 if (kind_ == DBINOM || kind_ == TBINOM)
803 features.require("amsmath");
804 } else if (features.runparams().math_flavor == OutputParams::MathAsHTML)
805 features.addCSSSnippet(
806 "span.binom{display: inline-block; vertical-align: bottom; text-align:center;}\n"
807 "span.binom span{display: block;}\n"
808 "span.binomdelim{font-size: 2em;}");
809 InsetMathNest::validate(features);