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