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