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         default:
1236                 return false;
1237         }
1238
1239         return true;
1240 }
1241
1242
1243 Inset * BufferView::editedInset(string const & name) const
1244 {
1245         map<string, Inset *>::const_iterator it = d->edited_insets_.find(name);
1246         return it == d->edited_insets_.end() ? 0 : it->second;
1247 }
1248
1249
1250 void BufferView::editInset(string const & name, Inset * inset)
1251 {
1252         if (inset)
1253                 d->edited_insets_[name] = inset;
1254         else
1255                 d->edited_insets_.erase(name);
1256 }
1257
1258
1259 void BufferView::dispatch(FuncRequest const & cmd, DispatchResult & dr)
1260 {
1261         LYXERR(Debug::ACTION, "BufferView::dispatch: cmd: " << cmd);
1262
1263         string const argument = to_utf8(cmd.argument());
1264         Cursor & cur = d->cursor_;
1265         Cursor old = cur;
1266
1267         // Don't dispatch function that does not apply to internal buffers.
1268         if (buffer_.isInternal()
1269             && lyxaction.funcHasFlag(cmd.action(), LyXAction::NoInternal))
1270                 return;
1271
1272         // We'll set this back to false if need be.
1273         bool dispatched = true;
1274         buffer_.undo().beginUndoGroup();
1275
1276         FuncCode const act = cmd.action();
1277         switch (act) {
1278
1279         case LFUN_BUFFER_PARAMS_APPLY: {
1280                 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1281                 cur.recordUndoBufferParams();
1282                 istringstream ss(to_utf8(cmd.argument()));
1283                 Lexer lex;
1284                 lex.setStream(ss);
1285                 int const unknown_tokens = buffer_.readHeader(lex);
1286                 if (unknown_tokens != 0) {
1287                         LYXERR0("Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1288                                                 << unknown_tokens << " unknown token"
1289                                                 << (unknown_tokens == 1 ? "" : "s"));
1290                 }
1291                 updateDocumentClass(olddc);
1292
1293                 // We are most certainly here because of a change in the document
1294                 // It is then better to make sure that all dialogs are in sync with
1295                 // current document settings.
1296                 dr.screenUpdate(Update::Force | Update::FitCursor);
1297                 dr.forceBufferUpdate();
1298                 break;
1299         }
1300
1301         case LFUN_LAYOUT_MODULES_CLEAR: {
1302                 // FIXME: this modifies the document in cap::switchBetweenClasses
1303                 //  without calling recordUndo. Fix this before using
1304                 //  recordUndoBufferParams().
1305                 cur.recordUndoFullBuffer();
1306                 buffer_.params().clearLayoutModules();
1307                 makeDocumentClass();
1308                 dr.screenUpdate(Update::Force);
1309                 dr.forceBufferUpdate();
1310                 break;
1311         }
1312
1313         case LFUN_LAYOUT_MODULE_ADD: {
1314                 BufferParams const & params = buffer_.params();
1315                 if (!params.layoutModuleCanBeAdded(argument)) {
1316                         LYXERR0("Module `" << argument <<
1317                                 "' cannot be added due to failed requirements or "
1318                                 "conflicts with installed modules.");
1319                         break;
1320                 }
1321                 // FIXME: this modifies the document in cap::switchBetweenClasses
1322                 //  without calling recordUndo. Fix this before using
1323                 //  recordUndoBufferParams().
1324                 cur.recordUndoFullBuffer();
1325                 buffer_.params().addLayoutModule(argument);
1326                 makeDocumentClass();
1327                 dr.screenUpdate(Update::Force);
1328                 dr.forceBufferUpdate();
1329                 break;
1330         }
1331
1332         case LFUN_TEXTCLASS_APPLY: {
1333                 // since this shortcircuits, the second call is made only if
1334                 // the first fails
1335                 bool const success =
1336                         LayoutFileList::get().load(argument, buffer_.temppath()) ||
1337                         LayoutFileList::get().load(argument, buffer_.filePath());
1338                 if (!success) {
1339                         docstring s = bformat(_("The document class `%1$s' "
1340                                                  "could not be loaded."), from_utf8(argument));
1341                         frontend::Alert::error(_("Could not load class"), s);
1342                         break;
1343                 }
1344
1345                 LayoutFile const * old_layout = buffer_.params().baseClass();
1346                 LayoutFile const * new_layout = &(LayoutFileList::get()[argument]);
1347
1348                 if (old_layout == new_layout)
1349                         // nothing to do
1350                         break;
1351
1352                 // Save the old, possibly modular, layout for use in conversion.
1353                 // FIXME: this modifies the document in cap::switchBetweenClasses
1354                 //  without calling recordUndo. Fix this before using
1355                 //  recordUndoBufferParams().
1356                 cur.recordUndoFullBuffer();
1357                 buffer_.params().setBaseClass(argument, buffer_.layoutPos());
1358                 makeDocumentClass();
1359                 dr.screenUpdate(Update::Force);
1360                 dr.forceBufferUpdate();
1361                 break;
1362         }
1363
1364         case LFUN_TEXTCLASS_LOAD: {
1365                 // since this shortcircuits, the second call is made only if
1366                 // the first fails
1367                 bool const success =
1368                         LayoutFileList::get().load(argument, buffer_.temppath()) ||
1369                         LayoutFileList::get().load(argument, buffer_.filePath());
1370                 if (!success) {
1371                         docstring s = bformat(_("The document class `%1$s' "
1372                                                  "could not be loaded."), from_utf8(argument));
1373                         frontend::Alert::error(_("Could not load class"), s);
1374                 }
1375                 break;
1376         }
1377
1378         case LFUN_LAYOUT_RELOAD: {
1379                 LayoutFileIndex bc = buffer_.params().baseClassID();
1380                 LayoutFileList::get().reset(bc);
1381                 buffer_.params().setBaseClass(bc, buffer_.layoutPos());
1382                 makeDocumentClass();
1383                 dr.screenUpdate(Update::Force);
1384                 dr.forceBufferUpdate();
1385                 break;
1386         }
1387
1388         case LFUN_UNDO: {
1389                 dr.setMessage(_("Undo"));
1390                 cur.clearSelection();
1391                 // We need to find out if the bibliography information
1392                 // has changed. See bug #11055.
1393                 // So these should not be references...
1394                 LayoutModuleList const engines = buffer().params().citeEngine();
1395                 CiteEngineType const enginetype = buffer().params().citeEngineType();
1396                 if (!cur.textUndo())
1397                         dr.setMessage(_("No further undo information"));
1398                 else {
1399                         dr.screenUpdate(Update::Force | Update::FitCursor);
1400                         dr.forceBufferUpdate();
1401                         if (buffer().params().citeEngine() != engines ||
1402                             buffer().params().citeEngineType() != enginetype)
1403                                 buffer().invalidateCiteLabels();
1404                 }
1405                 break;
1406         }
1407
1408         case LFUN_REDO: {
1409                 dr.setMessage(_("Redo"));
1410                 cur.clearSelection();
1411                 // We need to find out if the bibliography information
1412                 // has changed. See bug #11055.
1413                 // So these should not be references...
1414                 LayoutModuleList const engines = buffer().params().citeEngine();
1415                 CiteEngineType const enginetype = buffer().params().citeEngineType();
1416                 if (!cur.textRedo())
1417                         dr.setMessage(_("No further redo information"));
1418                 else {
1419                         dr.screenUpdate(Update::Force | Update::FitCursor);
1420                         dr.forceBufferUpdate();
1421                         if (buffer().params().citeEngine() != engines ||
1422                             buffer().params().citeEngineType() != enginetype)
1423                                 buffer().invalidateCiteLabels();
1424                 }
1425                 break;
1426         }
1427
1428         case LFUN_FONT_STATE:
1429                 dr.setMessage(cur.currentState(false));
1430                 break;
1431
1432         case LFUN_BOOKMARK_SAVE:
1433                 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1434                 break;
1435
1436         case LFUN_LABEL_GOTO: {
1437                 docstring label = cmd.argument();
1438                 if (label.empty()) {
1439                         InsetRef * inset =
1440                                 getInsetByCode<InsetRef>(cur, REF_CODE);
1441                         if (inset) {
1442                                 label = inset->getParam("reference");
1443                                 // persistent=false: use temp_bookmark
1444                                 saveBookmark(0);
1445                         }
1446                 }
1447                 if (!label.empty()) {
1448                         gotoLabel(label);
1449                         // at the moment, this is redundant, since gotoLabel will
1450                         // eventually call LFUN_PARAGRAPH_GOTO, but it seems best
1451                         // to have it here.
1452                         dr.screenUpdate(Update::Force | Update::FitCursor);
1453                 }
1454                 break;
1455         }
1456
1457         case LFUN_PARAGRAPH_GOTO: {
1458                 int const id = convert<int>(cmd.getArg(0));
1459                 pos_type const pos = convert<int>(cmd.getArg(1));
1460                 if (id < 0)
1461                         break;
1462                 string const str_id_end = cmd.getArg(2);
1463                 string const str_pos_end = cmd.getArg(3);
1464                 int i = 0;
1465                 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1466                         b = theBufferList().next(b)) {
1467
1468                         Cursor cur(*this);
1469                         cur.setCursor(b->getParFromID(id));
1470                         if (cur.atEnd()) {
1471                                 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1472                                 ++i;
1473                                 continue;
1474                         }
1475                         LYXERR(Debug::INFO, "Paragraph " << cur.paragraph().id()
1476                                 << " found in buffer `"
1477                                 << b->absFileName() << "'.");
1478
1479                         if (b == &buffer_) {
1480                                 bool success;
1481                                 if (str_id_end.empty() || str_pos_end.empty()) {
1482                                         // Set the cursor
1483                                         cur.pos() = pos;
1484                                         mouseSetCursor(cur);
1485                                         success = true;
1486                                 } else {
1487                                         int const id_end = convert<int>(str_id_end);
1488                                         pos_type const pos_end = convert<int>(str_pos_end);
1489                                         success = setCursorFromEntries({id, pos},
1490                                                                        {id_end, pos_end});
1491                                 }
1492                                 if (success)
1493                                         dr.screenUpdate(Update::Force | Update::FitCursor);
1494                         } else {
1495                                 // Switch to other buffer view and resend cmd
1496                                 lyx::dispatch(FuncRequest(
1497                                         LFUN_BUFFER_SWITCH, b->absFileName()));
1498                                 lyx::dispatch(cmd);
1499                         }
1500                         break;
1501                 }
1502                 break;
1503         }
1504
1505         case LFUN_NOTE_NEXT:
1506                 gotoInset(this, NOTE_CODE, false);
1507                 break;
1508
1509         case LFUN_REFERENCE_NEXT: {
1510                 vector<InsetCode> tmp;
1511                 tmp.push_back(LABEL_CODE);
1512                 tmp.push_back(REF_CODE);
1513                 gotoInset(this, tmp, true);
1514                 break;
1515         }
1516
1517         case LFUN_CHANGE_NEXT:
1518                 findNextChange(this);
1519                 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1520                 dr.screenUpdate(Update::Force | Update::FitCursor);
1521                 break;
1522
1523         case LFUN_CHANGE_PREVIOUS:
1524                 findPreviousChange(this);
1525                 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1526                 dr.screenUpdate(Update::Force | Update::FitCursor);
1527                 break;
1528
1529         case LFUN_CHANGES_MERGE:
1530                 if (findNextChange(this) || findPreviousChange(this)) {
1531                         dr.screenUpdate(Update::Force | Update::FitCursor);
1532                         dr.forceBufferUpdate();
1533                         showDialog("changes");
1534                 }
1535                 break;
1536
1537         case LFUN_ALL_CHANGES_ACCEPT:
1538                 // select complete document
1539                 cur.reset();
1540                 cur.selHandle(true);
1541                 buffer_.text().cursorBottom(cur);
1542                 // accept everything in a single step to support atomic undo
1543                 buffer_.text().acceptOrRejectChanges(cur, Text::ACCEPT);
1544                 cur.resetAnchor();
1545                 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1546                 dr.screenUpdate(Update::Force | Update::FitCursor);
1547                 dr.forceBufferUpdate();
1548                 break;
1549
1550         case LFUN_ALL_CHANGES_REJECT:
1551                 // select complete document
1552                 cur.reset();
1553                 cur.selHandle(true);
1554                 buffer_.text().cursorBottom(cur);
1555                 // reject everything in a single step to support atomic undo
1556                 // Note: reject does not work recursively; the user may have to repeat the operation
1557                 buffer_.text().acceptOrRejectChanges(cur, Text::REJECT);
1558                 cur.resetAnchor();
1559                 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1560                 dr.screenUpdate(Update::Force | Update::FitCursor);
1561                 dr.forceBufferUpdate();
1562                 break;
1563
1564         case LFUN_WORD_FIND_FORWARD:
1565         case LFUN_WORD_FIND_BACKWARD: {
1566                 // FIXME THREAD
1567                 // Would it maybe be better if this variable were view specific anyway?
1568                 static docstring last_search;
1569                 docstring searched_string;
1570
1571                 if (!cmd.argument().empty()) {
1572                         last_search = cmd.argument();
1573                         searched_string = cmd.argument();
1574                 } else {
1575                         searched_string = last_search;
1576                 }
1577
1578                 if (searched_string.empty())
1579                         break;
1580
1581                 bool const fw = act == LFUN_WORD_FIND_FORWARD;
1582                 docstring const data =
1583                         find2string(searched_string, true, false, fw);
1584                 bool found = lyxfind(this, FuncRequest(LFUN_WORD_FIND, data));
1585                 if (found)
1586                         dr.screenUpdate(Update::Force | Update::FitCursor);
1587                 break;
1588         }
1589
1590         case LFUN_WORD_FIND: {
1591                 FuncRequest req = cmd;
1592                 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1593                         req = d->search_request_cache_;
1594                 if (req.argument().empty()) {
1595                         lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, "findreplace"));
1596                         break;
1597                 }
1598                 if (lyxfind(this, req))
1599                         dr.screenUpdate(Update::Force | Update::FitCursor);
1600
1601                 d->search_request_cache_ = req;
1602                 break;
1603         }
1604
1605         case LFUN_WORD_REPLACE: {
1606                 bool has_deleted = false;
1607                 if (cur.selection()) {
1608                         DocIterator beg = cur.selectionBegin();
1609                         DocIterator end = cur.selectionEnd();
1610                         if (beg.pit() == end.pit()) {
1611                                 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1612                                         if (!cur.inMathed() && cur.paragraph().isDeleted(p)) {
1613                                                 has_deleted = true;
1614                                                 break;
1615                                         }
1616                                 }
1617                         }
1618                 }
1619                 if (lyxreplace(this, cmd, has_deleted)) {
1620                         dr.forceBufferUpdate();
1621                         dr.screenUpdate(Update::Force | Update::FitCursor);
1622                 }
1623                 break;
1624         }
1625
1626         case LFUN_WORD_FINDADV: {
1627                 FindAndReplaceOptions opt;
1628                 istringstream iss(to_utf8(cmd.argument()));
1629                 iss >> opt;
1630                 if (findAdv(this, opt)) {
1631                         dr.screenUpdate(Update::Force | Update::FitCursor);
1632                         cur.dispatched();
1633                         dispatched = true;
1634                 } else {
1635                         cur.undispatched();
1636                         dispatched = false;
1637                 }
1638                 break;
1639         }
1640
1641         case LFUN_MARK_OFF:
1642                 cur.clearSelection();
1643                 dr.setMessage(from_utf8(N_("Mark off")));
1644                 break;
1645
1646         case LFUN_MARK_ON:
1647                 cur.clearSelection();
1648                 cur.setMark(true);
1649                 dr.setMessage(from_utf8(N_("Mark on")));
1650                 break;
1651
1652         case LFUN_MARK_TOGGLE:
1653                 cur.selection(false);
1654                 if (cur.mark()) {
1655                         cur.setMark(false);
1656                         dr.setMessage(from_utf8(N_("Mark removed")));
1657                 } else {
1658                         cur.setMark(true);
1659                         dr.setMessage(from_utf8(N_("Mark set")));
1660                 }
1661                 cur.resetAnchor();
1662                 break;
1663
1664         case LFUN_SCREEN_SHOW_CURSOR:
1665                 showCursor();
1666                 break;
1667
1668         case LFUN_SCREEN_RECENTER:
1669                 recenter();
1670                 break;
1671
1672         case LFUN_BIBTEX_DATABASE_ADD: {
1673                 Cursor tmpcur = cur;
1674                 findInset(tmpcur, BIBTEX_CODE, false);
1675                 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1676                                                 BIBTEX_CODE);
1677                 if (inset) {
1678                         if (inset->addDatabase(cmd.argument())) {
1679                                 dr.forceBufferUpdate();
1680                         }
1681                 }
1682                 break;
1683         }
1684
1685         case LFUN_BIBTEX_DATABASE_DEL: {
1686                 Cursor tmpcur = cur;
1687                 findInset(tmpcur, BIBTEX_CODE, false);
1688                 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1689                                                 BIBTEX_CODE);
1690                 if (inset) {
1691                         if (inset->delDatabase(cmd.argument()))
1692                                 dr.forceBufferUpdate();
1693                 }
1694                 break;
1695         }
1696
1697         case LFUN_GRAPHICS_UNIFY: {
1698
1699                 cur.recordUndoFullBuffer();
1700
1701                 DocIterator from, to;
1702                 from = cur.selectionBegin();
1703                 to = cur.selectionEnd();
1704
1705                 string const newId = cmd.getArg(0);
1706                 bool fetchId = newId.empty(); //if we wait for groupId from first graphics inset
1707
1708                 InsetGraphicsParams grp_par;
1709                 if (!fetchId)
1710                         InsetGraphics::string2params(graphics::getGroupParams(buffer_, newId), buffer_, grp_par);
1711
1712                 if (!from.nextInset())  //move to closest inset
1713                         from.forwardInset();
1714
1715                 while (!from.empty() && from < to) {
1716                         Inset * inset = from.nextInset();
1717                         if (!inset)
1718                                 break;
1719                         if (inset->lyxCode() == GRAPHICS_CODE) {
1720                         InsetGraphics & ig = static_cast<InsetGraphics &>(*inset);
1721                                 InsetGraphicsParams inspar = ig.getParams();
1722                                 if (fetchId) {
1723                                         grp_par = inspar;
1724                                         fetchId = false;
1725                                 } else {
1726                                         grp_par.filename = inspar.filename;
1727                                         ig.setParams(grp_par);
1728                                 }
1729                         }
1730                         from.forwardInset();
1731                 }
1732                 dr.screenUpdate(Update::Force); //needed if triggered from context menu
1733                 break;
1734         }
1735
1736         case LFUN_STATISTICS: {
1737                 DocIterator from, to;
1738                 if (cur.selection()) {
1739                         from = cur.selectionBegin();
1740                         to = cur.selectionEnd();
1741                 } else {
1742                         from = doc_iterator_begin(&buffer_);
1743                         to = doc_iterator_end(&buffer_);
1744                 }
1745                 buffer_.updateStatistics(from, to);
1746                 int const words = buffer_.wordCount();
1747                 int const chars = buffer_.charCount(false);
1748                 int const chars_blanks = buffer_.charCount(true);
1749                 docstring message;
1750                 if (cur.selection())
1751                         message = _("Statistics for the selection:");
1752                 else
1753                         message = _("Statistics for the document:");
1754                 message += "\n\n";
1755                 if (words != 1)
1756                         message += bformat(_("%1$d words"), words);
1757                 else
1758                         message += _("One word");
1759                 message += "\n";
1760                 if (chars_blanks != 1)
1761                         message += bformat(_("%1$d characters (including blanks)"),
1762                                           chars_blanks);
1763                 else
1764                         message += _("One character (including blanks)");
1765                 message += "\n";
1766                 if (chars != 1)
1767                         message += bformat(_("%1$d characters (excluding blanks)"),
1768                                           chars);
1769                 else
1770                         message += _("One character (excluding blanks)");
1771
1772                 Alert::information(_("Statistics"), message);
1773         }
1774                 break;
1775
1776         case LFUN_SCREEN_UP:
1777         case LFUN_SCREEN_DOWN: {
1778                 Point p = getPos(cur);
1779                 // This code has been commented out to enable to scroll down a
1780                 // document, even if there are large insets in it (see bug #5465).
1781                 /*if (p.y_ < 0 || p.y_ > height_) {
1782                         // The cursor is off-screen so recenter before proceeding.
1783                         showCursor();
1784                         p = getPos(cur);
1785                 }*/
1786                 int const scrolled = scroll(act == LFUN_SCREEN_UP
1787                         ? -height_ : height_);
1788                 if (act == LFUN_SCREEN_UP && scrolled > -height_)
1789                         p = Point(0, 0);
1790                 if (act == LFUN_SCREEN_DOWN && scrolled < height_)
1791                         p = Point(width_, height_);
1792                 bool const in_texted = cur.inTexted();
1793                 cur.setCursor(doc_iterator_begin(cur.buffer()));
1794                 cur.selHandle(false);
1795                 // Force an immediate computation of metrics because we need it below
1796                 processUpdateFlags(Update::Force);
1797
1798                 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_,
1799                         true, act == LFUN_SCREEN_UP);
1800                 //FIXME: what to do with cur.x_target()?
1801                 bool update = in_texted && cur.bv().checkDepm(cur, old);
1802                 cur.finishUndo();
1803
1804                 if (update || cur.mark())
1805                         dr.screenUpdate(Update::Force | Update::FitCursor);
1806                 if (update)
1807                         dr.forceBufferUpdate();
1808                 break;
1809         }
1810
1811         case LFUN_SCROLL: {
1812                 string const scroll_type = cmd.getArg(0);
1813                 int scroll_step = 0;
1814                 if (scroll_type == "line")
1815                         scroll_step = d->scrollbarParameters_.single_step;
1816                 else if (scroll_type == "page")
1817                         scroll_step = d->scrollbarParameters_.page_step;
1818                 else
1819                         return;
1820                 string const scroll_quantity = cmd.getArg(1);
1821                 if (scroll_quantity == "up")
1822                         scrollUp(scroll_step);
1823                 else if (scroll_quantity == "down")
1824                         scrollDown(scroll_step);
1825                 else {
1826                         int const scroll_value = convert<int>(scroll_quantity);
1827                         if (scroll_value)
1828                                 scroll(scroll_step * scroll_value);
1829                 }
1830                 dr.screenUpdate(Update::ForceDraw);
1831                 dr.forceBufferUpdate();
1832                 break;
1833         }
1834
1835         case LFUN_SCREEN_UP_SELECT: {
1836                 // FIXME: why is the algorithm different from LFUN_SCREEN_UP?
1837                 cur.selHandle(true);
1838                 if (isTopScreen()) {
1839                         lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1840                         cur.finishUndo();
1841                         break;
1842                 }
1843                 int y = getPos(cur).y_;
1844                 int const ymin = y - height_ + defaultRowHeight();
1845                 while (y > ymin && cur.up())
1846                         y = getPos(cur).y_;
1847
1848                 cur.finishUndo();
1849                 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1850                 break;
1851         }
1852
1853         case LFUN_SCREEN_DOWN_SELECT: {
1854                 // FIXME: why is the algorithm different from LFUN_SCREEN_DOWN?
1855                 cur.selHandle(true);
1856                 if (isBottomScreen()) {
1857                         lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1858                         cur.finishUndo();
1859                         break;
1860                 }
1861                 int y = getPos(cur).y_;
1862                 int const ymax = y + height_ - defaultRowHeight();
1863                 while (y < ymax && cur.down())
1864                         y = getPos(cur).y_;
1865
1866                 cur.finishUndo();
1867                 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1868                 break;
1869         }
1870
1871
1872         case LFUN_INSET_SELECT_ALL: {
1873                 // true if all cells are selected
1874                 bool const all_selected = cur.depth() > 1
1875                     && cur.selBegin().at_begin()
1876                     && cur.selEnd().at_end();
1877                 // true if some cells are selected
1878                 bool const cells_selected = cur.depth() > 1
1879                     && cur.selBegin().at_cell_begin()
1880                         && cur.selEnd().at_cell_end();
1881                 if (all_selected || (cells_selected && !cur.inset().isTable())) {
1882                         // All the contents of the inset if selected, or only at
1883                         // least one cell but inset is not a table.
1884                         // Select the inset from outside.
1885                         cur.pop();
1886                         cur.resetAnchor();
1887                         cur.selection(true);
1888                         cur.posForward();
1889                 } else if (cells_selected) {
1890                         // At least one complete cell is selected and inset is a table.
1891                         // Select all cells
1892                         cur.idx() = 0;
1893                         cur.pit() = 0;
1894                         cur.pos() = 0;
1895                         cur.resetAnchor();
1896                         cur.selection(true);
1897                         cur.idx() = cur.lastidx();
1898                         cur.pit() = cur.lastpit();
1899                         cur.pos() = cur.lastpos();
1900                 } else {
1901                         // select current cell
1902                         cur.pit() = 0;
1903                         cur.pos() = 0;
1904                         cur.resetAnchor();
1905                         cur.selection(true);
1906                         cur.pit() = cur.lastpit();
1907                         cur.pos() = cur.lastpos();
1908                 }
1909                 cur.setCurrentFont();
1910                 dr.screenUpdate(Update::Force);
1911                 break;
1912         }
1913
1914
1915         case LFUN_UNICODE_INSERT: {
1916                 if (cmd.argument().empty())
1917                         break;
1918
1919                 FuncCode code = cur.inset().currentMode() == Inset::MATH_MODE ?
1920                         LFUN_MATH_INSERT : LFUN_SELF_INSERT;
1921                 int i = 0;
1922                 while (true) {
1923                         docstring const arg = from_utf8(cmd.getArg(i));
1924                         if (arg.empty())
1925                                 break;
1926                         if (!isHex(arg)) {
1927                                 LYXERR0("Not a hexstring: " << arg);
1928                                 ++i;
1929                                 continue;
1930                         }
1931                         char_type c = hexToInt(arg);
1932                         if (c >= 32 && c < 0x10ffff) {
1933                                 LYXERR(Debug::KEY, "Inserting c: " << c);
1934                                 lyx::dispatch(FuncRequest(code, docstring(1, c)));
1935                         }
1936                         ++i;
1937                 }
1938                 break;
1939         }
1940
1941
1942         // This would be in Buffer class if only Cursor did not
1943         // require a bufferview
1944         case LFUN_INSET_FORALL: {
1945                 docstring const name = from_utf8(cmd.getArg(0));
1946                 string const commandstr = cmd.getLongArg(1);
1947                 FuncRequest const fr = lyxaction.lookupFunc(commandstr);
1948
1949                 // an arbitrary number to limit number of iterations
1950                 const int max_iter = 100000;
1951                 int iterations = 0;
1952                 Cursor & cur = d->cursor_;
1953                 Cursor const savecur = cur;
1954                 cur.reset();
1955                 if (!cur.nextInset())
1956                         cur.forwardInset();
1957                 cur.beginUndoGroup();
1958                 while(cur && iterations < max_iter) {
1959                         Inset * const ins = cur.nextInset();
1960                         if (!ins)
1961                                 break;
1962                         docstring insname = ins->layoutName();
1963                         while (!insname.empty()) {
1964                                 if (insname == name || name == from_utf8("*")) {
1965                                         cur.recordUndo();
1966                                         lyx::dispatch(fr, dr);
1967                                         ++iterations;
1968                                         break;
1969                                 }
1970                                 size_t const i = insname.rfind(':');
1971                                 if (i == string::npos)
1972                                         break;
1973                                 insname = insname.substr(0, i);
1974                         }
1975                         // if we did not delete the inset, skip it
1976                         if (!cur.nextInset() || cur.nextInset() == ins)
1977                                 cur.forwardInset();
1978                 }
1979                 cur = savecur;
1980                 cur.fixIfBroken();
1981                 /** This is a dummy undo record only to remember the cursor
1982                  * that has just been set; this will be used on a redo action
1983                  * (see ticket #10097)
1984
1985                  * FIXME: a better fix would be to have a way to set the
1986                  * cursor value directly, but I am not sure it is worth it.
1987                  */
1988                 cur.recordUndo();
1989                 cur.endUndoGroup();
1990                 dr.screenUpdate(Update::Force);
1991                 dr.forceBufferUpdate();
1992
1993                 if (iterations >= max_iter) {
1994                         dr.setError(true);
1995                         dr.setMessage(bformat(_("`inset-forall' interrupted because number of actions is larger than %1$d"), max_iter));
1996                 } else
1997                         dr.setMessage(bformat(_("Applied \"%1$s\" to %2$d insets"), from_utf8(commandstr), iterations));
1998                 break;
1999         }
2000
2001
2002         case LFUN_BRANCH_ADD_INSERT: {
2003                 docstring branch_name = from_utf8(cmd.getArg(0));
2004                 if (branch_name.empty())
2005                         if (!Alert::askForText(branch_name, _("Branch name")) ||
2006                                                 branch_name.empty())
2007                                 break;
2008
2009                 DispatchResult drtmp;
2010                 buffer_.dispatch(FuncRequest(LFUN_BRANCH_ADD, branch_name), drtmp);
2011                 if (drtmp.error()) {
2012                         Alert::warning(_("Branch already exists"), drtmp.message());
2013                         break;
2014                 }
2015                 BranchList & branch_list = buffer_.params().branchlist();
2016                 vector<docstring> const branches =
2017                         getVectorFromString(branch_name, branch_list.separator());
2018                 for (vector<docstring>::const_iterator it = branches.begin();
2019                      it != branches.end(); ++it) {
2020                         branch_name = *it;
2021                         lyx::dispatch(FuncRequest(LFUN_BRANCH_INSERT, branch_name));
2022                 }
2023                 break;
2024         }
2025
2026         case LFUN_KEYMAP_OFF:
2027                 getIntl().keyMapOn(false);
2028                 break;
2029
2030         case LFUN_KEYMAP_PRIMARY:
2031                 getIntl().keyMapPrim();
2032                 break;
2033
2034         case LFUN_KEYMAP_SECONDARY:
2035                 getIntl().keyMapSec();
2036                 break;
2037
2038         case LFUN_KEYMAP_TOGGLE:
2039                 getIntl().toggleKeyMap();
2040                 break;
2041
2042         case LFUN_DIALOG_SHOW_NEW_INSET: {
2043                 string const name = cmd.getArg(0);
2044                 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
2045                 if (decodeInsetParam(name, data, buffer_))
2046                         lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
2047                 else
2048                         lyxerr << "Inset type '" << name <<
2049                         "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" <<  endl;
2050                 break;
2051         }
2052
2053         case LFUN_CITATION_INSERT: {
2054                 if (argument.empty()) {
2055                         lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
2056                         break;
2057                 }
2058                 // we can have one optional argument, delimited by '|'
2059                 // citation-insert <key>|<text_before>
2060                 // this should be enhanced to also support text_after
2061                 // and citation style
2062                 string arg = argument;
2063                 string opt1;
2064                 if (contains(argument, "|")) {
2065                         arg = token(argument, '|', 0);
2066                         opt1 = token(argument, '|', 1);
2067                 }
2068
2069                 // if our cursor is directly in front of or behind a citation inset,
2070                 // we will instead add the new key to it.
2071                 Inset * inset = cur.nextInset();
2072                 if (!inset || inset->lyxCode() != CITE_CODE)
2073                         inset = cur.prevInset();
2074                 if (inset && inset->lyxCode() == CITE_CODE) {
2075                         InsetCitation * icite = static_cast<InsetCitation *>(inset);
2076                         if (icite->addKey(arg)) {
2077                                 dr.forceBufferUpdate();
2078                                 dr.screenUpdate(Update::FitCursor | Update::SinglePar);
2079                                 if (!opt1.empty())
2080                                         LYXERR0("Discarding optional argument to citation-insert.");
2081                         }
2082                         dispatched = true;
2083                         break;
2084                 }
2085                 InsetCommandParams icp(CITE_CODE);
2086                 icp["key"] = from_utf8(arg);
2087                 if (!opt1.empty())
2088                         icp["before"] = from_utf8(opt1);
2089                 icp["literal"] =
2090                         from_ascii(InsetCitation::last_literal ? "true" : "false");
2091                 string icstr = InsetCommand::params2string(icp);
2092                 FuncRequest fr(LFUN_INSET_INSERT, icstr);
2093                 lyx::dispatch(fr);
2094                 break;
2095         }
2096
2097         case LFUN_INSET_APPLY: {
2098                 string const name = cmd.getArg(0);
2099                 Inset * inset = editedInset(name);
2100                 if (!inset) {
2101                         FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
2102                         lyx::dispatch(fr);
2103                         break;
2104                 }
2105                 // put cursor in front of inset.
2106                 if (!setCursorFromInset(inset)) {
2107                         LASSERT(false, break);
2108                 }
2109                 cur.recordUndo();
2110                 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
2111                 inset->dispatch(cur, fr);
2112                 dr.screenUpdate(cur.result().screenUpdate());
2113                 if (cur.result().needBufferUpdate())
2114                         dr.forceBufferUpdate();
2115                 break;
2116         }
2117
2118         // FIXME:
2119         // The change of language of buffer belongs to the Buffer class.
2120         // We have to do it here because we need a cursor for Undo.
2121         // When Undo::recordUndoBufferParams() is implemented someday
2122         // LFUN_BUFFER_LANGUAGE should be handled by the Buffer class.
2123         case LFUN_BUFFER_LANGUAGE: {
2124                 Language const * oldL = buffer_.params().language;
2125                 Language const * newL = languages.getLanguage(argument);
2126                 if (!newL || oldL == newL)
2127                         break;
2128                 if (oldL->rightToLeft() == newL->rightToLeft()) {
2129                         cur.recordUndoFullBuffer();
2130                         buffer_.changeLanguage(oldL, newL);
2131                         cur.setCurrentFont();
2132                         dr.forceBufferUpdate();
2133                 }
2134                 break;
2135         }
2136
2137         case LFUN_FILE_INSERT_PLAINTEXT_PARA:
2138         case LFUN_FILE_INSERT_PLAINTEXT: {
2139                 bool const as_paragraph = (act == LFUN_FILE_INSERT_PLAINTEXT_PARA);
2140                 string const fname = to_utf8(cmd.argument());
2141                 if (!FileName::isAbsolute(fname))
2142                         dr.setMessage(_("Absolute filename expected."));
2143                 else
2144                         insertPlaintextFile(FileName(fname), as_paragraph);
2145                 break;
2146         }
2147
2148         default:
2149                 // OK, so try the Buffer itself...
2150                 buffer_.dispatch(cmd, dr);
2151                 dispatched = dr.dispatched();
2152                 break;
2153         }
2154
2155         buffer_.undo().endUndoGroup();
2156         dr.dispatched(dispatched);
2157
2158         // NOTE: The code below is copied from Cursor::dispatch. If you
2159         // need to modify this, please update the other one too.
2160
2161         // notify insets we just entered/left
2162         if (cursor() != old) {
2163                 old.beginUndoGroup();
2164                 old.fixIfBroken();
2165                 bool badcursor = notifyCursorLeavesOrEnters(old, cursor());
2166                 if (badcursor) {
2167                         cursor().fixIfBroken();
2168                         resetInlineCompletionPos();
2169                 }
2170                 old.endUndoGroup();
2171         }
2172 }
2173
2174
2175 docstring const BufferView::requestSelection()
2176 {
2177         Cursor & cur = d->cursor_;
2178
2179         LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
2180         if (!cur.selection()) {
2181                 d->xsel_cache_.set = false;
2182                 return docstring();
2183         }
2184
2185         LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
2186         if (!d->xsel_cache_.set ||
2187             cur.top() != d->xsel_cache_.cursor ||
2188             cur.realAnchor().top() != d->xsel_cache_.anchor)
2189         {
2190                 d->xsel_cache_.cursor = cur.top();
2191                 d->xsel_cache_.anchor = cur.realAnchor().top();
2192                 d->xsel_cache_.set = cur.selection();
2193                 return cur.selectionAsString(false);
2194         }
2195         return docstring();
2196 }
2197
2198
2199 void BufferView::clearSelection()
2200 {
2201         d->cursor_.clearSelection();
2202         // Clear the selection buffer. Otherwise a subsequent
2203         // middle-mouse-button paste would use the selection buffer,
2204         // not the more current external selection.
2205         cap::clearSelection();
2206         d->xsel_cache_.set = false;
2207         // The buffer did not really change, but this causes the
2208         // redraw we need because we cleared the selection above.
2209         buffer_.changed(false);
2210 }
2211
2212
2213 void BufferView::resize(int width, int height)
2214 {
2215         // Update from work area
2216         width_ = width;
2217         height_ = height;
2218
2219         // Clear the paragraph height cache.
2220         d->par_height_.clear();
2221         // Redo the metrics.
2222         updateMetrics();
2223 }
2224
2225
2226 Inset const * BufferView::getCoveringInset(Text const & text,
2227                 int x, int y) const
2228 {
2229         TextMetrics & tm = d->text_metrics_[&text];
2230         Inset * inset = tm.checkInsetHit(x, y);
2231         if (!inset)
2232                 return 0;
2233
2234         if (!inset->descendable(*this))
2235                 // No need to go further down if the inset is not
2236                 // descendable.
2237                 return inset;
2238
2239         size_t cell_number = inset->nargs();
2240         // Check all the inner cell.
2241         for (size_t i = 0; i != cell_number; ++i) {
2242                 Text const * inner_text = inset->getText(i);
2243                 if (inner_text) {
2244                         // Try deeper.
2245                         Inset const * inset_deeper =
2246                                 getCoveringInset(*inner_text, x, y);
2247                         if (inset_deeper)
2248                                 return inset_deeper;
2249                 }
2250         }
2251
2252         return inset;
2253 }
2254
2255
2256 void BufferView::updateHoveredInset() const
2257 {
2258         // Get inset under mouse, if there is one.
2259         int const x = d->mouse_position_cache_.x_;
2260         int const y = d->mouse_position_cache_.y_;
2261         Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
2262
2263         d->clickable_inset_ = covering_inset && covering_inset->clickable(*this, x, y);
2264
2265         if (covering_inset == d->last_inset_)
2266                 // Same inset, no need to do anything...
2267                 return;
2268
2269         bool need_redraw = false;
2270         if (d->last_inset_) {
2271                 // Remove the hint on the last hovered inset (if any).
2272                 need_redraw |= d->last_inset_->setMouseHover(this, false);
2273                 d->last_inset_ = 0;
2274         }
2275
2276         if (covering_inset && covering_inset->setMouseHover(this, true)) {
2277                 need_redraw = true;
2278                 // Only the insets that accept the hover state, do
2279                 // clear the last_inset_, so only set the last_inset_
2280                 // member if the hovered setting is accepted.
2281                 d->last_inset_ = covering_inset;
2282         }
2283
2284         if (need_redraw) {
2285                 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
2286                                 << d->mouse_position_cache_.x_ << ", "
2287                                 << d->mouse_position_cache_.y_ << ")");
2288
2289                 d->update_strategy_ = DecorationUpdate;
2290
2291                 // This event (moving without mouse click) is not passed further.
2292                 // This should be changed if it is further utilized.
2293                 buffer_.changed(false);
2294         }
2295 }
2296
2297
2298 void BufferView::clearLastInset(Inset * inset) const
2299 {
2300         if (d->last_inset_ != inset) {
2301                 LYXERR0("Wrong last_inset!");
2302                 LATTEST(false);
2303         }
2304         d->last_inset_ = 0;
2305 }
2306
2307
2308 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
2309 {
2310         //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
2311
2312         // This is only called for mouse related events including
2313         // LFUN_FILE_OPEN generated by drag-and-drop.
2314         FuncRequest cmd = cmd0;
2315
2316         Cursor old = cursor();
2317         Cursor cur(*this);
2318         cur.push(buffer_.inset());
2319         cur.selection(d->cursor_.selection());
2320
2321         // Either the inset under the cursor or the
2322         // surrounding Text will handle this event.
2323
2324         // make sure we stay within the screen...
2325         cmd.set_y(min(max(cmd.y(), -1), height_));
2326
2327         d->mouse_position_cache_.x_ = cmd.x();
2328         d->mouse_position_cache_.y_ = cmd.y();
2329
2330         if (cmd.action() == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
2331                 updateHoveredInset();
2332                 return;
2333         }
2334
2335         // Build temporary cursor.
2336         Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x(), cmd.y());
2337         if (inset) {
2338                 // If inset is not editable, cur.pos() might point behind the
2339                 // inset (depending on cmd.x(), cmd.y()). This is needed for
2340                 // editing to fix bug 9628, but e.g. the context menu needs a
2341                 // cursor in front of the inset.
2342                 if ((inset->hasSettings() || !inset->contextMenuName().empty()
2343                      || inset->lyxCode() == SEPARATOR_CODE) &&
2344                     cur.nextInset() != inset && cur.prevInset() == inset)
2345                         cur.posBackward();
2346         } else if (cur.inTexted() && cur.pos()
2347                         && cur.paragraph().isEnvSeparator(cur.pos() - 1)) {
2348                 // Always place cursor in front of a separator inset.
2349                 cur.posBackward();
2350         }
2351
2352         // Put anchor at the same position.
2353         cur.resetAnchor();
2354
2355         cur.beginUndoGroup();
2356
2357         // Try to dispatch to an non-editable inset near this position
2358         // via the temp cursor. If the inset wishes to change the real
2359         // cursor it has to do so explicitly by using
2360         //  cur.bv().cursor() = cur;  (or similar)
2361         if (inset)
2362                 inset->dispatch(cur, cmd);
2363
2364         // Now dispatch to the temporary cursor. If the real cursor should
2365         // be modified, the inset's dispatch has to do so explicitly.
2366         if (!inset || !cur.result().dispatched())
2367                 cur.dispatch(cmd);
2368
2369         // Notify left insets
2370         if (cur != old) {
2371                 bool badcursor = old.fixIfBroken() | cur.fixIfBroken();
2372                 badcursor |= notifyCursorLeavesOrEnters(old, cur);
2373                 if (badcursor)
2374                         cursor().fixIfBroken();
2375         }
2376
2377         cur.endUndoGroup();
2378
2379         // Do we have a selection?
2380         theSelection().haveSelection(cursor().selection());
2381
2382         if (cur.needBufferUpdate()) {
2383                 cur.clearBufferUpdate();
2384                 buffer().updateBuffer();
2385         }
2386
2387         // If the command has been dispatched,
2388         if (cur.result().dispatched() || cur.result().screenUpdate())
2389                 processUpdateFlags(cur.result().screenUpdate());
2390 }
2391
2392
2393 int BufferView::minVisiblePart()
2394 {
2395         return 2 * defaultRowHeight();
2396 }
2397
2398
2399 int BufferView::scroll(int y)
2400 {
2401         if (y > 0)
2402                 return scrollDown(y);
2403         if (y < 0)
2404                 return scrollUp(-y);
2405         return 0;
2406 }
2407
2408
2409 int BufferView::scrollDown(int offset)
2410 {
2411         Text * text = &buffer_.text();
2412         TextMetrics & tm = d->text_metrics_[text];
2413         int const ymax = height_ + offset;
2414         while (true) {
2415                 pair<pit_type, ParagraphMetrics const *> last = tm.last();
2416                 int bottom_pos = last.second->position() + last.second->descent();
2417                 if (lyxrc.scroll_below_document)
2418                         bottom_pos += height_ - minVisiblePart();
2419                 if (last.first + 1 == int(text->paragraphs().size())) {
2420                         if (bottom_pos <= height_)
2421                                 return 0;
2422                         offset = min(offset, bottom_pos - height_);
2423                         break;
2424                 }
2425                 if (bottom_pos > ymax)
2426                         break;
2427                 tm.newParMetricsDown();
2428         }
2429         d->anchor_ypos_ -= offset;
2430         return -offset;
2431 }
2432
2433
2434 int BufferView::scrollUp(int offset)
2435 {
2436         Text * text = &buffer_.text();
2437         TextMetrics & tm = d->text_metrics_[text];
2438         int ymin = - offset;
2439         while (true) {
2440                 pair<pit_type, ParagraphMetrics const *> first = tm.first();
2441                 int top_pos = first.second->position() - first.second->ascent();
2442                 if (first.first == 0) {
2443                         if (top_pos >= 0)
2444                                 return 0;
2445                         offset = min(offset, - top_pos);
2446                         break;
2447                 }
2448                 if (top_pos < ymin)
2449                         break;
2450                 tm.newParMetricsUp();
2451         }
2452         d->anchor_ypos_ += offset;
2453         return offset;
2454 }
2455
2456
2457 bool BufferView::setCursorFromRow(int row)
2458 {
2459         TexRow::TextEntry start, end;
2460         tie(start,end) = buffer_.texrow().getEntriesFromRow(row);
2461         LYXERR(Debug::LATEX,
2462                "setCursorFromRow: for row " << row << ", TexRow has found "
2463                "start (id=" << start.id << ",pos=" << start.pos << "), "
2464                "end (id=" << end.id << ",pos=" << end.pos << ")");
2465         return setCursorFromEntries(start, end);
2466 }
2467
2468
2469 bool BufferView::setCursorFromEntries(TexRow::TextEntry start,
2470                                       TexRow::TextEntry end)
2471 {
2472         DocIterator dit_start, dit_end;
2473         tie(dit_start,dit_end) =
2474                 TexRow::getDocIteratorsFromEntries(start, end, buffer_);
2475         if (!dit_start)
2476                 return false;
2477         // Setting selection start
2478         d->cursor_.clearSelection();
2479         setCursor(dit_start);
2480         // Setting selection end
2481         if (dit_end) {
2482                 d->cursor_.resetAnchor();
2483                 setCursorSelectionTo(dit_end);
2484         }
2485         return true;
2486 }
2487
2488
2489 bool BufferView::setCursorFromInset(Inset const * inset)
2490 {
2491         // are we already there?
2492         if (cursor().nextInset() == inset)
2493                 return true;
2494
2495         // Inset is not at cursor position. Find it in the document.
2496         Cursor cur(*this);
2497         cur.reset();
2498         while (cur && cur.nextInset() != inset)
2499                 cur.forwardInset();
2500
2501         if (cur) {
2502                 setCursor(cur);
2503                 return true;
2504         }
2505         return false;
2506 }
2507
2508
2509 void BufferView::gotoLabel(docstring const & label)
2510 {
2511         FuncRequest action;
2512         bool have_inactive = false;
2513         ListOfBuffers bufs = buffer().allRelatives();
2514         ListOfBuffers::iterator it = bufs.begin();
2515         for (; it != bufs.end(); ++it) {
2516                 Buffer const * buf = *it;
2517
2518                 // find label
2519                 shared_ptr<Toc> toc = buf->tocBackend().toc("label");
2520                 Toc::const_iterator toc_it = toc->begin();
2521                 Toc::const_iterator end = toc->end();
2522                 for (; toc_it != end; ++toc_it) {
2523                         if (label == toc_it->str() && toc_it->isOutput()) {
2524                                 lyx::dispatch(toc_it->action());
2525                                 return;
2526                         }
2527                         // If we find an inactive label, save it for the case
2528                         // that no active one is there
2529                         if (label == toc_it->str() && !have_inactive) {
2530                                 have_inactive = true;
2531                                 action = toc_it->action();
2532                         }
2533                 }
2534         }
2535         // We only found an inactive label. Go there.
2536         if (have_inactive)
2537                 lyx::dispatch(action);
2538 }
2539
2540
2541 TextMetrics const & BufferView::textMetrics(Text const * t) const
2542 {
2543         return const_cast<BufferView *>(this)->textMetrics(t);
2544 }
2545
2546
2547 TextMetrics & BufferView::textMetrics(Text const * t)
2548 {
2549         LBUFERR(t);
2550         TextMetricsCache::iterator tmc_it  = d->text_metrics_.find(t);
2551         if (tmc_it == d->text_metrics_.end()) {
2552                 tmc_it = d->text_metrics_.insert(
2553                         make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
2554         }
2555         return tmc_it->second;
2556 }
2557
2558
2559 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
2560                 pit_type pit) const
2561 {
2562         return textMetrics(t).parMetrics(pit);
2563 }
2564
2565
2566 int BufferView::workHeight() const
2567 {
2568         return height_;
2569 }
2570
2571
2572 void BufferView::setCursor(DocIterator const & dit)
2573 {
2574         d->cursor_.reset();
2575         size_t const n = dit.depth();
2576         for (size_t i = 0; i < n; ++i)
2577                 dit[i].inset().edit(d->cursor_, true);
2578
2579         d->cursor_.setCursor(dit);
2580         d->cursor_.selection(false);
2581         d->cursor_.setCurrentFont();
2582         // FIXME
2583         // It seems on general grounds as if this is probably needed, but
2584         // it is not yet clear.
2585         // See bug #7394 and r38388.
2586         // d->cursor.resetAnchor();
2587 }
2588
2589
2590 void BufferView::setCursorSelectionTo(DocIterator const & dit)
2591 {
2592         size_t const n = dit.depth();
2593         for (size_t i = 0; i < n; ++i)
2594                 dit[i].inset().edit(d->cursor_, true);
2595
2596         d->cursor_.selection(true);
2597         d->cursor_.setCursorSelectionTo(dit);
2598         d->cursor_.setCurrentFont();
2599 }
2600
2601
2602 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
2603 {
2604         // Would be wrong to delete anything if we have a selection.
2605         if (cur.selection())
2606                 return false;
2607
2608         bool need_anchor_change = false;
2609         bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
2610                 need_anchor_change);
2611
2612         if (need_anchor_change)
2613                 cur.resetAnchor();
2614
2615         if (!changed)
2616                 return false;
2617
2618         d->cursor_ = cur;
2619
2620         // we would rather not do this here, but it needs to be done before
2621         // the changed() signal is sent.
2622         buffer_.updateBuffer();
2623
2624         buffer_.changed(true);
2625         return true;
2626 }
2627
2628
2629 bool BufferView::mouseSetCursor(Cursor & cur, bool const select)
2630 {
2631         LASSERT(&cur.bv() == this, return false);
2632
2633         if (!select)
2634                 // this event will clear selection so we save selection for
2635                 // persistent selection
2636                 cap::saveSelection(cursor());
2637
2638         d->cursor_.macroModeClose();
2639         // If a macro has been finalized, the cursor might have been broken
2640         cur.fixIfBroken();
2641
2642         // Has the cursor just left the inset?
2643         bool const leftinset = (&d->cursor_.inset() != &cur.inset());
2644         if (leftinset)
2645                 d->cursor_.fixIfBroken();
2646
2647         // do the dEPM magic if needed
2648         // FIXME: (1) move this to InsetText::notifyCursorLeaves?
2649         // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
2650         // the leftinset bool would not be necessary (badcursor instead).
2651         bool update = leftinset;
2652
2653         if (select) {
2654                 d->cursor_.setSelection();
2655                 d->cursor_.setCursorSelectionTo(cur);
2656         } else {
2657                 if (d->cursor_.inTexted())
2658                         update |= checkDepm(cur, d->cursor_);
2659                 d->cursor_.resetAnchor();
2660                 d->cursor_.setCursor(cur);
2661                 d->cursor_.clearSelection();
2662         }
2663         d->cursor_.boundary(cur.boundary());
2664         d->cursor_.finishUndo();
2665         d->cursor_.setCurrentFont();
2666         if (update)
2667                 cur.forceBufferUpdate();
2668         return update;
2669 }
2670
2671
2672 void BufferView::putSelectionAt(DocIterator const & cur,
2673                                 int length, bool backwards)
2674 {
2675         d->cursor_.clearSelection();
2676
2677         setCursor(cur);
2678
2679         if (length) {
2680                 if (backwards) {
2681                         d->cursor_.pos() += length;
2682                         d->cursor_.setSelection(d->cursor_, -length);
2683                 } else
2684                         d->cursor_.setSelection(d->cursor_, length);
2685         }
2686 }
2687
2688
2689 bool BufferView::selectIfEmpty(DocIterator & cur)
2690 {
2691         if ((cur.inTexted() && !cur.paragraph().empty())
2692             || (cur.inMathed() && !cur.cell().empty()))
2693                 return false;
2694
2695         pit_type const beg_pit = cur.pit();
2696         if (beg_pit > 0) {
2697                 // The paragraph associated to this item isn't
2698                 // the first one, so it can be selected
2699                 cur.backwardPos();
2700         } else {
2701                 // We have to resort to select the space between the
2702                 // end of this item and the begin of the next one
2703                 cur.forwardPos();
2704         }
2705         if (cur.empty()) {
2706                 // If it is the only item in the document,
2707                 // nothing can be selected
2708                 return false;
2709         }
2710         pit_type const end_pit = cur.pit();
2711         pos_type const end_pos = cur.pos();
2712         d->cursor_.clearSelection();
2713         d->cursor_.reset();
2714         d->cursor_.setCursor(cur);
2715         d->cursor_.pit() = beg_pit;
2716         d->cursor_.pos() = 0;
2717         d->cursor_.selection(false);
2718         d->cursor_.resetAnchor();
2719         d->cursor_.pit() = end_pit;
2720         d->cursor_.pos() = end_pos;
2721         d->cursor_.setSelection();
2722         return true;
2723 }
2724
2725
2726 Cursor & BufferView::cursor()
2727 {
2728         return d->cursor_;
2729 }
2730
2731
2732 Cursor const & BufferView::cursor() const
2733 {
2734         return d->cursor_;
2735 }
2736
2737
2738 pit_type BufferView::anchor_ref() const
2739 {
2740         return d->anchor_pit_;
2741 }
2742
2743
2744 bool BufferView::singleParUpdate()
2745 {
2746         Text & buftext = buffer_.text();
2747         pit_type const bottom_pit = d->cursor_.bottom().pit();
2748         TextMetrics & tm = textMetrics(&buftext);
2749         int old_height = tm.parMetrics(bottom_pit).height();
2750
2751         // make sure inline completion pointer is ok
2752         if (d->inlineCompletionPos_.fixIfBroken())
2753                 d->inlineCompletionPos_ = DocIterator();
2754
2755         // In Single Paragraph mode, rebreak only
2756         // the (main text, not inset!) paragraph containing the cursor.
2757         // (if this paragraph contains insets etc., rebreaking will
2758         // recursively descend)
2759         tm.redoParagraph(bottom_pit);
2760         ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
2761         if (pm.height() != old_height)
2762                 // Paragraph height has changed so we cannot proceed to
2763                 // the singlePar optimisation.
2764                 return false;
2765
2766         tm.updatePosCache(bottom_pit);
2767
2768         LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
2769                 << " y2: " << pm.position() + pm.descent()
2770                 << " pit: " << bottom_pit
2771                 << " singlepar: 1");
2772         return true;
2773 }
2774
2775
2776 void BufferView::updateMetrics()
2777 {
2778         updateMetrics(d->update_flags_);
2779         d->update_strategy_ = FullScreenUpdate;
2780 }
2781
2782
2783 void BufferView::updateMetrics(Update::flags & update_flags)
2784 {
2785         if (height_ == 0 || width_ == 0)
2786                 return;
2787
2788         Text & buftext = buffer_.text();
2789         pit_type const npit = int(buftext.paragraphs().size());
2790
2791         // Clear out the position cache in case of full screen redraw,
2792         d->coord_cache_.clear();
2793
2794         // Clear out paragraph metrics to avoid having invalid metrics
2795         // in the cache from paragraphs not relayouted below
2796         // The complete text metrics will be redone.
2797         d->text_metrics_.clear();
2798
2799         TextMetrics & tm = textMetrics(&buftext);
2800
2801         // make sure inline completion pointer is ok
2802         if (d->inlineCompletionPos_.fixIfBroken())
2803                 d->inlineCompletionPos_ = DocIterator();
2804
2805         if (d->anchor_pit_ >= npit)
2806                 // The anchor pit must have been deleted...
2807                 d->anchor_pit_ = npit - 1;
2808
2809         // Rebreak anchor paragraph.
2810         tm.redoParagraph(d->anchor_pit_);
2811         ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
2812
2813         // position anchor
2814         if (d->anchor_pit_ == 0) {
2815                 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
2816
2817                 // Complete buffer visible? Then it's easy.
2818                 if (scrollRange == 0)
2819                         d->anchor_ypos_ = anchor_pm.ascent();
2820                 else {
2821                         // avoid empty space above the first row
2822                         d->anchor_ypos_ = min(d->anchor_ypos_, anchor_pm.ascent());
2823                 }
2824         }
2825         anchor_pm.setPosition(d->anchor_ypos_);
2826         tm.updatePosCache(d->anchor_pit_);
2827
2828         LYXERR(Debug::PAINTING, "metrics: "
2829                 << " anchor pit = " << d->anchor_pit_
2830                 << " anchor ypos = " << d->anchor_ypos_);
2831
2832         // Redo paragraphs above anchor if necessary.
2833         int y1 = d->anchor_ypos_ - anchor_pm.ascent();
2834         // We are now just above the anchor paragraph.
2835         pit_type pit1 = d->anchor_pit_ - 1;
2836         for (; pit1 >= 0 && y1 >= 0; --pit1) {
2837                 tm.redoParagraph(pit1);
2838                 ParagraphMetrics & pm = tm.par_metrics_[pit1];
2839                 y1 -= pm.descent();
2840                 // Save the paragraph position in the cache.
2841                 pm.setPosition(y1);
2842                 tm.updatePosCache(pit1);
2843                 y1 -= pm.ascent();
2844         }
2845
2846         // Redo paragraphs below the anchor if necessary.
2847         int y2 = d->anchor_ypos_ + anchor_pm.descent();
2848         // We are now just below the anchor paragraph.
2849         pit_type pit2 = d->anchor_pit_ + 1;
2850         for (; pit2 < npit && y2 <= height_; ++pit2) {
2851                 tm.redoParagraph(pit2);
2852                 ParagraphMetrics & pm = tm.par_metrics_[pit2];
2853                 y2 += pm.ascent();
2854                 // Save the paragraph position in the cache.
2855                 pm.setPosition(y2);
2856                 tm.updatePosCache(pit2);
2857                 y2 += pm.descent();
2858         }
2859
2860         LYXERR(Debug::PAINTING, "Metrics: "
2861                 << " anchor pit = " << d->anchor_pit_
2862                 << " anchor ypos = " << d->anchor_ypos_
2863                 << " y1 = " << y1
2864                 << " y2 = " << y2
2865                 << " pit1 = " << pit1
2866                 << " pit2 = " << pit2);
2867
2868         // metrics is done, full drawing is necessary now
2869         update_flags = (update_flags & ~Update::Force) | Update::ForceDraw;
2870
2871         // Now update the positions of insets in the cache.
2872         updatePosCache();
2873
2874         if (lyxerr.debugging(Debug::WORKAREA)) {
2875                 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
2876                 d->coord_cache_.dump();
2877         }
2878 }
2879
2880
2881 void BufferView::updatePosCache()
2882 {
2883         // this is the "nodraw" drawing stage: only set the positions of the
2884         // insets in metrics cache.
2885         frontend::NullPainter np;
2886         draw(np, false);
2887 }
2888
2889
2890 void BufferView::insertLyXFile(FileName const & fname)
2891 {
2892         LASSERT(d->cursor_.inTexted(), return);
2893
2894         // Get absolute path of file and add ".lyx"
2895         // to the filename if necessary
2896         FileName filename = fileSearch(string(), fname.absFileName(), "lyx");
2897
2898         docstring const disp_fn = makeDisplayPath(filename.absFileName());
2899         // emit message signal.
2900         message(bformat(_("Inserting document %1$s..."), disp_fn));
2901
2902         docstring res;
2903         Buffer buf(filename.absFileName(), false);
2904         if (buf.loadLyXFile() == Buffer::ReadSuccess) {
2905                 ErrorList & el = buffer_.errorList("Parse");
2906                 // Copy the inserted document error list into the current buffer one.
2907                 el = buf.errorList("Parse");
2908                 buffer_.undo().recordUndo(d->cursor_);
2909                 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
2910                                              buf.params().documentClassPtr(), el);
2911                 res = _("Document %1$s inserted.");
2912         } else {
2913                 res = _("Could not insert document %1$s");
2914         }
2915
2916         buffer_.changed(true);
2917         // emit message signal.
2918         message(bformat(res, disp_fn));
2919 }
2920
2921
2922 Point BufferView::coordOffset(DocIterator const & dit) const
2923 {
2924         int x = 0;
2925         int y = 0;
2926         int lastw = 0;
2927
2928         // Addup contribution of nested insets, from inside to outside,
2929         // keeping the outer paragraph for a special handling below
2930         for (size_t i = dit.depth() - 1; i >= 1; --i) {
2931                 CursorSlice const & sl = dit[i];
2932                 int xx = 0;
2933                 int yy = 0;
2934
2935                 // get relative position inside sl.inset()
2936                 sl.inset().cursorPos(*this, sl, dit.boundary() && (i + 1 == dit.depth()), xx, yy);
2937
2938                 // Make relative position inside of the edited inset relative to sl.inset()
2939                 x += xx;
2940                 y += yy;
2941
2942                 // In case of an RTL inset, the edited inset will be positioned to the left
2943                 // of xx:yy
2944                 if (sl.text()) {
2945                         bool boundary_i = dit.boundary() && i + 1 == dit.depth();
2946                         bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2947                         if (rtl)
2948                                 x -= lastw;
2949                 }
2950
2951                 // remember width for the case that sl.inset() is positioned in an RTL inset
2952                 lastw = sl.inset().dimension(*this).wid;
2953
2954                 //lyxerr << "Cursor::getPos, i: "
2955                 // << i << " x: " << xx << " y: " << y << endl;
2956         }
2957
2958         // Add contribution of initial rows of outermost paragraph
2959         CursorSlice const & sl = dit[0];
2960         TextMetrics const & tm = textMetrics(sl.text());
2961         ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2962
2963         LBUFERR(!pm.rows().empty());
2964         y -= pm.rows()[0].ascent();
2965 #if 1
2966         // FIXME: document this mess
2967         size_t rend;
2968         if (sl.pos() > 0 && dit.depth() == 1) {
2969                 int pos = sl.pos();
2970                 if (pos && dit.boundary())
2971                         --pos;
2972 //              lyxerr << "coordOffset: boundary:" << dit.boundary() << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
2973                 rend = pm.pos2row(pos);
2974         } else
2975                 rend = pm.pos2row(sl.pos());
2976 #else
2977         size_t rend = pm.pos2row(sl.pos());
2978 #endif
2979         for (size_t rit = 0; rit != rend; ++rit)
2980                 y += pm.rows()[rit].height();
2981         y += pm.rows()[rend].ascent();
2982
2983         TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
2984
2985         // Make relative position from the nested inset now bufferview absolute.
2986         int xx = bottom_tm.cursorX(dit.bottom(), dit.boundary() && dit.depth() == 1);
2987         x += xx;
2988
2989         // In the RTL case place the nested inset at the left of the cursor in
2990         // the outer paragraph
2991         bool boundary_1 = dit.boundary() && 1 == dit.depth();
2992         bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
2993         if (rtl)
2994                 x -= lastw;
2995
2996         return Point(x, y);
2997 }
2998
2999
3000 Point BufferView::getPos(DocIterator const & dit) const
3001 {
3002         if (!paragraphVisible(dit))
3003                 return Point(-1, -1);
3004
3005         CursorSlice const & bot = dit.bottom();
3006         TextMetrics const & tm = textMetrics(bot.text());
3007
3008         // offset from outer paragraph
3009         Point p = coordOffset(dit);
3010         p.y_ += tm.parMetrics(bot.pit()).position();
3011         return p;
3012 }
3013
3014
3015 bool BufferView::paragraphVisible(DocIterator const & dit) const
3016 {
3017         CursorSlice const & bot = dit.bottom();
3018         TextMetrics const & tm = textMetrics(bot.text());
3019
3020         return tm.contains(bot.pit());
3021 }
3022
3023
3024 void BufferView::setCaretAscentDescent(int asc, int des)
3025 {
3026         d->caret_ascent_ = asc;
3027         d->caret_descent_ = des;
3028 }
3029
3030
3031 void BufferView::caretPosAndHeight(Point & p, int & h) const
3032 {
3033         int asc, des;
3034         Cursor const & cur = cursor();
3035         if (cur.inMathed()) {
3036                 asc = d->caret_ascent_;
3037                 des = d->caret_descent_;
3038         } else {
3039                 Font const font = cur.real_current_font;
3040                 frontend::FontMetrics const & fm = theFontMetrics(font);
3041                 asc = fm.maxAscent();
3042                 des = fm.maxDescent();
3043         }
3044         h = asc + des;
3045         p = getPos(cur);
3046         p.y_ -= asc;
3047 }
3048
3049
3050 bool BufferView::cursorInView(Point const & p, int h) const
3051 {
3052         Cursor const & cur = cursor();
3053         // does the cursor touch the screen ?
3054         if (p.y_ + h < 0 || p.y_ >= workHeight() || !paragraphVisible(cur))
3055                 return false;
3056         return true;
3057 }
3058
3059
3060 int BufferView::horizScrollOffset() const
3061 {
3062         return d->horiz_scroll_offset_;
3063 }
3064
3065
3066 int BufferView::horizScrollOffset(Text const * text,
3067                                   pit_type pit, pos_type pos) const
3068 {
3069         // Is this a row that is currently scrolled?
3070         if (!d->current_row_slice_.empty()
3071             && &text->inset() == d->current_row_slice_.inset().asInsetText()
3072             && pit ==  d->current_row_slice_.pit()
3073             && pos ==  d->current_row_slice_.pos())
3074                 return d->horiz_scroll_offset_;
3075         return 0;
3076 }
3077
3078
3079 bool BufferView::hadHorizScrollOffset(Text const * text,
3080                                       pit_type pit, pos_type pos) const
3081 {
3082         return !d->last_row_slice_.empty()
3083                && &text->inset() == d->last_row_slice_.inset().asInsetText()
3084                && pit ==  d->last_row_slice_.pit()
3085                && pos ==  d->last_row_slice_.pos();
3086 }
3087
3088
3089 void BufferView::setCurrentRowSlice(CursorSlice const & rowSlice)
3090 {
3091         // nothing to do if the cursor was already on this row
3092         if (d->current_row_slice_ == rowSlice) {
3093                 d->last_row_slice_ = CursorSlice();
3094                 return;
3095         }
3096
3097         // if the (previous) current row was scrolled, we have to
3098         // remember it in order to repaint it next time.
3099         if (d->horiz_scroll_offset_ != 0)
3100                 d->last_row_slice_ = d->current_row_slice_;
3101         else
3102                 d->last_row_slice_ = CursorSlice();
3103
3104         // Since we changed row, the scroll offset is not valid anymore
3105         d->horiz_scroll_offset_ = 0;
3106         d->current_row_slice_ = rowSlice;
3107 }
3108
3109
3110 void BufferView::checkCursorScrollOffset()
3111 {
3112         CursorSlice rowSlice = d->cursor_.bottom();
3113         TextMetrics const & tm = textMetrics(rowSlice.text());
3114
3115         // Stop if metrics have not been computed yet, since it means
3116         // that there is nothing to do.
3117         if (!tm.contains(rowSlice.pit()))
3118                 return;
3119         ParagraphMetrics const & pm = tm.parMetrics(rowSlice.pit());
3120         Row const & row = pm.getRow(rowSlice.pos(),
3121                                     d->cursor_.boundary() && rowSlice == d->cursor_.top());
3122         rowSlice.pos() = row.pos();
3123
3124         // Set the row on which the cursor lives.
3125         setCurrentRowSlice(rowSlice);
3126
3127         // Current x position of the cursor in pixels
3128         int cur_x = getPos(d->cursor_).x_;
3129
3130         // Horizontal scroll offset of the cursor row in pixels
3131         int offset = d->horiz_scroll_offset_;
3132         int const MARGIN = 2 * theFontMetrics(d->cursor_.real_current_font).em()
3133                            + row.right_margin;
3134         if (row.right_x() <= workWidth() - row.right_margin) {
3135                 // Row is narrower than the work area, no offset needed.
3136                 offset = 0;
3137         } else {
3138                 if (cur_x - offset < MARGIN) {
3139                         // cursor would be too far right
3140                         offset = cur_x - MARGIN;
3141                 } else if (cur_x - offset > workWidth() - MARGIN) {
3142                         // cursor would be too far left
3143                         offset = cur_x - workWidth() + MARGIN;
3144                 }
3145                 // Correct the offset to make sure that we do not scroll too much
3146                 if (offset < 0)
3147                         offset = 0;
3148                 if (row.right_x() - offset < workWidth() - row.right_margin)
3149                         offset = row.right_x() - workWidth() + row.right_margin;
3150         }
3151
3152         //lyxerr << "cur_x=" << cur_x << ", offset=" << offset << ", row.wid=" << row.width() << ", margin=" << MARGIN << endl;
3153
3154         if (offset != d->horiz_scroll_offset_)
3155                 LYXERR(Debug::PAINTING, "Horiz. scroll offset changed from "
3156                        << d->horiz_scroll_offset_ << " to " << offset);
3157
3158         if (d->update_strategy_ == NoScreenUpdate
3159             && (offset != d->horiz_scroll_offset_
3160                 || !d->last_row_slice_.empty())) {
3161                 // FIXME: if one uses SingleParUpdate, then home/end
3162                 // will not work on long rows. Why?
3163                 d->update_strategy_ = FullScreenUpdate;
3164         }
3165
3166         d->horiz_scroll_offset_ = offset;
3167 }
3168
3169
3170 void BufferView::draw(frontend::Painter & pain, bool paint_caret)
3171 {
3172         if (height_ == 0 || width_ == 0)
3173                 return;
3174         LYXERR(Debug::PAINTING, (pain.isNull() ? "\t\t--- START NODRAW ---"
3175                                  : "\t\t*** START DRAWING ***"));
3176         Text & text = buffer_.text();
3177         TextMetrics const & tm = d->text_metrics_[&text];
3178         int const y = tm.first().second->position();
3179         PainterInfo pi(this, pain);
3180
3181         // Check whether the row where the cursor lives needs to be scrolled.
3182         // Update the drawing strategy if needed.
3183         checkCursorScrollOffset();
3184
3185         switch (d->update_strategy_) {
3186
3187         case NoScreenUpdate:
3188                 // no screen painting is actually needed. In nodraw stage
3189                 // however, the different coordinates of insets and paragraphs
3190                 // needs to be updated.
3191                 LYXERR(Debug::PAINTING, "Strategy: NoScreenUpdate");
3192                 pi.full_repaint = false;
3193                 if (pain.isNull()) {
3194                         pi.full_repaint = true;
3195                         tm.draw(pi, 0, y);
3196                 } else {
3197                         pi.full_repaint = false;
3198                         tm.draw(pi, 0, y);
3199                 }
3200                 break;
3201
3202         case SingleParUpdate:
3203                 pi.full_repaint = false;
3204                 LYXERR(Debug::PAINTING, "Strategy: SingleParUpdate");
3205                 // In general, only the current row of the outermost paragraph
3206                 // will be redrawn. Particular cases where selection spans
3207                 // multiple paragraph are correctly detected in TextMetrics.
3208                 tm.draw(pi, 0, y);
3209                 break;
3210
3211         case DecorationUpdate:
3212                 // FIXME: We should also distinguish DecorationUpdate to avoid text
3213                 // drawing if possible. This is not possible to do easily right now
3214                 // because of the single backing pixmap.
3215
3216         case FullScreenUpdate:
3217
3218                 LYXERR(Debug::PAINTING,
3219                        ((d->update_strategy_ == FullScreenUpdate)
3220                         ? "Strategy: FullScreenUpdate"
3221                         : "Strategy: DecorationUpdate"));
3222
3223                 // The whole screen, including insets, will be refreshed.
3224                 pi.full_repaint = true;
3225
3226                 // Clear background.
3227                 pain.fillRectangle(0, 0, width_, height_,
3228                         pi.backgroundColor(&buffer_.inset()));
3229
3230                 // Draw everything.
3231                 tm.draw(pi, 0, y);
3232
3233                 // and possibly grey out below
3234                 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3235                 int const y2 = lastpm.second->position() + lastpm.second->descent();
3236
3237                 if (y2 < height_) {
3238                         Color color = buffer().isInternal()
3239                                 ? Color_background : Color_bottomarea;
3240                         pain.fillRectangle(0, y2, width_, height_ - y2, color);
3241                 }
3242                 break;
3243         }
3244         LYXERR(Debug::PAINTING, (pain.isNull() ? "\t\t --- END NODRAW ---"
3245                                 : "\t\t *** END DRAWING ***"));
3246
3247         // The scrollbar needs an update.
3248         updateScrollbar();
3249
3250         // Normalize anchor for next time
3251         pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
3252         pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3253         for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
3254                 ParagraphMetrics const & pm = tm.parMetrics(pit);
3255                 if (pm.position() + pm.descent() > 0) {
3256                         if (d->anchor_pit_ != pit
3257                             || d->anchor_ypos_ != pm.position())
3258                                 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
3259                                        << "  anchor ypos = " << d->anchor_ypos_);
3260                         d->anchor_pit_ = pit;
3261                         d->anchor_ypos_ = pm.position();
3262                         break;
3263                 }
3264         }
3265         if (!pain.isNull()) {
3266                 // reset the update flags, everything has been done
3267                 d->update_flags_ = Update::None;
3268         }
3269
3270         // If a caret has to be painted, mark its text row as dirty to
3271         //make sure that it will be repainted on next redraw.
3272         /* FIXME: investigate whether this can be avoided when the cursor did not
3273          * move at all
3274          */
3275         if (paint_caret) {
3276                 Row const & caret_row = d->cursor_.textRow();
3277                 caret_row.changed(true);
3278         }
3279 }
3280
3281
3282 void BufferView::message(docstring const & msg)
3283 {
3284         if (d->gui_)
3285                 d->gui_->message(msg);
3286 }
3287
3288
3289 void BufferView::showDialog(string const & name)
3290 {
3291         if (d->gui_)
3292                 d->gui_->showDialog(name, string());
3293 }
3294
3295
3296 void BufferView::showDialog(string const & name,
3297         string const & data, Inset * inset)
3298 {
3299         if (d->gui_)
3300                 d->gui_->showDialog(name, data, inset);
3301 }
3302
3303
3304 void BufferView::updateDialog(string const & name, string const & data)
3305 {
3306         if (d->gui_)
3307                 d->gui_->updateDialog(name, data);
3308 }
3309
3310
3311 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
3312 {
3313         d->gui_ = gui;
3314 }
3315
3316
3317 // FIXME: Move this out of BufferView again
3318 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
3319 {
3320         if (!fname.isReadableFile()) {
3321                 docstring const error = from_ascii(strerror(errno));
3322                 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3323                 docstring const text =
3324                   bformat(_("Could not read the specified document\n"
3325                             "%1$s\ndue to the error: %2$s"), file, error);
3326                 Alert::error(_("Could not read file"), text);
3327                 return docstring();
3328         }
3329
3330         if (!fname.isReadableFile()) {
3331                 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3332                 docstring const text =
3333                   bformat(_("%1$s\n is not readable."), file);
3334                 Alert::error(_("Could not open file"), text);
3335                 return docstring();
3336         }
3337
3338         // FIXME UNICODE: We don't know the encoding of the file
3339         docstring file_content = fname.fileContents("UTF-8");
3340         if (file_content.empty()) {
3341                 Alert::error(_("Reading not UTF-8 encoded file"),
3342                              _("The file is not UTF-8 encoded.\n"
3343                                "It will be read as local 8Bit-encoded.\n"
3344                                "If this does not give the correct result\n"
3345                                "then please change the encoding of the file\n"
3346                                "to UTF-8 with a program other than LyX.\n"));
3347                 file_content = fname.fileContents("local8bit");
3348         }
3349
3350         return normalize_c(file_content);
3351 }
3352
3353
3354 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
3355 {
3356         docstring const tmpstr = contentsOfPlaintextFile(f);
3357
3358         if (tmpstr.empty())
3359                 return;
3360
3361         Cursor & cur = cursor();
3362         cap::replaceSelection(cur);
3363         buffer_.undo().recordUndo(cur);
3364         if (asParagraph)
3365                 cur.innerText()->insertStringAsParagraphs(cur, tmpstr, cur.current_font);
3366         else
3367                 cur.innerText()->insertStringAsLines(cur, tmpstr, cur.current_font);
3368
3369         buffer_.changed(true);
3370 }
3371
3372
3373 docstring const & BufferView::inlineCompletion() const
3374 {
3375         return d->inlineCompletion_;
3376 }
3377
3378
3379 size_t const & BufferView::inlineCompletionUniqueChars() const
3380 {
3381         return d->inlineCompletionUniqueChars_;
3382 }
3383
3384
3385 DocIterator const & BufferView::inlineCompletionPos() const
3386 {
3387         return d->inlineCompletionPos_;
3388 }
3389
3390
3391 void BufferView::resetInlineCompletionPos()
3392 {
3393         d->inlineCompletionPos_ = DocIterator();
3394 }
3395
3396
3397 bool samePar(DocIterator const & a, DocIterator const & b)
3398 {
3399         if (a.empty() && b.empty())
3400                 return true;
3401         if (a.empty() || b.empty())
3402                 return false;
3403         if (a.depth() != b.depth())
3404                 return false;
3405         return &a.innerParagraph() == &b.innerParagraph();
3406 }
3407
3408
3409 void BufferView::setInlineCompletion(Cursor const & cur, DocIterator const & pos,
3410         docstring const & completion, size_t uniqueChars)
3411 {
3412         uniqueChars = min(completion.size(), uniqueChars);
3413         bool changed = d->inlineCompletion_ != completion
3414                 || d->inlineCompletionUniqueChars_ != uniqueChars;
3415         bool singlePar = true;
3416         d->inlineCompletion_ = completion;
3417         d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
3418
3419         //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
3420
3421         // at new position?
3422         DocIterator const & old = d->inlineCompletionPos_;
3423         if (old != pos) {
3424                 //lyxerr << "inlineCompletionPos changed" << std::endl;
3425                 // old or pos are in another paragraph?
3426                 if ((!samePar(cur, pos) && !pos.empty())
3427                     || (!samePar(cur, old) && !old.empty())) {
3428                         singlePar = false;
3429                         //lyxerr << "different paragraph" << std::endl;
3430                 }
3431                 d->inlineCompletionPos_ = pos;
3432         }
3433
3434         // set update flags
3435         if (changed) {
3436                 if (singlePar && !(cur.result().screenUpdate() & Update::Force))
3437                         cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
3438                 else
3439                         cur.screenUpdateFlags(cur.result().screenUpdate() | Update::Force);
3440         }
3441 }
3442
3443
3444 bool BufferView::clickableInset() const
3445 {
3446         return d->clickable_inset_;
3447 }
3448
3449 } // namespace lyx