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