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