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