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::updateDocumentClass(DocumentClass const * const olddc)
 945 {
 946         message(_("Converting document to new document class..."));
 947
 948         StableDocIterator backcur(d->cursor_);
 949         ErrorList & el = buffer_.errorList("Class Switch");
 950         cap::switchBetweenClasses(
 951                         olddc, buffer_.params().documentClassPtr(),
 952                         static_cast<InsetText &>(buffer_.inset()), el);
 953
 954         setCursor(backcur.asDocIterator(&buffer_));
 955
 956         buffer_.errors("Class Switch");
 957 }
 958
 959 /** Return the change status at cursor position, taking in account the
 960  * status at each level of the document iterator (a table in a deleted
 961  * footnote is deleted).
 962  * When \param outer is true, the top slice is not looked at.
 963  */
 964 static Change::Type lookupChangeType(DocIterator const & dit, bool outer = false)
 965 {
 966         size_t const depth = dit.depth() - (outer ? 1 : 0);
 967
 968         for (size_t i = 0 ; i < depth ; ++i) {
 969                 CursorSlice const & slice = dit[i];
 970                 if (!slice.inset().inMathed()
 971                     && slice.pos() < slice.paragraph().size()) {
 972                         Change::Type const ch = slice.paragraph().lookupChange(slice.pos()).type;
 973                         if (ch != Change::UNCHANGED)
 974                                 return ch;
 975                 }
 976         }
 977         return Change::UNCHANGED;
 978 }
 979
 980
 981 bool BufferView::getStatus(FuncRequest const & cmd, FuncStatus & flag)
 982 {
 983         FuncCode const act = cmd.action();
 984
 985         // Can we use a readonly buffer?
 986         if (buffer_.isReadonly()
 987             && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
 988             && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
 989                 flag.message(from_utf8(N_("Document is read-only")));
 990                 flag.setEnabled(false);
 991                 return true;
 992         }
 993
 994         // Are we in a DELETED change-tracking region?
 995         if (lookupChangeType(d->cursor_, true) == Change::DELETED
 996             && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
 997             && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
 998                 flag.message(from_utf8(N_("This portion of the document is deleted.")));
 999                 flag.setEnabled(false);
1000                 return true;
1001         }
1002
1003         Cursor & cur = d->cursor_;
1004
1005         if (cur.getStatus(cmd, flag))
1006                 return true;
1007
1008         switch (act) {
1009
1010         // FIXME: This is a bit problematic because we don't check if this is
1011         // a document BufferView or not for these LFUNs. We probably have to
1012         // dispatch both to currentBufferView() and, if that fails,
1013         // to documentBufferView(); same as we do now for current Buffer and
1014         // document Buffer. Ideally those LFUN should go to Buffer as they
1015         // operate on the full Buffer and the cursor is only needed either for
1016         // an Undo record or to restore a cursor position. But we don't know
1017         // how to do that inside Buffer of course.
1018         case LFUN_BUFFER_PARAMS_APPLY:
1019         case LFUN_LAYOUT_MODULES_CLEAR:
1020         case LFUN_LAYOUT_MODULE_ADD:
1021         case LFUN_LAYOUT_RELOAD:
1022         case LFUN_TEXTCLASS_APPLY:
1023         case LFUN_TEXTCLASS_LOAD:
1024                 flag.setEnabled(!buffer_.isReadonly());
1025                 break;
1026
1027         case LFUN_UNDO:
1028                 // We do not use the LyXAction flag for readonly because Undo sets the
1029                 // buffer clean/dirty status by itself.
1030                 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasUndoStack());
1031                 break;
1032         case LFUN_REDO:
1033                 // We do not use the LyXAction flag for readonly because Redo sets the
1034                 // buffer clean/dirty status by itself.
1035                 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasRedoStack());
1036                 break;
1037         case LFUN_FILE_INSERT_PLAINTEXT_PARA:
1038         case LFUN_FILE_INSERT_PLAINTEXT: {
1039                 docstring const fname = cmd.argument();
1040                 if (!FileName::isAbsolute(to_utf8(fname))) {
1041                         flag.message(_("Absolute filename expected."));
1042                         return false;
1043                 }
1044                 flag.setEnabled(cur.inTexted());
1045                 break;
1046         }
1047         case LFUN_FILE_INSERT:
1048         case LFUN_BOOKMARK_SAVE:
1049                 // FIXME: Actually, these LFUNS should be moved to Text
1050                 flag.setEnabled(cur.inTexted());
1051                 break;
1052
1053         case LFUN_FONT_STATE:
1054         case LFUN_LABEL_INSERT:
1055         case LFUN_INFO_INSERT:
1056         case LFUN_PARAGRAPH_GOTO:
1057         case LFUN_NOTE_NEXT:
1058         case LFUN_REFERENCE_NEXT:
1059         case LFUN_WORD_FIND:
1060         case LFUN_WORD_FIND_FORWARD:
1061         case LFUN_WORD_FIND_BACKWARD:
1062         case LFUN_WORD_FINDADV:
1063         case LFUN_WORD_REPLACE:
1064         case LFUN_MARK_OFF:
1065         case LFUN_MARK_ON:
1066         case LFUN_MARK_TOGGLE:
1067         case LFUN_SCREEN_RECENTER:
1068         case LFUN_SCREEN_SHOW_CURSOR:
1069         case LFUN_BIBTEX_DATABASE_ADD:
1070         case LFUN_BIBTEX_DATABASE_DEL:
1071         case LFUN_STATISTICS:
1072         case LFUN_BRANCH_ADD_INSERT:
1073         case LFUN_KEYMAP_OFF:
1074         case LFUN_KEYMAP_PRIMARY:
1075         case LFUN_KEYMAP_SECONDARY:
1076         case LFUN_KEYMAP_TOGGLE:
1077                 flag.setEnabled(true);
1078                 break;
1079
1080         case LFUN_LABEL_GOTO: {
1081                 flag.setEnabled(!cmd.argument().empty()
1082                     || getInsetByCode<InsetRef>(cur, REF_CODE));
1083                 break;
1084         }
1085
1086         case LFUN_CHANGES_TRACK:
1087                 flag.setEnabled(true);
1088                 flag.setOnOff(buffer_.params().trackChanges);
1089                 break;
1090
1091         case LFUN_CHANGES_OUTPUT:
1092                 flag.setEnabled(true);
1093                 flag.setOnOff(buffer_.params().outputChanges);
1094                 break;
1095
1096         case LFUN_CHANGES_MERGE:
1097         case LFUN_CHANGE_NEXT:
1098         case LFUN_CHANGE_PREVIOUS:
1099         case LFUN_ALL_CHANGES_ACCEPT:
1100         case LFUN_ALL_CHANGES_REJECT:
1101                 // TODO: context-sensitive enabling of LFUNs
1102                 // In principle, these command should only be enabled if there
1103                 // is a change in the document. However, without proper
1104                 // optimizations, this will inevitably result in poor performance.
1105                 flag.setEnabled(true);
1106                 break;
1107
1108         case LFUN_BUFFER_TOGGLE_COMPRESSION: {
1109                 flag.setOnOff(buffer_.params().compressed);
1110                 break;
1111         }
1112
1113         case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC: {
1114                 flag.setOnOff(buffer_.params().output_sync);
1115                 break;
1116         }
1117
1118         case LFUN_SCREEN_UP:
1119         case LFUN_SCREEN_DOWN:
1120         case LFUN_SCROLL:
1121         case LFUN_SCREEN_UP_SELECT:
1122         case LFUN_SCREEN_DOWN_SELECT:
1123         case LFUN_INSET_FORALL:
1124                 flag.setEnabled(true);
1125                 break;
1126
1127         case LFUN_LAYOUT_TABULAR:
1128                 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
1129                 break;
1130
1131         case LFUN_LAYOUT:
1132                 flag.setEnabled(!cur.inset().forcePlainLayout(cur.idx()));
1133                 break;
1134
1135         case LFUN_LAYOUT_PARAGRAPH:
1136                 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
1137                 break;
1138
1139         case LFUN_DIALOG_SHOW_NEW_INSET:
1140                 // FIXME: this is wrong, but I do not understand the
1141                 // intent (JMarc)
1142                 if (cur.inset().lyxCode() == CAPTION_CODE)
1143                         return cur.inset().getStatus(cur, cmd, flag);
1144                 // FIXME we should consider passthru paragraphs too.
1145                 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1146                 break;
1147
1148         case LFUN_CITATION_INSERT: {
1149                 FuncRequest fr(LFUN_INSET_INSERT, "citation");
1150                 // FIXME: This could turn in a recursive hell.
1151                 // Shouldn't we use Buffer::getStatus() instead?
1152                 flag.setEnabled(lyx::getStatus(fr).enabled());
1153                 break;
1154         }
1155         case LFUN_INSET_APPLY: {
1156                 string const name = cmd.getArg(0);
1157                 Inset * inset = editedInset(name);
1158                 if (inset) {
1159                         FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1160                         if (!inset->getStatus(cur, fr, flag)) {
1161                                 // Every inset is supposed to handle this
1162                                 LASSERT(false, break);
1163                         }
1164                 } else {
1165                         FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1166                         flag = lyx::getStatus(fr);
1167                 }
1168                 break;
1169         }
1170
1171         // FIXME We do not really want this here, but at present we need to
1172         // handle their dispatch here, for reasons explained there, so we'll
1173         // handle this here, too, for consistency.
1174         case LFUN_BRANCH_ACTIVATE:
1175         case LFUN_BRANCH_DEACTIVATE: {
1176                 BranchList const & branchList = buffer().params().branchlist();
1177                 docstring const branchName = cmd.argument();
1178                 flag.setEnabled(!branchName.empty() && branchList.find(branchName));
1179                 break;
1180         }
1181
1182         default:
1183                 return false;
1184         }
1185
1186         return true;
1187 }
1188
1189
1190 Inset * BufferView::editedInset(string const & name) const
1191 {
1192         map<string, Inset *>::const_iterator it = d->edited_insets_.find(name);
1193         return it == d->edited_insets_.end() ? 0 : it->second;
1194 }
1195
1196
1197 void BufferView::editInset(string const & name, Inset * inset)
1198 {
1199         d->edited_insets_[name] = inset;
1200 }
1201
1202
1203 void BufferView::dispatch(FuncRequest const & cmd, DispatchResult & dr)
1204 {
1205         //lyxerr << [ cmd = " << cmd << "]" << endl;
1206
1207         // Make sure that the cached BufferView is correct.
1208         LYXERR(Debug::ACTION, " action[" << cmd.action() << ']'
1209                 << " arg[" << to_utf8(cmd.argument()) << ']'
1210                 << " x[" << cmd.x() << ']'
1211                 << " y[" << cmd.y() << ']'
1212                 << " button[" << cmd.button() << ']');
1213
1214         string const argument = to_utf8(cmd.argument());
1215         Cursor & cur = d->cursor_;
1216
1217         // Don't dispatch function that does not apply to internal buffers.
1218         if (buffer_.isInternal()
1219             && lyxaction.funcHasFlag(cmd.action(), LyXAction::NoInternal))
1220                 return;
1221
1222         // We'll set this back to false if need be.
1223         bool dispatched = true;
1224         buffer_.undo().beginUndoGroup();
1225
1226         FuncCode const act = cmd.action();
1227         switch (act) {
1228
1229         case LFUN_BUFFER_PARAMS_APPLY: {
1230                 DocumentClass const * const oldClass = buffer_.params().documentClassPtr();
1231                 cur.recordUndoFullDocument();
1232                 istringstream ss(to_utf8(cmd.argument()));
1233                 Lexer lex;
1234                 lex.setStream(ss);
1235                 int const unknown_tokens = buffer_.readHeader(lex);
1236                 if (unknown_tokens != 0) {
1237                         LYXERR0("Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1238                                                 << unknown_tokens << " unknown token"
1239                                                 << (unknown_tokens == 1 ? "" : "s"));
1240                 }
1241                 updateDocumentClass(oldClass);
1242
1243                 // We are most certainly here because of a change in the document
1244                 // It is then better to make sure that all dialogs are in sync with
1245                 // current document settings.
1246                 dr.screenUpdate(Update::Force | Update::FitCursor);
1247                 dr.forceBufferUpdate();
1248                 break;
1249         }
1250
1251         case LFUN_LAYOUT_MODULES_CLEAR: {
1252                 DocumentClass const * const oldClass =
1253                         buffer_.params().documentClassPtr();
1254                 cur.recordUndoFullDocument();
1255                 buffer_.params().clearLayoutModules();
1256                 buffer_.params().makeDocumentClass();
1257                 updateDocumentClass(oldClass);
1258                 dr.screenUpdate(Update::Force);
1259                 dr.forceBufferUpdate();
1260                 break;
1261         }
1262
1263         case LFUN_LAYOUT_MODULE_ADD: {
1264                 BufferParams const & params = buffer_.params();
1265                 if (!params.moduleCanBeAdded(argument)) {
1266                         LYXERR0("Module `" << argument <<
1267                                 "' cannot be added due to failed requirements or "
1268                                 "conflicts with installed modules.");
1269                         break;
1270                 }
1271                 DocumentClass const * const oldClass = params.documentClassPtr();
1272                 cur.recordUndoFullDocument();
1273                 buffer_.params().addLayoutModule(argument);
1274                 buffer_.params().makeDocumentClass();
1275                 updateDocumentClass(oldClass);
1276                 dr.screenUpdate(Update::Force);
1277                 dr.forceBufferUpdate();
1278                 break;
1279         }
1280
1281         case LFUN_TEXTCLASS_APPLY: {
1282                 // since this shortcircuits, the second call is made only if
1283                 // the first fails
1284                 bool const success =
1285                         LayoutFileList::get().load(argument, buffer_.temppath()) ||
1286                         LayoutFileList::get().load(argument, buffer_.filePath());
1287                 if (!success) {
1288                         docstring s = bformat(_("The document class `%1$s' "
1289                                                  "could not be loaded."), from_utf8(argument));
1290                         frontend::Alert::error(_("Could not load class"), s);
1291                         break;
1292                 }
1293
1294                 LayoutFile const * old_layout = buffer_.params().baseClass();
1295                 LayoutFile const * new_layout = &(LayoutFileList::get()[argument]);
1296
1297                 if (old_layout == new_layout)
1298                         // nothing to do
1299                         break;
1300
1301                 // Save the old, possibly modular, layout for use in conversion.
1302                 DocumentClass const * const oldDocClass =
1303                         buffer_.params().documentClassPtr();
1304                 cur.recordUndoFullDocument();
1305                 buffer_.params().setBaseClass(argument);
1306                 buffer_.params().makeDocumentClass();
1307                 updateDocumentClass(oldDocClass);
1308                 dr.screenUpdate(Update::Force);
1309                 dr.forceBufferUpdate();
1310                 break;
1311         }
1312
1313         case LFUN_TEXTCLASS_LOAD: {
1314                 // since this shortcircuits, the second call is made only if
1315                 // the first fails
1316                 bool const success =
1317                         LayoutFileList::get().load(argument, buffer_.temppath()) ||
1318                         LayoutFileList::get().load(argument, buffer_.filePath());
1319                 if (!success) {
1320                         docstring s = bformat(_("The document class `%1$s' "
1321                                                  "could not be loaded."), from_utf8(argument));
1322                         frontend::Alert::error(_("Could not load class"), s);
1323                 }
1324                 break;
1325         }
1326
1327         case LFUN_LAYOUT_RELOAD: {
1328                 DocumentClass const * const oldClass = buffer_.params().documentClassPtr();
1329                 LayoutFileIndex bc = buffer_.params().baseClassID();
1330                 LayoutFileList::get().reset(bc);
1331                 buffer_.params().setBaseClass(bc);
1332                 buffer_.params().makeDocumentClass();
1333                 updateDocumentClass(oldClass);
1334                 dr.screenUpdate(Update::Force);
1335                 dr.forceBufferUpdate();
1336                 break;
1337         }
1338
1339         case LFUN_UNDO:
1340                 dr.setMessage(_("Undo"));
1341                 cur.clearSelection();
1342                 if (!cur.textUndo())
1343                         dr.setMessage(_("No further undo information"));
1344                 else
1345                         dr.screenUpdate(Update::Force | Update::FitCursor);
1346                 dr.forceBufferUpdate();
1347                 break;
1348
1349         case LFUN_REDO:
1350                 dr.setMessage(_("Redo"));
1351                 cur.clearSelection();
1352                 if (!cur.textRedo())
1353                         dr.setMessage(_("No further redo information"));
1354                 else
1355                         dr.screenUpdate(Update::Force | Update::FitCursor);
1356                 dr.forceBufferUpdate();
1357                 break;
1358
1359         case LFUN_FONT_STATE:
1360                 dr.setMessage(cur.currentState());
1361                 break;
1362
1363         case LFUN_BOOKMARK_SAVE:
1364                 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1365                 break;
1366
1367         case LFUN_LABEL_GOTO: {
1368                 docstring label = cmd.argument();
1369                 if (label.empty()) {
1370                         InsetRef * inset =
1371                                 getInsetByCode<InsetRef>(cur, REF_CODE);
1372                         if (inset) {
1373                                 label = inset->getParam("reference");
1374                                 // persistent=false: use temp_bookmark
1375                                 saveBookmark(0);
1376                         }
1377                 }
1378                 if (!label.empty()) {
1379                         gotoLabel(label);
1380                         // at the moment, this is redundant, since gotoLabel will
1381                         // eventually call LFUN_PARAGRAPH_GOTO, but it seems best
1382                         // to have it here.
1383                         dr.screenUpdate(Update::Force | Update::FitCursor);
1384                 }
1385                 break;
1386         }
1387
1388         case LFUN_PARAGRAPH_GOTO: {
1389                 int const id = convert<int>(cmd.getArg(0));
1390                 int const pos = convert<int>(cmd.getArg(1));
1391                 int i = 0;
1392                 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1393                         b = theBufferList().next(b)) {
1394
1395                         DocIterator dit = b->getParFromID(id);
1396                         if (dit.atEnd()) {
1397                                 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1398                                 ++i;
1399                                 continue;
1400                         }
1401                         LYXERR(Debug::INFO, "Paragraph " << dit.paragraph().id()
1402                                 << " found in buffer `"
1403                                 << b->absFileName() << "'.");
1404
1405                         if (b == &buffer_) {
1406                                 // Set the cursor
1407                                 dit.pos() = pos;
1408                                 setCursor(dit);
1409                                 dr.screenUpdate(Update::Force | Update::FitCursor);
1410                         } else {
1411                                 // Switch to other buffer view and resend cmd
1412                                 lyx::dispatch(FuncRequest(
1413                                         LFUN_BUFFER_SWITCH, b->absFileName()));
1414                                 lyx::dispatch(cmd);
1415                         }
1416                         break;
1417                 }
1418                 break;
1419         }
1420
1421         case LFUN_NOTE_NEXT:
1422                 gotoInset(this, NOTE_CODE, false);
1423                 break;
1424
1425         case LFUN_REFERENCE_NEXT: {
1426                 vector<InsetCode> tmp;
1427                 tmp.push_back(LABEL_CODE);
1428                 tmp.push_back(REF_CODE);
1429                 gotoInset(this, tmp, true);
1430                 break;
1431         }
1432
1433         case LFUN_CHANGES_TRACK:
1434                 buffer_.params().trackChanges = !buffer_.params().trackChanges;
1435                 break;
1436
1437         case LFUN_CHANGES_OUTPUT:
1438                 buffer_.params().outputChanges = !buffer_.params().outputChanges;
1439                 if (buffer_.params().outputChanges) {
1440                         bool dvipost    = LaTeXFeatures::isAvailable("dvipost");
1441                         bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1442                                           LaTeXFeatures::isAvailable("xcolor");
1443
1444                         if (!dvipost && !xcolorulem) {
1445                                 Alert::warning(_("Changes not shown in LaTeX output"),
1446                                                _("Changes will not be highlighted in LaTeX output, "
1447                                                  "because neither dvipost nor xcolor/ulem are installed.\n"
1448                                                  "Please install these packages or redefine "
1449                                                  "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1450                         } else if (!xcolorulem) {
1451                                 Alert::warning(_("Changes not shown in LaTeX output"),
1452                                                _("Changes will not be highlighted in LaTeX output "
1453                                                  "when using pdflatex, because xcolor and ulem are not installed.\n"
1454                                                  "Please install both packages or redefine "
1455                                                  "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1456                         }
1457                 }
1458                 break;
1459
1460         case LFUN_CHANGE_NEXT:
1461                 findNextChange(this);
1462                 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1463                 dr.screenUpdate(Update::Force | Update::FitCursor);
1464                 break;
1465
1466         case LFUN_CHANGE_PREVIOUS:
1467                 findPreviousChange(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_CHANGES_MERGE:
1473                 if (findNextChange(this) || findPreviousChange(this)) {
1474                         dr.screenUpdate(Update::Force | Update::FitCursor);
1475                         dr.forceBufferUpdate();
1476                         showDialog("changes");
1477                 }
1478                 break;
1479
1480         case LFUN_ALL_CHANGES_ACCEPT:
1481                 // select complete document
1482                 cur.reset();
1483                 cur.selHandle(true);
1484                 buffer_.text().cursorBottom(cur);
1485                 // accept everything in a single step to support atomic undo
1486                 buffer_.text().acceptOrRejectChanges(cur, Text::ACCEPT);
1487                 cur.resetAnchor();
1488                 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1489                 dr.screenUpdate(Update::Force | Update::FitCursor);
1490                 dr.forceBufferUpdate();
1491                 break;
1492
1493         case LFUN_ALL_CHANGES_REJECT:
1494                 // select complete document
1495                 cur.reset();
1496                 cur.selHandle(true);
1497                 buffer_.text().cursorBottom(cur);
1498                 // reject everything in a single step to support atomic undo
1499                 // Note: reject does not work recursively; the user may have to repeat the operation
1500                 buffer_.text().acceptOrRejectChanges(cur, Text::REJECT);
1501                 cur.resetAnchor();
1502                 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1503                 dr.screenUpdate(Update::Force | Update::FitCursor);
1504                 dr.forceBufferUpdate();
1505                 break;
1506
1507         case LFUN_WORD_FIND_FORWARD:
1508         case LFUN_WORD_FIND_BACKWARD: {
1509                 static docstring last_search;
1510                 docstring searched_string;
1511
1512                 if (!cmd.argument().empty()) {
1513                         last_search = cmd.argument();
1514                         searched_string = cmd.argument();
1515                 } else {
1516                         searched_string = last_search;
1517                 }
1518
1519                 if (searched_string.empty())
1520                         break;
1521
1522                 bool const fw = act == LFUN_WORD_FIND_FORWARD;
1523                 docstring const data =
1524                         find2string(searched_string, true, false, fw);
1525                 bool found = lyxfind(this, FuncRequest(LFUN_WORD_FIND, data));
1526                 if (found)
1527                         dr.screenUpdate(Update::Force | Update::FitCursor);
1528                 break;
1529         }
1530
1531         case LFUN_WORD_FIND: {
1532                 FuncRequest req = cmd;
1533                 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1534                         req = d->search_request_cache_;
1535                 if (req.argument().empty()) {
1536                         lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, "findreplace"));
1537                         break;
1538                 }
1539                 if (lyxfind(this, req))
1540                         dr.screenUpdate(Update::Force | Update::FitCursor);
1541                 else
1542                         message(_("String not found!"));
1543                 d->search_request_cache_ = req;
1544                 break;
1545         }
1546
1547         case LFUN_WORD_REPLACE: {
1548                 bool has_deleted = false;
1549                 if (cur.selection()) {
1550                         DocIterator beg = cur.selectionBegin();
1551                         DocIterator end = cur.selectionEnd();
1552                         if (beg.pit() == end.pit()) {
1553                                 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1554                                         if (!cur.inMathed() && cur.paragraph().isDeleted(p)) {
1555                                                 has_deleted = true;
1556                                                 break;
1557                                         }
1558                                 }
1559                         }
1560                 }
1561                 if (lyxreplace(this, cmd, has_deleted)) {
1562                         dr.forceBufferUpdate();
1563                         dr.screenUpdate(Update::Force | Update::FitCursor);
1564                 }
1565                 break;
1566         }
1567
1568         case LFUN_WORD_FINDADV: {
1569                 FindAndReplaceOptions opt;
1570                 istringstream iss(to_utf8(cmd.argument()));
1571                 iss >> opt;
1572                 if (findAdv(this, opt)) {
1573                         dr.screenUpdate(Update::Force | Update::FitCursor);
1574                         cur.dispatched();
1575                         dispatched = true;
1576                 } else {
1577                         cur.undispatched();
1578                         dispatched = false;
1579                 }
1580                 break;
1581         }
1582
1583         case LFUN_MARK_OFF:
1584                 cur.clearSelection();
1585                 dr.setMessage(from_utf8(N_("Mark off")));
1586                 break;
1587
1588         case LFUN_MARK_ON:
1589                 cur.clearSelection();
1590                 cur.setMark(true);
1591                 dr.setMessage(from_utf8(N_("Mark on")));
1592                 break;
1593
1594         case LFUN_MARK_TOGGLE:
1595                 cur.setSelection(false);
1596                 if (cur.mark()) {
1597                         cur.setMark(false);
1598                         dr.setMessage(from_utf8(N_("Mark removed")));
1599                 } else {
1600                         cur.setMark(true);
1601                         dr.setMessage(from_utf8(N_("Mark set")));
1602                 }
1603                 cur.resetAnchor();
1604                 break;
1605
1606         case LFUN_SCREEN_SHOW_CURSOR:
1607                 showCursor();
1608                 break;
1609
1610         case LFUN_SCREEN_RECENTER:
1611                 recenter();
1612                 break;
1613
1614         case LFUN_BIBTEX_DATABASE_ADD: {
1615                 Cursor tmpcur = cur;
1616                 findInset(tmpcur, BIBTEX_CODE, false);
1617                 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1618                                                 BIBTEX_CODE);
1619                 if (inset) {
1620                         if (inset->addDatabase(cmd.argument())) {
1621                                 buffer_.invalidateBibfileCache();
1622                                 dr.forceBufferUpdate();
1623                         }
1624                 }
1625                 break;
1626         }
1627
1628         case LFUN_BIBTEX_DATABASE_DEL: {
1629                 Cursor tmpcur = cur;
1630                 findInset(tmpcur, BIBTEX_CODE, false);
1631                 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1632                                                 BIBTEX_CODE);
1633                 if (inset) {
1634                         if (inset->delDatabase(cmd.argument())) {
1635                                 buffer_.invalidateBibfileCache();
1636                                 dr.forceBufferUpdate();
1637                         }
1638                 }
1639                 break;
1640         }
1641
1642         case LFUN_STATISTICS: {
1643                 DocIterator from, to;
1644                 if (cur.selection()) {
1645                         from = cur.selectionBegin();
1646                         to = cur.selectionEnd();
1647                 } else {
1648                         from = doc_iterator_begin(&buffer_);
1649                         to = doc_iterator_end(&buffer_);
1650                 }
1651                 int const words = countWords(from, to);
1652                 int const chars = countChars(from, to, false);
1653                 int const chars_blanks = countChars(from, to, true);
1654                 docstring message;
1655                 if (cur.selection())
1656                         message = _("Statistics for the selection:");
1657                 else
1658                         message = _("Statistics for the document:");
1659                 message += "\n\n";
1660                 if (words != 1)
1661                         message += bformat(_("%1$d words"), words);
1662                 else
1663                         message += _("One word");
1664                 message += "\n";
1665                 if (chars_blanks != 1)
1666                         message += bformat(_("%1$d characters (including blanks)"),
1667                                           chars_blanks);
1668                 else
1669                         message += _("One character (including blanks)");
1670                 message += "\n";
1671                 if (chars != 1)
1672                         message += bformat(_("%1$d characters (excluding blanks)"),
1673                                           chars);
1674                 else
1675                         message += _("One character (excluding blanks)");
1676
1677                 Alert::information(_("Statistics"), message);
1678         }
1679                 break;
1680
1681         case LFUN_BUFFER_TOGGLE_COMPRESSION:
1682                 // turn compression on/off
1683                 buffer_.params().compressed = !buffer_.params().compressed;
1684                 break;
1685
1686         case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
1687                 buffer_.params().output_sync = !buffer_.params().output_sync;
1688                 break;
1689
1690         case LFUN_SCREEN_UP:
1691         case LFUN_SCREEN_DOWN: {
1692                 Point p = getPos(cur);
1693                 // This code has been commented out to enable to scroll down a
1694                 // document, even if there are large insets in it (see bug #5465).
1695                 /*if (p.y_ < 0 || p.y_ > height_) {
1696                         // The cursor is off-screen so recenter before proceeding.
1697                         showCursor();
1698                         p = getPos(cur);
1699                 }*/
1700                 int const scrolled = scroll(act == LFUN_SCREEN_UP
1701                         ? -height_ : height_);
1702                 if (act == LFUN_SCREEN_UP && scrolled > -height_)
1703                         p = Point(0, 0);
1704                 if (act == LFUN_SCREEN_DOWN && scrolled < height_)
1705                         p = Point(width_, height_);
1706                 Cursor old = cur;
1707                 bool const in_texted = cur.inTexted();
1708                 cur.setCursor(doc_iterator_begin(cur.buffer()));
1709                 cur.selHandle(false);
1710                 buffer_.changed(true);
1711                 updateHoveredInset();
1712
1713                 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_,
1714                         true, act == LFUN_SCREEN_UP);
1715                 //FIXME: what to do with cur.x_target()?
1716                 bool update = in_texted && cur.bv().checkDepm(cur, old);
1717                 cur.finishUndo();
1718
1719                 if (update || cur.mark())
1720                         dr.screenUpdate(Update::Force | Update::FitCursor);
1721                 if (update)
1722                         dr.forceBufferUpdate();
1723                 break;
1724         }
1725
1726         case LFUN_SCROLL: {
1727                 string const scroll_type = cmd.getArg(0);
1728                 int scroll_step = 0;
1729                 if (scroll_type == "line")
1730                         scroll_step = d->scrollbarParameters_.single_step;
1731                 else if (scroll_type == "page")
1732                         scroll_step = d->scrollbarParameters_.page_step;
1733                 else
1734                         return;
1735                 string const scroll_quantity = cmd.getArg(1);
1736                 if (scroll_quantity == "up")
1737                         scrollUp(scroll_step);
1738                 else if (scroll_quantity == "down")
1739                         scrollDown(scroll_step);
1740                 else {
1741                         int const scroll_value = convert<int>(scroll_quantity);
1742                         if (scroll_value)
1743                                 scroll(scroll_step * scroll_value);
1744                 }
1745                 buffer_.changed(true);
1746                 updateHoveredInset();
1747                 dr.forceBufferUpdate();
1748                 break;
1749         }
1750
1751         case LFUN_SCREEN_UP_SELECT: {
1752                 // FIXME: why is the algorithm different from LFUN_SCREEN_UP?
1753                 cur.selHandle(true);
1754                 if (isTopScreen()) {
1755                         lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1756                         cur.finishUndo();
1757                         break;
1758                 }
1759                 int y = getPos(cur).y_;
1760                 int const ymin = y - height_ + defaultRowHeight();
1761                 while (y > ymin && cur.up())
1762                         y = getPos(cur).y_;
1763
1764                 cur.finishUndo();
1765                 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1766                 break;
1767         }
1768
1769         case LFUN_SCREEN_DOWN_SELECT: {
1770                 // FIXME: why is the algorithm different from LFUN_SCREEN_DOWN?
1771                 cur.selHandle(true);
1772                 if (isBottomScreen()) {
1773                         lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1774                         cur.finishUndo();
1775                         break;
1776                 }
1777                 int y = getPos(cur).y_;
1778                 int const ymax = y + height_ - defaultRowHeight();
1779                 while (y < ymax && cur.down())
1780                         y = getPos(cur).y_;
1781
1782                 cur.finishUndo();
1783                 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1784                 break;
1785         }
1786
1787
1788         // This would be in Buffer class if only Cursor did not
1789         // require a bufferview
1790         case LFUN_INSET_FORALL: {
1791                 docstring const name = from_utf8(cmd.getArg(0));
1792                 string const commandstr = cmd.getLongArg(1);
1793                 FuncRequest const fr = lyxaction.lookupFunc(commandstr);
1794
1795                 // an arbitrary number to limit number of iterations
1796                 const int max_iter = 100000;
1797                 int iterations = 0;
1798                 Cursor & cur = d->cursor_;
1799                 Cursor const savecur = cur;
1800                 cur.reset();
1801                 if (!cur.nextInset())
1802                         cur.forwardInset();
1803                 cur.beginUndoGroup();
1804                 while(cur && iterations < max_iter) {
1805                         Inset * ins = cur.nextInset();
1806                         if (!ins)
1807                                 break;
1808                         docstring insname = ins->layoutName();
1809                         while (!insname.empty()) {
1810                                 if (insname == name || name == from_utf8("*")) {
1811                                         cur.recordUndo();
1812                                         lyx::dispatch(fr, dr);
1813                                         ++iterations;
1814                                         break;
1815                                 }
1816                                 size_t const i = insname.rfind(':');
1817                                 if (i == string::npos)
1818                                         break;
1819                                 insname = insname.substr(0, i);
1820                         }
1821                         cur.forwardInset();
1822                 }
1823                 cur.endUndoGroup();
1824                 cur = savecur;
1825                 cur.fixIfBroken();
1826                 dr.screenUpdate(Update::Force);
1827                 dr.forceBufferUpdate();
1828
1829                 if (iterations >= max_iter) {
1830                         dr.setError(true);
1831                         dr.setMessage(bformat(_("`inset-forall' interrupted because number of actions is larger than %1$d"), max_iter));
1832                 } else
1833                         dr.setMessage(bformat(_("Applied \"%1$s\" to %2$d insets"), from_utf8(commandstr), iterations));
1834                 break;
1835         }
1836
1837
1838         case LFUN_BRANCH_ADD_INSERT: {
1839                 docstring branch_name = from_utf8(cmd.getArg(0));
1840                 if (branch_name.empty())
1841                         if (!Alert::askForText(branch_name, _("Branch name")) ||
1842                                                 branch_name.empty())
1843                                 break;
1844
1845                 DispatchResult drtmp;
1846                 buffer_.dispatch(FuncRequest(LFUN_BRANCH_ADD, branch_name), drtmp);
1847                 if (drtmp.error()) {
1848                         Alert::warning(_("Branch already exists"), drtmp.message());
1849                         break;
1850                 }
1851                 BranchList & branch_list = buffer_.params().branchlist();
1852                 vector<docstring> const branches =
1853                         getVectorFromString(branch_name, branch_list.separator());
1854                 for (vector<docstring>::const_iterator it = branches.begin();
1855                      it != branches.end(); ++it) {
1856                         branch_name = *it;
1857                         lyx::dispatch(FuncRequest(LFUN_BRANCH_INSERT, branch_name));
1858                 }
1859                 break;
1860         }
1861
1862         case LFUN_KEYMAP_OFF:
1863                 getIntl().keyMapOn(false);
1864                 break;
1865
1866         case LFUN_KEYMAP_PRIMARY:
1867                 getIntl().keyMapPrim();
1868                 break;
1869
1870         case LFUN_KEYMAP_SECONDARY:
1871                 getIntl().keyMapSec();
1872                 break;
1873
1874         case LFUN_KEYMAP_TOGGLE:
1875                 getIntl().toggleKeyMap();
1876                 break;
1877
1878         case LFUN_DIALOG_SHOW_NEW_INSET: {
1879                 string const name = cmd.getArg(0);
1880                 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
1881                 if (decodeInsetParam(name, data, buffer_))
1882                         lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
1883                 else
1884                         lyxerr << "Inset type '" << name <<
1885                         "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" <<  endl;
1886                 break;
1887         }
1888
1889         case LFUN_CITATION_INSERT: {
1890                 if (argument.empty()) {
1891                         lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
1892                         break;
1893                 }
1894                 // we can have one optional argument, delimited by '|'
1895                 // citation-insert <key>|<text_before>
1896                 // this should be enhanced to also support text_after
1897                 // and citation style
1898                 string arg = argument;
1899                 string opt1;
1900                 if (contains(argument, "|")) {
1901                         arg = token(argument, '|', 0);
1902                         opt1 = token(argument, '|', 1);
1903                 }
1904                 InsetCommandParams icp(CITE_CODE);
1905                 icp["key"] = from_utf8(arg);
1906                 if (!opt1.empty())
1907                         icp["before"] = from_utf8(opt1);
1908                 string icstr = InsetCommand::params2string(icp);
1909                 FuncRequest fr(LFUN_INSET_INSERT, icstr);
1910                 lyx::dispatch(fr);
1911                 break;
1912         }
1913
1914         case LFUN_INSET_APPLY: {
1915                 string const name = cmd.getArg(0);
1916                 Inset * inset = editedInset(name);
1917                 if (!inset) {
1918                         FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1919                         lyx::dispatch(fr);
1920                         break;
1921                 }
1922                 // put cursor in front of inset.
1923                 if (!setCursorFromInset(inset)) {
1924                         LASSERT(false, break);
1925                 }
1926                 cur.recordUndo();
1927                 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1928                 inset->dispatch(cur, fr);
1929                 dr.screenUpdate(cur.result().screenUpdate());
1930                 if (cur.result().needBufferUpdate())
1931                         dr.forceBufferUpdate();
1932                 break;
1933         }
1934
1935         // FIXME:
1936         // The change of language of buffer belongs to the Buffer class.
1937         // We have to do it here because we need a cursor for Undo.
1938         // When Undo::recordUndoBufferParams() is implemented someday
1939         // LFUN_BUFFER_LANGUAGE should be handled by the Buffer class.
1940         case LFUN_BUFFER_LANGUAGE: {
1941                 Language const * oldL = buffer_.params().language;
1942                 Language const * newL = languages.getLanguage(argument);
1943                 if (!newL || oldL == newL)
1944                         break;
1945                 if (oldL->rightToLeft() == newL->rightToLeft()) {
1946                         cur.recordUndoFullDocument();
1947                         buffer_.changeLanguage(oldL, newL);
1948                         cur.setCurrentFont();
1949                         dr.forceBufferUpdate();
1950                 }
1951         }
1952
1953         case LFUN_FILE_INSERT_PLAINTEXT_PARA:
1954         case LFUN_FILE_INSERT_PLAINTEXT: {
1955                 bool const as_paragraph = (act == LFUN_FILE_INSERT_PLAINTEXT_PARA);
1956                 string const fname = to_utf8(cmd.argument());
1957                 if (!FileName::isAbsolute(fname))
1958                         dr.setMessage(_("Absolute filename expected."));
1959                 else
1960                         insertPlaintextFile(FileName(fname), as_paragraph);
1961                 break;
1962         }
1963
1964         // FIXME We do not really want this here, but it has to be at present
1965         // because we need a cursor for the recordUndoFullDocument call. What
1966         // we would really like is a recordUndoBufferParams call that did not
1967         // need a cursor, but we do not have that yet.
1968         // So, if this does get fixed, this code can be moved back to Buffer.cpp,
1969         // and the corresponding code in getStatus() should be moved back, too.
1970         case LFUN_BRANCH_ACTIVATE:
1971         case LFUN_BRANCH_DEACTIVATE: {
1972                 BranchList & branch_list = buffer().params().branchlist();
1973                 docstring const branch_name = cmd.argument();
1974                 // the case without a branch name is handled elsewhere
1975                 if (branch_name.empty()) {
1976                         dispatched = false;
1977                         break;
1978                 }
1979                 Branch * branch = branch_list.find(branch_name);
1980                 if (!branch) {
1981                         LYXERR0("Branch " << branch_name << " does not exist.");
1982                         dr.setError(true);
1983                         docstring const msg =
1984                                 bformat(_("Branch \"%1$s\" does not exist."), branch_name);
1985                         dr.setMessage(msg);
1986                         break;
1987                 }
1988                 bool activate = cmd.action() == LFUN_BRANCH_ACTIVATE;
1989                 if (branch->isSelected() != activate) {
1990                         branch->setSelected(activate);
1991                         cur.recordUndoFullDocument();
1992                         dr.setError(false);
1993                         dr.screenUpdate(Update::Force);
1994                         dr.forceBufferUpdate();
1995                 }
1996                 break;
1997         }
1998
1999         default:
2000                 // OK, so try the Buffer itself...
2001                 buffer_.dispatch(cmd, dr);
2002                 dispatched = dr.dispatched();
2003                 break;
2004         }
2005
2006         buffer_.undo().endUndoGroup();
2007         dr.dispatched(dispatched);
2008 }
2009
2010
2011 docstring const BufferView::requestSelection()
2012 {
2013         Cursor & cur = d->cursor_;
2014
2015         LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
2016         if (!cur.selection()) {
2017                 d->xsel_cache_.set = false;
2018                 return docstring();
2019         }
2020
2021         LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
2022         if (!d->xsel_cache_.set ||
2023             cur.top() != d->xsel_cache_.cursor ||
2024             cur.realAnchor().top() != d->xsel_cache_.anchor)
2025         {
2026                 d->xsel_cache_.cursor = cur.top();
2027                 d->xsel_cache_.anchor = cur.realAnchor().top();
2028                 d->xsel_cache_.set = cur.selection();
2029                 return cur.selectionAsString(false);
2030         }
2031         return docstring();
2032 }
2033
2034
2035 void BufferView::clearSelection()
2036 {
2037         d->cursor_.clearSelection();
2038         // Clear the selection buffer. Otherwise a subsequent
2039         // middle-mouse-button paste would use the selection buffer,
2040         // not the more current external selection.
2041         cap::clearSelection();
2042         d->xsel_cache_.set = false;
2043         // The buffer did not really change, but this causes the
2044         // redraw we need because we cleared the selection above.
2045         buffer_.changed(false);
2046 }
2047
2048
2049 void BufferView::resize(int width, int height)
2050 {
2051         // Update from work area
2052         width_ = width;
2053         height_ = height;
2054
2055         // Clear the paragraph height cache.
2056         d->par_height_.clear();
2057         // Redo the metrics.
2058         updateMetrics();
2059 }
2060
2061
2062 Inset const * BufferView::getCoveringInset(Text const & text,
2063                 int x, int y) const
2064 {
2065         TextMetrics & tm = d->text_metrics_[&text];
2066         Inset * inset = tm.checkInsetHit(x, y);
2067         if (!inset)
2068                 return 0;
2069
2070         if (!inset->descendable(*this))
2071                 // No need to go further down if the inset is not
2072                 // descendable.
2073                 return inset;
2074
2075         size_t cell_number = inset->nargs();
2076         // Check all the inner cell.
2077         for (size_t i = 0; i != cell_number; ++i) {
2078                 Text const * inner_text = inset->getText(i);
2079                 if (inner_text) {
2080                         // Try deeper.
2081                         Inset const * inset_deeper =
2082                                 getCoveringInset(*inner_text, x, y);
2083                         if (inset_deeper)
2084                                 return inset_deeper;
2085                 }
2086         }
2087
2088         return inset;
2089 }
2090
2091
2092 void BufferView::updateHoveredInset() const
2093 {
2094         // Get inset under mouse, if there is one.
2095         int const x = d->mouse_position_cache_.x_;
2096         int const y = d->mouse_position_cache_.y_;
2097         Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
2098
2099         d->clickable_inset_ = covering_inset && covering_inset->clickable(x, y);
2100
2101         if (covering_inset == d->last_inset_)
2102                 // Same inset, no need to do anything...
2103                 return;
2104
2105         bool need_redraw = false;
2106         if (d->last_inset_) {
2107                 // Remove the hint on the last hovered inset (if any).
2108                 need_redraw |= d->last_inset_->setMouseHover(this, false);
2109                 d->last_inset_ = 0;
2110         }
2111
2112         if (covering_inset && covering_inset->setMouseHover(this, true)) {
2113                 need_redraw = true;
2114                 // Only the insets that accept the hover state, do
2115                 // clear the last_inset_, so only set the last_inset_
2116                 // member if the hovered setting is accepted.
2117                 d->last_inset_ = covering_inset;
2118         }
2119
2120         if (need_redraw) {
2121                 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
2122                                 << d->mouse_position_cache_.x_ << ", "
2123                                 << d->mouse_position_cache_.y_ << ")");
2124
2125                 d->update_strategy_ = DecorationUpdate;
2126
2127                 // This event (moving without mouse click) is not passed further.
2128                 // This should be changed if it is further utilized.
2129                 buffer_.changed(false);
2130         }
2131 }
2132
2133
2134 void BufferView::clearLastInset(Inset * inset) const
2135 {
2136         if (d->last_inset_ != inset) {
2137                 LYXERR0("Wrong last_inset!");
2138                 LASSERT(false, /**/);
2139         }
2140         d->last_inset_ = 0;
2141 }
2142
2143
2144 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
2145 {
2146         //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
2147
2148         // This is only called for mouse related events including
2149         // LFUN_FILE_OPEN generated by drag-and-drop.
2150         FuncRequest cmd = cmd0;
2151
2152         Cursor old = cursor();
2153         Cursor cur(*this);
2154         cur.push(buffer_.inset());
2155         cur.setSelection(d->cursor_.selection());
2156
2157         // Either the inset under the cursor or the
2158         // surrounding Text will handle this event.
2159
2160         // make sure we stay within the screen...
2161         cmd.set_y(min(max(cmd.y(), -1), height_));
2162
2163         d->mouse_position_cache_.x_ = cmd.x();
2164         d->mouse_position_cache_.y_ = cmd.y();
2165
2166         if (cmd.action() == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
2167                 updateHoveredInset();
2168                 return;
2169         }
2170
2171         // Build temporary cursor.
2172         Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x(), cmd.y());
2173
2174         // Put anchor at the same position.
2175         cur.resetAnchor();
2176
2177         cur.beginUndoGroup();
2178
2179         // Try to dispatch to an non-editable inset near this position
2180         // via the temp cursor. If the inset wishes to change the real
2181         // cursor it has to do so explicitly by using
2182         //  cur.bv().cursor() = cur;  (or similar)
2183         if (inset)
2184                 inset->dispatch(cur, cmd);
2185
2186         // Now dispatch to the temporary cursor. If the real cursor should
2187         // be modified, the inset's dispatch has to do so explicitly.
2188         if (!inset || !cur.result().dispatched())
2189                 cur.dispatch(cmd);
2190
2191         cur.endUndoGroup();
2192
2193         // Notify left insets
2194         if (cur != old) {
2195                 old.fixIfBroken();
2196                 bool badcursor = notifyCursorLeavesOrEnters(old, cur);
2197                 if (badcursor)
2198                         cursor().fixIfBroken();
2199         }
2200
2201         // Do we have a selection?
2202         theSelection().haveSelection(cursor().selection());
2203
2204         if (cur.needBufferUpdate()) {
2205                 cur.clearBufferUpdate();
2206                 buffer().updateBuffer();
2207         }
2208
2209         // If the command has been dispatched,
2210         if (cur.result().dispatched() || cur.result().screenUpdate())
2211                 processUpdateFlags(cur.result().screenUpdate());
2212 }
2213
2214
2215 int BufferView::minVisiblePart()
2216 {
2217         return 2 * defaultRowHeight();
2218 }
2219
2220
2221 int BufferView::scroll(int y)
2222 {
2223         if (y > 0)
2224                 return scrollDown(y);
2225         if (y < 0)
2226                 return scrollUp(-y);
2227         return 0;
2228 }
2229
2230
2231 int BufferView::scrollDown(int offset)
2232 {
2233         Text * text = &buffer_.text();
2234         TextMetrics & tm = d->text_metrics_[text];
2235         int const ymax = height_ + offset;
2236         while (true) {
2237                 pair<pit_type, ParagraphMetrics const *> last = tm.last();
2238                 int bottom_pos = last.second->position() + last.second->descent();
2239                 if (lyxrc.scroll_below_document)
2240                         bottom_pos += height_ - minVisiblePart();
2241                 if (last.first + 1 == int(text->paragraphs().size())) {
2242                         if (bottom_pos <= height_)
2243                                 return 0;
2244                         offset = min(offset, bottom_pos - height_);
2245                         break;
2246                 }
2247                 if (bottom_pos > ymax)
2248                         break;
2249                 tm.newParMetricsDown();
2250         }
2251         d->anchor_ypos_ -= offset;
2252         return -offset;
2253 }
2254
2255
2256 int BufferView::scrollUp(int offset)
2257 {
2258         Text * text = &buffer_.text();
2259         TextMetrics & tm = d->text_metrics_[text];
2260         int ymin = - offset;
2261         while (true) {
2262                 pair<pit_type, ParagraphMetrics const *> first = tm.first();
2263                 int top_pos = first.second->position() - first.second->ascent();
2264                 if (first.first == 0) {
2265                         if (top_pos >= 0)
2266                                 return 0;
2267                         offset = min(offset, - top_pos);
2268                         break;
2269                 }
2270                 if (top_pos < ymin)
2271                         break;
2272                 tm.newParMetricsUp();
2273         }
2274         d->anchor_ypos_ += offset;
2275         return offset;
2276 }
2277
2278
2279 void BufferView::setCursorFromRow(int row)
2280 {
2281         int tmpid;
2282         int tmppos;
2283         pit_type newpit = 0;
2284         pos_type newpos = 0;
2285
2286         buffer_.texrow().getIdFromRow(row, tmpid, tmppos);
2287
2288         bool posvalid = (tmpid != -1);
2289         if (posvalid) {
2290                 // we need to make sure that the row and position
2291                 // we got back are valid, because the buffer may well
2292                 // have changed since we last generated the LaTeX.
2293                 DocIterator const dit = buffer_.getParFromID(tmpid);
2294                 if (dit == doc_iterator_end(&buffer_))
2295                         posvalid = false;
2296                 else {
2297                         newpit = dit.pit();
2298                         // now have to check pos.
2299                         newpos = tmppos;
2300                         Paragraph const & par = buffer_.text().getPar(newpit);
2301                         if (newpos > par.size()) {
2302                                 LYXERR0("Requested position no longer valid.");
2303                                 newpos = par.size() - 1;
2304                         }
2305                 }
2306         }
2307         if (!posvalid) {
2308                 frontend::Alert::error(_("Inverse Search Failed"),
2309                         _("Invalid position requested by inverse search.\n"
2310                     "You need to update the viewed document."));
2311                 return;
2312         }
2313         d->cursor_.reset();
2314         buffer_.text().setCursor(d->cursor_, newpit, newpos);
2315         d->cursor_.setSelection(false);
2316         d->cursor_.resetAnchor();
2317         recenter();
2318 }
2319
2320
2321 bool BufferView::setCursorFromInset(Inset const * inset)
2322 {
2323         // are we already there?
2324         if (cursor().nextInset() == inset)
2325                 return true;
2326
2327         // Inset is not at cursor position. Find it in the document.
2328         Cursor cur(*this);
2329         cur.reset();
2330         while (cur && cur.nextInset() != inset)
2331                 cur.forwardInset();
2332
2333         if (cur) {
2334                 setCursor(cur);
2335                 return true;
2336         }
2337         return false;
2338 }
2339
2340
2341 void BufferView::gotoLabel(docstring const & label)
2342 {
2343         ListOfBuffers bufs = buffer().allRelatives();
2344         ListOfBuffers::iterator it = bufs.begin();
2345         for (; it != bufs.end(); ++it) {
2346                 Buffer const * buf = *it;
2347
2348                 // find label
2349                 Toc & toc = buf->tocBackend().toc("label");
2350                 TocIterator toc_it = toc.begin();
2351                 TocIterator end = toc.end();
2352                 for (; toc_it != end; ++toc_it) {
2353                         if (label == toc_it->str()) {
2354                                 lyx::dispatch(toc_it->action());
2355                                 return;
2356                         }
2357                 }
2358         }
2359 }
2360
2361
2362 TextMetrics const & BufferView::textMetrics(Text const * t) const
2363 {
2364         return const_cast<BufferView *>(this)->textMetrics(t);
2365 }
2366
2367
2368 TextMetrics & BufferView::textMetrics(Text const * t)
2369 {
2370         LASSERT(t, /**/);
2371         TextMetricsCache::iterator tmc_it  = d->text_metrics_.find(t);
2372         if (tmc_it == d->text_metrics_.end()) {
2373                 tmc_it = d->text_metrics_.insert(
2374                         make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
2375         }
2376         return tmc_it->second;
2377 }
2378
2379
2380 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
2381                 pit_type pit) const
2382 {
2383         return textMetrics(t).parMetrics(pit);
2384 }
2385
2386
2387 int BufferView::workHeight() const
2388 {
2389         return height_;
2390 }
2391
2392
2393 void BufferView::setCursor(DocIterator const & dit)
2394 {
2395         d->cursor_.reset();
2396         size_t const n = dit.depth();
2397         for (size_t i = 0; i < n; ++i)
2398                 dit[i].inset().edit(d->cursor_, true);
2399
2400         d->cursor_.setCursor(dit);
2401         d->cursor_.setSelection(false);
2402         // FIXME
2403         // It seems on general grounds as if this is probably needed, but
2404         // it is not yet clear.
2405         // See bug #7394 and r38388.
2406         // d->cursor.resetAnchor();
2407 }
2408
2409
2410 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
2411 {
2412         // Would be wrong to delete anything if we have a selection.
2413         if (cur.selection())
2414                 return false;
2415
2416         bool need_anchor_change = false;
2417         bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
2418                 need_anchor_change);
2419
2420         if (need_anchor_change)
2421                 cur.resetAnchor();
2422
2423         if (!changed)
2424                 return false;
2425
2426         d->cursor_ = cur;
2427
2428         cur.forceBufferUpdate();
2429         cur.screenUpdateFlags(Update::Force);
2430         return true;
2431 }
2432
2433
2434 bool BufferView::mouseSetCursor(Cursor & cur, bool select)
2435 {
2436         LASSERT(&cur.bv() == this, /**/);
2437
2438         if (!select)
2439                 // this event will clear selection so we save selection for
2440                 // persistent selection
2441                 cap::saveSelection(cursor());
2442
2443         d->cursor_.macroModeClose();
2444
2445         // Has the cursor just left the inset?
2446         bool const leftinset = (&d->cursor_.inset() != &cur.inset());
2447         if (leftinset)
2448                 d->cursor_.fixIfBroken();
2449
2450         // FIXME: shift-mouse selection doesn't work well across insets.
2451         bool const do_selection =
2452                         select && &d->cursor_.normalAnchor().inset() == &cur.inset();
2453
2454         // do the dEPM magic if needed
2455         // FIXME: (1) move this to InsetText::notifyCursorLeaves?
2456         // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
2457         // the leftinset bool would not be necessary (badcursor instead).
2458         bool update = leftinset;
2459         if (!do_selection && d->cursor_.inTexted())
2460                 update |= checkDepm(cur, d->cursor_);
2461
2462         if (!do_selection)
2463                 d->cursor_.resetAnchor();
2464         d->cursor_.setCursor(cur);
2465         d->cursor_.boundary(cur.boundary());
2466         if (do_selection)
2467                 d->cursor_.setSelection();
2468         else
2469                 d->cursor_.clearSelection();
2470
2471         d->cursor_.finishUndo();
2472         d->cursor_.setCurrentFont();
2473         if (update)
2474                 cur.forceBufferUpdate();
2475         return update;
2476 }
2477
2478
2479 void BufferView::putSelectionAt(DocIterator const & cur,
2480                                 int length, bool backwards)
2481 {
2482         d->cursor_.clearSelection();
2483
2484         setCursor(cur);
2485
2486         if (length) {
2487                 if (backwards) {
2488                         d->cursor_.pos() += length;
2489                         d->cursor_.setSelection(d->cursor_, -length);
2490                 } else
2491                         d->cursor_.setSelection(d->cursor_, length);
2492         }
2493 }
2494
2495
2496 bool BufferView::selectIfEmpty(DocIterator & cur)
2497 {
2498         if (!cur.paragraph().empty())
2499                 return false;
2500
2501         pit_type const beg_pit = cur.pit();
2502         if (beg_pit > 0) {
2503                 // The paragraph associated to this item isn't
2504                 // the first one, so it can be selected
2505                 cur.backwardPos();
2506         } else {
2507                 // We have to resort to select the space between the
2508                 // end of this item and the begin of the next one
2509                 cur.forwardPos();
2510         }
2511         if (cur.empty()) {
2512                 // If it is the only item in the document,
2513                 // nothing can be selected
2514                 return false;
2515         }
2516         pit_type const end_pit = cur.pit();
2517         pos_type const end_pos = cur.pos();
2518         d->cursor_.clearSelection();
2519         d->cursor_.reset();
2520         d->cursor_.setCursor(cur);
2521         d->cursor_.pit() = beg_pit;
2522         d->cursor_.pos() = 0;
2523         d->cursor_.setSelection(false);
2524         d->cursor_.resetAnchor();
2525         d->cursor_.pit() = end_pit;
2526         d->cursor_.pos() = end_pos;
2527         d->cursor_.setSelection();
2528         return true;
2529 }
2530
2531
2532 Cursor & BufferView::cursor()
2533 {
2534         return d->cursor_;
2535 }
2536
2537
2538 Cursor const & BufferView::cursor() const
2539 {
2540         return d->cursor_;
2541 }
2542
2543
2544 pit_type BufferView::anchor_ref() const
2545 {
2546         return d->anchor_pit_;
2547 }
2548
2549
2550 bool BufferView::singleParUpdate()
2551 {
2552         Text & buftext = buffer_.text();
2553         pit_type const bottom_pit = d->cursor_.bottom().pit();
2554         TextMetrics & tm = textMetrics(&buftext);
2555         int old_height = tm.parMetrics(bottom_pit).height();
2556
2557         // make sure inline completion pointer is ok
2558         if (d->inlineCompletionPos_.fixIfBroken())
2559                 d->inlineCompletionPos_ = DocIterator();
2560
2561         // In Single Paragraph mode, rebreak only
2562         // the (main text, not inset!) paragraph containing the cursor.
2563         // (if this paragraph contains insets etc., rebreaking will
2564         // recursively descend)
2565         tm.redoParagraph(bottom_pit);
2566         ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
2567         if (pm.height() != old_height)
2568                 // Paragraph height has changed so we cannot proceed to
2569                 // the singlePar optimisation.
2570                 return false;
2571
2572         d->update_strategy_ = SingleParUpdate;
2573
2574         LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
2575                 << " y2: " << pm.position() + pm.descent()
2576                 << " pit: " << bottom_pit
2577                 << " singlepar: 1");
2578         return true;
2579 }
2580
2581
2582 void BufferView::updateMetrics()
2583 {
2584         if (height_ == 0 || width_ == 0)
2585                 return;
2586
2587         Text & buftext = buffer_.text();
2588         pit_type const npit = int(buftext.paragraphs().size());
2589
2590         // Clear out the position cache in case of full screen redraw,
2591         d->coord_cache_.clear();
2592
2593         // Clear out paragraph metrics to avoid having invalid metrics
2594         // in the cache from paragraphs not relayouted below
2595         // The complete text metrics will be redone.
2596         d->text_metrics_.clear();
2597
2598         TextMetrics & tm = textMetrics(&buftext);
2599
2600         // make sure inline completion pointer is ok
2601         if (d->inlineCompletionPos_.fixIfBroken())
2602                 d->inlineCompletionPos_ = DocIterator();
2603
2604         if (d->anchor_pit_ >= npit)
2605                 // The anchor pit must have been deleted...
2606                 d->anchor_pit_ = npit - 1;
2607
2608         // Rebreak anchor paragraph.
2609         tm.redoParagraph(d->anchor_pit_);
2610         ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
2611
2612         // position anchor
2613         if (d->anchor_pit_ == 0) {
2614                 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
2615
2616                 // Complete buffer visible? Then it's easy.
2617                 if (scrollRange == 0)
2618                         d->anchor_ypos_ = anchor_pm.ascent();
2619
2620                 // FIXME: Some clever handling needed to show
2621                 // the _first_ paragraph up to the top if the cursor is
2622                 // in the first line.
2623         }
2624         anchor_pm.setPosition(d->anchor_ypos_);
2625
2626         LYXERR(Debug::PAINTING, "metrics: "
2627                 << " anchor pit = " << d->anchor_pit_
2628                 << " anchor ypos = " << d->anchor_ypos_);
2629
2630         // Redo paragraphs above anchor if necessary.
2631         int y1 = d->anchor_ypos_ - anchor_pm.ascent();
2632         // We are now just above the anchor paragraph.
2633         pit_type pit1 = d->anchor_pit_ - 1;
2634         for (; pit1 >= 0 && y1 >= 0; --pit1) {
2635                 tm.redoParagraph(pit1);
2636                 ParagraphMetrics & pm = tm.par_metrics_[pit1];
2637                 y1 -= pm.descent();
2638                 // Save the paragraph position in the cache.
2639                 pm.setPosition(y1);
2640                 y1 -= pm.ascent();
2641         }
2642
2643         // Redo paragraphs below the anchor if necessary.
2644         int y2 = d->anchor_ypos_ + anchor_pm.descent();
2645         // We are now just below the anchor paragraph.
2646         pit_type pit2 = d->anchor_pit_ + 1;
2647         for (; pit2 < npit && y2 <= height_; ++pit2) {
2648                 tm.redoParagraph(pit2);
2649                 ParagraphMetrics & pm = tm.par_metrics_[pit2];
2650                 y2 += pm.ascent();
2651                 // Save the paragraph position in the cache.
2652                 pm.setPosition(y2);
2653                 y2 += pm.descent();
2654         }
2655
2656         LYXERR(Debug::PAINTING, "Metrics: "
2657                 << " anchor pit = " << d->anchor_pit_
2658                 << " anchor ypos = " << d->anchor_ypos_
2659                 << " y1 = " << y1
2660                 << " y2 = " << y2
2661                 << " pit1 = " << pit1
2662                 << " pit2 = " << pit2);
2663
2664         d->update_strategy_ = FullScreenUpdate;
2665
2666         if (lyxerr.debugging(Debug::WORKAREA)) {
2667                 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
2668                 d->coord_cache_.dump();
2669         }
2670 }
2671
2672
2673 void BufferView::insertLyXFile(FileName const & fname)
2674 {
2675         LASSERT(d->cursor_.inTexted(), /**/);
2676
2677         // Get absolute path of file and add ".lyx"
2678         // to the filename if necessary
2679         FileName filename = fileSearch(string(), fname.absFileName(), "lyx");
2680
2681         docstring const disp_fn = makeDisplayPath(filename.absFileName());
2682         // emit message signal.
2683         message(bformat(_("Inserting document %1$s..."), disp_fn));
2684
2685         docstring res;
2686         Buffer buf(filename.absFileName(), false);
2687         if (buf.loadLyXFile() == Buffer::ReadSuccess) {
2688                 ErrorList & el = buffer_.errorList("Parse");
2689                 // Copy the inserted document error list into the current buffer one.
2690                 el = buf.errorList("Parse");
2691                 buffer_.undo().recordUndo(d->cursor_);
2692                 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
2693                                              buf.params().documentClassPtr(), el);
2694                 res = _("Document %1$s inserted.");
2695         } else {
2696                 res = _("Could not insert document %1$s");
2697         }
2698
2699         buffer_.changed(true);
2700         // emit message signal.
2701         message(bformat(res, disp_fn));
2702 }
2703
2704
2705 Point BufferView::coordOffset(DocIterator const & dit) const
2706 {
2707         int x = 0;
2708         int y = 0;
2709         int lastw = 0;
2710
2711         // Addup contribution of nested insets, from inside to outside,
2712         // keeping the outer paragraph for a special handling below
2713         for (size_t i = dit.depth() - 1; i >= 1; --i) {
2714                 CursorSlice const & sl = dit[i];
2715                 int xx = 0;
2716                 int yy = 0;
2717
2718                 // get relative position inside sl.inset()
2719                 sl.inset().cursorPos(*this, sl, dit.boundary() && (i + 1 == dit.depth()), xx, yy);
2720
2721                 // Make relative position inside of the edited inset relative to sl.inset()
2722                 x += xx;
2723                 y += yy;
2724
2725                 // In case of an RTL inset, the edited inset will be positioned to the left
2726                 // of xx:yy
2727                 if (sl.text()) {
2728                         bool boundary_i = dit.boundary() && i + 1 == dit.depth();
2729                         bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2730                         if (rtl)
2731                                 x -= lastw;
2732                 }
2733
2734                 // remember width for the case that sl.inset() is positioned in an RTL inset
2735                 if (i && dit[i - 1].text()) {
2736                         // If this Inset is inside a Text Inset, retrieve the Dimension
2737                         // from the containing text instead of using Inset::dimension() which
2738                         // might not be implemented.
2739                         // FIXME (Abdel 23/09/2007): this is a bit messy because of the
2740                         // elimination of Inset::dim_ cache. This coordOffset() method needs
2741                         // to be rewritten in light of the new design.
2742                         Dimension const & dim = parMetrics(dit[i - 1].text(),
2743                                 dit[i - 1].pit()).insetDimension(&sl.inset());
2744                         lastw = dim.wid;
2745                 } else {
2746                         Dimension const dim = sl.inset().dimension(*this);
2747                         lastw = dim.wid;
2748                 }
2749
2750                 //lyxerr << "Cursor::getPos, i: "
2751                 // << i << " x: " << xx << " y: " << y << endl;
2752         }
2753
2754         // Add contribution of initial rows of outermost paragraph
2755         CursorSlice const & sl = dit[0];
2756         TextMetrics const & tm = textMetrics(sl.text());
2757         ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2758         LASSERT(!pm.rows().empty(), /**/);
2759         y -= pm.rows()[0].ascent();
2760 #if 1
2761         // FIXME: document this mess
2762         size_t rend;
2763         if (sl.pos() > 0 && dit.depth() == 1) {
2764                 int pos = sl.pos();
2765                 if (pos && dit.boundary())
2766                         --pos;
2767 //              lyxerr << "coordOffset: boundary:" << dit.boundary() << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
2768                 rend = pm.pos2row(pos);
2769         } else
2770                 rend = pm.pos2row(sl.pos());
2771 #else
2772         size_t rend = pm.pos2row(sl.pos());
2773 #endif
2774         for (size_t rit = 0; rit != rend; ++rit)
2775                 y += pm.rows()[rit].height();
2776         y += pm.rows()[rend].ascent();
2777
2778         TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
2779
2780         // Make relative position from the nested inset now bufferview absolute.
2781         int xx = bottom_tm.cursorX(dit.bottom(), dit.boundary() && dit.depth() == 1);
2782         x += xx;
2783
2784         // In the RTL case place the nested inset at the left of the cursor in
2785         // the outer paragraph
2786         bool boundary_1 = dit.boundary() && 1 == dit.depth();
2787         bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
2788         if (rtl)
2789                 x -= lastw;
2790
2791         return Point(x, y);
2792 }
2793
2794
2795 Point BufferView::getPos(DocIterator const & dit) const
2796 {
2797         if (!paragraphVisible(dit))
2798                 return Point(-1, -1);
2799
2800         CursorSlice const & bot = dit.bottom();
2801         TextMetrics const & tm = textMetrics(bot.text());
2802
2803         // offset from outer paragraph
2804         Point p = coordOffset(dit);
2805         p.y_ += tm.parMetrics(bot.pit()).position();
2806         return p;
2807 }
2808
2809
2810 bool BufferView::paragraphVisible(DocIterator const & dit) const
2811 {
2812         CursorSlice const & bot = dit.bottom();
2813         TextMetrics const & tm = textMetrics(bot.text());
2814
2815         return tm.contains(bot.pit());
2816 }
2817
2818
2819 void BufferView::cursorPosAndHeight(Point & p, int & h) const
2820 {
2821         Cursor const & cur = cursor();
2822         Font const font = cur.getFont();
2823         frontend::FontMetrics const & fm = theFontMetrics(font);
2824         int const asc = fm.maxAscent();
2825         int const des = fm.maxDescent();
2826         h = asc + des;
2827         p = getPos(cur);
2828         p.y_ -= asc;
2829 }
2830
2831
2832 bool BufferView::cursorInView(Point const & p, int h) const
2833 {
2834         Cursor const & cur = cursor();
2835         // does the cursor touch the screen ?
2836         if (p.y_ + h < 0 || p.y_ >= workHeight() || !paragraphVisible(cur))
2837                 return false;
2838         return true;
2839 }
2840
2841
2842 void BufferView::draw(frontend::Painter & pain)
2843 {
2844         if (height_ == 0 || width_ == 0)
2845                 return;
2846         LYXERR(Debug::PAINTING, "\t\t*** START DRAWING ***");
2847
2848         Text & text = buffer_.text();
2849         TextMetrics const & tm = d->text_metrics_[&text];
2850         int const y = tm.first().second->position();
2851         PainterInfo pi(this, pain);
2852
2853         switch (d->update_strategy_) {
2854
2855         case NoScreenUpdate:
2856                 // If no screen painting is actually needed, only some the different
2857                 // coordinates of insets and paragraphs needs to be updated.
2858                 pi.full_repaint = true;
2859                 pi.pain.setDrawingEnabled(false);
2860                 tm.draw(pi, 0, y);
2861                 break;
2862
2863         case SingleParUpdate:
2864                 pi.full_repaint = false;
2865                 // In general, only the current row of the outermost paragraph
2866                 // will be redrawn. Particular cases where selection spans
2867                 // multiple paragraph are correctly detected in TextMetrics.
2868                 tm.draw(pi, 0, y);
2869                 break;
2870
2871         case DecorationUpdate:
2872                 // FIXME: We should also distinguish DecorationUpdate to avoid text
2873                 // drawing if possible. This is not possible to do easily right now
2874                 // because of the single backing pixmap.
2875
2876         case FullScreenUpdate:
2877                 // The whole screen, including insets, will be refreshed.
2878                 pi.full_repaint = true;
2879
2880                 // Clear background.
2881                 pain.fillRectangle(0, 0, width_, height_,
2882                         pi.backgroundColor(&buffer_.inset()));
2883
2884                 // Draw everything.
2885                 tm.draw(pi, 0, y);
2886
2887                 // and possibly grey out below
2888                 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2889                 int const y2 = lastpm.second->position() + lastpm.second->descent();
2890
2891                 if (y2 < height_) {
2892                         Color color = buffer().isInternal()
2893                                 ? Color_background : Color_bottomarea;
2894                         pain.fillRectangle(0, y2, width_, height_ - y2, color);
2895                 }
2896                 break;
2897         }
2898         LYXERR(Debug::PAINTING, "\n\t\t*** END DRAWING  ***");
2899
2900         // The scrollbar needs an update.
2901         updateScrollbar();
2902
2903         // Normalize anchor for next time
2904         pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
2905         pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2906         for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
2907                 ParagraphMetrics const & pm = tm.parMetrics(pit);
2908                 if (pm.position() + pm.descent() > 0) {
2909                         d->anchor_pit_ = pit;
2910                         d->anchor_ypos_ = pm.position();
2911                         break;
2912                 }
2913         }
2914         LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
2915                 << "  anchor ypos = " << d->anchor_ypos_);
2916 }
2917
2918
2919 void BufferView::message(docstring const & msg)
2920 {
2921         if (d->gui_)
2922                 d->gui_->message(msg);
2923 }
2924
2925
2926 void BufferView::showDialog(string const & name)
2927 {
2928         if (d->gui_)
2929                 d->gui_->showDialog(name, string());
2930 }
2931
2932
2933 void BufferView::showDialog(string const & name,
2934         string const & data, Inset * inset)
2935 {
2936         if (d->gui_)
2937                 d->gui_->showDialog(name, data, inset);
2938 }
2939
2940
2941 void BufferView::updateDialog(string const & name, string const & data)
2942 {
2943         if (d->gui_)
2944                 d->gui_->updateDialog(name, data);
2945 }
2946
2947
2948 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
2949 {
2950         d->gui_ = gui;
2951 }
2952
2953
2954 // FIXME: Move this out of BufferView again
2955 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
2956 {
2957         if (!fname.isReadableFile()) {
2958                 docstring const error = from_ascii(strerror(errno));
2959                 docstring const file = makeDisplayPath(fname.absFileName(), 50);
2960                 docstring const text =
2961                   bformat(_("Could not read the specified document\n"
2962                             "%1$s\ndue to the error: %2$s"), file, error);
2963                 Alert::error(_("Could not read file"), text);
2964                 return docstring();
2965         }
2966
2967         if (!fname.isReadableFile()) {
2968                 docstring const file = makeDisplayPath(fname.absFileName(), 50);
2969                 docstring const text =
2970                   bformat(_("%1$s\n is not readable."), file);
2971                 Alert::error(_("Could not open file"), text);
2972                 return docstring();
2973         }
2974
2975         // FIXME UNICODE: We don't know the encoding of the file
2976         docstring file_content = fname.fileContents("UTF-8");
2977         if (file_content.empty()) {
2978                 Alert::error(_("Reading not UTF-8 encoded file"),
2979                              _("The file is not UTF-8 encoded.\n"
2980                                "It will be read as local 8Bit-encoded.\n"
2981                                "If this does not give the correct result\n"
2982                                "then please change the encoding of the file\n"
2983                                "to UTF-8 with a program other than LyX.\n"));
2984                 file_content = fname.fileContents("local8bit");
2985         }
2986
2987         return normalize_c(file_content);
2988 }
2989
2990
2991 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
2992 {
2993         docstring const tmpstr = contentsOfPlaintextFile(f);
2994
2995         if (tmpstr.empty())
2996                 return;
2997
2998         Cursor & cur = cursor();
2999         cap::replaceSelection(cur);
3000         buffer_.undo().recordUndo(cur);
3001         if (asParagraph)
3002                 cur.innerText()->insertStringAsParagraphs(cur, tmpstr, cur.current_font);
3003         else
3004                 cur.innerText()->insertStringAsLines(cur, tmpstr, cur.current_font);
3005
3006         buffer_.changed(true);
3007 }
3008
3009
3010 docstring const & BufferView::inlineCompletion() const
3011 {
3012         return d->inlineCompletion_;
3013 }
3014
3015
3016 size_t const & BufferView::inlineCompletionUniqueChars() const
3017 {
3018         return d->inlineCompletionUniqueChars_;
3019 }
3020
3021
3022 DocIterator const & BufferView::inlineCompletionPos() const
3023 {
3024         return d->inlineCompletionPos_;
3025 }
3026
3027
3028 void BufferView::resetInlineCompletionPos()
3029 {
3030         d->inlineCompletionPos_ = DocIterator();
3031 }
3032
3033
3034 bool samePar(DocIterator const & a, DocIterator const & b)
3035 {
3036         if (a.empty() && b.empty())
3037                 return true;
3038         if (a.empty() || b.empty())
3039                 return false;
3040         if (a.depth() != b.depth())
3041                 return false;
3042         return &a.innerParagraph() == &b.innerParagraph();
3043 }
3044
3045
3046 void BufferView::setInlineCompletion(Cursor const & cur, DocIterator const & pos,
3047         docstring const & completion, size_t uniqueChars)
3048 {
3049         uniqueChars = min(completion.size(), uniqueChars);
3050         bool changed = d->inlineCompletion_ != completion
3051                 || d->inlineCompletionUniqueChars_ != uniqueChars;
3052         bool singlePar = true;
3053         d->inlineCompletion_ = completion;
3054         d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
3055
3056         //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
3057
3058         // at new position?
3059         DocIterator const & old = d->inlineCompletionPos_;
3060         if (old != pos) {
3061                 //lyxerr << "inlineCompletionPos changed" << std::endl;
3062                 // old or pos are in another paragraph?
3063                 if ((!samePar(cur, pos) && !pos.empty())
3064                     || (!samePar(cur, old) && !old.empty())) {
3065                         singlePar = false;
3066                         //lyxerr << "different paragraph" << std::endl;
3067                 }
3068                 d->inlineCompletionPos_ = pos;
3069         }
3070
3071         // set update flags
3072         if (changed) {
3073                 if (singlePar && !(cur.result().screenUpdate() & Update::Force))
3074                         cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
3075                 else
3076                         cur.screenUpdateFlags(cur.result().screenUpdate() | Update::Force);
3077         }
3078 }
3079
3080
3081 bool BufferView::clickableInset() const
3082 {
3083         return d->clickable_inset_;
3084 }
3085
3086 } // namespace lyx