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