src/BufferView.cpp

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