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 "LayoutFile.h"
  38 #include "Lexer.h"
  39 #include "LyX.h"
  40 #include "LyXAction.h"
  41 #include "lyxfind.h"
  42 #include "Layout.h"
  43 #include "LyXRC.h"
  44 #include "MetricsInfo.h"
  45 #include "Paragraph.h"
  46 #include "ParagraphParameters.h"
  47 #include "ParIterator.h"
  48 #include "Session.h"
  49 #include "Text.h"
  50 #include "TextClass.h"
  51 #include "TextMetrics.h"
  52 #include "TexRow.h"
  53 #include "TocBackend.h"
  54 #include "WordLangTuple.h"
  55
  56 #include "insets/InsetBibtex.h"
  57 #include "insets/InsetCitation.h"
  58 #include "insets/InsetCommand.h" // ChangeRefs
  59 #include "insets/InsetExternal.h"
  60 #include "insets/InsetGraphics.h"
  61 #include "insets/InsetNote.h"
  62 #include "insets/InsetRef.h"
  63 #include "insets/InsetText.h"
  64
  65 #include "mathed/MathData.h"
  66
  67 #include "frontends/alert.h"
  68 #include "frontends/Application.h"
  69 #include "frontends/Delegates.h"
  70 #include "frontends/FontMetrics.h"
  71 #include "frontends/Painter.h"
  72 #include "frontends/Selection.h"
  73
  74 #include "support/convert.h"
  75 #include "support/debug.h"
  76 #include "support/ExceptionMessage.h"
  77 #include "support/filetools.h"
  78 #include "support/gettext.h"
  79 #include "support/lassert.h"
  80 #include "support/lstrings.h"
  81 #include "support/Package.h"
  82 #include "support/types.h"
  83
  84 #include <cerrno>
  85 #include <fstream>
  86 #include <functional>
  87 #include <iterator>
  88 #include <sstream>
  89 #include <vector>
  90
  91 using namespace std;
  92 using namespace lyx::support;
  93
  94 namespace lyx {
  95
  96 namespace Alert = frontend::Alert;
  97
  98 namespace {
  99
 100 /// Return an inset of this class if it exists at the current cursor position
 101 template <class T>
 102 T * getInsetByCode(Cursor const & cur, InsetCode code)
 103 {
 104         DocIterator it = cur;
 105         Inset * inset = it.nextInset();
 106         if (inset && inset->lyxCode() == code)
 107                 return static_cast<T*>(inset);
 108         return 0;
 109 }
 110
 111
 112 /// Note that comparing contents can only be used for InsetCommand
 113 bool findNextInset(DocIterator & dit, vector<InsetCode> const & codes,
 114         docstring const & contents)
 115 {
 116         DocIterator tmpdit = dit;
 117
 118         while (tmpdit) {
 119                 Inset const * inset = tmpdit.nextInset();
 120                 if (inset) {
 121                         bool const valid_code = std::find(codes.begin(), codes.end(),
 122                                 inset->lyxCode()) != codes.end();
 123                         InsetCommand const * ic = inset->asInsetCommand();
 124                         bool const same_or_no_contents =  contents.empty()
 125                                 || (ic && (ic->getFirstNonOptParam() == contents));
 126
 127                         if (valid_code && same_or_no_contents) {
 128                                 dit = tmpdit;
 129                                 return true;
 130                         }
 131                 }
 132                 tmpdit.forwardInset();
 133         }
 134
 135         return false;
 136 }
 137
 138
 139 /// Looks for next inset with one of the given codes.
 140 /// Note that same_content can only be used for InsetCommand
 141 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
 142         bool same_content)
 143 {
 144         docstring contents;
 145         DocIterator tmpdit = dit;
 146         tmpdit.forwardInset();
 147         if (!tmpdit)
 148                 return false;
 149
 150         Inset const * inset = tmpdit.nextInset();
 151         if (same_content && inset) {
 152                 InsetCommand const * ic = inset->asInsetCommand();
 153                 if (ic) {
 154                         bool const valid_code = std::find(codes.begin(), codes.end(),
 155                                 ic->lyxCode()) != codes.end();
 156                         if (valid_code)
 157                                 contents = ic->getFirstNonOptParam();
 158                 }
 159         }
 160
 161         if (!findNextInset(tmpdit, codes, contents)) {
 162                 if (dit.depth() != 1 || dit.pit() != 0 || dit.pos() != 0) {
 163                         Inset * inset = &tmpdit.bottom().inset();
 164                         tmpdit = doc_iterator_begin(&inset->buffer(), inset);
 165                         if (!findNextInset(tmpdit, codes, contents))
 166                                 return false;
 167                 } else {
 168                         return false;
 169                 }
 170         }
 171
 172         dit = tmpdit;
 173         return true;
 174 }
 175
 176
 177 /// Looks for next inset with the given code
 178 void findInset(DocIterator & dit, InsetCode code, bool same_content)
 179 {
 180         findInset(dit, vector<InsetCode>(1, code), same_content);
 181 }
 182
 183
 184 /// Moves cursor to the next inset with one of the given codes.
 185 void gotoInset(BufferView * bv, vector<InsetCode> const & codes,
 186                bool same_content)
 187 {
 188         Cursor tmpcur = bv->cursor();
 189         if (!findInset(tmpcur, codes, same_content)) {
 190                 bv->cursor().message(_("No more insets"));
 191                 return;
 192         }
 193
 194         tmpcur.clearSelection();
 195         bv->setCursor(tmpcur);
 196         bv->showCursor();
 197 }
 198
 199
 200 /// Moves cursor to the next inset with given code.
 201 void gotoInset(BufferView * bv, InsetCode code, bool same_content)
 202 {
 203         gotoInset(bv, vector<InsetCode>(1, code), same_content);
 204 }
 205
 206
 207 /// A map from a Text to the associated text metrics
 208 typedef map<Text const *, TextMetrics> TextMetricsCache;
 209
 210 enum ScreenUpdateStrategy {
 211         NoScreenUpdate,
 212         SingleParUpdate,
 213         FullScreenUpdate,
 214         DecorationUpdate
 215 };
 216
 217 } // anon namespace
 218
 219
 220 /////////////////////////////////////////////////////////////////////
 221 //
 222 // BufferView
 223 //
 224 /////////////////////////////////////////////////////////////////////
 225
 226 struct BufferView::Private
 227 {
 228         Private(BufferView & bv): wh_(0), cursor_(bv),
 229                 anchor_pit_(0), anchor_ypos_(0),
 230                 inlineCompletionUniqueChars_(0),
 231                 last_inset_(0), clickable_inset_(false),
 232                 mouse_position_cache_(),
 233                 bookmark_edit_position_(-1), gui_(0)
 234         {}
 235
 236         ///
 237         ScrollbarParameters scrollbarParameters_;
 238         ///
 239         ScreenUpdateStrategy update_strategy_;
 240         ///
 241         CoordCache coord_cache_;
 242
 243         /// Estimated average par height for scrollbar.
 244         int wh_;
 245         /// this is used to handle XSelection events in the right manner.
 246         struct {
 247                 CursorSlice cursor;
 248                 CursorSlice anchor;
 249                 bool set;
 250         } xsel_cache_;
 251         ///
 252         Cursor cursor_;
 253         ///
 254         pit_type anchor_pit_;
 255         ///
 256         int anchor_ypos_;
 257         ///
 258         vector<int> par_height_;
 259
 260         ///
 261         DocIterator inlineCompletionPos_;
 262         ///
 263         docstring inlineCompletion_;
 264         ///
 265         size_t inlineCompletionUniqueChars_;
 266
 267         /// keyboard mapping object.
 268         Intl intl_;
 269
 270         /// last visited inset.
 271         /** kept to send setMouseHover(false).
 272           * Not owned, so don't delete.
 273           */
 274         Inset const * last_inset_;
 275         /// are we hovering something that we can click
 276         bool clickable_inset_;
 277
 278         /// position of the mouse at the time of the last mouse move
 279         /// This is used to update the hovering status of inset in
 280         /// cases where the buffer is scrolled, but the mouse didn't move.
 281         Point mouse_position_cache_;
 282
 283         // cache for id of the paragraph which was edited the last time
 284         int bookmark_edit_position_;
 285
 286         mutable TextMetricsCache text_metrics_;
 287
 288         /// Whom to notify.
 289         /** Not owned, so don't delete.
 290           */
 291         frontend::GuiBufferViewDelegate * gui_;
 292
 293         /// Cache for Find Next
 294         FuncRequest search_request_cache_;
 295
 296         ///
 297         map<string, Inset *> edited_insets_;
 298 };
 299
 300
 301 BufferView::BufferView(Buffer & buf)
 302         : width_(0), height_(0), full_screen_(false), buffer_(buf),
 303       d(new Private(*this))
 304 {
 305         d->xsel_cache_.set = false;
 306         d->intl_.initKeyMapper(lyxrc.use_kbmap);
 307
 308         d->cursor_.setBuffer(&buf);
 309         d->cursor_.push(buffer_.inset());
 310         d->cursor_.resetAnchor();
 311         d->cursor_.setCurrentFont();
 312
 313         buffer_.updatePreviews();
 314 }
 315
 316
 317 BufferView::~BufferView()
 318 {
 319         // current buffer is going to be switched-off, save cursor pos
 320         // Ideally, the whole cursor stack should be saved, but session
 321         // currently can only handle bottom (whole document) level pit and pos.
 322         // That is to say, if a cursor is in a nested inset, it will be
 323         // restore to the left of the top level inset.
 324         LastFilePosSection::FilePos fp;
 325         fp.pit = d->cursor_.bottom().pit();
 326         fp.pos = d->cursor_.bottom().pos();
 327         theSession().lastFilePos().save(buffer_.fileName(), fp);
 328
 329         if (d->last_inset_)
 330                 d->last_inset_->setMouseHover(this, false);
 331
 332         delete d;
 333 }
 334
 335
 336 int BufferView::rightMargin() const
 337 {
 338         // The additional test for the case the outliner is opened.
 339         if (!full_screen_ ||
 340                 !lyxrc.full_screen_limit ||
 341                 width_ < lyxrc.full_screen_width + 20)
 342                         return 10;
 343
 344         return (width_ - lyxrc.full_screen_width) / 2;
 345 }
 346
 347
 348 int BufferView::leftMargin() const
 349 {
 350         return rightMargin();
 351 }
 352
 353
 354 bool BufferView::isTopScreen() const
 355 {
 356         return d->scrollbarParameters_.position == d->scrollbarParameters_.min;
 357 }
 358
 359
 360 bool BufferView::isBottomScreen() const
 361 {
 362         return d->scrollbarParameters_.position == d->scrollbarParameters_.max;
 363 }
 364
 365
 366 Intl & BufferView::getIntl()
 367 {
 368         return d->intl_;
 369 }
 370
 371
 372 Intl const & BufferView::getIntl() const
 373 {
 374         return d->intl_;
 375 }
 376
 377
 378 CoordCache & BufferView::coordCache()
 379 {
 380         return d->coord_cache_;
 381 }
 382
 383
 384 CoordCache const & BufferView::coordCache() const
 385 {
 386         return d->coord_cache_;
 387 }
 388
 389
 390 Buffer & BufferView::buffer()
 391 {
 392         return buffer_;
 393 }
 394
 395
 396 Buffer const & BufferView::buffer() const
 397 {
 398         return buffer_;
 399 }
 400
 401
 402 bool BufferView::fitCursor()
 403 {
 404         if (cursorStatus(d->cursor_) == CUR_INSIDE) {
 405                 frontend::FontMetrics const & fm =
 406                         theFontMetrics(d->cursor_.getFont().fontInfo());
 407                 int const asc = fm.maxAscent();
 408                 int const des = fm.maxDescent();
 409                 Point const p = getPos(d->cursor_);
 410                 if (p.y_ - asc >= 0 && p.y_ + des < height_)
 411                         return false;
 412         }
 413         return true;
 414 }
 415
 416
 417 void BufferView::processUpdateFlags(Update::flags flags)
 418 {
 419         // This is close to a hot-path.
 420         LYXERR(Debug::DEBUG, "BufferView::processUpdateFlags()"
 421                 << "[fitcursor = " << (flags & Update::FitCursor)
 422                 << ", forceupdate = " << (flags & Update::Force)
 423                 << ", singlepar = " << (flags & Update::SinglePar)
 424                 << "]  buffer: " << &buffer_);
 425
 426         // FIXME Does this really need doing here? It's done in updateBuffer, and
 427         // if the Buffer doesn't need updating, then do the macros?
 428         buffer_.updateMacros();
 429
 430         // Now do the first drawing step if needed. This consists on updating
 431         // the CoordCache in updateMetrics().
 432         // The second drawing step is done in WorkArea::redraw() if needed.
 433
 434         // Case when no explicit update is requested.
 435         if (!flags) {
 436                 // no need to redraw anything.
 437                 d->update_strategy_ = NoScreenUpdate;
 438                 return;
 439         }
 440
 441         if (flags == Update::Decoration) {
 442                 d->update_strategy_ = DecorationUpdate;
 443                 buffer_.changed(false);
 444                 return;
 445         }
 446
 447         if (flags == Update::FitCursor
 448                 || flags == (Update::Decoration | Update::FitCursor)) {
 449                 // tell the frontend to update the screen if needed.
 450                 if (fitCursor()) {
 451                         showCursor();
 452                         return;
 453                 }
 454                 if (flags & Update::Decoration) {
 455                         d->update_strategy_ = DecorationUpdate;
 456                         buffer_.changed(false);
 457                         return;
 458                 }
 459                 // no screen update is needed.
 460                 d->update_strategy_ = NoScreenUpdate;
 461                 return;
 462         }
 463
 464         bool const full_metrics = flags & Update::Force || !singleParUpdate();
 465
 466         if (full_metrics)
 467                 // We have to update the full screen metrics.
 468                 updateMetrics();
 469
 470         if (!(flags & Update::FitCursor)) {
 471                 // Nothing to do anymore. Trigger a redraw and return
 472                 buffer_.changed(false);
 473                 return;
 474         }
 475
 476         // updateMetrics() does not update paragraph position
 477         // This is done at draw() time. So we need a redraw!
 478         buffer_.changed(false);
 479
 480         if (fitCursor()) {
 481                 // The cursor is off screen so ensure it is visible.
 482                 // refresh it:
 483                 showCursor();
 484         }
 485
 486         updateHoveredInset();
 487 }
 488
 489
 490 void BufferView::updateScrollbar()
 491 {
 492         if (height_ == 0 && width_ == 0)
 493                 return;
 494
 495         // We prefer fixed size line scrolling.
 496         d->scrollbarParameters_.single_step = defaultRowHeight();
 497         // We prefer full screen page scrolling.
 498         d->scrollbarParameters_.page_step = height_;
 499
 500         Text & t = buffer_.text();
 501         TextMetrics & tm = d->text_metrics_[&t];
 502
 503         LYXERR(Debug::GUI, " Updating scrollbar: height: "
 504                 << t.paragraphs().size()
 505                 << " curr par: " << d->cursor_.bottom().pit()
 506                 << " default height " << defaultRowHeight());
 507
 508         size_t const parsize = t.paragraphs().size();
 509         if (d->par_height_.size() != parsize) {
 510                 d->par_height_.clear();
 511                 // FIXME: We assume a default paragraph height of 2 rows. This
 512                 // should probably be pondered with the screen width.
 513                 d->par_height_.resize(parsize, defaultRowHeight() * 2);
 514         }
 515
 516         // Look at paragraph heights on-screen
 517         pair<pit_type, ParagraphMetrics const *> first = tm.first();
 518         pair<pit_type, ParagraphMetrics const *> last = tm.last();
 519         for (pit_type pit = first.first; pit <= last.first; ++pit) {
 520                 d->par_height_[pit] = tm.parMetrics(pit).height();
 521                 LYXERR(Debug::SCROLLING, "storing height for pit " << pit << " : "
 522                         << d->par_height_[pit]);
 523         }
 524
 525         int top_pos = first.second->position() - first.second->ascent();
 526         int bottom_pos = last.second->position() + last.second->descent();
 527         bool first_visible = first.first == 0 && top_pos >= 0;
 528         bool last_visible = last.first + 1 == int(parsize) && bottom_pos <= height_;
 529         if (first_visible && last_visible) {
 530                 d->scrollbarParameters_.min = 0;
 531                 d->scrollbarParameters_.max = 0;
 532                 return;
 533         }
 534
 535         d->scrollbarParameters_.min = top_pos;
 536         for (size_t i = 0; i != size_t(first.first); ++i)
 537                 d->scrollbarParameters_.min -= d->par_height_[i];
 538         d->scrollbarParameters_.max = bottom_pos;
 539         for (size_t i = last.first + 1; i != parsize; ++i)
 540                 d->scrollbarParameters_.max += d->par_height_[i];
 541
 542         d->scrollbarParameters_.position = 0;
 543         // The reference is the top position so we remove one page.
 544         if (lyxrc.scroll_below_document)
 545                 d->scrollbarParameters_.max -= minVisiblePart();
 546         else
 547                 d->scrollbarParameters_.max -= d->scrollbarParameters_.page_step;
 548 }
 549
 550
 551 ScrollbarParameters const & BufferView::scrollbarParameters() const
 552 {
 553         return d->scrollbarParameters_;
 554 }
 555
 556
 557 docstring BufferView::toolTip(int x, int y) const
 558 {
 559         // Get inset under mouse, if there is one.
 560         Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
 561         if (!covering_inset)
 562                 // No inset, no tooltip...
 563                 return docstring();
 564         return covering_inset->toolTip(*this, x, y);
 565 }
 566
 567
 568 string BufferView::contextMenu(int x, int y) const
 569 {
 570         //If there is a selection, return the containing inset menu
 571         if (d->cursor_.selection())
 572                 return d->cursor_.inset().contextMenu(*this, x, y);
 573
 574         // Get inset under mouse, if there is one.
 575         Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
 576         if (covering_inset)
 577                 return covering_inset->contextMenu(*this, x, y);
 578
 579         return buffer_.inset().contextMenu(*this, x, y);
 580 }
 581
 582
 583 void BufferView::scrollDocView(int value, bool update)
 584 {
 585         int const offset = value - d->scrollbarParameters_.position;
 586
 587         // No scrolling at all? No need to redraw anything
 588         if (offset == 0)
 589                 return;
 590
 591         // If the offset is less than 2 screen height, prefer to scroll instead.
 592         if (abs(offset) <= 2 * height_) {
 593                 d->anchor_ypos_ -= offset;
 594                 buffer_.changed(true);
 595                 updateHoveredInset();
 596                 return;
 597         }
 598
 599         // cut off at the top
 600         if (value <= d->scrollbarParameters_.min) {
 601                 DocIterator dit = doc_iterator_begin(&buffer_);
 602                 showCursor(dit, false, update);
 603                 LYXERR(Debug::SCROLLING, "scroll to top");
 604                 return;
 605         }
 606
 607         // cut off at the bottom
 608         if (value >= d->scrollbarParameters_.max) {
 609                 DocIterator dit = doc_iterator_end(&buffer_);
 610                 dit.backwardPos();
 611                 showCursor(dit, false, update);
 612                 LYXERR(Debug::SCROLLING, "scroll to bottom");
 613                 return;
 614         }
 615
 616         // find paragraph at target position
 617         int par_pos = d->scrollbarParameters_.min;
 618         pit_type i = 0;
 619         for (; i != int(d->par_height_.size()); ++i) {
 620                 par_pos += d->par_height_[i];
 621                 if (par_pos >= value)
 622                         break;
 623         }
 624
 625         if (par_pos < value) {
 626                 // It seems we didn't find the correct pit so stay on the safe side and
 627                 // scroll to bottom.
 628                 LYXERR0("scrolling position not found!");
 629                 scrollDocView(d->scrollbarParameters_.max, update);
 630                 return;
 631         }
 632
 633         DocIterator dit = doc_iterator_begin(&buffer_);
 634         dit.pit() = i;
 635         LYXERR(Debug::SCROLLING, "value = " << value << " -> scroll to pit " << i);
 636         showCursor(dit, false, update);
 637 }
 638
 639
 640 // FIXME: this method is not working well.
 641 void BufferView::setCursorFromScrollbar()
 642 {
 643         TextMetrics & tm = d->text_metrics_[&buffer_.text()];
 644
 645         int const height = 2 * defaultRowHeight();
 646         int const first = height;
 647         int const last = height_ - height;
 648         int newy = 0;
 649         Cursor const & oldcur = d->cursor_;
 650
 651         switch (cursorStatus(oldcur)) {
 652         case CUR_ABOVE:
 653                 newy = first;
 654                 break;
 655         case CUR_BELOW:
 656                 newy = last;
 657                 break;
 658         case CUR_INSIDE:
 659                 int const y = getPos(oldcur).y_;
 660                 newy = min(last, max(y, first));
 661                 if (y == newy)
 662                         return;
 663         }
 664         // We reset the cursor because cursorStatus() does not
 665         // work when the cursor is within mathed.
 666         Cursor cur(*this);
 667         cur.reset();
 668         tm.setCursorFromCoordinates(cur, 0, newy);
 669
 670         // update the bufferview cursor and notify insets
 671         // FIXME: Care about the d->cursor_ flags to redraw if needed
 672         Cursor old = d->cursor_;
 673         mouseSetCursor(cur);
 674         // the DEPM call in mouseSetCursor() might have destroyed the
 675         // paragraph the cursor is in.
 676         bool badcursor = old.fixIfBroken();
 677         badcursor |= notifyCursorLeavesOrEnters(old, d->cursor_);
 678         if (badcursor)
 679                 d->cursor_.fixIfBroken();
 680 }
 681
 682
 683 Change const BufferView::getCurrentChange() const
 684 {
 685         if (!d->cursor_.selection())
 686                 return Change(Change::UNCHANGED);
 687
 688         DocIterator dit = d->cursor_.selectionBegin();
 689         // The selected content might have been changed (see #7685)
 690         while (dit.inMathed())
 691                 // Find enclosing text cursor
 692                 dit.pop_back();
 693         return dit.paragraph().lookupChange(dit.pos());
 694 }
 695
 696
 697 // this could be used elsewhere as well?
 698 // FIXME: This does not work within mathed!
 699 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
 700 {
 701         Point const p = getPos(dit);
 702         if (p.y_ < 0)
 703                 return CUR_ABOVE;
 704         if (p.y_ > workHeight())
 705                 return CUR_BELOW;
 706         return CUR_INSIDE;
 707 }
 708
 709
 710 void BufferView::bookmarkEditPosition()
 711 {
 712         // Don't eat cpu time for each keystroke
 713         if (d->cursor_.paragraph().id() == d->bookmark_edit_position_)
 714                 return;
 715         saveBookmark(0);
 716         d->bookmark_edit_position_ = d->cursor_.paragraph().id();
 717 }
 718
 719
 720 void BufferView::saveBookmark(unsigned int idx)
 721 {
 722         // tentatively save bookmark, id and pos will be used to
 723         // acturately locate a bookmark in a 'live' lyx session.
 724         // pit and pos will be updated with bottom level pit/pos
 725         // when lyx exits.
 726         if (!buffer_.isInternal()) {
 727                 theSession().bookmarks().save(
 728                         buffer_.fileName(),
 729                         d->cursor_.bottom().pit(),
 730                         d->cursor_.bottom().pos(),
 731                         d->cursor_.paragraph().id(),
 732                         d->cursor_.pos(),
 733                         idx
 734                         );
 735                 if (idx)
 736                         // emit message signal.
 737                         message(_("Save bookmark"));
 738         }
 739 }
 740
 741
 742 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
 743         int top_id, pos_type top_pos)
 744 {
 745         bool success = false;
 746         DocIterator dit;
 747
 748         d->cursor_.clearSelection();
 749
 750         // if a valid par_id is given, try it first
 751         // This is the case for a 'live' bookmark when unique paragraph ID
 752         // is used to track bookmarks.
 753         if (top_id > 0) {
 754                 dit = buffer_.getParFromID(top_id);
 755                 if (!dit.atEnd()) {
 756                         dit.pos() = min(dit.paragraph().size(), top_pos);
 757                         // Some slices of the iterator may not be
 758                         // reachable (e.g. closed collapsable inset)
 759                         // so the dociterator may need to be
 760                         // shortened. Otherwise, setCursor may crash
 761                         // lyx when the cursor can not be set to these
 762                         // insets.
 763                         size_t const n = dit.depth();
 764                         for (size_t i = 0; i < n; ++i)
 765                                 if (!dit[i].inset().editable()) {
 766                                         dit.resize(i);
 767                                         break;
 768                                 }
 769                         success = true;
 770                 }
 771         }
 772
 773         // if top_id == 0, or searching through top_id failed
 774         // This is the case for a 'restored' bookmark when only bottom
 775         // (document level) pit was saved. Because of this, bookmark
 776         // restoration is inaccurate. If a bookmark was within an inset,
 777         // it will be restored to the left of the outmost inset that contains
 778         // the bookmark.
 779         if (bottom_pit < int(buffer_.paragraphs().size())) {
 780                 dit = doc_iterator_begin(&buffer_);
 781
 782                 dit.pit() = bottom_pit;
 783                 dit.pos() = min(bottom_pos, dit.paragraph().size());
 784                 success = true;
 785         }
 786
 787         if (success) {
 788                 // Note: only bottom (document) level pit is set.
 789                 setCursor(dit);
 790                 // set the current font.
 791                 d->cursor_.setCurrentFont();
 792                 // To center the screen on this new position we need the
 793                 // paragraph position which is computed at draw() time.
 794                 // So we need a redraw!
 795                 buffer_.changed(false);
 796                 if (fitCursor())
 797                         showCursor();
 798         }
 799
 800         return success;
 801 }
 802
 803
 804 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
 805 {
 806         if (d->cursor_.real_current_font.isRightToLeft()) {
 807                 if (d->intl_.keymap == Intl::PRIMARY)
 808                         d->intl_.keyMapSec();
 809         } else {
 810                 if (d->intl_.keymap == Intl::SECONDARY)
 811                         d->intl_.keyMapPrim();
 812         }
 813
 814         d->intl_.getTransManager().translateAndInsert(c, t, cur);
 815 }
 816
 817
 818 int BufferView::workWidth() const
 819 {
 820         return width_;
 821 }
 822
 823
 824 void BufferView::recenter()
 825 {
 826         showCursor(d->cursor_, true, true);
 827 }
 828
 829
 830 void BufferView::showCursor()
 831 {
 832         showCursor(d->cursor_, false, true);
 833 }
 834
 835
 836 void BufferView::showCursor(DocIterator const & dit,
 837         bool recenter, bool update)
 838 {
 839         if (scrollToCursor(dit, recenter) && update) {
 840                 buffer_.changed(true);
 841                 updateHoveredInset();
 842         }
 843 }
 844
 845
 846 void BufferView::scrollToCursor()
 847 {
 848         if (scrollToCursor(d->cursor_, false)) {
 849                 buffer_.changed(true);
 850                 updateHoveredInset();
 851         }
 852 }
 853
 854
 855 bool BufferView::scrollToCursor(DocIterator const & dit, bool recenter)
 856 {
 857         // We are not properly started yet, delay until resizing is
 858         // done.
 859         if (height_ == 0)
 860                 return false;
 861
 862         LYXERR(Debug::SCROLLING, "recentering!");
 863
 864         CursorSlice const & bot = dit.bottom();
 865         TextMetrics & tm = d->text_metrics_[bot.text()];
 866
 867         pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
 868         int bot_pit = bot.pit();
 869         if (bot_pit > max_pit) {
 870                 // FIXME: Why does this happen?
 871                 LYXERR0("bottom pit is greater that max pit: "
 872                         << bot_pit << " > " << max_pit);
 873                 bot_pit = max_pit;
 874         }
 875
 876         if (bot_pit == tm.first().first - 1)
 877                 tm.newParMetricsUp();
 878         else if (bot_pit == tm.last().first + 1)
 879                 tm.newParMetricsDown();
 880
 881         if (tm.contains(bot_pit)) {
 882                 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
 883                 LBUFERR(!pm.rows().empty());
 884                 // FIXME: smooth scrolling doesn't work in mathed.
 885                 CursorSlice const & cs = dit.innerTextSlice();
 886                 int offset = coordOffset(dit).y_;
 887                 int ypos = pm.position() + offset;
 888                 Dimension const & row_dim =
 889                         pm.getRow(cs.pos(), dit.boundary()).dimension();
 890                 int scrolled = 0;
 891                 if (recenter)
 892                         scrolled = scroll(ypos - height_/2);
 893
 894                 // We try to visualize the whole row, if the row height is larger than
 895                 // the screen height, we scroll to a heuristic value of height_ / 4.
 896                 // FIXME: This heuristic value should be replaced by a recursive search
 897                 // for a row in the inset that can be visualized completely.
 898                 else if (row_dim.height() > height_) {
 899                         if (ypos < defaultRowHeight())
 900                                 scrolled = scroll(ypos - height_ / 4);
 901                         else if (ypos > height_ - defaultRowHeight())
 902                                 scrolled = scroll(ypos - 3 * height_ / 4);
 903                 }
 904
 905                 // If the top part of the row falls of the screen, we scroll
 906                 // up to align the top of the row with the top of the screen.
 907                 else if (ypos - row_dim.ascent() < 0 && ypos < height_) {
 908                         int ynew = row_dim.ascent();
 909                         scrolled = scrollUp(ynew - ypos);
 910                 }
 911
 912                 // If the bottom of the row falls of the screen, we scroll down.
 913                 else if (ypos + row_dim.descent() > height_ && ypos > 0) {
 914                         int ynew = height_ - row_dim.descent();
 915                         scrolled = scrollDown(ypos - ynew);
 916                 }
 917
 918                 // else, nothing to do, the cursor is already visible so we just return.
 919                 return scrolled != 0;
 920         }
 921
 922         // fix inline completion position
 923         if (d->inlineCompletionPos_.fixIfBroken())
 924                 d->inlineCompletionPos_ = DocIterator();
 925
 926         tm.redoParagraph(bot_pit);
 927         ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
 928         int offset = coordOffset(dit).y_;
 929
 930         d->anchor_pit_ = bot_pit;
 931         CursorSlice const & cs = dit.innerTextSlice();
 932         Dimension const & row_dim =
 933                 pm.getRow(cs.pos(), dit.boundary()).dimension();
 934
 935         if (recenter)
 936                 d->anchor_ypos_ = height_/2;
 937         else if (d->anchor_pit_ == 0)
 938                 d->anchor_ypos_ = offset + pm.ascent();
 939         else if (d->anchor_pit_ == max_pit)
 940                 d->anchor_ypos_ = height_ - offset - row_dim.descent();
 941         else if (offset > height_)
 942                 d->anchor_ypos_ = height_ - offset - defaultRowHeight();
 943         else
 944                 d->anchor_ypos_ = defaultRowHeight() * 2;
 945
 946         return true;
 947 }
 948
 949
 950 void BufferView::makeDocumentClass()
 951 {
 952         DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
 953         buffer_.params().makeDocumentClass();
 954         updateDocumentClass(olddc);
 955 }
 956
 957
 958 void BufferView::updateDocumentClass(DocumentClassConstPtr olddc)
 959 {
 960         message(_("Converting document to new document class..."));
 961
 962         StableDocIterator backcur(d->cursor_);
 963         ErrorList & el = buffer_.errorList("Class Switch");
 964         cap::switchBetweenClasses(
 965                         olddc, buffer_.params().documentClassPtr(),
 966                         static_cast<InsetText &>(buffer_.inset()), el);
 967
 968         setCursor(backcur.asDocIterator(&buffer_));
 969
 970         buffer_.errors("Class Switch");
 971 }
 972
 973
 974 /** Return the change status at cursor position, taking in account the
 975  * status at each level of the document iterator (a table in a deleted
 976  * footnote is deleted).
 977  * When \param outer is true, the top slice is not looked at.
 978  */
 979 static Change::Type lookupChangeType(DocIterator const & dit, bool outer = false)
 980 {
 981         size_t const depth = dit.depth() - (outer ? 1 : 0);
 982
 983         for (size_t i = 0 ; i < depth ; ++i) {
 984                 CursorSlice const & slice = dit[i];
 985                 if (!slice.inset().inMathed()
 986                     && slice.pos() < slice.paragraph().size()) {
 987                         Change::Type const ch = slice.paragraph().lookupChange(slice.pos()).type;
 988                         if (ch != Change::UNCHANGED)
 989                                 return ch;
 990                 }
 991         }
 992         return Change::UNCHANGED;
 993 }
 994
 995
 996 bool BufferView::getStatus(FuncRequest const & cmd, FuncStatus & flag)
 997 {
 998         FuncCode const act = cmd.action();
 999
1000         // Can we use a readonly buffer?
1001         if (buffer_.isReadonly()
1002             && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1003             && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1004                 flag.message(from_utf8(N_("Document is read-only")));
1005                 flag.setEnabled(false);
1006                 return true;
1007         }
1008
1009         // Are we in a DELETED change-tracking region?
1010         if (lookupChangeType(d->cursor_, true) == Change::DELETED
1011             && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1012             && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1013                 flag.message(from_utf8(N_("This portion of the document is deleted.")));
1014                 flag.setEnabled(false);
1015                 return true;
1016         }
1017
1018         Cursor & cur = d->cursor_;
1019
1020         if (cur.getStatus(cmd, flag))
1021                 return true;
1022
1023         switch (act) {
1024
1025         // FIXME: This is a bit problematic because we don't check if this is
1026         // a document BufferView or not for these LFUNs. We probably have to
1027         // dispatch both to currentBufferView() and, if that fails,
1028         // to documentBufferView(); same as we do now for current Buffer and
1029         // document Buffer. Ideally those LFUN should go to Buffer as they
1030         // operate on the full Buffer and the cursor is only needed either for
1031         // an Undo record or to restore a cursor position. But we don't know
1032         // how to do that inside Buffer of course.
1033         case LFUN_BUFFER_PARAMS_APPLY:
1034         case LFUN_LAYOUT_MODULES_CLEAR:
1035         case LFUN_LAYOUT_MODULE_ADD:
1036         case LFUN_LAYOUT_RELOAD:
1037         case LFUN_TEXTCLASS_APPLY:
1038         case LFUN_TEXTCLASS_LOAD:
1039                 flag.setEnabled(!buffer_.isReadonly());
1040                 break;
1041
1042         case LFUN_UNDO:
1043                 // We do not use the LyXAction flag for readonly because Undo sets the
1044                 // buffer clean/dirty status by itself.
1045                 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasUndoStack());
1046                 break;
1047         case LFUN_REDO:
1048                 // We do not use the LyXAction flag for readonly because Redo sets the
1049                 // buffer clean/dirty status by itself.
1050                 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasRedoStack());
1051                 break;
1052         case LFUN_FILE_INSERT_PLAINTEXT_PARA:
1053         case LFUN_FILE_INSERT_PLAINTEXT: {
1054                 docstring const fname = cmd.argument();
1055                 if (!FileName::isAbsolute(to_utf8(fname))) {
1056                         flag.message(_("Absolute filename expected."));
1057                         return false;
1058                 }
1059                 flag.setEnabled(cur.inTexted());
1060                 break;
1061         }
1062         case LFUN_FILE_INSERT:
1063         case LFUN_BOOKMARK_SAVE:
1064                 // FIXME: Actually, these LFUNS should be moved to Text
1065                 flag.setEnabled(cur.inTexted());
1066                 break;
1067
1068         case LFUN_FONT_STATE:
1069         case LFUN_LABEL_INSERT:
1070         case LFUN_INFO_INSERT:
1071         case LFUN_PARAGRAPH_GOTO:
1072         case LFUN_NOTE_NEXT:
1073         case LFUN_REFERENCE_NEXT:
1074         case LFUN_WORD_FIND:
1075         case LFUN_WORD_FIND_FORWARD:
1076         case LFUN_WORD_FIND_BACKWARD:
1077         case LFUN_WORD_REPLACE:
1078         case LFUN_MARK_OFF:
1079         case LFUN_MARK_ON:
1080         case LFUN_MARK_TOGGLE:
1081         case LFUN_SCREEN_RECENTER:
1082         case LFUN_SCREEN_SHOW_CURSOR:
1083         case LFUN_BIBTEX_DATABASE_ADD:
1084         case LFUN_BIBTEX_DATABASE_DEL:
1085         case LFUN_STATISTICS:
1086         case LFUN_KEYMAP_OFF:
1087         case LFUN_KEYMAP_PRIMARY:
1088         case LFUN_KEYMAP_SECONDARY:
1089         case LFUN_KEYMAP_TOGGLE:
1090                 flag.setEnabled(true);
1091                 break;
1092
1093         case LFUN_WORD_FINDADV: {
1094                 FindAndReplaceOptions opt;
1095                 istringstream iss(to_utf8(cmd.argument()));
1096                 iss >> opt;
1097                 flag.setEnabled(opt.repl_buf_name.empty()
1098                                 || !buffer_.isReadonly());
1099         }
1100
1101         case LFUN_LABEL_GOTO: {
1102                 flag.setEnabled(!cmd.argument().empty()
1103                     || getInsetByCode<InsetRef>(cur, REF_CODE));
1104                 break;
1105         }
1106
1107         case LFUN_CHANGES_TRACK:
1108                 flag.setEnabled(true);
1109                 flag.setOnOff(buffer_.params().track_changes);
1110                 break;
1111
1112         case LFUN_CHANGES_OUTPUT:
1113                 flag.setEnabled(true);
1114                 flag.setOnOff(buffer_.params().output_changes);
1115                 break;
1116
1117         case LFUN_CHANGES_MERGE:
1118         case LFUN_CHANGE_NEXT:
1119         case LFUN_CHANGE_PREVIOUS:
1120         case LFUN_ALL_CHANGES_ACCEPT:
1121         case LFUN_ALL_CHANGES_REJECT:
1122                 // TODO: context-sensitive enabling of LFUNs
1123                 // In principle, these command should only be enabled if there
1124                 // is a change in the document. However, without proper
1125                 // optimizations, this will inevitably result in poor performance.
1126                 flag.setEnabled(true);
1127                 break;
1128
1129         case LFUN_BUFFER_TOGGLE_COMPRESSION: {
1130                 flag.setOnOff(buffer_.params().compressed);
1131                 break;
1132         }
1133
1134         case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC: {
1135                 flag.setOnOff(buffer_.params().output_sync);
1136                 break;
1137         }
1138
1139         case LFUN_SCREEN_UP:
1140         case LFUN_SCREEN_DOWN:
1141         case LFUN_SCROLL:
1142         case LFUN_SCREEN_UP_SELECT:
1143         case LFUN_SCREEN_DOWN_SELECT:
1144         case LFUN_INSET_FORALL:
1145                 flag.setEnabled(true);
1146                 break;
1147
1148         case LFUN_LAYOUT_TABULAR:
1149                 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
1150                 break;
1151
1152         case LFUN_LAYOUT:
1153                 flag.setEnabled(!cur.inset().forcePlainLayout(cur.idx()));
1154                 break;
1155
1156         case LFUN_LAYOUT_PARAGRAPH:
1157                 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
1158                 break;
1159
1160         case LFUN_BRANCH_ADD_INSERT:
1161                 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1162                 break;
1163
1164         case LFUN_DIALOG_SHOW_NEW_INSET:
1165                 // FIXME: this is wrong, but I do not understand the
1166                 // intent (JMarc)
1167                 if (cur.inset().lyxCode() == CAPTION_CODE)
1168                         return cur.inset().getStatus(cur, cmd, flag);
1169                 // FIXME we should consider passthru paragraphs too.
1170                 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1171                 break;
1172
1173         case LFUN_CITATION_INSERT: {
1174                 FuncRequest fr(LFUN_INSET_INSERT, "citation");
1175                 // FIXME: This could turn in a recursive hell.
1176                 // Shouldn't we use Buffer::getStatus() instead?
1177                 flag.setEnabled(lyx::getStatus(fr).enabled());
1178                 break;
1179         }
1180         case LFUN_INSET_APPLY: {
1181                 string const name = cmd.getArg(0);
1182                 Inset * inset = editedInset(name);
1183                 if (inset) {
1184                         FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1185                         if (!inset->getStatus(cur, fr, flag)) {
1186                                 // Every inset is supposed to handle this
1187                                 LASSERT(false, break);
1188                         }
1189                 } else {
1190                         FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1191                         flag = lyx::getStatus(fr);
1192                 }
1193                 break;
1194         }
1195
1196         default:
1197                 return false;
1198         }
1199
1200         return true;
1201 }
1202
1203
1204 Inset * BufferView::editedInset(string const & name) const
1205 {
1206         map<string, Inset *>::const_iterator it = d->edited_insets_.find(name);
1207         return it == d->edited_insets_.end() ? 0 : it->second;
1208 }
1209
1210
1211 void BufferView::editInset(string const & name, Inset * inset)
1212 {
1213         d->edited_insets_[name] = inset;
1214 }
1215
1216
1217 void BufferView::dispatch(FuncRequest const & cmd, DispatchResult & dr)
1218 {
1219         LYXERR(Debug::ACTION, "BufferView::dispatch: cmd: " << cmd);
1220
1221         string const argument = to_utf8(cmd.argument());
1222         Cursor & cur = d->cursor_;
1223
1224         // Don't dispatch function that does not apply to internal buffers.
1225         if (buffer_.isInternal()
1226             && lyxaction.funcHasFlag(cmd.action(), LyXAction::NoInternal))
1227                 return;
1228
1229         // We'll set this back to false if need be.
1230         bool dispatched = true;
1231         buffer_.undo().beginUndoGroup();
1232
1233         FuncCode const act = cmd.action();
1234         switch (act) {
1235
1236         case LFUN_BUFFER_PARAMS_APPLY: {
1237                 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1238                 cur.recordUndoFullDocument();
1239                 istringstream ss(to_utf8(cmd.argument()));
1240                 Lexer lex;
1241                 lex.setStream(ss);
1242                 int const unknown_tokens = buffer_.readHeader(lex);
1243                 if (unknown_tokens != 0) {
1244                         LYXERR0("Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1245                                                 << unknown_tokens << " unknown token"
1246                                                 << (unknown_tokens == 1 ? "" : "s"));
1247                 }
1248                 updateDocumentClass(olddc);
1249
1250                 // We are most certainly here because of a change in the document
1251                 // It is then better to make sure that all dialogs are in sync with
1252                 // current document settings.
1253                 dr.screenUpdate(Update::Force | Update::FitCursor);
1254                 dr.forceBufferUpdate();
1255                 break;
1256         }
1257
1258         case LFUN_LAYOUT_MODULES_CLEAR: {
1259                 cur.recordUndoFullDocument();
1260                 buffer_.params().clearLayoutModules();
1261                 makeDocumentClass();
1262                 dr.screenUpdate(Update::Force);
1263                 dr.forceBufferUpdate();
1264                 break;
1265         }
1266
1267         case LFUN_LAYOUT_MODULE_ADD: {
1268                 BufferParams const & params = buffer_.params();
1269                 if (!params.layoutModuleCanBeAdded(argument)) {
1270                         LYXERR0("Module `" << argument <<
1271                                 "' cannot be added due to failed requirements or "
1272                                 "conflicts with installed modules.");
1273                         break;
1274                 }
1275                 cur.recordUndoFullDocument();
1276                 buffer_.params().addLayoutModule(argument);
1277                 makeDocumentClass();
1278                 dr.screenUpdate(Update::Force);
1279                 dr.forceBufferUpdate();
1280                 break;
1281         }
1282
1283         case LFUN_TEXTCLASS_APPLY: {
1284                 // since this shortcircuits, the second call is made only if
1285                 // the first fails
1286                 bool const success =
1287                         LayoutFileList::get().load(argument, buffer_.temppath()) ||
1288                         LayoutFileList::get().load(argument, buffer_.filePath());
1289                 if (!success) {
1290                         docstring s = bformat(_("The document class `%1$s' "
1291                                                  "could not be loaded."), from_utf8(argument));
1292                         frontend::Alert::error(_("Could not load class"), s);
1293                         break;
1294                 }
1295
1296                 LayoutFile const * old_layout = buffer_.params().baseClass();
1297                 LayoutFile const * new_layout = &(LayoutFileList::get()[argument]);
1298
1299                 if (old_layout == new_layout)
1300                         // nothing to do
1301                         break;
1302
1303                 // Save the old, possibly modular, layout for use in conversion.
1304                 cur.recordUndoFullDocument();
1305                 buffer_.params().setBaseClass(argument);
1306                 makeDocumentClass();
1307                 dr.screenUpdate(Update::Force);
1308                 dr.forceBufferUpdate();
1309                 break;
1310         }
1311
1312         case LFUN_TEXTCLASS_LOAD: {
1313                 // since this shortcircuits, the second call is made only if
1314                 // the first fails
1315                 bool const success =
1316                         LayoutFileList::get().load(argument, buffer_.temppath()) ||
1317                         LayoutFileList::get().load(argument, buffer_.filePath());
1318                 if (!success) {
1319                         docstring s = bformat(_("The document class `%1$s' "
1320                                                  "could not be loaded."), from_utf8(argument));
1321                         frontend::Alert::error(_("Could not load class"), s);
1322                 }
1323                 break;
1324         }
1325
1326         case LFUN_LAYOUT_RELOAD: {
1327                 LayoutFileIndex bc = buffer_.params().baseClassID();
1328                 LayoutFileList::get().reset(bc);
1329                 buffer_.params().setBaseClass(bc);
1330                 makeDocumentClass();
1331                 dr.screenUpdate(Update::Force);
1332                 dr.forceBufferUpdate();
1333                 break;
1334         }
1335
1336         case LFUN_UNDO:
1337                 dr.setMessage(_("Undo"));
1338                 cur.clearSelection();
1339                 if (!cur.textUndo())
1340                         dr.setMessage(_("No further undo information"));
1341                 else
1342                         dr.screenUpdate(Update::Force | Update::FitCursor);
1343                 dr.forceBufferUpdate();
1344                 break;
1345
1346         case LFUN_REDO:
1347                 dr.setMessage(_("Redo"));
1348                 cur.clearSelection();
1349                 if (!cur.textRedo())
1350                         dr.setMessage(_("No further redo information"));
1351                 else
1352                         dr.screenUpdate(Update::Force | Update::FitCursor);
1353                 dr.forceBufferUpdate();
1354                 break;
1355
1356         case LFUN_FONT_STATE:
1357                 dr.setMessage(cur.currentState());
1358                 break;
1359
1360         case LFUN_BOOKMARK_SAVE:
1361                 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1362                 break;
1363
1364         case LFUN_LABEL_GOTO: {
1365                 docstring label = cmd.argument();
1366                 if (label.empty()) {
1367                         InsetRef * inset =
1368                                 getInsetByCode<InsetRef>(cur, REF_CODE);
1369                         if (inset) {
1370                                 label = inset->getParam("reference");
1371                                 // persistent=false: use temp_bookmark
1372                                 saveBookmark(0);
1373                         }
1374                 }
1375                 if (!label.empty()) {
1376                         gotoLabel(label);
1377                         // at the moment, this is redundant, since gotoLabel will
1378                         // eventually call LFUN_PARAGRAPH_GOTO, but it seems best
1379                         // to have it here.
1380                         dr.screenUpdate(Update::Force | Update::FitCursor);
1381                 }
1382                 break;
1383         }
1384
1385         case LFUN_PARAGRAPH_GOTO: {
1386                 int const id = convert<int>(cmd.getArg(0));
1387                 int const pos = convert<int>(cmd.getArg(1));
1388                 int i = 0;
1389                 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1390                         b = theBufferList().next(b)) {
1391
1392                         DocIterator dit = b->getParFromID(id);
1393                         if (dit.atEnd()) {
1394                                 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1395                                 ++i;
1396                                 continue;
1397                         }
1398                         LYXERR(Debug::INFO, "Paragraph " << dit.paragraph().id()
1399                                 << " found in buffer `"
1400                                 << b->absFileName() << "'.");
1401
1402                         if (b == &buffer_) {
1403                                 // Set the cursor
1404                                 dit.pos() = pos;
1405                                 setCursor(dit);
1406                                 dr.screenUpdate(Update::Force | Update::FitCursor);
1407                         } else {
1408                                 // Switch to other buffer view and resend cmd
1409                                 lyx::dispatch(FuncRequest(
1410                                         LFUN_BUFFER_SWITCH, b->absFileName()));
1411                                 lyx::dispatch(cmd);
1412                         }
1413                         break;
1414                 }
1415                 break;
1416         }
1417
1418         case LFUN_NOTE_NEXT:
1419                 gotoInset(this, NOTE_CODE, false);
1420                 break;
1421
1422         case LFUN_REFERENCE_NEXT: {
1423                 vector<InsetCode> tmp;
1424                 tmp.push_back(LABEL_CODE);
1425                 tmp.push_back(REF_CODE);
1426                 gotoInset(this, tmp, true);
1427                 break;
1428         }
1429
1430         case LFUN_CHANGES_TRACK:
1431                 buffer_.params().track_changes = !buffer_.params().track_changes;
1432                 break;
1433
1434         case LFUN_CHANGES_OUTPUT:
1435                 buffer_.params().output_changes = !buffer_.params().output_changes;
1436                 if (buffer_.params().output_changes) {
1437                         bool dvipost    = LaTeXFeatures::isAvailable("dvipost");
1438                         bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1439                                           LaTeXFeatures::isAvailable("xcolor");
1440
1441                         if (!dvipost && !xcolorulem) {
1442                                 Alert::warning(_("Changes not shown in LaTeX output"),
1443                                                _("Changes will not be highlighted in LaTeX output, "
1444                                                  "because neither dvipost nor xcolor/ulem are installed.\n"
1445                                                  "Please install these packages or redefine "
1446                                                  "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1447                         } else if (!xcolorulem) {
1448                                 Alert::warning(_("Changes not shown in LaTeX output"),
1449                                                _("Changes will not be highlighted in LaTeX output "
1450                                                  "when using pdflatex, because xcolor and ulem are not installed.\n"
1451                                                  "Please install both packages or redefine "
1452                                                  "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1453                         }
1454                 }
1455                 break;
1456
1457         case LFUN_CHANGE_NEXT:
1458                 findNextChange(this);
1459                 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1460                 dr.screenUpdate(Update::Force | Update::FitCursor);
1461                 break;
1462
1463         case LFUN_CHANGE_PREVIOUS:
1464                 findPreviousChange(this);
1465                 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1466                 dr.screenUpdate(Update::Force | Update::FitCursor);
1467                 break;
1468
1469         case LFUN_CHANGES_MERGE:
1470                 if (findNextChange(this) || findPreviousChange(this)) {
1471                         dr.screenUpdate(Update::Force | Update::FitCursor);
1472                         dr.forceBufferUpdate();
1473                         showDialog("changes");
1474                 }
1475                 break;
1476
1477         case LFUN_ALL_CHANGES_ACCEPT:
1478                 // select complete document
1479                 cur.reset();
1480                 cur.selHandle(true);
1481                 buffer_.text().cursorBottom(cur);
1482                 // accept everything in a single step to support atomic undo
1483                 buffer_.text().acceptOrRejectChanges(cur, Text::ACCEPT);
1484                 cur.resetAnchor();
1485                 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1486                 dr.screenUpdate(Update::Force | Update::FitCursor);
1487                 dr.forceBufferUpdate();
1488                 break;
1489
1490         case LFUN_ALL_CHANGES_REJECT:
1491                 // select complete document
1492                 cur.reset();
1493                 cur.selHandle(true);
1494                 buffer_.text().cursorBottom(cur);
1495                 // reject everything in a single step to support atomic undo
1496                 // Note: reject does not work recursively; the user may have to repeat the operation
1497                 buffer_.text().acceptOrRejectChanges(cur, Text::REJECT);
1498                 cur.resetAnchor();
1499                 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1500                 dr.screenUpdate(Update::Force | Update::FitCursor);
1501                 dr.forceBufferUpdate();
1502                 break;
1503
1504         case LFUN_WORD_FIND_FORWARD:
1505         case LFUN_WORD_FIND_BACKWARD: {
1506                 // FIXME THREAD
1507                 // Would it maybe be better if this variable were view specific anyway?
1508                 static docstring last_search;
1509                 docstring searched_string;
1510
1511                 if (!cmd.argument().empty()) {
1512                         last_search = cmd.argument();
1513                         searched_string = cmd.argument();
1514                 } else {
1515                         searched_string = last_search;
1516                 }
1517
1518                 if (searched_string.empty())
1519                         break;
1520
1521                 bool const fw = act == LFUN_WORD_FIND_FORWARD;
1522                 docstring const data =
1523                         find2string(searched_string, true, false, fw);
1524                 bool found = lyxfind(this, FuncRequest(LFUN_WORD_FIND, data));
1525                 if (found) {
1526                         dr.screenUpdate(Update::Force | Update::FitCursor);
1527                         cur.dispatched();
1528                         dispatched = true;
1529                 } else {
1530                         cur.undispatched();
1531                         dispatched = false;
1532                 }
1533                 break;
1534         }
1535
1536         case LFUN_WORD_FIND: {
1537                 FuncRequest req = cmd;
1538                 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1539                         req = d->search_request_cache_;
1540                 if (req.argument().empty()) {
1541                         lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, "findreplace"));
1542                         break;
1543                 }
1544                 if (lyxfind(this, req)) {
1545                         dr.screenUpdate(Update::Force | Update::FitCursor);
1546                         cur.dispatched();
1547                         dispatched = true;
1548                 } else {
1549                         cur.undispatched();
1550                         dispatched = false;
1551                 }
1552                 d->search_request_cache_ = req;
1553                 break;
1554         }
1555
1556         case LFUN_WORD_REPLACE: {
1557                 bool has_deleted = false;
1558                 if (cur.selection()) {
1559                         DocIterator beg = cur.selectionBegin();
1560                         DocIterator end = cur.selectionEnd();
1561                         if (beg.pit() == end.pit()) {
1562                                 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1563                                         if (!cur.inMathed() && cur.paragraph().isDeleted(p)) {
1564                                                 has_deleted = true;
1565                                                 break;
1566                                         }
1567                                 }
1568                         }
1569                 }
1570                 if (lyxreplace(this, cmd, has_deleted)) {
1571                         dr.forceBufferUpdate();
1572                         dr.screenUpdate(Update::Force | Update::FitCursor);
1573                         cur.dispatched();
1574                         dispatched = true;
1575                 } else {
1576                         cur.undispatched();
1577                         dispatched = false;
1578                 }
1579                 break;
1580         }
1581
1582         case LFUN_WORD_FINDADV: {
1583                 FindAndReplaceOptions opt;
1584                 istringstream iss(to_utf8(cmd.argument()));
1585                 iss >> opt;
1586                 if (findAdv(this, opt)) {
1587                         dr.screenUpdate(Update::Force | Update::FitCursor);
1588                         cur.dispatched();
1589                         dispatched = true;
1590                 } else {
1591                         cur.undispatched();
1592                         dispatched = false;
1593                 }
1594                 break;
1595         }
1596
1597         case LFUN_MARK_OFF:
1598                 cur.clearSelection();
1599                 dr.setMessage(from_utf8(N_("Mark off")));
1600                 break;
1601
1602         case LFUN_MARK_ON:
1603                 cur.clearSelection();
1604                 cur.setMark(true);
1605                 dr.setMessage(from_utf8(N_("Mark on")));
1606                 break;
1607
1608         case LFUN_MARK_TOGGLE:
1609                 cur.setSelection(false);
1610                 if (cur.mark()) {
1611                         cur.setMark(false);
1612                         dr.setMessage(from_utf8(N_("Mark removed")));
1613                 } else {
1614                         cur.setMark(true);
1615                         dr.setMessage(from_utf8(N_("Mark set")));
1616                 }
1617                 cur.resetAnchor();
1618                 break;
1619
1620         case LFUN_SCREEN_SHOW_CURSOR:
1621                 showCursor();
1622                 break;
1623
1624         case LFUN_SCREEN_RECENTER:
1625                 recenter();
1626                 break;
1627
1628         case LFUN_BIBTEX_DATABASE_ADD: {
1629                 Cursor tmpcur = cur;
1630                 findInset(tmpcur, BIBTEX_CODE, false);
1631                 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1632                                                 BIBTEX_CODE);
1633                 if (inset) {
1634                         if (inset->addDatabase(cmd.argument())) {
1635                                 buffer_.invalidateBibfileCache();
1636                                 dr.forceBufferUpdate();
1637                         }
1638                 }
1639                 break;
1640         }
1641
1642         case LFUN_BIBTEX_DATABASE_DEL: {
1643                 Cursor tmpcur = cur;
1644                 findInset(tmpcur, BIBTEX_CODE, false);
1645                 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1646                                                 BIBTEX_CODE);
1647                 if (inset) {
1648                         if (inset->delDatabase(cmd.argument())) {
1649                                 buffer_.invalidateBibfileCache();
1650                                 dr.forceBufferUpdate();
1651                         }
1652                 }
1653                 break;
1654         }
1655
1656         case LFUN_STATISTICS: {
1657                 DocIterator from, to;
1658                 if (cur.selection()) {
1659                         from = cur.selectionBegin();
1660                         to = cur.selectionEnd();
1661                 } else {
1662                         from = doc_iterator_begin(&buffer_);
1663                         to = doc_iterator_end(&buffer_);
1664                 }
1665                 buffer_.updateStatistics(from, to);
1666                 int const words = buffer_.wordCount();
1667                 int const chars = buffer_.charCount(false);
1668                 int const chars_blanks = buffer_.charCount(true);
1669                 docstring message;
1670                 if (cur.selection())
1671                         message = _("Statistics for the selection:");
1672                 else
1673                         message = _("Statistics for the document:");
1674                 message += "\n\n";
1675                 if (words != 1)
1676                         message += bformat(_("%1$d words"), words);
1677                 else
1678                         message += _("One word");
1679                 message += "\n";
1680                 if (chars_blanks != 1)
1681                         message += bformat(_("%1$d characters (including blanks)"),
1682                                           chars_blanks);
1683                 else
1684                         message += _("One character (including blanks)");
1685                 message += "\n";
1686                 if (chars != 1)
1687                         message += bformat(_("%1$d characters (excluding blanks)"),
1688                                           chars);
1689                 else
1690                         message += _("One character (excluding blanks)");
1691
1692                 Alert::information(_("Statistics"), message);
1693         }
1694                 break;
1695
1696         case LFUN_BUFFER_TOGGLE_COMPRESSION:
1697                 // turn compression on/off
1698                 buffer_.params().compressed = !buffer_.params().compressed;
1699                 break;
1700
1701         case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
1702                 buffer_.params().output_sync = !buffer_.params().output_sync;
1703                 break;
1704
1705         case LFUN_SCREEN_UP:
1706         case LFUN_SCREEN_DOWN: {
1707                 Point p = getPos(cur);
1708                 // This code has been commented out to enable to scroll down a
1709                 // document, even if there are large insets in it (see bug #5465).
1710                 /*if (p.y_ < 0 || p.y_ > height_) {
1711                         // The cursor is off-screen so recenter before proceeding.
1712                         showCursor();
1713                         p = getPos(cur);
1714                 }*/
1715                 int const scrolled = scroll(act == LFUN_SCREEN_UP
1716                         ? -height_ : height_);
1717                 if (act == LFUN_SCREEN_UP && scrolled > -height_)
1718                         p = Point(0, 0);
1719                 if (act == LFUN_SCREEN_DOWN && scrolled < height_)
1720                         p = Point(width_, height_);
1721                 Cursor old = cur;
1722                 bool const in_texted = cur.inTexted();
1723                 cur.setCursor(doc_iterator_begin(cur.buffer()));
1724                 cur.selHandle(false);
1725                 buffer_.changed(true);
1726                 updateHoveredInset();
1727
1728                 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_,
1729                         true, act == LFUN_SCREEN_UP);
1730                 //FIXME: what to do with cur.x_target()?
1731                 bool update = in_texted && cur.bv().checkDepm(cur, old);
1732                 cur.finishUndo();
1733
1734                 if (update || cur.mark())
1735                         dr.screenUpdate(Update::Force | Update::FitCursor);
1736                 if (update)
1737                         dr.forceBufferUpdate();
1738                 break;
1739         }
1740
1741         case LFUN_SCROLL: {
1742                 string const scroll_type = cmd.getArg(0);
1743                 int scroll_step = 0;
1744                 if (scroll_type == "line")
1745                         scroll_step = d->scrollbarParameters_.single_step;
1746                 else if (scroll_type == "page")
1747                         scroll_step = d->scrollbarParameters_.page_step;
1748                 else
1749                         return;
1750                 string const scroll_quantity = cmd.getArg(1);
1751                 if (scroll_quantity == "up")
1752                         scrollUp(scroll_step);
1753                 else if (scroll_quantity == "down")
1754                         scrollDown(scroll_step);
1755                 else {
1756                         int const scroll_value = convert<int>(scroll_quantity);
1757                         if (scroll_value)
1758                                 scroll(scroll_step * scroll_value);
1759                 }
1760                 buffer_.changed(true);
1761                 updateHoveredInset();
1762                 dr.forceBufferUpdate();
1763                 break;
1764         }
1765
1766         case LFUN_SCREEN_UP_SELECT: {
1767                 // FIXME: why is the algorithm different from LFUN_SCREEN_UP?
1768                 cur.selHandle(true);
1769                 if (isTopScreen()) {
1770                         lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1771                         cur.finishUndo();
1772                         break;
1773                 }
1774                 int y = getPos(cur).y_;
1775                 int const ymin = y - height_ + defaultRowHeight();
1776                 while (y > ymin && cur.up())
1777                         y = getPos(cur).y_;
1778
1779                 cur.finishUndo();
1780                 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1781                 break;
1782         }
1783
1784         case LFUN_SCREEN_DOWN_SELECT: {
1785                 // FIXME: why is the algorithm different from LFUN_SCREEN_DOWN?
1786                 cur.selHandle(true);
1787                 if (isBottomScreen()) {
1788                         lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1789                         cur.finishUndo();
1790                         break;
1791                 }
1792                 int y = getPos(cur).y_;
1793                 int const ymax = y + height_ - defaultRowHeight();
1794                 while (y < ymax && cur.down())
1795                         y = getPos(cur).y_;
1796
1797                 cur.finishUndo();
1798                 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1799                 break;
1800         }
1801
1802
1803         // This would be in Buffer class if only Cursor did not
1804         // require a bufferview
1805         case LFUN_INSET_FORALL: {
1806                 docstring const name = from_utf8(cmd.getArg(0));
1807                 string const commandstr = cmd.getLongArg(1);
1808                 FuncRequest const fr = lyxaction.lookupFunc(commandstr);
1809
1810                 // an arbitrary number to limit number of iterations
1811                 const int max_iter = 100000;
1812                 int iterations = 0;
1813                 Cursor & cur = d->cursor_;
1814                 Cursor const savecur = cur;
1815                 cur.reset();
1816                 if (!cur.nextInset())
1817                         cur.forwardInset();
1818                 cur.beginUndoGroup();
1819                 while(cur && iterations < max_iter) {
1820                         Inset * const ins = cur.nextInset();
1821                         if (!ins)
1822                                 break;
1823                         docstring insname = ins->layoutName();
1824                         while (!insname.empty()) {
1825                                 if (insname == name || name == from_utf8("*")) {
1826                                         cur.recordUndo();
1827                                         lyx::dispatch(fr, dr);
1828                                         ++iterations;
1829                                         break;
1830                                 }
1831                                 size_t const i = insname.rfind(':');
1832                                 if (i == string::npos)
1833                                         break;
1834                                 insname = insname.substr(0, i);
1835                         }
1836                         // if we did not delete the inset, skip it
1837                         if (!cur.nextInset() || cur.nextInset() == ins)
1838                                 cur.forwardInset();
1839                 }
1840                 cur.endUndoGroup();
1841                 cur = savecur;
1842                 cur.fixIfBroken();
1843                 dr.screenUpdate(Update::Force);
1844                 dr.forceBufferUpdate();
1845
1846                 if (iterations >= max_iter) {
1847                         dr.setError(true);
1848                         dr.setMessage(bformat(_("`inset-forall' interrupted because number of actions is larger than %1$d"), max_iter));
1849                 } else
1850                         dr.setMessage(bformat(_("Applied \"%1$s\" to %2$d insets"), from_utf8(commandstr), iterations));
1851                 break;
1852         }
1853
1854
1855         case LFUN_BRANCH_ADD_INSERT: {
1856                 docstring branch_name = from_utf8(cmd.getArg(0));
1857                 if (branch_name.empty())
1858                         if (!Alert::askForText(branch_name, _("Branch name")) ||
1859                                                 branch_name.empty())
1860                                 break;
1861
1862                 DispatchResult drtmp;
1863                 buffer_.dispatch(FuncRequest(LFUN_BRANCH_ADD, branch_name), drtmp);
1864                 if (drtmp.error()) {
1865                         Alert::warning(_("Branch already exists"), drtmp.message());
1866                         break;
1867                 }
1868                 BranchList & branch_list = buffer_.params().branchlist();
1869                 vector<docstring> const branches =
1870                         getVectorFromString(branch_name, branch_list.separator());
1871                 for (vector<docstring>::const_iterator it = branches.begin();
1872                      it != branches.end(); ++it) {
1873                         branch_name = *it;
1874                         lyx::dispatch(FuncRequest(LFUN_BRANCH_INSERT, branch_name));
1875                 }
1876                 break;
1877         }
1878
1879         case LFUN_KEYMAP_OFF:
1880                 getIntl().keyMapOn(false);
1881                 break;
1882
1883         case LFUN_KEYMAP_PRIMARY:
1884                 getIntl().keyMapPrim();
1885                 break;
1886
1887         case LFUN_KEYMAP_SECONDARY:
1888                 getIntl().keyMapSec();
1889                 break;
1890
1891         case LFUN_KEYMAP_TOGGLE:
1892                 getIntl().toggleKeyMap();
1893                 break;
1894
1895         case LFUN_DIALOG_SHOW_NEW_INSET: {
1896                 string const name = cmd.getArg(0);
1897                 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
1898                 if (decodeInsetParam(name, data, buffer_))
1899                         lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
1900                 else
1901                         lyxerr << "Inset type '" << name <<
1902                         "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" <<  endl;
1903                 break;
1904         }
1905
1906         case LFUN_CITATION_INSERT: {
1907                 if (argument.empty()) {
1908                         lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
1909                         break;
1910                 }
1911                 // we can have one optional argument, delimited by '|'
1912                 // citation-insert <key>|<text_before>
1913                 // this should be enhanced to also support text_after
1914                 // and citation style
1915                 string arg = argument;
1916                 string opt1;
1917                 if (contains(argument, "|")) {
1918                         arg = token(argument, '|', 0);
1919                         opt1 = token(argument, '|', 1);
1920                 }
1921
1922                 // if our cursor is directly in front of or behind a citation inset,
1923                 // we will instead add the new key to it.
1924                 Inset * inset = cur.nextInset();
1925                 if (!inset || inset->lyxCode() != CITE_CODE)
1926                         inset = cur.prevInset();
1927                 if (inset && inset->lyxCode() == CITE_CODE) {
1928                         InsetCitation * icite = static_cast<InsetCitation *>(inset);
1929                         if (icite->addKey(arg)) {
1930                                 dr.forceBufferUpdate();
1931                                 dr.screenUpdate(Update::FitCursor | Update::SinglePar);
1932                                 if (!opt1.empty())
1933                                         LYXERR0("Discarding optional argument to citation-insert.");
1934                         }
1935                         dispatched = true;
1936                         break;
1937                 }
1938                 InsetCommandParams icp(CITE_CODE);
1939                 icp["key"] = from_utf8(arg);
1940                 if (!opt1.empty())
1941                         icp["before"] = from_utf8(opt1);
1942                 string icstr = InsetCommand::params2string(icp);
1943                 FuncRequest fr(LFUN_INSET_INSERT, icstr);
1944                 lyx::dispatch(fr);
1945                 break;
1946         }
1947
1948         case LFUN_INSET_APPLY: {
1949                 string const name = cmd.getArg(0);
1950                 Inset * inset = editedInset(name);
1951                 if (!inset) {
1952                         FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1953                         lyx::dispatch(fr);
1954                         break;
1955                 }
1956                 // put cursor in front of inset.
1957                 if (!setCursorFromInset(inset)) {
1958                         LASSERT(false, break);
1959                 }
1960                 cur.recordUndo();
1961                 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1962                 inset->dispatch(cur, fr);
1963                 dr.screenUpdate(cur.result().screenUpdate());
1964                 if (cur.result().needBufferUpdate())
1965                         dr.forceBufferUpdate();
1966                 break;
1967         }
1968
1969         // FIXME:
1970         // The change of language of buffer belongs to the Buffer class.
1971         // We have to do it here because we need a cursor for Undo.
1972         // When Undo::recordUndoBufferParams() is implemented someday
1973         // LFUN_BUFFER_LANGUAGE should be handled by the Buffer class.
1974         case LFUN_BUFFER_LANGUAGE: {
1975                 Language const * oldL = buffer_.params().language;
1976                 Language const * newL = languages.getLanguage(argument);
1977                 if (!newL || oldL == newL)
1978                         break;
1979                 if (oldL->rightToLeft() == newL->rightToLeft()) {
1980                         cur.recordUndoFullDocument();
1981                         buffer_.changeLanguage(oldL, newL);
1982                         cur.setCurrentFont();
1983                         dr.forceBufferUpdate();
1984                 }
1985                 break;
1986         }
1987
1988         case LFUN_FILE_INSERT_PLAINTEXT_PARA:
1989         case LFUN_FILE_INSERT_PLAINTEXT: {
1990                 bool const as_paragraph = (act == LFUN_FILE_INSERT_PLAINTEXT_PARA);
1991                 string const fname = to_utf8(cmd.argument());
1992                 if (!FileName::isAbsolute(fname))
1993                         dr.setMessage(_("Absolute filename expected."));
1994                 else
1995                         insertPlaintextFile(FileName(fname), as_paragraph);
1996                 break;
1997         }
1998
1999         default:
2000                 // OK, so try the Buffer itself...
2001                 buffer_.dispatch(cmd, dr);
2002                 dispatched = dr.dispatched();
2003                 break;
2004         }
2005
2006         buffer_.undo().endUndoGroup();
2007         dr.dispatched(dispatched);
2008 }
2009
2010
2011 docstring const BufferView::requestSelection()
2012 {
2013         Cursor & cur = d->cursor_;
2014
2015         LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
2016         if (!cur.selection()) {
2017                 d->xsel_cache_.set = false;
2018                 return docstring();
2019         }
2020
2021         LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
2022         if (!d->xsel_cache_.set ||
2023             cur.top() != d->xsel_cache_.cursor ||
2024             cur.realAnchor().top() != d->xsel_cache_.anchor)
2025         {
2026                 d->xsel_cache_.cursor = cur.top();
2027                 d->xsel_cache_.anchor = cur.realAnchor().top();
2028                 d->xsel_cache_.set = cur.selection();
2029                 return cur.selectionAsString(false);
2030         }
2031         return docstring();
2032 }
2033
2034
2035 void BufferView::clearSelection()
2036 {
2037         d->cursor_.clearSelection();
2038         // Clear the selection buffer. Otherwise a subsequent
2039         // middle-mouse-button paste would use the selection buffer,
2040         // not the more current external selection.
2041         cap::clearSelection();
2042         d->xsel_cache_.set = false;
2043         // The buffer did not really change, but this causes the
2044         // redraw we need because we cleared the selection above.
2045         buffer_.changed(false);
2046 }
2047
2048
2049 void BufferView::resize(int width, int height)
2050 {
2051         // Update from work area
2052         width_ = width;
2053         height_ = height;
2054
2055         // Clear the paragraph height cache.
2056         d->par_height_.clear();
2057         // Redo the metrics.
2058         updateMetrics();
2059 }
2060
2061
2062 Inset const * BufferView::getCoveringInset(Text const & text,
2063                 int x, int y) const
2064 {
2065         TextMetrics & tm = d->text_metrics_[&text];
2066         Inset * inset = tm.checkInsetHit(x, y);
2067         if (!inset)
2068                 return 0;
2069
2070         if (!inset->descendable(*this))
2071                 // No need to go further down if the inset is not
2072                 // descendable.
2073                 return inset;
2074
2075         size_t cell_number = inset->nargs();
2076         // Check all the inner cell.
2077         for (size_t i = 0; i != cell_number; ++i) {
2078                 Text const * inner_text = inset->getText(i);
2079                 if (inner_text) {
2080                         // Try deeper.
2081                         Inset const * inset_deeper =
2082                                 getCoveringInset(*inner_text, x, y);
2083                         if (inset_deeper)
2084                                 return inset_deeper;
2085                 }
2086         }
2087
2088         return inset;
2089 }
2090
2091
2092 void BufferView::updateHoveredInset() const
2093 {
2094         // Get inset under mouse, if there is one.
2095         int const x = d->mouse_position_cache_.x_;
2096         int const y = d->mouse_position_cache_.y_;
2097         Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
2098
2099         d->clickable_inset_ = covering_inset && covering_inset->clickable(x, y);
2100
2101         if (covering_inset == d->last_inset_)
2102                 // Same inset, no need to do anything...
2103                 return;
2104
2105         bool need_redraw = false;
2106         if (d->last_inset_) {
2107                 // Remove the hint on the last hovered inset (if any).
2108                 need_redraw |= d->last_inset_->setMouseHover(this, false);
2109                 d->last_inset_ = 0;
2110         }
2111
2112         if (covering_inset && covering_inset->setMouseHover(this, true)) {
2113                 need_redraw = true;
2114                 // Only the insets that accept the hover state, do
2115                 // clear the last_inset_, so only set the last_inset_
2116                 // member if the hovered setting is accepted.
2117                 d->last_inset_ = covering_inset;
2118         }
2119
2120         if (need_redraw) {
2121                 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
2122                                 << d->mouse_position_cache_.x_ << ", "
2123                                 << d->mouse_position_cache_.y_ << ")");
2124
2125                 d->update_strategy_ = DecorationUpdate;
2126
2127                 // This event (moving without mouse click) is not passed further.
2128                 // This should be changed if it is further utilized.
2129                 buffer_.changed(false);
2130         }
2131 }
2132
2133
2134 void BufferView::clearLastInset(Inset * inset) const
2135 {
2136         if (d->last_inset_ != inset) {
2137                 LYXERR0("Wrong last_inset!");
2138                 LATTEST(false);
2139         }
2140         d->last_inset_ = 0;
2141 }
2142
2143
2144 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
2145 {
2146         //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
2147
2148         // This is only called for mouse related events including
2149         // LFUN_FILE_OPEN generated by drag-and-drop.
2150         FuncRequest cmd = cmd0;
2151
2152         Cursor old = cursor();
2153         Cursor cur(*this);
2154         cur.push(buffer_.inset());
2155         cur.setSelection(d->cursor_.selection());
2156
2157         // Either the inset under the cursor or the
2158         // surrounding Text will handle this event.
2159
2160         // make sure we stay within the screen...
2161         cmd.set_y(min(max(cmd.y(), -1), height_));
2162
2163         d->mouse_position_cache_.x_ = cmd.x();
2164         d->mouse_position_cache_.y_ = cmd.y();
2165
2166         if (cmd.action() == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
2167                 updateHoveredInset();
2168                 return;
2169         }
2170
2171         // Build temporary cursor.
2172         Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x(), cmd.y());
2173
2174         // Put anchor at the same position.
2175         cur.resetAnchor();
2176
2177         cur.beginUndoGroup();
2178
2179         // Try to dispatch to an non-editable inset near this position
2180         // via the temp cursor. If the inset wishes to change the real
2181         // cursor it has to do so explicitly by using
2182         //  cur.bv().cursor() = cur;  (or similar)
2183         if (inset)
2184                 inset->dispatch(cur, cmd);
2185
2186         // Now dispatch to the temporary cursor. If the real cursor should
2187         // be modified, the inset's dispatch has to do so explicitly.
2188         if (!inset || !cur.result().dispatched())
2189                 cur.dispatch(cmd);
2190
2191         cur.endUndoGroup();
2192
2193         // Notify left insets
2194         if (cur != old) {
2195                 bool badcursor = old.fixIfBroken() | cur.fixIfBroken();
2196                 badcursor |= notifyCursorLeavesOrEnters(old, cur);
2197                 if (badcursor)
2198                         cursor().fixIfBroken();
2199         }
2200
2201         // Do we have a selection?
2202         theSelection().haveSelection(cursor().selection());
2203
2204         if (cur.needBufferUpdate()) {
2205                 cur.clearBufferUpdate();
2206                 buffer().updateBuffer();
2207         }
2208
2209         // If the command has been dispatched,
2210         if (cur.result().dispatched() || cur.result().screenUpdate())
2211                 processUpdateFlags(cur.result().screenUpdate());
2212 }
2213
2214
2215 int BufferView::minVisiblePart()
2216 {
2217         return 2 * defaultRowHeight();
2218 }
2219
2220
2221 int BufferView::scroll(int y)
2222 {
2223         if (y > 0)
2224                 return scrollDown(y);
2225         if (y < 0)
2226                 return scrollUp(-y);
2227         return 0;
2228 }
2229
2230
2231 int BufferView::scrollDown(int offset)
2232 {
2233         Text * text = &buffer_.text();
2234         TextMetrics & tm = d->text_metrics_[text];
2235         int const ymax = height_ + offset;
2236         while (true) {
2237                 pair<pit_type, ParagraphMetrics const *> last = tm.last();
2238                 int bottom_pos = last.second->position() + last.second->descent();
2239                 if (lyxrc.scroll_below_document)
2240                         bottom_pos += height_ - minVisiblePart();
2241                 if (last.first + 1 == int(text->paragraphs().size())) {
2242                         if (bottom_pos <= height_)
2243                                 return 0;
2244                         offset = min(offset, bottom_pos - height_);
2245                         break;
2246                 }
2247                 if (bottom_pos > ymax)
2248                         break;
2249                 tm.newParMetricsDown();
2250         }
2251         d->anchor_ypos_ -= offset;
2252         return -offset;
2253 }
2254
2255
2256 int BufferView::scrollUp(int offset)
2257 {
2258         Text * text = &buffer_.text();
2259         TextMetrics & tm = d->text_metrics_[text];
2260         int ymin = - offset;
2261         while (true) {
2262                 pair<pit_type, ParagraphMetrics const *> first = tm.first();
2263                 int top_pos = first.second->position() - first.second->ascent();
2264                 if (first.first == 0) {
2265                         if (top_pos >= 0)
2266                                 return 0;
2267                         offset = min(offset, - top_pos);
2268                         break;
2269                 }
2270                 if (top_pos < ymin)
2271                         break;
2272                 tm.newParMetricsUp();
2273         }
2274         d->anchor_ypos_ += offset;
2275         return offset;
2276 }
2277
2278
2279 void BufferView::setCursorFromRow(int row)
2280 {
2281         int tmpid;
2282         int tmppos;
2283         pit_type newpit = 0;
2284         pos_type newpos = 0;
2285
2286         buffer_.texrow().getIdFromRow(row, tmpid, tmppos);
2287
2288         bool posvalid = (tmpid != -1);
2289         if (posvalid) {
2290                 // we need to make sure that the row and position
2291                 // we got back are valid, because the buffer may well
2292                 // have changed since we last generated the LaTeX.
2293                 DocIterator dit = buffer_.getParFromID(tmpid);
2294                 if (dit == doc_iterator_end(&buffer_))
2295                         posvalid = false;
2296                 else if (dit.depth() > 1) {
2297                         // We are in an inset.
2298                         pos_type lastpos = dit.lastpos();
2299                         dit.pos() = tmppos > lastpos ? lastpos : tmppos;
2300                         setCursor(dit);
2301                         recenter();
2302                         return;
2303                 } else {
2304                         newpit = dit.pit();
2305                         // now have to check pos.
2306                         newpos = tmppos;
2307                         Paragraph const & par = buffer_.text().getPar(newpit);
2308                         if (newpos > par.size()) {
2309                                 LYXERR0("Requested position no longer valid.");
2310                                 newpos = par.size() - 1;
2311                         }
2312                 }
2313         }
2314         if (!posvalid) {
2315                 frontend::Alert::error(_("Inverse Search Failed"),
2316                         _("Invalid position requested by inverse search.\n"
2317                     "You need to update the viewed document."));
2318                 return;
2319         }
2320         d->cursor_.reset();
2321         buffer_.text().setCursor(d->cursor_, newpit, newpos);
2322         d->cursor_.setSelection(false);
2323         d->cursor_.resetAnchor();
2324         recenter();
2325 }
2326
2327
2328 bool BufferView::setCursorFromInset(Inset const * inset)
2329 {
2330         // are we already there?
2331         if (cursor().nextInset() == inset)
2332                 return true;
2333
2334         // Inset is not at cursor position. Find it in the document.
2335         Cursor cur(*this);
2336         cur.reset();
2337         while (cur && cur.nextInset() != inset)
2338                 cur.forwardInset();
2339
2340         if (cur) {
2341                 setCursor(cur);
2342                 return true;
2343         }
2344         return false;
2345 }
2346
2347
2348 void BufferView::gotoLabel(docstring const & label)
2349 {
2350         ListOfBuffers bufs = buffer().allRelatives();
2351         ListOfBuffers::iterator it = bufs.begin();
2352         for (; it != bufs.end(); ++it) {
2353                 Buffer const * buf = *it;
2354
2355                 // find label
2356                 Toc & toc = buf->tocBackend().toc("label");
2357                 TocIterator toc_it = toc.begin();
2358                 TocIterator end = toc.end();
2359                 for (; toc_it != end; ++toc_it) {
2360                         if (label == toc_it->str()) {
2361                                 lyx::dispatch(toc_it->action());
2362                                 return;
2363                         }
2364                 }
2365         }
2366 }
2367
2368
2369 TextMetrics const & BufferView::textMetrics(Text const * t) const
2370 {
2371         return const_cast<BufferView *>(this)->textMetrics(t);
2372 }
2373
2374
2375 TextMetrics & BufferView::textMetrics(Text const * t)
2376 {
2377         LBUFERR(t);
2378         TextMetricsCache::iterator tmc_it  = d->text_metrics_.find(t);
2379         if (tmc_it == d->text_metrics_.end()) {
2380                 tmc_it = d->text_metrics_.insert(
2381                         make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
2382         }
2383         return tmc_it->second;
2384 }
2385
2386
2387 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
2388                 pit_type pit) const
2389 {
2390         return textMetrics(t).parMetrics(pit);
2391 }
2392
2393
2394 int BufferView::workHeight() const
2395 {
2396         return height_;
2397 }
2398
2399
2400 void BufferView::setCursor(DocIterator const & dit)
2401 {
2402         d->cursor_.reset();
2403         size_t const n = dit.depth();
2404         for (size_t i = 0; i < n; ++i)
2405                 dit[i].inset().edit(d->cursor_, true);
2406
2407         d->cursor_.setCursor(dit);
2408         d->cursor_.setSelection(false);
2409         // FIXME
2410         // It seems on general grounds as if this is probably needed, but
2411         // it is not yet clear.
2412         // See bug #7394 and r38388.
2413         // d->cursor.resetAnchor();
2414 }
2415
2416
2417 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
2418 {
2419         // Would be wrong to delete anything if we have a selection.
2420         if (cur.selection())
2421                 return false;
2422
2423         bool need_anchor_change = false;
2424         bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
2425                 need_anchor_change);
2426
2427         if (need_anchor_change)
2428                 cur.resetAnchor();
2429
2430         if (!changed)
2431                 return false;
2432
2433         d->cursor_ = cur;
2434
2435         // we would rather not do this here, but it needs to be done before
2436         // the changed() signal is sent.
2437         buffer_.updateBuffer();
2438
2439         buffer_.changed(true);
2440         return true;
2441 }
2442
2443
2444 bool BufferView::mouseSetCursor(Cursor & cur, bool select)
2445 {
2446         LASSERT(&cur.bv() == this, return false);
2447
2448         if (!select)
2449                 // this event will clear selection so we save selection for
2450                 // persistent selection
2451                 cap::saveSelection(cursor());
2452
2453         d->cursor_.macroModeClose();
2454         // If a macro has been finalized, the cursor might have been broken
2455         cur.fixIfBroken();
2456
2457         // Has the cursor just left the inset?
2458         bool const leftinset = (&d->cursor_.inset() != &cur.inset());
2459         if (leftinset)
2460                 d->cursor_.fixIfBroken();
2461
2462         // FIXME: shift-mouse selection doesn't work well across insets.
2463         bool const do_selection =
2464                         select && &d->cursor_.normalAnchor().inset() == &cur.inset();
2465
2466         // do the dEPM magic if needed
2467         // FIXME: (1) move this to InsetText::notifyCursorLeaves?
2468         // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
2469         // the leftinset bool would not be necessary (badcursor instead).
2470         bool update = leftinset;
2471         if (!do_selection && d->cursor_.inTexted())
2472                 update |= checkDepm(cur, d->cursor_);
2473
2474         if (!do_selection)
2475                 d->cursor_.resetAnchor();
2476         d->cursor_.setCursor(cur);
2477         d->cursor_.boundary(cur.boundary());
2478         if (do_selection)
2479                 d->cursor_.setSelection();
2480         else
2481                 d->cursor_.clearSelection();
2482
2483         d->cursor_.finishUndo();
2484         d->cursor_.setCurrentFont();
2485         if (update)
2486                 cur.forceBufferUpdate();
2487         return update;
2488 }
2489
2490
2491 void BufferView::putSelectionAt(DocIterator const & cur,
2492                                 int length, bool backwards)
2493 {
2494         d->cursor_.clearSelection();
2495
2496         setCursor(cur);
2497
2498         if (length) {
2499                 if (backwards) {
2500                         d->cursor_.pos() += length;
2501                         d->cursor_.setSelection(d->cursor_, -length);
2502                 } else
2503                         d->cursor_.setSelection(d->cursor_, length);
2504         }
2505 }
2506
2507
2508 bool BufferView::selectIfEmpty(DocIterator & cur)
2509 {
2510         if ((cur.inTexted() && !cur.paragraph().empty())
2511             || (cur.inMathed() && !cur.cell().empty()))
2512                 return false;
2513
2514         pit_type const beg_pit = cur.pit();
2515         if (beg_pit > 0) {
2516                 // The paragraph associated to this item isn't
2517                 // the first one, so it can be selected
2518                 cur.backwardPos();
2519         } else {
2520                 // We have to resort to select the space between the
2521                 // end of this item and the begin of the next one
2522                 cur.forwardPos();
2523         }
2524         if (cur.empty()) {
2525                 // If it is the only item in the document,
2526                 // nothing can be selected
2527                 return false;
2528         }
2529         pit_type const end_pit = cur.pit();
2530         pos_type const end_pos = cur.pos();
2531         d->cursor_.clearSelection();
2532         d->cursor_.reset();
2533         d->cursor_.setCursor(cur);
2534         d->cursor_.pit() = beg_pit;
2535         d->cursor_.pos() = 0;
2536         d->cursor_.setSelection(false);
2537         d->cursor_.resetAnchor();
2538         d->cursor_.pit() = end_pit;
2539         d->cursor_.pos() = end_pos;
2540         d->cursor_.setSelection();
2541         return true;
2542 }
2543
2544
2545 Cursor & BufferView::cursor()
2546 {
2547         return d->cursor_;
2548 }
2549
2550
2551 Cursor const & BufferView::cursor() const
2552 {
2553         return d->cursor_;
2554 }
2555
2556
2557 pit_type BufferView::anchor_ref() const
2558 {
2559         return d->anchor_pit_;
2560 }
2561
2562
2563 bool BufferView::singleParUpdate()
2564 {
2565         Text & buftext = buffer_.text();
2566         pit_type const bottom_pit = d->cursor_.bottom().pit();
2567         TextMetrics & tm = textMetrics(&buftext);
2568         int old_height = tm.parMetrics(bottom_pit).height();
2569
2570         // make sure inline completion pointer is ok
2571         if (d->inlineCompletionPos_.fixIfBroken())
2572                 d->inlineCompletionPos_ = DocIterator();
2573
2574         // In Single Paragraph mode, rebreak only
2575         // the (main text, not inset!) paragraph containing the cursor.
2576         // (if this paragraph contains insets etc., rebreaking will
2577         // recursively descend)
2578         tm.redoParagraph(bottom_pit);
2579         ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
2580         if (pm.height() != old_height)
2581                 // Paragraph height has changed so we cannot proceed to
2582                 // the singlePar optimisation.
2583                 return false;
2584
2585         d->update_strategy_ = SingleParUpdate;
2586
2587         LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
2588                 << " y2: " << pm.position() + pm.descent()
2589                 << " pit: " << bottom_pit
2590                 << " singlepar: 1");
2591         return true;
2592 }
2593
2594
2595 void BufferView::updateMetrics()
2596 {
2597         if (height_ == 0 || width_ == 0)
2598                 return;
2599
2600         Text & buftext = buffer_.text();
2601         pit_type const npit = int(buftext.paragraphs().size());
2602
2603         // Clear out the position cache in case of full screen redraw,
2604         d->coord_cache_.clear();
2605
2606         // Clear out paragraph metrics to avoid having invalid metrics
2607         // in the cache from paragraphs not relayouted below
2608         // The complete text metrics will be redone.
2609         d->text_metrics_.clear();
2610
2611         TextMetrics & tm = textMetrics(&buftext);
2612
2613         // make sure inline completion pointer is ok
2614         if (d->inlineCompletionPos_.fixIfBroken())
2615                 d->inlineCompletionPos_ = DocIterator();
2616
2617         if (d->anchor_pit_ >= npit)
2618                 // The anchor pit must have been deleted...
2619                 d->anchor_pit_ = npit - 1;
2620
2621         // Rebreak anchor paragraph.
2622         tm.redoParagraph(d->anchor_pit_);
2623         ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
2624
2625         // position anchor
2626         if (d->anchor_pit_ == 0) {
2627                 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
2628
2629                 // Complete buffer visible? Then it's easy.
2630                 if (scrollRange == 0)
2631                         d->anchor_ypos_ = anchor_pm.ascent();
2632
2633                 // FIXME: Some clever handling needed to show
2634                 // the _first_ paragraph up to the top if the cursor is
2635                 // in the first line.
2636         }
2637         anchor_pm.setPosition(d->anchor_ypos_);
2638
2639         LYXERR(Debug::PAINTING, "metrics: "
2640                 << " anchor pit = " << d->anchor_pit_
2641                 << " anchor ypos = " << d->anchor_ypos_);
2642
2643         // Redo paragraphs above anchor if necessary.
2644         int y1 = d->anchor_ypos_ - anchor_pm.ascent();
2645         // We are now just above the anchor paragraph.
2646         pit_type pit1 = d->anchor_pit_ - 1;
2647         for (; pit1 >= 0 && y1 >= 0; --pit1) {
2648                 tm.redoParagraph(pit1);
2649                 ParagraphMetrics & pm = tm.par_metrics_[pit1];
2650                 y1 -= pm.descent();
2651                 // Save the paragraph position in the cache.
2652                 pm.setPosition(y1);
2653                 y1 -= pm.ascent();
2654         }
2655
2656         // Redo paragraphs below the anchor if necessary.
2657         int y2 = d->anchor_ypos_ + anchor_pm.descent();
2658         // We are now just below the anchor paragraph.
2659         pit_type pit2 = d->anchor_pit_ + 1;
2660         for (; pit2 < npit && y2 <= height_; ++pit2) {
2661                 tm.redoParagraph(pit2);
2662                 ParagraphMetrics & pm = tm.par_metrics_[pit2];
2663                 y2 += pm.ascent();
2664                 // Save the paragraph position in the cache.
2665                 pm.setPosition(y2);
2666                 y2 += pm.descent();
2667         }
2668
2669         LYXERR(Debug::PAINTING, "Metrics: "
2670                 << " anchor pit = " << d->anchor_pit_
2671                 << " anchor ypos = " << d->anchor_ypos_
2672                 << " y1 = " << y1
2673                 << " y2 = " << y2
2674                 << " pit1 = " << pit1
2675                 << " pit2 = " << pit2);
2676
2677         d->update_strategy_ = FullScreenUpdate;
2678
2679         if (lyxerr.debugging(Debug::WORKAREA)) {
2680                 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
2681                 d->coord_cache_.dump();
2682         }
2683 }
2684
2685
2686 void BufferView::insertLyXFile(FileName const & fname)
2687 {
2688         LASSERT(d->cursor_.inTexted(), return);
2689
2690         // Get absolute path of file and add ".lyx"
2691         // to the filename if necessary
2692         FileName filename = fileSearch(string(), fname.absFileName(), "lyx");
2693
2694         docstring const disp_fn = makeDisplayPath(filename.absFileName());
2695         // emit message signal.
2696         message(bformat(_("Inserting document %1$s..."), disp_fn));
2697
2698         docstring res;
2699         Buffer buf(filename.absFileName(), false);
2700         if (buf.loadLyXFile() == Buffer::ReadSuccess) {
2701                 ErrorList & el = buffer_.errorList("Parse");
2702                 // Copy the inserted document error list into the current buffer one.
2703                 el = buf.errorList("Parse");
2704                 buffer_.undo().recordUndo(d->cursor_);
2705                 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
2706                                              buf.params().documentClassPtr(), el);
2707                 res = _("Document %1$s inserted.");
2708         } else {
2709                 res = _("Could not insert document %1$s");
2710         }
2711
2712         buffer_.changed(true);
2713         // emit message signal.
2714         message(bformat(res, disp_fn));
2715 }
2716
2717
2718 Point BufferView::coordOffset(DocIterator const & dit) const
2719 {
2720         int x = 0;
2721         int y = 0;
2722         int lastw = 0;
2723
2724         // Addup contribution of nested insets, from inside to outside,
2725         // keeping the outer paragraph for a special handling below
2726         for (size_t i = dit.depth() - 1; i >= 1; --i) {
2727                 CursorSlice const & sl = dit[i];
2728                 int xx = 0;
2729                 int yy = 0;
2730
2731                 // get relative position inside sl.inset()
2732                 sl.inset().cursorPos(*this, sl, dit.boundary() && (i + 1 == dit.depth()), xx, yy);
2733
2734                 // Make relative position inside of the edited inset relative to sl.inset()
2735                 x += xx;
2736                 y += yy;
2737
2738                 // In case of an RTL inset, the edited inset will be positioned to the left
2739                 // of xx:yy
2740                 if (sl.text()) {
2741                         bool boundary_i = dit.boundary() && i + 1 == dit.depth();
2742                         bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2743                         if (rtl)
2744                                 x -= lastw;
2745                 }
2746
2747                 // remember width for the case that sl.inset() is positioned in an RTL inset
2748                 if (i && dit[i - 1].text()) {
2749                         // If this Inset is inside a Text Inset, retrieve the Dimension
2750                         // from the containing text instead of using Inset::dimension() which
2751                         // might not be implemented.
2752                         // FIXME (Abdel 23/09/2007): this is a bit messy because of the
2753                         // elimination of Inset::dim_ cache. This coordOffset() method needs
2754                         // to be rewritten in light of the new design.
2755                         Dimension const & dim = parMetrics(dit[i - 1].text(),
2756                                 dit[i - 1].pit()).insetDimension(&sl.inset());
2757                         lastw = dim.wid;
2758                 } else {
2759                         Dimension const dim = sl.inset().dimension(*this);
2760                         lastw = dim.wid;
2761                 }
2762
2763                 //lyxerr << "Cursor::getPos, i: "
2764                 // << i << " x: " << xx << " y: " << y << endl;
2765         }
2766
2767         // Add contribution of initial rows of outermost paragraph
2768         CursorSlice const & sl = dit[0];
2769         TextMetrics const & tm = textMetrics(sl.text());
2770         ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2771
2772         LBUFERR(!pm.rows().empty());
2773         y -= pm.rows()[0].ascent();
2774 #if 1
2775         // FIXME: document this mess
2776         size_t rend;
2777         if (sl.pos() > 0 && dit.depth() == 1) {
2778                 int pos = sl.pos();
2779                 if (pos && dit.boundary())
2780                         --pos;
2781 //              lyxerr << "coordOffset: boundary:" << dit.boundary() << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
2782                 rend = pm.pos2row(pos);
2783         } else
2784                 rend = pm.pos2row(sl.pos());
2785 #else
2786         size_t rend = pm.pos2row(sl.pos());
2787 #endif
2788         for (size_t rit = 0; rit != rend; ++rit)
2789                 y += pm.rows()[rit].height();
2790         y += pm.rows()[rend].ascent();
2791
2792         TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
2793
2794         // Make relative position from the nested inset now bufferview absolute.
2795         int xx = bottom_tm.cursorX(dit.bottom(), dit.boundary() && dit.depth() == 1);
2796         x += xx;
2797
2798         // In the RTL case place the nested inset at the left of the cursor in
2799         // the outer paragraph
2800         bool boundary_1 = dit.boundary() && 1 == dit.depth();
2801         bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
2802         if (rtl)
2803                 x -= lastw;
2804
2805         return Point(x, y);
2806 }
2807
2808
2809 Point BufferView::getPos(DocIterator const & dit) const
2810 {
2811         if (!paragraphVisible(dit))
2812                 return Point(-1, -1);
2813
2814         CursorSlice const & bot = dit.bottom();
2815         TextMetrics const & tm = textMetrics(bot.text());
2816
2817         // offset from outer paragraph
2818         Point p = coordOffset(dit);
2819         p.y_ += tm.parMetrics(bot.pit()).position();
2820         return p;
2821 }
2822
2823
2824 bool BufferView::paragraphVisible(DocIterator const & dit) const
2825 {
2826         CursorSlice const & bot = dit.bottom();
2827         TextMetrics const & tm = textMetrics(bot.text());
2828
2829         return tm.contains(bot.pit());
2830 }
2831
2832
2833 void BufferView::cursorPosAndHeight(Point & p, int & h) const
2834 {
2835         Cursor const & cur = cursor();
2836         Font const font = cur.getFont();
2837         frontend::FontMetrics const & fm = theFontMetrics(font);
2838         int const asc = fm.maxAscent();
2839         int const des = fm.maxDescent();
2840         h = asc + des;
2841         p = getPos(cur);
2842         p.y_ -= asc;
2843 }
2844
2845
2846 bool BufferView::cursorInView(Point const & p, int h) const
2847 {
2848         Cursor const & cur = cursor();
2849         // does the cursor touch the screen ?
2850         if (p.y_ + h < 0 || p.y_ >= workHeight() || !paragraphVisible(cur))
2851                 return false;
2852         return true;
2853 }
2854
2855
2856 void BufferView::draw(frontend::Painter & pain)
2857 {
2858         if (height_ == 0 || width_ == 0)
2859                 return;
2860         LYXERR(Debug::PAINTING, "\t\t*** START DRAWING ***");
2861
2862         Text & text = buffer_.text();
2863         TextMetrics const & tm = d->text_metrics_[&text];
2864         int const y = tm.first().second->position();
2865         PainterInfo pi(this, pain);
2866
2867         switch (d->update_strategy_) {
2868
2869         case NoScreenUpdate:
2870                 // If no screen painting is actually needed, only some the different
2871                 // coordinates of insets and paragraphs needs to be updated.
2872                 pi.full_repaint = true;
2873                 pi.pain.setDrawingEnabled(false);
2874                 tm.draw(pi, 0, y);
2875                 break;
2876
2877         case SingleParUpdate:
2878                 pi.full_repaint = false;
2879                 // In general, only the current row of the outermost paragraph
2880                 // will be redrawn. Particular cases where selection spans
2881                 // multiple paragraph are correctly detected in TextMetrics.
2882                 tm.draw(pi, 0, y);
2883                 break;
2884
2885         case DecorationUpdate:
2886                 // FIXME: We should also distinguish DecorationUpdate to avoid text
2887                 // drawing if possible. This is not possible to do easily right now
2888                 // because of the single backing pixmap.
2889
2890         case FullScreenUpdate:
2891                 // The whole screen, including insets, will be refreshed.
2892                 pi.full_repaint = true;
2893
2894                 // Clear background.
2895                 pain.fillRectangle(0, 0, width_, height_,
2896                         pi.backgroundColor(&buffer_.inset()));
2897
2898                 // Draw everything.
2899                 tm.draw(pi, 0, y);
2900
2901                 // and possibly grey out below
2902                 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2903                 int const y2 = lastpm.second->position() + lastpm.second->descent();
2904
2905                 if (y2 < height_) {
2906                         Color color = buffer().isInternal()
2907                                 ? Color_background : Color_bottomarea;
2908                         pain.fillRectangle(0, y2, width_, height_ - y2, color);
2909                 }
2910                 break;
2911         }
2912         LYXERR(Debug::PAINTING, "\n\t\t*** END DRAWING  ***");
2913
2914         // The scrollbar needs an update.
2915         updateScrollbar();
2916
2917         // Normalize anchor for next time
2918         pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
2919         pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2920         for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
2921                 ParagraphMetrics const & pm = tm.parMetrics(pit);
2922                 if (pm.position() + pm.descent() > 0) {
2923                         d->anchor_pit_ = pit;
2924                         d->anchor_ypos_ = pm.position();
2925                         break;
2926                 }
2927         }
2928         LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
2929                 << "  anchor ypos = " << d->anchor_ypos_);
2930 }
2931
2932
2933 void BufferView::message(docstring const & msg)
2934 {
2935         if (d->gui_)
2936                 d->gui_->message(msg);
2937 }
2938
2939
2940 void BufferView::showDialog(string const & name)
2941 {
2942         if (d->gui_)
2943                 d->gui_->showDialog(name, string());
2944 }
2945
2946
2947 void BufferView::showDialog(string const & name,
2948         string const & data, Inset * inset)
2949 {
2950         if (d->gui_)
2951                 d->gui_->showDialog(name, data, inset);
2952 }
2953
2954
2955 void BufferView::updateDialog(string const & name, string const & data)
2956 {
2957         if (d->gui_)
2958                 d->gui_->updateDialog(name, data);
2959 }
2960
2961
2962 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
2963 {
2964         d->gui_ = gui;
2965 }
2966
2967
2968 // FIXME: Move this out of BufferView again
2969 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
2970 {
2971         if (!fname.isReadableFile()) {
2972                 docstring const error = from_ascii(strerror(errno));
2973                 docstring const file = makeDisplayPath(fname.absFileName(), 50);
2974                 docstring const text =
2975                   bformat(_("Could not read the specified document\n"
2976                             "%1$s\ndue to the error: %2$s"), file, error);
2977                 Alert::error(_("Could not read file"), text);
2978                 return docstring();
2979         }
2980
2981         if (!fname.isReadableFile()) {
2982                 docstring const file = makeDisplayPath(fname.absFileName(), 50);
2983                 docstring const text =
2984                   bformat(_("%1$s\n is not readable."), file);
2985                 Alert::error(_("Could not open file"), text);
2986                 return docstring();
2987         }
2988
2989         // FIXME UNICODE: We don't know the encoding of the file
2990         docstring file_content = fname.fileContents("UTF-8");
2991         if (file_content.empty()) {
2992                 Alert::error(_("Reading not UTF-8 encoded file"),
2993                              _("The file is not UTF-8 encoded.\n"
2994                                "It will be read as local 8Bit-encoded.\n"
2995                                "If this does not give the correct result\n"
2996                                "then please change the encoding of the file\n"
2997                                "to UTF-8 with a program other than LyX.\n"));
2998                 file_content = fname.fileContents("local8bit");
2999         }
3000
3001         return normalize_c(file_content);
3002 }
3003
3004
3005 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
3006 {
3007         docstring const tmpstr = contentsOfPlaintextFile(f);
3008
3009         if (tmpstr.empty())
3010                 return;
3011
3012         Cursor & cur = cursor();
3013         cap::replaceSelection(cur);
3014         buffer_.undo().recordUndo(cur);
3015         if (asParagraph)
3016                 cur.innerText()->insertStringAsParagraphs(cur, tmpstr, cur.current_font);
3017         else
3018                 cur.innerText()->insertStringAsLines(cur, tmpstr, cur.current_font);
3019
3020         buffer_.changed(true);
3021 }
3022
3023
3024 docstring const & BufferView::inlineCompletion() const
3025 {
3026         return d->inlineCompletion_;
3027 }
3028
3029
3030 size_t const & BufferView::inlineCompletionUniqueChars() const
3031 {
3032         return d->inlineCompletionUniqueChars_;
3033 }
3034
3035
3036 DocIterator const & BufferView::inlineCompletionPos() const
3037 {
3038         return d->inlineCompletionPos_;
3039 }
3040
3041
3042 void BufferView::resetInlineCompletionPos()
3043 {
3044         d->inlineCompletionPos_ = DocIterator();
3045 }
3046
3047
3048 bool samePar(DocIterator const & a, DocIterator const & b)
3049 {
3050         if (a.empty() && b.empty())
3051                 return true;
3052         if (a.empty() || b.empty())
3053                 return false;
3054         if (a.depth() != b.depth())
3055                 return false;
3056         return &a.innerParagraph() == &b.innerParagraph();
3057 }
3058
3059
3060 void BufferView::setInlineCompletion(Cursor const & cur, DocIterator const & pos,
3061         docstring const & completion, size_t uniqueChars)
3062 {
3063         uniqueChars = min(completion.size(), uniqueChars);
3064         bool changed = d->inlineCompletion_ != completion
3065                 || d->inlineCompletionUniqueChars_ != uniqueChars;
3066         bool singlePar = true;
3067         d->inlineCompletion_ = completion;
3068         d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
3069
3070         //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
3071
3072         // at new position?
3073         DocIterator const & old = d->inlineCompletionPos_;
3074         if (old != pos) {
3075                 //lyxerr << "inlineCompletionPos changed" << std::endl;
3076                 // old or pos are in another paragraph?
3077                 if ((!samePar(cur, pos) && !pos.empty())
3078                     || (!samePar(cur, old) && !old.empty())) {
3079                         singlePar = false;
3080                         //lyxerr << "different paragraph" << std::endl;
3081                 }
3082                 d->inlineCompletionPos_ = pos;
3083         }
3084
3085         // set update flags
3086         if (changed) {
3087                 if (singlePar && !(cur.result().screenUpdate() & Update::Force))
3088                         cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
3089                 else
3090                         cur.screenUpdateFlags(cur.result().screenUpdate() | Update::Force);
3091         }
3092 }
3093
3094
3095 bool BufferView::clickableInset() const
3096 {
3097         return d->clickable_inset_;
3098 }
3099
3100 } // namespace lyx