src/mathed/InsetMathHull.cpp

   1 /**
   2  * \file InsetMathHull.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author André Pönitz
   7  *
   8  * Full author contact details are available in file CREDITS.
   9  */
  10
  11 #include <config.h>
  12
  13 #include "InsetMathHull.h"
  14
  15 #include "InsetMathChar.h"
  16 #include "InsetMathColor.h"
  17 #include "MathExtern.h"
  18 #include "MathFactory.h"
  19 #include "MathStream.h"
  20 #include "MathSupport.h"
  21
  22 #include "Buffer.h"
  23 #include "BufferParams.h"
  24 #include "BufferView.h"
  25 #include "ColorSet.h"
  26 #include "CutAndPaste.h"
  27 #include "Encoding.h"
  28 #include "Exporter.h"
  29 #include "FuncRequest.h"
  30 #include "FuncStatus.h"
  31 #include "LaTeXFeatures.h"
  32 #include "LyXRC.h"
  33 #include "MacroTable.h"
  34 #include "output_xhtml.h"
  35 #include "sgml.h"
  36 #include "TextPainter.h"
  37 #include "TocBackend.h"
  38
  39 #include "insets/InsetLabel.h"
  40 #include "insets/InsetRef.h"
  41 #include "insets/RenderPreview.h"
  42
  43 #include "graphics/PreviewImage.h"
  44 #include "graphics/PreviewLoader.h"
  45
  46 #include "frontends/Painter.h"
  47
  48 #include "support/lassert.h"
  49 #include "support/debug.h"
  50 #include "support/gettext.h"
  51 #include "support/lstrings.h"
  52
  53 #include <sstream>
  54
  55 using namespace std;
  56 using namespace lyx::support;
  57
  58 namespace lyx {
  59
  60 using cap::grabAndEraseSelection;
  61
  62 namespace {
  63
  64         int getCols(HullType type)
  65         {
  66                 switch (type) {
  67                         case hullEqnArray:
  68                                 return 3;
  69                         case hullAlign:
  70                         case hullFlAlign:
  71                         case hullAlignAt:
  72                         case hullXAlignAt:
  73                         case hullXXAlignAt:
  74                                 return 2;
  75                         default:
  76                                 return 1;
  77                 }
  78         }
  79
  80
  81         // returns position of first relation operator in the array
  82         // used for "intelligent splitting"
  83         size_t firstRelOp(MathData const & ar)
  84         {
  85                 for (MathData::const_iterator it = ar.begin(); it != ar.end(); ++it)
  86                         if ((*it)->isRelOp())
  87                                 return it - ar.begin();
  88                 return ar.size();
  89         }
  90
  91
  92         char const * star(bool numbered)
  93         {
  94                 return numbered ? "" : "*";
  95         }
  96
  97
  98 } // end anon namespace
  99
 100
 101 HullType hullType(docstring const & s)
 102 {
 103         if (s == "none")      return hullNone;
 104         if (s == "simple")    return hullSimple;
 105         if (s == "equation")  return hullEquation;
 106         if (s == "eqnarray")  return hullEqnArray;
 107         if (s == "align")     return hullAlign;
 108         if (s == "alignat")   return hullAlignAt;
 109         if (s == "xalignat")  return hullXAlignAt;
 110         if (s == "xxalignat") return hullXXAlignAt;
 111         if (s == "multline")  return hullMultline;
 112         if (s == "gather")    return hullGather;
 113         if (s == "flalign")   return hullFlAlign;
 114         if (s == "regexp")    return hullRegexp;
 115         lyxerr << "unknown hull type '" << to_utf8(s) << "'" << endl;
 116         return HullType(-1);
 117 }
 118
 119
 120 docstring hullName(HullType type)
 121 {
 122         switch (type) {
 123                 case hullNone:       return from_ascii("none");
 124                 case hullSimple:     return from_ascii("simple");
 125                 case hullEquation:   return from_ascii("equation");
 126                 case hullEqnArray:   return from_ascii("eqnarray");
 127                 case hullAlign:      return from_ascii("align");
 128                 case hullAlignAt:    return from_ascii("alignat");
 129                 case hullXAlignAt:   return from_ascii("xalignat");
 130                 case hullXXAlignAt:  return from_ascii("xxalignat");
 131                 case hullMultline:   return from_ascii("multline");
 132                 case hullGather:     return from_ascii("gather");
 133                 case hullFlAlign:    return from_ascii("flalign");
 134                 case hullRegexp:     return from_ascii("regexp");
 135                 default:
 136                         lyxerr << "unknown hull type '" << type << "'" << endl;
 137                         return from_ascii("none");
 138         }
 139 }
 140
 141 static InsetLabel * dummy_pointer = 0;
 142
 143 InsetMathHull::InsetMathHull(Buffer * buf)
 144         : InsetMathGrid(buf, 1, 1), type_(hullNone), numbered_(1, true),
 145           label_(1, dummy_pointer), preview_(new RenderPreview(this))
 146 {
 147         //lyxerr << "sizeof InsetMath: " << sizeof(InsetMath) << endl;
 148         //lyxerr << "sizeof MetricsInfo: " << sizeof(MetricsInfo) << endl;
 149         //lyxerr << "sizeof InsetMathChar: " << sizeof(InsetMathChar) << endl;
 150         //lyxerr << "sizeof FontInfo: " << sizeof(FontInfo) << endl;
 151         buffer_ = buf;
 152         initMath();
 153         setDefaults();
 154 }
 155
 156
 157 InsetMathHull::InsetMathHull(Buffer * buf, HullType type)
 158         : InsetMathGrid(buf, getCols(type), 1), type_(type), numbered_(1, true),
 159           label_(1, dummy_pointer), preview_(new RenderPreview(this))
 160 {
 161         buffer_ = buf;
 162         initMath();
 163         setDefaults();
 164 }
 165
 166
 167 InsetMathHull::InsetMathHull(InsetMathHull const & other) : InsetMathGrid(other)
 168 {
 169         operator=(other);
 170 }
 171
 172
 173 InsetMathHull::~InsetMathHull()
 174 {
 175         for (size_t i = 0; i < label_.size(); ++i)
 176                 delete label_[i];
 177 }
 178
 179
 180 Inset * InsetMathHull::clone() const
 181 {
 182         return new InsetMathHull(*this);
 183 }
 184
 185
 186 InsetMathHull & InsetMathHull::operator=(InsetMathHull const & other)
 187 {
 188         if (this == &other)
 189                 return *this;
 190         InsetMathGrid::operator=(other);
 191         type_  = other.type_;
 192         numbered_ = other.numbered_;
 193         buffer_ = other.buffer_;
 194         for (size_t i = 0; i < label_.size(); ++i)
 195                 delete label_[i];
 196         label_ = other.label_;
 197         for (size_t i = 0; i != label_.size(); ++i) {
 198                 if (label_[i])
 199                         label_[i] = new InsetLabel(*label_[i]);
 200         }
 201         preview_.reset(new RenderPreview(*other.preview_, this));
 202
 203         return *this;
 204 }
 205
 206
 207 void InsetMathHull::setBuffer(Buffer & buffer)
 208 {
 209         InsetMathGrid::setBuffer(buffer);
 210
 211         for (size_t i = 0; i != label_.size(); ++i) {
 212                 if (label_[i])
 213                         label_[i]->setBuffer(buffer);
 214         }
 215 }
 216
 217
 218 void InsetMathHull::updateBuffer(ParIterator const & it, UpdateType utype)
 219 {
 220         if (!buffer_) {
 221                 //FIXME: buffer_ should be set at creation for this inset! Problem is
 222                 // This inset is created at too many places (see Parser::parse1() in
 223                 // MathParser.cpp).
 224                 return;
 225         }
 226         for (size_t i = 0; i != label_.size(); ++i) {
 227                 if (label_[i])
 228                         label_[i]->updateBuffer(it, utype);
 229         }
 230         // pass down
 231         InsetMathGrid::updateBuffer(it, utype);
 232 }
 233
 234
 235 void InsetMathHull::addToToc(DocIterator const & pit)
 236 {
 237         if (!buffer_) {
 238                 //FIXME: buffer_ should be set at creation for this inset! Problem is
 239                 // This inset is created at too many places (see Parser::parse1() in
 240                 // MathParser.cpp).
 241                 return;
 242         }
 243
 244         Toc & toc = buffer().tocBackend().toc("equation");
 245
 246         for (row_type row = 0; row != nrows(); ++row) {
 247                 if (!numbered_[row])
 248                         continue;
 249                 if (label_[row])
 250                         label_[row]->addToToc(pit);
 251                 toc.push_back(TocItem(pit, 0, nicelabel(row)));
 252         }
 253 }
 254
 255
 256 Inset * InsetMathHull::editXY(Cursor & cur, int x, int y)
 257 {
 258         if (use_preview_) {
 259                 edit(cur, true);
 260                 return this;
 261         }
 262         return InsetMathNest::editXY(cur, x, y);
 263 }
 264
 265
 266 InsetMath::mode_type InsetMathHull::currentMode() const
 267 {
 268         if (type_ == hullNone)
 269                 return UNDECIDED_MODE;
 270         // definitely math mode ...
 271         return MATH_MODE;
 272 }
 273
 274
 275 bool InsetMathHull::idxFirst(Cursor & cur) const
 276 {
 277         cur.idx() = 0;
 278         cur.pos() = 0;
 279         return true;
 280 }
 281
 282
 283 bool InsetMathHull::idxLast(Cursor & cur) const
 284 {
 285         cur.idx() = nargs() - 1;
 286         cur.pos() = cur.lastpos();
 287         return true;
 288 }
 289
 290
 291 char InsetMathHull::defaultColAlign(col_type col)
 292 {
 293         if (type_ == hullEqnArray)
 294                 return "rcl"[col];
 295         if (type_ == hullGather)
 296                 return 'c';
 297         if (type_ >= hullAlign)
 298                 return "rl"[col & 1];
 299         return 'c';
 300 }
 301
 302
 303 int InsetMathHull::defaultColSpace(col_type col)
 304 {
 305         if (type_ == hullAlign || type_ == hullAlignAt)
 306                 return 0;
 307         if (type_ == hullXAlignAt)
 308                 return (col & 1) ? 20 : 0;
 309         if (type_ == hullXXAlignAt || type_ == hullFlAlign)
 310                 return (col & 1) ? 40 : 0;
 311         return 0;
 312 }
 313
 314
 315 docstring InsetMathHull::standardFont() const
 316 {
 317         docstring font_name;
 318         switch (type_) {
 319         case hullRegexp:
 320                 font_name = from_ascii("texttt");
 321                 break;
 322         case hullNone:
 323                 font_name = from_ascii("lyxnochange");
 324                 break;
 325         default:
 326                 font_name = from_ascii("mathnormal");
 327         }
 328         return font_name;
 329 }
 330
 331
 332 ColorCode InsetMathHull::standardColor() const
 333 {
 334         ColorCode color;
 335         switch (type_) {
 336         case hullRegexp:
 337         case hullNone:
 338                 color = Color_foreground;
 339                 break;
 340         default:
 341                 color = Color_math;
 342         }
 343         return color;
 344 }
 345
 346
 347 bool InsetMathHull::previewState(BufferView * bv) const
 348 {
 349         if (!editing(bv) && RenderPreview::status() == LyXRC::PREVIEW_ON) {
 350                 graphics::PreviewImage const * pimage =
 351                         preview_->getPreviewImage(bv->buffer());
 352                 return pimage && pimage->image();
 353         }
 354         return false;
 355 }
 356
 357
 358 void InsetMathHull::metrics(MetricsInfo & mi, Dimension & dim) const
 359 {
 360         if (previewState(mi.base.bv)) {
 361                 preview_->metrics(mi, dim);
 362                 // insert a one pixel gap in front of the formula
 363                 dim.wid += 1;
 364                 if (display())
 365                         dim.des += displayMargin();
 366                 // Cache the inset dimension.
 367                 setDimCache(mi, dim);
 368                 return;
 369         }
 370
 371         FontSetChanger dummy1(mi.base, standardFont());
 372         StyleChanger dummy2(mi.base, display() ? LM_ST_DISPLAY : LM_ST_TEXT);
 373
 374         // let the cells adjust themselves
 375         InsetMathGrid::metrics(mi, dim);
 376
 377         if (display()) {
 378                 dim.asc += displayMargin();
 379                 dim.des += displayMargin();
 380         }
 381
 382         if (numberedType()) {
 383                 FontSetChanger dummy(mi.base, from_ascii("mathbf"));
 384                 int l = 0;
 385                 for (row_type row = 0; row < nrows(); ++row)
 386                         l = max(l, mathed_string_width(mi.base.font, nicelabel(row)));
 387
 388                 if (l)
 389                         dim.wid += 30 + l;
 390         }
 391
 392         // make it at least as high as the current font
 393         int asc = 0;
 394         int des = 0;
 395         math_font_max_dim(mi.base.font, asc, des);
 396         dim.asc = max(dim.asc, asc);
 397         dim.des = max(dim.des, des);
 398         // Cache the inset dimension.
 399         // FIXME: This will overwrite InsetMathGrid dimension, is that OK?
 400         setDimCache(mi, dim);
 401 }
 402
 403
 404 ColorCode InsetMathHull::backgroundColor(PainterInfo const & pi) const
 405 {
 406         if (previewState(pi.base.bv))
 407                 return graphics::PreviewLoader::backgroundColor();
 408         return Color_mathbg;
 409 }
 410
 411
 412 void InsetMathHull::drawBackground(PainterInfo & pi, int x, int y) const
 413 {
 414         Dimension const dim = dimension(*pi.base.bv);
 415         pi.pain.fillRectangle(x + 1, y - dim.asc + 1, dim.wid - 2,
 416                 dim.asc + dim.des - 1, pi.backgroundColor(this));
 417 }
 418
 419
 420 void InsetMathHull::draw(PainterInfo & pi, int x, int y) const
 421 {
 422         use_preview_ = previewState(pi.base.bv);
 423
 424         if (type_ == hullRegexp) {
 425                 Dimension const dim = dimension(*pi.base.bv);
 426                 pi.pain.rectangle(x + 1, y - dim.ascent() + 1,
 427                         dim.width() - 2, dim.height() - 2, Color_regexpframe);
 428         }
 429         if (use_preview_) {
 430                 // one pixel gap in front
 431                 preview_->draw(pi, x + 1, y);
 432                 setPosCache(pi, x, y);
 433                 return;
 434         }
 435
 436         ColorCode color = pi.selected && lyxrc.use_system_colors
 437                                 ? Color_selectiontext : standardColor();
 438         bool const really_change_color = pi.base.font.color() == Color_none;
 439         ColorChanger dummy0(pi.base.font, color, really_change_color);
 440         FontSetChanger dummy1(pi.base, standardFont());
 441         StyleChanger dummy2(pi.base, display() ? LM_ST_DISPLAY : LM_ST_TEXT);
 442
 443         InsetMathGrid::draw(pi, x + 1, y);
 444
 445         if (numberedType()) {
 446                 int const xx = x + colinfo_.back().offset_ + colinfo_.back().width_ + 20;
 447                 for (row_type row = 0; row < nrows(); ++row) {
 448                         int const yy = y + rowinfo_[row].offset_;
 449                         FontSetChanger dummy(pi.base, from_ascii("mathrm"));
 450                         docstring const nl = nicelabel(row);
 451                         pi.draw(xx, yy, nl);
 452                 }
 453         }
 454         setPosCache(pi, x, y);
 455 }
 456
 457
 458 void InsetMathHull::metricsT(TextMetricsInfo const & mi, Dimension & dim) const
 459 {
 460         if (display()) {
 461                 InsetMathGrid::metricsT(mi, dim);
 462         } else {
 463                 odocstringstream os;
 464                 WriteStream wi(os, false, true, WriteStream::wsDefault);
 465                 write(wi);
 466                 dim.wid = os.str().size();
 467                 dim.asc = 1;
 468                 dim.des = 0;
 469         }
 470 }
 471
 472
 473 void InsetMathHull::drawT(TextPainter & pain, int x, int y) const
 474 {
 475         if (display()) {
 476                 InsetMathGrid::drawT(pain, x, y);
 477         } else {
 478                 odocstringstream os;
 479                 WriteStream wi(os, false, true, WriteStream::wsDefault);
 480                 write(wi);
 481                 pain.draw(x, y, os.str().c_str());
 482         }
 483 }
 484
 485
 486 static docstring latexString(InsetMathHull const & inset)
 487 {
 488         odocstringstream ls;
 489         // This has to be static, because a preview snippet or a math
 490         // macro containing math in text mode (such as $\text{$\phi$}$ or
 491         // \newcommand{\xxx}{\text{$\phi$}}) gets processed twice. The
 492         // first time as a whole, and the second time only the inner math.
 493         // In this last case inset.buffer() would be invalid.
 494         static Encoding const * encoding = 0;
 495         if (inset.isBufferValid())
 496                 encoding = &(inset.buffer().params().encoding());
 497         WriteStream wi(ls, false, true, WriteStream::wsPreview, encoding);
 498         inset.write(wi);
 499         return ls.str();
 500 }
 501
 502
 503 void InsetMathHull::initUnicodeMath() const
 504 {
 505         // Trigger classification of the unicode symbols in this inset
 506         docstring const dummy = latexString(*this);
 507 }
 508
 509
 510 void InsetMathHull::addPreview(DocIterator const & inset_pos,
 511         graphics::PreviewLoader & /*ploader*/) const
 512 {
 513         if (RenderPreview::status() == LyXRC::PREVIEW_ON) {
 514                 preparePreview(inset_pos);
 515         }
 516 }
 517
 518
 519 void InsetMathHull::preparePreview(DocIterator const & pos,
 520                                    bool forexport) const
 521 {
 522         // there is no need to do all the macro stuff if we're not
 523         // actually going to generate the preview.
 524         if (RenderPreview::status() != LyXRC::PREVIEW_ON && !forexport)
 525                 return;
 526
 527         Buffer const * buffer = pos.buffer();
 528
 529         // collect macros at this position
 530         MacroNameSet macros;
 531         buffer->listMacroNames(macros);
 532         MacroNameSet::iterator it = macros.begin();
 533         MacroNameSet::iterator end = macros.end();
 534         odocstringstream macro_preamble;
 535         for (; it != end; ++it) {
 536                 MacroData const * data = buffer->getMacro(*it, pos, true);
 537                 if (data) {
 538                         data->write(macro_preamble, true);
 539                         macro_preamble << endl;
 540                 }
 541         }
 542
 543         docstring const snippet = macro_preamble.str() + latexString(*this);
 544         LYXERR(Debug::MACROS, "Preview snippet: " << snippet);
 545         preview_->addPreview(snippet, *buffer, forexport);
 546 }
 547
 548
 549 void InsetMathHull::reloadPreview(DocIterator const & pos) const
 550 {
 551         preparePreview(pos);
 552         preview_->startLoading(*pos.buffer());
 553 }
 554
 555
 556 void InsetMathHull::loadPreview(DocIterator const & pos) const
 557 {
 558         bool const forexport = true;
 559         preparePreview(pos, forexport);
 560         preview_->startLoading(*pos.buffer(), forexport);
 561 }
 562
 563
 564 bool InsetMathHull::notifyCursorLeaves(Cursor const & old, Cursor & cur)
 565 {
 566         if (RenderPreview::status() == LyXRC::PREVIEW_ON) {
 567                 reloadPreview(old);
 568                 cur.screenUpdateFlags(Update::Force);
 569         }
 570         return false;
 571 }
 572
 573
 574 docstring InsetMathHull::label(row_type row) const
 575 {
 576         LASSERT(row < nrows(), /**/);
 577         if (InsetLabel * il = label_[row])
 578                 return il->screenLabel();
 579         return docstring();
 580 }
 581
 582
 583 void InsetMathHull::label(row_type row, docstring const & label)
 584 {
 585         //lyxerr << "setting label '" << label << "' for row " << row << endl;
 586         if (label_[row]) {
 587                 if (label.empty()) {
 588                         delete label_[row];
 589                         label_[row] = dummy_pointer;
 590                 } else {
 591                         if (buffer_)
 592                                 label_[row]->updateCommand(label);
 593                         else
 594                                 label_[row]->setParam("name", label);
 595                 }
 596                 return;
 597         }
 598         InsetCommandParams p(LABEL_CODE);
 599         p["name"] = label;
 600         label_[row] = new InsetLabel(buffer_, p);
 601         if (buffer_)
 602                 label_[row]->setBuffer(buffer());
 603 }
 604
 605
 606 void InsetMathHull::numbered(row_type row, bool num)
 607 {
 608         numbered_[row] = num;
 609         if (!numbered_[row] && label_[row]) {
 610                 delete label_[row];
 611                 label_[row] = 0;
 612         }
 613 }
 614
 615
 616 bool InsetMathHull::numbered(row_type row) const
 617 {
 618         return numbered_[row];
 619 }
 620
 621
 622 bool InsetMathHull::ams() const
 623 {
 624         return type_ == hullAlign
 625                 || type_ == hullFlAlign
 626                 || type_ == hullMultline
 627                 || type_ == hullGather
 628                 || type_ == hullAlignAt
 629                 || type_ == hullXAlignAt
 630                 || type_ == hullXXAlignAt;
 631 }
 632
 633
 634 Inset::DisplayType InsetMathHull::display() const
 635 {
 636         if (type_ == hullSimple || type_ == hullNone || type_ == hullRegexp)
 637                 return Inline;
 638         return AlignCenter;
 639 }
 640
 641 bool InsetMathHull::numberedType() const
 642 {
 643         if (type_ == hullNone)
 644                 return false;
 645         if (type_ == hullSimple)
 646                 return false;
 647         if (type_ == hullXXAlignAt)
 648                 return false;
 649         if (type_ == hullRegexp)
 650                 return false;
 651         for (row_type row = 0; row < nrows(); ++row)
 652                 if (numbered_[row])
 653                         return true;
 654         return false;
 655 }
 656
 657
 658 void InsetMathHull::validate(LaTeXFeatures & features) const
 659 {
 660         if (features.runparams().isLaTeX()) {
 661                 if (ams())
 662                         features.require("amsmath");
 663
 664                 if (type_ == hullRegexp) {
 665                         features.require("color");
 666                         string frcol = lcolor.getLaTeXName(Color_regexpframe);
 667                         string bgcol = "white";
 668                         features.addPreambleSnippet(
 669                                 string("\\newcommand{\\regexp}[1]{\\fcolorbox{")
 670                                 + frcol + string("}{")
 671                                 + bgcol + string("}{\\texttt{#1}}}"));
 672                 }
 673
 674                 // Validation is necessary only if not using AMS math.
 675                 // To be safe, we will always run mathedvalidate.
 676                 //if (features.amsstyle)
 677                 //  return;
 678
 679                 //features.binom      = true;
 680         } else if (features.runparams().math_flavor == OutputParams::MathAsHTML) {
 681                 // it would be better to do this elsewhere, but we can't validate in
 682                 // InsetMathMatrix and we have no way, outside MathExtern, to know if
 683                 // we even have any matrices.
 684                                 features.addPreambleSnippet("<style type=\"text/css\">\n"
 685                                         "table.matrix{display: inline-block; vertical-align: middle; text-align:center;}\n"
 686                                         "table.matrix td{padding: 0.25px;}\n"
 687                                         "td.ldelim{width: 0.5ex; border: thin solid black; border-right: none;}\n"
 688                                         "td.rdelim{width: 0.5ex; border: thin solid black; border-left: none;}\n"
 689                                         "</style>");
 690         }
 691         InsetMathGrid::validate(features);
 692 }
 693
 694
 695 void InsetMathHull::header_write(WriteStream & os) const
 696 {
 697         bool n = numberedType();
 698
 699         switch(type_) {
 700         case hullNone:
 701                 break;
 702
 703         case hullSimple:
 704                 os << '$';
 705                 if (cell(0).empty())
 706                         os << ' ';
 707                 break;
 708
 709         case hullEquation:
 710                 if (n)
 711                         os << "\\begin{equation" << star(n) << "}\n";
 712                 else
 713                         os << "\\[\n";
 714                 break;
 715
 716         case hullEqnArray:
 717         case hullAlign:
 718         case hullFlAlign:
 719         case hullGather:
 720         case hullMultline:
 721                 os << "\\begin{" << hullName(type_) << star(n) << "}\n";
 722                 break;
 723
 724         case hullAlignAt:
 725         case hullXAlignAt:
 726                 os << "\\begin{" << hullName(type_) << star(n) << '}'
 727                   << '{' << static_cast<unsigned int>((ncols() + 1)/2) << "}\n";
 728                 break;
 729
 730         case hullXXAlignAt:
 731                 os << "\\begin{" << hullName(type_) << '}'
 732                   << '{' << static_cast<unsigned int>((ncols() + 1)/2) << "}\n";
 733                 break;
 734
 735         case hullRegexp:
 736                 os << "\\regexp{{{";
 737                 break;
 738
 739         default:
 740                 os << "\\begin{unknown" << star(n) << '}';
 741                 break;
 742         }
 743 }
 744
 745
 746 void InsetMathHull::footer_write(WriteStream & os) const
 747 {
 748         bool n = numberedType();
 749
 750         switch(type_) {
 751         case hullNone:
 752                 os << "\n";
 753                 break;
 754
 755         case hullSimple:
 756                 os << '$';
 757                 break;
 758
 759         case hullEquation:
 760                 if (n)
 761                         os << "\\end{equation" << star(n) << "}\n";
 762                 else
 763                         os << "\\]\n";
 764                 break;
 765
 766         case hullEqnArray:
 767         case hullAlign:
 768         case hullFlAlign:
 769         case hullAlignAt:
 770         case hullXAlignAt:
 771         case hullGather:
 772         case hullMultline:
 773                 os << "\\end{" << hullName(type_) << star(n) << "}\n";
 774                 break;
 775
 776         case hullXXAlignAt:
 777                 os << "\\end{" << hullName(type_) << "}\n";
 778                 break;
 779
 780         case hullRegexp:
 781                 os << "}}}";
 782                 break;
 783
 784         default:
 785                 os << "\\end{unknown" << star(n) << '}';
 786                 break;
 787         }
 788 }
 789
 790
 791 bool InsetMathHull::rowChangeOK() const
 792 {
 793         return
 794                 type_ == hullEqnArray || type_ == hullAlign ||
 795                 type_ == hullFlAlign || type_ == hullAlignAt ||
 796                 type_ == hullXAlignAt || type_ == hullXXAlignAt ||
 797                 type_ == hullGather || type_ == hullMultline;
 798 }
 799
 800
 801 bool InsetMathHull::colChangeOK() const
 802 {
 803         return
 804                 type_ == hullAlign || type_ == hullFlAlign ||type_ == hullAlignAt ||
 805                 type_ == hullXAlignAt || type_ == hullXXAlignAt;
 806 }
 807
 808
 809 void InsetMathHull::addRow(row_type row)
 810 {
 811         if (!rowChangeOK())
 812                 return;
 813
 814         bool numbered = numberedType();
 815         docstring lab;
 816         if (type_ == hullMultline) {
 817                 if (row + 1 == nrows())  {
 818                         numbered_[row] = false;
 819                         lab = label(row);
 820                 } else
 821                         numbered = false;
 822         }
 823
 824         numbered_.insert(numbered_.begin() + row + 1, numbered);
 825         label_.insert(label_.begin() + row + 1, dummy_pointer);
 826         if (!lab.empty())
 827                 label(row + 1, lab);
 828         InsetMathGrid::addRow(row);
 829 }
 830
 831
 832 void InsetMathHull::swapRow(row_type row)
 833 {
 834         if (nrows() <= 1)
 835                 return;
 836         if (row + 1 == nrows())
 837                 --row;
 838         // gcc implements the standard std::vector<bool> which is *not* a container:
 839         //   http://www.gotw.ca/publications/N1185.pdf
 840         // As a results, it doesn't like this:
 841         //      swap(numbered_[row], numbered_[row + 1]);
 842         // so we do it manually:
 843         bool const b = numbered_[row];
 844         numbered_[row] = numbered_[row + 1];
 845         numbered_[row + 1] = b;
 846         swap(label_[row], label_[row + 1]);
 847         InsetMathGrid::swapRow(row);
 848 }
 849
 850
 851 void InsetMathHull::delRow(row_type row)
 852 {
 853         if (nrows() <= 1 || !rowChangeOK())
 854                 return;
 855         if (row + 1 == nrows() && type_ == hullMultline) {
 856                 bool const b = numbered_[row - 1];
 857                 numbered_[row - 1] = numbered_[row];
 858                 numbered_[row] = b;
 859                 swap(label_[row - 1], label_[row]);
 860                 InsetMathGrid::delRow(row);
 861                 return;
 862         }
 863         InsetMathGrid::delRow(row);
 864         // The last dummy row has no number info nor a label.
 865         // Test nrows() + 1 because we have already erased the row.
 866         if (row == nrows() + 1)
 867                 row--;
 868         numbered_.erase(numbered_.begin() + row);
 869         delete label_[row];
 870         label_.erase(label_.begin() + row);
 871 }
 872
 873
 874 void InsetMathHull::addCol(col_type col)
 875 {
 876         if (!colChangeOK())
 877                 return;
 878         InsetMathGrid::addCol(col);
 879 }
 880
 881
 882 void InsetMathHull::delCol(col_type col)
 883 {
 884         if (ncols() <= 1 || !colChangeOK())
 885                 return;
 886         InsetMathGrid::delCol(col);
 887 }
 888
 889
 890 docstring InsetMathHull::nicelabel(row_type row) const
 891 {
 892         if (!numbered_[row])
 893                 return docstring();
 894         if (!label_[row])
 895                 return from_ascii("(#)");
 896         return '(' + label_[row]->screenLabel() + from_ascii(", #)");
 897 }
 898
 899
 900 void InsetMathHull::glueall(HullType type)
 901 {
 902         MathData ar;
 903         for (idx_type i = 0; i < nargs(); ++i)
 904                 ar.append(cell(i));
 905         InsetLabel * label = 0;
 906         if (type == hullEquation) {
 907                 // preserve first non-empty label
 908                 for (row_type row = 0; row < nrows(); ++row) {
 909                         if (label_[row]) {
 910                                 label = label_[row];
 911                                 label_[row] = 0;
 912                                 break;
 913                         }
 914                 }
 915         }
 916         *this = InsetMathHull(buffer_, hullSimple);
 917         label_[0] = label;
 918         cell(0) = ar;
 919         setDefaults();
 920 }
 921
 922
 923 void InsetMathHull::splitTo2Cols()
 924 {
 925         LASSERT(ncols() == 1, /**/);
 926         InsetMathGrid::addCol(1);
 927         for (row_type row = 0; row < nrows(); ++row) {
 928                 idx_type const i = 2 * row;
 929                 pos_type pos = firstRelOp(cell(i));
 930                 cell(i + 1) = MathData(buffer_, cell(i).begin() + pos, cell(i).end());
 931                 cell(i).erase(pos, cell(i).size());
 932         }
 933 }
 934
 935
 936 void InsetMathHull::splitTo3Cols()
 937 {
 938         LASSERT(ncols() < 3, /**/);
 939         if (ncols() < 2)
 940                 splitTo2Cols();
 941         InsetMathGrid::addCol(2);
 942         for (row_type row = 0; row < nrows(); ++row) {
 943                 idx_type const i = 3 * row + 1;
 944                 if (cell(i).size()) {
 945                         cell(i + 1) = MathData(buffer_, cell(i).begin() + 1, cell(i).end());
 946                         cell(i).erase(1, cell(i).size());
 947                 }
 948         }
 949 }
 950
 951
 952 void InsetMathHull::changeCols(col_type cols)
 953 {
 954         if (ncols() == cols)
 955                 return;
 956         else if (ncols() < cols) {
 957                 // split columns
 958                 if (cols < 3)
 959                         splitTo2Cols();
 960                 else {
 961                         splitTo3Cols();
 962                         while (ncols() < cols)
 963                                 InsetMathGrid::addCol(ncols());
 964                 }
 965                 return;
 966         }
 967
 968         // combine columns
 969         for (row_type row = 0; row < nrows(); ++row) {
 970                 idx_type const i = row * ncols();
 971                 for (col_type col = cols; col < ncols(); ++col) {
 972                         cell(i + cols - 1).append(cell(i + col));
 973                 }
 974         }
 975         // delete columns
 976         while (ncols() > cols) {
 977                 InsetMathGrid::delCol(ncols() - 1);
 978         }
 979 }
 980
 981
 982 HullType InsetMathHull::getType() const
 983 {
 984         return type_;
 985 }
 986
 987
 988 void InsetMathHull::setType(HullType type)
 989 {
 990         type_ = type;
 991         setDefaults();
 992 }
 993
 994
 995 void InsetMathHull::mutate(HullType newtype)
 996 {
 997         //lyxerr << "mutating from '" << type_ << "' to '" << newtype << "'" << endl;
 998
 999         // we try to move along the chain
1000         // none <-> simple <-> equation <-> eqnarray -> *align* -> multline, gather -+
1001         //                                     ^                                     |
1002         //                                     +-------------------------------------+
1003         // we use eqnarray as intermediate type for mutations that are not
1004         // directly supported because it handles labels and numbering for
1005         // "down mutation".
1006
1007         if (newtype == type_) {
1008                 // done
1009         }
1010
1011         else if (newtype < hullNone) {
1012                 // unknown type
1013                 dump();
1014         }
1015
1016         else if (type_ == hullNone) {
1017                 setType(hullSimple);
1018                 numbered(0, false);
1019                 mutate(newtype);
1020         }
1021
1022         else if (type_ == hullSimple) {
1023                 if (newtype == hullNone) {
1024                         setType(hullNone);
1025                         numbered(0, false);
1026                 } else {
1027                         setType(hullEquation);
1028                         numbered(0, label_[0] ? true : false);
1029                         mutate(newtype);
1030                 }
1031         }
1032
1033         else if (type_ == hullEquation) {
1034                 if (newtype < type_) {
1035                         setType(hullSimple);
1036                         numbered(0, false);
1037                         mutate(newtype);
1038                 } else if (newtype == hullEqnArray) {
1039                         // split it "nicely" on the first relop
1040                         splitTo3Cols();
1041                         setType(hullEqnArray);
1042                 } else if (newtype == hullMultline || newtype == hullGather) {
1043                         setType(newtype);
1044                 } else {
1045                         // split it "nicely"
1046                         splitTo2Cols();
1047                         setType(hullAlign);
1048                         mutate(newtype);
1049                 }
1050         }
1051
1052         else if (type_ == hullEqnArray) {
1053                 if (newtype < type_) {
1054                         glueall(newtype);
1055                         mutate(newtype);
1056                 } else { // align & Co.
1057                         changeCols(2);
1058                         setType(hullAlign);
1059                         mutate(newtype);
1060                 }
1061         }
1062
1063         else if (type_ ==  hullAlign || type_ == hullAlignAt ||
1064                  type_ == hullXAlignAt || type_ == hullFlAlign) {
1065                 if (newtype < hullAlign) {
1066                         changeCols(3);
1067                         setType(hullEqnArray);
1068                         mutate(newtype);
1069                 } else if (newtype == hullGather || newtype == hullMultline) {
1070                         changeCols(1);
1071                         setType(newtype);
1072                 } else if (newtype ==   hullXXAlignAt) {
1073                         for (row_type row = 0; row < nrows(); ++row)
1074                                 numbered(row, false);
1075                         setType(newtype);
1076                 } else {
1077                         setType(newtype);
1078                 }
1079         }
1080
1081         else if (type_ == hullXXAlignAt) {
1082                 for (row_type row = 0; row < nrows(); ++row)
1083                         numbered(row, false);
1084                 if (newtype < hullAlign) {
1085                         changeCols(3);
1086                         setType(hullEqnArray);
1087                         mutate(newtype);
1088                 } else if (newtype == hullGather || newtype == hullMultline) {
1089                         changeCols(1);
1090                         setType(newtype);
1091                 } else {
1092                         setType(newtype);
1093                 }
1094         }
1095
1096         else if (type_ == hullMultline || type_ == hullGather) {
1097                 if (newtype == hullGather || newtype == hullMultline)
1098                         setType(newtype);
1099                 else if (newtype == hullAlign || newtype == hullFlAlign  ||
1100                          newtype == hullAlignAt || newtype == hullXAlignAt) {
1101                         splitTo2Cols();
1102                         setType(newtype);
1103                 } else if (newtype ==   hullXXAlignAt) {
1104                         splitTo2Cols();
1105                         for (row_type row = 0; row < nrows(); ++row)
1106                                 numbered(row, false);
1107                         setType(newtype);
1108                 } else {
1109                         splitTo3Cols();
1110                         setType(hullEqnArray);
1111                         mutate(newtype);
1112                 }
1113         }
1114
1115         else {
1116                 lyxerr << "mutation from '" << to_utf8(hullName(type_))
1117                        << "' to '" << to_utf8(hullName(newtype))
1118                        << "' not implemented" << endl;
1119         }
1120 }
1121
1122
1123 docstring InsetMathHull::eolString(row_type row, bool fragile, bool last_eoln) const
1124 {
1125         docstring res;
1126         if (numberedType()) {
1127                 if (label_[row] && numbered_[row])
1128                         res += "\\label{" +
1129                             escape(label_[row]->getParam("name")) + '}';
1130                 if (!numbered_[row] && (type_ != hullMultline))
1131                         res += "\\nonumber ";
1132         }
1133         // Never add \\ on the last empty line of eqnarray and friends
1134         last_eoln = false;
1135         return res + InsetMathGrid::eolString(row, fragile, last_eoln);
1136 }
1137
1138
1139 void InsetMathHull::write(WriteStream & os) const
1140 {
1141         ModeSpecifier specifier(os, MATH_MODE);
1142         header_write(os);
1143         InsetMathGrid::write(os);
1144         footer_write(os);
1145 }
1146
1147
1148 void InsetMathHull::normalize(NormalStream & os) const
1149 {
1150         os << "[formula " << hullName(type_) << ' ';
1151         InsetMathGrid::normalize(os);
1152         os << "] ";
1153 }
1154
1155
1156 void InsetMathHull::mathmlize(MathStream & os) const
1157 {
1158         InsetMathGrid::mathmlize(os);
1159 }
1160
1161
1162 void InsetMathHull::infoize(odocstream & os) const
1163 {
1164         os << "Type: " << hullName(type_);
1165 }
1166
1167
1168 void InsetMathHull::check() const
1169 {
1170         LASSERT(numbered_.size() == nrows(), /**/);
1171         LASSERT(label_.size() == nrows(), /**/);
1172 }
1173
1174
1175 void InsetMathHull::doExtern(Cursor & cur, FuncRequest & func)
1176 {
1177         docstring dlang;
1178         docstring extra;
1179         idocstringstream iss(func.argument());
1180         iss >> dlang >> extra;
1181         if (extra.empty())
1182                 extra = from_ascii("noextra");
1183         string const lang = to_ascii(dlang);
1184
1185         // FIXME: temporarily disabled
1186         //if (cur.selection()) {
1187         //      MathData ar;
1188         //      selGet(cur.ar);
1189         //      lyxerr << "use selection: " << ar << endl;
1190         //      insert(pipeThroughExtern(lang, extra, ar));
1191         //      return;
1192         //}
1193
1194         MathData eq;
1195         eq.push_back(MathAtom(new InsetMathChar('=')));
1196
1197         // go to first item in line
1198         cur.idx() -= cur.idx() % ncols();
1199         cur.pos() = 0;
1200
1201         if (getType() == hullSimple) {
1202                 size_type pos = cur.cell().find_last(eq);
1203                 MathData ar;
1204                 if (cur.inMathed() && cur.selection()) {
1205                         asArray(grabAndEraseSelection(cur), ar);
1206                 } else if (pos == cur.cell().size()) {
1207                         ar = cur.cell();
1208                         lyxerr << "use whole cell: " << ar << endl;
1209                 } else {
1210                         ar = MathData(buffer_, cur.cell().begin() + pos + 1, cur.cell().end());
1211                         lyxerr << "use partial cell form pos: " << pos << endl;
1212                 }
1213                 cur.cell().append(eq);
1214                 cur.cell().append(pipeThroughExtern(lang, extra, ar));
1215                 cur.pos() = cur.lastpos();
1216                 return;
1217         }
1218
1219         if (getType() == hullEquation) {
1220                 lyxerr << "use equation inset" << endl;
1221                 mutate(hullEqnArray);
1222                 MathData & ar = cur.cell();
1223                 lyxerr << "use cell: " << ar << endl;
1224                 ++cur.idx();
1225                 cur.cell() = eq;
1226                 ++cur.idx();
1227                 cur.cell() = pipeThroughExtern(lang, extra, ar);
1228                 // move to end of line
1229                 cur.pos() = cur.lastpos();
1230                 return;
1231         }
1232
1233         {
1234                 lyxerr << "use eqnarray" << endl;
1235                 cur.idx() += 2 - cur.idx() % ncols();
1236                 cur.pos() = 0;
1237                 MathData ar = cur.cell();
1238                 lyxerr << "use cell: " << ar << endl;
1239                 // FIXME: temporarily disabled
1240                 addRow(cur.row());
1241                 ++cur.idx();
1242                 ++cur.idx();
1243                 cur.cell() = eq;
1244                 ++cur.idx();
1245                 cur.cell() = pipeThroughExtern(lang, extra, ar);
1246                 cur.pos() = cur.lastpos();
1247         }
1248 }
1249
1250
1251 void InsetMathHull::doDispatch(Cursor & cur, FuncRequest & cmd)
1252 {
1253         //lyxerr << "action: " << cmd.action() << endl;
1254         switch (cmd.action()) {
1255
1256         case LFUN_FINISHED_BACKWARD:
1257         case LFUN_FINISHED_FORWARD:
1258         case LFUN_FINISHED_RIGHT:
1259         case LFUN_FINISHED_LEFT:
1260                 //lyxerr << "action: " << cmd.action() << endl;
1261                 InsetMathGrid::doDispatch(cur, cmd);
1262                 cur.undispatched();
1263                 break;
1264
1265         case LFUN_BREAK_PARAGRAPH:
1266                 // just swallow this
1267                 break;
1268
1269         case LFUN_NEWLINE_INSERT:
1270                 // some magic for the common case
1271                 if (type_ == hullSimple || type_ == hullEquation) {
1272                         cur.recordUndoInset();
1273                         bool const align =
1274                                 cur.bv().buffer().params().use_amsmath == BufferParams::package_on;
1275                         mutate(align ? hullAlign : hullEqnArray);
1276                         // mutate() may change labels and such.
1277                         cur.forceBufferUpdate();
1278                         cur.idx() = nrows() * ncols() - 1;
1279                         cur.pos() = cur.lastpos();
1280                 }
1281                 InsetMathGrid::doDispatch(cur, cmd);
1282                 break;
1283
1284         case LFUN_MATH_NUMBER_TOGGLE: {
1285                 //lyxerr << "toggling all numbers" << endl;
1286                 cur.recordUndoInset();
1287                 bool old = numberedType();
1288                 if (type_ == hullMultline)
1289                         numbered(nrows() - 1, !old);
1290                 else
1291                         for (row_type row = 0; row < nrows(); ++row)
1292                                 numbered(row, !old);
1293
1294                 cur.message(old ? _("No number") : _("Number"));
1295                 cur.forceBufferUpdate();
1296                 break;
1297         }
1298
1299         case LFUN_MATH_NUMBER_LINE_TOGGLE: {
1300                 cur.recordUndoInset();
1301                 row_type r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1302                 bool old = numbered(r);
1303                 cur.message(old ? _("No number") : _("Number"));
1304                 numbered(r, !old);
1305                 cur.forceBufferUpdate();
1306                 break;
1307         }
1308
1309         case LFUN_LABEL_INSERT: {
1310                 cur.recordUndoInset();
1311                 row_type r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1312                 docstring old_label = label(r);
1313                 // FIXME refstyle
1314                 // Allow customization of this separator
1315                 docstring const default_label = from_ascii("eq:");
1316                 if (old_label.empty())
1317                         old_label = default_label;
1318
1319                 InsetCommandParams p(LABEL_CODE);
1320                 p["name"] = cmd.argument().empty() ? old_label : cmd.argument();
1321                 string const data = InsetCommand::params2string(p);
1322
1323                 if (cmd.argument().empty())
1324                         cur.bv().showDialog("label", data);
1325                 else {
1326                         FuncRequest fr(LFUN_INSET_INSERT, data);
1327                         dispatch(cur, fr);
1328                 }
1329                 break;
1330         }
1331
1332         case LFUN_LABEL_COPY_AS_REF: {
1333                 row_type row;
1334                 if (cmd.argument().empty() && &cur.inset() == this)
1335                         // if there is no argument and we're inside math, we retrieve
1336                         // the row number from the cursor position.
1337                         row = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1338                 else {
1339                         // if there is an argument, find the corresponding label, else
1340                         // check whether there is at least one label.
1341                         for (row = 0; row != nrows(); ++row)
1342                                 if (numbered_[row] && label_[row]
1343                                           && (cmd.argument().empty() || label(row) == cmd.argument()))
1344                                         break;
1345                 }
1346
1347                 if (row == nrows())
1348                         break;
1349
1350                 InsetCommandParams p(REF_CODE, "ref");
1351                 p["reference"] = label(row);
1352                 cap::clearSelection();
1353                 cap::copyInset(cur, new InsetRef(buffer_, p), label(row));
1354                 break;
1355         }
1356
1357         case LFUN_WORD_DELETE_FORWARD:
1358         case LFUN_CHAR_DELETE_FORWARD:
1359                 if (col(cur.idx()) + 1 == ncols()
1360                     && cur.pos() == cur.lastpos()
1361                     && !cur.selection()) {
1362                         if (!label(row(cur.idx())).empty()) {
1363                                 cur.recordUndoInset();
1364                                 label(row(cur.idx()), docstring());
1365                         } else if (numbered(row(cur.idx()))) {
1366                                 cur.recordUndoInset();
1367                                 numbered(row(cur.idx()), false);
1368                                 cur.forceBufferUpdate();
1369                         } else {
1370                                 InsetMathGrid::doDispatch(cur, cmd);
1371                                 return;
1372                         }
1373                 } else {
1374                         InsetMathGrid::doDispatch(cur, cmd);
1375                         return;
1376                 }
1377                 break;
1378
1379         case LFUN_INSET_INSERT: {
1380                 //lyxerr << "arg: " << to_utf8(cmd.argument()) << endl;
1381                 // FIXME: this should be cleaned up to use InsetLabel methods directly.
1382                 string const name = cmd.getArg(0);
1383                 if (name == "label") {
1384                         InsetCommandParams p(LABEL_CODE);
1385                         InsetCommand::string2params(to_utf8(cmd.argument()), p);
1386                         docstring str = p["name"];
1387                         cur.recordUndoInset();
1388                         row_type const r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1389                         str = trim(str);
1390                         if (!str.empty())
1391                                 numbered(r, true);
1392                         docstring old = label(r);
1393                         if (str != old) {
1394                                 if (label_[r])
1395                                         // The label will take care of the reference update.
1396                                         label(r, str);
1397                                 else {
1398                                         label(r, str);
1399                                         // Newly created inset so initialize it.
1400                                         label_[r]->initView();
1401                                 }
1402                         }
1403                         cur.forceBufferUpdate();
1404                         break;
1405                 }
1406                 InsetMathGrid::doDispatch(cur, cmd);
1407                 return;
1408         }
1409
1410         case LFUN_MATH_EXTERN:
1411                 cur.recordUndoInset();
1412                 doExtern(cur, cmd);
1413                 break;
1414
1415         case LFUN_MATH_MUTATE: {
1416                 cur.recordUndoInset();
1417                 row_type row = cur.row();
1418                 col_type col = cur.col();
1419                 mutate(hullType(cmd.argument()));
1420                 cur.idx() = row * ncols() + col;
1421                 if (cur.idx() > cur.lastidx()) {
1422                         cur.idx() = cur.lastidx();
1423                         cur.pos() = cur.lastpos();
1424                 }
1425                 if (cur.pos() > cur.lastpos())
1426                         cur.pos() = cur.lastpos();
1427
1428                 cur.forceBufferUpdate();
1429                 // FIXME: find some more clever handling of the selection,
1430                 // i.e. preserve it.
1431                 cur.clearSelection();
1432                 //cur.dispatched(FINISHED);
1433                 break;
1434         }
1435
1436         case LFUN_MATH_DISPLAY: {
1437                 cur.recordUndoInset();
1438                 mutate(type_ == hullSimple ? hullEquation : hullSimple);
1439                 cur.idx() = 0;
1440                 cur.pos() = cur.lastpos();
1441                 //cur.dispatched(FINISHED);
1442                 break;
1443         }
1444
1445         default:
1446                 InsetMathGrid::doDispatch(cur, cmd);
1447                 break;
1448         }
1449 }
1450
1451
1452 bool InsetMathHull::getStatus(Cursor & cur, FuncRequest const & cmd,
1453                 FuncStatus & status) const
1454 {
1455         switch (cmd.action()) {
1456         case LFUN_FINISHED_BACKWARD:
1457         case LFUN_FINISHED_FORWARD:
1458         case LFUN_FINISHED_RIGHT:
1459         case LFUN_FINISHED_LEFT:
1460         case LFUN_UP:
1461         case LFUN_DOWN:
1462         case LFUN_NEWLINE_INSERT:
1463         case LFUN_MATH_EXTERN:
1464         case LFUN_MATH_DISPLAY:
1465                 // we handle these
1466                 status.setEnabled(true);
1467                 return true;
1468
1469         case LFUN_MATH_MUTATE: {
1470                 HullType ht = hullType(cmd.argument());
1471                 status.setOnOff(type_ == ht);
1472                 status.setEnabled(true);
1473                 return true;
1474         }
1475
1476         case LFUN_MATH_NUMBER_TOGGLE:
1477                 // FIXME: what is the right test, this or the one of
1478                 // LABEL_INSERT?
1479                 status.setEnabled(display() != Inline);
1480                 status.setOnOff(numberedType());
1481                 return true;
1482
1483         case LFUN_MATH_NUMBER_LINE_TOGGLE: {
1484                 // FIXME: what is the right test, this or the one of
1485                 // LABEL_INSERT?
1486                 bool const enable = (type_ == hullMultline)
1487                         ? (nrows() - 1 == cur.row())
1488                         : display() != Inline && nrows() > 1;
1489                 row_type const r = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1490                 status.setEnabled(enable);
1491                 status.setOnOff(enable && numbered(r));
1492                 return true;
1493         }
1494
1495         case LFUN_LABEL_INSERT:
1496                 status.setEnabled(type_ != hullSimple);
1497                 return true;
1498
1499         case LFUN_LABEL_COPY_AS_REF: {
1500                 bool enabled = false;
1501                 row_type row;
1502                 if (cmd.argument().empty() && &cur.inset() == this) {
1503                         // if there is no argument and we're inside math, we retrieve
1504                         // the row number from the cursor position.
1505                         row = (type_ == hullMultline) ? nrows() - 1 : cur.row();
1506                         enabled = numberedType() && label_[row] && numbered_[row];
1507                 } else {
1508                         // if there is an argument, find the corresponding label, else
1509                         // check whether there is at least one label.
1510                         for (row_type row = 0; row != nrows(); ++row) {
1511                                 if (numbered_[row] && label_[row] &&
1512                                         (cmd.argument().empty() || label(row) == cmd.argument())) {
1513                                                 enabled = true;
1514                                                 break;
1515                                 }
1516                         }
1517                 }
1518                 status.setEnabled(enabled);
1519                 return true;
1520         }
1521
1522         case LFUN_INSET_INSERT:
1523                 if (cmd.getArg(0) == "label") {
1524                         status.setEnabled(type_ != hullSimple);
1525                         return true;
1526                 }
1527                 return InsetMathGrid::getStatus(cur, cmd, status);
1528
1529         case LFUN_INSET_MODIFY: {
1530                 istringstream is(to_utf8(cmd.argument()));
1531                 string s;
1532                 is >> s;
1533                 if (s != "tabular")
1534                         return InsetMathGrid::getStatus(cur, cmd, status);
1535                 is >> s;
1536                 if (!rowChangeOK()
1537                     && (s == "append-row"
1538                         || s == "delete-row"
1539                         || s == "copy-row")) {
1540                         status.message(bformat(
1541                                 from_utf8(N_("Can't change number of rows in '%1$s'")),
1542                                 hullName(type_)));
1543                         status.setEnabled(false);
1544                         return true;
1545                 }
1546                 if (!colChangeOK()
1547                     && (s == "append-column"
1548                         || s == "delete-column"
1549                         || s == "copy-column")) {
1550                         status.message(bformat(
1551                                 from_utf8(N_("Can't change number of columns in '%1$s'")),
1552                                 hullName(type_)));
1553                         status.setEnabled(false);
1554                         return true;
1555                 }
1556                 if ((type_ == hullSimple
1557                   || type_ == hullEquation
1558                   || type_ == hullNone) &&
1559                     (s == "add-hline-above" || s == "add-hline-below")) {
1560                         status.message(bformat(
1561                                 from_utf8(N_("Can't add horizontal grid lines in '%1$s'")),
1562                                 hullName(type_)));
1563                         status.setEnabled(false);
1564                         return true;
1565                 }
1566                 if (s == "add-vline-left" || s == "add-vline-right") {
1567                         status.message(bformat(
1568                                 from_utf8(N_("Can't add vertical grid lines in '%1$s'")),
1569                                 hullName(type_)));
1570                         status.setEnabled(false);
1571                         return true;
1572                 }
1573                 if (s == "valign-top" || s == "valign-middle"
1574                  || s == "valign-bottom" || s == "align-left"
1575                  || s == "align-center" || s == "align-right") {
1576                         status.setEnabled(false);
1577                         return true;
1578                 }
1579                 return InsetMathGrid::getStatus(cur, cmd, status);
1580         }
1581
1582         default:
1583                 return InsetMathGrid::getStatus(cur, cmd, status);
1584         }
1585
1586         // This cannot really happen, but inserted to shut-up gcc
1587         return InsetMathGrid::getStatus(cur, cmd, status);
1588 }
1589
1590
1591 /////////////////////////////////////////////////////////////////////
1592
1593
1594
1595 // simply scrap this function if you want
1596 void InsetMathHull::mutateToText()
1597 {
1598 #if 0
1599         // translate to latex
1600         ostringstream os;
1601         latex(os, false, false);
1602         string str = os.str();
1603
1604         // insert this text
1605         Text * lt = view_->cursor().innerText();
1606         string::const_iterator cit = str.begin();
1607         string::const_iterator end = str.end();
1608         for (; cit != end; ++cit)
1609                 view_->getIntl()->getTransManager().TranslateAndInsert(*cit, lt);
1610
1611         // remove ourselves
1612         //dispatch(LFUN_ESCAPE);
1613 #endif
1614 }
1615
1616
1617 void InsetMathHull::handleFont(Cursor & cur, docstring const & arg,
1618         docstring const & font)
1619 {
1620         // this whole function is a hack and won't work for incremental font
1621         // changes...
1622         cur.recordUndo();
1623         if (cur.inset().asInsetMath()->name() == font)
1624                 cur.handleFont(to_utf8(font));
1625         else {
1626                 cur.handleNest(createInsetMath(font, cur.buffer()));
1627                 cur.insert(arg);
1628         }
1629 }
1630
1631
1632 void InsetMathHull::handleFont2(Cursor & cur, docstring const & arg)
1633 {
1634         cur.recordUndo();
1635         Font font;
1636         bool b;
1637         font.fromString(to_utf8(arg), b);
1638         if (font.fontInfo().color() != Color_inherit) {
1639                 MathAtom at = MathAtom(new InsetMathColor(buffer_, true, font.fontInfo().color()));
1640                 cur.handleNest(at, 0);
1641         }
1642 }
1643
1644
1645 void InsetMathHull::edit(Cursor & cur, bool front, EntryDirection entry_from)
1646 {
1647         cur.push(*this);
1648         bool enter_front = (entry_from == Inset::ENTRY_DIRECTION_LEFT ||
1649                 (entry_from == Inset::ENTRY_DIRECTION_IGNORE && front));
1650         enter_front ? idxFirst(cur) : idxLast(cur);
1651         // The inset formula dimension is not necessarily the same as the
1652         // one of the instant preview image, so we have to indicate to the
1653         // BufferView that a metrics update is needed.
1654         cur.screenUpdateFlags(Update::Force);
1655 }
1656
1657
1658 void InsetMathHull::revealCodes(Cursor & cur) const
1659 {
1660         if (!cur.inMathed())
1661                 return;
1662         odocstringstream os;
1663         cur.info(os);
1664         cur.message(os.str());
1665 /*
1666         // write something to the minibuffer
1667         // translate to latex
1668         cur.markInsert(bv);
1669         ostringstream os;
1670         write(os);
1671         string str = os.str();
1672         cur.markErase(bv);
1673         string::size_type pos = 0;
1674         string res;
1675         for (string::iterator it = str.begin(); it != str.end(); ++it) {
1676                 if (*it == '\n')
1677                         res += ' ';
1678                 else if (*it == '\0') {
1679                         res += "  -X-  ";
1680                         pos = it - str.begin();
1681                 }
1682                 else
1683                         res += *it;
1684         }
1685         if (pos > 30)
1686                 res = res.substr(pos - 30);
1687         if (res.size() > 60)
1688                 res = res.substr(0, 60);
1689         cur.message(res);
1690 */
1691 }
1692
1693
1694 /////////////////////////////////////////////////////////////////////
1695
1696
1697 #if 0
1698 bool InsetMathHull::searchForward(BufferView * bv, string const & str,
1699                                      bool, bool)
1700 {
1701         // FIXME: completely broken
1702         static InsetMathHull * lastformula = 0;
1703         static CursorBase current = DocIterator(ibegin(nucleus()));
1704         static MathData ar;
1705         static string laststr;
1706
1707         if (lastformula != this || laststr != str) {
1708                 //lyxerr << "reset lastformula to " << this << endl;
1709                 lastformula = this;
1710                 laststr = str;
1711                 current = ibegin(nucleus());
1712                 ar.clear();
1713                 mathed_parse_cell(ar, str, Parse::NORMAL, &buffer());
1714         } else {
1715                 increment(current);
1716         }
1717         //lyxerr << "searching '" << str << "' in " << this << ar << endl;
1718
1719         for (DocIterator it = current; it != iend(nucleus()); increment(it)) {
1720                 CursorSlice & top = it.back();
1721                 MathData const & a = top.asInsetMath()->cell(top.idx_);
1722                 if (a.matchpart(ar, top.pos_)) {
1723                         bv->cursor().setSelection(it, ar.size());
1724                         current = it;
1725                         top.pos_ += ar.size();
1726                         bv->update();
1727                         return true;
1728                 }
1729         }
1730
1731         //lyxerr << "not found!" << endl;
1732         lastformula = 0;
1733         return false;
1734 }
1735 #endif
1736
1737
1738 void InsetMathHull::write(ostream & os) const
1739 {
1740         odocstringstream oss;
1741         WriteStream wi(oss, false, false, WriteStream::wsDefault);
1742         oss << "Formula ";
1743         write(wi);
1744         os << to_utf8(oss.str());
1745 }
1746
1747
1748 void InsetMathHull::read(Lexer & lex)
1749 {
1750         MathAtom at;
1751         mathed_parse_normal(buffer_, at, lex, Parse::TRACKMACRO);
1752         operator=(*at->asHullInset());
1753 }
1754
1755
1756 bool InsetMathHull::readQuiet(Lexer & lex)
1757 {
1758         MathAtom at;
1759         bool success = mathed_parse_normal(buffer_, at, lex, Parse::QUIET);
1760         if (success)
1761                 operator=(*at->asHullInset());
1762         return success;
1763 }
1764
1765
1766 int InsetMathHull::plaintext(odocstream & os, OutputParams const &) const
1767 {
1768         // disables ASCII-art for export of equations. See #2275.
1769         if (0 && display()) {
1770                 Dimension dim;
1771                 TextMetricsInfo mi;
1772                 metricsT(mi, dim);
1773                 TextPainter tpain(dim.width(), dim.height());
1774                 drawT(tpain, 0, dim.ascent());
1775                 tpain.show(os, 3);
1776                 // reset metrics cache to "real" values
1777                 //metrics();
1778                 return tpain.textheight();
1779         } else {
1780                 odocstringstream oss;
1781                 Encoding const * const enc = encodings.fromLyXName("utf8");
1782                 WriteStream wi(oss, false, true, WriteStream::wsDefault, enc);
1783                 // Fix Bug #6139
1784                 if (type_ == hullRegexp)
1785                         write(wi);
1786                 else
1787                         wi << cell(0);
1788                 docstring const str = oss.str();
1789                 os << str;
1790                 return str.size();
1791         }
1792 }
1793
1794
1795 int InsetMathHull::docbook(odocstream & os, OutputParams const & runparams) const
1796 {
1797         MathStream ms(os);
1798         int res = 0;
1799         docstring name;
1800         if (getType() == hullSimple)
1801                 name = from_ascii("inlineequation");
1802         else
1803                 name = from_ascii("informalequation");
1804
1805         docstring bname = name;
1806         if (!label(0).empty())
1807                 bname += " id='" + sgml::cleanID(buffer(), runparams, label(0)) + "'";
1808
1809         ++ms.tab(); ms.cr(); ms.os() << '<' << bname << '>';
1810
1811         odocstringstream ls;
1812         if (runparams.flavor == OutputParams::XML) {
1813                 ms << MTag("alt role='tex' ");
1814                 // Workaround for db2latex: db2latex always includes equations with
1815                 // \ensuremath{} or \begin{display}\end{display}
1816                 // so we strip LyX' math environment
1817                 WriteStream wi(ls, false, false, WriteStream::wsDefault, runparams.encoding);
1818                 InsetMathGrid::write(wi);
1819                 ms << from_utf8(subst(subst(to_utf8(ls.str()), "&", "&amp;"), "<", "&lt;"));
1820                 ms << ETag("alt");
1821                 ms << MTag("math");
1822                 ms << ETag("alt");
1823                 ms << MTag("math");
1824                 InsetMathGrid::mathmlize(ms);
1825                 ms << ETag("math");
1826         } else {
1827                 ms << MTag("alt role='tex'");
1828                 res = latex(ls, runparams);
1829                 ms << from_utf8(subst(subst(to_utf8(ls.str()), "&", "&amp;"), "<", "&lt;"));
1830                 ms << ETag("alt");
1831         }
1832
1833         ms << from_ascii("<graphic fileref=\"eqn/");
1834         if (!label(0).empty())
1835                 ms << sgml::cleanID(buffer(), runparams, label(0));
1836         else
1837                 ms << sgml::uniqueID(from_ascii("anon"));
1838
1839         if (runparams.flavor == OutputParams::XML)
1840                 ms << from_ascii("\"/>");
1841         else
1842                 ms << from_ascii("\">");
1843
1844         ms.cr(); --ms.tab(); ms.os() << "</" << name << '>';
1845
1846         return ms.line() + res;
1847 }
1848
1849
1850 docstring InsetMathHull::xhtml(XHTMLStream & xs, OutputParams const & op) const
1851 {
1852         BufferParams::MathOutput const mathtype =
1853                 buffer().params().html_math_output;
1854
1855         bool success = false;
1856         // FIXME Eventually we would like to do this inset by inset.
1857         if (mathtype == BufferParams::MathML) {
1858                 odocstringstream os;
1859                 MathStream ms(os);
1860                 try {
1861                         InsetMathGrid::mathmlize(ms);
1862                         success = true;
1863                 } catch (MathExportException const &) {}
1864                 if (success) {
1865                         if (getType() == hullSimple)
1866                                 xs << html::StartTag("math",
1867                                                         "xmlns=\"http://www.w3.org/1998/Math/MathML\"", true);
1868                         else
1869                                 xs << html::StartTag("math",
1870                                                         "display=\"block\" xmlns=\"http://www.w3.org/1998/Math/MathML\"", true);
1871                         xs << XHTMLStream::NextRaw()
1872                                  << os.str()
1873                                  << html::EndTag("math");
1874                 }
1875         } else if (mathtype == BufferParams::HTML) {
1876                 odocstringstream os;
1877                 HtmlStream ms(os);
1878                 try {
1879                         InsetMathGrid::htmlize(ms);
1880                         success = true;
1881                 } catch (MathExportException const &) {}
1882                 if (success) {
1883                         string const tag = (getType() == hullSimple) ? "span" : "div";
1884                         xs << html::StartTag(tag, "class='formula'", true)
1885                                  << XHTMLStream::NextRaw()
1886                                  << os.str()
1887                                  << html::EndTag(tag);
1888                 }
1889         }
1890
1891         // what we actually want is this:
1892         // if (
1893         //     ((mathtype == BufferParams::MathML || mathtype == BufferParams::HTML)
1894         //       && !success)
1895         //     || mathtype == BufferParams::Images
1896         //    )
1897         // but what follows is equivalent, since we'll enter only if either (a) we
1898         // tried and failed with MathML or HTML or (b) didn't try yet at all but
1899         // aren't doing LaTeX, in which case we are doing Images.
1900         if (!success && mathtype != BufferParams::LaTeX) {
1901                 loadPreview(docit_);
1902                 graphics::PreviewImage const * pimage = preview_->getPreviewImage(buffer());
1903                 if (pimage) {
1904                         // FIXME Do we always have png?
1905                         string const tag = (getType() == hullSimple) ? "span" : "div";
1906                         FileName const & mathimg = pimage->filename();
1907                         xs << html::StartTag(tag)
1908                            << html::CompTag("img", "src=\"" + mathimg.onlyFileName() + "\"")
1909                            << html::EndTag(tag);
1910                         xs.cr();
1911                         // add the file to the list of files to be exported
1912                         op.exportdata->addExternalFile("xhtml", mathimg);
1913                         success = true;
1914                 }
1915         }
1916
1917         // so we'll pass this test if we've failed everything else, or
1918         // if mathtype was LaTeX, since we won't have entered any of the
1919         // earlier branches
1920         if (!success /* || mathtype != BufferParams::LaTeX */) {
1921                 string const tag = (getType() == hullSimple) ? "span" : "div";
1922                 // Unfortunately, we cannot use latexString() because we do not want
1923                 // $...$ or whatever.
1924                 odocstringstream ls;
1925                 WriteStream wi(ls, false, true, WriteStream::wsPreview);
1926                 ModeSpecifier specifier(wi, MATH_MODE);
1927                 InsetMathGrid::write(wi);
1928                 docstring const latex = ls.str();
1929
1930                 // class='math' allows for use of jsMath
1931                 // http://www.math.union.edu/~dpvc/jsMath/
1932                 // FIXME XHTML
1933                 // probably should allow for some kind of customization here
1934                 xs << html::StartTag(tag, "class='math'")
1935                    << latex
1936                    << html::EndTag(tag);
1937                 xs.cr();
1938         }
1939         return docstring();
1940 }
1941
1942
1943 void InsetMathHull::tocString(odocstream & os) const
1944 {
1945         plaintext(os, OutputParams(0));
1946 }
1947
1948
1949 docstring InsetMathHull::contextMenu(BufferView const &, int, int) const
1950 {
1951         return from_ascii("context-math");
1952 }
1953
1954
1955 void InsetMathHull::recordLocation(DocIterator const & di)
1956 {
1957         docit_ = di;
1958 }
1959
1960 } // namespace lyx