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