src/BufferView.cpp

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