src/BufferView.cpp

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