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