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