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 "InsetMathGrid.h"
19 #include "InsetMathNest.h"
20 #include "InsetMathScript.h"
21 #include "MathExtern.h"
22 #include "MathFactory.h"
23 #include "MathStream.h"
24 #include "MathSupport.h"
27 #include "BufferParams.h"
28 #include "BufferView.h"
30 #include "CutAndPaste.h"
33 #include "FuncRequest.h"
34 #include "FuncStatus.h"
36 #include "LaTeXFeatures.h"
38 #include "MacroTable.h"
39 #include "MathMacro.h"
40 #include "MathMacroTemplate.h"
41 #include "MetricsInfo.h"
42 #include "output_xhtml.h"
43 #include "Paragraph.h"
44 #include "ParIterator.h"
47 #include "TextClass.h"
48 #include "TextPainter.h"
49 #include "TocBackend.h"
51 #include "insets/InsetLabel.h"
52 #include "insets/InsetRef.h"
53 #include "insets/RenderPreview.h"
55 #include "graphics/GraphicsImage.h"
56 #include "graphics/PreviewImage.h"
57 #include "graphics/PreviewLoader.h"
59 #include "frontends/alert.h"
60 #include "frontends/Painter.h"
62 #include "support/convert.h"
63 #include "support/debug.h"
64 #include "support/gettext.h"
65 #include "support/filetools.h"
66 #include "support/lassert.h"
67 #include "support/lstrings.h"
68 #include "support/RefChanger.h"
73 using namespace lyx::support;
77 using cap::grabAndEraseSelection;
78 using cap::reduceSelectionToOneCell;
82 int getCols(HullType type)
107 // returns position of first relation operator in the array
108 // used for "intelligent splitting"
109 size_t firstRelOp(MathData const & ar)
111 for (MathData::const_iterator it = ar.begin(); it != ar.end(); ++it)
112 if ((*it)->isMathRel())
113 return it - ar.begin();
118 char const * star(bool numbered)
120 return numbered ? "" : "*";
124 } // end anon namespace
127 HullType hullType(docstring const & s)
129 if (s == "none") return hullNone;
130 if (s == "simple") return hullSimple;
131 if (s == "equation") return hullEquation;
132 if (s == "eqnarray") return hullEqnArray;
133 if (s == "align") return hullAlign;
134 if (s == "alignat") return hullAlignAt;
135 if (s == "xalignat") return hullXAlignAt;
136 if (s == "xxalignat") return hullXXAlignAt;
137 if (s == "multline") return hullMultline;
138 if (s == "gather") return hullGather;
139 if (s == "flalign") return hullFlAlign;
140 if (s == "regexp") return hullRegexp;
141 lyxerr << "unknown hull type '" << to_utf8(s) << "'" << endl;
146 docstring hullName(HullType type)
149 case hullNone: return from_ascii("none");
150 case hullSimple: return from_ascii("simple");
151 case hullEquation: return from_ascii("equation");
152 case hullEqnArray: return from_ascii("eqnarray");
153 case hullAlign: return from_ascii("align");
154 case hullAlignAt: return from_ascii("alignat");
155 case hullXAlignAt: return from_ascii("xalignat");
156 case hullXXAlignAt: return from_ascii("xxalignat");
157 case hullMultline: return from_ascii("multline");
158 case hullGather: return from_ascii("gather");
159 case hullFlAlign: return from_ascii("flalign");
160 case hullRegexp: return from_ascii("regexp");
162 lyxerr << "unknown hull type" << endl;
165 return from_ascii("none");
168 static InsetLabel * dummy_pointer = 0;
170 InsetMathHull::InsetMathHull(Buffer * buf)
171 : InsetMathGrid(buf, 1, 1), type_(hullNone), numbered_(1, NUMBER),
172 numbers_(1, empty_docstring()), label_(1, dummy_pointer),
173 preview_(new RenderPreview(this))
175 //lyxerr << "sizeof InsetMath: " << sizeof(InsetMath) << endl;
176 //lyxerr << "sizeof MetricsInfo: " << sizeof(MetricsInfo) << endl;
177 //lyxerr << "sizeof InsetMathChar: " << sizeof(InsetMathChar) << endl;
178 //lyxerr << "sizeof FontInfo: " << sizeof(FontInfo) << endl;
185 InsetMathHull::InsetMathHull(Buffer * buf, HullType type)
186 : InsetMathGrid(buf, getCols(type), 1), type_(type), numbered_(1, NUMBER),
187 numbers_(1, empty_docstring()), label_(1, dummy_pointer),
188 preview_(new RenderPreview(this))
196 InsetMathHull::InsetMathHull(InsetMathHull const & other) : InsetMathGrid(other)
202 InsetMathHull::~InsetMathHull()
204 for (size_t i = 0; i < label_.size(); ++i)
209 Inset * InsetMathHull::clone() const
211 return new InsetMathHull(*this);
215 InsetMathHull & InsetMathHull::operator=(InsetMathHull const & other)
219 InsetMathGrid::operator=(other);
221 numbered_ = other.numbered_;
222 numbers_ = other.numbers_;
223 buffer_ = other.buffer_;
224 for (size_t i = 0; i < label_.size(); ++i)
226 label_ = other.label_;
227 for (size_t i = 0; i != label_.size(); ++i) {
229 label_[i] = new InsetLabel(*label_[i]);
231 preview_.reset(new RenderPreview(*other.preview_, this));
237 void InsetMathHull::setBuffer(Buffer & buffer)
239 InsetMathGrid::setBuffer(buffer);
241 for (size_t i = 0; i != label_.size(); ++i) {
243 label_[i]->setBuffer(buffer);
248 // FIXME This should really be controlled by the TOC level, or
249 // something of the sort.
251 const char * counters_to_save[] = {"section", "chapter"};
252 unsigned int const numcnts = sizeof(counters_to_save)/sizeof(char *);
256 void InsetMathHull::updateBuffer(ParIterator const & it, UpdateType utype)
259 //FIXME: buffer_ should be set at creation for this inset! Problem is
260 // This inset is created at too many places (see Parser::parse1() in
265 // if any of the equations are numbered, then we want to save the values
266 // of some of the counters.
268 BufferParams const & bp = buffer_->params();
269 string const & lang = it->getParLanguage(bp)->code();
271 buffer_->masterBuffer()->params().documentClass().counters();
273 // right now, we only need to do this at export time
274 if (utype == OutputUpdate) {
275 for (size_t i = 0; i < numcnts; ++i) {
276 docstring const cnt = from_ascii(counters_to_save[i]);
277 if (cnts.hasCounter(cnt))
278 counter_map[cnt] = cnts.value(cnt);
282 // this has to be done separately
283 docstring const eqstr = from_ascii("equation");
284 if (cnts.hasCounter(eqstr)) {
285 if (utype == OutputUpdate)
286 counter_map[eqstr] = cnts.value(eqstr);
287 for (size_t i = 0; i != label_.size(); ++i) {
289 cnts.step(eqstr, utype);
290 numbers_[i] = cnts.theCounter(eqstr, lang);
292 numbers_[i] = empty_docstring();
298 for (size_t i = 0; i != label_.size(); ++i) {
300 label_[i]->updateBuffer(it, utype);
303 InsetMathGrid::updateBuffer(it, utype);
307 void InsetMathHull::addToToc(DocIterator const & pit, bool output_active,
308 UpdateType utype) const
311 //FIXME: buffer_ should be set at creation for this inset! Problem is
312 // This inset is created at too many places (see Parser::parse1() in
317 shared_ptr<Toc> toc = buffer().tocBackend().toc("equation");
319 for (row_type row = 0; row != nrows(); ++row) {
323 label_[row]->addToToc(pit, output_active, utype);
324 toc->push_back(TocItem(pit, 0, nicelabel(row), output_active));
329 Inset * InsetMathHull::editXY(Cursor & cur, int x, int y)
331 if (previewState(&cur.bv())) {
335 return InsetMathNest::editXY(cur, x, y);
339 InsetMath::mode_type InsetMathHull::currentMode() const
343 return UNDECIDED_MODE;
345 // definitely math mode ...
365 bool InsetMathHull::idxFirst(Cursor & cur) const
373 bool InsetMathHull::idxLast(Cursor & cur) const
375 cur.idx() = nargs() - 1;
376 cur.pos() = cur.lastpos();
381 // FIXME: InsetMathGrid should be changed to let the real column alignment be
382 // given by a virtual method like displayColAlign, because the values produced
383 // by defaultColAlign can be invalidated by lfuns such as add-column. For the
384 // moment the values produced by defaultColAlign are not used, notably because
385 // alignment is not implemented in the LyXHTML output.
386 char InsetMathHull::defaultColAlign(col_type col)
388 return colAlign(type_, col);
392 char InsetMathHull::displayColAlign(idx_type idx) const
396 row_type const r = row(idx);
399 if (r == nrows() - 1)
410 return colAlign(type_, col(idx));
414 return InsetMathGrid::displayColAlign(idx);
418 int InsetMathHull::displayColSpace(col_type col) const
420 return colSpace(type_, col);
424 // FIXME: same comment as for defaultColAlign applies.
425 int InsetMathHull::defaultColSpace(col_type col)
427 return colSpace(type_, col);
431 string InsetMathHull::standardFont() const
437 return "lyxnochange";
444 ColorCode InsetMathHull::standardColor() const
449 return Color_foreground;
457 bool InsetMathHull::previewState(const BufferView *const bv) const
459 if (!editing(bv) && RenderPreview::previewMath()
460 && type_ != hullRegexp)
462 graphics::PreviewImage const * pimage =
463 preview_->getPreviewImage(bv->buffer());
464 return pimage && pimage->image();
471 static const int ERROR_FRAME_WIDTH = 2;
474 void InsetMathHull::metrics(MetricsInfo & mi, Dimension & dim) const
476 if (previewState(mi.base.bv)) {
477 preview_->metrics(mi, dim);
478 if (previewTooSmall(dim)) {
479 // preview image is too small
480 dim.wid += 2 * ERROR_FRAME_WIDTH;
481 dim.asc += 2 * ERROR_FRAME_WIDTH;
483 // insert a one pixel gap in front of the formula
486 dim.des += displayMargin();
488 // Cache the inset dimension.
489 setDimCache(mi, dim);
493 // FIXME: Changing the same object repeatedly is inefficient.
494 Changer dummy1 = mi.base.changeFontSet(standardFont());
495 Changer dummy2 = mi.base.changeStyle(display() ? LM_ST_DISPLAY : LM_ST_TEXT);
497 // let the cells adjust themselves
498 InsetMathGrid::metrics(mi, dim);
501 dim.asc += displayMargin();
502 dim.des += displayMargin();
505 if (numberedType()) {
506 Changer dummy = mi.base.changeFontSet("mathbf");
508 for (row_type row = 0; row < nrows(); ++row)
509 l = max(l, mathed_string_width(mi.base.font, nicelabel(row)));
515 if (type_ == hullRegexp)
517 // make it at least as high as the current font
520 math_font_max_dim(mi.base.font, asc, des);
521 dim.asc = max(dim.asc, asc);
522 dim.des = max(dim.des, des);
523 // Cache the inset dimension.
524 // FIXME: This will overwrite InsetMathGrid dimension, is that OK?
525 setDimCache(mi, dim);
529 bool InsetMathHull::previewTooSmall(Dimension const & dim) const
531 return dim.width() <= 10 && dim.height() <= 10;
535 ColorCode InsetMathHull::backgroundColor(PainterInfo const & pi) const
537 BufferView const * const bv = pi.base.bv;
538 if (previewState(bv)) {
539 Dimension const dim = dimension(*pi.base.bv);
540 if (previewTooSmall(dim))
542 return graphics::PreviewLoader::backgroundColor();
548 void InsetMathHull::drawBackground(PainterInfo & pi, int x, int y) const
550 Dimension const dim = dimension(*pi.base.bv);
551 if (previewTooSmall(dim)) {
552 pi.pain.fillRectangle(x, y - 2 * ERROR_FRAME_WIDTH,
553 dim.wid, dim.asc + dim.des, backgroundColor(pi));
556 pi.pain.fillRectangle(x + 1, y - dim.asc + 1, dim.wid - 2,
557 dim.asc + dim.des - 1, pi.backgroundColor(this));
561 void InsetMathHull::draw(PainterInfo & pi, int x, int y) const
563 BufferView const * const bv = pi.base.bv;
564 Dimension const dim = dimension(*bv);
566 if (type_ == hullRegexp) {
567 pi.pain.rectangle(x + 1, y - dim.ascent() + 1,
568 dim.width() - 2, dim.height() - 2, Color_regexpframe);
571 if (previewState(bv)) {
572 // Do not draw change tracking cue if taken care of by RowPainter
574 Changer dummy = make_change(pi.change_, Change(), !canPaintChange(*bv));
575 if (previewTooSmall(dim)) {
576 // we have an extra frame
577 preview_->draw(pi, x + ERROR_FRAME_WIDTH, y);
579 // one pixel gap in front
580 preview_->draw(pi, x + 1, y);
582 setPosCache(pi, x, y);
586 ColorCode color = pi.selected && lyxrc.use_system_colors
587 ? Color_selectiontext : standardColor();
588 bool const really_change_color = pi.base.font.color() == Color_none;
589 Changer dummy0 = pi.base.font.changeColor(color, really_change_color);
590 Changer dummy1 = pi.base.changeFontSet(standardFont());
591 Changer dummy2 = pi.base.changeStyle(display() ? LM_ST_DISPLAY : LM_ST_TEXT);
593 InsetMathGrid::draw(pi, x + 1, y);
595 if (numberedType()) {
596 int const xx = x + colinfo_.back().offset_ + colinfo_.back().width_ + 20;
597 for (row_type row = 0; row < nrows(); ++row) {
598 int const yy = y + rowinfo_[row].offset_;
599 Changer dummy = pi.base.changeFontSet("mathrm");
600 docstring const nl = nicelabel(row);
604 // drawing change line
605 if (canPaintChange(*bv))
606 pi.change_.paintCue(pi, x + 1, y + 1 - dim.asc,
607 x + dim.wid, y + dim.des);
608 setPosCache(pi, x, y);
612 void InsetMathHull::metricsT(TextMetricsInfo const & mi, Dimension & dim) const
615 InsetMathGrid::metricsT(mi, dim);
618 otexrowstream ots(os, false);
619 WriteStream wi(ots, false, true, WriteStream::wsDefault);
621 dim.wid = os.str().size();
628 void InsetMathHull::drawT(TextPainter & pain, int x, int y) const
631 InsetMathGrid::drawT(pain, x, y);
634 otexrowstream ots(os, false);
635 WriteStream wi(ots, false, true, WriteStream::wsDefault);
637 pain.draw(x, y, os.str().c_str());
642 static docstring latexString(InsetMathHull const & inset)
645 // This has to be static, because a preview snippet or a math
646 // macro containing math in text mode (such as $\text{$\phi$}$ or
647 // \newcommand{\xxx}{\text{$\phi$}}) gets processed twice. The
648 // first time as a whole, and the second time only the inner math.
649 // In this last case inset.buffer() would be invalid.
650 static Encoding const * encoding = 0;
651 if (inset.isBufferValid())
652 encoding = &(inset.buffer().params().encoding());
653 otexrowstream ots(ls, false);
654 WriteStream wi(ots, false, true, WriteStream::wsPreview, encoding);
660 void InsetMathHull::initUnicodeMath() const
662 // Trigger classification of the unicode symbols in this inset
663 docstring const dummy = latexString(*this);
667 void InsetMathHull::addPreview(DocIterator const & inset_pos,
668 graphics::PreviewLoader & /*ploader*/) const
670 if (RenderPreview::previewMath()) {
671 preparePreview(inset_pos);
676 void InsetMathHull::usedMacros(MathData const & md, DocIterator const & pos,
677 MacroNameSet & macros, MacroNameSet & defs) const
679 MacroNameSet::iterator const end = macros.end();
681 for (size_t i = 0; i < md.size(); ++i) {
682 MathMacro const * mi = md[i].nucleus()->asMacro();
683 MathMacroTemplate const * mt = md[i].nucleus()->asMacroTemplate();
684 InsetMathScript const * si = md[i].nucleus()->asScriptInset();
685 InsetMathFracBase const * fi = md[i].nucleus()->asFracBaseInset();
686 InsetMathGrid const * gi = md[i].nucleus()->asGridInset();
687 InsetMathNest const * ni = md[i].nucleus()->asNestInset();
689 // Look for macros in the arguments of this macro.
690 for (idx_type idx = 0; idx < mi->nargs(); ++idx)
691 usedMacros(mi->cell(idx), pos, macros, defs);
692 // Make sure this is a macro defined in the document
693 // (as we also spot the macros in the symbols file)
694 // or that we have not already accounted for it.
695 docstring const name = mi->name();
696 if (macros.find(name) == end)
699 // Look for macros in the definition of this macro.
700 MathData ar(pos.buffer());
701 MacroData const * data =
702 pos.buffer()->getMacro(name, pos, true);
704 odocstringstream macro_def;
705 data->write(macro_def, true);
707 defs.insert(macro_def.str());
708 asArray(data->definition(), ar);
710 usedMacros(ar, pos, macros, defs);
712 MathData ar(pos.buffer());
713 asArray(mt->definition(), ar);
714 usedMacros(ar, pos, macros, defs);
716 if (!si->nuc().empty())
717 usedMacros(si->nuc(), pos, macros, defs);
719 usedMacros(si->down(), pos, macros, defs);
721 usedMacros(si->up(), pos, macros, defs);
722 } else if (fi || gi) {
723 idx_type nidx = fi ? fi->nargs() : gi->nargs();
724 for (idx_type idx = 0; idx < nidx; ++idx)
725 usedMacros(fi ? fi->cell(idx) : gi->cell(idx),
728 usedMacros(ni->cell(0), pos, macros, defs);
734 void InsetMathHull::preparePreview(DocIterator const & pos,
735 bool forexport) const
737 // there is no need to do all the macro stuff if we're not
738 // actually going to generate the preview.
739 if (!RenderPreview::previewMath() && !forexport)
742 Buffer const * buffer = pos.buffer();
744 // collect macros at this position
746 buffer->listMacroNames(macros);
748 // collect definitions only for the macros used in this inset
750 for (idx_type idx = 0; idx < nargs(); ++idx)
751 usedMacros(cell(idx), pos, macros, defs);
753 MacroNameSet::iterator it = defs.begin();
754 MacroNameSet::iterator end = defs.end();
755 docstring macro_preamble;
756 for (; it != end; ++it)
757 macro_preamble.append(*it);
759 // set the font series and size for this snippet
760 DocIterator dit = pos.getInnerText();
761 Paragraph const & par = dit.paragraph();
762 Font font = par.getFontSettings(buffer->params(), dit.pos());
763 font.fontInfo().realize(par.layout().font);
764 string const lsize = font.latexSize();
767 if (font.fontInfo().series() == BOLD_SERIES) {
768 setfont += from_ascii("\\textbf{");
771 if (lsize != "normalsize" && !prefixIs(lsize, "error"))
772 setfont += from_ascii("\\" + lsize + '\n');
775 if (forexport && haveNumbers()) {
776 docstring eqstr = from_ascii("equation");
777 CounterMap::const_iterator it = counter_map.find(eqstr);
778 if (it != counter_map.end()) {
779 int num = it->second;
781 setcnt += from_ascii("\\setcounter{") + eqstr + '}' +
782 '{' + convert<docstring>(num) + '}' + '\n';
784 for (size_t i = 0; i != numcnts; ++i) {
785 docstring cnt = from_ascii(counters_to_save[i]);
786 it = counter_map.find(cnt);
787 if (it == counter_map.end())
789 int num = it->second;
791 setcnt += from_ascii("\\setcounter{") + cnt + '}' +
792 '{' + convert<docstring>(num) + '}';
795 docstring const snippet = macro_preamble + setfont + setcnt
796 + latexString(*this) + endfont;
797 LYXERR(Debug::MACROS, "Preview snippet: " << snippet);
798 preview_->addPreview(snippet, *buffer, forexport);
802 void InsetMathHull::reloadPreview(DocIterator const & pos) const
805 preview_->startLoading(*pos.buffer());
809 void InsetMathHull::loadPreview(DocIterator const & pos) const
811 bool const forexport = true;
812 preparePreview(pos, forexport);
813 preview_->startLoading(*pos.buffer(), forexport);
817 bool InsetMathHull::notifyCursorLeaves(Cursor const & old, Cursor & cur)
819 if (RenderPreview::previewMath()) {
821 cur.screenUpdateFlags(Update::Force);
827 docstring InsetMathHull::label(row_type row) const
829 LASSERT(row < nrows(), return docstring());
830 if (InsetLabel * il = label_[row])
831 return il->screenLabel();
836 void InsetMathHull::label(row_type row, docstring const & label)
838 //lyxerr << "setting label '" << label << "' for row " << row << endl;
842 label_[row] = dummy_pointer;
845 label_[row]->updateLabelAndRefs(label);
847 label_[row]->setParam("name", label);
851 InsetCommandParams p(LABEL_CODE);
853 label_[row] = new InsetLabel(buffer_, p);
855 label_[row]->setBuffer(buffer());
859 void InsetMathHull::numbered(row_type row, Numbered num)
861 numbered_[row] = num;
862 if (!numbered(row) && label_[row]) {
869 bool InsetMathHull::numbered(row_type row) const
871 return numbered_[row] == NUMBER;
875 bool InsetMathHull::ams() const
895 for (size_t row = 0; row < numbered_.size(); ++row)
896 if (numbered_[row] == NOTAG)
902 Inset::DisplayType InsetMathHull::display() const
925 bool InsetMathHull::numberedType() const
944 for (row_type row = 0; row < nrows(); ++row)
951 void InsetMathHull::validate(LaTeXFeatures & features) const
953 if (features.runparams().isLaTeX()) {
955 features.require("amsmath");
957 if (type_ == hullRegexp) {
958 features.require("color");
959 string frcol = lcolor.getLaTeXName(Color_regexpframe);
960 string bgcol = "white";
961 features.addPreambleSnippet(
962 string("\\newcommand{\\regexp}[1]{\\fcolorbox{")
963 + frcol + string("}{")
964 + bgcol + string("}{\\ensuremath{\\mathtt{#1}}}}"));
965 features.addPreambleSnippet(
966 string("\\newcommand{\\endregexp}{}"));
969 // Validation is necessary only if not using AMS math.
970 // To be safe, we will always run mathedvalidate.
971 //if (features.amsstyle)
974 //features.binom = true;
975 } else if (features.runparams().math_flavor == OutputParams::MathAsHTML) {
976 // it would be better to do this elsewhere, but we can't validate in
977 // InsetMathMatrix and we have no way, outside MathExtern, to know if
978 // we even have any matrices.
979 features.addCSSSnippet(
980 "table.matrix{display: inline-block; vertical-align: middle; text-align:center;}\n"
981 "table.matrix td{padding: 0.25px;}\n"
982 "td.ldelim{width: 0.5ex; border: thin solid black; border-right: none;}\n"
983 "td.rdelim{width: 0.5ex; border: thin solid black; border-left: none;}");
985 InsetMathGrid::validate(features);
989 void InsetMathHull::header_write(WriteStream & os) const
991 bool n = numberedType();
1000 if (cell(0).empty())
1008 os << "\\begin{equation" << star(n) << "}\n";
1020 os << "\\begin{" << hullName(type_) << star(n) << "}\n";
1027 os << "\\begin{" << hullName(type_) << star(n) << '}'
1028 << '{' << static_cast<unsigned int>((ncols() + 1)/2) << "}\n";
1034 os << "\\begin{" << hullName(type_) << '}'
1035 << '{' << static_cast<unsigned int>((ncols() + 1)/2) << "}\n";
1045 os << "\\begin{unknown" << star(n) << "}\n";
1051 void InsetMathHull::footer_write(WriteStream & os) const
1053 bool n = numberedType();
1068 os << "\\end{equation" << star(n) << "}\n";
1082 os << "\\end{" << hullName(type_) << star(n) << "}\n";
1088 os << "\\end{" << hullName(type_) << "}\n";
1092 // Only used as a heuristic to find the regexp termination, when searching in ignore-format mode
1093 os << "\\endregexp{}}";
1099 os << "\\end{unknown" << star(n) << "}\n";
1105 bool InsetMathHull::allowsTabularFeatures() const
1128 bool InsetMathHull::rowChangeOK() const
1131 type_ == hullEqnArray || type_ == hullAlign ||
1132 type_ == hullFlAlign || type_ == hullAlignAt ||
1133 type_ == hullXAlignAt || type_ == hullXXAlignAt ||
1134 type_ == hullGather || type_ == hullMultline;
1138 bool InsetMathHull::colChangeOK() const
1141 type_ == hullAlign || type_ == hullFlAlign ||type_ == hullAlignAt ||
1142 type_ == hullXAlignAt || type_ == hullXXAlignAt;
1146 void InsetMathHull::addRow(row_type row)
1151 bool numbered = numberedType();
1152 // Move the number and raw pointer, do not call label() (bug 7511)
1153 InsetLabel * label = dummy_pointer;
1154 docstring number = empty_docstring();
1155 if (type_ == hullMultline) {
1156 if (row + 1 == nrows()) {
1157 numbered_[row] = NONUMBER;
1158 swap(label, label_[row]);
1159 swap(number, numbers_[row]);
1164 numbered_.insert(numbered_.begin() + row + 1, numbered ? NUMBER : NONUMBER);
1165 numbers_.insert(numbers_.begin() + row + 1, number);
1166 label_.insert(label_.begin() + row + 1, label);
1167 InsetMathGrid::addRow(row);
1171 void InsetMathHull::swapRow(row_type row)
1175 if (row + 1 == nrows())
1177 swap(numbered_[row], numbered_[row + 1]);
1178 swap(numbers_[row], numbers_[row + 1]);
1179 swap(label_[row], label_[row + 1]);
1180 InsetMathGrid::swapRow(row);
1184 void InsetMathHull::delRow(row_type row)
1186 if (nrows() <= 1 || !rowChangeOK())
1188 if (row + 1 == nrows() && type_ == hullMultline) {
1189 swap(numbered_[row - 1], numbered_[row]);
1190 swap(numbers_[row - 1], numbers_[row]);
1191 swap(label_[row - 1], label_[row]);
1192 InsetMathGrid::delRow(row);
1195 InsetMathGrid::delRow(row);
1196 // The last dummy row has no number info nor a label.
1197 // Test nrows() + 1 because we have already erased the row.
1198 if (row == nrows() + 1)
1200 numbered_.erase(numbered_.begin() + row);
1201 numbers_.erase(numbers_.begin() + row);
1203 label_.erase(label_.begin() + row);
1207 void InsetMathHull::addCol(col_type col)
1211 InsetMathGrid::addCol(col);
1215 void InsetMathHull::delCol(col_type col)
1217 if (ncols() <= 1 || !colChangeOK())
1219 InsetMathGrid::delCol(col);
1223 docstring InsetMathHull::nicelabel(row_type row) const
1227 docstring const & val = numbers_[row];
1229 return '(' + val + ')';
1230 return '(' + val + ',' + label_[row]->screenLabel() + ')';
1234 void InsetMathHull::glueall(HullType type)
1237 for (idx_type i = 0; i < nargs(); ++i)
1239 InsetLabel * label = 0;
1240 if (type == hullEquation) {
1241 // preserve first non-empty label
1242 for (row_type row = 0; row < nrows(); ++row) {
1244 label = label_[row];
1250 *this = InsetMathHull(buffer_, hullSimple);
1257 void InsetMathHull::splitTo2Cols()
1259 LASSERT(ncols() == 1, return);
1260 InsetMathGrid::addCol(1);
1261 for (row_type row = 0; row < nrows(); ++row) {
1262 idx_type const i = 2 * row;
1263 pos_type pos = firstRelOp(cell(i));
1264 cell(i + 1) = MathData(buffer_, cell(i).begin() + pos, cell(i).end());
1265 cell(i).erase(pos, cell(i).size());
1270 void InsetMathHull::splitTo3Cols()
1272 LASSERT(ncols() < 3, return);
1275 InsetMathGrid::addCol(2);
1276 for (row_type row = 0; row < nrows(); ++row) {
1277 idx_type const i = 3 * row + 1;
1278 if (!cell(i).empty()) {
1279 cell(i + 1) = MathData(buffer_, cell(i).begin() + 1, cell(i).end());
1280 cell(i).erase(1, cell(i).size());
1286 void InsetMathHull::changeCols(col_type cols)
1288 if (ncols() == cols)
1290 else if (ncols() < cols) {
1296 while (ncols() < cols)
1297 InsetMathGrid::addCol(ncols());
1303 for (row_type row = 0; row < nrows(); ++row) {
1304 idx_type const i = row * ncols();
1305 for (col_type col = cols; col < ncols(); ++col) {
1306 cell(i + cols - 1).append(cell(i + col));
1310 while (ncols() > cols) {
1311 InsetMathGrid::delCol(ncols() - 1);
1316 HullType InsetMathHull::getType() const
1322 void InsetMathHull::setType(HullType type)
1329 bool InsetMathHull::isMutable(HullType type)
1353 void InsetMathHull::mutate(HullType newtype)
1355 //lyxerr << "mutating from '" << type_ << "' to '" << newtype << "'" << endl;
1357 if (newtype == type_)
1360 // This guards the algorithm below it, which is designed with certain types
1362 if (!isMutable(newtype) || !isMutable(type_)) {
1363 lyxerr << "mutation from '" << to_utf8(hullName(type_))
1364 << "' to '" << to_utf8(hullName(newtype))
1365 << "' not implemented" << endl;
1369 // we try to move along the chain
1370 // none <-> simple <-> equation <-> eqnarray -> *align* -> multline, gather -+
1372 // +-------------------------------------+
1373 // we use eqnarray as intermediate type for mutations that are not
1374 // directly supported because it handles labels and numbering for
1379 setType(hullSimple);
1385 if (newtype == hullNone) {
1389 setType(hullEquation);
1390 numbered(0, label_[0] ? true : false);
1399 setType(hullSimple);
1404 // split it "nicely" on the first relop
1406 setType(hullEqnArray);
1414 // split it "nicely"
1449 setType(hullEqnArray);
1458 for (row_type row = 0; row < nrows(); ++row)
1459 numbered(row, false);
1469 for (row_type row = 0; row < nrows(); ++row)
1470 numbered(row, false);
1477 setType(hullEqnArray);
1507 for (row_type row = 0; row < nrows(); ++row)
1508 numbered(row, false);
1512 // first we mutate to EqnArray
1514 setType(hullEqnArray);
1521 // we passed the guard so we should not be here
1522 LASSERT("Mutation not implemented, but should have been.", return);
1528 docstring InsetMathHull::eolString(row_type row, bool fragile, bool latex,
1529 bool last_eoln) const
1532 if (numberedType()) {
1533 if (label_[row] && numbered(row)) {
1534 docstring const name =
1535 latex ? escape(label_[row]->getParam("name"))
1536 : label_[row]->getParam("name");
1537 res += "\\label{" + name + '}';
1539 if (type_ != hullMultline) {
1540 if (numbered_[row] == NONUMBER)
1541 res += "\\nonumber ";
1542 else if (numbered_[row] == NOTAG)
1546 // Never add \\ on the last empty line of eqnarray and friends
1548 return res + InsetMathGrid::eolString(row, fragile, latex, last_eoln);
1551 void InsetMathHull::write(WriteStream & os) const
1553 ModeSpecifier specifier(os, MATH_MODE);
1555 InsetMathGrid::write(os);
1560 void InsetMathHull::normalize(NormalStream & os) const
1562 os << "[formula " << hullName(type_) << ' ';
1563 InsetMathGrid::normalize(os);
1568 void InsetMathHull::infoize(odocstream & os) const
1570 os << bformat(_("Type: %1$s"), hullName(type_));
1574 void InsetMathHull::check() const
1576 LATTEST(numbered_.size() == nrows());
1577 LATTEST(numbers_.size() == nrows());
1578 LATTEST(label_.size() == nrows());
1582 void InsetMathHull::doExtern(Cursor & cur, FuncRequest & func)
1586 idocstringstream iss(func.argument());
1587 iss >> dlang >> extra;
1589 extra = from_ascii("noextra");
1590 string const lang = to_ascii(dlang);
1592 // replace selection with result of computation
1593 if (reduceSelectionToOneCell(cur)) {
1595 asArray(grabAndEraseSelection(cur), ar);
1596 lyxerr << "use selection: " << ar << endl;
1597 cur.insert(pipeThroughExtern(lang, extra, ar));
1601 // only inline, display or eqnarray math is allowed
1602 switch (getType()) {
1608 frontend::Alert::warning(_("Bad math environment"),
1609 _("Computation cannot be performed for AMS "
1610 "math environments.\nChange the math "
1611 "formula type and try again."));
1616 eq.push_back(MathAtom(new InsetMathChar('=')));
1618 // go to first item in line
1619 cur.idx() -= cur.idx() % ncols();
1622 if (getType() == hullSimple) {
1623 size_type pos = cur.cell().find_last(eq);
1625 if (pos == cur.cell().size()) {
1627 lyxerr << "use whole cell: " << ar << endl;
1629 ar = MathData(buffer_, cur.cell().begin() + pos + 1, cur.cell().end());
1630 lyxerr << "use partial cell form pos: " << pos << endl;
1632 cur.cell().append(eq);
1633 cur.cell().append(pipeThroughExtern(lang, extra, ar));
1634 cur.pos() = cur.lastpos();
1638 if (getType() == hullEquation) {
1639 lyxerr << "use equation inset" << endl;
1640 mutate(hullEqnArray);
1641 MathData & ar = cur.cell();
1642 lyxerr << "use cell: " << ar << endl;
1646 cur.cell() = pipeThroughExtern(lang, extra, ar);
1647 // move to end of line
1648 cur.pos() = cur.lastpos();
1653 lyxerr << "use eqnarray" << endl;
1654 cur.idx() += 2 - cur.idx() % ncols();
1656 MathData ar = cur.cell();
1657 lyxerr << "use cell: " << ar << endl;
1658 // FIXME: temporarily disabled
1664 cur.cell() = pipeThroughExtern(lang, extra, ar);
1665 cur.pos() = cur.lastpos();
1670 void InsetMathHull::doDispatch(Cursor & cur, FuncRequest & cmd)
1672 //lyxerr << "action: " << cmd.action() << endl;
1673 switch (cmd.action()) {
1675 case LFUN_FINISHED_BACKWARD:
1676 case LFUN_FINISHED_FORWARD:
1677 case LFUN_FINISHED_RIGHT:
1678 case LFUN_FINISHED_LEFT:
1679 //lyxerr << "action: " << cmd.action() << endl;
1680 InsetMathGrid::doDispatch(cur, cmd);
1683 case LFUN_PARAGRAPH_BREAK:
1684 // just swallow this
1687 case LFUN_NEWLINE_INSERT:
1688 // some magic for the common case
1689 if (type_ == hullSimple || type_ == hullEquation) {
1690 cur.recordUndoInset();
1692 cur.bv().buffer().params().use_package("amsmath") != BufferParams::package_off;
1693 mutate(align ? hullAlign : hullEqnArray);
1694 // mutate() may change labels and such.
1695 cur.forceBufferUpdate();
1696 cur.idx() = nrows() * ncols() - 1;
1697 cur.pos() = cur.lastpos();
1699 InsetMathGrid::doDispatch(cur, cmd);
1702 case LFUN_MATH_NUMBER_TOGGLE: {
1703 //lyxerr << "toggling all numbers" << endl;
1704 cur.recordUndoInset();
1705 bool old = numberedType();
1706 if (type_ == hullMultline)
1707 numbered(nrows() - 1, !old);
1709 for (row_type row = 0; row < nrows(); ++row)
1710 numbered(row, !old);
1712 cur.message(old ? _("No number") : _("Number"));
1713 cur.forceBufferUpdate();
1717 case LFUN_MATH_NUMBER_LINE_TOGGLE: {
1718 cur.recordUndoInset();
1719 row_type r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1720 bool old = numbered(r);
1721 cur.message(old ? _("No number") : _("Number"));
1723 cur.forceBufferUpdate();
1727 case LFUN_LABEL_INSERT: {
1728 row_type r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1729 docstring old_label = label(r);
1730 docstring const default_label = from_ascii("eq:");
1731 if (old_label.empty())
1732 old_label = default_label;
1734 InsetCommandParams p(LABEL_CODE);
1735 p["name"] = cmd.argument().empty() ? old_label : cmd.argument();
1736 string const data = InsetCommand::params2string(p);
1738 if (cmd.argument().empty())
1739 cur.bv().showDialog("label", data);
1741 FuncRequest fr(LFUN_INSET_INSERT, data);
1747 case LFUN_LABEL_COPY_AS_REFERENCE: {
1749 if (cmd.argument().empty() && &cur.inset() == this)
1750 // if there is no argument and we're inside math, we retrieve
1751 // the row number from the cursor position.
1752 row = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1754 // if there is an argument, find the corresponding label, else
1755 // check whether there is at least one label.
1756 for (row = 0; row != nrows(); ++row)
1757 if (numbered(row) && label_[row]
1758 && (cmd.argument().empty() || label(row) == cmd.argument()))
1765 InsetCommandParams p(REF_CODE, "ref");
1766 p["reference"] = label(row);
1767 cap::clearSelection();
1768 cap::copyInset(cur, new InsetRef(buffer_, p), label(row));
1772 case LFUN_WORD_DELETE_FORWARD:
1773 case LFUN_CHAR_DELETE_FORWARD:
1774 if (col(cur.idx()) + 1 == ncols()
1775 && cur.pos() == cur.lastpos()
1776 && !cur.selection()) {
1777 if (!label(row(cur.idx())).empty()) {
1778 cur.recordUndoInset();
1779 label(row(cur.idx()), docstring());
1780 } else if (numbered(row(cur.idx()))) {
1781 cur.recordUndoInset();
1782 numbered(row(cur.idx()), false);
1783 cur.forceBufferUpdate();
1785 InsetMathGrid::doDispatch(cur, cmd);
1789 InsetMathGrid::doDispatch(cur, cmd);
1794 case LFUN_INSET_INSERT: {
1795 //lyxerr << "arg: " << to_utf8(cmd.argument()) << endl;
1796 // FIXME: this should be cleaned up to use InsetLabel methods directly.
1797 string const name = cmd.getArg(0);
1798 if (name == "label") {
1799 InsetCommandParams p(LABEL_CODE);
1800 InsetCommand::string2params(to_utf8(cmd.argument()), p);
1801 docstring str = p["name"];
1802 cur.recordUndoInset();
1803 row_type const r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1807 docstring old = label(r);
1810 // The label will take care of the reference update.
1814 // Newly created inset so initialize it.
1815 label_[r]->initView();
1818 cur.forceBufferUpdate();
1821 InsetMathGrid::doDispatch(cur, cmd);
1825 case LFUN_MATH_EXTERN:
1826 cur.recordUndoInset();
1830 case LFUN_MATH_MUTATE: {
1831 cur.recordUndoInset();
1832 row_type row = cur.row();
1833 col_type col = cur.col();
1834 mutate(hullType(cmd.argument()));
1835 cur.idx() = row * ncols() + col;
1836 if (cur.idx() > cur.lastidx()) {
1837 cur.idx() = cur.lastidx();
1838 cur.pos() = cur.lastpos();
1840 if (cur.pos() > cur.lastpos())
1841 cur.pos() = cur.lastpos();
1843 cur.forceBufferUpdate();
1844 // FIXME: find some more clever handling of the selection,
1845 // i.e. preserve it.
1846 cur.clearSelection();
1847 //cur.dispatched(FINISHED);
1851 case LFUN_MATH_DISPLAY: {
1852 cur.recordUndoInset();
1853 mutate(type_ == hullSimple ? hullEquation : hullSimple);
1854 // if the cursor is in a cell that got merged, move it to
1855 // start of the hull inset.
1856 if (cur.idx() > 0) {
1860 if (cur.pos() > cur.lastpos())
1861 cur.pos() = cur.lastpos();
1866 case LFUN_TABULAR_FEATURE:
1867 if (!allowsTabularFeatures())
1870 InsetMathGrid::doDispatch(cur, cmd);
1874 InsetMathGrid::doDispatch(cur, cmd);
1882 bool allowDisplayMath(Cursor const & cur)
1884 LATTEST(cur.depth() > 1);
1885 Cursor tmpcur = cur;
1888 FuncRequest cmd(LFUN_MATH_DISPLAY);
1889 return tmpcur.getStatus(cmd, status) && status.enabled();
1895 bool InsetMathHull::getStatus(Cursor & cur, FuncRequest const & cmd,
1896 FuncStatus & status) const
1898 switch (cmd.action()) {
1899 case LFUN_FINISHED_BACKWARD:
1900 case LFUN_FINISHED_FORWARD:
1901 case LFUN_FINISHED_RIGHT:
1902 case LFUN_FINISHED_LEFT:
1905 case LFUN_NEWLINE_INSERT:
1906 case LFUN_MATH_EXTERN:
1908 status.setEnabled(true);
1911 // we never allow this in math, and we want to bind enter
1912 // to another actions in command-alternatives
1913 case LFUN_PARAGRAPH_BREAK:
1914 status.setEnabled(false);
1916 case LFUN_MATH_MUTATE: {
1917 HullType const ht = hullType(cmd.argument());
1918 status.setOnOff(type_ == ht);
1919 status.setEnabled(isMutable(ht) && isMutable(type_));
1921 if (ht != hullSimple && status.enabled())
1922 status.setEnabled(allowDisplayMath(cur));
1925 case LFUN_MATH_DISPLAY: {
1926 status.setEnabled(display() != Inline || allowDisplayMath(cur));
1927 status.setOnOff(display() != Inline);
1931 case LFUN_MATH_NUMBER_TOGGLE:
1932 // FIXME: what is the right test, this or the one of
1934 status.setEnabled(display() != Inline);
1935 status.setOnOff(numberedType());
1938 case LFUN_MATH_NUMBER_LINE_TOGGLE: {
1939 // FIXME: what is the right test, this or the one of
1941 bool const enable = (type_ == hullMultline)
1942 ? (nrows() - 1 == cur.row())
1943 : display() != Inline;
1944 row_type const r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1945 status.setEnabled(enable);
1946 status.setOnOff(enable && numbered(r));
1950 case LFUN_LABEL_INSERT:
1951 status.setEnabled(type_ != hullSimple);
1954 case LFUN_LABEL_COPY_AS_REFERENCE: {
1955 bool enabled = false;
1957 if (cmd.argument().empty() && &cur.inset() == this) {
1958 // if there is no argument and we're inside math, we retrieve
1959 // the row number from the cursor position.
1960 row = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1961 enabled = numberedType() && label_[row] && numbered(row);
1963 // if there is an argument, find the corresponding label, else
1964 // check whether there is at least one label.
1965 for (row_type row = 0; row != nrows(); ++row) {
1966 if (numbered(row) && label_[row] &&
1967 (cmd.argument().empty() || label(row) == cmd.argument())) {
1973 status.setEnabled(enabled);
1977 case LFUN_INSET_INSERT:
1978 if (cmd.getArg(0) == "label") {
1979 status.setEnabled(type_ != hullSimple);
1982 return InsetMathGrid::getStatus(cur, cmd, status);
1984 case LFUN_TABULAR_FEATURE: {
1985 if (!allowsTabularFeatures())
1987 string s = cmd.getArg(0);
1989 && (s == "append-row"
1990 || s == "delete-row"
1991 || s == "copy-row")) {
1992 status.message(bformat(
1993 from_utf8(N_("Can't change number of rows in '%1$s'")),
1995 status.setEnabled(false);
1999 && (s == "append-column"
2000 || s == "delete-column"
2001 || s == "copy-column")) {
2002 status.message(bformat(
2003 from_utf8(N_("Can't change number of columns in '%1$s'")),
2005 status.setEnabled(false);
2008 if (s == "add-vline-left" || s == "add-vline-right") {
2009 status.message(bformat(
2010 from_utf8(N_("Can't add vertical grid lines in '%1$s'")),
2012 status.setEnabled(false);
2015 if (s == "valign-top" || s == "valign-middle"
2016 || s == "valign-bottom" || s == "align-left"
2017 || s == "align-center" || s == "align-right") {
2018 status.setEnabled(false);
2021 return InsetMathGrid::getStatus(cur, cmd, status);
2025 return InsetMathGrid::getStatus(cur, cmd, status);
2028 // This cannot really happen, but inserted to shut-up gcc
2029 return InsetMathGrid::getStatus(cur, cmd, status);
2033 /////////////////////////////////////////////////////////////////////
2037 // simply scrap this function if you want
2038 void InsetMathHull::mutateToText()
2041 // translate to latex
2043 latex(os, false, false);
2044 string str = os.str();
2047 Text * lt = view_->cursor().innerText();
2048 string::const_iterator cit = str.begin();
2049 string::const_iterator end = str.end();
2050 for (; cit != end; ++cit)
2051 view_->getIntl()->getTransManager().TranslateAndInsert(*cit, lt);
2054 //dispatch(LFUN_ESCAPE);
2059 void InsetMathHull::handleFont(Cursor & cur, docstring const & arg,
2060 docstring const & font)
2062 // this whole function is a hack and won't work for incremental font
2065 if (cur.inset().asInsetMath()->name() == font)
2066 cur.handleFont(to_utf8(font));
2068 cur.handleNest(createInsetMath(font, cur.buffer()));
2074 void InsetMathHull::handleFont2(Cursor & cur, docstring const & arg)
2079 font.fromString(to_utf8(arg), b);
2080 if (font.fontInfo().color() != Color_inherit) {
2081 MathAtom at = MathAtom(new InsetMathColor(buffer_, true, font.fontInfo().color()));
2082 cur.handleNest(at, 0);
2087 void InsetMathHull::edit(Cursor & cur, bool front, EntryDirection entry_from)
2090 bool enter_front = (entry_from == Inset::ENTRY_DIRECTION_LEFT ||
2091 (entry_from == Inset::ENTRY_DIRECTION_IGNORE && front));
2092 enter_front ? idxFirst(cur) : idxLast(cur);
2093 // The inset formula dimension is not necessarily the same as the
2094 // one of the instant preview image, so we have to indicate to the
2095 // BufferView that a metrics update is needed.
2096 cur.screenUpdateFlags(Update::Force);
2100 void InsetMathHull::revealCodes(Cursor & cur) const
2102 if (!cur.inMathed())
2104 odocstringstream os;
2106 cur.message(os.str());
2108 // write something to the minibuffer
2109 // translate to latex
2113 string str = os.str();
2115 string::size_type pos = 0;
2117 for (string::iterator it = str.begin(); it != str.end(); ++it) {
2120 else if (*it == '\0') {
2122 pos = it - str.begin();
2128 res = res.substr(pos - 30);
2129 if (res.size() > 60)
2130 res = res.substr(0, 60);
2136 /////////////////////////////////////////////////////////////////////
2140 bool InsetMathHull::searchForward(BufferView * bv, string const & str,
2143 // FIXME: completely broken
2144 static InsetMathHull * lastformula = 0;
2145 static CursorBase current = DocIterator(ibegin(nucleus()));
2147 static string laststr;
2149 if (lastformula != this || laststr != str) {
2150 //lyxerr << "reset lastformula to " << this << endl;
2153 current = ibegin(nucleus());
2155 mathed_parse_cell(ar, str, Parse::NORMAL, &buffer());
2159 //lyxerr << "searching '" << str << "' in " << this << ar << endl;
2161 for (DocIterator it = current; it != iend(nucleus()); increment(it)) {
2162 CursorSlice & top = it.back();
2163 MathData const & a = top.asInsetMath()->cell(top.idx_);
2164 if (a.matchpart(ar, top.pos_)) {
2165 bv->cursor().setSelection(it, ar.size());
2167 top.pos_ += ar.size();
2173 //lyxerr << "not found!" << endl;
2180 void InsetMathHull::write(ostream & os) const
2182 odocstringstream oss;
2183 otexrowstream ots(oss, false);
2184 WriteStream wi(ots, false, false, WriteStream::wsDefault);
2187 os << to_utf8(oss.str());
2191 void InsetMathHull::read(Lexer & lex)
2194 mathed_parse_normal(buffer_, at, lex, Parse::TRACKMACRO);
2195 operator=(*at->asHullInset());
2199 bool InsetMathHull::readQuiet(Lexer & lex)
2202 bool success = mathed_parse_normal(buffer_, at, lex, Parse::QUIET);
2204 operator=(*at->asHullInset());
2209 int InsetMathHull::plaintext(odocstringstream & os,
2210 OutputParams const & op, size_t max_length) const
2212 // disables ASCII-art for export of equations. See #2275.
2213 if (0 && display()) {
2217 TextPainter tpain(dim.width(), dim.height());
2218 drawT(tpain, 0, dim.ascent());
2220 // reset metrics cache to "real" values
2222 return tpain.textheight();
2225 odocstringstream oss;
2226 otexrowstream ots(oss, false);
2227 Encoding const * const enc = encodings.fromLyXName("utf8");
2228 WriteStream wi(ots, false, true, WriteStream::wsDefault, enc);
2231 if (type_ == hullRegexp)
2234 for (row_type r = 0; r < nrows(); ++r) {
2235 for (col_type c = 0; c < ncols(); ++c)
2236 wi << (c == 0 ? "" : "\t") << cell(index(r, c));
2237 // if it's for the TOC, we write just the first line
2238 // and do not include the newline.
2239 if (op.for_toc || op.for_tooltip || oss.str().size() >= max_length)
2241 if (r < nrows() - 1)
2245 docstring const str = oss.str();
2251 int InsetMathHull::docbook(odocstream & os, OutputParams const & runparams) const
2256 if (getType() == hullSimple)
2257 name = from_ascii("inlineequation");
2259 name = from_ascii("informalequation");
2261 docstring bname = name;
2262 if (!label(0).empty())
2263 bname += " id='" + sgml::cleanID(buffer(), runparams, label(0)) + "'";
2265 ++ms.tab(); ms.cr(); ms.os() << '<' << bname << '>';
2267 odocstringstream ls;
2269 if (runparams.flavor == OutputParams::XML) {
2270 ms << MTag("alt role='tex' ");
2271 // Workaround for db2latex: db2latex always includes equations with
2272 // \ensuremath{} or \begin{display}\end{display}
2273 // so we strip LyX' math environment
2274 WriteStream wi(ols, false, false, WriteStream::wsDefault, runparams.encoding);
2275 InsetMathGrid::write(wi);
2276 ms << from_utf8(subst(subst(to_utf8(ls.str()), "&", "&"), "<", "<"));
2281 InsetMathGrid::mathmlize(ms);
2284 ms << MTag("alt role='tex'");
2285 latex(ols, runparams);
2286 res = ols.texrow().rows();
2287 ms << from_utf8(subst(subst(to_utf8(ls.str()), "&", "&"), "<", "<"));
2291 ms << from_ascii("<graphic fileref=\"eqn/");
2292 if (!label(0).empty())
2293 ms << sgml::cleanID(buffer(), runparams, label(0));
2295 ms << sgml::uniqueID(from_ascii("anon"));
2297 if (runparams.flavor == OutputParams::XML)
2298 ms << from_ascii("\"/>");
2300 ms << from_ascii("\">");
2302 ms.cr(); --ms.tab(); ms.os() << "</" << name << '>';
2304 return ms.line() + res;
2308 bool InsetMathHull::haveNumbers() const
2310 bool havenumbers = false;
2311 // inline formulas are never numbered (bug 7351 part 3)
2312 if (getType() == hullSimple)
2314 for (size_t i = 0; i != numbered_.size(); ++i) {
2325 // We need to do something about alignment here.
2327 // This duplicates code from InsetMathGrid, but
2328 // we need access here to number information,
2329 // and we simply do not have that in InsetMathGrid.
2330 void InsetMathHull::htmlize(HtmlStream & os) const
2332 bool const havenumbers = haveNumbers();
2333 bool const havetable = havenumbers || nrows() > 1 || ncols() > 1;
2336 os << cell(index(0, 0));
2340 os << MTag("table", "class='mathtable'");
2341 for (row_type row = 0; row < nrows(); ++row) {
2343 for (col_type col = 0; col < ncols(); ++col) {
2345 os << cell(index(row, col));
2350 docstring const & num = numbers_[row];
2352 os << '(' << num << ')';
2357 os << ETag("table");
2361 // this duplicates code from InsetMathGrid, but
2362 // we need access here to number information,
2363 // and we simply do not have that in InsetMathGrid.
2364 void InsetMathHull::mathmlize(MathStream & os) const
2366 bool const havenumbers = haveNumbers();
2367 bool const havetable = havenumbers || nrows() > 1 || ncols() > 1;
2370 os << MTag("mtable");
2371 char const * const celltag = havetable ? "mtd" : "mrow";
2372 // FIXME There does not seem to be wide support at the moment
2373 // for mlabeledtr, so we have to use just mtr for now.
2374 // char const * const rowtag = havenumbers ? "mlabeledtr" : "mtr";
2375 char const * const rowtag = "mtr";
2376 for (row_type row = 0; row < nrows(); ++row) {
2379 for (col_type col = 0; col < ncols(); ++col) {
2381 << cell(index(row, col))
2387 docstring const & num = numbers_[row];
2389 os << '(' << num << ')';
2396 os << ETag("mtable");
2400 void InsetMathHull::mathAsLatex(WriteStream & os) const
2402 MathEnsurer ensurer(os, false);
2403 bool havenumbers = haveNumbers();
2404 bool const havetable = havenumbers || nrows() > 1 || ncols() > 1;
2407 os << cell(index(0, 0));
2411 os << "<table class='mathtable'>";
2412 for (row_type row = 0; row < nrows(); ++row) {
2414 for (col_type col = 0; col < ncols(); ++col) {
2415 os << "<td class='math'>";
2416 os << cell(index(row, col));
2421 docstring const & num = numbers_[row];
2423 os << '(' << num << ')';
2432 docstring InsetMathHull::xhtml(XHTMLStream & xs, OutputParams const & op) const
2434 BufferParams::MathOutput const mathtype =
2435 buffer().masterBuffer()->params().html_math_output;
2437 bool success = false;
2439 // we output all the labels just at the beginning of the equation.
2440 // this should be fine.
2441 for (size_t i = 0; i != label_.size(); ++i) {
2442 InsetLabel const * const il = label_[i];
2448 // FIXME Eventually we would like to do this inset by inset.
2449 if (mathtype == BufferParams::MathML) {
2450 odocstringstream os;
2455 } catch (MathExportException const &) {}
2457 if (getType() == hullSimple)
2458 xs << html::StartTag("math",
2459 "xmlns=\"http://www.w3.org/1998/Math/MathML\"", true);
2461 xs << html::StartTag("math",
2462 "display=\"block\" xmlns=\"http://www.w3.org/1998/Math/MathML\"", true);
2463 xs << XHTMLStream::ESCAPE_NONE
2465 << html::EndTag("math");
2467 } else if (mathtype == BufferParams::HTML) {
2468 odocstringstream os;
2473 } catch (MathExportException const &) {}
2475 string const tag = (getType() == hullSimple) ? "span" : "div";
2476 xs << html::StartTag(tag, "class='formula'", true)
2477 << XHTMLStream::ESCAPE_NONE
2479 << html::EndTag(tag);
2483 // what we actually want is this:
2485 // ((mathtype == BufferParams::MathML || mathtype == BufferParams::HTML)
2487 // || mathtype == BufferParams::Images
2489 // but what follows is equivalent, since we'll enter only if either (a) we
2490 // tried and failed with MathML or HTML or (b) didn't try yet at all but
2491 // aren't doing LaTeX.
2493 // so this is for Images.
2494 if (!success && mathtype != BufferParams::LaTeX) {
2495 graphics::PreviewImage const * pimage = 0;
2497 loadPreview(docit_);
2498 pimage = preview_->getPreviewImage(buffer());
2499 // FIXME Do we always have png?
2502 if (pimage || op.dryrun) {
2503 string const filename = pimage ? pimage->filename().onlyFileName()
2504 : "previewimage.png";
2506 // if we are not in the master buffer, then we need to see that the
2507 // generated image is copied there; otherwise, preview fails.
2508 Buffer const * mbuf = buffer().masterBuffer();
2509 if (mbuf != &buffer()) {
2510 string mbtmp = mbuf->temppath();
2511 FileName const mbufimg(support::addName(mbtmp, filename));
2512 pimage->filename().copyTo(mbufimg);
2514 // add the file to the list of files to be exported
2515 op.exportdata->addExternalFile("xhtml", pimage->filename());
2518 string const tag = (getType() == hullSimple) ? "span" : "div";
2520 << html::StartTag(tag, "style = \"text-align: center;\"")
2521 << html::CompTag("img", "src=\"" + filename + "\" alt=\"Mathematical Equation\"")
2522 << html::EndTag(tag)
2528 // so we'll pass this test if we've failed everything else, or
2529 // if mathtype was LaTeX, since we won't have entered any of the
2531 if (!success /* || mathtype != BufferParams::LaTeX */) {
2532 // Unfortunately, we cannot use latexString() because we do not want
2533 // $...$ or whatever.
2534 odocstringstream ls;
2535 otexrowstream ots(ls, false);
2536 WriteStream wi(ots, false, true, WriteStream::wsPreview);
2537 ModeSpecifier specifier(wi, MATH_MODE);
2539 docstring const latex = ls.str();
2541 // class='math' allows for use of jsMath
2542 // http://www.math.union.edu/~dpvc/jsMath/
2544 // probably should allow for some kind of customization here
2545 string const tag = (getType() == hullSimple) ? "span" : "div";
2546 xs << html::StartTag(tag, "class='math'")
2548 << html::EndTag(tag)
2555 void InsetMathHull::toString(odocstream & os) const
2557 odocstringstream ods;
2558 plaintext(ods, OutputParams(0));
2563 void InsetMathHull::forOutliner(docstring & os, size_t const, bool const) const
2565 odocstringstream ods;
2568 // FIXME: this results in spilling TeX into the LyXHTML output since the
2569 // outliner is used to generate the LyXHTML list of figures/etc.
2575 string InsetMathHull::contextMenuName() const
2577 return "context-math";
2581 void InsetMathHull::recordLocation(DocIterator const & di)
2587 bool InsetMathHull::canPaintChange(BufferView const &) const
2589 // We let RowPainter do it seamlessly for inline insets
2590 return display() != Inline;