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 += Length(0.3, Length::IN).inPixels(mi.base) + l;
571 // reserve some space for marker.
576 bool InsetMathHull::previewTooSmall(Dimension const & dim) const
578 return dim.width() <= 10 && dim.height() <= 10;
582 ColorCode InsetMathHull::backgroundColor(PainterInfo const & pi) const
584 BufferView const * const bv = pi.base.bv;
585 if (previewState(bv)) {
586 Dimension const dim = dimension(*pi.base.bv);
587 if (previewTooSmall(dim))
589 return graphics::PreviewLoader::backgroundColor();
595 void InsetMathHull::drawMarkers(PainterInfo & pi, int x, int y) const
597 ColorCode pen_color = mouseHovered(pi.base.bv) || editing(pi.base.bv)?
598 Color_mathframe : Color_mathcorners;
599 // If the corners have the same color as the background, do not paint them.
600 if (lcolor.getX11Name(Color_mathbg) == lcolor.getX11Name(pen_color))
603 Inset::drawMarkers(pi, x, y);
604 Dimension const dim = dimension(*pi.base.bv);
605 int const t = x + dim.width() - 1;
606 int const a = y - dim.ascent();
607 pi.pain.line(x, a + 3, x, a, pen_color);
608 pi.pain.line(t, a + 3, t, a, pen_color);
609 pi.pain.line(x, a, x + 3, a, pen_color);
610 pi.pain.line(t - 3, a, t, a, pen_color);
614 void InsetMathHull::drawBackground(PainterInfo & pi, int x, int y) const
616 Dimension const dim = dimension(*pi.base.bv);
617 if (previewTooSmall(dim)) {
618 pi.pain.fillRectangle(x, y - 2 * ERROR_FRAME_WIDTH,
619 dim.wid, dim.asc + dim.des, backgroundColor(pi));
622 pi.pain.fillRectangle(x + 1, y - dim.asc + 1, dim.wid - 2,
623 dim.asc + dim.des - 1, pi.backgroundColor(this));
627 void InsetMathHull::draw(PainterInfo & pi, int x, int y) const
629 BufferView const * const bv = pi.base.bv;
630 Dimension const dim = dimension(*bv);
632 if (type_ == hullRegexp)
633 pi.pain.rectangle(x + 2, y - dim.ascent() + 1,
634 dim.width() - 3, dim.height() - 2, Color_regexpframe);
636 if (previewState(bv)) {
637 // Do not draw change tracking cue if taken care of by RowPainter
639 Changer dummy = !canPaintChange(*bv) ? make_change(pi.change_, Change())
641 if (previewTooSmall(dim)) {
642 // we have an extra frame
643 preview_->draw(pi, x + ERROR_FRAME_WIDTH, y);
645 // one pixel gap in front
646 preview_->draw(pi, x + 1, y);
651 ColorCode color = pi.selected && lyxrc.use_system_colors
652 ? Color_selectiontext : standardColor();
653 bool const really_change_color = pi.base.font.color() == Color_none;
654 Changer dummy0 = really_change_color ? pi.base.font.changeColor(color)
656 Changer dummy1 = pi.base.changeFontSet(standardFont());
657 Changer dummy2 = pi.base.font.changeStyle(display() ? LM_ST_DISPLAY
661 BufferParams::MathNumber const math_number = buffer().params().getMathNumber();
662 if (numberedType() && math_number == BufferParams::LEFT) {
663 Changer dummy = pi.base.changeFontSet("mathrm");
665 for (row_type row = 0; row < nrows(); ++row)
666 l = max(l, mathed_string_width(pi.base.font, nicelabel(row)));
669 // Value was hardcoded to 30 pixels
670 xmath += Length(0.3, Length::IN).inPixels(pi.base) + l;
673 InsetMathGrid::draw(pi, xmath + 1, y);
674 drawMarkers(pi, x, y);
676 if (numberedType()) {
677 Changer dummy = pi.base.changeFontSet("mathrm");
678 for (row_type row = 0; row < nrows(); ++row) {
679 int const yy = y + rowinfo_[row].offset_;
680 docstring const nl = nicelabel(row);
681 if (math_number == BufferParams::LEFT)
684 int l = mathed_string_width(pi.base.font, nl);
685 pi.draw(x + dim.wid - l, yy, nl);
690 // drawing change line
691 if (canPaintChange(*bv))
692 pi.change_.paintCue(pi, x + 1, y + 1 - dim.asc,
693 x + dim.wid, y + dim.des);
697 void InsetMathHull::metricsT(TextMetricsInfo const & mi, Dimension & dim) const
700 InsetMathGrid::metricsT(mi, dim);
703 otexrowstream ots(os);
704 WriteStream wi(ots, false, true, WriteStream::wsDefault);
706 dim.wid = os.str().size();
713 void InsetMathHull::drawT(TextPainter & pain, int x, int y) const
716 InsetMathGrid::drawT(pain, x, y);
719 otexrowstream ots(os);
720 WriteStream wi(ots, false, true, WriteStream::wsDefault);
722 pain.draw(x, y, os.str().c_str());
727 static docstring latexString(InsetMathHull const & inset)
730 // This has to be static, because a preview snippet or a math
731 // macro containing math in text mode (such as $\text{$\phi$}$ or
732 // \newcommand{\xxx}{\text{$\phi$}}) gets processed twice. The
733 // first time as a whole, and the second time only the inner math.
734 // In this last case inset.buffer() would be invalid.
735 static Encoding const * encoding = 0;
736 if (inset.isBufferValid())
737 encoding = &(inset.buffer().params().encoding());
738 otexrowstream ots(ls);
739 WriteStream wi(ots, false, true, WriteStream::wsPreview, encoding);
745 void InsetMathHull::initUnicodeMath() const
747 // Trigger classification of the unicode symbols in this inset
748 docstring const dummy = latexString(*this);
752 void InsetMathHull::addPreview(DocIterator const & inset_pos,
753 graphics::PreviewLoader & /*ploader*/) const
755 if (RenderPreview::previewMath()) {
756 preparePreview(inset_pos);
761 void InsetMathHull::usedMacros(MathData const & md, DocIterator const & pos,
762 MacroNameSet & macros, MacroNameSet & defs) const
764 MacroNameSet::iterator const end = macros.end();
766 for (size_t i = 0; i < md.size(); ++i) {
767 InsetMathMacro const * mi = md[i].nucleus()->asMacro();
768 InsetMathMacroTemplate const * mt = md[i].nucleus()->asMacroTemplate();
769 InsetMathScript const * si = md[i].nucleus()->asScriptInset();
770 InsetMathFracBase const * fi = md[i].nucleus()->asFracBaseInset();
771 InsetMathGrid const * gi = md[i].nucleus()->asGridInset();
772 InsetMathNest const * ni = md[i].nucleus()->asNestInset();
774 // Look for macros in the arguments of this macro.
775 for (idx_type idx = 0; idx < mi->nargs(); ++idx)
776 usedMacros(mi->cell(idx), pos, macros, defs);
777 // Make sure this is a macro defined in the document
778 // (as we also spot the macros in the symbols file)
779 // or that we have not already accounted for it.
780 docstring const name = mi->name();
781 if (macros.find(name) == end)
784 // Look for macros in the definition of this macro.
785 MathData ar(pos.buffer());
786 MacroData const * data =
787 pos.buffer()->getMacro(name, pos, true);
789 odocstringstream macro_def;
790 data->write(macro_def, true);
792 defs.insert(macro_def.str());
793 asArray(data->definition(), ar);
795 usedMacros(ar, pos, macros, defs);
797 MathData ar(pos.buffer());
798 asArray(mt->definition(), ar);
799 usedMacros(ar, pos, macros, defs);
801 if (!si->nuc().empty())
802 usedMacros(si->nuc(), pos, macros, defs);
804 usedMacros(si->down(), pos, macros, defs);
806 usedMacros(si->up(), pos, macros, defs);
807 } else if (fi || gi) {
808 idx_type nidx = fi ? fi->nargs() : gi->nargs();
809 for (idx_type idx = 0; idx < nidx; ++idx)
810 usedMacros(fi ? fi->cell(idx) : gi->cell(idx),
813 usedMacros(ni->cell(0), pos, macros, defs);
819 void InsetMathHull::preparePreview(DocIterator const & pos,
820 bool forexport) const
822 // there is no need to do all the macro stuff if we're not
823 // actually going to generate the preview.
824 if (!RenderPreview::previewMath() && !forexport)
827 Buffer const * buffer = pos.buffer();
829 // collect macros at this position
831 buffer->listMacroNames(macros);
833 // collect definitions only for the macros used in this inset
835 for (idx_type idx = 0; idx < nargs(); ++idx)
836 usedMacros(cell(idx), pos, macros, defs);
838 MacroNameSet::iterator it = defs.begin();
839 MacroNameSet::iterator end = defs.end();
840 docstring macro_preamble;
841 for (; it != end; ++it)
842 macro_preamble.append(*it);
844 // set the font series and size for this snippet
845 DocIterator dit = pos.getInnerText();
846 Paragraph const & par = dit.paragraph();
847 Font font = par.getFontSettings(buffer->params(), dit.pos());
848 font.fontInfo().realize(par.layout().font);
849 string const lsize = font.latexSize();
852 if (font.fontInfo().series() == BOLD_SERIES) {
853 setfont += from_ascii("\\textbf{");
856 if (lsize != "normalsize" && !prefixIs(lsize, "error"))
857 setfont += from_ascii("\\" + lsize + '\n');
860 if (forexport && haveNumbers()) {
861 docstring eqstr = from_ascii("equation");
862 CounterMap::const_iterator it = counter_map.find(eqstr);
863 if (it != counter_map.end()) {
864 int num = it->second;
866 setcnt += from_ascii("\\setcounter{") + eqstr + '}' +
867 '{' + convert<docstring>(num) + '}' + '\n';
869 for (size_t i = 0; i != numcnts; ++i) {
870 docstring cnt = from_ascii(counters_to_save[i]);
871 it = counter_map.find(cnt);
872 if (it == counter_map.end())
874 int num = it->second;
876 setcnt += from_ascii("\\setcounter{") + cnt + '}' +
877 '{' + convert<docstring>(num) + '}';
880 docstring const snippet = macro_preamble + setfont + setcnt
881 + latexString(*this) + endfont;
882 LYXERR(Debug::MACROS, "Preview snippet: " << snippet);
883 preview_->addPreview(snippet, *buffer, forexport);
887 void InsetMathHull::reloadPreview(DocIterator const & pos) const
890 preview_->startLoading(*pos.buffer());
894 void InsetMathHull::loadPreview(DocIterator const & pos) const
896 bool const forexport = true;
897 preparePreview(pos, forexport);
898 preview_->startLoading(*pos.buffer(), forexport);
902 bool InsetMathHull::notifyCursorLeaves(Cursor const & old, Cursor & cur)
904 if (RenderPreview::previewMath()) {
906 cur.screenUpdateFlags(Update::Force);
912 docstring InsetMathHull::label(row_type row) const
914 LASSERT(row < nrows(), return docstring());
915 if (InsetLabel * il = label_[row])
916 return il->screenLabel();
921 void InsetMathHull::label(row_type row, docstring const & label)
923 //lyxerr << "setting label '" << label << "' for row " << row << endl;
927 label_[row] = dummy_pointer;
930 label_[row]->updateLabelAndRefs(label);
932 label_[row]->setParam("name", label);
936 InsetCommandParams p(LABEL_CODE);
938 label_[row] = new InsetLabel(buffer_, p);
940 label_[row]->setBuffer(buffer());
944 void InsetMathHull::numbered(row_type row, Numbered num)
946 numbered_[row] = num;
947 if (!numbered(row) && label_[row]) {
954 bool InsetMathHull::numbered(row_type row) const
956 return numbered_[row] == NUMBER;
960 bool InsetMathHull::ams() const
980 for (size_t row = 0; row < numbered_.size(); ++row)
981 if (numbered_[row] == NOTAG)
987 bool InsetMathHull::outerDisplay() const
1010 Inset::DisplayType InsetMathHull::display() const
1027 if (buffer().params().is_math_indent)
1037 int InsetMathHull::indent(BufferView const & bv) const
1039 // FIXME: set this in the textclass. This value is what the article class uses.
1040 static Length default_indent(2.5, Length::EM);
1041 if (display() != Inline && buffer().params().is_math_indent) {
1042 Length const & len = buffer().params().getMathIndent();
1044 return bv.inPixels(default_indent);
1046 return bv.inPixels(len);
1048 return Inset::indent(bv);
1052 bool InsetMathHull::numberedType() const
1071 for (row_type row = 0; row < nrows(); ++row)
1078 void InsetMathHull::validate(LaTeXFeatures & features) const
1080 if (features.runparams().isLaTeX()) {
1082 features.require("amsmath");
1084 if (type_ == hullRegexp) {
1085 features.require("color");
1086 docstring frcol = from_utf8(lcolor.getLaTeXName(Color_regexpframe));
1087 docstring bgcol = from_ascii("white");
1088 features.addPreambleSnippet(
1089 "\\newcommand{\\regexp}[1]{\\fcolorbox{"
1091 + bgcol + "}{\\ensuremath{\\mathtt{#1}}}}");
1092 features.addPreambleSnippet(
1093 from_ascii("\\newcommand{\\endregexp}{}"));
1094 } else if (outerDisplay() && features.inDeletedInset()
1095 && !features.mustProvide("ct-dvipost")) {
1096 features.require("ct-tikz-math-sout");
1099 // Validation is necessary only if not using AMS math.
1100 // To be safe, we will always run mathedvalidate.
1101 //if (features.amsstyle)
1104 //features.binom = true;
1105 } else if (features.runparams().math_flavor == OutputParams::MathAsHTML) {
1106 // it would be better to do this elsewhere, but we can't validate in
1107 // InsetMathMatrix and we have no way, outside MathExtern, to know if
1108 // we even have any matrices.
1109 features.addCSSSnippet(
1110 "table.matrix{display: inline-block; vertical-align: middle; text-align:center;}\n"
1111 "table.matrix td{padding: 0.25px;}\n"
1112 "td.ldelim{width: 0.5ex; border: thin solid black; border-right: none;}\n"
1113 "td.rdelim{width: 0.5ex; border: thin solid black; border-left: none;}");
1115 InsetMathGrid::validate(features);
1119 void InsetMathHull::header_write(WriteStream & os) const
1121 bool n = numberedType();
1132 if (cell(0).empty())
1137 writeMathdisplayPreamble(os);
1141 os << "\\begin{equation" << star(n) << "}\n";
1151 writeMathdisplayPreamble(os);
1154 os << "\\begin{" << hullName(type_) << star(n) << "}\n";
1161 os << "\\begin{" << hullName(type_) << star(n) << '}'
1162 << '{' << static_cast<unsigned int>((ncols() + 1)/2) << "}\n";
1168 os << "\\begin{" << hullName(type_) << '}'
1169 << '{' << static_cast<unsigned int>((ncols() + 1)/2) << "}\n";
1179 os << "\\begin{unknown" << star(n) << "}\n";
1185 void InsetMathHull::footer_write(WriteStream & os) const
1187 bool n = numberedType();
1204 os << "\\end{equation" << star(n) << "}\n";
1207 writeMathdisplayPostamble(os);
1217 os << "\\end{" << hullName(type_) << star(n) << "}\n";
1218 writeMathdisplayPostamble(os);
1225 os << "\\end{" << hullName(type_) << star(n) << "}\n";
1231 os << "\\end{" << hullName(type_) << "}\n";
1235 // Only used as a heuristic to find the regexp termination, when searching in ignore-format mode
1236 os << "\\endregexp{}}";
1242 os << "\\end{unknown" << star(n) << "}\n";
1248 bool InsetMathHull::allowsTabularFeatures() const
1271 bool InsetMathHull::rowChangeOK() const
1274 type_ == hullEqnArray || type_ == hullAlign ||
1275 type_ == hullFlAlign || type_ == hullAlignAt ||
1276 type_ == hullXAlignAt || type_ == hullXXAlignAt ||
1277 type_ == hullGather || type_ == hullMultline;
1281 bool InsetMathHull::colChangeOK() const
1284 type_ == hullAlign || type_ == hullFlAlign ||type_ == hullAlignAt ||
1285 type_ == hullXAlignAt || type_ == hullXXAlignAt;
1289 void InsetMathHull::addRow(row_type row)
1294 bool numbered = numberedType();
1295 // Move the number and raw pointer, do not call label() (bug 7511)
1296 InsetLabel * label = dummy_pointer;
1297 docstring number = empty_docstring();
1298 if (type_ == hullMultline) {
1299 if (row + 1 == nrows()) {
1300 numbered_[row] = NONUMBER;
1301 swap(label, label_[row]);
1302 swap(number, numbers_[row]);
1307 numbered_.insert(numbered_.begin() + row + 1, numbered ? NUMBER : NONUMBER);
1308 numbers_.insert(numbers_.begin() + row + 1, number);
1309 label_.insert(label_.begin() + row + 1, label);
1310 InsetMathGrid::addRow(row);
1314 void InsetMathHull::swapRow(row_type row)
1318 if (row + 1 == nrows())
1320 swap(numbered_[row], numbered_[row + 1]);
1321 swap(numbers_[row], numbers_[row + 1]);
1322 swap(label_[row], label_[row + 1]);
1323 InsetMathGrid::swapRow(row);
1327 void InsetMathHull::delRow(row_type row)
1329 if (nrows() <= 1 || !rowChangeOK())
1331 if (row + 1 == nrows() && type_ == hullMultline) {
1332 swap(numbered_[row - 1], numbered_[row]);
1333 swap(numbers_[row - 1], numbers_[row]);
1334 swap(label_[row - 1], label_[row]);
1335 InsetMathGrid::delRow(row);
1338 InsetMathGrid::delRow(row);
1339 // The last dummy row has no number info nor a label.
1340 // Test nrows() + 1 because we have already erased the row.
1341 if (row == nrows() + 1)
1343 numbered_.erase(numbered_.begin() + row);
1344 numbers_.erase(numbers_.begin() + row);
1346 label_.erase(label_.begin() + row);
1350 void InsetMathHull::addCol(col_type col)
1354 InsetMathGrid::addCol(col);
1358 void InsetMathHull::delCol(col_type col)
1360 if (ncols() <= 1 || !colChangeOK())
1362 InsetMathGrid::delCol(col);
1366 docstring InsetMathHull::nicelabel(row_type row) const
1370 docstring const & val = numbers_[row];
1372 return '(' + val + ')';
1373 return '(' + val + ',' + label_[row]->screenLabel() + ')';
1377 void InsetMathHull::glueall(HullType type)
1380 for (idx_type i = 0; i < nargs(); ++i)
1382 InsetLabel * label = 0;
1383 if (type == hullEquation) {
1384 // preserve first non-empty label
1385 for (row_type row = 0; row < nrows(); ++row) {
1387 label = label_[row];
1393 *this = InsetMathHull(buffer_, hullSimple);
1400 void InsetMathHull::splitTo2Cols()
1402 LASSERT(ncols() == 1, return);
1403 InsetMathGrid::addCol(1);
1404 for (row_type row = 0; row < nrows(); ++row) {
1405 idx_type const i = 2 * row;
1406 pos_type pos = firstRelOp(cell(i));
1407 cell(i + 1) = MathData(buffer_, cell(i).begin() + pos, cell(i).end());
1408 cell(i).erase(pos, cell(i).size());
1413 void InsetMathHull::splitTo3Cols()
1415 LASSERT(ncols() < 3, return);
1418 InsetMathGrid::addCol(2);
1419 for (row_type row = 0; row < nrows(); ++row) {
1420 idx_type const i = 3 * row + 1;
1421 if (!cell(i).empty()) {
1422 cell(i + 1) = MathData(buffer_, cell(i).begin() + 1, cell(i).end());
1423 cell(i).erase(1, cell(i).size());
1429 void InsetMathHull::changeCols(col_type cols)
1431 if (ncols() == cols)
1433 else if (ncols() < cols) {
1439 while (ncols() < cols)
1440 InsetMathGrid::addCol(ncols());
1446 for (row_type row = 0; row < nrows(); ++row) {
1447 idx_type const i = row * ncols();
1448 for (col_type col = cols; col < ncols(); ++col) {
1449 cell(i + cols - 1).append(cell(i + col));
1453 while (ncols() > cols) {
1454 InsetMathGrid::delCol(ncols() - 1);
1459 HullType InsetMathHull::getType() const
1465 void InsetMathHull::setType(HullType type)
1472 bool InsetMathHull::isMutable(HullType type)
1496 void InsetMathHull::mutate(HullType newtype)
1498 //lyxerr << "mutating from '" << type_ << "' to '" << newtype << "'" << endl;
1500 if (newtype == type_)
1503 // This guards the algorithm below it, which is designed with certain types
1505 if (!isMutable(newtype) || !isMutable(type_)) {
1506 lyxerr << "mutation from '" << to_utf8(hullName(type_))
1507 << "' to '" << to_utf8(hullName(newtype))
1508 << "' not implemented" << endl;
1512 // we try to move along the chain
1513 // none <-> simple <-> equation <-> eqnarray -> *align* -> multline, gather -+
1515 // +-------------------------------------+
1516 // we use eqnarray as intermediate type for mutations that are not
1517 // directly supported because it handles labels and numbering for
1522 setType(hullSimple);
1528 if (newtype == hullNone) {
1532 setType(hullEquation);
1533 numbered(0, label_[0] ? true : false);
1542 setType(hullSimple);
1547 // split it "nicely" on the first relop
1549 setType(hullEqnArray);
1557 // split it "nicely"
1592 setType(hullEqnArray);
1601 for (row_type row = 0; row < nrows(); ++row)
1602 numbered(row, false);
1612 for (row_type row = 0; row < nrows(); ++row)
1613 numbered(row, false);
1620 setType(hullEqnArray);
1650 for (row_type row = 0; row < nrows(); ++row)
1651 numbered(row, false);
1655 // first we mutate to EqnArray
1657 setType(hullEqnArray);
1664 // we passed the guard so we should not be here
1665 LASSERT("Mutation not implemented, but should have been.", return);
1671 docstring InsetMathHull::eolString(row_type row, bool fragile, bool latex,
1672 bool last_eoln) const
1675 if (numberedType()) {
1676 if (label_[row] && numbered(row)) {
1677 docstring const name =
1678 latex ? escape(label_[row]->getParam("name"))
1679 : label_[row]->getParam("name");
1680 res += "\\label{" + name + '}';
1682 if (type_ != hullMultline) {
1683 if (numbered_[row] == NONUMBER)
1684 res += "\\nonumber ";
1685 else if (numbered_[row] == NOTAG)
1689 // Never add \\ on the last empty line of eqnarray and friends
1691 return res + InsetMathGrid::eolString(row, fragile, latex, last_eoln);
1694 void InsetMathHull::write(WriteStream & os) const
1696 ModeSpecifier specifier(os, MATH_MODE);
1698 InsetMathGrid::write(os);
1703 void InsetMathHull::normalize(NormalStream & os) const
1705 os << "[formula " << hullName(type_) << ' ';
1706 InsetMathGrid::normalize(os);
1711 void InsetMathHull::infoize(odocstream & os) const
1713 os << bformat(_("Type: %1$s"), hullName(type_));
1717 void InsetMathHull::check() const
1719 LATTEST(numbered_.size() == nrows());
1720 LATTEST(numbers_.size() == nrows());
1721 LATTEST(label_.size() == nrows());
1725 void InsetMathHull::doExtern(Cursor & cur, FuncRequest & func)
1729 idocstringstream iss(func.argument());
1730 iss >> dlang >> extra;
1732 extra = from_ascii("noextra");
1733 string const lang = to_ascii(dlang);
1735 // replace selection with result of computation
1736 if (reduceSelectionToOneCell(cur)) {
1738 asArray(grabAndEraseSelection(cur), ar);
1739 lyxerr << "use selection: " << ar << endl;
1740 cur.insert(pipeThroughExtern(lang, extra, ar));
1744 // only inline, display or eqnarray math is allowed
1745 switch (getType()) {
1751 frontend::Alert::warning(_("Bad math environment"),
1752 _("Computation cannot be performed for AMS "
1753 "math environments.\nChange the math "
1754 "formula type and try again."));
1759 eq.push_back(MathAtom(new InsetMathChar('=')));
1761 // go to first item in line
1762 cur.idx() -= cur.idx() % ncols();
1765 if (getType() == hullSimple) {
1766 size_type pos = cur.cell().find_last(eq);
1768 if (pos == cur.cell().size()) {
1770 lyxerr << "use whole cell: " << ar << endl;
1772 ar = MathData(buffer_, cur.cell().begin() + pos + 1, cur.cell().end());
1773 lyxerr << "use partial cell form pos: " << pos << endl;
1775 cur.cell().append(eq);
1776 cur.cell().append(pipeThroughExtern(lang, extra, ar));
1777 cur.pos() = cur.lastpos();
1781 if (getType() == hullEquation) {
1782 lyxerr << "use equation inset" << endl;
1783 mutate(hullEqnArray);
1784 MathData & ar = cur.cell();
1785 lyxerr << "use cell: " << ar << endl;
1789 cur.cell() = pipeThroughExtern(lang, extra, ar);
1790 // move to end of line
1791 cur.pos() = cur.lastpos();
1796 lyxerr << "use eqnarray" << endl;
1797 cur.idx() += 2 - cur.idx() % ncols();
1799 MathData ar = cur.cell();
1800 lyxerr << "use cell: " << ar << endl;
1801 // FIXME: temporarily disabled
1807 cur.cell() = pipeThroughExtern(lang, extra, ar);
1808 cur.pos() = cur.lastpos();
1813 void InsetMathHull::doDispatch(Cursor & cur, FuncRequest & cmd)
1815 //lyxerr << "action: " << cmd.action() << endl;
1816 switch (cmd.action()) {
1818 case LFUN_FINISHED_BACKWARD:
1819 case LFUN_FINISHED_FORWARD:
1820 case LFUN_FINISHED_RIGHT:
1821 case LFUN_FINISHED_LEFT:
1822 //lyxerr << "action: " << cmd.action() << endl;
1823 InsetMathGrid::doDispatch(cur, cmd);
1826 case LFUN_PARAGRAPH_BREAK:
1827 // just swallow this
1830 case LFUN_NEWLINE_INSERT:
1831 // some magic for the common case
1832 if (type_ == hullSimple || type_ == hullEquation) {
1833 cur.recordUndoInset();
1835 cur.bv().buffer().params().use_package("amsmath") != BufferParams::package_off;
1836 mutate(align ? hullAlign : hullEqnArray);
1837 // mutate() may change labels and such.
1838 cur.forceBufferUpdate();
1839 cur.idx() = nrows() * ncols() - 1;
1840 cur.pos() = cur.lastpos();
1842 InsetMathGrid::doDispatch(cur, cmd);
1845 case LFUN_MATH_NUMBER_TOGGLE: {
1846 //lyxerr << "toggling all numbers" << endl;
1847 cur.recordUndoInset();
1848 bool old = numberedType();
1849 if (type_ == hullMultline)
1850 numbered(nrows() - 1, !old);
1852 for (row_type row = 0; row < nrows(); ++row)
1853 numbered(row, !old);
1855 cur.message(old ? _("No number") : _("Number"));
1856 cur.forceBufferUpdate();
1860 case LFUN_MATH_NUMBER_LINE_TOGGLE: {
1861 cur.recordUndoInset();
1862 row_type r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1863 bool old = numbered(r);
1864 cur.message(old ? _("No number") : _("Number"));
1866 cur.forceBufferUpdate();
1870 case LFUN_LABEL_INSERT: {
1871 row_type r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1872 docstring old_label = label(r);
1873 docstring const default_label = from_ascii("eq:");
1874 if (old_label.empty())
1875 old_label = default_label;
1877 InsetCommandParams p(LABEL_CODE);
1878 p["name"] = cmd.argument().empty() ? old_label : cmd.argument();
1879 string const data = InsetCommand::params2string(p);
1881 if (cmd.argument().empty())
1882 cur.bv().showDialog("label", data);
1884 FuncRequest fr(LFUN_INSET_INSERT, data);
1890 case LFUN_LABEL_COPY_AS_REFERENCE: {
1892 if (cmd.argument().empty() && &cur.inset() == this)
1893 // if there is no argument and we're inside math, we retrieve
1894 // the row number from the cursor position.
1895 row = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1897 // if there is an argument, find the corresponding label, else
1898 // check whether there is at least one label.
1899 for (row = 0; row != nrows(); ++row)
1900 if (numbered(row) && label_[row]
1901 && (cmd.argument().empty() || label(row) == cmd.argument()))
1908 InsetCommandParams p(REF_CODE, "ref");
1909 p["reference"] = label(row);
1910 cap::clearSelection();
1911 cap::copyInset(cur, new InsetRef(buffer_, p), label(row));
1915 case LFUN_WORD_DELETE_FORWARD:
1916 case LFUN_CHAR_DELETE_FORWARD:
1917 if (col(cur.idx()) + 1 == ncols()
1918 && cur.pos() == cur.lastpos()
1919 && !cur.selection()) {
1920 if (!label(row(cur.idx())).empty()) {
1921 cur.recordUndoInset();
1922 label(row(cur.idx()), docstring());
1923 } else if (numbered(row(cur.idx()))) {
1924 cur.recordUndoInset();
1925 numbered(row(cur.idx()), false);
1926 cur.forceBufferUpdate();
1928 InsetMathGrid::doDispatch(cur, cmd);
1932 InsetMathGrid::doDispatch(cur, cmd);
1937 case LFUN_INSET_INSERT: {
1938 //lyxerr << "arg: " << to_utf8(cmd.argument()) << endl;
1939 // FIXME: this should be cleaned up to use InsetLabel methods directly.
1940 string const name = cmd.getArg(0);
1941 if (name == "label") {
1942 InsetCommandParams p(LABEL_CODE);
1943 InsetCommand::string2params(to_utf8(cmd.argument()), p);
1944 docstring str = p["name"];
1945 cur.recordUndoInset();
1946 row_type const r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1950 docstring old = label(r);
1953 // The label will take care of the reference update.
1957 // Newly created inset so initialize it.
1958 label_[r]->initView();
1961 cur.forceBufferUpdate();
1964 InsetMathGrid::doDispatch(cur, cmd);
1968 case LFUN_MATH_EXTERN:
1969 cur.recordUndoInset();
1973 case LFUN_MATH_MUTATE: {
1974 cur.recordUndoInset();
1975 row_type row = cur.row();
1976 col_type col = cur.col();
1977 mutate(hullType(cmd.argument()));
1978 cur.idx() = row * ncols() + col;
1979 if (cur.idx() > cur.lastidx()) {
1980 cur.idx() = cur.lastidx();
1981 cur.pos() = cur.lastpos();
1983 if (cur.pos() > cur.lastpos())
1984 cur.pos() = cur.lastpos();
1986 cur.forceBufferUpdate();
1987 // FIXME: find some more clever handling of the selection,
1988 // i.e. preserve it.
1989 cur.clearSelection();
1990 //cur.dispatched(FINISHED);
1994 case LFUN_MATH_DISPLAY: {
1995 cur.recordUndoInset();
1996 mutate(type_ == hullSimple ? hullEquation : hullSimple);
1997 // if the cursor is in a cell that got merged, move it to
1998 // start of the hull inset.
1999 if (cur.idx() > 0) {
2003 if (cur.pos() > cur.lastpos())
2004 cur.pos() = cur.lastpos();
2009 case LFUN_TABULAR_FEATURE:
2010 if (!allowsTabularFeatures())
2013 InsetMathGrid::doDispatch(cur, cmd);
2017 InsetMathGrid::doDispatch(cur, cmd);
2025 bool allowDisplayMath(Cursor const & cur)
2027 LATTEST(cur.depth() > 1);
2028 Cursor tmpcur = cur;
2031 FuncRequest cmd(LFUN_MATH_DISPLAY);
2032 return tmpcur.getStatus(cmd, status) && status.enabled();
2038 bool InsetMathHull::getStatus(Cursor & cur, FuncRequest const & cmd,
2039 FuncStatus & status) const
2041 switch (cmd.action()) {
2042 case LFUN_FINISHED_BACKWARD:
2043 case LFUN_FINISHED_FORWARD:
2044 case LFUN_FINISHED_RIGHT:
2045 case LFUN_FINISHED_LEFT:
2048 case LFUN_NEWLINE_INSERT:
2049 case LFUN_MATH_EXTERN:
2051 status.setEnabled(true);
2054 // we never allow this in math, and we want to bind enter
2055 // to another actions in command-alternatives
2056 case LFUN_PARAGRAPH_BREAK:
2057 status.setEnabled(false);
2059 case LFUN_MATH_MUTATE: {
2060 HullType const ht = hullType(cmd.argument());
2061 status.setOnOff(type_ == ht);
2062 status.setEnabled(isMutable(ht) && isMutable(type_));
2064 if (ht != hullSimple && status.enabled())
2065 status.setEnabled(allowDisplayMath(cur));
2068 case LFUN_MATH_DISPLAY: {
2069 status.setEnabled(display() != Inline || allowDisplayMath(cur));
2070 status.setOnOff(display() != Inline);
2074 case LFUN_MATH_NUMBER_TOGGLE:
2075 // FIXME: what is the right test, this or the one of
2077 status.setEnabled(display() != Inline);
2078 status.setOnOff(numberedType());
2081 case LFUN_MATH_NUMBER_LINE_TOGGLE: {
2082 // FIXME: what is the right test, this or the one of
2084 bool const enable = (type_ == hullMultline)
2085 ? (nrows() - 1 == cur.row())
2086 : display() != Inline;
2087 row_type const r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
2088 status.setEnabled(enable);
2089 status.setOnOff(enable && numbered(r));
2093 case LFUN_LABEL_INSERT:
2094 status.setEnabled(type_ != hullSimple);
2097 case LFUN_LABEL_COPY_AS_REFERENCE: {
2098 bool enabled = false;
2100 if (cmd.argument().empty() && &cur.inset() == this) {
2101 // if there is no argument and we're inside math, we retrieve
2102 // the row number from the cursor position.
2103 row = (type_ == hullMultline) ? nrows() - 1 : cur.row();
2104 enabled = numberedType() && label_[row] && numbered(row);
2106 // if there is an argument, find the corresponding label, else
2107 // check whether there is at least one label.
2108 for (row_type row = 0; row != nrows(); ++row) {
2109 if (numbered(row) && label_[row] &&
2110 (cmd.argument().empty() || label(row) == cmd.argument())) {
2116 status.setEnabled(enabled);
2120 case LFUN_INSET_INSERT:
2121 if (cmd.getArg(0) == "label") {
2122 status.setEnabled(type_ != hullSimple);
2125 return InsetMathGrid::getStatus(cur, cmd, status);
2127 case LFUN_TABULAR_FEATURE: {
2128 if (!allowsTabularFeatures())
2130 string s = cmd.getArg(0);
2132 && (s == "append-row"
2133 || s == "delete-row"
2134 || s == "copy-row")) {
2135 status.message(bformat(
2136 from_utf8(N_("Can't change number of rows in '%1$s'")),
2138 status.setEnabled(false);
2142 && (s == "append-column"
2143 || s == "delete-column"
2144 || s == "copy-column")) {
2145 status.message(bformat(
2146 from_utf8(N_("Can't change number of columns in '%1$s'")),
2148 status.setEnabled(false);
2151 if (s == "add-vline-left" || s == "add-vline-right") {
2152 status.message(bformat(
2153 from_utf8(N_("Can't add vertical grid lines in '%1$s'")),
2155 status.setEnabled(false);
2158 if (s == "valign-top" || s == "valign-middle"
2159 || s == "valign-bottom" || s == "align-left"
2160 || s == "align-center" || s == "align-right") {
2161 status.setEnabled(false);
2164 return InsetMathGrid::getStatus(cur, cmd, status);
2168 return InsetMathGrid::getStatus(cur, cmd, status);
2173 int InsetMathHull::leftMargin() const
2175 return (getType() == hullSimple) ? 0 : InsetMathGrid::leftMargin();
2179 int InsetMathHull::rightMargin() const
2181 return (getType() == hullSimple) ? 0 : InsetMathGrid::rightMargin();
2185 int InsetMathHull::border() const
2187 return (getType() == hullSimple) ? 0 : InsetMathGrid::border();
2191 /////////////////////////////////////////////////////////////////////
2195 // simply scrap this function if you want
2196 void InsetMathHull::mutateToText()
2199 // translate to latex
2201 latex(os, false, false);
2202 string str = os.str();
2205 Text * lt = view_->cursor().innerText();
2206 string::const_iterator cit = str.begin();
2207 string::const_iterator end = str.end();
2208 for (; cit != end; ++cit)
2209 view_->getIntl()->getTransManager().TranslateAndInsert(*cit, lt);
2212 //dispatch(LFUN_ESCAPE);
2217 void InsetMathHull::handleFont(Cursor & cur, docstring const & arg,
2218 docstring const & font)
2220 // this whole function is a hack and won't work for incremental font
2223 if (cur.inset().asInsetMath()->name() == font)
2224 cur.handleFont(to_utf8(font));
2226 cur.handleNest(createInsetMath(font, cur.buffer()));
2232 void InsetMathHull::handleFont2(Cursor & cur, docstring const & arg)
2237 font.fromString(to_utf8(arg), b);
2238 if (font.fontInfo().color() != Color_inherit) {
2239 MathAtom at = MathAtom(new InsetMathColor(buffer_, true, font.fontInfo().color()));
2240 cur.handleNest(at, 0);
2245 void InsetMathHull::edit(Cursor & cur, bool front, EntryDirection entry_from)
2248 bool enter_front = (entry_from == Inset::ENTRY_DIRECTION_LEFT ||
2249 (entry_from == Inset::ENTRY_DIRECTION_IGNORE && front));
2250 enter_front ? idxFirst(cur) : idxLast(cur);
2251 // The inset formula dimension is not necessarily the same as the
2252 // one of the instant preview image, so we have to indicate to the
2253 // BufferView that a metrics update is needed.
2254 cur.screenUpdateFlags(Update::Force);
2258 void InsetMathHull::revealCodes(Cursor & cur) const
2260 if (!cur.inMathed())
2262 odocstringstream os;
2263 cur.info(os, false);
2264 cur.message(os.str());
2266 // write something to the minibuffer
2267 // translate to latex
2271 string str = os.str();
2273 string::size_type pos = 0;
2275 for (string::iterator it = str.begin(); it != str.end(); ++it) {
2278 else if (*it == '\0') {
2280 pos = it - str.begin();
2286 res = res.substr(pos - 30);
2287 if (res.size() > 60)
2288 res = res.substr(0, 60);
2294 /////////////////////////////////////////////////////////////////////
2298 bool InsetMathHull::searchForward(BufferView * bv, string const & str,
2301 // FIXME: completely broken
2302 static InsetMathHull * lastformula = 0;
2303 static CursorBase current = DocIterator(ibegin(nucleus()));
2305 static string laststr;
2307 if (lastformula != this || laststr != str) {
2308 //lyxerr << "reset lastformula to " << this << endl;
2311 current = ibegin(nucleus());
2313 mathed_parse_cell(ar, str, Parse::NORMAL, &buffer());
2317 //lyxerr << "searching '" << str << "' in " << this << ar << endl;
2319 for (DocIterator it = current; it != iend(nucleus()); increment(it)) {
2320 CursorSlice & top = it.back();
2321 MathData const & a = top.asInsetMath()->cell(top.idx_);
2322 if (a.matchpart(ar, top.pos_)) {
2323 bv->cursor().setSelection(it, ar.size());
2325 top.pos_ += ar.size();
2331 //lyxerr << "not found!" << endl;
2338 void InsetMathHull::write(ostream & os) const
2340 odocstringstream oss;
2341 otexrowstream ots(oss);
2342 WriteStream wi(ots, false, false, WriteStream::wsDefault);
2345 os << to_utf8(oss.str());
2349 void InsetMathHull::read(Lexer & lex)
2352 mathed_parse_normal(buffer_, at, lex, Parse::TRACKMACRO);
2353 operator=(*at->asHullInset());
2357 bool InsetMathHull::readQuiet(Lexer & lex)
2360 bool success = mathed_parse_normal(buffer_, at, lex, Parse::QUIET);
2362 operator=(*at->asHullInset());
2367 int InsetMathHull::plaintext(odocstringstream & os,
2368 OutputParams const & op, size_t max_length) const
2370 // disables ASCII-art for export of equations. See #2275.
2371 if (0 && display()) {
2375 TextPainter tpain(dim.width(), dim.height());
2376 drawT(tpain, 0, dim.ascent());
2378 // reset metrics cache to "real" values
2380 return tpain.textheight();
2383 odocstringstream oss;
2384 otexrowstream ots(oss);
2385 Encoding const * const enc = encodings.fromLyXName("utf8");
2386 WriteStream wi(ots, false, true, WriteStream::wsDefault, enc);
2389 if (type_ == hullRegexp)
2392 for (row_type r = 0; r < nrows(); ++r) {
2393 for (col_type c = 0; c < ncols(); ++c)
2394 wi << (c == 0 ? "" : "\t") << cell(index(r, c));
2395 // if it's for the TOC, we write just the first line
2396 // and do not include the newline.
2397 if (op.for_toc || op.for_tooltip || oss.str().size() >= max_length)
2399 if (r < nrows() - 1)
2403 docstring const str = oss.str();
2409 int InsetMathHull::docbook(odocstream & os, OutputParams const & runparams) const
2414 if (getType() == hullSimple)
2415 name = from_ascii("inlineequation");
2417 name = from_ascii("informalequation");
2419 docstring bname = name;
2420 if (!label(0).empty())
2421 bname += " id='" + sgml::cleanID(buffer(), runparams, label(0)) + "'";
2423 ++ms.tab(); ms.cr(); ms.os() << '<' << bname << '>';
2425 odocstringstream ls;
2427 if (runparams.flavor == OutputParams::XML) {
2428 ms << MTag("alt role='tex' ");
2429 // Workaround for db2latex: db2latex always includes equations with
2430 // \ensuremath{} or \begin{display}\end{display}
2431 // so we strip LyX' math environment
2432 WriteStream wi(ols, false, false, WriteStream::wsDefault, runparams.encoding);
2433 InsetMathGrid::write(wi);
2434 ms << from_utf8(subst(subst(to_utf8(ls.str()), "&", "&"), "<", "<"));
2439 InsetMathGrid::mathmlize(ms);
2442 ms << MTag("alt role='tex'");
2443 latex(ols, runparams);
2444 res = ols.texrow().rows();
2445 ms << from_utf8(subst(subst(to_utf8(ls.str()), "&", "&"), "<", "<"));
2449 ms << from_ascii("<graphic fileref=\"eqn/");
2450 if (!label(0).empty())
2451 ms << sgml::cleanID(buffer(), runparams, label(0));
2453 ms << sgml::uniqueID(from_ascii("anon"));
2455 if (runparams.flavor == OutputParams::XML)
2456 ms << from_ascii("\"/>");
2458 ms << from_ascii("\">");
2460 ms.cr(); --ms.tab(); ms.os() << "</" << name << '>';
2462 return ms.line() + res;
2466 bool InsetMathHull::haveNumbers() const
2468 bool havenumbers = false;
2469 // inline formulas are never numbered (bug 7351 part 3)
2470 if (getType() == hullSimple)
2472 for (size_t i = 0; i != numbered_.size(); ++i) {
2483 // We need to do something about alignment here.
2485 // This duplicates code from InsetMathGrid, but
2486 // we need access here to number information,
2487 // and we simply do not have that in InsetMathGrid.
2488 void InsetMathHull::htmlize(HtmlStream & os) const
2490 bool const havenumbers = haveNumbers();
2491 bool const havetable = havenumbers || nrows() > 1 || ncols() > 1;
2494 os << cell(index(0, 0));
2498 os << MTag("table", "class='mathtable'");
2499 for (row_type row = 0; row < nrows(); ++row) {
2501 for (col_type col = 0; col < ncols(); ++col) {
2503 os << cell(index(row, col));
2508 docstring const & num = numbers_[row];
2510 os << '(' << num << ')';
2515 os << ETag("table");
2519 // this duplicates code from InsetMathGrid, but
2520 // we need access here to number information,
2521 // and we simply do not have that in InsetMathGrid.
2522 void InsetMathHull::mathmlize(MathStream & os) const
2524 bool const havenumbers = haveNumbers();
2525 bool const havetable = havenumbers || nrows() > 1 || ncols() > 1;
2528 os << MTag("mtable");
2529 char const * const celltag = havetable ? "mtd" : "mrow";
2530 // FIXME There does not seem to be wide support at the moment
2531 // for mlabeledtr, so we have to use just mtr for now.
2532 // char const * const rowtag = havenumbers ? "mlabeledtr" : "mtr";
2533 char const * const rowtag = "mtr";
2534 for (row_type row = 0; row < nrows(); ++row) {
2537 for (col_type col = 0; col < ncols(); ++col) {
2539 << cell(index(row, col))
2545 docstring const & num = numbers_[row];
2547 os << '(' << num << ')';
2554 os << ETag("mtable");
2558 void InsetMathHull::mathAsLatex(WriteStream & os) const
2560 MathEnsurer ensurer(os, false);
2561 bool havenumbers = haveNumbers();
2562 bool const havetable = havenumbers || nrows() > 1 || ncols() > 1;
2565 os << cell(index(0, 0));
2569 os << "<table class='mathtable'>";
2570 for (row_type row = 0; row < nrows(); ++row) {
2572 for (col_type col = 0; col < ncols(); ++col) {
2573 os << "<td class='math'>";
2574 os << cell(index(row, col));
2579 docstring const & num = numbers_[row];
2581 os << '(' << num << ')';
2590 docstring InsetMathHull::xhtml(XHTMLStream & xs, OutputParams const & op) const
2592 BufferParams::MathOutput const mathtype =
2593 buffer().masterBuffer()->params().html_math_output;
2595 bool success = false;
2597 // we output all the labels just at the beginning of the equation.
2598 // this should be fine.
2599 for (size_t i = 0; i != label_.size(); ++i) {
2600 InsetLabel const * const il = label_[i];
2606 // FIXME Eventually we would like to do this inset by inset.
2607 if (mathtype == BufferParams::MathML) {
2608 odocstringstream os;
2613 } catch (MathExportException const &) {}
2615 if (getType() == hullSimple)
2616 xs << html::StartTag("math",
2617 "xmlns=\"http://www.w3.org/1998/Math/MathML\"", true);
2619 xs << html::StartTag("math",
2620 "display=\"block\" xmlns=\"http://www.w3.org/1998/Math/MathML\"", true);
2621 xs << XHTMLStream::ESCAPE_NONE
2623 << html::EndTag("math");
2625 } else if (mathtype == BufferParams::HTML) {
2626 odocstringstream os;
2631 } catch (MathExportException const &) {}
2633 string const tag = (getType() == hullSimple) ? "span" : "div";
2634 xs << html::StartTag(tag, "class='formula'", true)
2635 << XHTMLStream::ESCAPE_NONE
2637 << html::EndTag(tag);
2641 // what we actually want is this:
2643 // ((mathtype == BufferParams::MathML || mathtype == BufferParams::HTML)
2645 // || mathtype == BufferParams::Images
2647 // but what follows is equivalent, since we'll enter only if either (a) we
2648 // tried and failed with MathML or HTML or (b) didn't try yet at all but
2649 // aren't doing LaTeX.
2651 // so this is for Images.
2652 if (!success && mathtype != BufferParams::LaTeX) {
2653 graphics::PreviewImage const * pimage = 0;
2655 loadPreview(docit_);
2656 pimage = preview_->getPreviewImage(buffer());
2657 // FIXME Do we always have png?
2660 if (pimage || op.dryrun) {
2661 string const filename = pimage ? pimage->filename().onlyFileName()
2662 : "previewimage.png";
2664 // if we are not in the master buffer, then we need to see that the
2665 // generated image is copied there; otherwise, preview fails.
2666 Buffer const * mbuf = buffer().masterBuffer();
2667 if (mbuf != &buffer()) {
2668 string mbtmp = mbuf->temppath();
2669 FileName const mbufimg(support::addName(mbtmp, filename));
2670 pimage->filename().copyTo(mbufimg);
2672 // add the file to the list of files to be exported
2673 op.exportdata->addExternalFile("xhtml", pimage->filename());
2676 string const tag = (getType() == hullSimple) ? "span" : "div";
2678 << html::StartTag(tag, "style = \"text-align: center;\"")
2679 << html::CompTag("img", "src=\"" + filename + "\" alt=\"Mathematical Equation\"")
2680 << html::EndTag(tag)
2686 // so we'll pass this test if we've failed everything else, or
2687 // if mathtype was LaTeX, since we won't have entered any of the
2689 if (!success /* || mathtype != BufferParams::LaTeX */) {
2690 // Unfortunately, we cannot use latexString() because we do not want
2691 // $...$ or whatever.
2692 odocstringstream ls;
2693 otexrowstream ots(ls);
2694 WriteStream wi(ots, false, true, WriteStream::wsPreview);
2695 ModeSpecifier specifier(wi, MATH_MODE);
2697 docstring const latex = ls.str();
2699 // class='math' allows for use of jsMath
2700 // http://www.math.union.edu/~dpvc/jsMath/
2702 // probably should allow for some kind of customization here
2703 string const tag = (getType() == hullSimple) ? "span" : "div";
2704 xs << html::StartTag(tag, "class='math'")
2706 << html::EndTag(tag)
2713 void InsetMathHull::toString(odocstream & os) const
2715 odocstringstream ods;
2716 plaintext(ods, OutputParams(0));
2721 void InsetMathHull::forOutliner(docstring & os, size_t const, bool const) const
2723 odocstringstream ods;
2726 // FIXME: this results in spilling TeX into the LyXHTML output since the
2727 // outliner is used to generate the LyXHTML list of figures/etc.
2733 string InsetMathHull::contextMenuName() const
2735 return "context-math";
2739 void InsetMathHull::recordLocation(DocIterator const & di)
2745 bool InsetMathHull::canPaintChange(BufferView const &) const
2747 // We let RowPainter do it seamlessly for inline insets
2748 return display() != Inline;