src/BufferView_pimpl.C

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