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