2 * \file InsetMathHull.cpp
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 "InsetMathHull.h"
15 #include "InsetMathChar.h"
16 #include "InsetMathColor.h"
17 #include "MathExtern.h"
18 #include "MathFactory.h"
19 #include "MathStream.h"
20 #include "MathSupport.h"
23 #include "BufferParams.h"
24 #include "BufferView.h"
26 #include "CutAndPaste.h"
29 #include "FuncRequest.h"
30 #include "FuncStatus.h"
31 #include "LaTeXFeatures.h"
33 #include "MacroTable.h"
34 #include "output_xhtml.h"
36 #include "TextPainter.h"
37 #include "TocBackend.h"
39 #include "insets/InsetLabel.h"
40 #include "insets/InsetRef.h"
41 #include "insets/RenderPreview.h"
43 #include "graphics/PreviewImage.h"
44 #include "graphics/PreviewLoader.h"
46 #include "frontends/Painter.h"
48 #include "support/lassert.h"
49 #include "support/debug.h"
50 #include "support/gettext.h"
51 #include "support/lstrings.h"
56 using namespace lyx::support;
60 using cap::grabAndEraseSelection;
64 int getCols(HullType type)
81 // returns position of first relation operator in the array
82 // used for "intelligent splitting"
83 size_t firstRelOp(MathData const & ar)
85 for (MathData::const_iterator it = ar.begin(); it != ar.end(); ++it)
87 return it - ar.begin();
92 char const * star(bool numbered)
94 return numbered ? "" : "*";
98 } // end anon namespace
101 HullType hullType(docstring const & s)
103 if (s == "none") return hullNone;
104 if (s == "simple") return hullSimple;
105 if (s == "equation") return hullEquation;
106 if (s == "eqnarray") return hullEqnArray;
107 if (s == "align") return hullAlign;
108 if (s == "alignat") return hullAlignAt;
109 if (s == "xalignat") return hullXAlignAt;
110 if (s == "xxalignat") return hullXXAlignAt;
111 if (s == "multline") return hullMultline;
112 if (s == "gather") return hullGather;
113 if (s == "flalign") return hullFlAlign;
114 if (s == "regexp") return hullRegexp;
115 lyxerr << "unknown hull type '" << to_utf8(s) << "'" << endl;
120 docstring hullName(HullType type)
123 case hullNone: return from_ascii("none");
124 case hullSimple: return from_ascii("simple");
125 case hullEquation: return from_ascii("equation");
126 case hullEqnArray: return from_ascii("eqnarray");
127 case hullAlign: return from_ascii("align");
128 case hullAlignAt: return from_ascii("alignat");
129 case hullXAlignAt: return from_ascii("xalignat");
130 case hullXXAlignAt: return from_ascii("xxalignat");
131 case hullMultline: return from_ascii("multline");
132 case hullGather: return from_ascii("gather");
133 case hullFlAlign: return from_ascii("flalign");
134 case hullRegexp: return from_ascii("regexp");
136 lyxerr << "unknown hull type '" << type << "'" << endl;
137 return from_ascii("none");
141 static InsetLabel * dummy_pointer = 0;
143 InsetMathHull::InsetMathHull(Buffer * buf)
144 : InsetMathGrid(buf, 1, 1), type_(hullNone), nonum_(1, true),
145 label_(1, dummy_pointer), preview_(new RenderPreview(this))
147 //lyxerr << "sizeof InsetMath: " << sizeof(InsetMath) << endl;
148 //lyxerr << "sizeof MetricsInfo: " << sizeof(MetricsInfo) << endl;
149 //lyxerr << "sizeof InsetMathChar: " << sizeof(InsetMathChar) << endl;
150 //lyxerr << "sizeof FontInfo: " << sizeof(FontInfo) << endl;
157 InsetMathHull::InsetMathHull(Buffer * buf, HullType type)
158 : InsetMathGrid(buf, getCols(type), 1), type_(type), nonum_(1, true),
159 label_(1, dummy_pointer), preview_(new RenderPreview(this))
167 InsetMathHull::InsetMathHull(InsetMathHull const & other) : InsetMathGrid(other)
173 InsetMathHull::~InsetMathHull()
175 for (size_t i = 0; i < label_.size(); ++i)
180 Inset * InsetMathHull::clone() const
182 return new InsetMathHull(*this);
186 InsetMathHull & InsetMathHull::operator=(InsetMathHull const & other)
190 InsetMathGrid::operator=(other);
192 nonum_ = other.nonum_;
193 buffer_ = other.buffer_;
194 for (size_t i = 0; i < label_.size(); ++i)
196 label_ = other.label_;
197 for (size_t i = 0; i != label_.size(); ++i) {
199 label_[i] = new InsetLabel(*label_[i]);
201 preview_.reset(new RenderPreview(*other.preview_, this));
207 void InsetMathHull::setBuffer(Buffer & buffer)
209 InsetMathGrid::setBuffer(buffer);
211 for (size_t i = 0; i != label_.size(); ++i) {
213 label_[i]->setBuffer(buffer);
218 void InsetMathHull::updateBuffer(ParIterator const & it, UpdateType utype)
221 //FIXME: buffer_ should be set at creation for this inset! Problem is
222 // This inset is created at too many places (see Parser::parse1() in
226 for (size_t i = 0; i != label_.size(); ++i) {
228 label_[i]->updateBuffer(it, utype);
231 InsetMathGrid::updateBuffer(it, utype);
235 void InsetMathHull::addToToc(DocIterator const & pit)
238 //FIXME: buffer_ should be set at creation for this inset! Problem is
239 // This inset is created at too many places (see Parser::parse1() in
244 Toc & toc = buffer().tocBackend().toc("equation");
246 for (row_type row = 0; row != nrows(); ++row) {
250 label_[row]->addToToc(pit);
251 toc.push_back(TocItem(pit, 0, nicelabel(row)));
256 Inset * InsetMathHull::editXY(Cursor & cur, int x, int y)
262 return InsetMathNest::editXY(cur, x, y);
266 InsetMath::mode_type InsetMathHull::currentMode() const
268 if (type_ == hullNone)
269 return UNDECIDED_MODE;
270 // definitely math mode ...
275 bool InsetMathHull::idxFirst(Cursor & cur) const
283 bool InsetMathHull::idxLast(Cursor & cur) const
285 cur.idx() = nargs() - 1;
286 cur.pos() = cur.lastpos();
291 char InsetMathHull::defaultColAlign(col_type col)
293 if (type_ == hullEqnArray)
295 if (type_ == hullGather)
297 if (type_ >= hullAlign)
298 return "rl"[col & 1];
303 int InsetMathHull::defaultColSpace(col_type col)
305 if (type_ == hullAlign || type_ == hullAlignAt)
307 if (type_ == hullXAlignAt)
308 return (col & 1) ? 20 : 0;
309 if (type_ == hullXXAlignAt || type_ == hullFlAlign)
310 return (col & 1) ? 40 : 0;
315 docstring InsetMathHull::standardFont() const
320 font_name = from_ascii("texttt");
323 font_name = from_ascii("lyxnochange");
326 font_name = from_ascii("mathnormal");
332 ColorCode InsetMathHull::standardColor() const
338 color = Color_foreground;
347 bool InsetMathHull::previewState(BufferView * bv) const
349 if (!editing(bv) && RenderPreview::status() == LyXRC::PREVIEW_ON) {
350 graphics::PreviewImage const * pimage =
351 preview_->getPreviewImage(bv->buffer());
352 return pimage && pimage->image();
358 void InsetMathHull::metrics(MetricsInfo & mi, Dimension & dim) const
360 if (previewState(mi.base.bv)) {
361 preview_->metrics(mi, dim);
362 // insert a one pixel gap in front of the formula
365 dim.des += displayMargin();
366 // Cache the inset dimension.
367 setDimCache(mi, dim);
371 FontSetChanger dummy1(mi.base, standardFont());
372 StyleChanger dummy2(mi.base, display() ? LM_ST_DISPLAY : LM_ST_TEXT);
374 // let the cells adjust themselves
375 InsetMathGrid::metrics(mi, dim);
378 dim.asc += displayMargin();
379 dim.des += displayMargin();
382 if (numberedType()) {
383 FontSetChanger dummy(mi.base, from_ascii("mathbf"));
385 for (row_type row = 0; row < nrows(); ++row)
386 l = max(l, mathed_string_width(mi.base.font, nicelabel(row)));
392 // make it at least as high as the current font
395 math_font_max_dim(mi.base.font, asc, des);
396 dim.asc = max(dim.asc, asc);
397 dim.des = max(dim.des, des);
398 // Cache the inset dimension.
399 // FIXME: This will overwrite InsetMathGrid dimension, is that OK?
400 setDimCache(mi, dim);
404 ColorCode InsetMathHull::backgroundColor(PainterInfo const & pi) const
406 if (previewState(pi.base.bv))
407 return graphics::PreviewLoader::backgroundColor();
412 void InsetMathHull::drawBackground(PainterInfo & pi, int x, int y) const
414 Dimension const dim = dimension(*pi.base.bv);
415 pi.pain.fillRectangle(x + 1, y - dim.asc + 1, dim.wid - 2,
416 dim.asc + dim.des - 1, pi.backgroundColor(this));
420 void InsetMathHull::draw(PainterInfo & pi, int x, int y) const
422 use_preview_ = previewState(pi.base.bv);
424 if (type_ == hullRegexp) {
425 Dimension const dim = dimension(*pi.base.bv);
426 pi.pain.rectangle(x + 1, y - dim.ascent() + 1,
427 dim.width() - 2, dim.height() - 2, Color_regexpframe);
430 // one pixel gap in front
431 preview_->draw(pi, x + 1, y);
432 setPosCache(pi, x, y);
436 ColorCode color = pi.selected && lyxrc.use_system_colors
437 ? Color_selectiontext : standardColor();
438 bool const really_change_color = pi.base.font.color() == Color_none;
439 ColorChanger dummy0(pi.base.font, color, really_change_color);
440 FontSetChanger dummy1(pi.base, standardFont());
441 StyleChanger dummy2(pi.base, display() ? LM_ST_DISPLAY : LM_ST_TEXT);
443 InsetMathGrid::draw(pi, x + 1, y);
445 if (numberedType()) {
446 int const xx = x + colinfo_.back().offset_ + colinfo_.back().width_ + 20;
447 for (row_type row = 0; row < nrows(); ++row) {
448 int const yy = y + rowinfo_[row].offset_;
449 FontSetChanger dummy(pi.base, from_ascii("mathrm"));
450 docstring const nl = nicelabel(row);
454 setPosCache(pi, x, y);
458 void InsetMathHull::metricsT(TextMetricsInfo const & mi, Dimension & dim) const
461 InsetMathGrid::metricsT(mi, dim);
464 WriteStream wi(os, false, true, WriteStream::wsDefault);
466 dim.wid = os.str().size();
473 void InsetMathHull::drawT(TextPainter & pain, int x, int y) const
476 InsetMathGrid::drawT(pain, x, y);
479 WriteStream wi(os, false, true, WriteStream::wsDefault);
481 pain.draw(x, y, os.str().c_str());
486 static docstring latexString(InsetMathHull const & inset)
489 // This has to be static, because a preview snippet or a math
490 // macro containing math in text mode (such as $\text{$\phi$}$ or
491 // \newcommand{\xxx}{\text{$\phi$}}) gets processed twice. The
492 // first time as a whole, and the second time only the inner math.
493 // In this last case inset.buffer() would be invalid.
494 static Encoding const * encoding = 0;
495 if (inset.isBufferValid())
496 encoding = &(inset.buffer().params().encoding());
497 WriteStream wi(ls, false, true, WriteStream::wsPreview, encoding);
503 void InsetMathHull::initUnicodeMath() const
505 // Trigger classification of the unicode symbols in this inset
506 docstring const dummy = latexString(*this);
510 void InsetMathHull::addPreview(DocIterator const & inset_pos,
511 graphics::PreviewLoader & /*ploader*/) const
513 if (RenderPreview::status() == LyXRC::PREVIEW_ON) {
514 preparePreview(inset_pos);
519 void InsetMathHull::preparePreview(DocIterator const & pos,
520 bool forexport) const
522 // there is no need to do all the macro stuff if we're not
523 // actually going to generate the preview.
524 if (RenderPreview::status() != LyXRC::PREVIEW_ON && !forexport)
527 Buffer const * buffer = pos.buffer();
529 // collect macros at this position
531 buffer->listMacroNames(macros);
532 MacroNameSet::iterator it = macros.begin();
533 MacroNameSet::iterator end = macros.end();
534 odocstringstream macro_preamble;
535 for (; it != end; ++it) {
536 MacroData const * data = buffer->getMacro(*it, pos, true);
538 data->write(macro_preamble, true);
539 macro_preamble << endl;
543 docstring const snippet = macro_preamble.str() + latexString(*this);
544 LYXERR(Debug::MACROS, "Preview snippet: " << snippet);
545 preview_->addPreview(snippet, *buffer, forexport);
549 void InsetMathHull::reloadPreview(DocIterator const & pos) const
552 preview_->startLoading(*pos.buffer());
556 void InsetMathHull::loadPreview(DocIterator const & pos) const
558 bool const forexport = true;
559 preparePreview(pos, forexport);
560 preview_->startLoading(*pos.buffer(), forexport);
564 bool InsetMathHull::notifyCursorLeaves(Cursor const & old, Cursor & cur)
566 if (RenderPreview::status() == LyXRC::PREVIEW_ON) {
568 cur.screenUpdateFlags(Update::Force);
574 docstring InsetMathHull::label(row_type row) const
576 LASSERT(row < nrows(), /**/);
577 if (InsetLabel * il = label_[row])
578 return il->screenLabel();
583 void InsetMathHull::label(row_type row, docstring const & label)
585 //lyxerr << "setting label '" << label << "' for row " << row << endl;
589 label_[row] = dummy_pointer;
592 label_[row]->updateCommand(label);
594 label_[row]->setParam("name", label);
598 InsetCommandParams p(LABEL_CODE);
600 label_[row] = new InsetLabel(buffer_, p);
602 label_[row]->setBuffer(buffer());
606 void InsetMathHull::numbered(row_type row, bool num)
609 if (nonum_[row] && label_[row]) {
616 bool InsetMathHull::numbered(row_type row) const
622 bool InsetMathHull::ams() const
624 return type_ == hullAlign
625 || type_ == hullFlAlign
626 || type_ == hullMultline
627 || type_ == hullGather
628 || type_ == hullAlignAt
629 || type_ == hullXAlignAt
630 || type_ == hullXXAlignAt;
634 Inset::DisplayType InsetMathHull::display() const
636 if (type_ == hullSimple || type_ == hullNone || type_ == hullRegexp)
641 bool InsetMathHull::numberedType() const
643 if (type_ == hullNone)
645 if (type_ == hullSimple)
647 if (type_ == hullXXAlignAt)
649 if (type_ == hullRegexp)
651 for (row_type row = 0; row < nrows(); ++row)
658 void InsetMathHull::validate(LaTeXFeatures & features) const
660 if (features.runparams().isLaTeX()) {
662 features.require("amsmath");
664 if (type_ == hullRegexp) {
665 features.require("color");
666 string frcol = lcolor.getLaTeXName(Color_regexpframe);
667 string bgcol = "white";
668 features.addPreambleSnippet(
669 string("\\newcommand{\\regexp}[1]{\\fcolorbox{")
670 + frcol + string("}{")
671 + bgcol + string("}{\\texttt{#1}}}"));
674 // Validation is necessary only if not using AMS math.
675 // To be safe, we will always run mathedvalidate.
676 //if (features.amsstyle)
679 //features.binom = true;
680 } else if (features.runparams().math_flavor == OutputParams::MathAsHTML) {
681 // it would be better to do this elsewhere, but we can't validate in
682 // InsetMathMatrix and we have no way, outside MathExtern, to know if
683 // we even have any matrices.
684 features.addPreambleSnippet("<style type=\"text/css\">\n"
685 "table.matrix{display: inline-block; vertical-align: middle; text-align:center;}\n"
686 "table.matrix td{padding: 0.25px;}\n"
687 "td.ldelim{width: 0.5ex; border: thin solid black; border-right: none;}\n"
688 "td.rdelim{width: 0.5ex; border: thin solid black; border-left: none;}\n"
691 InsetMathGrid::validate(features);
695 void InsetMathHull::header_write(WriteStream & os) const
697 bool n = numberedType();
711 os << "\\begin{equation" << star(n) << "}\n";
721 os << "\\begin{" << hullName(type_) << star(n) << "}\n";
726 os << "\\begin{" << hullName(type_) << star(n) << '}'
727 << '{' << static_cast<unsigned int>((ncols() + 1)/2) << "}\n";
731 os << "\\begin{" << hullName(type_) << '}'
732 << '{' << static_cast<unsigned int>((ncols() + 1)/2) << "}\n";
740 os << "\\begin{unknown" << star(n) << '}';
746 void InsetMathHull::footer_write(WriteStream & os) const
748 bool n = numberedType();
761 os << "\\end{equation" << star(n) << "}\n";
773 os << "\\end{" << hullName(type_) << star(n) << "}\n";
777 os << "\\end{" << hullName(type_) << "}\n";
785 os << "\\end{unknown" << star(n) << '}';
791 bool InsetMathHull::rowChangeOK() const
794 type_ == hullEqnArray || type_ == hullAlign ||
795 type_ == hullFlAlign || type_ == hullAlignAt ||
796 type_ == hullXAlignAt || type_ == hullXXAlignAt ||
797 type_ == hullGather || type_ == hullMultline;
801 bool InsetMathHull::colChangeOK() const
804 type_ == hullAlign || type_ == hullFlAlign ||type_ == hullAlignAt ||
805 type_ == hullXAlignAt || type_ == hullXXAlignAt;
809 void InsetMathHull::addRow(row_type row)
814 bool numbered = numberedType();
816 if (type_ == hullMultline) {
817 if (row + 1 == nrows()) {
824 nonum_.insert(nonum_.begin() + row + 1, !numbered);
825 label_.insert(label_.begin() + row + 1, dummy_pointer);
828 InsetMathGrid::addRow(row);
832 void InsetMathHull::swapRow(row_type row)
836 if (row + 1 == nrows())
838 // gcc implements the standard std::vector<bool> which is *not* a container:
839 // http://www.gotw.ca/publications/N1185.pdf
840 // As a results, it doesn't like this:
841 // swap(nonum_[row], nonum_[row + 1]);
842 // so we do it manually:
843 bool const b = nonum_[row];
844 nonum_[row] = nonum_[row + 1];
846 swap(label_[row], label_[row + 1]);
847 InsetMathGrid::swapRow(row);
851 void InsetMathHull::delRow(row_type row)
853 if (nrows() <= 1 || !rowChangeOK())
855 if (row + 1 == nrows() && type_ == hullMultline) {
856 bool const b = nonum_[row - 1];
857 nonum_[row - 1] = nonum_[row];
859 swap(label_[row - 1], label_[row]);
860 InsetMathGrid::delRow(row);
863 InsetMathGrid::delRow(row);
864 // The last dummy row has no number info nor a label.
865 // Test nrows() + 1 because we have already erased the row.
866 if (row == nrows() + 1)
868 nonum_.erase(nonum_.begin() + row);
870 label_.erase(label_.begin() + row);
874 void InsetMathHull::addCol(col_type col)
878 InsetMathGrid::addCol(col);
882 void InsetMathHull::delCol(col_type col)
884 if (ncols() <= 1 || !colChangeOK())
886 InsetMathGrid::delCol(col);
890 docstring InsetMathHull::nicelabel(row_type row) const
895 return from_ascii("(#)");
896 return '(' + label_[row]->screenLabel() + from_ascii(", #)");
900 void InsetMathHull::glueall(HullType type)
903 for (idx_type i = 0; i < nargs(); ++i)
905 InsetLabel * label = 0;
906 if (type == hullEquation) {
907 // preserve first non-empty label
908 for (row_type row = 0; row < nrows(); ++row) {
916 *this = InsetMathHull(buffer_, hullSimple);
924 void InsetMathHull::splitTo2Cols()
926 LASSERT(ncols() == 1, /**/);
927 InsetMathGrid::addCol(1);
928 for (row_type row = 0; row < nrows(); ++row) {
929 idx_type const i = 2 * row;
930 pos_type pos = firstRelOp(cell(i));
931 cell(i + 1) = MathData(buffer_, cell(i).begin() + pos, cell(i).end());
932 cell(i).erase(pos, cell(i).size());
937 void InsetMathHull::splitTo3Cols()
939 LASSERT(ncols() < 3, /**/);
942 InsetMathGrid::addCol(2);
943 for (row_type row = 0; row < nrows(); ++row) {
944 idx_type const i = 3 * row + 1;
945 if (cell(i).size()) {
946 cell(i + 1) = MathData(buffer_, cell(i).begin() + 1, cell(i).end());
947 cell(i).erase(1, cell(i).size());
953 void InsetMathHull::changeCols(col_type cols)
957 else if (ncols() < cols) {
963 while (ncols() < cols)
964 InsetMathGrid::addCol(ncols());
970 for (row_type row = 0; row < nrows(); ++row) {
971 idx_type const i = row * ncols();
972 for (col_type col = cols; col < ncols(); ++col) {
973 cell(i + cols - 1).append(cell(i + col));
977 while (ncols() > cols) {
978 InsetMathGrid::delCol(ncols() - 1);
983 HullType InsetMathHull::getType() const
989 void InsetMathHull::setType(HullType type)
996 void InsetMathHull::mutate(HullType newtype)
998 //lyxerr << "mutating from '" << type_ << "' to '" << newtype << "'" << endl;
1000 // we try to move along the chain
1001 // none <-> simple <-> equation <-> eqnarray -> *align* -> multline, gather -+
1003 // +-------------------------------------+
1004 // we use eqnarray as intermediate type for mutations that are not
1005 // directly supported because it handles labels and numbering for
1008 if (newtype == type_) {
1012 else if (newtype < hullNone) {
1017 else if (type_ == hullNone) {
1018 setType(hullSimple);
1023 else if (type_ == hullSimple) {
1024 if (newtype == hullNone) {
1028 setType(hullEquation);
1033 else if (type_ == hullEquation) {
1034 if (newtype < type_) {
1035 setType(hullSimple);
1038 } else if (newtype == hullEqnArray) {
1039 // split it "nicely" on the first relop
1041 setType(hullEqnArray);
1042 } else if (newtype == hullMultline || newtype == hullGather) {
1045 // split it "nicely"
1052 else if (type_ == hullEqnArray) {
1053 if (newtype < type_) {
1056 } else { // align & Co.
1063 else if (type_ == hullAlign || type_ == hullAlignAt ||
1064 type_ == hullXAlignAt || type_ == hullFlAlign) {
1065 if (newtype < hullAlign) {
1067 setType(hullEqnArray);
1069 } else if (newtype == hullGather || newtype == hullMultline) {
1072 } else if (newtype == hullXXAlignAt) {
1073 for (row_type row = 0; row < nrows(); ++row)
1074 numbered(row, false);
1081 else if (type_ == hullXXAlignAt) {
1082 for (row_type row = 0; row < nrows(); ++row)
1083 numbered(row, false);
1084 if (newtype < hullAlign) {
1086 setType(hullEqnArray);
1088 } else if (newtype == hullGather || newtype == hullMultline) {
1096 else if (type_ == hullMultline || type_ == hullGather) {
1097 if (newtype == hullGather || newtype == hullMultline)
1099 else if (newtype == hullAlign || newtype == hullFlAlign ||
1100 newtype == hullAlignAt || newtype == hullXAlignAt) {
1103 } else if (newtype == hullXXAlignAt) {
1105 for (row_type row = 0; row < nrows(); ++row)
1106 numbered(row, false);
1110 setType(hullEqnArray);
1116 lyxerr << "mutation from '" << to_utf8(hullName(type_))
1117 << "' to '" << to_utf8(hullName(newtype))
1118 << "' not implemented" << endl;
1123 docstring InsetMathHull::eolString(row_type row, bool fragile, bool last_eoln) const
1126 if (numberedType()) {
1127 if (label_[row] && !nonum_[row])
1129 escape(label_[row]->getParam("name")) + '}';
1130 if (nonum_[row] && (type_ != hullMultline))
1131 res += "\\nonumber ";
1133 // Never add \\ on the last empty line of eqnarray and friends
1135 return res + InsetMathGrid::eolString(row, fragile, last_eoln);
1139 void InsetMathHull::write(WriteStream & os) const
1141 ModeSpecifier specifier(os, MATH_MODE);
1143 InsetMathGrid::write(os);
1148 void InsetMathHull::normalize(NormalStream & os) const
1150 os << "[formula " << hullName(type_) << ' ';
1151 InsetMathGrid::normalize(os);
1156 void InsetMathHull::mathmlize(MathStream & os) const
1158 InsetMathGrid::mathmlize(os);
1162 void InsetMathHull::infoize(odocstream & os) const
1164 os << "Type: " << hullName(type_);
1168 void InsetMathHull::check() const
1170 LASSERT(nonum_.size() == nrows(), /**/);
1171 LASSERT(label_.size() == nrows(), /**/);
1175 void InsetMathHull::doExtern(Cursor & cur, FuncRequest & func)
1179 idocstringstream iss(func.argument());
1180 iss >> dlang >> extra;
1182 extra = from_ascii("noextra");
1183 string const lang = to_ascii(dlang);
1185 // FIXME: temporarily disabled
1186 //if (cur.selection()) {
1189 // lyxerr << "use selection: " << ar << endl;
1190 // insert(pipeThroughExtern(lang, extra, ar));
1195 eq.push_back(MathAtom(new InsetMathChar('=')));
1197 // go to first item in line
1198 cur.idx() -= cur.idx() % ncols();
1201 if (getType() == hullSimple) {
1202 size_type pos = cur.cell().find_last(eq);
1204 if (cur.inMathed() && cur.selection()) {
1205 asArray(grabAndEraseSelection(cur), ar);
1206 } else if (pos == cur.cell().size()) {
1208 lyxerr << "use whole cell: " << ar << endl;
1210 ar = MathData(buffer_, cur.cell().begin() + pos + 1, cur.cell().end());
1211 lyxerr << "use partial cell form pos: " << pos << endl;
1213 cur.cell().append(eq);
1214 cur.cell().append(pipeThroughExtern(lang, extra, ar));
1215 cur.pos() = cur.lastpos();
1219 if (getType() == hullEquation) {
1220 lyxerr << "use equation inset" << endl;
1221 mutate(hullEqnArray);
1222 MathData & ar = cur.cell();
1223 lyxerr << "use cell: " << ar << endl;
1227 cur.cell() = pipeThroughExtern(lang, extra, ar);
1228 // move to end of line
1229 cur.pos() = cur.lastpos();
1234 lyxerr << "use eqnarray" << endl;
1235 cur.idx() += 2 - cur.idx() % ncols();
1237 MathData ar = cur.cell();
1238 lyxerr << "use cell: " << ar << endl;
1239 // FIXME: temporarily disabled
1245 cur.cell() = pipeThroughExtern(lang, extra, ar);
1246 cur.pos() = cur.lastpos();
1251 void InsetMathHull::doDispatch(Cursor & cur, FuncRequest & cmd)
1253 //lyxerr << "action: " << cmd.action() << endl;
1254 switch (cmd.action()) {
1256 case LFUN_FINISHED_BACKWARD:
1257 case LFUN_FINISHED_FORWARD:
1258 case LFUN_FINISHED_RIGHT:
1259 case LFUN_FINISHED_LEFT:
1260 //lyxerr << "action: " << cmd.action() << endl;
1261 InsetMathGrid::doDispatch(cur, cmd);
1265 case LFUN_BREAK_PARAGRAPH:
1266 // just swallow this
1269 case LFUN_NEWLINE_INSERT:
1270 // some magic for the common case
1271 if (type_ == hullSimple || type_ == hullEquation) {
1272 cur.recordUndoInset();
1274 cur.bv().buffer().params().use_amsmath == BufferParams::package_on;
1275 mutate(align ? hullAlign : hullEqnArray);
1276 // mutate() may change labels and such.
1277 cur.forceBufferUpdate();
1278 cur.idx() = nrows() * ncols() - 1;
1279 cur.pos() = cur.lastpos();
1281 InsetMathGrid::doDispatch(cur, cmd);
1284 case LFUN_MATH_NUMBER_TOGGLE: {
1285 //lyxerr << "toggling all numbers" << endl;
1286 cur.recordUndoInset();
1287 bool old = numberedType();
1288 if (type_ == hullMultline)
1289 numbered(nrows() - 1, !old);
1291 for (row_type row = 0; row < nrows(); ++row)
1292 numbered(row, !old);
1294 cur.message(old ? _("No number") : _("Number"));
1295 cur.forceBufferUpdate();
1299 case LFUN_MATH_NUMBER_LINE_TOGGLE: {
1300 cur.recordUndoInset();
1301 row_type r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1302 bool old = numbered(r);
1303 cur.message(old ? _("No number") : _("Number"));
1305 cur.forceBufferUpdate();
1309 case LFUN_LABEL_INSERT: {
1310 cur.recordUndoInset();
1311 row_type r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1312 docstring old_label = label(r);
1314 // Allow customization of this separator
1315 docstring const default_label = from_ascii("eq:");
1316 if (old_label.empty())
1317 old_label = default_label;
1319 InsetCommandParams p(LABEL_CODE);
1320 p["name"] = cmd.argument().empty() ? old_label : cmd.argument();
1321 string const data = InsetCommand::params2string("label", p);
1323 if (cmd.argument().empty())
1324 cur.bv().showDialog("label", data);
1326 FuncRequest fr(LFUN_INSET_INSERT, data);
1332 case LFUN_LABEL_COPY_AS_REF: {
1334 if (cmd.argument().empty() && &cur.inset() == this)
1335 // if there is no argument and we're inside math, we retrieve
1336 // the row number from the cursor position.
1337 row = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1339 // if there is an argument, find the corresponding label, else
1340 // check whether there is at least one label.
1341 for (row = 0; row != nrows(); ++row)
1342 if (!nonum_[row] && label_[row]
1343 && (cmd.argument().empty() || label(row) == cmd.argument()))
1350 InsetCommandParams p(REF_CODE, "ref");
1351 p["reference"] = label(row);
1352 cap::clearSelection();
1353 cap::copyInset(cur, new InsetRef(buffer_, p), label(row));
1357 case LFUN_WORD_DELETE_FORWARD:
1358 case LFUN_CHAR_DELETE_FORWARD:
1359 if (col(cur.idx()) + 1 == ncols()
1360 && cur.pos() == cur.lastpos()
1361 && !cur.selection()) {
1362 if (!label(row(cur.idx())).empty()) {
1363 cur.recordUndoInset();
1364 label(row(cur.idx()), docstring());
1365 } else if (numbered(row(cur.idx()))) {
1366 cur.recordUndoInset();
1367 numbered(row(cur.idx()), false);
1368 cur.forceBufferUpdate();
1370 InsetMathGrid::doDispatch(cur, cmd);
1374 InsetMathGrid::doDispatch(cur, cmd);
1379 case LFUN_INSET_INSERT: {
1380 //lyxerr << "arg: " << to_utf8(cmd.argument()) << endl;
1381 // FIXME: this should be cleaned up to use InsetLabel methods directly.
1382 string const name = cmd.getArg(0);
1383 if (name == "label") {
1384 InsetCommandParams p(LABEL_CODE);
1385 InsetCommand::string2params(name, to_utf8(cmd.argument()), p);
1386 docstring str = p["name"];
1387 cur.recordUndoInset();
1388 row_type const r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1392 docstring old = label(r);
1395 // The label will take care of the reference update.
1399 // Newly created inset so initialize it.
1400 label_[r]->initView();
1403 cur.forceBufferUpdate();
1406 InsetMathGrid::doDispatch(cur, cmd);
1410 case LFUN_MATH_EXTERN:
1411 cur.recordUndoInset();
1415 case LFUN_MATH_MUTATE: {
1416 cur.recordUndoInset();
1417 row_type row = cur.row();
1418 col_type col = cur.col();
1419 mutate(hullType(cmd.argument()));
1420 cur.idx() = row * ncols() + col;
1421 if (cur.idx() > cur.lastidx()) {
1422 cur.idx() = cur.lastidx();
1423 cur.pos() = cur.lastpos();
1425 if (cur.pos() > cur.lastpos())
1426 cur.pos() = cur.lastpos();
1428 cur.forceBufferUpdate();
1429 // FIXME: find some more clever handling of the selection,
1430 // i.e. preserve it.
1431 cur.clearSelection();
1432 //cur.dispatched(FINISHED);
1436 case LFUN_MATH_DISPLAY: {
1437 cur.recordUndoInset();
1438 mutate(type_ == hullSimple ? hullEquation : hullSimple);
1440 cur.pos() = cur.lastpos();
1441 //cur.dispatched(FINISHED);
1446 InsetMathGrid::doDispatch(cur, cmd);
1452 bool InsetMathHull::getStatus(Cursor & cur, FuncRequest const & cmd,
1453 FuncStatus & status) const
1455 switch (cmd.action()) {
1456 case LFUN_FINISHED_BACKWARD:
1457 case LFUN_FINISHED_FORWARD:
1458 case LFUN_FINISHED_RIGHT:
1459 case LFUN_FINISHED_LEFT:
1462 case LFUN_NEWLINE_INSERT:
1463 case LFUN_MATH_EXTERN:
1464 case LFUN_MATH_DISPLAY:
1466 status.setEnabled(true);
1469 case LFUN_MATH_MUTATE: {
1470 HullType ht = hullType(cmd.argument());
1471 status.setOnOff(type_ == ht);
1472 status.setEnabled(true);
1476 case LFUN_MATH_NUMBER_TOGGLE:
1477 // FIXME: what is the right test, this or the one of
1479 status.setEnabled(display() != Inline);
1480 status.setOnOff(numberedType());
1483 case LFUN_MATH_NUMBER_LINE_TOGGLE: {
1484 // FIXME: what is the right test, this or the one of
1486 bool const enable = (type_ == hullMultline)
1487 ? (nrows() - 1 == cur.row())
1488 : display() != Inline && nrows() > 1;
1489 row_type const r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1490 status.setEnabled(enable);
1491 status.setOnOff(enable && numbered(r));
1495 case LFUN_LABEL_INSERT:
1496 status.setEnabled(type_ != hullSimple);
1499 case LFUN_LABEL_COPY_AS_REF: {
1500 bool enabled = false;
1502 if (cmd.argument().empty() && &cur.inset() == this) {
1503 // if there is no argument and we're inside math, we retrieve
1504 // the row number from the cursor position.
1505 row = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1506 enabled = numberedType() && label_[row] && !nonum_[row];
1508 // if there is an argument, find the corresponding label, else
1509 // check whether there is at least one label.
1510 for (row_type row = 0; row != nrows(); ++row) {
1511 if (!nonum_[row] && label_[row] &&
1512 (cmd.argument().empty() || label(row) == cmd.argument())) {
1518 status.setEnabled(enabled);
1522 case LFUN_INSET_INSERT:
1523 if (cmd.getArg(0) == "label") {
1524 status.setEnabled(type_ != hullSimple);
1527 return InsetMathGrid::getStatus(cur, cmd, status);
1529 case LFUN_INSET_MODIFY: {
1530 istringstream is(to_utf8(cmd.argument()));
1534 return InsetMathGrid::getStatus(cur, cmd, status);
1537 && (s == "append-row"
1538 || s == "delete-row"
1539 || s == "copy-row")) {
1540 status.message(bformat(
1541 from_utf8(N_("Can't change number of rows in '%1$s'")),
1543 status.setEnabled(false);
1547 && (s == "append-column"
1548 || s == "delete-column"
1549 || s == "copy-column")) {
1550 status.message(bformat(
1551 from_utf8(N_("Can't change number of columns in '%1$s'")),
1553 status.setEnabled(false);
1556 if ((type_ == hullSimple
1557 || type_ == hullEquation
1558 || type_ == hullNone) &&
1559 (s == "add-hline-above" || s == "add-hline-below")) {
1560 status.message(bformat(
1561 from_utf8(N_("Can't add horizontal grid lines in '%1$s'")),
1563 status.setEnabled(false);
1566 if (s == "add-vline-left" || s == "add-vline-right") {
1567 status.message(bformat(
1568 from_utf8(N_("Can't add vertical grid lines in '%1$s'")),
1570 status.setEnabled(false);
1573 if (s == "valign-top" || s == "valign-middle"
1574 || s == "valign-bottom" || s == "align-left"
1575 || s == "align-center" || s == "align-right") {
1576 status.setEnabled(false);
1579 return InsetMathGrid::getStatus(cur, cmd, status);
1583 return InsetMathGrid::getStatus(cur, cmd, status);
1586 // This cannot really happen, but inserted to shut-up gcc
1587 return InsetMathGrid::getStatus(cur, cmd, status);
1591 /////////////////////////////////////////////////////////////////////
1595 // simply scrap this function if you want
1596 void InsetMathHull::mutateToText()
1599 // translate to latex
1601 latex(os, false, false);
1602 string str = os.str();
1605 Text * lt = view_->cursor().innerText();
1606 string::const_iterator cit = str.begin();
1607 string::const_iterator end = str.end();
1608 for (; cit != end; ++cit)
1609 view_->getIntl()->getTransManager().TranslateAndInsert(*cit, lt);
1612 //dispatch(LFUN_ESCAPE);
1617 void InsetMathHull::handleFont(Cursor & cur, docstring const & arg,
1618 docstring const & font)
1620 // this whole function is a hack and won't work for incremental font
1623 if (cur.inset().asInsetMath()->name() == font)
1624 cur.handleFont(to_utf8(font));
1626 cur.handleNest(createInsetMath(font, cur.buffer()));
1632 void InsetMathHull::handleFont2(Cursor & cur, docstring const & arg)
1637 font.fromString(to_utf8(arg), b);
1638 if (font.fontInfo().color() != Color_inherit) {
1639 MathAtom at = MathAtom(new InsetMathColor(buffer_, true, font.fontInfo().color()));
1640 cur.handleNest(at, 0);
1645 void InsetMathHull::edit(Cursor & cur, bool front, EntryDirection entry_from)
1648 bool enter_front = (entry_from == Inset::ENTRY_DIRECTION_LEFT ||
1649 (entry_from == Inset::ENTRY_DIRECTION_IGNORE && front));
1650 enter_front ? idxFirst(cur) : idxLast(cur);
1651 // The inset formula dimension is not necessarily the same as the
1652 // one of the instant preview image, so we have to indicate to the
1653 // BufferView that a metrics update is needed.
1654 cur.screenUpdateFlags(Update::Force);
1658 void InsetMathHull::revealCodes(Cursor & cur) const
1660 if (!cur.inMathed())
1662 odocstringstream os;
1664 cur.message(os.str());
1666 // write something to the minibuffer
1667 // translate to latex
1671 string str = os.str();
1673 string::size_type pos = 0;
1675 for (string::iterator it = str.begin(); it != str.end(); ++it) {
1678 else if (*it == '\0') {
1680 pos = it - str.begin();
1686 res = res.substr(pos - 30);
1687 if (res.size() > 60)
1688 res = res.substr(0, 60);
1694 /////////////////////////////////////////////////////////////////////
1698 bool InsetMathHull::searchForward(BufferView * bv, string const & str,
1701 // FIXME: completely broken
1702 static InsetMathHull * lastformula = 0;
1703 static CursorBase current = DocIterator(ibegin(nucleus()));
1705 static string laststr;
1707 if (lastformula != this || laststr != str) {
1708 //lyxerr << "reset lastformula to " << this << endl;
1711 current = ibegin(nucleus());
1713 mathed_parse_cell(ar, str, Parse::NORMAL, &buffer());
1717 //lyxerr << "searching '" << str << "' in " << this << ar << endl;
1719 for (DocIterator it = current; it != iend(nucleus()); increment(it)) {
1720 CursorSlice & top = it.back();
1721 MathData const & a = top.asInsetMath()->cell(top.idx_);
1722 if (a.matchpart(ar, top.pos_)) {
1723 bv->cursor().setSelection(it, ar.size());
1725 top.pos_ += ar.size();
1731 //lyxerr << "not found!" << endl;
1738 void InsetMathHull::write(ostream & os) const
1740 odocstringstream oss;
1741 WriteStream wi(oss, false, false, WriteStream::wsDefault);
1744 os << to_utf8(oss.str());
1748 void InsetMathHull::read(Lexer & lex)
1751 mathed_parse_normal(buffer_, at, lex, Parse::TRACKMACRO);
1752 operator=(*at->asHullInset());
1756 bool InsetMathHull::readQuiet(Lexer & lex)
1759 bool success = mathed_parse_normal(buffer_, at, lex, Parse::QUIET);
1761 operator=(*at->asHullInset());
1766 int InsetMathHull::plaintext(odocstream & os, OutputParams const &) const
1768 // disables ASCII-art for export of equations. See #2275.
1769 if (0 && display()) {
1773 TextPainter tpain(dim.width(), dim.height());
1774 drawT(tpain, 0, dim.ascent());
1776 // reset metrics cache to "real" values
1778 return tpain.textheight();
1780 odocstringstream oss;
1781 Encoding const * const enc = encodings.fromLyXName("utf8");
1782 WriteStream wi(oss, false, true, WriteStream::wsDefault, enc);
1784 if (type_ == hullRegexp)
1788 docstring const str = oss.str();
1795 int InsetMathHull::docbook(odocstream & os, OutputParams const & runparams) const
1800 if (getType() == hullSimple)
1801 name = from_ascii("inlineequation");
1803 name = from_ascii("informalequation");
1805 docstring bname = name;
1806 if (!label(0).empty())
1807 bname += " id='" + sgml::cleanID(buffer(), runparams, label(0)) + "'";
1809 ++ms.tab(); ms.cr(); ms.os() << '<' << bname << '>';
1811 odocstringstream ls;
1812 if (runparams.flavor == OutputParams::XML) {
1813 ms << MTag("alt role='tex' ");
1814 // Workaround for db2latex: db2latex always includes equations with
1815 // \ensuremath{} or \begin{display}\end{display}
1816 // so we strip LyX' math environment
1817 WriteStream wi(ls, false, false, WriteStream::wsDefault, runparams.encoding);
1818 InsetMathGrid::write(wi);
1819 ms << from_utf8(subst(subst(to_utf8(ls.str()), "&", "&"), "<", "<"));
1824 InsetMathGrid::mathmlize(ms);
1827 ms << MTag("alt role='tex'");
1828 res = latex(ls, runparams);
1829 ms << from_utf8(subst(subst(to_utf8(ls.str()), "&", "&"), "<", "<"));
1833 ms << from_ascii("<graphic fileref=\"eqn/");
1834 if (!label(0).empty())
1835 ms << sgml::cleanID(buffer(), runparams, label(0));
1837 ms << sgml::uniqueID(from_ascii("anon"));
1839 if (runparams.flavor == OutputParams::XML)
1840 ms << from_ascii("\"/>");
1842 ms << from_ascii("\">");
1844 ms.cr(); --ms.tab(); ms.os() << "</" << name << '>';
1846 return ms.line() + res;
1850 docstring InsetMathHull::xhtml(XHTMLStream & xs, OutputParams const & op) const
1852 BufferParams::MathOutput const mathtype =
1853 buffer().params().html_math_output;
1855 bool success = false;
1856 // FIXME Eventually we would like to do this inset by inset.
1857 if (mathtype == BufferParams::MathML) {
1858 odocstringstream os;
1861 InsetMathGrid::mathmlize(ms);
1863 } catch (MathExportException const &) {}
1865 if (getType() == hullSimple)
1866 xs << html::StartTag("math",
1867 "xmlns=\"http://www.w3.org/1998/Math/MathML\"", true);
1869 xs << html::StartTag("math",
1870 "display=\"block\" xmlns=\"http://www.w3.org/1998/Math/MathML\"", true);
1871 xs << XHTMLStream::NextRaw()
1873 << html::EndTag("math");
1875 } else if (mathtype == BufferParams::HTML) {
1876 odocstringstream os;
1879 InsetMathGrid::htmlize(ms);
1881 } catch (MathExportException const &) {}
1883 string const tag = (getType() == hullSimple) ? "span" : "div";
1884 xs << html::StartTag(tag, "class='formula'", true)
1885 << XHTMLStream::NextRaw()
1887 << html::EndTag(tag);
1891 // what we actually want is this:
1893 // ((mathtype == BufferParams::MathML || mathtype == BufferParams::HTML)
1895 // || mathtype == BufferParams::Images
1897 // but what follows is equivalent, since we'll enter only if either (a) we
1898 // tried and failed with MathML or HTML or (b) didn't try yet at all but
1899 // aren't doing LaTeX, in which case we are doing Images.
1900 if (!success && mathtype != BufferParams::LaTeX) {
1901 loadPreview(docit_);
1902 graphics::PreviewImage const * pimage = preview_->getPreviewImage(buffer());
1904 // FIXME Do we always have png?
1905 string const tag = (getType() == hullSimple) ? "span" : "div";
1906 FileName const & mathimg = pimage->filename();
1907 xs << html::StartTag(tag)
1908 << html::CompTag("img", "src=\"" + mathimg.onlyFileName() + "\"")
1909 << html::EndTag(tag);
1911 // add the file to the list of files to be exported
1912 op.exportdata->addExternalFile("xhtml", mathimg);
1917 // so we'll pass this test if we've failed everything else, or
1918 // if mathtype was LaTeX, since we won't have entered any of the
1920 if (!success /* || mathtype != BufferParams::LaTeX */) {
1921 string const tag = (getType() == hullSimple) ? "span" : "div";
1922 // Unfortunately, we cannot use latexString() because we do not want
1923 // $...$ or whatever.
1924 odocstringstream ls;
1925 WriteStream wi(ls, false, true, WriteStream::wsPreview);
1926 ModeSpecifier specifier(wi, MATH_MODE);
1927 InsetMathGrid::write(wi);
1928 docstring const latex = ls.str();
1930 // class='math' allows for use of jsMath
1931 // http://www.math.union.edu/~dpvc/jsMath/
1933 // probably should allow for some kind of customization here
1934 xs << html::StartTag(tag, "class='math'")
1936 << html::EndTag(tag);
1943 void InsetMathHull::tocString(odocstream & os) const
1945 plaintext(os, OutputParams(0));
1949 docstring InsetMathHull::contextMenu(BufferView const &, int, int) const
1951 return from_ascii("context-math");
1955 void InsetMathHull::recordLocation(DocIterator const & di)