src/BufferView.cpp

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