mirror of
https://git.lyx.org/repos/lyx.git
synced 2024-11-28 20:45:47 +00:00
76188dcdf1
Set the buffer of contents that is added to a MathData object through
MathData::insert() (both versions)
MathData::push_back()
asArray()
Also in math macros, initialize look_ with the relevant buffer.
This reduces the number of insets hat do not have a proper buffer.
See #13050 for discussion of this issue.
(cherry picked from commit f3c5ff9cb7)
1412 lines
34 KiB
C++
1412 lines
34 KiB
C++
/**
|
|
* \file InsetMathMacroTemplate.cpp
|
|
* This file is part of LyX, the document processor.
|
|
* Licence details can be found in the file COPYING.
|
|
*
|
|
* \author André Pönitz
|
|
* \author Stefan Schimanski
|
|
*
|
|
* Full author contact details are available in file CREDITS.
|
|
*/
|
|
|
|
#include <config.h>
|
|
|
|
#include "InsetMathMacroTemplate.h"
|
|
|
|
#include "InsetMathBrace.h"
|
|
#include "InsetMathChar.h"
|
|
#include "InsetMathHull.h"
|
|
#include "InsetMathSqrt.h"
|
|
#include "InsetMathMacro.h"
|
|
#include "InsetMathMacroArgument.h"
|
|
#include "MathStream.h"
|
|
#include "MathParser.h"
|
|
#include "MathSupport.h"
|
|
|
|
#include "Buffer.h"
|
|
#include "BufferView.h"
|
|
#include "Color.h"
|
|
#include "Cursor.h"
|
|
#include "DispatchResult.h"
|
|
#include "DocIterator.h"
|
|
#include "FuncRequest.h"
|
|
#include "FuncStatus.h"
|
|
#include "LaTeXFeatures.h"
|
|
#include "Lexer.h"
|
|
#include "MetricsInfo.h"
|
|
#include "TocBackend.h"
|
|
|
|
#include "frontends/Painter.h"
|
|
|
|
#include "insets/RenderPreview.h"
|
|
|
|
#include "support/lassert.h"
|
|
#include "support/convert.h"
|
|
#include "support/debug.h"
|
|
#include "support/gettext.h"
|
|
#include "support/docstream.h"
|
|
#include "support/lstrings.h"
|
|
|
|
#include <set>
|
|
#include <sstream>
|
|
|
|
using namespace std;
|
|
|
|
namespace lyx {
|
|
|
|
using support::bformat;
|
|
|
|
//////////////////////////////////////////////////////////////////////
|
|
|
|
class InsetLabelBox : public InsetMathNest {
|
|
public:
|
|
///
|
|
InsetLabelBox(Buffer * buf, MathAtom const & atom, docstring const & label,
|
|
InsetMathMacroTemplate const & parent, bool frame = false);
|
|
InsetLabelBox(Buffer * buf, docstring const & label, InsetMathMacroTemplate const & parent,
|
|
bool frame = false);
|
|
///
|
|
void metrics(MetricsInfo & mi, Dimension & dim) const override;
|
|
///
|
|
void draw(PainterInfo &, int x, int y) const override;
|
|
|
|
protected:
|
|
///
|
|
InsetMathMacroTemplate const & parent_;
|
|
///
|
|
Inset * clone() const override;
|
|
///
|
|
docstring const label_;
|
|
///
|
|
bool frame_;
|
|
};
|
|
|
|
|
|
InsetLabelBox::InsetLabelBox(Buffer * buf, MathAtom const & atom, docstring const & label,
|
|
InsetMathMacroTemplate const & parent, bool frame)
|
|
: InsetMathNest(buf, 1), parent_(parent), label_(label), frame_(frame)
|
|
{
|
|
cell(0).insert(0, atom);
|
|
}
|
|
|
|
|
|
InsetLabelBox::InsetLabelBox(Buffer * buf, docstring const & label,
|
|
InsetMathMacroTemplate const & parent, bool frame)
|
|
: InsetMathNest(buf, 1), parent_(parent), label_(label), frame_(frame)
|
|
{
|
|
}
|
|
|
|
|
|
Inset * InsetLabelBox::clone() const
|
|
{
|
|
return new InsetLabelBox(*this);
|
|
}
|
|
|
|
|
|
void InsetLabelBox::metrics(MetricsInfo & mi, Dimension & dim) const
|
|
{
|
|
// kernel
|
|
cell(0).metrics(mi, dim);
|
|
|
|
// frame
|
|
if (frame_) {
|
|
dim.wid += 6;
|
|
dim.asc += 5;
|
|
dim.des += 5;
|
|
}
|
|
|
|
// adjust to common height in main metrics phase
|
|
if (!parent_.premetrics()) {
|
|
dim.asc = max(dim.asc, parent_.commonLabelBoxAscent());
|
|
dim.des = max(dim.des, parent_.commonLabelBoxDescent());
|
|
}
|
|
|
|
// label
|
|
if (parent_.editing(mi.base.bv) && label_.length() > 0) {
|
|
// grey
|
|
FontInfo font = sane_font;
|
|
font.setSize(TINY_SIZE);
|
|
font.setColor(Color_mathmacrolabel);
|
|
|
|
// make space for label and box
|
|
int lwid = mathed_string_width(font, label_);
|
|
int maxasc;
|
|
int maxdes;
|
|
math_font_max_dim(font, maxasc, maxdes);
|
|
|
|
dim.wid = max(dim.wid, lwid + 2);
|
|
|
|
// space for the label
|
|
if (!parent_.premetrics())
|
|
dim.des += maxasc + maxdes + 1;
|
|
}
|
|
}
|
|
|
|
|
|
void InsetLabelBox::draw(PainterInfo & pi, int x, int y) const
|
|
{
|
|
Dimension const dim = dimension(*pi.base.bv);
|
|
Dimension const cdim = cell(0).dimension(*pi.base.bv);
|
|
|
|
// kernel
|
|
cell(0).draw(pi, x + (dim.wid - cdim.wid) / 2, y);
|
|
|
|
// label
|
|
if (parent_.editing(pi.base.bv) && label_.length() > 0) {
|
|
// grey
|
|
FontInfo font = sane_font;
|
|
font.setSize(TINY_SIZE);
|
|
font.setColor(Color_mathmacrolabel);
|
|
|
|
// make space for label and box
|
|
int lwid = mathed_string_width(font, label_);
|
|
int maxasc;
|
|
int maxdes;
|
|
math_font_max_dim(font, maxasc, maxdes);
|
|
|
|
if (lwid < dim.wid)
|
|
pi.pain.text(x + (dim.wid - lwid) / 2, y + dim.des - maxdes, label_, font);
|
|
else
|
|
pi.pain.text(x, y + dim.des - maxdes, label_, font);
|
|
}
|
|
|
|
// draw frame
|
|
int boxHeight = parent_.commonLabelBoxAscent() + parent_.commonLabelBoxDescent();
|
|
if (frame_) {
|
|
pi.pain.rectangle(x + 1, y - dim.ascent() + 1,
|
|
dim.wid - 2, boxHeight - 2,
|
|
Color_mathline);
|
|
}
|
|
}
|
|
|
|
|
|
//////////////////////////////////////////////////////////////////////
|
|
|
|
class InsetDisplayLabelBox : public InsetLabelBox {
|
|
public:
|
|
///
|
|
InsetDisplayLabelBox(Buffer * buf, MathAtom const & atom, docstring const & label,
|
|
InsetMathMacroTemplate const & parent);
|
|
|
|
///
|
|
marker_type marker(BufferView const *) const override;
|
|
///
|
|
void metrics(MetricsInfo & mi, Dimension & dim) const override;
|
|
///
|
|
void draw(PainterInfo &, int x, int y) const override;
|
|
|
|
protected:
|
|
///
|
|
Inset * clone() const override;
|
|
};
|
|
|
|
|
|
InsetDisplayLabelBox::InsetDisplayLabelBox(Buffer * buf, MathAtom const & atom,
|
|
docstring const & label,
|
|
InsetMathMacroTemplate const & parent)
|
|
: InsetLabelBox(buf, atom, label, parent, true)
|
|
{
|
|
}
|
|
|
|
|
|
|
|
Inset * InsetDisplayLabelBox::clone() const
|
|
{
|
|
return new InsetDisplayLabelBox(*this);
|
|
}
|
|
|
|
|
|
marker_type InsetDisplayLabelBox::marker(BufferView const * bv) const
|
|
{
|
|
if (parent_.editing(bv)
|
|
|| !parent_.cell(parent_.displayIdx()).empty())
|
|
return marker_type::MARKER;
|
|
else
|
|
return marker_type::NO_MARKER;
|
|
}
|
|
|
|
|
|
void InsetDisplayLabelBox::metrics(MetricsInfo & mi, Dimension & dim) const
|
|
{
|
|
InsetLabelBox::metrics(mi, dim);
|
|
if (!parent_.editing(mi.base.bv)
|
|
&& parent_.cell(parent_.displayIdx()).empty())
|
|
dim.clear();
|
|
}
|
|
|
|
|
|
void InsetDisplayLabelBox::draw(PainterInfo & pi, int x, int y) const
|
|
{
|
|
if (parent_.editing(pi.base.bv)
|
|
|| !parent_.cell(parent_.displayIdx()).empty()
|
|
|| pi.pain.isNull())
|
|
InsetLabelBox::draw(pi, x, y);
|
|
}
|
|
|
|
|
|
//////////////////////////////////////////////////////////////////////
|
|
|
|
class InsetMathWrapper : public InsetMath {
|
|
public:
|
|
///
|
|
explicit InsetMathWrapper(MathData const * value) : value_(value) {}
|
|
///
|
|
void metrics(MetricsInfo & mi, Dimension & dim) const override;
|
|
///
|
|
void draw(PainterInfo &, int x, int y) const override;
|
|
|
|
private:
|
|
///
|
|
Inset * clone() const override;
|
|
///
|
|
MathData const * value_;
|
|
};
|
|
|
|
|
|
Inset * InsetMathWrapper::clone() const
|
|
{
|
|
return new InsetMathWrapper(*this);
|
|
}
|
|
|
|
|
|
void InsetMathWrapper::metrics(MetricsInfo & mi, Dimension & dim) const
|
|
{
|
|
value_->metrics(mi, dim);
|
|
}
|
|
|
|
|
|
void InsetMathWrapper::draw(PainterInfo & pi, int x, int y) const
|
|
{
|
|
value_->draw(pi, x, y);
|
|
}
|
|
|
|
|
|
///////////////////////////////////////////////////////////////////////
|
|
class InsetColoredCell : public InsetMathNest {
|
|
public:
|
|
///
|
|
InsetColoredCell(Buffer * buf, ColorCode blend);
|
|
///
|
|
InsetColoredCell(Buffer * buf, ColorCode blend, MathAtom const & atom);
|
|
///
|
|
void draw(PainterInfo &, int x, int y) const override;
|
|
///
|
|
void metrics(MetricsInfo & mi, Dimension & dim) const override;
|
|
|
|
protected:
|
|
///
|
|
Inset * clone() const override;
|
|
///
|
|
ColorCode blend_;
|
|
};
|
|
|
|
|
|
InsetColoredCell::InsetColoredCell(Buffer * buf, ColorCode blend)
|
|
: InsetMathNest(buf, 1), blend_(blend)
|
|
{
|
|
}
|
|
|
|
|
|
InsetColoredCell::InsetColoredCell(Buffer * buf, ColorCode blend, MathAtom const & atom)
|
|
: InsetMathNest(buf, 1), blend_(blend)
|
|
{
|
|
cell(0).insert(0, atom);
|
|
}
|
|
|
|
|
|
Inset * InsetColoredCell::clone() const
|
|
{
|
|
return new InsetColoredCell(*this);
|
|
}
|
|
|
|
|
|
void InsetColoredCell::metrics(MetricsInfo & mi, Dimension & dim) const
|
|
{
|
|
cell(0).metrics(mi, dim);
|
|
}
|
|
|
|
|
|
void InsetColoredCell::draw(PainterInfo & pi, int x, int y) const
|
|
{
|
|
pi.pain.enterMonochromeMode(blend_);
|
|
cell(0).draw(pi, x, y);
|
|
pi.pain.leaveMonochromeMode();
|
|
}
|
|
|
|
|
|
///////////////////////////////////////////////////////////////////////
|
|
|
|
class InsetNameWrapper : public InsetMathWrapper {
|
|
public:
|
|
///
|
|
InsetNameWrapper(MathData const * value, InsetMathMacroTemplate const & parent);
|
|
///
|
|
void metrics(MetricsInfo & mi, Dimension & dim) const override;
|
|
///
|
|
void draw(PainterInfo &, int x, int y) const override;
|
|
|
|
private:
|
|
///
|
|
InsetMathMacroTemplate const & parent_;
|
|
///
|
|
Inset * clone() const override;
|
|
};
|
|
|
|
|
|
InsetNameWrapper::InsetNameWrapper(MathData const * value,
|
|
InsetMathMacroTemplate const & parent)
|
|
: InsetMathWrapper(value), parent_(parent)
|
|
{
|
|
}
|
|
|
|
|
|
Inset * InsetNameWrapper::clone() const
|
|
{
|
|
return new InsetNameWrapper(*this);
|
|
}
|
|
|
|
|
|
void InsetNameWrapper::metrics(MetricsInfo & mi, Dimension & dim) const
|
|
{
|
|
Changer dummy = mi.base.changeFontSet("textit");
|
|
InsetMathWrapper::metrics(mi, dim);
|
|
dim.wid += mathed_string_width(mi.base.font, from_ascii("\\"));
|
|
}
|
|
|
|
|
|
void InsetNameWrapper::draw(PainterInfo & pi, int x, int y) const
|
|
{
|
|
ColorCode const color = parent_.validMacro() ? Color_latex : Color_error;
|
|
|
|
Changer dummy = pi.base.changeFontSet("textit");
|
|
Changer dummy2 = pi.base.font.changeColor(color);
|
|
|
|
// draw backslash
|
|
pi.pain.text(x, y, from_ascii("\\"), pi.base.font);
|
|
x += mathed_string_width(pi.base.font, from_ascii("\\"));
|
|
|
|
// draw name
|
|
InsetMathWrapper::draw(pi, x, y);
|
|
}
|
|
|
|
|
|
///////////////////////////////////////////////////////////////////////
|
|
|
|
|
|
InsetMathMacroTemplate::InsetMathMacroTemplate(Buffer * buf)
|
|
: InsetMathNest(buf, 3), look_(buf), numargs_(0), argsInLook_(0), optionals_(0),
|
|
type_(MacroTypeNewcommand), redefinition_(false), lookOutdated_(true),
|
|
premetrics_(false), labelBoxAscent_(0), labelBoxDescent_(0)
|
|
{
|
|
initMath();
|
|
}
|
|
|
|
|
|
InsetMathMacroTemplate::InsetMathMacroTemplate(Buffer * buf, docstring const & name, int numargs,
|
|
int optionals, MacroType type, vector<MathData> const & optionalValues,
|
|
MathData const & def, MathData const & display)
|
|
: InsetMathNest(buf, optionals + 3), look_(buf), numargs_(numargs),
|
|
argsInLook_(numargs), optionals_(optionals), optionalValues_(optionalValues),
|
|
type_(type), redefinition_(false), lookOutdated_(true),
|
|
premetrics_(false), labelBoxAscent_(0), labelBoxDescent_(0)
|
|
{
|
|
initMath();
|
|
|
|
if (numargs_ > 9)
|
|
lyxerr << "InsetMathMacroTemplate::InsetMathMacroTemplate: wrong # of arguments: "
|
|
<< numargs_ << endl;
|
|
|
|
asArray(name, cell(0));
|
|
optionalValues_.resize(9);
|
|
for (int i = 0; i < optionals_; ++i)
|
|
cell(optIdx(i)) = optionalValues_[i];
|
|
cell(defIdx()) = def;
|
|
cell(displayIdx()) = display;
|
|
|
|
updateLook();
|
|
}
|
|
|
|
|
|
bool InsetMathMacroTemplate::fromString(docstring const & str)
|
|
{
|
|
MathData ar(buffer_);
|
|
mathed_parse_cell(ar, str, Parse::NORMAL);
|
|
if (ar.size() != 1 || !ar[0]->asMacroTemplate()) {
|
|
lyxerr << "Cannot read macro from '" << ar << "'" << endl;
|
|
asArray(from_ascii("invalidmacro"), cell(0));
|
|
// The macro template does not make sense after this.
|
|
return false;
|
|
}
|
|
operator=( *(ar[0]->asMacroTemplate()) );
|
|
|
|
updateLook();
|
|
return true;
|
|
}
|
|
|
|
|
|
Inset * InsetMathMacroTemplate::clone() const
|
|
{
|
|
InsetMathMacroTemplate * inset = new InsetMathMacroTemplate(*this);
|
|
// the parent pointers of the proxy insets above will point to
|
|
// to the old template. Hence, the look must be updated.
|
|
inset->updateLook();
|
|
return inset;
|
|
}
|
|
|
|
|
|
docstring InsetMathMacroTemplate::name() const
|
|
{
|
|
return asString(cell(0));
|
|
}
|
|
|
|
|
|
void InsetMathMacroTemplate::updateToContext(MacroContext const & mc)
|
|
{
|
|
redefinition_ = mc.get(name()) != 0;
|
|
}
|
|
|
|
|
|
void InsetMathMacroTemplate::updateLook() const
|
|
{
|
|
lookOutdated_ = true;
|
|
}
|
|
|
|
|
|
void InsetMathMacroTemplate::createLook(int args) const
|
|
{
|
|
look_.clear();
|
|
argsInLook_ = args;
|
|
|
|
// \foo
|
|
look_.push_back(MathAtom(
|
|
new InsetLabelBox(buffer_, _("Name"), *this, false)));
|
|
MathData & nameData = look_[look_.size() - 1].nucleus()->cell(0);
|
|
nameData.push_back(MathAtom(new InsetNameWrapper(&cell(0), *this)));
|
|
|
|
// [#1][#2]
|
|
int i = 0;
|
|
if (optionals_ > 0) {
|
|
look_.push_back(MathAtom(
|
|
new InsetLabelBox(buffer_, _("optional"), *this, false)));
|
|
|
|
MathData * optData = &look_[look_.size() - 1].nucleus()->cell(0);
|
|
for (; i < optionals_; ++i) {
|
|
// color it light grey, if it is to be removed when the cursor leaves
|
|
if (i == argsInLook_) {
|
|
optData->push_back(MathAtom(
|
|
new InsetColoredCell(buffer_, Color_mathmacrooldarg)));
|
|
optData = &(*optData)[optData->size() - 1].nucleus()->cell(0);
|
|
}
|
|
|
|
optData->push_back(MathAtom(new InsetMathChar('[')));
|
|
optData->push_back(MathAtom(new InsetMathWrapper(&cell(1 + i))));
|
|
optData->push_back(MathAtom(new InsetMathChar(']')));
|
|
}
|
|
}
|
|
|
|
// {#3}{#4}
|
|
for (; i < numargs_; ++i) {
|
|
MathData arg;
|
|
arg.push_back(MathAtom(new InsetMathMacroArgument(i + 1)));
|
|
if (i >= argsInLook_) {
|
|
look_.push_back(MathAtom(new InsetColoredCell(buffer_,
|
|
Color_mathmacrooldarg,
|
|
MathAtom(new InsetMathBrace(arg)))));
|
|
} else
|
|
look_.push_back(MathAtom(new InsetMathBrace(arg)));
|
|
}
|
|
for (; i < argsInLook_; ++i) {
|
|
MathData arg;
|
|
arg.push_back(MathAtom(new InsetMathMacroArgument(i + 1)));
|
|
look_.push_back(MathAtom(new InsetColoredCell(buffer_,
|
|
Color_mathmacronewarg,
|
|
MathAtom(new InsetMathBrace(arg)))));
|
|
}
|
|
|
|
// :=
|
|
look_.push_back(MathAtom(new InsetMathChar(':')));
|
|
look_.push_back(MathAtom(new InsetMathChar('=')));
|
|
|
|
// definition
|
|
look_.push_back(MathAtom(
|
|
new InsetLabelBox(buffer_, MathAtom(
|
|
new InsetMathWrapper(&cell(defIdx()))), _("TeX"), *this, true)));
|
|
|
|
// display
|
|
look_.push_back(MathAtom(
|
|
new InsetDisplayLabelBox(buffer_, MathAtom(
|
|
new InsetMathWrapper(&cell(displayIdx()))), _("LyX"), *this)));
|
|
|
|
look_.setContentsBuffer();
|
|
}
|
|
|
|
|
|
void InsetMathMacroTemplate::metrics(MetricsInfo & mi, Dimension & dim) const
|
|
{
|
|
Changer dummy1 = mi.base.changeFontSet("mathnormal");
|
|
Changer dummy2 = mi.base.font.changeStyle(TEXT_STYLE);
|
|
|
|
// valid macro?
|
|
MacroData const * macro = 0;
|
|
if (validName())
|
|
macro = mi.macrocontext.get(name());
|
|
|
|
// update look?
|
|
int argsInDef = maxArgumentInDefinition();
|
|
if (lookOutdated_ || argsInDef != argsInLook_) {
|
|
lookOutdated_ = false;
|
|
createLook(argsInDef);
|
|
}
|
|
|
|
/// metrics for inset contents
|
|
if (macro)
|
|
macro->lock();
|
|
|
|
// first phase, premetric:
|
|
premetrics_ = true;
|
|
look_.metrics(mi, dim);
|
|
labelBoxAscent_ = dim.asc;
|
|
labelBoxDescent_ = dim.des;
|
|
|
|
// second phase, main metric:
|
|
premetrics_ = false;
|
|
look_.metrics(mi, dim);
|
|
|
|
if (macro)
|
|
macro->unlock();
|
|
|
|
dim.wid += leftOffset(mi.base.bv) + rightOffset(mi.base.bv);
|
|
dim.des += bottomOffset(mi.base.bv);
|
|
dim.asc += topOffset(mi.base.bv);
|
|
}
|
|
|
|
|
|
void InsetMathMacroTemplate::draw(PainterInfo & pi, int x, int y) const
|
|
{
|
|
// FIXME: Calling Changer on the same object repeatedly is inefficient.
|
|
Changer dummy0 = pi.base.font.changeColor(Color_math);
|
|
Changer dummy1 = pi.base.changeFontSet("mathnormal");
|
|
Changer dummy2 = pi.base.font.changeStyle(TEXT_STYLE);
|
|
|
|
Dimension const dim = dimension(*pi.base.bv);
|
|
|
|
// draw outer frame
|
|
int const hoffset = leftOffset(pi.base.bv) + rightOffset(pi.base.bv);
|
|
int const voffset = topOffset(pi.base.bv) + bottomOffset(pi.base.bv);
|
|
int const a = y - dim.asc + topOffset(pi.base.bv) / 2;
|
|
int const w = dim.wid - (hoffset - hoffset / 2);
|
|
int const h = dim.height() - (voffset - voffset / 2);
|
|
pi.pain.rectangle(x + leftOffset(pi.base.bv) / 2, a, w, h, Color_mathframe);
|
|
|
|
// just to be sure: set some dummy values for coord cache
|
|
for (idx_type i = 0; i < nargs(); ++i)
|
|
cell(i).setXY(*pi.base.bv, x, y);
|
|
|
|
// draw contents
|
|
look_.draw(pi, x + leftOffset(pi.base.bv), y);
|
|
}
|
|
|
|
|
|
void InsetMathMacroTemplate::edit(Cursor & cur, bool front, EntryDirection entry_from)
|
|
{
|
|
updateLook();
|
|
cur.screenUpdateFlags(Update::SinglePar);
|
|
InsetMathNest::edit(cur, front, entry_from);
|
|
}
|
|
|
|
|
|
bool InsetMathMacroTemplate::notifyCursorLeaves(Cursor const & old, Cursor & cur)
|
|
{
|
|
unsigned int const nargs_before = nargs();
|
|
commitEditChanges(cur, old);
|
|
updateLook();
|
|
cur.screenUpdateFlags(Update::Force);
|
|
// If we have removed a cell, we might have invalidated the cursor
|
|
return InsetMathNest::notifyCursorLeaves(old, cur)
|
|
|| nargs() < nargs_before;
|
|
}
|
|
|
|
|
|
void InsetMathMacroTemplate::removeArguments(Cursor & cur,
|
|
DocIterator const & /*inset_pos*/, int from, int to)
|
|
{
|
|
DocIterator it = doc_iterator_begin(&buffer(), this);
|
|
for (; it; it.forwardChar()) {
|
|
if (!it.nextInset())
|
|
continue;
|
|
if (it.nextInset()->lyxCode() != MATH_MACROARG_CODE)
|
|
continue;
|
|
InsetMathMacroArgument * arg = static_cast<InsetMathMacroArgument*>(it.nextInset());
|
|
int n = arg->number() - 1;
|
|
if (from <= n && n <= to) {
|
|
int cellSlice = cur.find(it.cell());
|
|
if (cellSlice != -1 && cur[cellSlice].pos() > it.pos())
|
|
--cur[cellSlice].pos();
|
|
|
|
it.cell().erase(it.pos());
|
|
}
|
|
}
|
|
|
|
updateLook();
|
|
}
|
|
|
|
|
|
void InsetMathMacroTemplate::shiftArguments(size_t from, int by)
|
|
{
|
|
for (DocIterator it = doc_iterator_begin(&buffer(), this); it; it.forwardChar()) {
|
|
if (!it.nextInset())
|
|
continue;
|
|
if (it.nextInset()->lyxCode() != MATH_MACROARG_CODE)
|
|
continue;
|
|
InsetMathMacroArgument * arg = static_cast<InsetMathMacroArgument*>(it.nextInset());
|
|
if (arg->number() >= int(from) + 1)
|
|
arg->setNumber(arg->number() + by);
|
|
}
|
|
|
|
updateLook();
|
|
}
|
|
|
|
|
|
int InsetMathMacroTemplate::maxArgumentInDefinition() const
|
|
{
|
|
// We don't have a buffer when pasting from the clipboard (bug 6014).
|
|
Buffer const * macro_buffer = isBufferLoaded() ? &buffer() : 0;
|
|
int maxArg = 0;
|
|
DocIterator it = doc_iterator_begin(macro_buffer, this);
|
|
it.idx() = defIdx();
|
|
for (; it; it.forwardChar()) {
|
|
if (!it.nextInset())
|
|
continue;
|
|
if (it.nextInset()->lyxCode() != MATH_MACROARG_CODE)
|
|
continue;
|
|
InsetMathMacroArgument * arg = static_cast<InsetMathMacroArgument*>(it.nextInset());
|
|
maxArg = std::max(arg->number(), maxArg);
|
|
}
|
|
return maxArg;
|
|
}
|
|
|
|
|
|
void InsetMathMacroTemplate::insertMissingArguments(int maxArg)
|
|
{
|
|
bool found[9] = { false, false, false, false, false, false, false, false, false };
|
|
idx_type idx = cell(displayIdx()).empty() ? defIdx() : displayIdx();
|
|
|
|
// search for #n macros arguments
|
|
DocIterator it = doc_iterator_begin(&buffer(), this);
|
|
it.idx() = idx;
|
|
for (; it && it[0].idx() == idx; it.forwardChar()) {
|
|
if (!it.nextInset())
|
|
continue;
|
|
if (it.nextInset()->lyxCode() != MATH_MACROARG_CODE)
|
|
continue;
|
|
InsetMathMacroArgument * arg = static_cast<InsetMathMacroArgument*>(it.nextInset());
|
|
found[arg->number() - 1] = true;
|
|
}
|
|
|
|
// add missing ones
|
|
for (int i = 0; i < maxArg; ++i) {
|
|
if (found[i])
|
|
continue;
|
|
|
|
cell(idx).push_back(MathAtom(new InsetMathMacroArgument(i + 1)));
|
|
}
|
|
}
|
|
|
|
|
|
void InsetMathMacroTemplate::changeArity(Cursor & cur,
|
|
DocIterator const & inset_pos, int newNumArg)
|
|
{
|
|
// remove parameter which do not appear anymore in the definition
|
|
for (int i = numargs_; i > newNumArg; --i)
|
|
removeParameter(cur, inset_pos, numargs_ - 1, true);
|
|
|
|
// add missing parameter
|
|
for (int i = numargs_; i < newNumArg; ++i)
|
|
insertParameter(cur, inset_pos, numargs_, true, false);
|
|
}
|
|
|
|
|
|
///
|
|
class AddRemoveMacroInstanceFix
|
|
{
|
|
public:
|
|
///
|
|
AddRemoveMacroInstanceFix(int n, bool insert) : n_(n), insert_(insert) {}
|
|
///
|
|
void operator()(InsetMathMacro * macro)
|
|
{
|
|
if (macro->folded()) {
|
|
if (insert_)
|
|
macro->insertArgument(n_);
|
|
else
|
|
macro->removeArgument(n_);
|
|
}
|
|
}
|
|
|
|
private:
|
|
///
|
|
int n_;
|
|
///
|
|
bool insert_;
|
|
};
|
|
|
|
|
|
///
|
|
class OptionalsMacroInstanceFix
|
|
{
|
|
public:
|
|
///
|
|
explicit OptionalsMacroInstanceFix(int optionals) : optionals_(optionals) {}
|
|
///
|
|
void operator()(InsetMathMacro * macro)
|
|
{
|
|
macro->setOptionals(optionals_);
|
|
}
|
|
|
|
private:
|
|
///
|
|
int optionals_;
|
|
};
|
|
|
|
|
|
///
|
|
class NullMacroInstanceFix
|
|
{
|
|
public:
|
|
///
|
|
void operator()(InsetMathMacro * ) {}
|
|
};
|
|
|
|
|
|
template<class F>
|
|
void fixMacroInstances(Cursor & cur, DocIterator const & inset_pos,
|
|
docstring const & name, F & fix)
|
|
{
|
|
// goto position behind macro template
|
|
DocIterator dit = inset_pos;
|
|
dit.pop_back();
|
|
dit.top().forwardPos();
|
|
|
|
// remember hull to trigger preview reload
|
|
DocIterator hull(dit.buffer());
|
|
bool preview_reload_needed = false;
|
|
set<DocIterator> preview_hulls;
|
|
|
|
// iterate over all positions until macro is redefined
|
|
for (; dit; dit.forwardPos()) {
|
|
// left the outer hull?
|
|
if (!hull.empty() && dit.depth() == hull.depth()) {
|
|
// schedule reload of the preview if necessary
|
|
if (preview_reload_needed) {
|
|
preview_hulls.insert(hull);
|
|
preview_reload_needed = false;
|
|
}
|
|
hull.clear();
|
|
}
|
|
|
|
// only until a macro is redefined
|
|
if (dit.inset().lyxCode() == MATHMACRO_CODE) {
|
|
InsetMathMacroTemplate const & macroTemplate
|
|
= static_cast<InsetMathMacroTemplate const &>(dit.inset());
|
|
if (macroTemplate.name() == name)
|
|
break;
|
|
}
|
|
|
|
// in front of macro instance?
|
|
Inset * inset = dit.nextInset();
|
|
if (!inset)
|
|
continue;
|
|
InsetMath * insetMath = inset->asInsetMath();
|
|
if (!insetMath)
|
|
continue;
|
|
|
|
// in front of outer hull?
|
|
InsetMathHull * inset_hull = insetMath->asHullInset();
|
|
if (inset_hull && hull.empty()) {
|
|
// remember this for later preview reload
|
|
hull = dit;
|
|
}
|
|
|
|
InsetMathMacro * macro = insetMath->asMacro();
|
|
if (macro && macro->name() == name && macro->folded()) {
|
|
fix(macro);
|
|
if (RenderPreview::previewMath())
|
|
preview_reload_needed = true;
|
|
}
|
|
}
|
|
|
|
if (!preview_hulls.empty()) {
|
|
// reload the scheduled previews
|
|
set<DocIterator>::const_iterator sit = preview_hulls.begin();
|
|
set<DocIterator>::const_iterator end = preview_hulls.end();
|
|
for (; sit != end; ++sit) {
|
|
InsetMathHull * inset_hull =
|
|
sit->nextInset()->asInsetMath()->asHullInset();
|
|
LBUFERR(inset_hull);
|
|
inset_hull->reloadPreview(*sit);
|
|
}
|
|
cur.screenUpdateFlags(Update::Force);
|
|
}
|
|
}
|
|
|
|
|
|
void InsetMathMacroTemplate::commitEditChanges(Cursor & cur,
|
|
DocIterator const & inset_pos)
|
|
{
|
|
int args_in_def = maxArgumentInDefinition();
|
|
if (args_in_def != numargs_) {
|
|
// FIXME: implement precise undo handling (only a few places
|
|
// need undo)
|
|
cur.recordUndoFullBuffer();
|
|
changeArity(cur, inset_pos, args_in_def);
|
|
}
|
|
insertMissingArguments(args_in_def);
|
|
|
|
// make sure the preview are up to date
|
|
NullMacroInstanceFix fix;
|
|
fixMacroInstances(cur, inset_pos, name(), fix);
|
|
}
|
|
|
|
|
|
void InsetMathMacroTemplate::insertParameter(Cursor & cur,
|
|
DocIterator const & inset_pos, int pos, bool greedy, bool addarg)
|
|
{
|
|
if (pos <= numargs_ && pos >= optionals_ && numargs_ < 9) {
|
|
++numargs_;
|
|
|
|
// append example #n
|
|
if (addarg) {
|
|
shiftArguments(pos, 1);
|
|
|
|
cell(defIdx()).push_back(MathAtom(new InsetMathMacroArgument(pos + 1)));
|
|
if (!cell(displayIdx()).empty())
|
|
cell(displayIdx()).push_back(MathAtom(new InsetMathMacroArgument(pos + 1)));
|
|
}
|
|
|
|
if (!greedy) {
|
|
// fix macro instances
|
|
AddRemoveMacroInstanceFix fix(pos, true);
|
|
fixMacroInstances(cur, inset_pos, name(), fix);
|
|
}
|
|
}
|
|
|
|
updateLook();
|
|
}
|
|
|
|
|
|
void InsetMathMacroTemplate::removeParameter(Cursor & cur,
|
|
DocIterator const & inset_pos, int pos, bool greedy)
|
|
{
|
|
if (pos < numargs_ && pos >= 0) {
|
|
--numargs_;
|
|
removeArguments(cur, inset_pos, pos, pos);
|
|
shiftArguments(pos + 1, -1);
|
|
|
|
// removed optional parameter?
|
|
if (pos < optionals_) {
|
|
--optionals_;
|
|
optionalValues_[pos] = cell(optIdx(pos));
|
|
cells_.erase(cells_.begin() + optIdx(pos));
|
|
|
|
// fix cursor
|
|
int macroSlice = cur.find(this);
|
|
if (macroSlice != -1) {
|
|
if (cur[macroSlice].idx() == optIdx(pos)) {
|
|
cur.cutOff(macroSlice);
|
|
cur[macroSlice].idx() = 1;
|
|
cur[macroSlice].pos() = 0;
|
|
} else if (cur[macroSlice].idx() > optIdx(pos))
|
|
--cur[macroSlice].idx();
|
|
}
|
|
}
|
|
|
|
if (!greedy) {
|
|
// fix macro instances
|
|
AddRemoveMacroInstanceFix fix(pos, false);
|
|
fixMacroInstances(cur, inset_pos, name(), fix);
|
|
}
|
|
}
|
|
|
|
updateLook();
|
|
}
|
|
|
|
|
|
void InsetMathMacroTemplate::makeOptional(Cursor & cur,
|
|
DocIterator const & inset_pos)
|
|
{
|
|
if (numargs_ > 0 && optionals_ < numargs_) {
|
|
++optionals_;
|
|
cells_.insert(cells_.begin() + optIdx(optionals_ - 1), optionalValues_[optionals_ - 1]);
|
|
// fix cursor
|
|
int macroSlice = cur.find(this);
|
|
if (macroSlice != -1 && cur[macroSlice].idx() >= optIdx(optionals_ - 1))
|
|
++cur[macroSlice].idx();
|
|
|
|
// fix macro instances
|
|
OptionalsMacroInstanceFix fix(optionals_);
|
|
fixMacroInstances(cur, inset_pos, name(), fix);
|
|
}
|
|
|
|
updateLook();
|
|
}
|
|
|
|
|
|
void InsetMathMacroTemplate::makeNonOptional(Cursor & cur,
|
|
DocIterator const & inset_pos)
|
|
{
|
|
if (numargs_ > 0 && optionals_ > 0) {
|
|
--optionals_;
|
|
|
|
// store default value for later if the user changes his mind
|
|
optionalValues_[optionals_] = cell(optIdx(optionals_));
|
|
cells_.erase(cells_.begin() + optIdx(optionals_));
|
|
|
|
// fix cursor
|
|
int macroSlice = cur.find(this);
|
|
if (macroSlice != -1) {
|
|
if (cur[macroSlice].idx() > optIdx(optionals_))
|
|
--cur[macroSlice].idx();
|
|
else if (cur[macroSlice].idx() == optIdx(optionals_)) {
|
|
cur.cutOff(macroSlice);
|
|
cur[macroSlice].idx() = optIdx(optionals_);
|
|
cur[macroSlice].pos() = 0;
|
|
}
|
|
}
|
|
|
|
// fix macro instances
|
|
OptionalsMacroInstanceFix fix(optionals_);
|
|
fixMacroInstances(cur, inset_pos, name(), fix);
|
|
}
|
|
|
|
updateLook();
|
|
}
|
|
|
|
|
|
void InsetMathMacroTemplate::doDispatch(Cursor & cur, FuncRequest & cmd)
|
|
{
|
|
string const arg = to_utf8(cmd.argument());
|
|
switch (cmd.action()) {
|
|
|
|
case LFUN_MATH_MACRO_ADD_PARAM:
|
|
if (numargs_ < 9) {
|
|
commitEditChanges(cur, cur);
|
|
// FIXME: implement precise undo handling (only a few places
|
|
// need undo)
|
|
cur.recordUndoFullBuffer();
|
|
size_t pos = numargs_;
|
|
if (!arg.empty())
|
|
pos = (size_t)convert<int>(arg) - 1; // it is checked for >=0 in getStatus
|
|
insertParameter(cur, cur, pos);
|
|
}
|
|
break;
|
|
|
|
|
|
case LFUN_MATH_MACRO_REMOVE_PARAM:
|
|
if (numargs_ > 0) {
|
|
commitEditChanges(cur, cur);
|
|
// FIXME: implement precise undo handling (only a few places
|
|
// need undo)
|
|
cur.recordUndoFullBuffer();
|
|
size_t pos = numargs_ - 1;
|
|
if (!arg.empty())
|
|
pos = (size_t)convert<int>(arg) - 1; // it is checked for >=0 in getStatus
|
|
removeParameter(cur, cur, pos);
|
|
}
|
|
break;
|
|
|
|
case LFUN_MATH_MACRO_APPEND_GREEDY_PARAM:
|
|
if (numargs_ < 9) {
|
|
commitEditChanges(cur, cur);
|
|
// FIXME: implement precise undo handling (only a few places
|
|
// need undo)
|
|
cur.recordUndoFullBuffer();
|
|
insertParameter(cur, cur, numargs_, true);
|
|
}
|
|
break;
|
|
|
|
case LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM:
|
|
if (numargs_ > 0) {
|
|
commitEditChanges(cur, cur);
|
|
// FIXME: implement precise undo handling (only a few places
|
|
// need undo)
|
|
cur.recordUndoFullBuffer();
|
|
removeParameter(cur, cur, numargs_ - 1, true);
|
|
}
|
|
break;
|
|
|
|
case LFUN_MATH_MACRO_MAKE_OPTIONAL:
|
|
commitEditChanges(cur, cur);
|
|
// FIXME: implement precise undo handling (only a few places
|
|
// need undo)
|
|
cur.recordUndoFullBuffer();
|
|
makeOptional(cur, cur);
|
|
break;
|
|
|
|
case LFUN_MATH_MACRO_MAKE_NONOPTIONAL:
|
|
commitEditChanges(cur, cur);
|
|
// FIXME: implement precise undo handling (only a few places
|
|
// need undo)
|
|
cur.recordUndoFullBuffer();
|
|
makeNonOptional(cur, cur);
|
|
break;
|
|
|
|
case LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM:
|
|
if (numargs_ < 9) {
|
|
commitEditChanges(cur, cur);
|
|
// FIXME: implement precise undo handling (only a few places
|
|
// need undo)
|
|
cur.recordUndoFullBuffer();
|
|
insertParameter(cur, cur, optionals_);
|
|
makeOptional(cur, cur);
|
|
}
|
|
break;
|
|
|
|
case LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM:
|
|
if (optionals_ > 0) {
|
|
commitEditChanges(cur, cur);
|
|
// FIXME: implement precise undo handling (only a few places
|
|
// need undo)
|
|
cur.recordUndoFullBuffer();
|
|
removeParameter(cur, cur, optionals_ - 1);
|
|
} break;
|
|
|
|
case LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM:
|
|
if (numargs_ == optionals_) {
|
|
commitEditChanges(cur, cur);
|
|
// FIXME: implement precise undo handling (only a few places
|
|
// need undo)
|
|
cur.recordUndoFullBuffer();
|
|
insertParameter(cur, cur, 0, true);
|
|
makeOptional(cur, cur);
|
|
}
|
|
break;
|
|
|
|
default:
|
|
InsetMathNest::doDispatch(cur, cmd);
|
|
break;
|
|
}
|
|
}
|
|
|
|
|
|
bool InsetMathMacroTemplate::getStatus(Cursor & cur, FuncRequest const & cmd,
|
|
FuncStatus & status) const
|
|
{
|
|
bool ret = true;
|
|
string const arg = to_utf8(cmd.argument());
|
|
switch (cmd.action()) {
|
|
case LFUN_MATH_MACRO_ADD_PARAM: {
|
|
int num = numargs_ + 1;
|
|
if (!arg.empty())
|
|
num = convert<int>(arg);
|
|
bool on = (num >= optionals_
|
|
&& numargs_ < 9 && num <= numargs_ + 1);
|
|
status.setEnabled(on);
|
|
break;
|
|
}
|
|
|
|
case LFUN_MATH_MACRO_APPEND_GREEDY_PARAM:
|
|
status.setEnabled(numargs_ < 9);
|
|
break;
|
|
|
|
case LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM:
|
|
case LFUN_MATH_MACRO_REMOVE_PARAM: {
|
|
int num = numargs_;
|
|
if (!arg.empty())
|
|
num = convert<int>(arg);
|
|
status.setEnabled(num >= 1 && num <= numargs_);
|
|
break;
|
|
}
|
|
|
|
case LFUN_MATH_MACRO_MAKE_OPTIONAL:
|
|
status.setEnabled(numargs_ > 0
|
|
&& optionals_ < numargs_
|
|
&& type_ != MacroTypeDef);
|
|
break;
|
|
|
|
case LFUN_MATH_MACRO_MAKE_NONOPTIONAL:
|
|
status.setEnabled(optionals_ > 0
|
|
&& type_ != MacroTypeDef);
|
|
break;
|
|
|
|
case LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM:
|
|
status.setEnabled(numargs_ < 9);
|
|
break;
|
|
|
|
case LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM:
|
|
status.setEnabled(optionals_ > 0);
|
|
break;
|
|
|
|
case LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM:
|
|
status.setEnabled(numargs_ == 0
|
|
&& type_ != MacroTypeDef);
|
|
break;
|
|
|
|
case LFUN_IN_MATHMACROTEMPLATE:
|
|
status.setEnabled(true);
|
|
break;
|
|
|
|
default:
|
|
ret = InsetMathNest::getStatus(cur, cmd, status);
|
|
break;
|
|
}
|
|
return ret;
|
|
}
|
|
|
|
|
|
void InsetMathMacroTemplate::read(Lexer & lex)
|
|
{
|
|
MathData ar(buffer_);
|
|
mathed_parse_cell(ar, lex.getStream(), Parse::TRACKMACRO);
|
|
if (ar.size() != 1 || !ar[0]->asMacroTemplate()) {
|
|
lyxerr << "Cannot read macro from '" << ar << "'" << endl;
|
|
lyxerr << "Read: " << to_utf8(asString(ar)) << endl;
|
|
return;
|
|
}
|
|
operator=( *(ar[0]->asMacroTemplate()) );
|
|
|
|
updateLook();
|
|
}
|
|
|
|
|
|
void InsetMathMacroTemplate::write(ostream & os) const
|
|
{
|
|
odocstringstream oss;
|
|
otexrowstream ots(oss);
|
|
TeXMathStream wi(ots, false, false, TeXMathStream::wsDefault);
|
|
oss << "FormulaMacro\n";
|
|
write(wi);
|
|
os << to_utf8(oss.str());
|
|
}
|
|
|
|
|
|
void InsetMathMacroTemplate::write(TeXMathStream & os) const
|
|
{
|
|
write(os, false);
|
|
}
|
|
|
|
|
|
int InsetMathMacroTemplate::write(TeXMathStream & os, bool overwriteRedefinition) const
|
|
{
|
|
int num_lines = 0;
|
|
|
|
if (os.latex()) {
|
|
if (definition().empty())
|
|
return num_lines;
|
|
|
|
if (optionals_ > 0) {
|
|
// macros with optionals use the xargs package, e.g.:
|
|
// \newcommandx{\foo}[2][usedefault, addprefix=\global,1=default]{#1,#2}
|
|
// \long is implicit by xargs
|
|
if (redefinition_ && !overwriteRedefinition)
|
|
os << "\\renewcommandx";
|
|
else
|
|
os << "\\newcommandx";
|
|
|
|
os << "\\" << name()
|
|
<< "[" << numargs_ << "]"
|
|
<< "[usedefault, addprefix=\\global";
|
|
for (int i = 0; i < optionals_; ++i) {
|
|
docstring optValue = asString(cell(optIdx(i)));
|
|
if (optValue.find(']') != docstring::npos
|
|
|| optValue.find(',') != docstring::npos)
|
|
os << ", " << i + 1 << "="
|
|
<< "{" << cell(optIdx(i)) << "}";
|
|
else
|
|
os << ", " << i + 1 << "="
|
|
<< cell(optIdx(i));
|
|
}
|
|
os << "]";
|
|
} else {
|
|
// Macros without optionals use standard _global_ \def macros:
|
|
// \global\def\long\foo#1#2{#1,#2}
|
|
// We use the \long prefix as this is the equivalent to \newcommand.
|
|
// We cannot use \newcommand directly because \global does not work with it.
|
|
os << "\n\\global\\long\\def\\" << name();
|
|
docstring param = from_ascii("#0");
|
|
for (int i = 1; i <= numargs_; ++i) {
|
|
param[1] = '0' + i;
|
|
os << param;
|
|
}
|
|
}
|
|
} else {
|
|
// in LyX output we use some pseudo syntax which is implementation
|
|
// independent, e.g.
|
|
// \newcommand{\foo}[2][default]{#1,#2}
|
|
if (redefinition_ && !overwriteRedefinition)
|
|
os << "\\renewcommand";
|
|
else
|
|
os << "\\newcommand";
|
|
os << "{\\" << name() << '}';
|
|
if (numargs_ > 0)
|
|
os << '[' << numargs_ << ']';
|
|
|
|
for (int i = 0; i < optionals_; ++i) {
|
|
docstring optValue = asString(cell(optIdx(i)));
|
|
if (optValue.find(']') != docstring::npos)
|
|
os << "[{" << cell(optIdx(i)) << "}]";
|
|
else
|
|
os << "[" << cell(optIdx(i)) << "]";
|
|
}
|
|
}
|
|
|
|
os << "{" << cell(defIdx()) << "}";
|
|
|
|
if (os.latex()) {
|
|
// writing .tex. done.
|
|
os << "%\n";
|
|
++num_lines;
|
|
} else {
|
|
// writing .lyx, write special .tex export only if necessary
|
|
if (!cell(displayIdx()).empty()) {
|
|
os << "\n{" << cell(displayIdx()) << '}';
|
|
++num_lines;
|
|
}
|
|
}
|
|
|
|
return num_lines;
|
|
}
|
|
|
|
|
|
docstring InsetMathMacroTemplate::xhtml(XMLStream &, OutputParams const &) const
|
|
{
|
|
return docstring();
|
|
}
|
|
|
|
int InsetMathMacroTemplate::plaintext(odocstringstream & os,
|
|
OutputParams const &, size_t) const
|
|
{
|
|
docstring const str = '[' + buffer().B_("math macro") + ']';
|
|
|
|
os << str;
|
|
return str.size();
|
|
}
|
|
|
|
|
|
bool InsetMathMacroTemplate::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?
|
|
if (n.size() > 1) {
|
|
for (char_type c : n) {
|
|
if (!(c >= 'a' && c <= 'z')
|
|
&& !(c >= 'A' && c <= 'Z')
|
|
&& c != '*')
|
|
return false;
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
bool InsetMathMacroTemplate::validMacro() const
|
|
{
|
|
return validName();
|
|
}
|
|
|
|
|
|
bool InsetMathMacroTemplate::fixNameAndCheckIfValid()
|
|
{
|
|
// check all the characters/insets in the name cell
|
|
size_t i = 0;
|
|
MathData & data = cell(0);
|
|
while (i < data.size()) {
|
|
InsetMathChar const * cinset = data[i]->asCharInset();
|
|
if (cinset) {
|
|
// valid character in [a-zA-Z]?
|
|
char_type c = cinset->getChar();
|
|
if ((c >= 'a' && c <= 'z')
|
|
|| (c >= 'A' && c <= 'Z')) {
|
|
++i;
|
|
continue;
|
|
}
|
|
}
|
|
|
|
// throw cell away
|
|
data.erase(i);
|
|
}
|
|
|
|
// now it should be valid if anything in the name survived
|
|
return !data.empty();
|
|
}
|
|
|
|
|
|
void InsetMathMacroTemplate::validate(LaTeXFeatures & features) const
|
|
{
|
|
// we need global optional macro arguments. They are not available
|
|
// with \def, and \newcommand does not support global macros. So we
|
|
// are bound to xargs also for the single-optional-parameter case.
|
|
if (optionals_ > 0)
|
|
features.require("xargs");
|
|
}
|
|
|
|
void InsetMathMacroTemplate::getDefaults(vector<docstring> & defaults) const
|
|
{
|
|
defaults.resize(numargs_);
|
|
for (int i = 0; i < optionals_; ++i)
|
|
defaults[i] = asString(cell(optIdx(i)));
|
|
}
|
|
|
|
|
|
docstring InsetMathMacroTemplate::definition() const
|
|
{
|
|
return asString(cell(defIdx()));
|
|
}
|
|
|
|
|
|
docstring InsetMathMacroTemplate::displayDefinition() const
|
|
{
|
|
return asString(cell(displayIdx()));
|
|
}
|
|
|
|
|
|
size_t InsetMathMacroTemplate::numArgs() const
|
|
{
|
|
return numargs_;
|
|
}
|
|
|
|
|
|
size_t InsetMathMacroTemplate::numOptionals() const
|
|
{
|
|
return optionals_;
|
|
}
|
|
|
|
|
|
void InsetMathMacroTemplate::infoize(odocstream & os) const
|
|
{
|
|
os << bformat(_("Math Macro: \\%1$s"), name());
|
|
}
|
|
|
|
|
|
string InsetMathMacroTemplate::contextMenuName() const
|
|
{
|
|
return "context-math-macro-definition";
|
|
}
|
|
|
|
|
|
void InsetMathMacroTemplate::addToToc(DocIterator const & pit, bool output_active,
|
|
UpdateType, TocBackend & backend) const
|
|
{
|
|
docstring str;
|
|
if (!validMacro())
|
|
str = bformat(_("Invalid macro! \\%1$s"), name());
|
|
else
|
|
str = "\\" + name();
|
|
TocBuilder & b = backend.builder("math-macro");
|
|
b.pushItem(pit, str, output_active);
|
|
b.pop();
|
|
}
|
|
|
|
|
|
} // namespace lyx
|