]> git.lyx.org Git - lyx.git/blobdiff - src/mathed/InsetMathScript.cpp
Add Benjamin Piwowarski to contributors. Welcome to LyX!
[lyx.git] / src / mathed / InsetMathScript.cpp
index a6d81617d7e64a4e011d557653ed5dfc0353ec95..ba2be2f729adddff8a17a16e66fabd886de89c64 100644 (file)
@@ -3,25 +3,30 @@
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *
- * \author André Pönitz
+ * \author André Pönitz
  *
  * Full author contact details are available in file CREDITS.
  */
 
 #include <config.h>
 
+#include "BufferView.h"
+#include "Cursor.h"
+#include "DispatchResult.h"
+#include "FuncRequest.h"
+#include "FuncStatus.h"
+#include "InsetMathBrace.h"
+#include "InsetMathFont.h"
 #include "InsetMathScript.h"
+#include "InsetMathSymbol.h"
+#include "LaTeXFeatures.h"
 #include "MathData.h"
 #include "MathStream.h"
 #include "MathSupport.h"
-#include "InsetMathSymbol.h"
-#include "InsetMathFont.h"
-#include "DispatchResult.h"
-#include "Cursor.h"
+
 #include "support/debug.h"
-#include "FuncRequest.h"
 
-#include <boost/assert.hpp>
+#include "support/lassert.h"
 
 #include <ostream>
 
@@ -30,20 +35,20 @@ using namespace std;
 namespace lyx {
 
 
-InsetMathScript::InsetMathScript()
-       : InsetMathNest(1), cell_1_is_up_(false), limits_(0)
+InsetMathScript::InsetMathScript(Buffer * buf)
+       : InsetMathNest(buf, 1), cell_1_is_up_(false), limits_(0)
 {}
 
 
-InsetMathScript::InsetMathScript(bool up)
-       : InsetMathNest(2), cell_1_is_up_(up), limits_(0)
+InsetMathScript::InsetMathScript(Buffer * buf, bool up)
+       : InsetMathNest(buf, 2), cell_1_is_up_(up), limits_(0)
 {}
 
 
-InsetMathScript::InsetMathScript(MathAtom const & at, bool up)
-       : InsetMathNest(2), cell_1_is_up_(up), limits_(0)
+InsetMathScript::InsetMathScript(Buffer * buf, MathAtom const & at, bool up)
+       : InsetMathNest(buf, 2), cell_1_is_up_(up), limits_(0)
 {
-       BOOST_ASSERT(nargs() >= 1);
+       LASSERT(nargs() >= 1, /**/);
        cell(0).push_back(at);
 }
 
@@ -86,7 +91,7 @@ MathData const & InsetMathScript::down() const
 {
        if (nargs() == 3)
                return cell(2);
-       BOOST_ASSERT(nargs() > 1);
+       LASSERT(nargs() > 1, /**/);
        return cell(1);
 }
 
@@ -95,21 +100,21 @@ MathData & InsetMathScript::down()
 {
        if (nargs() == 3)
                return cell(2);
-       BOOST_ASSERT(nargs() > 1);
+       LASSERT(nargs() > 1, /**/);
        return cell(1);
 }
 
 
 MathData const & InsetMathScript::up() const
 {
-       BOOST_ASSERT(nargs() > 1);
+       LASSERT(nargs() > 1, /**/);
        return cell(1);
 }
 
 
 MathData & InsetMathScript::up()
 {
-       BOOST_ASSERT(nargs() > 1);
+       LASSERT(nargs() > 1, /**/);
        return cell(1);
 }
 
@@ -172,7 +177,7 @@ int InsetMathScript::dy01(BufferView const & bv, int asc, int des, int what) con
 {
        int dasc = 0;
        int slevel = 0;
-       bool isCharBox = nuc().size() ? isAlphaSymbol(nuc().back()) : false;
+       bool isCharBox = !nuc().empty() ? isAlphaSymbol(nuc().back()) : false;
        if (hasDown()) {
                Dimension const & dimdown = down().dimension(bv);
                dasc = dimdown.ascent();
@@ -243,7 +248,7 @@ int InsetMathScript::dy1(BufferView const & bv) const
 
 int InsetMathScript::dx0(BufferView const & bv) const
 {
-       BOOST_ASSERT(hasDown());
+       LASSERT(hasDown(), /**/);
        Dimension const dim = dimension(bv);
        return hasLimits() ? (dim.wid - down().dimension(bv).width()) / 2 : nwid(bv);
 }
@@ -251,9 +256,9 @@ int InsetMathScript::dx0(BufferView const & bv) const
 
 int InsetMathScript::dx1(BufferView const & bv) const
 {
-       BOOST_ASSERT(hasUp());
+       LASSERT(hasUp(), /**/);
        Dimension const dim = dimension(bv);
-       return hasLimits() ? (dim.wid - up().dimension(bv).width()) / 2 : nwid(bv) + nker();
+       return hasLimits() ? (dim.wid - up().dimension(bv).width()) / 2 : nwid(bv) + nker(&bv);
 }
 
 
@@ -266,26 +271,26 @@ int InsetMathScript::dxx(BufferView const & bv) const
 
 int InsetMathScript::nwid(BufferView const & bv) const
 {
-       return nuc().size() ? nuc().dimension(bv).width() : 2;
+       return !nuc().empty() ? nuc().dimension(bv).width() : 2;
 }
 
 
 int InsetMathScript::nasc(BufferView const & bv) const
 {
-       return nuc().size() ? nuc().dimension(bv).ascent() : 5;
+       return !nuc().empty() ? nuc().dimension(bv).ascent() : 5;
 }
 
 
 int InsetMathScript::ndes(BufferView const & bv) const
 {
-       return nuc().size() ? nuc().dimension(bv).descent() : 0;
+       return !nuc().empty() ? nuc().dimension(bv).descent() : 0;
 }
 
 
-int InsetMathScript::nker() const
+int InsetMathScript::nker(BufferView const * bv) const
 {
-       if (nuc().size()) {
-               int kerning = nuc().kerning();
+       if (!nuc().empty()) {
+               int kerning = nuc().kerning(bv);
                return kerning > 0 ? kerning : 0;
        }
        return 0;
@@ -322,7 +327,7 @@ void InsetMathScript::metrics(MetricsInfo & mi, Dimension & dim) const
                        dim.wid = max(dim.wid, dimdown.width());
        } else {
                if (hasUp())
-                       dim.wid = max(dim.wid, nker() + dimup.width());
+                       dim.wid = max(dim.wid, nker(mi.base.bv) + dimup.width());
                if (hasDown())
                        dim.wid = max(dim.wid, dimdown.width());
                dim.wid += nwid(bv);
@@ -340,15 +345,13 @@ void InsetMathScript::metrics(MetricsInfo & mi, Dimension & dim) const
        } else
                dim.des = nd;
        metricsMarkers(dim);
-       // Cache the inset dimension. 
-       setDimCache(mi, dim);
 }
 
 
 void InsetMathScript::draw(PainterInfo & pi, int x, int y) const
 {
        BufferView & bv = *pi.base.bv;
-       if (nuc().size())
+       if (!nuc().empty())
                nuc().draw(pi, x + dxx(bv), y);
        else {
                nuc().setXY(bv, x + dxx(bv), y);
@@ -377,7 +380,7 @@ void InsetMathScript::metricsT(TextMetricsInfo const & mi, Dimension & dim) cons
 void InsetMathScript::drawT(TextPainter & pain, int x, int y) const
 {
        // FIXME: BROKEN
-       if (nuc().size())
+       if (!nuc().empty())
                nuc().drawT(pain, x + 1, y);
        if (hasUp())
                up().drawT(pain, x + 1, y - 1 /*dy1()*/);
@@ -396,7 +399,7 @@ bool InsetMathScript::hasLimits() const
                return false;
 
        // we can only display limits if the nucleus wants some
-       if (!nuc().size())
+       if (nuc().empty())
                return false;
        if (!nuc().back()->isScriptable())
                return false;
@@ -462,7 +465,7 @@ Inset::idx_type InsetMathScript::idxOfScript(bool up) const
                return (cell_1_is_up_ == up) ? 1 : 0;
        if (nargs() == 3)
                return up ? 1 : 2;
-       BOOST_ASSERT(false);
+       LASSERT(false, /**/);
        // Silence compiler
        return 0;
 }
@@ -525,7 +528,9 @@ bool InsetMathScript::idxUpDown(Cursor & cur, bool up) const
 
 void InsetMathScript::write(WriteStream & os) const
 {
-       if (nuc().size()) {
+       MathEnsurer ensurer(os);
+
+       if (!nuc().empty()) {
                os << nuc();
                //if (nuc().back()->takesLimits()) {
                        if (limits_ == -1)
@@ -540,11 +545,19 @@ void InsetMathScript::write(WriteStream & os) const
                        os << "{}";
        }
 
-       if (hasDown() /*&& down().size()*/)
+       if (hasDown() /*&& !down().empty()*/)
                os << "_{" << down() << '}';
 
-       if (hasUp() /*&& up().size()*/)
-               os << "^{" << up() << '}';
+       if (hasUp() /*&& !up().empty()*/) {
+               // insert space if up() is empty or an empty brace inset
+               // (see bug 8305)
+               if (os.latex() && (up().empty() ||
+                   (up().size() == 1 && up().back()->asBraceInset() &&
+                    up().back()->asBraceInset()->cell(0).empty())))
+                       os << "^ {}";
+               else
+                       os << "^{" << up() << '}';
+       }
 
        if (lock_ && !os.latex())
                os << "\\lyxlock ";
@@ -553,8 +566,8 @@ void InsetMathScript::write(WriteStream & os) const
 
 void InsetMathScript::normalize(NormalStream & os) const
 {
-       bool d = hasDown() && down().size();
-       bool u = hasUp() && up().size();
+       bool d = hasDown() && !down().empty();
+       bool u = hasUp() && !up().empty();
 
        if (u && d)
                os << "[subsup ";
@@ -563,7 +576,7 @@ void InsetMathScript::normalize(NormalStream & os) const
        else if (d)
                os << "[sub ";
 
-       if (nuc().size())
+       if (!nuc().empty())
                os << nuc() << ' ';
        else
                os << "[par]";
@@ -579,21 +592,21 @@ void InsetMathScript::normalize(NormalStream & os) const
 
 void InsetMathScript::maple(MapleStream & os) const
 {
-       if (nuc().size())
+       if (!nuc().empty())
                os << nuc();
-       if (hasDown() && down().size())
+       if (hasDown() && !down().empty())
                os << '[' << down() << ']';
-       if (hasUp() && up().size())
+       if (hasUp() && !up().empty())
                os << "^(" << up() << ')';
 }
 
 
 void InsetMathScript::mathematica(MathematicaStream & os) const
 {
-       bool d = hasDown() && down().size();
-       bool u = hasUp() && up().size();
+       bool d = hasDown() && !down().empty();
+       bool u = hasUp() && !up().empty();
 
-       if (nuc().size()) {
+       if (!nuc().empty()) {
                if (d)
                        os << "Subscript[" << nuc();
                else
@@ -603,17 +616,21 @@ void InsetMathScript::mathematica(MathematicaStream & os) const
        if (u)
                os << "^(" << up() << ')';
 
-       if (nuc().size()) {
+       if (!nuc().empty()) {
                if (d)
                        os << ',' << down() << ']';
        }
 }
 
 
+// FIXME XHTML
+// It may be worth trying to output munder, mover, and munderover
+// in certain cases, e.g., for display formulas. But then we would
+// need to know if we're in a display formula.
 void InsetMathScript::mathmlize(MathStream & os) const
 {
-       bool d = hasDown() && down().size();
-       bool u = hasUp() && up().size();
+       bool d = hasDown() && !down().empty();
+       bool u = hasUp() && !up().empty();
 
        if (u && d)
                os << MTag("msubsup");
@@ -622,27 +639,49 @@ void InsetMathScript::mathmlize(MathStream & os) const
        else if (d)
                os << MTag("msub");
 
-       if (nuc().size())
-               os << nuc();
+       if (!nuc().empty())
+               os << MTag("mrow") << nuc() << ETag("mrow");
        else
-               os << "<mrow/>";
+               os << "<mrow />";
 
        if (u && d)
-               os << down() << up() << ETag("msubsup");
+               os << MTag("mrow") << down() << ETag("mrow") 
+                  << MTag("mrow") << up() << ETag("mrow") 
+                  << ETag("msubsup");
        else if (u)
-               os << up() << ETag("msup");
+               os << MTag("mrow") << up() << ETag("mrow") << ETag("msup");
        else if (d)
-               os << down() << ETag("msub");
+               os << MTag("mrow") << down() << ETag("mrow") << ETag("msub");
+}
+
+
+void InsetMathScript::htmlize(HtmlStream & os) const
+{
+       bool d = hasDown() && !down().empty();
+       bool u = hasUp() && !up().empty();
+
+       if (!nuc().empty())
+               os << nuc();
+
+       if (u && d)
+               os << MTag("span", "class='scripts'")
+                        << MTag("span") << up() << ETag("span")
+                        << MTag("span") << down() << ETag("span")
+                        << ETag("span");
+       else if (u)
+               os << MTag("sup", "class='math'") << up() << ETag("sup");
+       else if (d)
+               os << MTag("sub", "class='math'") << down() << ETag("sub");
 }
 
 
 void InsetMathScript::octave(OctaveStream & os) const
 {
-       if (nuc().size())
+       if (!nuc().empty())
                os << nuc();
-       if (hasDown() && down().size())
+       if (hasDown() && !down().empty())
                os << '[' << down() << ']';
-       if (hasUp() && up().size())
+       if (hasUp() && !up().empty())
                os << "^(" << up() << ')';
 }
 
@@ -660,40 +699,58 @@ void InsetMathScript::infoize2(odocstream & os) const
 }
 
 
-bool InsetMathScript::notifyCursorLeaves(Cursor & cur)
+bool InsetMathScript::notifyCursorLeaves(Cursor const & old, Cursor & cur)
 {
-       InsetMathNest::notifyCursorLeaves(cur);
+       InsetMathNest::notifyCursorLeaves(old, cur);
 
        //LYXERR0("InsetMathScript::notifyCursorLeaves: 1 " << cur);
 
-       // remove empty scripts if possible
-       if (nargs() > 2) {
-               // Case of two scripts. In this case, 1 = super, 2 = sub
-               if (cur.idx() == 2 && cell(2).empty()) {
+       // Remove empty scripts if possible:
+
+       // The case of two scripts, but only one got empty (1 = super, 2 = sub).
+       // We keep the script inset, but remove the empty script.
+       if (nargs() > 2 && (!cell(1).empty() || !cell(2).empty())) {
+               if (cell(2).empty()) {
                        // must be a subscript...
-                       cur.recordUndoInset();
+                       old.recordUndoInset();
                        removeScript(false);
+                       cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
                        return true;
-               } else if (cur.idx() == 1 && cell(1).empty()) {
+               } else if (cell(1).empty()) {
                        // must be a superscript...
-                       cur.recordUndoInset();
+                       old.recordUndoInset();
                        removeScript(true);
+                       cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
                        return true;
                }
-       } else if (nargs() > 1 && cur.idx() == 1 && cell(1).empty()) {
-               // could be either subscript or super script
-               cur.recordUndoInset();
-               removeScript(cell_1_is_up_);
+       }
+       // Now the two suicide cases:
+       // * we have only one script which is empty
+       // * we have two scripts which are both empty.
+       // The script inset is removed completely.
+       if ((nargs() == 2 && cell(1).empty())
+           || (nargs() == 3 && cell(1).empty() && cell(2).empty())) {
+               // Make undo step. We cannot use cur for this because
+               // it does not necessarily point to us anymore. But we
+               // should be on top of the cursor old.
+               Cursor insetCur = old;
+               int scriptSlice = insetCur.find(this);
+               LASSERT(scriptSlice != -1, /**/);
+               insetCur.cutOff(scriptSlice);
+               insetCur.recordUndoInset();
+
                // Let the script inset commit suicide. This is
                // modelled on Cursor.pullArg(), but tries not to
                // invoke notifyCursorLeaves again and does not touch
                // cur (since the top slice will be deleted
-               // afterwards))
+               // afterwards)
                MathData ar = cell(0);
-               Cursor tmpcur = cur;
-               tmpcur.pop();
-               tmpcur.cell().erase(tmpcur.pos());
-               tmpcur.cell().insert(tmpcur.pos(), ar);
+               insetCur.pop();
+               insetCur.cell().erase(insetCur.pos());
+               insetCur.cell().insert(insetCur.pos(), ar);
+
+               // redraw
+               cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
                return true;
        }
 
@@ -706,7 +763,8 @@ void InsetMathScript::doDispatch(Cursor & cur, FuncRequest & cmd)
 {
        //LYXERR("InsetMathScript: request: " << cmd);
 
-       if (cmd.action == LFUN_MATH_LIMITS) {
+       if (cmd.action() == LFUN_MATH_LIMITS) {
+               cur.recordUndoInset();
                if (!cmd.argument().empty()) {
                        if (cmd.argument() == "limits")
                                limits_ = 1;
@@ -725,4 +783,36 @@ void InsetMathScript::doDispatch(Cursor & cur, FuncRequest & cmd)
 }
 
 
+bool InsetMathScript::getStatus(Cursor & cur, FuncRequest const & cmd,
+                               FuncStatus & flag) const
+{
+       if (cmd.action() == LFUN_MATH_LIMITS) {
+               if (!cmd.argument().empty()) {
+                       if (cmd.argument() == "limits")
+                               flag.setOnOff(limits_ == 1);
+                       else if (cmd.argument() == "nolimits")
+                               flag.setOnOff(limits_ == -1);
+                       else
+                               flag.setOnOff(limits_ == 0);
+               } 
+               flag.setEnabled(true);
+               return true;
+       }
+
+       return InsetMathNest::getStatus(cur, cmd, flag);
+}
+
+
+// the idea for dual scripts came from the eLyXer code
+void InsetMathScript::validate(LaTeXFeatures & features) const
+{
+       if (features.runparams().math_flavor == OutputParams::MathAsHTML)
+               features.addCSSSnippet(
+                       "span.scripts{display: inline-block; vertical-align: middle; text-align:center; font-size: 75%;}\n"
+                       "span.scripts span {display: block;}\n"
+                       "sub.math{font-size: 75%;}\n"
+                       "sup.math{font-size: 75%;}");
+       InsetMathNest::validate(features);
+}
+
 } // namespace lyx