src/Cursor.cpp

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