src/BufferView.cpp

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