src/Cursor.cpp

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