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