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