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                 break;
1535
1536         case LFUN_REFERENCE_NEXT: {
1537                 vector<InsetCode> tmp;
1538                 tmp.push_back(LABEL_CODE);
1539                 tmp.push_back(REF_CODE);
1540                 gotoInset(this, tmp, true);
1541                 break;
1542         }
1543
1544         case LFUN_CHANGE_NEXT:
1545                 findNextChange(this);
1546                 if (cur.inset().isTable())
1547                         // In tables, there might be whole changed rows or columns
1548                         cur.dispatch(cmd);
1549                 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1550                 dr.screenUpdate(Update::Force | Update::FitCursor);
1551                 break;
1552
1553         case LFUN_CHANGE_PREVIOUS:
1554                 findPreviousChange(this);
1555                 if (cur.inset().isTable())
1556                         // In tables, there might be whole changed rows or columns
1557                         cur.dispatch(cmd);
1558                 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1559                 dr.screenUpdate(Update::Force | Update::FitCursor);
1560                 break;
1561
1562         case LFUN_CHANGES_MERGE:
1563                 if (findNextChange(this) || findPreviousChange(this)) {
1564                         dr.screenUpdate(Update::Force | Update::FitCursor);
1565                         dr.forceBufferUpdate();
1566                         showDialog("changes");
1567                 }
1568                 break;
1569
1570         case LFUN_ALL_CHANGES_ACCEPT: {
1571                 // select complete document
1572                 cur.reset();
1573                 cur.selHandle(true);
1574                 buffer_.text().cursorBottom(cur);
1575                 // accept everything in a single step to support atomic undo
1576                 // temporarily disable track changes in order to end with really
1577                 // no new (e.g., DPSM-caused) changes (see #7487)
1578                 bool const track = buffer_.params().track_changes;
1579                 buffer_.params().track_changes = false;
1580                 buffer_.text().acceptOrRejectChanges(cur, Text::ACCEPT);
1581                 buffer_.params().track_changes = track;
1582                 cur.resetAnchor();
1583                 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1584                 dr.screenUpdate(Update::Force | Update::FitCursor);
1585                 dr.forceBufferUpdate();
1586                 break;
1587         }
1588
1589         case LFUN_ALL_CHANGES_REJECT: {
1590                 // select complete document
1591                 cur.reset();
1592                 cur.selHandle(true);
1593                 buffer_.text().cursorBottom(cur);
1594                 // reject everything in a single step to support atomic undo
1595                 // temporarily disable track changes in order to end with really
1596                 // no new (e.g., DPSM-caused) changes (see #7487)
1597                 bool const track = buffer_.params().track_changes;
1598                 buffer_.params().track_changes = false;
1599                 buffer_.text().acceptOrRejectChanges(cur, Text::REJECT);
1600                 buffer_.params().track_changes = track;
1601                 cur.resetAnchor();
1602                 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1603                 dr.screenUpdate(Update::Force | Update::FitCursor);
1604                 dr.forceBufferUpdate();
1605                 break;
1606         }
1607
1608         case LFUN_WORD_FIND_FORWARD:
1609         case LFUN_WORD_FIND_BACKWARD: {
1610                 // FIXME THREAD
1611                 // Would it maybe be better if this variable were view specific anyway?
1612                 static docstring last_search;
1613                 docstring searched_string;
1614
1615                 if (!cmd.argument().empty()) {
1616                         last_search = cmd.argument();
1617                         searched_string = cmd.argument();
1618                 } else {
1619                         searched_string = last_search;
1620                 }
1621
1622                 if (searched_string.empty())
1623                         break;
1624
1625                 bool const fw = act == LFUN_WORD_FIND_FORWARD;
1626                 docstring const data =
1627                         find2string(searched_string, true, false, fw);
1628                 bool found = lyxfind(this, FuncRequest(LFUN_WORD_FIND, data));
1629                 if (found)
1630                         dr.screenUpdate(Update::Force | Update::FitCursor);
1631                 break;
1632         }
1633
1634         case LFUN_WORD_FIND: {
1635                 FuncRequest req = cmd;
1636                 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1637                         req = d->search_request_cache_;
1638                 if (req.argument().empty()) {
1639                         lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, "findreplace"));
1640                         break;
1641                 }
1642                 if (lyxfind(this, req))
1643                         dr.screenUpdate(Update::Force | Update::FitCursor);
1644
1645                 d->search_request_cache_ = req;
1646                 break;
1647         }
1648
1649         case LFUN_WORD_REPLACE: {
1650                 bool has_deleted = false;
1651                 if (cur.selection()) {
1652                         DocIterator beg = cur.selectionBegin();
1653                         DocIterator end = cur.selectionEnd();
1654                         if (beg.pit() == end.pit()) {
1655                                 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1656                                         if (!cur.inMathed() && cur.paragraph().isDeleted(p)) {
1657                                                 has_deleted = true;
1658                                                 break;
1659                                         }
1660                                 }
1661                         }
1662                 }
1663                 if (lyxreplace(this, cmd, has_deleted)) {
1664                         dr.forceBufferUpdate();
1665                         dr.screenUpdate(Update::Force | Update::FitCursor);
1666                 }
1667                 break;
1668         }
1669
1670         case LFUN_WORD_FINDADV: {
1671                 FindAndReplaceOptions opt;
1672                 istringstream iss(to_utf8(cmd.argument()));
1673                 iss >> opt;
1674                 if (findAdv(this, opt)) {
1675                         dr.screenUpdate(Update::Force | Update::FitCursor);
1676                         cur.dispatched();
1677                         dispatched = true;
1678                 } else {
1679                         cur.undispatched();
1680                         dispatched = false;
1681                 }
1682                 break;
1683         }
1684
1685         case LFUN_MARK_OFF:
1686                 cur.clearSelection();
1687                 dr.setMessage(from_utf8(N_("Mark off")));
1688                 break;
1689
1690         case LFUN_MARK_ON:
1691                 cur.clearSelection();
1692                 cur.setMark(true);
1693                 dr.setMessage(from_utf8(N_("Mark on")));
1694                 break;
1695
1696         case LFUN_MARK_TOGGLE:
1697                 cur.selection(false);
1698                 if (cur.mark()) {
1699                         cur.setMark(false);
1700                         dr.setMessage(from_utf8(N_("Mark removed")));
1701                 } else {
1702                         cur.setMark(true);
1703                         dr.setMessage(from_utf8(N_("Mark set")));
1704                 }
1705                 cur.resetAnchor();
1706                 break;
1707
1708         case LFUN_SCREEN_SHOW_CURSOR:
1709                 showCursor();
1710                 break;
1711
1712         case LFUN_SCREEN_RECENTER:
1713                 recenter();
1714                 break;
1715
1716         case LFUN_BIBTEX_DATABASE_ADD: {
1717                 Cursor tmpcur = cur;
1718                 findInset(tmpcur, BIBTEX_CODE, false);
1719                 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1720                                                 BIBTEX_CODE);
1721                 if (inset) {
1722                         if (inset->addDatabase(cmd.argument()))
1723                                 dr.forceBufferUpdate();
1724                 }
1725                 break;
1726         }
1727
1728         case LFUN_BIBTEX_DATABASE_DEL: {
1729                 Cursor tmpcur = cur;
1730                 findInset(tmpcur, BIBTEX_CODE, false);
1731                 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1732                                                 BIBTEX_CODE);
1733                 if (inset) {
1734                         if (inset->delDatabase(cmd.argument()))
1735                                 dr.forceBufferUpdate();
1736                 }
1737                 break;
1738         }
1739
1740         case LFUN_GRAPHICS_UNIFY: {
1741
1742                 cur.recordUndoFullBuffer();
1743
1744                 DocIterator from, to;
1745                 from = cur.selectionBegin();
1746                 to = cur.selectionEnd();
1747
1748                 string const newId = cmd.getArg(0);
1749                 bool fetchId = newId.empty(); //if we wait for groupId from first graphics inset
1750
1751                 InsetGraphicsParams grp_par;
1752                 if (!fetchId)
1753                         InsetGraphics::string2params(graphics::getGroupParams(buffer_, newId), buffer_, grp_par);
1754
1755                 if (!from.nextInset())  //move to closest inset
1756                         from.forwardInset();
1757
1758                 while (!from.empty() && from < to) {
1759                         Inset * inset = from.nextInset();
1760                         if (!inset)
1761                                 break;
1762                         InsetGraphics * ig = inset->asInsetGraphics();
1763                         if (ig) {
1764                                 InsetGraphicsParams inspar = ig->getParams();
1765                                 if (fetchId) {
1766                                         grp_par = inspar;
1767                                         fetchId = false;
1768                                 } else {
1769                                         grp_par.filename = inspar.filename;
1770                                         ig->setParams(grp_par);
1771                                 }
1772                         }
1773                         from.forwardInset();
1774                 }
1775                 dr.screenUpdate(Update::Force); //needed if triggered from context menu
1776                 break;
1777         }
1778
1779         case LFUN_STATISTICS: {
1780                 DocIterator from, to;
1781                 if (cur.selection()) {
1782                         from = cur.selectionBegin();
1783                         to = cur.selectionEnd();
1784                 } else {
1785                         from = doc_iterator_begin(&buffer_);
1786                         to = doc_iterator_end(&buffer_);
1787                 }
1788                 buffer_.updateStatistics(from, to);
1789                 int const words = buffer_.wordCount();
1790                 int const chars = buffer_.charCount(false);
1791                 int const chars_blanks = buffer_.charCount(true);
1792                 docstring message;
1793                 if (cur.selection())
1794                         message = _("Statistics for the selection:");
1795                 else
1796                         message = _("Statistics for the document:");
1797                 message += "\n\n";
1798                 if (words != 1)
1799                         message += bformat(_("%1$d words"), words);
1800                 else
1801                         message += _("One word");
1802                 message += "\n";
1803                 if (chars_blanks != 1)
1804                         message += bformat(_("%1$d characters (including blanks)"),
1805                                           chars_blanks);
1806                 else
1807                         message += _("One character (including blanks)");
1808                 message += "\n";
1809                 if (chars != 1)
1810                         message += bformat(_("%1$d characters (excluding blanks)"),
1811                                           chars);
1812                 else
1813                         message += _("One character (excluding blanks)");
1814
1815                 Alert::information(_("Statistics"), message);
1816         }
1817                 break;
1818
1819         case LFUN_SCREEN_UP:
1820         case LFUN_SCREEN_DOWN: {
1821                 Point p = getPos(cur);
1822                 // This code has been commented out to enable to scroll down a
1823                 // document, even if there are large insets in it (see bug #5465).
1824                 /*if (p.y_ < 0 || p.y_ > height_) {
1825                         // The cursor is off-screen so recenter before proceeding.
1826                         showCursor();
1827                         p = getPos(cur);
1828                 }*/
1829                 int const scrolled = scroll(act == LFUN_SCREEN_UP
1830                         ? -height_ : height_);
1831                 if (act == LFUN_SCREEN_UP && scrolled > -height_)
1832                         p = Point(0, 0);
1833                 if (act == LFUN_SCREEN_DOWN && scrolled < height_)
1834                         p = Point(width_, height_);
1835                 bool const in_texted = cur.inTexted();
1836                 cur.setCursor(doc_iterator_begin(cur.buffer()));
1837                 cur.selHandle(false);
1838                 // Force an immediate computation of metrics because we need it below
1839                 processUpdateFlags(Update::Force);
1840
1841                 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_,
1842                         true, act == LFUN_SCREEN_UP);
1843                 //FIXME: what to do with cur.x_target()?
1844                 bool update = in_texted && cur.bv().checkDepm(cur, old);
1845                 cur.finishUndo();
1846
1847                 if (update || cur.mark())
1848                         dr.screenUpdate(Update::Force | Update::FitCursor);
1849                 if (update)
1850                         dr.forceBufferUpdate();
1851                 break;
1852         }
1853
1854         case LFUN_SCROLL: {
1855                 string const scroll_type = cmd.getArg(0);
1856                 int scroll_step = 0;
1857                 if (scroll_type == "line")
1858                         scroll_step = d->scrollbarParameters_.single_step;
1859                 else if (scroll_type == "page")
1860                         scroll_step = d->scrollbarParameters_.page_step;
1861                 else
1862                         return;
1863                 string const scroll_quantity = cmd.getArg(1);
1864                 if (scroll_quantity == "up")
1865                         scrollUp(scroll_step);
1866                 else if (scroll_quantity == "down")
1867                         scrollDown(scroll_step);
1868                 else {
1869                         int const scroll_value = convert<int>(scroll_quantity);
1870                         if (scroll_value)
1871                                 scroll(scroll_step * scroll_value);
1872                 }
1873                 dr.screenUpdate(Update::ForceDraw);
1874                 dr.forceBufferUpdate();
1875                 break;
1876         }
1877
1878         case LFUN_SCREEN_UP_SELECT: {
1879                 // FIXME: why is the algorithm different from LFUN_SCREEN_UP?
1880                 cur.selHandle(true);
1881                 if (isTopScreen()) {
1882                         lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1883                         cur.finishUndo();
1884                         break;
1885                 }
1886                 int y = getPos(cur).y_;
1887                 int const ymin = y - height_ + defaultRowHeight();
1888                 while (y > ymin && cur.up())
1889                         y = getPos(cur).y_;
1890
1891                 cur.finishUndo();
1892                 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1893                 break;
1894         }
1895
1896         case LFUN_SCREEN_DOWN_SELECT: {
1897                 // FIXME: why is the algorithm different from LFUN_SCREEN_DOWN?
1898                 cur.selHandle(true);
1899                 if (isBottomScreen()) {
1900                         lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1901                         cur.finishUndo();
1902                         break;
1903                 }
1904                 int y = getPos(cur).y_;
1905                 int const ymax = y + height_ - defaultRowHeight();
1906                 while (y < ymax && cur.down())
1907                         y = getPos(cur).y_;
1908
1909                 cur.finishUndo();
1910                 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1911                 break;
1912         }
1913
1914
1915         case LFUN_INSET_SELECT_ALL: {
1916                 // true if all cells are selected
1917                 bool const all_selected = cur.depth() > 1
1918                     && cur.selBegin().at_begin()
1919                     && cur.selEnd().at_end();
1920                 // true if some cells are selected
1921                 bool const cells_selected = cur.depth() > 1
1922                     && cur.selBegin().at_cell_begin()
1923                         && cur.selEnd().at_cell_end();
1924                 if (all_selected || (cells_selected && !cur.inset().isTable())) {
1925                         // All the contents of the inset if selected, or only at
1926                         // least one cell but inset is not a table.
1927                         // Select the inset from outside.
1928                         cur.pop();
1929                         cur.resetAnchor();
1930                         cur.selection(true);
1931                         cur.posForward();
1932                 } else if (cells_selected) {
1933                         // At least one complete cell is selected and inset is a table.
1934                         // Select all cells
1935                         cur.idx() = 0;
1936                         cur.pit() = 0;
1937                         cur.pos() = 0;
1938                         cur.resetAnchor();
1939                         cur.selection(true);
1940                         cur.idx() = cur.lastidx();
1941                         cur.pit() = cur.lastpit();
1942                         cur.pos() = cur.lastpos();
1943                 } else {
1944                         // select current cell
1945                         cur.pit() = 0;
1946                         cur.pos() = 0;
1947                         cur.resetAnchor();
1948                         cur.selection(true);
1949                         cur.pit() = cur.lastpit();
1950                         cur.pos() = cur.lastpos();
1951                 }
1952                 cur.setCurrentFont();
1953                 dr.screenUpdate(Update::Force);
1954                 break;
1955         }
1956
1957
1958         case LFUN_UNICODE_INSERT: {
1959                 if (cmd.argument().empty())
1960                         break;
1961
1962                 FuncCode code = cur.inset().currentMode() == Inset::MATH_MODE ?
1963                         LFUN_MATH_INSERT : LFUN_SELF_INSERT;
1964                 int i = 0;
1965                 while (true) {
1966                         docstring const arg = from_utf8(cmd.getArg(i));
1967                         if (arg.empty())
1968                                 break;
1969                         if (!isHex(arg)) {
1970                                 LYXERR0("Not a hexstring: " << arg);
1971                                 ++i;
1972                                 continue;
1973                         }
1974                         char_type c = hexToInt(arg);
1975                         if (c >= 32 && c < 0x10ffff) {
1976                                 LYXERR(Debug::KEY, "Inserting c: " << c);
1977                                 lyx::dispatch(FuncRequest(code, docstring(1, c)));
1978                         }
1979                         ++i;
1980                 }
1981                 break;
1982         }
1983
1984
1985         // This would be in Buffer class if only Cursor did not
1986         // require a bufferview
1987         case LFUN_INSET_FORALL: {
1988                 docstring const name = from_utf8(cmd.getArg(0));
1989                 string const commandstr = cmd.getLongArg(1);
1990                 FuncRequest const fr = lyxaction.lookupFunc(commandstr);
1991
1992                 // an arbitrary number to limit number of iterations
1993                 const int max_iter = 100000;
1994                 int iterations = 0;
1995                 Cursor & curs = d->cursor_;
1996                 Cursor const savecur = curs;
1997                 curs.reset();
1998                 if (!curs.nextInset())
1999                         curs.forwardInset();
2000                 curs.beginUndoGroup();
2001                 while(curs && iterations < max_iter) {
2002                         Inset * const ins = curs.nextInset();
2003                         if (!ins)
2004                                 break;
2005                         docstring insname = ins->layoutName();
2006                         while (!insname.empty()) {
2007                                 if (insname == name || name == from_utf8("*")) {
2008                                         curs.recordUndo();
2009                                         lyx::dispatch(fr, dr);
2010                                         ++iterations;
2011                                         break;
2012                                 }
2013                                 size_t const i = insname.rfind(':');
2014                                 if (i == string::npos)
2015                                         break;
2016                                 insname = insname.substr(0, i);
2017                         }
2018                         // if we did not delete the inset, skip it
2019                         if (!curs.nextInset() || curs.nextInset() == ins)
2020                                 curs.forwardInset();
2021                 }
2022                 curs = savecur;
2023                 curs.fixIfBroken();
2024                 /** This is a dummy undo record only to remember the cursor
2025                  * that has just been set; this will be used on a redo action
2026                  * (see ticket #10097)
2027
2028                  * FIXME: a better fix would be to have a way to set the
2029                  * cursor value directly, but I am not sure it is worth it.
2030                  */
2031                 curs.recordUndo();
2032                 curs.endUndoGroup();
2033                 dr.screenUpdate(Update::Force);
2034                 dr.forceBufferUpdate();
2035
2036                 if (iterations >= max_iter) {
2037                         dr.setError(true);
2038                         dr.setMessage(bformat(_("`inset-forall' interrupted because number of actions is larger than %1$d"), max_iter));
2039                 } else
2040                         dr.setMessage(bformat(_("Applied \"%1$s\" to %2$d insets"), from_utf8(commandstr), iterations));
2041                 break;
2042         }
2043
2044
2045         case LFUN_BRANCH_ADD_INSERT: {
2046                 docstring branch_name = from_utf8(cmd.getArg(0));
2047                 if (branch_name.empty())
2048                         if (!Alert::askForText(branch_name, _("Branch name")) ||
2049                                                 branch_name.empty())
2050                                 break;
2051
2052                 DispatchResult drtmp;
2053                 buffer_.dispatch(FuncRequest(LFUN_BRANCH_ADD, branch_name), drtmp);
2054                 if (drtmp.error()) {
2055                         Alert::warning(_("Branch already exists"), drtmp.message());
2056                         break;
2057                 }
2058                 docstring const sep = buffer_.params().branchlist().separator();
2059                 for (docstring const & branch : getVectorFromString(branch_name, sep))
2060                         lyx::dispatch(FuncRequest(LFUN_BRANCH_INSERT, branch));
2061                 break;
2062         }
2063
2064         case LFUN_KEYMAP_OFF:
2065                 getIntl().keyMapOn(false);
2066                 break;
2067
2068         case LFUN_KEYMAP_PRIMARY:
2069                 getIntl().keyMapPrim();
2070                 break;
2071
2072         case LFUN_KEYMAP_SECONDARY:
2073                 getIntl().keyMapSec();
2074                 break;
2075
2076         case LFUN_KEYMAP_TOGGLE:
2077                 getIntl().toggleKeyMap();
2078                 break;
2079
2080         case LFUN_DIALOG_SHOW_NEW_INSET: {
2081                 string const name = cmd.getArg(0);
2082                 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
2083                 if (decodeInsetParam(name, data, buffer_))
2084                         lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
2085                 else
2086                         lyxerr << "Inset type '" << name <<
2087                         "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" <<  endl;
2088                 break;
2089         }
2090
2091         case LFUN_CITATION_INSERT: {
2092                 if (argument.empty()) {
2093                         lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
2094                         break;
2095                 }
2096                 // we can have one optional argument, delimited by '|'
2097                 // citation-insert <key>|<text_before>
2098                 // this should be enhanced to also support text_after
2099                 // and citation style
2100                 string arg = argument;
2101                 string opt1;
2102                 if (contains(argument, "|")) {
2103                         arg = token(argument, '|', 0);
2104                         opt1 = token(argument, '|', 1);
2105                 }
2106
2107                 // if our cursor is directly in front of or behind a citation inset,
2108                 // we will instead add the new key to it.
2109                 Inset * inset = cur.nextInset();
2110                 if (!inset || inset->lyxCode() != CITE_CODE)
2111                         inset = cur.prevInset();
2112                 if (inset && inset->lyxCode() == CITE_CODE) {
2113                         InsetCitation * icite = static_cast<InsetCitation *>(inset);
2114                         if (icite->addKey(arg)) {
2115                                 dr.forceBufferUpdate();
2116                                 dr.screenUpdate(Update::FitCursor | Update::SinglePar);
2117                                 if (!opt1.empty())
2118                                         LYXERR0("Discarding optional argument to citation-insert.");
2119                         }
2120                         dispatched = true;
2121                         break;
2122                 }
2123                 InsetCommandParams icp(CITE_CODE);
2124                 icp["key"] = from_utf8(arg);
2125                 if (!opt1.empty())
2126                         icp["before"] = from_utf8(opt1);
2127                 icp["literal"] =
2128                         from_ascii(InsetCitation::last_literal ? "true" : "false");
2129                 string icstr = InsetCommand::params2string(icp);
2130                 FuncRequest fr(LFUN_INSET_INSERT, icstr);
2131                 lyx::dispatch(fr);
2132                 break;
2133         }
2134
2135         case LFUN_INSET_APPLY: {
2136                 string const name = cmd.getArg(0);
2137                 Inset * inset = editedInset(name);
2138                 if (!inset) {
2139                         FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
2140                         lyx::dispatch(fr);
2141                         break;
2142                 }
2143                 // put cursor in front of inset.
2144                 if (!setCursorFromInset(inset)) {
2145                         LASSERT(false, break);
2146                 }
2147                 cur.recordUndo();
2148                 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
2149                 inset->dispatch(cur, fr);
2150                 dr.screenUpdate(cur.result().screenUpdate());
2151                 if (cur.result().needBufferUpdate())
2152                         dr.forceBufferUpdate();
2153                 break;
2154         }
2155
2156         // FIXME:
2157         // The change of language of buffer belongs to the Buffer class.
2158         // We have to do it here because we need a cursor for Undo.
2159         // When Undo::recordUndoBufferParams() is implemented someday
2160         // LFUN_BUFFER_LANGUAGE should be handled by the Buffer class.
2161         case LFUN_BUFFER_LANGUAGE: {
2162                 Language const * oldL = buffer_.params().language;
2163                 Language const * newL = languages.getLanguage(argument);
2164                 if (!newL || oldL == newL)
2165                         break;
2166                 if (oldL->rightToLeft() == newL->rightToLeft()) {
2167                         cur.recordUndoFullBuffer();
2168                         buffer_.changeLanguage(oldL, newL);
2169                         cur.setCurrentFont();
2170                         dr.forceBufferUpdate();
2171                 }
2172                 break;
2173         }
2174
2175         case LFUN_FILE_INSERT_PLAINTEXT_PARA:
2176         case LFUN_FILE_INSERT_PLAINTEXT: {
2177                 bool const as_paragraph = (act == LFUN_FILE_INSERT_PLAINTEXT_PARA);
2178                 string const fname = to_utf8(cmd.argument());
2179                 if (!FileName::isAbsolute(fname))
2180                         dr.setMessage(_("Absolute filename expected."));
2181                 else
2182                         insertPlaintextFile(FileName(fname), as_paragraph);
2183                 break;
2184         }
2185
2186         default:
2187                 // OK, so try the Buffer itself...
2188                 buffer_.dispatch(cmd, dr);
2189                 dispatched = dr.dispatched();
2190                 break;
2191         }
2192
2193         buffer_.undo().endUndoGroup();
2194         dr.dispatched(dispatched);
2195
2196         // NOTE: The code below is copied from Cursor::dispatch. If you
2197         // need to modify this, please update the other one too.
2198
2199         // notify insets we just entered/left
2200         if (cursor() != old) {
2201                 old.beginUndoGroup();
2202                 old.fixIfBroken();
2203                 bool badcursor = notifyCursorLeavesOrEnters(old, cursor());
2204                 if (badcursor) {
2205                         cursor().fixIfBroken();
2206                         resetInlineCompletionPos();
2207                 }
2208                 old.endUndoGroup();
2209         }
2210 }
2211
2212
2213 docstring BufferView::requestSelection()
2214 {
2215         Cursor & cur = d->cursor_;
2216
2217         LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
2218         if (!cur.selection()) {
2219                 d->xsel_cache_.set = false;
2220                 return docstring();
2221         }
2222
2223         LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
2224         if (!d->xsel_cache_.set ||
2225             cur.top() != d->xsel_cache_.cursor ||
2226             cur.realAnchor().top() != d->xsel_cache_.anchor)
2227         {
2228                 d->xsel_cache_.cursor = cur.top();
2229                 d->xsel_cache_.anchor = cur.realAnchor().top();
2230                 d->xsel_cache_.set = cur.selection();
2231                 return cur.selectionAsString(false);
2232         }
2233         return docstring();
2234 }
2235
2236
2237 void BufferView::clearSelection()
2238 {
2239         d->cursor_.clearSelection();
2240         // Clear the selection buffer. Otherwise a subsequent
2241         // middle-mouse-button paste would use the selection buffer,
2242         // not the more current external selection.
2243         cap::clearSelection();
2244         d->xsel_cache_.set = false;
2245         // The buffer did not really change, but this causes the
2246         // redraw we need because we cleared the selection above.
2247         buffer_.changed(false);
2248 }
2249
2250
2251 void BufferView::resize(int width, int height)
2252 {
2253         // Update from work area
2254         width_ = width;
2255         height_ = height;
2256
2257         // Clear the paragraph height cache.
2258         d->par_height_.clear();
2259         // Redo the metrics.
2260         updateMetrics();
2261 }
2262
2263
2264 Inset const * BufferView::getCoveringInset(Text const & text,
2265                 int x, int y) const
2266 {
2267         TextMetrics & tm = d->text_metrics_[&text];
2268         Inset * inset = tm.checkInsetHit(x, y);
2269         if (!inset)
2270                 return nullptr;
2271
2272         if (!inset->descendable(*this))
2273                 // No need to go further down if the inset is not
2274                 // descendable.
2275                 return inset;
2276
2277         size_t cell_number = inset->nargs();
2278         // Check all the inner cell.
2279         for (size_t i = 0; i != cell_number; ++i) {
2280                 Text const * inner_text = inset->getText(i);
2281                 if (inner_text) {
2282                         // Try deeper.
2283                         Inset const * inset_deeper =
2284                                 getCoveringInset(*inner_text, x, y);
2285                         if (inset_deeper)
2286                                 return inset_deeper;
2287                 }
2288         }
2289
2290         return inset;
2291 }
2292
2293
2294 void BufferView::updateHoveredInset() const
2295 {
2296         // Get inset under mouse, if there is one.
2297         int const x = d->mouse_position_cache_.x_;
2298         int const y = d->mouse_position_cache_.y_;
2299         Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
2300
2301         d->clickable_inset_ = covering_inset && covering_inset->clickable(*this, x, y);
2302
2303         if (covering_inset == d->last_inset_)
2304                 // Same inset, no need to do anything...
2305                 return;
2306
2307         bool need_redraw = false;
2308         if (d->last_inset_) {
2309                 // Remove the hint on the last hovered inset (if any).
2310                 need_redraw |= d->last_inset_->setMouseHover(this, false);
2311                 d->last_inset_ = nullptr;
2312         }
2313
2314         if (covering_inset && covering_inset->setMouseHover(this, true)) {
2315                 need_redraw = true;
2316                 // Only the insets that accept the hover state, do
2317                 // clear the last_inset_, so only set the last_inset_
2318                 // member if the hovered setting is accepted.
2319                 d->last_inset_ = covering_inset;
2320         }
2321
2322         if (need_redraw) {
2323                 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
2324                                 << d->mouse_position_cache_.x_ << ", "
2325                                 << d->mouse_position_cache_.y_ << ")");
2326
2327                 d->update_strategy_ = DecorationUpdate;
2328
2329                 // This event (moving without mouse click) is not passed further.
2330                 // This should be changed if it is further utilized.
2331                 buffer_.changed(false);
2332         }
2333 }
2334
2335
2336 void BufferView::clearLastInset(Inset * inset) const
2337 {
2338         if (d->last_inset_ != inset) {
2339                 LYXERR0("Wrong last_inset!");
2340                 LATTEST(false);
2341         }
2342         d->last_inset_ = nullptr;
2343 }
2344
2345
2346 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
2347 {
2348         //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
2349
2350         // This is only called for mouse related events including
2351         // LFUN_FILE_OPEN generated by drag-and-drop.
2352         FuncRequest cmd = cmd0;
2353
2354         Cursor old = cursor();
2355         Cursor cur(*this);
2356         cur.push(buffer_.inset());
2357         cur.selection(d->cursor_.selection());
2358
2359         // Either the inset under the cursor or the
2360         // surrounding Text will handle this event.
2361
2362         // make sure we stay within the screen...
2363         cmd.set_y(min(max(cmd.y(), -1), height_));
2364
2365         d->mouse_position_cache_.x_ = cmd.x();
2366         d->mouse_position_cache_.y_ = cmd.y();
2367
2368         if (cmd.action() == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
2369                 updateHoveredInset();
2370                 return;
2371         }
2372
2373         // Build temporary cursor.
2374         Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x(), cmd.y());
2375         if (inset) {
2376                 // If inset is not editable, cur.pos() might point behind the
2377                 // inset (depending on cmd.x(), cmd.y()). This is needed for
2378                 // editing to fix bug 9628, but e.g. the context menu needs a
2379                 // cursor in front of the inset.
2380                 if ((inset->hasSettings() || !inset->contextMenuName().empty()
2381                      || inset->lyxCode() == SEPARATOR_CODE) &&
2382                     cur.nextInset() != inset && cur.prevInset() == inset)
2383                         cur.posBackward();
2384         } else if (cur.inTexted() && cur.pos()
2385                         && cur.paragraph().isEnvSeparator(cur.pos() - 1)) {
2386                 // Always place cursor in front of a separator inset.
2387                 cur.posBackward();
2388         }
2389
2390         // Put anchor at the same position.
2391         cur.resetAnchor();
2392
2393         cur.beginUndoGroup();
2394
2395         // Try to dispatch to an non-editable inset near this position
2396         // via the temp cursor. If the inset wishes to change the real
2397         // cursor it has to do so explicitly by using
2398         //  cur.bv().cursor() = cur;  (or similar)
2399         if (inset)
2400                 inset->dispatch(cur, cmd);
2401
2402         // Now dispatch to the temporary cursor. If the real cursor should
2403         // be modified, the inset's dispatch has to do so explicitly.
2404         if (!inset || !cur.result().dispatched())
2405                 cur.dispatch(cmd);
2406
2407         // Notify left insets
2408         if (cur != old) {
2409                 bool badcursor = old.fixIfBroken() | cur.fixIfBroken();
2410                 badcursor |= notifyCursorLeavesOrEnters(old, cur);
2411                 if (badcursor)
2412                         cursor().fixIfBroken();
2413         }
2414
2415         cur.endUndoGroup();
2416
2417         // Do we have a selection?
2418         theSelection().haveSelection(cursor().selection());
2419
2420         if (cur.needBufferUpdate()) {
2421                 cur.clearBufferUpdate();
2422                 buffer().updateBuffer();
2423         }
2424
2425         // If the command has been dispatched,
2426         if (cur.result().dispatched() || cur.result().screenUpdate())
2427                 processUpdateFlags(cur.result().screenUpdate());
2428 }
2429
2430
2431 int BufferView::minVisiblePart()
2432 {
2433         return 2 * defaultRowHeight();
2434 }
2435
2436
2437 int BufferView::scroll(int y)
2438 {
2439         if (y > 0)
2440                 return scrollDown(y);
2441         if (y < 0)
2442                 return scrollUp(-y);
2443         return 0;
2444 }
2445
2446
2447 int BufferView::scrollDown(int offset)
2448 {
2449         Text * text = &buffer_.text();
2450         TextMetrics & tm = d->text_metrics_[text];
2451         int const ymax = height_ + offset;
2452         while (true) {
2453                 pair<pit_type, ParagraphMetrics const *> last = tm.last();
2454                 int bottom_pos = last.second->position() + last.second->descent();
2455                 if (lyxrc.scroll_below_document)
2456                         bottom_pos += height_ - minVisiblePart();
2457                 if (last.first + 1 == int(text->paragraphs().size())) {
2458                         if (bottom_pos <= height_)
2459                                 return 0;
2460                         offset = min(offset, bottom_pos - height_);
2461                         break;
2462                 }
2463                 if (bottom_pos > ymax)
2464                         break;
2465                 tm.newParMetricsDown();
2466         }
2467         d->anchor_ypos_ -= offset;
2468         return -offset;
2469 }
2470
2471
2472 int BufferView::scrollUp(int offset)
2473 {
2474         Text * text = &buffer_.text();
2475         TextMetrics & tm = d->text_metrics_[text];
2476         int ymin = - offset;
2477         while (true) {
2478                 pair<pit_type, ParagraphMetrics const *> first = tm.first();
2479                 int top_pos = first.second->position() - first.second->ascent();
2480                 if (first.first == 0) {
2481                         if (top_pos >= 0)
2482                                 return 0;
2483                         offset = min(offset, - top_pos);
2484                         break;
2485                 }
2486                 if (top_pos < ymin)
2487                         break;
2488                 tm.newParMetricsUp();
2489         }
2490         d->anchor_ypos_ += offset;
2491         return offset;
2492 }
2493
2494
2495 bool BufferView::setCursorFromRow(int row)
2496 {
2497         TexRow::TextEntry start, end;
2498         tie(start,end) = buffer_.texrow().getEntriesFromRow(row);
2499         LYXERR(Debug::LATEX,
2500                "setCursorFromRow: for row " << row << ", TexRow has found "
2501                "start (id=" << start.id << ",pos=" << start.pos << "), "
2502                "end (id=" << end.id << ",pos=" << end.pos << ")");
2503         return setCursorFromEntries(start, end);
2504 }
2505
2506
2507 bool BufferView::setCursorFromEntries(TexRow::TextEntry start,
2508                                       TexRow::TextEntry end)
2509 {
2510         DocIterator dit_start, dit_end;
2511         tie(dit_start,dit_end) =
2512                 TexRow::getDocIteratorsFromEntries(start, end, buffer_);
2513         if (!dit_start)
2514                 return false;
2515         // Setting selection start
2516         d->cursor_.clearSelection();
2517         setCursor(dit_start);
2518         // Setting selection end
2519         if (dit_end) {
2520                 d->cursor_.resetAnchor();
2521                 setCursorSelectionTo(dit_end);
2522         }
2523         return true;
2524 }
2525
2526
2527 bool BufferView::setCursorFromInset(Inset const * inset)
2528 {
2529         // are we already there?
2530         if (cursor().nextInset() == inset)
2531                 return true;
2532
2533         // Inset is not at cursor position. Find it in the document.
2534         Cursor cur(*this);
2535         cur.reset();
2536         while (cur && cur.nextInset() != inset)
2537                 cur.forwardInset();
2538
2539         if (cur) {
2540                 setCursor(cur);
2541                 return true;
2542         }
2543         return false;
2544 }
2545
2546
2547 void BufferView::gotoLabel(docstring const & label)
2548 {
2549         FuncRequest action;
2550         bool have_inactive = false;
2551         for (Buffer const * buf : buffer().allRelatives()) {
2552                 // find label
2553                 for (TocItem const & item : *buf->tocBackend().toc("label")) {
2554                         if (label == item.str() && item.isOutput()) {
2555                                 lyx::dispatch(item.action());
2556                                 return;
2557                         }
2558                         // If we find an inactive label, save it for the case
2559                         // that no active one is there
2560                         if (label == item.str() && !have_inactive) {
2561                                 have_inactive = true;
2562                                 action = item.action();
2563                         }
2564                 }
2565         }
2566         // We only found an inactive label. Go there.
2567         if (have_inactive)
2568                 lyx::dispatch(action);
2569 }
2570
2571
2572 TextMetrics const & BufferView::textMetrics(Text const * t) const
2573 {
2574         return const_cast<BufferView *>(this)->textMetrics(t);
2575 }
2576
2577
2578 TextMetrics & BufferView::textMetrics(Text const * t)
2579 {
2580         LBUFERR(t);
2581         TextMetricsCache::iterator tmc_it  = d->text_metrics_.find(t);
2582         if (tmc_it == d->text_metrics_.end()) {
2583                 tmc_it = d->text_metrics_.emplace(std::piecewise_construct,
2584                                 std::forward_as_tuple(t),
2585                                 std::forward_as_tuple(this, const_cast<Text *>(t))).first;
2586         }
2587         return tmc_it->second;
2588 }
2589
2590
2591 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
2592                 pit_type pit) const
2593 {
2594         return textMetrics(t).parMetrics(pit);
2595 }
2596
2597
2598 int BufferView::workHeight() const
2599 {
2600         return height_;
2601 }
2602
2603
2604 void BufferView::setCursor(DocIterator const & dit)
2605 {
2606         d->cursor_.reset();
2607         size_t const n = dit.depth();
2608         for (size_t i = 0; i < n; ++i)
2609                 dit[i].inset().edit(d->cursor_, true);
2610
2611         d->cursor_.setCursor(dit);
2612         d->cursor_.selection(false);
2613         d->cursor_.setCurrentFont();
2614         // FIXME
2615         // It seems on general grounds as if this is probably needed, but
2616         // it is not yet clear.
2617         // See bug #7394 and r38388.
2618         // d->cursor.resetAnchor();
2619 }
2620
2621
2622 void BufferView::setCursorSelectionTo(DocIterator const & dit)
2623 {
2624         size_t const n = dit.depth();
2625         for (size_t i = 0; i < n; ++i)
2626                 dit[i].inset().edit(d->cursor_, true);
2627
2628         d->cursor_.selection(true);
2629         d->cursor_.setCursorSelectionTo(dit);
2630         d->cursor_.setCurrentFont();
2631 }
2632
2633
2634 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
2635 {
2636         // Would be wrong to delete anything if we have a selection.
2637         if (cur.selection())
2638                 return false;
2639
2640         bool need_anchor_change = false;
2641         bool changed = Text::deleteEmptyParagraphMechanism(cur, old,
2642                 need_anchor_change);
2643
2644         if (need_anchor_change)
2645                 cur.resetAnchor();
2646
2647         if (!changed)
2648                 return false;
2649
2650         d->cursor_ = cur;
2651
2652         // we would rather not do this here, but it needs to be done before
2653         // the changed() signal is sent.
2654         buffer_.updateBuffer();
2655
2656         buffer_.changed(true);
2657         return true;
2658 }
2659
2660
2661 bool BufferView::mouseSetCursor(Cursor & cur, bool const select)
2662 {
2663         LASSERT(&cur.bv() == this, return false);
2664
2665         if (!select)
2666                 // this event will clear selection so we save selection for
2667                 // persistent selection
2668                 cap::saveSelection(cursor());
2669
2670         d->cursor_.macroModeClose();
2671         // If a macro has been finalized, the cursor might have been broken
2672         cur.fixIfBroken();
2673
2674         // Has the cursor just left the inset?
2675         bool const leftinset = (&d->cursor_.inset() != &cur.inset());
2676         if (leftinset)
2677                 d->cursor_.fixIfBroken();
2678
2679         // do the dEPM magic if needed
2680         // FIXME: (1) move this to InsetText::notifyCursorLeaves?
2681         // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
2682         // the leftinset bool would not be necessary (badcursor instead).
2683         bool update = leftinset;
2684
2685         if (select) {
2686                 d->cursor_.setSelection();
2687                 d->cursor_.setCursorSelectionTo(cur);
2688         } else {
2689                 if (d->cursor_.inTexted())
2690                         update |= checkDepm(cur, d->cursor_);
2691                 d->cursor_.resetAnchor();
2692                 d->cursor_.setCursor(cur);
2693                 d->cursor_.clearSelection();
2694         }
2695         d->cursor_.boundary(cur.boundary());
2696         d->cursor_.finishUndo();
2697         d->cursor_.setCurrentFont();
2698         if (update)
2699                 cur.forceBufferUpdate();
2700         return update;
2701 }
2702
2703
2704 void BufferView::putSelectionAt(DocIterator const & cur,
2705                                 int length, bool backwards)
2706 {
2707         d->cursor_.clearSelection();
2708
2709         setCursor(cur);
2710
2711         if (length) {
2712                 if (backwards) {
2713                         d->cursor_.pos() += length;
2714                         d->cursor_.setSelection(d->cursor_, -length);
2715                 } else
2716                         d->cursor_.setSelection(d->cursor_, length);
2717         }
2718 }
2719
2720
2721 bool BufferView::selectIfEmpty(DocIterator & cur)
2722 {
2723         if ((cur.inTexted() && !cur.paragraph().empty())
2724             || (cur.inMathed() && !cur.cell().empty()))
2725                 return false;
2726
2727         pit_type const beg_pit = cur.pit();
2728         if (beg_pit > 0) {
2729                 // The paragraph associated to this item isn't
2730                 // the first one, so it can be selected
2731                 cur.backwardPos();
2732         } else {
2733                 // We have to resort to select the space between the
2734                 // end of this item and the begin of the next one
2735                 cur.forwardPos();
2736         }
2737         if (cur.empty()) {
2738                 // If it is the only item in the document,
2739                 // nothing can be selected
2740                 return false;
2741         }
2742         pit_type const end_pit = cur.pit();
2743         pos_type const end_pos = cur.pos();
2744         d->cursor_.clearSelection();
2745         d->cursor_.reset();
2746         d->cursor_.setCursor(cur);
2747         d->cursor_.pit() = beg_pit;
2748         d->cursor_.pos() = 0;
2749         d->cursor_.selection(false);
2750         d->cursor_.resetAnchor();
2751         d->cursor_.pit() = end_pit;
2752         d->cursor_.pos() = end_pos;
2753         d->cursor_.setSelection();
2754         return true;
2755 }
2756
2757
2758 Cursor & BufferView::cursor()
2759 {
2760         return d->cursor_;
2761 }
2762
2763
2764 Cursor const & BufferView::cursor() const
2765 {
2766         return d->cursor_;
2767 }
2768
2769
2770 bool BufferView::singleParUpdate()
2771 {
2772         Text & buftext = buffer_.text();
2773         pit_type const bottom_pit = d->cursor_.bottom().pit();
2774         TextMetrics & tm = textMetrics(&buftext);
2775         int old_height = tm.parMetrics(bottom_pit).height();
2776
2777         // make sure inline completion pointer is ok
2778         if (d->inlineCompletionPos_.fixIfBroken())
2779                 d->inlineCompletionPos_ = DocIterator();
2780
2781         // In Single Paragraph mode, rebreak only
2782         // the (main text, not inset!) paragraph containing the cursor.
2783         // (if this paragraph contains insets etc., rebreaking will
2784         // recursively descend)
2785         tm.redoParagraph(bottom_pit);
2786         ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
2787         if (pm.height() != old_height)
2788                 // Paragraph height has changed so we cannot proceed to
2789                 // the singlePar optimisation.
2790                 return false;
2791
2792         tm.updatePosCache(bottom_pit);
2793
2794         LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
2795                 << " y2: " << pm.position() + pm.descent()
2796                 << " pit: " << bottom_pit
2797                 << " singlepar: 1");
2798         return true;
2799 }
2800
2801
2802 void BufferView::updateMetrics()
2803 {
2804         updateMetrics(d->update_flags_);
2805         d->update_strategy_ = FullScreenUpdate;
2806 }
2807
2808
2809 void BufferView::updateMetrics(Update::flags & update_flags)
2810 {
2811         if (height_ == 0 || width_ == 0)
2812                 return;
2813
2814         Text & buftext = buffer_.text();
2815         pit_type const npit = int(buftext.paragraphs().size());
2816
2817         // Clear out the position cache in case of full screen redraw,
2818         d->coord_cache_.clear();
2819         d->math_rows_.clear();
2820
2821         // Clear out paragraph metrics to avoid having invalid metrics
2822         // in the cache from paragraphs not relayouted below
2823         // The complete text metrics will be redone.
2824         d->text_metrics_.clear();
2825
2826         TextMetrics & tm = textMetrics(&buftext);
2827
2828         // make sure inline completion pointer is ok
2829         if (d->inlineCompletionPos_.fixIfBroken())
2830                 d->inlineCompletionPos_ = DocIterator();
2831
2832         if (d->anchor_pit_ >= npit)
2833                 // The anchor pit must have been deleted...
2834                 d->anchor_pit_ = npit - 1;
2835
2836         // Rebreak anchor paragraph.
2837         tm.redoParagraph(d->anchor_pit_);
2838         ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
2839
2840         // position anchor
2841         if (d->anchor_pit_ == 0) {
2842                 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
2843
2844                 // Complete buffer visible? Then it's easy.
2845                 if (scrollRange == 0)
2846                         d->anchor_ypos_ = anchor_pm.ascent();
2847                 else {
2848                         // avoid empty space above the first row
2849                         d->anchor_ypos_ = min(d->anchor_ypos_, anchor_pm.ascent());
2850                 }
2851         }
2852         anchor_pm.setPosition(d->anchor_ypos_);
2853         tm.updatePosCache(d->anchor_pit_);
2854
2855         LYXERR(Debug::PAINTING, "metrics: "
2856                 << " anchor pit = " << d->anchor_pit_
2857                 << " anchor ypos = " << d->anchor_ypos_);
2858
2859         // Redo paragraphs above anchor if necessary.
2860         int y1 = d->anchor_ypos_ - anchor_pm.ascent();
2861         // We are now just above the anchor paragraph.
2862         pit_type pit1 = d->anchor_pit_ - 1;
2863         for (; pit1 >= 0 && y1 >= 0; --pit1) {
2864                 tm.redoParagraph(pit1);
2865                 ParagraphMetrics & pm = tm.par_metrics_[pit1];
2866                 y1 -= pm.descent();
2867                 // Save the paragraph position in the cache.
2868                 pm.setPosition(y1);
2869                 tm.updatePosCache(pit1);
2870                 y1 -= pm.ascent();
2871         }
2872
2873         // Redo paragraphs below the anchor if necessary.
2874         int y2 = d->anchor_ypos_ + anchor_pm.descent();
2875         // We are now just below the anchor paragraph.
2876         pit_type pit2 = d->anchor_pit_ + 1;
2877         for (; pit2 < npit && y2 <= height_; ++pit2) {
2878                 tm.redoParagraph(pit2);
2879                 ParagraphMetrics & pm = tm.par_metrics_[pit2];
2880                 y2 += pm.ascent();
2881                 // Save the paragraph position in the cache.
2882                 pm.setPosition(y2);
2883                 tm.updatePosCache(pit2);
2884                 y2 += pm.descent();
2885         }
2886
2887         LYXERR(Debug::PAINTING, "Metrics: "
2888                 << " anchor pit = " << d->anchor_pit_
2889                 << " anchor ypos = " << d->anchor_ypos_
2890                 << " y1 = " << y1
2891                 << " y2 = " << y2
2892                 << " pit1 = " << pit1
2893                 << " pit2 = " << pit2);
2894
2895         // metrics is done, full drawing is necessary now
2896         update_flags = (update_flags & ~Update::Force) | Update::ForceDraw;
2897
2898         // Now update the positions of insets in the cache.
2899         updatePosCache();
2900
2901         if (lyxerr.debugging(Debug::WORKAREA)) {
2902                 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
2903                 d->coord_cache_.dump();
2904         }
2905 }
2906
2907
2908 void BufferView::updatePosCache()
2909 {
2910         // this is the "nodraw" drawing stage: only set the positions of the
2911         // insets in metrics cache.
2912         frontend::NullPainter np;
2913         draw(np, false);
2914 }
2915
2916
2917 void BufferView::insertLyXFile(FileName const & fname, bool const ignorelang)
2918 {
2919         LASSERT(d->cursor_.inTexted(), return);
2920
2921         // Get absolute path of file and add ".lyx"
2922         // to the filename if necessary
2923         FileName filename = fileSearch(string(), fname.absFileName(), "lyx");
2924
2925         docstring const disp_fn = makeDisplayPath(filename.absFileName());
2926         // emit message signal.
2927         message(bformat(_("Inserting document %1$s..."), disp_fn));
2928
2929         docstring res;
2930         Buffer buf(filename.absFileName(), false);
2931         if (buf.loadLyXFile() == Buffer::ReadSuccess) {
2932                 ErrorList & el = buffer_.errorList("Parse");
2933                 // Copy the inserted document error list into the current buffer one.
2934                 el = buf.errorList("Parse");
2935                 ParagraphList & pars = buf.paragraphs();
2936                 if (ignorelang)
2937                         // set main language of imported file to context language
2938                         buf.changeLanguage(buf.language(), d->cursor_.getFont().language());
2939                 buffer_.undo().recordUndo(d->cursor_);
2940                 cap::pasteParagraphList(d->cursor_, pars,
2941                                              buf.params().documentClassPtr(), el);
2942                 res = _("Document %1$s inserted.");
2943         } else {
2944                 res = _("Could not insert document %1$s");
2945         }
2946
2947         buffer_.changed(true);
2948         // emit message signal.
2949         message(bformat(res, disp_fn));
2950 }
2951
2952
2953 Point BufferView::coordOffset(DocIterator const & dit) const
2954 {
2955         int x = 0;
2956         int y = 0;
2957         int lastw = 0;
2958
2959         // Addup contribution of nested insets, from inside to outside,
2960         // keeping the outer paragraph for a special handling below
2961         for (size_t i = dit.depth() - 1; i >= 1; --i) {
2962                 CursorSlice const & sl = dit[i];
2963                 int xx = 0;
2964                 int yy = 0;
2965
2966                 // get relative position inside sl.inset()
2967                 sl.inset().cursorPos(*this, sl, dit.boundary() && (i + 1 == dit.depth()), xx, yy);
2968
2969                 // Make relative position inside of the edited inset relative to sl.inset()
2970                 x += xx;
2971                 y += yy;
2972
2973                 // In case of an RTL inset, the edited inset will be positioned to the left
2974                 // of xx:yy
2975                 if (sl.text()) {
2976                         bool boundary_i = dit.boundary() && i + 1 == dit.depth();
2977                         bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2978                         if (rtl)
2979                                 x -= lastw;
2980                 }
2981
2982                 // remember width for the case that sl.inset() is positioned in an RTL inset
2983                 lastw = sl.inset().dimension(*this).wid;
2984
2985                 //lyxerr << "Cursor::getPos, i: "
2986                 // << i << " x: " << xx << " y: " << y << endl;
2987         }
2988
2989         // Add contribution of initial rows of outermost paragraph
2990         CursorSlice const & sl = dit[0];
2991         TextMetrics const & tm = textMetrics(sl.text());
2992         ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2993
2994         LBUFERR(!pm.rows().empty());
2995         y -= pm.rows()[0].ascent();
2996 #if 1
2997         // FIXME: document this mess
2998         size_t rend;
2999         if (sl.pos() > 0 && dit.depth() == 1) {
3000                 int pos = sl.pos();
3001                 if (pos && dit.boundary())
3002                         --pos;
3003 //              lyxerr << "coordOffset: boundary:" << dit.boundary() << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
3004                 rend = pm.pos2row(pos);
3005         } else
3006                 rend = pm.pos2row(sl.pos());
3007 #else
3008         size_t rend = pm.pos2row(sl.pos());
3009 #endif
3010         for (size_t rit = 0; rit != rend; ++rit)
3011                 y += pm.rows()[rit].height();
3012         y += pm.rows()[rend].ascent();
3013
3014         TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
3015
3016         // Make relative position from the nested inset now bufferview absolute.
3017         int xx = bottom_tm.cursorX(dit.bottom(), dit.boundary() && dit.depth() == 1);
3018         x += xx;
3019
3020         // In the RTL case place the nested inset at the left of the cursor in
3021         // the outer paragraph
3022         bool boundary_1 = dit.boundary() && 1 == dit.depth();
3023         bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
3024         if (rtl)
3025                 x -= lastw;
3026
3027         return Point(x, y);
3028 }
3029
3030
3031 Point BufferView::getPos(DocIterator const & dit) const
3032 {
3033         if (!paragraphVisible(dit))
3034                 return Point(-1, -1);
3035
3036         CursorSlice const & bot = dit.bottom();
3037         TextMetrics const & tm = textMetrics(bot.text());
3038
3039         // offset from outer paragraph
3040         Point p = coordOffset(dit);
3041         p.y_ += tm.parMetrics(bot.pit()).position();
3042         return p;
3043 }
3044
3045
3046 bool BufferView::paragraphVisible(DocIterator const & dit) const
3047 {
3048         CursorSlice const & bot = dit.bottom();
3049         TextMetrics const & tm = textMetrics(bot.text());
3050
3051         return tm.contains(bot.pit());
3052 }
3053
3054
3055 void BufferView::caretPosAndHeight(Point & p, int & h) const
3056 {
3057         int asc, des;
3058         Cursor const & cur = cursor();
3059         if (cur.inMathed()) {
3060                 MathRow const & mrow = mathRow(&cur.cell());
3061                 asc = mrow.caret_ascent;
3062                 des = mrow.caret_descent;
3063         } else {
3064                 Font const font = cur.real_current_font;
3065                 frontend::FontMetrics const & fm = theFontMetrics(font);
3066                 asc = fm.maxAscent();
3067                 des = fm.maxDescent();
3068         }
3069         h = asc + des;
3070         p = getPos(cur);
3071         p.y_ -= asc;
3072 }
3073
3074
3075 bool BufferView::caretInView() const
3076 {
3077         if (!paragraphVisible(cursor()))
3078                 return false;
3079         Point p;
3080         int h;
3081         caretPosAndHeight(p, h);
3082
3083         // does the cursor touch the screen ?
3084         if (p.y_ + h < 0 || p.y_ >= workHeight())
3085                 return false;
3086         return true;
3087 }
3088
3089
3090 int BufferView::horizScrollOffset() const
3091 {
3092         return d->horiz_scroll_offset_;
3093 }
3094
3095
3096 int BufferView::horizScrollOffset(Text const * text,
3097                                   pit_type pit, pos_type pos) const
3098 {
3099         // Is this a row that is currently scrolled?
3100         if (!d->current_row_slice_.empty()
3101             && &text->inset() == d->current_row_slice_.inset().asInsetText()
3102             && pit ==  d->current_row_slice_.pit()
3103             && pos ==  d->current_row_slice_.pos())
3104                 return d->horiz_scroll_offset_;
3105         return 0;
3106 }
3107
3108
3109 void BufferView::setCurrentRowSlice(CursorSlice const & rowSlice)
3110 {
3111         // nothing to do if the cursor was already on this row
3112         if (d->current_row_slice_ == rowSlice)
3113                 return;
3114
3115         // if the (previous) current row was scrolled, we have to
3116         // remember it in order to repaint it next time.
3117         if (d->horiz_scroll_offset_ != 0) {
3118                 // search the old row in cache and mark it changed
3119                 for (auto & tm_pair : d->text_metrics_) {
3120                         if (&tm_pair.first->inset() == rowSlice.inset().asInsetText()) {
3121                                 tm_pair.second.setRowChanged(rowSlice.pit(), rowSlice.pos());
3122                                 // We found it, no need to continue.
3123                                 break;
3124                         }
3125                 }
3126         }
3127
3128         // Since we changed row, the scroll offset is not valid anymore
3129         d->horiz_scroll_offset_ = 0;
3130         d->current_row_slice_ = rowSlice;
3131 }
3132
3133
3134 void BufferView::checkCursorScrollOffset()
3135 {
3136         CursorSlice rowSlice = d->cursor_.bottom();
3137         TextMetrics const & tm = textMetrics(rowSlice.text());
3138
3139         // Stop if metrics have not been computed yet, since it means
3140         // that there is nothing to do.
3141         if (!tm.contains(rowSlice.pit()))
3142                 return;
3143         ParagraphMetrics const & pm = tm.parMetrics(rowSlice.pit());
3144         Row const & row = pm.getRow(rowSlice.pos(),
3145                                     d->cursor_.boundary() && rowSlice == d->cursor_.top());
3146         rowSlice.pos() = row.pos();
3147
3148         // Set the row on which the cursor lives.
3149         setCurrentRowSlice(rowSlice);
3150
3151         // Current x position of the cursor in pixels
3152         int cur_x = getPos(d->cursor_).x_;
3153
3154         // Horizontal scroll offset of the cursor row in pixels
3155         int offset = d->horiz_scroll_offset_;
3156         int const MARGIN = 2 * theFontMetrics(d->cursor_.real_current_font).em()
3157                            + row.right_margin;
3158         if (row.right_x() <= workWidth() - row.right_margin) {
3159                 // Row is narrower than the work area, no offset needed.
3160                 offset = 0;
3161         } else {
3162                 if (cur_x - offset < MARGIN) {
3163                         // cursor would be too far right
3164                         offset = cur_x - MARGIN;
3165                 } else if (cur_x - offset > workWidth() - MARGIN) {
3166                         // cursor would be too far left
3167                         offset = cur_x - workWidth() + MARGIN;
3168                 }
3169                 // Correct the offset to make sure that we do not scroll too much
3170                 if (offset < 0)
3171                         offset = 0;
3172                 if (row.right_x() - offset < workWidth() - row.right_margin)
3173                         offset = row.right_x() - workWidth() + row.right_margin;
3174         }
3175
3176         //lyxerr << "cur_x=" << cur_x << ", offset=" << offset << ", row.wid=" << row.width() << ", margin=" << MARGIN << endl;
3177
3178         if (offset != d->horiz_scroll_offset_)
3179                 LYXERR(Debug::PAINTING, "Horiz. scroll offset changed from "
3180                        << d->horiz_scroll_offset_ << " to " << offset);
3181
3182         if (d->update_strategy_ == NoScreenUpdate
3183             && offset != d->horiz_scroll_offset_) {
3184                 // FIXME: if one uses SingleParUpdate, then home/end
3185                 // will not work on long rows. Why?
3186                 d->update_strategy_ = FullScreenUpdate;
3187         }
3188
3189         d->horiz_scroll_offset_ = offset;
3190 }
3191
3192
3193 void BufferView::draw(frontend::Painter & pain, bool paint_caret)
3194 {
3195         if (height_ == 0 || width_ == 0)
3196                 return;
3197         LYXERR(Debug::PAINTING, (pain.isNull() ? "\t\t--- START NODRAW ---"
3198                                  : "\t\t*** START DRAWING ***"));
3199         Text & text = buffer_.text();
3200         TextMetrics const & tm = d->text_metrics_[&text];
3201         int const y = tm.first().second->position();
3202         PainterInfo pi(this, pain);
3203
3204         // Check whether the row where the cursor lives needs to be scrolled.
3205         // Update the drawing strategy if needed.
3206         checkCursorScrollOffset();
3207
3208         switch (d->update_strategy_) {
3209
3210         case NoScreenUpdate:
3211                 // no screen painting is actually needed. In nodraw stage
3212                 // however, the different coordinates of insets and paragraphs
3213                 // needs to be updated.
3214                 LYXERR(Debug::PAINTING, "Strategy: NoScreenUpdate");
3215                 if (pain.isNull()) {
3216                         pi.full_repaint = true;
3217                         tm.draw(pi, 0, y);
3218                 } else {
3219                         pi.full_repaint = false;
3220                         tm.draw(pi, 0, y);
3221                 }
3222                 break;
3223
3224         case SingleParUpdate:
3225                 pi.full_repaint = false;
3226                 LYXERR(Debug::PAINTING, "Strategy: SingleParUpdate");
3227                 // In general, only the current row of the outermost paragraph
3228                 // will be redrawn. Particular cases where selection spans
3229                 // multiple paragraph are correctly detected in TextMetrics.
3230                 tm.draw(pi, 0, y);
3231                 break;
3232
3233         case DecorationUpdate:
3234                 // FIXME: We should also distinguish DecorationUpdate to avoid text
3235                 // drawing if possible. This is not possible to do easily right now
3236                 // because of the single backing pixmap.
3237
3238         case FullScreenUpdate:
3239
3240                 LYXERR(Debug::PAINTING,
3241                        ((d->update_strategy_ == FullScreenUpdate)
3242                         ? "Strategy: FullScreenUpdate"
3243                         : "Strategy: DecorationUpdate"));
3244
3245                 // The whole screen, including insets, will be refreshed.
3246                 pi.full_repaint = true;
3247
3248                 // Clear background.
3249                 pain.fillRectangle(0, 0, width_, height_,
3250                         pi.backgroundColor(&buffer_.inset()));
3251
3252                 // Draw everything.
3253                 tm.draw(pi, 0, y);
3254
3255                 // and possibly grey out below
3256                 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3257                 int const y2 = lastpm.second->position() + lastpm.second->descent();
3258
3259                 if (y2 < height_) {
3260                         Color color = buffer().isInternal()
3261                                 ? Color_background : Color_bottomarea;
3262                         pain.fillRectangle(0, y2, width_, height_ - y2, color);
3263                 }
3264                 break;
3265         }
3266         LYXERR(Debug::PAINTING, (pain.isNull() ? "\t\t --- END NODRAW ---"
3267                                 : "\t\t *** END DRAWING ***"));
3268
3269         // The scrollbar needs an update.
3270         updateScrollbar();
3271
3272         // Normalize anchor for next time
3273         pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
3274         pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3275         for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
3276                 ParagraphMetrics const & pm = tm.parMetrics(pit);
3277                 if (pm.position() + pm.descent() > 0) {
3278                         if (d->anchor_pit_ != pit
3279                             || d->anchor_ypos_ != pm.position())
3280                                 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
3281                                        << "  anchor ypos = " << d->anchor_ypos_);
3282                         d->anchor_pit_ = pit;
3283                         d->anchor_ypos_ = pm.position();
3284                         break;
3285                 }
3286         }
3287         if (!pain.isNull()) {
3288                 // reset the update flags, everything has been done
3289                 d->update_flags_ = Update::None;
3290         }
3291
3292         // If a caret has to be painted, mark its text row as dirty to
3293         //make sure that it will be repainted on next redraw.
3294         /* FIXME: investigate whether this can be avoided when the cursor did not
3295          * move at all
3296          */
3297         if (paint_caret) {
3298                 Row const & caret_row = d->cursor_.textRow();
3299                 caret_row.changed(true);
3300         }
3301 }
3302
3303
3304 void BufferView::message(docstring const & msg)
3305 {
3306         if (d->gui_)
3307                 d->gui_->message(msg);
3308 }
3309
3310
3311 void BufferView::showDialog(string const & name)
3312 {
3313         if (d->gui_)
3314                 d->gui_->showDialog(name, string());
3315 }
3316
3317
3318 void BufferView::showDialog(string const & name,
3319         string const & data, Inset * inset)
3320 {
3321         if (d->gui_)
3322                 d->gui_->showDialog(name, data, inset);
3323 }
3324
3325
3326 void BufferView::updateDialog(string const & name, string const & data)
3327 {
3328         if (d->gui_)
3329                 d->gui_->updateDialog(name, data);
3330 }
3331
3332
3333 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
3334 {
3335         d->gui_ = gui;
3336 }
3337
3338
3339 // FIXME: Move this out of BufferView again
3340 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
3341 {
3342         if (!fname.isReadableFile()) {
3343                 docstring const error = from_ascii(strerror(errno));
3344                 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3345                 docstring const text =
3346                   bformat(_("Could not read the specified document\n"
3347                             "%1$s\ndue to the error: %2$s"), file, error);
3348                 Alert::error(_("Could not read file"), text);
3349                 return docstring();
3350         }
3351
3352         if (!fname.isReadableFile()) {
3353                 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3354                 docstring const text =
3355                   bformat(_("%1$s\n is not readable."), file);
3356                 Alert::error(_("Could not open file"), text);
3357                 return docstring();
3358         }
3359
3360         // FIXME UNICODE: We don't know the encoding of the file
3361         docstring file_content = fname.fileContents("UTF-8");
3362         if (file_content.empty()) {
3363                 Alert::error(_("Reading not UTF-8 encoded file"),
3364                              _("The file is not UTF-8 encoded.\n"
3365                                "It will be read as local 8Bit-encoded.\n"
3366                                "If this does not give the correct result\n"
3367                                "then please change the encoding of the file\n"
3368                                "to UTF-8 with a program other than LyX.\n"));
3369                 file_content = fname.fileContents("local8bit");
3370         }
3371
3372         return normalize_c(file_content);
3373 }
3374
3375
3376 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
3377 {
3378         docstring const tmpstr = contentsOfPlaintextFile(f);
3379
3380         if (tmpstr.empty())
3381                 return;
3382
3383         Cursor & cur = cursor();
3384         cap::replaceSelection(cur);
3385         buffer_.undo().recordUndo(cur);
3386         if (asParagraph)
3387                 cur.innerText()->insertStringAsParagraphs(cur, tmpstr, cur.current_font);
3388         else
3389                 cur.innerText()->insertStringAsLines(cur, tmpstr, cur.current_font);
3390
3391         buffer_.changed(true);
3392 }
3393
3394
3395 docstring const & BufferView::inlineCompletion() const
3396 {
3397         return d->inlineCompletion_;
3398 }
3399
3400
3401 size_t const & BufferView::inlineCompletionUniqueChars() const
3402 {
3403         return d->inlineCompletionUniqueChars_;
3404 }
3405
3406
3407 DocIterator const & BufferView::inlineCompletionPos() const
3408 {
3409         return d->inlineCompletionPos_;
3410 }
3411
3412
3413 void BufferView::resetInlineCompletionPos()
3414 {
3415         d->inlineCompletionPos_ = DocIterator();
3416 }
3417
3418
3419 bool samePar(DocIterator const & a, DocIterator const & b)
3420 {
3421         if (a.empty() && b.empty())
3422                 return true;
3423         if (a.empty() || b.empty())
3424                 return false;
3425         if (a.depth() != b.depth())
3426                 return false;
3427         return &a.innerParagraph() == &b.innerParagraph();
3428 }
3429
3430
3431 void BufferView::setInlineCompletion(Cursor const & cur, DocIterator const & pos,
3432         docstring const & completion, size_t uniqueChars)
3433 {
3434         uniqueChars = min(completion.size(), uniqueChars);
3435         bool changed = d->inlineCompletion_ != completion
3436                 || d->inlineCompletionUniqueChars_ != uniqueChars;
3437         bool singlePar = true;
3438         d->inlineCompletion_ = completion;
3439         d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
3440
3441         //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
3442
3443         // at new position?
3444         DocIterator const & old = d->inlineCompletionPos_;
3445         if (old != pos) {
3446                 //lyxerr << "inlineCompletionPos changed" << std::endl;
3447                 // old or pos are in another paragraph?
3448                 if ((!samePar(cur, pos) && !pos.empty())
3449                     || (!samePar(cur, old) && !old.empty())) {
3450                         singlePar = false;
3451                         //lyxerr << "different paragraph" << std::endl;
3452                 }
3453                 d->inlineCompletionPos_ = pos;
3454         }
3455
3456         // set update flags
3457         if (changed) {
3458                 if (singlePar && !(cur.result().screenUpdate() & Update::Force))
3459                         cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
3460                 else
3461                         cur.screenUpdateFlags(cur.result().screenUpdate() | Update::Force);
3462         }
3463 }
3464
3465
3466 bool BufferView::clickableInset() const
3467 {
3468         return d->clickable_inset_;
3469 }
3470
3471 } // namespace lyx