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.selection());
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         d->edited_insets_[name] = inset;
1252 }
1253
1254
1255 void BufferView::dispatch(FuncRequest const & cmd, DispatchResult & dr)
1256 {
1257         LYXERR(Debug::ACTION, "BufferView::dispatch: cmd: " << cmd);
1258
1259         string const argument = to_utf8(cmd.argument());
1260         Cursor & cur = d->cursor_;
1261         Cursor old = cur;
1262
1263         // Don't dispatch function that does not apply to internal buffers.
1264         if (buffer_.isInternal()
1265             && lyxaction.funcHasFlag(cmd.action(), LyXAction::NoInternal))
1266                 return;
1267
1268         // We'll set this back to false if need be.
1269         bool dispatched = true;
1270         buffer_.undo().beginUndoGroup();
1271
1272         FuncCode const act = cmd.action();
1273         switch (act) {
1274
1275         case LFUN_BUFFER_PARAMS_APPLY: {
1276                 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1277                 cur.recordUndoBufferParams();
1278                 istringstream ss(to_utf8(cmd.argument()));
1279                 Lexer lex;
1280                 lex.setStream(ss);
1281                 int const unknown_tokens = buffer_.readHeader(lex);
1282                 if (unknown_tokens != 0) {
1283                         LYXERR0("Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1284                                                 << unknown_tokens << " unknown token"
1285                                                 << (unknown_tokens == 1 ? "" : "s"));
1286                 }
1287                 updateDocumentClass(olddc);
1288
1289                 // We are most certainly here because of a change in the document
1290                 // It is then better to make sure that all dialogs are in sync with
1291                 // current document settings.
1292                 dr.screenUpdate(Update::Force | Update::FitCursor);
1293                 dr.forceBufferUpdate();
1294                 break;
1295         }
1296
1297         case LFUN_LAYOUT_MODULES_CLEAR: {
1298                 // FIXME: this modifies the document in cap::switchBetweenClasses
1299                 //  without calling recordUndo. Fix this before using
1300                 //  recordUndoBufferParams().
1301                 cur.recordUndoFullBuffer();
1302                 buffer_.params().clearLayoutModules();
1303                 makeDocumentClass();
1304                 dr.screenUpdate(Update::Force);
1305                 dr.forceBufferUpdate();
1306                 break;
1307         }
1308
1309         case LFUN_LAYOUT_MODULE_ADD: {
1310                 BufferParams const & params = buffer_.params();
1311                 if (!params.layoutModuleCanBeAdded(argument)) {
1312                         LYXERR0("Module `" << argument <<
1313                                 "' cannot be added due to failed requirements or "
1314                                 "conflicts with installed modules.");
1315                         break;
1316                 }
1317                 // FIXME: this modifies the document in cap::switchBetweenClasses
1318                 //  without calling recordUndo. Fix this before using
1319                 //  recordUndoBufferParams().
1320                 cur.recordUndoFullBuffer();
1321                 buffer_.params().addLayoutModule(argument);
1322                 makeDocumentClass();
1323                 dr.screenUpdate(Update::Force);
1324                 dr.forceBufferUpdate();
1325                 break;
1326         }
1327
1328         case LFUN_TEXTCLASS_APPLY: {
1329                 // since this shortcircuits, the second call is made only if
1330                 // the first fails
1331                 bool const success =
1332                         LayoutFileList::get().load(argument, buffer_.temppath()) ||
1333                         LayoutFileList::get().load(argument, buffer_.filePath());
1334                 if (!success) {
1335                         docstring s = bformat(_("The document class `%1$s' "
1336                                                  "could not be loaded."), from_utf8(argument));
1337                         frontend::Alert::error(_("Could not load class"), s);
1338                         break;
1339                 }
1340
1341                 LayoutFile const * old_layout = buffer_.params().baseClass();
1342                 LayoutFile const * new_layout = &(LayoutFileList::get()[argument]);
1343
1344                 if (old_layout == new_layout)
1345                         // nothing to do
1346                         break;
1347
1348                 // Save the old, possibly modular, layout for use in conversion.
1349                 // FIXME: this modifies the document in cap::switchBetweenClasses
1350                 //  without calling recordUndo. Fix this before using
1351                 //  recordUndoBufferParams().
1352                 cur.recordUndoFullBuffer();
1353                 buffer_.params().setBaseClass(argument, buffer_.layoutPos());
1354                 makeDocumentClass();
1355                 dr.screenUpdate(Update::Force);
1356                 dr.forceBufferUpdate();
1357                 break;
1358         }
1359
1360         case LFUN_TEXTCLASS_LOAD: {
1361                 // since this shortcircuits, the second call is made only if
1362                 // the first fails
1363                 bool const success =
1364                         LayoutFileList::get().load(argument, buffer_.temppath()) ||
1365                         LayoutFileList::get().load(argument, buffer_.filePath());
1366                 if (!success) {
1367                         docstring s = bformat(_("The document class `%1$s' "
1368                                                  "could not be loaded."), from_utf8(argument));
1369                         frontend::Alert::error(_("Could not load class"), s);
1370                 }
1371                 break;
1372         }
1373
1374         case LFUN_LAYOUT_RELOAD: {
1375                 LayoutFileIndex bc = buffer_.params().baseClassID();
1376                 LayoutFileList::get().reset(bc);
1377                 buffer_.params().setBaseClass(bc, buffer_.layoutPos());
1378                 makeDocumentClass();
1379                 dr.screenUpdate(Update::Force);
1380                 dr.forceBufferUpdate();
1381                 break;
1382         }
1383
1384         case LFUN_UNDO: {
1385                 dr.setMessage(_("Undo"));
1386                 cur.clearSelection();
1387                 // We need to find out if the bibliography information
1388                 // has changed. See bug #11055.
1389                 // So these should not be references...
1390                 LayoutModuleList const engines = buffer().params().citeEngine();
1391                 CiteEngineType const enginetype = buffer().params().citeEngineType();
1392                 if (!cur.textUndo())
1393                         dr.setMessage(_("No further undo information"));
1394                 else {
1395                         dr.screenUpdate(Update::Force | Update::FitCursor);
1396                         dr.forceBufferUpdate();
1397                         if (buffer().params().citeEngine() != engines ||
1398                             buffer().params().citeEngineType() != enginetype)
1399                                 buffer().invalidateCiteLabels();
1400                 }
1401                 break;
1402         }
1403
1404         case LFUN_REDO: {
1405                 dr.setMessage(_("Redo"));
1406                 cur.clearSelection();
1407                 // We need to find out if the bibliography information
1408                 // has changed. See bug #11055.
1409                 // So these should not be references...
1410                 LayoutModuleList const engines = buffer().params().citeEngine();
1411                 CiteEngineType const enginetype = buffer().params().citeEngineType();
1412                 if (!cur.textRedo())
1413                         dr.setMessage(_("No further redo information"));
1414                 else {
1415                         dr.screenUpdate(Update::Force | Update::FitCursor);
1416                         dr.forceBufferUpdate();
1417                         if (buffer().params().citeEngine() != engines ||
1418                             buffer().params().citeEngineType() != enginetype)
1419                                 buffer().invalidateCiteLabels();
1420                 }
1421                 break;
1422         }
1423
1424         case LFUN_FONT_STATE:
1425                 dr.setMessage(cur.currentState(false));
1426                 break;
1427
1428         case LFUN_BOOKMARK_SAVE:
1429                 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1430                 break;
1431
1432         case LFUN_LABEL_GOTO: {
1433                 docstring label = cmd.argument();
1434                 if (label.empty()) {
1435                         InsetRef * inset =
1436                                 getInsetByCode<InsetRef>(cur, REF_CODE);
1437                         if (inset) {
1438                                 label = inset->getParam("reference");
1439                                 // persistent=false: use temp_bookmark
1440                                 saveBookmark(0);
1441                         }
1442                 }
1443                 if (!label.empty()) {
1444                         gotoLabel(label);
1445                         // at the moment, this is redundant, since gotoLabel will
1446                         // eventually call LFUN_PARAGRAPH_GOTO, but it seems best
1447                         // to have it here.
1448                         dr.screenUpdate(Update::Force | Update::FitCursor);
1449                 }
1450                 break;
1451         }
1452
1453         case LFUN_PARAGRAPH_GOTO: {
1454                 int const id = convert<int>(cmd.getArg(0));
1455                 pos_type const pos = convert<int>(cmd.getArg(1));
1456                 if (id < 0)
1457                         break;
1458                 string const str_id_end = cmd.getArg(2);
1459                 string const str_pos_end = cmd.getArg(3);
1460                 int i = 0;
1461                 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1462                         b = theBufferList().next(b)) {
1463
1464                         Cursor cur(*this);
1465                         cur.setCursor(b->getParFromID(id));
1466                         if (cur.atEnd()) {
1467                                 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1468                                 ++i;
1469                                 continue;
1470                         }
1471                         LYXERR(Debug::INFO, "Paragraph " << cur.paragraph().id()
1472                                 << " found in buffer `"
1473                                 << b->absFileName() << "'.");
1474
1475                         if (b == &buffer_) {
1476                                 bool success;
1477                                 if (str_id_end.empty() || str_pos_end.empty()) {
1478                                         // Set the cursor
1479                                         cur.pos() = pos;
1480                                         mouseSetCursor(cur);
1481                                         success = true;
1482                                 } else {
1483                                         int const id_end = convert<int>(str_id_end);
1484                                         pos_type const pos_end = convert<int>(str_pos_end);
1485                                         success = setCursorFromEntries({id, pos},
1486                                                                        {id_end, pos_end});
1487                                 }
1488                                 if (success)
1489                                         dr.screenUpdate(Update::Force | Update::FitCursor);
1490                         } else {
1491                                 // Switch to other buffer view and resend cmd
1492                                 lyx::dispatch(FuncRequest(
1493                                         LFUN_BUFFER_SWITCH, b->absFileName()));
1494                                 lyx::dispatch(cmd);
1495                         }
1496                         break;
1497                 }
1498                 break;
1499         }
1500
1501         case LFUN_NOTE_NEXT:
1502                 gotoInset(this, NOTE_CODE, false);
1503                 break;
1504
1505         case LFUN_REFERENCE_NEXT: {
1506                 vector<InsetCode> tmp;
1507                 tmp.push_back(LABEL_CODE);
1508                 tmp.push_back(REF_CODE);
1509                 gotoInset(this, tmp, true);
1510                 break;
1511         }
1512
1513         case LFUN_CHANGE_NEXT:
1514                 findNextChange(this);
1515                 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1516                 dr.screenUpdate(Update::Force | Update::FitCursor);
1517                 break;
1518
1519         case LFUN_CHANGE_PREVIOUS:
1520                 findPreviousChange(this);
1521                 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1522                 dr.screenUpdate(Update::Force | Update::FitCursor);
1523                 break;
1524
1525         case LFUN_CHANGES_MERGE:
1526                 if (findNextChange(this) || findPreviousChange(this)) {
1527                         dr.screenUpdate(Update::Force | Update::FitCursor);
1528                         dr.forceBufferUpdate();
1529                         showDialog("changes");
1530                 }
1531                 break;
1532
1533         case LFUN_ALL_CHANGES_ACCEPT:
1534                 // select complete document
1535                 cur.reset();
1536                 cur.selHandle(true);
1537                 buffer_.text().cursorBottom(cur);
1538                 // accept everything in a single step to support atomic undo
1539                 buffer_.text().acceptOrRejectChanges(cur, Text::ACCEPT);
1540                 cur.resetAnchor();
1541                 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1542                 dr.screenUpdate(Update::Force | Update::FitCursor);
1543                 dr.forceBufferUpdate();
1544                 break;
1545
1546         case LFUN_ALL_CHANGES_REJECT:
1547                 // select complete document
1548                 cur.reset();
1549                 cur.selHandle(true);
1550                 buffer_.text().cursorBottom(cur);
1551                 // reject everything in a single step to support atomic undo
1552                 // Note: reject does not work recursively; the user may have to repeat the operation
1553                 buffer_.text().acceptOrRejectChanges(cur, Text::REJECT);
1554                 cur.resetAnchor();
1555                 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1556                 dr.screenUpdate(Update::Force | Update::FitCursor);
1557                 dr.forceBufferUpdate();
1558                 break;
1559
1560         case LFUN_WORD_FIND_FORWARD:
1561         case LFUN_WORD_FIND_BACKWARD: {
1562                 // FIXME THREAD
1563                 // Would it maybe be better if this variable were view specific anyway?
1564                 static docstring last_search;
1565                 docstring searched_string;
1566
1567                 if (!cmd.argument().empty()) {
1568                         last_search = cmd.argument();
1569                         searched_string = cmd.argument();
1570                 } else {
1571                         searched_string = last_search;
1572                 }
1573
1574                 if (searched_string.empty())
1575                         break;
1576
1577                 bool const fw = act == LFUN_WORD_FIND_FORWARD;
1578                 docstring const data =
1579                         find2string(searched_string, true, false, fw);
1580                 bool found = lyxfind(this, FuncRequest(LFUN_WORD_FIND, data));
1581                 if (found)
1582                         dr.screenUpdate(Update::Force | Update::FitCursor);
1583                 break;
1584         }
1585
1586         case LFUN_WORD_FIND: {
1587                 FuncRequest req = cmd;
1588                 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1589                         req = d->search_request_cache_;
1590                 if (req.argument().empty()) {
1591                         lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, "findreplace"));
1592                         break;
1593                 }
1594                 if (lyxfind(this, req))
1595                         dr.screenUpdate(Update::Force | Update::FitCursor);
1596
1597                 d->search_request_cache_ = req;
1598                 break;
1599         }
1600
1601         case LFUN_WORD_REPLACE: {
1602                 bool has_deleted = false;
1603                 if (cur.selection()) {
1604                         DocIterator beg = cur.selectionBegin();
1605                         DocIterator end = cur.selectionEnd();
1606                         if (beg.pit() == end.pit()) {
1607                                 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1608                                         if (!cur.inMathed() && cur.paragraph().isDeleted(p)) {
1609                                                 has_deleted = true;
1610                                                 break;
1611                                         }
1612                                 }
1613                         }
1614                 }
1615                 if (lyxreplace(this, cmd, has_deleted)) {
1616                         dr.forceBufferUpdate();
1617                         dr.screenUpdate(Update::Force | Update::FitCursor);
1618                 }
1619                 break;
1620         }
1621
1622         case LFUN_WORD_FINDADV: {
1623                 FindAndReplaceOptions opt;
1624                 istringstream iss(to_utf8(cmd.argument()));
1625                 iss >> opt;
1626                 if (findAdv(this, opt)) {
1627                         dr.screenUpdate(Update::Force | Update::FitCursor);
1628                         cur.dispatched();
1629                         dispatched = true;
1630                 } else {
1631                         cur.undispatched();
1632                         dispatched = false;
1633                 }
1634                 break;
1635         }
1636
1637         case LFUN_MARK_OFF:
1638                 cur.clearSelection();
1639                 dr.setMessage(from_utf8(N_("Mark off")));
1640                 break;
1641
1642         case LFUN_MARK_ON:
1643                 cur.clearSelection();
1644                 cur.setMark(true);
1645                 dr.setMessage(from_utf8(N_("Mark on")));
1646                 break;
1647
1648         case LFUN_MARK_TOGGLE:
1649                 cur.selection(false);
1650                 if (cur.mark()) {
1651                         cur.setMark(false);
1652                         dr.setMessage(from_utf8(N_("Mark removed")));
1653                 } else {
1654                         cur.setMark(true);
1655                         dr.setMessage(from_utf8(N_("Mark set")));
1656                 }
1657                 cur.resetAnchor();
1658                 break;
1659
1660         case LFUN_SCREEN_SHOW_CURSOR:
1661                 showCursor();
1662                 break;
1663
1664         case LFUN_SCREEN_RECENTER:
1665                 recenter();
1666                 break;
1667
1668         case LFUN_BIBTEX_DATABASE_ADD: {
1669                 Cursor tmpcur = cur;
1670                 findInset(tmpcur, BIBTEX_CODE, false);
1671                 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1672                                                 BIBTEX_CODE);
1673                 if (inset) {
1674                         if (inset->addDatabase(cmd.argument())) {
1675                                 dr.forceBufferUpdate();
1676                         }
1677                 }
1678                 break;
1679         }
1680
1681         case LFUN_BIBTEX_DATABASE_DEL: {
1682                 Cursor tmpcur = cur;
1683                 findInset(tmpcur, BIBTEX_CODE, false);
1684                 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1685                                                 BIBTEX_CODE);
1686                 if (inset) {
1687                         if (inset->delDatabase(cmd.argument()))
1688                                 dr.forceBufferUpdate();
1689                 }
1690                 break;
1691         }
1692
1693         case LFUN_GRAPHICS_UNIFY: {
1694
1695                 cur.recordUndoFullBuffer();
1696
1697                 DocIterator from, to;
1698                 from = cur.selectionBegin();
1699                 to = cur.selectionEnd();
1700
1701                 string const newId = cmd.getArg(0);
1702                 bool fetchId = newId.empty(); //if we wait for groupId from first graphics inset
1703
1704                 InsetGraphicsParams grp_par;
1705                 if (!fetchId)
1706                         InsetGraphics::string2params(graphics::getGroupParams(buffer_, newId), buffer_, grp_par);
1707
1708                 if (!from.nextInset())  //move to closest inset
1709                         from.forwardInset();
1710
1711                 while (!from.empty() && from < to) {
1712                         Inset * inset = from.nextInset();
1713                         if (!inset)
1714                                 break;
1715                         if (inset->lyxCode() == GRAPHICS_CODE) {
1716                         InsetGraphics & ig = static_cast<InsetGraphics &>(*inset);
1717                                 InsetGraphicsParams inspar = ig.getParams();
1718                                 if (fetchId) {
1719                                         grp_par = inspar;
1720                                         fetchId = false;
1721                                 } else {
1722                                         grp_par.filename = inspar.filename;
1723                                         ig.setParams(grp_par);
1724                                 }
1725                         }
1726                         from.forwardInset();
1727                 }
1728                 dr.screenUpdate(Update::Force); //needed if triggered from context menu
1729                 break;
1730         }
1731
1732         case LFUN_STATISTICS: {
1733                 DocIterator from, to;
1734                 if (cur.selection()) {
1735                         from = cur.selectionBegin();
1736                         to = cur.selectionEnd();
1737                 } else {
1738                         from = doc_iterator_begin(&buffer_);
1739                         to = doc_iterator_end(&buffer_);
1740                 }
1741                 buffer_.updateStatistics(from, to);
1742                 int const words = buffer_.wordCount();
1743                 int const chars = buffer_.charCount(false);
1744                 int const chars_blanks = buffer_.charCount(true);
1745                 docstring message;
1746                 if (cur.selection())
1747                         message = _("Statistics for the selection:");
1748                 else
1749                         message = _("Statistics for the document:");
1750                 message += "\n\n";
1751                 if (words != 1)
1752                         message += bformat(_("%1$d words"), words);
1753                 else
1754                         message += _("One word");
1755                 message += "\n";
1756                 if (chars_blanks != 1)
1757                         message += bformat(_("%1$d characters (including blanks)"),
1758                                           chars_blanks);
1759                 else
1760                         message += _("One character (including blanks)");
1761                 message += "\n";
1762                 if (chars != 1)
1763                         message += bformat(_("%1$d characters (excluding blanks)"),
1764                                           chars);
1765                 else
1766                         message += _("One character (excluding blanks)");
1767
1768                 Alert::information(_("Statistics"), message);
1769         }
1770                 break;
1771
1772         case LFUN_SCREEN_UP:
1773         case LFUN_SCREEN_DOWN: {
1774                 Point p = getPos(cur);
1775                 // This code has been commented out to enable to scroll down a
1776                 // document, even if there are large insets in it (see bug #5465).
1777                 /*if (p.y_ < 0 || p.y_ > height_) {
1778                         // The cursor is off-screen so recenter before proceeding.
1779                         showCursor();
1780                         p = getPos(cur);
1781                 }*/
1782                 int const scrolled = scroll(act == LFUN_SCREEN_UP
1783                         ? -height_ : height_);
1784                 if (act == LFUN_SCREEN_UP && scrolled > -height_)
1785                         p = Point(0, 0);
1786                 if (act == LFUN_SCREEN_DOWN && scrolled < height_)
1787                         p = Point(width_, height_);
1788                 bool const in_texted = cur.inTexted();
1789                 cur.setCursor(doc_iterator_begin(cur.buffer()));
1790                 cur.selHandle(false);
1791                 // Force an immediate computation of metrics because we need it below
1792                 processUpdateFlags(Update::Force);
1793
1794                 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_,
1795                         true, act == LFUN_SCREEN_UP);
1796                 //FIXME: what to do with cur.x_target()?
1797                 bool update = in_texted && cur.bv().checkDepm(cur, old);
1798                 cur.finishUndo();
1799
1800                 if (update || cur.mark())
1801                         dr.screenUpdate(Update::Force | Update::FitCursor);
1802                 if (update)
1803                         dr.forceBufferUpdate();
1804                 break;
1805         }
1806
1807         case LFUN_SCROLL: {
1808                 string const scroll_type = cmd.getArg(0);
1809                 int scroll_step = 0;
1810                 if (scroll_type == "line")
1811                         scroll_step = d->scrollbarParameters_.single_step;
1812                 else if (scroll_type == "page")
1813                         scroll_step = d->scrollbarParameters_.page_step;
1814                 else
1815                         return;
1816                 string const scroll_quantity = cmd.getArg(1);
1817                 if (scroll_quantity == "up")
1818                         scrollUp(scroll_step);
1819                 else if (scroll_quantity == "down")
1820                         scrollDown(scroll_step);
1821                 else {
1822                         int const scroll_value = convert<int>(scroll_quantity);
1823                         if (scroll_value)
1824                                 scroll(scroll_step * scroll_value);
1825                 }
1826                 dr.screenUpdate(Update::ForceDraw);
1827                 dr.forceBufferUpdate();
1828                 break;
1829         }
1830
1831         case LFUN_SCREEN_UP_SELECT: {
1832                 // FIXME: why is the algorithm different from LFUN_SCREEN_UP?
1833                 cur.selHandle(true);
1834                 if (isTopScreen()) {
1835                         lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1836                         cur.finishUndo();
1837                         break;
1838                 }
1839                 int y = getPos(cur).y_;
1840                 int const ymin = y - height_ + defaultRowHeight();
1841                 while (y > ymin && cur.up())
1842                         y = getPos(cur).y_;
1843
1844                 cur.finishUndo();
1845                 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1846                 break;
1847         }
1848
1849         case LFUN_SCREEN_DOWN_SELECT: {
1850                 // FIXME: why is the algorithm different from LFUN_SCREEN_DOWN?
1851                 cur.selHandle(true);
1852                 if (isBottomScreen()) {
1853                         lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1854                         cur.finishUndo();
1855                         break;
1856                 }
1857                 int y = getPos(cur).y_;
1858                 int const ymax = y + height_ - defaultRowHeight();
1859                 while (y < ymax && cur.down())
1860                         y = getPos(cur).y_;
1861
1862                 cur.finishUndo();
1863                 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1864                 break;
1865         }
1866
1867
1868         case LFUN_INSET_SELECT_ALL: {
1869                 // true if all cells are selected
1870                 bool const all_selected = cur.depth() > 1
1871                     && cur.selBegin().at_begin()
1872                     && cur.selEnd().at_end();
1873                 // true if some cells are selected
1874                 bool const cells_selected = cur.depth() > 1
1875                     && cur.selBegin().at_cell_begin()
1876                         && cur.selEnd().at_cell_end();
1877                 if (all_selected || (cells_selected && !cur.inset().isTable())) {
1878                         // All the contents of the inset if selected, or only at
1879                         // least one cell but inset is not a table.
1880                         // Select the inset from outside.
1881                         cur.pop();
1882                         cur.resetAnchor();
1883                         cur.selection(true);
1884                         cur.posForward();
1885                 } else if (cells_selected) {
1886                         // At least one complete cell is selected and inset is a table.
1887                         // Select all cells
1888                         cur.idx() = 0;
1889                         cur.pos() = 0;
1890                         cur.resetAnchor();
1891                         cur.selection(true);
1892                         cur.idx() = cur.lastidx();
1893                         cur.pos() = cur.lastpos();
1894                 } else {
1895                         // select current cell
1896                         cur.pit() = 0;
1897                         cur.pos() = 0;
1898                         cur.resetAnchor();
1899                         cur.selection(true);
1900                         cur.pit() = cur.lastpit();
1901                         cur.pos() = cur.lastpos();
1902                 }
1903                 cur.setCurrentFont();
1904                 dr.screenUpdate(Update::Force);
1905                 break;
1906         }
1907
1908
1909         case LFUN_UNICODE_INSERT: {
1910                 if (cmd.argument().empty())
1911                         break;
1912
1913                 FuncCode code = cur.inset().currentMode() == Inset::MATH_MODE ?
1914                         LFUN_MATH_INSERT : LFUN_SELF_INSERT;
1915                 int i = 0;
1916                 while (true) {
1917                         docstring const arg = from_utf8(cmd.getArg(i));
1918                         if (arg.empty())
1919                                 break;
1920                         if (!isHex(arg)) {
1921                                 LYXERR0("Not a hexstring: " << arg);
1922                                 ++i;
1923                                 continue;
1924                         }
1925                         char_type c = hexToInt(arg);
1926                         if (c >= 32 && c < 0x10ffff) {
1927                                 LYXERR(Debug::KEY, "Inserting c: " << c);
1928                                 lyx::dispatch(FuncRequest(code, docstring(1, c)));
1929                         }
1930                         ++i;
1931                 }
1932                 break;
1933         }
1934
1935
1936         // This would be in Buffer class if only Cursor did not
1937         // require a bufferview
1938         case LFUN_INSET_FORALL: {
1939                 docstring const name = from_utf8(cmd.getArg(0));
1940                 string const commandstr = cmd.getLongArg(1);
1941                 FuncRequest const fr = lyxaction.lookupFunc(commandstr);
1942
1943                 // an arbitrary number to limit number of iterations
1944                 const int max_iter = 100000;
1945                 int iterations = 0;
1946                 Cursor & cur = d->cursor_;
1947                 Cursor const savecur = cur;
1948                 cur.reset();
1949                 if (!cur.nextInset())
1950                         cur.forwardInset();
1951                 cur.beginUndoGroup();
1952                 while(cur && iterations < max_iter) {
1953                         Inset * const ins = cur.nextInset();
1954                         if (!ins)
1955                                 break;
1956                         docstring insname = ins->layoutName();
1957                         while (!insname.empty()) {
1958                                 if (insname == name || name == from_utf8("*")) {
1959                                         cur.recordUndo();
1960                                         lyx::dispatch(fr, dr);
1961                                         ++iterations;
1962                                         break;
1963                                 }
1964                                 size_t const i = insname.rfind(':');
1965                                 if (i == string::npos)
1966                                         break;
1967                                 insname = insname.substr(0, i);
1968                         }
1969                         // if we did not delete the inset, skip it
1970                         if (!cur.nextInset() || cur.nextInset() == ins)
1971                                 cur.forwardInset();
1972                 }
1973                 cur = savecur;
1974                 cur.fixIfBroken();
1975                 /** This is a dummy undo record only to remember the cursor
1976                  * that has just been set; this will be used on a redo action
1977                  * (see ticket #10097)
1978
1979                  * FIXME: a better fix would be to have a way to set the
1980                  * cursor value directly, but I am not sure it is worth it.
1981                  */
1982                 cur.recordUndo();
1983                 cur.endUndoGroup();
1984                 dr.screenUpdate(Update::Force);
1985                 dr.forceBufferUpdate();
1986
1987                 if (iterations >= max_iter) {
1988                         dr.setError(true);
1989                         dr.setMessage(bformat(_("`inset-forall' interrupted because number of actions is larger than %1$d"), max_iter));
1990                 } else
1991                         dr.setMessage(bformat(_("Applied \"%1$s\" to %2$d insets"), from_utf8(commandstr), iterations));
1992                 break;
1993         }
1994
1995
1996         case LFUN_BRANCH_ADD_INSERT: {
1997                 docstring branch_name = from_utf8(cmd.getArg(0));
1998                 if (branch_name.empty())
1999                         if (!Alert::askForText(branch_name, _("Branch name")) ||
2000                                                 branch_name.empty())
2001                                 break;
2002
2003                 DispatchResult drtmp;
2004                 buffer_.dispatch(FuncRequest(LFUN_BRANCH_ADD, branch_name), drtmp);
2005                 if (drtmp.error()) {
2006                         Alert::warning(_("Branch already exists"), drtmp.message());
2007                         break;
2008                 }
2009                 BranchList & branch_list = buffer_.params().branchlist();
2010                 vector<docstring> const branches =
2011                         getVectorFromString(branch_name, branch_list.separator());
2012                 for (vector<docstring>::const_iterator it = branches.begin();
2013                      it != branches.end(); ++it) {
2014                         branch_name = *it;
2015                         lyx::dispatch(FuncRequest(LFUN_BRANCH_INSERT, branch_name));
2016                 }
2017                 break;
2018         }
2019
2020         case LFUN_KEYMAP_OFF:
2021                 getIntl().keyMapOn(false);
2022                 break;
2023
2024         case LFUN_KEYMAP_PRIMARY:
2025                 getIntl().keyMapPrim();
2026                 break;
2027
2028         case LFUN_KEYMAP_SECONDARY:
2029                 getIntl().keyMapSec();
2030                 break;
2031
2032         case LFUN_KEYMAP_TOGGLE:
2033                 getIntl().toggleKeyMap();
2034                 break;
2035
2036         case LFUN_DIALOG_SHOW_NEW_INSET: {
2037                 string const name = cmd.getArg(0);
2038                 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
2039                 if (decodeInsetParam(name, data, buffer_))
2040                         lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
2041                 else
2042                         lyxerr << "Inset type '" << name <<
2043                         "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" <<  endl;
2044                 break;
2045         }
2046
2047         case LFUN_CITATION_INSERT: {
2048                 if (argument.empty()) {
2049                         lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
2050                         break;
2051                 }
2052                 // we can have one optional argument, delimited by '|'
2053                 // citation-insert <key>|<text_before>
2054                 // this should be enhanced to also support text_after
2055                 // and citation style
2056                 string arg = argument;
2057                 string opt1;
2058                 if (contains(argument, "|")) {
2059                         arg = token(argument, '|', 0);
2060                         opt1 = token(argument, '|', 1);
2061                 }
2062
2063                 // if our cursor is directly in front of or behind a citation inset,
2064                 // we will instead add the new key to it.
2065                 Inset * inset = cur.nextInset();
2066                 if (!inset || inset->lyxCode() != CITE_CODE)
2067                         inset = cur.prevInset();
2068                 if (inset && inset->lyxCode() == CITE_CODE) {
2069                         InsetCitation * icite = static_cast<InsetCitation *>(inset);
2070                         if (icite->addKey(arg)) {
2071                                 dr.forceBufferUpdate();
2072                                 dr.screenUpdate(Update::FitCursor | Update::SinglePar);
2073                                 if (!opt1.empty())
2074                                         LYXERR0("Discarding optional argument to citation-insert.");
2075                         }
2076                         dispatched = true;
2077                         break;
2078                 }
2079                 InsetCommandParams icp(CITE_CODE);
2080                 icp["key"] = from_utf8(arg);
2081                 if (!opt1.empty())
2082                         icp["before"] = from_utf8(opt1);
2083                 icp["literal"] =
2084                         from_ascii(InsetCitation::last_literal ? "true" : "false");
2085                 string icstr = InsetCommand::params2string(icp);
2086                 FuncRequest fr(LFUN_INSET_INSERT, icstr);
2087                 lyx::dispatch(fr);
2088                 break;
2089         }
2090
2091         case LFUN_INSET_APPLY: {
2092                 string const name = cmd.getArg(0);
2093                 Inset * inset = editedInset(name);
2094                 if (!inset) {
2095                         FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
2096                         lyx::dispatch(fr);
2097                         break;
2098                 }
2099                 // put cursor in front of inset.
2100                 if (!setCursorFromInset(inset)) {
2101                         LASSERT(false, break);
2102                 }
2103                 cur.recordUndo();
2104                 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
2105                 inset->dispatch(cur, fr);
2106                 dr.screenUpdate(cur.result().screenUpdate());
2107                 if (cur.result().needBufferUpdate())
2108                         dr.forceBufferUpdate();
2109                 break;
2110         }
2111
2112         // FIXME:
2113         // The change of language of buffer belongs to the Buffer class.
2114         // We have to do it here because we need a cursor for Undo.
2115         // When Undo::recordUndoBufferParams() is implemented someday
2116         // LFUN_BUFFER_LANGUAGE should be handled by the Buffer class.
2117         case LFUN_BUFFER_LANGUAGE: {
2118                 Language const * oldL = buffer_.params().language;
2119                 Language const * newL = languages.getLanguage(argument);
2120                 if (!newL || oldL == newL)
2121                         break;
2122                 if (oldL->rightToLeft() == newL->rightToLeft()) {
2123                         cur.recordUndoFullBuffer();
2124                         buffer_.changeLanguage(oldL, newL);
2125                         cur.setCurrentFont();
2126                         dr.forceBufferUpdate();
2127                 }
2128                 break;
2129         }
2130
2131         case LFUN_FILE_INSERT_PLAINTEXT_PARA:
2132         case LFUN_FILE_INSERT_PLAINTEXT: {
2133                 bool const as_paragraph = (act == LFUN_FILE_INSERT_PLAINTEXT_PARA);
2134                 string const fname = to_utf8(cmd.argument());
2135                 if (!FileName::isAbsolute(fname))
2136                         dr.setMessage(_("Absolute filename expected."));
2137                 else
2138                         insertPlaintextFile(FileName(fname), as_paragraph);
2139                 break;
2140         }
2141
2142         default:
2143                 // OK, so try the Buffer itself...
2144                 buffer_.dispatch(cmd, dr);
2145                 dispatched = dr.dispatched();
2146                 break;
2147         }
2148
2149         buffer_.undo().endUndoGroup();
2150         dr.dispatched(dispatched);
2151
2152         // NOTE: The code below is copied from Cursor::dispatch. If you
2153         // need to modify this, please update the other one too.
2154
2155         // notify insets we just entered/left
2156         if (cursor() != old) {
2157                 old.beginUndoGroup();
2158                 old.fixIfBroken();
2159                 bool badcursor = notifyCursorLeavesOrEnters(old, cursor());
2160                 if (badcursor) {
2161                         cursor().fixIfBroken();
2162                         resetInlineCompletionPos();
2163                 }
2164                 old.endUndoGroup();
2165         }
2166 }
2167
2168
2169 docstring const BufferView::requestSelection()
2170 {
2171         Cursor & cur = d->cursor_;
2172
2173         LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
2174         if (!cur.selection()) {
2175                 d->xsel_cache_.set = false;
2176                 return docstring();
2177         }
2178
2179         LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
2180         if (!d->xsel_cache_.set ||
2181             cur.top() != d->xsel_cache_.cursor ||
2182             cur.realAnchor().top() != d->xsel_cache_.anchor)
2183         {
2184                 d->xsel_cache_.cursor = cur.top();
2185                 d->xsel_cache_.anchor = cur.realAnchor().top();
2186                 d->xsel_cache_.set = cur.selection();
2187                 return cur.selectionAsString(false);
2188         }
2189         return docstring();
2190 }
2191
2192
2193 void BufferView::clearSelection()
2194 {
2195         d->cursor_.clearSelection();
2196         // Clear the selection buffer. Otherwise a subsequent
2197         // middle-mouse-button paste would use the selection buffer,
2198         // not the more current external selection.
2199         cap::clearSelection();
2200         d->xsel_cache_.set = false;
2201         // The buffer did not really change, but this causes the
2202         // redraw we need because we cleared the selection above.
2203         buffer_.changed(false);
2204 }
2205
2206
2207 void BufferView::resize(int width, int height)
2208 {
2209         // Update from work area
2210         width_ = width;
2211         height_ = height;
2212
2213         // Clear the paragraph height cache.
2214         d->par_height_.clear();
2215         // Redo the metrics.
2216         updateMetrics();
2217 }
2218
2219
2220 Inset const * BufferView::getCoveringInset(Text const & text,
2221                 int x, int y) const
2222 {
2223         TextMetrics & tm = d->text_metrics_[&text];
2224         Inset * inset = tm.checkInsetHit(x, y);
2225         if (!inset)
2226                 return 0;
2227
2228         if (!inset->descendable(*this))
2229                 // No need to go further down if the inset is not
2230                 // descendable.
2231                 return inset;
2232
2233         size_t cell_number = inset->nargs();
2234         // Check all the inner cell.
2235         for (size_t i = 0; i != cell_number; ++i) {
2236                 Text const * inner_text = inset->getText(i);
2237                 if (inner_text) {
2238                         // Try deeper.
2239                         Inset const * inset_deeper =
2240                                 getCoveringInset(*inner_text, x, y);
2241                         if (inset_deeper)
2242                                 return inset_deeper;
2243                 }
2244         }
2245
2246         return inset;
2247 }
2248
2249
2250 void BufferView::updateHoveredInset() const
2251 {
2252         // Get inset under mouse, if there is one.
2253         int const x = d->mouse_position_cache_.x_;
2254         int const y = d->mouse_position_cache_.y_;
2255         Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
2256
2257         d->clickable_inset_ = covering_inset && covering_inset->clickable(*this, x, y);
2258
2259         if (covering_inset == d->last_inset_)
2260                 // Same inset, no need to do anything...
2261                 return;
2262
2263         bool need_redraw = false;
2264         if (d->last_inset_) {
2265                 // Remove the hint on the last hovered inset (if any).
2266                 need_redraw |= d->last_inset_->setMouseHover(this, false);
2267                 d->last_inset_ = 0;
2268         }
2269
2270         if (covering_inset && covering_inset->setMouseHover(this, true)) {
2271                 need_redraw = true;
2272                 // Only the insets that accept the hover state, do
2273                 // clear the last_inset_, so only set the last_inset_
2274                 // member if the hovered setting is accepted.
2275                 d->last_inset_ = covering_inset;
2276         }
2277
2278         if (need_redraw) {
2279                 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
2280                                 << d->mouse_position_cache_.x_ << ", "
2281                                 << d->mouse_position_cache_.y_ << ")");
2282
2283                 d->update_strategy_ = DecorationUpdate;
2284
2285                 // This event (moving without mouse click) is not passed further.
2286                 // This should be changed if it is further utilized.
2287                 buffer_.changed(false);
2288         }
2289 }
2290
2291
2292 void BufferView::clearLastInset(Inset * inset) const
2293 {
2294         if (d->last_inset_ != inset) {
2295                 LYXERR0("Wrong last_inset!");
2296                 LATTEST(false);
2297         }
2298         d->last_inset_ = 0;
2299 }
2300
2301
2302 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
2303 {
2304         //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
2305
2306         // This is only called for mouse related events including
2307         // LFUN_FILE_OPEN generated by drag-and-drop.
2308         FuncRequest cmd = cmd0;
2309
2310         Cursor old = cursor();
2311         Cursor cur(*this);
2312         cur.push(buffer_.inset());
2313         cur.selection(d->cursor_.selection());
2314
2315         // Either the inset under the cursor or the
2316         // surrounding Text will handle this event.
2317
2318         // make sure we stay within the screen...
2319         cmd.set_y(min(max(cmd.y(), -1), height_));
2320
2321         d->mouse_position_cache_.x_ = cmd.x();
2322         d->mouse_position_cache_.y_ = cmd.y();
2323
2324         if (cmd.action() == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
2325                 updateHoveredInset();
2326                 return;
2327         }
2328
2329         // Build temporary cursor.
2330         Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x(), cmd.y());
2331         if (inset) {
2332                 // If inset is not editable, cur.pos() might point behind the
2333                 // inset (depending on cmd.x(), cmd.y()). This is needed for
2334                 // editing to fix bug 9628, but e.g. the context menu needs a
2335                 // cursor in front of the inset.
2336                 if ((inset->hasSettings() || !inset->contextMenuName().empty()
2337                      || inset->lyxCode() == SEPARATOR_CODE) &&
2338                     cur.nextInset() != inset && cur.prevInset() == inset)
2339                         cur.posBackward();
2340         } else if (cur.inTexted() && cur.pos()
2341                         && cur.paragraph().isEnvSeparator(cur.pos() - 1)) {
2342                 // Always place cursor in front of a separator inset.
2343                 cur.posBackward();
2344         }
2345
2346         // Put anchor at the same position.
2347         cur.resetAnchor();
2348
2349         cur.beginUndoGroup();
2350
2351         // Try to dispatch to an non-editable inset near this position
2352         // via the temp cursor. If the inset wishes to change the real
2353         // cursor it has to do so explicitly by using
2354         //  cur.bv().cursor() = cur;  (or similar)
2355         if (inset)
2356                 inset->dispatch(cur, cmd);
2357
2358         // Now dispatch to the temporary cursor. If the real cursor should
2359         // be modified, the inset's dispatch has to do so explicitly.
2360         if (!inset || !cur.result().dispatched())
2361                 cur.dispatch(cmd);
2362
2363         // Notify left insets
2364         if (cur != old) {
2365                 bool badcursor = old.fixIfBroken() | cur.fixIfBroken();
2366                 badcursor |= notifyCursorLeavesOrEnters(old, cur);
2367                 if (badcursor)
2368                         cursor().fixIfBroken();
2369         }
2370
2371         cur.endUndoGroup();
2372
2373         // Do we have a selection?
2374         theSelection().haveSelection(cursor().selection());
2375
2376         if (cur.needBufferUpdate()) {
2377                 cur.clearBufferUpdate();
2378                 buffer().updateBuffer();
2379         }
2380
2381         // If the command has been dispatched,
2382         if (cur.result().dispatched() || cur.result().screenUpdate())
2383                 processUpdateFlags(cur.result().screenUpdate());
2384 }
2385
2386
2387 int BufferView::minVisiblePart()
2388 {
2389         return 2 * defaultRowHeight();
2390 }
2391
2392
2393 int BufferView::scroll(int y)
2394 {
2395         if (y > 0)
2396                 return scrollDown(y);
2397         if (y < 0)
2398                 return scrollUp(-y);
2399         return 0;
2400 }
2401
2402
2403 int BufferView::scrollDown(int offset)
2404 {
2405         Text * text = &buffer_.text();
2406         TextMetrics & tm = d->text_metrics_[text];
2407         int const ymax = height_ + offset;
2408         while (true) {
2409                 pair<pit_type, ParagraphMetrics const *> last = tm.last();
2410                 int bottom_pos = last.second->position() + last.second->descent();
2411                 if (lyxrc.scroll_below_document)
2412                         bottom_pos += height_ - minVisiblePart();
2413                 if (last.first + 1 == int(text->paragraphs().size())) {
2414                         if (bottom_pos <= height_)
2415                                 return 0;
2416                         offset = min(offset, bottom_pos - height_);
2417                         break;
2418                 }
2419                 if (bottom_pos > ymax)
2420                         break;
2421                 tm.newParMetricsDown();
2422         }
2423         d->anchor_ypos_ -= offset;
2424         return -offset;
2425 }
2426
2427
2428 int BufferView::scrollUp(int offset)
2429 {
2430         Text * text = &buffer_.text();
2431         TextMetrics & tm = d->text_metrics_[text];
2432         int ymin = - offset;
2433         while (true) {
2434                 pair<pit_type, ParagraphMetrics const *> first = tm.first();
2435                 int top_pos = first.second->position() - first.second->ascent();
2436                 if (first.first == 0) {
2437                         if (top_pos >= 0)
2438                                 return 0;
2439                         offset = min(offset, - top_pos);
2440                         break;
2441                 }
2442                 if (top_pos < ymin)
2443                         break;
2444                 tm.newParMetricsUp();
2445         }
2446         d->anchor_ypos_ += offset;
2447         return offset;
2448 }
2449
2450
2451 bool BufferView::setCursorFromRow(int row)
2452 {
2453         TexRow::TextEntry start, end;
2454         tie(start,end) = buffer_.texrow().getEntriesFromRow(row);
2455         LYXERR(Debug::LATEX,
2456                "setCursorFromRow: for row " << row << ", TexRow has found "
2457                "start (id=" << start.id << ",pos=" << start.pos << "), "
2458                "end (id=" << end.id << ",pos=" << end.pos << ")");
2459         return setCursorFromEntries(start, end);
2460 }
2461
2462
2463 bool BufferView::setCursorFromEntries(TexRow::TextEntry start,
2464                                       TexRow::TextEntry end)
2465 {
2466         DocIterator dit_start, dit_end;
2467         tie(dit_start,dit_end) =
2468                 TexRow::getDocIteratorsFromEntries(start, end, buffer_);
2469         if (!dit_start)
2470                 return false;
2471         // Setting selection start
2472         d->cursor_.clearSelection();
2473         setCursor(dit_start);
2474         // Setting selection end
2475         if (dit_end) {
2476                 d->cursor_.resetAnchor();
2477                 setCursorSelectionTo(dit_end);
2478         }
2479         return true;
2480 }
2481
2482
2483 bool BufferView::setCursorFromInset(Inset const * inset)
2484 {
2485         // are we already there?
2486         if (cursor().nextInset() == inset)
2487                 return true;
2488
2489         // Inset is not at cursor position. Find it in the document.
2490         Cursor cur(*this);
2491         cur.reset();
2492         while (cur && cur.nextInset() != inset)
2493                 cur.forwardInset();
2494
2495         if (cur) {
2496                 setCursor(cur);
2497                 return true;
2498         }
2499         return false;
2500 }
2501
2502
2503 void BufferView::gotoLabel(docstring const & label)
2504 {
2505         ListOfBuffers bufs = buffer().allRelatives();
2506         ListOfBuffers::iterator it = bufs.begin();
2507         for (; it != bufs.end(); ++it) {
2508                 Buffer const * buf = *it;
2509
2510                 // find label
2511                 shared_ptr<Toc> toc = buf->tocBackend().toc("label");
2512                 Toc::const_iterator toc_it = toc->begin();
2513                 Toc::const_iterator end = toc->end();
2514                 for (; toc_it != end; ++toc_it) {
2515                         if (label == toc_it->str()) {
2516                                 lyx::dispatch(toc_it->action());
2517                                 return;
2518                         }
2519                 }
2520         }
2521 }
2522
2523
2524 TextMetrics const & BufferView::textMetrics(Text const * t) const
2525 {
2526         return const_cast<BufferView *>(this)->textMetrics(t);
2527 }
2528
2529
2530 TextMetrics & BufferView::textMetrics(Text const * t)
2531 {
2532         LBUFERR(t);
2533         TextMetricsCache::iterator tmc_it  = d->text_metrics_.find(t);
2534         if (tmc_it == d->text_metrics_.end()) {
2535                 tmc_it = d->text_metrics_.insert(
2536                         make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
2537         }
2538         return tmc_it->second;
2539 }
2540
2541
2542 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
2543                 pit_type pit) const
2544 {
2545         return textMetrics(t).parMetrics(pit);
2546 }
2547
2548
2549 int BufferView::workHeight() const
2550 {
2551         return height_;
2552 }
2553
2554
2555 void BufferView::setCursor(DocIterator const & dit)
2556 {
2557         d->cursor_.reset();
2558         size_t const n = dit.depth();
2559         for (size_t i = 0; i < n; ++i)
2560                 dit[i].inset().edit(d->cursor_, true);
2561
2562         d->cursor_.setCursor(dit);
2563         d->cursor_.selection(false);
2564         d->cursor_.setCurrentFont();
2565         // FIXME
2566         // It seems on general grounds as if this is probably needed, but
2567         // it is not yet clear.
2568         // See bug #7394 and r38388.
2569         // d->cursor.resetAnchor();
2570 }
2571
2572
2573 void BufferView::setCursorSelectionTo(DocIterator const & dit)
2574 {
2575         size_t const n = dit.depth();
2576         for (size_t i = 0; i < n; ++i)
2577                 dit[i].inset().edit(d->cursor_, true);
2578
2579         d->cursor_.selection(true);
2580         d->cursor_.setCursorSelectionTo(dit);
2581         d->cursor_.setCurrentFont();
2582 }
2583
2584
2585 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
2586 {
2587         // Would be wrong to delete anything if we have a selection.
2588         if (cur.selection())
2589                 return false;
2590
2591         bool need_anchor_change = false;
2592         bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
2593                 need_anchor_change);
2594
2595         if (need_anchor_change)
2596                 cur.resetAnchor();
2597
2598         if (!changed)
2599                 return false;
2600
2601         d->cursor_ = cur;
2602
2603         // we would rather not do this here, but it needs to be done before
2604         // the changed() signal is sent.
2605         buffer_.updateBuffer();
2606
2607         buffer_.changed(true);
2608         return true;
2609 }
2610
2611
2612 bool BufferView::mouseSetCursor(Cursor & cur, bool const select)
2613 {
2614         LASSERT(&cur.bv() == this, return false);
2615
2616         if (!select)
2617                 // this event will clear selection so we save selection for
2618                 // persistent selection
2619                 cap::saveSelection(cursor());
2620
2621         d->cursor_.macroModeClose();
2622         // If a macro has been finalized, the cursor might have been broken
2623         cur.fixIfBroken();
2624
2625         // Has the cursor just left the inset?
2626         bool const leftinset = (&d->cursor_.inset() != &cur.inset());
2627         if (leftinset)
2628                 d->cursor_.fixIfBroken();
2629
2630         // do the dEPM magic if needed
2631         // FIXME: (1) move this to InsetText::notifyCursorLeaves?
2632         // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
2633         // the leftinset bool would not be necessary (badcursor instead).
2634         bool update = leftinset;
2635
2636         if (select) {
2637                 d->cursor_.setSelection();
2638                 d->cursor_.setCursorSelectionTo(cur);
2639         } else {
2640                 if (d->cursor_.inTexted())
2641                         update |= checkDepm(cur, d->cursor_);
2642                 d->cursor_.resetAnchor();
2643                 d->cursor_.setCursor(cur);
2644                 d->cursor_.clearSelection();
2645         }
2646         d->cursor_.boundary(cur.boundary());
2647         d->cursor_.finishUndo();
2648         d->cursor_.setCurrentFont();
2649         if (update)
2650                 cur.forceBufferUpdate();
2651         return update;
2652 }
2653
2654
2655 void BufferView::putSelectionAt(DocIterator const & cur,
2656                                 int length, bool backwards)
2657 {
2658         d->cursor_.clearSelection();
2659
2660         setCursor(cur);
2661
2662         if (length) {
2663                 if (backwards) {
2664                         d->cursor_.pos() += length;
2665                         d->cursor_.setSelection(d->cursor_, -length);
2666                 } else
2667                         d->cursor_.setSelection(d->cursor_, length);
2668         }
2669 }
2670
2671
2672 bool BufferView::selectIfEmpty(DocIterator & cur)
2673 {
2674         if ((cur.inTexted() && !cur.paragraph().empty())
2675             || (cur.inMathed() && !cur.cell().empty()))
2676                 return false;
2677
2678         pit_type const beg_pit = cur.pit();
2679         if (beg_pit > 0) {
2680                 // The paragraph associated to this item isn't
2681                 // the first one, so it can be selected
2682                 cur.backwardPos();
2683         } else {
2684                 // We have to resort to select the space between the
2685                 // end of this item and the begin of the next one
2686                 cur.forwardPos();
2687         }
2688         if (cur.empty()) {
2689                 // If it is the only item in the document,
2690                 // nothing can be selected
2691                 return false;
2692         }
2693         pit_type const end_pit = cur.pit();
2694         pos_type const end_pos = cur.pos();
2695         d->cursor_.clearSelection();
2696         d->cursor_.reset();
2697         d->cursor_.setCursor(cur);
2698         d->cursor_.pit() = beg_pit;
2699         d->cursor_.pos() = 0;
2700         d->cursor_.selection(false);
2701         d->cursor_.resetAnchor();
2702         d->cursor_.pit() = end_pit;
2703         d->cursor_.pos() = end_pos;
2704         d->cursor_.setSelection();
2705         return true;
2706 }
2707
2708
2709 Cursor & BufferView::cursor()
2710 {
2711         return d->cursor_;
2712 }
2713
2714
2715 Cursor const & BufferView::cursor() const
2716 {
2717         return d->cursor_;
2718 }
2719
2720
2721 pit_type BufferView::anchor_ref() const
2722 {
2723         return d->anchor_pit_;
2724 }
2725
2726
2727 bool BufferView::singleParUpdate()
2728 {
2729         Text & buftext = buffer_.text();
2730         pit_type const bottom_pit = d->cursor_.bottom().pit();
2731         TextMetrics & tm = textMetrics(&buftext);
2732         int old_height = tm.parMetrics(bottom_pit).height();
2733
2734         // make sure inline completion pointer is ok
2735         if (d->inlineCompletionPos_.fixIfBroken())
2736                 d->inlineCompletionPos_ = DocIterator();
2737
2738         // In Single Paragraph mode, rebreak only
2739         // the (main text, not inset!) paragraph containing the cursor.
2740         // (if this paragraph contains insets etc., rebreaking will
2741         // recursively descend)
2742         tm.redoParagraph(bottom_pit);
2743         ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
2744         if (pm.height() != old_height)
2745                 // Paragraph height has changed so we cannot proceed to
2746                 // the singlePar optimisation.
2747                 return false;
2748
2749         tm.updatePosCache(bottom_pit);
2750
2751         LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
2752                 << " y2: " << pm.position() + pm.descent()
2753                 << " pit: " << bottom_pit
2754                 << " singlepar: 1");
2755         return true;
2756 }
2757
2758
2759 void BufferView::updateMetrics()
2760 {
2761         updateMetrics(d->update_flags_);
2762         d->update_strategy_ = FullScreenUpdate;
2763 }
2764
2765
2766 void BufferView::updateMetrics(Update::flags & update_flags)
2767 {
2768         if (height_ == 0 || width_ == 0)
2769                 return;
2770
2771         Text & buftext = buffer_.text();
2772         pit_type const npit = int(buftext.paragraphs().size());
2773
2774         // Clear out the position cache in case of full screen redraw,
2775         d->coord_cache_.clear();
2776
2777         // Clear out paragraph metrics to avoid having invalid metrics
2778         // in the cache from paragraphs not relayouted below
2779         // The complete text metrics will be redone.
2780         d->text_metrics_.clear();
2781
2782         TextMetrics & tm = textMetrics(&buftext);
2783
2784         // make sure inline completion pointer is ok
2785         if (d->inlineCompletionPos_.fixIfBroken())
2786                 d->inlineCompletionPos_ = DocIterator();
2787
2788         if (d->anchor_pit_ >= npit)
2789                 // The anchor pit must have been deleted...
2790                 d->anchor_pit_ = npit - 1;
2791
2792         // Rebreak anchor paragraph.
2793         tm.redoParagraph(d->anchor_pit_);
2794         ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
2795
2796         // position anchor
2797         if (d->anchor_pit_ == 0) {
2798                 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
2799
2800                 // Complete buffer visible? Then it's easy.
2801                 if (scrollRange == 0)
2802                         d->anchor_ypos_ = anchor_pm.ascent();
2803                 else {
2804                         // avoid empty space above the first row
2805                         d->anchor_ypos_ = min(d->anchor_ypos_, anchor_pm.ascent());
2806                 }
2807         }
2808         anchor_pm.setPosition(d->anchor_ypos_);
2809         tm.updatePosCache(d->anchor_pit_);
2810
2811         LYXERR(Debug::PAINTING, "metrics: "
2812                 << " anchor pit = " << d->anchor_pit_
2813                 << " anchor ypos = " << d->anchor_ypos_);
2814
2815         // Redo paragraphs above anchor if necessary.
2816         int y1 = d->anchor_ypos_ - anchor_pm.ascent();
2817         // We are now just above the anchor paragraph.
2818         pit_type pit1 = d->anchor_pit_ - 1;
2819         for (; pit1 >= 0 && y1 >= 0; --pit1) {
2820                 tm.redoParagraph(pit1);
2821                 ParagraphMetrics & pm = tm.par_metrics_[pit1];
2822                 y1 -= pm.descent();
2823                 // Save the paragraph position in the cache.
2824                 pm.setPosition(y1);
2825                 tm.updatePosCache(pit1);
2826                 y1 -= pm.ascent();
2827         }
2828
2829         // Redo paragraphs below the anchor if necessary.
2830         int y2 = d->anchor_ypos_ + anchor_pm.descent();
2831         // We are now just below the anchor paragraph.
2832         pit_type pit2 = d->anchor_pit_ + 1;
2833         for (; pit2 < npit && y2 <= height_; ++pit2) {
2834                 tm.redoParagraph(pit2);
2835                 ParagraphMetrics & pm = tm.par_metrics_[pit2];
2836                 y2 += pm.ascent();
2837                 // Save the paragraph position in the cache.
2838                 pm.setPosition(y2);
2839                 tm.updatePosCache(pit2);
2840                 y2 += pm.descent();
2841         }
2842
2843         LYXERR(Debug::PAINTING, "Metrics: "
2844                 << " anchor pit = " << d->anchor_pit_
2845                 << " anchor ypos = " << d->anchor_ypos_
2846                 << " y1 = " << y1
2847                 << " y2 = " << y2
2848                 << " pit1 = " << pit1
2849                 << " pit2 = " << pit2);
2850
2851         // metrics is done, full drawing is necessary now
2852         update_flags = (update_flags & ~Update::Force) | Update::ForceDraw;
2853
2854         // Now update the positions of insets in the cache.
2855         updatePosCache();
2856
2857         if (lyxerr.debugging(Debug::WORKAREA)) {
2858                 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
2859                 d->coord_cache_.dump();
2860         }
2861 }
2862
2863
2864 void BufferView::updatePosCache()
2865 {
2866         // this is the "nodraw" drawing stage: only set the positions of the
2867         // insets in metrics cache.
2868         frontend::NullPainter np;
2869         draw(np, false);
2870 }
2871
2872
2873 void BufferView::insertLyXFile(FileName const & fname)
2874 {
2875         LASSERT(d->cursor_.inTexted(), return);
2876
2877         // Get absolute path of file and add ".lyx"
2878         // to the filename if necessary
2879         FileName filename = fileSearch(string(), fname.absFileName(), "lyx");
2880
2881         docstring const disp_fn = makeDisplayPath(filename.absFileName());
2882         // emit message signal.
2883         message(bformat(_("Inserting document %1$s..."), disp_fn));
2884
2885         docstring res;
2886         Buffer buf(filename.absFileName(), false);
2887         if (buf.loadLyXFile() == Buffer::ReadSuccess) {
2888                 ErrorList & el = buffer_.errorList("Parse");
2889                 // Copy the inserted document error list into the current buffer one.
2890                 el = buf.errorList("Parse");
2891                 buffer_.undo().recordUndo(d->cursor_);
2892                 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
2893                                              buf.params().documentClassPtr(), el);
2894                 res = _("Document %1$s inserted.");
2895         } else {
2896                 res = _("Could not insert document %1$s");
2897         }
2898
2899         buffer_.changed(true);
2900         // emit message signal.
2901         message(bformat(res, disp_fn));
2902 }
2903
2904
2905 Point BufferView::coordOffset(DocIterator const & dit) const
2906 {
2907         int x = 0;
2908         int y = 0;
2909         int lastw = 0;
2910
2911         // Addup contribution of nested insets, from inside to outside,
2912         // keeping the outer paragraph for a special handling below
2913         for (size_t i = dit.depth() - 1; i >= 1; --i) {
2914                 CursorSlice const & sl = dit[i];
2915                 int xx = 0;
2916                 int yy = 0;
2917
2918                 // get relative position inside sl.inset()
2919                 sl.inset().cursorPos(*this, sl, dit.boundary() && (i + 1 == dit.depth()), xx, yy);
2920
2921                 // Make relative position inside of the edited inset relative to sl.inset()
2922                 x += xx;
2923                 y += yy;
2924
2925                 // In case of an RTL inset, the edited inset will be positioned to the left
2926                 // of xx:yy
2927                 if (sl.text()) {
2928                         bool boundary_i = dit.boundary() && i + 1 == dit.depth();
2929                         bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2930                         if (rtl)
2931                                 x -= lastw;
2932                 }
2933
2934                 // remember width for the case that sl.inset() is positioned in an RTL inset
2935                 lastw = sl.inset().dimension(*this).wid;
2936
2937                 //lyxerr << "Cursor::getPos, i: "
2938                 // << i << " x: " << xx << " y: " << y << endl;
2939         }
2940
2941         // Add contribution of initial rows of outermost paragraph
2942         CursorSlice const & sl = dit[0];
2943         TextMetrics const & tm = textMetrics(sl.text());
2944         ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2945
2946         LBUFERR(!pm.rows().empty());
2947         y -= pm.rows()[0].ascent();
2948 #if 1
2949         // FIXME: document this mess
2950         size_t rend;
2951         if (sl.pos() > 0 && dit.depth() == 1) {
2952                 int pos = sl.pos();
2953                 if (pos && dit.boundary())
2954                         --pos;
2955 //              lyxerr << "coordOffset: boundary:" << dit.boundary() << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
2956                 rend = pm.pos2row(pos);
2957         } else
2958                 rend = pm.pos2row(sl.pos());
2959 #else
2960         size_t rend = pm.pos2row(sl.pos());
2961 #endif
2962         for (size_t rit = 0; rit != rend; ++rit)
2963                 y += pm.rows()[rit].height();
2964         y += pm.rows()[rend].ascent();
2965
2966         TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
2967
2968         // Make relative position from the nested inset now bufferview absolute.
2969         int xx = bottom_tm.cursorX(dit.bottom(), dit.boundary() && dit.depth() == 1);
2970         x += xx;
2971
2972         // In the RTL case place the nested inset at the left of the cursor in
2973         // the outer paragraph
2974         bool boundary_1 = dit.boundary() && 1 == dit.depth();
2975         bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
2976         if (rtl)
2977                 x -= lastw;
2978
2979         return Point(x, y);
2980 }
2981
2982
2983 Point BufferView::getPos(DocIterator const & dit) const
2984 {
2985         if (!paragraphVisible(dit))
2986                 return Point(-1, -1);
2987
2988         CursorSlice const & bot = dit.bottom();
2989         TextMetrics const & tm = textMetrics(bot.text());
2990
2991         // offset from outer paragraph
2992         Point p = coordOffset(dit);
2993         p.y_ += tm.parMetrics(bot.pit()).position();
2994         return p;
2995 }
2996
2997
2998 bool BufferView::paragraphVisible(DocIterator const & dit) const
2999 {
3000         CursorSlice const & bot = dit.bottom();
3001         TextMetrics const & tm = textMetrics(bot.text());
3002
3003         return tm.contains(bot.pit());
3004 }
3005
3006
3007 void BufferView::setCaretAscentDescent(int asc, int des)
3008 {
3009         d->caret_ascent_ = asc;
3010         d->caret_descent_ = des;
3011 }
3012
3013
3014 void BufferView::caretPosAndHeight(Point & p, int & h) const
3015 {
3016         int asc, des;
3017         Cursor const & cur = cursor();
3018         if (cur.inMathed()) {
3019                 asc = d->caret_ascent_;
3020                 des = d->caret_descent_;
3021         } else {
3022                 Font const font = cur.real_current_font;
3023                 frontend::FontMetrics const & fm = theFontMetrics(font);
3024                 asc = fm.maxAscent();
3025                 des = fm.maxDescent();
3026         }
3027         h = asc + des;
3028         p = getPos(cur);
3029         p.y_ -= asc;
3030 }
3031
3032
3033 bool BufferView::cursorInView(Point const & p, int h) const
3034 {
3035         Cursor const & cur = cursor();
3036         // does the cursor touch the screen ?
3037         if (p.y_ + h < 0 || p.y_ >= workHeight() || !paragraphVisible(cur))
3038                 return false;
3039         return true;
3040 }
3041
3042
3043 int BufferView::horizScrollOffset() const
3044 {
3045         return d->horiz_scroll_offset_;
3046 }
3047
3048
3049 int BufferView::horizScrollOffset(Text const * text,
3050                                   pit_type pit, pos_type pos) const
3051 {
3052         // Is this a row that is currently scrolled?
3053         if (!d->current_row_slice_.empty()
3054             && &text->inset() == d->current_row_slice_.inset().asInsetText()
3055             && pit ==  d->current_row_slice_.pit()
3056             && pos ==  d->current_row_slice_.pos())
3057                 return d->horiz_scroll_offset_;
3058         return 0;
3059 }
3060
3061
3062 bool BufferView::hadHorizScrollOffset(Text const * text,
3063                                       pit_type pit, pos_type pos) const
3064 {
3065         return !d->last_row_slice_.empty()
3066                && &text->inset() == d->last_row_slice_.inset().asInsetText()
3067                && pit ==  d->last_row_slice_.pit()
3068                && pos ==  d->last_row_slice_.pos();
3069 }
3070
3071
3072 void BufferView::setCurrentRowSlice(CursorSlice const & rowSlice)
3073 {
3074         // nothing to do if the cursor was already on this row
3075         if (d->current_row_slice_ == rowSlice) {
3076                 d->last_row_slice_ = CursorSlice();
3077                 return;
3078         }
3079
3080         // if the (previous) current row was scrolled, we have to
3081         // remember it in order to repaint it next time.
3082         if (d->horiz_scroll_offset_ != 0)
3083                 d->last_row_slice_ = d->current_row_slice_;
3084         else
3085                 d->last_row_slice_ = CursorSlice();
3086
3087         // Since we changed row, the scroll offset is not valid anymore
3088         d->horiz_scroll_offset_ = 0;
3089         d->current_row_slice_ = rowSlice;
3090 }
3091
3092
3093 void BufferView::checkCursorScrollOffset()
3094 {
3095         CursorSlice rowSlice = d->cursor_.bottom();
3096         TextMetrics const & tm = textMetrics(rowSlice.text());
3097
3098         // Stop if metrics have not been computed yet, since it means
3099         // that there is nothing to do.
3100         if (!tm.contains(rowSlice.pit()))
3101                 return;
3102         ParagraphMetrics const & pm = tm.parMetrics(rowSlice.pit());
3103         Row const & row = pm.getRow(rowSlice.pos(),
3104                                     d->cursor_.boundary() && rowSlice == d->cursor_.top());
3105         rowSlice.pos() = row.pos();
3106
3107         // Set the row on which the cursor lives.
3108         setCurrentRowSlice(rowSlice);
3109
3110         // Current x position of the cursor in pixels
3111         int cur_x = getPos(d->cursor_).x_;
3112
3113         // Horizontal scroll offset of the cursor row in pixels
3114         int offset = d->horiz_scroll_offset_;
3115         int const MARGIN = 2 * theFontMetrics(d->cursor_.real_current_font).em()
3116                            + row.right_margin;
3117         if (row.right_x() <= workWidth() - row.right_margin) {
3118                 // Row is narrower than the work area, no offset needed.
3119                 offset = 0;
3120         } else {
3121                 if (cur_x - offset < MARGIN) {
3122                         // cursor would be too far right
3123                         offset = cur_x - MARGIN;
3124                 } else if (cur_x - offset > workWidth() - MARGIN) {
3125                         // cursor would be too far left
3126                         offset = cur_x - workWidth() + MARGIN;
3127                 }
3128                 // Correct the offset to make sure that we do not scroll too much
3129                 if (offset < 0)
3130                         offset = 0;
3131                 if (row.right_x() - offset < workWidth() - row.right_margin)
3132                         offset = row.right_x() - workWidth() + row.right_margin;
3133         }
3134
3135         //lyxerr << "cur_x=" << cur_x << ", offset=" << offset << ", row.wid=" << row.width() << ", margin=" << MARGIN << endl;
3136
3137         if (offset != d->horiz_scroll_offset_)
3138                 LYXERR(Debug::PAINTING, "Horiz. scroll offset changed from "
3139                        << d->horiz_scroll_offset_ << " to " << offset);
3140
3141         if (d->update_strategy_ == NoScreenUpdate
3142             && (offset != d->horiz_scroll_offset_
3143                 || !d->last_row_slice_.empty())) {
3144                 // FIXME: if one uses SingleParUpdate, then home/end
3145                 // will not work on long rows. Why?
3146                 d->update_strategy_ = FullScreenUpdate;
3147         }
3148
3149         d->horiz_scroll_offset_ = offset;
3150 }
3151
3152
3153 void BufferView::draw(frontend::Painter & pain, bool paint_caret)
3154 {
3155         if (height_ == 0 || width_ == 0)
3156                 return;
3157         LYXERR(Debug::PAINTING, (pain.isNull() ? "\t\t--- START NODRAW ---"
3158                                  : "\t\t*** START DRAWING ***"));
3159         Text & text = buffer_.text();
3160         TextMetrics const & tm = d->text_metrics_[&text];
3161         int const y = tm.first().second->position();
3162         PainterInfo pi(this, pain);
3163
3164         // Check whether the row where the cursor lives needs to be scrolled.
3165         // Update the drawing strategy if needed.
3166         checkCursorScrollOffset();
3167
3168         switch (d->update_strategy_) {
3169
3170         case NoScreenUpdate:
3171                 // no screen painting is actually needed. In nodraw stage
3172                 // however, the different coordinates of insets and paragraphs
3173                 // needs to be updated.
3174                 LYXERR(Debug::PAINTING, "Strategy: NoScreenUpdate");
3175                 pi.full_repaint = false;
3176                 if (pain.isNull()) {
3177                         pi.full_repaint = true;
3178                         tm.draw(pi, 0, y);
3179                 } else {
3180                         pi.full_repaint = false;
3181                         tm.draw(pi, 0, y);
3182                 }
3183                 break;
3184
3185         case SingleParUpdate:
3186                 pi.full_repaint = false;
3187                 LYXERR(Debug::PAINTING, "Strategy: SingleParUpdate");
3188                 // In general, only the current row of the outermost paragraph
3189                 // will be redrawn. Particular cases where selection spans
3190                 // multiple paragraph are correctly detected in TextMetrics.
3191                 tm.draw(pi, 0, y);
3192                 break;
3193
3194         case DecorationUpdate:
3195                 // FIXME: We should also distinguish DecorationUpdate to avoid text
3196                 // drawing if possible. This is not possible to do easily right now
3197                 // because of the single backing pixmap.
3198
3199         case FullScreenUpdate:
3200
3201                 LYXERR(Debug::PAINTING,
3202                        ((d->update_strategy_ == FullScreenUpdate)
3203                         ? "Strategy: FullScreenUpdate"
3204                         : "Strategy: DecorationUpdate"));
3205
3206                 // The whole screen, including insets, will be refreshed.
3207                 pi.full_repaint = true;
3208
3209                 // Clear background.
3210                 pain.fillRectangle(0, 0, width_, height_,
3211                         pi.backgroundColor(&buffer_.inset()));
3212
3213                 // Draw everything.
3214                 tm.draw(pi, 0, y);
3215
3216                 // and possibly grey out below
3217                 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3218                 int const y2 = lastpm.second->position() + lastpm.second->descent();
3219
3220                 if (y2 < height_) {
3221                         Color color = buffer().isInternal()
3222                                 ? Color_background : Color_bottomarea;
3223                         pain.fillRectangle(0, y2, width_, height_ - y2, color);
3224                 }
3225                 break;
3226         }
3227         LYXERR(Debug::PAINTING, (pain.isNull() ? "\t\t --- END NODRAW ---"
3228                                 : "\t\t *** END DRAWING ***"));
3229
3230         // The scrollbar needs an update.
3231         updateScrollbar();
3232
3233         // Normalize anchor for next time
3234         pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
3235         pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3236         for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
3237                 ParagraphMetrics const & pm = tm.parMetrics(pit);
3238                 if (pm.position() + pm.descent() > 0) {
3239                         if (d->anchor_pit_ != pit
3240                             || d->anchor_ypos_ != pm.position())
3241                                 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
3242                                        << "  anchor ypos = " << d->anchor_ypos_);
3243                         d->anchor_pit_ = pit;
3244                         d->anchor_ypos_ = pm.position();
3245                         break;
3246                 }
3247         }
3248         if (!pain.isNull()) {
3249                 // reset the update flags, everything has been done
3250                 d->update_flags_ = Update::None;
3251         }
3252
3253         // If a caret has to be painted, mark its text row as dirty to
3254         //make sure that it will be repainted on next redraw.
3255         /* FIXME: investigate whether this can be avoided when the cursor did not
3256          * move at all
3257          */
3258         if (paint_caret) {
3259                 Row const & caret_row = d->cursor_.textRow();
3260                 caret_row.changed(true);
3261         }
3262 }
3263
3264
3265 void BufferView::message(docstring const & msg)
3266 {
3267         if (d->gui_)
3268                 d->gui_->message(msg);
3269 }
3270
3271
3272 void BufferView::showDialog(string const & name)
3273 {
3274         if (d->gui_)
3275                 d->gui_->showDialog(name, string());
3276 }
3277
3278
3279 void BufferView::showDialog(string const & name,
3280         string const & data, Inset * inset)
3281 {
3282         if (d->gui_)
3283                 d->gui_->showDialog(name, data, inset);
3284 }
3285
3286
3287 void BufferView::updateDialog(string const & name, string const & data)
3288 {
3289         if (d->gui_)
3290                 d->gui_->updateDialog(name, data);
3291 }
3292
3293
3294 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
3295 {
3296         d->gui_ = gui;
3297 }
3298
3299
3300 // FIXME: Move this out of BufferView again
3301 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
3302 {
3303         if (!fname.isReadableFile()) {
3304                 docstring const error = from_ascii(strerror(errno));
3305                 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3306                 docstring const text =
3307                   bformat(_("Could not read the specified document\n"
3308                             "%1$s\ndue to the error: %2$s"), file, error);
3309                 Alert::error(_("Could not read file"), text);
3310                 return docstring();
3311         }
3312
3313         if (!fname.isReadableFile()) {
3314                 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3315                 docstring const text =
3316                   bformat(_("%1$s\n is not readable."), file);
3317                 Alert::error(_("Could not open file"), text);
3318                 return docstring();
3319         }
3320
3321         // FIXME UNICODE: We don't know the encoding of the file
3322         docstring file_content = fname.fileContents("UTF-8");
3323         if (file_content.empty()) {
3324                 Alert::error(_("Reading not UTF-8 encoded file"),
3325                              _("The file is not UTF-8 encoded.\n"
3326                                "It will be read as local 8Bit-encoded.\n"
3327                                "If this does not give the correct result\n"
3328                                "then please change the encoding of the file\n"
3329                                "to UTF-8 with a program other than LyX.\n"));
3330                 file_content = fname.fileContents("local8bit");
3331         }
3332
3333         return normalize_c(file_content);
3334 }
3335
3336
3337 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
3338 {
3339         docstring const tmpstr = contentsOfPlaintextFile(f);
3340
3341         if (tmpstr.empty())
3342                 return;
3343
3344         Cursor & cur = cursor();
3345         cap::replaceSelection(cur);
3346         buffer_.undo().recordUndo(cur);
3347         if (asParagraph)
3348                 cur.innerText()->insertStringAsParagraphs(cur, tmpstr, cur.current_font);
3349         else
3350                 cur.innerText()->insertStringAsLines(cur, tmpstr, cur.current_font);
3351
3352         buffer_.changed(true);
3353 }
3354
3355
3356 docstring const & BufferView::inlineCompletion() const
3357 {
3358         return d->inlineCompletion_;
3359 }
3360
3361
3362 size_t const & BufferView::inlineCompletionUniqueChars() const
3363 {
3364         return d->inlineCompletionUniqueChars_;
3365 }
3366
3367
3368 DocIterator const & BufferView::inlineCompletionPos() const
3369 {
3370         return d->inlineCompletionPos_;
3371 }
3372
3373
3374 void BufferView::resetInlineCompletionPos()
3375 {
3376         d->inlineCompletionPos_ = DocIterator();
3377 }
3378
3379
3380 bool samePar(DocIterator const & a, DocIterator const & b)
3381 {
3382         if (a.empty() && b.empty())
3383                 return true;
3384         if (a.empty() || b.empty())
3385                 return false;
3386         if (a.depth() != b.depth())
3387                 return false;
3388         return &a.innerParagraph() == &b.innerParagraph();
3389 }
3390
3391
3392 void BufferView::setInlineCompletion(Cursor const & cur, DocIterator const & pos,
3393         docstring const & completion, size_t uniqueChars)
3394 {
3395         uniqueChars = min(completion.size(), uniqueChars);
3396         bool changed = d->inlineCompletion_ != completion
3397                 || d->inlineCompletionUniqueChars_ != uniqueChars;
3398         bool singlePar = true;
3399         d->inlineCompletion_ = completion;
3400         d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
3401
3402         //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
3403
3404         // at new position?
3405         DocIterator const & old = d->inlineCompletionPos_;
3406         if (old != pos) {
3407                 //lyxerr << "inlineCompletionPos changed" << std::endl;
3408                 // old or pos are in another paragraph?
3409                 if ((!samePar(cur, pos) && !pos.empty())
3410                     || (!samePar(cur, old) && !old.empty())) {
3411                         singlePar = false;
3412                         //lyxerr << "different paragraph" << std::endl;
3413                 }
3414                 d->inlineCompletionPos_ = pos;
3415         }
3416
3417         // set update flags
3418         if (changed) {
3419                 if (singlePar && !(cur.result().screenUpdate() & Update::Force))
3420                         cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
3421                 else
3422                         cur.screenUpdateFlags(cur.result().screenUpdate() | Update::Force);
3423         }
3424 }
3425
3426
3427 bool BufferView::clickableInset() const
3428 {
3429         return d->clickable_inset_;
3430 }
3431
3432 } // namespace lyx