src/BufferView.cpp

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