src/mathed/InsetMathNest.cpp

   1 /**
   2  * \file InsetMathNest.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 "InsetMathNest.h"
  14
  15 #include "InsetMathArray.h"
  16 #include "InsetMathAMSArray.h"
  17 #include "InsetMathBig.h"
  18 #include "InsetMathBox.h"
  19 #include "InsetMathBrace.h"
  20 #include "InsetMathChar.h"
  21 #include "InsetMathColor.h"
  22 #include "InsetMathComment.h"
  23 #include "InsetMathDelim.h"
  24 #include "InsetMathEnsureMath.h"
  25 #include "InsetMathHull.h"
  26 #include "InsetMathRef.h"
  27 #include "InsetMathScript.h"
  28 #include "InsetMathSpace.h"
  29 #include "InsetMathSymbol.h"
  30 #include "InsetMathUnknown.h"
  31 #include "MathAutoCorrect.h"
  32 #include "MathCompletionList.h"
  33 #include "MathFactory.h"
  34 #include "InsetMathMacro.h"
  35 #include "InsetMathMacroArgument.h"
  36 #include "MathParser.h"
  37 #include "MathStream.h"
  38 #include "MathSupport.h"
  39
  40 #include "Buffer.h"
  41 #include "BufferParams.h"
  42 #include "BufferView.h"
  43 #include "CoordCache.h"
  44 #include "Cursor.h"
  45 #include "CutAndPaste.h"
  46 #include "DispatchResult.h"
  47 #include "Encoding.h"
  48 #include "FuncRequest.h"
  49 #include "FuncStatus.h"
  50 #include "LaTeXFeatures.h"
  51 #include "LyX.h"
  52 #include "LyXRC.h"
  53 #include "MetricsInfo.h"
  54 #include "TexRow.h"
  55 #include "Text.h"
  56
  57 #include "frontends/Application.h"
  58 #include "frontends/Clipboard.h"
  59 #include "frontends/Painter.h"
  60 #include "frontends/Selection.h"
  61
  62 #include "support/debug.h"
  63 #include "support/docstream.h"
  64 #include "support/gettext.h"
  65 #include "support/lassert.h"
  66 #include "support/lstrings.h"
  67 #include "support/textutils.h"
  68
  69 #include <algorithm>
  70 #include <sstream>
  71
  72 using namespace std;
  73 using namespace lyx::support;
  74
  75 namespace lyx {
  76
  77 using cap::copySelection;
  78 using cap::grabAndEraseSelection;
  79 using cap::cutSelection;
  80 using cap::replaceSelection;
  81 using cap::selClearOrDel;
  82
  83
  84 InsetMathNest::InsetMathNest(Buffer * buf, idx_type nargs)
  85         : InsetMath(buf), cells_(nargs), lock_(false)
  86 {
  87         // FIXME This should not really be necessary, but when we are
  88         // initializing the table of global macros, we create macros
  89         // with no associated Buffer.
  90         if (buf)
  91                 setBuffer(*buf);
  92 }
  93
  94
  95 InsetMathNest::InsetMathNest(InsetMathNest const & inset)
  96         : InsetMath(inset), cells_(inset.cells_), lock_(inset.lock_)
  97 {}
  98
  99
 100 InsetMathNest::~InsetMathNest()
 101 {
 102         map<BufferView const *, bool>::iterator it = mouse_hover_.begin();
 103         map<BufferView const *, bool>::iterator end = mouse_hover_.end();
 104         for (; it != end; ++it)
 105                 if (it->second)
 106                         it->first->clearLastInset(this);
 107 }
 108
 109
 110 InsetMathNest & InsetMathNest::operator=(InsetMathNest const & inset)
 111 {
 112         cells_ = inset.cells_;
 113         lock_ = inset.lock_;
 114         mouse_hover_.clear();
 115         InsetMath::operator=(inset);
 116         return *this;
 117 }
 118
 119
 120 void InsetMathNest::setBuffer(Buffer & buffer)
 121 {
 122         InsetMath::setBuffer(buffer);
 123         for (MathData & data : cells_)
 124                 data.setBuffer(buffer);
 125 }
 126
 127
 128 idx_type InsetMathNest::nargs() const
 129 {
 130         return cells_.size();
 131 }
 132
 133
 134 void InsetMathNest::cursorPos(BufferView const & bv,
 135                 CursorSlice const & sl, bool /*boundary*/,
 136                 int & x, int & y) const
 137 {
 138 // FIXME: This is a hack. Ideally, the coord cache should not store
 139 // absolute positions, but relative ones. This would mean to call
 140 // setXY() not in MathData::draw(), but in the parent insets' draw()
 141 // with the correctly adjusted x,y values. But this means that we'd have
 142 // to touch all (math)inset's draw() methods. Right now, we'll store
 143 // absolute value, and make them here relative, only to make them
 144 // absolute again when actually drawing the cursor. What a mess.
 145         LASSERT(&sl.inset() == this, return);
 146         MathData const & ar = sl.cell();
 147         CoordCache const & coord_cache = bv.coordCache();
 148         if (!coord_cache.getArrays().has(&ar)) {
 149                 // this can (semi-)legally happen if we just created this cell
 150                 // and it never has been drawn before. So don't ASSERT.
 151                 //lyxerr << "no cached data for array " << &ar << endl;
 152                 x = 0;
 153                 y = 0;
 154                 return;
 155         }
 156         Point const pt = coord_cache.getArrays().xy(&ar);
 157         if (!coord_cache.getInsets().has(this)) {
 158                 // same as above
 159                 //lyxerr << "no cached data for inset " << this << endl;
 160                 x = 0;
 161                 y = 0;
 162                 return;
 163         }
 164         Point const pt2 = coord_cache.getInsets().xy(this);
 165         //lyxerr << "retrieving position cache for MathData "
 166         //      << pt.x_ << ' ' << pt.y_ << endl;
 167         x = pt.x_ - pt2.x_ + ar.pos2x(&bv, sl.pos());
 168         y = pt.y_ - pt2.y_;
 169 //      lyxerr << "pt.y_ : " << pt.y_ << " pt2_.y_ : " << pt2.y_
 170 //              << " asc: " << ascent() << "  des: " << descent()
 171 //              << " ar.asc: " << ar.ascent() << " ar.des: " << ar.descent() << endl;
 172         // move cursor visually into empty cells ("blue rectangles");
 173         if (ar.empty()) {
 174                 Dimension const dim = coord_cache.getArrays().dim(&ar);
 175                 x += dim.wid / 3;
 176         }
 177 }
 178
 179
 180 void InsetMathNest::cellsMetrics(MetricsInfo const & mi) const
 181 {
 182         MetricsInfo m = mi;
 183         for (auto const & cell : cells_) {
 184                 Dimension dim;
 185                 cell.metrics(m, dim);
 186         }
 187 }
 188
 189
 190 void InsetMathNest::updateBuffer(ParIterator const & it, UpdateType utype, bool const deleted)
 191 {
 192         for (idx_type i = 0, n = nargs(); i != n; ++i)
 193                 cell(i).updateBuffer(it, utype, deleted);
 194 }
 195
 196
 197
 198 bool InsetMathNest::idxNext(Cursor & cur) const
 199 {
 200         LASSERT(&cur.inset() == this, return false);
 201         if (cur.idx() == cur.lastidx())
 202                 return false;
 203         ++cur.idx();
 204         cur.pos() = 0;
 205         return true;
 206 }
 207
 208
 209 bool InsetMathNest::idxForward(Cursor & cur) const
 210 {
 211         return idxNext(cur);
 212 }
 213
 214
 215 bool InsetMathNest::idxPrev(Cursor & cur) const
 216 {
 217         LASSERT(&cur.inset() == this, return false);
 218         if (cur.idx() == 0)
 219                 return false;
 220         --cur.idx();
 221         cur.pos() = lyxrc.mac_like_cursor_movement ? cur.lastpos() : 0;
 222         return true;
 223 }
 224
 225
 226 bool InsetMathNest::idxBackward(Cursor & cur) const
 227 {
 228         return idxPrev(cur);
 229 }
 230
 231
 232 bool InsetMathNest::idxFirst(Cursor & cur) const
 233 {
 234         LASSERT(&cur.inset() == this, return false);
 235         if (nargs() == 0)
 236                 return false;
 237         cur.idx() = firstIdx();
 238         cur.pos() = 0;
 239         return true;
 240 }
 241
 242
 243 bool InsetMathNest::idxLast(Cursor & cur) const
 244 {
 245         LASSERT(&cur.inset() == this, return false);
 246         if (nargs() == 0)
 247                 return false;
 248         cur.idx() = lastIdx();
 249         cur.pos() = cur.lastpos();
 250         return true;
 251 }
 252
 253
 254 void InsetMathNest::dump() const
 255 {
 256         odocstringstream oss;
 257         otexrowstream ots(oss);
 258         TeXMathStream os(ots);
 259         os << "---------------------------------------------\n";
 260         write(os);
 261         os << "\n";
 262         for (idx_type i = 0, n = nargs(); i != n; ++i)
 263                 os << cell(i) << "\n";
 264         os << "---------------------------------------------\n";
 265         lyxerr << to_utf8(oss.str());
 266 }
 267
 268
 269 void InsetMathNest::draw(PainterInfo &, int, int) const
 270 {
 271 #if 0
 272         if (lock_)
 273                 pi.pain.fillRectangle(x, y - ascent(), width(), height(),
 274                                         Color_mathlockbg);
 275 #endif
 276 }
 277
 278
 279 void InsetMathNest::validate(LaTeXFeatures & features) const
 280 {
 281         for (idx_type i = 0; i < nargs(); ++i)
 282                 cell(i).validate(features);
 283 }
 284
 285
 286 void InsetMathNest::replace(ReplaceData & rep)
 287 {
 288         for (idx_type i = 0; i < nargs(); ++i)
 289                 cell(i).replace(rep);
 290 }
 291
 292
 293 bool InsetMathNest::contains(MathData const & ar) const
 294 {
 295         for (idx_type i = 0; i < nargs(); ++i)
 296                 if (cell(i).contains(ar))
 297                         return true;
 298         return false;
 299 }
 300
 301
 302 bool InsetMathNest::lock() const
 303 {
 304         return lock_;
 305 }
 306
 307
 308 void InsetMathNest::lock(bool l)
 309 {
 310         lock_ = l;
 311 }
 312
 313
 314 bool InsetMathNest::isActive() const
 315 {
 316         return nargs() > 0;
 317 }
 318
 319
 320 MathData InsetMathNest::glue() const
 321 {
 322         MathData ar;
 323         for (size_t i = 0; i < nargs(); ++i)
 324                 ar.append(cell(i));
 325         return ar;
 326 }
 327
 328
 329 void InsetMathNest::write(TeXMathStream & os) const
 330 {
 331         MathEnsurer ensurer(os, currentMode() == MATH_MODE);
 332         ModeSpecifier specifier(os, currentMode(), lockedMode());
 333         docstring const latex_name = name();
 334         os << '\\' << latex_name;
 335         os.inMathClass(asClassInset());
 336         for (size_t i = 0; i < nargs(); ++i) {
 337                 Changer dummy = os.changeRowEntry(TexRow::mathEntry(id(),i));
 338                 os << '{' << cell(i) << '}';
 339         }
 340         if (nargs() == 0)
 341                 os.pendingSpace(true);
 342         if (lock_ && !os.latex()) {
 343                 os << "\\lyxlock";
 344                 os.pendingSpace(true);
 345         }
 346         os.inMathClass(false);
 347 }
 348
 349
 350 void InsetMathNest::normalize(NormalStream & os) const
 351 {
 352         os << '[' << name();
 353         for (size_t i = 0; i < nargs(); ++i)
 354                 os << ' ' << cell(i);
 355         os << ']';
 356 }
 357
 358
 359 void InsetMathNest::latex(otexstream & os, OutputParams const & runparams) const
 360 {
 361         TeXMathStream::OutputType ot;
 362         if (runparams.for_searchAdv != OutputParams::NoSearch)
 363                 ot = TeXMathStream::wsSearchAdv;
 364         else if (runparams.dryrun)
 365                 ot = TeXMathStream::wsDryrun;
 366         else
 367                 ot = TeXMathStream::wsDefault;
 368         TeXMathStream wi(os, runparams.moving_arg, true, ot,
 369                          runparams.encoding);
 370         wi.strikeoutMath(runparams.inDeletedInset);
 371         if (runparams.inulemcmd) {
 372                 wi.ulemCmd(TeXMathStream::UNDERLINE);
 373                 if (runparams.local_font) {
 374                         FontInfo f = runparams.local_font->fontInfo();
 375                         if (f.strikeout() == FONT_ON)
 376                                 wi.ulemCmd(TeXMathStream::STRIKEOUT);
 377                 }
 378         }
 379         wi.canBreakLine(os.canBreakLine());
 380         Changer dummy = wi.changeRowEntry(TexRow::textEntry(runparams.lastid,
 381                                                             runparams.lastpos));
 382         write(wi);
 383         // Reset parbreak and command termination status after a math inset.
 384         os.lastChar(0);
 385         os.canBreakLine(wi.canBreakLine());
 386         os.terminateCommand(false);
 387 }
 388
 389
 390 bool InsetMathNest::setMouseHover(BufferView const * bv, bool mouse_hover)
 391         const
 392 {
 393         mouse_hover_[bv] = mouse_hover;
 394         return true;
 395 }
 396
 397
 398 bool InsetMathNest::notifyCursorLeaves(Cursor const & /*old*/, Cursor & /*cur*/)
 399 {
 400         // FIXME: look here
 401 #if 0
 402         MathData & ar = cur.cell();
 403         // remove base-only "scripts"
 404         for (pos_type i = 0; i + 1 < ar.size(); ++i) {
 405                 InsetMathScript * p = operator[](i).nucleus()->asScriptInset();
 406                 if (p && p->nargs() == 1) {
 407                         MathData ar = p->nuc();
 408                         erase(i);
 409                         insert(i, ar);
 410                         cur.adjust(i, ar.size() - 1);
 411                 }
 412         }
 413
 414         // glue adjacent font insets of the same kind
 415         for (pos_type i = 0; i + 1 < size(); ++i) {
 416                 InsetMathFont * p = operator[](i).nucleus()->asFontInset();
 417                 InsetMathFont const * q = operator[](i + 1)->asFontInset();
 418                 if (p && q && p->name() == q->name()) {
 419                         p->cell(0).append(q->cell(0));
 420                         erase(i + 1);
 421                         cur.adjust(i, -1);
 422                 }
 423         }
 424 #endif
 425         return false;
 426 }
 427
 428
 429 void InsetMathNest::handleFont
 430         (Cursor & cur, docstring const & arg, char const * const font)
 431 {
 432         handleFont(cur, arg, from_ascii(font));
 433 }
 434
 435
 436 void InsetMathNest::handleFont(Cursor & cur, docstring const & arg,
 437         docstring const & font)
 438 {
 439         cur.recordUndoSelection();
 440
 441         // this whole function is a hack and won't work for incremental font
 442         // changes...
 443         if (cur.inset().asInsetMath()->name() == font)
 444                 cur.handleFont(to_utf8(font));
 445         else
 446                 handleNest(cur, createInsetMath(font, cur.buffer()), arg);
 447 }
 448
 449
 450 void InsetMathNest::handleNest(Cursor & cur, MathAtom const & nest)
 451 {
 452         handleNest(cur, nest, docstring());
 453 }
 454
 455
 456 void InsetMathNest::handleNest(Cursor & cur, MathAtom const & nest,
 457         docstring const & arg)
 458 {
 459         DocIterator const i1 = cur.selectionBegin();
 460         DocIterator const i2 = cur.selectionEnd();
 461         if (!i1.inset().asInsetMath())
 462                 return;
 463         if (i1.idx() == i2.idx()) {
 464                 // the easy case where only one cell is selected
 465                 cur.handleNest(nest);
 466                 cur.insert(arg);
 467                 return;
 468         }
 469
 470         // multiple selected cells in a simple non-grid inset
 471         if (i1.inset().nrows() == 0 || i1.inset().ncols() == 0) {
 472                 for (idx_type i = i1.idx(); i <= i2.idx(); ++i) {
 473                         cur.setCursor(i1);
 474                         // select cell
 475                         cur.idx() = i;
 476                         cur.pos() = 0;
 477                         cur.resetAnchor();
 478                         cur.pos() = cur.lastpos();
 479                         cur.setSelection();
 480
 481                         // do the real job
 482                         cur.handleNest(nest);
 483                         cur.insert(arg);
 484                 }
 485                 return;
 486         }
 487
 488         // the complicated case with multiple selected cells in a grid
 489         row_type r1, r2;
 490         col_type c1, c2;
 491         cap::region(i1.top(), i2.top(), r1, r2, c1, c2);
 492         for (row_type row = r1; row <= r2; ++row) {
 493                 for (col_type col = c1; col <= c2; ++col) {
 494                         cur.setCursor(i1);
 495                         // select cell
 496                         cur.idx() = i1.inset().index(row, col);
 497                         cur.pos() = 0;
 498                         cur.resetAnchor();
 499                         cur.pos() = cur.lastpos();
 500                         cur.setSelection();
 501
 502                         // do the real job
 503                         cur.handleNest(nest);
 504                         cur.insert(arg);
 505                 }
 506         }
 507 }
 508
 509
 510 void InsetMathNest::handleFont2(Cursor & cur, docstring const & arg)
 511 {
 512         cur.recordUndoSelection();
 513         Font font;
 514         bool b;
 515         font.fromString(to_utf8(arg), b);
 516         if (font.fontInfo().color() != Color_inherit &&
 517             font.fontInfo().color() != Color_ignore)
 518                 handleNest(cur, MathAtom(new InsetMathColor(buffer_, true, font.fontInfo().color())));
 519
 520         // FIXME: support other font changes here as well?
 521 }
 522
 523 void InsetMathNest::doDispatch(Cursor & cur, FuncRequest & cmd)
 524 {
 525         //LYXERR0("InsetMathNest: request: " << cmd);
 526
 527         Parse::flags parseflg = Parse::QUIET | Parse::USETEXT;
 528
 529         FuncCode const act = cmd.action();
 530         switch (act) {
 531
 532         case LFUN_CLIPBOARD_PASTE:
 533                 parseflg |= Parse::VERBATIM;
 534                 // fall through
 535         case LFUN_PASTE: {
 536                 if (cur.currentMode() != MATH_MODE)
 537                         parseflg |= Parse::TEXTMODE;
 538                 cur.recordUndoSelection();
 539                 cur.message(_("Paste"));
 540                 replaceSelection(cur);
 541                 docstring topaste;
 542                 if (cmd.argument().empty() && !theClipboard().isInternal())
 543                         topaste = theClipboard().getAsText(frontend::Clipboard::PlainTextType);
 544                 else {
 545                         size_t n = 0;
 546                         idocstringstream is(cmd.argument());
 547                         is >> n;
 548                         topaste = cap::selection(n, make_pair(buffer().params().documentClassPtr(),
 549                                                               buffer().params().authors()));
 550                 }
 551                 cur.niceInsert(topaste, parseflg, false);
 552                 cur.clearSelection(); // bug 393
 553                 cur.forceBufferUpdate();
 554                 cur.finishUndo();
 555                 break;
 556         }
 557
 558         case LFUN_CUT:
 559                 cur.recordUndo();
 560                 cutSelection(cur, true);
 561                 cur.message(_("Cut"));
 562                 // Prevent stale position >= size crash
 563                 // Probably not necessary anymore, see eraseSelection (gb 2005-10-09)
 564                 cur.normalize();
 565                 cur.forceBufferUpdate();
 566                 break;
 567
 568         case LFUN_MOUSE_PRESS:
 569                 lfunMousePress(cur, cmd);
 570                 break;
 571
 572         case LFUN_MOUSE_MOTION:
 573                 lfunMouseMotion(cur, cmd);
 574                 break;
 575
 576         case LFUN_MOUSE_RELEASE:
 577                 lfunMouseRelease(cur, cmd);
 578                 break;
 579
 580         case LFUN_FINISHED_LEFT: // in math, left is backwards
 581         case LFUN_FINISHED_BACKWARD:
 582                 cur.bv().cursor() = cur;
 583                 break;
 584
 585         case LFUN_FINISHED_RIGHT: // in math, right is forward
 586         case LFUN_FINISHED_FORWARD:
 587                 ++cur.pos();
 588                 cur.bv().cursor() = cur;
 589                 break;
 590
 591         case LFUN_WORD_RIGHT:
 592         case LFUN_WORD_LEFT:
 593         case LFUN_WORD_BACKWARD:
 594         case LFUN_WORD_FORWARD:
 595         case LFUN_CHAR_RIGHT:
 596         case LFUN_CHAR_LEFT:
 597         case LFUN_CHAR_BACKWARD:
 598         case LFUN_CHAR_FORWARD:
 599                 cur.screenUpdateFlags(Update::Decoration | Update::FitCursor);
 600                 // fall through
 601         case LFUN_WORD_RIGHT_SELECT:
 602         case LFUN_WORD_LEFT_SELECT:
 603         case LFUN_WORD_BACKWARD_SELECT:
 604         case LFUN_WORD_FORWARD_SELECT:
 605         case LFUN_CHAR_RIGHT_SELECT:
 606         case LFUN_CHAR_LEFT_SELECT:
 607         case LFUN_CHAR_BACKWARD_SELECT:
 608         case LFUN_CHAR_FORWARD_SELECT: {
 609                 // are we in a selection?
 610                 bool select = (act == LFUN_WORD_RIGHT_SELECT
 611                                            || act == LFUN_WORD_LEFT_SELECT
 612                                            || act == LFUN_WORD_BACKWARD_SELECT
 613                                            || act == LFUN_WORD_FORWARD_SELECT
 614                                || act == LFUN_CHAR_RIGHT_SELECT
 615                                            || act == LFUN_CHAR_LEFT_SELECT
 616                                            || act == LFUN_CHAR_BACKWARD_SELECT
 617                                            || act == LFUN_CHAR_FORWARD_SELECT);
 618                 // select words
 619                 bool word = (act == LFUN_WORD_RIGHT_SELECT
 620                              || act == LFUN_WORD_LEFT_SELECT
 621                              || act == LFUN_WORD_BACKWARD_SELECT
 622                              || act == LFUN_WORD_FORWARD_SELECT
 623                              || act == LFUN_WORD_RIGHT
 624                              || act == LFUN_WORD_LEFT
 625                              || act == LFUN_WORD_BACKWARD
 626                              || act == LFUN_WORD_FORWARD);
 627                 // are we moving forward or backwards?
 628                 // If the command was RIGHT or LEFT, then whether we're moving forward
 629                 // or backwards depends on the cursor movement mode (logical or visual):
 630                 //  * in visual mode, since math is always LTR, right -> forward,
 631                 //    left -> backwards
 632                 //  * in logical mode, the mapping is determined by the
 633                 //    reverseDirectionNeeded() function
 634
 635                 bool forward;
 636                 FuncCode finish_lfun;
 637
 638                 if (act == LFUN_CHAR_FORWARD
 639                     || act == LFUN_CHAR_FORWARD_SELECT
 640                     || act == LFUN_WORD_FORWARD
 641                     || act == LFUN_WORD_FORWARD_SELECT) {
 642                         forward = true;
 643                         finish_lfun = LFUN_FINISHED_FORWARD;
 644                 }
 645                 else if (act == LFUN_CHAR_BACKWARD
 646                          || act == LFUN_CHAR_BACKWARD_SELECT
 647                          || act == LFUN_WORD_BACKWARD
 648                          || act == LFUN_WORD_BACKWARD_SELECT) {
 649                         forward = false;
 650                         finish_lfun = LFUN_FINISHED_BACKWARD;
 651                 }
 652                 else {
 653                         bool right = (act == LFUN_CHAR_RIGHT_SELECT
 654                                                   || act == LFUN_CHAR_RIGHT
 655                                       || act == LFUN_WORD_RIGHT_SELECT
 656                                       || act == LFUN_WORD_RIGHT);
 657                         if (lyxrc.visual_cursor || !cur.reverseDirectionNeeded())
 658                                 forward = right;
 659                         else
 660                                 forward = !right;
 661
 662                         if (right)
 663                                 finish_lfun = LFUN_FINISHED_RIGHT;
 664                         else
 665                                 finish_lfun = LFUN_FINISHED_LEFT;
 666                 }
 667                 // Now that we know exactly what we want to do, let's do it!
 668                 cur.selHandle(select);
 669                 cur.clearTargetX();
 670                 cur.macroModeClose();
 671                 // try moving forward or backwards as necessary...
 672                 if (!(forward ? cur.mathForward(word) : cur.mathBackward(word))) {
 673                         // ... and if movement failed, then finish forward or backwards
 674                         // as necessary
 675                         cmd = FuncRequest(finish_lfun);
 676                         cur.undispatched();
 677                 }
 678                 break;
 679         }
 680
 681         case LFUN_DOWN:
 682         case LFUN_UP:
 683         case LFUN_PARAGRAPH_UP:
 684         case LFUN_PARAGRAPH_DOWN:
 685                 cur.screenUpdateFlags(Update::Decoration | Update::FitCursor);
 686                 // fall through
 687         case LFUN_DOWN_SELECT:
 688         case LFUN_UP_SELECT:
 689         case LFUN_PARAGRAPH_UP_SELECT:
 690         case LFUN_PARAGRAPH_DOWN_SELECT: {
 691                 // close active macro
 692                 if (cur.inMacroMode()) {
 693                         cur.macroModeClose();
 694                         break;
 695                 }
 696
 697                 // stop/start the selection
 698                 bool select = act == LFUN_DOWN_SELECT
 699                         || act == LFUN_UP_SELECT
 700                         || act == LFUN_PARAGRAPH_DOWN_SELECT
 701                         || act == LFUN_PARAGRAPH_UP_SELECT;
 702                 cur.selHandle(select);
 703
 704                 // go up/down
 705                 bool up = act == LFUN_UP || act == LFUN_UP_SELECT
 706                         || act == LFUN_PARAGRAPH_UP || act == LFUN_PARAGRAPH_UP_SELECT;
 707                 bool successful = cur.upDownInMath(up);
 708                 if (successful)
 709                         break;
 710
 711                 if (cur.fixIfBroken())
 712                         // FIXME: Something bad happened. We pass the corrected Cursor
 713                         // instead of letting things go worse.
 714                         break;
 715
 716                 // We did not manage to move the cursor.
 717                 cur.undispatched();
 718                 break;
 719         }
 720
 721         case LFUN_MOUSE_DOUBLE:
 722         case LFUN_WORD_SELECT:
 723                 cur.pos() = 0;
 724                 cur.bv().mouseSetCursor(cur);
 725                 cur.pos() = cur.lastpos();
 726                 cur.bv().mouseSetCursor(cur, true);
 727                 break;
 728
 729         case LFUN_MOUSE_TRIPLE:
 730                 cur.idx() = 0;
 731                 cur.pos() = 0;
 732                 cur.bv().mouseSetCursor(cur);
 733                 cur.idx() = cur.lastidx();
 734                 cur.pos() = cur.lastpos();
 735                 cur.bv().mouseSetCursor(cur, true);
 736                 break;
 737
 738         case LFUN_LINE_BEGIN:
 739                 cur.screenUpdateFlags(Update::Decoration | Update::FitCursor);
 740                 // fall through
 741         case LFUN_LINE_BEGIN_SELECT:
 742                 cur.selHandle(act == LFUN_WORD_BACKWARD_SELECT ||
 743                                 act == LFUN_WORD_LEFT_SELECT ||
 744                                 act == LFUN_LINE_BEGIN_SELECT);
 745                 cur.macroModeClose();
 746                 if (cur.pos() != 0) {
 747                         cur.pos() = 0;
 748                 } else if (cur.col() != 0) {
 749                         cur.idx() -= cur.col();
 750                         cur.pos() = 0;
 751                 } else if (cur.idx() != 0) {
 752                         cur.idx() = 0;
 753                         cur.pos() = 0;
 754                 } else {
 755                         cmd = FuncRequest(LFUN_FINISHED_BACKWARD);
 756                         cur.undispatched();
 757                 }
 758                 break;
 759
 760         case LFUN_LINE_END:
 761                 cur.screenUpdateFlags(Update::Decoration | Update::FitCursor);
 762                 // fall through
 763         case LFUN_LINE_END_SELECT:
 764                 cur.selHandle(act == LFUN_WORD_FORWARD_SELECT ||
 765                                 act == LFUN_WORD_RIGHT_SELECT ||
 766                                 act == LFUN_LINE_END_SELECT);
 767                 cur.macroModeClose();
 768                 cur.clearTargetX();
 769                 if (cur.pos() != cur.lastpos()) {
 770                         cur.pos() = cur.lastpos();
 771                 } else if (ncols() && (cur.col() != cur.lastcol())) {
 772                         cur.idx() = cur.idx() - cur.col() + cur.lastcol();
 773                         cur.pos() = cur.lastpos();
 774                 } else if (cur.idx() != cur.lastidx()) {
 775                         cur.idx() = cur.lastidx();
 776                         cur.pos() = cur.lastpos();
 777                 } else {
 778                         cmd = FuncRequest(LFUN_FINISHED_FORWARD);
 779                         cur.undispatched();
 780                 }
 781                 break;
 782
 783         case LFUN_CELL_FORWARD:
 784                 cur.screenUpdateFlags(Update::Decoration | Update::FitCursor);
 785                 cur.selHandle(false);
 786                 cur.clearTargetX();
 787                 cur.macroModeClose();
 788                 if (!cur.inset().idxNext(cur)) {
 789                         if (cur.lastidx() == 0)
 790                                 cur.popForward();
 791                         else {
 792                                 cur.idx() = firstIdx();
 793                                 cur.pos() = 0;
 794                         }
 795                 }
 796                 break;
 797
 798         case LFUN_CELL_BACKWARD:
 799                 cur.screenUpdateFlags(Update::Decoration | Update::FitCursor);
 800                 cur.selHandle(false);
 801                 cur.clearTargetX();
 802                 cur.macroModeClose();
 803                 if (!cur.inset().idxPrev(cur)) {
 804                         if (cur.lastidx() == 0)
 805                                 cur.popBackward();
 806                         else {
 807                                 cur.idx() = cur.lastidx();
 808                                 cur.pos() = lyxrc.mac_like_cursor_movement ? cur.lastpos() : 0;
 809                         }
 810                 }
 811                 break;
 812
 813         case LFUN_WORD_DELETE_BACKWARD:
 814         case LFUN_CHAR_DELETE_BACKWARD:
 815                 if (cur.pos() == 0)
 816                         // May affect external cell:
 817                         cur.recordUndoInset();
 818                 else if (!cur.inMacroMode())
 819                         cur.recordUndoSelection();
 820                 // if the inset can not be removed from within, delete it
 821                 if (!cur.backspace(cmd.getArg(0) == "force")) {
 822                         FuncRequest newcmd = FuncRequest(LFUN_CHAR_DELETE_FORWARD, "force");
 823                         cur.innerText()->dispatch(cur, newcmd);
 824                 }
 825                 break;
 826
 827         case LFUN_WORD_DELETE_FORWARD:
 828         case LFUN_CHAR_DELETE_FORWARD:
 829                 if (cur.pos() == cur.lastpos())
 830                         // May affect external cell:
 831                         cur.recordUndoInset();
 832                 else
 833                         cur.recordUndoSelection();
 834                 // if the inset can not be removed from within, delete it
 835                 if (!cur.erase(cmd.getArg(0) == "force")) {
 836                         FuncRequest newcmd = FuncRequest(LFUN_CHAR_DELETE_FORWARD, "force");
 837                         cur.innerText()->dispatch(cur, newcmd);
 838                 }
 839                 break;
 840
 841         case LFUN_ESCAPE:
 842                 if (cur.selection())
 843                         cur.clearSelection();
 844                 else  {
 845                         if (cur.inMacroMode())
 846                                 cur.macroModeClose(true);
 847                         else {
 848                                 cmd = FuncRequest(LFUN_FINISHED_FORWARD);
 849                                 cur.undispatched();
 850                         }
 851                 }
 852                 break;
 853
 854         // 'Locks' the math inset. A 'locked' math inset behaves as a unit
 855         // that is traversed by a single <CursorLeft>/<CursorRight>.
 856         case LFUN_INSET_TOGGLE:
 857                 cur.recordUndo();
 858                 lock(!lock());
 859                 cur.popForward();
 860                 break;
 861
 862         case LFUN_SELF_INSERT:
 863                 // special case first for big delimiters
 864                 if (cmd.argument().size() != 1 && interpretString(cur, cmd.argument()))
 865                         break;
 866
 867                 for (char_type c : cmd.argument()) {
 868                         // Don't record undo steps if we are in macro mode and thus
 869                         // cmd.argument is the next character of the macro name.
 870                         // Otherwise we'll get an invalid cursor if we undo after
 871                         // the macro was finished and the macro is a known command,
 872                         // e.g. sqrt. Cursor::macroModeClose replaces in this case
 873                         // the InsetMathUnknown with name "frac" by an empty
 874                         // InsetMathFrac -> a pos value > 0 is invalid.
 875                         // A side effect is that an undo before the macro is finished
 876                         // undoes the complete macro, not only the last character.
 877                         // At the time we hit '\' we are not in macro mode, still.
 878                         if (!cur.inMacroMode())
 879                                 cur.recordUndoSelection();
 880
 881                         // special handling of space. If we insert an inset
 882                         // via macro mode, we want to put the cursor inside it
 883                         // if relevant. Think typing "\frac<space>".
 884                         if (c == ' '
 885                             && cur.inMacroMode() && cur.macroName() != "\\"
 886                             && cur.macroModeClose() && cur.pos() > 0)
 887                                 cur.editInsertedInset();
 888                         else if (!interpretChar(cur, c)) {
 889                                 cmd = FuncRequest(LFUN_FINISHED_FORWARD);
 890                                 cur.undispatched();
 891                                 // FIXME: can we avoid skipping the end of the string?
 892                                 break;
 893                         }
 894                 }
 895                 break;
 896
 897         //case LFUN_SERVER_GET_XY:
 898         //      break;
 899
 900         case LFUN_SERVER_SET_XY: {
 901                 lyxerr << "LFUN_SERVER_SET_XY broken!" << endl;
 902                 int x = 0;
 903                 int y = 0;
 904                 istringstream is(to_utf8(cmd.argument()));
 905                 is >> x >> y;
 906                 cur.setTargetX(x);
 907                 break;
 908         }
 909
 910         // Special casing for superscript in case of LyX handling
 911         // dead-keys:
 912         case LFUN_ACCENT_CIRCUMFLEX:
 913                 if (cmd.argument().empty()) {
 914                         // do superscript if LyX handles
 915                         // deadkeys
 916                         cur.recordUndoInset();
 917                         script(cur, true, grabAndEraseSelection(cur));
 918                 }
 919                 break;
 920
 921         case LFUN_ACCENT_UMLAUT:
 922         case LFUN_ACCENT_ACUTE:
 923         case LFUN_ACCENT_GRAVE:
 924         case LFUN_ACCENT_BREVE:
 925         case LFUN_ACCENT_DOT:
 926         case LFUN_ACCENT_MACRON:
 927         case LFUN_ACCENT_CARON:
 928         case LFUN_ACCENT_TILDE:
 929         case LFUN_ACCENT_CEDILLA:
 930         case LFUN_ACCENT_CIRCLE:
 931         case LFUN_ACCENT_UNDERDOT:
 932         case LFUN_ACCENT_TIE:
 933         case LFUN_ACCENT_OGONEK:
 934         case LFUN_ACCENT_HUNGARIAN_UMLAUT:
 935                 break;
 936
 937         //  Math fonts
 938         case LFUN_TEXTSTYLE_APPLY:
 939         case LFUN_TEXTSTYLE_UPDATE:
 940                 handleFont2(cur, cmd.argument());
 941                 break;
 942
 943         case LFUN_FONT_BOLD:
 944                 if (currentMode() != MATH_MODE)
 945                         handleFont(cur, cmd.argument(), "textbf");
 946                 else
 947                         handleFont(cur, cmd.argument(), "mathbf");
 948                 break;
 949         case LFUN_FONT_BOLDSYMBOL:
 950                 if (currentMode() != MATH_MODE)
 951                         handleFont(cur, cmd.argument(), "textbf");
 952                 else
 953                         handleFont(cur, cmd.argument(), "boldsymbol");
 954                 break;
 955         case LFUN_FONT_SANS:
 956                 if (currentMode() != MATH_MODE)
 957                         handleFont(cur, cmd.argument(), "textsf");
 958                 else
 959                         handleFont(cur, cmd.argument(), "mathsf");
 960                 break;
 961         case LFUN_FONT_EMPH:
 962                 if (currentMode() != MATH_MODE)
 963                         handleFont(cur, cmd.argument(), "emph");
 964                 else
 965                         handleFont(cur, cmd.argument(), "mathcal");
 966                 break;
 967         case LFUN_FONT_ROMAN:
 968                 if (currentMode() != MATH_MODE)
 969                         handleFont(cur, cmd.argument(), "textrm");
 970                 else
 971                         handleFont(cur, cmd.argument(), "mathrm");
 972                 break;
 973         case LFUN_FONT_TYPEWRITER:
 974                 if (currentMode() != MATH_MODE)
 975                         handleFont(cur, cmd.argument(), "texttt");
 976                 else
 977                         handleFont(cur, cmd.argument(), "mathtt");
 978                 break;
 979         case LFUN_FONT_FRAK:
 980                 handleFont(cur, cmd.argument(), "mathfrak");
 981                 break;
 982         case LFUN_FONT_ITAL:
 983                 if (currentMode() != MATH_MODE)
 984                         handleFont(cur, cmd.argument(), "textit");
 985                 else
 986                         handleFont(cur, cmd.argument(), "mathit");
 987                 break;
 988         case LFUN_FONT_NOUN:
 989                 if (currentMode() != MATH_MODE)
 990                         // FIXME: should be "noun"
 991                         handleFont(cur, cmd.argument(), "textsc");
 992                 else
 993                         handleFont(cur, cmd.argument(), "mathbb");
 994                 break;
 995         case LFUN_FONT_DEFAULT:
 996                 handleFont(cur, cmd.argument(), "textnormal");
 997                 break;
 998         case LFUN_FONT_UNDERLINE:
 999                 cur.recordUndo();
1000                 cur.handleNest(createInsetMath("underline", cur.buffer()));
1001                 break;
1002
1003         case LFUN_MATH_MODE: {
1004 #if 1
1005                 // ignore math-mode on when already in math mode
1006                 if (currentMode() == Inset::MATH_MODE && cmd.argument() == "on")
1007                         break;
1008                 cur.recordUndoSelection();
1009                 cur.macroModeClose();
1010                 docstring const save_selection = grabAndEraseSelection(cur);
1011                 selClearOrDel(cur);
1012                 if (currentMode() != Inset::MATH_MODE)
1013                         cur.plainInsert(MathAtom(new InsetMathEnsureMath(buffer_)));
1014                 else
1015                         cur.plainInsert(createInsetMath("text", buffer_));
1016                 cur.posBackward();
1017                 cur.pushBackward(*cur.nextInset());
1018                 cur.niceInsert(save_selection);
1019                 cur.forceBufferUpdate();
1020 #else
1021                 if (currentMode() == Inset::TEXT_MODE) {
1022                         cur.recordUndoSelection();
1023                         cur.niceInsert(MathAtom(new InsetMathHull("simple", cur.buffer())));
1024                         cur.message(_("create new math text environment ($...$)"));
1025                 } else {
1026                         handleFont(cur, cmd.argument(), "textrm");
1027                         cur.message(_("entered math text mode (textrm)"));
1028                 }
1029 #endif
1030                 break;
1031         }
1032
1033         case LFUN_REGEXP_MODE: {
1034                 InsetMath * im = cur.inset().asInsetMath();
1035                 if (im) {
1036                         InsetMathHull * i = im->asHullInset();
1037                         if (i && i->getType() == hullRegexp) {
1038                                 cur.message(_("Already in regular expression mode"));
1039                                 break;
1040                         }
1041                 }
1042                 cur.macroModeClose();
1043                 docstring const save_selection = grabAndEraseSelection(cur);
1044                 selClearOrDel(cur);
1045                 cur.plainInsert(MathAtom(new InsetMathHull(buffer_, hullRegexp)));
1046                 cur.posBackward();
1047                 cur.pushBackward(*cur.nextInset());
1048                 cur.niceInsert(save_selection);
1049                 cur.message(_("Regular expression editor mode"));
1050                 break;
1051         }
1052
1053         case LFUN_MATH_FONT_STYLE: {
1054                 FuncRequest fr = FuncRequest(LFUN_MATH_INSERT, '\\' + cmd.argument());
1055                 doDispatch(cur, fr);
1056                 break;
1057         }
1058
1059         case LFUN_MATH_SIZE: {
1060                 FuncRequest fr = FuncRequest(LFUN_MATH_INSERT, cmd.argument());
1061                 doDispatch(cur, fr);
1062                 break;
1063         }
1064
1065         case LFUN_MATH_MATRIX: {
1066                 cur.recordUndo();
1067                 unsigned int m = 1;
1068                 unsigned int n = 1;
1069                 docstring v_align;
1070                 docstring h_align;
1071                 idocstringstream is(cmd.argument());
1072                 is >> m >> n >> v_align >> h_align;
1073                 if (m < 1)
1074                         m = 1;
1075                 if (n < 1)
1076                         n = 1;
1077                 v_align += 'c';
1078                 cur.niceInsert(MathAtom(new InsetMathArray(buffer_,
1079                         from_ascii("array"), m, n, (char)v_align[0], h_align)));
1080                 break;
1081         }
1082
1083         case LFUN_MATH_AMS_MATRIX: {
1084                 cur.recordUndo();
1085                 unsigned int m = 1;
1086                 unsigned int n = 1;
1087                 docstring name = from_ascii("matrix");
1088                 idocstringstream is(cmd.argument());
1089                 is >> m >> n >> name;
1090                 if (m < 1)
1091                         m = 1;
1092                 if (n < 1)
1093                         n = 1;
1094                 // check if we have a valid decoration
1095                 if (name != "pmatrix" && name != "bmatrix"
1096                         && name != "Bmatrix" && name != "vmatrix"
1097                         && name != "Vmatrix" && name != "matrix"
1098                         && name != "smallmatrix")
1099                         name = from_ascii("matrix");
1100
1101                 cur.niceInsert(
1102                         MathAtom(new InsetMathAMSArray(buffer_, name, m, n)));
1103                 break;
1104         }
1105
1106         case LFUN_MATH_DELIM: {
1107                 docstring ls;
1108                 docstring rs = split(cmd.argument(), ls, ' ');
1109                 // Reasonable default values
1110                 if (ls.empty())
1111                         ls = '(';
1112                 if (rs.empty())
1113                         rs = ')';
1114                 cur.recordUndo();
1115                 cur.handleNest(MathAtom(new InsetMathDelim(buffer_, ls, rs)));
1116                 break;
1117         }
1118
1119         case LFUN_MATH_BIGDELIM: {
1120                 docstring const lname  = from_utf8(cmd.getArg(0));
1121                 docstring const ldelim = from_utf8(cmd.getArg(1));
1122                 docstring const rname  = from_utf8(cmd.getArg(2));
1123                 docstring const rdelim = from_utf8(cmd.getArg(3));
1124                 latexkeys const * l = in_word_set(lname);
1125                 bool const have_l = l && l->inset == "big" &&
1126                                     InsetMathBig::isBigInsetDelim(ldelim);
1127                 l = in_word_set(rname);
1128                 bool const have_r = l && l->inset == "big" &&
1129                                     InsetMathBig::isBigInsetDelim(rdelim);
1130                 // We mimic LFUN_MATH_DELIM in case we have an empty left
1131                 // or right delimiter.
1132                 if (have_l || have_r) {
1133                         cur.recordUndo();
1134                         docstring const selection = grabAndEraseSelection(cur);
1135                         selClearOrDel(cur);
1136                         if (have_l)
1137                                 cur.insert(MathAtom(new InsetMathBig(lname,
1138                                                                 ldelim)));
1139                         // first insert the right delimiter and then go back
1140                         // and re-insert the selection (bug 7088)
1141                         if (have_r) {
1142                                 cur.insert(MathAtom(new InsetMathBig(rname,
1143                                                                 rdelim)));
1144                                 cur.posBackward();
1145                         }
1146                         cur.niceInsert(selection);
1147                 }
1148                 // Don't call cur.undispatched() if we did nothing, this would
1149                 // lead to infinite recursion via Text::dispatch().
1150                 break;
1151         }
1152
1153         case LFUN_SPACE_INSERT: {
1154                 cur.recordUndoSelection();
1155                 string const name = cmd.getArg(0);
1156                 if (name == "normal")
1157                         cur.insert(MathAtom(new InsetMathSpace(" ", "")));
1158                 else if (name == "protected")
1159                         cur.insert(MathAtom(new InsetMathSpace("~", "")));
1160                 else if (name == "thin" || name == "med" || name == "thick")
1161                         cur.insert(MathAtom(new InsetMathSpace(name + "space", "")));
1162                 else if (name == "hfill*")
1163                         cur.insert(MathAtom(new InsetMathSpace("hspace*{\\fill}", "")));
1164                 else if (name == "quad" || name == "qquad" ||
1165                          name == "enspace" || name == "enskip" ||
1166                          name == "negthinspace" || name == "negmedspace" ||
1167                          name == "negthickspace" || name == "hfill")
1168                         cur.insert(MathAtom(new InsetMathSpace(name, "")));
1169                 else if (name == "hspace" || name == "hspace*") {
1170                         string const len = cmd.getArg(1);
1171                         if (len.empty() || !isValidLength(len)) {
1172                                 lyxerr << "LyX function 'space-insert " << name << "' "
1173                                           "needs a valid length argument." << endl;
1174                                 break;
1175                         }
1176                         cur.insert(MathAtom(new InsetMathSpace(name, len)));
1177                 } else
1178                         cur.insert(MathAtom(new InsetMathSpace));
1179                 break;
1180         }
1181
1182         case LFUN_MATH_SPACE:
1183                 cur.recordUndoSelection();
1184                 if (cmd.argument().empty())
1185                         cur.insert(MathAtom(new InsetMathSpace));
1186                 else {
1187                         string const name = cmd.getArg(0);
1188                         string const len = cmd.getArg(1);
1189                         cur.insert(MathAtom(new InsetMathSpace(name, len)));
1190                 }
1191                 break;
1192
1193         case LFUN_ERT_INSERT:
1194                 // interpret this as if a backslash was typed
1195                 cur.recordUndo();
1196                 interpretChar(cur, '\\');
1197                 break;
1198
1199         case LFUN_MATH_SUBSCRIPT:
1200                 // interpret this as if a _ was typed
1201                 cur.recordUndoSelection();
1202                 interpretChar(cur, '_');
1203                 break;
1204
1205         case LFUN_MATH_SUPERSCRIPT:
1206                 // interpret this as if a ^ was typed
1207                 cur.recordUndoSelection();
1208                 interpretChar(cur, '^');
1209                 break;
1210
1211         case LFUN_MATH_MACRO_FOLD:
1212         case LFUN_MATH_MACRO_UNFOLD: {
1213                 Cursor it = cur;
1214                 bool fold = act == LFUN_MATH_MACRO_FOLD;
1215                 bool found = findMacroToFoldUnfold(it, fold);
1216                 if (found) {
1217                         InsetMathMacro * macro = it.nextInset()->asInsetMath()->asMacro();
1218                         cur.recordUndoInset();
1219                         if (fold)
1220                                 macro->fold(cur);
1221                         else
1222                                 macro->unfold(cur);
1223                 }
1224                 break;
1225         }
1226
1227         case LFUN_QUOTE_INSERT:
1228                 // interpret this as if a straight " was typed
1229                 cur.recordUndoSelection();
1230                 interpretChar(cur, '\"');
1231                 break;
1232
1233 // FIXME: We probably should swap parts of "math-insert" and "self-insert"
1234 // handling such that "self-insert" works on "arbitrary stuff" too, and
1235 // math-insert only handles special math things like "matrix".
1236         case LFUN_MATH_INSERT: {
1237                 cur.recordUndoSelection();
1238                 if (cmd.argument() == "^" || cmd.argument() == "_")
1239                         interpretChar(cur, cmd.argument()[0]);
1240                 else if (!cur.selection())
1241                         cur.niceInsert(cmd.argument());
1242                 else {
1243                         MathData ar(cur.buffer());
1244                         asArray(cmd.argument(), ar);
1245                         if (ar.size() == 1
1246                             && ar[0]->asNestInset()
1247                             && ar[0]->asNestInset()->nargs() > 1)
1248                                 handleNest(cur, ar[0]);
1249                         else
1250                                 cur.niceInsert(cmd.argument());
1251                 }
1252                 break;
1253         }
1254
1255         case LFUN_DIALOG_SHOW_NEW_INSET: {
1256                 docstring const & name = cmd.argument();
1257                 string data;
1258                 if (name == "ref") {
1259                         InsetMathRef tmp(buffer_, name);
1260                         data = tmp.createDialogStr();
1261                         cur.bv().showDialog(to_utf8(name), data);
1262                 } else if (name == "mathspace") {
1263                         cur.bv().showDialog(to_utf8(name));
1264                 }
1265                 break;
1266         }
1267
1268         case LFUN_INSET_INSERT: {
1269                 MathData ar;
1270                 if (createInsetMath_fromDialogStr(cmd.argument(), ar)) {
1271                         cur.recordUndoSelection();
1272                         cur.insert(ar);
1273                         cur.forceBufferUpdate();
1274                 } else
1275                         cur.undispatched();
1276                 break;
1277         }
1278         case LFUN_INSET_DISSOLVE:
1279                 if (!asHullInset()) {
1280                         cur.recordUndoInset();
1281                         cur.pullArg();
1282                 }
1283                 break;
1284
1285         case LFUN_MATH_LIMITS: {
1286                 InsetMath * in = 0;
1287                 if (cur.pos() < cur.lastpos() && cur.nextMath().allowsLimitsChange())
1288                         in = &cur.nextMath();
1289                 else if (cur.pos() > 0 && cur.prevMath().allowsLimitsChange())
1290                         in = &cur.prevMath();
1291                 else if (cur.lastpos() > 0 && cur.cell().back()->allowsLimitsChange())
1292                         in = cur.cell().back().nucleus();
1293                 // only when nucleus allows this
1294                 if (!in)
1295                         return;
1296                 cur.recordUndoInset();
1297                 if (!cmd.argument().empty()) {
1298                         if (cmd.argument() == "limits")
1299                                 in->limits(LIMITS);
1300                         else if (cmd.argument() == "nolimits")
1301                                 in->limits(NO_LIMITS);
1302                         else
1303                                 in->limits(AUTO_LIMITS);
1304                 } else if (in->limits() != AUTO_LIMITS)
1305                         in->limits(AUTO_LIMITS);
1306                 else if (in->defaultLimits(cur.cell().displayStyle()) == LIMITS)
1307                         in->limits(NO_LIMITS);
1308                 else
1309                         in->limits(LIMITS);
1310                 return;
1311         }
1312
1313         case LFUN_PHANTOM_INSERT: {
1314                 docstring const & arg = cmd.argument();
1315                 docstring newarg;
1316                 if (arg == "Phantom")
1317                         newarg = from_ascii("\\phantom");
1318                 else if (arg == "HPhantom")
1319                         newarg = from_ascii("\\hphantom");
1320                 else if (arg == "VPhantom")
1321                         newarg = from_ascii("\\vphantom");
1322                 if (newarg.empty())
1323                         LYXERR0("Unknown phantom type " + newarg);
1324                 else {
1325                         FuncRequest const newfunc(LFUN_MATH_INSERT, newarg);
1326                         lyx::dispatch(newfunc);
1327                 }
1328                 break;
1329         }
1330
1331         default:
1332                 InsetMath::doDispatch(cur, cmd);
1333                 break;
1334         }
1335 }
1336
1337
1338 bool InsetMathNest::findMacroToFoldUnfold(Cursor & it, bool fold) const {
1339         // look for macro to open/close, but stay in mathed
1340         for (; !it.empty(); it.pop_back()) {
1341
1342                 // go backward through the current cell
1343                 Inset * inset = it.nextInset();
1344                 while (inset && inset->asInsetMath()) {
1345                         InsetMathMacro * macro = inset->asInsetMath()->asMacro();
1346                         if (macro) {
1347                                 // found the an macro to open/close?
1348                                 if (macro->folded() != fold)
1349                                         return true;
1350
1351                                 // Wrong folding state.
1352                                 // If this was the first we see in this slice, look further left,
1353                                 // otherwise go up.
1354                                 if (inset != it.nextInset())
1355                                         break;
1356                         }
1357
1358                         // go up if this was the left most position
1359                         if (it.pos() == 0)
1360                                 break;
1361
1362                         // go left
1363                         it.pos()--;
1364                         inset = it.nextInset();
1365                 }
1366         }
1367
1368         return false;
1369 }
1370
1371
1372 bool InsetMathNest::getStatus(Cursor & cur, FuncRequest const & cmd,
1373                 FuncStatus & flag) const
1374 {
1375         // the font related toggles
1376         //string tc = "mathnormal";
1377         bool ret = true;
1378         string const arg = to_utf8(cmd.argument());
1379         switch (cmd.action()) {
1380 #if 0
1381         case LFUN_INSET_MODIFY:
1382                 // FIXME: check temporarily disabled
1383                 // valign code
1384                 char align = mathcursor::valign();
1385                 if (align == '\0') {
1386                         enable = false;
1387                         break;
1388                 }
1389                 if (cmd.argument().empty()) {
1390                         flag.clear();
1391                         break;
1392                 }
1393                 if (!contains("tcb", cmd.argument()[0])) {
1394                         enable = false;
1395                         break;
1396                 }
1397                 flag.setOnOff(cmd.argument()[0] == align);
1398                 break;
1399 #endif
1400         /// We have to handle them since 1.4 blocks all unhandled actions
1401         case LFUN_FONT_ITAL:
1402         case LFUN_FONT_BOLD:
1403         case LFUN_FONT_BOLDSYMBOL:
1404         case LFUN_FONT_SANS:
1405         case LFUN_FONT_EMPH:
1406         case LFUN_FONT_TYPEWRITER:
1407         case LFUN_FONT_NOUN:
1408         case LFUN_FONT_ROMAN:
1409         case LFUN_FONT_DEFAULT:
1410                 flag.setEnabled(true);
1411                 break;
1412
1413         // we just need to be in math mode to enable that
1414         case LFUN_MATH_SIZE:
1415         case LFUN_MATH_SPACE:
1416         case LFUN_MATH_EXTERN:
1417                 flag.setEnabled(true);
1418                 break;
1419
1420         case LFUN_FONT_UNDERLINE:
1421         case LFUN_FONT_FRAK:
1422                 flag.setEnabled(currentMode() != TEXT_MODE);
1423                 break;
1424
1425         case LFUN_MATH_FONT_STYLE: {
1426                 bool const textarg =
1427                         arg == "textbf"   || arg == "textsf" ||
1428                         arg == "textrm"   || arg == "textmd" ||
1429                         arg == "textit"   || arg == "textsc" ||
1430                         arg == "textsl"   || arg == "textup" ||
1431                         arg == "texttt"   || arg == "textbb" ||
1432                         arg == "textnormal";
1433                 flag.setEnabled(currentMode() != TEXT_MODE || textarg);
1434                 break;
1435         }
1436
1437         case LFUN_MATH_MODE:
1438                 // forbid "math-mode on" in math mode to prevent irritating
1439                 // behaviour of menu entries (bug 6709)
1440                 flag.setEnabled(currentMode() == TEXT_MODE || arg != "on");
1441                 break;
1442
1443         case LFUN_MATH_INSERT:
1444                 flag.setEnabled(currentMode() != TEXT_MODE);
1445                 break;
1446
1447         case LFUN_MATH_AMS_MATRIX:
1448         case LFUN_MATH_MATRIX:
1449                 flag.setEnabled(currentMode() == MATH_MODE);
1450                 break;
1451
1452         case LFUN_INSET_INSERT: {
1453                 // Don't test createMathInset_fromDialogStr(), since
1454                 // getStatus is not called with a valid reference and the
1455                 // dialog would not be applicable.
1456                 string const name = cmd.getArg(0);
1457                 flag.setEnabled(name == "ref" || name == "mathspace");
1458                 break;
1459         }
1460
1461         case LFUN_DIALOG_SHOW_NEW_INSET: {
1462                 docstring const & name = cmd.argument();
1463                 if (name == "space")
1464                         flag.setEnabled(false);
1465                 break;
1466         }
1467
1468
1469         case LFUN_MATH_DELIM:
1470         case LFUN_MATH_BIGDELIM:
1471                 // Don't do this with multi-cell selections
1472                 flag.setEnabled(cur.selBegin().idx() == cur.selEnd().idx());
1473                 break;
1474
1475         case LFUN_MATH_MACRO_FOLD:
1476         case LFUN_MATH_MACRO_UNFOLD: {
1477                 Cursor it = cur;
1478                 bool found = findMacroToFoldUnfold(it, cmd.action() == LFUN_MATH_MACRO_FOLD);
1479                 flag.setEnabled(found);
1480                 break;
1481         }
1482
1483         case LFUN_SPECIALCHAR_INSERT:
1484         case LFUN_SCRIPT_INSERT:
1485                 // FIXME: These would probably make sense in math-text mode
1486                 flag.setEnabled(false);
1487                 break;
1488
1489         case LFUN_CAPTION_INSERT:
1490                 flag.setEnabled(false);
1491                 break;
1492
1493         case LFUN_SPACE_INSERT: {
1494                 docstring const & name = cmd.argument();
1495                 if (name == "visible")
1496                         flag.setEnabled(false);
1497                 break;
1498         }
1499
1500         case LFUN_INSET_DISSOLVE:
1501                 flag.setEnabled(!asHullInset());
1502                 break;
1503
1504         case LFUN_PASTE: {
1505                 docstring const & name = cmd.argument();
1506                 if (name == "html" || name == "latex")
1507                         flag.setEnabled(false);
1508                 break;
1509         }
1510
1511         case LFUN_MATH_LIMITS: {
1512                 InsetMath * in = 0;
1513                 if (cur.pos() < cur.lastpos() && cur.nextMath().allowsLimitsChange())
1514                         in = &cur.nextMath();
1515                 else if (cur.pos() > 0 && cur.prevMath().allowsLimitsChange())
1516                         in = &cur.prevMath();
1517                 else if (cur.lastpos() > 0 && cur.cell().back()->allowsLimitsChange())
1518                         in = cur.cell().back().nucleus();
1519                 if (in) {
1520                         if (!cmd.argument().empty()) {
1521                                 if (cmd.argument() == "limits")
1522                                         flag.setOnOff(in->limits() == LIMITS);
1523                                 else if (cmd.argument() == "nolimits")
1524                                         flag.setOnOff(in->limits() == NO_LIMITS);
1525                                 else
1526                                         flag.setOnOff(in->limits() == AUTO_LIMITS);
1527                         }
1528                         flag.setEnabled(true);
1529                 } else
1530                         flag.setEnabled(false);
1531                 return true;
1532         }
1533
1534         default:
1535                 ret = false;
1536                 break;
1537         }
1538         return ret;
1539 }
1540
1541
1542 void InsetMathNest::edit(Cursor & cur, bool front, EntryDirection entry_from)
1543 {
1544         cur.push(*this);
1545         bool enter_front = (entry_from == Inset::ENTRY_DIRECTION_LEFT ||
1546                 (entry_from == Inset::ENTRY_DIRECTION_IGNORE && front));
1547         enter_front ? idxFirst(cur) : idxLast(cur);
1548         cur.resetAnchor();
1549         //lyxerr << "InsetMathNest::edit, cur:\n" << cur << endl;
1550 }
1551
1552
1553 Inset * InsetMathNest::editXY(Cursor & cur, int x, int y)
1554 {
1555         int idx_min = -1;
1556         int dist_min = 1000000;
1557         for (idx_type i = 0, n = nargs(); i != n; ++i) {
1558                 int const d = cell(i).dist(cur.bv(), x, y);
1559                 if (d < dist_min) {
1560                         dist_min = d;
1561                         idx_min = i;
1562                 }
1563         }
1564         if (idx_min == -1)
1565                 return this;
1566
1567         MathData & ar = cell(idx_min);
1568         cur.push(*this);
1569         cur.idx() = idx_min;
1570         cur.pos() = ar.x2pos(&cur.bv(), x - ar.xo(cur.bv()));
1571
1572         //lyxerr << "found cell : " << idx_min << " pos: " << cur.pos() << endl;
1573         if (dist_min == 0) {
1574                 // hit inside cell
1575                 for (pos_type i = 0, n = ar.size(); i < n; ++i)
1576                         if (ar[i]->covers(cur.bv(), x, y))
1577                                 return ar[i].nucleus()->editXY(cur, x, y);
1578         }
1579         return this;
1580 }
1581
1582
1583 void InsetMathNest::lfunMousePress(Cursor & cur, FuncRequest & cmd)
1584 {
1585         //lyxerr << "## lfunMousePress: buttons: " << cmd.button() << endl;
1586         BufferView & bv = cur.bv();
1587         if (cmd.button() == mouse_button::button3) {
1588                 // Don't do anything if we right-click a
1589                 // selection, a context menu will popup.
1590                 if (bv.cursor().selection() && cur >= bv.cursor().selectionBegin()
1591                       && cur < bv.cursor().selectionEnd()) {
1592                         cur.noScreenUpdate();
1593                         return;
1594                 }
1595         }
1596
1597         // set cursor after the inset if x is nearer to that position (bug 9748)
1598         cur.moveToClosestEdge(cmd.x(), true);
1599
1600         bool do_selection = cmd.button() == mouse_button::button1
1601                 && cmd.modifier() == ShiftModifier;
1602         bv.mouseSetCursor(cur, do_selection);
1603         if (cmd.button() == mouse_button::button1) {
1604                 //lyxerr << "## lfunMousePress: setting cursor to: " << cur << endl;
1605                 // Update the cursor update flags as needed:
1606                 //
1607                 // Update::Decoration: tells to update the decoration
1608                 //                     (visual box corners that define
1609                 //                     the inset)/
1610                 // Update::FitCursor: adjust the screen to the cursor
1611                 //                    position if needed
1612                 // cur.result().update(): don't overwrite previously set flags.
1613                 cur.screenUpdateFlags(Update::Decoration | Update::FitCursor
1614                                 | cur.result().screenUpdate());
1615         } else if (cmd.button() == mouse_button::button2 && lyxrc.mouse_middlebutton_paste) {
1616                 if (cap::selection()) {
1617                         // See comment in Text::dispatch why we do this
1618                         cap::copySelectionToStack();
1619                         cmd = FuncRequest(LFUN_PASTE, "0");
1620                         doDispatch(bv.cursor(), cmd);
1621                 } else {
1622                         MathData ar;
1623                         asArray(theSelection().get(), ar);
1624                         bv.cursor().insert(ar);
1625                 }
1626         }
1627 }
1628
1629
1630 void InsetMathNest::lfunMouseMotion(Cursor & cur, FuncRequest & cmd)
1631 {
1632         // only select with button 1
1633         if (cmd.button() != mouse_button::button1)
1634                 return;
1635
1636         Cursor & bvcur = cur.bv().cursor();
1637
1638         // ignore motions deeper nested than the real anchor
1639         if (!bvcur.realAnchor().hasPart(cur)) {
1640                 cur.undispatched();
1641                 return;
1642         }
1643
1644         // set cursor after the inset if x is nearer to that position (bug 9748)
1645         cur.moveToClosestEdge(cmd.x());
1646
1647         CursorSlice old = bvcur.top();
1648
1649         // We continue with our existing selection or start a new one, so don't
1650         // reset the anchor.
1651         bvcur.setCursor(cur);
1652         // Did we actually move?
1653         if (cur.top() == old)
1654                 // We didn't move one iota, so no need to change selection status
1655                 // or update the screen.
1656                 cur.screenUpdateFlags(Update::SinglePar | Update::FitCursor);
1657         else
1658                 bvcur.setSelection();
1659 }
1660
1661
1662 void InsetMathNest::lfunMouseRelease(Cursor & cur, FuncRequest & cmd)
1663 {
1664         //lyxerr << "## lfunMouseRelease: buttons: " << cmd.button() << endl;
1665
1666         if (cmd.button() == mouse_button::button1) {
1667                 if (!cur.selection())
1668                         cur.noScreenUpdate();
1669                 else {
1670                         Cursor & bvcur = cur.bv().cursor();
1671                         bvcur.selection(true);
1672                 }
1673                 return;
1674         }
1675
1676         cur.undispatched();
1677 }
1678
1679
1680 bool InsetMathNest::interpretChar(Cursor & cur, char_type const c)
1681 {
1682         // try auto-correction
1683         if (lyxrc.autocorrection_math && cur.pos() != 0 && !cur.selection()
1684              && math_autocorrect(cur, c))
1685                 return true;
1686
1687         //lyxerr << "interpret 2: '" << c << "'" << endl;
1688         docstring save_selection;
1689         if (c == '^' || c == '_')
1690                 save_selection = grabAndEraseSelection(cur);
1691
1692         cur.clearTargetX();
1693         Buffer * buf = cur.buffer();
1694
1695         // handle macroMode
1696         if (cur.inMacroMode()) {
1697                 docstring name = cur.macroName();
1698
1699                 /// are we currently typing '#1' or '#2' or...?
1700                 if (name == "\\#") {
1701                         cur.backspace();
1702                         int n = c - '0';
1703                         if (n >= 1 && n <= 9)
1704                                 cur.insert(new InsetMathMacroArgument(n));
1705                         return true;
1706                 }
1707
1708                 // do not finish macro for known * commands
1709                 bool star_macro = c == '*'
1710                         && (in_word_set(name.substr(1) + '*')
1711                             || cur.buffer()->getMacro(name.substr(1) + "*", cur, true));
1712                 if (isAlphaASCII(c) || star_macro) {
1713                         cur.activeMacro()->setName(name + docstring(1, c));
1714                         return true;
1715                 }
1716
1717                 // handle 'special char' macros
1718                 if (name == "\\") {
1719                         // remove the '\\'
1720                         if (c == '\\') {
1721                                 cur.backspace();
1722                                 if (currentMode() != InsetMath::MATH_MODE)
1723                                         cur.niceInsert(createInsetMath("textbackslash", buf));
1724                                 else
1725                                         cur.niceInsert(createInsetMath("backslash", buf));
1726                         } else if (c == '^' && currentMode() == InsetMath::MATH_MODE) {
1727                                 cur.backspace();
1728                                 cur.niceInsert(createInsetMath("mathcircumflex", buf));
1729                         } else if (c == '{' || c == '%') {
1730                                 //using the saved selection as argument
1731                                 InsetMathUnknown * p = cur.activeMacro();
1732                                 p->finalize();
1733                                 MathData sel(cur.buffer());
1734                                 asArray(p->selection(), sel);
1735                                 cur.backspace();
1736                                 if (c == '{')
1737                                         cur.niceInsert(MathAtom(new InsetMathBrace(sel)));
1738                                 else
1739                                         cur.niceInsert(MathAtom(new InsetMathComment(sel)));
1740                         } else if (c == '#') {
1741                                 LASSERT(cur.activeMacro(), return false);
1742                                 cur.activeMacro()->setName(name + docstring(1, c));
1743                         } else {
1744                                 cur.backspace();
1745                                 cur.niceInsert(createInsetMath(docstring(1, c), buf));
1746                         }
1747                         return true;
1748                 }
1749
1750                 // One character big delimiters. The others are handled in
1751                 // interpretString().
1752                 latexkeys const * l = in_word_set(name.substr(1));
1753                 if (name[0] == '\\' && l && l->inset == "big") {
1754                         docstring delim;
1755                         switch (c) {
1756                         case '{':
1757                                 delim = from_ascii("\\{");
1758                                 break;
1759                         case '}':
1760                                 delim = from_ascii("\\}");
1761                                 break;
1762                         default:
1763                                 delim = docstring(1, c);
1764                                 break;
1765                         }
1766                         if (InsetMathBig::isBigInsetDelim(delim)) {
1767                                 // name + delim ared a valid InsetMathBig.
1768                                 // We can't use cur.macroModeClose() because
1769                                 // it does not handle delim.
1770                                 InsetMathUnknown * p = cur.activeMacro();
1771                                 p->finalize();
1772                                 --cur.pos();
1773                                 cur.cell().erase(cur.pos());
1774                                 cur.plainInsert(MathAtom(
1775                                         new InsetMathBig(name.substr(1), delim)));
1776                                 return true;
1777                         }
1778                 } else if (name == "\\smash" && c == '[') {
1779                         // We can't use cur.macroModeClose() because
1780                         // it would create an InsetMathPhantom
1781                         InsetMathUnknown * p = cur.activeMacro();
1782                         p->finalize();
1783                         interpretChar(cur, c);
1784                         return true;
1785                 }
1786
1787                 // leave macro mode and try again if necessary
1788                 if (cur.macroModeClose()) {
1789                         MathAtom const atom = cur.prevAtom();
1790                         if (atom->asNestInset() && atom->isActive()) {
1791                                 cur.posBackward();
1792                                 cur.nextInset()->edit(cur, true);
1793                         }
1794                 }
1795                 if (c == '{')
1796                         cur.niceInsert(MathAtom(new InsetMathBrace(buf)));
1797                 else if (c != ' ')
1798                         interpretChar(cur, c);
1799                 return true;
1800         }
1801
1802
1803         // just clear selection on pressing the space bar
1804         if (cur.selection() && c == ' ') {
1805                 cur.selection(false);
1806                 return true;
1807         }
1808
1809         if (c == '\\') {
1810                 //lyxerr << "starting with macro" << endl;
1811                 bool reduced = cap::reduceSelectionToOneCell(cur);
1812                 if (reduced || !cur.selection()) {
1813                         cur.recordUndoInset();
1814                         docstring const safe = cap::grabAndEraseSelection(cur);
1815                         if (!cur.inRegexped())
1816                                 cur.insert(MathAtom(new InsetMathUnknown(from_ascii("\\"), safe, false)));
1817                         else
1818                                 cur.niceInsert(createInsetMath("backslash", buf));
1819                 }
1820                 return true;
1821         }
1822
1823         selClearOrDel(cur);
1824
1825         if (c == '\n') {
1826                 if (currentMode() != InsetMath::MATH_MODE)
1827                         cur.insert(c);
1828                 return true;
1829         }
1830
1831         if (c == ' ') {
1832                 if (currentMode() != InsetMath::MATH_MODE) {
1833                         // insert spaces in text or undecided mode,
1834                         // but suppress direct insertion of two spaces in a row
1835                         // the still allows typing  '<space>a<space>' and deleting the 'a', but
1836                         // it is better than nothing...
1837                         pos_type const pos = cur.pos();
1838                         pos_type const lastpos = cur.lastpos();
1839                         if ((pos == 0 && lastpos == 0)
1840                             || (pos == 0 && cur.nextAtom()->getChar() != ' ')
1841                             || (pos == lastpos && cur.prevAtom()->getChar() != ' ')
1842                             || (pos > 0 && cur.prevAtom()->getChar() != ' '
1843                                         && cur.nextAtom()->getChar() != ' ')) {
1844                                 cur.insert(c);
1845                                 // FIXME: we have to enable full redraw here because of the
1846                                 // visual box corners that define the inset. If we know for
1847                                 // sure that we stay within the same cell we can optimize for
1848                                 // that using:
1849                                 //cur.screenUpdateFlags(Update::SinglePar | Update::FitCursor);
1850                         }
1851                         return true;
1852                 }
1853                 if (cur.pos() != 0 && cur.prevAtom()->asSpaceInset()) {
1854                         cur.prevAtom().nucleus()->asSpaceInset()->incSpace();
1855                         // FIXME: we have to enable full redraw here because of the
1856                         // visual box corners that define the inset. If we know for
1857                         // sure that we stay within the same cell we can optimize for
1858                         // that using:
1859                         //cur.screenUpdateFlags(Update::SinglePar | Update::FitCursor);
1860                         return true;
1861                 }
1862
1863                 if (cur.popForward()) {
1864                         // FIXME: we have to enable full redraw here because of the
1865                         // visual box corners that define the inset. If we know for
1866                         // sure that we stay within the same cell we can optimize for
1867                         // that using:
1868                         //cur.screenUpdateFlags(Update::FitCursor);
1869                         return true;
1870                 }
1871
1872                 // if we are at the very end, leave the formula
1873                 return cur.pos() != cur.lastpos();
1874         }
1875
1876         // These should be treated differently when not in text mode:
1877         if (cur.inRegexped()) {
1878                 switch (c) {
1879                 case '^':
1880                         cur.niceInsert(createInsetMath("mathcircumflex", buf));
1881                         break;
1882                 case '{':
1883                 case '}':
1884                 case '#':
1885                 case '%':
1886                 case '_':
1887                         cur.niceInsert(createInsetMath(docstring(1, c), buf));
1888                         break;
1889                 case '~':
1890                         cur.niceInsert(createInsetMath("sim", buf));
1891                         break;
1892                 default:
1893                         cur.insert(c);
1894                 }
1895                 return true;
1896         } else if (currentMode() != InsetMath::TEXT_MODE) {
1897                 if (c == '_') {
1898                         cur.recordUndoInset();
1899                         script(cur, false, save_selection);
1900                         return true;
1901                 }
1902                 if (c == '^') {
1903                         cur.recordUndoInset();
1904                         script(cur, true, save_selection);
1905                         return true;
1906                 }
1907                 if (c == '~') {
1908                         cur.niceInsert(createInsetMath("sim", buf));
1909                         return true;
1910                 }
1911                 if (currentMode() == InsetMath::MATH_MODE && Encodings::isUnicodeTextOnly(c)) {
1912                         MathAtom const atom(new InsetMathChar(c));
1913                         if (cur.prevInset() && cur.prevInset()->asInsetMath()->name() == "text") {
1914                                 // reuse existing \text inset
1915                                 cur.prevInset()->asInsetMath()->cell(0).push_back(atom);
1916                         } else {
1917                                 MathAtom at = createInsetMath("text", buf);
1918                                 at.nucleus()->cell(0).push_back(atom);
1919                                 cur.insert(at);
1920                                 cur.posForward();
1921                         }
1922                         return true;
1923                 }
1924         } else {
1925                 if (c == '^') {
1926                         cur.niceInsert(createInsetMath("textasciicircum", buf));
1927                         return true;
1928                 }
1929                 if (c == '~') {
1930                         cur.niceInsert(createInsetMath("textasciitilde", buf));
1931                         return true;
1932                 }
1933         }
1934
1935         if (c == '{' || c == '}' || c == '&' || c == '$' || c == '#' ||
1936             c == '%' || c == '_') {
1937                 cur.niceInsert(createInsetMath(docstring(1, c), buf));
1938                 return true;
1939         }
1940
1941         // no special circumstances, so insert the character without any fuss
1942         cur.insert(c);
1943         return true;
1944 }
1945
1946
1947 bool InsetMathNest::interpretString(Cursor & cur, docstring const & str)
1948 {
1949         if (str == "\\limits" || str == "\\nolimits") {
1950                 if (cur.pos() > 0 && cur.prevMath().allowsLimitsChange()) {
1951                         cur.prevMath().limits(str == "\\limits" ? LIMITS : NO_LIMITS);
1952                         return true;
1953                 } else {
1954                         cur.message(bformat(_("Cannot apply %1$s here."), str));
1955                         return false;
1956                 }
1957         }
1958         // Create a InsetMathBig from cur.cell()[cur.pos() - 1] and t if
1959         // possible
1960         if (!cur.empty() && cur.pos() > 0 &&
1961             cur.cell()[cur.pos() - 1]->asUnknownInset()) {
1962                 if (InsetMathBig::isBigInsetDelim(str)) {
1963                         docstring prev = asString(cur.cell()[cur.pos() - 1]);
1964                         if (prev[0] == '\\') {
1965                                 prev = prev.substr(1);
1966                                 latexkeys const * l = in_word_set(prev);
1967                                 if (l && l->inset == "big") {
1968                                         cur.recordUndoSelection();
1969                                         cur.cell()[cur.pos() - 1] =
1970                                                 MathAtom(new InsetMathBig(prev, str));
1971                                         return true;
1972                                 }
1973                         }
1974                 }
1975         }
1976         return false;
1977 }
1978
1979
1980 bool InsetMathNest::script(Cursor & cur, bool up)
1981 {
1982         return script(cur, up, docstring());
1983 }
1984
1985
1986 bool InsetMathNest::script(Cursor & cur, bool up,
1987                 docstring const & save_selection)
1988 {
1989         // Hack to get \^ and \_ working
1990         //lyxerr << "handling script: up: " << up << endl;
1991         if (cur.inMacroMode() && cur.macroName() == "\\") {
1992                 if (up)
1993                         cur.niceInsert(createInsetMath("mathcircumflex", cur.buffer()));
1994                 else
1995                         interpretChar(cur, '_');
1996                 return true;
1997         }
1998
1999         cur.macroModeClose();
2000         if (asScriptInset() && cur.idx() == 0) {
2001                 // we are in a nucleus of a script inset, move to _our_ script
2002                 InsetMathScript * inset = asScriptInset();
2003                 //lyxerr << " going to cell " << inset->idxOfScript(up) << endl;
2004                 inset->ensure(up);
2005                 cur.idx() = inset->idxOfScript(up);
2006                 cur.pos() = 0;
2007         } else if (cur.pos() != 0 && cur.prevAtom()->asScriptInset()) {
2008                 --cur.pos();
2009                 InsetMathScript * inset = cur.nextAtom().nucleus()->asScriptInset();
2010                 cur.push(*inset);
2011                 inset->ensure(up);
2012                 cur.idx() = inset->idxOfScript(up);
2013                 cur.pos() = cur.lastpos();
2014         } else {
2015                 // convert the thing to our left to a scriptinset or create a new
2016                 // one if in the very first position of the array
2017                 if (cur.pos() == 0) {
2018                         //lyxerr << "new scriptinset" << endl;
2019                         cur.insert(new InsetMathScript(buffer_, up));
2020                 } else {
2021                         //lyxerr << "converting prev atom " << endl;
2022                         cur.prevAtom() = MathAtom(new InsetMathScript(buffer_, cur.prevAtom(), up));
2023                 }
2024                 --cur.pos();
2025                 InsetMathScript * inset = cur.nextAtom().nucleus()->asScriptInset();
2026                 // See comment in MathParser.cpp for special handling of {}-bases
2027
2028                 cur.push(*inset);
2029                 cur.idx() = 1;
2030                 cur.pos() = 0;
2031         }
2032         //lyxerr << "inserting selection 1:\n" << save_selection << endl;
2033         cur.niceInsert(save_selection);
2034         cur.resetAnchor();
2035         //lyxerr << "inserting selection 2:\n" << save_selection << endl;
2036         return true;
2037 }
2038
2039
2040 bool InsetMathNest::completionSupported(Cursor const & cur) const
2041 {
2042         return cur.inMacroMode();
2043 }
2044
2045
2046 bool InsetMathNest::inlineCompletionSupported(Cursor const & cur) const
2047 {
2048         return cur.inMacroMode();
2049 }
2050
2051
2052 bool InsetMathNest::automaticInlineCompletion() const
2053 {
2054         return lyxrc.completion_inline_math;
2055 }
2056
2057
2058 bool InsetMathNest::automaticPopupCompletion() const
2059 {
2060         return lyxrc.completion_popup_math;
2061 }
2062
2063
2064 CompletionList const *
2065 InsetMathNest::createCompletionList(Cursor const & cur) const
2066 {
2067         if (!cur.inMacroMode())
2068                 return nullptr;
2069
2070         return new MathCompletionList(cur);
2071 }
2072
2073
2074 docstring InsetMathNest::completionPrefix(Cursor const & cur) const
2075 {
2076         if (!cur.inMacroMode())
2077                 return docstring();
2078
2079         return cur.activeMacro()->name();
2080 }
2081
2082
2083 bool InsetMathNest::insertCompletion(Cursor & cur, docstring const & s,
2084                                      bool finished)
2085 {
2086         if (!cur.inMacroMode())
2087                 return false;
2088
2089         // append completion to active macro
2090         InsetMathUnknown * inset = cur.activeMacro();
2091         inset->setName(inset->name() + s);
2092
2093         // finish macro
2094         if (finished) {
2095 #if 0
2096                 // FIXME: this creates duplicates in the completion popup
2097                 // which looks ugly. Moreover the changes the list lengths
2098                 // which seems to confuse the popup as well.
2099                 MathCompletionList::addToFavorites(inset->name());
2100 #endif
2101                 lyx::dispatch(FuncRequest(LFUN_SELF_INSERT, " "));
2102         }
2103
2104         return true;
2105 }
2106
2107
2108 void InsetMathNest::completionPosAndDim(Cursor const & cur, int & x, int & y,
2109                                         Dimension & dim) const
2110 {
2111         Inset const * inset = cur.activeMacro();
2112         if (!inset)
2113                 return;
2114
2115         // get inset dimensions
2116         dim = cur.bv().coordCache().insets().dim(inset);
2117         // FIXME: these 3 are no accurate, but should depend on the font.
2118         // Now the popup jumps down if you enter a char with descent > 0.
2119         dim.des += 3;
2120         dim.asc += 3;
2121
2122         // and position
2123         Point xy = cur.bv().coordCache().insets().xy(inset);
2124         x = xy.x_;
2125         y = xy.y_;
2126 }
2127
2128
2129 ////////////////////////////////////////////////////////////////////
2130
2131 MathCompletionList::MathCompletionList(Cursor const & cur)
2132 {
2133         // fill it with macros from the buffer
2134         MacroNameSet macros;
2135         cur.buffer()->listMacroNames(macros);
2136         MacroNameSet::const_iterator it;
2137         for (it = macros.begin(); it != macros.end(); ++it) {
2138                 if (cur.buffer()->getMacro(*it, cur, false))
2139                         locals.push_back("\\" + *it);
2140         }
2141         sort(locals.begin(), locals.end());
2142
2143         if (!globals.empty())
2144                 return;
2145
2146         // fill in global macros
2147         macros.clear();
2148         MacroTable::globalMacros().getMacroNames(macros, false);
2149         //lyxerr << "Globals completion macros: ";
2150         for (it = macros.begin(); it != macros.end(); ++it) {
2151                 //lyxerr << "\\" + *it << " ";
2152                 globals.push_back("\\" + *it);
2153         }
2154         //lyxerr << std::endl;
2155
2156         // fill in global commands
2157         globals.push_back(from_ascii("\\boxed"));
2158         globals.push_back(from_ascii("\\fbox"));
2159         globals.push_back(from_ascii("\\framebox"));
2160         globals.push_back(from_ascii("\\makebox"));
2161         globals.push_back(from_ascii("\\kern"));
2162         globals.push_back(from_ascii("\\xhookrightarrow"));
2163         globals.push_back(from_ascii("\\xhookleftarrow"));
2164         globals.push_back(from_ascii("\\xrightarrow"));
2165         globals.push_back(from_ascii("\\xRightarrow"));
2166         globals.push_back(from_ascii("\\xrightharpoondown"));
2167         globals.push_back(from_ascii("\\xrightharpoonup"));
2168         globals.push_back(from_ascii("\\xrightleftharpoons"));
2169         globals.push_back(from_ascii("\\xleftarrow"));
2170         globals.push_back(from_ascii("\\xLeftarrow"));
2171         globals.push_back(from_ascii("\\xleftharpoondown"));
2172         globals.push_back(from_ascii("\\xleftharpoonup"));
2173         globals.push_back(from_ascii("\\xleftrightarrow"));
2174         globals.push_back(from_ascii("\\xLeftrightarrow"));
2175         globals.push_back(from_ascii("\\xleftrightharpoons"));
2176         globals.push_back(from_ascii("\\xmapsto"));
2177         globals.push_back(from_ascii("\\split"));
2178         globals.push_back(from_ascii("\\gathered"));
2179         globals.push_back(from_ascii("\\aligned"));
2180         globals.push_back(from_ascii("\\alignedat"));
2181         globals.push_back(from_ascii("\\cases"));
2182         globals.push_back(from_ascii("\\substack"));
2183         globals.push_back(from_ascii("\\xymatrix"));
2184         globals.push_back(from_ascii("\\Diagram"));
2185         globals.push_back(from_ascii("\\subarray"));
2186         globals.push_back(from_ascii("\\array"));
2187         globals.push_back(from_ascii("\\sqrt"));
2188         globals.push_back(from_ascii("\\root"));
2189         globals.push_back(from_ascii("\\tabular"));
2190         globals.push_back(from_ascii("\\sideset"));
2191         globals.push_back(from_ascii("\\stackrel"));
2192         globals.push_back(from_ascii("\\stackrelthree"));
2193         globals.push_back(from_ascii("\\binom"));
2194         globals.push_back(from_ascii("\\choose"));
2195         globals.push_back(from_ascii("\\brace"));
2196         globals.push_back(from_ascii("\\brack"));
2197         globals.push_back(from_ascii("\\frac"));
2198         globals.push_back(from_ascii("\\over"));
2199         globals.push_back(from_ascii("\\nicefrac"));
2200         globals.push_back(from_ascii("\\unitfrac"));
2201         globals.push_back(from_ascii("\\unitfracthree"));
2202         globals.push_back(from_ascii("\\unitone"));
2203         globals.push_back(from_ascii("\\unittwo"));
2204         globals.push_back(from_ascii("\\infer"));
2205         globals.push_back(from_ascii("\\atop"));
2206         globals.push_back(from_ascii("\\lefteqn"));
2207         globals.push_back(from_ascii("\\boldsymbol"));
2208         globals.push_back(from_ascii("\\bm"));
2209         globals.push_back(from_ascii("\\color"));
2210         globals.push_back(from_ascii("\\normalcolor"));
2211         globals.push_back(from_ascii("\\textcolor"));
2212         globals.push_back(from_ascii("\\cfrac"));
2213         globals.push_back(from_ascii("\\cfracleft"));
2214         globals.push_back(from_ascii("\\cfracright"));
2215         globals.push_back(from_ascii("\\dfrac"));
2216         globals.push_back(from_ascii("\\tfrac"));
2217         globals.push_back(from_ascii("\\dbinom"));
2218         globals.push_back(from_ascii("\\tbinom"));
2219         globals.push_back(from_ascii("\\hphantom"));
2220         globals.push_back(from_ascii("\\phantom"));
2221         globals.push_back(from_ascii("\\vphantom"));
2222         globals.push_back(from_ascii("\\cancel"));
2223         globals.push_back(from_ascii("\\bcancel"));
2224         globals.push_back(from_ascii("\\xcancel"));
2225         globals.push_back(from_ascii("\\cancelto"));
2226         globals.push_back(from_ascii("\\smash"));
2227         globals.push_back(from_ascii("\\mathclap"));
2228         globals.push_back(from_ascii("\\mathllap"));
2229         globals.push_back(from_ascii("\\mathrlap"));
2230         globals.push_back(from_ascii("\\ensuremath"));
2231         MathWordList const & words = mathedWordList();
2232         MathWordList::const_iterator it2;
2233         //lyxerr << "Globals completion commands: ";
2234         for (it2 = words.begin(); it2 != words.end(); ++it2) {
2235                 if (it2->second.inset != "macro" && !it2->second.hidden) {
2236                         // macros are already read from MacroTable::globalMacros()
2237                         globals.push_back('\\' + it2->first);
2238                         //lyxerr << '\\' + it2->first << ' ';
2239                 }
2240         }
2241         //lyxerr << std::endl;
2242         sort(globals.begin(), globals.end());
2243 }
2244
2245
2246 MathCompletionList::~MathCompletionList()
2247 {
2248 }
2249
2250
2251 size_type MathCompletionList::size() const
2252 {
2253         return locals.size() + globals.size();
2254 }
2255
2256
2257 docstring const & MathCompletionList::data(size_t idx) const
2258 {
2259         size_t lsize = locals.size();
2260         if (idx >= lsize)
2261                 return globals[idx - lsize];
2262         else
2263                 return locals[idx];
2264 }
2265
2266
2267 std::string MathCompletionList::icon(size_t idx) const
2268 {
2269         // get the latex command
2270         docstring cmd;
2271         size_t lsize = locals.size();
2272         if (idx >= lsize)
2273                 cmd = globals[idx - lsize];
2274         else
2275                 cmd = locals[idx];
2276
2277         // get the icon name by stripping the backslash
2278         docstring icon_name = frontend::Application::mathIcon(cmd.substr(1));
2279         if (icon_name.empty())
2280                 return std::string();
2281         return "math/" + to_utf8(icon_name);
2282 }
2283
2284 std::vector<docstring> MathCompletionList::globals;
2285
2286 } // namespace lyx