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