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                 thePreviews()->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                 updateMetrics();
 552                 buffer_.changed();
 553                 return;
 554         }
 555
 556         // cut off at the top
 557         if (value <= d->scrollbarParameters_.min) {
 558                 DocIterator dit = doc_iterator_begin(buffer_.inset());
 559                 showCursor(dit);
 560                 LYXERR(Debug::SCROLLING, "scroll to top");
 561                 return;
 562         }
 563
 564         // cut off at the bottom
 565         if (value >= d->scrollbarParameters_.max) {
 566                 DocIterator dit = doc_iterator_end(buffer_.inset());
 567                 dit.backwardPos();
 568                 showCursor(dit);
 569                 LYXERR(Debug::SCROLLING, "scroll to bottom");
 570                 return;
 571         }
 572
 573         // find paragraph at target position
 574         int par_pos = d->scrollbarParameters_.min;
 575         pit_type i = 0;
 576         for (; i != int(d->par_height_.size()); ++i) {
 577                 par_pos += d->par_height_[i];
 578                 if (par_pos >= value)
 579                         break;
 580         }
 581
 582         if (par_pos < value) {
 583                 // It seems we didn't find the correct pit so stay on the safe side and
 584                 // scroll to bottom.
 585                 LYXERR0("scrolling position not found!");
 586                 scrollDocView(d->scrollbarParameters_.max);
 587                 return;
 588         }
 589
 590         DocIterator dit = doc_iterator_begin(buffer_.inset());
 591         dit.pit() = i;
 592         LYXERR(Debug::SCROLLING, "value = " << value << " -> scroll to pit " << i);
 593         showCursor(dit);
 594 }
 595
 596
 597 // FIXME: this method is not working well.
 598 void BufferView::setCursorFromScrollbar()
 599 {
 600         TextMetrics & tm = d->text_metrics_[&buffer_.text()];
 601
 602         int const height = 2 * defaultRowHeight();
 603         int const first = height;
 604         int const last = height_ - height;
 605         Cursor & cur = d->cursor_;
 606
 607         switch (cursorStatus(cur)) {
 608         case CUR_ABOVE:
 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, first);
 613                 cur.clearSelection();
 614                 break;
 615         case CUR_BELOW:
 616                 // We reset the cursor because cursorStatus() does not
 617                 // work when the cursor is within mathed.
 618                 cur.reset(buffer_.inset());
 619                 tm.setCursorFromCoordinates(cur, 0, last);
 620                 cur.clearSelection();
 621                 break;
 622         case CUR_INSIDE:
 623                 int const y = getPos(cur, cur.boundary()).y_;
 624                 int const newy = min(last, max(y, first));
 625                 if (y != newy) {
 626                         cur.reset(buffer_.inset());
 627                         tm.setCursorFromCoordinates(cur, 0, newy);
 628                 }
 629         }
 630 }
 631
 632
 633 Change const BufferView::getCurrentChange() const
 634 {
 635         if (!d->cursor_.selection())
 636                 return Change(Change::UNCHANGED);
 637
 638         DocIterator dit = d->cursor_.selectionBegin();
 639         return dit.paragraph().lookupChange(dit.pos());
 640 }
 641
 642
 643 // this could be used elsewhere as well?
 644 // FIXME: This does not work within mathed!
 645 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
 646 {
 647         Point const p = getPos(dit, dit.boundary());
 648         if (p.y_ < 0)
 649                 return CUR_ABOVE;
 650         if (p.y_ > workHeight())
 651                 return CUR_BELOW;
 652         return CUR_INSIDE;
 653 }
 654
 655
 656 void BufferView::saveBookmark(unsigned int idx)
 657 {
 658         // tenatively save bookmark, id and pos will be used to
 659         // acturately locate a bookmark in a 'live' lyx session.
 660         // pit and pos will be updated with bottom level pit/pos
 661         // when lyx exits.
 662         LyX::ref().session().bookmarks().save(
 663                 buffer_.fileName(),
 664                 d->cursor_.bottom().pit(),
 665                 d->cursor_.bottom().pos(),
 666                 d->cursor_.paragraph().id(),
 667                 d->cursor_.pos(),
 668                 idx
 669         );
 670         if (idx)
 671                 // emit message signal.
 672                 message(_("Save bookmark"));
 673 }
 674
 675
 676 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
 677         int top_id, pos_type top_pos)
 678 {
 679         bool success = false;
 680         DocIterator dit;
 681
 682         d->cursor_.clearSelection();
 683
 684         // if a valid par_id is given, try it first
 685         // This is the case for a 'live' bookmark when unique paragraph ID
 686         // is used to track bookmarks.
 687         if (top_id > 0) {
 688                 dit = buffer_.getParFromID(top_id);
 689                 if (!dit.atEnd()) {
 690                         dit.pos() = min(dit.paragraph().size(), top_pos);
 691                         // Some slices of the iterator may not be
 692                         // reachable (e.g. closed collapsable inset)
 693                         // so the dociterator may need to be
 694                         // shortened. Otherwise, setCursor may crash
 695                         // lyx when the cursor can not be set to these
 696                         // insets.
 697                         size_t const n = dit.depth();
 698                         for (size_t i = 0; i < n; ++i)
 699                                 if (dit[i].inset().editable() != Inset::HIGHLY_EDITABLE) {
 700                                         dit.resize(i);
 701                                         break;
 702                                 }
 703                         success = true;
 704                 }
 705         }
 706
 707         // if top_id == 0, or searching through top_id failed
 708         // This is the case for a 'restored' bookmark when only bottom
 709         // (document level) pit was saved. Because of this, bookmark
 710         // restoration is inaccurate. If a bookmark was within an inset,
 711         // it will be restored to the left of the outmost inset that contains
 712         // the bookmark.
 713         if (bottom_pit < int(buffer_.paragraphs().size())) {
 714                 dit = doc_iterator_begin(buffer_.inset());
 715
 716                 dit.pit() = bottom_pit;
 717                 dit.pos() = min(bottom_pos, dit.paragraph().size());
 718                 success = true;
 719         }
 720
 721         if (success) {
 722                 // Note: only bottom (document) level pit is set.
 723                 setCursor(dit);
 724                 // set the current font.
 725                 d->cursor_.setCurrentFont();
 726                 // To center the screen on this new position we need the
 727                 // paragraph position which is computed at draw() time.
 728                 // So we need a redraw!
 729                 buffer_.changed();
 730                 if (fitCursor())
 731                         showCursor();
 732         }
 733
 734         return success;
 735 }
 736
 737
 738 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
 739 {
 740         if (lyxrc.rtl_support) {
 741                 if (d->cursor_.real_current_font.isRightToLeft()) {
 742                         if (d->intl_.keymap == Intl::PRIMARY)
 743                                 d->intl_.keyMapSec();
 744                 } else {
 745                         if (d->intl_.keymap == Intl::SECONDARY)
 746                                 d->intl_.keyMapPrim();
 747                 }
 748         }
 749
 750         d->intl_.getTransManager().translateAndInsert(c, t, cur);
 751 }
 752
 753
 754 int BufferView::workWidth() const
 755 {
 756         return width_;
 757 }
 758
 759
 760 void BufferView::showCursor()
 761 {
 762         showCursor(d->cursor_);
 763 }
 764
 765
 766 void BufferView::showCursor(DocIterator const & dit)
 767 {
 768         // We are not properly started yet, delay until resizing is
 769         // done.
 770         if (height_ == 0)
 771                 return;
 772
 773         LYXERR(Debug::SCROLLING, "recentering!");
 774
 775         CursorSlice const & bot = dit.bottom();
 776         TextMetrics & tm = d->text_metrics_[bot.text()];
 777
 778         pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
 779         int bot_pit = bot.pit();
 780         if (bot_pit > max_pit) {
 781                 // FIXME: Why does this happen?
 782                 LYXERR0("bottom pit is greater that max pit: "
 783                         << bot_pit << " > " << max_pit);
 784                 bot_pit = max_pit;
 785         }
 786
 787         if (bot_pit == tm.first().first - 1)
 788                 tm.newParMetricsUp();
 789         else if (bot_pit == tm.last().first + 1)
 790                 tm.newParMetricsDown();
 791
 792         if (tm.contains(bot_pit)) {
 793                 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
 794                 LASSERT(!pm.rows().empty(), /**/);
 795                 // FIXME: smooth scrolling doesn't work in mathed.
 796                 CursorSlice const & cs = dit.innerTextSlice();
 797                 int offset = coordOffset(dit, dit.boundary()).y_;
 798                 int ypos = pm.position() + offset;
 799                 Dimension const & row_dim =
 800                         pm.getRow(cs.pos(), dit.boundary()).dimension();
 801                 int scrolled = 0;
 802                 if (ypos - row_dim.ascent() < 0)
 803                         scrolled = scrollUp(- ypos + row_dim.ascent());
 804                 else if (ypos + row_dim.descent() > height_)
 805                         scrolled = scrollDown(ypos - height_ + row_dim.descent());
 806                 // else, nothing to do, the cursor is already visible so we just return.
 807                 if (scrolled != 0) {
 808                         updateMetrics();
 809                         buffer_.changed();
 810                 }
 811                 return;
 812         }
 813
 814         // fix inline completion position
 815         if (d->inlineCompletionPos_.fixIfBroken())
 816                 d->inlineCompletionPos_ = DocIterator();
 817
 818         tm.redoParagraph(bot_pit);
 819         ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
 820         int offset = coordOffset(dit, dit.boundary()).y_;
 821
 822         d->anchor_pit_ = bot_pit;
 823         CursorSlice const & cs = dit.innerTextSlice();
 824         Dimension const & row_dim =
 825                 pm.getRow(cs.pos(), dit.boundary()).dimension();
 826
 827         if (d->anchor_pit_ == 0)
 828                 d->anchor_ypos_ = offset + pm.ascent();
 829         else if (d->anchor_pit_ == max_pit)
 830                 d->anchor_ypos_ = height_ - offset - row_dim.descent();
 831         else
 832                 d->anchor_ypos_ = defaultRowHeight() * 2 - offset - row_dim.descent();
 833
 834         updateMetrics();
 835         buffer_.changed();
 836 }
 837
 838
 839 FuncStatus BufferView::getStatus(FuncRequest const & cmd)
 840 {
 841         FuncStatus flag;
 842
 843         Cursor & cur = d->cursor_;
 844
 845         switch (cmd.action) {
 846
 847         case LFUN_UNDO:
 848                 flag.setEnabled(buffer_.undo().hasUndoStack());
 849                 break;
 850         case LFUN_REDO:
 851                 flag.setEnabled(buffer_.undo().hasRedoStack());
 852                 break;
 853         case LFUN_FILE_INSERT:
 854         case LFUN_FILE_INSERT_PLAINTEXT_PARA:
 855         case LFUN_FILE_INSERT_PLAINTEXT:
 856         case LFUN_BOOKMARK_SAVE:
 857                 // FIXME: Actually, these LFUNS should be moved to Text
 858                 flag.setEnabled(cur.inTexted());
 859                 break;
 860         case LFUN_FONT_STATE:
 861         case LFUN_LABEL_INSERT:
 862         case LFUN_INFO_INSERT:
 863         case LFUN_INSET_EDIT:
 864         case LFUN_PARAGRAPH_GOTO:
 865         case LFUN_NOTE_NEXT:
 866         case LFUN_REFERENCE_NEXT:
 867         case LFUN_WORD_FIND:
 868         case LFUN_WORD_REPLACE:
 869         case LFUN_MARK_OFF:
 870         case LFUN_MARK_ON:
 871         case LFUN_MARK_TOGGLE:
 872         case LFUN_SCREEN_RECENTER:
 873         case LFUN_BIBTEX_DATABASE_ADD:
 874         case LFUN_BIBTEX_DATABASE_DEL:
 875         case LFUN_GRAPHICS_GROUPS_UNIFY:
 876         case LFUN_NOTES_MUTATE:
 877         case LFUN_ALL_INSETS_TOGGLE:
 878         case LFUN_STATISTICS:
 879                 flag.setEnabled(true);
 880                 break;
 881
 882         case LFUN_NEXT_INSET_TOGGLE:
 883         case LFUN_NEXT_INSET_MODIFY: {
 884                 // this is the real function we want to invoke
 885                 FuncRequest tmpcmd = cmd;
 886                 tmpcmd.action = (cmd.action == LFUN_NEXT_INSET_TOGGLE)
 887                         ? LFUN_INSET_TOGGLE : LFUN_INSET_MODIFY;
 888                 // if there is an inset at cursor, see whether it
 889                 // handles the lfun, other start from scratch
 890                 Inset * inset = cur.nextInset();
 891                 if (!inset || !inset->getStatus(cur, tmpcmd, flag))
 892                         flag = lyx::getStatus(tmpcmd);
 893                 break;
 894         }
 895
 896         case LFUN_LABEL_GOTO: {
 897                 flag.setEnabled(!cmd.argument().empty()
 898                     || getInsetByCode<InsetRef>(cur, REF_CODE));
 899                 break;
 900         }
 901
 902         case LFUN_CHANGES_TRACK:
 903                 flag.setEnabled(true);
 904                 flag.setOnOff(buffer_.params().trackChanges);
 905                 break;
 906
 907         case LFUN_CHANGES_OUTPUT:
 908                 flag.setEnabled(true);
 909                 flag.setOnOff(buffer_.params().outputChanges);
 910                 break;
 911
 912         case LFUN_CHANGES_MERGE:
 913         case LFUN_CHANGE_NEXT:
 914         case LFUN_ALL_CHANGES_ACCEPT:
 915         case LFUN_ALL_CHANGES_REJECT:
 916                 // TODO: context-sensitive enabling of LFUNs
 917                 // In principle, these command should only be enabled if there
 918                 // is a change in the document. However, without proper
 919                 // optimizations, this will inevitably result in poor performance.
 920                 flag.setEnabled(true);
 921                 break;
 922
 923         case LFUN_BUFFER_TOGGLE_COMPRESSION: {
 924                 flag.setOnOff(buffer_.params().compressed);
 925                 break;
 926         }
 927
 928         case LFUN_SCREEN_UP:
 929         case LFUN_SCREEN_DOWN:
 930         case LFUN_SCROLL:
 931         case LFUN_SCREEN_UP_SELECT:
 932         case LFUN_SCREEN_DOWN_SELECT:
 933                 flag.setEnabled(true);
 934                 break;
 935
 936         case LFUN_LAYOUT_TABULAR:
 937                 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
 938                 break;
 939
 940         case LFUN_LAYOUT:
 941                 flag.setEnabled(!cur.inset().forcePlainLayout(cur.idx()));
 942                 break;
 943
 944         case LFUN_LAYOUT_PARAGRAPH:
 945                 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
 946                 break;
 947
 948         case LFUN_INSET_SETTINGS: {
 949                 InsetCode code = cur.inset().lyxCode();
 950                 if (cmd.getArg(0) == insetName(code)) {
 951                         flag.setEnabled(true);
 952                         break;
 953                 }
 954                 bool enable = false;
 955                 InsetCode next_code = cur.nextInset()
 956                         ? cur.nextInset()->lyxCode() : NO_CODE;
 957                 //FIXME: remove these special cases:
 958                 switch (next_code) {
 959                         case TABULAR_CODE:
 960                         case ERT_CODE:
 961                         case FLOAT_CODE:
 962                         case WRAP_CODE:
 963                         case NOTE_CODE:
 964                         case BRANCH_CODE:
 965                         case BOX_CODE:
 966                         case LISTINGS_CODE:
 967                                 enable = (cmd.argument().empty() ||
 968                                           cmd.getArg(0) == insetName(next_code));
 969                                 break;
 970                         default:
 971                                 break;
 972                 }
 973                 flag.setEnabled(enable);
 974                 break;
 975         }
 976
 977         case LFUN_DIALOG_SHOW_NEW_INSET:
 978                 flag.setEnabled(cur.inset().lyxCode() != ERT_CODE &&
 979                         cur.inset().lyxCode() != LISTINGS_CODE);
 980                 if (cur.inset().lyxCode() == CAPTION_CODE) {
 981                         FuncStatus flag;
 982                         if (cur.inset().getStatus(cur, cmd, flag))
 983                                 return flag;
 984                 }
 985                 break;
 986
 987         case LFUN_BRANCH_ACTIVATE:
 988         case LFUN_BRANCH_DEACTIVATE: {
 989                 bool enable = false;
 990                 docstring const branchName = cmd.argument();
 991                 if (!branchName.empty())
 992                         enable = buffer_.params().branchlist().find(branchName);
 993                 flag.setEnabled(enable);
 994                 break;
 995         }
 996
 997         default:
 998                 flag.setEnabled(false);
 999         }
1000
1001         return flag;
1002 }
1003
1004
1005 bool BufferView::dispatch(FuncRequest const & cmd)
1006 {
1007         //lyxerr << [ cmd = " << cmd << "]" << endl;
1008
1009         // Make sure that the cached BufferView is correct.
1010         LYXERR(Debug::ACTION, " action[" << cmd.action << ']'
1011                 << " arg[" << to_utf8(cmd.argument()) << ']'
1012                 << " x[" << cmd.x << ']'
1013                 << " y[" << cmd.y << ']'
1014                 << " button[" << cmd.button() << ']');
1015
1016         Cursor & cur = d->cursor_;
1017
1018         switch (cmd.action) {
1019
1020         case LFUN_UNDO:
1021                 cur.message(_("Undo"));
1022                 cur.clearSelection();
1023                 if (!cur.textUndo())
1024                         cur.message(_("No further undo information"));
1025                 else
1026                         processUpdateFlags(Update::Force | Update::FitCursor);
1027                 break;
1028
1029         case LFUN_REDO:
1030                 cur.message(_("Redo"));
1031                 cur.clearSelection();
1032                 if (!cur.textRedo())
1033                         cur.message(_("No further redo information"));
1034                 else
1035                         processUpdateFlags(Update::Force | Update::FitCursor);
1036                 break;
1037
1038         case LFUN_FONT_STATE:
1039                 cur.message(cur.currentState());
1040                 break;
1041
1042         case LFUN_BOOKMARK_SAVE:
1043                 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1044                 break;
1045
1046         case LFUN_LABEL_GOTO: {
1047                 docstring label = cmd.argument();
1048                 if (label.empty()) {
1049                         InsetRef * inset =
1050                                 getInsetByCode<InsetRef>(d->cursor_,
1051                                                          REF_CODE);
1052                         if (inset) {
1053                                 label = inset->getParam("reference");
1054                                 // persistent=false: use temp_bookmark
1055                                 saveBookmark(0);
1056                         }
1057                 }
1058
1059                 if (!label.empty())
1060                         gotoLabel(label);
1061                 break;
1062         }
1063
1064         case LFUN_INSET_EDIT: {
1065                 FuncRequest fr(cmd);
1066                 // if there is an inset at cursor, see whether it
1067                 // can be modified.
1068                 Inset * inset = cur.nextInset();
1069                 if (inset)
1070                         inset->dispatch(cur, fr);
1071                 // if it did not work, try the underlying inset.
1072                 if (!inset || !cur.result().dispatched())
1073                         cur.dispatch(cmd);
1074
1075                 if (!cur.result().dispatched())
1076                         // It did not work too; no action needed.
1077                         break;
1078         }
1079
1080         case LFUN_PARAGRAPH_GOTO: {
1081                 int const id = convert<int>(cmd.getArg(0));
1082                 int const pos = convert<int>(cmd.getArg(1));
1083                 int i = 0;
1084                 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1085                         b = theBufferList().next(b)) {
1086
1087                         DocIterator dit = b->getParFromID(id);
1088                         if (dit.atEnd()) {
1089                                 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1090                                 ++i;
1091                                 continue;
1092                         }
1093                         LYXERR(Debug::INFO, "Paragraph " << dit.paragraph().id()
1094                                 << " found in buffer `"
1095                                 << b->absFileName() << "'.");
1096
1097                         if (b == &buffer_) {
1098                                 // Set the cursor
1099                                 dit.pos() = pos;
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                 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1169                 processUpdateFlags(Update::Force | Update::FitCursor);
1170                 break;
1171
1172         case LFUN_ALL_CHANGES_REJECT:
1173                 // select complete document
1174                 d->cursor_.reset(buffer_.inset());
1175                 d->cursor_.selHandle(true);
1176                 buffer_.text().cursorBottom(d->cursor_);
1177                 // reject everything in a single step to support atomic undo
1178                 // Note: reject does not work recursively; the user may have to repeat the operation
1179                 buffer_.text().acceptOrRejectChanges(d->cursor_, Text::REJECT);
1180                 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1181                 processUpdateFlags(Update::Force | Update::FitCursor);
1182                 break;
1183
1184         case LFUN_WORD_FIND: {
1185                 FuncRequest req = cmd;
1186                 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1187                         req = d->search_request_cache_;
1188                 if (find(this, req))
1189                         showCursor();
1190                 else
1191                         message(_("String not found!"));
1192                 d->search_request_cache_ = req;
1193                 break;
1194         }
1195
1196         case LFUN_WORD_REPLACE: {
1197                 bool has_deleted = false;
1198                 if (cur.selection()) {
1199                         DocIterator beg = cur.selectionBegin();
1200                         DocIterator end = cur.selectionEnd();
1201                         if (beg.pit() == end.pit()) {
1202                                 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1203                                         if (cur.paragraph().isDeleted(p))
1204                                                 has_deleted = true;
1205                                 }
1206                         }
1207                 }
1208                 replace(this, cmd, has_deleted);
1209                 break;
1210         }
1211
1212         case LFUN_MARK_OFF:
1213                 cur.clearSelection();
1214                 cur.resetAnchor();
1215                 cur.message(from_utf8(N_("Mark off")));
1216                 break;
1217
1218         case LFUN_MARK_ON:
1219                 cur.clearSelection();
1220                 cur.mark() = true;
1221                 cur.resetAnchor();
1222                 cur.message(from_utf8(N_("Mark on")));
1223                 break;
1224
1225         case LFUN_MARK_TOGGLE:
1226                 cur.clearSelection();
1227                 if (cur.mark()) {
1228                         cur.mark() = false;
1229                         cur.message(from_utf8(N_("Mark removed")));
1230                 } else {
1231                         cur.mark() = true;
1232                         cur.message(from_utf8(N_("Mark set")));
1233                 }
1234                 cur.resetAnchor();
1235                 break;
1236
1237         case LFUN_SCREEN_RECENTER:
1238                 showCursor();
1239                 break;
1240
1241         case LFUN_BIBTEX_DATABASE_ADD: {
1242                 Cursor tmpcur = d->cursor_;
1243                 findInset(tmpcur, BIBTEX_CODE, false);
1244                 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1245                                                 BIBTEX_CODE);
1246                 if (inset) {
1247                         if (inset->addDatabase(cmd.argument()))
1248                                 buffer_.updateBibfilesCache();
1249                 }
1250                 break;
1251         }
1252
1253         case LFUN_BIBTEX_DATABASE_DEL: {
1254                 Cursor tmpcur = d->cursor_;
1255                 findInset(tmpcur, BIBTEX_CODE, false);
1256                 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1257                                                 BIBTEX_CODE);
1258                 if (inset) {
1259                         if (inset->delDatabase(cmd.argument()))
1260                                 buffer_.updateBibfilesCache();
1261                 }
1262                 break;
1263         }
1264
1265         case LFUN_STATISTICS: {
1266                 DocIterator from, to;
1267                 if (cur.selection()) {
1268                         from = cur.selectionBegin();
1269                         to = cur.selectionEnd();
1270                 } else {
1271                         from = doc_iterator_begin(buffer_.inset());
1272                         to = doc_iterator_end(buffer_.inset());
1273                 }
1274                 int const words = countWords(from, to);
1275                 int const chars = countChars(from, to, false);
1276                 int const chars_blanks = countChars(from, to, true);
1277                 docstring message;
1278                 if (cur.selection())
1279                         message = _("Statistics for the selection:");
1280                 else
1281                         message = _("Statistics for the document:");
1282                 message += "\n\n";
1283                 if (words != 1)
1284                         message += bformat(_("%1$d words"), words);
1285                 else
1286                         message += _("One word");
1287                 message += "\n";
1288                 if (chars_blanks != 1)
1289                         message += bformat(_("%1$d characters (including blanks)"),
1290                                           chars_blanks);
1291                 else
1292                         message += _("One character (including blanks)");
1293                 message += "\n";
1294                 if (chars != 1)
1295                         message += bformat(_("%1$d characters (excluding blanks)"),
1296                                           chars);
1297                 else
1298                         message += _("One character (excluding blanks)");
1299
1300                 Alert::information(_("Statistics"), message);
1301         }
1302                 break;
1303
1304         case LFUN_BUFFER_TOGGLE_COMPRESSION:
1305                 // turn compression on/off
1306                 buffer_.params().compressed = !buffer_.params().compressed;
1307                 break;
1308
1309         case LFUN_NEXT_INSET_TOGGLE: {
1310                 // create the the real function we want to invoke
1311                 FuncRequest tmpcmd = cmd;
1312                 tmpcmd.action = LFUN_INSET_TOGGLE;
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                         } else
1324                                 inset->dispatch(cur, tmpcmd);
1325                 }
1326                 // if it did not work, try the underlying inset.
1327                 if (!inset || !cur.result().dispatched())
1328                         cur.dispatch(tmpcmd);
1329
1330                 if (!cur.result().dispatched())
1331                         // It did not work too; no action needed.
1332                         break;
1333                 cur.clearSelection();
1334                 processUpdateFlags(Update::SinglePar | Update::FitCursor);
1335                 break;
1336         }
1337
1338         case LFUN_NEXT_INSET_MODIFY: {
1339                 // create the the real function we want to invoke
1340                 FuncRequest tmpcmd = cmd;
1341                 tmpcmd.action = LFUN_INSET_MODIFY;
1342                 // if there is an inset at cursor, see whether it
1343                 // can be modified.
1344                 Inset * inset = cur.nextInset();
1345                 if (inset)
1346                         inset->dispatch(cur, tmpcmd);
1347                 // if it did not work, try the underlying inset.
1348                 if (!inset || !cur.result().dispatched())
1349                         cur.dispatch(tmpcmd);
1350
1351                 if (!cur.result().dispatched())
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                 int const scrolled = scroll(cmd.action == LFUN_SCREEN_UP
1368                         ? - height_ : height_);
1369                 if (cmd.action == LFUN_SCREEN_UP && scrolled > - height_)
1370                         p = Point(0, 0);
1371                 if (cmd.action == LFUN_SCREEN_DOWN && scrolled < height_)
1372                         p = Point(width_, height_);
1373                 cur.reset(buffer_.inset());
1374                 updateMetrics();
1375                 buffer_.changed();
1376                 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_);
1377                 //FIXME: what to do with cur.x_target()?
1378                 cur.finishUndo();
1379                 break;
1380         }
1381
1382         case LFUN_SCROLL:
1383                 lfunScroll(cmd);
1384                 break;
1385
1386         case LFUN_SCREEN_UP_SELECT: {
1387                 cur.selHandle(true);
1388                 if (isTopScreen()) {
1389                         lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1390                         cur.finishUndo();
1391                         break;
1392                 }
1393                 int y = getPos(cur, cur.boundary()).y_;
1394                 int const ymin = y - height_ + defaultRowHeight();
1395                 while (y > ymin && cur.up())
1396                         y = getPos(cur, cur.boundary()).y_;
1397
1398                 cur.finishUndo();
1399                 processUpdateFlags(Update::SinglePar | Update::FitCursor);
1400                 break;
1401         }
1402
1403         case LFUN_SCREEN_DOWN_SELECT: {
1404                 cur.selHandle(true);
1405                 if (isBottomScreen()) {
1406                         lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1407                         cur.finishUndo();
1408                         break;
1409                 }
1410                 int y = getPos(cur, cur.boundary()).y_;
1411                 int const ymax = y + height_ - defaultRowHeight();
1412                 while (y < ymax && cur.down())
1413                         y = getPos(cur, cur.boundary()).y_;
1414
1415                 cur.finishUndo();
1416                 processUpdateFlags(Update::SinglePar | Update::FitCursor);
1417                 break;
1418         }
1419
1420         case LFUN_BRANCH_ACTIVATE:
1421         case LFUN_BRANCH_DEACTIVATE:
1422                 buffer_.dispatch(cmd);
1423                 processUpdateFlags(Update::Force);
1424                 break;
1425
1426         // These two could be rewriten using some command like forall <insetname> <command>
1427         // once the insets refactoring is done.
1428         case LFUN_GRAPHICS_GROUPS_UNIFY: {
1429                 if (cmd.argument().empty())
1430                         break;
1431                 //view()->cursor().recordUndoFullDocument(); let inset-apply do that job
1432                 graphics::unifyGraphicsGroups(cur.buffer(), to_utf8(cmd.argument()));
1433                 processUpdateFlags(Update::Force | Update::FitCursor);
1434                 break;
1435         }
1436
1437         case LFUN_NOTES_MUTATE: {
1438                 if (cmd.argument().empty())
1439                         break;
1440                 cur.recordUndoFullDocument();
1441
1442                 if (mutateNotes(cur, cmd.getArg(0), cmd.getArg(1))) {
1443                         processUpdateFlags(Update::Force);
1444                 }
1445                 break;
1446         }
1447
1448         case LFUN_ALL_INSETS_TOGGLE: {
1449                 string action;
1450                 string const name = split(to_utf8(cmd.argument()), action, ' ');
1451                 InsetCode const inset_code = insetCode(name);
1452
1453                 FuncRequest fr(LFUN_INSET_TOGGLE, action);
1454
1455                 Inset & inset = cur.buffer().inset();
1456                 InsetIterator it  = inset_iterator_begin(inset);
1457                 InsetIterator const end = inset_iterator_end(inset);
1458                 for (; it != end; ++it) {
1459                         if (!it->asInsetMath()
1460                             && (inset_code == NO_CODE
1461                             || inset_code == it->lyxCode())) {
1462                                 Cursor tmpcur = cur;
1463                                 tmpcur.pushBackward(*it);
1464                                 FuncStatus flag;
1465                                 it->getStatus(tmpcur, fr, flag);
1466                                 if (flag.enabled())
1467                                         it->dispatch(tmpcur, fr);
1468                         }
1469                 }
1470                 processUpdateFlags(Update::Force | Update::FitCursor);
1471                 break;
1472         }
1473
1474         default:
1475                 return false;
1476         }
1477
1478         return true;
1479 }
1480
1481
1482 docstring const BufferView::requestSelection()
1483 {
1484         Cursor & cur = d->cursor_;
1485
1486         if (!cur.selection()) {
1487                 d->xsel_cache_.set = false;
1488                 return docstring();
1489         }
1490
1491         if (!d->xsel_cache_.set ||
1492             cur.top() != d->xsel_cache_.cursor ||
1493             cur.anchor_.top() != d->xsel_cache_.anchor)
1494         {
1495                 d->xsel_cache_.cursor = cur.top();
1496                 d->xsel_cache_.anchor = cur.anchor_.top();
1497                 d->xsel_cache_.set = cur.selection();
1498                 return cur.selectionAsString(false);
1499         }
1500         return docstring();
1501 }
1502
1503
1504 void BufferView::clearSelection()
1505 {
1506         d->cursor_.clearSelection();
1507         // Clear the selection buffer. Otherwise a subsequent
1508         // middle-mouse-button paste would use the selection buffer,
1509         // not the more current external selection.
1510         cap::clearSelection();
1511         d->xsel_cache_.set = false;
1512         // The buffer did not really change, but this causes the
1513         // redraw we need because we cleared the selection above.
1514         buffer_.changed();
1515 }
1516
1517
1518 void BufferView::resize(int width, int height)
1519 {
1520         // Update from work area
1521         width_ = width;
1522         height_ = height;
1523
1524         // Clear the paragraph height cache.
1525         d->par_height_.clear();
1526         // Redo the metrics.
1527         updateMetrics();
1528 }
1529
1530
1531 Inset const * BufferView::getCoveringInset(Text const & text,
1532                 int x, int y) const
1533 {
1534         TextMetrics & tm = d->text_metrics_[&text];
1535         Inset * inset = tm.checkInsetHit(x, y);
1536         if (!inset)
1537                 return 0;
1538
1539         if (!inset->descendable())
1540                 // No need to go further down if the inset is not
1541                 // descendable.
1542                 return inset;
1543
1544         size_t cell_number = inset->nargs();
1545         // Check all the inner cell.
1546         for (size_t i = 0; i != cell_number; ++i) {
1547                 Text const * inner_text = inset->getText(i);
1548                 if (inner_text) {
1549                         // Try deeper.
1550                         Inset const * inset_deeper =
1551                                 getCoveringInset(*inner_text, x, y);
1552                         if (inset_deeper)
1553                                 return inset_deeper;
1554                 }
1555         }
1556
1557         return inset;
1558 }
1559
1560
1561 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
1562 {
1563         //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
1564
1565         // This is only called for mouse related events including
1566         // LFUN_FILE_OPEN generated by drag-and-drop.
1567         FuncRequest cmd = cmd0;
1568
1569         Cursor old = cursor();
1570         Cursor cur(*this);
1571         cur.push(buffer_.inset());
1572         cur.selection() = d->cursor_.selection();
1573
1574         // Either the inset under the cursor or the
1575         // surrounding Text will handle this event.
1576
1577         // make sure we stay within the screen...
1578         cmd.y = min(max(cmd.y, -1), height_);
1579
1580         if (cmd.action == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
1581
1582                 // Get inset under mouse, if there is one.
1583                 Inset const * covering_inset =
1584                         getCoveringInset(buffer_.text(), cmd.x, cmd.y);
1585                 if (covering_inset == d->last_inset_)
1586                         // Same inset, no need to do anything...
1587                         return;
1588
1589                 bool need_redraw = false;
1590                 // const_cast because of setMouseHover().
1591                 Inset * inset = const_cast<Inset *>(covering_inset);
1592                 if (d->last_inset_)
1593                         // Remove the hint on the last hovered inset (if any).
1594                         need_redraw |= d->last_inset_->setMouseHover(false);
1595                 if (inset)
1596                         // Highlighted the newly hovered inset (if any).
1597                         need_redraw |= inset->setMouseHover(true);
1598                 d->last_inset_ = inset;
1599                 if (!need_redraw)
1600                         return;
1601
1602                 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
1603                         << cmd.x << ", " << cmd.y << ")");
1604
1605                 d->update_strategy_ = DecorationUpdate;
1606
1607                 // This event (moving without mouse click) is not passed further.
1608                 // This should be changed if it is further utilized.
1609                 buffer_.changed();
1610                 return;
1611         }
1612
1613         // Build temporary cursor.
1614         Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x, cmd.y);
1615
1616         // Put anchor at the same position.
1617         cur.resetAnchor();
1618
1619         // Try to dispatch to an non-editable inset near this position
1620         // via the temp cursor. If the inset wishes to change the real
1621         // cursor it has to do so explicitly by using
1622         //  cur.bv().cursor() = cur;  (or similar)
1623         if (inset)
1624                 inset->dispatch(cur, cmd);
1625
1626         // Now dispatch to the temporary cursor. If the real cursor should
1627         // be modified, the inset's dispatch has to do so explicitly.
1628         if (!inset || !cur.result().dispatched())
1629                 cur.dispatch(cmd);
1630
1631         // Notify left insets
1632         if (cur != old) {
1633                 old.fixIfBroken();
1634                 bool badcursor = notifyCursorLeaves(old, cur);
1635                 if (badcursor)
1636                         cursor().fixIfBroken();
1637         }
1638
1639         // Do we have a selection?
1640         theSelection().haveSelection(cursor().selection());
1641
1642         // If the command has been dispatched,
1643         if (cur.result().dispatched() || cur.result().update())
1644                 processUpdateFlags(cur.result().update());
1645 }
1646
1647
1648 void BufferView::lfunScroll(FuncRequest const & cmd)
1649 {
1650         string const scroll_type = cmd.getArg(0);
1651         int const scroll_step =
1652                 (scroll_type == "line") ? d->scrollbarParameters_.single_step
1653                 : (scroll_type == "page") ? d->scrollbarParameters_.page_step : 0;
1654         if (scroll_step == 0)
1655                 return;
1656         string const scroll_quantity = cmd.getArg(1);
1657         if (scroll_quantity == "up")
1658                 scrollUp(scroll_step);
1659         else if (scroll_quantity == "down")
1660                 scrollDown(scroll_step);
1661         else {
1662                 int const scroll_value = convert<int>(scroll_quantity);
1663                 if (scroll_value)
1664                         scroll(scroll_step * scroll_value);
1665         }
1666         updateMetrics();
1667         buffer_.changed();
1668 }
1669
1670
1671 int BufferView::scroll(int y)
1672 {
1673         if (y > 0)
1674                 return scrollDown(y);
1675         if (y < 0)
1676                 return scrollUp(-y);
1677         return 0;
1678 }
1679
1680
1681 int BufferView::scrollDown(int offset)
1682 {
1683         Text * text = &buffer_.text();
1684         TextMetrics & tm = d->text_metrics_[text];
1685         int ymax = height_ + offset;
1686         while (true) {
1687                 pair<pit_type, ParagraphMetrics const *> last = tm.last();
1688                 int bottom_pos = last.second->position() + last.second->descent();
1689                 if (last.first + 1 == int(text->paragraphs().size())) {
1690                         if (bottom_pos <= height_)
1691                                 return 0;
1692                         offset = min(offset, bottom_pos - height_);
1693                         break;
1694                 }
1695                 if (bottom_pos > ymax)
1696                         break;
1697                 tm.newParMetricsDown();
1698         }
1699         d->anchor_ypos_ -= offset;
1700         return -offset;
1701 }
1702
1703
1704 int BufferView::scrollUp(int offset)
1705 {
1706         Text * text = &buffer_.text();
1707         TextMetrics & tm = d->text_metrics_[text];
1708         int ymin = - offset;
1709         while (true) {
1710                 pair<pit_type, ParagraphMetrics const *> first = tm.first();
1711                 int top_pos = first.second->position() - first.second->ascent();
1712                 if (first.first == 0) {
1713                         if (top_pos >= 0)
1714                                 return 0;
1715                         offset = min(offset, - top_pos);
1716                         break;
1717                 }
1718                 if (top_pos < ymin)
1719                         break;
1720                 tm.newParMetricsUp();
1721         }
1722         d->anchor_ypos_ += offset;
1723         return offset;
1724 }
1725
1726
1727 void BufferView::setCursorFromRow(int row)
1728 {
1729         int tmpid = -1;
1730         int tmppos = -1;
1731
1732         buffer_.texrow().getIdFromRow(row, tmpid, tmppos);
1733
1734         d->cursor_.reset(buffer_.inset());
1735         if (tmpid == -1)
1736                 buffer_.text().setCursor(d->cursor_, 0, 0);
1737         else
1738                 buffer_.text().setCursor(d->cursor_, buffer_.getParFromID(tmpid).pit(), tmppos);
1739 }
1740
1741
1742 void BufferView::gotoLabel(docstring const & label)
1743 {
1744         Toc & toc = buffer().tocBackend().toc("label");
1745         TocIterator toc_it = toc.begin();
1746         TocIterator end = toc.end();
1747         for (; toc_it != end; ++toc_it) {
1748                 if (label == toc_it->str())
1749                         dispatch(toc_it->action());
1750         }
1751         //FIXME: We could do a bit more searching thanks to this:
1752         //InsetLabel const * inset = buffer_.insetLabel(label);
1753 }
1754
1755
1756 TextMetrics const & BufferView::textMetrics(Text const * t) const
1757 {
1758         return const_cast<BufferView *>(this)->textMetrics(t);
1759 }
1760
1761
1762 TextMetrics & BufferView::textMetrics(Text const * t)
1763 {
1764         TextMetricsCache::iterator tmc_it  = d->text_metrics_.find(t);
1765         if (tmc_it == d->text_metrics_.end()) {
1766                 tmc_it = d->text_metrics_.insert(
1767                         make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
1768         }
1769         return tmc_it->second;
1770 }
1771
1772
1773 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
1774                 pit_type pit) const
1775 {
1776         return textMetrics(t).parMetrics(pit);
1777 }
1778
1779
1780 int BufferView::workHeight() const
1781 {
1782         return height_;
1783 }
1784
1785
1786 void BufferView::setCursor(DocIterator const & dit)
1787 {
1788         size_t const n = dit.depth();
1789         for (size_t i = 0; i < n; ++i)
1790                 dit[i].inset().edit(d->cursor_, true);
1791
1792         d->cursor_.setCursor(dit);
1793         d->cursor_.selection() = false;
1794 }
1795
1796
1797 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
1798 {
1799         // Would be wrong to delete anything if we have a selection.
1800         if (cur.selection())
1801                 return false;
1802
1803         bool need_anchor_change = false;
1804         bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
1805                 need_anchor_change);
1806
1807         if (need_anchor_change)
1808                 cur.resetAnchor();
1809
1810         if (!changed)
1811                 return false;
1812
1813         d->cursor_ = cur;
1814
1815         updateLabels(buffer_);
1816
1817         updateMetrics();
1818         buffer_.changed();
1819         return true;
1820 }
1821
1822
1823 bool BufferView::mouseSetCursor(Cursor & cur, bool select)
1824 {
1825         LASSERT(&cur.bv() == this, /**/);
1826
1827         if (!select)
1828                 // this event will clear selection so we save selection for
1829                 // persistent selection
1830                 cap::saveSelection(cursor());
1831
1832         // Has the cursor just left the inset?
1833         bool badcursor = false;
1834         bool leftinset = (&d->cursor_.inset() != &cur.inset());
1835         if (leftinset) {
1836                 d->cursor_.fixIfBroken();
1837                 badcursor = notifyCursorLeaves(d->cursor_, cur);
1838                 if (badcursor)
1839                         cur.fixIfBroken();
1840         }
1841
1842         // FIXME: shift-mouse selection doesn't work well across insets.
1843         bool do_selection = select && &d->cursor_.anchor().inset() == &cur.inset();
1844
1845         // do the dEPM magic if needed
1846         // FIXME: (1) move this to InsetText::notifyCursorLeaves?
1847         // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
1848         // the leftinset bool would not be necessary (badcursor instead).
1849         bool update = leftinset;
1850         if (!do_selection && !badcursor && d->cursor_.inTexted())
1851                 update |= checkDepm(cur, d->cursor_);
1852
1853         d->cursor_.setCursor(cur);
1854         d->cursor_.boundary(cur.boundary());
1855         if (do_selection)
1856                 d->cursor_.setSelection();
1857         else
1858                 d->cursor_.clearSelection();
1859
1860         d->cursor_.finishUndo();
1861         d->cursor_.setCurrentFont();
1862         return update;
1863 }
1864
1865
1866 void BufferView::putSelectionAt(DocIterator const & cur,
1867                                 int length, bool backwards)
1868 {
1869         d->cursor_.clearSelection();
1870
1871         setCursor(cur);
1872
1873         if (length) {
1874                 if (backwards) {
1875                         d->cursor_.pos() += length;
1876                         d->cursor_.setSelection(d->cursor_, -length);
1877                 } else
1878                         d->cursor_.setSelection(d->cursor_, length);
1879         }
1880         // Ensure a redraw happens in any case because the new selection could
1881         // possibly be on the same screen as the previous selection.
1882         processUpdateFlags(Update::Force | Update::FitCursor);
1883 }
1884
1885
1886 Cursor & BufferView::cursor()
1887 {
1888         return d->cursor_;
1889 }
1890
1891
1892 Cursor const & BufferView::cursor() const
1893 {
1894         return d->cursor_;
1895 }
1896
1897
1898 pit_type BufferView::anchor_ref() const
1899 {
1900         return d->anchor_pit_;
1901 }
1902
1903
1904 bool BufferView::singleParUpdate()
1905 {
1906         Text & buftext = buffer_.text();
1907         pit_type const bottom_pit = d->cursor_.bottom().pit();
1908         TextMetrics & tm = textMetrics(&buftext);
1909         int old_height = tm.parMetrics(bottom_pit).height();
1910
1911         // make sure inline completion pointer is ok
1912         if (d->inlineCompletionPos_.fixIfBroken())
1913                 d->inlineCompletionPos_ = DocIterator();
1914
1915         // In Single Paragraph mode, rebreak only
1916         // the (main text, not inset!) paragraph containing the cursor.
1917         // (if this paragraph contains insets etc., rebreaking will
1918         // recursively descend)
1919         tm.redoParagraph(bottom_pit);
1920         ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
1921         if (pm.height() != old_height)
1922                 // Paragraph height has changed so we cannot proceed to
1923                 // the singlePar optimisation.
1924                 return false;
1925
1926         d->update_strategy_ = SingleParUpdate;
1927
1928         LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
1929                 << " y2: " << pm.position() + pm.descent()
1930                 << " pit: " << bottom_pit
1931                 << " singlepar: 1");
1932         return true;
1933 }
1934
1935
1936 void BufferView::updateMetrics()
1937 {
1938         if (height_ == 0 || width_ == 0)
1939                 return;
1940
1941         Text & buftext = buffer_.text();
1942         pit_type const npit = int(buftext.paragraphs().size());
1943
1944         // Clear out the position cache in case of full screen redraw,
1945         d->coord_cache_.clear();
1946
1947         // Clear out paragraph metrics to avoid having invalid metrics
1948         // in the cache from paragraphs not relayouted below
1949         // The complete text metrics will be redone.
1950         d->text_metrics_.clear();
1951
1952         TextMetrics & tm = textMetrics(&buftext);
1953
1954         // make sure inline completion pointer is ok
1955         if (d->inlineCompletionPos_.fixIfBroken())
1956                 d->inlineCompletionPos_ = DocIterator();
1957
1958         if (d->anchor_pit_ >= npit)
1959                 // The anchor pit must have been deleted...
1960                 d->anchor_pit_ = npit - 1;
1961
1962         // Rebreak anchor paragraph.
1963         tm.redoParagraph(d->anchor_pit_);
1964         ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
1965
1966         // position anchor
1967         if (d->anchor_pit_ == 0) {
1968                 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
1969
1970                 // Complete buffer visible? Then it's easy.
1971                 if (scrollRange == 0)
1972                         d->anchor_ypos_ = anchor_pm.ascent();
1973
1974                 // FIXME: Some clever handling needed to show
1975                 // the _first_ paragraph up to the top if the cursor is
1976                 // in the first line.
1977         }
1978         anchor_pm.setPosition(d->anchor_ypos_);
1979
1980         LYXERR(Debug::PAINTING, "metrics: "
1981                 << " anchor pit = " << d->anchor_pit_
1982                 << " anchor ypos = " << d->anchor_ypos_);
1983
1984         // Redo paragraphs above anchor if necessary.
1985         int y1 = d->anchor_ypos_ - anchor_pm.ascent();
1986         // We are now just above the anchor paragraph.
1987         pit_type pit1 = d->anchor_pit_ - 1;
1988         for (; pit1 >= 0 && y1 >= 0; --pit1) {
1989                 tm.redoParagraph(pit1);
1990                 ParagraphMetrics & pm = tm.par_metrics_[pit1];
1991                 y1 -= pm.descent();
1992                 // Save the paragraph position in the cache.
1993                 pm.setPosition(y1);
1994                 y1 -= pm.ascent();
1995         }
1996
1997         // Redo paragraphs below the anchor if necessary.
1998         int y2 = d->anchor_ypos_ + anchor_pm.descent();
1999         // We are now just below the anchor paragraph.
2000         pit_type pit2 = d->anchor_pit_ + 1;
2001         for (; pit2 < npit && y2 <= height_; ++pit2) {
2002                 tm.redoParagraph(pit2);
2003                 ParagraphMetrics & pm = tm.par_metrics_[pit2];
2004                 y2 += pm.ascent();
2005                 // Save the paragraph position in the cache.
2006                 pm.setPosition(y2);
2007                 y2 += pm.descent();
2008         }
2009
2010         LYXERR(Debug::PAINTING, "Metrics: "
2011                 << " anchor pit = " << d->anchor_pit_
2012                 << " anchor ypos = " << d->anchor_ypos_
2013                 << " y1 = " << y1
2014                 << " y2 = " << y2
2015                 << " pit1 = " << pit1
2016                 << " pit2 = " << pit2);
2017
2018         d->update_strategy_ = FullScreenUpdate;
2019
2020         if (lyxerr.debugging(Debug::WORKAREA)) {
2021                 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
2022                 d->coord_cache_.dump();
2023         }
2024 }
2025
2026
2027 void BufferView::insertLyXFile(FileName const & fname)
2028 {
2029         LASSERT(d->cursor_.inTexted(), /**/);
2030
2031         // Get absolute path of file and add ".lyx"
2032         // to the filename if necessary
2033         FileName filename = fileSearch(string(), fname.absFilename(), "lyx");
2034
2035         docstring const disp_fn = makeDisplayPath(filename.absFilename());
2036         // emit message signal.
2037         message(bformat(_("Inserting document %1$s..."), disp_fn));
2038
2039         docstring res;
2040         Buffer buf("", false);
2041         if (buf.loadLyXFile(filename)) {
2042                 ErrorList & el = buffer_.errorList("Parse");
2043                 // Copy the inserted document error list into the current buffer one.
2044                 el = buf.errorList("Parse");
2045                 buffer_.undo().recordUndo(d->cursor_);
2046                 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
2047                                              buf.params().documentClassPtr(), el);
2048                 res = _("Document %1$s inserted.");
2049         } else {
2050                 res = _("Could not insert document %1$s");
2051         }
2052
2053         updateMetrics();
2054         buffer_.changed();
2055         // emit message signal.
2056         message(bformat(res, disp_fn));
2057         buffer_.errors("Parse");
2058 }
2059
2060
2061 Point BufferView::coordOffset(DocIterator const & dit, bool boundary) const
2062 {
2063         int x = 0;
2064         int y = 0;
2065         int lastw = 0;
2066
2067         // Addup contribution of nested insets, from inside to outside,
2068         // keeping the outer paragraph for a special handling below
2069         for (size_t i = dit.depth() - 1; i >= 1; --i) {
2070                 CursorSlice const & sl = dit[i];
2071                 int xx = 0;
2072                 int yy = 0;
2073
2074                 // get relative position inside sl.inset()
2075                 sl.inset().cursorPos(*this, sl, boundary && (i + 1 == dit.depth()), xx, yy);
2076
2077                 // Make relative position inside of the edited inset relative to sl.inset()
2078                 x += xx;
2079                 y += yy;
2080
2081                 // In case of an RTL inset, the edited inset will be positioned to the left
2082                 // of xx:yy
2083                 if (sl.text()) {
2084                         bool boundary_i = boundary && i + 1 == dit.depth();
2085                         bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2086                         if (rtl)
2087                                 x -= lastw;
2088                 }
2089
2090                 // remember width for the case that sl.inset() is positioned in an RTL inset
2091                 if (i && dit[i - 1].text()) {
2092                         // If this Inset is inside a Text Inset, retrieve the Dimension
2093                         // from the containing text instead of using Inset::dimension() which
2094                         // might not be implemented.
2095                         // FIXME (Abdel 23/09/2007): this is a bit messy because of the
2096                         // elimination of Inset::dim_ cache. This coordOffset() method needs
2097                         // to be rewritten in light of the new design.
2098                         Dimension const & dim = parMetrics(dit[i - 1].text(),
2099                                 dit[i - 1].pit()).insetDimension(&sl.inset());
2100                         lastw = dim.wid;
2101                 } else {
2102                         Dimension const dim = sl.inset().dimension(*this);
2103                         lastw = dim.wid;
2104                 }
2105
2106                 //lyxerr << "Cursor::getPos, i: "
2107                 // << i << " x: " << xx << " y: " << y << endl;
2108         }
2109
2110         // Add contribution of initial rows of outermost paragraph
2111         CursorSlice const & sl = dit[0];
2112         TextMetrics const & tm = textMetrics(sl.text());
2113         ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2114         LASSERT(!pm.rows().empty(), /**/);
2115         y -= pm.rows()[0].ascent();
2116 #if 1
2117         // FIXME: document this mess
2118         size_t rend;
2119         if (sl.pos() > 0 && dit.depth() == 1) {
2120                 int pos = sl.pos();
2121                 if (pos && boundary)
2122                         --pos;
2123 //              lyxerr << "coordOffset: boundary:" << boundary << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
2124                 rend = pm.pos2row(pos);
2125         } else
2126                 rend = pm.pos2row(sl.pos());
2127 #else
2128         size_t rend = pm.pos2row(sl.pos());
2129 #endif
2130         for (size_t rit = 0; rit != rend; ++rit)
2131                 y += pm.rows()[rit].height();
2132         y += pm.rows()[rend].ascent();
2133
2134         TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
2135
2136         // Make relative position from the nested inset now bufferview absolute.
2137         int xx = bottom_tm.cursorX(dit.bottom(), boundary && dit.depth() == 1);
2138         x += xx;
2139
2140         // In the RTL case place the nested inset at the left of the cursor in
2141         // the outer paragraph
2142         bool boundary_1 = boundary && 1 == dit.depth();
2143         bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
2144         if (rtl)
2145                 x -= lastw;
2146
2147         return Point(x, y);
2148 }
2149
2150
2151 Point BufferView::getPos(DocIterator const & dit, bool boundary) const
2152 {
2153         CursorSlice const & bot = dit.bottom();
2154         TextMetrics const & tm = textMetrics(bot.text());
2155         if (!tm.contains(bot.pit()))
2156                 return Point(-1, -1);
2157
2158         Point p = coordOffset(dit, boundary); // offset from outer paragraph
2159         p.y_ += tm.parMetrics(bot.pit()).position();
2160         return p;
2161 }
2162
2163
2164 void BufferView::draw(frontend::Painter & pain)
2165 {
2166         if (height_ == 0 || width_ == 0)
2167                 return;
2168         LYXERR(Debug::PAINTING, "\t\t*** START DRAWING ***");
2169         Text & text = buffer_.text();
2170         TextMetrics const & tm = d->text_metrics_[&text];
2171         int const y = tm.first().second->position();
2172         PainterInfo pi(this, pain);
2173
2174         switch (d->update_strategy_) {
2175
2176         case NoScreenUpdate:
2177                 // If no screen painting is actually needed, only some the different
2178                 // coordinates of insets and paragraphs needs to be updated.
2179                 pi.full_repaint = true;
2180                 pi.pain.setDrawingEnabled(false);
2181                 tm.draw(pi, 0, y);
2182                 break;
2183
2184         case SingleParUpdate:
2185                 pi.full_repaint = false;
2186                 // In general, only the current row of the outermost paragraph
2187                 // will be redrawn. Particular cases where selection spans
2188                 // multiple paragraph are correctly detected in TextMetrics.
2189                 tm.draw(pi, 0, y);
2190                 break;
2191
2192         case DecorationUpdate:
2193                 // FIXME: We should also distinguish DecorationUpdate to avoid text
2194                 // drawing if possible. This is not possible to do easily right now
2195                 // because of the single backing pixmap.
2196
2197         case FullScreenUpdate:
2198                 // The whole screen, including insets, will be refreshed.
2199                 pi.full_repaint = true;
2200
2201                 // Clear background.
2202                 pain.fillRectangle(0, 0, width_, height_,
2203                         buffer_.inset().backgroundColor());
2204
2205                 // Draw everything.
2206                 tm.draw(pi, 0, y);
2207
2208                 // and possibly grey out below
2209                 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2210                 int const y2 = lastpm.second->position() + lastpm.second->descent();
2211                 if (y2 < height_)
2212                         pain.fillRectangle(0, y2, width_, height_ - y2, Color_bottomarea);
2213                 break;
2214         }
2215         LYXERR(Debug::PAINTING, "\n\t\t*** END DRAWING  ***");
2216
2217         // The scrollbar needs an update.
2218         updateScrollbar();
2219
2220         // Normalize anchor for next time
2221         pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
2222         pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2223         for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
2224                 ParagraphMetrics const & pm = tm.parMetrics(pit);
2225                 if (pm.position() + pm.descent() > 0) {
2226                         d->anchor_pit_ = pit;
2227                         d->anchor_ypos_ = pm.position();
2228                         break;
2229                 }
2230         }
2231         LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
2232                 << "  anchor ypos = " << d->anchor_ypos_);
2233 }
2234
2235
2236 void BufferView::message(docstring const & msg)
2237 {
2238         if (d->gui_)
2239                 d->gui_->message(msg);
2240 }
2241
2242
2243 void BufferView::showDialog(string const & name)
2244 {
2245         if (d->gui_)
2246                 d->gui_->showDialog(name, string());
2247 }
2248
2249
2250 void BufferView::showDialog(string const & name,
2251         string const & data, Inset * inset)
2252 {
2253         if (d->gui_)
2254                 d->gui_->showDialog(name, data, inset);
2255 }
2256
2257
2258 void BufferView::updateDialog(string const & name, string const & data)
2259 {
2260         if (d->gui_)
2261                 d->gui_->updateDialog(name, data);
2262 }
2263
2264
2265 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
2266 {
2267         d->gui_ = gui;
2268 }
2269
2270
2271 // FIXME: Move this out of BufferView again
2272 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
2273 {
2274         if (!fname.isReadableFile()) {
2275                 docstring const error = from_ascii(strerror(errno));
2276                 docstring const file = makeDisplayPath(fname.absFilename(), 50);
2277                 docstring const text =
2278                   bformat(_("Could not read the specified document\n"
2279                             "%1$s\ndue to the error: %2$s"), file, error);
2280                 Alert::error(_("Could not read file"), text);
2281                 return docstring();
2282         }
2283
2284         if (!fname.isReadableFile()) {
2285                 docstring const file = makeDisplayPath(fname.absFilename(), 50);
2286                 docstring const text =
2287                   bformat(_("%1$s\n is not readable."), file);
2288                 Alert::error(_("Could not open file"), text);
2289                 return docstring();
2290         }
2291
2292         // FIXME UNICODE: We don't know the encoding of the file
2293         docstring file_content = fname.fileContents("UTF-8");
2294         if (file_content.empty()) {
2295                 Alert::error(_("Reading not UTF-8 encoded file"),
2296                              _("The file is not UTF-8 encoded.\n"
2297                                "It will be read as local 8Bit-encoded.\n"
2298                                "If this does not give the correct result\n"
2299                                "then please change the encoding of the file\n"
2300                                "to UTF-8 with a program other than LyX.\n"));
2301                 file_content = fname.fileContents("local8bit");
2302         }
2303
2304         return normalize_c(file_content);
2305 }
2306
2307
2308 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
2309 {
2310         docstring const tmpstr = contentsOfPlaintextFile(f);
2311
2312         if (tmpstr.empty())
2313                 return;
2314
2315         Cursor & cur = cursor();
2316         cap::replaceSelection(cur);
2317         buffer_.undo().recordUndo(cur);
2318         if (asParagraph)
2319                 cur.innerText()->insertStringAsParagraphs(cur, tmpstr);
2320         else
2321                 cur.innerText()->insertStringAsLines(cur, tmpstr);
2322
2323         updateMetrics();
2324         buffer_.changed();
2325 }
2326
2327
2328 docstring const & BufferView::inlineCompletion() const
2329 {
2330         return d->inlineCompletion_;
2331 }
2332
2333
2334 size_t const & BufferView::inlineCompletionUniqueChars() const
2335 {
2336         return d->inlineCompletionUniqueChars_;
2337 }
2338
2339
2340 DocIterator const & BufferView::inlineCompletionPos() const
2341 {
2342         return d->inlineCompletionPos_;
2343 }
2344
2345
2346 bool samePar(DocIterator const & a, DocIterator const & b)
2347 {
2348         if (a.empty() && b.empty())
2349                 return true;
2350         if (a.empty() || b.empty())
2351                 return false;
2352         return &a.innerParagraph() == &b.innerParagraph();
2353 }
2354
2355
2356 void BufferView::setInlineCompletion(Cursor & cur, DocIterator const & pos,
2357         docstring const & completion, size_t uniqueChars)
2358 {
2359         uniqueChars = min(completion.size(), uniqueChars);
2360         bool changed = d->inlineCompletion_ != completion
2361                 || d->inlineCompletionUniqueChars_ != uniqueChars;
2362         bool singlePar = true;
2363         d->inlineCompletion_ = completion;
2364         d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
2365
2366         //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
2367
2368         // at new position?
2369         DocIterator const & old = d->inlineCompletionPos_;
2370         if (old != pos) {
2371                 //lyxerr << "inlineCompletionPos changed" << std::endl;
2372                 // old or pos are in another paragraph?
2373                 if ((!samePar(cur, pos) && !pos.empty())
2374                     || (!samePar(cur, old) && !old.empty())) {
2375                         singlePar = false;
2376                         //lyxerr << "different paragraph" << std::endl;
2377                 }
2378                 d->inlineCompletionPos_ = pos;
2379         }
2380
2381         // set update flags
2382         if (changed) {
2383                 if (singlePar && !(cur.disp_.update() & Update::Force))
2384                         cur.updateFlags(cur.disp_.update() | Update::SinglePar);
2385                 else
2386                         cur.updateFlags(cur.disp_.update() | Update::Force);
2387         }
2388 }
2389
2390 } // namespace lyx