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