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"
14 #include "InsetMathChar.h"
15 #include "InsetMathColor.h"
16 #include "InsetMathFrac.h"
17 #include "InsetMathNest.h"
18 #include "InsetMathScript.h"
19 #include "MathExtern.h"
20 #include "MathFactory.h"
21 #include "MathStream.h"
22 #include "MathSupport.h"
25 #include "BufferParams.h"
26 #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 "Paragraph.h"
42 #include "ParIterator.h"
45 #include "TextClass.h"
46 #include "TextPainter.h"
47 #include "TocBackend.h"
49 #include "insets/InsetLabel.h"
50 #include "insets/InsetRef.h"
51 #include "insets/RenderPreview.h"
53 #include "graphics/PreviewImage.h"
54 #include "graphics/PreviewLoader.h"
56 #include "frontends/alert.h"
57 #include "frontends/FontMetrics.h"
58 #include "frontends/Painter.h"
60 #include "support/convert.h"
61 #include "support/debug.h"
62 #include "support/gettext.h"
63 #include "support/filetools.h"
64 #include "support/lassert.h"
65 #include "support/lstrings.h"
66 #include "support/Changer.h"
71 using namespace lyx::support;
75 using cap::grabAndEraseSelection;
76 using cap::reduceSelectionToOneCell;
80 int getCols(HullType type)
105 // returns position of first relation operator in the array
106 // used for "intelligent splitting"
107 size_t firstRelOp(MathData const & ar)
109 for (MathData::const_iterator it = ar.begin(); it != ar.end(); ++it)
110 if ((*it)->mathClass() == MC_REL)
111 return it - ar.begin();
116 char const * star(bool numbered)
118 return numbered ? "" : "*";
122 // writes a preamble for underlined or struck out math display
123 void writeMathdisplayPreamble(TeXMathStream & os)
125 if (os.strikeoutMath())
128 if (os.ulemCmd() == TeXMathStream::UNDERLINE)
129 os << "\\raisebox{-\\belowdisplayshortskip}{"
130 "\\parbox[b]{\\linewidth}{";
131 else if (os.ulemCmd() == TeXMathStream::STRIKEOUT)
132 os << "\\parbox{\\linewidth}{";
136 // writes a postamble for underlined or struck out math display
137 void writeMathdisplayPostamble(TeXMathStream & os)
139 if (os.strikeoutMath())
142 if (os.ulemCmd() == TeXMathStream::UNDERLINE)
144 else if (os.ulemCmd() == TeXMathStream::STRIKEOUT)
151 static InsetLabel * dummy_pointer = 0;
153 InsetMathHull::InsetMathHull(Buffer * buf)
154 : InsetMathGrid(buf, 1, 1), type_(hullNone), numbered_(1, NONUMBER),
155 numbers_(1, empty_docstring()), label_(1, dummy_pointer),
156 preview_(new RenderPreview(this))
158 //lyxerr << "sizeof InsetMath: " << sizeof(InsetMath) << endl;
159 //lyxerr << "sizeof MetricsInfo: " << sizeof(MetricsInfo) << endl;
160 //lyxerr << "sizeof InsetMathChar: " << sizeof(InsetMathChar) << endl;
161 //lyxerr << "sizeof FontInfo: " << sizeof(FontInfo) << endl;
168 InsetMathHull::InsetMathHull(Buffer * buf, HullType type)
169 : InsetMathGrid(buf, getCols(type), 1), type_(type), numbered_(1, NONUMBER),
170 numbers_(1, empty_docstring()), label_(1, dummy_pointer),
171 preview_(new RenderPreview(this))
179 InsetMathHull::InsetMathHull(InsetMathHull const & other) : InsetMathGrid(other)
185 InsetMathHull::~InsetMathHull()
187 for (auto & i : label_)
192 Inset * InsetMathHull::clone() const
194 return new InsetMathHull(*this);
198 InsetMathHull & InsetMathHull::operator=(InsetMathHull const & other)
202 InsetMathGrid::operator=(other);
204 numbered_ = other.numbered_;
205 numbers_ = other.numbers_;
206 buffer_ = other.buffer_;
207 for (auto & i : label_)
209 label_ = other.label_;
210 for (size_t i = 0; i != label_.size(); ++i) {
212 label_[i] = new InsetLabel(*label_[i]);
214 preview_.reset(new RenderPreview(*other.preview_, this));
220 void InsetMathHull::setBuffer(Buffer & buffer)
222 InsetMathGrid::setBuffer(buffer);
224 for (size_t i = 0; i != label_.size(); ++i) {
226 label_[i]->setBuffer(buffer);
231 // FIXME This should really be controlled by the TOC level, or
232 // something of the sort.
234 const char * counters_to_save[] = {"section", "chapter"};
235 unsigned int const numcnts = sizeof(counters_to_save)/sizeof(char *);
239 void InsetMathHull::updateBuffer(ParIterator const & it, UpdateType utype, bool const deleted)
242 //FIXME: buffer_ should be set at creation for this inset! Problem is
243 // This inset is created at too many places (see Parser::parse1() in
248 // if any of the equations are numbered, then we want to save the values
249 // of some of the counters.
251 BufferParams const & bp = buffer_->params();
252 string const & lang = it->getParLanguage(bp)->code();
254 buffer_->masterBuffer()->params().documentClass().counters();
256 // right now, we only need to do this at export time
257 if (utype == OutputUpdate) {
258 for (size_t i = 0; i < numcnts; ++i) {
259 docstring const cnt = from_ascii(counters_to_save[i]);
260 if (cnts.hasCounter(cnt))
261 counter_map[cnt] = cnts.value(cnt);
265 // this has to be done separately
266 docstring const eqstr = from_ascii("equation");
267 if (cnts.hasCounter(eqstr)) {
268 if (utype == OutputUpdate)
269 counter_map[eqstr] = cnts.value(eqstr);
270 for (size_t i = 0; i != label_.size(); ++i) {
272 Paragraph const & par = it.paragraph();
273 if (!par.isDeleted(it.pos())) {
274 cnts.step(eqstr, utype);
275 numbers_[i] = cnts.theCounter(eqstr, lang);
277 numbers_[i] = from_ascii("#");
279 numbers_[i] = empty_docstring();
285 for (size_t i = 0; i != label_.size(); ++i) {
287 label_[i]->updateBuffer(it, utype, deleted);
290 InsetMathGrid::updateBuffer(it, utype, deleted);
294 void InsetMathHull::addToToc(DocIterator const & pit, bool output_active,
295 UpdateType utype, TocBackend & backend) const
298 //FIXME: buffer_ should be set at creation for this inset! Problem is
299 // This inset is created at too many places (see Parser::parse1() in
304 TocBuilder & b = backend.builder("equation");
305 // compute first and last item
306 row_type first = nrows();
307 for (row_type row = 0; row != nrows(); ++row)
312 if (first == nrows())
315 row_type last = nrows() - 1;
316 for (; last != 0; --last)
319 // add equation numbers
320 b.pushItem(pit, docstring(), output_active);
322 b.argumentItem(bformat(from_ascii("(%1$s-%2$s)"),
323 numbers_[first], numbers_[last]));
324 for (row_type row = 0; row != nrows(); ++row) {
328 label_[row]->addToToc(pit, output_active, utype, backend);
329 docstring label = nicelabel(row);
331 // this is the only equation
332 b.argumentItem(label);
334 // insert as sub-items
335 b.pushItem(pit, label, output_active);
343 Inset * InsetMathHull::editXY(Cursor & cur, int x, int y)
345 if (previewState(&cur.bv())) {
349 return InsetMathNest::editXY(cur, x, y);
353 InsetMath::mode_type InsetMathHull::currentMode() const
357 return UNDECIDED_MODE;
359 // definitely math mode ...
379 // FIXME: InsetMathGrid should be changed to let the real column alignment be
380 // given by a virtual method like displayColAlign, because the values produced
381 // by defaultColAlign can be invalidated by lfuns such as add-column. For the
382 // moment the values produced by defaultColAlign are not used, notably because
383 // alignment is not implemented in the LyXHTML output.
384 char InsetMathHull::defaultColAlign(col_type col)
386 return colAlign(type_, col);
390 char InsetMathHull::displayColAlign(idx_type idx) const
394 row_type const r = row(idx);
397 if (r == nrows() - 1)
408 return colAlign(type_, col(idx));
412 return InsetMathGrid::displayColAlign(idx);
416 int InsetMathHull::displayColSpace(col_type col) const
418 return colSpace(type_, col);
422 // FIXME: same comment as for defaultColAlign applies.
423 int InsetMathHull::defaultColSpace(col_type col)
425 return colSpace(type_, col);
429 string InsetMathHull::standardFont() const
435 return "lyxnochange";
442 ColorCode InsetMathHull::standardColor() const
447 return Color_foreground;
455 bool InsetMathHull::previewState(const BufferView *const bv) const
457 if (!editing(bv) && RenderPreview::previewMath()
458 && type_ != hullRegexp)
460 graphics::PreviewImage const * pimage =
461 preview_->getPreviewImage(bv->buffer());
462 return pimage && pimage->image();
469 const int ERROR_FRAME_WIDTH = 2;
471 bool previewTooSmall(Dimension const & dim)
473 return dim.width() <= 10 && dim.height() <= 10;
478 void InsetMathHull::metrics(MetricsInfo & mi, Dimension & dim) const
480 /* Compute \(above|below)displayskip
481 true value in LaTeX is 10pt plus 2pt minus 5pt (in normal size at 10pt)
482 But we use a fixed number of pixels and scale them with zoom.
484 int const bottom_display_margin = mi.base.bv->zoomedPixels(6);
485 int top_display_margin = bottom_display_margin;
486 // at start of paragraph, add an empty line
488 top_display_margin += theFontMetrics(mi.base.font).maxHeight() + 2;
490 if (previewState(mi.base.bv)) {
491 preview_->metrics(mi, dim);
492 if (previewTooSmall(dim)) {
493 // preview image is too small
494 dim.wid += 2 * ERROR_FRAME_WIDTH;
495 dim.asc += 2 * ERROR_FRAME_WIDTH;
497 // insert a gap in front of the formula
498 // value was hardcoded to 1 pixel
499 dim.wid += mi.base.bv->zoomedPixels(1) ;
501 dim.asc += top_display_margin;
502 dim.des += bottom_display_margin;
509 Changer dummy1 = mi.base.changeFontSet(standardFont());
510 Changer dummy2 = mi.base.font.changeStyle(display() ? DISPLAY_STYLE
513 // let the cells adjust themselves
514 InsetMathGrid::metrics(mi, dim);
517 // Check whether the numbering interferes with the equations
518 if (numberedType()) {
519 BufferParams::MathNumber const math_number = buffer().params().getMathNumber();
520 int extra_offset = 0;
521 for (row_type row = 0; row < nrows(); ++row) {
522 rowinfo(row).offset[mi.base.bv] += extra_offset;
525 docstring const nl = nicelabel(row);
527 mathed_string_dim(mi.base.font, nl, dimnl);
528 int const ind = indent(*mi.base.bv);
529 int const x = ind ? ind : (mi.base.textwidth - dim.wid) / 2;
530 // for some reason metrics does not trigger at the
531 // same point as draw, and therefore we use >= instead of >
532 if ((math_number == BufferParams::LEFT && dimnl.wid >= x)
533 || (math_number == BufferParams::RIGHT
534 && dimnl.wid >= mi.base.textwidth - x - dim.wid)) {
535 extra_offset += dimnl.height();
538 dim.des += extra_offset;
543 dim.asc += top_display_margin;
544 dim.des += bottom_display_margin;
547 // reserve some space for marker.
552 ColorCode InsetMathHull::backgroundColor(PainterInfo const & pi) const
554 BufferView const * const bv = pi.base.bv;
555 if (previewState(bv)) {
556 Dimension const dim = dimension(*pi.base.bv);
557 if (previewTooSmall(dim))
559 return graphics::PreviewLoader::backgroundColor();
565 void InsetMathHull::drawMarkers(PainterInfo & pi, int x, int y) const
567 ColorCode pen_color = mouseHovered(pi.base.bv) || editing(pi.base.bv)?
568 Color_mathframe : Color_mathcorners;
569 // If the corners have the same color as the background, do not paint them.
570 if (lcolor.getX11HexName(Color_mathbg) == lcolor.getX11HexName(pen_color))
573 Inset::drawMarkers(pi, x, y);
574 Dimension const dim = dimension(*pi.base.bv);
575 int const t = x + dim.width() - 1;
576 int const a = y - dim.ascent();
577 pi.pain.line(x, a + 3, x, a, pen_color);
578 pi.pain.line(t, a + 3, t, a, pen_color);
579 pi.pain.line(x, a, x + 3, a, pen_color);
580 pi.pain.line(t - 3, a, t, a, pen_color);
584 void InsetMathHull::drawBackground(PainterInfo & pi, int x, int y) const
586 Dimension const dim = dimension(*pi.base.bv);
587 if (previewTooSmall(dim)) {
588 pi.pain.fillRectangle(x, y - 2 * ERROR_FRAME_WIDTH,
589 dim.wid, dim.asc + dim.des, backgroundColor(pi));
592 // If there are numbers, the margins around the (displayed)
593 // equation have to be cleared.
595 pi.pain.fillRectangle(pi.leftx, y - dim.asc,
596 pi.rightx - pi.leftx, dim.height(), pi.background_color);
597 pi.pain.fillRectangle(x + 1, y - dim.asc + 1, dim.wid - 2,
598 dim.asc + dim.des - 1, pi.backgroundColor(this));
602 void InsetMathHull::draw(PainterInfo & pi, int x, int y) const
604 BufferView const * const bv = pi.base.bv;
605 Dimension const dim = dimension(*bv);
607 if (type_ == hullRegexp)
608 pi.pain.rectangle(x + 2, y - dim.ascent() + 1,
609 dim.width() - 3, dim.height() - 2, Color_regexpframe);
611 if (previewState(bv)) {
612 // Do not draw change tracking cue if taken care of by RowPainter
614 Changer dummy = !canPaintChange(*bv) ? changeVar(pi.change, Change())
616 if (previewTooSmall(dim)) {
617 // we have an extra frame
618 preview_->draw(pi, x + ERROR_FRAME_WIDTH, y);
620 // one pixel gap in front
621 // value was hardcoded to 1 pixel
622 int const gap = pi.base.bv->zoomedPixels(1) ;
623 preview_->draw(pi, x + gap, y);
628 // First draw the numbers
629 ColorCode color = pi.selected && lyxrc.use_system_colors
630 ? Color_selectiontext : standardColor();
631 bool const really_change_color = pi.base.font.color() == Color_none;
632 Changer dummy0 = really_change_color ? pi.base.font.changeColor(color)
634 if (numberedType()) {
635 BufferParams::MathNumber const math_number = buffer().params().getMathNumber();
636 for (row_type row = 0; row < nrows(); ++row) {
637 int yy = y + rowinfo(row).offset[bv];
638 docstring const nl = nicelabel(row);
640 mathed_string_dim(pi.base.font, nl, dimnl);
641 if (math_number == BufferParams::LEFT) {
642 if (dimnl.wid > x - pi.leftx)
643 yy += rowinfo(row).descent + dimnl.asc;
644 pi.draw(pi.leftx, yy, nl);
646 if (dimnl.wid > pi.rightx - x - dim.wid)
647 yy += rowinfo(row).descent + dimnl.asc;
648 pi.draw(pi.rightx - dimnl.wid, yy, nl);
653 // Then the equations
654 Changer dummy1 = pi.base.changeFontSet(standardFont());
655 Changer dummy2 = pi.base.font.changeStyle(display() ? DISPLAY_STYLE
657 InsetMathGrid::draw(pi, x + 1, y);
658 drawMarkers(pi, x, y);
660 // drawing change line
661 if (canPaintChange(*bv)) {
663 int const display_margin = display() ? pi.base.inPixels(Length(12, Length::PT)) : 0;
664 pi.change.paintCue(pi, x + 1, y + 1 - dim.asc + display_margin,
665 x + dim.wid, y + dim.des - display_margin);
670 void InsetMathHull::metricsT(TextMetricsInfo const & mi, Dimension & dim) const
673 InsetMathGrid::metricsT(mi, dim);
676 otexrowstream ots(os);
677 TeXMathStream wi(ots, false, true, TeXMathStream::wsDefault);
679 dim.wid = os.str().size();
686 void InsetMathHull::drawT(TextPainter & pain, int x, int y) const
689 InsetMathGrid::drawT(pain, x, y);
692 otexrowstream ots(os);
693 TeXMathStream wi(ots, false, true, TeXMathStream::wsDefault);
695 pain.draw(x, y, os.str().c_str());
700 static docstring latexString(InsetMathHull const & inset)
703 // This has to be static, because a preview snippet or a math
704 // macro containing math in text mode (such as $\text{$\phi$}$ or
705 // \newcommand{\xxx}{\text{$\phi$}}) gets processed twice. The
706 // first time as a whole, and the second time only the inner math.
707 // In this last case inset.buffer() would be invalid.
708 static Encoding const * encoding = 0;
709 if (inset.isBufferValid())
710 encoding = &(inset.buffer().params().encoding());
711 otexrowstream ots(ls);
712 TeXMathStream wi(ots, false, true, TeXMathStream::wsPreview, encoding);
718 void InsetMathHull::initUnicodeMath() const
720 // Trigger classification of the unicode symbols in this inset
721 docstring const dummy = latexString(*this);
725 void InsetMathHull::addPreview(DocIterator const & inset_pos,
726 graphics::PreviewLoader & /*ploader*/) const
728 if (RenderPreview::previewMath()) {
729 preparePreview(inset_pos);
734 void InsetMathHull::usedMacros(MathData const & md, DocIterator const & pos,
735 MacroNameSet & macros, MacroNameSet & defs) const
737 MacroNameSet::iterator const end = macros.end();
739 for (size_t i = 0; i < md.size(); ++i) {
740 InsetMathMacro const * mi = md[i].nucleus()->asMacro();
741 InsetMathMacroTemplate const * mt = md[i].nucleus()->asMacroTemplate();
742 InsetMathScript const * si = md[i].nucleus()->asScriptInset();
743 InsetMathFracBase const * fi = md[i].nucleus()->asFracBaseInset();
744 InsetMathGrid const * gi = md[i].nucleus()->asGridInset();
745 InsetMathNest const * ni = md[i].nucleus()->asNestInset();
747 // Look for macros in the arguments of this macro.
748 for (idx_type idx = 0; idx < mi->nargs(); ++idx)
749 usedMacros(mi->cell(idx), pos, macros, defs);
750 // Make sure this is a macro defined in the document
751 // (as we also spot the macros in the symbols file)
752 // or that we have not already accounted for it.
753 docstring const name = mi->name();
754 if (macros.find(name) == end)
757 // Look for macros in the definition of this macro.
758 MathData ar(pos.buffer());
759 MacroData const * data =
760 pos.buffer()->getMacro(name, pos, true);
762 odocstringstream macro_def;
763 data->write(macro_def, true);
765 defs.insert(macro_def.str());
766 asArray(data->definition(), ar);
768 usedMacros(ar, pos, macros, defs);
770 MathData ar(pos.buffer());
771 asArray(mt->definition(), ar);
772 usedMacros(ar, pos, macros, defs);
774 if (!si->nuc().empty())
775 usedMacros(si->nuc(), pos, macros, defs);
777 usedMacros(si->down(), pos, macros, defs);
779 usedMacros(si->up(), pos, macros, defs);
780 } else if (fi || gi) {
781 idx_type nidx = fi ? fi->nargs() : gi->nargs();
782 for (idx_type idx = 0; idx < nidx; ++idx)
783 usedMacros(fi ? fi->cell(idx) : gi->cell(idx),
786 usedMacros(ni->cell(0), pos, macros, defs);
792 void InsetMathHull::preparePreview(DocIterator const & pos,
793 bool forexport) const
795 // there is no need to do all the macro stuff if we're not
796 // actually going to generate the preview.
797 if (!RenderPreview::previewMath() && !forexport)
800 Buffer const * buffer = pos.buffer();
802 // collect macros at this position
804 buffer->listMacroNames(macros);
806 // collect definitions only for the macros used in this inset
808 for (idx_type idx = 0; idx < nargs(); ++idx)
809 usedMacros(cell(idx), pos, macros, defs);
811 docstring macro_preamble;
812 for (auto const & defvar : defs)
813 macro_preamble.append(defvar);
815 // set the font series and size for this snippet
816 DocIterator dit = pos.getInnerText();
817 Paragraph const & par = dit.paragraph();
818 Font font = par.getFontSettings(buffer->params(), dit.pos());
819 font.fontInfo().realize(par.layout().font);
820 string const lsize = font.latexSize();
823 if (font.fontInfo().series() == BOLD_SERIES) {
824 setfont += from_ascii("\\textbf{");
827 if (lsize != "normalsize" && !prefixIs(lsize, "error"))
828 setfont += from_ascii("\\" + lsize + '\n');
831 if (forexport && haveNumbers()) {
832 docstring eqstr = from_ascii("equation");
833 CounterMap::const_iterator it = counter_map.find(eqstr);
834 if (it != counter_map.end()) {
835 int num = it->second;
837 setcnt += from_ascii("\\setcounter{") + eqstr + '}' +
838 '{' + convert<docstring>(num) + '}' + '\n';
840 for (size_t i = 0; i != numcnts; ++i) {
841 docstring cnt = from_ascii(counters_to_save[i]);
842 it = counter_map.find(cnt);
843 if (it == counter_map.end())
845 int num = it->second;
847 setcnt += from_ascii("\\setcounter{") + cnt + '}' +
848 '{' + convert<docstring>(num) + '}';
851 docstring const snippet = macro_preamble + setfont + setcnt
852 + latexString(*this) + endfont;
853 LYXERR(Debug::MACROS, "Preview snippet: " << snippet);
854 preview_->addPreview(snippet, *buffer, forexport);
858 void InsetMathHull::reloadPreview(DocIterator const & pos) const
861 preview_->startLoading(*pos.buffer());
865 void InsetMathHull::loadPreview(DocIterator const & pos) const
867 bool const forexport = true;
868 preparePreview(pos, forexport);
869 preview_->startLoading(*pos.buffer(), forexport);
873 bool InsetMathHull::notifyCursorLeaves(Cursor const & old, Cursor & cur)
875 if (RenderPreview::previewMath()) {
877 cur.screenUpdateFlags(Update::Force);
883 docstring InsetMathHull::label(row_type row) const
885 LASSERT(row < nrows(), return docstring());
886 if (InsetLabel * il = label_[row])
887 return il->screenLabel();
892 void InsetMathHull::label(row_type row, docstring const & label)
894 //lyxerr << "setting label '" << label << "' for row " << row << endl;
898 label_[row] = dummy_pointer;
901 label_[row]->updateLabelAndRefs(label);
903 label_[row]->setParam("name", label);
907 InsetCommandParams p(LABEL_CODE);
909 label_[row] = new InsetLabel(buffer_, p);
911 label_[row]->setBuffer(buffer());
915 void InsetMathHull::numbered(row_type row, Numbered num)
917 numbered_[row] = num;
918 if (!numbered(row) && label_[row]) {
925 bool InsetMathHull::numbered(row_type row) const
927 return numbered_[row] == NUMBER;
931 bool InsetMathHull::ams() const
951 for (auto const & row : numbered_)
958 bool InsetMathHull::outerDisplay() const
981 Inset::RowFlags InsetMathHull::rowFlags() const
998 if (buffer().params().is_math_indent)
999 return Display | AlignLeft;
1008 int InsetMathHull::indent(BufferView const & bv) const
1010 // FIXME: set this in the textclass. This value is what the article class uses.
1011 static Length default_indent(2.5, Length::EM);
1012 if (display() && buffer().params().is_math_indent) {
1013 Length const & len = buffer().params().getMathIndent();
1015 return bv.inPixels(default_indent);
1017 return bv.inPixels(len);
1019 return Inset::indent(bv);
1023 bool InsetMathHull::numberedType() const
1042 for (row_type row = 0; row < nrows(); ++row)
1049 void InsetMathHull::validate(LaTeXFeatures & features) const
1051 if (features.runparams().isLaTeX()) {
1053 features.require("amsmath");
1055 if (type_ == hullRegexp) {
1056 features.require("color");
1057 docstring frcol = from_utf8(lcolor.getLaTeXName(Color_regexpframe));
1058 docstring bgcol = from_ascii("white");
1059 features.addPreambleSnippet(
1060 "\\newcommand{\\regexp}[1]{\\fcolorbox{"
1062 + bgcol + "}{\\ensuremath{\\mathtt{#1}}}}");
1063 features.addPreambleSnippet(
1064 from_ascii("\\newcommand{\\endregexp}{}"));
1065 } else if (outerDisplay() && features.inDeletedInset()) {
1066 features.require("tikz");
1067 features.require("ct-tikz-object-sout");
1070 // Validation is necessary only if not using AMS math.
1071 // To be safe, we will always run mathedvalidate.
1072 //if (features.amsstyle)
1075 //features.binom = true;
1076 } else if (features.runparams().math_flavor == OutputParams::MathAsHTML) {
1077 // it would be better to do this elsewhere, but we can't validate in
1078 // InsetMathMatrix and we have no way, outside MathExtern, to know if
1079 // we even have any matrices.
1080 features.addCSSSnippet(
1081 "table.matrix{display: inline-block; vertical-align: middle; text-align:center;}\n"
1082 "table.matrix td{padding: 0.25px;}\n"
1083 "td.ldelim{width: 0.5ex; border: thin solid black; border-right: none;}\n"
1084 "td.rdelim{width: 0.5ex; border: thin solid black; border-left: none;}");
1086 InsetMathGrid::validate(features);
1090 CtObject InsetMathHull::getCtObject(OutputParams const & runparams) const
1092 CtObject res = CtObject::Normal;
1108 case hullMultline: {
1109 if (runparams.inulemcmd
1110 && (!runparams.local_font || runparams.local_font->fontInfo().strikeout() != FONT_ON))
1111 res = CtObject::UDisplayObject;
1113 res = CtObject::DisplayObject;
1121 void InsetMathHull::header_write(TeXMathStream & os) const
1123 bool n = numberedType();
1134 if (cell(0).empty())
1139 writeMathdisplayPreamble(os);
1143 os << "\\begin{equation" << star(n) << "}\n";
1153 writeMathdisplayPreamble(os);
1156 os << "\\begin{" << hullName(type_) << star(n) << "}\n";
1163 os << "\\begin{" << hullName(type_) << star(n) << '}'
1164 << '{' << static_cast<unsigned int>((ncols() + 1)/2) << "}\n";
1170 os << "\\begin{" << hullName(type_) << '}'
1171 << '{' << static_cast<unsigned int>((ncols() + 1)/2) << "}\n";
1181 os << "\\begin{unknown" << star(n) << "}\n";
1187 void InsetMathHull::footer_write(TeXMathStream & os) const
1189 bool n = numberedType();
1206 os << "\\end{equation" << star(n) << "}\n";
1209 writeMathdisplayPostamble(os);
1219 os << "\\end{" << hullName(type_) << star(n) << "}\n";
1220 writeMathdisplayPostamble(os);
1227 os << "\\end{" << hullName(type_) << star(n) << "}\n";
1233 os << "\\end{" << hullName(type_) << "}\n";
1237 // Only used as a heuristic to find the regexp termination, when searching in ignore-format mode
1238 os << "\\endregexp{}}";
1244 os << "\\end{unknown" << star(n) << "}\n";
1250 bool InsetMathHull::allowsTabularFeatures() const
1273 bool InsetMathHull::rowChangeOK() const
1276 type_ == hullEqnArray || type_ == hullAlign ||
1277 type_ == hullFlAlign || type_ == hullAlignAt ||
1278 type_ == hullXAlignAt || type_ == hullXXAlignAt ||
1279 type_ == hullGather || type_ == hullMultline;
1283 bool InsetMathHull::colChangeOK() const
1286 type_ == hullAlign || type_ == hullFlAlign ||type_ == hullAlignAt ||
1287 type_ == hullXAlignAt || type_ == hullXXAlignAt;
1291 void InsetMathHull::addRow(row_type row)
1296 bool numbered = numberedType();
1297 // Move the number and raw pointer, do not call label() (bug 7511)
1298 InsetLabel * label = dummy_pointer;
1299 docstring number = empty_docstring();
1300 if (type_ == hullMultline) {
1301 if (row + 1 == nrows()) {
1302 numbered_[row] = NONUMBER;
1303 swap(label, label_[row]);
1304 swap(number, numbers_[row]);
1309 numbered_.insert(numbered_.begin() + row + 1, numbered ? NUMBER : NONUMBER);
1310 numbers_.insert(numbers_.begin() + row + 1, number);
1311 label_.insert(label_.begin() + row + 1, label);
1312 InsetMathGrid::addRow(row);
1316 void InsetMathHull::swapRow(row_type row)
1320 if (row + 1 == nrows())
1322 swap(numbered_[row], numbered_[row + 1]);
1323 swap(numbers_[row], numbers_[row + 1]);
1324 swap(label_[row], label_[row + 1]);
1325 InsetMathGrid::swapRow(row);
1329 void InsetMathHull::delRow(row_type row)
1331 if (nrows() <= 1 || !rowChangeOK())
1333 if (row + 1 == nrows() && type_ == hullMultline) {
1334 swap(numbered_[row - 1], numbered_[row]);
1335 swap(numbers_[row - 1], numbers_[row]);
1336 swap(label_[row - 1], label_[row]);
1337 InsetMathGrid::delRow(row);
1340 InsetMathGrid::delRow(row);
1341 // The last dummy row has no number info nor a label.
1342 // Test nrows() + 1 because we have already erased the row.
1343 if (row == nrows() + 1)
1345 numbered_.erase(numbered_.begin() + row);
1346 numbers_.erase(numbers_.begin() + row);
1348 label_.erase(label_.begin() + row);
1352 void InsetMathHull::addCol(col_type col)
1356 InsetMathGrid::addCol(col);
1360 void InsetMathHull::delCol(col_type col)
1362 if (ncols() <= 1 || !colChangeOK())
1364 InsetMathGrid::delCol(col);
1368 docstring InsetMathHull::nicelabel(row_type row) const
1372 docstring const & val = numbers_[row];
1374 return '(' + val + ')';
1375 return '(' + val + ',' + label_[row]->screenLabel() + ')';
1379 void InsetMathHull::glueall(HullType type)
1382 for (idx_type i = 0; i < nargs(); ++i)
1384 InsetLabel * label = 0;
1385 if (type == hullEquation) {
1386 // preserve first non-empty label
1387 for (row_type row = 0; row < nrows(); ++row) {
1389 label = label_[row];
1395 *this = InsetMathHull(buffer_, hullSimple);
1402 void InsetMathHull::splitTo2Cols()
1404 LASSERT(ncols() == 1, return);
1405 InsetMathGrid::addCol(1);
1406 for (row_type row = 0; row < nrows(); ++row) {
1407 idx_type const i = 2 * row;
1408 pos_type pos = firstRelOp(cell(i));
1409 cell(i + 1) = MathData(buffer_, cell(i).begin() + pos, cell(i).end());
1410 cell(i).erase(pos, cell(i).size());
1415 void InsetMathHull::splitTo3Cols()
1417 LASSERT(ncols() < 3, return);
1420 InsetMathGrid::addCol(2);
1421 for (row_type row = 0; row < nrows(); ++row) {
1422 idx_type const i = 3 * row + 1;
1423 if (!cell(i).empty()) {
1424 cell(i + 1) = MathData(buffer_, cell(i).begin() + 1, cell(i).end());
1425 cell(i).erase(1, cell(i).size());
1431 void InsetMathHull::changeCols(col_type cols)
1433 if (ncols() == cols)
1435 else if (ncols() < cols) {
1441 while (ncols() < cols)
1442 InsetMathGrid::addCol(ncols());
1448 for (row_type row = 0; row < nrows(); ++row) {
1449 idx_type const i = row * ncols();
1450 for (col_type col = cols; col < ncols(); ++col) {
1451 cell(i + cols - 1).append(cell(i + col));
1455 while (ncols() > cols) {
1456 InsetMathGrid::delCol(ncols() - 1);
1461 HullType InsetMathHull::getType() const
1467 void InsetMathHull::setType(HullType type)
1474 bool InsetMathHull::isMutable(HullType type)
1498 void InsetMathHull::mutate(HullType newtype)
1500 //lyxerr << "mutating from '" << type_ << "' to '" << newtype << "'" << endl;
1502 if (newtype == type_)
1505 // This guards the algorithm below it, which is designed with certain types
1507 if (!isMutable(newtype) || !isMutable(type_)) {
1508 lyxerr << "mutation from '" << to_utf8(hullName(type_))
1509 << "' to '" << to_utf8(hullName(newtype))
1510 << "' not implemented" << endl;
1514 // we try to move along the chain
1515 // none <-> simple <-> equation <-> eqnarray -> *align* -> multline, gather -+
1517 // +-------------------------------------+
1518 // we use eqnarray as intermediate type for mutations that are not
1519 // directly supported because it handles labels and numbering for
1524 setType(hullSimple);
1530 if (newtype == hullNone) {
1534 setType(hullEquation);
1535 numbered(0, label_[0] != nullptr);
1544 setType(hullSimple);
1549 // split it "nicely" on the first relop
1551 setType(hullEqnArray);
1559 // split it "nicely"
1594 setType(hullEqnArray);
1603 for (row_type row = 0; row < nrows(); ++row)
1604 numbered(row, false);
1614 for (row_type row = 0; row < nrows(); ++row)
1615 numbered(row, false);
1622 setType(hullEqnArray);
1652 for (row_type row = 0; row < nrows(); ++row)
1653 numbered(row, false);
1657 // first we mutate to EqnArray
1659 setType(hullEqnArray);
1666 // we passed the guard so we should not be here
1667 LYXERR0("Mutation not implemented, but should have been.");
1668 LASSERT(false, return);
1674 docstring InsetMathHull::eolString(row_type row, bool fragile, bool latex,
1675 bool last_eoln) const
1678 if (numberedType()) {
1679 if (label_[row] && numbered(row)) {
1680 docstring const name =
1681 latex ? escape(label_[row]->getParam("name"))
1682 : label_[row]->getParam("name");
1683 res += "\\label{" + name + '}';
1685 if (type_ != hullMultline) {
1686 if (numbered_[row] == NONUMBER)
1687 res += "\\nonumber ";
1688 else if (numbered_[row] == NOTAG)
1692 // Never add \\ on the last empty line of eqnarray and friends
1694 return res + InsetMathGrid::eolString(row, fragile, latex, last_eoln);
1697 void InsetMathHull::write(TeXMathStream & os) const
1699 ModeSpecifier specifier(os, MATH_MODE);
1701 InsetMathGrid::write(os);
1706 void InsetMathHull::normalize(NormalStream & os) const
1708 os << "[formula " << hullName(type_) << ' ';
1709 InsetMathGrid::normalize(os);
1714 void InsetMathHull::infoize(odocstream & os) const
1716 os << bformat(_("Type: %1$s"), hullName(type_));
1720 void InsetMathHull::check() const
1722 LATTEST(numbered_.size() == nrows());
1723 LATTEST(numbers_.size() == nrows());
1724 LATTEST(label_.size() == nrows());
1728 void InsetMathHull::doExtern(Cursor & cur, FuncRequest & func)
1730 //FIXME: sort out whether we want std::string or docstring for those
1731 string const lang = func.getArg(0);
1732 docstring extra = from_utf8(func.getArg(1));
1734 extra = from_ascii("noextra");
1736 // replace selection with result of computation
1737 if (reduceSelectionToOneCell(cur)) {
1739 asArray(grabAndEraseSelection(cur), ar);
1740 lyxerr << "use selection: " << ar << endl;
1741 cur.insert(pipeThroughExtern(lang, extra, ar));
1745 // only inline, display or eqnarray math is allowed
1746 switch (getType()) {
1752 frontend::Alert::warning(_("Bad math environment"),
1753 _("Computation cannot be performed for AMS "
1754 "math environments.\nChange the math "
1755 "formula type and try again."));
1760 eq.push_back(MathAtom(new InsetMathChar('=')));
1762 // go to first item in line
1763 cur.idx() -= cur.idx() % ncols();
1766 if (getType() == hullSimple) {
1767 size_type pos = cur.cell().find_last(eq);
1769 if (pos == cur.cell().size()) {
1771 lyxerr << "use whole cell: " << ar << endl;
1773 ar = MathData(buffer_, cur.cell().begin() + pos + 1, cur.cell().end());
1774 lyxerr << "use partial cell form pos: " << pos << endl;
1776 cur.cell().append(eq);
1777 cur.cell().append(pipeThroughExtern(lang, extra, ar));
1778 cur.pos() = cur.lastpos();
1782 if (getType() == hullEquation) {
1783 lyxerr << "use equation inset" << endl;
1784 mutate(hullEqnArray);
1785 MathData & ar = cur.cell();
1786 lyxerr << "use cell: " << ar << endl;
1790 cur.cell() = pipeThroughExtern(lang, extra, ar);
1791 // move to end of line
1792 cur.pos() = cur.lastpos();
1797 lyxerr << "use eqnarray" << endl;
1798 cur.idx() += 2 - cur.idx() % ncols();
1800 MathData ar = cur.cell();
1801 lyxerr << "use cell: " << ar << endl;
1802 // FIXME: temporarily disabled
1808 cur.cell() = pipeThroughExtern(lang, extra, ar);
1809 cur.pos() = cur.lastpos();
1814 void InsetMathHull::doDispatch(Cursor & cur, FuncRequest & cmd)
1816 //lyxerr << "action: " << cmd.action() << endl;
1817 switch (cmd.action()) {
1819 case LFUN_FINISHED_BACKWARD:
1820 case LFUN_FINISHED_FORWARD:
1821 case LFUN_FINISHED_RIGHT:
1822 case LFUN_FINISHED_LEFT:
1823 //lyxerr << "action: " << cmd.action() << endl;
1824 InsetMathGrid::doDispatch(cur, cmd);
1827 case LFUN_PARAGRAPH_BREAK:
1828 // just swallow this
1831 case LFUN_NEWLINE_INSERT:
1832 // some magic for the common case
1833 if (type_ == hullSimple || type_ == hullEquation) {
1834 cur.recordUndoInset();
1836 cur.bv().buffer().params().use_package("amsmath") != BufferParams::package_off;
1837 mutate(align ? hullAlign : hullEqnArray);
1838 // mutate() may change labels and such.
1839 cur.forceBufferUpdate();
1840 cur.idx() = nrows() * ncols() - 1;
1841 cur.pos() = cur.lastpos();
1843 InsetMathGrid::doDispatch(cur, cmd);
1846 case LFUN_MATH_NUMBER_TOGGLE: {
1847 //lyxerr << "toggling all numbers" << endl;
1848 cur.recordUndoInset();
1849 bool old = numberedType();
1850 if (type_ == hullMultline)
1851 numbered(nrows() - 1, !old);
1853 for (row_type row = 0; row < nrows(); ++row)
1854 numbered(row, !old);
1856 cur.message(old ? _("No number") : _("Number"));
1857 cur.forceBufferUpdate();
1861 case LFUN_MATH_NUMBER_LINE_TOGGLE: {
1862 cur.recordUndoInset();
1863 row_type r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1864 bool old = numbered(r);
1865 cur.message(old ? _("No number") : _("Number"));
1867 cur.forceBufferUpdate();
1871 case LFUN_LABEL_INSERT: {
1872 row_type r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1873 docstring old_label = label(r);
1874 docstring const default_label = from_ascii("eq:");
1875 if (old_label.empty())
1876 old_label = default_label;
1878 InsetCommandParams p(LABEL_CODE);
1879 p["name"] = cmd.argument().empty() ? old_label : cmd.argument();
1880 string const data = InsetCommand::params2string(p);
1882 if (cmd.argument().empty())
1883 cur.bv().showDialog("label", data);
1885 FuncRequest fr(LFUN_INSET_INSERT, data);
1891 case LFUN_LABEL_COPY_AS_REFERENCE: {
1893 if (cmd.argument().empty() && &cur.inset() == this)
1894 // if there is no argument and we're inside math, we retrieve
1895 // the row number from the cursor position.
1896 row = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1898 // if there is an argument, find the corresponding label, else
1899 // check whether there is at least one label.
1900 for (row = 0; row != nrows(); ++row)
1901 if (numbered(row) && label_[row]
1902 && (cmd.argument().empty() || label(row) == cmd.argument()))
1909 InsetCommandParams p(REF_CODE, "ref");
1910 p["reference"] = label(row);
1911 cap::clearSelection();
1912 cap::copyInset(cur, new InsetRef(buffer_, p), label(row));
1916 case LFUN_WORD_DELETE_FORWARD:
1917 case LFUN_CHAR_DELETE_FORWARD:
1918 if (col(cur.idx()) + 1 == ncols()
1919 && cur.pos() == cur.lastpos()
1920 && !cur.selection()) {
1921 if (!label(row(cur.idx())).empty()) {
1922 cur.recordUndoInset();
1923 label(row(cur.idx()), docstring());
1924 } else if (numbered(row(cur.idx()))) {
1925 cur.recordUndoInset();
1926 numbered(row(cur.idx()), false);
1927 cur.forceBufferUpdate();
1929 InsetMathGrid::doDispatch(cur, cmd);
1933 InsetMathGrid::doDispatch(cur, cmd);
1938 case LFUN_INSET_INSERT: {
1939 //lyxerr << "arg: " << to_utf8(cmd.argument()) << endl;
1940 // FIXME: this should be cleaned up to use InsetLabel methods directly.
1941 string const name = cmd.getArg(0);
1942 if (name == "label") {
1943 InsetCommandParams p(LABEL_CODE);
1944 InsetCommand::string2params(to_utf8(cmd.argument()), p);
1945 docstring str = p["name"];
1946 cur.recordUndoInset();
1947 row_type const r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1951 docstring old = label(r);
1954 // The label will take care of the reference update.
1958 // Newly created inset so initialize it.
1959 label_[r]->initView();
1962 cur.forceBufferUpdate();
1965 InsetMathGrid::doDispatch(cur, cmd);
1969 case LFUN_MATH_EXTERN:
1970 cur.recordUndoInset();
1974 case LFUN_MATH_MUTATE: {
1975 cur.recordUndoInset();
1976 row_type row = cur.row();
1977 col_type col = cur.col();
1978 mutate(hullType(cmd.argument()));
1979 cur.idx() = row * ncols() + col;
1980 if (cur.idx() > cur.lastidx()) {
1981 cur.idx() = cur.lastidx();
1982 cur.pos() = cur.lastpos();
1984 if (cur.pos() > cur.lastpos())
1985 cur.pos() = cur.lastpos();
1987 cur.forceBufferUpdate();
1988 // FIXME: find some more clever handling of the selection,
1989 // i.e. preserve it.
1990 cur.clearSelection();
1991 //cur.dispatched(FINISHED);
1995 case LFUN_MATH_DISPLAY: {
1996 cur.recordUndoInset();
1997 mutate(type_ == hullSimple ? hullEquation : hullSimple);
1998 // if the cursor is in a cell that got merged, move it to
1999 // start of the hull inset.
2000 if (cur.idx() > 0) {
2004 if (cur.pos() > cur.lastpos())
2005 cur.pos() = cur.lastpos();
2010 case LFUN_TABULAR_FEATURE:
2011 if (!allowsTabularFeatures())
2014 InsetMathGrid::doDispatch(cur, cmd);
2018 InsetMathGrid::doDispatch(cur, cmd);
2026 bool allowDisplayMath(Cursor const & cur)
2028 LATTEST(cur.depth() > 1);
2029 Cursor tmpcur = cur;
2032 FuncRequest cmd(LFUN_MATH_DISPLAY);
2033 return tmpcur.getStatus(cmd, status) && status.enabled();
2039 bool InsetMathHull::getStatus(Cursor & cur, FuncRequest const & cmd,
2040 FuncStatus & status) const
2042 switch (cmd.action()) {
2043 case LFUN_FINISHED_BACKWARD:
2044 case LFUN_FINISHED_FORWARD:
2045 case LFUN_FINISHED_RIGHT:
2046 case LFUN_FINISHED_LEFT:
2049 case LFUN_NEWLINE_INSERT:
2050 case LFUN_MATH_EXTERN:
2052 status.setEnabled(true);
2055 // we never allow this in math, and we want to bind enter
2056 // to another actions in command-alternatives
2057 case LFUN_PARAGRAPH_BREAK:
2058 status.setEnabled(false);
2060 case LFUN_MATH_MUTATE: {
2061 HullType const ht = hullType(cmd.argument());
2062 status.setOnOff(type_ == ht);
2063 status.setEnabled(isMutable(ht) && isMutable(type_));
2065 if (ht != hullSimple && status.enabled())
2066 status.setEnabled(allowDisplayMath(cur));
2069 case LFUN_MATH_DISPLAY: {
2070 status.setEnabled(display() || allowDisplayMath(cur));
2071 status.setOnOff(display());
2075 case LFUN_MATH_NUMBER_TOGGLE:
2076 // FIXME: what is the right test, this or the one of
2078 status.setEnabled(display());
2079 status.setOnOff(numberedType());
2082 case LFUN_MATH_NUMBER_LINE_TOGGLE: {
2083 // FIXME: what is the right test, this or the one of
2085 bool const enable = (type_ == hullMultline)
2086 ? (nrows() - 1 == cur.row())
2088 row_type const r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
2089 status.setEnabled(enable);
2090 status.setOnOff(enable && numbered(r));
2094 case LFUN_LABEL_INSERT:
2095 status.setEnabled(type_ != hullSimple);
2098 case LFUN_LABEL_COPY_AS_REFERENCE: {
2099 bool enabled = false;
2100 if (cmd.argument().empty() && &cur.inset() == this) {
2101 // if there is no argument and we're inside math, we retrieve
2102 // the row number from the cursor position.
2103 row_type row = (type_ == hullMultline) ? nrows() - 1 : cur.row();
2104 enabled = numberedType() && label_[row] && numbered(row);
2106 // if there is an argument, find the corresponding label, else
2107 // check whether there is at least one label.
2108 for (row_type row = 0; row != nrows(); ++row) {
2109 if (numbered(row) && label_[row] &&
2110 (cmd.argument().empty() || label(row) == cmd.argument())) {
2116 status.setEnabled(enabled);
2120 case LFUN_INSET_INSERT:
2121 if (cmd.getArg(0) == "label") {
2122 status.setEnabled(type_ != hullSimple);
2125 return InsetMathGrid::getStatus(cur, cmd, status);
2127 case LFUN_TABULAR_FEATURE: {
2128 if (!allowsTabularFeatures())
2130 string s = cmd.getArg(0);
2132 && (s == "append-row"
2133 || s == "delete-row"
2134 || s == "copy-row")) {
2135 status.message(bformat(
2136 from_utf8(N_("Can't change number of rows in '%1$s'")),
2138 status.setEnabled(false);
2142 && (s == "append-column"
2143 || s == "delete-column"
2144 || s == "copy-column")) {
2145 status.message(bformat(
2146 from_utf8(N_("Can't change number of columns in '%1$s'")),
2148 status.setEnabled(false);
2151 if (s == "add-vline-left" || s == "add-vline-right") {
2152 status.message(bformat(
2153 from_utf8(N_("Can't add vertical grid lines in '%1$s'")),
2155 status.setEnabled(false);
2158 if (s == "valign-top" || s == "valign-middle"
2159 || s == "valign-bottom" || s == "align-left"
2160 || s == "align-center" || s == "align-right") {
2161 status.setEnabled(false);
2164 return InsetMathGrid::getStatus(cur, cmd, status);
2168 return InsetMathGrid::getStatus(cur, cmd, status);
2173 int InsetMathHull::leftMargin() const
2175 return (getType() == hullSimple) ? 0 : InsetMathGrid::leftMargin();
2179 int InsetMathHull::rightMargin() const
2181 return (getType() == hullSimple) ? 0 : InsetMathGrid::rightMargin();
2185 int InsetMathHull::border() const
2187 return (getType() == hullSimple) ? 0 : InsetMathGrid::border();
2191 /////////////////////////////////////////////////////////////////////
2195 // simply scrap this function if you want
2196 void InsetMathHull::mutateToText()
2199 // translate to latex
2201 latex(os, false, false);
2202 string str = os.str();
2205 Text * lt = view_->cursor().innerText();
2206 string::const_iterator cit = str.begin();
2207 string::const_iterator end = str.end();
2208 for (; cit != end; ++cit)
2209 view_->getIntl()->getTransManager().TranslateAndInsert(*cit, lt);
2212 //dispatch(LFUN_ESCAPE);
2217 void InsetMathHull::handleFont(Cursor & cur, docstring const & arg,
2218 docstring const & font)
2220 // this whole function is a hack and won't work for incremental font
2223 if (cur.inset().asInsetMath()->name() == font)
2224 cur.handleFont(to_utf8(font));
2226 cur.handleNest(createInsetMath(font, cur.buffer()));
2232 void InsetMathHull::handleFont2(Cursor & cur, docstring const & arg)
2237 font.fromString(to_utf8(arg), b);
2238 if (font.fontInfo().color() != Color_inherit) {
2239 MathAtom at = MathAtom(new InsetMathColor(buffer_, true, font.fontInfo().color()));
2245 void InsetMathHull::edit(Cursor & cur, bool front, EntryDirection entry_from)
2247 InsetMathNest::edit(cur, front, entry_from);
2248 // The inset formula dimension is not necessarily the same as the
2249 // one of the instant preview image, so we have to indicate to the
2250 // BufferView that a metrics update is needed.
2251 cur.screenUpdateFlags(Update::Force);
2255 /////////////////////////////////////////////////////////////////////
2259 bool InsetMathHull::searchForward(BufferView * bv, string const & str,
2262 // FIXME: completely broken
2263 static InsetMathHull * lastformula = 0;
2264 static CursorBase current = DocIterator(ibegin(nucleus()));
2266 static string laststr;
2268 if (lastformula != this || laststr != str) {
2269 //lyxerr << "reset lastformula to " << this << endl;
2272 current = ibegin(nucleus());
2274 mathed_parse_cell(ar, str, Parse::NORMAL, &buffer());
2278 //lyxerr << "searching '" << str << "' in " << this << ar << endl;
2280 for (DocIterator it = current; it != iend(nucleus()); increment(it)) {
2281 CursorSlice & top = it.back();
2282 MathData const & a = top.asInsetMath()->cell(top.idx_);
2283 if (a.matchpart(ar, top.pos_)) {
2284 bv->cursor().setSelection(it, ar.size());
2286 top.pos_ += ar.size();
2292 //lyxerr << "not found!" << endl;
2299 void InsetMathHull::write(ostream & os) const
2301 odocstringstream oss;
2302 otexrowstream ots(oss);
2303 TeXMathStream wi(ots, false, false, TeXMathStream::wsDefault);
2306 os << to_utf8(oss.str());
2310 void InsetMathHull::read(Lexer & lex)
2313 mathed_parse_normal(buffer_, at, lex, Parse::TRACKMACRO);
2314 operator=(*at->asHullInset());
2318 bool InsetMathHull::readQuiet(Lexer & lex)
2321 bool success = mathed_parse_normal(buffer_, at, lex, Parse::QUIET);
2323 operator=(*at->asHullInset());
2328 int InsetMathHull::plaintext(odocstringstream & os,
2329 OutputParams const & op, size_t max_length) const
2331 // Try enabling this now that there is a flag as requested at #2275.
2332 if (buffer().isExporting() && display()) {
2336 TextPainter tpain(dim.width(), dim.height());
2337 drawT(tpain, 0, dim.ascent());
2339 // reset metrics cache to "real" values
2341 return tpain.textheight();
2344 odocstringstream oss;
2345 otexrowstream ots(oss);
2346 Encoding const * const enc = encodings.fromLyXName("utf8");
2347 TeXMathStream wi(ots, false, true, TeXMathStream::wsDefault, enc);
2350 if (type_ == hullRegexp)
2353 for (row_type r = 0; r < nrows(); ++r) {
2354 for (col_type c = 0; c < ncols(); ++c)
2355 wi << (c == 0 ? "" : "\t") << cell(index(r, c));
2356 // if it's for the TOC, we write just the first line
2357 // and do not include the newline.
2358 if (op.for_toc || op.for_tooltip || oss.str().size() >= max_length)
2360 if (r < nrows() - 1)
2364 docstring const str = oss.str();
2370 void InsetMathHull::docbook(XMLStream & xs, OutputParams const & runparams) const {
2371 // Choose the tag around the MathML equation.
2374 if (getType() == hullSimple)
2375 name = from_ascii("inlineequation");
2377 doCR = true; // This is a block equation, always have <informalequation> on its own line.
2378 name = from_ascii("informalequation");
2381 // DocBook also has <equation>, but it comes with a title.
2382 // TODO: recognise \tag from amsmath? This would allow having <equation> with a proper title.
2386 bool mathmlNamespaceInline = buffer().params().docbook_mathml_prefix == BufferParams::NoPrefix;
2387 if (mathmlNamespaceInline)
2388 attr += "xmlns=\"http://www.w3.org/1998/Math/MathML\"";
2390 for (row_type i = 0; i < nrows(); ++i) {
2391 if (!label(i).empty()) {
2395 attr += "xml:id=\"" + xml::cleanID(label(i)) + "\"";
2401 if (!xs.isLastTagCR())
2404 xs << xml::StartTag(name, attr);
2407 // With DocBook 5, MathML must be within its own namespace (defined in Buffer.cpp::writeDocBookSource, except when
2408 // it should be inlined).
2409 // Output everything in a separate stream so that this does not interfere with the standard flow of DocBook tags.
2410 std::string mathmlNamespacePrefix;
2411 if (!mathmlNamespaceInline) {
2412 if (buffer().params().docbook_mathml_prefix == BufferParams::MPrefix)
2413 mathmlNamespacePrefix = "m";
2414 else if (buffer().params().docbook_mathml_prefix == BufferParams::MMLPrefix)
2415 mathmlNamespacePrefix = "mml";
2418 odocstringstream osmath;
2419 MathMLStream ms(osmath, mathmlNamespacePrefix, true);
2421 // Output the MathML subtree.
2422 // TeX transcription. Avoid MTag/ETag so that there are no extraneous spaces.
2423 ms << "<" << from_ascii("alt") << " role='tex'" << ">";
2424 // Workaround for db2latex: db2latex always includes equations with
2425 // \ensuremath{} or \begin{display}\end{display}
2426 // so we strip LyX' math environment
2427 odocstringstream ls;
2429 TeXMathStream wi(ols, false, false, TeXMathStream::wsDefault, runparams.encoding);
2430 InsetMathGrid::write(wi);
2431 ms << from_utf8(subst(subst(to_utf8(ls.str()), "&", "&"), "<", "<"));
2432 ms << "</" << from_ascii("alt") << ">";
2434 // Actual transformation of the formula into MathML. This translation may fail (for example, due to custom macros).
2435 // The new output stream is required to deal with the errors: first write completely the formula into this
2436 // temporary stream; then, if it is possible without error, then copy it back to the "real" stream. Otherwise,
2437 // some incomplete tags might be put into the real stream.
2439 // First, generate the MathML expression. If there is an error in the generation, this block is not fully
2440 // executed, and the formula is not output to the DocBook stream.
2441 odocstringstream ostmp;
2442 MathMLStream mstmp(ostmp, ms.xmlns(), ms.xmlMode());
2445 // Choose the display style for the formula, to be output as an attribute near the formula root.
2446 std::string mathmlAttr;
2447 if (getType() == hullSimple)
2448 mathmlAttr = "display=\"inline\"";
2450 mathmlAttr = "display=\"block\"";
2452 // Then, output the formula.
2453 ms << MTag("math", mathmlAttr);
2455 osmath << ostmp.str(); // osmath is not a XMLStream, so no need for XMLStream::ESCAPE_NONE.
2457 } catch (MathExportException const &) {
2459 osmath << "<mathphrase>MathML export failed. Please report this as a bug to the LyX developers: "
2460 "https://www.lyx.org/trac.</mathphrase>";
2463 // Output the complete formula to the DocBook stream.
2464 xs << XMLStream::ESCAPE_NONE << osmath.str();
2466 xs << xml::EndTag(name);
2472 bool InsetMathHull::haveNumbers() const
2474 bool havenumbers = false;
2475 // inline formulas are never numbered (bug 7351 part 3)
2476 if (getType() == hullSimple)
2478 for (size_t i = 0; i != numbered_.size(); ++i) {
2489 // We need to do something about alignment here.
2491 // This duplicates code from InsetMathGrid, but
2492 // we need access here to number information,
2493 // and we simply do not have that in InsetMathGrid.
2494 void InsetMathHull::htmlize(HtmlStream & os) const
2496 bool const havenumbers = haveNumbers();
2497 bool const havetable = havenumbers || nrows() > 1 || ncols() > 1;
2500 os << cell(index(0, 0));
2504 os << MTag("table", "class='mathtable'");
2505 for (row_type row = 0; row < nrows(); ++row) {
2507 for (col_type col = 0; col < ncols(); ++col) {
2509 os << cell(index(row, col));
2514 docstring const & num = numbers_[row];
2516 os << '(' << num << ')';
2521 os << ETag("table");
2525 // this duplicates code from InsetMathGrid, but
2526 // we need access here to number information,
2527 // and we simply do not have that in InsetMathGrid.
2528 void InsetMathHull::mathmlize(MathMLStream & ms) const
2530 bool const havenumbers = haveNumbers();
2531 bool const havetable = havenumbers || nrows() > 1 || ncols() > 1;
2534 if (getType() == hullSimple)
2535 ms << MTag("mtable");
2536 else if (getType() >= hullAlign && getType() <= hullXXAlignAt)
2537 ms << MTag("mtable", "displaystyle='true' columnalign='right left'");
2539 ms << MTag("mtable", "displaystyle='true'");
2542 char const * const celltag = havetable ? "mtd" : "mrow";
2543 // FIXME There does not seem to be wide support at the moment
2544 // for mlabeledtr, so we have to use just mtr for now.
2545 // char const * const rowtag = havenumbers ? "mlabeledtr" : "mtr";
2546 char const * const rowtag = "mtr";
2547 for (row_type row = 0; row < nrows(); ++row) {
2550 for (col_type col = 0; col < ncols(); ++col) {
2552 << cell(index(row, col))
2558 docstring const & num = numbers_[row];
2560 ms << MTagInline("mtext") << '(' << num << ')' << ETagInline("mtext");
2567 ms << ETag("mtable");
2571 void InsetMathHull::mathAsLatex(TeXMathStream & os) const
2573 MathEnsurer ensurer(os, false);
2574 bool havenumbers = haveNumbers();
2575 bool const havetable = havenumbers || nrows() > 1 || ncols() > 1;
2578 os << cell(index(0, 0));
2582 os << "<table class='mathtable'>";
2583 for (row_type row = 0; row < nrows(); ++row) {
2585 for (col_type col = 0; col < ncols(); ++col) {
2586 os << "<td class='math'>";
2587 os << cell(index(row, col));
2592 docstring const & num = numbers_[row];
2594 os << '(' << num << ')';
2603 docstring InsetMathHull::xhtml(XMLStream & xs, OutputParams const & op) const
2605 BufferParams::MathOutput const mathtype =
2606 buffer().masterBuffer()->params().html_math_output;
2608 bool success = false;
2610 // we output all the labels just at the beginning of the equation.
2611 // this should be fine.
2612 for (size_t i = 0; i != label_.size(); ++i) {
2613 InsetLabel const * const il = label_[i];
2619 // FIXME Eventually we would like to do this inset by inset.
2620 if (mathtype == BufferParams::MathML) {
2621 odocstringstream os;
2622 MathMLStream ms(os);
2626 } catch (MathExportException const &) {}
2628 if (getType() == hullSimple)
2629 xs << xml::StartTag("math",
2630 "xmlns=\"http://www.w3.org/1998/Math/MathML\"", true);
2632 xs << xml::StartTag("math",
2633 "display=\"block\" xmlns=\"http://www.w3.org/1998/Math/MathML\"", true);
2634 xs << XMLStream::ESCAPE_NONE
2636 << xml::EndTag("math");
2638 } else if (mathtype == BufferParams::HTML) {
2639 odocstringstream os;
2644 } catch (MathExportException const &) {}
2646 string const tag = (getType() == hullSimple) ? "span" : "div";
2647 xs << xml::StartTag(tag, "class='formula'", true)
2648 << XMLStream::ESCAPE_NONE
2650 << xml::EndTag(tag);
2654 // what we actually want is this:
2656 // ((mathtype == BufferParams::MathML || mathtype == BufferParams::HTML)
2658 // || mathtype == BufferParams::Images
2660 // but what follows is equivalent, since we'll enter only if either (a) we
2661 // tried and failed with MathML or HTML or (b) didn't try yet at all but
2662 // aren't doing LaTeX.
2664 // so this is for Images.
2665 if (!success && mathtype != BufferParams::LaTeX) {
2666 graphics::PreviewImage const * pimage = 0;
2668 loadPreview(docit_);
2669 pimage = preview_->getPreviewImage(buffer());
2670 // FIXME Do we always have png?
2673 if (pimage || op.dryrun) {
2674 string const filename = pimage ? pimage->filename().onlyFileName()
2675 : "previewimage.png";
2677 // if we are not in the master buffer, then we need to see that the
2678 // generated image is copied there; otherwise, preview fails.
2679 Buffer const * mbuf = buffer().masterBuffer();
2680 if (mbuf != &buffer()) {
2681 string mbtmp = mbuf->temppath();
2682 FileName const mbufimg(support::addName(mbtmp, filename));
2683 pimage->filename().copyTo(mbufimg);
2685 // add the file to the list of files to be exported
2686 op.exportdata->addExternalFile("xhtml", pimage->filename());
2689 string const tag = (getType() == hullSimple) ? "span" : "div";
2691 << xml::StartTag(tag, "style = \"text-align: center;\"")
2692 << xml::CompTag("img", "src=\"" + filename + "\" alt=\"Mathematical Equation\"")
2699 // so we'll pass this test if we've failed everything else, or
2700 // if mathtype was LaTeX, since we won't have entered any of the
2702 if (!success /* || mathtype != BufferParams::LaTeX */) {
2703 // Unfortunately, we cannot use latexString() because we do not want
2704 // $...$ or whatever.
2705 odocstringstream ls;
2706 otexrowstream ots(ls);
2707 TeXMathStream wi(ots, false, true, TeXMathStream::wsPreview);
2708 ModeSpecifier specifier(wi, MATH_MODE);
2710 docstring const latex = ls.str();
2712 // class='math' allows for use of jsMath
2713 // http://www.math.union.edu/~dpvc/jsMath/
2715 // probably should allow for some kind of customization here
2716 string const tag = (getType() == hullSimple) ? "span" : "div";
2717 xs << xml::StartTag(tag, "class='math'")
2726 void InsetMathHull::toString(odocstream & os) const
2728 odocstringstream ods;
2729 plaintext(ods, OutputParams(0));
2734 void InsetMathHull::forOutliner(docstring & os, size_t const, bool const) const
2736 odocstringstream ods;
2739 // FIXME: this results in spilling TeX into the LyXHTML output since the
2740 // outliner is used to generate the LyXHTML list of figures/etc.
2746 string InsetMathHull::contextMenuName() const
2748 return "context-math";
2752 void InsetMathHull::recordLocation(DocIterator const & di)
2758 bool InsetMathHull::canPaintChange(BufferView const &) const
2760 // We let RowPainter do it seamlessly for inline insets