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 "support/LOstream.h"
34 #include "support/LAssert.h"
35 #include "support/lyxlib.h"
36 #include "support/systemcall.h"
37 #include "support/filetools.h"
38 #include "frontends/Alert.h"
39 #include "frontends/LyXView.h"
40 #include "frontends/Painter.h"
41 #include "graphics/GraphicsImage.h"
43 #include "math_hullinset.h"
44 #include "math_support.h"
45 #include "math_mathmlstream.h"
46 #include "textpainter.h"
50 #include <boost/bind.hpp>
51 #include <boost/utility.hpp>
63 InsetFormula::InsetFormula()
64 : par_(MathAtom(new MathHullInset)), loader_(0)
68 InsetFormula::InsetFormula(MathInsetTypes t)
69 : par_(MathAtom(new MathHullInset(t))), loader_(0)
73 InsetFormula::InsetFormula(string const & s)
76 bool res = mathed_parse_normal(par_, s);
79 res = mathed_parse_normal(par_, "$" + s + "$");
82 lyxerr << "cannot interpret '" << s << "' as math\n";
83 par_ = MathAtom(new MathHullInset(LM_OT_SIMPLE));
91 Inset * InsetFormula::clone(Buffer const &, bool) const
93 return new InsetFormula(*this);
97 void InsetFormula::write(Buffer const *, ostream & os) const
100 WriteStream wi(os, false, false);
105 int InsetFormula::latex(Buffer const *, ostream & os, bool fragile, bool) const
107 WriteStream wi(os, fragile, true);
113 int InsetFormula::ascii(Buffer const *, ostream & os, int) const
118 TextPainter tpain(par()->width(), par()->height());
119 par()->drawT(tpain, 0, par()->ascent());
121 // reset metrics cache to "real" values
123 return tpain.textheight();
125 WriteStream wi(os, false, true);
132 int InsetFormula::linuxdoc(Buffer const * buf, ostream & os) const
134 return docbook(buf, os, false);
138 int InsetFormula::docbook(Buffer const * buf, ostream & os, bool) const
141 ms << MTag("equation");
144 int res = ascii(buf, ms.os(), 0);
148 ms << par_.nucleus();
150 ms << ETag("equation");
151 return ms.line() + res;
155 void InsetFormula::read(Buffer const *, LyXLex & lex)
157 mathed_parse_normal(par_, lex);
163 //ostream & operator<<(ostream & os, LyXCursor const & c)
165 // os << '[' << c.x() << ' ' << c.y() << ' ' << c.pos() << ']';
170 void InsetFormula::draw(BufferView * bv, LyXFont const & font,
171 int y, float & xx, bool) const
173 int const x = int(xx);
174 int const w = width(bv, font);
175 int const d = descent(bv, font);
176 int const a = ascent(bv, font);
179 MathPainterInfo pi(bv->painter());
182 pi.pain.image(x + 1, y - a + 1, w - 2, h - 2, *(loader_->image()));
184 pi.base.style = display() ? LM_ST_DISPLAY : LM_ST_TEXT;
186 pi.base.font.setColor(LColor::math);
187 if (lcolor.getX11Name(LColor::mathbg)
188 != lcolor.getX11Name(LColor::background))
189 pi.pain.fillRectangle(x, y - a, w, h, LColor::mathbg);
192 const_cast<InsetFormulaBase const *>(mathcursor->formula()) == this)
194 mathcursor->drawSelection(pi);
195 pi.pain.rectangle(x, y - a, w, h, LColor::mathframe);
198 par_->draw(pi, x, y);
205 setCursorVisible(false);
209 vector<string> const InsetFormula::getLabelList() const
211 return hull()->getLabelList();
215 UpdatableInset::RESULT
216 InsetFormula::localDispatch(BufferView * bv, kb_action action,
219 RESULT result = DISPATCHED;
224 bv->lockedInsetStoreUndo(Undo::INSERT);
225 mathcursor->breakLine();
226 mathcursor->normalize();
227 updateLocal(bv, true);
230 case LFUN_MATH_NUMBER:
232 //lyxerr << "toggling all numbers\n";
234 bv->lockedInsetStoreUndo(Undo::INSERT);
235 bool old = hull()->numberedType();
236 for (MathInset::row_type row = 0; row < par_->nrows(); ++row)
237 hull()->numbered(row, !old);
238 bv->owner()->message(old ? _("No number") : _("Number"));
239 updateLocal(bv, true);
244 case LFUN_MATH_NONUMBER:
246 //lyxerr << "toggling line number\n";
248 bv->lockedInsetStoreUndo(Undo::INSERT);
249 MathCursor::row_type row = mathcursor->hullRow();
250 bool old = hull()->numbered(row);
251 bv->owner()->message(old ? _("No number") : _("Number"));
252 hull()->numbered(row, !old);
253 updateLocal(bv, true);
258 case LFUN_INSERT_LABEL:
260 bv->lockedInsetStoreUndo(Undo::INSERT);
262 MathCursor::row_type row = mathcursor->hullRow();
263 string old_label = hull()->label(row);
264 string new_label = arg;
266 if (new_label.empty()) {
267 string const default_label =
268 (lyxrc.label_init_length >= 0) ? "eq:" : "";
269 pair<bool, string> const res = old_label.empty()
270 ? Alert::askForText(_("Enter new label to insert:"), default_label)
271 : Alert::askForText(_("Enter label:"), old_label);
274 new_label = frontStrip(strip(res.second));
277 //if (new_label == old_label)
278 // break; // Nothing to do
280 if (!new_label.empty()) {
281 lyxerr << "setting label to '" << new_label << "'\n";
282 hull()->numbered(row, true);
285 #warning FIXME: please check you really mean repaint() ... is it needed,
286 #warning and if so, should it be update() instead ?
287 if (!new_label.empty() && bv->ChangeRefsIfUnique(old_label, new_label))
290 hull()->label(row, new_label);
292 updateLocal(bv, true);
296 case LFUN_MATH_MUTATE:
298 bv->lockedInsetStoreUndo(Undo::EDIT);
301 mathcursor->getPos(x, y);
303 mathcursor->setPos(x, y);
304 mathcursor->normalize();
305 updateLocal(bv, true);
309 case LFUN_MATH_EXTERN:
311 bv->lockedInsetStoreUndo(Undo::EDIT);
313 mathcursor->handleExtern(arg);
314 // re-compute inset dimension
316 updateLocal(bv, true);
320 case LFUN_MATH_DISPLAY:
324 mathcursor->getPos(x, y);
325 if (getType() == LM_OT_SIMPLE)
326 hull()->mutate(LM_OT_EQUATION);
328 hull()->mutate(LM_OT_SIMPLE);
329 mathcursor->setPos(x, y);
330 mathcursor->normalize();
331 updateLocal(bv, true);
335 case LFUN_PASTESELECTION:
337 string const clip = bv->getClipboard();
339 mathed_parse_normal(par_, clip);
344 result = InsetFormulaBase::localDispatch(bv, action, arg);
353 bool InsetFormula::display() const
355 return getType() != LM_OT_SIMPLE;
359 MathHullInset const * InsetFormula::hull() const
361 lyx::Assert(par_->asHullInset());
362 return par_->asHullInset();
366 MathHullInset * InsetFormula::hull()
368 lyx::Assert(par_->asHullInset());
369 return par_->asHullInset();
373 Inset::Code InsetFormula::lyxCode() const
375 return Inset::MATH_CODE;
379 void InsetFormula::validate(LaTeXFeatures & features) const
381 par_->validate(features);
385 bool InsetFormula::insetAllowed(Inset::Code code) const
388 (code == Inset::LABEL_CODE && display())
389 || code == Inset::REF_CODE
390 || code == Inset::ERT_CODE;
394 int InsetFormula::ascent(BufferView *, LyXFont const &) const
396 const int a = par_->ascent();
399 return a + 1 - (par_->height() - loader_->image()->getHeight()) / 2;
403 int InsetFormula::descent(BufferView *, LyXFont const &) const
405 const int d = par_->descent();
408 return d + 1 - (par_->height() - loader_->image()->getHeight()) / 2;
412 int InsetFormula::width(BufferView * bv, LyXFont const & font) const
415 return canPreview() ? loader_->image()->getWidth() : par_->width();
419 MathInsetTypes InsetFormula::getType() const
421 return hull()->getType();
429 bool InsetFormula::canPreview() const
431 return lyxrc.preview && loader_ && !par_->asNestInset()->editing()
432 && loader_->status() == grfx::Ready;
436 void InsetFormula::statusChanged()
438 lyxerr << "### InsetFormula::statusChanged called!, status: "
439 << loader_->status() << "\n";
440 if (loader_->status() == grfx::Ready)
441 view()->updateInset(this, false);
442 else if (loader_->status() == grfx::WaitingToLoad)
443 loader_->startLoading();
447 void InsetFormula::updatePreview()
449 // nothing to be done if no preview requested
450 lyxerr << "### updatePreview() called\n";
456 WriteStream wi(ls, false, false);
458 string const data = ls.str();
460 // the preview cache, maps contents to image loaders
461 typedef std::map<string, boost::shared_ptr<grfx::Loader> > cache_type;
462 static cache_type theCache;
463 static int theCounter = 0;
465 // set our loader corresponding to our current data
466 cache_type::const_iterator it = theCache.find(data);
469 if (it != theCache.end()) {
470 // we have already a loader, connect to it anyway
471 lyxerr << "### updatePreview(), old loader: " << loader_ << "\n";
472 loader_ = it->second.get();
473 loader_->statusChanged.connect
474 (boost::bind(&InsetFormula::statusChanged, this));
478 // construct new file name
479 static string const dir = OnlyPath(lyx::tempName());
481 os << dir << theCounter++ << ".lyxpreview";
482 string file = os.str();
484 // the real work starts
485 lyxerr << "### updatePreview(), new file " << file << "\n";
486 std::ofstream of(file.c_str());
488 << "\\documentclass{article}"
489 << "\\usepackage{amssymb}"
490 << "\\thispagestyle{empty}"
492 << "\\begin{document}"
494 << "\\end{document}\n";
497 // now we are done, start actual loading we will get called back via
498 // InsetFormula::statusChanged() if this is finished
499 lyxerr << "### updatePreview(), new loader: " << loader_ << "\n";
500 theCache[data].reset(new grfx::Loader(file));
501 loader_ = theCache.find(data)->second.get();
502 loader_->startLoading();
503 loader_->statusChanged.connect(boost::bind(&InsetFormula::statusChanged, this));