src/BufferView.cpp

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