2 * \file math_hullinset.C
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
8 * Full author contact details are available in file CREDITS.
13 #include "math_hullinset.h"
14 #include "math_mathmlstream.h"
15 #include "math_streamstr.h"
16 #include "math_cursor.h"
17 #include "math_support.h"
18 #include "math_extern.h"
19 #include "math_charinset.h"
20 #include "textpainter.h"
22 #include "funcrequest.h"
24 #include "LaTeXFeatures.h"
28 #include "frontends/Alert.h"
30 #include "support/std_sstream.h"
33 using lyx::support::trim;
39 using std::istringstream;
40 using std::ostringstream;
46 int getCols(string const & type)
48 if (type == "eqnarray")
52 if (type == "flalign")
54 if (type == "alignat")
56 if (type == "xalignat")
58 if (type == "xxalignat")
64 // returns position of first relation operator in the array
65 // used for "intelligent splitting"
66 MathArray::size_type firstRelOp(MathArray const & ar)
68 for (MathArray::const_iterator it = ar.begin(); it != ar.end(); ++it)
70 return it - ar.begin();
75 char const * star(bool numbered)
77 return numbered ? "" : "*";
81 int typecode(string const & s)
83 if (s == "none") return 0;
84 if (s == "simple") return 1;
85 if (s == "equation") return 2;
86 if (s == "eqnarray") return 3;
87 if (s == "align") return 4;
88 if (s == "alignat") return 5;
89 if (s == "xalignat") return 6;
90 if (s == "xxalignat") return 7;
91 if (s == "multline") return 8;
92 if (s == "gather") return 9;
93 if (s == "flalign") return 10;
94 lyxerr << "unknown hull type '" << s << "'" << endl;
98 bool smaller(string const & s, string const & t)
100 return typecode(s) < typecode(t);
104 } // end anon namespace
107 MathHullInset::MathHullInset()
108 : MathGridInset(1, 1), type_("none"), nonum_(1), label_(1)
114 MathHullInset::MathHullInset(string const & type)
115 : MathGridInset(getCols(type), 1), type_(type), nonum_(1), label_(1)
121 auto_ptr<InsetBase> MathHullInset::clone() const
123 return auto_ptr<InsetBase>(new MathHullInset(*this));
127 MathInset::mode_type MathHullInset::currentMode() const
130 return UNDECIDED_MODE;
131 // definitely math mode ...
136 bool MathHullInset::idxFirst(idx_type & idx, pos_type & pos) const
144 bool MathHullInset::idxLast(idx_type & idx, pos_type & pos) const
147 pos = cell(idx).size();
152 char MathHullInset::defaultColAlign(col_type col)
154 if (type_ == "eqnarray")
156 if (typecode(type_) >= typecode("align"))
157 return "rl"[col & 1];
162 int MathHullInset::defaultColSpace(col_type col)
164 if (type_ == "align" || type_ == "alignat")
166 if (type_ == "xalignat")
167 return (col & 1) ? 20 : 0;
168 if (type_ == "xxalignat" || type_ == "flalign")
169 return (col & 1) ? 40 : 0;
174 char const * MathHullInset::standardFont() const
177 return "lyxnochange";
182 void MathHullInset::metrics(MetricsInfo & mi, Dimension & dim) const
184 FontSetChanger dummy1(mi.base, standardFont());
185 StyleChanger dummy2(mi.base, display() ? LM_ST_DISPLAY : LM_ST_TEXT);
187 // let the cells adjust themselves
188 MathGridInset::metrics(mi);
195 if (numberedType()) {
196 FontSetChanger dummy(mi.base, "mathbf");
198 for (row_type row = 0; row < nrows(); ++row)
199 l = max(l, mathed_string_width(mi.base.font, nicelabel(row)));
205 // make it at least as high as the current font
208 math_font_max_dim(mi.base.font, asc, des);
209 dim_.asc = max(dim_.asc, asc);
210 dim_.des = max(dim_.des, des);
218 void MathHullInset::draw(PainterInfo & pi, int x, int y) const
220 FontSetChanger dummy1(pi.base, standardFont());
221 StyleChanger dummy2(pi.base, display() ? LM_ST_DISPLAY : LM_ST_TEXT);
222 MathGridInset::draw(pi, x + 1, y);
224 if (numberedType()) {
225 int const xx = x + colinfo_.back().offset_ + colinfo_.back().width_ + 20;
226 for (row_type row = 0; row < nrows(); ++row) {
227 int const yy = y + rowinfo_[row].offset_;
228 FontSetChanger dummy(pi.base, "mathrm");
229 drawStr(pi, pi.base.font, xx, yy, nicelabel(row));
233 drawMarkers2(pi, x, y);
237 void MathHullInset::metricsT(TextMetricsInfo const & mi, Dimension & dim) const
240 MathGridInset::metricsT(mi, dim);
243 WriteStream wi(os, false, true);
245 dim.wid = os.str().size();
252 void MathHullInset::drawT(TextPainter & pain, int x, int y) const
255 MathGridInset::drawT(pain, x, y);
258 WriteStream wi(os, false, true);
260 pain.draw(x, y, os.str().c_str());
265 string MathHullInset::label(row_type row) const
267 row_type n = nrows();
268 BOOST_ASSERT(row < n);
273 void MathHullInset::label(row_type row, string const & label)
275 //lyxerr << "setting label '" << label << "' for row " << row << endl;
280 void MathHullInset::numbered(row_type row, bool num)
286 bool MathHullInset::numbered(row_type row) const
292 bool MathHullInset::ams() const
296 type_ == "flalign" ||
297 type_ == "multline" ||
299 type_ == "alignat" ||
300 type_ == "xalignat" ||
301 type_ == "xxalignat";
305 bool MathHullInset::display() const
307 return type_ != "simple" && type_ != "none";
311 void MathHullInset::getLabelList(Buffer const &,
312 std::vector<string> & labels) const
314 for (row_type row = 0; row < nrows(); ++row)
315 if (!label_[row].empty() && nonum_[row] != 1)
316 labels.push_back(label_[row]);
320 bool MathHullInset::numberedType() const
324 if (type_ == "simple")
326 if (type_ == "xxalignat")
328 for (row_type row = 0; row < nrows(); ++row)
335 void MathHullInset::validate(LaTeXFeatures & features) const
338 features.require("amsmath");
341 // Validation is necessary only if not using AMS math.
342 // To be safe, we will always run mathedvalidate.
343 //if (features.amsstyle)
346 features.require("boldsymbol");
347 //features.binom = true;
349 MathGridInset::validate(features);
353 void MathHullInset::header_write(WriteStream & os) const
355 bool n = numberedType();
360 else if (type_ == "simple") {
366 else if (type_ == "equation") {
368 os << "\\begin{equation" << star(n) << "}\n";
373 else if (type_ == "eqnarray" || type_ == "align" || type_ == "flalign"
374 || type_ == "gather" || type_ == "multline")
375 os << "\\begin{" << type_ << star(n) << "}\n";
377 else if (type_ == "alignat" || type_ == "xalignat")
378 os << "\\begin{" << type_ << star(n) << '}'
379 << '{' << static_cast<unsigned int>((ncols() + 1)/2) << "}\n";
381 else if (type_ == "xxalignat")
382 os << "\\begin{" << type_ << '}'
383 << '{' << static_cast<unsigned int>((ncols() + 1)/2) << "}\n";
386 os << "\\begin{unknown" << star(n) << '}';
390 void MathHullInset::footer_write(WriteStream & os) const
392 bool n = numberedType();
397 else if (type_ == "simple")
400 else if (type_ == "equation")
402 os << "\\end{equation" << star(n) << "}\n";
406 else if (type_ == "eqnarray" || type_ == "align" || type_ == "flalign"
407 || type_ == "alignat" || type_ == "xalignat"
408 || type_ == "gather" || type_ == "multline")
409 os << "\\end{" << type_ << star(n) << "}\n";
411 else if (type_ == "xxalignat")
412 os << "\\end{" << type_ << "}\n";
415 os << "\\end{unknown" << star(n) << '}';
419 bool MathHullInset::colChangeOK() const
422 type_ == "align" || type_ == "flalign" ||type_ == "alignat" ||
423 type_ == "xalignat" || type_ == "xxalignat";
427 void MathHullInset::addRow(row_type row)
429 nonum_.insert(nonum_.begin() + row + 1, !numberedType());
430 label_.insert(label_.begin() + row + 1, string());
431 MathGridInset::addRow(row);
435 void MathHullInset::swapRow(row_type row)
439 if (row + 1 == nrows())
441 std::swap(nonum_[row], nonum_[row + 1]);
442 std::swap(label_[row], label_[row + 1]);
443 MathGridInset::swapRow(row);
447 void MathHullInset::delRow(row_type row)
451 MathGridInset::delRow(row);
452 nonum_.erase(nonum_.begin() + row);
453 label_.erase(label_.begin() + row);
457 void MathHullInset::addCol(col_type col)
460 MathGridInset::addCol(col);
462 lyxerr << "Can't change number of columns in '" << type_ << "'" << endl;
466 void MathHullInset::delCol(col_type col)
469 MathGridInset::delCol(col);
471 lyxerr << "Can't change number of columns in '" << type_ << "'" << endl;
475 string MathHullInset::nicelabel(row_type row) const
479 if (label_[row].empty())
480 return string("(#)");
481 return '(' + label_[row] + ')';
485 void MathHullInset::glueall()
488 for (idx_type i = 0; i < nargs(); ++i)
490 *this = MathHullInset("simple");
496 string const & MathHullInset::getType() const
502 void MathHullInset::setType(string const & type)
510 void MathHullInset::mutate(string const & newtype)
512 //lyxerr << "mutating from '" << type_ << "' to '" << newtype << "'" << endl;
514 // we try to move along the chain
515 // none <-> simple <-> equation <-> eqnarray
517 if (newtype == "dump") {
521 else if (newtype == type_) {
525 else if (type_ == "none") {
531 else if (type_ == "simple") {
532 if (newtype == "none") {
541 else if (type_ == "equation") {
542 if (smaller(newtype, type_)) {
545 } else if (newtype == "eqnarray") {
546 MathGridInset::addCol(1);
547 MathGridInset::addCol(1);
549 // split it "nicely" on the firest relop
550 pos_type pos = firstRelOp(cell(0));
551 cell(1) = MathArray(cell(0).begin() + pos, cell(0).end());
552 cell(0).erase(pos, cell(0).size());
554 if (cell(1).size()) {
555 cell(2) = MathArray(cell(1).begin() + 1, cell(1).end());
556 cell(1).erase(1, cell(1).size());
560 } else if (newtype == "multline" || newtype == "gather") {
564 MathGridInset::addCol(1);
566 pos_type pos = firstRelOp(cell(0));
568 cell(0).erase(pos, cell(0).size());
569 cell(1).erase(0, pos);
575 else if (type_ == "eqnarray") {
576 if (smaller(newtype, type_)) {
577 // set correct (no)numbering
578 bool allnonum = true;
579 for (row_type row = 0; row < nrows(); ++row)
583 // set first non-empty label
585 for (row_type row = 0; row < nrows(); ++row) {
586 if (!label_[row].empty()) {
593 nonum_[0] = allnonum;
596 } else { // align & Co.
597 for (row_type row = 0; row < nrows(); ++row) {
598 idx_type c = 3 * row + 1;
599 cell(c).append(cell(c + 1));
601 MathGridInset::delCol(2);
607 else if (type_ == "align") {
608 if (smaller(newtype, type_)) {
609 MathGridInset::addCol(1);
617 else if (type_ == "multline") {
618 if (newtype == "gather" || newtype == "align" ||
619 newtype == "xalignat" || newtype == "xxalignat" || newtype == "flalign")
621 else if (newtype == "eqnarray") {
622 MathGridInset::addCol(1);
623 MathGridInset::addCol(1);
626 lyxerr << "mutation from '" << type_
627 << "' to '" << newtype << "' not implemented" << endl;
631 else if (type_ == "gather") {
632 if (newtype == "multline") {
635 lyxerr << "mutation from '" << type_
636 << "' to '" << newtype << "' not implemented" << endl;
641 lyxerr << "mutation from '" << type_
642 << "' to '" << newtype << "' not implemented" << endl;
647 string MathHullInset::eolString(row_type row, bool fragile) const
650 if (numberedType()) {
651 if (!label_[row].empty() && !nonum_[row])
652 res += "\\label{" + label_[row] + '}';
653 if (nonum_[row] && (type_ != "multline"))
654 res += "\\nonumber ";
656 return res + MathGridInset::eolString(row, fragile);
660 void MathHullInset::write(WriteStream & os) const
663 MathGridInset::write(os);
668 void MathHullInset::normalize(NormalStream & os) const
670 os << "[formula " << type_ << ' ';
671 MathGridInset::normalize(os);
676 void MathHullInset::mathmlize(MathMLStream & os) const
678 MathGridInset::mathmlize(os);
682 void MathHullInset::infoize(std::ostream & os) const
684 os << "Type: " << type_;
688 void MathHullInset::check() const
690 BOOST_ASSERT(nonum_.size() == nrows());
691 BOOST_ASSERT(label_.size() == nrows());
695 void MathHullInset::doExtern
696 (FuncRequest const & func, idx_type & idx, pos_type & pos)
700 istringstream iss(func.argument.c_str());
701 iss >> lang >> extra;
706 #warning temporarily disabled
710 // lyxerr << "use selection: " << ar << endl;
711 // insert(pipeThroughExtern(lang, extra, ar));
717 eq.push_back(MathAtom(new MathCharInset('=')));
719 // go to first item in line
720 idx -= idx % ncols();
723 if (getType() == "simple") {
724 size_type pos = cell(idx).find_last(eq);
726 if (mathcursor && mathcursor->selection()) {
727 asArray(mathcursor->grabAndEraseSelection(), ar);
728 } else if (pos == cell(idx).size()) {
730 lyxerr << "use whole cell: " << ar << endl;
732 ar = MathArray(cell(idx).begin() + pos + 1, cell(idx).end());
733 lyxerr << "use partial cell form pos: " << pos << endl;
735 cell(idx).append(eq);
736 cell(idx).append(pipeThroughExtern(lang, extra, ar));
737 pos = cell(idx).size();
741 if (getType() == "equation") {
742 lyxerr << "use equation inset" << endl;
744 MathArray & ar = cell(idx);
745 lyxerr << "use cell: " << ar << endl;
747 cell(idx + 2) = pipeThroughExtern(lang, extra, ar);
748 // move to end of line
750 pos = cell(idx).size();
755 lyxerr << "use eqnarray" << endl;
756 idx -= idx % ncols();
759 MathArray ar = cell(idx);
760 lyxerr << "use cell: " << ar << endl;
762 #warning temporarily disabled
766 cell(idx + 3) = pipeThroughExtern(lang, extra, ar);
768 pos = cell(idx).size();
773 dispatch_result MathHullInset::dispatch
774 (FuncRequest const & cmd, idx_type & idx, pos_type & pos)
776 switch (cmd.action) {
779 if (type_ == "simple" || type_ == "equation") {
783 return DISPATCHED_POP;
785 return MathGridInset::dispatch(cmd, idx, pos);
787 case LFUN_MATH_NUMBER:
788 //lyxerr << "toggling all numbers" << endl;
790 //recordUndo(bv, Undo::INSERT);
791 bool old = numberedType();
792 if (type_ == "multline")
793 numbered(nrows() - 1, !old);
795 for (row_type row = 0; row < nrows(); ++row)
797 //bv->owner()->message(old ? _("No number") : _("Number"));
801 case LFUN_MATH_NONUMBER:
803 row_type r = (type_ == "multline") ? nrows() - 1 : row(idx);
804 //recordUndo(bv, Undo::INSERT);
805 bool old = numbered(r);
806 //bv->owner()->message(old ? _("No number") : _("Number"));
811 case LFUN_INSERT_LABEL: {
812 row_type r = (type_ == "multline") ? nrows() - 1 : row(idx);
813 string old_label = label(r);
814 string new_label = cmd.argument;
816 if (new_label.empty()) {
817 string const default_label =
818 (lyxrc.label_init_length >= 0) ? "eq:" : "";
819 pair<bool, string> const res = old_label.empty()
820 ? Alert::askForText(_("Enter new label to insert:"), default_label)
821 : Alert::askForText(_("Enter label:"), old_label);
824 new_label = trim(res.second);
827 //if (new_label == old_label)
828 // break; // Nothing to do
830 if (!new_label.empty())
836 case LFUN_MATH_EXTERN:
837 doExtern(cmd, idx, pos);
838 return DISPATCHED_POP;
840 case LFUN_MATH_MUTATE: {
841 row_type r = row(idx);
842 col_type c = col(idx);
843 mutate(cmd.argument);
844 idx = r * ncols() + c;
847 if (pos > cell(idx).size())
848 pos = cell(idx).size();
849 return DISPATCHED_POP;
852 case LFUN_MATH_DISPLAY: {
853 mutate(type_ == "simple" ? "equation" : "simple");
855 pos = cell(idx).size();
856 return DISPATCHED_POP;
860 return MathGridInset::dispatch(cmd, idx, pos);
865 string MathHullInset::fileInsetLabel() const