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 Braustein
   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 "cursor.h"
  27 #include "debug.h"
  28 #include "dispatchresult.h"
  29 #include "factory.h"
  30 #include "FloatList.h"
  31 #include "funcrequest.h"
  32 #include "gettext.h"
  33 #include "intl.h"
  34 #include "iterators.h"
  35 #include "lyx_cb.h" // added for Dispatch functions
  36 #include "lyx_main.h"
  37 #include "lyxfind.h"
  38 #include "lyxfunc.h"
  39 #include "lyxtext.h"
  40 #include "lyxrc.h"
  41 #include "lastfiles.h"
  42 #include "paragraph.h"
  43 #include "paragraph_funcs.h"
  44 #include "ParagraphParameters.h"
  45 #include "undo.h"
  46 #include "vspace.h"
  47
  48 #include "insets/insetfloatlist.h"
  49 #include "insets/insetref.h"
  50
  51 #include "frontends/Alert.h"
  52 #include "frontends/Dialogs.h"
  53 #include "frontends/FileDialog.h"
  54 #include "frontends/LyXView.h"
  55 #include "frontends/LyXScreenFactory.h"
  56 #include "frontends/screen.h"
  57 #include "frontends/WorkArea.h"
  58 #include "frontends/WorkAreaFactory.h"
  59
  60 #include "graphics/Previews.h"
  61
  62 #include "mathed/formulabase.h"
  63
  64 #include "support/filetools.h"
  65 #include "support/path_defines.h"
  66 #include "support/tostr.h"
  67
  68 #include <boost/bind.hpp>
  69
  70 using bv_funcs::currentState;
  71
  72 using lyx::pos_type;
  73
  74 using lyx::support::AddPath;
  75 using lyx::support::bformat;
  76 using lyx::support::FileSearch;
  77 using lyx::support::IsDirWriteable;
  78 using lyx::support::MakeDisplayPath;
  79 using lyx::support::strToUnsignedInt;
  80 using lyx::support::system_lyxdir;
  81
  82 using std::endl;
  83 using std::make_pair;
  84 using std::min;
  85 using std::string;
  86
  87
  88 extern BufferList bufferlist;
  89
  90
  91 namespace {
  92
  93 unsigned int const saved_positions_num = 20;
  94
  95 // All the below connection objects are needed because of a bug in some
  96 // versions of GCC (<=2.96 are on the suspects list.) By having and assigning
  97 // to these connections we avoid a segfault upon startup, and also at exit.
  98 // (Lgb)
  99
 100 boost::signals::connection dispatchcon;
 101 boost::signals::connection timecon;
 102 boost::signals::connection doccon;
 103 boost::signals::connection resizecon;
 104 boost::signals::connection kpresscon;
 105 boost::signals::connection selectioncon;
 106 boost::signals::connection lostcon;
 107
 108
 109 } // anon namespace
 110
 111
 112 BufferView::Pimpl::Pimpl(BufferView * bv, LyXView * owner,
 113              int xpos, int ypos, int width, int height)
 114         : bv_(bv), owner_(owner), buffer_(0), cursor_timeout(400),
 115           using_xterm_cursor(false), cursor_(bv)
 116 {
 117         workarea_.reset(WorkAreaFactory::create(xpos, ypos, width, height));
 118         screen_.reset(LyXScreenFactory::create(workarea()));
 119
 120         // Setup the signals
 121         doccon = workarea().scrollDocView
 122                 .connect(boost::bind(&BufferView::Pimpl::scrollDocView, this, _1));
 123         resizecon = workarea().workAreaResize
 124                 .connect(boost::bind(&BufferView::Pimpl::workAreaResize, this));
 125         dispatchcon = workarea().dispatch
 126                 .connect(boost::bind(&BufferView::Pimpl::workAreaDispatch, this, _1));
 127         kpresscon = workarea().workAreaKeyPress
 128                 .connect(boost::bind(&BufferView::Pimpl::workAreaKeyPress, this, _1, _2));
 129         selectioncon = workarea().selectionRequested
 130                 .connect(boost::bind(&BufferView::Pimpl::selectionRequested, this));
 131         lostcon = workarea().selectionLost
 132                 .connect(boost::bind(&BufferView::Pimpl::selectionLost, this));
 133
 134         timecon = cursor_timeout.timeout
 135                 .connect(boost::bind(&BufferView::Pimpl::cursorToggle, this));
 136         cursor_timeout.start();
 137         saved_positions.resize(saved_positions_num);
 138 }
 139
 140
 141 void BufferView::Pimpl::addError(ErrorItem const & ei)
 142 {
 143         errorlist_.push_back(ei);
 144 }
 145
 146
 147 void BufferView::Pimpl::showReadonly(bool)
 148 {
 149         owner_->updateWindowTitle();
 150         owner_->getDialogs().updateBufferDependent(false);
 151 }
 152
 153
 154 void BufferView::Pimpl::connectBuffer(Buffer & buf)
 155 {
 156         if (errorConnection_.connected())
 157                 disconnectBuffer();
 158
 159         errorConnection_ = buf.error.connect(boost::bind(&BufferView::Pimpl::addError, this, _1));
 160         messageConnection_ = buf.message.connect(boost::bind(&LyXView::message, owner_, _1));
 161         busyConnection_ = buf.busy.connect(boost::bind(&LyXView::busy, owner_, _1));
 162         titleConnection_ = buf.updateTitles.connect(boost::bind(&LyXView::updateWindowTitle, owner_));
 163         timerConnection_ = buf.resetAutosaveTimers.connect(boost::bind(&LyXView::resetAutosaveTimer, owner_));
 164         readonlyConnection_ = buf.readonly.connect(boost::bind(&BufferView::Pimpl::showReadonly, this, _1));
 165         closingConnection_ = buf.closing.connect(boost::bind(&BufferView::Pimpl::buffer, this, (Buffer *)0));
 166 }
 167
 168
 169 void BufferView::Pimpl::disconnectBuffer()
 170 {
 171         errorConnection_.disconnect();
 172         messageConnection_.disconnect();
 173         busyConnection_.disconnect();
 174         titleConnection_.disconnect();
 175         timerConnection_.disconnect();
 176         readonlyConnection_.disconnect();
 177         closingConnection_.disconnect();
 178 }
 179
 180
 181 bool BufferView::Pimpl::newFile(string const & filename,
 182                                 string const & tname,
 183                                 bool isNamed)
 184 {
 185         Buffer * b = ::newFile(filename, tname, isNamed);
 186         buffer(b);
 187         return true;
 188 }
 189
 190
 191 bool BufferView::Pimpl::loadLyXFile(string const & filename, bool tolastfiles)
 192 {
 193         // get absolute path of file and add ".lyx" to the filename if
 194         // necessary
 195         string s = FileSearch(string(), filename, "lyx");
 196
 197         bool const found = !s.empty();
 198
 199         if (!found)
 200                 s = filename;
 201
 202         // file already open?
 203         if (bufferlist.exists(s)) {
 204                 string const file = MakeDisplayPath(s, 20);
 205                 string text = bformat(_("The document %1$s is already "
 206                                         "loaded.\n\nDo you want to revert "
 207                                         "to the saved version?"), file);
 208                 int const ret = Alert::prompt(_("Revert to saved document?"),
 209                         text, 0, 1,  _("&Revert"), _("&Switch to document"));
 210
 211                 if (ret != 0) {
 212                         buffer(bufferlist.getBuffer(s));
 213                         return true;
 214                 } else {
 215                         // FIXME: should be LFUN_REVERT
 216                         if (!bufferlist.close(bufferlist.getBuffer(s), false))
 217                                 return false;
 218                         // Fall through to new load. (Asger)
 219                 }
 220         }
 221
 222         Buffer * b;
 223
 224         if (found) {
 225                 b = bufferlist.newBuffer(s);
 226                 connectBuffer(*b);
 227                 if (!::loadLyXFile(b, s)) {
 228                         bufferlist.release(b);
 229                         return false;
 230                 }
 231         } else {
 232                 string text = bformat(_("The document %1$s does not yet "
 233                                         "exist.\n\nDo you want to create "
 234                                         "a new document?"), s);
 235                 int const ret = Alert::prompt(_("Create new document?"),
 236                          text, 0, 1, _("&Create"), _("Cancel"));
 237
 238                 if (ret == 0)
 239                         b = ::newFile(s, string(), true);
 240                 else
 241                         return false;
 242         }
 243
 244         buffer(b);
 245         bv_->showErrorList(_("Parse"));
 246
 247         if (tolastfiles)
 248                 LyX::ref().lastfiles().newFile(b->fileName());
 249
 250         return true;
 251 }
 252
 253
 254 WorkArea & BufferView::Pimpl::workarea() const
 255 {
 256         return *workarea_.get();
 257 }
 258
 259
 260 LyXScreen & BufferView::Pimpl::screen() const
 261 {
 262         return *screen_.get();
 263 }
 264
 265
 266 Painter & BufferView::Pimpl::painter() const
 267 {
 268         return workarea().getPainter();
 269 }
 270
 271
 272 void BufferView::Pimpl::top_y(int y)
 273 {
 274         top_y_ = y;
 275 }
 276
 277
 278 int BufferView::Pimpl::top_y() const
 279 {
 280         return top_y_;
 281 }
 282
 283
 284 void BufferView::Pimpl::buffer(Buffer * b)
 285 {
 286         lyxerr[Debug::INFO] << "Setting buffer in BufferView ("
 287                             << b << ')' << endl;
 288         if (buffer_) {
 289                 disconnectBuffer();
 290                 //delete bv_->text();
 291                 //bv_->setText(0);
 292         }
 293
 294         // set current buffer
 295         buffer_ = b;
 296
 297         top_y_ = 0;
 298
 299         // if we're quitting lyx, don't bother updating stuff
 300         if (quitting)
 301                 return;
 302
 303         // if we are closing the buffer, use the first buffer as current
 304         if (!buffer_)
 305                 buffer_ = bufferlist.first();
 306
 307         if (buffer_) {
 308                 lyxerr[Debug::INFO] << "Buffer addr: " << buffer_ << endl;
 309                 connectBuffer(*buffer_);
 310
 311                 buffer_->text().init(bv_);
 312                 buffer_->text().textwidth_ = workarea().workWidth();
 313                 buffer_->text().fullRebreak();
 314
 315                 // If we don't have a text object for this, we make one
 316                 if (bv_->text() == 0)
 317                         resizeCurrentBuffer();
 318
 319                 // FIXME: needed when ?
 320                 fitCursor();
 321
 322                 // Buffer-dependent dialogs should be updated or
 323                 // hidden. This should go here because some dialogs (eg ToC)
 324                 // require bv_->text.
 325                 owner_->getDialogs().updateBufferDependent(true);
 326         } else {
 327                 lyxerr[Debug::INFO] << "  No Buffer!" << endl;
 328                 owner_->getDialogs().hideBufferDependent();
 329         }
 330
 331         update();
 332         updateScrollbar();
 333         owner_->updateMenubar();
 334         owner_->updateToolbar();
 335         owner_->updateLayoutChoice();
 336         owner_->updateWindowTitle();
 337
 338         // Don't forget to update the Layout
 339         if (buffer_)
 340                 owner_->setLayout(bv_->text()->cursorPar()->layout()->name());
 341
 342         if (lyx::graphics::Previews::activated() && buffer_)
 343                 lyx::graphics::Previews::get().generateBufferPreviews(*buffer_);
 344 }
 345
 346
 347 bool BufferView::Pimpl::fitCursor()
 348 {
 349         lyxerr << "BufferView::Pimpl::fitCursor." << endl;
 350         if (screen().fitCursor(bv_)) {
 351                 updateScrollbar();
 352                 return true;
 353         }
 354         return false;
 355 }
 356
 357
 358 void BufferView::Pimpl::redoCurrentBuffer()
 359 {
 360         lyxerr[Debug::INFO] << "BufferView::redoCurrentBuffer" << endl;
 361         if (buffer_ && bv_->text()) {
 362                 resizeCurrentBuffer();
 363                 updateScrollbar();
 364                 owner_->updateLayoutChoice();
 365         }
 366 }
 367
 368
 369 void BufferView::Pimpl::resizeCurrentBuffer()
 370 {
 371         lyxerr[Debug::INFO] << "resizeCurrentBuffer" << endl;
 372
 373         int par = -1;
 374         int selstartpar = -1;
 375         int selendpar = -1;
 376
 377         pos_type pos = 0;
 378         pos_type selstartpos = 0;
 379         pos_type selendpos = 0;
 380         bool selection = false;
 381         bool mark_set  = false;
 382
 383         owner_->busy(true);
 384
 385         owner_->message(_("Formatting document..."));
 386
 387         lyxerr << "### resizeCurrentBuffer: text" << bv_->text() << endl;
 388         if (!bv_->text())
 389                 return;
 390
 391         //if (bv_->text()) {
 392                 par = bv_->text()->cursor.par();
 393                 pos = bv_->text()->cursor.pos();
 394                 selstartpar = bv_->text()->selection.start.par();
 395                 selstartpos = bv_->text()->selection.start.pos();
 396                 selendpar = bv_->text()->selection.end.par();
 397                 selendpos = bv_->text()->selection.end.pos();
 398                 selection = bv_->text()->selection.set();
 399                 mark_set = bv_->text()->selection.mark();
 400                 bv_->text()->fullRebreak();
 401                 update();
 402         //} else {
 403         //      bv_->setText(new LyXText(bv_, 0, false, bv_->buffer()->paragraphs()));
 404         //      bv_->text()->init(bv_);
 405         //}
 406
 407         if (par != -1) {
 408                 bv_->text()->selection.set(true);
 409                 // At this point just to avoid the Delete-Empty-Paragraph-
 410                 // Mechanism when setting the cursor.
 411                 bv_->text()->selection.mark(mark_set);
 412                 if (selection) {
 413                         bv_->text()->setCursor(selstartpar, selstartpos);
 414                         bv_->text()->selection.cursor = bv_->text()->cursor;
 415                         bv_->text()->setCursor(selendpar, selendpos);
 416                         bv_->text()->setSelection();
 417                         bv_->text()->setCursor(par, pos);
 418                 } else {
 419                         bv_->text()->setCursor(par, pos);
 420                         bv_->text()->selection.cursor = bv_->text()->cursor;
 421                         bv_->text()->selection.set(false);
 422                 }
 423         }
 424
 425         fitCursor();
 426
 427         switchKeyMap();
 428         owner_->busy(false);
 429
 430         // reset the "Formatting..." message
 431         owner_->clearMessage();
 432
 433         updateScrollbar();
 434 }
 435
 436
 437 void BufferView::Pimpl::updateScrollbar()
 438 {
 439         if (!bv_->text()) {
 440                 lyxerr[Debug::GUI] << "no text in updateScrollbar" << endl;
 441                 workarea().setScrollbarParams(0, 0, 0);
 442                 return;
 443         }
 444
 445         LyXText const & t = *bv_->text();
 446
 447         lyxerr[Debug::GUI] << "Updating scrollbar: h " << t.height << ", top_y() "
 448                 << top_y() << ", default height " << defaultRowHeight() << endl;
 449
 450         workarea().setScrollbarParams(t.height, top_y(), defaultRowHeight());
 451 }
 452
 453
 454 void BufferView::Pimpl::scrollDocView(int value)
 455 {
 456         lyxerr[Debug::GUI] << "scrollDocView of " << value << endl;
 457
 458         if (!buffer_)
 459                 return;
 460
 461         screen().hideCursor();
 462
 463         top_y(value);
 464         screen().redraw(*bv_);
 465
 466         if (!lyxrc.cursor_follows_scrollbar)
 467                 return;
 468
 469         int const height = defaultRowHeight();
 470         int const first = top_y() + height;
 471         int const last = top_y() + workarea().workHeight() - height;
 472
 473         LyXText * text = bv_->text();
 474         if (text->cursor.y() < first)
 475                 text->setCursorFromCoordinates(0, first);
 476         else if (text->cursor.y() > last)
 477                 text->setCursorFromCoordinates(0, last);
 478
 479         owner_->updateLayoutChoice();
 480 }
 481
 482
 483 void BufferView::Pimpl::scroll(int lines)
 484 {
 485         if (!buffer_)
 486                 return;
 487
 488         LyXText const * t = bv_->text();
 489         int const line_height = defaultRowHeight();
 490
 491         // The new absolute coordinate
 492         int new_top_y = top_y() + lines * line_height;
 493
 494         // Restrict to a valid value
 495         new_top_y = std::min(t->height - 4 * line_height, new_top_y);
 496         new_top_y = std::max(0, new_top_y);
 497
 498         scrollDocView(new_top_y);
 499
 500         // Update the scrollbar.
 501         workarea().setScrollbarParams(t->height, top_y(), defaultRowHeight());
 502 }
 503
 504
 505 void BufferView::Pimpl::workAreaKeyPress(LyXKeySymPtr key,
 506                                          key_modifier::state state)
 507 {
 508         bv_->owner()->getLyXFunc().processKeySym(key, state);
 509
 510         /* This is perhaps a bit of a hack. When we move
 511          * around, or type, it's nice to be able to see
 512          * the cursor immediately after the keypress. So
 513          * we reset the toggle timeout and force the visibility
 514          * of the cursor. Note we cannot do this inside
 515          * dispatch() itself, because that's called recursively.
 516          */
 517         if (available()) {
 518                 cursor_timeout.restart();
 519                 screen().showCursor(*bv_);
 520         }
 521 }
 522
 523
 524 void BufferView::Pimpl::selectionRequested()
 525 {
 526         static string sel;
 527
 528         if (!available())
 529                 return;
 530
 531         LyXText * text = bv_->getLyXText();
 532
 533         if (text->selection.set() &&
 534                 (!bv_->text()->xsel_cache.set() ||
 535                  text->selection.start != bv_->text()->xsel_cache.start ||
 536                  text->selection.end != bv_->text()->xsel_cache.end))
 537         {
 538                 bv_->text()->xsel_cache = text->selection;
 539                 sel = text->selectionAsString(*bv_->buffer(), false);
 540         } else if (!text->selection.set()) {
 541                 sel = string();
 542                 bv_->text()->xsel_cache.set(false);
 543         }
 544         if (!sel.empty()) {
 545                 workarea().putClipboard(sel);
 546         }
 547 }
 548
 549
 550 void BufferView::Pimpl::selectionLost()
 551 {
 552         if (available()) {
 553                 screen().hideCursor();
 554                 bv_->getLyXText()->clearSelection();
 555                 bv_->text()->xsel_cache.set(false);
 556         }
 557 }
 558
 559
 560 void BufferView::Pimpl::workAreaResize()
 561 {
 562         static int work_area_width;
 563         static int work_area_height;
 564
 565         bool const widthChange = workarea().workWidth() != work_area_width;
 566         bool const heightChange = workarea().workHeight() != work_area_height;
 567
 568         // update from work area
 569         work_area_width = workarea().workWidth();
 570         work_area_height = workarea().workHeight();
 571
 572         if (buffer_ != 0) {
 573                 if (widthChange) {
 574                         // The visible LyXView need a resize
 575                         resizeCurrentBuffer();
 576                 }
 577         }
 578
 579         if (widthChange || heightChange)
 580                 update();
 581
 582         // always make sure that the scrollbar is sane.
 583         updateScrollbar();
 584         owner_->updateLayoutChoice();
 585 }
 586
 587
 588 void BufferView::Pimpl::update()
 589 {
 590         //lyxerr << "BufferView::update()" << endl;
 591         // fix cursor coordinate cache in case something went wrong
 592
 593         // check needed to survive LyX startup
 594         if (bv_->getLyXText()) {
 595                 // update all 'visible' paragraphs
 596                 ParagraphList::iterator beg;
 597                 ParagraphList::iterator end;
 598                 getParsInRange(buffer_->paragraphs(),
 599                                top_y(), top_y() + workarea().workHeight(),
 600                                beg, end);
 601                 bv_->text()->redoParagraphs(beg, end);
 602                 bv_->getLyXText()->redoCursor();
 603                 updateScrollbar();
 604         }
 605         screen().redraw(*bv_);
 606 }
 607
 608
 609 // Callback for cursor timer
 610 void BufferView::Pimpl::cursorToggle()
 611 {
 612         if (!buffer_) {
 613                 cursor_timeout.restart();
 614                 return;
 615         }
 616
 617         screen().toggleCursor(*bv_);
 618         cursor_timeout.restart();
 619 }
 620
 621
 622 bool BufferView::Pimpl::available() const
 623 {
 624         return buffer_ && bv_->text();
 625 }
 626
 627
 628 Change const BufferView::Pimpl::getCurrentChange()
 629 {
 630         if (!bv_->buffer()->params().tracking_changes)
 631                 return Change(Change::UNCHANGED);
 632
 633         LyXText * text = bv_->getLyXText();
 634
 635         if (!text->selection.set())
 636                 return Change(Change::UNCHANGED);
 637
 638         return text->getPar(text->selection.start)
 639                 ->lookupChangeFull(text->selection.start.pos());
 640 }
 641
 642
 643 void BufferView::Pimpl::savePosition(unsigned int i)
 644 {
 645         if (i >= saved_positions_num)
 646                 return;
 647         saved_positions[i] = Position(buffer_->fileName(),
 648                                       bv_->text()->cursorPar()->id(),
 649                                       bv_->text()->cursor.pos());
 650         if (i > 0)
 651                 owner_->message(bformat(_("Saved bookmark %1$s"), tostr(i)));
 652 }
 653
 654
 655 void BufferView::Pimpl::restorePosition(unsigned int i)
 656 {
 657         if (i >= saved_positions_num)
 658                 return;
 659
 660         string const fname = saved_positions[i].filename;
 661
 662         bv_->text()->clearSelection();
 663
 664         if (fname != buffer_->fileName()) {
 665                 Buffer * b = 0;
 666                 if (bufferlist.exists(fname))
 667                         b = bufferlist.getBuffer(fname);
 668                 else {
 669                         b = bufferlist.newBuffer(fname);
 670                         ::loadLyXFile(b, fname); // don't ask, just load it
 671                 }
 672                 if (b)
 673                         buffer(b);
 674         }
 675
 676         ParIterator par = buffer_->getParFromID(saved_positions[i].par_id);
 677         if (par == buffer_->par_iterator_end())
 678                 return;
 679
 680         bv_->text()->setCursor(par.pit(),
 681                              min(par->size(), saved_positions[i].par_pos));
 682
 683         if (i > 0)
 684                 owner_->message(bformat(_("Moved to bookmark %1$s"), tostr(i)));
 685 }
 686
 687
 688 bool BufferView::Pimpl::isSavedPosition(unsigned int i)
 689 {
 690         return i < saved_positions_num && !saved_positions[i].filename.empty();
 691 }
 692
 693
 694 void BufferView::Pimpl::switchKeyMap()
 695 {
 696         if (!lyxrc.rtl_support)
 697                 return;
 698
 699         Intl & intl = owner_->getIntl();
 700         if (bv_->getLyXText()->real_current_font.isRightToLeft()) {
 701                 if (intl.keymap == Intl::PRIMARY)
 702                         intl.KeyMapSec();
 703         } else {
 704                 if (intl.keymap == Intl::SECONDARY)
 705                         intl.KeyMapPrim();
 706         }
 707 }
 708
 709
 710 void BufferView::Pimpl::center()
 711 {
 712         LyXText * text = bv_->text();
 713
 714         text->clearSelection();
 715         int const half_height = workarea().workHeight() / 2;
 716         int new_y = std::max(0, text->cursor.y() - half_height);
 717
 718         // FIXME: look at this comment again ...
 719         // This updates top_y() but means the fitCursor() call
 720         // from the update(FITCUR) doesn't realise that we might
 721         // have moved (e.g. from GOTOPARAGRAPH), so doesn't cause
 722         // the scrollbar to be updated as it should, so we have
 723         // to do it manually. Any operation that does a center()
 724         // and also might have moved top_y() must make sure to call
 725         // updateScrollbar() currently. Never mind that this is a
 726         // pretty obfuscated way of updating t->top_y()
 727         top_y(new_y);
 728 }
 729
 730
 731 void BufferView::Pimpl::stuffClipboard(string const & stuff) const
 732 {
 733         workarea().putClipboard(stuff);
 734 }
 735
 736
 737 InsetOld * BufferView::Pimpl::getInsetByCode(InsetOld::Code code)
 738 {
 739 #if 0
 740         LyXCursor cursor = bv_->getLyXText()->cursor;
 741         Buffer::inset_iterator it =
 742                 find_if(Buffer::inset_iterator(
 743                         cursorPar(), cursor.pos()),
 744                         buffer_->inset_iterator_end(),
 745                         lyx::compare_memfun(&Inset::lyxCode, code));
 746         return it != buffer_->inset_iterator_end() ? (*it) : 0;
 747 #else
 748         // Ok, this is a little bit too brute force but it
 749         // should work for now. Better infrastructure is coming. (Lgb)
 750
 751         Buffer * b = bv_->buffer();
 752         LyXText * text =  bv_->getLyXText();
 753
 754         Buffer::inset_iterator beg = b->inset_iterator_begin();
 755         Buffer::inset_iterator end = b->inset_iterator_end();
 756
 757         bool cursorPar_seen = false;
 758
 759         for (; beg != end; ++beg) {
 760                 if (beg.getPar() == text->cursorPar()) {
 761                         cursorPar_seen = true;
 762                 }
 763                 if (cursorPar_seen) {
 764                         if (beg.getPar() == text->cursorPar()
 765                             && beg.getPos() >= text->cursor.pos()) {
 766                                 break;
 767                         } else if (beg.getPar() != text->cursorPar()) {
 768                                 break;
 769                         }
 770                 }
 771
 772         }
 773         if (beg != end) {
 774                 // Now find the first inset that matches code.
 775                 for (; beg != end; ++beg) {
 776                         if (beg->lyxCode() == code) {
 777                                 return &(*beg);
 778                         }
 779                 }
 780         }
 781         return 0;
 782 #endif
 783 }
 784
 785
 786 void BufferView::Pimpl::MenuInsertLyXFile(string const & filen)
 787 {
 788         string filename = filen;
 789
 790         if (filename.empty()) {
 791                 // Launch a file browser
 792                 string initpath = lyxrc.document_path;
 793
 794                 if (available()) {
 795                         string const trypath = owner_->buffer()->filePath();
 796                         // If directory is writeable, use this as default.
 797                         if (IsDirWriteable(trypath))
 798                                 initpath = trypath;
 799                 }
 800
 801                 FileDialog fileDlg(_("Select LyX document to insert"),
 802                         LFUN_FILE_INSERT,
 803                         make_pair(string(_("Documents|#o#O")),
 804                                   string(lyxrc.document_path)),
 805                         make_pair(string(_("Examples|#E#e")),
 806                                   string(AddPath(system_lyxdir(), "examples"))));
 807
 808                 FileDialog::Result result =
 809                         fileDlg.open(initpath,
 810                                        _("*.lyx| LyX Documents (*.lyx)"));
 811
 812                 if (result.first == FileDialog::Later)
 813                         return;
 814
 815                 filename = result.second;
 816
 817                 // check selected filename
 818                 if (filename.empty()) {
 819                         owner_->message(_("Canceled."));
 820                         return;
 821                 }
 822         }
 823
 824         // get absolute path of file and add ".lyx" to the filename if
 825         // necessary
 826         filename = FileSearch(string(), filename, "lyx");
 827
 828         string const disp_fn = MakeDisplayPath(filename);
 829         owner_->message(bformat(_("Inserting document %1$s..."), disp_fn));
 830         if (bv_->insertLyXFile(filename))
 831                 owner_->message(bformat(_("Document %1$s inserted."),
 832                                         disp_fn));
 833         else
 834                 owner_->message(bformat(_("Could not insert document %1$s"),
 835                                         disp_fn));
 836 }
 837
 838
 839 void BufferView::Pimpl::trackChanges()
 840 {
 841         Buffer * buf(bv_->buffer());
 842         bool const tracking(buf->params().tracking_changes);
 843
 844         if (!tracking) {
 845                 ParIterator const end = buf->par_iterator_end();
 846                 for (ParIterator it = buf->par_iterator_begin(); it != end; ++it)
 847                         it->trackChanges();
 848                 buf->params().tracking_changes = true;
 849
 850                 // we cannot allow undos beyond the freeze point
 851                 buf->undostack().clear();
 852         } else {
 853                 update();
 854                 bv_->text()->setCursor(0, 0);
 855 #warning changes FIXME
 856                 bool found = lyx::find::findNextChange(bv_);
 857                 if (found) {
 858                         owner_->getDialogs().show("changes");
 859                         return;
 860                 }
 861
 862                 ParIterator const end = buf->par_iterator_end();
 863                 for (ParIterator it = buf->par_iterator_begin(); it != end; ++it)
 864                         it->untrackChanges();
 865                 buf->params().tracking_changes = false;
 866         }
 867
 868         buf->redostack().clear();
 869 }
 870
 871 #warning remove me
 872 LCursor theTempCursor(0);
 873
 874 namespace {
 875
 876         InsetOld * insetFromCoords(BufferView * bv, int x, int y)
 877         {
 878                 LyXText * text = bv->text();
 879                 InsetOld * inset = 0;
 880                 theTempCursor = LCursor(bv);
 881                 while (true) {
 882                         InsetOld * inset_hit = text->checkInsetHit(x, y);
 883                         if (!inset_hit) {
 884                                 lyxerr << "no further inset hit" << endl;
 885                                 break;
 886                         }
 887                         inset = inset_hit;
 888                         if (!inset_hit->descendable()) {
 889                                 lyxerr << "not descendable" << endl;
 890                                 break;
 891                         }
 892                         text = inset_hit->getText(0);
 893                         lyxerr << "Hit inset: " << inset << " at x: " << x
 894                                 << " text: " << text << " y: " << y << endl;
 895                         theTempCursor.push(static_cast<UpdatableInset*>(inset));
 896                 }
 897                 lyxerr << "theTempCursor: " << theTempCursor << endl;
 898                 return inset;
 899         }
 900
 901 }
 902
 903
 904 bool BufferView::Pimpl::workAreaDispatch(FuncRequest const & cmd)
 905 {
 906         switch (cmd.action) {
 907         case LFUN_MOUSE_MOTION: {
 908                 FuncRequest cmd1(cmd, bv_);
 909                 UpdatableInset * inset = bv_->cursor().innerInset();
 910                 DispatchResult res;
 911                 if (inset) {
 912                         cmd1.x -= inset->x();
 913                         cmd1.y -= inset->y();
 914                         res = inset->dispatch(cmd1);
 915                 } else {
 916                         cmd1.y += bv_->top_y();
 917                         res = bv_->cursor().innerText()->dispatch(cmd1);
 918                 }
 919
 920                 if (bv_->fitCursor() || res.update()) {
 921                         bv_->update();
 922                         bv_->cursor().updatePos();
 923                 }
 924
 925                 return true;
 926         }
 927
 928         case LFUN_MOUSE_PRESS:
 929         case LFUN_MOUSE_RELEASE:
 930         case LFUN_MOUSE_DOUBLE:
 931         case LFUN_MOUSE_TRIPLE: {
 932                 // We pass those directly to the Bufferview, since
 933                 // otherwise selection handling breaks down
 934
 935                 // Doesn't go through lyxfunc, so we need to update
 936                 // the layout choice etc. ourselves
 937
 938                 // e.g. Qt mouse press when no buffer
 939                 if (!available())
 940                         return false;
 941
 942                 screen().hideCursor();
 943
 944                 // either the inset under the cursor or the surrounding LyXText will
 945                 // handle this event.
 946
 947                 // built temporary path to inset
 948                 InsetOld * inset = insetFromCoords(bv_, cmd.x, cmd.y);
 949                 FuncRequest cmd1(cmd, bv_);
 950                 DispatchResult res;
 951
 952                 // try to dispatch to that inset
 953                 if (inset) {
 954                         FuncRequest cmd2 = cmd1;
 955                         lyxerr << "dispatching action " << cmd2.action
 956                                << " to inset " << inset << endl;
 957                         cmd2.x -= inset->x();
 958                         cmd2.y -= inset->y();
 959                         res = inset->dispatch(cmd2);
 960                         if (res.update()) {
 961                                 bv_->update();
 962                                 bv_->cursor().updatePos();
 963                         }
 964                         res.update(false);
 965                         switch (res.val()) {
 966                                 case FINISHED:
 967                                 case FINISHED_RIGHT:
 968                                 case FINISHED_UP:
 969                                 case FINISHED_DOWN:
 970                                         theTempCursor.pop();
 971                                         bv_->cursor() = theTempCursor;
 972                                         bv_->cursor().innerText()->setCursorFromCoordinates(cmd.x, top_y() + cmd.y);
 973                                         if (bv_->fitCursor())
 974                                                 bv_->update();
 975                                         return true;
 976                                 default:
 977                                         lyxerr << "not dispatched by inner inset val: " << res.val() << endl;
 978                                         break;
 979                         }
 980                 }
 981
 982                 // otherwise set cursor to surrounding LyXText
 983                 if (!res.dispatched()) {
 984                         lyxerr << "temp cursor is: " << theTempCursor << endl;
 985                         lyxerr << "dispatching " << cmd1
 986                                << " to surrounding LyXText "
 987                                << theTempCursor.innerText() << endl;
 988                         bv_->cursor() = theTempCursor;
 989                         cmd1.y += bv_->top_y();
 990                         res = bv_->cursor().innerText()->dispatch(cmd1);
 991                         if (bv_->fitCursor() || res.update())
 992                                 bv_->update();
 993
 994                         //return DispatchResult(true, true);
 995                 }
 996                 // see workAreaKeyPress
 997                 cursor_timeout.restart();
 998                 screen().showCursor(*bv_);
 999
1000                 // skip these when selecting
1001                 if (cmd.action != LFUN_MOUSE_MOTION) {
1002                         owner_->updateLayoutChoice();
1003                         owner_->updateToolbar();
1004                 }
1005
1006                 // slight hack: this is only called currently when we
1007                 // clicked somewhere, so we force through the display
1008                 // of the new status here.
1009                 owner_->clearMessage();
1010                 return true;
1011         }
1012
1013         default:
1014                 owner_->dispatch(cmd);
1015                 return true;
1016         }
1017 }
1018
1019
1020 bool BufferView::Pimpl::dispatch(FuncRequest const & ev_in)
1021 {
1022         // Make sure that the cached BufferView is correct.
1023         FuncRequest ev = ev_in;
1024         ev.setView(bv_);
1025
1026         lyxerr[Debug::ACTION] << "BufferView::Pimpl::Dispatch:"
1027                 << " action[" << ev.action << ']'
1028                 << " arg[" << ev.argument << ']'
1029                 << " x[" << ev.x << ']'
1030                 << " y[" << ev.y << ']'
1031                 << " button[" << ev.button() << ']'
1032                 << endl;
1033
1034         LyXTextClass const & tclass = buffer_->params().getLyXTextClass();
1035
1036         switch (ev.action) {
1037
1038         case LFUN_SCROLL_INSET:
1039                 // this is not handled here as this function is only active
1040                 // if we have a locking_inset and that one is (or contains)
1041                 // a tabular-inset
1042                 break;
1043
1044         case LFUN_FILE_INSERT:
1045                 MenuInsertLyXFile(ev.argument);
1046                 break;
1047
1048         case LFUN_FILE_INSERT_ASCII_PARA:
1049                 InsertAsciiFile(bv_, ev.argument, true);
1050                 break;
1051
1052         case LFUN_FILE_INSERT_ASCII:
1053                 InsertAsciiFile(bv_, ev.argument, false);
1054                 break;
1055
1056         case LFUN_FONT_STATE:
1057                 owner_->getLyXFunc().setMessage(currentState(bv_));
1058                 break;
1059
1060         case LFUN_INSERT_LABEL: {
1061                 // Try and generate a valid label
1062                 string const contents = ev.argument.empty() ?
1063                         getPossibleLabel(*bv_) : ev.argument;
1064                 InsetCommandParams icp("label", contents);
1065                 string data = InsetCommandMailer::params2string("label", icp);
1066                 owner_->getDialogs().show("label", data, 0);
1067                 break;
1068         }
1069
1070         case LFUN_BOOKMARK_SAVE:
1071                 savePosition(strToUnsignedInt(ev.argument));
1072                 break;
1073
1074         case LFUN_BOOKMARK_GOTO:
1075                 restorePosition(strToUnsignedInt(ev.argument));
1076                 break;
1077
1078         case LFUN_REF_GOTO: {
1079                 string label = ev.argument;
1080                 if (label.empty()) {
1081                         InsetRef * inset =
1082                                 static_cast<InsetRef*>(getInsetByCode(InsetOld::REF_CODE));
1083                         if (inset) {
1084                                 label = inset->getContents();
1085                                 savePosition(0);
1086                         }
1087                 }
1088
1089                 if (!label.empty())
1090                         bv_->gotoLabel(label);
1091         }
1092         break;
1093
1094         // --- accented characters ---------------------------
1095
1096         case LFUN_UMLAUT:
1097         case LFUN_CIRCUMFLEX:
1098         case LFUN_GRAVE:
1099         case LFUN_ACUTE:
1100         case LFUN_TILDE:
1101         case LFUN_CEDILLA:
1102         case LFUN_MACRON:
1103         case LFUN_DOT:
1104         case LFUN_UNDERDOT:
1105         case LFUN_UNDERBAR:
1106         case LFUN_CARON:
1107         case LFUN_SPECIAL_CARON:
1108         case LFUN_BREVE:
1109         case LFUN_TIE:
1110         case LFUN_HUNG_UMLAUT:
1111         case LFUN_CIRCLE:
1112         case LFUN_OGONEK:
1113                 if (ev.argument.empty()) {
1114                         // As always...
1115                         owner_->getLyXFunc().handleKeyFunc(ev.action);
1116                 } else {
1117                         owner_->getLyXFunc().handleKeyFunc(ev.action);
1118                         owner_->getIntl().getTransManager()
1119                                 .TranslateAndInsert(ev.argument[0], bv_->getLyXText());
1120                         update();
1121                 }
1122                 break;
1123
1124         case LFUN_MATH_MACRO:
1125         case LFUN_MATH_DELIM:
1126         case LFUN_INSERT_MATRIX:
1127         case LFUN_INSERT_MATH:
1128         case LFUN_MATH_IMPORT_SELECTION: // Imports LaTeX from the X selection
1129         case LFUN_MATH_DISPLAY:          // Open or create a displayed math inset
1130         case LFUN_MATH_MODE:             // Open or create an inlined math inset
1131                 mathDispatch(ev);
1132                 break;
1133
1134         case LFUN_INSET_APPLY: {
1135 #warning is this code ever called?
1136                 // Remove if not triggered. Mail lyx-devel if triggered.
1137                 // This code was replaced by code in text3.C.
1138                 BOOST_ASSERT(false);
1139                 string const name = ev.getArg(0);
1140
1141                 InsetBase * inset = owner_->getDialogs().getOpenInset(name);
1142                 if (inset) {
1143                         // This works both for 'original' and 'mathed' insets.
1144                         // Note that the localDispatch performs update also.
1145                         FuncRequest fr(bv_, LFUN_INSET_MODIFY, ev.argument);
1146                         inset->dispatch(fr);
1147                 } else {
1148                         FuncRequest fr(bv_, LFUN_INSET_INSERT, ev.argument);
1149                         dispatch(fr);
1150                 }
1151         }
1152         break;
1153
1154         case LFUN_INSET_INSERT: {
1155                 // Same as above.
1156                 BOOST_ASSERT(false);
1157                 InsetOld * inset = createInset(ev);
1158                 if (!inset || !insertInset(inset))
1159                         delete inset;
1160                 break;
1161         }
1162
1163         case LFUN_FLOAT_LIST:
1164                 if (tclass.floats().typeExist(ev.argument)) {
1165                         InsetOld * inset = new InsetFloatList(ev.argument);
1166                         if (!insertInset(inset, tclass.defaultLayoutName()))
1167                                 delete inset;
1168                 } else {
1169                         lyxerr << "Non-existent float type: "
1170                                << ev.argument << endl;
1171                 }
1172                 break;
1173
1174         case LFUN_LAYOUT_PARAGRAPH: {
1175                 string data;
1176                 params2string(*bv_->getLyXText()->cursorPar(), data);
1177                 data = "show\n" + data;
1178                 bv_->owner()->getDialogs().show("paragraph", data);
1179                 break;
1180         }
1181
1182         case LFUN_PARAGRAPH_UPDATE:
1183                 updateParagraphDialog();
1184                 break;
1185
1186         case LFUN_PARAGRAPH_APPLY:
1187                 setParagraphParams(*bv_, ev.argument);
1188                 break;
1189
1190         case LFUN_THESAURUS_ENTRY: {
1191                 string arg = ev.argument;
1192
1193                 if (arg.empty()) {
1194                         arg = bv_->getLyXText()->selectionAsString(*buffer_,
1195                                                                    false);
1196
1197                         // FIXME
1198                         if (arg.size() > 100 || arg.empty()) {
1199                                 // Get word or selection
1200                                 bv_->getLyXText()->selectWordWhenUnderCursor(lyx::WHOLE_WORD);
1201                                 arg = bv_->getLyXText()->selectionAsString(*buffer_, false);
1202                                 // FIXME: where is getLyXText()->unselect(bv_) ?
1203                         }
1204                 }
1205
1206                 bv_->owner()->getDialogs().show("thesaurus", arg);
1207                 break;
1208         }
1209
1210         case LFUN_TRACK_CHANGES:
1211                 trackChanges();
1212                 break;
1213
1214         case LFUN_MERGE_CHANGES:
1215                 owner_->getDialogs().show("changes");
1216                 break;
1217
1218         case LFUN_ACCEPT_ALL_CHANGES: {
1219                 bv_->text()->setCursor(0, 0);
1220 #warning FIXME changes
1221                 while (lyx::find::findNextChange(bv_))
1222                         bv_->getLyXText()->acceptChange();
1223                 update();
1224                 break;
1225         }
1226
1227         case LFUN_REJECT_ALL_CHANGES: {
1228                 bv_->text()->setCursor(0, 0);
1229 #warning FIXME changes
1230                 while (lyx::find::findNextChange(bv_))
1231                         bv_->getLyXText()->rejectChange();
1232                 update();
1233                 break;
1234         }
1235
1236         case LFUN_ACCEPT_CHANGE: {
1237                 bv_->getLyXText()->acceptChange();
1238                 update();
1239                 break;
1240         }
1241
1242         case LFUN_REJECT_CHANGE: {
1243                 bv_->getLyXText()->rejectChange();
1244                 update();
1245                 break;
1246         }
1247
1248         case LFUN_UNKNOWN_ACTION:
1249                 ev.errorMessage(N_("Unknown function!"));
1250                 break;
1251
1252         default:
1253                 return bv_->getLyXText()->dispatch(FuncRequest(ev, bv_)).dispatched();
1254         } // end of switch
1255
1256         return true;
1257 }
1258
1259
1260 bool BufferView::Pimpl::insertInset(InsetOld * inset, string const & lout)
1261 {
1262 #ifdef LOCK
1263         // if we are in a locking inset we should try to insert the
1264         // inset there otherwise this is a illegal function now
1265         if (bv_->theLockingInset()) {
1266                 if (bv_->theLockingInset()->insetAllowed(inset))
1267                         return bv_->theLockingInset()->insertInset(bv_, inset);
1268                 return false;
1269         }
1270 #endif
1271
1272         // not quite sure if we want this...
1273         bv_->text()->recUndo(bv_->text()->cursor.par());
1274         freezeUndo();
1275
1276         bv_->text()->clearSelection();
1277         if (!lout.empty()) {
1278                 bv_->text()->breakParagraph(bv_->buffer()->paragraphs());
1279
1280                 if (!bv_->text()->cursorPar()->empty()) {
1281                         bv_->text()->cursorLeft(bv_);
1282                         bv_->text()->breakParagraph(bv_->buffer()->paragraphs());
1283                 }
1284
1285                 string lres = lout;
1286                 LyXTextClass const & tclass = buffer_->params().getLyXTextClass();
1287                 bool hasLayout = tclass.hasLayout(lres);
1288
1289                 bv_->text()->setLayout(hasLayout ? lres : tclass.defaultLayoutName());
1290                 bv_->text()->setParagraph(Spacing(), LYX_ALIGN_LAYOUT, string(), 0);
1291         }
1292         bv_->cursor().innerText()->insertInset(inset);
1293         unFreezeUndo();
1294         return true;
1295 }
1296
1297
1298 bool BufferView::Pimpl::ChangeInsets(InsetOld::Code code,
1299                                      string const & from, string const & to)
1300 {
1301         bool need_update = false;
1302         LyXCursor cursor = bv_->text()->cursor;
1303         LyXCursor tmpcursor = cursor;
1304         cursor.par(tmpcursor.par());
1305         cursor.pos(tmpcursor.pos());
1306
1307         ParIterator end = bv_->buffer()->par_iterator_end();
1308         for (ParIterator it = bv_->buffer()->par_iterator_begin();
1309              it != end; ++it) {
1310                 bool changed_inset = false;
1311                 for (InsetList::iterator it2 = it->insetlist.begin();
1312                      it2 != it->insetlist.end(); ++it2) {
1313                         if (it2->inset->lyxCode() == code) {
1314                                 InsetCommand * inset = static_cast<InsetCommand *>(it2->inset);
1315                                 if (inset->getContents() == from) {
1316                                         inset->setContents(to);
1317                                         changed_inset = true;
1318                                 }
1319                         }
1320                 }
1321                 if (changed_inset) {
1322                         need_update = true;
1323
1324                         // FIXME
1325
1326                         // The test it.size()==1 was needed to prevent crashes.
1327                         // How to set the cursor correctly when it.size()>1 ??
1328                         if (it.size() == 1) {
1329                                 bv_->text()->setCursorIntern(bv_->text()->parOffset(it.pit()), 0);
1330                                 bv_->text()->redoParagraph(bv_->text()->cursorPar());
1331                         }
1332                 }
1333         }
1334         bv_->text()->setCursorIntern(cursor.par(), cursor.pos());
1335         return need_update;
1336 }
1337
1338
1339 void BufferView::Pimpl::updateParagraphDialog()
1340 {
1341         if (!bv_->owner()->getDialogs().visible("paragraph"))
1342                 return;
1343         Paragraph const & par = *bv_->getLyXText()->cursorPar();
1344         string data;
1345         params2string(par, data);
1346
1347         // Will the paragraph accept changes from the dialog?
1348         InsetOld * const inset = par.inInset();
1349         bool const accept =
1350                 !(inset && inset->forceDefaultParagraphs(inset));
1351
1352         data = "update " + tostr(accept) + '\n' + data;
1353         bv_->owner()->getDialogs().update("paragraph", data);
1354 }