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