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