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