src/cursor.C

   1 /**
   2  * \file 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 Alfredo Braunstein
   8  * \author André Pönitz
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #include <config.h>
  14
  15 #include "BufferView.h"
  16 #include "bufferview_funcs.h"
  17 #include "buffer.h"
  18 #include "cursor.h"
  19 #include "coordcache.h"
  20 #include "CutAndPaste.h"
  21 #include "debug.h"
  22 #include "dispatchresult.h"
  23 #include "encoding.h"
  24 #include "funcrequest.h"
  25 #include "language.h"
  26 #include "lfuns.h"
  27 #include "lyxfont.h"
  28 #include "lyxfunc.h" // only for setMessage()
  29 #include "lyxrc.h"
  30 #include "lyxrow.h"
  31 #include "lyxtext.h"
  32 #include "paragraph.h"
  33 #include "paragraph_funcs.h"
  34 #include "pariterator.h"
  35
  36 #include "insets/insettabular.h"
  37 #include "insets/insettext.h"
  38
  39 #include "mathed/MathData.h"
  40 #include "mathed/InsetMath.h"
  41 #include "mathed/InsetMathScript.h"
  42 #include "mathed/MathMacroTable.h"
  43
  44 #include "support/limited_stack.h"
  45
  46 #include <boost/assert.hpp>
  47 #include <boost/bind.hpp>
  48 #include <boost/current_function.hpp>
  49
  50 #include <sstream>
  51 #include <limits>
  52 #include <map>
  53
  54 namespace lyx {
  55
  56 using std::string;
  57 using std::vector;
  58 using std::endl;
  59 #ifndef CXX_GLOBAL_CSTD
  60 using std::isalpha;
  61 #endif
  62 using std::min;
  63 using std::for_each;
  64
  65 namespace {
  66
  67         bool
  68         positionable(DocIterator const & cursor, DocIterator const & anchor)
  69         {
  70                 // avoid deeper nested insets when selecting
  71                 if (cursor.depth() > anchor.depth())
  72                         return false;
  73
  74                 // anchor might be deeper, should have same path then
  75                 for (size_t i = 0; i < cursor.depth(); ++i)
  76                         if (&cursor[i].inset() != &anchor[i].inset())
  77                                 return false;
  78
  79                 // position should be ok.
  80                 return true;
  81         }
  82
  83
  84         // Find position closest to (x, y) in cell given by iter.
  85         // Used only in mathed
  86         DocIterator bruteFind2(LCursor const & c, int x, int y)
  87         {
  88                 double best_dist = std::numeric_limits<double>::max();
  89
  90                 DocIterator result;
  91
  92                 DocIterator it = c;
  93                 it.top().pos() = 0;
  94                 DocIterator et = c;
  95                 et.top().pos() = et.top().asInsetMath()->cell(et.top().idx()).size();
  96                 for (size_t i = 0; ; ++i) {
  97                         int xo;
  98                         int yo;
  99                         InsetBase const * inset = &it.inset();
 100                         std::map<InsetBase const *, Point> const & data =
 101                                 c.bv().coordCache().getInsets().getData();
 102                         std::map<InsetBase const *, Point>::const_iterator I = data.find(inset);
 103
 104                         // FIXME: in the case where the inset is not in the cache, this
 105                         // means that no part of it is visible on screen. In this case
 106                         // we don't do elaborate search and we just return the forwarded
 107                         // DocIterator at its beginning.
 108                         if (I == data.end()) {
 109                                 it.top().pos() = 0;
 110                                 return it;
 111                         }
 112
 113                         Point o = I->second;
 114                         inset->cursorPos(c.bv(), it.top(), c.boundary(), xo, yo);
 115                         // Convert to absolute
 116                         xo += o.x_;
 117                         yo += o.y_;
 118                         double d = (x - xo) * (x - xo) + (y - yo) * (y - yo);
 119                         // '<=' in order to take the last possible position
 120                         // this is important for clicking behind \sum in e.g. '\sum_i a'
 121                         lyxerr[Debug::DEBUG] << "i: " << i << " d: " << d
 122                                 << " best: " << best_dist << endl;
 123                         if (d <= best_dist) {
 124                                 best_dist = d;
 125                                 result = it;
 126                         }
 127                         if (it == et)
 128                                 break;
 129                         it.forwardPos();
 130                 }
 131                 return result;
 132         }
 133
 134
 135         /// moves position closest to (x, y) in given box
 136         bool bruteFind(LCursor & cursor,
 137                 int x, int y, int xlow, int xhigh, int ylow, int yhigh)
 138         {
 139                 BOOST_ASSERT(!cursor.empty());
 140                 InsetBase & inset = cursor[0].inset();
 141                 BufferView & bv = cursor.bv();
 142
 143                 CoordCache::InnerParPosCache const & cache =
 144                         bv.coordCache().getParPos().find(cursor.bottom().text())->second;
 145                 // Get an iterator on the first paragraph in the cache
 146                 DocIterator it(inset);
 147                 it.push_back(CursorSlice(inset));
 148                 it.pit() = cache.begin()->first;
 149                 // Get an iterator after the last paragraph in the cache
 150                 DocIterator et(inset);
 151                 et.push_back(CursorSlice(inset));
 152                 et.pit() = boost::prior(cache.end())->first;
 153                 if (et.pit() >= et.lastpit())
 154                         et = doc_iterator_end(inset);
 155                 else
 156                         ++et.pit();
 157
 158                 double best_dist = std::numeric_limits<double>::max();;
 159                 DocIterator best_cursor = et;
 160
 161                 for ( ; it != et; it.forwardPos(true)) {
 162                         // avoid invalid nesting when selecting
 163                         if (!cursor.selection() || positionable(it, cursor.anchor_)) {
 164                                 Point p = bv_funcs::getPos(bv, it, false);
 165                                 int xo = p.x_;
 166                                 int yo = p.y_;
 167                                 if (xlow <= xo && xo <= xhigh && ylow <= yo && yo <= yhigh) {
 168                                         double const dx = xo - x;
 169                                         double const dy = yo - y;
 170                                         double const d = dx * dx + dy * dy;
 171                                         // '<=' in order to take the last possible position
 172                                         // this is important for clicking behind \sum in e.g. '\sum_i a'
 173                                         if (d <= best_dist) {
 174                                                 //      lyxerr << "*" << endl;
 175                                                 best_dist   = d;
 176                                                 best_cursor = it;
 177                                         }
 178                                 }
 179                         }
 180                 }
 181
 182                 if (best_cursor != et) {
 183                         cursor.setCursor(best_cursor);
 184                         return true;
 185                 }
 186
 187                 return false;
 188         }
 189
 190
 191         /// moves position closest to (x, y) in given box
 192         bool bruteFind3(LCursor & cur, int x, int y, bool up)
 193         {
 194                 BufferView & bv = cur.bv();
 195                 int ylow  = up ? 0 : y + 1;
 196                 int yhigh = up ? y - 1 : bv.workHeight();
 197                 int xlow = 0;
 198                 int xhigh = bv.workWidth();
 199
 200 // FIXME: bit more work needed to get 'from' and 'to' right.
 201                 pit_type from = cur.bottom().pit();
 202                 //pit_type to = cur.bottom().pit();
 203                 //lyxerr << "Pit start: " << from << endl;
 204
 205                 //lyxerr << "bruteFind3: x: " << x << " y: " << y
 206                 //      << " xlow: " << xlow << " xhigh: " << xhigh
 207                 //      << " ylow: " << ylow << " yhigh: " << yhigh
 208                 //      << endl;
 209                 InsetBase & inset = bv.buffer()->inset();
 210                 DocIterator it = doc_iterator_begin(inset);
 211                 it.pit() = from;
 212                 DocIterator et = doc_iterator_end(inset);
 213
 214                 double best_dist = std::numeric_limits<double>::max();
 215                 DocIterator best_cursor = et;
 216
 217                 for ( ; it != et; it.forwardPos()) {
 218                         // avoid invalid nesting when selecting
 219                         if (bv_funcs::status(&bv, it) == bv_funcs::CUR_INSIDE
 220                             && (!cur.selection() || positionable(it, cur.anchor_))) {
 221                                 Point p = bv_funcs::getPos(bv, it, false);
 222                                 int xo = p.x_;
 223                                 int yo = p.y_;
 224                                 if (xlow <= xo && xo <= xhigh && ylow <= yo && yo <= yhigh) {
 225                                         double const dx = xo - x;
 226                                         double const dy = yo - y;
 227                                         double const d = dx * dx + dy * dy;
 228                                         //lyxerr << "itx: " << xo << " ity: " << yo << " d: " << d
 229                                         //      << " dx: " << dx << " dy: " << dy
 230                                         //      << " idx: " << it.idx() << " pos: " << it.pos()
 231                                         //      << " it:\n" << it
 232                                         //      << endl;
 233                                         // '<=' in order to take the last possible position
 234                                         // this is important for clicking behind \sum in e.g. '\sum_i a'
 235                                         if (d <= best_dist) {
 236                                                 //lyxerr << "*" << endl;
 237                                                 best_dist   = d;
 238                                                 best_cursor = it;
 239                                         }
 240                                 }
 241                         }
 242                 }
 243
 244                 //lyxerr << "best_dist: " << best_dist << " cur:\n" << best_cursor << endl;
 245                 if (best_cursor == et)
 246                         return false;
 247                 cur.setCursor(best_cursor);
 248                 return true;
 249         }
 250
 251 } // namespace anon
 252
 253
 254 // be careful: this is called from the bv's constructor, too, so
 255 // bv functions are not yet available!
 256 LCursor::LCursor(BufferView & bv)
 257         : DocIterator(), bv_(&bv), anchor_(), x_target_(-1),
 258           selection_(false), mark_(false), logicalpos_(false)
 259 {}
 260
 261
 262 void LCursor::reset(InsetBase & inset)
 263 {
 264         clear();
 265         push_back(CursorSlice(inset));
 266         anchor_ = DocIterator(inset);
 267         clearTargetX();
 268         selection_ = false;
 269         mark_ = false;
 270 }
 271
 272
 273 // this (intentionally) does neither touch anchor nor selection status
 274 void LCursor::setCursor(DocIterator const & cur)
 275 {
 276         DocIterator::operator=(cur);
 277 }
 278
 279
 280 void LCursor::dispatch(FuncRequest const & cmd0)
 281 {
 282         lyxerr[Debug::DEBUG] << BOOST_CURRENT_FUNCTION
 283                              << " cmd: " << cmd0 << '\n'
 284                              << *this << endl;
 285         if (empty())
 286                 return;
 287
 288         fixIfBroken();
 289         FuncRequest cmd = cmd0;
 290         LCursor safe = *this;
 291
 292         for (; depth(); pop()) {
 293                 lyxerr[Debug::DEBUG] << "LCursor::dispatch: cmd: "
 294                         << cmd0 << endl << *this << endl;
 295                 BOOST_ASSERT(pos() <= lastpos());
 296                 BOOST_ASSERT(idx() <= lastidx());
 297                 BOOST_ASSERT(pit() <= lastpit());
 298
 299                 // The common case is 'LFUN handled, need update', so make the
 300                 // LFUN handler's life easier by assuming this as default value.
 301                 // The handler can reset the update and val flags if necessary.
 302                 disp_.update(Update::FitCursor | Update::Force);
 303                 disp_.dispatched(true);
 304                 inset().dispatch(*this, cmd);
 305                 if (disp_.dispatched())
 306                         break;
 307         }
 308         // it completely to get a 'bomb early' behaviour in case this
 309         // object will be used again.
 310         if (!disp_.dispatched()) {
 311                 lyxerr[Debug::DEBUG] << "RESTORING OLD CURSOR!" << endl;
 312                 operator=(safe);
 313                 disp_.update(Update::None);
 314                 disp_.dispatched(false);
 315         }
 316 }
 317
 318
 319 DispatchResult LCursor::result() const
 320 {
 321         return disp_;
 322 }
 323
 324
 325 BufferView & LCursor::bv() const
 326 {
 327         BOOST_ASSERT(bv_);
 328         return *bv_;
 329 }
 330
 331
 332 Buffer & LCursor::buffer() const
 333 {
 334         BOOST_ASSERT(bv_);
 335         BOOST_ASSERT(bv_->buffer());
 336         return *bv_->buffer();
 337 }
 338
 339
 340 void LCursor::pop()
 341 {
 342         BOOST_ASSERT(depth() >= 1);
 343         pop_back();
 344 }
 345
 346
 347 void LCursor::push(InsetBase & p)
 348 {
 349         push_back(CursorSlice(p));
 350 }
 351
 352
 353 void LCursor::pushLeft(InsetBase & p)
 354 {
 355         BOOST_ASSERT(!empty());
 356         //lyxerr << "Entering inset " << t << " left" << endl;
 357         push(p);
 358         p.idxFirst(*this);
 359 }
 360
 361
 362 bool LCursor::popLeft()
 363 {
 364         BOOST_ASSERT(!empty());
 365         //lyxerr << "Leaving inset to the left" << endl;
 366         inset().notifyCursorLeaves(*this);
 367         if (depth() == 1)
 368                 return false;
 369         pop();
 370         return true;
 371 }
 372
 373
 374 bool LCursor::popRight()
 375 {
 376         BOOST_ASSERT(!empty());
 377         //lyxerr << "Leaving inset to the right" << endl;
 378         const pos_type lp = (depth() > 1) ? (*this)[depth() - 2].lastpos() : 0;
 379         inset().notifyCursorLeaves(*this);
 380         if (depth() == 1)
 381                 return false;
 382         pop();
 383         pos() += lastpos() - lp + 1;
 384         return true;
 385 }
 386
 387
 388 int LCursor::currentMode()
 389 {
 390         BOOST_ASSERT(!empty());
 391         for (int i = depth() - 1; i >= 0; --i) {
 392                 int res = operator[](i).inset().currentMode();
 393                 if (res != InsetBase::UNDECIDED_MODE)
 394                         return res;
 395         }
 396         return InsetBase::TEXT_MODE;
 397 }
 398
 399
 400 void LCursor::getPos(int & x, int & y) const
 401 {
 402         Point p = bv_funcs::getPos(bv(), *this, boundary());
 403         x = p.x_;
 404         y = p.y_;
 405 }
 406
 407
 408 Row const & LCursor::textRow() const
 409 {
 410         ParagraphMetrics const & pm = bv().parMetrics(text(), pit());
 411         BOOST_ASSERT(!pm.rows().empty());
 412         return pm.getRow(pos(), boundary());
 413 }
 414
 415
 416 void LCursor::resetAnchor()
 417 {
 418         anchor_ = *this;
 419 }
 420
 421
 422
 423 bool LCursor::posLeft()
 424 {
 425         if (pos() == 0)
 426                 return false;
 427         --pos();
 428         return true;
 429 }
 430
 431
 432 bool LCursor::posRight()
 433 {
 434         if (pos() == lastpos())
 435                 return false;
 436         ++pos();
 437         return true;
 438 }
 439
 440
 441 CursorSlice LCursor::anchor() const
 442 {
 443         BOOST_ASSERT(anchor_.depth() >= depth());
 444         CursorSlice normal = anchor_[depth() - 1];
 445         if (depth() < anchor_.depth() && top() <= normal) {
 446                 // anchor is behind cursor -> move anchor behind the inset
 447                 ++normal.pos();
 448         }
 449         return normal;
 450 }
 451
 452
 453 CursorSlice LCursor::selBegin() const
 454 {
 455         if (!selection())
 456                 return top();
 457         return anchor() < top() ? anchor() : top();
 458 }
 459
 460
 461 CursorSlice LCursor::selEnd() const
 462 {
 463         if (!selection())
 464                 return top();
 465         return anchor() > top() ? anchor() : top();
 466 }
 467
 468
 469 DocIterator LCursor::selectionBegin() const
 470 {
 471         if (!selection())
 472                 return *this;
 473         DocIterator di = (anchor() < top() ? anchor_ : *this);
 474         di.resize(depth());
 475         return di;
 476 }
 477
 478
 479 DocIterator LCursor::selectionEnd() const
 480 {
 481         if (!selection())
 482                 return *this;
 483         DocIterator di = (anchor() > top() ? anchor_ : *this);
 484         if (di.depth() > depth()) {
 485                 di.resize(depth());
 486                 ++di.pos();
 487         }
 488         return di;
 489 }
 490
 491
 492 void LCursor::setSelection()
 493 {
 494         selection() = true;
 495         // A selection with no contents is not a selection
 496 #ifdef WITH_WARNINGS
 497 #warning doesnt look ok
 498 #endif
 499         if (pit() == anchor().pit() && pos() == anchor().pos())
 500                 selection() = false;
 501 }
 502
 503
 504 void LCursor::setSelection(DocIterator const & where, int n)
 505 {
 506         setCursor(where);
 507         selection() = true;
 508         anchor_ = where;
 509         pos() += n;
 510 }
 511
 512
 513 void LCursor::setSelection(DocIterator const & from,
 514                 DocIterator const & to)
 515 {
 516         setCursor(to);
 517         selection() = true;
 518         anchor_ = from;
 519 }
 520
 521
 522 void LCursor::clearSelection()
 523 {
 524         selection() = false;
 525         mark() = false;
 526         resetAnchor();
 527 }
 528
 529
 530 int & LCursor::x_target()
 531 {
 532         return x_target_;
 533 }
 534
 535
 536 int LCursor::x_target() const
 537 {
 538         return x_target_;
 539 }
 540
 541
 542 void LCursor::clearTargetX()
 543 {
 544         x_target_ = -1;
 545 }
 546
 547
 548
 549 void LCursor::info(odocstream & os) const
 550 {
 551         for (int i = 1, n = depth(); i < n; ++i) {
 552                 operator[](i).inset().infoize(os);
 553                 os << "  ";
 554         }
 555         if (pos() != 0) {
 556                 InsetBase const * inset = prevInset();
 557                 // prevInset() can return 0 in certain case.
 558                 if (inset)
 559                         prevInset()->infoize2(os);
 560         }
 561         // overwite old message
 562         os << "                    ";
 563 }
 564
 565
 566 bool LCursor::selHandle(bool sel)
 567 {
 568         //lyxerr << "LCursor::selHandle" << endl;
 569         if (sel == selection())
 570                 return false;
 571
 572         resetAnchor();
 573         selection() = sel;
 574         cap::saveSelection(*this);
 575         return true;
 576 }
 577
 578
 579 std::ostream & operator<<(std::ostream & os, LCursor const & cur)
 580 {
 581         os << "\n cursor:                                | anchor:\n";
 582         for (size_t i = 0, n = cur.depth(); i != n; ++i) {
 583                 os << " " << cur[i] << " | ";
 584                 if (i < cur.anchor_.depth())
 585                         os << cur.anchor_[i];
 586                 else
 587                         os << "-------------------------------";
 588                 os << "\n";
 589         }
 590         for (size_t i = cur.depth(), n = cur.anchor_.depth(); i < n; ++i) {
 591                 os << "------------------------------- | " << cur.anchor_[i] << "\n";
 592         }
 593         os << " selection: " << cur.selection_
 594            << " x_target: " << cur.x_target_ << endl;
 595         return os;
 596 }
 597
 598 } // namespace lyx
 599
 600
 601 ///////////////////////////////////////////////////////////////////
 602 //
 603 // The part below is the non-integrated rest of the original math
 604 // cursor. This should be either generalized for texted or moved
 605 // back to mathed (in most cases to InsetMathNest).
 606 //
 607 ///////////////////////////////////////////////////////////////////
 608
 609 #include "mathed/InsetMathChar.h"
 610 #include "mathed/InsetMathGrid.h"
 611 #include "mathed/InsetMathScript.h"
 612 #include "mathed/InsetMathUnknown.h"
 613 #include "mathed/MathFactory.h"
 614 #include "mathed/MathMacroArgument.h"
 615 #include "mathed/MathStream.h"
 616 #include "mathed/MathSupport.h"
 617
 618
 619 namespace lyx {
 620
 621 //#define FILEDEBUG 1
 622
 623
 624 bool LCursor::isInside(InsetBase const * p)
 625 {
 626         for (size_t i = 0; i != depth(); ++i)
 627                 if (&operator[](i).inset() == p)
 628                         return true;
 629         return false;
 630 }
 631
 632
 633 void LCursor::leaveInset(InsetBase const & inset)
 634 {
 635         for (size_t i = 0; i != depth(); ++i) {
 636                 if (&operator[](i).inset() == &inset) {
 637                         resize(i);
 638                         return;
 639                 }
 640         }
 641 }
 642
 643
 644 bool LCursor::openable(MathAtom const & t) const
 645 {
 646         if (!t->isActive())
 647                 return false;
 648
 649         if (t->lock())
 650                 return false;
 651
 652         if (!selection())
 653                 return true;
 654
 655         // we can't move into anything new during selection
 656         if (depth() >= anchor_.depth())
 657                 return false;
 658         if (!ptr_cmp(t.nucleus(), &anchor_[depth()].inset()))
 659                 return false;
 660
 661         return true;
 662 }
 663
 664
 665 void LCursor::setScreenPos(int x, int y)
 666 {
 667         x_target() = x;
 668         bruteFind(*this, x, y, 0, bv().workWidth(), 0, bv().workHeight());
 669 }
 670
 671
 672
 673 void LCursor::plainErase()
 674 {
 675         cell().erase(pos());
 676 }
 677
 678
 679 void LCursor::markInsert()
 680 {
 681         insert(char_type(0));
 682 }
 683
 684
 685 void LCursor::markErase()
 686 {
 687         cell().erase(pos());
 688 }
 689
 690
 691 void LCursor::plainInsert(MathAtom const & t)
 692 {
 693         cell().insert(pos(), t);
 694         ++pos();
 695 }
 696
 697
 698 void LCursor::insert(docstring const & str)
 699 {
 700         for_each(str.begin(), str.end(),
 701                  boost::bind(static_cast<void(LCursor::*)(char_type)>
 702                              (&LCursor::insert), this, _1));
 703 }
 704
 705
 706 void LCursor::insert(char_type c)
 707 {
 708         //lyxerr << "LCursor::insert char '" << c << "'" << endl;
 709         BOOST_ASSERT(!empty());
 710         if (inMathed()) {
 711                 cap::selClearOrDel(*this);
 712                 insert(new InsetMathChar(c));
 713         } else {
 714                 text()->insertChar(*this, c);
 715         }
 716 }
 717
 718
 719 void LCursor::insert(MathAtom const & t)
 720 {
 721         //lyxerr << "LCursor::insert MathAtom '" << t << "'" << endl;
 722         macroModeClose();
 723         cap::selClearOrDel(*this);
 724         plainInsert(t);
 725 }
 726
 727
 728 void LCursor::insert(InsetBase * inset)
 729 {
 730         if (inMathed())
 731                 insert(MathAtom(inset));
 732         else
 733                 text()->insertInset(*this, inset);
 734 }
 735
 736
 737 void LCursor::niceInsert(docstring const & t)
 738 {
 739         MathArray ar;
 740         asArray(t, ar);
 741         if (ar.size() == 1)
 742                 niceInsert(ar[0]);
 743         else
 744                 insert(ar);
 745 }
 746
 747
 748 void LCursor::niceInsert(MathAtom const & t)
 749 {
 750         macroModeClose();
 751         docstring const safe = cap::grabAndEraseSelection(*this);
 752         plainInsert(t);
 753         // enter the new inset and move the contents of the selection if possible
 754         if (t->isActive()) {
 755                 posLeft();
 756                 // be careful here: don't use 'pushLeft(t)' as this we need to
 757                 // push the clone, not the original
 758                 pushLeft(*nextInset());
 759                 // We may not use niceInsert here (recursion)
 760                 MathArray ar;
 761                 asArray(safe, ar);
 762                 insert(ar);
 763         }
 764 }
 765
 766
 767 void LCursor::insert(MathArray const & ar)
 768 {
 769         macroModeClose();
 770         if (selection())
 771                 cap::eraseSelection(*this);
 772         cell().insert(pos(), ar);
 773         pos() += ar.size();
 774 }
 775
 776
 777 bool LCursor::backspace()
 778 {
 779         autocorrect() = false;
 780
 781         if (selection()) {
 782                 cap::eraseSelection(*this);
 783                 return true;
 784         }
 785
 786         if (pos() == 0) {
 787                 // If empty cell, and not part of a big cell
 788                 if (lastpos() == 0 && inset().nargs() == 1) {
 789                         popLeft();
 790                         // Directly delete empty cell: [|[]] => [|]
 791                         if (inMathed()) {
 792                                 plainErase();
 793                                 resetAnchor();
 794                                 return true;
 795                         }
 796                         // [|], can not delete from inside
 797                         return false;
 798                 } else {
 799                         // move to left
 800                         popLeft();
 801                         return true;
 802                 }
 803         }
 804
 805         if (inMacroMode()) {
 806                 InsetMathUnknown * p = activeMacro();
 807                 if (p->name().size() > 1) {
 808                         p->setName(p->name().substr(0, p->name().size() - 1));
 809                         return true;
 810                 }
 811         }
 812
 813         if (pos() != 0 && prevAtom()->nargs() > 0) {
 814                 // let's require two backspaces for 'big stuff' and
 815                 // highlight on the first
 816                 resetAnchor();
 817                 selection() = true;
 818                 --pos();
 819         } else {
 820                 --pos();
 821                 plainErase();
 822         }
 823         return true;
 824 }
 825
 826
 827 bool LCursor::erase()
 828 {
 829         autocorrect() = false;
 830         if (inMacroMode())
 831                 return true;
 832
 833         if (selection()) {
 834                 cap::eraseSelection(*this);
 835                 return true;
 836         }
 837
 838         // delete empty cells if possible
 839         if (pos() == lastpos() && inset().idxDelete(idx()))
 840                 return true;
 841
 842         // special behaviour when in last position of cell
 843         if (pos() == lastpos()) {
 844                 bool one_cell = inset().nargs() == 1;
 845                 if (one_cell && lastpos() == 0) {
 846                         popLeft();
 847                         // Directly delete empty cell: [|[]] => [|]
 848                         if (inMathed()) {
 849                                 plainErase();
 850                                 resetAnchor();
 851                                 return true;
 852                         }
 853                         // [|], can not delete from inside
 854                         return false;
 855                 }
 856                 // remove markup
 857                 if (!one_cell)
 858                         inset().idxGlue(idx());
 859                 return true;
 860         }
 861
 862         // 'clever' UI hack: only erase large items if previously slected
 863         if (pos() != lastpos() && nextAtom()->nargs() > 0) {
 864                 resetAnchor();
 865                 selection() = true;
 866                 ++pos();
 867         } else {
 868                 plainErase();
 869         }
 870
 871         return true;
 872 }
 873
 874
 875 bool LCursor::up()
 876 {
 877         macroModeClose();
 878         DocIterator save = *this;
 879         if (goUpDown(true))
 880                 return true;
 881         setCursor(save);
 882         autocorrect() = false;
 883         return selection();
 884 }
 885
 886
 887 bool LCursor::down()
 888 {
 889         macroModeClose();
 890         DocIterator save = *this;
 891         if (goUpDown(false))
 892                 return true;
 893         setCursor(save);
 894         autocorrect() = false;
 895         return selection();
 896 }
 897
 898
 899 bool LCursor::macroModeClose()
 900 {
 901         if (!inMacroMode())
 902                 return false;
 903         InsetMathUnknown * p = activeMacro();
 904         p->finalize();
 905         docstring const s = p->name();
 906         --pos();
 907         cell().erase(pos());
 908
 909         // do nothing if the macro name is empty
 910         if (s == "\\")
 911                 return false;
 912
 913         // prevent entering of recursive macros
 914         // FIXME: this is only a weak attempt... only prevents immediate
 915         // recursion
 916         docstring const name = s.substr(1);
 917         InsetBase const * macro = innerInsetOfType(InsetBase::MATHMACRO_CODE);
 918         if (macro && macro->getInsetName() == name)
 919                 lyxerr << "can't enter recursive macro" << endl;
 920
 921         InsetMathNest * const in = inset().asInsetMath()->asNestInset();
 922         if (in && in->interpretString(*this, s))
 923                 return true;
 924         plainInsert(createInsetMath(name));
 925         return true;
 926 }
 927
 928
 929 docstring LCursor::macroName()
 930 {
 931         return inMacroMode() ? activeMacro()->name() : docstring();
 932 }
 933
 934
 935 void LCursor::handleNest(MathAtom const & a, int c)
 936 {
 937         //lyxerr << "LCursor::handleNest: " << c << endl;
 938         MathAtom t = a;
 939         asArray(cap::grabAndEraseSelection(*this), t.nucleus()->cell(c));
 940         insert(t);
 941         posLeft();
 942         pushLeft(*nextInset());
 943 }
 944
 945
 946 int LCursor::targetX() const
 947 {
 948         if (x_target() != -1)
 949                 return x_target();
 950         int x = 0;
 951         int y = 0;
 952         getPos(x, y);
 953         return x;
 954 }
 955
 956
 957 void LCursor::setTargetX()
 958 {
 959         int x;
 960         int y;
 961         getPos(x, y);
 962         x_target_ = x;
 963 }
 964
 965
 966 bool LCursor::inMacroMode() const
 967 {
 968         if (pos() == 0)
 969                 return false;
 970         InsetMathUnknown const * p = prevAtom()->asUnknownInset();
 971         return p && !p->final();
 972 }
 973
 974
 975 InsetMathUnknown * LCursor::activeMacro()
 976 {
 977         return inMacroMode() ? prevAtom().nucleus()->asUnknownInset() : 0;
 978 }
 979
 980
 981 void LCursor::pullArg()
 982 {
 983 #ifdef WITH_WARNINGS
 984 #warning Look here
 985 #endif
 986         MathArray ar = cell();
 987         if (popLeft() && inMathed()) {
 988                 plainErase();
 989                 cell().insert(pos(), ar);
 990                 resetAnchor();
 991         } else {
 992                 //formula()->mutateToText();
 993         }
 994 }
 995
 996
 997 void LCursor::touch()
 998 {
 999 #ifdef WITH_WARNINGS
1000 #warning look here
1001 #endif
1002 #if 0
1003         DocIterator::const_iterator it = begin();
1004         DocIterator::const_iterator et = end();
1005         for ( ; it != et; ++it)
1006                 it->cell().touch();
1007 #endif
1008 }
1009
1010
1011 void LCursor::normalize()
1012 {
1013         if (idx() > lastidx()) {
1014                 lyxerr << "this should not really happen - 1: "
1015                        << idx() << ' ' << nargs()
1016                        << " in: " << &inset() << endl;
1017                 idx() = lastidx();
1018         }
1019
1020         if (pos() > lastpos()) {
1021                 lyxerr << "this should not really happen - 2: "
1022                         << pos() << ' ' << lastpos() <<  " in idx: " << idx()
1023                        << " in atom: '";
1024                 odocstringstream os;
1025                 WriteStream wi(os, false, true);
1026                 inset().asInsetMath()->write(wi);
1027                 lyxerr << to_utf8(os.str()) << endl;
1028                 pos() = lastpos();
1029         }
1030 }
1031
1032
1033 bool LCursor::goUpDown(bool up)
1034 {
1035         // Be warned: The 'logic' implemented in this function is highly
1036         // fragile. A distance of one pixel or a '<' vs '<=' _really
1037         // matters. So fiddle around with it only if you think you know
1038         // what you are doing!
1039
1040         int xo = 0;
1041         int yo = 0;
1042         getPos(xo, yo);
1043
1044         // check if we had something else in mind, if not, this is the future
1045         // target
1046         if (x_target() == -1)
1047                 x_target() = xo;
1048         else
1049                 xo = x_target();
1050
1051         // try neigbouring script insets
1052         if (!selection()) {
1053                 // try left
1054                 if (pos() != 0) {
1055                         InsetMathScript const * p = prevAtom()->asScriptInset();
1056                         if (p && p->has(up)) {
1057                                 --pos();
1058                                 push(*const_cast<InsetMathScript*>(p));
1059                                 idx() = p->idxOfScript(up);
1060                                 pos() = lastpos();
1061                                 return true;
1062                         }
1063                 }
1064
1065                 // try right
1066                 if (pos() != lastpos()) {
1067                         InsetMathScript const * p = nextAtom()->asScriptInset();
1068                         if (p && p->has(up)) {
1069                                 push(*const_cast<InsetMathScript*>(p));
1070                                 idx() = p->idxOfScript(up);
1071                                 pos() = 0;
1072                                 return true;
1073                         }
1074                 }
1075         }
1076
1077 // FIXME: Switch this on for more robust movement
1078 #if 0
1079
1080         return bruteFind3(*this, xo, yo, up);
1081
1082 #else
1083         //xarray().boundingBox(xlow, xhigh, ylow, yhigh);
1084         //if (up)
1085         //      yhigh = yo - 4;
1086         //else
1087         //      ylow = yo + 4;
1088         //if (bruteFind(*this, xo, yo, xlow, xhigh, ylow, yhigh)) {
1089         //      lyxerr << "updown: handled by brute find in the same cell" << endl;
1090         //      return true;
1091         //}
1092
1093         // try to find an inset that knows better then we
1094         while (true) {
1095                 //lyxerr << "updown: We are in " << &inset() << " idx: " << idx() << endl;
1096                 // ask inset first
1097                 if (inset().idxUpDown(*this, up)) {
1098                         //lyxerr << "idxUpDown triggered" << endl;
1099                         // try to find best position within this inset
1100                         if (!selection())
1101                                 setCursor(bruteFind2(*this, xo, yo));
1102                         return true;
1103                 }
1104
1105                 // no such inset found, just take something "above"
1106                 if (!popLeft()) {
1107                         //lyxerr << "updown: popleft failed (strange case)" << endl;
1108                         int ylow  = up ? 0 : yo + 1;
1109                         int yhigh = up ? yo - 1 : bv().workHeight();
1110                         return bruteFind(*this, xo, yo, 0, bv().workWidth(), ylow, yhigh);
1111                 }
1112
1113                 // any improvement so far?
1114                 //lyxerr << "updown: popLeft succeeded" << endl;
1115                 int xnew;
1116                 int ynew;
1117                 getPos(xnew, ynew);
1118                 if (up ? ynew < yo : ynew > yo)
1119                         return true;
1120         }
1121
1122         // we should not come here.
1123         BOOST_ASSERT(false);
1124 #endif
1125 }
1126
1127
1128 void LCursor::handleFont(string const & font)
1129 {
1130         lyxerr[Debug::DEBUG] << BOOST_CURRENT_FUNCTION << ": " << font << endl;
1131         docstring safe;
1132         if (selection()) {
1133                 macroModeClose();
1134                 safe = cap::grabAndEraseSelection(*this);
1135         }
1136
1137         if (lastpos() != 0) {
1138                 // something left in the cell
1139                 if (pos() == 0) {
1140                         // cursor in first position
1141                         popLeft();
1142                 } else if (pos() == lastpos()) {
1143                         // cursor in last position
1144                         popRight();
1145                 } else {
1146                         // cursor in between. split cell
1147                         MathArray::iterator bt = cell().begin();
1148                         MathAtom at = createInsetMath(from_utf8(font));
1149                         at.nucleus()->cell(0) = MathArray(bt, bt + pos());
1150                         cell().erase(bt, bt + pos());
1151                         popLeft();
1152                         plainInsert(at);
1153                 }
1154         } else {
1155                 // nothing left in the cell
1156                 pullArg();
1157                 plainErase();
1158         }
1159         insert(safe);
1160 }
1161
1162
1163 void LCursor::message(docstring const & msg) const
1164 {
1165         theLyXFunc().setMessage(msg);
1166 }
1167
1168
1169 void LCursor::errorMessage(docstring const & msg) const
1170 {
1171         theLyXFunc().setErrorMessage(msg);
1172 }
1173
1174
1175 docstring LCursor::selectionAsString(bool label) const
1176 {
1177         if (!selection())
1178                 return docstring();
1179
1180         if (inTexted()) {
1181                 Buffer const & buffer = *bv().buffer();
1182                 ParagraphList const & pars = text()->paragraphs();
1183
1184                 // should be const ...
1185                 pit_type startpit = selBegin().pit();
1186                 pit_type endpit = selEnd().pit();
1187                 size_t const startpos = selBegin().pos();
1188                 size_t const endpos = selEnd().pos();
1189
1190                 if (startpit == endpit)
1191                         return pars[startpit].asString(buffer, startpos, endpos, label);
1192
1193                 // First paragraph in selection
1194                 docstring result = pars[startpit].
1195                         asString(buffer, startpos, pars[startpit].size(), label) + "\n\n";
1196
1197                 // The paragraphs in between (if any)
1198                 for (pit_type pit = startpit + 1; pit != endpit; ++pit) {
1199                         Paragraph const & par = pars[pit];
1200                         result += par.asString(buffer, 0, par.size(), label) + "\n\n";
1201                 }
1202
1203                 // Last paragraph in selection
1204                 result += pars[endpit].asString(buffer, 0, endpos, label);
1205
1206                 return result;
1207         }
1208
1209         if (inMathed())
1210                 return cap::grabSelection(*this);
1211
1212         return docstring();
1213 }
1214
1215
1216 docstring LCursor::currentState()
1217 {
1218         if (inMathed()) {
1219                 odocstringstream os;
1220                 info(os);
1221                 return os.str();
1222         }
1223
1224         if (inTexted())
1225                 return text()->currentState(*this);
1226
1227         return docstring();
1228 }
1229
1230
1231 docstring LCursor::getPossibleLabel()
1232 {
1233         return inMathed() ? from_ascii("eq:") : text()->getPossibleLabel(*this);
1234 }
1235
1236
1237 Encoding const * LCursor::getEncoding() const
1238 {
1239         if (empty())
1240                 return 0;
1241         if (!bv().buffer())
1242                 return 0;
1243         int s = 0;
1244         // go up until first non-0 text is hit
1245         // (innermost text is 0 in mathed)
1246         for (s = depth() - 1; s >= 0; --s)
1247                 if (operator[](s).text())
1248                         break;
1249         CursorSlice const & sl = operator[](s);
1250         LyXText const & text = *sl.text();
1251         LyXFont font = text.getPar(sl.pit()).getFont(
1252                 bv().buffer()->params(), sl.pos(), outerFont(sl.pit(), text.paragraphs()));
1253         return font.language()->encoding();
1254 }
1255
1256
1257 void LCursor::undispatched()
1258 {
1259         disp_.dispatched(false);
1260 }
1261
1262
1263 void LCursor::dispatched()
1264 {
1265         disp_.dispatched(true);
1266 }
1267
1268
1269 void LCursor::updateFlags(Update::flags f)
1270 {
1271         disp_.update(f);
1272 }
1273
1274
1275 void LCursor::noUpdate()
1276 {
1277         disp_.update(Update::None);
1278 }
1279
1280
1281 LyXFont LCursor::getFont() const
1282 {
1283         // HACK. far from being perfect...
1284         int s = 0;
1285         // go up until first non-0 text is hit
1286         // (innermost text is 0 in mathed)
1287         for (s = depth() - 1; s >= 0; --s)
1288                 if (operator[](s).text())
1289                         break;
1290         CursorSlice const & sl = operator[](s);
1291         LyXText const & text = *sl.text();
1292         LyXFont font = text.getPar(sl.pit()).getFont(
1293                 bv().buffer()->params(),
1294                 sl.pos(),
1295                 outerFont(sl.pit(), text.paragraphs()));
1296
1297         return font;
1298 }
1299
1300
1301 void LCursor::fixIfBroken()
1302 {
1303         // find out last good level
1304         LCursor copy = *this;
1305         size_t newdepth = depth();
1306         while (!copy.empty()) {
1307                 if (copy.idx() > copy.lastidx()) {
1308                         lyxerr << "wrong idx " << copy.idx()
1309                                << ", max is " << copy.lastidx()
1310                                << " at level " << copy.depth()
1311                                << ". Trying to correct this."  << endl;
1312                         newdepth = copy.depth() - 1;
1313                 }
1314                 else if (copy.pit() > copy.lastpit()) {
1315                         lyxerr << "wrong pit " << copy.pit()
1316                                << ", max is " << copy.lastpit()
1317                                << " at level " << copy.depth()
1318                                << ". Trying to correct this."  << endl;
1319                         newdepth = copy.depth() - 1;
1320                 }
1321                 else if (copy.pos() > copy.lastpos()) {
1322                         lyxerr << "wrong pos " << copy.pos()
1323                                << ", max is " << copy.lastpos()
1324                                << " at level " << copy.depth()
1325                                << ". Trying to correct this."  << endl;
1326                         newdepth = copy.depth() - 1;
1327                 }
1328                 copy.pop();
1329         }
1330         // shrink cursor to a size where everything is valid, possibly
1331         // leaving insets
1332         while (depth() > newdepth) {
1333                 pop();
1334                 lyxerr << "correcting cursor to level " << depth() << endl;
1335         }
1336 }
1337
1338
1339 } // namespace lyx