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