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