* 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.
*/
#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 "Cursor.h"
-#include "debug.h"
#include "BufferView.h"
+#include "CoordCache.h"
+#include "Cursor.h"
+#include "FuncStatus.h"
+#include "FuncRequest.h"
#include "LaTeXFeatures.h"
+#include "LyX.h"
+#include "LyXRC.h"
+#include "MetricsInfo.h"
+
#include "frontends/Painter.h"
+#include "support/debug.h"
+#include "support/gettext.h"
+#include "support/lassert.h"
+#include "support/lstrings.h"
+#include "support/RefChanger.h"
+#include "support/textutils.h"
-namespace lyx {
+#include <ostream>
+#include <vector>
+
+using namespace lyx::support;
+using namespace std;
-using std::string;
-using std::max;
-using std::auto_ptr;
-using std::endl;
-using std::vector;
+namespace lyx {
-/// This class is the value of a macro argument, technically
-/// a wrapper of the cells of MathMacro.
-class MathMacroArgumentValue : public InsetMathDim {
+/// A proxy for the macro values
+class ArgumentProxy : public InsetMath {
public:
///
- MathMacroArgumentValue(MathData const * value, docstring const & macroName)
- : value_(value), macroName_(macroName) {}
+ ArgumentProxy(MathMacro * mathMacro, size_t idx)
+ : 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; }
+ ///
+ MathMacro const * owner() { return mathMacro_; }
+ ///
+ InsetCode lyxCode() const { return ARGUMENT_PROXY_CODE; }
+ /// The math data to use for display
+ MathData const & displayCell(BufferView const * bv) const
+ {
+ // handle default macro arguments
+ bool use_def_arg = !mathMacro_->editMetrics(bv)
+ && mathMacro_->cell(idx_).empty();
+ return use_def_arg ? def_ : mathMacro_->cell(idx_);
+ }
+ ///
+ bool addToMathRow(MathRow & mrow, MetricsInfo & mi) const
+ {
+ // macro arguments are in macros
+ LATTEST(mathMacro_->nesting() > 0);
+ /// The macro nesting can change display of insets. Change it locally.
+ Changer chg = make_change(mi.base.macro_nesting, mathMacro_->nesting());
+
+ MathRow::Element e_beg(MathRow::BEG_ARG);
+ e_beg.macro = mathMacro_;
+ e_beg.ar = &mathMacro_->cell(idx_);
+ mrow.push_back(e_beg);
+
+ mathMacro_->macro()->unlock();
+ bool has_contents = displayCell(mi.base.bv).addToMathRow(mrow, mi);
+ mathMacro_->macro()->lock();
+
+ // if there was no contents, and the contents is editable,
+ // then we insert a box instead.
+ if (!has_contents && mathMacro_->nesting() == 1) {
+ // mathclass is ord because it should be spaced as a normal atom
+ MathRow::Element e(MathRow::BOX, MC_ORD);
+ e.color = Color_mathline;
+ mrow.push_back(e);
+ has_contents = true;
+ }
+
+ MathRow::Element e_end(MathRow::END_ARG);
+ e_end.macro = mathMacro_;
+ e_end.ar = &mathMacro_->cell(idx_);
+
+ mrow.push_back(e_end);
+
+ return has_contents;
+ }
+ ///
+ void metrics(MetricsInfo &, Dimension &) const {
+ // This should never be invoked, since ArgumentProxy insets are linearized
+ LATTEST(false);
+ }
+ ///
+ int kerning(BufferView const * bv) const
+ {
+ return displayCell(bv).kerning(bv);
+ }
+ ///
+ void draw(PainterInfo &, int, int) const {
+ // This should never be invoked, since ArgumentProxy insets are linearized
+ LATTEST(false);
+ }
+ // 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_); }
///
- bool metrics(MetricsInfo & mi, Dimension & dim) const;
+ void mathematica(MathematicaStream & ms) const { ms << mathMacro_->cell(idx_); }
///
- void draw(PainterInfo &, int x, int y) const;
-
+ 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_); }
+
private:
- std::auto_ptr<InsetBase> doClone() const;
- MathData const * value_;
- docstring macroName_;
+ ///
+ Inset * clone() const
+ {
+ return new ArgumentProxy(*this);
+ }
+ ///
+ MathMacro * mathMacro_;
+ ///
+ size_t idx_;
+ ///
+ MathData def_;
};
-auto_ptr<InsetBase> MathMacroArgumentValue::doClone() const
+/// 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);
+ /// Recursively update the pointers of all expanded macros
+ /// appearing in the arguments of the current macro
+ void updateNestedChildren(MathMacro * owner, InsetMathNest * ni);
+ /// 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_;
+ /// Level of nesting in macros (including this one)
+ int nesting_;
+};
+
+
+void MathMacro::Private::updateChildren(MathMacro * owner)
{
- return auto_ptr<InsetBase>(new MathMacroArgumentValue(*this));
+ for (size_t i = 0; i < expanded_.size(); ++i) {
+ ArgumentProxy * p = dynamic_cast<ArgumentProxy *>(expanded_[i].nucleus());
+ if (p)
+ p->setOwner(owner);
+
+ InsetMathNest * ni = expanded_[i].nucleus()->asNestInset();
+ if (ni)
+ updateNestedChildren(owner, ni);
+ }
+
+ if (macro_) {
+ // The macro_ pointer is updated when MathData::metrics() is
+ // called. However, when instant preview is on or the macro is
+ // not on screen, MathData::metrics() is not called and we may
+ // have a dangling pointer. As a safety measure, when a macro
+ // is copied, always let macro_ point to the backup copy of the
+ // MacroData structure. This backup is updated every time the
+ // macro is changed, so it will not become stale.
+ macro_ = ¯oBackup_;
+ }
}
-bool MathMacroArgumentValue::metrics(MetricsInfo & mi, Dimension & dim) const
+void MathMacro::Private::updateNestedChildren(MathMacro * owner, InsetMathNest * ni)
{
- // unlock outer macro in arguments, and lock it again later
- MacroTable::globalMacros().get(macroName_).unlock();
- value_->metrics(mi, dim);
- MacroTable::globalMacros().get(macroName_).lock();
- metricsMarkers2(dim);
- if (dim_ == dim)
- return false;
- dim_ = dim;
- return true;
+ for (size_t i = 0; i < ni->nargs(); ++i) {
+ MathData & ar = ni->cell(i);
+ for (size_t j = 0; j < ar.size(); ++j) {
+ ArgumentProxy * ap = dynamic_cast
+ <ArgumentProxy *>(ar[j].nucleus());
+ if (ap) {
+ MathMacro::Private * md = ap->owner()->d;
+ if (md->macro_)
+ md->macro_ = &md->macroBackup_;
+ ap->setOwner(owner);
+ }
+ InsetMathNest * imn = ar[j].nucleus()->asNestInset();
+ if (imn)
+ updateNestedChildren(owner, imn);
+ }
+ }
}
-void MathMacroArgumentValue::draw(PainterInfo & pi, int x, int y) const
+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))
{
- // unlock outer macro in arguments, and lock it again later
- MacroTable::globalMacros().get(macroName_).unlock();
- value_->draw(pi, x, y);
- MacroTable::globalMacros().get(macroName_).lock();
+ setBuffer(*that.buffer_);
+ d->updateChildren(this);
}
-MathMacro::MathMacro(docstring const & name, int numargs)
- : InsetMathNest(numargs), name_(name)
-{}
+MathMacro & MathMacro::operator=(MathMacro const & that)
+{
+ if (&that == this)
+ return *this;
+ InsetMathNest::operator=(that);
+ *d = *that.d;
+ d->updateChildren(this);
+ return *this;
+}
+
+
+MathMacro::~MathMacro()
+{
+ delete d;
+}
+
+
+bool MathMacro::addToMathRow(MathRow & mrow, MetricsInfo & mi) const
+{
+ // set edit mode for which we will have calculated row.
+ // This is the same as what is done in metrics().
+ d->editing_[mi.base.bv] = editMode(mi.base.bv);
+
+ /// The macro nesting can change display of insets. Change it locally.
+ Changer chg = make_change(mi.base.macro_nesting, d->nesting_);
+
+ if (displayMode() != MathMacro::DISPLAY_NORMAL
+ || d->editing_[mi.base.bv])
+ return InsetMath::addToMathRow(mrow, mi);
+
+ MathRow::Element e_beg(MathRow::BEG_MACRO);
+ e_beg.macro = this;
+ mrow.push_back(e_beg);
+
+ d->macro_->lock();
+ bool has_contents = d->expanded_.addToMathRow(mrow, mi);
+ d->macro_->unlock();
+
+ // if there was no contents and the array is editable, then we
+ // insert a grey box instead.
+ if (!has_contents && mi.base.macro_nesting == 1) {
+ // mathclass is unknown because it is irrelevant for spacing
+ MathRow::Element e(MathRow::BOX);
+ e.color = Color_mathmacroblend;
+ mrow.push_back(e);
+ has_contents = true;
+ }
+
+ MathRow::Element e_end(MathRow::END_MACRO);
+ e_end.macro = this;
+ mrow.push_back(e_end);
+
+ return has_contents;
+}
+
+
+Inset * MathMacro::clone() const
+{
+ MathMacro * copy = new MathMacro(*this);
+ 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_;
+}
-auto_ptr<InsetBase> MathMacro::doClone() const
+bool MathMacro::extraBraces() const
{
- return auto_ptr<InsetBase>(new MathMacro(*this));
+ return d->displayMode_ == DISPLAY_NORMAL && arity() > 0;
}
docstring MathMacro::name() const
{
- return name_;
+ if (d->displayMode_ == DISPLAY_UNFOLDED)
+ return asString(cell(0));
+
+ return d->name_;
+}
+
+
+docstring MathMacro::macroName() const
+{
+ return d->name_;
+}
+
+
+int MathMacro::nesting() const
+{
+ return d->nesting_;
}
}
-bool MathMacro::metrics(MetricsInfo & mi, Dimension & dim) 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) {
+ 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
+ return true;
+ }
+
+ return false;
+}
+
+
+MacroData const * MathMacro::macro() const
+{
+ return d->macro_;
+}
+
+
+bool MathMacro::editMetrics(BufferView const * bv) const
+{
+ return d->editing_[bv];
+}
+
+
+void MathMacro::metrics(MetricsInfo & mi, Dimension & dim) const
{
- if (!MacroTable::globalMacros().has(name())) {
- mathed_string_dim(mi.base.font, "Unknown: " + name(), dim);
+ /// The macro nesting can change display of insets. Change it locally.
+ Changer chg = make_change(mi.base.macro_nesting, d->nesting_);
+
+ // 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 (d->displayMode_ == DISPLAY_INIT || d->displayMode_ == DISPLAY_INTERACTIVE_INIT) {
+ Changer dummy = mi.base.changeFontSet("lyxtex");
+ mathed_string_dim(mi.base.font, from_ascii("\\") + name(), dim);
+ } else if (d->displayMode_ == DISPLAY_UNFOLDED) {
+ Changer dummy = mi.base.changeFontSet("lyxtex");
+ cell(0).metrics(mi, dim);
+ Dimension bsdim;
+ mathed_string_dim(mi.base.font, from_ascii("\\"), bsdim);
+ dim.wid += bsdim.width() + 1;
+ dim.asc = max(bsdim.ascent(), dim.ascent());
+ dim.des = max(bsdim.descent(), dim.descent());
+ metricsMarkers(mi, dim);
+ } 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);
+ }
+
+ // make space for box and markers, 2 pixels
+ dim.asc += 1;
+ dim.des += 1;
+ dim.wid += 2;
+ metricsMarkers2(mi, dim);
} else {
- MacroData const & macro = MacroTable::globalMacros().get(name());
- if (macro.locked()) {
- mathed_string_dim(mi.base.font, "Self reference: " + name(), dim);
- expanded_ = MathData();
- } else if (editing(mi.base.bv)) {
- // FIXME UNICODE
- asArray(macro.def(), tmpl_);
- LyXFont font = mi.base.font;
- augmentFont(font, from_ascii("lyxtex"));
- tmpl_.metrics(mi, dim);
- // FIXME UNICODE
- dim.wid += mathed_string_width(font, name()) + 10;
- // FIXME UNICODE
- int ww = mathed_string_width(font, from_ascii("#1: "));
- for (idx_type i = 0; i < nargs(); ++i) {
- MathData const & c = cell(i);
- c.metrics(mi);
- dim.wid = max(dim.wid, c.width() + ww);
- dim.des += c.height() + 10;
+ LBUFERR(d->macro_);
+
+ Changer dummy = (currentMode() == TEXT_MODE)
+ ? mi.base.font.changeShape(UP_SHAPE)
+ : Changer();
+
+ // 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);
}
- } else {
- // create MathMacroArgumentValue object pointing to the cells of the macro
- MacroData const & macro = MacroTable::globalMacros().get(name());
- vector<MathData> values(nargs());
- for (size_t i = 0; i != nargs(); ++i)
- values[i].insert(0, MathAtom(new MathMacroArgumentValue(&cells_[i], name())));
- macro.expand(values, expanded_);
-
- MacroTable::globalMacros().get(name()).lock();
- expanded_.metrics(mi, dim);
- MacroTable::globalMacros().get(name()).unlock();
+ }
+ d->macro_->unlock();
+
+ // calculate dimension with label while editing
+ if (lyxrc.macro_edit_style == LyXRC::MACRO_EDIT_INLINE_BOX
+ && d->editing_[mi.base.bv]) {
+ FontInfo font = mi.base.font;
+ augmentFont(font, "lyxtex");
+ Dimension namedim;
+ mathed_string_dim(font, name(), namedim);
+#if 0
+ dim.wid += 2 + namedim.wid + 2 + 2;
+ dim.asc = max(dim.asc, namedim.asc) + 2;
+ dim.des = max(dim.des, namedim.des) + 2;
+#endif
+ dim.wid = max(1 + namedim.wid + 1, 2 + dim.wid + 2);
+ dim.asc += 1 + namedim.height() + 1;
+ dim.des += 2;
}
}
- metricsMarkers2(dim);
- if (dim_ == dim)
- return false;
- dim_ = dim;
- return true;
+}
+
+
+int MathMacro::kerning(BufferView const * bv) const {
+ if (d->displayMode_ == DISPLAY_NORMAL && !d->editing_[bv])
+ return d->expanded_.kerning(bv);
+ else
+ return 0;
+}
+
+
+void MathMacro::updateMacro(MacroContext const & mc)
+{
+ if (validName()) {
+ d->macro_ = mc.get(name());
+ if (d->macro_ && d->macroBackup_ != *d->macro_) {
+ d->macroBackup_ = *d->macro_;
+ d->needsUpdate_ = true;
+ }
+ } else {
+ d->macro_ = 0;
+ }
+}
+
+
+class MathMacro::UpdateLocker
+{
+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, int nesting)
+{
+ // block recursive calls (bug 8999)
+ if (d->isUpdating_)
+ return;
+
+ UpdateLocker locker(*this);
+
+ // known macro?
+ if (d->macro_ == 0)
+ return;
+
+ // remember nesting level of this macro
+ d->nesting_ = nesting;
+
+ // update requires
+ d->requires_ = d->macro_->requires();
+
+ if (!d->needsUpdate_
+ // non-normal mode? We are done!
+ || (d->displayMode_ != DISPLAY_NORMAL))
+ return;
+
+ 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, nesting);
+ }
+ // get definition for list edit mode
+ docstring const & display = d->macro_->display();
+ asArray(display.empty() ? d->macro_->definition() : display,
+ d->definition_, Parse::QUIET);
}
void MathMacro::draw(PainterInfo & pi, int x, int y) const
{
- if (!MacroTable::globalMacros().has(name())) {
- // FIXME UNICODE
- drawStrRed(pi, x, y, "Unknown: " + name());
+ Dimension const dim = dimension(*pi.base.bv);
+
+ int expx = x;
+ int expy = y;
+
+ if (d->displayMode_ == DISPLAY_INIT || d->displayMode_ == DISPLAY_INTERACTIVE_INIT) {
+ Changer dummy = pi.base.changeFontSet("lyxtex");
+ pi.pain.text(x, y, from_ascii("\\") + name(), pi.base.font);
+ } else if (d->displayMode_ == DISPLAY_UNFOLDED) {
+ Changer dummy = pi.base.changeFontSet("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 {
- MacroData const & macro = MacroTable::globalMacros().get(name());
- if (macro.locked()) {
- // FIXME UNICODE
- drawStrRed(pi, x, y, "Self reference: " + name());
- } else if (editing(pi.base.bv)) {
- LyXFont font = pi.base.font;
- augmentFont(font, from_ascii("lyxtex"));
- int h = y - dim_.ascent() + 2 + tmpl_.ascent();
- pi.pain.text(x + 3, h, name(), font);
- int const w = mathed_string_width(font, name());
- tmpl_.draw(pi, x + w + 12, h);
- h += tmpl_.descent();
- Dimension ldim;
- docstring t = from_ascii("#1: ");
- mathed_string_dim(font, t, ldim);
- for (idx_type i = 0; i < nargs(); ++i) {
- MathData const & c = cell(i);
- h += max(c.ascent(), ldim.asc) + 5;
- c.draw(pi, x + ldim.wid, h);
- char_type str[] = { '#', '1', ':', '\0' };
- str[1] += static_cast<char_type>(i);
- pi.pain.text(x + 3, h, str, font);
- h += max(c.descent(), ldim.des) + 5;
- }
- } else {
- MacroTable::globalMacros().get(name()).lock();
- expanded_.draw(pi, x, y);
- MacroTable::globalMacros().get(name()).unlock();
+ bool drawBox = lyxrc.macro_edit_style == LyXRC::MACRO_EDIT_INLINE_BOX;
+ Changer dummy = (currentMode() == TEXT_MODE)
+ ? pi.base.font.changeShape(UP_SHAPE)
+ : Changer();
+
+ // warm up cells
+ for (size_t i = 0; i < nargs(); ++i)
+ cell(i).setXY(*pi.base.bv, x, y);
+
+ if (drawBox && d->editing_[pi.base.bv]) {
+ // draw header and rectangle around
+ FontInfo font = pi.base.font;
+ augmentFont(font, "lyxtex");
+ font.setSize(FONT_SIZE_TINY);
+ font.setColor(Color_mathmacrolabel);
+ Dimension namedim;
+ mathed_string_dim(font, name(), namedim);
+
+ 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 - d->expanded_.dimension(*pi.base.bv).width()) / 2;
}
+
+ if (d->editing_[pi.base.bv]) {
+ pi.pain.enterMonochromeMode(Color_mathbg, Color_mathmacroblend);
+ 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
+ d->expanded_.draw(pi, expx, expy);
+
+ if (!drawBox)
+ drawMarkers(pi, x, y);
+
}
- drawMarkers2(pi, x, y);
+
+ // 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 (nargs() > 0)
+ if (!cells_.empty())
InsetMathNest::drawSelection(pi, x, y);
}
+void MathMacro::setDisplayMode(MathMacro::DisplayMode mode, int appetite)
+{
+ if (d->displayMode_ != mode) {
+ // transfer name if changing from or to DISPLAY_UNFOLDED
+ if (mode == DISPLAY_UNFOLDED) {
+ cells_.resize(1);
+ asArray(d->name_, cell(0));
+ } else if (d->displayMode_ == DISPLAY_UNFOLDED) {
+ d->name_ = asString(cell(0));
+ cells_.resize(0);
+ }
+
+ 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 (d->nextFoldMode_ == true && d->macro_ && !d->macro_->locked())
+ return DISPLAY_NORMAL;
+ else
+ return DISPLAY_UNFOLDED;
+}
+
+
+bool MathMacro::validName() const
+{
+ docstring n = name();
+
+ if (n.empty())
+ return false;
+
+ // converting back and force doesn't swallow anything?
+ /*MathData ma;
+ asArray(n, ma);
+ if (asString(ma) != n)
+ return false;*/
+
+ // valid characters?
+ for (size_t i = 0; i<n.size(); ++i) {
+ if (!(n[i] >= 'a' && n[i] <= 'z')
+ && !(n[i] >= 'A' && n[i] <= 'Z')
+ && n[i] != '*')
+ return false;
+ }
+
+ return true;
+}
+
+
+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_;
+}
+
+
+InsetMath::mode_type MathMacro::currentMode() const
+{
+ // User defined macros are always assumed to be mathmode macros.
+ // Only the global macros defined in lib/symbols may be textmode.
+
+ MacroData const * data = MacroTable::globalMacros().get(name());
+ bool textmode = data && data->symbol() && data->symbol()->extra == "textmode";
+ return textmode ? TEXT_MODE : MATH_MODE;
+}
+
+
void MathMacro::validate(LaTeXFeatures & features) const
{
- if (name() == "binom" || name() == "mathcircumflex")
- features.require(to_utf8(name()));
+ // 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")
+ 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 front, EntryDirection entry_from)
+{
+ cur.screenUpdateFlags(Update::SinglePar);
+ InsetMathNest::edit(cur, front, entry_from);
}
-InsetBase * MathMacro::editXY(Cursor & cur, int x, int y)
+Inset * MathMacro::editXY(Cursor & cur, int x, int y)
{
// We may have 0 arguments, but InsetMathNest requires at least one.
if (nargs() > 0) {
- // Prevent crash due to cold coordcache
- // FIXME: This is only a workaround, the call of
- // InsetMathNest::editXY is correct. The correct fix would
- // ensure that the coordcache of the arguments is valid.
- if (!editing(&cur.bv())) {
- edit(cur, true);
- return this;
- }
+ cur.screenUpdateFlags(Update::SinglePar);
return InsetMathNest::editXY(cur, x, y);
+ } else
+ return this;
+}
+
+
+void MathMacro::removeArgument(Inset::pos_type pos) {
+ if (d->displayMode_ == DISPLAY_NORMAL) {
+ LASSERT(size_t(pos) < cells_.size(), return);
+ cells_.erase(cells_.begin() + pos);
+ if (size_t(pos) < d->attachedArgsNum_)
+ --d->attachedArgsNum_;
+ if (size_t(pos) < d->optionals_) {
+ --d->optionals_;
+ }
+
+ d->needsUpdate_ = true;
}
- return this;
}
-bool MathMacro::idxFirst(Cursor & cur) const
+void MathMacro::insertArgument(Inset::pos_type pos) {
+ if (d->displayMode_ == DISPLAY_NORMAL) {
+ LASSERT(size_t(pos) <= cells_.size(), return);
+ cells_.insert(cells_.begin() + pos, MathData());
+ if (size_t(pos) < d->attachedArgsNum_)
+ ++d->attachedArgsNum_;
+ if (size_t(pos) < d->optionals_)
+ ++d->optionals_;
+
+ d->needsUpdate_ = true;
+ }
+}
+
+
+void MathMacro::detachArguments(vector<MathData> & args, bool strip)
{
- cur.updateFlags(Update::Force);
+ 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 > d->attachedArgsNum_; --i)
+ if (!cell(i - 1).empty()) break;
+ args.resize(i);
+ }
+
+ d->attachedArgsNum_ = 0;
+ d->expanded_ = MathData();
+ cells_.resize(0);
+
+ d->needsUpdate_ = true;
+}
+
+
+void MathMacro::attachArguments(vector<MathData> const & args, size_t arity, int optionals)
+{
+ LASSERT(d->displayMode_ == DISPLAY_NORMAL, return);
+ cells_ = args;
+ d->attachedArgsNum_ = args.size();
+ cells_.resize(arity);
+ d->expanded_ = MathData();
+ d->optionals_ = optionals;
+
+ d->needsUpdate_ = true;
+}
+
+
+bool MathMacro::idxFirst(Cursor & cur) const
+{
+ 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 (!d->nextFoldMode_) {
+ d->nextFoldMode_ = true;
+ cur.screenUpdateFlags(Update::SinglePar);
+ }
+}
+
+
+void MathMacro::unfold(Cursor & cur)
+{
+ if (d->nextFoldMode_) {
+ d->nextFoldMode_ = false;
+ cur.screenUpdateFlags(Update::SinglePar);
+ }
+}
+
+
+bool MathMacro::folded() const
+{
+ return d->nextFoldMode_;
+}
+
+
+void MathMacro::write(WriteStream & os) const
+{
+ MacroData const * data = MacroTable::globalMacros().get(name());
+ bool textmode_macro = data && data->symbol()
+ && data->symbol()->extra == "textmode";
+ bool needs_mathmode = data && (!data->symbol()
+ || data->symbol()->extra != "textmode");
+
+ MathEnsurer ensurer(os, needs_mathmode, true, textmode_macro);
+
+ // non-normal mode
+ if (d->displayMode_ != DISPLAY_NORMAL) {
+ os << "\\" << name();
+ if (name().size() != 1 || isAlphaASCII(name()[0]))
+ os.pendingSpace(true);
+ return;
+ }
+
+ // normal mode
+ // we should be ok to continue even if this fails.
+ LATTEST(d->macro_);
+
+ // We may already be in the argument of a macro
+ bool const inside_macro = os.insideMacro();
+ os.insideMacro(true);
+
+ // Enclose in braces to avoid latex errors with xargs if we have
+ // optional arguments and are in the optional argument of a macro
+ if (d->optionals_ && inside_macro)
+ os << '{';
+
+ // 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 < 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 = d->optionals_;
+
+ // Print remaining arguments
+ for (; i < cells_.size(); ++i) {
+ if (cell(i).size() == 1
+ && cell(i)[0].nucleus()->asCharInset()
+ && isASCII(cell(i)[0].nucleus()->asCharInset()->getChar())) {
+ if (first)
+ os << " ";
+ os << cell(i);
+ } else
+ os << "{" << cell(i) << "}";
+ first = false;
+ }
+
+ // Close the opened brace or add space if there was no argument
+ if (d->optionals_ && inside_macro)
+ os << '}';
+ else if (first)
+ os.pendingSpace(true);
+
+ os.insideMacro(inside_macro);
}
void MathMacro::maple(MapleStream & os) const
{
- updateExpansion();
- lyx::maple(expanded_, 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
{
- updateExpansion();
- lyx::mathmlize(expanded_, 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::octave(OctaveStream & os) const
+void MathMacro::htmlize(HtmlStream & os) const
{
- updateExpansion();
- lyx::octave(expanded_, 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()) {
+ os << ' ' << xmlname << ' ';
+ return;
+ }
+ }
+ if (d->expanded_.empty()) {
+ // this means that we do not recognize the macro
+ throw MathExportException();
+ }
+ os << d->expanded_;
}
-void MathMacro::updateExpansion() const
+void MathMacro::octave(OctaveStream & os) const
{
- //expanded_.substitute(*this);
+ 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_;
}
projects / lyx.git / blobdiff