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