src/BufferView.cpp

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