src/BufferView.cpp

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