src/BufferView.cpp

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