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