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 "Buffer.h"
  20 #include "buffer_funcs.h"
  21 #include "BufferList.h"
  22 #include "BufferParams.h"
  23 #include "CoordCache.h"
  24 #include "Cursor.h"
  25 #include "CutAndPaste.h"
  26 #include "DispatchResult.h"
  27 #include "EmbeddedFiles.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 "VSpace.h"
  53 #include "WordLangTuple.h"
  54
  55 #include "insets/InsetBibtex.h"
  56 #include "insets/InsetCommand.h" // ChangeRefs
  57 #include "insets/InsetRef.h"
  58 #include "insets/InsetText.h"
  59
  60 #include "frontends/alert.h"
  61 #include "frontends/Application.h"
  62 #include "frontends/Delegates.h"
  63 #include "frontends/FontMetrics.h"
  64 #include "frontends/Painter.h"
  65 #include "frontends/Selection.h"
  66
  67 #include "graphics/Previews.h"
  68
  69 #include "support/convert.h"
  70 #include "support/debug.h"
  71 #include "support/FileFilterList.h"
  72 #include "support/filetools.h"
  73 #include "support/gettext.h"
  74 #include "support/lstrings.h"
  75 #include "support/Package.h"
  76 #include "support/types.h"
  77
  78 #include <cerrno>
  79 #include <fstream>
  80 #include <functional>
  81 #include <iterator>
  82 #include <vector>
  83
  84 using namespace std;
  85 using namespace lyx::support;
  86
  87 namespace lyx {
  88
  89 namespace Alert = frontend::Alert;
  90
  91 namespace {
  92
  93 /// Return an inset of this class if it exists at the current cursor position
  94 template <class T>
  95 T * getInsetByCode(Cursor const & cur, InsetCode code)
  96 {
  97         DocIterator it = cur;
  98         Inset * inset = it.nextInset();
  99         if (inset && inset->lyxCode() == code)
 100                 return static_cast<T*>(inset);
 101         return 0;
 102 }
 103
 104
 105 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
 106         bool same_content);
 107
 108 bool findNextInset(DocIterator & dit, vector<InsetCode> const & codes,
 109         docstring const & contents)
 110 {
 111         DocIterator tmpdit = dit;
 112
 113         while (tmpdit) {
 114                 Inset const * inset = tmpdit.nextInset();
 115                 if (inset
 116                     && find(codes.begin(), codes.end(), inset->lyxCode()) != codes.end()
 117                     && (contents.empty() ||
 118                     static_cast<InsetCommand const *>(inset)->getFirstNonOptParam() == contents)) {
 119                         dit = tmpdit;
 120                         return true;
 121                 }
 122                 tmpdit.forwardInset();
 123         }
 124
 125         return false;
 126 }
 127
 128
 129 /// Looks for next inset with one of the given codes.
 130 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
 131         bool same_content)
 132 {
 133         docstring contents;
 134         DocIterator tmpdit = dit;
 135         tmpdit.forwardInset();
 136         if (!tmpdit)
 137                 return false;
 138
 139         if (same_content) {
 140                 Inset const * inset = tmpdit.nextInset();
 141                 if (inset
 142                     && find(codes.begin(), codes.end(), inset->lyxCode()) != codes.end()) {
 143                         contents = static_cast<InsetCommand const *>(inset)->getFirstNonOptParam();
 144                 }
 145         }
 146
 147         if (!findNextInset(tmpdit, codes, contents)) {
 148                 if (dit.depth() != 1 || dit.pit() != 0 || dit.pos() != 0) {
 149                         tmpdit  = doc_iterator_begin(tmpdit.bottom().inset());
 150                         if (!findNextInset(tmpdit, codes, contents))
 151                                 return false;
 152                 } else
 153                         return false;
 154         }
 155
 156         dit = tmpdit;
 157         return true;
 158 }
 159
 160
 161 /// Looks for next inset with the given code
 162 void findInset(DocIterator & dit, InsetCode code, bool same_content)
 163 {
 164         findInset(dit, vector<InsetCode>(1, code), same_content);
 165 }
 166
 167
 168 /// Moves cursor to the next inset with one of the given codes.
 169 void gotoInset(BufferView * bv, vector<InsetCode> const & codes,
 170                bool same_content)
 171 {
 172         Cursor tmpcur = bv->cursor();
 173         if (!findInset(tmpcur, codes, same_content)) {
 174                 bv->cursor().message(_("No more insets"));
 175                 return;
 176         }
 177
 178         tmpcur.clearSelection();
 179         bv->setCursor(tmpcur);
 180         bv->showCursor();
 181 }
 182
 183
 184 /// Moves cursor to the next inset with given code.
 185 void gotoInset(BufferView * bv, InsetCode code, bool same_content)
 186 {
 187         gotoInset(bv, vector<InsetCode>(1, code), same_content);
 188 }
 189
 190
 191 /// A map from a Text to the associated text metrics
 192 typedef map<Text const *, TextMetrics> TextMetricsCache;
 193
 194 enum ScreenUpdateStrategy {
 195         NoScreenUpdate,
 196         SingleParUpdate,
 197         FullScreenUpdate,
 198         DecorationUpdate
 199 };
 200
 201 } // anon namespace
 202
 203
 204 /////////////////////////////////////////////////////////////////////
 205 //
 206 // BufferView
 207 //
 208 /////////////////////////////////////////////////////////////////////
 209
 210 struct BufferView::Private
 211 {
 212         Private(BufferView & bv): wh_(0), cursor_(bv),
 213                 anchor_pit_(0), anchor_ypos_(0),
 214                 last_inset_(0), gui_(0)
 215         {}
 216
 217         ///
 218         ScrollbarParameters scrollbarParameters_;
 219         ///
 220         ScreenUpdateStrategy update_strategy_;
 221         ///
 222         CoordCache coord_cache_;
 223
 224         /// Estimated average par height for scrollbar.
 225         int wh_;
 226         /// this is used to handle XSelection events in the right manner.
 227         struct {
 228                 CursorSlice cursor;
 229                 CursorSlice anchor;
 230                 bool set;
 231         } xsel_cache_;
 232         ///
 233         Cursor cursor_;
 234         ///
 235         pit_type anchor_pit_;
 236         ///
 237         int anchor_ypos_;
 238         ///
 239         vector<int> par_height_;
 240
 241         /// keyboard mapping object.
 242         Intl intl_;
 243
 244         /// last visited inset.
 245         /** kept to send setMouseHover(false).
 246           * Not owned, so don't delete.
 247           */
 248         Inset * last_inset_;
 249
 250         mutable TextMetricsCache text_metrics_;
 251
 252         /// Whom to notify.
 253         /** Not owned, so don't delete.
 254           */
 255         frontend::GuiBufferViewDelegate * gui_;
 256 };
 257
 258
 259 BufferView::BufferView(Buffer & buf)
 260         : width_(0), height_(0), buffer_(buf), d(new Private(*this))
 261 {
 262         d->xsel_cache_.set = false;
 263         d->intl_.initKeyMapper(lyxrc.use_kbmap);
 264
 265         d->cursor_.push(buffer_.inset());
 266         d->cursor_.resetAnchor();
 267         d->cursor_.setCurrentFont();
 268
 269         if (graphics::Previews::status() != LyXRC::PREVIEW_OFF)
 270                 graphics::Previews::get().generateBufferPreviews(buffer_);
 271 }
 272
 273
 274 BufferView::~BufferView()
 275 {
 276         // current buffer is going to be switched-off, save cursor pos
 277         // Ideally, the whole cursor stack should be saved, but session
 278         // currently can only handle bottom (whole document) level pit and pos.
 279         // That is to say, if a cursor is in a nested inset, it will be
 280         // restore to the left of the top level inset.
 281         LastFilePosSection::FilePos fp;
 282         fp.pit = d->cursor_.bottom().pit();
 283         fp.pos = d->cursor_.bottom().pos();
 284         LyX::ref().session().lastFilePos().save(buffer_.fileName(), fp);
 285
 286         delete d;
 287 }
 288
 289
 290 Intl & BufferView::getIntl()
 291 {
 292         return d->intl_;
 293 }
 294
 295
 296 Intl const & BufferView::getIntl() const
 297 {
 298         return d->intl_;
 299 }
 300
 301
 302 CoordCache & BufferView::coordCache()
 303 {
 304         return d->coord_cache_;
 305 }
 306
 307
 308 CoordCache const & BufferView::coordCache() const
 309 {
 310         return d->coord_cache_;
 311 }
 312
 313
 314 Buffer & BufferView::buffer()
 315 {
 316         return buffer_;
 317 }
 318
 319
 320 Buffer const & BufferView::buffer() const
 321 {
 322         return buffer_;
 323 }
 324
 325
 326 bool BufferView::fitCursor()
 327 {
 328         if (cursorStatus(d->cursor_) == CUR_INSIDE) {
 329                 frontend::FontMetrics const & fm =
 330                         theFontMetrics(d->cursor_.getFont().fontInfo());
 331                 int const asc = fm.maxAscent();
 332                 int const des = fm.maxDescent();
 333                 Point const p = getPos(d->cursor_, d->cursor_.boundary());
 334                 if (p.y_ - asc >= 0 && p.y_ + des < height_)
 335                         return false;
 336         }
 337         return true;
 338 }
 339
 340
 341 void BufferView::processUpdateFlags(Update::flags flags)
 342 {
 343         // last_inset_ points to the last visited inset. This pointer may become
 344         // invalid because of keyboard editing. Since all such operations
 345         // causes screen update(), I reset last_inset_ to avoid such a problem.
 346         d->last_inset_ = 0;
 347         // This is close to a hot-path.
 348         LYXERR(Debug::DEBUG, "BufferView::processUpdateFlags()"
 349                 << "[fitcursor = " << (flags & Update::FitCursor)
 350                 << ", forceupdate = " << (flags & Update::Force)
 351                 << ", singlepar = " << (flags & Update::SinglePar)
 352                 << "]  buffer: " << &buffer_);
 353
 354         buffer_.updateMacros();
 355
 356         // Now do the first drawing step if needed. This consists on updating
 357         // the CoordCache in updateMetrics().
 358         // The second drawing step is done in WorkArea::redraw() if needed.
 359
 360         // Case when no explicit update is requested.
 361         if (!flags) {
 362                 // no need to redraw anything.
 363                 d->update_strategy_ = NoScreenUpdate;
 364                 return;
 365         }
 366
 367         if (flags == Update::Decoration) {
 368                 d->update_strategy_ = DecorationUpdate;
 369                 buffer_.changed();
 370                 return;
 371         }
 372
 373         if (flags == Update::FitCursor
 374                 || flags == (Update::Decoration | Update::FitCursor)) {
 375                 // tell the frontend to update the screen if needed.
 376                 if (fitCursor()) {
 377                         showCursor();
 378                         return;
 379                 }
 380                 if (flags & Update::Decoration) {
 381                         d->update_strategy_ = DecorationUpdate;
 382                         buffer_.changed();
 383                         return;
 384                 }
 385                 // no screen update is needed.
 386                 d->update_strategy_ = NoScreenUpdate;
 387                 return;
 388         }
 389
 390         bool const full_metrics = flags & Update::Force || !singleParUpdate();
 391
 392         if (full_metrics)
 393                 // We have to update the full screen metrics.
 394                 updateMetrics();
 395
 396         if (!(flags & Update::FitCursor)) {
 397                 // Nothing to do anymore. Trigger a redraw and return
 398                 buffer_.changed();
 399                 return;
 400         }
 401
 402         // updateMetrics() does not update paragraph position
 403         // This is done at draw() time. So we need a redraw!
 404         buffer_.changed();
 405
 406         if (fitCursor()) {
 407                 // The cursor is off screen so ensure it is visible.
 408                 // refresh it:
 409                 showCursor();
 410         }
 411 }
 412
 413
 414 void BufferView::updateScrollbar()
 415 {
 416         if (height_ == 0)
 417                 return;
 418
 419         Text & t = buffer_.text();
 420         TextMetrics & tm = d->text_metrics_[&t];
 421
 422         LYXERR(Debug::GUI, " Updating scrollbar: height: "
 423                 << t.paragraphs().size()
 424                 << " curr par: " << d->cursor_.bottom().pit()
 425                 << " default height " << defaultRowHeight());
 426
 427         int const parsize = int(t.paragraphs().size());
 428         if (d->par_height_.size() != parsize) {
 429                 d->par_height_.clear();
 430                 // FIXME: We assume a default paragraph height of 2 rows. This
 431                 // should probably be pondered with the screen width.
 432                 d->par_height_.resize(parsize, defaultRowHeight() * 2);
 433         }
 434
 435         // It would be better to fix the scrollbar to understand
 436         // values in [0..1] and divide everything by wh
 437
 438         // Look at paragraph heights on-screen
 439         pit_type first_visible_pit = -1;
 440         pair<pit_type, ParagraphMetrics const *> first = tm.first();
 441         pair<pit_type, ParagraphMetrics const *> last = tm.last();
 442         for (pit_type pit = first.first; pit <= last.first; ++pit) {
 443                 ParagraphMetrics const & pm = tm.parMetrics(pit);
 444                 d->par_height_[pit] = pm.height();
 445                 if (first_visible_pit >= 0 || pm.position() + pm.descent() <= 0)
 446                         continue;
 447                 first_visible_pit = pit;
 448                 LYXERR(Debug::SCROLLING, "first visible pit " << first_visible_pit);
 449                 // FIXME: we should look for the first visible row within
 450                 // the deepest inset!
 451                 int row_pos = pm.position();
 452                 size_t const nrows = pm.rows().size();
 453                 for (size_t i = 0; i != nrows; ++i) {
 454                         Row const & row = pm.rows()[i];
 455                         if (row_pos >= 0) {
 456                                 LYXERR(Debug::SCROLLING, "first visible row " << i
 457                                         << "(row pos = " << row_pos << ");");
 458                                 break;
 459                         }
 460                         row_pos += row.height();
 461                 }
 462                 d->scrollbarParameters_.position = row_pos;
 463         }
 464
 465         d->scrollbarParameters_.height = 0;
 466         for (size_t i = 0; i != d->par_height_.size(); ++i) {
 467                 if (i == first_visible_pit)
 468                         d->scrollbarParameters_.position += d->scrollbarParameters_.height;
 469                 d->scrollbarParameters_.height += d->par_height_[i];
 470         }
 471
 472         // We prefer fixed size line scrolling.
 473         d->scrollbarParameters_.lineScrollHeight = defaultRowHeight();
 474 }
 475
 476
 477 ScrollbarParameters const & BufferView::scrollbarParameters() const
 478 {
 479         return d->scrollbarParameters_;
 480 }
 481
 482
 483 docstring BufferView::toolTip(int x, int y) const
 484 {
 485         // Get inset under mouse, if there is one.
 486         Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
 487         if (!covering_inset)
 488                 // No inset, no tooltip...
 489                 return docstring();
 490         return covering_inset->toolTip(*this, x, y);
 491 }
 492
 493
 494 docstring BufferView::contextMenu(int x, int y) const
 495 {
 496         // Get inset under mouse, if there is one.
 497         Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
 498         if (covering_inset)
 499                 return covering_inset->contextMenu(*this, x, y);
 500
 501         // FIXME: Do something more elaborate here.
 502         return from_ascii("edit");
 503 }
 504
 505
 506 void BufferView::scrollDocView(int value)
 507 {
 508         int const offset = value - d->scrollbarParameters_.position;
 509         // If the offset is less than 2 screen height, prefer to scroll instead.
 510         if (abs(offset) <= 2 * height_) {
 511                 scroll(offset);
 512                 return;
 513         }
 514
 515         int par_pos = 0;
 516         for (size_t i = 0; i != d->par_height_.size(); ++i) {
 517                 par_pos += d->par_height_[i];
 518                 if (par_pos >= value) {
 519                         d->anchor_pit_ = pit_type(i);
 520                         break;
 521                 }
 522         }
 523
 524         LYXERR(Debug::SCROLLING, "value = " << value
 525                 << "\tanchor_ref_ = " << d->anchor_pit_
 526                 << "\tpar_pos = " << par_pos);
 527
 528         d->anchor_ypos_ = par_pos - value;
 529         updateMetrics();
 530         buffer_.changed();
 531 }
 532
 533
 534 // FIXME: this method is not working well.
 535 void BufferView::setCursorFromScrollbar()
 536 {
 537         TextMetrics & tm = d->text_metrics_[&buffer_.text()];
 538
 539         int const height = 2 * defaultRowHeight();
 540         int const first = height;
 541         int const last = height_ - height;
 542         Cursor & cur = d->cursor_;
 543
 544         switch (cursorStatus(cur)) {
 545         case CUR_ABOVE:
 546                 // We reset the cursor because cursorStatus() does not
 547                 // work when the cursor is within mathed.
 548                 cur.reset(buffer_.inset());
 549                 tm.setCursorFromCoordinates(cur, 0, first);
 550                 cur.clearSelection();
 551                 break;
 552         case CUR_BELOW:
 553                 // We reset the cursor because cursorStatus() does not
 554                 // work when the cursor is within mathed.
 555                 cur.reset(buffer_.inset());
 556                 tm.setCursorFromCoordinates(cur, 0, last);
 557                 cur.clearSelection();
 558                 break;
 559         case CUR_INSIDE:
 560                 int const y = getPos(cur, cur.boundary()).y_;
 561                 int const newy = min(last, max(y, first));
 562                 if (y != newy) {
 563                         cur.reset(buffer_.inset());
 564                         tm.setCursorFromCoordinates(cur, 0, newy);
 565                 }
 566         }
 567 }
 568
 569
 570 Change const BufferView::getCurrentChange() const
 571 {
 572         if (!d->cursor_.selection())
 573                 return Change(Change::UNCHANGED);
 574
 575         DocIterator dit = d->cursor_.selectionBegin();
 576         return dit.paragraph().lookupChange(dit.pos());
 577 }
 578
 579
 580 // this could be used elsewhere as well?
 581 // FIXME: This does not work within mathed!
 582 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
 583 {
 584         Point const p = getPos(dit, dit.boundary());
 585         if (p.y_ < 0)
 586                 return CUR_ABOVE;
 587         if (p.y_ > workHeight())
 588                 return CUR_BELOW;
 589         return CUR_INSIDE;
 590 }
 591
 592
 593 void BufferView::saveBookmark(unsigned int idx)
 594 {
 595         // tenatively save bookmark, id and pos will be used to
 596         // acturately locate a bookmark in a 'live' lyx session.
 597         // pit and pos will be updated with bottom level pit/pos
 598         // when lyx exits.
 599         LyX::ref().session().bookmarks().save(
 600                 buffer_.fileName(),
 601                 d->cursor_.bottom().pit(),
 602                 d->cursor_.bottom().pos(),
 603                 d->cursor_.paragraph().id(),
 604                 d->cursor_.pos(),
 605                 idx
 606         );
 607         if (idx)
 608                 // emit message signal.
 609                 message(_("Save bookmark"));
 610 }
 611
 612
 613 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
 614         int top_id, pos_type top_pos)
 615 {
 616         bool success = false;
 617         DocIterator doc_it;
 618
 619         d->cursor_.clearSelection();
 620
 621         // if a valid par_id is given, try it first
 622         // This is the case for a 'live' bookmark when unique paragraph ID
 623         // is used to track bookmarks.
 624         if (top_id > 0) {
 625                 ParIterator par = buffer_.getParFromID(top_id);
 626                 if (par != buffer_.par_iterator_end()) {
 627                         doc_it = makeDocIterator(par, min(par->size(), top_pos));
 628                         // Some slices of the iterator may not be
 629                         // reachable (e.g. closed collapsable inset)
 630                         // so the dociterator may need to be
 631                         // shortened. Otherwise, setCursor may crash
 632                         // lyx when the cursor can not be set to these
 633                         // insets.
 634                         size_t const n = doc_it.depth();
 635                         for (size_t i = 0; i < n; ++i)
 636                                 if (doc_it[i].inset().editable() != Inset::HIGHLY_EDITABLE) {
 637                                         doc_it.resize(i);
 638                                         break;
 639                                 }
 640                         success = true;
 641                 }
 642         }
 643
 644         // if top_id == 0, or searching through top_id failed
 645         // This is the case for a 'restored' bookmark when only bottom
 646         // (document level) pit was saved. Because of this, bookmark
 647         // restoration is inaccurate. If a bookmark was within an inset,
 648         // it will be restored to the left of the outmost inset that contains
 649         // the bookmark.
 650         if (static_cast<size_t>(bottom_pit) < buffer_.paragraphs().size()) {
 651                 doc_it = doc_iterator_begin(buffer_.inset());
 652                 doc_it.pit() = bottom_pit;
 653                 doc_it.pos() = min(bottom_pos, doc_it.paragraph().size());
 654                 success = true;
 655         }
 656
 657         if (success) {
 658                 // Note: only bottom (document) level pit is set.
 659                 setCursor(doc_it);
 660                 // set the current font.
 661                 d->cursor_.setCurrentFont();
 662                 // To center the screen on this new position we need the
 663                 // paragraph position which is computed at draw() time.
 664                 // So we need a redraw!
 665                 buffer_.changed();
 666                 if (fitCursor())
 667                         showCursor();
 668         }
 669
 670         return success;
 671 }
 672
 673
 674 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
 675 {
 676         if (lyxrc.rtl_support) {
 677                 if (d->cursor_.real_current_font.isRightToLeft()) {
 678                         if (d->intl_.keymap == Intl::PRIMARY)
 679                                 d->intl_.keyMapSec();
 680                 } else {
 681                         if (d->intl_.keymap == Intl::SECONDARY)
 682                                 d->intl_.keyMapPrim();
 683                 }
 684         }
 685
 686         d->intl_.getTransManager().translateAndInsert(c, t, cur);
 687 }
 688
 689
 690 int BufferView::workWidth() const
 691 {
 692         return width_;
 693 }
 694
 695
 696 void BufferView::showCursor()
 697 {
 698         // We are not properly started yet, delay until resizing is
 699         // done.
 700         if (height_ == 0)
 701                 return;
 702
 703         LYXERR(Debug::SCROLLING, "recentering!");
 704
 705         CursorSlice & bot = d->cursor_.bottom();
 706         TextMetrics & tm = d->text_metrics_[bot.text()];
 707
 708         pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
 709         int bot_pit = d->cursor_.bottom().pit();
 710         if (bot_pit > max_pit) {
 711                 // FIXME: Why does this happen?
 712                 LYXERR0("bottom pit is greater that max pit: "
 713                         << bot_pit << " > " << max_pit);
 714                 bot_pit = max_pit;
 715         }
 716
 717         if (bot_pit == tm.first().first - 1)
 718                 tm.newParMetricsUp();
 719         else if (bot_pit == tm.last().first + 1)
 720                 tm.newParMetricsDown();
 721
 722         if (tm.has(bot_pit)) {
 723                 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
 724                 int offset = coordOffset(d->cursor_, d->cursor_.boundary()).y_;
 725                 int ypos = pm.position() + offset;
 726                 Dimension const & row_dim = d->cursor_.textRow().dimension();
 727                 if (ypos - row_dim.ascent() < 0)
 728                         scrollUp(- ypos + row_dim.ascent());
 729                 else if (ypos + row_dim.descent() > height_)
 730                         scrollDown(ypos - height_ + row_dim.descent());
 731                 // else, nothing to do, the cursor is already visible so we just return.
 732                 return;
 733         }
 734
 735         tm.redoParagraph(bot_pit);
 736         ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
 737         int offset = coordOffset(d->cursor_, d->cursor_.boundary()).y_;
 738
 739         d->anchor_pit_ = bot_pit;
 740         Dimension const & row_dim = d->cursor_.textRow().dimension();
 741
 742         if (d->anchor_pit_ == 0)
 743                 d->anchor_ypos_ = offset + pm.ascent();
 744         else if (d->anchor_pit_ == max_pit)
 745                 d->anchor_ypos_ = height_ - offset - row_dim.descent();
 746         else
 747                 d->anchor_ypos_ = offset + pm.ascent() - height_ / 2;
 748
 749         updateMetrics();
 750         buffer_.changed();
 751 }
 752
 753
 754 FuncStatus BufferView::getStatus(FuncRequest const & cmd)
 755 {
 756         FuncStatus flag;
 757
 758         Cursor & cur = d->cursor_;
 759
 760         switch (cmd.action) {
 761
 762         case LFUN_UNDO:
 763                 flag.enabled(buffer_.undo().hasUndoStack());
 764                 break;
 765         case LFUN_REDO:
 766                 flag.enabled(buffer_.undo().hasRedoStack());
 767                 break;
 768         case LFUN_FILE_INSERT:
 769         case LFUN_FILE_INSERT_PLAINTEXT_PARA:
 770         case LFUN_FILE_INSERT_PLAINTEXT:
 771         case LFUN_BOOKMARK_SAVE:
 772                 // FIXME: Actually, these LFUNS should be moved to Text
 773                 flag.enabled(cur.inTexted());
 774                 break;
 775         case LFUN_FONT_STATE:
 776         case LFUN_LABEL_INSERT:
 777         case LFUN_INFO_INSERT:
 778         case LFUN_PARAGRAPH_GOTO:
 779         case LFUN_NOTE_NEXT:
 780         case LFUN_REFERENCE_NEXT:
 781         case LFUN_WORD_FIND:
 782         case LFUN_WORD_REPLACE:
 783         case LFUN_MARK_OFF:
 784         case LFUN_MARK_ON:
 785         case LFUN_MARK_TOGGLE:
 786         case LFUN_SCREEN_RECENTER:
 787         case LFUN_BIBTEX_DATABASE_ADD:
 788         case LFUN_BIBTEX_DATABASE_DEL:
 789         case LFUN_WORDS_COUNT:
 790         case LFUN_NEXT_INSET_TOGGLE:
 791                 flag.enabled(true);
 792                 break;
 793
 794         case LFUN_LABEL_GOTO: {
 795                 flag.enabled(!cmd.argument().empty()
 796                     || getInsetByCode<InsetRef>(cur, REF_CODE));
 797                 break;
 798         }
 799
 800         case LFUN_CHANGES_TRACK:
 801                 flag.enabled(true);
 802                 flag.setOnOff(buffer_.params().trackChanges);
 803                 break;
 804
 805         case LFUN_CHANGES_OUTPUT:
 806                 flag.enabled(true);
 807                 flag.setOnOff(buffer_.params().outputChanges);
 808                 break;
 809
 810         case LFUN_CHANGES_MERGE:
 811         case LFUN_CHANGE_NEXT:
 812         case LFUN_ALL_CHANGES_ACCEPT:
 813         case LFUN_ALL_CHANGES_REJECT:
 814                 // TODO: context-sensitive enabling of LFUNs
 815                 // In principle, these command should only be enabled if there
 816                 // is a change in the document. However, without proper
 817                 // optimizations, this will inevitably result in poor performance.
 818                 flag.enabled(true);
 819                 break;
 820
 821         case LFUN_BUFFER_TOGGLE_COMPRESSION: {
 822                 flag.setOnOff(buffer_.params().compressed);
 823                 break;
 824         }
 825
 826         case LFUN_BUFFER_TOGGLE_EMBEDDING: {
 827                 flag.setOnOff(buffer_.params().embedded);
 828                 break;
 829         }
 830
 831         case LFUN_SCREEN_UP:
 832         case LFUN_SCREEN_DOWN:
 833                 flag.enabled(true);
 834                 break;
 835
 836         // FIXME: LFUN_SCREEN_DOWN_SELECT should be removed from
 837         // everywhere else before this can enabled:
 838         case LFUN_SCREEN_UP_SELECT:
 839         case LFUN_SCREEN_DOWN_SELECT:
 840                 flag.enabled(false);
 841                 break;
 842
 843         case LFUN_LAYOUT_TABULAR:
 844                 flag.enabled(cur.innerInsetOfType(TABULAR_CODE));
 845                 break;
 846
 847         case LFUN_LAYOUT:
 848         case LFUN_LAYOUT_PARAGRAPH:
 849                 flag.enabled(cur.inset().forceDefaultParagraphs(cur.idx()));
 850                 break;
 851
 852         case LFUN_INSET_SETTINGS: {
 853                 InsetCode code = cur.inset().lyxCode();
 854                 bool enable = false;
 855                 switch (code) {
 856                         case TABULAR_CODE:
 857                                 enable = cmd.argument() == "tabular";
 858                                 break;
 859                         case ERT_CODE:
 860                                 enable = cmd.argument() == "ert";
 861                                 break;
 862                         case FLOAT_CODE:
 863                                 enable = cmd.argument() == "float";
 864                                 break;
 865                         case WRAP_CODE:
 866                                 enable = cmd.argument() == "wrap";
 867                                 break;
 868                         case NOTE_CODE:
 869                                 enable = cmd.argument() == "note";
 870                                 break;
 871                         case BRANCH_CODE:
 872                                 enable = cmd.argument() == "branch";
 873                                 break;
 874                         case BOX_CODE:
 875                                 enable = cmd.argument() == "box";
 876                                 break;
 877                         case LISTINGS_CODE:
 878                                 enable = cmd.argument() == "listings";
 879                                 break;
 880                         default:
 881                                 break;
 882                 }
 883                 flag.enabled(enable);
 884                 break;
 885         }
 886
 887         case LFUN_DIALOG_SHOW_NEW_INSET:
 888                 flag.enabled(cur.inset().lyxCode() != ERT_CODE &&
 889                         cur.inset().lyxCode() != LISTINGS_CODE);
 890                 if (cur.inset().lyxCode() == CAPTION_CODE) {
 891                         FuncStatus flag;
 892                         if (cur.inset().getStatus(cur, cmd, flag))
 893                                 return flag;
 894                 }
 895                 break;
 896
 897         default:
 898                 flag.enabled(false);
 899         }
 900
 901         return flag;
 902 }
 903
 904
 905 bool BufferView::dispatch(FuncRequest const & cmd)
 906 {
 907         //lyxerr << [ cmd = " << cmd << "]" << endl;
 908
 909         // Make sure that the cached BufferView is correct.
 910         LYXERR(Debug::ACTION, " action[" << cmd.action << ']'
 911                 << " arg[" << to_utf8(cmd.argument()) << ']'
 912                 << " x[" << cmd.x << ']'
 913                 << " y[" << cmd.y << ']'
 914                 << " button[" << cmd.button() << ']');
 915
 916         Cursor & cur = d->cursor_;
 917
 918         switch (cmd.action) {
 919
 920         case LFUN_UNDO:
 921                 cur.message(_("Undo"));
 922                 cur.clearSelection();
 923                 if (!cur.textUndo())
 924                         cur.message(_("No further undo information"));
 925                 else
 926                         processUpdateFlags(Update::Force | Update::FitCursor);
 927                 break;
 928
 929         case LFUN_REDO:
 930                 cur.message(_("Redo"));
 931                 cur.clearSelection();
 932                 if (!cur.textRedo())
 933                         cur.message(_("No further redo information"));
 934                 else
 935                         processUpdateFlags(Update::Force | Update::FitCursor);
 936                 break;
 937
 938         case LFUN_FONT_STATE:
 939                 cur.message(cur.currentState());
 940                 break;
 941
 942         case LFUN_BOOKMARK_SAVE:
 943                 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
 944                 break;
 945
 946         case LFUN_LABEL_GOTO: {
 947                 docstring label = cmd.argument();
 948                 if (label.empty()) {
 949                         InsetRef * inset =
 950                                 getInsetByCode<InsetRef>(d->cursor_,
 951                                                          REF_CODE);
 952                         if (inset) {
 953                                 label = inset->getParam("reference");
 954                                 // persistent=false: use temp_bookmark
 955                                 saveBookmark(0);
 956                         }
 957                 }
 958
 959                 if (!label.empty())
 960                         gotoLabel(label);
 961                 break;
 962         }
 963
 964         case LFUN_PARAGRAPH_GOTO: {
 965                 int const id = convert<int>(to_utf8(cmd.argument()));
 966                 int i = 0;
 967                 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
 968                         b = theBufferList().next(b)) {
 969
 970                         ParIterator par = b->getParFromID(id);
 971                         if (par == b->par_iterator_end()) {
 972                                 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
 973                         } else {
 974                                 LYXERR(Debug::INFO, "Paragraph " << par->id()
 975                                         << " found in buffer `"
 976                                         << b->absFileName() << "'.");
 977
 978                                 if (b == &buffer_) {
 979                                         // Set the cursor
 980                                         setCursor(makeDocIterator(par, 0));
 981                                         showCursor();
 982                                 } else {
 983                                         // Switch to other buffer view and resend cmd
 984                                         theLyXFunc().dispatch(FuncRequest(
 985                                                 LFUN_BUFFER_SWITCH, b->absFileName()));
 986                                         theLyXFunc().dispatch(cmd);
 987                                 }
 988                                 break;
 989                         }
 990                         ++i;
 991                 }
 992                 break;
 993         }
 994
 995         case LFUN_NOTE_NEXT:
 996                 gotoInset(this, NOTE_CODE, false);
 997                 break;
 998
 999         case LFUN_REFERENCE_NEXT: {
1000                 vector<InsetCode> tmp;
1001                 tmp.push_back(LABEL_CODE);
1002                 tmp.push_back(REF_CODE);
1003                 gotoInset(this, tmp, true);
1004                 break;
1005         }
1006
1007         case LFUN_CHANGES_TRACK:
1008                 buffer_.params().trackChanges = !buffer_.params().trackChanges;
1009                 break;
1010
1011         case LFUN_CHANGES_OUTPUT:
1012                 buffer_.params().outputChanges = !buffer_.params().outputChanges;
1013                 if (buffer_.params().outputChanges) {
1014                         bool dvipost    = LaTeXFeatures::isAvailable("dvipost");
1015                         bool xcolorsoul = LaTeXFeatures::isAvailable("soul") &&
1016                                           LaTeXFeatures::isAvailable("xcolor");
1017
1018                         if (!dvipost && !xcolorsoul) {
1019                                 Alert::warning(_("Changes not shown in LaTeX output"),
1020                                                _("Changes will not be highlighted in LaTeX output, "
1021                                                  "because neither dvipost nor xcolor/soul are installed.\n"
1022                                                  "Please install these packages or redefine "
1023                                                  "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1024                         } else if (!xcolorsoul) {
1025                                 Alert::warning(_("Changes not shown in LaTeX output"),
1026                                                _("Changes will not be highlighted in LaTeX output "
1027                                                  "when using pdflatex, because xcolor and soul are not installed.\n"
1028                                                  "Please install both packages or redefine "
1029                                                  "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1030                         }
1031                 }
1032                 break;
1033
1034         case LFUN_CHANGE_NEXT:
1035                 findNextChange(this);
1036                 break;
1037
1038         case LFUN_CHANGES_MERGE:
1039                 if (findNextChange(this))
1040                         showDialog("changes");
1041                 break;
1042
1043         case LFUN_ALL_CHANGES_ACCEPT:
1044                 // select complete document
1045                 d->cursor_.reset(buffer_.inset());
1046                 d->cursor_.selHandle(true);
1047                 buffer_.text().cursorBottom(d->cursor_);
1048                 // accept everything in a single step to support atomic undo
1049                 buffer_.text().acceptOrRejectChanges(d->cursor_, Text::ACCEPT);
1050                 break;
1051
1052         case LFUN_ALL_CHANGES_REJECT:
1053                 // select complete document
1054                 d->cursor_.reset(buffer_.inset());
1055                 d->cursor_.selHandle(true);
1056                 buffer_.text().cursorBottom(d->cursor_);
1057                 // reject everything in a single step to support atomic undo
1058                 // Note: reject does not work recursively; the user may have to repeat the operation
1059                 buffer_.text().acceptOrRejectChanges(d->cursor_, Text::REJECT);
1060                 break;
1061
1062         case LFUN_WORD_FIND:
1063                 find(this, cmd);
1064                 break;
1065
1066         case LFUN_WORD_REPLACE: {
1067                 bool has_deleted = false;
1068                 if (cur.selection()) {
1069                         DocIterator beg = cur.selectionBegin();
1070                         DocIterator end = cur.selectionEnd();
1071                         if (beg.pit() == end.pit()) {
1072                                 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1073                                         if (cur.paragraph().isDeleted(p))
1074                                                 has_deleted = true;
1075                                 }
1076                         }
1077                 }
1078                 replace(this, cmd, has_deleted);
1079                 break;
1080         }
1081
1082         case LFUN_MARK_OFF:
1083                 cur.clearSelection();
1084                 cur.resetAnchor();
1085                 cur.message(from_utf8(N_("Mark off")));
1086                 break;
1087
1088         case LFUN_MARK_ON:
1089                 cur.clearSelection();
1090                 cur.mark() = true;
1091                 cur.resetAnchor();
1092                 cur.message(from_utf8(N_("Mark on")));
1093                 break;
1094
1095         case LFUN_MARK_TOGGLE:
1096                 cur.clearSelection();
1097                 if (cur.mark()) {
1098                         cur.mark() = false;
1099                         cur.message(from_utf8(N_("Mark removed")));
1100                 } else {
1101                         cur.mark() = true;
1102                         cur.message(from_utf8(N_("Mark set")));
1103                 }
1104                 cur.resetAnchor();
1105                 break;
1106
1107         case LFUN_SCREEN_RECENTER:
1108                 showCursor();
1109                 break;
1110
1111         case LFUN_BIBTEX_DATABASE_ADD: {
1112                 Cursor tmpcur = d->cursor_;
1113                 findInset(tmpcur, BIBTEX_CODE, false);
1114                 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1115                                                 BIBTEX_CODE);
1116                 if (inset) {
1117                         if (inset->addDatabase(to_utf8(cmd.argument())))
1118                                 buffer_.updateBibfilesCache();
1119                 }
1120                 break;
1121         }
1122
1123         case LFUN_BIBTEX_DATABASE_DEL: {
1124                 Cursor tmpcur = d->cursor_;
1125                 findInset(tmpcur, BIBTEX_CODE, false);
1126                 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1127                                                 BIBTEX_CODE);
1128                 if (inset) {
1129                         if (inset->delDatabase(to_utf8(cmd.argument())))
1130                                 buffer_.updateBibfilesCache();
1131                 }
1132                 break;
1133         }
1134
1135         case LFUN_WORDS_COUNT: {
1136                 DocIterator from, to;
1137                 if (cur.selection()) {
1138                         from = cur.selectionBegin();
1139                         to = cur.selectionEnd();
1140                 } else {
1141                         from = doc_iterator_begin(buffer_.inset());
1142                         to = doc_iterator_end(buffer_.inset());
1143                 }
1144                 int const count = countWords(from, to);
1145                 docstring message;
1146                 if (count != 1) {
1147                         if (cur.selection())
1148                                 message = bformat(_("%1$d words in selection."),
1149                                           count);
1150                                 else
1151                                         message = bformat(_("%1$d words in document."),
1152                                                           count);
1153                 }
1154                 else {
1155                         if (cur.selection())
1156                                 message = _("One word in selection.");
1157                         else
1158                                 message = _("One word in document.");
1159                 }
1160
1161                 Alert::information(_("Count words"), message);
1162         }
1163                 break;
1164
1165         case LFUN_BUFFER_TOGGLE_COMPRESSION:
1166                 // turn compression on/off
1167                 buffer_.params().compressed = !buffer_.params().compressed;
1168                 break;
1169
1170         case LFUN_BUFFER_TOGGLE_EMBEDDING:
1171                 // turn embedding on/off
1172                 buffer_.embeddedFiles().enable(!buffer_.params().embedded);
1173                 break;
1174
1175         case LFUN_NEXT_INSET_TOGGLE: {
1176                 // this is the real function we want to invoke
1177                 FuncRequest tmpcmd = FuncRequest(LFUN_INSET_TOGGLE, cmd.origin);
1178                 // if there is an inset at cursor, see whether it
1179                 // wants to toggle.
1180                 Inset * inset = cur.nextInset();
1181                 if (inset) {
1182                         if (inset->isActive()) {
1183                                 Cursor tmpcur = cur;
1184                                 tmpcur.pushBackward(*inset);
1185                                 inset->dispatch(tmpcur, tmpcmd);
1186                                 if (tmpcur.result().dispatched()) {
1187                                         cur.dispatched();
1188                                 }
1189                         } else if (inset->editable() == Inset::IS_EDITABLE) {
1190                                 inset->edit(cur, true);
1191                         }
1192                 }
1193                 // if it did not work, try the underlying inset.
1194                 if (!cur.result().dispatched())
1195                         cur.dispatch(tmpcmd);
1196
1197                 if (!cur.result().dispatched())
1198                         // It did not work too; no action needed.
1199                         break;
1200                 cur.clearSelection();
1201                 processUpdateFlags(Update::SinglePar | Update::FitCursor);
1202                 break;
1203         }
1204
1205         case LFUN_SCREEN_UP:
1206         case LFUN_SCREEN_DOWN: {
1207                 Point p = getPos(cur, cur.boundary());
1208                 if (p.y_ < 0 || p.y_ > height_) {
1209                         // The cursor is off-screen so recenter before proceeding.
1210                         showCursor();
1211                         p = getPos(cur, cur.boundary());
1212                 }
1213                 scroll(cmd.action == LFUN_SCREEN_UP? - height_ : height_);
1214                 cur.reset(buffer_.inset());
1215                 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_);
1216                 //FIXME: what to do with cur.x_target()?
1217                 cur.finishUndo();
1218                 break;
1219         }
1220
1221         case LFUN_SCREEN_UP_SELECT:
1222         case LFUN_SCREEN_DOWN_SELECT: {
1223                 // Those two are not ready yet for consumption.
1224                 return false;
1225
1226                 cur.selHandle(true);
1227                 size_t initial_depth = cur.depth();
1228                 Point const p = getPos(cur, cur.boundary());
1229                 scroll(cmd.action == LFUN_SCREEN_UP_SELECT? - height_ : height_);
1230                 // FIXME: We need to verify if the cursor stayed within an inset...
1231                 //cur.reset(buffer_.inset());
1232                 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_);
1233                 cur.finishUndo();
1234                 while (cur.depth() > initial_depth) {
1235                         cur.forwardInset();
1236                 }
1237                 // FIXME: we need to do a redraw again because of the selection
1238                 // But no screen update is needed.
1239                 d->update_strategy_ = NoScreenUpdate;
1240                 buffer_.changed();
1241                 break;
1242         }
1243
1244         default:
1245                 return false;
1246         }
1247
1248         return true;
1249 }
1250
1251
1252 docstring const BufferView::requestSelection()
1253 {
1254         Cursor & cur = d->cursor_;
1255
1256         if (!cur.selection()) {
1257                 d->xsel_cache_.set = false;
1258                 return docstring();
1259         }
1260
1261         if (!d->xsel_cache_.set ||
1262             cur.top() != d->xsel_cache_.cursor ||
1263             cur.anchor_.top() != d->xsel_cache_.anchor)
1264         {
1265                 d->xsel_cache_.cursor = cur.top();
1266                 d->xsel_cache_.anchor = cur.anchor_.top();
1267                 d->xsel_cache_.set = cur.selection();
1268                 return cur.selectionAsString(false);
1269         }
1270         return docstring();
1271 }
1272
1273
1274 void BufferView::clearSelection()
1275 {
1276         d->cursor_.clearSelection();
1277         // Clear the selection buffer. Otherwise a subsequent
1278         // middle-mouse-button paste would use the selection buffer,
1279         // not the more current external selection.
1280         cap::clearSelection();
1281         d->xsel_cache_.set = false;
1282         // The buffer did not really change, but this causes the
1283         // redraw we need because we cleared the selection above.
1284         buffer_.changed();
1285 }
1286
1287
1288 void BufferView::resize(int width, int height)
1289 {
1290         // Update from work area
1291         width_ = width;
1292         height_ = height;
1293
1294         // Clear the paragraph height cache.
1295         d->par_height_.clear();
1296
1297         updateMetrics();
1298 }
1299
1300
1301 Inset const * BufferView::getCoveringInset(Text const & text,
1302                 int x, int y) const
1303 {
1304         TextMetrics & tm = d->text_metrics_[&text];
1305         Inset * inset = tm.checkInsetHit(x, y);
1306         if (!inset)
1307                 return 0;
1308
1309         if (!inset->descendable())
1310                 // No need to go further down if the inset is not
1311                 // descendable.
1312                 return inset;
1313
1314         size_t cell_number = inset->nargs();
1315         // Check all the inner cell.
1316         for (size_t i = 0; i != cell_number; ++i) {
1317                 Text const * inner_text = inset->getText(i);
1318                 if (inner_text) {
1319                         // Try deeper.
1320                         Inset const * inset_deeper =
1321                                 getCoveringInset(*inner_text, x, y);
1322                         if (inset_deeper)
1323                                 return inset_deeper;
1324                 }
1325         }
1326
1327         return inset;
1328 }
1329
1330
1331 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
1332 {
1333         //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
1334
1335         // This is only called for mouse related events including
1336         // LFUN_FILE_OPEN generated by drag-and-drop.
1337         FuncRequest cmd = cmd0;
1338
1339         Cursor cur(*this);
1340         cur.push(buffer_.inset());
1341         cur.selection() = d->cursor_.selection();
1342
1343         // Either the inset under the cursor or the
1344         // surrounding Text will handle this event.
1345
1346         // make sure we stay within the screen...
1347         cmd.y = min(max(cmd.y, -1), height_);
1348
1349         if (cmd.action == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
1350
1351                 // Get inset under mouse, if there is one.
1352                 Inset const * covering_inset =
1353                         getCoveringInset(buffer_.text(), cmd.x, cmd.y);
1354                 if (covering_inset == d->last_inset_)
1355                         // Same inset, no need to do anything...
1356                         return;
1357
1358                 bool need_redraw = false;
1359                 // const_cast because of setMouseHover().
1360                 Inset * inset = const_cast<Inset *>(covering_inset);
1361                 if (d->last_inset_)
1362                         // Remove the hint on the last hovered inset (if any).
1363                         need_redraw |= d->last_inset_->setMouseHover(false);
1364                 if (inset)
1365                         // Highlighted the newly hovered inset (if any).
1366                         need_redraw |= inset->setMouseHover(true);
1367                 d->last_inset_ = inset;
1368                 if (!need_redraw)
1369                         return;
1370
1371                 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
1372                         << cmd.x << ", " << cmd.y << ")");
1373
1374                 d->update_strategy_ = DecorationUpdate;
1375
1376                 // This event (moving without mouse click) is not passed further.
1377                 // This should be changed if it is further utilized.
1378                 buffer_.changed();
1379                 return;
1380         }
1381
1382         // Build temporary cursor.
1383         Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x, cmd.y);
1384
1385         // Put anchor at the same position.
1386         cur.resetAnchor();
1387
1388         // Try to dispatch to an non-editable inset near this position
1389         // via the temp cursor. If the inset wishes to change the real
1390         // cursor it has to do so explicitly by using
1391         //  cur.bv().cursor() = cur;  (or similar)
1392         if (inset)
1393                 inset->dispatch(cur, cmd);
1394
1395         // Now dispatch to the temporary cursor. If the real cursor should
1396         // be modified, the inset's dispatch has to do so explicitly.
1397         if (!cur.result().dispatched())
1398                 cur.dispatch(cmd);
1399
1400         //Do we have a selection?
1401         theSelection().haveSelection(cursor().selection());
1402
1403         // If the command has been dispatched,
1404         if (cur.result().dispatched()
1405                 // an update is asked,
1406                 && cur.result().update())
1407                 processUpdateFlags(cur.result().update());
1408 }
1409
1410
1411 void BufferView::scroll(int y)
1412 {
1413         if (y > 0)
1414                 scrollDown(y);
1415         else if (y < 0)
1416                 scrollUp(-y);
1417 }
1418
1419
1420 void BufferView::scrollDown(int offset)
1421 {
1422         Text * text = &buffer_.text();
1423         TextMetrics & tm = d->text_metrics_[text];
1424         int ymax = height_ + offset;
1425         while (true) {
1426                 pair<pit_type, ParagraphMetrics const *> last = tm.last();
1427                 int bottom_pos = last.second->position() + last.second->descent();
1428                 if (last.first + 1 == int(text->paragraphs().size())) {
1429                         if (bottom_pos <= height_)
1430                                 return;
1431                         offset = min(offset, bottom_pos - height_);
1432                         break;
1433                 }
1434                 if (bottom_pos > ymax)
1435                         break;
1436                 tm.newParMetricsDown();
1437         }
1438         d->anchor_ypos_ -= offset;
1439         updateMetrics();
1440         buffer_.changed();
1441 }
1442
1443
1444 void BufferView::scrollUp(int offset)
1445 {
1446         Text * text = &buffer_.text();
1447         TextMetrics & tm = d->text_metrics_[text];
1448         int ymin = - offset;
1449         while (true) {
1450                 pair<pit_type, ParagraphMetrics const *> first = tm.first();
1451                 int top_pos = first.second->position() - first.second->ascent();
1452                 if (first.first == 0) {
1453                         if (top_pos >= 0)
1454                                 return;
1455                         offset = min(offset, - top_pos);
1456                         break;
1457                 }
1458                 if (top_pos < ymin)
1459                         break;
1460                 tm.newParMetricsUp();
1461         }
1462         d->anchor_ypos_ += offset;
1463         updateMetrics();
1464         buffer_.changed();
1465 }
1466
1467
1468 void BufferView::setCursorFromRow(int row)
1469 {
1470         int tmpid = -1;
1471         int tmppos = -1;
1472
1473         buffer_.texrow().getIdFromRow(row, tmpid, tmppos);
1474
1475         d->cursor_.reset(buffer_.inset());
1476         if (tmpid == -1)
1477                 buffer_.text().setCursor(d->cursor_, 0, 0);
1478         else
1479                 buffer_.text().setCursor(d->cursor_, buffer_.getParFromID(tmpid).pit(), tmppos);
1480 }
1481
1482
1483 void BufferView::gotoLabel(docstring const & label)
1484 {
1485         for (InsetIterator it = inset_iterator_begin(buffer_.inset()); it; ++it) {
1486                 vector<docstring> labels;
1487                 it->getLabelList(buffer_, labels);
1488                 if (find(labels.begin(), labels.end(), label) != labels.end()) {
1489                         setCursor(it);
1490                         showCursor();
1491                         return;
1492                 }
1493         }
1494 }
1495
1496
1497 TextMetrics const & BufferView::textMetrics(Text const * t) const
1498 {
1499         return const_cast<BufferView *>(this)->textMetrics(t);
1500 }
1501
1502
1503 TextMetrics & BufferView::textMetrics(Text const * t)
1504 {
1505         TextMetricsCache::iterator tmc_it  = d->text_metrics_.find(t);
1506         if (tmc_it == d->text_metrics_.end()) {
1507                 tmc_it = d->text_metrics_.insert(
1508                         make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
1509         }
1510         return tmc_it->second;
1511 }
1512
1513
1514 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
1515                 pit_type pit) const
1516 {
1517         return textMetrics(t).parMetrics(pit);
1518 }
1519
1520
1521 int BufferView::workHeight() const
1522 {
1523         return height_;
1524 }
1525
1526
1527 void BufferView::setCursor(DocIterator const & dit)
1528 {
1529         size_t const n = dit.depth();
1530         for (size_t i = 0; i < n; ++i)
1531                 dit[i].inset().edit(d->cursor_, true);
1532
1533         d->cursor_.setCursor(dit);
1534         d->cursor_.selection() = false;
1535 }
1536
1537
1538 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
1539 {
1540         // Would be wrong to delete anything if we have a selection.
1541         if (cur.selection())
1542                 return false;
1543
1544         bool need_anchor_change = false;
1545         bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
1546                 need_anchor_change);
1547
1548         if (need_anchor_change)
1549                 cur.resetAnchor();
1550
1551         if (!changed)
1552                 return false;
1553
1554         updateLabels(buffer_);
1555
1556         updateMetrics();
1557         buffer_.changed();
1558         return true;
1559 }
1560
1561
1562 bool BufferView::mouseSetCursor(Cursor & cur, bool select)
1563 {
1564         BOOST_ASSERT(&cur.bv() == this);
1565
1566         if (!select)
1567                 // this event will clear selection so we save selection for
1568                 // persistent selection
1569                 cap::saveSelection(cursor());
1570
1571         // Has the cursor just left the inset?
1572         bool badcursor = false;
1573         bool leftinset = (&d->cursor_.inset() != &cur.inset());
1574         if (leftinset)
1575                 badcursor = notifyCursorLeaves(d->cursor_, cur);
1576
1577         // FIXME: shift-mouse selection doesn't work well across insets.
1578         bool do_selection = select && &d->cursor_.anchor().inset() == &cur.inset();
1579
1580         // do the dEPM magic if needed
1581         // FIXME: (1) move this to InsetText::notifyCursorLeaves?
1582         // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
1583         // the leftinset bool would not be necessary (badcursor instead).
1584         bool update = leftinset;
1585         if (!do_selection && !badcursor && d->cursor_.inTexted())
1586                 update |= checkDepm(cur, d->cursor_);
1587
1588         // if the cursor was in an empty script inset and the new
1589         // position is in the nucleus of the inset, notifyCursorLeaves
1590         // will kill the script inset itself. So we check all the
1591         // elements of the cursor to make sure that they are correct.
1592         // For an example, see bug 2933:
1593         // http://bugzilla.lyx.org/show_bug.cgi?id=2933
1594         // The code below could maybe be moved to a DocIterator method.
1595         //lyxerr << "cur before " << cur <<endl;
1596         DocIterator dit(cur.inset());
1597         dit.push_back(cur.bottom());
1598         size_t i = 1;
1599         while (i < cur.depth() && dit.nextInset() == &cur[i].inset()) {
1600                 dit.push_back(cur[i]);
1601                 ++i;
1602         }
1603         //lyxerr << "5 cur after" << dit <<endl;
1604
1605         d->cursor_.setCursor(dit);
1606         d->cursor_.boundary(cur.boundary());
1607         if (do_selection)
1608                 d->cursor_.setSelection();
1609         else
1610                 d->cursor_.clearSelection();
1611
1612         d->cursor_.finishUndo();
1613         d->cursor_.setCurrentFont();
1614         return update;
1615 }
1616
1617
1618 void BufferView::putSelectionAt(DocIterator const & cur,
1619                                 int length, bool backwards)
1620 {
1621         d->cursor_.clearSelection();
1622
1623         setCursor(cur);
1624
1625         if (length) {
1626                 if (backwards) {
1627                         d->cursor_.pos() += length;
1628                         d->cursor_.setSelection(d->cursor_, -length);
1629                 } else
1630                         d->cursor_.setSelection(d->cursor_, length);
1631         }
1632 }
1633
1634
1635 Cursor & BufferView::cursor()
1636 {
1637         return d->cursor_;
1638 }
1639
1640
1641 Cursor const & BufferView::cursor() const
1642 {
1643         return d->cursor_;
1644 }
1645
1646
1647 pit_type BufferView::anchor_ref() const
1648 {
1649         return d->anchor_pit_;
1650 }
1651
1652
1653 bool BufferView::singleParUpdate()
1654 {
1655         Text & buftext = buffer_.text();
1656         pit_type const bottom_pit = d->cursor_.bottom().pit();
1657         TextMetrics & tm = textMetrics(&buftext);
1658         int old_height = tm.parMetrics(bottom_pit).height();
1659
1660         // In Single Paragraph mode, rebreak only
1661         // the (main text, not inset!) paragraph containing the cursor.
1662         // (if this paragraph contains insets etc., rebreaking will
1663         // recursively descend)
1664         tm.redoParagraph(bottom_pit);
1665         ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
1666         if (pm.height() != old_height)
1667                 // Paragraph height has changed so we cannot proceed to
1668                 // the singlePar optimisation.
1669                 return false;
1670
1671         d->update_strategy_ = SingleParUpdate;
1672
1673         LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
1674                 << " y2: " << pm.position() + pm.descent()
1675                 << " pit: " << bottom_pit
1676                 << " singlepar: 1");
1677         return true;
1678 }
1679
1680
1681 void BufferView::updateMetrics()
1682 {
1683         Text & buftext = buffer_.text();
1684         pit_type const npit = int(buftext.paragraphs().size());
1685
1686         // Clear out the position cache in case of full screen redraw,
1687         d->coord_cache_.clear();
1688
1689         // Clear out paragraph metrics to avoid having invalid metrics
1690         // in the cache from paragraphs not relayouted below
1691         // The complete text metrics will be redone.
1692         d->text_metrics_.clear();
1693
1694         TextMetrics & tm = textMetrics(&buftext);
1695
1696         // Rebreak anchor paragraph.
1697         tm.redoParagraph(d->anchor_pit_);
1698         ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
1699         anchor_pm.setPosition(d->anchor_ypos_);
1700
1701         LYXERR(Debug::PAINTING, "metrics: "
1702                 << " anchor pit = " << d->anchor_pit_
1703                 << " anchor ypos = " << d->anchor_ypos_);
1704
1705         // Redo paragraphs above anchor if necessary.
1706         int y1 = d->anchor_ypos_ - anchor_pm.ascent();
1707         // We are now just above the anchor paragraph.
1708         pit_type pit1 = d->anchor_pit_ - 1;
1709         for (; pit1 >= 0 && y1 >= 0; --pit1) {
1710                 tm.redoParagraph(pit1);
1711                 ParagraphMetrics & pm = tm.par_metrics_[pit1];
1712                 y1 -= pm.descent();
1713                 // Save the paragraph position in the cache.
1714                 pm.setPosition(y1);
1715                 y1 -= pm.ascent();
1716         }
1717
1718         // Redo paragraphs below the anchor if necessary.
1719         int y2 = d->anchor_ypos_ + anchor_pm.descent();
1720         // We are now just below the anchor paragraph.
1721         pit_type pit2 = d->anchor_pit_ + 1;
1722         for (; pit2 < npit && y2 <= height_; ++pit2) {
1723                 tm.redoParagraph(pit2);
1724                 ParagraphMetrics & pm = tm.par_metrics_[pit2];
1725                 y2 += pm.ascent();
1726                 // Save the paragraph position in the cache.
1727                 pm.setPosition(y2);
1728                 y2 += pm.descent();
1729         }
1730
1731         LYXERR(Debug::PAINTING, "Metrics: "
1732                 << " anchor pit = " << d->anchor_pit_
1733                 << " anchor ypos = " << d->anchor_ypos_
1734                 << " y1 = " << y1
1735                 << " y2 = " << y2
1736                 << " pit1 = " << pit1
1737                 << " pit2 = " << pit2);
1738
1739         d->update_strategy_ = FullScreenUpdate;
1740
1741         if (lyxerr.debugging(Debug::WORKAREA)) {
1742                 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
1743                 d->coord_cache_.dump();
1744         }
1745 }
1746
1747
1748 void BufferView::insertLyXFile(FileName const & fname)
1749 {
1750         BOOST_ASSERT(d->cursor_.inTexted());
1751
1752         // Get absolute path of file and add ".lyx"
1753         // to the filename if necessary
1754         FileName filename = fileSearch(string(), fname.absFilename(), "lyx");
1755
1756         docstring const disp_fn = makeDisplayPath(filename.absFilename());
1757         // emit message signal.
1758         message(bformat(_("Inserting document %1$s..."), disp_fn));
1759
1760         docstring res;
1761         Buffer buf("", false);
1762         if (buf.loadLyXFile(filename)) {
1763                 ErrorList & el = buffer_.errorList("Parse");
1764                 // Copy the inserted document error list into the current buffer one.
1765                 el = buf.errorList("Parse");
1766                 buffer_.undo().recordUndo(d->cursor_);
1767                 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
1768                                              buf.params().getTextClassPtr(), el);
1769                 res = _("Document %1$s inserted.");
1770         } else {
1771                 res = _("Could not insert document %1$s");
1772         }
1773
1774         updateMetrics();
1775         buffer_.changed();
1776         // emit message signal.
1777         message(bformat(res, disp_fn));
1778         buffer_.errors("Parse");
1779 }
1780
1781
1782 Point BufferView::coordOffset(DocIterator const & dit, bool boundary) const
1783 {
1784         int x = 0;
1785         int y = 0;
1786         int lastw = 0;
1787
1788         // Addup contribution of nested insets, from inside to outside,
1789         // keeping the outer paragraph for a special handling below
1790         for (size_t i = dit.depth() - 1; i >= 1; --i) {
1791                 CursorSlice const & sl = dit[i];
1792                 int xx = 0;
1793                 int yy = 0;
1794
1795                 // get relative position inside sl.inset()
1796                 sl.inset().cursorPos(*this, sl, boundary && (i + 1 == dit.depth()), xx, yy);
1797
1798                 // Make relative position inside of the edited inset relative to sl.inset()
1799                 x += xx;
1800                 y += yy;
1801
1802                 // In case of an RTL inset, the edited inset will be positioned to the left
1803                 // of xx:yy
1804                 if (sl.text()) {
1805                         bool boundary_i = boundary && i + 1 == dit.depth();
1806                         bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
1807                         if (rtl)
1808                                 x -= lastw;
1809                 }
1810
1811                 // remember width for the case that sl.inset() is positioned in an RTL inset
1812                 if (i && dit[i - 1].text()) {
1813                         // If this Inset is inside a Text Inset, retrieve the Dimension
1814                         // from the containing text instead of using Inset::dimension() which
1815                         // might not be implemented.
1816                         // FIXME (Abdel 23/09/2007): this is a bit messy because of the
1817                         // elimination of Inset::dim_ cache. This coordOffset() method needs
1818                         // to be rewritten in light of the new design.
1819                         Dimension const & dim = parMetrics(dit[i - 1].text(),
1820                                 dit[i - 1].pit()).insetDimension(&sl.inset());
1821                         lastw = dim.wid;
1822                 } else {
1823                         Dimension const dim = sl.inset().dimension(*this);
1824                         lastw = dim.wid;
1825                 }
1826
1827                 //lyxerr << "Cursor::getPos, i: "
1828                 // << i << " x: " << xx << " y: " << y << endl;
1829         }
1830
1831         // Add contribution of initial rows of outermost paragraph
1832         CursorSlice const & sl = dit[0];
1833         TextMetrics const & tm = textMetrics(sl.text());
1834         ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
1835         BOOST_ASSERT(!pm.rows().empty());
1836         y -= pm.rows()[0].ascent();
1837 #if 1
1838         // FIXME: document this mess
1839         size_t rend;
1840         if (sl.pos() > 0 && dit.depth() == 1) {
1841                 int pos = sl.pos();
1842                 if (pos && boundary)
1843                         --pos;
1844 //              lyxerr << "coordOffset: boundary:" << boundary << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
1845                 rend = pm.pos2row(pos);
1846         } else
1847                 rend = pm.pos2row(sl.pos());
1848 #else
1849         size_t rend = pm.pos2row(sl.pos());
1850 #endif
1851         for (size_t rit = 0; rit != rend; ++rit)
1852                 y += pm.rows()[rit].height();
1853         y += pm.rows()[rend].ascent();
1854
1855         TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
1856
1857         // Make relative position from the nested inset now bufferview absolute.
1858         int xx = bottom_tm.cursorX(dit.bottom(), boundary && dit.depth() == 1);
1859         x += xx;
1860
1861         // In the RTL case place the nested inset at the left of the cursor in
1862         // the outer paragraph
1863         bool boundary_1 = boundary && 1 == dit.depth();
1864         bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
1865         if (rtl)
1866                 x -= lastw;
1867
1868         return Point(x, y);
1869 }
1870
1871
1872 Point BufferView::getPos(DocIterator const & dit, bool boundary) const
1873 {
1874         CursorSlice const & bot = dit.bottom();
1875         TextMetrics const & tm = textMetrics(bot.text());
1876         if (!tm.has(bot.pit()))
1877                 return Point(-1, -1);
1878
1879         Point p = coordOffset(dit, boundary); // offset from outer paragraph
1880         p.y_ += tm.parMetrics(bot.pit()).position();
1881         return p;
1882 }
1883
1884
1885 void BufferView::draw(frontend::Painter & pain)
1886 {
1887         LYXERR(Debug::PAINTING, "\t\t*** START DRAWING ***");
1888         Text & text = buffer_.text();
1889         TextMetrics const & tm = d->text_metrics_[&text];
1890         int const y = tm.first().second->position();
1891         PainterInfo pi(this, pain);
1892
1893         switch (d->update_strategy_) {
1894
1895         case NoScreenUpdate:
1896                 // If no screen painting is actually needed, only some the different
1897                 // coordinates of insets and paragraphs needs to be updated.
1898                 pi.full_repaint = true;
1899                 pi.pain.setDrawingEnabled(false);
1900                 tm.draw(pi, 0, y);
1901                 break;
1902
1903         case SingleParUpdate:
1904                 pi.full_repaint = false;
1905                 // In general, only the current row of the outermost paragraph
1906                 // will be redrawn. Particular cases where selection spans
1907                 // multiple paragraph are correctly detected in TextMetrics.
1908                 tm.draw(pi, 0, y);
1909                 break;
1910
1911         case DecorationUpdate:
1912                 // FIXME: We should also distinguish DecorationUpdate to avoid text
1913                 // drawing if possible. This is not possible to do easily right now
1914                 // because of the single backing pixmap.
1915
1916         case FullScreenUpdate:
1917                 // The whole screen, including insets, will be refreshed.
1918                 pi.full_repaint = true;
1919
1920                 // Clear background.
1921                 pain.fillRectangle(0, 0, width_, height_,
1922                         buffer_.inset().backgroundColor());
1923
1924                 // Draw everything.
1925                 tm.draw(pi, 0, y);
1926
1927                 // and possibly grey out below
1928                 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
1929                 int const y2 = lastpm.second->position() + lastpm.second->descent();
1930                 if (y2 < height_)
1931                         pain.fillRectangle(0, y2, width_, height_ - y2, Color_bottomarea);
1932                 break;
1933         }
1934         LYXERR(Debug::PAINTING, "\n\t\t*** END DRAWING  ***");
1935
1936         // The scrollbar needs an update.
1937         updateScrollbar();
1938
1939         // Normalize anchor for next time
1940         pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
1941         pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
1942         for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
1943                 ParagraphMetrics const & pm = tm.parMetrics(pit);
1944                 if (pm.position() + pm.descent() > 0) {
1945                         d->anchor_pit_ = pit;
1946                         d->anchor_ypos_ = pm.position();
1947                         break;
1948                 }
1949         }
1950         LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
1951                 << "  anchor ypos = " << d->anchor_ypos_);
1952 }
1953
1954
1955 void BufferView::message(docstring const & msg)
1956 {
1957         if (d->gui_)
1958                 d->gui_->message(msg);
1959 }
1960
1961
1962 void BufferView::showDialog(string const & name)
1963 {
1964         if (d->gui_)
1965                 d->gui_->showDialog(name, string());
1966 }
1967
1968
1969 void BufferView::showDialog(string const & name,
1970         string const & data, Inset * inset)
1971 {
1972         if (d->gui_)
1973                 d->gui_->showDialog(name, data, inset);
1974 }
1975
1976
1977 void BufferView::updateDialog(string const & name, string const & data)
1978 {
1979         if (d->gui_)
1980                 d->gui_->updateDialog(name, data);
1981 }
1982
1983
1984 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
1985 {
1986         d->gui_ = gui;
1987 }
1988
1989
1990 // FIXME: Move this out of BufferView again
1991 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
1992 {
1993         if (!fname.isReadableFile()) {
1994                 docstring const error = from_ascii(strerror(errno));
1995                 docstring const file = makeDisplayPath(fname.absFilename(), 50);
1996                 docstring const text =
1997                   bformat(_("Could not read the specified document\n"
1998                             "%1$s\ndue to the error: %2$s"), file, error);
1999                 Alert::error(_("Could not read file"), text);
2000                 return docstring();
2001         }
2002
2003         if (!fname.isReadableFile()) {
2004                 docstring const file = makeDisplayPath(fname.absFilename(), 50);
2005                 docstring const text =
2006                   bformat(_("%1$s\n is not readable."), file);
2007                 Alert::error(_("Could not open file"), text);
2008                 return docstring();
2009         }
2010
2011         // FIXME UNICODE: We don't know the encoding of the file
2012         docstring file_content = fname.fileContents("UTF-8");
2013         if (file_content.empty()) {
2014                 Alert::error(_("Reading not UTF-8 encoded file"),
2015                              _("The file is not UTF-8 encoded.\n"
2016                                "It will be read as local 8Bit-encoded.\n"
2017                                "If this does not give the correct result\n"
2018                                "then please change the encoding of the file\n"
2019                                "to UTF-8 with a program other than LyX.\n"));
2020                 file_content = fname.fileContents("local8bit");
2021         }
2022
2023         return normalize_c(file_content);
2024 }
2025
2026
2027 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
2028 {
2029         docstring const tmpstr = contentsOfPlaintextFile(f);
2030
2031         if (tmpstr.empty())
2032                 return;
2033
2034         Cursor & cur = cursor();
2035         cap::replaceSelection(cur);
2036         buffer_.undo().recordUndo(cur);
2037         if (asParagraph)
2038                 cur.innerText()->insertStringAsParagraphs(cur, tmpstr);
2039         else
2040                 cur.innerText()->insertStringAsLines(cur, tmpstr);
2041
2042         updateMetrics();
2043         buffer_.changed();
2044 }
2045
2046 } // namespace lyx