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         /*
 136         /// moves position closest to (x, y) in given box
 137         bool bruteFind(Cursor & cursor,
 138                 int x, int y, int xlow, int xhigh, int ylow, int yhigh)
 139         {
 140                 BOOST_ASSERT(!cursor.empty());
 141                 Inset & inset = cursor[0].inset();
 142                 BufferView & bv = cursor.bv();
 143
 144                 CoordCache::InnerParPosCache const & cache =
 145                         bv.coordCache().getParPos().find(cursor.bottom().text())->second;
 146                 // Get an iterator on the first paragraph in the cache
 147                 DocIterator it(inset);
 148                 it.push_back(CursorSlice(inset));
 149                 it.pit() = cache.begin()->first;
 150                 // Get an iterator after the last paragraph in the cache
 151                 DocIterator et(inset);
 152                 et.push_back(CursorSlice(inset));
 153                 et.pit() = boost::prior(cache.end())->first;
 154                 if (et.pit() >= et.lastpit())
 155                         et = doc_iterator_end(inset);
 156                 else
 157                         ++et.pit();
 158
 159                 double best_dist = std::numeric_limits<double>::max();;
 160                 DocIterator best_cursor = et;
 161
 162                 for ( ; it != et; it.forwardPos(true)) {
 163                         // avoid invalid nesting when selecting
 164                         if (!cursor.selection() || positionable(it, cursor.anchor_)) {
 165                                 Point p = bv_funcs::getPos(bv, it, false);
 166                                 int xo = p.x_;
 167                                 int yo = p.y_;
 168                                 if (xlow <= xo && xo <= xhigh && ylow <= yo && yo <= yhigh) {
 169                                         double const dx = xo - x;
 170                                         double const dy = yo - y;
 171                                         double const d = dx * dx + dy * dy;
 172                                         // '<=' in order to take the last possible position
 173                                         // this is important for clicking behind \sum in e.g. '\sum_i a'
 174                                         if (d <= best_dist) {
 175                                                 //      lyxerr << "*" << endl;
 176                                                 best_dist   = d;
 177                                                 best_cursor = it;
 178                                         }
 179                                 }
 180                         }
 181                 }
 182
 183                 if (best_cursor != et) {
 184                         cursor.setCursor(best_cursor);
 185                         return true;
 186                 }
 187
 188                 return false;
 189         }
 190         */
 191
 192
 193         /// moves position closest to (x, y) in given box
 194         bool bruteFind3(Cursor & cur, int x, int y, bool up)
 195         {
 196                 BufferView & bv = cur.bv();
 197                 int ylow  = up ? 0 : y + 1;
 198                 int yhigh = up ? y - 1 : bv.workHeight();
 199                 int xlow = 0;
 200                 int xhigh = bv.workWidth();
 201
 202 // FIXME: bit more work needed to get 'from' and 'to' right.
 203                 pit_type from = cur.bottom().pit();
 204                 //pit_type to = cur.bottom().pit();
 205                 //lyxerr << "Pit start: " << from << endl;
 206
 207                 //lyxerr << "bruteFind3: x: " << x << " y: " << y
 208                 //      << " xlow: " << xlow << " xhigh: " << xhigh
 209                 //      << " ylow: " << ylow << " yhigh: " << yhigh
 210                 //      << endl;
 211                 Inset & inset = bv.buffer().inset();
 212                 DocIterator it = doc_iterator_begin(inset);
 213                 it.pit() = from;
 214                 DocIterator et = doc_iterator_end(inset);
 215
 216                 double best_dist = std::numeric_limits<double>::max();
 217                 DocIterator best_cursor = et;
 218
 219                 for ( ; it != et; it.forwardPos()) {
 220                         // avoid invalid nesting when selecting
 221                         if (bv_funcs::status(&bv, it) == bv_funcs::CUR_INSIDE
 222                             && (!cur.selection() || positionable(it, cur.anchor_))) {
 223                                 Point p = bv_funcs::getPos(bv, it, false);
 224                                 int xo = p.x_;
 225                                 int yo = p.y_;
 226                                 if (xlow <= xo && xo <= xhigh && ylow <= yo && yo <= yhigh) {
 227                                         double const dx = xo - x;
 228                                         double const dy = yo - y;
 229                                         double const d = dx * dx + dy * dy;
 230                                         //lyxerr << "itx: " << xo << " ity: " << yo << " d: " << d
 231                                         //      << " dx: " << dx << " dy: " << dy
 232                                         //      << " idx: " << it.idx() << " pos: " << it.pos()
 233                                         //      << " it:\n" << it
 234                                         //      << endl;
 235                                         // '<=' in order to take the last possible position
 236                                         // this is important for clicking behind \sum in e.g. '\sum_i a'
 237                                         if (d <= best_dist) {
 238                                                 //lyxerr << "*" << endl;
 239                                                 best_dist   = d;
 240                                                 best_cursor = it;
 241                                         }
 242                                 }
 243                         }
 244                 }
 245
 246                 //lyxerr << "best_dist: " << best_dist << " cur:\n" << best_cursor << endl;
 247                 if (best_cursor == et)
 248                         return false;
 249                 cur.setCursor(best_cursor);
 250                 return true;
 251         }
 252
 253         docstring parbreak(Paragraph const & par)
 254         {
 255                 odocstringstream ods;
 256                 ods << '\n';
 257                 // only add blank line if we're not in an ERT or Listings inset
 258                 if (par.ownerCode() != Inset::ERT_CODE
 259                     && par.ownerCode() != Inset::LISTINGS_CODE)
 260                         ods << '\n';
 261                 return ods.str();
 262         }
 263
 264 } // namespace anon
 265
 266
 267 // be careful: this is called from the bv's constructor, too, so
 268 // bv functions are not yet available!
 269 Cursor::Cursor(BufferView & bv)
 270         : DocIterator(), bv_(&bv), anchor_(), x_target_(-1), textTargetOffset_(0),
 271           selection_(false), mark_(false), logicalpos_(false), current_font(Font::ALL_INHERIT)
 272 {}
 273
 274
 275 void Cursor::reset(Inset & inset)
 276 {
 277         clear();
 278         push_back(CursorSlice(inset));
 279         anchor_ = DocIterator(inset);
 280         clearTargetX();
 281         selection_ = false;
 282         mark_ = false;
 283 }
 284
 285
 286 // this (intentionally) does neither touch anchor nor selection status
 287 void Cursor::setCursor(DocIterator const & cur)
 288 {
 289         DocIterator::operator=(cur);
 290 }
 291
 292
 293 void Cursor::dispatch(FuncRequest const & cmd0)
 294 {
 295         LYXERR(Debug::DEBUG) << BOOST_CURRENT_FUNCTION
 296                              << " cmd: " << cmd0 << '\n'
 297                              << *this << endl;
 298         if (empty())
 299                 return;
 300
 301         fixIfBroken();
 302         FuncRequest cmd = cmd0;
 303         Cursor safe = *this;
 304
 305         // store some values to be used inside of the handlers
 306         getPos(beforeDispX_, beforeDispY_);
 307         beforeDispatchCursor_ = *this;
 308         for (; depth(); pop()) {
 309                 LYXERR(Debug::DEBUG) << "Cursor::dispatch: cmd: "
 310                         << cmd0 << endl << *this << endl;
 311                 BOOST_ASSERT(pos() <= lastpos());
 312                 BOOST_ASSERT(idx() <= lastidx());
 313                 BOOST_ASSERT(pit() <= lastpit());
 314
 315                 // The common case is 'LFUN handled, need update', so make the
 316                 // LFUN handler's life easier by assuming this as default value.
 317                 // The handler can reset the update and val flags if necessary.
 318                 disp_.update(Update::FitCursor | Update::Force);
 319                 disp_.dispatched(true);
 320                 inset().dispatch(*this, cmd);
 321                 if (disp_.dispatched())
 322                         break;
 323         }
 324
 325         // it completely to get a 'bomb early' behaviour in case this
 326         // object will be used again.
 327         if (!disp_.dispatched()) {
 328                 LYXERR(Debug::DEBUG) << "RESTORING OLD CURSOR!" << endl;
 329                 operator=(safe);
 330                 disp_.update(Update::None);
 331                 disp_.dispatched(false);
 332         } else {
 333                 // restore the previous one because nested Cursor::dispatch calls
 334                 // are possible which would change it
 335                 beforeDispatchCursor_ = safe.beforeDispatchCursor_;
 336         }
 337 }
 338
 339
 340 DispatchResult Cursor::result() const
 341 {
 342         return disp_;
 343 }
 344
 345
 346 BufferView & Cursor::bv() const
 347 {
 348         BOOST_ASSERT(bv_);
 349         return *bv_;
 350 }
 351
 352
 353 Buffer & Cursor::buffer() const
 354 {
 355         BOOST_ASSERT(bv_);
 356         return bv_->buffer();
 357 }
 358
 359
 360 void Cursor::pop()
 361 {
 362         BOOST_ASSERT(depth() >= 1);
 363         pop_back();
 364 }
 365
 366
 367 void Cursor::push(Inset & p)
 368 {
 369         push_back(CursorSlice(p));
 370 }
 371
 372
 373 void Cursor::pushLeft(Inset & p)
 374 {
 375         BOOST_ASSERT(!empty());
 376         //lyxerr << "Entering inset " << t << " left" << endl;
 377         push(p);
 378         p.idxFirst(*this);
 379 }
 380
 381
 382 bool Cursor::popLeft()
 383 {
 384         BOOST_ASSERT(!empty());
 385         //lyxerr << "Leaving inset to the left" << endl;
 386         inset().notifyCursorLeaves(*this);
 387         if (depth() == 1)
 388                 return false;
 389         pop();
 390         return true;
 391 }
 392
 393
 394 bool Cursor::popRight()
 395 {
 396         BOOST_ASSERT(!empty());
 397         //lyxerr << "Leaving inset to the right" << endl;
 398         const pos_type lp = (depth() > 1) ? (*this)[depth() - 2].lastpos() : 0;
 399         inset().notifyCursorLeaves(*this);
 400         if (depth() == 1)
 401                 return false;
 402         pop();
 403         pos() += lastpos() - lp + 1;
 404         return true;
 405 }
 406
 407
 408 int Cursor::currentMode()
 409 {
 410         BOOST_ASSERT(!empty());
 411         for (int i = depth() - 1; i >= 0; --i) {
 412                 int res = operator[](i).inset().currentMode();
 413                 if (res != Inset::UNDECIDED_MODE)
 414                         return res;
 415         }
 416         return Inset::TEXT_MODE;
 417 }
 418
 419
 420 void Cursor::getPos(int & x, int & y) const
 421 {
 422         Point p = bv_funcs::getPos(bv(), *this, boundary());
 423         x = p.x_;
 424         y = p.y_;
 425 }
 426
 427
 428 Row const & Cursor::textRow() const
 429 {
 430         ParagraphMetrics const & pm = bv().parMetrics(text(), pit());
 431         BOOST_ASSERT(!pm.rows().empty());
 432         return pm.getRow(pos(), boundary());
 433 }
 434
 435
 436 void Cursor::resetAnchor()
 437 {
 438         anchor_ = *this;
 439 }
 440
 441
 442
 443 bool Cursor::posLeft()
 444 {
 445         if (pos() == 0)
 446                 return false;
 447         --pos();
 448         return true;
 449 }
 450
 451
 452 bool Cursor::posRight()
 453 {
 454         if (pos() == lastpos())
 455                 return false;
 456         ++pos();
 457         return true;
 458 }
 459
 460
 461 CursorSlice Cursor::anchor() const
 462 {
 463         BOOST_ASSERT(anchor_.depth() >= depth());
 464         CursorSlice normal = anchor_[depth() - 1];
 465         if (depth() < anchor_.depth() && top() <= normal) {
 466                 // anchor is behind cursor -> move anchor behind the inset
 467                 ++normal.pos();
 468         }
 469         return normal;
 470 }
 471
 472
 473 CursorSlice Cursor::selBegin() const
 474 {
 475         if (!selection())
 476                 return top();
 477         return anchor() < top() ? anchor() : top();
 478 }
 479
 480
 481 CursorSlice Cursor::selEnd() const
 482 {
 483         if (!selection())
 484                 return top();
 485         return anchor() > top() ? anchor() : top();
 486 }
 487
 488
 489 DocIterator Cursor::selectionBegin() const
 490 {
 491         if (!selection())
 492                 return *this;
 493         DocIterator di = (anchor() < top() ? anchor_ : *this);
 494         di.resize(depth());
 495         return di;
 496 }
 497
 498
 499 DocIterator Cursor::selectionEnd() const
 500 {
 501         if (!selection())
 502                 return *this;
 503         DocIterator di = (anchor() > top() ? anchor_ : *this);
 504         if (di.depth() > depth()) {
 505                 di.resize(depth());
 506                 ++di.pos();
 507         }
 508         return di;
 509 }
 510
 511
 512 void Cursor::setSelection()
 513 {
 514         selection() = true;
 515         // A selection with no contents is not a selection
 516         // FIXME: doesnt look ok
 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         // FIXME: Look here
1015         MathData ar = cell();
1016         if (popLeft() && inMathed()) {
1017                 plainErase();
1018                 cell().insert(pos(), ar);
1019                 resetAnchor();
1020         } else {
1021                 //formula()->mutateToText();
1022         }
1023 }
1024
1025
1026 void Cursor::touch()
1027 {
1028         // FIXME: look here
1029 #if 0
1030         DocIterator::const_iterator it = begin();
1031         DocIterator::const_iterator et = end();
1032         for ( ; it != et; ++it)
1033                 it->cell().touch();
1034 #endif
1035 }
1036
1037
1038 void Cursor::normalize()
1039 {
1040         if (idx() > lastidx()) {
1041                 lyxerr << "this should not really happen - 1: "
1042                        << idx() << ' ' << nargs()
1043                        << " in: " << &inset() << endl;
1044                 idx() = lastidx();
1045         }
1046
1047         if (pos() > lastpos()) {
1048                 lyxerr << "this should not really happen - 2: "
1049                         << pos() << ' ' << lastpos() <<  " in idx: " << idx()
1050                        << " in atom: '";
1051                 odocstringstream os;
1052                 WriteStream wi(os, false, true);
1053                 inset().asInsetMath()->write(wi);
1054                 lyxerr << to_utf8(os.str()) << endl;
1055                 pos() = lastpos();
1056         }
1057 }
1058
1059
1060 bool Cursor::upDownInMath(bool up)
1061 {
1062         // Be warned: The 'logic' implemented in this function is highly
1063         // fragile. A distance of one pixel or a '<' vs '<=' _really
1064         // matters. So fiddle around with it only if you think you know
1065         // what you are doing!
1066         int xo = 0;
1067         int yo = 0;
1068         getPos(xo, yo);
1069         xo = beforeDispX_;
1070
1071         // check if we had something else in mind, if not, this is the future
1072         // target
1073         if (x_target_ == -1)
1074                 setTargetX(xo);
1075         else if (inset().asTextInset() && xo - textTargetOffset() != x_target()) {
1076                 // In text mode inside the line (not left or right) possibly set a new target_x,
1077                 // but only if we are somewhere else than the previous target-offset.
1078
1079                 // We want to keep the x-target on subsequent up/down movements
1080                 // that cross beyond the end of short lines. Thus a special
1081                 // handling when the cursor is at the end of line: Use the new
1082                 // x-target only if the old one was before the end of line
1083                 // or the old one was after the beginning of the line
1084                 bool inRTL = isWithinRtlParagraph(*this);
1085                 bool left;
1086                 bool right;
1087                 if (inRTL) {
1088                         left = pos() == textRow().endpos();
1089                         right = pos() == textRow().pos();
1090                 } else {
1091                         left = pos() == textRow().pos();
1092                         right = pos() == textRow().endpos();
1093                 }
1094                 if ((!left && !right) ||
1095                                 (left && !right && xo < x_target_) ||
1096                                 (!left && right && x_target_ < xo))
1097                         setTargetX(xo);
1098                 else
1099                         xo = targetX();
1100         } else
1101                 xo = targetX();
1102
1103         // try neigbouring script insets
1104         Cursor old = *this;
1105         if (inMathed() && !selection()) {
1106                 // try left
1107                 if (pos() != 0) {
1108                         InsetMathScript const * p = prevAtom()->asScriptInset();
1109                         if (p && p->has(up)) {
1110                                 --pos();
1111                                 push(*const_cast<InsetMathScript*>(p));
1112                                 idx() = p->idxOfScript(up);
1113                                 pos() = lastpos();
1114
1115                                 // we went in the right direction? Otherwise don't jump into the script
1116                                 int x;
1117                                 int y;
1118                                 getPos(x, y);
1119                                 if ((!up && y <= beforeDispY_) ||
1120                                                 (up && y >= beforeDispY_))
1121                                         operator=(old);
1122                                 else
1123                                         return true;
1124                         }
1125                 }
1126
1127                 // try right
1128                 if (pos() != lastpos()) {
1129                         InsetMathScript const * p = nextAtom()->asScriptInset();
1130                         if (p && p->has(up)) {
1131                                 push(*const_cast<InsetMathScript*>(p));
1132                                 idx() = p->idxOfScript(up);
1133                                 pos() = 0;
1134
1135                                 // we went in the right direction? Otherwise don't jump into the script
1136                                 int x;
1137                                 int y;
1138                                 getPos(x, y);
1139                                 if ((!up && y <= beforeDispY_) ||
1140                                                 (up && y >= beforeDispY_))
1141                                         operator=(old);
1142                                 else
1143                                         return true;
1144                         }
1145                 }
1146         }
1147
1148         // try to find an inset that knows better then we,
1149         if (inset().idxUpDown(*this, up)) {
1150                 //lyxerr << "idxUpDown triggered" << endl;
1151                 // try to find best position within this inset
1152                 if (!selection())
1153                         setCursor(bruteFind2(*this, xo, yo));
1154                 return true;
1155         }
1156
1157         // any improvement going just out of inset?
1158         if (popLeft() && inMathed()) {
1159                 //lyxerr << "updown: popLeft succeeded" << endl;
1160                 int xnew;
1161                 int ynew;
1162                 getPos(xnew, ynew);
1163                 if (up ? ynew < beforeDispY_ : ynew > beforeDispY_)
1164                         return true;
1165         }
1166
1167         // no success, we are probably at the document top or bottom
1168         operator=(old);
1169         return false;
1170 }
1171
1172
1173 bool Cursor::upDownInText(bool up, bool & updateNeeded)
1174 {
1175         BOOST_ASSERT(text());
1176
1177         // where are we?
1178         int xo = 0;
1179         int yo = 0;
1180         getPos(xo, yo);
1181         xo = beforeDispX_;
1182
1183         // update the targetX - this is here before the "return false"
1184         // to set a new target which can be used by InsetTexts above
1185         // if we cannot move up/down inside this inset anymore
1186         if (x_target_ == -1)
1187                 setTargetX(xo);
1188         else if (xo - textTargetOffset() != x_target() &&
1189                                          depth() == beforeDispatchCursor_.depth()) {
1190                 // In text mode inside the line (not left or right) possibly set a new target_x,
1191                 // but only if we are somewhere else than the previous target-offset.
1192
1193                 // We want to keep the x-target on subsequent up/down movements
1194                 // that cross beyond the end of short lines. Thus a special
1195                 // handling when the cursor is at the end of line: Use the new
1196                 // x-target only if the old one was before the end of line
1197                 // or the old one was after the beginning of the line
1198                 bool inRTL = isWithinRtlParagraph(*this);
1199                 bool left;
1200                 bool right;
1201                 if (inRTL) {
1202                         left = pos() == textRow().endpos();
1203                         right = pos() == textRow().pos();
1204                 } else {
1205                         left = pos() == textRow().pos();
1206                         right = pos() == textRow().endpos();
1207                 }
1208                 if ((!left && !right) ||
1209                                 (left && !right && xo < x_target_) ||
1210                                 (!left && right && x_target_ < xo))
1211                         setTargetX(xo);
1212                 else
1213                         xo = targetX();
1214         } else
1215                 xo = targetX();
1216
1217         // first get the current line
1218         TextMetrics & tm = bv_->textMetrics(text());
1219         ParagraphMetrics const & pm = tm.parMetrics(pit());
1220         int row;
1221         if (pos() && boundary())
1222                 row = pm.pos2row(pos() - 1);
1223         else
1224                 row = pm.pos2row(pos());
1225
1226         // are we not at the start or end?
1227         if (up) {
1228                 if (pit() == 0 && row == 0)
1229                         return false;
1230         } else {
1231                 if (pit() + 1 >= int(text()->paragraphs().size()) &&
1232                                 row + 1 >= int(pm.rows().size()))
1233                         return false;
1234         }
1235
1236         // with and without selection are handled differently
1237         if (!selection()) {
1238                 int yo = bv_funcs::getPos(bv(), *this, boundary()).y_;
1239                 Cursor old = *this;
1240                 // To next/previous row
1241                 if (up)
1242                         tm.editXY(*this, xo, yo - textRow().ascent() - 1);
1243                 else
1244                         tm.editXY(*this, xo, yo + textRow().descent() + 1);
1245                 clearSelection();
1246
1247                 // This happens when you move out of an inset.
1248                 // And to give the DEPM the possibility of doing
1249                 // something we must provide it with two different
1250                 // cursors. (Lgb)
1251                 Cursor dummy = *this;
1252                 if (dummy == old)
1253                         ++dummy.pos();
1254                 if (bv().checkDepm(dummy, old)) {
1255                         updateNeeded = true;
1256                         // Make sure that cur gets back whatever happened to dummy(Lgb)
1257                         operator=(dummy);
1258                 }
1259         } else {
1260                 // if there is a selection, we stay out of any inset, and just jump to the right position:
1261                 Cursor old = *this;
1262                 if (up) {
1263                         if (row > 0) {
1264                                 top().pos() = std::min(tm.x2pos(pit(), row - 1, xo), top().lastpos());
1265                         } else if (pit() > 0) {
1266                                 --pit();
1267                                 ParagraphMetrics const & pmcur = bv_->parMetrics(text(), pit());
1268                                 top().pos() = std::min(tm.x2pos(pit(), pmcur.rows().size() - 1, xo), top().lastpos());
1269                         }
1270                 } else {
1271                         if (row + 1 < int(pm.rows().size())) {
1272                                 top().pos() = std::min(tm.x2pos(pit(), row + 1, xo), top().lastpos());
1273                         } else if (pit() + 1 < int(text()->paragraphs().size())) {
1274                                 ++pit();
1275                                 top().pos() = std::min(tm.x2pos(pit(), 0, xo), top().lastpos());
1276                         }
1277                 }
1278
1279                 updateNeeded |= bv().checkDepm(*this, old);
1280         }
1281
1282         updateTextTargetOffset();
1283         return true;
1284 }
1285
1286
1287 void Cursor::handleFont(string const & font)
1288 {
1289         LYXERR(Debug::DEBUG) << BOOST_CURRENT_FUNCTION << ": " << font << endl;
1290         docstring safe;
1291         if (selection()) {
1292                 macroModeClose();
1293                 safe = cap::grabAndEraseSelection(*this);
1294         }
1295
1296         if (lastpos() != 0) {
1297                 // something left in the cell
1298                 if (pos() == 0) {
1299                         // cursor in first position
1300                         popLeft();
1301                 } else if (pos() == lastpos()) {
1302                         // cursor in last position
1303                         popRight();
1304                 } else {
1305                         // cursor in between. split cell
1306                         MathData::iterator bt = cell().begin();
1307                         MathAtom at = createInsetMath(from_utf8(font));
1308                         at.nucleus()->cell(0) = MathData(bt, bt + pos());
1309                         cell().erase(bt, bt + pos());
1310                         popLeft();
1311                         plainInsert(at);
1312                 }
1313         } else {
1314                 // nothing left in the cell
1315                 pullArg();
1316                 plainErase();
1317         }
1318         insert(safe);
1319 }
1320
1321
1322 void Cursor::message(docstring const & msg) const
1323 {
1324         theLyXFunc().setMessage(msg);
1325 }
1326
1327
1328 void Cursor::errorMessage(docstring const & msg) const
1329 {
1330         theLyXFunc().setErrorMessage(msg);
1331 }
1332
1333
1334 docstring Cursor::selectionAsString(bool label) const
1335 {
1336         if (!selection())
1337                 return docstring();
1338
1339         if (inTexted()) {
1340                 Buffer const & buffer = bv().buffer();
1341                 ParagraphList const & pars = text()->paragraphs();
1342
1343                 // should be const ...
1344                 pit_type startpit = selBegin().pit();
1345                 pit_type endpit = selEnd().pit();
1346                 size_t const startpos = selBegin().pos();
1347                 size_t const endpos = selEnd().pos();
1348
1349                 if (startpit == endpit)
1350                         return pars[startpit].asString(buffer, startpos, endpos, label);
1351
1352                 // First paragraph in selection
1353                 docstring result = pars[startpit].
1354                         asString(buffer, startpos, pars[startpit].size(), label)
1355                                  + parbreak(pars[startpit]);
1356
1357                 // The paragraphs in between (if any)
1358                 for (pit_type pit = startpit + 1; pit != endpit; ++pit) {
1359                         Paragraph const & par = pars[pit];
1360                         result += par.asString(buffer, 0, par.size(), label)
1361                                   + parbreak(pars[pit]);
1362                 }
1363
1364                 // Last paragraph in selection
1365                 result += pars[endpit].asString(buffer, 0, endpos, label);
1366
1367                 return result;
1368         }
1369
1370         if (inMathed())
1371                 return cap::grabSelection(*this);
1372
1373         return docstring();
1374 }
1375
1376
1377 docstring Cursor::currentState()
1378 {
1379         if (inMathed()) {
1380                 odocstringstream os;
1381                 info(os);
1382                 return os.str();
1383         }
1384
1385         if (inTexted())
1386                 return text()->currentState(*this);
1387
1388         return docstring();
1389 }
1390
1391
1392 docstring Cursor::getPossibleLabel()
1393 {
1394         return inMathed() ? from_ascii("eq:") : text()->getPossibleLabel(*this);
1395 }
1396
1397
1398 Encoding const * Cursor::getEncoding() const
1399 {
1400         if (empty())
1401                 return 0;
1402         int s = 0;
1403         // go up until first non-0 text is hit
1404         // (innermost text is 0 in mathed)
1405         for (s = depth() - 1; s >= 0; --s)
1406                 if (operator[](s).text())
1407                         break;
1408         CursorSlice const & sl = operator[](s);
1409         Text const & text = *sl.text();
1410         Font font = text.getPar(sl.pit()).getFont(
1411                 bv().buffer().params(), sl.pos(), outerFont(sl.pit(), text.paragraphs()));
1412         return font.language()->encoding();
1413 }
1414
1415
1416 void Cursor::undispatched()
1417 {
1418         disp_.dispatched(false);
1419 }
1420
1421
1422 void Cursor::dispatched()
1423 {
1424         disp_.dispatched(true);
1425 }
1426
1427
1428 void Cursor::updateFlags(Update::flags f)
1429 {
1430         disp_.update(f);
1431 }
1432
1433
1434 void Cursor::noUpdate()
1435 {
1436         disp_.update(Update::None);
1437 }
1438
1439
1440 Font Cursor::getFont() const
1441 {
1442         // The logic here should more or less match to the Cursor::setCurrentFont
1443         // logic, i.e. the cursor height should give a hint what will happen
1444         // if a character is entered.
1445
1446         // HACK. far from being perfect...
1447         // go up until first non-0 text is hit
1448         // (innermost text is 0 in mathed)
1449         int s = 0;
1450         for (s = depth() - 1; s >= 0; --s)
1451                 if (operator[](s).text())
1452                         break;
1453         CursorSlice const & sl = operator[](s);
1454         Text const & text = *sl.text();
1455         Paragraph const & par = text.getPar(sl.pit());
1456
1457         // on boundary, so we are really at the character before
1458         pos_type pos = sl.pos();
1459         if (pos > 0 && boundary())
1460                 --pos;
1461
1462         // on space? Take the font before (only for RTL boundary stay)
1463         if (pos > 0) {
1464                 TextMetrics const & tm = bv().textMetrics(&text);
1465                 if (pos == sl.lastpos()
1466                         || (par.isSeparator(pos)
1467                         && !tm.isRTLBoundary(sl.pit(), 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 bool Cursor::fixIfBroken()
1480 {
1481         if (DocIterator::fixIfBroken()) {
1482                         clearSelection();
1483                         resetAnchor();
1484                         return true;
1485         }
1486         return false;
1487 }
1488
1489
1490 bool notifyCursorLeaves(DocIterator const & old, Cursor & cur)
1491 {
1492         // find inset in common
1493         size_type i;
1494         for (i = 0; i < old.depth() && i < cur.depth(); ++i) {
1495                 if (&old.inset() != &cur.inset())
1496                         break;
1497         }
1498
1499         // notify everything on top of the common part in old cursor,
1500         // but stop if the inset claims the cursor to be invalid now
1501         for (;  i < old.depth(); ++i) {
1502                 if (old[i].inset().notifyCursorLeaves(cur))
1503                         return true;
1504         }
1505
1506         return false;
1507 }
1508
1509
1510 void Cursor::setCurrentFont()
1511 {
1512         CursorSlice const & cs = innerTextSlice();
1513         Paragraph const & par = cs.paragraph();
1514         pos_type cpit = cs.pit();
1515         pos_type cpos = cs.pos();
1516         Text const & ctext = *cs.text();
1517         TextMetrics const & tm = bv().textMetrics(&ctext);
1518
1519         // are we behind previous char in fact? -> go to that char
1520         if (cpos > 0 && boundary())
1521                 --cpos;
1522
1523         // find position to take the font from
1524         if (cpos != 0) {
1525                 // paragraph end? -> font of last char
1526                 if (cpos == lastpos())
1527                         --cpos;
1528                 // on space? -> look at the words in front of space
1529                 else if (cpos > 0 && par.isSeparator(cpos))     {
1530                         // abc| def -> font of c
1531                         // abc |[WERBEH], i.e. boundary==true -> font of c
1532                         // abc [WERBEH]| def, font of the space
1533                         if (!tm.isRTLBoundary(cpit, cpos))
1534                                 --cpos;
1535                 }
1536         }
1537
1538         // get font
1539         BufferParams const & bufparams = buffer().params();
1540         current_font = par.getFontSettings(bufparams, cpos);
1541         real_current_font = tm.getDisplayFont(cpit, cpos);
1542
1543         // special case for paragraph end
1544         if (cs.pos() == lastpos()
1545             && tm.isRTLBoundary(cpit, cs.pos())
1546             && !boundary()) {
1547                 Language const * lang = par.getParLanguage(bufparams);
1548                 current_font.setLanguage(lang);
1549                 current_font.setNumber(Font::OFF);
1550                 real_current_font.setLanguage(lang);
1551                 real_current_font.setNumber(Font::OFF);
1552         }
1553 }
1554
1555 } // namespace lyx