* 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
+ * \author Stefan Schimanski
*
* Full author contact details are available in file CREDITS.
*/
#include "LaTeXFeatures.h"
#include "InsetMathBrace.h"
#include "InsetMathChar.h"
+#include "InsetMathHull.h"
#include "InsetMathSqrt.h"
#include "MathMacro.h"
#include "MathMacroArgument.h"
#include "FuncRequest.h"
#include "FuncStatus.h"
#include "Lexer.h"
-#include "Undo.h"
+#include "LyXRC.h"
#include "frontends/Painter.h"
+#include "insets/RenderPreview.h"
+
+#include "support/lassert.h"
#include "support/convert.h"
#include "support/debug.h"
#include "support/gettext.h"
#include "support/docstream.h"
#include "support/lstrings.h"
+#include <set>
#include <sstream>
using namespace std;
class InsetLabelBox : public InsetMathNest {
public:
///
- InsetLabelBox(MathAtom const & atom, docstring label,
+ InsetLabelBox(Buffer * buf, MathAtom const & atom, docstring label,
MathMacroTemplate const & parent, bool frame = false);
- InsetLabelBox(docstring label, MathMacroTemplate const & parent,
+ InsetLabelBox(Buffer * buf, docstring label, MathMacroTemplate const & parent,
bool frame = false);
///
void metrics(MetricsInfo & mi, Dimension & dim) const;
};
-InsetLabelBox::InsetLabelBox(MathAtom const & atom, docstring label,
- MathMacroTemplate const & parent, bool frame)
-: InsetMathNest(1), parent_(parent), label_(label), frame_(frame)
+InsetLabelBox::InsetLabelBox(Buffer * buf, MathAtom const & atom, docstring label,
+ MathMacroTemplate const & parent, bool frame)
+ : InsetMathNest(buf, 1), parent_(parent), label_(label), frame_(frame)
{
cell(0).insert(0, atom);
}
-InsetLabelBox::InsetLabelBox(docstring label,
+InsetLabelBox::InsetLabelBox(Buffer * buf, docstring label,
MathMacroTemplate const & parent, bool frame)
-: InsetMathNest(1), parent_(parent), label_(label), frame_(frame)
+ : InsetMathNest(buf, 1), parent_(parent), label_(label), frame_(frame)
{
}
class DisplayLabelBox : public InsetLabelBox {
public:
///
- DisplayLabelBox(MathAtom const & atom, docstring label,
+ DisplayLabelBox(Buffer * buf, MathAtom const & atom, docstring label,
MathMacroTemplate const & parent);
///
};
-DisplayLabelBox::DisplayLabelBox(MathAtom const & atom,
+DisplayLabelBox::DisplayLabelBox(Buffer * buf, MathAtom const & atom,
docstring label,
MathMacroTemplate const & parent)
- : InsetLabelBox(atom, label, parent, true)
+ : InsetLabelBox(buf, atom, label, parent, true)
{
}
}
+///////////////////////////////////////////////////////////////////////
+class InsetColoredCell : public InsetMathNest {
+public:
+ ///
+ InsetColoredCell(Buffer * buf, ColorCode min, ColorCode max);
+ ///
+ InsetColoredCell(Buffer * buf, ColorCode min, ColorCode max, MathAtom const & atom);
+ ///
+ void draw(PainterInfo &, int x, int y) const;
+ ///
+ void metrics(MetricsInfo & mi, Dimension & dim) const;
+
+protected:
+ ///
+ Inset * clone() const;
+ ///
+ ColorCode min_;
+ ///
+ ColorCode max_;
+};
+
+
+InsetColoredCell::InsetColoredCell(Buffer * buf, ColorCode min, ColorCode max)
+ : InsetMathNest(buf, 1), min_(min), max_(max)
+{
+}
+
+
+InsetColoredCell::InsetColoredCell(Buffer * buf, ColorCode min, ColorCode max, MathAtom const & atom)
+ : InsetMathNest(buf, 1), min_(min), max_(max)
+{
+ cell(0).insert(0, atom);
+}
+
+
+Inset * InsetColoredCell::clone() const
+{
+ return new InsetColoredCell(*this);
+}
+
+
+void InsetColoredCell::metrics(MetricsInfo & mi, Dimension & dim) const
+{
+ cell(0).metrics(mi, dim);
+}
+
+
+void InsetColoredCell::draw(PainterInfo & pi, int x, int y) const
+{
+ pi.pain.enterMonochromeMode(min_, max_);
+ cell(0).draw(pi, x, y);
+ pi.pain.leaveMonochromeMode();
+}
+
+
///////////////////////////////////////////////////////////////////////
class InsetNameWrapper : public InsetMathWrapper {
///////////////////////////////////////////////////////////////////////
-MathMacroTemplate::MathMacroTemplate()
- : InsetMathNest(3), numargs_(0), optionals_(0),
+MathMacroTemplate::MathMacroTemplate(Buffer * buf)
+ : InsetMathNest(buf, 3), numargs_(0), argsInLook_(0), optionals_(0),
type_(MacroTypeNewcommand), lookOutdated_(true)
{
initMath();
}
-MathMacroTemplate::MathMacroTemplate(docstring const & name, int numargs,
- int optionals, MacroType type,
- vector<MathData> const & optionalValues,
+MathMacroTemplate::MathMacroTemplate(Buffer * buf, docstring const & name, int numargs,
+ int optionals, MacroType type, vector<MathData> const & optionalValues,
MathData const & def, MathData const & display)
- : InsetMathNest(optionals + 3), numargs_(numargs),
+ : InsetMathNest(buf, optionals + 3), numargs_(numargs), argsInLook_(numargs),
optionals_(optionals), optionalValues_(optionalValues),
type_(type), lookOutdated_(true)
{
}
-MathMacroTemplate::MathMacroTemplate(docstring const & str)
- : InsetMathNest(3), numargs_(0), optionals_(0),
+MathMacroTemplate::MathMacroTemplate(Buffer * buf, docstring const & str)
+ : InsetMathNest(buf, 3), numargs_(0), optionals_(0),
type_(MacroTypeNewcommand), lookOutdated_(true)
{
+ buffer_ = buf;
initMath();
- MathData ar;
- mathed_parse_cell(ar, str);
+ MathData ar(buf);
+ 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));
}
-void MathMacroTemplate::createLook() const
+void MathMacroTemplate::createLook(int args) const
{
look_.clear();
+ argsInLook_ = args;
// \foo
- look_.push_back(MathAtom(new InsetLabelBox(_("Name"), *this, false)));
+ look_.push_back(MathAtom(
+ new InsetLabelBox(buffer_, _("Name"), *this, false)));
MathData & nameData = look_[look_.size() - 1].nucleus()->cell(0);
nameData.push_back(MathAtom(new InsetNameWrapper(&cell(0), *this)));
// [#1][#2]
int i = 0;
if (optionals_ > 0) {
- look_.push_back(MathAtom(new InsetLabelBox(_("optional"), *this, false)));
- MathData & optData = look_[look_.size() - 1].nucleus()->cell(0);
-
+ look_.push_back(MathAtom(
+ new InsetLabelBox(buffer_, _("optional"), *this, false)));
+
+ MathData * optData = &look_[look_.size() - 1].nucleus()->cell(0);
for (; i < optionals_; ++i) {
- optData.push_back(MathAtom(new InsetMathChar('[')));
- optData.push_back(MathAtom(new InsetMathWrapper(&cell(1 + i))));
- optData.push_back(MathAtom(new InsetMathChar(']')));
+ // color it light grey, if it is to be removed when the cursor leaves
+ if (i == argsInLook_) {
+ optData->push_back(MathAtom(
+ new InsetColoredCell(buffer_, Color_mathbg, Color_mathmacrooldarg)));
+ optData = &(*optData)[optData->size() - 1].nucleus()->cell(0);
+ }
+
+ optData->push_back(MathAtom(new InsetMathChar('[')));
+ optData->push_back(MathAtom(new InsetMathWrapper(&cell(1 + i))));
+ optData->push_back(MathAtom(new InsetMathChar(']')));
}
}
for (; i < numargs_; ++i) {
MathData arg;
arg.push_back(MathAtom(new MathMacroArgument(i + 1)));
- look_.push_back(MathAtom(new InsetMathBrace(arg)));
+ if (i >= argsInLook_) {
+ look_.push_back(MathAtom(new InsetColoredCell(buffer_,
+ Color_mathbg, Color_mathmacrooldarg,
+ MathAtom(new InsetMathBrace(arg)))));
+ } else
+ look_.push_back(MathAtom(new InsetMathBrace(arg)));
}
-
+ for (; i < argsInLook_; ++i) {
+ MathData arg;
+ arg.push_back(MathAtom(new MathMacroArgument(i + 1)));
+ look_.push_back(MathAtom(new InsetColoredCell(buffer_,
+ Color_mathbg, Color_mathmacronewarg,
+ MathAtom(new InsetMathBrace(arg)))));
+ }
+
// :=
look_.push_back(MathAtom(new InsetMathChar(':')));
look_.push_back(MathAtom(new InsetMathChar('=')));
// definition
look_.push_back(MathAtom(
- new InsetLabelBox(MathAtom(
+ new InsetLabelBox(buffer_, MathAtom(
new InsetMathWrapper(&cell(defIdx()))), _("TeX"), *this, true)));
// display
look_.push_back(MathAtom(
- new DisplayLabelBox(MathAtom(
+ new DisplayLabelBox(buffer_, MathAtom(
new InsetMathWrapper(&cell(displayIdx()))), _("LyX"), *this)));
}
}
// update look?
- if (lookOutdated_) {
+ int argsInDef = maxArgumentInDefinition();
+ if (lookOutdated_ || argsInDef != argsInLook_) {
lookOutdated_ = false;
- createLook();
+ createLook(argsInDef);
}
/// metrics for inset contents
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);
pi.pain.rectangle(x, a, w, h, Color_mathframe);
// just to be sure: set some dummy values for coord cache
- for (idx_type i = 0; i < nargs(); ++i) {
+ for (idx_type i = 0; i < nargs(); ++i)
cell(i).setXY(*pi.base.bv, x, y);
- }
// draw contents
look_.draw(pi, x + 3, y);
void MathMacroTemplate::edit(Cursor & cur, bool front, EntryDirection entry_from)
{
updateLook();
- cur.updateFlags(Update::Force);
+ cur.screenUpdateFlags(Update::SinglePar);
InsetMathNest::edit(cur, front, entry_from);
}
-bool MathMacroTemplate::notifyCursorLeaves(Cursor & cur)
+bool MathMacroTemplate::notifyCursorLeaves(Cursor const & old, Cursor & cur)
{
+ commitEditChanges(cur, old);
updateLook();
- cur.updateFlags(Update::Force);
- return InsetMathNest::notifyCursorLeaves(cur);
+ cur.screenUpdateFlags(Update::Force);
+ return InsetMathNest::notifyCursorLeaves(old, cur);
}
-void MathMacroTemplate::removeArguments(Cursor & cur, int from, int to) {
- for (DocIterator it = doc_iterator_begin(*this); it; it.forwardChar()) {
+void MathMacroTemplate::removeArguments(Cursor & cur,
+ DocIterator const & /*inset_pos*/, int from, int to)
+{
+ DocIterator it = doc_iterator_begin(&buffer(), this);
+ for (; it; it.forwardChar()) {
if (!it.nextInset())
continue;
- if (it.nextInset()->lyxCode() != MATHMACROARG_CODE)
+ if (it.nextInset()->lyxCode() != MATH_MACROARG_CODE)
continue;
MathMacroArgument * arg = static_cast<MathMacroArgument*>(it.nextInset());
int n = arg->number() - 1;
}
-void MathMacroTemplate::shiftArguments(size_t from, int by) {
- for (DocIterator it = doc_iterator_begin(*this); it; it.forwardChar()) {
+void MathMacroTemplate::shiftArguments(size_t from, int by)
+{
+ for (DocIterator it = doc_iterator_begin(&buffer(), this); it; it.forwardChar()) {
if (!it.nextInset())
continue;
- if (it.nextInset()->lyxCode() != MATHMACROARG_CODE)
+ if (it.nextInset()->lyxCode() != MATH_MACROARG_CODE)
continue;
MathMacroArgument * arg = static_cast<MathMacroArgument*>(it.nextInset());
- if (arg->number() >= from + 1)
+ if (arg->number() >= int(from) + 1)
arg->setNumber(arg->number() + by);
}
}
-// FIXME: factorize those functions here with a functional style, maybe using Boost's function
-// objects?
+int MathMacroTemplate::maxArgumentInDefinition() const
+{
+ // We don't have a buffer when pasting from the clipboard (bug 6014).
+ Buffer const * macro_buffer = isBufferLoaded() ? &buffer() : 0;
+ int maxArg = 0;
+ DocIterator it = doc_iterator_begin(macro_buffer, this);
+ it.idx() = defIdx();
+ for (; it; it.forwardChar()) {
+ if (!it.nextInset())
+ continue;
+ if (it.nextInset()->lyxCode() != MATH_MACROARG_CODE)
+ continue;
+ MathMacroArgument * arg = static_cast<MathMacroArgument*>(it.nextInset());
+ maxArg = std::max(int(arg->number()), maxArg);
+ }
+ return maxArg;
+}
-void fixMacroInstancesAddRemove(Cursor const & from, docstring const & name, int n, bool insert) {
- Cursor dit = from;
- for (; dit; dit.forwardPos()) {
- // only until a macro is redefined
- if (dit.inset().lyxCode() == MATHMACRO_CODE) {
- MathMacroTemplate const & macroTemplate
- = static_cast<MathMacroTemplate const &>(dit.inset());
- if (macroTemplate.name() == name)
- break;
- }
+void MathMacroTemplate::insertMissingArguments(int maxArg)
+{
+ bool found[9] = { false, false, false, false, false, false, false, false, false };
+ idx_type idx = cell(displayIdx()).empty() ? defIdx() : displayIdx();
- // in front of macro instance?
- Inset * inset = dit.nextInset();
- if (!inset)
+ // search for #n macros arguments
+ DocIterator it = doc_iterator_begin(&buffer(), this);
+ it.idx() = idx;
+ for (; it && it[0].idx() == idx; it.forwardChar()) {
+ if (!it.nextInset())
continue;
- InsetMath * insetMath = inset->asInsetMath();
- if (!insetMath)
+ if (it.nextInset()->lyxCode() != MATH_MACROARG_CODE)
continue;
+ MathMacroArgument * arg = static_cast<MathMacroArgument*>(it.nextInset());
+ found[arg->number() - 1] = true;
+ }
- MathMacro * macro = insetMath->asMacro();
- if (macro && macro->name() == name && macro->folded()) {
- // found macro instance
- if (insert)
- macro->insertArgument(n);
- else
- macro->removeArgument(n);
- }
+ // add missing ones
+ for (int i = 0; i < maxArg; ++i) {
+ if (found[i])
+ continue;
+
+ cell(idx).push_back(MathAtom(new MathMacroArgument(i + 1)));
}
}
-void fixMacroInstancesOptional(Cursor const & from, docstring const & name, int optionals) {
- Cursor dit = from;
+void MathMacroTemplate::changeArity(Cursor & cur,
+ DocIterator const & inset_pos, int newNumArg)
+{
+ // remove parameter which do not appear anymore in the definition
+ for (int i = numargs_; i > newNumArg; --i)
+ removeParameter(cur, inset_pos, numargs_ - 1, true);
+
+ // add missing parameter
+ for (int i = numargs_; i < newNumArg; ++i)
+ insertParameter(cur, inset_pos, numargs_, true, false);
+}
- for (; dit; dit.forwardPos()) {
- // only until a macro is redefined
- if (dit.inset().lyxCode() == MATHMACRO_CODE) {
- MathMacroTemplate const & macroTemplate
- = static_cast<MathMacroTemplate const &>(dit.inset());
- if (macroTemplate.name() == name)
- break;
- }
- // in front of macro instance?
- Inset * inset = dit.nextInset();
- if (!inset)
- continue;
- InsetMath * insetMath = inset->asInsetMath();
- if (!insetMath)
- continue;
- MathMacro * macro = insetMath->asMacro();
- if (macro && macro->name() == name && macro->folded()) {
- // found macro instance
- macro->setOptionals(optionals);
+///
+class AddRemoveMacroInstanceFix
+{
+public:
+ ///
+ AddRemoveMacroInstanceFix(int n, bool insert) : n_(n), insert_(insert) {}
+ ///
+ void operator()(MathMacro * macro)
+ {
+ if (macro->folded()) {
+ if (insert_)
+ macro->insertArgument(n_);
+ else
+ macro->removeArgument(n_);
}
}
-}
+
+private:
+ ///
+ int n_;
+ ///
+ bool insert_;
+};
+
+
+///
+class OptionalsMacroInstanceFix
+{
+public:
+ ///
+ OptionalsMacroInstanceFix(int optionals) : optionals_(optionals) {}
+ ///
+ void operator()(MathMacro * macro)
+ {
+ macro->setOptionals(optionals_);
+ }
+
+private:
+ ///
+ int optionals_;
+};
+
+
+///
+class NullMacroInstanceFix
+{
+public:
+ ///
+ void operator()(MathMacro * ) {}
+};
template<class F>
-void fixMacroInstancesFunctional(Cursor const & from,
- docstring const & name, F & fix) {
- Cursor dit = from;
+void fixMacroInstances(Cursor & cur, DocIterator const & inset_pos,
+ docstring const & name, F & fix)
+{
+ // goto position behind macro template
+ DocIterator dit = inset_pos;
+ dit.pop_back();
+ dit.top().forwardPos();
+
+ // remember hull to trigger preview reload
+ DocIterator hull(dit.buffer());
+ bool preview_reload_needed = false;
+ set<DocIterator> preview_hulls;
+ // iterate over all positions until macro is redefined
for (; dit; dit.forwardPos()) {
+ // left the outer hull?
+ if (!hull.empty() && dit.depth() == hull.depth()) {
+ // schedule reload of the preview if necessary
+ if (preview_reload_needed) {
+ preview_hulls.insert(hull);
+ preview_reload_needed = false;
+ }
+ hull.clear();
+ }
+
// only until a macro is redefined
if (dit.inset().lyxCode() == MATHMACRO_CODE) {
MathMacroTemplate const & macroTemplate
InsetMath * insetMath = inset->asInsetMath();
if (!insetMath)
continue;
+
+ // in front of outer hull?
+ InsetMathHull * inset_hull = insetMath->asHullInset();
+ if (inset_hull && hull.empty()) {
+ // remember this for later preview reload
+ hull = dit;
+ }
+
MathMacro * macro = insetMath->asMacro();
- if (macro && macro->name() == name && macro->folded())
- F(macro);
+ if (macro && macro->name() == name && macro->folded()) {
+ fix(macro);
+ if (RenderPreview::status() == LyXRC::PREVIEW_ON)
+ preview_reload_needed = true;
+ }
+ }
+
+ if (!preview_hulls.empty()) {
+ // reload the scheduled previews
+ set<DocIterator>::const_iterator sit = preview_hulls.begin();
+ set<DocIterator>::const_iterator end = preview_hulls.end();
+ for (; sit != end; ++sit) {
+ InsetMathHull * inset_hull =
+ sit->nextInset()->asInsetMath()->asHullInset();
+ LASSERT(inset_hull, /**/);
+ inset_hull->reloadPreview(*sit);
+ }
+ cur.screenUpdateFlags(Update::Force);
+ }
+}
+
+
+void MathMacroTemplate::commitEditChanges(Cursor & cur,
+ DocIterator const & inset_pos)
+{
+ int args_in_def = maxArgumentInDefinition();
+ if (args_in_def != numargs_) {
+ cur.recordUndoFullDocument();
+ changeArity(cur, inset_pos, args_in_def);
}
+ insertMissingArguments(args_in_def);
+
+ // make sure the preview are up to date
+ NullMacroInstanceFix fix;
+ fixMacroInstances(cur, inset_pos, name(), fix);
}
-void MathMacroTemplate::insertParameter(Cursor & cur, int pos, bool greedy)
+void MathMacroTemplate::insertParameter(Cursor & cur,
+ DocIterator const & inset_pos, int pos, bool greedy, bool addarg)
{
if (pos <= numargs_ && pos >= optionals_ && numargs_ < 9) {
++numargs_;
- shiftArguments(pos, 1);
-
+
// append example #n
- cell(defIdx()).push_back(MathAtom(new MathMacroArgument(pos + 1)));
- if (!cell(displayIdx()).empty())
- cell(displayIdx()).push_back(MathAtom(new MathMacroArgument(pos + 1)));
+ if (addarg) {
+ shiftArguments(pos, 1);
- if (!greedy) {
- Cursor dit = cur;
- dit.leaveInset(*this);
- // TODO: this was dit.forwardPosNoDescend before. Check that this is the same
- dit.top().forwardPos();
+ cell(defIdx()).push_back(MathAtom(new MathMacroArgument(pos + 1)));
+ if (!cell(displayIdx()).empty())
+ cell(displayIdx()).push_back(MathAtom(new MathMacroArgument(pos + 1)));
+ }
+ if (!greedy) {
// fix macro instances
- fixMacroInstancesAddRemove(dit, name(), pos, true);
+ AddRemoveMacroInstanceFix fix(pos, true);
+ fixMacroInstances(cur, inset_pos, name(), fix);
}
}
}
-void MathMacroTemplate::removeParameter(Cursor & cur, int pos, bool greedy)
+void MathMacroTemplate::removeParameter(Cursor & cur,
+ DocIterator const & inset_pos, int pos, bool greedy)
{
if (pos < numargs_ && pos >= 0) {
--numargs_;
- removeArguments(cur, pos, pos);
+ removeArguments(cur, inset_pos, pos, pos);
shiftArguments(pos + 1, -1);
// removed optional parameter?
if (!greedy) {
// fix macro instances
- //boost::function<void(MathMacro *)> fix = _1->insertArgument(n);
- //fixMacroInstancesFunctional(dit, name(), fix);
- Cursor dit = cur;
- dit.leaveInset(*this);
- // TODO: this was dit.forwardPosNoDescend before. Check that this is the same
- dit.top().forwardPos();
- fixMacroInstancesAddRemove(dit, name(), pos, false);
+ AddRemoveMacroInstanceFix fix(pos, false);
+ fixMacroInstances(cur, inset_pos, name(), fix);
}
}
}
-void MathMacroTemplate::makeOptional(Cursor & cur) {
+void MathMacroTemplate::makeOptional(Cursor & cur,
+ DocIterator const & inset_pos)
+{
if (numargs_ > 0 && optionals_ < numargs_) {
++optionals_;
cells_.insert(cells_.begin() + optIdx(optionals_ - 1), optionalValues_[optionals_ - 1]);
++cur[macroSlice].idx();
// fix macro instances
- Cursor dit = cur;
- dit.leaveInset(*this);
- // TODO: this was dit.forwardPosNoDescend before. Check that this is the same
- dit.top().forwardPos();
- fixMacroInstancesOptional(dit, name(), optionals_);
+ OptionalsMacroInstanceFix fix(optionals_);
+ fixMacroInstances(cur, inset_pos, name(), fix);
}
updateLook();
}
-void MathMacroTemplate::makeNonOptional(Cursor & cur) {
+void MathMacroTemplate::makeNonOptional(Cursor & cur,
+ DocIterator const & inset_pos)
+{
if (numargs_ > 0 && optionals_ > 0) {
--optionals_;
- // store default value for later if the use changes his mind
+ // store default value for later if the user changes his mind
optionalValues_[optionals_] = cell(optIdx(optionals_));
cells_.erase(cells_.begin() + optIdx(optionals_));
}
// fix macro instances
- Cursor dit = cur;
- dit.leaveInset(*this);
- // TODO: this was dit.forwardPosNoDescend before. Check that this is the same
- dit.top().forwardPos();
- fixMacroInstancesOptional(dit, name(), optionals_);
+ OptionalsMacroInstanceFix fix(optionals_);
+ fixMacroInstances(cur, inset_pos, name(), fix);
}
updateLook();
void MathMacroTemplate::doDispatch(Cursor & cur, FuncRequest & cmd)
{
string const arg = to_utf8(cmd.argument());
- switch (cmd.action) {
+ switch (cmd.action()) {
case LFUN_MATH_MACRO_ADD_PARAM:
if (numargs_ < 9) {
+ commitEditChanges(cur, cur);
cur.recordUndoFullDocument();
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, pos);
+ insertParameter(cur, cur, pos);
}
break;
case LFUN_MATH_MACRO_REMOVE_PARAM:
if (numargs_ > 0) {
+ commitEditChanges(cur, cur);
cur.recordUndoFullDocument();
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, pos);
+ removeParameter(cur, cur, pos);
}
break;
case LFUN_MATH_MACRO_APPEND_GREEDY_PARAM:
if (numargs_ < 9) {
+ commitEditChanges(cur, cur);
cur.recordUndoFullDocument();
- insertParameter(cur, numargs_, true);
+ insertParameter(cur, cur, numargs_, true);
}
break;
case LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM:
if (numargs_ > 0) {
+ commitEditChanges(cur, cur);
cur.recordUndoFullDocument();
- removeParameter(cur, numargs_ - 1, true);
+ removeParameter(cur, cur, numargs_ - 1, true);
}
break;
case LFUN_MATH_MACRO_MAKE_OPTIONAL:
+ commitEditChanges(cur, cur);
cur.recordUndoFullDocument();
- makeOptional(cur);
+ makeOptional(cur, cur);
break;
case LFUN_MATH_MACRO_MAKE_NONOPTIONAL:
+ commitEditChanges(cur, cur);
cur.recordUndoFullDocument();
- makeNonOptional(cur);
+ makeNonOptional(cur, cur);
break;
case LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM:
if (numargs_ < 9) {
+ commitEditChanges(cur, cur);
cur.recordUndoFullDocument();
- insertParameter(cur, optionals_);
- makeOptional(cur);
+ insertParameter(cur, cur, optionals_);
+ makeOptional(cur, cur);
}
break;
case LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM:
if (optionals_ > 0) {
+ commitEditChanges(cur, cur);
cur.recordUndoFullDocument();
- removeParameter(cur, optionals_ - 1);
+ removeParameter(cur, cur, optionals_ - 1);
} break;
case LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM:
if (numargs_ == optionals_) {
+ commitEditChanges(cur, cur);
cur.recordUndoFullDocument();
- insertParameter(cur, 0, true);
- makeOptional(cur);
+ insertParameter(cur, cur, 0, true);
+ makeOptional(cur, cur);
}
break;
{
bool ret = true;
string const arg = to_utf8(cmd.argument());
- switch (cmd.action) {
+ 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);
- flag.enabled(on);
+ flag.setEnabled(on);
break;
}
case LFUN_MATH_MACRO_APPEND_GREEDY_PARAM:
- flag.enabled(numargs_ < 9);
+ flag.setEnabled(numargs_ < 9);
break;
+ 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.enabled(num >= 1 && num <= numargs_);
+ flag.setEnabled(num >= 1 && num <= numargs_);
break;
}
case LFUN_MATH_MACRO_MAKE_OPTIONAL:
- flag.enabled(numargs_ > 0
+ flag.setEnabled(numargs_ > 0
&& optionals_ < numargs_
&& type_ != MacroTypeDef);
break;
case LFUN_MATH_MACRO_MAKE_NONOPTIONAL:
- flag.enabled(optionals_ > 0
+ flag.setEnabled(optionals_ > 0
&& type_ != MacroTypeDef);
break;
case LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM:
- flag.enabled(numargs_ < 9);
+ flag.setEnabled(numargs_ < 9);
break;
case LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM:
- flag.enabled(optionals_ > 0);
+ flag.setEnabled(optionals_ > 0);
break;
case LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM:
- flag.enabled(numargs_ == 0
+ flag.setEnabled(numargs_ == 0
&& type_ != MacroTypeDef);
break;
case LFUN_IN_MATHMACROTEMPLATE:
- flag.enabled();
+ flag.setEnabled(true);
break;
default:
}
-void MathMacroTemplate::read(Buffer const &, Lexer & lex)
+void MathMacroTemplate::read(Lexer & lex)
{
- MathData ar;
- mathed_parse_cell(ar, lex.getStream());
+ MathData ar(buffer_);
+ mathed_parse_cell(ar, lex.getStream(), Parse::TRACKMACRO);
if (ar.size() != 1 || !ar[0]->asMacroTemplate()) {
lyxerr << "Cannot read macro from '" << ar << "'" << endl;
lyxerr << "Read: " << to_utf8(asString(ar)) << endl;
}
-void MathMacroTemplate::write(Buffer const &, ostream & os) const
+void MathMacroTemplate::write(ostream & os) const
{
odocstringstream oss;
- WriteStream wi(oss, false, false);
+ WriteStream wi(oss, false, false, WriteStream::wsDefault);
oss << "FormulaMacro\n";
write(wi);
os << to_utf8(oss.str());
}
-void MathMacroTemplate::write(WriteStream & os, bool overwriteRedefinition) const
+int MathMacroTemplate::write(WriteStream & os, bool overwriteRedefinition) const
{
- // newcommand or renewcommand
- if (os.latex() && optionals_ > 1)
- os << "\\newlyxcommand";
- else {
+ int num_lines = 0;
+
+ if (os.latex()) {
+ if (optionals_ > 0) {
+ // macros with optionals use the xargs package, e.g.:
+ // \newcommandx{\foo}[2][usedefault, addprefix=\global,1=default]{#1,#2}
+ // \long is implicit by xargs
+ if (redefinition_ && !overwriteRedefinition)
+ os << "\\renewcommandx";
+ else
+ os << "\\newcommandx";
+
+ os << "\\" << name()
+ << "[" << numargs_ << "]"
+ << "[usedefault, addprefix=\\global";
+ for (int i = 0; i < optionals_; ++i) {
+ docstring optValue = asString(cell(optIdx(i)));
+ if (optValue.find(']') != docstring::npos
+ || optValue.find(',') != docstring::npos)
+ os << ", " << i + 1 << "="
+ << "{" << cell(optIdx(i)) << "}";
+ else
+ os << ", " << i + 1 << "="
+ << cell(optIdx(i));
+ }
+ os << "]";
+ } else {
+ // Macros without optionals use standard _global_ \def macros:
+ // \global\def\long\foo#1#2{#1,#2}
+ // We use the \long prefix as this is the equivalent to \newcommand.
+ // We cannot use \newcommand directly because \global does not work with it.
+ os << "\\global\\long\\def\\" << name();
+ docstring param = from_ascii("#0");
+ for (int i = 1; i <= numargs_; ++i) {
+ param[1] = '0' + i;
+ os << param;
+ }
+ }
+ } else {
+ // in LyX output we use some pseudo syntax which is implementation
+ // independent, e.g.
+ // \newcommand{\foo}[2][default]{#1,#2}
if (redefinition_ && !overwriteRedefinition)
os << "\\renewcommand";
else
os << "\\newcommand";
- }
- os << "{\\" << name().c_str() << '}';
- if (numargs_ > 0)
- os << '[' << numargs_ << ']';
-
- // optional values
- for (int i = 0; i < optionals_; ++i) {
- docstring optValue = asString(cell(optIdx(i)));
- if (optValue.find(']') != docstring::npos)
- os << "[{" << cell(optIdx(i)) << "}]";
- else
- os << "[" << cell(optIdx(i)) << "]";
+ os << "{\\" << name() << '}';
+ if (numargs_ > 0)
+ os << '[' << numargs_ << ']';
+
+ for (int i = 0; i < optionals_; ++i) {
+ docstring optValue = asString(cell(optIdx(i)));
+ if (optValue.find(']') != docstring::npos)
+ os << "[{" << cell(optIdx(i)) << "}]";
+ else
+ os << "[" << cell(optIdx(i)) << "]";
+ }
}
os << "{" << cell(defIdx()) << "}";
if (os.latex()) {
// writing .tex. done.
os << "\n";
+ ++num_lines;
} else {
// writing .lyx, write special .tex export only if necessary
- if (!cell(displayIdx()).empty())
+ if (!cell(displayIdx()).empty()) {
os << "\n{" << cell(displayIdx()) << '}';
+ ++num_lines;
+ }
}
+
+ return num_lines;
}
-int MathMacroTemplate::plaintext(Buffer const & buf, odocstream & os,
+docstring MathMacroTemplate::xhtml(XHTMLStream &, OutputParams const &) const
+{
+ return docstring();
+}
+
+int MathMacroTemplate::plaintext(odocstream & os,
OutputParams const &) const
{
- static docstring const str = '[' + buf.B_("math macro") + ']';
+ static docstring const str = '[' + buffer().B_("math macro") + ']';
os << str;
return str.size();
{
docstring n = name();
- // empty name?
- if (n.size() == 0)
+ if (n.empty())
return false;
// converting back and force doesn't swallow anything?
// valid characters?
for (size_t i = 0; i < n.size(); ++i) {
- if (!(n[i] >= 'a' && n[i] <= 'z') &&
- !(n[i] >= 'A' && n[i] <= 'Z'))
+ if (!(n[i] >= 'a' && n[i] <= 'z')
+ && !(n[i] >= 'A' && n[i] <= 'Z')
+ && n[i] != '*')
return false;
}
}
// now it should be valid if anything in the name survived
- return data.size() > 0;
+ return !data.empty();
}
void MathMacroTemplate::validate(LaTeXFeatures & features) const
{
- if (optionals_ > 1) {
- features.require("newlyxcommand");
- }
+ // we need global optional macro arguments. They are not available
+ // with \def, and \newcommand does not support global macros. So we
+ // are bound to xargs also for the single-optional-parameter case.
+ if (optionals_ > 0)
+ features.require("xargs");
}
void MathMacroTemplate::getDefaults(vector<docstring> & defaults) const
os << "Math Macro: \\" << name();
}
+
+string MathMacroTemplate::contextMenuName() const
+{
+ return "context-math-macro-definition";
+}
+
} // namespace lyx
projects / lyx.git / blobdiff