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