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