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         }
1116
1117         case LFUN_LABEL_GOTO: {
1118                 flag.setEnabled(!cmd.argument().empty()
1119                     || getInsetByCode<InsetRef>(cur, REF_CODE));
1120                 break;
1121         }
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.recordUndoFullDocument();
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                 cur.recordUndoFullDocument();
1276                 buffer_.params().clearLayoutModules();
1277                 makeDocumentClass();
1278                 dr.screenUpdate(Update::Force);
1279                 dr.forceBufferUpdate();
1280                 break;
1281         }
1282
1283         case LFUN_LAYOUT_MODULE_ADD: {
1284                 BufferParams const & params = buffer_.params();
1285                 if (!params.layoutModuleCanBeAdded(argument)) {
1286                         LYXERR0("Module `" << argument <<
1287                                 "' cannot be added due to failed requirements or "
1288                                 "conflicts with installed modules.");
1289                         break;
1290                 }
1291                 cur.recordUndoFullDocument();
1292                 buffer_.params().addLayoutModule(argument);
1293                 makeDocumentClass();
1294                 dr.screenUpdate(Update::Force);
1295                 dr.forceBufferUpdate();
1296                 break;
1297         }
1298
1299         case LFUN_TEXTCLASS_APPLY: {
1300                 // since this shortcircuits, the second call is made only if
1301                 // the first fails
1302                 bool const success =
1303                         LayoutFileList::get().load(argument, buffer_.temppath()) ||
1304                         LayoutFileList::get().load(argument, buffer_.filePath());
1305                 if (!success) {
1306                         docstring s = bformat(_("The document class `%1$s' "
1307                                                  "could not be loaded."), from_utf8(argument));
1308                         frontend::Alert::error(_("Could not load class"), s);
1309                         break;
1310                 }
1311
1312                 LayoutFile const * old_layout = buffer_.params().baseClass();
1313                 LayoutFile const * new_layout = &(LayoutFileList::get()[argument]);
1314
1315                 if (old_layout == new_layout)
1316                         // nothing to do
1317                         break;
1318
1319                 // Save the old, possibly modular, layout for use in conversion.
1320                 cur.recordUndoFullDocument();
1321                 buffer_.params().setBaseClass(argument);
1322                 makeDocumentClass();
1323                 dr.screenUpdate(Update::Force);
1324                 dr.forceBufferUpdate();
1325                 break;
1326         }
1327
1328         case LFUN_TEXTCLASS_LOAD: {
1329                 // since this shortcircuits, the second call is made only if
1330                 // the first fails
1331                 bool const success =
1332                         LayoutFileList::get().load(argument, buffer_.temppath()) ||
1333                         LayoutFileList::get().load(argument, buffer_.filePath());
1334                 if (!success) {
1335                         docstring s = bformat(_("The document class `%1$s' "
1336                                                  "could not be loaded."), from_utf8(argument));
1337                         frontend::Alert::error(_("Could not load class"), s);
1338                 }
1339                 break;
1340         }
1341
1342         case LFUN_LAYOUT_RELOAD: {
1343                 LayoutFileIndex bc = buffer_.params().baseClassID();
1344                 LayoutFileList::get().reset(bc);
1345                 buffer_.params().setBaseClass(bc);
1346                 makeDocumentClass();
1347                 dr.screenUpdate(Update::Force);
1348                 dr.forceBufferUpdate();
1349                 break;
1350         }
1351
1352         case LFUN_UNDO:
1353                 dr.setMessage(_("Undo"));
1354                 cur.clearSelection();
1355                 if (!cur.textUndo())
1356                         dr.setMessage(_("No further undo information"));
1357                 else
1358                         dr.screenUpdate(Update::Force | Update::FitCursor);
1359                 dr.forceBufferUpdate();
1360                 break;
1361
1362         case LFUN_REDO:
1363                 dr.setMessage(_("Redo"));
1364                 cur.clearSelection();
1365                 if (!cur.textRedo())
1366                         dr.setMessage(_("No further redo information"));
1367                 else
1368                         dr.screenUpdate(Update::Force | Update::FitCursor);
1369                 dr.forceBufferUpdate();
1370                 break;
1371
1372         case LFUN_FONT_STATE:
1373                 dr.setMessage(cur.currentState());
1374                 break;
1375
1376         case LFUN_BOOKMARK_SAVE:
1377                 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1378                 break;
1379
1380         case LFUN_LABEL_GOTO: {
1381                 docstring label = cmd.argument();
1382                 if (label.empty()) {
1383                         InsetRef * inset =
1384                                 getInsetByCode<InsetRef>(cur, REF_CODE);
1385                         if (inset) {
1386                                 label = inset->getParam("reference");
1387                                 // persistent=false: use temp_bookmark
1388                                 saveBookmark(0);
1389                         }
1390                 }
1391                 if (!label.empty()) {
1392                         gotoLabel(label);
1393                         // at the moment, this is redundant, since gotoLabel will
1394                         // eventually call LFUN_PARAGRAPH_GOTO, but it seems best
1395                         // to have it here.
1396                         dr.screenUpdate(Update::Force | Update::FitCursor);
1397                 }
1398                 break;
1399         }
1400
1401         case LFUN_PARAGRAPH_GOTO: {
1402                 int const id = convert<int>(cmd.getArg(0));
1403                 int const pos = convert<int>(cmd.getArg(1));
1404                 int i = 0;
1405                 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1406                         b = theBufferList().next(b)) {
1407
1408                         DocIterator dit = b->getParFromID(id);
1409                         if (dit.atEnd()) {
1410                                 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1411                                 ++i;
1412                                 continue;
1413                         }
1414                         LYXERR(Debug::INFO, "Paragraph " << dit.paragraph().id()
1415                                 << " found in buffer `"
1416                                 << b->absFileName() << "'.");
1417
1418                         if (b == &buffer_) {
1419                                 // Set the cursor
1420                                 dit.pos() = pos;
1421                                 setCursor(dit);
1422                                 dr.screenUpdate(Update::Force | Update::FitCursor);
1423                         } else {
1424                                 // Switch to other buffer view and resend cmd
1425                                 lyx::dispatch(FuncRequest(
1426                                         LFUN_BUFFER_SWITCH, b->absFileName()));
1427                                 lyx::dispatch(cmd);
1428                         }
1429                         break;
1430                 }
1431                 break;
1432         }
1433
1434         case LFUN_NOTE_NEXT:
1435                 gotoInset(this, NOTE_CODE, false);
1436                 break;
1437
1438         case LFUN_REFERENCE_NEXT: {
1439                 vector<InsetCode> tmp;
1440                 tmp.push_back(LABEL_CODE);
1441                 tmp.push_back(REF_CODE);
1442                 gotoInset(this, tmp, true);
1443                 break;
1444         }
1445
1446         case LFUN_CHANGES_TRACK:
1447                 buffer_.params().track_changes = !buffer_.params().track_changes;
1448                 break;
1449
1450         case LFUN_CHANGES_OUTPUT:
1451                 buffer_.params().output_changes = !buffer_.params().output_changes;
1452                 if (buffer_.params().output_changes) {
1453                         bool dvipost    = LaTeXFeatures::isAvailable("dvipost");
1454                         bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1455                                           LaTeXFeatures::isAvailable("xcolor");
1456
1457                         if (!dvipost && !xcolorulem) {
1458                                 Alert::warning(_("Changes not shown in LaTeX output"),
1459                                                _("Changes will not be highlighted in LaTeX output, "
1460                                                  "because neither dvipost nor xcolor/ulem are installed.\n"
1461                                                  "Please install these packages or redefine "
1462                                                  "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1463                         } else if (!xcolorulem) {
1464                                 Alert::warning(_("Changes not shown in LaTeX output"),
1465                                                _("Changes will not be highlighted in LaTeX output "
1466                                                  "when using pdflatex, because xcolor and ulem are not installed.\n"
1467                                                  "Please install both packages or redefine "
1468                                                  "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1469                         }
1470                 }
1471                 break;
1472
1473         case LFUN_CHANGE_NEXT:
1474                 findNextChange(this);
1475                 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1476                 dr.screenUpdate(Update::Force | Update::FitCursor);
1477                 break;
1478
1479         case LFUN_CHANGE_PREVIOUS:
1480                 findPreviousChange(this);
1481                 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1482                 dr.screenUpdate(Update::Force | Update::FitCursor);
1483                 break;
1484
1485         case LFUN_CHANGES_MERGE:
1486                 if (findNextChange(this) || findPreviousChange(this)) {
1487                         dr.screenUpdate(Update::Force | Update::FitCursor);
1488                         dr.forceBufferUpdate();
1489                         showDialog("changes");
1490                 }
1491                 break;
1492
1493         case LFUN_ALL_CHANGES_ACCEPT:
1494                 // select complete document
1495                 cur.reset();
1496                 cur.selHandle(true);
1497                 buffer_.text().cursorBottom(cur);
1498                 // accept everything in a single step to support atomic undo
1499                 buffer_.text().acceptOrRejectChanges(cur, Text::ACCEPT);
1500                 cur.resetAnchor();
1501                 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1502                 dr.screenUpdate(Update::Force | Update::FitCursor);
1503                 dr.forceBufferUpdate();
1504                 break;
1505
1506         case LFUN_ALL_CHANGES_REJECT:
1507                 // select complete document
1508                 cur.reset();
1509                 cur.selHandle(true);
1510                 buffer_.text().cursorBottom(cur);
1511                 // reject everything in a single step to support atomic undo
1512                 // Note: reject does not work recursively; the user may have to repeat the operation
1513                 buffer_.text().acceptOrRejectChanges(cur, Text::REJECT);
1514                 cur.resetAnchor();
1515                 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1516                 dr.screenUpdate(Update::Force | Update::FitCursor);
1517                 dr.forceBufferUpdate();
1518                 break;
1519
1520         case LFUN_WORD_FIND_FORWARD:
1521         case LFUN_WORD_FIND_BACKWARD: {
1522                 // FIXME THREAD
1523                 // Would it maybe be better if this variable were view specific anyway?
1524                 static docstring last_search;
1525                 docstring searched_string;
1526
1527                 if (!cmd.argument().empty()) {
1528                         last_search = cmd.argument();
1529                         searched_string = cmd.argument();
1530                 } else {
1531                         searched_string = last_search;
1532                 }
1533
1534                 if (searched_string.empty())
1535                         break;
1536
1537                 bool const fw = act == LFUN_WORD_FIND_FORWARD;
1538                 docstring const data =
1539                         find2string(searched_string, true, false, fw);
1540                 bool found = lyxfind(this, FuncRequest(LFUN_WORD_FIND, data));
1541                 if (found) {
1542                         dr.screenUpdate(Update::Force | Update::FitCursor);
1543                         cur.dispatched();
1544                         dispatched = true;
1545                 } else {
1546                         cur.undispatched();
1547                         dispatched = false;
1548                 }
1549                 break;
1550         }
1551
1552         case LFUN_WORD_FIND: {
1553                 FuncRequest req = cmd;
1554                 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1555                         req = d->search_request_cache_;
1556                 if (req.argument().empty()) {
1557                         lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, "findreplace"));
1558                         break;
1559                 }
1560                 if (lyxfind(this, req)) {
1561                         dr.screenUpdate(Update::Force | Update::FitCursor);
1562                         cur.dispatched();
1563                         dispatched = true;
1564                 } else {
1565                         cur.undispatched();
1566                         dispatched = false;
1567                 }
1568                 d->search_request_cache_ = req;
1569                 break;
1570         }
1571
1572         case LFUN_WORD_REPLACE: {
1573                 bool has_deleted = false;
1574                 if (cur.selection()) {
1575                         DocIterator beg = cur.selectionBegin();
1576                         DocIterator end = cur.selectionEnd();
1577                         if (beg.pit() == end.pit()) {
1578                                 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1579                                         if (!cur.inMathed() && cur.paragraph().isDeleted(p)) {
1580                                                 has_deleted = true;
1581                                                 break;
1582                                         }
1583                                 }
1584                         }
1585                 }
1586                 if (lyxreplace(this, cmd, has_deleted)) {
1587                         dr.forceBufferUpdate();
1588                         dr.screenUpdate(Update::Force | Update::FitCursor);
1589                         cur.dispatched();
1590                         dispatched = true;
1591                 } else {
1592                         cur.undispatched();
1593                         dispatched = false;
1594                 }
1595                 break;
1596         }
1597
1598         case LFUN_WORD_FINDADV: {
1599                 FindAndReplaceOptions opt;
1600                 istringstream iss(to_utf8(cmd.argument()));
1601                 iss >> opt;
1602                 if (findAdv(this, opt)) {
1603                         dr.screenUpdate(Update::Force | Update::FitCursor);
1604                         cur.dispatched();
1605                         dispatched = true;
1606                 } else {
1607                         cur.undispatched();
1608                         dispatched = false;
1609                 }
1610                 break;
1611         }
1612
1613         case LFUN_MARK_OFF:
1614                 cur.clearSelection();
1615                 dr.setMessage(from_utf8(N_("Mark off")));
1616                 break;
1617
1618         case LFUN_MARK_ON:
1619                 cur.clearSelection();
1620                 cur.setMark(true);
1621                 dr.setMessage(from_utf8(N_("Mark on")));
1622                 break;
1623
1624         case LFUN_MARK_TOGGLE:
1625                 cur.setSelection(false);
1626                 if (cur.mark()) {
1627                         cur.setMark(false);
1628                         dr.setMessage(from_utf8(N_("Mark removed")));
1629                 } else {
1630                         cur.setMark(true);
1631                         dr.setMessage(from_utf8(N_("Mark set")));
1632                 }
1633                 cur.resetAnchor();
1634                 break;
1635
1636         case LFUN_SCREEN_SHOW_CURSOR:
1637                 showCursor();
1638                 break;
1639
1640         case LFUN_SCREEN_RECENTER:
1641                 recenter();
1642                 break;
1643
1644         case LFUN_BIBTEX_DATABASE_ADD: {
1645                 Cursor tmpcur = cur;
1646                 findInset(tmpcur, BIBTEX_CODE, false);
1647                 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1648                                                 BIBTEX_CODE);
1649                 if (inset) {
1650                         if (inset->addDatabase(cmd.argument())) {
1651                                 buffer_.invalidateBibfileCache();
1652                                 dr.forceBufferUpdate();
1653                         }
1654                 }
1655                 break;
1656         }
1657
1658         case LFUN_BIBTEX_DATABASE_DEL: {
1659                 Cursor tmpcur = cur;
1660                 findInset(tmpcur, BIBTEX_CODE, false);
1661                 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1662                                                 BIBTEX_CODE);
1663                 if (inset) {
1664                         if (inset->delDatabase(cmd.argument())) {
1665                                 buffer_.invalidateBibfileCache();
1666                                 dr.forceBufferUpdate();
1667                         }
1668                 }
1669                 break;
1670         }
1671
1672         case LFUN_STATISTICS: {
1673                 DocIterator from, to;
1674                 if (cur.selection()) {
1675                         from = cur.selectionBegin();
1676                         to = cur.selectionEnd();
1677                 } else {
1678                         from = doc_iterator_begin(&buffer_);
1679                         to = doc_iterator_end(&buffer_);
1680                 }
1681                 buffer_.updateStatistics(from, to);
1682                 int const words = buffer_.wordCount();
1683                 int const chars = buffer_.charCount(false);
1684                 int const chars_blanks = buffer_.charCount(true);
1685                 docstring message;
1686                 if (cur.selection())
1687                         message = _("Statistics for the selection:");
1688                 else
1689                         message = _("Statistics for the document:");
1690                 message += "\n\n";
1691                 if (words != 1)
1692                         message += bformat(_("%1$d words"), words);
1693                 else
1694                         message += _("One word");
1695                 message += "\n";
1696                 if (chars_blanks != 1)
1697                         message += bformat(_("%1$d characters (including blanks)"),
1698                                           chars_blanks);
1699                 else
1700                         message += _("One character (including blanks)");
1701                 message += "\n";
1702                 if (chars != 1)
1703                         message += bformat(_("%1$d characters (excluding blanks)"),
1704                                           chars);
1705                 else
1706                         message += _("One character (excluding blanks)");
1707
1708                 Alert::information(_("Statistics"), message);
1709         }
1710                 break;
1711
1712         case LFUN_BUFFER_TOGGLE_COMPRESSION:
1713                 // turn compression on/off
1714                 buffer_.params().compressed = !buffer_.params().compressed;
1715                 break;
1716
1717         case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
1718                 buffer_.params().output_sync = !buffer_.params().output_sync;
1719                 break;
1720
1721         case LFUN_SCREEN_UP:
1722         case LFUN_SCREEN_DOWN: {
1723                 Point p = getPos(cur);
1724                 // This code has been commented out to enable to scroll down a
1725                 // document, even if there are large insets in it (see bug #5465).
1726                 /*if (p.y_ < 0 || p.y_ > height_) {
1727                         // The cursor is off-screen so recenter before proceeding.
1728                         showCursor();
1729                         p = getPos(cur);
1730                 }*/
1731                 int const scrolled = scroll(act == LFUN_SCREEN_UP
1732                         ? -height_ : height_);
1733                 if (act == LFUN_SCREEN_UP && scrolled > -height_)
1734                         p = Point(0, 0);
1735                 if (act == LFUN_SCREEN_DOWN && scrolled < height_)
1736                         p = Point(width_, height_);
1737                 Cursor old = cur;
1738                 bool const in_texted = cur.inTexted();
1739                 cur.setCursor(doc_iterator_begin(cur.buffer()));
1740                 cur.selHandle(false);
1741                 buffer_.changed(true);
1742                 updateHoveredInset();
1743
1744                 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_,
1745                         true, act == LFUN_SCREEN_UP);
1746                 //FIXME: what to do with cur.x_target()?
1747                 bool update = in_texted && cur.bv().checkDepm(cur, old);
1748                 cur.finishUndo();
1749
1750                 if (update || cur.mark())
1751                         dr.screenUpdate(Update::Force | Update::FitCursor);
1752                 if (update)
1753                         dr.forceBufferUpdate();
1754                 break;
1755         }
1756
1757         case LFUN_SCROLL: {
1758                 string const scroll_type = cmd.getArg(0);
1759                 int scroll_step = 0;
1760                 if (scroll_type == "line")
1761                         scroll_step = d->scrollbarParameters_.single_step;
1762                 else if (scroll_type == "page")
1763                         scroll_step = d->scrollbarParameters_.page_step;
1764                 else
1765                         return;
1766                 string const scroll_quantity = cmd.getArg(1);
1767                 if (scroll_quantity == "up")
1768                         scrollUp(scroll_step);
1769                 else if (scroll_quantity == "down")
1770                         scrollDown(scroll_step);
1771                 else {
1772                         int const scroll_value = convert<int>(scroll_quantity);
1773                         if (scroll_value)
1774                                 scroll(scroll_step * scroll_value);
1775                 }
1776                 buffer_.changed(true);
1777                 updateHoveredInset();
1778                 dr.forceBufferUpdate();
1779                 break;
1780         }
1781
1782         case LFUN_SCREEN_UP_SELECT: {
1783                 // FIXME: why is the algorithm different from LFUN_SCREEN_UP?
1784                 cur.selHandle(true);
1785                 if (isTopScreen()) {
1786                         lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1787                         cur.finishUndo();
1788                         break;
1789                 }
1790                 int y = getPos(cur).y_;
1791                 int const ymin = y - height_ + defaultRowHeight();
1792                 while (y > ymin && cur.up())
1793                         y = getPos(cur).y_;
1794
1795                 cur.finishUndo();
1796                 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1797                 break;
1798         }
1799
1800         case LFUN_SCREEN_DOWN_SELECT: {
1801                 // FIXME: why is the algorithm different from LFUN_SCREEN_DOWN?
1802                 cur.selHandle(true);
1803                 if (isBottomScreen()) {
1804                         lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1805                         cur.finishUndo();
1806                         break;
1807                 }
1808                 int y = getPos(cur).y_;
1809                 int const ymax = y + height_ - defaultRowHeight();
1810                 while (y < ymax && cur.down())
1811                         y = getPos(cur).y_;
1812
1813                 cur.finishUndo();
1814                 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1815                 break;
1816         }
1817
1818
1819         case LFUN_INSET_SELECT_ALL:
1820                 if (cur.depth() > 1
1821                     && cur.selBegin().at_begin()
1822                     && cur.selEnd().at_end()) {
1823                         // All the contents of the inset if selected.
1824                         // Select the inset from outside.
1825                         cur.pop();
1826                         cur.resetAnchor();
1827                         cur.setSelection(true);
1828                         cur.posForward();
1829                 } else if (cur.selBegin().idx() != cur.selEnd().idx()
1830                            || (cur.depth() > 1
1831                                    && cur.selBegin().at_cell_begin()
1832                                && cur.selEnd().at_cell_end())) {
1833                         // At least one complete cell is selected.
1834                         // Select all cells
1835                         cur.idx() = 0;
1836                         cur.pos() = 0;
1837                         cur.resetAnchor();
1838                         cur.setSelection(true);
1839                         cur.idx() = cur.lastidx();
1840                         cur.pos() = cur.lastpos();
1841                 } else {
1842                         // select current cell
1843                         cur.pit() = 0;
1844                         cur.pos() = 0;
1845                         cur.resetAnchor();
1846                         cur.setSelection(true);
1847                         cur.pit() = cur.lastpit();
1848                         cur.pos() = cur.lastpos();
1849                 }
1850                 dr.screenUpdate(Update::Force);
1851                 break;
1852
1853
1854         // This would be in Buffer class if only Cursor did not
1855         // require a bufferview
1856         case LFUN_INSET_FORALL: {
1857                 docstring const name = from_utf8(cmd.getArg(0));
1858                 string const commandstr = cmd.getLongArg(1);
1859                 FuncRequest const fr = lyxaction.lookupFunc(commandstr);
1860
1861                 // an arbitrary number to limit number of iterations
1862                 const int max_iter = 100000;
1863                 int iterations = 0;
1864                 Cursor & cur = d->cursor_;
1865                 Cursor const savecur = cur;
1866                 cur.reset();
1867                 if (!cur.nextInset())
1868                         cur.forwardInset();
1869                 cur.beginUndoGroup();
1870                 while(cur && iterations < max_iter) {
1871                         Inset * const ins = cur.nextInset();
1872                         if (!ins)
1873                                 break;
1874                         docstring insname = ins->layoutName();
1875                         while (!insname.empty()) {
1876                                 if (insname == name || name == from_utf8("*")) {
1877                                         cur.recordUndo();
1878                                         lyx::dispatch(fr, dr);
1879                                         ++iterations;
1880                                         break;
1881                                 }
1882                                 size_t const i = insname.rfind(':');
1883                                 if (i == string::npos)
1884                                         break;
1885                                 insname = insname.substr(0, i);
1886                         }
1887                         // if we did not delete the inset, skip it
1888                         if (!cur.nextInset() || cur.nextInset() == ins)
1889                                 cur.forwardInset();
1890                 }
1891                 cur.endUndoGroup();
1892                 cur = savecur;
1893                 cur.fixIfBroken();
1894                 dr.screenUpdate(Update::Force);
1895                 dr.forceBufferUpdate();
1896
1897                 if (iterations >= max_iter) {
1898                         dr.setError(true);
1899                         dr.setMessage(bformat(_("`inset-forall' interrupted because number of actions is larger than %1$d"), max_iter));
1900                 } else
1901                         dr.setMessage(bformat(_("Applied \"%1$s\" to %2$d insets"), from_utf8(commandstr), iterations));
1902                 break;
1903         }
1904
1905
1906         case LFUN_BRANCH_ADD_INSERT: {
1907                 docstring branch_name = from_utf8(cmd.getArg(0));
1908                 if (branch_name.empty())
1909                         if (!Alert::askForText(branch_name, _("Branch name")) ||
1910                                                 branch_name.empty())
1911                                 break;
1912
1913                 DispatchResult drtmp;
1914                 buffer_.dispatch(FuncRequest(LFUN_BRANCH_ADD, branch_name), drtmp);
1915                 if (drtmp.error()) {
1916                         Alert::warning(_("Branch already exists"), drtmp.message());
1917                         break;
1918                 }
1919                 BranchList & branch_list = buffer_.params().branchlist();
1920                 vector<docstring> const branches =
1921                         getVectorFromString(branch_name, branch_list.separator());
1922                 for (vector<docstring>::const_iterator it = branches.begin();
1923                      it != branches.end(); ++it) {
1924                         branch_name = *it;
1925                         lyx::dispatch(FuncRequest(LFUN_BRANCH_INSERT, branch_name));
1926                 }
1927                 break;
1928         }
1929
1930         case LFUN_KEYMAP_OFF:
1931                 getIntl().keyMapOn(false);
1932                 break;
1933
1934         case LFUN_KEYMAP_PRIMARY:
1935                 getIntl().keyMapPrim();
1936                 break;
1937
1938         case LFUN_KEYMAP_SECONDARY:
1939                 getIntl().keyMapSec();
1940                 break;
1941
1942         case LFUN_KEYMAP_TOGGLE:
1943                 getIntl().toggleKeyMap();
1944                 break;
1945
1946         case LFUN_DIALOG_SHOW_NEW_INSET: {
1947                 string const name = cmd.getArg(0);
1948                 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
1949                 if (decodeInsetParam(name, data, buffer_))
1950                         lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
1951                 else
1952                         lyxerr << "Inset type '" << name <<
1953                         "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" <<  endl;
1954                 break;
1955         }
1956
1957         case LFUN_CITATION_INSERT: {
1958                 if (argument.empty()) {
1959                         lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
1960                         break;
1961                 }
1962                 // we can have one optional argument, delimited by '|'
1963                 // citation-insert <key>|<text_before>
1964                 // this should be enhanced to also support text_after
1965                 // and citation style
1966                 string arg = argument;
1967                 string opt1;
1968                 if (contains(argument, "|")) {
1969                         arg = token(argument, '|', 0);
1970                         opt1 = token(argument, '|', 1);
1971                 }
1972
1973                 // if our cursor is directly in front of or behind a citation inset,
1974                 // we will instead add the new key to it.
1975                 Inset * inset = cur.nextInset();
1976                 if (!inset || inset->lyxCode() != CITE_CODE)
1977                         inset = cur.prevInset();
1978                 if (inset && inset->lyxCode() == CITE_CODE) {
1979                         InsetCitation * icite = static_cast<InsetCitation *>(inset);
1980                         if (icite->addKey(arg)) {
1981                                 dr.forceBufferUpdate();
1982                                 dr.screenUpdate(Update::FitCursor | Update::SinglePar);
1983                                 if (!opt1.empty())
1984                                         LYXERR0("Discarding optional argument to citation-insert.");
1985                         }
1986                         dispatched = true;
1987                         break;
1988                 }
1989                 InsetCommandParams icp(CITE_CODE);
1990                 icp["key"] = from_utf8(arg);
1991                 if (!opt1.empty())
1992                         icp["before"] = from_utf8(opt1);
1993                 string icstr = InsetCommand::params2string(icp);
1994                 FuncRequest fr(LFUN_INSET_INSERT, icstr);
1995                 lyx::dispatch(fr);
1996                 break;
1997         }
1998
1999         case LFUN_INSET_APPLY: {
2000                 string const name = cmd.getArg(0);
2001                 Inset * inset = editedInset(name);
2002                 if (!inset) {
2003                         FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
2004                         lyx::dispatch(fr);
2005                         break;
2006                 }
2007                 // put cursor in front of inset.
2008                 if (!setCursorFromInset(inset)) {
2009                         LASSERT(false, break);
2010                 }
2011                 cur.recordUndo();
2012                 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
2013                 inset->dispatch(cur, fr);
2014                 dr.screenUpdate(cur.result().screenUpdate());
2015                 if (cur.result().needBufferUpdate())
2016                         dr.forceBufferUpdate();
2017                 break;
2018         }
2019
2020         // FIXME:
2021         // The change of language of buffer belongs to the Buffer class.
2022         // We have to do it here because we need a cursor for Undo.
2023         // When Undo::recordUndoBufferParams() is implemented someday
2024         // LFUN_BUFFER_LANGUAGE should be handled by the Buffer class.
2025         case LFUN_BUFFER_LANGUAGE: {
2026                 Language const * oldL = buffer_.params().language;
2027                 Language const * newL = languages.getLanguage(argument);
2028                 if (!newL || oldL == newL)
2029                         break;
2030                 if (oldL->rightToLeft() == newL->rightToLeft()) {
2031                         cur.recordUndoFullDocument();
2032                         buffer_.changeLanguage(oldL, newL);
2033                         cur.setCurrentFont();
2034                         dr.forceBufferUpdate();
2035                 }
2036                 break;
2037         }
2038
2039         case LFUN_FILE_INSERT_PLAINTEXT_PARA:
2040         case LFUN_FILE_INSERT_PLAINTEXT: {
2041                 bool const as_paragraph = (act == LFUN_FILE_INSERT_PLAINTEXT_PARA);
2042                 string const fname = to_utf8(cmd.argument());
2043                 if (!FileName::isAbsolute(fname))
2044                         dr.setMessage(_("Absolute filename expected."));
2045                 else
2046                         insertPlaintextFile(FileName(fname), as_paragraph);
2047                 break;
2048         }
2049
2050         default:
2051                 // OK, so try the Buffer itself...
2052                 buffer_.dispatch(cmd, dr);
2053                 dispatched = dr.dispatched();
2054                 break;
2055         }
2056
2057         buffer_.undo().endUndoGroup();
2058         dr.dispatched(dispatched);
2059 }
2060
2061
2062 docstring const BufferView::requestSelection()
2063 {
2064         Cursor & cur = d->cursor_;
2065
2066         LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
2067         if (!cur.selection()) {
2068                 d->xsel_cache_.set = false;
2069                 return docstring();
2070         }
2071
2072         LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
2073         if (!d->xsel_cache_.set ||
2074             cur.top() != d->xsel_cache_.cursor ||
2075             cur.realAnchor().top() != d->xsel_cache_.anchor)
2076         {
2077                 d->xsel_cache_.cursor = cur.top();
2078                 d->xsel_cache_.anchor = cur.realAnchor().top();
2079                 d->xsel_cache_.set = cur.selection();
2080                 return cur.selectionAsString(false);
2081         }
2082         return docstring();
2083 }
2084
2085
2086 void BufferView::clearSelection()
2087 {
2088         d->cursor_.clearSelection();
2089         // Clear the selection buffer. Otherwise a subsequent
2090         // middle-mouse-button paste would use the selection buffer,
2091         // not the more current external selection.
2092         cap::clearSelection();
2093         d->xsel_cache_.set = false;
2094         // The buffer did not really change, but this causes the
2095         // redraw we need because we cleared the selection above.
2096         buffer_.changed(false);
2097 }
2098
2099
2100 void BufferView::resize(int width, int height)
2101 {
2102         // Update from work area
2103         width_ = width;
2104         height_ = height;
2105
2106         // Clear the paragraph height cache.
2107         d->par_height_.clear();
2108         // Redo the metrics.
2109         updateMetrics();
2110 }
2111
2112
2113 Inset const * BufferView::getCoveringInset(Text const & text,
2114                 int x, int y) const
2115 {
2116         TextMetrics & tm = d->text_metrics_[&text];
2117         Inset * inset = tm.checkInsetHit(x, y);
2118         if (!inset)
2119                 return 0;
2120
2121         if (!inset->descendable(*this))
2122                 // No need to go further down if the inset is not
2123                 // descendable.
2124                 return inset;
2125
2126         size_t cell_number = inset->nargs();
2127         // Check all the inner cell.
2128         for (size_t i = 0; i != cell_number; ++i) {
2129                 Text const * inner_text = inset->getText(i);
2130                 if (inner_text) {
2131                         // Try deeper.
2132                         Inset const * inset_deeper =
2133                                 getCoveringInset(*inner_text, x, y);
2134                         if (inset_deeper)
2135                                 return inset_deeper;
2136                 }
2137         }
2138
2139         return inset;
2140 }
2141
2142
2143 void BufferView::updateHoveredInset() const
2144 {
2145         // Get inset under mouse, if there is one.
2146         int const x = d->mouse_position_cache_.x_;
2147         int const y = d->mouse_position_cache_.y_;
2148         Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
2149
2150         d->clickable_inset_ = covering_inset && covering_inset->clickable(x, y);
2151
2152         if (covering_inset == d->last_inset_)
2153                 // Same inset, no need to do anything...
2154                 return;
2155
2156         bool need_redraw = false;
2157         if (d->last_inset_) {
2158                 // Remove the hint on the last hovered inset (if any).
2159                 need_redraw |= d->last_inset_->setMouseHover(this, false);
2160                 d->last_inset_ = 0;
2161         }
2162
2163         if (covering_inset && covering_inset->setMouseHover(this, true)) {
2164                 need_redraw = true;
2165                 // Only the insets that accept the hover state, do
2166                 // clear the last_inset_, so only set the last_inset_
2167                 // member if the hovered setting is accepted.
2168                 d->last_inset_ = covering_inset;
2169         }
2170
2171         if (need_redraw) {
2172                 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
2173                                 << d->mouse_position_cache_.x_ << ", "
2174                                 << d->mouse_position_cache_.y_ << ")");
2175
2176                 d->update_strategy_ = DecorationUpdate;
2177
2178                 // This event (moving without mouse click) is not passed further.
2179                 // This should be changed if it is further utilized.
2180                 buffer_.changed(false);
2181         }
2182 }
2183
2184
2185 void BufferView::clearLastInset(Inset * inset) const
2186 {
2187         if (d->last_inset_ != inset) {
2188                 LYXERR0("Wrong last_inset!");
2189                 LATTEST(false);
2190         }
2191         d->last_inset_ = 0;
2192 }
2193
2194
2195 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
2196 {
2197         //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
2198
2199         // This is only called for mouse related events including
2200         // LFUN_FILE_OPEN generated by drag-and-drop.
2201         FuncRequest cmd = cmd0;
2202
2203         Cursor old = cursor();
2204         Cursor cur(*this);
2205         cur.push(buffer_.inset());
2206         cur.setSelection(d->cursor_.selection());
2207
2208         // Either the inset under the cursor or the
2209         // surrounding Text will handle this event.
2210
2211         // make sure we stay within the screen...
2212         cmd.set_y(min(max(cmd.y(), -1), height_));
2213
2214         d->mouse_position_cache_.x_ = cmd.x();
2215         d->mouse_position_cache_.y_ = cmd.y();
2216
2217         if (cmd.action() == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
2218                 updateHoveredInset();
2219                 return;
2220         }
2221
2222         // Build temporary cursor.
2223         Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x(), cmd.y());
2224
2225         // Put anchor at the same position.
2226         cur.resetAnchor();
2227
2228         cur.beginUndoGroup();
2229
2230         // Try to dispatch to an non-editable inset near this position
2231         // via the temp cursor. If the inset wishes to change the real
2232         // cursor it has to do so explicitly by using
2233         //  cur.bv().cursor() = cur;  (or similar)
2234         if (inset)
2235                 inset->dispatch(cur, cmd);
2236
2237         // Now dispatch to the temporary cursor. If the real cursor should
2238         // be modified, the inset's dispatch has to do so explicitly.
2239         if (!inset || !cur.result().dispatched())
2240                 cur.dispatch(cmd);
2241
2242         cur.endUndoGroup();
2243
2244         // Notify left insets
2245         if (cur != old) {
2246                 bool badcursor = old.fixIfBroken() | cur.fixIfBroken();
2247                 badcursor |= notifyCursorLeavesOrEnters(old, cur);
2248                 if (badcursor)
2249                         cursor().fixIfBroken();
2250         }
2251
2252         // Do we have a selection?
2253         theSelection().haveSelection(cursor().selection());
2254
2255         if (cur.needBufferUpdate()) {
2256                 cur.clearBufferUpdate();
2257                 buffer().updateBuffer();
2258         }
2259
2260         // If the command has been dispatched,
2261         if (cur.result().dispatched() || cur.result().screenUpdate())
2262                 processUpdateFlags(cur.result().screenUpdate());
2263 }
2264
2265
2266 int BufferView::minVisiblePart()
2267 {
2268         return 2 * defaultRowHeight();
2269 }
2270
2271
2272 int BufferView::scroll(int y)
2273 {
2274         if (y > 0)
2275                 return scrollDown(y);
2276         if (y < 0)
2277                 return scrollUp(-y);
2278         return 0;
2279 }
2280
2281
2282 int BufferView::scrollDown(int offset)
2283 {
2284         Text * text = &buffer_.text();
2285         TextMetrics & tm = d->text_metrics_[text];
2286         int const ymax = height_ + offset;
2287         while (true) {
2288                 pair<pit_type, ParagraphMetrics const *> last = tm.last();
2289                 int bottom_pos = last.second->position() + last.second->descent();
2290                 if (lyxrc.scroll_below_document)
2291                         bottom_pos += height_ - minVisiblePart();
2292                 if (last.first + 1 == int(text->paragraphs().size())) {
2293                         if (bottom_pos <= height_)
2294                                 return 0;
2295                         offset = min(offset, bottom_pos - height_);
2296                         break;
2297                 }
2298                 if (bottom_pos > ymax)
2299                         break;
2300                 tm.newParMetricsDown();
2301         }
2302         d->anchor_ypos_ -= offset;
2303         return -offset;
2304 }
2305
2306
2307 int BufferView::scrollUp(int offset)
2308 {
2309         Text * text = &buffer_.text();
2310         TextMetrics & tm = d->text_metrics_[text];
2311         int ymin = - offset;
2312         while (true) {
2313                 pair<pit_type, ParagraphMetrics const *> first = tm.first();
2314                 int top_pos = first.second->position() - first.second->ascent();
2315                 if (first.first == 0) {
2316                         if (top_pos >= 0)
2317                                 return 0;
2318                         offset = min(offset, - top_pos);
2319                         break;
2320                 }
2321                 if (top_pos < ymin)
2322                         break;
2323                 tm.newParMetricsUp();
2324         }
2325         d->anchor_ypos_ += offset;
2326         return offset;
2327 }
2328
2329
2330 void BufferView::setCursorFromRow(int row)
2331 {
2332         int tmpid;
2333         int tmppos;
2334         pit_type newpit = 0;
2335         pos_type newpos = 0;
2336
2337         buffer_.texrow().getIdFromRow(row, tmpid, tmppos);
2338
2339         bool posvalid = (tmpid != -1);
2340         if (posvalid) {
2341                 // we need to make sure that the row and position
2342                 // we got back are valid, because the buffer may well
2343                 // have changed since we last generated the LaTeX.
2344                 DocIterator dit = buffer_.getParFromID(tmpid);
2345                 if (dit == doc_iterator_end(&buffer_))
2346                         posvalid = false;
2347                 else if (dit.depth() > 1) {
2348                         // We are in an inset.
2349                         pos_type lastpos = dit.lastpos();
2350                         dit.pos() = tmppos > lastpos ? lastpos : tmppos;
2351                         setCursor(dit);
2352                         recenter();
2353                         return;
2354                 } else {
2355                         newpit = dit.pit();
2356                         // now have to check pos.
2357                         newpos = tmppos;
2358                         Paragraph const & par = buffer_.text().getPar(newpit);
2359                         if (newpos > par.size()) {
2360                                 LYXERR0("Requested position no longer valid.");
2361                                 newpos = par.size() - 1;
2362                         }
2363                 }
2364         }
2365         if (!posvalid) {
2366                 frontend::Alert::error(_("Inverse Search Failed"),
2367                         _("Invalid position requested by inverse search.\n"
2368                     "You need to update the viewed document."));
2369                 return;
2370         }
2371         d->cursor_.reset();
2372         buffer_.text().setCursor(d->cursor_, newpit, newpos);
2373         d->cursor_.setSelection(false);
2374         d->cursor_.resetAnchor();
2375         recenter();
2376 }
2377
2378
2379 bool BufferView::setCursorFromInset(Inset const * inset)
2380 {
2381         // are we already there?
2382         if (cursor().nextInset() == inset)
2383                 return true;
2384
2385         // Inset is not at cursor position. Find it in the document.
2386         Cursor cur(*this);
2387         cur.reset();
2388         while (cur && cur.nextInset() != inset)
2389                 cur.forwardInset();
2390
2391         if (cur) {
2392                 setCursor(cur);
2393                 return true;
2394         }
2395         return false;
2396 }
2397
2398
2399 void BufferView::gotoLabel(docstring const & label)
2400 {
2401         ListOfBuffers bufs = buffer().allRelatives();
2402         ListOfBuffers::iterator it = bufs.begin();
2403         for (; it != bufs.end(); ++it) {
2404                 Buffer const * buf = *it;
2405
2406                 // find label
2407                 Toc & toc = buf->tocBackend().toc("label");
2408                 TocIterator toc_it = toc.begin();
2409                 TocIterator end = toc.end();
2410                 for (; toc_it != end; ++toc_it) {
2411                         if (label == toc_it->str()) {
2412                                 lyx::dispatch(toc_it->action());
2413                                 return;
2414                         }
2415                 }
2416         }
2417 }
2418
2419
2420 TextMetrics const & BufferView::textMetrics(Text const * t) const
2421 {
2422         return const_cast<BufferView *>(this)->textMetrics(t);
2423 }
2424
2425
2426 TextMetrics & BufferView::textMetrics(Text const * t)
2427 {
2428         LBUFERR(t);
2429         TextMetricsCache::iterator tmc_it  = d->text_metrics_.find(t);
2430         if (tmc_it == d->text_metrics_.end()) {
2431                 tmc_it = d->text_metrics_.insert(
2432                         make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
2433         }
2434         return tmc_it->second;
2435 }
2436
2437
2438 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
2439                 pit_type pit) const
2440 {
2441         return textMetrics(t).parMetrics(pit);
2442 }
2443
2444
2445 int BufferView::workHeight() const
2446 {
2447         return height_;
2448 }
2449
2450
2451 void BufferView::setCursor(DocIterator const & dit)
2452 {
2453         d->cursor_.reset();
2454         size_t const n = dit.depth();
2455         for (size_t i = 0; i < n; ++i)
2456                 dit[i].inset().edit(d->cursor_, true);
2457
2458         d->cursor_.setCursor(dit);
2459         d->cursor_.setSelection(false);
2460         // FIXME
2461         // It seems on general grounds as if this is probably needed, but
2462         // it is not yet clear.
2463         // See bug #7394 and r38388.
2464         // d->cursor.resetAnchor();
2465 }
2466
2467
2468 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
2469 {
2470         // Would be wrong to delete anything if we have a selection.
2471         if (cur.selection())
2472                 return false;
2473
2474         bool need_anchor_change = false;
2475         bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
2476                 need_anchor_change);
2477
2478         if (need_anchor_change)
2479                 cur.resetAnchor();
2480
2481         if (!changed)
2482                 return false;
2483
2484         d->cursor_ = cur;
2485
2486         // we would rather not do this here, but it needs to be done before
2487         // the changed() signal is sent.
2488         buffer_.updateBuffer();
2489
2490         buffer_.changed(true);
2491         return true;
2492 }
2493
2494
2495 bool BufferView::mouseSetCursor(Cursor & cur, bool select)
2496 {
2497         LASSERT(&cur.bv() == this, return false);
2498
2499         if (!select)
2500                 // this event will clear selection so we save selection for
2501                 // persistent selection
2502                 cap::saveSelection(cursor());
2503
2504         d->cursor_.macroModeClose();
2505         // If a macro has been finalized, the cursor might have been broken
2506         cur.fixIfBroken();
2507
2508         // Has the cursor just left the inset?
2509         bool const leftinset = (&d->cursor_.inset() != &cur.inset());
2510         if (leftinset)
2511                 d->cursor_.fixIfBroken();
2512
2513         // FIXME: shift-mouse selection doesn't work well across insets.
2514         bool const do_selection =
2515                         select && &d->cursor_.normalAnchor().inset() == &cur.inset();
2516
2517         // do the dEPM magic if needed
2518         // FIXME: (1) move this to InsetText::notifyCursorLeaves?
2519         // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
2520         // the leftinset bool would not be necessary (badcursor instead).
2521         bool update = leftinset;
2522         if (!do_selection && d->cursor_.inTexted())
2523                 update |= checkDepm(cur, d->cursor_);
2524
2525         if (!do_selection)
2526                 d->cursor_.resetAnchor();
2527         d->cursor_.setCursor(cur);
2528         d->cursor_.boundary(cur.boundary());
2529         if (do_selection)
2530                 d->cursor_.setSelection();
2531         else
2532                 d->cursor_.clearSelection();
2533
2534         d->cursor_.finishUndo();
2535         d->cursor_.setCurrentFont();
2536         if (update)
2537                 cur.forceBufferUpdate();
2538         return update;
2539 }
2540
2541
2542 void BufferView::putSelectionAt(DocIterator const & cur,
2543                                 int length, bool backwards)
2544 {
2545         d->cursor_.clearSelection();
2546
2547         setCursor(cur);
2548
2549         if (length) {
2550                 if (backwards) {
2551                         d->cursor_.pos() += length;
2552                         d->cursor_.setSelection(d->cursor_, -length);
2553                 } else
2554                         d->cursor_.setSelection(d->cursor_, length);
2555         }
2556 }
2557
2558
2559 bool BufferView::selectIfEmpty(DocIterator & cur)
2560 {
2561         if ((cur.inTexted() && !cur.paragraph().empty())
2562             || (cur.inMathed() && !cur.cell().empty()))
2563                 return false;
2564
2565         pit_type const beg_pit = cur.pit();
2566         if (beg_pit > 0) {
2567                 // The paragraph associated to this item isn't
2568                 // the first one, so it can be selected
2569                 cur.backwardPos();
2570         } else {
2571                 // We have to resort to select the space between the
2572                 // end of this item and the begin of the next one
2573                 cur.forwardPos();
2574         }
2575         if (cur.empty()) {
2576                 // If it is the only item in the document,
2577                 // nothing can be selected
2578                 return false;
2579         }
2580         pit_type const end_pit = cur.pit();
2581         pos_type const end_pos = cur.pos();
2582         d->cursor_.clearSelection();
2583         d->cursor_.reset();
2584         d->cursor_.setCursor(cur);
2585         d->cursor_.pit() = beg_pit;
2586         d->cursor_.pos() = 0;
2587         d->cursor_.setSelection(false);
2588         d->cursor_.resetAnchor();
2589         d->cursor_.pit() = end_pit;
2590         d->cursor_.pos() = end_pos;
2591         d->cursor_.setSelection();
2592         return true;
2593 }
2594
2595
2596 Cursor & BufferView::cursor()
2597 {
2598         return d->cursor_;
2599 }
2600
2601
2602 Cursor const & BufferView::cursor() const
2603 {
2604         return d->cursor_;
2605 }
2606
2607
2608 pit_type BufferView::anchor_ref() const
2609 {
2610         return d->anchor_pit_;
2611 }
2612
2613
2614 bool BufferView::singleParUpdate()
2615 {
2616         Text & buftext = buffer_.text();
2617         pit_type const bottom_pit = d->cursor_.bottom().pit();
2618         TextMetrics & tm = textMetrics(&buftext);
2619         int old_height = tm.parMetrics(bottom_pit).height();
2620
2621         // make sure inline completion pointer is ok
2622         if (d->inlineCompletionPos_.fixIfBroken())
2623                 d->inlineCompletionPos_ = DocIterator();
2624
2625         // In Single Paragraph mode, rebreak only
2626         // the (main text, not inset!) paragraph containing the cursor.
2627         // (if this paragraph contains insets etc., rebreaking will
2628         // recursively descend)
2629         tm.redoParagraph(bottom_pit);
2630         ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
2631         if (pm.height() != old_height)
2632                 // Paragraph height has changed so we cannot proceed to
2633                 // the singlePar optimisation.
2634                 return false;
2635
2636         d->update_strategy_ = SingleParUpdate;
2637
2638         LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
2639                 << " y2: " << pm.position() + pm.descent()
2640                 << " pit: " << bottom_pit
2641                 << " singlepar: 1");
2642         return true;
2643 }
2644
2645
2646 void BufferView::updateMetrics()
2647 {
2648         if (height_ == 0 || width_ == 0)
2649                 return;
2650
2651         Text & buftext = buffer_.text();
2652         pit_type const npit = int(buftext.paragraphs().size());
2653
2654         // Clear out the position cache in case of full screen redraw,
2655         d->coord_cache_.clear();
2656
2657         // Clear out paragraph metrics to avoid having invalid metrics
2658         // in the cache from paragraphs not relayouted below
2659         // The complete text metrics will be redone.
2660         d->text_metrics_.clear();
2661
2662         TextMetrics & tm = textMetrics(&buftext);
2663
2664         // make sure inline completion pointer is ok
2665         if (d->inlineCompletionPos_.fixIfBroken())
2666                 d->inlineCompletionPos_ = DocIterator();
2667
2668         if (d->anchor_pit_ >= npit)
2669                 // The anchor pit must have been deleted...
2670                 d->anchor_pit_ = npit - 1;
2671
2672         // Rebreak anchor paragraph.
2673         tm.redoParagraph(d->anchor_pit_);
2674         ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
2675
2676         // position anchor
2677         if (d->anchor_pit_ == 0) {
2678                 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
2679
2680                 // Complete buffer visible? Then it's easy.
2681                 if (scrollRange == 0)
2682                         d->anchor_ypos_ = anchor_pm.ascent();
2683
2684                 // FIXME: Some clever handling needed to show
2685                 // the _first_ paragraph up to the top if the cursor is
2686                 // in the first line.
2687         }
2688         anchor_pm.setPosition(d->anchor_ypos_);
2689
2690         LYXERR(Debug::PAINTING, "metrics: "
2691                 << " anchor pit = " << d->anchor_pit_
2692                 << " anchor ypos = " << d->anchor_ypos_);
2693
2694         // Redo paragraphs above anchor if necessary.
2695         int y1 = d->anchor_ypos_ - anchor_pm.ascent();
2696         // We are now just above the anchor paragraph.
2697         pit_type pit1 = d->anchor_pit_ - 1;
2698         for (; pit1 >= 0 && y1 >= 0; --pit1) {
2699                 tm.redoParagraph(pit1);
2700                 ParagraphMetrics & pm = tm.par_metrics_[pit1];
2701                 y1 -= pm.descent();
2702                 // Save the paragraph position in the cache.
2703                 pm.setPosition(y1);
2704                 y1 -= pm.ascent();
2705         }
2706
2707         // Redo paragraphs below the anchor if necessary.
2708         int y2 = d->anchor_ypos_ + anchor_pm.descent();
2709         // We are now just below the anchor paragraph.
2710         pit_type pit2 = d->anchor_pit_ + 1;
2711         for (; pit2 < npit && y2 <= height_; ++pit2) {
2712                 tm.redoParagraph(pit2);
2713                 ParagraphMetrics & pm = tm.par_metrics_[pit2];
2714                 y2 += pm.ascent();
2715                 // Save the paragraph position in the cache.
2716                 pm.setPosition(y2);
2717                 y2 += pm.descent();
2718         }
2719
2720         LYXERR(Debug::PAINTING, "Metrics: "
2721                 << " anchor pit = " << d->anchor_pit_
2722                 << " anchor ypos = " << d->anchor_ypos_
2723                 << " y1 = " << y1
2724                 << " y2 = " << y2
2725                 << " pit1 = " << pit1
2726                 << " pit2 = " << pit2);
2727
2728         d->update_strategy_ = FullScreenUpdate;
2729
2730         if (lyxerr.debugging(Debug::WORKAREA)) {
2731                 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
2732                 d->coord_cache_.dump();
2733         }
2734 }
2735
2736
2737 void BufferView::insertLyXFile(FileName const & fname)
2738 {
2739         LASSERT(d->cursor_.inTexted(), return);
2740
2741         // Get absolute path of file and add ".lyx"
2742         // to the filename if necessary
2743         FileName filename = fileSearch(string(), fname.absFileName(), "lyx");
2744
2745         docstring const disp_fn = makeDisplayPath(filename.absFileName());
2746         // emit message signal.
2747         message(bformat(_("Inserting document %1$s..."), disp_fn));
2748
2749         docstring res;
2750         Buffer buf(filename.absFileName(), false);
2751         if (buf.loadLyXFile() == Buffer::ReadSuccess) {
2752                 ErrorList & el = buffer_.errorList("Parse");
2753                 // Copy the inserted document error list into the current buffer one.
2754                 el = buf.errorList("Parse");
2755                 buffer_.undo().recordUndo(d->cursor_);
2756                 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
2757                                              buf.params().documentClassPtr(), el);
2758                 res = _("Document %1$s inserted.");
2759         } else {
2760                 res = _("Could not insert document %1$s");
2761         }
2762
2763         buffer_.changed(true);
2764         // emit message signal.
2765         message(bformat(res, disp_fn));
2766 }
2767
2768
2769 Point BufferView::coordOffset(DocIterator const & dit) const
2770 {
2771         int x = 0;
2772         int y = 0;
2773         int lastw = 0;
2774
2775         // Addup contribution of nested insets, from inside to outside,
2776         // keeping the outer paragraph for a special handling below
2777         for (size_t i = dit.depth() - 1; i >= 1; --i) {
2778                 CursorSlice const & sl = dit[i];
2779                 int xx = 0;
2780                 int yy = 0;
2781
2782                 // get relative position inside sl.inset()
2783                 sl.inset().cursorPos(*this, sl, dit.boundary() && (i + 1 == dit.depth()), xx, yy);
2784
2785                 // Make relative position inside of the edited inset relative to sl.inset()
2786                 x += xx;
2787                 y += yy;
2788
2789                 // In case of an RTL inset, the edited inset will be positioned to the left
2790                 // of xx:yy
2791                 if (sl.text()) {
2792                         bool boundary_i = dit.boundary() && i + 1 == dit.depth();
2793                         bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2794                         if (rtl)
2795                                 x -= lastw;
2796                 }
2797
2798                 // remember width for the case that sl.inset() is positioned in an RTL inset
2799                 if (i && dit[i - 1].text()) {
2800                         // If this Inset is inside a Text Inset, retrieve the Dimension
2801                         // from the containing text instead of using Inset::dimension() which
2802                         // might not be implemented.
2803                         // FIXME (Abdel 23/09/2007): this is a bit messy because of the
2804                         // elimination of Inset::dim_ cache. This coordOffset() method needs
2805                         // to be rewritten in light of the new design.
2806                         Dimension const & dim = parMetrics(dit[i - 1].text(),
2807                                 dit[i - 1].pit()).insetDimension(&sl.inset());
2808                         lastw = dim.wid;
2809                 } else {
2810                         Dimension const dim = sl.inset().dimension(*this);
2811                         lastw = dim.wid;
2812                 }
2813
2814                 //lyxerr << "Cursor::getPos, i: "
2815                 // << i << " x: " << xx << " y: " << y << endl;
2816         }
2817
2818         // Add contribution of initial rows of outermost paragraph
2819         CursorSlice const & sl = dit[0];
2820         TextMetrics const & tm = textMetrics(sl.text());
2821         ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2822
2823         LBUFERR(!pm.rows().empty());
2824         y -= pm.rows()[0].ascent();
2825 #if 1
2826         // FIXME: document this mess
2827         size_t rend;
2828         if (sl.pos() > 0 && dit.depth() == 1) {
2829                 int pos = sl.pos();
2830                 if (pos && dit.boundary())
2831                         --pos;
2832 //              lyxerr << "coordOffset: boundary:" << dit.boundary() << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
2833                 rend = pm.pos2row(pos);
2834         } else
2835                 rend = pm.pos2row(sl.pos());
2836 #else
2837         size_t rend = pm.pos2row(sl.pos());
2838 #endif
2839         for (size_t rit = 0; rit != rend; ++rit)
2840                 y += pm.rows()[rit].height();
2841         y += pm.rows()[rend].ascent();
2842
2843         TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
2844
2845         // Make relative position from the nested inset now bufferview absolute.
2846         int xx = bottom_tm.cursorX(dit.bottom(), dit.boundary() && dit.depth() == 1);
2847         x += xx;
2848
2849         // In the RTL case place the nested inset at the left of the cursor in
2850         // the outer paragraph
2851         bool boundary_1 = dit.boundary() && 1 == dit.depth();
2852         bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
2853         if (rtl)
2854                 x -= lastw;
2855
2856         return Point(x, y);
2857 }
2858
2859
2860 Point BufferView::getPos(DocIterator const & dit) const
2861 {
2862         if (!paragraphVisible(dit))
2863                 return Point(-1, -1);
2864
2865         CursorSlice const & bot = dit.bottom();
2866         TextMetrics const & tm = textMetrics(bot.text());
2867
2868         // offset from outer paragraph
2869         Point p = coordOffset(dit);
2870         p.y_ += tm.parMetrics(bot.pit()).position();
2871         return p;
2872 }
2873
2874
2875 bool BufferView::paragraphVisible(DocIterator const & dit) const
2876 {
2877         CursorSlice const & bot = dit.bottom();
2878         TextMetrics const & tm = textMetrics(bot.text());
2879
2880         return tm.contains(bot.pit());
2881 }
2882
2883
2884 void BufferView::cursorPosAndHeight(Point & p, int & h) const
2885 {
2886         Cursor const & cur = cursor();
2887         Font const font = cur.getFont();
2888         frontend::FontMetrics const & fm = theFontMetrics(font);
2889         int const asc = fm.maxAscent();
2890         int const des = fm.maxDescent();
2891         h = asc + des;
2892         p = getPos(cur);
2893         p.y_ -= asc;
2894 }
2895
2896
2897 bool BufferView::cursorInView(Point const & p, int h) const
2898 {
2899         Cursor const & cur = cursor();
2900         // does the cursor touch the screen ?
2901         if (p.y_ + h < 0 || p.y_ >= workHeight() || !paragraphVisible(cur))
2902                 return false;
2903         return true;
2904 }
2905
2906
2907 int BufferView::horizScrollOffset() const
2908 {
2909         return d->horiz_scroll_offset_;
2910 }
2911
2912
2913 CursorSlice const & BufferView::currentRowSlice() const
2914 {
2915         return d->current_row_slice_;
2916 }
2917
2918
2919 CursorSlice const & BufferView::lastRowSlice() const
2920 {
2921         return d->last_row_slice_;
2922 }
2923
2924
2925 void BufferView::setCurrentRowSlice(CursorSlice const & rowSlice)
2926 {
2927         // nothing to do if the cursor was already on this row
2928         if (d->current_row_slice_ == rowSlice) {
2929                 d->last_row_slice_ = CursorSlice();
2930                 return;
2931         }
2932
2933         // if the (previous) current row was scrolled, we have to
2934         // remember it in order to repaint it next time.
2935         if (d->horiz_scroll_offset_ != 0)
2936                 d->last_row_slice_ = d->current_row_slice_;
2937         else
2938                 d->last_row_slice_ = CursorSlice();
2939
2940         // Since we changed row, the scroll offset is not valid anymore
2941         d->horiz_scroll_offset_ = 0;
2942         d->current_row_slice_ = rowSlice;
2943 }
2944
2945
2946 void BufferView::checkCursorScrollOffset(PainterInfo & pi)
2947 {
2948         CursorSlice rowSlice = d->cursor_.bottom();
2949         TextMetrics const & tm = textMetrics(rowSlice.text());
2950
2951         // Stop if metrics have not been computed yet, since it means
2952         // that there is nothing to do.
2953         if (!tm.contains(rowSlice.pit()))
2954                 return;
2955         ParagraphMetrics const & pm = tm.parMetrics(rowSlice.pit());
2956         Row const & row = pm.getRow(rowSlice.pos(),
2957                                     d->cursor_.boundary()
2958                                     && rowSlice == d->cursor_.top());
2959         rowSlice.pos() = row.pos();
2960
2961         // Set the row on which the cursor lives.
2962         setCurrentRowSlice(rowSlice);
2963
2964         // Force the recomputation of inset positions
2965         bool const drawing = pi.pain.isDrawingEnabled();
2966         pi.pain.setDrawingEnabled(false);
2967         // No need to care about vertical position.
2968         RowPainter rp(pi, buffer().text(), d->cursor_.bottom().pit(), row,
2969                       -d->horiz_scroll_offset_, 0);
2970         rp.paintText();
2971         pi.pain.setDrawingEnabled(drawing);
2972
2973         // Current x position of the cursor in pixels
2974         int const cur_x = getPos(d->cursor_).x_;
2975
2976         // Horizontal scroll offset of the cursor row in pixels
2977         int offset = d->horiz_scroll_offset_;
2978         int const MARGIN = Length(2, Length::EM).inPixels(workWidth());
2979         if (cur_x < offset + MARGIN) {
2980                 // scroll right
2981                 offset = cur_x - MARGIN;
2982         } else if (cur_x > offset + workWidth() - MARGIN) {
2983                 // scroll left
2984                 offset = cur_x - workWidth() + MARGIN;
2985         }
2986
2987         if (offset < row.left_margin || row.width() <= workWidth())
2988                 offset = 0;
2989
2990         if (offset != d->horiz_scroll_offset_)
2991                 LYXERR(Debug::PAINTING, "Horiz. scroll offset changed from "
2992                        << d->horiz_scroll_offset_ << " to " << offset);
2993
2994         if (d->update_strategy_ == NoScreenUpdate
2995             && (offset != d->horiz_scroll_offset_
2996                 || !d->last_row_slice_.empty())) {
2997                 // FIXME: if one uses SingleParUpdate, then home/end
2998                 // will not work on long rows. Why?
2999                 d->update_strategy_ = FullScreenUpdate;
3000         }
3001
3002         d->horiz_scroll_offset_ = offset;
3003 }
3004
3005
3006 void BufferView::draw(frontend::Painter & pain)
3007 {
3008         if (height_ == 0 || width_ == 0)
3009                 return;
3010         LYXERR(Debug::PAINTING, "\t\t*** START DRAWING ***");
3011
3012         Text & text = buffer_.text();
3013         TextMetrics const & tm = d->text_metrics_[&text];
3014         int const y = tm.first().second->position();
3015         PainterInfo pi(this, pain);
3016
3017         // Check whether the row where the cursor lives needs to be scrolled.
3018         // Update the drawing strategy if needed.
3019         checkCursorScrollOffset(pi);
3020
3021         switch (d->update_strategy_) {
3022
3023         case NoScreenUpdate:
3024                 // If no screen painting is actually needed, only some the different
3025                 // coordinates of insets and paragraphs needs to be updated.
3026                 LYXERR(Debug::PAINTING, "Strategy: NoScreenUpdate");
3027                 pi.full_repaint = true;
3028                 pi.pain.setDrawingEnabled(false);
3029                 tm.draw(pi, 0, y);
3030                 break;
3031
3032         case SingleParUpdate:
3033                 pi.full_repaint = false;
3034                 LYXERR(Debug::PAINTING, "Strategy: SingleParUpdate");
3035                 // In general, only the current row of the outermost paragraph
3036                 // will be redrawn. Particular cases where selection spans
3037                 // multiple paragraph are correctly detected in TextMetrics.
3038                 tm.draw(pi, 0, y);
3039                 break;
3040
3041         case DecorationUpdate:
3042                 // FIXME: We should also distinguish DecorationUpdate to avoid text
3043                 // drawing if possible. This is not possible to do easily right now
3044                 // because of the single backing pixmap.
3045
3046         case FullScreenUpdate:
3047
3048                 LYXERR(Debug::PAINTING,
3049                        ((d->update_strategy_ == FullScreenUpdate)
3050                         ? "Strategy: FullScreenUpdate"
3051                         : "Strategy: DecorationUpdate"));
3052
3053                 // The whole screen, including insets, will be refreshed.
3054                 pi.full_repaint = true;
3055
3056                 // Clear background.
3057                 pain.fillRectangle(0, 0, width_, height_,
3058                         pi.backgroundColor(&buffer_.inset()));
3059
3060                 // Draw everything.
3061                 tm.draw(pi, 0, y);
3062
3063                 // and possibly grey out below
3064                 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3065                 int const y2 = lastpm.second->position() + lastpm.second->descent();
3066
3067                 if (y2 < height_) {
3068                         Color color = buffer().isInternal()
3069                                 ? Color_background : Color_bottomarea;
3070                         pain.fillRectangle(0, y2, width_, height_ - y2, color);
3071                 }
3072                 break;
3073         }
3074         LYXERR(Debug::PAINTING, "\n\t\t*** END DRAWING  ***");
3075
3076         // The scrollbar needs an update.
3077         updateScrollbar();
3078
3079         // Normalize anchor for next time
3080         pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
3081         pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3082         for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
3083                 ParagraphMetrics const & pm = tm.parMetrics(pit);
3084                 if (pm.position() + pm.descent() > 0) {
3085                         d->anchor_pit_ = pit;
3086                         d->anchor_ypos_ = pm.position();
3087                         break;
3088                 }
3089         }
3090         LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
3091                 << "  anchor ypos = " << d->anchor_ypos_);
3092 }
3093
3094
3095 void BufferView::message(docstring const & msg)
3096 {
3097         if (d->gui_)
3098                 d->gui_->message(msg);
3099 }
3100
3101
3102 void BufferView::showDialog(string const & name)
3103 {
3104         if (d->gui_)
3105                 d->gui_->showDialog(name, string());
3106 }
3107
3108
3109 void BufferView::showDialog(string const & name,
3110         string const & data, Inset * inset)
3111 {
3112         if (d->gui_)
3113                 d->gui_->showDialog(name, data, inset);
3114 }
3115
3116
3117 void BufferView::updateDialog(string const & name, string const & data)
3118 {
3119         if (d->gui_)
3120                 d->gui_->updateDialog(name, data);
3121 }
3122
3123
3124 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
3125 {
3126         d->gui_ = gui;
3127 }
3128
3129
3130 // FIXME: Move this out of BufferView again
3131 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
3132 {
3133         if (!fname.isReadableFile()) {
3134                 docstring const error = from_ascii(strerror(errno));
3135                 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3136                 docstring const text =
3137                   bformat(_("Could not read the specified document\n"
3138                             "%1$s\ndue to the error: %2$s"), file, error);
3139                 Alert::error(_("Could not read file"), text);
3140                 return docstring();
3141         }
3142
3143         if (!fname.isReadableFile()) {
3144                 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3145                 docstring const text =
3146                   bformat(_("%1$s\n is not readable."), file);
3147                 Alert::error(_("Could not open file"), text);
3148                 return docstring();
3149         }
3150
3151         // FIXME UNICODE: We don't know the encoding of the file
3152         docstring file_content = fname.fileContents("UTF-8");
3153         if (file_content.empty()) {
3154                 Alert::error(_("Reading not UTF-8 encoded file"),
3155                              _("The file is not UTF-8 encoded.\n"
3156                                "It will be read as local 8Bit-encoded.\n"
3157                                "If this does not give the correct result\n"
3158                                "then please change the encoding of the file\n"
3159                                "to UTF-8 with a program other than LyX.\n"));
3160                 file_content = fname.fileContents("local8bit");
3161         }
3162
3163         return normalize_c(file_content);
3164 }
3165
3166
3167 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
3168 {
3169         docstring const tmpstr = contentsOfPlaintextFile(f);
3170
3171         if (tmpstr.empty())
3172                 return;
3173
3174         Cursor & cur = cursor();
3175         cap::replaceSelection(cur);
3176         buffer_.undo().recordUndo(cur);
3177         if (asParagraph)
3178                 cur.innerText()->insertStringAsParagraphs(cur, tmpstr, cur.current_font);
3179         else
3180                 cur.innerText()->insertStringAsLines(cur, tmpstr, cur.current_font);
3181
3182         buffer_.changed(true);
3183 }
3184
3185
3186 docstring const & BufferView::inlineCompletion() const
3187 {
3188         return d->inlineCompletion_;
3189 }
3190
3191
3192 size_t const & BufferView::inlineCompletionUniqueChars() const
3193 {
3194         return d->inlineCompletionUniqueChars_;
3195 }
3196
3197
3198 DocIterator const & BufferView::inlineCompletionPos() const
3199 {
3200         return d->inlineCompletionPos_;
3201 }
3202
3203
3204 void BufferView::resetInlineCompletionPos()
3205 {
3206         d->inlineCompletionPos_ = DocIterator();
3207 }
3208
3209
3210 bool samePar(DocIterator const & a, DocIterator const & b)
3211 {
3212         if (a.empty() && b.empty())
3213                 return true;
3214         if (a.empty() || b.empty())
3215                 return false;
3216         if (a.depth() != b.depth())
3217                 return false;
3218         return &a.innerParagraph() == &b.innerParagraph();
3219 }
3220
3221
3222 void BufferView::setInlineCompletion(Cursor const & cur, DocIterator const & pos,
3223         docstring const & completion, size_t uniqueChars)
3224 {
3225         uniqueChars = min(completion.size(), uniqueChars);
3226         bool changed = d->inlineCompletion_ != completion
3227                 || d->inlineCompletionUniqueChars_ != uniqueChars;
3228         bool singlePar = true;
3229         d->inlineCompletion_ = completion;
3230         d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
3231
3232         //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
3233
3234         // at new position?
3235         DocIterator const & old = d->inlineCompletionPos_;
3236         if (old != pos) {
3237                 //lyxerr << "inlineCompletionPos changed" << std::endl;
3238                 // old or pos are in another paragraph?
3239                 if ((!samePar(cur, pos) && !pos.empty())
3240                     || (!samePar(cur, old) && !old.empty())) {
3241                         singlePar = false;
3242                         //lyxerr << "different paragraph" << std::endl;
3243                 }
3244                 d->inlineCompletionPos_ = pos;
3245         }
3246
3247         // set update flags
3248         if (changed) {
3249                 if (singlePar && !(cur.result().screenUpdate() & Update::Force))
3250                         cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
3251                 else
3252                         cur.screenUpdateFlags(cur.result().screenUpdate() | Update::Force);
3253         }
3254 }
3255
3256
3257 bool BufferView::clickableInset() const
3258 {
3259         return d->clickable_inset_;
3260 }
3261
3262 } // namespace lyx