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