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 Dov Feldstern
   9  * \author André Pönitz
  10  * \author Stefan Schimanski
  11  *
  12  * Full author contact details are available in file CREDITS.
  13  */
  14
  15 #include <config.h>
  16
  17 #include "Bidi.h"
  18 #include "Buffer.h"
  19 #include "BufferView.h"
  20 #include "CoordCache.h"
  21 #include "Cursor.h"
  22 #include "CutAndPaste.h"
  23 #include "DispatchResult.h"
  24 #include "Encoding.h"
  25 #include "Font.h"
  26 #include "FuncCode.h"
  27 #include "FuncRequest.h"
  28 #include "Language.h"
  29 #include "Layout.h"
  30 #include "LyXAction.h"
  31 #include "LyXRC.h"
  32 #include "Paragraph.h"
  33 #include "ParIterator.h"
  34 #include "Row.h"
  35 #include "Text.h"
  36 #include "TextMetrics.h"
  37 #include "TocBackend.h"
  38
  39 #include "support/debug.h"
  40 #include "support/docstream.h"
  41 #include "support/ExceptionMessage.h"
  42 #include "support/gettext.h"
  43 #include "support/lassert.h"
  44
  45 #include "insets/InsetTabular.h"
  46 #include "insets/InsetText.h"
  47
  48 #include "mathed/InsetMath.h"
  49 #include "mathed/InsetMathBrace.h"
  50 #include "mathed/InsetMathScript.h"
  51 #include "mathed/MacroTable.h"
  52 #include "mathed/MathData.h"
  53 #include "mathed/MathMacro.h"
  54
  55 #include "support/bind.h"
  56
  57 #include <sstream>
  58 #include <limits>
  59 #include <map>
  60 #include <algorithm>
  61
  62 using namespace std;
  63
  64 namespace lyx {
  65
  66 namespace {
  67
  68 // Find position closest to (x, y) in cell given by iter.
  69 // Used only in mathed
  70 DocIterator bruteFind2(Cursor const & c, int x, int y)
  71 {
  72         double best_dist = numeric_limits<double>::max();
  73
  74         DocIterator result;
  75
  76         DocIterator it = c;
  77         it.top().pos() = 0;
  78         DocIterator et = c;
  79         et.top().pos() = et.top().asInsetMath()->cell(et.top().idx()).size();
  80         for (size_t i = 0;; ++i) {
  81                 int xo;
  82                 int yo;
  83                 Inset const * inset = &it.inset();
  84                 CoordCache const & cache = c.bv().coordCache();
  85
  86                 // FIXME: in the case where the inset is not in the cache, this
  87                 // means that no part of it is visible on screen. In this case
  88                 // we don't do elaborate search and we just return the forwarded
  89                 // DocIterator at its beginning.
  90                 if (!cache.getInsets().has(inset)) {
  91                         it.top().pos() = 0;
  92                         return it;
  93                 }
  94
  95                 Point const o = cache.getInsets().xy(inset);
  96                 inset->cursorPos(c.bv(), it.top(), c.boundary(), xo, yo);
  97                 // Convert to absolute
  98                 xo += o.x_;
  99                 yo += o.y_;
 100                 double d = (x - xo) * (x - xo) + (y - yo) * (y - yo);
 101                 // '<=' in order to take the last possible position
 102                 // this is important for clicking behind \sum in e.g. '\sum_i a'
 103                 LYXERR(Debug::DEBUG, "i: " << i << " d: " << d
 104                         << " best: " << best_dist);
 105                 if (d <= best_dist) {
 106                         best_dist = d;
 107                         result = it;
 108                 }
 109                 if (it == et)
 110                         break;
 111                 it.forwardPos();
 112         }
 113         return result;
 114 }
 115
 116
 117 /*
 118 /// moves position closest to (x, y) in given box
 119 bool bruteFind(Cursor & cursor,
 120         int x, int y, int xlow, int xhigh, int ylow, int yhigh)
 121 {
 122         LASSERT(!cursor.empty(), return false);
 123         Inset & inset = cursor[0].inset();
 124         BufferView & bv = cursor.bv();
 125
 126         CoordCache::InnerParPosCache const & cache =
 127                 bv.coordCache().getParPos().find(cursor.bottom().text())->second;
 128         // Get an iterator on the first paragraph in the cache
 129         DocIterator it(inset);
 130         it.push_back(CursorSlice(inset));
 131         it.pit() = cache.begin()->first;
 132         // Get an iterator after the last paragraph in the cache
 133         DocIterator et(inset);
 134         et.push_back(CursorSlice(inset));
 135         et.pit() = prev(cache.end(), 1)->first;
 136         if (et.pit() >= et.lastpit())
 137                 et = doc_iterator_end(inset);
 138         else
 139                 ++et.pit();
 140
 141         double best_dist = numeric_limits<double>::max();
 142         DocIterator best_cursor = et;
 143
 144         for ( ; it != et; it.forwardPos(true)) {
 145                 // avoid invalid nesting when selecting
 146                 if (!cursor.selection() || positionable(it, cursor.anchor_)) {
 147                         Point p = bv.getPos(it, false);
 148                         int xo = p.x_;
 149                         int yo = p.y_;
 150                         if (xlow <= xo && xo <= xhigh && ylow <= yo && yo <= yhigh) {
 151                                 double const dx = xo - x;
 152                                 double const dy = yo - y;
 153                                 double const d = dx * dx + dy * dy;
 154                                 // '<=' in order to take the last possible position
 155                                 // this is important for clicking behind \sum in e.g. '\sum_i a'
 156                                 if (d <= best_dist) {
 157                                         //      lyxerr << "*" << endl;
 158                                         best_dist   = d;
 159                                         best_cursor = it;
 160                                 }
 161                         }
 162                 }
 163         }
 164
 165         if (best_cursor != et) {
 166                 cursor.setCursor(best_cursor);
 167                 return true;
 168         }
 169
 170         return false;
 171 }
 172 */
 173
 174 /*
 175 /// moves position closest to (x, y) in given box
 176 bool bruteFind3(Cursor & cur, int x, int y, bool up)
 177 {
 178         BufferView & bv = cur.bv();
 179         int ylow  = up ? 0 : y + 1;
 180         int yhigh = up ? y - 1 : bv.workHeight();
 181         int xlow = 0;
 182         int xhigh = bv.workWidth();
 183
 184 // FIXME: bit more work needed to get 'from' and 'to' right.
 185         pit_type from = cur.bottom().pit();
 186         //pit_type to = cur.bottom().pit();
 187         //lyxerr << "Pit start: " << from << endl;
 188
 189         //lyxerr << "bruteFind3: x: " << x << " y: " << y
 190         //      << " xlow: " << xlow << " xhigh: " << xhigh
 191         //      << " ylow: " << ylow << " yhigh: " << yhigh
 192         //      << endl;
 193         DocIterator it = doc_iterator_begin(cur.buffer());
 194         it.pit() = from;
 195         DocIterator et = doc_iterator_end(cur.buffer());
 196
 197         double best_dist = numeric_limits<double>::max();
 198         DocIterator best_cursor = et;
 199
 200         for ( ; it != et; it.forwardPos()) {
 201                 // avoid invalid nesting when selecting
 202                 if (bv.cursorStatus(it) == CUR_INSIDE
 203                     && (!cur.selection() || positionable(it, cur.realAnchor()))) {
 204                         // If this function is ever used again, check
 205                         // whether this is the same as "bv.getPos(it,
 206                         // false)" with boundary = false.
 207                         Point p = bv.getPos(it);
 208                         int xo = p.x_;
 209                         int yo = p.y_;
 210                         if (xlow <= xo && xo <= xhigh && ylow <= yo && yo <= yhigh) {
 211                                 double const dx = xo - x;
 212                                 double const dy = yo - y;
 213                                 double const d = dx * dx + dy * dy;
 214                                 //lyxerr << "itx: " << xo << " ity: " << yo << " d: " << d
 215                                 //      << " dx: " << dx << " dy: " << dy
 216                                 //      << " idx: " << it.idx() << " pos: " << it.pos()
 217                                 //      << " it:\n" << it
 218                                 //      << endl;
 219                                 // '<=' in order to take the last possible position
 220                                 // this is important for clicking behind \sum in e.g. '\sum_i a'
 221                                 if (d <= best_dist) {
 222                                         //lyxerr << "*" << endl;
 223                                         best_dist   = d;
 224                                         best_cursor = it;
 225                                 }
 226                         }
 227                 }
 228         }
 229
 230         //lyxerr << "best_dist: " << best_dist << " cur:\n" << best_cursor << endl;
 231         if (best_cursor == et)
 232                 return false;
 233         cur.setCursor(best_cursor);
 234         return true;
 235 }
 236 */
 237 } // namespace anon
 238
 239
 240 CursorData::CursorData()
 241         : DocIterator(), anchor_(),
 242           selection_(false), mark_(false), word_selection_(false),
 243           logicalpos_(false), current_font(inherit_font),
 244           autocorrect_(false), macromode_(false)
 245 {}
 246
 247
 248 CursorData::CursorData(Buffer * buffer)
 249         : DocIterator(buffer), anchor_(),
 250           selection_(false), mark_(false), word_selection_(false),
 251           logicalpos_(false), current_font(inherit_font),
 252           autocorrect_(false), macromode_(false)
 253 {}
 254
 255
 256 CursorData::CursorData(DocIterator const & dit)
 257         : DocIterator(dit), anchor_(),
 258           selection_(false), mark_(false), word_selection_(false),
 259           logicalpos_(false), current_font(inherit_font),
 260           autocorrect_(false), macromode_(false)
 261 {}
 262
 263
 264
 265
 266 ostream & operator<<(ostream & os, CursorData const & cur)
 267 {
 268         os << "\n cursor:                                | anchor:\n";
 269         for (size_t i = 0, n = cur.depth(); i != n; ++i) {
 270                 os << " " << cur[i] << " | ";
 271                 if (i < cur.anchor_.depth())
 272                         os << cur.anchor_[i];
 273                 else
 274                         os << "-------------------------------";
 275                 os << "\n";
 276         }
 277         for (size_t i = cur.depth(), n = cur.anchor_.depth(); i < n; ++i) {
 278                 os << "------------------------------- | " << cur.anchor_[i] << "\n";
 279         }
 280         os << " selection: " << cur.selection_
 281 //         << " x_target: " << cur.x_target_
 282            << " boundary: " << cur.boundary() << endl;
 283         return os;
 284 }
 285
 286
 287 LyXErr & operator<<(LyXErr & os, CursorData const & cur)
 288 {
 289         os.stream() << cur;
 290         return os;
 291 }
 292
 293
 294 // be careful: this is called from the bv's constructor, too, so
 295 // bv functions are not yet available!
 296 Cursor::Cursor(BufferView & bv)
 297         : CursorData(&bv.buffer()), bv_(&bv),
 298           x_target_(-1), textTargetOffset_(0),
 299           beforeDispatchPosX_(0), beforeDispatchPosY_(0)
 300 {}
 301
 302
 303 void Cursor::reset()
 304 {
 305         clear();
 306         push_back(CursorSlice(buffer()->inset()));
 307         anchor_ = doc_iterator_begin(buffer());
 308         anchor_.clear();
 309         new_word_ = doc_iterator_begin(buffer());
 310         new_word_.clear();
 311         clearTargetX();
 312         selection_ = false;
 313         mark_ = false;
 314 }
 315
 316
 317 // this (intentionally) does neither touch anchor nor selection status
 318 void Cursor::setCursor(DocIterator const & cur)
 319 {
 320         DocIterator::operator=(cur);
 321 }
 322
 323
 324 void Cursor::setCursorToAnchor()
 325 {
 326         if (selection()) {
 327                 DocIterator normal = anchor_;
 328                 while (depth() < normal.depth())
 329                         normal.pop_back();
 330                 if (depth() < anchor_.depth() && top() <= anchor_[depth() - 1])
 331                         ++normal.pos();
 332                 setCursor(normal);
 333         }
 334 }
 335
 336
 337 void Cursor::setCursorData(CursorData const & data)
 338 {
 339         CursorData::operator=(data);
 340 }
 341
 342
 343 bool Cursor::getStatus(FuncRequest const & cmd, FuncStatus & status) const
 344 {
 345         Cursor cur = *this;
 346
 347         // Try to fix cursor in case it is broken.
 348         cur.fixIfBroken();
 349
 350         // Is this a function that acts on inset at point?
 351         Inset * inset = cur.nextInset();
 352         if (lyxaction.funcHasFlag(cmd.action(), LyXAction::AtPoint)
 353             && inset && inset->getStatus(cur, cmd, status))
 354                 return true;
 355
 356         // This is, of course, a mess. Better create a new doc iterator and use
 357         // this in Inset::getStatus. This might require an additional
 358         // BufferView * arg, though (which should be avoided)
 359         //Cursor safe = *this;
 360         bool res = false;
 361         for ( ; cur.depth(); cur.pop()) {
 362                 //lyxerr << "\nCursor::getStatus: cmd: " << cmd << endl << *this << endl;
 363                 // LASSERT: Is it safe to continue here, or should we return?
 364                 LASSERT(cur.idx() <= cur.lastidx(), /**/);
 365                 LASSERT(cur.pit() <= cur.lastpit(), /**/);
 366                 LASSERT(cur.pos() <= cur.lastpos(), /**/);
 367
 368                 // The inset's getStatus() will return 'true' if it made
 369                 // a definitive decision on whether it want to handle the
 370                 // request or not. The result of this decision is put into
 371                 // the 'status' parameter.
 372                 if (cur.inset().getStatus(cur, cmd, status)) {
 373                         res = true;
 374                         break;
 375                 }
 376         }
 377         return res;
 378 }
 379
 380
 381 void Cursor::saveBeforeDispatchPosXY()
 382 {
 383         getPos(beforeDispatchPosX_, beforeDispatchPosY_);
 384 }
 385
 386
 387 void Cursor::dispatch(FuncRequest const & cmd0)
 388 {
 389         LYXERR(Debug::ACTION, "Cursor::dispatch: cmd: " << cmd0 << '\n' << *this);
 390         if (empty())
 391                 return;
 392
 393         fixIfBroken();
 394         FuncRequest cmd = cmd0;
 395         Cursor safe = *this;
 396         Cursor old = *this;
 397         disp_ = DispatchResult();
 398
 399         beginUndoGroup();
 400
 401         // Is this a function that acts on inset at point?
 402         if (lyxaction.funcHasFlag(cmd.action(), LyXAction::AtPoint)
 403             && nextInset()) {
 404                 disp_.dispatched(true);
 405                 disp_.screenUpdate(Update::FitCursor | Update::Force);
 406                 FuncRequest tmpcmd = cmd;
 407                 LYXERR(Debug::DEBUG, "Cursor::dispatch: (AtPoint) cmd: "
 408                         << cmd0 << endl << *this);
 409                 nextInset()->dispatch(*this, tmpcmd);
 410                 if (disp_.dispatched()) {
 411                         endUndoGroup();
 412                         return;
 413                 }
 414         }
 415
 416         // store some values to be used inside of the handlers
 417         beforeDispatchCursor_ = *this;
 418         for (; depth(); pop(), boundary(false)) {
 419                 LYXERR(Debug::DEBUG, "Cursor::dispatch: cmd: "
 420                         << cmd0 << endl << *this);
 421
 422                 // In any of these cases, the cursor is invalid, and we should
 423                 // try to save this document rather than crash.
 424                 LBUFERR(pos() <= lastpos());
 425                 LBUFERR(idx() <= lastidx());
 426                 LBUFERR(pit() <= lastpit());
 427
 428                 // The common case is 'LFUN handled, need update', so make the
 429                 // LFUN handler's life easier by assuming this as default value.
 430                 // The handler can reset the update and val flags if necessary.
 431                 disp_.screenUpdate(Update::FitCursor | Update::Force);
 432                 disp_.dispatched(true);
 433                 inset().dispatch(*this, cmd);
 434                 if (disp_.dispatched())
 435                         break;
 436         }
 437
 438         // it completely to get a 'bomb early' behaviour in case this
 439         // object will be used again.
 440         if (!disp_.dispatched()) {
 441                 LYXERR(Debug::DEBUG, "RESTORING OLD CURSOR!");
 442                 // We might have invalidated the cursor when removing an empty
 443                 // paragraph while the cursor could not be moved out the inset
 444                 // while we initially thought we could. This might happen when
 445                 // a multiline inset becomes an inline inset when the second
 446                 // paragraph is removed.
 447                 if (safe.pit() > safe.lastpit()) {
 448                         safe.pit() = safe.lastpit();
 449                         safe.pos() = safe.lastpos();
 450                 }
 451                 operator=(safe);
 452                 disp_.screenUpdate(Update::None);
 453                 disp_.dispatched(false);
 454         } else {
 455                 // restore the previous one because nested Cursor::dispatch calls
 456                 // are possible which would change it
 457                 beforeDispatchCursor_ = safe.beforeDispatchCursor_;
 458         }
 459         endUndoGroup();
 460
 461         // NOTE: The code below has been copied to BufferView::dispatch.
 462         // If you need to modify this, please update the other one too.
 463
 464         // notify insets we just left
 465         if (*this != old) {
 466                 old.beginUndoGroup();
 467                 old.fixIfBroken();
 468                 bool badcursor = notifyCursorLeavesOrEnters(old, *this);
 469                 if (badcursor) {
 470                         fixIfBroken();
 471                         bv().resetInlineCompletionPos();
 472                 }
 473                 old.endUndoGroup();
 474         }
 475 }
 476
 477
 478 DispatchResult const & Cursor::result() const
 479 {
 480         return disp_;
 481 }
 482
 483
 484 BufferView & Cursor::bv() const
 485 {
 486         LBUFERR(bv_);
 487         return *bv_;
 488 }
 489
 490
 491 void Cursor::pop()
 492 {
 493         LBUFERR(depth() >= 1);
 494         pop_back();
 495 }
 496
 497
 498 void Cursor::push(Inset & p)
 499 {
 500         push_back(CursorSlice(p));
 501         p.setBuffer(*buffer());
 502 }
 503
 504
 505 void Cursor::pushBackward(Inset & p)
 506 {
 507         LASSERT(!empty(), return);
 508         //lyxerr << "Entering inset " << t << " front" << endl;
 509         push(p);
 510         p.idxFirst(*this);
 511 }
 512
 513
 514 bool Cursor::popBackward()
 515 {
 516         LASSERT(!empty(), return false);
 517         if (depth() == 1)
 518                 return false;
 519         pop();
 520         return true;
 521 }
 522
 523
 524 bool Cursor::popForward()
 525 {
 526         LASSERT(!empty(), return false);
 527         //lyxerr << "Leaving inset from in back" << endl;
 528         const pos_type lp = (depth() > 1) ? (*this)[depth() - 2].lastpos() : 0;
 529         if (depth() == 1)
 530                 return false;
 531         pop();
 532         pos() += lastpos() - lp + 1;
 533         return true;
 534 }
 535
 536
 537 int Cursor::currentMode()
 538 {
 539         LASSERT(!empty(), return Inset::UNDECIDED_MODE);
 540         for (int i = depth() - 1; i >= 0; --i) {
 541                 int res = operator[](i).inset().currentMode();
 542                 bool locked_mode = operator[](i).inset().lockedMode();
 543                 // Also return UNDECIDED_MODE when the mode is locked,
 544                 // as in this case it is treated the same as TEXT_MODE
 545                 if (res != Inset::UNDECIDED_MODE || locked_mode)
 546                         return res;
 547         }
 548         return Inset::TEXT_MODE;
 549 }
 550
 551
 552 void Cursor::getPos(int & x, int & y) const
 553 {
 554         Point p = bv().getPos(*this);
 555         x = p.x_;
 556         y = p.y_;
 557 }
 558
 559
 560 Row const & Cursor::textRow() const
 561 {
 562         CursorSlice const & cs = innerTextSlice();
 563         ParagraphMetrics const & pm = bv().parMetrics(cs.text(), cs.pit());
 564         return pm.getRow(pos(), boundary());
 565 }
 566
 567
 568 void Cursor::resetAnchor()
 569 {
 570         anchor_ = *this;
 571         checkNewWordPosition();
 572 }
 573
 574
 575 void Cursor::markNewWordPosition()
 576 {
 577         if (lyxrc.spellcheck_continuously && inTexted() && new_word_.empty()) {
 578                 FontSpan nw = locateWord(WHOLE_WORD);
 579                 if (nw.size() == 1) {
 580                         LYXERR(Debug::DEBUG, "start new word: "
 581                                 << " par: " << pit()
 582                                 << " pos: " << nw.first);
 583                         new_word_ = *this;
 584                 }
 585         }
 586 }
 587
 588
 589 void Cursor::clearNewWordPosition()
 590 {
 591         if (!new_word_.empty()) {
 592                 LYXERR(Debug::DEBUG, "clear new word: "
 593                         << " par: " << pit()
 594                         << " pos: " << pos());
 595                 new_word_.resize(0);
 596         }
 597 }
 598
 599
 600 void Cursor::checkNewWordPosition()
 601 {
 602         if (!lyxrc.spellcheck_continuously || new_word_.empty())
 603                 return ;
 604         if (!inTexted())
 605                 clearNewWordPosition();
 606         else {
 607                 // forget the position of the current new word if
 608                 // 1) the paragraph changes or
 609                 // 2) the count of nested insets changes or
 610                 // 3) the cursor pos is out of paragraph bound
 611                 if (pit() != new_word_.pit() ||
 612                         depth() != new_word_.depth() ||
 613                         new_word_.pos() > new_word_.lastpos()) {
 614                         clearNewWordPosition();
 615                 } else if (new_word_.fixIfBroken())
 616                         // 4) or the remembered position was "broken"
 617                         clearNewWordPosition();
 618                 else {
 619                         FontSpan nw = locateWord(WHOLE_WORD);
 620                         if (!nw.empty()) {
 621                                 FontSpan ow = new_word_.locateWord(WHOLE_WORD);
 622                                 if (nw.intersect(ow).empty())
 623                                         clearNewWordPosition();
 624                                 else
 625                                         LYXERR(Debug::DEBUG, "new word: "
 626                                                    << " par: " << pit()
 627                                                    << " pos: " << nw.first << ".." << nw.last);
 628                         } else {
 629                                 clearNewWordPosition();
 630                         }
 631                 }
 632         }
 633 }
 634
 635
 636 bool Cursor::posBackward()
 637 {
 638         if (pos() == 0)
 639                 return false;
 640         --pos();
 641         return true;
 642 }
 643
 644
 645 bool Cursor::posForward()
 646 {
 647         if (pos() == lastpos())
 648                 return false;
 649         ++pos();
 650         return true;
 651 }
 652
 653
 654 bool Cursor::posVisRight(bool skip_inset)
 655 {
 656         Cursor new_cur = *this; // where we will move to
 657         pos_type left_pos; // position visually left of current cursor
 658         pos_type right_pos; // position visually right of current cursor
 659
 660         getSurroundingPos(left_pos, right_pos);
 661
 662         LYXERR(Debug::RTL, left_pos <<"|"<< right_pos << " (pos: "<< pos() <<")");
 663
 664         // Are we at an inset?
 665         new_cur.pos() = right_pos;
 666         new_cur.boundary(false);
 667         if (!skip_inset &&
 668                 text()->checkAndActivateInsetVisual(new_cur, right_pos >= pos(), false)) {
 669                 // we actually move the cursor at the end of this
 670                 // function, for now we just keep track of the new
 671                 // position in new_cur...
 672                 LYXERR(Debug::RTL, "entering inset at: " << new_cur.pos());
 673         }
 674
 675         // Are we already at rightmost pos in row?
 676         else if (text()->empty() || right_pos == -1) {
 677
 678                 new_cur = *this;
 679                 if (!new_cur.posVisToNewRow(false)) {
 680                         LYXERR(Debug::RTL, "not moving!");
 681                         return false;
 682                 }
 683
 684                 // we actually move the cursor at the end of this
 685                 // function, for now just keep track of the new
 686                 // position in new_cur...
 687                 LYXERR(Debug::RTL, "right edge, moving: " << int(new_cur.pit()) << ","
 688                         << int(new_cur.pos()) << "," << (new_cur.boundary() ? 1 : 0));
 689
 690         }
 691         // normal movement to the right
 692         else {
 693                 new_cur = *this;
 694                 // Recall, if the cursor is at position 'x', that
 695                 // means *before* the character at position 'x'. In
 696                 // RTL, "before" means "to the right of", in LTR, "to
 697                 // the left of". So currently our situation is this:
 698                 // the position to our right is 'right_pos' (i.e.,
 699                 // we're currently to the left of 'right_pos'). In
 700                 // order to move to the right, it depends whether or
 701                 // not the character at 'right_pos' is RTL.
 702                 bool const new_pos_is_RTL = paragraph().getFontSettings(
 703                         buffer()->params(), right_pos).isVisibleRightToLeft();
 704                 // If the character at 'right_pos' *is* LTR, then in
 705                 // order to move to the right of it, we need to be
 706                 // *after* 'right_pos', i.e., move to position
 707                 // 'right_pos' + 1.
 708                 if (!new_pos_is_RTL) {
 709                         new_cur.pos() = right_pos + 1;
 710                         // set the boundary to true in two situations:
 711                         if (
 712                         // 1. if new_pos is now lastpos, and we're in
 713                         // an RTL paragraph (this means that we're
 714                         // moving right to the end of an LTR chunk
 715                         // which is at the end of an RTL paragraph);
 716                                 (new_cur.pos() == lastpos()
 717                                  && paragraph().isRTL(buffer()->params()))
 718                         // 2. if the position *after* right_pos is RTL
 719                         // (we want to be *after* right_pos, not
 720                         // before right_pos + 1!)
 721                                 || paragraph().getFontSettings(buffer()->params(),
 722                                                 new_cur.pos()).isVisibleRightToLeft()
 723                         )
 724                                 new_cur.boundary(true);
 725                         else // set the boundary to false
 726                                 new_cur.boundary(false);
 727                 }
 728                 // Otherwise (if the character at position 'right_pos'
 729                 // is RTL), then moving to the right of it is as easy
 730                 // as setting the new position to 'right_pos'.
 731                 else {
 732                         new_cur.pos() = right_pos;
 733                         new_cur.boundary(false);
 734                 }
 735
 736         }
 737
 738         bool moved = (new_cur.pos() != pos()
 739                                   || new_cur.pit() != pit()
 740                                   || new_cur.boundary() != boundary()
 741                                   || &new_cur.inset() != &inset());
 742
 743         if (moved) {
 744                 LYXERR(Debug::RTL, "moving to: " << new_cur.pos()
 745                         << (new_cur.boundary() ? " (boundary)" : ""));
 746                 *this = new_cur;
 747         }
 748
 749         return moved;
 750 }
 751
 752
 753 bool Cursor::posVisLeft(bool skip_inset)
 754 {
 755         Cursor new_cur = *this; // where we will move to
 756         pos_type left_pos; // position visually left of current cursor
 757         pos_type right_pos; // position visually right of current cursor
 758
 759         getSurroundingPos(left_pos, right_pos);
 760
 761         LYXERR(Debug::RTL, left_pos <<"|"<< right_pos << " (pos: "<< pos() <<")");
 762
 763         // Are we at an inset?
 764         new_cur.pos() = left_pos;
 765         new_cur.boundary(false);
 766         if (!skip_inset &&
 767                 text()->checkAndActivateInsetVisual(new_cur, left_pos >= pos(), true)) {
 768                 // we actually move the cursor at the end of this
 769                 // function, for now we just keep track of the new
 770                 // position in new_cur...
 771                 LYXERR(Debug::RTL, "entering inset at: " << new_cur.pos());
 772         }
 773
 774         // Are we already at leftmost pos in row?
 775         else if (text()->empty() || left_pos == -1) {
 776
 777                 new_cur = *this;
 778                 if (!new_cur.posVisToNewRow(true)) {
 779                         LYXERR(Debug::RTL, "not moving!");
 780                         return false;
 781                 }
 782
 783                 // we actually move the cursor at the end of this
 784                 // function, for now just keep track of the new
 785                 // position in new_cur...
 786                 LYXERR(Debug::RTL, "left edge, moving: " << int(new_cur.pit()) << ","
 787                         << int(new_cur.pos()) << "," << (new_cur.boundary() ? 1 : 0));
 788
 789         }
 790         // normal movement to the left
 791         else {
 792                 new_cur = *this;
 793                 // Recall, if the cursor is at position 'x', that
 794                 // means *before* the character at position 'x'. In
 795                 // RTL, "before" means "to the right of", in LTR, "to
 796                 // the left of". So currently our situation is this:
 797                 // the position to our left is 'left_pos' (i.e., we're
 798                 // currently to the right of 'left_pos'). In order to
 799                 // move to the left, it depends whether or not the
 800                 // character at 'left_pos' is RTL.
 801                 bool const new_pos_is_RTL = paragraph().getFontSettings(
 802                         buffer()->params(), left_pos).isVisibleRightToLeft();
 803                 // If the character at 'left_pos' *is* RTL, then in
 804                 // order to move to the left of it, we need to be
 805                 // *after* 'left_pos', i.e., move to position
 806                 // 'left_pos' + 1.
 807                 if (new_pos_is_RTL) {
 808                         new_cur.pos() = left_pos + 1;
 809                         // set the boundary to true in two situations:
 810                         if (
 811                         // 1. if new_pos is now lastpos and we're in
 812                         // an LTR paragraph (this means that we're
 813                         // moving left to the end of an RTL chunk
 814                         // which is at the end of an LTR paragraph);
 815                                 (new_cur.pos() == lastpos()
 816                                  && !paragraph().isRTL(buffer()->params()))
 817                         // 2. if the position *after* left_pos is not
 818                         // RTL (we want to be *after* left_pos, not
 819                         // before left_pos + 1!)
 820                                 || !paragraph().getFontSettings(buffer()->params(),
 821                                                 new_cur.pos()).isVisibleRightToLeft()
 822                         )
 823                                 new_cur.boundary(true);
 824                         else // set the boundary to false
 825                                 new_cur.boundary(false);
 826                 }
 827                 // Otherwise (if the character at position 'left_pos'
 828                 // is LTR), then moving to the left of it is as easy
 829                 // as setting the new position to 'left_pos'.
 830                 else {
 831                         new_cur.pos() = left_pos;
 832                         new_cur.boundary(false);
 833                 }
 834
 835         }
 836
 837         bool moved = (new_cur.pos() != pos()
 838                                   || new_cur.pit() != pit()
 839                                   || new_cur.boundary() != boundary());
 840
 841         if (moved) {
 842                 LYXERR(Debug::RTL, "moving to: " << new_cur.pos()
 843                         << (new_cur.boundary() ? " (boundary)" : ""));
 844                 *this = new_cur;
 845         }
 846
 847         return moved;
 848 }
 849
 850
 851 void Cursor::getSurroundingPos(pos_type & left_pos, pos_type & right_pos)
 852 {
 853         // preparing bidi tables
 854         Paragraph const & par = paragraph();
 855         Buffer const & buf = *buffer();
 856         Row const & row = textRow();
 857         Bidi bidi;
 858         bidi.computeTables(par, buf, row);
 859
 860         LYXERR(Debug::RTL, "bidi: " << row.pos() << "--" << row.endpos());
 861
 862         // The cursor is painted *before* the character at pos(), or,
 863         // if 'boundary' is true, *after* the character at (pos() -
 864         // 1). So we already have one known position around the
 865         // cursor:
 866         pos_type const known_pos = boundary() && pos() > 0 ? pos() - 1 : pos();
 867
 868         // edge case: if we're at the end of the paragraph, things are
 869         // a little different (because lastpos is a position which
 870         // does not really "exist" --- there's no character there
 871         // yet).
 872         if (known_pos == lastpos()) {
 873                 if (par.isRTL(buf.params())) {
 874                         left_pos = -1;
 875                         right_pos = bidi.vis2log(row.pos());
 876                 } else {
 877                         // LTR paragraph
 878                         right_pos = -1;
 879                         left_pos = bidi.vis2log(row.endpos() - 1);
 880                 }
 881                 return;
 882         }
 883
 884         // Whether 'known_pos' is to the left or to the right of the
 885         // cursor depends on whether it is an RTL or LTR character...
 886         bool const cur_is_RTL =
 887                 par.getFontSettings(buf.params(), known_pos).isVisibleRightToLeft();
 888         // ... in the following manner:
 889         // For an RTL character, "before"
 890         // means "to the right" and "after" means "to the left"; and
 891         // for LTR, it's the reverse. So, 'known_pos' is to the right
 892         // of the cursor if (RTL && boundary) or (!RTL && !boundary):
 893         bool const known_pos_on_right = cur_is_RTL == boundary();
 894
 895         // So we now know one of the positions surrounding the cursor.
 896         // Let's determine the other one:
 897         if (known_pos_on_right) {
 898                 right_pos = known_pos;
 899                 // *visual* position of 'left_pos':
 900                 pos_type v_left_pos = bidi.log2vis(right_pos) - 1;
 901                 // If the position we just identified as 'left_pos' is
 902                 // a "skipped separator" (a separator which is at the
 903                 // logical end of a row, except for the last row in a
 904                 // paragraph; such separators are not painted, so they
 905                 // "are not really there"; note that in bidi text,
 906                 // such a separator could appear visually in the
 907                 // middle of a row), set 'left_pos' to the *next*
 908                 // position to the left.
 909                 if (bidi.inRange(v_left_pos)
 910                                 && bidi.vis2log(v_left_pos) + 1 == row.endpos()
 911                                 && row.endpos() < lastpos()
 912                                 && par.isSeparator(bidi.vis2log(v_left_pos)))
 913                         --v_left_pos;
 914
 915                 // calculate the logical position of 'left_pos', if in row
 916                 if (!bidi.inRange(v_left_pos))
 917                         left_pos = -1;
 918                 else
 919                         left_pos = bidi.vis2log(v_left_pos);
 920                 // If the position we identified as 'right_pos' is a
 921                 // "skipped separator", set 'right_pos' to the *next*
 922                 // position to the right.
 923                 if (right_pos + 1 == row.endpos() && row.endpos() < lastpos()
 924                                 && par.isSeparator(right_pos)) {
 925                         pos_type const v_right_pos = bidi.log2vis(right_pos) + 1;
 926                         if (!bidi.inRange(v_right_pos))
 927                                 right_pos = -1;
 928                         else
 929                                 right_pos = bidi.vis2log(v_right_pos);
 930                 }
 931         } else {
 932                 // known_pos is on the left
 933                 left_pos = known_pos;
 934                 // *visual* position of 'right_pos'
 935                 pos_type v_right_pos = bidi.log2vis(left_pos) + 1;
 936                 // If the position we just identified as 'right_pos'
 937                 // is a "skipped separator", set 'right_pos' to the
 938                 // *next* position to the right.
 939                 if (bidi.inRange(v_right_pos)
 940                                 && bidi.vis2log(v_right_pos) + 1 == row.endpos()
 941                                 && row.endpos() < lastpos()
 942                                 && par.isSeparator(bidi.vis2log(v_right_pos)))
 943                         ++v_right_pos;
 944
 945                 // calculate the logical position of 'right_pos', if in row
 946                 if (!bidi.inRange(v_right_pos))
 947                         right_pos = -1;
 948                 else
 949                         right_pos = bidi.vis2log(v_right_pos);
 950                 // If the position we identified as 'left_pos' is a
 951                 // "skipped separator", set 'left_pos' to the *next*
 952                 // position to the left.
 953                 if (left_pos + 1 == row.endpos() && row.endpos() < lastpos()
 954                                 && par.isSeparator(left_pos)) {
 955                         pos_type const v_left_pos = bidi.log2vis(left_pos) - 1;
 956                         if (!bidi.inRange(v_left_pos))
 957                                 left_pos = -1;
 958                         else
 959                                 left_pos = bidi.vis2log(v_left_pos);
 960                 }
 961         }
 962         return;
 963 }
 964
 965
 966 bool Cursor::posVisToNewRow(bool movingLeft)
 967 {
 968         Paragraph const & par = paragraph();
 969         Buffer const & buf = *buffer();
 970         Row const & row = textRow();
 971         bool par_is_LTR = !par.isRTL(buf.params());
 972
 973         // Inside a table, determining whether to move to the next or
 974         // previous row should be done based on the table's direction.
 975         int s = depth() - 1;
 976         if (s >= 1 && (*this)[s].inset().asInsetTabular()) {
 977                 par_is_LTR = !(*this)[s].inset().asInsetTabular()->isRightToLeft(*this);
 978                 LYXERR(Debug::RTL, "Inside table! par_is_LTR=" << (par_is_LTR ? 1 : 0));
 979         }
 980
 981         // if moving left in an LTR paragraph or moving right in an
 982         // RTL one, move to previous row
 983         if (par_is_LTR == movingLeft) {
 984                 if (row.pos() == 0) { // we're at first row in paragraph
 985                         if (pit() == 0) // no previous paragraph! don't move
 986                                 return false;
 987                         // move to last pos in previous par
 988                         --pit();
 989                         pos() = lastpos();
 990                         boundary(false);
 991                 } else { // move to previous row in this par
 992                         pos() = row.pos() - 1; // this is guaranteed to be in previous row
 993                         boundary(false);
 994                 }
 995         }
 996         // if moving left in an RTL paragraph or moving right in an
 997         // LTR one, move to next row
 998         else {
 999                 if (row.endpos() == lastpos()) { // we're at last row in paragraph
1000                         if (pit() == lastpit()) // last paragraph! don't move
1001                                 return false;
1002                         // move to first row in next par
1003                         ++pit();
1004                         pos() = 0;
1005                         boundary(false);
1006                 } else { // move to next row in this par
1007                         pos() = row.endpos();
1008                         boundary(false);
1009                 }
1010         }
1011
1012         // make sure we're at left-/right-most pos in new row
1013         posVisToRowExtremity(!movingLeft);
1014
1015         return true;
1016 }
1017
1018
1019 void Cursor::posVisToRowExtremity(bool left)
1020 {
1021         LYXERR(Debug::RTL, "entering extremity: " << pit() << "," << pos() << ","
1022                 << (boundary() ? 1 : 0));
1023
1024         TextMetrics const & tm = bv_->textMetrics(text());
1025         // Looking for extremities is like clicking on the left or the
1026         // right of the row.
1027         int x = tm.origin().x_ + (left ? 0 : textRow().width());
1028         bool b = false;
1029         pos() = tm.getPosNearX(textRow(), x, b);
1030         boundary(b);
1031
1032         LYXERR(Debug::RTL, "leaving extremity: " << pit() << "," << pos() << ","
1033                 << (boundary() ? 1 : 0));
1034 }
1035
1036
1037 bool Cursor::reverseDirectionNeeded() const
1038 {
1039         /*
1040          * We determine the directions based on the direction of the
1041          * bottom() --- i.e., outermost --- paragraph, because that is
1042          * the only way to achieve consistency of the arrow's movements
1043          * within a paragraph, and thus avoid situations in which the
1044          * cursor gets stuck.
1045          */
1046         return bottom().paragraph().isRTL(bv().buffer().params());
1047 }
1048
1049
1050 CursorSlice Cursor::normalAnchor() const
1051 {
1052         if (!selection())
1053                 return top();
1054         // LASSERT: There have been several bugs around this code, that seem
1055         // to involve failures to reset the anchor. We can at least not crash
1056         // in release mode by resetting it ourselves.
1057         LASSERT(anchor_.depth() >= depth(),
1058                 const_cast<DocIterator &>(anchor_) = *this);
1059
1060         CursorSlice normal = anchor_[depth() - 1];
1061         if (depth() < anchor_.depth() && top() <= normal) {
1062                 // anchor is behind cursor -> move anchor behind the inset
1063                 ++normal.pos();
1064         }
1065         return normal;
1066 }
1067
1068
1069 DocIterator & Cursor::realAnchor()
1070 {
1071         return anchor_;
1072 }
1073
1074
1075 CursorSlice Cursor::selBegin() const
1076 {
1077         if (!selection())
1078                 return top();
1079         return normalAnchor() < top() ? normalAnchor() : top();
1080 }
1081
1082
1083 CursorSlice Cursor::selEnd() const
1084 {
1085         if (!selection())
1086                 return top();
1087         return normalAnchor() > top() ? normalAnchor() : top();
1088 }
1089
1090
1091 DocIterator Cursor::selectionBegin() const
1092 {
1093         if (!selection())
1094                 return *this;
1095
1096         DocIterator di;
1097         // FIXME: This is a work-around for the problem that
1098         // CursorSlice doesn't keep track of the boundary.
1099         if (normalAnchor() == top())
1100                 di = anchor_.boundary() > boundary() ? anchor_ : *this;
1101         else
1102                 di = normalAnchor() < top() ? anchor_ : *this;
1103         di.resize(depth());
1104         return di;
1105 }
1106
1107
1108 DocIterator Cursor::selectionEnd() const
1109 {
1110         if (!selection())
1111                 return *this;
1112
1113         DocIterator di;
1114         // FIXME: This is a work-around for the problem that
1115         // CursorSlice doesn't keep track of the boundary.
1116         if (normalAnchor() == top())
1117                 di = anchor_.boundary() < boundary() ? anchor_ : *this;
1118         else
1119                 di = normalAnchor() > top() ? anchor_ : *this;
1120
1121         if (di.depth() > depth()) {
1122                 di.resize(depth());
1123                 ++di.pos();
1124         }
1125         return di;
1126 }
1127
1128
1129 void Cursor::setSelection()
1130 {
1131         setSelection(true);
1132         if (idx() == normalAnchor().idx() &&
1133             pit() == normalAnchor().pit() &&
1134             pos() == normalAnchor().pos())
1135                 setSelection(false);
1136 }
1137
1138
1139 void Cursor::setSelection(DocIterator const & where, int n)
1140 {
1141         setCursor(where);
1142         setSelection(true);
1143         anchor_ = where;
1144         pos() += n;
1145 }
1146
1147
1148 void Cursor::clearSelection()
1149 {
1150         setSelection(false);
1151         setWordSelection(false);
1152         setMark(false);
1153         resetAnchor();
1154 }
1155
1156
1157 void Cursor::setTargetX(int x)
1158 {
1159         x_target_ = x;
1160         textTargetOffset_ = 0;
1161 }
1162
1163
1164 int Cursor::x_target() const
1165 {
1166         return x_target_;
1167 }
1168
1169
1170 void Cursor::clearTargetX()
1171 {
1172         x_target_ = -1;
1173         textTargetOffset_ = 0;
1174 }
1175
1176
1177 void Cursor::updateTextTargetOffset()
1178 {
1179         int x;
1180         int y;
1181         getPos(x, y);
1182         textTargetOffset_ = x - x_target_;
1183 }
1184
1185
1186 void Cursor::info(odocstream & os) const
1187 {
1188         for (int i = 1, n = depth(); i < n; ++i) {
1189                 operator[](i).inset().infoize(os);
1190                 os << "  ";
1191         }
1192         if (pos() != 0) {
1193                 Inset const * inset = prevInset();
1194                 // prevInset() can return 0 in certain case.
1195                 if (inset)
1196                         prevInset()->infoize2(os);
1197         }
1198         // overwite old message
1199         os << "                    ";
1200 }
1201
1202
1203 bool Cursor::selHandle(bool sel)
1204 {
1205         //lyxerr << "Cursor::selHandle" << endl;
1206         if (mark())
1207                 sel = true;
1208         if (sel == selection())
1209                 return false;
1210
1211         if (!sel)
1212                 cap::saveSelection(*this);
1213
1214         resetAnchor();
1215         setSelection(sel);
1216         return true;
1217 }
1218 } // namespace lyx
1219
1220
1221 ///////////////////////////////////////////////////////////////////
1222 //
1223 // FIXME: Look here
1224 // The part below is the non-integrated rest of the original math
1225 // cursor. This should be either generalized for texted or moved
1226 // back to mathed (in most cases to InsetMathNest).
1227 //
1228 ///////////////////////////////////////////////////////////////////
1229
1230 #include "mathed/InsetMathChar.h"
1231 #include "mathed/InsetMathGrid.h"
1232 #include "mathed/InsetMathScript.h"
1233 #include "mathed/InsetMathUnknown.h"
1234 #include "mathed/MathFactory.h"
1235 #include "mathed/MathStream.h"
1236 #include "mathed/MathSupport.h"
1237
1238
1239 namespace lyx {
1240
1241 bool Cursor::isInside(Inset const * p) const
1242 {
1243         for (size_t i = 0; i != depth(); ++i)
1244                 if (&operator[](i).inset() == p)
1245                         return true;
1246         return false;
1247 }
1248
1249
1250 void Cursor::leaveInset(Inset const & inset)
1251 {
1252         for (size_t i = 0; i != depth(); ++i) {
1253                 if (&operator[](i).inset() == &inset) {
1254                         resize(i);
1255                         return;
1256                 }
1257         }
1258 }
1259
1260
1261 bool Cursor::openable(MathAtom const & t) const
1262 {
1263         if (!t->isActive())
1264                 return false;
1265
1266         if (t->lock())
1267                 return false;
1268
1269         if (!selection())
1270                 return true;
1271
1272         // we can't move into anything new during selection
1273         if (depth() >= anchor_.depth())
1274                 return false;
1275         if (t.nucleus() != &anchor_[depth()].inset())
1276                 return false;
1277
1278         return true;
1279 }
1280
1281
1282 void Cursor::setScreenPos(int x, int /*y*/)
1283 {
1284         setTargetX(x);
1285         //bruteFind(*this, x, y, 0, bv().workWidth(), 0, bv().workHeight());
1286 }
1287
1288
1289
1290 void Cursor::plainErase()
1291 {
1292         cell().erase(pos());
1293 }
1294
1295
1296 void Cursor::markInsert()
1297 {
1298         insert(char_type(0));
1299 }
1300
1301
1302 void Cursor::markErase()
1303 {
1304         cell().erase(pos());
1305 }
1306
1307
1308 void Cursor::plainInsert(MathAtom const & t)
1309 {
1310         cell().insert(pos(), t);
1311         ++pos();
1312         inset().setBuffer(bv_->buffer());
1313         inset().initView();
1314         forceBufferUpdate();
1315 }
1316
1317
1318 void Cursor::insert(docstring const & str)
1319 {
1320         for_each(str.begin(), str.end(),
1321                  bind(static_cast<void(Cursor::*)(char_type)>
1322                              (&Cursor::insert), this, _1));
1323 }
1324
1325
1326 void Cursor::insert(char_type c)
1327 {
1328         //lyxerr << "Cursor::insert char '" << c << "'" << endl;
1329         LASSERT(!empty(), return);
1330         if (inMathed()) {
1331                 cap::selClearOrDel(*this);
1332                 insert(new InsetMathChar(c));
1333         } else {
1334                 text()->insertChar(*this, c);
1335         }
1336 }
1337
1338
1339 void Cursor::insert(MathAtom const & t)
1340 {
1341         //lyxerr << "Cursor::insert MathAtom '" << t << "'" << endl;
1342         macroModeClose();
1343         cap::selClearOrDel(*this);
1344         plainInsert(t);
1345 }
1346
1347
1348 void Cursor::insert(Inset * inset0)
1349 {
1350         LASSERT(inset0, return);
1351         if (inMathed())
1352                 insert(MathAtom(inset0->asInsetMath()));
1353         else {
1354                 text()->insertInset(*this, inset0);
1355                 inset0->setBuffer(bv_->buffer());
1356                 inset0->initView();
1357                 if (inset0->isLabeled())
1358                         forceBufferUpdate();
1359         }
1360 }
1361
1362
1363 int Cursor::niceInsert(docstring const & t, Parse::flags f, bool enter)
1364 {
1365         MathData ar(buffer());
1366         asArray(t, ar, f);
1367         if (ar.size() == 1 && (enter || selection()))
1368                 niceInsert(ar[0]);
1369         else
1370                 insert(ar);
1371         return ar.size();
1372 }
1373
1374
1375 void Cursor::niceInsert(MathAtom const & t)
1376 {
1377         macroModeClose();
1378         docstring const safe = cap::grabAndEraseSelection(*this);
1379         plainInsert(t);
1380         // If possible, enter the new inset and move the contents of the selection
1381         if (t->isActive()) {
1382                 posBackward();
1383                 // be careful here: don't use 'pushBackward(t)' as this we need to
1384                 // push the clone, not the original
1385                 pushBackward(*nextInset());
1386                 // We may not use niceInsert here (recursion)
1387                 MathData ar(buffer());
1388                 asArray(safe, ar);
1389                 insert(ar);
1390         } else if (t->asMacro() && !safe.empty()) {
1391                 MathData ar(buffer());
1392                 asArray(safe, ar);
1393                 docstring const name = t->asMacro()->name();
1394                 MacroData const * data = buffer()->getMacro(name);
1395                 if (data && data->numargs() - data->optionals() > 0) {
1396                         plainInsert(MathAtom(new InsetMathBrace(ar)));
1397                         posBackward();
1398                 }
1399         }
1400 }
1401
1402
1403 void Cursor::insert(MathData const & ar)
1404 {
1405         macroModeClose();
1406         if (selection())
1407                 cap::eraseSelection(*this);
1408         cell().insert(pos(), ar);
1409         pos() += ar.size();
1410         // FIXME audit setBuffer calls
1411         inset().setBuffer(bv_->buffer());
1412 }
1413
1414
1415 bool Cursor::backspace()
1416 {
1417         if (selection()) {
1418                 cap::eraseSelection(*this);
1419                 return true;
1420         }
1421
1422         if (pos() == 0) {
1423                 // If empty cell, and not part of a big cell
1424                 if (lastpos() == 0 && inset().nargs() == 1) {
1425                         popBackward();
1426                         // Directly delete empty cell: [|[]] => [|]
1427                         if (inMathed()) {
1428                                 plainErase();
1429                                 resetAnchor();
1430                                 return true;
1431                         }
1432                         // [|], can not delete from inside
1433                         return false;
1434                 } else {
1435                         if (inMathed())
1436                                 pullArg();
1437                         else
1438                                 popBackward();
1439                         return true;
1440                 }
1441         }
1442
1443         if (inMacroMode()) {
1444                 InsetMathUnknown * p = activeMacro();
1445                 if (p->name().size() > 1) {
1446                         p->setName(p->name().substr(0, p->name().size() - 1));
1447                         return true;
1448                 }
1449         }
1450
1451         if (pos() != 0 && prevAtom()->nargs() > 0) {
1452                 // let's require two backspaces for 'big stuff' and
1453                 // highlight on the first
1454                 resetAnchor();
1455                 setSelection(true);
1456                 --pos();
1457         } else {
1458                 --pos();
1459                 plainErase();
1460         }
1461         return true;
1462 }
1463
1464
1465 bool Cursor::erase()
1466 {
1467         if (inMacroMode())
1468                 return true;
1469
1470         if (selection()) {
1471                 cap::eraseSelection(*this);
1472                 return true;
1473         }
1474
1475         // delete empty cells if possible
1476         if (pos() == lastpos() && inset().idxDelete(idx()))
1477                 return true;
1478
1479         // special behaviour when in last position of cell
1480         if (pos() == lastpos()) {
1481                 bool one_cell = inset().nargs() == 1;
1482                 if (one_cell && lastpos() == 0) {
1483                         popBackward();
1484                         // Directly delete empty cell: [|[]] => [|]
1485                         if (inMathed()) {
1486                                 plainErase();
1487                                 resetAnchor();
1488                                 return true;
1489                         }
1490                         // [|], can not delete from inside
1491                         return false;
1492                 }
1493                 // remove markup
1494                 if (!one_cell)
1495                         inset().idxGlue(idx());
1496                 return true;
1497         }
1498
1499         // 'clever' UI hack: only erase large items if previously slected
1500         if (pos() != lastpos() && nextAtom()->nargs() > 0) {
1501                 resetAnchor();
1502                 setSelection(true);
1503                 ++pos();
1504         } else {
1505                 plainErase();
1506         }
1507
1508         return true;
1509 }
1510
1511
1512 bool Cursor::up()
1513 {
1514         macroModeClose();
1515         DocIterator save = *this;
1516         FuncRequest cmd(selection() ? LFUN_UP_SELECT : LFUN_UP, docstring());
1517         this->dispatch(cmd);
1518         if (disp_.dispatched())
1519                 return true;
1520         setCursor(save);
1521         return false;
1522 }
1523
1524
1525 bool Cursor::down()
1526 {
1527         macroModeClose();
1528         DocIterator save = *this;
1529         FuncRequest cmd(selection() ? LFUN_DOWN_SELECT : LFUN_DOWN, docstring());
1530         this->dispatch(cmd);
1531         if (disp_.dispatched())
1532                 return true;
1533         setCursor(save);
1534         return false;
1535 }
1536
1537
1538 bool Cursor::macroModeClose()
1539 {
1540         if (!inMacroMode())
1541                 return false;
1542         InsetMathUnknown * p = activeMacro();
1543         p->finalize();
1544         MathData selection(buffer());
1545         asArray(p->selection(), selection);
1546         docstring const s = p->name();
1547         --pos();
1548         cell().erase(pos());
1549
1550         // do nothing if the macro name is empty
1551         if (s == "\\")
1552                 return false;
1553
1554         // trigger updates of macros, at least, if no full
1555         // updates take place anyway
1556         screenUpdateFlags(Update::Force);
1557
1558         docstring const name = s.substr(1);
1559         InsetMathNest * const in = inset().asInsetMath()->asNestInset();
1560         if (in && in->interpretString(*this, s))
1561                 return true;
1562         MathAtom atom = buffer()->getMacro(name, *this, false) ?
1563                 MathAtom(new MathMacro(buffer(), name)) : createInsetMath(name, buffer());
1564
1565         // try to put argument into macro, if we just inserted a macro
1566         bool macroArg = false;
1567         MathMacro * atomAsMacro = atom.nucleus()->asMacro();
1568         if (atomAsMacro) {
1569                 // macros here are still unfolded (in init mode in fact). So
1570                 // we have to resolve the macro here manually and check its arity
1571                 // to put the selection behind it if arity > 0.
1572                 MacroData const * data = buffer()->getMacro(atomAsMacro->name());
1573                 if (!selection.empty() && data && data->numargs() - data->optionals() > 0) {
1574                         macroArg = true;
1575                         atomAsMacro->setDisplayMode(MathMacro::DISPLAY_INTERACTIVE_INIT, 1);
1576                 } else
1577                         // non-greedy case. Do not touch the arguments behind
1578                         atomAsMacro->setDisplayMode(MathMacro::DISPLAY_INTERACTIVE_INIT, 0);
1579         }
1580
1581         // insert remembered selection into first argument of a non-macro
1582         else if (atom.nucleus()->nargs() > 0)
1583                 atom.nucleus()->cell(0).append(selection);
1584
1585         plainInsert(atom);
1586
1587         // finally put the macro argument behind, if needed
1588         if (macroArg) {
1589                 if (selection.size() > 1 || selection[0]->asScriptInset())
1590                         plainInsert(MathAtom(new InsetMathBrace(selection)));
1591                 else
1592                         insert(selection);
1593         }
1594
1595         return true;
1596 }
1597
1598
1599 docstring Cursor::macroName()
1600 {
1601         return inMacroMode() ? activeMacro()->name() : docstring();
1602 }
1603
1604
1605 void Cursor::handleNest(MathAtom const & a, int c)
1606 {
1607         //lyxerr << "Cursor::handleNest: " << c << endl;
1608         MathAtom t = a;
1609         asArray(cap::grabAndEraseSelection(*this), t.nucleus()->cell(c));
1610         insert(t);
1611         posBackward();
1612         pushBackward(*nextInset());
1613 }
1614
1615
1616 int Cursor::targetX() const
1617 {
1618         if (x_target() != -1)
1619                 return x_target();
1620         int x = 0;
1621         int y = 0;
1622         getPos(x, y);
1623         return x;
1624 }
1625
1626
1627 int Cursor::textTargetOffset() const
1628 {
1629         return textTargetOffset_;
1630 }
1631
1632
1633 void Cursor::setTargetX()
1634 {
1635         int x;
1636         int y;
1637         getPos(x, y);
1638         setTargetX(x);
1639 }
1640
1641
1642 bool Cursor::inMacroMode() const
1643 {
1644         if (!inMathed())
1645                 return false;
1646         if (pos() == 0 || cell().empty())
1647                 return false;
1648         InsetMathUnknown const * p = prevAtom()->asUnknownInset();
1649         return p && !p->final();
1650 }
1651
1652
1653 InsetMathUnknown * Cursor::activeMacro()
1654 {
1655         return inMacroMode() ? prevAtom().nucleus()->asUnknownInset() : 0;
1656 }
1657
1658
1659 InsetMathUnknown const * Cursor::activeMacro() const
1660 {
1661         return inMacroMode() ? prevAtom().nucleus()->asUnknownInset() : 0;
1662 }
1663
1664
1665 void Cursor::pullArg()
1666 {
1667         // FIXME: Look here
1668         MathData ar = cell();
1669         if (popBackward() && inMathed()) {
1670                 plainErase();
1671                 cell().insert(pos(), ar);
1672                 resetAnchor();
1673         } else {
1674                 //formula()->mutateToText();
1675         }
1676 }
1677
1678
1679 void Cursor::touch()
1680 {
1681         // FIXME: look here
1682 #if 0
1683         DocIterator::const_iterator it = begin();
1684         DocIterator::const_iterator et = end();
1685         for ( ; it != et; ++it)
1686                 it->cell().touch();
1687 #endif
1688 }
1689
1690
1691 void Cursor::normalize()
1692 {
1693         if (idx() > lastidx()) {
1694                 lyxerr << "this should not really happen - 1: "
1695                        << idx() << ' ' << nargs()
1696                        << " in: " << &inset() << endl;
1697                 idx() = lastidx();
1698         }
1699
1700         if (pos() > lastpos()) {
1701                 lyxerr << "this should not really happen - 2: "
1702                         << pos() << ' ' << lastpos() <<  " in idx: " << idx()
1703                        << " in atom: '";
1704                 odocstringstream os;
1705                 WriteStream wi(os, false, true, WriteStream::wsDefault);
1706                 inset().asInsetMath()->write(wi);
1707                 lyxerr << to_utf8(os.str()) << endl;
1708                 pos() = lastpos();
1709         }
1710 }
1711
1712
1713 bool Cursor::upDownInMath(bool up)
1714 {
1715         // Be warned: The 'logic' implemented in this function is highly
1716         // fragile. A distance of one pixel or a '<' vs '<=' _really
1717         // matters. So fiddle around with it only if you think you know
1718         // what you are doing!
1719         int xo = 0;
1720         int yo = 0;
1721         getPos(xo, yo);
1722         xo = beforeDispatchPosX_;
1723
1724         // check if we had something else in mind, if not, this is the future
1725         // target
1726         if (x_target_ == -1)
1727                 setTargetX(xo);
1728         else if (inset().asInsetText() && xo - textTargetOffset() != x_target()) {
1729                 // In text mode inside the line (not left or right) possibly set a new target_x,
1730                 // but only if we are somewhere else than the previous target-offset.
1731
1732                 // We want to keep the x-target on subsequent up/down movements
1733                 // that cross beyond the end of short lines. Thus a special
1734                 // handling when the cursor is at the end of line: Use the new
1735                 // x-target only if the old one was before the end of line
1736                 // or the old one was after the beginning of the line
1737                 bool inRTL = innerParagraph().isRTL(bv().buffer().params());
1738                 bool left;
1739                 bool right;
1740                 if (inRTL) {
1741                         left = pos() == textRow().endpos();
1742                         right = pos() == textRow().pos();
1743                 } else {
1744                         left = pos() == textRow().pos();
1745                         right = pos() == textRow().endpos();
1746                 }
1747                 if ((!left && !right) ||
1748                                 (left && !right && xo < x_target_) ||
1749                                 (!left && right && x_target_ < xo))
1750                         setTargetX(xo);
1751                 else
1752                         xo = targetX();
1753         } else
1754                 xo = targetX();
1755
1756         // try neigbouring script insets
1757         Cursor old = *this;
1758         if (inMathed() && !selection()) {
1759                 // try left
1760                 if (pos() != 0) {
1761                         InsetMathScript const * p = prevAtom()->asScriptInset();
1762                         if (p && p->has(up)) {
1763                                 --pos();
1764                                 push(*const_cast<InsetMathScript*>(p));
1765                                 idx() = p->idxOfScript(up);
1766                                 pos() = lastpos();
1767
1768                                 // we went in the right direction? Otherwise don't jump into the script
1769                                 int x;
1770                                 int y;
1771                                 getPos(x, y);
1772                                 int oy = beforeDispatchPosY_;
1773                                 if ((!up && y <= oy) ||
1774                                                 (up && y >= oy))
1775                                         operator=(old);
1776                                 else
1777                                         return true;
1778                         }
1779                 }
1780
1781                 // try right
1782                 if (pos() != lastpos()) {
1783                         InsetMathScript const * p = nextAtom()->asScriptInset();
1784                         if (p && p->has(up)) {
1785                                 push(*const_cast<InsetMathScript*>(p));
1786                                 idx() = p->idxOfScript(up);
1787                                 pos() = 0;
1788
1789                                 // we went in the right direction? Otherwise don't jump into the script
1790                                 int x;
1791                                 int y;
1792                                 getPos(x, y);
1793                                 int oy = beforeDispatchPosY_;
1794                                 if ((!up && y <= oy) ||
1795                                                 (up && y >= oy))
1796                                         operator=(old);
1797                                 else
1798                                         return true;
1799                         }
1800                 }
1801         }
1802
1803         // try to find an inset that knows better then we,
1804         if (inset().idxUpDown(*this, up)) {
1805                 //lyxerr << "idxUpDown triggered" << endl;
1806                 // try to find best position within this inset
1807                 if (!selection())
1808                         setCursor(bruteFind2(*this, xo, yo));
1809                 return true;
1810         }
1811
1812         // any improvement going just out of inset?
1813         if (popBackward() && inMathed()) {
1814                 //lyxerr << "updown: popBackward succeeded" << endl;
1815                 int xnew;
1816                 int ynew;
1817                 int yold = beforeDispatchPosY_;
1818                 getPos(xnew, ynew);
1819                 if (up ? ynew < yold : ynew > yold)
1820                         return true;
1821         }
1822
1823         // no success, we are probably at the document top or bottom
1824         operator=(old);
1825         return false;
1826 }
1827
1828
1829 bool Cursor::atFirstOrLastRow(bool up)
1830 {
1831         TextMetrics const & tm = bv_->textMetrics(text());
1832         ParagraphMetrics const & pm = tm.parMetrics(pit());
1833
1834         int row;
1835         if (pos() && boundary())
1836                 row = pm.pos2row(pos() - 1);
1837         else
1838                 row = pm.pos2row(pos());
1839
1840         if (up) {
1841                 if (pit() == 0 && row == 0)
1842                         return true;
1843         } else {
1844                 if (pit() + 1 >= int(text()->paragraphs().size()) &&
1845                                 row + 1 >= int(pm.rows().size()))
1846                         return true;
1847         }
1848         return false;
1849 }
1850
1851
1852 bool Cursor::upDownInText(bool up, bool & updateNeeded)
1853 {
1854         LASSERT(text(), return false);
1855
1856         // where are we?
1857         int xo = 0;
1858         int yo = 0;
1859         getPos(xo, yo);
1860         xo = beforeDispatchPosX_;
1861
1862         // update the targetX - this is here before the "return false"
1863         // to set a new target which can be used by InsetTexts above
1864         // if we cannot move up/down inside this inset anymore
1865         if (x_target_ == -1)
1866                 setTargetX(xo);
1867         else if (xo - textTargetOffset() != x_target() &&
1868                                          depth() == beforeDispatchCursor_.depth()) {
1869                 // In text mode inside the line (not left or right)
1870                 // possibly set a new target_x, but only if we are
1871                 // somewhere else than the previous target-offset.
1872
1873                 // We want to keep the x-target on subsequent up/down
1874                 // movements that cross beyond the end of short lines.
1875                 // Thus a special handling when the cursor is at the
1876                 // end of line: Use the new x-target only if the old
1877                 // one was before the end of line or the old one was
1878                 // after the beginning of the line
1879                 bool inRTL = innerParagraph().isRTL(bv().buffer().params());
1880                 bool left;
1881                 bool right;
1882                 if (inRTL) {
1883                         left = pos() == textRow().endpos();
1884                         right = pos() == textRow().pos();
1885                 } else {
1886                         left = pos() == textRow().pos();
1887                         right = pos() == textRow().endpos();
1888                 }
1889                 if ((!left && !right) ||
1890                                 (left && !right && xo < x_target_) ||
1891                                 (!left && right && x_target_ < xo))
1892                         setTargetX(xo);
1893                 else
1894                         xo = targetX();
1895         } else
1896                 xo = targetX();
1897
1898         // first get the current line
1899         TextMetrics & tm = bv_->textMetrics(text());
1900         ParagraphMetrics const & pm = tm.parMetrics(pit());
1901         int row;
1902         if (pos() && boundary())
1903                 row = pm.pos2row(pos() - 1);
1904         else
1905                 row = pm.pos2row(pos());
1906
1907         if (atFirstOrLastRow(up)) {
1908                 // Is there a place for the cursor to go ? If yes, we
1909                 // can execute the DEPM, otherwise we should keep the
1910                 // paragraph to host the cursor.
1911                 Cursor dummy = *this;
1912                 bool valid_destination = false;
1913                 for(; dummy.depth(); dummy.pop())
1914                         if (!dummy.atFirstOrLastRow(up)) {
1915                                 valid_destination = true;
1916                                 break;
1917                         }
1918
1919                 // will a next dispatch follow and if there is a new
1920                 // dispatch will it move the cursor out ?
1921                 if (depth() > 1 && valid_destination) {
1922                         // The cursor hasn't changed yet. This happens when
1923                         // you e.g. move out of an inset. And to give the
1924                         // DEPM the possibility of doing something we must
1925                         // provide it with two different cursors. (Lgb, vfr)
1926                         dummy = *this;
1927                         dummy.pos() = dummy.pos() == 0 ? dummy.lastpos() : 0;
1928                         dummy.pit() = dummy.pit() == 0 ? dummy.lastpit() : 0;
1929
1930                         updateNeeded |= bv().checkDepm(dummy, *this);
1931                         updateTextTargetOffset();
1932                         if (updateNeeded)
1933                                 forceBufferUpdate();
1934                 }
1935                 return false;
1936         }
1937
1938         // with and without selection are handled differently
1939         if (!selection()) {
1940                 int yo = bv().getPos(*this).y_;
1941                 Cursor old = *this;
1942                 // To next/previous row
1943                 if (up)
1944                         tm.editXY(*this, xo, yo - textRow().ascent() - 1);
1945                 else
1946                         tm.editXY(*this, xo, yo + textRow().descent() + 1);
1947                 clearSelection();
1948
1949                 // This happens when you move out of an inset.
1950                 // And to give the DEPM the possibility of doing
1951                 // something we must provide it with two different
1952                 // cursors. (Lgb)
1953                 Cursor dummy = *this;
1954                 if (dummy == old)
1955                         ++dummy.pos();
1956                 if (bv().checkDepm(dummy, old)) {
1957                         updateNeeded = true;
1958                         // Make sure that cur gets back whatever happened to dummy (Lgb)
1959                         operator=(dummy);
1960                 }
1961         } else {
1962                 // if there is a selection, we stay out of any inset,
1963                 // and just jump to the right position:
1964                 Cursor old = *this;
1965                 int next_row = row;
1966                 if (up) {
1967                         if (row > 0) {
1968                                 --next_row;
1969                         } else if (pit() > 0) {
1970                                 --pit();
1971                                 TextMetrics & tm = bv_->textMetrics(text());
1972                                 if (!tm.contains(pit()))
1973                                         tm.newParMetricsUp();
1974                                 ParagraphMetrics const & pmcur = tm.parMetrics(pit());
1975                                 next_row = pmcur.rows().size() - 1;
1976                         }
1977                 } else {
1978                         if (row + 1 < int(pm.rows().size())) {
1979                                 ++next_row;
1980                         } else if (pit() + 1 < int(text()->paragraphs().size())) {
1981                                 ++pit();
1982                                 TextMetrics & tm = bv_->textMetrics(text());
1983                                 if (!tm.contains(pit()))
1984                                         tm.newParMetricsDown();
1985                                 next_row = 0;
1986                         }
1987                 }
1988
1989                 Row const & real_next_row = tm.parMetrics(pit()).rows()[next_row];
1990                 bool bound = false;
1991                 top().pos() = tm.getPosNearX(real_next_row, xo, bound);
1992                 boundary(bound);
1993
1994                 updateNeeded |= bv().checkDepm(*this, old);
1995         }
1996
1997         if (updateNeeded)
1998                 forceBufferUpdate();
1999         updateTextTargetOffset();
2000         return true;
2001 }
2002
2003
2004 void Cursor::handleFont(string const & font)
2005 {
2006         LYXERR(Debug::DEBUG, font);
2007         docstring safe;
2008         if (selection()) {
2009                 macroModeClose();
2010                 safe = cap::grabAndEraseSelection(*this);
2011         }
2012
2013         recordUndoInset();
2014
2015         if (lastpos() != 0) {
2016                 // something left in the cell
2017                 if (pos() == 0) {
2018                         // cursor in first position
2019                         popBackward();
2020                 } else if (pos() == lastpos()) {
2021                         // cursor in last position
2022                         popForward();
2023                 } else {
2024                         // cursor in between. split cell
2025                         MathData::iterator bt = cell().begin();
2026                         MathAtom at = createInsetMath(from_utf8(font), buffer());
2027                         at.nucleus()->cell(0) = MathData(buffer(), bt, bt + pos());
2028                         cell().erase(bt, bt + pos());
2029                         popBackward();
2030                         plainInsert(at);
2031                 }
2032         } else {
2033                 // nothing left in the cell
2034                 popBackward();
2035                 plainErase();
2036                 resetAnchor();
2037         }
2038         insert(safe);
2039 }
2040
2041
2042 void Cursor::message(docstring const & msg) const
2043 {
2044         disp_.setMessage(msg);
2045 }
2046
2047
2048 void Cursor::errorMessage(docstring const & msg) const
2049 {
2050         disp_.setMessage(msg);
2051         disp_.setError(true);
2052 }
2053
2054
2055 namespace {
2056
2057 docstring parbreak(Cursor const * cur)
2058 {
2059         odocstringstream os;
2060         os << '\n';
2061         // only add blank line if we're not in a ParbreakIsNewline situation
2062         if (!cur->inset().getLayout().parbreakIsNewline()
2063             && !cur->paragraph().layout().parbreak_is_newline)
2064                 os << '\n';
2065         return os.str();
2066 }
2067
2068 }
2069
2070
2071 docstring Cursor::selectionAsString(bool with_label) const
2072 {
2073         if (!selection())
2074                 return docstring();
2075
2076         if (inMathed())
2077                 return cap::grabSelection(*this);
2078
2079         int const label = with_label
2080                 ? AS_STR_LABEL | AS_STR_INSETS : AS_STR_INSETS;
2081
2082         idx_type const startidx = selBegin().idx();
2083         idx_type const endidx = selEnd().idx();
2084         if (startidx != endidx) {
2085                 // multicell selection
2086                 InsetTabular * table = inset().asInsetTabular();
2087                 LASSERT(table, return docstring());
2088                 return table->asString(startidx, endidx);
2089         }
2090
2091         ParagraphList const & pars = text()->paragraphs();
2092
2093         pit_type const startpit = selBegin().pit();
2094         pit_type const endpit = selEnd().pit();
2095         size_t const startpos = selBegin().pos();
2096         size_t const endpos = selEnd().pos();
2097
2098         if (startpit == endpit)
2099                 return pars[startpit].asString(startpos, endpos, label);
2100
2101         // First paragraph in selection
2102         docstring result = pars[startpit].
2103                 asString(startpos, pars[startpit].size(), label)
2104                 + parbreak(this);
2105
2106         // The paragraphs in between (if any)
2107         for (pit_type pit = startpit + 1; pit != endpit; ++pit) {
2108                 Paragraph const & par = pars[pit];
2109                 result += par.asString(0, par.size(), label)
2110                         + parbreak(this);
2111         }
2112
2113         // Last paragraph in selection
2114         result += pars[endpit].asString(0, endpos, label);
2115
2116         return result;
2117 }
2118
2119
2120 docstring Cursor::currentState() const
2121 {
2122         if (inMathed()) {
2123                 odocstringstream os;
2124                 info(os);
2125                 return os.str();
2126         }
2127
2128         if (inTexted())
2129                 return text()->currentState(*this);
2130
2131         return docstring();
2132 }
2133
2134
2135 docstring Cursor::getPossibleLabel() const
2136 {
2137         return inMathed() ? from_ascii("eq:") : text()->getPossibleLabel(*this);
2138 }
2139
2140
2141 Encoding const * Cursor::getEncoding() const
2142 {
2143         if (empty())
2144                 return 0;
2145         CursorSlice const & sl = innerTextSlice();
2146         Text const & text = *sl.text();
2147         Font font = text.getPar(sl.pit()).getFont(
2148                 bv().buffer().params(), sl.pos(), text.outerFont(sl.pit()));
2149         return font.language()->encoding();
2150 }
2151
2152
2153 void Cursor::undispatched() const
2154 {
2155         disp_.dispatched(false);
2156 }
2157
2158
2159 void Cursor::dispatched() const
2160 {
2161         disp_.dispatched(true);
2162 }
2163
2164
2165 void Cursor::screenUpdateFlags(Update::flags f) const
2166 {
2167         disp_.screenUpdate(f);
2168 }
2169
2170
2171 void Cursor::forceBufferUpdate() const
2172 {
2173         disp_.forceBufferUpdate();
2174 }
2175
2176
2177 void Cursor::clearBufferUpdate() const
2178 {
2179         disp_.clearBufferUpdate();
2180 }
2181
2182
2183 bool Cursor::needBufferUpdate() const
2184 {
2185         return disp_.needBufferUpdate();
2186 }
2187
2188
2189 void Cursor::noScreenUpdate() const
2190 {
2191         disp_.screenUpdate(Update::None);
2192 }
2193
2194
2195 Font Cursor::getFont() const
2196 {
2197         // The logic here should more or less match to the
2198         // Cursor::setCurrentFont logic, i.e. the cursor height should
2199         // give a hint what will happen if a character is entered.
2200
2201         // HACK. far from being perfect...
2202
2203         CursorSlice const & sl = innerTextSlice();
2204         Text const & text = *sl.text();
2205         Paragraph const & par = text.getPar(sl.pit());
2206
2207         // on boundary, so we are really at the character before
2208         pos_type pos = sl.pos();
2209         if (pos > 0 && boundary())
2210                 --pos;
2211
2212         // on space? Take the font before (only for RTL boundary stay)
2213         if (pos > 0) {
2214                 TextMetrics const & tm = bv().textMetrics(&text);
2215                 if (pos == sl.lastpos()
2216                         || (par.isSeparator(pos)
2217                         && !tm.isRTLBoundary(sl.pit(), pos)))
2218                         --pos;
2219         }
2220
2221         // get font at the position
2222         Font font = par.getFont(buffer()->params(), pos,
2223                 text.outerFont(sl.pit()));
2224
2225         return font;
2226 }
2227
2228
2229 bool Cursor::fixIfBroken()
2230 {
2231         bool const broken_cursor = DocIterator::fixIfBroken();
2232         bool const broken_anchor = anchor_.fixIfBroken();
2233
2234         if (broken_cursor || broken_anchor) {
2235                 clearNewWordPosition();
2236                 clearSelection();
2237                 return true;
2238         }
2239         return false;
2240 }
2241
2242
2243 void Cursor::sanitize()
2244 {
2245         setBuffer(&bv_->buffer());
2246         DocIterator::sanitize();
2247         if (selection())
2248                 anchor_.sanitize();
2249         else
2250                 resetAnchor();
2251 }
2252
2253
2254 bool notifyCursorLeavesOrEnters(Cursor const & old, Cursor & cur)
2255 {
2256         // find inset in common
2257         size_type i;
2258         for (i = 0; i < old.depth() && i < cur.depth(); ++i) {
2259                 if (&old[i].inset() != &cur[i].inset())
2260                         break;
2261         }
2262
2263         // update words if we just moved to another paragraph
2264         if (i == old.depth() && i == cur.depth()
2265             && !cur.buffer()->isClean()
2266             && cur.inTexted() && old.inTexted()
2267             && cur.pit() != old.pit()) {
2268                 old.paragraph().updateWords();
2269         }
2270
2271         // notify everything on top of the common part in old cursor,
2272         // but stop if the inset claims the cursor to be invalid now
2273         for (size_type j = i; j < old.depth(); ++j) {
2274                 Cursor inset_pos = old;
2275                 inset_pos.cutOff(j);
2276                 if (old[j].inset().notifyCursorLeaves(inset_pos, cur))
2277                         return true;
2278         }
2279
2280         // notify everything on top of the common part in new cursor,
2281         // but stop if the inset claims the cursor to be invalid now
2282         for (; i < cur.depth(); ++i) {
2283                 if (cur[i].inset().notifyCursorEnters(cur))
2284                         return true;
2285         }
2286
2287         return false;
2288 }
2289
2290
2291 void Cursor::setCurrentFont()
2292 {
2293         CursorSlice const & cs = innerTextSlice();
2294         Paragraph const & par = cs.paragraph();
2295         pos_type cpit = cs.pit();
2296         pos_type cpos = cs.pos();
2297         Text const & ctext = *cs.text();
2298         TextMetrics const & tm = bv().textMetrics(&ctext);
2299
2300         // are we behind previous char in fact? -> go to that char
2301         if (cpos > 0 && boundary())
2302                 --cpos;
2303
2304         // find position to take the font from
2305         if (cpos != 0) {
2306                 // paragraph end? -> font of last char
2307                 if (cpos == lastpos())
2308                         --cpos;
2309                 // on space? -> look at the words in front of space
2310                 else if (cpos > 0 && par.isSeparator(cpos))     {
2311                         // abc| def -> font of c
2312                         // abc |[WERBEH], i.e. boundary==true -> font of c
2313                         // abc [WERBEH]| def, font of the space
2314                         if (!tm.isRTLBoundary(cpit, cpos))
2315                                 --cpos;
2316                 }
2317         }
2318
2319         // get font
2320         BufferParams const & bufparams = buffer()->params();
2321         current_font = par.getFontSettings(bufparams, cpos);
2322         real_current_font = tm.displayFont(cpit, cpos);
2323
2324         // special case for paragraph end
2325         if (cs.pos() == lastpos()
2326             && tm.isRTLBoundary(cpit, cs.pos())
2327             && !boundary()) {
2328                 Language const * lang = par.getParLanguage(bufparams);
2329                 current_font.setLanguage(lang);
2330                 current_font.fontInfo().setNumber(FONT_OFF);
2331                 real_current_font.setLanguage(lang);
2332                 real_current_font.fontInfo().setNumber(FONT_OFF);
2333         }
2334 }
2335
2336
2337 bool Cursor::textUndo()
2338 {
2339         if (!buffer()->undo().textUndo(*this))
2340                 return false;
2341         sanitize();
2342         return true;
2343 }
2344
2345
2346 bool Cursor::textRedo()
2347 {
2348         if (!buffer()->undo().textRedo(*this))
2349                 return false;
2350         sanitize();
2351         return true;
2352 }
2353
2354
2355 void Cursor::finishUndo() const
2356 {
2357         buffer()->undo().finishUndo();
2358 }
2359
2360
2361 void Cursor::beginUndoGroup() const
2362 {
2363         buffer()->undo().beginUndoGroup(*this);
2364 }
2365
2366
2367 void Cursor::endUndoGroup() const
2368 {
2369         buffer()->undo().endUndoGroup(*this);
2370 }
2371
2372
2373 void Cursor::recordUndo(pit_type from, pit_type to) const
2374 {
2375         buffer()->undo().recordUndo(*this, from, to);
2376 }
2377
2378
2379 void Cursor::recordUndo(pit_type from) const
2380 {
2381         buffer()->undo().recordUndo(*this, from, pit());
2382 }
2383
2384
2385 void Cursor::recordUndo(UndoKind kind) const
2386 {
2387         buffer()->undo().recordUndo(*this, kind);
2388 }
2389
2390
2391 void Cursor::recordUndoInset(Inset const * in) const
2392 {
2393         buffer()->undo().recordUndoInset(*this, in);
2394 }
2395
2396
2397 void Cursor::recordUndoFullBuffer() const
2398 {
2399         buffer()->undo().recordUndoFullBuffer(*this);
2400 }
2401
2402
2403 void Cursor::recordUndoBufferParams() const
2404 {
2405         buffer()->undo().recordUndoBufferParams(*this);
2406 }
2407
2408
2409 void Cursor::recordUndoSelection() const
2410 {
2411         if (inMathed()) {
2412                 if (cap::multipleCellsSelected(*this))
2413                         recordUndoInset();
2414                 else
2415                         recordUndo();
2416         } else {
2417                 buffer()->undo().recordUndo(*this,
2418                         selBegin().pit(), selEnd().pit());
2419         }
2420 }
2421
2422
2423 void Cursor::checkBufferStructure()
2424 {
2425         Buffer const * master = buffer()->masterBuffer();
2426         master->tocBackend().updateItem(*this);
2427         if (master != buffer() && !master->hasGuiDelegate())
2428                 // In case the master has no gui associated with it,
2429                 // the TocItem is not updated (part of bug 5699).
2430                 buffer()->tocBackend().updateItem(*this);
2431 }
2432
2433
2434 } // namespace lyx