src/BufferView.cpp

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