src/BufferView.cpp

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