src/BufferView.cpp

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