src/BufferView.cpp

   1 /**
   2  * \file BufferView.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Alfredo Braunstein
   7  * \author Lars Gullik Bjønnes
   8  * \author John Levon
   9  * \author André Pönitz
  10  * \author Jürgen Vigna
  11  *
  12  * Full author contact details are available in file CREDITS.
  13  */
  14
  15 #include <config.h>
  16
  17 #include "BufferView.h"
  18
  19 #include "BranchList.h"
  20 #include "Buffer.h"
  21 #include "buffer_funcs.h"
  22 #include "BufferList.h"
  23 #include "BufferParams.h"
  24 #include "CoordCache.h"
  25 #include "Cursor.h"
  26 #include "CutAndPaste.h"
  27 #include "DispatchResult.h"
  28 #include "ErrorList.h"
  29 #include "factory.h"
  30 #include "FloatList.h"
  31 #include "FuncRequest.h"
  32 #include "FuncStatus.h"
  33 #include "Intl.h"
  34 #include "InsetIterator.h"
  35 #include "Language.h"
  36 #include "LaTeXFeatures.h"
  37 #include "LayoutFile.h"
  38 #include "Length.h"
  39 #include "Lexer.h"
  40 #include "LyX.h"
  41 #include "LyXAction.h"
  42 #include "lyxfind.h"
  43 #include "Layout.h"
  44 #include "LyXRC.h"
  45 #include "MetricsInfo.h"
  46 #include "Paragraph.h"
  47 #include "ParagraphParameters.h"
  48 #include "ParIterator.h"
  49 #include "RowPainter.h"
  50 #include "Session.h"
  51 #include "Text.h"
  52 #include "TextClass.h"
  53 #include "TextMetrics.h"
  54 #include "TexRow.h"
  55 #include "TocBackend.h"
  56 #include "WordLangTuple.h"
  57
  58 #include "insets/InsetBibtex.h"
  59 #include "insets/InsetCitation.h"
  60 #include "insets/InsetCommand.h" // ChangeRefs
  61 #include "insets/InsetExternal.h"
  62 #include "insets/InsetGraphics.h"
  63 #include "insets/InsetNote.h"
  64 #include "insets/InsetRef.h"
  65 #include "insets/InsetText.h"
  66
  67 #include "mathed/MathData.h"
  68
  69 #include "frontends/alert.h"
  70 #include "frontends/Application.h"
  71 #include "frontends/Delegates.h"
  72 #include "frontends/FontMetrics.h"
  73 #include "frontends/Painter.h"
  74 #include "frontends/Selection.h"
  75
  76 #include "support/convert.h"
  77 #include "support/debug.h"
  78 #include "support/ExceptionMessage.h"
  79 #include "support/filetools.h"
  80 #include "support/gettext.h"
  81 #include "support/lassert.h"
  82 #include "support/lstrings.h"
  83 #include "support/Package.h"
  84 #include "support/types.h"
  85
  86 #include <cerrno>
  87 #include <fstream>
  88 #include <functional>
  89 #include <iterator>
  90 #include <sstream>
  91 #include <vector>
  92
  93 using namespace std;
  94 using namespace lyx::support;
  95
  96 namespace lyx {
  97
  98 namespace Alert = frontend::Alert;
  99
 100 namespace {
 101
 102 /// Return an inset of this class if it exists at the current cursor position
 103 template <class T>
 104 T * getInsetByCode(Cursor const & cur, InsetCode code)
 105 {
 106         DocIterator it = cur;
 107         Inset * inset = it.nextInset();
 108         if (inset && inset->lyxCode() == code)
 109                 return static_cast<T*>(inset);
 110         return 0;
 111 }
 112
 113
 114 /// Note that comparing contents can only be used for InsetCommand
 115 bool findNextInset(DocIterator & dit, vector<InsetCode> const & codes,
 116         docstring const & contents)
 117 {
 118         DocIterator tmpdit = dit;
 119
 120         while (tmpdit) {
 121                 Inset const * inset = tmpdit.nextInset();
 122                 if (inset) {
 123                         bool const valid_code = std::find(codes.begin(), codes.end(),
 124                                 inset->lyxCode()) != codes.end();
 125                         InsetCommand const * ic = inset->asInsetCommand();
 126                         bool const same_or_no_contents =  contents.empty()
 127                                 || (ic && (ic->getFirstNonOptParam() == contents));
 128
 129                         if (valid_code && same_or_no_contents) {
 130                                 dit = tmpdit;
 131                                 return true;
 132                         }
 133                 }
 134                 tmpdit.forwardInset();
 135         }
 136
 137         return false;
 138 }
 139
 140
 141 /// Looks for next inset with one of the given codes.
 142 /// Note that same_content can only be used for InsetCommand
 143 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
 144         bool same_content)
 145 {
 146         docstring contents;
 147         DocIterator tmpdit = dit;
 148         tmpdit.forwardInset();
 149         if (!tmpdit)
 150                 return false;
 151
 152         Inset const * inset = tmpdit.nextInset();
 153         if (same_content && inset) {
 154                 InsetCommand const * ic = inset->asInsetCommand();
 155                 if (ic) {
 156                         bool const valid_code = std::find(codes.begin(), codes.end(),
 157                                 ic->lyxCode()) != codes.end();
 158                         if (valid_code)
 159                                 contents = ic->getFirstNonOptParam();
 160                 }
 161         }
 162
 163         if (!findNextInset(tmpdit, codes, contents)) {
 164                 if (dit.depth() != 1 || dit.pit() != 0 || dit.pos() != 0) {
 165                         Inset * inset = &tmpdit.bottom().inset();
 166                         tmpdit = doc_iterator_begin(&inset->buffer(), inset);
 167                         if (!findNextInset(tmpdit, codes, contents))
 168                                 return false;
 169                 } else {
 170                         return false;
 171                 }
 172         }
 173
 174         dit = tmpdit;
 175         return true;
 176 }
 177
 178
 179 /// Looks for next inset with the given code
 180 void findInset(DocIterator & dit, InsetCode code, bool same_content)
 181 {
 182         findInset(dit, vector<InsetCode>(1, code), same_content);
 183 }
 184
 185
 186 /// Moves cursor to the next inset with one of the given codes.
 187 void gotoInset(BufferView * bv, vector<InsetCode> const & codes,
 188                bool same_content)
 189 {
 190         Cursor tmpcur = bv->cursor();
 191         if (!findInset(tmpcur, codes, same_content)) {
 192                 bv->cursor().message(_("No more insets"));
 193                 return;
 194         }
 195
 196         tmpcur.clearSelection();
 197         bv->setCursor(tmpcur);
 198         bv->showCursor();
 199 }
 200
 201
 202 /// Moves cursor to the next inset with given code.
 203 void gotoInset(BufferView * bv, InsetCode code, bool same_content)
 204 {
 205         gotoInset(bv, vector<InsetCode>(1, code), same_content);
 206 }
 207
 208
 209 /// A map from a Text to the associated text metrics
 210 typedef map<Text const *, TextMetrics> TextMetricsCache;
 211
 212 enum ScreenUpdateStrategy {
 213         NoScreenUpdate,
 214         SingleParUpdate,
 215         FullScreenUpdate,
 216         DecorationUpdate
 217 };
 218
 219 } // anon namespace
 220
 221
 222 /////////////////////////////////////////////////////////////////////
 223 //
 224 // BufferView
 225 //
 226 /////////////////////////////////////////////////////////////////////
 227
 228 struct BufferView::Private
 229 {
 230         Private(BufferView & bv) : update_strategy_(NoScreenUpdate),
 231                 wh_(0), cursor_(bv),
 232                 anchor_pit_(0), anchor_ypos_(0),
 233                 inlineCompletionUniqueChars_(0),
 234                 last_inset_(0), clickable_inset_(false),
 235                 mouse_position_cache_(),
 236                 bookmark_edit_position_(-1), gui_(0),
 237                 horiz_scroll_offset_(0)
 238         {
 239                 xsel_cache_.set = false;
 240         }
 241
 242         ///
 243         ScrollbarParameters scrollbarParameters_;
 244         ///
 245         ScreenUpdateStrategy update_strategy_;
 246         ///
 247         CoordCache coord_cache_;
 248
 249         /// Estimated average par height for scrollbar.
 250         int wh_;
 251         /// this is used to handle XSelection events in the right manner.
 252         struct {
 253                 CursorSlice cursor;
 254                 CursorSlice anchor;
 255                 bool set;
 256         } xsel_cache_;
 257         ///
 258         Cursor cursor_;
 259         ///
 260         pit_type anchor_pit_;
 261         ///
 262         int anchor_ypos_;
 263         ///
 264         vector<int> par_height_;
 265
 266         ///
 267         DocIterator inlineCompletionPos_;
 268         ///
 269         docstring inlineCompletion_;
 270         ///
 271         size_t inlineCompletionUniqueChars_;
 272
 273         /// keyboard mapping object.
 274         Intl intl_;
 275
 276         /// last visited inset.
 277         /** kept to send setMouseHover(false).
 278           * Not owned, so don't delete.
 279           */
 280         Inset const * last_inset_;
 281         /// are we hovering something that we can click
 282         bool clickable_inset_;
 283
 284         /// position of the mouse at the time of the last mouse move
 285         /// This is used to update the hovering status of inset in
 286         /// cases where the buffer is scrolled, but the mouse didn't move.
 287         Point mouse_position_cache_;
 288
 289         // cache for id of the paragraph which was edited the last time
 290         int bookmark_edit_position_;
 291
 292         mutable TextMetricsCache text_metrics_;
 293
 294         /// Whom to notify.
 295         /** Not owned, so don't delete.
 296           */
 297         frontend::GuiBufferViewDelegate * gui_;
 298
 299         /// Cache for Find Next
 300         FuncRequest search_request_cache_;
 301
 302         ///
 303         map<string, Inset *> edited_insets_;
 304
 305         /// When the row where the cursor lies is scrolled, this
 306         /// contains the scroll offset
 307         int horiz_scroll_offset_;
 308         /// a slice pointing to the start of the row where the cursor
 309         /// is (at last draw time)
 310         CursorSlice current_row_slice_;
 311         /// a slice pointing to the start of the row where cursor was
 312         /// at previous draw event
 313         CursorSlice last_row_slice_;
 314 };
 315
 316
 317 BufferView::BufferView(Buffer & buf)
 318         : width_(0), height_(0), full_screen_(false), buffer_(buf),
 319       d(new Private(*this))
 320 {
 321         d->xsel_cache_.set = false;
 322         d->intl_.initKeyMapper(lyxrc.use_kbmap);
 323
 324         d->cursor_.setBuffer(&buf);
 325         d->cursor_.push(buffer_.inset());
 326         d->cursor_.resetAnchor();
 327         d->cursor_.setCurrentFont();
 328
 329         buffer_.updatePreviews();
 330 }
 331
 332
 333 BufferView::~BufferView()
 334 {
 335         // current buffer is going to be switched-off, save cursor pos
 336         // Ideally, the whole cursor stack should be saved, but session
 337         // currently can only handle bottom (whole document) level pit and pos.
 338         // That is to say, if a cursor is in a nested inset, it will be
 339         // restore to the left of the top level inset.
 340         LastFilePosSection::FilePos fp;
 341         fp.pit = d->cursor_.bottom().pit();
 342         fp.pos = d->cursor_.bottom().pos();
 343         theSession().lastFilePos().save(buffer_.fileName(), fp);
 344
 345         if (d->last_inset_)
 346                 d->last_inset_->setMouseHover(this, false);
 347
 348         delete d;
 349 }
 350
 351
 352 int BufferView::rightMargin() const
 353 {
 354         // The additional test for the case the outliner is opened.
 355         if (!full_screen_ ||
 356                 !lyxrc.full_screen_limit ||
 357                 width_ < lyxrc.full_screen_width + 20)
 358                         return 10;
 359
 360         return (width_ - lyxrc.full_screen_width) / 2;
 361 }
 362
 363
 364 int BufferView::leftMargin() const
 365 {
 366         return rightMargin();
 367 }
 368
 369
 370 bool BufferView::isTopScreen() const
 371 {
 372         return d->scrollbarParameters_.position == d->scrollbarParameters_.min;
 373 }
 374
 375
 376 bool BufferView::isBottomScreen() const
 377 {
 378         return d->scrollbarParameters_.position == d->scrollbarParameters_.max;
 379 }
 380
 381
 382 Intl & BufferView::getIntl()
 383 {
 384         return d->intl_;
 385 }
 386
 387
 388 Intl const & BufferView::getIntl() const
 389 {
 390         return d->intl_;
 391 }
 392
 393
 394 CoordCache & BufferView::coordCache()
 395 {
 396         return d->coord_cache_;
 397 }
 398
 399
 400 CoordCache const & BufferView::coordCache() const
 401 {
 402         return d->coord_cache_;
 403 }
 404
 405
 406 Buffer & BufferView::buffer()
 407 {
 408         return buffer_;
 409 }
 410
 411
 412 Buffer const & BufferView::buffer() const
 413 {
 414         return buffer_;
 415 }
 416
 417
 418 bool BufferView::needsFitCursor() const
 419 {
 420         if (cursorStatus(d->cursor_) == CUR_INSIDE) {
 421                 frontend::FontMetrics const & fm =
 422                         theFontMetrics(d->cursor_.getFont().fontInfo());
 423                 int const asc = fm.maxAscent();
 424                 int const des = fm.maxDescent();
 425                 Point const p = getPos(d->cursor_);
 426                 if (p.y_ - asc >= 0 && p.y_ + des < height_)
 427                         return false;
 428         }
 429         return true;
 430 }
 431
 432
 433 void BufferView::processUpdateFlags(Update::flags flags)
 434 {
 435         // This is close to a hot-path.
 436         LYXERR(Debug::DEBUG, "BufferView::processUpdateFlags()"
 437                 << "[fitcursor = " << (flags & Update::FitCursor)
 438                 << ", forceupdate = " << (flags & Update::Force)
 439                 << ", singlepar = " << (flags & Update::SinglePar)
 440                 << "]  buffer: " << &buffer_);
 441
 442         // FIXME Does this really need doing here? It's done in updateBuffer, and
 443         // if the Buffer doesn't need updating, then do the macros?
 444         buffer_.updateMacros();
 445
 446         // Now do the first drawing step if needed. This consists on updating
 447         // the CoordCache in updateMetrics().
 448         // The second drawing step is done in WorkArea::redraw() if needed.
 449         // FIXME: is this still true now that Buffer::changed() is used all over?
 450
 451         // Case when no explicit update is requested.
 452         if (!flags) {
 453                 // no need to redraw anything.
 454                 d->update_strategy_ = NoScreenUpdate;
 455                 return;
 456         }
 457
 458         if (flags == Update::Decoration) {
 459                 d->update_strategy_ = DecorationUpdate;
 460                 buffer_.changed(false);
 461                 return;
 462         }
 463
 464         if (flags == Update::FitCursor
 465                 || flags == (Update::Decoration | Update::FitCursor)) {
 466                 // tell the frontend to update the screen if needed.
 467                 if (needsFitCursor()) {
 468                         showCursor();
 469                         return;
 470                 }
 471                 if (flags & Update::Decoration) {
 472                         d->update_strategy_ = DecorationUpdate;
 473                         buffer_.changed(false);
 474                         return;
 475                 }
 476                 // no screen update is needed in principle, but this
 477                 // could change if cursor row needs horizontal scrolling.
 478                 d->update_strategy_ = NoScreenUpdate;
 479                 buffer_.changed(false);
 480                 return;
 481         }
 482
 483         bool const full_metrics = flags & Update::Force || !singleParUpdate();
 484
 485         if (full_metrics)
 486                 // We have to update the full screen metrics.
 487                 updateMetrics();
 488
 489         if (!(flags & Update::FitCursor)) {
 490                 // Nothing to do anymore. Trigger a redraw and return
 491                 buffer_.changed(false);
 492                 return;
 493         }
 494
 495         // updateMetrics() does not update paragraph position
 496         // This is done at draw() time. So we need a redraw!
 497         buffer_.changed(false);
 498
 499         if (needsFitCursor()) {
 500                 // The cursor is off screen so ensure it is visible.
 501                 // refresh it:
 502                 showCursor();
 503         }
 504
 505         updateHoveredInset();
 506 }
 507
 508
 509 void BufferView::updateScrollbar()
 510 {
 511         if (height_ == 0 && width_ == 0)
 512                 return;
 513
 514         // We prefer fixed size line scrolling.
 515         d->scrollbarParameters_.single_step = defaultRowHeight();
 516         // We prefer full screen page scrolling.
 517         d->scrollbarParameters_.page_step = height_;
 518
 519         Text & t = buffer_.text();
 520         TextMetrics & tm = d->text_metrics_[&t];
 521
 522         LYXERR(Debug::GUI, " Updating scrollbar: height: "
 523                 << t.paragraphs().size()
 524                 << " curr par: " << d->cursor_.bottom().pit()
 525                 << " default height " << defaultRowHeight());
 526
 527         size_t const parsize = t.paragraphs().size();
 528         if (d->par_height_.size() != parsize) {
 529                 d->par_height_.clear();
 530                 // FIXME: We assume a default paragraph height of 2 rows. This
 531                 // should probably be pondered with the screen width.
 532                 d->par_height_.resize(parsize, defaultRowHeight() * 2);
 533         }
 534
 535         // Look at paragraph heights on-screen
 536         pair<pit_type, ParagraphMetrics const *> first = tm.first();
 537         pair<pit_type, ParagraphMetrics const *> last = tm.last();
 538         for (pit_type pit = first.first; pit <= last.first; ++pit) {
 539                 d->par_height_[pit] = tm.parMetrics(pit).height();
 540                 LYXERR(Debug::SCROLLING, "storing height for pit " << pit << " : "
 541                         << d->par_height_[pit]);
 542         }
 543
 544         int top_pos = first.second->position() - first.second->ascent();
 545         int bottom_pos = last.second->position() + last.second->descent();
 546         bool first_visible = first.first == 0 && top_pos >= 0;
 547         bool last_visible = last.first + 1 == int(parsize) && bottom_pos <= height_;
 548         if (first_visible && last_visible) {
 549                 d->scrollbarParameters_.min = 0;
 550                 d->scrollbarParameters_.max = 0;
 551                 return;
 552         }
 553
 554         d->scrollbarParameters_.min = top_pos;
 555         for (size_t i = 0; i != size_t(first.first); ++i)
 556                 d->scrollbarParameters_.min -= d->par_height_[i];
 557         d->scrollbarParameters_.max = bottom_pos;
 558         for (size_t i = last.first + 1; i != parsize; ++i)
 559                 d->scrollbarParameters_.max += d->par_height_[i];
 560
 561         d->scrollbarParameters_.position = 0;
 562         // The reference is the top position so we remove one page.
 563         if (lyxrc.scroll_below_document)
 564                 d->scrollbarParameters_.max -= minVisiblePart();
 565         else
 566                 d->scrollbarParameters_.max -= d->scrollbarParameters_.page_step;
 567 }
 568
 569
 570 ScrollbarParameters const & BufferView::scrollbarParameters() const
 571 {
 572         return d->scrollbarParameters_;
 573 }
 574
 575
 576 docstring BufferView::toolTip(int x, int y) const
 577 {
 578         // Get inset under mouse, if there is one.
 579         Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
 580         if (!covering_inset)
 581                 // No inset, no tooltip...
 582                 return docstring();
 583         return covering_inset->toolTip(*this, x, y);
 584 }
 585
 586
 587 string BufferView::contextMenu(int x, int y) const
 588 {
 589         //If there is a selection, return the containing inset menu
 590         if (d->cursor_.selection())
 591                 return d->cursor_.inset().contextMenu(*this, x, y);
 592
 593         // Get inset under mouse, if there is one.
 594         Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
 595         if (covering_inset)
 596                 return covering_inset->contextMenu(*this, x, y);
 597
 598         return buffer_.inset().contextMenu(*this, x, y);
 599 }
 600
 601
 602 void BufferView::scrollDocView(int value, bool update)
 603 {
 604         int const offset = value - d->scrollbarParameters_.position;
 605
 606         // No scrolling at all? No need to redraw anything
 607         if (offset == 0)
 608                 return;
 609
 610         // If the offset is less than 2 screen height, prefer to scroll instead.
 611         if (abs(offset) <= 2 * height_) {
 612                 d->anchor_ypos_ -= offset;
 613                 buffer_.changed(true);
 614                 updateHoveredInset();
 615                 return;
 616         }
 617
 618         // cut off at the top
 619         if (value <= d->scrollbarParameters_.min) {
 620                 DocIterator dit = doc_iterator_begin(&buffer_);
 621                 showCursor(dit, false, update);
 622                 LYXERR(Debug::SCROLLING, "scroll to top");
 623                 return;
 624         }
 625
 626         // cut off at the bottom
 627         if (value >= d->scrollbarParameters_.max) {
 628                 DocIterator dit = doc_iterator_end(&buffer_);
 629                 dit.backwardPos();
 630                 showCursor(dit, false, update);
 631                 LYXERR(Debug::SCROLLING, "scroll to bottom");
 632                 return;
 633         }
 634
 635         // find paragraph at target position
 636         int par_pos = d->scrollbarParameters_.min;
 637         pit_type i = 0;
 638         for (; i != int(d->par_height_.size()); ++i) {
 639                 par_pos += d->par_height_[i];
 640                 if (par_pos >= value)
 641                         break;
 642         }
 643
 644         if (par_pos < value) {
 645                 // It seems we didn't find the correct pit so stay on the safe side and
 646                 // scroll to bottom.
 647                 LYXERR0("scrolling position not found!");
 648                 scrollDocView(d->scrollbarParameters_.max, update);
 649                 return;
 650         }
 651
 652         DocIterator dit = doc_iterator_begin(&buffer_);
 653         dit.pit() = i;
 654         LYXERR(Debug::SCROLLING, "value = " << value << " -> scroll to pit " << i);
 655         showCursor(dit, false, update);
 656 }
 657
 658
 659 // FIXME: this method is not working well.
 660 void BufferView::setCursorFromScrollbar()
 661 {
 662         TextMetrics & tm = d->text_metrics_[&buffer_.text()];
 663
 664         int const height = 2 * defaultRowHeight();
 665         int const first = height;
 666         int const last = height_ - height;
 667         int newy = 0;
 668         Cursor const & oldcur = d->cursor_;
 669
 670         switch (cursorStatus(oldcur)) {
 671         case CUR_ABOVE:
 672                 newy = first;
 673                 break;
 674         case CUR_BELOW:
 675                 newy = last;
 676                 break;
 677         case CUR_INSIDE:
 678                 int const y = getPos(oldcur).y_;
 679                 newy = min(last, max(y, first));
 680                 if (y == newy)
 681                         return;
 682         }
 683         // We reset the cursor because cursorStatus() does not
 684         // work when the cursor is within mathed.
 685         Cursor cur(*this);
 686         cur.reset();
 687         tm.setCursorFromCoordinates(cur, 0, newy);
 688
 689         // update the bufferview cursor and notify insets
 690         // FIXME: Care about the d->cursor_ flags to redraw if needed
 691         Cursor old = d->cursor_;
 692         mouseSetCursor(cur);
 693         // the DEPM call in mouseSetCursor() might have destroyed the
 694         // paragraph the cursor is in.
 695         bool badcursor = old.fixIfBroken();
 696         badcursor |= notifyCursorLeavesOrEnters(old, d->cursor_);
 697         if (badcursor)
 698                 d->cursor_.fixIfBroken();
 699 }
 700
 701
 702 Change const BufferView::getCurrentChange() const
 703 {
 704         if (!d->cursor_.selection())
 705                 return Change(Change::UNCHANGED);
 706
 707         DocIterator dit = d->cursor_.selectionBegin();
 708         // The selected content might have been changed (see #7685)
 709         while (dit.inMathed())
 710                 // Find enclosing text cursor
 711                 dit.pop_back();
 712         return dit.paragraph().lookupChange(dit.pos());
 713 }
 714
 715
 716 // this could be used elsewhere as well?
 717 // FIXME: This does not work within mathed!
 718 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
 719 {
 720         Point const p = getPos(dit);
 721         if (p.y_ < 0)
 722                 return CUR_ABOVE;
 723         if (p.y_ > workHeight())
 724                 return CUR_BELOW;
 725         return CUR_INSIDE;
 726 }
 727
 728
 729 void BufferView::bookmarkEditPosition()
 730 {
 731         // Don't eat cpu time for each keystroke
 732         if (d->cursor_.paragraph().id() == d->bookmark_edit_position_)
 733                 return;
 734         saveBookmark(0);
 735         d->bookmark_edit_position_ = d->cursor_.paragraph().id();
 736 }
 737
 738
 739 void BufferView::saveBookmark(unsigned int idx)
 740 {
 741         // tentatively save bookmark, id and pos will be used to
 742         // acturately locate a bookmark in a 'live' lyx session.
 743         // pit and pos will be updated with bottom level pit/pos
 744         // when lyx exits.
 745         if (!buffer_.isInternal()) {
 746                 theSession().bookmarks().save(
 747                         buffer_.fileName(),
 748                         d->cursor_.bottom().pit(),
 749                         d->cursor_.bottom().pos(),
 750                         d->cursor_.paragraph().id(),
 751                         d->cursor_.pos(),
 752                         idx
 753                         );
 754                 if (idx)
 755                         // emit message signal.
 756                         message(_("Save bookmark"));
 757         }
 758 }
 759
 760
 761 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
 762         int top_id, pos_type top_pos)
 763 {
 764         bool success = false;
 765         DocIterator dit;
 766
 767         d->cursor_.clearSelection();
 768
 769         // if a valid par_id is given, try it first
 770         // This is the case for a 'live' bookmark when unique paragraph ID
 771         // is used to track bookmarks.
 772         if (top_id > 0) {
 773                 dit = buffer_.getParFromID(top_id);
 774                 if (!dit.atEnd()) {
 775                         dit.pos() = min(dit.paragraph().size(), top_pos);
 776                         // Some slices of the iterator may not be
 777                         // reachable (e.g. closed collapsable inset)
 778                         // so the dociterator may need to be
 779                         // shortened. Otherwise, setCursor may crash
 780                         // lyx when the cursor can not be set to these
 781                         // insets.
 782                         size_t const n = dit.depth();
 783                         for (size_t i = 0; i < n; ++i)
 784                                 if (!dit[i].inset().editable()) {
 785                                         dit.resize(i);
 786                                         break;
 787                                 }
 788                         success = true;
 789                 }
 790         }
 791
 792         // if top_id == 0, or searching through top_id failed
 793         // This is the case for a 'restored' bookmark when only bottom
 794         // (document level) pit was saved. Because of this, bookmark
 795         // restoration is inaccurate. If a bookmark was within an inset,
 796         // it will be restored to the left of the outmost inset that contains
 797         // the bookmark.
 798         if (bottom_pit < int(buffer_.paragraphs().size())) {
 799                 dit = doc_iterator_begin(&buffer_);
 800
 801                 dit.pit() = bottom_pit;
 802                 dit.pos() = min(bottom_pos, dit.paragraph().size());
 803                 success = true;
 804         }
 805
 806         if (success) {
 807                 // Note: only bottom (document) level pit is set.
 808                 setCursor(dit);
 809                 // set the current font.
 810                 d->cursor_.setCurrentFont();
 811                 // To center the screen on this new position we need the
 812                 // paragraph position which is computed at draw() time.
 813                 // So we need a redraw!
 814                 buffer_.changed(false);
 815                 if (needsFitCursor())
 816                         showCursor();
 817         }
 818
 819         return success;
 820 }
 821
 822
 823 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
 824 {
 825         if (d->cursor_.real_current_font.isRightToLeft()) {
 826                 if (d->intl_.keymap == Intl::PRIMARY)
 827                         d->intl_.keyMapSec();
 828         } else {
 829                 if (d->intl_.keymap == Intl::SECONDARY)
 830                         d->intl_.keyMapPrim();
 831         }
 832
 833         d->intl_.getTransManager().translateAndInsert(c, t, cur);
 834 }
 835
 836
 837 int BufferView::workWidth() const
 838 {
 839         return width_;
 840 }
 841
 842
 843 void BufferView::recenter()
 844 {
 845         showCursor(d->cursor_, true, true);
 846 }
 847
 848
 849 void BufferView::showCursor()
 850 {
 851         showCursor(d->cursor_, false, true);
 852 }
 853
 854
 855 void BufferView::showCursor(DocIterator const & dit,
 856         bool recenter, bool update)
 857 {
 858         if (scrollToCursor(dit, recenter) && update) {
 859                 buffer_.changed(true);
 860                 updateHoveredInset();
 861         }
 862 }
 863
 864
 865 void BufferView::scrollToCursor()
 866 {
 867         if (scrollToCursor(d->cursor_, false)) {
 868                 buffer_.changed(true);
 869                 updateHoveredInset();
 870         }
 871 }
 872
 873
 874 bool BufferView::scrollToCursor(DocIterator const & dit, bool recenter)
 875 {
 876         // We are not properly started yet, delay until resizing is
 877         // done.
 878         if (height_ == 0)
 879                 return false;
 880
 881         LYXERR(Debug::SCROLLING, "recentering!");
 882
 883         CursorSlice const & bot = dit.bottom();
 884         TextMetrics & tm = d->text_metrics_[bot.text()];
 885
 886         pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
 887         int bot_pit = bot.pit();
 888         if (bot_pit > max_pit) {
 889                 // FIXME: Why does this happen?
 890                 LYXERR0("bottom pit is greater that max pit: "
 891                         << bot_pit << " > " << max_pit);
 892                 bot_pit = max_pit;
 893         }
 894
 895         if (bot_pit == tm.first().first - 1)
 896                 tm.newParMetricsUp();
 897         else if (bot_pit == tm.last().first + 1)
 898                 tm.newParMetricsDown();
 899
 900         if (tm.contains(bot_pit)) {
 901                 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
 902                 LBUFERR(!pm.rows().empty());
 903                 // FIXME: smooth scrolling doesn't work in mathed.
 904                 CursorSlice const & cs = dit.innerTextSlice();
 905                 int offset = coordOffset(dit).y_;
 906                 int ypos = pm.position() + offset;
 907                 Dimension const & row_dim =
 908                         pm.getRow(cs.pos(), dit.boundary()).dimension();
 909                 int scrolled = 0;
 910                 if (recenter)
 911                         scrolled = scroll(ypos - height_/2);
 912
 913                 // We try to visualize the whole row, if the row height is larger than
 914                 // the screen height, we scroll to a heuristic value of height_ / 4.
 915                 // FIXME: This heuristic value should be replaced by a recursive search
 916                 // for a row in the inset that can be visualized completely.
 917                 else if (row_dim.height() > height_) {
 918                         if (ypos < defaultRowHeight())
 919                                 scrolled = scroll(ypos - height_ / 4);
 920                         else if (ypos > height_ - defaultRowHeight())
 921                                 scrolled = scroll(ypos - 3 * height_ / 4);
 922                 }
 923
 924                 // If the top part of the row falls of the screen, we scroll
 925                 // up to align the top of the row with the top of the screen.
 926                 else if (ypos - row_dim.ascent() < 0 && ypos < height_) {
 927                         int ynew = row_dim.ascent();
 928                         scrolled = scrollUp(ynew - ypos);
 929                 }
 930
 931                 // If the bottom of the row falls of the screen, we scroll down.
 932                 else if (ypos + row_dim.descent() > height_ && ypos > 0) {
 933                         int ynew = height_ - row_dim.descent();
 934                         scrolled = scrollDown(ypos - ynew);
 935                 }
 936
 937                 // else, nothing to do, the cursor is already visible so we just return.
 938                 return scrolled != 0;
 939         }
 940
 941         // fix inline completion position
 942         if (d->inlineCompletionPos_.fixIfBroken())
 943                 d->inlineCompletionPos_ = DocIterator();
 944
 945         tm.redoParagraph(bot_pit);
 946         ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
 947         int offset = coordOffset(dit).y_;
 948
 949         d->anchor_pit_ = bot_pit;
 950         CursorSlice const & cs = dit.innerTextSlice();
 951         Dimension const & row_dim =
 952                 pm.getRow(cs.pos(), dit.boundary()).dimension();
 953
 954         if (recenter)
 955                 d->anchor_ypos_ = height_/2;
 956         else if (d->anchor_pit_ == 0)
 957                 d->anchor_ypos_ = offset + pm.ascent();
 958         else if (d->anchor_pit_ == max_pit)
 959                 d->anchor_ypos_ = height_ - offset - row_dim.descent();
 960         else if (offset > height_)
 961                 d->anchor_ypos_ = height_ - offset - defaultRowHeight();
 962         else
 963                 d->anchor_ypos_ = defaultRowHeight() * 2;
 964
 965         return true;
 966 }
 967
 968
 969 void BufferView::makeDocumentClass()
 970 {
 971         DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
 972         buffer_.params().makeDocumentClass();
 973         updateDocumentClass(olddc);
 974 }
 975
 976
 977 void BufferView::updateDocumentClass(DocumentClassConstPtr olddc)
 978 {
 979         message(_("Converting document to new document class..."));
 980
 981         StableDocIterator backcur(d->cursor_);
 982         ErrorList & el = buffer_.errorList("Class Switch");
 983         cap::switchBetweenClasses(
 984                         olddc, buffer_.params().documentClassPtr(),
 985                         static_cast<InsetText &>(buffer_.inset()), el);
 986
 987         setCursor(backcur.asDocIterator(&buffer_));
 988
 989         buffer_.errors("Class Switch");
 990 }
 991
 992
 993 /** Return the change status at cursor position, taking into account the
 994  * status at each level of the document iterator (a table in a deleted
 995  * footnote is deleted).
 996  * When \param outer is true, the top slice is not looked at.
 997  */
 998 static Change::Type lookupChangeType(DocIterator const & dit, bool outer = false)
 999 {
1000         size_t const depth = dit.depth() - (outer ? 1 : 0);
1001
1002         for (size_t i = 0 ; i < depth ; ++i) {
1003                 CursorSlice const & slice = dit[i];
1004                 if (!slice.inset().inMathed()
1005                     && slice.pos() < slice.paragraph().size()) {
1006                         Change::Type const ch = slice.paragraph().lookupChange(slice.pos()).type;
1007                         if (ch != Change::UNCHANGED)
1008                                 return ch;
1009                 }
1010         }
1011         return Change::UNCHANGED;
1012 }
1013
1014
1015 bool BufferView::getStatus(FuncRequest const & cmd, FuncStatus & flag)
1016 {
1017         FuncCode const act = cmd.action();
1018
1019         // Can we use a readonly buffer?
1020         if (buffer_.isReadonly()
1021             && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1022             && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1023                 flag.message(from_utf8(N_("Document is read-only")));
1024                 flag.setEnabled(false);
1025                 return true;
1026         }
1027
1028         // Are we in a DELETED change-tracking region?
1029         if (lookupChangeType(d->cursor_, true) == Change::DELETED
1030             && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1031             && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1032                 flag.message(from_utf8(N_("This portion of the document is deleted.")));
1033                 flag.setEnabled(false);
1034                 return true;
1035         }
1036
1037         Cursor & cur = d->cursor_;
1038
1039         if (cur.getStatus(cmd, flag))
1040                 return true;
1041
1042         switch (act) {
1043
1044         // FIXME: This is a bit problematic because we don't check if this is
1045         // a document BufferView or not for these LFUNs. We probably have to
1046         // dispatch both to currentBufferView() and, if that fails,
1047         // to documentBufferView(); same as we do now for current Buffer and
1048         // document Buffer. Ideally those LFUN should go to Buffer as they
1049         // operate on the full Buffer and the cursor is only needed either for
1050         // an Undo record or to restore a cursor position. But we don't know
1051         // how to do that inside Buffer of course.
1052         case LFUN_BUFFER_PARAMS_APPLY:
1053         case LFUN_LAYOUT_MODULES_CLEAR:
1054         case LFUN_LAYOUT_MODULE_ADD:
1055         case LFUN_LAYOUT_RELOAD:
1056         case LFUN_TEXTCLASS_APPLY:
1057         case LFUN_TEXTCLASS_LOAD:
1058                 flag.setEnabled(!buffer_.isReadonly());
1059                 break;
1060
1061         case LFUN_UNDO:
1062                 // We do not use the LyXAction flag for readonly because Undo sets the
1063                 // buffer clean/dirty status by itself.
1064                 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasUndoStack());
1065                 break;
1066         case LFUN_REDO:
1067                 // We do not use the LyXAction flag for readonly because Redo sets the
1068                 // buffer clean/dirty status by itself.
1069                 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasRedoStack());
1070                 break;
1071         case LFUN_FILE_INSERT_PLAINTEXT_PARA:
1072         case LFUN_FILE_INSERT_PLAINTEXT: {
1073                 docstring const fname = cmd.argument();
1074                 if (!FileName::isAbsolute(to_utf8(fname))) {
1075                         flag.message(_("Absolute filename expected."));
1076                         return false;
1077                 }
1078                 flag.setEnabled(cur.inTexted());
1079                 break;
1080         }
1081         case LFUN_FILE_INSERT:
1082         case LFUN_BOOKMARK_SAVE:
1083                 // FIXME: Actually, these LFUNS should be moved to Text
1084                 flag.setEnabled(cur.inTexted());
1085                 break;
1086
1087         case LFUN_FONT_STATE:
1088         case LFUN_LABEL_INSERT:
1089         case LFUN_INFO_INSERT:
1090         case LFUN_PARAGRAPH_GOTO:
1091         case LFUN_NOTE_NEXT:
1092         case LFUN_REFERENCE_NEXT:
1093         case LFUN_WORD_FIND:
1094         case LFUN_WORD_FIND_FORWARD:
1095         case LFUN_WORD_FIND_BACKWARD:
1096         case LFUN_WORD_REPLACE:
1097         case LFUN_MARK_OFF:
1098         case LFUN_MARK_ON:
1099         case LFUN_MARK_TOGGLE:
1100         case LFUN_SCREEN_RECENTER:
1101         case LFUN_SCREEN_SHOW_CURSOR:
1102         case LFUN_BIBTEX_DATABASE_ADD:
1103         case LFUN_BIBTEX_DATABASE_DEL:
1104         case LFUN_STATISTICS:
1105         case LFUN_KEYMAP_OFF:
1106         case LFUN_KEYMAP_PRIMARY:
1107         case LFUN_KEYMAP_SECONDARY:
1108         case LFUN_KEYMAP_TOGGLE:
1109         case LFUN_INSET_SELECT_ALL:
1110                 flag.setEnabled(true);
1111                 break;
1112
1113         case LFUN_WORD_FINDADV: {
1114                 FindAndReplaceOptions opt;
1115                 istringstream iss(to_utf8(cmd.argument()));
1116                 iss >> opt;
1117                 flag.setEnabled(opt.repl_buf_name.empty()
1118                                 || !buffer_.isReadonly());
1119                 break;
1120         }
1121
1122         case LFUN_LABEL_GOTO:
1123                 flag.setEnabled(!cmd.argument().empty()
1124                     || getInsetByCode<InsetRef>(cur, REF_CODE));
1125                 break;
1126
1127         case LFUN_CHANGES_MERGE:
1128         case LFUN_CHANGE_NEXT:
1129         case LFUN_CHANGE_PREVIOUS:
1130         case LFUN_ALL_CHANGES_ACCEPT:
1131         case LFUN_ALL_CHANGES_REJECT:
1132                 // TODO: context-sensitive enabling of LFUNs
1133                 // In principle, these command should only be enabled if there
1134                 // is a change in the document. However, without proper
1135                 // optimizations, this will inevitably result in poor performance.
1136                 flag.setEnabled(true);
1137                 break;
1138
1139         case LFUN_SCREEN_UP:
1140         case LFUN_SCREEN_DOWN:
1141         case LFUN_SCROLL:
1142         case LFUN_SCREEN_UP_SELECT:
1143         case LFUN_SCREEN_DOWN_SELECT:
1144         case LFUN_INSET_FORALL:
1145                 flag.setEnabled(true);
1146                 break;
1147
1148         case LFUN_LAYOUT_TABULAR:
1149                 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
1150                 break;
1151
1152         case LFUN_LAYOUT:
1153                 flag.setEnabled(!cur.inset().forcePlainLayout(cur.idx()));
1154                 break;
1155
1156         case LFUN_LAYOUT_PARAGRAPH:
1157                 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
1158                 break;
1159
1160         case LFUN_BRANCH_ADD_INSERT:
1161                 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1162                 break;
1163
1164         case LFUN_DIALOG_SHOW_NEW_INSET:
1165                 // FIXME: this is wrong, but I do not understand the
1166                 // intent (JMarc)
1167                 if (cur.inset().lyxCode() == CAPTION_CODE)
1168                         return cur.inset().getStatus(cur, cmd, flag);
1169                 // FIXME we should consider passthru paragraphs too.
1170                 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1171                 break;
1172
1173         case LFUN_CITATION_INSERT: {
1174                 FuncRequest fr(LFUN_INSET_INSERT, "citation");
1175                 // FIXME: This could turn in a recursive hell.
1176                 // Shouldn't we use Buffer::getStatus() instead?
1177                 flag.setEnabled(lyx::getStatus(fr).enabled());
1178                 break;
1179         }
1180         case LFUN_INSET_APPLY: {
1181                 string const name = cmd.getArg(0);
1182                 Inset * inset = editedInset(name);
1183                 if (inset) {
1184                         FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1185                         if (!inset->getStatus(cur, fr, flag)) {
1186                                 // Every inset is supposed to handle this
1187                                 LASSERT(false, break);
1188                         }
1189                 } else {
1190                         FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1191                         flag = lyx::getStatus(fr);
1192                 }
1193                 break;
1194         }
1195
1196         default:
1197                 return false;
1198         }
1199
1200         return true;
1201 }
1202
1203
1204 Inset * BufferView::editedInset(string const & name) const
1205 {
1206         map<string, Inset *>::const_iterator it = d->edited_insets_.find(name);
1207         return it == d->edited_insets_.end() ? 0 : it->second;
1208 }
1209
1210
1211 void BufferView::editInset(string const & name, Inset * inset)
1212 {
1213         d->edited_insets_[name] = inset;
1214 }
1215
1216
1217 void BufferView::dispatch(FuncRequest const & cmd, DispatchResult & dr)
1218 {
1219         LYXERR(Debug::ACTION, "BufferView::dispatch: cmd: " << cmd);
1220
1221         string const argument = to_utf8(cmd.argument());
1222         Cursor & cur = d->cursor_;
1223         Cursor old = cur;
1224
1225         // Don't dispatch function that does not apply to internal buffers.
1226         if (buffer_.isInternal()
1227             && lyxaction.funcHasFlag(cmd.action(), LyXAction::NoInternal))
1228                 return;
1229
1230         // We'll set this back to false if need be.
1231         bool dispatched = true;
1232         buffer_.undo().beginUndoGroup();
1233
1234         FuncCode const act = cmd.action();
1235         switch (act) {
1236
1237         case LFUN_BUFFER_PARAMS_APPLY: {
1238                 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1239                 cur.recordUndoBufferParams();
1240                 istringstream ss(to_utf8(cmd.argument()));
1241                 Lexer lex;
1242                 lex.setStream(ss);
1243                 int const unknown_tokens = buffer_.readHeader(lex);
1244                 if (unknown_tokens != 0) {
1245                         LYXERR0("Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1246                                                 << unknown_tokens << " unknown token"
1247                                                 << (unknown_tokens == 1 ? "" : "s"));
1248                 }
1249                 updateDocumentClass(olddc);
1250
1251                 // We are most certainly here because of a change in the document
1252                 // It is then better to make sure that all dialogs are in sync with
1253                 // current document settings.
1254                 dr.screenUpdate(Update::Force | Update::FitCursor);
1255                 dr.forceBufferUpdate();
1256                 break;
1257         }
1258
1259         case LFUN_LAYOUT_MODULES_CLEAR: {
1260                 // FIXME: this modifies the document in cap::switchBetweenClasses
1261                 //  without calling recordUndo. Fix this before using
1262                 //  recordUndoBufferParams().
1263                 cur.recordUndoFullBuffer();
1264                 buffer_.params().clearLayoutModules();
1265                 makeDocumentClass();
1266                 dr.screenUpdate(Update::Force);
1267                 dr.forceBufferUpdate();
1268                 break;
1269         }
1270
1271         case LFUN_LAYOUT_MODULE_ADD: {
1272                 BufferParams const & params = buffer_.params();
1273                 if (!params.layoutModuleCanBeAdded(argument)) {
1274                         LYXERR0("Module `" << argument <<
1275                                 "' cannot be added due to failed requirements or "
1276                                 "conflicts with installed modules.");
1277                         break;
1278                 }
1279                 // FIXME: this modifies the document in cap::switchBetweenClasses
1280                 //  without calling recordUndo. Fix this before using
1281                 //  recordUndoBufferParams().
1282                 cur.recordUndoFullBuffer();
1283                 buffer_.params().addLayoutModule(argument);
1284                 makeDocumentClass();
1285                 dr.screenUpdate(Update::Force);
1286                 dr.forceBufferUpdate();
1287                 break;
1288         }
1289
1290         case LFUN_TEXTCLASS_APPLY: {
1291                 // since this shortcircuits, the second call is made only if
1292                 // the first fails
1293                 bool const success =
1294                         LayoutFileList::get().load(argument, buffer_.temppath()) ||
1295                         LayoutFileList::get().load(argument, buffer_.filePath());
1296                 if (!success) {
1297                         docstring s = bformat(_("The document class `%1$s' "
1298                                                  "could not be loaded."), from_utf8(argument));
1299                         frontend::Alert::error(_("Could not load class"), s);
1300                         break;
1301                 }
1302
1303                 LayoutFile const * old_layout = buffer_.params().baseClass();
1304                 LayoutFile const * new_layout = &(LayoutFileList::get()[argument]);
1305
1306                 if (old_layout == new_layout)
1307                         // nothing to do
1308                         break;
1309
1310                 // Save the old, possibly modular, layout for use in conversion.
1311                 // FIXME: this modifies the document in cap::switchBetweenClasses
1312                 //  without calling recordUndo. Fix this before using
1313                 //  recordUndoBufferParams().
1314                 cur.recordUndoFullBuffer();
1315                 buffer_.params().setBaseClass(argument);
1316                 makeDocumentClass();
1317                 dr.screenUpdate(Update::Force);
1318                 dr.forceBufferUpdate();
1319                 break;
1320         }
1321
1322         case LFUN_TEXTCLASS_LOAD: {
1323                 // since this shortcircuits, the second call is made only if
1324                 // the first fails
1325                 bool const success =
1326                         LayoutFileList::get().load(argument, buffer_.temppath()) ||
1327                         LayoutFileList::get().load(argument, buffer_.filePath());
1328                 if (!success) {
1329                         docstring s = bformat(_("The document class `%1$s' "
1330                                                  "could not be loaded."), from_utf8(argument));
1331                         frontend::Alert::error(_("Could not load class"), s);
1332                 }
1333                 break;
1334         }
1335
1336         case LFUN_LAYOUT_RELOAD: {
1337                 LayoutFileIndex bc = buffer_.params().baseClassID();
1338                 LayoutFileList::get().reset(bc);
1339                 buffer_.params().setBaseClass(bc);
1340                 makeDocumentClass();
1341                 dr.screenUpdate(Update::Force);
1342                 dr.forceBufferUpdate();
1343                 break;
1344         }
1345
1346         case LFUN_UNDO:
1347                 dr.setMessage(_("Undo"));
1348                 cur.clearSelection();
1349                 if (!cur.textUndo())
1350                         dr.setMessage(_("No further undo information"));
1351                 else
1352                         dr.screenUpdate(Update::Force | Update::FitCursor);
1353                 dr.forceBufferUpdate();
1354                 break;
1355
1356         case LFUN_REDO:
1357                 dr.setMessage(_("Redo"));
1358                 cur.clearSelection();
1359                 if (!cur.textRedo())
1360                         dr.setMessage(_("No further redo information"));
1361                 else
1362                         dr.screenUpdate(Update::Force | Update::FitCursor);
1363                 dr.forceBufferUpdate();
1364                 break;
1365
1366         case LFUN_FONT_STATE:
1367                 dr.setMessage(cur.currentState());
1368                 break;
1369
1370         case LFUN_BOOKMARK_SAVE:
1371                 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1372                 break;
1373
1374         case LFUN_LABEL_GOTO: {
1375                 docstring label = cmd.argument();
1376                 if (label.empty()) {
1377                         InsetRef * inset =
1378                                 getInsetByCode<InsetRef>(cur, REF_CODE);
1379                         if (inset) {
1380                                 label = inset->getParam("reference");
1381                                 // persistent=false: use temp_bookmark
1382                                 saveBookmark(0);
1383                         }
1384                 }
1385                 if (!label.empty()) {
1386                         gotoLabel(label);
1387                         // at the moment, this is redundant, since gotoLabel will
1388                         // eventually call LFUN_PARAGRAPH_GOTO, but it seems best
1389                         // to have it here.
1390                         dr.screenUpdate(Update::Force | Update::FitCursor);
1391                 }
1392                 break;
1393         }
1394
1395         case LFUN_PARAGRAPH_GOTO: {
1396                 int const id = convert<int>(cmd.getArg(0));
1397                 int const pos = convert<int>(cmd.getArg(1));
1398                 int i = 0;
1399                 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1400                         b = theBufferList().next(b)) {
1401
1402                         Cursor cur(*this);
1403                         cur.setCursor(b->getParFromID(id));
1404                         if (cur.atEnd()) {
1405                                 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1406                                 ++i;
1407                                 continue;
1408                         }
1409                         LYXERR(Debug::INFO, "Paragraph " << cur.paragraph().id()
1410                                 << " found in buffer `"
1411                                 << b->absFileName() << "'.");
1412
1413                         if (b == &buffer_) {
1414                                 // Set the cursor
1415                                 cur.pos() = pos;
1416                                 mouseSetCursor(cur);
1417                                 dr.screenUpdate(Update::Force | Update::FitCursor);
1418                         } else {
1419                                 // Switch to other buffer view and resend cmd
1420                                 lyx::dispatch(FuncRequest(
1421                                         LFUN_BUFFER_SWITCH, b->absFileName()));
1422                                 lyx::dispatch(cmd);
1423                         }
1424                         break;
1425                 }
1426                 break;
1427         }
1428
1429         case LFUN_NOTE_NEXT:
1430                 gotoInset(this, NOTE_CODE, false);
1431                 break;
1432
1433         case LFUN_REFERENCE_NEXT: {
1434                 vector<InsetCode> tmp;
1435                 tmp.push_back(LABEL_CODE);
1436                 tmp.push_back(REF_CODE);
1437                 gotoInset(this, tmp, true);
1438                 break;
1439         }
1440
1441         case LFUN_CHANGE_NEXT:
1442                 findNextChange(this);
1443                 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1444                 dr.screenUpdate(Update::Force | Update::FitCursor);
1445                 break;
1446
1447         case LFUN_CHANGE_PREVIOUS:
1448                 findPreviousChange(this);
1449                 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1450                 dr.screenUpdate(Update::Force | Update::FitCursor);
1451                 break;
1452
1453         case LFUN_CHANGES_MERGE:
1454                 if (findNextChange(this) || findPreviousChange(this)) {
1455                         dr.screenUpdate(Update::Force | Update::FitCursor);
1456                         dr.forceBufferUpdate();
1457                         showDialog("changes");
1458                 }
1459                 break;
1460
1461         case LFUN_ALL_CHANGES_ACCEPT:
1462                 // select complete document
1463                 cur.reset();
1464                 cur.selHandle(true);
1465                 buffer_.text().cursorBottom(cur);
1466                 // accept everything in a single step to support atomic undo
1467                 buffer_.text().acceptOrRejectChanges(cur, Text::ACCEPT);
1468                 cur.resetAnchor();
1469                 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1470                 dr.screenUpdate(Update::Force | Update::FitCursor);
1471                 dr.forceBufferUpdate();
1472                 break;
1473
1474         case LFUN_ALL_CHANGES_REJECT:
1475                 // select complete document
1476                 cur.reset();
1477                 cur.selHandle(true);
1478                 buffer_.text().cursorBottom(cur);
1479                 // reject everything in a single step to support atomic undo
1480                 // Note: reject does not work recursively; the user may have to repeat the operation
1481                 buffer_.text().acceptOrRejectChanges(cur, Text::REJECT);
1482                 cur.resetAnchor();
1483                 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1484                 dr.screenUpdate(Update::Force | Update::FitCursor);
1485                 dr.forceBufferUpdate();
1486                 break;
1487
1488         case LFUN_WORD_FIND_FORWARD:
1489         case LFUN_WORD_FIND_BACKWARD: {
1490                 // FIXME THREAD
1491                 // Would it maybe be better if this variable were view specific anyway?
1492                 static docstring last_search;
1493                 docstring searched_string;
1494
1495                 if (!cmd.argument().empty()) {
1496                         last_search = cmd.argument();
1497                         searched_string = cmd.argument();
1498                 } else {
1499                         searched_string = last_search;
1500                 }
1501
1502                 if (searched_string.empty())
1503                         break;
1504
1505                 bool const fw = act == LFUN_WORD_FIND_FORWARD;
1506                 docstring const data =
1507                         find2string(searched_string, true, false, fw);
1508                 bool found = lyxfind(this, FuncRequest(LFUN_WORD_FIND, data));
1509                 if (found) {
1510                         dr.screenUpdate(Update::Force | Update::FitCursor);
1511                         cur.dispatched();
1512                         dispatched = true;
1513                 } else {
1514                         cur.undispatched();
1515                         dispatched = false;
1516                 }
1517                 break;
1518         }
1519
1520         case LFUN_WORD_FIND: {
1521                 FuncRequest req = cmd;
1522                 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1523                         req = d->search_request_cache_;
1524                 if (req.argument().empty()) {
1525                         lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, "findreplace"));
1526                         break;
1527                 }
1528                 if (lyxfind(this, req)) {
1529                         dr.screenUpdate(Update::Force | Update::FitCursor);
1530                         cur.dispatched();
1531                         dispatched = true;
1532                 } else {
1533                         cur.undispatched();
1534                         dispatched = false;
1535                 }
1536                 d->search_request_cache_ = req;
1537                 break;
1538         }
1539
1540         case LFUN_WORD_REPLACE: {
1541                 bool has_deleted = false;
1542                 if (cur.selection()) {
1543                         DocIterator beg = cur.selectionBegin();
1544                         DocIterator end = cur.selectionEnd();
1545                         if (beg.pit() == end.pit()) {
1546                                 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1547                                         if (!cur.inMathed() && cur.paragraph().isDeleted(p)) {
1548                                                 has_deleted = true;
1549                                                 break;
1550                                         }
1551                                 }
1552                         }
1553                 }
1554                 if (lyxreplace(this, cmd, has_deleted)) {
1555                         dr.forceBufferUpdate();
1556                         dr.screenUpdate(Update::Force | Update::FitCursor);
1557                         cur.dispatched();
1558                         dispatched = true;
1559                 } else {
1560                         cur.undispatched();
1561                         dispatched = false;
1562                 }
1563                 break;
1564         }
1565
1566         case LFUN_WORD_FINDADV: {
1567                 FindAndReplaceOptions opt;
1568                 istringstream iss(to_utf8(cmd.argument()));
1569                 iss >> opt;
1570                 if (findAdv(this, opt)) {
1571                         dr.screenUpdate(Update::Force | Update::FitCursor);
1572                         cur.dispatched();
1573                         dispatched = true;
1574                 } else {
1575                         cur.undispatched();
1576                         dispatched = false;
1577                 }
1578                 break;
1579         }
1580
1581         case LFUN_MARK_OFF:
1582                 cur.clearSelection();
1583                 dr.setMessage(from_utf8(N_("Mark off")));
1584                 break;
1585
1586         case LFUN_MARK_ON:
1587                 cur.clearSelection();
1588                 cur.setMark(true);
1589                 dr.setMessage(from_utf8(N_("Mark on")));
1590                 break;
1591
1592         case LFUN_MARK_TOGGLE:
1593                 cur.setSelection(false);
1594                 if (cur.mark()) {
1595                         cur.setMark(false);
1596                         dr.setMessage(from_utf8(N_("Mark removed")));
1597                 } else {
1598                         cur.setMark(true);
1599                         dr.setMessage(from_utf8(N_("Mark set")));
1600                 }
1601                 cur.resetAnchor();
1602                 break;
1603
1604         case LFUN_SCREEN_SHOW_CURSOR:
1605                 showCursor();
1606                 break;
1607
1608         case LFUN_SCREEN_RECENTER:
1609                 recenter();
1610                 break;
1611
1612         case LFUN_BIBTEX_DATABASE_ADD: {
1613                 Cursor tmpcur = cur;
1614                 findInset(tmpcur, BIBTEX_CODE, false);
1615                 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1616                                                 BIBTEX_CODE);
1617                 if (inset) {
1618                         if (inset->addDatabase(cmd.argument())) {
1619                                 buffer_.invalidateBibfileCache();
1620                                 dr.forceBufferUpdate();
1621                         }
1622                 }
1623                 break;
1624         }
1625
1626         case LFUN_BIBTEX_DATABASE_DEL: {
1627                 Cursor tmpcur = cur;
1628                 findInset(tmpcur, BIBTEX_CODE, false);
1629                 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1630                                                 BIBTEX_CODE);
1631                 if (inset) {
1632                         if (inset->delDatabase(cmd.argument())) {
1633                                 buffer_.invalidateBibfileCache();
1634                                 dr.forceBufferUpdate();
1635                         }
1636                 }
1637                 break;
1638         }
1639
1640         case LFUN_STATISTICS: {
1641                 DocIterator from, to;
1642                 if (cur.selection()) {
1643                         from = cur.selectionBegin();
1644                         to = cur.selectionEnd();
1645                 } else {
1646                         from = doc_iterator_begin(&buffer_);
1647                         to = doc_iterator_end(&buffer_);
1648                 }
1649                 buffer_.updateStatistics(from, to);
1650                 int const words = buffer_.wordCount();
1651                 int const chars = buffer_.charCount(false);
1652                 int const chars_blanks = buffer_.charCount(true);
1653                 docstring message;
1654                 if (cur.selection())
1655                         message = _("Statistics for the selection:");
1656                 else
1657                         message = _("Statistics for the document:");
1658                 message += "\n\n";
1659                 if (words != 1)
1660                         message += bformat(_("%1$d words"), words);
1661                 else
1662                         message += _("One word");
1663                 message += "\n";
1664                 if (chars_blanks != 1)
1665                         message += bformat(_("%1$d characters (including blanks)"),
1666                                           chars_blanks);
1667                 else
1668                         message += _("One character (including blanks)");
1669                 message += "\n";
1670                 if (chars != 1)
1671                         message += bformat(_("%1$d characters (excluding blanks)"),
1672                                           chars);
1673                 else
1674                         message += _("One character (excluding blanks)");
1675
1676                 Alert::information(_("Statistics"), message);
1677         }
1678                 break;
1679
1680         case LFUN_SCREEN_UP:
1681         case LFUN_SCREEN_DOWN: {
1682                 Point p = getPos(cur);
1683                 // This code has been commented out to enable to scroll down a
1684                 // document, even if there are large insets in it (see bug #5465).
1685                 /*if (p.y_ < 0 || p.y_ > height_) {
1686                         // The cursor is off-screen so recenter before proceeding.
1687                         showCursor();
1688                         p = getPos(cur);
1689                 }*/
1690                 int const scrolled = scroll(act == LFUN_SCREEN_UP
1691                         ? -height_ : height_);
1692                 if (act == LFUN_SCREEN_UP && scrolled > -height_)
1693                         p = Point(0, 0);
1694                 if (act == LFUN_SCREEN_DOWN && scrolled < height_)
1695                         p = Point(width_, height_);
1696                 bool const in_texted = cur.inTexted();
1697                 cur.setCursor(doc_iterator_begin(cur.buffer()));
1698                 cur.selHandle(false);
1699                 buffer_.changed(true);
1700                 updateHoveredInset();
1701
1702                 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_,
1703                         true, act == LFUN_SCREEN_UP);
1704                 //FIXME: what to do with cur.x_target()?
1705                 bool update = in_texted && cur.bv().checkDepm(cur, old);
1706                 cur.finishUndo();
1707
1708                 if (update || cur.mark())
1709                         dr.screenUpdate(Update::Force | Update::FitCursor);
1710                 if (update)
1711                         dr.forceBufferUpdate();
1712                 break;
1713         }
1714
1715         case LFUN_SCROLL: {
1716                 string const scroll_type = cmd.getArg(0);
1717                 int scroll_step = 0;
1718                 if (scroll_type == "line")
1719                         scroll_step = d->scrollbarParameters_.single_step;
1720                 else if (scroll_type == "page")
1721                         scroll_step = d->scrollbarParameters_.page_step;
1722                 else
1723                         return;
1724                 string const scroll_quantity = cmd.getArg(1);
1725                 if (scroll_quantity == "up")
1726                         scrollUp(scroll_step);
1727                 else if (scroll_quantity == "down")
1728                         scrollDown(scroll_step);
1729                 else {
1730                         int const scroll_value = convert<int>(scroll_quantity);
1731                         if (scroll_value)
1732                                 scroll(scroll_step * scroll_value);
1733                 }
1734                 buffer_.changed(true);
1735                 updateHoveredInset();
1736                 dr.forceBufferUpdate();
1737                 break;
1738         }
1739
1740         case LFUN_SCREEN_UP_SELECT: {
1741                 // FIXME: why is the algorithm different from LFUN_SCREEN_UP?
1742                 cur.selHandle(true);
1743                 if (isTopScreen()) {
1744                         lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1745                         cur.finishUndo();
1746                         break;
1747                 }
1748                 int y = getPos(cur).y_;
1749                 int const ymin = y - height_ + defaultRowHeight();
1750                 while (y > ymin && cur.up())
1751                         y = getPos(cur).y_;
1752
1753                 cur.finishUndo();
1754                 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1755                 break;
1756         }
1757
1758         case LFUN_SCREEN_DOWN_SELECT: {
1759                 // FIXME: why is the algorithm different from LFUN_SCREEN_DOWN?
1760                 cur.selHandle(true);
1761                 if (isBottomScreen()) {
1762                         lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1763                         cur.finishUndo();
1764                         break;
1765                 }
1766                 int y = getPos(cur).y_;
1767                 int const ymax = y + height_ - defaultRowHeight();
1768                 while (y < ymax && cur.down())
1769                         y = getPos(cur).y_;
1770
1771                 cur.finishUndo();
1772                 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1773                 break;
1774         }
1775
1776
1777         case LFUN_INSET_SELECT_ALL:
1778                 if (cur.depth() > 1
1779                     && cur.selBegin().at_begin()
1780                     && cur.selEnd().at_end()) {
1781                         // All the contents of the inset if selected.
1782                         // Select the inset from outside.
1783                         cur.pop();
1784                         cur.resetAnchor();
1785                         cur.setSelection(true);
1786                         cur.posForward();
1787                 } else if (cur.selBegin().idx() != cur.selEnd().idx()
1788                            || (cur.depth() > 1
1789                                    && cur.selBegin().at_cell_begin()
1790                                && cur.selEnd().at_cell_end())) {
1791                         // At least one complete cell is selected.
1792                         // Select all cells
1793                         cur.idx() = 0;
1794                         cur.pos() = 0;
1795                         cur.resetAnchor();
1796                         cur.setSelection(true);
1797                         cur.idx() = cur.lastidx();
1798                         cur.pos() = cur.lastpos();
1799                 } else {
1800                         // select current cell
1801                         cur.pit() = 0;
1802                         cur.pos() = 0;
1803                         cur.resetAnchor();
1804                         cur.setSelection(true);
1805                         cur.pit() = cur.lastpit();
1806                         cur.pos() = cur.lastpos();
1807                 }
1808                 cur.setCurrentFont();
1809                 dr.screenUpdate(Update::Force);
1810                 break;
1811
1812
1813         // This would be in Buffer class if only Cursor did not
1814         // require a bufferview
1815         case LFUN_INSET_FORALL: {
1816                 docstring const name = from_utf8(cmd.getArg(0));
1817                 string const commandstr = cmd.getLongArg(1);
1818                 FuncRequest const fr = lyxaction.lookupFunc(commandstr);
1819
1820                 // an arbitrary number to limit number of iterations
1821                 const int max_iter = 100000;
1822                 int iterations = 0;
1823                 Cursor & cur = d->cursor_;
1824                 Cursor const savecur = cur;
1825                 cur.reset();
1826                 if (!cur.nextInset())
1827                         cur.forwardInset();
1828                 cur.beginUndoGroup();
1829                 while(cur && iterations < max_iter) {
1830                         Inset * const ins = cur.nextInset();
1831                         if (!ins)
1832                                 break;
1833                         docstring insname = ins->layoutName();
1834                         while (!insname.empty()) {
1835                                 if (insname == name || name == from_utf8("*")) {
1836                                         cur.recordUndo();
1837                                         lyx::dispatch(fr, dr);
1838                                         ++iterations;
1839                                         break;
1840                                 }
1841                                 size_t const i = insname.rfind(':');
1842                                 if (i == string::npos)
1843                                         break;
1844                                 insname = insname.substr(0, i);
1845                         }
1846                         // if we did not delete the inset, skip it
1847                         if (!cur.nextInset() || cur.nextInset() == ins)
1848                                 cur.forwardInset();
1849                 }
1850                 cur.endUndoGroup();
1851                 cur = savecur;
1852                 cur.fixIfBroken();
1853                 dr.screenUpdate(Update::Force);
1854                 dr.forceBufferUpdate();
1855
1856                 if (iterations >= max_iter) {
1857                         dr.setError(true);
1858                         dr.setMessage(bformat(_("`inset-forall' interrupted because number of actions is larger than %1$d"), max_iter));
1859                 } else
1860                         dr.setMessage(bformat(_("Applied \"%1$s\" to %2$d insets"), from_utf8(commandstr), iterations));
1861                 break;
1862         }
1863
1864
1865         case LFUN_BRANCH_ADD_INSERT: {
1866                 docstring branch_name = from_utf8(cmd.getArg(0));
1867                 if (branch_name.empty())
1868                         if (!Alert::askForText(branch_name, _("Branch name")) ||
1869                                                 branch_name.empty())
1870                                 break;
1871
1872                 DispatchResult drtmp;
1873                 buffer_.dispatch(FuncRequest(LFUN_BRANCH_ADD, branch_name), drtmp);
1874                 if (drtmp.error()) {
1875                         Alert::warning(_("Branch already exists"), drtmp.message());
1876                         break;
1877                 }
1878                 BranchList & branch_list = buffer_.params().branchlist();
1879                 vector<docstring> const branches =
1880                         getVectorFromString(branch_name, branch_list.separator());
1881                 for (vector<docstring>::const_iterator it = branches.begin();
1882                      it != branches.end(); ++it) {
1883                         branch_name = *it;
1884                         lyx::dispatch(FuncRequest(LFUN_BRANCH_INSERT, branch_name));
1885                 }
1886                 break;
1887         }
1888
1889         case LFUN_KEYMAP_OFF:
1890                 getIntl().keyMapOn(false);
1891                 break;
1892
1893         case LFUN_KEYMAP_PRIMARY:
1894                 getIntl().keyMapPrim();
1895                 break;
1896
1897         case LFUN_KEYMAP_SECONDARY:
1898                 getIntl().keyMapSec();
1899                 break;
1900
1901         case LFUN_KEYMAP_TOGGLE:
1902                 getIntl().toggleKeyMap();
1903                 break;
1904
1905         case LFUN_DIALOG_SHOW_NEW_INSET: {
1906                 string const name = cmd.getArg(0);
1907                 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
1908                 if (decodeInsetParam(name, data, buffer_))
1909                         lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
1910                 else
1911                         lyxerr << "Inset type '" << name <<
1912                         "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" <<  endl;
1913                 break;
1914         }
1915
1916         case LFUN_CITATION_INSERT: {
1917                 if (argument.empty()) {
1918                         lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
1919                         break;
1920                 }
1921                 // we can have one optional argument, delimited by '|'
1922                 // citation-insert <key>|<text_before>
1923                 // this should be enhanced to also support text_after
1924                 // and citation style
1925                 string arg = argument;
1926                 string opt1;
1927                 if (contains(argument, "|")) {
1928                         arg = token(argument, '|', 0);
1929                         opt1 = token(argument, '|', 1);
1930                 }
1931
1932                 // if our cursor is directly in front of or behind a citation inset,
1933                 // we will instead add the new key to it.
1934                 Inset * inset = cur.nextInset();
1935                 if (!inset || inset->lyxCode() != CITE_CODE)
1936                         inset = cur.prevInset();
1937                 if (inset && inset->lyxCode() == CITE_CODE) {
1938                         InsetCitation * icite = static_cast<InsetCitation *>(inset);
1939                         if (icite->addKey(arg)) {
1940                                 dr.forceBufferUpdate();
1941                                 dr.screenUpdate(Update::FitCursor | Update::SinglePar);
1942                                 if (!opt1.empty())
1943                                         LYXERR0("Discarding optional argument to citation-insert.");
1944                         }
1945                         dispatched = true;
1946                         break;
1947                 }
1948                 InsetCommandParams icp(CITE_CODE);
1949                 icp["key"] = from_utf8(arg);
1950                 if (!opt1.empty())
1951                         icp["before"] = from_utf8(opt1);
1952                 string icstr = InsetCommand::params2string(icp);
1953                 FuncRequest fr(LFUN_INSET_INSERT, icstr);
1954                 lyx::dispatch(fr);
1955                 break;
1956         }
1957
1958         case LFUN_INSET_APPLY: {
1959                 string const name = cmd.getArg(0);
1960                 Inset * inset = editedInset(name);
1961                 if (!inset) {
1962                         FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1963                         lyx::dispatch(fr);
1964                         break;
1965                 }
1966                 // put cursor in front of inset.
1967                 if (!setCursorFromInset(inset)) {
1968                         LASSERT(false, break);
1969                 }
1970                 cur.recordUndo();
1971                 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1972                 inset->dispatch(cur, fr);
1973                 dr.screenUpdate(cur.result().screenUpdate());
1974                 if (cur.result().needBufferUpdate())
1975                         dr.forceBufferUpdate();
1976                 break;
1977         }
1978
1979         // FIXME:
1980         // The change of language of buffer belongs to the Buffer class.
1981         // We have to do it here because we need a cursor for Undo.
1982         // When Undo::recordUndoBufferParams() is implemented someday
1983         // LFUN_BUFFER_LANGUAGE should be handled by the Buffer class.
1984         case LFUN_BUFFER_LANGUAGE: {
1985                 Language const * oldL = buffer_.params().language;
1986                 Language const * newL = languages.getLanguage(argument);
1987                 if (!newL || oldL == newL)
1988                         break;
1989                 if (oldL->rightToLeft() == newL->rightToLeft()) {
1990                         cur.recordUndoFullBuffer();
1991                         buffer_.changeLanguage(oldL, newL);
1992                         cur.setCurrentFont();
1993                         dr.forceBufferUpdate();
1994                 }
1995                 break;
1996         }
1997
1998         case LFUN_FILE_INSERT_PLAINTEXT_PARA:
1999         case LFUN_FILE_INSERT_PLAINTEXT: {
2000                 bool const as_paragraph = (act == LFUN_FILE_INSERT_PLAINTEXT_PARA);
2001                 string const fname = to_utf8(cmd.argument());
2002                 if (!FileName::isAbsolute(fname))
2003                         dr.setMessage(_("Absolute filename expected."));
2004                 else
2005                         insertPlaintextFile(FileName(fname), as_paragraph);
2006                 break;
2007         }
2008
2009         default:
2010                 // OK, so try the Buffer itself...
2011                 buffer_.dispatch(cmd, dr);
2012                 dispatched = dr.dispatched();
2013                 break;
2014         }
2015
2016         buffer_.undo().endUndoGroup();
2017         dr.dispatched(dispatched);
2018
2019         // NOTE: The code below is copied from Cursor::dispatch. If you
2020         // need to modify this, please update the other one too.
2021
2022         // notify insets we just entered/left
2023         if (cursor() != old) {
2024                 old.beginUndoGroup();
2025                 old.fixIfBroken();
2026                 bool badcursor = notifyCursorLeavesOrEnters(old, cursor());
2027                 if (badcursor) {
2028                         cursor().fixIfBroken();
2029                         resetInlineCompletionPos();
2030                 }
2031                 old.endUndoGroup();
2032         }
2033 }
2034
2035
2036 docstring const BufferView::requestSelection()
2037 {
2038         Cursor & cur = d->cursor_;
2039
2040         LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
2041         if (!cur.selection()) {
2042                 d->xsel_cache_.set = false;
2043                 return docstring();
2044         }
2045
2046         LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
2047         if (!d->xsel_cache_.set ||
2048             cur.top() != d->xsel_cache_.cursor ||
2049             cur.realAnchor().top() != d->xsel_cache_.anchor)
2050         {
2051                 d->xsel_cache_.cursor = cur.top();
2052                 d->xsel_cache_.anchor = cur.realAnchor().top();
2053                 d->xsel_cache_.set = cur.selection();
2054                 return cur.selectionAsString(false);
2055         }
2056         return docstring();
2057 }
2058
2059
2060 void BufferView::clearSelection()
2061 {
2062         d->cursor_.clearSelection();
2063         // Clear the selection buffer. Otherwise a subsequent
2064         // middle-mouse-button paste would use the selection buffer,
2065         // not the more current external selection.
2066         cap::clearSelection();
2067         d->xsel_cache_.set = false;
2068         // The buffer did not really change, but this causes the
2069         // redraw we need because we cleared the selection above.
2070         buffer_.changed(false);
2071 }
2072
2073
2074 void BufferView::resize(int width, int height)
2075 {
2076         // Update from work area
2077         width_ = width;
2078         height_ = height;
2079
2080         // Clear the paragraph height cache.
2081         d->par_height_.clear();
2082         // Redo the metrics.
2083         updateMetrics();
2084 }
2085
2086
2087 Inset const * BufferView::getCoveringInset(Text const & text,
2088                 int x, int y) const
2089 {
2090         TextMetrics & tm = d->text_metrics_[&text];
2091         Inset * inset = tm.checkInsetHit(x, y);
2092         if (!inset)
2093                 return 0;
2094
2095         if (!inset->descendable(*this))
2096                 // No need to go further down if the inset is not
2097                 // descendable.
2098                 return inset;
2099
2100         size_t cell_number = inset->nargs();
2101         // Check all the inner cell.
2102         for (size_t i = 0; i != cell_number; ++i) {
2103                 Text const * inner_text = inset->getText(i);
2104                 if (inner_text) {
2105                         // Try deeper.
2106                         Inset const * inset_deeper =
2107                                 getCoveringInset(*inner_text, x, y);
2108                         if (inset_deeper)
2109                                 return inset_deeper;
2110                 }
2111         }
2112
2113         return inset;
2114 }
2115
2116
2117 void BufferView::updateHoveredInset() const
2118 {
2119         // Get inset under mouse, if there is one.
2120         int const x = d->mouse_position_cache_.x_;
2121         int const y = d->mouse_position_cache_.y_;
2122         Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
2123
2124         d->clickable_inset_ = covering_inset && covering_inset->clickable(x, y);
2125
2126         if (covering_inset == d->last_inset_)
2127                 // Same inset, no need to do anything...
2128                 return;
2129
2130         bool need_redraw = false;
2131         if (d->last_inset_) {
2132                 // Remove the hint on the last hovered inset (if any).
2133                 need_redraw |= d->last_inset_->setMouseHover(this, false);
2134                 d->last_inset_ = 0;
2135         }
2136
2137         if (covering_inset && covering_inset->setMouseHover(this, true)) {
2138                 need_redraw = true;
2139                 // Only the insets that accept the hover state, do
2140                 // clear the last_inset_, so only set the last_inset_
2141                 // member if the hovered setting is accepted.
2142                 d->last_inset_ = covering_inset;
2143         }
2144
2145         if (need_redraw) {
2146                 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
2147                                 << d->mouse_position_cache_.x_ << ", "
2148                                 << d->mouse_position_cache_.y_ << ")");
2149
2150                 d->update_strategy_ = DecorationUpdate;
2151
2152                 // This event (moving without mouse click) is not passed further.
2153                 // This should be changed if it is further utilized.
2154                 buffer_.changed(false);
2155         }
2156 }
2157
2158
2159 void BufferView::clearLastInset(Inset * inset) const
2160 {
2161         if (d->last_inset_ != inset) {
2162                 LYXERR0("Wrong last_inset!");
2163                 LATTEST(false);
2164         }
2165         d->last_inset_ = 0;
2166 }
2167
2168
2169 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
2170 {
2171         //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
2172
2173         // This is only called for mouse related events including
2174         // LFUN_FILE_OPEN generated by drag-and-drop.
2175         FuncRequest cmd = cmd0;
2176
2177         Cursor old = cursor();
2178         Cursor cur(*this);
2179         cur.push(buffer_.inset());
2180         cur.setSelection(d->cursor_.selection());
2181
2182         // Either the inset under the cursor or the
2183         // surrounding Text will handle this event.
2184
2185         // make sure we stay within the screen...
2186         cmd.set_y(min(max(cmd.y(), -1), height_));
2187
2188         d->mouse_position_cache_.x_ = cmd.x();
2189         d->mouse_position_cache_.y_ = cmd.y();
2190
2191         if (cmd.action() == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
2192                 updateHoveredInset();
2193                 return;
2194         }
2195
2196         // Build temporary cursor.
2197         Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x(), cmd.y());
2198         if (inset) {
2199                 // If inset is not editable, cur.pos() might point behind the
2200                 // inset (depending on cmd.x(), cmd.y()). This is needed for
2201                 // editing to fix bug 9628, but e.g. the context menu needs a
2202                 // cursor in front of the inset.
2203                 if (inset->hasSettings() &&
2204                     cur.nextInset() != inset && cur.prevInset() == inset)
2205                         cur.backwardPos();
2206         }
2207
2208         // Put anchor at the same position.
2209         cur.resetAnchor();
2210
2211         cur.beginUndoGroup();
2212
2213         // Try to dispatch to an non-editable inset near this position
2214         // via the temp cursor. If the inset wishes to change the real
2215         // cursor it has to do so explicitly by using
2216         //  cur.bv().cursor() = cur;  (or similar)
2217         if (inset)
2218                 inset->dispatch(cur, cmd);
2219
2220         // Now dispatch to the temporary cursor. If the real cursor should
2221         // be modified, the inset's dispatch has to do so explicitly.
2222         if (!inset || !cur.result().dispatched())
2223                 cur.dispatch(cmd);
2224
2225         cur.endUndoGroup();
2226
2227         // Notify left insets
2228         if (cur != old) {
2229                 bool badcursor = old.fixIfBroken() | cur.fixIfBroken();
2230                 badcursor |= notifyCursorLeavesOrEnters(old, cur);
2231                 if (badcursor)
2232                         cursor().fixIfBroken();
2233         }
2234
2235         // Do we have a selection?
2236         theSelection().haveSelection(cursor().selection());
2237
2238         if (cur.needBufferUpdate()) {
2239                 cur.clearBufferUpdate();
2240                 buffer().updateBuffer();
2241         }
2242
2243         // If the command has been dispatched,
2244         if (cur.result().dispatched() || cur.result().screenUpdate())
2245                 processUpdateFlags(cur.result().screenUpdate());
2246 }
2247
2248
2249 int BufferView::minVisiblePart()
2250 {
2251         return 2 * defaultRowHeight();
2252 }
2253
2254
2255 int BufferView::scroll(int y)
2256 {
2257         if (y > 0)
2258                 return scrollDown(y);
2259         if (y < 0)
2260                 return scrollUp(-y);
2261         return 0;
2262 }
2263
2264
2265 int BufferView::scrollDown(int offset)
2266 {
2267         Text * text = &buffer_.text();
2268         TextMetrics & tm = d->text_metrics_[text];
2269         int const ymax = height_ + offset;
2270         while (true) {
2271                 pair<pit_type, ParagraphMetrics const *> last = tm.last();
2272                 int bottom_pos = last.second->position() + last.second->descent();
2273                 if (lyxrc.scroll_below_document)
2274                         bottom_pos += height_ - minVisiblePart();
2275                 if (last.first + 1 == int(text->paragraphs().size())) {
2276                         if (bottom_pos <= height_)
2277                                 return 0;
2278                         offset = min(offset, bottom_pos - height_);
2279                         break;
2280                 }
2281                 if (bottom_pos > ymax)
2282                         break;
2283                 tm.newParMetricsDown();
2284         }
2285         d->anchor_ypos_ -= offset;
2286         return -offset;
2287 }
2288
2289
2290 int BufferView::scrollUp(int offset)
2291 {
2292         Text * text = &buffer_.text();
2293         TextMetrics & tm = d->text_metrics_[text];
2294         int ymin = - offset;
2295         while (true) {
2296                 pair<pit_type, ParagraphMetrics const *> first = tm.first();
2297                 int top_pos = first.second->position() - first.second->ascent();
2298                 if (first.first == 0) {
2299                         if (top_pos >= 0)
2300                                 return 0;
2301                         offset = min(offset, - top_pos);
2302                         break;
2303                 }
2304                 if (top_pos < ymin)
2305                         break;
2306                 tm.newParMetricsUp();
2307         }
2308         d->anchor_ypos_ += offset;
2309         return offset;
2310 }
2311
2312
2313 void BufferView::setCursorFromRow(int row)
2314 {
2315         setCursorFromRow(row, buffer_.texrow());
2316 }
2317
2318
2319 void BufferView::setCursorFromRow(int row, TexRow const & texrow)
2320 {
2321         int tmpid;
2322         int tmppos;
2323         pit_type newpit = 0;
2324         pos_type newpos = 0;
2325
2326         texrow.getIdFromRow(row, tmpid, tmppos);
2327
2328         bool posvalid = (tmpid != -1);
2329         if (posvalid) {
2330                 // we need to make sure that the row and position
2331                 // we got back are valid, because the buffer may well
2332                 // have changed since we last generated the LaTeX.
2333                 DocIterator dit = buffer_.getParFromID(tmpid);
2334                 if (dit == doc_iterator_end(&buffer_))
2335                         posvalid = false;
2336                 else if (dit.depth() > 1) {
2337                         // We are in an inset.
2338                         pos_type lastpos = dit.lastpos();
2339                         dit.pos() = tmppos > lastpos ? lastpos : tmppos;
2340                         setCursor(dit);
2341                         recenter();
2342                         return;
2343                 } else {
2344                         newpit = dit.pit();
2345                         // now have to check pos.
2346                         newpos = tmppos;
2347                         Paragraph const & par = buffer_.text().getPar(newpit);
2348                         if (newpos > par.size()) {
2349                                 LYXERR0("Requested position no longer valid.");
2350                                 newpos = par.size() - 1;
2351                         }
2352                 }
2353         }
2354         if (!posvalid) {
2355                 frontend::Alert::error(_("Inverse Search Failed"),
2356                         _("Invalid position requested by inverse search.\n"
2357                     "You need to update the viewed document."));
2358                 return;
2359         }
2360         d->cursor_.reset();
2361         buffer_.text().setCursor(d->cursor_, newpit, newpos);
2362         d->cursor_.setSelection(false);
2363         d->cursor_.resetAnchor();
2364         recenter();
2365 }
2366
2367
2368 bool BufferView::setCursorFromInset(Inset const * inset)
2369 {
2370         // are we already there?
2371         if (cursor().nextInset() == inset)
2372                 return true;
2373
2374         // Inset is not at cursor position. Find it in the document.
2375         Cursor cur(*this);
2376         cur.reset();
2377         while (cur && cur.nextInset() != inset)
2378                 cur.forwardInset();
2379
2380         if (cur) {
2381                 setCursor(cur);
2382                 return true;
2383         }
2384         return false;
2385 }
2386
2387
2388 void BufferView::gotoLabel(docstring const & label)
2389 {
2390         ListOfBuffers bufs = buffer().allRelatives();
2391         ListOfBuffers::iterator it = bufs.begin();
2392         for (; it != bufs.end(); ++it) {
2393                 Buffer const * buf = *it;
2394
2395                 // find label
2396                 shared_ptr<Toc> toc = buf->tocBackend().toc("label");
2397                 TocIterator toc_it = toc->begin();
2398                 TocIterator end = toc->end();
2399                 for (; toc_it != end; ++toc_it) {
2400                         if (label == toc_it->str()) {
2401                                 lyx::dispatch(toc_it->action());
2402                                 return;
2403                         }
2404                 }
2405         }
2406 }
2407
2408
2409 TextMetrics const & BufferView::textMetrics(Text const * t) const
2410 {
2411         return const_cast<BufferView *>(this)->textMetrics(t);
2412 }
2413
2414
2415 TextMetrics & BufferView::textMetrics(Text const * t)
2416 {
2417         LBUFERR(t);
2418         TextMetricsCache::iterator tmc_it  = d->text_metrics_.find(t);
2419         if (tmc_it == d->text_metrics_.end()) {
2420                 tmc_it = d->text_metrics_.insert(
2421                         make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
2422         }
2423         return tmc_it->second;
2424 }
2425
2426
2427 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
2428                 pit_type pit) const
2429 {
2430         return textMetrics(t).parMetrics(pit);
2431 }
2432
2433
2434 int BufferView::workHeight() const
2435 {
2436         return height_;
2437 }
2438
2439
2440 void BufferView::setCursor(DocIterator const & dit)
2441 {
2442         d->cursor_.reset();
2443         size_t const n = dit.depth();
2444         for (size_t i = 0; i < n; ++i)
2445                 dit[i].inset().edit(d->cursor_, true);
2446
2447         d->cursor_.setCursor(dit);
2448         d->cursor_.setSelection(false);
2449         d->cursor_.setCurrentFont();
2450         // FIXME
2451         // It seems on general grounds as if this is probably needed, but
2452         // it is not yet clear.
2453         // See bug #7394 and r38388.
2454         // d->cursor.resetAnchor();
2455 }
2456
2457
2458 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
2459 {
2460         // Would be wrong to delete anything if we have a selection.
2461         if (cur.selection())
2462                 return false;
2463
2464         bool need_anchor_change = false;
2465         bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
2466                 need_anchor_change);
2467
2468         if (need_anchor_change)
2469                 cur.resetAnchor();
2470
2471         if (!changed)
2472                 return false;
2473
2474         d->cursor_ = cur;
2475
2476         // we would rather not do this here, but it needs to be done before
2477         // the changed() signal is sent.
2478         buffer_.updateBuffer();
2479
2480         buffer_.changed(true);
2481         return true;
2482 }
2483
2484
2485 bool BufferView::mouseSetCursor(Cursor & cur, bool select)
2486 {
2487         LASSERT(&cur.bv() == this, return false);
2488
2489         if (!select)
2490                 // this event will clear selection so we save selection for
2491                 // persistent selection
2492                 cap::saveSelection(cursor());
2493
2494         d->cursor_.macroModeClose();
2495         // If a macro has been finalized, the cursor might have been broken
2496         cur.fixIfBroken();
2497
2498         // Has the cursor just left the inset?
2499         bool const leftinset = (&d->cursor_.inset() != &cur.inset());
2500         if (leftinset)
2501                 d->cursor_.fixIfBroken();
2502
2503         // FIXME: shift-mouse selection doesn't work well across insets.
2504         bool const do_selection =
2505                         select && &d->cursor_.normalAnchor().inset() == &cur.inset();
2506
2507         // do the dEPM magic if needed
2508         // FIXME: (1) move this to InsetText::notifyCursorLeaves?
2509         // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
2510         // the leftinset bool would not be necessary (badcursor instead).
2511         bool update = leftinset;
2512         if (!do_selection && d->cursor_.inTexted())
2513                 update |= checkDepm(cur, d->cursor_);
2514
2515         if (!do_selection)
2516                 d->cursor_.resetAnchor();
2517         d->cursor_.setCursor(cur);
2518         d->cursor_.boundary(cur.boundary());
2519         if (do_selection)
2520                 d->cursor_.setSelection();
2521         else
2522                 d->cursor_.clearSelection();
2523
2524         d->cursor_.finishUndo();
2525         d->cursor_.setCurrentFont();
2526         if (update)
2527                 cur.forceBufferUpdate();
2528         return update;
2529 }
2530
2531
2532 void BufferView::putSelectionAt(DocIterator const & cur,
2533                                 int length, bool backwards)
2534 {
2535         d->cursor_.clearSelection();
2536
2537         setCursor(cur);
2538
2539         if (length) {
2540                 if (backwards) {
2541                         d->cursor_.pos() += length;
2542                         d->cursor_.setSelection(d->cursor_, -length);
2543                 } else
2544                         d->cursor_.setSelection(d->cursor_, length);
2545         }
2546 }
2547
2548
2549 bool BufferView::selectIfEmpty(DocIterator & cur)
2550 {
2551         if ((cur.inTexted() && !cur.paragraph().empty())
2552             || (cur.inMathed() && !cur.cell().empty()))
2553                 return false;
2554
2555         pit_type const beg_pit = cur.pit();
2556         if (beg_pit > 0) {
2557                 // The paragraph associated to this item isn't
2558                 // the first one, so it can be selected
2559                 cur.backwardPos();
2560         } else {
2561                 // We have to resort to select the space between the
2562                 // end of this item and the begin of the next one
2563                 cur.forwardPos();
2564         }
2565         if (cur.empty()) {
2566                 // If it is the only item in the document,
2567                 // nothing can be selected
2568                 return false;
2569         }
2570         pit_type const end_pit = cur.pit();
2571         pos_type const end_pos = cur.pos();
2572         d->cursor_.clearSelection();
2573         d->cursor_.reset();
2574         d->cursor_.setCursor(cur);
2575         d->cursor_.pit() = beg_pit;
2576         d->cursor_.pos() = 0;
2577         d->cursor_.setSelection(false);
2578         d->cursor_.resetAnchor();
2579         d->cursor_.pit() = end_pit;
2580         d->cursor_.pos() = end_pos;
2581         d->cursor_.setSelection();
2582         return true;
2583 }
2584
2585
2586 Cursor & BufferView::cursor()
2587 {
2588         return d->cursor_;
2589 }
2590
2591
2592 Cursor const & BufferView::cursor() const
2593 {
2594         return d->cursor_;
2595 }
2596
2597
2598 pit_type BufferView::anchor_ref() const
2599 {
2600         return d->anchor_pit_;
2601 }
2602
2603
2604 bool BufferView::singleParUpdate()
2605 {
2606         Text & buftext = buffer_.text();
2607         pit_type const bottom_pit = d->cursor_.bottom().pit();
2608         TextMetrics & tm = textMetrics(&buftext);
2609         int old_height = tm.parMetrics(bottom_pit).height();
2610
2611         // make sure inline completion pointer is ok
2612         if (d->inlineCompletionPos_.fixIfBroken())
2613                 d->inlineCompletionPos_ = DocIterator();
2614
2615         // In Single Paragraph mode, rebreak only
2616         // the (main text, not inset!) paragraph containing the cursor.
2617         // (if this paragraph contains insets etc., rebreaking will
2618         // recursively descend)
2619         tm.redoParagraph(bottom_pit);
2620         ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
2621         if (pm.height() != old_height)
2622                 // Paragraph height has changed so we cannot proceed to
2623                 // the singlePar optimisation.
2624                 return false;
2625
2626         d->update_strategy_ = SingleParUpdate;
2627
2628         LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
2629                 << " y2: " << pm.position() + pm.descent()
2630                 << " pit: " << bottom_pit
2631                 << " singlepar: 1");
2632         return true;
2633 }
2634
2635
2636 void BufferView::updateMetrics()
2637 {
2638         if (height_ == 0 || width_ == 0)
2639                 return;
2640
2641         Text & buftext = buffer_.text();
2642         pit_type const npit = int(buftext.paragraphs().size());
2643
2644         // Clear out the position cache in case of full screen redraw,
2645         d->coord_cache_.clear();
2646
2647         // Clear out paragraph metrics to avoid having invalid metrics
2648         // in the cache from paragraphs not relayouted below
2649         // The complete text metrics will be redone.
2650         d->text_metrics_.clear();
2651
2652         TextMetrics & tm = textMetrics(&buftext);
2653
2654         // make sure inline completion pointer is ok
2655         if (d->inlineCompletionPos_.fixIfBroken())
2656                 d->inlineCompletionPos_ = DocIterator();
2657
2658         if (d->anchor_pit_ >= npit)
2659                 // The anchor pit must have been deleted...
2660                 d->anchor_pit_ = npit - 1;
2661
2662         // Rebreak anchor paragraph.
2663         tm.redoParagraph(d->anchor_pit_);
2664         ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
2665
2666         // position anchor
2667         if (d->anchor_pit_ == 0) {
2668                 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
2669
2670                 // Complete buffer visible? Then it's easy.
2671                 if (scrollRange == 0)
2672                         d->anchor_ypos_ = anchor_pm.ascent();
2673
2674                 // FIXME: Some clever handling needed to show
2675                 // the _first_ paragraph up to the top if the cursor is
2676                 // in the first line.
2677         }
2678         anchor_pm.setPosition(d->anchor_ypos_);
2679
2680         LYXERR(Debug::PAINTING, "metrics: "
2681                 << " anchor pit = " << d->anchor_pit_
2682                 << " anchor ypos = " << d->anchor_ypos_);
2683
2684         // Redo paragraphs above anchor if necessary.
2685         int y1 = d->anchor_ypos_ - anchor_pm.ascent();
2686         // We are now just above the anchor paragraph.
2687         pit_type pit1 = d->anchor_pit_ - 1;
2688         for (; pit1 >= 0 && y1 >= 0; --pit1) {
2689                 tm.redoParagraph(pit1);
2690                 ParagraphMetrics & pm = tm.par_metrics_[pit1];
2691                 y1 -= pm.descent();
2692                 // Save the paragraph position in the cache.
2693                 pm.setPosition(y1);
2694                 y1 -= pm.ascent();
2695         }
2696
2697         // Redo paragraphs below the anchor if necessary.
2698         int y2 = d->anchor_ypos_ + anchor_pm.descent();
2699         // We are now just below the anchor paragraph.
2700         pit_type pit2 = d->anchor_pit_ + 1;
2701         for (; pit2 < npit && y2 <= height_; ++pit2) {
2702                 tm.redoParagraph(pit2);
2703                 ParagraphMetrics & pm = tm.par_metrics_[pit2];
2704                 y2 += pm.ascent();
2705                 // Save the paragraph position in the cache.
2706                 pm.setPosition(y2);
2707                 y2 += pm.descent();
2708         }
2709
2710         LYXERR(Debug::PAINTING, "Metrics: "
2711                 << " anchor pit = " << d->anchor_pit_
2712                 << " anchor ypos = " << d->anchor_ypos_
2713                 << " y1 = " << y1
2714                 << " y2 = " << y2
2715                 << " pit1 = " << pit1
2716                 << " pit2 = " << pit2);
2717
2718         d->update_strategy_ = FullScreenUpdate;
2719
2720         if (lyxerr.debugging(Debug::WORKAREA)) {
2721                 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
2722                 d->coord_cache_.dump();
2723         }
2724 }
2725
2726
2727 void BufferView::insertLyXFile(FileName const & fname)
2728 {
2729         LASSERT(d->cursor_.inTexted(), return);
2730
2731         // Get absolute path of file and add ".lyx"
2732         // to the filename if necessary
2733         FileName filename = fileSearch(string(), fname.absFileName(), "lyx");
2734
2735         docstring const disp_fn = makeDisplayPath(filename.absFileName());
2736         // emit message signal.
2737         message(bformat(_("Inserting document %1$s..."), disp_fn));
2738
2739         docstring res;
2740         Buffer buf(filename.absFileName(), false);
2741         if (buf.loadLyXFile() == Buffer::ReadSuccess) {
2742                 ErrorList & el = buffer_.errorList("Parse");
2743                 // Copy the inserted document error list into the current buffer one.
2744                 el = buf.errorList("Parse");
2745                 buffer_.undo().recordUndo(d->cursor_);
2746                 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
2747                                              buf.params().documentClassPtr(), el);
2748                 res = _("Document %1$s inserted.");
2749         } else {
2750                 res = _("Could not insert document %1$s");
2751         }
2752
2753         buffer_.changed(true);
2754         // emit message signal.
2755         message(bformat(res, disp_fn));
2756 }
2757
2758
2759 Point BufferView::coordOffset(DocIterator const & dit) const
2760 {
2761         int x = 0;
2762         int y = 0;
2763         int lastw = 0;
2764
2765         // Addup contribution of nested insets, from inside to outside,
2766         // keeping the outer paragraph for a special handling below
2767         for (size_t i = dit.depth() - 1; i >= 1; --i) {
2768                 CursorSlice const & sl = dit[i];
2769                 int xx = 0;
2770                 int yy = 0;
2771
2772                 // get relative position inside sl.inset()
2773                 sl.inset().cursorPos(*this, sl, dit.boundary() && (i + 1 == dit.depth()), xx, yy);
2774
2775                 // Make relative position inside of the edited inset relative to sl.inset()
2776                 x += xx;
2777                 y += yy;
2778
2779                 // In case of an RTL inset, the edited inset will be positioned to the left
2780                 // of xx:yy
2781                 if (sl.text()) {
2782                         bool boundary_i = dit.boundary() && i + 1 == dit.depth();
2783                         bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2784                         if (rtl)
2785                                 x -= lastw;
2786                 }
2787
2788                 // remember width for the case that sl.inset() is positioned in an RTL inset
2789                 if (i && dit[i - 1].text()) {
2790                         // If this Inset is inside a Text Inset, retrieve the Dimension
2791                         // from the containing text instead of using Inset::dimension() which
2792                         // might not be implemented.
2793                         // FIXME (Abdel 23/09/2007): this is a bit messy because of the
2794                         // elimination of Inset::dim_ cache. This coordOffset() method needs
2795                         // to be rewritten in light of the new design.
2796                         Dimension const & dim = coordCache().getInsets().dim(&sl.inset());
2797                         lastw = dim.wid;
2798                 } else {
2799                         Dimension const dim = sl.inset().dimension(*this);
2800                         lastw = dim.wid;
2801                 }
2802
2803                 //lyxerr << "Cursor::getPos, i: "
2804                 // << i << " x: " << xx << " y: " << y << endl;
2805         }
2806
2807         // Add contribution of initial rows of outermost paragraph
2808         CursorSlice const & sl = dit[0];
2809         TextMetrics const & tm = textMetrics(sl.text());
2810         ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2811
2812         LBUFERR(!pm.rows().empty());
2813         y -= pm.rows()[0].ascent();
2814 #if 1
2815         // FIXME: document this mess
2816         size_t rend;
2817         if (sl.pos() > 0 && dit.depth() == 1) {
2818                 int pos = sl.pos();
2819                 if (pos && dit.boundary())
2820                         --pos;
2821 //              lyxerr << "coordOffset: boundary:" << dit.boundary() << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
2822                 rend = pm.pos2row(pos);
2823         } else
2824                 rend = pm.pos2row(sl.pos());
2825 #else
2826         size_t rend = pm.pos2row(sl.pos());
2827 #endif
2828         for (size_t rit = 0; rit != rend; ++rit)
2829                 y += pm.rows()[rit].height();
2830         y += pm.rows()[rend].ascent();
2831
2832         TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
2833
2834         // Make relative position from the nested inset now bufferview absolute.
2835         int xx = bottom_tm.cursorX(dit.bottom(), dit.boundary() && dit.depth() == 1);
2836         x += xx;
2837
2838         // In the RTL case place the nested inset at the left of the cursor in
2839         // the outer paragraph
2840         bool boundary_1 = dit.boundary() && 1 == dit.depth();
2841         bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
2842         if (rtl)
2843                 x -= lastw;
2844
2845         return Point(x, y);
2846 }
2847
2848
2849 Point BufferView::getPos(DocIterator const & dit) const
2850 {
2851         if (!paragraphVisible(dit))
2852                 return Point(-1, -1);
2853
2854         CursorSlice const & bot = dit.bottom();
2855         TextMetrics const & tm = textMetrics(bot.text());
2856
2857         // offset from outer paragraph
2858         Point p = coordOffset(dit);
2859         p.y_ += tm.parMetrics(bot.pit()).position();
2860         return p;
2861 }
2862
2863
2864 bool BufferView::paragraphVisible(DocIterator const & dit) const
2865 {
2866         CursorSlice const & bot = dit.bottom();
2867         TextMetrics const & tm = textMetrics(bot.text());
2868
2869         return tm.contains(bot.pit());
2870 }
2871
2872
2873 void BufferView::cursorPosAndHeight(Point & p, int & h) const
2874 {
2875         Cursor const & cur = cursor();
2876         Font const font = cur.getFont();
2877         frontend::FontMetrics const & fm = theFontMetrics(font);
2878         int const asc = fm.maxAscent();
2879         int const des = fm.maxDescent();
2880         h = asc + des;
2881         p = getPos(cur);
2882         p.y_ -= asc;
2883 }
2884
2885
2886 bool BufferView::cursorInView(Point const & p, int h) const
2887 {
2888         Cursor const & cur = cursor();
2889         // does the cursor touch the screen ?
2890         if (p.y_ + h < 0 || p.y_ >= workHeight() || !paragraphVisible(cur))
2891                 return false;
2892         return true;
2893 }
2894
2895
2896 int BufferView::horizScrollOffset() const
2897 {
2898         return d->horiz_scroll_offset_;
2899 }
2900
2901
2902 CursorSlice const & BufferView::currentRowSlice() const
2903 {
2904         return d->current_row_slice_;
2905 }
2906
2907
2908 CursorSlice const & BufferView::lastRowSlice() const
2909 {
2910         return d->last_row_slice_;
2911 }
2912
2913
2914 void BufferView::setCurrentRowSlice(CursorSlice const & rowSlice)
2915 {
2916         // nothing to do if the cursor was already on this row
2917         if (d->current_row_slice_ == rowSlice) {
2918                 d->last_row_slice_ = CursorSlice();
2919                 return;
2920         }
2921
2922         // if the (previous) current row was scrolled, we have to
2923         // remember it in order to repaint it next time.
2924         if (d->horiz_scroll_offset_ != 0)
2925                 d->last_row_slice_ = d->current_row_slice_;
2926         else
2927                 d->last_row_slice_ = CursorSlice();
2928
2929         // Since we changed row, the scroll offset is not valid anymore
2930         d->horiz_scroll_offset_ = 0;
2931         d->current_row_slice_ = rowSlice;
2932 }
2933
2934
2935 void BufferView::checkCursorScrollOffset(PainterInfo & pi)
2936 {
2937         CursorSlice rowSlice = d->cursor_.bottom();
2938         TextMetrics const & tm = textMetrics(rowSlice.text());
2939
2940         // Stop if metrics have not been computed yet, since it means
2941         // that there is nothing to do.
2942         if (!tm.contains(rowSlice.pit()))
2943                 return;
2944         ParagraphMetrics const & pm = tm.parMetrics(rowSlice.pit());
2945         Row const & row = pm.getRow(rowSlice.pos(),
2946                                     d->cursor_.boundary() && rowSlice == d->cursor_.top());
2947         rowSlice.pos() = row.pos();
2948
2949         // Set the row on which the cursor lives.
2950         setCurrentRowSlice(rowSlice);
2951
2952         // Current x position of the cursor in pixels
2953         int cur_x = getPos(d->cursor_).x_;
2954
2955         // If cursor offset is left margin and offset is not the leftmost
2956         // position of the row, there is a cache problem.
2957         if (cur_x == row.left_margin && !row.empty()
2958             && d->cursor_.pos() != row.front().left_pos()) {
2959                 /** FIXME: the code below adds an extraneous computation of
2960                  * inset positions, and can therefore be bad for performance
2961                  * (think for example about a very large tabular inset.
2962                  * Redawing the row where it is means redrawing the whole
2963                  * screen).
2964                  *
2965                  * The bug that this fixes is the following: assume that there
2966                  * is a very large math inset. Upon entering the inset, when
2967                  * pressing `End', the row is not scrolled and the cursor is
2968                  * not visible. The extra row computation makes sure that the
2969                  * inset positions are correctly computed and set in the
2970                  * cache. This would not happen if we did not have two-stage
2971                  * drawing.
2972                  *
2973                  * A proper fix should be found and this code should be removed.
2974                  */
2975                 // Force the recomputation of inset positions
2976                 bool const drawing = pi.pain.isDrawingEnabled();
2977                 pi.pain.setDrawingEnabled(false);
2978                 // No need to care about vertical position.
2979                 RowPainter rp(pi, buffer().text(), d->cursor_.bottom().pit(), row,
2980                               -d->horiz_scroll_offset_, 0);
2981                 rp.paintText();
2982                 pi.pain.setDrawingEnabled(drawing);
2983
2984                 // Recompute current Current x position of the cursor in pixels
2985                 cur_x = getPos(d->cursor_).x_;
2986         }
2987
2988         // Horizontal scroll offset of the cursor row in pixels
2989         int offset = d->horiz_scroll_offset_;
2990         int const MARGIN = 2 * theFontMetrics(d->cursor_.real_current_font).em()
2991                            + row.right_margin;
2992         if (row.right_x() <= workWidth() - row.right_margin) {
2993                 // Row is narrower than the work area, no offset needed.
2994                 offset = 0;
2995         } else {
2996                 if (cur_x - offset < MARGIN) {
2997                         // cursor would be too far right
2998                         offset = cur_x - MARGIN;
2999                 } else if (cur_x - offset > workWidth() - MARGIN) {
3000                         // cursor would be too far left
3001                         offset = cur_x - workWidth() + MARGIN;
3002                 }
3003                 // Correct the offset to make sure that we do not scroll too much
3004                 if (offset < 0)
3005                         offset = 0;
3006                 if (row.right_x() - offset < workWidth() - row.right_margin)
3007                         offset = row.right_x() - workWidth() + row.right_margin;
3008         }
3009
3010         //lyxerr << "cur_x=" << cur_x << ", offset=" << offset << ", row.wid=" << row.width() << ", margin=" << MARGIN << endl;
3011
3012         if (offset != d->horiz_scroll_offset_)
3013                 LYXERR(Debug::PAINTING, "Horiz. scroll offset changed from "
3014                        << d->horiz_scroll_offset_ << " to " << offset);
3015
3016         if (d->update_strategy_ == NoScreenUpdate
3017             && (offset != d->horiz_scroll_offset_
3018                 || !d->last_row_slice_.empty())) {
3019                 // FIXME: if one uses SingleParUpdate, then home/end
3020                 // will not work on long rows. Why?
3021                 d->update_strategy_ = FullScreenUpdate;
3022         }
3023
3024         d->horiz_scroll_offset_ = offset;
3025 }
3026
3027
3028 void BufferView::draw(frontend::Painter & pain)
3029 {
3030         if (height_ == 0 || width_ == 0)
3031                 return;
3032         LYXERR(Debug::PAINTING, "\t\t*** START DRAWING ***");
3033
3034         Text & text = buffer_.text();
3035         TextMetrics const & tm = d->text_metrics_[&text];
3036         int const y = tm.first().second->position();
3037         PainterInfo pi(this, pain);
3038
3039         // Check whether the row where the cursor lives needs to be scrolled.
3040         // Update the drawing strategy if needed.
3041         checkCursorScrollOffset(pi);
3042
3043         switch (d->update_strategy_) {
3044
3045         case NoScreenUpdate:
3046                 // If no screen painting is actually needed, only some the different
3047                 // coordinates of insets and paragraphs needs to be updated.
3048                 LYXERR(Debug::PAINTING, "Strategy: NoScreenUpdate");
3049                 pi.full_repaint = true;
3050                 pi.pain.setDrawingEnabled(false);
3051                 tm.draw(pi, 0, y);
3052                 break;
3053
3054         case SingleParUpdate:
3055                 pi.full_repaint = false;
3056                 LYXERR(Debug::PAINTING, "Strategy: SingleParUpdate");
3057                 // In general, only the current row of the outermost paragraph
3058                 // will be redrawn. Particular cases where selection spans
3059                 // multiple paragraph are correctly detected in TextMetrics.
3060                 tm.draw(pi, 0, y);
3061                 break;
3062
3063         case DecorationUpdate:
3064                 // FIXME: We should also distinguish DecorationUpdate to avoid text
3065                 // drawing if possible. This is not possible to do easily right now
3066                 // because of the single backing pixmap.
3067
3068         case FullScreenUpdate:
3069
3070                 LYXERR(Debug::PAINTING,
3071                        ((d->update_strategy_ == FullScreenUpdate)
3072                         ? "Strategy: FullScreenUpdate"
3073                         : "Strategy: DecorationUpdate"));
3074
3075                 // The whole screen, including insets, will be refreshed.
3076                 pi.full_repaint = true;
3077
3078                 // Clear background.
3079                 pain.fillRectangle(0, 0, width_, height_,
3080                         pi.backgroundColor(&buffer_.inset()));
3081
3082                 // Draw everything.
3083                 tm.draw(pi, 0, y);
3084
3085                 // and possibly grey out below
3086                 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3087                 int const y2 = lastpm.second->position() + lastpm.second->descent();
3088
3089                 if (y2 < height_) {
3090                         Color color = buffer().isInternal()
3091                                 ? Color_background : Color_bottomarea;
3092                         pain.fillRectangle(0, y2, width_, height_ - y2, color);
3093                 }
3094                 break;
3095         }
3096         LYXERR(Debug::PAINTING, "\n\t\t*** END DRAWING  ***");
3097
3098         // The scrollbar needs an update.
3099         updateScrollbar();
3100
3101         // Normalize anchor for next time
3102         pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
3103         pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3104         for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
3105                 ParagraphMetrics const & pm = tm.parMetrics(pit);
3106                 if (pm.position() + pm.descent() > 0) {
3107                         d->anchor_pit_ = pit;
3108                         d->anchor_ypos_ = pm.position();
3109                         break;
3110                 }
3111         }
3112         LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
3113                 << "  anchor ypos = " << d->anchor_ypos_);
3114 }
3115
3116
3117 void BufferView::message(docstring const & msg)
3118 {
3119         if (d->gui_)
3120                 d->gui_->message(msg);
3121 }
3122
3123
3124 void BufferView::showDialog(string const & name)
3125 {
3126         if (d->gui_)
3127                 d->gui_->showDialog(name, string());
3128 }
3129
3130
3131 void BufferView::showDialog(string const & name,
3132         string const & data, Inset * inset)
3133 {
3134         if (d->gui_)
3135                 d->gui_->showDialog(name, data, inset);
3136 }
3137
3138
3139 void BufferView::updateDialog(string const & name, string const & data)
3140 {
3141         if (d->gui_)
3142                 d->gui_->updateDialog(name, data);
3143 }
3144
3145
3146 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
3147 {
3148         d->gui_ = gui;
3149 }
3150
3151
3152 // FIXME: Move this out of BufferView again
3153 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
3154 {
3155         if (!fname.isReadableFile()) {
3156                 docstring const error = from_ascii(strerror(errno));
3157                 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3158                 docstring const text =
3159                   bformat(_("Could not read the specified document\n"
3160                             "%1$s\ndue to the error: %2$s"), file, error);
3161                 Alert::error(_("Could not read file"), text);
3162                 return docstring();
3163         }
3164
3165         if (!fname.isReadableFile()) {
3166                 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3167                 docstring const text =
3168                   bformat(_("%1$s\n is not readable."), file);
3169                 Alert::error(_("Could not open file"), text);
3170                 return docstring();
3171         }
3172
3173         // FIXME UNICODE: We don't know the encoding of the file
3174         docstring file_content = fname.fileContents("UTF-8");
3175         if (file_content.empty()) {
3176                 Alert::error(_("Reading not UTF-8 encoded file"),
3177                              _("The file is not UTF-8 encoded.\n"
3178                                "It will be read as local 8Bit-encoded.\n"
3179                                "If this does not give the correct result\n"
3180                                "then please change the encoding of the file\n"
3181                                "to UTF-8 with a program other than LyX.\n"));
3182                 file_content = fname.fileContents("local8bit");
3183         }
3184
3185         return normalize_c(file_content);
3186 }
3187
3188
3189 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
3190 {
3191         docstring const tmpstr = contentsOfPlaintextFile(f);
3192
3193         if (tmpstr.empty())
3194                 return;
3195
3196         Cursor & cur = cursor();
3197         cap::replaceSelection(cur);
3198         buffer_.undo().recordUndo(cur);
3199         if (asParagraph)
3200                 cur.innerText()->insertStringAsParagraphs(cur, tmpstr, cur.current_font);
3201         else
3202                 cur.innerText()->insertStringAsLines(cur, tmpstr, cur.current_font);
3203
3204         buffer_.changed(true);
3205 }
3206
3207
3208 docstring const & BufferView::inlineCompletion() const
3209 {
3210         return d->inlineCompletion_;
3211 }
3212
3213
3214 size_t const & BufferView::inlineCompletionUniqueChars() const
3215 {
3216         return d->inlineCompletionUniqueChars_;
3217 }
3218
3219
3220 DocIterator const & BufferView::inlineCompletionPos() const
3221 {
3222         return d->inlineCompletionPos_;
3223 }
3224
3225
3226 void BufferView::resetInlineCompletionPos()
3227 {
3228         d->inlineCompletionPos_ = DocIterator();
3229 }
3230
3231
3232 bool samePar(DocIterator const & a, DocIterator const & b)
3233 {
3234         if (a.empty() && b.empty())
3235                 return true;
3236         if (a.empty() || b.empty())
3237                 return false;
3238         if (a.depth() != b.depth())
3239                 return false;
3240         return &a.innerParagraph() == &b.innerParagraph();
3241 }
3242
3243
3244 void BufferView::setInlineCompletion(Cursor const & cur, DocIterator const & pos,
3245         docstring const & completion, size_t uniqueChars)
3246 {
3247         uniqueChars = min(completion.size(), uniqueChars);
3248         bool changed = d->inlineCompletion_ != completion
3249                 || d->inlineCompletionUniqueChars_ != uniqueChars;
3250         bool singlePar = true;
3251         d->inlineCompletion_ = completion;
3252         d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
3253
3254         //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
3255
3256         // at new position?
3257         DocIterator const & old = d->inlineCompletionPos_;
3258         if (old != pos) {
3259                 //lyxerr << "inlineCompletionPos changed" << std::endl;
3260                 // old or pos are in another paragraph?
3261                 if ((!samePar(cur, pos) && !pos.empty())
3262                     || (!samePar(cur, old) && !old.empty())) {
3263                         singlePar = false;
3264                         //lyxerr << "different paragraph" << std::endl;
3265                 }
3266                 d->inlineCompletionPos_ = pos;
3267         }
3268
3269         // set update flags
3270         if (changed) {
3271                 if (singlePar && !(cur.result().screenUpdate() & Update::Force))
3272                         cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
3273                 else
3274                         cur.screenUpdateFlags(cur.result().screenUpdate() | Update::Force);
3275         }
3276 }
3277
3278
3279 bool BufferView::clickableInset() const
3280 {
3281         return d->clickable_inset_;
3282 }
3283
3284 } // namespace lyx