3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Alfredo Braunstein
7 * \author Lars Gullik Bjønnes
10 * \author Jürgen Vigna
12 * Full author contact details are available in file CREDITS.
17 #include "BufferView.h"
19 #include "BranchList.h"
21 #include "BufferList.h"
22 #include "BufferParams.h"
23 #include "CoordCache.h"
25 #include "CutAndPaste.h"
26 #include "DispatchResult.h"
27 #include "ErrorList.h"
28 #include "FuncRequest.h"
29 #include "FuncStatus.h"
32 #include "LayoutFile.h"
35 #include "LyXAction.h"
38 #include "MetricsInfo.h"
39 #include "Paragraph.h"
42 #include "TextMetrics.h"
44 #include "TocBackend.h"
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"
53 #include "mathed/InsetMathNest.h"
54 #include "mathed/InsetMathRef.h"
55 #include "mathed/MathData.h"
56 #include "mathed/MathRow.h"
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"
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"
88 using namespace lyx::support;
92 namespace Alert = frontend::Alert;
96 /// Return an inset of this class if it exists at the current cursor position
98 T * getInsetByCode(Cursor const & cur, InsetCode code)
100 DocIterator it = cur;
101 Inset * inset = it.nextInset();
102 if (inset && inset->lyxCode() == code)
103 return static_cast<T*>(inset);
108 /// Note that comparing contents can only be used for InsetCommand
109 bool findNextInset(DocIterator & dit, vector<InsetCode> const & codes,
110 docstring const & contents)
112 DocIterator tmpdit = dit;
115 Inset const * inset = tmpdit.nextInset();
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));
123 if (valid_code && same_or_no_contents) {
128 tmpdit.forwardInset();
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,
141 DocIterator tmpdit = dit;
142 tmpdit.forwardInset();
146 Inset const * inset = tmpdit.nextInset();
147 if (same_content && inset) {
148 InsetCommand const * ic = inset->asInsetCommand();
150 bool const valid_code = std::find(codes.begin(), codes.end(),
151 ic->lyxCode()) != codes.end();
153 contents = ic->getFirstNonOptParam();
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))
173 /// Moves cursor to the next inset with one of the given codes.
174 void gotoInset(BufferView * bv, vector<InsetCode> const & codes,
177 Cursor tmpcur = bv->cursor();
178 if (!findInset(tmpcur, codes, same_content)) {
179 bv->cursor().message(_("No more insets"));
183 tmpcur.clearSelection();
184 bv->setCursor(tmpcur);
189 /// A map from a Text to the associated text metrics
190 typedef map<Text const *, TextMetrics> TextMetricsCache;
192 enum ScreenUpdateStrategy {
202 /////////////////////////////////////////////////////////////////////
206 /////////////////////////////////////////////////////////////////////
208 struct BufferView::Private
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)
219 xsel_cache_.set = false;
223 ScrollbarParameters scrollbarParameters_;
225 ScreenUpdateStrategy update_strategy_;
227 Update::flags update_flags_;
229 CoordCache coord_cache_;
231 typedef map<MathData const *, MathRow> MathRows;
234 /// this is used to handle XSelection events in the right manner.
243 pit_type anchor_pit_;
246 /// Estimated average par height for scrollbar.
249 vector<int> par_height_;
252 DocIterator inlineCompletionPos_;
254 docstring inlineCompletion_;
256 size_t inlineCompletionUniqueChars_;
258 /// keyboard mapping object.
261 /// last visited inset.
262 /** kept to send setMouseHover(false).
263 * Not owned, so don't delete.
265 Inset const * last_inset_;
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_;
272 mutable TextMetricsCache text_metrics_;
275 /** Not owned, so don't delete.
277 frontend::GuiBufferViewDelegate * gui_;
280 map<string, Inset *> edited_insets_;
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_;
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_;
298 BufferView::BufferView(Buffer & buf)
299 : width_(0), height_(0), full_screen_(false), buffer_(buf),
300 d(new Private(*this))
302 d->xsel_cache_.set = false;
303 d->intl_.initKeyMapper(lyxrc.use_kbmap);
305 d->cursor_.setBuffer(&buf);
306 d->cursor_.push(buffer_.inset());
307 d->cursor_.resetAnchor();
308 d->cursor_.setCurrentFont();
310 buffer_.updatePreviews();
314 BufferView::~BufferView()
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);
328 d->last_inset_->setMouseHover(this, false);
334 int BufferView::rightMargin() const
336 // The value used to be hardcoded to 10
337 int const default_margin = zoomedPixels(10);
338 // The additional test for the case the outliner is opened.
339 if (!full_screen_ || !lyxrc.full_screen_limit
340 || width_ < lyxrc.full_screen_width + 2 * default_margin)
341 return default_margin;
343 return (width_ - lyxrc.full_screen_width) / 2;
347 int BufferView::leftMargin() const
349 return rightMargin();
353 int BufferView::topMargin() const
355 // Original value was 20px at 100dpi. For internal buffers like in
356 // advanced search and replace, a value of 5px is enough.
357 return zoomedPixels(buffer().isInternal() ? 5 : 20);
361 int BufferView::bottomMargin() const
367 int BufferView::inPixels(Length const & len) const
369 Font const font = buffer().params().getFont();
370 return len.inPixels(workWidth(), theFontMetrics(font).em());
374 int BufferView::zoomedPixels(int pix) const
376 // FIXME: the dpi setting should really depend on the BufferView
377 // (think different monitors).
379 // Zoom factor specified by user in percent
380 double const zoom = lyxrc.currentZoom / 100.0; // [percent]
382 // DPI setting for monitor relative to 100dpi
383 double const dpizoom = lyxrc.dpi / 100.0; // [per 100dpi]
385 return support::iround(pix * zoom * dpizoom);
389 bool BufferView::isTopScreen() const
391 return 0 == d->scrollbarParameters_.min;
395 bool BufferView::isBottomScreen() const
397 return 0 == d->scrollbarParameters_.max;
401 Intl & BufferView::getIntl()
407 Intl const & BufferView::getIntl() const
413 CoordCache & BufferView::coordCache()
415 return d->coord_cache_;
419 CoordCache const & BufferView::coordCache() const
421 return d->coord_cache_;
425 MathRow const & BufferView::mathRow(MathData const * cell) const
427 auto it = d->math_rows_.find(cell);
428 LATTEST(it != d->math_rows_.end());
433 void BufferView::setMathRow(MathData const * cell, MathRow const & mrow)
435 d->math_rows_[cell] = mrow;
439 Buffer & BufferView::buffer()
445 Buffer const & BufferView::buffer() const
451 docstring const & BufferView::searchRequestCache() const
453 return theClipboard().getFindBuffer();
457 void BufferView::setSearchRequestCache(docstring const & text)
465 docstring const search = string2find(text, casesensitive, matchword,
466 forward, wrap, instant, onlysel);
467 theClipboard().setFindBuffer(search);
471 bool BufferView::needsFitCursor() const
473 if (cursorStatus(d->cursor_) == CUR_INSIDE) {
474 frontend::FontMetrics const & fm =
475 theFontMetrics(d->cursor_.getFont().fontInfo());
476 int const asc = fm.maxAscent();
477 int const des = fm.maxDescent();
478 Point const p = getPos(d->cursor_);
479 if (p.y_ - asc >= 0 && p.y_ + des < height_)
488 // this is for debugging only.
489 string flagsAsString(Update::flags flags)
491 if (flags == Update::None)
493 return string((flags & Update::FitCursor) ? "FitCursor " : "")
494 + ((flags & Update::Force) ? "Force " : "")
495 + ((flags & Update::ForceDraw) ? "ForceDraw " : "")
496 + ((flags & Update::SinglePar) ? "SinglePar " : "")
497 + ((flags & Update::Decoration) ? "Decoration " : "");
502 void BufferView::processUpdateFlags(Update::flags flags)
504 LYXERR(Debug::PAINTING, "BufferView::processUpdateFlags( "
505 << flagsAsString(flags) << ") buffer: " << &buffer_);
507 // Case when no explicit update is requested.
508 if (flags == Update::None)
511 /* FIXME We would like to avoid doing this here, since it is very
512 * expensive and is called in updateBuffer already. However, even
513 * inserting a plain character can invalidate the overly fragile
514 * tables of child documents built by updateMacros. Some work is
515 * needed to avoid doing that when not necessary.
517 buffer_.updateMacros();
519 // First check whether the metrics and inset positions should be updated
520 if (flags & Update::Force) {
521 // This will update the CoordCache items and replace Force
522 // with ForceDraw in flags.
523 updateMetrics(flags);
526 // Detect whether we can only repaint a single paragraph (if we
527 // are not already redrawing all).
528 // We handle this before FitCursor because the later will require
529 // correct metrics at cursor position.
530 if (!(flags & Update::ForceDraw)
531 && (flags & Update::SinglePar)
532 && !singleParUpdate())
533 updateMetrics(flags);
535 // Then make sure that the screen contains the cursor if needed
536 if (flags & Update::FitCursor) {
537 if (needsFitCursor()) {
538 // First try to make the selection start visible
539 // (which is just the cursor when there is no selection)
540 scrollToCursor(d->cursor_.selectionBegin(), false);
541 // Metrics have to be recomputed (maybe again)
543 // Is the cursor visible? (only useful if cursor is at end of selection)
544 if (needsFitCursor()) {
545 // then try to make cursor visible instead
546 scrollToCursor(d->cursor_, false);
547 // Metrics have to be recomputed (maybe again)
548 updateMetrics(flags);
551 flags = flags & ~Update::FitCursor;
554 // Add flags to the the update flags. These will be reset to None
555 // after the redraw is actually done
556 d->update_flags_ = d->update_flags_ | flags;
557 LYXERR(Debug::PAINTING, "Cumulative flags: " << flagsAsString(flags));
559 // Now compute the update strategy
560 // Possibly values in flag are None, SinglePar, Decoration, ForceDraw
561 LATTEST((d->update_flags_ & ~(Update::None | Update::SinglePar
562 | Update::Decoration | Update::ForceDraw)) == 0);
564 if (d->update_flags_ & Update::ForceDraw)
565 d->update_strategy_ = FullScreenUpdate;
566 else if (d->update_flags_ & Update::Decoration)
567 d->update_strategy_ = DecorationUpdate;
568 else if (d->update_flags_ & Update::SinglePar)
569 d->update_strategy_ = SingleParUpdate;
571 // no need to redraw anything.
572 d->update_strategy_ = NoScreenUpdate;
575 updateHoveredInset();
578 buffer_.changed(false);
582 void BufferView::updateScrollbar()
584 if (height_ == 0 && width_ == 0)
587 // We prefer fixed size line scrolling.
588 d->scrollbarParameters_.single_step = defaultRowHeight();
589 // We prefer full screen page scrolling.
590 d->scrollbarParameters_.page_step = height_;
592 Text & t = buffer_.text();
593 TextMetrics & tm = d->text_metrics_[&t];
595 LYXERR(Debug::GUI, " Updating scrollbar: height: "
596 << t.paragraphs().size()
597 << " curr par: " << d->cursor_.bottom().pit()
598 << " default height " << defaultRowHeight());
600 size_t const parsize = t.paragraphs().size();
601 if (d->par_height_.size() != parsize) {
602 d->par_height_.clear();
603 // FIXME: We assume a default paragraph height of 2 rows. This
604 // should probably be pondered with the screen width.
605 d->par_height_.resize(parsize, defaultRowHeight() * 2);
608 // Look at paragraph heights on-screen
609 pair<pit_type, ParagraphMetrics const *> first = tm.first();
610 pair<pit_type, ParagraphMetrics const *> last = tm.last();
611 for (pit_type pit = first.first; pit <= last.first; ++pit) {
612 d->par_height_[pit] = tm.parMetrics(pit).height();
613 LYXERR(Debug::SCROLLING, "storing height for pit " << pit << " : "
614 << d->par_height_[pit]);
617 int top_pos = first.second->position() - first.second->ascent();
618 int bottom_pos = last.second->position() + last.second->descent();
619 bool first_visible = first.first == 0 && top_pos >= 0;
620 bool last_visible = last.first + 1 == int(parsize) && bottom_pos <= height_;
621 if (first_visible && last_visible) {
622 d->scrollbarParameters_.min = 0;
623 d->scrollbarParameters_.max = 0;
627 d->scrollbarParameters_.min = top_pos;
628 for (size_t i = 0; i != size_t(first.first); ++i)
629 d->scrollbarParameters_.min -= d->par_height_[i];
630 d->scrollbarParameters_.max = bottom_pos;
631 for (size_t i = last.first + 1; i != parsize; ++i)
632 d->scrollbarParameters_.max += d->par_height_[i];
634 // The reference is the top position so we remove one page.
635 if (lyxrc.scroll_below_document)
636 d->scrollbarParameters_.max -= minVisiblePart();
638 d->scrollbarParameters_.max -= d->scrollbarParameters_.page_step;
640 // 0 must be inside the range as it denotes the current position
641 if (d->scrollbarParameters_.max < 0)
642 d->scrollbarParameters_.max = 0;
643 if (d->scrollbarParameters_.min > 0)
644 d->scrollbarParameters_.min = 0;
648 ScrollbarParameters const & BufferView::scrollbarParameters() const
650 return d->scrollbarParameters_;
654 docstring BufferView::toolTip(int x, int y) const
656 // Get inset under mouse, if there is one.
657 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
659 // No inset, no tooltip...
661 return covering_inset->toolTip(*this, x, y);
665 string BufferView::contextMenu(int x, int y) const
667 //If there is a selection, return the containing inset menu
668 if (d->cursor_.selection())
669 return d->cursor_.inset().contextMenu(*this, x, y);
671 // Get inset under mouse, if there is one.
672 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
673 if (covering_inset) {
674 if (covering_inset->asInsetMath()) {
675 CoordCache::Insets const & inset_cache =
676 coordCache().getInsets();
677 Inset const * inner_inset = mathContextMenu(
678 covering_inset->asInsetMath()->asNestInset(),
681 return inner_inset->contextMenu(*this, x, y);
683 return covering_inset->contextMenu(*this, x, y);
686 return buffer_.inset().contextMenu(*this, x, y);
690 Inset const * BufferView::mathContextMenu(InsetMathNest const * inset,
691 CoordCache::Insets const & inset_cache, int x, int y) const
693 for (size_t i = 0; i < inset->nargs(); ++i) {
694 MathData const & ar = inset->cell(i);
695 for (size_t j = 0; j < ar.size(); ++j) {
696 string const name = lyxerr.debugging(Debug::MATHED)
697 ? insetName(ar[j].nucleus()->lyxCode())
699 LYXERR(Debug::MATHED, "Examining inset: " << name);
700 if (!ar[j].nucleus()->contextMenuName().empty()) {
701 if (inset_cache.covers(ar[j].nucleus(), x, y)) {
702 LYXERR(Debug::MATHED, "Hit inset: "
704 return ar[j].nucleus();
707 InsetMathNest const * imn =
708 ar[j].nucleus()->asNestInset();
710 Inset const * inner =
711 mathContextMenu(imn, inset_cache, x, y);
721 void BufferView::scrollDocView(int const pixels, bool update)
723 // The scrollbar values are relative to the top of the screen, therefore the
724 // offset is equal to the target value.
726 // No scrolling at all? No need to redraw anything
730 // If the offset is less than 2 screen height, prefer to scroll instead.
731 if (abs(pixels) <= 2 * height_) {
732 d->anchor_ypos_ -= pixels;
733 processUpdateFlags(Update::Force);
737 // cut off at the top
738 if (pixels <= d->scrollbarParameters_.min) {
739 DocIterator dit = doc_iterator_begin(&buffer_);
740 showCursor(dit, false, update);
741 LYXERR(Debug::SCROLLING, "scroll to top");
745 // cut off at the bottom
746 if (pixels >= d->scrollbarParameters_.max) {
747 DocIterator dit = doc_iterator_end(&buffer_);
749 showCursor(dit, false, update);
750 LYXERR(Debug::SCROLLING, "scroll to bottom");
754 // find paragraph at target position
755 int par_pos = d->scrollbarParameters_.min;
757 for (; i != int(d->par_height_.size()); ++i) {
758 par_pos += d->par_height_[i];
759 if (par_pos >= pixels)
763 if (par_pos < pixels) {
764 // It seems we didn't find the correct pit so stay on the safe side and
766 LYXERR0("scrolling position not found!");
767 scrollDocView(d->scrollbarParameters_.max, update);
771 DocIterator dit = doc_iterator_begin(&buffer_);
773 LYXERR(Debug::SCROLLING, "pixels = " << pixels << " -> scroll to pit " << i);
774 showCursor(dit, false, update);
778 // FIXME: this method is not working well.
779 void BufferView::setCursorFromScrollbar()
781 TextMetrics & tm = d->text_metrics_[&buffer_.text()];
783 int const height = 2 * defaultRowHeight();
784 int const first = height;
785 int const last = height_ - height;
787 Cursor const & oldcur = d->cursor_;
789 switch (cursorStatus(oldcur)) {
797 int const y = getPos(oldcur).y_;
798 newy = min(last, max(y, first));
802 // We reset the cursor because cursorStatus() does not
803 // work when the cursor is within mathed.
806 tm.setCursorFromCoordinates(cur, 0, newy);
808 // update the bufferview cursor and notify insets
809 // FIXME: Care about the d->cursor_ flags to redraw if needed
810 Cursor old = d->cursor_;
812 // the DEPM call in mouseSetCursor() might have destroyed the
813 // paragraph the cursor is in.
814 bool badcursor = old.fixIfBroken();
815 badcursor |= notifyCursorLeavesOrEnters(old, d->cursor_);
817 d->cursor_.fixIfBroken();
821 Change const BufferView::getCurrentChange() const
823 if (!d->cursor_.selection())
824 return Change(Change::UNCHANGED);
826 DocIterator dit = d->cursor_.selectionBegin();
827 // The selected content might have been changed (see #7685)
828 dit = dit.getInnerText();
829 return dit.paragraph().lookupChange(dit.pos());
833 // this could be used elsewhere as well?
834 // FIXME: This does not work within mathed!
835 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
837 Point const p = getPos(dit);
840 if (p.y_ > workHeight())
846 void BufferView::bookmarkEditPosition()
848 // Don't eat cpu time for each keystroke
849 if (d->cursor_.paragraph().id() == d->bookmark_edit_position_)
852 d->bookmark_edit_position_ = d->cursor_.paragraph().id();
856 void BufferView::saveBookmark(unsigned int idx)
858 if (buffer().isInternal())
861 // tentatively save bookmark, id and pos will be used to
862 // acturately locate a bookmark in a 'live' lyx session.
863 // pit and pos will be updated with bottom level pit/pos
865 theSession().bookmarks().save(
867 d->cursor_.bottom().pit(),
868 d->cursor_.bottom().pos(),
869 d->cursor_.paragraph().id(),
874 // emit message signal.
875 message(_("Save bookmark"));
879 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
880 int top_id, pos_type top_pos)
882 bool success = false;
885 d->cursor_.clearSelection();
887 // if a valid par_id is given, try it first
888 // This is the case for a 'live' bookmark when unique paragraph ID
889 // is used to track bookmarks.
891 dit = buffer_.getParFromID(top_id);
893 dit.pos() = min(dit.paragraph().size(), top_pos);
894 // Some slices of the iterator may not be
895 // reachable (e.g. closed collapsible inset)
896 // so the dociterator may need to be
897 // shortened. Otherwise, setCursor may crash
898 // lyx when the cursor can not be set to these
900 size_t const n = dit.depth();
901 for (size_t i = 0; i < n; ++i)
902 if (!dit[i].inset().editable()) {
910 // if top_id == 0, or searching through top_id failed
911 // This is the case for a 'restored' bookmark when only bottom
912 // (document level) pit was saved. Because of this, bookmark
913 // restoration is inaccurate. If a bookmark was within an inset,
914 // it will be restored to the left of the outmost inset that contains
916 if (!success && bottom_pit < int(buffer_.paragraphs().size())) {
917 dit = doc_iterator_begin(&buffer_);
919 dit.pit() = bottom_pit;
920 dit.pos() = min(bottom_pos, dit.paragraph().size());
925 // Note: only bottom (document) level pit is set.
927 // set the current font.
928 d->cursor_.setCurrentFont();
929 // Do not forget to reset the anchor (see #9912)
930 d->cursor_.resetAnchor();
931 processUpdateFlags(Update::Force | Update::FitCursor);
938 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
940 if (d->cursor_.real_current_font.isRightToLeft()) {
941 if (d->intl_.keymap == Intl::PRIMARY)
942 d->intl_.keyMapSec();
944 if (d->intl_.keymap == Intl::SECONDARY)
945 d->intl_.keyMapPrim();
948 d->intl_.getTransManager().translateAndInsert(c, t, cur);
952 int BufferView::workWidth() const
958 void BufferView::recenter()
960 showCursor(d->cursor_, true, true);
964 void BufferView::showCursor()
966 showCursor(d->cursor_, false, true);
970 void BufferView::showCursor(DocIterator const & dit,
971 bool recenter, bool update)
973 if (scrollToCursor(dit, recenter) && update)
974 processUpdateFlags(Update::Force);
978 void BufferView::scrollToCursor()
980 if (scrollToCursor(d->cursor_, false))
981 processUpdateFlags(Update::Force);
985 bool BufferView::scrollToCursor(DocIterator const & dit, bool const recenter)
987 // We are not properly started yet, delay until resizing is done.
992 LYXERR(Debug::SCROLLING, "recentering and scrolling to cursor");
994 LYXERR(Debug::SCROLLING, "scrolling to cursor");
996 CursorSlice const & bot = dit.bottom();
997 TextMetrics & tm = textMetrics(bot.text());
999 pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
1000 pos_type bot_pit = bot.pit();
1001 if (bot_pit > max_pit) {
1002 // FIXME: Why does this happen?
1003 LYXERR0("bottom pit is greater that max pit: "
1004 << bot_pit << " > " << max_pit);
1008 if (bot_pit == tm.first().first - 1)
1009 tm.newParMetricsUp();
1010 else if (bot_pit == tm.last().first + 1)
1011 tm.newParMetricsDown();
1013 if (tm.contains(bot_pit)) {
1014 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
1015 LBUFERR(!pm.rows().empty());
1016 // FIXME: smooth scrolling doesn't work in mathed.
1017 CursorSlice const & cs = dit.innerTextSlice();
1018 int const ypos = pm.position() + coordOffset(dit).y_;
1019 ParagraphMetrics const & inner_pm =
1020 textMetrics(cs.text()).parMetrics(cs.pit());
1021 Dimension const & row_dim =
1022 inner_pm.getRow(cs.pos(), dit.boundary()).dim();
1025 scrolled = scroll(ypos - height_/2);
1027 // We try to visualize the whole row, if the row height is larger than
1028 // the screen height, we scroll to a heuristic value of height_ / 4.
1029 // FIXME: This heuristic value should be replaced by a recursive search
1030 // for a row in the inset that can be visualized completely.
1031 else if (row_dim.height() > height_) {
1032 if (ypos < defaultRowHeight())
1033 scrolled = scroll(ypos - height_ / 4);
1034 else if (ypos > height_ - defaultRowHeight())
1035 scrolled = scroll(ypos - 3 * height_ / 4);
1038 // If the top part of the row falls of the screen, we scroll
1039 // up to align the top of the row with the top of the screen.
1040 else if (ypos - row_dim.ascent() < 0 && ypos < height_) {
1041 int const ynew = row_dim.ascent();
1042 scrolled = scrollUp(ynew - ypos);
1045 // If the bottom of the row falls of the screen, we scroll down.
1046 else if (ypos + row_dim.descent() > height_ && ypos > 0) {
1047 int const ynew = height_ - row_dim.descent();
1048 scrolled = scrollDown(ypos - ynew);
1051 // else, nothing to do, the cursor is already visible so we just return.
1052 return scrolled != 0;
1055 // fix inline completion position
1056 if (d->inlineCompletionPos_.fixIfBroken())
1057 d->inlineCompletionPos_ = DocIterator();
1059 tm.redoParagraph(bot_pit);
1060 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
1061 int const offset = coordOffset(dit).y_;
1063 d->anchor_pit_ = bot_pit;
1064 CursorSlice const & cs = dit.innerTextSlice();
1065 ParagraphMetrics const & inner_pm =
1066 textMetrics(cs.text()).parMetrics(cs.pit());
1067 Dimension const & row_dim =
1068 inner_pm.getRow(cs.pos(), dit.boundary()).dim();
1071 d->anchor_ypos_ = height_/2;
1072 else if (d->anchor_pit_ == 0)
1073 d->anchor_ypos_ = offset + pm.ascent();
1074 else if (d->anchor_pit_ == max_pit)
1075 d->anchor_ypos_ = height_ - offset - row_dim.descent();
1076 else if (offset > height_)
1077 d->anchor_ypos_ = height_ - offset - defaultRowHeight();
1079 d->anchor_ypos_ = defaultRowHeight() * 2;
1085 void BufferView::makeDocumentClass()
1087 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1088 buffer_.params().makeDocumentClass(buffer_.isClone(), buffer_.isInternal());
1089 updateDocumentClass(olddc);
1093 void BufferView::updateDocumentClass(DocumentClassConstPtr olddc)
1095 message(_("Converting document to new document class..."));
1097 StableDocIterator backcur(d->cursor_);
1098 ErrorList & el = buffer_.errorList("Class Switch");
1099 cap::switchBetweenClasses(
1100 olddc, buffer_.params().documentClassPtr(),
1101 static_cast<InsetText &>(buffer_.inset()), el);
1103 setCursor(backcur.asDocIterator(&buffer_));
1105 buffer_.errors("Class Switch");
1109 /** Return the change status at cursor position, taking into account the
1110 * status at each level of the document iterator (a table in a deleted
1111 * footnote is deleted).
1112 * When \param outer is true, the top slice is not looked at.
1114 static Change::Type lookupChangeType(DocIterator const & dit, bool outer = false)
1116 size_t const depth = dit.depth() - (outer ? 1 : 0);
1118 for (size_t i = 0 ; i < depth ; ++i) {
1119 CursorSlice const & slice = dit[i];
1120 if (!slice.inset().inMathed()
1121 && slice.pos() < slice.paragraph().size()) {
1122 Change::Type const ch = slice.paragraph().lookupChange(slice.pos()).type;
1123 if (ch != Change::UNCHANGED)
1127 return Change::UNCHANGED;
1131 bool BufferView::getStatus(FuncRequest const & cmd, FuncStatus & flag)
1133 FuncCode const act = cmd.action();
1135 // Can we use a readonly buffer?
1136 if (buffer_.isReadonly()
1137 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1138 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1139 if (buffer_.hasReadonlyFlag())
1140 flag.message(from_utf8(N_("Document is read-only")));
1142 flag.message(from_utf8(N_("Document has been modified externally")));
1143 flag.setEnabled(false);
1147 // Are we in a DELETED change-tracking region?
1148 if (lookupChangeType(d->cursor_, true) == Change::DELETED
1149 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1150 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1151 flag.message(from_utf8(N_("This portion of the document is deleted.")));
1152 flag.setEnabled(false);
1156 Cursor & cur = d->cursor_;
1158 if (cur.getStatus(cmd, flag))
1163 // FIXME: This is a bit problematic because we don't check if this is
1164 // a document BufferView or not for these LFUNs. We probably have to
1165 // dispatch both to currentBufferView() and, if that fails,
1166 // to documentBufferView(); same as we do now for current Buffer and
1167 // document Buffer. Ideally those LFUN should go to Buffer as they
1168 // operate on the full Buffer and the cursor is only needed either for
1169 // an Undo record or to restore a cursor position. But we don't know
1170 // how to do that inside Buffer of course.
1171 case LFUN_BUFFER_PARAMS_APPLY:
1172 case LFUN_LAYOUT_MODULES_CLEAR:
1173 case LFUN_LAYOUT_MODULE_ADD:
1174 case LFUN_LAYOUT_RELOAD:
1175 case LFUN_TEXTCLASS_APPLY:
1176 case LFUN_TEXTCLASS_LOAD:
1177 flag.setEnabled(!buffer_.isReadonly());
1181 // We do not use the LyXAction flag for readonly because Undo sets the
1182 // buffer clean/dirty status by itself.
1183 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasUndoStack());
1186 // We do not use the LyXAction flag for readonly because Redo sets the
1187 // buffer clean/dirty status by itself.
1188 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasRedoStack());
1190 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
1191 case LFUN_FILE_INSERT_PLAINTEXT: {
1192 docstring const & fname = cmd.argument();
1193 if (!FileName::isAbsolute(to_utf8(fname))) {
1194 flag.message(_("Absolute filename expected."));
1197 flag.setEnabled(cur.inTexted());
1200 case LFUN_FILE_INSERT:
1201 case LFUN_BOOKMARK_SAVE:
1202 // FIXME: Actually, these LFUNS should be moved to Text
1203 flag.setEnabled(cur.inTexted());
1206 case LFUN_FONT_STATE:
1207 case LFUN_LABEL_INSERT:
1208 case LFUN_INFO_INSERT:
1209 case LFUN_PARAGRAPH_GOTO:
1210 case LFUN_NOTE_NEXT:
1211 case LFUN_REFERENCE_NEXT:
1212 case LFUN_WORD_FIND:
1213 case LFUN_WORD_FIND_FORWARD:
1214 case LFUN_WORD_FIND_BACKWARD:
1215 case LFUN_WORD_REPLACE:
1218 case LFUN_MARK_TOGGLE:
1219 case LFUN_SEARCH_STRING_SET:
1220 case LFUN_SCREEN_RECENTER:
1221 case LFUN_SCREEN_SHOW_CURSOR:
1222 case LFUN_BIBTEX_DATABASE_ADD:
1223 case LFUN_BIBTEX_DATABASE_DEL:
1224 case LFUN_STATISTICS:
1225 case LFUN_KEYMAP_OFF:
1226 case LFUN_KEYMAP_PRIMARY:
1227 case LFUN_KEYMAP_SECONDARY:
1228 case LFUN_KEYMAP_TOGGLE:
1229 case LFUN_INSET_SELECT_ALL:
1230 flag.setEnabled(true);
1233 case LFUN_GRAPHICS_UNIFY:
1234 flag.setEnabled(cur.countInsetsInSelection(GRAPHICS_CODE)>1);
1237 case LFUN_WORD_FINDADV: {
1238 FindAndReplaceOptions opt;
1239 istringstream iss(to_utf8(cmd.argument()));
1241 flag.setEnabled(opt.repl_buf_name.empty()
1242 || !buffer_.isReadonly());
1246 case LFUN_LABEL_GOTO:
1247 flag.setEnabled(!cmd.argument().empty()
1248 || getInsetByCode<InsetRef>(cur, REF_CODE)
1249 || getInsetByCode<InsetMathRef>(cur, MATH_REF_CODE));
1252 case LFUN_CHANGES_MERGE:
1253 case LFUN_CHANGE_NEXT:
1254 case LFUN_CHANGE_PREVIOUS:
1255 case LFUN_ALL_CHANGES_ACCEPT:
1256 case LFUN_ALL_CHANGES_REJECT:
1257 flag.setEnabled(buffer_.areChangesPresent());
1260 case LFUN_SCREEN_UP:
1261 case LFUN_SCREEN_DOWN:
1263 case LFUN_SCREEN_UP_SELECT:
1264 case LFUN_SCREEN_DOWN_SELECT:
1265 case LFUN_INSET_FORALL:
1266 flag.setEnabled(true);
1269 case LFUN_LAYOUT_TABULAR:
1270 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
1274 flag.setEnabled(!cur.inset().forcePlainLayout(cur.idx()));
1277 case LFUN_LAYOUT_PARAGRAPH:
1278 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
1281 case LFUN_BRANCH_ADD_INSERT:
1282 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1285 case LFUN_DIALOG_SHOW_NEW_INSET:
1286 // FIXME: this is wrong, but I do not understand the
1288 if (cur.inset().lyxCode() == CAPTION_CODE)
1289 return cur.inset().getStatus(cur, cmd, flag);
1290 // FIXME we should consider passthru paragraphs too.
1291 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1294 case LFUN_CITATION_INSERT: {
1295 FuncRequest fr(LFUN_INSET_INSERT, "citation");
1296 // FIXME: This could turn in a recursive hell.
1297 // Shouldn't we use Buffer::getStatus() instead?
1298 flag.setEnabled(lyx::getStatus(fr).enabled());
1301 case LFUN_INSET_APPLY: {
1302 string const name = cmd.getArg(0);
1303 Inset * inset = editedInset(name);
1305 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1306 if (!inset->getStatus(cur, fr, flag)) {
1307 // Every inset is supposed to handle this
1308 LASSERT(false, break);
1311 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1312 flag = lyx::getStatus(fr);
1318 flag.setEnabled(cur.selection());
1329 Inset * BufferView::editedInset(string const & name) const
1331 map<string, Inset *>::const_iterator it = d->edited_insets_.find(name);
1332 return it == d->edited_insets_.end() ? nullptr : it->second;
1336 void BufferView::editInset(string const & name, Inset * inset)
1339 d->edited_insets_[name] = inset;
1341 d->edited_insets_.erase(name);
1345 void BufferView::dispatch(FuncRequest const & cmd, DispatchResult & dr)
1347 LYXERR(Debug::ACTION, "BufferView::dispatch: cmd: " << cmd);
1349 string const argument = to_utf8(cmd.argument());
1350 Cursor & cur = d->cursor_;
1353 // Don't dispatch function that does not apply to internal buffers.
1354 if (buffer_.isInternal()
1355 && lyxaction.funcHasFlag(cmd.action(), LyXAction::NoInternal))
1358 // We'll set this back to false if need be.
1359 bool dispatched = true;
1360 buffer_.undo().beginUndoGroup();
1362 FuncCode const act = cmd.action();
1365 case LFUN_BUFFER_PARAMS_APPLY: {
1366 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1367 cur.recordUndoBufferParams();
1368 istringstream ss(to_utf8(cmd.argument()));
1371 int const unknown_tokens = buffer_.readHeader(lex);
1372 if (unknown_tokens != 0) {
1373 LYXERR0("Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1374 << unknown_tokens << " unknown token"
1375 << (unknown_tokens == 1 ? "" : "s"));
1377 updateDocumentClass(olddc);
1379 // We are most certainly here because of a change in the document
1380 // It is then better to make sure that all dialogs are in sync with
1381 // current document settings.
1382 dr.screenUpdate(Update::Force | Update::FitCursor);
1383 dr.forceBufferUpdate();
1387 case LFUN_LAYOUT_MODULES_CLEAR: {
1388 // FIXME: this modifies the document in cap::switchBetweenClasses
1389 // without calling recordUndo. Fix this before using
1390 // recordUndoBufferParams().
1391 cur.recordUndoFullBuffer();
1392 buffer_.params().clearLayoutModules();
1393 makeDocumentClass();
1394 dr.screenUpdate(Update::Force);
1395 dr.forceBufferUpdate();
1399 case LFUN_LAYOUT_MODULE_ADD: {
1400 BufferParams const & params = buffer_.params();
1401 if (!params.layoutModuleCanBeAdded(argument)) {
1402 LYXERR0("Module `" << argument <<
1403 "' cannot be added due to failed requirements or "
1404 "conflicts with installed modules.");
1407 // FIXME: this modifies the document in cap::switchBetweenClasses
1408 // without calling recordUndo. Fix this before using
1409 // recordUndoBufferParams().
1410 cur.recordUndoFullBuffer();
1411 buffer_.params().addLayoutModule(argument);
1412 makeDocumentClass();
1413 dr.screenUpdate(Update::Force);
1414 dr.forceBufferUpdate();
1418 case LFUN_TEXTCLASS_APPLY: {
1419 // since this shortcircuits, the second call is made only if
1421 bool const success =
1422 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1423 LayoutFileList::get().load(argument, buffer_.filePath());
1425 docstring s = bformat(_("The document class `%1$s' "
1426 "could not be loaded."), from_utf8(argument));
1427 frontend::Alert::error(_("Could not load class"), s);
1431 LayoutFile const * old_layout = buffer_.params().baseClass();
1432 LayoutFile const * new_layout = &(LayoutFileList::get()[argument]);
1434 if (old_layout == new_layout)
1438 // Save the old, possibly modular, layout for use in conversion.
1439 // FIXME: this modifies the document in cap::switchBetweenClasses
1440 // without calling recordUndo. Fix this before using
1441 // recordUndoBufferParams().
1442 cur.recordUndoFullBuffer();
1443 buffer_.params().setBaseClass(argument, buffer_.layoutPos());
1444 makeDocumentClass();
1445 dr.screenUpdate(Update::Force);
1446 dr.forceBufferUpdate();
1450 case LFUN_TEXTCLASS_LOAD: {
1451 // since this shortcircuits, the second call is made only if
1453 bool const success =
1454 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1455 LayoutFileList::get().load(argument, buffer_.filePath());
1457 docstring s = bformat(_("The document class `%1$s' "
1458 "could not be loaded."), from_utf8(argument));
1459 frontend::Alert::error(_("Could not load class"), s);
1464 case LFUN_LAYOUT_RELOAD: {
1465 LayoutFileIndex bc = buffer_.params().baseClassID();
1466 LayoutFileList::get().reset(bc);
1467 buffer_.params().setBaseClass(bc, buffer_.layoutPos());
1468 makeDocumentClass();
1469 dr.screenUpdate(Update::Force);
1470 dr.forceBufferUpdate();
1475 dr.setMessage(_("Undo"));
1476 cur.clearSelection();
1477 // We need to find out if the bibliography information
1478 // has changed. See bug #11055.
1479 // So these should not be references...
1480 string const engine = buffer().params().citeEngine();
1481 CiteEngineType const enginetype = buffer().params().citeEngineType();
1482 if (!cur.undoAction())
1483 dr.setMessage(_("No further undo information"));
1485 dr.screenUpdate(Update::Force | Update::FitCursor);
1486 dr.forceBufferUpdate();
1487 if (buffer().params().citeEngine() != engine ||
1488 buffer().params().citeEngineType() != enginetype)
1489 buffer().invalidateCiteLabels();
1495 dr.setMessage(_("Redo"));
1496 cur.clearSelection();
1497 // We need to find out if the bibliography information
1498 // has changed. See bug #11055.
1499 // So these should not be references...
1500 string const engine = buffer().params().citeEngine();
1501 CiteEngineType const enginetype = buffer().params().citeEngineType();
1502 if (!cur.redoAction())
1503 dr.setMessage(_("No further redo information"));
1505 dr.screenUpdate(Update::Force | Update::FitCursor);
1506 dr.forceBufferUpdate();
1507 if (buffer().params().citeEngine() != engine ||
1508 buffer().params().citeEngineType() != enginetype)
1509 buffer().invalidateCiteLabels();
1514 case LFUN_FONT_STATE:
1515 dr.setMessage(cur.currentState(false));
1518 case LFUN_BOOKMARK_SAVE:
1519 dr.screenUpdate(Update::Force);
1520 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1523 case LFUN_LABEL_GOTO: {
1524 docstring label = cmd.argument();
1525 if (label.empty()) {
1527 getInsetByCode<InsetRef>(cur, REF_CODE);
1529 label = inset->getParam("reference");
1530 // persistent=false: use temp_bookmark
1534 if (!label.empty()) {
1536 // at the moment, this is redundant, since gotoLabel will
1537 // eventually call LFUN_PARAGRAPH_GOTO, but it seems best
1539 dr.screenUpdate(Update::Force | Update::FitCursor);
1541 InsetMathRef * minset =
1542 getInsetByCode<InsetMathRef>(cur, MATH_REF_CODE);
1544 lyx::dispatch(FuncRequest(LFUN_LABEL_GOTO,
1545 minset->getTarget()));
1550 case LFUN_PARAGRAPH_GOTO: {
1551 int const id = convert<int>(cmd.getArg(0));
1552 pos_type const pos = convert<int>(cmd.getArg(1));
1555 string const str_id_end = cmd.getArg(2);
1556 string const str_pos_end = cmd.getArg(3);
1558 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1559 b = theBufferList().next(b)) {
1562 curs.setCursor(b->getParFromID(id));
1564 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1568 LYXERR(Debug::INFO, "Paragraph " << curs.paragraph().id()
1569 << " found in buffer `"
1570 << b->absFileName() << "'.");
1572 if (b == &buffer_) {
1574 if (str_id_end.empty() || str_pos_end.empty()) {
1577 mouseSetCursor(curs);
1580 int const id_end = convert<int>(str_id_end);
1581 pos_type const pos_end = convert<int>(str_pos_end);
1582 success = setCursorFromEntries({id, pos},
1586 dr.screenUpdate(Update::Force | Update::FitCursor);
1588 // Switch to other buffer view and resend cmd
1589 lyx::dispatch(FuncRequest(
1590 LFUN_BUFFER_SWITCH, b->absFileName()));
1598 case LFUN_NOTE_NEXT:
1599 gotoInset(this, { NOTE_CODE }, false);
1600 // FIXME: if SinglePar is changed to act on the inner
1601 // paragraph, this will not be OK anymore. The update is
1602 // useful for auto-open collapsible insets.
1603 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1606 case LFUN_REFERENCE_NEXT: {
1607 gotoInset(this, { LABEL_CODE, REF_CODE }, true);
1608 // FIXME: if SinglePar is changed to act on the inner
1609 // paragraph, this will not be OK anymore. The update is
1610 // useful for auto-open collapsible insets.
1611 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1615 case LFUN_CHANGE_NEXT:
1616 findNextChange(this);
1617 if (cur.inset().isTable())
1618 // In tables, there might be whole changed rows or columns
1620 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1621 dr.screenUpdate(Update::Force | Update::FitCursor);
1624 case LFUN_CHANGE_PREVIOUS:
1625 findPreviousChange(this);
1626 if (cur.inset().isTable())
1627 // In tables, there might be whole changed rows or columns
1629 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1630 dr.screenUpdate(Update::Force | Update::FitCursor);
1633 case LFUN_CHANGES_MERGE:
1634 if (findNextChange(this) || findPreviousChange(this)) {
1635 dr.screenUpdate(Update::Force | Update::FitCursor);
1636 dr.forceBufferUpdate();
1637 showDialog("changes");
1641 case LFUN_ALL_CHANGES_ACCEPT: {
1642 // select complete document
1644 cur.selHandle(true);
1645 buffer_.text().cursorBottom(cur);
1646 // accept everything in a single step to support atomic undo
1647 // temporarily disable track changes in order to end with really
1648 // no new (e.g., DPSM-caused) changes (see #7487)
1649 bool const track = buffer_.params().track_changes;
1650 buffer_.params().track_changes = false;
1651 buffer_.text().acceptOrRejectChanges(cur, Text::ACCEPT);
1652 buffer_.params().track_changes = track;
1654 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1655 dr.screenUpdate(Update::Force | Update::FitCursor);
1656 dr.forceBufferUpdate();
1660 case LFUN_ALL_CHANGES_REJECT: {
1661 // select complete document
1663 cur.selHandle(true);
1664 buffer_.text().cursorBottom(cur);
1665 // reject everything in a single step to support atomic undo
1666 // temporarily disable track changes in order to end with really
1667 // no new (e.g., DPSM-caused) changes (see #7487)
1668 bool const track = buffer_.params().track_changes;
1669 buffer_.params().track_changes = false;
1670 buffer_.text().acceptOrRejectChanges(cur, Text::REJECT);
1671 buffer_.params().track_changes = track;
1673 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1674 dr.screenUpdate(Update::Force | Update::FitCursor);
1675 dr.forceBufferUpdate();
1679 case LFUN_WORD_FIND_FORWARD:
1680 case LFUN_WORD_FIND_BACKWARD: {
1681 docstring searched_string;
1683 if (!cmd.argument().empty()) {
1684 setSearchRequestCache(cmd.argument());
1685 searched_string = cmd.argument();
1687 searched_string = searchRequestCache();
1690 if (searched_string.empty())
1693 docstring const data =
1694 find2string(searched_string, false, false,
1695 act == LFUN_WORD_FIND_FORWARD, false, false, false);
1696 bool found = lyxfind(this, FuncRequest(LFUN_WORD_FIND, data));
1698 dr.screenUpdate(Update::Force | Update::FitCursor);
1700 dr.setMessage(_("Search string not found!"));
1704 case LFUN_WORD_FIND: {
1705 docstring arg = cmd.argument();
1707 arg = searchRequestCache();
1709 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, "findreplace"));
1712 if (lyxfind(this, FuncRequest(act, arg)))
1713 dr.screenUpdate(Update::Force | Update::FitCursor);
1715 dr.setMessage(_("Search string not found!"));
1717 setSearchRequestCache(arg);
1721 case LFUN_SEARCH_STRING_SET: {
1722 docstring pattern = cmd.argument();
1723 if (!pattern.empty()) {
1724 setSearchRequestCache(pattern);
1727 if (cur.selection())
1728 pattern = cur.selectionAsString(false);
1730 pos_type spos = cur.pos();
1731 cur.innerText()->selectWord(cur, WHOLE_WORD);
1732 pattern = cur.selectionAsString(false);
1733 cur.selection(false);
1736 setSearchRequestCache(pattern);
1740 case LFUN_WORD_REPLACE: {
1741 if (lyxreplace(this, cmd)) {
1742 dr.forceBufferUpdate();
1743 dr.screenUpdate(Update::Force | Update::FitCursor);
1746 dr.setMessage(_("Search string not found!"));
1750 case LFUN_WORD_FINDADV: {
1751 FindAndReplaceOptions opt;
1752 istringstream iss(to_utf8(cmd.argument()));
1754 if (findAdv(this, opt)) {
1755 dr.screenUpdate(Update::Force | Update::FitCursor);
1766 cur.clearSelection();
1767 dr.setMessage(from_utf8(N_("Mark off")));
1771 cur.clearSelection();
1773 dr.setMessage(from_utf8(N_("Mark on")));
1776 case LFUN_MARK_TOGGLE:
1777 cur.selection(false);
1780 dr.setMessage(from_utf8(N_("Mark removed")));
1783 dr.setMessage(from_utf8(N_("Mark set")));
1788 case LFUN_SCREEN_SHOW_CURSOR:
1792 case LFUN_SCREEN_RECENTER:
1796 case LFUN_BIBTEX_DATABASE_ADD: {
1797 Cursor tmpcur = cur;
1798 findInset(tmpcur, { BIBTEX_CODE }, false);
1799 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1802 if (inset->addDatabase(cmd.argument()))
1803 dr.forceBufferUpdate();
1808 case LFUN_BIBTEX_DATABASE_DEL: {
1809 Cursor tmpcur = cur;
1810 findInset(tmpcur, { BIBTEX_CODE }, false);
1811 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1814 if (inset->delDatabase(cmd.argument()))
1815 dr.forceBufferUpdate();
1820 case LFUN_GRAPHICS_UNIFY: {
1822 cur.recordUndoFullBuffer();
1824 DocIterator from, to;
1825 from = cur.selectionBegin();
1826 to = cur.selectionEnd();
1828 string const newId = cmd.getArg(0);
1829 bool fetchId = newId.empty(); //if we wait for groupId from first graphics inset
1831 InsetGraphicsParams grp_par;
1833 InsetGraphics::string2params(graphics::getGroupParams(buffer_, newId), buffer_, grp_par);
1835 if (!from.nextInset()) //move to closest inset
1836 from.forwardInset();
1838 while (!from.empty() && from < to) {
1839 Inset * inset = from.nextInset();
1842 InsetGraphics * ig = inset->asInsetGraphics();
1844 InsetGraphicsParams inspar = ig->getParams();
1849 grp_par.filename = inspar.filename;
1850 ig->setParams(grp_par);
1853 from.forwardInset();
1855 dr.screenUpdate(Update::Force); //needed if triggered from context menu
1859 case LFUN_STATISTICS: {
1860 DocIterator from, to;
1861 if (cur.selection()) {
1862 from = cur.selectionBegin();
1863 to = cur.selectionEnd();
1865 from = doc_iterator_begin(&buffer_);
1866 to = doc_iterator_end(&buffer_);
1868 buffer_.updateStatistics(from, to);
1869 int const words = buffer_.wordCount();
1870 int const chars = buffer_.charCount(false);
1871 int const chars_blanks = buffer_.charCount(true);
1873 if (cur.selection())
1874 message = _("Statistics for the selection:");
1876 message = _("Statistics for the document:");
1879 message += bformat(_("%1$d words"), words);
1881 message += _("One word");
1883 if (chars_blanks != 1)
1884 message += bformat(_("%1$d characters (including blanks)"),
1887 message += _("One character (including blanks)");
1890 message += bformat(_("%1$d characters (excluding blanks)"),
1893 message += _("One character (excluding blanks)");
1895 Alert::information(_("Statistics"), message);
1899 case LFUN_SCREEN_UP:
1900 case LFUN_SCREEN_DOWN: {
1901 Point p = getPos(cur);
1902 // This code has been commented out to enable to scroll down a
1903 // document, even if there are large insets in it (see bug #5465).
1904 /*if (p.y_ < 0 || p.y_ > height_) {
1905 // The cursor is off-screen so recenter before proceeding.
1909 int const scrolled = scroll(act == LFUN_SCREEN_UP
1910 ? -height_ : height_);
1911 if (act == LFUN_SCREEN_UP && scrolled > -height_)
1913 if (act == LFUN_SCREEN_DOWN && scrolled < height_)
1914 p = Point(width_, height_);
1915 bool const in_texted = cur.inTexted();
1916 cur.setCursor(doc_iterator_begin(cur.buffer()));
1917 cur.selHandle(false);
1918 // Force an immediate computation of metrics because we need it below
1921 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_,
1922 true, act == LFUN_SCREEN_UP);
1923 //FIXME: what to do with cur.x_target()?
1924 bool update = in_texted && cur.bv().checkDepm(cur, old);
1927 if (update || cur.mark())
1928 dr.screenUpdate(Update::Force | Update::FitCursor);
1930 dr.forceBufferUpdate();
1935 string const scroll_type = cmd.getArg(0);
1936 int scroll_step = 0;
1937 if (scroll_type == "line")
1938 scroll_step = d->scrollbarParameters_.single_step;
1939 else if (scroll_type == "page")
1940 scroll_step = d->scrollbarParameters_.page_step;
1943 string const scroll_quantity = cmd.getArg(1);
1944 if (scroll_quantity == "up")
1945 scrollUp(scroll_step);
1946 else if (scroll_quantity == "down")
1947 scrollDown(scroll_step);
1949 int const scroll_value = convert<int>(scroll_quantity);
1951 scroll(scroll_step * scroll_value);
1953 dr.screenUpdate(Update::ForceDraw);
1954 dr.forceBufferUpdate();
1958 case LFUN_SCREEN_UP_SELECT: {
1959 // FIXME: why is the algorithm different from LFUN_SCREEN_UP?
1960 cur.selHandle(true);
1961 if (isTopScreen()) {
1962 lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1966 int y = getPos(cur).y_;
1967 int const ymin = y - height_ + defaultRowHeight();
1968 while (y > ymin && cur.up())
1972 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1976 case LFUN_SCREEN_DOWN_SELECT: {
1977 // FIXME: why is the algorithm different from LFUN_SCREEN_DOWN?
1978 cur.selHandle(true);
1979 if (isBottomScreen()) {
1980 lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1984 int y = getPos(cur).y_;
1985 int const ymax = y + height_ - defaultRowHeight();
1986 while (y < ymax && cur.down())
1990 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1995 case LFUN_INSET_SELECT_ALL: {
1996 // true if all cells are selected
1997 bool const all_selected = cur.depth() > 1
1998 && cur.selBegin().at_begin()
1999 && cur.selEnd().at_end();
2000 // true if some cells are selected
2001 bool const cells_selected = cur.depth() > 1
2002 && cur.selBegin().at_cell_begin()
2003 && cur.selEnd().at_cell_end();
2004 if (all_selected || (cells_selected && !cur.inset().isTable())) {
2005 // All the contents of the inset if selected, or only at
2006 // least one cell but inset is not a table.
2007 // Select the inset from outside.
2010 cur.selection(true);
2012 } else if (cells_selected) {
2013 // At least one complete cell is selected and inset is a table.
2019 cur.selection(true);
2020 cur.idx() = cur.lastidx();
2021 cur.pit() = cur.lastpit();
2022 cur.pos() = cur.lastpos();
2024 // select current cell
2028 cur.selection(true);
2029 cur.pit() = cur.lastpit();
2030 cur.pos() = cur.lastpos();
2032 cur.setCurrentFont();
2033 dr.screenUpdate(Update::Force);
2038 case LFUN_UNICODE_INSERT: {
2039 if (cmd.argument().empty())
2042 FuncCode code = cur.inset().currentMode() == Inset::MATH_MODE ?
2043 LFUN_MATH_INSERT : LFUN_SELF_INSERT;
2046 docstring const arg = from_utf8(cmd.getArg(i));
2050 LYXERR0("Not a hexstring: " << arg);
2054 char_type c = hexToInt(arg);
2055 if (c >= 32 && c < 0x10ffff) {
2056 LYXERR(Debug::KEY, "Inserting c: " << c);
2057 lyx::dispatch(FuncRequest(code, docstring(1, c)));
2065 // This would be in Buffer class if only Cursor did not
2066 // require a bufferview
2067 case LFUN_INSET_FORALL: {
2068 docstring const name = from_utf8(cmd.getArg(0));
2069 string const commandstr = cmd.getLongArg(1);
2070 FuncRequest const fr = lyxaction.lookupFunc(commandstr);
2072 // an arbitrary number to limit number of iterations
2073 const int max_iter = 100000;
2075 Cursor & curs = d->cursor_;
2076 Cursor const savecur = curs;
2078 if (!curs.nextInset())
2079 curs.forwardInset();
2080 curs.beginUndoGroup();
2081 while(curs && iterations < max_iter) {
2082 Inset * const ins = curs.nextInset();
2085 docstring insname = ins->layoutName();
2086 while (!insname.empty()) {
2087 if (insname == name || name == from_utf8("*")) {
2089 lyx::dispatch(fr, dr);
2093 size_t const i = insname.rfind(':');
2094 if (i == string::npos)
2096 insname = insname.substr(0, i);
2098 // if we did not delete the inset, skip it
2099 if (!curs.nextInset() || curs.nextInset() == ins)
2100 curs.forwardInset();
2104 /** This is a dummy undo record only to remember the cursor
2105 * that has just been set; this will be used on a redo action
2106 * (see ticket #10097)
2108 * FIXME: a better fix would be to have a way to set the
2109 * cursor value directly, but I am not sure it is worth it.
2112 curs.endUndoGroup();
2113 dr.screenUpdate(Update::Force);
2114 dr.forceBufferUpdate();
2116 if (iterations >= max_iter) {
2118 dr.setMessage(bformat(_("`inset-forall' interrupted because number of actions is larger than %1$d"), max_iter));
2120 dr.setMessage(bformat(_("Applied \"%1$s\" to %2$d insets"), from_utf8(commandstr), iterations));
2125 case LFUN_BRANCH_ADD_INSERT: {
2126 docstring branch_name = from_utf8(cmd.getArg(0));
2127 if (branch_name.empty())
2128 if (!Alert::askForText(branch_name, _("Branch name")) ||
2129 branch_name.empty())
2132 DispatchResult drtmp;
2133 buffer_.dispatch(FuncRequest(LFUN_BRANCH_ADD, branch_name), drtmp);
2134 if (drtmp.error()) {
2135 Alert::warning(_("Branch already exists"), drtmp.message());
2138 docstring const sep = buffer_.params().branchlist().separator();
2139 for (docstring const & branch : getVectorFromString(branch_name, sep))
2140 lyx::dispatch(FuncRequest(LFUN_BRANCH_INSERT, branch));
2144 case LFUN_KEYMAP_OFF:
2145 getIntl().keyMapOn(false);
2148 case LFUN_KEYMAP_PRIMARY:
2149 getIntl().keyMapPrim();
2152 case LFUN_KEYMAP_SECONDARY:
2153 getIntl().keyMapSec();
2156 case LFUN_KEYMAP_TOGGLE:
2157 getIntl().toggleKeyMap();
2160 case LFUN_DIALOG_SHOW_NEW_INSET: {
2161 string const name = cmd.getArg(0);
2162 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
2163 if (decodeInsetParam(name, data, buffer_))
2164 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
2166 lyxerr << "Inset type '" << name <<
2167 "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" << endl;
2171 case LFUN_CITATION_INSERT: {
2172 if (argument.empty()) {
2173 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
2176 // we can have one optional argument, delimited by '|'
2177 // citation-insert <key>|<text_before>
2178 // this should be enhanced to also support text_after
2179 // and citation style
2180 string arg = argument;
2182 if (contains(argument, "|")) {
2183 arg = token(argument, '|', 0);
2184 opt1 = token(argument, '|', 1);
2187 // if our cursor is directly in front of or behind a citation inset,
2188 // we will instead add the new key to it.
2189 Inset * inset = cur.nextInset();
2190 if (!inset || inset->lyxCode() != CITE_CODE)
2191 inset = cur.prevInset();
2192 if (inset && inset->lyxCode() == CITE_CODE) {
2193 InsetCitation * icite = static_cast<InsetCitation *>(inset);
2194 if (icite->addKey(arg)) {
2195 dr.forceBufferUpdate();
2196 dr.screenUpdate(Update::FitCursor | Update::SinglePar);
2198 LYXERR0("Discarding optional argument to citation-insert.");
2203 InsetCommandParams icp(CITE_CODE);
2204 icp["key"] = from_utf8(arg);
2206 icp["before"] = from_utf8(opt1);
2208 from_ascii(InsetCitation::last_literal ? "true" : "false");
2209 string icstr = InsetCommand::params2string(icp);
2210 FuncRequest fr(LFUN_INSET_INSERT, icstr);
2215 case LFUN_INSET_APPLY: {
2216 string const name = cmd.getArg(0);
2217 Inset * inset = editedInset(name);
2219 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
2223 // put cursor in front of inset.
2224 if (!setCursorFromInset(inset)) {
2225 LASSERT(false, break);
2228 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
2229 inset->dispatch(cur, fr);
2230 dr.screenUpdate(cur.result().screenUpdate());
2231 if (cur.result().needBufferUpdate())
2232 dr.forceBufferUpdate();
2237 // The change of language of buffer belongs to the Buffer class.
2238 // We have to do it here because we need a cursor for Undo.
2239 // When Undo::recordUndoBufferParams() is implemented someday
2240 // LFUN_BUFFER_LANGUAGE should be handled by the Buffer class.
2241 case LFUN_BUFFER_LANGUAGE: {
2242 Language const * oldL = buffer_.params().language;
2243 Language const * newL = languages.getLanguage(argument);
2244 if (!newL || oldL == newL)
2246 if (oldL->rightToLeft() == newL->rightToLeft()) {
2247 cur.recordUndoFullBuffer();
2248 buffer_.changeLanguage(oldL, newL);
2249 cur.setCurrentFont();
2250 dr.forceBufferUpdate();
2255 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
2256 case LFUN_FILE_INSERT_PLAINTEXT: {
2257 bool const as_paragraph = (act == LFUN_FILE_INSERT_PLAINTEXT_PARA);
2258 string const fname = to_utf8(cmd.argument());
2259 if (!FileName::isAbsolute(fname))
2260 dr.setMessage(_("Absolute filename expected."));
2262 insertPlaintextFile(FileName(fname), as_paragraph);
2267 // With multi-cell table content, we pass down to the inset
2268 if (cur.inTexted() && cur.selection()
2269 && cur.selectionBegin().idx() != cur.selectionEnd().idx()) {
2270 buffer_.dispatch(cmd, dr);
2271 dispatched = dr.dispatched();
2274 cap::copySelection(cur);
2275 cur.message(_("Copy"));
2279 // OK, so try the Buffer itself...
2280 buffer_.dispatch(cmd, dr);
2281 dispatched = dr.dispatched();
2285 buffer_.undo().endUndoGroup();
2286 dr.dispatched(dispatched);
2288 // NOTE: The code below is copied from Cursor::dispatch. If you
2289 // need to modify this, please update the other one too.
2291 // notify insets we just entered/left
2292 if (cursor() != old) {
2293 old.beginUndoGroup();
2295 bool badcursor = notifyCursorLeavesOrEnters(old, cursor());
2297 cursor().fixIfBroken();
2298 resetInlineCompletionPos();
2305 docstring BufferView::requestSelection()
2307 Cursor & cur = d->cursor_;
2309 LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
2310 if (!cur.selection()) {
2311 d->xsel_cache_.set = false;
2315 LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
2316 if (!d->xsel_cache_.set ||
2317 cur.top() != d->xsel_cache_.cursor ||
2318 cur.realAnchor().top() != d->xsel_cache_.anchor)
2320 d->xsel_cache_.cursor = cur.top();
2321 d->xsel_cache_.anchor = cur.realAnchor().top();
2322 d->xsel_cache_.set = cur.selection();
2323 return cur.selectionAsString(false);
2329 void BufferView::clearSelection()
2331 d->cursor_.clearSelection();
2332 // Clear the selection buffer. Otherwise a subsequent
2333 // middle-mouse-button paste would use the selection buffer,
2334 // not the more current external selection.
2335 cap::clearSelection();
2336 d->xsel_cache_.set = false;
2337 // The buffer did not really change, but this causes the
2338 // redraw we need because we cleared the selection above.
2339 buffer_.changed(false);
2343 void BufferView::resize(int width, int height)
2345 // Update from work area
2349 // Clear the paragraph height cache.
2350 d->par_height_.clear();
2351 // Redo the metrics.
2356 Inset const * BufferView::getCoveringInset(Text const & text,
2359 TextMetrics & tm = d->text_metrics_[&text];
2360 Inset * inset = tm.checkInsetHit(x, y);
2364 if (!inset->descendable(*this))
2365 // No need to go further down if the inset is not
2369 size_t cell_number = inset->nargs();
2370 // Check all the inner cell.
2371 for (size_t i = 0; i != cell_number; ++i) {
2372 Text const * inner_text = inset->getText(i);
2375 Inset const * inset_deeper =
2376 getCoveringInset(*inner_text, x, y);
2378 return inset_deeper;
2386 void BufferView::updateHoveredInset() const
2388 // Get inset under mouse, if there is one.
2389 int const x = d->mouse_position_cache_.x_;
2390 int const y = d->mouse_position_cache_.y_;
2391 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
2393 d->clickable_inset_ = covering_inset && covering_inset->clickable(*this, x, y);
2395 if (covering_inset == d->last_inset_)
2396 // Same inset, no need to do anything...
2399 bool need_redraw = false;
2400 if (d->last_inset_) {
2401 // Remove the hint on the last hovered inset (if any).
2402 need_redraw |= d->last_inset_->setMouseHover(this, false);
2403 d->last_inset_ = nullptr;
2406 if (covering_inset && covering_inset->setMouseHover(this, true)) {
2408 // Only the insets that accept the hover state, do
2409 // clear the last_inset_, so only set the last_inset_
2410 // member if the hovered setting is accepted.
2411 d->last_inset_ = covering_inset;
2415 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
2416 << d->mouse_position_cache_.x_ << ", "
2417 << d->mouse_position_cache_.y_ << ")");
2419 d->update_strategy_ = DecorationUpdate;
2421 // This event (moving without mouse click) is not passed further.
2422 // This should be changed if it is further utilized.
2423 buffer_.changed(false);
2428 void BufferView::clearLastInset(Inset * inset) const
2430 if (d->last_inset_ != inset) {
2431 LYXERR0("Wrong last_inset!");
2434 d->last_inset_ = nullptr;
2438 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
2440 //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
2442 // This is only called for mouse related events including
2443 // LFUN_FILE_OPEN generated by drag-and-drop.
2444 FuncRequest cmd = cmd0;
2446 Cursor old = cursor();
2448 cur.push(buffer_.inset());
2449 cur.selection(d->cursor_.selection());
2451 // Either the inset under the cursor or the
2452 // surrounding Text will handle this event.
2454 // make sure we stay within the screen...
2455 cmd.set_y(min(max(cmd.y(), -1), height_));
2457 d->mouse_position_cache_.x_ = cmd.x();
2458 d->mouse_position_cache_.y_ = cmd.y();
2460 if (cmd.action() == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
2461 updateHoveredInset();
2465 // Build temporary cursor.
2466 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x(), cmd.y());
2468 // If inset is not editable, cur.pos() might point behind the
2469 // inset (depending on cmd.x(), cmd.y()). This is needed for
2470 // editing to fix bug 9628, but e.g. the context menu needs a
2471 // cursor in front of the inset.
2472 if ((inset->hasSettings() || !inset->contextMenuName().empty()
2473 || inset->lyxCode() == SEPARATOR_CODE) &&
2474 cur.nextInset() != inset && cur.prevInset() == inset)
2476 } else if (cur.inTexted() && cur.pos()
2477 && cur.paragraph().isEnvSeparator(cur.pos() - 1)) {
2478 // Always place cursor in front of a separator inset.
2482 // Put anchor at the same position.
2485 cur.beginUndoGroup();
2487 // Try to dispatch to an non-editable inset near this position
2488 // via the temp cursor. If the inset wishes to change the real
2489 // cursor it has to do so explicitly by using
2490 // cur.bv().cursor() = cur; (or similar)
2492 inset->dispatch(cur, cmd);
2494 // Now dispatch to the temporary cursor. If the real cursor should
2495 // be modified, the inset's dispatch has to do so explicitly.
2496 if (!inset || !cur.result().dispatched())
2499 // Notify left insets
2501 bool badcursor = old.fixIfBroken() | cur.fixIfBroken();
2502 badcursor |= notifyCursorLeavesOrEnters(old, cur);
2504 cursor().fixIfBroken();
2509 // Do we have a selection?
2510 theSelection().haveSelection(cursor().selection());
2512 if (cur.needBufferUpdate() || buffer().needUpdate()) {
2513 cur.clearBufferUpdate();
2514 buffer().updateBuffer();
2517 // If the command has been dispatched,
2518 if (cur.result().dispatched() || cur.result().screenUpdate())
2519 processUpdateFlags(cur.result().screenUpdate());
2523 int BufferView::minVisiblePart()
2525 return 2 * defaultRowHeight();
2529 int BufferView::scroll(int pixels)
2532 return scrollDown(pixels);
2534 return scrollUp(-pixels);
2539 int BufferView::scrollDown(int pixels)
2541 Text * text = &buffer_.text();
2542 TextMetrics & tm = d->text_metrics_[text];
2543 int const ymax = height_ + pixels;
2545 pair<pit_type, ParagraphMetrics const *> last = tm.last();
2546 int bottom_pos = last.second->position() + last.second->descent();
2547 if (lyxrc.scroll_below_document)
2548 bottom_pos += height_ - minVisiblePart();
2549 if (last.first + 1 == int(text->paragraphs().size())) {
2550 if (bottom_pos <= height_)
2552 pixels = min(pixels, bottom_pos - height_);
2555 if (bottom_pos > ymax)
2557 tm.newParMetricsDown();
2559 d->anchor_ypos_ -= pixels;
2564 int BufferView::scrollUp(int pixels)
2566 Text * text = &buffer_.text();
2567 TextMetrics & tm = d->text_metrics_[text];
2568 int ymin = - pixels;
2570 pair<pit_type, ParagraphMetrics const *> first = tm.first();
2571 int top_pos = first.second->position() - first.second->ascent();
2572 if (first.first == 0) {
2575 pixels = min(pixels, - top_pos);
2580 tm.newParMetricsUp();
2582 d->anchor_ypos_ += pixels;
2587 bool BufferView::setCursorFromRow(int row)
2589 TexRow::TextEntry start, end;
2590 tie(start,end) = buffer_.texrow().getEntriesFromRow(row);
2591 LYXERR(Debug::LATEX,
2592 "setCursorFromRow: for row " << row << ", TexRow has found "
2593 "start (id=" << start.id << ",pos=" << start.pos << "), "
2594 "end (id=" << end.id << ",pos=" << end.pos << ")");
2595 return setCursorFromEntries(start, end);
2599 bool BufferView::setCursorFromEntries(TexRow::TextEntry start,
2600 TexRow::TextEntry end)
2602 DocIterator dit_start, dit_end;
2603 tie(dit_start,dit_end) =
2604 TexRow::getDocIteratorsFromEntries(start, end, buffer_);
2607 // Setting selection start
2608 d->cursor_.clearSelection();
2609 setCursor(dit_start);
2610 // Setting selection end
2612 d->cursor_.resetAnchor();
2613 setCursorSelectionTo(dit_end);
2619 bool BufferView::setCursorFromInset(Inset const * inset)
2621 // are we already there?
2622 if (cursor().nextInset() == inset)
2625 // Inset is not at cursor position. Find it in the document.
2628 while (cur && cur.nextInset() != inset)
2639 void BufferView::gotoLabel(docstring const & label)
2642 bool have_inactive = false;
2643 for (Buffer const * buf : buffer().allRelatives()) {
2645 for (TocItem const & item : *buf->tocBackend().toc("label")) {
2646 if (label == item.str() && item.isOutput()) {
2647 lyx::dispatch(item.action());
2650 // If we find an inactive label, save it for the case
2651 // that no active one is there
2652 if (label == item.str() && !have_inactive) {
2653 have_inactive = true;
2654 action = item.action();
2658 // We only found an inactive label. Go there.
2660 lyx::dispatch(action);
2664 TextMetrics const & BufferView::textMetrics(Text const * t) const
2666 return const_cast<BufferView *>(this)->textMetrics(t);
2670 TextMetrics & BufferView::textMetrics(Text const * t)
2673 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
2674 if (tmc_it == d->text_metrics_.end()) {
2675 tmc_it = d->text_metrics_.emplace(std::piecewise_construct,
2676 std::forward_as_tuple(t),
2677 std::forward_as_tuple(this, const_cast<Text *>(t))).first;
2679 return tmc_it->second;
2683 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
2686 return textMetrics(t).parMetrics(pit);
2690 int BufferView::workHeight() const
2696 void BufferView::setCursor(DocIterator const & dit)
2699 size_t const n = dit.depth();
2700 for (size_t i = 0; i < n; ++i)
2701 dit[i].inset().edit(d->cursor_, true);
2703 d->cursor_.setCursor(dit);
2704 d->cursor_.selection(false);
2705 d->cursor_.setCurrentFont();
2707 // It seems on general grounds as if this is probably needed, but
2708 // it is not yet clear.
2709 // See bug #7394 and r38388.
2710 // d->cursor.resetAnchor();
2714 void BufferView::setCursorSelectionTo(DocIterator const & dit)
2716 size_t const n = dit.depth();
2717 for (size_t i = 0; i < n; ++i)
2718 dit[i].inset().edit(d->cursor_, true);
2720 d->cursor_.selection(true);
2721 d->cursor_.setCursorSelectionTo(dit);
2722 d->cursor_.setCurrentFont();
2726 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
2728 // Would be wrong to delete anything if we have a selection.
2729 if (cur.selection())
2732 bool need_anchor_change = false;
2733 bool changed = Text::deleteEmptyParagraphMechanism(cur, old,
2734 need_anchor_change);
2736 if (need_anchor_change)
2744 // we would rather not do this here, but it needs to be done before
2745 // the changed() signal is sent.
2746 buffer_.updateBuffer();
2748 buffer_.changed(true);
2753 bool BufferView::mouseSetCursor(Cursor & cur, bool const select)
2755 LASSERT(&cur.bv() == this, return false);
2758 // this event will clear selection so we save selection for
2759 // persistent selection
2760 cap::saveSelection(cursor());
2762 d->cursor_.macroModeClose();
2763 // If a macro has been finalized, the cursor might have been broken
2766 // Has the cursor just left the inset?
2767 bool const leftinset = (&d->cursor_.inset() != &cur.inset());
2769 d->cursor_.fixIfBroken();
2771 // do the dEPM magic if needed
2772 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
2773 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
2774 // the leftinset bool would not be necessary (badcursor instead).
2775 bool update = leftinset;
2778 d->cursor_.setSelection();
2779 d->cursor_.setCursorSelectionTo(cur);
2781 if (d->cursor_.inTexted())
2782 update |= checkDepm(cur, d->cursor_);
2783 d->cursor_.resetAnchor();
2784 d->cursor_.setCursor(cur);
2785 d->cursor_.clearSelection();
2787 d->cursor_.boundary(cur.boundary());
2788 d->cursor_.finishUndo();
2789 d->cursor_.setCurrentFont();
2791 cur.forceBufferUpdate();
2796 void BufferView::putSelectionAt(DocIterator const & cur,
2797 int length, bool backwards)
2799 d->cursor_.clearSelection();
2805 d->cursor_.pos() += length;
2806 d->cursor_.setSelection(d->cursor_, -length);
2808 d->cursor_.setSelection(d->cursor_, length);
2813 bool BufferView::selectIfEmpty(DocIterator & cur)
2815 if ((cur.inTexted() && !cur.paragraph().empty())
2816 || (cur.inMathed() && !cur.cell().empty()))
2819 pit_type const beg_pit = cur.pit();
2821 // The paragraph associated to this item isn't
2822 // the first one, so it can be selected
2825 // We have to resort to select the space between the
2826 // end of this item and the begin of the next one
2830 // If it is the only item in the document,
2831 // nothing can be selected
2834 pit_type const end_pit = cur.pit();
2835 pos_type const end_pos = cur.pos();
2836 d->cursor_.clearSelection();
2838 d->cursor_.setCursor(cur);
2839 d->cursor_.pit() = beg_pit;
2840 d->cursor_.pos() = 0;
2841 d->cursor_.selection(false);
2842 d->cursor_.resetAnchor();
2843 d->cursor_.pit() = end_pit;
2844 d->cursor_.pos() = end_pos;
2845 d->cursor_.setSelection();
2850 Cursor & BufferView::cursor()
2856 Cursor const & BufferView::cursor() const
2862 bool BufferView::singleParUpdate()
2864 Text & buftext = buffer_.text();
2865 pit_type const bottom_pit = d->cursor_.bottom().pit();
2866 TextMetrics & tm = textMetrics(&buftext);
2867 Dimension const old_dim = tm.parMetrics(bottom_pit).dim();
2869 // make sure inline completion pointer is ok
2870 if (d->inlineCompletionPos_.fixIfBroken())
2871 d->inlineCompletionPos_ = DocIterator();
2873 // In Single Paragraph mode, rebreak only
2874 // the (main text, not inset!) paragraph containing the cursor.
2875 // (if this paragraph contains insets etc., rebreaking will
2876 // recursively descend)
2877 tm.redoParagraph(bottom_pit);
2878 ParagraphMetrics & pm = tm.parMetrics(bottom_pit);
2879 if (pm.height() != old_dim.height()) {
2880 // Paragraph height has changed so we cannot proceed to
2881 // the singlePar optimisation.
2884 // Since position() points to the baseline of the first row, we
2885 // may have to update it. See ticket #11601 for an example where
2886 // the height does not change but the ascent does.
2887 pm.setPosition(pm.position() - old_dim.ascent() + pm.ascent());
2889 tm.updatePosCache(bottom_pit);
2891 LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
2892 << " y2: " << pm.position() + pm.descent()
2893 << " pit: " << bottom_pit
2894 << " singlepar: 1");
2899 void BufferView::updateMetrics()
2901 updateMetrics(d->update_flags_);
2902 d->update_strategy_ = FullScreenUpdate;
2906 void BufferView::updateMetrics(Update::flags & update_flags)
2908 if (height_ == 0 || width_ == 0)
2911 Text & buftext = buffer_.text();
2912 pit_type const npit = int(buftext.paragraphs().size());
2914 // Clear out the position cache in case of full screen redraw,
2915 d->coord_cache_.clear();
2916 d->math_rows_.clear();
2918 // Clear out paragraph metrics to avoid having invalid metrics
2919 // in the cache from paragraphs not relayouted below
2920 // The complete text metrics will be redone.
2921 d->text_metrics_.clear();
2923 TextMetrics & tm = textMetrics(&buftext);
2925 // make sure inline completion pointer is ok
2926 if (d->inlineCompletionPos_.fixIfBroken())
2927 d->inlineCompletionPos_ = DocIterator();
2929 if (d->anchor_pit_ >= npit)
2930 // The anchor pit must have been deleted...
2931 d->anchor_pit_ = npit - 1;
2933 // Rebreak anchor paragraph.
2934 tm.redoParagraph(d->anchor_pit_);
2935 ParagraphMetrics & anchor_pm = tm.parMetrics(d->anchor_pit_);
2938 if (d->anchor_pit_ == 0) {
2939 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
2941 // Complete buffer visible? Then it's easy.
2942 if (scrollRange == 0)
2943 d->anchor_ypos_ = anchor_pm.ascent();
2945 // avoid empty space above the first row
2946 d->anchor_ypos_ = min(d->anchor_ypos_, anchor_pm.ascent());
2949 anchor_pm.setPosition(d->anchor_ypos_);
2950 tm.updatePosCache(d->anchor_pit_);
2952 LYXERR(Debug::PAINTING, "metrics: "
2953 << " anchor pit = " << d->anchor_pit_
2954 << " anchor ypos = " << d->anchor_ypos_);
2956 // Redo paragraphs above anchor if necessary.
2957 int y1 = d->anchor_ypos_ - anchor_pm.ascent();
2958 // We are now just above the anchor paragraph.
2959 pit_type pit1 = d->anchor_pit_ - 1;
2960 for (; pit1 >= 0 && y1 >= 0; --pit1) {
2961 tm.redoParagraph(pit1);
2962 ParagraphMetrics & pm = tm.parMetrics(pit1);
2964 // Save the paragraph position in the cache.
2966 tm.updatePosCache(pit1);
2970 // Redo paragraphs below the anchor if necessary.
2971 int y2 = d->anchor_ypos_ + anchor_pm.descent();
2972 // We are now just below the anchor paragraph.
2973 pit_type pit2 = d->anchor_pit_ + 1;
2974 for (; pit2 < npit && y2 <= height_; ++pit2) {
2975 tm.redoParagraph(pit2);
2976 ParagraphMetrics & pm = tm.parMetrics(pit2);
2978 // Save the paragraph position in the cache.
2980 tm.updatePosCache(pit2);
2984 LYXERR(Debug::PAINTING, "Metrics: "
2985 << " anchor pit = " << d->anchor_pit_
2986 << " anchor ypos = " << d->anchor_ypos_
2989 << " pit1 = " << pit1
2990 << " pit2 = " << pit2);
2992 // metrics is done, full drawing is necessary now
2993 update_flags = (update_flags & ~Update::Force) | Update::ForceDraw;
2995 // Now update the positions of insets in the cache.
2998 if (lyxerr.debugging(Debug::WORKAREA)) {
2999 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
3000 d->coord_cache_.dump();
3005 void BufferView::updatePosCache()
3007 // this is the "nodraw" drawing stage: only set the positions of the
3008 // insets in metrics cache.
3009 frontend::NullPainter np;
3014 void BufferView::insertLyXFile(FileName const & fname, bool const ignorelang)
3016 LASSERT(d->cursor_.inTexted(), return);
3018 // Get absolute path of file and add ".lyx"
3019 // to the filename if necessary
3020 FileName filename = fileSearch(string(), fname.absFileName(), "lyx");
3022 docstring const disp_fn = makeDisplayPath(filename.absFileName());
3023 // emit message signal.
3024 message(bformat(_("Inserting document %1$s..."), disp_fn));
3027 Buffer buf(filename.absFileName(), false);
3028 if (buf.loadLyXFile() == Buffer::ReadSuccess) {
3029 ErrorList & el = buffer_.errorList("Parse");
3030 // Copy the inserted document error list into the current buffer one.
3031 el = buf.errorList("Parse");
3032 ParagraphList & pars = buf.paragraphs();
3034 // set main language of imported file to context language
3035 buf.changeLanguage(buf.language(), d->cursor_.getFont().language());
3036 buffer_.undo().recordUndo(d->cursor_);
3037 cap::pasteParagraphList(d->cursor_, pars,
3038 buf.params().documentClassPtr(),
3039 buf.params().authors(), el);
3040 res = _("Document %1$s inserted.");
3042 res = _("Could not insert document %1$s");
3045 buffer_.changed(true);
3046 // emit message signal.
3047 message(bformat(res, disp_fn));
3051 Point BufferView::coordOffset(DocIterator const & dit) const
3057 // Addup contribution of nested insets, from inside to outside,
3058 // keeping the outer paragraph for a special handling below
3059 for (size_t i = dit.depth() - 1; i >= 1; --i) {
3060 CursorSlice const & sl = dit[i];
3064 // get relative position inside sl.inset()
3065 sl.inset().cursorPos(*this, sl, dit.boundary() && (i + 1 == dit.depth()), xx, yy);
3067 // Make relative position inside of the edited inset relative to sl.inset()
3071 // In case of an RTL inset, the edited inset will be positioned to the left
3074 bool boundary_i = dit.boundary() && i + 1 == dit.depth();
3075 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
3080 // remember width for the case that sl.inset() is positioned in an RTL inset
3081 lastw = sl.inset().dimension(*this).wid;
3083 //lyxerr << "Cursor::getPos, i: "
3084 // << i << " x: " << xx << " y: " << y << endl;
3087 // Add contribution of initial rows of outermost paragraph
3088 CursorSlice const & sl = dit[0];
3089 TextMetrics const & tm = textMetrics(sl.text());
3090 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
3092 LBUFERR(!pm.rows().empty());
3093 y -= pm.rows()[0].ascent();
3095 // FIXME: document this mess
3097 if (sl.pos() > 0 && dit.depth() == 1) {
3099 if (pos && dit.boundary())
3101 // lyxerr << "coordOffset: boundary:" << dit.boundary() << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
3102 rend = pm.pos2row(pos);
3104 rend = pm.pos2row(sl.pos());
3106 size_t rend = pm.pos2row(sl.pos());
3108 for (size_t rit = 0; rit != rend; ++rit)
3109 y += pm.rows()[rit].height();
3110 y += pm.rows()[rend].ascent();
3112 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
3114 // Make relative position from the nested inset now bufferview absolute.
3115 int xx = bottom_tm.cursorX(dit.bottom(), dit.boundary() && dit.depth() == 1);
3118 // In the RTL case place the nested inset at the left of the cursor in
3119 // the outer paragraph
3120 bool boundary_1 = dit.boundary() && 1 == dit.depth();
3121 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
3129 Point BufferView::getPos(DocIterator const & dit) const
3131 if (!paragraphVisible(dit))
3132 return Point(-1, -1);
3134 CursorSlice const & bot = dit.bottom();
3135 TextMetrics const & tm = textMetrics(bot.text());
3137 // offset from outer paragraph
3138 Point p = coordOffset(dit);
3139 p.y_ += tm.parMetrics(bot.pit()).position();
3144 bool BufferView::paragraphVisible(DocIterator const & dit) const
3146 CursorSlice const & bot = dit.bottom();
3147 TextMetrics const & tm = textMetrics(bot.text());
3149 return tm.contains(bot.pit());
3153 void BufferView::caretPosAndDim(Point & p, Dimension & dim) const
3155 Cursor const & cur = cursor();
3156 if (cur.inMathed()) {
3157 MathRow const & mrow = mathRow(&cur.cell());
3158 dim = mrow.caret_dim;
3160 Font const font = cur.real_current_font;
3161 frontend::FontMetrics const & fm = theFontMetrics(font);
3162 dim.wid = fm.lineWidth();
3163 dim.asc = fm.maxAscent();
3164 dim.des = fm.maxDescent();
3166 if (lyxrc.cursor_width > 0)
3167 dim.wid = lyxrc.cursor_width;
3170 // center fat carets horizontally
3171 p.x_ -= dim.wid / 2;
3177 void BufferView::buildCaretGeometry(bool complet)
3181 caretPosAndDim(p, dim);
3183 Cursor const & cur = d->cursor_;
3184 Font const & realfont = cur.real_current_font;
3185 frontend::FontMetrics const & fm = theFontMetrics(realfont.fontInfo());
3186 bool const isrtl = realfont.isVisibleRightToLeft();
3187 int const dir = isrtl ? -1 : 1;
3189 frontend::CaretGeometry & cg = d->caret_geometry_;
3192 // The caret itself, slanted for italics in text edit mode except
3193 // for selections because the selection rect does not slant
3194 bool const slant = fm.italic() && cur.inTexted() && !cur.selection();
3195 double const slope = slant ? fm.italicSlope() : 0;
3196 cg.shapes.push_back(
3197 {{iround(p.x_ + dim.asc * slope), p.y_},
3198 {iround(p.x_ - dim.des * slope), p.y_ + dim.height()},
3199 {iround(p.x_ + dir * dim.wid - dim.des * slope), p.y_ + dim.height()},
3200 {iround(p.x_ + dir * dim.wid + dim.asc * slope), p.y_}}
3203 // The language indicator _| (if needed)
3204 Language const * doclang = buffer().params().language;
3205 if (!((realfont.language() == doclang && isrtl == doclang->rightToLeft())
3206 || realfont.language() == latex_language)) {
3207 int const lx = dim.height() / 3;
3208 int const xx = iround(p.x_ - dim.des * slope);
3209 int const yy = p.y_ + dim.height();
3210 cg.shapes.push_back(
3211 {{xx, yy - dim.wid},
3212 {xx + dir * (dim.wid + lx - 1), yy - dim.wid},
3213 {xx + dir * (dim.wid + lx - 1), yy},
3218 // The completion triangle |> (if needed)
3220 int const m = p.y_ + dim.height() / 2;
3221 int const d = dim.height() / 8;
3222 // offset for slanted carret
3223 int const sx = iround((dim.asc - (dim.height() / 2 - d)) * slope);
3224 // starting position x
3225 int const xx = p.x_ + dir * dim.wid + sx;
3226 cg.shapes.push_back(
3230 {xx, m + d - dim.wid},
3231 {xx + dir * d - dim.wid, m},
3232 {xx, m - d + dim.wid}}
3236 // compute extremal x values
3238 cg.right = -1000000;
3240 cg.bottom = -1000000;
3241 for (auto const & shape : cg.shapes)
3242 for (Point const & p : shape) {
3243 cg.left = min(cg.left, p.x_);
3244 cg.right = max(cg.right, p.x_);
3245 cg.top = min(cg.top, p.y_);
3246 cg.bottom = max(cg.bottom, p.y_);
3251 frontend::CaretGeometry const & BufferView::caretGeometry() const
3253 return d->caret_geometry_;
3257 bool BufferView::caretInView() const
3259 if (!paragraphVisible(cursor()))
3263 caretPosAndDim(p, dim);
3265 // does the cursor touch the screen ?
3266 if (p.y_ + dim.height() < 0 || p.y_ >= workHeight())
3272 int BufferView::horizScrollOffset() const
3274 return d->horiz_scroll_offset_;
3278 int BufferView::horizScrollOffset(Text const * text,
3279 pit_type pit, pos_type pos) const
3281 // Is this a row that is currently scrolled?
3282 if (!d->current_row_slice_.empty()
3283 && &text->inset() == d->current_row_slice_.inset().asInsetText()
3284 && pit == d->current_row_slice_.pit()
3285 && pos == d->current_row_slice_.pos())
3286 return d->horiz_scroll_offset_;
3291 void BufferView::setCurrentRowSlice(CursorSlice const & rowSlice)
3293 // nothing to do if the cursor was already on this row
3294 if (d->current_row_slice_ == rowSlice)
3297 // if the (previous) current row was scrolled, we have to
3298 // remember it in order to repaint it next time.
3299 if (d->horiz_scroll_offset_ != 0) {
3300 // search the old row in cache and mark it changed
3301 for (auto & tm_pair : d->text_metrics_) {
3302 if (&tm_pair.first->inset() == rowSlice.inset().asInsetText()) {
3303 tm_pair.second.setRowChanged(rowSlice.pit(), rowSlice.pos());
3304 // We found it, no need to continue.
3310 // Since we changed row, the scroll offset is not valid anymore
3311 d->horiz_scroll_offset_ = 0;
3312 d->current_row_slice_ = rowSlice;
3316 void BufferView::checkCursorScrollOffset()
3318 CursorSlice rowSlice = d->cursor_.bottom();
3319 TextMetrics const & tm = textMetrics(rowSlice.text());
3321 // Stop if metrics have not been computed yet, since it means
3322 // that there is nothing to do.
3323 if (!tm.contains(rowSlice.pit()))
3325 ParagraphMetrics const & pm = tm.parMetrics(rowSlice.pit());
3326 Row const & row = pm.getRow(rowSlice.pos(),
3327 d->cursor_.boundary() && rowSlice == d->cursor_.top());
3328 rowSlice.pos() = row.pos();
3330 // Set the row on which the cursor lives.
3331 setCurrentRowSlice(rowSlice);
3333 // Current x position of the cursor in pixels
3334 int cur_x = getPos(d->cursor_).x_;
3336 // Horizontal scroll offset of the cursor row in pixels
3337 int offset = d->horiz_scroll_offset_;
3338 int const MARGIN = 2 * theFontMetrics(d->cursor_.real_current_font).em()
3340 if (row.right_x() <= workWidth() - row.right_margin) {
3341 // Row is narrower than the work area, no offset needed.
3344 if (cur_x - offset < MARGIN) {
3345 // cursor would be too far right
3346 offset = cur_x - MARGIN;
3347 } else if (cur_x - offset > workWidth() - MARGIN) {
3348 // cursor would be too far left
3349 offset = cur_x - workWidth() + MARGIN;
3351 // Correct the offset to make sure that we do not scroll too much
3354 if (row.right_x() - offset < workWidth() - row.right_margin)
3355 offset = row.right_x() - workWidth() + row.right_margin;
3358 //lyxerr << "cur_x=" << cur_x << ", offset=" << offset << ", row.wid=" << row.width() << ", margin=" << MARGIN << endl;
3360 if (offset != d->horiz_scroll_offset_)
3361 LYXERR(Debug::PAINTING, "Horiz. scroll offset changed from "
3362 << d->horiz_scroll_offset_ << " to " << offset);
3364 if (d->update_strategy_ == NoScreenUpdate
3365 && offset != d->horiz_scroll_offset_) {
3366 // FIXME: if one uses SingleParUpdate, then home/end
3367 // will not work on long rows. Why?
3368 d->update_strategy_ = FullScreenUpdate;
3371 d->horiz_scroll_offset_ = offset;
3375 void BufferView::draw(frontend::Painter & pain, bool paint_caret)
3377 if (height_ == 0 || width_ == 0)
3379 LYXERR(Debug::PAINTING, (pain.isNull() ? "\t\t--- START NODRAW ---"
3380 : "\t\t*** START DRAWING ***"));
3381 Text & text = buffer_.text();
3382 TextMetrics const & tm = d->text_metrics_[&text];
3383 int const y = tm.first().second->position();
3384 PainterInfo pi(this, pain);
3386 // Check whether the row where the cursor lives needs to be scrolled.
3387 // Update the drawing strategy if needed.
3388 checkCursorScrollOffset();
3390 switch (d->update_strategy_) {
3392 case NoScreenUpdate:
3393 // no screen painting is actually needed. In nodraw stage
3394 // however, the different coordinates of insets and paragraphs
3395 // needs to be updated.
3396 LYXERR(Debug::PAINTING, "Strategy: NoScreenUpdate");
3397 if (pain.isNull()) {
3398 pi.full_repaint = true;
3401 pi.full_repaint = false;
3406 case SingleParUpdate:
3407 pi.full_repaint = false;
3408 LYXERR(Debug::PAINTING, "Strategy: SingleParUpdate");
3409 // In general, only the current row of the outermost paragraph
3410 // will be redrawn. Particular cases where selection spans
3411 // multiple paragraph are correctly detected in TextMetrics.
3415 case DecorationUpdate:
3416 // FIXME: We should also distinguish DecorationUpdate to avoid text
3417 // drawing if possible. This is not possible to do easily right now
3418 // because of the single backing pixmap.
3420 case FullScreenUpdate:
3422 LYXERR(Debug::PAINTING,
3423 ((d->update_strategy_ == FullScreenUpdate)
3424 ? "Strategy: FullScreenUpdate"
3425 : "Strategy: DecorationUpdate"));
3427 // The whole screen, including insets, will be refreshed.
3428 pi.full_repaint = true;
3430 // Clear background.
3431 pain.fillRectangle(0, 0, width_, height_,
3432 pi.backgroundColor(&buffer_.inset()));
3437 // and possibly grey out below
3438 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3439 int const y2 = lastpm.second->position() + lastpm.second->descent();
3442 Color color = buffer().isInternal()
3443 ? Color_background : Color_bottomarea;
3444 pain.fillRectangle(0, y2, width_, height_ - y2, color);
3448 LYXERR(Debug::PAINTING, (pain.isNull() ? "\t\t --- END NODRAW ---"
3449 : "\t\t *** END DRAWING ***"));
3451 // The scrollbar needs an update.
3452 // FIXME: does it always? see ticket #11947.
3455 // Normalize anchor for next time
3456 pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
3457 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3458 for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
3459 ParagraphMetrics const & pm = tm.parMetrics(pit);
3460 if (pm.position() + pm.descent() > 0) {
3461 if (d->anchor_pit_ != pit
3462 || d->anchor_ypos_ != pm.position())
3463 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
3464 << " anchor ypos = " << d->anchor_ypos_);
3465 d->anchor_pit_ = pit;
3466 d->anchor_ypos_ = pm.position();
3470 if (!pain.isNull()) {
3471 // reset the update flags, everything has been done
3472 d->update_flags_ = Update::None;
3475 // If a caret has to be painted, mark its text row as dirty to
3476 //make sure that it will be repainted on next redraw.
3477 /* FIXME: investigate whether this can be avoided when the cursor did not
3481 Cursor cur(d->cursor_);
3482 while (cur.depth() > 1) {
3483 if (!cur.inTexted())
3485 TextMetrics const & tm = textMetrics(cur.text());
3486 if (d->caret_geometry_.left >= tm.origin().x_
3487 && d->caret_geometry_.right <= tm.origin().x_ + tm.dim().width())
3491 cur.textRow().changed(true);
3496 void BufferView::message(docstring const & msg)
3499 d->gui_->message(msg);
3503 void BufferView::showDialog(string const & name)
3506 d->gui_->showDialog(name, string());
3510 void BufferView::showDialog(string const & name,
3511 string const & data, Inset * inset)
3514 d->gui_->showDialog(name, data, inset);
3518 void BufferView::updateDialog(string const & name, string const & data)
3521 d->gui_->updateDialog(name, data);
3525 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
3531 // FIXME: Move this out of BufferView again
3532 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
3534 if (!fname.isReadableFile()) {
3535 docstring const error = from_ascii(strerror(errno));
3536 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3537 docstring const text =
3538 bformat(_("Could not read the specified document\n"
3539 "%1$s\ndue to the error: %2$s"), file, error);
3540 Alert::error(_("Could not read file"), text);
3544 if (!fname.isReadableFile()) {
3545 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3546 docstring const text =
3547 bformat(_("%1$s\n is not readable."), file);
3548 Alert::error(_("Could not open file"), text);
3552 // FIXME UNICODE: We don't know the encoding of the file
3553 docstring file_content = fname.fileContents("UTF-8");
3554 if (file_content.empty()) {
3555 Alert::error(_("Reading not UTF-8 encoded file"),
3556 _("The file is not UTF-8 encoded.\n"
3557 "It will be read as local 8Bit-encoded.\n"
3558 "If this does not give the correct result\n"
3559 "then please change the encoding of the file\n"
3560 "to UTF-8 with a program other than LyX.\n"));
3561 file_content = fname.fileContents("local8bit");
3564 return normalize_c(file_content);
3568 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
3570 docstring const tmpstr = contentsOfPlaintextFile(f);
3575 Cursor & cur = cursor();
3576 cap::replaceSelection(cur);
3577 buffer_.undo().recordUndo(cur);
3579 cur.innerText()->insertStringAsParagraphs(cur, tmpstr, cur.current_font);
3581 cur.innerText()->insertStringAsLines(cur, tmpstr, cur.current_font);
3583 buffer_.changed(true);
3587 docstring const & BufferView::inlineCompletion() const
3589 return d->inlineCompletion_;
3593 size_t BufferView::inlineCompletionUniqueChars() const
3595 return d->inlineCompletionUniqueChars_;
3599 DocIterator const & BufferView::inlineCompletionPos() const
3601 return d->inlineCompletionPos_;
3605 void BufferView::resetInlineCompletionPos()
3607 d->inlineCompletionPos_ = DocIterator();
3611 bool samePar(DocIterator const & a, DocIterator const & b)
3613 if (a.empty() && b.empty())
3615 if (a.empty() || b.empty())
3617 if (a.depth() != b.depth())
3619 return &a.innerParagraph() == &b.innerParagraph();
3623 void BufferView::setInlineCompletion(Cursor const & cur, DocIterator const & pos,
3624 docstring const & completion, size_t uniqueChars)
3626 uniqueChars = min(completion.size(), uniqueChars);
3627 bool changed = d->inlineCompletion_ != completion
3628 || d->inlineCompletionUniqueChars_ != uniqueChars;
3629 bool singlePar = true;
3630 d->inlineCompletion_ = completion;
3631 d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
3633 //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
3636 DocIterator const & old = d->inlineCompletionPos_;
3638 //lyxerr << "inlineCompletionPos changed" << std::endl;
3639 // old or pos are in another paragraph?
3640 if ((!samePar(cur, pos) && !pos.empty())
3641 || (!samePar(cur, old) && !old.empty())) {
3643 //lyxerr << "different paragraph" << std::endl;
3645 d->inlineCompletionPos_ = pos;
3650 if (singlePar && !(cur.result().screenUpdate() & Update::Force))
3651 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
3653 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::Force);
3658 bool BufferView::clickableInset() const
3660 return d->clickable_inset_;