src/mathed/formula.C

   1 /*
   2 *  File:        formula.C
   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.
   7 *
   8 *  Copyright: 1996-1998 Alejandro Aguilar Sierra
   9 *
  10 *  Version: 0.4, Lyx project.
  11 *
  12 *   You are free to use and modify this code under the terms of
  13 *   the GNU General Public Licence version 2 or later.
  14 */
  15
  16 #ifdef __GNUG__
  17 #pragma implementation
  18 #endif
  19
  20 #include <config.h>
  21
  22 #include "formula.h"
  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"
  29 #include "lyx_main.h"
  30 #include "BufferView.h"
  31 #include "gettext.h"
  32 #include "debug.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
  38 #include "LyXView.h"
  39 #include "Painter.h"
  40 #include "lyxrc.h"
  41 #include "math_hullinset.h"
  42 #include "math_support.h"
  43 #include "math_mathmlstream.h"
  44 #include "textpainter.h"
  45
  46 using std::ostream;
  47 using std::ifstream;
  48 using std::istream;
  49 using std::pair;
  50 using std::endl;
  51 using std::vector;
  52 using std::getline;
  53
  54
  55 namespace {
  56
  57         string captureOutput(string const & cmd, string const & data)
  58         {
  59                 string outfile = lyx::tempName(string(), "mathextern");
  60                 string full =  "echo '" + data + "' | (" + cmd + ") > " + outfile;
  61                 lyxerr << "calling: " << full << "\n";
  62                 Systemcall dummy;
  63                 dummy.startscript(Systemcall::Wait, full);
  64                 string out = GetFileContents(outfile);
  65                 lyx::unlink(outfile);
  66                 lyxerr << "result: '" << out << "'\n";
  67                 return out;
  68         }
  69
  70
  71         MathArray pipeThroughMaple(string const & extra, MathArray const & ar)
  72         {
  73                 string header = "readlib(latex):\n";
  74
  75                 // remove the \\it for variable names
  76                 //"#`latex/csname_font` := `\\it `:"
  77                 header +=
  78                         "`latex/csname_font` := ``:\n";
  79
  80                 // export matrices in (...) instead of [...]
  81                 header +=
  82                         "`latex/latex/matrix` := "
  83                                 "subs(`[`=`(`, `]`=`)`,"
  84                                         "eval(`latex/latex/matrix`)):\n";
  85
  86                 // replace \\cdots with proper '*'
  87                 header +=
  88                         "`latex/latex/*` := "
  89                                 "subs(`\\,`=`\\cdot `,"
  90                                         "eval(`latex/latex/*`)):\n";
  91
  92                 // remove spurious \\noalign{\\medskip} in matrix output
  93                 header +=
  94                         "`latex/latex/matrix`:= "
  95                                 "subs(`\\\\\\\\\\\\noalign{\\\\medskip}` = `\\\\\\\\`,"
  96                                         "eval(`latex/latex/matrix`)):\n";
  97
  98                 //"#`latex/latex/symbol` "
  99                 //      " := subs((\\'_\\' = \\'`\\_`\\',eval(`latex/latex/symbol`)): ";
 100
 101                 string trailer = "quit;";
 102                 ostringstream os;
 103                 MapleStream ms(os);
 104                 ms << ar;
 105                 string expr = os.str().c_str();
 106
 107                 for (int i = 0; i < 100; ++i) { // at most 100 attempts
 108                         // try to fix missing '*' the hard way by using mint
 109                         //
 110                         // ... > echo "1A;" | mint -i 1 -S -s -q
 111                         // on line     1: 1A;
 112                         //                 ^ syntax error -
 113                         //                   Probably missing an operator such as * p
 114                         //
 115                         lyxerr << "checking expr: '" << expr << "'\n";
 116                         string out = captureOutput("mint -i 1 -S -s -q -q", expr + ";");
 117                         if (out.empty())
 118                                 break; // expression syntax is ok
 119                         istringstream is(out.c_str());
 120                         string line;
 121                         getline(is, line);
 122                         if (line.find("on line") != 0)
 123                                 break; // error message not identified
 124                         getline(is, line);
 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,  "*");
 132                 }
 133
 134                 string full = "latex(" +  extra + '(' + expr + "));";
 135                 string out = captureOutput("maple -q", header + full + trailer);
 136
 137                 // change \_ into _
 138
 139                 //
 140                 MathArray res;
 141                 mathed_parse_cell(res, out);
 142                 return res;
 143         }
 144
 145
 146         MathArray pipeThroughOctave(string const &, MathArray const & ar)
 147         {
 148                 ostringstream os;
 149                 OctaveStream vs(os);
 150                 vs << ar;
 151                 string expr = os.str().c_str();
 152                 string out;
 153
 154                 for (int i = 0; i < 100; ++i) { // at most 100 attempts
 155                         //
 156                         // try to fix missing '*' the hard way
 157                         // parse error:
 158                         // >>> ([[1 2 3 ];[2 3 1 ];[3 1 2 ]])([[1 2 3 ];[2 3 1 ];[3 1 2 ]])
 159                         //                                   ^
 160                         //
 161                         lyxerr << "checking expr: '" << expr << "'\n";
 162                         out = captureOutput("octave -q 2>&1", expr);
 163                         lyxerr << "checking out: '" << out << "'\n";
 164
 165                         // leave loop if expression syntax is probably ok
 166                         if (out.find("parse error:") == string::npos)
 167                                 break;
 168
 169                         // search line with single caret
 170                         istringstream is(out.c_str());
 171                         string line;
 172                         while (is) {
 173                                 getline(is, line);
 174                                 lyxerr << "skipping line: '" << line << "'\n";
 175                                 if (line.find(">>> ") != string::npos)
 176                                         break;
 177                         }
 178
 179                         // found line with error, next line is the one with caret
 180                         getline(is, line);
 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,  "*");
 190                 }
 191
 192                 if (out.size() < 6)
 193                         return MathArray();
 194
 195                 // remove 'ans = '
 196                 out = out.substr(6);
 197
 198                 // parse output as matrix or single number
 199                 MathAtom at(new MathArrayInset("array", out));
 200                 MathArrayInset const * mat = at.nucleus()->asArrayInset();
 201                 MathArray res;
 202                 if (mat->ncols() == 1 && mat->nrows() == 1)
 203                         res.push_back(mat->cell(0));
 204                 else {
 205                         res.push_back(MathAtom(new MathDelimInset("(", ")")));
 206                         res.back()->cell(0).push_back(at);
 207                 }
 208                 return res;
 209         }
 210
 211
 212         MathArray pipeThroughExtern(string const & lang, string const & extra,
 213                 MathArray const & ar)
 214         {
 215                 if (lang == "octave")
 216                         return pipeThroughOctave(extra, ar);
 217
 218                 if (lang == "maple")
 219                         return pipeThroughMaple(extra, ar);
 220
 221                 // create normalized expression
 222                 ostringstream os;
 223                 NormalStream ns(os);
 224                 os << "[" << extra << ' ';
 225                 ns << ar;
 226                 os << "]";
 227                 string data = os.str().c_str();
 228
 229                 // search external script
 230                 string file = LibFileSearch("mathed", "extern_" + lang);
 231                 if (file.empty()) {
 232                         lyxerr << "converter to '" << lang << "' not found\n";
 233                         return MathArray();
 234                 }
 235
 236                 // run external sript
 237                 string out = captureOutput(file, data);
 238                 MathArray res;
 239                 mathed_parse_cell(res, out);
 240                 return res;
 241         }
 242
 243 }
 244
 245
 246 InsetFormula::InsetFormula()
 247         : par_(MathAtom(new MathHullInset))
 248 {}
 249
 250
 251 InsetFormula::InsetFormula(MathInsetTypes t)
 252         : par_(MathAtom(new MathHullInset(t)))
 253 {}
 254
 255
 256 InsetFormula::InsetFormula(string const & s)
 257 {
 258         if (s.size()) {
 259                 bool res = mathed_parse_normal(par_, s);
 260
 261                 if (!res)
 262                         res = mathed_parse_normal(par_, "$" + s + "$");
 263
 264                 if (!res) {
 265                         lyxerr << "cannot interpret '" << s << "' as math\n";
 266                         par_ = MathAtom(new MathHullInset(LM_OT_SIMPLE));
 267                 }
 268         }
 269         metrics();
 270 }
 271
 272
 273 Inset * InsetFormula::clone(Buffer const &, bool) const
 274 {
 275         return new InsetFormula(*this);
 276 }
 277
 278
 279 void InsetFormula::write(Buffer const *, ostream & os) const
 280 {
 281         os << "Formula ";
 282         WriteStream wi(os, false, false);
 283         par_->write(wi);
 284 }
 285
 286
 287 int InsetFormula::latex(Buffer const *, ostream & os, bool fragile, bool) const
 288 {
 289         WriteStream wi(os, fragile, true);
 290         par_->write(wi);
 291         return wi.line();
 292 }
 293
 294
 295 int InsetFormula::ascii(Buffer const *, ostream & os, int) const
 296 {
 297 #if 0
 298         TextMetricsInfo mi;
 299         par()->metricsT(mi);
 300         TextPainter tpain(par()->width(), par()->height());
 301         par()->drawT(tpain, 0, par()->ascent());
 302         tpain.show(os);
 303         // reset metrics cache to "real" values
 304         metrics();
 305         return tpain.textheight();
 306 #else
 307         WriteStream wi(os, false, true);
 308         par_->write(wi);
 309         return wi.line();
 310 #endif
 311 }
 312
 313
 314 int InsetFormula::linuxdoc(Buffer const * buf, ostream & os) const
 315 {
 316         return docbook(buf, os);
 317 }
 318
 319
 320 int InsetFormula::docbook(Buffer const * buf, ostream & os) const
 321 {
 322         MathMLStream ms(os);
 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;
 329 }
 330
 331
 332 void InsetFormula::read(Buffer const *, LyXLex & lex)
 333 {
 334         mathed_parse_normal(par_, lex);
 335         metrics();
 336 }
 337
 338
 339 //ostream & operator<<(ostream & os, LyXCursor const & c)
 340 //{
 341 //      os << '[' << c.x() << ' ' << c.y() << ' ' << c.pos() << ']';
 342 //      return os;
 343 //}
 344
 345
 346 void InsetFormula::draw(BufferView * bv, LyXFont const & font,
 347                         int y, float & xx, bool) const
 348 {
 349         metrics(bv, font);
 350
 351         int x = int(xx);
 352         int w = par_->width();
 353         int h = par_->height();
 354         int a = par_->ascent();
 355         Painter & pain = bv->painter();
 356
 357         if (lcolor.getX11Name(LColor::mathbg)!=lcolor.getX11Name(LColor::background))
 358                 pain.fillRectangle(x, y - a, w, h, LColor::mathbg);
 359
 360         if (mathcursor &&
 361                         const_cast<InsetFormulaBase const *>(mathcursor->formula()) == this)
 362         {
 363                 mathcursor->drawSelection(pain);
 364                 pain.rectangle(x, y - a, w, h, LColor::mathframe);
 365         }
 366
 367         par_->draw(pain, x, y);
 368         xx += par_->width();
 369         xo_ = x;
 370         yo_ = y;
 371
 372         setCursorVisible(false);
 373 }
 374
 375
 376 vector<string> const InsetFormula::getLabelList() const
 377 {
 378         return hull()->getLabelList();
 379 }
 380
 381
 382 UpdatableInset::RESULT
 383 InsetFormula::localDispatch(BufferView * bv, kb_action action,
 384          string const & arg)
 385 {
 386         RESULT result = DISPATCHED;
 387
 388         switch (action) {
 389
 390                 case LFUN_BREAKLINE:
 391                         bv->lockedInsetStoreUndo(Undo::INSERT);
 392                         mathcursor->breakLine();
 393                         mathcursor->normalize();
 394                         updateLocal(bv, true);
 395                         break;
 396
 397                 case LFUN_MATH_NUMBER:
 398                 {
 399                         //lyxerr << "toggling all numbers\n";
 400                         if (display()) {
 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);
 407                         }
 408                         break;
 409                 }
 410
 411                 case LFUN_MATH_NONUMBER:
 412                 {
 413                         //lyxerr << "toggling line number\n";
 414                         if (display()) {
 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);
 421                         }
 422                         break;
 423                 }
 424
 425                 case LFUN_INSERT_LABEL:
 426                 {
 427                         bv->lockedInsetStoreUndo(Undo::INSERT);
 428
 429                         MathCursor::row_type row = mathcursor->hullRow();
 430                         string old_label = hull()->label(row);
 431                         string new_label = arg;
 432
 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);
 439                                 if (!res.first)
 440                                         break;
 441                                 new_label = frontStrip(strip(res.second));
 442                         }
 443
 444                         //if (new_label == old_label)
 445                         //      break;  // Nothing to do
 446
 447                         if (!new_label.empty()) {
 448                                 lyxerr << "setting label to '" << new_label << "'\n";
 449                                 hull()->numbered(row, true);
 450                         }
 451
 452                         if (!new_label.empty() && bv->ChangeRefsIfUnique(old_label, new_label))
 453                                 bv->redraw();
 454
 455                         hull()->label(row, new_label);
 456
 457                         updateLocal(bv, true);
 458                         break;
 459                 }
 460
 461                 case LFUN_MATH_MUTATE:
 462                 {
 463                         bv->lockedInsetStoreUndo(Undo::EDIT);
 464                         int x;
 465                         int y;
 466                         mathcursor->getPos(x, y);
 467                         hull()->mutate(arg);
 468                         mathcursor->setPos(x, y);
 469                         mathcursor->normalize();
 470                         updateLocal(bv, true);
 471                         break;
 472                 }
 473
 474                 case LFUN_MATH_EXTERN:
 475                 {
 476                         bv->lockedInsetStoreUndo(Undo::EDIT);
 477                         handleExtern(arg);
 478                         // re-compute inset dimension
 479                         metrics(bv);
 480                         updateLocal(bv, true);
 481                         break;
 482                 }
 483
 484                 case LFUN_MATH_DISPLAY:
 485                 {
 486                         int x = 0;
 487                         int y = 0;
 488                         mathcursor->getPos(x, y);
 489                         if (hull()->getType() == LM_OT_SIMPLE)
 490                                 hull()->mutate(LM_OT_EQUATION);
 491                         else
 492                                 hull()->mutate(LM_OT_SIMPLE);
 493                         mathcursor->setPos(x, y);
 494                         mathcursor->normalize();
 495                         updateLocal(bv, true);
 496                         break;
 497                 }
 498
 499                 case LFUN_PASTESELECTION:
 500                 {
 501                         string const clip = bv->getClipboard();
 502                 if (!clip.empty())
 503                                 mathed_parse_normal(par_, clip);
 504                         break;
 505                 }
 506
 507                 default:
 508                         result = InsetFormulaBase::localDispatch(bv, action, arg);
 509         }
 510
 511         return result;
 512 }
 513
 514
 515 bool needEqnArray(string const & extra)
 516 {
 517         return extra == "dsolve";
 518 }
 519
 520
 521 void InsetFormula::handleExtern(const string & arg)
 522 {
 523         // where are we?
 524         if (!mathcursor)
 525                 return;
 526
 527         string lang;
 528         string extra;
 529         istringstream iss(arg.c_str());
 530         iss >> lang >> extra;
 531         if (extra.empty())
 532                 extra = "noextra";
 533
 534         bool selected = mathcursor->selection();
 535
 536         MathArray ar;
 537         if (needEqnArray(extra)) {
 538                 mathcursor->last();
 539                 //mathcursor->readLine(ar);
 540                 mathcursor->breakLine();
 541         } else if (selected) {
 542                 mathcursor->selGet(ar);
 543                 //lyxerr << "use selection: " << ar << "\n";
 544         } else {
 545                 mathcursor->last();
 546                 mathcursor->stripFromLastEqualSign();
 547                 ar = mathcursor->cursor().cell();
 548                 mathcursor->insert(MathAtom(new MathCharInset('=', LM_TC_VAR)));
 549                 //lyxerr << "use whole cell: " << ar << "\n";
 550         }
 551
 552         mathcursor->insert(pipeThroughExtern(lang, extra, ar));
 553 }
 554
 555
 556 bool InsetFormula::display() const
 557 {
 558         return hull()->getType() != LM_OT_SIMPLE;
 559 }
 560
 561
 562 MathHullInset const * InsetFormula::hull() const
 563 {
 564         lyx::Assert(par_->asHullInset());
 565         return par_->asHullInset();
 566 }
 567
 568
 569 MathHullInset * InsetFormula::hull()
 570 {
 571         lyx::Assert(par_->asHullInset());
 572         return par_->asHullInset();
 573 }
 574
 575
 576 Inset::Code InsetFormula::lyxCode() const
 577 {
 578         return Inset::MATH_CODE;
 579 }
 580
 581
 582 void InsetFormula::validate(LaTeXFeatures & features) const
 583 {
 584         par_->validate(features);
 585 }
 586
 587
 588 bool InsetFormula::insetAllowed(Inset::Code code) const
 589 {
 590         return
 591                 (code == Inset::LABEL_CODE && display())
 592                 || code == Inset::ERT_CODE;
 593 }
 594
 595
 596 int InsetFormula::ascent(BufferView *, LyXFont const &) const
 597 {
 598         return par_->ascent() + 1;
 599 }
 600
 601
 602 int InsetFormula::descent(BufferView *, LyXFont const &) const
 603 {
 604         return par_->descent() + 1;
 605 }
 606
 607
 608 int InsetFormula::width(BufferView * bv, LyXFont const & font) const
 609 {
 610         metrics(bv, font);
 611         return par_->width();
 612 }
 613
 614
 615 MathInsetTypes InsetFormula::getType() const
 616 {
 617         return hull()->getType();
 618 }