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