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