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 Paragraph const & par = it.paragraph();
320 if (!par.isDeleted(it.pos())) {
321 cnts.step(eqstr, utype);
322 numbers_[i] = cnts.theCounter(eqstr, lang);
324 numbers_[i] = from_ascii("#");
326 numbers_[i] = empty_docstring();
332 for (size_t i = 0; i != label_.size(); ++i) {
334 label_[i]->updateBuffer(it, utype);
337 InsetMathGrid::updateBuffer(it, utype);
341 void InsetMathHull::addToToc(DocIterator const & pit, bool output_active,
342 UpdateType utype, TocBackend & backend) const
345 //FIXME: buffer_ should be set at creation for this inset! Problem is
346 // This inset is created at too many places (see Parser::parse1() in
351 TocBuilder & b = backend.builder("equation");
352 // compute first and last item
353 row_type first = nrows();
354 for (row_type row = 0; row != nrows(); ++row)
359 if (first == nrows())
362 row_type last = nrows() - 1;
363 for (; last != 0; --last)
366 // add equation numbers
367 b.pushItem(pit, docstring(), output_active);
369 b.argumentItem(bformat(from_ascii("(%1$s-%2$s)"),
370 numbers_[first], numbers_[last]));
371 for (row_type row = 0; row != nrows(); ++row) {
375 label_[row]->addToToc(pit, output_active, utype, backend);
376 docstring label = nicelabel(row);
378 // this is the only equation
379 b.argumentItem(label);
381 // insert as sub-items
382 b.pushItem(pit, label, output_active);
390 Inset * InsetMathHull::editXY(Cursor & cur, int x, int y)
392 if (previewState(&cur.bv())) {
396 return InsetMathNest::editXY(cur, x, y);
400 InsetMath::mode_type InsetMathHull::currentMode() const
404 return UNDECIDED_MODE;
406 // definitely math mode ...
426 bool InsetMathHull::idxFirst(Cursor & cur) const
434 bool InsetMathHull::idxLast(Cursor & cur) const
436 cur.idx() = nargs() - 1;
437 cur.pos() = cur.lastpos();
442 // FIXME: InsetMathGrid should be changed to let the real column alignment be
443 // given by a virtual method like displayColAlign, because the values produced
444 // by defaultColAlign can be invalidated by lfuns such as add-column. For the
445 // moment the values produced by defaultColAlign are not used, notably because
446 // alignment is not implemented in the LyXHTML output.
447 char InsetMathHull::defaultColAlign(col_type col)
449 return colAlign(type_, col);
453 char InsetMathHull::displayColAlign(idx_type idx) const
457 row_type const r = row(idx);
460 if (r == nrows() - 1)
471 return colAlign(type_, col(idx));
475 return InsetMathGrid::displayColAlign(idx);
479 int InsetMathHull::displayColSpace(col_type col) const
481 return colSpace(type_, col);
485 // FIXME: same comment as for defaultColAlign applies.
486 int InsetMathHull::defaultColSpace(col_type col)
488 return colSpace(type_, col);
492 string InsetMathHull::standardFont() const
498 return "lyxnochange";
505 ColorCode InsetMathHull::standardColor() const
510 return Color_foreground;
518 bool InsetMathHull::previewState(const BufferView *const bv) const
520 if (!editing(bv) && RenderPreview::previewMath()
521 && type_ != hullRegexp)
523 graphics::PreviewImage const * pimage =
524 preview_->getPreviewImage(bv->buffer());
525 return pimage && pimage->image();
532 static const int ERROR_FRAME_WIDTH = 2;
535 void InsetMathHull::metrics(MetricsInfo & mi, Dimension & dim) const
537 if (previewState(mi.base.bv)) {
538 preview_->metrics(mi, dim);
539 if (previewTooSmall(dim)) {
540 // preview image is too small
541 dim.wid += 2 * ERROR_FRAME_WIDTH;
542 dim.asc += 2 * ERROR_FRAME_WIDTH;
544 // insert a one pixel gap in front of the formula
547 dim.des += displayMargin();
552 Changer dummy1 = mi.base.changeFontSet(standardFont());
553 Changer dummy2 = mi.base.font.changeStyle(display() ? LM_ST_DISPLAY
556 // let the cells adjust themselves
557 InsetMathGrid::metrics(mi, dim);
560 dim.asc += displayMargin();
561 dim.des += displayMargin();
564 if (numberedType()) {
565 Changer dummy = mi.base.changeFontSet("mathrm");
567 for (row_type row = 0; row < nrows(); ++row)
568 l = max(l, mathed_string_width(mi.base.font, nicelabel(row)));
571 // Value was hardcoded to 30 pixels
572 dim.wid += Length(0.3, Length::IN).inPixels(mi.base) + l;
575 // reserve some space for marker.
580 bool InsetMathHull::previewTooSmall(Dimension const & dim) const
582 return dim.width() <= 10 && dim.height() <= 10;
586 ColorCode InsetMathHull::backgroundColor(PainterInfo const & pi) const
588 BufferView const * const bv = pi.base.bv;
589 if (previewState(bv)) {
590 Dimension const dim = dimension(*pi.base.bv);
591 if (previewTooSmall(dim))
593 return graphics::PreviewLoader::backgroundColor();
599 void InsetMathHull::drawMarkers(PainterInfo & pi, int x, int y) const
601 ColorCode pen_color = mouseHovered(pi.base.bv) || editing(pi.base.bv)?
602 Color_mathframe : Color_mathcorners;
603 // If the corners have the same color as the background, do not paint them.
604 if (lcolor.getX11Name(Color_mathbg) == lcolor.getX11Name(pen_color))
607 Inset::drawMarkers(pi, x, y);
608 Dimension const dim = dimension(*pi.base.bv);
609 int const t = x + dim.width() - 1;
610 int const a = y - dim.ascent();
611 pi.pain.line(x, a + 3, x, a, pen_color);
612 pi.pain.line(t, a + 3, t, a, pen_color);
613 pi.pain.line(x, a, x + 3, a, pen_color);
614 pi.pain.line(t - 3, a, t, a, pen_color);
618 void InsetMathHull::drawBackground(PainterInfo & pi, int x, int y) const
620 Dimension const dim = dimension(*pi.base.bv);
621 if (previewTooSmall(dim)) {
622 pi.pain.fillRectangle(x, y - 2 * ERROR_FRAME_WIDTH,
623 dim.wid, dim.asc + dim.des, backgroundColor(pi));
626 pi.pain.fillRectangle(x + 1, y - dim.asc + 1, dim.wid - 2,
627 dim.asc + dim.des - 1, pi.backgroundColor(this));
631 void InsetMathHull::draw(PainterInfo & pi, int x, int y) const
633 BufferView const * const bv = pi.base.bv;
634 Dimension const dim = dimension(*bv);
636 if (type_ == hullRegexp)
637 pi.pain.rectangle(x + 2, y - dim.ascent() + 1,
638 dim.width() - 3, dim.height() - 2, Color_regexpframe);
640 if (previewState(bv)) {
641 // Do not draw change tracking cue if taken care of by RowPainter
643 Changer dummy = !canPaintChange(*bv) ? make_change(pi.change_, Change())
645 if (previewTooSmall(dim)) {
646 // we have an extra frame
647 preview_->draw(pi, x + ERROR_FRAME_WIDTH, y);
649 // one pixel gap in front
650 preview_->draw(pi, x + 1, y);
655 ColorCode color = pi.selected && lyxrc.use_system_colors
656 ? Color_selectiontext : standardColor();
657 bool const really_change_color = pi.base.font.color() == Color_none;
658 Changer dummy0 = really_change_color ? pi.base.font.changeColor(color)
660 Changer dummy1 = pi.base.changeFontSet(standardFont());
661 Changer dummy2 = pi.base.font.changeStyle(display() ? LM_ST_DISPLAY
665 BufferParams::MathNumber const math_number = buffer().params().getMathNumber();
666 if (numberedType() && math_number == BufferParams::LEFT) {
667 Changer dummy = pi.base.changeFontSet("mathrm");
669 for (row_type row = 0; row < nrows(); ++row)
670 l = max(l, mathed_string_width(pi.base.font, nicelabel(row)));
673 // Value was hardcoded to 30 pixels
674 xmath += Length(0.3, Length::IN).inPixels(pi.base) + l;
677 InsetMathGrid::draw(pi, xmath + 1, y);
678 drawMarkers(pi, x, y);
680 if (numberedType()) {
681 Changer dummy = pi.base.changeFontSet("mathrm");
682 for (row_type row = 0; row < nrows(); ++row) {
683 int const yy = y + rowinfo_[row].offset_;
684 docstring const nl = nicelabel(row);
685 if (math_number == BufferParams::LEFT)
688 int l = mathed_string_width(pi.base.font, nl);
689 pi.draw(x + dim.wid - l, yy, nl);
694 // drawing change line
695 if (canPaintChange(*bv))
696 pi.change_.paintCue(pi, x + 1, y + 1 - dim.asc,
697 x + dim.wid, y + dim.des);
701 void InsetMathHull::metricsT(TextMetricsInfo const & mi, Dimension & dim) const
704 InsetMathGrid::metricsT(mi, dim);
707 otexrowstream ots(os);
708 WriteStream wi(ots, false, true, WriteStream::wsDefault);
710 dim.wid = os.str().size();
717 void InsetMathHull::drawT(TextPainter & pain, int x, int y) const
720 InsetMathGrid::drawT(pain, x, y);
723 otexrowstream ots(os);
724 WriteStream wi(ots, false, true, WriteStream::wsDefault);
726 pain.draw(x, y, os.str().c_str());
731 static docstring latexString(InsetMathHull const & inset)
734 // This has to be static, because a preview snippet or a math
735 // macro containing math in text mode (such as $\text{$\phi$}$ or
736 // \newcommand{\xxx}{\text{$\phi$}}) gets processed twice. The
737 // first time as a whole, and the second time only the inner math.
738 // In this last case inset.buffer() would be invalid.
739 static Encoding const * encoding = 0;
740 if (inset.isBufferValid())
741 encoding = &(inset.buffer().params().encoding());
742 otexrowstream ots(ls);
743 WriteStream wi(ots, false, true, WriteStream::wsPreview, encoding);
749 void InsetMathHull::initUnicodeMath() const
751 // Trigger classification of the unicode symbols in this inset
752 docstring const dummy = latexString(*this);
756 void InsetMathHull::addPreview(DocIterator const & inset_pos,
757 graphics::PreviewLoader & /*ploader*/) const
759 if (RenderPreview::previewMath()) {
760 preparePreview(inset_pos);
765 void InsetMathHull::usedMacros(MathData const & md, DocIterator const & pos,
766 MacroNameSet & macros, MacroNameSet & defs) const
768 MacroNameSet::iterator const end = macros.end();
770 for (size_t i = 0; i < md.size(); ++i) {
771 InsetMathMacro const * mi = md[i].nucleus()->asMacro();
772 InsetMathMacroTemplate const * mt = md[i].nucleus()->asMacroTemplate();
773 InsetMathScript const * si = md[i].nucleus()->asScriptInset();
774 InsetMathFracBase const * fi = md[i].nucleus()->asFracBaseInset();
775 InsetMathGrid const * gi = md[i].nucleus()->asGridInset();
776 InsetMathNest const * ni = md[i].nucleus()->asNestInset();
778 // Look for macros in the arguments of this macro.
779 for (idx_type idx = 0; idx < mi->nargs(); ++idx)
780 usedMacros(mi->cell(idx), pos, macros, defs);
781 // Make sure this is a macro defined in the document
782 // (as we also spot the macros in the symbols file)
783 // or that we have not already accounted for it.
784 docstring const name = mi->name();
785 if (macros.find(name) == end)
788 // Look for macros in the definition of this macro.
789 MathData ar(pos.buffer());
790 MacroData const * data =
791 pos.buffer()->getMacro(name, pos, true);
793 odocstringstream macro_def;
794 data->write(macro_def, true);
796 defs.insert(macro_def.str());
797 asArray(data->definition(), ar);
799 usedMacros(ar, pos, macros, defs);
801 MathData ar(pos.buffer());
802 asArray(mt->definition(), ar);
803 usedMacros(ar, pos, macros, defs);
805 if (!si->nuc().empty())
806 usedMacros(si->nuc(), pos, macros, defs);
808 usedMacros(si->down(), pos, macros, defs);
810 usedMacros(si->up(), pos, macros, defs);
811 } else if (fi || gi) {
812 idx_type nidx = fi ? fi->nargs() : gi->nargs();
813 for (idx_type idx = 0; idx < nidx; ++idx)
814 usedMacros(fi ? fi->cell(idx) : gi->cell(idx),
817 usedMacros(ni->cell(0), pos, macros, defs);
823 void InsetMathHull::preparePreview(DocIterator const & pos,
824 bool forexport) const
826 // there is no need to do all the macro stuff if we're not
827 // actually going to generate the preview.
828 if (!RenderPreview::previewMath() && !forexport)
831 Buffer const * buffer = pos.buffer();
833 // collect macros at this position
835 buffer->listMacroNames(macros);
837 // collect definitions only for the macros used in this inset
839 for (idx_type idx = 0; idx < nargs(); ++idx)
840 usedMacros(cell(idx), pos, macros, defs);
842 MacroNameSet::iterator it = defs.begin();
843 MacroNameSet::iterator end = defs.end();
844 docstring macro_preamble;
845 for (; it != end; ++it)
846 macro_preamble.append(*it);
848 // set the font series and size for this snippet
849 DocIterator dit = pos.getInnerText();
850 Paragraph const & par = dit.paragraph();
851 Font font = par.getFontSettings(buffer->params(), dit.pos());
852 font.fontInfo().realize(par.layout().font);
853 string const lsize = font.latexSize();
856 if (font.fontInfo().series() == BOLD_SERIES) {
857 setfont += from_ascii("\\textbf{");
860 if (lsize != "normalsize" && !prefixIs(lsize, "error"))
861 setfont += from_ascii("\\" + lsize + '\n');
864 if (forexport && haveNumbers()) {
865 docstring eqstr = from_ascii("equation");
866 CounterMap::const_iterator it = counter_map.find(eqstr);
867 if (it != counter_map.end()) {
868 int num = it->second;
870 setcnt += from_ascii("\\setcounter{") + eqstr + '}' +
871 '{' + convert<docstring>(num) + '}' + '\n';
873 for (size_t i = 0; i != numcnts; ++i) {
874 docstring cnt = from_ascii(counters_to_save[i]);
875 it = counter_map.find(cnt);
876 if (it == counter_map.end())
878 int num = it->second;
880 setcnt += from_ascii("\\setcounter{") + cnt + '}' +
881 '{' + convert<docstring>(num) + '}';
884 docstring const snippet = macro_preamble + setfont + setcnt
885 + latexString(*this) + endfont;
886 LYXERR(Debug::MACROS, "Preview snippet: " << snippet);
887 preview_->addPreview(snippet, *buffer, forexport);
891 void InsetMathHull::reloadPreview(DocIterator const & pos) const
894 preview_->startLoading(*pos.buffer());
898 void InsetMathHull::loadPreview(DocIterator const & pos) const
900 bool const forexport = true;
901 preparePreview(pos, forexport);
902 preview_->startLoading(*pos.buffer(), forexport);
906 bool InsetMathHull::notifyCursorLeaves(Cursor const & old, Cursor & cur)
908 if (RenderPreview::previewMath()) {
910 cur.screenUpdateFlags(Update::Force);
916 docstring InsetMathHull::label(row_type row) const
918 LASSERT(row < nrows(), return docstring());
919 if (InsetLabel * il = label_[row])
920 return il->screenLabel();
925 void InsetMathHull::label(row_type row, docstring const & label)
927 //lyxerr << "setting label '" << label << "' for row " << row << endl;
931 label_[row] = dummy_pointer;
934 label_[row]->updateLabelAndRefs(label);
936 label_[row]->setParam("name", label);
940 InsetCommandParams p(LABEL_CODE);
942 label_[row] = new InsetLabel(buffer_, p);
944 label_[row]->setBuffer(buffer());
948 void InsetMathHull::numbered(row_type row, Numbered num)
950 numbered_[row] = num;
951 if (!numbered(row) && label_[row]) {
958 bool InsetMathHull::numbered(row_type row) const
960 return numbered_[row] == NUMBER;
964 bool InsetMathHull::ams() const
984 for (size_t row = 0; row < numbered_.size(); ++row)
985 if (numbered_[row] == NOTAG)
991 bool InsetMathHull::outerDisplay() const
1014 Inset::DisplayType InsetMathHull::display() const
1031 if (buffer().params().is_math_indent)
1041 int InsetMathHull::indent(BufferView const & bv) const
1043 // FIXME: set this in the textclass. This value is what the article class uses.
1044 static Length default_indent(2.5, Length::EM);
1045 if (display() != Inline && buffer().params().is_math_indent) {
1046 Length const & len = buffer().params().getMathIndent();
1048 return bv.inPixels(default_indent);
1050 return bv.inPixels(len);
1052 return Inset::indent(bv);
1056 bool InsetMathHull::numberedType() const
1075 for (row_type row = 0; row < nrows(); ++row)
1082 void InsetMathHull::validate(LaTeXFeatures & features) const
1084 if (features.runparams().isLaTeX()) {
1086 features.require("amsmath");
1088 if (type_ == hullRegexp) {
1089 features.require("color");
1090 docstring frcol = from_utf8(lcolor.getLaTeXName(Color_regexpframe));
1091 docstring bgcol = from_ascii("white");
1092 features.addPreambleSnippet(
1093 "\\newcommand{\\regexp}[1]{\\fcolorbox{"
1095 + bgcol + "}{\\ensuremath{\\mathtt{#1}}}}");
1096 features.addPreambleSnippet(
1097 from_ascii("\\newcommand{\\endregexp}{}"));
1098 } else if (outerDisplay() && features.inDeletedInset()
1099 && !features.mustProvide("ct-dvipost")) {
1100 features.require("ct-tikz-math-sout");
1103 // Validation is necessary only if not using AMS math.
1104 // To be safe, we will always run mathedvalidate.
1105 //if (features.amsstyle)
1108 //features.binom = true;
1109 } else if (features.runparams().math_flavor == OutputParams::MathAsHTML) {
1110 // it would be better to do this elsewhere, but we can't validate in
1111 // InsetMathMatrix and we have no way, outside MathExtern, to know if
1112 // we even have any matrices.
1113 features.addCSSSnippet(
1114 "table.matrix{display: inline-block; vertical-align: middle; text-align:center;}\n"
1115 "table.matrix td{padding: 0.25px;}\n"
1116 "td.ldelim{width: 0.5ex; border: thin solid black; border-right: none;}\n"
1117 "td.rdelim{width: 0.5ex; border: thin solid black; border-left: none;}");
1119 InsetMathGrid::validate(features);
1123 void InsetMathHull::header_write(WriteStream & os) const
1125 bool n = numberedType();
1136 if (cell(0).empty())
1141 writeMathdisplayPreamble(os);
1145 os << "\\begin{equation" << star(n) << "}\n";
1155 writeMathdisplayPreamble(os);
1158 os << "\\begin{" << hullName(type_) << star(n) << "}\n";
1165 os << "\\begin{" << hullName(type_) << star(n) << '}'
1166 << '{' << static_cast<unsigned int>((ncols() + 1)/2) << "}\n";
1172 os << "\\begin{" << hullName(type_) << '}'
1173 << '{' << static_cast<unsigned int>((ncols() + 1)/2) << "}\n";
1183 os << "\\begin{unknown" << star(n) << "}\n";
1189 void InsetMathHull::footer_write(WriteStream & os) const
1191 bool n = numberedType();
1208 os << "\\end{equation" << star(n) << "}\n";
1211 writeMathdisplayPostamble(os);
1221 os << "\\end{" << hullName(type_) << star(n) << "}\n";
1222 writeMathdisplayPostamble(os);
1229 os << "\\end{" << hullName(type_) << star(n) << "}\n";
1235 os << "\\end{" << hullName(type_) << "}\n";
1239 // Only used as a heuristic to find the regexp termination, when searching in ignore-format mode
1240 os << "\\endregexp{}}";
1246 os << "\\end{unknown" << star(n) << "}\n";
1252 bool InsetMathHull::allowsTabularFeatures() const
1275 bool InsetMathHull::rowChangeOK() const
1278 type_ == hullEqnArray || type_ == hullAlign ||
1279 type_ == hullFlAlign || type_ == hullAlignAt ||
1280 type_ == hullXAlignAt || type_ == hullXXAlignAt ||
1281 type_ == hullGather || type_ == hullMultline;
1285 bool InsetMathHull::colChangeOK() const
1288 type_ == hullAlign || type_ == hullFlAlign ||type_ == hullAlignAt ||
1289 type_ == hullXAlignAt || type_ == hullXXAlignAt;
1293 void InsetMathHull::addRow(row_type row)
1298 bool numbered = numberedType();
1299 // Move the number and raw pointer, do not call label() (bug 7511)
1300 InsetLabel * label = dummy_pointer;
1301 docstring number = empty_docstring();
1302 if (type_ == hullMultline) {
1303 if (row + 1 == nrows()) {
1304 numbered_[row] = NONUMBER;
1305 swap(label, label_[row]);
1306 swap(number, numbers_[row]);
1311 numbered_.insert(numbered_.begin() + row + 1, numbered ? NUMBER : NONUMBER);
1312 numbers_.insert(numbers_.begin() + row + 1, number);
1313 label_.insert(label_.begin() + row + 1, label);
1314 InsetMathGrid::addRow(row);
1318 void InsetMathHull::swapRow(row_type row)
1322 if (row + 1 == nrows())
1324 swap(numbered_[row], numbered_[row + 1]);
1325 swap(numbers_[row], numbers_[row + 1]);
1326 swap(label_[row], label_[row + 1]);
1327 InsetMathGrid::swapRow(row);
1331 void InsetMathHull::delRow(row_type row)
1333 if (nrows() <= 1 || !rowChangeOK())
1335 if (row + 1 == nrows() && type_ == hullMultline) {
1336 swap(numbered_[row - 1], numbered_[row]);
1337 swap(numbers_[row - 1], numbers_[row]);
1338 swap(label_[row - 1], label_[row]);
1339 InsetMathGrid::delRow(row);
1342 InsetMathGrid::delRow(row);
1343 // The last dummy row has no number info nor a label.
1344 // Test nrows() + 1 because we have already erased the row.
1345 if (row == nrows() + 1)
1347 numbered_.erase(numbered_.begin() + row);
1348 numbers_.erase(numbers_.begin() + row);
1350 label_.erase(label_.begin() + row);
1354 void InsetMathHull::addCol(col_type col)
1358 InsetMathGrid::addCol(col);
1362 void InsetMathHull::delCol(col_type col)
1364 if (ncols() <= 1 || !colChangeOK())
1366 InsetMathGrid::delCol(col);
1370 docstring InsetMathHull::nicelabel(row_type row) const
1374 docstring const & val = numbers_[row];
1376 return '(' + val + ')';
1377 return '(' + val + ',' + label_[row]->screenLabel() + ')';
1381 void InsetMathHull::glueall(HullType type)
1384 for (idx_type i = 0; i < nargs(); ++i)
1386 InsetLabel * label = 0;
1387 if (type == hullEquation) {
1388 // preserve first non-empty label
1389 for (row_type row = 0; row < nrows(); ++row) {
1391 label = label_[row];
1397 *this = InsetMathHull(buffer_, hullSimple);
1404 void InsetMathHull::splitTo2Cols()
1406 LASSERT(ncols() == 1, return);
1407 InsetMathGrid::addCol(1);
1408 for (row_type row = 0; row < nrows(); ++row) {
1409 idx_type const i = 2 * row;
1410 pos_type pos = firstRelOp(cell(i));
1411 cell(i + 1) = MathData(buffer_, cell(i).begin() + pos, cell(i).end());
1412 cell(i).erase(pos, cell(i).size());
1417 void InsetMathHull::splitTo3Cols()
1419 LASSERT(ncols() < 3, return);
1422 InsetMathGrid::addCol(2);
1423 for (row_type row = 0; row < nrows(); ++row) {
1424 idx_type const i = 3 * row + 1;
1425 if (!cell(i).empty()) {
1426 cell(i + 1) = MathData(buffer_, cell(i).begin() + 1, cell(i).end());
1427 cell(i).erase(1, cell(i).size());
1433 void InsetMathHull::changeCols(col_type cols)
1435 if (ncols() == cols)
1437 else if (ncols() < cols) {
1443 while (ncols() < cols)
1444 InsetMathGrid::addCol(ncols());
1450 for (row_type row = 0; row < nrows(); ++row) {
1451 idx_type const i = row * ncols();
1452 for (col_type col = cols; col < ncols(); ++col) {
1453 cell(i + cols - 1).append(cell(i + col));
1457 while (ncols() > cols) {
1458 InsetMathGrid::delCol(ncols() - 1);
1463 HullType InsetMathHull::getType() const
1469 void InsetMathHull::setType(HullType type)
1476 bool InsetMathHull::isMutable(HullType type)
1500 void InsetMathHull::mutate(HullType newtype)
1502 //lyxerr << "mutating from '" << type_ << "' to '" << newtype << "'" << endl;
1504 if (newtype == type_)
1507 // This guards the algorithm below it, which is designed with certain types
1509 if (!isMutable(newtype) || !isMutable(type_)) {
1510 lyxerr << "mutation from '" << to_utf8(hullName(type_))
1511 << "' to '" << to_utf8(hullName(newtype))
1512 << "' not implemented" << endl;
1516 // we try to move along the chain
1517 // none <-> simple <-> equation <-> eqnarray -> *align* -> multline, gather -+
1519 // +-------------------------------------+
1520 // we use eqnarray as intermediate type for mutations that are not
1521 // directly supported because it handles labels and numbering for
1526 setType(hullSimple);
1532 if (newtype == hullNone) {
1536 setType(hullEquation);
1537 numbered(0, label_[0] ? true : false);
1546 setType(hullSimple);
1551 // split it "nicely" on the first relop
1553 setType(hullEqnArray);
1561 // split it "nicely"
1596 setType(hullEqnArray);
1605 for (row_type row = 0; row < nrows(); ++row)
1606 numbered(row, false);
1616 for (row_type row = 0; row < nrows(); ++row)
1617 numbered(row, false);
1624 setType(hullEqnArray);
1654 for (row_type row = 0; row < nrows(); ++row)
1655 numbered(row, false);
1659 // first we mutate to EqnArray
1661 setType(hullEqnArray);
1668 // we passed the guard so we should not be here
1669 LASSERT("Mutation not implemented, but should have been.", return);
1675 docstring InsetMathHull::eolString(row_type row, bool fragile, bool latex,
1676 bool last_eoln) const
1679 if (numberedType()) {
1680 if (label_[row] && numbered(row)) {
1681 docstring const name =
1682 latex ? escape(label_[row]->getParam("name"))
1683 : label_[row]->getParam("name");
1684 res += "\\label{" + name + '}';
1686 if (type_ != hullMultline) {
1687 if (numbered_[row] == NONUMBER)
1688 res += "\\nonumber ";
1689 else if (numbered_[row] == NOTAG)
1693 // Never add \\ on the last empty line of eqnarray and friends
1695 return res + InsetMathGrid::eolString(row, fragile, latex, last_eoln);
1698 void InsetMathHull::write(WriteStream & os) const
1700 ModeSpecifier specifier(os, MATH_MODE);
1702 InsetMathGrid::write(os);
1707 void InsetMathHull::normalize(NormalStream & os) const
1709 os << "[formula " << hullName(type_) << ' ';
1710 InsetMathGrid::normalize(os);
1715 void InsetMathHull::infoize(odocstream & os) const
1717 os << bformat(_("Type: %1$s"), hullName(type_));
1721 void InsetMathHull::check() const
1723 LATTEST(numbered_.size() == nrows());
1724 LATTEST(numbers_.size() == nrows());
1725 LATTEST(label_.size() == nrows());
1729 void InsetMathHull::doExtern(Cursor & cur, FuncRequest & func)
1733 idocstringstream iss(func.argument());
1734 iss >> dlang >> extra;
1736 extra = from_ascii("noextra");
1737 string const lang = to_ascii(dlang);
1739 // replace selection with result of computation
1740 if (reduceSelectionToOneCell(cur)) {
1742 asArray(grabAndEraseSelection(cur), ar);
1743 lyxerr << "use selection: " << ar << endl;
1744 cur.insert(pipeThroughExtern(lang, extra, ar));
1748 // only inline, display or eqnarray math is allowed
1749 switch (getType()) {
1755 frontend::Alert::warning(_("Bad math environment"),
1756 _("Computation cannot be performed for AMS "
1757 "math environments.\nChange the math "
1758 "formula type and try again."));
1763 eq.push_back(MathAtom(new InsetMathChar('=')));
1765 // go to first item in line
1766 cur.idx() -= cur.idx() % ncols();
1769 if (getType() == hullSimple) {
1770 size_type pos = cur.cell().find_last(eq);
1772 if (pos == cur.cell().size()) {
1774 lyxerr << "use whole cell: " << ar << endl;
1776 ar = MathData(buffer_, cur.cell().begin() + pos + 1, cur.cell().end());
1777 lyxerr << "use partial cell form pos: " << pos << endl;
1779 cur.cell().append(eq);
1780 cur.cell().append(pipeThroughExtern(lang, extra, ar));
1781 cur.pos() = cur.lastpos();
1785 if (getType() == hullEquation) {
1786 lyxerr << "use equation inset" << endl;
1787 mutate(hullEqnArray);
1788 MathData & ar = cur.cell();
1789 lyxerr << "use cell: " << ar << endl;
1793 cur.cell() = pipeThroughExtern(lang, extra, ar);
1794 // move to end of line
1795 cur.pos() = cur.lastpos();
1800 lyxerr << "use eqnarray" << endl;
1801 cur.idx() += 2 - cur.idx() % ncols();
1803 MathData ar = cur.cell();
1804 lyxerr << "use cell: " << ar << endl;
1805 // FIXME: temporarily disabled
1811 cur.cell() = pipeThroughExtern(lang, extra, ar);
1812 cur.pos() = cur.lastpos();
1817 void InsetMathHull::doDispatch(Cursor & cur, FuncRequest & cmd)
1819 //lyxerr << "action: " << cmd.action() << endl;
1820 switch (cmd.action()) {
1822 case LFUN_FINISHED_BACKWARD:
1823 case LFUN_FINISHED_FORWARD:
1824 case LFUN_FINISHED_RIGHT:
1825 case LFUN_FINISHED_LEFT:
1826 //lyxerr << "action: " << cmd.action() << endl;
1827 InsetMathGrid::doDispatch(cur, cmd);
1830 case LFUN_PARAGRAPH_BREAK:
1831 // just swallow this
1834 case LFUN_NEWLINE_INSERT:
1835 // some magic for the common case
1836 if (type_ == hullSimple || type_ == hullEquation) {
1837 cur.recordUndoInset();
1839 cur.bv().buffer().params().use_package("amsmath") != BufferParams::package_off;
1840 mutate(align ? hullAlign : hullEqnArray);
1841 // mutate() may change labels and such.
1842 cur.forceBufferUpdate();
1843 cur.idx() = nrows() * ncols() - 1;
1844 cur.pos() = cur.lastpos();
1846 InsetMathGrid::doDispatch(cur, cmd);
1849 case LFUN_MATH_NUMBER_TOGGLE: {
1850 //lyxerr << "toggling all numbers" << endl;
1851 cur.recordUndoInset();
1852 bool old = numberedType();
1853 if (type_ == hullMultline)
1854 numbered(nrows() - 1, !old);
1856 for (row_type row = 0; row < nrows(); ++row)
1857 numbered(row, !old);
1859 cur.message(old ? _("No number") : _("Number"));
1860 cur.forceBufferUpdate();
1864 case LFUN_MATH_NUMBER_LINE_TOGGLE: {
1865 cur.recordUndoInset();
1866 row_type r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1867 bool old = numbered(r);
1868 cur.message(old ? _("No number") : _("Number"));
1870 cur.forceBufferUpdate();
1874 case LFUN_LABEL_INSERT: {
1875 row_type r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1876 docstring old_label = label(r);
1877 docstring const default_label = from_ascii("eq:");
1878 if (old_label.empty())
1879 old_label = default_label;
1881 InsetCommandParams p(LABEL_CODE);
1882 p["name"] = cmd.argument().empty() ? old_label : cmd.argument();
1883 string const data = InsetCommand::params2string(p);
1885 if (cmd.argument().empty())
1886 cur.bv().showDialog("label", data);
1888 FuncRequest fr(LFUN_INSET_INSERT, data);
1894 case LFUN_LABEL_COPY_AS_REFERENCE: {
1896 if (cmd.argument().empty() && &cur.inset() == this)
1897 // if there is no argument and we're inside math, we retrieve
1898 // the row number from the cursor position.
1899 row = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1901 // if there is an argument, find the corresponding label, else
1902 // check whether there is at least one label.
1903 for (row = 0; row != nrows(); ++row)
1904 if (numbered(row) && label_[row]
1905 && (cmd.argument().empty() || label(row) == cmd.argument()))
1912 InsetCommandParams p(REF_CODE, "ref");
1913 p["reference"] = label(row);
1914 cap::clearSelection();
1915 cap::copyInset(cur, new InsetRef(buffer_, p), label(row));
1919 case LFUN_WORD_DELETE_FORWARD:
1920 case LFUN_CHAR_DELETE_FORWARD:
1921 if (col(cur.idx()) + 1 == ncols()
1922 && cur.pos() == cur.lastpos()
1923 && !cur.selection()) {
1924 if (!label(row(cur.idx())).empty()) {
1925 cur.recordUndoInset();
1926 label(row(cur.idx()), docstring());
1927 } else if (numbered(row(cur.idx()))) {
1928 cur.recordUndoInset();
1929 numbered(row(cur.idx()), false);
1930 cur.forceBufferUpdate();
1932 InsetMathGrid::doDispatch(cur, cmd);
1936 InsetMathGrid::doDispatch(cur, cmd);
1941 case LFUN_INSET_INSERT: {
1942 //lyxerr << "arg: " << to_utf8(cmd.argument()) << endl;
1943 // FIXME: this should be cleaned up to use InsetLabel methods directly.
1944 string const name = cmd.getArg(0);
1945 if (name == "label") {
1946 InsetCommandParams p(LABEL_CODE);
1947 InsetCommand::string2params(to_utf8(cmd.argument()), p);
1948 docstring str = p["name"];
1949 cur.recordUndoInset();
1950 row_type const r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1954 docstring old = label(r);
1957 // The label will take care of the reference update.
1961 // Newly created inset so initialize it.
1962 label_[r]->initView();
1965 cur.forceBufferUpdate();
1968 InsetMathGrid::doDispatch(cur, cmd);
1972 case LFUN_MATH_EXTERN:
1973 cur.recordUndoInset();
1977 case LFUN_MATH_MUTATE: {
1978 cur.recordUndoInset();
1979 row_type row = cur.row();
1980 col_type col = cur.col();
1981 mutate(hullType(cmd.argument()));
1982 cur.idx() = row * ncols() + col;
1983 if (cur.idx() > cur.lastidx()) {
1984 cur.idx() = cur.lastidx();
1985 cur.pos() = cur.lastpos();
1987 if (cur.pos() > cur.lastpos())
1988 cur.pos() = cur.lastpos();
1990 cur.forceBufferUpdate();
1991 // FIXME: find some more clever handling of the selection,
1992 // i.e. preserve it.
1993 cur.clearSelection();
1994 //cur.dispatched(FINISHED);
1998 case LFUN_MATH_DISPLAY: {
1999 cur.recordUndoInset();
2000 mutate(type_ == hullSimple ? hullEquation : hullSimple);
2001 // if the cursor is in a cell that got merged, move it to
2002 // start of the hull inset.
2003 if (cur.idx() > 0) {
2007 if (cur.pos() > cur.lastpos())
2008 cur.pos() = cur.lastpos();
2013 case LFUN_TABULAR_FEATURE:
2014 if (!allowsTabularFeatures())
2017 InsetMathGrid::doDispatch(cur, cmd);
2021 InsetMathGrid::doDispatch(cur, cmd);
2029 bool allowDisplayMath(Cursor const & cur)
2031 LATTEST(cur.depth() > 1);
2032 Cursor tmpcur = cur;
2035 FuncRequest cmd(LFUN_MATH_DISPLAY);
2036 return tmpcur.getStatus(cmd, status) && status.enabled();
2042 bool InsetMathHull::getStatus(Cursor & cur, FuncRequest const & cmd,
2043 FuncStatus & status) const
2045 switch (cmd.action()) {
2046 case LFUN_FINISHED_BACKWARD:
2047 case LFUN_FINISHED_FORWARD:
2048 case LFUN_FINISHED_RIGHT:
2049 case LFUN_FINISHED_LEFT:
2052 case LFUN_NEWLINE_INSERT:
2053 case LFUN_MATH_EXTERN:
2055 status.setEnabled(true);
2058 // we never allow this in math, and we want to bind enter
2059 // to another actions in command-alternatives
2060 case LFUN_PARAGRAPH_BREAK:
2061 status.setEnabled(false);
2063 case LFUN_MATH_MUTATE: {
2064 HullType const ht = hullType(cmd.argument());
2065 status.setOnOff(type_ == ht);
2066 status.setEnabled(isMutable(ht) && isMutable(type_));
2068 if (ht != hullSimple && status.enabled())
2069 status.setEnabled(allowDisplayMath(cur));
2072 case LFUN_MATH_DISPLAY: {
2073 status.setEnabled(display() != Inline || allowDisplayMath(cur));
2074 status.setOnOff(display() != Inline);
2078 case LFUN_MATH_NUMBER_TOGGLE:
2079 // FIXME: what is the right test, this or the one of
2081 status.setEnabled(display() != Inline);
2082 status.setOnOff(numberedType());
2085 case LFUN_MATH_NUMBER_LINE_TOGGLE: {
2086 // FIXME: what is the right test, this or the one of
2088 bool const enable = (type_ == hullMultline)
2089 ? (nrows() - 1 == cur.row())
2090 : display() != Inline;
2091 row_type const r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
2092 status.setEnabled(enable);
2093 status.setOnOff(enable && numbered(r));
2097 case LFUN_LABEL_INSERT:
2098 status.setEnabled(type_ != hullSimple);
2101 case LFUN_LABEL_COPY_AS_REFERENCE: {
2102 bool enabled = false;
2104 if (cmd.argument().empty() && &cur.inset() == this) {
2105 // if there is no argument and we're inside math, we retrieve
2106 // the row number from the cursor position.
2107 row = (type_ == hullMultline) ? nrows() - 1 : cur.row();
2108 enabled = numberedType() && label_[row] && numbered(row);
2110 // if there is an argument, find the corresponding label, else
2111 // check whether there is at least one label.
2112 for (row_type row = 0; row != nrows(); ++row) {
2113 if (numbered(row) && label_[row] &&
2114 (cmd.argument().empty() || label(row) == cmd.argument())) {
2120 status.setEnabled(enabled);
2124 case LFUN_INSET_INSERT:
2125 if (cmd.getArg(0) == "label") {
2126 status.setEnabled(type_ != hullSimple);
2129 return InsetMathGrid::getStatus(cur, cmd, status);
2131 case LFUN_TABULAR_FEATURE: {
2132 if (!allowsTabularFeatures())
2134 string s = cmd.getArg(0);
2136 && (s == "append-row"
2137 || s == "delete-row"
2138 || s == "copy-row")) {
2139 status.message(bformat(
2140 from_utf8(N_("Can't change number of rows in '%1$s'")),
2142 status.setEnabled(false);
2146 && (s == "append-column"
2147 || s == "delete-column"
2148 || s == "copy-column")) {
2149 status.message(bformat(
2150 from_utf8(N_("Can't change number of columns in '%1$s'")),
2152 status.setEnabled(false);
2155 if (s == "add-vline-left" || s == "add-vline-right") {
2156 status.message(bformat(
2157 from_utf8(N_("Can't add vertical grid lines in '%1$s'")),
2159 status.setEnabled(false);
2162 if (s == "valign-top" || s == "valign-middle"
2163 || s == "valign-bottom" || s == "align-left"
2164 || s == "align-center" || s == "align-right") {
2165 status.setEnabled(false);
2168 return InsetMathGrid::getStatus(cur, cmd, status);
2172 return InsetMathGrid::getStatus(cur, cmd, status);
2177 int InsetMathHull::leftMargin() const
2179 return (getType() == hullSimple) ? 0 : InsetMathGrid::leftMargin();
2183 int InsetMathHull::rightMargin() const
2185 return (getType() == hullSimple) ? 0 : InsetMathGrid::rightMargin();
2189 int InsetMathHull::border() const
2191 return (getType() == hullSimple) ? 0 : InsetMathGrid::border();
2195 /////////////////////////////////////////////////////////////////////
2199 // simply scrap this function if you want
2200 void InsetMathHull::mutateToText()
2203 // translate to latex
2205 latex(os, false, false);
2206 string str = os.str();
2209 Text * lt = view_->cursor().innerText();
2210 string::const_iterator cit = str.begin();
2211 string::const_iterator end = str.end();
2212 for (; cit != end; ++cit)
2213 view_->getIntl()->getTransManager().TranslateAndInsert(*cit, lt);
2216 //dispatch(LFUN_ESCAPE);
2221 void InsetMathHull::handleFont(Cursor & cur, docstring const & arg,
2222 docstring const & font)
2224 // this whole function is a hack and won't work for incremental font
2227 if (cur.inset().asInsetMath()->name() == font)
2228 cur.handleFont(to_utf8(font));
2230 cur.handleNest(createInsetMath(font, cur.buffer()));
2236 void InsetMathHull::handleFont2(Cursor & cur, docstring const & arg)
2241 font.fromString(to_utf8(arg), b);
2242 if (font.fontInfo().color() != Color_inherit) {
2243 MathAtom at = MathAtom(new InsetMathColor(buffer_, true, font.fontInfo().color()));
2244 cur.handleNest(at, 0);
2249 void InsetMathHull::edit(Cursor & cur, bool front, EntryDirection entry_from)
2252 bool enter_front = (entry_from == Inset::ENTRY_DIRECTION_LEFT ||
2253 (entry_from == Inset::ENTRY_DIRECTION_IGNORE && front));
2254 enter_front ? idxFirst(cur) : idxLast(cur);
2255 // The inset formula dimension is not necessarily the same as the
2256 // one of the instant preview image, so we have to indicate to the
2257 // BufferView that a metrics update is needed.
2258 cur.screenUpdateFlags(Update::Force);
2262 void InsetMathHull::revealCodes(Cursor & cur) const
2264 if (!cur.inMathed())
2266 odocstringstream os;
2267 cur.info(os, false);
2268 cur.message(os.str());
2270 // write something to the minibuffer
2271 // translate to latex
2275 string str = os.str();
2277 string::size_type pos = 0;
2279 for (string::iterator it = str.begin(); it != str.end(); ++it) {
2282 else if (*it == '\0') {
2284 pos = it - str.begin();
2290 res = res.substr(pos - 30);
2291 if (res.size() > 60)
2292 res = res.substr(0, 60);
2298 /////////////////////////////////////////////////////////////////////
2302 bool InsetMathHull::searchForward(BufferView * bv, string const & str,
2305 // FIXME: completely broken
2306 static InsetMathHull * lastformula = 0;
2307 static CursorBase current = DocIterator(ibegin(nucleus()));
2309 static string laststr;
2311 if (lastformula != this || laststr != str) {
2312 //lyxerr << "reset lastformula to " << this << endl;
2315 current = ibegin(nucleus());
2317 mathed_parse_cell(ar, str, Parse::NORMAL, &buffer());
2321 //lyxerr << "searching '" << str << "' in " << this << ar << endl;
2323 for (DocIterator it = current; it != iend(nucleus()); increment(it)) {
2324 CursorSlice & top = it.back();
2325 MathData const & a = top.asInsetMath()->cell(top.idx_);
2326 if (a.matchpart(ar, top.pos_)) {
2327 bv->cursor().setSelection(it, ar.size());
2329 top.pos_ += ar.size();
2335 //lyxerr << "not found!" << endl;
2342 void InsetMathHull::write(ostream & os) const
2344 odocstringstream oss;
2345 otexrowstream ots(oss);
2346 WriteStream wi(ots, false, false, WriteStream::wsDefault);
2349 os << to_utf8(oss.str());
2353 void InsetMathHull::read(Lexer & lex)
2356 mathed_parse_normal(buffer_, at, lex, Parse::TRACKMACRO);
2357 operator=(*at->asHullInset());
2361 bool InsetMathHull::readQuiet(Lexer & lex)
2364 bool success = mathed_parse_normal(buffer_, at, lex, Parse::QUIET);
2366 operator=(*at->asHullInset());
2371 int InsetMathHull::plaintext(odocstringstream & os,
2372 OutputParams const & op, size_t max_length) const
2374 // disables ASCII-art for export of equations. See #2275.
2375 if (0 && display()) {
2379 TextPainter tpain(dim.width(), dim.height());
2380 drawT(tpain, 0, dim.ascent());
2382 // reset metrics cache to "real" values
2384 return tpain.textheight();
2387 odocstringstream oss;
2388 otexrowstream ots(oss);
2389 Encoding const * const enc = encodings.fromLyXName("utf8");
2390 WriteStream wi(ots, false, true, WriteStream::wsDefault, enc);
2393 if (type_ == hullRegexp)
2396 for (row_type r = 0; r < nrows(); ++r) {
2397 for (col_type c = 0; c < ncols(); ++c)
2398 wi << (c == 0 ? "" : "\t") << cell(index(r, c));
2399 // if it's for the TOC, we write just the first line
2400 // and do not include the newline.
2401 if (op.for_toc || op.for_tooltip || oss.str().size() >= max_length)
2403 if (r < nrows() - 1)
2407 docstring const str = oss.str();
2413 int InsetMathHull::docbook(odocstream & os, OutputParams const & runparams) const
2418 if (getType() == hullSimple)
2419 name = from_ascii("inlineequation");
2421 name = from_ascii("informalequation");
2423 docstring bname = name;
2424 if (!label(0).empty())
2425 bname += " id='" + sgml::cleanID(buffer(), runparams, label(0)) + "'";
2427 ++ms.tab(); ms.cr(); ms.os() << '<' << bname << '>';
2429 odocstringstream ls;
2431 if (runparams.flavor == OutputParams::XML) {
2432 ms << MTag("alt role='tex' ");
2433 // Workaround for db2latex: db2latex always includes equations with
2434 // \ensuremath{} or \begin{display}\end{display}
2435 // so we strip LyX' math environment
2436 WriteStream wi(ols, false, false, WriteStream::wsDefault, runparams.encoding);
2437 InsetMathGrid::write(wi);
2438 ms << from_utf8(subst(subst(to_utf8(ls.str()), "&", "&"), "<", "<"));
2443 InsetMathGrid::mathmlize(ms);
2446 ms << MTag("alt role='tex'");
2447 latex(ols, runparams);
2448 res = ols.texrow().rows();
2449 ms << from_utf8(subst(subst(to_utf8(ls.str()), "&", "&"), "<", "<"));
2453 ms << from_ascii("<graphic fileref=\"eqn/");
2454 if (!label(0).empty())
2455 ms << sgml::cleanID(buffer(), runparams, label(0));
2457 ms << sgml::uniqueID(from_ascii("anon"));
2459 if (runparams.flavor == OutputParams::XML)
2460 ms << from_ascii("\"/>");
2462 ms << from_ascii("\">");
2464 ms.cr(); --ms.tab(); ms.os() << "</" << name << '>';
2466 return ms.line() + res;
2470 bool InsetMathHull::haveNumbers() const
2472 bool havenumbers = false;
2473 // inline formulas are never numbered (bug 7351 part 3)
2474 if (getType() == hullSimple)
2476 for (size_t i = 0; i != numbered_.size(); ++i) {
2487 // We need to do something about alignment here.
2489 // This duplicates code from InsetMathGrid, but
2490 // we need access here to number information,
2491 // and we simply do not have that in InsetMathGrid.
2492 void InsetMathHull::htmlize(HtmlStream & os) const
2494 bool const havenumbers = haveNumbers();
2495 bool const havetable = havenumbers || nrows() > 1 || ncols() > 1;
2498 os << cell(index(0, 0));
2502 os << MTag("table", "class='mathtable'");
2503 for (row_type row = 0; row < nrows(); ++row) {
2505 for (col_type col = 0; col < ncols(); ++col) {
2507 os << cell(index(row, col));
2512 docstring const & num = numbers_[row];
2514 os << '(' << num << ')';
2519 os << ETag("table");
2523 // this duplicates code from InsetMathGrid, but
2524 // we need access here to number information,
2525 // and we simply do not have that in InsetMathGrid.
2526 void InsetMathHull::mathmlize(MathStream & os) const
2528 bool const havenumbers = haveNumbers();
2529 bool const havetable = havenumbers || nrows() > 1 || ncols() > 1;
2532 os << MTag("mtable");
2533 char const * const celltag = havetable ? "mtd" : "mrow";
2534 // FIXME There does not seem to be wide support at the moment
2535 // for mlabeledtr, so we have to use just mtr for now.
2536 // char const * const rowtag = havenumbers ? "mlabeledtr" : "mtr";
2537 char const * const rowtag = "mtr";
2538 for (row_type row = 0; row < nrows(); ++row) {
2541 for (col_type col = 0; col < ncols(); ++col) {
2543 << cell(index(row, col))
2549 docstring const & num = numbers_[row];
2551 os << '(' << num << ')';
2558 os << ETag("mtable");
2562 void InsetMathHull::mathAsLatex(WriteStream & os) const
2564 MathEnsurer ensurer(os, false);
2565 bool havenumbers = haveNumbers();
2566 bool const havetable = havenumbers || nrows() > 1 || ncols() > 1;
2569 os << cell(index(0, 0));
2573 os << "<table class='mathtable'>";
2574 for (row_type row = 0; row < nrows(); ++row) {
2576 for (col_type col = 0; col < ncols(); ++col) {
2577 os << "<td class='math'>";
2578 os << cell(index(row, col));
2583 docstring const & num = numbers_[row];
2585 os << '(' << num << ')';
2594 docstring InsetMathHull::xhtml(XHTMLStream & xs, OutputParams const & op) const
2596 BufferParams::MathOutput const mathtype =
2597 buffer().masterBuffer()->params().html_math_output;
2599 bool success = false;
2601 // we output all the labels just at the beginning of the equation.
2602 // this should be fine.
2603 for (size_t i = 0; i != label_.size(); ++i) {
2604 InsetLabel const * const il = label_[i];
2610 // FIXME Eventually we would like to do this inset by inset.
2611 if (mathtype == BufferParams::MathML) {
2612 odocstringstream os;
2617 } catch (MathExportException const &) {}
2619 if (getType() == hullSimple)
2620 xs << html::StartTag("math",
2621 "xmlns=\"http://www.w3.org/1998/Math/MathML\"", true);
2623 xs << html::StartTag("math",
2624 "display=\"block\" xmlns=\"http://www.w3.org/1998/Math/MathML\"", true);
2625 xs << XHTMLStream::ESCAPE_NONE
2627 << html::EndTag("math");
2629 } else if (mathtype == BufferParams::HTML) {
2630 odocstringstream os;
2635 } catch (MathExportException const &) {}
2637 string const tag = (getType() == hullSimple) ? "span" : "div";
2638 xs << html::StartTag(tag, "class='formula'", true)
2639 << XHTMLStream::ESCAPE_NONE
2641 << html::EndTag(tag);
2645 // what we actually want is this:
2647 // ((mathtype == BufferParams::MathML || mathtype == BufferParams::HTML)
2649 // || mathtype == BufferParams::Images
2651 // but what follows is equivalent, since we'll enter only if either (a) we
2652 // tried and failed with MathML or HTML or (b) didn't try yet at all but
2653 // aren't doing LaTeX.
2655 // so this is for Images.
2656 if (!success && mathtype != BufferParams::LaTeX) {
2657 graphics::PreviewImage const * pimage = 0;
2659 loadPreview(docit_);
2660 pimage = preview_->getPreviewImage(buffer());
2661 // FIXME Do we always have png?
2664 if (pimage || op.dryrun) {
2665 string const filename = pimage ? pimage->filename().onlyFileName()
2666 : "previewimage.png";
2668 // if we are not in the master buffer, then we need to see that the
2669 // generated image is copied there; otherwise, preview fails.
2670 Buffer const * mbuf = buffer().masterBuffer();
2671 if (mbuf != &buffer()) {
2672 string mbtmp = mbuf->temppath();
2673 FileName const mbufimg(support::addName(mbtmp, filename));
2674 pimage->filename().copyTo(mbufimg);
2676 // add the file to the list of files to be exported
2677 op.exportdata->addExternalFile("xhtml", pimage->filename());
2680 string const tag = (getType() == hullSimple) ? "span" : "div";
2682 << html::StartTag(tag, "style = \"text-align: center;\"")
2683 << html::CompTag("img", "src=\"" + filename + "\" alt=\"Mathematical Equation\"")
2684 << html::EndTag(tag)
2690 // so we'll pass this test if we've failed everything else, or
2691 // if mathtype was LaTeX, since we won't have entered any of the
2693 if (!success /* || mathtype != BufferParams::LaTeX */) {
2694 // Unfortunately, we cannot use latexString() because we do not want
2695 // $...$ or whatever.
2696 odocstringstream ls;
2697 otexrowstream ots(ls);
2698 WriteStream wi(ots, false, true, WriteStream::wsPreview);
2699 ModeSpecifier specifier(wi, MATH_MODE);
2701 docstring const latex = ls.str();
2703 // class='math' allows for use of jsMath
2704 // http://www.math.union.edu/~dpvc/jsMath/
2706 // probably should allow for some kind of customization here
2707 string const tag = (getType() == hullSimple) ? "span" : "div";
2708 xs << html::StartTag(tag, "class='math'")
2710 << html::EndTag(tag)
2717 void InsetMathHull::toString(odocstream & os) const
2719 odocstringstream ods;
2720 plaintext(ods, OutputParams(0));
2725 void InsetMathHull::forOutliner(docstring & os, size_t const, bool const) const
2727 odocstringstream ods;
2730 // FIXME: this results in spilling TeX into the LyXHTML output since the
2731 // outliner is used to generate the LyXHTML list of figures/etc.
2737 string InsetMathHull::contextMenuName() const
2739 return "context-math";
2743 void InsetMathHull::recordLocation(DocIterator const & di)
2749 bool InsetMathHull::canPaintChange(BufferView const &) const
2751 // We let RowPainter do it seamlessly for inline insets
2752 return display() != Inline;