src/BufferView.cpp

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