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