src/BufferView.cpp

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