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