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