src/BufferView.cpp

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