src/BufferView.cpp

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