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