src/BufferView.cpp

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