]> git.lyx.org Git - lyx.git/blob - src/BufferView.C
ea667c43f95b50cac6bfcfa7fd202772c3fd15f6
[lyx.git] / src / BufferView.C
1 /**
2  * \file BufferView.C
3  * This file is part of LyX, the document processor.
4  * Licence details can be found in the file COPYING.
5  *
6  * \author Alfredo Braunstein
7  * \author Lars Gullik Bjønnes
8  * \author John Levon
9  * \author André Pönitz
10  * \author Jürgen Vigna
11  *
12  * Full author contact details are available in file CREDITS.
13  */
14
15 #include <config.h>
16
17 #include "BufferView.h"
18
19 #include "buffer.h"
20 #include "buffer_funcs.h"
21 #include "bufferlist.h"
22 #include "bufferparams.h"
23 #include "coordcache.h"
24 #include "CutAndPaste.h"
25 #include "debug.h"
26 #include "dispatchresult.h"
27 #include "errorlist.h"
28 #include "factory.h"
29 #include "FloatList.h"
30 #include "funcrequest.h"
31 #include "FuncStatus.h"
32 #include "gettext.h"
33 #include "intl.h"
34 #include "insetiterator.h"
35 #include "language.h"
36 #include "LaTeXFeatures.h"
37 #include "lyx_cb.h" // added for Dispatch functions
38 #include "lyx_main.h"
39 #include "lyxfind.h"
40 #include "lyxfunc.h"
41 #include "lyxlayout.h"
42 #include "lyxtext.h"
43 #include "lyxtextclass.h"
44 #include "lyxrc.h"
45 #include "session.h"
46 #include "paragraph.h"
47 #include "paragraph_funcs.h"
48 #include "ParagraphParameters.h"
49 #include "pariterator.h"
50 #include "texrow.h"
51 #include "toc.h"
52 #include "undo.h"
53 #include "vspace.h"
54 #include "WordLangTuple.h"
55 #include "metricsinfo.h"
56
57 #include "insets/insetbibtex.h"
58 #include "insets/insetcommand.h" // ChangeRefs
59 #include "insets/insetref.h"
60 #include "insets/insettext.h"
61
62 #include "frontends/Alert.h"
63 #include "frontends/FileDialog.h"
64 #include "frontends/FontMetrics.h"
65
66 #include "graphics/Previews.h"
67
68 #include "support/convert.h"
69 #include "support/filefilterlist.h"
70 #include "support/filetools.h"
71 #include "support/package.h"
72 #include "support/types.h"
73
74 #include <boost/bind.hpp>
75 #include <boost/current_function.hpp>
76
77 #include <functional>
78 #include <vector>
79
80
81 namespace lyx {
82
83 using support::addPath;
84 using support::bformat;
85 using support::FileFilterList;
86 using support::fileSearch;
87 using support::isDirWriteable;
88 using support::makeDisplayPath;
89 using support::makeAbsPath;
90 using support::package;
91
92 using std::distance;
93 using std::endl;
94 using std::istringstream;
95 using std::make_pair;
96 using std::min;
97 using std::max;
98 using std::mem_fun_ref;
99 using std::string;
100 using std::vector;
101
102 namespace Alert = frontend::Alert;
103
104 namespace {
105
106 unsigned int const saved_positions_num = 20;
107
108
109 /// Return an inset of this class if it exists at the current cursor position
110 template <class T>
111 T * getInsetByCode(LCursor & cur, InsetBase::Code code)
112 {
113         T * inset = 0;
114         DocIterator it = cur;
115         if (it.nextInset() &&
116             it.nextInset()->lyxCode() == code) {
117                 inset = static_cast<T*>(it.nextInset());
118         }
119         return inset;
120 }
121
122 } // anon namespace
123
124
125 BufferView::BufferView()
126         : buffer_(0), wh_(0), width_(0), height_(0),
127           cursor_(*this),
128           multiparsel_cache_(false), anchor_ref_(0), offset_ref_(0),
129           intl_(new Intl)
130 {
131         xsel_cache_.set = false;
132
133         saved_positions.resize(saved_positions_num);
134         // load saved bookmarks
135         Session::BookmarkList & bmList = LyX::ref().session().loadBookmarks();
136         for (Session::BookmarkList::iterator bm = bmList.begin();
137                 bm != bmList.end(); ++bm)
138                 if (bm->get<0>() < saved_positions_num)
139                         saved_positions[bm->get<0>()] = Position( bm->get<1>(), bm->get<2>(), bm->get<3>() );
140         // and then clear them
141         bmList.clear();
142
143         intl_->initKeyMapper(lyxrc.use_kbmap);
144 }
145
146
147 BufferView::~BufferView()
148 {
149 }
150
151
152 Buffer * BufferView::buffer() const
153 {
154         return buffer_;
155 }
156
157
158 void BufferView::setBuffer(Buffer * b)
159 {
160         lyxerr[Debug::INFO] << BOOST_CURRENT_FUNCTION
161                             << "[ b = " << b << "]" << endl;
162
163         if (buffer_) {
164                 // Save the actual cursor position and anchor inside the
165                 // buffer so that it can be restored in case we rechange
166                 // to this buffer later on.
167                 buffer_->saveCursor(cursor_.selectionBegin(),
168                                     cursor_.selectionEnd());
169                 // current buffer is going to be switched-off, save cursor pos
170                 LyX::ref().session().saveFilePosition(buffer_->fileName(),
171                         boost::tie(cursor_.pit(), cursor_.pos()) );
172         }
173
174         // If we're quitting lyx, don't bother updating stuff
175         if (quitting) {
176                 buffer_ = 0;
177                 return;
178         }
179
180         // If we are closing current buffer, switch to the first in
181         // buffer list.
182         if (!b) {
183                 lyxerr[Debug::INFO] << BOOST_CURRENT_FUNCTION
184                                     << " No Buffer!" << endl;
185                 // We are closing the buffer, use the first buffer as current
186                 buffer_ = theBufferList().first();
187         } else {
188                 // Set current buffer
189                 buffer_ = b;
190         }
191
192         // Reset old cursor
193         cursor_ = LCursor(*this);
194         anchor_ref_ = 0;
195         offset_ref_ = 0;
196
197         if (buffer_) {
198                 lyxerr[Debug::INFO] << BOOST_CURRENT_FUNCTION
199                                     << "Buffer addr: " << buffer_ << endl;
200                 cursor_.push(buffer_->inset());
201                 cursor_.resetAnchor();
202                 buffer_->text().init(this);
203                 buffer_->text().setCurrentFont(cursor_);
204                 if (buffer_->getCursor().size() > 0 &&
205                     buffer_->getAnchor().size() > 0)
206                 {
207                         cursor_.setCursor(buffer_->getAnchor().asDocIterator(&(buffer_->inset())));
208                         cursor_.resetAnchor();
209                         cursor_.setCursor(buffer_->getCursor().asDocIterator(&(buffer_->inset())));
210                         cursor_.setSelection();
211                 }
212         }
213
214         update();
215
216         if (buffer_ && graphics::Previews::status() != LyXRC::PREVIEW_OFF)
217                 graphics::Previews::get().generateBufferPreviews(*buffer_);
218 }
219
220
221 bool BufferView::loadLyXFile(string const & filename, bool tolastfiles)
222 {
223         // Get absolute path of file and add ".lyx"
224         // to the filename if necessary
225         string s = fileSearch(string(), filename, "lyx");
226
227         bool const found = !s.empty();
228
229         if (!found)
230                 s = filename;
231
232         // File already open?
233         if (theBufferList().exists(s)) {
234                 docstring const file = makeDisplayPath(s, 20);
235                 docstring text = bformat(_("The document %1$s is already "
236                                                      "loaded.\n\nDo you want to revert "
237                                                      "to the saved version?"), file);
238                 int const ret = Alert::prompt(_("Revert to saved document?"),
239                         text, 0, 1,  _("&Revert"), _("&Switch to document"));
240
241                 if (ret != 0) {
242                         setBuffer(theBufferList().getBuffer(s));
243                         return true;
244                 }
245                 // FIXME: should be LFUN_REVERT
246                 if (!theBufferList().close(theBufferList().getBuffer(s), false))
247                         return false;
248                 // Fall through to new load. (Asger)
249         }
250
251         Buffer * b = 0;
252
253         if (found) {
254                 b = theBufferList().newBuffer(s);
255                 if (!lyx::loadLyXFile(b, s)) {
256                         theBufferList().release(b);
257                         return false;
258                 }
259         } else {
260                 docstring text = bformat(_("The document %1$s does not yet "
261                                                      "exist.\n\nDo you want to create "
262                                                      "a new document?"), from_utf8(s));
263                 int const ret = Alert::prompt(_("Create new document?"),
264                          text, 0, 1, _("&Create"), _("Cancel"));
265
266                 if (ret == 0) {
267                         b = newFile(s, string(), true);
268                         if (!b)
269                                 return false;
270                 } else
271                         return false;
272         }
273
274         setBuffer(b);
275         // Send the "errors" signal in case of parsing errors
276         b->errors("Parse");
277
278         // scroll to the position when the file was last closed
279         if (lyxrc.use_lastfilepos) {
280                 pit_type pit;
281                 pos_type pos;
282                 boost::tie(pit, pos) = LyX::ref().session().loadFilePosition(s);
283                 // I am not sure how to separate the following part to a function
284                 // so I will leave this to Lars.
285                 //
286                 // check pit since the document may be externally changed.
287                 if ( static_cast<size_t>(pit) < b->paragraphs().size() ) {
288                         ParIterator it = b->par_iterator_begin();
289                         ParIterator const end = b->par_iterator_end();
290                         for (; it != end; ++it)
291                                 if (it.pit() == pit) {
292                                         // restored pos may be bigger than it->size
293                                         setCursor(makeDocIterator(it, min(pos, it->size())));
294                                         update(Update::FitCursor);
295                                         break;
296                                 }
297                 }
298         }
299
300         if (tolastfiles)
301                 LyX::ref().session().addLastFile(b->fileName());
302
303         return true;
304 }
305
306
307 void BufferView::reload()
308 {
309         string const fn = buffer_->fileName();
310         if (theBufferList().close(buffer_, false))
311                 loadLyXFile(fn);
312 }
313
314
315 void BufferView::resize()
316 {
317         if (!buffer_)
318                 return;
319
320         lyxerr[Debug::DEBUG] << BOOST_CURRENT_FUNCTION << endl;
321
322         buffer_->text().init(this);
323         update();
324         switchKeyMap();
325 }
326
327
328 bool BufferView::fitCursor()
329 {
330         if (bv_funcs::status(this, cursor_) == bv_funcs::CUR_INSIDE) {
331                 frontend::FontMetrics const & fm =
332                         theFontMetrics(cursor_.getFont());
333                 int const asc = fm.maxAscent();
334                 int const des = fm.maxDescent();
335                 Point const p = bv_funcs::getPos(*this, cursor_, cursor_.boundary());
336                 if (p.y_ - asc >= 0 && p.y_ + des < height_)
337                         return false;
338         }
339         center();
340         return true;
341 }
342
343
344 bool BufferView::multiParSel()
345 {
346         if (!cursor_.selection())
347                 return false;
348         bool ret = multiparsel_cache_;
349         multiparsel_cache_ = cursor_.selBegin().pit() != cursor_.selEnd().pit();
350         // Either this, or previous selection spans paragraphs
351         return ret || multiparsel_cache_;
352 }
353
354
355 bool BufferView::update(Update::flags flags)
356 {
357         // This is close to a hot-path.
358         if (lyxerr.debugging(Debug::DEBUG)) {
359                 lyxerr[Debug::DEBUG]
360                         << BOOST_CURRENT_FUNCTION
361                         << "[fitcursor = " << (flags & Update::FitCursor)
362                         << ", forceupdate = " << (flags & Update::Force)
363                         << ", singlepar = " << (flags & Update::SinglePar)
364                         << "]  buffer: " << buffer_ << endl;
365         }
366
367         // Check needed to survive LyX startup
368         if (!buffer_)
369                 return false;
370
371         lyxerr[Debug::WORKAREA] << "BufferView::update" << std::endl;
372
373         // Update macro store
374         buffer_->buildMacros();
375
376         // First drawing step
377         updateMetrics(flags & Update::SinglePar);
378
379         // The second drawing step is done in WorkArea::redraw() if needed.
380         bool const need_second_step =
381                 (flags & (Update::Force | Update::FitCursor | Update::MultiParSel))
382                 && (fitCursor() || multiParSel());
383
384         return need_second_step;
385 }
386
387
388 void BufferView::updateScrollbar()
389 {
390         if (!buffer_) {
391                 lyxerr[Debug::DEBUG] << BOOST_CURRENT_FUNCTION
392                                      << " no text in updateScrollbar" << endl;
393                 scrollbarParameters_.reset();
394                 return;
395         }
396
397         LyXText & t = buffer_->text();
398         int const parsize = int(t.paragraphs().size() - 1);
399         if (anchor_ref_ >  parsize)  {
400                 anchor_ref_ = parsize;
401                 offset_ref_ = 0;
402         }
403
404         lyxerr[Debug::GUI]
405                 << BOOST_CURRENT_FUNCTION
406                 << " Updating scrollbar: height: " << t.paragraphs().size()
407                 << " curr par: " << cursor_.bottom().pit()
408                 << " default height " << defaultRowHeight() << endl;
409
410         // It would be better to fix the scrollbar to understand
411         // values in [0..1] and divide everything by wh
412
413         // estimated average paragraph height:
414         if (wh_ == 0)
415                 wh_ = height_ / 4;
416         int h = t.getPar(anchor_ref_).height();
417
418         // Normalize anchor/offset (MV):
419         while (offset_ref_ > h && anchor_ref_ < parsize) {
420                 anchor_ref_++;
421                 offset_ref_ -= h;
422                 h = t.getPar(anchor_ref_).height();
423         }
424         // Look at paragraph heights on-screen
425         int sumh = 0;
426         int nh = 0;
427         for (pit_type pit = anchor_ref_; pit <= parsize; ++pit) {
428                 if (sumh > height_)
429                         break;
430                 int const h2 = t.getPar(pit).height();
431                 sumh += h2;
432                 nh++;
433         }
434
435         BOOST_ASSERT(nh);
436         int const hav = sumh / nh;
437         // More realistic average paragraph height
438         if (hav > wh_)
439                 wh_ = hav;
440
441         BOOST_ASSERT(h);
442         scrollbarParameters_.height = (parsize + 1) * wh_;
443         scrollbarParameters_.position = anchor_ref_ * wh_ + int(offset_ref_ * wh_ / float(h));
444         scrollbarParameters_.lineScrollHeight = int(wh_ * defaultRowHeight() / float(h));
445 }
446
447
448 ScrollbarParameters const & BufferView::scrollbarParameters() const
449 {
450         return scrollbarParameters_;
451 }
452
453
454 void BufferView::scrollDocView(int value)
455 {
456         lyxerr[Debug::GUI] << BOOST_CURRENT_FUNCTION
457                            << "[ value = " << value << "]" << endl;
458
459         if (!buffer_)
460                 return;
461
462         LyXText & t = buffer_->text();
463
464         float const bar = value / float(wh_ * t.paragraphs().size());
465
466         anchor_ref_ = int(bar * t.paragraphs().size());
467         if (anchor_ref_ >  int(t.paragraphs().size()) - 1)
468                 anchor_ref_ = int(t.paragraphs().size()) - 1;
469         t.redoParagraph(anchor_ref_);
470         int const h = t.getPar(anchor_ref_).height();
471         offset_ref_ = int((bar * t.paragraphs().size() - anchor_ref_) * h);
472 }
473
474
475 void BufferView::setCursorFromScrollbar()
476 {
477         LyXText & t = buffer_->text();
478
479         int const height = 2 * defaultRowHeight();
480         int const first = height;
481         int const last = height_ - height;
482         LCursor & cur = cursor_;
483
484         bv_funcs::CurStatus st = bv_funcs::status(this, cur);
485
486         switch (st) {
487         case bv_funcs::CUR_ABOVE:
488                 t.setCursorFromCoordinates(cur, 0, first);
489                 cur.clearSelection();
490                 break;
491         case bv_funcs::CUR_BELOW:
492                 t.setCursorFromCoordinates(cur, 0, last);
493                 cur.clearSelection();
494                 break;
495         case bv_funcs::CUR_INSIDE:
496                 int const y = bv_funcs::getPos(*this, cur, cur.boundary()).y_;
497                 int const newy = min(last, max(y, first));
498                 if (y != newy) {
499                         cur.reset(buffer_->inset());
500                         t.setCursorFromCoordinates(cur, 0, newy);
501                 }
502         }
503 }
504
505
506 Change const BufferView::getCurrentChange() const
507 {
508         if (!cursor_.selection())
509                 return Change(Change::UNCHANGED);
510
511         DocIterator dit = cursor_.selectionBegin();
512         return dit.paragraph().lookupChange(dit.pos());
513 }
514
515
516 void BufferView::savePosition(unsigned int i)
517 {
518         if (i >= saved_positions_num)
519                 return;
520         BOOST_ASSERT(cursor_.inTexted());
521         saved_positions[i] = Position(buffer_->fileName(),
522                                       cursor_.paragraph().id(),
523                                       cursor_.pos());
524         if (i > 0)
525                 // emit message signal.
526                 message(bformat(_("Saved bookmark %1$d"), i));
527 }
528
529
530 void BufferView::restorePosition(unsigned int i)
531 {
532         if (i >= saved_positions_num)
533                 return;
534
535         string const fname = saved_positions[i].filename;
536
537         cursor_.clearSelection();
538
539         if (fname != buffer_->fileName()) {
540                 Buffer * b = 0;
541                 if (theBufferList().exists(fname))
542                         b = theBufferList().getBuffer(fname);
543                 else {
544                         b = theBufferList().newBuffer(fname);
545                         // Don't ask, just load it
546                         lyx::loadLyXFile(b, fname);
547                 }
548                 if (b)
549                         setBuffer(b);
550         }
551
552         ParIterator par = buffer_->getParFromID(saved_positions[i].par_id);
553         if (par == buffer_->par_iterator_end())
554                 return;
555
556         setCursor(makeDocIterator(par, min(par->size(), saved_positions[i].par_pos)));
557
558         if (i > 0)
559                 // emit message signal.
560                 message(bformat(_("Moved to bookmark %1$d"), i));
561 }
562
563
564 bool BufferView::isSavedPosition(unsigned int i)
565 {
566         return i < saved_positions_num && !saved_positions[i].filename.empty();
567 }
568
569 void BufferView::saveSavedPositions()
570 {
571         // save bookmarks. It is better to use the pit interface
572         // but I do not know how to effectively convert between
573         // par_id and pit.
574         for (unsigned int i=1; i < saved_positions_num; ++i) {
575                 if ( isSavedPosition(i) )
576                         LyX::ref().session().saveBookmark( boost::tie(
577                                 i,
578                                 saved_positions[i].filename,
579                                 saved_positions[i].par_id,
580                                 saved_positions[i].par_pos) );
581         }
582 }
583
584 void BufferView::switchKeyMap()
585 {
586         if (!lyxrc.rtl_support)
587                 return;
588
589         if (getLyXText()->real_current_font.isRightToLeft()) {
590                 if (intl_->keymap == Intl::PRIMARY)
591                         intl_->keyMapSec();
592         } else {
593                 if (intl_->keymap == Intl::SECONDARY)
594                         intl_->keyMapPrim();
595         }
596 }
597
598
599 int BufferView::workWidth() const
600 {
601         return width_;
602 }
603
604
605 void BufferView::center()
606 {
607         CursorSlice & bot = cursor_.bottom();
608         pit_type const pit = bot.pit();
609         bot.text()->redoParagraph(pit);
610         Paragraph const & par = bot.text()->paragraphs()[pit];
611         anchor_ref_ = pit;
612         offset_ref_ = bv_funcs::coordOffset(*this, cursor_, cursor_.boundary()).y_
613                 + par.ascent() - height_ / 2;
614 }
615
616
617 FuncStatus BufferView::getStatus(FuncRequest const & cmd)
618 {
619         FuncStatus flag;
620
621         switch (cmd.action) {
622
623         case LFUN_UNDO:
624                 flag.enabled(!buffer_->undostack().empty());
625                 break;
626         case LFUN_REDO:
627                 flag.enabled(!buffer_->redostack().empty());
628                 break;
629         case LFUN_FILE_INSERT:
630         case LFUN_FILE_INSERT_ASCII_PARA:
631         case LFUN_FILE_INSERT_ASCII:
632         case LFUN_BOOKMARK_SAVE:
633                 // FIXME: Actually, these LFUNS should be moved to LyXText
634                 flag.enabled(cursor_.inTexted());
635                 break;
636         case LFUN_FONT_STATE:
637         case LFUN_LABEL_INSERT:
638         case LFUN_PARAGRAPH_GOTO:
639         // FIXME handle non-trivially
640         case LFUN_OUTLINE_UP:
641         case LFUN_OUTLINE_DOWN:
642         case LFUN_OUTLINE_IN:
643         case LFUN_OUTLINE_OUT:
644         case LFUN_NOTE_NEXT:
645         case LFUN_REFERENCE_NEXT:
646         case LFUN_WORD_FIND:
647         case LFUN_WORD_REPLACE:
648         case LFUN_MARK_OFF:
649         case LFUN_MARK_ON:
650         case LFUN_MARK_TOGGLE:
651         case LFUN_SCREEN_RECENTER:
652         case LFUN_BIBTEX_DATABASE_ADD:
653         case LFUN_BIBTEX_DATABASE_DEL:
654         case LFUN_WORDS_COUNT:
655         case LFUN_NEXT_INSET_TOGGLE:
656                 flag.enabled(true);
657                 break;
658
659         case LFUN_LABEL_GOTO: {
660                 flag.enabled(!cmd.argument().empty()
661                     || getInsetByCode<InsetRef>(cursor_, InsetBase::REF_CODE));
662                 break;
663         }
664
665         case LFUN_BOOKMARK_GOTO:
666                 flag.enabled(isSavedPosition(convert<unsigned int>(to_utf8(cmd.argument()))));
667                 break;
668
669         case LFUN_CHANGES_TRACK:
670                 flag.enabled(true);
671                 flag.setOnOff(buffer_->params().trackChanges);
672                 break;
673
674         case LFUN_CHANGES_OUTPUT: {
675                 OutputParams runparams;
676                 LaTeXFeatures features(*buffer_, buffer_->params(), runparams);
677                 flag.enabled(buffer_ && features.isAvailable("dvipost"));
678                 flag.setOnOff(buffer_->params().outputChanges);
679                 break;
680         }
681
682         case LFUN_CHANGES_MERGE:
683         case LFUN_CHANGE_NEXT:
684         case LFUN_ALL_CHANGES_ACCEPT:
685         case LFUN_ALL_CHANGES_REJECT:
686                 flag.enabled(buffer_); // FIXME: Change tracking (MG)
687                 break;
688
689         case LFUN_BUFFER_TOGGLE_COMPRESSION: {
690                 flag.setOnOff(buffer_->params().compressed);
691                 break;
692         }
693
694         default:
695                 flag.enabled(false);
696         }
697
698         return flag;
699 }
700
701
702 bool BufferView::dispatch(FuncRequest const & cmd)
703 {
704         //lyxerr << BOOST_CURRENT_FUNCTION
705         //       << [ cmd = " << cmd << "]" << endl;
706
707         // Make sure that the cached BufferView is correct.
708         lyxerr[Debug::ACTION] << BOOST_CURRENT_FUNCTION
709                 << " action[" << cmd.action << ']'
710                 << " arg[" << to_utf8(cmd.argument()) << ']'
711                 << " x[" << cmd.x << ']'
712                 << " y[" << cmd.y << ']'
713                 << " button[" << cmd.button() << ']'
714                 << endl;
715
716         LCursor & cur = cursor_;
717
718         switch (cmd.action) {
719
720         case LFUN_UNDO:
721                 if (buffer_) {
722                         cur.message(_("Undo"));
723                         cur.clearSelection();
724                         if (!textUndo(*this))
725                                 cur.message(_("No further undo information"));
726                         update();
727                         switchKeyMap();
728                 }
729                 break;
730
731         case LFUN_REDO:
732                 if (buffer_) {
733                         cur.message(_("Redo"));
734                         cur.clearSelection();
735                         if (!textRedo(*this))
736                                 cur.message(_("No further redo information"));
737                         update();
738                         switchKeyMap();
739                 }
740                 break;
741
742         case LFUN_FILE_INSERT:
743                 // FIXME: We don't know the encoding of filenames
744                 menuInsertLyXFile(to_utf8(cmd.argument()));
745                 break;
746
747         case LFUN_FILE_INSERT_ASCII_PARA:
748                 // FIXME: We don't know the encoding of filenames
749                 insertAsciiFile(this, to_utf8(cmd.argument()), true);
750                 break;
751
752         case LFUN_FILE_INSERT_ASCII:
753                 // FIXME: We don't know the encoding of filenames
754                 insertAsciiFile(this, to_utf8(cmd.argument()), false);
755                 break;
756
757         case LFUN_FONT_STATE:
758                 cur.message(from_utf8(cur.currentState()));
759                 break;
760
761         case LFUN_BOOKMARK_SAVE:
762                 savePosition(convert<unsigned int>(to_utf8(cmd.argument())));
763                 break;
764
765         case LFUN_BOOKMARK_GOTO:
766                 restorePosition(convert<unsigned int>(to_utf8(cmd.argument())));
767                 break;
768
769         case LFUN_LABEL_GOTO: {
770                 docstring label = cmd.argument();
771                 if (label.empty()) {
772                         InsetRef * inset =
773                                 getInsetByCode<InsetRef>(cursor_,
774                                                          InsetBase::REF_CODE);
775                         if (inset) {
776                                 label = inset->getParam("reference");
777                                 savePosition(0);
778                         }
779                 }
780
781                 if (!label.empty())
782                         gotoLabel(label);
783                 break;
784         }
785
786         case LFUN_PARAGRAPH_GOTO: {
787                 int const id = convert<int>(to_utf8(cmd.argument()));
788                 ParIterator par = buffer_->getParFromID(id);
789                 if (par == buffer_->par_iterator_end()) {
790                         lyxerr[Debug::INFO] << "No matching paragraph found! ["
791                                             << id << ']' << endl;
792                         break;
793                 } else {
794                         lyxerr[Debug::INFO] << "Paragraph " << par->id()
795                                             << " found." << endl;
796                 }
797
798                 // Set the cursor
799                 setCursor(makeDocIterator(par, 0));
800
801                 update();
802                 switchKeyMap();
803                 break;
804         }
805
806         case LFUN_OUTLINE_UP:
807                 toc::outline(toc::Up, cursor_);
808                 cursor_.text()->setCursor(cursor_, cursor_.pit(), 0);
809                 updateLabels(*buffer_);
810                 break;
811         case LFUN_OUTLINE_DOWN:
812                 toc::outline(toc::Down, cursor_);
813                 cursor_.text()->setCursor(cursor_, cursor_.pit(), 0);
814                 updateLabels(*buffer_);
815                 break;
816         case LFUN_OUTLINE_IN:
817                 toc::outline(toc::In, cursor_);
818                 updateLabels(*buffer_);
819                 break;
820         case LFUN_OUTLINE_OUT:
821                 toc::outline(toc::Out, cursor_);
822                 updateLabels(*buffer_);
823                 break;
824
825         case LFUN_NOTE_NEXT:
826                 bv_funcs::gotoInset(this, InsetBase::NOTE_CODE, false);
827                 break;
828
829         case LFUN_REFERENCE_NEXT: {
830                 vector<InsetBase_code> tmp;
831                 tmp.push_back(InsetBase::LABEL_CODE);
832                 tmp.push_back(InsetBase::REF_CODE);
833                 bv_funcs::gotoInset(this, tmp, true);
834                 break;
835         }
836
837         case LFUN_CHANGES_TRACK:
838                 buffer_->params().trackChanges = !buffer_->params().trackChanges;
839                 break;
840
841         case LFUN_CHANGES_OUTPUT: {
842                 buffer_->params().outputChanges = !buffer_->params().outputChanges;
843                 break;
844         }
845
846         case LFUN_CHANGE_NEXT:
847                 findNextChange(this);
848                 break;
849
850         case LFUN_CHANGES_MERGE:
851                 if (findNextChange(this))
852                         showDialog("changes");
853                 break;
854
855         case LFUN_ALL_CHANGES_ACCEPT: {
856                 cursor_.reset(buffer_->inset());
857 #ifdef WITH_WARNINGS
858 #warning FIXME changes
859 #endif
860                 while (findNextChange(this))
861                         getLyXText()->acceptChange(cursor_);
862                 update();
863                 break;
864         }
865
866         case LFUN_ALL_CHANGES_REJECT: {
867                 cursor_.reset(buffer_->inset());
868 #ifdef WITH_WARNINGS
869 #warning FIXME changes
870 #endif
871                 while (findNextChange(this))
872                         getLyXText()->rejectChange(cursor_);
873                 break;
874         }
875
876         case LFUN_WORD_FIND:
877                 find(this, cmd);
878                 break;
879
880         case LFUN_WORD_REPLACE:
881                 replace(this, cmd);
882                 break;
883
884         case LFUN_MARK_OFF:
885                 cur.clearSelection();
886                 cur.resetAnchor();
887                 cur.message(from_utf8(N_("Mark off")));
888                 break;
889
890         case LFUN_MARK_ON:
891                 cur.clearSelection();
892                 cur.mark() = true;
893                 cur.resetAnchor();
894                 cur.message(from_utf8(N_("Mark on")));
895                 break;
896
897         case LFUN_MARK_TOGGLE:
898                 cur.clearSelection();
899                 if (cur.mark()) {
900                         cur.mark() = false;
901                         cur.message(from_utf8(N_("Mark removed")));
902                 } else {
903                         cur.mark() = true;
904                         cur.message(from_utf8(N_("Mark set")));
905                 }
906                 cur.resetAnchor();
907                 break;
908
909         case LFUN_SCREEN_RECENTER:
910                 center();
911                 break;
912
913         case LFUN_BIBTEX_DATABASE_ADD: {
914                 LCursor tmpcur = cursor_;
915                 bv_funcs::findInset(tmpcur, InsetBase::BIBTEX_CODE, false);
916                 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
917                                                 InsetBase::BIBTEX_CODE);
918                 if (inset) {
919                         if (inset->addDatabase(to_utf8(cmd.argument())))
920                                 buffer_->updateBibfilesCache();
921                 }
922                 break;
923         }
924
925         case LFUN_BIBTEX_DATABASE_DEL: {
926                 LCursor tmpcur = cursor_;
927                 bv_funcs::findInset(tmpcur, InsetBase::BIBTEX_CODE, false);
928                 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
929                                                 InsetBase::BIBTEX_CODE);
930                 if (inset) {
931                         if (inset->delDatabase(to_utf8(cmd.argument())))
932                                 buffer_->updateBibfilesCache();
933                 }
934                 break;
935         }
936
937         case LFUN_WORDS_COUNT: {
938                 DocIterator from, to;
939                 if (cur.selection()) {
940                         from = cur.selectionBegin();
941                         to = cur.selectionEnd();
942                 } else {
943                         from = doc_iterator_begin(buffer_->inset());
944                         to = doc_iterator_end(buffer_->inset());
945                 }
946                 int const count = countWords(from, to);
947                 docstring message;
948                 if (count != 1) {
949                         if (cur.selection())
950                                 message = bformat(_("%1$d words in selection."),
951                                           count);
952                                 else
953                                         message = bformat(_("%1$d words in document."),
954                                                           count);
955                 }
956                 else {
957                         if (cur.selection())
958                                 message = _("One word in selection.");
959                         else
960                                 message = _("One word in document.");
961                 }
962
963                 Alert::information(_("Count words"), message);
964         }
965                 break;
966
967         case LFUN_BUFFER_TOGGLE_COMPRESSION:
968                 // turn compression on/off
969                 buffer_->params().compressed = !buffer_->params().compressed;
970                 break;
971
972         case LFUN_NEXT_INSET_TOGGLE: {
973                 // this is the real function we want to invoke
974                 FuncRequest tmpcmd = FuncRequest(LFUN_INSET_TOGGLE, cmd.origin);
975                 // if there is an inset at cursor, see whether it
976                 // wants to toggle.
977                 InsetBase * inset = cur.nextInset();
978                 if (inset && inset->isActive()) {
979                         LCursor tmpcur = cur;
980                         tmpcur.pushLeft(*inset);
981                         inset->dispatch(tmpcur, tmpcmd);
982                         if (tmpcur.result().dispatched()) {
983                                 cur.dispatched();
984                         }
985                 }
986                 // if it did not work, try the underlying inset.
987                 if (!cur.result().dispatched())
988                         cur.dispatch(tmpcmd);
989
990                 if (cur.result().dispatched())
991                         cur.clearSelection();
992
993                 break;
994         }
995
996         default:
997                 return false;
998         }
999
1000         return true;
1001 }
1002
1003
1004 docstring const BufferView::requestSelection()
1005 {
1006         if (!buffer_)
1007                 return docstring();
1008
1009         LCursor & cur = cursor_;
1010
1011         if (!cur.selection()) {
1012                 xsel_cache_.set = false;
1013                 return docstring();
1014         }
1015
1016         if (!xsel_cache_.set ||
1017             cur.top() != xsel_cache_.cursor ||
1018             cur.anchor_.top() != xsel_cache_.anchor)
1019         {
1020                 xsel_cache_.cursor = cur.top();
1021                 xsel_cache_.anchor = cur.anchor_.top();
1022                 xsel_cache_.set = cur.selection();
1023                 return cur.selectionAsString(false);
1024         }
1025         return docstring();
1026 }
1027
1028
1029 void BufferView::clearSelection()
1030 {
1031         if (buffer_) {
1032                 cursor_.clearSelection();
1033                 xsel_cache_.set = false;
1034         }
1035 }
1036
1037
1038 void BufferView::workAreaResize(int width, int height)
1039 {
1040         bool const widthChange = width != width_;
1041         bool const heightChange = height != height_;
1042
1043         // Update from work area
1044         width_ = width;
1045         height_ = height;
1046
1047         if (buffer_ && widthChange) {
1048                 // The WorkArea content needs a resize
1049                 resize();
1050         }
1051
1052         if (widthChange || heightChange)
1053                 update();
1054 }
1055
1056
1057 bool BufferView::workAreaDispatch(FuncRequest const & cmd0)
1058 {
1059         //lyxerr << BOOST_CURRENT_FUNCTION << "[ cmd0 " << cmd0 << "]" << endl;
1060
1061         // This is only called for mouse related events including
1062         // LFUN_FILE_OPEN generated by drag-and-drop.
1063         FuncRequest cmd = cmd0;
1064
1065         if (!buffer_)
1066                 return false;
1067
1068         LCursor cur(*this);
1069         cur.push(buffer_->inset());
1070         cur.selection() = cursor_.selection();
1071
1072         // Doesn't go through lyxfunc, so we need to update
1073         // the layout choice etc. ourselves
1074
1075         // E.g. Qt mouse press when no buffer
1076         if (!buffer_)
1077                 return false;
1078
1079         // Either the inset under the cursor or the
1080         // surrounding LyXText will handle this event.
1081
1082         // Build temporary cursor.
1083         cmd.y = min(max(cmd.y, -1), height_);
1084         InsetBase * inset = buffer_->text().editXY(cur, cmd.x, cmd.y);
1085         //lyxerr << BOOST_CURRENT_FUNCTION
1086         //       << " * hit inset at tip: " << inset << endl;
1087         //lyxerr << BOOST_CURRENT_FUNCTION
1088         //       << " * created temp cursor:" << cur << endl;
1089
1090         // Put anchor at the same position.
1091         cur.resetAnchor();
1092
1093         // Try to dispatch to an non-editable inset near this position
1094         // via the temp cursor. If the inset wishes to change the real
1095         // cursor it has to do so explicitly by using
1096         //  cur.bv().cursor() = cur;  (or similar)
1097         if (inset)
1098                 inset->dispatch(cur, cmd);
1099
1100         // Now dispatch to the temporary cursor. If the real cursor should
1101         // be modified, the inset's dispatch has to do so explicitly.
1102         if (!cur.result().dispatched())
1103                 cur.dispatch(cmd);
1104
1105         if (cur.result().dispatched()) {
1106                 // Redraw if requested or necessary.
1107                 if (cur.result().update())
1108                         update(Update::FitCursor | Update::Force);
1109                 else
1110                         update(Update::FitCursor | Update::MultiParSel);
1111         }
1112
1113         return true;
1114 }
1115
1116
1117 void BufferView::scroll(int /*lines*/)
1118 {
1119 //      if (!buffer_)
1120 //              return;
1121 //
1122 //      LyXText const * t = &buffer_->text();
1123 //      int const line_height = defaultRowHeight();
1124 //
1125 //      // The new absolute coordinate
1126 //      int new_top_y = top_y() + lines * line_height;
1127 //
1128 //      // Restrict to a valid value
1129 //      new_top_y = std::min(t->height() - 4 * line_height, new_top_y);
1130 //      new_top_y = std::max(0, new_top_y);
1131 //
1132 //      scrollDocView(new_top_y);
1133 //
1134 //      // Update the scrollbar.
1135 //      workArea_->setScrollbarParams(t->height(), top_y(), defaultRowHeight());}
1136 }
1137
1138
1139 void BufferView::setCursorFromRow(int row)
1140 {
1141         int tmpid = -1;
1142         int tmppos = -1;
1143
1144         buffer_->texrow().getIdFromRow(row, tmpid, tmppos);
1145
1146         if (tmpid == -1)
1147                 buffer_->text().setCursor(cursor_, 0, 0);
1148         else
1149                 buffer_->text().setCursor(cursor_, buffer_->getParFromID(tmpid).pit(), tmppos);
1150 }
1151
1152
1153 void BufferView::gotoLabel(docstring const & label)
1154 {
1155         for (InsetIterator it = inset_iterator_begin(buffer_->inset()); it; ++it) {
1156                 vector<docstring> labels;
1157                 it->getLabelList(*buffer_, labels);
1158                 if (std::find(labels.begin(), labels.end(), label) != labels.end()) {
1159                         setCursor(it);
1160                         update();
1161                         return;
1162                 }
1163         }
1164 }
1165
1166
1167 LyXText * BufferView::getLyXText()
1168 {
1169         LyXText * text = cursor_.innerText();
1170         BOOST_ASSERT(text);
1171         return text;
1172 }
1173
1174
1175 LyXText const * BufferView::getLyXText() const
1176 {
1177         LyXText const * text = cursor_.innerText();
1178         BOOST_ASSERT(text);
1179         return text;
1180 }
1181
1182
1183 int BufferView::workHeight() const
1184 {
1185         return height_;
1186 }
1187
1188
1189 void BufferView::setCursor(DocIterator const & dit)
1190 {
1191         size_t const n = dit.depth();
1192         for (size_t i = 0; i < n; ++i)
1193                 dit[i].inset().edit(cursor_, true);
1194
1195         cursor_.setCursor(dit);
1196         cursor_.selection() = false;
1197 }
1198
1199
1200 void BufferView::mouseSetCursor(LCursor & cur)
1201 {
1202         BOOST_ASSERT(&cur.bv() == this);
1203
1204         // Has the cursor just left the inset?
1205         bool badcursor = false;
1206         if (&cursor_.inset() != &cur.inset())
1207                 badcursor = cursor_.inset().notifyCursorLeaves(cursor_);
1208
1209         // do the dEPM magic if needed
1210         // FIXME: move this to InsetText::notifyCursorLeaves?
1211         if (!badcursor && cursor_.inTexted())
1212                 cursor_.text()->deleteEmptyParagraphMechanism(cur, cursor_);
1213
1214         cursor_ = cur;
1215         cursor_.clearSelection();
1216         cursor_.setTargetX();
1217         finishUndo();
1218
1219 }
1220
1221
1222 void BufferView::putSelectionAt(DocIterator const & cur,
1223                                 int length, bool backwards)
1224 {
1225         cursor_.clearSelection();
1226
1227         setCursor(cur);
1228
1229         if (length) {
1230                 if (backwards) {
1231                         cursor_.pos() += length;
1232                         cursor_.setSelection(cursor_, -length);
1233                 } else
1234                         cursor_.setSelection(cursor_, length);
1235         }
1236 }
1237
1238
1239 LCursor & BufferView::cursor()
1240 {
1241         return cursor_;
1242 }
1243
1244
1245 LCursor const & BufferView::cursor() const
1246 {
1247         return cursor_;
1248 }
1249
1250
1251 pit_type BufferView::anchor_ref() const
1252 {
1253         return anchor_ref_;
1254 }
1255
1256
1257 ViewMetricsInfo const & BufferView::viewMetricsInfo()
1258 {
1259         return metrics_info_;
1260 }
1261
1262
1263 void BufferView::updateMetrics(bool singlepar)
1264 {
1265         // FIXME (Abdel 19/10/2006):
1266         // There's something fishy in tabular. The coord_cache_ is not
1267         // correctly reconstructed when a character is trying to be inserted.
1268         // Not clearing out the coord_cache_ fixes the crash but there is a
1269         // bad side effect: buffer-begin and buffer-end do not update the screen.
1270         //
1271         // Remove old position cache
1272         coord_cache_.clear();
1273
1274         LyXText & buftext = buffer_->text();
1275         pit_type size = int(buftext.paragraphs().size());
1276
1277         if (anchor_ref_ > int(buftext.paragraphs().size() - 1)) {
1278                 anchor_ref_ = int(buftext.paragraphs().size() - 1);
1279                 offset_ref_ = 0;
1280         }
1281
1282         pit_type const pit = anchor_ref_;
1283         int pit1 = pit;
1284         int pit2 = pit;
1285         size_t const npit = buftext.paragraphs().size();
1286
1287         // Rebreak anchor paragraph. In Single Paragraph mode, rebreak only
1288         // the (main text, not inset!) paragraph containing the cursor.
1289         // (if this paragraph contains insets etc., rebreaking will
1290         // recursively descend)
1291         if (!singlepar || pit == cursor_.bottom().pit())
1292                 buftext.redoParagraph(pit);
1293         int y0 = buftext.getPar(pit).ascent() - offset_ref_;
1294
1295         // Redo paragraphs above anchor if necessary; again, in Single Par
1296         // mode, only if we encounter the (main text) one having the cursor.
1297         int y1 = y0;
1298         while (y1 > 0 && pit1 > 0) {
1299                 y1 -= buftext.getPar(pit1).ascent();
1300                 --pit1;
1301                 if (!singlepar || pit1 == cursor_.bottom().pit())
1302                         buftext.redoParagraph(pit1);
1303                 y1 -= buftext.getPar(pit1).descent();
1304         }
1305
1306
1307         // Take care of ascent of first line
1308         y1 -= buftext.getPar(pit1).ascent();
1309
1310         // Normalize anchor for next time
1311         anchor_ref_ = pit1;
1312         offset_ref_ = -y1;
1313
1314         // Grey at the beginning is ugly
1315         if (pit1 == 0 && y1 > 0) {
1316                 y0 -= y1;
1317                 y1 = 0;
1318                 anchor_ref_ = 0;
1319         }
1320
1321         // Redo paragraphs below the anchor if necessary. Single par mode:
1322         // only the one containing the cursor if encountered.
1323         int y2 = y0;
1324         while (y2 < height_ && pit2 < int(npit) - 1) {
1325                 y2 += buftext.getPar(pit2).descent();
1326                 ++pit2;
1327                 if (!singlepar || pit2 == cursor_.bottom().pit())
1328                         buftext.redoParagraph(pit2);
1329                 y2 += buftext.getPar(pit2).ascent();
1330         }
1331
1332         // Take care of descent of last line
1333         y2 += buftext.getPar(pit2).descent();
1334
1335         // The coordinates of all these paragraphs are correct, cache them
1336         int y = y1;
1337         CoordCache::InnerParPosCache & parPos = coord_cache_.parPos()[&buftext];
1338         for (pit_type pit = pit1; pit <= pit2; ++pit) {
1339                 Paragraph const & par = buftext.getPar(pit);
1340                 y += par.ascent();
1341                 parPos[pit] = Point(0, y);
1342                 if (singlepar && pit == cursor_.bottom().pit()) {
1343                         // In Single Paragraph mode, collect here the
1344                         // y1 and y2 of the (one) paragraph the cursor is in
1345                         y1 = y - par.ascent();
1346                         y2 = y + par.descent();
1347                 }
1348                 y += par.descent();
1349         }
1350
1351         if (singlepar) {
1352                 // collect cursor paragraph iter bounds
1353                 pit1 = cursor_.bottom().pit();
1354                 pit2 = cursor_.bottom().pit();
1355         }
1356
1357         lyxerr[Debug::DEBUG]
1358                 << BOOST_CURRENT_FUNCTION
1359                 << " y1: " << y1
1360                 << " y2: " << y2
1361                 << " pit1: " << pit1
1362                 << " pit2: " << pit2
1363                 << " npit: " << npit
1364                 << " singlepar: " << singlepar
1365                 << "size: " << size
1366                 << endl;
1367
1368         metrics_info_ = ViewMetricsInfo(pit1, pit2, y1, y2, singlepar, size);
1369
1370         if (lyxerr.debugging(Debug::WORKAREA)) {
1371                 lyxerr[Debug::WORKAREA] << "BufferView::updateMetrics" << endl;
1372                 coord_cache_.dump();
1373         }
1374 }
1375
1376
1377 void BufferView::menuInsertLyXFile(string const & filenm)
1378 {
1379         BOOST_ASSERT(cursor_.inTexted());
1380         string filename = filenm;
1381
1382         if (filename.empty()) {
1383                 // Launch a file browser
1384                 // FIXME UNICODE
1385                 string initpath = lyxrc.document_path;
1386
1387                 if (buffer_) {
1388                         string const trypath = buffer_->filePath();
1389                         // If directory is writeable, use this as default.
1390                         if (isDirWriteable(trypath))
1391                                 initpath = trypath;
1392                 }
1393
1394                 // FIXME UNICODE
1395                 FileDialog fileDlg(_("Select LyX document to insert"),
1396                         LFUN_FILE_INSERT,
1397                         make_pair(_("Documents|#o#O"), from_utf8(lyxrc.document_path)),
1398                         make_pair(_("Examples|#E#e"), from_utf8(addPath(package().system_support(), "examples"))));
1399
1400                 FileDialog::Result result =
1401                         fileDlg.open(from_utf8(initpath),
1402                                      FileFilterList(_("LyX Documents (*.lyx)")),
1403                                      docstring());
1404
1405                 if (result.first == FileDialog::Later)
1406                         return;
1407
1408                 // FIXME UNICODE
1409                 filename = to_utf8(result.second);
1410
1411                 // check selected filename
1412                 if (filename.empty()) {
1413                         // emit message signal.
1414                         message(_("Canceled."));
1415                         return;
1416                 }
1417         }
1418
1419         // Get absolute path of file and add ".lyx"
1420         // to the filename if necessary
1421         filename = fileSearch(string(), filename, "lyx");
1422
1423         docstring const disp_fn = makeDisplayPath(filename);
1424         // emit message signal.
1425         message(bformat(_("Inserting document %1$s..."), disp_fn));
1426
1427         docstring res;
1428         Buffer buf("", false);
1429         if (lyx::loadLyXFile(&buf, makeAbsPath(filename))) {
1430                 ErrorList & el = buffer_->errorList("Parse");
1431                 // Copy the inserted document error list into the current buffer one.
1432                 el = buf.errorList("Parse");
1433                 cap::pasteParagraphList(cursor_, buf.paragraphs(),
1434                                              buf.params().textclass, el);
1435                 res = _("Document %1$s inserted.");
1436         } else
1437                 res = _("Could not insert document %1$s");
1438
1439         // emit message signal.
1440         message(bformat(res, disp_fn));
1441         buffer_->errors("Parse");
1442         resize();
1443 }
1444
1445
1446 } // namespace lyx