src/BufferView.cpp

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