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]{\\linewidth}{";
131 os << "\\lyxmathsout{\\parbox{\\linewidth}{";
132 } else if (os.ulemCmd() == WriteStream::UNDERLINE)
133 os << "\\raisebox{-\\belowdisplayshortskip}{"
134 "\\parbox[b]{\\linewidth}{";
135 else if (os.ulemCmd() == WriteStream::STRIKEOUT)
136 os << "\\parbox{\\linewidth}{";
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 += mi.base.inPixels(Length(0.3, Length::IN)) + 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::drawMarkers(PainterInfo & pi, int x, int y) const
604 ColorCode pen_color = mouseHovered(pi.base.bv) || editing(pi.base.bv)?
605 Color_mathframe : Color_mathcorners;
606 // If the corners have the same color as the background, do not paint them.
607 if (lcolor.getX11Name(Color_mathbg) == lcolor.getX11Name(pen_color))
610 Inset::drawMarkers(pi, x, y);
611 Dimension const dim = dimension(*pi.base.bv);
612 int const t = x + dim.width() - 1;
613 int const a = y - dim.ascent();
614 pi.pain.line(x, a + 3, x, a, pen_color);
615 pi.pain.line(t, a + 3, t, a, pen_color);
616 pi.pain.line(x, a, x + 3, a, pen_color);
617 pi.pain.line(t - 3, a, t, a, pen_color);
621 void InsetMathHull::drawBackground(PainterInfo & pi, int x, int y) const
623 Dimension const dim = dimension(*pi.base.bv);
624 if (previewTooSmall(dim)) {
625 pi.pain.fillRectangle(x, y - 2 * ERROR_FRAME_WIDTH,
626 dim.wid, dim.asc + dim.des, backgroundColor(pi));
629 pi.pain.fillRectangle(x + 1, y - dim.asc + 1, dim.wid - 2,
630 dim.asc + dim.des - 1, pi.backgroundColor(this));
634 void InsetMathHull::draw(PainterInfo & pi, int x, int y) const
636 BufferView const * const bv = pi.base.bv;
637 Dimension const dim = dimension(*bv);
639 if (type_ == hullRegexp)
640 pi.pain.rectangle(x + 2, y - dim.ascent() + 1,
641 dim.width() - 3, dim.height() - 2, Color_regexpframe);
643 if (previewState(bv)) {
644 // Do not draw change tracking cue if taken care of by RowPainter
646 Changer dummy = !canPaintChange(*bv) ? make_change(pi.change_, Change())
648 if (previewTooSmall(dim)) {
649 // we have an extra frame
650 preview_->draw(pi, x + ERROR_FRAME_WIDTH, y);
652 // one pixel gap in front
653 preview_->draw(pi, x + 1, y);
658 ColorCode color = pi.selected && lyxrc.use_system_colors
659 ? Color_selectiontext : standardColor();
660 bool const really_change_color = pi.base.font.color() == Color_none;
661 Changer dummy0 = really_change_color ? pi.base.font.changeColor(color)
663 Changer dummy1 = pi.base.changeFontSet(standardFont());
664 Changer dummy2 = pi.base.font.changeStyle(display() ? LM_ST_DISPLAY
668 BufferParams::MathNumber const math_number = buffer().params().getMathNumber();
669 if (numberedType() && math_number == BufferParams::LEFT) {
670 Changer dummy = pi.base.changeFontSet("mathrm");
672 for (row_type row = 0; row < nrows(); ++row)
673 l = max(l, mathed_string_width(pi.base.font, nicelabel(row)));
676 // Value was hardcoded to 30 pixels
677 xmath += pi.base.inPixels(Length(0.3, Length::IN)) + l;
680 InsetMathGrid::draw(pi, xmath + 1, y);
681 drawMarkers(pi, x, y);
683 if (numberedType()) {
684 Changer dummy = pi.base.changeFontSet("mathrm");
685 for (row_type row = 0; row < nrows(); ++row) {
686 int const yy = y + rowinfo_[row].offset_;
687 docstring const nl = nicelabel(row);
688 if (math_number == BufferParams::LEFT)
691 int l = mathed_string_width(pi.base.font, nl);
692 pi.draw(x + dim.wid - l, yy, nl);
697 // drawing change line
698 if (canPaintChange(*bv))
699 pi.change_.paintCue(pi, x + 1, y + 1 - dim.asc,
700 x + dim.wid, y + dim.des);
704 void InsetMathHull::metricsT(TextMetricsInfo const & mi, Dimension & dim) const
707 InsetMathGrid::metricsT(mi, dim);
710 otexrowstream ots(os);
711 WriteStream wi(ots, false, true, WriteStream::wsDefault);
713 dim.wid = os.str().size();
720 void InsetMathHull::drawT(TextPainter & pain, int x, int y) const
723 InsetMathGrid::drawT(pain, x, y);
726 otexrowstream ots(os);
727 WriteStream wi(ots, false, true, WriteStream::wsDefault);
729 pain.draw(x, y, os.str().c_str());
734 static docstring latexString(InsetMathHull const & inset)
737 // This has to be static, because a preview snippet or a math
738 // macro containing math in text mode (such as $\text{$\phi$}$ or
739 // \newcommand{\xxx}{\text{$\phi$}}) gets processed twice. The
740 // first time as a whole, and the second time only the inner math.
741 // In this last case inset.buffer() would be invalid.
742 static Encoding const * encoding = 0;
743 if (inset.isBufferValid())
744 encoding = &(inset.buffer().params().encoding());
745 otexrowstream ots(ls);
746 WriteStream wi(ots, false, true, WriteStream::wsPreview, encoding);
752 void InsetMathHull::initUnicodeMath() const
754 // Trigger classification of the unicode symbols in this inset
755 docstring const dummy = latexString(*this);
759 void InsetMathHull::addPreview(DocIterator const & inset_pos,
760 graphics::PreviewLoader & /*ploader*/) const
762 if (RenderPreview::previewMath()) {
763 preparePreview(inset_pos);
768 void InsetMathHull::usedMacros(MathData const & md, DocIterator const & pos,
769 MacroNameSet & macros, MacroNameSet & defs) const
771 MacroNameSet::iterator const end = macros.end();
773 for (size_t i = 0; i < md.size(); ++i) {
774 InsetMathMacro const * mi = md[i].nucleus()->asMacro();
775 InsetMathMacroTemplate const * mt = md[i].nucleus()->asMacroTemplate();
776 InsetMathScript const * si = md[i].nucleus()->asScriptInset();
777 InsetMathFracBase const * fi = md[i].nucleus()->asFracBaseInset();
778 InsetMathGrid const * gi = md[i].nucleus()->asGridInset();
779 InsetMathNest const * ni = md[i].nucleus()->asNestInset();
781 // Look for macros in the arguments of this macro.
782 for (idx_type idx = 0; idx < mi->nargs(); ++idx)
783 usedMacros(mi->cell(idx), pos, macros, defs);
784 // Make sure this is a macro defined in the document
785 // (as we also spot the macros in the symbols file)
786 // or that we have not already accounted for it.
787 docstring const name = mi->name();
788 if (macros.find(name) == end)
791 // Look for macros in the definition of this macro.
792 MathData ar(pos.buffer());
793 MacroData const * data =
794 pos.buffer()->getMacro(name, pos, true);
796 odocstringstream macro_def;
797 data->write(macro_def, true);
799 defs.insert(macro_def.str());
800 asArray(data->definition(), ar);
802 usedMacros(ar, pos, macros, defs);
804 MathData ar(pos.buffer());
805 asArray(mt->definition(), ar);
806 usedMacros(ar, pos, macros, defs);
808 if (!si->nuc().empty())
809 usedMacros(si->nuc(), pos, macros, defs);
811 usedMacros(si->down(), pos, macros, defs);
813 usedMacros(si->up(), pos, macros, defs);
814 } else if (fi || gi) {
815 idx_type nidx = fi ? fi->nargs() : gi->nargs();
816 for (idx_type idx = 0; idx < nidx; ++idx)
817 usedMacros(fi ? fi->cell(idx) : gi->cell(idx),
820 usedMacros(ni->cell(0), pos, macros, defs);
826 void InsetMathHull::preparePreview(DocIterator const & pos,
827 bool forexport) const
829 // there is no need to do all the macro stuff if we're not
830 // actually going to generate the preview.
831 if (!RenderPreview::previewMath() && !forexport)
834 Buffer const * buffer = pos.buffer();
836 // collect macros at this position
838 buffer->listMacroNames(macros);
840 // collect definitions only for the macros used in this inset
842 for (idx_type idx = 0; idx < nargs(); ++idx)
843 usedMacros(cell(idx), pos, macros, defs);
845 docstring macro_preamble;
846 for (auto const & defvar : defs)
847 macro_preamble.append(defvar);
849 // set the font series and size for this snippet
850 DocIterator dit = pos.getInnerText();
851 Paragraph const & par = dit.paragraph();
852 Font font = par.getFontSettings(buffer->params(), dit.pos());
853 font.fontInfo().realize(par.layout().font);
854 string const lsize = font.latexSize();
857 if (font.fontInfo().series() == BOLD_SERIES) {
858 setfont += from_ascii("\\textbf{");
861 if (lsize != "normalsize" && !prefixIs(lsize, "error"))
862 setfont += from_ascii("\\" + lsize + '\n');
865 if (forexport && haveNumbers()) {
866 docstring eqstr = from_ascii("equation");
867 CounterMap::const_iterator it = counter_map.find(eqstr);
868 if (it != counter_map.end()) {
869 int num = it->second;
871 setcnt += from_ascii("\\setcounter{") + eqstr + '}' +
872 '{' + convert<docstring>(num) + '}' + '\n';
874 for (size_t i = 0; i != numcnts; ++i) {
875 docstring cnt = from_ascii(counters_to_save[i]);
876 it = counter_map.find(cnt);
877 if (it == counter_map.end())
879 int num = it->second;
881 setcnt += from_ascii("\\setcounter{") + cnt + '}' +
882 '{' + convert<docstring>(num) + '}';
885 docstring const snippet = macro_preamble + setfont + setcnt
886 + latexString(*this) + endfont;
887 LYXERR(Debug::MACROS, "Preview snippet: " << snippet);
888 preview_->addPreview(snippet, *buffer, forexport);
892 void InsetMathHull::reloadPreview(DocIterator const & pos) const
895 preview_->startLoading(*pos.buffer());
899 void InsetMathHull::loadPreview(DocIterator const & pos) const
901 bool const forexport = true;
902 preparePreview(pos, forexport);
903 preview_->startLoading(*pos.buffer(), forexport);
907 bool InsetMathHull::notifyCursorLeaves(Cursor const & old, Cursor & cur)
909 if (RenderPreview::previewMath()) {
911 cur.screenUpdateFlags(Update::Force);
917 docstring InsetMathHull::label(row_type row) const
919 LASSERT(row < nrows(), return docstring());
920 if (InsetLabel * il = label_[row])
921 return il->screenLabel();
926 void InsetMathHull::label(row_type row, docstring const & label)
928 //lyxerr << "setting label '" << label << "' for row " << row << endl;
932 label_[row] = dummy_pointer;
935 label_[row]->updateLabelAndRefs(label);
937 label_[row]->setParam("name", label);
941 InsetCommandParams p(LABEL_CODE);
943 label_[row] = new InsetLabel(buffer_, p);
945 label_[row]->setBuffer(buffer());
949 void InsetMathHull::numbered(row_type row, Numbered num)
951 numbered_[row] = num;
952 if (!numbered(row) && label_[row]) {
959 bool InsetMathHull::numbered(row_type row) const
961 return numbered_[row] == NUMBER;
965 bool InsetMathHull::ams() const
985 for (size_t row = 0; row < numbered_.size(); ++row)
986 if (numbered_[row] == NOTAG)
992 bool InsetMathHull::outerDisplay() const
1015 Inset::DisplayType InsetMathHull::display() const
1032 if (buffer().params().is_math_indent)
1042 int InsetMathHull::indent(BufferView const & bv) const
1044 // FIXME: set this in the textclass. This value is what the article class uses.
1045 static Length default_indent(2.5, Length::EM);
1046 if (display() != Inline && buffer().params().is_math_indent) {
1047 Length const & len = buffer().params().getMathIndent();
1049 return bv.inPixels(default_indent);
1051 return bv.inPixels(len);
1053 return Inset::indent(bv);
1057 bool InsetMathHull::numberedType() const
1076 for (row_type row = 0; row < nrows(); ++row)
1083 void InsetMathHull::validate(LaTeXFeatures & features) const
1085 if (features.runparams().isLaTeX()) {
1087 features.require("amsmath");
1089 if (type_ == hullRegexp) {
1090 features.require("color");
1091 docstring frcol = from_utf8(lcolor.getLaTeXName(Color_regexpframe));
1092 docstring bgcol = from_ascii("white");
1093 features.addPreambleSnippet(
1094 "\\newcommand{\\regexp}[1]{\\fcolorbox{"
1096 + bgcol + "}{\\ensuremath{\\mathtt{#1}}}}");
1097 features.addPreambleSnippet(
1098 from_ascii("\\newcommand{\\endregexp}{}"));
1099 } else if (outerDisplay() && features.inDeletedInset()
1100 && !features.mustProvide("ct-dvipost")) {
1101 features.require("ct-tikz-math-sout");
1104 // Validation is necessary only if not using AMS math.
1105 // To be safe, we will always run mathedvalidate.
1106 //if (features.amsstyle)
1109 //features.binom = true;
1110 } else if (features.runparams().math_flavor == OutputParams::MathAsHTML) {
1111 // it would be better to do this elsewhere, but we can't validate in
1112 // InsetMathMatrix and we have no way, outside MathExtern, to know if
1113 // we even have any matrices.
1114 features.addCSSSnippet(
1115 "table.matrix{display: inline-block; vertical-align: middle; text-align:center;}\n"
1116 "table.matrix td{padding: 0.25px;}\n"
1117 "td.ldelim{width: 0.5ex; border: thin solid black; border-right: none;}\n"
1118 "td.rdelim{width: 0.5ex; border: thin solid black; border-left: none;}");
1120 InsetMathGrid::validate(features);
1124 void InsetMathHull::header_write(WriteStream & os) const
1126 bool n = numberedType();
1137 if (cell(0).empty())
1142 writeMathdisplayPreamble(os);
1146 os << "\\begin{equation" << star(n) << "}\n";
1156 writeMathdisplayPreamble(os);
1159 os << "\\begin{" << hullName(type_) << star(n) << "}\n";
1166 os << "\\begin{" << hullName(type_) << star(n) << '}'
1167 << '{' << static_cast<unsigned int>((ncols() + 1)/2) << "}\n";
1173 os << "\\begin{" << hullName(type_) << '}'
1174 << '{' << static_cast<unsigned int>((ncols() + 1)/2) << "}\n";
1184 os << "\\begin{unknown" << star(n) << "}\n";
1190 void InsetMathHull::footer_write(WriteStream & os) const
1192 bool n = numberedType();
1209 os << "\\end{equation" << star(n) << "}\n";
1212 writeMathdisplayPostamble(os);
1222 os << "\\end{" << hullName(type_) << star(n) << "}\n";
1223 writeMathdisplayPostamble(os);
1230 os << "\\end{" << hullName(type_) << star(n) << "}\n";
1236 os << "\\end{" << hullName(type_) << "}\n";
1240 // Only used as a heuristic to find the regexp termination, when searching in ignore-format mode
1241 os << "\\endregexp{}}";
1247 os << "\\end{unknown" << star(n) << "}\n";
1253 bool InsetMathHull::allowsTabularFeatures() const
1276 bool InsetMathHull::rowChangeOK() const
1279 type_ == hullEqnArray || type_ == hullAlign ||
1280 type_ == hullFlAlign || type_ == hullAlignAt ||
1281 type_ == hullXAlignAt || type_ == hullXXAlignAt ||
1282 type_ == hullGather || type_ == hullMultline;
1286 bool InsetMathHull::colChangeOK() const
1289 type_ == hullAlign || type_ == hullFlAlign ||type_ == hullAlignAt ||
1290 type_ == hullXAlignAt || type_ == hullXXAlignAt;
1294 void InsetMathHull::addRow(row_type row)
1299 bool numbered = numberedType();
1300 // Move the number and raw pointer, do not call label() (bug 7511)
1301 InsetLabel * label = dummy_pointer;
1302 docstring number = empty_docstring();
1303 if (type_ == hullMultline) {
1304 if (row + 1 == nrows()) {
1305 numbered_[row] = NONUMBER;
1306 swap(label, label_[row]);
1307 swap(number, numbers_[row]);
1312 numbered_.insert(numbered_.begin() + row + 1, numbered ? NUMBER : NONUMBER);
1313 numbers_.insert(numbers_.begin() + row + 1, number);
1314 label_.insert(label_.begin() + row + 1, label);
1315 InsetMathGrid::addRow(row);
1319 void InsetMathHull::swapRow(row_type row)
1323 if (row + 1 == nrows())
1325 swap(numbered_[row], numbered_[row + 1]);
1326 swap(numbers_[row], numbers_[row + 1]);
1327 swap(label_[row], label_[row + 1]);
1328 InsetMathGrid::swapRow(row);
1332 void InsetMathHull::delRow(row_type row)
1334 if (nrows() <= 1 || !rowChangeOK())
1336 if (row + 1 == nrows() && type_ == hullMultline) {
1337 swap(numbered_[row - 1], numbered_[row]);
1338 swap(numbers_[row - 1], numbers_[row]);
1339 swap(label_[row - 1], label_[row]);
1340 InsetMathGrid::delRow(row);
1343 InsetMathGrid::delRow(row);
1344 // The last dummy row has no number info nor a label.
1345 // Test nrows() + 1 because we have already erased the row.
1346 if (row == nrows() + 1)
1348 numbered_.erase(numbered_.begin() + row);
1349 numbers_.erase(numbers_.begin() + row);
1351 label_.erase(label_.begin() + row);
1355 void InsetMathHull::addCol(col_type col)
1359 InsetMathGrid::addCol(col);
1363 void InsetMathHull::delCol(col_type col)
1365 if (ncols() <= 1 || !colChangeOK())
1367 InsetMathGrid::delCol(col);
1371 docstring InsetMathHull::nicelabel(row_type row) const
1375 docstring const & val = numbers_[row];
1377 return '(' + val + ')';
1378 return '(' + val + ',' + label_[row]->screenLabel() + ')';
1382 void InsetMathHull::glueall(HullType type)
1385 for (idx_type i = 0; i < nargs(); ++i)
1387 InsetLabel * label = 0;
1388 if (type == hullEquation) {
1389 // preserve first non-empty label
1390 for (row_type row = 0; row < nrows(); ++row) {
1392 label = label_[row];
1398 *this = InsetMathHull(buffer_, hullSimple);
1405 void InsetMathHull::splitTo2Cols()
1407 LASSERT(ncols() == 1, return);
1408 InsetMathGrid::addCol(1);
1409 for (row_type row = 0; row < nrows(); ++row) {
1410 idx_type const i = 2 * row;
1411 pos_type pos = firstRelOp(cell(i));
1412 cell(i + 1) = MathData(buffer_, cell(i).begin() + pos, cell(i).end());
1413 cell(i).erase(pos, cell(i).size());
1418 void InsetMathHull::splitTo3Cols()
1420 LASSERT(ncols() < 3, return);
1423 InsetMathGrid::addCol(2);
1424 for (row_type row = 0; row < nrows(); ++row) {
1425 idx_type const i = 3 * row + 1;
1426 if (!cell(i).empty()) {
1427 cell(i + 1) = MathData(buffer_, cell(i).begin() + 1, cell(i).end());
1428 cell(i).erase(1, cell(i).size());
1434 void InsetMathHull::changeCols(col_type cols)
1436 if (ncols() == cols)
1438 else if (ncols() < cols) {
1444 while (ncols() < cols)
1445 InsetMathGrid::addCol(ncols());
1451 for (row_type row = 0; row < nrows(); ++row) {
1452 idx_type const i = row * ncols();
1453 for (col_type col = cols; col < ncols(); ++col) {
1454 cell(i + cols - 1).append(cell(i + col));
1458 while (ncols() > cols) {
1459 InsetMathGrid::delCol(ncols() - 1);
1464 HullType InsetMathHull::getType() const
1470 void InsetMathHull::setType(HullType type)
1477 bool InsetMathHull::isMutable(HullType type)
1501 void InsetMathHull::mutate(HullType newtype)
1503 //lyxerr << "mutating from '" << type_ << "' to '" << newtype << "'" << endl;
1505 if (newtype == type_)
1508 // This guards the algorithm below it, which is designed with certain types
1510 if (!isMutable(newtype) || !isMutable(type_)) {
1511 lyxerr << "mutation from '" << to_utf8(hullName(type_))
1512 << "' to '" << to_utf8(hullName(newtype))
1513 << "' not implemented" << endl;
1517 // we try to move along the chain
1518 // none <-> simple <-> equation <-> eqnarray -> *align* -> multline, gather -+
1520 // +-------------------------------------+
1521 // we use eqnarray as intermediate type for mutations that are not
1522 // directly supported because it handles labels and numbering for
1527 setType(hullSimple);
1533 if (newtype == hullNone) {
1537 setType(hullEquation);
1538 numbered(0, label_[0] ? true : false);
1547 setType(hullSimple);
1552 // split it "nicely" on the first relop
1554 setType(hullEqnArray);
1562 // split it "nicely"
1597 setType(hullEqnArray);
1606 for (row_type row = 0; row < nrows(); ++row)
1607 numbered(row, false);
1617 for (row_type row = 0; row < nrows(); ++row)
1618 numbered(row, false);
1625 setType(hullEqnArray);
1655 for (row_type row = 0; row < nrows(); ++row)
1656 numbered(row, false);
1660 // first we mutate to EqnArray
1662 setType(hullEqnArray);
1669 // we passed the guard so we should not be here
1670 LYXERR0("Mutation not implemented, but should have been.");
1671 LASSERT(false, return);
1677 docstring InsetMathHull::eolString(row_type row, bool fragile, bool latex,
1678 bool last_eoln) const
1681 if (numberedType()) {
1682 if (label_[row] && numbered(row)) {
1683 docstring const name =
1684 latex ? escape(label_[row]->getParam("name"))
1685 : label_[row]->getParam("name");
1686 res += "\\label{" + name + '}';
1688 if (type_ != hullMultline) {
1689 if (numbered_[row] == NONUMBER)
1690 res += "\\nonumber ";
1691 else if (numbered_[row] == NOTAG)
1695 // Never add \\ on the last empty line of eqnarray and friends
1697 return res + InsetMathGrid::eolString(row, fragile, latex, last_eoln);
1700 void InsetMathHull::write(WriteStream & os) const
1702 ModeSpecifier specifier(os, MATH_MODE);
1704 InsetMathGrid::write(os);
1709 void InsetMathHull::normalize(NormalStream & os) const
1711 os << "[formula " << hullName(type_) << ' ';
1712 InsetMathGrid::normalize(os);
1717 void InsetMathHull::infoize(odocstream & os) const
1719 os << bformat(_("Type: %1$s"), hullName(type_));
1723 void InsetMathHull::check() const
1725 LATTEST(numbered_.size() == nrows());
1726 LATTEST(numbers_.size() == nrows());
1727 LATTEST(label_.size() == nrows());
1731 void InsetMathHull::doExtern(Cursor & cur, FuncRequest & func)
1735 idocstringstream iss(func.argument());
1736 iss >> dlang >> extra;
1738 extra = from_ascii("noextra");
1739 string const lang = to_ascii(dlang);
1741 // replace selection with result of computation
1742 if (reduceSelectionToOneCell(cur)) {
1744 asArray(grabAndEraseSelection(cur), ar);
1745 lyxerr << "use selection: " << ar << endl;
1746 cur.insert(pipeThroughExtern(lang, extra, ar));
1750 // only inline, display or eqnarray math is allowed
1751 switch (getType()) {
1757 frontend::Alert::warning(_("Bad math environment"),
1758 _("Computation cannot be performed for AMS "
1759 "math environments.\nChange the math "
1760 "formula type and try again."));
1765 eq.push_back(MathAtom(new InsetMathChar('=')));
1767 // go to first item in line
1768 cur.idx() -= cur.idx() % ncols();
1771 if (getType() == hullSimple) {
1772 size_type pos = cur.cell().find_last(eq);
1774 if (pos == cur.cell().size()) {
1776 lyxerr << "use whole cell: " << ar << endl;
1778 ar = MathData(buffer_, cur.cell().begin() + pos + 1, cur.cell().end());
1779 lyxerr << "use partial cell form pos: " << pos << endl;
1781 cur.cell().append(eq);
1782 cur.cell().append(pipeThroughExtern(lang, extra, ar));
1783 cur.pos() = cur.lastpos();
1787 if (getType() == hullEquation) {
1788 lyxerr << "use equation inset" << endl;
1789 mutate(hullEqnArray);
1790 MathData & ar = cur.cell();
1791 lyxerr << "use cell: " << ar << endl;
1795 cur.cell() = pipeThroughExtern(lang, extra, ar);
1796 // move to end of line
1797 cur.pos() = cur.lastpos();
1802 lyxerr << "use eqnarray" << endl;
1803 cur.idx() += 2 - cur.idx() % ncols();
1805 MathData ar = cur.cell();
1806 lyxerr << "use cell: " << ar << endl;
1807 // FIXME: temporarily disabled
1813 cur.cell() = pipeThroughExtern(lang, extra, ar);
1814 cur.pos() = cur.lastpos();
1819 void InsetMathHull::doDispatch(Cursor & cur, FuncRequest & cmd)
1821 //lyxerr << "action: " << cmd.action() << endl;
1822 switch (cmd.action()) {
1824 case LFUN_FINISHED_BACKWARD:
1825 case LFUN_FINISHED_FORWARD:
1826 case LFUN_FINISHED_RIGHT:
1827 case LFUN_FINISHED_LEFT:
1828 //lyxerr << "action: " << cmd.action() << endl;
1829 InsetMathGrid::doDispatch(cur, cmd);
1832 case LFUN_PARAGRAPH_BREAK:
1833 // just swallow this
1836 case LFUN_NEWLINE_INSERT:
1837 // some magic for the common case
1838 if (type_ == hullSimple || type_ == hullEquation) {
1839 cur.recordUndoInset();
1841 cur.bv().buffer().params().use_package("amsmath") != BufferParams::package_off;
1842 mutate(align ? hullAlign : hullEqnArray);
1843 // mutate() may change labels and such.
1844 cur.forceBufferUpdate();
1845 cur.idx() = nrows() * ncols() - 1;
1846 cur.pos() = cur.lastpos();
1848 InsetMathGrid::doDispatch(cur, cmd);
1851 case LFUN_MATH_NUMBER_TOGGLE: {
1852 //lyxerr << "toggling all numbers" << endl;
1853 cur.recordUndoInset();
1854 bool old = numberedType();
1855 if (type_ == hullMultline)
1856 numbered(nrows() - 1, !old);
1858 for (row_type row = 0; row < nrows(); ++row)
1859 numbered(row, !old);
1861 cur.message(old ? _("No number") : _("Number"));
1862 cur.forceBufferUpdate();
1866 case LFUN_MATH_NUMBER_LINE_TOGGLE: {
1867 cur.recordUndoInset();
1868 row_type r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1869 bool old = numbered(r);
1870 cur.message(old ? _("No number") : _("Number"));
1872 cur.forceBufferUpdate();
1876 case LFUN_LABEL_INSERT: {
1877 row_type r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1878 docstring old_label = label(r);
1879 docstring const default_label = from_ascii("eq:");
1880 if (old_label.empty())
1881 old_label = default_label;
1883 InsetCommandParams p(LABEL_CODE);
1884 p["name"] = cmd.argument().empty() ? old_label : cmd.argument();
1885 string const data = InsetCommand::params2string(p);
1887 if (cmd.argument().empty())
1888 cur.bv().showDialog("label", data);
1890 FuncRequest fr(LFUN_INSET_INSERT, data);
1896 case LFUN_LABEL_COPY_AS_REFERENCE: {
1898 if (cmd.argument().empty() && &cur.inset() == this)
1899 // if there is no argument and we're inside math, we retrieve
1900 // the row number from the cursor position.
1901 row = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1903 // if there is an argument, find the corresponding label, else
1904 // check whether there is at least one label.
1905 for (row = 0; row != nrows(); ++row)
1906 if (numbered(row) && label_[row]
1907 && (cmd.argument().empty() || label(row) == cmd.argument()))
1914 InsetCommandParams p(REF_CODE, "ref");
1915 p["reference"] = label(row);
1916 cap::clearSelection();
1917 cap::copyInset(cur, new InsetRef(buffer_, p), label(row));
1921 case LFUN_WORD_DELETE_FORWARD:
1922 case LFUN_CHAR_DELETE_FORWARD:
1923 if (col(cur.idx()) + 1 == ncols()
1924 && cur.pos() == cur.lastpos()
1925 && !cur.selection()) {
1926 if (!label(row(cur.idx())).empty()) {
1927 cur.recordUndoInset();
1928 label(row(cur.idx()), docstring());
1929 } else if (numbered(row(cur.idx()))) {
1930 cur.recordUndoInset();
1931 numbered(row(cur.idx()), false);
1932 cur.forceBufferUpdate();
1934 InsetMathGrid::doDispatch(cur, cmd);
1938 InsetMathGrid::doDispatch(cur, cmd);
1943 case LFUN_INSET_INSERT: {
1944 //lyxerr << "arg: " << to_utf8(cmd.argument()) << endl;
1945 // FIXME: this should be cleaned up to use InsetLabel methods directly.
1946 string const name = cmd.getArg(0);
1947 if (name == "label") {
1948 InsetCommandParams p(LABEL_CODE);
1949 InsetCommand::string2params(to_utf8(cmd.argument()), p);
1950 docstring str = p["name"];
1951 cur.recordUndoInset();
1952 row_type const r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1956 docstring old = label(r);
1959 // The label will take care of the reference update.
1963 // Newly created inset so initialize it.
1964 label_[r]->initView();
1967 cur.forceBufferUpdate();
1970 InsetMathGrid::doDispatch(cur, cmd);
1974 case LFUN_MATH_EXTERN:
1975 cur.recordUndoInset();
1979 case LFUN_MATH_MUTATE: {
1980 cur.recordUndoInset();
1981 row_type row = cur.row();
1982 col_type col = cur.col();
1983 mutate(hullType(cmd.argument()));
1984 cur.idx() = row * ncols() + col;
1985 if (cur.idx() > cur.lastidx()) {
1986 cur.idx() = cur.lastidx();
1987 cur.pos() = cur.lastpos();
1989 if (cur.pos() > cur.lastpos())
1990 cur.pos() = cur.lastpos();
1992 cur.forceBufferUpdate();
1993 // FIXME: find some more clever handling of the selection,
1994 // i.e. preserve it.
1995 cur.clearSelection();
1996 //cur.dispatched(FINISHED);
2000 case LFUN_MATH_DISPLAY: {
2001 cur.recordUndoInset();
2002 mutate(type_ == hullSimple ? hullEquation : hullSimple);
2003 // if the cursor is in a cell that got merged, move it to
2004 // start of the hull inset.
2005 if (cur.idx() > 0) {
2009 if (cur.pos() > cur.lastpos())
2010 cur.pos() = cur.lastpos();
2015 case LFUN_TABULAR_FEATURE:
2016 if (!allowsTabularFeatures())
2019 InsetMathGrid::doDispatch(cur, cmd);
2023 InsetMathGrid::doDispatch(cur, cmd);
2031 bool allowDisplayMath(Cursor const & cur)
2033 LATTEST(cur.depth() > 1);
2034 Cursor tmpcur = cur;
2037 FuncRequest cmd(LFUN_MATH_DISPLAY);
2038 return tmpcur.getStatus(cmd, status) && status.enabled();
2044 bool InsetMathHull::getStatus(Cursor & cur, FuncRequest const & cmd,
2045 FuncStatus & status) const
2047 switch (cmd.action()) {
2048 case LFUN_FINISHED_BACKWARD:
2049 case LFUN_FINISHED_FORWARD:
2050 case LFUN_FINISHED_RIGHT:
2051 case LFUN_FINISHED_LEFT:
2054 case LFUN_NEWLINE_INSERT:
2055 case LFUN_MATH_EXTERN:
2057 status.setEnabled(true);
2060 // we never allow this in math, and we want to bind enter
2061 // to another actions in command-alternatives
2062 case LFUN_PARAGRAPH_BREAK:
2063 status.setEnabled(false);
2065 case LFUN_MATH_MUTATE: {
2066 HullType const ht = hullType(cmd.argument());
2067 status.setOnOff(type_ == ht);
2068 status.setEnabled(isMutable(ht) && isMutable(type_));
2070 if (ht != hullSimple && status.enabled())
2071 status.setEnabled(allowDisplayMath(cur));
2074 case LFUN_MATH_DISPLAY: {
2075 status.setEnabled(display() != Inline || allowDisplayMath(cur));
2076 status.setOnOff(display() != Inline);
2080 case LFUN_MATH_NUMBER_TOGGLE:
2081 // FIXME: what is the right test, this or the one of
2083 status.setEnabled(display() != Inline);
2084 status.setOnOff(numberedType());
2087 case LFUN_MATH_NUMBER_LINE_TOGGLE: {
2088 // FIXME: what is the right test, this or the one of
2090 bool const enable = (type_ == hullMultline)
2091 ? (nrows() - 1 == cur.row())
2092 : display() != Inline;
2093 row_type const r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
2094 status.setEnabled(enable);
2095 status.setOnOff(enable && numbered(r));
2099 case LFUN_LABEL_INSERT:
2100 status.setEnabled(type_ != hullSimple);
2103 case LFUN_LABEL_COPY_AS_REFERENCE: {
2104 bool enabled = false;
2105 if (cmd.argument().empty() && &cur.inset() == this) {
2106 // if there is no argument and we're inside math, we retrieve
2107 // the row number from the cursor position.
2108 row_type row = (type_ == hullMultline) ? nrows() - 1 : cur.row();
2109 enabled = numberedType() && label_[row] && numbered(row);
2111 // if there is an argument, find the corresponding label, else
2112 // check whether there is at least one label.
2113 for (row_type row = 0; row != nrows(); ++row) {
2114 if (numbered(row) && label_[row] &&
2115 (cmd.argument().empty() || label(row) == cmd.argument())) {
2121 status.setEnabled(enabled);
2125 case LFUN_INSET_INSERT:
2126 if (cmd.getArg(0) == "label") {
2127 status.setEnabled(type_ != hullSimple);
2130 return InsetMathGrid::getStatus(cur, cmd, status);
2132 case LFUN_TABULAR_FEATURE: {
2133 if (!allowsTabularFeatures())
2135 string s = cmd.getArg(0);
2137 && (s == "append-row"
2138 || s == "delete-row"
2139 || s == "copy-row")) {
2140 status.message(bformat(
2141 from_utf8(N_("Can't change number of rows in '%1$s'")),
2143 status.setEnabled(false);
2147 && (s == "append-column"
2148 || s == "delete-column"
2149 || s == "copy-column")) {
2150 status.message(bformat(
2151 from_utf8(N_("Can't change number of columns in '%1$s'")),
2153 status.setEnabled(false);
2156 if (s == "add-vline-left" || s == "add-vline-right") {
2157 status.message(bformat(
2158 from_utf8(N_("Can't add vertical grid lines in '%1$s'")),
2160 status.setEnabled(false);
2163 if (s == "valign-top" || s == "valign-middle"
2164 || s == "valign-bottom" || s == "align-left"
2165 || s == "align-center" || s == "align-right") {
2166 status.setEnabled(false);
2169 return InsetMathGrid::getStatus(cur, cmd, status);
2173 return InsetMathGrid::getStatus(cur, cmd, status);
2178 int InsetMathHull::leftMargin() const
2180 return (getType() == hullSimple) ? 0 : InsetMathGrid::leftMargin();
2184 int InsetMathHull::rightMargin() const
2186 return (getType() == hullSimple) ? 0 : InsetMathGrid::rightMargin();
2190 int InsetMathHull::border() const
2192 return (getType() == hullSimple) ? 0 : InsetMathGrid::border();
2196 /////////////////////////////////////////////////////////////////////
2200 // simply scrap this function if you want
2201 void InsetMathHull::mutateToText()
2204 // translate to latex
2206 latex(os, false, false);
2207 string str = os.str();
2210 Text * lt = view_->cursor().innerText();
2211 string::const_iterator cit = str.begin();
2212 string::const_iterator end = str.end();
2213 for (; cit != end; ++cit)
2214 view_->getIntl()->getTransManager().TranslateAndInsert(*cit, lt);
2217 //dispatch(LFUN_ESCAPE);
2222 void InsetMathHull::handleFont(Cursor & cur, docstring const & arg,
2223 docstring const & font)
2225 // this whole function is a hack and won't work for incremental font
2228 if (cur.inset().asInsetMath()->name() == font)
2229 cur.handleFont(to_utf8(font));
2231 cur.handleNest(createInsetMath(font, cur.buffer()));
2237 void InsetMathHull::handleFont2(Cursor & cur, docstring const & arg)
2242 font.fromString(to_utf8(arg), b);
2243 if (font.fontInfo().color() != Color_inherit) {
2244 MathAtom at = MathAtom(new InsetMathColor(buffer_, true, font.fontInfo().color()));
2245 cur.handleNest(at, 0);
2250 void InsetMathHull::edit(Cursor & cur, bool front, EntryDirection entry_from)
2253 bool enter_front = (entry_from == Inset::ENTRY_DIRECTION_LEFT ||
2254 (entry_from == Inset::ENTRY_DIRECTION_IGNORE && front));
2255 enter_front ? idxFirst(cur) : idxLast(cur);
2256 // The inset formula dimension is not necessarily the same as the
2257 // one of the instant preview image, so we have to indicate to the
2258 // BufferView that a metrics update is needed.
2259 cur.screenUpdateFlags(Update::Force);
2263 /////////////////////////////////////////////////////////////////////
2267 bool InsetMathHull::searchForward(BufferView * bv, string const & str,
2270 // FIXME: completely broken
2271 static InsetMathHull * lastformula = 0;
2272 static CursorBase current = DocIterator(ibegin(nucleus()));
2274 static string laststr;
2276 if (lastformula != this || laststr != str) {
2277 //lyxerr << "reset lastformula to " << this << endl;
2280 current = ibegin(nucleus());
2282 mathed_parse_cell(ar, str, Parse::NORMAL, &buffer());
2286 //lyxerr << "searching '" << str << "' in " << this << ar << endl;
2288 for (DocIterator it = current; it != iend(nucleus()); increment(it)) {
2289 CursorSlice & top = it.back();
2290 MathData const & a = top.asInsetMath()->cell(top.idx_);
2291 if (a.matchpart(ar, top.pos_)) {
2292 bv->cursor().setSelection(it, ar.size());
2294 top.pos_ += ar.size();
2300 //lyxerr << "not found!" << endl;
2307 void InsetMathHull::write(ostream & os) const
2309 odocstringstream oss;
2310 otexrowstream ots(oss);
2311 WriteStream wi(ots, false, false, WriteStream::wsDefault);
2314 os << to_utf8(oss.str());
2318 void InsetMathHull::read(Lexer & lex)
2321 mathed_parse_normal(buffer_, at, lex, Parse::TRACKMACRO);
2322 operator=(*at->asHullInset());
2326 bool InsetMathHull::readQuiet(Lexer & lex)
2329 bool success = mathed_parse_normal(buffer_, at, lex, Parse::QUIET);
2331 operator=(*at->asHullInset());
2336 int InsetMathHull::plaintext(odocstringstream & os,
2337 OutputParams const & op, size_t max_length) const
2339 // Try enabling this now that there is a flag as requested at #2275.
2340 if (buffer().isExporting() && display()) {
2344 TextPainter tpain(dim.width(), dim.height());
2345 drawT(tpain, 0, dim.ascent());
2347 // reset metrics cache to "real" values
2349 return tpain.textheight();
2352 odocstringstream oss;
2353 otexrowstream ots(oss);
2354 Encoding const * const enc = encodings.fromLyXName("utf8");
2355 WriteStream wi(ots, false, true, WriteStream::wsDefault, enc);
2358 if (type_ == hullRegexp)
2361 for (row_type r = 0; r < nrows(); ++r) {
2362 for (col_type c = 0; c < ncols(); ++c)
2363 wi << (c == 0 ? "" : "\t") << cell(index(r, c));
2364 // if it's for the TOC, we write just the first line
2365 // and do not include the newline.
2366 if (op.for_toc || op.for_tooltip || oss.str().size() >= max_length)
2368 if (r < nrows() - 1)
2372 docstring const str = oss.str();
2378 int InsetMathHull::docbook(odocstream & os, OutputParams const & runparams) const
2383 if (getType() == hullSimple)
2384 name = from_ascii("inlineequation");
2386 name = from_ascii("informalequation");
2388 docstring bname = name;
2389 if (!label(0).empty())
2390 bname += " id='" + sgml::cleanID(buffer(), runparams, label(0)) + "'";
2392 ++ms.tab(); ms.cr(); ms.os() << '<' << bname << '>';
2394 odocstringstream ls;
2396 if (runparams.flavor == OutputParams::XML) {
2397 ms << MTag("alt role='tex' ");
2398 // Workaround for db2latex: db2latex always includes equations with
2399 // \ensuremath{} or \begin{display}\end{display}
2400 // so we strip LyX' math environment
2401 WriteStream wi(ols, false, false, WriteStream::wsDefault, runparams.encoding);
2402 InsetMathGrid::write(wi);
2403 ms << from_utf8(subst(subst(to_utf8(ls.str()), "&", "&"), "<", "<"));
2408 InsetMathGrid::mathmlize(ms);
2411 ms << MTag("alt role='tex'");
2412 latex(ols, runparams);
2413 res = ols.texrow().rows();
2414 ms << from_utf8(subst(subst(to_utf8(ls.str()), "&", "&"), "<", "<"));
2418 ms << from_ascii("<graphic fileref=\"eqn/");
2419 if (!label(0).empty())
2420 ms << sgml::cleanID(buffer(), runparams, label(0));
2422 ms << sgml::uniqueID(from_ascii("anon"));
2424 if (runparams.flavor == OutputParams::XML)
2425 ms << from_ascii("\"/>");
2427 ms << from_ascii("\">");
2429 ms.cr(); --ms.tab(); ms.os() << "</" << name << '>';
2431 return ms.line() + res;
2435 bool InsetMathHull::haveNumbers() const
2437 bool havenumbers = false;
2438 // inline formulas are never numbered (bug 7351 part 3)
2439 if (getType() == hullSimple)
2441 for (size_t i = 0; i != numbered_.size(); ++i) {
2452 // We need to do something about alignment here.
2454 // This duplicates code from InsetMathGrid, but
2455 // we need access here to number information,
2456 // and we simply do not have that in InsetMathGrid.
2457 void InsetMathHull::htmlize(HtmlStream & os) const
2459 bool const havenumbers = haveNumbers();
2460 bool const havetable = havenumbers || nrows() > 1 || ncols() > 1;
2463 os << cell(index(0, 0));
2467 os << MTag("table", "class='mathtable'");
2468 for (row_type row = 0; row < nrows(); ++row) {
2470 for (col_type col = 0; col < ncols(); ++col) {
2472 os << cell(index(row, col));
2477 docstring const & num = numbers_[row];
2479 os << '(' << num << ')';
2484 os << ETag("table");
2488 // this duplicates code from InsetMathGrid, but
2489 // we need access here to number information,
2490 // and we simply do not have that in InsetMathGrid.
2491 void InsetMathHull::mathmlize(MathStream & os) const
2493 bool const havenumbers = haveNumbers();
2494 bool const havetable = havenumbers || nrows() > 1 || ncols() > 1;
2497 os << MTag("mtable");
2498 char const * const celltag = havetable ? "mtd" : "mrow";
2499 // FIXME There does not seem to be wide support at the moment
2500 // for mlabeledtr, so we have to use just mtr for now.
2501 // char const * const rowtag = havenumbers ? "mlabeledtr" : "mtr";
2502 char const * const rowtag = "mtr";
2503 for (row_type row = 0; row < nrows(); ++row) {
2506 for (col_type col = 0; col < ncols(); ++col) {
2508 << cell(index(row, col))
2514 docstring const & num = numbers_[row];
2516 os << '(' << num << ')';
2523 os << ETag("mtable");
2527 void InsetMathHull::mathAsLatex(WriteStream & os) const
2529 MathEnsurer ensurer(os, false);
2530 bool havenumbers = haveNumbers();
2531 bool const havetable = havenumbers || nrows() > 1 || ncols() > 1;
2534 os << cell(index(0, 0));
2538 os << "<table class='mathtable'>";
2539 for (row_type row = 0; row < nrows(); ++row) {
2541 for (col_type col = 0; col < ncols(); ++col) {
2542 os << "<td class='math'>";
2543 os << cell(index(row, col));
2548 docstring const & num = numbers_[row];
2550 os << '(' << num << ')';
2559 docstring InsetMathHull::xhtml(XHTMLStream & xs, OutputParams const & op) const
2561 BufferParams::MathOutput const mathtype =
2562 buffer().masterBuffer()->params().html_math_output;
2564 bool success = false;
2566 // we output all the labels just at the beginning of the equation.
2567 // this should be fine.
2568 for (size_t i = 0; i != label_.size(); ++i) {
2569 InsetLabel const * const il = label_[i];
2575 // FIXME Eventually we would like to do this inset by inset.
2576 if (mathtype == BufferParams::MathML) {
2577 odocstringstream os;
2582 } catch (MathExportException const &) {}
2584 if (getType() == hullSimple)
2585 xs << html::StartTag("math",
2586 "xmlns=\"http://www.w3.org/1998/Math/MathML\"", true);
2588 xs << html::StartTag("math",
2589 "display=\"block\" xmlns=\"http://www.w3.org/1998/Math/MathML\"", true);
2590 xs << XHTMLStream::ESCAPE_NONE
2592 << html::EndTag("math");
2594 } else if (mathtype == BufferParams::HTML) {
2595 odocstringstream os;
2600 } catch (MathExportException const &) {}
2602 string const tag = (getType() == hullSimple) ? "span" : "div";
2603 xs << html::StartTag(tag, "class='formula'", true)
2604 << XHTMLStream::ESCAPE_NONE
2606 << html::EndTag(tag);
2610 // what we actually want is this:
2612 // ((mathtype == BufferParams::MathML || mathtype == BufferParams::HTML)
2614 // || mathtype == BufferParams::Images
2616 // but what follows is equivalent, since we'll enter only if either (a) we
2617 // tried and failed with MathML or HTML or (b) didn't try yet at all but
2618 // aren't doing LaTeX.
2620 // so this is for Images.
2621 if (!success && mathtype != BufferParams::LaTeX) {
2622 graphics::PreviewImage const * pimage = 0;
2624 loadPreview(docit_);
2625 pimage = preview_->getPreviewImage(buffer());
2626 // FIXME Do we always have png?
2629 if (pimage || op.dryrun) {
2630 string const filename = pimage ? pimage->filename().onlyFileName()
2631 : "previewimage.png";
2633 // if we are not in the master buffer, then we need to see that the
2634 // generated image is copied there; otherwise, preview fails.
2635 Buffer const * mbuf = buffer().masterBuffer();
2636 if (mbuf != &buffer()) {
2637 string mbtmp = mbuf->temppath();
2638 FileName const mbufimg(support::addName(mbtmp, filename));
2639 pimage->filename().copyTo(mbufimg);
2641 // add the file to the list of files to be exported
2642 op.exportdata->addExternalFile("xhtml", pimage->filename());
2645 string const tag = (getType() == hullSimple) ? "span" : "div";
2647 << html::StartTag(tag, "style = \"text-align: center;\"")
2648 << html::CompTag("img", "src=\"" + filename + "\" alt=\"Mathematical Equation\"")
2649 << html::EndTag(tag)
2655 // so we'll pass this test if we've failed everything else, or
2656 // if mathtype was LaTeX, since we won't have entered any of the
2658 if (!success /* || mathtype != BufferParams::LaTeX */) {
2659 // Unfortunately, we cannot use latexString() because we do not want
2660 // $...$ or whatever.
2661 odocstringstream ls;
2662 otexrowstream ots(ls);
2663 WriteStream wi(ots, false, true, WriteStream::wsPreview);
2664 ModeSpecifier specifier(wi, MATH_MODE);
2666 docstring const latex = ls.str();
2668 // class='math' allows for use of jsMath
2669 // http://www.math.union.edu/~dpvc/jsMath/
2671 // probably should allow for some kind of customization here
2672 string const tag = (getType() == hullSimple) ? "span" : "div";
2673 xs << html::StartTag(tag, "class='math'")
2675 << html::EndTag(tag)
2682 void InsetMathHull::toString(odocstream & os) const
2684 odocstringstream ods;
2685 plaintext(ods, OutputParams(0));
2690 void InsetMathHull::forOutliner(docstring & os, size_t const, bool const) const
2692 odocstringstream ods;
2695 // FIXME: this results in spilling TeX into the LyXHTML output since the
2696 // outliner is used to generate the LyXHTML list of figures/etc.
2702 string InsetMathHull::contextMenuName() const
2704 return "context-math";
2708 void InsetMathHull::recordLocation(DocIterator const & di)
2714 bool InsetMathHull::canPaintChange(BufferView const &) const
2716 // We let RowPainter do it seamlessly for inline insets
2717 return display() != Inline;