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 "InsetMathMacro.h"
39 #include "InsetMathMacroTemplate.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)
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, TocBackend & backend) 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 = backend.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, backend);
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("mathrm");
563 for (row_type row = 0; row < nrows(); ++row)
564 l = max(l, mathed_string_width(mi.base.font, nicelabel(row)));
567 // Value was hardcoded to 30 pixels
568 dim.wid += Length(0.3, Length::IN).inPixels(mi.base) + l;
571 // reserve some space for marker.
574 // make it at least as high as the current font
577 math_font_max_dim(mi.base.font, asc, des);
578 dim.asc = max(dim.asc, asc);
579 dim.des = max(dim.des, des);
583 bool InsetMathHull::previewTooSmall(Dimension const & dim) const
585 return dim.width() <= 10 && dim.height() <= 10;
589 ColorCode InsetMathHull::backgroundColor(PainterInfo const & pi) const
591 BufferView const * const bv = pi.base.bv;
592 if (previewState(bv)) {
593 Dimension const dim = dimension(*pi.base.bv);
594 if (previewTooSmall(dim))
596 return graphics::PreviewLoader::backgroundColor();
602 void InsetMathHull::drawBackground(PainterInfo & pi, int x, int y) const
604 Dimension const dim = dimension(*pi.base.bv);
605 if (previewTooSmall(dim)) {
606 pi.pain.fillRectangle(x, y - 2 * ERROR_FRAME_WIDTH,
607 dim.wid, dim.asc + dim.des, backgroundColor(pi));
610 pi.pain.fillRectangle(x + 1, y - dim.asc + 1, dim.wid - 2,
611 dim.asc + dim.des - 1, pi.backgroundColor(this));
615 void InsetMathHull::draw(PainterInfo & pi, int x, int y) const
617 BufferView const * const bv = pi.base.bv;
618 Dimension const dim = dimension(*bv);
620 if (type_ == hullRegexp)
621 pi.pain.rectangle(x + 2, y - dim.ascent() + 1,
622 dim.width() - 3, dim.height() - 2, Color_regexpframe);
624 if (previewState(bv)) {
625 // Do not draw change tracking cue if taken care of by RowPainter
627 Changer dummy = !canPaintChange(*bv) ? make_change(pi.change_, Change())
629 if (previewTooSmall(dim)) {
630 // we have an extra frame
631 preview_->draw(pi, x + ERROR_FRAME_WIDTH, y);
633 // one pixel gap in front
634 preview_->draw(pi, x + 1, y);
639 ColorCode color = pi.selected && lyxrc.use_system_colors
640 ? Color_selectiontext : standardColor();
641 bool const really_change_color = pi.base.font.color() == Color_none;
642 Changer dummy0 = really_change_color ? pi.base.font.changeColor(color)
644 Changer dummy1 = pi.base.changeFontSet(standardFont());
645 Changer dummy2 = pi.base.font.changeStyle(display() ? LM_ST_DISPLAY
649 BufferParams::MathNumber const math_number = buffer().params().getMathNumber();
650 if (numberedType() && math_number == BufferParams::LEFT) {
651 Changer dummy = pi.base.changeFontSet("mathrm");
653 for (row_type row = 0; row < nrows(); ++row)
654 l = max(l, mathed_string_width(pi.base.font, nicelabel(row)));
657 // Value was hardcoded to 30 pixels
658 xmath += Length(0.3, Length::IN).inPixels(pi.base) + l;
661 InsetMathGrid::draw(pi, xmath + 1, y);
662 drawMarkers2(pi, x, y);
664 if (numberedType()) {
665 Changer dummy = pi.base.changeFontSet("mathrm");
666 for (row_type row = 0; row < nrows(); ++row) {
667 int const yy = y + rowinfo_[row].offset_;
668 docstring const nl = nicelabel(row);
669 if (math_number == BufferParams::LEFT)
672 int l = mathed_string_width(pi.base.font, nl);
673 pi.draw(x + dim.wid - l, yy, nl);
678 // drawing change line
679 if (canPaintChange(*bv))
680 pi.change_.paintCue(pi, x + 1, y + 1 - dim.asc,
681 x + dim.wid, y + dim.des);
685 void InsetMathHull::metricsT(TextMetricsInfo const & mi, Dimension & dim) const
688 InsetMathGrid::metricsT(mi, dim);
691 otexrowstream ots(os);
692 WriteStream wi(ots, false, true, WriteStream::wsDefault);
694 dim.wid = os.str().size();
701 void InsetMathHull::drawT(TextPainter & pain, int x, int y) const
704 InsetMathGrid::drawT(pain, x, y);
707 otexrowstream ots(os);
708 WriteStream wi(ots, false, true, WriteStream::wsDefault);
710 pain.draw(x, y, os.str().c_str());
715 static docstring latexString(InsetMathHull const & inset)
718 // This has to be static, because a preview snippet or a math
719 // macro containing math in text mode (such as $\text{$\phi$}$ or
720 // \newcommand{\xxx}{\text{$\phi$}}) gets processed twice. The
721 // first time as a whole, and the second time only the inner math.
722 // In this last case inset.buffer() would be invalid.
723 static Encoding const * encoding = 0;
724 if (inset.isBufferValid())
725 encoding = &(inset.buffer().params().encoding());
726 otexrowstream ots(ls);
727 WriteStream wi(ots, false, true, WriteStream::wsPreview, encoding);
733 void InsetMathHull::initUnicodeMath() const
735 // Trigger classification of the unicode symbols in this inset
736 docstring const dummy = latexString(*this);
740 void InsetMathHull::addPreview(DocIterator const & inset_pos,
741 graphics::PreviewLoader & /*ploader*/) const
743 if (RenderPreview::previewMath()) {
744 preparePreview(inset_pos);
749 void InsetMathHull::usedMacros(MathData const & md, DocIterator const & pos,
750 MacroNameSet & macros, MacroNameSet & defs) const
752 MacroNameSet::iterator const end = macros.end();
754 for (size_t i = 0; i < md.size(); ++i) {
755 InsetMathMacro const * mi = md[i].nucleus()->asMacro();
756 InsetMathMacroTemplate const * mt = md[i].nucleus()->asMacroTemplate();
757 InsetMathScript const * si = md[i].nucleus()->asScriptInset();
758 InsetMathFracBase const * fi = md[i].nucleus()->asFracBaseInset();
759 InsetMathGrid const * gi = md[i].nucleus()->asGridInset();
760 InsetMathNest const * ni = md[i].nucleus()->asNestInset();
762 // Look for macros in the arguments of this macro.
763 for (idx_type idx = 0; idx < mi->nargs(); ++idx)
764 usedMacros(mi->cell(idx), pos, macros, defs);
765 // Make sure this is a macro defined in the document
766 // (as we also spot the macros in the symbols file)
767 // or that we have not already accounted for it.
768 docstring const name = mi->name();
769 if (macros.find(name) == end)
772 // Look for macros in the definition of this macro.
773 MathData ar(pos.buffer());
774 MacroData const * data =
775 pos.buffer()->getMacro(name, pos, true);
777 odocstringstream macro_def;
778 data->write(macro_def, true);
780 defs.insert(macro_def.str());
781 asArray(data->definition(), ar);
783 usedMacros(ar, pos, macros, defs);
785 MathData ar(pos.buffer());
786 asArray(mt->definition(), ar);
787 usedMacros(ar, pos, macros, defs);
789 if (!si->nuc().empty())
790 usedMacros(si->nuc(), pos, macros, defs);
792 usedMacros(si->down(), pos, macros, defs);
794 usedMacros(si->up(), pos, macros, defs);
795 } else if (fi || gi) {
796 idx_type nidx = fi ? fi->nargs() : gi->nargs();
797 for (idx_type idx = 0; idx < nidx; ++idx)
798 usedMacros(fi ? fi->cell(idx) : gi->cell(idx),
801 usedMacros(ni->cell(0), pos, macros, defs);
807 void InsetMathHull::preparePreview(DocIterator const & pos,
808 bool forexport) const
810 // there is no need to do all the macro stuff if we're not
811 // actually going to generate the preview.
812 if (!RenderPreview::previewMath() && !forexport)
815 Buffer const * buffer = pos.buffer();
817 // collect macros at this position
819 buffer->listMacroNames(macros);
821 // collect definitions only for the macros used in this inset
823 for (idx_type idx = 0; idx < nargs(); ++idx)
824 usedMacros(cell(idx), pos, macros, defs);
826 MacroNameSet::iterator it = defs.begin();
827 MacroNameSet::iterator end = defs.end();
828 docstring macro_preamble;
829 for (; it != end; ++it)
830 macro_preamble.append(*it);
832 // set the font series and size for this snippet
833 DocIterator dit = pos.getInnerText();
834 Paragraph const & par = dit.paragraph();
835 Font font = par.getFontSettings(buffer->params(), dit.pos());
836 font.fontInfo().realize(par.layout().font);
837 string const lsize = font.latexSize();
840 if (font.fontInfo().series() == BOLD_SERIES) {
841 setfont += from_ascii("\\textbf{");
844 if (lsize != "normalsize" && !prefixIs(lsize, "error"))
845 setfont += from_ascii("\\" + lsize + '\n');
848 if (forexport && haveNumbers()) {
849 docstring eqstr = from_ascii("equation");
850 CounterMap::const_iterator it = counter_map.find(eqstr);
851 if (it != counter_map.end()) {
852 int num = it->second;
854 setcnt += from_ascii("\\setcounter{") + eqstr + '}' +
855 '{' + convert<docstring>(num) + '}' + '\n';
857 for (size_t i = 0; i != numcnts; ++i) {
858 docstring cnt = from_ascii(counters_to_save[i]);
859 it = counter_map.find(cnt);
860 if (it == counter_map.end())
862 int num = it->second;
864 setcnt += from_ascii("\\setcounter{") + cnt + '}' +
865 '{' + convert<docstring>(num) + '}';
868 docstring const snippet = macro_preamble + setfont + setcnt
869 + latexString(*this) + endfont;
870 LYXERR(Debug::MACROS, "Preview snippet: " << snippet);
871 preview_->addPreview(snippet, *buffer, forexport);
875 void InsetMathHull::reloadPreview(DocIterator const & pos) const
878 preview_->startLoading(*pos.buffer());
882 void InsetMathHull::loadPreview(DocIterator const & pos) const
884 bool const forexport = true;
885 preparePreview(pos, forexport);
886 preview_->startLoading(*pos.buffer(), forexport);
890 bool InsetMathHull::notifyCursorLeaves(Cursor const & old, Cursor & cur)
892 if (RenderPreview::previewMath()) {
894 cur.screenUpdateFlags(Update::Force);
900 docstring InsetMathHull::label(row_type row) const
902 LASSERT(row < nrows(), return docstring());
903 if (InsetLabel * il = label_[row])
904 return il->screenLabel();
909 void InsetMathHull::label(row_type row, docstring const & label)
911 //lyxerr << "setting label '" << label << "' for row " << row << endl;
915 label_[row] = dummy_pointer;
918 label_[row]->updateLabelAndRefs(label);
920 label_[row]->setParam("name", label);
924 InsetCommandParams p(LABEL_CODE);
926 label_[row] = new InsetLabel(buffer_, p);
928 label_[row]->setBuffer(buffer());
932 void InsetMathHull::numbered(row_type row, Numbered num)
934 numbered_[row] = num;
935 if (!numbered(row) && label_[row]) {
942 bool InsetMathHull::numbered(row_type row) const
944 return numbered_[row] == NUMBER;
948 bool InsetMathHull::ams() const
968 for (size_t row = 0; row < numbered_.size(); ++row)
969 if (numbered_[row] == NOTAG)
975 bool InsetMathHull::outerDisplay() const
998 Inset::DisplayType InsetMathHull::display() const
1015 if (buffer().params().is_math_indent)
1025 int InsetMathHull::indent(BufferView const & bv) const
1027 // FIXME: set this in the textclass. This value is what the article class uses.
1028 static Length default_indent(2.5, Length::EM);
1029 if (buffer().params().is_math_indent) {
1030 Length const & len = buffer().params().getMathIndent();
1032 return bv.inPixels(default_indent);
1034 return bv.inPixels(len);
1036 return Inset::indent(bv);
1040 bool InsetMathHull::numberedType() const
1059 for (row_type row = 0; row < nrows(); ++row)
1066 void InsetMathHull::validate(LaTeXFeatures & features) const
1068 if (features.runparams().isLaTeX()) {
1070 features.require("amsmath");
1072 if (type_ == hullRegexp) {
1073 features.require("color");
1074 docstring frcol = from_utf8(lcolor.getLaTeXName(Color_regexpframe));
1075 docstring bgcol = from_ascii("white");
1076 features.addPreambleSnippet(
1077 "\\newcommand{\\regexp}[1]{\\fcolorbox{"
1079 + bgcol + "}{\\ensuremath{\\mathtt{#1}}}}");
1080 features.addPreambleSnippet(
1081 from_ascii("\\newcommand{\\endregexp}{}"));
1082 } else if (outerDisplay() && features.inDeletedInset()
1083 && !features.mustProvide("ct-dvipost")) {
1084 features.require("ct-tikz-math-sout");
1087 // Validation is necessary only if not using AMS math.
1088 // To be safe, we will always run mathedvalidate.
1089 //if (features.amsstyle)
1092 //features.binom = true;
1093 } else if (features.runparams().math_flavor == OutputParams::MathAsHTML) {
1094 // it would be better to do this elsewhere, but we can't validate in
1095 // InsetMathMatrix and we have no way, outside MathExtern, to know if
1096 // we even have any matrices.
1097 features.addCSSSnippet(
1098 "table.matrix{display: inline-block; vertical-align: middle; text-align:center;}\n"
1099 "table.matrix td{padding: 0.25px;}\n"
1100 "td.ldelim{width: 0.5ex; border: thin solid black; border-right: none;}\n"
1101 "td.rdelim{width: 0.5ex; border: thin solid black; border-left: none;}");
1103 InsetMathGrid::validate(features);
1107 void InsetMathHull::header_write(WriteStream & os) const
1109 bool n = numberedType();
1120 if (cell(0).empty())
1125 writeMathdisplayPreamble(os);
1129 os << "\\begin{equation" << star(n) << "}\n";
1139 writeMathdisplayPreamble(os);
1142 os << "\\begin{" << hullName(type_) << star(n) << "}\n";
1149 os << "\\begin{" << hullName(type_) << star(n) << '}'
1150 << '{' << static_cast<unsigned int>((ncols() + 1)/2) << "}\n";
1156 os << "\\begin{" << hullName(type_) << '}'
1157 << '{' << static_cast<unsigned int>((ncols() + 1)/2) << "}\n";
1167 os << "\\begin{unknown" << star(n) << "}\n";
1173 void InsetMathHull::footer_write(WriteStream & os) const
1175 bool n = numberedType();
1192 os << "\\end{equation" << star(n) << "}\n";
1195 writeMathdisplayPostamble(os);
1205 os << "\\end{" << hullName(type_) << star(n) << "}\n";
1206 writeMathdisplayPostamble(os);
1213 os << "\\end{" << hullName(type_) << star(n) << "}\n";
1219 os << "\\end{" << hullName(type_) << "}\n";
1223 // Only used as a heuristic to find the regexp termination, when searching in ignore-format mode
1224 os << "\\endregexp{}}";
1230 os << "\\end{unknown" << star(n) << "}\n";
1236 bool InsetMathHull::allowsTabularFeatures() const
1259 bool InsetMathHull::rowChangeOK() const
1262 type_ == hullEqnArray || type_ == hullAlign ||
1263 type_ == hullFlAlign || type_ == hullAlignAt ||
1264 type_ == hullXAlignAt || type_ == hullXXAlignAt ||
1265 type_ == hullGather || type_ == hullMultline;
1269 bool InsetMathHull::colChangeOK() const
1272 type_ == hullAlign || type_ == hullFlAlign ||type_ == hullAlignAt ||
1273 type_ == hullXAlignAt || type_ == hullXXAlignAt;
1277 void InsetMathHull::addRow(row_type row)
1282 bool numbered = numberedType();
1283 // Move the number and raw pointer, do not call label() (bug 7511)
1284 InsetLabel * label = dummy_pointer;
1285 docstring number = empty_docstring();
1286 if (type_ == hullMultline) {
1287 if (row + 1 == nrows()) {
1288 numbered_[row] = NONUMBER;
1289 swap(label, label_[row]);
1290 swap(number, numbers_[row]);
1295 numbered_.insert(numbered_.begin() + row + 1, numbered ? NUMBER : NONUMBER);
1296 numbers_.insert(numbers_.begin() + row + 1, number);
1297 label_.insert(label_.begin() + row + 1, label);
1298 InsetMathGrid::addRow(row);
1302 void InsetMathHull::swapRow(row_type row)
1306 if (row + 1 == nrows())
1308 swap(numbered_[row], numbered_[row + 1]);
1309 swap(numbers_[row], numbers_[row + 1]);
1310 swap(label_[row], label_[row + 1]);
1311 InsetMathGrid::swapRow(row);
1315 void InsetMathHull::delRow(row_type row)
1317 if (nrows() <= 1 || !rowChangeOK())
1319 if (row + 1 == nrows() && type_ == hullMultline) {
1320 swap(numbered_[row - 1], numbered_[row]);
1321 swap(numbers_[row - 1], numbers_[row]);
1322 swap(label_[row - 1], label_[row]);
1323 InsetMathGrid::delRow(row);
1326 InsetMathGrid::delRow(row);
1327 // The last dummy row has no number info nor a label.
1328 // Test nrows() + 1 because we have already erased the row.
1329 if (row == nrows() + 1)
1331 numbered_.erase(numbered_.begin() + row);
1332 numbers_.erase(numbers_.begin() + row);
1334 label_.erase(label_.begin() + row);
1338 void InsetMathHull::addCol(col_type col)
1342 InsetMathGrid::addCol(col);
1346 void InsetMathHull::delCol(col_type col)
1348 if (ncols() <= 1 || !colChangeOK())
1350 InsetMathGrid::delCol(col);
1354 docstring InsetMathHull::nicelabel(row_type row) const
1358 docstring const & val = numbers_[row];
1360 return '(' + val + ')';
1361 return '(' + val + ',' + label_[row]->screenLabel() + ')';
1365 void InsetMathHull::glueall(HullType type)
1368 for (idx_type i = 0; i < nargs(); ++i)
1370 InsetLabel * label = 0;
1371 if (type == hullEquation) {
1372 // preserve first non-empty label
1373 for (row_type row = 0; row < nrows(); ++row) {
1375 label = label_[row];
1381 *this = InsetMathHull(buffer_, hullSimple);
1388 void InsetMathHull::splitTo2Cols()
1390 LASSERT(ncols() == 1, return);
1391 InsetMathGrid::addCol(1);
1392 for (row_type row = 0; row < nrows(); ++row) {
1393 idx_type const i = 2 * row;
1394 pos_type pos = firstRelOp(cell(i));
1395 cell(i + 1) = MathData(buffer_, cell(i).begin() + pos, cell(i).end());
1396 cell(i).erase(pos, cell(i).size());
1401 void InsetMathHull::splitTo3Cols()
1403 LASSERT(ncols() < 3, return);
1406 InsetMathGrid::addCol(2);
1407 for (row_type row = 0; row < nrows(); ++row) {
1408 idx_type const i = 3 * row + 1;
1409 if (!cell(i).empty()) {
1410 cell(i + 1) = MathData(buffer_, cell(i).begin() + 1, cell(i).end());
1411 cell(i).erase(1, cell(i).size());
1417 void InsetMathHull::changeCols(col_type cols)
1419 if (ncols() == cols)
1421 else if (ncols() < cols) {
1427 while (ncols() < cols)
1428 InsetMathGrid::addCol(ncols());
1434 for (row_type row = 0; row < nrows(); ++row) {
1435 idx_type const i = row * ncols();
1436 for (col_type col = cols; col < ncols(); ++col) {
1437 cell(i + cols - 1).append(cell(i + col));
1441 while (ncols() > cols) {
1442 InsetMathGrid::delCol(ncols() - 1);
1447 HullType InsetMathHull::getType() const
1453 void InsetMathHull::setType(HullType type)
1460 bool InsetMathHull::isMutable(HullType type)
1484 void InsetMathHull::mutate(HullType newtype)
1486 //lyxerr << "mutating from '" << type_ << "' to '" << newtype << "'" << endl;
1488 if (newtype == type_)
1491 // This guards the algorithm below it, which is designed with certain types
1493 if (!isMutable(newtype) || !isMutable(type_)) {
1494 lyxerr << "mutation from '" << to_utf8(hullName(type_))
1495 << "' to '" << to_utf8(hullName(newtype))
1496 << "' not implemented" << endl;
1500 // we try to move along the chain
1501 // none <-> simple <-> equation <-> eqnarray -> *align* -> multline, gather -+
1503 // +-------------------------------------+
1504 // we use eqnarray as intermediate type for mutations that are not
1505 // directly supported because it handles labels and numbering for
1510 setType(hullSimple);
1516 if (newtype == hullNone) {
1520 setType(hullEquation);
1521 numbered(0, label_[0] ? true : false);
1530 setType(hullSimple);
1535 // split it "nicely" on the first relop
1537 setType(hullEqnArray);
1545 // split it "nicely"
1580 setType(hullEqnArray);
1589 for (row_type row = 0; row < nrows(); ++row)
1590 numbered(row, false);
1600 for (row_type row = 0; row < nrows(); ++row)
1601 numbered(row, false);
1608 setType(hullEqnArray);
1638 for (row_type row = 0; row < nrows(); ++row)
1639 numbered(row, false);
1643 // first we mutate to EqnArray
1645 setType(hullEqnArray);
1652 // we passed the guard so we should not be here
1653 LASSERT("Mutation not implemented, but should have been.", return);
1659 docstring InsetMathHull::eolString(row_type row, bool fragile, bool latex,
1660 bool last_eoln) const
1663 if (numberedType()) {
1664 if (label_[row] && numbered(row)) {
1665 docstring const name =
1666 latex ? escape(label_[row]->getParam("name"))
1667 : label_[row]->getParam("name");
1668 res += "\\label{" + name + '}';
1670 if (type_ != hullMultline) {
1671 if (numbered_[row] == NONUMBER)
1672 res += "\\nonumber ";
1673 else if (numbered_[row] == NOTAG)
1677 // Never add \\ on the last empty line of eqnarray and friends
1679 return res + InsetMathGrid::eolString(row, fragile, latex, last_eoln);
1682 void InsetMathHull::write(WriteStream & os) const
1684 ModeSpecifier specifier(os, MATH_MODE);
1686 InsetMathGrid::write(os);
1691 void InsetMathHull::normalize(NormalStream & os) const
1693 os << "[formula " << hullName(type_) << ' ';
1694 InsetMathGrid::normalize(os);
1699 void InsetMathHull::infoize(odocstream & os) const
1701 os << bformat(_("Type: %1$s"), hullName(type_));
1705 void InsetMathHull::check() const
1707 LATTEST(numbered_.size() == nrows());
1708 LATTEST(numbers_.size() == nrows());
1709 LATTEST(label_.size() == nrows());
1713 void InsetMathHull::doExtern(Cursor & cur, FuncRequest & func)
1717 idocstringstream iss(func.argument());
1718 iss >> dlang >> extra;
1720 extra = from_ascii("noextra");
1721 string const lang = to_ascii(dlang);
1723 // replace selection with result of computation
1724 if (reduceSelectionToOneCell(cur)) {
1726 asArray(grabAndEraseSelection(cur), ar);
1727 lyxerr << "use selection: " << ar << endl;
1728 cur.insert(pipeThroughExtern(lang, extra, ar));
1732 // only inline, display or eqnarray math is allowed
1733 switch (getType()) {
1739 frontend::Alert::warning(_("Bad math environment"),
1740 _("Computation cannot be performed for AMS "
1741 "math environments.\nChange the math "
1742 "formula type and try again."));
1747 eq.push_back(MathAtom(new InsetMathChar('=')));
1749 // go to first item in line
1750 cur.idx() -= cur.idx() % ncols();
1753 if (getType() == hullSimple) {
1754 size_type pos = cur.cell().find_last(eq);
1756 if (pos == cur.cell().size()) {
1758 lyxerr << "use whole cell: " << ar << endl;
1760 ar = MathData(buffer_, cur.cell().begin() + pos + 1, cur.cell().end());
1761 lyxerr << "use partial cell form pos: " << pos << endl;
1763 cur.cell().append(eq);
1764 cur.cell().append(pipeThroughExtern(lang, extra, ar));
1765 cur.pos() = cur.lastpos();
1769 if (getType() == hullEquation) {
1770 lyxerr << "use equation inset" << endl;
1771 mutate(hullEqnArray);
1772 MathData & ar = cur.cell();
1773 lyxerr << "use cell: " << ar << endl;
1777 cur.cell() = pipeThroughExtern(lang, extra, ar);
1778 // move to end of line
1779 cur.pos() = cur.lastpos();
1784 lyxerr << "use eqnarray" << endl;
1785 cur.idx() += 2 - cur.idx() % ncols();
1787 MathData ar = cur.cell();
1788 lyxerr << "use cell: " << ar << endl;
1789 // FIXME: temporarily disabled
1795 cur.cell() = pipeThroughExtern(lang, extra, ar);
1796 cur.pos() = cur.lastpos();
1801 void InsetMathHull::doDispatch(Cursor & cur, FuncRequest & cmd)
1803 //lyxerr << "action: " << cmd.action() << endl;
1804 switch (cmd.action()) {
1806 case LFUN_FINISHED_BACKWARD:
1807 case LFUN_FINISHED_FORWARD:
1808 case LFUN_FINISHED_RIGHT:
1809 case LFUN_FINISHED_LEFT:
1810 //lyxerr << "action: " << cmd.action() << endl;
1811 InsetMathGrid::doDispatch(cur, cmd);
1814 case LFUN_PARAGRAPH_BREAK:
1815 // just swallow this
1818 case LFUN_NEWLINE_INSERT:
1819 // some magic for the common case
1820 if (type_ == hullSimple || type_ == hullEquation) {
1821 cur.recordUndoInset();
1823 cur.bv().buffer().params().use_package("amsmath") != BufferParams::package_off;
1824 mutate(align ? hullAlign : hullEqnArray);
1825 // mutate() may change labels and such.
1826 cur.forceBufferUpdate();
1827 cur.idx() = nrows() * ncols() - 1;
1828 cur.pos() = cur.lastpos();
1830 InsetMathGrid::doDispatch(cur, cmd);
1833 case LFUN_MATH_NUMBER_TOGGLE: {
1834 //lyxerr << "toggling all numbers" << endl;
1835 cur.recordUndoInset();
1836 bool old = numberedType();
1837 if (type_ == hullMultline)
1838 numbered(nrows() - 1, !old);
1840 for (row_type row = 0; row < nrows(); ++row)
1841 numbered(row, !old);
1843 cur.message(old ? _("No number") : _("Number"));
1844 cur.forceBufferUpdate();
1848 case LFUN_MATH_NUMBER_LINE_TOGGLE: {
1849 cur.recordUndoInset();
1850 row_type r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1851 bool old = numbered(r);
1852 cur.message(old ? _("No number") : _("Number"));
1854 cur.forceBufferUpdate();
1858 case LFUN_LABEL_INSERT: {
1859 row_type r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1860 docstring old_label = label(r);
1861 docstring const default_label = from_ascii("eq:");
1862 if (old_label.empty())
1863 old_label = default_label;
1865 InsetCommandParams p(LABEL_CODE);
1866 p["name"] = cmd.argument().empty() ? old_label : cmd.argument();
1867 string const data = InsetCommand::params2string(p);
1869 if (cmd.argument().empty())
1870 cur.bv().showDialog("label", data);
1872 FuncRequest fr(LFUN_INSET_INSERT, data);
1878 case LFUN_LABEL_COPY_AS_REFERENCE: {
1880 if (cmd.argument().empty() && &cur.inset() == this)
1881 // if there is no argument and we're inside math, we retrieve
1882 // the row number from the cursor position.
1883 row = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1885 // if there is an argument, find the corresponding label, else
1886 // check whether there is at least one label.
1887 for (row = 0; row != nrows(); ++row)
1888 if (numbered(row) && label_[row]
1889 && (cmd.argument().empty() || label(row) == cmd.argument()))
1896 InsetCommandParams p(REF_CODE, "ref");
1897 p["reference"] = label(row);
1898 cap::clearSelection();
1899 cap::copyInset(cur, new InsetRef(buffer_, p), label(row));
1903 case LFUN_WORD_DELETE_FORWARD:
1904 case LFUN_CHAR_DELETE_FORWARD:
1905 if (col(cur.idx()) + 1 == ncols()
1906 && cur.pos() == cur.lastpos()
1907 && !cur.selection()) {
1908 if (!label(row(cur.idx())).empty()) {
1909 cur.recordUndoInset();
1910 label(row(cur.idx()), docstring());
1911 } else if (numbered(row(cur.idx()))) {
1912 cur.recordUndoInset();
1913 numbered(row(cur.idx()), false);
1914 cur.forceBufferUpdate();
1916 InsetMathGrid::doDispatch(cur, cmd);
1920 InsetMathGrid::doDispatch(cur, cmd);
1925 case LFUN_INSET_INSERT: {
1926 //lyxerr << "arg: " << to_utf8(cmd.argument()) << endl;
1927 // FIXME: this should be cleaned up to use InsetLabel methods directly.
1928 string const name = cmd.getArg(0);
1929 if (name == "label") {
1930 InsetCommandParams p(LABEL_CODE);
1931 InsetCommand::string2params(to_utf8(cmd.argument()), p);
1932 docstring str = p["name"];
1933 cur.recordUndoInset();
1934 row_type const r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1938 docstring old = label(r);
1941 // The label will take care of the reference update.
1945 // Newly created inset so initialize it.
1946 label_[r]->initView();
1949 cur.forceBufferUpdate();
1952 InsetMathGrid::doDispatch(cur, cmd);
1956 case LFUN_MATH_EXTERN:
1957 cur.recordUndoInset();
1961 case LFUN_MATH_MUTATE: {
1962 cur.recordUndoInset();
1963 row_type row = cur.row();
1964 col_type col = cur.col();
1965 mutate(hullType(cmd.argument()));
1966 cur.idx() = row * ncols() + col;
1967 if (cur.idx() > cur.lastidx()) {
1968 cur.idx() = cur.lastidx();
1969 cur.pos() = cur.lastpos();
1971 if (cur.pos() > cur.lastpos())
1972 cur.pos() = cur.lastpos();
1974 cur.forceBufferUpdate();
1975 // FIXME: find some more clever handling of the selection,
1976 // i.e. preserve it.
1977 cur.clearSelection();
1978 //cur.dispatched(FINISHED);
1982 case LFUN_MATH_DISPLAY: {
1983 cur.recordUndoInset();
1984 mutate(type_ == hullSimple ? hullEquation : hullSimple);
1985 // if the cursor is in a cell that got merged, move it to
1986 // start of the hull inset.
1987 if (cur.idx() > 0) {
1991 if (cur.pos() > cur.lastpos())
1992 cur.pos() = cur.lastpos();
1997 case LFUN_TABULAR_FEATURE:
1998 if (!allowsTabularFeatures())
2001 InsetMathGrid::doDispatch(cur, cmd);
2005 InsetMathGrid::doDispatch(cur, cmd);
2013 bool allowDisplayMath(Cursor const & cur)
2015 LATTEST(cur.depth() > 1);
2016 Cursor tmpcur = cur;
2019 FuncRequest cmd(LFUN_MATH_DISPLAY);
2020 return tmpcur.getStatus(cmd, status) && status.enabled();
2026 bool InsetMathHull::getStatus(Cursor & cur, FuncRequest const & cmd,
2027 FuncStatus & status) const
2029 switch (cmd.action()) {
2030 case LFUN_FINISHED_BACKWARD:
2031 case LFUN_FINISHED_FORWARD:
2032 case LFUN_FINISHED_RIGHT:
2033 case LFUN_FINISHED_LEFT:
2036 case LFUN_NEWLINE_INSERT:
2037 case LFUN_MATH_EXTERN:
2039 status.setEnabled(true);
2042 // we never allow this in math, and we want to bind enter
2043 // to another actions in command-alternatives
2044 case LFUN_PARAGRAPH_BREAK:
2045 status.setEnabled(false);
2047 case LFUN_MATH_MUTATE: {
2048 HullType const ht = hullType(cmd.argument());
2049 status.setOnOff(type_ == ht);
2050 status.setEnabled(isMutable(ht) && isMutable(type_));
2052 if (ht != hullSimple && status.enabled())
2053 status.setEnabled(allowDisplayMath(cur));
2056 case LFUN_MATH_DISPLAY: {
2057 status.setEnabled(display() != Inline || allowDisplayMath(cur));
2058 status.setOnOff(display() != Inline);
2062 case LFUN_MATH_NUMBER_TOGGLE:
2063 // FIXME: what is the right test, this or the one of
2065 status.setEnabled(display() != Inline);
2066 status.setOnOff(numberedType());
2069 case LFUN_MATH_NUMBER_LINE_TOGGLE: {
2070 // FIXME: what is the right test, this or the one of
2072 bool const enable = (type_ == hullMultline)
2073 ? (nrows() - 1 == cur.row())
2074 : display() != Inline;
2075 row_type const r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
2076 status.setEnabled(enable);
2077 status.setOnOff(enable && numbered(r));
2081 case LFUN_LABEL_INSERT:
2082 status.setEnabled(type_ != hullSimple);
2085 case LFUN_LABEL_COPY_AS_REFERENCE: {
2086 bool enabled = false;
2088 if (cmd.argument().empty() && &cur.inset() == this) {
2089 // if there is no argument and we're inside math, we retrieve
2090 // the row number from the cursor position.
2091 row = (type_ == hullMultline) ? nrows() - 1 : cur.row();
2092 enabled = numberedType() && label_[row] && numbered(row);
2094 // if there is an argument, find the corresponding label, else
2095 // check whether there is at least one label.
2096 for (row_type row = 0; row != nrows(); ++row) {
2097 if (numbered(row) && label_[row] &&
2098 (cmd.argument().empty() || label(row) == cmd.argument())) {
2104 status.setEnabled(enabled);
2108 case LFUN_INSET_INSERT:
2109 if (cmd.getArg(0) == "label") {
2110 status.setEnabled(type_ != hullSimple);
2113 return InsetMathGrid::getStatus(cur, cmd, status);
2115 case LFUN_TABULAR_FEATURE: {
2116 if (!allowsTabularFeatures())
2118 string s = cmd.getArg(0);
2120 && (s == "append-row"
2121 || s == "delete-row"
2122 || s == "copy-row")) {
2123 status.message(bformat(
2124 from_utf8(N_("Can't change number of rows in '%1$s'")),
2126 status.setEnabled(false);
2130 && (s == "append-column"
2131 || s == "delete-column"
2132 || s == "copy-column")) {
2133 status.message(bformat(
2134 from_utf8(N_("Can't change number of columns in '%1$s'")),
2136 status.setEnabled(false);
2139 if (s == "add-vline-left" || s == "add-vline-right") {
2140 status.message(bformat(
2141 from_utf8(N_("Can't add vertical grid lines in '%1$s'")),
2143 status.setEnabled(false);
2146 if (s == "valign-top" || s == "valign-middle"
2147 || s == "valign-bottom" || s == "align-left"
2148 || s == "align-center" || s == "align-right") {
2149 status.setEnabled(false);
2152 return InsetMathGrid::getStatus(cur, cmd, status);
2156 return InsetMathGrid::getStatus(cur, cmd, status);
2161 int InsetMathHull::leftMargin() const
2163 return (getType() == hullSimple) ? 0 : InsetMathGrid::leftMargin();
2167 int InsetMathHull::rightMargin() const
2169 return (getType() == hullSimple) ? 0 : InsetMathGrid::rightMargin();
2173 int InsetMathHull::border() const
2175 return (getType() == hullSimple) ? 0 : InsetMathGrid::border();
2179 /////////////////////////////////////////////////////////////////////
2183 // simply scrap this function if you want
2184 void InsetMathHull::mutateToText()
2187 // translate to latex
2189 latex(os, false, false);
2190 string str = os.str();
2193 Text * lt = view_->cursor().innerText();
2194 string::const_iterator cit = str.begin();
2195 string::const_iterator end = str.end();
2196 for (; cit != end; ++cit)
2197 view_->getIntl()->getTransManager().TranslateAndInsert(*cit, lt);
2200 //dispatch(LFUN_ESCAPE);
2205 void InsetMathHull::handleFont(Cursor & cur, docstring const & arg,
2206 docstring const & font)
2208 // this whole function is a hack and won't work for incremental font
2211 if (cur.inset().asInsetMath()->name() == font)
2212 cur.handleFont(to_utf8(font));
2214 cur.handleNest(createInsetMath(font, cur.buffer()));
2220 void InsetMathHull::handleFont2(Cursor & cur, docstring const & arg)
2225 font.fromString(to_utf8(arg), b);
2226 if (font.fontInfo().color() != Color_inherit) {
2227 MathAtom at = MathAtom(new InsetMathColor(buffer_, true, font.fontInfo().color()));
2228 cur.handleNest(at, 0);
2233 void InsetMathHull::edit(Cursor & cur, bool front, EntryDirection entry_from)
2236 bool enter_front = (entry_from == Inset::ENTRY_DIRECTION_LEFT ||
2237 (entry_from == Inset::ENTRY_DIRECTION_IGNORE && front));
2238 enter_front ? idxFirst(cur) : idxLast(cur);
2239 // The inset formula dimension is not necessarily the same as the
2240 // one of the instant preview image, so we have to indicate to the
2241 // BufferView that a metrics update is needed.
2242 cur.screenUpdateFlags(Update::Force);
2246 void InsetMathHull::revealCodes(Cursor & cur) const
2248 if (!cur.inMathed())
2250 odocstringstream os;
2251 cur.info(os, false);
2252 cur.message(os.str());
2254 // write something to the minibuffer
2255 // translate to latex
2259 string str = os.str();
2261 string::size_type pos = 0;
2263 for (string::iterator it = str.begin(); it != str.end(); ++it) {
2266 else if (*it == '\0') {
2268 pos = it - str.begin();
2274 res = res.substr(pos - 30);
2275 if (res.size() > 60)
2276 res = res.substr(0, 60);
2282 /////////////////////////////////////////////////////////////////////
2286 bool InsetMathHull::searchForward(BufferView * bv, string const & str,
2289 // FIXME: completely broken
2290 static InsetMathHull * lastformula = 0;
2291 static CursorBase current = DocIterator(ibegin(nucleus()));
2293 static string laststr;
2295 if (lastformula != this || laststr != str) {
2296 //lyxerr << "reset lastformula to " << this << endl;
2299 current = ibegin(nucleus());
2301 mathed_parse_cell(ar, str, Parse::NORMAL, &buffer());
2305 //lyxerr << "searching '" << str << "' in " << this << ar << endl;
2307 for (DocIterator it = current; it != iend(nucleus()); increment(it)) {
2308 CursorSlice & top = it.back();
2309 MathData const & a = top.asInsetMath()->cell(top.idx_);
2310 if (a.matchpart(ar, top.pos_)) {
2311 bv->cursor().setSelection(it, ar.size());
2313 top.pos_ += ar.size();
2319 //lyxerr << "not found!" << endl;
2326 void InsetMathHull::write(ostream & os) const
2328 odocstringstream oss;
2329 otexrowstream ots(oss);
2330 WriteStream wi(ots, false, false, WriteStream::wsDefault);
2333 os << to_utf8(oss.str());
2337 void InsetMathHull::read(Lexer & lex)
2340 mathed_parse_normal(buffer_, at, lex, Parse::TRACKMACRO);
2341 operator=(*at->asHullInset());
2345 bool InsetMathHull::readQuiet(Lexer & lex)
2348 bool success = mathed_parse_normal(buffer_, at, lex, Parse::QUIET);
2350 operator=(*at->asHullInset());
2355 int InsetMathHull::plaintext(odocstringstream & os,
2356 OutputParams const & op, size_t max_length) const
2358 // disables ASCII-art for export of equations. See #2275.
2359 if (0 && display()) {
2363 TextPainter tpain(dim.width(), dim.height());
2364 drawT(tpain, 0, dim.ascent());
2366 // reset metrics cache to "real" values
2368 return tpain.textheight();
2371 odocstringstream oss;
2372 otexrowstream ots(oss);
2373 Encoding const * const enc = encodings.fromLyXName("utf8");
2374 WriteStream wi(ots, false, true, WriteStream::wsDefault, enc);
2377 if (type_ == hullRegexp)
2380 for (row_type r = 0; r < nrows(); ++r) {
2381 for (col_type c = 0; c < ncols(); ++c)
2382 wi << (c == 0 ? "" : "\t") << cell(index(r, c));
2383 // if it's for the TOC, we write just the first line
2384 // and do not include the newline.
2385 if (op.for_toc || op.for_tooltip || oss.str().size() >= max_length)
2387 if (r < nrows() - 1)
2391 docstring const str = oss.str();
2397 int InsetMathHull::docbook(odocstream & os, OutputParams const & runparams) const
2402 if (getType() == hullSimple)
2403 name = from_ascii("inlineequation");
2405 name = from_ascii("informalequation");
2407 docstring bname = name;
2408 if (!label(0).empty())
2409 bname += " id='" + sgml::cleanID(buffer(), runparams, label(0)) + "'";
2411 ++ms.tab(); ms.cr(); ms.os() << '<' << bname << '>';
2413 odocstringstream ls;
2415 if (runparams.flavor == OutputParams::XML) {
2416 ms << MTag("alt role='tex' ");
2417 // Workaround for db2latex: db2latex always includes equations with
2418 // \ensuremath{} or \begin{display}\end{display}
2419 // so we strip LyX' math environment
2420 WriteStream wi(ols, false, false, WriteStream::wsDefault, runparams.encoding);
2421 InsetMathGrid::write(wi);
2422 ms << from_utf8(subst(subst(to_utf8(ls.str()), "&", "&"), "<", "<"));
2427 InsetMathGrid::mathmlize(ms);
2430 ms << MTag("alt role='tex'");
2431 latex(ols, runparams);
2432 res = ols.texrow().rows();
2433 ms << from_utf8(subst(subst(to_utf8(ls.str()), "&", "&"), "<", "<"));
2437 ms << from_ascii("<graphic fileref=\"eqn/");
2438 if (!label(0).empty())
2439 ms << sgml::cleanID(buffer(), runparams, label(0));
2441 ms << sgml::uniqueID(from_ascii("anon"));
2443 if (runparams.flavor == OutputParams::XML)
2444 ms << from_ascii("\"/>");
2446 ms << from_ascii("\">");
2448 ms.cr(); --ms.tab(); ms.os() << "</" << name << '>';
2450 return ms.line() + res;
2454 bool InsetMathHull::haveNumbers() const
2456 bool havenumbers = false;
2457 // inline formulas are never numbered (bug 7351 part 3)
2458 if (getType() == hullSimple)
2460 for (size_t i = 0; i != numbered_.size(); ++i) {
2471 // We need to do something about alignment here.
2473 // This duplicates code from InsetMathGrid, but
2474 // we need access here to number information,
2475 // and we simply do not have that in InsetMathGrid.
2476 void InsetMathHull::htmlize(HtmlStream & os) const
2478 bool const havenumbers = haveNumbers();
2479 bool const havetable = havenumbers || nrows() > 1 || ncols() > 1;
2482 os << cell(index(0, 0));
2486 os << MTag("table", "class='mathtable'");
2487 for (row_type row = 0; row < nrows(); ++row) {
2489 for (col_type col = 0; col < ncols(); ++col) {
2491 os << cell(index(row, col));
2496 docstring const & num = numbers_[row];
2498 os << '(' << num << ')';
2503 os << ETag("table");
2507 // this duplicates code from InsetMathGrid, but
2508 // we need access here to number information,
2509 // and we simply do not have that in InsetMathGrid.
2510 void InsetMathHull::mathmlize(MathStream & os) const
2512 bool const havenumbers = haveNumbers();
2513 bool const havetable = havenumbers || nrows() > 1 || ncols() > 1;
2516 os << MTag("mtable");
2517 char const * const celltag = havetable ? "mtd" : "mrow";
2518 // FIXME There does not seem to be wide support at the moment
2519 // for mlabeledtr, so we have to use just mtr for now.
2520 // char const * const rowtag = havenumbers ? "mlabeledtr" : "mtr";
2521 char const * const rowtag = "mtr";
2522 for (row_type row = 0; row < nrows(); ++row) {
2525 for (col_type col = 0; col < ncols(); ++col) {
2527 << cell(index(row, col))
2533 docstring const & num = numbers_[row];
2535 os << '(' << num << ')';
2542 os << ETag("mtable");
2546 void InsetMathHull::mathAsLatex(WriteStream & os) const
2548 MathEnsurer ensurer(os, false);
2549 bool havenumbers = haveNumbers();
2550 bool const havetable = havenumbers || nrows() > 1 || ncols() > 1;
2553 os << cell(index(0, 0));
2557 os << "<table class='mathtable'>";
2558 for (row_type row = 0; row < nrows(); ++row) {
2560 for (col_type col = 0; col < ncols(); ++col) {
2561 os << "<td class='math'>";
2562 os << cell(index(row, col));
2567 docstring const & num = numbers_[row];
2569 os << '(' << num << ')';
2578 docstring InsetMathHull::xhtml(XHTMLStream & xs, OutputParams const & op) const
2580 BufferParams::MathOutput const mathtype =
2581 buffer().masterBuffer()->params().html_math_output;
2583 bool success = false;
2585 // we output all the labels just at the beginning of the equation.
2586 // this should be fine.
2587 for (size_t i = 0; i != label_.size(); ++i) {
2588 InsetLabel const * const il = label_[i];
2594 // FIXME Eventually we would like to do this inset by inset.
2595 if (mathtype == BufferParams::MathML) {
2596 odocstringstream os;
2601 } catch (MathExportException const &) {}
2603 if (getType() == hullSimple)
2604 xs << html::StartTag("math",
2605 "xmlns=\"http://www.w3.org/1998/Math/MathML\"", true);
2607 xs << html::StartTag("math",
2608 "display=\"block\" xmlns=\"http://www.w3.org/1998/Math/MathML\"", true);
2609 xs << XHTMLStream::ESCAPE_NONE
2611 << html::EndTag("math");
2613 } else if (mathtype == BufferParams::HTML) {
2614 odocstringstream os;
2619 } catch (MathExportException const &) {}
2621 string const tag = (getType() == hullSimple) ? "span" : "div";
2622 xs << html::StartTag(tag, "class='formula'", true)
2623 << XHTMLStream::ESCAPE_NONE
2625 << html::EndTag(tag);
2629 // what we actually want is this:
2631 // ((mathtype == BufferParams::MathML || mathtype == BufferParams::HTML)
2633 // || mathtype == BufferParams::Images
2635 // but what follows is equivalent, since we'll enter only if either (a) we
2636 // tried and failed with MathML or HTML or (b) didn't try yet at all but
2637 // aren't doing LaTeX.
2639 // so this is for Images.
2640 if (!success && mathtype != BufferParams::LaTeX) {
2641 graphics::PreviewImage const * pimage = 0;
2643 loadPreview(docit_);
2644 pimage = preview_->getPreviewImage(buffer());
2645 // FIXME Do we always have png?
2648 if (pimage || op.dryrun) {
2649 string const filename = pimage ? pimage->filename().onlyFileName()
2650 : "previewimage.png";
2652 // if we are not in the master buffer, then we need to see that the
2653 // generated image is copied there; otherwise, preview fails.
2654 Buffer const * mbuf = buffer().masterBuffer();
2655 if (mbuf != &buffer()) {
2656 string mbtmp = mbuf->temppath();
2657 FileName const mbufimg(support::addName(mbtmp, filename));
2658 pimage->filename().copyTo(mbufimg);
2660 // add the file to the list of files to be exported
2661 op.exportdata->addExternalFile("xhtml", pimage->filename());
2664 string const tag = (getType() == hullSimple) ? "span" : "div";
2666 << html::StartTag(tag, "style = \"text-align: center;\"")
2667 << html::CompTag("img", "src=\"" + filename + "\" alt=\"Mathematical Equation\"")
2668 << html::EndTag(tag)
2674 // so we'll pass this test if we've failed everything else, or
2675 // if mathtype was LaTeX, since we won't have entered any of the
2677 if (!success /* || mathtype != BufferParams::LaTeX */) {
2678 // Unfortunately, we cannot use latexString() because we do not want
2679 // $...$ or whatever.
2680 odocstringstream ls;
2681 otexrowstream ots(ls);
2682 WriteStream wi(ots, false, true, WriteStream::wsPreview);
2683 ModeSpecifier specifier(wi, MATH_MODE);
2685 docstring const latex = ls.str();
2687 // class='math' allows for use of jsMath
2688 // http://www.math.union.edu/~dpvc/jsMath/
2690 // probably should allow for some kind of customization here
2691 string const tag = (getType() == hullSimple) ? "span" : "div";
2692 xs << html::StartTag(tag, "class='math'")
2694 << html::EndTag(tag)
2701 void InsetMathHull::toString(odocstream & os) const
2703 odocstringstream ods;
2704 plaintext(ods, OutputParams(0));
2709 void InsetMathHull::forOutliner(docstring & os, size_t const, bool const) const
2711 odocstringstream ods;
2714 // FIXME: this results in spilling TeX into the LyXHTML output since the
2715 // outliner is used to generate the LyXHTML list of figures/etc.
2721 string InsetMathHull::contextMenuName() const
2723 return "context-math";
2727 void InsetMathHull::recordLocation(DocIterator const & di)
2733 bool InsetMathHull::canPaintChange(BufferView const &) const
2735 // We let RowPainter do it seamlessly for inline insets
2736 return display() != Inline;