src/BufferView.cpp

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