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 bool 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);
185 return bv->scrollToCursor(bv->cursor(), false, true);
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 unordered_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::defaultMargin() const
336 // The value used to be hardcoded to 10
337 return zoomedPixels(20);
341 int BufferView::rightMargin() const
343 // The additional test for the case the outliner is opened.
344 if (full_screen_ && lyxrc.full_screen_limit)
345 return max(defaultMargin(), (width_ - lyxrc.full_screen_width) / 2);
347 return defaultMargin();
351 int BufferView::leftMargin() const
353 return rightMargin();
357 int BufferView::topMargin() const
359 // Original value was 20px at 100dpi. For internal buffers like in
360 // advanced search and replace, a value of 5px is enough.
361 return zoomedPixels(buffer().isInternal() ? 5 : 20);
365 int BufferView::bottomMargin() const
371 int BufferView::inPixels(Length const & len) const
373 Font const font = buffer().params().getFont();
374 return len.inPixels(workWidth(), theFontMetrics(font).em());
378 int BufferView::zoomedPixels(int pix) const
380 // FIXME: the dpi setting should really depend on the BufferView
381 // (think different monitors).
383 // Zoom factor specified by user in percent
384 double const zoom = lyxrc.currentZoom / 100.0; // [percent]
386 // DPI setting for monitor relative to 100dpi
387 double const dpizoom = lyxrc.dpi / 100.0; // [per 100dpi]
389 return support::iround(pix * zoom * dpizoom);
393 bool BufferView::isTopScreen() const
395 return 0 == d->scrollbarParameters_.min;
399 bool BufferView::isBottomScreen() const
401 return 0 == d->scrollbarParameters_.max;
405 Intl & BufferView::getIntl()
411 Intl const & BufferView::getIntl() const
417 CoordCache & BufferView::coordCache()
419 return d->coord_cache_;
423 CoordCache const & BufferView::coordCache() const
425 return d->coord_cache_;
429 MathRow const & BufferView::mathRow(MathData const * cell) const
431 auto it = d->math_rows_.find(cell);
432 LATTEST(it != d->math_rows_.end());
437 void BufferView::setMathRow(MathData const * cell, MathRow const & mrow)
439 d->math_rows_[cell] = mrow;
443 Buffer & BufferView::buffer()
449 Buffer const & BufferView::buffer() const
455 docstring const & BufferView::searchRequestCache() const
457 return theClipboard().getFindBuffer();
461 void BufferView::setSearchRequestCache(docstring const & text)
469 docstring const search = string2find(text, casesensitive, matchword,
470 forward, wrap, instant, onlysel);
471 theClipboard().setFindBuffer(search);
475 bool BufferView::needsFitCursor() const
477 if (cursorStatus(d->cursor_) == CUR_INSIDE) {
478 frontend::FontMetrics const & fm =
479 theFontMetrics(d->cursor_.getFont().fontInfo());
480 int const asc = fm.maxAscent();
481 int const des = fm.maxDescent();
482 Point const p = getPos(d->cursor_);
483 if (p.y_ - asc >= 0 && p.y_ + des < height_)
492 // this is for debugging only.
493 string flagsAsString(Update::flags flags)
495 if (flags == Update::None)
497 return string((flags & Update::FitCursor) ? "FitCursor " : "")
498 + ((flags & Update::Force) ? "Force " : "")
499 + ((flags & Update::ForceDraw) ? "ForceDraw " : "")
500 + ((flags & Update::SinglePar) ? "SinglePar " : "")
501 + ((flags & Update::Decoration) ? "Decoration " : "");
506 void BufferView::processUpdateFlags(Update::flags flags)
508 LYXERR(Debug::PAINTING, "BufferView::processUpdateFlags( "
509 << flagsAsString(flags) << ") buffer: " << &buffer_);
511 // Case when no explicit update is requested.
512 if (flags == Update::None)
515 /* FIXME We would like to avoid doing this here, since it is very
516 * expensive and is called in updateBuffer already. However, even
517 * inserting a plain character can invalidate the overly fragile
518 * tables of child documents built by updateMacros. Some work is
519 * needed to avoid doing that when not necessary.
521 buffer_.updateMacros();
523 // First check whether the metrics and inset positions should be updated
524 if (flags & Update::Force) {
525 // This will update the CoordCache items and replace Force
526 // with ForceDraw in flags.
527 updateMetrics(flags);
530 // Detect whether we can only repaint a single paragraph (if we
531 // are not already redrawing all).
532 // We handle this before FitCursor because the later will require
533 // correct metrics at cursor position.
534 if (!(flags & Update::ForceDraw)
535 && (flags & Update::SinglePar)
536 && !singleParUpdate())
537 updateMetrics(flags);
539 // Then make sure that the screen contains the cursor if needed
540 if (flags & Update::FitCursor) {
541 if (needsFitCursor()) {
542 // First try to make the selection start visible
543 // (which is just the cursor when there is no selection)
544 scrollToCursor(d->cursor_.selectionBegin(), false, false);
545 // Metrics have to be recomputed (maybe again)
547 // Is the cursor visible? (only useful if cursor is at end of selection)
548 if (needsFitCursor()) {
549 // then try to make cursor visible instead
550 scrollToCursor(d->cursor_, false, false);
551 // Metrics have to be recomputed (maybe again)
552 updateMetrics(flags);
555 flags = flags & ~Update::FitCursor;
558 // Add flags to the the update flags. These will be reset to None
559 // after the redraw is actually done
560 d->update_flags_ = d->update_flags_ | flags;
561 LYXERR(Debug::PAINTING, "Cumulative flags: " << flagsAsString(flags));
563 // Now compute the update strategy
564 // Possibly values in flag are None, SinglePar, Decoration, ForceDraw
565 LATTEST((d->update_flags_ & ~(Update::None | Update::SinglePar
566 | Update::Decoration | Update::ForceDraw)) == 0);
568 if (d->update_flags_ & Update::ForceDraw)
569 d->update_strategy_ = FullScreenUpdate;
570 else if (d->update_flags_ & Update::Decoration)
571 d->update_strategy_ = DecorationUpdate;
572 else if (d->update_flags_ & Update::SinglePar)
573 d->update_strategy_ = SingleParUpdate;
575 // no need to redraw anything.
576 d->update_strategy_ = NoScreenUpdate;
579 updateHoveredInset();
582 buffer_.changed(false);
586 void BufferView::updateScrollbar()
588 if (height_ == 0 && width_ == 0)
591 // We prefer fixed size line scrolling.
592 d->scrollbarParameters_.single_step = defaultRowHeight();
593 // We prefer full screen page scrolling.
594 d->scrollbarParameters_.page_step = height_;
596 Text & t = buffer_.text();
597 TextMetrics & tm = d->text_metrics_[&t];
599 LYXERR(Debug::GUI, " Updating scrollbar: height: "
600 << t.paragraphs().size()
601 << " curr par: " << d->cursor_.bottom().pit()
602 << " default height " << defaultRowHeight());
604 size_t const parsize = t.paragraphs().size();
605 if (d->par_height_.size() != parsize) {
606 d->par_height_.clear();
607 // FIXME: We assume a default paragraph height of 2 rows. This
608 // should probably be pondered with the screen width.
609 d->par_height_.resize(parsize, defaultRowHeight() * 2);
612 // Look at paragraph heights on-screen
613 pair<pit_type, ParagraphMetrics const *> first = tm.first();
614 pair<pit_type, ParagraphMetrics const *> last = tm.last();
615 for (pit_type pit = first.first; pit <= last.first; ++pit) {
616 d->par_height_[pit] = tm.parMetrics(pit).height();
617 LYXERR(Debug::SCROLLING, "storing height for pit " << pit << " : "
618 << d->par_height_[pit]);
621 int top_pos = first.second->position() - first.second->ascent();
622 int bottom_pos = last.second->position() + last.second->descent();
623 bool first_visible = first.first == 0 && top_pos >= 0;
624 bool last_visible = last.first + 1 == int(parsize) && bottom_pos <= height_;
625 if (first_visible && last_visible) {
626 d->scrollbarParameters_.min = 0;
627 d->scrollbarParameters_.max = 0;
631 d->scrollbarParameters_.min = top_pos;
632 for (size_t i = 0; i != size_t(first.first); ++i)
633 d->scrollbarParameters_.min -= d->par_height_[i];
634 d->scrollbarParameters_.max = bottom_pos;
635 for (size_t i = last.first + 1; i != parsize; ++i)
636 d->scrollbarParameters_.max += d->par_height_[i];
638 // The reference is the top position so we remove one page.
639 if (lyxrc.scroll_below_document)
640 d->scrollbarParameters_.max -= minVisiblePart();
642 d->scrollbarParameters_.max -= d->scrollbarParameters_.page_step;
644 // 0 must be inside the range as it denotes the current position
645 if (d->scrollbarParameters_.max < 0)
646 d->scrollbarParameters_.max = 0;
647 if (d->scrollbarParameters_.min > 0)
648 d->scrollbarParameters_.min = 0;
652 ScrollbarParameters const & BufferView::scrollbarParameters() const
654 return d->scrollbarParameters_;
658 docstring BufferView::toolTip(int x, int y) const
660 // Get inset under mouse, if there is one.
661 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
663 // No inset, no tooltip...
665 return covering_inset->toolTip(*this, x, y);
669 string BufferView::contextMenu(int x, int y) const
671 //If there is a selection, return the containing inset menu
672 if (d->cursor_.selection())
673 return d->cursor_.inset().contextMenu(*this, x, y);
675 // Get inset under mouse, if there is one.
676 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
677 if (covering_inset) {
678 if (covering_inset->asInsetMath()) {
679 CoordCache::Insets const & inset_cache =
680 coordCache().getInsets();
681 Inset const * inner_inset = mathContextMenu(
682 covering_inset->asInsetMath()->asNestInset(),
685 return inner_inset->contextMenu(*this, x, y);
687 return covering_inset->contextMenu(*this, x, y);
690 return buffer_.inset().contextMenu(*this, x, y);
694 Inset const * BufferView::mathContextMenu(InsetMathNest const * inset,
695 CoordCache::Insets const & inset_cache, int x, int y) const
697 for (size_t i = 0; i < inset->nargs(); ++i) {
698 MathData const & ar = inset->cell(i);
699 for (size_t j = 0; j < ar.size(); ++j) {
700 string const name = lyxerr.debugging(Debug::MATHED)
701 ? insetName(ar[j].nucleus()->lyxCode())
703 LYXERR(Debug::MATHED, "Examining inset: " << name);
704 if (!ar[j].nucleus()->contextMenuName().empty()) {
705 if (inset_cache.covers(ar[j].nucleus(), x, y)) {
706 LYXERR(Debug::MATHED, "Hit inset: "
708 return ar[j].nucleus();
711 InsetMathNest const * imn =
712 ar[j].nucleus()->asNestInset();
714 Inset const * inner =
715 mathContextMenu(imn, inset_cache, x, y);
725 void BufferView::scrollDocView(int const pixels, bool update)
727 // The scrollbar values are relative to the top of the screen, therefore the
728 // offset is equal to the target value.
730 // No scrolling at all? No need to redraw anything
734 // If the offset is less than 2 screen height, prefer to scroll instead.
735 if (abs(pixels) <= 2 * height_) {
736 d->anchor_ypos_ -= pixels;
737 processUpdateFlags(Update::Force);
741 // cut off at the top
742 if (pixels <= d->scrollbarParameters_.min) {
743 DocIterator dit = doc_iterator_begin(&buffer_);
744 showCursor(dit, false, false, update);
745 LYXERR(Debug::SCROLLING, "scroll to top");
749 // cut off at the bottom
750 if (pixels >= d->scrollbarParameters_.max) {
751 DocIterator dit = doc_iterator_end(&buffer_);
753 showCursor(dit, false, false, update);
754 LYXERR(Debug::SCROLLING, "scroll to bottom");
758 // find paragraph at target position
759 int par_pos = d->scrollbarParameters_.min;
761 for (; i != int(d->par_height_.size()); ++i) {
762 par_pos += d->par_height_[i];
763 if (par_pos >= pixels)
767 if (par_pos < pixels) {
768 // It seems we didn't find the correct pit so stay on the safe side and
770 LYXERR0("scrolling position not found!");
771 scrollDocView(d->scrollbarParameters_.max, update);
775 DocIterator dit = doc_iterator_begin(&buffer_);
777 LYXERR(Debug::SCROLLING, "pixels = " << pixels << " -> scroll to pit " << i);
778 showCursor(dit, false, false, update);
782 // FIXME: this method is not working well.
783 void BufferView::setCursorFromScrollbar()
785 TextMetrics & tm = d->text_metrics_[&buffer_.text()];
787 int const height = 2 * defaultRowHeight();
788 int const first = height;
789 int const last = height_ - height;
791 Cursor const & oldcur = d->cursor_;
793 switch (cursorStatus(oldcur)) {
801 int const y = getPos(oldcur).y_;
802 newy = min(last, max(y, first));
806 // We reset the cursor because cursorStatus() does not
807 // work when the cursor is within mathed.
810 tm.setCursorFromCoordinates(cur, 0, newy);
812 // update the bufferview cursor and notify insets
813 // FIXME: Care about the d->cursor_ flags to redraw if needed
814 Cursor old = d->cursor_;
816 // the DEPM call in mouseSetCursor() might have destroyed the
817 // paragraph the cursor is in.
818 bool badcursor = old.fixIfBroken();
819 badcursor |= notifyCursorLeavesOrEnters(old, d->cursor_);
821 d->cursor_.fixIfBroken();
825 Change const BufferView::getCurrentChange() const
827 if (!d->cursor_.selection())
828 return Change(Change::UNCHANGED);
830 DocIterator dit = d->cursor_.selectionBegin();
831 // The selected content might have been changed (see #7685)
832 dit = dit.getInnerText();
833 return dit.paragraph().lookupChange(dit.pos());
837 // this could be used elsewhere as well?
838 // FIXME: This does not work within mathed!
839 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
841 Point const p = getPos(dit);
844 if (p.y_ > workHeight())
850 void BufferView::bookmarkEditPosition()
852 // Don't eat cpu time for each keystroke
853 if (d->cursor_.paragraph().id() == d->bookmark_edit_position_)
856 d->bookmark_edit_position_ = d->cursor_.paragraph().id();
860 void BufferView::saveBookmark(unsigned int idx)
862 if (buffer().isInternal())
865 // tentatively save bookmark, id and pos will be used to
866 // acturately locate a bookmark in a 'live' lyx session.
867 // pit and pos will be updated with bottom level pit/pos
869 theSession().bookmarks().save(
871 d->cursor_.bottom().pit(),
872 d->cursor_.bottom().pos(),
873 d->cursor_.paragraph().id(),
878 // emit message signal.
879 message(_("Save bookmark"));
883 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
884 int top_id, pos_type top_pos)
886 bool success = false;
889 d->cursor_.clearSelection();
891 // if a valid par_id is given, try it first
892 // This is the case for a 'live' bookmark when unique paragraph ID
893 // is used to track bookmarks.
895 dit = buffer_.getParFromID(top_id);
897 dit.pos() = min(dit.paragraph().size(), top_pos);
898 // Some slices of the iterator may not be
899 // reachable (e.g. closed collapsible inset)
900 // so the dociterator may need to be
901 // shortened. Otherwise, setCursor may crash
902 // lyx when the cursor can not be set to these
904 size_t const n = dit.depth();
905 for (size_t i = 0; i < n; ++i)
906 if (!dit[i].inset().editable()) {
914 // if top_id == 0, or searching through top_id failed
915 // This is the case for a 'restored' bookmark when only bottom
916 // (document level) pit was saved. Because of this, bookmark
917 // restoration is inaccurate. If a bookmark was within an inset,
918 // it will be restored to the left of the outmost inset that contains
920 if (!success && bottom_pit < int(buffer_.paragraphs().size())) {
921 dit = doc_iterator_begin(&buffer_);
923 dit.pit() = bottom_pit;
924 dit.pos() = min(bottom_pos, dit.paragraph().size());
929 // Note: only bottom (document) level pit is set.
931 // set the current font.
932 d->cursor_.setCurrentFont();
933 // Do not forget to reset the anchor (see #9912)
934 d->cursor_.resetAnchor();
935 processUpdateFlags(Update::Force | Update::FitCursor);
942 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
944 if (d->cursor_.real_current_font.isRightToLeft()) {
945 if (d->intl_.keymap == Intl::PRIMARY)
946 d->intl_.keyMapSec();
948 if (d->intl_.keymap == Intl::SECONDARY)
949 d->intl_.keyMapPrim();
952 d->intl_.getTransManager().translateAndInsert(c, t, cur);
956 int BufferView::workWidth() const
962 void BufferView::recenter()
964 showCursor(d->cursor_, true, false, true);
968 void BufferView::showCursor()
970 showCursor(d->cursor_, false, false, true);
974 void BufferView::showCursor(DocIterator const & dit,
975 bool recenter, bool force, bool update)
977 if (scrollToCursor(dit, recenter, force) && update)
978 processUpdateFlags(Update::Force);
982 bool BufferView::scrollToCursor(DocIterator const & dit, bool const recenter, bool force)
984 // We are not properly started yet, delay until resizing is done.
989 LYXERR(Debug::SCROLLING, "recentering and scrolling to cursor");
991 LYXERR(Debug::SCROLLING, "scrolling to cursor");
993 CursorSlice const & bot = dit.bottom();
994 TextMetrics & tm = textMetrics(bot.text());
996 pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
997 pos_type bot_pit = bot.pit();
998 if (bot_pit > max_pit) {
999 // FIXME: Why does this happen?
1000 LYXERR0("bottom pit is greater that max pit: "
1001 << bot_pit << " > " << max_pit);
1005 if (bot_pit == tm.first().first - 1)
1006 tm.newParMetricsUp();
1007 else if (bot_pit == tm.last().first + 1)
1008 tm.newParMetricsDown();
1010 if (tm.contains(bot_pit) && !force) {
1011 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
1012 LBUFERR(!pm.rows().empty());
1013 // FIXME: smooth scrolling doesn't work in mathed.
1014 CursorSlice const & cs = dit.innerTextSlice();
1015 int const ypos = pm.position() + coordOffset(dit).y_;
1016 ParagraphMetrics const & inner_pm =
1017 textMetrics(cs.text()).parMetrics(cs.pit());
1018 Dimension const & row_dim =
1019 inner_pm.getRow(cs.pos(), dit.boundary()).dim();
1022 scrolled = scroll(ypos - height_/2);
1024 // We try to visualize the whole row, if the row height is larger than
1025 // the screen height, we scroll to a heuristic value of height_ / 4.
1026 // FIXME: This heuristic value should be replaced by a recursive search
1027 // for a row in the inset that can be visualized completely.
1028 else if (row_dim.height() > height_) {
1029 if (ypos < defaultRowHeight())
1030 scrolled = scroll(ypos - height_ / 4);
1031 else if (ypos > height_ - defaultRowHeight())
1032 scrolled = scroll(ypos - 3 * height_ / 4);
1035 // If the top part of the row falls of the screen, we scroll
1036 // up to align the top of the row with the top of the screen.
1037 else if (ypos - row_dim.ascent() < 0 && ypos < height_) {
1038 int const ynew = row_dim.ascent();
1039 scrolled = scrollUp(ynew - ypos);
1042 // If the bottom of the row falls of the screen, we scroll down.
1043 else if (ypos + row_dim.descent() > height_ && ypos > 0) {
1044 int const ynew = height_ - row_dim.descent();
1045 scrolled = scrollDown(ypos - ynew);
1048 // else, nothing to do, the cursor is already visible so we just return.
1049 return scrolled != 0;
1052 // fix inline completion position
1053 if (d->inlineCompletionPos_.fixIfBroken())
1054 d->inlineCompletionPos_ = DocIterator();
1056 tm.redoParagraph(bot_pit);
1057 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
1058 int const offset = coordOffset(dit).y_;
1060 d->anchor_pit_ = bot_pit;
1061 CursorSlice const & cs = dit.innerTextSlice();
1062 ParagraphMetrics const & inner_pm =
1063 textMetrics(cs.text()).parMetrics(cs.pit());
1064 Dimension const & row_dim =
1065 inner_pm.getRow(cs.pos(), dit.boundary()).dim();
1068 d->anchor_ypos_ = height_/2;
1069 else if (d->anchor_pit_ == 0)
1070 d->anchor_ypos_ = offset + pm.ascent();
1071 else if (d->anchor_pit_ == max_pit)
1072 d->anchor_ypos_ = height_ - offset - row_dim.descent();
1073 else if (offset > height_)
1074 d->anchor_ypos_ = height_ - offset - row_dim.descent();
1076 d->anchor_ypos_ = row_dim.ascent();
1082 void BufferView::makeDocumentClass()
1084 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1085 buffer_.params().makeDocumentClass(buffer_.isClone(), buffer_.isInternal());
1086 updateDocumentClass(olddc);
1090 void BufferView::updateDocumentClass(DocumentClassConstPtr olddc)
1092 message(_("Converting document to new document class..."));
1094 StableDocIterator backcur(d->cursor_);
1095 ErrorList & el = buffer_.errorList("Class Switch");
1096 cap::switchBetweenClasses(
1097 olddc, buffer_.params().documentClassPtr(),
1098 static_cast<InsetText &>(buffer_.inset()), el);
1100 setCursor(backcur.asDocIterator(&buffer_));
1102 buffer_.errors("Class Switch");
1106 /** Return the change status at cursor position, taking into account the
1107 * status at each level of the document iterator (a table in a deleted
1108 * footnote is deleted).
1109 * When \param outer is true, the top slice is not looked at.
1111 static Change::Type lookupChangeType(DocIterator const & dit, bool outer = false)
1113 size_t const depth = dit.depth() - (outer ? 1 : 0);
1115 for (size_t i = 0 ; i < depth ; ++i) {
1116 CursorSlice const & slice = dit[i];
1117 if (!slice.inset().inMathed()
1118 && slice.pos() < slice.paragraph().size()) {
1119 Change::Type const ch = slice.paragraph().lookupChange(slice.pos()).type;
1120 if (ch != Change::UNCHANGED)
1124 return Change::UNCHANGED;
1128 bool BufferView::getStatus(FuncRequest const & cmd, FuncStatus & flag)
1130 FuncCode const act = cmd.action();
1132 // Can we use a readonly buffer?
1133 if (buffer_.isReadonly()
1134 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1135 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1136 if (buffer_.hasReadonlyFlag())
1137 flag.message(from_utf8(N_("Document is read-only")));
1139 flag.message(from_utf8(N_("Document has been modified externally")));
1140 flag.setEnabled(false);
1144 // Are we in a DELETED change-tracking region?
1145 if (lookupChangeType(d->cursor_, true) == Change::DELETED
1146 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1147 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1148 flag.message(from_utf8(N_("This portion of the document is deleted.")));
1149 flag.setEnabled(false);
1153 Cursor & cur = d->cursor_;
1155 if (cur.getStatus(cmd, flag))
1160 // FIXME: This is a bit problematic because we don't check if this is
1161 // a document BufferView or not for these LFUNs. We probably have to
1162 // dispatch both to currentBufferView() and, if that fails,
1163 // to documentBufferView(); same as we do now for current Buffer and
1164 // document Buffer. Ideally those LFUN should go to Buffer as they
1165 // operate on the full Buffer and the cursor is only needed either for
1166 // an Undo record or to restore a cursor position. But we don't know
1167 // how to do that inside Buffer of course.
1168 case LFUN_BUFFER_PARAMS_APPLY:
1169 case LFUN_LAYOUT_MODULES_CLEAR:
1170 case LFUN_LAYOUT_MODULE_ADD:
1171 case LFUN_LAYOUT_RELOAD:
1172 case LFUN_TEXTCLASS_APPLY:
1173 case LFUN_TEXTCLASS_LOAD:
1174 flag.setEnabled(!buffer_.isReadonly());
1178 // We do not use the LyXAction flag for readonly because Undo sets the
1179 // buffer clean/dirty status by itself.
1180 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasUndoStack());
1183 // We do not use the LyXAction flag for readonly because Redo sets the
1184 // buffer clean/dirty status by itself.
1185 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasRedoStack());
1187 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
1188 case LFUN_FILE_INSERT_PLAINTEXT: {
1189 docstring const & fname = cmd.argument();
1190 if (!FileName::isAbsolute(to_utf8(fname))) {
1191 flag.message(_("Absolute filename expected."));
1194 flag.setEnabled(cur.inTexted());
1197 case LFUN_FILE_INSERT:
1198 case LFUN_BOOKMARK_SAVE:
1199 // FIXME: Actually, these LFUNS should be moved to Text
1200 flag.setEnabled(cur.inTexted());
1203 case LFUN_FONT_STATE:
1204 case LFUN_LABEL_INSERT:
1205 case LFUN_INFO_INSERT:
1206 case LFUN_PARAGRAPH_GOTO:
1207 case LFUN_NOTE_NEXT:
1208 case LFUN_REFERENCE_NEXT:
1209 case LFUN_WORD_FIND:
1210 case LFUN_WORD_FIND_FORWARD:
1211 case LFUN_WORD_FIND_BACKWARD:
1212 case LFUN_WORD_REPLACE:
1215 case LFUN_MARK_TOGGLE:
1216 case LFUN_SEARCH_STRING_SET:
1217 case LFUN_SCREEN_RECENTER:
1218 case LFUN_SCREEN_SHOW_CURSOR:
1219 case LFUN_BIBTEX_DATABASE_ADD:
1220 case LFUN_BIBTEX_DATABASE_DEL:
1221 case LFUN_STATISTICS:
1222 case LFUN_KEYMAP_OFF:
1223 case LFUN_KEYMAP_PRIMARY:
1224 case LFUN_KEYMAP_SECONDARY:
1225 case LFUN_KEYMAP_TOGGLE:
1226 case LFUN_INSET_SELECT_ALL:
1227 flag.setEnabled(true);
1230 case LFUN_GRAPHICS_UNIFY:
1231 flag.setEnabled(cur.countInsetsInSelection(GRAPHICS_CODE)>1);
1234 case LFUN_WORD_FINDADV: {
1235 FindAndReplaceOptions opt;
1236 istringstream iss(to_utf8(cmd.argument()));
1238 flag.setEnabled(opt.repl_buf_name.empty()
1239 || !buffer_.isReadonly());
1243 case LFUN_LABEL_GOTO:
1244 flag.setEnabled(!cmd.argument().empty()
1245 || getInsetByCode<InsetRef>(cur, REF_CODE)
1246 || getInsetByCode<InsetMathRef>(cur, MATH_REF_CODE));
1249 case LFUN_CHANGES_MERGE:
1250 case LFUN_CHANGE_NEXT:
1251 case LFUN_CHANGE_PREVIOUS:
1252 case LFUN_ALL_CHANGES_ACCEPT:
1253 case LFUN_ALL_CHANGES_REJECT:
1254 flag.setEnabled(buffer_.areChangesPresent());
1257 case LFUN_SCREEN_UP:
1258 case LFUN_SCREEN_DOWN:
1260 case LFUN_SCREEN_UP_SELECT:
1261 case LFUN_SCREEN_DOWN_SELECT:
1262 case LFUN_INSET_FORALL:
1263 flag.setEnabled(true);
1266 case LFUN_LAYOUT_TABULAR:
1267 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
1271 flag.setEnabled(!cur.inset().forcePlainLayout(cur.idx()));
1274 case LFUN_LAYOUT_PARAGRAPH:
1275 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
1278 case LFUN_BRANCH_ADD_INSERT:
1279 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1282 case LFUN_DIALOG_SHOW_NEW_INSET:
1283 // FIXME: this is wrong, but I do not understand the
1285 if (cur.inset().lyxCode() == CAPTION_CODE)
1286 return cur.inset().getStatus(cur, cmd, flag);
1287 // FIXME we should consider passthru paragraphs too.
1288 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1291 case LFUN_CITATION_INSERT: {
1292 FuncRequest fr(LFUN_INSET_INSERT, "citation");
1293 // FIXME: This could turn in a recursive hell.
1294 // Shouldn't we use Buffer::getStatus() instead?
1295 flag.setEnabled(lyx::getStatus(fr).enabled());
1298 case LFUN_INSET_APPLY: {
1299 string const name = cmd.getArg(0);
1300 Inset * inset = editedInset(name);
1302 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1303 if (!inset->getStatus(cur, fr, flag)) {
1304 // Every inset is supposed to handle this
1305 LASSERT(false, break);
1308 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1309 flag = lyx::getStatus(fr);
1315 flag.setEnabled(cur.selection());
1326 Inset * BufferView::editedInset(string const & name) const
1328 map<string, Inset *>::const_iterator it = d->edited_insets_.find(name);
1329 return it == d->edited_insets_.end() ? nullptr : it->second;
1333 void BufferView::editInset(string const & name, Inset * inset)
1336 d->edited_insets_[name] = inset;
1338 d->edited_insets_.erase(name);
1342 void BufferView::dispatch(FuncRequest const & cmd, DispatchResult & dr)
1344 LYXERR(Debug::ACTION, "BufferView::dispatch: cmd: " << cmd);
1346 string const argument = to_utf8(cmd.argument());
1347 Cursor & cur = d->cursor_;
1350 // Don't dispatch function that does not apply to internal buffers.
1351 if (buffer_.isInternal()
1352 && lyxaction.funcHasFlag(cmd.action(), LyXAction::NoInternal))
1355 // We'll set this back to false if need be.
1356 bool dispatched = true;
1357 buffer_.undo().beginUndoGroup();
1359 FuncCode const act = cmd.action();
1362 case LFUN_BUFFER_PARAMS_APPLY: {
1363 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1364 cur.recordUndoBufferParams();
1365 istringstream ss(to_utf8(cmd.argument()));
1368 int const unknown_tokens = buffer_.readHeader(lex);
1369 if (unknown_tokens != 0) {
1370 LYXERR0("Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1371 << unknown_tokens << " unknown token"
1372 << (unknown_tokens == 1 ? "" : "s"));
1374 updateDocumentClass(olddc);
1376 // We are most certainly here because of a change in the document
1377 // It is then better to make sure that all dialogs are in sync with
1378 // current document settings.
1379 dr.screenUpdate(Update::Force | Update::FitCursor);
1380 dr.forceBufferUpdate();
1384 case LFUN_LAYOUT_MODULES_CLEAR: {
1385 // FIXME: this modifies the document in cap::switchBetweenClasses
1386 // without calling recordUndo. Fix this before using
1387 // recordUndoBufferParams().
1388 cur.recordUndoFullBuffer();
1389 buffer_.params().clearLayoutModules();
1390 makeDocumentClass();
1391 dr.screenUpdate(Update::Force);
1392 dr.forceBufferUpdate();
1396 case LFUN_LAYOUT_MODULE_ADD: {
1397 BufferParams const & params = buffer_.params();
1398 if (!params.layoutModuleCanBeAdded(argument)) {
1399 LYXERR0("Module `" << argument <<
1400 "' cannot be added due to failed requirements or "
1401 "conflicts with installed modules.");
1404 // FIXME: this modifies the document in cap::switchBetweenClasses
1405 // without calling recordUndo. Fix this before using
1406 // recordUndoBufferParams().
1407 cur.recordUndoFullBuffer();
1408 buffer_.params().addLayoutModule(argument);
1409 makeDocumentClass();
1410 dr.screenUpdate(Update::Force);
1411 dr.forceBufferUpdate();
1415 case LFUN_TEXTCLASS_APPLY: {
1416 // since this shortcircuits, the second call is made only if
1418 bool const success =
1419 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1420 LayoutFileList::get().load(argument, buffer_.filePath());
1422 docstring s = bformat(_("The document class `%1$s' "
1423 "could not be loaded."), from_utf8(argument));
1424 frontend::Alert::error(_("Could not load class"), s);
1428 LayoutFile const * old_layout = buffer_.params().baseClass();
1429 LayoutFile const * new_layout = &(LayoutFileList::get()[argument]);
1431 if (old_layout == new_layout)
1435 // Save the old, possibly modular, layout for use in conversion.
1436 // FIXME: this modifies the document in cap::switchBetweenClasses
1437 // without calling recordUndo. Fix this before using
1438 // recordUndoBufferParams().
1439 cur.recordUndoFullBuffer();
1440 buffer_.params().setBaseClass(argument, buffer_.layoutPos());
1441 makeDocumentClass();
1442 dr.screenUpdate(Update::Force);
1443 dr.forceBufferUpdate();
1447 case LFUN_TEXTCLASS_LOAD: {
1448 // since this shortcircuits, the second call is made only if
1450 bool const success =
1451 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1452 LayoutFileList::get().load(argument, buffer_.filePath());
1454 docstring s = bformat(_("The document class `%1$s' "
1455 "could not be loaded."), from_utf8(argument));
1456 frontend::Alert::error(_("Could not load class"), s);
1461 case LFUN_LAYOUT_RELOAD: {
1462 LayoutFileIndex bc = buffer_.params().baseClassID();
1463 LayoutFileList::get().reset(bc);
1464 buffer_.params().setBaseClass(bc, buffer_.layoutPos());
1465 makeDocumentClass();
1466 dr.screenUpdate(Update::Force);
1467 dr.forceBufferUpdate();
1472 dr.setMessage(_("Undo"));
1473 cur.clearSelection();
1474 // We need to find out if the bibliography information
1475 // has changed. See bug #11055.
1476 // So these should not be references...
1477 string const engine = buffer().params().citeEngine();
1478 CiteEngineType const enginetype = buffer().params().citeEngineType();
1479 if (!cur.undoAction())
1480 dr.setMessage(_("No further undo information"));
1482 dr.screenUpdate(Update::Force | Update::FitCursor);
1483 dr.forceBufferUpdate();
1484 if (buffer().params().citeEngine() != engine ||
1485 buffer().params().citeEngineType() != enginetype)
1486 buffer().invalidateCiteLabels();
1492 dr.setMessage(_("Redo"));
1493 cur.clearSelection();
1494 // We need to find out if the bibliography information
1495 // has changed. See bug #11055.
1496 // So these should not be references...
1497 string const engine = buffer().params().citeEngine();
1498 CiteEngineType const enginetype = buffer().params().citeEngineType();
1499 if (!cur.redoAction())
1500 dr.setMessage(_("No further redo information"));
1502 dr.screenUpdate(Update::Force | Update::FitCursor);
1503 dr.forceBufferUpdate();
1504 if (buffer().params().citeEngine() != engine ||
1505 buffer().params().citeEngineType() != enginetype)
1506 buffer().invalidateCiteLabels();
1511 case LFUN_FONT_STATE:
1512 dr.setMessage(cur.currentState(false));
1515 case LFUN_BOOKMARK_SAVE:
1516 dr.screenUpdate(Update::Force);
1517 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1520 case LFUN_LABEL_GOTO: {
1521 docstring label = cmd.argument();
1522 if (label.empty()) {
1524 getInsetByCode<InsetRef>(cur, REF_CODE);
1526 label = inset->getParam("reference");
1527 // persistent=false: use temp_bookmark
1531 if (!label.empty()) {
1533 // at the moment, this is redundant, since gotoLabel will
1534 // eventually call LFUN_PARAGRAPH_GOTO, but it seems best
1536 dr.screenUpdate(Update::Force | Update::FitCursor);
1538 InsetMathRef * minset =
1539 getInsetByCode<InsetMathRef>(cur, MATH_REF_CODE);
1541 lyx::dispatch(FuncRequest(LFUN_LABEL_GOTO,
1542 minset->getTarget()));
1547 case LFUN_PARAGRAPH_GOTO: {
1548 int const id = convert<int>(cmd.getArg(0));
1549 pos_type const pos = convert<int>(cmd.getArg(1));
1552 string const str_id_end = cmd.getArg(2);
1553 string const str_pos_end = cmd.getArg(3);
1555 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1556 b = theBufferList().next(b)) {
1559 curs.setCursor(b->getParFromID(id));
1561 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1565 LYXERR(Debug::INFO, "Paragraph " << curs.paragraph().id()
1566 << " found in buffer `"
1567 << b->absFileName() << "'.");
1569 if (b == &buffer_) {
1571 if (str_id_end.empty() || str_pos_end.empty()) {
1574 mouseSetCursor(curs);
1577 int const id_end = convert<int>(str_id_end);
1578 pos_type const pos_end = convert<int>(str_pos_end);
1579 success = setCursorFromEntries({id, pos},
1582 if (success && scrollToCursor(d->cursor_, false, true))
1583 dr.screenUpdate(Update::Force);
1585 // Switch to other buffer view and resend cmd
1586 lyx::dispatch(FuncRequest(
1587 LFUN_BUFFER_SWITCH, b->absFileName()));
1595 case LFUN_NOTE_NEXT:
1596 if (gotoInset(this, { NOTE_CODE }, false))
1597 dr.screenUpdate(Update::Force);
1600 case LFUN_REFERENCE_NEXT: {
1601 if (gotoInset(this, { LABEL_CODE, REF_CODE }, true))
1602 dr.screenUpdate(Update::Force);
1606 case LFUN_CHANGE_NEXT:
1607 findNextChange(this);
1608 if (cur.inset().isTable())
1609 // In tables, there might be whole changed rows or columns
1611 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1612 dr.screenUpdate(Update::Force | Update::FitCursor);
1615 case LFUN_CHANGE_PREVIOUS:
1616 findPreviousChange(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_CHANGES_MERGE:
1625 if (findNextChange(this) || findPreviousChange(this)) {
1626 dr.screenUpdate(Update::Force | Update::FitCursor);
1627 dr.forceBufferUpdate();
1628 showDialog("changes");
1632 case LFUN_ALL_CHANGES_ACCEPT: {
1633 // select complete document
1635 cur.selHandle(true);
1636 buffer_.text().cursorBottom(cur);
1637 // accept everything in a single step to support atomic undo
1638 // temporarily disable track changes in order to end with really
1639 // no new (e.g., DPSM-caused) changes (see #7487)
1640 bool const track = buffer_.params().track_changes;
1641 buffer_.params().track_changes = false;
1642 buffer_.text().acceptOrRejectChanges(cur, Text::ACCEPT);
1643 buffer_.params().track_changes = track;
1645 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1646 dr.screenUpdate(Update::Force | Update::FitCursor);
1647 dr.forceBufferUpdate();
1651 case LFUN_ALL_CHANGES_REJECT: {
1652 // select complete document
1654 cur.selHandle(true);
1655 buffer_.text().cursorBottom(cur);
1656 // reject everything in a single step to support atomic undo
1657 // temporarily disable track changes in order to end with really
1658 // no new (e.g., DPSM-caused) changes (see #7487)
1659 bool const track = buffer_.params().track_changes;
1660 buffer_.params().track_changes = false;
1661 buffer_.text().acceptOrRejectChanges(cur, Text::REJECT);
1662 buffer_.params().track_changes = track;
1664 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1665 dr.screenUpdate(Update::Force | Update::FitCursor);
1666 dr.forceBufferUpdate();
1670 case LFUN_WORD_FIND_FORWARD:
1671 case LFUN_WORD_FIND_BACKWARD: {
1672 docstring searched_string;
1674 if (!cmd.argument().empty()) {
1675 setSearchRequestCache(cmd.argument());
1676 searched_string = cmd.argument();
1678 searched_string = searchRequestCache();
1681 if (searched_string.empty())
1684 docstring const data =
1685 find2string(searched_string, false, false,
1686 act == LFUN_WORD_FIND_FORWARD, false, false, false);
1687 bool found = lyxfind(this, FuncRequest(LFUN_WORD_FIND, data));
1689 dr.screenUpdate(Update::Force | Update::FitCursor);
1691 dr.setMessage(_("Search string not found!"));
1695 case LFUN_WORD_FIND: {
1696 docstring arg = cmd.argument();
1698 arg = searchRequestCache();
1700 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, "findreplace"));
1703 if (lyxfind(this, FuncRequest(act, arg)))
1704 dr.screenUpdate(Update::Force | Update::FitCursor);
1706 dr.setMessage(_("Search string not found!"));
1708 setSearchRequestCache(arg);
1712 case LFUN_SEARCH_STRING_SET: {
1713 docstring pattern = cmd.argument();
1714 if (!pattern.empty()) {
1715 setSearchRequestCache(pattern);
1718 if (cur.selection())
1719 pattern = cur.selectionAsString(false);
1721 pos_type spos = cur.pos();
1722 cur.innerText()->selectWord(cur, WHOLE_WORD);
1723 pattern = cur.selectionAsString(false);
1724 cur.selection(false);
1727 setSearchRequestCache(pattern);
1731 case LFUN_WORD_REPLACE: {
1732 if (lyxreplace(this, cmd)) {
1733 dr.forceBufferUpdate();
1734 dr.screenUpdate(Update::Force | Update::FitCursor);
1737 dr.setMessage(_("Search string not found!"));
1741 case LFUN_WORD_FINDADV: {
1742 FindAndReplaceOptions opt;
1743 istringstream iss(to_utf8(cmd.argument()));
1745 if (findAdv(this, opt)) {
1746 dr.screenUpdate(Update::Force | Update::FitCursor);
1757 cur.clearSelection();
1758 dr.setMessage(from_utf8(N_("Mark off")));
1762 cur.clearSelection();
1764 dr.setMessage(from_utf8(N_("Mark on")));
1767 case LFUN_MARK_TOGGLE:
1768 cur.selection(false);
1771 dr.setMessage(from_utf8(N_("Mark removed")));
1774 dr.setMessage(from_utf8(N_("Mark set")));
1779 case LFUN_SCREEN_SHOW_CURSOR:
1783 case LFUN_SCREEN_RECENTER:
1787 case LFUN_BIBTEX_DATABASE_ADD: {
1788 Cursor tmpcur = cur;
1789 findInset(tmpcur, { BIBTEX_CODE }, false);
1790 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1793 if (inset->addDatabase(cmd.argument()))
1794 dr.forceBufferUpdate();
1799 case LFUN_BIBTEX_DATABASE_DEL: {
1800 Cursor tmpcur = cur;
1801 findInset(tmpcur, { BIBTEX_CODE }, false);
1802 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1805 if (inset->delDatabase(cmd.argument()))
1806 dr.forceBufferUpdate();
1811 case LFUN_GRAPHICS_UNIFY: {
1813 cur.recordUndoFullBuffer();
1815 DocIterator from, to;
1816 from = cur.selectionBegin();
1817 to = cur.selectionEnd();
1819 string const newId = cmd.getArg(0);
1820 bool fetchId = newId.empty(); //if we wait for groupId from first graphics inset
1822 InsetGraphicsParams grp_par;
1824 InsetGraphics::string2params(graphics::getGroupParams(buffer_, newId), buffer_, grp_par);
1826 if (!from.nextInset()) //move to closest inset
1827 from.forwardInset();
1829 while (!from.empty() && from < to) {
1830 Inset * inset = from.nextInset();
1833 InsetGraphics * ig = inset->asInsetGraphics();
1835 InsetGraphicsParams inspar = ig->getParams();
1840 grp_par.filename = inspar.filename;
1841 ig->setParams(grp_par);
1844 from.forwardInset();
1846 dr.screenUpdate(Update::Force); //needed if triggered from context menu
1850 case LFUN_STATISTICS: {
1851 DocIterator from, to;
1852 if (cur.selection()) {
1853 from = cur.selectionBegin();
1854 to = cur.selectionEnd();
1856 from = doc_iterator_begin(&buffer_);
1857 to = doc_iterator_end(&buffer_);
1859 buffer_.updateStatistics(from, to);
1860 int const words = buffer_.wordCount();
1861 int const chars = buffer_.charCount(false);
1862 int const chars_blanks = buffer_.charCount(true);
1864 if (cur.selection())
1865 message = _("Statistics for the selection:");
1867 message = _("Statistics for the document:");
1870 message += bformat(_("%1$d words"), words);
1872 message += _("One word");
1874 if (chars_blanks != 1)
1875 message += bformat(_("%1$d characters (including blanks)"),
1878 message += _("One character (including blanks)");
1881 message += bformat(_("%1$d characters (excluding blanks)"),
1884 message += _("One character (excluding blanks)");
1886 Alert::information(_("Statistics"), message);
1890 case LFUN_SCREEN_UP:
1891 case LFUN_SCREEN_DOWN: {
1892 Point p = getPos(cur);
1893 // This code has been commented out to enable to scroll down a
1894 // document, even if there are large insets in it (see bug #5465).
1895 /*if (p.y_ < 0 || p.y_ > height_) {
1896 // The cursor is off-screen so recenter before proceeding.
1900 int const scrolled = scroll(act == LFUN_SCREEN_UP
1901 ? -height_ : height_);
1902 if (act == LFUN_SCREEN_UP && scrolled > -height_)
1904 if (act == LFUN_SCREEN_DOWN && scrolled < height_)
1905 p = Point(width_, height_);
1906 bool const in_texted = cur.inTexted();
1907 cur.setCursor(doc_iterator_begin(cur.buffer()));
1908 cur.selHandle(false);
1909 // Force an immediate computation of metrics because we need it below
1912 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_,
1913 true, act == LFUN_SCREEN_UP);
1914 //FIXME: what to do with cur.x_target()?
1915 bool update = in_texted && cur.bv().checkDepm(cur, old);
1918 if (update || cur.mark())
1919 dr.screenUpdate(Update::Force | Update::FitCursor);
1921 dr.forceBufferUpdate();
1926 string const scroll_type = cmd.getArg(0);
1927 int scroll_step = 0;
1928 if (scroll_type == "line")
1929 scroll_step = d->scrollbarParameters_.single_step;
1930 else if (scroll_type == "page")
1931 scroll_step = d->scrollbarParameters_.page_step;
1934 string const scroll_quantity = cmd.getArg(1);
1935 if (scroll_quantity == "up")
1936 scrollUp(scroll_step);
1937 else if (scroll_quantity == "down")
1938 scrollDown(scroll_step);
1940 int const scroll_value = convert<int>(scroll_quantity);
1942 scroll(scroll_step * scroll_value);
1944 dr.screenUpdate(Update::ForceDraw);
1945 dr.forceBufferUpdate();
1949 case LFUN_SCREEN_UP_SELECT: {
1950 // FIXME: why is the algorithm different from LFUN_SCREEN_UP?
1951 cur.selHandle(true);
1952 if (isTopScreen()) {
1953 lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1957 int y = getPos(cur).y_;
1958 int const ymin = y - height_ + defaultRowHeight();
1959 while (y > ymin && cur.up())
1963 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1967 case LFUN_SCREEN_DOWN_SELECT: {
1968 // FIXME: why is the algorithm different from LFUN_SCREEN_DOWN?
1969 cur.selHandle(true);
1970 if (isBottomScreen()) {
1971 lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1975 int y = getPos(cur).y_;
1976 int const ymax = y + height_ - defaultRowHeight();
1977 while (y < ymax && cur.down())
1981 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1986 case LFUN_INSET_SELECT_ALL: {
1987 // true if all cells are selected
1988 bool const all_selected = cur.depth() > 1
1989 && cur.selBegin().at_begin()
1990 && cur.selEnd().at_end();
1991 // true if some cells are selected
1992 bool const cells_selected = cur.depth() > 1
1993 && cur.selBegin().at_cell_begin()
1994 && cur.selEnd().at_cell_end();
1995 if (all_selected || (cells_selected && !cur.inset().isTable())) {
1996 // All the contents of the inset if selected, or only at
1997 // least one cell but inset is not a table.
1998 // Select the inset from outside.
2001 cur.selection(true);
2003 } else if (cells_selected) {
2004 // At least one complete cell is selected and inset is a table.
2010 cur.selection(true);
2011 cur.idx() = cur.lastidx();
2012 cur.pit() = cur.lastpit();
2013 cur.pos() = cur.lastpos();
2015 // select current cell
2019 cur.selection(true);
2020 cur.pit() = cur.lastpit();
2021 cur.pos() = cur.lastpos();
2023 cur.setCurrentFont();
2024 dr.screenUpdate(Update::Force);
2029 case LFUN_UNICODE_INSERT: {
2030 if (cmd.argument().empty())
2033 FuncCode code = cur.inset().currentMode() == Inset::MATH_MODE ?
2034 LFUN_MATH_INSERT : LFUN_SELF_INSERT;
2037 docstring const arg = from_utf8(cmd.getArg(i));
2041 LYXERR0("Not a hexstring: " << arg);
2045 char_type c = hexToInt(arg);
2046 if (c >= 32 && c < 0x10ffff) {
2047 LYXERR(Debug::KEY, "Inserting c: " << c);
2048 lyx::dispatch(FuncRequest(code, docstring(1, c)));
2056 // This would be in Buffer class if only Cursor did not
2057 // require a bufferview
2058 case LFUN_INSET_FORALL: {
2059 docstring const name = from_utf8(cmd.getArg(0));
2060 string const commandstr = cmd.getLongArg(1);
2061 FuncRequest const fr = lyxaction.lookupFunc(commandstr);
2063 // an arbitrary number to limit number of iterations
2064 const int max_iter = 100000;
2066 Cursor & curs = d->cursor_;
2067 Cursor const savecur = curs;
2069 if (!curs.nextInset())
2070 curs.forwardInset();
2071 curs.beginUndoGroup();
2072 while(curs && iterations < max_iter) {
2073 Inset * const ins = curs.nextInset();
2076 docstring insname = ins->layoutName();
2077 while (!insname.empty()) {
2078 if (insname == name || name == from_utf8("*")) {
2080 lyx::dispatch(fr, dr);
2084 size_t const i = insname.rfind(':');
2085 if (i == string::npos)
2087 insname = insname.substr(0, i);
2089 // if we did not delete the inset, skip it
2090 if (!curs.nextInset() || curs.nextInset() == ins)
2091 curs.forwardInset();
2095 /** This is a dummy undo record only to remember the cursor
2096 * that has just been set; this will be used on a redo action
2097 * (see ticket #10097)
2099 * FIXME: a better fix would be to have a way to set the
2100 * cursor value directly, but I am not sure it is worth it.
2103 curs.endUndoGroup();
2104 dr.screenUpdate(Update::Force);
2105 dr.forceBufferUpdate();
2107 if (iterations >= max_iter) {
2109 dr.setMessage(bformat(_("`inset-forall' interrupted because number of actions is larger than %1$d"), max_iter));
2111 dr.setMessage(bformat(_("Applied \"%1$s\" to %2$d insets"), from_utf8(commandstr), iterations));
2116 case LFUN_BRANCH_ADD_INSERT: {
2117 docstring branch_name = from_utf8(cmd.getArg(0));
2118 if (branch_name.empty())
2119 if (!Alert::askForText(branch_name, _("Branch name")) ||
2120 branch_name.empty())
2123 DispatchResult drtmp;
2124 buffer_.dispatch(FuncRequest(LFUN_BRANCH_ADD, branch_name), drtmp);
2125 if (drtmp.error()) {
2126 Alert::warning(_("Branch already exists"), drtmp.message());
2129 docstring const sep = buffer_.params().branchlist().separator();
2130 for (docstring const & branch : getVectorFromString(branch_name, sep))
2131 lyx::dispatch(FuncRequest(LFUN_BRANCH_INSERT, branch));
2135 case LFUN_KEYMAP_OFF:
2136 getIntl().keyMapOn(false);
2139 case LFUN_KEYMAP_PRIMARY:
2140 getIntl().keyMapPrim();
2143 case LFUN_KEYMAP_SECONDARY:
2144 getIntl().keyMapSec();
2147 case LFUN_KEYMAP_TOGGLE:
2148 getIntl().toggleKeyMap();
2151 case LFUN_DIALOG_SHOW_NEW_INSET: {
2152 string const name = cmd.getArg(0);
2153 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
2154 if (decodeInsetParam(name, data, buffer_))
2155 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
2157 lyxerr << "Inset type '" << name <<
2158 "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" << endl;
2162 case LFUN_CITATION_INSERT: {
2163 if (argument.empty()) {
2164 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
2167 // we can have one optional argument, delimited by '|'
2168 // citation-insert <key>|<text_before>
2169 // this should be enhanced to also support text_after
2170 // and citation style
2171 string arg = argument;
2173 if (contains(argument, "|")) {
2174 arg = token(argument, '|', 0);
2175 opt1 = token(argument, '|', 1);
2178 // if our cursor is directly in front of or behind a citation inset,
2179 // we will instead add the new key to it.
2180 Inset * inset = cur.nextInset();
2181 if (!inset || inset->lyxCode() != CITE_CODE)
2182 inset = cur.prevInset();
2183 if (inset && inset->lyxCode() == CITE_CODE) {
2184 InsetCitation * icite = static_cast<InsetCitation *>(inset);
2185 if (icite->addKey(arg)) {
2186 dr.forceBufferUpdate();
2187 dr.screenUpdate(Update::FitCursor | Update::SinglePar);
2189 LYXERR0("Discarding optional argument to citation-insert.");
2194 InsetCommandParams icp(CITE_CODE);
2195 icp["key"] = from_utf8(arg);
2197 icp["before"] = from_utf8(opt1);
2199 from_ascii(InsetCitation::last_literal ? "true" : "false");
2200 string icstr = InsetCommand::params2string(icp);
2201 FuncRequest fr(LFUN_INSET_INSERT, icstr);
2206 case LFUN_INSET_APPLY: {
2207 string const name = cmd.getArg(0);
2208 Inset * inset = editedInset(name);
2210 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
2214 // put cursor in front of inset.
2215 if (!setCursorFromInset(inset)) {
2216 LASSERT(false, break);
2219 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
2220 inset->dispatch(cur, fr);
2221 dr.screenUpdate(cur.result().screenUpdate());
2222 if (cur.result().needBufferUpdate())
2223 dr.forceBufferUpdate();
2228 // The change of language of buffer belongs to the Buffer class.
2229 // We have to do it here because we need a cursor for Undo.
2230 // When Undo::recordUndoBufferParams() is implemented someday
2231 // LFUN_BUFFER_LANGUAGE should be handled by the Buffer class.
2232 case LFUN_BUFFER_LANGUAGE: {
2233 Language const * oldL = buffer_.params().language;
2234 Language const * newL = languages.getLanguage(argument);
2235 if (!newL || oldL == newL)
2237 if (oldL->rightToLeft() == newL->rightToLeft()) {
2238 cur.recordUndoFullBuffer();
2239 buffer_.changeLanguage(oldL, newL);
2240 cur.setCurrentFont();
2241 dr.forceBufferUpdate();
2246 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
2247 case LFUN_FILE_INSERT_PLAINTEXT: {
2248 bool const as_paragraph = (act == LFUN_FILE_INSERT_PLAINTEXT_PARA);
2249 string const fname = to_utf8(cmd.argument());
2250 if (!FileName::isAbsolute(fname))
2251 dr.setMessage(_("Absolute filename expected."));
2253 insertPlaintextFile(FileName(fname), as_paragraph);
2258 // With multi-cell table content, we pass down to the inset
2259 if (cur.inTexted() && cur.selection()
2260 && cur.selectionBegin().idx() != cur.selectionEnd().idx()) {
2261 buffer_.dispatch(cmd, dr);
2262 dispatched = dr.dispatched();
2265 cap::copySelection(cur);
2266 cur.message(_("Copy"));
2270 // OK, so try the Buffer itself...
2271 buffer_.dispatch(cmd, dr);
2272 dispatched = dr.dispatched();
2276 buffer_.undo().endUndoGroup();
2277 dr.dispatched(dispatched);
2279 // NOTE: The code below is copied from Cursor::dispatch. If you
2280 // need to modify this, please update the other one too.
2282 // notify insets we just entered/left
2283 if (cursor() != old) {
2284 old.beginUndoGroup();
2286 bool badcursor = notifyCursorLeavesOrEnters(old, cursor());
2288 cursor().fixIfBroken();
2289 resetInlineCompletionPos();
2296 docstring BufferView::requestSelection()
2298 Cursor & cur = d->cursor_;
2300 LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
2301 if (!cur.selection()) {
2302 d->xsel_cache_.set = false;
2306 LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
2307 if (!d->xsel_cache_.set ||
2308 cur.top() != d->xsel_cache_.cursor ||
2309 cur.realAnchor().top() != d->xsel_cache_.anchor)
2311 d->xsel_cache_.cursor = cur.top();
2312 d->xsel_cache_.anchor = cur.realAnchor().top();
2313 d->xsel_cache_.set = cur.selection();
2314 return cur.selectionAsString(false);
2320 void BufferView::clearSelection()
2322 d->cursor_.clearSelection();
2323 // Clear the selection buffer. Otherwise a subsequent
2324 // middle-mouse-button paste would use the selection buffer,
2325 // not the more current external selection.
2326 cap::clearSelection();
2327 d->xsel_cache_.set = false;
2328 // The buffer did not really change, but this causes the
2329 // redraw we need because we cleared the selection above.
2330 buffer_.changed(false);
2334 void BufferView::resize(int width, int height)
2336 // Update from work area
2340 // Clear the paragraph height cache.
2341 d->par_height_.clear();
2342 // Redo the metrics.
2347 Inset const * BufferView::getCoveringInset(Text const & text,
2350 TextMetrics & tm = d->text_metrics_[&text];
2351 Inset * inset = tm.checkInsetHit(x, y);
2355 if (!inset->descendable(*this))
2356 // No need to go further down if the inset is not
2360 size_t cell_number = inset->nargs();
2361 // Check all the inner cell.
2362 for (size_t i = 0; i != cell_number; ++i) {
2363 Text const * inner_text = inset->getText(i);
2366 Inset const * inset_deeper =
2367 getCoveringInset(*inner_text, x, y);
2369 return inset_deeper;
2377 Inset const * BufferView::clickableMathInset(InsetMathNest const * inset,
2378 CoordCache::Insets const & inset_cache, int x, int y) const
2380 for (size_t i = 0; i < inset->nargs(); ++i) {
2381 MathData const & ar = inset->cell(i);
2382 for (size_t j = 0; j < ar.size(); ++j) {
2383 string const name = lyxerr.debugging(Debug::MATHED)
2384 ? insetName(ar[j].nucleus()->lyxCode())
2386 LYXERR(Debug::MATHED, "Checking inset: " << name);
2387 if (ar[j].nucleus()->clickable(*this, x, y)) {
2388 if (inset_cache.covers(ar[j].nucleus(), x, y)) {
2389 LYXERR(Debug::MATHED, "Clickable inset: "
2391 return ar[j].nucleus();
2394 InsetMathNest const * imn =
2395 ar[j].nucleus()->asNestInset();
2397 Inset const * inner =
2398 clickableMathInset(imn, inset_cache, x, y);
2408 void BufferView::updateHoveredInset() const
2410 // Get inset under mouse, if there is one.
2411 int const x = d->mouse_position_cache_.x_;
2412 int const y = d->mouse_position_cache_.y_;
2413 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
2414 if (covering_inset && covering_inset->asInsetMath()) {
2415 Inset const * inner_inset = clickableMathInset(
2416 covering_inset->asInsetMath()->asNestInset(),
2417 coordCache().getInsets(), x, y);
2419 covering_inset = inner_inset;
2422 d->clickable_inset_ = covering_inset && covering_inset->clickable(*this, x, y);
2424 if (covering_inset == d->last_inset_)
2425 // Same inset, no need to do anything...
2428 bool need_redraw = false;
2429 if (d->last_inset_) {
2430 // Remove the hint on the last hovered inset (if any).
2431 need_redraw |= d->last_inset_->setMouseHover(this, false);
2432 d->last_inset_ = nullptr;
2435 if (covering_inset && covering_inset->setMouseHover(this, true)) {
2437 // Only the insets that accept the hover state, do
2438 // clear the last_inset_, so only set the last_inset_
2439 // member if the hovered setting is accepted.
2440 d->last_inset_ = covering_inset;
2444 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
2445 << d->mouse_position_cache_.x_ << ", "
2446 << d->mouse_position_cache_.y_ << ")");
2448 d->update_strategy_ = DecorationUpdate;
2450 // This event (moving without mouse click) is not passed further.
2451 // This should be changed if it is further utilized.
2452 buffer_.changed(false);
2457 void BufferView::clearLastInset(Inset * inset) const
2459 if (d->last_inset_ != inset) {
2460 LYXERR0("Wrong last_inset!");
2463 d->last_inset_ = nullptr;
2467 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
2469 //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
2471 // This is only called for mouse related events including
2472 // LFUN_FILE_OPEN generated by drag-and-drop.
2473 FuncRequest cmd = cmd0;
2475 Cursor old = cursor();
2477 cur.push(buffer_.inset());
2478 cur.selection(d->cursor_.selection());
2480 // Either the inset under the cursor or the
2481 // surrounding Text will handle this event.
2483 // make sure we stay within the screen...
2484 cmd.set_y(min(max(cmd.y(), -1), height_));
2486 d->mouse_position_cache_.x_ = cmd.x();
2487 d->mouse_position_cache_.y_ = cmd.y();
2489 if (cmd.action() == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
2490 updateHoveredInset();
2494 // Build temporary cursor.
2495 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x(), cmd.y());
2497 // If inset is not editable, cur.pos() might point behind the
2498 // inset (depending on cmd.x(), cmd.y()). This is needed for
2499 // editing to fix bug 9628, but e.g. the context menu needs a
2500 // cursor in front of the inset.
2501 if ((inset->hasSettings() || !inset->contextMenuName().empty()
2502 || inset->lyxCode() == SEPARATOR_CODE) &&
2503 cur.nextInset() != inset && cur.prevInset() == inset)
2505 } else if (cur.inTexted() && cur.pos()
2506 && cur.paragraph().isEnvSeparator(cur.pos() - 1)) {
2507 // Always place cursor in front of a separator inset.
2511 // Put anchor at the same position.
2514 cur.beginUndoGroup();
2516 // Try to dispatch to an non-editable inset near this position
2517 // via the temp cursor. If the inset wishes to change the real
2518 // cursor it has to do so explicitly by using
2519 // cur.bv().cursor() = cur; (or similar)
2521 inset->dispatch(cur, cmd);
2523 // Now dispatch to the temporary cursor. If the real cursor should
2524 // be modified, the inset's dispatch has to do so explicitly.
2525 if (!inset || !cur.result().dispatched())
2528 // Notify left insets
2530 bool badcursor = old.fixIfBroken() | cur.fixIfBroken();
2531 badcursor |= notifyCursorLeavesOrEnters(old, cur);
2533 cursor().fixIfBroken();
2538 // Do we have a selection?
2539 theSelection().haveSelection(cursor().selection());
2541 if (cur.needBufferUpdate() || buffer().needUpdate()) {
2542 cur.clearBufferUpdate();
2543 buffer().updateBuffer();
2546 // If the command has been dispatched,
2547 if (cur.result().dispatched() || cur.result().screenUpdate())
2548 processUpdateFlags(cur.result().screenUpdate());
2552 int BufferView::minVisiblePart()
2554 return 2 * defaultRowHeight();
2558 int BufferView::scroll(int pixels)
2561 return scrollDown(pixels);
2563 return scrollUp(-pixels);
2568 int BufferView::scrollDown(int pixels)
2570 Text * text = &buffer_.text();
2571 TextMetrics & tm = d->text_metrics_[text];
2572 int const ymax = height_ + pixels;
2574 pair<pit_type, ParagraphMetrics const *> last = tm.last();
2575 int bottom_pos = last.second->position() + last.second->descent();
2576 if (lyxrc.scroll_below_document)
2577 bottom_pos += height_ - minVisiblePart();
2578 if (last.first + 1 == int(text->paragraphs().size())) {
2579 if (bottom_pos <= height_)
2581 pixels = min(pixels, bottom_pos - height_);
2584 if (bottom_pos > ymax)
2586 tm.newParMetricsDown();
2588 d->anchor_ypos_ -= pixels;
2593 int BufferView::scrollUp(int pixels)
2595 Text * text = &buffer_.text();
2596 TextMetrics & tm = d->text_metrics_[text];
2597 int ymin = - pixels;
2599 pair<pit_type, ParagraphMetrics const *> first = tm.first();
2600 int top_pos = first.second->position() - first.second->ascent();
2601 if (first.first == 0) {
2604 pixels = min(pixels, - top_pos);
2609 tm.newParMetricsUp();
2611 d->anchor_ypos_ += pixels;
2616 bool BufferView::setCursorFromRow(int row)
2618 TexRow::TextEntry start, end;
2619 tie(start,end) = buffer_.texrow().getEntriesFromRow(row);
2620 LYXERR(Debug::LATEX,
2621 "setCursorFromRow: for row " << row << ", TexRow has found "
2622 "start (id=" << start.id << ",pos=" << start.pos << "), "
2623 "end (id=" << end.id << ",pos=" << end.pos << ")");
2624 return setCursorFromEntries(start, end);
2628 bool BufferView::setCursorFromEntries(TexRow::TextEntry start,
2629 TexRow::TextEntry end)
2631 DocIterator dit_start, dit_end;
2632 tie(dit_start,dit_end) =
2633 TexRow::getDocIteratorsFromEntries(start, end, buffer_);
2636 // Setting selection start
2637 d->cursor_.clearSelection();
2638 setCursor(dit_start);
2639 // Setting selection end
2641 d->cursor_.resetAnchor();
2642 setCursorSelectionTo(dit_end);
2648 bool BufferView::setCursorFromInset(Inset const * inset)
2650 // are we already there?
2651 if (cursor().nextInset() == inset)
2654 // Inset is not at cursor position. Find it in the document.
2657 while (cur && cur.nextInset() != inset)
2668 void BufferView::gotoLabel(docstring const & label)
2671 bool have_inactive = false;
2672 for (Buffer const * buf : buffer().allRelatives()) {
2674 for (TocItem const & item : *buf->tocBackend().toc("label")) {
2675 if (label == item.str() && item.isOutput()) {
2676 lyx::dispatch(item.action());
2679 // If we find an inactive label, save it for the case
2680 // that no active one is there
2681 if (label == item.str() && !have_inactive) {
2682 have_inactive = true;
2683 action = item.action();
2687 // We only found an inactive label. Go there.
2689 lyx::dispatch(action);
2693 TextMetrics const & BufferView::textMetrics(Text const * t) const
2695 return const_cast<BufferView *>(this)->textMetrics(t);
2699 TextMetrics & BufferView::textMetrics(Text const * t)
2702 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
2703 if (tmc_it == d->text_metrics_.end()) {
2704 tmc_it = d->text_metrics_.emplace(std::piecewise_construct,
2705 std::forward_as_tuple(t),
2706 std::forward_as_tuple(this, const_cast<Text *>(t))).first;
2708 return tmc_it->second;
2712 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
2715 return textMetrics(t).parMetrics(pit);
2719 int BufferView::workHeight() const
2725 void BufferView::setCursor(DocIterator const & dit)
2728 size_t const n = dit.depth();
2729 for (size_t i = 0; i < n; ++i)
2730 dit[i].inset().edit(d->cursor_, true);
2732 d->cursor_.setCursor(dit);
2733 d->cursor_.selection(false);
2734 d->cursor_.setCurrentFont();
2736 // It seems on general grounds as if this is probably needed, but
2737 // it is not yet clear.
2738 // See bug #7394 and r38388.
2739 // d->cursor.resetAnchor();
2743 void BufferView::setCursorSelectionTo(DocIterator const & dit)
2745 size_t const n = dit.depth();
2746 for (size_t i = 0; i < n; ++i)
2747 dit[i].inset().edit(d->cursor_, true);
2749 d->cursor_.selection(true);
2750 d->cursor_.setCursorSelectionTo(dit);
2751 d->cursor_.setCurrentFont();
2755 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
2757 // Would be wrong to delete anything if we have a selection.
2758 if (cur.selection())
2761 bool need_anchor_change = false;
2762 bool changed = Text::deleteEmptyParagraphMechanism(cur, old,
2763 need_anchor_change);
2765 if (need_anchor_change)
2773 // we would rather not do this here, but it needs to be done before
2774 // the changed() signal is sent.
2775 buffer_.updateBuffer();
2777 buffer_.changed(true);
2782 bool BufferView::mouseSetCursor(Cursor & cur, bool const select)
2784 LASSERT(&cur.bv() == this, return false);
2787 // this event will clear selection so we save selection for
2788 // persistent selection
2789 cap::saveSelection(cursor());
2791 d->cursor_.macroModeClose();
2792 // If a macro has been finalized, the cursor might have been broken
2795 // Has the cursor just left the inset?
2796 bool const leftinset = (&d->cursor_.inset() != &cur.inset());
2798 d->cursor_.fixIfBroken();
2800 // do the dEPM magic if needed
2801 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
2802 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
2803 // the leftinset bool would not be necessary (badcursor instead).
2804 bool update = leftinset;
2807 d->cursor_.setSelection();
2808 d->cursor_.setCursorSelectionTo(cur);
2810 if (d->cursor_.inTexted())
2811 update |= checkDepm(cur, d->cursor_);
2812 d->cursor_.resetAnchor();
2813 d->cursor_.setCursor(cur);
2814 d->cursor_.clearSelection();
2816 d->cursor_.boundary(cur.boundary());
2817 d->cursor_.finishUndo();
2818 d->cursor_.setCurrentFont();
2820 cur.forceBufferUpdate();
2825 void BufferView::putSelectionAt(DocIterator const & cur,
2826 int length, bool backwards)
2828 d->cursor_.clearSelection();
2834 d->cursor_.pos() += length;
2835 d->cursor_.setSelection(d->cursor_, -length);
2837 d->cursor_.setSelection(d->cursor_, length);
2842 bool BufferView::selectIfEmpty(DocIterator & cur)
2844 if ((cur.inTexted() && !cur.paragraph().empty())
2845 || (cur.inMathed() && !cur.cell().empty()))
2848 pit_type const beg_pit = cur.pit();
2850 // The paragraph associated to this item isn't
2851 // the first one, so it can be selected
2854 // We have to resort to select the space between the
2855 // end of this item and the begin of the next one
2859 // If it is the only item in the document,
2860 // nothing can be selected
2863 pit_type const end_pit = cur.pit();
2864 pos_type const end_pos = cur.pos();
2865 d->cursor_.clearSelection();
2867 d->cursor_.setCursor(cur);
2868 d->cursor_.pit() = beg_pit;
2869 d->cursor_.pos() = 0;
2870 d->cursor_.selection(false);
2871 d->cursor_.resetAnchor();
2872 d->cursor_.pit() = end_pit;
2873 d->cursor_.pos() = end_pos;
2874 d->cursor_.setSelection();
2879 Cursor & BufferView::cursor()
2885 Cursor const & BufferView::cursor() const
2891 bool BufferView::singleParUpdate()
2893 Text & buftext = buffer_.text();
2894 pit_type const bottom_pit = d->cursor_.bottom().pit();
2895 TextMetrics & tm = textMetrics(&buftext);
2896 Dimension const old_dim = tm.parMetrics(bottom_pit).dim();
2898 // make sure inline completion pointer is ok
2899 if (d->inlineCompletionPos_.fixIfBroken())
2900 d->inlineCompletionPos_ = DocIterator();
2902 // In Single Paragraph mode, rebreak only
2903 // the (main text, not inset!) paragraph containing the cursor.
2904 // (if this paragraph contains insets etc., rebreaking will
2905 // recursively descend)
2906 tm.redoParagraph(bottom_pit);
2907 ParagraphMetrics & pm = tm.parMetrics(bottom_pit);
2908 if (pm.height() != old_dim.height()) {
2909 // Paragraph height has changed so we cannot proceed to
2910 // the singlePar optimisation.
2913 // Since position() points to the baseline of the first row, we
2914 // may have to update it. See ticket #11601 for an example where
2915 // the height does not change but the ascent does.
2916 pm.setPosition(pm.position() - old_dim.ascent() + pm.ascent());
2918 tm.updatePosCache(bottom_pit);
2920 LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
2921 << " y2: " << pm.position() + pm.descent()
2922 << " pit: " << bottom_pit
2923 << " singlepar: 1");
2928 void BufferView::updateMetrics()
2930 updateMetrics(d->update_flags_);
2931 d->update_strategy_ = FullScreenUpdate;
2935 void BufferView::updateMetrics(Update::flags & update_flags)
2937 if (height_ == 0 || width_ == 0)
2940 Text & buftext = buffer_.text();
2941 pit_type const npit = int(buftext.paragraphs().size());
2943 // Clear out the position cache in case of full screen redraw,
2944 d->coord_cache_.clear();
2945 d->math_rows_.clear();
2947 // Clear out paragraph metrics to avoid having invalid metrics
2948 // in the cache from paragraphs not relayouted below
2949 // The complete text metrics will be redone.
2950 d->text_metrics_.clear();
2952 TextMetrics & tm = textMetrics(&buftext);
2954 // make sure inline completion pointer is ok
2955 if (d->inlineCompletionPos_.fixIfBroken())
2956 d->inlineCompletionPos_ = DocIterator();
2958 if (d->anchor_pit_ >= npit)
2959 // The anchor pit must have been deleted...
2960 d->anchor_pit_ = npit - 1;
2962 // Rebreak anchor paragraph.
2963 tm.redoParagraph(d->anchor_pit_);
2964 ParagraphMetrics & anchor_pm = tm.parMetrics(d->anchor_pit_);
2967 if (d->anchor_pit_ == 0) {
2968 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
2970 // Complete buffer visible? Then it's easy.
2971 if (scrollRange == 0)
2972 d->anchor_ypos_ = anchor_pm.ascent();
2974 // avoid empty space above the first row
2975 d->anchor_ypos_ = min(d->anchor_ypos_, anchor_pm.ascent());
2978 anchor_pm.setPosition(d->anchor_ypos_);
2979 tm.updatePosCache(d->anchor_pit_);
2981 LYXERR(Debug::PAINTING, "metrics: "
2982 << " anchor pit = " << d->anchor_pit_
2983 << " anchor ypos = " << d->anchor_ypos_);
2985 // Redo paragraphs above anchor if necessary.
2986 int y1 = d->anchor_ypos_ - anchor_pm.ascent();
2987 // We are now just above the anchor paragraph.
2988 pit_type pit1 = d->anchor_pit_ - 1;
2989 for (; pit1 >= 0 && y1 >= 0; --pit1) {
2990 tm.redoParagraph(pit1);
2991 ParagraphMetrics & pm = tm.parMetrics(pit1);
2993 // Save the paragraph position in the cache.
2995 tm.updatePosCache(pit1);
2999 // Redo paragraphs below the anchor if necessary.
3000 int y2 = d->anchor_ypos_ + anchor_pm.descent();
3001 // We are now just below the anchor paragraph.
3002 pit_type pit2 = d->anchor_pit_ + 1;
3003 for (; pit2 < npit && y2 <= height_; ++pit2) {
3004 tm.redoParagraph(pit2);
3005 ParagraphMetrics & pm = tm.parMetrics(pit2);
3007 // Save the paragraph position in the cache.
3009 tm.updatePosCache(pit2);
3013 LYXERR(Debug::PAINTING, "Metrics: "
3014 << " anchor pit = " << d->anchor_pit_
3015 << " anchor ypos = " << d->anchor_ypos_
3018 << " pit1 = " << pit1
3019 << " pit2 = " << pit2);
3021 // metrics is done, full drawing is necessary now
3022 update_flags = (update_flags & ~Update::Force) | Update::ForceDraw;
3024 // Now update the positions of insets in the cache.
3027 if (lyxerr.debugging(Debug::WORKAREA)) {
3028 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
3029 d->coord_cache_.dump();
3034 void BufferView::updatePosCache()
3036 // this is the "nodraw" drawing stage: only set the positions of the
3037 // insets in metrics cache.
3038 frontend::NullPainter np;
3043 void BufferView::insertLyXFile(FileName const & fname, bool const ignorelang)
3045 LASSERT(d->cursor_.inTexted(), return);
3047 // Get absolute path of file and add ".lyx"
3048 // to the filename if necessary
3049 FileName filename = fileSearch(string(), fname.absFileName(), "lyx");
3051 docstring const disp_fn = makeDisplayPath(filename.absFileName());
3052 // emit message signal.
3053 message(bformat(_("Inserting document %1$s..."), disp_fn));
3056 Buffer buf(filename.absFileName(), false);
3057 if (buf.loadLyXFile() == Buffer::ReadSuccess) {
3058 ErrorList & el = buffer_.errorList("Parse");
3059 // Copy the inserted document error list into the current buffer one.
3060 el = buf.errorList("Parse");
3061 ParagraphList & pars = buf.paragraphs();
3063 // set main language of imported file to context language
3064 buf.changeLanguage(buf.language(), d->cursor_.getFont().language());
3065 buffer_.undo().recordUndo(d->cursor_);
3066 cap::pasteParagraphList(d->cursor_, pars,
3067 buf.params().documentClassPtr(),
3068 buf.params().authors(), el);
3069 res = _("Document %1$s inserted.");
3071 res = _("Could not insert document %1$s");
3074 buffer_.changed(true);
3075 // emit message signal.
3076 message(bformat(res, disp_fn));
3080 Point BufferView::coordOffset(DocIterator const & dit) const
3086 // Addup contribution of nested insets, from inside to outside,
3087 // keeping the outer paragraph for a special handling below
3088 for (size_t i = dit.depth() - 1; i >= 1; --i) {
3089 CursorSlice const & sl = dit[i];
3093 // get relative position inside sl.inset()
3094 sl.inset().cursorPos(*this, sl, dit.boundary() && (i + 1 == dit.depth()), xx, yy);
3096 // Make relative position inside of the edited inset relative to sl.inset()
3100 // In case of an RTL inset, the edited inset will be positioned to the left
3103 bool boundary_i = dit.boundary() && i + 1 == dit.depth();
3104 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
3109 // remember width for the case that sl.inset() is positioned in an RTL inset
3110 lastw = sl.inset().dimension(*this).wid;
3112 //lyxerr << "Cursor::getPos, i: "
3113 // << i << " x: " << xx << " y: " << y << endl;
3116 // Add contribution of initial rows of outermost paragraph
3117 CursorSlice const & sl = dit[0];
3118 TextMetrics const & tm = textMetrics(sl.text());
3119 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
3121 LBUFERR(!pm.rows().empty());
3122 y -= pm.rows()[0].ascent();
3124 // FIXME: document this mess
3126 if (sl.pos() > 0 && dit.depth() == 1) {
3128 if (pos && dit.boundary())
3130 // lyxerr << "coordOffset: boundary:" << dit.boundary() << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
3131 rend = pm.pos2row(pos);
3133 rend = pm.pos2row(sl.pos());
3135 size_t rend = pm.pos2row(sl.pos());
3137 for (size_t rit = 0; rit != rend; ++rit)
3138 y += pm.rows()[rit].height();
3139 y += pm.rows()[rend].ascent();
3141 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
3143 // Make relative position from the nested inset now bufferview absolute.
3144 int xx = bottom_tm.cursorX(dit.bottom(), dit.boundary() && dit.depth() == 1);
3147 // In the RTL case place the nested inset at the left of the cursor in
3148 // the outer paragraph
3149 bool boundary_1 = dit.boundary() && 1 == dit.depth();
3150 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
3158 Point BufferView::getPos(DocIterator const & dit) const
3160 if (!paragraphVisible(dit))
3161 return Point(-1, -1);
3163 CursorSlice const & bot = dit.bottom();
3164 TextMetrics const & tm = textMetrics(bot.text());
3166 // offset from outer paragraph
3167 Point p = coordOffset(dit);
3168 p.y_ += tm.parMetrics(bot.pit()).position();
3173 bool BufferView::paragraphVisible(DocIterator const & dit) const
3175 CursorSlice const & bot = dit.bottom();
3176 TextMetrics const & tm = textMetrics(bot.text());
3178 return tm.contains(bot.pit());
3182 void BufferView::caretPosAndDim(Point & p, Dimension & dim) const
3184 Cursor const & cur = cursor();
3185 if (cur.inMathed()) {
3186 MathRow const & mrow = mathRow(&cur.cell());
3187 dim = mrow.caret_dim;
3189 Font const font = cur.real_current_font;
3190 frontend::FontMetrics const & fm = theFontMetrics(font);
3191 // lineWidth() can be 0 to mean 'thin line' on HiDpi, but the
3192 // caret drawing code is not prepared for that.
3193 dim.wid = max(fm.lineWidth(), 1);
3194 dim.asc = fm.maxAscent();
3195 dim.des = fm.maxDescent();
3197 if (lyxrc.cursor_width > 0)
3198 dim.wid = lyxrc.cursor_width;
3201 // center fat carets horizontally
3202 p.x_ -= dim.wid / 2;
3208 void BufferView::buildCaretGeometry(bool complet)
3212 caretPosAndDim(p, dim);
3214 Cursor const & cur = d->cursor_;
3215 Font const & realfont = cur.real_current_font;
3216 frontend::FontMetrics const & fm = theFontMetrics(realfont.fontInfo());
3217 bool const isrtl = realfont.isVisibleRightToLeft();
3218 int const dir = isrtl ? -1 : 1;
3220 frontend::CaretGeometry & cg = d->caret_geometry_;
3223 // The caret itself, slanted for italics in text edit mode except
3224 // for selections because the selection rect does not slant
3225 bool const slant = fm.italic() && cur.inTexted() && !cur.selection();
3226 double const slope = slant ? fm.italicSlope() : 0;
3227 cg.shapes.push_back(
3228 {{iround(p.x_ + dim.asc * slope), p.y_},
3229 {iround(p.x_ - dim.des * slope), p.y_ + dim.height()},
3230 {iround(p.x_ + dir * dim.wid - dim.des * slope), p.y_ + dim.height()},
3231 {iround(p.x_ + dir * dim.wid + dim.asc * slope), p.y_}}
3234 // The language indicator _| (if needed)
3235 Language const * doclang = buffer().params().language;
3236 if (!((realfont.language() == doclang && isrtl == doclang->rightToLeft())
3237 || realfont.language() == latex_language)) {
3238 int const lx = dim.height() / 3;
3239 int const xx = iround(p.x_ - dim.des * slope);
3240 int const yy = p.y_ + dim.height();
3241 cg.shapes.push_back(
3242 {{xx, yy - dim.wid},
3243 {xx + dir * (dim.wid + lx - 1), yy - dim.wid},
3244 {xx + dir * (dim.wid + lx - 1), yy},
3249 // The completion triangle |> (if needed)
3251 int const m = p.y_ + dim.height() / 2;
3252 int const d = dim.height() / 8;
3253 // offset for slanted carret
3254 int const sx = iround((dim.asc - (dim.height() / 2 - d)) * slope);
3255 // starting position x
3256 int const xx = p.x_ + dir * dim.wid + sx;
3257 cg.shapes.push_back(
3261 {xx, m + d - dim.wid},
3262 {xx + dir * d - dim.wid, m},
3263 {xx, m - d + dim.wid}}
3267 // compute extremal x values
3269 cg.right = -1000000;
3271 cg.bottom = -1000000;
3272 for (auto const & shape : cg.shapes)
3273 for (Point const & p : shape) {
3274 cg.left = min(cg.left, p.x_);
3275 cg.right = max(cg.right, p.x_);
3276 cg.top = min(cg.top, p.y_);
3277 cg.bottom = max(cg.bottom, p.y_);
3282 frontend::CaretGeometry const & BufferView::caretGeometry() const
3284 return d->caret_geometry_;
3288 bool BufferView::caretInView() const
3290 if (!paragraphVisible(cursor()))
3294 caretPosAndDim(p, dim);
3296 // does the cursor touch the screen ?
3297 if (p.y_ + dim.height() < 0 || p.y_ >= workHeight())
3303 int BufferView::horizScrollOffset() const
3305 return d->horiz_scroll_offset_;
3309 int BufferView::horizScrollOffset(Text const * text,
3310 pit_type pit, pos_type pos) const
3312 // Is this a row that is currently scrolled?
3313 if (!d->current_row_slice_.empty()
3314 && &text->inset() == d->current_row_slice_.inset().asInsetText()
3315 && pit == d->current_row_slice_.pit()
3316 && pos == d->current_row_slice_.pos())
3317 return d->horiz_scroll_offset_;
3322 void BufferView::setCurrentRowSlice(CursorSlice const & rowSlice)
3324 // nothing to do if the cursor was already on this row
3325 if (d->current_row_slice_ == rowSlice)
3328 // if the (previous) current row was scrolled, we have to
3329 // remember it in order to repaint it next time.
3330 if (d->horiz_scroll_offset_ != 0) {
3331 // search the old row in cache and mark it changed
3332 for (auto & tm_pair : d->text_metrics_) {
3333 if (&tm_pair.first->inset() == rowSlice.inset().asInsetText()) {
3334 tm_pair.second.setRowChanged(rowSlice.pit(), rowSlice.pos());
3335 // We found it, no need to continue.
3341 // Since we changed row, the scroll offset is not valid anymore
3342 d->horiz_scroll_offset_ = 0;
3343 d->current_row_slice_ = rowSlice;
3347 void BufferView::checkCursorScrollOffset()
3349 CursorSlice rowSlice = d->cursor_.bottom();
3350 TextMetrics const & tm = textMetrics(rowSlice.text());
3352 // Stop if metrics have not been computed yet, since it means
3353 // that there is nothing to do.
3354 if (!tm.contains(rowSlice.pit()))
3356 ParagraphMetrics const & pm = tm.parMetrics(rowSlice.pit());
3357 Row const & row = pm.getRow(rowSlice.pos(),
3358 d->cursor_.boundary() && rowSlice == d->cursor_.top());
3359 rowSlice.pos() = row.pos();
3361 // Set the row on which the cursor lives.
3362 setCurrentRowSlice(rowSlice);
3364 // Current x position of the cursor in pixels
3365 int cur_x = getPos(d->cursor_).x_;
3367 // Horizontal scroll offset of the cursor row in pixels
3368 int offset = d->horiz_scroll_offset_;
3369 int const MARGIN = 2 * theFontMetrics(d->cursor_.real_current_font).em()
3371 if (row.right_x() <= workWidth() - row.right_margin) {
3372 // Row is narrower than the work area, no offset needed.
3375 if (cur_x - offset < MARGIN) {
3376 // cursor would be too far right
3377 offset = cur_x - MARGIN;
3378 } else if (cur_x - offset > workWidth() - MARGIN) {
3379 // cursor would be too far left
3380 offset = cur_x - workWidth() + MARGIN;
3382 // Correct the offset to make sure that we do not scroll too much
3385 if (row.right_x() - offset < workWidth() - row.right_margin)
3386 offset = row.right_x() - workWidth() + row.right_margin;
3389 //lyxerr << "cur_x=" << cur_x << ", offset=" << offset << ", row.wid=" << row.width() << ", margin=" << MARGIN << endl;
3391 if (offset != d->horiz_scroll_offset_)
3392 LYXERR(Debug::PAINTING, "Horiz. scroll offset changed from "
3393 << d->horiz_scroll_offset_ << " to " << offset);
3395 if (d->update_strategy_ == NoScreenUpdate
3396 && offset != d->horiz_scroll_offset_) {
3397 // FIXME: if one uses SingleParUpdate, then home/end
3398 // will not work on long rows. Why?
3399 d->update_strategy_ = FullScreenUpdate;
3402 d->horiz_scroll_offset_ = offset;
3406 void BufferView::draw(frontend::Painter & pain, bool paint_caret)
3408 if (height_ == 0 || width_ == 0)
3410 LYXERR(Debug::PAINTING, (pain.isNull() ? "\t\t--- START NODRAW ---"
3411 : "\t\t*** START DRAWING ***"));
3412 Text & text = buffer_.text();
3413 TextMetrics const & tm = d->text_metrics_[&text];
3414 int const y = tm.first().second->position();
3415 PainterInfo pi(this, pain);
3417 // Check whether the row where the cursor lives needs to be scrolled.
3418 // Update the drawing strategy if needed.
3419 checkCursorScrollOffset();
3421 switch (d->update_strategy_) {
3423 case NoScreenUpdate:
3424 // no screen painting is actually needed. In nodraw stage
3425 // however, the different coordinates of insets and paragraphs
3426 // needs to be updated.
3427 LYXERR(Debug::PAINTING, "Strategy: NoScreenUpdate");
3428 if (pain.isNull()) {
3429 pi.full_repaint = true;
3432 pi.full_repaint = false;
3437 case SingleParUpdate:
3438 pi.full_repaint = false;
3439 LYXERR(Debug::PAINTING, "Strategy: SingleParUpdate");
3440 // In general, only the current row of the outermost paragraph
3441 // will be redrawn. Particular cases where selection spans
3442 // multiple paragraph are correctly detected in TextMetrics.
3446 case DecorationUpdate:
3447 // FIXME: We should also distinguish DecorationUpdate to avoid text
3448 // drawing if possible. This is not possible to do easily right now
3449 // because of the single backing pixmap.
3451 case FullScreenUpdate:
3453 LYXERR(Debug::PAINTING,
3454 ((d->update_strategy_ == FullScreenUpdate)
3455 ? "Strategy: FullScreenUpdate"
3456 : "Strategy: DecorationUpdate"));
3458 // The whole screen, including insets, will be refreshed.
3459 pi.full_repaint = true;
3461 // Clear background.
3462 pain.fillRectangle(0, 0, width_, height_,
3463 pi.backgroundColor(&buffer_.inset()));
3468 // and possibly grey out below
3469 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3470 int const y2 = lastpm.second->position() + lastpm.second->descent();
3473 Color color = buffer().isInternal()
3474 ? Color_background : Color_bottomarea;
3475 pain.fillRectangle(0, y2, width_, height_ - y2, color);
3479 LYXERR(Debug::PAINTING, (pain.isNull() ? "\t\t --- END NODRAW ---"
3480 : "\t\t *** END DRAWING ***"));
3482 // The scrollbar needs an update.
3483 // FIXME: does it always? see ticket #11947.
3486 // Normalize anchor for next time
3487 pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
3488 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3489 for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
3490 ParagraphMetrics const & pm = tm.parMetrics(pit);
3491 if (pm.position() + pm.descent() > 0) {
3492 if (d->anchor_pit_ != pit
3493 || d->anchor_ypos_ != pm.position())
3494 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
3495 << " anchor ypos = " << d->anchor_ypos_);
3496 d->anchor_pit_ = pit;
3497 d->anchor_ypos_ = pm.position();
3501 if (!pain.isNull()) {
3502 // reset the update flags, everything has been done
3503 d->update_flags_ = Update::None;
3506 // If a caret has to be painted, mark its text row as dirty to
3507 //make sure that it will be repainted on next redraw.
3508 /* FIXME: investigate whether this can be avoided when the cursor did not
3512 Cursor cur(d->cursor_);
3513 while (cur.depth() > 1) {
3514 if (!cur.inTexted())
3516 TextMetrics const & tm = textMetrics(cur.text());
3517 if (d->caret_geometry_.left >= tm.origin().x_
3518 && d->caret_geometry_.right <= tm.origin().x_ + tm.dim().width())
3522 cur.textRow().changed(true);
3527 void BufferView::message(docstring const & msg)
3530 d->gui_->message(msg);
3534 void BufferView::showDialog(string const & name)
3537 d->gui_->showDialog(name, string());
3541 void BufferView::showDialog(string const & name,
3542 string const & data, Inset * inset)
3545 d->gui_->showDialog(name, data, inset);
3549 void BufferView::updateDialog(string const & name, string const & data)
3552 d->gui_->updateDialog(name, data);
3556 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
3562 // FIXME: Move this out of BufferView again
3563 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
3565 if (!fname.isReadableFile()) {
3566 docstring const error = from_ascii(strerror(errno));
3567 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3568 docstring const text =
3569 bformat(_("Could not read the specified document\n"
3570 "%1$s\ndue to the error: %2$s"), file, error);
3571 Alert::error(_("Could not read file"), text);
3575 if (!fname.isReadableFile()) {
3576 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3577 docstring const text =
3578 bformat(_("%1$s\n is not readable."), file);
3579 Alert::error(_("Could not open file"), text);
3583 // FIXME UNICODE: We don't know the encoding of the file
3584 docstring file_content = fname.fileContents("UTF-8");
3585 if (file_content.empty()) {
3586 Alert::error(_("Reading not UTF-8 encoded file"),
3587 _("The file is not UTF-8 encoded.\n"
3588 "It will be read as local 8Bit-encoded.\n"
3589 "If this does not give the correct result\n"
3590 "then please change the encoding of the file\n"
3591 "to UTF-8 with a program other than LyX.\n"));
3592 file_content = fname.fileContents("local8bit");
3595 return normalize_c(file_content);
3599 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
3601 docstring const tmpstr = contentsOfPlaintextFile(f);
3606 Cursor & cur = cursor();
3607 cap::replaceSelection(cur);
3608 buffer_.undo().recordUndo(cur);
3610 cur.innerText()->insertStringAsParagraphs(cur, tmpstr, cur.current_font);
3612 cur.innerText()->insertStringAsLines(cur, tmpstr, cur.current_font);
3614 buffer_.changed(true);
3618 docstring const & BufferView::inlineCompletion() const
3620 return d->inlineCompletion_;
3624 size_t BufferView::inlineCompletionUniqueChars() const
3626 return d->inlineCompletionUniqueChars_;
3630 DocIterator const & BufferView::inlineCompletionPos() const
3632 return d->inlineCompletionPos_;
3636 void BufferView::resetInlineCompletionPos()
3638 d->inlineCompletionPos_ = DocIterator();
3642 bool samePar(DocIterator const & a, DocIterator const & b)
3644 if (a.empty() && b.empty())
3646 if (a.empty() || b.empty())
3648 if (a.depth() != b.depth())
3650 return &a.innerParagraph() == &b.innerParagraph();
3654 void BufferView::setInlineCompletion(Cursor const & cur, DocIterator const & pos,
3655 docstring const & completion, size_t uniqueChars)
3657 uniqueChars = min(completion.size(), uniqueChars);
3658 bool changed = d->inlineCompletion_ != completion
3659 || d->inlineCompletionUniqueChars_ != uniqueChars;
3660 bool singlePar = true;
3661 d->inlineCompletion_ = completion;
3662 d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
3664 //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
3667 DocIterator const & old = d->inlineCompletionPos_;
3669 //lyxerr << "inlineCompletionPos changed" << std::endl;
3670 // old or pos are in another paragraph?
3671 if ((!samePar(cur, pos) && !pos.empty())
3672 || (!samePar(cur, old) && !old.empty())) {
3674 //lyxerr << "different paragraph" << std::endl;
3676 d->inlineCompletionPos_ = pos;
3681 if (singlePar && !(cur.result().screenUpdate() & Update::Force))
3682 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
3684 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::Force);
3689 bool BufferView::clickableInset() const
3691 return d->clickable_inset_;