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 "InsetMathFrac.h"
18 #include "InsetMathGrid.h"
19 #include "InsetMathNest.h"
20 #include "InsetMathScript.h"
21 #include "MathExtern.h"
22 #include "MathFactory.h"
23 #include "MathStream.h"
24 #include "MathSupport.h"
27 #include "BufferParams.h"
28 #include "BufferView.h"
30 #include "CutAndPaste.h"
33 #include "FuncRequest.h"
34 #include "FuncStatus.h"
36 #include "LaTeXFeatures.h"
38 #include "MacroTable.h"
39 #include "MathMacro.h"
40 #include "MathMacroTemplate.h"
41 #include "MetricsInfo.h"
42 #include "output_xhtml.h"
43 #include "Paragraph.h"
44 #include "ParIterator.h"
47 #include "TextClass.h"
48 #include "TextPainter.h"
49 #include "TocBackend.h"
51 #include "insets/InsetLabel.h"
52 #include "insets/InsetRef.h"
53 #include "insets/RenderPreview.h"
55 #include "graphics/GraphicsImage.h"
56 #include "graphics/PreviewImage.h"
57 #include "graphics/PreviewLoader.h"
59 #include "frontends/alert.h"
60 #include "frontends/Painter.h"
62 #include "support/convert.h"
63 #include "support/debug.h"
64 #include "support/gettext.h"
65 #include "support/filetools.h"
66 #include "support/lassert.h"
67 #include "support/lstrings.h"
68 #include "support/RefChanger.h"
73 using namespace lyx::support;
77 using cap::grabAndEraseSelection;
78 using cap::reduceSelectionToOneCell;
82 int getCols(HullType type)
107 // returns position of first relation operator in the array
108 // used for "intelligent splitting"
109 size_t firstRelOp(MathData const & ar)
111 for (MathData::const_iterator it = ar.begin(); it != ar.end(); ++it)
112 if ((*it)->isMathRel())
113 return it - ar.begin();
118 char const * star(bool numbered)
120 return numbered ? "" : "*";
124 } // end anon namespace
127 HullType hullType(docstring const & s)
129 if (s == "none") return hullNone;
130 if (s == "simple") return hullSimple;
131 if (s == "equation") return hullEquation;
132 if (s == "eqnarray") return hullEqnArray;
133 if (s == "align") return hullAlign;
134 if (s == "alignat") return hullAlignAt;
135 if (s == "xalignat") return hullXAlignAt;
136 if (s == "xxalignat") return hullXXAlignAt;
137 if (s == "multline") return hullMultline;
138 if (s == "gather") return hullGather;
139 if (s == "flalign") return hullFlAlign;
140 if (s == "regexp") return hullRegexp;
141 lyxerr << "unknown hull type '" << to_utf8(s) << "'" << endl;
146 docstring hullName(HullType type)
149 case hullNone: return from_ascii("none");
150 case hullSimple: return from_ascii("simple");
151 case hullEquation: return from_ascii("equation");
152 case hullEqnArray: return from_ascii("eqnarray");
153 case hullAlign: return from_ascii("align");
154 case hullAlignAt: return from_ascii("alignat");
155 case hullXAlignAt: return from_ascii("xalignat");
156 case hullXXAlignAt: return from_ascii("xxalignat");
157 case hullMultline: return from_ascii("multline");
158 case hullGather: return from_ascii("gather");
159 case hullFlAlign: return from_ascii("flalign");
160 case hullRegexp: return from_ascii("regexp");
162 lyxerr << "unknown hull type" << endl;
165 return from_ascii("none");
168 static InsetLabel * dummy_pointer = 0;
170 InsetMathHull::InsetMathHull(Buffer * buf)
171 : InsetMathGrid(buf, 1, 1), type_(hullNone), numbered_(1, NUMBER),
172 numbers_(1, empty_docstring()), label_(1, dummy_pointer),
173 preview_(new RenderPreview(this))
175 //lyxerr << "sizeof InsetMath: " << sizeof(InsetMath) << endl;
176 //lyxerr << "sizeof MetricsInfo: " << sizeof(MetricsInfo) << endl;
177 //lyxerr << "sizeof InsetMathChar: " << sizeof(InsetMathChar) << endl;
178 //lyxerr << "sizeof FontInfo: " << sizeof(FontInfo) << endl;
185 InsetMathHull::InsetMathHull(Buffer * buf, HullType type)
186 : InsetMathGrid(buf, getCols(type), 1), type_(type), numbered_(1, NUMBER),
187 numbers_(1, empty_docstring()), label_(1, dummy_pointer),
188 preview_(new RenderPreview(this))
196 InsetMathHull::InsetMathHull(InsetMathHull const & other) : InsetMathGrid(other)
202 InsetMathHull::~InsetMathHull()
204 for (size_t i = 0; i < label_.size(); ++i)
209 Inset * InsetMathHull::clone() const
211 return new InsetMathHull(*this);
215 InsetMathHull & InsetMathHull::operator=(InsetMathHull const & other)
219 InsetMathGrid::operator=(other);
221 numbered_ = other.numbered_;
222 numbers_ = other.numbers_;
223 buffer_ = other.buffer_;
224 for (size_t i = 0; i < label_.size(); ++i)
226 label_ = other.label_;
227 for (size_t i = 0; i != label_.size(); ++i) {
229 label_[i] = new InsetLabel(*label_[i]);
231 preview_.reset(new RenderPreview(*other.preview_, this));
237 void InsetMathHull::setBuffer(Buffer & buffer)
239 InsetMathGrid::setBuffer(buffer);
241 for (size_t i = 0; i != label_.size(); ++i) {
243 label_[i]->setBuffer(buffer);
248 // FIXME This should really be controlled by the TOC level, or
249 // something of the sort.
251 const char * counters_to_save[] = {"section", "chapter"};
252 unsigned int const numcnts = sizeof(counters_to_save)/sizeof(char *);
256 void InsetMathHull::updateBuffer(ParIterator const & it, UpdateType utype)
259 //FIXME: buffer_ should be set at creation for this inset! Problem is
260 // This inset is created at too many places (see Parser::parse1() in
265 // if any of the equations are numbered, then we want to save the values
266 // of some of the counters.
268 BufferParams const & bp = buffer_->params();
269 string const & lang = it->getParLanguage(bp)->code();
271 buffer_->masterBuffer()->params().documentClass().counters();
273 // right now, we only need to do this at export time
274 if (utype == OutputUpdate) {
275 for (size_t i = 0; i < numcnts; ++i) {
276 docstring const cnt = from_ascii(counters_to_save[i]);
277 if (cnts.hasCounter(cnt))
278 counter_map[cnt] = cnts.value(cnt);
282 // this has to be done separately
283 docstring const eqstr = from_ascii("equation");
284 if (cnts.hasCounter(eqstr)) {
285 if (utype == OutputUpdate)
286 counter_map[eqstr] = cnts.value(eqstr);
287 for (size_t i = 0; i != label_.size(); ++i) {
289 cnts.step(eqstr, utype);
290 numbers_[i] = cnts.theCounter(eqstr, lang);
292 numbers_[i] = empty_docstring();
298 for (size_t i = 0; i != label_.size(); ++i) {
300 label_[i]->updateBuffer(it, utype);
303 InsetMathGrid::updateBuffer(it, utype);
307 void InsetMathHull::addToToc(DocIterator const & pit, bool output_active,
308 UpdateType utype) const
311 //FIXME: buffer_ should be set at creation for this inset! Problem is
312 // This inset is created at too many places (see Parser::parse1() in
317 shared_ptr<Toc> toc = buffer().tocBackend().toc("equation");
319 for (row_type row = 0; row != nrows(); ++row) {
323 label_[row]->addToToc(pit, output_active, utype);
324 toc->push_back(TocItem(pit, 0, nicelabel(row), output_active));
329 Inset * InsetMathHull::editXY(Cursor & cur, int x, int y)
331 if (previewState(&cur.bv())) {
335 return InsetMathNest::editXY(cur, x, y);
339 InsetMath::mode_type InsetMathHull::currentMode() const
343 return UNDECIDED_MODE;
345 // definitely math mode ...
365 bool InsetMathHull::idxFirst(Cursor & cur) const
373 bool InsetMathHull::idxLast(Cursor & cur) const
375 cur.idx() = nargs() - 1;
376 cur.pos() = cur.lastpos();
381 // FIXME: InsetMathGrid should be changed to let the real column alignment be
382 // given by a virtual method like displayColAlign, because the values produced
383 // by defaultColAlign can be invalidated by lfuns such as add-column. For the
384 // moment the values produced by defaultColAlign are not used, notably because
385 // alignment is not implemented in the LyXHTML output.
386 char InsetMathHull::defaultColAlign(col_type col)
388 return colAlign(type_, col);
392 char InsetMathHull::displayColAlign(idx_type idx) const
396 row_type const r = row(idx);
399 if (r == nrows() - 1)
410 return colAlign(type_, col(idx));
414 return InsetMathGrid::displayColAlign(idx);
418 int InsetMathHull::displayColSpace(col_type col) const
420 return colSpace(type_, col);
424 // FIXME: same comment as for defaultColAlign applies.
425 int InsetMathHull::defaultColSpace(col_type col)
427 return colSpace(type_, col);
431 string InsetMathHull::standardFont() const
437 return "lyxnochange";
444 ColorCode InsetMathHull::standardColor() const
449 return Color_foreground;
457 bool InsetMathHull::previewState(const BufferView *const bv) const
459 if (!editing(bv) && RenderPreview::previewMath()
460 && type_ != hullRegexp)
462 graphics::PreviewImage const * pimage =
463 preview_->getPreviewImage(bv->buffer());
464 return pimage && pimage->image();
471 static const int ERROR_FRAME_WIDTH = 2;
474 void InsetMathHull::metrics(MetricsInfo & mi, Dimension & dim) const
476 if (previewState(mi.base.bv)) {
477 preview_->metrics(mi, dim);
478 if (previewTooSmall(dim)) {
479 // preview image is too small
480 dim.wid += 2 * ERROR_FRAME_WIDTH;
481 dim.asc += 2 * ERROR_FRAME_WIDTH;
483 // insert a one pixel gap in front of the formula
486 dim.des += displayMargin();
488 // Cache the inset dimension.
489 setDimCache(mi, dim);
493 // FIXME: Changing the same object repeatedly is inefficient.
494 Changer dummy1 = mi.base.changeFontSet(standardFont());
495 Changer dummy2 = mi.base.changeStyle(display() ? LM_ST_DISPLAY : LM_ST_TEXT);
497 // let the cells adjust themselves
498 InsetMathGrid::metrics(mi, dim);
501 dim.asc += displayMargin();
502 dim.des += displayMargin();
505 if (numberedType()) {
506 Changer dummy = mi.base.changeFontSet("mathbf");
508 for (row_type row = 0; row < nrows(); ++row)
509 l = max(l, mathed_string_width(mi.base.font, nicelabel(row)));
515 if (type_ == hullRegexp)
517 // make it at least as high as the current font
520 math_font_max_dim(mi.base.font, asc, des);
521 dim.asc = max(dim.asc, asc);
522 dim.des = max(dim.des, des);
523 // Cache the inset dimension.
524 // FIXME: This will overwrite InsetMathGrid dimension, is that OK?
525 setDimCache(mi, dim);
529 bool InsetMathHull::previewTooSmall(Dimension const & dim) const
531 return dim.width() <= 10 && dim.height() <= 10;
535 ColorCode InsetMathHull::backgroundColor(PainterInfo const & pi) const
537 BufferView const * const bv = pi.base.bv;
538 if (previewState(bv)) {
539 Dimension const dim = dimension(*pi.base.bv);
540 if (previewTooSmall(dim))
542 return graphics::PreviewLoader::backgroundColor();
548 void InsetMathHull::drawBackground(PainterInfo & pi, int x, int y) const
550 Dimension const dim = dimension(*pi.base.bv);
551 if (previewTooSmall(dim)) {
552 pi.pain.fillRectangle(x, y - 2 * ERROR_FRAME_WIDTH,
553 dim.wid, dim.asc + dim.des, backgroundColor(pi));
556 pi.pain.fillRectangle(x + 1, y - dim.asc + 1, dim.wid - 2,
557 dim.asc + dim.des - 1, pi.backgroundColor(this));
561 void InsetMathHull::draw(PainterInfo & pi, int x, int y) const
563 BufferView const * const bv = pi.base.bv;
564 Dimension const dim = dimension(*bv);
566 if (type_ == hullRegexp)
567 pi.pain.rectangle(x + 2, y - dim.ascent() + 1,
568 dim.width() - 3, dim.height() - 2, Color_regexpframe);
570 if (previewState(bv)) {
571 // Do not draw change tracking cue if taken care of by RowPainter
573 Changer dummy = make_change(pi.change_, Change(), !canPaintChange(*bv));
574 if (previewTooSmall(dim)) {
575 // we have an extra frame
576 preview_->draw(pi, x + ERROR_FRAME_WIDTH, y);
578 // one pixel gap in front
579 preview_->draw(pi, x + 1, y);
581 setPosCache(pi, x, y);
585 ColorCode color = pi.selected && lyxrc.use_system_colors
586 ? Color_selectiontext : standardColor();
587 bool const really_change_color = pi.base.font.color() == Color_none;
588 Changer dummy0 = pi.base.font.changeColor(color, really_change_color);
589 Changer dummy1 = pi.base.changeFontSet(standardFont());
590 Changer dummy2 = pi.base.changeStyle(display() ? LM_ST_DISPLAY : LM_ST_TEXT);
592 InsetMathGrid::draw(pi, x + 1, y);
594 if (numberedType()) {
595 int const xx = x + colinfo_.back().offset_ + colinfo_.back().width_ + 20;
596 for (row_type row = 0; row < nrows(); ++row) {
597 int const yy = y + rowinfo_[row].offset_;
598 Changer dummy = pi.base.changeFontSet("mathrm");
599 docstring const nl = nicelabel(row);
603 // drawing change line
604 if (canPaintChange(*bv))
605 pi.change_.paintCue(pi, x + 1, y + 1 - dim.asc,
606 x + dim.wid, y + dim.des);
607 setPosCache(pi, x, y);
611 void InsetMathHull::metricsT(TextMetricsInfo const & mi, Dimension & dim) const
614 InsetMathGrid::metricsT(mi, dim);
617 otexrowstream ots(os);
618 WriteStream wi(ots, false, true, WriteStream::wsDefault);
620 dim.wid = os.str().size();
627 void InsetMathHull::drawT(TextPainter & pain, int x, int y) const
630 InsetMathGrid::drawT(pain, x, y);
633 otexrowstream ots(os);
634 WriteStream wi(ots, false, true, WriteStream::wsDefault);
636 pain.draw(x, y, os.str().c_str());
641 static docstring latexString(InsetMathHull const & inset)
644 // This has to be static, because a preview snippet or a math
645 // macro containing math in text mode (such as $\text{$\phi$}$ or
646 // \newcommand{\xxx}{\text{$\phi$}}) gets processed twice. The
647 // first time as a whole, and the second time only the inner math.
648 // In this last case inset.buffer() would be invalid.
649 static Encoding const * encoding = 0;
650 if (inset.isBufferValid())
651 encoding = &(inset.buffer().params().encoding());
652 otexrowstream ots(ls);
653 WriteStream wi(ots, false, true, WriteStream::wsPreview, encoding);
659 void InsetMathHull::initUnicodeMath() const
661 // Trigger classification of the unicode symbols in this inset
662 docstring const dummy = latexString(*this);
666 void InsetMathHull::addPreview(DocIterator const & inset_pos,
667 graphics::PreviewLoader & /*ploader*/) const
669 if (RenderPreview::previewMath()) {
670 preparePreview(inset_pos);
675 void InsetMathHull::usedMacros(MathData const & md, DocIterator const & pos,
676 MacroNameSet & macros, MacroNameSet & defs) const
678 MacroNameSet::iterator const end = macros.end();
680 for (size_t i = 0; i < md.size(); ++i) {
681 MathMacro const * mi = md[i].nucleus()->asMacro();
682 MathMacroTemplate const * mt = md[i].nucleus()->asMacroTemplate();
683 InsetMathScript const * si = md[i].nucleus()->asScriptInset();
684 InsetMathFracBase const * fi = md[i].nucleus()->asFracBaseInset();
685 InsetMathGrid const * gi = md[i].nucleus()->asGridInset();
686 InsetMathNest const * ni = md[i].nucleus()->asNestInset();
688 // Look for macros in the arguments of this macro.
689 for (idx_type idx = 0; idx < mi->nargs(); ++idx)
690 usedMacros(mi->cell(idx), pos, macros, defs);
691 // Make sure this is a macro defined in the document
692 // (as we also spot the macros in the symbols file)
693 // or that we have not already accounted for it.
694 docstring const name = mi->name();
695 if (macros.find(name) == end)
698 // Look for macros in the definition of this macro.
699 MathData ar(pos.buffer());
700 MacroData const * data =
701 pos.buffer()->getMacro(name, pos, true);
703 odocstringstream macro_def;
704 data->write(macro_def, true);
706 defs.insert(macro_def.str());
707 asArray(data->definition(), ar);
709 usedMacros(ar, pos, macros, defs);
711 MathData ar(pos.buffer());
712 asArray(mt->definition(), ar);
713 usedMacros(ar, pos, macros, defs);
715 if (!si->nuc().empty())
716 usedMacros(si->nuc(), pos, macros, defs);
718 usedMacros(si->down(), pos, macros, defs);
720 usedMacros(si->up(), pos, macros, defs);
721 } else if (fi || gi) {
722 idx_type nidx = fi ? fi->nargs() : gi->nargs();
723 for (idx_type idx = 0; idx < nidx; ++idx)
724 usedMacros(fi ? fi->cell(idx) : gi->cell(idx),
727 usedMacros(ni->cell(0), pos, macros, defs);
733 void InsetMathHull::preparePreview(DocIterator const & pos,
734 bool forexport) const
736 // there is no need to do all the macro stuff if we're not
737 // actually going to generate the preview.
738 if (!RenderPreview::previewMath() && !forexport)
741 Buffer const * buffer = pos.buffer();
743 // collect macros at this position
745 buffer->listMacroNames(macros);
747 // collect definitions only for the macros used in this inset
749 for (idx_type idx = 0; idx < nargs(); ++idx)
750 usedMacros(cell(idx), pos, macros, defs);
752 MacroNameSet::iterator it = defs.begin();
753 MacroNameSet::iterator end = defs.end();
754 docstring macro_preamble;
755 for (; it != end; ++it)
756 macro_preamble.append(*it);
758 // set the font series and size for this snippet
759 DocIterator dit = pos.getInnerText();
760 Paragraph const & par = dit.paragraph();
761 Font font = par.getFontSettings(buffer->params(), dit.pos());
762 font.fontInfo().realize(par.layout().font);
763 string const lsize = font.latexSize();
766 if (font.fontInfo().series() == BOLD_SERIES) {
767 setfont += from_ascii("\\textbf{");
770 if (lsize != "normalsize" && !prefixIs(lsize, "error"))
771 setfont += from_ascii("\\" + lsize + '\n');
774 if (forexport && haveNumbers()) {
775 docstring eqstr = from_ascii("equation");
776 CounterMap::const_iterator it = counter_map.find(eqstr);
777 if (it != counter_map.end()) {
778 int num = it->second;
780 setcnt += from_ascii("\\setcounter{") + eqstr + '}' +
781 '{' + convert<docstring>(num) + '}' + '\n';
783 for (size_t i = 0; i != numcnts; ++i) {
784 docstring cnt = from_ascii(counters_to_save[i]);
785 it = counter_map.find(cnt);
786 if (it == counter_map.end())
788 int num = it->second;
790 setcnt += from_ascii("\\setcounter{") + cnt + '}' +
791 '{' + convert<docstring>(num) + '}';
794 docstring const snippet = macro_preamble + setfont + setcnt
795 + latexString(*this) + endfont;
796 LYXERR(Debug::MACROS, "Preview snippet: " << snippet);
797 preview_->addPreview(snippet, *buffer, forexport);
801 void InsetMathHull::reloadPreview(DocIterator const & pos) const
804 preview_->startLoading(*pos.buffer());
808 void InsetMathHull::loadPreview(DocIterator const & pos) const
810 bool const forexport = true;
811 preparePreview(pos, forexport);
812 preview_->startLoading(*pos.buffer(), forexport);
816 bool InsetMathHull::notifyCursorLeaves(Cursor const & old, Cursor & cur)
818 if (RenderPreview::previewMath()) {
820 cur.screenUpdateFlags(Update::Force);
826 docstring InsetMathHull::label(row_type row) const
828 LASSERT(row < nrows(), return docstring());
829 if (InsetLabel * il = label_[row])
830 return il->screenLabel();
835 void InsetMathHull::label(row_type row, docstring const & label)
837 //lyxerr << "setting label '" << label << "' for row " << row << endl;
841 label_[row] = dummy_pointer;
844 label_[row]->updateLabelAndRefs(label);
846 label_[row]->setParam("name", label);
850 InsetCommandParams p(LABEL_CODE);
852 label_[row] = new InsetLabel(buffer_, p);
854 label_[row]->setBuffer(buffer());
858 void InsetMathHull::numbered(row_type row, Numbered num)
860 numbered_[row] = num;
861 if (!numbered(row) && label_[row]) {
868 bool InsetMathHull::numbered(row_type row) const
870 return numbered_[row] == NUMBER;
874 bool InsetMathHull::ams() const
894 for (size_t row = 0; row < numbered_.size(); ++row)
895 if (numbered_[row] == NOTAG)
901 bool InsetMathHull::outerDisplay() const
924 Inset::DisplayType InsetMathHull::display() const
947 bool InsetMathHull::numberedType() const
966 for (row_type row = 0; row < nrows(); ++row)
973 void InsetMathHull::validate(LaTeXFeatures & features) const
975 if (features.runparams().isLaTeX()) {
977 features.require("amsmath");
979 if (type_ == hullRegexp) {
980 features.require("color");
981 docstring frcol = from_utf8(lcolor.getLaTeXName(Color_regexpframe));
982 docstring bgcol = from_ascii("white");
983 features.addPreambleSnippet(
984 "\\newcommand{\\regexp}[1]{\\fcolorbox{"
986 + bgcol + "}{\\ensuremath{\\mathtt{#1}}}}");
987 features.addPreambleSnippet(
988 from_ascii("\\newcommand{\\endregexp}{}"));
989 } else if (outerDisplay() && features.inDeletedInset()
990 && !features.mustProvide("ct-dvipost")) {
991 features.require("ct-tikz-math-sout");
994 // Validation is necessary only if not using AMS math.
995 // To be safe, we will always run mathedvalidate.
996 //if (features.amsstyle)
999 //features.binom = true;
1000 } else if (features.runparams().math_flavor == OutputParams::MathAsHTML) {
1001 // it would be better to do this elsewhere, but we can't validate in
1002 // InsetMathMatrix and we have no way, outside MathExtern, to know if
1003 // we even have any matrices.
1004 features.addCSSSnippet(
1005 "table.matrix{display: inline-block; vertical-align: middle; text-align:center;}\n"
1006 "table.matrix td{padding: 0.25px;}\n"
1007 "td.ldelim{width: 0.5ex; border: thin solid black; border-right: none;}\n"
1008 "td.rdelim{width: 0.5ex; border: thin solid black; border-left: none;}");
1010 InsetMathGrid::validate(features);
1014 void InsetMathHull::header_write(WriteStream & os) const
1016 bool n = numberedType();
1025 if (cell(0).empty())
1030 if (os.strikeoutMath())
1031 os << "\\lyxmathsout{\\parbox{\\columnwidth}{";
1035 os << "\\begin{equation" << star(n) << "}\n";
1045 if (os.strikeoutMath())
1046 os << "\\lyxmathsout{\\parbox{\\columnwidth}{";
1049 os << "\\begin{" << hullName(type_) << star(n) << "}\n";
1056 os << "\\begin{" << hullName(type_) << star(n) << '}'
1057 << '{' << static_cast<unsigned int>((ncols() + 1)/2) << "}\n";
1063 os << "\\begin{" << hullName(type_) << '}'
1064 << '{' << static_cast<unsigned int>((ncols() + 1)/2) << "}\n";
1074 os << "\\begin{unknown" << star(n) << "}\n";
1080 void InsetMathHull::footer_write(WriteStream & os) const
1082 bool n = numberedType();
1097 os << "\\end{equation" << star(n) << "}\n";
1100 if (os.strikeoutMath())
1111 os << "\\end{" << hullName(type_) << star(n) << "}\n";
1112 if (os.strikeoutMath())
1120 os << "\\end{" << hullName(type_) << star(n) << "}\n";
1126 os << "\\end{" << hullName(type_) << "}\n";
1130 // Only used as a heuristic to find the regexp termination, when searching in ignore-format mode
1131 os << "\\endregexp{}}";
1137 os << "\\end{unknown" << star(n) << "}\n";
1143 bool InsetMathHull::allowsTabularFeatures() const
1166 bool InsetMathHull::rowChangeOK() const
1169 type_ == hullEqnArray || type_ == hullAlign ||
1170 type_ == hullFlAlign || type_ == hullAlignAt ||
1171 type_ == hullXAlignAt || type_ == hullXXAlignAt ||
1172 type_ == hullGather || type_ == hullMultline;
1176 bool InsetMathHull::colChangeOK() const
1179 type_ == hullAlign || type_ == hullFlAlign ||type_ == hullAlignAt ||
1180 type_ == hullXAlignAt || type_ == hullXXAlignAt;
1184 void InsetMathHull::addRow(row_type row)
1189 bool numbered = numberedType();
1190 // Move the number and raw pointer, do not call label() (bug 7511)
1191 InsetLabel * label = dummy_pointer;
1192 docstring number = empty_docstring();
1193 if (type_ == hullMultline) {
1194 if (row + 1 == nrows()) {
1195 numbered_[row] = NONUMBER;
1196 swap(label, label_[row]);
1197 swap(number, numbers_[row]);
1202 numbered_.insert(numbered_.begin() + row + 1, numbered ? NUMBER : NONUMBER);
1203 numbers_.insert(numbers_.begin() + row + 1, number);
1204 label_.insert(label_.begin() + row + 1, label);
1205 InsetMathGrid::addRow(row);
1209 void InsetMathHull::swapRow(row_type row)
1213 if (row + 1 == nrows())
1215 swap(numbered_[row], numbered_[row + 1]);
1216 swap(numbers_[row], numbers_[row + 1]);
1217 swap(label_[row], label_[row + 1]);
1218 InsetMathGrid::swapRow(row);
1222 void InsetMathHull::delRow(row_type row)
1224 if (nrows() <= 1 || !rowChangeOK())
1226 if (row + 1 == nrows() && type_ == hullMultline) {
1227 swap(numbered_[row - 1], numbered_[row]);
1228 swap(numbers_[row - 1], numbers_[row]);
1229 swap(label_[row - 1], label_[row]);
1230 InsetMathGrid::delRow(row);
1233 InsetMathGrid::delRow(row);
1234 // The last dummy row has no number info nor a label.
1235 // Test nrows() + 1 because we have already erased the row.
1236 if (row == nrows() + 1)
1238 numbered_.erase(numbered_.begin() + row);
1239 numbers_.erase(numbers_.begin() + row);
1241 label_.erase(label_.begin() + row);
1245 void InsetMathHull::addCol(col_type col)
1249 InsetMathGrid::addCol(col);
1253 void InsetMathHull::delCol(col_type col)
1255 if (ncols() <= 1 || !colChangeOK())
1257 InsetMathGrid::delCol(col);
1261 docstring InsetMathHull::nicelabel(row_type row) const
1265 docstring const & val = numbers_[row];
1267 return '(' + val + ')';
1268 return '(' + val + ',' + label_[row]->screenLabel() + ')';
1272 void InsetMathHull::glueall(HullType type)
1275 for (idx_type i = 0; i < nargs(); ++i)
1277 InsetLabel * label = 0;
1278 if (type == hullEquation) {
1279 // preserve first non-empty label
1280 for (row_type row = 0; row < nrows(); ++row) {
1282 label = label_[row];
1288 *this = InsetMathHull(buffer_, hullSimple);
1295 void InsetMathHull::splitTo2Cols()
1297 LASSERT(ncols() == 1, return);
1298 InsetMathGrid::addCol(1);
1299 for (row_type row = 0; row < nrows(); ++row) {
1300 idx_type const i = 2 * row;
1301 pos_type pos = firstRelOp(cell(i));
1302 cell(i + 1) = MathData(buffer_, cell(i).begin() + pos, cell(i).end());
1303 cell(i).erase(pos, cell(i).size());
1308 void InsetMathHull::splitTo3Cols()
1310 LASSERT(ncols() < 3, return);
1313 InsetMathGrid::addCol(2);
1314 for (row_type row = 0; row < nrows(); ++row) {
1315 idx_type const i = 3 * row + 1;
1316 if (!cell(i).empty()) {
1317 cell(i + 1) = MathData(buffer_, cell(i).begin() + 1, cell(i).end());
1318 cell(i).erase(1, cell(i).size());
1324 void InsetMathHull::changeCols(col_type cols)
1326 if (ncols() == cols)
1328 else if (ncols() < cols) {
1334 while (ncols() < cols)
1335 InsetMathGrid::addCol(ncols());
1341 for (row_type row = 0; row < nrows(); ++row) {
1342 idx_type const i = row * ncols();
1343 for (col_type col = cols; col < ncols(); ++col) {
1344 cell(i + cols - 1).append(cell(i + col));
1348 while (ncols() > cols) {
1349 InsetMathGrid::delCol(ncols() - 1);
1354 HullType InsetMathHull::getType() const
1360 void InsetMathHull::setType(HullType type)
1367 bool InsetMathHull::isMutable(HullType type)
1391 void InsetMathHull::mutate(HullType newtype)
1393 //lyxerr << "mutating from '" << type_ << "' to '" << newtype << "'" << endl;
1395 if (newtype == type_)
1398 // This guards the algorithm below it, which is designed with certain types
1400 if (!isMutable(newtype) || !isMutable(type_)) {
1401 lyxerr << "mutation from '" << to_utf8(hullName(type_))
1402 << "' to '" << to_utf8(hullName(newtype))
1403 << "' not implemented" << endl;
1407 // we try to move along the chain
1408 // none <-> simple <-> equation <-> eqnarray -> *align* -> multline, gather -+
1410 // +-------------------------------------+
1411 // we use eqnarray as intermediate type for mutations that are not
1412 // directly supported because it handles labels and numbering for
1417 setType(hullSimple);
1423 if (newtype == hullNone) {
1427 setType(hullEquation);
1428 numbered(0, label_[0] ? true : false);
1437 setType(hullSimple);
1442 // split it "nicely" on the first relop
1444 setType(hullEqnArray);
1452 // split it "nicely"
1487 setType(hullEqnArray);
1496 for (row_type row = 0; row < nrows(); ++row)
1497 numbered(row, false);
1507 for (row_type row = 0; row < nrows(); ++row)
1508 numbered(row, false);
1515 setType(hullEqnArray);
1545 for (row_type row = 0; row < nrows(); ++row)
1546 numbered(row, false);
1550 // first we mutate to EqnArray
1552 setType(hullEqnArray);
1559 // we passed the guard so we should not be here
1560 LASSERT("Mutation not implemented, but should have been.", return);
1566 docstring InsetMathHull::eolString(row_type row, bool fragile, bool latex,
1567 bool last_eoln) const
1570 if (numberedType()) {
1571 if (label_[row] && numbered(row)) {
1572 docstring const name =
1573 latex ? escape(label_[row]->getParam("name"))
1574 : label_[row]->getParam("name");
1575 res += "\\label{" + name + '}';
1577 if (type_ != hullMultline) {
1578 if (numbered_[row] == NONUMBER)
1579 res += "\\nonumber ";
1580 else if (numbered_[row] == NOTAG)
1584 // Never add \\ on the last empty line of eqnarray and friends
1586 return res + InsetMathGrid::eolString(row, fragile, latex, last_eoln);
1589 void InsetMathHull::write(WriteStream & os) const
1591 ModeSpecifier specifier(os, MATH_MODE);
1593 InsetMathGrid::write(os);
1598 void InsetMathHull::normalize(NormalStream & os) const
1600 os << "[formula " << hullName(type_) << ' ';
1601 InsetMathGrid::normalize(os);
1606 void InsetMathHull::infoize(odocstream & os) const
1608 os << bformat(_("Type: %1$s"), hullName(type_));
1612 void InsetMathHull::check() const
1614 LATTEST(numbered_.size() == nrows());
1615 LATTEST(numbers_.size() == nrows());
1616 LATTEST(label_.size() == nrows());
1620 void InsetMathHull::doExtern(Cursor & cur, FuncRequest & func)
1624 idocstringstream iss(func.argument());
1625 iss >> dlang >> extra;
1627 extra = from_ascii("noextra");
1628 string const lang = to_ascii(dlang);
1630 // replace selection with result of computation
1631 if (reduceSelectionToOneCell(cur)) {
1633 asArray(grabAndEraseSelection(cur), ar);
1634 lyxerr << "use selection: " << ar << endl;
1635 cur.insert(pipeThroughExtern(lang, extra, ar));
1639 // only inline, display or eqnarray math is allowed
1640 switch (getType()) {
1646 frontend::Alert::warning(_("Bad math environment"),
1647 _("Computation cannot be performed for AMS "
1648 "math environments.\nChange the math "
1649 "formula type and try again."));
1654 eq.push_back(MathAtom(new InsetMathChar('=')));
1656 // go to first item in line
1657 cur.idx() -= cur.idx() % ncols();
1660 if (getType() == hullSimple) {
1661 size_type pos = cur.cell().find_last(eq);
1663 if (pos == cur.cell().size()) {
1665 lyxerr << "use whole cell: " << ar << endl;
1667 ar = MathData(buffer_, cur.cell().begin() + pos + 1, cur.cell().end());
1668 lyxerr << "use partial cell form pos: " << pos << endl;
1670 cur.cell().append(eq);
1671 cur.cell().append(pipeThroughExtern(lang, extra, ar));
1672 cur.pos() = cur.lastpos();
1676 if (getType() == hullEquation) {
1677 lyxerr << "use equation inset" << endl;
1678 mutate(hullEqnArray);
1679 MathData & ar = cur.cell();
1680 lyxerr << "use cell: " << ar << endl;
1684 cur.cell() = pipeThroughExtern(lang, extra, ar);
1685 // move to end of line
1686 cur.pos() = cur.lastpos();
1691 lyxerr << "use eqnarray" << endl;
1692 cur.idx() += 2 - cur.idx() % ncols();
1694 MathData ar = cur.cell();
1695 lyxerr << "use cell: " << ar << endl;
1696 // FIXME: temporarily disabled
1702 cur.cell() = pipeThroughExtern(lang, extra, ar);
1703 cur.pos() = cur.lastpos();
1708 void InsetMathHull::doDispatch(Cursor & cur, FuncRequest & cmd)
1710 //lyxerr << "action: " << cmd.action() << endl;
1711 switch (cmd.action()) {
1713 case LFUN_FINISHED_BACKWARD:
1714 case LFUN_FINISHED_FORWARD:
1715 case LFUN_FINISHED_RIGHT:
1716 case LFUN_FINISHED_LEFT:
1717 //lyxerr << "action: " << cmd.action() << endl;
1718 InsetMathGrid::doDispatch(cur, cmd);
1721 case LFUN_PARAGRAPH_BREAK:
1722 // just swallow this
1725 case LFUN_NEWLINE_INSERT:
1726 // some magic for the common case
1727 if (type_ == hullSimple || type_ == hullEquation) {
1728 cur.recordUndoInset();
1730 cur.bv().buffer().params().use_package("amsmath") != BufferParams::package_off;
1731 mutate(align ? hullAlign : hullEqnArray);
1732 // mutate() may change labels and such.
1733 cur.forceBufferUpdate();
1734 cur.idx() = nrows() * ncols() - 1;
1735 cur.pos() = cur.lastpos();
1737 InsetMathGrid::doDispatch(cur, cmd);
1740 case LFUN_MATH_NUMBER_TOGGLE: {
1741 //lyxerr << "toggling all numbers" << endl;
1742 cur.recordUndoInset();
1743 bool old = numberedType();
1744 if (type_ == hullMultline)
1745 numbered(nrows() - 1, !old);
1747 for (row_type row = 0; row < nrows(); ++row)
1748 numbered(row, !old);
1750 cur.message(old ? _("No number") : _("Number"));
1751 cur.forceBufferUpdate();
1755 case LFUN_MATH_NUMBER_LINE_TOGGLE: {
1756 cur.recordUndoInset();
1757 row_type r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1758 bool old = numbered(r);
1759 cur.message(old ? _("No number") : _("Number"));
1761 cur.forceBufferUpdate();
1765 case LFUN_LABEL_INSERT: {
1766 row_type r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1767 docstring old_label = label(r);
1768 docstring const default_label = from_ascii("eq:");
1769 if (old_label.empty())
1770 old_label = default_label;
1772 InsetCommandParams p(LABEL_CODE);
1773 p["name"] = cmd.argument().empty() ? old_label : cmd.argument();
1774 string const data = InsetCommand::params2string(p);
1776 if (cmd.argument().empty())
1777 cur.bv().showDialog("label", data);
1779 FuncRequest fr(LFUN_INSET_INSERT, data);
1785 case LFUN_LABEL_COPY_AS_REFERENCE: {
1787 if (cmd.argument().empty() && &cur.inset() == this)
1788 // if there is no argument and we're inside math, we retrieve
1789 // the row number from the cursor position.
1790 row = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1792 // if there is an argument, find the corresponding label, else
1793 // check whether there is at least one label.
1794 for (row = 0; row != nrows(); ++row)
1795 if (numbered(row) && label_[row]
1796 && (cmd.argument().empty() || label(row) == cmd.argument()))
1803 InsetCommandParams p(REF_CODE, "ref");
1804 p["reference"] = label(row);
1805 cap::clearSelection();
1806 cap::copyInset(cur, new InsetRef(buffer_, p), label(row));
1810 case LFUN_WORD_DELETE_FORWARD:
1811 case LFUN_CHAR_DELETE_FORWARD:
1812 if (col(cur.idx()) + 1 == ncols()
1813 && cur.pos() == cur.lastpos()
1814 && !cur.selection()) {
1815 if (!label(row(cur.idx())).empty()) {
1816 cur.recordUndoInset();
1817 label(row(cur.idx()), docstring());
1818 } else if (numbered(row(cur.idx()))) {
1819 cur.recordUndoInset();
1820 numbered(row(cur.idx()), false);
1821 cur.forceBufferUpdate();
1823 InsetMathGrid::doDispatch(cur, cmd);
1827 InsetMathGrid::doDispatch(cur, cmd);
1832 case LFUN_INSET_INSERT: {
1833 //lyxerr << "arg: " << to_utf8(cmd.argument()) << endl;
1834 // FIXME: this should be cleaned up to use InsetLabel methods directly.
1835 string const name = cmd.getArg(0);
1836 if (name == "label") {
1837 InsetCommandParams p(LABEL_CODE);
1838 InsetCommand::string2params(to_utf8(cmd.argument()), p);
1839 docstring str = p["name"];
1840 cur.recordUndoInset();
1841 row_type const r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1845 docstring old = label(r);
1848 // The label will take care of the reference update.
1852 // Newly created inset so initialize it.
1853 label_[r]->initView();
1856 cur.forceBufferUpdate();
1859 InsetMathGrid::doDispatch(cur, cmd);
1863 case LFUN_MATH_EXTERN:
1864 cur.recordUndoInset();
1868 case LFUN_MATH_MUTATE: {
1869 cur.recordUndoInset();
1870 row_type row = cur.row();
1871 col_type col = cur.col();
1872 mutate(hullType(cmd.argument()));
1873 cur.idx() = row * ncols() + col;
1874 if (cur.idx() > cur.lastidx()) {
1875 cur.idx() = cur.lastidx();
1876 cur.pos() = cur.lastpos();
1878 if (cur.pos() > cur.lastpos())
1879 cur.pos() = cur.lastpos();
1881 cur.forceBufferUpdate();
1882 // FIXME: find some more clever handling of the selection,
1883 // i.e. preserve it.
1884 cur.clearSelection();
1885 //cur.dispatched(FINISHED);
1889 case LFUN_MATH_DISPLAY: {
1890 cur.recordUndoInset();
1891 mutate(type_ == hullSimple ? hullEquation : hullSimple);
1892 // if the cursor is in a cell that got merged, move it to
1893 // start of the hull inset.
1894 if (cur.idx() > 0) {
1898 if (cur.pos() > cur.lastpos())
1899 cur.pos() = cur.lastpos();
1904 case LFUN_TABULAR_FEATURE:
1905 if (!allowsTabularFeatures())
1908 InsetMathGrid::doDispatch(cur, cmd);
1912 InsetMathGrid::doDispatch(cur, cmd);
1920 bool allowDisplayMath(Cursor const & cur)
1922 LATTEST(cur.depth() > 1);
1923 Cursor tmpcur = cur;
1926 FuncRequest cmd(LFUN_MATH_DISPLAY);
1927 return tmpcur.getStatus(cmd, status) && status.enabled();
1933 bool InsetMathHull::getStatus(Cursor & cur, FuncRequest const & cmd,
1934 FuncStatus & status) const
1936 switch (cmd.action()) {
1937 case LFUN_FINISHED_BACKWARD:
1938 case LFUN_FINISHED_FORWARD:
1939 case LFUN_FINISHED_RIGHT:
1940 case LFUN_FINISHED_LEFT:
1943 case LFUN_NEWLINE_INSERT:
1944 case LFUN_MATH_EXTERN:
1946 status.setEnabled(true);
1949 // we never allow this in math, and we want to bind enter
1950 // to another actions in command-alternatives
1951 case LFUN_PARAGRAPH_BREAK:
1952 status.setEnabled(false);
1954 case LFUN_MATH_MUTATE: {
1955 HullType const ht = hullType(cmd.argument());
1956 status.setOnOff(type_ == ht);
1957 status.setEnabled(isMutable(ht) && isMutable(type_));
1959 if (ht != hullSimple && status.enabled())
1960 status.setEnabled(allowDisplayMath(cur));
1963 case LFUN_MATH_DISPLAY: {
1964 status.setEnabled(display() != Inline || allowDisplayMath(cur));
1965 status.setOnOff(display() != Inline);
1969 case LFUN_MATH_NUMBER_TOGGLE:
1970 // FIXME: what is the right test, this or the one of
1972 status.setEnabled(display() != Inline);
1973 status.setOnOff(numberedType());
1976 case LFUN_MATH_NUMBER_LINE_TOGGLE: {
1977 // FIXME: what is the right test, this or the one of
1979 bool const enable = (type_ == hullMultline)
1980 ? (nrows() - 1 == cur.row())
1981 : display() != Inline;
1982 row_type const r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1983 status.setEnabled(enable);
1984 status.setOnOff(enable && numbered(r));
1988 case LFUN_LABEL_INSERT:
1989 status.setEnabled(type_ != hullSimple);
1992 case LFUN_LABEL_COPY_AS_REFERENCE: {
1993 bool enabled = false;
1995 if (cmd.argument().empty() && &cur.inset() == this) {
1996 // if there is no argument and we're inside math, we retrieve
1997 // the row number from the cursor position.
1998 row = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1999 enabled = numberedType() && label_[row] && numbered(row);
2001 // if there is an argument, find the corresponding label, else
2002 // check whether there is at least one label.
2003 for (row_type row = 0; row != nrows(); ++row) {
2004 if (numbered(row) && label_[row] &&
2005 (cmd.argument().empty() || label(row) == cmd.argument())) {
2011 status.setEnabled(enabled);
2015 case LFUN_INSET_INSERT:
2016 if (cmd.getArg(0) == "label") {
2017 status.setEnabled(type_ != hullSimple);
2020 return InsetMathGrid::getStatus(cur, cmd, status);
2022 case LFUN_TABULAR_FEATURE: {
2023 if (!allowsTabularFeatures())
2025 string s = cmd.getArg(0);
2027 && (s == "append-row"
2028 || s == "delete-row"
2029 || s == "copy-row")) {
2030 status.message(bformat(
2031 from_utf8(N_("Can't change number of rows in '%1$s'")),
2033 status.setEnabled(false);
2037 && (s == "append-column"
2038 || s == "delete-column"
2039 || s == "copy-column")) {
2040 status.message(bformat(
2041 from_utf8(N_("Can't change number of columns in '%1$s'")),
2043 status.setEnabled(false);
2046 if (s == "add-vline-left" || s == "add-vline-right") {
2047 status.message(bformat(
2048 from_utf8(N_("Can't add vertical grid lines in '%1$s'")),
2050 status.setEnabled(false);
2053 if (s == "valign-top" || s == "valign-middle"
2054 || s == "valign-bottom" || s == "align-left"
2055 || s == "align-center" || s == "align-right") {
2056 status.setEnabled(false);
2059 return InsetMathGrid::getStatus(cur, cmd, status);
2063 return InsetMathGrid::getStatus(cur, cmd, status);
2066 // This cannot really happen, but inserted to shut-up gcc
2067 return InsetMathGrid::getStatus(cur, cmd, status);
2071 /////////////////////////////////////////////////////////////////////
2075 // simply scrap this function if you want
2076 void InsetMathHull::mutateToText()
2079 // translate to latex
2081 latex(os, false, false);
2082 string str = os.str();
2085 Text * lt = view_->cursor().innerText();
2086 string::const_iterator cit = str.begin();
2087 string::const_iterator end = str.end();
2088 for (; cit != end; ++cit)
2089 view_->getIntl()->getTransManager().TranslateAndInsert(*cit, lt);
2092 //dispatch(LFUN_ESCAPE);
2097 void InsetMathHull::handleFont(Cursor & cur, docstring const & arg,
2098 docstring const & font)
2100 // this whole function is a hack and won't work for incremental font
2103 if (cur.inset().asInsetMath()->name() == font)
2104 cur.handleFont(to_utf8(font));
2106 cur.handleNest(createInsetMath(font, cur.buffer()));
2112 void InsetMathHull::handleFont2(Cursor & cur, docstring const & arg)
2117 font.fromString(to_utf8(arg), b);
2118 if (font.fontInfo().color() != Color_inherit) {
2119 MathAtom at = MathAtom(new InsetMathColor(buffer_, true, font.fontInfo().color()));
2120 cur.handleNest(at, 0);
2125 void InsetMathHull::edit(Cursor & cur, bool front, EntryDirection entry_from)
2128 bool enter_front = (entry_from == Inset::ENTRY_DIRECTION_LEFT ||
2129 (entry_from == Inset::ENTRY_DIRECTION_IGNORE && front));
2130 enter_front ? idxFirst(cur) : idxLast(cur);
2131 // The inset formula dimension is not necessarily the same as the
2132 // one of the instant preview image, so we have to indicate to the
2133 // BufferView that a metrics update is needed.
2134 cur.screenUpdateFlags(Update::Force);
2138 void InsetMathHull::revealCodes(Cursor & cur) const
2140 if (!cur.inMathed())
2142 odocstringstream os;
2144 cur.message(os.str());
2146 // write something to the minibuffer
2147 // translate to latex
2151 string str = os.str();
2153 string::size_type pos = 0;
2155 for (string::iterator it = str.begin(); it != str.end(); ++it) {
2158 else if (*it == '\0') {
2160 pos = it - str.begin();
2166 res = res.substr(pos - 30);
2167 if (res.size() > 60)
2168 res = res.substr(0, 60);
2174 /////////////////////////////////////////////////////////////////////
2178 bool InsetMathHull::searchForward(BufferView * bv, string const & str,
2181 // FIXME: completely broken
2182 static InsetMathHull * lastformula = 0;
2183 static CursorBase current = DocIterator(ibegin(nucleus()));
2185 static string laststr;
2187 if (lastformula != this || laststr != str) {
2188 //lyxerr << "reset lastformula to " << this << endl;
2191 current = ibegin(nucleus());
2193 mathed_parse_cell(ar, str, Parse::NORMAL, &buffer());
2197 //lyxerr << "searching '" << str << "' in " << this << ar << endl;
2199 for (DocIterator it = current; it != iend(nucleus()); increment(it)) {
2200 CursorSlice & top = it.back();
2201 MathData const & a = top.asInsetMath()->cell(top.idx_);
2202 if (a.matchpart(ar, top.pos_)) {
2203 bv->cursor().setSelection(it, ar.size());
2205 top.pos_ += ar.size();
2211 //lyxerr << "not found!" << endl;
2218 void InsetMathHull::write(ostream & os) const
2220 odocstringstream oss;
2221 otexrowstream ots(oss);
2222 WriteStream wi(ots, false, false, WriteStream::wsDefault);
2225 os << to_utf8(oss.str());
2229 void InsetMathHull::read(Lexer & lex)
2232 mathed_parse_normal(buffer_, at, lex, Parse::TRACKMACRO);
2233 operator=(*at->asHullInset());
2237 bool InsetMathHull::readQuiet(Lexer & lex)
2240 bool success = mathed_parse_normal(buffer_, at, lex, Parse::QUIET);
2242 operator=(*at->asHullInset());
2247 int InsetMathHull::plaintext(odocstringstream & os,
2248 OutputParams const & op, size_t max_length) const
2250 // disables ASCII-art for export of equations. See #2275.
2251 if (0 && display()) {
2255 TextPainter tpain(dim.width(), dim.height());
2256 drawT(tpain, 0, dim.ascent());
2258 // reset metrics cache to "real" values
2260 return tpain.textheight();
2263 odocstringstream oss;
2264 otexrowstream ots(oss);
2265 Encoding const * const enc = encodings.fromLyXName("utf8");
2266 WriteStream wi(ots, false, true, WriteStream::wsDefault, enc);
2269 if (type_ == hullRegexp)
2272 for (row_type r = 0; r < nrows(); ++r) {
2273 for (col_type c = 0; c < ncols(); ++c)
2274 wi << (c == 0 ? "" : "\t") << cell(index(r, c));
2275 // if it's for the TOC, we write just the first line
2276 // and do not include the newline.
2277 if (op.for_toc || op.for_tooltip || oss.str().size() >= max_length)
2279 if (r < nrows() - 1)
2283 docstring const str = oss.str();
2289 int InsetMathHull::docbook(odocstream & os, OutputParams const & runparams) const
2294 if (getType() == hullSimple)
2295 name = from_ascii("inlineequation");
2297 name = from_ascii("informalequation");
2299 docstring bname = name;
2300 if (!label(0).empty())
2301 bname += " id='" + sgml::cleanID(buffer(), runparams, label(0)) + "'";
2303 ++ms.tab(); ms.cr(); ms.os() << '<' << bname << '>';
2305 odocstringstream ls;
2307 if (runparams.flavor == OutputParams::XML) {
2308 ms << MTag("alt role='tex' ");
2309 // Workaround for db2latex: db2latex always includes equations with
2310 // \ensuremath{} or \begin{display}\end{display}
2311 // so we strip LyX' math environment
2312 WriteStream wi(ols, false, false, WriteStream::wsDefault, runparams.encoding);
2313 InsetMathGrid::write(wi);
2314 ms << from_utf8(subst(subst(to_utf8(ls.str()), "&", "&"), "<", "<"));
2319 InsetMathGrid::mathmlize(ms);
2322 ms << MTag("alt role='tex'");
2323 latex(ols, runparams);
2324 res = ols.texrow().rows();
2325 ms << from_utf8(subst(subst(to_utf8(ls.str()), "&", "&"), "<", "<"));
2329 ms << from_ascii("<graphic fileref=\"eqn/");
2330 if (!label(0).empty())
2331 ms << sgml::cleanID(buffer(), runparams, label(0));
2333 ms << sgml::uniqueID(from_ascii("anon"));
2335 if (runparams.flavor == OutputParams::XML)
2336 ms << from_ascii("\"/>");
2338 ms << from_ascii("\">");
2340 ms.cr(); --ms.tab(); ms.os() << "</" << name << '>';
2342 return ms.line() + res;
2346 bool InsetMathHull::haveNumbers() const
2348 bool havenumbers = false;
2349 // inline formulas are never numbered (bug 7351 part 3)
2350 if (getType() == hullSimple)
2352 for (size_t i = 0; i != numbered_.size(); ++i) {
2363 // We need to do something about alignment here.
2365 // This duplicates code from InsetMathGrid, but
2366 // we need access here to number information,
2367 // and we simply do not have that in InsetMathGrid.
2368 void InsetMathHull::htmlize(HtmlStream & os) const
2370 bool const havenumbers = haveNumbers();
2371 bool const havetable = havenumbers || nrows() > 1 || ncols() > 1;
2374 os << cell(index(0, 0));
2378 os << MTag("table", "class='mathtable'");
2379 for (row_type row = 0; row < nrows(); ++row) {
2381 for (col_type col = 0; col < ncols(); ++col) {
2383 os << cell(index(row, col));
2388 docstring const & num = numbers_[row];
2390 os << '(' << num << ')';
2395 os << ETag("table");
2399 // this duplicates code from InsetMathGrid, but
2400 // we need access here to number information,
2401 // and we simply do not have that in InsetMathGrid.
2402 void InsetMathHull::mathmlize(MathStream & os) const
2404 bool const havenumbers = haveNumbers();
2405 bool const havetable = havenumbers || nrows() > 1 || ncols() > 1;
2408 os << MTag("mtable");
2409 char const * const celltag = havetable ? "mtd" : "mrow";
2410 // FIXME There does not seem to be wide support at the moment
2411 // for mlabeledtr, so we have to use just mtr for now.
2412 // char const * const rowtag = havenumbers ? "mlabeledtr" : "mtr";
2413 char const * const rowtag = "mtr";
2414 for (row_type row = 0; row < nrows(); ++row) {
2417 for (col_type col = 0; col < ncols(); ++col) {
2419 << cell(index(row, col))
2425 docstring const & num = numbers_[row];
2427 os << '(' << num << ')';
2434 os << ETag("mtable");
2438 void InsetMathHull::mathAsLatex(WriteStream & os) const
2440 MathEnsurer ensurer(os, false);
2441 bool havenumbers = haveNumbers();
2442 bool const havetable = havenumbers || nrows() > 1 || ncols() > 1;
2445 os << cell(index(0, 0));
2449 os << "<table class='mathtable'>";
2450 for (row_type row = 0; row < nrows(); ++row) {
2452 for (col_type col = 0; col < ncols(); ++col) {
2453 os << "<td class='math'>";
2454 os << cell(index(row, col));
2459 docstring const & num = numbers_[row];
2461 os << '(' << num << ')';
2470 docstring InsetMathHull::xhtml(XHTMLStream & xs, OutputParams const & op) const
2472 BufferParams::MathOutput const mathtype =
2473 buffer().masterBuffer()->params().html_math_output;
2475 bool success = false;
2477 // we output all the labels just at the beginning of the equation.
2478 // this should be fine.
2479 for (size_t i = 0; i != label_.size(); ++i) {
2480 InsetLabel const * const il = label_[i];
2486 // FIXME Eventually we would like to do this inset by inset.
2487 if (mathtype == BufferParams::MathML) {
2488 odocstringstream os;
2493 } catch (MathExportException const &) {}
2495 if (getType() == hullSimple)
2496 xs << html::StartTag("math",
2497 "xmlns=\"http://www.w3.org/1998/Math/MathML\"", true);
2499 xs << html::StartTag("math",
2500 "display=\"block\" xmlns=\"http://www.w3.org/1998/Math/MathML\"", true);
2501 xs << XHTMLStream::ESCAPE_NONE
2503 << html::EndTag("math");
2505 } else if (mathtype == BufferParams::HTML) {
2506 odocstringstream os;
2511 } catch (MathExportException const &) {}
2513 string const tag = (getType() == hullSimple) ? "span" : "div";
2514 xs << html::StartTag(tag, "class='formula'", true)
2515 << XHTMLStream::ESCAPE_NONE
2517 << html::EndTag(tag);
2521 // what we actually want is this:
2523 // ((mathtype == BufferParams::MathML || mathtype == BufferParams::HTML)
2525 // || mathtype == BufferParams::Images
2527 // but what follows is equivalent, since we'll enter only if either (a) we
2528 // tried and failed with MathML or HTML or (b) didn't try yet at all but
2529 // aren't doing LaTeX.
2531 // so this is for Images.
2532 if (!success && mathtype != BufferParams::LaTeX) {
2533 graphics::PreviewImage const * pimage = 0;
2535 loadPreview(docit_);
2536 pimage = preview_->getPreviewImage(buffer());
2537 // FIXME Do we always have png?
2540 if (pimage || op.dryrun) {
2541 string const filename = pimage ? pimage->filename().onlyFileName()
2542 : "previewimage.png";
2544 // if we are not in the master buffer, then we need to see that the
2545 // generated image is copied there; otherwise, preview fails.
2546 Buffer const * mbuf = buffer().masterBuffer();
2547 if (mbuf != &buffer()) {
2548 string mbtmp = mbuf->temppath();
2549 FileName const mbufimg(support::addName(mbtmp, filename));
2550 pimage->filename().copyTo(mbufimg);
2552 // add the file to the list of files to be exported
2553 op.exportdata->addExternalFile("xhtml", pimage->filename());
2556 string const tag = (getType() == hullSimple) ? "span" : "div";
2558 << html::StartTag(tag, "style = \"text-align: center;\"")
2559 << html::CompTag("img", "src=\"" + filename + "\" alt=\"Mathematical Equation\"")
2560 << html::EndTag(tag)
2566 // so we'll pass this test if we've failed everything else, or
2567 // if mathtype was LaTeX, since we won't have entered any of the
2569 if (!success /* || mathtype != BufferParams::LaTeX */) {
2570 // Unfortunately, we cannot use latexString() because we do not want
2571 // $...$ or whatever.
2572 odocstringstream ls;
2573 otexrowstream ots(ls);
2574 WriteStream wi(ots, false, true, WriteStream::wsPreview);
2575 ModeSpecifier specifier(wi, MATH_MODE);
2577 docstring const latex = ls.str();
2579 // class='math' allows for use of jsMath
2580 // http://www.math.union.edu/~dpvc/jsMath/
2582 // probably should allow for some kind of customization here
2583 string const tag = (getType() == hullSimple) ? "span" : "div";
2584 xs << html::StartTag(tag, "class='math'")
2586 << html::EndTag(tag)
2593 void InsetMathHull::toString(odocstream & os) const
2595 odocstringstream ods;
2596 plaintext(ods, OutputParams(0));
2601 void InsetMathHull::forOutliner(docstring & os, size_t const, bool const) const
2603 odocstringstream ods;
2606 // FIXME: this results in spilling TeX into the LyXHTML output since the
2607 // outliner is used to generate the LyXHTML list of figures/etc.
2613 string InsetMathHull::contextMenuName() const
2615 return "context-math";
2619 void InsetMathHull::recordLocation(DocIterator const & di)
2625 bool InsetMathHull::canPaintChange(BufferView const &) const
2627 // We let RowPainter do it seamlessly for inline insets
2628 return display() != Inline;