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 "lyxrc.h"
  36 #include "funcrequest.h"
  37 #include "Lsstream.h"
  38
  39 #include "support/LOstream.h"
  40 #include "support/LAssert.h"
  41 #include "support/lyxlib.h"
  42 #include "support/systemcall.h"
  43 #include "support/filetools.h"
  44
  45 #include "frontends/Alert.h"
  46 #include "frontends/LyXView.h"
  47 #include "frontends/Painter.h"
  48
  49 #include "graphics/PreviewedInset.h"
  50 #include "graphics/PreviewImage.h"
  51
  52
  53 using std::ostream;
  54 using std::vector;
  55
  56
  57 class InsetFormula::PreviewImpl : public grfx::PreviewedInset {
  58 public:
  59         ///
  60         PreviewImpl(InsetFormula & p) : PreviewedInset(p) {}
  61
  62 private:
  63         ///
  64         bool previewWanted() const;
  65         ///
  66         string const latexString() const;
  67         ///
  68         InsetFormula & parent() const
  69         {
  70                 return *static_cast<InsetFormula*>(inset());
  71         }
  72 };
  73
  74
  75
  76 InsetFormula::InsetFormula(bool chemistry)
  77         : par_(MathAtom(new MathHullInset)),
  78           preview_(new PreviewImpl(*this))
  79 {
  80         if (chemistry)
  81                 mutate("chemistry");
  82 }
  83
  84
  85 InsetFormula::InsetFormula(InsetFormula const & other)
  86         : InsetFormulaBase(other),
  87           par_(other.par_),
  88           preview_(new PreviewImpl(*this))
  89 {}
  90
  91
  92 InsetFormula::InsetFormula(BufferView * bv)
  93         : par_(MathAtom(new MathHullInset)),
  94           preview_(new PreviewImpl(*this))
  95 {
  96         view_ = bv->owner()->view();
  97 }
  98
  99
 100 InsetFormula::InsetFormula(string const & data)
 101         : par_(MathAtom(new MathHullInset)),
 102           preview_(new PreviewImpl(*this))
 103 {
 104         if (!data.size())
 105                 return;
 106         if (!mathed_parse_normal(par_, data))
 107                 lyxerr << "cannot interpret '" << data << "' as math\n";
 108 }
 109
 110
 111
 112 InsetFormula::~InsetFormula()
 113 {}
 114
 115
 116 Inset * InsetFormula::clone(Buffer const &, bool) const
 117 {
 118         return new InsetFormula(*this);
 119 }
 120
 121
 122 void InsetFormula::write(Buffer const *, ostream & os) const
 123 {
 124         WriteStream wi(os, false, false);
 125         os << par_->fileInsetLabel() << ' ';
 126         par_->write(wi);
 127 }
 128
 129
 130 int InsetFormula::latex(Buffer const *, ostream & os, LatexRunParams const &,
 131                         bool fragile, bool) const
 132 {
 133         WriteStream wi(os, fragile, true);
 134         par_->write(wi);
 135         return wi.line();
 136 }
 137
 138
 139 int InsetFormula::ascii(Buffer const *, ostream & os, int) const
 140 {
 141         if (0 && display()) {
 142                 TextMetricsInfo mi;
 143                 par()->metricsT(mi);
 144                 TextPainter tpain(par()->width(), par()->height());
 145                 par()->drawT(tpain, 0, par()->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(BufferView * bv, LyXFont const & font,
 209                         int y, float & xx) const
 210 {
 211         cache(bv);
 212         // This initiates the loading of the preview, so should come
 213         // before the metrics are computed.
 214         bool const use_preview = preview_->previewReady();
 215
 216         int const x = int(xx);
 217         int const w = width(bv, font);
 218         int const d = descent(bv, font);
 219         int const a = ascent(bv, font);
 220         int const h = a + d;
 221
 222         PainterInfo pi(bv->painter());
 223
 224         if (use_preview) {
 225                 pi.pain.image(x + 1, y - a, w, h,   // one pixel gap in front
 226                               *(preview_->pimage()->image()));
 227         } else {
 228                 pi.base.style = LM_ST_TEXT;
 229                 pi.base.font  = font;
 230                 pi.base.font.setColor(LColor::math);
 231                 if (lcolor.getX11Name(LColor::mathbg)
 232                             != lcolor.getX11Name(LColor::background))
 233                         pi.pain.fillRectangle(x, y - a, w, h, LColor::mathbg);
 234
 235                 if (mathcursor &&
 236                                 const_cast<InsetFormulaBase const *>(mathcursor->formula()) == this)
 237                 {
 238                         mathcursor->drawSelection(pi);
 239                         //pi.pain.rectangle(x, y - a, w, h, LColor::mathframe);
 240                 }
 241
 242                 par_->draw(pi, x, y);
 243         }
 244
 245         xx += w;
 246         xo_ = x;
 247         yo_ = y;
 248 }
 249
 250
 251 vector<string> const InsetFormula::getLabelList() const
 252 {
 253         vector<string> res;
 254         par()->getLabelList(res);
 255         return res;
 256 }
 257
 258
 259 Inset::Code InsetFormula::lyxCode() const
 260 {
 261         return Inset::MATH_CODE;
 262 }
 263
 264
 265 void InsetFormula::validate(LaTeXFeatures & features) const
 266 {
 267         par_->validate(features);
 268 }
 269
 270
 271 bool InsetFormula::insetAllowed(Inset::Code code) const
 272 {
 273         return
 274                    code == Inset::LABEL_CODE
 275                 || code == Inset::REF_CODE
 276                 || code == Inset::ERT_CODE;
 277 }
 278
 279
 280 void InsetFormula::dimension(BufferView * bv, LyXFont const & font,
 281         Dimension & dim) const
 282 {
 283         metrics(bv, font);
 284         if (preview_->previewReady()) {
 285                 dim.a = preview_->pimage()->ascent();
 286                 int const descent = preview_->pimage()->descent();
 287                 dim.d = display() ? descent + 12 : descent;
 288                 // insert a one pixel gap in front of the formula
 289                 dim.w = 1 + preview_->pimage()->width();
 290         } else {
 291                 dim = par_->dimensions();
 292                 dim.a += 1;
 293                 dim.d += 1;
 294         }
 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(grfx::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 }
 333