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 (lyxrc.rtl_support) {
 807                 if (d->cursor_.real_current_font.isRightToLeft()) {
 808                         if (d->intl_.keymap == Intl::PRIMARY)
 809                                 d->intl_.keyMapSec();
 810                 } else {
 811                         if (d->intl_.keymap == Intl::SECONDARY)
 812                                 d->intl_.keyMapPrim();
 813                 }
 814         }
 815
 816         d->intl_.getTransManager().translateAndInsert(c, t, cur);
 817 }
 818
 819
 820 int BufferView::workWidth() const
 821 {
 822         return width_;
 823 }
 824
 825
 826 void BufferView::recenter()
 827 {
 828         showCursor(d->cursor_, true, true);
 829 }
 830
 831
 832 void BufferView::showCursor()
 833 {
 834         showCursor(d->cursor_, false, true);
 835 }
 836
 837
 838 void BufferView::showCursor(DocIterator const & dit,
 839         bool recenter, bool update)
 840 {
 841         if (scrollToCursor(dit, recenter) && update) {
 842                 buffer_.changed(true);
 843                 updateHoveredInset();
 844         }
 845 }
 846
 847
 848 void BufferView::scrollToCursor()
 849 {
 850         if (scrollToCursor(d->cursor_, false)) {
 851                 buffer_.changed(true);
 852                 updateHoveredInset();
 853         }
 854 }
 855
 856
 857 bool BufferView::scrollToCursor(DocIterator const & dit, bool recenter)
 858 {
 859         // We are not properly started yet, delay until resizing is
 860         // done.
 861         if (height_ == 0)
 862                 return false;
 863
 864         LYXERR(Debug::SCROLLING, "recentering!");
 865
 866         CursorSlice const & bot = dit.bottom();
 867         TextMetrics & tm = d->text_metrics_[bot.text()];
 868
 869         pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
 870         int bot_pit = bot.pit();
 871         if (bot_pit > max_pit) {
 872                 // FIXME: Why does this happen?
 873                 LYXERR0("bottom pit is greater that max pit: "
 874                         << bot_pit << " > " << max_pit);
 875                 bot_pit = max_pit;
 876         }
 877
 878         if (bot_pit == tm.first().first - 1)
 879                 tm.newParMetricsUp();
 880         else if (bot_pit == tm.last().first + 1)
 881                 tm.newParMetricsDown();
 882
 883         if (tm.contains(bot_pit)) {
 884                 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
 885                 LBUFERR(!pm.rows().empty());
 886                 // FIXME: smooth scrolling doesn't work in mathed.
 887                 CursorSlice const & cs = dit.innerTextSlice();
 888                 int offset = coordOffset(dit).y_;
 889                 int ypos = pm.position() + offset;
 890                 Dimension const & row_dim =
 891                         pm.getRow(cs.pos(), dit.boundary()).dimension();
 892                 int scrolled = 0;
 893                 if (recenter)
 894                         scrolled = scroll(ypos - height_/2);
 895
 896                 // We try to visualize the whole row, if the row height is larger than
 897                 // the screen height, we scroll to a heuristic value of height_ / 4.
 898                 // FIXME: This heuristic value should be replaced by a recursive search
 899                 // for a row in the inset that can be visualized completely.
 900                 else if (row_dim.height() > height_) {
 901                         if (ypos < defaultRowHeight())
 902                                 scrolled = scroll(ypos - height_ / 4);
 903                         else if (ypos > height_ - defaultRowHeight())
 904                                 scrolled = scroll(ypos - 3 * height_ / 4);
 905                 }
 906
 907                 // If the top part of the row falls of the screen, we scroll
 908                 // up to align the top of the row with the top of the screen.
 909                 else if (ypos - row_dim.ascent() < 0 && ypos < height_) {
 910                         int ynew = row_dim.ascent();
 911                         scrolled = scrollUp(ynew - ypos);
 912                 }
 913
 914                 // If the bottom of the row falls of the screen, we scroll down.
 915                 else if (ypos + row_dim.descent() > height_ && ypos > 0) {
 916                         int ynew = height_ - row_dim.descent();
 917                         scrolled = scrollDown(ypos - ynew);
 918                 }
 919
 920                 // else, nothing to do, the cursor is already visible so we just return.
 921                 return scrolled != 0;
 922         }
 923
 924         // fix inline completion position
 925         if (d->inlineCompletionPos_.fixIfBroken())
 926                 d->inlineCompletionPos_ = DocIterator();
 927
 928         tm.redoParagraph(bot_pit);
 929         ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
 930         int offset = coordOffset(dit).y_;
 931
 932         d->anchor_pit_ = bot_pit;
 933         CursorSlice const & cs = dit.innerTextSlice();
 934         Dimension const & row_dim =
 935                 pm.getRow(cs.pos(), dit.boundary()).dimension();
 936
 937         if (recenter)
 938                 d->anchor_ypos_ = height_/2;
 939         else if (d->anchor_pit_ == 0)
 940                 d->anchor_ypos_ = offset + pm.ascent();
 941         else if (d->anchor_pit_ == max_pit)
 942                 d->anchor_ypos_ = height_ - offset - row_dim.descent();
 943         else if (offset > height_)
 944                 d->anchor_ypos_ = height_ - offset - defaultRowHeight();
 945         else
 946                 d->anchor_ypos_ = defaultRowHeight() * 2;
 947
 948         return true;
 949 }
 950
 951
 952 void BufferView::makeDocumentClass()
 953 {
 954         DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
 955         buffer_.params().makeDocumentClass();
 956         updateDocumentClass(olddc);
 957 }
 958
 959
 960 void BufferView::updateDocumentClass(DocumentClassConstPtr olddc)
 961 {
 962         message(_("Converting document to new document class..."));
 963
 964         StableDocIterator backcur(d->cursor_);
 965         ErrorList & el = buffer_.errorList("Class Switch");
 966         cap::switchBetweenClasses(
 967                         olddc, buffer_.params().documentClassPtr(),
 968                         static_cast<InsetText &>(buffer_.inset()), el);
 969
 970         setCursor(backcur.asDocIterator(&buffer_));
 971
 972         buffer_.errors("Class Switch");
 973 }
 974
 975
 976 /** Return the change status at cursor position, taking in account the
 977  * status at each level of the document iterator (a table in a deleted
 978  * footnote is deleted).
 979  * When \param outer is true, the top slice is not looked at.
 980  */
 981 static Change::Type lookupChangeType(DocIterator const & dit, bool outer = false)
 982 {
 983         size_t const depth = dit.depth() - (outer ? 1 : 0);
 984
 985         for (size_t i = 0 ; i < depth ; ++i) {
 986                 CursorSlice const & slice = dit[i];
 987                 if (!slice.inset().inMathed()
 988                     && slice.pos() < slice.paragraph().size()) {
 989                         Change::Type const ch = slice.paragraph().lookupChange(slice.pos()).type;
 990                         if (ch != Change::UNCHANGED)
 991                                 return ch;
 992                 }
 993         }
 994         return Change::UNCHANGED;
 995 }
 996
 997
 998 bool BufferView::getStatus(FuncRequest const & cmd, FuncStatus & flag)
 999 {
1000         FuncCode const act = cmd.action();
1001
1002         // Can we use a readonly buffer?
1003         if (buffer_.isReadonly()
1004             && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1005             && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1006                 flag.message(from_utf8(N_("Document is read-only")));
1007                 flag.setEnabled(false);
1008                 return true;
1009         }
1010
1011         // Are we in a DELETED change-tracking region?
1012         if (lookupChangeType(d->cursor_, true) == Change::DELETED
1013             && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1014             && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1015                 flag.message(from_utf8(N_("This portion of the document is deleted.")));
1016                 flag.setEnabled(false);
1017                 return true;
1018         }
1019
1020         Cursor & cur = d->cursor_;
1021
1022         if (cur.getStatus(cmd, flag))
1023                 return true;
1024
1025         switch (act) {
1026
1027         // FIXME: This is a bit problematic because we don't check if this is
1028         // a document BufferView or not for these LFUNs. We probably have to
1029         // dispatch both to currentBufferView() and, if that fails,
1030         // to documentBufferView(); same as we do now for current Buffer and
1031         // document Buffer. Ideally those LFUN should go to Buffer as they
1032         // operate on the full Buffer and the cursor is only needed either for
1033         // an Undo record or to restore a cursor position. But we don't know
1034         // how to do that inside Buffer of course.
1035         case LFUN_BUFFER_PARAMS_APPLY:
1036         case LFUN_LAYOUT_MODULES_CLEAR:
1037         case LFUN_LAYOUT_MODULE_ADD:
1038         case LFUN_LAYOUT_RELOAD:
1039         case LFUN_TEXTCLASS_APPLY:
1040         case LFUN_TEXTCLASS_LOAD:
1041                 flag.setEnabled(!buffer_.isReadonly());
1042                 break;
1043
1044         case LFUN_UNDO:
1045                 // We do not use the LyXAction flag for readonly because Undo sets the
1046                 // buffer clean/dirty status by itself.
1047                 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasUndoStack());
1048                 break;
1049         case LFUN_REDO:
1050                 // We do not use the LyXAction flag for readonly because Redo sets the
1051                 // buffer clean/dirty status by itself.
1052                 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasRedoStack());
1053                 break;
1054         case LFUN_FILE_INSERT_PLAINTEXT_PARA:
1055         case LFUN_FILE_INSERT_PLAINTEXT: {
1056                 docstring const fname = cmd.argument();
1057                 if (!FileName::isAbsolute(to_utf8(fname))) {
1058                         flag.message(_("Absolute filename expected."));
1059                         return false;
1060                 }
1061                 flag.setEnabled(cur.inTexted());
1062                 break;
1063         }
1064         case LFUN_FILE_INSERT:
1065         case LFUN_BOOKMARK_SAVE:
1066                 // FIXME: Actually, these LFUNS should be moved to Text
1067                 flag.setEnabled(cur.inTexted());
1068                 break;
1069
1070         case LFUN_FONT_STATE:
1071         case LFUN_LABEL_INSERT:
1072         case LFUN_INFO_INSERT:
1073         case LFUN_PARAGRAPH_GOTO:
1074         case LFUN_NOTE_NEXT:
1075         case LFUN_REFERENCE_NEXT:
1076         case LFUN_WORD_FIND:
1077         case LFUN_WORD_FIND_FORWARD:
1078         case LFUN_WORD_FIND_BACKWARD:
1079         case LFUN_WORD_REPLACE:
1080         case LFUN_MARK_OFF:
1081         case LFUN_MARK_ON:
1082         case LFUN_MARK_TOGGLE:
1083         case LFUN_SCREEN_RECENTER:
1084         case LFUN_SCREEN_SHOW_CURSOR:
1085         case LFUN_BIBTEX_DATABASE_ADD:
1086         case LFUN_BIBTEX_DATABASE_DEL:
1087         case LFUN_STATISTICS:
1088         case LFUN_KEYMAP_OFF:
1089         case LFUN_KEYMAP_PRIMARY:
1090         case LFUN_KEYMAP_SECONDARY:
1091         case LFUN_KEYMAP_TOGGLE:
1092                 flag.setEnabled(true);
1093                 break;
1094
1095         case LFUN_WORD_FINDADV: {
1096                 FindAndReplaceOptions opt;
1097                 istringstream iss(to_utf8(cmd.argument()));
1098                 iss >> opt;
1099                 flag.setEnabled(opt.repl_buf_name.empty()
1100                                 || !buffer_.isReadonly());
1101         }
1102
1103         case LFUN_LABEL_GOTO: {
1104                 flag.setEnabled(!cmd.argument().empty()
1105                     || getInsetByCode<InsetRef>(cur, REF_CODE));
1106                 break;
1107         }
1108
1109         case LFUN_CHANGES_TRACK:
1110                 flag.setEnabled(true);
1111                 flag.setOnOff(buffer_.params().track_changes);
1112                 break;
1113
1114         case LFUN_CHANGES_OUTPUT:
1115                 flag.setEnabled(true);
1116                 flag.setOnOff(buffer_.params().output_changes);
1117                 break;
1118
1119         case LFUN_CHANGES_MERGE:
1120         case LFUN_CHANGE_NEXT:
1121         case LFUN_CHANGE_PREVIOUS:
1122         case LFUN_ALL_CHANGES_ACCEPT:
1123         case LFUN_ALL_CHANGES_REJECT:
1124                 // TODO: context-sensitive enabling of LFUNs
1125                 // In principle, these command should only be enabled if there
1126                 // is a change in the document. However, without proper
1127                 // optimizations, this will inevitably result in poor performance.
1128                 flag.setEnabled(true);
1129                 break;
1130
1131         case LFUN_BUFFER_TOGGLE_COMPRESSION: {
1132                 flag.setOnOff(buffer_.params().compressed);
1133                 break;
1134         }
1135
1136         case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC: {
1137                 flag.setOnOff(buffer_.params().output_sync);
1138                 break;
1139         }
1140
1141         case LFUN_SCREEN_UP:
1142         case LFUN_SCREEN_DOWN:
1143         case LFUN_SCROLL:
1144         case LFUN_SCREEN_UP_SELECT:
1145         case LFUN_SCREEN_DOWN_SELECT:
1146         case LFUN_INSET_FORALL:
1147                 flag.setEnabled(true);
1148                 break;
1149
1150         case LFUN_LAYOUT_TABULAR:
1151                 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
1152                 break;
1153
1154         case LFUN_LAYOUT:
1155                 flag.setEnabled(!cur.inset().forcePlainLayout(cur.idx()));
1156                 break;
1157
1158         case LFUN_LAYOUT_PARAGRAPH:
1159                 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
1160                 break;
1161
1162         case LFUN_BRANCH_ADD_INSERT:
1163                 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1164                 break;
1165
1166         case LFUN_DIALOG_SHOW_NEW_INSET:
1167                 // FIXME: this is wrong, but I do not understand the
1168                 // intent (JMarc)
1169                 if (cur.inset().lyxCode() == CAPTION_CODE)
1170                         return cur.inset().getStatus(cur, cmd, flag);
1171                 // FIXME we should consider passthru paragraphs too.
1172                 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1173                 break;
1174
1175         case LFUN_CITATION_INSERT: {
1176                 FuncRequest fr(LFUN_INSET_INSERT, "citation");
1177                 // FIXME: This could turn in a recursive hell.
1178                 // Shouldn't we use Buffer::getStatus() instead?
1179                 flag.setEnabled(lyx::getStatus(fr).enabled());
1180                 break;
1181         }
1182         case LFUN_INSET_APPLY: {
1183                 string const name = cmd.getArg(0);
1184                 Inset * inset = editedInset(name);
1185                 if (inset) {
1186                         FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1187                         if (!inset->getStatus(cur, fr, flag)) {
1188                                 // Every inset is supposed to handle this
1189                                 LASSERT(false, break);
1190                         }
1191                 } else {
1192                         FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1193                         flag = lyx::getStatus(fr);
1194                 }
1195                 break;
1196         }
1197
1198         default:
1199                 return false;
1200         }
1201
1202         return true;
1203 }
1204
1205
1206 Inset * BufferView::editedInset(string const & name) const
1207 {
1208         map<string, Inset *>::const_iterator it = d->edited_insets_.find(name);
1209         return it == d->edited_insets_.end() ? 0 : it->second;
1210 }
1211
1212
1213 void BufferView::editInset(string const & name, Inset * inset)
1214 {
1215         d->edited_insets_[name] = inset;
1216 }
1217
1218
1219 void BufferView::dispatch(FuncRequest const & cmd, DispatchResult & dr)
1220 {
1221         LYXERR(Debug::ACTION, "BufferView::dispatch: cmd: " << cmd);
1222
1223         string const argument = to_utf8(cmd.argument());
1224         Cursor & cur = d->cursor_;
1225
1226         // Don't dispatch function that does not apply to internal buffers.
1227         if (buffer_.isInternal()
1228             && lyxaction.funcHasFlag(cmd.action(), LyXAction::NoInternal))
1229                 return;
1230
1231         // We'll set this back to false if need be.
1232         bool dispatched = true;
1233         buffer_.undo().beginUndoGroup();
1234
1235         FuncCode const act = cmd.action();
1236         switch (act) {
1237
1238         case LFUN_BUFFER_PARAMS_APPLY: {
1239                 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1240                 cur.recordUndoFullDocument();
1241                 istringstream ss(to_utf8(cmd.argument()));
1242                 Lexer lex;
1243                 lex.setStream(ss);
1244                 int const unknown_tokens = buffer_.readHeader(lex);
1245                 if (unknown_tokens != 0) {
1246                         LYXERR0("Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1247                                                 << unknown_tokens << " unknown token"
1248                                                 << (unknown_tokens == 1 ? "" : "s"));
1249                 }
1250                 updateDocumentClass(olddc);
1251
1252                 // We are most certainly here because of a change in the document
1253                 // It is then better to make sure that all dialogs are in sync with
1254                 // current document settings.
1255                 dr.screenUpdate(Update::Force | Update::FitCursor);
1256                 dr.forceBufferUpdate();
1257                 break;
1258         }
1259
1260         case LFUN_LAYOUT_MODULES_CLEAR: {
1261                 cur.recordUndoFullDocument();
1262                 buffer_.params().clearLayoutModules();
1263                 makeDocumentClass();
1264                 dr.screenUpdate(Update::Force);
1265                 dr.forceBufferUpdate();
1266                 break;
1267         }
1268
1269         case LFUN_LAYOUT_MODULE_ADD: {
1270                 BufferParams const & params = buffer_.params();
1271                 if (!params.layoutModuleCanBeAdded(argument)) {
1272                         LYXERR0("Module `" << argument <<
1273                                 "' cannot be added due to failed requirements or "
1274                                 "conflicts with installed modules.");
1275                         break;
1276                 }
1277                 cur.recordUndoFullDocument();
1278                 buffer_.params().addLayoutModule(argument);
1279                 makeDocumentClass();
1280                 dr.screenUpdate(Update::Force);
1281                 dr.forceBufferUpdate();
1282                 break;
1283         }
1284
1285         case LFUN_TEXTCLASS_APPLY: {
1286                 // since this shortcircuits, the second call is made only if
1287                 // the first fails
1288                 bool const success =
1289                         LayoutFileList::get().load(argument, buffer_.temppath()) ||
1290                         LayoutFileList::get().load(argument, buffer_.filePath());
1291                 if (!success) {
1292                         docstring s = bformat(_("The document class `%1$s' "
1293                                                  "could not be loaded."), from_utf8(argument));
1294                         frontend::Alert::error(_("Could not load class"), s);
1295                         break;
1296                 }
1297
1298                 LayoutFile const * old_layout = buffer_.params().baseClass();
1299                 LayoutFile const * new_layout = &(LayoutFileList::get()[argument]);
1300
1301                 if (old_layout == new_layout)
1302                         // nothing to do
1303                         break;
1304
1305                 // Save the old, possibly modular, layout for use in conversion.
1306                 cur.recordUndoFullDocument();
1307                 buffer_.params().setBaseClass(argument);
1308                 makeDocumentClass();
1309                 dr.screenUpdate(Update::Force);
1310                 dr.forceBufferUpdate();
1311                 break;
1312         }
1313
1314         case LFUN_TEXTCLASS_LOAD: {
1315                 // since this shortcircuits, the second call is made only if
1316                 // the first fails
1317                 bool const success =
1318                         LayoutFileList::get().load(argument, buffer_.temppath()) ||
1319                         LayoutFileList::get().load(argument, buffer_.filePath());
1320                 if (!success) {
1321                         docstring s = bformat(_("The document class `%1$s' "
1322                                                  "could not be loaded."), from_utf8(argument));
1323                         frontend::Alert::error(_("Could not load class"), s);
1324                 }
1325                 break;
1326         }
1327
1328         case LFUN_LAYOUT_RELOAD: {
1329                 LayoutFileIndex bc = buffer_.params().baseClassID();
1330                 LayoutFileList::get().reset(bc);
1331                 buffer_.params().setBaseClass(bc);
1332                 makeDocumentClass();
1333                 dr.screenUpdate(Update::Force);
1334                 dr.forceBufferUpdate();
1335                 break;
1336         }
1337
1338         case LFUN_UNDO:
1339                 dr.setMessage(_("Undo"));
1340                 cur.clearSelection();
1341                 if (!cur.textUndo())
1342                         dr.setMessage(_("No further undo information"));
1343                 else
1344                         dr.screenUpdate(Update::Force | Update::FitCursor);
1345                 dr.forceBufferUpdate();
1346                 break;
1347
1348         case LFUN_REDO:
1349                 dr.setMessage(_("Redo"));
1350                 cur.clearSelection();
1351                 if (!cur.textRedo())
1352                         dr.setMessage(_("No further redo information"));
1353                 else
1354                         dr.screenUpdate(Update::Force | Update::FitCursor);
1355                 dr.forceBufferUpdate();
1356                 break;
1357
1358         case LFUN_FONT_STATE:
1359                 dr.setMessage(cur.currentState());
1360                 break;
1361
1362         case LFUN_BOOKMARK_SAVE:
1363                 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1364                 break;
1365
1366         case LFUN_LABEL_GOTO: {
1367                 docstring label = cmd.argument();
1368                 if (label.empty()) {
1369                         InsetRef * inset =
1370                                 getInsetByCode<InsetRef>(cur, REF_CODE);
1371                         if (inset) {
1372                                 label = inset->getParam("reference");
1373                                 // persistent=false: use temp_bookmark
1374                                 saveBookmark(0);
1375                         }
1376                 }
1377                 if (!label.empty()) {
1378                         gotoLabel(label);
1379                         // at the moment, this is redundant, since gotoLabel will
1380                         // eventually call LFUN_PARAGRAPH_GOTO, but it seems best
1381                         // to have it here.
1382                         dr.screenUpdate(Update::Force | Update::FitCursor);
1383                 }
1384                 break;
1385         }
1386
1387         case LFUN_PARAGRAPH_GOTO: {
1388                 int const id = convert<int>(cmd.getArg(0));
1389                 int const pos = convert<int>(cmd.getArg(1));
1390                 int i = 0;
1391                 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1392                         b = theBufferList().next(b)) {
1393
1394                         DocIterator dit = b->getParFromID(id);
1395                         if (dit.atEnd()) {
1396                                 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1397                                 ++i;
1398                                 continue;
1399                         }
1400                         LYXERR(Debug::INFO, "Paragraph " << dit.paragraph().id()
1401                                 << " found in buffer `"
1402                                 << b->absFileName() << "'.");
1403
1404                         if (b == &buffer_) {
1405                                 // Set the cursor
1406                                 dit.pos() = pos;
1407                                 setCursor(dit);
1408                                 dr.screenUpdate(Update::Force | Update::FitCursor);
1409                         } else {
1410                                 // Switch to other buffer view and resend cmd
1411                                 lyx::dispatch(FuncRequest(
1412                                         LFUN_BUFFER_SWITCH, b->absFileName()));
1413                                 lyx::dispatch(cmd);
1414                         }
1415                         break;
1416                 }
1417                 break;
1418         }
1419
1420         case LFUN_NOTE_NEXT:
1421                 gotoInset(this, NOTE_CODE, false);
1422                 break;
1423
1424         case LFUN_REFERENCE_NEXT: {
1425                 vector<InsetCode> tmp;
1426                 tmp.push_back(LABEL_CODE);
1427                 tmp.push_back(REF_CODE);
1428                 gotoInset(this, tmp, true);
1429                 break;
1430         }
1431
1432         case LFUN_CHANGES_TRACK:
1433                 buffer_.params().track_changes = !buffer_.params().track_changes;
1434                 break;
1435
1436         case LFUN_CHANGES_OUTPUT:
1437                 buffer_.params().output_changes = !buffer_.params().output_changes;
1438                 if (buffer_.params().output_changes) {
1439                         bool dvipost    = LaTeXFeatures::isAvailable("dvipost");
1440                         bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1441                                           LaTeXFeatures::isAvailable("xcolor");
1442
1443                         if (!dvipost && !xcolorulem) {
1444                                 Alert::warning(_("Changes not shown in LaTeX output"),
1445                                                _("Changes will not be highlighted in LaTeX output, "
1446                                                  "because neither dvipost nor xcolor/ulem are installed.\n"
1447                                                  "Please install these packages or redefine "
1448                                                  "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1449                         } else if (!xcolorulem) {
1450                                 Alert::warning(_("Changes not shown in LaTeX output"),
1451                                                _("Changes will not be highlighted in LaTeX output "
1452                                                  "when using pdflatex, because xcolor and ulem are not installed.\n"
1453                                                  "Please install both packages or redefine "
1454                                                  "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1455                         }
1456                 }
1457                 break;
1458
1459         case LFUN_CHANGE_NEXT:
1460                 findNextChange(this);
1461                 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1462                 dr.screenUpdate(Update::Force | Update::FitCursor);
1463                 break;
1464
1465         case LFUN_CHANGE_PREVIOUS:
1466                 findPreviousChange(this);
1467                 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1468                 dr.screenUpdate(Update::Force | Update::FitCursor);
1469                 break;
1470
1471         case LFUN_CHANGES_MERGE:
1472                 if (findNextChange(this) || findPreviousChange(this)) {
1473                         dr.screenUpdate(Update::Force | Update::FitCursor);
1474                         dr.forceBufferUpdate();
1475                         showDialog("changes");
1476                 }
1477                 break;
1478
1479         case LFUN_ALL_CHANGES_ACCEPT:
1480                 // select complete document
1481                 cur.reset();
1482                 cur.selHandle(true);
1483                 buffer_.text().cursorBottom(cur);
1484                 // accept everything in a single step to support atomic undo
1485                 buffer_.text().acceptOrRejectChanges(cur, Text::ACCEPT);
1486                 cur.resetAnchor();
1487                 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1488                 dr.screenUpdate(Update::Force | Update::FitCursor);
1489                 dr.forceBufferUpdate();
1490                 break;
1491
1492         case LFUN_ALL_CHANGES_REJECT:
1493                 // select complete document
1494                 cur.reset();
1495                 cur.selHandle(true);
1496                 buffer_.text().cursorBottom(cur);
1497                 // reject everything in a single step to support atomic undo
1498                 // Note: reject does not work recursively; the user may have to repeat the operation
1499                 buffer_.text().acceptOrRejectChanges(cur, Text::REJECT);
1500                 cur.resetAnchor();
1501                 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1502                 dr.screenUpdate(Update::Force | Update::FitCursor);
1503                 dr.forceBufferUpdate();
1504                 break;
1505
1506         case LFUN_WORD_FIND_FORWARD:
1507         case LFUN_WORD_FIND_BACKWARD: {
1508                 // FIXME THREAD
1509                 // Would it maybe be better if this variable were view specific anyway?
1510                 static docstring last_search;
1511                 docstring searched_string;
1512
1513                 if (!cmd.argument().empty()) {
1514                         last_search = cmd.argument();
1515                         searched_string = cmd.argument();
1516                 } else {
1517                         searched_string = last_search;
1518                 }
1519
1520                 if (searched_string.empty())
1521                         break;
1522
1523                 bool const fw = act == LFUN_WORD_FIND_FORWARD;
1524                 docstring const data =
1525                         find2string(searched_string, true, false, fw);
1526                 bool found = lyxfind(this, FuncRequest(LFUN_WORD_FIND, data));
1527                 if (found) {
1528                         dr.screenUpdate(Update::Force | Update::FitCursor);
1529                         cur.dispatched();
1530                         dispatched = true;
1531                 } else {
1532                         cur.undispatched();
1533                         dispatched = false;
1534                 }
1535                 break;
1536         }
1537
1538         case LFUN_WORD_FIND: {
1539                 FuncRequest req = cmd;
1540                 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1541                         req = d->search_request_cache_;
1542                 if (req.argument().empty()) {
1543                         lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, "findreplace"));
1544                         break;
1545                 }
1546                 if (lyxfind(this, req)) {
1547                         dr.screenUpdate(Update::Force | Update::FitCursor);
1548                         cur.dispatched();
1549                         dispatched = true;
1550                 } else {
1551                         cur.undispatched();
1552                         dispatched = false;
1553                 }
1554                 d->search_request_cache_ = req;
1555                 break;
1556         }
1557
1558         case LFUN_WORD_REPLACE: {
1559                 bool has_deleted = false;
1560                 if (cur.selection()) {
1561                         DocIterator beg = cur.selectionBegin();
1562                         DocIterator end = cur.selectionEnd();
1563                         if (beg.pit() == end.pit()) {
1564                                 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1565                                         if (!cur.inMathed() && cur.paragraph().isDeleted(p)) {
1566                                                 has_deleted = true;
1567                                                 break;
1568                                         }
1569                                 }
1570                         }
1571                 }
1572                 if (lyxreplace(this, cmd, has_deleted)) {
1573                         dr.forceBufferUpdate();
1574                         dr.screenUpdate(Update::Force | Update::FitCursor);
1575                         cur.dispatched();
1576                         dispatched = true;
1577                 } else {
1578                         cur.undispatched();
1579                         dispatched = false;
1580                 }
1581                 break;
1582         }
1583
1584         case LFUN_WORD_FINDADV: {
1585                 FindAndReplaceOptions opt;
1586                 istringstream iss(to_utf8(cmd.argument()));
1587                 iss >> opt;
1588                 if (findAdv(this, opt)) {
1589                         dr.screenUpdate(Update::Force | Update::FitCursor);
1590                         cur.dispatched();
1591                         dispatched = true;
1592                 } else {
1593                         cur.undispatched();
1594                         dispatched = false;
1595                 }
1596                 break;
1597         }
1598
1599         case LFUN_MARK_OFF:
1600                 cur.clearSelection();
1601                 dr.setMessage(from_utf8(N_("Mark off")));
1602                 break;
1603
1604         case LFUN_MARK_ON:
1605                 cur.clearSelection();
1606                 cur.setMark(true);
1607                 dr.setMessage(from_utf8(N_("Mark on")));
1608                 break;
1609
1610         case LFUN_MARK_TOGGLE:
1611                 cur.setSelection(false);
1612                 if (cur.mark()) {
1613                         cur.setMark(false);
1614                         dr.setMessage(from_utf8(N_("Mark removed")));
1615                 } else {
1616                         cur.setMark(true);
1617                         dr.setMessage(from_utf8(N_("Mark set")));
1618                 }
1619                 cur.resetAnchor();
1620                 break;
1621
1622         case LFUN_SCREEN_SHOW_CURSOR:
1623                 showCursor();
1624                 break;
1625
1626         case LFUN_SCREEN_RECENTER:
1627                 recenter();
1628                 break;
1629
1630         case LFUN_BIBTEX_DATABASE_ADD: {
1631                 Cursor tmpcur = cur;
1632                 findInset(tmpcur, BIBTEX_CODE, false);
1633                 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1634                                                 BIBTEX_CODE);
1635                 if (inset) {
1636                         if (inset->addDatabase(cmd.argument())) {
1637                                 buffer_.invalidateBibfileCache();
1638                                 dr.forceBufferUpdate();
1639                         }
1640                 }
1641                 break;
1642         }
1643
1644         case LFUN_BIBTEX_DATABASE_DEL: {
1645                 Cursor tmpcur = cur;
1646                 findInset(tmpcur, BIBTEX_CODE, false);
1647                 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1648                                                 BIBTEX_CODE);
1649                 if (inset) {
1650                         if (inset->delDatabase(cmd.argument())) {
1651                                 buffer_.invalidateBibfileCache();
1652                                 dr.forceBufferUpdate();
1653                         }
1654                 }
1655                 break;
1656         }
1657
1658         case LFUN_STATISTICS: {
1659                 DocIterator from, to;
1660                 if (cur.selection()) {
1661                         from = cur.selectionBegin();
1662                         to = cur.selectionEnd();
1663                 } else {
1664                         from = doc_iterator_begin(&buffer_);
1665                         to = doc_iterator_end(&buffer_);
1666                 }
1667                 buffer_.updateStatistics(from, to);
1668                 int const words = buffer_.wordCount();
1669                 int const chars = buffer_.charCount(false);
1670                 int const chars_blanks = buffer_.charCount(true);
1671                 docstring message;
1672                 if (cur.selection())
1673                         message = _("Statistics for the selection:");
1674                 else
1675                         message = _("Statistics for the document:");
1676                 message += "\n\n";
1677                 if (words != 1)
1678                         message += bformat(_("%1$d words"), words);
1679                 else
1680                         message += _("One word");
1681                 message += "\n";
1682                 if (chars_blanks != 1)
1683                         message += bformat(_("%1$d characters (including blanks)"),
1684                                           chars_blanks);
1685                 else
1686                         message += _("One character (including blanks)");
1687                 message += "\n";
1688                 if (chars != 1)
1689                         message += bformat(_("%1$d characters (excluding blanks)"),
1690                                           chars);
1691                 else
1692                         message += _("One character (excluding blanks)");
1693
1694                 Alert::information(_("Statistics"), message);
1695         }
1696                 break;
1697
1698         case LFUN_BUFFER_TOGGLE_COMPRESSION:
1699                 // turn compression on/off
1700                 buffer_.params().compressed = !buffer_.params().compressed;
1701                 break;
1702
1703         case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
1704                 buffer_.params().output_sync = !buffer_.params().output_sync;
1705                 break;
1706
1707         case LFUN_SCREEN_UP:
1708         case LFUN_SCREEN_DOWN: {
1709                 Point p = getPos(cur);
1710                 // This code has been commented out to enable to scroll down a
1711                 // document, even if there are large insets in it (see bug #5465).
1712                 /*if (p.y_ < 0 || p.y_ > height_) {
1713                         // The cursor is off-screen so recenter before proceeding.
1714                         showCursor();
1715                         p = getPos(cur);
1716                 }*/
1717                 int const scrolled = scroll(act == LFUN_SCREEN_UP
1718                         ? -height_ : height_);
1719                 if (act == LFUN_SCREEN_UP && scrolled > -height_)
1720                         p = Point(0, 0);
1721                 if (act == LFUN_SCREEN_DOWN && scrolled < height_)
1722                         p = Point(width_, height_);
1723                 Cursor old = cur;
1724                 bool const in_texted = cur.inTexted();
1725                 cur.setCursor(doc_iterator_begin(cur.buffer()));
1726                 cur.selHandle(false);
1727                 buffer_.changed(true);
1728                 updateHoveredInset();
1729
1730                 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_,
1731                         true, act == LFUN_SCREEN_UP);
1732                 //FIXME: what to do with cur.x_target()?
1733                 bool update = in_texted && cur.bv().checkDepm(cur, old);
1734                 cur.finishUndo();
1735
1736                 if (update || cur.mark())
1737                         dr.screenUpdate(Update::Force | Update::FitCursor);
1738                 if (update)
1739                         dr.forceBufferUpdate();
1740                 break;
1741         }
1742
1743         case LFUN_SCROLL: {
1744                 string const scroll_type = cmd.getArg(0);
1745                 int scroll_step = 0;
1746                 if (scroll_type == "line")
1747                         scroll_step = d->scrollbarParameters_.single_step;
1748                 else if (scroll_type == "page")
1749                         scroll_step = d->scrollbarParameters_.page_step;
1750                 else
1751                         return;
1752                 string const scroll_quantity = cmd.getArg(1);
1753                 if (scroll_quantity == "up")
1754                         scrollUp(scroll_step);
1755                 else if (scroll_quantity == "down")
1756                         scrollDown(scroll_step);
1757                 else {
1758                         int const scroll_value = convert<int>(scroll_quantity);
1759                         if (scroll_value)
1760                                 scroll(scroll_step * scroll_value);
1761                 }
1762                 buffer_.changed(true);
1763                 updateHoveredInset();
1764                 dr.forceBufferUpdate();
1765                 break;
1766         }
1767
1768         case LFUN_SCREEN_UP_SELECT: {
1769                 // FIXME: why is the algorithm different from LFUN_SCREEN_UP?
1770                 cur.selHandle(true);
1771                 if (isTopScreen()) {
1772                         lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1773                         cur.finishUndo();
1774                         break;
1775                 }
1776                 int y = getPos(cur).y_;
1777                 int const ymin = y - height_ + defaultRowHeight();
1778                 while (y > ymin && cur.up())
1779                         y = getPos(cur).y_;
1780
1781                 cur.finishUndo();
1782                 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1783                 break;
1784         }
1785
1786         case LFUN_SCREEN_DOWN_SELECT: {
1787                 // FIXME: why is the algorithm different from LFUN_SCREEN_DOWN?
1788                 cur.selHandle(true);
1789                 if (isBottomScreen()) {
1790                         lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1791                         cur.finishUndo();
1792                         break;
1793                 }
1794                 int y = getPos(cur).y_;
1795                 int const ymax = y + height_ - defaultRowHeight();
1796                 while (y < ymax && cur.down())
1797                         y = getPos(cur).y_;
1798
1799                 cur.finishUndo();
1800                 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1801                 break;
1802         }
1803
1804
1805         // This would be in Buffer class if only Cursor did not
1806         // require a bufferview
1807         case LFUN_INSET_FORALL: {
1808                 docstring const name = from_utf8(cmd.getArg(0));
1809                 string const commandstr = cmd.getLongArg(1);
1810                 FuncRequest const fr = lyxaction.lookupFunc(commandstr);
1811
1812                 // an arbitrary number to limit number of iterations
1813                 const int max_iter = 100000;
1814                 int iterations = 0;
1815                 Cursor & cur = d->cursor_;
1816                 Cursor const savecur = cur;
1817                 cur.reset();
1818                 if (!cur.nextInset())
1819                         cur.forwardInset();
1820                 cur.beginUndoGroup();
1821                 while(cur && iterations < max_iter) {
1822                         Inset * const ins = cur.nextInset();
1823                         if (!ins)
1824                                 break;
1825                         docstring insname = ins->layoutName();
1826                         while (!insname.empty()) {
1827                                 if (insname == name || name == from_utf8("*")) {
1828                                         cur.recordUndo();
1829                                         lyx::dispatch(fr, dr);
1830                                         ++iterations;
1831                                         break;
1832                                 }
1833                                 size_t const i = insname.rfind(':');
1834                                 if (i == string::npos)
1835                                         break;
1836                                 insname = insname.substr(0, i);
1837                         }
1838                         // if we did not delete the inset, skip it
1839                         if (!cur.nextInset() || cur.nextInset() == ins)
1840                                 cur.forwardInset();
1841                 }
1842                 cur.endUndoGroup();
1843                 cur = savecur;
1844                 cur.fixIfBroken();
1845                 dr.screenUpdate(Update::Force);
1846                 dr.forceBufferUpdate();
1847
1848                 if (iterations >= max_iter) {
1849                         dr.setError(true);
1850                         dr.setMessage(bformat(_("`inset-forall' interrupted because number of actions is larger than %1$d"), max_iter));
1851                 } else
1852                         dr.setMessage(bformat(_("Applied \"%1$s\" to %2$d insets"), from_utf8(commandstr), iterations));
1853                 break;
1854         }
1855
1856
1857         case LFUN_BRANCH_ADD_INSERT: {
1858                 docstring branch_name = from_utf8(cmd.getArg(0));
1859                 if (branch_name.empty())
1860                         if (!Alert::askForText(branch_name, _("Branch name")) ||
1861                                                 branch_name.empty())
1862                                 break;
1863
1864                 DispatchResult drtmp;
1865                 buffer_.dispatch(FuncRequest(LFUN_BRANCH_ADD, branch_name), drtmp);
1866                 if (drtmp.error()) {
1867                         Alert::warning(_("Branch already exists"), drtmp.message());
1868                         break;
1869                 }
1870                 BranchList & branch_list = buffer_.params().branchlist();
1871                 vector<docstring> const branches =
1872                         getVectorFromString(branch_name, branch_list.separator());
1873                 for (vector<docstring>::const_iterator it = branches.begin();
1874                      it != branches.end(); ++it) {
1875                         branch_name = *it;
1876                         lyx::dispatch(FuncRequest(LFUN_BRANCH_INSERT, branch_name));
1877                 }
1878                 break;
1879         }
1880
1881         case LFUN_KEYMAP_OFF:
1882                 getIntl().keyMapOn(false);
1883                 break;
1884
1885         case LFUN_KEYMAP_PRIMARY:
1886                 getIntl().keyMapPrim();
1887                 break;
1888
1889         case LFUN_KEYMAP_SECONDARY:
1890                 getIntl().keyMapSec();
1891                 break;
1892
1893         case LFUN_KEYMAP_TOGGLE:
1894                 getIntl().toggleKeyMap();
1895                 break;
1896
1897         case LFUN_DIALOG_SHOW_NEW_INSET: {
1898                 string const name = cmd.getArg(0);
1899                 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
1900                 if (decodeInsetParam(name, data, buffer_))
1901                         lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
1902                 else
1903                         lyxerr << "Inset type '" << name <<
1904                         "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" <<  endl;
1905                 break;
1906         }
1907
1908         case LFUN_CITATION_INSERT: {
1909                 if (argument.empty()) {
1910                         lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
1911                         break;
1912                 }
1913                 // we can have one optional argument, delimited by '|'
1914                 // citation-insert <key>|<text_before>
1915                 // this should be enhanced to also support text_after
1916                 // and citation style
1917                 string arg = argument;
1918                 string opt1;
1919                 if (contains(argument, "|")) {
1920                         arg = token(argument, '|', 0);
1921                         opt1 = token(argument, '|', 1);
1922                 }
1923
1924                 // if our cursor is directly in front of or behind a citation inset,
1925                 // we will instead add the new key to it.
1926                 Inset * inset = cur.nextInset();
1927                 if (!inset || inset->lyxCode() != CITE_CODE)
1928                         inset = cur.prevInset();
1929                 if (inset && inset->lyxCode() == CITE_CODE) {
1930                         InsetCitation * icite = static_cast<InsetCitation *>(inset);
1931                         if (icite->addKey(arg)) {
1932                                 dr.forceBufferUpdate();
1933                                 dr.screenUpdate(Update::FitCursor | Update::SinglePar);
1934                                 if (!opt1.empty())
1935                                         LYXERR0("Discarding optional argument to citation-insert.");
1936                         }
1937                         dispatched = true;
1938                         break;
1939                 }
1940                 InsetCommandParams icp(CITE_CODE);
1941                 icp["key"] = from_utf8(arg);
1942                 if (!opt1.empty())
1943                         icp["before"] = from_utf8(opt1);
1944                 string icstr = InsetCommand::params2string(icp);
1945                 FuncRequest fr(LFUN_INSET_INSERT, icstr);
1946                 lyx::dispatch(fr);
1947                 break;
1948         }
1949
1950         case LFUN_INSET_APPLY: {
1951                 string const name = cmd.getArg(0);
1952                 Inset * inset = editedInset(name);
1953                 if (!inset) {
1954                         FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1955                         lyx::dispatch(fr);
1956                         break;
1957                 }
1958                 // put cursor in front of inset.
1959                 if (!setCursorFromInset(inset)) {
1960                         LASSERT(false, break);
1961                 }
1962                 cur.recordUndo();
1963                 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1964                 inset->dispatch(cur, fr);
1965                 dr.screenUpdate(cur.result().screenUpdate());
1966                 if (cur.result().needBufferUpdate())
1967                         dr.forceBufferUpdate();
1968                 break;
1969         }
1970
1971         // FIXME:
1972         // The change of language of buffer belongs to the Buffer class.
1973         // We have to do it here because we need a cursor for Undo.
1974         // When Undo::recordUndoBufferParams() is implemented someday
1975         // LFUN_BUFFER_LANGUAGE should be handled by the Buffer class.
1976         case LFUN_BUFFER_LANGUAGE: {
1977                 Language const * oldL = buffer_.params().language;
1978                 Language const * newL = languages.getLanguage(argument);
1979                 if (!newL || oldL == newL)
1980                         break;
1981                 if (oldL->rightToLeft() == newL->rightToLeft()) {
1982                         cur.recordUndoFullDocument();
1983                         buffer_.changeLanguage(oldL, newL);
1984                         cur.setCurrentFont();
1985                         dr.forceBufferUpdate();
1986                 }
1987                 break;
1988         }
1989
1990         case LFUN_FILE_INSERT_PLAINTEXT_PARA:
1991         case LFUN_FILE_INSERT_PLAINTEXT: {
1992                 bool const as_paragraph = (act == LFUN_FILE_INSERT_PLAINTEXT_PARA);
1993                 string const fname = to_utf8(cmd.argument());
1994                 if (!FileName::isAbsolute(fname))
1995                         dr.setMessage(_("Absolute filename expected."));
1996                 else
1997                         insertPlaintextFile(FileName(fname), as_paragraph);
1998                 break;
1999         }
2000
2001         default:
2002                 // OK, so try the Buffer itself...
2003                 buffer_.dispatch(cmd, dr);
2004                 dispatched = dr.dispatched();
2005                 break;
2006         }
2007
2008         buffer_.undo().endUndoGroup();
2009         dr.dispatched(dispatched);
2010 }
2011
2012
2013 docstring const BufferView::requestSelection()
2014 {
2015         Cursor & cur = d->cursor_;
2016
2017         LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
2018         if (!cur.selection()) {
2019                 d->xsel_cache_.set = false;
2020                 return docstring();
2021         }
2022
2023         LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
2024         if (!d->xsel_cache_.set ||
2025             cur.top() != d->xsel_cache_.cursor ||
2026             cur.realAnchor().top() != d->xsel_cache_.anchor)
2027         {
2028                 d->xsel_cache_.cursor = cur.top();
2029                 d->xsel_cache_.anchor = cur.realAnchor().top();
2030                 d->xsel_cache_.set = cur.selection();
2031                 return cur.selectionAsString(false);
2032         }
2033         return docstring();
2034 }
2035
2036
2037 void BufferView::clearSelection()
2038 {
2039         d->cursor_.clearSelection();
2040         // Clear the selection buffer. Otherwise a subsequent
2041         // middle-mouse-button paste would use the selection buffer,
2042         // not the more current external selection.
2043         cap::clearSelection();
2044         d->xsel_cache_.set = false;
2045         // The buffer did not really change, but this causes the
2046         // redraw we need because we cleared the selection above.
2047         buffer_.changed(false);
2048 }
2049
2050
2051 void BufferView::resize(int width, int height)
2052 {
2053         // Update from work area
2054         width_ = width;
2055         height_ = height;
2056
2057         // Clear the paragraph height cache.
2058         d->par_height_.clear();
2059         // Redo the metrics.
2060         updateMetrics();
2061 }
2062
2063
2064 Inset const * BufferView::getCoveringInset(Text const & text,
2065                 int x, int y) const
2066 {
2067         TextMetrics & tm = d->text_metrics_[&text];
2068         Inset * inset = tm.checkInsetHit(x, y);
2069         if (!inset)
2070                 return 0;
2071
2072         if (!inset->descendable(*this))
2073                 // No need to go further down if the inset is not
2074                 // descendable.
2075                 return inset;
2076
2077         size_t cell_number = inset->nargs();
2078         // Check all the inner cell.
2079         for (size_t i = 0; i != cell_number; ++i) {
2080                 Text const * inner_text = inset->getText(i);
2081                 if (inner_text) {
2082                         // Try deeper.
2083                         Inset const * inset_deeper =
2084                                 getCoveringInset(*inner_text, x, y);
2085                         if (inset_deeper)
2086                                 return inset_deeper;
2087                 }
2088         }
2089
2090         return inset;
2091 }
2092
2093
2094 void BufferView::updateHoveredInset() const
2095 {
2096         // Get inset under mouse, if there is one.
2097         int const x = d->mouse_position_cache_.x_;
2098         int const y = d->mouse_position_cache_.y_;
2099         Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
2100
2101         d->clickable_inset_ = covering_inset && covering_inset->clickable(x, y);
2102
2103         if (covering_inset == d->last_inset_)
2104                 // Same inset, no need to do anything...
2105                 return;
2106
2107         bool need_redraw = false;
2108         if (d->last_inset_) {
2109                 // Remove the hint on the last hovered inset (if any).
2110                 need_redraw |= d->last_inset_->setMouseHover(this, false);
2111                 d->last_inset_ = 0;
2112         }
2113
2114         if (covering_inset && covering_inset->setMouseHover(this, true)) {
2115                 need_redraw = true;
2116                 // Only the insets that accept the hover state, do
2117                 // clear the last_inset_, so only set the last_inset_
2118                 // member if the hovered setting is accepted.
2119                 d->last_inset_ = covering_inset;
2120         }
2121
2122         if (need_redraw) {
2123                 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
2124                                 << d->mouse_position_cache_.x_ << ", "
2125                                 << d->mouse_position_cache_.y_ << ")");
2126
2127                 d->update_strategy_ = DecorationUpdate;
2128
2129                 // This event (moving without mouse click) is not passed further.
2130                 // This should be changed if it is further utilized.
2131                 buffer_.changed(false);
2132         }
2133 }
2134
2135
2136 void BufferView::clearLastInset(Inset * inset) const
2137 {
2138         if (d->last_inset_ != inset) {
2139                 LYXERR0("Wrong last_inset!");
2140                 LATTEST(false);
2141         }
2142         d->last_inset_ = 0;
2143 }
2144
2145
2146 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
2147 {
2148         //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
2149
2150         // This is only called for mouse related events including
2151         // LFUN_FILE_OPEN generated by drag-and-drop.
2152         FuncRequest cmd = cmd0;
2153
2154         Cursor old = cursor();
2155         Cursor cur(*this);
2156         cur.push(buffer_.inset());
2157         cur.setSelection(d->cursor_.selection());
2158
2159         // Either the inset under the cursor or the
2160         // surrounding Text will handle this event.
2161
2162         // make sure we stay within the screen...
2163         cmd.set_y(min(max(cmd.y(), -1), height_));
2164
2165         d->mouse_position_cache_.x_ = cmd.x();
2166         d->mouse_position_cache_.y_ = cmd.y();
2167
2168         if (cmd.action() == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
2169                 updateHoveredInset();
2170                 return;
2171         }
2172
2173         // Build temporary cursor.
2174         Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x(), cmd.y());
2175
2176         // Put anchor at the same position.
2177         cur.resetAnchor();
2178
2179         cur.beginUndoGroup();
2180
2181         // Try to dispatch to an non-editable inset near this position
2182         // via the temp cursor. If the inset wishes to change the real
2183         // cursor it has to do so explicitly by using
2184         //  cur.bv().cursor() = cur;  (or similar)
2185         if (inset)
2186                 inset->dispatch(cur, cmd);
2187
2188         // Now dispatch to the temporary cursor. If the real cursor should
2189         // be modified, the inset's dispatch has to do so explicitly.
2190         if (!inset || !cur.result().dispatched())
2191                 cur.dispatch(cmd);
2192
2193         cur.endUndoGroup();
2194
2195         // Notify left insets
2196         if (cur != old) {
2197                 bool badcursor = old.fixIfBroken() | cur.fixIfBroken();
2198                 badcursor |= notifyCursorLeavesOrEnters(old, cur);
2199                 if (badcursor)
2200                         cursor().fixIfBroken();
2201         }
2202
2203         // Do we have a selection?
2204         theSelection().haveSelection(cursor().selection());
2205
2206         if (cur.needBufferUpdate()) {
2207                 cur.clearBufferUpdate();
2208                 buffer().updateBuffer();
2209         }
2210
2211         // If the command has been dispatched,
2212         if (cur.result().dispatched() || cur.result().screenUpdate())
2213                 processUpdateFlags(cur.result().screenUpdate());
2214 }
2215
2216
2217 int BufferView::minVisiblePart()
2218 {
2219         return 2 * defaultRowHeight();
2220 }
2221
2222
2223 int BufferView::scroll(int y)
2224 {
2225         if (y > 0)
2226                 return scrollDown(y);
2227         if (y < 0)
2228                 return scrollUp(-y);
2229         return 0;
2230 }
2231
2232
2233 int BufferView::scrollDown(int offset)
2234 {
2235         Text * text = &buffer_.text();
2236         TextMetrics & tm = d->text_metrics_[text];
2237         int const ymax = height_ + offset;
2238         while (true) {
2239                 pair<pit_type, ParagraphMetrics const *> last = tm.last();
2240                 int bottom_pos = last.second->position() + last.second->descent();
2241                 if (lyxrc.scroll_below_document)
2242                         bottom_pos += height_ - minVisiblePart();
2243                 if (last.first + 1 == int(text->paragraphs().size())) {
2244                         if (bottom_pos <= height_)
2245                                 return 0;
2246                         offset = min(offset, bottom_pos - height_);
2247                         break;
2248                 }
2249                 if (bottom_pos > ymax)
2250                         break;
2251                 tm.newParMetricsDown();
2252         }
2253         d->anchor_ypos_ -= offset;
2254         return -offset;
2255 }
2256
2257
2258 int BufferView::scrollUp(int offset)
2259 {
2260         Text * text = &buffer_.text();
2261         TextMetrics & tm = d->text_metrics_[text];
2262         int ymin = - offset;
2263         while (true) {
2264                 pair<pit_type, ParagraphMetrics const *> first = tm.first();
2265                 int top_pos = first.second->position() - first.second->ascent();
2266                 if (first.first == 0) {
2267                         if (top_pos >= 0)
2268                                 return 0;
2269                         offset = min(offset, - top_pos);
2270                         break;
2271                 }
2272                 if (top_pos < ymin)
2273                         break;
2274                 tm.newParMetricsUp();
2275         }
2276         d->anchor_ypos_ += offset;
2277         return offset;
2278 }
2279
2280
2281 void BufferView::setCursorFromRow(int row)
2282 {
2283         int tmpid;
2284         int tmppos;
2285         pit_type newpit = 0;
2286         pos_type newpos = 0;
2287
2288         buffer_.texrow().getIdFromRow(row, tmpid, tmppos);
2289
2290         bool posvalid = (tmpid != -1);
2291         if (posvalid) {
2292                 // we need to make sure that the row and position
2293                 // we got back are valid, because the buffer may well
2294                 // have changed since we last generated the LaTeX.
2295                 DocIterator const dit = buffer_.getParFromID(tmpid);
2296                 if (dit == doc_iterator_end(&buffer_))
2297                         posvalid = false;
2298                 else if (dit.depth() > 1) {
2299                         // We are an inset.
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