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