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 "InsetMathNest.h"
19 #include "InsetMathScript.h"
20 #include "MathExtern.h"
21 #include "MathFactory.h"
22 #include "MathStream.h"
23 #include "MathSupport.h"
26 #include "BufferParams.h"
27 #include "BufferView.h"
29 #include "CutAndPaste.h"
32 #include "FuncRequest.h"
33 #include "FuncStatus.h"
35 #include "LaTeXFeatures.h"
37 #include "MacroTable.h"
38 #include "MathMacro.h"
39 #include "MathMacroTemplate.h"
40 #include "MetricsInfo.h"
41 #include "output_xhtml.h"
42 #include "Paragraph.h"
43 #include "ParIterator.h"
46 #include "TextClass.h"
47 #include "TextPainter.h"
48 #include "TocBackend.h"
50 #include "insets/InsetLabel.h"
51 #include "insets/InsetRef.h"
52 #include "insets/RenderPreview.h"
54 #include "graphics/GraphicsImage.h"
55 #include "graphics/PreviewImage.h"
56 #include "graphics/PreviewLoader.h"
58 #include "frontends/alert.h"
59 #include "frontends/Painter.h"
61 #include "support/convert.h"
62 #include "support/debug.h"
63 #include "support/gettext.h"
64 #include "support/filetools.h"
65 #include "support/lassert.h"
66 #include "support/lstrings.h"
67 #include "support/RefChanger.h"
72 using namespace lyx::support;
76 using cap::grabAndEraseSelection;
77 using cap::reduceSelectionToOneCell;
81 int getCols(HullType type)
106 // returns position of first relation operator in the array
107 // used for "intelligent splitting"
108 size_t firstRelOp(MathData const & ar)
110 for (MathData::const_iterator it = ar.begin(); it != ar.end(); ++it)
111 if ((*it)->mathClass() == MC_REL)
112 return it - ar.begin();
117 char const * star(bool numbered)
119 return numbered ? "" : "*";
123 // writes a preamble for underlined or struck out math display
124 void writeMathdisplayPreamble(WriteStream & os)
126 if (os.strikeoutMath()) {
127 if (os.ulemCmd() == WriteStream::UNDERLINE)
128 os << "\\raisebox{-\\belowdisplayshortskip}{"
129 "\\lyxmathsout{\\parbox[b]{\\columnwidth}{";
131 os << "\\lyxmathsout{\\parbox{\\columnwidth}{";
132 } else if (os.ulemCmd() == WriteStream::UNDERLINE)
133 os << "\\raisebox{-\\belowdisplayshortskip}{"
134 "\\parbox[b]{\\columnwidth}{";
135 else if (os.ulemCmd() == WriteStream::STRIKEOUT)
136 os << "\\parbox{\\columnwidth}{";
140 // writes a postamble for underlined or struck out math display
141 void writeMathdisplayPostamble(WriteStream & os)
143 if (os.strikeoutMath()) {
144 if (os.ulemCmd() == WriteStream::UNDERLINE)
147 } else if (os.ulemCmd() == WriteStream::UNDERLINE)
149 else if (os.ulemCmd() == WriteStream::STRIKEOUT)
154 } // end anon namespace
157 HullType hullType(docstring const & s)
159 if (s == "none") return hullNone;
160 if (s == "simple") return hullSimple;
161 if (s == "equation") return hullEquation;
162 if (s == "eqnarray") return hullEqnArray;
163 if (s == "align") return hullAlign;
164 if (s == "alignat") return hullAlignAt;
165 if (s == "xalignat") return hullXAlignAt;
166 if (s == "xxalignat") return hullXXAlignAt;
167 if (s == "multline") return hullMultline;
168 if (s == "gather") return hullGather;
169 if (s == "flalign") return hullFlAlign;
170 if (s == "regexp") return hullRegexp;
171 lyxerr << "unknown hull type '" << to_utf8(s) << "'" << endl;
176 docstring hullName(HullType type)
179 case hullNone: return from_ascii("none");
180 case hullSimple: return from_ascii("simple");
181 case hullEquation: return from_ascii("equation");
182 case hullEqnArray: return from_ascii("eqnarray");
183 case hullAlign: return from_ascii("align");
184 case hullAlignAt: return from_ascii("alignat");
185 case hullXAlignAt: return from_ascii("xalignat");
186 case hullXXAlignAt: return from_ascii("xxalignat");
187 case hullMultline: return from_ascii("multline");
188 case hullGather: return from_ascii("gather");
189 case hullFlAlign: return from_ascii("flalign");
190 case hullRegexp: return from_ascii("regexp");
192 lyxerr << "unknown hull type" << endl;
195 return from_ascii("none");
198 static InsetLabel * dummy_pointer = 0;
200 InsetMathHull::InsetMathHull(Buffer * buf)
201 : InsetMathGrid(buf, 1, 1), type_(hullNone), numbered_(1, NUMBER),
202 numbers_(1, empty_docstring()), label_(1, dummy_pointer),
203 preview_(new RenderPreview(this))
205 //lyxerr << "sizeof InsetMath: " << sizeof(InsetMath) << endl;
206 //lyxerr << "sizeof MetricsInfo: " << sizeof(MetricsInfo) << endl;
207 //lyxerr << "sizeof InsetMathChar: " << sizeof(InsetMathChar) << endl;
208 //lyxerr << "sizeof FontInfo: " << sizeof(FontInfo) << endl;
215 InsetMathHull::InsetMathHull(Buffer * buf, HullType type)
216 : InsetMathGrid(buf, getCols(type), 1), type_(type), numbered_(1, NUMBER),
217 numbers_(1, empty_docstring()), label_(1, dummy_pointer),
218 preview_(new RenderPreview(this))
226 InsetMathHull::InsetMathHull(InsetMathHull const & other) : InsetMathGrid(other)
232 InsetMathHull::~InsetMathHull()
234 for (size_t i = 0; i < label_.size(); ++i)
239 Inset * InsetMathHull::clone() const
241 return new InsetMathHull(*this);
245 InsetMathHull & InsetMathHull::operator=(InsetMathHull const & other)
249 InsetMathGrid::operator=(other);
251 numbered_ = other.numbered_;
252 numbers_ = other.numbers_;
253 buffer_ = other.buffer_;
254 for (size_t i = 0; i < label_.size(); ++i)
256 label_ = other.label_;
257 for (size_t i = 0; i != label_.size(); ++i) {
259 label_[i] = new InsetLabel(*label_[i]);
261 preview_.reset(new RenderPreview(*other.preview_, this));
267 void InsetMathHull::setBuffer(Buffer & buffer)
269 InsetMathGrid::setBuffer(buffer);
271 for (size_t i = 0; i != label_.size(); ++i) {
273 label_[i]->setBuffer(buffer);
278 // FIXME This should really be controlled by the TOC level, or
279 // something of the sort.
281 const char * counters_to_save[] = {"section", "chapter"};
282 unsigned int const numcnts = sizeof(counters_to_save)/sizeof(char *);
286 void InsetMathHull::updateBuffer(ParIterator const & it, UpdateType utype)
289 //FIXME: buffer_ should be set at creation for this inset! Problem is
290 // This inset is created at too many places (see Parser::parse1() in
295 // if any of the equations are numbered, then we want to save the values
296 // of some of the counters.
298 BufferParams const & bp = buffer_->params();
299 string const & lang = it->getParLanguage(bp)->code();
301 buffer_->masterBuffer()->params().documentClass().counters();
303 // right now, we only need to do this at export time
304 if (utype == OutputUpdate) {
305 for (size_t i = 0; i < numcnts; ++i) {
306 docstring const cnt = from_ascii(counters_to_save[i]);
307 if (cnts.hasCounter(cnt))
308 counter_map[cnt] = cnts.value(cnt);
312 // this has to be done separately
313 docstring const eqstr = from_ascii("equation");
314 if (cnts.hasCounter(eqstr)) {
315 if (utype == OutputUpdate)
316 counter_map[eqstr] = cnts.value(eqstr);
317 for (size_t i = 0; i != label_.size(); ++i) {
319 cnts.step(eqstr, utype);
320 numbers_[i] = cnts.theCounter(eqstr, lang);
322 numbers_[i] = empty_docstring();
328 for (size_t i = 0; i != label_.size(); ++i) {
330 label_[i]->updateBuffer(it, utype);
333 InsetMathGrid::updateBuffer(it, utype);
337 void InsetMathHull::addToToc(DocIterator const & pit, bool output_active,
338 UpdateType utype) const
341 //FIXME: buffer_ should be set at creation for this inset! Problem is
342 // This inset is created at too many places (see Parser::parse1() in
347 TocBuilder & b = buffer().tocBackend().builder("equation");
348 // compute first and last item
349 row_type first = nrows();
350 for (row_type row = 0; row != nrows(); ++row)
355 if (first == nrows())
358 row_type last = nrows() - 1;
359 for (; last != 0; --last)
362 // add equation numbers
363 b.pushItem(pit, docstring(), output_active);
365 b.argumentItem(bformat(from_ascii("(%1$s-%2$s)"),
366 numbers_[first], numbers_[last]));
367 for (row_type row = 0; row != nrows(); ++row) {
371 label_[row]->addToToc(pit, output_active, utype);
372 docstring label = nicelabel(row);
374 // this is the only equation
375 b.argumentItem(label);
377 // insert as sub-items
378 b.pushItem(pit, label, output_active);
386 Inset * InsetMathHull::editXY(Cursor & cur, int x, int y)
388 if (previewState(&cur.bv())) {
392 return InsetMathNest::editXY(cur, x, y);
396 InsetMath::mode_type InsetMathHull::currentMode() const
400 return UNDECIDED_MODE;
402 // definitely math mode ...
422 bool InsetMathHull::idxFirst(Cursor & cur) const
430 bool InsetMathHull::idxLast(Cursor & cur) const
432 cur.idx() = nargs() - 1;
433 cur.pos() = cur.lastpos();
438 // FIXME: InsetMathGrid should be changed to let the real column alignment be
439 // given by a virtual method like displayColAlign, because the values produced
440 // by defaultColAlign can be invalidated by lfuns such as add-column. For the
441 // moment the values produced by defaultColAlign are not used, notably because
442 // alignment is not implemented in the LyXHTML output.
443 char InsetMathHull::defaultColAlign(col_type col)
445 return colAlign(type_, col);
449 char InsetMathHull::displayColAlign(idx_type idx) const
453 row_type const r = row(idx);
456 if (r == nrows() - 1)
467 return colAlign(type_, col(idx));
471 return InsetMathGrid::displayColAlign(idx);
475 int InsetMathHull::displayColSpace(col_type col) const
477 return colSpace(type_, col);
481 // FIXME: same comment as for defaultColAlign applies.
482 int InsetMathHull::defaultColSpace(col_type col)
484 return colSpace(type_, col);
488 string InsetMathHull::standardFont() const
494 return "lyxnochange";
501 ColorCode InsetMathHull::standardColor() const
506 return Color_foreground;
514 bool InsetMathHull::previewState(const BufferView *const bv) const
516 if (!editing(bv) && RenderPreview::previewMath()
517 && type_ != hullRegexp)
519 graphics::PreviewImage const * pimage =
520 preview_->getPreviewImage(bv->buffer());
521 return pimage && pimage->image();
528 static const int ERROR_FRAME_WIDTH = 2;
531 void InsetMathHull::metrics(MetricsInfo & mi, Dimension & dim) const
533 if (previewState(mi.base.bv)) {
534 preview_->metrics(mi, dim);
535 if (previewTooSmall(dim)) {
536 // preview image is too small
537 dim.wid += 2 * ERROR_FRAME_WIDTH;
538 dim.asc += 2 * ERROR_FRAME_WIDTH;
540 // insert a one pixel gap in front of the formula
543 dim.des += displayMargin();
548 Changer dummy1 = mi.base.changeFontSet(standardFont());
549 Changer dummy2 = mi.base.font.changeStyle(display() ? LM_ST_DISPLAY
552 // let the cells adjust themselves
553 InsetMathGrid::metrics(mi, dim);
556 dim.asc += displayMargin();
557 dim.des += displayMargin();
560 if (numberedType()) {
561 Changer dummy = mi.base.changeFontSet("mathbf");
563 for (row_type row = 0; row < nrows(); ++row)
564 l = max(l, mathed_string_width(mi.base.font, nicelabel(row)));
570 if (type_ == hullRegexp)
572 // make it at least as high as the current font
575 math_font_max_dim(mi.base.font, asc, des);
576 dim.asc = max(dim.asc, asc);
577 dim.des = max(dim.des, des);
581 bool InsetMathHull::previewTooSmall(Dimension const & dim) const
583 return dim.width() <= 10 && dim.height() <= 10;
587 ColorCode InsetMathHull::backgroundColor(PainterInfo const & pi) const
589 BufferView const * const bv = pi.base.bv;
590 if (previewState(bv)) {
591 Dimension const dim = dimension(*pi.base.bv);
592 if (previewTooSmall(dim))
594 return graphics::PreviewLoader::backgroundColor();
600 void InsetMathHull::drawBackground(PainterInfo & pi, int x, int y) const
602 Dimension const dim = dimension(*pi.base.bv);
603 if (previewTooSmall(dim)) {
604 pi.pain.fillRectangle(x, y - 2 * ERROR_FRAME_WIDTH,
605 dim.wid, dim.asc + dim.des, backgroundColor(pi));
608 pi.pain.fillRectangle(x + 1, y - dim.asc + 1, dim.wid - 2,
609 dim.asc + dim.des - 1, pi.backgroundColor(this));
613 void InsetMathHull::draw(PainterInfo & pi, int x, int y) const
615 BufferView const * const bv = pi.base.bv;
616 Dimension const dim = dimension(*bv);
618 if (type_ == hullRegexp)
619 pi.pain.rectangle(x + 2, y - dim.ascent() + 1,
620 dim.width() - 3, dim.height() - 2, Color_regexpframe);
622 if (previewState(bv)) {
623 // Do not draw change tracking cue if taken care of by RowPainter
625 Changer dummy = !canPaintChange(*bv) ? make_change(pi.change_, Change())
627 if (previewTooSmall(dim)) {
628 // we have an extra frame
629 preview_->draw(pi, x + ERROR_FRAME_WIDTH, y);
631 // one pixel gap in front
632 preview_->draw(pi, x + 1, y);
637 ColorCode color = pi.selected && lyxrc.use_system_colors
638 ? Color_selectiontext : standardColor();
639 bool const really_change_color = pi.base.font.color() == Color_none;
640 Changer dummy0 = really_change_color ? pi.base.font.changeColor(color)
642 Changer dummy1 = pi.base.changeFontSet(standardFont());
643 Changer dummy2 = pi.base.font.changeStyle(display() ? LM_ST_DISPLAY
646 InsetMathGrid::draw(pi, x + 1, y);
648 if (numberedType()) {
649 int const xx = x + colinfo_.back().offset_ + colinfo_.back().width_ + 20;
650 for (row_type row = 0; row < nrows(); ++row) {
651 int const yy = y + rowinfo_[row].offset_;
652 Changer dummy = pi.base.changeFontSet("mathrm");
653 docstring const nl = nicelabel(row);
657 // drawing change line
658 if (canPaintChange(*bv))
659 pi.change_.paintCue(pi, x + 1, y + 1 - dim.asc,
660 x + dim.wid, y + dim.des);
664 void InsetMathHull::metricsT(TextMetricsInfo const & mi, Dimension & dim) const
667 InsetMathGrid::metricsT(mi, dim);
670 otexrowstream ots(os);
671 WriteStream wi(ots, false, true, WriteStream::wsDefault);
673 dim.wid = os.str().size();
680 void InsetMathHull::drawT(TextPainter & pain, int x, int y) const
683 InsetMathGrid::drawT(pain, x, y);
686 otexrowstream ots(os);
687 WriteStream wi(ots, false, true, WriteStream::wsDefault);
689 pain.draw(x, y, os.str().c_str());
694 static docstring latexString(InsetMathHull const & inset)
697 // This has to be static, because a preview snippet or a math
698 // macro containing math in text mode (such as $\text{$\phi$}$ or
699 // \newcommand{\xxx}{\text{$\phi$}}) gets processed twice. The
700 // first time as a whole, and the second time only the inner math.
701 // In this last case inset.buffer() would be invalid.
702 static Encoding const * encoding = 0;
703 if (inset.isBufferValid())
704 encoding = &(inset.buffer().params().encoding());
705 otexrowstream ots(ls);
706 WriteStream wi(ots, false, true, WriteStream::wsPreview, encoding);
712 void InsetMathHull::initUnicodeMath() const
714 // Trigger classification of the unicode symbols in this inset
715 docstring const dummy = latexString(*this);
719 void InsetMathHull::addPreview(DocIterator const & inset_pos,
720 graphics::PreviewLoader & /*ploader*/) const
722 if (RenderPreview::previewMath()) {
723 preparePreview(inset_pos);
728 void InsetMathHull::usedMacros(MathData const & md, DocIterator const & pos,
729 MacroNameSet & macros, MacroNameSet & defs) const
731 MacroNameSet::iterator const end = macros.end();
733 for (size_t i = 0; i < md.size(); ++i) {
734 MathMacro const * mi = md[i].nucleus()->asMacro();
735 MathMacroTemplate const * mt = md[i].nucleus()->asMacroTemplate();
736 InsetMathScript const * si = md[i].nucleus()->asScriptInset();
737 InsetMathFracBase const * fi = md[i].nucleus()->asFracBaseInset();
738 InsetMathGrid const * gi = md[i].nucleus()->asGridInset();
739 InsetMathNest const * ni = md[i].nucleus()->asNestInset();
741 // Look for macros in the arguments of this macro.
742 for (idx_type idx = 0; idx < mi->nargs(); ++idx)
743 usedMacros(mi->cell(idx), pos, macros, defs);
744 // Make sure this is a macro defined in the document
745 // (as we also spot the macros in the symbols file)
746 // or that we have not already accounted for it.
747 docstring const name = mi->name();
748 if (macros.find(name) == end)
751 // Look for macros in the definition of this macro.
752 MathData ar(pos.buffer());
753 MacroData const * data =
754 pos.buffer()->getMacro(name, pos, true);
756 odocstringstream macro_def;
757 data->write(macro_def, true);
759 defs.insert(macro_def.str());
760 asArray(data->definition(), ar);
762 usedMacros(ar, pos, macros, defs);
764 MathData ar(pos.buffer());
765 asArray(mt->definition(), ar);
766 usedMacros(ar, pos, macros, defs);
768 if (!si->nuc().empty())
769 usedMacros(si->nuc(), pos, macros, defs);
771 usedMacros(si->down(), pos, macros, defs);
773 usedMacros(si->up(), pos, macros, defs);
774 } else if (fi || gi) {
775 idx_type nidx = fi ? fi->nargs() : gi->nargs();
776 for (idx_type idx = 0; idx < nidx; ++idx)
777 usedMacros(fi ? fi->cell(idx) : gi->cell(idx),
780 usedMacros(ni->cell(0), pos, macros, defs);
786 void InsetMathHull::preparePreview(DocIterator const & pos,
787 bool forexport) const
789 // there is no need to do all the macro stuff if we're not
790 // actually going to generate the preview.
791 if (!RenderPreview::previewMath() && !forexport)
794 Buffer const * buffer = pos.buffer();
796 // collect macros at this position
798 buffer->listMacroNames(macros);
800 // collect definitions only for the macros used in this inset
802 for (idx_type idx = 0; idx < nargs(); ++idx)
803 usedMacros(cell(idx), pos, macros, defs);
805 MacroNameSet::iterator it = defs.begin();
806 MacroNameSet::iterator end = defs.end();
807 docstring macro_preamble;
808 for (; it != end; ++it)
809 macro_preamble.append(*it);
811 // set the font series and size for this snippet
812 DocIterator dit = pos.getInnerText();
813 Paragraph const & par = dit.paragraph();
814 Font font = par.getFontSettings(buffer->params(), dit.pos());
815 font.fontInfo().realize(par.layout().font);
816 string const lsize = font.latexSize();
819 if (font.fontInfo().series() == BOLD_SERIES) {
820 setfont += from_ascii("\\textbf{");
823 if (lsize != "normalsize" && !prefixIs(lsize, "error"))
824 setfont += from_ascii("\\" + lsize + '\n');
827 if (forexport && haveNumbers()) {
828 docstring eqstr = from_ascii("equation");
829 CounterMap::const_iterator it = counter_map.find(eqstr);
830 if (it != counter_map.end()) {
831 int num = it->second;
833 setcnt += from_ascii("\\setcounter{") + eqstr + '}' +
834 '{' + convert<docstring>(num) + '}' + '\n';
836 for (size_t i = 0; i != numcnts; ++i) {
837 docstring cnt = from_ascii(counters_to_save[i]);
838 it = counter_map.find(cnt);
839 if (it == counter_map.end())
841 int num = it->second;
843 setcnt += from_ascii("\\setcounter{") + cnt + '}' +
844 '{' + convert<docstring>(num) + '}';
847 docstring const snippet = macro_preamble + setfont + setcnt
848 + latexString(*this) + endfont;
849 LYXERR(Debug::MACROS, "Preview snippet: " << snippet);
850 preview_->addPreview(snippet, *buffer, forexport);
854 void InsetMathHull::reloadPreview(DocIterator const & pos) const
857 preview_->startLoading(*pos.buffer());
861 void InsetMathHull::loadPreview(DocIterator const & pos) const
863 bool const forexport = true;
864 preparePreview(pos, forexport);
865 preview_->startLoading(*pos.buffer(), forexport);
869 bool InsetMathHull::notifyCursorLeaves(Cursor const & old, Cursor & cur)
871 if (RenderPreview::previewMath()) {
873 cur.screenUpdateFlags(Update::Force);
879 docstring InsetMathHull::label(row_type row) const
881 LASSERT(row < nrows(), return docstring());
882 if (InsetLabel * il = label_[row])
883 return il->screenLabel();
888 void InsetMathHull::label(row_type row, docstring const & label)
890 //lyxerr << "setting label '" << label << "' for row " << row << endl;
894 label_[row] = dummy_pointer;
897 label_[row]->updateLabelAndRefs(label);
899 label_[row]->setParam("name", label);
903 InsetCommandParams p(LABEL_CODE);
905 label_[row] = new InsetLabel(buffer_, p);
907 label_[row]->setBuffer(buffer());
911 void InsetMathHull::numbered(row_type row, Numbered num)
913 numbered_[row] = num;
914 if (!numbered(row) && label_[row]) {
921 bool InsetMathHull::numbered(row_type row) const
923 return numbered_[row] == NUMBER;
927 bool InsetMathHull::ams() const
947 for (size_t row = 0; row < numbered_.size(); ++row)
948 if (numbered_[row] == NOTAG)
954 bool InsetMathHull::outerDisplay() const
977 Inset::DisplayType InsetMathHull::display() const
1000 bool InsetMathHull::numberedType() const
1019 for (row_type row = 0; row < nrows(); ++row)
1026 void InsetMathHull::validate(LaTeXFeatures & features) const
1028 if (features.runparams().isLaTeX()) {
1030 features.require("amsmath");
1032 if (type_ == hullRegexp) {
1033 features.require("color");
1034 docstring frcol = from_utf8(lcolor.getLaTeXName(Color_regexpframe));
1035 docstring bgcol = from_ascii("white");
1036 features.addPreambleSnippet(
1037 "\\newcommand{\\regexp}[1]{\\fcolorbox{"
1039 + bgcol + "}{\\ensuremath{\\mathtt{#1}}}}");
1040 features.addPreambleSnippet(
1041 from_ascii("\\newcommand{\\endregexp}{}"));
1042 } else if (outerDisplay() && features.inDeletedInset()
1043 && !features.mustProvide("ct-dvipost")) {
1044 features.require("ct-tikz-math-sout");
1047 // Validation is necessary only if not using AMS math.
1048 // To be safe, we will always run mathedvalidate.
1049 //if (features.amsstyle)
1052 //features.binom = true;
1053 } else if (features.runparams().math_flavor == OutputParams::MathAsHTML) {
1054 // it would be better to do this elsewhere, but we can't validate in
1055 // InsetMathMatrix and we have no way, outside MathExtern, to know if
1056 // we even have any matrices.
1057 features.addCSSSnippet(
1058 "table.matrix{display: inline-block; vertical-align: middle; text-align:center;}\n"
1059 "table.matrix td{padding: 0.25px;}\n"
1060 "td.ldelim{width: 0.5ex; border: thin solid black; border-right: none;}\n"
1061 "td.rdelim{width: 0.5ex; border: thin solid black; border-left: none;}");
1063 InsetMathGrid::validate(features);
1067 void InsetMathHull::header_write(WriteStream & os) const
1069 bool n = numberedType();
1080 if (cell(0).empty())
1085 writeMathdisplayPreamble(os);
1089 os << "\\begin{equation" << star(n) << "}\n";
1099 writeMathdisplayPreamble(os);
1102 os << "\\begin{" << hullName(type_) << star(n) << "}\n";
1109 os << "\\begin{" << hullName(type_) << star(n) << '}'
1110 << '{' << static_cast<unsigned int>((ncols() + 1)/2) << "}\n";
1116 os << "\\begin{" << hullName(type_) << '}'
1117 << '{' << static_cast<unsigned int>((ncols() + 1)/2) << "}\n";
1127 os << "\\begin{unknown" << star(n) << "}\n";
1133 void InsetMathHull::footer_write(WriteStream & os) const
1135 bool n = numberedType();
1152 os << "\\end{equation" << star(n) << "}\n";
1155 writeMathdisplayPostamble(os);
1165 os << "\\end{" << hullName(type_) << star(n) << "}\n";
1166 writeMathdisplayPostamble(os);
1173 os << "\\end{" << hullName(type_) << star(n) << "}\n";
1179 os << "\\end{" << hullName(type_) << "}\n";
1183 // Only used as a heuristic to find the regexp termination, when searching in ignore-format mode
1184 os << "\\endregexp{}}";
1190 os << "\\end{unknown" << star(n) << "}\n";
1196 bool InsetMathHull::allowsTabularFeatures() const
1219 bool InsetMathHull::rowChangeOK() const
1222 type_ == hullEqnArray || type_ == hullAlign ||
1223 type_ == hullFlAlign || type_ == hullAlignAt ||
1224 type_ == hullXAlignAt || type_ == hullXXAlignAt ||
1225 type_ == hullGather || type_ == hullMultline;
1229 bool InsetMathHull::colChangeOK() const
1232 type_ == hullAlign || type_ == hullFlAlign ||type_ == hullAlignAt ||
1233 type_ == hullXAlignAt || type_ == hullXXAlignAt;
1237 void InsetMathHull::addRow(row_type row)
1242 bool numbered = numberedType();
1243 // Move the number and raw pointer, do not call label() (bug 7511)
1244 InsetLabel * label = dummy_pointer;
1245 docstring number = empty_docstring();
1246 if (type_ == hullMultline) {
1247 if (row + 1 == nrows()) {
1248 numbered_[row] = NONUMBER;
1249 swap(label, label_[row]);
1250 swap(number, numbers_[row]);
1255 numbered_.insert(numbered_.begin() + row + 1, numbered ? NUMBER : NONUMBER);
1256 numbers_.insert(numbers_.begin() + row + 1, number);
1257 label_.insert(label_.begin() + row + 1, label);
1258 InsetMathGrid::addRow(row);
1262 void InsetMathHull::swapRow(row_type row)
1266 if (row + 1 == nrows())
1268 swap(numbered_[row], numbered_[row + 1]);
1269 swap(numbers_[row], numbers_[row + 1]);
1270 swap(label_[row], label_[row + 1]);
1271 InsetMathGrid::swapRow(row);
1275 void InsetMathHull::delRow(row_type row)
1277 if (nrows() <= 1 || !rowChangeOK())
1279 if (row + 1 == nrows() && type_ == hullMultline) {
1280 swap(numbered_[row - 1], numbered_[row]);
1281 swap(numbers_[row - 1], numbers_[row]);
1282 swap(label_[row - 1], label_[row]);
1283 InsetMathGrid::delRow(row);
1286 InsetMathGrid::delRow(row);
1287 // The last dummy row has no number info nor a label.
1288 // Test nrows() + 1 because we have already erased the row.
1289 if (row == nrows() + 1)
1291 numbered_.erase(numbered_.begin() + row);
1292 numbers_.erase(numbers_.begin() + row);
1294 label_.erase(label_.begin() + row);
1298 void InsetMathHull::addCol(col_type col)
1302 InsetMathGrid::addCol(col);
1306 void InsetMathHull::delCol(col_type col)
1308 if (ncols() <= 1 || !colChangeOK())
1310 InsetMathGrid::delCol(col);
1314 docstring InsetMathHull::nicelabel(row_type row) const
1318 docstring const & val = numbers_[row];
1320 return '(' + val + ')';
1321 return '(' + val + ',' + label_[row]->screenLabel() + ')';
1325 void InsetMathHull::glueall(HullType type)
1328 for (idx_type i = 0; i < nargs(); ++i)
1330 InsetLabel * label = 0;
1331 if (type == hullEquation) {
1332 // preserve first non-empty label
1333 for (row_type row = 0; row < nrows(); ++row) {
1335 label = label_[row];
1341 *this = InsetMathHull(buffer_, hullSimple);
1348 void InsetMathHull::splitTo2Cols()
1350 LASSERT(ncols() == 1, return);
1351 InsetMathGrid::addCol(1);
1352 for (row_type row = 0; row < nrows(); ++row) {
1353 idx_type const i = 2 * row;
1354 pos_type pos = firstRelOp(cell(i));
1355 cell(i + 1) = MathData(buffer_, cell(i).begin() + pos, cell(i).end());
1356 cell(i).erase(pos, cell(i).size());
1361 void InsetMathHull::splitTo3Cols()
1363 LASSERT(ncols() < 3, return);
1366 InsetMathGrid::addCol(2);
1367 for (row_type row = 0; row < nrows(); ++row) {
1368 idx_type const i = 3 * row + 1;
1369 if (!cell(i).empty()) {
1370 cell(i + 1) = MathData(buffer_, cell(i).begin() + 1, cell(i).end());
1371 cell(i).erase(1, cell(i).size());
1377 void InsetMathHull::changeCols(col_type cols)
1379 if (ncols() == cols)
1381 else if (ncols() < cols) {
1387 while (ncols() < cols)
1388 InsetMathGrid::addCol(ncols());
1394 for (row_type row = 0; row < nrows(); ++row) {
1395 idx_type const i = row * ncols();
1396 for (col_type col = cols; col < ncols(); ++col) {
1397 cell(i + cols - 1).append(cell(i + col));
1401 while (ncols() > cols) {
1402 InsetMathGrid::delCol(ncols() - 1);
1407 HullType InsetMathHull::getType() const
1413 void InsetMathHull::setType(HullType type)
1420 bool InsetMathHull::isMutable(HullType type)
1444 void InsetMathHull::mutate(HullType newtype)
1446 //lyxerr << "mutating from '" << type_ << "' to '" << newtype << "'" << endl;
1448 if (newtype == type_)
1451 // This guards the algorithm below it, which is designed with certain types
1453 if (!isMutable(newtype) || !isMutable(type_)) {
1454 lyxerr << "mutation from '" << to_utf8(hullName(type_))
1455 << "' to '" << to_utf8(hullName(newtype))
1456 << "' not implemented" << endl;
1460 // we try to move along the chain
1461 // none <-> simple <-> equation <-> eqnarray -> *align* -> multline, gather -+
1463 // +-------------------------------------+
1464 // we use eqnarray as intermediate type for mutations that are not
1465 // directly supported because it handles labels and numbering for
1470 setType(hullSimple);
1476 if (newtype == hullNone) {
1480 setType(hullEquation);
1481 numbered(0, label_[0] ? true : false);
1490 setType(hullSimple);
1495 // split it "nicely" on the first relop
1497 setType(hullEqnArray);
1505 // split it "nicely"
1540 setType(hullEqnArray);
1549 for (row_type row = 0; row < nrows(); ++row)
1550 numbered(row, false);
1560 for (row_type row = 0; row < nrows(); ++row)
1561 numbered(row, false);
1568 setType(hullEqnArray);
1598 for (row_type row = 0; row < nrows(); ++row)
1599 numbered(row, false);
1603 // first we mutate to EqnArray
1605 setType(hullEqnArray);
1612 // we passed the guard so we should not be here
1613 LASSERT("Mutation not implemented, but should have been.", return);
1619 docstring InsetMathHull::eolString(row_type row, bool fragile, bool latex,
1620 bool last_eoln) const
1623 if (numberedType()) {
1624 if (label_[row] && numbered(row)) {
1625 docstring const name =
1626 latex ? escape(label_[row]->getParam("name"))
1627 : label_[row]->getParam("name");
1628 res += "\\label{" + name + '}';
1630 if (type_ != hullMultline) {
1631 if (numbered_[row] == NONUMBER)
1632 res += "\\nonumber ";
1633 else if (numbered_[row] == NOTAG)
1637 // Never add \\ on the last empty line of eqnarray and friends
1639 return res + InsetMathGrid::eolString(row, fragile, latex, last_eoln);
1642 void InsetMathHull::write(WriteStream & os) const
1644 ModeSpecifier specifier(os, MATH_MODE);
1646 InsetMathGrid::write(os);
1651 void InsetMathHull::normalize(NormalStream & os) const
1653 os << "[formula " << hullName(type_) << ' ';
1654 InsetMathGrid::normalize(os);
1659 void InsetMathHull::infoize(odocstream & os) const
1661 os << bformat(_("Type: %1$s"), hullName(type_));
1665 void InsetMathHull::check() const
1667 LATTEST(numbered_.size() == nrows());
1668 LATTEST(numbers_.size() == nrows());
1669 LATTEST(label_.size() == nrows());
1673 void InsetMathHull::doExtern(Cursor & cur, FuncRequest & func)
1677 idocstringstream iss(func.argument());
1678 iss >> dlang >> extra;
1680 extra = from_ascii("noextra");
1681 string const lang = to_ascii(dlang);
1683 // replace selection with result of computation
1684 if (reduceSelectionToOneCell(cur)) {
1686 asArray(grabAndEraseSelection(cur), ar);
1687 lyxerr << "use selection: " << ar << endl;
1688 cur.insert(pipeThroughExtern(lang, extra, ar));
1692 // only inline, display or eqnarray math is allowed
1693 switch (getType()) {
1699 frontend::Alert::warning(_("Bad math environment"),
1700 _("Computation cannot be performed for AMS "
1701 "math environments.\nChange the math "
1702 "formula type and try again."));
1707 eq.push_back(MathAtom(new InsetMathChar('=')));
1709 // go to first item in line
1710 cur.idx() -= cur.idx() % ncols();
1713 if (getType() == hullSimple) {
1714 size_type pos = cur.cell().find_last(eq);
1716 if (pos == cur.cell().size()) {
1718 lyxerr << "use whole cell: " << ar << endl;
1720 ar = MathData(buffer_, cur.cell().begin() + pos + 1, cur.cell().end());
1721 lyxerr << "use partial cell form pos: " << pos << endl;
1723 cur.cell().append(eq);
1724 cur.cell().append(pipeThroughExtern(lang, extra, ar));
1725 cur.pos() = cur.lastpos();
1729 if (getType() == hullEquation) {
1730 lyxerr << "use equation inset" << endl;
1731 mutate(hullEqnArray);
1732 MathData & ar = cur.cell();
1733 lyxerr << "use cell: " << ar << endl;
1737 cur.cell() = pipeThroughExtern(lang, extra, ar);
1738 // move to end of line
1739 cur.pos() = cur.lastpos();
1744 lyxerr << "use eqnarray" << endl;
1745 cur.idx() += 2 - cur.idx() % ncols();
1747 MathData ar = cur.cell();
1748 lyxerr << "use cell: " << ar << endl;
1749 // FIXME: temporarily disabled
1755 cur.cell() = pipeThroughExtern(lang, extra, ar);
1756 cur.pos() = cur.lastpos();
1761 void InsetMathHull::doDispatch(Cursor & cur, FuncRequest & cmd)
1763 //lyxerr << "action: " << cmd.action() << endl;
1764 switch (cmd.action()) {
1766 case LFUN_FINISHED_BACKWARD:
1767 case LFUN_FINISHED_FORWARD:
1768 case LFUN_FINISHED_RIGHT:
1769 case LFUN_FINISHED_LEFT:
1770 //lyxerr << "action: " << cmd.action() << endl;
1771 InsetMathGrid::doDispatch(cur, cmd);
1774 case LFUN_PARAGRAPH_BREAK:
1775 // just swallow this
1778 case LFUN_NEWLINE_INSERT:
1779 // some magic for the common case
1780 if (type_ == hullSimple || type_ == hullEquation) {
1781 cur.recordUndoInset();
1783 cur.bv().buffer().params().use_package("amsmath") != BufferParams::package_off;
1784 mutate(align ? hullAlign : hullEqnArray);
1785 // mutate() may change labels and such.
1786 cur.forceBufferUpdate();
1787 cur.idx() = nrows() * ncols() - 1;
1788 cur.pos() = cur.lastpos();
1790 InsetMathGrid::doDispatch(cur, cmd);
1793 case LFUN_MATH_NUMBER_TOGGLE: {
1794 //lyxerr << "toggling all numbers" << endl;
1795 cur.recordUndoInset();
1796 bool old = numberedType();
1797 if (type_ == hullMultline)
1798 numbered(nrows() - 1, !old);
1800 for (row_type row = 0; row < nrows(); ++row)
1801 numbered(row, !old);
1803 cur.message(old ? _("No number") : _("Number"));
1804 cur.forceBufferUpdate();
1808 case LFUN_MATH_NUMBER_LINE_TOGGLE: {
1809 cur.recordUndoInset();
1810 row_type r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1811 bool old = numbered(r);
1812 cur.message(old ? _("No number") : _("Number"));
1814 cur.forceBufferUpdate();
1818 case LFUN_LABEL_INSERT: {
1819 row_type r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1820 docstring old_label = label(r);
1821 docstring const default_label = from_ascii("eq:");
1822 if (old_label.empty())
1823 old_label = default_label;
1825 InsetCommandParams p(LABEL_CODE);
1826 p["name"] = cmd.argument().empty() ? old_label : cmd.argument();
1827 string const data = InsetCommand::params2string(p);
1829 if (cmd.argument().empty())
1830 cur.bv().showDialog("label", data);
1832 FuncRequest fr(LFUN_INSET_INSERT, data);
1838 case LFUN_LABEL_COPY_AS_REFERENCE: {
1840 if (cmd.argument().empty() && &cur.inset() == this)
1841 // if there is no argument and we're inside math, we retrieve
1842 // the row number from the cursor position.
1843 row = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1845 // if there is an argument, find the corresponding label, else
1846 // check whether there is at least one label.
1847 for (row = 0; row != nrows(); ++row)
1848 if (numbered(row) && label_[row]
1849 && (cmd.argument().empty() || label(row) == cmd.argument()))
1856 InsetCommandParams p(REF_CODE, "ref");
1857 p["reference"] = label(row);
1858 cap::clearSelection();
1859 cap::copyInset(cur, new InsetRef(buffer_, p), label(row));
1863 case LFUN_WORD_DELETE_FORWARD:
1864 case LFUN_CHAR_DELETE_FORWARD:
1865 if (col(cur.idx()) + 1 == ncols()
1866 && cur.pos() == cur.lastpos()
1867 && !cur.selection()) {
1868 if (!label(row(cur.idx())).empty()) {
1869 cur.recordUndoInset();
1870 label(row(cur.idx()), docstring());
1871 } else if (numbered(row(cur.idx()))) {
1872 cur.recordUndoInset();
1873 numbered(row(cur.idx()), false);
1874 cur.forceBufferUpdate();
1876 InsetMathGrid::doDispatch(cur, cmd);
1880 InsetMathGrid::doDispatch(cur, cmd);
1885 case LFUN_INSET_INSERT: {
1886 //lyxerr << "arg: " << to_utf8(cmd.argument()) << endl;
1887 // FIXME: this should be cleaned up to use InsetLabel methods directly.
1888 string const name = cmd.getArg(0);
1889 if (name == "label") {
1890 InsetCommandParams p(LABEL_CODE);
1891 InsetCommand::string2params(to_utf8(cmd.argument()), p);
1892 docstring str = p["name"];
1893 cur.recordUndoInset();
1894 row_type const r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1898 docstring old = label(r);
1901 // The label will take care of the reference update.
1905 // Newly created inset so initialize it.
1906 label_[r]->initView();
1909 cur.forceBufferUpdate();
1912 InsetMathGrid::doDispatch(cur, cmd);
1916 case LFUN_MATH_EXTERN:
1917 cur.recordUndoInset();
1921 case LFUN_MATH_MUTATE: {
1922 cur.recordUndoInset();
1923 row_type row = cur.row();
1924 col_type col = cur.col();
1925 mutate(hullType(cmd.argument()));
1926 cur.idx() = row * ncols() + col;
1927 if (cur.idx() > cur.lastidx()) {
1928 cur.idx() = cur.lastidx();
1929 cur.pos() = cur.lastpos();
1931 if (cur.pos() > cur.lastpos())
1932 cur.pos() = cur.lastpos();
1934 cur.forceBufferUpdate();
1935 // FIXME: find some more clever handling of the selection,
1936 // i.e. preserve it.
1937 cur.clearSelection();
1938 //cur.dispatched(FINISHED);
1942 case LFUN_MATH_DISPLAY: {
1943 cur.recordUndoInset();
1944 mutate(type_ == hullSimple ? hullEquation : hullSimple);
1945 // if the cursor is in a cell that got merged, move it to
1946 // start of the hull inset.
1947 if (cur.idx() > 0) {
1951 if (cur.pos() > cur.lastpos())
1952 cur.pos() = cur.lastpos();
1957 case LFUN_TABULAR_FEATURE:
1958 if (!allowsTabularFeatures())
1961 InsetMathGrid::doDispatch(cur, cmd);
1965 InsetMathGrid::doDispatch(cur, cmd);
1973 bool allowDisplayMath(Cursor const & cur)
1975 LATTEST(cur.depth() > 1);
1976 Cursor tmpcur = cur;
1979 FuncRequest cmd(LFUN_MATH_DISPLAY);
1980 return tmpcur.getStatus(cmd, status) && status.enabled();
1986 bool InsetMathHull::getStatus(Cursor & cur, FuncRequest const & cmd,
1987 FuncStatus & status) const
1989 switch (cmd.action()) {
1990 case LFUN_FINISHED_BACKWARD:
1991 case LFUN_FINISHED_FORWARD:
1992 case LFUN_FINISHED_RIGHT:
1993 case LFUN_FINISHED_LEFT:
1996 case LFUN_NEWLINE_INSERT:
1997 case LFUN_MATH_EXTERN:
1999 status.setEnabled(true);
2002 // we never allow this in math, and we want to bind enter
2003 // to another actions in command-alternatives
2004 case LFUN_PARAGRAPH_BREAK:
2005 status.setEnabled(false);
2007 case LFUN_MATH_MUTATE: {
2008 HullType const ht = hullType(cmd.argument());
2009 status.setOnOff(type_ == ht);
2010 status.setEnabled(isMutable(ht) && isMutable(type_));
2012 if (ht != hullSimple && status.enabled())
2013 status.setEnabled(allowDisplayMath(cur));
2016 case LFUN_MATH_DISPLAY: {
2017 status.setEnabled(display() != Inline || allowDisplayMath(cur));
2018 status.setOnOff(display() != Inline);
2022 case LFUN_MATH_NUMBER_TOGGLE:
2023 // FIXME: what is the right test, this or the one of
2025 status.setEnabled(display() != Inline);
2026 status.setOnOff(numberedType());
2029 case LFUN_MATH_NUMBER_LINE_TOGGLE: {
2030 // FIXME: what is the right test, this or the one of
2032 bool const enable = (type_ == hullMultline)
2033 ? (nrows() - 1 == cur.row())
2034 : display() != Inline;
2035 row_type const r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
2036 status.setEnabled(enable);
2037 status.setOnOff(enable && numbered(r));
2041 case LFUN_LABEL_INSERT:
2042 status.setEnabled(type_ != hullSimple);
2045 case LFUN_LABEL_COPY_AS_REFERENCE: {
2046 bool enabled = false;
2048 if (cmd.argument().empty() && &cur.inset() == this) {
2049 // if there is no argument and we're inside math, we retrieve
2050 // the row number from the cursor position.
2051 row = (type_ == hullMultline) ? nrows() - 1 : cur.row();
2052 enabled = numberedType() && label_[row] && numbered(row);
2054 // if there is an argument, find the corresponding label, else
2055 // check whether there is at least one label.
2056 for (row_type row = 0; row != nrows(); ++row) {
2057 if (numbered(row) && label_[row] &&
2058 (cmd.argument().empty() || label(row) == cmd.argument())) {
2064 status.setEnabled(enabled);
2068 case LFUN_INSET_INSERT:
2069 if (cmd.getArg(0) == "label") {
2070 status.setEnabled(type_ != hullSimple);
2073 return InsetMathGrid::getStatus(cur, cmd, status);
2075 case LFUN_TABULAR_FEATURE: {
2076 if (!allowsTabularFeatures())
2078 string s = cmd.getArg(0);
2080 && (s == "append-row"
2081 || s == "delete-row"
2082 || s == "copy-row")) {
2083 status.message(bformat(
2084 from_utf8(N_("Can't change number of rows in '%1$s'")),
2086 status.setEnabled(false);
2090 && (s == "append-column"
2091 || s == "delete-column"
2092 || s == "copy-column")) {
2093 status.message(bformat(
2094 from_utf8(N_("Can't change number of columns in '%1$s'")),
2096 status.setEnabled(false);
2099 if (s == "add-vline-left" || s == "add-vline-right") {
2100 status.message(bformat(
2101 from_utf8(N_("Can't add vertical grid lines in '%1$s'")),
2103 status.setEnabled(false);
2106 if (s == "valign-top" || s == "valign-middle"
2107 || s == "valign-bottom" || s == "align-left"
2108 || s == "align-center" || s == "align-right") {
2109 status.setEnabled(false);
2112 return InsetMathGrid::getStatus(cur, cmd, status);
2116 return InsetMathGrid::getStatus(cur, cmd, status);
2119 // This cannot really happen, but inserted to shut-up gcc
2120 return InsetMathGrid::getStatus(cur, cmd, status);
2124 /////////////////////////////////////////////////////////////////////
2128 // simply scrap this function if you want
2129 void InsetMathHull::mutateToText()
2132 // translate to latex
2134 latex(os, false, false);
2135 string str = os.str();
2138 Text * lt = view_->cursor().innerText();
2139 string::const_iterator cit = str.begin();
2140 string::const_iterator end = str.end();
2141 for (; cit != end; ++cit)
2142 view_->getIntl()->getTransManager().TranslateAndInsert(*cit, lt);
2145 //dispatch(LFUN_ESCAPE);
2150 void InsetMathHull::handleFont(Cursor & cur, docstring const & arg,
2151 docstring const & font)
2153 // this whole function is a hack and won't work for incremental font
2156 if (cur.inset().asInsetMath()->name() == font)
2157 cur.handleFont(to_utf8(font));
2159 cur.handleNest(createInsetMath(font, cur.buffer()));
2165 void InsetMathHull::handleFont2(Cursor & cur, docstring const & arg)
2170 font.fromString(to_utf8(arg), b);
2171 if (font.fontInfo().color() != Color_inherit) {
2172 MathAtom at = MathAtom(new InsetMathColor(buffer_, true, font.fontInfo().color()));
2173 cur.handleNest(at, 0);
2178 void InsetMathHull::edit(Cursor & cur, bool front, EntryDirection entry_from)
2181 bool enter_front = (entry_from == Inset::ENTRY_DIRECTION_LEFT ||
2182 (entry_from == Inset::ENTRY_DIRECTION_IGNORE && front));
2183 enter_front ? idxFirst(cur) : idxLast(cur);
2184 // The inset formula dimension is not necessarily the same as the
2185 // one of the instant preview image, so we have to indicate to the
2186 // BufferView that a metrics update is needed.
2187 cur.screenUpdateFlags(Update::Force);
2191 void InsetMathHull::revealCodes(Cursor & cur) const
2193 if (!cur.inMathed())
2195 odocstringstream os;
2197 cur.message(os.str());
2199 // write something to the minibuffer
2200 // translate to latex
2204 string str = os.str();
2206 string::size_type pos = 0;
2208 for (string::iterator it = str.begin(); it != str.end(); ++it) {
2211 else if (*it == '\0') {
2213 pos = it - str.begin();
2219 res = res.substr(pos - 30);
2220 if (res.size() > 60)
2221 res = res.substr(0, 60);
2227 /////////////////////////////////////////////////////////////////////
2231 bool InsetMathHull::searchForward(BufferView * bv, string const & str,
2234 // FIXME: completely broken
2235 static InsetMathHull * lastformula = 0;
2236 static CursorBase current = DocIterator(ibegin(nucleus()));
2238 static string laststr;
2240 if (lastformula != this || laststr != str) {
2241 //lyxerr << "reset lastformula to " << this << endl;
2244 current = ibegin(nucleus());
2246 mathed_parse_cell(ar, str, Parse::NORMAL, &buffer());
2250 //lyxerr << "searching '" << str << "' in " << this << ar << endl;
2252 for (DocIterator it = current; it != iend(nucleus()); increment(it)) {
2253 CursorSlice & top = it.back();
2254 MathData const & a = top.asInsetMath()->cell(top.idx_);
2255 if (a.matchpart(ar, top.pos_)) {
2256 bv->cursor().setSelection(it, ar.size());
2258 top.pos_ += ar.size();
2264 //lyxerr << "not found!" << endl;
2271 void InsetMathHull::write(ostream & os) const
2273 odocstringstream oss;
2274 otexrowstream ots(oss);
2275 WriteStream wi(ots, false, false, WriteStream::wsDefault);
2278 os << to_utf8(oss.str());
2282 void InsetMathHull::read(Lexer & lex)
2285 mathed_parse_normal(buffer_, at, lex, Parse::TRACKMACRO);
2286 operator=(*at->asHullInset());
2290 bool InsetMathHull::readQuiet(Lexer & lex)
2293 bool success = mathed_parse_normal(buffer_, at, lex, Parse::QUIET);
2295 operator=(*at->asHullInset());
2300 int InsetMathHull::plaintext(odocstringstream & os,
2301 OutputParams const & op, size_t max_length) const
2303 // disables ASCII-art for export of equations. See #2275.
2304 if (0 && display()) {
2308 TextPainter tpain(dim.width(), dim.height());
2309 drawT(tpain, 0, dim.ascent());
2311 // reset metrics cache to "real" values
2313 return tpain.textheight();
2316 odocstringstream oss;
2317 otexrowstream ots(oss);
2318 Encoding const * const enc = encodings.fromLyXName("utf8");
2319 WriteStream wi(ots, false, true, WriteStream::wsDefault, enc);
2322 if (type_ == hullRegexp)
2325 for (row_type r = 0; r < nrows(); ++r) {
2326 for (col_type c = 0; c < ncols(); ++c)
2327 wi << (c == 0 ? "" : "\t") << cell(index(r, c));
2328 // if it's for the TOC, we write just the first line
2329 // and do not include the newline.
2330 if (op.for_toc || op.for_tooltip || oss.str().size() >= max_length)
2332 if (r < nrows() - 1)
2336 docstring const str = oss.str();
2342 int InsetMathHull::docbook(odocstream & os, OutputParams const & runparams) const
2347 if (getType() == hullSimple)
2348 name = from_ascii("inlineequation");
2350 name = from_ascii("informalequation");
2352 docstring bname = name;
2353 if (!label(0).empty())
2354 bname += " id='" + sgml::cleanID(buffer(), runparams, label(0)) + "'";
2356 ++ms.tab(); ms.cr(); ms.os() << '<' << bname << '>';
2358 odocstringstream ls;
2360 if (runparams.flavor == OutputParams::XML) {
2361 ms << MTag("alt role='tex' ");
2362 // Workaround for db2latex: db2latex always includes equations with
2363 // \ensuremath{} or \begin{display}\end{display}
2364 // so we strip LyX' math environment
2365 WriteStream wi(ols, false, false, WriteStream::wsDefault, runparams.encoding);
2366 InsetMathGrid::write(wi);
2367 ms << from_utf8(subst(subst(to_utf8(ls.str()), "&", "&"), "<", "<"));
2372 InsetMathGrid::mathmlize(ms);
2375 ms << MTag("alt role='tex'");
2376 latex(ols, runparams);
2377 res = ols.texrow().rows();
2378 ms << from_utf8(subst(subst(to_utf8(ls.str()), "&", "&"), "<", "<"));
2382 ms << from_ascii("<graphic fileref=\"eqn/");
2383 if (!label(0).empty())
2384 ms << sgml::cleanID(buffer(), runparams, label(0));
2386 ms << sgml::uniqueID(from_ascii("anon"));
2388 if (runparams.flavor == OutputParams::XML)
2389 ms << from_ascii("\"/>");
2391 ms << from_ascii("\">");
2393 ms.cr(); --ms.tab(); ms.os() << "</" << name << '>';
2395 return ms.line() + res;
2399 bool InsetMathHull::haveNumbers() const
2401 bool havenumbers = false;
2402 // inline formulas are never numbered (bug 7351 part 3)
2403 if (getType() == hullSimple)
2405 for (size_t i = 0; i != numbered_.size(); ++i) {
2416 // We need to do something about alignment here.
2418 // This duplicates code from InsetMathGrid, but
2419 // we need access here to number information,
2420 // and we simply do not have that in InsetMathGrid.
2421 void InsetMathHull::htmlize(HtmlStream & os) const
2423 bool const havenumbers = haveNumbers();
2424 bool const havetable = havenumbers || nrows() > 1 || ncols() > 1;
2427 os << cell(index(0, 0));
2431 os << MTag("table", "class='mathtable'");
2432 for (row_type row = 0; row < nrows(); ++row) {
2434 for (col_type col = 0; col < ncols(); ++col) {
2436 os << cell(index(row, col));
2441 docstring const & num = numbers_[row];
2443 os << '(' << num << ')';
2448 os << ETag("table");
2452 // this duplicates code from InsetMathGrid, but
2453 // we need access here to number information,
2454 // and we simply do not have that in InsetMathGrid.
2455 void InsetMathHull::mathmlize(MathStream & os) const
2457 bool const havenumbers = haveNumbers();
2458 bool const havetable = havenumbers || nrows() > 1 || ncols() > 1;
2461 os << MTag("mtable");
2462 char const * const celltag = havetable ? "mtd" : "mrow";
2463 // FIXME There does not seem to be wide support at the moment
2464 // for mlabeledtr, so we have to use just mtr for now.
2465 // char const * const rowtag = havenumbers ? "mlabeledtr" : "mtr";
2466 char const * const rowtag = "mtr";
2467 for (row_type row = 0; row < nrows(); ++row) {
2470 for (col_type col = 0; col < ncols(); ++col) {
2472 << cell(index(row, col))
2478 docstring const & num = numbers_[row];
2480 os << '(' << num << ')';
2487 os << ETag("mtable");
2491 void InsetMathHull::mathAsLatex(WriteStream & os) const
2493 MathEnsurer ensurer(os, false);
2494 bool havenumbers = haveNumbers();
2495 bool const havetable = havenumbers || nrows() > 1 || ncols() > 1;
2498 os << cell(index(0, 0));
2502 os << "<table class='mathtable'>";
2503 for (row_type row = 0; row < nrows(); ++row) {
2505 for (col_type col = 0; col < ncols(); ++col) {
2506 os << "<td class='math'>";
2507 os << cell(index(row, col));
2512 docstring const & num = numbers_[row];
2514 os << '(' << num << ')';
2523 docstring InsetMathHull::xhtml(XHTMLStream & xs, OutputParams const & op) const
2525 BufferParams::MathOutput const mathtype =
2526 buffer().masterBuffer()->params().html_math_output;
2528 bool success = false;
2530 // we output all the labels just at the beginning of the equation.
2531 // this should be fine.
2532 for (size_t i = 0; i != label_.size(); ++i) {
2533 InsetLabel const * const il = label_[i];
2539 // FIXME Eventually we would like to do this inset by inset.
2540 if (mathtype == BufferParams::MathML) {
2541 odocstringstream os;
2546 } catch (MathExportException const &) {}
2548 if (getType() == hullSimple)
2549 xs << html::StartTag("math",
2550 "xmlns=\"http://www.w3.org/1998/Math/MathML\"", true);
2552 xs << html::StartTag("math",
2553 "display=\"block\" xmlns=\"http://www.w3.org/1998/Math/MathML\"", true);
2554 xs << XHTMLStream::ESCAPE_NONE
2556 << html::EndTag("math");
2558 } else if (mathtype == BufferParams::HTML) {
2559 odocstringstream os;
2564 } catch (MathExportException const &) {}
2566 string const tag = (getType() == hullSimple) ? "span" : "div";
2567 xs << html::StartTag(tag, "class='formula'", true)
2568 << XHTMLStream::ESCAPE_NONE
2570 << html::EndTag(tag);
2574 // what we actually want is this:
2576 // ((mathtype == BufferParams::MathML || mathtype == BufferParams::HTML)
2578 // || mathtype == BufferParams::Images
2580 // but what follows is equivalent, since we'll enter only if either (a) we
2581 // tried and failed with MathML or HTML or (b) didn't try yet at all but
2582 // aren't doing LaTeX.
2584 // so this is for Images.
2585 if (!success && mathtype != BufferParams::LaTeX) {
2586 graphics::PreviewImage const * pimage = 0;
2588 loadPreview(docit_);
2589 pimage = preview_->getPreviewImage(buffer());
2590 // FIXME Do we always have png?
2593 if (pimage || op.dryrun) {
2594 string const filename = pimage ? pimage->filename().onlyFileName()
2595 : "previewimage.png";
2597 // if we are not in the master buffer, then we need to see that the
2598 // generated image is copied there; otherwise, preview fails.
2599 Buffer const * mbuf = buffer().masterBuffer();
2600 if (mbuf != &buffer()) {
2601 string mbtmp = mbuf->temppath();
2602 FileName const mbufimg(support::addName(mbtmp, filename));
2603 pimage->filename().copyTo(mbufimg);
2605 // add the file to the list of files to be exported
2606 op.exportdata->addExternalFile("xhtml", pimage->filename());
2609 string const tag = (getType() == hullSimple) ? "span" : "div";
2611 << html::StartTag(tag, "style = \"text-align: center;\"")
2612 << html::CompTag("img", "src=\"" + filename + "\" alt=\"Mathematical Equation\"")
2613 << html::EndTag(tag)
2619 // so we'll pass this test if we've failed everything else, or
2620 // if mathtype was LaTeX, since we won't have entered any of the
2622 if (!success /* || mathtype != BufferParams::LaTeX */) {
2623 // Unfortunately, we cannot use latexString() because we do not want
2624 // $...$ or whatever.
2625 odocstringstream ls;
2626 otexrowstream ots(ls);
2627 WriteStream wi(ots, false, true, WriteStream::wsPreview);
2628 ModeSpecifier specifier(wi, MATH_MODE);
2630 docstring const latex = ls.str();
2632 // class='math' allows for use of jsMath
2633 // http://www.math.union.edu/~dpvc/jsMath/
2635 // probably should allow for some kind of customization here
2636 string const tag = (getType() == hullSimple) ? "span" : "div";
2637 xs << html::StartTag(tag, "class='math'")
2639 << html::EndTag(tag)
2646 void InsetMathHull::toString(odocstream & os) const
2648 odocstringstream ods;
2649 plaintext(ods, OutputParams(0));
2654 void InsetMathHull::forOutliner(docstring & os, size_t const, bool const) const
2656 odocstringstream ods;
2659 // FIXME: this results in spilling TeX into the LyXHTML output since the
2660 // outliner is used to generate the LyXHTML list of figures/etc.
2666 string InsetMathHull::contextMenuName() const
2668 return "context-math";
2672 void InsetMathHull::recordLocation(DocIterator const & di)
2678 bool InsetMathHull::canPaintChange(BufferView const &) const
2680 // We let RowPainter do it seamlessly for inline insets
2681 return display() != Inline;