]> git.lyx.org Git - lyx.git/blobdiff - src/mathed/InsetMathHull.cpp
Specify that we are in math mode. This avoids unnecessary \ensuremath
[lyx.git] / src / mathed / InsetMathHull.cpp
index 738c3098fa6a91647fdad1ae79f5c3e8988ce40f..99d59b00b08a291bc29c97358345562387feaf75 100644 (file)
@@ -26,6 +26,7 @@
 #include "InsetMathRef.h"
 
 #include "Buffer.h"
+#include "buffer_funcs.h"
 #include "BufferParams.h"
 #include "BufferView.h"
 #include "CutAndPaste.h"
@@ -34,6 +35,7 @@
 #include "Cursor.h"
 #include "DispatchResult.h"
 #include "FuncRequest.h"
+#include "Language.h"
 #include "LyXRC.h"
 #include "OutputParams.h"
 #include "ParIterator.h"
@@ -50,6 +52,7 @@
 
 #include "frontends/Painter.h"
 
+#include "support/lassert.h"
 #include "support/debug.h"
 #include "support/gettext.h"
 #include "support/lstrings.h"
@@ -143,8 +146,8 @@ docstring hullName(HullType type)
 static InsetLabel * dummy_pointer = 0;
 
 InsetMathHull::InsetMathHull()
-       : InsetMathGrid(1, 1), type_(hullNone), nonum_(1, false), label_(1, dummy_pointer),
-         preview_(new RenderPreview(this))
+       : InsetMathGrid(1, 1), type_(hullNone), nonum_(1, false),
+         label_(1, dummy_pointer), preview_(new RenderPreview(this))
 {
        //lyxerr << "sizeof InsetMath: " << sizeof(InsetMath) << endl;
        //lyxerr << "sizeof MetricsInfo: " << sizeof(MetricsInfo) << endl;
@@ -156,15 +159,15 @@ InsetMathHull::InsetMathHull()
 
 
 InsetMathHull::InsetMathHull(HullType type)
-       : InsetMathGrid(getCols(type), 1), type_(type), nonum_(1, false), label_(1, dummy_pointer),
-         preview_(new RenderPreview(this))
+       : InsetMathGrid(getCols(type), 1), type_(type), nonum_(1, false),
+         label_(1, dummy_pointer), preview_(new RenderPreview(this))
 {
        initMath();
        setDefaults();
 }
 
 
-InsetMathHull::InsetMathHull(InsetMathHull const & other)
+InsetMathHull::InsetMathHull(InsetMathHull const & other) : InsetMathGrid()
 {
        operator=(other);
 }
@@ -172,10 +175,8 @@ InsetMathHull::InsetMathHull(InsetMathHull const & other)
 
 InsetMathHull::~InsetMathHull()
 {
-       for (size_t i = 0; i < label_.size(); ++i) {
-               if (label_[i])
-                       delete label_[i];
-       }
+       for (size_t i = 0; i < label_.size(); ++i)
+               delete label_[i];
 }
 
 
@@ -192,10 +193,8 @@ InsetMathHull & InsetMathHull::operator=(InsetMathHull const & other)
        InsetMathGrid::operator=(other);
        type_  = other.type_;
        nonum_ = other.nonum_;
-       for (size_t i = 0; i < label_.size(); ++i) {
-               if (label_[i])
-                       delete label_[i];
-       }
+       for (size_t i = 0; i < label_.size(); ++i)
+               delete label_[i];
        label_ = other.label_;
        for (size_t i = 0; i != label_.size(); ++i) {
                if (label_[i])
@@ -210,6 +209,12 @@ InsetMathHull & InsetMathHull::operator=(InsetMathHull const & other)
 void InsetMathHull::setBuffer(Buffer & buffer)
 {
        buffer_ = &buffer;
+       for (idx_type i = 0, n = nargs(); i != n; ++i) {
+               MathData & data = cell(i);
+               for (size_t j = 0; j != data.size(); ++j)
+                       data[j].nucleus()->setBuffer(buffer);
+       }
+
        for (size_t i = 0; i != label_.size(); ++i) {
                if (label_[i])
                        label_[i]->setBuffer(buffer);
@@ -232,7 +237,7 @@ void InsetMathHull::updateLabels(ParIterator const & it)
 }
 
 
-void InsetMathHull::addToToc(ParConstIterator const & pit) const
+void InsetMathHull::addToToc(DocIterator const & pit)
 {
        if (!buffer_) {
                //FIXME: buffer_ should be set at creation for this inset! Problem is
@@ -241,10 +246,6 @@ void InsetMathHull::addToToc(ParConstIterator const & pit) const
                return;
        }
 
-       // FIXME: it would be way better to directly use InsetLabel instead of this
-       // label list. But it should be possible to copy&paste the code in
-       // InsetLabel::addToToc() anyway.
-
        Toc & toc = buffer().tocBackend().toc("equation");
 
        for (row_type row = 0; row != nrows(); ++row) {
@@ -420,7 +421,7 @@ void InsetMathHull::metricsT(TextMetricsInfo const & mi, Dimension & dim) const
                InsetMathGrid::metricsT(mi, dim);
        } else {
                odocstringstream os;
-               WriteStream wi(os, false, true);
+               WriteStream wi(os, false, true, false);
                write(wi);
                dim.wid = os.str().size();
                dim.asc = 1;
@@ -435,30 +436,31 @@ void InsetMathHull::drawT(TextPainter & pain, int x, int y) const
                InsetMathGrid::drawT(pain, x, y);
        } else {
                odocstringstream os;
-               WriteStream wi(os, false, true);
+               WriteStream wi(os, false, true, false);
                write(wi);
                pain.draw(x, y, os.str().c_str());
        }
 }
 
 
-namespace {
-
-docstring const latex_string(InsetMathHull const & inset)
+static docstring latexString(InsetMathHull const & inset)
 {
        odocstringstream ls;
-       WriteStream wi(ls, false, false);
+       // This has to be static, because a preview snippet containing math
+       // in text mode (such as $\text{$\phi$}$) gets processed twice. The
+       // first time as a whole, and the second time only the inner math.
+       // In this last case inset.buffer() would be invalid.
+       static Encoding const * encoding = inset.buffer().language()->encoding();
+       WriteStream wi(ls, false, true, false, encoding);
        inset.write(wi);
        return ls.str();
 }
 
-} // namespace anon
-
 
 void InsetMathHull::addPreview(graphics::PreviewLoader & ploader) const
 {
        if (RenderPreview::status() == LyXRC::PREVIEW_ON) {
-               docstring const snippet = latex_string(*this);
+               docstring const snippet = latexString(*this);
                preview_->addPreview(snippet, ploader);
        }
 }
@@ -468,7 +470,7 @@ bool InsetMathHull::notifyCursorLeaves(Cursor const & /*old*/, Cursor & cur)
 {
        if (RenderPreview::status() == LyXRC::PREVIEW_ON) {
                Buffer const & buffer = cur.buffer();
-               docstring const snippet = latex_string(*this);
+               docstring const snippet = latexString(*this);
                preview_->addPreview(snippet, buffer);
                preview_->startLoading(buffer);
                cur.updateFlags(Update::Force);
@@ -479,7 +481,7 @@ bool InsetMathHull::notifyCursorLeaves(Cursor const & /*old*/, Cursor & cur)
 
 docstring InsetMathHull::label(row_type row) const
 {
-       BOOST_ASSERT(row < nrows());
+       LASSERT(row < nrows(), /**/);
        if (InsetLabel * il = label_[row])
                return il->screenLabel();
        return docstring();
@@ -490,7 +492,14 @@ void InsetMathHull::label(row_type row, docstring const & label)
 {
        //lyxerr << "setting label '" << label << "' for row " << row << endl;
        if (label_[row]) {
-               label_[row]->updateCommand(label);
+               if (label.empty()) {
+                       delete label_[row];
+                       label_[row] = dummy_pointer;
+                       // We need an update of the Buffer reference cache.
+                       // This is achieved by updateLabels().
+                       lyx::updateLabels(buffer());
+               } else
+                       label_[row]->updateCommand(label);
                return;
        }
        InsetCommandParams p(LABEL_CODE);
@@ -507,6 +516,9 @@ void InsetMathHull::numbered(row_type row, bool num)
        if (nonum_[row] && label_[row]) {
                delete label_[row];
                label_[row] = 0;
+               // We need an update of the Buffer reference cache.
+               // This is achieved by updateLabels().
+               lyx::updateLabels(buffer());
        }
 }
 
@@ -536,14 +548,6 @@ Inset::DisplayType InsetMathHull::display() const
 }
 
 
-void InsetMathHull::getLabelList(vector<docstring> & labels) const
-{
-       for (row_type row = 0; row < nrows(); ++row)
-               if (label_[row] && !nonum_[row])
-                       labels.push_back(label_[row]->screenLabel());
-}
-
-
 bool InsetMathHull::numberedType() const
 {
        if (type_ == hullNone)
@@ -564,13 +568,11 @@ void InsetMathHull::validate(LaTeXFeatures & features) const
        if (ams())
                features.require("amsmath");
 
-
        // Validation is necessary only if not using AMS math.
        // To be safe, we will always run mathedvalidate.
        //if (features.amsstyle)
        //  return;
 
-       features.require("boldsymbol");
        //features.binom      = true;
 
        InsetMathGrid::validate(features);
@@ -687,8 +689,21 @@ void InsetMathHull::addRow(row_type row)
 {
        if (!rowChangeOK())
                return;
-       nonum_.insert(nonum_.begin() + row + 1, !numberedType());
+
+       bool numbered = numberedType();
+       docstring lab;
+       if (type_ == hullMultline) {
+               if (row + 1 == nrows())  {
+                       nonum_[row] = true;
+                       lab = label(row);
+               } else
+                       numbered = false;
+       }
+
+       nonum_.insert(nonum_.begin() + row + 1, !numbered);
        label_.insert(label_.begin() + row + 1, dummy_pointer);
+       if (!lab.empty())
+               label(row + 1, lab);
        InsetMathGrid::addRow(row);
 }
 
@@ -699,7 +714,14 @@ void InsetMathHull::swapRow(row_type row)
                return;
        if (row + 1 == nrows())
                --row;
-       swap(nonum_[row], nonum_[row + 1]);
+       // gcc implements the standard std::vector<bool> which is *not* a container:
+       //   http://www.gotw.ca/publications/N1185.pdf
+       // As a results, it doesn't like this:
+       //      swap(nonum_[row], nonum_[row + 1]);
+       // so we do it manually:
+       bool const b = nonum_[row];
+       nonum_[row] = nonum_[row + 1];
+       nonum_[row + 1] = b;
        swap(label_[row], label_[row + 1]);
        InsetMathGrid::swapRow(row);
 }
@@ -709,14 +731,21 @@ void InsetMathHull::delRow(row_type row)
 {
        if (nrows() <= 1 || !rowChangeOK())
                return;
+       if (row + 1 == nrows() && type_ == hullMultline) {
+               bool const b = nonum_[row - 1];
+               nonum_[row - 1] = nonum_[row];
+               nonum_[row] = b;
+               swap(label_[row - 1], label_[row]);
+               InsetMathGrid::delRow(row);
+               return;
+       }
        InsetMathGrid::delRow(row);
        // The last dummy row has no number info nor a label.
        // Test nrows() + 1 because we have already erased the row.
        if (row == nrows() + 1)
                row--;
        nonum_.erase(nonum_.begin() + row);
-       if (label_[row])
-               delete label_[row];
+       delete label_[row];
        label_.erase(label_.begin() + row);
 }
 
@@ -743,7 +772,7 @@ docstring InsetMathHull::nicelabel(row_type row) const
                return docstring();
        if (!label_[row])
                return from_ascii("(#)");
-       return '(' + label_[row]->screenLabel() + ')';
+       return '(' + label_[row]->screenLabel() + from_ascii(", #)");
 }
 
 
@@ -760,7 +789,7 @@ void InsetMathHull::glueall()
 
 void InsetMathHull::splitTo2Cols()
 {
-       BOOST_ASSERT(ncols() == 1);
+       LASSERT(ncols() == 1, /**/);
        InsetMathGrid::addCol(1);
        for (row_type row = 0; row < nrows(); ++row) {
                idx_type const i = 2 * row;
@@ -773,7 +802,7 @@ void InsetMathHull::splitTo2Cols()
 
 void InsetMathHull::splitTo3Cols()
 {
-       BOOST_ASSERT(ncols() < 3);
+       LASSERT(ncols() < 3, /**/);
        if (ncols() < 2)
                splitTo2Cols();
        InsetMathGrid::addCol(2);
@@ -980,7 +1009,7 @@ docstring InsetMathHull::eolString(row_type row, bool emptyline, bool fragile) c
        docstring res;
        if (numberedType()) {
                if (label_[row] && !nonum_[row])
-                       res += "\\label{" + label_[row]->screenLabel() + '}';
+                       res += "\\label{" + label_[row]->getParam("name") + '}';
                if (nonum_[row] && (type_ != hullMultline))
                        res += "\\nonumber ";
        }
@@ -990,6 +1019,7 @@ docstring InsetMathHull::eolString(row_type row, bool emptyline, bool fragile) c
 
 void InsetMathHull::write(WriteStream & os) const
 {
+       ModeSpecifier specifier(os, MATH_MODE);
        header_write(os);
        InsetMathGrid::write(os);
        footer_write(os);
@@ -1018,8 +1048,8 @@ void InsetMathHull::infoize(odocstream & os) const
 
 void InsetMathHull::check() const
 {
-       BOOST_ASSERT(nonum_.size() == nrows());
-       BOOST_ASSERT(label_.size() == nrows());
+       LASSERT(nonum_.size() == nrows(), /**/);
+       LASSERT(label_.size() == nrows(), /**/);
 }
 
 
@@ -1117,7 +1147,7 @@ void InsetMathHull::doDispatch(Cursor & cur, FuncRequest & cmd)
                // just swallow this
                break;
 
-       case LFUN_NEW_LINE:
+       case LFUN_NEWLINE_INSERT:
                // some magic for the common case
                if (type_ == hullSimple || type_ == hullEquation) {
                        cur.recordUndoInset();
@@ -1164,7 +1194,7 @@ void InsetMathHull::doDispatch(Cursor & cur, FuncRequest & cmd)
 
                InsetCommandParams p(LABEL_CODE);
                p["name"] = cmd.argument().empty() ? old_label : cmd.argument();
-               string const data = InsetCommandMailer::params2string("label", p);
+               string const data = InsetCommand::params2string("label", p);
 
                if (cmd.argument().empty())
                        cur.bv().showDialog("label", data);
@@ -1175,13 +1205,33 @@ void InsetMathHull::doDispatch(Cursor & cur, FuncRequest & cmd)
                break;
        }
 
+       case LFUN_WORD_DELETE_FORWARD:
+       case LFUN_CHAR_DELETE_FORWARD:
+               if (col(cur.idx()) + 1 == ncols()
+                   && cur.pos() == cur.lastpos()) {
+                       if (!label(row(cur.idx())).empty()) {
+                               cur.recordUndoInset();
+                               label(row(cur.idx()), docstring());
+                       } else if (numbered(row(cur.idx()))) {
+                               cur.recordUndoInset();
+                               numbered(row(cur.idx()), false);
+                       } else {
+                               InsetMathGrid::doDispatch(cur, cmd);
+                               return;
+                       }
+               } else {
+                       InsetMathGrid::doDispatch(cur, cmd);
+                       return;
+               }
+               break;
+
        case LFUN_INSET_INSERT: {
                //lyxerr << "arg: " << to_utf8(cmd.argument()) << endl;
                // FIXME: this should be cleaned up to use InsetLabel methods directly.
                string const name = cmd.getArg(0);
                if (name == "label") {
                        InsetCommandParams p(LABEL_CODE);
-                       InsetCommandMailer::string2params(name, to_utf8(cmd.argument()), p);
+                       InsetCommand::string2params(name, to_utf8(cmd.argument()), p);
                        docstring str = p["name"];
                        cur.recordUndoInset();
                        row_type const r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
@@ -1256,33 +1306,35 @@ bool InsetMathHull::getStatus(Cursor & cur, FuncRequest const & cmd,
        case LFUN_FINISHED_LEFT:
        case LFUN_UP:
        case LFUN_DOWN:
-       case LFUN_NEW_LINE:
+       case LFUN_NEWLINE_INSERT:
        case LFUN_MATH_EXTERN:
        case LFUN_MATH_MUTATE:
        case LFUN_MATH_DISPLAY:
                // we handle these
-               status.enabled(true);
+               status.setEnabled(true);
                return true;
        case LFUN_MATH_NUMBER_TOGGLE:
                // FIXME: what is the right test, this or the one of
                // LABEL_INSERT?
-               status.enabled(display());
+               status.setEnabled(display());
                status.setOnOff(numberedType());
                return true;
        case LFUN_MATH_NUMBER_LINE_TOGGLE: {
                // FIXME: what is the right test, this or the one of
                // LABEL_INSERT?
-               status.enabled(display());
+               bool const enable = (type_ == hullMultline) ?
+                       (nrows() - 1 == cur.row()) : display();
                row_type const r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
+               status.setEnabled(enable);
                status.setOnOff(numbered(r));
                return true;
        }
        case LFUN_LABEL_INSERT:
-               status.enabled(type_ != hullSimple);
+               status.setEnabled(type_ != hullSimple);
                return true;
        case LFUN_INSET_INSERT:
                if (cmd.getArg(0) == "label") {
-                       status.enabled(type_ != hullSimple);
+                       status.setEnabled(type_ != hullSimple);
                        return true;
                }
                return InsetMathGrid::getStatus(cur, cmd, status);
@@ -1297,7 +1349,7 @@ bool InsetMathHull::getStatus(Cursor & cur, FuncRequest const & cmd,
                        status.message(bformat(
                                from_utf8(N_("Can't change number of rows in '%1$s'")),
                                hullName(type_)));
-                       status.enabled(false);
+                       status.setEnabled(false);
                        return true;
                }
                if (!colChangeOK()
@@ -1307,7 +1359,7 @@ bool InsetMathHull::getStatus(Cursor & cur, FuncRequest const & cmd,
                        status.message(bformat(
                                from_utf8(N_("Can't change number of columns in '%1$s'")),
                                hullName(type_)));
-                       status.enabled(false);
+                       status.setEnabled(false);
                        return true;
                }
                if ((type_ == hullSimple
@@ -1317,20 +1369,20 @@ bool InsetMathHull::getStatus(Cursor & cur, FuncRequest const & cmd,
                        status.message(bformat(
                                from_utf8(N_("Can't add horizontal grid lines in '%1$s'")),
                                hullName(type_)));
-                       status.enabled(false);
+                       status.setEnabled(false);
                        return true;
                }
                if (s == "add-vline-left" || s == "add-vline-right") {
                        status.message(bformat(
                                from_utf8(N_("Can't add vertical grid lines in '%1$s'")),
                                hullName(type_)));
-                       status.enabled(false);
+                       status.setEnabled(false);
                        return true;
                }
                if (s == "valign-top" || s == "valign-middle"
                 || s == "valign-bottom" || s == "align-left"
                 || s == "align-center" || s == "align-right") {
-                       status.enabled(false);
+                       status.setEnabled(false);
                        return true;
                }
                return InsetMathGrid::getStatus(cur, cmd, status);
@@ -1354,7 +1406,7 @@ void InsetMathHull::mutateToText()
 #if 0
        // translate to latex
        ostringstream os;
-       latex(NULL, os, false, false);
+       latex(os, false, false);
        string str = os.str();
 
        // insert this text
@@ -1429,7 +1481,7 @@ void InsetMathHull::revealCodes(Cursor & cur) const
        // translate to latex
        cur.markInsert(bv);
        ostringstream os;
-       write(NULL, os);
+       write(os);
        string str = os.str();
        cur.markErase(bv);
        string::size_type pos = 0;
@@ -1506,7 +1558,7 @@ bool InsetMathHull::searchForward(BufferView * bv, string const & str,
 void InsetMathHull::write(ostream & os) const
 {
        odocstringstream oss;
-       WriteStream wi(oss, false, false);
+       WriteStream wi(oss, false, false, false);
        oss << "Formula ";
        write(wi);
        os << to_utf8(oss.str());
@@ -1521,7 +1573,7 @@ void InsetMathHull::read(Lexer & lex)
 }
 
 
-int InsetMathHull::plaintext(odocstream & os, OutputParams const &) const
+int InsetMathHull::plaintext(odocstream & os, OutputParams const & runparams) const
 {
        if (0 && display()) {
                Dimension dim;
@@ -1535,7 +1587,7 @@ int InsetMathHull::plaintext(odocstream & os, OutputParams const &) const
                return tpain.textheight();
        } else {
                odocstringstream oss;
-               WriteStream wi(oss, false, true);
+               WriteStream wi(oss, false, true, false, runparams.encoding);
                wi << cell(0);
 
                docstring const str = oss.str();
@@ -1567,7 +1619,7 @@ int InsetMathHull::docbook(odocstream & os, OutputParams const & runparams) cons
                // Workaround for db2latex: db2latex always includes equations with
                // \ensuremath{} or \begin{display}\end{display}
                // so we strip LyX' math environment
-               WriteStream wi(ls, false, false);
+               WriteStream wi(ls, false, false, false, runparams.encoding);
                InsetMathGrid::write(wi);
                ms << from_utf8(subst(subst(to_utf8(ls.str()), "&", "&amp;"), "<", "&lt;"));
                ms << ETag("alt");
@@ -1606,4 +1658,10 @@ void InsetMathHull::textString(odocstream & os) const
 }
 
 
+docstring InsetMathHull::contextMenu(BufferView const &, int, int) const
+{
+       return from_ascii("context-math");
+}
+
+
 } // namespace lyx