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