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 "output_xhtml.h"
42 #include "Paragraph.h"
43 #include "ParIterator.h"
45 #include "TextClass.h"
46 #include "TextPainter.h"
47 #include "TocBackend.h"
49 #include "insets/InsetLabel.h"
50 #include "insets/InsetRef.h"
51 #include "insets/RenderPreview.h"
53 #include "graphics/GraphicsImage.h"
54 #include "graphics/PreviewImage.h"
55 #include "graphics/PreviewLoader.h"
57 #include "frontends/alert.h"
58 #include "frontends/Painter.h"
60 #include "support/convert.h"
61 #include "support/lassert.h"
62 #include "support/debug.h"
63 #include "support/filetools.h"
64 #include "support/gettext.h"
65 #include "support/lstrings.h"
70 using namespace lyx::support;
74 using cap::grabAndEraseSelection;
75 using cap::reduceSelectionToOneCell;
79 int getCols(HullType type)
96 // returns position of first relation operator in the array
97 // used for "intelligent splitting"
98 size_t firstRelOp(MathData const & ar)
100 for (MathData::const_iterator it = ar.begin(); it != ar.end(); ++it)
101 if ((*it)->isRelOp())
102 return it - ar.begin();
107 char const * star(bool numbered)
109 return numbered ? "" : "*";
113 } // end anon namespace
116 HullType hullType(docstring const & s)
118 if (s == "none") return hullNone;
119 if (s == "simple") return hullSimple;
120 if (s == "equation") return hullEquation;
121 if (s == "eqnarray") return hullEqnArray;
122 if (s == "align") return hullAlign;
123 if (s == "alignat") return hullAlignAt;
124 if (s == "xalignat") return hullXAlignAt;
125 if (s == "xxalignat") return hullXXAlignAt;
126 if (s == "multline") return hullMultline;
127 if (s == "gather") return hullGather;
128 if (s == "flalign") return hullFlAlign;
129 if (s == "regexp") return hullRegexp;
130 lyxerr << "unknown hull type '" << to_utf8(s) << "'" << endl;
135 docstring hullName(HullType type)
138 case hullNone: return from_ascii("none");
139 case hullSimple: return from_ascii("simple");
140 case hullEquation: return from_ascii("equation");
141 case hullEqnArray: return from_ascii("eqnarray");
142 case hullAlign: return from_ascii("align");
143 case hullAlignAt: return from_ascii("alignat");
144 case hullXAlignAt: return from_ascii("xalignat");
145 case hullXXAlignAt: return from_ascii("xxalignat");
146 case hullMultline: return from_ascii("multline");
147 case hullGather: return from_ascii("gather");
148 case hullFlAlign: return from_ascii("flalign");
149 case hullRegexp: return from_ascii("regexp");
151 lyxerr << "unknown hull type '" << type << "'" << endl;
152 return from_ascii("none");
156 static InsetLabel * dummy_pointer = 0;
158 InsetMathHull::InsetMathHull(Buffer * buf)
159 : InsetMathGrid(buf, 1, 1), type_(hullNone), numbered_(1, NUMBER),
160 numbers_(1, empty_docstring()), label_(1, dummy_pointer),
161 preview_(new RenderPreview(this)), use_preview_(false)
163 //lyxerr << "sizeof InsetMath: " << sizeof(InsetMath) << endl;
164 //lyxerr << "sizeof MetricsInfo: " << sizeof(MetricsInfo) << endl;
165 //lyxerr << "sizeof InsetMathChar: " << sizeof(InsetMathChar) << endl;
166 //lyxerr << "sizeof FontInfo: " << sizeof(FontInfo) << endl;
173 InsetMathHull::InsetMathHull(Buffer * buf, HullType type)
174 : InsetMathGrid(buf, getCols(type), 1), type_(type), numbered_(1, NUMBER),
175 numbers_(1, empty_docstring()), label_(1, dummy_pointer),
176 preview_(new RenderPreview(this)), use_preview_(false)
184 InsetMathHull::InsetMathHull(InsetMathHull const & other) : InsetMathGrid(other)
190 InsetMathHull::~InsetMathHull()
192 for (size_t i = 0; i < label_.size(); ++i)
197 Inset * InsetMathHull::clone() const
199 return new InsetMathHull(*this);
203 InsetMathHull & InsetMathHull::operator=(InsetMathHull const & other)
207 InsetMathGrid::operator=(other);
209 numbered_ = other.numbered_;
210 numbers_ = other.numbers_;
211 buffer_ = other.buffer_;
212 for (size_t i = 0; i < label_.size(); ++i)
214 label_ = other.label_;
215 for (size_t i = 0; i != label_.size(); ++i) {
217 label_[i] = new InsetLabel(*label_[i]);
219 preview_.reset(new RenderPreview(*other.preview_, this));
225 void InsetMathHull::setBuffer(Buffer & buffer)
227 InsetMathGrid::setBuffer(buffer);
229 for (size_t i = 0; i != label_.size(); ++i) {
231 label_[i]->setBuffer(buffer);
236 // FIXME This should really be controlled by the TOC level, or
237 // something of the sort.
239 const char * counters_to_save[] = {"section", "chapter"};
240 unsigned int const numcnts = sizeof(counters_to_save)/sizeof(char *);
244 void InsetMathHull::updateBuffer(ParIterator const & it, UpdateType utype)
247 //FIXME: buffer_ should be set at creation for this inset! Problem is
248 // This inset is created at too many places (see Parser::parse1() in
253 // if any of the equations are numbered, then we want to save the values
254 // of some of the counters.
256 BufferParams const & bp = buffer_->params();
257 string const & lang = it->getParLanguage(bp)->code();
259 buffer_->masterBuffer()->params().documentClass().counters();
261 // right now, we only need to do this at export time
262 if (utype == OutputUpdate) {
263 for (size_t i = 0; i < numcnts; ++i) {
264 docstring const cnt = from_ascii(counters_to_save[i]);
265 if (cnts.hasCounter(cnt))
266 counter_map[cnt] = cnts.value(cnt);
270 // this has to be done separately
271 docstring const eqstr = from_ascii("equation");
272 if (cnts.hasCounter(eqstr)) {
273 if (utype == OutputUpdate)
274 counter_map[eqstr] = cnts.value(eqstr);
275 for (size_t i = 0; i != label_.size(); ++i) {
277 cnts.step(eqstr, utype);
278 numbers_[i] = cnts.theCounter(eqstr, lang);
280 numbers_[i] = empty_docstring();
286 for (size_t i = 0; i != label_.size(); ++i) {
288 label_[i]->updateBuffer(it, utype);
291 InsetMathGrid::updateBuffer(it, utype);
295 void InsetMathHull::addToToc(DocIterator const & pit, bool output_active) const
298 //FIXME: buffer_ should be set at creation for this inset! Problem is
299 // This inset is created at too many places (see Parser::parse1() in
304 Toc & toc = buffer().tocBackend().toc("equation");
306 for (row_type row = 0; row != nrows(); ++row) {
310 label_[row]->addToToc(pit, output_active);
311 toc.push_back(TocItem(pit, 0, nicelabel(row), output_active));
316 Inset * InsetMathHull::editXY(Cursor & cur, int x, int y)
322 return InsetMathNest::editXY(cur, x, y);
326 InsetMath::mode_type InsetMathHull::currentMode() const
328 if (type_ == hullNone)
329 return UNDECIDED_MODE;
330 // definitely math mode ...
335 bool InsetMathHull::idxFirst(Cursor & cur) const
343 bool InsetMathHull::idxLast(Cursor & cur) const
345 cur.idx() = nargs() - 1;
346 cur.pos() = cur.lastpos();
351 char InsetMathHull::defaultColAlign(col_type col)
353 if (type_ == hullEqnArray)
355 if (type_ == hullMultline)
357 if (type_ == hullGather)
359 if (type_ >= hullAlign)
360 return "rl"[col & 1];
365 char InsetMathHull::displayColAlign(idx_type idx) const
367 if (type_ == hullMultline) {
368 row_type const r = row(idx);
371 if (r == nrows() - 1)
374 return InsetMathGrid::displayColAlign(idx);
378 int InsetMathHull::defaultColSpace(col_type col)
380 if (type_ == hullAlign || type_ == hullAlignAt)
382 if (type_ == hullXAlignAt)
383 return (col & 1) ? 20 : 0;
384 if (type_ == hullXXAlignAt || type_ == hullFlAlign)
385 return (col & 1) ? 40 : 0;
390 docstring InsetMathHull::standardFont() const
395 font_name = from_ascii("texttt");
398 font_name = from_ascii("lyxnochange");
401 font_name = from_ascii("mathnormal");
407 ColorCode InsetMathHull::standardColor() const
413 color = Color_foreground;
422 bool InsetMathHull::previewState(const BufferView *const bv) const
424 if (!editing(bv) && RenderPreview::previewMath()
425 && type_ != hullRegexp)
427 graphics::PreviewImage const * pimage =
428 preview_->getPreviewImage(bv->buffer());
429 return pimage && pimage->image();
436 static const int ERROR_FRAME_WIDTH = 2;
439 void InsetMathHull::metrics(MetricsInfo & mi, Dimension & dim) const
441 if (previewState(mi.base.bv)) {
442 preview_->metrics(mi, dim);
443 if (previewTooSmall(dim)) {
444 // preview image is too small
445 dim.wid += 2 * ERROR_FRAME_WIDTH;
446 dim.asc += 2 * ERROR_FRAME_WIDTH;
448 // insert a one pixel gap in front of the formula
451 dim.des += displayMargin();
453 // Cache the inset dimension.
454 setDimCache(mi, dim);
458 FontSetChanger dummy1(mi.base, standardFont());
459 StyleChanger dummy2(mi.base, display() ? LM_ST_DISPLAY : LM_ST_TEXT);
461 // let the cells adjust themselves
462 InsetMathGrid::metrics(mi, dim);
465 dim.asc += displayMargin();
466 dim.des += displayMargin();
469 if (numberedType()) {
470 FontSetChanger dummy(mi.base, from_ascii("mathbf"));
472 for (row_type row = 0; row < nrows(); ++row)
473 l = max(l, mathed_string_width(mi.base.font, nicelabel(row)));
479 if (type_ == hullRegexp)
481 // make it at least as high as the current font
484 math_font_max_dim(mi.base.font, asc, des);
485 dim.asc = max(dim.asc, asc);
486 dim.des = max(dim.des, des);
487 // Cache the inset dimension.
488 // FIXME: This will overwrite InsetMathGrid dimension, is that OK?
489 setDimCache(mi, dim);
493 bool InsetMathHull::previewTooSmall(Dimension const & dim) const
495 return dim.width() <= 10 && dim.height() <= 10;
499 ColorCode InsetMathHull::backgroundColor(PainterInfo const & pi) const
501 BufferView const * const bv = pi.base.bv;
502 if (previewState(bv)) {
503 Dimension const dim = dimension(*pi.base.bv);
504 if (previewTooSmall(dim))
506 return graphics::PreviewLoader::backgroundColor();
512 void InsetMathHull::drawBackground(PainterInfo & pi, int x, int y) const
514 Dimension const dim = dimension(*pi.base.bv);
515 if (previewTooSmall(dim)) {
516 pi.pain.fillRectangle(x, y - 2 * ERROR_FRAME_WIDTH,
517 dim.wid, dim.asc + dim.des, backgroundColor(pi));
520 pi.pain.fillRectangle(x + 1, y - dim.asc + 1, dim.wid - 2,
521 dim.asc + dim.des - 1, pi.backgroundColor(this));
525 void InsetMathHull::draw(PainterInfo & pi, int x, int y) const
527 BufferView const * const bv = pi.base.bv;
528 use_preview_ = previewState(bv);
530 if (type_ == hullRegexp) {
531 Dimension const dim = dimension(*bv);
532 pi.pain.rectangle(x + 1, y - dim.ascent() + 1,
533 dim.width() - 2, dim.height() - 2, Color_regexpframe);
537 Dimension const dim = dimension(*bv);
538 if (previewTooSmall(dim)) {
539 // we have an extra frame
540 preview_->draw(pi, x + ERROR_FRAME_WIDTH, y);
542 // one pixel gap in front
543 preview_->draw(pi, x + 1, y);
545 setPosCache(pi, x, y);
549 ColorCode color = pi.selected && lyxrc.use_system_colors
550 ? Color_selectiontext : standardColor();
551 bool const really_change_color = pi.base.font.color() == Color_none;
552 ColorChanger dummy0(pi.base.font, color, really_change_color);
553 FontSetChanger dummy1(pi.base, standardFont());
554 StyleChanger dummy2(pi.base, display() ? LM_ST_DISPLAY : LM_ST_TEXT);
556 InsetMathGrid::draw(pi, x + 1, y);
558 if (numberedType()) {
559 int const xx = x + colinfo_.back().offset_ + colinfo_.back().width_ + 20;
560 for (row_type row = 0; row < nrows(); ++row) {
561 int const yy = y + rowinfo_[row].offset_;
562 FontSetChanger dummy(pi.base, from_ascii("mathrm"));
563 docstring const nl = nicelabel(row);
567 setPosCache(pi, x, y);
571 void InsetMathHull::metricsT(TextMetricsInfo const & mi, Dimension & dim) const
574 InsetMathGrid::metricsT(mi, dim);
577 WriteStream wi(os, false, true, WriteStream::wsDefault);
579 dim.wid = os.str().size();
586 void InsetMathHull::drawT(TextPainter & pain, int x, int y) const
589 InsetMathGrid::drawT(pain, x, y);
592 WriteStream wi(os, false, true, WriteStream::wsDefault);
594 pain.draw(x, y, os.str().c_str());
599 static docstring latexString(InsetMathHull const & inset)
602 // This has to be static, because a preview snippet or a math
603 // macro containing math in text mode (such as $\text{$\phi$}$ or
604 // \newcommand{\xxx}{\text{$\phi$}}) gets processed twice. The
605 // first time as a whole, and the second time only the inner math.
606 // In this last case inset.buffer() would be invalid.
607 static Encoding const * encoding = 0;
608 if (inset.isBufferValid())
609 encoding = &(inset.buffer().params().encoding());
610 WriteStream wi(ls, false, true, WriteStream::wsPreview, encoding);
616 void InsetMathHull::initUnicodeMath() const
618 // Trigger classification of the unicode symbols in this inset
619 docstring const dummy = latexString(*this);
623 void InsetMathHull::addPreview(DocIterator const & inset_pos,
624 graphics::PreviewLoader & /*ploader*/) const
626 if (RenderPreview::previewMath()) {
627 preparePreview(inset_pos);
632 void InsetMathHull::usedMacros(MathData const & md, DocIterator const & pos,
633 MacroNameSet & macros, MacroNameSet & defs) const
635 MacroNameSet::iterator const end = macros.end();
637 for (size_t i = 0; i < md.size(); ++i) {
638 MathMacro const * mi = md[i].nucleus()->asMacro();
639 MathMacroTemplate const * mt = md[i].nucleus()->asMacroTemplate();
640 InsetMathScript const * si = md[i].nucleus()->asScriptInset();
641 InsetMathFracBase const * fi = md[i].nucleus()->asFracBaseInset();
642 InsetMathGrid const * gi = md[i].nucleus()->asGridInset();
643 InsetMathNest const * ni = md[i].nucleus()->asNestInset();
645 // Look for macros in the arguments of this macro.
646 for (idx_type idx = 0; idx < mi->nargs(); ++idx)
647 usedMacros(mi->cell(idx), pos, macros, defs);
648 // Make sure this is a macro defined in the document
649 // (as we also spot the macros in the symbols file)
650 // or that we have not already accounted for it.
651 docstring const name = mi->name();
652 if (macros.find(name) == end)
655 // Look for macros in the definition of this macro.
656 MathData ar(pos.buffer());
657 MacroData const * data =
658 pos.buffer()->getMacro(name, pos, true);
660 odocstringstream macro_def;
661 data->write(macro_def, true);
663 defs.insert(macro_def.str());
664 asArray(data->definition(), ar);
666 usedMacros(ar, pos, macros, defs);
668 MathData ar(pos.buffer());
669 asArray(mt->definition(), ar);
670 usedMacros(ar, pos, macros, defs);
672 if (!si->nuc().empty())
673 usedMacros(si->nuc(), pos, macros, defs);
675 usedMacros(si->down(), pos, macros, defs);
677 usedMacros(si->up(), pos, macros, defs);
678 } else if (fi || gi) {
679 idx_type nidx = fi ? fi->nargs() : gi->nargs();
680 for (idx_type idx = 0; idx < nidx; ++idx)
681 usedMacros(fi ? fi->cell(idx) : gi->cell(idx),
684 usedMacros(ni->cell(0), pos, macros, defs);
690 void InsetMathHull::preparePreview(DocIterator const & pos,
691 bool forexport) const
693 // there is no need to do all the macro stuff if we're not
694 // actually going to generate the preview.
695 if (!RenderPreview::previewMath() && !forexport)
698 Buffer const * buffer = pos.buffer();
700 // collect macros at this position
702 buffer->listMacroNames(macros);
704 // collect definitions only for the macros used in this inset
706 for (idx_type idx = 0; idx < nargs(); ++idx)
707 usedMacros(cell(idx), pos, macros, defs);
709 MacroNameSet::iterator it = defs.begin();
710 MacroNameSet::iterator end = defs.end();
711 docstring macro_preamble;
712 for (; it != end; ++it)
713 macro_preamble.append(*it);
716 if (forexport && haveNumbers()) {
717 docstring eqstr = from_ascii("equation");
718 CounterMap::const_iterator it = counter_map.find(eqstr);
719 if (it != counter_map.end()) {
720 int num = it->second;
722 setcnt += from_ascii("\\setcounter{") + eqstr + '}' +
723 '{' + convert<docstring>(num) + '}' + '\n';
725 for (size_t i = 0; i != numcnts; ++i) {
726 docstring cnt = from_ascii(counters_to_save[i]);
727 it = counter_map.find(cnt);
728 if (it == counter_map.end())
730 int num = it->second;
732 setcnt += from_ascii("\\setcounter{") + cnt + '}' +
733 '{' + convert<docstring>(num) + '}';
736 docstring const snippet = macro_preamble + setcnt + latexString(*this);
737 LYXERR(Debug::MACROS, "Preview snippet: " << snippet);
738 preview_->addPreview(snippet, *buffer, forexport);
742 void InsetMathHull::reloadPreview(DocIterator const & pos) const
745 preview_->startLoading(*pos.buffer());
749 void InsetMathHull::loadPreview(DocIterator const & pos) const
751 bool const forexport = true;
752 preparePreview(pos, forexport);
753 preview_->startLoading(*pos.buffer(), forexport);
757 bool InsetMathHull::notifyCursorLeaves(Cursor const & old, Cursor & cur)
759 if (RenderPreview::previewMath()) {
761 cur.screenUpdateFlags(Update::Force);
767 docstring InsetMathHull::label(row_type row) const
769 LASSERT(row < nrows(), return docstring());
770 if (InsetLabel * il = label_[row])
771 return il->screenLabel();
776 void InsetMathHull::label(row_type row, docstring const & label)
778 //lyxerr << "setting label '" << label << "' for row " << row << endl;
782 label_[row] = dummy_pointer;
785 label_[row]->updateLabelAndRefs(label);
787 label_[row]->setParam("name", label);
791 InsetCommandParams p(LABEL_CODE);
793 label_[row] = new InsetLabel(buffer_, p);
795 label_[row]->setBuffer(buffer());
799 void InsetMathHull::numbered(row_type row, Numbered num)
801 numbered_[row] = num;
802 if (!numbered(row) && label_[row]) {
809 bool InsetMathHull::numbered(row_type row) const
811 return numbered_[row] == NUMBER;
815 bool InsetMathHull::ams() const
833 for (size_t row = 0; row < numbered_.size(); ++row)
834 if (numbered_[row] == NOTAG)
840 Inset::DisplayType InsetMathHull::display() const
842 if (type_ == hullSimple || type_ == hullNone || type_ == hullRegexp)
847 bool InsetMathHull::numberedType() const
849 if (type_ == hullNone)
851 if (type_ == hullSimple)
853 if (type_ == hullXXAlignAt)
855 if (type_ == hullRegexp)
857 for (row_type row = 0; row < nrows(); ++row)
864 void InsetMathHull::validate(LaTeXFeatures & features) const
866 if (features.runparams().isLaTeX()) {
868 features.require("amsmath");
870 if (type_ == hullRegexp) {
871 features.require("color");
872 string frcol = lcolor.getLaTeXName(Color_regexpframe);
873 string bgcol = "white";
874 features.addPreambleSnippet(
875 string("\\newcommand{\\regexp}[1]{\\fcolorbox{")
876 + frcol + string("}{")
877 + bgcol + string("}{\\ensuremath{\\mathtt{#1}}}}"));
878 features.addPreambleSnippet(
879 string("\\newcommand{\\endregexp}{}"));
882 // Validation is necessary only if not using AMS math.
883 // To be safe, we will always run mathedvalidate.
884 //if (features.amsstyle)
887 //features.binom = true;
888 } else if (features.runparams().math_flavor == OutputParams::MathAsHTML) {
889 // it would be better to do this elsewhere, but we can't validate in
890 // InsetMathMatrix and we have no way, outside MathExtern, to know if
891 // we even have any matrices.
892 features.addCSSSnippet(
893 "table.matrix{display: inline-block; vertical-align: middle; text-align:center;}\n"
894 "table.matrix td{padding: 0.25px;}\n"
895 "td.ldelim{width: 0.5ex; border: thin solid black; border-right: none;}\n"
896 "td.rdelim{width: 0.5ex; border: thin solid black; border-left: none;}");
898 InsetMathGrid::validate(features);
902 void InsetMathHull::header_write(WriteStream & os) const
904 bool n = numberedType();
918 os << "\n\\begin{equation" << star(n) << "}\n";
928 os << "\n\\begin{" << hullName(type_) << star(n) << "}\n";
933 os << "\n\\begin{" << hullName(type_) << star(n) << '}'
934 << '{' << static_cast<unsigned int>((ncols() + 1)/2) << "}\n";
938 os << "\n\\begin{" << hullName(type_) << '}'
939 << '{' << static_cast<unsigned int>((ncols() + 1)/2) << "}\n";
947 os << "\n\\begin{unknown" << star(n) << "}\n";
953 void InsetMathHull::footer_write(WriteStream & os) const
955 bool n = numberedType();
968 os << "\n\\end{equation" << star(n) << "}\n";
980 os << "\n\\end{" << hullName(type_) << star(n) << "}\n";
984 os << "\n\\end{" << hullName(type_) << "}\n";
988 // Only used as a heuristic to find the regexp termination, when searching in ignore-format mode
989 os << "\\endregexp{}}";
993 os << "\n\\end{unknown" << star(n) << "}\n";
999 bool InsetMathHull::rowChangeOK() const
1002 type_ == hullEqnArray || type_ == hullAlign ||
1003 type_ == hullFlAlign || type_ == hullAlignAt ||
1004 type_ == hullXAlignAt || type_ == hullXXAlignAt ||
1005 type_ == hullGather || type_ == hullMultline;
1009 bool InsetMathHull::colChangeOK() const
1012 type_ == hullAlign || type_ == hullFlAlign ||type_ == hullAlignAt ||
1013 type_ == hullXAlignAt || type_ == hullXXAlignAt;
1017 void InsetMathHull::addRow(row_type row)
1022 bool numbered = numberedType();
1023 // Move the number and raw pointer, do not call label() (bug 7511)
1024 InsetLabel * label = dummy_pointer;
1025 docstring number = empty_docstring();
1026 if (type_ == hullMultline) {
1027 if (row + 1 == nrows()) {
1028 numbered_[row] = NONUMBER;
1029 swap(label, label_[row]);
1030 swap(number, numbers_[row]);
1035 numbered_.insert(numbered_.begin() + row + 1, numbered ? NUMBER : NONUMBER);
1036 numbers_.insert(numbers_.begin() + row + 1, number);
1037 label_.insert(label_.begin() + row + 1, label);
1038 InsetMathGrid::addRow(row);
1042 void InsetMathHull::swapRow(row_type row)
1046 if (row + 1 == nrows())
1048 swap(numbered_[row], numbered_[row + 1]);
1049 swap(numbers_[row], numbers_[row + 1]);
1050 swap(label_[row], label_[row + 1]);
1051 InsetMathGrid::swapRow(row);
1055 void InsetMathHull::delRow(row_type row)
1057 if (nrows() <= 1 || !rowChangeOK())
1059 if (row + 1 == nrows() && type_ == hullMultline) {
1060 swap(numbered_[row - 1], numbered_[row]);
1061 swap(numbers_[row - 1], numbers_[row]);
1062 swap(label_[row - 1], label_[row]);
1063 InsetMathGrid::delRow(row);
1066 InsetMathGrid::delRow(row);
1067 // The last dummy row has no number info nor a label.
1068 // Test nrows() + 1 because we have already erased the row.
1069 if (row == nrows() + 1)
1071 numbered_.erase(numbered_.begin() + row);
1072 numbers_.erase(numbers_.begin() + row);
1074 label_.erase(label_.begin() + row);
1078 void InsetMathHull::addCol(col_type col)
1082 InsetMathGrid::addCol(col);
1086 void InsetMathHull::delCol(col_type col)
1088 if (ncols() <= 1 || !colChangeOK())
1090 InsetMathGrid::delCol(col);
1094 docstring InsetMathHull::nicelabel(row_type row) const
1098 docstring const & val = numbers_[row];
1100 return '(' + val + ')';
1101 return '(' + val + ',' + label_[row]->screenLabel() + ')';
1105 void InsetMathHull::glueall(HullType type)
1108 for (idx_type i = 0; i < nargs(); ++i)
1110 InsetLabel * label = 0;
1111 if (type == hullEquation) {
1112 // preserve first non-empty label
1113 for (row_type row = 0; row < nrows(); ++row) {
1115 label = label_[row];
1121 *this = InsetMathHull(buffer_, hullSimple);
1128 void InsetMathHull::splitTo2Cols()
1130 LASSERT(ncols() == 1, return);
1131 InsetMathGrid::addCol(1);
1132 for (row_type row = 0; row < nrows(); ++row) {
1133 idx_type const i = 2 * row;
1134 pos_type pos = firstRelOp(cell(i));
1135 cell(i + 1) = MathData(buffer_, cell(i).begin() + pos, cell(i).end());
1136 cell(i).erase(pos, cell(i).size());
1141 void InsetMathHull::splitTo3Cols()
1143 LASSERT(ncols() < 3, return);
1146 InsetMathGrid::addCol(2);
1147 for (row_type row = 0; row < nrows(); ++row) {
1148 idx_type const i = 3 * row + 1;
1149 if (!cell(i).empty()) {
1150 cell(i + 1) = MathData(buffer_, cell(i).begin() + 1, cell(i).end());
1151 cell(i).erase(1, cell(i).size());
1157 void InsetMathHull::changeCols(col_type cols)
1159 if (ncols() == cols)
1161 else if (ncols() < cols) {
1167 while (ncols() < cols)
1168 InsetMathGrid::addCol(ncols());
1174 for (row_type row = 0; row < nrows(); ++row) {
1175 idx_type const i = row * ncols();
1176 for (col_type col = cols; col < ncols(); ++col) {
1177 cell(i + cols - 1).append(cell(i + col));
1181 while (ncols() > cols) {
1182 InsetMathGrid::delCol(ncols() - 1);
1187 HullType InsetMathHull::getType() const
1193 void InsetMathHull::setType(HullType type)
1200 void InsetMathHull::mutate(HullType newtype)
1202 //lyxerr << "mutating from '" << type_ << "' to '" << newtype << "'" << endl;
1204 // we try to move along the chain
1205 // none <-> simple <-> equation <-> eqnarray -> *align* -> multline, gather -+
1207 // +-------------------------------------+
1208 // we use eqnarray as intermediate type for mutations that are not
1209 // directly supported because it handles labels and numbering for
1212 if (newtype == type_) {
1216 else if (newtype < hullNone) {
1221 else if (type_ == hullNone) {
1222 setType(hullSimple);
1227 else if (type_ == hullSimple) {
1228 if (newtype == hullNone) {
1232 setType(hullEquation);
1233 numbered(0, label_[0] ? true : false);
1238 else if (type_ == hullEquation) {
1239 if (newtype < type_) {
1240 setType(hullSimple);
1243 } else if (newtype == hullEqnArray) {
1244 // split it "nicely" on the first relop
1246 setType(hullEqnArray);
1247 } else if (newtype == hullMultline || newtype == hullGather) {
1250 // split it "nicely"
1257 else if (type_ == hullEqnArray) {
1258 if (newtype < type_) {
1261 } else { // align & Co.
1268 else if (type_ == hullAlign || type_ == hullAlignAt ||
1269 type_ == hullXAlignAt || type_ == hullFlAlign) {
1270 if (newtype < hullAlign) {
1272 setType(hullEqnArray);
1274 } else if (newtype == hullGather || newtype == hullMultline) {
1277 } else if (newtype == hullXXAlignAt) {
1278 for (row_type row = 0; row < nrows(); ++row)
1279 numbered(row, false);
1286 else if (type_ == hullXXAlignAt) {
1287 for (row_type row = 0; row < nrows(); ++row)
1288 numbered(row, false);
1289 if (newtype < hullAlign) {
1291 setType(hullEqnArray);
1293 } else if (newtype == hullGather || newtype == hullMultline) {
1301 else if (type_ == hullMultline || type_ == hullGather) {
1302 if (newtype == hullGather || newtype == hullMultline)
1304 else if (newtype == hullAlign || newtype == hullFlAlign ||
1305 newtype == hullAlignAt || newtype == hullXAlignAt) {
1308 } else if (newtype == hullXXAlignAt) {
1310 for (row_type row = 0; row < nrows(); ++row)
1311 numbered(row, false);
1315 setType(hullEqnArray);
1321 lyxerr << "mutation from '" << to_utf8(hullName(type_))
1322 << "' to '" << to_utf8(hullName(newtype))
1323 << "' not implemented" << endl;
1328 docstring InsetMathHull::eolString(row_type row, bool fragile, bool latex,
1329 bool last_eoln) const
1332 if (numberedType()) {
1333 if (label_[row] && numbered(row)) {
1334 docstring const name =
1335 latex ? escape(label_[row]->getParam("name"))
1336 : label_[row]->getParam("name");
1337 res += "\\label{" + name + '}';
1339 if (type_ != hullMultline) {
1340 if (numbered_[row] == NONUMBER)
1341 res += "\\nonumber ";
1342 else if (numbered_[row] == NOTAG)
1346 // Never add \\ on the last empty line of eqnarray and friends
1348 return res + InsetMathGrid::eolString(row, fragile, latex, last_eoln);
1352 void InsetMathHull::write(WriteStream & os) const
1354 ModeSpecifier specifier(os, MATH_MODE);
1356 InsetMathGrid::write(os);
1361 void InsetMathHull::normalize(NormalStream & os) const
1363 os << "[formula " << hullName(type_) << ' ';
1364 InsetMathGrid::normalize(os);
1369 void InsetMathHull::infoize(odocstream & os) const
1371 os << bformat(_("Type: %1$s"), hullName(type_));
1375 void InsetMathHull::check() const
1377 LATTEST(numbered_.size() == nrows());
1378 LATTEST(numbers_.size() == nrows());
1379 LATTEST(label_.size() == nrows());
1383 void InsetMathHull::doExtern(Cursor & cur, FuncRequest & func)
1387 idocstringstream iss(func.argument());
1388 iss >> dlang >> extra;
1390 extra = from_ascii("noextra");
1391 string const lang = to_ascii(dlang);
1393 // replace selection with result of computation
1394 if (reduceSelectionToOneCell(cur)) {
1396 asArray(grabAndEraseSelection(cur), ar);
1397 lyxerr << "use selection: " << ar << endl;
1398 cur.insert(pipeThroughExtern(lang, extra, ar));
1402 // only inline, display or eqnarray math is allowed
1403 if (getType() > hullEqnArray) {
1404 frontend::Alert::warning(_("Bad math environment"),
1405 _("Computation cannot be performed for AMS "
1406 "math environments.\nChange the math "
1407 "formula type and try again."));
1412 eq.push_back(MathAtom(new InsetMathChar('=')));
1414 // go to first item in line
1415 cur.idx() -= cur.idx() % ncols();
1418 if (getType() == hullSimple) {
1419 size_type pos = cur.cell().find_last(eq);
1421 if (pos == cur.cell().size()) {
1423 lyxerr << "use whole cell: " << ar << endl;
1425 ar = MathData(buffer_, cur.cell().begin() + pos + 1, cur.cell().end());
1426 lyxerr << "use partial cell form pos: " << pos << endl;
1428 cur.cell().append(eq);
1429 cur.cell().append(pipeThroughExtern(lang, extra, ar));
1430 cur.pos() = cur.lastpos();
1434 if (getType() == hullEquation) {
1435 lyxerr << "use equation inset" << endl;
1436 mutate(hullEqnArray);
1437 MathData & ar = cur.cell();
1438 lyxerr << "use cell: " << ar << endl;
1442 cur.cell() = pipeThroughExtern(lang, extra, ar);
1443 // move to end of line
1444 cur.pos() = cur.lastpos();
1449 lyxerr << "use eqnarray" << endl;
1450 cur.idx() += 2 - cur.idx() % ncols();
1452 MathData ar = cur.cell();
1453 lyxerr << "use cell: " << ar << endl;
1454 // FIXME: temporarily disabled
1460 cur.cell() = pipeThroughExtern(lang, extra, ar);
1461 cur.pos() = cur.lastpos();
1466 void InsetMathHull::doDispatch(Cursor & cur, FuncRequest & cmd)
1468 //lyxerr << "action: " << cmd.action() << endl;
1469 switch (cmd.action()) {
1471 case LFUN_FINISHED_BACKWARD:
1472 case LFUN_FINISHED_FORWARD:
1473 case LFUN_FINISHED_RIGHT:
1474 case LFUN_FINISHED_LEFT:
1475 //lyxerr << "action: " << cmd.action() << endl;
1476 InsetMathGrid::doDispatch(cur, cmd);
1479 case LFUN_PARAGRAPH_BREAK:
1480 // just swallow this
1483 case LFUN_NEWLINE_INSERT:
1484 // some magic for the common case
1485 if (type_ == hullSimple || type_ == hullEquation) {
1486 cur.recordUndoInset();
1488 cur.bv().buffer().params().use_package("amsmath") == BufferParams::package_on;
1489 mutate(align ? hullAlign : hullEqnArray);
1490 // mutate() may change labels and such.
1491 cur.forceBufferUpdate();
1492 cur.idx() = nrows() * ncols() - 1;
1493 cur.pos() = cur.lastpos();
1495 InsetMathGrid::doDispatch(cur, cmd);
1498 case LFUN_MATH_NUMBER_TOGGLE: {
1499 //lyxerr << "toggling all numbers" << endl;
1500 cur.recordUndoInset();
1501 bool old = numberedType();
1502 if (type_ == hullMultline)
1503 numbered(nrows() - 1, !old);
1505 for (row_type row = 0; row < nrows(); ++row)
1506 numbered(row, !old);
1508 cur.message(old ? _("No number") : _("Number"));
1509 cur.forceBufferUpdate();
1513 case LFUN_MATH_NUMBER_LINE_TOGGLE: {
1514 cur.recordUndoInset();
1515 row_type r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1516 bool old = numbered(r);
1517 cur.message(old ? _("No number") : _("Number"));
1519 cur.forceBufferUpdate();
1523 case LFUN_LABEL_INSERT: {
1524 row_type r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1525 docstring old_label = label(r);
1526 docstring const default_label = from_ascii("eq:");
1527 if (old_label.empty())
1528 old_label = default_label;
1530 InsetCommandParams p(LABEL_CODE);
1531 p["name"] = cmd.argument().empty() ? old_label : cmd.argument();
1532 string const data = InsetCommand::params2string(p);
1534 if (cmd.argument().empty())
1535 cur.bv().showDialog("label", data);
1537 FuncRequest fr(LFUN_INSET_INSERT, data);
1543 case LFUN_LABEL_COPY_AS_REFERENCE: {
1545 if (cmd.argument().empty() && &cur.inset() == this)
1546 // if there is no argument and we're inside math, we retrieve
1547 // the row number from the cursor position.
1548 row = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1550 // if there is an argument, find the corresponding label, else
1551 // check whether there is at least one label.
1552 for (row = 0; row != nrows(); ++row)
1553 if (numbered(row) && label_[row]
1554 && (cmd.argument().empty() || label(row) == cmd.argument()))
1561 InsetCommandParams p(REF_CODE, "ref");
1562 p["reference"] = label(row);
1563 cap::clearSelection();
1564 cap::copyInset(cur, new InsetRef(buffer_, p), label(row));
1568 case LFUN_WORD_DELETE_FORWARD:
1569 case LFUN_CHAR_DELETE_FORWARD:
1570 if (col(cur.idx()) + 1 == ncols()
1571 && cur.pos() == cur.lastpos()
1572 && !cur.selection()) {
1573 if (!label(row(cur.idx())).empty()) {
1574 cur.recordUndoInset();
1575 label(row(cur.idx()), docstring());
1576 } else if (numbered(row(cur.idx()))) {
1577 cur.recordUndoInset();
1578 numbered(row(cur.idx()), false);
1579 cur.forceBufferUpdate();
1581 InsetMathGrid::doDispatch(cur, cmd);
1585 InsetMathGrid::doDispatch(cur, cmd);
1590 case LFUN_INSET_INSERT: {
1591 //lyxerr << "arg: " << to_utf8(cmd.argument()) << endl;
1592 // FIXME: this should be cleaned up to use InsetLabel methods directly.
1593 string const name = cmd.getArg(0);
1594 if (name == "label") {
1595 InsetCommandParams p(LABEL_CODE);
1596 InsetCommand::string2params(to_utf8(cmd.argument()), p);
1597 docstring str = p["name"];
1598 cur.recordUndoInset();
1599 row_type const r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1603 docstring old = label(r);
1606 // The label will take care of the reference update.
1610 // Newly created inset so initialize it.
1611 label_[r]->initView();
1614 cur.forceBufferUpdate();
1617 InsetMathGrid::doDispatch(cur, cmd);
1621 case LFUN_MATH_EXTERN:
1622 cur.recordUndoInset();
1626 case LFUN_MATH_MUTATE: {
1627 cur.recordUndoInset();
1628 row_type row = cur.row();
1629 col_type col = cur.col();
1630 mutate(hullType(cmd.argument()));
1631 cur.idx() = row * ncols() + col;
1632 if (cur.idx() > cur.lastidx()) {
1633 cur.idx() = cur.lastidx();
1634 cur.pos() = cur.lastpos();
1636 if (cur.pos() > cur.lastpos())
1637 cur.pos() = cur.lastpos();
1639 cur.forceBufferUpdate();
1640 // FIXME: find some more clever handling of the selection,
1641 // i.e. preserve it.
1642 cur.clearSelection();
1643 //cur.dispatched(FINISHED);
1647 case LFUN_MATH_DISPLAY: {
1648 cur.recordUndoInset();
1649 mutate(type_ == hullSimple ? hullEquation : hullSimple);
1650 // if the cursor is in a cell that got merged, move it to
1651 // start of the hull inset.
1652 if (cur.idx() > 0) {
1656 if (cur.pos() > cur.lastpos())
1657 cur.pos() = cur.lastpos();
1663 InsetMathGrid::doDispatch(cur, cmd);
1669 bool InsetMathHull::getStatus(Cursor & cur, FuncRequest const & cmd,
1670 FuncStatus & status) const
1672 switch (cmd.action()) {
1673 case LFUN_FINISHED_BACKWARD:
1674 case LFUN_FINISHED_FORWARD:
1675 case LFUN_FINISHED_RIGHT:
1676 case LFUN_FINISHED_LEFT:
1679 case LFUN_NEWLINE_INSERT:
1680 case LFUN_MATH_EXTERN:
1682 status.setEnabled(true);
1685 // we never allow this in math, and we want to bind enter
1686 // to another actions in command-alternatives
1687 case LFUN_PARAGRAPH_BREAK:
1688 status.setEnabled(false);
1690 case LFUN_MATH_MUTATE: {
1691 HullType const ht = hullType(cmd.argument());
1692 status.setOnOff(type_ == ht);
1693 status.setEnabled(true);
1695 if (ht != hullSimple) {
1696 Cursor tmpcur = cur;
1697 while (!tmpcur.empty()) {
1698 InsetCode code = tmpcur.inset().lyxCode();
1699 if (code == BOX_CODE) {
1701 } else if (code == TABULAR_CODE) {
1702 FuncRequest tmpcmd(LFUN_MATH_DISPLAY);
1703 if (tmpcur.getStatus(tmpcmd, status) && !status.enabled())
1711 case LFUN_MATH_DISPLAY: {
1713 if (cur.depth() > 1) {
1714 Inset const & in = cur[cur.depth()-2].inset();
1715 if (in.lyxCode() == SCRIPT_CODE)
1716 enable = display() != Inline;
1718 status.setEnabled(enable);
1719 status.setOnOff(display() != Inline);
1723 case LFUN_MATH_NUMBER_TOGGLE:
1724 // FIXME: what is the right test, this or the one of
1726 status.setEnabled(display() != Inline);
1727 status.setOnOff(numberedType());
1730 case LFUN_MATH_NUMBER_LINE_TOGGLE: {
1731 // FIXME: what is the right test, this or the one of
1733 bool const enable = (type_ == hullMultline)
1734 ? (nrows() - 1 == cur.row())
1735 : display() != Inline;
1736 row_type const r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1737 status.setEnabled(enable);
1738 status.setOnOff(enable && numbered(r));
1742 case LFUN_LABEL_INSERT:
1743 status.setEnabled(type_ != hullSimple);
1746 case LFUN_LABEL_COPY_AS_REFERENCE: {
1747 bool enabled = false;
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();
1753 enabled = numberedType() && label_[row] && numbered(row);
1755 // if there is an argument, find the corresponding label, else
1756 // check whether there is at least one label.
1757 for (row_type row = 0; row != nrows(); ++row) {
1758 if (numbered(row) && label_[row] &&
1759 (cmd.argument().empty() || label(row) == cmd.argument())) {
1765 status.setEnabled(enabled);
1769 case LFUN_INSET_INSERT:
1770 if (cmd.getArg(0) == "label") {
1771 status.setEnabled(type_ != hullSimple);
1774 return InsetMathGrid::getStatus(cur, cmd, status);
1776 case LFUN_INSET_MODIFY: {
1777 istringstream is(to_utf8(cmd.argument()));
1781 return InsetMathGrid::getStatus(cur, cmd, status);
1784 && (s == "append-row"
1785 || s == "delete-row"
1786 || s == "copy-row")) {
1787 status.message(bformat(
1788 from_utf8(N_("Can't change number of rows in '%1$s'")),
1790 status.setEnabled(false);
1794 && (s == "append-column"
1795 || s == "delete-column"
1796 || s == "copy-column")) {
1797 status.message(bformat(
1798 from_utf8(N_("Can't change number of columns in '%1$s'")),
1800 status.setEnabled(false);
1803 if ((type_ == hullSimple
1804 || type_ == hullEquation
1805 || type_ == hullNone) &&
1806 (s == "add-hline-above" || s == "add-hline-below")) {
1807 status.message(bformat(
1808 from_utf8(N_("Can't add horizontal grid lines in '%1$s'")),
1810 status.setEnabled(false);
1813 if (s == "add-vline-left" || s == "add-vline-right") {
1814 status.message(bformat(
1815 from_utf8(N_("Can't add vertical grid lines in '%1$s'")),
1817 status.setEnabled(false);
1820 if (s == "valign-top" || s == "valign-middle"
1821 || s == "valign-bottom" || s == "align-left"
1822 || s == "align-center" || s == "align-right") {
1823 status.setEnabled(false);
1826 return InsetMathGrid::getStatus(cur, cmd, status);
1830 return InsetMathGrid::getStatus(cur, cmd, status);
1833 // This cannot really happen, but inserted to shut-up gcc
1834 return InsetMathGrid::getStatus(cur, cmd, status);
1838 /////////////////////////////////////////////////////////////////////
1842 // simply scrap this function if you want
1843 void InsetMathHull::mutateToText()
1846 // translate to latex
1848 latex(os, false, false);
1849 string str = os.str();
1852 Text * lt = view_->cursor().innerText();
1853 string::const_iterator cit = str.begin();
1854 string::const_iterator end = str.end();
1855 for (; cit != end; ++cit)
1856 view_->getIntl()->getTransManager().TranslateAndInsert(*cit, lt);
1859 //dispatch(LFUN_ESCAPE);
1864 void InsetMathHull::handleFont(Cursor & cur, docstring const & arg,
1865 docstring const & font)
1867 // this whole function is a hack and won't work for incremental font
1870 if (cur.inset().asInsetMath()->name() == font)
1871 cur.handleFont(to_utf8(font));
1873 cur.handleNest(createInsetMath(font, cur.buffer()));
1879 void InsetMathHull::handleFont2(Cursor & cur, docstring const & arg)
1884 font.fromString(to_utf8(arg), b);
1885 if (font.fontInfo().color() != Color_inherit) {
1886 MathAtom at = MathAtom(new InsetMathColor(buffer_, true, font.fontInfo().color()));
1887 cur.handleNest(at, 0);
1892 void InsetMathHull::edit(Cursor & cur, bool front, EntryDirection entry_from)
1895 bool enter_front = (entry_from == Inset::ENTRY_DIRECTION_LEFT ||
1896 (entry_from == Inset::ENTRY_DIRECTION_IGNORE && front));
1897 enter_front ? idxFirst(cur) : idxLast(cur);
1898 // The inset formula dimension is not necessarily the same as the
1899 // one of the instant preview image, so we have to indicate to the
1900 // BufferView that a metrics update is needed.
1901 cur.screenUpdateFlags(Update::Force);
1905 void InsetMathHull::revealCodes(Cursor & cur) const
1907 if (!cur.inMathed())
1909 odocstringstream os;
1911 cur.message(os.str());
1913 // write something to the minibuffer
1914 // translate to latex
1918 string str = os.str();
1920 string::size_type pos = 0;
1922 for (string::iterator it = str.begin(); it != str.end(); ++it) {
1925 else if (*it == '\0') {
1927 pos = it - str.begin();
1933 res = res.substr(pos - 30);
1934 if (res.size() > 60)
1935 res = res.substr(0, 60);
1941 /////////////////////////////////////////////////////////////////////
1945 bool InsetMathHull::searchForward(BufferView * bv, string const & str,
1948 // FIXME: completely broken
1949 static InsetMathHull * lastformula = 0;
1950 static CursorBase current = DocIterator(ibegin(nucleus()));
1952 static string laststr;
1954 if (lastformula != this || laststr != str) {
1955 //lyxerr << "reset lastformula to " << this << endl;
1958 current = ibegin(nucleus());
1960 mathed_parse_cell(ar, str, Parse::NORMAL, &buffer());
1964 //lyxerr << "searching '" << str << "' in " << this << ar << endl;
1966 for (DocIterator it = current; it != iend(nucleus()); increment(it)) {
1967 CursorSlice & top = it.back();
1968 MathData const & a = top.asInsetMath()->cell(top.idx_);
1969 if (a.matchpart(ar, top.pos_)) {
1970 bv->cursor().setSelection(it, ar.size());
1972 top.pos_ += ar.size();
1978 //lyxerr << "not found!" << endl;
1985 void InsetMathHull::write(ostream & os) const
1987 odocstringstream oss;
1988 WriteStream wi(oss, false, false, WriteStream::wsDefault);
1991 os << to_utf8(oss.str());
1995 void InsetMathHull::read(Lexer & lex)
1998 mathed_parse_normal(buffer_, at, lex, Parse::TRACKMACRO);
1999 operator=(*at->asHullInset());
2003 bool InsetMathHull::readQuiet(Lexer & lex)
2006 bool success = mathed_parse_normal(buffer_, at, lex, Parse::QUIET);
2008 operator=(*at->asHullInset());
2013 int InsetMathHull::plaintext(odocstringstream & os,
2014 OutputParams const & op, size_t max_length) const
2016 // disables ASCII-art for export of equations. See #2275.
2017 if (0 && display()) {
2021 TextPainter tpain(dim.width(), dim.height());
2022 drawT(tpain, 0, dim.ascent());
2024 // reset metrics cache to "real" values
2026 return tpain.textheight();
2029 odocstringstream oss;
2030 Encoding const * const enc = encodings.fromLyXName("utf8");
2031 WriteStream wi(oss, false, true, WriteStream::wsDefault, enc);
2034 if (type_ == hullRegexp)
2037 for (row_type r = 0; r < nrows(); ++r) {
2038 for (col_type c = 0; c < ncols(); ++c)
2039 wi << (c == 0 ? "" : "\t") << cell(index(r, c));
2040 // if it's for the TOC, we write just the first line
2041 // and do not include the newline.
2042 if (op.for_toc || op.for_tooltip || oss.str().size() >= max_length)
2044 if (r < nrows() - 1)
2048 docstring const str = oss.str();
2054 int InsetMathHull::docbook(odocstream & os, OutputParams const & runparams) const
2059 if (getType() == hullSimple)
2060 name = from_ascii("inlineequation");
2062 name = from_ascii("informalequation");
2064 docstring bname = name;
2065 if (!label(0).empty())
2066 bname += " id='" + sgml::cleanID(buffer(), runparams, label(0)) + "'";
2068 ++ms.tab(); ms.cr(); ms.os() << '<' << bname << '>';
2070 odocstringstream ls;
2071 if (runparams.flavor == OutputParams::XML) {
2072 ms << MTag("alt role='tex' ");
2073 // Workaround for db2latex: db2latex always includes equations with
2074 // \ensuremath{} or \begin{display}\end{display}
2075 // so we strip LyX' math environment
2076 WriteStream wi(ls, false, false, WriteStream::wsDefault, runparams.encoding);
2077 InsetMathGrid::write(wi);
2078 ms << from_utf8(subst(subst(to_utf8(ls.str()), "&", "&"), "<", "<"));
2083 InsetMathGrid::mathmlize(ms);
2088 otexstream ols(ls, texrow);
2089 ms << MTag("alt role='tex'");
2090 latex(ols, runparams);
2091 res = texrow.rows();
2092 ms << from_utf8(subst(subst(to_utf8(ls.str()), "&", "&"), "<", "<"));
2096 ms << from_ascii("<graphic fileref=\"eqn/");
2097 if (!label(0).empty())
2098 ms << sgml::cleanID(buffer(), runparams, label(0));
2100 ms << sgml::uniqueID(from_ascii("anon"));
2102 if (runparams.flavor == OutputParams::XML)
2103 ms << from_ascii("\"/>");
2105 ms << from_ascii("\">");
2107 ms.cr(); --ms.tab(); ms.os() << "</" << name << '>';
2109 return ms.line() + res;
2113 bool InsetMathHull::haveNumbers() const
2115 bool havenumbers = false;
2116 // inline formulas are never numbered (bug 7351 part 3)
2117 if (getType() == hullSimple)
2119 for (size_t i = 0; i != numbered_.size(); ++i) {
2130 // We need to do something about alignment here.
2132 // This duplicates code from InsetMathGrid, but
2133 // we need access here to number information,
2134 // and we simply do not have that in InsetMathGrid.
2135 void InsetMathHull::htmlize(HtmlStream & os) const
2137 bool const havenumbers = haveNumbers();
2138 bool const havetable = havenumbers || nrows() > 1 || ncols() > 1;
2141 os << cell(index(0, 0));
2145 os << MTag("table", "class='mathtable'");
2146 for (row_type row = 0; row < nrows(); ++row) {
2148 for (col_type col = 0; col < ncols(); ++col) {
2150 os << cell(index(row, col));
2155 docstring const & num = numbers_[row];
2157 os << '(' << num << ')';
2162 os << ETag("table");
2166 // this duplicates code from InsetMathGrid, but
2167 // we need access here to number information,
2168 // and we simply do not have that in InsetMathGrid.
2169 void InsetMathHull::mathmlize(MathStream & os) const
2171 bool const havenumbers = haveNumbers();
2172 bool const havetable = havenumbers || nrows() > 1 || ncols() > 1;
2175 os << MTag("mtable");
2176 char const * const celltag = havetable ? "mtd" : "mrow";
2177 // FIXME There does not seem to be wide support at the moment
2178 // for mlabeledtr, so we have to use just mtr for now.
2179 // char const * const rowtag = havenumbers ? "mlabeledtr" : "mtr";
2180 char const * const rowtag = "mtr";
2181 for (row_type row = 0; row < nrows(); ++row) {
2184 for (col_type col = 0; col < ncols(); ++col) {
2186 << cell(index(row, col))
2192 docstring const & num = numbers_[row];
2194 os << '(' << num << ')';
2201 os << ETag("mtable");
2205 void InsetMathHull::mathAsLatex(WriteStream & os) const
2207 MathEnsurer ensurer(os, false);
2208 bool havenumbers = haveNumbers();
2209 bool const havetable = havenumbers || nrows() > 1 || ncols() > 1;
2212 os << cell(index(0, 0));
2216 os << "<table class='mathtable'>";
2217 for (row_type row = 0; row < nrows(); ++row) {
2219 for (col_type col = 0; col < ncols(); ++col) {
2220 os << "<td class='math'>";
2221 os << cell(index(row, col));
2226 docstring const & num = numbers_[row];
2228 os << '(' << num << ')';
2237 docstring InsetMathHull::xhtml(XHTMLStream & xs, OutputParams const & op) const
2239 BufferParams::MathOutput const mathtype =
2240 buffer().masterBuffer()->params().html_math_output;
2242 bool success = false;
2244 // we output all the labels just at the beginning of the equation.
2245 // this should be fine.
2246 for (size_t i = 0; i != label_.size(); ++i) {
2247 InsetLabel const * const il = label_[i];
2253 // FIXME Eventually we would like to do this inset by inset.
2254 if (mathtype == BufferParams::MathML) {
2255 odocstringstream os;
2260 } catch (MathExportException const &) {}
2262 if (getType() == hullSimple)
2263 xs << html::StartTag("math",
2264 "xmlns=\"http://www.w3.org/1998/Math/MathML\"", true);
2266 xs << html::StartTag("math",
2267 "display=\"block\" xmlns=\"http://www.w3.org/1998/Math/MathML\"", true);
2268 xs << XHTMLStream::ESCAPE_NONE
2270 << html::EndTag("math");
2272 } else if (mathtype == BufferParams::HTML) {
2273 odocstringstream os;
2278 } catch (MathExportException const &) {}
2280 string const tag = (getType() == hullSimple) ? "span" : "div";
2281 xs << html::StartTag(tag, "class='formula'", true)
2282 << XHTMLStream::ESCAPE_NONE
2284 << html::EndTag(tag);
2288 // what we actually want is this:
2290 // ((mathtype == BufferParams::MathML || mathtype == BufferParams::HTML)
2292 // || mathtype == BufferParams::Images
2294 // but what follows is equivalent, since we'll enter only if either (a) we
2295 // tried and failed with MathML or HTML or (b) didn't try yet at all but
2296 // aren't doing LaTeX, in which case we are doing Images.
2297 if (!success && mathtype != BufferParams::LaTeX) {
2298 graphics::PreviewImage const * pimage = 0;
2300 loadPreview(docit_);
2301 pimage = preview_->getPreviewImage(buffer());
2302 // FIXME Do we always have png?
2305 if (pimage || op.dryrun) {
2306 string const filename = pimage ? pimage->filename().onlyFileName()
2307 : "previewimage.png";
2309 // if we are not in the master buffer, then we need to see that the
2310 // generated image is copied there; otherwise, preview fails.
2311 Buffer const * mbuf = buffer().masterBuffer();
2312 if (mbuf != &buffer()) {
2313 string mbtmp = mbuf->temppath();
2314 FileName const mbufimg(support::addName(mbtmp, filename));
2315 pimage->filename().copyTo(mbufimg);
2317 // add the file to the list of files to be exported
2318 op.exportdata->addExternalFile("xhtml", pimage->filename());
2321 string const tag = (getType() == hullSimple) ? "span" : "div";
2323 << html::StartTag(tag)
2324 << html::CompTag("img", "src=\"" + filename + "\" alt=\"Mathematical Equation\"")
2325 << html::EndTag(tag)
2331 // so we'll pass this test if we've failed everything else, or
2332 // if mathtype was LaTeX, since we won't have entered any of the
2334 if (!success /* || mathtype != BufferParams::LaTeX */) {
2335 // Unfortunately, we cannot use latexString() because we do not want
2336 // $...$ or whatever.
2337 odocstringstream ls;
2338 WriteStream wi(ls, false, true, WriteStream::wsPreview);
2339 ModeSpecifier specifier(wi, MATH_MODE);
2341 docstring const latex = ls.str();
2343 // class='math' allows for use of jsMath
2344 // http://www.math.union.edu/~dpvc/jsMath/
2346 // probably should allow for some kind of customization here
2347 string const tag = (getType() == hullSimple) ? "span" : "div";
2348 xs << html::StartTag(tag, "class='math'")
2350 << html::EndTag(tag)
2357 void InsetMathHull::toString(odocstream & os) const
2359 odocstringstream ods;
2360 plaintext(ods, OutputParams(0));
2365 void InsetMathHull::forOutliner(docstring & os, size_t) const
2367 odocstringstream ods;
2375 string InsetMathHull::contextMenuName() const
2377 return "context-math";
2381 void InsetMathHull::recordLocation(DocIterator const & di)