#include "LaTeXFeatures.h"
#include "LyX.h"
#include "LyXRC.h"
+#include "MetricsInfo.h"
#include "frontends/Painter.h"
#include "support/gettext.h"
#include "support/lassert.h"
#include "support/lstrings.h"
+#include "support/RefChanger.h"
#include "support/textutils.h"
#include <ostream>
///
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());
- if (!mathMacro_->editMetrics(mi.base.bv)
- && mathMacro_->cell(idx_).empty())
- def_.metrics(mi, dim);
+ 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 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_->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);
- }
- ///
- size_t idx() const { return 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);
- }
private:
///
/// 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
bool isUpdating_;
/// maximal number of arguments the macro is greedy for
size_t appetite_;
+ /// Level of nesting in macros (including this one)
+ int nesting_;
};
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(MathMacro const & that)
: InsetMathNest(that), d(new Private(*that.d))
{
+ setBuffer(*that.buffer_);
d->updateChildren(this);
}
}
+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);
}
+int MathMacro::nesting() const
+{
+ return d->nesting_;
+}
+
+
void MathMacro::cursorPos(BufferView const & bv,
CursorSlice const & sl, bool boundary, int & x, int & y) const
{
}
-MacroData const * MathMacro::macro()
+MacroData const * MathMacro::macro() const
{
return d->macro_;
}
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
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(dim);
+ 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:
dim.asc += 1;
dim.des += 1;
dim.wid += 2;
- metricsMarkers2(dim);
+ metricsMarkers2(mi, dim);
} else {
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);
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
void MathMacro::updateRepresentation(Cursor * cur, MacroContext const & mc,
- UpdateType utype)
+ UpdateType utype, int nesting)
{
// block recursive calls (bug 8999)
if (d->isUpdating_)
if (d->macro_ == 0)
return;
+ // remember nesting level of this macro
+ d->nesting_ = nesting;
+
// update requires
d->requires_ = d->macro_->requires();
// protected by UpdateLocker.
if (d->macro_->expand(values, d->expanded_)) {
if (utype == OutputUpdate && !d->expanded_.empty())
- d->expanded_.updateMacros(cur, mc, utype);
+ 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_);
+ 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 (d->displayMode_ == DISPLAY_INIT || d->displayMode_ == DISPLAY_INTERACTIVE_INIT) {
- FontSetChanger dummy(pi.base, "lyxtex");
+ Changer dummy = pi.base.changeFontSet("lyxtex");
pi.pain.text(x, y, from_ascii("\\") + name(), pi.base.font);
} else if (d->displayMode_ == DISPLAY_UNFOLDED) {
- FontSetChanger dummy(pi.base, "lyxtex");
+ 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);
drawMarkers2(pi, expx, expy);
} else {
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)
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;
if (!drawBox)
drawMarkers(pi, x, y);
+
}
// edit mode changed?
}
+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
{
+ // 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");
void MathMacro::write(WriteStream & os) const
{
- MathEnsurer ensurer(os, d->macro_ != 0, true);
+ 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) {
// 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";
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);
}
docstring const xmlname = d->macro_->xmlname();
if (!xmlname.empty()) {
char const * type = d->macro_->MathMLtype();
- os << '<' << type << "> " << xmlname << " /<"
+ os << '<' << type << "> " << xmlname << " </"
<< type << '>';
return;
}
projects / lyx.git / blobdiff