lyx_mirror/src/mathed/math_hullinset.C

853 lines
17 KiB
C++
Raw Normal View History

#include <config.h>
#include "math_hullinset.h"
#include "math_mathmlstream.h"
#include "math_streamstr.h"
#include "math_cursor.h"
#include "math_support.h"
#include "math_extern.h"
#include "math_charinset.h"
#include "debug.h"
#include "textpainter.h"
#include "funcrequest.h"
#include "Lsstream.h"
#include "LaTeXFeatures.h"
#include "support/LAssert.h"
#include "frontends/Painter.h"
#include "frontends/Alert.h"
#include "lyxrc.h"
#include "gettext.h"
#include "BufferView.h"
#include <vector>
using namespace lyx::support;
using std::vector;
using std::max;
using std::endl;
using std::pair;
namespace {
int getCols(string const & type)
{
if (type == "eqnarray")
return 3;
if (type == "align")
return 2;
if (type == "flalign")
return 2;
if (type == "alignat")
return 2;
if (type == "xalignat")
return 2;
if (type == "xxalignat")
return 2;
return 1;
}
// returns position of first relation operator in the array
// used for "intelligent splitting"
MathArray::size_type firstRelOp(MathArray const & ar)
{
for (MathArray::const_iterator it = ar.begin(); it != ar.end(); ++it)
if ((*it)->isRelOp())
return it - ar.begin();
return ar.size();
}
char const * star(bool numbered)
{
return numbered ? "" : "*";
}
int typecode(string const & s)
{
if (s == "none") return 0;
if (s == "simple") return 1;
if (s == "equation") return 2;
if (s == "eqnarray") return 3;
if (s == "align") return 4;
if (s == "alignat") return 5;
if (s == "xalignat") return 6;
if (s == "xxalignat") return 7;
if (s == "multline") return 8;
if (s == "gather") return 9;
if (s == "flalign") return 10;
lyxerr << "unknown hull type '" << s << "'\n";
return 0;
}
bool smaller(string const & s, string const & t)
{
return typecode(s) < typecode(t);
}
} // end anon namespace
MathHullInset::MathHullInset()
: MathGridInset(1, 1), type_("none"), nonum_(1), label_(1)
{
setDefaults();
}
MathHullInset::MathHullInset(string const & type)
: MathGridInset(getCols(type), 1), type_(type), nonum_(1), label_(1)
{
setDefaults();
}
InsetBase * MathHullInset::clone() const
{
return new MathHullInset(*this);
}
MathInset::mode_type MathHullInset::currentMode() const
{
if (type_ == "none")
return UNDECIDED_MODE;
// definitely math mode ...
return MATH_MODE;
}
bool MathHullInset::idxFirst(idx_type & idx, pos_type & pos) const
{
idx = 0;
pos = 0;
return true;
}
bool MathHullInset::idxLast(idx_type & idx, pos_type & pos) const
{
idx = nargs() - 1;
pos = cell(idx).size();
return true;
}
char MathHullInset::defaultColAlign(col_type col)
{
if (type_ == "eqnarray")
return "rcl"[col];
if (typecode(type_) >= typecode("align"))
return "rl"[col & 1];
return 'c';
}
int MathHullInset::defaultColSpace(col_type col)
{
if (type_ == "align" || type_ == "alignat")
return 0;
if (type_ == "xalignat")
return (col & 1) ? 20 : 0;
if (type_ == "xxalignat" || type_ == "flalign")
return (col & 1) ? 40 : 0;
return 0;
}
char const * MathHullInset::standardFont() const
{
if (type_ == "none")
return "lyxnochange";
return "mathnormal";
}
void MathHullInset::metrics(MetricsInfo & mi, Dimension & dim) const
{
FontSetChanger dummy1(mi.base, standardFont());
StyleChanger dummy2(mi.base, display() ? LM_ST_DISPLAY : LM_ST_TEXT);
// let the cells adjust themselves
MathGridInset::metrics(mi);
if (display()) {
dim_.asc += 12;
dim_.des += 12;
}
if (numberedType()) {
FontSetChanger dummy(mi.base, "mathbf");
int l = 0;
for (row_type row = 0; row < nrows(); ++row)
l = max(l, mathed_string_width(mi.base.font, nicelabel(row)));
if (l)
dim_.wid += 30 + l;
}
// make it at least as high as the current font
int asc = 0;
int des = 0;
math_font_max_dim(mi.base.font, asc, des);
dim_.asc = max(dim_.asc, asc);
dim_.des = max(dim_.des, des);
// for markers
metricsMarkers2();
dim = dim_;
}
void MathHullInset::draw(PainterInfo & pi, int x, int y) const
{
FontSetChanger dummy1(pi.base, standardFont());
StyleChanger dummy2(pi.base, display() ? LM_ST_DISPLAY : LM_ST_TEXT);
MathGridInset::draw(pi, x + 1, y);
if (numberedType()) {
int const xx = x + colinfo_.back().offset_ + colinfo_.back().width_ + 20;
for (row_type row = 0; row < nrows(); ++row) {
int const yy = y + rowinfo_[row].offset_;
FontSetChanger dummy(pi.base, "mathrm");
drawStr(pi, pi.base.font, xx, yy, nicelabel(row));
}
}
drawMarkers2(pi, x, y);
}
void MathHullInset::metricsT(TextMetricsInfo const & mi, Dimension & dim) const
{
if (display()) {
MathGridInset::metricsT(mi, dim);
} else {
ostringstream os;
WriteStream wi(os, false, true);
write(wi);
dim.wid = os.str().size();
dim.asc = 1;
dim.des = 0;
}
}
void MathHullInset::drawT(TextPainter & pain, int x, int y) const
{
if (display()) {
MathGridInset::drawT(pain, x, y);
} else {
ostringstream os;
WriteStream wi(os, false, true);
write(wi);
pain.draw(x, y, os.str().c_str());
}
}
string MathHullInset::label(row_type row) const
{
row_type n = nrows();
Assert(row < n);
return label_[row];
}
void MathHullInset::label(row_type row, string const & label)
{
//lyxerr << "setting label '" << label << "' for row " << row << endl;
label_[row] = label;
}
void MathHullInset::numbered(row_type row, bool num)
{
nonum_[row] = !num;
}
bool MathHullInset::numbered(row_type row) const
{
return !nonum_[row];
}
bool MathHullInset::ams() const
{
return
type_ == "align" ||
type_ == "flalign" ||
type_ == "multline" ||
type_ == "gather" ||
type_ == "alignat" ||
type_ == "xalignat" ||
type_ == "xxalignat";
}
bool MathHullInset::display() const
{
return type_ != "simple" && type_ != "none";
}
void MathHullInset::getLabelList(std::vector<string> & labels) const
{
for (row_type row = 0; row < nrows(); ++row)
if (!label_[row].empty() && nonum_[row] != 1)
labels.push_back(label_[row]);
}
bool MathHullInset::numberedType() const
{
if (type_ == "none")
return false;
if (type_ == "simple")
return false;
if (type_ == "xxalignat")
return false;
for (row_type row = 0; row < nrows(); ++row)
if (!nonum_[row])
return true;
return false;
}
void MathHullInset::validate(LaTeXFeatures & features) const
{
if (ams())
features.require("amsmath");
// Validation is necessary only if not using AMS math.
// To be safe, we will always run mathedvalidate.
//if (features.amsstyle)
// return;
features.require("boldsymbol");
//features.binom = true;
MathGridInset::validate(features);
}
void MathHullInset::header_write(WriteStream & os) const
{
bool n = numberedType();
if (type_ == "none")
;
else if (type_ == "simple") {
os << '$';
if (cell(0).empty())
os << ' ';
}
else if (type_ == "equation") {
if (n)
os << "\\begin{equation" << star(n) << "}\n";
else
os << "\\[\n";
}
else if (type_ == "eqnarray" || type_ == "align" || type_ == "flalign"
|| type_ == "gather" || type_ == "multline")
os << "\\begin{" << type_ << star(n) << "}\n";
else if (type_ == "alignat" || type_ == "xalignat")
os << "\\begin{" << type_ << star(n) << '}'
<< '{' << static_cast<unsigned int>((ncols() + 1)/2) << "}\n";
else if (type_ == "xxalignat")
os << "\\begin{" << type_ << '}'
<< '{' << static_cast<unsigned int>((ncols() + 1)/2) << "}\n";
else
os << "\\begin{unknown" << star(n) << '}';
}
void MathHullInset::footer_write(WriteStream & os) const
{
bool n = numberedType();
if (type_ == "none")
os << "\n";
else if (type_ == "simple")
os << '$';
else if (type_ == "equation")
if (n)
os << "\\end{equation" << star(n) << "}\n";
else
os << "\\]\n";
else if (type_ == "eqnarray" || type_ == "align" || type_ == "flalign"
|| type_ == "alignat" || type_ == "xalignat"
|| type_ == "gather" || type_ == "multline")
os << "\\end{" << type_ << star(n) << "}\n";
else if (type_ == "xxalignat")
os << "\\end{" << type_ << "}\n";
else
os << "\\end{unknown" << star(n) << '}';
}
bool MathHullInset::colChangeOK() const
{
return
type_ == "align" || type_ == "flalign" ||type_ == "alignat" ||
type_ == "xalignat" || type_ == "xxalignat";
}
void MathHullInset::addRow(row_type row)
{
nonum_.insert(nonum_.begin() + row + 1, !numberedType());
label_.insert(label_.begin() + row + 1, string());
MathGridInset::addRow(row);
}
void MathHullInset::delRow(row_type row)
{
if (nrows() <= 1)
return;
MathGridInset::delRow(row);
nonum_.erase(nonum_.begin() + row);
label_.erase(label_.begin() + row);
}
void MathHullInset::addCol(col_type col)
{
if (colChangeOK())
MathGridInset::addCol(col);
else
lyxerr << "Can't change number of columns in '" << type_ << "'\n";
}
void MathHullInset::delCol(col_type col)
{
if (colChangeOK())
MathGridInset::delCol(col);
else
lyxerr << "Can't change number of columns in '" << type_ << "'\n";
}
string MathHullInset::nicelabel(row_type row) const
{
if (nonum_[row])
return string();
if (label_[row].empty())
return string("(#)");
return '(' + label_[row] + ')';
}
void MathHullInset::glueall()
{
MathArray ar;
for (idx_type i = 0; i < nargs(); ++i)
ar.append(cell(i));
*this = MathHullInset("simple");
cell(0) = ar;
setDefaults();
}
string const & MathHullInset::getType() const
{
return type_;
}
void MathHullInset::setType(string const & type)
{
type_ = type;
setDefaults();
}
void MathHullInset::mutate(string const & newtype)
{
//lyxerr << "mutating from '" << type_ << "' to '" << newtype << "'\n";
// we try to move along the chain
// none <-> simple <-> equation <-> eqnarray
if (newtype == "dump") {
dump();
}
else if (newtype == type_) {
// done
}
else if (type_ == "none") {
setType("simple");
numbered(0, false);
mutate(newtype);
}
else if (type_ == "simple") {
if (newtype == "none") {
setType("none");
} else {
setType("equation");
numbered(0, false);
mutate(newtype);
}
}
else if (type_ == "equation") {
if (smaller(newtype, type_)) {
setType("simple");
mutate(newtype);
} else if (newtype == "eqnarray") {
MathGridInset::addCol(1);
MathGridInset::addCol(1);
// split it "nicely" on the firest relop
pos_type pos = firstRelOp(cell(0));
cell(1) = MathArray(cell(0).begin() + pos, cell(0).end());
cell(0).erase(pos, cell(0).size());
if (cell(1).size()) {
cell(2) = MathArray(cell(1).begin() + 1, cell(1).end());
cell(1).erase(1, cell(1).size());
}
setType("eqnarray");
mutate(newtype);
} else if (newtype == "multline" || newtype == "gather") {
setType(newtype);
numbered(0, false);
} else {
MathGridInset::addCol(1);
// split it "nicely"
pos_type pos = firstRelOp(cell(0));
cell(1) = cell(0);
cell(0).erase(pos, cell(0).size());
cell(1).erase(0, pos);
setType("align");
mutate(newtype);
}
}
else if (type_ == "eqnarray") {
if (smaller(newtype, type_)) {
// set correct (no)numbering
bool allnonum = true;
for (row_type row = 0; row < nrows(); ++row)
if (!nonum_[row])
allnonum = false;
// set first non-empty label
string label;
for (row_type row = 0; row < nrows(); ++row) {
if (!label_[row].empty()) {
label = label_[row];
break;
}
}
glueall();
nonum_[0] = allnonum;
label_[0] = label;
mutate(newtype);
} else { // align & Co.
for (row_type row = 0; row < nrows(); ++row) {
idx_type c = 3 * row + 1;
cell(c).append(cell(c + 1));
}
MathGridInset::delCol(2);
setType("align");
mutate(newtype);
}
}
else if (type_ == "align") {
if (smaller(newtype, type_)) {
MathGridInset::addCol(1);
setType("eqnarray");
mutate(newtype);
} else {
setType(newtype);
}
}
else if (type_ == "multline") {
if (newtype == "gather" || newtype == "align" ||
newtype == "xalignat" || newtype == "xxalignat" || newtype == "flalign")
setType(newtype);
else if (newtype == "eqnarray") {
MathGridInset::addCol(1);
MathGridInset::addCol(1);
setType("eqnarray");
} else {
lyxerr << "mutation from '" << type_
<< "' to '" << newtype << "' not implemented" << endl;
}
}
else if (type_ == "gather") {
if (newtype == "multline") {
setType("multline");
} else {
lyxerr << "mutation from '" << type_
<< "' to '" << newtype << "' not implemented" << endl;
}
}
else {
lyxerr << "mutation from '" << type_
<< "' to '" << newtype << "' not implemented" << endl;
}
}
string MathHullInset::eolString(row_type row, bool fragile) const
{
string res;
if (numberedType()) {
if (!label_[row].empty() && !nonum_[row])
res += "\\label{" + label_[row] + '}';
if (nonum_[row] && (type_ != "multline"))
res += "\\nonumber ";
}
return res + MathGridInset::eolString(row, fragile);
}
void MathHullInset::write(WriteStream & os) const
{
header_write(os);
MathGridInset::write(os);
footer_write(os);
}
void MathHullInset::normalize(NormalStream & os) const
{
os << "[formula " << type_ << ' ';
MathGridInset::normalize(os);
os << "] ";
}
void MathHullInset::mathmlize(MathMLStream & os) const
{
MathGridInset::mathmlize(os);
}
void MathHullInset::infoize(std::ostream & os) const
{
os << "Type: " << type_;
}
void MathHullInset::check() const
{
Assert(nonum_.size() == nrows());
Assert(label_.size() == nrows());
}
void MathHullInset::doExtern
(FuncRequest const & func, idx_type & idx, pos_type & pos)
{
string lang;
string extra;
istringstream iss(func.argument.c_str());
iss >> lang >> extra;
if (extra.empty())
extra = "noextra";
#ifdef WITH_WARNINGS
#warning temporarily disabled
//if (selection()) {
// MathArray ar;
// selGet(ar);
// lyxerr << "use selection: " << ar << "\n";
// insert(pipeThroughExtern(lang, extra, ar));
// return;
//}
#endif
MathArray eq;
eq.push_back(MathAtom(new MathCharInset('=')));
// go to first item in line
idx -= idx % ncols();
pos = 0;
if (getType() == "simple") {
size_type pos = cell(idx).find_last(eq);
MathArray ar;
if (mathcursor && mathcursor->selection()) {
asArray(mathcursor->grabAndEraseSelection(), ar);
} else if (pos == cell(idx).size()) {
ar = cell(idx);
lyxerr << "use whole cell: " << ar << "\n";
} else {
ar = MathArray(cell(idx).begin() + pos + 1, cell(idx).end());
lyxerr << "use partial cell form pos: " << pos << "\n";
}
cell(idx).append(eq);
cell(idx).append(pipeThroughExtern(lang, extra, ar));
pos = cell(idx).size();
return;
}
if (getType() == "equation") {
lyxerr << "use equation inset\n";
mutate("eqnarray");
MathArray & ar = cell(idx);
lyxerr << "use cell: " << ar << "\n";
cell(idx + 1) = eq;
cell(idx + 2) = pipeThroughExtern(lang, extra, ar);
// move to end of line
idx += 2;
pos = cell(idx).size();
return;
}
{
lyxerr << "use eqnarray\n";
idx -= idx % ncols();
idx += 2;
pos = 0;
MathArray ar = cell(idx);
lyxerr << "use cell: " << ar << "\n";
#ifdef WITH_WARNINGS
#warning temporarily disabled
#endif
addRow(row(idx));
cell(idx + 2) = eq;
cell(idx + 3) = pipeThroughExtern(lang, extra, ar);
idx += 3;
pos = cell(idx).size();
}
}
dispatch_result MathHullInset::dispatch
(FuncRequest const & cmd, idx_type & idx, pos_type & pos)
{
switch (cmd.action) {
case LFUN_BREAKLINE:
if (type_ == "simple" || type_ == "equation") {
mutate("eqnarray");
idx = 1;
pos = 0;
return DISPATCHED_POP;
}
return MathGridInset::dispatch(cmd, idx, pos);
case LFUN_MATH_NUMBER:
//lyxerr << "toggling all numbers\n";
if (display()) {
//bv->lockedInsetStoreUndo(Undo::INSERT);
bool old = numberedType();
if (type_ == "multline")
numbered(nrows() - 1, !old);
else
for (row_type row = 0; row < nrows(); ++row)
numbered(row, !old);
//bv->owner()->message(old ? _("No number") : _("Number"));
}
return DISPATCHED;
case LFUN_MATH_NONUMBER:
if (display()) {
row_type r = (type_ == "multline") ? nrows() - 1 : row(idx);
//bv->lockedInsetStoreUndo(Undo::INSERT);
bool old = numbered(r);
//bv->owner()->message(old ? _("No number") : _("Number"));
numbered(r, !old);
}
return DISPATCHED;
case LFUN_INSERT_LABEL: {
row_type r = (type_ == "multline") ? nrows() - 1 : row(idx);
string old_label = label(r);
string new_label = cmd.argument;
if (new_label.empty()) {
string const default_label =
(lyxrc.label_init_length >= 0) ? "eq:" : "";
pair<bool, string> const res = old_label.empty()
? Alert::askForText(_("Enter new label to insert:"), default_label)
: Alert::askForText(_("Enter label:"), old_label);
if (!res.first)
break;
new_label = trim(res.second);
}
//if (new_label == old_label)
// break; // Nothing to do
if (!new_label.empty())
numbered(r, true);
#warning FIXME: please check you really mean repaint() ... is it needed,
#warning and if so, should it be update() instead ?
if (!new_label.empty()
&& cmd.view()->ChangeRefsIfUnique(old_label, new_label))
cmd.view()->repaint();
label(r, new_label);
return DISPATCHED;
}
case LFUN_MATH_EXTERN:
doExtern(cmd, idx, pos);
return DISPATCHED_POP;
case LFUN_MATH_MUTATE: {
row_type r = row(idx);
col_type c = col(idx);
mutate(cmd.argument);
idx = r * ncols() + c;
if (idx >= nargs())
idx = nargs() - 1;
if (pos > cell(idx).size())
pos = cell(idx).size();
return DISPATCHED_POP;
}
case LFUN_MATH_DISPLAY: {
mutate(type_ == "simple" ? "equation" : "simple");
idx = 0;
pos = cell(idx).size();
return DISPATCHED_POP;
}
default:
return MathGridInset::dispatch(cmd, idx, pos);
}
return UNDISPATCHED;
}
string MathHullInset::fileInsetLabel() const
{
return "Formula";
}