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