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