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         LYXERR(Debug::SCROLLING, "recentering!");
 942
 943         CursorSlice const & bot = dit.bottom();
 944         TextMetrics & tm = d->text_metrics_[bot.text()];
 945
 946         pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
 947         int bot_pit = bot.pit();
 948         if (bot_pit > max_pit) {
 949                 // FIXME: Why does this happen?
 950                 LYXERR0("bottom pit is greater that max pit: "
 951                         << bot_pit << " > " << max_pit);
 952                 bot_pit = max_pit;
 953         }
 954
 955         if (bot_pit == tm.first().first - 1)
 956                 tm.newParMetricsUp();
 957         else if (bot_pit == tm.last().first + 1)
 958                 tm.newParMetricsDown();
 959
 960         if (tm.contains(bot_pit)) {
 961                 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
 962                 LBUFERR(!pm.rows().empty());
 963                 // FIXME: smooth scrolling doesn't work in mathed.
 964                 CursorSlice const & cs = dit.innerTextSlice();
 965                 int offset = coordOffset(dit).y_;
 966                 int ypos = pm.position() + offset;
 967                 Dimension const & row_dim =
 968                         pm.getRow(cs.pos(), dit.boundary()).dim();
 969                 int scrolled = 0;
 970                 if (recenter)
 971                         scrolled = scroll(ypos - height_/2);
 972
 973                 // We try to visualize the whole row, if the row height is larger than
 974                 // the screen height, we scroll to a heuristic value of height_ / 4.
 975                 // FIXME: This heuristic value should be replaced by a recursive search
 976                 // for a row in the inset that can be visualized completely.
 977                 else if (row_dim.height() > height_) {
 978                         if (ypos < defaultRowHeight())
 979                                 scrolled = scroll(ypos - height_ / 4);
 980                         else if (ypos > height_ - defaultRowHeight())
 981                                 scrolled = scroll(ypos - 3 * height_ / 4);
 982                 }
 983
 984                 // If the top part of the row falls of the screen, we scroll
 985                 // up to align the top of the row with the top of the screen.
 986                 else if (ypos - row_dim.ascent() < 0 && ypos < height_) {
 987                         int ynew = row_dim.ascent();
 988                         scrolled = scrollUp(ynew - ypos);
 989                 }
 990
 991                 // If the bottom of the row falls of the screen, we scroll down.
 992                 else if (ypos + row_dim.descent() > height_ && ypos > 0) {
 993                         int ynew = height_ - row_dim.descent();
 994                         scrolled = scrollDown(ypos - ynew);
 995                 }
 996
 997                 // else, nothing to do, the cursor is already visible so we just return.
 998                 return scrolled != 0;
 999         }
1000
1001         // fix inline completion position
1002         if (d->inlineCompletionPos_.fixIfBroken())
1003                 d->inlineCompletionPos_ = DocIterator();
1004
1005         tm.redoParagraph(bot_pit);
1006         ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
1007         int offset = coordOffset(dit).y_;
1008
1009         d->anchor_pit_ = bot_pit;
1010         CursorSlice const & cs = dit.innerTextSlice();
1011         Dimension const & row_dim =
1012                 pm.getRow(cs.pos(), dit.boundary()).dim();
1013
1014         if (recenter)
1015                 d->anchor_ypos_ = height_/2;
1016         else if (d->anchor_pit_ == 0)
1017                 d->anchor_ypos_ = offset + pm.ascent();
1018         else if (d->anchor_pit_ == max_pit)
1019                 d->anchor_ypos_ = height_ - offset - row_dim.descent();
1020         else if (offset > height_)
1021                 d->anchor_ypos_ = height_ - offset - defaultRowHeight();
1022         else
1023                 d->anchor_ypos_ = defaultRowHeight() * 2;
1024
1025         return true;
1026 }
1027
1028
1029 void BufferView::makeDocumentClass()
1030 {
1031         DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1032         buffer_.params().makeDocumentClass();
1033         updateDocumentClass(olddc);
1034 }
1035
1036
1037 void BufferView::updateDocumentClass(DocumentClassConstPtr olddc)
1038 {
1039         message(_("Converting document to new document class..."));
1040
1041         StableDocIterator backcur(d->cursor_);
1042         ErrorList & el = buffer_.errorList("Class Switch");
1043         cap::switchBetweenClasses(
1044                         olddc, buffer_.params().documentClassPtr(),
1045                         static_cast<InsetText &>(buffer_.inset()), el);
1046
1047         setCursor(backcur.asDocIterator(&buffer_));
1048
1049         buffer_.errors("Class Switch");
1050 }
1051
1052
1053 /** Return the change status at cursor position, taking into account the
1054  * status at each level of the document iterator (a table in a deleted
1055  * footnote is deleted).
1056  * When \param outer is true, the top slice is not looked at.
1057  */
1058 static Change::Type lookupChangeType(DocIterator const & dit, bool outer = false)
1059 {
1060         size_t const depth = dit.depth() - (outer ? 1 : 0);
1061
1062         for (size_t i = 0 ; i < depth ; ++i) {
1063                 CursorSlice const & slice = dit[i];
1064                 if (!slice.inset().inMathed()
1065                     && slice.pos() < slice.paragraph().size()) {
1066                         Change::Type const ch = slice.paragraph().lookupChange(slice.pos()).type;
1067                         if (ch != Change::UNCHANGED)
1068                                 return ch;
1069                 }
1070         }
1071         return Change::UNCHANGED;
1072 }
1073
1074
1075 bool BufferView::getStatus(FuncRequest const & cmd, FuncStatus & flag)
1076 {
1077         FuncCode const act = cmd.action();
1078
1079         // Can we use a readonly buffer?
1080         if (buffer_.isReadonly()
1081             && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1082             && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1083                 if (buffer_.hasReadonlyFlag())
1084                         flag.message(from_utf8(N_("Document is read-only")));
1085                 else
1086                         flag.message(from_utf8(N_("Document has been modified externally")));
1087                 flag.setEnabled(false);
1088                 return true;
1089         }
1090
1091         // Are we in a DELETED change-tracking region?
1092         if (lookupChangeType(d->cursor_, true) == Change::DELETED
1093             && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1094             && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1095                 flag.message(from_utf8(N_("This portion of the document is deleted.")));
1096                 flag.setEnabled(false);
1097                 return true;
1098         }
1099
1100         Cursor & cur = d->cursor_;
1101
1102         if (cur.getStatus(cmd, flag))
1103                 return true;
1104
1105         switch (act) {
1106
1107         // FIXME: This is a bit problematic because we don't check if this is
1108         // a document BufferView or not for these LFUNs. We probably have to
1109         // dispatch both to currentBufferView() and, if that fails,
1110         // to documentBufferView(); same as we do now for current Buffer and
1111         // document Buffer. Ideally those LFUN should go to Buffer as they
1112         // operate on the full Buffer and the cursor is only needed either for
1113         // an Undo record or to restore a cursor position. But we don't know
1114         // how to do that inside Buffer of course.
1115         case LFUN_BUFFER_PARAMS_APPLY:
1116         case LFUN_LAYOUT_MODULES_CLEAR:
1117         case LFUN_LAYOUT_MODULE_ADD:
1118         case LFUN_LAYOUT_RELOAD:
1119         case LFUN_TEXTCLASS_APPLY:
1120         case LFUN_TEXTCLASS_LOAD:
1121                 flag.setEnabled(!buffer_.isReadonly());
1122                 break;
1123
1124         case LFUN_UNDO:
1125                 // We do not use the LyXAction flag for readonly because Undo sets the
1126                 // buffer clean/dirty status by itself.
1127                 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasUndoStack());
1128                 break;
1129         case LFUN_REDO:
1130                 // We do not use the LyXAction flag for readonly because Redo sets the
1131                 // buffer clean/dirty status by itself.
1132                 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasRedoStack());
1133                 break;
1134         case LFUN_FILE_INSERT_PLAINTEXT_PARA:
1135         case LFUN_FILE_INSERT_PLAINTEXT: {
1136                 docstring const fname = cmd.argument();
1137                 if (!FileName::isAbsolute(to_utf8(fname))) {
1138                         flag.message(_("Absolute filename expected."));
1139                         return false;
1140                 }
1141                 flag.setEnabled(cur.inTexted());
1142                 break;
1143         }
1144         case LFUN_FILE_INSERT:
1145         case LFUN_BOOKMARK_SAVE:
1146                 // FIXME: Actually, these LFUNS should be moved to Text
1147                 flag.setEnabled(cur.inTexted());
1148                 break;
1149
1150         case LFUN_FONT_STATE:
1151         case LFUN_LABEL_INSERT:
1152         case LFUN_INFO_INSERT:
1153         case LFUN_PARAGRAPH_GOTO:
1154         case LFUN_NOTE_NEXT:
1155         case LFUN_REFERENCE_NEXT:
1156         case LFUN_WORD_FIND:
1157         case LFUN_WORD_FIND_FORWARD:
1158         case LFUN_WORD_FIND_BACKWARD:
1159         case LFUN_WORD_REPLACE:
1160         case LFUN_MARK_OFF:
1161         case LFUN_MARK_ON:
1162         case LFUN_MARK_TOGGLE:
1163         case LFUN_SCREEN_RECENTER:
1164         case LFUN_SCREEN_SHOW_CURSOR:
1165         case LFUN_BIBTEX_DATABASE_ADD:
1166         case LFUN_BIBTEX_DATABASE_DEL:
1167         case LFUN_STATISTICS:
1168         case LFUN_KEYMAP_OFF:
1169         case LFUN_KEYMAP_PRIMARY:
1170         case LFUN_KEYMAP_SECONDARY:
1171         case LFUN_KEYMAP_TOGGLE:
1172         case LFUN_INSET_SELECT_ALL:
1173                 flag.setEnabled(true);
1174                 break;
1175
1176         case LFUN_GRAPHICS_UNIFY:
1177                 flag.setEnabled(cur.countInsetsInSelection(GRAPHICS_CODE)>1);
1178                 break;
1179
1180         case LFUN_WORD_FINDADV: {
1181                 FindAndReplaceOptions opt;
1182                 istringstream iss(to_utf8(cmd.argument()));
1183                 iss >> opt;
1184                 flag.setEnabled(opt.repl_buf_name.empty()
1185                                 || !buffer_.isReadonly());
1186                 break;
1187         }
1188
1189         case LFUN_LABEL_GOTO:
1190                 flag.setEnabled(!cmd.argument().empty()
1191                     || getInsetByCode<InsetRef>(cur, REF_CODE));
1192                 break;
1193
1194         case LFUN_CHANGES_MERGE:
1195         case LFUN_CHANGE_NEXT:
1196         case LFUN_CHANGE_PREVIOUS:
1197         case LFUN_ALL_CHANGES_ACCEPT:
1198         case LFUN_ALL_CHANGES_REJECT:
1199                 flag.setEnabled(buffer_.areChangesPresent());
1200                 break;
1201
1202         case LFUN_SCREEN_UP:
1203         case LFUN_SCREEN_DOWN:
1204         case LFUN_SCROLL:
1205         case LFUN_SCREEN_UP_SELECT:
1206         case LFUN_SCREEN_DOWN_SELECT:
1207         case LFUN_INSET_FORALL:
1208                 flag.setEnabled(true);
1209                 break;
1210
1211         case LFUN_LAYOUT_TABULAR:
1212                 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
1213                 break;
1214
1215         case LFUN_LAYOUT:
1216                 flag.setEnabled(!cur.inset().forcePlainLayout(cur.idx()));
1217                 break;
1218
1219         case LFUN_LAYOUT_PARAGRAPH:
1220                 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
1221                 break;
1222
1223         case LFUN_BRANCH_ADD_INSERT:
1224                 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1225                 break;
1226
1227         case LFUN_DIALOG_SHOW_NEW_INSET:
1228                 // FIXME: this is wrong, but I do not understand the
1229                 // intent (JMarc)
1230                 if (cur.inset().lyxCode() == CAPTION_CODE)
1231                         return cur.inset().getStatus(cur, cmd, flag);
1232                 // FIXME we should consider passthru paragraphs too.
1233                 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1234                 break;
1235
1236         case LFUN_CITATION_INSERT: {
1237                 FuncRequest fr(LFUN_INSET_INSERT, "citation");
1238                 // FIXME: This could turn in a recursive hell.
1239                 // Shouldn't we use Buffer::getStatus() instead?
1240                 flag.setEnabled(lyx::getStatus(fr).enabled());
1241                 break;
1242         }
1243         case LFUN_INSET_APPLY: {
1244                 string const name = cmd.getArg(0);
1245                 Inset * inset = editedInset(name);
1246                 if (inset) {
1247                         FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1248                         if (!inset->getStatus(cur, fr, flag)) {
1249                                 // Every inset is supposed to handle this
1250                                 LASSERT(false, break);
1251                         }
1252                 } else {
1253                         FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1254                         flag = lyx::getStatus(fr);
1255                 }
1256                 break;
1257         }
1258
1259         default:
1260                 return false;
1261         }
1262
1263         return true;
1264 }
1265
1266
1267 Inset * BufferView::editedInset(string const & name) const
1268 {
1269         map<string, Inset *>::const_iterator it = d->edited_insets_.find(name);
1270         return it == d->edited_insets_.end() ? nullptr : it->second;
1271 }
1272
1273
1274 void BufferView::editInset(string const & name, Inset * inset)
1275 {
1276         if (inset)
1277                 d->edited_insets_[name] = inset;
1278         else
1279                 d->edited_insets_.erase(name);
1280 }
1281
1282
1283 void BufferView::dispatch(FuncRequest const & cmd, DispatchResult & dr)
1284 {
1285         LYXERR(Debug::ACTION, "BufferView::dispatch: cmd: " << cmd);
1286
1287         string const argument = to_utf8(cmd.argument());
1288         Cursor & cur = d->cursor_;
1289         Cursor old = cur;
1290
1291         // Don't dispatch function that does not apply to internal buffers.
1292         if (buffer_.isInternal()
1293             && lyxaction.funcHasFlag(cmd.action(), LyXAction::NoInternal))
1294                 return;
1295
1296         // We'll set this back to false if need be.
1297         bool dispatched = true;
1298         buffer_.undo().beginUndoGroup();
1299
1300         FuncCode const act = cmd.action();
1301         switch (act) {
1302
1303         case LFUN_BUFFER_PARAMS_APPLY: {
1304                 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1305                 cur.recordUndoBufferParams();
1306                 istringstream ss(to_utf8(cmd.argument()));
1307                 Lexer lex;
1308                 lex.setStream(ss);
1309                 int const unknown_tokens = buffer_.readHeader(lex);
1310                 if (unknown_tokens != 0) {
1311                         LYXERR0("Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1312                                                 << unknown_tokens << " unknown token"
1313                                                 << (unknown_tokens == 1 ? "" : "s"));
1314                 }
1315                 updateDocumentClass(olddc);
1316
1317                 // We are most certainly here because of a change in the document
1318                 // It is then better to make sure that all dialogs are in sync with
1319                 // current document settings.
1320                 dr.screenUpdate(Update::Force | Update::FitCursor);
1321                 dr.forceBufferUpdate();
1322                 break;
1323         }
1324
1325         case LFUN_LAYOUT_MODULES_CLEAR: {
1326                 // FIXME: this modifies the document in cap::switchBetweenClasses
1327                 //  without calling recordUndo. Fix this before using
1328                 //  recordUndoBufferParams().
1329                 cur.recordUndoFullBuffer();
1330                 buffer_.params().clearLayoutModules();
1331                 makeDocumentClass();
1332                 dr.screenUpdate(Update::Force);
1333                 dr.forceBufferUpdate();
1334                 break;
1335         }
1336
1337         case LFUN_LAYOUT_MODULE_ADD: {
1338                 BufferParams const & params = buffer_.params();
1339                 if (!params.layoutModuleCanBeAdded(argument)) {
1340                         LYXERR0("Module `" << argument <<
1341                                 "' cannot be added due to failed requirements or "
1342                                 "conflicts with installed modules.");
1343                         break;
1344                 }
1345                 // FIXME: this modifies the document in cap::switchBetweenClasses
1346                 //  without calling recordUndo. Fix this before using
1347                 //  recordUndoBufferParams().
1348                 cur.recordUndoFullBuffer();
1349                 buffer_.params().addLayoutModule(argument);
1350                 makeDocumentClass();
1351                 dr.screenUpdate(Update::Force);
1352                 dr.forceBufferUpdate();
1353                 break;
1354         }
1355
1356         case LFUN_TEXTCLASS_APPLY: {
1357                 // since this shortcircuits, the second call is made only if
1358                 // the first fails
1359                 bool const success =
1360                         LayoutFileList::get().load(argument, buffer_.temppath()) ||
1361                         LayoutFileList::get().load(argument, buffer_.filePath());
1362                 if (!success) {
1363                         docstring s = bformat(_("The document class `%1$s' "
1364                                                  "could not be loaded."), from_utf8(argument));
1365                         frontend::Alert::error(_("Could not load class"), s);
1366                         break;
1367                 }
1368
1369                 LayoutFile const * old_layout = buffer_.params().baseClass();
1370                 LayoutFile const * new_layout = &(LayoutFileList::get()[argument]);
1371
1372                 if (old_layout == new_layout)
1373                         // nothing to do
1374                         break;
1375
1376                 // Save the old, possibly modular, layout for use in conversion.
1377                 // FIXME: this modifies the document in cap::switchBetweenClasses
1378                 //  without calling recordUndo. Fix this before using
1379                 //  recordUndoBufferParams().
1380                 cur.recordUndoFullBuffer();
1381                 buffer_.params().setBaseClass(argument, buffer_.layoutPos());
1382                 makeDocumentClass();
1383                 dr.screenUpdate(Update::Force);
1384                 dr.forceBufferUpdate();
1385                 break;
1386         }
1387
1388         case LFUN_TEXTCLASS_LOAD: {
1389                 // since this shortcircuits, the second call is made only if
1390                 // the first fails
1391                 bool const success =
1392                         LayoutFileList::get().load(argument, buffer_.temppath()) ||
1393                         LayoutFileList::get().load(argument, buffer_.filePath());
1394                 if (!success) {
1395                         docstring s = bformat(_("The document class `%1$s' "
1396                                                  "could not be loaded."), from_utf8(argument));
1397                         frontend::Alert::error(_("Could not load class"), s);
1398                 }
1399                 break;
1400         }
1401
1402         case LFUN_LAYOUT_RELOAD: {
1403                 LayoutFileIndex bc = buffer_.params().baseClassID();
1404                 LayoutFileList::get().reset(bc);
1405                 buffer_.params().setBaseClass(bc, buffer_.layoutPos());
1406                 makeDocumentClass();
1407                 dr.screenUpdate(Update::Force);
1408                 dr.forceBufferUpdate();
1409                 break;
1410         }
1411
1412         case LFUN_UNDO: {
1413                 dr.setMessage(_("Undo"));
1414                 cur.clearSelection();
1415                 // We need to find out if the bibliography information
1416                 // has changed. See bug #11055.
1417                 // So these should not be references...
1418                 string const engine = buffer().params().citeEngine();
1419                 CiteEngineType const enginetype = buffer().params().citeEngineType();
1420                 if (!cur.undoAction())
1421                         dr.setMessage(_("No further undo information"));
1422                 else {
1423                         dr.screenUpdate(Update::Force | Update::FitCursor);
1424                         dr.forceBufferUpdate();
1425                         if (buffer().params().citeEngine() != engine ||
1426                             buffer().params().citeEngineType() != enginetype)
1427                                 buffer().invalidateCiteLabels();
1428                 }
1429                 break;
1430         }
1431
1432         case LFUN_REDO: {
1433                 dr.setMessage(_("Redo"));
1434                 cur.clearSelection();
1435                 // We need to find out if the bibliography information
1436                 // has changed. See bug #11055.
1437                 // So these should not be references...
1438                 string const engine = buffer().params().citeEngine();
1439                 CiteEngineType const enginetype = buffer().params().citeEngineType();
1440                 if (!cur.redoAction())
1441                         dr.setMessage(_("No further redo information"));
1442                 else {
1443                         dr.screenUpdate(Update::Force | Update::FitCursor);
1444                         dr.forceBufferUpdate();
1445                         if (buffer().params().citeEngine() != engine ||
1446                             buffer().params().citeEngineType() != enginetype)
1447                                 buffer().invalidateCiteLabels();
1448                 }
1449                 break;
1450         }
1451
1452         case LFUN_FONT_STATE:
1453                 dr.setMessage(cur.currentState(false));
1454                 break;
1455
1456         case LFUN_BOOKMARK_SAVE:
1457                 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1458                 break;
1459
1460         case LFUN_LABEL_GOTO: {
1461                 docstring label = cmd.argument();
1462                 if (label.empty()) {
1463                         InsetRef * inset =
1464                                 getInsetByCode<InsetRef>(cur, REF_CODE);
1465                         if (inset) {
1466                                 label = inset->getParam("reference");
1467                                 // persistent=false: use temp_bookmark
1468                                 saveBookmark(0);
1469                         }
1470                 }
1471                 if (!label.empty()) {
1472                         gotoLabel(label);
1473                         // at the moment, this is redundant, since gotoLabel will
1474                         // eventually call LFUN_PARAGRAPH_GOTO, but it seems best
1475                         // to have it here.
1476                         dr.screenUpdate(Update::Force | Update::FitCursor);
1477                 }
1478                 break;
1479         }
1480
1481         case LFUN_PARAGRAPH_GOTO: {
1482                 int const id = convert<int>(cmd.getArg(0));
1483                 pos_type const pos = convert<int>(cmd.getArg(1));
1484                 if (id < 0)
1485                         break;
1486                 string const str_id_end = cmd.getArg(2);
1487                 string const str_pos_end = cmd.getArg(3);
1488                 int i = 0;
1489                 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1490                         b = theBufferList().next(b)) {
1491
1492                         Cursor curs(*this);
1493                         curs.setCursor(b->getParFromID(id));
1494                         if (curs.atEnd()) {
1495                                 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1496                                 ++i;
1497                                 continue;
1498                         }
1499                         LYXERR(Debug::INFO, "Paragraph " << curs.paragraph().id()
1500                                 << " found in buffer `"
1501                                 << b->absFileName() << "'.");
1502
1503                         if (b == &buffer_) {
1504                                 bool success;
1505                                 if (str_id_end.empty() || str_pos_end.empty()) {
1506                                         // Set the cursor
1507                                         curs.pos() = pos;
1508                                         mouseSetCursor(curs);
1509                                         success = true;
1510                                 } else {
1511                                         int const id_end = convert<int>(str_id_end);
1512                                         pos_type const pos_end = convert<int>(str_pos_end);
1513                                         success = setCursorFromEntries({id, pos},
1514                                                                        {id_end, pos_end});
1515                                 }
1516                                 if (success)
1517                                         dr.screenUpdate(Update::Force | Update::FitCursor);
1518                         } else {
1519                                 // Switch to other buffer view and resend cmd
1520                                 lyx::dispatch(FuncRequest(
1521                                         LFUN_BUFFER_SWITCH, b->absFileName()));
1522                                 lyx::dispatch(cmd);
1523                         }
1524                         break;
1525                 }
1526                 break;
1527         }
1528
1529         case LFUN_NOTE_NEXT:
1530                 gotoInset(this, NOTE_CODE, false);
1531                 break;
1532
1533         case LFUN_REFERENCE_NEXT: {
1534                 vector<InsetCode> tmp;
1535                 tmp.push_back(LABEL_CODE);
1536                 tmp.push_back(REF_CODE);
1537                 gotoInset(this, tmp, true);
1538                 break;
1539         }
1540
1541         case LFUN_CHANGE_NEXT:
1542                 findNextChange(this);
1543                 if (cur.inset().isTable())
1544                         // In tables, there might be whole changed rows or columns
1545                         cur.dispatch(cmd);
1546                 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1547                 dr.screenUpdate(Update::Force | Update::FitCursor);
1548                 break;
1549
1550         case LFUN_CHANGE_PREVIOUS:
1551                 findPreviousChange(this);
1552                 if (cur.inset().isTable())
1553                         // In tables, there might be whole changed rows or columns
1554                         cur.dispatch(cmd);
1555                 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1556                 dr.screenUpdate(Update::Force | Update::FitCursor);
1557                 break;
1558
1559         case LFUN_CHANGES_MERGE:
1560                 if (findNextChange(this) || findPreviousChange(this)) {
1561                         dr.screenUpdate(Update::Force | Update::FitCursor);
1562                         dr.forceBufferUpdate();
1563                         showDialog("changes");
1564                 }
1565                 break;
1566
1567         case LFUN_ALL_CHANGES_ACCEPT: {
1568                 // select complete document
1569                 cur.reset();
1570                 cur.selHandle(true);
1571                 buffer_.text().cursorBottom(cur);
1572                 // accept everything in a single step to support atomic undo
1573                 // temporarily disable track changes in order to end with really
1574                 // no new (e.g., DPSM-caused) changes (see #7487)
1575                 bool const track = buffer_.params().track_changes;
1576                 buffer_.params().track_changes = false;
1577                 buffer_.text().acceptOrRejectChanges(cur, Text::ACCEPT);
1578                 buffer_.params().track_changes = track;
1579                 cur.resetAnchor();
1580                 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1581                 dr.screenUpdate(Update::Force | Update::FitCursor);
1582                 dr.forceBufferUpdate();
1583                 break;
1584         }
1585
1586         case LFUN_ALL_CHANGES_REJECT: {
1587                 // select complete document
1588                 cur.reset();
1589                 cur.selHandle(true);
1590                 buffer_.text().cursorBottom(cur);
1591                 // reject everything in a single step to support atomic undo
1592                 // temporarily disable track changes in order to end with really
1593                 // no new (e.g., DPSM-caused) changes (see #7487)
1594                 bool const track = buffer_.params().track_changes;
1595                 buffer_.params().track_changes = false;
1596                 buffer_.text().acceptOrRejectChanges(cur, Text::REJECT);
1597                 buffer_.params().track_changes = track;
1598                 cur.resetAnchor();
1599                 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1600                 dr.screenUpdate(Update::Force | Update::FitCursor);
1601                 dr.forceBufferUpdate();
1602                 break;
1603         }
1604
1605         case LFUN_WORD_FIND_FORWARD:
1606         case LFUN_WORD_FIND_BACKWARD: {
1607                 // FIXME THREAD
1608                 // Would it maybe be better if this variable were view specific anyway?
1609                 static docstring last_search;
1610                 docstring searched_string;
1611
1612                 if (!cmd.argument().empty()) {
1613                         last_search = cmd.argument();
1614                         searched_string = cmd.argument();
1615                 } else {
1616                         searched_string = last_search;
1617                 }
1618
1619                 if (searched_string.empty())
1620                         break;
1621
1622                 bool const fw = act == LFUN_WORD_FIND_FORWARD;
1623                 docstring const data =
1624                         find2string(searched_string, true, false, fw);
1625                 bool found = lyxfind(this, FuncRequest(LFUN_WORD_FIND, data));
1626                 if (found)
1627                         dr.screenUpdate(Update::Force | Update::FitCursor);
1628                 break;
1629         }
1630
1631         case LFUN_WORD_FIND: {
1632                 FuncRequest req = cmd;
1633                 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1634                         req = d->search_request_cache_;
1635                 if (req.argument().empty()) {
1636                         lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, "findreplace"));
1637                         break;
1638                 }
1639                 if (lyxfind(this, req))
1640                         dr.screenUpdate(Update::Force | Update::FitCursor);
1641
1642                 d->search_request_cache_ = req;
1643                 break;
1644         }
1645
1646         case LFUN_WORD_REPLACE: {
1647                 bool has_deleted = false;
1648                 if (cur.selection()) {
1649                         DocIterator beg = cur.selectionBegin();
1650                         DocIterator end = cur.selectionEnd();
1651                         if (beg.pit() == end.pit()) {
1652                                 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1653                                         if (!cur.inMathed() && cur.paragraph().isDeleted(p)) {
1654                                                 has_deleted = true;
1655                                                 break;
1656                                         }
1657                                 }
1658                         }
1659                 }
1660                 if (lyxreplace(this, cmd, has_deleted)) {
1661                         dr.forceBufferUpdate();
1662                         dr.screenUpdate(Update::Force | Update::FitCursor);
1663                 }
1664                 break;
1665         }
1666
1667         case LFUN_WORD_FINDADV: {
1668                 FindAndReplaceOptions opt;
1669                 istringstream iss(to_utf8(cmd.argument()));
1670                 iss >> opt;
1671                 if (findAdv(this, opt)) {
1672                         dr.screenUpdate(Update::Force | Update::FitCursor);
1673                         cur.dispatched();
1674                         dispatched = true;
1675                 } else {
1676                         cur.undispatched();
1677                         dispatched = false;
1678                 }
1679                 break;
1680         }
1681
1682         case LFUN_MARK_OFF:
1683                 cur.clearSelection();
1684                 dr.setMessage(from_utf8(N_("Mark off")));
1685                 break;
1686
1687         case LFUN_MARK_ON:
1688                 cur.clearSelection();
1689                 cur.setMark(true);
1690                 dr.setMessage(from_utf8(N_("Mark on")));
1691                 break;
1692
1693         case LFUN_MARK_TOGGLE:
1694                 cur.selection(false);
1695                 if (cur.mark()) {
1696                         cur.setMark(false);
1697                         dr.setMessage(from_utf8(N_("Mark removed")));
1698                 } else {
1699                         cur.setMark(true);
1700                         dr.setMessage(from_utf8(N_("Mark set")));
1701                 }
1702                 cur.resetAnchor();
1703                 break;
1704
1705         case LFUN_SCREEN_SHOW_CURSOR:
1706                 showCursor();
1707                 break;
1708
1709         case LFUN_SCREEN_RECENTER:
1710                 recenter();
1711                 break;
1712
1713         case LFUN_BIBTEX_DATABASE_ADD: {
1714                 Cursor tmpcur = cur;
1715                 findInset(tmpcur, BIBTEX_CODE, false);
1716                 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1717                                                 BIBTEX_CODE);
1718                 if (inset) {
1719                         if (inset->addDatabase(cmd.argument()))
1720                                 dr.forceBufferUpdate();
1721                 }
1722                 break;
1723         }
1724
1725         case LFUN_BIBTEX_DATABASE_DEL: {
1726                 Cursor tmpcur = cur;
1727                 findInset(tmpcur, BIBTEX_CODE, false);
1728                 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1729                                                 BIBTEX_CODE);
1730                 if (inset) {
1731                         if (inset->delDatabase(cmd.argument()))
1732                                 dr.forceBufferUpdate();
1733                 }
1734                 break;
1735         }
1736
1737         case LFUN_GRAPHICS_UNIFY: {
1738
1739                 cur.recordUndoFullBuffer();
1740
1741                 DocIterator from, to;
1742                 from = cur.selectionBegin();
1743                 to = cur.selectionEnd();
1744
1745                 string const newId = cmd.getArg(0);
1746                 bool fetchId = newId.empty(); //if we wait for groupId from first graphics inset
1747
1748                 InsetGraphicsParams grp_par;
1749                 if (!fetchId)
1750                         InsetGraphics::string2params(graphics::getGroupParams(buffer_, newId), buffer_, grp_par);
1751
1752                 if (!from.nextInset())  //move to closest inset
1753                         from.forwardInset();
1754
1755                 while (!from.empty() && from < to) {
1756                         Inset * inset = from.nextInset();
1757                         if (!inset)
1758                                 break;
1759                         InsetGraphics * ig = inset->asInsetGraphics();
1760                         if (ig) {
1761                                 InsetGraphicsParams inspar = ig->getParams();
1762                                 if (fetchId) {
1763                                         grp_par = inspar;
1764                                         fetchId = false;
1765                                 } else {
1766                                         grp_par.filename = inspar.filename;
1767                                         ig->setParams(grp_par);
1768                                 }
1769                         }
1770                         from.forwardInset();
1771                 }
1772                 dr.screenUpdate(Update::Force); //needed if triggered from context menu
1773                 break;
1774         }
1775
1776         case LFUN_STATISTICS: {
1777                 DocIterator from, to;
1778                 if (cur.selection()) {
1779                         from = cur.selectionBegin();
1780                         to = cur.selectionEnd();
1781                 } else {
1782                         from = doc_iterator_begin(&buffer_);
1783                         to = doc_iterator_end(&buffer_);
1784                 }
1785                 buffer_.updateStatistics(from, to);
1786                 int const words = buffer_.wordCount();
1787                 int const chars = buffer_.charCount(false);
1788                 int const chars_blanks = buffer_.charCount(true);
1789                 docstring message;
1790                 if (cur.selection())
1791                         message = _("Statistics for the selection:");
1792                 else
1793                         message = _("Statistics for the document:");
1794                 message += "\n\n";
1795                 if (words != 1)
1796                         message += bformat(_("%1$d words"), words);
1797                 else
1798                         message += _("One word");
1799                 message += "\n";
1800                 if (chars_blanks != 1)
1801                         message += bformat(_("%1$d characters (including blanks)"),
1802                                           chars_blanks);
1803                 else
1804                         message += _("One character (including blanks)");
1805                 message += "\n";
1806                 if (chars != 1)
1807                         message += bformat(_("%1$d characters (excluding blanks)"),
1808                                           chars);
1809                 else
1810                         message += _("One character (excluding blanks)");
1811
1812                 Alert::information(_("Statistics"), message);
1813         }
1814                 break;
1815
1816         case LFUN_SCREEN_UP:
1817         case LFUN_SCREEN_DOWN: {
1818                 Point p = getPos(cur);
1819                 // This code has been commented out to enable to scroll down a
1820                 // document, even if there are large insets in it (see bug #5465).
1821                 /*if (p.y_ < 0 || p.y_ > height_) {
1822                         // The cursor is off-screen so recenter before proceeding.
1823                         showCursor();
1824                         p = getPos(cur);
1825                 }*/
1826                 int const scrolled = scroll(act == LFUN_SCREEN_UP
1827                         ? -height_ : height_);
1828                 if (act == LFUN_SCREEN_UP && scrolled > -height_)
1829                         p = Point(0, 0);
1830                 if (act == LFUN_SCREEN_DOWN && scrolled < height_)
1831                         p = Point(width_, height_);
1832                 bool const in_texted = cur.inTexted();
1833                 cur.setCursor(doc_iterator_begin(cur.buffer()));
1834                 cur.selHandle(false);
1835                 // Force an immediate computation of metrics because we need it below
1836                 processUpdateFlags(Update::Force);
1837
1838                 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_,
1839                         true, act == LFUN_SCREEN_UP);
1840                 //FIXME: what to do with cur.x_target()?
1841                 bool update = in_texted && cur.bv().checkDepm(cur, old);
1842                 cur.finishUndo();
1843
1844                 if (update || cur.mark())
1845                         dr.screenUpdate(Update::Force | Update::FitCursor);
1846                 if (update)
1847                         dr.forceBufferUpdate();
1848                 break;
1849         }
1850
1851         case LFUN_SCROLL: {
1852                 string const scroll_type = cmd.getArg(0);
1853                 int scroll_step = 0;
1854                 if (scroll_type == "line")
1855                         scroll_step = d->scrollbarParameters_.single_step;
1856                 else if (scroll_type == "page")
1857                         scroll_step = d->scrollbarParameters_.page_step;
1858                 else
1859                         return;
1860                 string const scroll_quantity = cmd.getArg(1);
1861                 if (scroll_quantity == "up")
1862                         scrollUp(scroll_step);
1863                 else if (scroll_quantity == "down")
1864                         scrollDown(scroll_step);
1865                 else {
1866                         int const scroll_value = convert<int>(scroll_quantity);
1867                         if (scroll_value)
1868                                 scroll(scroll_step * scroll_value);
1869                 }
1870                 dr.screenUpdate(Update::ForceDraw);
1871                 dr.forceBufferUpdate();
1872                 break;
1873         }
1874
1875         case LFUN_SCREEN_UP_SELECT: {
1876                 // FIXME: why is the algorithm different from LFUN_SCREEN_UP?
1877                 cur.selHandle(true);
1878                 if (isTopScreen()) {
1879                         lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1880                         cur.finishUndo();
1881                         break;
1882                 }
1883                 int y = getPos(cur).y_;
1884                 int const ymin = y - height_ + defaultRowHeight();
1885                 while (y > ymin && cur.up())
1886                         y = getPos(cur).y_;
1887
1888                 cur.finishUndo();
1889                 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1890                 break;
1891         }
1892
1893         case LFUN_SCREEN_DOWN_SELECT: {
1894                 // FIXME: why is the algorithm different from LFUN_SCREEN_DOWN?
1895                 cur.selHandle(true);
1896                 if (isBottomScreen()) {
1897                         lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1898                         cur.finishUndo();
1899                         break;
1900                 }
1901                 int y = getPos(cur).y_;
1902                 int const ymax = y + height_ - defaultRowHeight();
1903                 while (y < ymax && cur.down())
1904                         y = getPos(cur).y_;
1905
1906                 cur.finishUndo();
1907                 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1908                 break;
1909         }
1910
1911
1912         case LFUN_INSET_SELECT_ALL: {
1913                 // true if all cells are selected
1914                 bool const all_selected = cur.depth() > 1
1915                     && cur.selBegin().at_begin()
1916                     && cur.selEnd().at_end();
1917                 // true if some cells are selected
1918                 bool const cells_selected = cur.depth() > 1
1919                     && cur.selBegin().at_cell_begin()
1920                         && cur.selEnd().at_cell_end();
1921                 if (all_selected || (cells_selected && !cur.inset().isTable())) {
1922                         // All the contents of the inset if selected, or only at
1923                         // least one cell but inset is not a table.
1924                         // Select the inset from outside.
1925                         cur.pop();
1926                         cur.resetAnchor();
1927                         cur.selection(true);
1928                         cur.posForward();
1929                 } else if (cells_selected) {
1930                         // At least one complete cell is selected and inset is a table.
1931                         // Select all cells
1932                         cur.idx() = 0;
1933                         cur.pit() = 0;
1934                         cur.pos() = 0;
1935                         cur.resetAnchor();
1936                         cur.selection(true);
1937                         cur.idx() = cur.lastidx();
1938                         cur.pit() = cur.lastpit();
1939                         cur.pos() = cur.lastpos();
1940                 } else {
1941                         // select current cell
1942                         cur.pit() = 0;
1943                         cur.pos() = 0;
1944                         cur.resetAnchor();
1945                         cur.selection(true);
1946                         cur.pit() = cur.lastpit();
1947                         cur.pos() = cur.lastpos();
1948                 }
1949                 cur.setCurrentFont();
1950                 dr.screenUpdate(Update::Force);
1951                 break;
1952         }
1953
1954
1955         case LFUN_UNICODE_INSERT: {
1956                 if (cmd.argument().empty())
1957                         break;
1958
1959                 FuncCode code = cur.inset().currentMode() == Inset::MATH_MODE ?
1960                         LFUN_MATH_INSERT : LFUN_SELF_INSERT;
1961                 int i = 0;
1962                 while (true) {
1963                         docstring const arg = from_utf8(cmd.getArg(i));
1964                         if (arg.empty())
1965                                 break;
1966                         if (!isHex(arg)) {
1967                                 LYXERR0("Not a hexstring: " << arg);
1968                                 ++i;
1969                                 continue;
1970                         }
1971                         char_type c = hexToInt(arg);
1972                         if (c >= 32 && c < 0x10ffff) {
1973                                 LYXERR(Debug::KEY, "Inserting c: " << c);
1974                                 lyx::dispatch(FuncRequest(code, docstring(1, c)));
1975                         }
1976                         ++i;
1977                 }
1978                 break;
1979         }
1980
1981
1982         // This would be in Buffer class if only Cursor did not
1983         // require a bufferview
1984         case LFUN_INSET_FORALL: {
1985                 docstring const name = from_utf8(cmd.getArg(0));
1986                 string const commandstr = cmd.getLongArg(1);
1987                 FuncRequest const fr = lyxaction.lookupFunc(commandstr);
1988
1989                 // an arbitrary number to limit number of iterations
1990                 const int max_iter = 100000;
1991                 int iterations = 0;
1992                 Cursor & curs = d->cursor_;
1993                 Cursor const savecur = curs;
1994                 curs.reset();
1995                 if (!curs.nextInset())
1996                         curs.forwardInset();
1997                 curs.beginUndoGroup();
1998                 while(curs && iterations < max_iter) {
1999                         Inset * const ins = curs.nextInset();
2000                         if (!ins)
2001                                 break;
2002                         docstring insname = ins->layoutName();
2003                         while (!insname.empty()) {
2004                                 if (insname == name || name == from_utf8("*")) {
2005                                         curs.recordUndo();
2006                                         lyx::dispatch(fr, dr);
2007                                         ++iterations;
2008                                         break;
2009                                 }
2010                                 size_t const i = insname.rfind(':');
2011                                 if (i == string::npos)
2012                                         break;
2013                                 insname = insname.substr(0, i);
2014                         }
2015                         // if we did not delete the inset, skip it
2016                         if (!curs.nextInset() || curs.nextInset() == ins)
2017                                 curs.forwardInset();
2018                 }
2019                 curs = savecur;
2020                 curs.fixIfBroken();
2021                 /** This is a dummy undo record only to remember the cursor
2022                  * that has just been set; this will be used on a redo action
2023                  * (see ticket #10097)
2024
2025                  * FIXME: a better fix would be to have a way to set the
2026                  * cursor value directly, but I am not sure it is worth it.
2027                  */
2028                 curs.recordUndo();
2029                 curs.endUndoGroup();
2030                 dr.screenUpdate(Update::Force);
2031                 dr.forceBufferUpdate();
2032
2033                 if (iterations >= max_iter) {
2034                         dr.setError(true);
2035                         dr.setMessage(bformat(_("`inset-forall' interrupted because number of actions is larger than %1$d"), max_iter));
2036                 } else
2037                         dr.setMessage(bformat(_("Applied \"%1$s\" to %2$d insets"), from_utf8(commandstr), iterations));
2038                 break;
2039         }
2040
2041
2042         case LFUN_BRANCH_ADD_INSERT: {
2043                 docstring branch_name = from_utf8(cmd.getArg(0));
2044                 if (branch_name.empty())
2045                         if (!Alert::askForText(branch_name, _("Branch name")) ||
2046                                                 branch_name.empty())
2047                                 break;
2048
2049                 DispatchResult drtmp;
2050                 buffer_.dispatch(FuncRequest(LFUN_BRANCH_ADD, branch_name), drtmp);
2051                 if (drtmp.error()) {
2052                         Alert::warning(_("Branch already exists"), drtmp.message());
2053                         break;
2054                 }
2055                 docstring const sep = buffer_.params().branchlist().separator();
2056                 for (docstring const & branch : getVectorFromString(branch_name, sep))
2057                         lyx::dispatch(FuncRequest(LFUN_BRANCH_INSERT, branch));
2058                 break;
2059         }
2060
2061         case LFUN_KEYMAP_OFF:
2062                 getIntl().keyMapOn(false);
2063                 break;
2064
2065         case LFUN_KEYMAP_PRIMARY:
2066                 getIntl().keyMapPrim();
2067                 break;
2068
2069         case LFUN_KEYMAP_SECONDARY:
2070                 getIntl().keyMapSec();
2071                 break;
2072
2073         case LFUN_KEYMAP_TOGGLE:
2074                 getIntl().toggleKeyMap();
2075                 break;
2076
2077         case LFUN_DIALOG_SHOW_NEW_INSET: {
2078                 string const name = cmd.getArg(0);
2079                 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
2080                 if (decodeInsetParam(name, data, buffer_))
2081                         lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
2082                 else
2083                         lyxerr << "Inset type '" << name <<
2084                         "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" <<  endl;
2085                 break;
2086         }
2087
2088         case LFUN_CITATION_INSERT: {
2089                 if (argument.empty()) {
2090                         lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
2091                         break;
2092                 }
2093                 // we can have one optional argument, delimited by '|'
2094                 // citation-insert <key>|<text_before>
2095                 // this should be enhanced to also support text_after
2096                 // and citation style
2097                 string arg = argument;
2098                 string opt1;
2099                 if (contains(argument, "|")) {
2100                         arg = token(argument, '|', 0);
2101                         opt1 = token(argument, '|', 1);
2102                 }
2103
2104                 // if our cursor is directly in front of or behind a citation inset,
2105                 // we will instead add the new key to it.
2106                 Inset * inset = cur.nextInset();
2107                 if (!inset || inset->lyxCode() != CITE_CODE)
2108                         inset = cur.prevInset();
2109                 if (inset && inset->lyxCode() == CITE_CODE) {
2110                         InsetCitation * icite = static_cast<InsetCitation *>(inset);
2111                         if (icite->addKey(arg)) {
2112                                 dr.forceBufferUpdate();
2113                                 dr.screenUpdate(Update::FitCursor | Update::SinglePar);
2114                                 if (!opt1.empty())
2115                                         LYXERR0("Discarding optional argument to citation-insert.");
2116                         }
2117                         dispatched = true;
2118                         break;
2119                 }
2120                 InsetCommandParams icp(CITE_CODE);
2121                 icp["key"] = from_utf8(arg);
2122                 if (!opt1.empty())
2123                         icp["before"] = from_utf8(opt1);
2124                 icp["literal"] =
2125                         from_ascii(InsetCitation::last_literal ? "true" : "false");
2126                 string icstr = InsetCommand::params2string(icp);
2127                 FuncRequest fr(LFUN_INSET_INSERT, icstr);
2128                 lyx::dispatch(fr);
2129                 break;
2130         }
2131
2132         case LFUN_INSET_APPLY: {
2133                 string const name = cmd.getArg(0);
2134                 Inset * inset = editedInset(name);
2135                 if (!inset) {
2136                         FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
2137                         lyx::dispatch(fr);
2138                         break;
2139                 }
2140                 // put cursor in front of inset.
2141                 if (!setCursorFromInset(inset)) {
2142                         LASSERT(false, break);
2143                 }
2144                 cur.recordUndo();
2145                 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
2146                 inset->dispatch(cur, fr);
2147                 dr.screenUpdate(cur.result().screenUpdate());
2148                 if (cur.result().needBufferUpdate())
2149                         dr.forceBufferUpdate();
2150                 break;
2151         }
2152
2153         // FIXME:
2154         // The change of language of buffer belongs to the Buffer class.
2155         // We have to do it here because we need a cursor for Undo.
2156         // When Undo::recordUndoBufferParams() is implemented someday
2157         // LFUN_BUFFER_LANGUAGE should be handled by the Buffer class.
2158         case LFUN_BUFFER_LANGUAGE: {
2159                 Language const * oldL = buffer_.params().language;
2160                 Language const * newL = languages.getLanguage(argument);
2161                 if (!newL || oldL == newL)
2162                         break;
2163                 if (oldL->rightToLeft() == newL->rightToLeft()) {
2164                         cur.recordUndoFullBuffer();
2165                         buffer_.changeLanguage(oldL, newL);
2166                         cur.setCurrentFont();
2167                         dr.forceBufferUpdate();
2168                 }
2169                 break;
2170         }
2171
2172         case LFUN_FILE_INSERT_PLAINTEXT_PARA:
2173         case LFUN_FILE_INSERT_PLAINTEXT: {
2174                 bool const as_paragraph = (act == LFUN_FILE_INSERT_PLAINTEXT_PARA);
2175                 string const fname = to_utf8(cmd.argument());
2176                 if (!FileName::isAbsolute(fname))
2177                         dr.setMessage(_("Absolute filename expected."));
2178                 else
2179                         insertPlaintextFile(FileName(fname), as_paragraph);
2180                 break;
2181         }
2182
2183         default:
2184                 // OK, so try the Buffer itself...
2185                 buffer_.dispatch(cmd, dr);
2186                 dispatched = dr.dispatched();
2187                 break;
2188         }
2189
2190         buffer_.undo().endUndoGroup();
2191         dr.dispatched(dispatched);
2192
2193         // NOTE: The code below is copied from Cursor::dispatch. If you
2194         // need to modify this, please update the other one too.
2195
2196         // notify insets we just entered/left
2197         if (cursor() != old) {
2198                 old.beginUndoGroup();
2199                 old.fixIfBroken();
2200                 bool badcursor = notifyCursorLeavesOrEnters(old, cursor());
2201                 if (badcursor) {
2202                         cursor().fixIfBroken();
2203                         resetInlineCompletionPos();
2204                 }
2205                 old.endUndoGroup();
2206         }
2207 }
2208
2209
2210 docstring BufferView::requestSelection()
2211 {
2212         Cursor & cur = d->cursor_;
2213
2214         LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
2215         if (!cur.selection()) {
2216                 d->xsel_cache_.set = false;
2217                 return docstring();
2218         }
2219
2220         LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
2221         if (!d->xsel_cache_.set ||
2222             cur.top() != d->xsel_cache_.cursor ||
2223             cur.realAnchor().top() != d->xsel_cache_.anchor)
2224         {
2225                 d->xsel_cache_.cursor = cur.top();
2226                 d->xsel_cache_.anchor = cur.realAnchor().top();
2227                 d->xsel_cache_.set = cur.selection();
2228                 return cur.selectionAsString(false);
2229         }
2230         return docstring();
2231 }
2232
2233
2234 void BufferView::clearSelection()
2235 {
2236         d->cursor_.clearSelection();
2237         // Clear the selection buffer. Otherwise a subsequent
2238         // middle-mouse-button paste would use the selection buffer,
2239         // not the more current external selection.
2240         cap::clearSelection();
2241         d->xsel_cache_.set = false;
2242         // The buffer did not really change, but this causes the
2243         // redraw we need because we cleared the selection above.
2244         buffer_.changed(false);
2245 }
2246
2247
2248 void BufferView::resize(int width, int height)
2249 {
2250         // Update from work area
2251         width_ = width;
2252         height_ = height;
2253
2254         // Clear the paragraph height cache.
2255         d->par_height_.clear();
2256         // Redo the metrics.
2257         updateMetrics();
2258 }
2259
2260
2261 Inset const * BufferView::getCoveringInset(Text const & text,
2262                 int x, int y) const
2263 {
2264         TextMetrics & tm = d->text_metrics_[&text];
2265         Inset * inset = tm.checkInsetHit(x, y);
2266         if (!inset)
2267                 return nullptr;
2268
2269         if (!inset->descendable(*this))
2270                 // No need to go further down if the inset is not
2271                 // descendable.
2272                 return inset;
2273
2274         size_t cell_number = inset->nargs();
2275         // Check all the inner cell.
2276         for (size_t i = 0; i != cell_number; ++i) {
2277                 Text const * inner_text = inset->getText(i);
2278                 if (inner_text) {
2279                         // Try deeper.
2280                         Inset const * inset_deeper =
2281                                 getCoveringInset(*inner_text, x, y);
2282                         if (inset_deeper)
2283                                 return inset_deeper;
2284                 }
2285         }
2286
2287         return inset;
2288 }
2289
2290
2291 void BufferView::updateHoveredInset() const
2292 {
2293         // Get inset under mouse, if there is one.
2294         int const x = d->mouse_position_cache_.x_;
2295         int const y = d->mouse_position_cache_.y_;
2296         Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
2297
2298         d->clickable_inset_ = covering_inset && covering_inset->clickable(*this, x, y);
2299
2300         if (covering_inset == d->last_inset_)
2301                 // Same inset, no need to do anything...
2302                 return;
2303
2304         bool need_redraw = false;
2305         if (d->last_inset_) {
2306                 // Remove the hint on the last hovered inset (if any).
2307                 need_redraw |= d->last_inset_->setMouseHover(this, false);
2308                 d->last_inset_ = nullptr;
2309         }
2310
2311         if (covering_inset && covering_inset->setMouseHover(this, true)) {
2312                 need_redraw = true;
2313                 // Only the insets that accept the hover state, do
2314                 // clear the last_inset_, so only set the last_inset_
2315                 // member if the hovered setting is accepted.
2316                 d->last_inset_ = covering_inset;
2317         }
2318
2319         if (need_redraw) {
2320                 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
2321                                 << d->mouse_position_cache_.x_ << ", "
2322                                 << d->mouse_position_cache_.y_ << ")");
2323
2324                 d->update_strategy_ = DecorationUpdate;
2325
2326                 // This event (moving without mouse click) is not passed further.
2327                 // This should be changed if it is further utilized.
2328                 buffer_.changed(false);
2329         }
2330 }
2331
2332
2333 void BufferView::clearLastInset(Inset * inset) const
2334 {
2335         if (d->last_inset_ != inset) {
2336                 LYXERR0("Wrong last_inset!");
2337                 LATTEST(false);
2338         }
2339         d->last_inset_ = nullptr;
2340 }
2341
2342
2343 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
2344 {
2345         //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
2346
2347         // This is only called for mouse related events including
2348         // LFUN_FILE_OPEN generated by drag-and-drop.
2349         FuncRequest cmd = cmd0;
2350
2351         Cursor old = cursor();
2352         Cursor cur(*this);
2353         cur.push(buffer_.inset());
2354         cur.selection(d->cursor_.selection());
2355
2356         // Either the inset under the cursor or the
2357         // surrounding Text will handle this event.
2358
2359         // make sure we stay within the screen...
2360         cmd.set_y(min(max(cmd.y(), -1), height_));
2361
2362         d->mouse_position_cache_.x_ = cmd.x();
2363         d->mouse_position_cache_.y_ = cmd.y();
2364
2365         if (cmd.action() == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
2366                 updateHoveredInset();
2367                 return;
2368         }
2369
2370         // Build temporary cursor.
2371         Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x(), cmd.y());
2372         if (inset) {
2373                 // If inset is not editable, cur.pos() might point behind the
2374                 // inset (depending on cmd.x(), cmd.y()). This is needed for
2375                 // editing to fix bug 9628, but e.g. the context menu needs a
2376                 // cursor in front of the inset.
2377                 if ((inset->hasSettings() || !inset->contextMenuName().empty()
2378                      || inset->lyxCode() == SEPARATOR_CODE) &&
2379                     cur.nextInset() != inset && cur.prevInset() == inset)
2380                         cur.posBackward();
2381         } else if (cur.inTexted() && cur.pos()
2382                         && cur.paragraph().isEnvSeparator(cur.pos() - 1)) {
2383                 // Always place cursor in front of a separator inset.
2384                 cur.posBackward();
2385         }
2386
2387         // Put anchor at the same position.
2388         cur.resetAnchor();
2389
2390         cur.beginUndoGroup();
2391
2392         // Try to dispatch to an non-editable inset near this position
2393         // via the temp cursor. If the inset wishes to change the real
2394         // cursor it has to do so explicitly by using
2395         //  cur.bv().cursor() = cur;  (or similar)
2396         if (inset)
2397                 inset->dispatch(cur, cmd);
2398
2399         // Now dispatch to the temporary cursor. If the real cursor should
2400         // be modified, the inset's dispatch has to do so explicitly.
2401         if (!inset || !cur.result().dispatched())
2402                 cur.dispatch(cmd);
2403
2404         // Notify left insets
2405         if (cur != old) {
2406                 bool badcursor = old.fixIfBroken() | cur.fixIfBroken();
2407                 badcursor |= notifyCursorLeavesOrEnters(old, cur);
2408                 if (badcursor)
2409                         cursor().fixIfBroken();
2410         }
2411
2412         cur.endUndoGroup();
2413
2414         // Do we have a selection?
2415         theSelection().haveSelection(cursor().selection());
2416
2417         if (cur.needBufferUpdate()) {
2418                 cur.clearBufferUpdate();
2419                 buffer().updateBuffer();
2420         }
2421
2422         // If the command has been dispatched,
2423         if (cur.result().dispatched() || cur.result().screenUpdate())
2424                 processUpdateFlags(cur.result().screenUpdate());
2425 }
2426
2427
2428 int BufferView::minVisiblePart()
2429 {
2430         return 2 * defaultRowHeight();
2431 }
2432
2433
2434 int BufferView::scroll(int y)
2435 {
2436         if (y > 0)
2437                 return scrollDown(y);
2438         if (y < 0)
2439                 return scrollUp(-y);
2440         return 0;
2441 }
2442
2443
2444 int BufferView::scrollDown(int offset)
2445 {
2446         Text * text = &buffer_.text();
2447         TextMetrics & tm = d->text_metrics_[text];
2448         int const ymax = height_ + offset;
2449         while (true) {
2450                 pair<pit_type, ParagraphMetrics const *> last = tm.last();
2451                 int bottom_pos = last.second->position() + last.second->descent();
2452                 if (lyxrc.scroll_below_document)
2453                         bottom_pos += height_ - minVisiblePart();
2454                 if (last.first + 1 == int(text->paragraphs().size())) {
2455                         if (bottom_pos <= height_)
2456                                 return 0;
2457                         offset = min(offset, bottom_pos - height_);
2458                         break;
2459                 }
2460                 if (bottom_pos > ymax)
2461                         break;
2462                 tm.newParMetricsDown();
2463         }
2464         d->anchor_ypos_ -= offset;
2465         return -offset;
2466 }
2467
2468
2469 int BufferView::scrollUp(int offset)
2470 {
2471         Text * text = &buffer_.text();
2472         TextMetrics & tm = d->text_metrics_[text];
2473         int ymin = - offset;
2474         while (true) {
2475                 pair<pit_type, ParagraphMetrics const *> first = tm.first();
2476                 int top_pos = first.second->position() - first.second->ascent();
2477                 if (first.first == 0) {
2478                         if (top_pos >= 0)
2479                                 return 0;
2480                         offset = min(offset, - top_pos);
2481                         break;
2482                 }
2483                 if (top_pos < ymin)
2484                         break;
2485                 tm.newParMetricsUp();
2486         }
2487         d->anchor_ypos_ += offset;
2488         return offset;
2489 }
2490
2491
2492 bool BufferView::setCursorFromRow(int row)
2493 {
2494         TexRow::TextEntry start, end;
2495         tie(start,end) = buffer_.texrow().getEntriesFromRow(row);
2496         LYXERR(Debug::LATEX,
2497                "setCursorFromRow: for row " << row << ", TexRow has found "
2498                "start (id=" << start.id << ",pos=" << start.pos << "), "
2499                "end (id=" << end.id << ",pos=" << end.pos << ")");
2500         return setCursorFromEntries(start, end);
2501 }
2502
2503
2504 bool BufferView::setCursorFromEntries(TexRow::TextEntry start,
2505                                       TexRow::TextEntry end)
2506 {
2507         DocIterator dit_start, dit_end;
2508         tie(dit_start,dit_end) =
2509                 TexRow::getDocIteratorsFromEntries(start, end, buffer_);
2510         if (!dit_start)
2511                 return false;
2512         // Setting selection start
2513         d->cursor_.clearSelection();
2514         setCursor(dit_start);
2515         // Setting selection end
2516         if (dit_end) {
2517                 d->cursor_.resetAnchor();
2518                 setCursorSelectionTo(dit_end);
2519         }
2520         return true;
2521 }
2522
2523
2524 bool BufferView::setCursorFromInset(Inset const * inset)
2525 {
2526         // are we already there?
2527         if (cursor().nextInset() == inset)
2528                 return true;
2529
2530         // Inset is not at cursor position. Find it in the document.
2531         Cursor cur(*this);
2532         cur.reset();
2533         while (cur && cur.nextInset() != inset)
2534                 cur.forwardInset();
2535
2536         if (cur) {
2537                 setCursor(cur);
2538                 return true;
2539         }
2540         return false;
2541 }
2542
2543
2544 void BufferView::gotoLabel(docstring const & label)
2545 {
2546         FuncRequest action;
2547         bool have_inactive = false;
2548         for (Buffer const * buf : buffer().allRelatives()) {
2549                 // find label
2550                 for (TocItem const & item : *buf->tocBackend().toc("label")) {
2551                         if (label == item.str() && item.isOutput()) {
2552                                 lyx::dispatch(item.action());
2553                                 return;
2554                         }
2555                         // If we find an inactive label, save it for the case
2556                         // that no active one is there
2557                         if (label == item.str() && !have_inactive) {
2558                                 have_inactive = true;
2559                                 action = item.action();
2560                         }
2561                 }
2562         }
2563         // We only found an inactive label. Go there.
2564         if (have_inactive)
2565                 lyx::dispatch(action);
2566 }
2567
2568
2569 TextMetrics const & BufferView::textMetrics(Text const * t) const
2570 {
2571         return const_cast<BufferView *>(this)->textMetrics(t);
2572 }
2573
2574
2575 TextMetrics & BufferView::textMetrics(Text const * t)
2576 {
2577         LBUFERR(t);
2578         TextMetricsCache::iterator tmc_it  = d->text_metrics_.find(t);
2579         if (tmc_it == d->text_metrics_.end()) {
2580                 tmc_it = d->text_metrics_.emplace(std::piecewise_construct,
2581                                 std::forward_as_tuple(t),
2582                                 std::forward_as_tuple(this, const_cast<Text *>(t))).first;
2583         }
2584         return tmc_it->second;
2585 }
2586
2587
2588 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
2589                 pit_type pit) const
2590 {
2591         return textMetrics(t).parMetrics(pit);
2592 }
2593
2594
2595 int BufferView::workHeight() const
2596 {
2597         return height_;
2598 }
2599
2600
2601 void BufferView::setCursor(DocIterator const & dit)
2602 {
2603         d->cursor_.reset();
2604         size_t const n = dit.depth();
2605         for (size_t i = 0; i < n; ++i)
2606                 dit[i].inset().edit(d->cursor_, true);
2607
2608         d->cursor_.setCursor(dit);
2609         d->cursor_.selection(false);
2610         d->cursor_.setCurrentFont();
2611         // FIXME
2612         // It seems on general grounds as if this is probably needed, but
2613         // it is not yet clear.
2614         // See bug #7394 and r38388.
2615         // d->cursor.resetAnchor();
2616 }
2617
2618
2619 void BufferView::setCursorSelectionTo(DocIterator const & dit)
2620 {
2621         size_t const n = dit.depth();
2622         for (size_t i = 0; i < n; ++i)
2623                 dit[i].inset().edit(d->cursor_, true);
2624
2625         d->cursor_.selection(true);
2626         d->cursor_.setCursorSelectionTo(dit);
2627         d->cursor_.setCurrentFont();
2628 }
2629
2630
2631 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
2632 {
2633         // Would be wrong to delete anything if we have a selection.
2634         if (cur.selection())
2635                 return false;
2636
2637         bool need_anchor_change = false;
2638         bool changed = Text::deleteEmptyParagraphMechanism(cur, old,
2639                 need_anchor_change);
2640
2641         if (need_anchor_change)
2642                 cur.resetAnchor();
2643
2644         if (!changed)
2645                 return false;
2646
2647         d->cursor_ = cur;
2648
2649         // we would rather not do this here, but it needs to be done before
2650         // the changed() signal is sent.
2651         buffer_.updateBuffer();
2652
2653         buffer_.changed(true);
2654         return true;
2655 }
2656
2657
2658 bool BufferView::mouseSetCursor(Cursor & cur, bool const select)
2659 {
2660         LASSERT(&cur.bv() == this, return false);
2661
2662         if (!select)
2663                 // this event will clear selection so we save selection for
2664                 // persistent selection
2665                 cap::saveSelection(cursor());
2666
2667         d->cursor_.macroModeClose();
2668         // If a macro has been finalized, the cursor might have been broken
2669         cur.fixIfBroken();
2670
2671         // Has the cursor just left the inset?
2672         bool const leftinset = (&d->cursor_.inset() != &cur.inset());
2673         if (leftinset)
2674                 d->cursor_.fixIfBroken();
2675
2676         // do the dEPM magic if needed
2677         // FIXME: (1) move this to InsetText::notifyCursorLeaves?
2678         // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
2679         // the leftinset bool would not be necessary (badcursor instead).
2680         bool update = leftinset;
2681
2682         if (select) {
2683                 d->cursor_.setSelection();
2684                 d->cursor_.setCursorSelectionTo(cur);
2685         } else {
2686                 if (d->cursor_.inTexted())
2687                         update |= checkDepm(cur, d->cursor_);
2688                 d->cursor_.resetAnchor();
2689                 d->cursor_.setCursor(cur);
2690                 d->cursor_.clearSelection();
2691         }
2692         d->cursor_.boundary(cur.boundary());
2693         d->cursor_.finishUndo();
2694         d->cursor_.setCurrentFont();
2695         if (update)
2696                 cur.forceBufferUpdate();
2697         return update;
2698 }
2699
2700
2701 void BufferView::putSelectionAt(DocIterator const & cur,
2702                                 int length, bool backwards)
2703 {
2704         d->cursor_.clearSelection();
2705
2706         setCursor(cur);
2707
2708         if (length) {
2709                 if (backwards) {
2710                         d->cursor_.pos() += length;
2711                         d->cursor_.setSelection(d->cursor_, -length);
2712                 } else
2713                         d->cursor_.setSelection(d->cursor_, length);
2714         }
2715 }
2716
2717
2718 bool BufferView::selectIfEmpty(DocIterator & cur)
2719 {
2720         if ((cur.inTexted() && !cur.paragraph().empty())
2721             || (cur.inMathed() && !cur.cell().empty()))
2722                 return false;
2723
2724         pit_type const beg_pit = cur.pit();
2725         if (beg_pit > 0) {
2726                 // The paragraph associated to this item isn't
2727                 // the first one, so it can be selected
2728                 cur.backwardPos();
2729         } else {
2730                 // We have to resort to select the space between the
2731                 // end of this item and the begin of the next one
2732                 cur.forwardPos();
2733         }
2734         if (cur.empty()) {
2735                 // If it is the only item in the document,
2736                 // nothing can be selected
2737                 return false;
2738         }
2739         pit_type const end_pit = cur.pit();
2740         pos_type const end_pos = cur.pos();
2741         d->cursor_.clearSelection();
2742         d->cursor_.reset();
2743         d->cursor_.setCursor(cur);
2744         d->cursor_.pit() = beg_pit;
2745         d->cursor_.pos() = 0;
2746         d->cursor_.selection(false);
2747         d->cursor_.resetAnchor();
2748         d->cursor_.pit() = end_pit;
2749         d->cursor_.pos() = end_pos;
2750         d->cursor_.setSelection();
2751         return true;
2752 }
2753
2754
2755 Cursor & BufferView::cursor()
2756 {
2757         return d->cursor_;
2758 }
2759
2760
2761 Cursor const & BufferView::cursor() const
2762 {
2763         return d->cursor_;
2764 }
2765
2766
2767 bool BufferView::singleParUpdate()
2768 {
2769         Text & buftext = buffer_.text();
2770         pit_type const bottom_pit = d->cursor_.bottom().pit();
2771         TextMetrics & tm = textMetrics(&buftext);
2772         int old_height = tm.parMetrics(bottom_pit).height();
2773
2774         // make sure inline completion pointer is ok
2775         if (d->inlineCompletionPos_.fixIfBroken())
2776                 d->inlineCompletionPos_ = DocIterator();
2777
2778         // In Single Paragraph mode, rebreak only
2779         // the (main text, not inset!) paragraph containing the cursor.
2780         // (if this paragraph contains insets etc., rebreaking will
2781         // recursively descend)
2782         tm.redoParagraph(bottom_pit);
2783         ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
2784         if (pm.height() != old_height)
2785                 // Paragraph height has changed so we cannot proceed to
2786                 // the singlePar optimisation.
2787                 return false;
2788
2789         tm.updatePosCache(bottom_pit);
2790
2791         LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
2792                 << " y2: " << pm.position() + pm.descent()
2793                 << " pit: " << bottom_pit
2794                 << " singlepar: 1");
2795         return true;
2796 }
2797
2798
2799 void BufferView::updateMetrics()
2800 {
2801         updateMetrics(d->update_flags_);
2802         d->update_strategy_ = FullScreenUpdate;
2803 }
2804
2805
2806 void BufferView::updateMetrics(Update::flags & update_flags)
2807 {
2808         if (height_ == 0 || width_ == 0)
2809                 return;
2810
2811         Text & buftext = buffer_.text();
2812         pit_type const npit = int(buftext.paragraphs().size());
2813
2814         // Clear out the position cache in case of full screen redraw,
2815         d->coord_cache_.clear();
2816         d->math_rows_.clear();
2817
2818         // Clear out paragraph metrics to avoid having invalid metrics
2819         // in the cache from paragraphs not relayouted below
2820         // The complete text metrics will be redone.
2821         d->text_metrics_.clear();
2822
2823         TextMetrics & tm = textMetrics(&buftext);
2824
2825         // make sure inline completion pointer is ok
2826         if (d->inlineCompletionPos_.fixIfBroken())
2827                 d->inlineCompletionPos_ = DocIterator();
2828
2829         if (d->anchor_pit_ >= npit)
2830                 // The anchor pit must have been deleted...
2831                 d->anchor_pit_ = npit - 1;
2832
2833         // Rebreak anchor paragraph.
2834         tm.redoParagraph(d->anchor_pit_);
2835         ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
2836
2837         // position anchor
2838         if (d->anchor_pit_ == 0) {
2839                 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
2840
2841                 // Complete buffer visible? Then it's easy.
2842                 if (scrollRange == 0)
2843                         d->anchor_ypos_ = anchor_pm.ascent();
2844                 else {
2845                         // avoid empty space above the first row
2846                         d->anchor_ypos_ = min(d->anchor_ypos_, anchor_pm.ascent());
2847                 }
2848         }
2849         anchor_pm.setPosition(d->anchor_ypos_);
2850         tm.updatePosCache(d->anchor_pit_);
2851
2852         LYXERR(Debug::PAINTING, "metrics: "
2853                 << " anchor pit = " << d->anchor_pit_
2854                 << " anchor ypos = " << d->anchor_ypos_);
2855
2856         // Redo paragraphs above anchor if necessary.
2857         int y1 = d->anchor_ypos_ - anchor_pm.ascent();
2858         // We are now just above the anchor paragraph.
2859         pit_type pit1 = d->anchor_pit_ - 1;
2860         for (; pit1 >= 0 && y1 >= 0; --pit1) {
2861                 tm.redoParagraph(pit1);
2862                 ParagraphMetrics & pm = tm.par_metrics_[pit1];
2863                 y1 -= pm.descent();
2864                 // Save the paragraph position in the cache.
2865                 pm.setPosition(y1);
2866                 tm.updatePosCache(pit1);
2867                 y1 -= pm.ascent();
2868         }
2869
2870         // Redo paragraphs below the anchor if necessary.
2871         int y2 = d->anchor_ypos_ + anchor_pm.descent();
2872         // We are now just below the anchor paragraph.
2873         pit_type pit2 = d->anchor_pit_ + 1;
2874         for (; pit2 < npit && y2 <= height_; ++pit2) {
2875                 tm.redoParagraph(pit2);
2876                 ParagraphMetrics & pm = tm.par_metrics_[pit2];
2877                 y2 += pm.ascent();
2878                 // Save the paragraph position in the cache.
2879                 pm.setPosition(y2);
2880                 tm.updatePosCache(pit2);
2881                 y2 += pm.descent();
2882         }
2883
2884         LYXERR(Debug::PAINTING, "Metrics: "
2885                 << " anchor pit = " << d->anchor_pit_
2886                 << " anchor ypos = " << d->anchor_ypos_
2887                 << " y1 = " << y1
2888                 << " y2 = " << y2
2889                 << " pit1 = " << pit1
2890                 << " pit2 = " << pit2);
2891
2892         // metrics is done, full drawing is necessary now
2893         update_flags = (update_flags & ~Update::Force) | Update::ForceDraw;
2894
2895         // Now update the positions of insets in the cache.
2896         updatePosCache();
2897
2898         if (lyxerr.debugging(Debug::WORKAREA)) {
2899                 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
2900                 d->coord_cache_.dump();
2901         }
2902 }
2903
2904
2905 void BufferView::updatePosCache()
2906 {
2907         // this is the "nodraw" drawing stage: only set the positions of the
2908         // insets in metrics cache.
2909         frontend::NullPainter np;
2910         draw(np, false);
2911 }
2912
2913
2914 void BufferView::insertLyXFile(FileName const & fname, bool const ignorelang)
2915 {
2916         LASSERT(d->cursor_.inTexted(), return);
2917
2918         // Get absolute path of file and add ".lyx"
2919         // to the filename if necessary
2920         FileName filename = fileSearch(string(), fname.absFileName(), "lyx");
2921
2922         docstring const disp_fn = makeDisplayPath(filename.absFileName());
2923         // emit message signal.
2924         message(bformat(_("Inserting document %1$s..."), disp_fn));
2925
2926         docstring res;
2927         Buffer buf(filename.absFileName(), false);
2928         if (buf.loadLyXFile() == Buffer::ReadSuccess) {
2929                 ErrorList & el = buffer_.errorList("Parse");
2930                 // Copy the inserted document error list into the current buffer one.
2931                 el = buf.errorList("Parse");
2932                 ParagraphList & pars = buf.paragraphs();
2933                 if (ignorelang)
2934                         // set main language of imported file to context language
2935                         buf.changeLanguage(buf.language(), d->cursor_.getFont().language());
2936                 buffer_.undo().recordUndo(d->cursor_);
2937                 cap::pasteParagraphList(d->cursor_, pars,
2938                                              buf.params().documentClassPtr(), el);
2939                 res = _("Document %1$s inserted.");
2940         } else {
2941                 res = _("Could not insert document %1$s");
2942         }
2943
2944         buffer_.changed(true);
2945         // emit message signal.
2946         message(bformat(res, disp_fn));
2947 }
2948
2949
2950 Point BufferView::coordOffset(DocIterator const & dit) const
2951 {
2952         int x = 0;
2953         int y = 0;
2954         int lastw = 0;
2955
2956         // Addup contribution of nested insets, from inside to outside,
2957         // keeping the outer paragraph for a special handling below
2958         for (size_t i = dit.depth() - 1; i >= 1; --i) {
2959                 CursorSlice const & sl = dit[i];
2960                 int xx = 0;
2961                 int yy = 0;
2962
2963                 // get relative position inside sl.inset()
2964                 sl.inset().cursorPos(*this, sl, dit.boundary() && (i + 1 == dit.depth()), xx, yy);
2965
2966                 // Make relative position inside of the edited inset relative to sl.inset()
2967                 x += xx;
2968                 y += yy;
2969
2970                 // In case of an RTL inset, the edited inset will be positioned to the left
2971                 // of xx:yy
2972                 if (sl.text()) {
2973                         bool boundary_i = dit.boundary() && i + 1 == dit.depth();
2974                         bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2975                         if (rtl)
2976                                 x -= lastw;
2977                 }
2978
2979                 // remember width for the case that sl.inset() is positioned in an RTL inset
2980                 lastw = sl.inset().dimension(*this).wid;
2981
2982                 //lyxerr << "Cursor::getPos, i: "
2983                 // << i << " x: " << xx << " y: " << y << endl;
2984         }
2985
2986         // Add contribution of initial rows of outermost paragraph
2987         CursorSlice const & sl = dit[0];
2988         TextMetrics const & tm = textMetrics(sl.text());
2989         ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2990
2991         LBUFERR(!pm.rows().empty());
2992         y -= pm.rows()[0].ascent();
2993 #if 1
2994         // FIXME: document this mess
2995         size_t rend;
2996         if (sl.pos() > 0 && dit.depth() == 1) {
2997                 int pos = sl.pos();
2998                 if (pos && dit.boundary())
2999                         --pos;
3000 //              lyxerr << "coordOffset: boundary:" << dit.boundary() << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
3001                 rend = pm.pos2row(pos);
3002         } else
3003                 rend = pm.pos2row(sl.pos());
3004 #else
3005         size_t rend = pm.pos2row(sl.pos());
3006 #endif
3007         for (size_t rit = 0; rit != rend; ++rit)
3008                 y += pm.rows()[rit].height();
3009         y += pm.rows()[rend].ascent();
3010
3011         TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
3012
3013         // Make relative position from the nested inset now bufferview absolute.
3014         int xx = bottom_tm.cursorX(dit.bottom(), dit.boundary() && dit.depth() == 1);
3015         x += xx;
3016
3017         // In the RTL case place the nested inset at the left of the cursor in
3018         // the outer paragraph
3019         bool boundary_1 = dit.boundary() && 1 == dit.depth();
3020         bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
3021         if (rtl)
3022                 x -= lastw;
3023
3024         return Point(x, y);
3025 }
3026
3027
3028 Point BufferView::getPos(DocIterator const & dit) const
3029 {
3030         if (!paragraphVisible(dit))
3031                 return Point(-1, -1);
3032
3033         CursorSlice const & bot = dit.bottom();
3034         TextMetrics const & tm = textMetrics(bot.text());
3035
3036         // offset from outer paragraph
3037         Point p = coordOffset(dit);
3038         p.y_ += tm.parMetrics(bot.pit()).position();
3039         return p;
3040 }
3041
3042
3043 bool BufferView::paragraphVisible(DocIterator const & dit) const
3044 {
3045         CursorSlice const & bot = dit.bottom();
3046         TextMetrics const & tm = textMetrics(bot.text());
3047
3048         return tm.contains(bot.pit());
3049 }
3050
3051
3052 void BufferView::caretPosAndHeight(Point & p, int & h) const
3053 {
3054         int asc, des;
3055         Cursor const & cur = cursor();
3056         if (cur.inMathed()) {
3057                 MathRow const & mrow = mathRow(&cur.cell());
3058                 asc = mrow.caret_ascent;
3059                 des = mrow.caret_descent;
3060         } else {
3061                 Font const font = cur.real_current_font;
3062                 frontend::FontMetrics const & fm = theFontMetrics(font);
3063                 asc = fm.maxAscent();
3064                 des = fm.maxDescent();
3065         }
3066         h = asc + des;
3067         p = getPos(cur);
3068         p.y_ -= asc;
3069 }
3070
3071
3072 bool BufferView::caretInView() const
3073 {
3074         if (!paragraphVisible(cursor()))
3075                 return false;
3076         Point p;
3077         int h;
3078         caretPosAndHeight(p, h);
3079
3080         // does the cursor touch the screen ?
3081         if (p.y_ + h < 0 || p.y_ >= workHeight())
3082                 return false;
3083         return true;
3084 }
3085
3086
3087 int BufferView::horizScrollOffset() const
3088 {
3089         return d->horiz_scroll_offset_;
3090 }
3091
3092
3093 int BufferView::horizScrollOffset(Text const * text,
3094                                   pit_type pit, pos_type pos) const
3095 {
3096         // Is this a row that is currently scrolled?
3097         if (!d->current_row_slice_.empty()
3098             && &text->inset() == d->current_row_slice_.inset().asInsetText()
3099             && pit ==  d->current_row_slice_.pit()
3100             && pos ==  d->current_row_slice_.pos())
3101                 return d->horiz_scroll_offset_;
3102         return 0;
3103 }
3104
3105
3106 void BufferView::setCurrentRowSlice(CursorSlice const & rowSlice)
3107 {
3108         // nothing to do if the cursor was already on this row
3109         if (d->current_row_slice_ == rowSlice)
3110                 return;
3111
3112         // if the (previous) current row was scrolled, we have to
3113         // remember it in order to repaint it next time.
3114         if (d->horiz_scroll_offset_ != 0) {
3115                 // search the old row in cache and mark it changed
3116                 for (auto & tm_pair : d->text_metrics_) {
3117                         if (&tm_pair.first->inset() == rowSlice.inset().asInsetText()) {
3118                                 tm_pair.second.setRowChanged(rowSlice.pit(), rowSlice.pos());
3119                                 // We found it, no need to continue.
3120                                 break;
3121                         }
3122                 }
3123         }
3124
3125         // Since we changed row, the scroll offset is not valid anymore
3126         d->horiz_scroll_offset_ = 0;
3127         d->current_row_slice_ = rowSlice;
3128 }
3129
3130
3131 void BufferView::checkCursorScrollOffset()
3132 {
3133         CursorSlice rowSlice = d->cursor_.bottom();
3134         TextMetrics const & tm = textMetrics(rowSlice.text());
3135
3136         // Stop if metrics have not been computed yet, since it means
3137         // that there is nothing to do.
3138         if (!tm.contains(rowSlice.pit()))
3139                 return;
3140         ParagraphMetrics const & pm = tm.parMetrics(rowSlice.pit());
3141         Row const & row = pm.getRow(rowSlice.pos(),
3142                                     d->cursor_.boundary() && rowSlice == d->cursor_.top());
3143         rowSlice.pos() = row.pos();
3144
3145         // Set the row on which the cursor lives.
3146         setCurrentRowSlice(rowSlice);
3147
3148         // Current x position of the cursor in pixels
3149         int cur_x = getPos(d->cursor_).x_;
3150
3151         // Horizontal scroll offset of the cursor row in pixels
3152         int offset = d->horiz_scroll_offset_;
3153         int const MARGIN = 2 * theFontMetrics(d->cursor_.real_current_font).em()
3154                            + row.right_margin;
3155         if (row.right_x() <= workWidth() - row.right_margin) {
3156                 // Row is narrower than the work area, no offset needed.
3157                 offset = 0;
3158         } else {
3159                 if (cur_x - offset < MARGIN) {
3160                         // cursor would be too far right
3161                         offset = cur_x - MARGIN;
3162                 } else if (cur_x - offset > workWidth() - MARGIN) {
3163                         // cursor would be too far left
3164                         offset = cur_x - workWidth() + MARGIN;
3165                 }
3166                 // Correct the offset to make sure that we do not scroll too much
3167                 if (offset < 0)
3168                         offset = 0;
3169                 if (row.right_x() - offset < workWidth() - row.right_margin)
3170                         offset = row.right_x() - workWidth() + row.right_margin;
3171         }
3172
3173         //lyxerr << "cur_x=" << cur_x << ", offset=" << offset << ", row.wid=" << row.width() << ", margin=" << MARGIN << endl;
3174
3175         if (offset != d->horiz_scroll_offset_)
3176                 LYXERR(Debug::PAINTING, "Horiz. scroll offset changed from "
3177                        << d->horiz_scroll_offset_ << " to " << offset);
3178
3179         if (d->update_strategy_ == NoScreenUpdate
3180             && offset != d->horiz_scroll_offset_) {
3181                 // FIXME: if one uses SingleParUpdate, then home/end
3182                 // will not work on long rows. Why?
3183                 d->update_strategy_ = FullScreenUpdate;
3184         }
3185
3186         d->horiz_scroll_offset_ = offset;
3187 }
3188
3189
3190 void BufferView::draw(frontend::Painter & pain, bool paint_caret)
3191 {
3192         if (height_ == 0 || width_ == 0)
3193                 return;
3194         LYXERR(Debug::PAINTING, (pain.isNull() ? "\t\t--- START NODRAW ---"
3195                                  : "\t\t*** START DRAWING ***"));
3196         Text & text = buffer_.text();
3197         TextMetrics const & tm = d->text_metrics_[&text];
3198         int const y = tm.first().second->position();
3199         PainterInfo pi(this, pain);
3200
3201         // Check whether the row where the cursor lives needs to be scrolled.
3202         // Update the drawing strategy if needed.
3203         checkCursorScrollOffset();
3204
3205         switch (d->update_strategy_) {
3206
3207         case NoScreenUpdate:
3208                 // no screen painting is actually needed. In nodraw stage
3209                 // however, the different coordinates of insets and paragraphs
3210                 // needs to be updated.
3211                 LYXERR(Debug::PAINTING, "Strategy: NoScreenUpdate");
3212                 if (pain.isNull()) {
3213                         pi.full_repaint = true;
3214                         tm.draw(pi, 0, y);
3215                 } else {
3216                         pi.full_repaint = false;
3217                         tm.draw(pi, 0, y);
3218                 }
3219                 break;
3220
3221         case SingleParUpdate:
3222                 pi.full_repaint = false;
3223                 LYXERR(Debug::PAINTING, "Strategy: SingleParUpdate");
3224                 // In general, only the current row of the outermost paragraph
3225                 // will be redrawn. Particular cases where selection spans
3226                 // multiple paragraph are correctly detected in TextMetrics.
3227                 tm.draw(pi, 0, y);
3228                 break;
3229
3230         case DecorationUpdate:
3231                 // FIXME: We should also distinguish DecorationUpdate to avoid text
3232                 // drawing if possible. This is not possible to do easily right now
3233                 // because of the single backing pixmap.
3234
3235         case FullScreenUpdate:
3236
3237                 LYXERR(Debug::PAINTING,
3238                        ((d->update_strategy_ == FullScreenUpdate)
3239                         ? "Strategy: FullScreenUpdate"
3240                         : "Strategy: DecorationUpdate"));
3241
3242                 // The whole screen, including insets, will be refreshed.
3243                 pi.full_repaint = true;
3244
3245                 // Clear background.
3246                 pain.fillRectangle(0, 0, width_, height_,
3247                         pi.backgroundColor(&buffer_.inset()));
3248
3249                 // Draw everything.
3250                 tm.draw(pi, 0, y);
3251
3252                 // and possibly grey out below
3253                 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3254                 int const y2 = lastpm.second->position() + lastpm.second->descent();
3255
3256                 if (y2 < height_) {
3257                         Color color = buffer().isInternal()
3258                                 ? Color_background : Color_bottomarea;
3259                         pain.fillRectangle(0, y2, width_, height_ - y2, color);
3260                 }
3261                 break;
3262         }
3263         LYXERR(Debug::PAINTING, (pain.isNull() ? "\t\t --- END NODRAW ---"
3264                                 : "\t\t *** END DRAWING ***"));
3265
3266         // The scrollbar needs an update.
3267         updateScrollbar();
3268
3269         // Normalize anchor for next time
3270         pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
3271         pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3272         for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
3273                 ParagraphMetrics const & pm = tm.parMetrics(pit);
3274                 if (pm.position() + pm.descent() > 0) {
3275                         if (d->anchor_pit_ != pit
3276                             || d->anchor_ypos_ != pm.position())
3277                                 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
3278                                        << "  anchor ypos = " << d->anchor_ypos_);
3279                         d->anchor_pit_ = pit;
3280                         d->anchor_ypos_ = pm.position();
3281                         break;
3282                 }
3283         }
3284         if (!pain.isNull()) {
3285                 // reset the update flags, everything has been done
3286                 d->update_flags_ = Update::None;
3287         }
3288
3289         // If a caret has to be painted, mark its text row as dirty to
3290         //make sure that it will be repainted on next redraw.
3291         /* FIXME: investigate whether this can be avoided when the cursor did not
3292          * move at all
3293          */
3294         if (paint_caret) {
3295                 Row const & caret_row = d->cursor_.textRow();
3296                 caret_row.changed(true);
3297         }
3298 }
3299
3300
3301 void BufferView::message(docstring const & msg)
3302 {
3303         if (d->gui_)
3304                 d->gui_->message(msg);
3305 }
3306
3307
3308 void BufferView::showDialog(string const & name)
3309 {
3310         if (d->gui_)
3311                 d->gui_->showDialog(name, string());
3312 }
3313
3314
3315 void BufferView::showDialog(string const & name,
3316         string const & data, Inset * inset)
3317 {
3318         if (d->gui_)
3319                 d->gui_->showDialog(name, data, inset);
3320 }
3321
3322
3323 void BufferView::updateDialog(string const & name, string const & data)
3324 {
3325         if (d->gui_)
3326                 d->gui_->updateDialog(name, data);
3327 }
3328
3329
3330 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
3331 {
3332         d->gui_ = gui;
3333 }
3334
3335
3336 // FIXME: Move this out of BufferView again
3337 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
3338 {
3339         if (!fname.isReadableFile()) {
3340                 docstring const error = from_ascii(strerror(errno));
3341                 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3342                 docstring const text =
3343                   bformat(_("Could not read the specified document\n"
3344                             "%1$s\ndue to the error: %2$s"), file, error);
3345                 Alert::error(_("Could not read file"), text);
3346                 return docstring();
3347         }
3348
3349         if (!fname.isReadableFile()) {
3350                 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3351                 docstring const text =
3352                   bformat(_("%1$s\n is not readable."), file);
3353                 Alert::error(_("Could not open file"), text);
3354                 return docstring();
3355         }
3356
3357         // FIXME UNICODE: We don't know the encoding of the file
3358         docstring file_content = fname.fileContents("UTF-8");
3359         if (file_content.empty()) {
3360                 Alert::error(_("Reading not UTF-8 encoded file"),
3361                              _("The file is not UTF-8 encoded.\n"
3362                                "It will be read as local 8Bit-encoded.\n"
3363                                "If this does not give the correct result\n"
3364                                "then please change the encoding of the file\n"
3365                                "to UTF-8 with a program other than LyX.\n"));
3366                 file_content = fname.fileContents("local8bit");
3367         }
3368
3369         return normalize_c(file_content);
3370 }
3371
3372
3373 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
3374 {
3375         docstring const tmpstr = contentsOfPlaintextFile(f);
3376
3377         if (tmpstr.empty())
3378                 return;
3379
3380         Cursor & cur = cursor();
3381         cap::replaceSelection(cur);
3382         buffer_.undo().recordUndo(cur);
3383         if (asParagraph)
3384                 cur.innerText()->insertStringAsParagraphs(cur, tmpstr, cur.current_font);
3385         else
3386                 cur.innerText()->insertStringAsLines(cur, tmpstr, cur.current_font);
3387
3388         buffer_.changed(true);
3389 }
3390
3391
3392 docstring const & BufferView::inlineCompletion() const
3393 {
3394         return d->inlineCompletion_;
3395 }
3396
3397
3398 size_t const & BufferView::inlineCompletionUniqueChars() const
3399 {
3400         return d->inlineCompletionUniqueChars_;
3401 }
3402
3403
3404 DocIterator const & BufferView::inlineCompletionPos() const
3405 {
3406         return d->inlineCompletionPos_;
3407 }
3408
3409
3410 void BufferView::resetInlineCompletionPos()
3411 {
3412         d->inlineCompletionPos_ = DocIterator();
3413 }
3414
3415
3416 bool samePar(DocIterator const & a, DocIterator const & b)
3417 {
3418         if (a.empty() && b.empty())
3419                 return true;
3420         if (a.empty() || b.empty())
3421                 return false;
3422         if (a.depth() != b.depth())
3423                 return false;
3424         return &a.innerParagraph() == &b.innerParagraph();
3425 }
3426
3427
3428 void BufferView::setInlineCompletion(Cursor const & cur, DocIterator const & pos,
3429         docstring const & completion, size_t uniqueChars)
3430 {
3431         uniqueChars = min(completion.size(), uniqueChars);
3432         bool changed = d->inlineCompletion_ != completion
3433                 || d->inlineCompletionUniqueChars_ != uniqueChars;
3434         bool singlePar = true;
3435         d->inlineCompletion_ = completion;
3436         d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
3437
3438         //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
3439
3440         // at new position?
3441         DocIterator const & old = d->inlineCompletionPos_;
3442         if (old != pos) {
3443                 //lyxerr << "inlineCompletionPos changed" << std::endl;
3444                 // old or pos are in another paragraph?
3445                 if ((!samePar(cur, pos) && !pos.empty())
3446                     || (!samePar(cur, old) && !old.empty())) {
3447                         singlePar = false;
3448                         //lyxerr << "different paragraph" << std::endl;
3449                 }
3450                 d->inlineCompletionPos_ = pos;
3451         }
3452
3453         // set update flags
3454         if (changed) {
3455                 if (singlePar && !(cur.result().screenUpdate() & Update::Force))
3456                         cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
3457                 else
3458                         cur.screenUpdateFlags(cur.result().screenUpdate() | Update::Force);
3459         }
3460 }
3461
3462
3463 bool BufferView::clickableInset() const
3464 {
3465         return d->clickable_inset_;
3466 }
3467
3468 } // namespace lyx