]> git.lyx.org Git - lyx.git/blob - src/BufferView.cpp
* src/frontends/GuiDocument.{cpp,h}:
[lyx.git] / src / BufferView.cpp
1 /**
2  * \file BufferView.cpp
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 "Cursor.h"
25 #include "CutAndPaste.h"
26 #include "DispatchResult.h"
27 #include "EmbeddedFiles.h"
28 #include "ErrorList.h"
29 #include "factory.h"
30 #include "FloatList.h"
31 #include "FuncRequest.h"
32 #include "FuncStatus.h"
33 #include "Intl.h"
34 #include "InsetIterator.h"
35 #include "Language.h"
36 #include "LaTeXFeatures.h"
37 #include "LyX.h"
38 #include "lyxfind.h"
39 #include "LyXFunc.h"
40 #include "Layout.h"
41 #include "LyXRC.h"
42 #include "MetricsInfo.h"
43 #include "Paragraph.h"
44 #include "paragraph_funcs.h"
45 #include "ParagraphParameters.h"
46 #include "ParIterator.h"
47 #include "Session.h"
48 #include "Text.h"
49 #include "TextClass.h"
50 #include "TextMetrics.h"
51 #include "TexRow.h"
52 #include "VSpace.h"
53 #include "WordLangTuple.h"
54
55 #include "insets/InsetBibtex.h"
56 #include "insets/InsetCommand.h" // ChangeRefs
57 #include "insets/InsetRef.h"
58 #include "insets/InsetText.h"
59
60 #include "frontends/alert.h"
61 #include "frontends/Application.h"
62 #include "frontends/Delegates.h"
63 #include "frontends/FontMetrics.h"
64 #include "frontends/Painter.h"
65 #include "frontends/Selection.h"
66
67 #include "graphics/Previews.h"
68
69 #include "support/convert.h"
70 #include "support/debug.h"
71 #include "support/ExceptionMessage.h"
72 #include "support/FileFilterList.h"
73 #include "support/filetools.h"
74 #include "support/gettext.h"
75 #include "support/lstrings.h"
76 #include "support/Package.h"
77 #include "support/types.h"
78
79 #include <cerrno>
80 #include <fstream>
81 #include <functional>
82 #include <iterator>
83 #include <vector>
84
85 using namespace std;
86 using namespace lyx::support;
87
88 namespace lyx {
89
90 namespace Alert = frontend::Alert;
91
92 namespace {
93
94 /// Return an inset of this class if it exists at the current cursor position
95 template <class T>
96 T * getInsetByCode(Cursor const & cur, InsetCode code)
97 {
98         DocIterator it = cur;
99         Inset * inset = it.nextInset();
100         if (inset && inset->lyxCode() == code)
101                 return static_cast<T*>(inset);
102         return 0;
103 }
104
105
106 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
107         bool same_content);
108
109 bool findNextInset(DocIterator & dit, vector<InsetCode> const & codes,
110         docstring const & contents)
111 {
112         DocIterator tmpdit = dit;
113
114         while (tmpdit) {
115                 Inset const * inset = tmpdit.nextInset();
116                 if (inset
117                     && find(codes.begin(), codes.end(), inset->lyxCode()) != codes.end()
118                     && (contents.empty() ||
119                     static_cast<InsetCommand const *>(inset)->getFirstNonOptParam() == contents)) {
120                         dit = tmpdit;
121                         return true;
122                 }
123                 tmpdit.forwardInset();
124         }
125
126         return false;
127 }
128
129
130 /// Looks for next inset with one of the given codes.
131 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
132         bool same_content)
133 {
134         docstring contents;
135         DocIterator tmpdit = dit;
136         tmpdit.forwardInset();
137         if (!tmpdit)
138                 return false;
139
140         if (same_content) {
141                 Inset const * inset = tmpdit.nextInset();
142                 if (inset
143                     && find(codes.begin(), codes.end(), inset->lyxCode()) != codes.end()) {
144                         contents = static_cast<InsetCommand const *>(inset)->getFirstNonOptParam();
145                 }
146         }
147
148         if (!findNextInset(tmpdit, codes, contents)) {
149                 if (dit.depth() != 1 || dit.pit() != 0 || dit.pos() != 0) {
150                         tmpdit  = doc_iterator_begin(tmpdit.bottom().inset());
151                         if (!findNextInset(tmpdit, codes, contents))
152                                 return false;
153                 } else
154                         return false;
155         }
156
157         dit = tmpdit;
158         return true;
159 }
160
161
162 /// Looks for next inset with the given code
163 void findInset(DocIterator & dit, InsetCode code, bool same_content)
164 {
165         findInset(dit, vector<InsetCode>(1, code), same_content);
166 }
167
168
169 /// Moves cursor to the next inset with one of the given codes.
170 void gotoInset(BufferView * bv, vector<InsetCode> const & codes,
171                bool same_content)
172 {
173         Cursor tmpcur = bv->cursor();
174         if (!findInset(tmpcur, codes, same_content)) {
175                 bv->cursor().message(_("No more insets"));
176                 return;
177         }
178
179         tmpcur.clearSelection();
180         bv->setCursor(tmpcur);
181         bv->showCursor();
182 }
183
184
185 /// Moves cursor to the next inset with given code.
186 void gotoInset(BufferView * bv, InsetCode code, bool same_content)
187 {
188         gotoInset(bv, vector<InsetCode>(1, code), same_content);
189 }
190
191
192 /// A map from a Text to the associated text metrics
193 typedef map<Text const *, TextMetrics> TextMetricsCache;
194
195 enum ScreenUpdateStrategy {
196         NoScreenUpdate,
197         SingleParUpdate,
198         FullScreenUpdate,
199         DecorationUpdate
200 };
201
202 } // anon namespace
203
204
205 /////////////////////////////////////////////////////////////////////
206 //
207 // BufferView
208 //
209 /////////////////////////////////////////////////////////////////////
210
211 struct BufferView::Private
212 {
213         Private(BufferView & bv): wh_(0), cursor_(bv),
214                 anchor_pit_(0), anchor_ypos_(0),
215                 last_inset_(0), gui_(0)
216         {}
217
218         ///
219         ScrollbarParameters scrollbarParameters_;
220         ///
221         ScreenUpdateStrategy update_strategy_;
222         ///
223         CoordCache coord_cache_;
224
225         /// Estimated average par height for scrollbar.
226         int wh_;
227         /// this is used to handle XSelection events in the right manner.
228         struct {
229                 CursorSlice cursor;
230                 CursorSlice anchor;
231                 bool set;
232         } xsel_cache_;
233         ///
234         Cursor cursor_;
235         ///
236         pit_type anchor_pit_;
237         ///
238         int anchor_ypos_;
239         ///
240         vector<int> par_height_;
241
242         /// keyboard mapping object.
243         Intl intl_;
244
245         /// last visited inset.
246         /** kept to send setMouseHover(false).
247           * Not owned, so don't delete.
248           */
249         Inset * last_inset_;
250
251         mutable TextMetricsCache text_metrics_;
252
253         /// Whom to notify.
254         /** Not owned, so don't delete.
255           */
256         frontend::GuiBufferViewDelegate * gui_;
257 };
258
259
260 BufferView::BufferView(Buffer & buf)
261         : width_(0), height_(0), buffer_(buf), d(new Private(*this))
262 {
263         d->xsel_cache_.set = false;
264         d->intl_.initKeyMapper(lyxrc.use_kbmap);
265
266         d->cursor_.push(buffer_.inset());
267         d->cursor_.resetAnchor();
268         d->cursor_.setCurrentFont();
269
270         if (graphics::Previews::status() != LyXRC::PREVIEW_OFF)
271                 graphics::Previews::get().generateBufferPreviews(buffer_);
272 }
273
274
275 BufferView::~BufferView()
276 {
277         // current buffer is going to be switched-off, save cursor pos
278         // Ideally, the whole cursor stack should be saved, but session
279         // currently can only handle bottom (whole document) level pit and pos.
280         // That is to say, if a cursor is in a nested inset, it will be
281         // restore to the left of the top level inset.
282         LastFilePosSection::FilePos fp;
283         fp.pit = d->cursor_.bottom().pit();
284         fp.pos = d->cursor_.bottom().pos();
285         LyX::ref().session().lastFilePos().save(buffer_.fileName(), fp);
286
287         delete d;
288 }
289
290
291 Intl & BufferView::getIntl()
292 {
293         return d->intl_;
294 }
295
296
297 Intl const & BufferView::getIntl() const
298 {
299         return d->intl_;
300 }
301
302
303 CoordCache & BufferView::coordCache()
304 {
305         return d->coord_cache_;
306 }
307
308
309 CoordCache const & BufferView::coordCache() const
310 {
311         return d->coord_cache_;
312 }
313
314
315 Buffer & BufferView::buffer()
316 {
317         return buffer_;
318 }
319
320
321 Buffer const & BufferView::buffer() const
322 {
323         return buffer_;
324 }
325
326
327 bool BufferView::fitCursor()
328 {
329         if (cursorStatus(d->cursor_) == CUR_INSIDE) {
330                 frontend::FontMetrics const & fm =
331                         theFontMetrics(d->cursor_.getFont().fontInfo());
332                 int const asc = fm.maxAscent();
333                 int const des = fm.maxDescent();
334                 Point const p = getPos(d->cursor_, d->cursor_.boundary());
335                 if (p.y_ - asc >= 0 && p.y_ + des < height_)
336                         return false;
337         }
338         return true;
339 }
340
341
342 void BufferView::processUpdateFlags(Update::flags flags)
343 {
344         // last_inset_ points to the last visited inset. This pointer may become
345         // invalid because of keyboard editing. Since all such operations
346         // causes screen update(), I reset last_inset_ to avoid such a problem.
347         d->last_inset_ = 0;
348         // This is close to a hot-path.
349         LYXERR(Debug::DEBUG, "BufferView::processUpdateFlags()"
350                 << "[fitcursor = " << (flags & Update::FitCursor)
351                 << ", forceupdate = " << (flags & Update::Force)
352                 << ", singlepar = " << (flags & Update::SinglePar)
353                 << "]  buffer: " << &buffer_);
354
355         buffer_.updateMacros();
356
357         // Now do the first drawing step if needed. This consists on updating
358         // the CoordCache in updateMetrics().
359         // The second drawing step is done in WorkArea::redraw() if needed.
360
361         // Case when no explicit update is requested.
362         if (!flags) {
363                 // no need to redraw anything.
364                 d->update_strategy_ = NoScreenUpdate;
365                 return;
366         }
367
368         if (flags == Update::Decoration) {
369                 d->update_strategy_ = DecorationUpdate;
370                 buffer_.changed();
371                 return;
372         }
373
374         if (flags == Update::FitCursor
375                 || flags == (Update::Decoration | Update::FitCursor)) {
376                 // tell the frontend to update the screen if needed.
377                 if (fitCursor()) {
378                         showCursor();
379                         return;
380                 }
381                 if (flags & Update::Decoration) {
382                         d->update_strategy_ = DecorationUpdate;
383                         buffer_.changed();
384                         return;
385                 }
386                 // no screen update is needed.
387                 d->update_strategy_ = NoScreenUpdate;
388                 return;
389         }
390
391         bool const full_metrics = flags & Update::Force || !singleParUpdate();
392
393         if (full_metrics)
394                 // We have to update the full screen metrics.
395                 updateMetrics();
396
397         if (!(flags & Update::FitCursor)) {
398                 // Nothing to do anymore. Trigger a redraw and return
399                 buffer_.changed();
400                 return;
401         }
402
403         // updateMetrics() does not update paragraph position
404         // This is done at draw() time. So we need a redraw!
405         buffer_.changed();
406
407         if (fitCursor()) {
408                 // The cursor is off screen so ensure it is visible.
409                 // refresh it:
410                 showCursor();
411         }
412 }
413
414
415 void BufferView::updateScrollbar()
416 {
417         if (height_ == 0)
418                 return;
419
420         Text & t = buffer_.text();
421         TextMetrics & tm = d->text_metrics_[&t];                
422
423         LYXERR(Debug::GUI, " Updating scrollbar: height: "
424                 << t.paragraphs().size()
425                 << " curr par: " << d->cursor_.bottom().pit()
426                 << " default height " << defaultRowHeight());
427
428         int const parsize = int(t.paragraphs().size());
429         if (d->par_height_.size() != parsize) {
430                 d->par_height_.clear();
431                 // FIXME: We assume a default paragraph height of 2 rows. This
432                 // should probably be pondered with the screen width.
433                 d->par_height_.resize(parsize, defaultRowHeight() * 2);
434         }
435
436         // It would be better to fix the scrollbar to understand
437         // values in [0..1] and divide everything by wh
438
439         // Look at paragraph heights on-screen
440         pit_type first_visible_pit = -1;
441         pair<pit_type, ParagraphMetrics const *> first = tm.first();
442         pair<pit_type, ParagraphMetrics const *> last = tm.last();
443         for (pit_type pit = first.first; pit <= last.first; ++pit) {
444                 ParagraphMetrics const & pm = tm.parMetrics(pit);
445                 d->par_height_[pit] = pm.height();
446                 if (first_visible_pit >= 0 || pm.position() + pm.descent() <= 0)
447                         continue;
448                 first_visible_pit = pit;
449                 LYXERR(Debug::SCROLLING, "first visible pit " << first_visible_pit);
450                 // FIXME: we should look for the first visible row within
451                 // the deepest inset!
452                 int row_pos = pm.position();
453                 size_t const nrows = pm.rows().size();
454                 for (size_t i = 0; i != nrows; ++i) {
455                         Row const & row = pm.rows()[i];
456                         if (row_pos >= 0) {
457                                 LYXERR(Debug::SCROLLING, "first visible row " << i
458                                         << "(row pos = " << row_pos << ");");
459                                 break;
460                         }
461                         row_pos += row.height();
462                 }
463                 d->scrollbarParameters_.position = row_pos;
464         }
465
466         d->scrollbarParameters_.height = 0;
467         for (size_t i = 0; i != d->par_height_.size(); ++i) {
468                 if (i == first_visible_pit)
469                         d->scrollbarParameters_.position += d->scrollbarParameters_.height;
470                 d->scrollbarParameters_.height += d->par_height_[i];
471         }
472
473         // We prefer fixed size line scrolling.
474         d->scrollbarParameters_.lineScrollHeight = defaultRowHeight();
475 }
476
477
478 ScrollbarParameters const & BufferView::scrollbarParameters() const
479 {
480         return d->scrollbarParameters_;
481 }
482
483
484 docstring BufferView::toolTip(int x, int y) const
485 {
486         // Get inset under mouse, if there is one.
487         Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
488         if (!covering_inset)
489                 // No inset, no tooltip...
490                 return docstring();
491         return covering_inset->toolTip(*this, x, y);
492 }
493
494
495 docstring BufferView::contextMenu(int x, int y) const
496 {
497         // Get inset under mouse, if there is one.
498         Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
499         if (covering_inset)
500                 return covering_inset->contextMenu(*this, x, y);
501
502         // FIXME: Do something more elaborate here.
503         return from_ascii("edit");
504 }
505
506
507 void BufferView::scrollDocView(int value)
508 {
509         int const offset = value - d->scrollbarParameters_.position;
510         // If the offset is less than 2 screen height, prefer to scroll instead.
511         if (abs(offset) <= 2 * height_) {
512                 scroll(offset);
513                 return;
514         }
515
516         int par_pos = 0;
517         for (size_t i = 0; i != d->par_height_.size(); ++i) {
518                 par_pos += d->par_height_[i];
519                 if (par_pos >= value) {
520                         d->anchor_pit_ = pit_type(i);
521                         break;
522                 }
523         }
524
525         LYXERR(Debug::SCROLLING, "value = " << value
526                 << "\tanchor_ref_ = " << d->anchor_pit_
527                 << "\tpar_pos = " << par_pos);
528
529         d->anchor_ypos_ = par_pos - value;
530         updateMetrics();
531         buffer_.changed();
532 }
533
534
535 // FIXME: this method is not working well.
536 void BufferView::setCursorFromScrollbar()
537 {
538         TextMetrics & tm = d->text_metrics_[&buffer_.text()];
539
540         int const height = 2 * defaultRowHeight();
541         int const first = height;
542         int const last = height_ - height;
543         Cursor & cur = d->cursor_;
544
545         switch (cursorStatus(cur)) {
546         case CUR_ABOVE:
547                 // We reset the cursor because cursorStatus() does not
548                 // work when the cursor is within mathed.
549                 cur.reset(buffer_.inset());
550                 tm.setCursorFromCoordinates(cur, 0, first);
551                 cur.clearSelection();
552                 break;
553         case CUR_BELOW:
554                 // We reset the cursor because cursorStatus() does not
555                 // work when the cursor is within mathed.
556                 cur.reset(buffer_.inset());
557                 tm.setCursorFromCoordinates(cur, 0, last);
558                 cur.clearSelection();
559                 break;
560         case CUR_INSIDE:
561                 int const y = getPos(cur, cur.boundary()).y_;
562                 int const newy = min(last, max(y, first));
563                 if (y != newy) {
564                         cur.reset(buffer_.inset());
565                         tm.setCursorFromCoordinates(cur, 0, newy);
566                 }
567         }
568 }
569
570
571 Change const BufferView::getCurrentChange() const
572 {
573         if (!d->cursor_.selection())
574                 return Change(Change::UNCHANGED);
575
576         DocIterator dit = d->cursor_.selectionBegin();
577         return dit.paragraph().lookupChange(dit.pos());
578 }
579
580
581 // this could be used elsewhere as well?
582 // FIXME: This does not work within mathed!
583 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
584 {
585         Point const p = getPos(dit, dit.boundary());
586         if (p.y_ < 0)
587                 return CUR_ABOVE;
588         if (p.y_ > workHeight())
589                 return CUR_BELOW;
590         return CUR_INSIDE;
591 }
592
593
594 void BufferView::saveBookmark(unsigned int idx)
595 {
596         // tenatively save bookmark, id and pos will be used to
597         // acturately locate a bookmark in a 'live' lyx session.
598         // pit and pos will be updated with bottom level pit/pos
599         // when lyx exits.
600         LyX::ref().session().bookmarks().save(
601                 buffer_.fileName(),
602                 d->cursor_.bottom().pit(),
603                 d->cursor_.bottom().pos(),
604                 d->cursor_.paragraph().id(),
605                 d->cursor_.pos(),
606                 idx
607         );
608         if (idx)
609                 // emit message signal.
610                 message(_("Save bookmark"));
611 }
612
613
614 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
615         int top_id, pos_type top_pos)
616 {
617         bool success = false;
618         DocIterator doc_it;
619
620         d->cursor_.clearSelection();
621
622         // if a valid par_id is given, try it first
623         // This is the case for a 'live' bookmark when unique paragraph ID
624         // is used to track bookmarks.
625         if (top_id > 0) {
626                 ParIterator par = buffer_.getParFromID(top_id);
627                 if (par != buffer_.par_iterator_end()) {
628                         doc_it = makeDocIterator(par, min(par->size(), top_pos));
629                         // Some slices of the iterator may not be
630                         // reachable (e.g. closed collapsable inset)
631                         // so the dociterator may need to be
632                         // shortened. Otherwise, setCursor may crash
633                         // lyx when the cursor can not be set to these
634                         // insets.
635                         size_t const n = doc_it.depth();
636                         for (size_t i = 0; i < n; ++i)
637                                 if (doc_it[i].inset().editable() != Inset::HIGHLY_EDITABLE) {
638                                         doc_it.resize(i);
639                                         break;
640                                 }
641                         success = true;
642                 }
643         }
644
645         // if top_id == 0, or searching through top_id failed
646         // This is the case for a 'restored' bookmark when only bottom
647         // (document level) pit was saved. Because of this, bookmark
648         // restoration is inaccurate. If a bookmark was within an inset,
649         // it will be restored to the left of the outmost inset that contains
650         // the bookmark.
651         if (static_cast<size_t>(bottom_pit) < buffer_.paragraphs().size()) {
652                 doc_it = doc_iterator_begin(buffer_.inset());
653                 doc_it.pit() = bottom_pit;
654                 doc_it.pos() = min(bottom_pos, doc_it.paragraph().size());
655                 success = true;
656         }
657
658         if (success) {
659                 // Note: only bottom (document) level pit is set.
660                 setCursor(doc_it);
661                 // set the current font.
662                 d->cursor_.setCurrentFont();
663                 // To center the screen on this new position we need the
664                 // paragraph position which is computed at draw() time.
665                 // So we need a redraw!
666                 buffer_.changed();
667                 if (fitCursor())
668                         showCursor();
669         }
670
671         return success;
672 }
673
674
675 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
676 {
677         if (lyxrc.rtl_support) {
678                 if (d->cursor_.real_current_font.isRightToLeft()) {
679                         if (d->intl_.keymap == Intl::PRIMARY)
680                                 d->intl_.keyMapSec();
681                 } else {
682                         if (d->intl_.keymap == Intl::SECONDARY)
683                                 d->intl_.keyMapPrim();
684                 }
685         }
686
687         d->intl_.getTransManager().translateAndInsert(c, t, cur);
688 }
689
690
691 int BufferView::workWidth() const
692 {
693         return width_;
694 }
695
696
697 void BufferView::showCursor()
698 {
699         // We are not properly started yet, delay until resizing is
700         // done.
701         if (height_ == 0)
702                 return;
703
704         LYXERR(Debug::SCROLLING, "recentering!");
705
706         CursorSlice & bot = d->cursor_.bottom();
707         TextMetrics & tm = d->text_metrics_[bot.text()];
708
709         pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
710         int bot_pit = d->cursor_.bottom().pit();
711         if (bot_pit > max_pit) {
712                 // FIXME: Why does this happen?
713                 LYXERR0("bottom pit is greater that max pit: "
714                         << bot_pit << " > " << max_pit);
715                 bot_pit = max_pit;
716         }
717
718         if (bot_pit == tm.first().first - 1)
719                 tm.newParMetricsUp();
720         else if (bot_pit == tm.last().first + 1)
721                 tm.newParMetricsDown();
722
723         if (tm.has(bot_pit)) {
724                 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
725                 int offset = coordOffset(d->cursor_, d->cursor_.boundary()).y_;
726                 int ypos = pm.position() + offset;
727                 Dimension const & row_dim = d->cursor_.textRow().dimension();
728                 if (ypos - row_dim.ascent() < 0)
729                         scrollUp(- ypos + row_dim.ascent());
730                 else if (ypos + row_dim.descent() > height_)
731                         scrollDown(ypos - height_ + row_dim.descent());
732                 // else, nothing to do, the cursor is already visible so we just return.
733                 return;
734         }
735
736         tm.redoParagraph(bot_pit);
737         ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
738         int offset = coordOffset(d->cursor_, d->cursor_.boundary()).y_;
739
740         d->anchor_pit_ = bot_pit;
741         Dimension const & row_dim = d->cursor_.textRow().dimension();
742
743         if (d->anchor_pit_ == 0)
744                 d->anchor_ypos_ = offset + pm.ascent();
745         else if (d->anchor_pit_ == max_pit)
746                 d->anchor_ypos_ = height_ - offset - row_dim.descent();
747         else
748                 d->anchor_ypos_ = defaultRowHeight() * 2 - offset - row_dim.descent();
749
750         updateMetrics();
751         buffer_.changed();
752 }
753
754
755 FuncStatus BufferView::getStatus(FuncRequest const & cmd)
756 {
757         FuncStatus flag;
758
759         Cursor & cur = d->cursor_;
760
761         switch (cmd.action) {
762
763         case LFUN_UNDO:
764                 flag.enabled(buffer_.undo().hasUndoStack());
765                 break;
766         case LFUN_REDO:
767                 flag.enabled(buffer_.undo().hasRedoStack());
768                 break;
769         case LFUN_FILE_INSERT:
770         case LFUN_FILE_INSERT_PLAINTEXT_PARA:
771         case LFUN_FILE_INSERT_PLAINTEXT:
772         case LFUN_BOOKMARK_SAVE:
773                 // FIXME: Actually, these LFUNS should be moved to Text
774                 flag.enabled(cur.inTexted());
775                 break;
776         case LFUN_FONT_STATE:
777         case LFUN_LABEL_INSERT:
778         case LFUN_INFO_INSERT:
779         case LFUN_PARAGRAPH_GOTO:
780         case LFUN_NOTE_NEXT:
781         case LFUN_REFERENCE_NEXT:
782         case LFUN_WORD_FIND:
783         case LFUN_WORD_REPLACE:
784         case LFUN_MARK_OFF:
785         case LFUN_MARK_ON:
786         case LFUN_MARK_TOGGLE:
787         case LFUN_SCREEN_RECENTER:
788         case LFUN_BIBTEX_DATABASE_ADD:
789         case LFUN_BIBTEX_DATABASE_DEL:
790         case LFUN_STATISTICS:
791         case LFUN_NEXT_INSET_TOGGLE:
792                 flag.enabled(true);
793                 break;
794
795         case LFUN_LABEL_GOTO: {
796                 flag.enabled(!cmd.argument().empty()
797                     || getInsetByCode<InsetRef>(cur, REF_CODE));
798                 break;
799         }
800
801         case LFUN_CHANGES_TRACK:
802                 flag.enabled(true);
803                 flag.setOnOff(buffer_.params().trackChanges);
804                 break;
805
806         case LFUN_CHANGES_OUTPUT:
807                 flag.enabled(true);
808                 flag.setOnOff(buffer_.params().outputChanges);
809                 break;
810
811         case LFUN_CHANGES_MERGE:
812         case LFUN_CHANGE_NEXT:
813         case LFUN_ALL_CHANGES_ACCEPT:
814         case LFUN_ALL_CHANGES_REJECT:
815                 // TODO: context-sensitive enabling of LFUNs
816                 // In principle, these command should only be enabled if there
817                 // is a change in the document. However, without proper
818                 // optimizations, this will inevitably result in poor performance.
819                 flag.enabled(true);
820                 break;
821
822         case LFUN_BUFFER_TOGGLE_COMPRESSION: {
823                 flag.setOnOff(buffer_.params().compressed);
824                 break;
825         }
826         
827         case LFUN_BUFFER_TOGGLE_EMBEDDING: {
828                 flag.setOnOff(buffer_.params().embedded);
829                 break;
830         }
831
832         case LFUN_SCREEN_UP:
833         case LFUN_SCREEN_DOWN:
834         case LFUN_SCROLL:
835                 flag.enabled(true);
836                 break;
837
838         // FIXME: LFUN_SCREEN_DOWN_SELECT should be removed from
839         // everywhere else before this can enabled:
840         case LFUN_SCREEN_UP_SELECT:
841         case LFUN_SCREEN_DOWN_SELECT:
842                 flag.enabled(false);
843                 break;
844
845         case LFUN_LAYOUT_TABULAR:
846                 flag.enabled(cur.innerInsetOfType(TABULAR_CODE));
847                 break;
848
849         case LFUN_LAYOUT:
850         case LFUN_LAYOUT_PARAGRAPH:
851                 flag.enabled(cur.inset().forceDefaultParagraphs(cur.idx()));
852                 break;
853
854         case LFUN_INSET_SETTINGS: {
855                 InsetCode code = cur.inset().lyxCode();
856                 bool enable = false;
857                 switch (code) {
858                         case TABULAR_CODE:
859                                 enable = cmd.argument() == "tabular";
860                                 break;
861                         case ERT_CODE:
862                                 enable = cmd.argument() == "ert";
863                                 break;
864                         case FLOAT_CODE:
865                                 enable = cmd.argument() == "float";
866                                 break;
867                         case WRAP_CODE:
868                                 enable = cmd.argument() == "wrap";
869                                 break;
870                         case NOTE_CODE:
871                                 enable = cmd.argument() == "note";
872                                 break;
873                         case BRANCH_CODE:
874                                 enable = cmd.argument() == "branch";
875                                 break;
876                         case BOX_CODE:
877                                 enable = cmd.argument() == "box";
878                                 break;
879                         case LISTINGS_CODE:
880                                 enable = cmd.argument() == "listings";
881                                 break;
882                         default:
883                                 break;
884                 }
885                 flag.enabled(enable);
886                 break;
887         }
888
889         case LFUN_DIALOG_SHOW_NEW_INSET:
890                 flag.enabled(cur.inset().lyxCode() != ERT_CODE &&
891                         cur.inset().lyxCode() != LISTINGS_CODE);
892                 if (cur.inset().lyxCode() == CAPTION_CODE) {
893                         FuncStatus flag;
894                         if (cur.inset().getStatus(cur, cmd, flag))
895                                 return flag;
896                 }
897                 break;
898
899         default:
900                 flag.enabled(false);
901         }
902
903         return flag;
904 }
905
906
907 bool BufferView::dispatch(FuncRequest const & cmd)
908 {
909         //lyxerr << [ cmd = " << cmd << "]" << endl;
910
911         // Make sure that the cached BufferView is correct.
912         LYXERR(Debug::ACTION, " action[" << cmd.action << ']'
913                 << " arg[" << to_utf8(cmd.argument()) << ']'
914                 << " x[" << cmd.x << ']'
915                 << " y[" << cmd.y << ']'
916                 << " button[" << cmd.button() << ']');
917
918         Cursor & cur = d->cursor_;
919
920         switch (cmd.action) {
921
922         case LFUN_UNDO:
923                 cur.message(_("Undo"));
924                 cur.clearSelection();
925                 if (!cur.textUndo())
926                         cur.message(_("No further undo information"));
927                 else
928                         processUpdateFlags(Update::Force | Update::FitCursor);
929                 break;
930
931         case LFUN_REDO:
932                 cur.message(_("Redo"));
933                 cur.clearSelection();
934                 if (!cur.textRedo())
935                         cur.message(_("No further redo information"));
936                 else
937                         processUpdateFlags(Update::Force | Update::FitCursor);
938                 break;
939
940         case LFUN_FONT_STATE:
941                 cur.message(cur.currentState());
942                 break;
943
944         case LFUN_BOOKMARK_SAVE:
945                 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
946                 break;
947
948         case LFUN_LABEL_GOTO: {
949                 docstring label = cmd.argument();
950                 if (label.empty()) {
951                         InsetRef * inset =
952                                 getInsetByCode<InsetRef>(d->cursor_,
953                                                          REF_CODE);
954                         if (inset) {
955                                 label = inset->getParam("reference");
956                                 // persistent=false: use temp_bookmark
957                                 saveBookmark(0);
958                         }
959                 }
960
961                 if (!label.empty())
962                         gotoLabel(label);
963                 break;
964         }
965
966         case LFUN_PARAGRAPH_GOTO: {
967                 int const id = convert<int>(to_utf8(cmd.argument()));
968                 int i = 0;
969                 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
970                         b = theBufferList().next(b)) {
971
972                         ParIterator par = b->getParFromID(id);
973                         if (par == b->par_iterator_end()) {
974                                 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
975                         } else {
976                                 LYXERR(Debug::INFO, "Paragraph " << par->id()
977                                         << " found in buffer `"
978                                         << b->absFileName() << "'.");
979
980                                 if (b == &buffer_) {
981                                         // Set the cursor
982                                         setCursor(makeDocIterator(par, 0));
983                                         showCursor();
984                                 } else {
985                                         // Switch to other buffer view and resend cmd
986                                         theLyXFunc().dispatch(FuncRequest(
987                                                 LFUN_BUFFER_SWITCH, b->absFileName()));
988                                         theLyXFunc().dispatch(cmd);
989                                 }
990                                 break;
991                         }
992                         ++i;
993                 }
994                 break;
995         }
996
997         case LFUN_NOTE_NEXT:
998                 gotoInset(this, NOTE_CODE, false);
999                 break;
1000
1001         case LFUN_REFERENCE_NEXT: {
1002                 vector<InsetCode> tmp;
1003                 tmp.push_back(LABEL_CODE);
1004                 tmp.push_back(REF_CODE);
1005                 gotoInset(this, tmp, true);
1006                 break;
1007         }
1008
1009         case LFUN_CHANGES_TRACK:
1010                 buffer_.params().trackChanges = !buffer_.params().trackChanges;
1011                 break;
1012
1013         case LFUN_CHANGES_OUTPUT:
1014                 buffer_.params().outputChanges = !buffer_.params().outputChanges;
1015                 if (buffer_.params().outputChanges) {
1016                         bool dvipost    = LaTeXFeatures::isAvailable("dvipost");
1017                         bool xcolorsoul = LaTeXFeatures::isAvailable("soul") &&
1018                                           LaTeXFeatures::isAvailable("xcolor");
1019
1020                         if (!dvipost && !xcolorsoul) {
1021                                 Alert::warning(_("Changes not shown in LaTeX output"),
1022                                                _("Changes will not be highlighted in LaTeX output, "
1023                                                  "because neither dvipost nor xcolor/soul are installed.\n"
1024                                                  "Please install these packages or redefine "
1025                                                  "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1026                         } else if (!xcolorsoul) {
1027                                 Alert::warning(_("Changes not shown in LaTeX output"),
1028                                                _("Changes will not be highlighted in LaTeX output "
1029                                                  "when using pdflatex, because xcolor and soul are not installed.\n"
1030                                                  "Please install both packages or redefine "
1031                                                  "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1032                         }
1033                 }
1034                 break;
1035
1036         case LFUN_CHANGE_NEXT:
1037                 findNextChange(this);
1038                 break;
1039
1040         case LFUN_CHANGES_MERGE:
1041                 if (findNextChange(this))
1042                         showDialog("changes");
1043                 break;
1044
1045         case LFUN_ALL_CHANGES_ACCEPT:
1046                 // select complete document
1047                 d->cursor_.reset(buffer_.inset());
1048                 d->cursor_.selHandle(true);
1049                 buffer_.text().cursorBottom(d->cursor_);
1050                 // accept everything in a single step to support atomic undo
1051                 buffer_.text().acceptOrRejectChanges(d->cursor_, Text::ACCEPT);
1052                 break;
1053
1054         case LFUN_ALL_CHANGES_REJECT:
1055                 // select complete document
1056                 d->cursor_.reset(buffer_.inset());
1057                 d->cursor_.selHandle(true);
1058                 buffer_.text().cursorBottom(d->cursor_);
1059                 // reject everything in a single step to support atomic undo
1060                 // Note: reject does not work recursively; the user may have to repeat the operation
1061                 buffer_.text().acceptOrRejectChanges(d->cursor_, Text::REJECT);
1062                 break;
1063
1064         case LFUN_WORD_FIND:
1065                 find(this, cmd);
1066                 break;
1067
1068         case LFUN_WORD_REPLACE: {
1069                 bool has_deleted = false;
1070                 if (cur.selection()) {
1071                         DocIterator beg = cur.selectionBegin();
1072                         DocIterator end = cur.selectionEnd();
1073                         if (beg.pit() == end.pit()) {
1074                                 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1075                                         if (cur.paragraph().isDeleted(p))
1076                                                 has_deleted = true;
1077                                 }
1078                         }
1079                 }
1080                 replace(this, cmd, has_deleted);
1081                 break;
1082         }
1083
1084         case LFUN_MARK_OFF:
1085                 cur.clearSelection();
1086                 cur.resetAnchor();
1087                 cur.message(from_utf8(N_("Mark off")));
1088                 break;
1089
1090         case LFUN_MARK_ON:
1091                 cur.clearSelection();
1092                 cur.mark() = true;
1093                 cur.resetAnchor();
1094                 cur.message(from_utf8(N_("Mark on")));
1095                 break;
1096
1097         case LFUN_MARK_TOGGLE:
1098                 cur.clearSelection();
1099                 if (cur.mark()) {
1100                         cur.mark() = false;
1101                         cur.message(from_utf8(N_("Mark removed")));
1102                 } else {
1103                         cur.mark() = true;
1104                         cur.message(from_utf8(N_("Mark set")));
1105                 }
1106                 cur.resetAnchor();
1107                 break;
1108
1109         case LFUN_SCREEN_RECENTER:
1110                 showCursor();
1111                 break;
1112
1113         case LFUN_BIBTEX_DATABASE_ADD: {
1114                 Cursor tmpcur = d->cursor_;
1115                 findInset(tmpcur, BIBTEX_CODE, false);
1116                 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1117                                                 BIBTEX_CODE);
1118                 if (inset) {
1119                         if (inset->addDatabase(to_utf8(cmd.argument())))
1120                                 buffer_.updateBibfilesCache();
1121                 }
1122                 break;
1123         }
1124
1125         case LFUN_BIBTEX_DATABASE_DEL: {
1126                 Cursor tmpcur = d->cursor_;
1127                 findInset(tmpcur, BIBTEX_CODE, false);
1128                 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1129                                                 BIBTEX_CODE);
1130                 if (inset) {
1131                         if (inset->delDatabase(to_utf8(cmd.argument())))
1132                                 buffer_.updateBibfilesCache();
1133                 }
1134                 break;
1135         }
1136
1137         case LFUN_STATISTICS: {
1138                 DocIterator from, to;
1139                 if (cur.selection()) {
1140                         from = cur.selectionBegin();
1141                         to = cur.selectionEnd();
1142                 } else {
1143                         from = doc_iterator_begin(buffer_.inset());
1144                         to = doc_iterator_end(buffer_.inset());
1145                 }
1146                 int const words = countWords(from, to);
1147                 int const chars = countChars(from, to, false);
1148                 int const chars_blanks = countChars(from, to, true);
1149                 docstring message;
1150                 if (cur.selection())
1151                         message = _("Statistics for the selection:\n");
1152                 else
1153                         message = _("Statistics for the document:\n");
1154                 if (words != 1)
1155                         message += bformat(_("\n%1$d words"), words);
1156                 else
1157                         message += _("\nOne word");
1158                 if (chars_blanks != 1)
1159                         message += bformat(_("\n%1$d characters (including blanks)"),
1160                                           chars_blanks);
1161                 else
1162                         message += _("\nOne character (including blanks)");
1163                 if (chars != 1)
1164                         message += bformat(_("\n%1$d characters (excluding blanks)"),
1165                                           chars);
1166                 else
1167                         message += _("\nOne character (excluding blanks)");
1168
1169                 Alert::information(_("Statistics"), message);
1170         }
1171                 break;
1172
1173         case LFUN_BUFFER_TOGGLE_COMPRESSION:
1174                 // turn compression on/off
1175                 buffer_.params().compressed = !buffer_.params().compressed;
1176                 break;
1177         
1178         case LFUN_BUFFER_TOGGLE_EMBEDDING: {
1179                 // turn embedding on/off
1180                 try {
1181                         buffer_.embeddedFiles().enable(!buffer_.params().embedded, buffer_);
1182                 } catch (ExceptionMessage const & message) {
1183                         Alert::error(message.title_, message.details_);
1184                 }
1185                 break;
1186         }
1187
1188         case LFUN_NEXT_INSET_TOGGLE: {
1189                 // this is the real function we want to invoke
1190                 FuncRequest tmpcmd = FuncRequest(LFUN_INSET_TOGGLE, cmd.origin);
1191                 // if there is an inset at cursor, see whether it
1192                 // wants to toggle.
1193                 Inset * inset = cur.nextInset();
1194                 if (inset) {
1195                         if (inset->isActive()) {
1196                                 Cursor tmpcur = cur;
1197                                 tmpcur.pushBackward(*inset);
1198                                 inset->dispatch(tmpcur, tmpcmd);
1199                                 if (tmpcur.result().dispatched()) {
1200                                         cur.dispatched();
1201                                 }
1202                         } else if (inset->editable() == Inset::IS_EDITABLE) {
1203                                 inset->edit(cur, true);
1204                         }
1205                 }
1206                 // if it did not work, try the underlying inset.
1207                 if (!cur.result().dispatched())
1208                         cur.dispatch(tmpcmd);
1209
1210                 if (!cur.result().dispatched())
1211                         // It did not work too; no action needed.
1212                         break;
1213                 cur.clearSelection();
1214                 processUpdateFlags(Update::SinglePar | Update::FitCursor);
1215                 break;
1216         }
1217
1218         case LFUN_SCREEN_UP:
1219         case LFUN_SCREEN_DOWN: {
1220                 Point p = getPos(cur, cur.boundary());
1221                 if (p.y_ < 0 || p.y_ > height_) {
1222                         // The cursor is off-screen so recenter before proceeding.
1223                         showCursor();
1224                         p = getPos(cur, cur.boundary());
1225                 }
1226                 scroll(cmd.action == LFUN_SCREEN_UP? - height_ : height_);
1227                 cur.reset(buffer_.inset());
1228                 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_);
1229                 //FIXME: what to do with cur.x_target()?
1230                 cur.finishUndo();
1231                 break;
1232         }
1233
1234         case LFUN_SCROLL:
1235                 lfunScroll(cmd);
1236                 break;
1237
1238         case LFUN_SCREEN_UP_SELECT:
1239         case LFUN_SCREEN_DOWN_SELECT: {
1240                 // Those two are not ready yet for consumption.
1241                 return false;
1242
1243                 cur.selHandle(true);
1244                 size_t initial_depth = cur.depth();
1245                 Point const p = getPos(cur, cur.boundary());
1246                 scroll(cmd.action == LFUN_SCREEN_UP_SELECT? - height_ : height_);
1247                 // FIXME: We need to verify if the cursor stayed within an inset...
1248                 //cur.reset(buffer_.inset());
1249                 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_);
1250                 cur.finishUndo();
1251                 while (cur.depth() > initial_depth) {
1252                         cur.forwardInset();
1253                 }
1254                 // FIXME: we need to do a redraw again because of the selection
1255                 // But no screen update is needed.
1256                 d->update_strategy_ = NoScreenUpdate;
1257                 buffer_.changed();
1258                 break;
1259         }
1260
1261         default:
1262                 return false;
1263         }
1264
1265         return true;
1266 }
1267
1268
1269 docstring const BufferView::requestSelection()
1270 {
1271         Cursor & cur = d->cursor_;
1272
1273         if (!cur.selection()) {
1274                 d->xsel_cache_.set = false;
1275                 return docstring();
1276         }
1277
1278         if (!d->xsel_cache_.set ||
1279             cur.top() != d->xsel_cache_.cursor ||
1280             cur.anchor_.top() != d->xsel_cache_.anchor)
1281         {
1282                 d->xsel_cache_.cursor = cur.top();
1283                 d->xsel_cache_.anchor = cur.anchor_.top();
1284                 d->xsel_cache_.set = cur.selection();
1285                 return cur.selectionAsString(false);
1286         }
1287         return docstring();
1288 }
1289
1290
1291 void BufferView::clearSelection()
1292 {
1293         d->cursor_.clearSelection();
1294         // Clear the selection buffer. Otherwise a subsequent
1295         // middle-mouse-button paste would use the selection buffer,
1296         // not the more current external selection.
1297         cap::clearSelection();
1298         d->xsel_cache_.set = false;
1299         // The buffer did not really change, but this causes the
1300         // redraw we need because we cleared the selection above.
1301         buffer_.changed();
1302 }
1303
1304
1305 void BufferView::resize(int width, int height)
1306 {
1307         // Update from work area
1308         width_ = width;
1309         height_ = height;
1310
1311         // Clear the paragraph height cache.
1312         d->par_height_.clear();
1313
1314         updateMetrics();
1315 }
1316
1317
1318 Inset const * BufferView::getCoveringInset(Text const & text,
1319                 int x, int y) const
1320 {
1321         TextMetrics & tm = d->text_metrics_[&text];
1322         Inset * inset = tm.checkInsetHit(x, y);
1323         if (!inset)
1324                 return 0;
1325
1326         if (!inset->descendable())
1327                 // No need to go further down if the inset is not
1328                 // descendable.
1329                 return inset;
1330
1331         size_t cell_number = inset->nargs();
1332         // Check all the inner cell.
1333         for (size_t i = 0; i != cell_number; ++i) {
1334                 Text const * inner_text = inset->getText(i);
1335                 if (inner_text) {
1336                         // Try deeper.
1337                         Inset const * inset_deeper =
1338                                 getCoveringInset(*inner_text, x, y);
1339                         if (inset_deeper)
1340                                 return inset_deeper;
1341                 }
1342         }
1343
1344         return inset;
1345 }
1346
1347
1348 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
1349 {
1350         //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
1351
1352         // This is only called for mouse related events including
1353         // LFUN_FILE_OPEN generated by drag-and-drop.
1354         FuncRequest cmd = cmd0;
1355
1356         Cursor cur(*this);
1357         cur.push(buffer_.inset());
1358         cur.selection() = d->cursor_.selection();
1359
1360         // Either the inset under the cursor or the
1361         // surrounding Text will handle this event.
1362
1363         // make sure we stay within the screen...
1364         cmd.y = min(max(cmd.y, -1), height_);
1365
1366         if (cmd.action == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
1367
1368                 // Get inset under mouse, if there is one.
1369                 Inset const * covering_inset =
1370                         getCoveringInset(buffer_.text(), cmd.x, cmd.y);
1371                 if (covering_inset == d->last_inset_)
1372                         // Same inset, no need to do anything...
1373                         return;
1374
1375                 bool need_redraw = false;
1376                 // const_cast because of setMouseHover().
1377                 Inset * inset = const_cast<Inset *>(covering_inset);
1378                 if (d->last_inset_)
1379                         // Remove the hint on the last hovered inset (if any).
1380                         need_redraw |= d->last_inset_->setMouseHover(false);
1381                 if (inset)
1382                         // Highlighted the newly hovered inset (if any).
1383                         need_redraw |= inset->setMouseHover(true);
1384                 d->last_inset_ = inset;
1385                 if (!need_redraw)
1386                         return;
1387
1388                 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
1389                         << cmd.x << ", " << cmd.y << ")");
1390
1391                 d->update_strategy_ = DecorationUpdate;
1392
1393                 // This event (moving without mouse click) is not passed further.
1394                 // This should be changed if it is further utilized.
1395                 buffer_.changed();
1396                 return;
1397         }
1398
1399         // Build temporary cursor.
1400         Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x, cmd.y);
1401
1402         // Put anchor at the same position.
1403         cur.resetAnchor();
1404
1405         // Try to dispatch to an non-editable inset near this position
1406         // via the temp cursor. If the inset wishes to change the real
1407         // cursor it has to do so explicitly by using
1408         //  cur.bv().cursor() = cur;  (or similar)
1409         if (inset)
1410                 inset->dispatch(cur, cmd);
1411
1412         // Now dispatch to the temporary cursor. If the real cursor should
1413         // be modified, the inset's dispatch has to do so explicitly.
1414         if (!cur.result().dispatched())
1415                 cur.dispatch(cmd);
1416
1417         //Do we have a selection?
1418         theSelection().haveSelection(cursor().selection());
1419
1420         // If the command has been dispatched,
1421         if (cur.result().dispatched()
1422                 // an update is asked,
1423                 && cur.result().update())
1424                 processUpdateFlags(cur.result().update());
1425 }
1426
1427
1428 void BufferView::lfunScroll(FuncRequest const & cmd)
1429 {
1430         string const scroll_type = cmd.getArg(0);
1431         int const scroll_step = 
1432                 (scroll_type == "line")? d->scrollbarParameters_.lineScrollHeight
1433                 : (scroll_type == "page")? height_ : 0;
1434         if (scroll_step == 0)
1435                 return;
1436         string const scroll_quantity = cmd.getArg(1);
1437         if (scroll_quantity == "up")
1438                 scrollUp(scroll_step);
1439         else if (scroll_quantity == "down")
1440                 scrollDown(scroll_step);
1441         else {
1442                 int const scroll_value = convert<int>(scroll_quantity);
1443                 if (scroll_value)
1444                         scroll(scroll_step * scroll_value);
1445         }
1446 }
1447
1448
1449 void BufferView::scroll(int y)
1450 {
1451         if (y > 0)
1452                 scrollDown(y);
1453         else if (y < 0)
1454                 scrollUp(-y);
1455 }
1456
1457
1458 void BufferView::scrollDown(int offset)
1459 {
1460         Text * text = &buffer_.text();
1461         TextMetrics & tm = d->text_metrics_[text];
1462         int ymax = height_ + offset;
1463         while (true) {
1464                 pair<pit_type, ParagraphMetrics const *> last = tm.last();
1465                 int bottom_pos = last.second->position() + last.second->descent();
1466                 if (last.first + 1 == int(text->paragraphs().size())) {
1467                         if (bottom_pos <= height_)
1468                                 return;
1469                         offset = min(offset, bottom_pos - height_);
1470                         break;
1471                 }
1472                 if (bottom_pos > ymax)
1473                         break;
1474                 tm.newParMetricsDown();
1475         }
1476         d->anchor_ypos_ -= offset;
1477         updateMetrics();
1478         buffer_.changed();
1479 }
1480
1481
1482 void BufferView::scrollUp(int offset)
1483 {
1484         Text * text = &buffer_.text();
1485         TextMetrics & tm = d->text_metrics_[text];
1486         int ymin = - offset;
1487         while (true) {
1488                 pair<pit_type, ParagraphMetrics const *> first = tm.first();
1489                 int top_pos = first.second->position() - first.second->ascent();
1490                 if (first.first == 0) {
1491                         if (top_pos >= 0)
1492                                 return;
1493                         offset = min(offset, - top_pos);
1494                         break;
1495                 }
1496                 if (top_pos < ymin)
1497                         break;
1498                 tm.newParMetricsUp();
1499         }
1500         d->anchor_ypos_ += offset;
1501         updateMetrics();
1502         buffer_.changed();
1503 }
1504
1505
1506 void BufferView::setCursorFromRow(int row)
1507 {
1508         int tmpid = -1;
1509         int tmppos = -1;
1510
1511         buffer_.texrow().getIdFromRow(row, tmpid, tmppos);
1512
1513         d->cursor_.reset(buffer_.inset());
1514         if (tmpid == -1)
1515                 buffer_.text().setCursor(d->cursor_, 0, 0);
1516         else
1517                 buffer_.text().setCursor(d->cursor_, buffer_.getParFromID(tmpid).pit(), tmppos);
1518 }
1519
1520
1521 void BufferView::gotoLabel(docstring const & label)
1522 {
1523         for (InsetIterator it = inset_iterator_begin(buffer_.inset()); it; ++it) {
1524                 vector<docstring> labels;
1525                 it->getLabelList(buffer_, labels);
1526                 if (find(labels.begin(), labels.end(), label) != labels.end()) {
1527                         setCursor(it);
1528                         showCursor();
1529                         return;
1530                 }
1531         }
1532 }
1533
1534
1535 TextMetrics const & BufferView::textMetrics(Text const * t) const
1536 {
1537         return const_cast<BufferView *>(this)->textMetrics(t);
1538 }
1539
1540
1541 TextMetrics & BufferView::textMetrics(Text const * t)
1542 {
1543         TextMetricsCache::iterator tmc_it  = d->text_metrics_.find(t);
1544         if (tmc_it == d->text_metrics_.end()) {
1545                 tmc_it = d->text_metrics_.insert(
1546                         make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
1547         }
1548         return tmc_it->second;
1549 }
1550
1551
1552 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
1553                 pit_type pit) const
1554 {
1555         return textMetrics(t).parMetrics(pit);
1556 }
1557
1558
1559 int BufferView::workHeight() const
1560 {
1561         return height_;
1562 }
1563
1564
1565 void BufferView::setCursor(DocIterator const & dit)
1566 {
1567         size_t const n = dit.depth();
1568         for (size_t i = 0; i < n; ++i)
1569                 dit[i].inset().edit(d->cursor_, true);
1570
1571         d->cursor_.setCursor(dit);
1572         d->cursor_.selection() = false;
1573 }
1574
1575
1576 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
1577 {
1578         // Would be wrong to delete anything if we have a selection.
1579         if (cur.selection())
1580                 return false;
1581
1582         bool need_anchor_change = false;
1583         bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
1584                 need_anchor_change);
1585
1586         if (need_anchor_change)
1587                 cur.resetAnchor();
1588
1589         if (!changed)
1590                 return false;
1591
1592         d->cursor_ = cur;
1593
1594         updateLabels(buffer_);
1595
1596         updateMetrics();
1597         buffer_.changed();
1598         return true;
1599 }
1600
1601
1602 bool BufferView::mouseSetCursor(Cursor & cur, bool select)
1603 {
1604         BOOST_ASSERT(&cur.bv() == this);
1605
1606         if (!select)
1607                 // this event will clear selection so we save selection for
1608                 // persistent selection
1609                 cap::saveSelection(cursor());
1610
1611         // Has the cursor just left the inset?
1612         bool badcursor = false;
1613         bool leftinset = (&d->cursor_.inset() != &cur.inset());
1614         if (leftinset)
1615                 badcursor = notifyCursorLeaves(d->cursor_, cur);
1616
1617         // FIXME: shift-mouse selection doesn't work well across insets.
1618         bool do_selection = select && &d->cursor_.anchor().inset() == &cur.inset();
1619
1620         // do the dEPM magic if needed
1621         // FIXME: (1) move this to InsetText::notifyCursorLeaves?
1622         // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
1623         // the leftinset bool would not be necessary (badcursor instead).
1624         bool update = leftinset;
1625         if (!do_selection && !badcursor && d->cursor_.inTexted())
1626                 update |= checkDepm(cur, d->cursor_);
1627
1628         // if the cursor was in an empty script inset and the new
1629         // position is in the nucleus of the inset, notifyCursorLeaves
1630         // will kill the script inset itself. So we check all the
1631         // elements of the cursor to make sure that they are correct.
1632         // For an example, see bug 2933:
1633         // http://bugzilla.lyx.org/show_bug.cgi?id=2933
1634         // The code below could maybe be moved to a DocIterator method.
1635         //lyxerr << "cur before " << cur <<endl;
1636         DocIterator dit(cur.inset());
1637         dit.push_back(cur.bottom());
1638         size_t i = 1;
1639         while (i < cur.depth() && dit.nextInset() == &cur[i].inset()) {
1640                 dit.push_back(cur[i]);
1641                 ++i;
1642         }
1643         //lyxerr << "5 cur after" << dit <<endl;
1644
1645         d->cursor_.setCursor(dit);
1646         d->cursor_.boundary(cur.boundary());
1647         if (do_selection)
1648                 d->cursor_.setSelection();
1649         else
1650                 d->cursor_.clearSelection();
1651
1652         d->cursor_.finishUndo();
1653         d->cursor_.setCurrentFont();
1654         return update;
1655 }
1656
1657
1658 void BufferView::putSelectionAt(DocIterator const & cur,
1659                                 int length, bool backwards)
1660 {
1661         d->cursor_.clearSelection();
1662
1663         setCursor(cur);
1664
1665         if (length) {
1666                 if (backwards) {
1667                         d->cursor_.pos() += length;
1668                         d->cursor_.setSelection(d->cursor_, -length);
1669                 } else
1670                         d->cursor_.setSelection(d->cursor_, length);
1671         }
1672 }
1673
1674
1675 Cursor & BufferView::cursor()
1676 {
1677         return d->cursor_;
1678 }
1679
1680
1681 Cursor const & BufferView::cursor() const
1682 {
1683         return d->cursor_;
1684 }
1685
1686
1687 pit_type BufferView::anchor_ref() const
1688 {
1689         return d->anchor_pit_;
1690 }
1691
1692
1693 bool BufferView::singleParUpdate()
1694 {
1695         Text & buftext = buffer_.text();
1696         pit_type const bottom_pit = d->cursor_.bottom().pit();
1697         TextMetrics & tm = textMetrics(&buftext);
1698         int old_height = tm.parMetrics(bottom_pit).height();
1699
1700         // In Single Paragraph mode, rebreak only
1701         // the (main text, not inset!) paragraph containing the cursor.
1702         // (if this paragraph contains insets etc., rebreaking will
1703         // recursively descend)
1704         tm.redoParagraph(bottom_pit);
1705         ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);                
1706         if (pm.height() != old_height)
1707                 // Paragraph height has changed so we cannot proceed to
1708                 // the singlePar optimisation.
1709                 return false;
1710
1711         d->update_strategy_ = SingleParUpdate;
1712
1713         LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
1714                 << " y2: " << pm.position() + pm.descent()
1715                 << " pit: " << bottom_pit
1716                 << " singlepar: 1");
1717         return true;
1718 }
1719
1720
1721 void BufferView::updateMetrics()
1722 {
1723         Text & buftext = buffer_.text();
1724         pit_type const npit = int(buftext.paragraphs().size());
1725
1726         // Clear out the position cache in case of full screen redraw,
1727         d->coord_cache_.clear();
1728
1729         // Clear out paragraph metrics to avoid having invalid metrics
1730         // in the cache from paragraphs not relayouted below
1731         // The complete text metrics will be redone.
1732         d->text_metrics_.clear();
1733
1734         TextMetrics & tm = textMetrics(&buftext);
1735
1736         // Rebreak anchor paragraph.
1737         tm.redoParagraph(d->anchor_pit_);
1738         ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
1739         anchor_pm.setPosition(d->anchor_ypos_);
1740
1741         LYXERR(Debug::PAINTING, "metrics: "
1742                 << " anchor pit = " << d->anchor_pit_
1743                 << " anchor ypos = " << d->anchor_ypos_);
1744
1745         // Redo paragraphs above anchor if necessary.
1746         int y1 = d->anchor_ypos_ - anchor_pm.ascent();
1747         // We are now just above the anchor paragraph.
1748         pit_type pit1 = d->anchor_pit_ - 1;
1749         for (; pit1 >= 0 && y1 >= 0; --pit1) {
1750                 tm.redoParagraph(pit1);
1751                 ParagraphMetrics & pm = tm.par_metrics_[pit1];
1752                 y1 -= pm.descent();
1753                 // Save the paragraph position in the cache.
1754                 pm.setPosition(y1);
1755                 y1 -= pm.ascent();
1756         }
1757
1758         // Redo paragraphs below the anchor if necessary.
1759         int y2 = d->anchor_ypos_ + anchor_pm.descent();
1760         // We are now just below the anchor paragraph.
1761         pit_type pit2 = d->anchor_pit_ + 1;
1762         for (; pit2 < npit && y2 <= height_; ++pit2) {
1763                 tm.redoParagraph(pit2);
1764                 ParagraphMetrics & pm = tm.par_metrics_[pit2];
1765                 y2 += pm.ascent();
1766                 // Save the paragraph position in the cache.
1767                 pm.setPosition(y2);
1768                 y2 += pm.descent();
1769         }
1770
1771         LYXERR(Debug::PAINTING, "Metrics: "
1772                 << " anchor pit = " << d->anchor_pit_
1773                 << " anchor ypos = " << d->anchor_ypos_
1774                 << " y1 = " << y1
1775                 << " y2 = " << y2
1776                 << " pit1 = " << pit1
1777                 << " pit2 = " << pit2);
1778
1779         d->update_strategy_ = FullScreenUpdate;
1780
1781         if (lyxerr.debugging(Debug::WORKAREA)) {
1782                 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
1783                 d->coord_cache_.dump();
1784         }
1785 }
1786
1787
1788 void BufferView::insertLyXFile(FileName const & fname)
1789 {
1790         BOOST_ASSERT(d->cursor_.inTexted());
1791
1792         // Get absolute path of file and add ".lyx"
1793         // to the filename if necessary
1794         FileName filename = fileSearch(string(), fname.absFilename(), "lyx");
1795
1796         docstring const disp_fn = makeDisplayPath(filename.absFilename());
1797         // emit message signal.
1798         message(bformat(_("Inserting document %1$s..."), disp_fn));
1799
1800         docstring res;
1801         Buffer buf("", false);
1802         if (buf.loadLyXFile(filename)) {
1803                 ErrorList & el = buffer_.errorList("Parse");
1804                 // Copy the inserted document error list into the current buffer one.
1805                 el = buf.errorList("Parse");
1806                 buffer_.undo().recordUndo(d->cursor_);
1807                 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
1808                                              buf.params().getTextClassPtr(), el);
1809                 res = _("Document %1$s inserted.");
1810         } else {
1811                 res = _("Could not insert document %1$s");
1812         }
1813
1814         updateMetrics();
1815         buffer_.changed();
1816         // emit message signal.
1817         message(bformat(res, disp_fn));
1818         buffer_.errors("Parse");
1819 }
1820
1821
1822 Point BufferView::coordOffset(DocIterator const & dit, bool boundary) const
1823 {
1824         int x = 0;
1825         int y = 0;
1826         int lastw = 0;
1827
1828         // Addup contribution of nested insets, from inside to outside,
1829         // keeping the outer paragraph for a special handling below
1830         for (size_t i = dit.depth() - 1; i >= 1; --i) {
1831                 CursorSlice const & sl = dit[i];
1832                 int xx = 0;
1833                 int yy = 0;
1834                 
1835                 // get relative position inside sl.inset()
1836                 sl.inset().cursorPos(*this, sl, boundary && (i + 1 == dit.depth()), xx, yy);
1837                 
1838                 // Make relative position inside of the edited inset relative to sl.inset()
1839                 x += xx;
1840                 y += yy;
1841                 
1842                 // In case of an RTL inset, the edited inset will be positioned to the left
1843                 // of xx:yy
1844                 if (sl.text()) {
1845                         bool boundary_i = boundary && i + 1 == dit.depth();
1846                         bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
1847                         if (rtl)
1848                                 x -= lastw;
1849                 }
1850
1851                 // remember width for the case that sl.inset() is positioned in an RTL inset
1852                 if (i && dit[i - 1].text()) {
1853                         // If this Inset is inside a Text Inset, retrieve the Dimension
1854                         // from the containing text instead of using Inset::dimension() which
1855                         // might not be implemented.
1856                         // FIXME (Abdel 23/09/2007): this is a bit messy because of the
1857                         // elimination of Inset::dim_ cache. This coordOffset() method needs
1858                         // to be rewritten in light of the new design.
1859                         Dimension const & dim = parMetrics(dit[i - 1].text(),
1860                                 dit[i - 1].pit()).insetDimension(&sl.inset());
1861                         lastw = dim.wid;
1862                 } else {
1863                         Dimension const dim = sl.inset().dimension(*this);
1864                         lastw = dim.wid;
1865                 }
1866                 
1867                 //lyxerr << "Cursor::getPos, i: "
1868                 // << i << " x: " << xx << " y: " << y << endl;
1869         }
1870
1871         // Add contribution of initial rows of outermost paragraph
1872         CursorSlice const & sl = dit[0];
1873         TextMetrics const & tm = textMetrics(sl.text());
1874         ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
1875         BOOST_ASSERT(!pm.rows().empty());
1876         y -= pm.rows()[0].ascent();
1877 #if 1
1878         // FIXME: document this mess
1879         size_t rend;
1880         if (sl.pos() > 0 && dit.depth() == 1) {
1881                 int pos = sl.pos();
1882                 if (pos && boundary)
1883                         --pos;
1884 //              lyxerr << "coordOffset: boundary:" << boundary << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
1885                 rend = pm.pos2row(pos);
1886         } else
1887                 rend = pm.pos2row(sl.pos());
1888 #else
1889         size_t rend = pm.pos2row(sl.pos());
1890 #endif
1891         for (size_t rit = 0; rit != rend; ++rit)
1892                 y += pm.rows()[rit].height();
1893         y += pm.rows()[rend].ascent();
1894         
1895         TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
1896         
1897         // Make relative position from the nested inset now bufferview absolute.
1898         int xx = bottom_tm.cursorX(dit.bottom(), boundary && dit.depth() == 1);
1899         x += xx;
1900         
1901         // In the RTL case place the nested inset at the left of the cursor in 
1902         // the outer paragraph
1903         bool boundary_1 = boundary && 1 == dit.depth();
1904         bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
1905         if (rtl)
1906                 x -= lastw;
1907         
1908         return Point(x, y);
1909 }
1910
1911
1912 Point BufferView::getPos(DocIterator const & dit, bool boundary) const
1913 {
1914         CursorSlice const & bot = dit.bottom();
1915         TextMetrics const & tm = textMetrics(bot.text());
1916         if (!tm.has(bot.pit()))
1917                 return Point(-1, -1);
1918
1919         Point p = coordOffset(dit, boundary); // offset from outer paragraph
1920         p.y_ += tm.parMetrics(bot.pit()).position();
1921         return p;
1922 }
1923
1924
1925 void BufferView::draw(frontend::Painter & pain)
1926 {
1927         LYXERR(Debug::PAINTING, "\t\t*** START DRAWING ***");
1928         Text & text = buffer_.text();
1929         TextMetrics const & tm = d->text_metrics_[&text];
1930         int const y = tm.first().second->position();
1931         PainterInfo pi(this, pain);
1932
1933         switch (d->update_strategy_) {
1934
1935         case NoScreenUpdate:
1936                 // If no screen painting is actually needed, only some the different
1937                 // coordinates of insets and paragraphs needs to be updated.
1938                 pi.full_repaint = true;
1939                 pi.pain.setDrawingEnabled(false);
1940                 tm.draw(pi, 0, y);
1941                 break;
1942
1943         case SingleParUpdate:
1944                 pi.full_repaint = false;
1945                 // In general, only the current row of the outermost paragraph
1946                 // will be redrawn. Particular cases where selection spans
1947                 // multiple paragraph are correctly detected in TextMetrics.
1948                 tm.draw(pi, 0, y);
1949                 break;
1950
1951         case DecorationUpdate:
1952                 // FIXME: We should also distinguish DecorationUpdate to avoid text
1953                 // drawing if possible. This is not possible to do easily right now
1954                 // because of the single backing pixmap.
1955
1956         case FullScreenUpdate:
1957                 // The whole screen, including insets, will be refreshed.
1958                 pi.full_repaint = true;
1959
1960                 // Clear background.
1961                 pain.fillRectangle(0, 0, width_, height_,
1962                         buffer_.inset().backgroundColor());
1963
1964                 // Draw everything.
1965                 tm.draw(pi, 0, y);
1966
1967                 // and possibly grey out below
1968                 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
1969                 int const y2 = lastpm.second->position() + lastpm.second->descent();
1970                 if (y2 < height_)
1971                         pain.fillRectangle(0, y2, width_, height_ - y2, Color_bottomarea);
1972                 break;
1973         }
1974         LYXERR(Debug::PAINTING, "\n\t\t*** END DRAWING  ***");
1975
1976         // The scrollbar needs an update.
1977         updateScrollbar();
1978
1979         // Normalize anchor for next time
1980         pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
1981         pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
1982         for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
1983                 ParagraphMetrics const & pm = tm.parMetrics(pit);
1984                 if (pm.position() + pm.descent() > 0) {
1985                         d->anchor_pit_ = pit;
1986                         d->anchor_ypos_ = pm.position();
1987                         break;
1988                 }
1989         }
1990         LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
1991                 << "  anchor ypos = " << d->anchor_ypos_);
1992 }
1993
1994
1995 void BufferView::message(docstring const & msg)
1996 {
1997         if (d->gui_)
1998                 d->gui_->message(msg);
1999 }
2000
2001
2002 void BufferView::showDialog(string const & name)
2003 {
2004         if (d->gui_)
2005                 d->gui_->showDialog(name, string());
2006 }
2007
2008
2009 void BufferView::showDialog(string const & name,
2010         string const & data, Inset * inset)
2011 {
2012         if (d->gui_)
2013                 d->gui_->showDialog(name, data, inset);
2014 }
2015
2016
2017 void BufferView::updateDialog(string const & name, string const & data)
2018 {
2019         if (d->gui_)
2020                 d->gui_->updateDialog(name, data);
2021 }
2022
2023
2024 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
2025 {
2026         d->gui_ = gui;
2027 }
2028
2029
2030 // FIXME: Move this out of BufferView again
2031 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
2032 {
2033         if (!fname.isReadableFile()) {
2034                 docstring const error = from_ascii(strerror(errno));
2035                 docstring const file = makeDisplayPath(fname.absFilename(), 50);
2036                 docstring const text =
2037                   bformat(_("Could not read the specified document\n"
2038                             "%1$s\ndue to the error: %2$s"), file, error);
2039                 Alert::error(_("Could not read file"), text);
2040                 return docstring();
2041         }
2042
2043         if (!fname.isReadableFile()) {
2044                 docstring const file = makeDisplayPath(fname.absFilename(), 50);
2045                 docstring const text =
2046                   bformat(_("%1$s\n is not readable."), file);
2047                 Alert::error(_("Could not open file"), text);
2048                 return docstring();
2049         }
2050
2051         // FIXME UNICODE: We don't know the encoding of the file
2052         docstring file_content = fname.fileContents("UTF-8");
2053         if (file_content.empty()) {
2054                 Alert::error(_("Reading not UTF-8 encoded file"),
2055                              _("The file is not UTF-8 encoded.\n"
2056                                "It will be read as local 8Bit-encoded.\n"
2057                                "If this does not give the correct result\n"
2058                                "then please change the encoding of the file\n"
2059                                "to UTF-8 with a program other than LyX.\n"));
2060                 file_content = fname.fileContents("local8bit");
2061         }
2062
2063         return normalize_c(file_content);
2064 }
2065
2066
2067 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
2068 {
2069         docstring const tmpstr = contentsOfPlaintextFile(f);
2070
2071         if (tmpstr.empty())
2072                 return;
2073
2074         Cursor & cur = cursor();
2075         cap::replaceSelection(cur);
2076         buffer_.undo().recordUndo(cur);
2077         if (asParagraph)
2078                 cur.innerText()->insertStringAsParagraphs(cur, tmpstr);
2079         else
2080                 cur.innerText()->insertStringAsLines(cur, tmpstr);
2081
2082         updateMetrics();
2083         buffer_.changed();
2084 }
2085
2086 } // namespace lyx