src/mathed/math_cursor.C

   1 /**
   2  * \file math_cursor.C
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Alejandro Aguilar Sierra
   7  * \author André Pönitz
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #include <config.h>
  13
  14 #include "math_cursor.h"
  15 #include "lyxrc.h"
  16 #include "support/limited_stack.h"
  17 #include "dispatchresult.h"
  18 #include "debug.h"
  19 #include "support/std_sstream.h"
  20 #include "formulabase.h"
  21 #include "funcrequest.h"
  22 #include "math_braceinset.h"
  23 #include "math_commentinset.h"
  24 #include "math_charinset.h"
  25 #include "math_factory.h"
  26 #include "math_gridinset.h"
  27 #include "math_macroarg.h"
  28 #include "math_macrotemplate.h"
  29 #include "math_mathmlstream.h"
  30 #include "math_scriptinset.h"
  31 #include "math_spaceinset.h"
  32 #include "math_support.h"
  33 #include "math_unknowninset.h"
  34
  35 #include <boost/assert.hpp>
  36
  37 //#define FILEDEBUG 1
  38
  39 using std::string;
  40 using std::endl;
  41 #ifndef CXX_GLOBAL_CSTD
  42 using std::isalpha;
  43 #endif
  44 using std::min;
  45 using std::swap;
  46
  47 using std::ostringstream;
  48
  49
  50 // matheds own cut buffer
  51 limited_stack<string> theCutBuffer;
  52
  53
  54 MathCursor::MathCursor(InsetFormulaBase * formula, bool front)
  55         :       formula_(formula), autocorrect_(false), selection_(false), targetx_(-1)
  56 {
  57         front ? first() : last();
  58         Anchor_ = Cursor_;
  59 }
  60
  61
  62 MathCursor::~MathCursor()
  63 {
  64         // ensure that 'notifyCursorLeave' is called
  65         while (popLeft())
  66                 ;
  67 }
  68
  69
  70 void MathCursor::push(MathAtom & t)
  71 {
  72         Cursor_.push_back(CursorSlice(t.nucleus()));
  73 }
  74
  75
  76 void MathCursor::pushLeft(MathAtom & t)
  77 {
  78         //lyxerr << "Entering atom " << t << " left" << endl;
  79         push(t);
  80         t->idxFirst(idx(), pos());
  81 }
  82
  83
  84 void MathCursor::pushRight(MathAtom & t)
  85 {
  86         //lyxerr << "Entering atom " << t << " right" << endl;
  87         posLeft();
  88         push(t);
  89         t->idxLast(idx(), pos());
  90 }
  91
  92
  93 bool MathCursor::popLeft()
  94 {
  95         //lyxerr << "Leaving atom to the left" << endl;
  96         if (depth() <= 1) {
  97                 if (depth() == 1)
  98                         inset()->notifyCursorLeaves(idx());
  99                 return false;
 100         }
 101         inset()->notifyCursorLeaves(idx());
 102         Cursor_.pop_back();
 103         return true;
 104 }
 105
 106
 107 bool MathCursor::popRight()
 108 {
 109         //lyxerr << "Leaving atom "; inset()->write(cerr, false); cerr << " right" << endl;
 110         if (depth() <= 1) {
 111                 if (depth() == 1)
 112                         inset()->notifyCursorLeaves(idx());
 113                 return false;
 114         }
 115         inset()->notifyCursorLeaves(idx());
 116         Cursor_.pop_back();
 117         posRight();
 118         return true;
 119 }
 120
 121
 122
 123 #if FILEDEBUG
 124         void MathCursor::dump(char const * what) const
 125         {
 126                 lyxerr << "MC: " << what << endl;
 127                 lyxerr << " Cursor: " << depth() << endl;
 128                 for (unsigned i = 0; i < depth(); ++i)
 129                         lyxerr << "    i: " << i << ' ' << Cursor_[i] << endl;
 130                 lyxerr << " Anchor: " << Anchor_.size() << endl;
 131                 for (unsigned i = 0; i < Anchor_.size(); ++i)
 132                         lyxerr << "    i: " << i << ' ' << Anchor_[i] << endl;
 133                 lyxerr  << " sel: " << selection_ << endl;
 134         }
 135 #else
 136         void MathCursor::dump(char const *) const {}
 137 #endif
 138
 139
 140 bool MathCursor::isInside(MathInset const * p) const
 141 {
 142         for (unsigned i = 0; i < depth(); ++i)
 143                 if (Cursor_[i].asMathInset() == p)
 144                         return true;
 145         return false;
 146 }
 147
 148
 149 bool MathCursor::openable(MathAtom const & t, bool sel) const
 150 {
 151         if (!t->isActive())
 152                 return false;
 153
 154         if (t->lock())
 155                 return false;
 156
 157         if (sel) {
 158                 // we can't move into anything new during selection
 159                 if (depth() == Anchor_.size())
 160                         return false;
 161                 if (t.operator->() != Anchor_[depth()].asMathInset())
 162                         return false;
 163         }
 164         return true;
 165 }
 166
 167
 168 bool MathCursor::inNucleus() const
 169 {
 170         return inset()->asScriptInset() && idx() == 2;
 171 }
 172
 173
 174 bool MathCursor::posLeft()
 175 {
 176         if (pos() == 0)
 177                 return false;
 178         --pos();
 179         return true;
 180 }
 181
 182
 183 bool MathCursor::posRight()
 184 {
 185         if (pos() == size())
 186                 return false;
 187         ++pos();
 188         return true;
 189 }
 190
 191
 192 bool MathCursor::left(bool sel)
 193 {
 194         dump("Left 1");
 195         autocorrect_ = false;
 196         targetx_ = -1; // "no target"
 197         if (inMacroMode()) {
 198                 macroModeClose();
 199                 return true;
 200         }
 201         selHandle(sel);
 202
 203         if (hasPrevAtom() && openable(prevAtom(), sel)) {
 204                 pushRight(prevAtom());
 205                 return true;
 206         }
 207
 208         return posLeft() || idxLeft() || popLeft() || selection_;
 209 }
 210
 211
 212 bool MathCursor::right(bool sel)
 213 {
 214         dump("Right 1");
 215         autocorrect_ = false;
 216         targetx_ = -1; // "no target"
 217         if (inMacroMode()) {
 218                 macroModeClose();
 219                 return true;
 220         }
 221         selHandle(sel);
 222
 223         if (hasNextAtom() && openable(nextAtom(), sel)) {
 224                 pushLeft(nextAtom());
 225                 return true;
 226         }
 227
 228         return posRight() || idxRight() || popRight() || selection_;
 229 }
 230
 231
 232 void MathCursor::first()
 233 {
 234         Cursor_.clear();
 235         push(formula_->par());
 236         inset()->idxFirst(idx(), pos());
 237 }
 238
 239
 240 void MathCursor::last()
 241 {
 242         Cursor_.clear();
 243         push(formula_->par());
 244         inset()->idxLast(idx(), pos());
 245 }
 246
 247
 248 bool positionable
 249         (MathIterator const & cursor, MathIterator const & anchor)
 250 {
 251         // avoid deeper nested insets when selecting
 252         if (cursor.size() > anchor.size())
 253                 return false;
 254
 255         // anchor might be deeper, should have same path then
 256         for (MathIterator::size_type i = 0; i < cursor.size(); ++i)
 257                 if (cursor[i].asMathInset() != anchor[i].asMathInset())
 258                         return false;
 259
 260         // position should be ok.
 261         return true;
 262 }
 263
 264
 265 void MathCursor::setPos(int x, int y)
 266 {
 267         dump("setPos 1");
 268         bool res = bruteFind(x, y,
 269                 formula()->xlow(), formula()->xhigh(),
 270                 formula()->ylow(), formula()->yhigh());
 271         if (!res) {
 272                 // this can happen on creation of "math-display"
 273                 dump("setPos 1.5");
 274                 first();
 275         }
 276         targetx_ = -1; // "no target"
 277         dump("setPos 2");
 278 }
 279
 280
 281
 282 bool MathCursor::home(bool sel)
 283 {
 284         dump("home 1");
 285         autocorrect_ = false;
 286         selHandle(sel);
 287         macroModeClose();
 288         if (!inset()->idxHome(idx(), pos()))
 289                 return popLeft();
 290         dump("home 2");
 291         targetx_ = -1; // "no target"
 292         return true;
 293 }
 294
 295
 296 bool MathCursor::end(bool sel)
 297 {
 298         dump("end 1");
 299         autocorrect_ = false;
 300         selHandle(sel);
 301         macroModeClose();
 302         if (!inset()->idxEnd(idx(), pos()))
 303                 return popRight();
 304         dump("end 2");
 305         targetx_ = -1; // "no target"
 306         return true;
 307 }
 308
 309
 310 void MathCursor::plainErase()
 311 {
 312         array().erase(pos());
 313 }
 314
 315
 316 void MathCursor::markInsert()
 317 {
 318         //lyxerr << "inserting mark" << endl;
 319         array().insert(pos(), MathAtom(new MathCharInset(0)));
 320 }
 321
 322
 323 void MathCursor::markErase()
 324 {
 325         //lyxerr << "deleting mark" << endl;
 326         array().erase(pos());
 327 }
 328
 329
 330 void MathCursor::plainInsert(MathAtom const & t)
 331 {
 332         dump("plainInsert");
 333         array().insert(pos(), t);
 334         ++pos();
 335 }
 336
 337
 338 void MathCursor::insert2(string const & str)
 339 {
 340         MathArray ar;
 341         asArray(str, ar);
 342         insert(ar);
 343 }
 344
 345
 346 void MathCursor::insert(string const & str)
 347 {
 348         //lyxerr << "inserting '" << str << "'" << endl;
 349         selClearOrDel();
 350         for (string::const_iterator it = str.begin(); it != str.end(); ++it)
 351                 plainInsert(MathAtom(new MathCharInset(*it)));
 352 }
 353
 354
 355 void MathCursor::insert(char c)
 356 {
 357         //lyxerr << "inserting '" << c << "'" << endl;
 358         selClearOrDel();
 359         plainInsert(MathAtom(new MathCharInset(c)));
 360 }
 361
 362
 363 void MathCursor::insert(MathAtom const & t)
 364 {
 365         macroModeClose();
 366         selClearOrDel();
 367         plainInsert(t);
 368 }
 369
 370
 371 void MathCursor::niceInsert(string const & t)
 372 {
 373         MathArray ar;
 374         asArray(t, ar);
 375         if (ar.size() == 1)
 376                 niceInsert(ar[0]);
 377         else
 378                 insert(ar);
 379 }
 380
 381
 382 void MathCursor::niceInsert(MathAtom const & t)
 383 {
 384         macroModeClose();
 385         string safe = grabAndEraseSelection();
 386         plainInsert(t);
 387         // enter the new inset and move the contents of the selection if possible
 388         if (t->isActive()) {
 389                 posLeft();
 390                 pushLeft(nextAtom());
 391                 paste(safe);
 392         }
 393 }
 394
 395
 396 void MathCursor::insert(MathArray const & ar)
 397 {
 398         macroModeClose();
 399         if (selection_)
 400                 eraseSelection();
 401         array().insert(pos(), ar);
 402         pos() += ar.size();
 403 }
 404
 405
 406 void MathCursor::paste(string const & data)
 407 {
 408         dispatch(FuncRequest(LFUN_PASTE, data));
 409 }
 410
 411
 412 bool MathCursor::backspace()
 413 {
 414         autocorrect_ = false;
 415
 416         if (selection_) {
 417                 selDel();
 418                 return true;
 419         }
 420
 421         if (pos() == 0) {
 422                 if (inset()->ncols() == 1 &&
 423                           inset()->nrows() == 1 &&
 424                           depth() == 1 &&
 425                           size() == 0)
 426                         return false;
 427                 pullArg();
 428                 return true;
 429         }
 430
 431         if (inMacroMode()) {
 432                 MathUnknownInset * p = activeMacro();
 433                 if (p->name().size() > 1) {
 434                         p->setName(p->name().substr(0, p->name().size() - 1));
 435                         return true;
 436                 }
 437         }
 438
 439         if (hasPrevAtom() && prevAtom()->nargs() > 0) {
 440                 // let's require two backspaces for 'big stuff' and
 441                 // highlight on the first
 442                 left(true);
 443         } else {
 444                 --pos();
 445                 plainErase();
 446         }
 447         return true;
 448 }
 449
 450
 451 bool MathCursor::erase()
 452 {
 453         autocorrect_ = false;
 454         if (inMacroMode())
 455                 return true;
 456
 457         if (selection_) {
 458                 selDel();
 459                 return true;
 460         }
 461
 462         // delete empty cells if possible
 463         if (array().empty())
 464                 if (inset()->idxDelete(idx()))
 465                         return true;
 466
 467         // special behaviour when in last position of cell
 468         if (pos() == size()) {
 469                 bool one_cell = inset()->ncols() == 1 && inset()->nrows() == 1;
 470                 if (one_cell && depth() == 1 && size() == 0)
 471                         return false;
 472                 // remove markup
 473                 if (one_cell)
 474                         pullArg();
 475                 else
 476                         inset()->idxGlue(idx());
 477                 return true;
 478         }
 479
 480         if (hasNextAtom() && nextAtom()->nargs() > 0)
 481                 right(true);
 482         else
 483                 plainErase();
 484
 485         return true;
 486 }
 487
 488
 489 bool MathCursor::up(bool sel)
 490 {
 491         dump("up 1");
 492         macroModeClose();
 493         selHandle(sel);
 494         MathIterator save = Cursor_;
 495         if (goUpDown(true))
 496                 return true;
 497         Cursor_ = save;
 498         autocorrect_ = false;
 499         return selection_;
 500 }
 501
 502
 503 bool MathCursor::down(bool sel)
 504 {
 505         dump("down 1");
 506         macroModeClose();
 507         selHandle(sel);
 508         MathIterator save = Cursor_;
 509         if (goUpDown(false))
 510                 return true;
 511         Cursor_ = save;
 512         autocorrect_ = false;
 513         return selection_;
 514 }
 515
 516
 517 void MathCursor::macroModeClose()
 518 {
 519         if (!inMacroMode())
 520                 return;
 521         MathUnknownInset * p = activeMacro();
 522         p->finalize();
 523         string s = p->name();
 524         --pos();
 525         array().erase(pos());
 526
 527         // do nothing if the macro name is empty
 528         if (s == "\\")
 529                 return;
 530
 531         string const name = s.substr(1);
 532
 533         // prevent entering of recursive macros
 534         if (formula()->lyxCode() == InsetOld::MATHMACRO_CODE
 535                         && formula()->getInsetName() == name)
 536                 lyxerr << "can't enter recursive macro" << endl;
 537
 538         niceInsert(createMathInset(name));
 539 }
 540
 541
 542 string MathCursor::macroName() const
 543 {
 544         return inMacroMode() ? activeMacro()->name() : string();
 545 }
 546
 547
 548 void MathCursor::selClear()
 549 {
 550         Anchor_.clear();
 551         selection_ = false;
 552 }
 553
 554
 555 void MathCursor::selCopy()
 556 {
 557         dump("selCopy");
 558         if (selection_) {
 559                 theCutBuffer.push(grabSelection());
 560                 selection_ = false;
 561         } else {
 562                 //theCutBuffer.erase();
 563         }
 564 }
 565
 566
 567 void MathCursor::selCut()
 568 {
 569         dump("selCut");
 570         theCutBuffer.push(grabAndEraseSelection());
 571 }
 572
 573
 574 void MathCursor::selDel()
 575 {
 576         dump("selDel");
 577         if (selection_) {
 578                 eraseSelection();
 579                 selection_ = false;
 580         }
 581 }
 582
 583
 584 void MathCursor::selPaste(size_t n)
 585 {
 586         dump("selPaste");
 587         selClearOrDel();
 588         if (n < theCutBuffer.size())
 589                 paste(theCutBuffer[n]);
 590         //grabSelection();
 591         selection_ = false;
 592 }
 593
 594
 595 void MathCursor::selHandle(bool sel)
 596 {
 597         if (sel == selection_)
 598                 return;
 599         //clear();
 600         Anchor_ = Cursor_;
 601         selection_ = sel;
 602 }
 603
 604
 605 void MathCursor::selStart()
 606 {
 607         dump("selStart 1");
 608         //clear();
 609         Anchor_ = Cursor_;
 610         selection_ = true;
 611         dump("selStart 2");
 612 }
 613
 614
 615 void MathCursor::selClearOrDel()
 616 {
 617         if (lyxrc.auto_region_delete)
 618                 selDel();
 619         else
 620                 selection_ = false;
 621 }
 622
 623
 624 void MathCursor::drawSelection(PainterInfo & pi) const
 625 {
 626         if (!selection_)
 627                 return;
 628         CursorSlice i1;
 629         CursorSlice i2;
 630         getSelection(i1, i2);
 631         i1.asMathInset()->drawSelection(pi, i1.idx_, i1.pos_, i2.idx_, i2.pos_);
 632 }
 633
 634
 635 void MathCursor::handleNest(MathAtom const & a, int c)
 636 {
 637         MathAtom at = a;
 638         asArray(grabAndEraseSelection(), at.nucleus()->cell(c));
 639         insert(at);
 640         pushRight(prevAtom());
 641 }
 642
 643
 644 void MathCursor::getPos(int & x, int & y) const
 645 {
 646         inset()->getPos(idx(), pos(), x, y);
 647 }
 648
 649
 650 int MathCursor::targetX() const
 651 {
 652         if (targetx_ != -1)
 653                 return targetx_;
 654         int x = 0, y = 0;
 655         getPos(x, y);
 656         return x;
 657 }
 658
 659
 660 MathInset * MathCursor::inset() const
 661 {
 662         return cursor().asMathInset();
 663 }
 664
 665
 666 InsetFormulaBase * MathCursor::formula() const
 667 {
 668         return formula_;
 669 }
 670
 671
 672 MathCursor::idx_type MathCursor::idx() const
 673 {
 674         return cursor().idx_;
 675 }
 676
 677
 678 MathCursor::idx_type & MathCursor::idx()
 679 {
 680         return cursor().idx_;
 681 }
 682
 683
 684 MathCursor::pos_type MathCursor::pos() const
 685 {
 686         return cursor().pos_;
 687 }
 688
 689
 690 void MathCursor::adjust(pos_type from, difference_type diff)
 691 {
 692         if (cursor().pos_ > from)
 693                 cursor().pos_ += diff;
 694         if (Anchor_.back().pos_ > from)
 695                 Anchor_.back().pos_ += diff;
 696         // just to be on the safe side
 697         // theoretically unecessary
 698         normalize();
 699 }
 700
 701
 702 MathCursor::pos_type & MathCursor::pos()
 703 {
 704         return cursor().pos_;
 705 }
 706
 707
 708 bool MathCursor::inMacroMode() const
 709 {
 710         if (!hasPrevAtom())
 711                 return false;
 712         MathUnknownInset const * p = prevAtom()->asUnknownInset();
 713         return p && !p->final();
 714 }
 715
 716
 717 MathUnknownInset * MathCursor::activeMacro()
 718 {
 719         return inMacroMode() ? prevAtom().nucleus()->asUnknownInset() : 0;
 720 }
 721
 722
 723 MathUnknownInset const * MathCursor::activeMacro() const
 724 {
 725         return inMacroMode() ? prevAtom()->asUnknownInset() : 0;
 726 }
 727
 728
 729 bool MathCursor::inMacroArgMode() const
 730 {
 731         return pos() > 0 && prevAtom()->getChar() == '#';
 732 }
 733
 734
 735 bool MathCursor::selection() const
 736 {
 737         return selection_;
 738 }
 739
 740
 741 MathGridInset * MathCursor::enclosingGrid(MathCursor::idx_type & idx) const
 742 {
 743         for (MathInset::difference_type i = depth() - 1; i >= 0; --i) {
 744                 MathGridInset * p = Cursor_[i].asMathInset()->asGridInset();
 745                 if (p) {
 746                         idx = Cursor_[i].idx_;
 747                         return p;
 748                 }
 749         }
 750         return 0;
 751 }
 752
 753
 754 void MathCursor::popToHere(MathInset const * p)
 755 {
 756         while (depth() && Cursor_.back().asMathInset() != p)
 757                 Cursor_.pop_back();
 758 }
 759
 760
 761 void MathCursor::popToEnclosingGrid()
 762 {
 763         while (depth() && !Cursor_.back().asMathInset()->asGridInset())
 764                 Cursor_.pop_back();
 765 }
 766
 767
 768 void MathCursor::popToEnclosingHull()
 769 {
 770         while (depth() && !Cursor_.back().asMathInset()->asHullInset())
 771                 Cursor_.pop_back();
 772 }
 773
 774
 775 void MathCursor::pullArg()
 776 {
 777         dump("pullarg");
 778         MathArray a = array();
 779         if (popLeft()) {
 780                 plainErase();
 781                 array().insert(pos(), a);
 782                 Anchor_ = Cursor_;
 783         } else {
 784                 formula()->mutateToText();
 785         }
 786 }
 787
 788
 789 void MathCursor::touch()
 790 {
 791         MathIterator::const_iterator it = Cursor_.begin();
 792         MathIterator::const_iterator et = Cursor_.end();
 793         for ( ; it != et; ++it)
 794                 it->cell().touch();
 795 }
 796
 797
 798 void MathCursor::normalize()
 799 {
 800         if (idx() >= inset()->nargs()) {
 801                 lyxerr << "this should not really happen - 1: "
 802                        << idx() << ' ' << inset()->nargs()
 803                        << " in: " << inset() << endl;
 804                 dump("error 2");
 805         }
 806         idx() = min(idx(), inset()->nargs() - 1);
 807
 808         if (pos() > size()) {
 809                 lyxerr << "this should not really happen - 2: "
 810                         << pos() << ' ' << size() <<  " in idx: " << idx()
 811                        << " in atom: '";
 812                 WriteStream wi(lyxerr, false, true);
 813                 inset()->write(wi);
 814                 lyxerr << endl;
 815                 dump("error 4");
 816         }
 817         pos() = min(pos(), size());
 818 }
 819
 820
 821 MathCursor::size_type MathCursor::size() const
 822 {
 823         return array().size();
 824 }
 825
 826
 827 bool MathCursor::hasPrevAtom() const
 828 {
 829         return pos() > 0;
 830 }
 831
 832
 833 bool MathCursor::hasNextAtom() const
 834 {
 835         return pos() < size();
 836 }
 837
 838
 839 MathAtom const & MathCursor::prevAtom() const
 840 {
 841         BOOST_ASSERT(pos() > 0);
 842         return array()[pos() - 1];
 843 }
 844
 845
 846 MathAtom & MathCursor::prevAtom()
 847 {
 848         BOOST_ASSERT(pos() > 0);
 849         return array()[pos() - 1];
 850 }
 851
 852
 853 MathAtom const & MathCursor::nextAtom() const
 854 {
 855         BOOST_ASSERT(pos() < size());
 856         return array()[pos()];
 857 }
 858
 859
 860 MathAtom & MathCursor::nextAtom()
 861 {
 862         BOOST_ASSERT(pos() < size());
 863         return array()[pos()];
 864 }
 865
 866
 867 MathArray & MathCursor::array() const
 868 {
 869         static MathArray dummy;
 870
 871         if (idx() >= inset()->nargs()) {
 872                 lyxerr << "############  idx_ " << idx() << " not valid" << endl;
 873                 return dummy;
 874         }
 875
 876         if (depth() == 0) {
 877                 lyxerr << "############  depth() == 0 not valid" << endl;
 878                 return dummy;
 879         }
 880
 881         return cursor().cell();
 882 }
 883
 884
 885 void MathCursor::idxNext()
 886 {
 887         inset()->idxNext(idx(), pos());
 888 }
 889
 890
 891 void MathCursor::idxPrev()
 892 {
 893         inset()->idxPrev(idx(), pos());
 894 }
 895
 896
 897 char MathCursor::valign() const
 898 {
 899         idx_type idx;
 900         MathGridInset * p = enclosingGrid(idx);
 901         return p ? p->valign() : '\0';
 902 }
 903
 904
 905 char MathCursor::halign() const
 906 {
 907         idx_type idx;
 908         MathGridInset * p = enclosingGrid(idx);
 909         return p ? p->halign(idx % p->ncols()) : '\0';
 910 }
 911
 912
 913 void MathCursor::getSelection(CursorSlice & i1, CursorSlice & i2) const
 914 {
 915         CursorSlice anc = normalAnchor();
 916         if (anc < cursor()) {
 917                 i1 = anc;
 918                 i2 = cursor();
 919         } else {
 920                 i1 = cursor();
 921                 i2 = anc;
 922         }
 923 }
 924
 925
 926 CursorSlice & MathCursor::cursor()
 927 {
 928         BOOST_ASSERT(depth());
 929         return Cursor_.back();
 930 }
 931
 932
 933 CursorSlice const & MathCursor::cursor() const
 934 {
 935         BOOST_ASSERT(depth());
 936         return Cursor_.back();
 937 }
 938
 939
 940 bool MathCursor::goUpDown(bool up)
 941 {
 942         // Be warned: The 'logic' implemented in this function is highly fragile.
 943         // A distance of one pixel or a '<' vs '<=' _really_ matters.
 944         // So fiddle around with it only if you know what you are doing!
 945   int xo = 0;
 946         int yo = 0;
 947         getPos(xo, yo);
 948
 949         // check if we had something else in mind, if not, this is the future goal
 950         if (targetx_ == -1)
 951                 targetx_ = xo;
 952         else
 953                 xo = targetx_;
 954
 955         // try neigbouring script insets
 956         if (!selection()) {
 957                 // try left
 958                 if (hasPrevAtom()) {
 959                         MathScriptInset const * p = prevAtom()->asScriptInset();
 960                         if (p && p->has(up)) {
 961                                 --pos();
 962                                 push(nextAtom());
 963                                 idx() = up; // the superscript has index 1
 964                                 pos() = size();
 965                                 //lyxerr << "updown: handled by scriptinset to the left" << endl;
 966                                 return true;
 967                         }
 968                 }
 969
 970                 // try right
 971                 if (hasNextAtom()) {
 972                         MathScriptInset const * p = nextAtom()->asScriptInset();
 973                         if (p && p->has(up)) {
 974                                 push(nextAtom());
 975                                 idx() = up;
 976                                 pos() = 0;
 977                                 //lyxerr << "updown: handled by scriptinset to the right" << endl;
 978                                 return true;
 979                         }
 980                 }
 981         }
 982
 983         // try current cell for e.g. text insets
 984         if (inset()->idxUpDown2(idx(), pos(), up, targetx_))
 985                 return true;
 986
 987         //xarray().boundingBox(xlow, xhigh, ylow, yhigh);
 988         //if (up)
 989         //      yhigh = yo - 4;
 990         //else
 991         //      ylow = yo + 4;
 992         //if (bruteFind(xo, yo, xlow, xhigh, ylow, yhigh)) {
 993         //      lyxerr << "updown: handled by brute find in the same cell" << endl;
 994         //      return true;
 995         //}
 996
 997         // try to find an inset that knows better then we
 998         while (1) {
 999                 //lyxerr << "updown: We are in " << inset() << " idx: " << idx() << endl;
1000                 // ask inset first
1001                 if (inset()->idxUpDown(idx(), pos(), up, targetx_)) {
1002                         // try to find best position within this inset
1003                         if (!selection())
1004                                 bruteFind2(xo, yo);
1005                         return true;
1006                 }
1007
1008                 // no such inset found, just take something "above"
1009                 //lyxerr << "updown: handled by strange case" << endl;
1010                 if (!popLeft())
1011                         return
1012                                 bruteFind(xo, yo,
1013                                         formula()->xlow(),
1014                                         formula()->xhigh(),
1015                                         up ? formula()->ylow() : yo + 4,
1016                                         up ? yo - 4 : formula()->yhigh()
1017                                 );
1018
1019                 // any improvement so far?
1020                 int xnew, ynew;
1021                 getPos(xnew, ynew);
1022                 if (up ? ynew < yo : ynew > yo)
1023                         return true;
1024         }
1025 }
1026
1027
1028 bool MathCursor::bruteFind
1029         (int x, int y, int xlow, int xhigh, int ylow, int yhigh)
1030 {
1031         MathIterator best_cursor;
1032         double best_dist = 1e10;
1033
1034         MathIterator it = ibegin(formula()->par().nucleus());
1035         MathIterator et = iend(formula()->par().nucleus());
1036         while (1) {
1037                 // avoid invalid nesting when selecting
1038                 if (!selection_ || positionable(it, Anchor_)) {
1039                         int xo, yo;
1040                         it.back().getPos(xo, yo);
1041                         if (xlow <= xo && xo <= xhigh && ylow <= yo && yo <= yhigh) {
1042                                 double d = (x - xo) * (x - xo) + (y - yo) * (y - yo);
1043                                 //lyxerr << "x: " << x << " y: " << y << " d: " << endl;
1044                                 // '<=' in order to take the last possible position
1045                                 // this is important for clicking behind \sum in e.g. '\sum_i a'
1046                                 if (d <= best_dist) {
1047                                         best_dist   = d;
1048                                         best_cursor = it;
1049                                 }
1050                         }
1051                 }
1052
1053                 if (it == et)
1054                         break;
1055                 ++it;
1056         }
1057
1058         if (best_dist < 1e10)
1059                 Cursor_ = best_cursor;
1060         return best_dist < 1e10;
1061 }
1062
1063
1064 void MathCursor::bruteFind2(int x, int y)
1065 {
1066         double best_dist = 1e10;
1067
1068         MathIterator it = Cursor_;
1069         it.back().setPos(0);
1070         MathIterator et = Cursor_;
1071         et.back().setPos(it.cell().size());
1072         for (int i = 0; ; ++i) {
1073                 int xo, yo;
1074                 it.back().getPos(xo, yo);
1075                 double d = (x - xo) * (x - xo) + (y - yo) * (y - yo);
1076                 // '<=' in order to take the last possible position
1077                 // this is important for clicking behind \sum in e.g. '\sum_i a'
1078                 lyxerr << "i: " << i << " d: " << d << " best: " << best_dist << endl;
1079                 if (d <= best_dist) {
1080                         best_dist = d;
1081                         Cursor_   = it;
1082                 }
1083                 if (it == et)
1084                         break;
1085                 ++it;
1086         }
1087 }
1088
1089
1090 bool MathCursor::idxLineLast()
1091 {
1092         idx() -= idx() % inset()->ncols();
1093         idx() += inset()->ncols() - 1;
1094         pos() = size();
1095         return true;
1096 }
1097
1098 bool MathCursor::idxLeft()
1099 {
1100         return inset()->idxLeft(idx(), pos());
1101 }
1102
1103
1104 bool MathCursor::idxRight()
1105 {
1106         return inset()->idxRight(idx(), pos());
1107 }
1108
1109
1110 bool MathCursor::script(bool up)
1111 {
1112         // Hack to get \\^ and \\_ working
1113         if (inMacroMode() && macroName() == "\\") {
1114                 if (up)
1115                         niceInsert(createMathInset("mathcircumflex"));
1116                 else
1117                         interpret('_');
1118                 return true;
1119         }
1120
1121         macroModeClose();
1122         string safe = grabAndEraseSelection();
1123         if (inNucleus()) {
1124                 // we are in a nucleus of a script inset, move to _our_ script
1125                 inset()->asScriptInset()->ensure(up);
1126                 idx() = up;
1127                 pos() = 0;
1128         } else if (hasPrevAtom() && prevAtom()->asScriptInset()) {
1129                 prevAtom().nucleus()->asScriptInset()->ensure(up);
1130                 pushRight(prevAtom());
1131                 idx() = up;
1132                 pos() = size();
1133         } else if (hasPrevAtom()) {
1134                 --pos();
1135                 array()[pos()] = MathAtom(new MathScriptInset(nextAtom(), up));
1136                 pushLeft(nextAtom());
1137                 idx() = up;
1138                 pos() = 0;
1139         } else {
1140                 plainInsert(MathAtom(new MathScriptInset(up)));
1141                 prevAtom().nucleus()->asScriptInset()->ensure(up);
1142                 pushRight(prevAtom());
1143                 idx() = up;
1144                 pos() = 0;
1145         }
1146         paste(safe);
1147         dump("1");
1148         return true;
1149 }
1150
1151
1152 bool MathCursor::interpret(char c)
1153 {
1154         //lyxerr << "interpret 2: '" << c << "'" << endl;
1155         targetx_ = -1; // "no target"
1156         if (inMacroArgMode()) {
1157                 --pos();
1158                 plainErase();
1159                 int n = c - '0';
1160                 MathMacroTemplate const * p = formula()->par()->asMacroTemplate();
1161                 if (p && 1 <= n && n <= p->numargs())
1162                         insert(MathAtom(new MathMacroArgument(c - '0')));
1163                 else {
1164                         insert(createMathInset("#"));
1165                         interpret(c); // try again
1166                 }
1167                 return true;
1168         }
1169
1170         // handle macroMode
1171         if (inMacroMode()) {
1172                 string name = macroName();
1173                 //lyxerr << "interpret name: '" << name << "'" << endl;
1174
1175                 if (isalpha(c)) {
1176                         activeMacro()->setName(activeMacro()->name() + c);
1177                         return true;
1178                 }
1179
1180                 // handle 'special char' macros
1181                 if (name == "\\") {
1182                         // remove the '\\'
1183                         backspace();
1184                         if (c == '\\') {
1185                                 if (currentMode() == MathInset::TEXT_MODE)
1186                                         niceInsert(createMathInset("textbackslash"));
1187                                 else
1188                                         niceInsert(createMathInset("backslash"));
1189                         } else if (c == '{') {
1190                                 niceInsert(MathAtom(new MathBraceInset));
1191                         } else {
1192                                 niceInsert(createMathInset(string(1, c)));
1193                         }
1194                         return true;
1195                 }
1196
1197                 // leave macro mode and try again if necessary
1198                 macroModeClose();
1199                 if (c == '{')
1200                         niceInsert(MathAtom(new MathBraceInset));
1201                 else if (c != ' ')
1202                         interpret(c);
1203                 return true;
1204         }
1205
1206         // This is annoying as one has to press <space> far too often.
1207         // Disable it.
1208
1209         if (0) {
1210                 // leave autocorrect mode if necessary
1211                 if (autocorrect_ && c == ' ') {
1212                         autocorrect_ = false;
1213                         return true;
1214                 }
1215         }
1216
1217         // just clear selection on pressing the space bar
1218         if (selection_ && c == ' ') {
1219                 selection_ = false;
1220                 return true;
1221         }
1222
1223         selClearOrDel();
1224
1225         if (c == '\\') {
1226                 //lyxerr << "starting with macro" << endl;
1227                 insert(MathAtom(new MathUnknownInset("\\", false)));
1228                 return true;
1229         }
1230
1231         if (c == '\n') {
1232                 if (currentMode() == MathInset::TEXT_MODE)
1233                         insert(c);
1234                 return true;
1235         }
1236
1237         if (c == ' ') {
1238                 if (currentMode() == MathInset::TEXT_MODE) {
1239                         // insert spaces in text mode,
1240                         // but suppress direct insertion of two spaces in a row
1241                         // the still allows typing  '<space>a<space>' and deleting the 'a', but
1242                         // it is better than nothing...
1243                         if (!hasPrevAtom() || prevAtom()->getChar() != ' ')
1244                                 insert(c);
1245                         return true;
1246                 }
1247                 if (hasPrevAtom() && prevAtom()->asSpaceInset()) {
1248                         prevAtom().nucleus()->asSpaceInset()->incSpace();
1249                         return true;
1250                 }
1251                 if (popRight())
1252                         return true;
1253                 // if are at the very end, leave the formula
1254                 return pos() != size();
1255         }
1256
1257         if (c == '_') {
1258                 script(false);
1259                 return true;
1260         }
1261
1262         if (c == '^') {
1263                 script(true);
1264                 return true;
1265         }
1266
1267         if (c == '{' || c == '}' || c == '#' || c == '&' || c == '$') {
1268                 niceInsert(createMathInset(string(1, c)));
1269                 return true;
1270         }
1271
1272         if (c == '%') {
1273                 niceInsert(MathAtom(new MathCommentInset));
1274                 return true;
1275         }
1276
1277         // try auto-correction
1278         //if (autocorrect_ && hasPrevAtom() && math_autocorrect(prevAtom(), c))
1279         //      return true;
1280
1281         // no special circumstances, so insert the character without any fuss
1282         insert(c);
1283         autocorrect_ = true;
1284         return true;
1285 }
1286
1287
1288 void MathCursor::setSelection(MathIterator const & where, size_type n)
1289 {
1290         selection_ = true;
1291         Anchor_ = where;
1292         Cursor_ = where;
1293         cursor().pos_ += n;
1294 }
1295
1296
1297 void MathCursor::insetToggle()
1298 {
1299         if (hasNextAtom()) {
1300                 // toggle previous inset ...
1301                 nextAtom().nucleus()->lock(!nextAtom()->lock());
1302         } else if (popLeft() && hasNextAtom()) {
1303                 // ... or enclosing inset if we are in the last inset position
1304                 nextAtom().nucleus()->lock(!nextAtom()->lock());
1305                 posRight();
1306         }
1307 }
1308
1309
1310 string MathCursor::info() const
1311 {
1312         ostringstream os;
1313         os << "Math editor mode.  ";
1314         for (int i = 0, n = depth(); i < n; ++i) {
1315                 Cursor_[i].asMathInset()->infoize(os);
1316                 os << "  ";
1317         }
1318         if (hasPrevAtom())
1319                 prevAtom()->infoize2(os);
1320         os << "                    ";
1321         return os.str();
1322 }
1323
1324
1325 unsigned MathCursor::depth() const
1326 {
1327         return Cursor_.size();
1328 }
1329
1330
1331
1332
1333 namespace {
1334
1335 void region(CursorSlice const & i1, CursorSlice const & i2,
1336         MathInset::row_type & r1, MathInset::row_type & r2,
1337         MathInset::col_type & c1, MathInset::col_type & c2)
1338 {
1339         MathInset * p = i1.asMathInset();
1340         c1 = p->col(i1.idx_);
1341         c2 = p->col(i2.idx_);
1342         if (c1 > c2)
1343                 swap(c1, c2);
1344         r1 = p->row(i1.idx_);
1345         r2 = p->row(i2.idx_);
1346         if (r1 > r2)
1347                 swap(r1, r2);
1348 }
1349
1350 }
1351
1352
1353 string MathCursor::grabSelection() const
1354 {
1355         if (!selection_)
1356                 return string();
1357
1358         CursorSlice i1;
1359         CursorSlice i2;
1360         getSelection(i1, i2);
1361
1362         if (i1.idx_ == i2.idx_) {
1363                 MathArray::const_iterator it = i1.cell().begin();
1364                 return asString(MathArray(it + i1.pos_, it + i2.pos_));
1365         }
1366
1367         row_type r1, r2;
1368         col_type c1, c2;
1369         region(i1, i2, r1, r2, c1, c2);
1370
1371         string data;
1372         for (row_type row = r1; row <= r2; ++row) {
1373                 if (row > r1)
1374                         data += "\\\\";
1375                 for (col_type col = c1; col <= c2; ++col) {
1376                         if (col > c1)
1377                                 data += '&';
1378                         data += asString(i1.asMathInset()->cell(i1.asMathInset()->index(row, col)));
1379                 }
1380         }
1381         return data;
1382 }
1383
1384
1385 void MathCursor::eraseSelection()
1386 {
1387         CursorSlice i1;
1388         CursorSlice i2;
1389         getSelection(i1, i2);
1390         if (i1.idx_ == i2.idx_)
1391                 i1.cell().erase(i1.pos_, i2.pos_);
1392         else {
1393                 MathInset * p = i1.asMathInset();
1394                 row_type r1, r2;
1395                 col_type c1, c2;
1396                 region(i1, i2, r1, r2, c1, c2);
1397                 for (row_type row = r1; row <= r2; ++row)
1398                         for (col_type col = c1; col <= c2; ++col)
1399                                 p->cell(p->index(row, col)).clear();
1400         }
1401         cursor() = i1;
1402 }
1403
1404
1405 string MathCursor::grabAndEraseSelection()
1406 {
1407         if (!selection_)
1408                 return string();
1409         string res = grabSelection();
1410         eraseSelection();
1411         selection_ = false;
1412         return res;
1413 }
1414
1415
1416 CursorSlice MathCursor::normalAnchor() const
1417 {
1418         if (Anchor_.size() < depth()) {
1419                 Anchor_ = Cursor_;
1420                 lyxerr << "unusual Anchor size" << endl;
1421         }
1422         //lyx::BOOST_ASSERT(Anchor_.size() >= cursor.depth());
1423         // use Anchor on the same level as Cursor
1424         CursorSlice normal = Anchor_[depth() - 1];
1425         if (depth() < Anchor_.size() && !(normal < cursor())) {
1426                 // anchor is behind cursor -> move anchor behind the inset
1427                 ++normal.pos_;
1428         }
1429         return normal;
1430 }
1431
1432
1433 DispatchResult MathCursor::dispatch(FuncRequest const & cmd)
1434 {
1435         // mouse clicks are somewhat special
1436         // check
1437         switch (cmd.action) {
1438                 case LFUN_MOUSE_PRESS:
1439                 case LFUN_MOUSE_MOTION:
1440                 case LFUN_MOUSE_RELEASE:
1441                 case LFUN_MOUSE_DOUBLE: {
1442                         CursorSlice & pos = Cursor_.back();
1443                         int x = 0;
1444                         int y = 0;
1445                         getPos(x, y);
1446                         if (x < cmd.x && hasPrevAtom()) {
1447                                 DispatchResult const res =
1448                                         prevAtom().nucleus()->dispatch(cmd, pos.idx_, pos.pos_);
1449                                 if (res.dispatched())
1450                                         return res;
1451                         }
1452                         if (x > cmd.x && hasNextAtom()) {
1453                                 DispatchResult const res =
1454                                         nextAtom().nucleus()->dispatch(cmd, pos.idx_, pos.pos_);
1455                                 if (res.dispatched())
1456                                         return res;
1457                         }
1458                 }
1459                 default:
1460                         break;
1461         }
1462
1463         for (int i = Cursor_.size() - 1; i >= 0; --i) {
1464                 CursorSlice & pos = Cursor_[i];
1465                 DispatchResult const res =
1466                         pos.asMathInset()->dispatch(cmd, pos.idx_, pos.pos_);
1467                 if (res.dispatched()) {
1468                         if (res.val() == FINISHED) {
1469                                 Cursor_.shrink(i + 1);
1470                                 selClear();
1471                         }
1472                         return res;
1473                 }
1474         }
1475         return DispatchResult(false);
1476 }
1477
1478
1479 MathInset::mode_type MathCursor::currentMode() const
1480 {
1481         for (int i = Cursor_.size() - 1; i >= 0; --i) {
1482                 MathInset::mode_type res = Cursor_[i].asMathInset()->currentMode();
1483                 if (res != MathInset::UNDECIDED_MODE)
1484                         return res;
1485         }
1486         return MathInset::UNDECIDED_MODE;
1487 }
1488
1489
1490 void MathCursor::handleFont(string const & font)
1491 {
1492         string safe;
1493         if (selection()) {
1494                 macroModeClose();
1495                 safe = grabAndEraseSelection();
1496         }
1497
1498         if (array().size()) {
1499                 // something left in the cell
1500                 if (pos() == 0) {
1501                         // cursor in first position
1502                         popLeft();
1503                 } else if (pos() == array().size()) {
1504                         // cursor in last position
1505                         popRight();
1506                 } else {
1507                         // cursor in between. split cell
1508                         MathArray::iterator bt = array().begin();
1509                         MathAtom at = createMathInset(font);
1510                         at.nucleus()->cell(0) = MathArray(bt, bt + pos());
1511                         cursor().cell().erase(bt, bt + pos());
1512                         popLeft();
1513                         plainInsert(at);
1514                 }
1515         } else {
1516                 // nothing left in the cell
1517                 pullArg();
1518                 plainErase();
1519         }
1520         insert(safe);
1521 }
1522
1523
1524 void releaseMathCursor(BufferView * bv)
1525 {
1526         if (mathcursor) {
1527                 InsetFormulaBase * f =  mathcursor->formula();
1528                 delete mathcursor;
1529                 mathcursor = 0;
1530                 f->insetUnlock(bv);
1531         }
1532 }