]> git.lyx.org Git - lyx.git/blob - src/BufferView.cpp
b64f36d8ab149549e446a9d872f1792590aabac3
[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 "BranchList.h"
20 #include "Buffer.h"
21 #include "buffer_funcs.h"
22 #include "BufferList.h"
23 #include "BufferParams.h"
24 #include "CoordCache.h"
25 #include "Cursor.h"
26 #include "CutAndPaste.h"
27 #include "DispatchResult.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 "LayoutFile.h"
38 #include "Length.h"
39 #include "Lexer.h"
40 #include "LyX.h"
41 #include "LyXAction.h"
42 #include "lyxfind.h"
43 #include "Layout.h"
44 #include "LyXRC.h"
45 #include "MetricsInfo.h"
46 #include "Paragraph.h"
47 #include "ParagraphParameters.h"
48 #include "ParIterator.h"
49 #include "RowPainter.h"
50 #include "Session.h"
51 #include "Text.h"
52 #include "TextClass.h"
53 #include "TextMetrics.h"
54 #include "TexRow.h"
55 #include "TocBackend.h"
56 #include "WordLangTuple.h"
57
58 #include "insets/InsetBibtex.h"
59 #include "insets/InsetCitation.h"
60 #include "insets/InsetCommand.h" // ChangeRefs
61 #include "insets/InsetExternal.h"
62 #include "insets/InsetGraphics.h"
63 #include "insets/InsetNote.h"
64 #include "insets/InsetRef.h"
65 #include "insets/InsetText.h"
66
67 #include "mathed/MathData.h"
68
69 #include "frontends/alert.h"
70 #include "frontends/Application.h"
71 #include "frontends/Delegates.h"
72 #include "frontends/FontMetrics.h"
73 #include "frontends/NullPainter.h"
74 #include "frontends/Painter.h"
75 #include "frontends/Selection.h"
76
77 #include "support/convert.h"
78 #include "support/debug.h"
79 #include "support/ExceptionMessage.h"
80 #include "support/filetools.h"
81 #include "support/gettext.h"
82 #include "support/lassert.h"
83 #include "support/lstrings.h"
84 #include "support/lyxlib.h"
85 #include "support/Package.h"
86 #include "support/types.h"
87
88 #include <cerrno>
89 #include <fstream>
90 #include <functional>
91 #include <iterator>
92 #include <sstream>
93 #include <vector>
94
95 using namespace std;
96 using namespace lyx::support;
97
98 namespace lyx {
99
100 namespace Alert = frontend::Alert;
101
102 namespace {
103
104 /// Return an inset of this class if it exists at the current cursor position
105 template <class T>
106 T * getInsetByCode(Cursor const & cur, InsetCode code)
107 {
108         DocIterator it = cur;
109         Inset * inset = it.nextInset();
110         if (inset && inset->lyxCode() == code)
111                 return static_cast<T*>(inset);
112         return 0;
113 }
114
115
116 /// Note that comparing contents can only be used for InsetCommand
117 bool findNextInset(DocIterator & dit, vector<InsetCode> const & codes,
118         docstring const & contents)
119 {
120         DocIterator tmpdit = dit;
121
122         while (tmpdit) {
123                 Inset const * inset = tmpdit.nextInset();
124                 if (inset) {
125                         bool const valid_code = std::find(codes.begin(), codes.end(),
126                                 inset->lyxCode()) != codes.end();
127                         InsetCommand const * ic = inset->asInsetCommand();
128                         bool const same_or_no_contents =  contents.empty()
129                                 || (ic && (ic->getFirstNonOptParam() == contents));
130
131                         if (valid_code && same_or_no_contents) {
132                                 dit = tmpdit;
133                                 return true;
134                         }
135                 }
136                 tmpdit.forwardInset();
137         }
138
139         return false;
140 }
141
142
143 /// Looks for next inset with one of the given codes.
144 /// Note that same_content can only be used for InsetCommand
145 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
146         bool same_content)
147 {
148         docstring contents;
149         DocIterator tmpdit = dit;
150         tmpdit.forwardInset();
151         if (!tmpdit)
152                 return false;
153
154         Inset const * inset = tmpdit.nextInset();
155         if (same_content && inset) {
156                 InsetCommand const * ic = inset->asInsetCommand();
157                 if (ic) {
158                         bool const valid_code = std::find(codes.begin(), codes.end(),
159                                 ic->lyxCode()) != codes.end();
160                         if (valid_code)
161                                 contents = ic->getFirstNonOptParam();
162                 }
163         }
164
165         if (!findNextInset(tmpdit, codes, contents)) {
166                 if (dit.depth() != 1 || dit.pit() != 0 || dit.pos() != 0) {
167                         Inset * inset = &tmpdit.bottom().inset();
168                         tmpdit = doc_iterator_begin(&inset->buffer(), inset);
169                         if (!findNextInset(tmpdit, codes, contents))
170                                 return false;
171                 } else {
172                         return false;
173                 }
174         }
175
176         dit = tmpdit;
177         return true;
178 }
179
180
181 /// Looks for next inset with the given code
182 void findInset(DocIterator & dit, InsetCode code, bool same_content)
183 {
184         findInset(dit, vector<InsetCode>(1, code), same_content);
185 }
186
187
188 /// Moves cursor to the next inset with one of the given codes.
189 void gotoInset(BufferView * bv, vector<InsetCode> const & codes,
190                bool same_content)
191 {
192         Cursor tmpcur = bv->cursor();
193         if (!findInset(tmpcur, codes, same_content)) {
194                 bv->cursor().message(_("No more insets"));
195                 return;
196         }
197
198         tmpcur.clearSelection();
199         bv->setCursor(tmpcur);
200         bv->showCursor();
201 }
202
203
204 /// Moves cursor to the next inset with given code.
205 void gotoInset(BufferView * bv, InsetCode code, bool same_content)
206 {
207         gotoInset(bv, vector<InsetCode>(1, code), same_content);
208 }
209
210
211 /// A map from a Text to the associated text metrics
212 typedef map<Text const *, TextMetrics> TextMetricsCache;
213
214 enum ScreenUpdateStrategy {
215         NoScreenUpdate,
216         SingleParUpdate,
217         FullScreenUpdate,
218         DecorationUpdate
219 };
220
221 } // namespace
222
223
224 /////////////////////////////////////////////////////////////////////
225 //
226 // BufferView
227 //
228 /////////////////////////////////////////////////////////////////////
229
230 struct BufferView::Private
231 {
232         Private(BufferView & bv) : update_strategy_(FullScreenUpdate),
233                 update_flags_(Update::Force),
234                 wh_(0), cursor_(bv),
235                 anchor_pit_(0), anchor_ypos_(0),
236                 inlineCompletionUniqueChars_(0),
237                 last_inset_(0), clickable_inset_(false),
238                 mouse_position_cache_(),
239                 bookmark_edit_position_(-1), gui_(0),
240                 horiz_scroll_offset_(0), repaint_caret_row_(false)
241         {
242                 xsel_cache_.set = false;
243         }
244
245         ///
246         ScrollbarParameters scrollbarParameters_;
247         ///
248         ScreenUpdateStrategy update_strategy_;
249         ///
250         Update::flags update_flags_;
251         ///
252         CoordCache coord_cache_;
253
254         /// Estimated average par height for scrollbar.
255         int wh_;
256         /// this is used to handle XSelection events in the right manner.
257         struct {
258                 CursorSlice cursor;
259                 CursorSlice anchor;
260                 bool set;
261         } xsel_cache_;
262         ///
263         Cursor cursor_;
264         ///
265         pit_type anchor_pit_;
266         ///
267         int anchor_ypos_;
268         ///
269         vector<int> par_height_;
270
271         ///
272         DocIterator inlineCompletionPos_;
273         ///
274         docstring inlineCompletion_;
275         ///
276         size_t inlineCompletionUniqueChars_;
277
278         /// keyboard mapping object.
279         Intl intl_;
280
281         /// last visited inset.
282         /** kept to send setMouseHover(false).
283           * Not owned, so don't delete.
284           */
285         Inset const * last_inset_;
286         /// are we hovering something that we can click
287         bool clickable_inset_;
288
289         /// position of the mouse at the time of the last mouse move
290         /// This is used to update the hovering status of inset in
291         /// cases where the buffer is scrolled, but the mouse didn't move.
292         Point mouse_position_cache_;
293
294         // cache for id of the paragraph which was edited the last time
295         int bookmark_edit_position_;
296
297         mutable TextMetricsCache text_metrics_;
298
299         /// Whom to notify.
300         /** Not owned, so don't delete.
301           */
302         frontend::GuiBufferViewDelegate * gui_;
303
304         /// Cache for Find Next
305         FuncRequest search_request_cache_;
306
307         ///
308         map<string, Inset *> edited_insets_;
309
310         /// When the row where the cursor lies is scrolled, this
311         /// contains the scroll offset
312         int horiz_scroll_offset_;
313         /// a slice pointing to the start of the row where the cursor
314         /// is (at last draw time)
315         CursorSlice current_row_slice_;
316         /// a slice pointing to the start of the row where cursor was
317         /// at previous draw event
318         CursorSlice last_row_slice_;
319
320         /// a slice pointing to where the cursor has been drawn after the current
321         /// draw() call.
322         CursorSlice caret_slice_;
323         /// indicates whether the caret slice needs to be repainted in this draw() run.
324         bool repaint_caret_row_;
325 };
326
327
328 BufferView::BufferView(Buffer & buf)
329         : width_(0), height_(0), full_screen_(false), buffer_(buf),
330       d(new Private(*this))
331 {
332         d->xsel_cache_.set = false;
333         d->intl_.initKeyMapper(lyxrc.use_kbmap);
334
335         d->cursor_.setBuffer(&buf);
336         d->cursor_.push(buffer_.inset());
337         d->cursor_.resetAnchor();
338         d->cursor_.setCurrentFont();
339
340         buffer_.updatePreviews();
341 }
342
343
344 BufferView::~BufferView()
345 {
346         // current buffer is going to be switched-off, save cursor pos
347         // Ideally, the whole cursor stack should be saved, but session
348         // currently can only handle bottom (whole document) level pit and pos.
349         // That is to say, if a cursor is in a nested inset, it will be
350         // restore to the left of the top level inset.
351         LastFilePosSection::FilePos fp;
352         fp.pit = d->cursor_.bottom().pit();
353         fp.pos = d->cursor_.bottom().pos();
354         theSession().lastFilePos().save(buffer_.fileName(), fp);
355
356         if (d->last_inset_)
357                 d->last_inset_->setMouseHover(this, false);
358
359         delete d;
360 }
361
362
363 int BufferView::rightMargin() const
364 {
365         // The value used to be hardcoded to 10
366         int const default_margin = zoomedPixels(10);
367         // The additional test for the case the outliner is opened.
368         if (!full_screen_ || !lyxrc.full_screen_limit
369             || width_ < lyxrc.full_screen_width + 2 * default_margin)
370                 return default_margin;
371
372         return (width_ - lyxrc.full_screen_width) / 2;
373 }
374
375
376 int BufferView::leftMargin() const
377 {
378         return rightMargin();
379 }
380
381
382 int BufferView::inPixels(Length const & len) const
383 {
384         Font const font = buffer().params().getFont();
385         return len.inPixels(workWidth(), theFontMetrics(font).em());
386 }
387
388
389 int BufferView::zoomedPixels(int pix) const
390 {
391         // FIXME: the dpi setting should really depend on the BufferView
392         // (think different monitors).
393
394         // Zoom factor specified by user in percent
395         double const zoom = lyxrc.currentZoom / 100.0; // [percent]
396
397         // DPI setting for monitor relative to 100dpi
398         double const dpizoom = lyxrc.dpi / 100.0; // [per 100dpi]
399
400         return support::iround(pix * zoom * dpizoom);
401 }
402
403
404 bool BufferView::isTopScreen() const
405 {
406         return 0 == d->scrollbarParameters_.min;
407 }
408
409
410 bool BufferView::isBottomScreen() const
411 {
412         return 0 == d->scrollbarParameters_.max;
413 }
414
415
416 Intl & BufferView::getIntl()
417 {
418         return d->intl_;
419 }
420
421
422 Intl const & BufferView::getIntl() const
423 {
424         return d->intl_;
425 }
426
427
428 CoordCache & BufferView::coordCache()
429 {
430         return d->coord_cache_;
431 }
432
433
434 CoordCache const & BufferView::coordCache() const
435 {
436         return d->coord_cache_;
437 }
438
439
440 Buffer & BufferView::buffer()
441 {
442         return buffer_;
443 }
444
445
446 Buffer const & BufferView::buffer() const
447 {
448         return buffer_;
449 }
450
451
452 bool BufferView::needsFitCursor() const
453 {
454         if (cursorStatus(d->cursor_) == CUR_INSIDE) {
455                 frontend::FontMetrics const & fm =
456                         theFontMetrics(d->cursor_.getFont().fontInfo());
457                 int const asc = fm.maxAscent();
458                 int const des = fm.maxDescent();
459                 Point const p = getPos(d->cursor_);
460                 if (p.y_ - asc >= 0 && p.y_ + des < height_)
461                         return false;
462         }
463         return true;
464 }
465
466
467 namespace {
468
469 // this is for debugging only.
470 string flagsAsString(Update::flags flags)
471 {
472         if (flags == Update::None)
473                 return "None ";
474         return string((flags & Update::FitCursor) ? "FitCursor " : "")
475                 + ((flags & Update::Force) ? "Force " : "")
476                 + ((flags & Update::ForceDraw) ? "ForceDraw " : "")
477                 + ((flags & Update::SinglePar) ? "SinglePar " : "");
478 }
479
480 }
481
482 void BufferView::processUpdateFlags(Update::flags flags)
483 {
484         LYXERR(Debug::PAINTING, "BufferView::processUpdateFlags( "
485                    << flagsAsString(flags) << ")  buffer: " << &buffer_);
486
487         // Case when no explicit update is requested.
488         if (flags == Update::None)
489                 return;
490
491         // SinglePar is ignored for now (this should probably change). We
492         // set it ourselves below, at the price of always rebreaking the
493         // paragraph at cursor. This can be expensive for large tables.
494         flags = flags & ~Update::SinglePar;
495
496         // First check whether the metrics and inset positions should be updated
497         if (flags & Update::Force) {
498                 // This will update the CoordCache items and replace Force
499                 // with ForceDraw in flags.
500                 updateMetrics(flags);
501         }
502
503         // Then make sure that the screen contains the cursor if needed
504         if (flags & Update::FitCursor) {
505                 if (needsFitCursor()) {
506                         scrollToCursor(d->cursor_, false);
507                         // Metrics have to be recomputed (maybe again)
508                         updateMetrics(flags);
509                 }
510                 flags = flags & ~Update::FitCursor;
511         }
512
513         // Finally detect whether we can only repaint a single paragraph
514         if (!(flags & Update::ForceDraw)) {
515                 if (singleParUpdate())
516                         flags = flags | Update::SinglePar;
517                 else
518                         updateMetrics(flags);
519         }
520
521         // Add flags to the the update flags. These will be reset to None
522         // after the redraw is actually done
523         d->update_flags_ = d->update_flags_ | flags;
524         LYXERR(Debug::PAINTING, "Cumulative flags: " << flagsAsString(flags));
525
526         // Now compute the update strategy
527         // Possibly values in flag are None, Decoration, ForceDraw
528         LATTEST((d->update_flags_ & ~(Update::None | Update::SinglePar
529                                       | Update::Decoration | Update::ForceDraw)) == 0);
530
531         if (d->update_flags_ & Update::ForceDraw)
532                 d->update_strategy_ = FullScreenUpdate;
533         else if (d->update_flags_ & Update::Decoration)
534                 d->update_strategy_ = DecorationUpdate;
535         else if (d->update_flags_ & Update::SinglePar)
536                 d->update_strategy_ = SingleParUpdate;
537         else {
538                 // no need to redraw anything.
539                 d->update_strategy_ = NoScreenUpdate;
540         }
541
542         updateHoveredInset();
543
544         // Trigger a redraw.
545         buffer_.changed(false);
546 }
547
548
549 void BufferView::updateScrollbar()
550 {
551         if (height_ == 0 && width_ == 0)
552                 return;
553
554         // We prefer fixed size line scrolling.
555         d->scrollbarParameters_.single_step = defaultRowHeight();
556         // We prefer full screen page scrolling.
557         d->scrollbarParameters_.page_step = height_;
558
559         Text & t = buffer_.text();
560         TextMetrics & tm = d->text_metrics_[&t];
561
562         LYXERR(Debug::GUI, " Updating scrollbar: height: "
563                 << t.paragraphs().size()
564                 << " curr par: " << d->cursor_.bottom().pit()
565                 << " default height " << defaultRowHeight());
566
567         size_t const parsize = t.paragraphs().size();
568         if (d->par_height_.size() != parsize) {
569                 d->par_height_.clear();
570                 // FIXME: We assume a default paragraph height of 2 rows. This
571                 // should probably be pondered with the screen width.
572                 d->par_height_.resize(parsize, defaultRowHeight() * 2);
573         }
574
575         // Look at paragraph heights on-screen
576         pair<pit_type, ParagraphMetrics const *> first = tm.first();
577         pair<pit_type, ParagraphMetrics const *> last = tm.last();
578         for (pit_type pit = first.first; pit <= last.first; ++pit) {
579                 d->par_height_[pit] = tm.parMetrics(pit).height();
580                 LYXERR(Debug::SCROLLING, "storing height for pit " << pit << " : "
581                         << d->par_height_[pit]);
582         }
583
584         int top_pos = first.second->position() - first.second->ascent();
585         int bottom_pos = last.second->position() + last.second->descent();
586         bool first_visible = first.first == 0 && top_pos >= 0;
587         bool last_visible = last.first + 1 == int(parsize) && bottom_pos <= height_;
588         if (first_visible && last_visible) {
589                 d->scrollbarParameters_.min = 0;
590                 d->scrollbarParameters_.max = 0;
591                 return;
592         }
593
594         d->scrollbarParameters_.min = top_pos;
595         for (size_t i = 0; i != size_t(first.first); ++i)
596                 d->scrollbarParameters_.min -= d->par_height_[i];
597         d->scrollbarParameters_.max = bottom_pos;
598         for (size_t i = last.first + 1; i != parsize; ++i)
599                 d->scrollbarParameters_.max += d->par_height_[i];
600
601         // The reference is the top position so we remove one page.
602         if (lyxrc.scroll_below_document)
603                 d->scrollbarParameters_.max -= minVisiblePart();
604         else
605                 d->scrollbarParameters_.max -= d->scrollbarParameters_.page_step;
606
607         // 0 must be inside the range as it denotes the current position
608         if (d->scrollbarParameters_.max < 0)
609                 d->scrollbarParameters_.max = 0;
610         if (d->scrollbarParameters_.min > 0)
611                 d->scrollbarParameters_.min = 0;
612 }
613
614
615 ScrollbarParameters const & BufferView::scrollbarParameters() const
616 {
617         return d->scrollbarParameters_;
618 }
619
620
621 docstring BufferView::toolTip(int x, int y) const
622 {
623         // Get inset under mouse, if there is one.
624         Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
625         if (!covering_inset)
626                 // No inset, no tooltip...
627                 return docstring();
628         return covering_inset->toolTip(*this, x, y);
629 }
630
631
632 string BufferView::contextMenu(int x, int y) const
633 {
634         //If there is a selection, return the containing inset menu
635         if (d->cursor_.selection())
636                 return d->cursor_.inset().contextMenu(*this, x, y);
637
638         // Get inset under mouse, if there is one.
639         Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
640         if (covering_inset)
641                 return covering_inset->contextMenu(*this, x, y);
642
643         return buffer_.inset().contextMenu(*this, x, y);
644 }
645
646
647
648 void BufferView::scrollDocView(int const value, bool update)
649 {
650         // The scrollbar values are relative to the top of the screen, therefore the
651         // offset is equal to the target value.
652
653         // No scrolling at all? No need to redraw anything
654         if (value == 0)
655                 return;
656
657         // If the offset is less than 2 screen height, prefer to scroll instead.
658         if (abs(value) <= 2 * height_) {
659                 d->anchor_ypos_ -= value;
660                 processUpdateFlags(Update::Force);
661                 return;
662         }
663
664         // cut off at the top
665         if (value <= d->scrollbarParameters_.min) {
666                 DocIterator dit = doc_iterator_begin(&buffer_);
667                 showCursor(dit, false, update);
668                 LYXERR(Debug::SCROLLING, "scroll to top");
669                 return;
670         }
671
672         // cut off at the bottom
673         if (value >= d->scrollbarParameters_.max) {
674                 DocIterator dit = doc_iterator_end(&buffer_);
675                 dit.backwardPos();
676                 showCursor(dit, false, update);
677                 LYXERR(Debug::SCROLLING, "scroll to bottom");
678                 return;
679         }
680
681         // find paragraph at target position
682         int par_pos = d->scrollbarParameters_.min;
683         pit_type i = 0;
684         for (; i != int(d->par_height_.size()); ++i) {
685                 par_pos += d->par_height_[i];
686                 if (par_pos >= value)
687                         break;
688         }
689
690         if (par_pos < value) {
691                 // It seems we didn't find the correct pit so stay on the safe side and
692                 // scroll to bottom.
693                 LYXERR0("scrolling position not found!");
694                 scrollDocView(d->scrollbarParameters_.max, update);
695                 return;
696         }
697
698         DocIterator dit = doc_iterator_begin(&buffer_);
699         dit.pit() = i;
700         LYXERR(Debug::SCROLLING, "value = " << value << " -> scroll to pit " << i);
701         showCursor(dit, false, update);
702 }
703
704
705 // FIXME: this method is not working well.
706 void BufferView::setCursorFromScrollbar()
707 {
708         TextMetrics & tm = d->text_metrics_[&buffer_.text()];
709
710         int const height = 2 * defaultRowHeight();
711         int const first = height;
712         int const last = height_ - height;
713         int newy = 0;
714         Cursor const & oldcur = d->cursor_;
715
716         switch (cursorStatus(oldcur)) {
717         case CUR_ABOVE:
718                 newy = first;
719                 break;
720         case CUR_BELOW:
721                 newy = last;
722                 break;
723         case CUR_INSIDE:
724                 int const y = getPos(oldcur).y_;
725                 newy = min(last, max(y, first));
726                 if (y == newy)
727                         return;
728         }
729         // We reset the cursor because cursorStatus() does not
730         // work when the cursor is within mathed.
731         Cursor cur(*this);
732         cur.reset();
733         tm.setCursorFromCoordinates(cur, 0, newy);
734
735         // update the bufferview cursor and notify insets
736         // FIXME: Care about the d->cursor_ flags to redraw if needed
737         Cursor old = d->cursor_;
738         mouseSetCursor(cur);
739         // the DEPM call in mouseSetCursor() might have destroyed the
740         // paragraph the cursor is in.
741         bool badcursor = old.fixIfBroken();
742         badcursor |= notifyCursorLeavesOrEnters(old, d->cursor_);
743         if (badcursor)
744                 d->cursor_.fixIfBroken();
745 }
746
747
748 Change const BufferView::getCurrentChange() const
749 {
750         if (!d->cursor_.selection())
751                 return Change(Change::UNCHANGED);
752
753         DocIterator dit = d->cursor_.selectionBegin();
754         // The selected content might have been changed (see #7685)
755         dit = dit.getInnerText();
756         return dit.paragraph().lookupChange(dit.pos());
757 }
758
759
760 // this could be used elsewhere as well?
761 // FIXME: This does not work within mathed!
762 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
763 {
764         Point const p = getPos(dit);
765         if (p.y_ < 0)
766                 return CUR_ABOVE;
767         if (p.y_ > workHeight())
768                 return CUR_BELOW;
769         return CUR_INSIDE;
770 }
771
772
773 void BufferView::bookmarkEditPosition()
774 {
775         // Don't eat cpu time for each keystroke
776         if (d->cursor_.paragraph().id() == d->bookmark_edit_position_)
777                 return;
778         saveBookmark(0);
779         d->bookmark_edit_position_ = d->cursor_.paragraph().id();
780 }
781
782
783 void BufferView::saveBookmark(unsigned int idx)
784 {
785         // tentatively save bookmark, id and pos will be used to
786         // acturately locate a bookmark in a 'live' lyx session.
787         // pit and pos will be updated with bottom level pit/pos
788         // when lyx exits.
789         if (!buffer_.isInternal()) {
790                 theSession().bookmarks().save(
791                         buffer_.fileName(),
792                         d->cursor_.bottom().pit(),
793                         d->cursor_.bottom().pos(),
794                         d->cursor_.paragraph().id(),
795                         d->cursor_.pos(),
796                         idx
797                         );
798                 if (idx)
799                         // emit message signal.
800                         message(_("Save bookmark"));
801         }
802 }
803
804
805 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
806         int top_id, pos_type top_pos)
807 {
808         bool success = false;
809         DocIterator dit;
810
811         d->cursor_.clearSelection();
812
813         // if a valid par_id is given, try it first
814         // This is the case for a 'live' bookmark when unique paragraph ID
815         // is used to track bookmarks.
816         if (top_id > 0) {
817                 dit = buffer_.getParFromID(top_id);
818                 if (!dit.atEnd()) {
819                         dit.pos() = min(dit.paragraph().size(), top_pos);
820                         // Some slices of the iterator may not be
821                         // reachable (e.g. closed collapsible inset)
822                         // so the dociterator may need to be
823                         // shortened. Otherwise, setCursor may crash
824                         // lyx when the cursor can not be set to these
825                         // insets.
826                         size_t const n = dit.depth();
827                         for (size_t i = 0; i < n; ++i)
828                                 if (!dit[i].inset().editable()) {
829                                         dit.resize(i);
830                                         break;
831                                 }
832                         success = true;
833                 }
834         }
835
836         // if top_id == 0, or searching through top_id failed
837         // This is the case for a 'restored' bookmark when only bottom
838         // (document level) pit was saved. Because of this, bookmark
839         // restoration is inaccurate. If a bookmark was within an inset,
840         // it will be restored to the left of the outmost inset that contains
841         // the bookmark.
842         if (bottom_pit < int(buffer_.paragraphs().size())) {
843                 dit = doc_iterator_begin(&buffer_);
844
845                 dit.pit() = bottom_pit;
846                 dit.pos() = min(bottom_pos, dit.paragraph().size());
847                 success = true;
848         }
849
850         if (success) {
851                 // Note: only bottom (document) level pit is set.
852                 setCursor(dit);
853                 // set the current font.
854                 d->cursor_.setCurrentFont();
855                 // Do not forget to reset the anchor (see #9912)
856                 d->cursor_.resetAnchor();
857                 processUpdateFlags(Update::FitCursor);
858         }
859
860         return success;
861 }
862
863
864 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
865 {
866         if (d->cursor_.real_current_font.isRightToLeft()) {
867                 if (d->intl_.keymap == Intl::PRIMARY)
868                         d->intl_.keyMapSec();
869         } else {
870                 if (d->intl_.keymap == Intl::SECONDARY)
871                         d->intl_.keyMapPrim();
872         }
873
874         d->intl_.getTransManager().translateAndInsert(c, t, cur);
875 }
876
877
878 int BufferView::workWidth() const
879 {
880         return width_;
881 }
882
883
884 void BufferView::recenter()
885 {
886         showCursor(d->cursor_, true, true);
887 }
888
889
890 void BufferView::showCursor()
891 {
892         showCursor(d->cursor_, false, true);
893 }
894
895
896 void BufferView::showCursor(DocIterator const & dit,
897         bool recenter, bool update)
898 {
899         if (scrollToCursor(dit, recenter) && update)
900                 processUpdateFlags(Update::Force);
901 }
902
903
904 void BufferView::scrollToCursor()
905 {
906         if (scrollToCursor(d->cursor_, false))
907                 processUpdateFlags(Update::Force);
908 }
909
910
911 bool BufferView::scrollToCursor(DocIterator const & dit, bool const recenter)
912 {
913         // We are not properly started yet, delay until resizing is
914         // done.
915         if (height_ == 0)
916                 return false;
917
918         LYXERR(Debug::SCROLLING, "recentering!");
919
920         CursorSlice const & bot = dit.bottom();
921         TextMetrics & tm = d->text_metrics_[bot.text()];
922
923         pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
924         int bot_pit = bot.pit();
925         if (bot_pit > max_pit) {
926                 // FIXME: Why does this happen?
927                 LYXERR0("bottom pit is greater that max pit: "
928                         << bot_pit << " > " << max_pit);
929                 bot_pit = max_pit;
930         }
931
932         if (bot_pit == tm.first().first - 1)
933                 tm.newParMetricsUp();
934         else if (bot_pit == tm.last().first + 1)
935                 tm.newParMetricsDown();
936
937         if (tm.contains(bot_pit)) {
938                 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
939                 LBUFERR(!pm.rows().empty());
940                 // FIXME: smooth scrolling doesn't work in mathed.
941                 CursorSlice const & cs = dit.innerTextSlice();
942                 int offset = coordOffset(dit).y_;
943                 int ypos = pm.position() + offset;
944                 Dimension const & row_dim =
945                         pm.getRow(cs.pos(), dit.boundary()).dimension();
946                 int scrolled = 0;
947                 if (recenter)
948                         scrolled = scroll(ypos - height_/2);
949
950                 // We try to visualize the whole row, if the row height is larger than
951                 // the screen height, we scroll to a heuristic value of height_ / 4.
952                 // FIXME: This heuristic value should be replaced by a recursive search
953                 // for a row in the inset that can be visualized completely.
954                 else if (row_dim.height() > height_) {
955                         if (ypos < defaultRowHeight())
956                                 scrolled = scroll(ypos - height_ / 4);
957                         else if (ypos > height_ - defaultRowHeight())
958                                 scrolled = scroll(ypos - 3 * height_ / 4);
959                 }
960
961                 // If the top part of the row falls of the screen, we scroll
962                 // up to align the top of the row with the top of the screen.
963                 else if (ypos - row_dim.ascent() < 0 && ypos < height_) {
964                         int ynew = row_dim.ascent();
965                         scrolled = scrollUp(ynew - ypos);
966                 }
967
968                 // If the bottom of the row falls of the screen, we scroll down.
969                 else if (ypos + row_dim.descent() > height_ && ypos > 0) {
970                         int ynew = height_ - row_dim.descent();
971                         scrolled = scrollDown(ypos - ynew);
972                 }
973
974                 // else, nothing to do, the cursor is already visible so we just return.
975                 return scrolled != 0;
976         }
977
978         // fix inline completion position
979         if (d->inlineCompletionPos_.fixIfBroken())
980                 d->inlineCompletionPos_ = DocIterator();
981
982         tm.redoParagraph(bot_pit);
983         ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
984         int offset = coordOffset(dit).y_;
985
986         d->anchor_pit_ = bot_pit;
987         CursorSlice const & cs = dit.innerTextSlice();
988         Dimension const & row_dim =
989                 pm.getRow(cs.pos(), dit.boundary()).dimension();
990
991         if (recenter)
992                 d->anchor_ypos_ = height_/2;
993         else if (d->anchor_pit_ == 0)
994                 d->anchor_ypos_ = offset + pm.ascent();
995         else if (d->anchor_pit_ == max_pit)
996                 d->anchor_ypos_ = height_ - offset - row_dim.descent();
997         else if (offset > height_)
998                 d->anchor_ypos_ = height_ - offset - defaultRowHeight();
999         else
1000                 d->anchor_ypos_ = defaultRowHeight() * 2;
1001
1002         return true;
1003 }
1004
1005
1006 void BufferView::makeDocumentClass()
1007 {
1008         DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1009         buffer_.params().makeDocumentClass();
1010         updateDocumentClass(olddc);
1011 }
1012
1013
1014 void BufferView::updateDocumentClass(DocumentClassConstPtr olddc)
1015 {
1016         message(_("Converting document to new document class..."));
1017
1018         StableDocIterator backcur(d->cursor_);
1019         ErrorList & el = buffer_.errorList("Class Switch");
1020         cap::switchBetweenClasses(
1021                         olddc, buffer_.params().documentClassPtr(),
1022                         static_cast<InsetText &>(buffer_.inset()), el);
1023
1024         setCursor(backcur.asDocIterator(&buffer_));
1025
1026         buffer_.errors("Class Switch");
1027 }
1028
1029
1030 /** Return the change status at cursor position, taking into account the
1031  * status at each level of the document iterator (a table in a deleted
1032  * footnote is deleted).
1033  * When \param outer is true, the top slice is not looked at.
1034  */
1035 static Change::Type lookupChangeType(DocIterator const & dit, bool outer = false)
1036 {
1037         size_t const depth = dit.depth() - (outer ? 1 : 0);
1038
1039         for (size_t i = 0 ; i < depth ; ++i) {
1040                 CursorSlice const & slice = dit[i];
1041                 if (!slice.inset().inMathed()
1042                     && slice.pos() < slice.paragraph().size()) {
1043                         Change::Type const ch = slice.paragraph().lookupChange(slice.pos()).type;
1044                         if (ch != Change::UNCHANGED)
1045                                 return ch;
1046                 }
1047         }
1048         return Change::UNCHANGED;
1049 }
1050
1051
1052 bool BufferView::getStatus(FuncRequest const & cmd, FuncStatus & flag)
1053 {
1054         FuncCode const act = cmd.action();
1055
1056         // Can we use a readonly buffer?
1057         if (buffer_.isReadonly()
1058             && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1059             && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1060                 if (buffer_.hasReadonlyFlag())
1061                         flag.message(from_utf8(N_("Document is read-only")));
1062                 else
1063                         flag.message(from_utf8(N_("Document has been modified externally")));
1064                 flag.setEnabled(false);
1065                 return true;
1066         }
1067
1068         // Are we in a DELETED change-tracking region?
1069         if (lookupChangeType(d->cursor_, true) == Change::DELETED
1070             && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1071             && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1072                 flag.message(from_utf8(N_("This portion of the document is deleted.")));
1073                 flag.setEnabled(false);
1074                 return true;
1075         }
1076
1077         Cursor & cur = d->cursor_;
1078
1079         if (cur.getStatus(cmd, flag))
1080                 return true;
1081
1082         switch (act) {
1083
1084         // FIXME: This is a bit problematic because we don't check if this is
1085         // a document BufferView or not for these LFUNs. We probably have to
1086         // dispatch both to currentBufferView() and, if that fails,
1087         // to documentBufferView(); same as we do now for current Buffer and
1088         // document Buffer. Ideally those LFUN should go to Buffer as they
1089         // operate on the full Buffer and the cursor is only needed either for
1090         // an Undo record or to restore a cursor position. But we don't know
1091         // how to do that inside Buffer of course.
1092         case LFUN_BUFFER_PARAMS_APPLY:
1093         case LFUN_LAYOUT_MODULES_CLEAR:
1094         case LFUN_LAYOUT_MODULE_ADD:
1095         case LFUN_LAYOUT_RELOAD:
1096         case LFUN_TEXTCLASS_APPLY:
1097         case LFUN_TEXTCLASS_LOAD:
1098                 flag.setEnabled(!buffer_.isReadonly());
1099                 break;
1100
1101         case LFUN_UNDO:
1102                 // We do not use the LyXAction flag for readonly because Undo sets the
1103                 // buffer clean/dirty status by itself.
1104                 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasUndoStack());
1105                 break;
1106         case LFUN_REDO:
1107                 // We do not use the LyXAction flag for readonly because Redo sets the
1108                 // buffer clean/dirty status by itself.
1109                 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasRedoStack());
1110                 break;
1111         case LFUN_FILE_INSERT_PLAINTEXT_PARA:
1112         case LFUN_FILE_INSERT_PLAINTEXT: {
1113                 docstring const fname = cmd.argument();
1114                 if (!FileName::isAbsolute(to_utf8(fname))) {
1115                         flag.message(_("Absolute filename expected."));
1116                         return false;
1117                 }
1118                 flag.setEnabled(cur.inTexted());
1119                 break;
1120         }
1121         case LFUN_FILE_INSERT:
1122         case LFUN_BOOKMARK_SAVE:
1123                 // FIXME: Actually, these LFUNS should be moved to Text
1124                 flag.setEnabled(cur.inTexted());
1125                 break;
1126
1127         case LFUN_FONT_STATE:
1128         case LFUN_LABEL_INSERT:
1129         case LFUN_INFO_INSERT:
1130         case LFUN_PARAGRAPH_GOTO:
1131         case LFUN_NOTE_NEXT:
1132         case LFUN_REFERENCE_NEXT:
1133         case LFUN_WORD_FIND:
1134         case LFUN_WORD_FIND_FORWARD:
1135         case LFUN_WORD_FIND_BACKWARD:
1136         case LFUN_WORD_REPLACE:
1137         case LFUN_MARK_OFF:
1138         case LFUN_MARK_ON:
1139         case LFUN_MARK_TOGGLE:
1140         case LFUN_SCREEN_RECENTER:
1141         case LFUN_SCREEN_SHOW_CURSOR:
1142         case LFUN_BIBTEX_DATABASE_ADD:
1143         case LFUN_BIBTEX_DATABASE_DEL:
1144         case LFUN_STATISTICS:
1145         case LFUN_KEYMAP_OFF:
1146         case LFUN_KEYMAP_PRIMARY:
1147         case LFUN_KEYMAP_SECONDARY:
1148         case LFUN_KEYMAP_TOGGLE:
1149         case LFUN_INSET_SELECT_ALL:
1150                 flag.setEnabled(true);
1151                 break;
1152
1153         case LFUN_WORD_FINDADV: {
1154                 FindAndReplaceOptions opt;
1155                 istringstream iss(to_utf8(cmd.argument()));
1156                 iss >> opt;
1157                 flag.setEnabled(opt.repl_buf_name.empty()
1158                                 || !buffer_.isReadonly());
1159                 break;
1160         }
1161
1162         case LFUN_LABEL_GOTO:
1163                 flag.setEnabled(!cmd.argument().empty()
1164                     || getInsetByCode<InsetRef>(cur, REF_CODE));
1165                 break;
1166
1167         case LFUN_CHANGES_MERGE:
1168         case LFUN_CHANGE_NEXT:
1169         case LFUN_CHANGE_PREVIOUS:
1170         case LFUN_ALL_CHANGES_ACCEPT:
1171         case LFUN_ALL_CHANGES_REJECT:
1172                 flag.setEnabled(buffer_.areChangesPresent());
1173                 break;
1174
1175         case LFUN_SCREEN_UP:
1176         case LFUN_SCREEN_DOWN:
1177         case LFUN_SCROLL:
1178         case LFUN_SCREEN_UP_SELECT:
1179         case LFUN_SCREEN_DOWN_SELECT:
1180         case LFUN_INSET_FORALL:
1181                 flag.setEnabled(true);
1182                 break;
1183
1184         case LFUN_LAYOUT_TABULAR:
1185                 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
1186                 break;
1187
1188         case LFUN_LAYOUT:
1189                 flag.setEnabled(!cur.inset().forcePlainLayout(cur.idx()));
1190                 break;
1191
1192         case LFUN_LAYOUT_PARAGRAPH:
1193                 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
1194                 break;
1195
1196         case LFUN_BRANCH_ADD_INSERT:
1197                 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1198                 break;
1199
1200         case LFUN_DIALOG_SHOW_NEW_INSET:
1201                 // FIXME: this is wrong, but I do not understand the
1202                 // intent (JMarc)
1203                 if (cur.inset().lyxCode() == CAPTION_CODE)
1204                         return cur.inset().getStatus(cur, cmd, flag);
1205                 // FIXME we should consider passthru paragraphs too.
1206                 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1207                 break;
1208
1209         case LFUN_CITATION_INSERT: {
1210                 FuncRequest fr(LFUN_INSET_INSERT, "citation");
1211                 // FIXME: This could turn in a recursive hell.
1212                 // Shouldn't we use Buffer::getStatus() instead?
1213                 flag.setEnabled(lyx::getStatus(fr).enabled());
1214                 break;
1215         }
1216         case LFUN_INSET_APPLY: {
1217                 string const name = cmd.getArg(0);
1218                 Inset * inset = editedInset(name);
1219                 if (inset) {
1220                         FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1221                         if (!inset->getStatus(cur, fr, flag)) {
1222                                 // Every inset is supposed to handle this
1223                                 LASSERT(false, break);
1224                         }
1225                 } else {
1226                         FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1227                         flag = lyx::getStatus(fr);
1228                 }
1229                 break;
1230         }
1231
1232         default:
1233                 return false;
1234         }
1235
1236         return true;
1237 }
1238
1239
1240 Inset * BufferView::editedInset(string const & name) const
1241 {
1242         map<string, Inset *>::const_iterator it = d->edited_insets_.find(name);
1243         return it == d->edited_insets_.end() ? 0 : it->second;
1244 }
1245
1246
1247 void BufferView::editInset(string const & name, Inset * inset)
1248 {
1249         d->edited_insets_[name] = inset;
1250 }
1251
1252
1253 void BufferView::dispatch(FuncRequest const & cmd, DispatchResult & dr)
1254 {
1255         LYXERR(Debug::ACTION, "BufferView::dispatch: cmd: " << cmd);
1256
1257         string const argument = to_utf8(cmd.argument());
1258         Cursor & cur = d->cursor_;
1259         Cursor old = cur;
1260
1261         // Don't dispatch function that does not apply to internal buffers.
1262         if (buffer_.isInternal()
1263             && lyxaction.funcHasFlag(cmd.action(), LyXAction::NoInternal))
1264                 return;
1265
1266         // We'll set this back to false if need be.
1267         bool dispatched = true;
1268         buffer_.undo().beginUndoGroup();
1269
1270         FuncCode const act = cmd.action();
1271         switch (act) {
1272
1273         case LFUN_BUFFER_PARAMS_APPLY: {
1274                 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1275                 cur.recordUndoBufferParams();
1276                 istringstream ss(to_utf8(cmd.argument()));
1277                 Lexer lex;
1278                 lex.setStream(ss);
1279                 int const unknown_tokens = buffer_.readHeader(lex);
1280                 if (unknown_tokens != 0) {
1281                         LYXERR0("Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1282                                                 << unknown_tokens << " unknown token"
1283                                                 << (unknown_tokens == 1 ? "" : "s"));
1284                 }
1285                 updateDocumentClass(olddc);
1286
1287                 // We are most certainly here because of a change in the document
1288                 // It is then better to make sure that all dialogs are in sync with
1289                 // current document settings.
1290                 dr.screenUpdate(Update::Force | Update::FitCursor);
1291                 dr.forceBufferUpdate();
1292                 break;
1293         }
1294
1295         case LFUN_LAYOUT_MODULES_CLEAR: {
1296                 // FIXME: this modifies the document in cap::switchBetweenClasses
1297                 //  without calling recordUndo. Fix this before using
1298                 //  recordUndoBufferParams().
1299                 cur.recordUndoFullBuffer();
1300                 buffer_.params().clearLayoutModules();
1301                 makeDocumentClass();
1302                 dr.screenUpdate(Update::Force);
1303                 dr.forceBufferUpdate();
1304                 break;
1305         }
1306
1307         case LFUN_LAYOUT_MODULE_ADD: {
1308                 BufferParams const & params = buffer_.params();
1309                 if (!params.layoutModuleCanBeAdded(argument)) {
1310                         LYXERR0("Module `" << argument <<
1311                                 "' cannot be added due to failed requirements or "
1312                                 "conflicts with installed modules.");
1313                         break;
1314                 }
1315                 // FIXME: this modifies the document in cap::switchBetweenClasses
1316                 //  without calling recordUndo. Fix this before using
1317                 //  recordUndoBufferParams().
1318                 cur.recordUndoFullBuffer();
1319                 buffer_.params().addLayoutModule(argument);
1320                 makeDocumentClass();
1321                 dr.screenUpdate(Update::Force);
1322                 dr.forceBufferUpdate();
1323                 break;
1324         }
1325
1326         case LFUN_TEXTCLASS_APPLY: {
1327                 // since this shortcircuits, the second call is made only if
1328                 // the first fails
1329                 bool const success =
1330                         LayoutFileList::get().load(argument, buffer_.temppath()) ||
1331                         LayoutFileList::get().load(argument, buffer_.filePath());
1332                 if (!success) {
1333                         docstring s = bformat(_("The document class `%1$s' "
1334                                                  "could not be loaded."), from_utf8(argument));
1335                         frontend::Alert::error(_("Could not load class"), s);
1336                         break;
1337                 }
1338
1339                 LayoutFile const * old_layout = buffer_.params().baseClass();
1340                 LayoutFile const * new_layout = &(LayoutFileList::get()[argument]);
1341
1342                 if (old_layout == new_layout)
1343                         // nothing to do
1344                         break;
1345
1346                 // Save the old, possibly modular, layout for use in conversion.
1347                 // FIXME: this modifies the document in cap::switchBetweenClasses
1348                 //  without calling recordUndo. Fix this before using
1349                 //  recordUndoBufferParams().
1350                 cur.recordUndoFullBuffer();
1351                 buffer_.params().setBaseClass(argument);
1352                 makeDocumentClass();
1353                 dr.screenUpdate(Update::Force);
1354                 dr.forceBufferUpdate();
1355                 break;
1356         }
1357
1358         case LFUN_TEXTCLASS_LOAD: {
1359                 // since this shortcircuits, the second call is made only if
1360                 // the first fails
1361                 bool const success =
1362                         LayoutFileList::get().load(argument, buffer_.temppath()) ||
1363                         LayoutFileList::get().load(argument, buffer_.filePath());
1364                 if (!success) {
1365                         docstring s = bformat(_("The document class `%1$s' "
1366                                                  "could not be loaded."), from_utf8(argument));
1367                         frontend::Alert::error(_("Could not load class"), s);
1368                 }
1369                 break;
1370         }
1371
1372         case LFUN_LAYOUT_RELOAD: {
1373                 LayoutFileIndex bc = buffer_.params().baseClassID();
1374                 LayoutFileList::get().reset(bc);
1375                 buffer_.params().setBaseClass(bc);
1376                 makeDocumentClass();
1377                 dr.screenUpdate(Update::Force);
1378                 dr.forceBufferUpdate();
1379                 break;
1380         }
1381
1382         case LFUN_UNDO:
1383                 dr.setMessage(_("Undo"));
1384                 cur.clearSelection();
1385                 if (!cur.textUndo())
1386                         dr.setMessage(_("No further undo information"));
1387                 else
1388                         dr.screenUpdate(Update::Force | Update::FitCursor);
1389                 dr.forceBufferUpdate();
1390                 break;
1391
1392         case LFUN_REDO:
1393                 dr.setMessage(_("Redo"));
1394                 cur.clearSelection();
1395                 if (!cur.textRedo())
1396                         dr.setMessage(_("No further redo information"));
1397                 else
1398                         dr.screenUpdate(Update::Force | Update::FitCursor);
1399                 dr.forceBufferUpdate();
1400                 break;
1401
1402         case LFUN_FONT_STATE:
1403                 dr.setMessage(cur.currentState(false));
1404                 break;
1405
1406         case LFUN_BOOKMARK_SAVE:
1407                 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1408                 break;
1409
1410         case LFUN_LABEL_GOTO: {
1411                 docstring label = cmd.argument();
1412                 if (label.empty()) {
1413                         InsetRef * inset =
1414                                 getInsetByCode<InsetRef>(cur, REF_CODE);
1415                         if (inset) {
1416                                 label = inset->getParam("reference");
1417                                 // persistent=false: use temp_bookmark
1418                                 saveBookmark(0);
1419                         }
1420                 }
1421                 if (!label.empty()) {
1422                         gotoLabel(label);
1423                         // at the moment, this is redundant, since gotoLabel will
1424                         // eventually call LFUN_PARAGRAPH_GOTO, but it seems best
1425                         // to have it here.
1426                         dr.screenUpdate(Update::Force | Update::FitCursor);
1427                 }
1428                 break;
1429         }
1430
1431         case LFUN_PARAGRAPH_GOTO: {
1432                 int const id = convert<int>(cmd.getArg(0));
1433                 pos_type const pos = convert<int>(cmd.getArg(1));
1434                 if (id < 0)
1435                         break;
1436                 string const str_id_end = cmd.getArg(2);
1437                 string const str_pos_end = cmd.getArg(3);
1438                 int i = 0;
1439                 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1440                         b = theBufferList().next(b)) {
1441
1442                         Cursor cur(*this);
1443                         cur.setCursor(b->getParFromID(id));
1444                         if (cur.atEnd()) {
1445                                 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1446                                 ++i;
1447                                 continue;
1448                         }
1449                         LYXERR(Debug::INFO, "Paragraph " << cur.paragraph().id()
1450                                 << " found in buffer `"
1451                                 << b->absFileName() << "'.");
1452
1453                         if (b == &buffer_) {
1454                                 bool success;
1455                                 if (str_id_end.empty() || str_pos_end.empty()) {
1456                                         // Set the cursor
1457                                         cur.pos() = pos;
1458                                         mouseSetCursor(cur);
1459                                         success = true;
1460                                 } else {
1461                                         int const id_end = convert<int>(str_id_end);
1462                                         pos_type const pos_end = convert<int>(str_pos_end);
1463                                         success = setCursorFromEntries({id, pos},
1464                                                                        {id_end, pos_end});
1465                                 }
1466                                 if (success)
1467                                         dr.screenUpdate(Update::Force | Update::FitCursor);
1468                         } else {
1469                                 // Switch to other buffer view and resend cmd
1470                                 lyx::dispatch(FuncRequest(
1471                                         LFUN_BUFFER_SWITCH, b->absFileName()));
1472                                 lyx::dispatch(cmd);
1473                         }
1474                         break;
1475                 }
1476                 break;
1477         }
1478
1479         case LFUN_NOTE_NEXT:
1480                 gotoInset(this, NOTE_CODE, false);
1481                 break;
1482
1483         case LFUN_REFERENCE_NEXT: {
1484                 vector<InsetCode> tmp;
1485                 tmp.push_back(LABEL_CODE);
1486                 tmp.push_back(REF_CODE);
1487                 gotoInset(this, tmp, true);
1488                 break;
1489         }
1490
1491         case LFUN_CHANGE_NEXT:
1492                 findNextChange(this);
1493                 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1494                 dr.screenUpdate(Update::Force | Update::FitCursor);
1495                 break;
1496
1497         case LFUN_CHANGE_PREVIOUS:
1498                 findPreviousChange(this);
1499                 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1500                 dr.screenUpdate(Update::Force | Update::FitCursor);
1501                 break;
1502
1503         case LFUN_CHANGES_MERGE:
1504                 if (findNextChange(this) || findPreviousChange(this)) {
1505                         dr.screenUpdate(Update::Force | Update::FitCursor);
1506                         dr.forceBufferUpdate();
1507                         showDialog("changes");
1508                 }
1509                 break;
1510
1511         case LFUN_ALL_CHANGES_ACCEPT:
1512                 // select complete document
1513                 cur.reset();
1514                 cur.selHandle(true);
1515                 buffer_.text().cursorBottom(cur);
1516                 // accept everything in a single step to support atomic undo
1517                 buffer_.text().acceptOrRejectChanges(cur, Text::ACCEPT);
1518                 cur.resetAnchor();
1519                 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1520                 dr.screenUpdate(Update::Force | Update::FitCursor);
1521                 dr.forceBufferUpdate();
1522                 break;
1523
1524         case LFUN_ALL_CHANGES_REJECT:
1525                 // select complete document
1526                 cur.reset();
1527                 cur.selHandle(true);
1528                 buffer_.text().cursorBottom(cur);
1529                 // reject everything in a single step to support atomic undo
1530                 // Note: reject does not work recursively; the user may have to repeat the operation
1531                 buffer_.text().acceptOrRejectChanges(cur, Text::REJECT);
1532                 cur.resetAnchor();
1533                 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1534                 dr.screenUpdate(Update::Force | Update::FitCursor);
1535                 dr.forceBufferUpdate();
1536                 break;
1537
1538         case LFUN_WORD_FIND_FORWARD:
1539         case LFUN_WORD_FIND_BACKWARD: {
1540                 // FIXME THREAD
1541                 // Would it maybe be better if this variable were view specific anyway?
1542                 static docstring last_search;
1543                 docstring searched_string;
1544
1545                 if (!cmd.argument().empty()) {
1546                         last_search = cmd.argument();
1547                         searched_string = cmd.argument();
1548                 } else {
1549                         searched_string = last_search;
1550                 }
1551
1552                 if (searched_string.empty())
1553                         break;
1554
1555                 bool const fw = act == LFUN_WORD_FIND_FORWARD;
1556                 docstring const data =
1557                         find2string(searched_string, true, false, fw);
1558                 bool found = lyxfind(this, FuncRequest(LFUN_WORD_FIND, data));
1559                 if (found)
1560                         dr.screenUpdate(Update::Force | Update::FitCursor);
1561                 break;
1562         }
1563
1564         case LFUN_WORD_FIND: {
1565                 FuncRequest req = cmd;
1566                 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1567                         req = d->search_request_cache_;
1568                 if (req.argument().empty()) {
1569                         lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, "findreplace"));
1570                         break;
1571                 }
1572                 if (lyxfind(this, req))
1573                         dr.screenUpdate(Update::Force | Update::FitCursor);
1574
1575                 d->search_request_cache_ = req;
1576                 break;
1577         }
1578
1579         case LFUN_WORD_REPLACE: {
1580                 bool has_deleted = false;
1581                 if (cur.selection()) {
1582                         DocIterator beg = cur.selectionBegin();
1583                         DocIterator end = cur.selectionEnd();
1584                         if (beg.pit() == end.pit()) {
1585                                 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1586                                         if (!cur.inMathed() && cur.paragraph().isDeleted(p)) {
1587                                                 has_deleted = true;
1588                                                 break;
1589                                         }
1590                                 }
1591                         }
1592                 }
1593                 if (lyxreplace(this, cmd, has_deleted)) {
1594                         dr.forceBufferUpdate();
1595                         dr.screenUpdate(Update::Force | Update::FitCursor);
1596                 }
1597                 break;
1598         }
1599
1600         case LFUN_WORD_FINDADV: {
1601                 FindAndReplaceOptions opt;
1602                 istringstream iss(to_utf8(cmd.argument()));
1603                 iss >> opt;
1604                 if (findAdv(this, opt)) {
1605                         dr.screenUpdate(Update::Force | Update::FitCursor);
1606                         cur.dispatched();
1607                         dispatched = true;
1608                 } else {
1609                         cur.undispatched();
1610                         dispatched = false;
1611                 }
1612                 break;
1613         }
1614
1615         case LFUN_MARK_OFF:
1616                 cur.clearSelection();
1617                 dr.setMessage(from_utf8(N_("Mark off")));
1618                 break;
1619
1620         case LFUN_MARK_ON:
1621                 cur.clearSelection();
1622                 cur.setMark(true);
1623                 dr.setMessage(from_utf8(N_("Mark on")));
1624                 break;
1625
1626         case LFUN_MARK_TOGGLE:
1627                 cur.selection(false);
1628                 if (cur.mark()) {
1629                         cur.setMark(false);
1630                         dr.setMessage(from_utf8(N_("Mark removed")));
1631                 } else {
1632                         cur.setMark(true);
1633                         dr.setMessage(from_utf8(N_("Mark set")));
1634                 }
1635                 cur.resetAnchor();
1636                 break;
1637
1638         case LFUN_SCREEN_SHOW_CURSOR:
1639                 showCursor();
1640                 break;
1641
1642         case LFUN_SCREEN_RECENTER:
1643                 recenter();
1644                 break;
1645
1646         case LFUN_BIBTEX_DATABASE_ADD: {
1647                 Cursor tmpcur = cur;
1648                 findInset(tmpcur, BIBTEX_CODE, false);
1649                 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1650                                                 BIBTEX_CODE);
1651                 if (inset) {
1652                         if (inset->addDatabase(cmd.argument()))
1653                                 dr.forceBufferUpdate();
1654                 }
1655                 break;
1656         }
1657
1658         case LFUN_BIBTEX_DATABASE_DEL: {
1659                 Cursor tmpcur = cur;
1660                 findInset(tmpcur, BIBTEX_CODE, false);
1661                 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1662                                                 BIBTEX_CODE);
1663                 if (inset) {
1664                         if (inset->delDatabase(cmd.argument()))
1665                                 dr.forceBufferUpdate();
1666                 }
1667                 break;
1668         }
1669
1670         case LFUN_STATISTICS: {
1671                 DocIterator from, to;
1672                 if (cur.selection()) {
1673                         from = cur.selectionBegin();
1674                         to = cur.selectionEnd();
1675                 } else {
1676                         from = doc_iterator_begin(&buffer_);
1677                         to = doc_iterator_end(&buffer_);
1678                 }
1679                 buffer_.updateStatistics(from, to);
1680                 int const words = buffer_.wordCount();
1681                 int const chars = buffer_.charCount(false);
1682                 int const chars_blanks = buffer_.charCount(true);
1683                 docstring message;
1684                 if (cur.selection())
1685                         message = _("Statistics for the selection:");
1686                 else
1687                         message = _("Statistics for the document:");
1688                 message += "\n\n";
1689                 if (words != 1)
1690                         message += bformat(_("%1$d words"), words);
1691                 else
1692                         message += _("One word");
1693                 message += "\n";
1694                 if (chars_blanks != 1)
1695                         message += bformat(_("%1$d characters (including blanks)"),
1696                                           chars_blanks);
1697                 else
1698                         message += _("One character (including blanks)");
1699                 message += "\n";
1700                 if (chars != 1)
1701                         message += bformat(_("%1$d characters (excluding blanks)"),
1702                                           chars);
1703                 else
1704                         message += _("One character (excluding blanks)");
1705
1706                 Alert::information(_("Statistics"), message);
1707         }
1708                 break;
1709
1710         case LFUN_SCREEN_UP:
1711         case LFUN_SCREEN_DOWN: {
1712                 Point p = getPos(cur);
1713                 // This code has been commented out to enable to scroll down a
1714                 // document, even if there are large insets in it (see bug #5465).
1715                 /*if (p.y_ < 0 || p.y_ > height_) {
1716                         // The cursor is off-screen so recenter before proceeding.
1717                         showCursor();
1718                         p = getPos(cur);
1719                 }*/
1720                 int const scrolled = scroll(act == LFUN_SCREEN_UP
1721                         ? -height_ : height_);
1722                 if (act == LFUN_SCREEN_UP && scrolled > -height_)
1723                         p = Point(0, 0);
1724                 if (act == LFUN_SCREEN_DOWN && scrolled < height_)
1725                         p = Point(width_, height_);
1726                 bool const in_texted = cur.inTexted();
1727                 cur.setCursor(doc_iterator_begin(cur.buffer()));
1728                 cur.selHandle(false);
1729                 // Force an immediate computation of metrics because we need it below
1730                 processUpdateFlags(Update::Force);
1731
1732                 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_,
1733                         true, act == LFUN_SCREEN_UP);
1734                 //FIXME: what to do with cur.x_target()?
1735                 bool update = in_texted && cur.bv().checkDepm(cur, old);
1736                 cur.finishUndo();
1737
1738                 if (update || cur.mark())
1739                         dr.screenUpdate(Update::Force | Update::FitCursor);
1740                 if (update)
1741                         dr.forceBufferUpdate();
1742                 break;
1743         }
1744
1745         case LFUN_SCROLL: {
1746                 string const scroll_type = cmd.getArg(0);
1747                 int scroll_step = 0;
1748                 if (scroll_type == "line")
1749                         scroll_step = d->scrollbarParameters_.single_step;
1750                 else if (scroll_type == "page")
1751                         scroll_step = d->scrollbarParameters_.page_step;
1752                 else
1753                         return;
1754                 string const scroll_quantity = cmd.getArg(1);
1755                 if (scroll_quantity == "up")
1756                         scrollUp(scroll_step);
1757                 else if (scroll_quantity == "down")
1758                         scrollDown(scroll_step);
1759                 else {
1760                         int const scroll_value = convert<int>(scroll_quantity);
1761                         if (scroll_value)
1762                                 scroll(scroll_step * scroll_value);
1763                 }
1764                 dr.screenUpdate(Update::ForceDraw);
1765                 dr.forceBufferUpdate();
1766                 break;
1767         }
1768
1769         case LFUN_SCREEN_UP_SELECT: {
1770                 // FIXME: why is the algorithm different from LFUN_SCREEN_UP?
1771                 cur.selHandle(true);
1772                 if (isTopScreen()) {
1773                         lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1774                         cur.finishUndo();
1775                         break;
1776                 }
1777                 int y = getPos(cur).y_;
1778                 int const ymin = y - height_ + defaultRowHeight();
1779                 while (y > ymin && cur.up())
1780                         y = getPos(cur).y_;
1781
1782                 cur.finishUndo();
1783                 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1784                 break;
1785         }
1786
1787         case LFUN_SCREEN_DOWN_SELECT: {
1788                 // FIXME: why is the algorithm different from LFUN_SCREEN_DOWN?
1789                 cur.selHandle(true);
1790                 if (isBottomScreen()) {
1791                         lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1792                         cur.finishUndo();
1793                         break;
1794                 }
1795                 int y = getPos(cur).y_;
1796                 int const ymax = y + height_ - defaultRowHeight();
1797                 while (y < ymax && cur.down())
1798                         y = getPos(cur).y_;
1799
1800                 cur.finishUndo();
1801                 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1802                 break;
1803         }
1804
1805
1806         case LFUN_INSET_SELECT_ALL: {
1807                 // true if all cells are selected
1808                 bool const all_selected = cur.depth() > 1
1809                     && cur.selBegin().at_begin()
1810                     && cur.selEnd().at_end();
1811                 // true if some cells are selected
1812                 bool const cells_selected = cur.depth() > 1
1813                     && cur.selBegin().at_cell_begin()
1814                         && cur.selEnd().at_cell_end();
1815                 if (all_selected || (cells_selected && !cur.inset().isTable())) {
1816                         // All the contents of the inset if selected, or only at
1817                         // least one cell but inset is not a table.
1818                         // Select the inset from outside.
1819                         cur.pop();
1820                         cur.resetAnchor();
1821                         cur.selection(true);
1822                         cur.posForward();
1823                 } else if (cells_selected) {
1824                         // At least one complete cell is selected and inset is a table.
1825                         // Select all cells
1826                         cur.idx() = 0;
1827                         cur.pos() = 0;
1828                         cur.resetAnchor();
1829                         cur.selection(true);
1830                         cur.idx() = cur.lastidx();
1831                         cur.pos() = cur.lastpos();
1832                 } else {
1833                         // select current cell
1834                         cur.pit() = 0;
1835                         cur.pos() = 0;
1836                         cur.resetAnchor();
1837                         cur.selection(true);
1838                         cur.pit() = cur.lastpit();
1839                         cur.pos() = cur.lastpos();
1840                 }
1841                 cur.setCurrentFont();
1842                 dr.screenUpdate(Update::Force);
1843                 break;
1844         }
1845
1846
1847         // This would be in Buffer class if only Cursor did not
1848         // require a bufferview
1849         case LFUN_INSET_FORALL: {
1850                 docstring const name = from_utf8(cmd.getArg(0));
1851                 string const commandstr = cmd.getLongArg(1);
1852                 FuncRequest const fr = lyxaction.lookupFunc(commandstr);
1853
1854                 // an arbitrary number to limit number of iterations
1855                 const int max_iter = 100000;
1856                 int iterations = 0;
1857                 Cursor & cur = d->cursor_;
1858                 Cursor const savecur = cur;
1859                 cur.reset();
1860                 if (!cur.nextInset())
1861                         cur.forwardInset();
1862                 cur.beginUndoGroup();
1863                 while(cur && iterations < max_iter) {
1864                         Inset * const ins = cur.nextInset();
1865                         if (!ins)
1866                                 break;
1867                         docstring insname = ins->layoutName();
1868                         while (!insname.empty()) {
1869                                 if (insname == name || name == from_utf8("*")) {
1870                                         cur.recordUndo();
1871                                         lyx::dispatch(fr, dr);
1872                                         ++iterations;
1873                                         break;
1874                                 }
1875                                 size_t const i = insname.rfind(':');
1876                                 if (i == string::npos)
1877                                         break;
1878                                 insname = insname.substr(0, i);
1879                         }
1880                         // if we did not delete the inset, skip it
1881                         if (!cur.nextInset() || cur.nextInset() == ins)
1882                                 cur.forwardInset();
1883                 }
1884                 cur = savecur;
1885                 cur.fixIfBroken();
1886                 /** This is a dummy undo record only to remember the cursor
1887                  * that has just been set; this will be used on a redo action
1888                  * (see ticket #10097)
1889
1890                  * FIXME: a better fix would be to have a way to set the
1891                  * cursor value directly, but I am not sure it is worth it.
1892                  */
1893                 cur.recordUndo();
1894                 cur.endUndoGroup();
1895                 dr.screenUpdate(Update::Force);
1896                 dr.forceBufferUpdate();
1897
1898                 if (iterations >= max_iter) {
1899                         dr.setError(true);
1900                         dr.setMessage(bformat(_("`inset-forall' interrupted because number of actions is larger than %1$d"), max_iter));
1901                 } else
1902                         dr.setMessage(bformat(_("Applied \"%1$s\" to %2$d insets"), from_utf8(commandstr), iterations));
1903                 break;
1904         }
1905
1906
1907         case LFUN_BRANCH_ADD_INSERT: {
1908                 docstring branch_name = from_utf8(cmd.getArg(0));
1909                 if (branch_name.empty())
1910                         if (!Alert::askForText(branch_name, _("Branch name")) ||
1911                                                 branch_name.empty())
1912                                 break;
1913
1914                 DispatchResult drtmp;
1915                 buffer_.dispatch(FuncRequest(LFUN_BRANCH_ADD, branch_name), drtmp);
1916                 if (drtmp.error()) {
1917                         Alert::warning(_("Branch already exists"), drtmp.message());
1918                         break;
1919                 }
1920                 docstring const sep = buffer_.params().branchlist().separator();
1921                 for (docstring const & branch : getVectorFromString(branch_name, sep))
1922                         lyx::dispatch(FuncRequest(LFUN_BRANCH_INSERT, branch));
1923                 break;
1924         }
1925
1926         case LFUN_KEYMAP_OFF:
1927                 getIntl().keyMapOn(false);
1928                 break;
1929
1930         case LFUN_KEYMAP_PRIMARY:
1931                 getIntl().keyMapPrim();
1932                 break;
1933
1934         case LFUN_KEYMAP_SECONDARY:
1935                 getIntl().keyMapSec();
1936                 break;
1937
1938         case LFUN_KEYMAP_TOGGLE:
1939                 getIntl().toggleKeyMap();
1940                 break;
1941
1942         case LFUN_DIALOG_SHOW_NEW_INSET: {
1943                 string const name = cmd.getArg(0);
1944                 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
1945                 if (decodeInsetParam(name, data, buffer_))
1946                         lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
1947                 else
1948                         lyxerr << "Inset type '" << name <<
1949                         "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" <<  endl;
1950                 break;
1951         }
1952
1953         case LFUN_CITATION_INSERT: {
1954                 if (argument.empty()) {
1955                         lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
1956                         break;
1957                 }
1958                 // we can have one optional argument, delimited by '|'
1959                 // citation-insert <key>|<text_before>
1960                 // this should be enhanced to also support text_after
1961                 // and citation style
1962                 string arg = argument;
1963                 string opt1;
1964                 if (contains(argument, "|")) {
1965                         arg = token(argument, '|', 0);
1966                         opt1 = token(argument, '|', 1);
1967                 }
1968
1969                 // if our cursor is directly in front of or behind a citation inset,
1970                 // we will instead add the new key to it.
1971                 Inset * inset = cur.nextInset();
1972                 if (!inset || inset->lyxCode() != CITE_CODE)
1973                         inset = cur.prevInset();
1974                 if (inset && inset->lyxCode() == CITE_CODE) {
1975                         InsetCitation * icite = static_cast<InsetCitation *>(inset);
1976                         if (icite->addKey(arg)) {
1977                                 dr.forceBufferUpdate();
1978                                 dr.screenUpdate(Update::FitCursor | Update::SinglePar);
1979                                 if (!opt1.empty())
1980                                         LYXERR0("Discarding optional argument to citation-insert.");
1981                         }
1982                         dispatched = true;
1983                         break;
1984                 }
1985                 InsetCommandParams icp(CITE_CODE);
1986                 icp["key"] = from_utf8(arg);
1987                 if (!opt1.empty())
1988                         icp["before"] = from_utf8(opt1);
1989                 string icstr = InsetCommand::params2string(icp);
1990                 FuncRequest fr(LFUN_INSET_INSERT, icstr);
1991                 lyx::dispatch(fr);
1992                 break;
1993         }
1994
1995         case LFUN_INSET_APPLY: {
1996                 string const name = cmd.getArg(0);
1997                 Inset * inset = editedInset(name);
1998                 if (!inset) {
1999                         FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
2000                         lyx::dispatch(fr);
2001                         break;
2002                 }
2003                 // put cursor in front of inset.
2004                 if (!setCursorFromInset(inset)) {
2005                         LASSERT(false, break);
2006                 }
2007                 cur.recordUndo();
2008                 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
2009                 inset->dispatch(cur, fr);
2010                 dr.screenUpdate(cur.result().screenUpdate());
2011                 if (cur.result().needBufferUpdate())
2012                         dr.forceBufferUpdate();
2013                 break;
2014         }
2015
2016         // FIXME:
2017         // The change of language of buffer belongs to the Buffer class.
2018         // We have to do it here because we need a cursor for Undo.
2019         // When Undo::recordUndoBufferParams() is implemented someday
2020         // LFUN_BUFFER_LANGUAGE should be handled by the Buffer class.
2021         case LFUN_BUFFER_LANGUAGE: {
2022                 Language const * oldL = buffer_.params().language;
2023                 Language const * newL = languages.getLanguage(argument);
2024                 if (!newL || oldL == newL)
2025                         break;
2026                 if (oldL->rightToLeft() == newL->rightToLeft()) {
2027                         cur.recordUndoFullBuffer();
2028                         buffer_.changeLanguage(oldL, newL);
2029                         cur.setCurrentFont();
2030                         dr.forceBufferUpdate();
2031                 }
2032                 break;
2033         }
2034
2035         case LFUN_FILE_INSERT_PLAINTEXT_PARA:
2036         case LFUN_FILE_INSERT_PLAINTEXT: {
2037                 bool const as_paragraph = (act == LFUN_FILE_INSERT_PLAINTEXT_PARA);
2038                 string const fname = to_utf8(cmd.argument());
2039                 if (!FileName::isAbsolute(fname))
2040                         dr.setMessage(_("Absolute filename expected."));
2041                 else
2042                         insertPlaintextFile(FileName(fname), as_paragraph);
2043                 break;
2044         }
2045
2046         default:
2047                 // OK, so try the Buffer itself...
2048                 buffer_.dispatch(cmd, dr);
2049                 dispatched = dr.dispatched();
2050                 break;
2051         }
2052
2053         buffer_.undo().endUndoGroup();
2054         dr.dispatched(dispatched);
2055
2056         // NOTE: The code below is copied from Cursor::dispatch. If you
2057         // need to modify this, please update the other one too.
2058
2059         // notify insets we just entered/left
2060         if (cursor() != old) {
2061                 old.beginUndoGroup();
2062                 old.fixIfBroken();
2063                 bool badcursor = notifyCursorLeavesOrEnters(old, cursor());
2064                 if (badcursor) {
2065                         cursor().fixIfBroken();
2066                         resetInlineCompletionPos();
2067                 }
2068                 old.endUndoGroup();
2069         }
2070 }
2071
2072
2073 docstring const BufferView::requestSelection()
2074 {
2075         Cursor & cur = d->cursor_;
2076
2077         LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
2078         if (!cur.selection()) {
2079                 d->xsel_cache_.set = false;
2080                 return docstring();
2081         }
2082
2083         LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
2084         if (!d->xsel_cache_.set ||
2085             cur.top() != d->xsel_cache_.cursor ||
2086             cur.realAnchor().top() != d->xsel_cache_.anchor)
2087         {
2088                 d->xsel_cache_.cursor = cur.top();
2089                 d->xsel_cache_.anchor = cur.realAnchor().top();
2090                 d->xsel_cache_.set = cur.selection();
2091                 return cur.selectionAsString(false);
2092         }
2093         return docstring();
2094 }
2095
2096
2097 void BufferView::clearSelection()
2098 {
2099         d->cursor_.clearSelection();
2100         // Clear the selection buffer. Otherwise a subsequent
2101         // middle-mouse-button paste would use the selection buffer,
2102         // not the more current external selection.
2103         cap::clearSelection();
2104         d->xsel_cache_.set = false;
2105         // The buffer did not really change, but this causes the
2106         // redraw we need because we cleared the selection above.
2107         buffer_.changed(false);
2108 }
2109
2110
2111 void BufferView::resize(int width, int height)
2112 {
2113         // Update from work area
2114         width_ = width;
2115         height_ = height;
2116
2117         // Clear the paragraph height cache.
2118         d->par_height_.clear();
2119         // Redo the metrics.
2120         updateMetrics();
2121 }
2122
2123
2124 Inset const * BufferView::getCoveringInset(Text const & text,
2125                 int x, int y) const
2126 {
2127         TextMetrics & tm = d->text_metrics_[&text];
2128         Inset * inset = tm.checkInsetHit(x, y);
2129         if (!inset)
2130                 return 0;
2131
2132         if (!inset->descendable(*this))
2133                 // No need to go further down if the inset is not
2134                 // descendable.
2135                 return inset;
2136
2137         size_t cell_number = inset->nargs();
2138         // Check all the inner cell.
2139         for (size_t i = 0; i != cell_number; ++i) {
2140                 Text const * inner_text = inset->getText(i);
2141                 if (inner_text) {
2142                         // Try deeper.
2143                         Inset const * inset_deeper =
2144                                 getCoveringInset(*inner_text, x, y);
2145                         if (inset_deeper)
2146                                 return inset_deeper;
2147                 }
2148         }
2149
2150         return inset;
2151 }
2152
2153
2154 void BufferView::updateHoveredInset() const
2155 {
2156         // Get inset under mouse, if there is one.
2157         int const x = d->mouse_position_cache_.x_;
2158         int const y = d->mouse_position_cache_.y_;
2159         Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
2160
2161         d->clickable_inset_ = covering_inset && covering_inset->clickable(*this, x, y);
2162
2163         if (covering_inset == d->last_inset_)
2164                 // Same inset, no need to do anything...
2165                 return;
2166
2167         bool need_redraw = false;
2168         if (d->last_inset_) {
2169                 // Remove the hint on the last hovered inset (if any).
2170                 need_redraw |= d->last_inset_->setMouseHover(this, false);
2171                 d->last_inset_ = 0;
2172         }
2173
2174         if (covering_inset && covering_inset->setMouseHover(this, true)) {
2175                 need_redraw = true;
2176                 // Only the insets that accept the hover state, do
2177                 // clear the last_inset_, so only set the last_inset_
2178                 // member if the hovered setting is accepted.
2179                 d->last_inset_ = covering_inset;
2180         }
2181
2182         if (need_redraw) {
2183                 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
2184                                 << d->mouse_position_cache_.x_ << ", "
2185                                 << d->mouse_position_cache_.y_ << ")");
2186
2187                 d->update_strategy_ = DecorationUpdate;
2188
2189                 // This event (moving without mouse click) is not passed further.
2190                 // This should be changed if it is further utilized.
2191                 buffer_.changed(false);
2192         }
2193 }
2194
2195
2196 void BufferView::clearLastInset(Inset * inset) const
2197 {
2198         if (d->last_inset_ != inset) {
2199                 LYXERR0("Wrong last_inset!");
2200                 LATTEST(false);
2201         }
2202         d->last_inset_ = 0;
2203 }
2204
2205
2206 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
2207 {
2208         //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
2209
2210         // This is only called for mouse related events including
2211         // LFUN_FILE_OPEN generated by drag-and-drop.
2212         FuncRequest cmd = cmd0;
2213
2214         Cursor old = cursor();
2215         Cursor cur(*this);
2216         cur.push(buffer_.inset());
2217         cur.selection(d->cursor_.selection());
2218
2219         // Either the inset under the cursor or the
2220         // surrounding Text will handle this event.
2221
2222         // make sure we stay within the screen...
2223         cmd.set_y(min(max(cmd.y(), -1), height_));
2224
2225         d->mouse_position_cache_.x_ = cmd.x();
2226         d->mouse_position_cache_.y_ = cmd.y();
2227
2228         if (cmd.action() == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
2229                 updateHoveredInset();
2230                 return;
2231         }
2232
2233         // Build temporary cursor.
2234         Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x(), cmd.y());
2235         if (inset) {
2236                 // If inset is not editable, cur.pos() might point behind the
2237                 // inset (depending on cmd.x(), cmd.y()). This is needed for
2238                 // editing to fix bug 9628, but e.g. the context menu needs a
2239                 // cursor in front of the inset.
2240                 if ((inset->hasSettings() || !inset->contextMenuName().empty()
2241                      || inset->lyxCode() == SEPARATOR_CODE) &&
2242                     cur.nextInset() != inset && cur.prevInset() == inset)
2243                         cur.posBackward();
2244         } else if (cur.inTexted() && cur.pos()
2245                         && cur.paragraph().isEnvSeparator(cur.pos() - 1)) {
2246                 // Always place cursor in front of a separator inset.
2247                 cur.posBackward();
2248         }
2249
2250         // Put anchor at the same position.
2251         cur.resetAnchor();
2252
2253         cur.beginUndoGroup();
2254
2255         // Try to dispatch to an non-editable inset near this position
2256         // via the temp cursor. If the inset wishes to change the real
2257         // cursor it has to do so explicitly by using
2258         //  cur.bv().cursor() = cur;  (or similar)
2259         if (inset)
2260                 inset->dispatch(cur, cmd);
2261
2262         // Now dispatch to the temporary cursor. If the real cursor should
2263         // be modified, the inset's dispatch has to do so explicitly.
2264         if (!inset || !cur.result().dispatched())
2265                 cur.dispatch(cmd);
2266
2267         // Notify left insets
2268         if (cur != old) {
2269                 bool badcursor = old.fixIfBroken() | cur.fixIfBroken();
2270                 badcursor |= notifyCursorLeavesOrEnters(old, cur);
2271                 if (badcursor)
2272                         cursor().fixIfBroken();
2273         }
2274
2275         cur.endUndoGroup();
2276
2277         // Do we have a selection?
2278         theSelection().haveSelection(cursor().selection());
2279
2280         if (cur.needBufferUpdate()) {
2281                 cur.clearBufferUpdate();
2282                 buffer().updateBuffer();
2283         }
2284
2285         // If the command has been dispatched,
2286         if (cur.result().dispatched() || cur.result().screenUpdate())
2287                 processUpdateFlags(cur.result().screenUpdate());
2288 }
2289
2290
2291 int BufferView::minVisiblePart()
2292 {
2293         return 2 * defaultRowHeight();
2294 }
2295
2296
2297 int BufferView::scroll(int y)
2298 {
2299         if (y > 0)
2300                 return scrollDown(y);
2301         if (y < 0)
2302                 return scrollUp(-y);
2303         return 0;
2304 }
2305
2306
2307 int BufferView::scrollDown(int offset)
2308 {
2309         Text * text = &buffer_.text();
2310         TextMetrics & tm = d->text_metrics_[text];
2311         int const ymax = height_ + offset;
2312         while (true) {
2313                 pair<pit_type, ParagraphMetrics const *> last = tm.last();
2314                 int bottom_pos = last.second->position() + last.second->descent();
2315                 if (lyxrc.scroll_below_document)
2316                         bottom_pos += height_ - minVisiblePart();
2317                 if (last.first + 1 == int(text->paragraphs().size())) {
2318                         if (bottom_pos <= height_)
2319                                 return 0;
2320                         offset = min(offset, bottom_pos - height_);
2321                         break;
2322                 }
2323                 if (bottom_pos > ymax)
2324                         break;
2325                 tm.newParMetricsDown();
2326         }
2327         d->anchor_ypos_ -= offset;
2328         return -offset;
2329 }
2330
2331
2332 int BufferView::scrollUp(int offset)
2333 {
2334         Text * text = &buffer_.text();
2335         TextMetrics & tm = d->text_metrics_[text];
2336         int ymin = - offset;
2337         while (true) {
2338                 pair<pit_type, ParagraphMetrics const *> first = tm.first();
2339                 int top_pos = first.second->position() - first.second->ascent();
2340                 if (first.first == 0) {
2341                         if (top_pos >= 0)
2342                                 return 0;
2343                         offset = min(offset, - top_pos);
2344                         break;
2345                 }
2346                 if (top_pos < ymin)
2347                         break;
2348                 tm.newParMetricsUp();
2349         }
2350         d->anchor_ypos_ += offset;
2351         return offset;
2352 }
2353
2354
2355 bool BufferView::setCursorFromRow(int row)
2356 {
2357         TexRow::TextEntry start, end;
2358         tie(start,end) = buffer_.texrow().getEntriesFromRow(row);
2359         LYXERR(Debug::LATEX,
2360                "setCursorFromRow: for row " << row << ", TexRow has found "
2361                "start (id=" << start.id << ",pos=" << start.pos << "), "
2362                "end (id=" << end.id << ",pos=" << end.pos << ")");
2363         return setCursorFromEntries(start, end);
2364 }
2365
2366
2367 bool BufferView::setCursorFromEntries(TexRow::TextEntry start,
2368                                       TexRow::TextEntry end)
2369 {
2370         DocIterator dit_start, dit_end;
2371         tie(dit_start,dit_end) =
2372                 TexRow::getDocIteratorsFromEntries(start, end, buffer_);
2373         if (!dit_start)
2374                 return false;
2375         // Setting selection start
2376         d->cursor_.clearSelection();
2377         setCursor(dit_start);
2378         // Setting selection end
2379         if (dit_end) {
2380                 d->cursor_.resetAnchor();
2381                 setCursorSelectionTo(dit_end);
2382         }
2383         return true;
2384 }
2385
2386
2387 bool BufferView::setCursorFromInset(Inset const * inset)
2388 {
2389         // are we already there?
2390         if (cursor().nextInset() == inset)
2391                 return true;
2392
2393         // Inset is not at cursor position. Find it in the document.
2394         Cursor cur(*this);
2395         cur.reset();
2396         while (cur && cur.nextInset() != inset)
2397                 cur.forwardInset();
2398
2399         if (cur) {
2400                 setCursor(cur);
2401                 return true;
2402         }
2403         return false;
2404 }
2405
2406
2407 void BufferView::gotoLabel(docstring const & label)
2408 {
2409         for (Buffer const * buf : buffer().allRelatives()) {
2410                 // find label
2411                 for (TocItem const & item : *buf->tocBackend().toc("label")) {
2412                         if (label == item.str()) {
2413                                 lyx::dispatch(item.action());
2414                                 return;
2415                         }
2416                 }
2417         }
2418 }
2419
2420
2421 TextMetrics const & BufferView::textMetrics(Text const * t) const
2422 {
2423         return const_cast<BufferView *>(this)->textMetrics(t);
2424 }
2425
2426
2427 TextMetrics & BufferView::textMetrics(Text const * t)
2428 {
2429         LBUFERR(t);
2430         TextMetricsCache::iterator tmc_it  = d->text_metrics_.find(t);
2431         if (tmc_it == d->text_metrics_.end()) {
2432                 tmc_it = d->text_metrics_.insert(
2433                         make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
2434         }
2435         return tmc_it->second;
2436 }
2437
2438
2439 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
2440                 pit_type pit) const
2441 {
2442         return textMetrics(t).parMetrics(pit);
2443 }
2444
2445
2446 int BufferView::workHeight() const
2447 {
2448         return height_;
2449 }
2450
2451
2452 void BufferView::setCursor(DocIterator const & dit)
2453 {
2454         d->cursor_.reset();
2455         size_t const n = dit.depth();
2456         for (size_t i = 0; i < n; ++i)
2457                 dit[i].inset().edit(d->cursor_, true);
2458
2459         d->cursor_.setCursor(dit);
2460         d->cursor_.selection(false);
2461         d->cursor_.setCurrentFont();
2462         // FIXME
2463         // It seems on general grounds as if this is probably needed, but
2464         // it is not yet clear.
2465         // See bug #7394 and r38388.
2466         // d->cursor.resetAnchor();
2467 }
2468
2469
2470 void BufferView::setCursorSelectionTo(DocIterator const & dit)
2471 {
2472         size_t const n = dit.depth();
2473         for (size_t i = 0; i < n; ++i)
2474                 dit[i].inset().edit(d->cursor_, true);
2475
2476         d->cursor_.selection(true);
2477         d->cursor_.setCursorSelectionTo(dit);
2478         d->cursor_.setCurrentFont();
2479 }
2480
2481
2482 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
2483 {
2484         // Would be wrong to delete anything if we have a selection.
2485         if (cur.selection())
2486                 return false;
2487
2488         bool need_anchor_change = false;
2489         bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
2490                 need_anchor_change);
2491
2492         if (need_anchor_change)
2493                 cur.resetAnchor();
2494
2495         if (!changed)
2496                 return false;
2497
2498         d->cursor_ = cur;
2499
2500         // we would rather not do this here, but it needs to be done before
2501         // the changed() signal is sent.
2502         buffer_.updateBuffer();
2503
2504         buffer_.changed(true);
2505         return true;
2506 }
2507
2508
2509 bool BufferView::mouseSetCursor(Cursor & cur, bool const select)
2510 {
2511         LASSERT(&cur.bv() == this, return false);
2512
2513         if (!select)
2514                 // this event will clear selection so we save selection for
2515                 // persistent selection
2516                 cap::saveSelection(cursor());
2517
2518         d->cursor_.macroModeClose();
2519         // If a macro has been finalized, the cursor might have been broken
2520         cur.fixIfBroken();
2521
2522         // Has the cursor just left the inset?
2523         bool const leftinset = (&d->cursor_.inset() != &cur.inset());
2524         if (leftinset)
2525                 d->cursor_.fixIfBroken();
2526
2527         // do the dEPM magic if needed
2528         // FIXME: (1) move this to InsetText::notifyCursorLeaves?
2529         // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
2530         // the leftinset bool would not be necessary (badcursor instead).
2531         bool update = leftinset;
2532
2533         if (select) {
2534                 d->cursor_.setSelection();
2535                 d->cursor_.setCursorSelectionTo(cur);
2536         } else {
2537                 if (d->cursor_.inTexted())
2538                         update |= checkDepm(cur, d->cursor_);
2539                 d->cursor_.resetAnchor();
2540                 d->cursor_.setCursor(cur);
2541                 d->cursor_.clearSelection();
2542         }
2543         d->cursor_.boundary(cur.boundary());
2544         d->cursor_.finishUndo();
2545         d->cursor_.setCurrentFont();
2546         if (update)
2547                 cur.forceBufferUpdate();
2548         return update;
2549 }
2550
2551
2552 void BufferView::putSelectionAt(DocIterator const & cur,
2553                                 int length, bool backwards)
2554 {
2555         d->cursor_.clearSelection();
2556
2557         setCursor(cur);
2558
2559         if (length) {
2560                 if (backwards) {
2561                         d->cursor_.pos() += length;
2562                         d->cursor_.setSelection(d->cursor_, -length);
2563                 } else
2564                         d->cursor_.setSelection(d->cursor_, length);
2565         }
2566 }
2567
2568
2569 bool BufferView::selectIfEmpty(DocIterator & cur)
2570 {
2571         if ((cur.inTexted() && !cur.paragraph().empty())
2572             || (cur.inMathed() && !cur.cell().empty()))
2573                 return false;
2574
2575         pit_type const beg_pit = cur.pit();
2576         if (beg_pit > 0) {
2577                 // The paragraph associated to this item isn't
2578                 // the first one, so it can be selected
2579                 cur.backwardPos();
2580         } else {
2581                 // We have to resort to select the space between the
2582                 // end of this item and the begin of the next one
2583                 cur.forwardPos();
2584         }
2585         if (cur.empty()) {
2586                 // If it is the only item in the document,
2587                 // nothing can be selected
2588                 return false;
2589         }
2590         pit_type const end_pit = cur.pit();
2591         pos_type const end_pos = cur.pos();
2592         d->cursor_.clearSelection();
2593         d->cursor_.reset();
2594         d->cursor_.setCursor(cur);
2595         d->cursor_.pit() = beg_pit;
2596         d->cursor_.pos() = 0;
2597         d->cursor_.selection(false);
2598         d->cursor_.resetAnchor();
2599         d->cursor_.pit() = end_pit;
2600         d->cursor_.pos() = end_pos;
2601         d->cursor_.setSelection();
2602         return true;
2603 }
2604
2605
2606 Cursor & BufferView::cursor()
2607 {
2608         return d->cursor_;
2609 }
2610
2611
2612 Cursor const & BufferView::cursor() const
2613 {
2614         return d->cursor_;
2615 }
2616
2617
2618 bool BufferView::singleParUpdate()
2619 {
2620         Text & buftext = buffer_.text();
2621         pit_type const bottom_pit = d->cursor_.bottom().pit();
2622         TextMetrics & tm = textMetrics(&buftext);
2623         int old_height = tm.parMetrics(bottom_pit).height();
2624
2625         // make sure inline completion pointer is ok
2626         if (d->inlineCompletionPos_.fixIfBroken())
2627                 d->inlineCompletionPos_ = DocIterator();
2628
2629         // In Single Paragraph mode, rebreak only
2630         // the (main text, not inset!) paragraph containing the cursor.
2631         // (if this paragraph contains insets etc., rebreaking will
2632         // recursively descend)
2633         tm.redoParagraph(bottom_pit);
2634         ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
2635         if (pm.height() != old_height)
2636                 // Paragraph height has changed so we cannot proceed to
2637                 // the singlePar optimisation.
2638                 return false;
2639
2640         tm.updatePosCache(bottom_pit);
2641
2642         LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
2643                 << " y2: " << pm.position() + pm.descent()
2644                 << " pit: " << bottom_pit
2645                 << " singlepar: 1");
2646         return true;
2647 }
2648
2649
2650 void BufferView::updateMetrics()
2651 {
2652         updateMetrics(d->update_flags_);
2653         d->update_strategy_ = FullScreenUpdate;
2654 }
2655
2656
2657 void BufferView::updateMetrics(Update::flags & update_flags)
2658 {
2659         if (height_ == 0 || width_ == 0)
2660                 return;
2661
2662         Text & buftext = buffer_.text();
2663         pit_type const npit = int(buftext.paragraphs().size());
2664
2665         // Clear out the position cache in case of full screen redraw,
2666         d->coord_cache_.clear();
2667
2668         // Clear out paragraph metrics to avoid having invalid metrics
2669         // in the cache from paragraphs not relayouted below
2670         // The complete text metrics will be redone.
2671         d->text_metrics_.clear();
2672
2673         TextMetrics & tm = textMetrics(&buftext);
2674
2675         // make sure inline completion pointer is ok
2676         if (d->inlineCompletionPos_.fixIfBroken())
2677                 d->inlineCompletionPos_ = DocIterator();
2678
2679         if (d->anchor_pit_ >= npit)
2680                 // The anchor pit must have been deleted...
2681                 d->anchor_pit_ = npit - 1;
2682
2683         // Rebreak anchor paragraph.
2684         tm.redoParagraph(d->anchor_pit_);
2685         ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
2686
2687         // position anchor
2688         if (d->anchor_pit_ == 0) {
2689                 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
2690
2691                 // Complete buffer visible? Then it's easy.
2692                 if (scrollRange == 0)
2693                         d->anchor_ypos_ = anchor_pm.ascent();
2694                 else {
2695                         // avoid empty space above the first row
2696                         d->anchor_ypos_ = min(d->anchor_ypos_, anchor_pm.ascent());
2697                 }
2698         }
2699         anchor_pm.setPosition(d->anchor_ypos_);
2700         tm.updatePosCache(d->anchor_pit_);
2701
2702         LYXERR(Debug::PAINTING, "metrics: "
2703                 << " anchor pit = " << d->anchor_pit_
2704                 << " anchor ypos = " << d->anchor_ypos_);
2705
2706         // Redo paragraphs above anchor if necessary.
2707         int y1 = d->anchor_ypos_ - anchor_pm.ascent();
2708         // We are now just above the anchor paragraph.
2709         pit_type pit1 = d->anchor_pit_ - 1;
2710         for (; pit1 >= 0 && y1 >= 0; --pit1) {
2711                 tm.redoParagraph(pit1);
2712                 ParagraphMetrics & pm = tm.par_metrics_[pit1];
2713                 y1 -= pm.descent();
2714                 // Save the paragraph position in the cache.
2715                 pm.setPosition(y1);
2716                 tm.updatePosCache(pit1);
2717                 y1 -= pm.ascent();
2718         }
2719
2720         // Redo paragraphs below the anchor if necessary.
2721         int y2 = d->anchor_ypos_ + anchor_pm.descent();
2722         // We are now just below the anchor paragraph.
2723         pit_type pit2 = d->anchor_pit_ + 1;
2724         for (; pit2 < npit && y2 <= height_; ++pit2) {
2725                 tm.redoParagraph(pit2);
2726                 ParagraphMetrics & pm = tm.par_metrics_[pit2];
2727                 y2 += pm.ascent();
2728                 // Save the paragraph position in the cache.
2729                 pm.setPosition(y2);
2730                 tm.updatePosCache(pit2);
2731                 y2 += pm.descent();
2732         }
2733
2734         LYXERR(Debug::PAINTING, "Metrics: "
2735                 << " anchor pit = " << d->anchor_pit_
2736                 << " anchor ypos = " << d->anchor_ypos_
2737                 << " y1 = " << y1
2738                 << " y2 = " << y2
2739                 << " pit1 = " << pit1
2740                 << " pit2 = " << pit2);
2741
2742         // metrics is done, full drawing is necessary now
2743         update_flags = (update_flags & ~Update::Force) | Update::ForceDraw;
2744
2745         // Now update the positions of insets in the cache.
2746         updatePosCache();
2747
2748         if (lyxerr.debugging(Debug::WORKAREA)) {
2749                 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
2750                 d->coord_cache_.dump();
2751         }
2752 }
2753
2754
2755 void BufferView::updatePosCache()
2756 {
2757         // this is the "nodraw" drawing stage: only set the positions of the
2758         // insets in metrics cache.
2759         frontend::NullPainter np;
2760         draw(np, false);
2761 }
2762
2763
2764 void BufferView::insertLyXFile(FileName const & fname)
2765 {
2766         LASSERT(d->cursor_.inTexted(), return);
2767
2768         // Get absolute path of file and add ".lyx"
2769         // to the filename if necessary
2770         FileName filename = fileSearch(string(), fname.absFileName(), "lyx");
2771
2772         docstring const disp_fn = makeDisplayPath(filename.absFileName());
2773         // emit message signal.
2774         message(bformat(_("Inserting document %1$s..."), disp_fn));
2775
2776         docstring res;
2777         Buffer buf(filename.absFileName(), false);
2778         if (buf.loadLyXFile() == Buffer::ReadSuccess) {
2779                 ErrorList & el = buffer_.errorList("Parse");
2780                 // Copy the inserted document error list into the current buffer one.
2781                 el = buf.errorList("Parse");
2782                 buffer_.undo().recordUndo(d->cursor_);
2783                 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
2784                                              buf.params().documentClassPtr(), el);
2785                 res = _("Document %1$s inserted.");
2786         } else {
2787                 res = _("Could not insert document %1$s");
2788         }
2789
2790         buffer_.changed(true);
2791         // emit message signal.
2792         message(bformat(res, disp_fn));
2793 }
2794
2795
2796 Point BufferView::coordOffset(DocIterator const & dit) const
2797 {
2798         int x = 0;
2799         int y = 0;
2800         int lastw = 0;
2801
2802         // Addup contribution of nested insets, from inside to outside,
2803         // keeping the outer paragraph for a special handling below
2804         for (size_t i = dit.depth() - 1; i >= 1; --i) {
2805                 CursorSlice const & sl = dit[i];
2806                 int xx = 0;
2807                 int yy = 0;
2808
2809                 // get relative position inside sl.inset()
2810                 sl.inset().cursorPos(*this, sl, dit.boundary() && (i + 1 == dit.depth()), xx, yy);
2811
2812                 // Make relative position inside of the edited inset relative to sl.inset()
2813                 x += xx;
2814                 y += yy;
2815
2816                 // In case of an RTL inset, the edited inset will be positioned to the left
2817                 // of xx:yy
2818                 if (sl.text()) {
2819                         bool boundary_i = dit.boundary() && i + 1 == dit.depth();
2820                         bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2821                         if (rtl)
2822                                 x -= lastw;
2823                 }
2824
2825                 // remember width for the case that sl.inset() is positioned in an RTL inset
2826                 lastw = sl.inset().dimension(*this).wid;
2827
2828                 //lyxerr << "Cursor::getPos, i: "
2829                 // << i << " x: " << xx << " y: " << y << endl;
2830         }
2831
2832         // Add contribution of initial rows of outermost paragraph
2833         CursorSlice const & sl = dit[0];
2834         TextMetrics const & tm = textMetrics(sl.text());
2835         ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2836
2837         LBUFERR(!pm.rows().empty());
2838         y -= pm.rows()[0].ascent();
2839 #if 1
2840         // FIXME: document this mess
2841         size_t rend;
2842         if (sl.pos() > 0 && dit.depth() == 1) {
2843                 int pos = sl.pos();
2844                 if (pos && dit.boundary())
2845                         --pos;
2846 //              lyxerr << "coordOffset: boundary:" << dit.boundary() << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
2847                 rend = pm.pos2row(pos);
2848         } else
2849                 rend = pm.pos2row(sl.pos());
2850 #else
2851         size_t rend = pm.pos2row(sl.pos());
2852 #endif
2853         for (size_t rit = 0; rit != rend; ++rit)
2854                 y += pm.rows()[rit].height();
2855         y += pm.rows()[rend].ascent();
2856
2857         TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
2858
2859         // Make relative position from the nested inset now bufferview absolute.
2860         int xx = bottom_tm.cursorX(dit.bottom(), dit.boundary() && dit.depth() == 1);
2861         x += xx;
2862
2863         // In the RTL case place the nested inset at the left of the cursor in
2864         // the outer paragraph
2865         bool boundary_1 = dit.boundary() && 1 == dit.depth();
2866         bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
2867         if (rtl)
2868                 x -= lastw;
2869
2870         return Point(x, y);
2871 }
2872
2873
2874 Point BufferView::getPos(DocIterator const & dit) const
2875 {
2876         if (!paragraphVisible(dit))
2877                 return Point(-1, -1);
2878
2879         CursorSlice const & bot = dit.bottom();
2880         TextMetrics const & tm = textMetrics(bot.text());
2881
2882         // offset from outer paragraph
2883         Point p = coordOffset(dit);
2884         p.y_ += tm.parMetrics(bot.pit()).position();
2885         return p;
2886 }
2887
2888
2889 bool BufferView::paragraphVisible(DocIterator const & dit) const
2890 {
2891         CursorSlice const & bot = dit.bottom();
2892         TextMetrics const & tm = textMetrics(bot.text());
2893
2894         return tm.contains(bot.pit());
2895 }
2896
2897
2898 void BufferView::caretPosAndHeight(Point & p, int & h) const
2899 {
2900         Cursor const & cur = cursor();
2901         Font const font = cur.real_current_font;
2902         frontend::FontMetrics const & fm = theFontMetrics(font);
2903         int const asc = fm.maxAscent();
2904         int const des = fm.maxDescent();
2905         h = asc + des;
2906         p = getPos(cur);
2907         p.y_ -= asc;
2908 }
2909
2910
2911 bool BufferView::cursorInView(Point const & p, int h) const
2912 {
2913         Cursor const & cur = cursor();
2914         // does the cursor touch the screen ?
2915         if (p.y_ + h < 0 || p.y_ >= workHeight() || !paragraphVisible(cur))
2916                 return false;
2917         return true;
2918 }
2919
2920
2921 int BufferView::horizScrollOffset() const
2922 {
2923         return d->horiz_scroll_offset_;
2924 }
2925
2926
2927 int BufferView::horizScrollOffset(Text const * text,
2928                                   pit_type pit, pos_type pos) const
2929 {
2930         // Is this a row that is currently scrolled?
2931         if (!d->current_row_slice_.empty()
2932             && &text->inset() == d->current_row_slice_.inset().asInsetText()
2933             && pit ==  d->current_row_slice_.pit()
2934             && pos ==  d->current_row_slice_.pos())
2935                 return d->horiz_scroll_offset_;
2936         return 0;
2937 }
2938
2939
2940 bool BufferView::hadHorizScrollOffset(Text const * text,
2941                                       pit_type pit, pos_type pos) const
2942 {
2943         return !d->last_row_slice_.empty()
2944                && &text->inset() == d->last_row_slice_.inset().asInsetText()
2945                && pit ==  d->last_row_slice_.pit()
2946                && pos ==  d->last_row_slice_.pos();
2947 }
2948
2949
2950 void BufferView::setCurrentRowSlice(CursorSlice const & rowSlice)
2951 {
2952         // nothing to do if the cursor was already on this row
2953         if (d->current_row_slice_ == rowSlice) {
2954                 d->last_row_slice_ = CursorSlice();
2955                 return;
2956         }
2957
2958         // if the (previous) current row was scrolled, we have to
2959         // remember it in order to repaint it next time.
2960         if (d->horiz_scroll_offset_ != 0)
2961                 d->last_row_slice_ = d->current_row_slice_;
2962         else
2963                 d->last_row_slice_ = CursorSlice();
2964
2965         // Since we changed row, the scroll offset is not valid anymore
2966         d->horiz_scroll_offset_ = 0;
2967         d->current_row_slice_ = rowSlice;
2968 }
2969
2970
2971 namespace {
2972
2973 bool sliceInRow(CursorSlice const & cs, Text const * text, Row const & row)
2974 {
2975         /* The normal case is the last line. The previous line takes care
2976          * of empty rows (e.g. empty paragraphs). Cursor boundary issues
2977          * are taken care of when setting caret_slice_ in
2978          * BufferView::draw.
2979          */
2980         return !cs.empty() && cs.text() == text && cs.pit() == row.pit()
2981                && ((row.pos() == row.endpos() && row.pos() == cs.pos())
2982                   || (row.pos() <= cs.pos() && cs.pos() < row.endpos()));
2983 }
2984
2985 }
2986
2987
2988 bool BufferView::needRepaint(Text const * text, Row const & row) const
2989 {
2990         return d->repaint_caret_row_ && sliceInRow(d->caret_slice_, text, row);
2991 }
2992
2993
2994 void BufferView::checkCursorScrollOffset()
2995 {
2996         CursorSlice rowSlice = d->cursor_.bottom();
2997         TextMetrics const & tm = textMetrics(rowSlice.text());
2998
2999         // Stop if metrics have not been computed yet, since it means
3000         // that there is nothing to do.
3001         if (!tm.contains(rowSlice.pit()))
3002                 return;
3003         ParagraphMetrics const & pm = tm.parMetrics(rowSlice.pit());
3004         Row const & row = pm.getRow(rowSlice.pos(),
3005                                     d->cursor_.boundary() && rowSlice == d->cursor_.top());
3006         rowSlice.pos() = row.pos();
3007
3008         // Set the row on which the cursor lives.
3009         setCurrentRowSlice(rowSlice);
3010
3011         // Current x position of the cursor in pixels
3012         int cur_x = getPos(d->cursor_).x_;
3013
3014         // Horizontal scroll offset of the cursor row in pixels
3015         int offset = d->horiz_scroll_offset_;
3016         int const MARGIN = 2 * theFontMetrics(d->cursor_.real_current_font).em()
3017                            + row.right_margin;
3018         if (row.right_x() <= workWidth() - row.right_margin) {
3019                 // Row is narrower than the work area, no offset needed.
3020                 offset = 0;
3021         } else {
3022                 if (cur_x - offset < MARGIN) {
3023                         // cursor would be too far right
3024                         offset = cur_x - MARGIN;
3025                 } else if (cur_x - offset > workWidth() - MARGIN) {
3026                         // cursor would be too far left
3027                         offset = cur_x - workWidth() + MARGIN;
3028                 }
3029                 // Correct the offset to make sure that we do not scroll too much
3030                 if (offset < 0)
3031                         offset = 0;
3032                 if (row.right_x() - offset < workWidth() - row.right_margin)
3033                         offset = row.right_x() - workWidth() + row.right_margin;
3034         }
3035
3036         //lyxerr << "cur_x=" << cur_x << ", offset=" << offset << ", row.wid=" << row.width() << ", margin=" << MARGIN << endl;
3037
3038         if (offset != d->horiz_scroll_offset_)
3039                 LYXERR(Debug::PAINTING, "Horiz. scroll offset changed from "
3040                        << d->horiz_scroll_offset_ << " to " << offset);
3041
3042         if (d->update_strategy_ == NoScreenUpdate
3043             && (offset != d->horiz_scroll_offset_
3044                 || !d->last_row_slice_.empty())) {
3045                 // FIXME: if one uses SingleParUpdate, then home/end
3046                 // will not work on long rows. Why?
3047                 d->update_strategy_ = FullScreenUpdate;
3048         }
3049
3050         d->horiz_scroll_offset_ = offset;
3051 }
3052
3053
3054 void BufferView::draw(frontend::Painter & pain, bool paint_caret)
3055 {
3056         if (height_ == 0 || width_ == 0)
3057                 return;
3058         LYXERR(Debug::PAINTING, (pain.isNull() ? "\t\t--- START NODRAW ---"
3059                                  : "\t\t*** START DRAWING ***"));
3060         Text & text = buffer_.text();
3061         TextMetrics const & tm = d->text_metrics_[&text];
3062         int const y = tm.first().second->position();
3063         PainterInfo pi(this, pain);
3064
3065         /**  A repaint of the previous caret row is needed if there is
3066          *  caret painted on screen and either
3067          *   1/ a new caret has to be painted at a place different from
3068          *      the existing one;
3069          *   2/ there is no need for a caret anymore.
3070          */
3071         d->repaint_caret_row_ = !d->caret_slice_.empty() &&
3072                 ((paint_caret && d->cursor_.top() != d->caret_slice_)
3073                  || ! paint_caret);
3074
3075         // Check whether the row where the cursor lives needs to be scrolled.
3076         // Update the drawing strategy if needed.
3077         checkCursorScrollOffset();
3078
3079         switch (d->update_strategy_) {
3080
3081         case NoScreenUpdate:
3082                 // no screen painting is actually needed. In nodraw stage
3083                 // however, the different coordinates of insets and paragraphs
3084                 // needs to be updated.
3085                 LYXERR(Debug::PAINTING, "Strategy: NoScreenUpdate");
3086                 pi.full_repaint = false;
3087                 if (pain.isNull()) {
3088                         pi.full_repaint = true;
3089                         tm.draw(pi, 0, y);
3090                 } else if (d->repaint_caret_row_) {
3091                         pi.full_repaint = false;
3092                         tm.draw(pi, 0, y);
3093                 }
3094                 break;
3095
3096         case SingleParUpdate:
3097                 pi.full_repaint = false;
3098                 LYXERR(Debug::PAINTING, "Strategy: SingleParUpdate");
3099                 // In general, only the current row of the outermost paragraph
3100                 // will be redrawn. Particular cases where selection spans
3101                 // multiple paragraph are correctly detected in TextMetrics.
3102                 tm.draw(pi, 0, y);
3103                 break;
3104
3105         case DecorationUpdate:
3106                 // FIXME: We should also distinguish DecorationUpdate to avoid text
3107                 // drawing if possible. This is not possible to do easily right now
3108                 // because of the single backing pixmap.
3109
3110         case FullScreenUpdate:
3111
3112                 LYXERR(Debug::PAINTING,
3113                        ((d->update_strategy_ == FullScreenUpdate)
3114                         ? "Strategy: FullScreenUpdate"
3115                         : "Strategy: DecorationUpdate"));
3116
3117                 // The whole screen, including insets, will be refreshed.
3118                 pi.full_repaint = true;
3119
3120                 // Clear background.
3121                 pain.fillRectangle(0, 0, width_, height_,
3122                         pi.backgroundColor(&buffer_.inset()));
3123
3124                 // Draw everything.
3125                 tm.draw(pi, 0, y);
3126
3127                 // and possibly grey out below
3128                 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3129                 int const y2 = lastpm.second->position() + lastpm.second->descent();
3130
3131                 if (y2 < height_) {
3132                         Color color = buffer().isInternal()
3133                                 ? Color_background : Color_bottomarea;
3134                         pain.fillRectangle(0, y2, width_, height_ - y2, color);
3135                 }
3136                 break;
3137         }
3138         LYXERR(Debug::PAINTING, (pain.isNull() ? "\t\t --- END NODRAW ---"
3139                                 : "\t\t *** END DRAWING ***"));
3140
3141         // The scrollbar needs an update.
3142         updateScrollbar();
3143
3144         // Normalize anchor for next time
3145         pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
3146         pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3147         for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
3148                 ParagraphMetrics const & pm = tm.parMetrics(pit);
3149                 if (pm.position() + pm.descent() > 0) {
3150                         if (d->anchor_pit_ != pit
3151                             || d->anchor_ypos_ != pm.position())
3152                                 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
3153                                        << "  anchor ypos = " << d->anchor_ypos_);
3154                         d->anchor_pit_ = pit;
3155                         d->anchor_ypos_ = pm.position();
3156                         break;
3157                 }
3158         }
3159         if (!pain.isNull()) {
3160                 // reset the update flags, everything has been done
3161                 d->update_flags_ = Update::None;
3162         }
3163
3164         // Remember what has just been done for the next draw() step
3165         if (paint_caret) {
3166                 d->caret_slice_ = d->cursor_.top();
3167                 if (d->caret_slice_.pos() > 0
3168                     && (d->cursor_.boundary()
3169                         || d->caret_slice_.pos() == d->caret_slice_.lastpos()))
3170                         --d->caret_slice_.pos();
3171         } else
3172                 d->caret_slice_ = CursorSlice();
3173 }
3174
3175
3176 void BufferView::message(docstring const & msg)
3177 {
3178         if (d->gui_)
3179                 d->gui_->message(msg);
3180 }
3181
3182
3183 void BufferView::showDialog(string const & name)
3184 {
3185         if (d->gui_)
3186                 d->gui_->showDialog(name, string());
3187 }
3188
3189
3190 void BufferView::showDialog(string const & name,
3191         string const & data, Inset * inset)
3192 {
3193         if (d->gui_)
3194                 d->gui_->showDialog(name, data, inset);
3195 }
3196
3197
3198 void BufferView::updateDialog(string const & name, string const & data)
3199 {
3200         if (d->gui_)
3201                 d->gui_->updateDialog(name, data);
3202 }
3203
3204
3205 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
3206 {
3207         d->gui_ = gui;
3208 }
3209
3210
3211 // FIXME: Move this out of BufferView again
3212 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
3213 {
3214         if (!fname.isReadableFile()) {
3215                 docstring const error = from_ascii(strerror(errno));
3216                 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3217                 docstring const text =
3218                   bformat(_("Could not read the specified document\n"
3219                             "%1$s\ndue to the error: %2$s"), file, error);
3220                 Alert::error(_("Could not read file"), text);
3221                 return docstring();
3222         }
3223
3224         if (!fname.isReadableFile()) {
3225                 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3226                 docstring const text =
3227                   bformat(_("%1$s\n is not readable."), file);
3228                 Alert::error(_("Could not open file"), text);
3229                 return docstring();
3230         }
3231
3232         // FIXME UNICODE: We don't know the encoding of the file
3233         docstring file_content = fname.fileContents("UTF-8");
3234         if (file_content.empty()) {
3235                 Alert::error(_("Reading not UTF-8 encoded file"),
3236                              _("The file is not UTF-8 encoded.\n"
3237                                "It will be read as local 8Bit-encoded.\n"
3238                                "If this does not give the correct result\n"
3239                                "then please change the encoding of the file\n"
3240                                "to UTF-8 with a program other than LyX.\n"));
3241                 file_content = fname.fileContents("local8bit");
3242         }
3243
3244         return normalize_c(file_content);
3245 }
3246
3247
3248 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
3249 {
3250         docstring const tmpstr = contentsOfPlaintextFile(f);
3251
3252         if (tmpstr.empty())
3253                 return;
3254
3255         Cursor & cur = cursor();
3256         cap::replaceSelection(cur);
3257         buffer_.undo().recordUndo(cur);
3258         if (asParagraph)
3259                 cur.innerText()->insertStringAsParagraphs(cur, tmpstr, cur.current_font);
3260         else
3261                 cur.innerText()->insertStringAsLines(cur, tmpstr, cur.current_font);
3262
3263         buffer_.changed(true);
3264 }
3265
3266
3267 docstring const & BufferView::inlineCompletion() const
3268 {
3269         return d->inlineCompletion_;
3270 }
3271
3272
3273 size_t const & BufferView::inlineCompletionUniqueChars() const
3274 {
3275         return d->inlineCompletionUniqueChars_;
3276 }
3277
3278
3279 DocIterator const & BufferView::inlineCompletionPos() const
3280 {
3281         return d->inlineCompletionPos_;
3282 }
3283
3284
3285 void BufferView::resetInlineCompletionPos()
3286 {
3287         d->inlineCompletionPos_ = DocIterator();
3288 }
3289
3290
3291 bool samePar(DocIterator const & a, DocIterator const & b)
3292 {
3293         if (a.empty() && b.empty())
3294                 return true;
3295         if (a.empty() || b.empty())
3296                 return false;
3297         if (a.depth() != b.depth())
3298                 return false;
3299         return &a.innerParagraph() == &b.innerParagraph();
3300 }
3301
3302
3303 void BufferView::setInlineCompletion(Cursor const & cur, DocIterator const & pos,
3304         docstring const & completion, size_t uniqueChars)
3305 {
3306         uniqueChars = min(completion.size(), uniqueChars);
3307         bool changed = d->inlineCompletion_ != completion
3308                 || d->inlineCompletionUniqueChars_ != uniqueChars;
3309         bool singlePar = true;
3310         d->inlineCompletion_ = completion;
3311         d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
3312
3313         //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
3314
3315         // at new position?
3316         DocIterator const & old = d->inlineCompletionPos_;
3317         if (old != pos) {
3318                 //lyxerr << "inlineCompletionPos changed" << std::endl;
3319                 // old or pos are in another paragraph?
3320                 if ((!samePar(cur, pos) && !pos.empty())
3321                     || (!samePar(cur, old) && !old.empty())) {
3322                         singlePar = false;
3323                         //lyxerr << "different paragraph" << std::endl;
3324                 }
3325                 d->inlineCompletionPos_ = pos;
3326         }
3327
3328         // set update flags
3329         if (changed) {
3330                 if (singlePar && !(cur.result().screenUpdate() & Update::Force))
3331                         cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
3332                 else
3333                         cur.screenUpdateFlags(cur.result().screenUpdate() | Update::Force);
3334         }
3335 }
3336
3337
3338 bool BufferView::clickableInset() const
3339 {
3340         return d->clickable_inset_;
3341 }
3342
3343 } // namespace lyx