src/mathed/InsetMathHull.cpp

   1 /**
   2  * \file InsetMathHull.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author André Pönitz
   7  *
   8  * Full author contact details are available in file CREDITS.
   9  */
  10
  11 #include <config.h>
  12
  13 #include "InsetMathHull.h"
  14
  15 #include "InsetMathChar.h"
  16 #include "InsetMathColor.h"
  17 #include "InsetMathFrac.h"
  18 #include "InsetMathGrid.h"
  19 #include "InsetMathNest.h"
  20 #include "InsetMathScript.h"
  21 #include "MathExtern.h"
  22 #include "MathFactory.h"
  23 #include "MathStream.h"
  24 #include "MathSupport.h"
  25
  26 #include "Buffer.h"
  27 #include "BufferParams.h"
  28 #include "BufferView.h"
  29 #include "ColorSet.h"
  30 #include "CutAndPaste.h"
  31 #include "Encoding.h"
  32 #include "Exporter.h"
  33 #include "FuncRequest.h"
  34 #include "FuncStatus.h"
  35 #include "Language.h"
  36 #include "LaTeXFeatures.h"
  37 #include "LyXRC.h"
  38 #include "MacroTable.h"
  39 #include "MathMacro.h"
  40 #include "MathMacroTemplate.h"
  41 #include "MetricsInfo.h"
  42 #include "output_xhtml.h"
  43 #include "Paragraph.h"
  44 #include "ParIterator.h"
  45 #include "sgml.h"
  46 #include "TextClass.h"
  47 #include "TextPainter.h"
  48 #include "TocBackend.h"
  49
  50 #include "insets/InsetLabel.h"
  51 #include "insets/InsetRef.h"
  52 #include "insets/RenderPreview.h"
  53
  54 #include "graphics/GraphicsImage.h"
  55 #include "graphics/PreviewImage.h"
  56 #include "graphics/PreviewLoader.h"
  57
  58 #include "frontends/alert.h"
  59 #include "frontends/Painter.h"
  60
  61 #include "support/convert.h"
  62 #include "support/lassert.h"
  63 #include "support/debug.h"
  64 #include "support/filetools.h"
  65 #include "support/gettext.h"
  66 #include "support/lstrings.h"
  67
  68 #include <sstream>
  69
  70 using namespace std;
  71 using namespace lyx::support;
  72
  73 namespace lyx {
  74
  75 using cap::grabAndEraseSelection;
  76 using cap::reduceSelectionToOneCell;
  77
  78 namespace {
  79
  80         int getCols(HullType type)
  81         {
  82                 switch (type) {
  83                 case hullEqnArray:
  84                         return 3;
  85                 case hullAlign:
  86                 case hullFlAlign:
  87                 case hullAlignAt:
  88                 case hullXAlignAt:
  89                 case hullXXAlignAt:
  90                         return 2;
  91                 case hullUnknown:
  92                 case hullNone:
  93                 case hullSimple:
  94                 case hullEquation:
  95                 case hullMultline:
  96                 case hullGather:
  97                 case hullRegexp:
  98                         return 1;
  99                 }
 100                 // avoid warning
 101                 return 0;
 102         }
 103
 104
 105         // returns position of first relation operator in the array
 106         // used for "intelligent splitting"
 107         size_t firstRelOp(MathData const & ar)
 108         {
 109                 for (MathData::const_iterator it = ar.begin(); it != ar.end(); ++it)
 110                         if ((*it)->isMathRel())
 111                                 return it - ar.begin();
 112                 return ar.size();
 113         }
 114
 115
 116         char const * star(bool numbered)
 117         {
 118                 return numbered ? "" : "*";
 119         }
 120
 121
 122 } // end anon namespace
 123
 124
 125 HullType hullType(docstring const & s)
 126 {
 127         if (s == "none")      return hullNone;
 128         if (s == "simple")    return hullSimple;
 129         if (s == "equation")  return hullEquation;
 130         if (s == "eqnarray")  return hullEqnArray;
 131         if (s == "align")     return hullAlign;
 132         if (s == "alignat")   return hullAlignAt;
 133         if (s == "xalignat")  return hullXAlignAt;
 134         if (s == "xxalignat") return hullXXAlignAt;
 135         if (s == "multline")  return hullMultline;
 136         if (s == "gather")    return hullGather;
 137         if (s == "flalign")   return hullFlAlign;
 138         if (s == "regexp")    return hullRegexp;
 139         lyxerr << "unknown hull type '" << to_utf8(s) << "'" << endl;
 140         return hullUnknown;
 141 }
 142
 143
 144 docstring hullName(HullType type)
 145 {
 146         switch (type) {
 147         case hullNone:       return from_ascii("none");
 148         case hullSimple:     return from_ascii("simple");
 149         case hullEquation:   return from_ascii("equation");
 150         case hullEqnArray:   return from_ascii("eqnarray");
 151         case hullAlign:      return from_ascii("align");
 152         case hullAlignAt:    return from_ascii("alignat");
 153         case hullXAlignAt:   return from_ascii("xalignat");
 154         case hullXXAlignAt:  return from_ascii("xxalignat");
 155         case hullMultline:   return from_ascii("multline");
 156         case hullGather:     return from_ascii("gather");
 157         case hullFlAlign:    return from_ascii("flalign");
 158         case hullRegexp:     return from_ascii("regexp");
 159         case hullUnknown:
 160                 lyxerr << "unknown hull type" << endl;
 161                 break;
 162         }
 163         return from_ascii("none");
 164 }
 165
 166 static InsetLabel * dummy_pointer = 0;
 167
 168 InsetMathHull::InsetMathHull(Buffer * buf)
 169         : InsetMathGrid(buf, 1, 1), type_(hullNone), numbered_(1, NUMBER),
 170           numbers_(1, empty_docstring()), label_(1, dummy_pointer),
 171           preview_(new RenderPreview(this))
 172 {
 173         //lyxerr << "sizeof InsetMath: " << sizeof(InsetMath) << endl;
 174         //lyxerr << "sizeof MetricsInfo: " << sizeof(MetricsInfo) << endl;
 175         //lyxerr << "sizeof InsetMathChar: " << sizeof(InsetMathChar) << endl;
 176         //lyxerr << "sizeof FontInfo: " << sizeof(FontInfo) << endl;
 177         buffer_ = buf;
 178         initMath();
 179         setDefaults();
 180 }
 181
 182
 183 InsetMathHull::InsetMathHull(Buffer * buf, HullType type)
 184         : InsetMathGrid(buf, getCols(type), 1), type_(type), numbered_(1, NUMBER),
 185           numbers_(1, empty_docstring()), label_(1, dummy_pointer),
 186           preview_(new RenderPreview(this))
 187 {
 188         buffer_ = buf;
 189         initMath();
 190         setDefaults();
 191 }
 192
 193
 194 InsetMathHull::InsetMathHull(InsetMathHull const & other) : InsetMathGrid(other)
 195 {
 196         operator=(other);
 197 }
 198
 199
 200 InsetMathHull::~InsetMathHull()
 201 {
 202         for (size_t i = 0; i < label_.size(); ++i)
 203                 delete label_[i];
 204 }
 205
 206
 207 Inset * InsetMathHull::clone() const
 208 {
 209         return new InsetMathHull(*this);
 210 }
 211
 212
 213 InsetMathHull & InsetMathHull::operator=(InsetMathHull const & other)
 214 {
 215         if (this == &other)
 216                 return *this;
 217         InsetMathGrid::operator=(other);
 218         type_  = other.type_;
 219         numbered_ = other.numbered_;
 220         numbers_ = other.numbers_;
 221         buffer_ = other.buffer_;
 222         for (size_t i = 0; i < label_.size(); ++i)
 223                 delete label_[i];
 224         label_ = other.label_;
 225         for (size_t i = 0; i != label_.size(); ++i) {
 226                 if (label_[i])
 227                         label_[i] = new InsetLabel(*label_[i]);
 228         }
 229         preview_.reset(new RenderPreview(*other.preview_, this));
 230
 231         return *this;
 232 }
 233
 234
 235 void InsetMathHull::setBuffer(Buffer & buffer)
 236 {
 237         InsetMathGrid::setBuffer(buffer);
 238
 239         for (size_t i = 0; i != label_.size(); ++i) {
 240                 if (label_[i])
 241                         label_[i]->setBuffer(buffer);
 242         }
 243 }
 244
 245
 246 // FIXME This should really be controlled by the TOC level, or
 247 // something of the sort.
 248 namespace {
 249         const char * counters_to_save[] = {"section", "chapter"};
 250         unsigned int const numcnts = sizeof(counters_to_save)/sizeof(char *);
 251 }
 252
 253
 254 void InsetMathHull::updateBuffer(ParIterator const & it, UpdateType utype)
 255 {
 256         if (!buffer_) {
 257                 //FIXME: buffer_ should be set at creation for this inset! Problem is
 258                 // This inset is created at too many places (see Parser::parse1() in
 259                 // MathParser.cpp).
 260                 return;
 261         }
 262
 263         // if any of the equations are numbered, then we want to save the values
 264         // of some of the counters.
 265         if (haveNumbers()) {
 266                 BufferParams const & bp = buffer_->params();
 267                 string const & lang = it->getParLanguage(bp)->code();
 268                 Counters & cnts =
 269                         buffer_->masterBuffer()->params().documentClass().counters();
 270
 271                 // right now, we only need to do this at export time
 272                 if (utype == OutputUpdate) {
 273                         for (size_t i = 0; i < numcnts; ++i) {
 274                                 docstring const cnt = from_ascii(counters_to_save[i]);
 275                                 if (cnts.hasCounter(cnt))
 276                                         counter_map[cnt] = cnts.value(cnt);
 277                         }
 278                 }
 279
 280                 // this has to be done separately
 281                 docstring const eqstr = from_ascii("equation");
 282                 if (cnts.hasCounter(eqstr)) {
 283                         if (utype == OutputUpdate)
 284                                 counter_map[eqstr] = cnts.value(eqstr);
 285                         for (size_t i = 0; i != label_.size(); ++i) {
 286                                 if (numbered(i)) {
 287                                         cnts.step(eqstr, utype);
 288                                         numbers_[i] = cnts.theCounter(eqstr, lang);
 289                                 } else
 290                                         numbers_[i] = empty_docstring();
 291                         }
 292                 }
 293         }
 294
 295         // now the labels
 296         for (size_t i = 0; i != label_.size(); ++i) {
 297                 if (label_[i])
 298                         label_[i]->updateBuffer(it, utype);
 299         }
 300         // pass down
 301         InsetMathGrid::updateBuffer(it, utype);
 302 }
 303
 304
 305 void InsetMathHull::addToToc(DocIterator const & pit, bool output_active,
 306                                                          UpdateType utype) const
 307 {
 308         if (!buffer_) {
 309                 //FIXME: buffer_ should be set at creation for this inset! Problem is
 310                 // This inset is created at too many places (see Parser::parse1() in
 311                 // MathParser.cpp).
 312                 return;
 313         }
 314
 315         shared_ptr<Toc> toc = buffer().tocBackend().toc("equation");
 316
 317         for (row_type row = 0; row != nrows(); ++row) {
 318                 if (!numbered(row))
 319                         continue;
 320                 if (label_[row])
 321                         label_[row]->addToToc(pit, output_active, utype);
 322                 toc->push_back(TocItem(pit, 0, nicelabel(row), output_active));
 323         }
 324 }
 325
 326
 327 Inset * InsetMathHull::editXY(Cursor & cur, int x, int y)
 328 {
 329         if (previewState(&cur.bv())) {
 330                 edit(cur, true);
 331                 return this;
 332         }
 333         return InsetMathNest::editXY(cur, x, y);
 334 }
 335
 336
 337 InsetMath::mode_type InsetMathHull::currentMode() const
 338 {
 339         switch (type_) {
 340         case hullNone:
 341                 return UNDECIDED_MODE;
 342
 343         // definitely math mode ...
 344         case hullUnknown:
 345         case hullSimple:
 346         case hullEquation:
 347         case hullMultline:
 348         case hullGather:
 349         case hullEqnArray:
 350         case hullAlign:
 351         case hullFlAlign:
 352         case hullAlignAt:
 353         case hullXAlignAt:
 354         case hullXXAlignAt:
 355         case hullRegexp:
 356                 return MATH_MODE;
 357         }
 358         // avoid warning
 359         return MATH_MODE;
 360 }
 361
 362
 363 bool InsetMathHull::idxFirst(Cursor & cur) const
 364 {
 365         cur.idx() = 0;
 366         cur.pos() = 0;
 367         return true;
 368 }
 369
 370
 371 bool InsetMathHull::idxLast(Cursor & cur) const
 372 {
 373         cur.idx() = nargs() - 1;
 374         cur.pos() = cur.lastpos();
 375         return true;
 376 }
 377
 378
 379 // FIXME: InsetMathGrid should be changed to let the real column alignment be
 380 // given by a virtual method like displayColAlign, because the values produced
 381 // by defaultColAlign can be invalidated by lfuns such as add-column. For the
 382 // moment the values produced by defaultColAlign are not used, notably because
 383 // alignment is not implemented in the LyXHTML output.
 384 char InsetMathHull::defaultColAlign(col_type col)
 385 {
 386         return colAlign(type_, col);
 387 }
 388
 389
 390 char InsetMathHull::displayColAlign(idx_type idx) const
 391 {
 392         switch (type_) {
 393         case hullMultline: {
 394                 row_type const r = row(idx);
 395                 if (r == 0)
 396                         return 'l';
 397                 if (r == nrows() - 1)
 398                         return 'r';
 399                 return 'c';
 400         }
 401         case hullEqnArray:
 402         case hullGather:
 403         case hullAlign:
 404         case hullAlignAt:
 405         case hullXAlignAt:
 406         case hullXXAlignAt:
 407         case hullFlAlign:
 408                 return colAlign(type_, col(idx));
 409         default:
 410                 break;
 411         }
 412         return InsetMathGrid::displayColAlign(idx);
 413 }
 414
 415
 416 int InsetMathHull::displayColSpace(col_type col) const
 417 {
 418         return colSpace(type_, col);
 419 }
 420
 421
 422 // FIXME: same comment as for defaultColAlign applies.
 423 int InsetMathHull::defaultColSpace(col_type col)
 424 {
 425         return colSpace(type_, col);
 426 }
 427
 428
 429 docstring InsetMathHull::standardFont() const
 430 {
 431         switch (type_) {
 432         case hullRegexp:
 433                 return from_ascii("texttt");
 434         case hullNone:
 435                 return from_ascii("lyxnochange");
 436         default:
 437                 return from_ascii("mathnormal");
 438         }
 439 }
 440
 441
 442 ColorCode InsetMathHull::standardColor() const
 443 {
 444         switch (type_) {
 445         case hullRegexp:
 446         case hullNone:
 447                 return Color_foreground;
 448
 449         default:
 450                 return Color_math;
 451         }
 452 }
 453
 454
 455 bool InsetMathHull::previewState(const BufferView *const bv) const
 456 {
 457         if (!editing(bv) && RenderPreview::previewMath()
 458             && type_ != hullRegexp)
 459         {
 460                 graphics::PreviewImage const * pimage =
 461                         preview_->getPreviewImage(bv->buffer());
 462                 return pimage && pimage->image();
 463         }
 464         return false;
 465 }
 466
 467
 468 namespace {
 469 static const int ERROR_FRAME_WIDTH = 2;
 470 }
 471
 472 void InsetMathHull::metrics(MetricsInfo & mi, Dimension & dim) const
 473 {
 474         if (previewState(mi.base.bv)) {
 475                 preview_->metrics(mi, dim);
 476                 if (previewTooSmall(dim)) {
 477                         // preview image is too small
 478                         dim.wid += 2 * ERROR_FRAME_WIDTH;
 479                         dim.asc += 2 * ERROR_FRAME_WIDTH;
 480                 } else {
 481                         // insert a one pixel gap in front of the formula
 482                         dim.wid += 1;
 483                         if (display())
 484                                 dim.des += displayMargin();
 485                 }
 486                 // Cache the inset dimension.
 487                 setDimCache(mi, dim);
 488                 return;
 489         }
 490
 491         // FIXME: Changing the same object repeatedly is inefficient.
 492         Changer dummy1 = mi.base.changeFontSet(standardFont());
 493         Changer dummy2 = mi.base.changeStyle(display() ? LM_ST_DISPLAY : LM_ST_TEXT);
 494
 495         // let the cells adjust themselves
 496         InsetMathGrid::metrics(mi, dim);
 497
 498         if (display()) {
 499                 dim.asc += displayMargin();
 500                 dim.des += displayMargin();
 501         }
 502
 503         if (numberedType()) {
 504                 Changer dummy = mi.base.changeFontSet(from_ascii("mathbf"));
 505                 int l = 0;
 506                 for (row_type row = 0; row < nrows(); ++row)
 507                         l = max(l, mathed_string_width(mi.base.font, nicelabel(row)));
 508
 509                 if (l)
 510                         dim.wid += 30 + l;
 511         }
 512
 513         if (type_ == hullRegexp)
 514                 dim.wid += 2;
 515         // make it at least as high as the current font
 516         int asc = 0;
 517         int des = 0;
 518         math_font_max_dim(mi.base.font, asc, des);
 519         dim.asc = max(dim.asc, asc);
 520         dim.des = max(dim.des, des);
 521         // Cache the inset dimension.
 522         // FIXME: This will overwrite InsetMathGrid dimension, is that OK?
 523         setDimCache(mi, dim);
 524 }
 525
 526
 527 bool InsetMathHull::previewTooSmall(Dimension const & dim) const
 528 {
 529         return dim.width() <= 10 && dim.height() <= 10;
 530 }
 531
 532
 533 ColorCode InsetMathHull::backgroundColor(PainterInfo const & pi) const
 534 {
 535         BufferView const * const bv = pi.base.bv;
 536         if (previewState(bv)) {
 537                 Dimension const dim = dimension(*pi.base.bv);
 538                 if (previewTooSmall(dim))
 539                         return Color_error;
 540                 return graphics::PreviewLoader::backgroundColor();
 541         }
 542         return Color_mathbg;
 543 }
 544
 545
 546 void InsetMathHull::drawBackground(PainterInfo & pi, int x, int y) const
 547 {
 548         Dimension const dim = dimension(*pi.base.bv);
 549         if (previewTooSmall(dim)) {
 550                 pi.pain.fillRectangle(x, y - 2 * ERROR_FRAME_WIDTH,
 551                     dim.wid, dim.asc + dim.des, backgroundColor(pi));
 552                 return;
 553         }
 554         pi.pain.fillRectangle(x + 1, y - dim.asc + 1, dim.wid - 2,
 555                         dim.asc + dim.des - 1, pi.backgroundColor(this));
 556 }
 557
 558
 559 void InsetMathHull::draw(PainterInfo & pi, int x, int y) const
 560 {
 561         BufferView const * const bv = pi.base.bv;
 562
 563         if (type_ == hullRegexp) {
 564                 Dimension const dim = dimension(*bv);
 565                 pi.pain.rectangle(x + 1, y - dim.ascent() + 1,
 566                         dim.width() - 2, dim.height() - 2, Color_regexpframe);
 567         }
 568
 569         if (previewState(bv)) {
 570                 Dimension const dim = dimension(*bv);
 571                 if (previewTooSmall(dim)) {
 572                         // we have an extra frame
 573                         preview_->draw(pi, x + ERROR_FRAME_WIDTH, y);
 574                 } else {
 575                         // one pixel gap in front
 576                         preview_->draw(pi, x + 1, y);
 577                 }
 578                 setPosCache(pi, x, y);
 579                 return;
 580         }
 581
 582         ColorCode color = pi.selected && lyxrc.use_system_colors
 583                                 ? Color_selectiontext : standardColor();
 584         bool const really_change_color = pi.base.font.color() == Color_none;
 585         Changer dummy0 = pi.base.font.changeColor(color, really_change_color);
 586         Changer dummy1 = pi.base.changeFontSet(standardFont());
 587         Changer dummy2 = pi.base.changeStyle(display() ? LM_ST_DISPLAY : LM_ST_TEXT);
 588
 589         InsetMathGrid::draw(pi, x + 1, y);
 590
 591         if (numberedType()) {
 592                 int const xx = x + colinfo_.back().offset_ + colinfo_.back().width_ + 20;
 593                 for (row_type row = 0; row < nrows(); ++row) {
 594                         int const yy = y + rowinfo_[row].offset_;
 595                         Changer dummy = pi.base.changeFontSet(from_ascii("mathrm"));
 596                         docstring const nl = nicelabel(row);
 597                         pi.draw(xx, yy, nl);
 598                 }
 599         }
 600         setPosCache(pi, x, y);
 601 }
 602
 603
 604 void InsetMathHull::metricsT(TextMetricsInfo const & mi, Dimension & dim) const
 605 {
 606         if (display()) {
 607                 InsetMathGrid::metricsT(mi, dim);
 608         } else {
 609                 odocstringstream os;
 610                 TexRow texrow(false);
 611                 otexrowstream ots(os,texrow);
 612                 WriteStream wi(ots, false, true, WriteStream::wsDefault);
 613                 write(wi);
 614                 dim.wid = os.str().size();
 615                 dim.asc = 1;
 616                 dim.des = 0;
 617         }
 618 }
 619
 620
 621 void InsetMathHull::drawT(TextPainter & pain, int x, int y) const
 622 {
 623         if (display()) {
 624                 InsetMathGrid::drawT(pain, x, y);
 625         } else {
 626                 odocstringstream os;
 627                 TexRow texrow(false);
 628                 otexrowstream ots(os,texrow);
 629                 WriteStream wi(ots, false, true, WriteStream::wsDefault);
 630                 write(wi);
 631                 pain.draw(x, y, os.str().c_str());
 632         }
 633 }
 634
 635
 636 static docstring latexString(InsetMathHull const & inset)
 637 {
 638         odocstringstream ls;
 639         // This has to be static, because a preview snippet or a math
 640         // macro containing math in text mode (such as $\text{$\phi$}$ or
 641         // \newcommand{\xxx}{\text{$\phi$}}) gets processed twice. The
 642         // first time as a whole, and the second time only the inner math.
 643         // In this last case inset.buffer() would be invalid.
 644         static Encoding const * encoding = 0;
 645         if (inset.isBufferValid())
 646                 encoding = &(inset.buffer().params().encoding());
 647         TexRow texrow(false);
 648         otexrowstream ots(ls,texrow);
 649         WriteStream wi(ots, false, true, WriteStream::wsPreview, encoding);
 650         inset.write(wi);
 651         return ls.str();
 652 }
 653
 654
 655 void InsetMathHull::initUnicodeMath() const
 656 {
 657         // Trigger classification of the unicode symbols in this inset
 658         docstring const dummy = latexString(*this);
 659 }
 660
 661
 662 void InsetMathHull::addPreview(DocIterator const & inset_pos,
 663         graphics::PreviewLoader & /*ploader*/) const
 664 {
 665         if (RenderPreview::previewMath()) {
 666                 preparePreview(inset_pos);
 667         }
 668 }
 669
 670
 671 void InsetMathHull::usedMacros(MathData const & md, DocIterator const & pos,
 672                                MacroNameSet & macros, MacroNameSet & defs) const
 673 {
 674         MacroNameSet::iterator const end = macros.end();
 675
 676         for (size_t i = 0; i < md.size(); ++i) {
 677                 MathMacro const * mi = md[i].nucleus()->asMacro();
 678                 MathMacroTemplate const * mt = md[i].nucleus()->asMacroTemplate();
 679                 InsetMathScript const * si = md[i].nucleus()->asScriptInset();
 680                 InsetMathFracBase const * fi = md[i].nucleus()->asFracBaseInset();
 681                 InsetMathGrid const * gi = md[i].nucleus()->asGridInset();
 682                 InsetMathNest const * ni = md[i].nucleus()->asNestInset();
 683                 if (mi) {
 684                         // Look for macros in the arguments of this macro.
 685                         for (idx_type idx = 0; idx < mi->nargs(); ++idx)
 686                                 usedMacros(mi->cell(idx), pos, macros, defs);
 687                         // Make sure this is a macro defined in the document
 688                         // (as we also spot the macros in the symbols file)
 689                         // or that we have not already accounted for it.
 690                         docstring const name = mi->name();
 691                         if (macros.find(name) == end)
 692                                 continue;
 693                         macros.erase(name);
 694                         // Look for macros in the definition of this macro.
 695                         MathData ar(pos.buffer());
 696                         MacroData const * data =
 697                                 pos.buffer()->getMacro(name, pos, true);
 698                         if (data) {
 699                                 odocstringstream macro_def;
 700                                 data->write(macro_def, true);
 701                                 macro_def << endl;
 702                                 defs.insert(macro_def.str());
 703                                 asArray(data->definition(), ar);
 704                         }
 705                         usedMacros(ar, pos, macros, defs);
 706                 } else if (mt) {
 707                         MathData ar(pos.buffer());
 708                         asArray(mt->definition(), ar);
 709                         usedMacros(ar, pos, macros, defs);
 710                 } else if (si) {
 711                         if (!si->nuc().empty())
 712                                 usedMacros(si->nuc(), pos, macros, defs);
 713                         if (si->hasDown())
 714                                 usedMacros(si->down(), pos, macros, defs);
 715                         if (si->hasUp())
 716                                 usedMacros(si->up(), pos, macros, defs);
 717                 } else if (fi || gi) {
 718                         idx_type nidx = fi ? fi->nargs() : gi->nargs();
 719                         for (idx_type idx = 0; idx < nidx; ++idx)
 720                                 usedMacros(fi ? fi->cell(idx) : gi->cell(idx),
 721                                            pos, macros, defs);
 722                 } else if (ni) {
 723                         usedMacros(ni->cell(0), pos, macros, defs);
 724                 }
 725         }
 726 }
 727
 728
 729 void InsetMathHull::preparePreview(DocIterator const & pos,
 730                                    bool forexport) const
 731 {
 732         // there is no need to do all the macro stuff if we're not
 733         // actually going to generate the preview.
 734         if (!RenderPreview::previewMath() && !forexport)
 735                 return;
 736
 737         Buffer const * buffer = pos.buffer();
 738
 739         // collect macros at this position
 740         MacroNameSet macros;
 741         buffer->listMacroNames(macros);
 742
 743         // collect definitions only for the macros used in this inset
 744         MacroNameSet defs;
 745         for (idx_type idx = 0; idx < nargs(); ++idx)
 746                 usedMacros(cell(idx), pos, macros, defs);
 747
 748         MacroNameSet::iterator it = defs.begin();
 749         MacroNameSet::iterator end = defs.end();
 750         docstring macro_preamble;
 751         for (; it != end; ++it)
 752                 macro_preamble.append(*it);
 753
 754         // set the font series and size for this snippet
 755         DocIterator dit = pos.getInnerText();
 756         Paragraph const & par = dit.paragraph();
 757         Font font = par.getFontSettings(buffer->params(), dit.pos());
 758         font.fontInfo().realize(par.layout().font);
 759         string const lsize = font.latexSize();
 760         docstring setfont;
 761         docstring endfont;
 762         if (font.fontInfo().series() == BOLD_SERIES) {
 763                 setfont += from_ascii("\\textbf{");
 764                 endfont += '}';
 765         }
 766         if (lsize != "normalsize" && !prefixIs(lsize, "error"))
 767                 setfont += from_ascii("\\" + lsize + '\n');
 768
 769         docstring setcnt;
 770         if (forexport && haveNumbers()) {
 771                 docstring eqstr = from_ascii("equation");
 772                 CounterMap::const_iterator it = counter_map.find(eqstr);
 773                 if (it != counter_map.end()) {
 774                         int num = it->second;
 775                         if (num >= 0)
 776                                 setcnt += from_ascii("\\setcounter{") + eqstr + '}' +
 777                                           '{' + convert<docstring>(num) + '}' + '\n';
 778                 }
 779                 for (size_t i = 0; i != numcnts; ++i) {
 780                         docstring cnt = from_ascii(counters_to_save[i]);
 781                         it = counter_map.find(cnt);
 782                         if (it == counter_map.end())
 783                                         continue;
 784                         int num = it->second;
 785                         if (num > 0)
 786                                 setcnt += from_ascii("\\setcounter{") + cnt + '}' +
 787                                           '{' + convert<docstring>(num) + '}';
 788                 }
 789         }
 790         docstring const snippet = macro_preamble + setfont + setcnt
 791                                   + latexString(*this) + endfont;
 792         LYXERR(Debug::MACROS, "Preview snippet: " << snippet);
 793         preview_->addPreview(snippet, *buffer, forexport);
 794 }
 795
 796
 797 void InsetMathHull::reloadPreview(DocIterator const & pos) const
 798 {
 799         preparePreview(pos);
 800         preview_->startLoading(*pos.buffer());
 801 }
 802
 803
 804 void InsetMathHull::loadPreview(DocIterator const & pos) const
 805 {
 806         bool const forexport = true;
 807         preparePreview(pos, forexport);
 808         preview_->startLoading(*pos.buffer(), forexport);
 809 }
 810
 811
 812 bool InsetMathHull::notifyCursorLeaves(Cursor const & old, Cursor & cur)
 813 {
 814         if (RenderPreview::previewMath()) {
 815                 reloadPreview(old);
 816                 cur.screenUpdateFlags(Update::Force);
 817         }
 818         return false;
 819 }
 820
 821
 822 docstring InsetMathHull::label(row_type row) const
 823 {
 824         LASSERT(row < nrows(), return docstring());
 825         if (InsetLabel * il = label_[row])
 826                 return il->screenLabel();
 827         return docstring();
 828 }
 829
 830
 831 void InsetMathHull::label(row_type row, docstring const & label)
 832 {
 833         //lyxerr << "setting label '" << label << "' for row " << row << endl;
 834         if (label_[row]) {
 835                 if (label.empty()) {
 836                         delete label_[row];
 837                         label_[row] = dummy_pointer;
 838                 } else {
 839                         if (buffer_)
 840                                 label_[row]->updateLabelAndRefs(label);
 841                         else
 842                                 label_[row]->setParam("name", label);
 843                 }
 844                 return;
 845         }
 846         InsetCommandParams p(LABEL_CODE);
 847         p["name"] = label;
 848         label_[row] = new InsetLabel(buffer_, p);
 849         if (buffer_)
 850                 label_[row]->setBuffer(buffer());
 851 }
 852
 853
 854 void InsetMathHull::numbered(row_type row, Numbered num)
 855 {
 856         numbered_[row] = num;
 857         if (!numbered(row) && label_[row]) {
 858                 delete label_[row];
 859                 label_[row] = 0;
 860         }
 861 }
 862
 863
 864 bool InsetMathHull::numbered(row_type row) const
 865 {
 866         return numbered_[row] == NUMBER;
 867 }
 868
 869
 870 bool InsetMathHull::ams() const
 871 {
 872         switch (type_) {
 873         case hullAlign:
 874         case hullFlAlign:
 875         case hullMultline:
 876         case hullGather:
 877         case hullAlignAt:
 878         case hullXAlignAt:
 879         case hullXXAlignAt:
 880                 return true;
 881         case hullUnknown:
 882         case hullRegexp:
 883                 return false;
 884         case hullNone:
 885         case hullSimple:
 886         case hullEquation:
 887         case hullEqnArray:
 888                 break;
 889         }
 890         for (size_t row = 0; row < numbered_.size(); ++row)
 891                 if (numbered_[row] == NOTAG)
 892                         return true;
 893         return false;
 894 }
 895
 896
 897 Inset::DisplayType InsetMathHull::display() const
 898 {
 899         switch (type_) {
 900         case hullUnknown:
 901         case hullSimple:
 902         case hullNone:
 903         case hullRegexp:
 904                 return Inline;
 905         case hullEqnArray:
 906         case hullAlign:
 907         case hullFlAlign:
 908         case hullAlignAt:
 909         case hullXAlignAt:
 910         case hullXXAlignAt:
 911         case hullEquation:
 912         case hullMultline:
 913         case hullGather:
 914                 return AlignCenter;
 915         }
 916         // avoid warning
 917         return AlignCenter;
 918 }
 919
 920 bool InsetMathHull::numberedType() const
 921 {
 922         switch (type_) {
 923         case hullUnknown:
 924         case hullNone:
 925         case hullSimple:
 926         case hullXXAlignAt:
 927         case hullRegexp:
 928                 return false;
 929         case hullEqnArray:
 930         case hullAlign:
 931         case hullFlAlign:
 932         case hullAlignAt:
 933         case hullXAlignAt:
 934         case hullEquation:
 935         case hullMultline:
 936         case hullGather:
 937                 break;
 938         }
 939         for (row_type row = 0; row < nrows(); ++row)
 940                 if (numbered(row))
 941                         return true;
 942         return false;
 943 }
 944
 945
 946 void InsetMathHull::validate(LaTeXFeatures & features) const
 947 {
 948         if (features.runparams().isLaTeX()) {
 949                 if (ams())
 950                         features.require("amsmath");
 951
 952                 if (type_ == hullRegexp) {
 953                         features.require("color");
 954                         string frcol = lcolor.getLaTeXName(Color_regexpframe);
 955                         string bgcol = "white";
 956                         features.addPreambleSnippet(
 957                                 string("\\newcommand{\\regexp}[1]{\\fcolorbox{")
 958                                 + frcol + string("}{")
 959                                 + bgcol + string("}{\\ensuremath{\\mathtt{#1}}}}"));
 960                         features.addPreambleSnippet(
 961                                 string("\\newcommand{\\endregexp}{}"));
 962                 }
 963
 964                 // Validation is necessary only if not using AMS math.
 965                 // To be safe, we will always run mathedvalidate.
 966                 //if (features.amsstyle)
 967                 //  return;
 968
 969                 //features.binom      = true;
 970         } else if (features.runparams().math_flavor == OutputParams::MathAsHTML) {
 971                 // it would be better to do this elsewhere, but we can't validate in
 972                 // InsetMathMatrix and we have no way, outside MathExtern, to know if
 973                 // we even have any matrices.
 974                                 features.addCSSSnippet(
 975                                         "table.matrix{display: inline-block; vertical-align: middle; text-align:center;}\n"
 976                                         "table.matrix td{padding: 0.25px;}\n"
 977                                         "td.ldelim{width: 0.5ex; border: thin solid black; border-right: none;}\n"
 978                                         "td.rdelim{width: 0.5ex; border: thin solid black; border-left: none;}");
 979         }
 980         InsetMathGrid::validate(features);
 981 }
 982
 983
 984 void InsetMathHull::header_write(WriteStream & os) const
 985 {
 986         bool n = numberedType();
 987
 988         switch(type_) {
 989         case hullNone:
 990                 break;
 991
 992         case hullSimple:
 993                 os << '$';
 994                 os.startOuterRow();
 995                 if (cell(0).empty())
 996                         os << ' ';
 997                 break;
 998
 999         case hullEquation:
1000                 os << "\n";
1001                 os.startOuterRow();
1002                 if (n)
1003                         os << "\\begin{equation" << star(n) << "}\n";
1004                 else
1005                         os << "\\[\n";
1006                 break;
1007
1008         case hullEqnArray:
1009         case hullAlign:
1010         case hullFlAlign:
1011         case hullGather:
1012         case hullMultline:
1013                 os << "\n";
1014                 os.startOuterRow();
1015                 os << "\\begin{" << hullName(type_) << star(n) << "}\n";
1016                 break;
1017
1018         case hullAlignAt:
1019         case hullXAlignAt:
1020                 os << "\n";
1021                 os.startOuterRow();
1022                 os << "\\begin{" << hullName(type_) << star(n) << '}'
1023                   << '{' << static_cast<unsigned int>((ncols() + 1)/2) << "}\n";
1024                 break;
1025
1026         case hullXXAlignAt:
1027                 os << "\n";
1028                 os.startOuterRow();
1029                 os << "\\begin{" << hullName(type_) << '}'
1030                   << '{' << static_cast<unsigned int>((ncols() + 1)/2) << "}\n";
1031                 break;
1032
1033         case hullRegexp:
1034                 os << "\\regexp{";
1035                 break;
1036
1037         case hullUnknown:
1038                 os << "\n";
1039                 os.startOuterRow();
1040                 os << "\\begin{unknown" << star(n) << "}\n";
1041                 break;
1042         }
1043 }
1044
1045
1046 void InsetMathHull::footer_write(WriteStream & os) const
1047 {
1048         bool n = numberedType();
1049
1050         switch(type_) {
1051         case hullNone:
1052                 os << "\n";
1053                 break;
1054
1055         case hullSimple:
1056                 os << '$';
1057                 break;
1058
1059         case hullEquation:
1060                 os << "\n";
1061                 os.startOuterRow();
1062                 if (n)
1063                         os << "\\end{equation" << star(n) << "}\n";
1064                 else
1065                         os << "\\]\n";
1066                 break;
1067
1068         case hullEqnArray:
1069         case hullAlign:
1070         case hullFlAlign:
1071         case hullAlignAt:
1072         case hullXAlignAt:
1073         case hullGather:
1074         case hullMultline:
1075                 os << "\n";
1076                 os.startOuterRow();
1077                 os << "\\end{" << hullName(type_) << star(n) << "}\n";
1078                 break;
1079
1080         case hullXXAlignAt:
1081                 os << "\n";
1082                 os.startOuterRow();
1083                 os << "\\end{" << hullName(type_) << "}\n";
1084                 break;
1085
1086         case hullRegexp:
1087                 // Only used as a heuristic to find the regexp termination, when searching in ignore-format mode
1088                 os << "\\endregexp{}}";
1089                 break;
1090
1091         case hullUnknown:
1092                 os << "\n";
1093                 os.startOuterRow();
1094                 os << "\\end{unknown" << star(n) << "}\n";
1095                 break;
1096         }
1097 }
1098
1099
1100 bool InsetMathHull::allowsTabularFeatures() const
1101 {
1102         switch (type_) {
1103         case hullEqnArray:
1104         case hullAlign:
1105         case hullAlignAt:
1106         case hullXAlignAt:
1107         case hullXXAlignAt:
1108         case hullFlAlign:
1109         case hullMultline:
1110         case hullGather:
1111                 return true;
1112         case hullNone:
1113         case hullSimple:
1114         case hullEquation:
1115         case hullRegexp:
1116         case hullUnknown:
1117                 break;
1118         }
1119         return false;
1120 }
1121
1122
1123 bool InsetMathHull::rowChangeOK() const
1124 {
1125         return
1126                 type_ == hullEqnArray || type_ == hullAlign ||
1127                 type_ == hullFlAlign || type_ == hullAlignAt ||
1128                 type_ == hullXAlignAt || type_ == hullXXAlignAt ||
1129                 type_ == hullGather || type_ == hullMultline;
1130 }
1131
1132
1133 bool InsetMathHull::colChangeOK() const
1134 {
1135         return
1136                 type_ == hullAlign || type_ == hullFlAlign ||type_ == hullAlignAt ||
1137                 type_ == hullXAlignAt || type_ == hullXXAlignAt;
1138 }
1139
1140
1141 void InsetMathHull::addRow(row_type row)
1142 {
1143         if (!rowChangeOK())
1144                 return;
1145
1146         bool numbered = numberedType();
1147         // Move the number and raw pointer, do not call label() (bug 7511)
1148         InsetLabel * label = dummy_pointer;
1149         docstring number = empty_docstring();
1150         if (type_ == hullMultline) {
1151                 if (row + 1 == nrows())  {
1152                         numbered_[row] = NONUMBER;
1153                         swap(label, label_[row]);
1154                         swap(number, numbers_[row]);
1155                 } else
1156                         numbered = false;
1157         }
1158
1159         numbered_.insert(numbered_.begin() + row + 1, numbered ? NUMBER : NONUMBER);
1160         numbers_.insert(numbers_.begin() + row + 1, number);
1161         label_.insert(label_.begin() + row + 1, label);
1162         InsetMathGrid::addRow(row);
1163 }
1164
1165
1166 void InsetMathHull::swapRow(row_type row)
1167 {
1168         if (nrows() <= 1)
1169                 return;
1170         if (row + 1 == nrows())
1171                 --row;
1172         swap(numbered_[row], numbered_[row + 1]);
1173         swap(numbers_[row], numbers_[row + 1]);
1174         swap(label_[row], label_[row + 1]);
1175         InsetMathGrid::swapRow(row);
1176 }
1177
1178
1179 void InsetMathHull::delRow(row_type row)
1180 {
1181         if (nrows() <= 1 || !rowChangeOK())
1182                 return;
1183         if (row + 1 == nrows() && type_ == hullMultline) {
1184                 swap(numbered_[row - 1], numbered_[row]);
1185                 swap(numbers_[row - 1], numbers_[row]);
1186                 swap(label_[row - 1], label_[row]);
1187                 InsetMathGrid::delRow(row);
1188                 return;
1189         }
1190         InsetMathGrid::delRow(row);
1191         // The last dummy row has no number info nor a label.
1192         // Test nrows() + 1 because we have already erased the row.
1193         if (row == nrows() + 1)
1194                 row--;
1195         numbered_.erase(numbered_.begin() + row);
1196         numbers_.erase(numbers_.begin() + row);
1197         delete label_[row];
1198         label_.erase(label_.begin() + row);
1199 }
1200
1201
1202 void InsetMathHull::addCol(col_type col)
1203 {
1204         if (!colChangeOK())
1205                 return;
1206         InsetMathGrid::addCol(col);
1207 }
1208
1209
1210 void InsetMathHull::delCol(col_type col)
1211 {
1212         if (ncols() <= 1 || !colChangeOK())
1213                 return;
1214         InsetMathGrid::delCol(col);
1215 }
1216
1217
1218 docstring InsetMathHull::nicelabel(row_type row) const
1219 {
1220         if (!numbered(row))
1221                 return docstring();
1222         docstring const & val = numbers_[row];
1223         if (!label_[row])
1224                 return '(' + val + ')';
1225         return '(' + val + ',' + label_[row]->screenLabel() + ')';
1226 }
1227
1228
1229 void InsetMathHull::glueall(HullType type)
1230 {
1231         MathData ar;
1232         for (idx_type i = 0; i < nargs(); ++i)
1233                 ar.append(cell(i));
1234         InsetLabel * label = 0;
1235         if (type == hullEquation) {
1236                 // preserve first non-empty label
1237                 for (row_type row = 0; row < nrows(); ++row) {
1238                         if (label_[row]) {
1239                                 label = label_[row];
1240                                 label_[row] = 0;
1241                                 break;
1242                         }
1243                 }
1244         }
1245         *this = InsetMathHull(buffer_, hullSimple);
1246         label_[0] = label;
1247         cell(0) = ar;
1248         setDefaults();
1249 }
1250
1251
1252 void InsetMathHull::splitTo2Cols()
1253 {
1254         LASSERT(ncols() == 1, return);
1255         InsetMathGrid::addCol(1);
1256         for (row_type row = 0; row < nrows(); ++row) {
1257                 idx_type const i = 2 * row;
1258                 pos_type pos = firstRelOp(cell(i));
1259                 cell(i + 1) = MathData(buffer_, cell(i).begin() + pos, cell(i).end());
1260                 cell(i).erase(pos, cell(i).size());
1261         }
1262 }
1263
1264
1265 void InsetMathHull::splitTo3Cols()
1266 {
1267         LASSERT(ncols() < 3, return);
1268         if (ncols() < 2)
1269                 splitTo2Cols();
1270         InsetMathGrid::addCol(2);
1271         for (row_type row = 0; row < nrows(); ++row) {
1272                 idx_type const i = 3 * row + 1;
1273                 if (!cell(i).empty()) {
1274                         cell(i + 1) = MathData(buffer_, cell(i).begin() + 1, cell(i).end());
1275                         cell(i).erase(1, cell(i).size());
1276                 }
1277         }
1278 }
1279
1280
1281 void InsetMathHull::changeCols(col_type cols)
1282 {
1283         if (ncols() == cols)
1284                 return;
1285         else if (ncols() < cols) {
1286                 // split columns
1287                 if (cols < 3)
1288                         splitTo2Cols();
1289                 else {
1290                         splitTo3Cols();
1291                         while (ncols() < cols)
1292                                 InsetMathGrid::addCol(ncols());
1293                 }
1294                 return;
1295         }
1296
1297         // combine columns
1298         for (row_type row = 0; row < nrows(); ++row) {
1299                 idx_type const i = row * ncols();
1300                 for (col_type col = cols; col < ncols(); ++col) {
1301                         cell(i + cols - 1).append(cell(i + col));
1302                 }
1303         }
1304         // delete columns
1305         while (ncols() > cols) {
1306                 InsetMathGrid::delCol(ncols() - 1);
1307         }
1308 }
1309
1310
1311 HullType InsetMathHull::getType() const
1312 {
1313         return type_;
1314 }
1315
1316
1317 void InsetMathHull::setType(HullType type)
1318 {
1319         type_ = type;
1320         setDefaults();
1321 }
1322
1323
1324 bool InsetMathHull::isMutable(HullType type)
1325 {
1326         switch (type) {
1327         case hullNone:
1328         case hullSimple:
1329         case hullEquation:
1330         case hullEqnArray:
1331         case hullAlign:
1332         case hullFlAlign:
1333         case hullAlignAt:
1334         case hullXAlignAt:
1335         case hullXXAlignAt:
1336         case hullMultline:
1337         case hullGather:
1338                 return true;
1339         case hullUnknown:
1340         case hullRegexp:
1341                 return false;
1342         }
1343         // avoid warning
1344         return false;
1345 }
1346
1347
1348 void InsetMathHull::mutate(HullType newtype)
1349 {
1350         //lyxerr << "mutating from '" << type_ << "' to '" << newtype << "'" << endl;
1351
1352         if (newtype == type_)
1353                 return;
1354
1355         // This guards the algorithm below it, which is designed with certain types
1356         // in mind.
1357         if (!isMutable(newtype) || !isMutable(type_)) {
1358                 lyxerr << "mutation from '" << to_utf8(hullName(type_))
1359                        << "' to '" << to_utf8(hullName(newtype))
1360                        << "' not implemented" << endl;
1361                 return;
1362         }
1363
1364         // we try to move along the chain
1365         // none <-> simple <-> equation <-> eqnarray -> *align* -> multline, gather -+
1366         //                                     ^                                     |
1367         //                                     +-------------------------------------+
1368         // we use eqnarray as intermediate type for mutations that are not
1369         // directly supported because it handles labels and numbering for
1370         // "down mutation".
1371
1372         switch (type_) {
1373         case hullNone:
1374                 setType(hullSimple);
1375                 numbered(0, false);
1376                 mutate(newtype);
1377                 break;
1378
1379         case hullSimple:
1380                 if (newtype == hullNone) {
1381                         setType(hullNone);
1382                         numbered(0, false);
1383                 } else {
1384                         setType(hullEquation);
1385                         numbered(0, label_[0] ? true : false);
1386                         mutate(newtype);
1387                 }
1388                 break;
1389
1390         case hullEquation:
1391                 switch (newtype) {
1392                 case hullNone:
1393                 case hullSimple:
1394                         setType(hullSimple);
1395                         numbered(0, false);
1396                         mutate(newtype);
1397                         break;
1398                 case hullEqnArray:
1399                         // split it "nicely" on the first relop
1400                         splitTo3Cols();
1401                         setType(hullEqnArray);
1402                         break;
1403                 case hullMultline:
1404                 case hullGather:
1405                         setType(newtype);
1406                         break;
1407                 default:
1408                         // *align*
1409                         // split it "nicely"
1410                         splitTo2Cols();
1411                         setType(hullAlign);
1412                         mutate(newtype);
1413                         break;
1414                 }
1415                 break;
1416
1417         case hullEqnArray:
1418                 switch (newtype) {
1419                 case hullNone:
1420                 case hullSimple:
1421                 case hullEquation:
1422                         glueall(newtype);
1423                         mutate(newtype);
1424                         break;
1425                 default:
1426                         // align & Co.
1427                         changeCols(2);
1428                         setType(hullAlign);
1429                         mutate(newtype);
1430                         break;
1431                 }
1432                 break;
1433
1434         case hullAlign:
1435         case hullAlignAt:
1436         case hullXAlignAt:
1437         case hullFlAlign:
1438                 switch (newtype) {
1439                 case hullNone:
1440                 case hullSimple:
1441                 case hullEquation:
1442                 case hullEqnArray:
1443                         changeCols(3);
1444                         setType(hullEqnArray);
1445                         mutate(newtype);
1446                         break;
1447                 case hullGather:
1448                 case hullMultline:
1449                         changeCols(1);
1450                         setType(newtype);
1451                         break;
1452                 case hullXXAlignAt:
1453                         for (row_type row = 0; row < nrows(); ++row)
1454                                 numbered(row, false);
1455                         setType(newtype);
1456                         break;
1457                 default:
1458                         setType(newtype);
1459                         break;
1460                 }
1461                 break;
1462
1463         case hullXXAlignAt:
1464                 for (row_type row = 0; row < nrows(); ++row)
1465                         numbered(row, false);
1466                 switch (newtype) {
1467                 case hullNone:
1468                 case hullSimple:
1469                 case hullEquation:
1470                 case hullEqnArray:
1471                         changeCols(3);
1472                         setType(hullEqnArray);
1473                         mutate(newtype);
1474                         break;
1475                 case hullGather:
1476                 case hullMultline:
1477                         changeCols(1);
1478                         setType(newtype);
1479                         break;
1480                 default:
1481                         setType(newtype);
1482                         break;
1483                 }
1484                 break;
1485
1486         case hullMultline:
1487         case hullGather:
1488                 switch (newtype) {
1489                 case hullGather:
1490                 case hullMultline:
1491                         setType(newtype);
1492                         break;
1493                 case hullAlign:
1494                 case hullFlAlign:
1495                 case hullAlignAt:
1496                 case hullXAlignAt:
1497                         splitTo2Cols();
1498                         setType(newtype);
1499                         break;
1500                 case hullXXAlignAt:
1501                         splitTo2Cols();
1502                         for (row_type row = 0; row < nrows(); ++row)
1503                                 numbered(row, false);
1504                         setType(newtype);
1505                         break;
1506                 default:
1507                         // first we mutate to EqnArray
1508                         splitTo3Cols();
1509                         setType(hullEqnArray);
1510                         mutate(newtype);
1511                         break;
1512                 }
1513                 break;
1514
1515         default:
1516                 // we passed the guard so we should not be here
1517                 LASSERT("Mutation not implemented, but should have been.", return);
1518                 break;
1519         }// switch
1520 }
1521
1522
1523 docstring InsetMathHull::eolString(row_type row, bool fragile, bool latex,
1524                 bool last_eoln) const
1525 {
1526         docstring res;
1527         if (numberedType()) {
1528                 if (label_[row] && numbered(row)) {
1529                         docstring const name =
1530                                 latex ? escape(label_[row]->getParam("name"))
1531                                       : label_[row]->getParam("name");
1532                         res += "\\label{" + name + '}';
1533                 }
1534                 if (type_ != hullMultline) {
1535                         if (numbered_[row]  == NONUMBER)
1536                                 res += "\\nonumber ";
1537                         else if (numbered_[row]  == NOTAG)
1538                                 res += "\\notag ";
1539                 }
1540         }
1541         // Never add \\ on the last empty line of eqnarray and friends
1542         last_eoln = false;
1543         return res + InsetMathGrid::eolString(row, fragile, latex, last_eoln);
1544 }
1545
1546 void InsetMathHull::write(WriteStream & os) const
1547 {
1548         ModeSpecifier specifier(os, MATH_MODE);
1549         header_write(os);
1550         InsetMathGrid::write(os);
1551         footer_write(os);
1552 }
1553
1554
1555 void InsetMathHull::normalize(NormalStream & os) const
1556 {
1557         os << "[formula " << hullName(type_) << ' ';
1558         InsetMathGrid::normalize(os);
1559         os << "] ";
1560 }
1561
1562
1563 void InsetMathHull::infoize(odocstream & os) const
1564 {
1565         os << bformat(_("Type: %1$s"), hullName(type_));
1566 }
1567
1568
1569 void InsetMathHull::check() const
1570 {
1571         LATTEST(numbered_.size() == nrows());
1572         LATTEST(numbers_.size() == nrows());
1573         LATTEST(label_.size() == nrows());
1574 }
1575
1576
1577 void InsetMathHull::doExtern(Cursor & cur, FuncRequest & func)
1578 {
1579         docstring dlang;
1580         docstring extra;
1581         idocstringstream iss(func.argument());
1582         iss >> dlang >> extra;
1583         if (extra.empty())
1584                 extra = from_ascii("noextra");
1585         string const lang = to_ascii(dlang);
1586
1587         // replace selection with result of computation
1588         if (reduceSelectionToOneCell(cur)) {
1589                 MathData ar;
1590                 asArray(grabAndEraseSelection(cur), ar);
1591                 lyxerr << "use selection: " << ar << endl;
1592                 cur.insert(pipeThroughExtern(lang, extra, ar));
1593                 return;
1594         }
1595
1596         // only inline, display or eqnarray math is allowed
1597         switch (getType()) {
1598         case hullSimple:
1599         case hullEquation:
1600         case hullEqnArray:
1601                 break;
1602         default:
1603                 frontend::Alert::warning(_("Bad math environment"),
1604                                 _("Computation cannot be performed for AMS "
1605                                   "math environments.\nChange the math "
1606                                   "formula type and try again."));
1607                 return;
1608         }
1609
1610         MathData eq;
1611         eq.push_back(MathAtom(new InsetMathChar('=')));
1612
1613         // go to first item in line
1614         cur.idx() -= cur.idx() % ncols();
1615         cur.pos() = 0;
1616
1617         if (getType() == hullSimple) {
1618                 size_type pos = cur.cell().find_last(eq);
1619                 MathData ar;
1620                 if (pos == cur.cell().size()) {
1621                         ar = cur.cell();
1622                         lyxerr << "use whole cell: " << ar << endl;
1623                 } else {
1624                         ar = MathData(buffer_, cur.cell().begin() + pos + 1, cur.cell().end());
1625                         lyxerr << "use partial cell form pos: " << pos << endl;
1626                 }
1627                 cur.cell().append(eq);
1628                 cur.cell().append(pipeThroughExtern(lang, extra, ar));
1629                 cur.pos() = cur.lastpos();
1630                 return;
1631         }
1632
1633         if (getType() == hullEquation) {
1634                 lyxerr << "use equation inset" << endl;
1635                 mutate(hullEqnArray);
1636                 MathData & ar = cur.cell();
1637                 lyxerr << "use cell: " << ar << endl;
1638                 ++cur.idx();
1639                 cur.cell() = eq;
1640                 ++cur.idx();
1641                 cur.cell() = pipeThroughExtern(lang, extra, ar);
1642                 // move to end of line
1643                 cur.pos() = cur.lastpos();
1644                 return;
1645         }
1646
1647         {
1648                 lyxerr << "use eqnarray" << endl;
1649                 cur.idx() += 2 - cur.idx() % ncols();
1650                 cur.pos() = 0;
1651                 MathData ar = cur.cell();
1652                 lyxerr << "use cell: " << ar << endl;
1653                 // FIXME: temporarily disabled
1654                 addRow(cur.row());
1655                 ++cur.idx();
1656                 ++cur.idx();
1657                 cur.cell() = eq;
1658                 ++cur.idx();
1659                 cur.cell() = pipeThroughExtern(lang, extra, ar);
1660                 cur.pos() = cur.lastpos();
1661         }
1662 }
1663
1664
1665 void InsetMathHull::doDispatch(Cursor & cur, FuncRequest & cmd)
1666 {
1667         //lyxerr << "action: " << cmd.action() << endl;
1668         switch (cmd.action()) {
1669
1670         case LFUN_FINISHED_BACKWARD:
1671         case LFUN_FINISHED_FORWARD:
1672         case LFUN_FINISHED_RIGHT:
1673         case LFUN_FINISHED_LEFT:
1674                 //lyxerr << "action: " << cmd.action() << endl;
1675                 InsetMathGrid::doDispatch(cur, cmd);
1676                 break;
1677
1678         case LFUN_PARAGRAPH_BREAK:
1679                 // just swallow this
1680                 break;
1681
1682         case LFUN_NEWLINE_INSERT:
1683                 // some magic for the common case
1684                 if (type_ == hullSimple || type_ == hullEquation) {
1685                         cur.recordUndoInset();
1686                         bool const align =
1687                                 cur.bv().buffer().params().use_package("amsmath") != BufferParams::package_off;
1688                         mutate(align ? hullAlign : hullEqnArray);
1689                         // mutate() may change labels and such.
1690                         cur.forceBufferUpdate();
1691                         cur.idx() = nrows() * ncols() - 1;
1692                         cur.pos() = cur.lastpos();
1693                 }
1694                 InsetMathGrid::doDispatch(cur, cmd);
1695                 break;
1696
1697         case LFUN_MATH_NUMBER_TOGGLE: {
1698                 //lyxerr << "toggling all numbers" << endl;
1699                 cur.recordUndoInset();
1700                 bool old = numberedType();
1701                 if (type_ == hullMultline)
1702                         numbered(nrows() - 1, !old);
1703                 else
1704                         for (row_type row = 0; row < nrows(); ++row)
1705                                 numbered(row, !old);
1706
1707                 cur.message(old ? _("No number") : _("Number"));
1708                 cur.forceBufferUpdate();
1709                 break;
1710         }
1711
1712         case LFUN_MATH_NUMBER_LINE_TOGGLE: {
1713                 cur.recordUndoInset();
1714                 row_type r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1715                 bool old = numbered(r);
1716                 cur.message(old ? _("No number") : _("Number"));
1717                 numbered(r, !old);
1718                 cur.forceBufferUpdate();
1719                 break;
1720         }
1721
1722         case LFUN_LABEL_INSERT: {
1723                 row_type r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1724                 docstring old_label = label(r);
1725                 docstring const default_label = from_ascii("eq:");
1726                 if (old_label.empty())
1727                         old_label = default_label;
1728
1729                 InsetCommandParams p(LABEL_CODE);
1730                 p["name"] = cmd.argument().empty() ? old_label : cmd.argument();
1731                 string const data = InsetCommand::params2string(p);
1732
1733                 if (cmd.argument().empty())
1734                         cur.bv().showDialog("label", data);
1735                 else {
1736                         FuncRequest fr(LFUN_INSET_INSERT, data);
1737                         dispatch(cur, fr);
1738                 }
1739                 break;
1740         }
1741
1742         case LFUN_LABEL_COPY_AS_REFERENCE: {
1743                 row_type row;
1744                 if (cmd.argument().empty() && &cur.inset() == this)
1745                         // if there is no argument and we're inside math, we retrieve
1746                         // the row number from the cursor position.
1747                         row = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1748                 else {
1749                         // if there is an argument, find the corresponding label, else
1750                         // check whether there is at least one label.
1751                         for (row = 0; row != nrows(); ++row)
1752                                 if (numbered(row) && label_[row]
1753                                           && (cmd.argument().empty() || label(row) == cmd.argument()))
1754                                         break;
1755                 }
1756
1757                 if (row == nrows())
1758                         break;
1759
1760                 InsetCommandParams p(REF_CODE, "ref");
1761                 p["reference"] = label(row);
1762                 cap::clearSelection();
1763                 cap::copyInset(cur, new InsetRef(buffer_, p), label(row));
1764                 break;
1765         }
1766
1767         case LFUN_WORD_DELETE_FORWARD:
1768         case LFUN_CHAR_DELETE_FORWARD:
1769                 if (col(cur.idx()) + 1 == ncols()
1770                     && cur.pos() == cur.lastpos()
1771                     && !cur.selection()) {
1772                         if (!label(row(cur.idx())).empty()) {
1773                                 cur.recordUndoInset();
1774                                 label(row(cur.idx()), docstring());
1775                         } else if (numbered(row(cur.idx()))) {
1776                                 cur.recordUndoInset();
1777                                 numbered(row(cur.idx()), false);
1778                                 cur.forceBufferUpdate();
1779                         } else {
1780                                 InsetMathGrid::doDispatch(cur, cmd);
1781                                 return;
1782                         }
1783                 } else {
1784                         InsetMathGrid::doDispatch(cur, cmd);
1785                         return;
1786                 }
1787                 break;
1788
1789         case LFUN_INSET_INSERT: {
1790                 //lyxerr << "arg: " << to_utf8(cmd.argument()) << endl;
1791                 // FIXME: this should be cleaned up to use InsetLabel methods directly.
1792                 string const name = cmd.getArg(0);
1793                 if (name == "label") {
1794                         InsetCommandParams p(LABEL_CODE);
1795                         InsetCommand::string2params(to_utf8(cmd.argument()), p);
1796                         docstring str = p["name"];
1797                         cur.recordUndoInset();
1798                         row_type const r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1799                         str = trim(str);
1800                         if (!str.empty())
1801                                 numbered(r, true);
1802                         docstring old = label(r);
1803                         if (str != old) {
1804                                 if (label_[r])
1805                                         // The label will take care of the reference update.
1806                                         label(r, str);
1807                                 else {
1808                                         label(r, str);
1809                                         // Newly created inset so initialize it.
1810                                         label_[r]->initView();
1811                                 }
1812                         }
1813                         cur.forceBufferUpdate();
1814                         break;
1815                 }
1816                 InsetMathGrid::doDispatch(cur, cmd);
1817                 return;
1818         }
1819
1820         case LFUN_MATH_EXTERN:
1821                 cur.recordUndoInset();
1822                 doExtern(cur, cmd);
1823                 break;
1824
1825         case LFUN_MATH_MUTATE: {
1826                 cur.recordUndoInset();
1827                 row_type row = cur.row();
1828                 col_type col = cur.col();
1829                 mutate(hullType(cmd.argument()));
1830                 cur.idx() = row * ncols() + col;
1831                 if (cur.idx() > cur.lastidx()) {
1832                         cur.idx() = cur.lastidx();
1833                         cur.pos() = cur.lastpos();
1834                 }
1835                 if (cur.pos() > cur.lastpos())
1836                         cur.pos() = cur.lastpos();
1837
1838                 cur.forceBufferUpdate();
1839                 // FIXME: find some more clever handling of the selection,
1840                 // i.e. preserve it.
1841                 cur.clearSelection();
1842                 //cur.dispatched(FINISHED);
1843                 break;
1844         }
1845
1846         case LFUN_MATH_DISPLAY: {
1847                 cur.recordUndoInset();
1848                 mutate(type_ == hullSimple ? hullEquation : hullSimple);
1849                 // if the cursor is in a cell that got merged, move it to
1850                 // start of the hull inset.
1851                 if (cur.idx() > 0) {
1852                         cur.idx() = 0;
1853                         cur.pos() = 0;
1854                 }
1855                 if (cur.pos() > cur.lastpos())
1856                         cur.pos() = cur.lastpos();
1857
1858                 break;
1859         }
1860
1861         case LFUN_TABULAR_FEATURE:
1862                 if (!allowsTabularFeatures())
1863                         cur.undispatched();
1864                 else
1865                         InsetMathGrid::doDispatch(cur, cmd);
1866                 break;
1867
1868         default:
1869                 InsetMathGrid::doDispatch(cur, cmd);
1870                 break;
1871         }
1872 }
1873
1874
1875 namespace {
1876
1877 bool allowDisplayMath(Cursor const & cur)
1878 {
1879         LATTEST(cur.depth() > 1);
1880         Cursor tmpcur = cur;
1881         tmpcur.pop();
1882         FuncStatus status;
1883         FuncRequest cmd(LFUN_MATH_DISPLAY);
1884         return tmpcur.getStatus(cmd, status) && status.enabled();
1885 }
1886
1887 }
1888
1889
1890 bool InsetMathHull::getStatus(Cursor & cur, FuncRequest const & cmd,
1891                 FuncStatus & status) const
1892 {
1893         switch (cmd.action()) {
1894         case LFUN_FINISHED_BACKWARD:
1895         case LFUN_FINISHED_FORWARD:
1896         case LFUN_FINISHED_RIGHT:
1897         case LFUN_FINISHED_LEFT:
1898         case LFUN_UP:
1899         case LFUN_DOWN:
1900         case LFUN_NEWLINE_INSERT:
1901         case LFUN_MATH_EXTERN:
1902                 // we handle these
1903                 status.setEnabled(true);
1904                 return true;
1905
1906         // we never allow this in math, and we want to bind enter
1907         // to another actions in command-alternatives
1908         case LFUN_PARAGRAPH_BREAK:
1909                 status.setEnabled(false);
1910                 return true;
1911         case LFUN_MATH_MUTATE: {
1912                 HullType const ht = hullType(cmd.argument());
1913                 status.setOnOff(type_ == ht);
1914                 status.setEnabled(isMutable(ht) && isMutable(type_));
1915
1916                 if (ht != hullSimple && status.enabled())
1917                         status.setEnabled(allowDisplayMath(cur));
1918                 return true;
1919         }
1920         case LFUN_MATH_DISPLAY: {
1921                 status.setEnabled(display() != Inline || allowDisplayMath(cur));
1922                 status.setOnOff(display() != Inline);
1923                 return true;
1924         }
1925
1926         case LFUN_MATH_NUMBER_TOGGLE:
1927                 // FIXME: what is the right test, this or the one of
1928                 // LABEL_INSERT?
1929                 status.setEnabled(display() != Inline);
1930                 status.setOnOff(numberedType());
1931                 return true;
1932
1933         case LFUN_MATH_NUMBER_LINE_TOGGLE: {
1934                 // FIXME: what is the right test, this or the one of
1935                 // LABEL_INSERT?
1936                 bool const enable = (type_ == hullMultline)
1937                         ? (nrows() - 1 == cur.row())
1938                         : display() != Inline;
1939                 row_type const r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1940                 status.setEnabled(enable);
1941                 status.setOnOff(enable && numbered(r));
1942                 return true;
1943         }
1944
1945         case LFUN_LABEL_INSERT:
1946                 status.setEnabled(type_ != hullSimple);
1947                 return true;
1948
1949         case LFUN_LABEL_COPY_AS_REFERENCE: {
1950                 bool enabled = false;
1951                 row_type row;
1952                 if (cmd.argument().empty() && &cur.inset() == this) {
1953                         // if there is no argument and we're inside math, we retrieve
1954                         // the row number from the cursor position.
1955                         row = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1956                         enabled = numberedType() && label_[row] && numbered(row);
1957                 } else {
1958                         // if there is an argument, find the corresponding label, else
1959                         // check whether there is at least one label.
1960                         for (row_type row = 0; row != nrows(); ++row) {
1961                                 if (numbered(row) && label_[row] &&
1962                                         (cmd.argument().empty() || label(row) == cmd.argument())) {
1963                                                 enabled = true;
1964                                                 break;
1965                                 }
1966                         }
1967                 }
1968                 status.setEnabled(enabled);
1969                 return true;
1970         }
1971
1972         case LFUN_INSET_INSERT:
1973                 if (cmd.getArg(0) == "label") {
1974                         status.setEnabled(type_ != hullSimple);
1975                         return true;
1976                 }
1977                 return InsetMathGrid::getStatus(cur, cmd, status);
1978
1979         case LFUN_TABULAR_FEATURE: {
1980                 if (!allowsTabularFeatures())
1981                         return false;
1982                 string s = cmd.getArg(0);
1983                 if (!rowChangeOK()
1984                     && (s == "append-row"
1985                         || s == "delete-row"
1986                         || s == "copy-row")) {
1987                         status.message(bformat(
1988                                 from_utf8(N_("Can't change number of rows in '%1$s'")),
1989                                 hullName(type_)));
1990                         status.setEnabled(false);
1991                         return true;
1992                 }
1993                 if (!colChangeOK()
1994                     && (s == "append-column"
1995                         || s == "delete-column"
1996                         || s == "copy-column")) {
1997                         status.message(bformat(
1998                                 from_utf8(N_("Can't change number of columns in '%1$s'")),
1999                                 hullName(type_)));
2000                         status.setEnabled(false);
2001                         return true;
2002                 }
2003                 if (s == "add-vline-left" || s == "add-vline-right") {
2004                         status.message(bformat(
2005                                 from_utf8(N_("Can't add vertical grid lines in '%1$s'")),
2006                                 hullName(type_)));
2007                         status.setEnabled(false);
2008                         return true;
2009                 }
2010                 if (s == "valign-top" || s == "valign-middle"
2011                  || s == "valign-bottom" || s == "align-left"
2012                  || s == "align-center" || s == "align-right") {
2013                         status.setEnabled(false);
2014                         return true;
2015                 }
2016                 return InsetMathGrid::getStatus(cur, cmd, status);
2017         }
2018
2019         default:
2020                 return InsetMathGrid::getStatus(cur, cmd, status);
2021         }
2022
2023         // This cannot really happen, but inserted to shut-up gcc
2024         return InsetMathGrid::getStatus(cur, cmd, status);
2025 }
2026
2027
2028 /////////////////////////////////////////////////////////////////////
2029
2030
2031
2032 // simply scrap this function if you want
2033 void InsetMathHull::mutateToText()
2034 {
2035 #if 0
2036         // translate to latex
2037         ostringstream os;
2038         latex(os, false, false);
2039         string str = os.str();
2040
2041         // insert this text
2042         Text * lt = view_->cursor().innerText();
2043         string::const_iterator cit = str.begin();
2044         string::const_iterator end = str.end();
2045         for (; cit != end; ++cit)
2046                 view_->getIntl()->getTransManager().TranslateAndInsert(*cit, lt);
2047
2048         // remove ourselves
2049         //dispatch(LFUN_ESCAPE);
2050 #endif
2051 }
2052
2053
2054 void InsetMathHull::handleFont(Cursor & cur, docstring const & arg,
2055         docstring const & font)
2056 {
2057         // this whole function is a hack and won't work for incremental font
2058         // changes...
2059         cur.recordUndo();
2060         if (cur.inset().asInsetMath()->name() == font)
2061                 cur.handleFont(to_utf8(font));
2062         else {
2063                 cur.handleNest(createInsetMath(font, cur.buffer()));
2064                 cur.insert(arg);
2065         }
2066 }
2067
2068
2069 void InsetMathHull::handleFont2(Cursor & cur, docstring const & arg)
2070 {
2071         cur.recordUndo();
2072         Font font;
2073         bool b;
2074         font.fromString(to_utf8(arg), b);
2075         if (font.fontInfo().color() != Color_inherit) {
2076                 MathAtom at = MathAtom(new InsetMathColor(buffer_, true, font.fontInfo().color()));
2077                 cur.handleNest(at, 0);
2078         }
2079 }
2080
2081
2082 void InsetMathHull::edit(Cursor & cur, bool front, EntryDirection entry_from)
2083 {
2084         cur.push(*this);
2085         bool enter_front = (entry_from == Inset::ENTRY_DIRECTION_LEFT ||
2086                 (entry_from == Inset::ENTRY_DIRECTION_IGNORE && front));
2087         enter_front ? idxFirst(cur) : idxLast(cur);
2088         // The inset formula dimension is not necessarily the same as the
2089         // one of the instant preview image, so we have to indicate to the
2090         // BufferView that a metrics update is needed.
2091         cur.screenUpdateFlags(Update::Force);
2092 }
2093
2094
2095 void InsetMathHull::revealCodes(Cursor & cur) const
2096 {
2097         if (!cur.inMathed())
2098                 return;
2099         odocstringstream os;
2100         cur.info(os);
2101         cur.message(os.str());
2102 /*
2103         // write something to the minibuffer
2104         // translate to latex
2105         cur.markInsert(bv);
2106         ostringstream os;
2107         write(os);
2108         string str = os.str();
2109         cur.markErase(bv);
2110         string::size_type pos = 0;
2111         string res;
2112         for (string::iterator it = str.begin(); it != str.end(); ++it) {
2113                 if (*it == '\n')
2114                         res += ' ';
2115                 else if (*it == '\0') {
2116                         res += "  -X-  ";
2117                         pos = it - str.begin();
2118                 }
2119                 else
2120                         res += *it;
2121         }
2122         if (pos > 30)
2123                 res = res.substr(pos - 30);
2124         if (res.size() > 60)
2125                 res = res.substr(0, 60);
2126         cur.message(res);
2127 */
2128 }
2129
2130
2131 /////////////////////////////////////////////////////////////////////
2132
2133
2134 #if 0
2135 bool InsetMathHull::searchForward(BufferView * bv, string const & str,
2136                                      bool, bool)
2137 {
2138         // FIXME: completely broken
2139         static InsetMathHull * lastformula = 0;
2140         static CursorBase current = DocIterator(ibegin(nucleus()));
2141         static MathData ar;
2142         static string laststr;
2143
2144         if (lastformula != this || laststr != str) {
2145                 //lyxerr << "reset lastformula to " << this << endl;
2146                 lastformula = this;
2147                 laststr = str;
2148                 current = ibegin(nucleus());
2149                 ar.clear();
2150                 mathed_parse_cell(ar, str, Parse::NORMAL, &buffer());
2151         } else {
2152                 increment(current);
2153         }
2154         //lyxerr << "searching '" << str << "' in " << this << ar << endl;
2155
2156         for (DocIterator it = current; it != iend(nucleus()); increment(it)) {
2157                 CursorSlice & top = it.back();
2158                 MathData const & a = top.asInsetMath()->cell(top.idx_);
2159                 if (a.matchpart(ar, top.pos_)) {
2160                         bv->cursor().setSelection(it, ar.size());
2161                         current = it;
2162                         top.pos_ += ar.size();
2163                         bv->update();
2164                         return true;
2165                 }
2166         }
2167
2168         //lyxerr << "not found!" << endl;
2169         lastformula = 0;
2170         return false;
2171 }
2172 #endif
2173
2174
2175 void InsetMathHull::write(ostream & os) const
2176 {
2177         odocstringstream oss;
2178         TexRow texrow(false);
2179         otexrowstream ots(oss,texrow);
2180         WriteStream wi(ots, false, false, WriteStream::wsDefault);
2181         oss << "Formula ";
2182         write(wi);
2183         os << to_utf8(oss.str());
2184 }
2185
2186
2187 void InsetMathHull::read(Lexer & lex)
2188 {
2189         MathAtom at;
2190         mathed_parse_normal(buffer_, at, lex, Parse::TRACKMACRO);
2191         operator=(*at->asHullInset());
2192 }
2193
2194
2195 bool InsetMathHull::readQuiet(Lexer & lex)
2196 {
2197         MathAtom at;
2198         bool success = mathed_parse_normal(buffer_, at, lex, Parse::QUIET);
2199         if (success)
2200                 operator=(*at->asHullInset());
2201         return success;
2202 }
2203
2204
2205 int InsetMathHull::plaintext(odocstringstream & os,
2206         OutputParams const & op, size_t max_length) const
2207 {
2208         // disables ASCII-art for export of equations. See #2275.
2209         if (0 && display()) {
2210                 Dimension dim;
2211                 TextMetricsInfo mi;
2212                 metricsT(mi, dim);
2213                 TextPainter tpain(dim.width(), dim.height());
2214                 drawT(tpain, 0, dim.ascent());
2215                 tpain.show(os, 3);
2216                 // reset metrics cache to "real" values
2217                 //metrics();
2218                 return tpain.textheight();
2219         }
2220
2221         odocstringstream oss;
2222         TexRow texrow(false);
2223         otexrowstream ots(oss,texrow);
2224         Encoding const * const enc = encodings.fromLyXName("utf8");
2225         WriteStream wi(ots, false, true, WriteStream::wsDefault, enc);
2226
2227         // Fix Bug #6139
2228         if (type_ == hullRegexp)
2229                 write(wi);
2230         else {
2231                 for (row_type r = 0; r < nrows(); ++r) {
2232                         for (col_type c = 0; c < ncols(); ++c)
2233                                 wi << (c == 0 ? "" : "\t") << cell(index(r, c));
2234                         // if it's for the TOC, we write just the first line
2235                         // and do not include the newline.
2236                         if (op.for_toc || op.for_tooltip || oss.str().size() >= max_length)
2237                                 break;
2238                         if (r < nrows() - 1)
2239                                 wi << "\n";
2240                 }
2241         }
2242         docstring const str = oss.str();
2243         os << str;
2244         return str.size();
2245 }
2246
2247
2248 int InsetMathHull::docbook(odocstream & os, OutputParams const & runparams) const
2249 {
2250         MathStream ms(os);
2251         int res = 0;
2252         docstring name;
2253         if (getType() == hullSimple)
2254                 name = from_ascii("inlineequation");
2255         else
2256                 name = from_ascii("informalequation");
2257
2258         docstring bname = name;
2259         if (!label(0).empty())
2260                 bname += " id='" + sgml::cleanID(buffer(), runparams, label(0)) + "'";
2261
2262         ++ms.tab(); ms.cr(); ms.os() << '<' << bname << '>';
2263
2264         odocstringstream ls;
2265         TexRow texrow;
2266         otexstream ols(ls, texrow);
2267         if (runparams.flavor == OutputParams::XML) {
2268                 ms << MTag("alt role='tex' ");
2269                 // Workaround for db2latex: db2latex always includes equations with
2270                 // \ensuremath{} or \begin{display}\end{display}
2271                 // so we strip LyX' math environment
2272                 WriteStream wi(ols, false, false, WriteStream::wsDefault, runparams.encoding);
2273                 InsetMathGrid::write(wi);
2274                 ms << from_utf8(subst(subst(to_utf8(ls.str()), "&", "&amp;"), "<", "&lt;"));
2275                 ms << ETag("alt");
2276                 ms << MTag("math");
2277                 ms << ETag("alt");
2278                 ms << MTag("math");
2279                 InsetMathGrid::mathmlize(ms);
2280                 ms << ETag("math");
2281         } else {
2282                 ms << MTag("alt role='tex'");
2283                 latex(ols, runparams);
2284                 res = texrow.rows();
2285                 ms << from_utf8(subst(subst(to_utf8(ls.str()), "&", "&amp;"), "<", "&lt;"));
2286                 ms << ETag("alt");
2287         }
2288
2289         ms << from_ascii("<graphic fileref=\"eqn/");
2290         if (!label(0).empty())
2291                 ms << sgml::cleanID(buffer(), runparams, label(0));
2292         else
2293                 ms << sgml::uniqueID(from_ascii("anon"));
2294
2295         if (runparams.flavor == OutputParams::XML)
2296                 ms << from_ascii("\"/>");
2297         else
2298                 ms << from_ascii("\">");
2299
2300         ms.cr(); --ms.tab(); ms.os() << "</" << name << '>';
2301
2302         return ms.line() + res;
2303 }
2304
2305
2306 bool InsetMathHull::haveNumbers() const
2307 {
2308         bool havenumbers = false;
2309         // inline formulas are never numbered (bug 7351 part 3)
2310         if (getType() == hullSimple)
2311                 return havenumbers;
2312         for (size_t i = 0; i != numbered_.size(); ++i) {
2313                 if (numbered(i)) {
2314                         havenumbers = true;
2315                         break;
2316                 }
2317         }
2318         return havenumbers;
2319 }
2320
2321
2322 // FIXME XHTML
2323 // We need to do something about alignment here.
2324 //
2325 // This duplicates code from InsetMathGrid, but
2326 // we need access here to number information,
2327 // and we simply do not have that in InsetMathGrid.
2328 void InsetMathHull::htmlize(HtmlStream & os) const
2329 {
2330         bool const havenumbers = haveNumbers();
2331         bool const havetable = havenumbers || nrows() > 1 || ncols() > 1;
2332
2333         if (!havetable) {
2334                 os << cell(index(0, 0));
2335                 return;
2336         }
2337
2338         os << MTag("table", "class='mathtable'");
2339         for (row_type row = 0; row < nrows(); ++row) {
2340                 os << MTag("tr");
2341                 for (col_type col = 0; col < ncols(); ++col) {
2342                         os << MTag("td");
2343                         os << cell(index(row, col));
2344                         os << ETag("td");
2345                 }
2346                 if (havenumbers) {
2347                         os << MTag("td");
2348                         docstring const & num = numbers_[row];
2349                         if (!num.empty())
2350                                 os << '(' << num << ')';
2351                   os << ETag("td");
2352                 }
2353                 os << ETag("tr");
2354         }
2355         os << ETag("table");
2356 }
2357
2358
2359 // this duplicates code from InsetMathGrid, but
2360 // we need access here to number information,
2361 // and we simply do not have that in InsetMathGrid.
2362 void InsetMathHull::mathmlize(MathStream & os) const
2363 {
2364         bool const havenumbers = haveNumbers();
2365         bool const havetable = havenumbers || nrows() > 1 || ncols() > 1;
2366
2367         if (havetable)
2368                 os << MTag("mtable");
2369         char const * const celltag = havetable ? "mtd" : "mrow";
2370         // FIXME There does not seem to be wide support at the moment
2371         // for mlabeledtr, so we have to use just mtr for now.
2372         // char const * const rowtag = havenumbers ? "mlabeledtr" : "mtr";
2373         char const * const rowtag = "mtr";
2374         for (row_type row = 0; row < nrows(); ++row) {
2375                 if (havetable)
2376                         os << MTag(rowtag);
2377                 for (col_type col = 0; col < ncols(); ++col) {
2378                         os << MTag(celltag)
2379                            << cell(index(row, col))
2380                            << ETag(celltag);
2381                 }
2382                 // fleqn?
2383                 if (havenumbers) {
2384                         os << MTag("mtd");
2385                         docstring const & num = numbers_[row];
2386                         if (!num.empty())
2387                                 os << '(' << num << ')';
2388                   os << ETag("mtd");
2389                 }
2390                 if (havetable)
2391                         os << ETag(rowtag);
2392         }
2393         if (havetable)
2394                 os << ETag("mtable");
2395 }
2396
2397
2398 void InsetMathHull::mathAsLatex(WriteStream & os) const
2399 {
2400         MathEnsurer ensurer(os, false);
2401         bool havenumbers = haveNumbers();
2402         bool const havetable = havenumbers || nrows() > 1 || ncols() > 1;
2403
2404         if (!havetable) {
2405                 os << cell(index(0, 0));
2406                 return;
2407         }
2408
2409         os << "<table class='mathtable'>";
2410         for (row_type row = 0; row < nrows(); ++row) {
2411                 os << "<tr>";
2412                 for (col_type col = 0; col < ncols(); ++col) {
2413                         os << "<td class='math'>";
2414                         os << cell(index(row, col));
2415                         os << "</td>";
2416                 }
2417                 if (havenumbers) {
2418                         os << "<td>";
2419                         docstring const & num = numbers_[row];
2420                         if (!num.empty())
2421                                 os << '(' << num << ')';
2422                   os << "</td>";
2423                 }
2424                 os << "</tr>";
2425         }
2426         os << "</table>";
2427 }
2428
2429
2430 docstring InsetMathHull::xhtml(XHTMLStream & xs, OutputParams const & op) const
2431 {
2432         BufferParams::MathOutput const mathtype =
2433                 buffer().masterBuffer()->params().html_math_output;
2434
2435         bool success = false;
2436
2437         // we output all the labels just at the beginning of the equation.
2438         // this should be fine.
2439         for (size_t i = 0; i != label_.size(); ++i) {
2440                 InsetLabel const * const il = label_[i];
2441                 if (!il)
2442                         continue;
2443                 il->xhtml(xs, op);
2444         }
2445
2446         // FIXME Eventually we would like to do this inset by inset.
2447         if (mathtype == BufferParams::MathML) {
2448                 odocstringstream os;
2449                 MathStream ms(os);
2450                 try {
2451                         mathmlize(ms);
2452                         success = true;
2453                 } catch (MathExportException const &) {}
2454                 if (success) {
2455                         if (getType() == hullSimple)
2456                                 xs << html::StartTag("math",
2457                                                         "xmlns=\"http://www.w3.org/1998/Math/MathML\"", true);
2458                         else
2459                                 xs << html::StartTag("math",
2460                                       "display=\"block\" xmlns=\"http://www.w3.org/1998/Math/MathML\"", true);
2461                         xs << XHTMLStream::ESCAPE_NONE
2462                                  << os.str()
2463                                  << html::EndTag("math");
2464                 }
2465         } else if (mathtype == BufferParams::HTML) {
2466                 odocstringstream os;
2467                 HtmlStream ms(os);
2468                 try {
2469                         htmlize(ms);
2470                         success = true;
2471                 } catch (MathExportException const &) {}
2472                 if (success) {
2473                         string const tag = (getType() == hullSimple) ? "span" : "div";
2474                         xs << html::StartTag(tag, "class='formula'", true)
2475                            << XHTMLStream::ESCAPE_NONE
2476                            << os.str()
2477                            << html::EndTag(tag);
2478                 }
2479         }
2480
2481         // what we actually want is this:
2482         // if (
2483         //     ((mathtype == BufferParams::MathML || mathtype == BufferParams::HTML)
2484         //       && !success)
2485         //     || mathtype == BufferParams::Images
2486         //    )
2487         // but what follows is equivalent, since we'll enter only if either (a) we
2488         // tried and failed with MathML or HTML or (b) didn't try yet at all but
2489         // aren't doing LaTeX, in which case we are doing Images.
2490         if (!success && mathtype != BufferParams::LaTeX) {
2491                 graphics::PreviewImage const * pimage = 0;
2492                 if (!op.dryrun) {
2493                         loadPreview(docit_);
2494                         pimage = preview_->getPreviewImage(buffer());
2495                         // FIXME Do we always have png?
2496                 }
2497
2498                 if (pimage || op.dryrun) {
2499                         string const filename = pimage ? pimage->filename().onlyFileName()
2500                                                        : "previewimage.png";
2501                         if (pimage) {
2502                                 // if we are not in the master buffer, then we need to see that the
2503                                 // generated image is copied there; otherwise, preview fails.
2504                                 Buffer const * mbuf = buffer().masterBuffer();
2505                                 if (mbuf != &buffer()) {
2506                                         string mbtmp = mbuf->temppath();
2507                                         FileName const mbufimg(support::addName(mbtmp, filename));
2508                                         pimage->filename().copyTo(mbufimg);
2509                                 }
2510                                 // add the file to the list of files to be exported
2511                                 op.exportdata->addExternalFile("xhtml", pimage->filename());
2512                         }
2513
2514                         string const tag = (getType() == hullSimple) ? "span" : "div";
2515                         xs << html::CR()
2516                            << html::StartTag(tag)
2517                                  << html::CompTag("img", "src=\"" + filename + "\" alt=\"Mathematical Equation\"")
2518                                  << html::EndTag(tag)
2519                                  << html::CR();
2520                         success = true;
2521                 }
2522         }
2523
2524         // so we'll pass this test if we've failed everything else, or
2525         // if mathtype was LaTeX, since we won't have entered any of the
2526         // earlier branches
2527         if (!success /* || mathtype != BufferParams::LaTeX */) {
2528                 // Unfortunately, we cannot use latexString() because we do not want
2529                 // $...$ or whatever.
2530                 odocstringstream ls;
2531                 TexRow texrow(false);
2532                 otexrowstream ots(ls,texrow);
2533                 WriteStream wi(ots, false, true, WriteStream::wsPreview);
2534                 ModeSpecifier specifier(wi, MATH_MODE);
2535                 mathAsLatex(wi);
2536                 docstring const latex = ls.str();
2537
2538                 // class='math' allows for use of jsMath
2539                 // http://www.math.union.edu/~dpvc/jsMath/
2540                 // FIXME XHTML
2541                 // probably should allow for some kind of customization here
2542                 string const tag = (getType() == hullSimple) ? "span" : "div";
2543                 xs << html::StartTag(tag, "class='math'")
2544                    << latex
2545                    << html::EndTag(tag)
2546                    << html::CR();
2547         }
2548         return docstring();
2549 }
2550
2551
2552 void InsetMathHull::toString(odocstream & os) const
2553 {
2554         odocstringstream ods;
2555         plaintext(ods, OutputParams(0));
2556         os << ods.str();
2557 }
2558
2559
2560 void InsetMathHull::forOutliner(docstring & os, size_t const, bool const) const
2561 {
2562         odocstringstream ods;
2563         OutputParams op(0);
2564         op.for_toc = true;
2565         // FIXME: this results in spilling TeX into the LyXHTML output since the
2566         // outliner is used to generate the LyXHTML list of figures/etc.
2567         plaintext(ods, op);
2568         os += ods.str();
2569 }
2570
2571
2572 string InsetMathHull::contextMenuName() const
2573 {
2574         return "context-math";
2575 }
2576
2577
2578 void InsetMathHull::recordLocation(DocIterator const & di)
2579 {
2580         docit_ = di;
2581 }
2582
2583 } // namespace lyx