2 * \file InsetMathScript.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
8 * Full author contact details are available in file CREDITS.
13 #include "InsetMathScript.h"
15 #include "InsetMathBrace.h"
16 #include "InsetMathSymbol.h"
18 #include "MathStream.h"
19 #include "MathSupport.h"
21 #include "BufferView.h"
23 #include "DispatchResult.h"
24 #include "FuncRequest.h"
25 #include "FuncStatus.h"
26 #include "LaTeXFeatures.h"
27 #include "MetricsInfo.h"
29 #include "support/debug.h"
30 #include "support/gettext.h"
31 #include "support/lassert.h"
39 InsetMathScript::InsetMathScript(Buffer * buf)
40 : InsetMathNest(buf, 1), cell_1_is_up_(false), limits_(0)
44 InsetMathScript::InsetMathScript(Buffer * buf, bool up)
45 : InsetMathNest(buf, 2), cell_1_is_up_(up), limits_(0)
49 InsetMathScript::InsetMathScript(Buffer * buf, MathAtom const & at, bool up)
50 : InsetMathNest(buf, 2), cell_1_is_up_(up), limits_(0)
52 LATTEST(nargs() >= 1);
53 cell(0).push_back(at);
57 Inset * InsetMathScript::clone() const
59 return new InsetMathScript(*this);
63 InsetMathScript const * InsetMathScript::asScriptInset() const
69 InsetMathScript * InsetMathScript::asScriptInset()
75 bool InsetMathScript::idxFirst(Cursor & cur) const
83 bool InsetMathScript::idxLast(Cursor & cur) const
86 cur.pos() = nuc().size();
91 MathData const & InsetMathScript::down() const
100 MathData & InsetMathScript::down()
104 LBUFERR(nargs() > 1);
109 MathData const & InsetMathScript::up() const
111 LBUFERR(nargs() > 1);
116 MathData & InsetMathScript::up()
118 LBUFERR(nargs() > 1);
123 void InsetMathScript::ensure(bool up)
126 // just nucleus so far
127 cells_.push_back(MathData());
129 } else if (nargs() == 2 && !has(up)) {
131 cells_.push_back(cell(1));
134 cells_.push_back(MathData());
140 MathData const & InsetMathScript::nuc() const
146 MathData & InsetMathScript::nuc()
152 int InsetMathScript::dy01(BufferView const & bv, int asc, int des, int what) const
156 bool isCharBox = !nuc().empty() ? isAlphaSymbol(nuc().back()) : false;
158 Dimension const & dimdown = down().dimension(bv);
159 dasc = dimdown.ascent();
160 slevel = nuc().slevel();
161 int ascdrop = dasc - slevel;
162 int desdrop = isCharBox ? 0 : des + nuc().sshift();
163 int mindes = nuc().mindes();
164 des = max(desdrop, ascdrop);
165 des = max(mindes, des);
168 Dimension const & dimup = up().dimension(bv);
169 int minasc = nuc().minasc();
170 int ascdrop = isCharBox ? 0 : asc - up().mindes();
171 int udes = dimup.descent();
172 asc = udes + nuc().sshift();
173 asc = max(ascdrop, asc);
174 asc = max(minasc, asc);
176 int del = asc - udes - dasc;
177 if (del + des <= 2) {
178 int newdes = 2 - del;
179 del = slevel - asc + udes;
184 des = max(des, newdes);
188 return what ? asc : des;
192 int InsetMathScript::dy0(BufferView const & bv) const
197 int des = down().dimension(bv).ascent();
202 des = dy01(bv, na, nd, 0);
208 int InsetMathScript::dy1(BufferView const & bv) const
213 int asc = up().dimension(bv).descent();
218 asc = dy01(bv, na, nd, 1);
225 int InsetMathScript::dx0(BufferView const & bv) const
227 LASSERT(hasDown(), return 0);
228 Dimension const dim = dimension(bv);
229 return hasLimits() ? (dim.wid - down().dimension(bv).width()) / 2 : nwid(bv);
233 int InsetMathScript::dx1(BufferView const & bv) const
235 LASSERT(hasUp(), return 0);
236 Dimension const dim = dimension(bv);
237 return hasLimits() ? (dim.wid - up().dimension(bv).width()) / 2 : nwid(bv) + nker(&bv);
241 int InsetMathScript::dxx(BufferView const & bv) const
243 Dimension const dim = dimension(bv);
244 return hasLimits() ? (dim.wid - nwid(bv)) / 2 : 0;
248 int InsetMathScript::nwid(BufferView const & bv) const
250 return !nuc().empty() ? nuc().dimension(bv).width() : 2;
254 int InsetMathScript::nasc(BufferView const & bv) const
256 return !nuc().empty() ? nuc().dimension(bv).ascent() : 5;
260 int InsetMathScript::ndes(BufferView const & bv) const
262 return !nuc().empty() ? nuc().dimension(bv).descent() : 0;
266 int InsetMathScript::nker(BufferView const * bv) const
268 if (!nuc().empty()) {
269 int kerning = nuc().kerning(bv);
270 return kerning > 0 ? kerning : 0;
276 MathClass InsetMathScript::mathClass() const
278 // FIXME: this is a hack, since the class will not be correct if
279 // the nucleus has several elements or if the last element is a math macro
280 // or a macro argument proxy.
281 // The correct implementation would require to linearize the nucleus.
285 // return the class of last element since this is the one that counts.
286 MathClass mc = nuc().back()->mathClass();
287 return (mc == MC_UNKNOWN) ? MC_ORD : mc;
292 void InsetMathScript::metrics(MetricsInfo & mi, Dimension & dim) const
294 Changer dummy2 = mi.base.changeEnsureMath();
298 cell(0).metrics(mi, dim0);
299 Changer dummy = mi.base.changeScript();
301 cell(1).metrics(mi, dim1);
303 cell(2).metrics(mi, dim2);
306 BufferView & bv = *mi.base.bv;
307 // FIXME: data copying... not very efficient.
311 dimup = up().dimension(bv);
313 dimdown = down().dimension(bv);
318 dim.wid = max(dim.wid, dimup.width());
320 dim.wid = max(dim.wid, dimdown.width());
323 dim.wid = max(dim.wid, nker(mi.base.bv) + dimup.width());
325 dim.wid = max(dim.wid, dimdown.width());
330 int asc = dy1(bv) + dimup.ascent();
331 dim.asc = max(na, asc);
336 int des = dy0(bv) + dimdown.descent();
337 dim.des = max(nd, des);
340 metricsMarkers(mi, dim);
344 void InsetMathScript::draw(PainterInfo & pi, int x, int y) const
346 Changer dummy2 = pi.base.changeEnsureMath();
347 BufferView & bv = *pi.base.bv;
349 nuc().draw(pi, x + dxx(bv), y);
351 nuc().setXY(bv, x + dxx(bv), y);
353 pi.draw(x + dxx(bv), y, char_type('.'));
355 Changer dummy = pi.base.changeScript();
357 up().draw(pi, x + dx1(bv), y - dy1(bv));
359 down().draw(pi, x + dx0(bv), y + dy0(bv));
360 drawMarkers(pi, x, y);
364 void InsetMathScript::metricsT(TextMetricsInfo const & mi, Dimension & dim) const
367 up().metricsT(mi, dim);
369 down().metricsT(mi, dim);
370 nuc().metricsT(mi, dim);
374 void InsetMathScript::drawT(TextPainter & pain, int x, int y) const
378 nuc().drawT(pain, x + 1, y);
380 up().drawT(pain, x + 1, y - 1 /*dy1()*/);
382 down().drawT(pain, x + 1, y + 1 /*dy0()*/);
387 bool InsetMathScript::hasLimits() const
395 // we can only display limits if the nucleus wants some
398 if (!nuc().back()->isScriptable())
401 if (nuc().back()->asSymbolInset()) {
402 // \intop is an alias for \int\limits, \ointop == \oint\limits
403 if (nuc().back()->asSymbolInset()->name().find(from_ascii("intop")) != string::npos)
405 // per default \int has limits beside the \int even in displayed formulas
406 if (nuc().back()->asSymbolInset()->name().find(from_ascii("int")) != string::npos)
410 // assume "real" limits for everything else
415 void InsetMathScript::removeScript(bool up)
418 if (up == cell_1_is_up_)
420 } else if (nargs() == 3) {
422 swap(cells_[1], cells_[2]);
423 cell_1_is_up_ = false;
425 cell_1_is_up_ = true;
432 bool InsetMathScript::has(bool up) const
434 return idxOfScript(up);
438 bool InsetMathScript::hasUp() const
440 //lyxerr << "1up: " << bool(cell_1_is_up_));
441 //lyxerr << "hasUp: " << bool(idxOfScript(true)));
442 return idxOfScript(true);
446 bool InsetMathScript::hasDown() const
448 //LYXERR0("1up: " << bool(cell_1_is_up_));
449 //LYXERR0("hasDown: " << bool(idxOfScript(false)));
450 return idxOfScript(false);
454 Inset::idx_type InsetMathScript::idxOfScript(bool up) const
459 return (cell_1_is_up_ == up) ? 1 : 0;
462 LASSERT(false, return 0);
466 bool InsetMathScript::idxForward(Cursor &) const
472 bool InsetMathScript::idxBackward(Cursor &) const
478 bool InsetMathScript::idxUpDown(Cursor & cur, bool up) const
481 if (cur.idx() == 0) {
482 // don't go up/down if there is no cell in this direction
485 // go up/down only if in the last position
486 // or in the first position of something with displayed limits
487 if (cur.pos() == cur.lastpos() || (cur.pos() == 0 && hasLimits())) {
488 cur.idx() = idxOfScript(up);
496 if (cur.idx() == idxOfScript(true)) {
497 // can't go further up
500 // otherwise go to last position in the nucleus
502 cur.pos() = cur.lastpos();
507 if (cur.idx() == idxOfScript(false)) {
508 // can't go further down
511 // otherwise go to last position in the nucleus
513 cur.pos() = cur.lastpos();
521 void InsetMathScript::write(WriteStream & os) const
523 MathEnsurer ensurer(os);
525 if (!nuc().empty()) {
527 //if (nuc().back()->takesLimits()) {
535 LYXERR(Debug::MATHED, "suppressing {} when writing");
540 if (hasDown() /*&& !down().empty()*/)
541 os << "_{" << down() << '}';
543 if (hasUp() /*&& !up().empty()*/) {
544 // insert space if up() is empty or an empty brace inset
546 if (os.latex() && (up().empty() ||
547 (up().size() == 1 && up().back()->asBraceInset() &&
548 up().back()->asBraceInset()->cell(0).empty())))
551 os << "^{" << up() << '}';
554 if (lock_ && !os.latex())
559 void InsetMathScript::normalize(NormalStream & os) const
561 bool d = hasDown() && !down().empty();
562 bool u = hasUp() && !up().empty();
577 os << down() << ' ' << up() << ']';
585 void InsetMathScript::maple(MapleStream & os) const
589 if (hasDown() && !down().empty())
590 os << '[' << down() << ']';
591 if (hasUp() && !up().empty())
592 os << "^(" << up() << ')';
596 void InsetMathScript::mathematica(MathematicaStream & os) const
598 bool d = hasDown() && !down().empty();
599 bool u = hasUp() && !up().empty();
601 if (!nuc().empty()) {
603 os << "Subscript[" << nuc();
609 os << "^(" << up() << ')';
611 if (!nuc().empty()) {
613 os << ',' << down() << ']';
618 void InsetMathScript::mathmlize(MathStream & os) const
620 bool d = hasDown() && !down().empty();
621 bool u = hasUp() && !up().empty();
622 bool l = hasLimits();
625 os << MTag(l ? "munderover" : "msubsup");
627 os << MTag(l ? "mover" : "msup");
629 os << MTag(l ? "munder" : "msub");
632 os << MTag("mrow") << nuc() << ETag("mrow");
637 os << MTag("mrow") << down() << ETag("mrow")
638 << MTag("mrow") << up() << ETag("mrow")
639 << ETag(l ? "munderover" : "msubsup");
641 os << MTag("mrow") << up() << ETag("mrow") << ETag(l ? "mover" : "msup");
643 os << MTag("mrow") << down() << ETag("mrow") << ETag(l ? "munder" : "msub");
647 void InsetMathScript::htmlize(HtmlStream & os) const
649 bool d = hasDown() && !down().empty();
650 bool u = hasUp() && !up().empty();
656 os << MTag("span", "class='scripts'")
657 << MTag("span") << up() << ETag("span")
658 << MTag("span") << down() << ETag("span")
661 os << MTag("sup", "class='math'") << up() << ETag("sup");
663 os << MTag("sub", "class='math'") << down() << ETag("sub");
667 void InsetMathScript::octave(OctaveStream & os) const
671 if (hasDown() && !down().empty())
672 os << '[' << down() << ']';
673 if (hasUp() && !up().empty())
674 os << "^(" << up() << ')';
678 void InsetMathScript::infoize(odocstream & os) const
684 void InsetMathScript::infoize2(odocstream & os) const
687 os << from_ascii(limits_ == 1 ? ", Displayed limits" : ", Inlined limits");
691 bool InsetMathScript::notifyCursorLeaves(Cursor const & old, Cursor & cur)
693 InsetMathNest::notifyCursorLeaves(old, cur);
695 //LYXERR0("InsetMathScript::notifyCursorLeaves: 1 " << cur);
697 // Remove empty scripts if possible:
699 // The case of two scripts, but only one got empty (1 = super, 2 = sub).
700 // We keep the script inset, but remove the empty script.
701 if (nargs() > 2 && (!cell(1).empty() || !cell(2).empty())) {
702 if (cell(2).empty()) {
703 // must be a subscript...
704 old.recordUndoInset();
706 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
708 } else if (cell(1).empty()) {
709 // must be a superscript...
710 old.recordUndoInset();
712 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
716 // Now the two suicide cases:
717 // * we have only one script which is empty
718 // * we have two scripts which are both empty.
719 // The script inset is removed completely.
720 if ((nargs() == 2 && cell(1).empty())
721 || (nargs() == 3 && cell(1).empty() && cell(2).empty())) {
722 // Make undo step. We cannot use cur for this because
723 // it does not necessarily point to us anymore. But we
724 // should be on top of the cursor old.
725 Cursor insetCur = old;
726 int scriptSlice = insetCur.find(this);
727 LASSERT(scriptSlice != -1, /**/);
728 insetCur.cutOff(scriptSlice);
729 insetCur.recordUndoInset();
731 // Let the script inset commit suicide. This is
732 // modelled on Cursor.pullArg(), but tries not to
733 // invoke notifyCursorLeaves again and does not touch
734 // cur (since the top slice will be deleted
736 MathData ar = cell(0);
738 insetCur.cell().erase(insetCur.pos());
739 insetCur.cell().insert(insetCur.pos(), ar);
742 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
746 //LYXERR0("InsetMathScript::notifyCursorLeaves: 2 " << cur);
751 void InsetMathScript::doDispatch(Cursor & cur, FuncRequest & cmd)
753 //LYXERR("InsetMathScript: request: " << cmd);
755 if (cmd.action() == LFUN_MATH_LIMITS) {
756 cur.recordUndoInset();
757 if (!cmd.argument().empty()) {
758 if (cmd.argument() == "limits")
760 else if (cmd.argument() == "nolimits")
764 } else if (limits_ == 0)
765 limits_ = hasLimits() ? -1 : 1;
771 InsetMathNest::doDispatch(cur, cmd);
775 bool InsetMathScript::getStatus(Cursor & cur, FuncRequest const & cmd,
776 FuncStatus & flag) const
778 if (cmd.action() == LFUN_MATH_LIMITS) {
779 if (!cmd.argument().empty()) {
780 if (cmd.argument() == "limits")
781 flag.setOnOff(limits_ == 1);
782 else if (cmd.argument() == "nolimits")
783 flag.setOnOff(limits_ == -1);
785 flag.setOnOff(limits_ == 0);
787 flag.setEnabled(true);
791 return InsetMathNest::getStatus(cur, cmd, flag);
795 // the idea for dual scripts came from the eLyXer code
796 void InsetMathScript::validate(LaTeXFeatures & features) const
798 if (features.runparams().math_flavor == OutputParams::MathAsHTML)
799 features.addCSSSnippet(
800 "span.scripts{display: inline-block; vertical-align: middle; text-align:center; font-size: 75%;}\n"
801 "span.scripts span {display: block;}\n"
802 "sub.math{font-size: 75%;}\n"
803 "sup.math{font-size: 75%;}");
804 InsetMathNest::validate(features);