src/BufferView_pimpl.C

   1 /**
   2  * \file BufferView_pimpl.C
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Asger Alstrup
   7  * \author Alfredo Braunstein
   8  * \author Lars Gullik Bjønnes
   9  * \author Jean-Marc Lasgouttes
  10  * \author Angus Leeming
  11  * \author John Levon
  12  * \author André Pönitz
  13  * \author Dekel Tsur
  14  * \author Jürgen Vigna
  15  *
  16  * Full author contact details are available in file CREDITS.
  17  */
  18
  19 #include <config.h>
  20
  21 #include "BufferView_pimpl.h"
  22 #include "buffer.h"
  23 #include "buffer_funcs.h"
  24 #include "bufferlist.h"
  25 #include "bufferparams.h"
  26 #include "coordcache.h"
  27 #include "cursor.h"
  28 #include "debug.h"
  29 #include "dispatchresult.h"
  30 #include "factory.h"
  31 #include "FloatList.h"
  32 #include "funcrequest.h"
  33 #include "FuncStatus.h"
  34 #include "gettext.h"
  35 #include "intl.h"
  36 #include "insetiterator.h"
  37 #include "LaTeXFeatures.h"
  38 #include "lyx_cb.h" // added for Dispatch functions
  39 #include "lyx_main.h"
  40 #include "lyxfind.h"
  41 #include "lyxfunc.h"
  42 #include "lyxtext.h"
  43 #include "lyxrc.h"
  44 #include "lastfiles.h"
  45 #include "metricsinfo.h"
  46 #include "paragraph.h"
  47 #include "paragraph_funcs.h"
  48 #include "ParagraphParameters.h"
  49 #include "pariterator.h"
  50 #include "rowpainter.h"
  51 #include "undo.h"
  52 #include "vspace.h"
  53
  54 #include "insets/insetbibtex.h"
  55 #include "insets/insetref.h"
  56 #include "insets/insettext.h"
  57
  58 #include "frontends/Alert.h"
  59 #include "frontends/Dialogs.h"
  60 #include "frontends/FileDialog.h"
  61 #include "frontends/font_metrics.h"
  62 #include "frontends/LyXView.h"
  63 #include "frontends/LyXScreenFactory.h"
  64 #include "frontends/screen.h"
  65 #include "frontends/WorkArea.h"
  66 #include "frontends/WorkAreaFactory.h"
  67
  68 #include "graphics/Previews.h"
  69
  70 #include "support/convert.h"
  71 #include "support/filefilterlist.h"
  72 #include "support/filetools.h"
  73 #include "support/forkedcontr.h"
  74 #include "support/package.h"
  75 #include "support/types.h"
  76
  77 #include <boost/bind.hpp>
  78 #include <boost/current_function.hpp>
  79
  80 #include <functional>
  81 #include <vector>
  82
  83 using lyx::pos_type;
  84
  85 using lyx::support::AddPath;
  86 using lyx::support::bformat;
  87 using lyx::support::FileFilterList;
  88 using lyx::support::FileSearch;
  89 using lyx::support::ForkedcallsController;
  90 using lyx::support::IsDirWriteable;
  91 using lyx::support::MakeDisplayPath;
  92 using lyx::support::MakeAbsPath;
  93 using lyx::support::package;
  94
  95 using std::endl;
  96 using std::istringstream;
  97 using std::make_pair;
  98 using std::min;
  99 using std::max;
 100 using std::string;
 101 using std::mem_fun_ref;
 102 using std::vector;
 103
 104
 105 extern BufferList bufferlist;
 106
 107
 108 namespace {
 109
 110 unsigned int const saved_positions_num = 20;
 111
 112 // All the below connection objects are needed because of a bug in some
 113 // versions of GCC (<=2.96 are on the suspects list.) By having and assigning
 114 // to these connections we avoid a segfault upon startup, and also at exit.
 115 // (Lgb)
 116
 117 boost::signals::connection dispatchcon;
 118 boost::signals::connection timecon;
 119 boost::signals::connection doccon;
 120 boost::signals::connection resizecon;
 121 boost::signals::connection kpresscon;
 122 boost::signals::connection selectioncon;
 123 boost::signals::connection lostcon;
 124
 125
 126 /// Return an inset of this class if it exists at the current cursor position
 127 template <class T>
 128 T * getInsetByCode(LCursor & cur, InsetBase::Code code)
 129 {
 130         T * inset = 0;
 131         DocIterator it = cur;
 132         if (it.nextInset() &&
 133             it.nextInset()->lyxCode() == code) {
 134                 inset = static_cast<T*>(it.nextInset());
 135         }
 136         return inset;
 137 }
 138
 139 } // anon namespace
 140
 141
 142 BufferView::Pimpl::Pimpl(BufferView & bv, LyXView * owner,
 143                          int width, int height)
 144         : bv_(&bv), owner_(owner), buffer_(0), cursor_timeout(400),
 145           using_xterm_cursor(false), cursor_(bv) ,
 146           anchor_ref_(0), offset_ref_(0)
 147 {
 148         xsel_cache_.set = false;
 149
 150         workarea_.reset(WorkAreaFactory::create(*owner_, width, height));
 151         screen_.reset(LyXScreenFactory::create(workarea()));
 152
 153         // Setup the signals
 154         doccon = workarea().scrollDocView
 155                 .connect(boost::bind(&BufferView::Pimpl::scrollDocView, this, _1));
 156         resizecon = workarea().workAreaResize
 157                 .connect(boost::bind(&BufferView::Pimpl::workAreaResize, this));
 158         dispatchcon = workarea().dispatch
 159                 .connect(boost::bind(&BufferView::Pimpl::workAreaDispatch, this, _1));
 160         kpresscon = workarea().workAreaKeyPress
 161                 .connect(boost::bind(&BufferView::Pimpl::workAreaKeyPress, this, _1, _2));
 162         selectioncon = workarea().selectionRequested
 163                 .connect(boost::bind(&BufferView::Pimpl::selectionRequested, this));
 164         lostcon = workarea().selectionLost
 165                 .connect(boost::bind(&BufferView::Pimpl::selectionLost, this));
 166
 167         timecon = cursor_timeout.timeout
 168                 .connect(boost::bind(&BufferView::Pimpl::cursorToggle, this));
 169         cursor_timeout.start();
 170         saved_positions.resize(saved_positions_num);
 171 }
 172
 173
 174 void BufferView::Pimpl::addError(ErrorItem const & ei)
 175 {
 176         errorlist_.push_back(ei);
 177 }
 178
 179
 180 void BufferView::Pimpl::showReadonly(bool)
 181 {
 182         owner_->updateWindowTitle();
 183         owner_->getDialogs().updateBufferDependent(false);
 184 }
 185
 186
 187 void BufferView::Pimpl::connectBuffer(Buffer & buf)
 188 {
 189         if (errorConnection_.connected())
 190                 disconnectBuffer();
 191
 192         errorConnection_ =
 193                 buf.error.connect(
 194                         boost::bind(&BufferView::Pimpl::addError, this, _1));
 195
 196         messageConnection_ =
 197                 buf.message.connect(
 198                         boost::bind(&LyXView::message, owner_, _1));
 199
 200         busyConnection_ =
 201                 buf.busy.connect(
 202                         boost::bind(&LyXView::busy, owner_, _1));
 203
 204         titleConnection_ =
 205                 buf.updateTitles.connect(
 206                         boost::bind(&LyXView::updateWindowTitle, owner_));
 207
 208         timerConnection_ =
 209                 buf.resetAutosaveTimers.connect(
 210                         boost::bind(&LyXView::resetAutosaveTimer, owner_));
 211
 212         readonlyConnection_ =
 213                 buf.readonly.connect(
 214                         boost::bind(&BufferView::Pimpl::showReadonly, this, _1));
 215
 216         closingConnection_ =
 217                 buf.closing.connect(
 218                         boost::bind(&BufferView::Pimpl::setBuffer, this, (Buffer *)0));
 219 }
 220
 221
 222 void BufferView::Pimpl::disconnectBuffer()
 223 {
 224         errorConnection_.disconnect();
 225         messageConnection_.disconnect();
 226         busyConnection_.disconnect();
 227         titleConnection_.disconnect();
 228         timerConnection_.disconnect();
 229         readonlyConnection_.disconnect();
 230         closingConnection_.disconnect();
 231 }
 232
 233
 234 void BufferView::Pimpl::newFile(string const & filename, string const & tname,
 235         bool isNamed)
 236 {
 237         setBuffer(::newFile(filename, tname, isNamed));
 238 }
 239
 240
 241 bool BufferView::Pimpl::loadLyXFile(string const & filename, bool tolastfiles)
 242 {
 243         // Get absolute path of file and add ".lyx"
 244         // to the filename if necessary
 245         string s = FileSearch(string(), filename, "lyx");
 246
 247         bool const found = !s.empty();
 248
 249         if (!found)
 250                 s = filename;
 251
 252         // File already open?
 253         if (bufferlist.exists(s)) {
 254                 string const file = MakeDisplayPath(s, 20);
 255                 string text = bformat(_("The document %1$s is already "
 256                                         "loaded.\n\nDo you want to revert "
 257                                         "to the saved version?"), file);
 258                 int const ret = Alert::prompt(_("Revert to saved document?"),
 259                         text, 0, 1,  _("&Revert"), _("&Switch to document"));
 260
 261                 if (ret != 0) {
 262                         setBuffer(bufferlist.getBuffer(s));
 263                         return true;
 264                 }
 265                 // FIXME: should be LFUN_REVERT
 266                 if (!bufferlist.close(bufferlist.getBuffer(s), false))
 267                         return false;
 268                 // Fall through to new load. (Asger)
 269         }
 270
 271         Buffer * b;
 272
 273         if (found) {
 274                 b = bufferlist.newBuffer(s);
 275                 connectBuffer(*b);
 276                 if (!::loadLyXFile(b, s)) {
 277                         bufferlist.release(b);
 278                         return false;
 279                 }
 280         } else {
 281                 string text = bformat(_("The document %1$s does not yet "
 282                                         "exist.\n\nDo you want to create "
 283                                         "a new document?"), s);
 284                 int const ret = Alert::prompt(_("Create new document?"),
 285                          text, 0, 1, _("&Create"), _("Cancel"));
 286
 287                 if (ret == 0)
 288                         b = ::newFile(s, string(), true);
 289                 else
 290                         return false;
 291         }
 292
 293         setBuffer(b);
 294         bv_->showErrorList(_("Parse"));
 295
 296         if (tolastfiles)
 297                 LyX::ref().lastfiles().newFile(b->fileName());
 298
 299         return true;
 300 }
 301
 302
 303 WorkArea & BufferView::Pimpl::workarea() const
 304 {
 305         return *workarea_.get();
 306 }
 307
 308
 309 LyXScreen & BufferView::Pimpl::screen() const
 310 {
 311         return *screen_.get();
 312 }
 313
 314
 315 Painter & BufferView::Pimpl::painter() const
 316 {
 317         return workarea().getPainter();
 318 }
 319
 320
 321 void BufferView::Pimpl::setBuffer(Buffer * b)
 322 {
 323         lyxerr[Debug::INFO] << BOOST_CURRENT_FUNCTION
 324                             << "[ b = " << b << "]" << endl;
 325
 326         if (buffer_) {
 327                 disconnectBuffer();
 328                 // Save the actual cursor position and anchor inside the
 329                 // buffer so that it can be restored in case we rechange
 330                 // to this buffer later on.
 331                 buffer_->saveCursor(cursor_.selectionBegin(),
 332                                     cursor_.selectionEnd());
 333         }
 334
 335         // If we are closing current buffer, switch to the first in
 336         // buffer list.
 337         if (!b) {
 338                 lyxerr[Debug::INFO] << BOOST_CURRENT_FUNCTION
 339                                     << " No Buffer!" << endl;
 340                 // We are closing the buffer, use the first buffer as current
 341                 buffer_ = bufferlist.first();
 342                 owner_->getDialogs().hideBufferDependent();
 343         } else {
 344                 // Set current buffer
 345                 buffer_ = b;
 346         }
 347
 348         // Reset old cursor
 349         cursor_ = LCursor(*bv_);
 350         anchor_ref_ = 0;
 351         offset_ref_ = 0;
 352
 353
 354         // If we're quitting lyx, don't bother updating stuff
 355         if (quitting)
 356                 return;
 357
 358         if (buffer_) {
 359                 lyxerr[Debug::INFO] << BOOST_CURRENT_FUNCTION
 360                                     << "Buffer addr: " << buffer_ << endl;
 361                 connectBuffer(*buffer_);
 362                 cursor_.push(buffer_->inset());
 363                 cursor_.resetAnchor();
 364                 buffer_->text().init(bv_);
 365                 buffer_->text().setCurrentFont(cursor_);
 366                 if (buffer_->getCursor().size() > 0 &&
 367                     buffer_->getAnchor().size() > 0)
 368                 {
 369                         cursor_.setCursor(buffer_->getAnchor().asDocIterator(&(buffer_->inset())));
 370                         cursor_.resetAnchor();
 371                         cursor_.setCursor(buffer_->getCursor().asDocIterator(&(buffer_->inset())));
 372                         cursor_.setSelection();
 373                 }
 374
 375                 // Buffer-dependent dialogs should be updated or
 376                 // hidden. This should go here because some dialogs (eg ToC)
 377                 // require bv_->text.
 378                 owner_->getDialogs().updateBufferDependent(true);
 379         }
 380
 381         update();
 382         updateScrollbar();
 383         owner_->updateMenubar();
 384         owner_->updateToolbars();
 385         owner_->updateLayoutChoice();
 386         owner_->updateWindowTitle();
 387
 388         // This is done after the layout combox has been populated
 389         if (buffer_)
 390                 owner_->setLayout(cursor_.paragraph().layout()->name());
 391
 392         if (buffer_ && lyx::graphics::Previews::status() != LyXRC::PREVIEW_OFF)
 393                 lyx::graphics::Previews::get().generateBufferPreviews(*buffer_);
 394 }
 395
 396
 397 void BufferView::Pimpl::resizeCurrentBuffer()
 398 {
 399         lyxerr[Debug::DEBUG] << BOOST_CURRENT_FUNCTION << endl;
 400         owner_->busy(true);
 401         owner_->message(_("Formatting document..."));
 402
 403         LyXText * text = bv_->text();
 404         if (!text)
 405                 return;
 406
 407         text->init(bv_);
 408         update();
 409
 410         switchKeyMap();
 411         owner_->busy(false);
 412
 413         // Reset the "Formatting..." message
 414         owner_->clearMessage();
 415
 416         updateScrollbar();
 417 }
 418
 419
 420 void BufferView::Pimpl::updateScrollbar()
 421 {
 422         if (!bv_->text()) {
 423                 lyxerr[Debug::DEBUG] << BOOST_CURRENT_FUNCTION
 424                                      << " no text in updateScrollbar" << endl;
 425                 workarea().setScrollbarParams(0, 0, 0);
 426                 return;
 427         }
 428
 429         LyXText & t = *bv_->text();
 430         if (anchor_ref_ >  int(t.paragraphs().size()) - 1) {
 431                 anchor_ref_ = int(t.paragraphs().size()) - 1;
 432                 offset_ref_ = 0;
 433         }
 434
 435         lyxerr[Debug::GUI]
 436                 << BOOST_CURRENT_FUNCTION
 437                 << " Updating scrollbar: height: " << t.paragraphs().size()
 438                 << " curr par: " << cursor_.bottom().pit()
 439                 << " default height " << defaultRowHeight() << endl;
 440
 441         // It would be better to fix the scrollbar to understand
 442         // values in [0..1] and divide everything by wh
 443         int const wh = workarea().workHeight() / 4;
 444         int const h = t.getPar(anchor_ref_).height();
 445         workarea().setScrollbarParams(t.paragraphs().size() * wh, anchor_ref_ * wh + int(offset_ref_ * wh / float(h)), int (wh * defaultRowHeight() / float(h)));
 446 //      workarea().setScrollbarParams(t.paragraphs().size(), anchor_ref_, 1);
 447 }
 448
 449
 450 void BufferView::Pimpl::scrollDocView(int value)
 451 {
 452         lyxerr[Debug::GUI] << BOOST_CURRENT_FUNCTION
 453                            << "[ value = " << value << "]" << endl;
 454
 455         if (!buffer_)
 456                 return;
 457
 458         screen().hideCursor();
 459
 460         int const wh = workarea().workHeight() / 4;
 461
 462         LyXText & t = *bv_->text();
 463
 464         float const bar = value / float(wh * t.paragraphs().size());
 465
 466         anchor_ref_ = int(bar * t.paragraphs().size());
 467         t.redoParagraph(anchor_ref_);
 468         int const h = t.getPar(anchor_ref_).height();
 469         offset_ref_ = int((bar * t.paragraphs().size() - anchor_ref_) * h);
 470         update();
 471
 472         if (!lyxrc.cursor_follows_scrollbar)
 473                 return;
 474
 475         int const height = 2 * defaultRowHeight();
 476         int const first = height;
 477         int const last = workarea().workHeight() - height;
 478         LCursor & cur = cursor_;
 479
 480         bv_funcs::CurStatus st = bv_funcs::status(bv_, cur);
 481
 482         switch (st) {
 483         case bv_funcs::CUR_ABOVE:
 484                 t.setCursorFromCoordinates(cur, 0, first);
 485                 cur.clearSelection();
 486                 break;
 487         case bv_funcs::CUR_BELOW:
 488                 t.setCursorFromCoordinates(cur, 0, last);
 489                 cur.clearSelection();
 490                 break;
 491         case bv_funcs::CUR_INSIDE:
 492                 int const y = bv_funcs::getPos(cur, cur.boundary()).y_;
 493                 int const newy = min(last, max(y, first));
 494                 if (y != newy) {
 495                         cur.reset(buffer_->inset());
 496                         t.setCursorFromCoordinates(cur, 0, newy);
 497                 }
 498         }
 499         owner_->updateLayoutChoice();
 500 }
 501
 502
 503 void BufferView::Pimpl::scroll(int /*lines*/)
 504 {
 505 //      if (!buffer_)
 506 //              return;
 507 //
 508 //      LyXText const * t = bv_->text();
 509 //      int const line_height = defaultRowHeight();
 510 //
 511 //      // The new absolute coordinate
 512 //      int new_top_y = top_y() + lines * line_height;
 513 //
 514 //      // Restrict to a valid value
 515 //      new_top_y = std::min(t->height() - 4 * line_height, new_top_y);
 516 //      new_top_y = std::max(0, new_top_y);
 517 //
 518 //      scrollDocView(new_top_y);
 519 //
 520 //      // Update the scrollbar.
 521 //      workarea().setScrollbarParams(t->height(), top_y(), defaultRowHeight());
 522 }
 523
 524
 525 void BufferView::Pimpl::workAreaKeyPress(LyXKeySymPtr key,
 526                                          key_modifier::state state)
 527 {
 528         owner_->getLyXFunc().processKeySym(key, state);
 529
 530         /* This is perhaps a bit of a hack. When we move
 531          * around, or type, it's nice to be able to see
 532          * the cursor immediately after the keypress. So
 533          * we reset the toggle timeout and force the visibility
 534          * of the cursor. Note we cannot do this inside
 535          * dispatch() itself, because that's called recursively.
 536          */
 537         if (available())
 538                 screen().showCursor(*bv_);
 539 }
 540
 541
 542 void BufferView::Pimpl::selectionRequested()
 543 {
 544         static string sel;
 545
 546         if (!available())
 547                 return;
 548
 549         LCursor & cur = cursor_;
 550
 551         if (!cur.selection()) {
 552                 xsel_cache_.set = false;
 553                 return;
 554         }
 555
 556         if (!xsel_cache_.set ||
 557             cur.top() != xsel_cache_.cursor ||
 558             cur.anchor_.top() != xsel_cache_.anchor)
 559         {
 560                 xsel_cache_.cursor = cur.top();
 561                 xsel_cache_.anchor = cur.anchor_.top();
 562                 xsel_cache_.set = cur.selection();
 563                 sel = cur.selectionAsString(false);
 564                 if (!sel.empty())
 565                         workarea().putClipboard(sel);
 566         }
 567 }
 568
 569
 570 void BufferView::Pimpl::selectionLost()
 571 {
 572         if (available()) {
 573                 screen().hideCursor();
 574                 cursor_.clearSelection();
 575                 xsel_cache_.set = false;
 576         }
 577 }
 578
 579
 580 void BufferView::Pimpl::workAreaResize()
 581 {
 582         static int work_area_width;
 583         static int work_area_height;
 584
 585         bool const widthChange = workarea().workWidth() != work_area_width;
 586         bool const heightChange = workarea().workHeight() != work_area_height;
 587
 588         // Update from work area
 589         work_area_width = workarea().workWidth();
 590         work_area_height = workarea().workHeight();
 591
 592         if (buffer_ && widthChange) {
 593                 // The visible LyXView need a resize
 594                 resizeCurrentBuffer();
 595         }
 596
 597         if (widthChange || heightChange)
 598                 update();
 599
 600         // Always make sure that the scrollbar is sane.
 601         updateScrollbar();
 602         owner_->updateLayoutChoice();
 603 }
 604
 605
 606 bool BufferView::Pimpl::fitCursor()
 607 {
 608         if (bv_funcs::status(bv_, cursor_) == bv_funcs::CUR_INSIDE) {
 609                 LyXFont const font = cursor_.getFont();
 610                 int const asc = font_metrics::maxAscent(font);
 611                 int const des = font_metrics::maxDescent(font);
 612                 Point const p = bv_funcs::getPos(cursor_, cursor_.boundary());
 613                 if (p.y_ - asc >= 0 && p.y_ + des < workarea().workHeight())
 614                         return false;
 615         }
 616         center();
 617         return true;
 618 }
 619
 620
 621 void BufferView::Pimpl::update(Update::flags flags)
 622 {
 623         lyxerr[Debug::DEBUG]
 624                 << BOOST_CURRENT_FUNCTION
 625                 << "[fitcursor = " << (flags & Update::FitCursor)
 626                 << ", forceupdate = " << (flags & Update::Force)
 627                 << ", singlepar = " << (flags & Update::SinglePar)
 628                 << "]  buffer: " << buffer_ << endl;
 629
 630         // Check needed to survive LyX startup
 631         if (buffer_) {
 632                 // Update macro store
 633                 buffer_->buildMacros();
 634
 635                 CoordCache backup;
 636                 std::swap(theCoords, backup);
 637
 638                 // This, together with doneUpdating(), verifies (using
 639                 // asserts) that screen redraw is not called from
 640                 // within itself.
 641                 theCoords.startUpdating();
 642
 643                 // First drawing step
 644                 ViewMetricsInfo vi = metrics();
 645                 bool forceupdate(flags & Update::Force);
 646
 647                 if ((flags & Update::FitCursor) && fitCursor()) {
 648                         forceupdate = true;
 649                         vi = metrics(flags & Update::SinglePar);
 650                 }
 651                 if (forceupdate) {
 652                         // Second drawing step
 653                         screen().redraw(*bv_, vi);
 654                 } else {
 655                         // Abort updating of the coord
 656                         // cache - just restore the old one
 657                         std::swap(theCoords, backup);
 658                 }
 659         } else
 660                 screen().greyOut();
 661
 662         // And the scrollbar
 663         updateScrollbar();
 664         owner_->view_state_changed();
 665 }
 666
 667
 668 // Callback for cursor timer
 669 void BufferView::Pimpl::cursorToggle()
 670 {
 671         if (buffer_) {
 672                 screen().toggleCursor(*bv_);
 673
 674                 // Use this opportunity to deal with any child processes that
 675                 // have finished but are waiting to communicate this fact
 676                 // to the rest of LyX.
 677                 ForkedcallsController & fcc = ForkedcallsController::get();
 678                 fcc.handleCompletedProcesses();
 679         }
 680
 681         cursor_timeout.restart();
 682 }
 683
 684
 685 bool BufferView::Pimpl::available() const
 686 {
 687         return buffer_ && bv_->text();
 688 }
 689
 690
 691 Change const BufferView::Pimpl::getCurrentChange()
 692 {
 693         if (!buffer_->params().tracking_changes)
 694                 return Change(Change::UNCHANGED);
 695
 696         LyXText * text = bv_->getLyXText();
 697         LCursor & cur = cursor_;
 698
 699         if (!cur.selection())
 700                 return Change(Change::UNCHANGED);
 701
 702         return text->getPar(cur.selBegin().pit()).
 703                         lookupChangeFull(cur.selBegin().pos());
 704 }
 705
 706
 707 void BufferView::Pimpl::savePosition(unsigned int i)
 708 {
 709         if (i >= saved_positions_num)
 710                 return;
 711         BOOST_ASSERT(cursor_.inTexted());
 712         saved_positions[i] = Position(buffer_->fileName(),
 713                                       cursor_.paragraph().id(),
 714                                       cursor_.pos());
 715         if (i > 0)
 716                 owner_->message(bformat(_("Saved bookmark %1$d"), i));
 717 }
 718
 719
 720 void BufferView::Pimpl::restorePosition(unsigned int i)
 721 {
 722         if (i >= saved_positions_num)
 723                 return;
 724
 725         string const fname = saved_positions[i].filename;
 726
 727         cursor_.clearSelection();
 728
 729         if (fname != buffer_->fileName()) {
 730                 Buffer * b = 0;
 731                 if (bufferlist.exists(fname))
 732                         b = bufferlist.getBuffer(fname);
 733                 else {
 734                         b = bufferlist.newBuffer(fname);
 735                         // Don't ask, just load it
 736                         ::loadLyXFile(b, fname);
 737                 }
 738                 if (b)
 739                         setBuffer(b);
 740         }
 741
 742         ParIterator par = buffer_->getParFromID(saved_positions[i].par_id);
 743         if (par == buffer_->par_iterator_end())
 744                 return;
 745
 746         bv_->setCursor(makeDocIterator(par, min(par->size(), saved_positions[i].par_pos)));
 747
 748         if (i > 0)
 749                 owner_->message(bformat(_("Moved to bookmark %1$d"), i));
 750 }
 751
 752
 753 bool BufferView::Pimpl::isSavedPosition(unsigned int i)
 754 {
 755         return i < saved_positions_num && !saved_positions[i].filename.empty();
 756 }
 757
 758
 759 void BufferView::Pimpl::switchKeyMap()
 760 {
 761         if (!lyxrc.rtl_support)
 762                 return;
 763
 764         Intl & intl = owner_->getIntl();
 765         if (bv_->getLyXText()->real_current_font.isRightToLeft()) {
 766                 if (intl.keymap == Intl::PRIMARY)
 767                         intl.KeyMapSec();
 768         } else {
 769                 if (intl.keymap == Intl::SECONDARY)
 770                         intl.KeyMapPrim();
 771         }
 772 }
 773
 774
 775 void BufferView::Pimpl::center()
 776 {
 777         CursorSlice & bot = cursor_.bottom();
 778         lyx::pit_type const pit = bot.pit();
 779         bot.text()->redoParagraph(pit);
 780         Paragraph const & par = bot.text()->paragraphs()[pit];
 781         anchor_ref_ = pit;
 782         offset_ref_ = bv_funcs::coordOffset(cursor_, cursor_.boundary()).y_
 783                 + par.ascent() - workarea().workHeight() / 2;
 784 }
 785
 786
 787 void BufferView::Pimpl::stuffClipboard(string const & content) const
 788 {
 789         workarea().putClipboard(content);
 790 }
 791
 792
 793 void BufferView::Pimpl::MenuInsertLyXFile(string const & filenm)
 794 {
 795         string filename = filenm;
 796
 797         if (filename.empty()) {
 798                 // Launch a file browser
 799                 string initpath = lyxrc.document_path;
 800
 801                 if (available()) {
 802                         string const trypath = owner_->buffer()->filePath();
 803                         // If directory is writeable, use this as default.
 804                         if (IsDirWriteable(trypath))
 805                                 initpath = trypath;
 806                 }
 807
 808                 FileDialog fileDlg(_("Select LyX document to insert"),
 809                         LFUN_FILE_INSERT,
 810                         make_pair(string(_("Documents|#o#O")),
 811                                   string(lyxrc.document_path)),
 812                         make_pair(string(_("Examples|#E#e")),
 813                                   string(AddPath(package().system_support(), "examples"))));
 814
 815                 FileDialog::Result result =
 816                         fileDlg.open(initpath,
 817                                      FileFilterList(_("LyX Documents (*.lyx)")),
 818                                      string());
 819
 820                 if (result.first == FileDialog::Later)
 821                         return;
 822
 823                 filename = result.second;
 824
 825                 // check selected filename
 826                 if (filename.empty()) {
 827                         owner_->message(_("Canceled."));
 828                         return;
 829                 }
 830         }
 831
 832         // Get absolute path of file and add ".lyx"
 833         // to the filename if necessary
 834         filename = FileSearch(string(), filename, "lyx");
 835
 836         string const disp_fn = MakeDisplayPath(filename);
 837         owner_->message(bformat(_("Inserting document %1$s..."), disp_fn));
 838
 839         cursor_.clearSelection();
 840         bv_->getLyXText()->breakParagraph(cursor_);
 841
 842         BOOST_ASSERT(cursor_.inTexted());
 843
 844         string const fname = MakeAbsPath(filename);
 845         bool const res = buffer_->readFile(fname, cursor_.pit());
 846         resizeCurrentBuffer();
 847
 848         string s = res ? _("Document %1$s inserted.")
 849                        : _("Could not insert document %1$s");
 850         owner_->message(bformat(s, disp_fn));
 851 }
 852
 853
 854 void BufferView::Pimpl::trackChanges()
 855 {
 856         bool const tracking = buffer_->params().tracking_changes;
 857
 858         if (!tracking) {
 859                 for_each(buffer_->par_iterator_begin(),
 860                          buffer_->par_iterator_end(),
 861                          bind(&Paragraph::trackChanges, _1, Change::UNCHANGED));
 862                 buffer_->params().tracking_changes = true;
 863
 864                 // We cannot allow undos beyond the freeze point
 865                 buffer_->undostack().clear();
 866         } else {
 867                 update();
 868                 bv_->text()->setCursor(cursor_, 0, 0);
 869 #ifdef WITH_WARNINGS
 870 #warning changes FIXME
 871 #endif
 872                 bool const found = lyx::find::findNextChange(bv_);
 873                 if (found) {
 874                         owner_->getDialogs().show("changes");
 875                         return;
 876                 }
 877
 878                 for_each(buffer_->par_iterator_begin(),
 879                          buffer_->par_iterator_end(),
 880                          mem_fun_ref(&Paragraph::untrackChanges));
 881
 882                 buffer_->params().tracking_changes = false;
 883         }
 884
 885         buffer_->redostack().clear();
 886 }
 887
 888
 889 bool BufferView::Pimpl::workAreaDispatch(FuncRequest const & cmd0)
 890 {
 891         //lyxerr << BOOST_CURRENT_FUNCTION << "[ cmd0 " << cmd0 << "]" << endl;
 892
 893         // This is only called for mouse related events including
 894         // LFUN_FILE_OPEN generated by drag-and-drop.
 895         FuncRequest cmd = cmd0;
 896
 897         // Handle drag&drop
 898         if (cmd.action == LFUN_FILE_OPEN) {
 899                 owner_->dispatch(cmd);
 900                 return true;
 901         }
 902
 903         if (!buffer_)
 904                 return false;
 905
 906         LCursor cur(*bv_);
 907         cur.push(buffer_->inset());
 908         cur.selection() = cursor_.selection();
 909
 910         // Doesn't go through lyxfunc, so we need to update
 911         // the layout choice etc. ourselves
 912
 913         // E.g. Qt mouse press when no buffer
 914         if (!available())
 915                 return false;
 916
 917         screen().hideCursor();
 918
 919         // Either the inset under the cursor or the
 920         // surrounding LyXText will handle this event.
 921
 922         // Build temporary cursor.
 923         cmd.y = min(max(cmd.y,-1), workarea().workHeight());
 924         InsetBase * inset = bv_->text()->editXY(cur, cmd.x, cmd.y);
 925         //lyxerr << BOOST_CURRENT_FUNCTION
 926         //       << " * hit inset at tip: " << inset << endl;
 927         //lyxerr << BOOST_CURRENT_FUNCTION
 928         //       << " * created temp cursor:" << cur << endl;
 929
 930         // Put anchor at the same position.
 931         cur.resetAnchor();
 932
 933         // Try to dispatch to an non-editable inset near this position
 934         // via the temp cursor. If the inset wishes to change the real
 935         // cursor it has to do so explicitly by using
 936         //  cur.bv().cursor() = cur;  (or similar)
 937         if (inset)
 938                 inset->dispatch(cur, cmd);
 939
 940         // Now dispatch to the temporary cursor. If the real cursor should
 941         // be modified, the inset's dispatch has to do so explicitly.
 942         if (!cur.result().dispatched())
 943                 cur.dispatch(cmd);
 944
 945         if (cur.result().dispatched()) {
 946                 // Redraw if requested or necessary.
 947                 if (cur.result().update())
 948                         update(Update::FitCursor | Update::Force);
 949                 else
 950                         update();
 951         }
 952
 953         // See workAreaKeyPress
 954         cursor_timeout.restart();
 955         screen().showCursor(*bv_);
 956
 957         // Skip these when selecting
 958         if (cmd.action != LFUN_MOUSE_MOTION) {
 959                 owner_->updateLayoutChoice();
 960                 owner_->updateToolbars();
 961         }
 962
 963         // Slight hack: this is only called currently when we
 964         // clicked somewhere, so we force through the display
 965         // of the new status here.
 966         owner_->clearMessage();
 967         return true;
 968 }
 969
 970
 971 FuncStatus BufferView::Pimpl::getStatus(FuncRequest const & cmd)
 972 {
 973         FuncStatus flag;
 974
 975         switch (cmd.action) {
 976
 977         case LFUN_UNDO:
 978                 flag.enabled(!buffer_->undostack().empty());
 979                 break;
 980         case LFUN_REDO:
 981                 flag.enabled(!buffer_->redostack().empty());
 982                 break;
 983         case LFUN_FILE_INSERT:
 984         case LFUN_FILE_INSERT_ASCII_PARA:
 985         case LFUN_FILE_INSERT_ASCII:
 986         case LFUN_FONT_STATE:
 987         case LFUN_INSERT_LABEL:
 988         case LFUN_BOOKMARK_SAVE:
 989         case LFUN_GOTO_PARAGRAPH:
 990         case LFUN_GOTOERROR:
 991         case LFUN_GOTONOTE:
 992         case LFUN_REFERENCE_GOTO:
 993         case LFUN_WORD_FIND:
 994         case LFUN_WORD_REPLACE:
 995         case LFUN_MARK_OFF:
 996         case LFUN_MARK_ON:
 997         case LFUN_SETMARK:
 998         case LFUN_CENTER:
 999         case LFUN_BIBDB_ADD:
1000         case LFUN_BIBDB_DEL:
1001         case LFUN_WORDS_COUNT:
1002                 flag.enabled(true);
1003                 break;
1004
1005         case LFUN_LABEL_GOTO: {
1006                 flag.enabled(!cmd.argument.empty()
1007                     || getInsetByCode<InsetRef>(cursor_, InsetBase::REF_CODE));
1008                 break;
1009         }
1010
1011         case LFUN_BOOKMARK_GOTO:
1012                 flag.enabled(isSavedPosition(convert<unsigned int>(cmd.argument)));
1013                 break;
1014         case LFUN_TRACK_CHANGES:
1015                 flag.enabled(true);
1016                 flag.setOnOff(buffer_->params().tracking_changes);
1017                 break;
1018
1019         case LFUN_OUTPUT_CHANGES: {
1020                 LaTeXFeatures features(*buffer_, buffer_->params(), false);
1021                 flag.enabled(buffer_ && buffer_->params().tracking_changes
1022                         && features.isAvailable("dvipost"));
1023                 flag.setOnOff(buffer_->params().output_changes);
1024                 break;
1025         }
1026
1027         case LFUN_MERGE_CHANGES:
1028         case LFUN_ACCEPT_CHANGE: // what about these two
1029         case LFUN_REJECT_CHANGE: // what about these two
1030         case LFUN_ACCEPT_ALL_CHANGES:
1031         case LFUN_REJECT_ALL_CHANGES:
1032                 flag.enabled(buffer_ && buffer_->params().tracking_changes);
1033                 break;
1034         default:
1035                 flag.enabled(false);
1036         }
1037
1038         return flag;
1039 }
1040
1041
1042
1043 bool BufferView::Pimpl::dispatch(FuncRequest const & cmd)
1044 {
1045         //lyxerr << BOOST_CURRENT_FUNCTION
1046         //       << [ cmd = " << cmd << "]" << endl;
1047
1048         // Make sure that the cached BufferView is correct.
1049         lyxerr[Debug::ACTION] << BOOST_CURRENT_FUNCTION
1050                 << " action[" << cmd.action << ']'
1051                 << " arg[" << cmd.argument << ']'
1052                 << " x[" << cmd.x << ']'
1053                 << " y[" << cmd.y << ']'
1054                 << " button[" << cmd.button() << ']'
1055                 << endl;
1056
1057         LCursor & cur = cursor_;
1058
1059         switch (cmd.action) {
1060
1061         case LFUN_UNDO:
1062                 if (available()) {
1063                         cur.message(_("Undo"));
1064                         cur.clearSelection();
1065                         if (!textUndo(*bv_))
1066                                 cur.message(_("No further undo information"));
1067                         update();
1068                         switchKeyMap();
1069                 }
1070                 break;
1071
1072         case LFUN_REDO:
1073                 if (available()) {
1074                         cur.message(_("Redo"));
1075                         cur.clearSelection();
1076                         if (!textRedo(*bv_))
1077                                 cur.message(_("No further redo information"));
1078                         update();
1079                         switchKeyMap();
1080                 }
1081                 break;
1082
1083         case LFUN_FILE_INSERT:
1084                 MenuInsertLyXFile(cmd.argument);
1085                 break;
1086
1087         case LFUN_FILE_INSERT_ASCII_PARA:
1088                 InsertAsciiFile(bv_, cmd.argument, true);
1089                 break;
1090
1091         case LFUN_FILE_INSERT_ASCII:
1092                 InsertAsciiFile(bv_, cmd.argument, false);
1093                 break;
1094
1095         case LFUN_FONT_STATE:
1096                 cur.message(cur.currentState());
1097                 break;
1098
1099         case LFUN_BOOKMARK_SAVE:
1100                 savePosition(convert<unsigned int>(cmd.argument));
1101                 break;
1102
1103         case LFUN_BOOKMARK_GOTO:
1104                 restorePosition(convert<unsigned int>(cmd.argument));
1105                 break;
1106
1107         case LFUN_LABEL_GOTO: {
1108                 string label = cmd.argument;
1109                 if (label.empty()) {
1110                         InsetRef * inset =
1111                                 getInsetByCode<InsetRef>(cursor_,
1112                                                          InsetBase::REF_CODE);
1113                         if (inset) {
1114                                 label = inset->getContents();
1115                                 savePosition(0);
1116                         }
1117                 }
1118
1119                 if (!label.empty())
1120                         bv_->gotoLabel(label);
1121                 break;
1122         }
1123
1124         case LFUN_GOTO_PARAGRAPH: {
1125                 int const id = convert<int>(cmd.argument);
1126                 ParIterator par = buffer_->getParFromID(id);
1127                 if (par == buffer_->par_iterator_end()) {
1128                         lyxerr[Debug::INFO] << "No matching paragraph found! ["
1129                                             << id << ']' << endl;
1130                         break;
1131                 } else {
1132                         lyxerr[Debug::INFO] << "Paragraph " << par->id()
1133                                             << " found." << endl;
1134                 }
1135
1136                 // Set the cursor
1137                 bv_->setCursor(makeDocIterator(par, 0));
1138
1139                 update();
1140                 switchKeyMap();
1141                 break;
1142         }
1143
1144         case LFUN_GOTOERROR:
1145                 bv_funcs::gotoInset(bv_, InsetBase::ERROR_CODE, false);
1146                 break;
1147
1148         case LFUN_GOTONOTE:
1149                 bv_funcs::gotoInset(bv_, InsetBase::NOTE_CODE, false);
1150                 break;
1151
1152         case LFUN_REFERENCE_GOTO: {
1153                 vector<InsetBase_code> tmp;
1154                 tmp.push_back(InsetBase::LABEL_CODE);
1155                 tmp.push_back(InsetBase::REF_CODE);
1156                 bv_funcs::gotoInset(bv_, tmp, true);
1157                 break;
1158         }
1159
1160         case LFUN_TRACK_CHANGES:
1161                 trackChanges();
1162                 break;
1163
1164         case LFUN_OUTPUT_CHANGES: {
1165                 bool const state = buffer_->params().output_changes;
1166                 buffer_->params().output_changes = !state;
1167                 break;
1168         }
1169
1170         case LFUN_MERGE_CHANGES:
1171                 owner_->getDialogs().show("changes");
1172                 break;
1173
1174         case LFUN_ACCEPT_ALL_CHANGES: {
1175                 cursor_.reset(buffer_->inset());
1176 #ifdef WITH_WARNINGS
1177 #warning FIXME changes
1178 #endif
1179                 while (lyx::find::findNextChange(bv_))
1180                         bv_->getLyXText()->acceptChange(cursor_);
1181                 update();
1182                 break;
1183         }
1184
1185         case LFUN_REJECT_ALL_CHANGES: {
1186                 cursor_.reset(buffer_->inset());
1187 #ifdef WITH_WARNINGS
1188 #warning FIXME changes
1189 #endif
1190                 while (lyx::find::findNextChange(bv_))
1191                         bv_->getLyXText()->rejectChange(cursor_);
1192                 break;
1193         }
1194
1195         case LFUN_WORD_FIND:
1196                 lyx::find::find(bv_, cmd);
1197                 break;
1198
1199         case LFUN_WORD_REPLACE:
1200                 lyx::find::replace(bv_, cmd);
1201                 break;
1202
1203         case LFUN_MARK_OFF:
1204                 cur.clearSelection();
1205                 cur.resetAnchor();
1206                 cur.message(N_("Mark off"));
1207                 break;
1208
1209         case LFUN_MARK_ON:
1210                 cur.clearSelection();
1211                 cur.mark() = true;
1212                 cur.resetAnchor();
1213                 cur.message(N_("Mark on"));
1214                 break;
1215
1216         case LFUN_SETMARK:
1217                 cur.clearSelection();
1218                 if (cur.mark()) {
1219                         cur.mark() = false;
1220                         cur.message(N_("Mark removed"));
1221                 } else {
1222                         cur.mark() = true;
1223                         cur.message(N_("Mark set"));
1224                 }
1225                 cur.resetAnchor();
1226                 break;
1227
1228         case LFUN_CENTER:
1229                 center();
1230                 break;
1231
1232         case LFUN_BIBDB_ADD: {
1233                 LCursor tmpcur = cursor_;
1234                 bv_funcs::findInset(tmpcur, InsetBase::BIBTEX_CODE, false);
1235                 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1236                                                 InsetBase::BIBTEX_CODE);
1237                 if (inset)
1238                         inset->addDatabase(cmd.argument);
1239                 break;
1240         }
1241
1242         case LFUN_BIBDB_DEL: {
1243                 LCursor tmpcur = cursor_;
1244                 bv_funcs::findInset(tmpcur, InsetBase::BIBTEX_CODE, false);
1245                 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1246                                                 InsetBase::BIBTEX_CODE);
1247                 if (inset)
1248                         inset->delDatabase(cmd.argument);
1249                 break;
1250         }
1251
1252         case LFUN_WORDS_COUNT: {
1253                 DocIterator from, to;
1254                 if (cur.selection()) {
1255                         from = cur.selectionBegin();
1256                         to = cur.selectionEnd();
1257                 } else {
1258                         from = doc_iterator_begin(buffer_->inset());
1259                         to = doc_iterator_end(buffer_->inset());
1260                 }
1261                 int const count = countWords(from, to);
1262                 string message;
1263                 if (count != 1) {
1264                         if (cur.selection())
1265                                 message = bformat(_("%1$d words in selection."),
1266                                           count);
1267                                 else
1268                                         message = bformat(_("%1$d words in document."),
1269                                                           count);
1270                 }
1271                 else {
1272                         if (cur.selection())
1273                                 message = _("One word in selection.");
1274                         else
1275                                 message = _("One word in document.");
1276                 }
1277
1278                 Alert::information(_("Count words"), message);
1279         }
1280                 break;
1281         default:
1282                 return false;
1283         }
1284
1285         return true;
1286 }
1287
1288
1289 ViewMetricsInfo BufferView::Pimpl::metrics(bool singlepar)
1290 {
1291         // Remove old position cache
1292         theCoords.clear();
1293         BufferView & bv = *bv_;
1294         LyXText * const text = bv.text();
1295         if (anchor_ref_ > int(text->paragraphs().size() - 1)) {
1296                 anchor_ref_ = int(text->paragraphs().size() - 1);
1297                 offset_ref_ = 0;
1298         }
1299
1300         lyx::pit_type const pit = anchor_ref_;
1301         int pit1 = pit;
1302         int pit2 = pit;
1303         size_t const npit = text->paragraphs().size();
1304
1305         lyxerr[Debug::DEBUG]
1306                 << BOOST_CURRENT_FUNCTION
1307                 << " npit: " << npit
1308                 << " pit1: " << pit1
1309                 << " pit2: " << pit2
1310                 << endl;
1311
1312         // Rebreak anchor par
1313         text->redoParagraph(pit);
1314         int y0 = text->getPar(pit1).ascent() - offset_ref_;
1315
1316         // Redo paragraphs above cursor if necessary
1317         int y1 = y0;
1318         while (!singlepar && y1 > 0 && pit1 > 0) {
1319                 y1 -= text->getPar(pit1).ascent();
1320                 --pit1;
1321                 text->redoParagraph(pit1);
1322                 y1 -= text->getPar(pit1).descent();
1323         }
1324
1325
1326         // Take care of ascent of first line
1327         y1 -= text->getPar(pit1).ascent();
1328
1329         // Normalize anchor for next time
1330         anchor_ref_ = pit1;
1331         offset_ref_ = -y1;
1332
1333         // Grey at the beginning is ugly
1334         if (pit1 == 0 && y1 > 0) {
1335                 y0 -= y1;
1336                 y1 = 0;
1337                 anchor_ref_ = 0;
1338         }
1339
1340         // Redo paragraphs below cursor if necessary
1341         int y2 = y0;
1342         while (!singlepar && y2 < bv.workHeight() && pit2 < int(npit) - 1) {
1343                 y2 += text->getPar(pit2).descent();
1344                 ++pit2;
1345                 text->redoParagraph(pit2);
1346                 y2 += text->getPar(pit2).ascent();
1347         }
1348
1349         // Take care of descent of last line
1350         y2 += text->getPar(pit2).descent();
1351
1352         // The coordinates of all these paragraphs are correct, cache them
1353         int y = y1;
1354         for (lyx::pit_type pit = pit1; pit <= pit2; ++pit) {
1355                 y += text->getPar(pit).ascent();
1356                 theCoords.parPos()[text][pit] = Point(0, y);
1357                 y += text->getPar(pit).descent();
1358         }
1359
1360         lyxerr[Debug::DEBUG]
1361                 << BOOST_CURRENT_FUNCTION
1362                 << " y1: " << y1
1363                 << " y2: " << y2
1364                 << endl;
1365
1366         return ViewMetricsInfo(pit1, pit2, y1, y2, singlepar);
1367 }