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 "LyX.h"
  38 #include "lyxfind.h"
  39 #include "LyXFunc.h"
  40 #include "Layout.h"
  41 #include "LyXRC.h"
  42 #include "MetricsInfo.h"
  43 #include "Paragraph.h"
  44 #include "paragraph_funcs.h"
  45 #include "ParagraphParameters.h"
  46 #include "ParIterator.h"
  47 #include "Session.h"
  48 #include "Text.h"
  49 #include "TextClass.h"
  50 #include "TextMetrics.h"
  51 #include "TexRow.h"
  52 #include "TocBackend.h"
  53 #include "VSpace.h"
  54 #include "WordLangTuple.h"
  55
  56 #include "insets/InsetBibtex.h"
  57 #include "insets/InsetCommand.h" // ChangeRefs
  58 #include "insets/InsetExternal.h"
  59 #include "insets/InsetGraphics.h"
  60 #include "insets/InsetRef.h"
  61 #include "insets/InsetText.h"
  62 #include "insets/InsetNote.h"
  63
  64 #include "frontends/alert.h"
  65 #include "frontends/Application.h"
  66 #include "frontends/Delegates.h"
  67 #include "frontends/FontMetrics.h"
  68 #include "frontends/Painter.h"
  69 #include "frontends/Selection.h"
  70
  71 #include "graphics/Previews.h"
  72
  73 #include "support/convert.h"
  74 #include "support/debug.h"
  75 #include "support/ExceptionMessage.h"
  76 #include "support/filetools.h"
  77 #include "support/gettext.h"
  78 #include "support/lstrings.h"
  79 #include "support/Package.h"
  80 #include "support/types.h"
  81
  82 #include <cerrno>
  83 #include <fstream>
  84 #include <functional>
  85 #include <iterator>
  86 #include <vector>
  87
  88 using namespace std;
  89 using namespace lyx::support;
  90
  91 namespace lyx {
  92
  93 namespace Alert = frontend::Alert;
  94
  95 namespace {
  96
  97 /// Return an inset of this class if it exists at the current cursor position
  98 template <class T>
  99 T * getInsetByCode(Cursor const & cur, InsetCode code)
 100 {
 101         DocIterator it = cur;
 102         Inset * inset = it.nextInset();
 103         if (inset && inset->lyxCode() == code)
 104                 return static_cast<T*>(inset);
 105         return 0;
 106 }
 107
 108
 109 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
 110         bool same_content);
 111
 112 bool findNextInset(DocIterator & dit, vector<InsetCode> const & codes,
 113         docstring const & contents)
 114 {
 115         DocIterator tmpdit = dit;
 116
 117         while (tmpdit) {
 118                 Inset const * inset = tmpdit.nextInset();
 119                 if (inset
 120                     && std::find(codes.begin(), codes.end(), inset->lyxCode()) != codes.end()
 121                     && (contents.empty() ||
 122                     static_cast<InsetCommand const *>(inset)->getFirstNonOptParam() == contents)) {
 123                         dit = tmpdit;
 124                         return true;
 125                 }
 126                 tmpdit.forwardInset();
 127         }
 128
 129         return false;
 130 }
 131
 132
 133 /// Looks for next inset with one of the given codes.
 134 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
 135         bool same_content)
 136 {
 137         docstring contents;
 138         DocIterator tmpdit = dit;
 139         tmpdit.forwardInset();
 140         if (!tmpdit)
 141                 return false;
 142
 143         if (same_content) {
 144                 Inset const * inset = tmpdit.nextInset();
 145                 if (inset
 146                     && std::find(codes.begin(), codes.end(), inset->lyxCode()) != codes.end()) {
 147                         contents = static_cast<InsetCommand const *>(inset)->getFirstNonOptParam();
 148                 }
 149         }
 150
 151         if (!findNextInset(tmpdit, codes, contents)) {
 152                 if (dit.depth() != 1 || dit.pit() != 0 || dit.pos() != 0) {
 153                         tmpdit  = doc_iterator_begin(tmpdit.bottom().inset());
 154                         if (!findNextInset(tmpdit, codes, contents))
 155                                 return false;
 156                 } else
 157                         return false;
 158         }
 159
 160         dit = tmpdit;
 161         return true;
 162 }
 163
 164
 165 /// Looks for next inset with the given code
 166 void findInset(DocIterator & dit, InsetCode code, bool same_content)
 167 {
 168         findInset(dit, vector<InsetCode>(1, code), same_content);
 169 }
 170
 171
 172 /// Moves cursor to the next inset with one of the given codes.
 173 void gotoInset(BufferView * bv, vector<InsetCode> const & codes,
 174                bool same_content)
 175 {
 176         Cursor tmpcur = bv->cursor();
 177         if (!findInset(tmpcur, codes, same_content)) {
 178                 bv->cursor().message(_("No more insets"));
 179                 return;
 180         }
 181
 182         tmpcur.clearSelection();
 183         bv->setCursor(tmpcur);
 184         bv->showCursor();
 185 }
 186
 187
 188 /// Moves cursor to the next inset with given code.
 189 void gotoInset(BufferView * bv, InsetCode code, bool same_content)
 190 {
 191         gotoInset(bv, vector<InsetCode>(1, code), same_content);
 192 }
 193
 194
 195 /// A map from a Text to the associated text metrics
 196 typedef map<Text const *, TextMetrics> TextMetricsCache;
 197
 198 enum ScreenUpdateStrategy {
 199         NoScreenUpdate,
 200         SingleParUpdate,
 201         FullScreenUpdate,
 202         DecorationUpdate
 203 };
 204
 205 } // anon namespace
 206
 207
 208 /////////////////////////////////////////////////////////////////////
 209 //
 210 // BufferView
 211 //
 212 /////////////////////////////////////////////////////////////////////
 213
 214 struct BufferView::Private
 215 {
 216         Private(BufferView & bv): wh_(0), cursor_(bv),
 217                 anchor_pit_(0), anchor_ypos_(0),
 218                 inlineCompletionUniqueChars_(0),
 219                 last_inset_(0), gui_(0)
 220         {}
 221
 222         ///
 223         ScrollbarParameters scrollbarParameters_;
 224         ///
 225         ScreenUpdateStrategy update_strategy_;
 226         ///
 227         CoordCache coord_cache_;
 228
 229         /// Estimated average par height for scrollbar.
 230         int wh_;
 231         /// this is used to handle XSelection events in the right manner.
 232         struct {
 233                 CursorSlice cursor;
 234                 CursorSlice anchor;
 235                 bool set;
 236         } xsel_cache_;
 237         ///
 238         Cursor cursor_;
 239         ///
 240         pit_type anchor_pit_;
 241         ///
 242         int anchor_ypos_;
 243         ///
 244         vector<int> par_height_;
 245
 246         ///
 247         DocIterator inlineCompletionPos_;
 248         ///
 249         docstring inlineCompletion_;
 250         ///
 251         size_t inlineCompletionUniqueChars_;
 252
 253         /// keyboard mapping object.
 254         Intl intl_;
 255
 256         /// last visited inset.
 257         /** kept to send setMouseHover(false).
 258           * Not owned, so don't delete.
 259           */
 260         Inset * last_inset_;
 261
 262         mutable TextMetricsCache text_metrics_;
 263
 264         /// Whom to notify.
 265         /** Not owned, so don't delete.
 266           */
 267         frontend::GuiBufferViewDelegate * gui_;
 268
 269         /// Cache for Find Next
 270         FuncRequest search_request_cache_;
 271 };
 272
 273
 274 BufferView::BufferView(Buffer & buf)
 275         : width_(0), height_(0), full_screen_(false), buffer_(buf), d(new Private(*this))
 276 {
 277         d->xsel_cache_.set = false;
 278         d->intl_.initKeyMapper(lyxrc.use_kbmap);
 279
 280         d->cursor_.push(buffer_.inset());
 281         d->cursor_.resetAnchor();
 282         d->cursor_.setCurrentFont();
 283
 284         if (graphics::Previews::status() != LyXRC::PREVIEW_OFF)
 285                 thePreviews().generateBufferPreviews(buffer_);
 286 }
 287
 288
 289 BufferView::~BufferView()
 290 {
 291         // current buffer is going to be switched-off, save cursor pos
 292         // Ideally, the whole cursor stack should be saved, but session
 293         // currently can only handle bottom (whole document) level pit and pos.
 294         // That is to say, if a cursor is in a nested inset, it will be
 295         // restore to the left of the top level inset.
 296         LastFilePosSection::FilePos fp;
 297         fp.pit = d->cursor_.bottom().pit();
 298         fp.pos = d->cursor_.bottom().pos();
 299         theSession().lastFilePos().save(buffer_.fileName(), fp);
 300
 301         delete d;
 302 }
 303
 304
 305 int BufferView::rightMargin() const
 306 {
 307         // The additional test for the case the outliner is opened.
 308         if (!full_screen_ ||
 309                 !lyxrc.full_screen_limit ||
 310                 width_ < lyxrc.full_screen_width + 20)
 311                         return 10;
 312
 313         return (width_ - lyxrc.full_screen_width) / 2;
 314 }
 315
 316
 317 int BufferView::leftMargin() const
 318 {
 319         return rightMargin();
 320 }
 321
 322
 323 bool BufferView::isTopScreen() const
 324 {
 325         return d->scrollbarParameters_.position == d->scrollbarParameters_.min;
 326 }
 327
 328
 329 bool BufferView::isBottomScreen() const
 330 {
 331         return d->scrollbarParameters_.position == d->scrollbarParameters_.max;
 332 }
 333
 334
 335 Intl & BufferView::getIntl()
 336 {
 337         return d->intl_;
 338 }
 339
 340
 341 Intl const & BufferView::getIntl() const
 342 {
 343         return d->intl_;
 344 }
 345
 346
 347 CoordCache & BufferView::coordCache()
 348 {
 349         return d->coord_cache_;
 350 }
 351
 352
 353 CoordCache const & BufferView::coordCache() const
 354 {
 355         return d->coord_cache_;
 356 }
 357
 358
 359 Buffer & BufferView::buffer()
 360 {
 361         return buffer_;
 362 }
 363
 364
 365 Buffer const & BufferView::buffer() const
 366 {
 367         return buffer_;
 368 }
 369
 370
 371 bool BufferView::fitCursor()
 372 {
 373         if (cursorStatus(d->cursor_) == CUR_INSIDE) {
 374                 frontend::FontMetrics const & fm =
 375                         theFontMetrics(d->cursor_.getFont().fontInfo());
 376                 int const asc = fm.maxAscent();
 377                 int const des = fm.maxDescent();
 378                 Point const p = getPos(d->cursor_, d->cursor_.boundary());
 379                 if (p.y_ - asc >= 0 && p.y_ + des < height_)
 380                         return false;
 381         }
 382         return true;
 383 }
 384
 385
 386 void BufferView::processUpdateFlags(Update::flags flags)
 387 {
 388         // last_inset_ points to the last visited inset. This pointer may become
 389         // invalid because of keyboard editing. Since all such operations
 390         // causes screen update(), I reset last_inset_ to avoid such a problem.
 391         d->last_inset_ = 0;
 392         // This is close to a hot-path.
 393         LYXERR(Debug::DEBUG, "BufferView::processUpdateFlags()"
 394                 << "[fitcursor = " << (flags & Update::FitCursor)
 395                 << ", forceupdate = " << (flags & Update::Force)
 396                 << ", singlepar = " << (flags & Update::SinglePar)
 397                 << "]  buffer: " << &buffer_);
 398
 399         buffer_.updateMacros();
 400
 401         // Now do the first drawing step if needed. This consists on updating
 402         // the CoordCache in updateMetrics().
 403         // The second drawing step is done in WorkArea::redraw() if needed.
 404
 405         // Case when no explicit update is requested.
 406         if (!flags) {
 407                 // no need to redraw anything.
 408                 d->update_strategy_ = NoScreenUpdate;
 409                 return;
 410         }
 411
 412         if (flags == Update::Decoration) {
 413                 d->update_strategy_ = DecorationUpdate;
 414                 buffer_.changed();
 415                 return;
 416         }
 417
 418         if (flags == Update::FitCursor
 419                 || flags == (Update::Decoration | Update::FitCursor)) {
 420                 // tell the frontend to update the screen if needed.
 421                 if (fitCursor()) {
 422                         showCursor();
 423                         return;
 424                 }
 425                 if (flags & Update::Decoration) {
 426                         d->update_strategy_ = DecorationUpdate;
 427                         buffer_.changed();
 428                         return;
 429                 }
 430                 // no screen update is needed.
 431                 d->update_strategy_ = NoScreenUpdate;
 432                 return;
 433         }
 434
 435         bool const full_metrics = flags & Update::Force || !singleParUpdate();
 436
 437         if (full_metrics)
 438                 // We have to update the full screen metrics.
 439                 updateMetrics();
 440
 441         if (!(flags & Update::FitCursor)) {
 442                 // Nothing to do anymore. Trigger a redraw and return
 443                 buffer_.changed();
 444                 return;
 445         }
 446
 447         // updateMetrics() does not update paragraph position
 448         // This is done at draw() time. So we need a redraw!
 449         buffer_.changed();
 450
 451         if (fitCursor()) {
 452                 // The cursor is off screen so ensure it is visible.
 453                 // refresh it:
 454                 showCursor();
 455         }
 456 }
 457
 458
 459 void BufferView::updateScrollbar()
 460 {
 461         if (height_ == 0 && width_ == 0)
 462                 return;
 463
 464         // We prefer fixed size line scrolling.
 465         d->scrollbarParameters_.single_step = defaultRowHeight();
 466         // We prefer full screen page scrolling.
 467         d->scrollbarParameters_.page_step = height_;
 468
 469         Text & t = buffer_.text();
 470         TextMetrics & tm = d->text_metrics_[&t];
 471
 472         LYXERR(Debug::GUI, " Updating scrollbar: height: "
 473                 << t.paragraphs().size()
 474                 << " curr par: " << d->cursor_.bottom().pit()
 475                 << " default height " << defaultRowHeight());
 476
 477         size_t const parsize = t.paragraphs().size();
 478         if (d->par_height_.size() != parsize) {
 479                 d->par_height_.clear();
 480                 // FIXME: We assume a default paragraph height of 2 rows. This
 481                 // should probably be pondered with the screen width.
 482                 d->par_height_.resize(parsize, defaultRowHeight() * 2);
 483         }
 484
 485         // Look at paragraph heights on-screen
 486         pair<pit_type, ParagraphMetrics const *> first = tm.first();
 487         pair<pit_type, ParagraphMetrics const *> last = tm.last();
 488         for (pit_type pit = first.first; pit <= last.first; ++pit) {
 489                 d->par_height_[pit] = tm.parMetrics(pit).height();
 490                 LYXERR(Debug::SCROLLING, "storing height for pit " << pit << " : "
 491                         << d->par_height_[pit]);
 492         }
 493
 494         int top_pos = first.second->position() - first.second->ascent();
 495         int bottom_pos = last.second->position() + last.second->descent();
 496         bool first_visible = first.first == 0 && top_pos >= 0;
 497         bool last_visible = last.first + 1 == int(parsize) && bottom_pos <= height_;
 498         if (first_visible && last_visible) {
 499                 d->scrollbarParameters_.min = 0;
 500                 d->scrollbarParameters_.max = 0;
 501                 return;
 502         }
 503
 504         d->scrollbarParameters_.min = top_pos;
 505         for (size_t i = 0; i != size_t(first.first); ++i)
 506                 d->scrollbarParameters_.min -= d->par_height_[i];
 507         d->scrollbarParameters_.max = bottom_pos;
 508         for (size_t i = last.first + 1; i != parsize; ++i)
 509                 d->scrollbarParameters_.max += d->par_height_[i];
 510
 511         d->scrollbarParameters_.position = 0;
 512         // The reference is the top position so we remove one page.
 513         d->scrollbarParameters_.max -= d->scrollbarParameters_.page_step;
 514 }
 515
 516
 517 ScrollbarParameters const & BufferView::scrollbarParameters() const
 518 {
 519         return d->scrollbarParameters_;
 520 }
 521
 522
 523 docstring BufferView::toolTip(int x, int y) const
 524 {
 525         // Get inset under mouse, if there is one.
 526         Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
 527         if (!covering_inset)
 528                 // No inset, no tooltip...
 529                 return docstring();
 530         return covering_inset->toolTip(*this, x, y);
 531 }
 532
 533
 534 docstring BufferView::contextMenu(int x, int y) const
 535 {
 536         // Get inset under mouse, if there is one.
 537         Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
 538         if (covering_inset)
 539                 return covering_inset->contextMenu(*this, x, y);
 540
 541         return buffer_.inset().contextMenu(*this, x, y);
 542 }
 543
 544
 545 void BufferView::scrollDocView(int value)
 546 {
 547         int const offset = value - d->scrollbarParameters_.position;
 548         // If the offset is less than 2 screen height, prefer to scroll instead.
 549         if (abs(offset) <= 2 * height_) {
 550                 scroll(offset);
 551                 updateMetrics();
 552                 buffer_.changed();
 553                 return;
 554         }
 555
 556         // cut off at the top
 557         if (value <= d->scrollbarParameters_.min) {
 558                 DocIterator dit = doc_iterator_begin(buffer_.inset());
 559                 showCursor(dit);
 560                 LYXERR(Debug::SCROLLING, "scroll to top");
 561                 return;
 562         }
 563
 564         // cut off at the bottom
 565         if (value >= d->scrollbarParameters_.max) {
 566                 DocIterator dit = doc_iterator_end(buffer_.inset());
 567                 dit.backwardPos();
 568                 showCursor(dit);
 569                 LYXERR(Debug::SCROLLING, "scroll to bottom");
 570                 return;
 571         }
 572
 573         // find paragraph at target position
 574         int par_pos = d->scrollbarParameters_.min;
 575         pit_type i = 0;
 576         for (; i != int(d->par_height_.size()); ++i) {
 577                 par_pos += d->par_height_[i];
 578                 if (par_pos >= value)
 579                         break;
 580         }
 581
 582         if (par_pos < value) {
 583                 // It seems we didn't find the correct pit so stay on the safe side and
 584                 // scroll to bottom.
 585                 LYXERR0("scrolling position not found!");
 586                 scrollDocView(d->scrollbarParameters_.max);
 587                 return;
 588         }
 589
 590         DocIterator dit = doc_iterator_begin(buffer_.inset());
 591         dit.pit() = i;
 592         LYXERR(Debug::SCROLLING, "value = " << value << " -> scroll to pit " << i);
 593         showCursor(dit);
 594 }
 595
 596
 597 // FIXME: this method is not working well.
 598 void BufferView::setCursorFromScrollbar()
 599 {
 600         TextMetrics & tm = d->text_metrics_[&buffer_.text()];
 601
 602         int const height = 2 * defaultRowHeight();
 603         int const first = height;
 604         int const last = height_ - height;
 605         Cursor & cur = d->cursor_;
 606
 607         switch (cursorStatus(cur)) {
 608         case CUR_ABOVE:
 609                 // We reset the cursor because cursorStatus() does not
 610                 // work when the cursor is within mathed.
 611                 cur.reset(buffer_.inset());
 612                 tm.setCursorFromCoordinates(cur, 0, first);
 613                 cur.clearSelection();
 614                 break;
 615         case CUR_BELOW:
 616                 // We reset the cursor because cursorStatus() does not
 617                 // work when the cursor is within mathed.
 618                 cur.reset(buffer_.inset());
 619                 tm.setCursorFromCoordinates(cur, 0, last);
 620                 cur.clearSelection();
 621                 break;
 622         case CUR_INSIDE:
 623                 int const y = getPos(cur, cur.boundary()).y_;
 624                 int const newy = min(last, max(y, first));
 625                 if (y != newy) {
 626                         cur.reset(buffer_.inset());
 627                         tm.setCursorFromCoordinates(cur, 0, newy);
 628                 }
 629         }
 630 }
 631
 632
 633 Change const BufferView::getCurrentChange() const
 634 {
 635         if (!d->cursor_.selection())
 636                 return Change(Change::UNCHANGED);
 637
 638         DocIterator dit = d->cursor_.selectionBegin();
 639         return dit.paragraph().lookupChange(dit.pos());
 640 }
 641
 642
 643 // this could be used elsewhere as well?
 644 // FIXME: This does not work within mathed!
 645 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
 646 {
 647         Point const p = getPos(dit, dit.boundary());
 648         if (p.y_ < 0)
 649                 return CUR_ABOVE;
 650         if (p.y_ > workHeight())
 651                 return CUR_BELOW;
 652         return CUR_INSIDE;
 653 }
 654
 655
 656 void BufferView::saveBookmark(unsigned int idx)
 657 {
 658         // tenatively save bookmark, id and pos will be used to
 659         // acturately locate a bookmark in a 'live' lyx session.
 660         // pit and pos will be updated with bottom level pit/pos
 661         // when lyx exits.
 662         theSession().bookmarks().save(
 663                 buffer_.fileName(),
 664                 d->cursor_.bottom().pit(),
 665                 d->cursor_.bottom().pos(),
 666                 d->cursor_.paragraph().id(),
 667                 d->cursor_.pos(),
 668                 idx
 669         );
 670         if (idx)
 671                 // emit message signal.
 672                 message(_("Save bookmark"));
 673 }
 674
 675
 676 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
 677         int top_id, pos_type top_pos)
 678 {
 679         bool success = false;
 680         DocIterator dit;
 681
 682         d->cursor_.clearSelection();
 683
 684         // if a valid par_id is given, try it first
 685         // This is the case for a 'live' bookmark when unique paragraph ID
 686         // is used to track bookmarks.
 687         if (top_id > 0) {
 688                 dit = buffer_.getParFromID(top_id);
 689                 if (!dit.atEnd()) {
 690                         dit.pos() = min(dit.paragraph().size(), top_pos);
 691                         // Some slices of the iterator may not be
 692                         // reachable (e.g. closed collapsable inset)
 693                         // so the dociterator may need to be
 694                         // shortened. Otherwise, setCursor may crash
 695                         // lyx when the cursor can not be set to these
 696                         // insets.
 697                         size_t const n = dit.depth();
 698                         for (size_t i = 0; i < n; ++i)
 699                                 if (dit[i].inset().editable() != Inset::HIGHLY_EDITABLE) {
 700                                         dit.resize(i);
 701                                         break;
 702                                 }
 703                         success = true;
 704                 }
 705         }
 706
 707         // if top_id == 0, or searching through top_id failed
 708         // This is the case for a 'restored' bookmark when only bottom
 709         // (document level) pit was saved. Because of this, bookmark
 710         // restoration is inaccurate. If a bookmark was within an inset,
 711         // it will be restored to the left of the outmost inset that contains
 712         // the bookmark.
 713         if (bottom_pit < int(buffer_.paragraphs().size())) {
 714                 dit = doc_iterator_begin(buffer_.inset());
 715
 716                 dit.pit() = bottom_pit;
 717                 dit.pos() = min(bottom_pos, dit.paragraph().size());
 718                 success = true;
 719         }
 720
 721         if (success) {
 722                 // Note: only bottom (document) level pit is set.
 723                 setCursor(dit);
 724                 // set the current font.
 725                 d->cursor_.setCurrentFont();
 726                 // To center the screen on this new position we need the
 727                 // paragraph position which is computed at draw() time.
 728                 // So we need a redraw!
 729                 buffer_.changed();
 730                 if (fitCursor())
 731                         showCursor();
 732         }
 733
 734         return success;
 735 }
 736
 737
 738 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
 739 {
 740         if (lyxrc.rtl_support) {
 741                 if (d->cursor_.real_current_font.isRightToLeft()) {
 742                         if (d->intl_.keymap == Intl::PRIMARY)
 743                                 d->intl_.keyMapSec();
 744                 } else {
 745                         if (d->intl_.keymap == Intl::SECONDARY)
 746                                 d->intl_.keyMapPrim();
 747                 }
 748         }
 749
 750         d->intl_.getTransManager().translateAndInsert(c, t, cur);
 751 }
 752
 753
 754 int BufferView::workWidth() const
 755 {
 756         return width_;
 757 }
 758
 759
 760 void BufferView::showCursor()
 761 {
 762         showCursor(d->cursor_);
 763 }
 764
 765
 766 void BufferView::showCursor(DocIterator const & dit)
 767 {
 768         // We are not properly started yet, delay until resizing is
 769         // done.
 770         if (height_ == 0)
 771                 return;
 772
 773         LYXERR(Debug::SCROLLING, "recentering!");
 774
 775         CursorSlice const & bot = dit.bottom();
 776         TextMetrics & tm = d->text_metrics_[bot.text()];
 777
 778         pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
 779         int bot_pit = bot.pit();
 780         if (bot_pit > max_pit) {
 781                 // FIXME: Why does this happen?
 782                 LYXERR0("bottom pit is greater that max pit: "
 783                         << bot_pit << " > " << max_pit);
 784                 bot_pit = max_pit;
 785         }
 786
 787         if (bot_pit == tm.first().first - 1)
 788                 tm.newParMetricsUp();
 789         else if (bot_pit == tm.last().first + 1)
 790                 tm.newParMetricsDown();
 791
 792         if (tm.contains(bot_pit)) {
 793                 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
 794                 LASSERT(!pm.rows().empty(), /**/);
 795                 // FIXME: smooth scrolling doesn't work in mathed.
 796                 CursorSlice const & cs = dit.innerTextSlice();
 797                 int offset = coordOffset(dit, dit.boundary()).y_;
 798                 int ypos = pm.position() + offset;
 799                 Dimension const & row_dim =
 800                         pm.getRow(cs.pos(), dit.boundary()).dimension();
 801                 int scrolled = 0;
 802                 if (ypos - row_dim.ascent() < 0)
 803                         scrolled = scrollUp(- ypos + row_dim.ascent());
 804                 else if (ypos + row_dim.descent() > height_)
 805                         scrolled = scrollDown(ypos - height_ + row_dim.descent());
 806                 // else, nothing to do, the cursor is already visible so we just return.
 807                 if (scrolled != 0) {
 808                         updateMetrics();
 809                         buffer_.changed();
 810                 }
 811                 return;
 812         }
 813
 814         // fix inline completion position
 815         if (d->inlineCompletionPos_.fixIfBroken())
 816                 d->inlineCompletionPos_ = DocIterator();
 817
 818         tm.redoParagraph(bot_pit);
 819         ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
 820         int offset = coordOffset(dit, dit.boundary()).y_;
 821
 822         d->anchor_pit_ = bot_pit;
 823         CursorSlice const & cs = dit.innerTextSlice();
 824         Dimension const & row_dim =
 825                 pm.getRow(cs.pos(), dit.boundary()).dimension();
 826
 827         if (d->anchor_pit_ == 0)
 828                 d->anchor_ypos_ = offset + pm.ascent();
 829         else if (d->anchor_pit_ == max_pit)
 830                 d->anchor_ypos_ = height_ - offset - row_dim.descent();
 831         else
 832                 d->anchor_ypos_ = defaultRowHeight() * 2 - offset - row_dim.descent();
 833
 834         updateMetrics();
 835         buffer_.changed();
 836 }
 837
 838
 839 FuncStatus BufferView::getStatus(FuncRequest const & cmd)
 840 {
 841         FuncStatus flag;
 842
 843         Cursor & cur = d->cursor_;
 844
 845         switch (cmd.action) {
 846
 847         case LFUN_UNDO:
 848                 flag.setEnabled(buffer_.undo().hasUndoStack());
 849                 break;
 850         case LFUN_REDO:
 851                 flag.setEnabled(buffer_.undo().hasRedoStack());
 852                 break;
 853         case LFUN_FILE_INSERT:
 854         case LFUN_FILE_INSERT_PLAINTEXT_PARA:
 855         case LFUN_FILE_INSERT_PLAINTEXT:
 856         case LFUN_BOOKMARK_SAVE:
 857                 // FIXME: Actually, these LFUNS should be moved to Text
 858                 flag.setEnabled(cur.inTexted());
 859                 break;
 860         case LFUN_FONT_STATE:
 861         case LFUN_LABEL_INSERT:
 862         case LFUN_INFO_INSERT:
 863         case LFUN_INSET_EDIT:
 864         case LFUN_PARAGRAPH_GOTO:
 865         case LFUN_NOTE_NEXT:
 866         case LFUN_REFERENCE_NEXT:
 867         case LFUN_WORD_FIND:
 868         case LFUN_WORD_REPLACE:
 869         case LFUN_MARK_OFF:
 870         case LFUN_MARK_ON:
 871         case LFUN_MARK_TOGGLE:
 872         case LFUN_SCREEN_RECENTER:
 873         case LFUN_BIBTEX_DATABASE_ADD:
 874         case LFUN_BIBTEX_DATABASE_DEL:
 875         case LFUN_GRAPHICS_GROUPS_UNIFY:
 876         case LFUN_NOTES_MUTATE:
 877         case LFUN_ALL_INSETS_TOGGLE:
 878         case LFUN_STATISTICS:
 879                 flag.setEnabled(true);
 880                 break;
 881
 882         case LFUN_NEXT_INSET_TOGGLE:
 883         case LFUN_NEXT_INSET_MODIFY: {
 884                 // this is the real function we want to invoke
 885                 FuncRequest tmpcmd = cmd;
 886                 tmpcmd.action = (cmd.action == LFUN_NEXT_INSET_TOGGLE)
 887                         ? LFUN_INSET_TOGGLE : LFUN_INSET_MODIFY;
 888                 // if there is an inset at cursor, see whether it
 889                 // handles the lfun, other start from scratch
 890                 Inset * inset = cur.nextInset();
 891                 if (!inset || !inset->getStatus(cur, tmpcmd, flag))
 892                         flag = lyx::getStatus(tmpcmd);
 893                 break;
 894         }
 895
 896         case LFUN_LABEL_GOTO: {
 897                 flag.setEnabled(!cmd.argument().empty()
 898                     || getInsetByCode<InsetRef>(cur, REF_CODE));
 899                 break;
 900         }
 901
 902         case LFUN_CHANGES_TRACK:
 903                 flag.setEnabled(true);
 904                 flag.setOnOff(buffer_.params().trackChanges);
 905                 break;
 906
 907         case LFUN_CHANGES_OUTPUT:
 908                 flag.setEnabled(true);
 909                 flag.setOnOff(buffer_.params().outputChanges);
 910                 break;
 911
 912         case LFUN_CHANGES_MERGE:
 913         case LFUN_CHANGE_NEXT:
 914         case LFUN_ALL_CHANGES_ACCEPT:
 915         case LFUN_ALL_CHANGES_REJECT:
 916                 // TODO: context-sensitive enabling of LFUNs
 917                 // In principle, these command should only be enabled if there
 918                 // is a change in the document. However, without proper
 919                 // optimizations, this will inevitably result in poor performance.
 920                 flag.setEnabled(true);
 921                 break;
 922
 923         case LFUN_BUFFER_TOGGLE_COMPRESSION: {
 924                 flag.setOnOff(buffer_.params().compressed);
 925                 break;
 926         }
 927
 928         case LFUN_SCREEN_UP:
 929         case LFUN_SCREEN_DOWN:
 930         case LFUN_SCROLL:
 931         case LFUN_SCREEN_UP_SELECT:
 932         case LFUN_SCREEN_DOWN_SELECT:
 933                 flag.setEnabled(true);
 934                 break;
 935
 936         case LFUN_LAYOUT_TABULAR:
 937                 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
 938                 break;
 939
 940         case LFUN_LAYOUT:
 941                 flag.setEnabled(!cur.inset().forcePlainLayout(cur.idx()));
 942                 break;
 943
 944         case LFUN_LAYOUT_PARAGRAPH:
 945                 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
 946                 break;
 947
 948         case LFUN_INSET_SETTINGS: {
 949                 InsetCode code = cur.inset().lyxCode();
 950                 if (cmd.getArg(0) == insetName(code)) {
 951                         flag.setEnabled(true);
 952                         break;
 953                 }
 954                 bool enable = false;
 955                 InsetCode next_code = cur.nextInset()
 956                         ? cur.nextInset()->lyxCode() : NO_CODE;
 957                 //FIXME: remove these special cases:
 958                 switch (next_code) {
 959                         case TABULAR_CODE:
 960                         case ERT_CODE:
 961                         case FLOAT_CODE:
 962                         case WRAP_CODE:
 963                         case NOTE_CODE:
 964                         case BRANCH_CODE:
 965                         case BOX_CODE:
 966                         case LISTINGS_CODE:
 967                                 enable = (cmd.argument().empty() ||
 968                                           cmd.getArg(0) == insetName(next_code));
 969                                 break;
 970                         default:
 971                                 break;
 972                 }
 973                 flag.setEnabled(enable);
 974                 break;
 975         }
 976
 977         case LFUN_DIALOG_SHOW_NEW_INSET:
 978                 flag.setEnabled(cur.inset().lyxCode() != ERT_CODE &&
 979                         cur.inset().lyxCode() != LISTINGS_CODE);
 980                 if (cur.inset().lyxCode() == CAPTION_CODE) {
 981                         FuncStatus flag;
 982                         if (cur.inset().getStatus(cur, cmd, flag))
 983                                 return flag;
 984                 }
 985                 break;
 986
 987         case LFUN_BRANCH_ACTIVATE:
 988         case LFUN_BRANCH_DEACTIVATE: {
 989                 bool enable = false;
 990                 docstring const branchName = cmd.argument();
 991                 if (!branchName.empty())
 992                         enable = buffer_.params().branchlist().find(branchName);
 993                 flag.setEnabled(enable);
 994                 break;
 995         }
 996
 997         default:
 998                 flag.setEnabled(false);
 999         }
1000
1001         return flag;
1002 }
1003
1004
1005 bool BufferView::dispatch(FuncRequest const & cmd)
1006 {
1007         //lyxerr << [ cmd = " << cmd << "]" << endl;
1008
1009         // Make sure that the cached BufferView is correct.
1010         LYXERR(Debug::ACTION, " action[" << cmd.action << ']'
1011                 << " arg[" << to_utf8(cmd.argument()) << ']'
1012                 << " x[" << cmd.x << ']'
1013                 << " y[" << cmd.y << ']'
1014                 << " button[" << cmd.button() << ']');
1015
1016         Cursor & cur = d->cursor_;
1017
1018         switch (cmd.action) {
1019
1020         case LFUN_UNDO:
1021                 cur.message(_("Undo"));
1022                 cur.clearSelection();
1023                 if (!cur.textUndo())
1024                         cur.message(_("No further undo information"));
1025                 else
1026                         processUpdateFlags(Update::Force | Update::FitCursor);
1027                 break;
1028
1029         case LFUN_REDO:
1030                 cur.message(_("Redo"));
1031                 cur.clearSelection();
1032                 if (!cur.textRedo())
1033                         cur.message(_("No further redo information"));
1034                 else
1035                         processUpdateFlags(Update::Force | Update::FitCursor);
1036                 break;
1037
1038         case LFUN_FONT_STATE:
1039                 cur.message(cur.currentState());
1040                 break;
1041
1042         case LFUN_BOOKMARK_SAVE:
1043                 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1044                 break;
1045
1046         case LFUN_LABEL_GOTO: {
1047                 docstring label = cmd.argument();
1048                 if (label.empty()) {
1049                         InsetRef * inset =
1050                                 getInsetByCode<InsetRef>(d->cursor_,
1051                                                          REF_CODE);
1052                         if (inset) {
1053                                 label = inset->getParam("reference");
1054                                 // persistent=false: use temp_bookmark
1055                                 saveBookmark(0);
1056                         }
1057                 }
1058
1059                 if (!label.empty())
1060                         gotoLabel(label);
1061                 break;
1062         }
1063
1064         case LFUN_INSET_EDIT: {
1065                 FuncRequest fr(cmd);
1066                 // if there is an inset at cursor, see whether it
1067                 // can be modified.
1068                 Inset * inset = cur.nextInset();
1069                 if (inset)
1070                         inset->dispatch(cur, fr);
1071                 // if it did not work, try the underlying inset.
1072                 if (!inset || !cur.result().dispatched())
1073                         cur.dispatch(cmd);
1074
1075                 // FIXME I'm adding the last break to solve a crash,
1076                 // but that is obviously not right.
1077                 if (!cur.result().dispatched())
1078                         // It did not work too; no action needed.
1079                         break;
1080                 break;
1081         }
1082
1083         case LFUN_PARAGRAPH_GOTO: {
1084                 int const id = convert<int>(cmd.getArg(0));
1085                 int const pos = convert<int>(cmd.getArg(1));
1086                 int i = 0;
1087                 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1088                         b = theBufferList().next(b)) {
1089
1090                         DocIterator dit = b->getParFromID(id);
1091                         if (dit.atEnd()) {
1092                                 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1093                                 ++i;
1094                                 continue;
1095                         }
1096                         LYXERR(Debug::INFO, "Paragraph " << dit.paragraph().id()
1097                                 << " found in buffer `"
1098                                 << b->absFileName() << "'.");
1099
1100                         if (b == &buffer_) {
1101                                 // Set the cursor
1102                                 dit.pos() = pos;
1103                                 setCursor(dit);
1104                                 processUpdateFlags(Update::Force | Update::FitCursor);
1105                         } else {
1106                                 // Switch to other buffer view and resend cmd
1107                                 theLyXFunc().dispatch(FuncRequest(
1108                                         LFUN_BUFFER_SWITCH, b->absFileName()));
1109                                 theLyXFunc().dispatch(cmd);
1110                         }
1111                         break;
1112                 }
1113                 break;
1114         }
1115
1116         case LFUN_NOTE_NEXT:
1117                 gotoInset(this, NOTE_CODE, false);
1118                 break;
1119
1120         case LFUN_REFERENCE_NEXT: {
1121                 vector<InsetCode> tmp;
1122                 tmp.push_back(LABEL_CODE);
1123                 tmp.push_back(REF_CODE);
1124                 gotoInset(this, tmp, true);
1125                 break;
1126         }
1127
1128         case LFUN_CHANGES_TRACK:
1129                 buffer_.params().trackChanges = !buffer_.params().trackChanges;
1130                 break;
1131
1132         case LFUN_CHANGES_OUTPUT:
1133                 buffer_.params().outputChanges = !buffer_.params().outputChanges;
1134                 if (buffer_.params().outputChanges) {
1135                         bool dvipost    = LaTeXFeatures::isAvailable("dvipost");
1136                         bool xcolorsoul = LaTeXFeatures::isAvailable("soul") &&
1137                                           LaTeXFeatures::isAvailable("xcolor");
1138
1139                         if (!dvipost && !xcolorsoul) {
1140                                 Alert::warning(_("Changes not shown in LaTeX output"),
1141                                                _("Changes will not be highlighted in LaTeX output, "
1142                                                  "because neither dvipost nor xcolor/soul are installed.\n"
1143                                                  "Please install these packages or redefine "
1144                                                  "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1145                         } else if (!xcolorsoul) {
1146                                 Alert::warning(_("Changes not shown in LaTeX output"),
1147                                                _("Changes will not be highlighted in LaTeX output "
1148                                                  "when using pdflatex, because xcolor and soul are not installed.\n"
1149                                                  "Please install both packages or redefine "
1150                                                  "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1151                         }
1152                 }
1153                 break;
1154
1155         case LFUN_CHANGE_NEXT:
1156                 findNextChange(this);
1157                 break;
1158
1159         case LFUN_CHANGES_MERGE:
1160                 if (findNextChange(this))
1161                         showDialog("changes");
1162                 break;
1163
1164         case LFUN_ALL_CHANGES_ACCEPT:
1165                 // select complete document
1166                 d->cursor_.reset(buffer_.inset());
1167                 d->cursor_.selHandle(true);
1168                 buffer_.text().cursorBottom(d->cursor_);
1169                 // accept everything in a single step to support atomic undo
1170                 buffer_.text().acceptOrRejectChanges(d->cursor_, Text::ACCEPT);
1171                 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1172                 processUpdateFlags(Update::Force | Update::FitCursor);
1173                 break;
1174
1175         case LFUN_ALL_CHANGES_REJECT:
1176                 // select complete document
1177                 d->cursor_.reset(buffer_.inset());
1178                 d->cursor_.selHandle(true);
1179                 buffer_.text().cursorBottom(d->cursor_);
1180                 // reject everything in a single step to support atomic undo
1181                 // Note: reject does not work recursively; the user may have to repeat the operation
1182                 buffer_.text().acceptOrRejectChanges(d->cursor_, Text::REJECT);
1183                 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1184                 processUpdateFlags(Update::Force | Update::FitCursor);
1185                 break;
1186
1187         case LFUN_WORD_FIND: {
1188                 FuncRequest req = cmd;
1189                 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1190                         req = d->search_request_cache_;
1191                 if (find(this, req))
1192                         showCursor();
1193                 else
1194                         message(_("String not found!"));
1195                 d->search_request_cache_ = req;
1196                 break;
1197         }
1198
1199         case LFUN_WORD_REPLACE: {
1200                 bool has_deleted = false;
1201                 if (cur.selection()) {
1202                         DocIterator beg = cur.selectionBegin();
1203                         DocIterator end = cur.selectionEnd();
1204                         if (beg.pit() == end.pit()) {
1205                                 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1206                                         if (cur.paragraph().isDeleted(p))
1207                                                 has_deleted = true;
1208                                 }
1209                         }
1210                 }
1211                 replace(this, cmd, has_deleted);
1212                 break;
1213         }
1214
1215         case LFUN_MARK_OFF:
1216                 cur.clearSelection();
1217                 cur.resetAnchor();
1218                 cur.message(from_utf8(N_("Mark off")));
1219                 break;
1220
1221         case LFUN_MARK_ON:
1222                 cur.clearSelection();
1223                 cur.mark() = true;
1224                 cur.resetAnchor();
1225                 cur.message(from_utf8(N_("Mark on")));
1226                 break;
1227
1228         case LFUN_MARK_TOGGLE:
1229                 cur.clearSelection();
1230                 if (cur.mark()) {
1231                         cur.mark() = false;
1232                         cur.message(from_utf8(N_("Mark removed")));
1233                 } else {
1234                         cur.mark() = true;
1235                         cur.message(from_utf8(N_("Mark set")));
1236                 }
1237                 cur.resetAnchor();
1238                 break;
1239
1240         case LFUN_SCREEN_RECENTER:
1241                 showCursor();
1242                 break;
1243
1244         case LFUN_BIBTEX_DATABASE_ADD: {
1245                 Cursor tmpcur = d->cursor_;
1246                 findInset(tmpcur, BIBTEX_CODE, false);
1247                 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1248                                                 BIBTEX_CODE);
1249                 if (inset) {
1250                         if (inset->addDatabase(cmd.argument()))
1251                                 buffer_.updateBibfilesCache();
1252                 }
1253                 break;
1254         }
1255
1256         case LFUN_BIBTEX_DATABASE_DEL: {
1257                 Cursor tmpcur = d->cursor_;
1258                 findInset(tmpcur, BIBTEX_CODE, false);
1259                 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1260                                                 BIBTEX_CODE);
1261                 if (inset) {
1262                         if (inset->delDatabase(cmd.argument()))
1263                                 buffer_.updateBibfilesCache();
1264                 }
1265                 break;
1266         }
1267
1268         case LFUN_STATISTICS: {
1269                 DocIterator from, to;
1270                 if (cur.selection()) {
1271                         from = cur.selectionBegin();
1272                         to = cur.selectionEnd();
1273                 } else {
1274                         from = doc_iterator_begin(buffer_.inset());
1275                         to = doc_iterator_end(buffer_.inset());
1276                 }
1277                 int const words = countWords(from, to);
1278                 int const chars = countChars(from, to, false);
1279                 int const chars_blanks = countChars(from, to, true);
1280                 docstring message;
1281                 if (cur.selection())
1282                         message = _("Statistics for the selection:");
1283                 else
1284                         message = _("Statistics for the document:");
1285                 message += "\n\n";
1286                 if (words != 1)
1287                         message += bformat(_("%1$d words"), words);
1288                 else
1289                         message += _("One word");
1290                 message += "\n";
1291                 if (chars_blanks != 1)
1292                         message += bformat(_("%1$d characters (including blanks)"),
1293                                           chars_blanks);
1294                 else
1295                         message += _("One character (including blanks)");
1296                 message += "\n";
1297                 if (chars != 1)
1298                         message += bformat(_("%1$d characters (excluding blanks)"),
1299                                           chars);
1300                 else
1301                         message += _("One character (excluding blanks)");
1302
1303                 Alert::information(_("Statistics"), message);
1304         }
1305                 break;
1306
1307         case LFUN_BUFFER_TOGGLE_COMPRESSION:
1308                 // turn compression on/off
1309                 buffer_.params().compressed = !buffer_.params().compressed;
1310                 break;
1311
1312         case LFUN_NEXT_INSET_TOGGLE: {
1313                 // create the the real function we want to invoke
1314                 FuncRequest tmpcmd = cmd;
1315                 tmpcmd.action = LFUN_INSET_TOGGLE;
1316                 // if there is an inset at cursor, see whether it
1317                 // wants to toggle.
1318                 Inset * inset = cur.nextInset();
1319                 if (inset) {
1320                         if (inset->isActive()) {
1321                                 Cursor tmpcur = cur;
1322                                 tmpcur.pushBackward(*inset);
1323                                 inset->dispatch(tmpcur, tmpcmd);
1324                                 if (tmpcur.result().dispatched())
1325                                         cur.dispatched();
1326                         } else
1327                                 inset->dispatch(cur, tmpcmd);
1328                 }
1329                 // if it did not work, try the underlying inset.
1330                 if (!inset || !cur.result().dispatched())
1331                         cur.dispatch(tmpcmd);
1332
1333                 if (!cur.result().dispatched())
1334                         // It did not work too; no action needed.
1335                         break;
1336                 cur.clearSelection();
1337                 processUpdateFlags(Update::SinglePar | Update::FitCursor);
1338                 break;
1339         }
1340
1341         case LFUN_NEXT_INSET_MODIFY: {
1342                 // create the the real function we want to invoke
1343                 FuncRequest tmpcmd = cmd;
1344                 tmpcmd.action = LFUN_INSET_MODIFY;
1345                 // if there is an inset at cursor, see whether it
1346                 // can be modified.
1347                 Inset * inset = cur.nextInset();
1348                 if (inset)
1349                         inset->dispatch(cur, tmpcmd);
1350                 // if it did not work, try the underlying inset.
1351                 if (!inset || !cur.result().dispatched())
1352                         cur.dispatch(tmpcmd);
1353
1354                 if (!cur.result().dispatched())
1355                         // It did not work too; no action needed.
1356                         break;
1357                 cur.clearSelection();
1358                 processUpdateFlags(Update::Force | Update::FitCursor);
1359                 break;
1360         }
1361
1362         case LFUN_SCREEN_UP:
1363         case LFUN_SCREEN_DOWN: {
1364                 Point p = getPos(cur, cur.boundary());
1365                 if (p.y_ < 0 || p.y_ > height_) {
1366                         // The cursor is off-screen so recenter before proceeding.
1367                         showCursor();
1368                         p = getPos(cur, cur.boundary());
1369                 }
1370                 int const scrolled = scroll(cmd.action == LFUN_SCREEN_UP
1371                         ? - height_ : height_);
1372                 if (cmd.action == LFUN_SCREEN_UP && scrolled > - height_)
1373                         p = Point(0, 0);
1374                 if (cmd.action == LFUN_SCREEN_DOWN && scrolled < height_)
1375                         p = Point(width_, height_);
1376                 cur.reset(buffer_.inset());
1377                 updateMetrics();
1378                 buffer_.changed();
1379                 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_);
1380                 //FIXME: what to do with cur.x_target()?
1381                 cur.finishUndo();
1382                 break;
1383         }
1384
1385         case LFUN_SCROLL:
1386                 lfunScroll(cmd);
1387                 break;
1388
1389         case LFUN_SCREEN_UP_SELECT: {
1390                 cur.selHandle(true);
1391                 if (isTopScreen()) {
1392                         lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1393                         cur.finishUndo();
1394                         break;
1395                 }
1396                 int y = getPos(cur, cur.boundary()).y_;
1397                 int const ymin = y - height_ + defaultRowHeight();
1398                 while (y > ymin && cur.up())
1399                         y = getPos(cur, cur.boundary()).y_;
1400
1401                 cur.finishUndo();
1402                 processUpdateFlags(Update::SinglePar | Update::FitCursor);
1403                 break;
1404         }
1405
1406         case LFUN_SCREEN_DOWN_SELECT: {
1407                 cur.selHandle(true);
1408                 if (isBottomScreen()) {
1409                         lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1410                         cur.finishUndo();
1411                         break;
1412                 }
1413                 int y = getPos(cur, cur.boundary()).y_;
1414                 int const ymax = y + height_ - defaultRowHeight();
1415                 while (y < ymax && cur.down())
1416                         y = getPos(cur, cur.boundary()).y_;
1417
1418                 cur.finishUndo();
1419                 processUpdateFlags(Update::SinglePar | Update::FitCursor);
1420                 break;
1421         }
1422
1423         case LFUN_BRANCH_ACTIVATE:
1424         case LFUN_BRANCH_DEACTIVATE:
1425                 buffer_.dispatch(cmd);
1426                 processUpdateFlags(Update::Force);
1427                 break;
1428
1429         // These two could be rewriten using some command like forall <insetname> <command>
1430         // once the insets refactoring is done.
1431         case LFUN_GRAPHICS_GROUPS_UNIFY: {
1432                 if (cmd.argument().empty())
1433                         break;
1434                 //view()->cursor().recordUndoFullDocument(); let inset-apply do that job
1435                 graphics::unifyGraphicsGroups(cur.buffer(), to_utf8(cmd.argument()));
1436                 processUpdateFlags(Update::Force | Update::FitCursor);
1437                 break;
1438         }
1439
1440         case LFUN_NOTES_MUTATE: {
1441                 if (cmd.argument().empty())
1442                         break;
1443                 cur.recordUndoFullDocument();
1444
1445                 if (mutateNotes(cur, cmd.getArg(0), cmd.getArg(1))) {
1446                         processUpdateFlags(Update::Force);
1447                 }
1448                 break;
1449         }
1450
1451         case LFUN_ALL_INSETS_TOGGLE: {
1452                 string action;
1453                 string const name = split(to_utf8(cmd.argument()), action, ' ');
1454                 InsetCode const inset_code = insetCode(name);
1455
1456                 FuncRequest fr(LFUN_INSET_TOGGLE, action);
1457
1458                 Inset & inset = cur.buffer().inset();
1459                 InsetIterator it  = inset_iterator_begin(inset);
1460                 InsetIterator const end = inset_iterator_end(inset);
1461                 for (; it != end; ++it) {
1462                         if (it->asInsetCollapsable()
1463                             && (inset_code == NO_CODE
1464                             || inset_code == it->lyxCode())) {
1465                                 Cursor tmpcur = cur;
1466                                 tmpcur.pushBackward(*it);
1467                                 it->dispatch(tmpcur, fr);
1468                         }
1469                 }
1470                 processUpdateFlags(Update::Force | Update::FitCursor);
1471                 break;
1472         }
1473
1474         default:
1475                 return false;
1476         }
1477
1478         return true;
1479 }
1480
1481
1482 docstring const BufferView::requestSelection()
1483 {
1484         Cursor & cur = d->cursor_;
1485
1486         LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
1487         if (!cur.selection()) {
1488                 d->xsel_cache_.set = false;
1489                 return docstring();
1490         }
1491
1492         LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
1493         if (!d->xsel_cache_.set ||
1494             cur.top() != d->xsel_cache_.cursor ||
1495             cur.anchor_.top() != d->xsel_cache_.anchor)
1496         {
1497                 d->xsel_cache_.cursor = cur.top();
1498                 d->xsel_cache_.anchor = cur.anchor_.top();
1499                 d->xsel_cache_.set = cur.selection();
1500                 return cur.selectionAsString(false);
1501         }
1502         return docstring();
1503 }
1504
1505
1506 void BufferView::clearSelection()
1507 {
1508         d->cursor_.clearSelection();
1509         // Clear the selection buffer. Otherwise a subsequent
1510         // middle-mouse-button paste would use the selection buffer,
1511         // not the more current external selection.
1512         cap::clearSelection();
1513         d->xsel_cache_.set = false;
1514         // The buffer did not really change, but this causes the
1515         // redraw we need because we cleared the selection above.
1516         buffer_.changed();
1517 }
1518
1519
1520 void BufferView::resize(int width, int height)
1521 {
1522         // Update from work area
1523         width_ = width;
1524         height_ = height;
1525
1526         // Clear the paragraph height cache.
1527         d->par_height_.clear();
1528         // Redo the metrics.
1529         updateMetrics();
1530 }
1531
1532
1533 Inset const * BufferView::getCoveringInset(Text const & text,
1534                 int x, int y) const
1535 {
1536         TextMetrics & tm = d->text_metrics_[&text];
1537         Inset * inset = tm.checkInsetHit(x, y);
1538         if (!inset)
1539                 return 0;
1540
1541         if (!inset->descendable())
1542                 // No need to go further down if the inset is not
1543                 // descendable.
1544                 return inset;
1545
1546         size_t cell_number = inset->nargs();
1547         // Check all the inner cell.
1548         for (size_t i = 0; i != cell_number; ++i) {
1549                 Text const * inner_text = inset->getText(i);
1550                 if (inner_text) {
1551                         // Try deeper.
1552                         Inset const * inset_deeper =
1553                                 getCoveringInset(*inner_text, x, y);
1554                         if (inset_deeper)
1555                                 return inset_deeper;
1556                 }
1557         }
1558
1559         return inset;
1560 }
1561
1562
1563 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
1564 {
1565         //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
1566
1567         // This is only called for mouse related events including
1568         // LFUN_FILE_OPEN generated by drag-and-drop.
1569         FuncRequest cmd = cmd0;
1570
1571         Cursor old = cursor();
1572         Cursor cur(*this);
1573         cur.push(buffer_.inset());
1574         cur.selection() = d->cursor_.selection();
1575
1576         // Either the inset under the cursor or the
1577         // surrounding Text will handle this event.
1578
1579         // make sure we stay within the screen...
1580         cmd.y = min(max(cmd.y, -1), height_);
1581
1582         if (cmd.action == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
1583
1584                 // Get inset under mouse, if there is one.
1585                 Inset const * covering_inset =
1586                         getCoveringInset(buffer_.text(), cmd.x, cmd.y);
1587                 if (covering_inset == d->last_inset_)
1588                         // Same inset, no need to do anything...
1589                         return;
1590
1591                 bool need_redraw = false;
1592                 // const_cast because of setMouseHover().
1593                 Inset * inset = const_cast<Inset *>(covering_inset);
1594                 if (d->last_inset_)
1595                         // Remove the hint on the last hovered inset (if any).
1596                         need_redraw |= d->last_inset_->setMouseHover(false);
1597                 if (inset)
1598                         // Highlighted the newly hovered inset (if any).
1599                         need_redraw |= inset->setMouseHover(true);
1600                 d->last_inset_ = inset;
1601                 if (!need_redraw)
1602                         return;
1603
1604                 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
1605                         << cmd.x << ", " << cmd.y << ")");
1606
1607                 d->update_strategy_ = DecorationUpdate;
1608
1609                 // This event (moving without mouse click) is not passed further.
1610                 // This should be changed if it is further utilized.
1611                 buffer_.changed();
1612                 return;
1613         }
1614
1615         // Build temporary cursor.
1616         Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x, cmd.y);
1617
1618         // Put anchor at the same position.
1619         cur.resetAnchor();
1620
1621         // Try to dispatch to an non-editable inset near this position
1622         // via the temp cursor. If the inset wishes to change the real
1623         // cursor it has to do so explicitly by using
1624         //  cur.bv().cursor() = cur;  (or similar)
1625         if (inset)
1626                 inset->dispatch(cur, cmd);
1627
1628         // Now dispatch to the temporary cursor. If the real cursor should
1629         // be modified, the inset's dispatch has to do so explicitly.
1630         if (!inset || !cur.result().dispatched())
1631                 cur.dispatch(cmd);
1632
1633         // Notify left insets
1634         if (cur != old) {
1635                 old.fixIfBroken();
1636                 bool badcursor = notifyCursorLeaves(old, cur);
1637                 if (badcursor)
1638                         cursor().fixIfBroken();
1639         }
1640
1641         // Do we have a selection?
1642         theSelection().haveSelection(cursor().selection());
1643
1644         // If the command has been dispatched,
1645         if (cur.result().dispatched() || cur.result().update())
1646                 processUpdateFlags(cur.result().update());
1647 }
1648
1649
1650 void BufferView::lfunScroll(FuncRequest const & cmd)
1651 {
1652         string const scroll_type = cmd.getArg(0);
1653         int const scroll_step =
1654                 (scroll_type == "line") ? d->scrollbarParameters_.single_step
1655                 : (scroll_type == "page") ? d->scrollbarParameters_.page_step : 0;
1656         if (scroll_step == 0)
1657                 return;
1658         string const scroll_quantity = cmd.getArg(1);
1659         if (scroll_quantity == "up")
1660                 scrollUp(scroll_step);
1661         else if (scroll_quantity == "down")
1662                 scrollDown(scroll_step);
1663         else {
1664                 int const scroll_value = convert<int>(scroll_quantity);
1665                 if (scroll_value)
1666                         scroll(scroll_step * scroll_value);
1667         }
1668         updateMetrics();
1669         buffer_.changed();
1670 }
1671
1672
1673 int BufferView::scroll(int y)
1674 {
1675         if (y > 0)
1676                 return scrollDown(y);
1677         if (y < 0)
1678                 return scrollUp(-y);
1679         return 0;
1680 }
1681
1682
1683 int BufferView::scrollDown(int offset)
1684 {
1685         Text * text = &buffer_.text();
1686         TextMetrics & tm = d->text_metrics_[text];
1687         int ymax = height_ + offset;
1688         while (true) {
1689                 pair<pit_type, ParagraphMetrics const *> last = tm.last();
1690                 int bottom_pos = last.second->position() + last.second->descent();
1691                 if (last.first + 1 == int(text->paragraphs().size())) {
1692                         if (bottom_pos <= height_)
1693                                 return 0;
1694                         offset = min(offset, bottom_pos - height_);
1695                         break;
1696                 }
1697                 if (bottom_pos > ymax)
1698                         break;
1699                 tm.newParMetricsDown();
1700         }
1701         d->anchor_ypos_ -= offset;
1702         return -offset;
1703 }
1704
1705
1706 int BufferView::scrollUp(int offset)
1707 {
1708         Text * text = &buffer_.text();
1709         TextMetrics & tm = d->text_metrics_[text];
1710         int ymin = - offset;
1711         while (true) {
1712                 pair<pit_type, ParagraphMetrics const *> first = tm.first();
1713                 int top_pos = first.second->position() - first.second->ascent();
1714                 if (first.first == 0) {
1715                         if (top_pos >= 0)
1716                                 return 0;
1717                         offset = min(offset, - top_pos);
1718                         break;
1719                 }
1720                 if (top_pos < ymin)
1721                         break;
1722                 tm.newParMetricsUp();
1723         }
1724         d->anchor_ypos_ += offset;
1725         return offset;
1726 }
1727
1728
1729 void BufferView::setCursorFromRow(int row)
1730 {
1731         int tmpid = -1;
1732         int tmppos = -1;
1733
1734         buffer_.texrow().getIdFromRow(row, tmpid, tmppos);
1735
1736         d->cursor_.reset(buffer_.inset());
1737         if (tmpid == -1)
1738                 buffer_.text().setCursor(d->cursor_, 0, 0);
1739         else
1740                 buffer_.text().setCursor(d->cursor_, buffer_.getParFromID(tmpid).pit(), tmppos);
1741 }
1742
1743
1744 void BufferView::gotoLabel(docstring const & label)
1745 {
1746         Toc & toc = buffer().tocBackend().toc("label");
1747         TocIterator toc_it = toc.begin();
1748         TocIterator end = toc.end();
1749         for (; toc_it != end; ++toc_it) {
1750                 if (label == toc_it->str())
1751                         dispatch(toc_it->action());
1752         }
1753         //FIXME: We could do a bit more searching thanks to this:
1754         //InsetLabel const * inset = buffer_.insetLabel(label);
1755 }
1756
1757
1758 TextMetrics const & BufferView::textMetrics(Text const * t) const
1759 {
1760         return const_cast<BufferView *>(this)->textMetrics(t);
1761 }
1762
1763
1764 TextMetrics & BufferView::textMetrics(Text const * t)
1765 {
1766         TextMetricsCache::iterator tmc_it  = d->text_metrics_.find(t);
1767         if (tmc_it == d->text_metrics_.end()) {
1768                 tmc_it = d->text_metrics_.insert(
1769                         make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
1770         }
1771         return tmc_it->second;
1772 }
1773
1774
1775 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
1776                 pit_type pit) const
1777 {
1778         return textMetrics(t).parMetrics(pit);
1779 }
1780
1781
1782 int BufferView::workHeight() const
1783 {
1784         return height_;
1785 }
1786
1787
1788 void BufferView::setCursor(DocIterator const & dit)
1789 {
1790         size_t const n = dit.depth();
1791         for (size_t i = 0; i < n; ++i)
1792                 dit[i].inset().edit(d->cursor_, true);
1793
1794         d->cursor_.setCursor(dit);
1795         d->cursor_.selection() = false;
1796 }
1797
1798
1799 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
1800 {
1801         // Would be wrong to delete anything if we have a selection.
1802         if (cur.selection())
1803                 return false;
1804
1805         bool need_anchor_change = false;
1806         bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
1807                 need_anchor_change);
1808
1809         if (need_anchor_change)
1810                 cur.resetAnchor();
1811
1812         if (!changed)
1813                 return false;
1814
1815         d->cursor_ = cur;
1816
1817         updateLabels(buffer_);
1818
1819         updateMetrics();
1820         buffer_.changed();
1821         return true;
1822 }
1823
1824
1825 bool BufferView::mouseSetCursor(Cursor & cur, bool select)
1826 {
1827         LASSERT(&cur.bv() == this, /**/);
1828
1829         if (!select)
1830                 // this event will clear selection so we save selection for
1831                 // persistent selection
1832                 cap::saveSelection(cursor());
1833
1834         // Has the cursor just left the inset?
1835         bool badcursor = false;
1836         bool leftinset = (&d->cursor_.inset() != &cur.inset());
1837         if (leftinset) {
1838                 d->cursor_.fixIfBroken();
1839                 badcursor = notifyCursorLeaves(d->cursor_, cur);
1840                 if (badcursor)
1841                         cur.fixIfBroken();
1842         }
1843
1844         // FIXME: shift-mouse selection doesn't work well across insets.
1845         bool do_selection = select && &d->cursor_.anchor().inset() == &cur.inset();
1846
1847         // do the dEPM magic if needed
1848         // FIXME: (1) move this to InsetText::notifyCursorLeaves?
1849         // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
1850         // the leftinset bool would not be necessary (badcursor instead).
1851         bool update = leftinset;
1852         if (!do_selection && !badcursor && d->cursor_.inTexted())
1853                 update |= checkDepm(cur, d->cursor_);
1854
1855         d->cursor_.setCursor(cur);
1856         d->cursor_.boundary(cur.boundary());
1857         if (do_selection)
1858                 d->cursor_.setSelection();
1859         else
1860                 d->cursor_.clearSelection();
1861
1862         d->cursor_.finishUndo();
1863         d->cursor_.setCurrentFont();
1864         return update;
1865 }
1866
1867
1868 void BufferView::putSelectionAt(DocIterator const & cur,
1869                                 int length, bool backwards)
1870 {
1871         d->cursor_.clearSelection();
1872
1873         setCursor(cur);
1874
1875         if (length) {
1876                 if (backwards) {
1877                         d->cursor_.pos() += length;
1878                         d->cursor_.setSelection(d->cursor_, -length);
1879                 } else
1880                         d->cursor_.setSelection(d->cursor_, length);
1881         }
1882         // Ensure a redraw happens in any case because the new selection could
1883         // possibly be on the same screen as the previous selection.
1884         processUpdateFlags(Update::Force | Update::FitCursor);
1885 }
1886
1887
1888 Cursor & BufferView::cursor()
1889 {
1890         return d->cursor_;
1891 }
1892
1893
1894 Cursor const & BufferView::cursor() const
1895 {
1896         return d->cursor_;
1897 }
1898
1899
1900 pit_type BufferView::anchor_ref() const
1901 {
1902         return d->anchor_pit_;
1903 }
1904
1905
1906 bool BufferView::singleParUpdate()
1907 {
1908         Text & buftext = buffer_.text();
1909         pit_type const bottom_pit = d->cursor_.bottom().pit();
1910         TextMetrics & tm = textMetrics(&buftext);
1911         int old_height = tm.parMetrics(bottom_pit).height();
1912
1913         // make sure inline completion pointer is ok
1914         if (d->inlineCompletionPos_.fixIfBroken())
1915                 d->inlineCompletionPos_ = DocIterator();
1916
1917         // In Single Paragraph mode, rebreak only
1918         // the (main text, not inset!) paragraph containing the cursor.
1919         // (if this paragraph contains insets etc., rebreaking will
1920         // recursively descend)
1921         tm.redoParagraph(bottom_pit);
1922         ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
1923         if (pm.height() != old_height)
1924                 // Paragraph height has changed so we cannot proceed to
1925                 // the singlePar optimisation.
1926                 return false;
1927
1928         d->update_strategy_ = SingleParUpdate;
1929
1930         LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
1931                 << " y2: " << pm.position() + pm.descent()
1932                 << " pit: " << bottom_pit
1933                 << " singlepar: 1");
1934         return true;
1935 }
1936
1937
1938 void BufferView::updateMetrics()
1939 {
1940         if (height_ == 0 || width_ == 0)
1941                 return;
1942
1943         Text & buftext = buffer_.text();
1944         pit_type const npit = int(buftext.paragraphs().size());
1945
1946         // Clear out the position cache in case of full screen redraw,
1947         d->coord_cache_.clear();
1948
1949         // Clear out paragraph metrics to avoid having invalid metrics
1950         // in the cache from paragraphs not relayouted below
1951         // The complete text metrics will be redone.
1952         d->text_metrics_.clear();
1953
1954         TextMetrics & tm = textMetrics(&buftext);
1955
1956         // make sure inline completion pointer is ok
1957         if (d->inlineCompletionPos_.fixIfBroken())
1958                 d->inlineCompletionPos_ = DocIterator();
1959
1960         if (d->anchor_pit_ >= npit)
1961                 // The anchor pit must have been deleted...
1962                 d->anchor_pit_ = npit - 1;
1963
1964         // Rebreak anchor paragraph.
1965         tm.redoParagraph(d->anchor_pit_);
1966         ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
1967
1968         // position anchor
1969         if (d->anchor_pit_ == 0) {
1970                 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
1971
1972                 // Complete buffer visible? Then it's easy.
1973                 if (scrollRange == 0)
1974                         d->anchor_ypos_ = anchor_pm.ascent();
1975
1976                 // FIXME: Some clever handling needed to show
1977                 // the _first_ paragraph up to the top if the cursor is
1978                 // in the first line.
1979         }
1980         anchor_pm.setPosition(d->anchor_ypos_);
1981
1982         LYXERR(Debug::PAINTING, "metrics: "
1983                 << " anchor pit = " << d->anchor_pit_
1984                 << " anchor ypos = " << d->anchor_ypos_);
1985
1986         // Redo paragraphs above anchor if necessary.
1987         int y1 = d->anchor_ypos_ - anchor_pm.ascent();
1988         // We are now just above the anchor paragraph.
1989         pit_type pit1 = d->anchor_pit_ - 1;
1990         for (; pit1 >= 0 && y1 >= 0; --pit1) {
1991                 tm.redoParagraph(pit1);
1992                 ParagraphMetrics & pm = tm.par_metrics_[pit1];
1993                 y1 -= pm.descent();
1994                 // Save the paragraph position in the cache.
1995                 pm.setPosition(y1);
1996                 y1 -= pm.ascent();
1997         }
1998
1999         // Redo paragraphs below the anchor if necessary.
2000         int y2 = d->anchor_ypos_ + anchor_pm.descent();
2001         // We are now just below the anchor paragraph.
2002         pit_type pit2 = d->anchor_pit_ + 1;
2003         for (; pit2 < npit && y2 <= height_; ++pit2) {
2004                 tm.redoParagraph(pit2);
2005                 ParagraphMetrics & pm = tm.par_metrics_[pit2];
2006                 y2 += pm.ascent();
2007                 // Save the paragraph position in the cache.
2008                 pm.setPosition(y2);
2009                 y2 += pm.descent();
2010         }
2011
2012         LYXERR(Debug::PAINTING, "Metrics: "
2013                 << " anchor pit = " << d->anchor_pit_
2014                 << " anchor ypos = " << d->anchor_ypos_
2015                 << " y1 = " << y1
2016                 << " y2 = " << y2
2017                 << " pit1 = " << pit1
2018                 << " pit2 = " << pit2);
2019
2020         d->update_strategy_ = FullScreenUpdate;
2021
2022         if (lyxerr.debugging(Debug::WORKAREA)) {
2023                 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
2024                 d->coord_cache_.dump();
2025         }
2026 }
2027
2028
2029 void BufferView::insertLyXFile(FileName const & fname)
2030 {
2031         LASSERT(d->cursor_.inTexted(), /**/);
2032
2033         // Get absolute path of file and add ".lyx"
2034         // to the filename if necessary
2035         FileName filename = fileSearch(string(), fname.absFilename(), "lyx");
2036
2037         docstring const disp_fn = makeDisplayPath(filename.absFilename());
2038         // emit message signal.
2039         message(bformat(_("Inserting document %1$s..."), disp_fn));
2040
2041         docstring res;
2042         Buffer buf("", false);
2043         if (buf.loadLyXFile(filename)) {
2044                 ErrorList & el = buffer_.errorList("Parse");
2045                 // Copy the inserted document error list into the current buffer one.
2046                 el = buf.errorList("Parse");
2047                 buffer_.undo().recordUndo(d->cursor_);
2048                 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
2049                                              buf.params().documentClassPtr(), el);
2050                 res = _("Document %1$s inserted.");
2051         } else {
2052                 res = _("Could not insert document %1$s");
2053         }
2054
2055         updateMetrics();
2056         buffer_.changed();
2057         // emit message signal.
2058         message(bformat(res, disp_fn));
2059         buffer_.errors("Parse");
2060 }
2061
2062
2063 Point BufferView::coordOffset(DocIterator const & dit, bool boundary) const
2064 {
2065         int x = 0;
2066         int y = 0;
2067         int lastw = 0;
2068
2069         // Addup contribution of nested insets, from inside to outside,
2070         // keeping the outer paragraph for a special handling below
2071         for (size_t i = dit.depth() - 1; i >= 1; --i) {
2072                 CursorSlice const & sl = dit[i];
2073                 int xx = 0;
2074                 int yy = 0;
2075
2076                 // get relative position inside sl.inset()
2077                 sl.inset().cursorPos(*this, sl, boundary && (i + 1 == dit.depth()), xx, yy);
2078
2079                 // Make relative position inside of the edited inset relative to sl.inset()
2080                 x += xx;
2081                 y += yy;
2082
2083                 // In case of an RTL inset, the edited inset will be positioned to the left
2084                 // of xx:yy
2085                 if (sl.text()) {
2086                         bool boundary_i = boundary && i + 1 == dit.depth();
2087                         bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2088                         if (rtl)
2089                                 x -= lastw;
2090                 }
2091
2092                 // remember width for the case that sl.inset() is positioned in an RTL inset
2093                 if (i && dit[i - 1].text()) {
2094                         // If this Inset is inside a Text Inset, retrieve the Dimension
2095                         // from the containing text instead of using Inset::dimension() which
2096                         // might not be implemented.
2097                         // FIXME (Abdel 23/09/2007): this is a bit messy because of the
2098                         // elimination of Inset::dim_ cache. This coordOffset() method needs
2099                         // to be rewritten in light of the new design.
2100                         Dimension const & dim = parMetrics(dit[i - 1].text(),
2101                                 dit[i - 1].pit()).insetDimension(&sl.inset());
2102                         lastw = dim.wid;
2103                 } else {
2104                         Dimension const dim = sl.inset().dimension(*this);
2105                         lastw = dim.wid;
2106                 }
2107
2108                 //lyxerr << "Cursor::getPos, i: "
2109                 // << i << " x: " << xx << " y: " << y << endl;
2110         }
2111
2112         // Add contribution of initial rows of outermost paragraph
2113         CursorSlice const & sl = dit[0];
2114         TextMetrics const & tm = textMetrics(sl.text());
2115         ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2116         LASSERT(!pm.rows().empty(), /**/);
2117         y -= pm.rows()[0].ascent();
2118 #if 1
2119         // FIXME: document this mess
2120         size_t rend;
2121         if (sl.pos() > 0 && dit.depth() == 1) {
2122                 int pos = sl.pos();
2123                 if (pos && boundary)
2124                         --pos;
2125 //              lyxerr << "coordOffset: boundary:" << boundary << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
2126                 rend = pm.pos2row(pos);
2127         } else
2128                 rend = pm.pos2row(sl.pos());
2129 #else
2130         size_t rend = pm.pos2row(sl.pos());
2131 #endif
2132         for (size_t rit = 0; rit != rend; ++rit)
2133                 y += pm.rows()[rit].height();
2134         y += pm.rows()[rend].ascent();
2135
2136         TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
2137
2138         // Make relative position from the nested inset now bufferview absolute.
2139         int xx = bottom_tm.cursorX(dit.bottom(), boundary && dit.depth() == 1);
2140         x += xx;
2141
2142         // In the RTL case place the nested inset at the left of the cursor in
2143         // the outer paragraph
2144         bool boundary_1 = boundary && 1 == dit.depth();
2145         bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
2146         if (rtl)
2147                 x -= lastw;
2148
2149         return Point(x, y);
2150 }
2151
2152
2153 Point BufferView::getPos(DocIterator const & dit, bool boundary) const
2154 {
2155         CursorSlice const & bot = dit.bottom();
2156         TextMetrics const & tm = textMetrics(bot.text());
2157         if (!tm.contains(bot.pit()))
2158                 return Point(-1, -1);
2159
2160         Point p = coordOffset(dit, boundary); // offset from outer paragraph
2161         p.y_ += tm.parMetrics(bot.pit()).position();
2162         return p;
2163 }
2164
2165
2166 void BufferView::draw(frontend::Painter & pain)
2167 {
2168         if (height_ == 0 || width_ == 0)
2169                 return;
2170         LYXERR(Debug::PAINTING, "\t\t*** START DRAWING ***");
2171         Text & text = buffer_.text();
2172         TextMetrics const & tm = d->text_metrics_[&text];
2173         int const y = tm.first().second->position();
2174         PainterInfo pi(this, pain);
2175
2176         switch (d->update_strategy_) {
2177
2178         case NoScreenUpdate:
2179                 // If no screen painting is actually needed, only some the different
2180                 // coordinates of insets and paragraphs needs to be updated.
2181                 pi.full_repaint = true;
2182                 pi.pain.setDrawingEnabled(false);
2183                 tm.draw(pi, 0, y);
2184                 break;
2185
2186         case SingleParUpdate:
2187                 pi.full_repaint = false;
2188                 // In general, only the current row of the outermost paragraph
2189                 // will be redrawn. Particular cases where selection spans
2190                 // multiple paragraph are correctly detected in TextMetrics.
2191                 tm.draw(pi, 0, y);
2192                 break;
2193
2194         case DecorationUpdate:
2195                 // FIXME: We should also distinguish DecorationUpdate to avoid text
2196                 // drawing if possible. This is not possible to do easily right now
2197                 // because of the single backing pixmap.
2198
2199         case FullScreenUpdate:
2200                 // The whole screen, including insets, will be refreshed.
2201                 pi.full_repaint = true;
2202
2203                 // Clear background.
2204                 pain.fillRectangle(0, 0, width_, height_,
2205                         buffer_.inset().backgroundColor());
2206
2207                 // Draw everything.
2208                 tm.draw(pi, 0, y);
2209
2210                 // and possibly grey out below
2211                 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2212                 int const y2 = lastpm.second->position() + lastpm.second->descent();
2213                 if (y2 < height_)
2214                         pain.fillRectangle(0, y2, width_, height_ - y2, Color_bottomarea);
2215                 break;
2216         }
2217         LYXERR(Debug::PAINTING, "\n\t\t*** END DRAWING  ***");
2218
2219         // The scrollbar needs an update.
2220         updateScrollbar();
2221
2222         // Normalize anchor for next time
2223         pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
2224         pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2225         for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
2226                 ParagraphMetrics const & pm = tm.parMetrics(pit);
2227                 if (pm.position() + pm.descent() > 0) {
2228                         d->anchor_pit_ = pit;
2229                         d->anchor_ypos_ = pm.position();
2230                         break;
2231                 }
2232         }
2233         LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
2234                 << "  anchor ypos = " << d->anchor_ypos_);
2235 }
2236
2237
2238 void BufferView::message(docstring const & msg)
2239 {
2240         if (d->gui_)
2241                 d->gui_->message(msg);
2242 }
2243
2244
2245 void BufferView::showDialog(string const & name)
2246 {
2247         if (d->gui_)
2248                 d->gui_->showDialog(name, string());
2249 }
2250
2251
2252 void BufferView::showDialog(string const & name,
2253         string const & data, Inset * inset)
2254 {
2255         if (d->gui_)
2256                 d->gui_->showDialog(name, data, inset);
2257 }
2258
2259
2260 void BufferView::updateDialog(string const & name, string const & data)
2261 {
2262         if (d->gui_)
2263                 d->gui_->updateDialog(name, data);
2264 }
2265
2266
2267 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
2268 {
2269         d->gui_ = gui;
2270 }
2271
2272
2273 // FIXME: Move this out of BufferView again
2274 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
2275 {
2276         if (!fname.isReadableFile()) {
2277                 docstring const error = from_ascii(strerror(errno));
2278                 docstring const file = makeDisplayPath(fname.absFilename(), 50);
2279                 docstring const text =
2280                   bformat(_("Could not read the specified document\n"
2281                             "%1$s\ndue to the error: %2$s"), file, error);
2282                 Alert::error(_("Could not read file"), text);
2283                 return docstring();
2284         }
2285
2286         if (!fname.isReadableFile()) {
2287                 docstring const file = makeDisplayPath(fname.absFilename(), 50);
2288                 docstring const text =
2289                   bformat(_("%1$s\n is not readable."), file);
2290                 Alert::error(_("Could not open file"), text);
2291                 return docstring();
2292         }
2293
2294         // FIXME UNICODE: We don't know the encoding of the file
2295         docstring file_content = fname.fileContents("UTF-8");
2296         if (file_content.empty()) {
2297                 Alert::error(_("Reading not UTF-8 encoded file"),
2298                              _("The file is not UTF-8 encoded.\n"
2299                                "It will be read as local 8Bit-encoded.\n"
2300                                "If this does not give the correct result\n"
2301                                "then please change the encoding of the file\n"
2302                                "to UTF-8 with a program other than LyX.\n"));
2303                 file_content = fname.fileContents("local8bit");
2304         }
2305
2306         return normalize_c(file_content);
2307 }
2308
2309
2310 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
2311 {
2312         docstring const tmpstr = contentsOfPlaintextFile(f);
2313
2314         if (tmpstr.empty())
2315                 return;
2316
2317         Cursor & cur = cursor();
2318         cap::replaceSelection(cur);
2319         buffer_.undo().recordUndo(cur);
2320         if (asParagraph)
2321                 cur.innerText()->insertStringAsParagraphs(cur, tmpstr);
2322         else
2323                 cur.innerText()->insertStringAsLines(cur, tmpstr);
2324
2325         updateMetrics();
2326         buffer_.changed();
2327 }
2328
2329
2330 docstring const & BufferView::inlineCompletion() const
2331 {
2332         return d->inlineCompletion_;
2333 }
2334
2335
2336 size_t const & BufferView::inlineCompletionUniqueChars() const
2337 {
2338         return d->inlineCompletionUniqueChars_;
2339 }
2340
2341
2342 DocIterator const & BufferView::inlineCompletionPos() const
2343 {
2344         return d->inlineCompletionPos_;
2345 }
2346
2347
2348 bool samePar(DocIterator const & a, DocIterator const & b)
2349 {
2350         if (a.empty() && b.empty())
2351                 return true;
2352         if (a.empty() || b.empty())
2353                 return false;
2354         return &a.innerParagraph() == &b.innerParagraph();
2355 }
2356
2357
2358 void BufferView::setInlineCompletion(Cursor & cur, DocIterator const & pos,
2359         docstring const & completion, size_t uniqueChars)
2360 {
2361         uniqueChars = min(completion.size(), uniqueChars);
2362         bool changed = d->inlineCompletion_ != completion
2363                 || d->inlineCompletionUniqueChars_ != uniqueChars;
2364         bool singlePar = true;
2365         d->inlineCompletion_ = completion;
2366         d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
2367
2368         //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
2369
2370         // at new position?
2371         DocIterator const & old = d->inlineCompletionPos_;
2372         if (old != pos) {
2373                 //lyxerr << "inlineCompletionPos changed" << std::endl;
2374                 // old or pos are in another paragraph?
2375                 if ((!samePar(cur, pos) && !pos.empty())
2376                     || (!samePar(cur, old) && !old.empty())) {
2377                         singlePar = false;
2378                         //lyxerr << "different paragraph" << std::endl;
2379                 }
2380                 d->inlineCompletionPos_ = pos;
2381         }
2382
2383         // set update flags
2384         if (changed) {
2385                 if (singlePar && !(cur.disp_.update() & Update::Force))
2386                         cur.updateFlags(cur.disp_.update() | Update::SinglePar);
2387                 else
2388                         cur.updateFlags(cur.disp_.update() | Update::Force);
2389         }
2390 }
2391
2392 } // namespace lyx