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