X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Fmathed%2FMathMacro.cpp;h=78ea2bb3654913789464948ac5efeb8a89684fec;hb=c9d9309c1ecffa218dee04ce4f7991ed4fc0c9bb;hp=b84df70e16ae9a201a76c07daca5fb090f5af365;hpb=6a9e5edae323d8df8a0cc7df7d6e19d080d90cc9;p=lyx.git

diff --git a/src/mathed/MathMacro.cpp b/src/mathed/MathMacro.cpp
index b84df70e16..78ea2bb365 100644
--- a/src/mathed/MathMacro.cpp
+++ b/src/mathed/MathMacro.cpp
@@ -4,7 +4,7 @@
  * Licence details can be found in the file COPYING.
  *
  * \author Alejandro Aguilar Sierra
- * \author André Pönitz
+ * \author André Pönitz
  * \author Stefan Schimanski
  *
  * Full author contact details are available in file CREDITS.
@@ -13,24 +13,36 @@
 #include <config.h>
 
 #include "MathMacro.h"
-#include "MathSupport.h"
+
+#include "InsetMathChar.h"
+#include "MathCompletionList.h"
 #include "MathExtern.h"
+#include "MathFactory.h"
 #include "MathStream.h"
+#include "MathSupport.h"
 
 #include "Buffer.h"
 #include "BufferView.h"
+#include "CoordCache.h"
 #include "Cursor.h"
-#include "support/debug.h"
-#include "LaTeXFeatures.h"
 #include "FuncStatus.h"
 #include "FuncRequest.h"
-#include "Undo.h"
+#include "LaTeXFeatures.h"
+#include "LyX.h"
+#include "LyXRC.h"
 
 #include "frontends/Painter.h"
 
+#include "support/debug.h"
+#include "support/gettext.h"
+#include "support/lassert.h"
+#include "support/lstrings.h"
+#include "support/textutils.h"
+
 #include <ostream>
 #include <vector>
 
+using namespace lyx::support;
 using namespace std;
 
 namespace lyx {
@@ -40,58 +52,83 @@ namespace lyx {
 class ArgumentProxy : public InsetMath {
 public:
 	///
-	ArgumentProxy(MathMacro & mathMacro, size_t idx) 
+	ArgumentProxy(MathMacro * mathMacro, size_t idx)
 		: mathMacro_(mathMacro), idx_(idx) {}
 	///
-	ArgumentProxy(MathMacro & mathMacro, size_t idx, docstring const & def) 
-		: mathMacro_(mathMacro), idx_(idx) 
+	ArgumentProxy(MathMacro * mathMacro, size_t idx, docstring const & def)
+		: mathMacro_(mathMacro), idx_(idx)
 	{
 			asArray(def, def_);
 	}
 	///
+	void setOwner(MathMacro * mathMacro) { mathMacro_ = mathMacro; }
+	///
+	InsetCode lyxCode() const { return ARGUMENT_PROXY_CODE; }
+	///
 	void metrics(MetricsInfo & mi, Dimension & dim) const {
-		mathMacro_.macro()->unlock();
-		mathMacro_.cell(idx_).metrics(mi, dim);
-		if (!mathMacro_.editing(mi.base.bv) && !def_.empty())
+		mathMacro_->macro()->unlock();
+		mathMacro_->cell(idx_).metrics(mi, dim);
+
+		if (!mathMacro_->editMetrics(mi.base.bv)
+		    && mathMacro_->cell(idx_).empty())
 			def_.metrics(mi, dim);
-		mathMacro_.macro()->lock();
+
+		mathMacro_->macro()->lock();
 	}
+	// write(), normalize(), infoize() and infoize2() are not needed since
+	// MathMacro uses the definition and not the expanded cells.
+	///
+	void maple(MapleStream & ms) const { ms << mathMacro_->cell(idx_); }
+	///
+	void maxima(MaximaStream & ms) const { ms << mathMacro_->cell(idx_); }
+	///
+	void mathematica(MathematicaStream & ms) const { ms << mathMacro_->cell(idx_); }
+	///
+	void mathmlize(MathStream & ms) const { ms << mathMacro_->cell(idx_); }
+	///
+	void htmlize(HtmlStream & ms) const { ms << mathMacro_->cell(idx_); }
+	///
+	void octave(OctaveStream & os) const { os << mathMacro_->cell(idx_); }
 	///
 	void draw(PainterInfo & pi, int x, int y) const {
-		if (mathMacro_.editing(pi.base.bv)) {
-			// The only way a ArgumentProxy can appear is in a cell of the 
-			// MathMacro. Moreover the cells are only drawn in the DISPLAY_FOLDED 
-			// mode and then, in the case of "editing_ == true" the monochrome 
+		if (mathMacro_->editMetrics(pi.base.bv)) {
+			// The only way a ArgumentProxy can appear is in a cell of the
+			// MathMacro. Moreover the cells are only drawn in the DISPLAY_FOLDED
+			// mode and then, if the macro is edited the monochrome
 			// mode is entered by the MathMacro before calling the cells' draw
 			// method. Then eventually this code is reached and the proxy leaves
-			// monochrome mode temporarely. Hence, if it is not in monochrome 
-			// here (and the assert triggers in pain.leaveMonochromeMode()) 
+			// monochrome mode temporarely. Hence, if it is not in monochrome
+			// here (and the assert triggers in pain.leaveMonochromeMode())
 			// it's a bug.
 			pi.pain.leaveMonochromeMode();
-			mathMacro_.cell(idx_).draw(pi, x, y);
+			mathMacro_->cell(idx_).draw(pi, x, y);
 			pi.pain.enterMonochromeMode(Color_mathbg, Color_mathmacroblend);
-		} else {
-			if (def_.empty())
-				mathMacro_.cell(idx_).draw(pi, x, y);
-			else {
-				mathMacro_.cell(idx_).setXY(*pi.base.bv, x, y);
-				def_.draw(pi, x, y);
-			}
-		}
+		} else if (mathMacro_->cell(idx_).empty()) {
+			mathMacro_->cell(idx_).setXY(*pi.base.bv, x, y);
+			def_.draw(pi, x, y);
+		} else
+			mathMacro_->cell(idx_).draw(pi, x, y);
 	}
 	///
 	size_t idx() const { return idx_; }
 	///
-	int kerning(BufferView const * bv) const { return mathMacro_.cell(idx_).kerning(bv); }
+	int kerning(BufferView const * bv) const
+	{
+		if (mathMacro_->editMetrics(bv)
+		    || !mathMacro_->cell(idx_).empty())
+			return mathMacro_->cell(idx_).kerning(bv);
+		else
+			return def_.kerning(bv);
+	}
 
 private:
 	///
-	Inset * clone() const 
+	Inset * clone() const
 	{
 		return new ArgumentProxy(*this);
 	}
 	///
-	MathMacro & mathMacro_;
+	MathMacro * mathMacro_;
 	///
 	size_t idx_;
 	///
@@ -99,28 +136,151 @@ private:
 };
 
 
-MathMacro::MathMacro(docstring const & name)
-	: InsetMathNest(0), name_(name), displayMode_(DISPLAY_INIT),
-		attachedArgsNum_(0), optionals_(0), nextFoldMode_(true),
-		macro_(0), needsUpdate_(false)
+/// Private implementation of MathMacro
+class MathMacro::Private {
+public:
+	Private(Buffer * buf, docstring const & name)
+		: name_(name), displayMode_(DISPLAY_INIT),
+		  expanded_(buf), definition_(buf), attachedArgsNum_(0),
+		  optionals_(0), nextFoldMode_(true), macroBackup_(buf),
+		  macro_(0), needsUpdate_(false), isUpdating_(false),
+		  appetite_(9)
+	{
+	}
+	/// Update the pointers to our owner of all expanded macros.
+	/// This needs to be called every time a copy of the owner is created
+	/// (bug 9418).
+	void updateChildren(MathMacro * owner);
+	/// name of macro
+	docstring name_;
+	/// current display mode
+	DisplayMode displayMode_;
+	/// expanded macro with ArgumentProxies
+	MathData expanded_;
+	/// macro definition with #1,#2,.. insets
+	MathData definition_;
+	/// number of arguments that were really attached
+	size_t attachedArgsNum_;
+	/// optional argument attached? (only in DISPLAY_NORMAL mode)
+	size_t optionals_;
+	/// fold mode to be set in next metrics call?
+	bool nextFoldMode_;
+	/// if macro_ == true, then here is a copy of the macro
+	/// don't use it for locking
+	MacroData macroBackup_;
+	/// if macroNotFound_ == false, then here is a reference to the macro
+	/// this might invalidate after metrics was called
+	MacroData const * macro_;
+	///
+	mutable std::map<BufferView const *, bool> editing_;
+	///
+	std::string requires_;
+	/// update macro representation
+	bool needsUpdate_;
+	///
+	bool isUpdating_;
+	/// maximal number of arguments the macro is greedy for
+	size_t appetite_;
+};
+
+
+void MathMacro::Private::updateChildren(MathMacro * owner)
+{
+	for (size_t i = 0; i < expanded_.size(); ++i) {
+		ArgumentProxy * p = dynamic_cast<ArgumentProxy *>(expanded_[i].nucleus());
+		if (p)
+			p->setOwner(owner);
+	}
+}
+
+
+MathMacro::MathMacro(Buffer * buf, docstring const & name)
+	: InsetMathNest(buf, 0), d(new Private(buf, name))
 {}
 
 
+MathMacro::MathMacro(MathMacro const & that)
+	: InsetMathNest(that), d(new Private(*that.d))
+{
+	d->updateChildren(this);
+	if (d->macro_ && lyxrc.preview == LyXRC::PREVIEW_ON) {
+		// We need to update d->macro_ by ourselves because in this case
+		// MathData::metrics() is not called when selecting a math inset
+		DocIterator const & pos = d->macroBackup_.pos();
+		d->macro_ = pos.buffer() ? pos.buffer()->getMacro(name(), pos) : 0;
+		if (!d->macro_)
+			d->macro_ = &d->macroBackup_;
+	}
+}
+
+
+MathMacro & MathMacro::operator=(MathMacro const & that)
+{
+	if (&that == this)
+		return *this;
+	InsetMathNest::operator=(that);
+	*d = *that.d;
+	d->updateChildren(this);
+	if (d->macro_ && lyxrc.preview == LyXRC::PREVIEW_ON) {
+		// We need to update d->macro_ by ourselves because in this case
+		// MathData::metrics() is not called when selecting a math inset
+		DocIterator const & pos = d->macroBackup_.pos();
+		d->macro_ = pos.buffer() ? pos.buffer()->getMacro(name(), pos) : 0;
+		if (!d->macro_)
+			d->macro_ = &d->macroBackup_;
+	}
+	return *this;
+}
+
+
+MathMacro::~MathMacro()
+{
+	delete d;
+}
+
+
 Inset * MathMacro::clone() const
 {
 	MathMacro * copy = new MathMacro(*this);
-	copy->needsUpdate_ = true;
-	copy->expanded_.cell(0).clear();
+	copy->d->needsUpdate_ = true;
+	//copy->d->expanded_.clear();
 	return copy;
 }
 
 
+void MathMacro::normalize(NormalStream & os) const
+{
+	os << "[macro " << name();
+	for (size_t i = 0; i < nargs(); ++i)
+		os << ' ' << cell(i);
+	os << ']';
+}
+
+
+MathMacro::DisplayMode MathMacro::displayMode() const
+{
+	return d->displayMode_;
+}
+
+
+bool MathMacro::extraBraces() const
+{
+	return d->displayMode_ == DISPLAY_NORMAL && arity() > 0;
+}
+
+
 docstring MathMacro::name() const
 {
-	if (displayMode_ == DISPLAY_UNFOLDED)
+	if (d->displayMode_ == DISPLAY_UNFOLDED)
 		return asString(cell(0));
-	else
-		return name_;
+
+	return d->name_;
+}
+
+
+docstring MathMacro::macroName() const
+{
+	return d->name_;
 }
 
 
@@ -133,24 +293,20 @@ void MathMacro::cursorPos(BufferView const & bv,
 }
 
 
-int MathMacro::cursorIdx(Cursor const & cur) const {
-	for (size_t i = 0; i != cur.depth(); ++i)
-			if (&cur[i].inset() == this)
-				return cur[i].idx();
-	return -1;
-}
-
-
-bool MathMacro::editMode(Cursor const & cur) const {
+bool MathMacro::editMode(BufferView const * bv) const {
 	// find this in cursor trace
+	Cursor const & cur = bv->cursor();
 	for (size_t i = 0; i != cur.depth(); ++i)
 		if (&cur[i].inset() == this) {
 			// look if there is no other macro in edit mode above
 			++i;
 			for (; i != cur.depth(); ++i) {
-				MathMacro const * macro = dynamic_cast<MathMacro const *>(&cur[i].inset());
-				if (macro && macro->displayMode() == DISPLAY_NORMAL)
-					return false;
+				InsetMath * im = cur[i].asInsetMath();
+				if (im) {
+					MathMacro const * macro = im->asMacro();
+					if (macro && macro->displayMode() == DISPLAY_NORMAL)
+						return false;
+				}
 			}
 
 			// ok, none found, I am the highest one
@@ -161,15 +317,27 @@ bool MathMacro::editMode(Cursor const & cur) const {
 }
 
 
+MacroData const * MathMacro::macro()
+{
+	return d->macro_;
+}
+
+
+bool MathMacro::editMetrics(BufferView const * bv) const
+{
+	return d->editing_[bv];
+}
+
+
 void MathMacro::metrics(MetricsInfo & mi, Dimension & dim) const
 {
-	// set edit mode for which we will have calculated metrics
-	editing_[mi.base.bv] = editMode(mi.base.bv->cursor());
+	// set edit mode for which we will have calculated metrics. But only
+	d->editing_[mi.base.bv] = editMode(mi.base.bv);
 
 	// calculate new metrics according to display mode
-	if (displayMode_ == DISPLAY_INIT || displayMode_ == DISPLAY_INTERACTIVE_INIT) {
+	if (d->displayMode_ == DISPLAY_INIT || d->displayMode_ == DISPLAY_INTERACTIVE_INIT) {
 		mathed_string_dim(mi.base.font, from_ascii("\\") + name(), dim);
-	} else if (displayMode_ == DISPLAY_UNFOLDED) {
+	} else if (d->displayMode_ == DISPLAY_UNFOLDED) {
 		cell(0).metrics(mi, dim);
 		Dimension bsdim;
 		mathed_string_dim(mi.base.font, from_ascii("\\"), bsdim);
@@ -177,16 +345,66 @@ void MathMacro::metrics(MetricsInfo & mi, Dimension & dim) const
 		dim.asc = max(bsdim.ascent(), dim.ascent());
 		dim.des = max(bsdim.descent(), dim.descent());
 		metricsMarkers(dim);
-	} else {
-		BOOST_ASSERT(macro_ != 0);
+	} else if (lyxrc.macro_edit_style == LyXRC::MACRO_EDIT_LIST
+		   && d->editing_[mi.base.bv]) {
+		// Macro will be edited in a old-style list mode here:
+
+		LBUFERR(d->macro_);
+		Dimension fontDim;
+		FontInfo labelFont = sane_font;
+		math_font_max_dim(labelFont, fontDim.asc, fontDim.des);
+
+		// get dimension of components of list view
+		Dimension nameDim;
+		nameDim.wid = mathed_string_width(mi.base.font, from_ascii("Macro \\") + name() + ": ");
+		nameDim.asc = fontDim.asc;
+		nameDim.des = fontDim.des;
+
+		Dimension argDim;
+		argDim.wid = mathed_string_width(labelFont, from_ascii("#9: "));
+		argDim.asc = fontDim.asc;
+		argDim.des = fontDim.des;
+
+		Dimension defDim;
+		d->definition_.metrics(mi, defDim);
+
+		// add them up
+		dim.wid = nameDim.wid + defDim.wid;
+		dim.asc = max(nameDim.asc, defDim.asc);
+		dim.des = max(nameDim.des, defDim.des);
+
+		for (idx_type i = 0; i < nargs(); ++i) {
+			Dimension cdim;
+			cell(i).metrics(mi, cdim);
+			dim.des += max(argDim.height(), cdim.height()) + 1;
+			dim.wid = max(dim.wid, argDim.wid + cdim.wid);
+		}
 
-		// calculate metric finally
-		macro_->lock();
-		expanded_.cell(0).metrics(mi, dim);
-		macro_->unlock();
+		// make space for box and markers, 2 pixels
+		dim.asc += 1;
+		dim.des += 1;
+		dim.wid += 2;
+		metricsMarkers2(dim);
+	} else {
+		LBUFERR(d->macro_);
+
+		// calculate metrics, hoping that all cells are seen
+		d->macro_->lock();
+		d->expanded_.metrics(mi, dim);
+
+		// otherwise do a manual metrics call
+		CoordCache & coords = mi.base.bv->coordCache();
+		for (idx_type i = 0; i < nargs(); ++i) {
+			if (!coords.getArrays().hasDim(&cell(i))) {
+				Dimension tdim;
+				cell(i).metrics(mi, tdim);
+			}
+		}
+		d->macro_->unlock();
 
 		// calculate dimension with label while editing
-		if (editing_[mi.base.bv]) {
+		if (lyxrc.macro_edit_style == LyXRC::MACRO_EDIT_INLINE_BOX
+		    && d->editing_[mi.base.bv]) {
 			FontInfo font = mi.base.font;
 			augmentFont(font, from_ascii("lyxtex"));
 			Dimension namedim;
@@ -205,71 +423,96 @@ void MathMacro::metrics(MetricsInfo & mi, Dimension & dim) const
 
 
 int MathMacro::kerning(BufferView const * bv) const {
-	if (displayMode_ == DISPLAY_NORMAL && !editing(bv))
-		return expanded_.kerning(bv);
+	if (d->displayMode_ == DISPLAY_NORMAL && !d->editing_[bv])
+		return d->expanded_.kerning(bv);
 	else
 		return 0;
 }
 
 
-void MathMacro::updateMacro(MacroContext const & mc) 
+void MathMacro::updateMacro(MacroContext const & mc)
 {
 	if (validName()) {
-		macro_ = mc.get(name());	    
-		if (macro_ && macroBackup_ != *macro_) {
-			macroBackup_ = *macro_;
-			needsUpdate_ = true;
+		d->macro_ = mc.get(name());
+		if (d->macro_ && d->macroBackup_ != *d->macro_) {
+			d->macroBackup_ = *d->macro_;
+			d->needsUpdate_ = true;
 		}
 	} else {
-		macro_ = 0;
+		d->macro_ = 0;
 	}
 }
 
 
-void MathMacro::updateRepresentation(Cursor const * bvCur)
+class MathMacro::UpdateLocker
 {
-	// index of child where the cursor is (or -1 if none is edited)
-	int curIdx = -1;
-	if (bvCur) {
-		curIdx = cursorIdx(*bvCur);
-		previousCurIdx_[&bvCur->bv()] = curIdx;
+public:
+	explicit UpdateLocker(MathMacro & mm) : mac(mm)
+	{
+		mac.d->isUpdating_ = true;
 	}
+	~UpdateLocker() { mac.d->isUpdating_ = false; }
+private:
+	MathMacro & mac;
+};
+/** Avoid wrong usage of UpdateLocker.
+    To avoid wrong usage:
+    UpdateLocker(...); // wrong
+    UpdateLocker locker(...); // right
+*/
+#define UpdateLocker(x) unnamed_UpdateLocker;
+// Tip gotten from Bobby Schmidt's column in C/C++ Users Journal
+
+
+void MathMacro::updateRepresentation(Cursor * cur, MacroContext const & mc,
+		UpdateType utype)
+{
+	// block recursive calls (bug 8999)
+	if (d->isUpdating_)
+		return;
+
+	UpdateLocker locker(*this);
 
 	// known macro?
-	if (macro_ == 0)
+	if (d->macro_ == 0)
 		return;
 
 	// update requires
-	requires_ = macro_->requires();
-	
-	// non-normal mode? We are done!
-	if (displayMode_ != DISPLAY_NORMAL)
+	d->requires_ = d->macro_->requires();
+
+	if (!d->needsUpdate_
+		// non-normal mode? We are done!
+		|| (d->displayMode_ != DISPLAY_NORMAL))
 		return;
 
-	// macro changed?
-	if (needsUpdate_) {
-		needsUpdate_ = false;
-		
-		// get default values of macro
-		vector<docstring> const & defaults = macro_->defaults();
-		
-		// create MathMacroArgumentValue objects pointing to the cells of the macro
-		vector<MathData> values(nargs());
-		for (size_t i = 0; i < nargs(); ++i) {
-			ArgumentProxy * proxy;
-			if (!cell(i).empty() 
-			    || i >= defaults.size() 
-			    || defaults[i].empty() 
-			    || curIdx == (int)i)
-				proxy = new ArgumentProxy(*this, i);
-			else
-				proxy = new ArgumentProxy(*this, i, defaults[i]);
-			values[i].insert(0, MathAtom(proxy));
-		}
-		
-		// expanding macro with the values
-		macro_->expand(values, expanded_.cell(0));
-	}		
+	d->needsUpdate_ = false;
+
+	// get default values of macro
+	vector<docstring> const & defaults = d->macro_->defaults();
+
+	// create MathMacroArgumentValue objects pointing to the cells of the macro
+	vector<MathData> values(nargs());
+	for (size_t i = 0; i < nargs(); ++i) {
+		ArgumentProxy * proxy;
+		if (i < defaults.size())
+			proxy = new ArgumentProxy(this, i, defaults[i]);
+		else
+			proxy = new ArgumentProxy(this, i);
+		values[i].insert(0, MathAtom(proxy));
+	}
+	// expanding macro with the values
+	// Only update the argument macros if anything was expanded, otherwise
+	// we would get an endless loop (bug 9140). UpdateLocker does not work
+	// in this case, since MacroData::expand() creates new MathMacro
+	// objects, so this would be a different recursion path than the one
+	// protected by UpdateLocker.
+	if (d->macro_->expand(values, d->expanded_)) {
+		if (utype == OutputUpdate && !d->expanded_.empty())
+			d->expanded_.updateMacros(cur, mc, utype);
+	}
+	// get definition for list edit mode
+	docstring const & display = d->macro_->display();
+	asArray(display.empty() ? d->macro_->definition() : display, d->definition_);
 }
 
 
@@ -281,25 +524,75 @@ void MathMacro::draw(PainterInfo & pi, int x, int y) const
 	int expx = x;
 	int expy = y;
 
-	if (displayMode_ == DISPLAY_INIT || displayMode_ == DISPLAY_INTERACTIVE_INIT) {		
-		PainterInfo pi2(pi.base.bv, pi.pain);
-		pi2.base.font.setColor(macro_ ? Color_latex : Color_error);
-		//pi2.base.style = LM_ST_TEXT;
-		pi2.pain.text(x, y, from_ascii("\\") + name(), pi2.base.font);
-	} else if (displayMode_ == DISPLAY_UNFOLDED) {
-		PainterInfo pi2(pi.base.bv, pi.pain);
-		pi2.base.font.setColor(macro_ ? Color_latex : Color_error);
-		//pi2.base.style = LM_ST_TEXT;
-		pi2.pain.text(x, y, from_ascii("\\"), pi2.base.font);
-		x += mathed_string_width(pi2.base.font, from_ascii("\\")) + 1;
-		cell(0).draw(pi2, x, y);
-		drawMarkers(pi2, expx, expy);
+	if (d->displayMode_ == DISPLAY_INIT || d->displayMode_ == DISPLAY_INTERACTIVE_INIT) {
+		FontSetChanger dummy(pi.base, "lyxtex");
+		pi.pain.text(x, y, from_ascii("\\") + name(), pi.base.font);
+	} else if (d->displayMode_ == DISPLAY_UNFOLDED) {
+		FontSetChanger dummy(pi.base, "lyxtex");
+		pi.pain.text(x, y, from_ascii("\\"), pi.base.font);
+		x += mathed_string_width(pi.base.font, from_ascii("\\")) + 1;
+		cell(0).draw(pi, x, y);
+		drawMarkers(pi, expx, expy);
+	} else if (lyxrc.macro_edit_style == LyXRC::MACRO_EDIT_LIST
+		   && d->editing_[pi.base.bv]) {
+		// Macro will be edited in a old-style list mode here:
+
+		CoordCache const & coords = pi.base.bv->coordCache();
+		FontInfo const & labelFont = sane_font;
+
+		// markers and box needs two pixels
+		x += 2;
+
+		// get maximal font height
+		Dimension fontDim;
+		math_font_max_dim(pi.base.font, fontDim.asc, fontDim.des);
+
+		// draw label
+		docstring label = from_ascii("Macro \\") + name() + from_ascii(": ");
+		pi.pain.text(x, y, label, labelFont);
+		x += mathed_string_width(labelFont, label);
+
+		// draw definition
+		d->definition_.draw(pi, x, y);
+		Dimension const & defDim = coords.getArrays().dim(&d->definition_);
+		y += max(fontDim.des, defDim.des);
+
+		// draw parameters
+		docstring str = from_ascii("#9");
+		int strw1 = mathed_string_width(labelFont, from_ascii("#9"));
+		int strw2 = mathed_string_width(labelFont, from_ascii(": "));
+
+		for (idx_type i = 0; i < nargs(); ++i) {
+			// position of label
+			Dimension const & cdim = coords.getArrays().dim(&cell(i));
+			x = expx + 2;
+			y += max(fontDim.asc, cdim.asc) + 1;
+
+			// draw label
+			str[1] = '1' + i;
+			pi.pain.text(x, y, str, labelFont);
+			x += strw1;
+			pi.pain.text(x, y, from_ascii(":"), labelFont);
+			x += strw2;
+
+			// draw paramter
+			cell(i).draw(pi, x, y);
+
+			// next line
+			y += max(fontDim.des, cdim.des);
+		}
+
+		pi.pain.rectangle(expx + 1, expy - dim.asc + 1, dim.wid - 3,
+				  dim.height() - 2, Color_mathmacroframe);
+		drawMarkers2(pi, expx, expy);
 	} else {
+		bool drawBox = lyxrc.macro_edit_style == LyXRC::MACRO_EDIT_INLINE_BOX;
+
 		// warm up cells
 		for (size_t i = 0; i < nargs(); ++i)
 			cell(i).setXY(*pi.base.bv, x, y);
 
-		if (editing_[pi.base.bv]) {
+		if (drawBox && d->editing_[pi.base.bv]) {
 			// draw header and rectangle around
 			FontInfo font = pi.base.font;
 			augmentFont(font, from_ascii("lyxtex"));
@@ -307,63 +600,68 @@ void MathMacro::draw(PainterInfo & pi, int x, int y) const
 			font.setColor(Color_mathmacrolabel);
 			Dimension namedim;
 			mathed_string_dim(font, name(), namedim);
-#if 0
-			pi.pain.fillRectangle(x, y - dim.asc, 2 + namedim.width() + 2, dim.height(), Color_mathmacrobg);
-			pi.pain.text(x + 2, y, name(), font);
-			expx += 2 + namew + 2;
-#endif
+
 			pi.pain.fillRectangle(x, y - dim.asc, dim.wid, 1 + namedim.height() + 1, Color_mathmacrobg);
 			pi.pain.text(x + 1, y - dim.asc + namedim.asc + 2, name(), font);
-			expx += (dim.wid - expanded_.cell(0).dimension(*pi.base.bv).width()) / 2;
+			expx += (dim.wid - d->expanded_.dimension(*pi.base.bv).width()) / 2;
+		}
 
+		if (d->editing_[pi.base.bv]) {
 			pi.pain.enterMonochromeMode(Color_mathbg, Color_mathmacroblend);
-			expanded_.cell(0).draw(pi, expx, expy);
+			d->expanded_.draw(pi, expx, expy);
 			pi.pain.leaveMonochromeMode();
+
+			if (drawBox)
+				pi.pain.rectangle(x, y - dim.asc, dim.wid,
+						  dim.height(), Color_mathmacroframe);
 		} else
-			expanded_.cell(0).draw(pi, expx, expy);
+			d->expanded_.draw(pi, expx, expy);
 
-		// draw frame while editing
-		if (editing_[pi.base.bv])
-			pi.pain.rectangle(x, y - dim.asc, dim.wid, dim.height(), Color_mathmacroframe);
+		if (!drawBox)
+			drawMarkers(pi, x, y);
 	}
 
-	// another argument selected or edit mode changed?
-	idx_type curIdx = cursorIdx(pi.base.bv->cursor());
-	if (previousCurIdx_[pi.base.bv] != curIdx 
-			|| editing_[pi.base.bv] != editMode(pi.base.bv->cursor()))
-		pi.base.bv->cursor().updateFlags(Update::Force);
+	// edit mode changed?
+	if (d->editing_[pi.base.bv] != editMode(pi.base.bv))
+		pi.base.bv->cursor().screenUpdateFlags(Update::SinglePar);
 }
 
 
 void MathMacro::drawSelection(PainterInfo & pi, int x, int y) const
 {
 	// We may have 0 arguments, but InsetMathNest requires at least one.
-	if (cells_.size() > 0)
+	if (!cells_.empty())
 		InsetMathNest::drawSelection(pi, x, y);
 }
 
 
-void MathMacro::setDisplayMode(MathMacro::DisplayMode mode)
+void MathMacro::setDisplayMode(MathMacro::DisplayMode mode, int appetite)
 {
-	if (displayMode_ != mode) {		
+	if (d->displayMode_ != mode) {
 		// transfer name if changing from or to DISPLAY_UNFOLDED
 		if (mode == DISPLAY_UNFOLDED) {
 			cells_.resize(1);
-			asArray(name_, cell(0));
-		} else if (displayMode_ == DISPLAY_UNFOLDED) {
-			name_ = asString(cell(0));
+			asArray(d->name_, cell(0));
+		} else if (d->displayMode_ == DISPLAY_UNFOLDED) {
+			d->name_ = asString(cell(0));
 			cells_.resize(0);
 		}
 
-		displayMode_ = mode;
-		needsUpdate_ = true;
+		d->displayMode_ = mode;
+		d->needsUpdate_ = true;
 	}
+
+	// the interactive init mode is non-greedy by default
+	if (appetite == -1)
+		d->appetite_ = (mode == DISPLAY_INTERACTIVE_INIT) ? 0 : 9;
+	else
+		d->appetite_ = size_t(appetite);
 }
 
 
 MathMacro::DisplayMode MathMacro::computeDisplayMode() const
 {
-	if (nextFoldMode_ == true && macro_ && !macro_->locked())
+	if (d->nextFoldMode_ == true && d->macro_ && !d->macro_->locked())
 		return DISPLAY_NORMAL;
 	else
 		return DISPLAY_UNFOLDED;
@@ -374,8 +672,7 @@ bool MathMacro::validName() const
 {
 	docstring n = name();
 
-	// empty name?
-	if (n.size() == 0)
+	if (n.empty())
 		return false;
 
 	// converting back and force doesn't swallow anything?
@@ -386,8 +683,9 @@ bool MathMacro::validName() const
 
 	// 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;
 	}
 
@@ -395,20 +693,67 @@ bool MathMacro::validName() const
 }
 
 
+size_t MathMacro::arity() const
+{
+	if (d->displayMode_ == DISPLAY_NORMAL )
+		return cells_.size();
+	else
+		return 0;
+}
+
+
+size_t MathMacro::optionals() const
+{
+	return d->optionals_;
+}
+
+
+void MathMacro::setOptionals(int n)
+{
+	if (n <= int(nargs()))
+		d->optionals_ = n;
+}
+
+
+size_t MathMacro::appetite() const
+{
+	return d->appetite_;
+}
+
+
 void MathMacro::validate(LaTeXFeatures & features) const
 {
-	if (!requires_.empty())
-		features.require(requires_);
+	// Immediately after a document is loaded, in some cases the MacroData
+	// of the global macros defined in the lib/symbols file may still not
+	// be known to the macro machinery because it will be set only after
+	// the first call to updateMacros(). This is not a problem unless
+	// instant preview is on for math, in which case we will be missing
+	// the corresponding requirements.
+	// In this case, we get the required info from the global macro table.
+	if (!d->requires_.empty())
+		features.require(d->requires_);
+	else if (!d->macro_) {
+		// Update requires for known global macros.
+		MacroData const * data = MacroTable::globalMacros().get(name());
+		if (data && !data->requires().empty())
+			features.require(data->requires());
+	}
 
-	if (name() == "binom" || name() == "mathcircumflex")
-		features.require(to_utf8(name()));
+	if (name() == "binom")
+		features.require("binom");
+
+	// validate the cells and the definition
+	if (displayMode() == DISPLAY_NORMAL) {
+		d->definition_.validate(features);
+		InsetMathNest::validate(features);
+	}
 }
 
 
-void MathMacro::edit(Cursor & cur, bool left)
+void MathMacro::edit(Cursor & cur, bool front, EntryDirection entry_from)
 {
-	cur.updateFlags(Update::Force);
-	InsetMathNest::edit(cur, left);
+	cur.screenUpdateFlags(Update::SinglePar);
+	InsetMathNest::edit(cur, front, entry_from);
 }
 
 
@@ -416,162 +761,187 @@ Inset * MathMacro::editXY(Cursor & cur, int x, int y)
 {
 	// We may have 0 arguments, but InsetMathNest requires at least one.
 	if (nargs() > 0) {
-		cur.updateFlags(Update::Force);
-		return InsetMathNest::editXY(cur, x, y);		
+		cur.screenUpdateFlags(Update::SinglePar);
+		return InsetMathNest::editXY(cur, x, y);
 	} else
 		return this;
 }
 
 
 void MathMacro::removeArgument(Inset::pos_type pos) {
-	if (displayMode_ == DISPLAY_NORMAL) {
-		BOOST_ASSERT(size_t(pos) < cells_.size());
+	if (d->displayMode_ == DISPLAY_NORMAL) {
+		LASSERT(size_t(pos) < cells_.size(), return);
 		cells_.erase(cells_.begin() + pos);
-		if (size_t(pos) < attachedArgsNum_)
-			--attachedArgsNum_;
-		if (size_t(pos) < optionals_) {
-			--optionals_;
+		if (size_t(pos) < d->attachedArgsNum_)
+			--d->attachedArgsNum_;
+		if (size_t(pos) < d->optionals_) {
+			--d->optionals_;
 		}
 
-		needsUpdate_ = true;
+		d->needsUpdate_ = true;
 	}
 }
 
 
 void MathMacro::insertArgument(Inset::pos_type pos) {
-	if (displayMode_ == DISPLAY_NORMAL) {
-		BOOST_ASSERT(size_t(pos) <= cells_.size());
+	if (d->displayMode_ == DISPLAY_NORMAL) {
+		LASSERT(size_t(pos) <= cells_.size(), return);
 		cells_.insert(cells_.begin() + pos, MathData());
-		if (size_t(pos) < attachedArgsNum_)
-			++attachedArgsNum_;
-		if (size_t(pos) < optionals_)
-			++optionals_;
+		if (size_t(pos) < d->attachedArgsNum_)
+			++d->attachedArgsNum_;
+		if (size_t(pos) < d->optionals_)
+			++d->optionals_;
 
-		needsUpdate_ = true;
+		d->needsUpdate_ = true;
 	}
 }
 
 
 void MathMacro::detachArguments(vector<MathData> & args, bool strip)
 {
-	BOOST_ASSERT(displayMode_ == DISPLAY_NORMAL);	
+	LASSERT(d->displayMode_ == DISPLAY_NORMAL, return);
 	args = cells_;
 
 	// strip off empty cells, but not more than arity-attachedArgsNum_
 	if (strip) {
 		size_t i;
-		for (i = cells_.size(); i > attachedArgsNum_; --i)
+		for (i = cells_.size(); i > d->attachedArgsNum_; --i)
 			if (!cell(i - 1).empty()) break;
 		args.resize(i);
 	}
 
-	attachedArgsNum_ = 0;
-	expanded_.cell(0) = MathData();
+	d->attachedArgsNum_ = 0;
+	d->expanded_ = MathData();
 	cells_.resize(0);
 
-	needsUpdate_ = true;
+	d->needsUpdate_ = true;
 }
 
 
 void MathMacro::attachArguments(vector<MathData> const & args, size_t arity, int optionals)
 {
-	BOOST_ASSERT(displayMode_ == DISPLAY_NORMAL);
+	LASSERT(d->displayMode_ == DISPLAY_NORMAL, return);
 	cells_ = args;
-	attachedArgsNum_ = args.size();
+	d->attachedArgsNum_ = args.size();
 	cells_.resize(arity);
-	expanded_.cell(0) = MathData();
-	optionals_ = optionals;
+	d->expanded_ = MathData();
+	d->optionals_ = optionals;
 
-	needsUpdate_ = true;
+	d->needsUpdate_ = true;
 }
 
 
-bool MathMacro::idxFirst(Cursor & cur) const 
+bool MathMacro::idxFirst(Cursor & cur) const
 {
-	cur.updateFlags(Update::Force);
+	cur.screenUpdateFlags(Update::SinglePar);
 	return InsetMathNest::idxFirst(cur);
 }
 
 
-bool MathMacro::idxLast(Cursor & cur) const 
+bool MathMacro::idxLast(Cursor & cur) const
 {
-	cur.updateFlags(Update::Force);
+	cur.screenUpdateFlags(Update::SinglePar);
 	return InsetMathNest::idxLast(cur);
 }
 
 
-bool MathMacro::notifyCursorLeaves(Cursor & cur)
+bool MathMacro::notifyCursorLeaves(Cursor const & old, Cursor & cur)
 {
-	cur.updateFlags(Update::Force);
-	return InsetMathNest::notifyCursorLeaves(cur);
+	if (d->displayMode_ == DISPLAY_UNFOLDED) {
+		docstring const & unfolded_name = name();
+		if (unfolded_name != d->name_) {
+			// The macro name was changed
+			Cursor inset_cursor = old;
+			int macroSlice = inset_cursor.find(this);
+			// returning true means the cursor is "now" invalid,
+			// which it was.
+			LASSERT(macroSlice != -1, return true);
+			inset_cursor.cutOff(macroSlice);
+			inset_cursor.recordUndoInset();
+			inset_cursor.pop();
+			inset_cursor.cell().erase(inset_cursor.pos());
+			inset_cursor.cell().insert(inset_cursor.pos(),
+				createInsetMath(unfolded_name, cur.buffer()));
+			cur.resetAnchor();
+			cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
+			return true;
+		}
+	}
+	cur.screenUpdateFlags(Update::Force);
+	return InsetMathNest::notifyCursorLeaves(old, cur);
 }
 
 
 void MathMacro::fold(Cursor & cur)
 {
-	if (!nextFoldMode_) {
-		nextFoldMode_ = true;
-		cur.updateFlags(Update::Force);
+	if (!d->nextFoldMode_) {
+		d->nextFoldMode_ = true;
+		cur.screenUpdateFlags(Update::SinglePar);
 	}
 }
 
 
 void MathMacro::unfold(Cursor & cur)
 {
-	if (nextFoldMode_) {
-		nextFoldMode_ = false;
-		cur.updateFlags(Update::Force);
+	if (d->nextFoldMode_) {
+		d->nextFoldMode_ = false;
+		cur.screenUpdateFlags(Update::SinglePar);
 	}
 }
 
 
 bool MathMacro::folded() const
 {
-	return nextFoldMode_;
+	return d->nextFoldMode_;
 }
 
 
 void MathMacro::write(WriteStream & os) const
 {
+	MathEnsurer ensurer(os, d->macro_ != 0, true);
+
 	// non-normal mode
-	if (displayMode_ != DISPLAY_NORMAL) {
-		os << "\\" << name() << " ";
-		os.pendingSpace(true);
+	if (d->displayMode_ != DISPLAY_NORMAL) {
+		os << "\\" << name();
+		if (name().size() != 1 || isAlphaASCII(name()[0]))
+			os.pendingSpace(true);
 		return;
 	}
 
 	// normal mode
-	BOOST_ASSERT(macro_);
+	// we should be ok to continue even if this fails.
+	LATTEST(d->macro_);
 
-	// optional arguments make macros fragile
-	if (optionals_ > 0 && os.fragile())
+	// Always protect macros in a fragile environment
+	if (os.fragile())
 		os << "\\protect";
-	
+
 	os << "\\" << name();
 	bool first = true;
-	
+
 	// Optional arguments:
 	// First find last non-empty optional argument
 	idx_type emptyOptFrom = 0;
 	idx_type i = 0;
-	for (; i < cells_.size() && i < optionals_; ++i) {
+	for (; i < cells_.size() && i < d->optionals_; ++i) {
 		if (!cell(i).empty())
 			emptyOptFrom = i + 1;
 	}
-	
+
 	// print out optionals
 	for (i=0; i < cells_.size() && i < emptyOptFrom; ++i) {
 		first = false;
 		os << "[" << cell(i) << "]";
 	}
-	
+
 	// skip the tailing empty optionals
-	i = optionals_;
-	
-	// Print remaining macros 
+	i = d->optionals_;
+
+	// Print remaining arguments
 	for (; i < cells_.size(); ++i) {
-		if (cell(i).size() == 1 
-			 && cell(i)[0].nucleus()->asCharInset()) {
+		if (cell(i).size() == 1
+			&& cell(i)[0].nucleus()->asCharInset()
+			&& isASCII(cell(i)[0].nucleus()->asCharInset()->getChar())) {
 			if (first)
 				os << " ";
 			os << cell(i);
@@ -588,32 +958,186 @@ void MathMacro::write(WriteStream & os) const
 
 void MathMacro::maple(MapleStream & os) const
 {
-	lyx::maple(expanded_.cell(0), os);
+	lyx::maple(d->expanded_, os);
+}
+
+
+void MathMacro::maxima(MaximaStream & os) const
+{
+	lyx::maxima(d->expanded_, os);
+}
+
+
+void MathMacro::mathematica(MathematicaStream & os) const
+{
+	lyx::mathematica(d->expanded_, os);
 }
 
 
 void MathMacro::mathmlize(MathStream & os) const
 {
-	lyx::mathmlize(expanded_.cell(0), os);
+	// macro_ is 0 if this is an unknown macro
+	LATTEST(d->macro_ || d->displayMode_ != DISPLAY_NORMAL);
+	if (d->macro_) {
+		docstring const xmlname = d->macro_->xmlname();
+		if (!xmlname.empty()) {
+			char const * type = d->macro_->MathMLtype();
+			os << '<' << type << "> " << xmlname << " /<"
+			   << type << '>';
+			return;
+		}
+	}
+	if (d->expanded_.empty()) {
+		// this means that we do not recognize the macro
+		throw MathExportException();
+	}
+	os << d->expanded_;
+}
+
+
+void MathMacro::htmlize(HtmlStream & os) const
+{
+	// macro_ is 0 if this is an unknown macro
+	LATTEST(d->macro_ || d->displayMode_ != DISPLAY_NORMAL);
+	if (d->macro_) {
+		docstring const xmlname = d->macro_->xmlname();
+		if (!xmlname.empty()) {
+			os << ' ' << xmlname << ' ';
+			return;
+		}
+	}
+	if (d->expanded_.empty()) {
+		// this means that we do not recognize the macro
+		throw MathExportException();
+	}
+	os << d->expanded_;
 }
 
 
 void MathMacro::octave(OctaveStream & os) const
 {
-	lyx::octave(expanded_.cell(0), os);
+	lyx::octave(d->expanded_, os);
 }
 
 
 void MathMacro::infoize(odocstream & os) const
 {
-	os << "Macro: " << name();
+	os << bformat(_("Macro: %1$s"), name());
 }
 
 
 void MathMacro::infoize2(odocstream & os) const
 {
-	os << "Macro: " << name();
+	os << bformat(_("Macro: %1$s"), name());
+}
+
+
+bool MathMacro::completionSupported(Cursor const & cur) const
+{
+	if (displayMode() != DISPLAY_UNFOLDED)
+		return InsetMathNest::completionSupported(cur);
+
+	return lyxrc.completion_popup_math
+		&& displayMode() == DISPLAY_UNFOLDED
+		&& cur.bv().cursor().pos() == int(name().size());
+}
+
+
+bool MathMacro::inlineCompletionSupported(Cursor const & cur) const
+{
+	if (displayMode() != DISPLAY_UNFOLDED)
+		return InsetMathNest::inlineCompletionSupported(cur);
+
+	return lyxrc.completion_inline_math
+		&& displayMode() == DISPLAY_UNFOLDED
+		&& cur.bv().cursor().pos() == int(name().size());
+}
+
+
+bool MathMacro::automaticInlineCompletion() const
+{
+	if (displayMode() != DISPLAY_UNFOLDED)
+		return InsetMathNest::automaticInlineCompletion();
+
+	return lyxrc.completion_inline_math;
+}
+
+
+bool MathMacro::automaticPopupCompletion() const
+{
+	if (displayMode() != DISPLAY_UNFOLDED)
+		return InsetMathNest::automaticPopupCompletion();
 
+	return lyxrc.completion_popup_math;
+}
+
+
+CompletionList const *
+MathMacro::createCompletionList(Cursor const & cur) const
+{
+	if (displayMode() != DISPLAY_UNFOLDED)
+		return InsetMathNest::createCompletionList(cur);
+
+	return new MathCompletionList(cur.bv().cursor());
+}
+
+
+docstring MathMacro::completionPrefix(Cursor const & cur) const
+{
+	if (displayMode() != DISPLAY_UNFOLDED)
+		return InsetMathNest::completionPrefix(cur);
+
+	if (!completionSupported(cur))
+		return docstring();
+
+	return "\\" + name();
+}
+
+
+bool MathMacro::insertCompletion(Cursor & cur, docstring const & s,
+					bool finished)
+{
+	if (displayMode() != DISPLAY_UNFOLDED)
+		return InsetMathNest::insertCompletion(cur, s, finished);
+
+	if (!completionSupported(cur))
+		return false;
+
+	// append completion
+	docstring newName = name() + s;
+	asArray(newName, cell(0));
+	cur.bv().cursor().pos() = name().size();
+	cur.screenUpdateFlags(Update::SinglePar);
+
+	// finish macro
+	if (finished) {
+		cur.bv().cursor().pop();
+		++cur.bv().cursor().pos();
+		cur.screenUpdateFlags(Update::SinglePar);
+	}
+
+	return true;
+}
+
+
+void MathMacro::completionPosAndDim(Cursor const & cur, int & x, int & y,
+	Dimension & dim) const
+{
+	if (displayMode() != DISPLAY_UNFOLDED)
+		InsetMathNest::completionPosAndDim(cur, x, y, dim);
+
+	// get inset dimensions
+	dim = cur.bv().coordCache().insets().dim(this);
+	// FIXME: these 3 are no accurate, but should depend on the font.
+	// Now the popup jumps down if you enter a char with descent > 0.
+	dim.des += 3;
+	dim.asc += 3;
+
+	// and position
+	Point xy
+	= cur.bv().coordCache().insets().xy(this);
+	x = xy.x_;
+	y = xy.y_;
 }