src/BufferView.cpp

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