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