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