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