src/BufferView.cpp

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