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