]> git.lyx.org Git - lyx.git/blobdiff - src/mathed/formula.C
rename commandtags.h to lfuns.h and renumber/cleanup. Rebuild the tree !
[lyx.git] / src / mathed / formula.C
index fc759f77446e45bf82129a0703c30767ed2d166a..15d10238f51d9c0bd9e7a831979806ac2bc973e9 100644 (file)
 *   the GNU General Public Licence version 2 or later.
 */
 
-#ifdef __GNUG__
-#pragma implementation
-#endif
 
 #include <config.h>
 
 #include "formula.h"
-#include "commandtags.h"
 #include "math_cursor.h"
 #include "math_parser.h"
 #include "math_charinset.h"
 #include "math_arrayinset.h"
+#include "math_metricsinfo.h"
 #include "math_deliminset.h"
-#include "lyx_main.h"
+#include "math_hullinset.h"
+#include "math_support.h"
+#include "math_mathmlstream.h"
+#include "textpainter.h"
+
 #include "BufferView.h"
 #include "gettext.h"
 #include "debug.h"
-#include "frontends/Alert.h"
+#include "lyxrc.h"
+#include "funcrequest.h"
+
 #include "support/LOstream.h"
 #include "support/LAssert.h"
 #include "support/lyxlib.h"
 #include "support/systemcall.h"
-#include "support/lstrings.h"
-#include "support/filetools.h" // LibFileSearch
-#include "LyXView.h"
-#include "Painter.h"
-#include "lyxrc.h"
-#include "math_hullinset.h"
-#include "math_support.h"
-#include "math_mathmlstream.h"
+#include "support/filetools.h"
+
+#include "frontends/Alert.h"
+#include "frontends/LyXView.h"
+#include "frontends/Painter.h"
+
+#include "graphics/PreviewedInset.h"
+#include "graphics/PreviewImage.h"
+
+#include <fstream>
+
 
 using std::ostream;
 using std::ifstream;
@@ -53,240 +59,79 @@ using std::vector;
 using std::getline;
 
 
-namespace {
-
-       string captureOutput(string const & cmd, string const & data)
-       {
-               string outfile = lyx::tempName(string(), "mathextern");
-               string full =  "echo '" + data + "' | (" + cmd + ") > " + outfile;
-               lyxerr << "calling: " << full << "\n";
-               Systemcall dummy;
-               dummy.startscript(Systemcall::Wait, full);
-               string out = GetFileContents(outfile);
-               lyx::unlink(outfile);
-               lyxerr << "result: '" << out << "'\n";
-               return out;
-       }
-
-
-       MathArray pipeThroughMaple(string const & extra, MathArray const & ar)
-       {
-               string header = "readlib(latex):\n";
-
-               // remove the \\it for variable names
-               //"#`latex/csname_font` := `\\it `:"
-               header +=
-                       "`latex/csname_font` := ``:\n";
-
-               // export matrices in (...) instead of [...]
-               header +=
-                       "`latex/latex/matrix` := "
-                               "subs(`[`=`(`, `]`=`)`,"
-                                       "eval(`latex/latex/matrix`)):\n";
-
-               // replace \\cdots with proper '*'
-               header +=
-                       "`latex/latex/*` := "
-                               "subs(`\\,`=`\\cdot `,"
-                                       "eval(`latex/latex/*`)):\n";
-
-               // remove spurious \\noalign{\\medskip} in matrix output
-               header += 
-                       "`latex/latex/matrix`:= "
-                               "subs(`\\\\\\\\\\\\noalign{\\\\medskip}` = `\\\\\\\\`,"
-                                       "eval(`latex/latex/matrix`)):\n";
-
-               //"#`latex/latex/symbol` "
-               //      " := subs((\\'_\\' = \\'`\\_`\\',eval(`latex/latex/symbol`)): ";
-
-               string trailer = "quit;";
-               ostringstream os;
-               MapleStream ms(os);
-               ms << ar;
-               string expr = os.str().c_str();
-
-               for (int i = 0; i < 100; ++i) { // at most 100 attempts
-                       // try to fix missing '*' the hard way by using mint
-                       //
-                       // ... > echo "1A;" | mint -i 1 -S -s -q
-                       // on line     1: 1A;
-                       //                 ^ syntax error - 
-                       //                   Probably missing an operator such as * p
-                       //
-                       lyxerr << "checking expr: '" << expr << "'\n";
-                       string out = captureOutput("mint -i 1 -S -s -q -q", expr + ";");
-                       if (out.empty())
-                               break; // expression syntax is ok
-                       istringstream is(out.c_str());
-                       string line;
-                       getline(is, line);
-                       if (line.find("on line") != 0)
-                               break; // error message not identified
-                       getline(is, line);
-                       string::size_type pos = line.find('^');
-                       if (pos == string::npos || pos < 15)
-                               break; // caret position not found
-                       pos -= 15; // skip the "on line ..." part
-                       if (expr[pos] == '*' || (pos > 0 && expr[pos - 1] == '*'))
-                               break; // two '*' in a row are definitely bad
-                       expr.insert(pos,  "*");
-               }
-
-               string full = "latex(" +  extra + '(' + expr + "));";
-               string out = captureOutput("maple -q", header + full + trailer);
-
-               // change \_ into _
-
-               //
-               MathArray res;
-               mathed_parse_cell(res, out);
-               return res;
-       }
-               
-       
-       MathArray pipeThroughOctave(string const &, MathArray const & ar)
-       {
-               ostringstream os;
-               OctaveStream vs(os);
-               vs << ar;
-               string expr = os.str().c_str();
-               string out;
-
-               for (int i = 0; i < 100; ++i) { // at most 100 attempts
-                       //
-                       // try to fix missing '*' the hard way 
-                       // parse error:
-                       // >>> ([[1 2 3 ];[2 3 1 ];[3 1 2 ]])([[1 2 3 ];[2 3 1 ];[3 1 2 ]])
-                       //                                   ^
-                       //
-                       lyxerr << "checking expr: '" << expr << "'\n";
-                       out = captureOutput("octave -q 2>&1", expr);
-                       lyxerr << "checking out: '" << out << "'\n";
-
-                       // leave loop if expression syntax is probably ok
-                       if (out.find("parse error:") == string::npos)
-                               break;
-
-                       // search line with single caret
-                       istringstream is(out.c_str());
-                       string line;
-                       while (is) {
-                               getline(is, line);
-                               lyxerr << "skipping line: '" << line << "'\n";
-                               if (line.find(">>> ") != string::npos)
-                                       break;
-                       }
-
-                       // found line with error, next line is the one with caret
-                       getline(is, line);
-                       string::size_type pos = line.find('^');
-                       lyxerr << "caret line: '" << line << "'\n";
-                       lyxerr << "found caret at pos: '" << pos << "'\n";
-                       if (pos == string::npos || pos < 4)
-                               break; // caret position not found
-                       pos -= 4; // skip the ">>> " part
-                       if (expr[pos] == '*')
-                               break; // two '*' in a row are definitely bad
-                       expr.insert(pos,  "*");
-               }
-
-               if (out.size() < 6)
-                       return MathArray();
-
-               // remove 'ans = '
-               out = out.substr(6);
-
-               // parse output as matrix or single number
-               MathAtom at(new MathArrayInset("array", out));
-               MathArrayInset const * mat = at.nucleus()->asArrayInset();
-               MathArray res;
-               if (mat->ncols() == 1 && mat->nrows() == 1)
-                       res.push_back(mat->cell(0));
-               else {
-                       res.push_back(MathAtom(new MathDelimInset("(", ")")));
-                       res.back()->cell(0).push_back(at);
-               }
-               return res;
-       }
-
+class InsetFormula::PreviewImpl : public grfx::PreviewedInset {
+public:
+       ///
+       PreviewImpl(InsetFormula & p) : PreviewedInset(p) {}
 
-       MathArray pipeThroughExtern(string const & lang, string const & extra,
-               MathArray const & ar)
+private:
+       ///
+       bool previewWanted() const;
+       ///
+       string const latexString() const;
+       ///
+       InsetFormula & parent() const
        {
-               if (lang == "octave")
-                       return pipeThroughOctave(extra, ar);
-
-               if (lang == "maple")
-                       return pipeThroughMaple(extra, ar);
-
-               // create normalized expression
-               ostringstream os;
-               NormalStream ns(os);
-               os << "[" << extra << ' ';
-               ns << ar;
-               os << "]";
-               string data = os.str().c_str();
-
-               // search external script
-               string file = LibFileSearch("mathed", "extern_" + lang);
-               if (file.empty()) {
-                       lyxerr << "converter to '" << lang << "' not found\n";
-                       return MathArray();
-               }
-               
-               // run external sript
-               string out = captureOutput(file, data);
-               MathArray res;
-               mathed_parse_cell(res, out);
-               return res;
+               return *static_cast<InsetFormula*>(inset());
        }
+};
 
-}
 
 
 InsetFormula::InsetFormula()
-       : par_(MathAtom(new MathHullInset))
+       : par_(MathAtom(new MathHullInset)),
+         preview_(new PreviewImpl(*this))
 {}
 
 
-InsetFormula::InsetFormula(MathInsetTypes t)
-       : par_(MathAtom(new MathHullInset(t)))
+InsetFormula::InsetFormula(InsetFormula const & other)
+       : InsetFormulaBase(other),
+         par_(other.par_),
+         preview_(new PreviewImpl(*this))
 {}
 
 
-InsetFormula::InsetFormula(string const & s) 
+InsetFormula::InsetFormula(BufferView * bv)
+       : par_(MathAtom(new MathHullInset)),
+         preview_(new PreviewImpl(*this))
 {
-       if (s.size()) {
-               bool res = mathed_parse_normal(par_, s);
+       view_ = bv->owner()->view();
+}
 
-               if (!res)
-                       res = mathed_parse_normal(par_, "$" + s + "$");
 
-               if (!res) {
-                       lyxerr << "cannot interpret '" << s << "' as math\n";
-                       par_ = MathAtom(new MathHullInset(LM_OT_SIMPLE));
-               }
-       }
-       metrics();
+InsetFormula::InsetFormula(string const & data)
+       : par_(MathAtom(new MathHullInset)),
+         preview_(new PreviewImpl(*this))
+{
+       if (!data.size())
+               return;
+       if (!mathed_parse_normal(par_, data))
+               lyxerr << "cannot interpret '" << data << "' as math\n";
 }
 
 
+
+InsetFormula::~InsetFormula()
+{}
+
+
 Inset * InsetFormula::clone(Buffer const &, bool) const
 {
        return new InsetFormula(*this);
 }
 
 
-void InsetFormula::write(Buffer const * buf, ostream & os) const
+void InsetFormula::write(Buffer const *, ostream & os) const
 {
-       os << "Formula ";
-       latex(buf, os, false, false);
+       WriteStream wi(os, false, false);
+       os << par_->fileInsetLabel() << ' ';
+       par_->write(wi);
 }
 
 
-int InsetFormula::latex(Buffer const *, ostream & os, bool fragil, bool) const
+int InsetFormula::latex(Buffer const *, ostream & os, bool fragile, bool) const
 {
-       WriteStream wi(os, fragil);
+       WriteStream wi(os, fragile, true);
        par_->write(wi);
        return wi.line();
 }
@@ -294,26 +139,42 @@ int InsetFormula::latex(Buffer const *, ostream & os, bool fragil, bool) const
 
 int InsetFormula::ascii(Buffer const *, ostream & os, int) const
 {
-       WriteStream wi(os, false);
-       par_->write(wi);
-       return wi.line();
+       if (0 && display()) {
+               TextMetricsInfo mi;
+               par()->metricsT(mi);
+               TextPainter tpain(par()->width(), par()->height());
+               par()->drawT(tpain, 0, par()->ascent());
+               tpain.show(os, 3);
+               // reset metrics cache to "real" values
+               metrics();
+               return tpain.textheight();
+       } else {
+               WriteStream wi(os, false, true);
+               wi << ' ' << (par_->asNestInset()->cell(0)) << ' ';
+               return wi.line();
+       }
 }
 
 
 int InsetFormula::linuxdoc(Buffer const * buf, ostream & os) const
 {
-       return docbook(buf, os);
+       return docbook(buf, os, false);
 }
 
 
-int InsetFormula::docbook(Buffer const * buf, ostream & os) const
+int InsetFormula::docbook(Buffer const * buf, ostream & os, bool) const
 {
        MathMLStream ms(os);
-       ms << MTag("equation") << MTag("alt");
+       ms << MTag("equation");
+       ms <<   MTag("alt");
+       ms <<    "<[CDATA[";
        int res = ascii(buf, ms.os(), 0);
-       ms << ETag("alt") << MTag("math");
-       ms << par_.nucleus();
-       ms << ETag("math") << ETag("equation");
+       ms <<    "]]>";
+       ms <<   ETag("alt");
+       ms <<   MTag("math");
+       ms <<    par_;
+       ms <<   ETag("math");
+       ms << ETag("equation");
        return ms.line() + res;
 }
 
@@ -333,28 +194,43 @@ void InsetFormula::read(Buffer const *, LyXLex & lex)
 
 
 void InsetFormula::draw(BufferView * bv, LyXFont const & font,
-                       int y, float & xx, bool) const
+                       int y, float & xx) const
 {
-       metrics(bv, font);
-
-       int x = int(xx);
-       int w = par_->width();
-       int h = par_->height();
-       int a = par_->ascent();
-       Painter & pain = bv->painter();
-
-       if (lcolor.getX11Name(LColor::mathbg)!=lcolor.getX11Name(LColor::background))
-               pain.fillRectangle(x, y - a, w, h, LColor::mathbg);
+       cache(bv);
+       // This initiates the loading of the preview, so should come
+       // before the metrics are computed.
+       bool const use_preview = preview_->previewReady();
+
+       int const x = int(xx);
+       int const w = width(bv, font);
+       int const d = descent(bv, font);
+       int const a = ascent(bv, font);
+       int const h = a + d;
+
+       MathPainterInfo pi(bv->painter());
+
+       if (use_preview) {
+               pi.pain.image(x + 1, y - a, w, h,   // one pixel gap in front
+                             *(preview_->pimage()->image()));
+       } else {
+               pi.base.style = LM_ST_TEXT;
+               pi.base.font  = font;
+               pi.base.font.setColor(LColor::math);
+               if (lcolor.getX11Name(LColor::mathbg)
+                           != lcolor.getX11Name(LColor::background))
+                       pi.pain.fillRectangle(x, y - a, w, h, LColor::mathbg);
+
+               if (mathcursor &&
+                               const_cast<InsetFormulaBase const *>(mathcursor->formula()) == this)
+               {
+                       mathcursor->drawSelection(pi);
+                       //pi.pain.rectangle(x, y - a, w, h, LColor::mathframe);
+               }
 
-       if (mathcursor &&
-                       const_cast<InsetFormulaBase const *>(mathcursor->formula()) == this)
-       {
-               mathcursor->drawSelection(pain);
-               pain.rectangle(x, y - a, w, h, LColor::mathframe);
+               par_->draw(pi, x, y);
        }
 
-       par_->draw(pain, x, y);
-       xx += par_->width();
+       xx += w;
        xo_ = x;
        yo_ = y;
 
@@ -364,244 +240,94 @@ void InsetFormula::draw(BufferView * bv, LyXFont const & font,
 
 vector<string> const InsetFormula::getLabelList() const
 {
-       return hull()->getLabelList();
+       vector<string> res;
+       par()->getLabelList(res);
+       return res;
 }
 
 
-UpdatableInset::RESULT
-InsetFormula::localDispatch(BufferView * bv, kb_action action,
-        string const & arg)
+Inset::Code InsetFormula::lyxCode() const
 {
-       RESULT result = DISPATCHED;
-
-       switch (action) {
-
-               case LFUN_BREAKLINE: 
-                       bv->lockedInsetStoreUndo(Undo::INSERT);
-                       mathcursor->breakLine();
-                       mathcursor->normalize();
-                       updateLocal(bv, true);
-                       break;
-
-               case LFUN_MATH_NUMBER:
-               {
-                       //lyxerr << "toggling all numbers\n";
-                       if (display()) {
-                               bv->lockedInsetStoreUndo(Undo::INSERT);
-                               bool old = hull()->numberedType();
-                               for (MathInset::row_type row = 0; row < par_->nrows(); ++row)
-                                       hull()->numbered(row, !old);
-                               bv->owner()->message(old ? _("No number") : _("Number"));
-                               updateLocal(bv, true);
-                       }
-                       break;
-               }
-
-               case LFUN_MATH_NONUMBER:
-               {
-                       //lyxerr << "toggling line number\n";
-                       if (display()) {
-                               bv->lockedInsetStoreUndo(Undo::INSERT);
-                               MathCursor::row_type row = mathcursor->hullRow();
-                               bool old = hull()->numbered(row);
-                               bv->owner()->message(old ? _("No number") : _("Number"));
-                               hull()->numbered(row, !old);
-                               updateLocal(bv, true);
-                       }
-                       break;
-               }
-
-               case LFUN_INSERT_LABEL:
-               {
-                       bv->lockedInsetStoreUndo(Undo::INSERT);
-
-                       MathCursor::row_type row = mathcursor->hullRow();
-                       string old_label = hull()->label(row);
-                       string new_label = arg;
-
-                       if (new_label.empty()) {
-                               string const default_label =
-                                       (lyxrc.label_init_length >= 0) ? "eq:" : "";
-                               pair<bool, string> const res = old_label.empty()
-                                       ? Alert::askForText(_("Enter new label to insert:"), default_label)
-                                       : Alert::askForText(_("Enter label:"), old_label);
-                               if (!res.first)
-                                       break;
-                               new_label = frontStrip(strip(res.second));
-                       }
-
-                       //if (new_label == old_label)
-                       //      break;  // Nothing to do
-
-                       if (!new_label.empty()) {
-                               lyxerr << "setting label to '" << new_label << "'\n";
-                               hull()->numbered(row, true);
-                       }
-
-                       if (!new_label.empty() && bv->ChangeRefsIfUnique(old_label, new_label))
-                               bv->redraw();
-
-                       hull()->label(row, new_label);
-
-                       updateLocal(bv, true);
-                       break;
-               }
-
-               case LFUN_MATH_MUTATE:
-               {
-                       bv->lockedInsetStoreUndo(Undo::EDIT);
-                       int x;
-                       int y;
-                       mathcursor->getPos(x, y);
-                       hull()->mutate(arg);
-                       mathcursor->setPos(x, y);
-                       mathcursor->normalize();
-                       updateLocal(bv, true);
-                       break;
-               }
-
-               case LFUN_MATH_EXTERN:
-               {
-                       bv->lockedInsetStoreUndo(Undo::EDIT);
-                       handleExtern(arg);
-                       // re-compute inset dimension
-                       metrics(bv);
-                       updateLocal(bv, true);
-                       break;
-               }
-
-               case LFUN_MATH_DISPLAY:
-               {
-                       int x = 0;
-                       int y = 0;
-                       mathcursor->getPos(x, y);
-                       if (hull()->getType() == LM_OT_SIMPLE)
-                               hull()->mutate(LM_OT_EQUATION);
-                       else
-                               hull()->mutate(LM_OT_SIMPLE);
-                       mathcursor->setPos(x, y);
-                       mathcursor->normalize();
-                       updateLocal(bv, true);
-                       break;
-               }
-               
-               case LFUN_PASTESELECTION:
-               {
-                       string const clip = bv->getClipboard();
-               if (!clip.empty())
-                               mathed_parse_normal(par_, clip);
-                       break;
-               }
-
-               default:
-                       result = InsetFormulaBase::localDispatch(bv, action, arg);
-       }
-
-       return result;
+       return Inset::MATH_CODE;
 }
 
 
-bool needEqnArray(string const & extra)
+void InsetFormula::validate(LaTeXFeatures & features) const
 {
-       return extra == "dsolve";
+       par_->validate(features);
 }
 
 
-void InsetFormula::handleExtern(const string & arg)
+bool InsetFormula::insetAllowed(Inset::Code code) const
 {
-       // where are we?
-       if (!mathcursor)
-               return; 
-
-       string lang;
-       string extra;
-       istringstream iss(arg.c_str());
-       iss >> lang >> extra;
-       if (extra.empty())
-               extra = "noextra";      
-
-       bool selected = mathcursor->selection();
-
-       MathArray ar;
-       if (needEqnArray(extra)) {
-               mathcursor->last();
-               //mathcursor->readLine(ar);
-               mathcursor->breakLine();
-       } else if (selected) {
-               mathcursor->selGet(ar);
-               //lyxerr << "use selection: " << ar << "\n";
-       } else {
-               mathcursor->last();
-               mathcursor->stripFromLastEqualSign();
-               ar = mathcursor->cursor().cell();
-               mathcursor->insert(MathAtom(new MathCharInset('=', LM_TC_VAR)));
-               //lyxerr << "use whole cell: " << ar << "\n";
-       }
-
-       mathcursor->insert(pipeThroughExtern(lang, extra, ar));
+       return
+                  code == Inset::LABEL_CODE
+               || code == Inset::REF_CODE
+               || code == Inset::ERT_CODE;
 }
 
 
-bool InsetFormula::display() const
+int InsetFormula::ascent(BufferView *, LyXFont const &) const
 {
-       return hull()->getType() != LM_OT_SIMPLE;
+       return preview_->previewReady() ?
+               preview_->pimage()->ascent() : 1 + par_->ascent();
 }
 
 
-MathHullInset const * InsetFormula::hull() const
+int InsetFormula::descent(BufferView *, LyXFont const &) const
 {
-       lyx::Assert(par_->asHullInset());
-       return par_->asHullInset();
-}
-
+       if (!preview_->previewReady())
+               return 1 + par_->descent();
 
-MathHullInset * InsetFormula::hull()
-{
-       lyx::Assert(par_->asHullInset());
-       return par_->asHullInset();
+       int const descent = preview_->pimage()->descent();
+       return display() ? descent + 12 : descent;
 }
 
 
-Inset::Code InsetFormula::lyxCode() const
+int InsetFormula::width(BufferView * bv, LyXFont const & font) const
 {
-       return Inset::MATH_CODE;
+       metrics(bv, font);
+       return preview_->previewReady() ?
+               1 + preview_->pimage()->width() : par_->width();
+               // insert a one pixel gap in front of the formula
 }
 
 
-void InsetFormula::validate(LaTeXFeatures & features) const
+/*
+void InsetFormula::mutate(string const & type)
 {
-       par_->validate(features);
+       par_.nucleus()->mutate(type);
 }
+*/
 
 
-bool InsetFormula::insetAllowed(Inset::Code code) const
-{
-       return 
-               (code == Inset::LABEL_CODE && display())
-               || code == Inset::ERT_CODE; 
-}
+//
+// preview stuff
+//
 
-
-int InsetFormula::ascent(BufferView *, LyXFont const &) const
+void InsetFormula::addPreview(grfx::PreviewLoader & ploader) const
 {
-       return par_->ascent() + 1;
+       preview_->addPreview(ploader);
 }
 
 
-int InsetFormula::descent(BufferView *, LyXFont const &) const
+void InsetFormula::generatePreview() const
 {
-       return par_->descent() + 1;
+       preview_->generatePreview();
 }
 
 
-int InsetFormula::width(BufferView * bv, LyXFont const & font) const
+bool InsetFormula::PreviewImpl::previewWanted() const
 {
-       metrics(bv, font);
-       return par_->width();
+       return !parent().par_->asNestInset()->editing();
 }
 
 
-MathInsetTypes InsetFormula::getType() const
+string const InsetFormula::PreviewImpl::latexString() const
 {
-       return hull()->getType();
+       ostringstream ls;
+       WriteStream wi(ls, false, false);
+       parent().par_->write(wi);
+       return STRCONV(ls.str());
 }
+