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