src/cursor.C

   1 /**
   2  * \file cursor.C
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Alejandro Aguilar Sierra
   7  * \author Alfredo Braunstein
   8  * \author André Pönitz
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #include <config.h>
  14
  15 #include "BufferView.h"
  16 #include "buffer.h"
  17 #include "cursor.h"
  18 #include "coordcache.h"
  19 #include "CutAndPaste.h"
  20 #include "debug.h"
  21 #include "dispatchresult.h"
  22 #include "encoding.h"
  23 #include "funcrequest.h"
  24 #include "language.h"
  25 #include "lfuns.h"
  26 #include "lyxfont.h"
  27 #include "lyxfunc.h" // only for setMessage()
  28 #include "lyxrc.h"
  29 #include "lyxrow.h"
  30 #include "lyxtext.h"
  31 #include "paragraph.h"
  32 #include "paragraph_funcs.h"
  33 #include "pariterator.h"
  34
  35 #include "insets/insettabular.h"
  36 #include "insets/insettext.h"
  37
  38 #include "mathed/MathData.h"
  39 #include "mathed/InsetMath.h"
  40 #include "mathed/InsetMathScript.h"
  41 #include "mathed/MathMacroTable.h"
  42 #include "mathed/MathParser.h"
  43
  44 #include "support/limited_stack.h"
  45
  46 #include <boost/assert.hpp>
  47 #include <boost/bind.hpp>
  48 #include <boost/current_function.hpp>
  49
  50 #include <sstream>
  51 #include <limits>
  52
  53 namespace lyx {
  54
  55 using std::string;
  56 using std::vector;
  57 using std::endl;
  58 #ifndef CXX_GLOBAL_CSTD
  59 using std::isalpha;
  60 #endif
  61 using std::min;
  62 using std::for_each;
  63
  64 namespace {
  65
  66         bool
  67         positionable(DocIterator const & cursor, DocIterator const & anchor)
  68         {
  69                 // avoid deeper nested insets when selecting
  70                 if (cursor.depth() > anchor.depth())
  71                         return false;
  72
  73                 // anchor might be deeper, should have same path then
  74                 for (size_t i = 0; i < cursor.depth(); ++i)
  75                         if (&cursor[i].inset() != &anchor[i].inset())
  76                                 return false;
  77
  78                 // position should be ok.
  79                 return true;
  80         }
  81
  82
  83         // Find position closest to (x, y) in cell given by iter.
  84         // Used only in mathed
  85         DocIterator bruteFind2(LCursor const & c, int x, int y)
  86         {
  87                 double best_dist = std::numeric_limits<double>::max();
  88
  89                 DocIterator result;
  90
  91                 DocIterator it = c;
  92                 it.top().pos() = 0;
  93                 DocIterator et = c;
  94                 et.top().pos() = et.top().asInsetMath()->cell(et.top().idx()).size();
  95                 for (size_t i = 0; ; ++i) {
  96                         int xo;
  97                         int yo;
  98                         InsetBase const * inset = &it.inset();
  99                         Point o = c.bv().coordCache().getInsets().xy(inset);
 100                         inset->cursorPos(c.bv(), it.top(), c.boundary(), xo, yo);
 101                         // Convert to absolute
 102                         xo += o.x_;
 103                         yo += o.y_;
 104                         double d = (x - xo) * (x - xo) + (y - yo) * (y - yo);
 105                         // '<=' in order to take the last possible position
 106                         // this is important for clicking behind \sum in e.g. '\sum_i a'
 107                         lyxerr[Debug::DEBUG] << "i: " << i << " d: " << d
 108                                 << " best: " << best_dist << endl;
 109                         if (d <= best_dist) {
 110                                 best_dist = d;
 111                                 result = it;
 112                         }
 113                         if (it == et)
 114                                 break;
 115                         it.forwardPos();
 116                 }
 117                 return result;
 118         }
 119
 120
 121         /// moves position closest to (x, y) in given box
 122         bool bruteFind(LCursor & cursor,
 123                 int x, int y, int xlow, int xhigh, int ylow, int yhigh)
 124         {
 125                 BOOST_ASSERT(!cursor.empty());
 126                 InsetBase & inset = cursor[0].inset();
 127                 BufferView & bv = cursor.bv();
 128
 129                 CoordCache::InnerParPosCache const & cache =
 130                         bv.coordCache().getParPos().find(cursor.bottom().text())->second;
 131                 // Get an iterator on the first paragraph in the cache
 132                 DocIterator it(inset);
 133                 it.push_back(CursorSlice(inset));
 134                 it.pit() = cache.begin()->first;
 135                 // Get an iterator after the last paragraph in the cache
 136                 DocIterator et(inset);
 137                 et.push_back(CursorSlice(inset));
 138                 et.pit() = boost::prior(cache.end())->first;
 139                 if (et.pit() >= et.lastpit())
 140                         et = doc_iterator_end(inset);
 141                 else
 142                         ++et.pit();
 143
 144                 double best_dist = std::numeric_limits<double>::max();;
 145                 DocIterator best_cursor = et;
 146
 147                 for ( ; it != et; it.forwardPos(true)) {
 148                         // avoid invalid nesting when selecting
 149                         if (!cursor.selection() || positionable(it, cursor.anchor_)) {
 150                                 Point p = bv_funcs::getPos(bv, it, false);
 151                                 int xo = p.x_;
 152                                 int yo = p.y_;
 153                                 if (xlow <= xo && xo <= xhigh && ylow <= yo && yo <= yhigh) {
 154                                         double const dx = xo - x;
 155                                         double const dy = yo - y;
 156                                         double const d = dx * dx + dy * dy;
 157                                         // '<=' in order to take the last possible position
 158                                         // this is important for clicking behind \sum in e.g. '\sum_i a'
 159                                         if (d <= best_dist) {
 160                                                 //      lyxerr << "*" << endl;
 161                                                 best_dist   = d;
 162                                                 best_cursor = it;
 163                                         }
 164                                 }
 165                         }
 166                 }
 167
 168                 if (best_cursor != et) {
 169                         cursor.setCursor(best_cursor);
 170                         return true;
 171                 }
 172
 173                 return false;
 174         }
 175
 176
 177         /// moves position closest to (x, y) in given box
 178         bool bruteFind3(LCursor & cur, int x, int y, bool up)
 179         {
 180                 BufferView & bv = cur.bv();
 181                 int ylow  = up ? 0 : y + 1;
 182                 int yhigh = up ? y - 1 : bv.workHeight();
 183                 int xlow = 0;
 184                 int xhigh = bv.workWidth();
 185
 186 // FIXME: bit more work needed to get 'from' and 'to' right.
 187                 pit_type from = cur.bottom().pit();
 188                 //pit_type to = cur.bottom().pit();
 189                 //lyxerr << "Pit start: " << from << endl;
 190
 191                 //lyxerr << "bruteFind3: x: " << x << " y: " << y
 192                 //      << " xlow: " << xlow << " xhigh: " << xhigh
 193                 //      << " ylow: " << ylow << " yhigh: " << yhigh
 194                 //      << endl;
 195                 InsetBase & inset = bv.buffer()->inset();
 196                 DocIterator it = doc_iterator_begin(inset);
 197                 it.pit() = from;
 198                 DocIterator et = doc_iterator_end(inset);
 199
 200                 double best_dist = std::numeric_limits<double>::max();
 201                 DocIterator best_cursor = et;
 202
 203                 for ( ; it != et; it.forwardPos()) {
 204                         // avoid invalid nesting when selecting
 205                         if (bv_funcs::status(&bv, it) == bv_funcs::CUR_INSIDE
 206                             && (!cur.selection() || positionable(it, cur.anchor_))) {
 207                                 Point p = bv_funcs::getPos(bv, it, false);
 208                                 int xo = p.x_;
 209                                 int yo = p.y_;
 210                                 if (xlow <= xo && xo <= xhigh && ylow <= yo && yo <= yhigh) {
 211                                         double const dx = xo - x;
 212                                         double const dy = yo - y;
 213                                         double const d = dx * dx + dy * dy;
 214                                         //lyxerr << "itx: " << xo << " ity: " << yo << " d: " << d
 215                                         //      << " dx: " << dx << " dy: " << dy
 216                                         //      << " idx: " << it.idx() << " pos: " << it.pos()
 217                                         //      << " it:\n" << it
 218                                         //      << endl;
 219                                         // '<=' in order to take the last possible position
 220                                         // this is important for clicking behind \sum in e.g. '\sum_i a'
 221                                         if (d <= best_dist) {
 222                                                 //lyxerr << "*" << endl;
 223                                                 best_dist   = d;
 224                                                 best_cursor = it;
 225                                         }
 226                                 }
 227                         }
 228                 }
 229
 230                 //lyxerr << "best_dist: " << best_dist << " cur:\n" << best_cursor << endl;
 231                 if (best_cursor == et)
 232                         return false;
 233                 cur.setCursor(best_cursor);
 234                 return true;
 235         }
 236
 237 } // namespace anon
 238
 239
 240 // be careful: this is called from the bv's constructor, too, so
 241 // bv functions are not yet available!
 242 LCursor::LCursor(BufferView & bv)
 243         : DocIterator(), bv_(&bv), anchor_(), x_target_(-1),
 244           selection_(false), mark_(false), logicalpos_(false)
 245 {}
 246
 247
 248 void LCursor::reset(InsetBase & inset)
 249 {
 250         clear();
 251         push_back(CursorSlice(inset));
 252         anchor_ = DocIterator(inset);
 253         clearTargetX();
 254         selection_ = false;
 255         mark_ = false;
 256 }
 257
 258
 259 // this (intentionally) does neither touch anchor nor selection status
 260 void LCursor::setCursor(DocIterator const & cur)
 261 {
 262         DocIterator::operator=(cur);
 263 }
 264
 265
 266 void LCursor::dispatch(FuncRequest const & cmd0)
 267 {
 268         lyxerr[Debug::DEBUG] << BOOST_CURRENT_FUNCTION
 269                              << " cmd: " << cmd0 << '\n'
 270                              << *this << endl;
 271         if (empty())
 272                 return;
 273
 274         fixIfBroken();
 275         FuncRequest cmd = cmd0;
 276         LCursor safe = *this;
 277
 278         for (; depth(); pop()) {
 279                 lyxerr[Debug::DEBUG] << "LCursor::dispatch: cmd: "
 280                         << cmd0 << endl << *this << endl;
 281                 BOOST_ASSERT(pos() <= lastpos());
 282                 BOOST_ASSERT(idx() <= lastidx());
 283                 BOOST_ASSERT(pit() <= lastpit());
 284
 285                 // The common case is 'LFUN handled, need update', so make the
 286                 // LFUN handler's life easier by assuming this as default value.
 287                 // The handler can reset the update and val flags if necessary.
 288                 disp_.update(true);
 289                 disp_.dispatched(true);
 290                 inset().dispatch(*this, cmd);
 291                 if (disp_.dispatched())
 292                         break;
 293         }
 294         // it completely to get a 'bomb early' behaviour in case this
 295         // object will be used again.
 296         if (!disp_.dispatched()) {
 297                 lyxerr[Debug::DEBUG] << "RESTORING OLD CURSOR!" << endl;
 298                 operator=(safe);
 299                 disp_.update(false);
 300                 disp_.dispatched(false);
 301         }
 302 }
 303
 304
 305 DispatchResult LCursor::result() const
 306 {
 307         return disp_;
 308 }
 309
 310
 311 BufferView & LCursor::bv() const
 312 {
 313         BOOST_ASSERT(bv_);
 314         return *bv_;
 315 }
 316
 317
 318 Buffer & LCursor::buffer() const
 319 {
 320         BOOST_ASSERT(bv_);
 321         BOOST_ASSERT(bv_->buffer());
 322         return *bv_->buffer();
 323 }
 324
 325
 326 void LCursor::pop()
 327 {
 328         BOOST_ASSERT(depth() >= 1);
 329         pop_back();
 330 }
 331
 332
 333 void LCursor::push(InsetBase & p)
 334 {
 335         push_back(CursorSlice(p));
 336 }
 337
 338
 339 void LCursor::pushLeft(InsetBase & p)
 340 {
 341         BOOST_ASSERT(!empty());
 342         //lyxerr << "Entering inset " << t << " left" << endl;
 343         push(p);
 344         p.idxFirst(*this);
 345 }
 346
 347
 348 bool LCursor::popLeft()
 349 {
 350         BOOST_ASSERT(!empty());
 351         //lyxerr << "Leaving inset to the left" << endl;
 352         inset().notifyCursorLeaves(*this);
 353         if (depth() == 1)
 354                 return false;
 355         pop();
 356         return true;
 357 }
 358
 359
 360 bool LCursor::popRight()
 361 {
 362         BOOST_ASSERT(!empty());
 363         //lyxerr << "Leaving inset to the right" << endl;
 364         inset().notifyCursorLeaves(*this);
 365         if (depth() == 1)
 366                 return false;
 367         pop();
 368         ++pos();
 369         return true;
 370 }
 371
 372
 373 int LCursor::currentMode()
 374 {
 375         BOOST_ASSERT(!empty());
 376         for (int i = depth() - 1; i >= 0; --i) {
 377                 int res = operator[](i).inset().currentMode();
 378                 if (res != InsetBase::UNDECIDED_MODE)
 379                         return res;
 380         }
 381         return InsetBase::TEXT_MODE;
 382 }
 383
 384
 385 void LCursor::getPos(int & x, int & y) const
 386 {
 387         Point p = bv_funcs::getPos(bv(), *this, boundary());
 388         x = p.x_;
 389         y = p.y_;
 390 }
 391
 392
 393 void LCursor::resetAnchor()
 394 {
 395         anchor_ = *this;
 396 }
 397
 398
 399
 400 bool LCursor::posLeft()
 401 {
 402         if (pos() == 0)
 403                 return false;
 404         --pos();
 405         return true;
 406 }
 407
 408
 409 bool LCursor::posRight()
 410 {
 411         if (pos() == lastpos())
 412                 return false;
 413         ++pos();
 414         return true;
 415 }
 416
 417
 418 CursorSlice LCursor::anchor() const
 419 {
 420         BOOST_ASSERT(anchor_.depth() >= depth());
 421         CursorSlice normal = anchor_[depth() - 1];
 422         if (depth() < anchor_.depth() && top() <= normal) {
 423                 // anchor is behind cursor -> move anchor behind the inset
 424                 ++normal.pos();
 425         }
 426         return normal;
 427 }
 428
 429
 430 CursorSlice LCursor::selBegin() const
 431 {
 432         if (!selection())
 433                 return top();
 434         return anchor() < top() ? anchor() : top();
 435 }
 436
 437
 438 CursorSlice LCursor::selEnd() const
 439 {
 440         if (!selection())
 441                 return top();
 442         return anchor() > top() ? anchor() : top();
 443 }
 444
 445
 446 DocIterator LCursor::selectionBegin() const
 447 {
 448         if (!selection())
 449                 return *this;
 450         DocIterator di = (anchor() < top() ? anchor_ : *this);
 451         di.resize(depth());
 452         return di;
 453 }
 454
 455
 456 DocIterator LCursor::selectionEnd() const
 457 {
 458         if (!selection())
 459                 return *this;
 460         DocIterator di = (anchor() > top() ? anchor_ : *this);
 461         if (di.depth() > depth()) {
 462                 di.resize(depth());
 463                 ++di.pos();
 464         }
 465         return di;
 466 }
 467
 468
 469 void LCursor::setSelection()
 470 {
 471         selection() = true;
 472         // A selection with no contents is not a selection
 473 #ifdef WITH_WARNINGS
 474 #warning doesnt look ok
 475 #endif
 476         if (pit() == anchor().pit() && pos() == anchor().pos())
 477                 selection() = false;
 478 }
 479
 480
 481 void LCursor::setSelection(DocIterator const & where, int n)
 482 {
 483         setCursor(where);
 484         selection() = true;
 485         anchor_ = where;
 486         pos() += n;
 487 }
 488
 489
 490 void LCursor::clearSelection()
 491 {
 492         selection() = false;
 493         mark() = false;
 494         resetAnchor();
 495 }
 496
 497
 498 int & LCursor::x_target()
 499 {
 500         return x_target_;
 501 }
 502
 503
 504 int LCursor::x_target() const
 505 {
 506         return x_target_;
 507 }
 508
 509
 510 void LCursor::clearTargetX()
 511 {
 512         x_target_ = -1;
 513 }
 514
 515
 516
 517 void LCursor::info(odocstream & os) const
 518 {
 519         for (int i = 1, n = depth(); i < n; ++i) {
 520                 operator[](i).inset().infoize(os);
 521                 os << "  ";
 522         }
 523         if (pos() != 0)
 524                 prevInset()->infoize2(os);
 525         // overwite old message
 526         os << "                    ";
 527 }
 528
 529
 530 void LCursor::selHandle(bool sel)
 531 {
 532         //lyxerr << "LCursor::selHandle" << endl;
 533         if (sel == selection())
 534                 return;
 535
 536         resetAnchor();
 537         selection() = sel;
 538 }
 539
 540
 541 std::ostream & operator<<(std::ostream & os, LCursor const & cur)
 542 {
 543         os << "\n cursor:                                | anchor:\n";
 544         for (size_t i = 0, n = cur.depth(); i != n; ++i) {
 545                 os << " " << cur[i] << " | ";
 546                 if (i < cur.anchor_.depth())
 547                         os << cur.anchor_[i];
 548                 else
 549                         os << "-------------------------------";
 550                 os << "\n";
 551         }
 552         for (size_t i = cur.depth(), n = cur.anchor_.depth(); i < n; ++i) {
 553                 os << "------------------------------- | " << cur.anchor_[i] << "\n";
 554         }
 555         os << " selection: " << cur.selection_
 556            << " x_target: " << cur.x_target_ << endl;
 557         return os;
 558 }
 559
 560 } // namespace lyx
 561
 562
 563 ///////////////////////////////////////////////////////////////////
 564 //
 565 // The part below is the non-integrated rest of the original math
 566 // cursor. This should be either generalized for texted or moved
 567 // back to mathed (in most cases to InsetMathNest).
 568 //
 569 ///////////////////////////////////////////////////////////////////
 570
 571 #include "mathed/InsetMathChar.h"
 572 #include "mathed/InsetMathGrid.h"
 573 #include "mathed/InsetMathScript.h"
 574 #include "mathed/InsetMathUnknown.h"
 575 #include "mathed/MathFactory.h"
 576 #include "mathed/MathMacroArgument.h"
 577 #include "mathed/MathStream.h"
 578 #include "mathed/MathSupport.h"
 579
 580
 581 namespace lyx {
 582
 583 //#define FILEDEBUG 1
 584
 585
 586 bool LCursor::isInside(InsetBase const * p)
 587 {
 588         for (size_t i = 0; i != depth(); ++i)
 589                 if (&operator[](i).inset() == p)
 590                         return true;
 591         return false;
 592 }
 593
 594
 595 void LCursor::leaveInset(InsetBase const & inset)
 596 {
 597         for (size_t i = 0; i != depth(); ++i) {
 598                 if (&operator[](i).inset() == &inset) {
 599                         resize(i);
 600                         return;
 601                 }
 602         }
 603 }
 604
 605
 606 bool LCursor::openable(MathAtom const & t) const
 607 {
 608         if (!t->isActive())
 609                 return false;
 610
 611         if (t->lock())
 612                 return false;
 613
 614         if (!selection())
 615                 return true;
 616
 617         // we can't move into anything new during selection
 618         if (depth() >= anchor_.depth())
 619                 return false;
 620         if (!ptr_cmp(t.nucleus(), &anchor_[depth()].inset()))
 621                 return false;
 622
 623         return true;
 624 }
 625
 626
 627 void LCursor::setScreenPos(int x, int y)
 628 {
 629         x_target() = x;
 630         bruteFind(*this, x, y, 0, bv().workWidth(), 0, bv().workHeight());
 631 }
 632
 633
 634
 635 void LCursor::plainErase()
 636 {
 637         cell().erase(pos());
 638 }
 639
 640
 641 void LCursor::markInsert()
 642 {
 643         insert(char_type(0));
 644 }
 645
 646
 647 void LCursor::markErase()
 648 {
 649         cell().erase(pos());
 650 }
 651
 652
 653 void LCursor::plainInsert(MathAtom const & t)
 654 {
 655         cell().insert(pos(), t);
 656         ++pos();
 657 }
 658
 659
 660 void LCursor::insert(docstring const & str)
 661 {
 662         for_each(str.begin(), str.end(),
 663                  boost::bind(static_cast<void(LCursor::*)(char_type)>
 664                              (&LCursor::insert), this, _1));
 665 }
 666
 667
 668 void LCursor::insert(char_type c)
 669 {
 670         //lyxerr << "LCursor::insert char '" << c << "'" << endl;
 671         BOOST_ASSERT(!empty());
 672         if (inMathed()) {
 673                 cap::selClearOrDel(*this);
 674                 insert(new InsetMathChar(c));
 675         } else {
 676                 text()->insertChar(*this, c);
 677         }
 678 }
 679
 680
 681 void LCursor::insert(MathAtom const & t)
 682 {
 683         //lyxerr << "LCursor::insert MathAtom '" << t << "'" << endl;
 684         macroModeClose();
 685         cap::selClearOrDel(*this);
 686         plainInsert(t);
 687 }
 688
 689
 690 void LCursor::insert(InsetBase * inset)
 691 {
 692         if (inMathed())
 693                 insert(MathAtom(inset));
 694         else
 695                 text()->insertInset(*this, inset);
 696 }
 697
 698
 699 void LCursor::niceInsert(docstring const & t)
 700 {
 701         MathArray ar;
 702         asArray(t, ar);
 703         if (ar.size() == 1)
 704                 niceInsert(ar[0]);
 705         else
 706                 insert(ar);
 707 }
 708
 709
 710 void LCursor::niceInsert(MathAtom const & t)
 711 {
 712         macroModeClose();
 713         docstring const safe = cap::grabAndEraseSelection(*this);
 714         plainInsert(t);
 715         // enter the new inset and move the contents of the selection if possible
 716         if (t->isActive()) {
 717                 posLeft();
 718                 // be careful here: don't use 'pushLeft(t)' as this we need to
 719                 // push the clone, not the original
 720                 pushLeft(*nextInset());
 721                 // We may not use niceInsert here (recursion)
 722                 MathArray ar;
 723                 asArray(safe, ar);
 724                 insert(ar);
 725         }
 726 }
 727
 728
 729 void LCursor::insert(MathArray const & ar)
 730 {
 731         macroModeClose();
 732         if (selection())
 733                 cap::eraseSelection(*this);
 734         cell().insert(pos(), ar);
 735         pos() += ar.size();
 736 }
 737
 738
 739 bool LCursor::backspace()
 740 {
 741         autocorrect() = false;
 742
 743         if (selection()) {
 744                 cap::selDel(*this);
 745                 return true;
 746         }
 747
 748         if (pos() == 0) {
 749                 if (inset().nargs() == 1 && depth() == 1 && lastpos() == 0)
 750                         return false;
 751                 pullArg();
 752                 return true;
 753         }
 754
 755         if (inMacroMode()) {
 756                 InsetMathUnknown * p = activeMacro();
 757                 if (p->name().size() > 1) {
 758                         p->setName(p->name().substr(0, p->name().size() - 1));
 759                         return true;
 760                 }
 761         }
 762
 763         if (pos() != 0 && prevAtom()->nargs() > 0) {
 764                 // let's require two backspaces for 'big stuff' and
 765                 // highlight on the first
 766                 resetAnchor();
 767                 selection() = true;
 768                 --pos();
 769         } else {
 770                 --pos();
 771                 plainErase();
 772         }
 773         return true;
 774 }
 775
 776
 777 bool LCursor::erase()
 778 {
 779         autocorrect() = false;
 780         if (inMacroMode())
 781                 return true;
 782
 783         if (selection()) {
 784                 cap::selDel(*this);
 785                 return true;
 786         }
 787
 788         // delete empty cells if possible
 789         if (pos() == lastpos() && inset().idxDelete(idx()))
 790                 return true;
 791
 792         // special behaviour when in last position of cell
 793         if (pos() == lastpos()) {
 794                 bool one_cell = inset().nargs() == 1;
 795                 if (one_cell && depth() == 1 && lastpos() == 0)
 796                         return false;
 797                 // remove markup
 798                 if (one_cell)
 799                         pullArg();
 800                 else
 801                         inset().idxGlue(idx());
 802                 return true;
 803         }
 804
 805         // 'clever' UI hack: only erase large items if previously slected
 806         if (pos() != lastpos() && nextAtom()->nargs() > 0) {
 807                 resetAnchor();
 808                 selection() = true;
 809                 ++pos();
 810         } else {
 811                 plainErase();
 812         }
 813
 814         return true;
 815 }
 816
 817
 818 bool LCursor::up()
 819 {
 820         macroModeClose();
 821         DocIterator save = *this;
 822         if (goUpDown(true))
 823                 return true;
 824         setCursor(save);
 825         autocorrect() = false;
 826         return selection();
 827 }
 828
 829
 830 bool LCursor::down()
 831 {
 832         macroModeClose();
 833         DocIterator save = *this;
 834         if (goUpDown(false))
 835                 return true;
 836         setCursor(save);
 837         autocorrect() = false;
 838         return selection();
 839 }
 840
 841
 842 bool LCursor::macroModeClose()
 843 {
 844         if (!inMacroMode())
 845                 return false;
 846         InsetMathUnknown * p = activeMacro();
 847         p->finalize();
 848         docstring const s = p->name();
 849         --pos();
 850         cell().erase(pos());
 851
 852         // do nothing if the macro name is empty
 853         if (s == "\\")
 854                 return false;
 855
 856         // prevent entering of recursive macros
 857         // FIXME: this is only a weak attempt... only prevents immediate
 858         // recursion
 859         docstring const name = s.substr(1);
 860         InsetBase const * macro = innerInsetOfType(InsetBase::MATHMACRO_CODE);
 861         if (macro && macro->getInsetName() == name)
 862                 lyxerr << "can't enter recursive macro" << endl;
 863
 864         InsetMathNest * const in = inset().asInsetMath()->asNestInset();
 865         if (in && in->interpretString(*this, s))
 866                 return true;
 867         plainInsert(createInsetMath(name));
 868         return true;
 869 }
 870
 871
 872 docstring LCursor::macroName()
 873 {
 874         return inMacroMode() ? activeMacro()->name() : docstring();
 875 }
 876
 877
 878 void LCursor::handleNest(MathAtom const & a, int c)
 879 {
 880         //lyxerr << "LCursor::handleNest: " << c << endl;
 881         MathAtom t = a;
 882         asArray(cap::grabAndEraseSelection(*this), t.nucleus()->cell(c));
 883         insert(t);
 884         posLeft();
 885         pushLeft(*nextInset());
 886 }
 887
 888
 889 int LCursor::targetX() const
 890 {
 891         if (x_target() != -1)
 892                 return x_target();
 893         int x = 0;
 894         int y = 0;
 895         getPos(x, y);
 896         return x;
 897 }
 898
 899
 900 void LCursor::setTargetX()
 901 {
 902         // For now this is good enough. A better solution would be to
 903         // avoid this rebreak by setting cursorX only after drawing
 904         bottom().text()->redoParagraph(bottom().pit());
 905         int x;
 906         int y;
 907         getPos(x, y);
 908         x_target_ = x;
 909 }
 910
 911
 912 bool LCursor::inMacroMode() const
 913 {
 914         if (pos() == 0)
 915                 return false;
 916         InsetMathUnknown const * p = prevAtom()->asUnknownInset();
 917         return p && !p->final();
 918 }
 919
 920
 921 InsetMathUnknown * LCursor::activeMacro()
 922 {
 923         return inMacroMode() ? prevAtom().nucleus()->asUnknownInset() : 0;
 924 }
 925
 926
 927 void LCursor::pullArg()
 928 {
 929 #ifdef WITH_WARNINGS
 930 #warning Look here
 931 #endif
 932         MathArray ar = cell();
 933         if (popLeft() && inMathed()) {
 934                 plainErase();
 935                 cell().insert(pos(), ar);
 936                 resetAnchor();
 937         } else {
 938                 //formula()->mutateToText();
 939         }
 940 }
 941
 942
 943 void LCursor::touch()
 944 {
 945 #ifdef WITH_WARNINGS
 946 #warning look here
 947 #endif
 948 #if 0
 949         DocIterator::const_iterator it = begin();
 950         DocIterator::const_iterator et = end();
 951         for ( ; it != et; ++it)
 952                 it->cell().touch();
 953 #endif
 954 }
 955
 956
 957 void LCursor::normalize()
 958 {
 959         if (idx() > lastidx()) {
 960                 lyxerr << "this should not really happen - 1: "
 961                        << idx() << ' ' << nargs()
 962                        << " in: " << &inset() << endl;
 963                 idx() = lastidx();
 964         }
 965
 966         if (pos() > lastpos()) {
 967                 lyxerr << "this should not really happen - 2: "
 968                         << pos() << ' ' << lastpos() <<  " in idx: " << idx()
 969                        << " in atom: '";
 970                 odocstringstream os;
 971                 WriteStream wi(os, false, true);
 972                 inset().asInsetMath()->write(wi);
 973                 lyxerr << to_utf8(os.str()) << endl;
 974                 pos() = lastpos();
 975         }
 976 }
 977
 978
 979 bool LCursor::goUpDown(bool up)
 980 {
 981         // Be warned: The 'logic' implemented in this function is highly
 982         // fragile. A distance of one pixel or a '<' vs '<=' _really
 983         // matters. So fiddle around with it only if you think you know
 984         // what you are doing!
 985
 986         int xo = 0;
 987         int yo = 0;
 988         getPos(xo, yo);
 989
 990         // check if we had something else in mind, if not, this is the future
 991         // target
 992         if (x_target() == -1)
 993                 x_target() = xo;
 994         else
 995                 xo = x_target();
 996
 997         // try neigbouring script insets
 998         if (!selection()) {
 999                 // try left
1000                 if (pos() != 0) {
1001                         InsetMathScript const * p = prevAtom()->asScriptInset();
1002                         if (p && p->has(up)) {
1003                                 --pos();
1004                                 push(*const_cast<InsetMathScript*>(p));
1005                                 idx() = p->idxOfScript(up);
1006                                 pos() = lastpos();
1007                                 return true;
1008                         }
1009                 }
1010
1011                 // try right
1012                 if (pos() != lastpos()) {
1013                         InsetMathScript const * p = nextAtom()->asScriptInset();
1014                         if (p && p->has(up)) {
1015                                 push(*const_cast<InsetMathScript*>(p));
1016                                 idx() = p->idxOfScript(up);
1017                                 pos() = 0;
1018                                 return true;
1019                         }
1020                 }
1021         }
1022
1023 // FIXME: Switch this on for more robust movement
1024 #if 0
1025
1026         return bruteFind3(*this, xo, yo, up);
1027
1028 #else
1029         //xarray().boundingBox(xlow, xhigh, ylow, yhigh);
1030         //if (up)
1031         //      yhigh = yo - 4;
1032         //else
1033         //      ylow = yo + 4;
1034         //if (bruteFind(*this, xo, yo, xlow, xhigh, ylow, yhigh)) {
1035         //      lyxerr << "updown: handled by brute find in the same cell" << endl;
1036         //      return true;
1037         //}
1038
1039         // try to find an inset that knows better then we
1040         while (true) {
1041                 //lyxerr << "updown: We are in " << &inset() << " idx: " << idx() << endl;
1042                 // ask inset first
1043                 if (inset().idxUpDown(*this, up)) {
1044                         //lyxerr << "idxUpDown triggered" << endl;
1045                         // try to find best position within this inset
1046                         if (!selection())
1047                                 setCursor(bruteFind2(*this, xo, yo));
1048                         return true;
1049                 }
1050
1051                 // no such inset found, just take something "above"
1052                 if (!popLeft()) {
1053                         //lyxerr << "updown: popleft failed (strange case)" << endl;
1054                         int ylow  = up ? 0 : yo + 1;
1055                         int yhigh = up ? yo - 1 : bv().workHeight();
1056                         return bruteFind(*this, xo, yo, 0, bv().workWidth(), ylow, yhigh);
1057                 }
1058
1059                 // any improvement so far?
1060                 //lyxerr << "updown: popLeft succeeded" << endl;
1061                 int xnew;
1062                 int ynew;
1063                 getPos(xnew, ynew);
1064                 if (up ? ynew < yo : ynew > yo)
1065                         return true;
1066         }
1067
1068         // we should not come here.
1069         BOOST_ASSERT(false);
1070 #endif
1071 }
1072
1073
1074 void LCursor::handleFont(string const & font)
1075 {
1076         lyxerr[Debug::DEBUG] << BOOST_CURRENT_FUNCTION << ": " << font << endl;
1077         docstring safe;
1078         if (selection()) {
1079                 macroModeClose();
1080                 safe = cap::grabAndEraseSelection(*this);
1081         }
1082
1083         if (lastpos() != 0) {
1084                 // something left in the cell
1085                 if (pos() == 0) {
1086                         // cursor in first position
1087                         popLeft();
1088                 } else if (pos() == lastpos()) {
1089                         // cursor in last position
1090                         popRight();
1091                 } else {
1092                         // cursor in between. split cell
1093                         MathArray::iterator bt = cell().begin();
1094                         MathAtom at = createInsetMath(from_utf8(font));
1095                         at.nucleus()->cell(0) = MathArray(bt, bt + pos());
1096                         cell().erase(bt, bt + pos());
1097                         popLeft();
1098                         plainInsert(at);
1099                 }
1100         } else {
1101                 // nothing left in the cell
1102                 pullArg();
1103                 plainErase();
1104         }
1105         insert(safe);
1106 }
1107
1108
1109 void LCursor::message(docstring const & msg) const
1110 {
1111         theLyXFunc().setMessage(msg);
1112 }
1113
1114
1115 void LCursor::errorMessage(docstring const & msg) const
1116 {
1117         theLyXFunc().setErrorMessage(msg);
1118 }
1119
1120
1121 docstring LCursor::selectionAsString(bool label) const
1122 {
1123         if (!selection())
1124                 return docstring();
1125
1126         if (inTexted()) {
1127                 Buffer const & buffer = *bv().buffer();
1128                 ParagraphList const & pars = text()->paragraphs();
1129
1130                 // should be const ...
1131                 pit_type startpit = selBegin().pit();
1132                 pit_type endpit = selEnd().pit();
1133                 size_t const startpos = selBegin().pos();
1134                 size_t const endpos = selEnd().pos();
1135
1136                 if (startpit == endpit)
1137                         return pars[startpit].asString(buffer, startpos, endpos, label);
1138
1139                 // First paragraph in selection
1140                 docstring result = pars[startpit].
1141                         asString(buffer, startpos, pars[startpit].size(), label) + "\n\n";
1142
1143                 // The paragraphs in between (if any)
1144                 for (pit_type pit = startpit + 1; pit != endpit; ++pit) {
1145                         Paragraph const & par = pars[pit];
1146                         result += par.asString(buffer, 0, par.size(), label) + "\n\n";
1147                 }
1148
1149                 // Last paragraph in selection
1150                 result += pars[endpit].asString(buffer, 0, endpos, label);
1151
1152                 return result;
1153         }
1154
1155         if (inMathed())
1156                 return cap::grabSelection(*this);
1157
1158         return docstring();
1159 }
1160
1161
1162 string LCursor::currentState()
1163 {
1164         if (inMathed()) {
1165                 odocstringstream os;
1166                 info(os);
1167                 return to_utf8(os.str());
1168         }
1169
1170         if (inTexted())
1171                 return text()->currentState(*this);
1172
1173         return string();
1174 }
1175
1176
1177 string LCursor::getPossibleLabel()
1178 {
1179         return inMathed() ? "eq:" : text()->getPossibleLabel(*this);
1180 }
1181
1182
1183 Encoding const * LCursor::getEncoding() const
1184 {
1185         if (empty())
1186                 return 0;
1187         if (!bv().buffer())
1188                 return 0;
1189         int s = 0;
1190         // go up until first non-0 text is hit
1191         // (innermost text is 0 in mathed)
1192         for (s = depth() - 1; s >= 0; --s)
1193                 if (operator[](s).text())
1194                         break;
1195         CursorSlice const & sl = operator[](s);
1196         LyXText const & text = *sl.text();
1197         LyXFont font = text.getPar(sl.pit()).getFont(
1198                 bv().buffer()->params(), sl.pos(), outerFont(sl.pit(), text.paragraphs()));
1199         return font.language()->encoding();
1200 }
1201
1202
1203 void LCursor::undispatched()
1204 {
1205         disp_.dispatched(false);
1206 }
1207
1208
1209 void LCursor::dispatched()
1210 {
1211         disp_.dispatched(true);
1212 }
1213
1214
1215 void LCursor::needsUpdate()
1216 {
1217         disp_.update(true);
1218 }
1219
1220
1221 void LCursor::noUpdate()
1222 {
1223         disp_.update(false);
1224 }
1225
1226
1227 LyXFont LCursor::getFont() const
1228 {
1229         // HACK. far from being perfect...
1230         int s = 0;
1231         // go up until first non-0 text is hit
1232         // (innermost text is 0 in mathed)
1233         for (s = depth() - 1; s >= 0; --s)
1234                 if (operator[](s).text())
1235                         break;
1236         CursorSlice const & sl = operator[](s);
1237         LyXText const & text = *sl.text();
1238         LyXFont font = text.getPar(sl.pit()).getFont(
1239                 bv().buffer()->params(),
1240                 sl.pos(),
1241                 outerFont(sl.pit(), text.paragraphs()));
1242
1243         return font;
1244 }
1245
1246
1247 void LCursor::fixIfBroken()
1248 {
1249         // find out last good level
1250         LCursor copy = *this;
1251         size_t newdepth = depth();
1252         while (!copy.empty()) {
1253                 if (copy.idx() > copy.lastidx()) {
1254                         lyxerr << "wrong idx " << copy.idx()
1255                                << ", max is " << copy.lastidx()
1256                                << " at level " << copy.depth()
1257                                << ". Trying to correct this."  << endl;
1258                         newdepth = copy.depth() - 1;
1259                 }
1260                 else if (copy.pit() > copy.lastpit()) {
1261                         lyxerr << "wrong pit " << copy.pit()
1262                                << ", max is " << copy.lastpit()
1263                                << " at level " << copy.depth()
1264                                << ". Trying to correct this."  << endl;
1265                         newdepth = copy.depth() - 1;
1266                 }
1267                 else if (copy.pos() > copy.lastpos()) {
1268                         lyxerr << "wrong pos " << copy.pos()
1269                                << ", max is " << copy.lastpos()
1270                                << " at level " << copy.depth()
1271                                << ". Trying to correct this."  << endl;
1272                         newdepth = copy.depth() - 1;
1273                 }
1274                 copy.pop();
1275         }
1276         // shrink cursor to a size where everything is valid, possibly
1277         // leaving insets
1278         while (depth() > newdepth) {
1279                 pop();
1280                 lyxerr << "correcting cursor to level " << depth() << endl;
1281         }
1282 }
1283
1284
1285 } // namespace lyx