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
  17 #include <config.h>
  18
  19 #include "formula.h"
  20 #include "math_cursor.h"
  21 #include "math_parser.h"
  22 #include "math_charinset.h"
  23 #include "math_arrayinset.h"
  24 #include "metricsinfo.h"
  25 #include "math_deliminset.h"
  26 #include "math_hullinset.h"
  27 #include "math_support.h"
  28 #include "math_mathmlstream.h"
  29 #include "textpainter.h"
  30 #include "Lsstream.h"
  31
  32 #include "BufferView.h"
  33 #include "gettext.h"
  34 #include "debug.h"
  35 #include "latexrunparams.h"
  36 #include "lyxrc.h"
  37 #include "funcrequest.h"
  38 #include "Lsstream.h"
  39
  40 #include "support/LOstream.h"
  41 #include "support/LAssert.h"
  42 #include "support/lyxlib.h"
  43 #include "support/systemcall.h"
  44 #include "support/filetools.h"
  45
  46 #include "frontends/Alert.h"
  47 #include "frontends/LyXView.h"
  48 #include "frontends/Painter.h"
  49
  50 #include "graphics/PreviewedInset.h"
  51 #include "graphics/PreviewImage.h"
  52
  53
  54 using std::ostream;
  55 using std::vector;
  56
  57
  58 class InsetFormula::PreviewImpl : public grfx::PreviewedInset {
  59 public:
  60         ///
  61         PreviewImpl(InsetFormula & p) : PreviewedInset(p) {}
  62
  63 private:
  64         ///
  65         bool previewWanted() const;
  66         ///
  67         string const latexString() const;
  68         ///
  69         InsetFormula & parent() const
  70         {
  71                 return *static_cast<InsetFormula*>(inset());
  72         }
  73 };
  74
  75
  76
  77 InsetFormula::InsetFormula(bool chemistry)
  78         : par_(MathAtom(new MathHullInset)),
  79           preview_(new PreviewImpl(*this))
  80 {
  81         if (chemistry)
  82                 mutate("chemistry");
  83 }
  84
  85
  86 InsetFormula::InsetFormula(InsetFormula const & other)
  87         : InsetFormulaBase(other),
  88           par_(other.par_),
  89           preview_(new PreviewImpl(*this))
  90 {}
  91
  92
  93 InsetFormula::InsetFormula(BufferView * bv)
  94         : par_(MathAtom(new MathHullInset)),
  95           preview_(new PreviewImpl(*this))
  96 {
  97         view_ = bv->owner()->view();
  98 }
  99
 100
 101 InsetFormula::InsetFormula(string const & data)
 102         : par_(MathAtom(new MathHullInset)),
 103           preview_(new PreviewImpl(*this))
 104 {
 105         if (!data.size())
 106                 return;
 107         if (!mathed_parse_normal(par_, data))
 108                 lyxerr << "cannot interpret '" << data << "' as math\n";
 109 }
 110
 111
 112
 113 InsetFormula::~InsetFormula()
 114 {}
 115
 116
 117 Inset * InsetFormula::clone(Buffer const &, bool) const
 118 {
 119         return new InsetFormula(*this);
 120 }
 121
 122
 123 void InsetFormula::write(Buffer const *, ostream & os) const
 124 {
 125         WriteStream wi(os, false, false);
 126         os << par_->fileInsetLabel() << ' ';
 127         par_->write(wi);
 128 }
 129
 130
 131 int InsetFormula::latex(Buffer const *, ostream & os,
 132                         LatexRunParams const & runparams) const
 133 {
 134         WriteStream wi(os, runparams.fragile, true);
 135         par_->write(wi);
 136         return wi.line();
 137 }
 138
 139
 140 int InsetFormula::ascii(Buffer const *, ostream & os, int) const
 141 {
 142         if (0 && display()) {
 143                 TextMetricsInfo mi;
 144                 par()->metricsT(mi);
 145                 TextPainter tpain(par()->width(), par()->height());
 146                 par()->drawT(tpain, 0, par()->ascent());
 147                 tpain.show(os, 3);
 148                 // reset metrics cache to "real" values
 149                 metrics();
 150                 return tpain.textheight();
 151         } else {
 152                 WriteStream wi(os, false, true);
 153                 wi << ' ' << (par_->asNestInset()->cell(0)) << ' ';
 154                 return wi.line();
 155         }
 156 }
 157
 158
 159 int InsetFormula::linuxdoc(Buffer const * buf, ostream & os) const
 160 {
 161         return docbook(buf, os, false);
 162 }
 163
 164
 165 int InsetFormula::docbook(Buffer const * buf, ostream & os, bool) const
 166 {
 167         MathMLStream ms(os);
 168         ms << MTag("equation");
 169         ms <<   MTag("alt");
 170         ms <<    "<[CDATA[";
 171         int res = ascii(buf, ms.os(), 0);
 172         ms <<    "]]>";
 173         ms <<   ETag("alt");
 174         ms <<   MTag("math");
 175         ms <<    par_;
 176         ms <<   ETag("math");
 177         ms << ETag("equation");
 178         return ms.line() + res;
 179 }
 180
 181
 182 void InsetFormula::read(Buffer const *, LyXLex & lex)
 183 {
 184         mathed_parse_normal(par_, lex);
 185         // remove extra 'mathrm' for chemistry stuff.
 186         // will be re-added on write
 187         if (par_->asHullInset()->getType() =="chemistry")  {
 188                 lyxerr << "this is chemistry\n";
 189                 if (par_->cell(0).size() == 1) {
 190                         lyxerr << "this is size 1\n";
 191             if (par_->cell(0)[0]->asFontInset()) {
 192                                 lyxerr << "this is a font inset \n";
 193                                 lyxerr << "replacing " << par_.nucleus()->cell(0) <<
 194                                         " with " << par_->cell(0)[0]->cell(0) << "\n";
 195                         }
 196                 }
 197         }
 198         metrics();
 199 }
 200
 201
 202 //ostream & operator<<(ostream & os, LyXCursor const & c)
 203 //{
 204 //      os << '[' << c.x() << ' ' << c.y() << ' ' << c.pos() << ']';
 205 //      return os;
 206 //}
 207
 208
 209 void InsetFormula::draw(BufferView * bv, LyXFont const & font,
 210                         int y, float & xx) const
 211 {
 212         cache(bv);
 213         // This initiates the loading of the preview, so should come
 214         // before the metrics are computed.
 215         bool const use_preview = preview_->previewReady();
 216
 217         int const x = int(xx);
 218         int const w = width(bv, font);
 219         int const d = descent(bv, font);
 220         int const a = ascent(bv, font);
 221         int const h = a + d;
 222
 223         PainterInfo pi(bv->painter());
 224
 225         if (use_preview) {
 226                 pi.pain.image(x + 1, y - a, w, h,   // one pixel gap in front
 227                               *(preview_->pimage()->image()));
 228         } else {
 229                 pi.base.style = LM_ST_TEXT;
 230                 pi.base.font  = font;
 231                 pi.base.font.setColor(LColor::math);
 232                 if (lcolor.getX11Name(LColor::mathbg)
 233                             != lcolor.getX11Name(LColor::background))
 234                         pi.pain.fillRectangle(x, y - a, w, h, LColor::mathbg);
 235
 236                 if (mathcursor &&
 237                                 const_cast<InsetFormulaBase const *>(mathcursor->formula()) == this)
 238                 {
 239                         mathcursor->drawSelection(pi);
 240                         //pi.pain.rectangle(x, y - a, w, h, LColor::mathframe);
 241                 }
 242
 243                 par_->draw(pi, x, y);
 244         }
 245
 246         xx += w;
 247         xo_ = x;
 248         yo_ = y;
 249 }
 250
 251
 252 vector<string> const InsetFormula::getLabelList() const
 253 {
 254         vector<string> res;
 255         par()->getLabelList(res);
 256         return res;
 257 }
 258
 259
 260 Inset::Code InsetFormula::lyxCode() const
 261 {
 262         return Inset::MATH_CODE;
 263 }
 264
 265
 266 void InsetFormula::validate(LaTeXFeatures & features) const
 267 {
 268         par_->validate(features);
 269 }
 270
 271
 272 bool InsetFormula::insetAllowed(Inset::Code code) const
 273 {
 274         return
 275                    code == Inset::LABEL_CODE
 276                 || code == Inset::REF_CODE
 277                 || code == Inset::ERT_CODE;
 278 }
 279
 280
 281 void InsetFormula::dimension(BufferView * bv, LyXFont const & font,
 282         Dimension & dim) const
 283 {
 284         metrics(bv, font);
 285         if (preview_->previewReady()) {
 286                 dim.a = preview_->pimage()->ascent();
 287                 int const descent = preview_->pimage()->descent();
 288                 dim.d = display() ? descent + 12 : descent;
 289                 // insert a one pixel gap in front of the formula
 290                 dim.w = 1 + preview_->pimage()->width();
 291         } else {
 292                 dim = par_->dimensions();
 293                 dim.a += 1;
 294                 dim.d += 1;
 295         }
 296 }
 297
 298
 299 void InsetFormula::mutate(string const & type)
 300 {
 301         par_.nucleus()->mutate(type);
 302 }
 303
 304
 305 //
 306 // preview stuff
 307 //
 308
 309 void InsetFormula::addPreview(grfx::PreviewLoader & ploader) const
 310 {
 311         preview_->addPreview(ploader);
 312 }
 313
 314
 315 void InsetFormula::generatePreview() const
 316 {
 317         preview_->generatePreview();
 318 }
 319
 320
 321 bool InsetFormula::PreviewImpl::previewWanted() const
 322 {
 323         return !parent().par_->asNestInset()->editing();
 324 }
 325
 326
 327 string const InsetFormula::PreviewImpl::latexString() const
 328 {
 329         ostringstream ls;
 330         WriteStream wi(ls, false, false);
 331         parent().par_->write(wi);
 332         return STRCONV(ls.str());
 333 }
 334