#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"
#include <ostream>
#include <vector>
+using namespace lyx::support;
using namespace std;
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; }
+ ///
+ 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_);
+ }
///
- void metrics(MetricsInfo & mi, Dimension & dim) const {
- mathMacro_.macro()->unlock();
- mathMacro_.cell(idx_).metrics(mi, dim);
+ 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;
+ }
- if (!mathMacro_.editMetrics(mi.base.bv)
- && mathMacro_.cell(idx_).empty())
- def_.metrics(mi, dim);
+ MathRow::Element e_end(MathRow::END_ARG);
+ e_end.macro = mathMacro_;
+ e_end.ar = &mathMacro_->cell(idx_);
- mathMacro_.macro()->lock();
+ mrow.push_back(e_end);
+
+ return has_contents;
}
- // FIXME Other external things need similar treatment.
///
- void mathmlize(MathStream & ms) const { ms << mathMacro_.cell(idx_); }
+ void metrics(MetricsInfo &, Dimension &) const {
+ // This should never be invoked, since ArgumentProxy insets are linearized
+ LATTEST(false);
+ }
///
- void htmlize(HtmlStream & ms) const { ms << mathMacro_.cell(idx_); }
+ int kerning(BufferView const * bv) const
+ {
+ return displayCell(bv).kerning(bv);
+ }
///
- void draw(PainterInfo & pi, int x, int y) const {
- 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())
- // it's a bug.
- pi.pain.leaveMonochromeMode();
- mathMacro_.cell(idx_).draw(pi, x, y);
- pi.pain.enterMonochromeMode(Color_mathbg, Color_mathmacroblend);
- } 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);
+ 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.
///
- size_t idx() const { return idx_; }
+ void maple(MapleStream & ms) const { ms << mathMacro_->cell(idx_); }
///
- 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);
+ 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_); }
+ ///
+ MathClass mathClass() const
+ {
+ return MC_UNKNOWN;
+ // This can be refined once the pointer issues are fixed. I did not
+ // notice any immediate crash with the following code, but it is risky
+ // nevertheless:
+ //return mathMacro_->cell(idx_).mathClass();
}
private:
///
- Inset * clone() const
+ Inset * clone() const
{
return new ArgumentProxy(*this);
}
///
- MathMacro & mathMacro_;
+ MathMacro * mathMacro_;
///
size_t idx_;
///
};
+/// 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)
+{
+ 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_;
+ }
+}
+
+
+void MathMacro::Private::updateNestedChildren(MathMacro * owner, InsetMathNest * ni)
+{
+ 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);
+ }
+ }
+}
+
+
MathMacro::MathMacro(Buffer * buf, docstring const & name)
- : InsetMathNest(buf, 0), name_(name), displayMode_(DISPLAY_INIT),
- expanded_(buf), attachedArgsNum_(0), optionals_(0), nextFoldMode_(true),
- macroBackup_(buf), macro_(0), needsUpdate_(false), appetite_(9)
+ : InsetMathNest(buf, 0), d(new Private(buf, name))
{}
+MathMacro::MathMacro(MathMacro const & that)
+ : InsetMathNest(that), d(new Private(*that.d))
+{
+ setBuffer(*that.buffer_);
+ d->updateChildren(this);
+}
+
+
+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->needsUpdate_ = true;
- //copy->expanded_.cell(0).clear();
+ copy->d->needsUpdate_ = true;
+ //copy->d->expanded_.clear();
return copy;
}
}
+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));
- return name_;
+ return d->name_;
+}
+
+
+docstring MathMacro::macroName() const
+{
+ return d->name_;
+}
+
+
+int MathMacro::nesting() const
+{
+ return d->nesting_;
}
}
+MacroData const * MathMacro::macro() const
+{
+ return d->macro_;
+}
+
+
bool MathMacro::editMetrics(BufferView const * bv) const
{
- return editing_[bv];
+ return d->editing_[bv];
}
void MathMacro::metrics(MetricsInfo & mi, Dimension & dim) const
{
+ /// 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
- editing_[mi.base.bv] = editMode(mi.base.bv);
+ 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) {
+ Changer dummy = mi.base.changeFontSet("lyxtex");
mathed_string_dim(mi.base.font, from_ascii("\\") + name(), dim);
- } else if (displayMode_ == DISPLAY_UNFOLDED) {
+ } 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(dim);
- } else if (lyxrc.macro_edit_style == LyXRC::MACRO_EDIT_LIST
- && editing_[mi.base.bv]) {
+ 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:
- LASSERT(macro_ != 0, /**/);
+ 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() + ": ");
argDim.wid = mathed_string_width(labelFont, from_ascii("#9: "));
argDim.asc = fontDim.asc;
argDim.des = fontDim.des;
-
+
Dimension defDim;
- definition_.metrics(mi, 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(dim);
+ metricsMarkers2(mi, dim);
} else {
- LASSERT(macro_ != 0, /**/);
+ LBUFERR(d->macro_);
// calculate metrics, hoping that all cells are seen
- macro_->lock();
- expanded_.cell(0).metrics(mi, dim);
+ d->macro_->lock();
+ d->expanded_.metrics(mi, dim);
// otherwise do a manual metrics call
CoordCache & coords = mi.base.bv->coordCache();
cell(i).metrics(mi, tdim);
}
}
- macro_->unlock();
+ d->macro_->unlock();
// calculate dimension with label while editing
- if (lyxrc.macro_edit_style == LyXRC::MACRO_EDIT_INLINE_BOX
- && 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"));
+ augmentFont(font, "lyxtex");
Dimension namedim;
mathed_string_dim(font, name(), namedim);
#if 0
dim.asc += 1 + namedim.height() + 1;
dim.des += 2;
}
-
}
}
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()
+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 (macro_ == 0)
+ if (d->macro_ == 0)
return;
+ // remember nesting level of this macro
+ d->nesting_ = nesting;
+
// update requires
- requires_ = macro_->requires();
-
- if (!needsUpdate_
+ d->requires_ = d->macro_->requires();
+
+ if (!d->needsUpdate_
// non-normal mode? We are done!
- || (displayMode_ != DISPLAY_NORMAL))
+ || (d->displayMode_ != DISPLAY_NORMAL))
return;
- needsUpdate_ = false;
-
+ d->needsUpdate_ = false;
+
// get default values of macro
- vector<docstring> const & defaults = macro_->defaults();
-
+ 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]);
+ if (i < defaults.size())
+ proxy = new ArgumentProxy(this, i, defaults[i]);
else
- proxy = new ArgumentProxy(*this, i);
+ proxy = new ArgumentProxy(this, i);
values[i].insert(0, MathAtom(proxy));
}
// expanding macro with the values
- macro_->expand(values, expanded_.cell(0));
+ // 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 = macro_->display();
- asArray(display.empty() ? macro_->definition() : display, definition_);
+ docstring const & display = d->macro_->display();
+ asArray(display.empty() ? d->macro_->definition() : display,
+ d->definition_, Parse::QUIET);
}
{
Dimension const dim = dimension(*pi.base.bv);
- setPosCache(pi, x, y);
int expx = x;
int expy = y;
- if (displayMode_ == DISPLAY_INIT || displayMode_ == DISPLAY_INTERACTIVE_INIT) {
- FontSetChanger dummy(pi.base, "lyxtex");
+ 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 (displayMode_ == DISPLAY_UNFOLDED) {
- FontSetChanger dummy(pi.base, "lyxtex");
+ } 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
- && editing_[pi.base.bv]) {
+ && 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
- definition_.draw(pi, x, y);
- Dimension const & defDim = coords.getArrays().dim(&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,
+
+ 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 (drawBox && 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"));
+ augmentFont(font, "lyxtex");
font.setSize(FONT_SIZE_TINY);
font.setColor(Color_mathmacrolabel);
Dimension 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 - expanded_.cell(0).dimension(*pi.base.bv).width()) / 2;
+ expx += (dim.wid - d->expanded_.dimension(*pi.base.bv).width()) / 2;
}
- if (editing_[pi.base.bv]) {
+ 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,
+ 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);
if (!drawBox)
drawMarkers(pi, x, y);
+
}
// edit mode changed?
- if (editing_[pi.base.bv] != editMode(pi.base.bv))
+ 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, 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)
- appetite_ = (mode == DISPLAY_INTERACTIVE_INIT) ? 0 : 9;
+ d->appetite_ = (mode == DISPLAY_INTERACTIVE_INIT) ? 0 : 9;
else
- appetite_ = size_t(appetite);
+ 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;
{
docstring n = name();
- // empty name?
- if (n.size() == 0)
+ if (n.empty())
return false;
// converting back and force doesn't swallow anything?
for (size_t i = 0; i<n.size(); ++i) {
if (!(n[i] >= 'a' && n[i] <= 'z')
&& !(n[i] >= 'A' && n[i] <= 'Z')
- && n[i] != '*')
+ && n[i] != '*')
return false;
}
}
+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_;
+}
+
+
+MathClass MathMacro::mathClass() const
+{
+ // This can be just a heuristic, since it is only considered for display
+ // when the macro is not linearised. Therefore it affects:
+ // * The spacing of the inset while being edited,
+ // * Intelligent splitting
+ // * Cursor word movement (Ctrl-Arrow).
+ if (MacroData const * m = macroBackup()) {
+ // If it is a global macro and is defined explicitly
+ if (m->symbol()) {
+ MathClass mc = string_to_class(m->symbol()->extra);
+ if (mc != MC_UNKNOWN)
+ return mc;
+ }
+ }
+ // Otherwise guess from the expanded macro
+ return d->expanded_.mathClass();
+}
+
+
+InsetMath::mode_type MathMacro::currentMode() const
+{
+ // There is no way to guess the mode of user defined macros, so they are
+ // always assumed to be mathmode. Only the global macros defined in
+ // lib/symbols may be textmode.
+ mode_type mode = modeToEnsure();
+ return (mode == UNDECIDED_MODE) ? MATH_MODE : mode;
+}
+
+
+InsetMath::mode_type MathMacro::modeToEnsure() const
+{
+ // User defined macros can be either text mode or math mode for output and
+ // display. There is no way to guess. For global macros defined in
+ // lib/symbols, we ensure textmode if flagged as such, otherwise we ensure
+ // math mode.
+ if (MacroData const * m = macroBackup())
+ if (m->symbol())
+ return (m->symbol()->extra == "textmode") ? TEXT_MODE : MATH_MODE;
+ return UNDECIDED_MODE;
+}
+
+
+MacroData const * MathMacro::macroBackup() const
+{
+ if (macro())
+ return &d->macroBackup_;
+ if (MacroData const * data = MacroTable::globalMacros().get(name()))
+ return data;
+ return nullptr;
+}
+
+
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")
features.require("binom");
-
+
// validate the cells and the definition
if (displayMode() == DISPLAY_NORMAL) {
- definition_.validate(features);
+ d->definition_.validate(features);
InsetMathNest::validate(features);
}
}
// We may have 0 arguments, but InsetMathNest requires at least one.
if (nargs() > 0) {
cur.screenUpdateFlags(Update::SinglePar);
- return InsetMathNest::editXY(cur, x, y);
+ return InsetMathNest::editXY(cur, x, y);
} else
return this;
}
void MathMacro::removeArgument(Inset::pos_type pos) {
- if (displayMode_ == DISPLAY_NORMAL) {
- LASSERT(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) {
- LASSERT(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)
{
- LASSERT(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)
{
- LASSERT(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.screenUpdateFlags(Update::SinglePar);
return InsetMathNest::idxFirst(cur);
}
-bool MathMacro::idxLast(Cursor & cur) const
+bool MathMacro::idxLast(Cursor & cur) const
{
cur.screenUpdateFlags(Update::SinglePar);
return InsetMathNest::idxLast(cur);
bool MathMacro::notifyCursorLeaves(Cursor const & old, Cursor & cur)
{
- if (displayMode_ == DISPLAY_UNFOLDED) {
+ if (d->displayMode_ == DISPLAY_UNFOLDED) {
docstring const & unfolded_name = name();
- if (unfolded_name != name_) {
+ if (unfolded_name != d->name_) {
// The macro name was changed
Cursor inset_cursor = old;
int macroSlice = inset_cursor.find(this);
- LASSERT(macroSlice != -1, /**/);
+ // 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();
void MathMacro::fold(Cursor & cur)
{
- if (!nextFoldMode_) {
- nextFoldMode_ = true;
+ if (!d->nextFoldMode_) {
+ d->nextFoldMode_ = true;
cur.screenUpdateFlags(Update::SinglePar);
}
}
void MathMacro::unfold(Cursor & cur)
{
- if (nextFoldMode_) {
- nextFoldMode_ = false;
+ 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, macro_ != 0, true);
+ mode_type mode = modeToEnsure();
+ bool textmode_macro = mode == TEXT_MODE;
+ bool needs_mathmode = mode == MATH_MODE;
+ MathEnsurer ensurer(os, needs_mathmode, true, textmode_macro);
// non-normal mode
- if (displayMode_ != DISPLAY_NORMAL) {
+ if (d->displayMode_ != DISPLAY_NORMAL) {
os << "\\" << name();
if (name().size() != 1 || isAlphaASCII(name()[0]))
os.pendingSpace(true);
}
// normal mode
- LASSERT(macro_, /**/);
+ // 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);
- // optional arguments make macros fragile
- if (optionals_ > 0 && os.fragile())
+ // 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 < 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_;
-
+ i = d->optionals_;
+
// Print remaining arguments
for (; i < cells_.size(); ++i) {
- if (cell(i).size() == 1
+ if (cell(i).size() == 1
&& cell(i)[0].nucleus()->asCharInset()
- && cell(i)[0].nucleus()->asCharInset()->getChar() < 0x80) {
+ && isASCII(cell(i)[0].nucleus()->asCharInset()->getChar())) {
if (first)
os << " ";
os << cell(i);
first = false;
}
- // add space if there was no argument
- if (first)
+ // 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
{
- 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
{
- MathData const & data = expanded_.cell(0);
- if (data.empty()) {
+ // 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 << data;
+ os << d->expanded_;
}
void MathMacro::htmlize(HtmlStream & os) const
{
- MathData const & data = expanded_.cell(0);
- if (data.empty()) {
+ // 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 << data;
+ 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());
}
}
-CompletionList const *
+CompletionList const *
MathMacro::createCompletionList(Cursor const & cur) const
{
if (displayMode() != DISPLAY_UNFOLDED)
if (!completionSupported(cur))
return docstring();
-
+
return "\\" + name();
}
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;
}
{
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);
projects / lyx.git / blobdiff