src/BufferView.cpp

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