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