]> git.lyx.org Git - lyx.git/blobdiff - src/mathed/MathMacroTemplate.cpp
Introduce hooks to encapsulate macro code of MathRow
[lyx.git] / src / mathed / MathMacroTemplate.cpp
index 3687bd185a8fa3ed5cb757457d68e06524637a9e..d4cf4cfa560bbf830c9b982564ac9fb0aa7c35f8 100644 (file)
@@ -13,8 +13,6 @@
 
 #include "MathMacroTemplate.h"
 
-#include "DocIterator.h"
-#include "LaTeXFeatures.h"
 #include "InsetMathBrace.h"
 #include "InsetMathChar.h"
 #include "InsetMathHull.h"
 #include "Color.h"
 #include "Cursor.h"
 #include "DispatchResult.h"
+#include "DocIterator.h"
 #include "FuncRequest.h"
 #include "FuncStatus.h"
+#include "LaTeXFeatures.h"
 #include "Lexer.h"
-#include "LyXRC.h" 
+#include "MetricsInfo.h"
+#include "TocBackend.h"
 
 #include "frontends/Painter.h"
 
@@ -268,14 +269,12 @@ Inset * InsetMathWrapper::clone() const
 void InsetMathWrapper::metrics(MetricsInfo & mi, Dimension & dim) const
 {
        value_->metrics(mi, dim);
-       //metricsMarkers2(dim);
 }
 
 
 void InsetMathWrapper::draw(PainterInfo & pi, int x, int y) const
 {
        value_->draw(pi, x, y);
-       //drawMarkers(pi, x, y);
 }
 
 
@@ -368,6 +367,7 @@ Inset * InsetNameWrapper::clone() const
 
 void InsetNameWrapper::metrics(MetricsInfo & mi, Dimension & dim) const
 {
+       Changer dummy = mi.base.changeFontSet("textit");
        InsetMathWrapper::metrics(mi, dim);
        dim.wid += mathed_string_width(mi.base.font, from_ascii("\\"));
 }
@@ -375,19 +375,17 @@ void InsetNameWrapper::metrics(MetricsInfo & mi, Dimension & dim) const
 
 void InsetNameWrapper::draw(PainterInfo & pi, int x, int y) const
 {
-       // create fonts
-       PainterInfo namepi = pi;
-       if (parent_.validMacro())
-               namepi.base.font.setColor(Color_latex);
-       else
-               namepi.base.font.setColor(Color_error);
+       ColorCode const color = parent_.validMacro() ? Color_latex : Color_error;
+
+       Changer dummy = pi.base.changeFontSet("textit");
+       Changer dummy2 = pi.base.font.changeColor(color);
 
        // draw backslash
-       pi.pain.text(x, y, from_ascii("\\"), namepi.base.font);
-       x += mathed_string_width(namepi.base.font, from_ascii("\\"));
+       pi.pain.text(x, y, from_ascii("\\"), pi.base.font);
+       x += mathed_string_width(pi.base.font, from_ascii("\\"));
 
        // draw name
-       InsetMathWrapper::draw(namepi, x, y);
+       InsetMathWrapper::draw(pi, x, y);
 }
 
 
@@ -396,7 +394,8 @@ void InsetNameWrapper::draw(PainterInfo & pi, int x, int y) const
 
 MathMacroTemplate::MathMacroTemplate(Buffer * buf)
        : InsetMathNest(buf, 3), numargs_(0), argsInLook_(0), optionals_(0),
-         type_(MacroTypeNewcommand), lookOutdated_(true)
+         type_(MacroTypeNewcommand), redefinition_(false), lookOutdated_(true),
+         premetrics_(false), labelBoxAscent_(0), labelBoxDescent_(0)
 {
        initMath();
 }
@@ -407,7 +406,8 @@ MathMacroTemplate::MathMacroTemplate(Buffer * buf, docstring const & name, int n
        MathData const & def, MathData const & display)
        : InsetMathNest(buf, optionals + 3), numargs_(numargs), argsInLook_(numargs),
          optionals_(optionals), optionalValues_(optionalValues),
-         type_(type), lookOutdated_(true)
+         type_(type), redefinition_(false), lookOutdated_(true),
+         premetrics_(false), labelBoxAscent_(0), labelBoxDescent_(0)
 {
        initMath();
 
@@ -426,26 +426,20 @@ MathMacroTemplate::MathMacroTemplate(Buffer * buf, docstring const & name, int n
 }
 
 
-MathMacroTemplate::MathMacroTemplate(Buffer * buf, docstring const & str)
-       : InsetMathNest(buf, 3), numargs_(0), optionals_(0),
-       type_(MacroTypeNewcommand), lookOutdated_(true)
+bool MathMacroTemplate::fromString(docstring const & str)
 {
-       buffer_ = buf;
-       initMath();
-
-       MathData ar(buf);
+       MathData ar(buffer_);
        mathed_parse_cell(ar, str, Parse::NORMAL);
        if (ar.size() != 1 || !ar[0]->asMacroTemplate()) {
                lyxerr << "Cannot read macro from '" << ar << "'" << endl;
                asArray(from_ascii("invalidmacro"), cell(0));
-               // FIXME: The macro template does not make sense after this.
-               // The whole parsing should not be in a constructor which
-               // has no chance to report failure.
-               return;
+               // The macro template does not make sense after this.
+               return false;
        }
        operator=( *(ar[0]->asMacroTemplate()) );
 
        updateLook();
+       return true;
 }
 
 
@@ -465,7 +459,7 @@ docstring MathMacroTemplate::name() const
 }
 
 
-void MathMacroTemplate::updateToContext(MacroContext const & mc) const
+void MathMacroTemplate::updateToContext(MacroContext const & mc)
 {
        redefinition_ = mc.get(name()) != 0;
 }
@@ -546,18 +540,14 @@ void MathMacroTemplate::createLook(int args) const
 
 void MathMacroTemplate::metrics(MetricsInfo & mi, Dimension & dim) const
 {
-       FontSetChanger dummy1(mi.base, from_ascii("mathnormal"));
-       StyleChanger dummy2(mi.base, LM_ST_TEXT);
+       Changer dummy1 = mi.base.changeFontSet("mathnormal");
+       Changer dummy2 = mi.base.font.changeStyle(LM_ST_TEXT);
 
        // valid macro?
        MacroData const * macro = 0;
-       if (validName()) {
+       if (validName())
                macro = mi.macrocontext.get(name());
 
-               // updateToContext() - avoids another lookup
-               redefinition_ = macro != 0;
-       }
-
        // update look?
        int argsInDef = maxArgumentInDefinition();
        if (lookOutdated_ || argsInDef != argsInLook_) {
@@ -585,25 +575,23 @@ void MathMacroTemplate::metrics(MetricsInfo & mi, Dimension & dim) const
        dim.wid += 6;
        dim.des += 2;
        dim.asc += 2;
-
-       setDimCache(mi, dim);
 }
 
 
 void MathMacroTemplate::draw(PainterInfo & pi, int x, int y) const
 {
-       ColorChanger dummy0(pi.base.font, Color_math);
-       FontSetChanger dummy1(pi.base, from_ascii("mathnormal"));
-       StyleChanger dummy2(pi.base, LM_ST_TEXT);
+       // FIXME: Calling Changer on the same object repeatedly is inefficient.
+       Changer dummy0 = pi.base.font.changeColor(Color_math);
+       Changer dummy1 = pi.base.changeFontSet("mathnormal");
+       Changer dummy2 = pi.base.font.changeStyle(LM_ST_TEXT);
 
-       setPosCache(pi, x, y);
        Dimension const dim = dimension(*pi.base.bv);
 
        // draw outer frame
        int const a = y - dim.asc + 1;
        int const w = dim.wid - 2;
        int const h = dim.height() - 2;
-       pi.pain.rectangle(x, a, w, h, Color_mathframe);
+       pi.pain.rectangle(x + 1, a, w, h, Color_mathframe);
 
        // just to be sure: set some dummy values for coord cache
        for (idx_type i = 0; i < nargs(); ++i)
@@ -624,10 +612,13 @@ void MathMacroTemplate::edit(Cursor & cur, bool front, EntryDirection entry_from
 
 bool MathMacroTemplate::notifyCursorLeaves(Cursor const & old, Cursor & cur)
 {
+       unsigned int const nargs_before = nargs();
        commitEditChanges(cur, old);
        updateLook();
        cur.screenUpdateFlags(Update::Force);
-       return InsetMathNest::notifyCursorLeaves(old, cur);
+       // If we have removed a cell, we might have invalidated the cursor
+       return InsetMathNest::notifyCursorLeaves(old, cur)
+               || nargs() < nargs_before;
 }
 
 
@@ -737,14 +728,14 @@ public:
        ///
        AddRemoveMacroInstanceFix(int n, bool insert) : n_(n), insert_(insert) {}
        ///
-       bool operator()(MathMacro * macro) {
+       void operator()(MathMacro * macro)
+       {
                if (macro->folded()) {
                        if (insert_)
                                macro->insertArgument(n_);
                        else
                                macro->removeArgument(n_);
                }
-               return true;
        }
 
 private:
@@ -762,9 +753,9 @@ public:
        ///
        OptionalsMacroInstanceFix(int optionals) : optionals_(optionals) {}
        ///
-       bool operator()(MathMacro * macro) {
+       void operator()(MathMacro * macro)
+       {
                macro->setOptionals(optionals_);
-               return true;
        }
 
 private:
@@ -778,7 +769,7 @@ class NullMacroInstanceFix
 {
 public:
        ///
-       bool operator()(MathMacro * ) { return false; }
+       void operator()(MathMacro * ) {}
 };
 
 
@@ -833,7 +824,8 @@ void fixMacroInstances(Cursor & cur, DocIterator const & inset_pos,
 
                MathMacro * macro = insetMath->asMacro();
                if (macro && macro->name() == name && macro->folded()) {
-                       if (fix(macro) && RenderPreview::status() == LyXRC::PREVIEW_ON)
+                       fix(macro);
+                       if (RenderPreview::previewMath())
                                preview_reload_needed = true;
                }
        }
@@ -845,7 +837,7 @@ void fixMacroInstances(Cursor & cur, DocIterator const & inset_pos,
                for (; sit != end; ++sit) {
                        InsetMathHull * inset_hull =
                                sit->nextInset()->asInsetMath()->asHullInset();
-                       LASSERT(inset_hull, /**/);
+                       LBUFERR(inset_hull);
                        inset_hull->reloadPreview(*sit);
                }
                cur.screenUpdateFlags(Update::Force);
@@ -858,7 +850,9 @@ void MathMacroTemplate::commitEditChanges(Cursor & cur,
 {
        int args_in_def = maxArgumentInDefinition();
        if (args_in_def != numargs_) {
-               cur.recordUndoFullDocument();
+               // FIXME: implement precise undo handling (only a few places
+               //   need undo)
+               cur.recordUndoFullBuffer();
                changeArity(cur, inset_pos, args_in_def);
        }
        insertMissingArguments(args_in_def);
@@ -874,7 +868,7 @@ void MathMacroTemplate::insertParameter(Cursor & cur,
 {
        if (pos <= numargs_ && pos >= optionals_ && numargs_ < 9) {
                ++numargs_;
-               
+
                // append example #n
                if (addarg) {
                        shiftArguments(pos, 1);
@@ -991,9 +985,11 @@ void MathMacroTemplate::doDispatch(Cursor & cur, FuncRequest & cmd)
        case LFUN_MATH_MACRO_ADD_PARAM:
                if (numargs_ < 9) {
                        commitEditChanges(cur, cur);
-                       cur.recordUndoFullDocument();
+                       // FIXME: implement precise undo handling (only a few places
+                       //   need undo)
+                       cur.recordUndoFullBuffer();
                        size_t pos = numargs_;
-                       if (arg.size() != 0)
+                       if (!arg.empty())
                                pos = (size_t)convert<int>(arg) - 1; // it is checked for >=0 in getStatus
                        insertParameter(cur, cur, pos);
                }
@@ -1003,9 +999,11 @@ void MathMacroTemplate::doDispatch(Cursor & cur, FuncRequest & cmd)
        case LFUN_MATH_MACRO_REMOVE_PARAM:
                if (numargs_ > 0) {
                        commitEditChanges(cur, cur);
-                       cur.recordUndoFullDocument();
+                       // FIXME: implement precise undo handling (only a few places
+                       //   need undo)
+                       cur.recordUndoFullBuffer();
                        size_t pos = numargs_ - 1;
-                       if (arg.size() != 0)
+                       if (!arg.empty())
                                pos = (size_t)convert<int>(arg) - 1; // it is checked for >=0 in getStatus
                        removeParameter(cur, cur, pos);
                }
@@ -1014,7 +1012,9 @@ void MathMacroTemplate::doDispatch(Cursor & cur, FuncRequest & cmd)
        case LFUN_MATH_MACRO_APPEND_GREEDY_PARAM:
                if (numargs_ < 9) {
                        commitEditChanges(cur, cur);
-                       cur.recordUndoFullDocument();
+                       // FIXME: implement precise undo handling (only a few places
+                       //   need undo)
+                       cur.recordUndoFullBuffer();
                        insertParameter(cur, cur, numargs_, true);
                }
                break;
@@ -1022,27 +1022,35 @@ void MathMacroTemplate::doDispatch(Cursor & cur, FuncRequest & cmd)
        case LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM:
                if (numargs_ > 0) {
                        commitEditChanges(cur, cur);
-                       cur.recordUndoFullDocument();
+                       // FIXME: implement precise undo handling (only a few places
+                       //   need undo)
+                       cur.recordUndoFullBuffer();
                        removeParameter(cur, cur, numargs_ - 1, true);
                }
                break;
 
        case LFUN_MATH_MACRO_MAKE_OPTIONAL:
                commitEditChanges(cur, cur);
-               cur.recordUndoFullDocument();
+               // FIXME: implement precise undo handling (only a few places
+               //   need undo)
+               cur.recordUndoFullBuffer();
                makeOptional(cur, cur);
                break;
 
        case LFUN_MATH_MACRO_MAKE_NONOPTIONAL:
                commitEditChanges(cur, cur);
-               cur.recordUndoFullDocument();
+               // FIXME: implement precise undo handling (only a few places
+               //   need undo)
+               cur.recordUndoFullBuffer();
                makeNonOptional(cur, cur);
                break;
 
        case LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM:
                if (numargs_ < 9) {
                        commitEditChanges(cur, cur);
-                       cur.recordUndoFullDocument();
+                       // FIXME: implement precise undo handling (only a few places
+                       //   need undo)
+                       cur.recordUndoFullBuffer();
                        insertParameter(cur, cur, optionals_);
                        makeOptional(cur, cur);
                }
@@ -1051,14 +1059,18 @@ void MathMacroTemplate::doDispatch(Cursor & cur, FuncRequest & cmd)
        case LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM:
                if (optionals_ > 0) {
                        commitEditChanges(cur, cur);
-                       cur.recordUndoFullDocument();
+                       // FIXME: implement precise undo handling (only a few places
+                       //   need undo)
+                       cur.recordUndoFullBuffer();
                        removeParameter(cur, cur, optionals_ - 1);
                } break;
 
        case LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM:
                if (numargs_ == optionals_) {
                        commitEditChanges(cur, cur);
-                       cur.recordUndoFullDocument();
+                       // FIXME: implement precise undo handling (only a few places
+                       //   need undo)
+                       cur.recordUndoFullBuffer();
                        insertParameter(cur, cur, 0, true);
                        makeOptional(cur, cur);
                }
@@ -1071,7 +1083,7 @@ void MathMacroTemplate::doDispatch(Cursor & cur, FuncRequest & cmd)
 }
 
 
-bool MathMacroTemplate::getStatus(Cursor & /*cur*/, FuncRequest const & cmd,
+bool MathMacroTemplate::getStatus(Cursor & cur, FuncRequest const & cmd,
        FuncStatus & flag) const
 {
        bool ret = true;
@@ -1079,7 +1091,7 @@ bool MathMacroTemplate::getStatus(Cursor & /*cur*/, FuncRequest const & cmd,
        switch (cmd.action()) {
                case LFUN_MATH_MACRO_ADD_PARAM: {
                        int num = numargs_ + 1;
-                       if (arg.size() != 0)
+                       if (!arg.empty())
                                num = convert<int>(arg);
                        bool on = (num >= optionals_
                                   && numargs_ < 9 && num <= numargs_ + 1);
@@ -1094,7 +1106,7 @@ bool MathMacroTemplate::getStatus(Cursor & /*cur*/, FuncRequest const & cmd,
                case LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM:
                case LFUN_MATH_MACRO_REMOVE_PARAM: {
                        int num = numargs_;
-                       if (arg.size() != 0)
+                       if (!arg.empty())
                                num = convert<int>(arg);
                        flag.setEnabled(num >= 1 && num <= numargs_);
                        break;
@@ -1129,7 +1141,7 @@ bool MathMacroTemplate::getStatus(Cursor & /*cur*/, FuncRequest const & cmd,
                        break;
 
                default:
-                       ret = false;
+                       ret = InsetMathNest::getStatus(cur, cmd, flag);
                        break;
        }
        return ret;
@@ -1154,7 +1166,8 @@ void MathMacroTemplate::read(Lexer & lex)
 void MathMacroTemplate::write(ostream & os) const
 {
        odocstringstream oss;
-       WriteStream wi(oss, false, false, WriteStream::wsDefault);
+       otexrowstream ots(oss);
+       WriteStream wi(ots, false, false, WriteStream::wsDefault);
        oss << "FormulaMacro\n";
        write(wi);
        os << to_utf8(oss.str());
@@ -1251,10 +1264,10 @@ docstring MathMacroTemplate::xhtml(XHTMLStream &, OutputParams const &) const
        return docstring();
 }
 
-int MathMacroTemplate::plaintext(odocstream & os,
-                                OutputParams const &) const
+int MathMacroTemplate::plaintext(odocstringstream & os,
+                                OutputParams const &, size_t) const
 {
-       static docstring const str = '[' + buffer().B_("math macro") + ']';
+       docstring const str = '[' + buffer().B_("math macro") + ']';
 
        os << str;
        return str.size();
@@ -1265,8 +1278,7 @@ bool MathMacroTemplate::validName() const
 {
        docstring n = name();
 
-       // empty name?
-       if (n.size() == 0)
+       if (n.empty())
                return false;
 
        // converting back and force doesn't swallow anything?
@@ -1315,7 +1327,7 @@ bool MathMacroTemplate::fixNameAndCheckIfValid()
        }
 
        // now it should be valid if anything in the name survived
-       return data.size() > 0;
+       return !data.empty();
 }
 
        
@@ -1362,13 +1374,28 @@ size_t MathMacroTemplate::numOptionals() const
 
 void MathMacroTemplate::infoize(odocstream & os) const
 {
-       os << "Math Macro: \\" << name();
+       os << bformat(_("Math Macro: \\%1$s"), name());
 }
 
 
-docstring MathMacroTemplate::contextMenuName() const
+string MathMacroTemplate::contextMenuName() const
 {
-       return from_ascii("context-math-macro-definition");
+       return "context-math-macro-definition";
 }
 
+
+void MathMacroTemplate::addToToc(DocIterator const & pit, bool output_active,
+                                                                UpdateType, TocBackend & backend) const
+{
+       docstring str;
+       if (!validMacro())
+               str = bformat(_("Invalid macro! \\%1$s"), name());
+       else
+               str = "\\" + name();
+       TocBuilder & b = backend.builder("math-macro");
+       b.pushItem(pit, str, output_active);
+       b.pop();
+}
+
+
 } // namespace lyx