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