#include "support/gettext.h"
#include "support/lassert.h"
#include "support/lstrings.h"
+#include "support/RefChanger.h"
#include "support/textutils.h"
#include <ostream>
///
MathMacro const * owner() { return mathMacro_; }
///
+ marker_type marker() const { return NO_MARKER; }
+ ///
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(mi.macro_nesting > 0);
- if (mi.macro_nesting == 1)
- mi.macro_nesting = 0;
+ 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() == 1 ? 0 : mathMacro_->nesting());
- MathRow::Element e_beg(MathRow::BEG_ARG, mi);
- e_beg.macro = mathMacro_;
+ MathRow::Element e_beg(mi, MathRow::BEGIN);
+ e_beg.inset = this;
e_beg.ar = &mathMacro_->cell(idx_);
mrow.push_back(e_beg);
mathMacro_->macro()->unlock();
- bool has_contents = mathMacro_->cell(idx_).addToMathRow(mrow, mi);
+ 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 && mi.macro_nesting == 0) {
- MathRow::Element e(MathRow::BOX, mi);
+ if (!has_contents && mathMacro_->nesting() == 1) {
+ // mathclass is ord because it should be spaced as a normal atom
+ MathRow::Element e(mi, MathRow::BOX, MC_ORD);
e.color = Color_mathline;
mrow.push_back(e);
has_contents = true;
}
- if (mi.macro_nesting == 0)
- mi.macro_nesting = 1;
-
- MathRow::Element e_end(MathRow::END_ARG, mi);
- e_end.macro = mathMacro_;
+ MathRow::Element e_end(mi, MathRow::END);
+ e_end.inset = this;
e_end.ar = &mathMacro_->cell(idx_);
-
mrow.push_back(e_end);
return has_contents;
}
///
- void metrics(MetricsInfo & mi, Dimension & dim) const {
- // macro arguments are in macros
- LATTEST(mi.macro_nesting > 0);
- if (mi.macro_nesting == 1)
- mi.macro_nesting = 0;
-
+ void beforeMetrics() const
+ {
mathMacro_->macro()->unlock();
- mathMacro_->cell(idx_).metrics(mi, dim);
-
- if (!mathMacro_->editMetrics(mi.base.bv)
- && mathMacro_->cell(idx_).empty())
- def_.metrics(mi, dim);
-
+ }
+ ///
+ void afterMetrics() const
+ {
mathMacro_->macro()->lock();
- if (mi.macro_nesting == 0)
- mi.macro_nesting = 1;
+ }
+ ///
+ void beforeDraw(PainterInfo const & pi) const
+ {
+ // if the macro is being edited, then the painter is in
+ // monochrome mode.
+ if (mathMacro_->editMetrics(pi.base.bv))
+ pi.pain.leaveMonochromeMode();
+ }
+ ///
+ void afterDraw(PainterInfo const & pi) const
+ {
+ if (mathMacro_->editMetrics(pi.base.bv))
+ pi.pain.enterMonochromeMode(Color_mathbg, Color_mathmacroblend);
+ }
+ ///
+ void metrics(MetricsInfo &, Dimension &) const {
+ // This should never be invoked, since ArgumentProxy insets are linearized
+ LATTEST(false);
+ }
+ ///
+ void draw(PainterInfo &, int, int) const {
+ // This should never be invoked, since ArgumentProxy insets are linearized
+ LATTEST(false);
+ }
+ ///
+ int kerning(BufferView const * bv) const
+ {
+ return displayCell(bv).kerning(bv);
}
// write(), normalize(), infoize() and infoize2() are not needed since
// MathMacro uses the definition and not the expanded cells.
///
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
+ MathClass mathClass() const
{
- if (mathMacro_->editMetrics(bv)
- || !mathMacro_->cell(idx_).empty())
- return mathMacro_->cell(idx_).kerning(bv);
- else
- return def_.kerning(bv);
+ 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:
bool isUpdating_;
/// maximal number of arguments the macro is greedy for
size_t appetite_;
+ /// Level of nesting in macros (including this one)
+ int nesting_;
};
// This is the same as what is done in metrics().
d->editing_[mi.base.bv] = editMode(mi.base.bv);
+ // For now we do not linearize in the following cases (can be improved)
+ // - display mode different from normal
+ // - editing with parameter list
+ // - editing with box around macro
if (displayMode() != MathMacro::DISPLAY_NORMAL
- || d->editing_[mi.base.bv])
+ || (d->editing_[mi.base.bv] && lyxrc.macro_edit_style != LyXRC::MACRO_EDIT_INLINE))
return InsetMath::addToMathRow(mrow, mi);
- MathRow::Element e_beg(MathRow::BEG_MACRO, mi);
- e_beg.macro = this;
- mrow.push_back(e_beg);
+ /// The macro nesting can change display of insets. Change it locally.
+ Changer chg = make_change(mi.base.macro_nesting, d->nesting_);
- ++mi.macro_nesting;
+ MathRow::Element e_beg(mi, MathRow::BEGIN);
+ e_beg.inset = this;
+ e_beg.marker = (d->nesting_ == 1 && nargs()) ? marker() : NO_MARKER;
+ mrow.push_back(e_beg);
d->macro_->lock();
bool has_contents = d->expanded_.addToMathRow(mrow, mi);
// if there was no contents and the array is editable, then we
// insert a grey box instead.
- if (!has_contents && mi.macro_nesting == 1) {
- MathRow::Element e(MathRow::BOX, mi);
+ if (!has_contents && mi.base.macro_nesting == 1) {
+ // mathclass is unknown because it is irrelevant for spacing
+ MathRow::Element e(mi, MathRow::BOX);
e.color = Color_mathmacroblend;
mrow.push_back(e);
has_contents = true;
}
- --mi.macro_nesting;
-
- MathRow::Element e_end(MathRow::END_MACRO, mi);
- e_end.macro = this;
+ MathRow::Element e_end(mi, MathRow::END);
+ e_end.inset = this;
mrow.push_back(e_end);
return has_contents;
}
+void MathMacro::beforeMetrics() const
+{
+ d->macro_->lock();
+}
+
+
+void MathMacro::afterMetrics() const
+{
+ d->macro_->unlock();
+}
+
+
+void MathMacro::beforeDraw(PainterInfo const & pi) const
+{
+ if (d->editing_[pi.base.bv])
+ pi.pain.enterMonochromeMode(Color_mathbg, Color_mathmacroblend);
+}
+
+
+void MathMacro::afterDraw(PainterInfo const & pi) const
+{
+ if (d->editing_[pi.base.bv])
+ pi.pain.leaveMonochromeMode();
+}
+
Inset * MathMacro::clone() const
{
}
+int MathMacro::nesting() const
+{
+ return d->nesting_;
+}
+
+
void MathMacro::cursorPos(BufferView const & bv,
CursorSlice const & sl, bool boundary, int & x, int & y) const
{
}
+Inset::marker_type MathMacro::marker() const
+{
+ switch (d->displayMode_) {
+ case DISPLAY_INIT:
+ case DISPLAY_INTERACTIVE_INIT:
+ return NO_MARKER;
+ case DISPLAY_UNFOLDED:
+ return MARKER;
+ default:
+ switch (lyxrc.macro_edit_style) {
+ case LyXRC::MACRO_EDIT_LIST:
+ return MARKER2;
+ case LyXRC::MACRO_EDIT_INLINE_BOX:
+ return NO_MARKER;
+ default:
+ return MARKER;
+ }
+ }
+}
+
+
void MathMacro::metrics(MetricsInfo & mi, Dimension & dim) const
{
- // the macro contents is not editable (except the arguments)
- ++mi.macro_nesting;
+ /// 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);
} 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);
} else {
LBUFERR(d->macro_);
dim.des += 2;
}
}
-
- // restore macro nesting
- --mi.macro_nesting;
}
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();
{
Dimension const dim = dimension(*pi.base.bv);
- setPosCache(pi, x, y);
int expx = x;
int expy = y;
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]) {
+ && 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;
+ // box needs one pixel
+ x += 1;
// get maximal font height
Dimension fontDim;
for (idx_type i = 0; i < nargs(); ++i) {
// position of label
Dimension const & cdim = coords.getArrays().dim(&cell(i));
- x = expx + 2;
+ x = expx + 1;
y += max(fontDim.asc, cdim.asc) + 1;
// draw label
y += max(fontDim.des, cdim.des);
}
- pi.pain.rectangle(expx + 1, expy - dim.asc + 1, dim.wid - 3,
+ pi.pain.rectangle(expx, expy - dim.asc + 1, dim.wid - 1,
dim.height() - 2, Color_mathmacroframe);
- drawMarkers2(pi, expx, expy);
} else {
- bool drawBox = lyxrc.macro_edit_style == LyXRC::MACRO_EDIT_INLINE_BOX;
- bool upshape = currentMode() == TEXT_MODE;
- Changer dummy = pi.base.font.changeShape(upshape ? UP_SHAPE
- : pi.base.font.shape());
+ bool drawBox = lyxrc.macro_edit_style == LyXRC::MACRO_EDIT_INLINE_BOX
+ && d->editing_[pi.base.bv];
// 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]) {
+ if (drawBox) {
// draw header and rectangle around
FontInfo font = pi.base.font;
augmentFont(font, "lyxtex");
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);
+ beforeDraw(pi);
+ d->expanded_.draw(pi, expx, expy);
+ afterDraw(pi);
- if (!drawBox)
- drawMarkers(pi, x, y);
+ if (drawBox)
+ pi.pain.rectangle(x, y - dim.asc, dim.wid,
+ dim.height(), Color_mathmacroframe);
}
// edit mode changed?
}
+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
{
- // User defined macros are always assumed to be mathmode macros.
- // Only the global macros defined in lib/symbols may be textmode.
+ // 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;
+}
+
- MacroData const * data = MacroTable::globalMacros().get(name());
- bool textmode = data && data->symbol() && data->symbol()->extra == "textmode";
- return textmode ? TEXT_MODE : MATH_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::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");
-
+ 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
// 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);
}
projects / lyx.git / blobdiff