src/mathed/math_cursor.C

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