3 * Purpose: Implementation of formula inset
4 * Author: Alejandro Aguilar Sierra <asierra@servidor.unam.mx>
5 * Created: January 1996
6 * Description: Allows the edition of math paragraphs inside Lyx.
8 * Copyright: 1996-1998 Alejandro Aguilar Sierra
10 * Version: 0.4, Lyx project.
12 * You are free to use and modify this code under the terms of
13 * the GNU General Public Licence version 2 or later.
17 #pragma implementation
23 #include "commandtags.h"
24 #include "math_cursor.h"
25 #include "math_parser.h"
26 #include "math_charinset.h"
27 #include "math_arrayinset.h"
28 #include "math_deliminset.h"
30 #include "BufferView.h"
33 #include "frontends/Alert.h"
34 #include "support/LOstream.h"
35 #include "support/LAssert.h"
36 #include "support/systemcall.h"
37 #include "support/filetools.h" // LibFileSearch
41 #include "math_hullinset.h"
42 #include "math_support.h"
43 #include "math_mathmlstream.h"
44 #include "textpainter.h"
57 string captureOutput(string const & cmd, string const & data)
59 string outfile = lyx::tempName(string(), "mathextern");
60 string full = "echo '" + data + "' | (" + cmd + ") > " + outfile;
61 lyxerr << "calling: " << full << "\n";
63 dummy.startscript(Systemcall::Wait, full);
64 string out = GetFileContents(outfile);
66 lyxerr << "result: '" << out << "'\n";
71 MathArray pipeThroughMaple(string const & extra, MathArray const & ar)
73 string header = "readlib(latex):\n";
75 // remove the \\it for variable names
76 //"#`latex/csname_font` := `\\it `:"
78 "`latex/csname_font` := ``:\n";
80 // export matrices in (...) instead of [...]
82 "`latex/latex/matrix` := "
83 "subs(`[`=`(`, `]`=`)`,"
84 "eval(`latex/latex/matrix`)):\n";
86 // replace \\cdots with proper '*'
89 "subs(`\\,`=`\\cdot `,"
90 "eval(`latex/latex/*`)):\n";
92 // remove spurious \\noalign{\\medskip} in matrix output
94 "`latex/latex/matrix`:= "
95 "subs(`\\\\\\\\\\\\noalign{\\\\medskip}` = `\\\\\\\\`,"
96 "eval(`latex/latex/matrix`)):\n";
98 //"#`latex/latex/symbol` "
99 // " := subs((\\'_\\' = \\'`\\_`\\',eval(`latex/latex/symbol`)): ";
101 string trailer = "quit;";
105 string expr = os.str().c_str();
107 for (int i = 0; i < 100; ++i) { // at most 100 attempts
108 // try to fix missing '*' the hard way by using mint
110 // ... > echo "1A;" | mint -i 1 -S -s -q
113 // Probably missing an operator such as * p
115 lyxerr << "checking expr: '" << expr << "'\n";
116 string out = captureOutput("mint -i 1 -S -s -q -q", expr + ";");
118 break; // expression syntax is ok
119 istringstream is(out.c_str());
122 if (line.find("on line") != 0)
123 break; // error message not identified
125 string::size_type pos = line.find('^');
126 if (pos == string::npos || pos < 15)
127 break; // caret position not found
128 pos -= 15; // skip the "on line ..." part
129 if (expr[pos] == '*' || (pos > 0 && expr[pos - 1] == '*'))
130 break; // two '*' in a row are definitely bad
131 expr.insert(pos, "*");
134 string full = "latex(" + extra + '(' + expr + "));";
135 string out = captureOutput("maple -q", header + full + trailer);
141 mathed_parse_cell(res, out);
146 MathArray pipeThroughOctave(string const &, MathArray const & ar)
151 string expr = os.str().c_str();
154 for (int i = 0; i < 100; ++i) { // at most 100 attempts
156 // try to fix missing '*' the hard way
158 // >>> ([[1 2 3 ];[2 3 1 ];[3 1 2 ]])([[1 2 3 ];[2 3 1 ];[3 1 2 ]])
161 lyxerr << "checking expr: '" << expr << "'\n";
162 out = captureOutput("octave -q 2>&1", expr);
163 lyxerr << "checking out: '" << out << "'\n";
165 // leave loop if expression syntax is probably ok
166 if (out.find("parse error:") == string::npos)
169 // search line with single caret
170 istringstream is(out.c_str());
174 lyxerr << "skipping line: '" << line << "'\n";
175 if (line.find(">>> ") != string::npos)
179 // found line with error, next line is the one with caret
181 string::size_type pos = line.find('^');
182 lyxerr << "caret line: '" << line << "'\n";
183 lyxerr << "found caret at pos: '" << pos << "'\n";
184 if (pos == string::npos || pos < 4)
185 break; // caret position not found
186 pos -= 4; // skip the ">>> " part
187 if (expr[pos] == '*')
188 break; // two '*' in a row are definitely bad
189 expr.insert(pos, "*");
198 // parse output as matrix or single number
199 MathAtom at(new MathArrayInset("array", out));
200 MathArrayInset const * mat = at.nucleus()->asArrayInset();
202 if (mat->ncols() == 1 && mat->nrows() == 1)
203 res.push_back(mat->cell(0));
205 res.push_back(MathAtom(new MathDelimInset("(", ")")));
206 res.back()->cell(0).push_back(at);
212 MathArray pipeThroughExtern(string const & lang, string const & extra,
213 MathArray const & ar)
215 if (lang == "octave")
216 return pipeThroughOctave(extra, ar);
219 return pipeThroughMaple(extra, ar);
221 // create normalized expression
224 os << "[" << extra << ' ';
227 string data = os.str().c_str();
229 // search external script
230 string file = LibFileSearch("mathed", "extern_" + lang);
232 lyxerr << "converter to '" << lang << "' not found\n";
236 // run external sript
237 string out = captureOutput(file, data);
239 mathed_parse_cell(res, out);
246 InsetFormula::InsetFormula()
247 : par_(MathAtom(new MathHullInset))
251 InsetFormula::InsetFormula(MathInsetTypes t)
252 : par_(MathAtom(new MathHullInset(t)))
256 InsetFormula::InsetFormula(string const & s)
259 bool res = mathed_parse_normal(par_, s);
262 res = mathed_parse_normal(par_, "$" + s + "$");
265 lyxerr << "cannot interpret '" << s << "' as math\n";
266 par_ = MathAtom(new MathHullInset(LM_OT_SIMPLE));
273 Inset * InsetFormula::clone(Buffer const &, bool) const
275 return new InsetFormula(*this);
279 void InsetFormula::write(Buffer const *, ostream & os) const
282 WriteStream wi(os, false, false);
287 int InsetFormula::latex(Buffer const *, ostream & os, bool fragile, bool) const
289 WriteStream wi(os, fragile, true);
295 int InsetFormula::ascii(Buffer const *, ostream & os, int) const
300 TextPainter tpain(par()->width(), par()->height());
301 par()->drawT(tpain, 0, par()->ascent());
303 // reset metrics cache to "real" values
305 return tpain.textheight();
307 WriteStream wi(os, false);
314 int InsetFormula::linuxdoc(Buffer const * buf, ostream & os) const
316 return docbook(buf, os);
320 int InsetFormula::docbook(Buffer const * buf, ostream & os) const
323 ms << MTag("equation") << MTag("alt");
324 int res = ascii(buf, ms.os(), 0);
325 ms << ETag("alt") << MTag("math");
326 ms << par_.nucleus();
327 ms << ETag("math") << ETag("equation");
328 return ms.line() + res;
332 void InsetFormula::read(Buffer const *, LyXLex & lex)
334 mathed_parse_normal(par_, lex);
339 //ostream & operator<<(ostream & os, LyXCursor const & c)
341 // os << '[' << c.x() << ' ' << c.y() << ' ' << c.pos() << ']';
346 void InsetFormula::draw(BufferView * bv, LyXFont const & font,
347 int y, float & xx, bool) const
352 int w = par_->width();
353 int h = par_->height();
354 int a = par_->ascent();
355 Painter & pain = bv->painter();
357 if (lcolor.getX11Name(LColor::mathbg)!=lcolor.getX11Name(LColor::background))
358 pain.fillRectangle(x, y - a, w, h, LColor::mathbg);
361 const_cast<InsetFormulaBase const *>(mathcursor->formula()) == this)
363 mathcursor->drawSelection(pain);
364 pain.rectangle(x, y - a, w, h, LColor::mathframe);
367 par_->draw(pain, x, y);
372 setCursorVisible(false);
376 vector<string> const InsetFormula::getLabelList() const
378 return hull()->getLabelList();
382 UpdatableInset::RESULT
383 InsetFormula::localDispatch(BufferView * bv, kb_action action,
386 RESULT result = DISPATCHED;
391 bv->lockedInsetStoreUndo(Undo::INSERT);
392 mathcursor->breakLine();
393 mathcursor->normalize();
394 updateLocal(bv, true);
397 case LFUN_MATH_NUMBER:
399 //lyxerr << "toggling all numbers\n";
401 bv->lockedInsetStoreUndo(Undo::INSERT);
402 bool old = hull()->numberedType();
403 for (MathInset::row_type row = 0; row < par_->nrows(); ++row)
404 hull()->numbered(row, !old);
405 bv->owner()->message(old ? _("No number") : _("Number"));
406 updateLocal(bv, true);
411 case LFUN_MATH_NONUMBER:
413 //lyxerr << "toggling line number\n";
415 bv->lockedInsetStoreUndo(Undo::INSERT);
416 MathCursor::row_type row = mathcursor->hullRow();
417 bool old = hull()->numbered(row);
418 bv->owner()->message(old ? _("No number") : _("Number"));
419 hull()->numbered(row, !old);
420 updateLocal(bv, true);
425 case LFUN_INSERT_LABEL:
427 bv->lockedInsetStoreUndo(Undo::INSERT);
429 MathCursor::row_type row = mathcursor->hullRow();
430 string old_label = hull()->label(row);
431 string new_label = arg;
433 if (new_label.empty()) {
434 string const default_label =
435 (lyxrc.label_init_length >= 0) ? "eq:" : "";
436 pair<bool, string> const res = old_label.empty()
437 ? Alert::askForText(_("Enter new label to insert:"), default_label)
438 : Alert::askForText(_("Enter label:"), old_label);
441 new_label = frontStrip(strip(res.second));
444 //if (new_label == old_label)
445 // break; // Nothing to do
447 if (!new_label.empty()) {
448 lyxerr << "setting label to '" << new_label << "'\n";
449 hull()->numbered(row, true);
452 if (!new_label.empty() && bv->ChangeRefsIfUnique(old_label, new_label))
455 hull()->label(row, new_label);
457 updateLocal(bv, true);
461 case LFUN_MATH_MUTATE:
463 bv->lockedInsetStoreUndo(Undo::EDIT);
466 mathcursor->getPos(x, y);
468 mathcursor->setPos(x, y);
469 mathcursor->normalize();
470 updateLocal(bv, true);
474 case LFUN_MATH_EXTERN:
476 bv->lockedInsetStoreUndo(Undo::EDIT);
478 // re-compute inset dimension
480 updateLocal(bv, true);
484 case LFUN_MATH_DISPLAY:
488 mathcursor->getPos(x, y);
489 if (hull()->getType() == LM_OT_SIMPLE)
490 hull()->mutate(LM_OT_EQUATION);
492 hull()->mutate(LM_OT_SIMPLE);
493 mathcursor->setPos(x, y);
494 mathcursor->normalize();
495 updateLocal(bv, true);
499 case LFUN_PASTESELECTION:
501 string const clip = bv->getClipboard();
503 mathed_parse_normal(par_, clip);
508 result = InsetFormulaBase::localDispatch(bv, action, arg);
515 bool needEqnArray(string const & extra)
517 return extra == "dsolve";
521 void InsetFormula::handleExtern(const string & arg)
529 istringstream iss(arg.c_str());
530 iss >> lang >> extra;
534 bool selected = mathcursor->selection();
537 if (needEqnArray(extra)) {
539 //mathcursor->readLine(ar);
540 mathcursor->breakLine();
541 } else if (selected) {
542 mathcursor->selGet(ar);
543 //lyxerr << "use selection: " << ar << "\n";
546 mathcursor->stripFromLastEqualSign();
547 ar = mathcursor->cursor().cell();
548 mathcursor->insert(MathAtom(new MathCharInset('=', LM_TC_VAR)));
549 //lyxerr << "use whole cell: " << ar << "\n";
552 mathcursor->insert(pipeThroughExtern(lang, extra, ar));
556 bool InsetFormula::display() const
558 return hull()->getType() != LM_OT_SIMPLE;
562 MathHullInset const * InsetFormula::hull() const
564 lyx::Assert(par_->asHullInset());
565 return par_->asHullInset();
569 MathHullInset * InsetFormula::hull()
571 lyx::Assert(par_->asHullInset());
572 return par_->asHullInset();
576 Inset::Code InsetFormula::lyxCode() const
578 return Inset::MATH_CODE;
582 void InsetFormula::validate(LaTeXFeatures & features) const
584 par_->validate(features);
588 bool InsetFormula::insetAllowed(Inset::Code code) const
591 (code == Inset::LABEL_CODE && display())
592 || code == Inset::ERT_CODE;
596 int InsetFormula::ascent(BufferView *, LyXFont const &) const
598 return par_->ascent() + 1;
602 int InsetFormula::descent(BufferView *, LyXFont const &) const
604 return par_->descent() + 1;
608 int InsetFormula::width(BufferView * bv, LyXFont const & font) const
611 return par_->width();
615 MathInsetTypes InsetFormula::getType() const
617 return hull()->getType();