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;
40 using std::istringstream;
41 using std::ostringstream;
47 int getCols(string const & type)
49 if (type == "eqnarray")
53 if (type == "flalign")
55 if (type == "alignat")
57 if (type == "xalignat")
59 if (type == "xxalignat")
65 // returns position of first relation operator in the array
66 // used for "intelligent splitting"
67 MathArray::size_type firstRelOp(MathArray const & ar)
69 for (MathArray::const_iterator it = ar.begin(); it != ar.end(); ++it)
71 return it - ar.begin();
76 char const * star(bool numbered)
78 return numbered ? "" : "*";
82 int typecode(string const & s)
84 if (s == "none") return 0;
85 if (s == "simple") return 1;
86 if (s == "equation") return 2;
87 if (s == "eqnarray") return 3;
88 if (s == "align") return 4;
89 if (s == "alignat") return 5;
90 if (s == "xalignat") return 6;
91 if (s == "xxalignat") return 7;
92 if (s == "multline") return 8;
93 if (s == "gather") return 9;
94 if (s == "flalign") return 10;
95 lyxerr << "unknown hull type '" << s << "'" << endl;
99 bool smaller(string const & s, string const & t)
101 return typecode(s) < typecode(t);
105 } // end anon namespace
108 MathHullInset::MathHullInset()
109 : MathGridInset(1, 1), type_("none"), nonum_(1), label_(1)
115 MathHullInset::MathHullInset(string const & type)
116 : MathGridInset(getCols(type), 1), type_(type), nonum_(1), label_(1)
122 auto_ptr<InsetBase> MathHullInset::clone() const
124 return auto_ptr<InsetBase>(new MathHullInset(*this));
128 MathInset::mode_type MathHullInset::currentMode() const
131 return UNDECIDED_MODE;
132 // definitely math mode ...
137 bool MathHullInset::idxFirst(idx_type & idx, pos_type & pos) const
145 bool MathHullInset::idxLast(idx_type & idx, pos_type & pos) const
148 pos = cell(idx).size();
153 char MathHullInset::defaultColAlign(col_type col)
155 if (type_ == "eqnarray")
157 if (typecode(type_) >= typecode("align"))
158 return "rl"[col & 1];
163 int MathHullInset::defaultColSpace(col_type col)
165 if (type_ == "align" || type_ == "alignat")
167 if (type_ == "xalignat")
168 return (col & 1) ? 20 : 0;
169 if (type_ == "xxalignat" || type_ == "flalign")
170 return (col & 1) ? 40 : 0;
175 char const * MathHullInset::standardFont() const
178 return "lyxnochange";
183 void MathHullInset::metrics(MetricsInfo & mi, Dimension & dim) const
185 FontSetChanger dummy1(mi.base, standardFont());
186 StyleChanger dummy2(mi.base, display() ? LM_ST_DISPLAY : LM_ST_TEXT);
188 // let the cells adjust themselves
189 MathGridInset::metrics(mi);
196 if (numberedType()) {
197 FontSetChanger dummy(mi.base, "mathbf");
199 for (row_type row = 0; row < nrows(); ++row)
200 l = max(l, mathed_string_width(mi.base.font, nicelabel(row)));
206 // make it at least as high as the current font
209 math_font_max_dim(mi.base.font, asc, des);
210 dim_.asc = max(dim_.asc, asc);
211 dim_.des = max(dim_.des, des);
219 void MathHullInset::draw(PainterInfo & pi, int x, int y) const
221 FontSetChanger dummy1(pi.base, standardFont());
222 StyleChanger dummy2(pi.base, display() ? LM_ST_DISPLAY : LM_ST_TEXT);
223 MathGridInset::draw(pi, x + 1, y);
225 if (numberedType()) {
226 int const xx = x + colinfo_.back().offset_ + colinfo_.back().width_ + 20;
227 for (row_type row = 0; row < nrows(); ++row) {
228 int const yy = y + rowinfo_[row].offset_;
229 FontSetChanger dummy(pi.base, "mathrm");
230 drawStr(pi, pi.base.font, xx, yy, nicelabel(row));
234 drawMarkers2(pi, x, y);
238 void MathHullInset::metricsT(TextMetricsInfo const & mi, Dimension & dim) const
241 MathGridInset::metricsT(mi, dim);
244 WriteStream wi(os, false, true);
246 dim.wid = os.str().size();
253 void MathHullInset::drawT(TextPainter & pain, int x, int y) const
256 MathGridInset::drawT(pain, x, y);
259 WriteStream wi(os, false, true);
261 pain.draw(x, y, os.str().c_str());
266 string MathHullInset::label(row_type row) const
268 row_type n = nrows();
269 BOOST_ASSERT(row < n);
274 void MathHullInset::label(row_type row, string const & label)
276 //lyxerr << "setting label '" << label << "' for row " << row << endl;
281 void MathHullInset::numbered(row_type row, bool num)
287 bool MathHullInset::numbered(row_type row) const
293 bool MathHullInset::ams() const
297 type_ == "flalign" ||
298 type_ == "multline" ||
300 type_ == "alignat" ||
301 type_ == "xalignat" ||
302 type_ == "xxalignat";
306 bool MathHullInset::display() const
308 return type_ != "simple" && type_ != "none";
312 void MathHullInset::getLabelList(Buffer const &,
313 std::vector<string> & labels) const
315 for (row_type row = 0; row < nrows(); ++row)
316 if (!label_[row].empty() && nonum_[row] != 1)
317 labels.push_back(label_[row]);
321 bool MathHullInset::numberedType() const
325 if (type_ == "simple")
327 if (type_ == "xxalignat")
329 for (row_type row = 0; row < nrows(); ++row)
336 void MathHullInset::validate(LaTeXFeatures & features) const
339 features.require("amsmath");
342 // Validation is necessary only if not using AMS math.
343 // To be safe, we will always run mathedvalidate.
344 //if (features.amsstyle)
347 features.require("boldsymbol");
348 //features.binom = true;
350 MathGridInset::validate(features);
354 void MathHullInset::header_write(WriteStream & os) const
356 bool n = numberedType();
361 else if (type_ == "simple") {
367 else if (type_ == "equation") {
369 os << "\\begin{equation" << star(n) << "}\n";
374 else if (type_ == "eqnarray" || type_ == "align" || type_ == "flalign"
375 || type_ == "gather" || type_ == "multline")
376 os << "\\begin{" << type_ << star(n) << "}\n";
378 else if (type_ == "alignat" || type_ == "xalignat")
379 os << "\\begin{" << type_ << star(n) << '}'
380 << '{' << static_cast<unsigned int>((ncols() + 1)/2) << "}\n";
382 else if (type_ == "xxalignat")
383 os << "\\begin{" << type_ << '}'
384 << '{' << static_cast<unsigned int>((ncols() + 1)/2) << "}\n";
387 os << "\\begin{unknown" << star(n) << '}';
391 void MathHullInset::footer_write(WriteStream & os) const
393 bool n = numberedType();
398 else if (type_ == "simple")
401 else if (type_ == "equation")
403 os << "\\end{equation" << star(n) << "}\n";
407 else if (type_ == "eqnarray" || type_ == "align" || type_ == "flalign"
408 || type_ == "alignat" || type_ == "xalignat"
409 || type_ == "gather" || type_ == "multline")
410 os << "\\end{" << type_ << star(n) << "}\n";
412 else if (type_ == "xxalignat")
413 os << "\\end{" << type_ << "}\n";
416 os << "\\end{unknown" << star(n) << '}';
420 bool MathHullInset::colChangeOK() const
423 type_ == "align" || type_ == "flalign" ||type_ == "alignat" ||
424 type_ == "xalignat" || type_ == "xxalignat";
428 void MathHullInset::addRow(row_type row)
430 nonum_.insert(nonum_.begin() + row + 1, !numberedType());
431 label_.insert(label_.begin() + row + 1, string());
432 MathGridInset::addRow(row);
436 void MathHullInset::swapRow(row_type row)
440 if (row + 1 == nrows())
442 std::swap(nonum_[row], nonum_[row + 1]);
443 std::swap(label_[row], label_[row + 1]);
444 MathGridInset::swapRow(row);
448 void MathHullInset::delRow(row_type row)
452 MathGridInset::delRow(row);
453 nonum_.erase(nonum_.begin() + row);
454 label_.erase(label_.begin() + row);
458 void MathHullInset::addCol(col_type col)
461 MathGridInset::addCol(col);
463 lyxerr << "Can't change number of columns in '" << type_ << "'" << endl;
467 void MathHullInset::delCol(col_type col)
470 MathGridInset::delCol(col);
472 lyxerr << "Can't change number of columns in '" << type_ << "'" << endl;
476 string MathHullInset::nicelabel(row_type row) const
480 if (label_[row].empty())
481 return string("(#)");
482 return '(' + label_[row] + ')';
486 void MathHullInset::glueall()
489 for (idx_type i = 0; i < nargs(); ++i)
491 *this = MathHullInset("simple");
497 string const & MathHullInset::getType() const
503 void MathHullInset::setType(string const & type)
511 void MathHullInset::mutate(string const & newtype)
513 //lyxerr << "mutating from '" << type_ << "' to '" << newtype << "'" << endl;
515 // we try to move along the chain
516 // none <-> simple <-> equation <-> eqnarray
518 if (newtype == "dump") {
522 else if (newtype == type_) {
526 else if (type_ == "none") {
532 else if (type_ == "simple") {
533 if (newtype == "none") {
542 else if (type_ == "equation") {
543 if (smaller(newtype, type_)) {
546 } else if (newtype == "eqnarray") {
547 MathGridInset::addCol(1);
548 MathGridInset::addCol(1);
550 // split it "nicely" on the firest relop
551 pos_type pos = firstRelOp(cell(0));
552 cell(1) = MathArray(cell(0).begin() + pos, cell(0).end());
553 cell(0).erase(pos, cell(0).size());
555 if (cell(1).size()) {
556 cell(2) = MathArray(cell(1).begin() + 1, cell(1).end());
557 cell(1).erase(1, cell(1).size());
561 } else if (newtype == "multline" || newtype == "gather") {
565 MathGridInset::addCol(1);
567 pos_type pos = firstRelOp(cell(0));
569 cell(0).erase(pos, cell(0).size());
570 cell(1).erase(0, pos);
576 else if (type_ == "eqnarray") {
577 if (smaller(newtype, type_)) {
578 // set correct (no)numbering
579 bool allnonum = true;
580 for (row_type row = 0; row < nrows(); ++row)
584 // set first non-empty label
586 for (row_type row = 0; row < nrows(); ++row) {
587 if (!label_[row].empty()) {
594 nonum_[0] = allnonum;
597 } else { // align & Co.
598 for (row_type row = 0; row < nrows(); ++row) {
599 idx_type c = 3 * row + 1;
600 cell(c).append(cell(c + 1));
602 MathGridInset::delCol(2);
608 else if (type_ == "align") {
609 if (smaller(newtype, type_)) {
610 MathGridInset::addCol(1);
618 else if (type_ == "multline") {
619 if (newtype == "gather" || newtype == "align" ||
620 newtype == "xalignat" || newtype == "xxalignat" || newtype == "flalign")
622 else if (newtype == "eqnarray") {
623 MathGridInset::addCol(1);
624 MathGridInset::addCol(1);
627 lyxerr << "mutation from '" << type_
628 << "' to '" << newtype << "' not implemented" << endl;
632 else if (type_ == "gather") {
633 if (newtype == "multline") {
636 lyxerr << "mutation from '" << type_
637 << "' to '" << newtype << "' not implemented" << endl;
642 lyxerr << "mutation from '" << type_
643 << "' to '" << newtype << "' not implemented" << endl;
648 string MathHullInset::eolString(row_type row, bool fragile) const
651 if (numberedType()) {
652 if (!label_[row].empty() && !nonum_[row])
653 res += "\\label{" + label_[row] + '}';
654 if (nonum_[row] && (type_ != "multline"))
655 res += "\\nonumber ";
657 return res + MathGridInset::eolString(row, fragile);
661 void MathHullInset::write(WriteStream & os) const
664 MathGridInset::write(os);
669 void MathHullInset::normalize(NormalStream & os) const
671 os << "[formula " << type_ << ' ';
672 MathGridInset::normalize(os);
677 void MathHullInset::mathmlize(MathMLStream & os) const
679 MathGridInset::mathmlize(os);
683 void MathHullInset::infoize(std::ostream & os) const
685 os << "Type: " << type_;
689 void MathHullInset::check() const
691 BOOST_ASSERT(nonum_.size() == nrows());
692 BOOST_ASSERT(label_.size() == nrows());
696 void MathHullInset::doExtern
697 (FuncRequest const & func, idx_type & idx, pos_type & pos)
701 istringstream iss(func.argument.c_str());
702 iss >> lang >> extra;
707 #warning temporarily disabled
711 // lyxerr << "use selection: " << ar << endl;
712 // insert(pipeThroughExtern(lang, extra, ar));
718 eq.push_back(MathAtom(new MathCharInset('=')));
720 // go to first item in line
721 idx -= idx % ncols();
724 if (getType() == "simple") {
725 size_type pos = cell(idx).find_last(eq);
727 if (mathcursor && mathcursor->selection()) {
728 asArray(mathcursor->grabAndEraseSelection(), ar);
729 } else if (pos == cell(idx).size()) {
731 lyxerr << "use whole cell: " << ar << endl;
733 ar = MathArray(cell(idx).begin() + pos + 1, cell(idx).end());
734 lyxerr << "use partial cell form pos: " << pos << endl;
736 cell(idx).append(eq);
737 cell(idx).append(pipeThroughExtern(lang, extra, ar));
738 pos = cell(idx).size();
742 if (getType() == "equation") {
743 lyxerr << "use equation inset" << endl;
745 MathArray & ar = cell(idx);
746 lyxerr << "use cell: " << ar << endl;
748 cell(idx + 2) = pipeThroughExtern(lang, extra, ar);
749 // move to end of line
751 pos = cell(idx).size();
756 lyxerr << "use eqnarray" << endl;
757 idx -= idx % ncols();
760 MathArray ar = cell(idx);
761 lyxerr << "use cell: " << ar << endl;
763 #warning temporarily disabled
767 cell(idx + 3) = pipeThroughExtern(lang, extra, ar);
769 pos = cell(idx).size();
774 dispatch_result MathHullInset::dispatch
775 (FuncRequest const & cmd, idx_type & idx, pos_type & pos)
777 switch (cmd.action) {
780 if (type_ == "simple" || type_ == "equation") {
784 return DISPATCHED_POP;
786 return MathGridInset::dispatch(cmd, idx, pos);
788 case LFUN_MATH_NUMBER:
789 //lyxerr << "toggling all numbers" << endl;
791 //recordUndo(bv, Undo::INSERT);
792 bool old = numberedType();
793 if (type_ == "multline")
794 numbered(nrows() - 1, !old);
796 for (row_type row = 0; row < nrows(); ++row)
798 //bv->owner()->message(old ? _("No number") : _("Number"));
802 case LFUN_MATH_NONUMBER:
804 row_type r = (type_ == "multline") ? nrows() - 1 : row(idx);
805 //recordUndo(bv, Undo::INSERT);
806 bool old = numbered(r);
807 //bv->owner()->message(old ? _("No number") : _("Number"));
812 case LFUN_INSERT_LABEL: {
813 row_type r = (type_ == "multline") ? nrows() - 1 : row(idx);
814 string old_label = label(r);
815 string new_label = cmd.argument;
817 if (new_label.empty()) {
818 string const default_label =
819 (lyxrc.label_init_length >= 0) ? "eq:" : "";
820 pair<bool, string> const res = old_label.empty()
821 ? Alert::askForText(_("Enter new label to insert:"), default_label)
822 : Alert::askForText(_("Enter label:"), old_label);
825 new_label = trim(res.second);
828 //if (new_label == old_label)
829 // break; // Nothing to do
831 if (!new_label.empty())
837 case LFUN_MATH_EXTERN:
838 doExtern(cmd, idx, pos);
839 return DISPATCHED_POP;
841 case LFUN_MATH_MUTATE: {
842 row_type r = row(idx);
843 col_type c = col(idx);
844 mutate(cmd.argument);
845 idx = r * ncols() + c;
848 if (pos > cell(idx).size())
849 pos = cell(idx).size();
850 return DISPATCHED_POP;
853 case LFUN_MATH_DISPLAY: {
854 mutate(type_ == "simple" ? "equation" : "simple");
856 pos = cell(idx).size();
857 return DISPATCHED_POP;
861 return MathGridInset::dispatch(cmd, idx, pos);
866 string MathHullInset::fileInsetLabel() const