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 "buffer_funcs.h"
22 #include "BufferList.h"
23 #include "BufferParams.h"
24 #include "CoordCache.h"
26 #include "CutAndPaste.h"
27 #include "DispatchResult.h"
28 #include "ErrorList.h"
30 #include "FloatList.h"
31 #include "FuncRequest.h"
32 #include "FuncStatus.h"
34 #include "InsetIterator.h"
36 #include "LaTeXFeatures.h"
37 #include "LayoutFile.h"
41 #include "LyXAction.h"
45 #include "MetricsInfo.h"
46 #include "Paragraph.h"
47 #include "ParagraphParameters.h"
48 #include "ParIterator.h"
49 #include "RowPainter.h"
52 #include "TextClass.h"
53 #include "TextMetrics.h"
55 #include "TocBackend.h"
56 #include "WordLangTuple.h"
58 #include "insets/InsetBibtex.h"
59 #include "insets/InsetCitation.h"
60 #include "insets/InsetCommand.h" // ChangeRefs
61 #include "insets/InsetExternal.h"
62 #include "insets/InsetGraphics.h"
63 #include "insets/InsetNote.h"
64 #include "insets/InsetRef.h"
65 #include "insets/InsetText.h"
67 #include "mathed/MathData.h"
68 #include "mathed/InsetMathNest.h"
70 #include "frontends/alert.h"
71 #include "frontends/Application.h"
72 #include "frontends/Delegates.h"
73 #include "frontends/FontMetrics.h"
74 #include "frontends/NullPainter.h"
75 #include "frontends/Painter.h"
76 #include "frontends/Selection.h"
78 #include "support/convert.h"
79 #include "support/debug.h"
80 #include "support/ExceptionMessage.h"
81 #include "support/filetools.h"
82 #include "support/gettext.h"
83 #include "support/lassert.h"
84 #include "support/lstrings.h"
85 #include "support/lyxlib.h"
86 #include "support/Package.h"
87 #include "support/types.h"
97 using namespace lyx::support;
101 namespace Alert = frontend::Alert;
105 /// Return an inset of this class if it exists at the current cursor position
107 T * getInsetByCode(Cursor const & cur, InsetCode code)
109 DocIterator it = cur;
110 Inset * inset = it.nextInset();
111 if (inset && inset->lyxCode() == code)
112 return static_cast<T*>(inset);
117 /// Note that comparing contents can only be used for InsetCommand
118 bool findNextInset(DocIterator & dit, vector<InsetCode> const & codes,
119 docstring const & contents)
121 DocIterator tmpdit = dit;
124 Inset const * inset = tmpdit.nextInset();
126 bool const valid_code = std::find(codes.begin(), codes.end(),
127 inset->lyxCode()) != codes.end();
128 InsetCommand const * ic = inset->asInsetCommand();
129 bool const same_or_no_contents = contents.empty()
130 || (ic && (ic->getFirstNonOptParam() == contents));
132 if (valid_code && same_or_no_contents) {
137 tmpdit.forwardInset();
144 /// Looks for next inset with one of the given codes.
145 /// Note that same_content can only be used for InsetCommand
146 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
150 DocIterator tmpdit = dit;
151 tmpdit.forwardInset();
155 Inset const * inset = tmpdit.nextInset();
156 if (same_content && inset) {
157 InsetCommand const * ic = inset->asInsetCommand();
159 bool const valid_code = std::find(codes.begin(), codes.end(),
160 ic->lyxCode()) != codes.end();
162 contents = ic->getFirstNonOptParam();
166 if (!findNextInset(tmpdit, codes, contents)) {
167 if (dit.depth() != 1 || dit.pit() != 0 || dit.pos() != 0) {
168 inset = &tmpdit.bottom().inset();
169 tmpdit = doc_iterator_begin(&inset->buffer(), inset);
170 if (!findNextInset(tmpdit, codes, contents))
182 /// Looks for next inset with the given code
183 void findInset(DocIterator & dit, InsetCode code, bool same_content)
185 findInset(dit, vector<InsetCode>(1, code), same_content);
189 /// Moves cursor to the next inset with one of the given codes.
190 void gotoInset(BufferView * bv, vector<InsetCode> const & codes,
193 Cursor tmpcur = bv->cursor();
194 if (!findInset(tmpcur, codes, same_content)) {
195 bv->cursor().message(_("No more insets"));
199 tmpcur.clearSelection();
200 bv->setCursor(tmpcur);
205 /// Moves cursor to the next inset with given code.
206 void gotoInset(BufferView * bv, InsetCode code, bool same_content)
208 gotoInset(bv, vector<InsetCode>(1, code), same_content);
212 /// A map from a Text to the associated text metrics
213 typedef map<Text const *, TextMetrics> TextMetricsCache;
215 enum ScreenUpdateStrategy {
225 /////////////////////////////////////////////////////////////////////
229 /////////////////////////////////////////////////////////////////////
231 struct BufferView::Private
233 Private(BufferView & bv) :
234 update_strategy_(FullScreenUpdate),
235 update_flags_(Update::Force),
236 cursor_(bv), anchor_pit_(0), anchor_ypos_(0),
237 wh_(0), inlineCompletionUniqueChars_(0),
238 last_inset_(nullptr), mouse_position_cache_(),
239 gui_(nullptr), bookmark_edit_position_(-1),
240 horiz_scroll_offset_(0), clickable_inset_(false)
242 xsel_cache_.set = false;
246 ScrollbarParameters scrollbarParameters_;
248 ScreenUpdateStrategy update_strategy_;
250 Update::flags update_flags_;
252 CoordCache coord_cache_;
254 typedef map<MathData const *, MathRow> MathRows;
257 /// this is used to handle XSelection events in the right manner.
266 pit_type anchor_pit_;
269 /// Estimated average par height for scrollbar.
272 vector<int> par_height_;
275 DocIterator inlineCompletionPos_;
277 docstring inlineCompletion_;
279 size_t inlineCompletionUniqueChars_;
281 /// keyboard mapping object.
284 /// last visited inset.
285 /** kept to send setMouseHover(false).
286 * Not owned, so don't delete.
288 Inset const * last_inset_;
290 /// position of the mouse at the time of the last mouse move
291 /// This is used to update the hovering status of inset in
292 /// cases where the buffer is scrolled, but the mouse didn't move.
293 Point mouse_position_cache_;
295 mutable TextMetricsCache text_metrics_;
298 /** Not owned, so don't delete.
300 frontend::GuiBufferViewDelegate * gui_;
302 /// Cache for Find Next
303 FuncRequest search_request_cache_;
306 map<string, Inset *> edited_insets_;
308 /// When the row where the cursor lies is scrolled, this
309 /// contains the scroll offset
310 // cache for id of the paragraph which was edited the last time
311 int bookmark_edit_position_;
313 int horiz_scroll_offset_;
314 /// a slice pointing to the start of the row where the cursor
315 /// is (at last draw time)
316 CursorSlice current_row_slice_;
317 /// are we hovering something that we can click
318 bool clickable_inset_;
322 BufferView::BufferView(Buffer & buf)
323 : width_(0), height_(0), full_screen_(false), buffer_(buf),
324 d(new Private(*this))
326 d->xsel_cache_.set = false;
327 d->intl_.initKeyMapper(lyxrc.use_kbmap);
329 d->cursor_.setBuffer(&buf);
330 d->cursor_.push(buffer_.inset());
331 d->cursor_.resetAnchor();
332 d->cursor_.setCurrentFont();
334 buffer_.updatePreviews();
338 BufferView::~BufferView()
340 // current buffer is going to be switched-off, save cursor pos
341 // Ideally, the whole cursor stack should be saved, but session
342 // currently can only handle bottom (whole document) level pit and pos.
343 // That is to say, if a cursor is in a nested inset, it will be
344 // restore to the left of the top level inset.
345 LastFilePosSection::FilePos fp;
346 fp.file = buffer_.fileName();
347 fp.pit = d->cursor_.bottom().pit();
348 fp.pos = d->cursor_.bottom().pos();
349 theSession().lastFilePos().save(fp);
352 d->last_inset_->setMouseHover(this, false);
358 int BufferView::rightMargin() const
360 // The value used to be hardcoded to 10
361 int const default_margin = zoomedPixels(10);
362 // The additional test for the case the outliner is opened.
363 if (!full_screen_ || !lyxrc.full_screen_limit
364 || width_ < lyxrc.full_screen_width + 2 * default_margin)
365 return default_margin;
367 return (width_ - lyxrc.full_screen_width) / 2;
371 int BufferView::leftMargin() const
373 return rightMargin();
377 int BufferView::inPixels(Length const & len) const
379 Font const font = buffer().params().getFont();
380 return len.inPixels(workWidth(), theFontMetrics(font).em());
384 int BufferView::zoomedPixels(int pix) const
386 // FIXME: the dpi setting should really depend on the BufferView
387 // (think different monitors).
389 // Zoom factor specified by user in percent
390 double const zoom = lyxrc.currentZoom / 100.0; // [percent]
392 // DPI setting for monitor relative to 100dpi
393 double const dpizoom = lyxrc.dpi / 100.0; // [per 100dpi]
395 return support::iround(pix * zoom * dpizoom);
399 bool BufferView::isTopScreen() const
401 return 0 == d->scrollbarParameters_.min;
405 bool BufferView::isBottomScreen() const
407 return 0 == d->scrollbarParameters_.max;
411 Intl & BufferView::getIntl()
417 Intl const & BufferView::getIntl() const
423 CoordCache & BufferView::coordCache()
425 return d->coord_cache_;
429 CoordCache const & BufferView::coordCache() const
431 return d->coord_cache_;
435 MathRow const & BufferView::mathRow(MathData const * cell) const
437 auto it = d->math_rows_.find(cell);
438 LATTEST(it != d->math_rows_.end());
443 void BufferView::setMathRow(MathData const * cell, MathRow const & mrow)
445 d->math_rows_[cell] = mrow;
449 Buffer & BufferView::buffer()
455 Buffer const & BufferView::buffer() const
461 bool BufferView::needsFitCursor() const
463 if (cursorStatus(d->cursor_) == CUR_INSIDE) {
464 frontend::FontMetrics const & fm =
465 theFontMetrics(d->cursor_.getFont().fontInfo());
466 int const asc = fm.maxAscent();
467 int const des = fm.maxDescent();
468 Point const p = getPos(d->cursor_);
469 if (p.y_ - asc >= 0 && p.y_ + des < height_)
478 // this is for debugging only.
479 string flagsAsString(Update::flags flags)
481 if (flags == Update::None)
483 return string((flags & Update::FitCursor) ? "FitCursor " : "")
484 + ((flags & Update::Force) ? "Force " : "")
485 + ((flags & Update::ForceDraw) ? "ForceDraw " : "")
486 + ((flags & Update::SinglePar) ? "SinglePar " : "")
487 + ((flags & Update::Decoration) ? "Decoration " : "");
492 void BufferView::processUpdateFlags(Update::flags flags)
494 LYXERR(Debug::PAINTING, "BufferView::processUpdateFlags( "
495 << flagsAsString(flags) << ") buffer: " << &buffer_);
497 // Case when no explicit update is requested.
498 if (flags == Update::None)
501 /* FIXME We would like to avoid doing this here, since it is very
502 * expensive and is called in updateBuffer already. However, even
503 * inserting a plain character can invalidate the overly fragile
504 * tables of child documents built by updateMacros. Some work is
505 * needed to avoid doing that when not necessary.
507 buffer_.updateMacros();
509 // First check whether the metrics and inset positions should be updated
510 if (flags & Update::Force) {
511 // This will update the CoordCache items and replace Force
512 // with ForceDraw in flags.
513 updateMetrics(flags);
516 // Detect whether we can only repaint a single paragraph (if we
517 // are not already redrawing all).
518 // We handle this before FitCursor because the later will require
519 // correct metrics at cursor position.
520 if (!(flags & Update::ForceDraw)
521 && (flags & Update::SinglePar)
522 && !singleParUpdate())
523 updateMetrics(flags);
525 // Then make sure that the screen contains the cursor if needed
526 if (flags & Update::FitCursor) {
527 if (needsFitCursor()) {
528 // First try to make the selection start visible
529 // (which is just the cursor when there is no selection)
530 scrollToCursor(d->cursor_.selectionBegin(), false);
531 // Metrics have to be recomputed (maybe again)
533 // Is the cursor visible? (only useful if cursor is at end of selection)
534 if (needsFitCursor()) {
535 // then try to make cursor visible instead
536 scrollToCursor(d->cursor_, false);
537 // Metrics have to be recomputed (maybe again)
538 updateMetrics(flags);
541 flags = flags & ~Update::FitCursor;
544 // Add flags to the the update flags. These will be reset to None
545 // after the redraw is actually done
546 d->update_flags_ = d->update_flags_ | flags;
547 LYXERR(Debug::PAINTING, "Cumulative flags: " << flagsAsString(flags));
549 // Now compute the update strategy
550 // Possibly values in flag are None, SinglePar, Decoration, ForceDraw
551 LATTEST((d->update_flags_ & ~(Update::None | Update::SinglePar
552 | Update::Decoration | Update::ForceDraw)) == 0);
554 if (d->update_flags_ & Update::ForceDraw)
555 d->update_strategy_ = FullScreenUpdate;
556 else if (d->update_flags_ & Update::Decoration)
557 d->update_strategy_ = DecorationUpdate;
558 else if (d->update_flags_ & Update::SinglePar)
559 d->update_strategy_ = SingleParUpdate;
561 // no need to redraw anything.
562 d->update_strategy_ = NoScreenUpdate;
565 updateHoveredInset();
568 buffer_.changed(false);
572 void BufferView::updateScrollbar()
574 if (height_ == 0 && width_ == 0)
577 // We prefer fixed size line scrolling.
578 d->scrollbarParameters_.single_step = defaultRowHeight();
579 // We prefer full screen page scrolling.
580 d->scrollbarParameters_.page_step = height_;
582 Text & t = buffer_.text();
583 TextMetrics & tm = d->text_metrics_[&t];
585 LYXERR(Debug::GUI, " Updating scrollbar: height: "
586 << t.paragraphs().size()
587 << " curr par: " << d->cursor_.bottom().pit()
588 << " default height " << defaultRowHeight());
590 size_t const parsize = t.paragraphs().size();
591 if (d->par_height_.size() != parsize) {
592 d->par_height_.clear();
593 // FIXME: We assume a default paragraph height of 2 rows. This
594 // should probably be pondered with the screen width.
595 d->par_height_.resize(parsize, defaultRowHeight() * 2);
598 // Look at paragraph heights on-screen
599 pair<pit_type, ParagraphMetrics const *> first = tm.first();
600 pair<pit_type, ParagraphMetrics const *> last = tm.last();
601 for (pit_type pit = first.first; pit <= last.first; ++pit) {
602 d->par_height_[pit] = tm.parMetrics(pit).height();
603 LYXERR(Debug::SCROLLING, "storing height for pit " << pit << " : "
604 << d->par_height_[pit]);
607 int top_pos = first.second->position() - first.second->ascent();
608 int bottom_pos = last.second->position() + last.second->descent();
609 bool first_visible = first.first == 0 && top_pos >= 0;
610 bool last_visible = last.first + 1 == int(parsize) && bottom_pos <= height_;
611 if (first_visible && last_visible) {
612 d->scrollbarParameters_.min = 0;
613 d->scrollbarParameters_.max = 0;
617 d->scrollbarParameters_.min = top_pos;
618 for (size_t i = 0; i != size_t(first.first); ++i)
619 d->scrollbarParameters_.min -= d->par_height_[i];
620 d->scrollbarParameters_.max = bottom_pos;
621 for (size_t i = last.first + 1; i != parsize; ++i)
622 d->scrollbarParameters_.max += d->par_height_[i];
624 // The reference is the top position so we remove one page.
625 if (lyxrc.scroll_below_document)
626 d->scrollbarParameters_.max -= minVisiblePart();
628 d->scrollbarParameters_.max -= d->scrollbarParameters_.page_step;
630 // 0 must be inside the range as it denotes the current position
631 if (d->scrollbarParameters_.max < 0)
632 d->scrollbarParameters_.max = 0;
633 if (d->scrollbarParameters_.min > 0)
634 d->scrollbarParameters_.min = 0;
638 ScrollbarParameters const & BufferView::scrollbarParameters() const
640 return d->scrollbarParameters_;
644 docstring BufferView::toolTip(int x, int y) const
646 // Get inset under mouse, if there is one.
647 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
649 // No inset, no tooltip...
651 return covering_inset->toolTip(*this, x, y);
655 string BufferView::contextMenu(int x, int y) const
657 //If there is a selection, return the containing inset menu
658 if (d->cursor_.selection())
659 return d->cursor_.inset().contextMenu(*this, x, y);
661 // Get inset under mouse, if there is one.
662 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
664 return covering_inset->contextMenu(*this, x, y);
666 return buffer_.inset().contextMenu(*this, x, y);
671 void BufferView::scrollDocView(int const value, bool update)
673 // The scrollbar values are relative to the top of the screen, therefore the
674 // offset is equal to the target value.
676 // No scrolling at all? No need to redraw anything
680 // If the offset is less than 2 screen height, prefer to scroll instead.
681 if (abs(value) <= 2 * height_) {
682 d->anchor_ypos_ -= value;
683 processUpdateFlags(Update::Force);
687 // cut off at the top
688 if (value <= d->scrollbarParameters_.min) {
689 DocIterator dit = doc_iterator_begin(&buffer_);
690 showCursor(dit, false, update);
691 LYXERR(Debug::SCROLLING, "scroll to top");
695 // cut off at the bottom
696 if (value >= d->scrollbarParameters_.max) {
697 DocIterator dit = doc_iterator_end(&buffer_);
699 showCursor(dit, false, update);
700 LYXERR(Debug::SCROLLING, "scroll to bottom");
704 // find paragraph at target position
705 int par_pos = d->scrollbarParameters_.min;
707 for (; i != int(d->par_height_.size()); ++i) {
708 par_pos += d->par_height_[i];
709 if (par_pos >= value)
713 if (par_pos < value) {
714 // It seems we didn't find the correct pit so stay on the safe side and
716 LYXERR0("scrolling position not found!");
717 scrollDocView(d->scrollbarParameters_.max, update);
721 DocIterator dit = doc_iterator_begin(&buffer_);
723 LYXERR(Debug::SCROLLING, "value = " << value << " -> scroll to pit " << i);
724 showCursor(dit, false, update);
728 // FIXME: this method is not working well.
729 void BufferView::setCursorFromScrollbar()
731 TextMetrics & tm = d->text_metrics_[&buffer_.text()];
733 int const height = 2 * defaultRowHeight();
734 int const first = height;
735 int const last = height_ - height;
737 Cursor const & oldcur = d->cursor_;
739 switch (cursorStatus(oldcur)) {
747 int const y = getPos(oldcur).y_;
748 newy = min(last, max(y, first));
752 // We reset the cursor because cursorStatus() does not
753 // work when the cursor is within mathed.
756 tm.setCursorFromCoordinates(cur, 0, newy);
758 // update the bufferview cursor and notify insets
759 // FIXME: Care about the d->cursor_ flags to redraw if needed
760 Cursor old = d->cursor_;
762 // the DEPM call in mouseSetCursor() might have destroyed the
763 // paragraph the cursor is in.
764 bool badcursor = old.fixIfBroken();
765 badcursor |= notifyCursorLeavesOrEnters(old, d->cursor_);
767 d->cursor_.fixIfBroken();
771 Change const BufferView::getCurrentChange() const
773 if (!d->cursor_.selection())
774 return Change(Change::UNCHANGED);
776 DocIterator dit = d->cursor_.selectionBegin();
777 // The selected content might have been changed (see #7685)
778 dit = dit.getInnerText();
779 return dit.paragraph().lookupChange(dit.pos());
783 // this could be used elsewhere as well?
784 // FIXME: This does not work within mathed!
785 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
787 Point const p = getPos(dit);
790 if (p.y_ > workHeight())
796 void BufferView::bookmarkEditPosition()
798 // Don't eat cpu time for each keystroke
799 if (d->cursor_.paragraph().id() == d->bookmark_edit_position_)
802 d->bookmark_edit_position_ = d->cursor_.paragraph().id();
806 void BufferView::saveBookmark(unsigned int idx)
808 // tentatively save bookmark, id and pos will be used to
809 // acturately locate a bookmark in a 'live' lyx session.
810 // pit and pos will be updated with bottom level pit/pos
812 if (!buffer_.isInternal()) {
813 theSession().bookmarks().save(
815 d->cursor_.bottom().pit(),
816 d->cursor_.bottom().pos(),
817 d->cursor_.paragraph().id(),
822 // emit message signal.
823 message(_("Save bookmark"));
828 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
829 int top_id, pos_type top_pos)
831 bool success = false;
834 d->cursor_.clearSelection();
836 // if a valid par_id is given, try it first
837 // This is the case for a 'live' bookmark when unique paragraph ID
838 // is used to track bookmarks.
840 dit = buffer_.getParFromID(top_id);
842 dit.pos() = min(dit.paragraph().size(), top_pos);
843 // Some slices of the iterator may not be
844 // reachable (e.g. closed collapsible inset)
845 // so the dociterator may need to be
846 // shortened. Otherwise, setCursor may crash
847 // lyx when the cursor can not be set to these
849 size_t const n = dit.depth();
850 for (size_t i = 0; i < n; ++i)
851 if (!dit[i].inset().editable()) {
859 // if top_id == 0, or searching through top_id failed
860 // This is the case for a 'restored' bookmark when only bottom
861 // (document level) pit was saved. Because of this, bookmark
862 // restoration is inaccurate. If a bookmark was within an inset,
863 // it will be restored to the left of the outmost inset that contains
865 if (bottom_pit < int(buffer_.paragraphs().size())) {
866 dit = doc_iterator_begin(&buffer_);
868 dit.pit() = bottom_pit;
869 dit.pos() = min(bottom_pos, dit.paragraph().size());
874 // Note: only bottom (document) level pit is set.
876 // set the current font.
877 d->cursor_.setCurrentFont();
878 // Do not forget to reset the anchor (see #9912)
879 d->cursor_.resetAnchor();
880 processUpdateFlags(Update::Force | Update::FitCursor);
887 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
889 if (d->cursor_.real_current_font.isRightToLeft()) {
890 if (d->intl_.keymap == Intl::PRIMARY)
891 d->intl_.keyMapSec();
893 if (d->intl_.keymap == Intl::SECONDARY)
894 d->intl_.keyMapPrim();
897 d->intl_.getTransManager().translateAndInsert(c, t, cur);
901 int BufferView::workWidth() const
907 void BufferView::recenter()
909 showCursor(d->cursor_, true, true);
913 void BufferView::showCursor()
915 showCursor(d->cursor_, false, true);
919 void BufferView::showCursor(DocIterator const & dit,
920 bool recenter, bool update)
922 if (scrollToCursor(dit, recenter) && update)
923 processUpdateFlags(Update::Force);
927 void BufferView::scrollToCursor()
929 if (scrollToCursor(d->cursor_, false))
930 processUpdateFlags(Update::Force);
934 bool BufferView::scrollToCursor(DocIterator const & dit, bool const recenter)
936 // We are not properly started yet, delay until resizing is
941 LYXERR(Debug::SCROLLING, "recentering!");
943 CursorSlice const & bot = dit.bottom();
944 TextMetrics & tm = d->text_metrics_[bot.text()];
946 pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
947 int bot_pit = bot.pit();
948 if (bot_pit > max_pit) {
949 // FIXME: Why does this happen?
950 LYXERR0("bottom pit is greater that max pit: "
951 << bot_pit << " > " << max_pit);
955 if (bot_pit == tm.first().first - 1)
956 tm.newParMetricsUp();
957 else if (bot_pit == tm.last().first + 1)
958 tm.newParMetricsDown();
960 if (tm.contains(bot_pit)) {
961 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
962 LBUFERR(!pm.rows().empty());
963 // FIXME: smooth scrolling doesn't work in mathed.
964 CursorSlice const & cs = dit.innerTextSlice();
965 int offset = coordOffset(dit).y_;
966 int ypos = pm.position() + offset;
967 Dimension const & row_dim =
968 pm.getRow(cs.pos(), dit.boundary()).dim();
971 scrolled = scroll(ypos - height_/2);
973 // We try to visualize the whole row, if the row height is larger than
974 // the screen height, we scroll to a heuristic value of height_ / 4.
975 // FIXME: This heuristic value should be replaced by a recursive search
976 // for a row in the inset that can be visualized completely.
977 else if (row_dim.height() > height_) {
978 if (ypos < defaultRowHeight())
979 scrolled = scroll(ypos - height_ / 4);
980 else if (ypos > height_ - defaultRowHeight())
981 scrolled = scroll(ypos - 3 * height_ / 4);
984 // If the top part of the row falls of the screen, we scroll
985 // up to align the top of the row with the top of the screen.
986 else if (ypos - row_dim.ascent() < 0 && ypos < height_) {
987 int ynew = row_dim.ascent();
988 scrolled = scrollUp(ynew - ypos);
991 // If the bottom of the row falls of the screen, we scroll down.
992 else if (ypos + row_dim.descent() > height_ && ypos > 0) {
993 int ynew = height_ - row_dim.descent();
994 scrolled = scrollDown(ypos - ynew);
997 // else, nothing to do, the cursor is already visible so we just return.
998 return scrolled != 0;
1001 // fix inline completion position
1002 if (d->inlineCompletionPos_.fixIfBroken())
1003 d->inlineCompletionPos_ = DocIterator();
1005 tm.redoParagraph(bot_pit);
1006 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
1007 int offset = coordOffset(dit).y_;
1009 d->anchor_pit_ = bot_pit;
1010 CursorSlice const & cs = dit.innerTextSlice();
1011 Dimension const & row_dim =
1012 pm.getRow(cs.pos(), dit.boundary()).dim();
1015 d->anchor_ypos_ = height_/2;
1016 else if (d->anchor_pit_ == 0)
1017 d->anchor_ypos_ = offset + pm.ascent();
1018 else if (d->anchor_pit_ == max_pit)
1019 d->anchor_ypos_ = height_ - offset - row_dim.descent();
1020 else if (offset > height_)
1021 d->anchor_ypos_ = height_ - offset - defaultRowHeight();
1023 d->anchor_ypos_ = defaultRowHeight() * 2;
1029 void BufferView::makeDocumentClass()
1031 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1032 buffer_.params().makeDocumentClass();
1033 updateDocumentClass(olddc);
1037 void BufferView::updateDocumentClass(DocumentClassConstPtr olddc)
1039 message(_("Converting document to new document class..."));
1041 StableDocIterator backcur(d->cursor_);
1042 ErrorList & el = buffer_.errorList("Class Switch");
1043 cap::switchBetweenClasses(
1044 olddc, buffer_.params().documentClassPtr(),
1045 static_cast<InsetText &>(buffer_.inset()), el);
1047 setCursor(backcur.asDocIterator(&buffer_));
1049 buffer_.errors("Class Switch");
1053 /** Return the change status at cursor position, taking into account the
1054 * status at each level of the document iterator (a table in a deleted
1055 * footnote is deleted).
1056 * When \param outer is true, the top slice is not looked at.
1058 static Change::Type lookupChangeType(DocIterator const & dit, bool outer = false)
1060 size_t const depth = dit.depth() - (outer ? 1 : 0);
1062 for (size_t i = 0 ; i < depth ; ++i) {
1063 CursorSlice const & slice = dit[i];
1064 if (!slice.inset().inMathed()
1065 && slice.pos() < slice.paragraph().size()) {
1066 Change::Type const ch = slice.paragraph().lookupChange(slice.pos()).type;
1067 if (ch != Change::UNCHANGED)
1071 return Change::UNCHANGED;
1075 bool BufferView::getStatus(FuncRequest const & cmd, FuncStatus & flag)
1077 FuncCode const act = cmd.action();
1079 // Can we use a readonly buffer?
1080 if (buffer_.isReadonly()
1081 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1082 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1083 if (buffer_.hasReadonlyFlag())
1084 flag.message(from_utf8(N_("Document is read-only")));
1086 flag.message(from_utf8(N_("Document has been modified externally")));
1087 flag.setEnabled(false);
1091 // Are we in a DELETED change-tracking region?
1092 if (lookupChangeType(d->cursor_, true) == Change::DELETED
1093 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1094 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1095 flag.message(from_utf8(N_("This portion of the document is deleted.")));
1096 flag.setEnabled(false);
1100 Cursor & cur = d->cursor_;
1102 if (cur.getStatus(cmd, flag))
1107 // FIXME: This is a bit problematic because we don't check if this is
1108 // a document BufferView or not for these LFUNs. We probably have to
1109 // dispatch both to currentBufferView() and, if that fails,
1110 // to documentBufferView(); same as we do now for current Buffer and
1111 // document Buffer. Ideally those LFUN should go to Buffer as they
1112 // operate on the full Buffer and the cursor is only needed either for
1113 // an Undo record or to restore a cursor position. But we don't know
1114 // how to do that inside Buffer of course.
1115 case LFUN_BUFFER_PARAMS_APPLY:
1116 case LFUN_LAYOUT_MODULES_CLEAR:
1117 case LFUN_LAYOUT_MODULE_ADD:
1118 case LFUN_LAYOUT_RELOAD:
1119 case LFUN_TEXTCLASS_APPLY:
1120 case LFUN_TEXTCLASS_LOAD:
1121 flag.setEnabled(!buffer_.isReadonly());
1125 // We do not use the LyXAction flag for readonly because Undo sets the
1126 // buffer clean/dirty status by itself.
1127 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasUndoStack());
1130 // We do not use the LyXAction flag for readonly because Redo sets the
1131 // buffer clean/dirty status by itself.
1132 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasRedoStack());
1134 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
1135 case LFUN_FILE_INSERT_PLAINTEXT: {
1136 docstring const fname = cmd.argument();
1137 if (!FileName::isAbsolute(to_utf8(fname))) {
1138 flag.message(_("Absolute filename expected."));
1141 flag.setEnabled(cur.inTexted());
1144 case LFUN_FILE_INSERT:
1145 case LFUN_BOOKMARK_SAVE:
1146 // FIXME: Actually, these LFUNS should be moved to Text
1147 flag.setEnabled(cur.inTexted());
1150 case LFUN_FONT_STATE:
1151 case LFUN_LABEL_INSERT:
1152 case LFUN_INFO_INSERT:
1153 case LFUN_PARAGRAPH_GOTO:
1154 case LFUN_NOTE_NEXT:
1155 case LFUN_REFERENCE_NEXT:
1156 case LFUN_WORD_FIND:
1157 case LFUN_WORD_FIND_FORWARD:
1158 case LFUN_WORD_FIND_BACKWARD:
1159 case LFUN_WORD_REPLACE:
1162 case LFUN_MARK_TOGGLE:
1163 case LFUN_SCREEN_RECENTER:
1164 case LFUN_SCREEN_SHOW_CURSOR:
1165 case LFUN_BIBTEX_DATABASE_ADD:
1166 case LFUN_BIBTEX_DATABASE_DEL:
1167 case LFUN_STATISTICS:
1168 case LFUN_KEYMAP_OFF:
1169 case LFUN_KEYMAP_PRIMARY:
1170 case LFUN_KEYMAP_SECONDARY:
1171 case LFUN_KEYMAP_TOGGLE:
1172 case LFUN_INSET_SELECT_ALL:
1173 flag.setEnabled(true);
1176 case LFUN_GRAPHICS_UNIFY:
1177 flag.setEnabled(cur.countInsetsInSelection(GRAPHICS_CODE)>1);
1180 case LFUN_WORD_FINDADV: {
1181 FindAndReplaceOptions opt;
1182 istringstream iss(to_utf8(cmd.argument()));
1184 flag.setEnabled(opt.repl_buf_name.empty()
1185 || !buffer_.isReadonly());
1189 case LFUN_LABEL_GOTO:
1190 flag.setEnabled(!cmd.argument().empty()
1191 || getInsetByCode<InsetRef>(cur, REF_CODE));
1194 case LFUN_CHANGES_MERGE:
1195 case LFUN_CHANGE_NEXT:
1196 case LFUN_CHANGE_PREVIOUS:
1197 case LFUN_ALL_CHANGES_ACCEPT:
1198 case LFUN_ALL_CHANGES_REJECT:
1199 flag.setEnabled(buffer_.areChangesPresent());
1202 case LFUN_SCREEN_UP:
1203 case LFUN_SCREEN_DOWN:
1205 case LFUN_SCREEN_UP_SELECT:
1206 case LFUN_SCREEN_DOWN_SELECT:
1207 case LFUN_INSET_FORALL:
1208 flag.setEnabled(true);
1211 case LFUN_LAYOUT_TABULAR:
1212 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
1216 flag.setEnabled(!cur.inset().forcePlainLayout(cur.idx()));
1219 case LFUN_LAYOUT_PARAGRAPH:
1220 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
1223 case LFUN_BRANCH_ADD_INSERT:
1224 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1227 case LFUN_DIALOG_SHOW_NEW_INSET:
1228 // FIXME: this is wrong, but I do not understand the
1230 if (cur.inset().lyxCode() == CAPTION_CODE)
1231 return cur.inset().getStatus(cur, cmd, flag);
1232 // FIXME we should consider passthru paragraphs too.
1233 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1236 case LFUN_CITATION_INSERT: {
1237 FuncRequest fr(LFUN_INSET_INSERT, "citation");
1238 // FIXME: This could turn in a recursive hell.
1239 // Shouldn't we use Buffer::getStatus() instead?
1240 flag.setEnabled(lyx::getStatus(fr).enabled());
1243 case LFUN_INSET_APPLY: {
1244 string const name = cmd.getArg(0);
1245 Inset * inset = editedInset(name);
1247 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1248 if (!inset->getStatus(cur, fr, flag)) {
1249 // Every inset is supposed to handle this
1250 LASSERT(false, break);
1253 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1254 flag = lyx::getStatus(fr);
1267 Inset * BufferView::editedInset(string const & name) const
1269 map<string, Inset *>::const_iterator it = d->edited_insets_.find(name);
1270 return it == d->edited_insets_.end() ? nullptr : it->second;
1274 void BufferView::editInset(string const & name, Inset * inset)
1277 d->edited_insets_[name] = inset;
1279 d->edited_insets_.erase(name);
1283 void BufferView::dispatch(FuncRequest const & cmd, DispatchResult & dr)
1285 LYXERR(Debug::ACTION, "BufferView::dispatch: cmd: " << cmd);
1287 string const argument = to_utf8(cmd.argument());
1288 Cursor & cur = d->cursor_;
1291 // Don't dispatch function that does not apply to internal buffers.
1292 if (buffer_.isInternal()
1293 && lyxaction.funcHasFlag(cmd.action(), LyXAction::NoInternal))
1296 // We'll set this back to false if need be.
1297 bool dispatched = true;
1298 buffer_.undo().beginUndoGroup();
1300 FuncCode const act = cmd.action();
1303 case LFUN_BUFFER_PARAMS_APPLY: {
1304 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1305 cur.recordUndoBufferParams();
1306 istringstream ss(to_utf8(cmd.argument()));
1309 int const unknown_tokens = buffer_.readHeader(lex);
1310 if (unknown_tokens != 0) {
1311 LYXERR0("Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1312 << unknown_tokens << " unknown token"
1313 << (unknown_tokens == 1 ? "" : "s"));
1315 updateDocumentClass(olddc);
1317 // We are most certainly here because of a change in the document
1318 // It is then better to make sure that all dialogs are in sync with
1319 // current document settings.
1320 dr.screenUpdate(Update::Force | Update::FitCursor);
1321 dr.forceBufferUpdate();
1325 case LFUN_LAYOUT_MODULES_CLEAR: {
1326 // FIXME: this modifies the document in cap::switchBetweenClasses
1327 // without calling recordUndo. Fix this before using
1328 // recordUndoBufferParams().
1329 cur.recordUndoFullBuffer();
1330 buffer_.params().clearLayoutModules();
1331 makeDocumentClass();
1332 dr.screenUpdate(Update::Force);
1333 dr.forceBufferUpdate();
1337 case LFUN_LAYOUT_MODULE_ADD: {
1338 BufferParams const & params = buffer_.params();
1339 if (!params.layoutModuleCanBeAdded(argument)) {
1340 LYXERR0("Module `" << argument <<
1341 "' cannot be added due to failed requirements or "
1342 "conflicts with installed modules.");
1345 // FIXME: this modifies the document in cap::switchBetweenClasses
1346 // without calling recordUndo. Fix this before using
1347 // recordUndoBufferParams().
1348 cur.recordUndoFullBuffer();
1349 buffer_.params().addLayoutModule(argument);
1350 makeDocumentClass();
1351 dr.screenUpdate(Update::Force);
1352 dr.forceBufferUpdate();
1356 case LFUN_TEXTCLASS_APPLY: {
1357 // since this shortcircuits, the second call is made only if
1359 bool const success =
1360 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1361 LayoutFileList::get().load(argument, buffer_.filePath());
1363 docstring s = bformat(_("The document class `%1$s' "
1364 "could not be loaded."), from_utf8(argument));
1365 frontend::Alert::error(_("Could not load class"), s);
1369 LayoutFile const * old_layout = buffer_.params().baseClass();
1370 LayoutFile const * new_layout = &(LayoutFileList::get()[argument]);
1372 if (old_layout == new_layout)
1376 // Save the old, possibly modular, layout for use in conversion.
1377 // FIXME: this modifies the document in cap::switchBetweenClasses
1378 // without calling recordUndo. Fix this before using
1379 // recordUndoBufferParams().
1380 cur.recordUndoFullBuffer();
1381 buffer_.params().setBaseClass(argument, buffer_.layoutPos());
1382 makeDocumentClass();
1383 dr.screenUpdate(Update::Force);
1384 dr.forceBufferUpdate();
1388 case LFUN_TEXTCLASS_LOAD: {
1389 // since this shortcircuits, the second call is made only if
1391 bool const success =
1392 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1393 LayoutFileList::get().load(argument, buffer_.filePath());
1395 docstring s = bformat(_("The document class `%1$s' "
1396 "could not be loaded."), from_utf8(argument));
1397 frontend::Alert::error(_("Could not load class"), s);
1402 case LFUN_LAYOUT_RELOAD: {
1403 LayoutFileIndex bc = buffer_.params().baseClassID();
1404 LayoutFileList::get().reset(bc);
1405 buffer_.params().setBaseClass(bc, buffer_.layoutPos());
1406 makeDocumentClass();
1407 dr.screenUpdate(Update::Force);
1408 dr.forceBufferUpdate();
1413 dr.setMessage(_("Undo"));
1414 cur.clearSelection();
1415 // We need to find out if the bibliography information
1416 // has changed. See bug #11055.
1417 // So these should not be references...
1418 string const engine = buffer().params().citeEngine();
1419 CiteEngineType const enginetype = buffer().params().citeEngineType();
1420 if (!cur.undoAction())
1421 dr.setMessage(_("No further undo information"));
1423 dr.screenUpdate(Update::Force | Update::FitCursor);
1424 dr.forceBufferUpdate();
1425 if (buffer().params().citeEngine() != engine ||
1426 buffer().params().citeEngineType() != enginetype)
1427 buffer().invalidateCiteLabels();
1433 dr.setMessage(_("Redo"));
1434 cur.clearSelection();
1435 // We need to find out if the bibliography information
1436 // has changed. See bug #11055.
1437 // So these should not be references...
1438 string const engine = buffer().params().citeEngine();
1439 CiteEngineType const enginetype = buffer().params().citeEngineType();
1440 if (!cur.redoAction())
1441 dr.setMessage(_("No further redo information"));
1443 dr.screenUpdate(Update::Force | Update::FitCursor);
1444 dr.forceBufferUpdate();
1445 if (buffer().params().citeEngine() != engine ||
1446 buffer().params().citeEngineType() != enginetype)
1447 buffer().invalidateCiteLabels();
1452 case LFUN_FONT_STATE:
1453 dr.setMessage(cur.currentState(false));
1456 case LFUN_BOOKMARK_SAVE:
1457 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1460 case LFUN_LABEL_GOTO: {
1461 docstring label = cmd.argument();
1462 if (label.empty()) {
1464 getInsetByCode<InsetRef>(cur, REF_CODE);
1466 label = inset->getParam("reference");
1467 // persistent=false: use temp_bookmark
1471 if (!label.empty()) {
1473 // at the moment, this is redundant, since gotoLabel will
1474 // eventually call LFUN_PARAGRAPH_GOTO, but it seems best
1476 dr.screenUpdate(Update::Force | Update::FitCursor);
1481 case LFUN_PARAGRAPH_GOTO: {
1482 int const id = convert<int>(cmd.getArg(0));
1483 pos_type const pos = convert<int>(cmd.getArg(1));
1486 string const str_id_end = cmd.getArg(2);
1487 string const str_pos_end = cmd.getArg(3);
1489 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1490 b = theBufferList().next(b)) {
1493 curs.setCursor(b->getParFromID(id));
1495 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1499 LYXERR(Debug::INFO, "Paragraph " << curs.paragraph().id()
1500 << " found in buffer `"
1501 << b->absFileName() << "'.");
1503 if (b == &buffer_) {
1505 if (str_id_end.empty() || str_pos_end.empty()) {
1508 mouseSetCursor(curs);
1511 int const id_end = convert<int>(str_id_end);
1512 pos_type const pos_end = convert<int>(str_pos_end);
1513 success = setCursorFromEntries({id, pos},
1517 dr.screenUpdate(Update::Force | Update::FitCursor);
1519 // Switch to other buffer view and resend cmd
1520 lyx::dispatch(FuncRequest(
1521 LFUN_BUFFER_SWITCH, b->absFileName()));
1529 case LFUN_NOTE_NEXT:
1530 gotoInset(this, NOTE_CODE, false);
1533 case LFUN_REFERENCE_NEXT: {
1534 vector<InsetCode> tmp;
1535 tmp.push_back(LABEL_CODE);
1536 tmp.push_back(REF_CODE);
1537 gotoInset(this, tmp, true);
1541 case LFUN_CHANGE_NEXT:
1542 findNextChange(this);
1543 if (cur.inset().isTable())
1544 // In tables, there might be whole changed rows or columns
1546 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1547 dr.screenUpdate(Update::Force | Update::FitCursor);
1550 case LFUN_CHANGE_PREVIOUS:
1551 findPreviousChange(this);
1552 if (cur.inset().isTable())
1553 // In tables, there might be whole changed rows or columns
1555 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1556 dr.screenUpdate(Update::Force | Update::FitCursor);
1559 case LFUN_CHANGES_MERGE:
1560 if (findNextChange(this) || findPreviousChange(this)) {
1561 dr.screenUpdate(Update::Force | Update::FitCursor);
1562 dr.forceBufferUpdate();
1563 showDialog("changes");
1567 case LFUN_ALL_CHANGES_ACCEPT: {
1568 // select complete document
1570 cur.selHandle(true);
1571 buffer_.text().cursorBottom(cur);
1572 // accept everything in a single step to support atomic undo
1573 // temporarily disable track changes in order to end with really
1574 // no new (e.g., DPSM-caused) changes (see #7487)
1575 bool const track = buffer_.params().track_changes;
1576 buffer_.params().track_changes = false;
1577 buffer_.text().acceptOrRejectChanges(cur, Text::ACCEPT);
1578 buffer_.params().track_changes = track;
1580 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1581 dr.screenUpdate(Update::Force | Update::FitCursor);
1582 dr.forceBufferUpdate();
1586 case LFUN_ALL_CHANGES_REJECT: {
1587 // select complete document
1589 cur.selHandle(true);
1590 buffer_.text().cursorBottom(cur);
1591 // reject everything in a single step to support atomic undo
1592 // temporarily disable track changes in order to end with really
1593 // no new (e.g., DPSM-caused) changes (see #7487)
1594 bool const track = buffer_.params().track_changes;
1595 buffer_.params().track_changes = false;
1596 buffer_.text().acceptOrRejectChanges(cur, Text::REJECT);
1597 buffer_.params().track_changes = track;
1599 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1600 dr.screenUpdate(Update::Force | Update::FitCursor);
1601 dr.forceBufferUpdate();
1605 case LFUN_WORD_FIND_FORWARD:
1606 case LFUN_WORD_FIND_BACKWARD: {
1608 // Would it maybe be better if this variable were view specific anyway?
1609 static docstring last_search;
1610 docstring searched_string;
1612 if (!cmd.argument().empty()) {
1613 last_search = cmd.argument();
1614 searched_string = cmd.argument();
1616 searched_string = last_search;
1619 if (searched_string.empty())
1622 bool const fw = act == LFUN_WORD_FIND_FORWARD;
1623 docstring const data =
1624 find2string(searched_string, true, false, fw);
1625 bool found = lyxfind(this, FuncRequest(LFUN_WORD_FIND, data));
1627 dr.screenUpdate(Update::Force | Update::FitCursor);
1631 case LFUN_WORD_FIND: {
1632 FuncRequest req = cmd;
1633 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1634 req = d->search_request_cache_;
1635 if (req.argument().empty()) {
1636 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, "findreplace"));
1639 if (lyxfind(this, req))
1640 dr.screenUpdate(Update::Force | Update::FitCursor);
1642 d->search_request_cache_ = req;
1646 case LFUN_WORD_REPLACE: {
1647 bool has_deleted = false;
1648 if (cur.selection()) {
1649 DocIterator beg = cur.selectionBegin();
1650 DocIterator end = cur.selectionEnd();
1651 if (beg.pit() == end.pit()) {
1652 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1653 if (!cur.inMathed() && cur.paragraph().isDeleted(p)) {
1660 if (lyxreplace(this, cmd, has_deleted)) {
1661 dr.forceBufferUpdate();
1662 dr.screenUpdate(Update::Force | Update::FitCursor);
1667 case LFUN_WORD_FINDADV: {
1668 FindAndReplaceOptions opt;
1669 istringstream iss(to_utf8(cmd.argument()));
1671 if (findAdv(this, opt)) {
1672 dr.screenUpdate(Update::Force | Update::FitCursor);
1683 cur.clearSelection();
1684 dr.setMessage(from_utf8(N_("Mark off")));
1688 cur.clearSelection();
1690 dr.setMessage(from_utf8(N_("Mark on")));
1693 case LFUN_MARK_TOGGLE:
1694 cur.selection(false);
1697 dr.setMessage(from_utf8(N_("Mark removed")));
1700 dr.setMessage(from_utf8(N_("Mark set")));
1705 case LFUN_SCREEN_SHOW_CURSOR:
1709 case LFUN_SCREEN_RECENTER:
1713 case LFUN_BIBTEX_DATABASE_ADD: {
1714 Cursor tmpcur = cur;
1715 findInset(tmpcur, BIBTEX_CODE, false);
1716 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1719 if (inset->addDatabase(cmd.argument()))
1720 dr.forceBufferUpdate();
1725 case LFUN_BIBTEX_DATABASE_DEL: {
1726 Cursor tmpcur = cur;
1727 findInset(tmpcur, BIBTEX_CODE, false);
1728 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1731 if (inset->delDatabase(cmd.argument()))
1732 dr.forceBufferUpdate();
1737 case LFUN_GRAPHICS_UNIFY: {
1739 cur.recordUndoFullBuffer();
1741 DocIterator from, to;
1742 from = cur.selectionBegin();
1743 to = cur.selectionEnd();
1745 string const newId = cmd.getArg(0);
1746 bool fetchId = newId.empty(); //if we wait for groupId from first graphics inset
1748 InsetGraphicsParams grp_par;
1750 InsetGraphics::string2params(graphics::getGroupParams(buffer_, newId), buffer_, grp_par);
1752 if (!from.nextInset()) //move to closest inset
1753 from.forwardInset();
1755 while (!from.empty() && from < to) {
1756 Inset * inset = from.nextInset();
1759 InsetGraphics * ig = inset->asInsetGraphics();
1761 InsetGraphicsParams inspar = ig->getParams();
1766 grp_par.filename = inspar.filename;
1767 ig->setParams(grp_par);
1770 from.forwardInset();
1772 dr.screenUpdate(Update::Force); //needed if triggered from context menu
1776 case LFUN_STATISTICS: {
1777 DocIterator from, to;
1778 if (cur.selection()) {
1779 from = cur.selectionBegin();
1780 to = cur.selectionEnd();
1782 from = doc_iterator_begin(&buffer_);
1783 to = doc_iterator_end(&buffer_);
1785 buffer_.updateStatistics(from, to);
1786 int const words = buffer_.wordCount();
1787 int const chars = buffer_.charCount(false);
1788 int const chars_blanks = buffer_.charCount(true);
1790 if (cur.selection())
1791 message = _("Statistics for the selection:");
1793 message = _("Statistics for the document:");
1796 message += bformat(_("%1$d words"), words);
1798 message += _("One word");
1800 if (chars_blanks != 1)
1801 message += bformat(_("%1$d characters (including blanks)"),
1804 message += _("One character (including blanks)");
1807 message += bformat(_("%1$d characters (excluding blanks)"),
1810 message += _("One character (excluding blanks)");
1812 Alert::information(_("Statistics"), message);
1816 case LFUN_SCREEN_UP:
1817 case LFUN_SCREEN_DOWN: {
1818 Point p = getPos(cur);
1819 // This code has been commented out to enable to scroll down a
1820 // document, even if there are large insets in it (see bug #5465).
1821 /*if (p.y_ < 0 || p.y_ > height_) {
1822 // The cursor is off-screen so recenter before proceeding.
1826 int const scrolled = scroll(act == LFUN_SCREEN_UP
1827 ? -height_ : height_);
1828 if (act == LFUN_SCREEN_UP && scrolled > -height_)
1830 if (act == LFUN_SCREEN_DOWN && scrolled < height_)
1831 p = Point(width_, height_);
1832 bool const in_texted = cur.inTexted();
1833 cur.setCursor(doc_iterator_begin(cur.buffer()));
1834 cur.selHandle(false);
1835 // Force an immediate computation of metrics because we need it below
1836 processUpdateFlags(Update::Force);
1838 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_,
1839 true, act == LFUN_SCREEN_UP);
1840 //FIXME: what to do with cur.x_target()?
1841 bool update = in_texted && cur.bv().checkDepm(cur, old);
1844 if (update || cur.mark())
1845 dr.screenUpdate(Update::Force | Update::FitCursor);
1847 dr.forceBufferUpdate();
1852 string const scroll_type = cmd.getArg(0);
1853 int scroll_step = 0;
1854 if (scroll_type == "line")
1855 scroll_step = d->scrollbarParameters_.single_step;
1856 else if (scroll_type == "page")
1857 scroll_step = d->scrollbarParameters_.page_step;
1860 string const scroll_quantity = cmd.getArg(1);
1861 if (scroll_quantity == "up")
1862 scrollUp(scroll_step);
1863 else if (scroll_quantity == "down")
1864 scrollDown(scroll_step);
1866 int const scroll_value = convert<int>(scroll_quantity);
1868 scroll(scroll_step * scroll_value);
1870 dr.screenUpdate(Update::ForceDraw);
1871 dr.forceBufferUpdate();
1875 case LFUN_SCREEN_UP_SELECT: {
1876 // FIXME: why is the algorithm different from LFUN_SCREEN_UP?
1877 cur.selHandle(true);
1878 if (isTopScreen()) {
1879 lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1883 int y = getPos(cur).y_;
1884 int const ymin = y - height_ + defaultRowHeight();
1885 while (y > ymin && cur.up())
1889 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1893 case LFUN_SCREEN_DOWN_SELECT: {
1894 // FIXME: why is the algorithm different from LFUN_SCREEN_DOWN?
1895 cur.selHandle(true);
1896 if (isBottomScreen()) {
1897 lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1901 int y = getPos(cur).y_;
1902 int const ymax = y + height_ - defaultRowHeight();
1903 while (y < ymax && cur.down())
1907 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1912 case LFUN_INSET_SELECT_ALL: {
1913 // true if all cells are selected
1914 bool const all_selected = cur.depth() > 1
1915 && cur.selBegin().at_begin()
1916 && cur.selEnd().at_end();
1917 // true if some cells are selected
1918 bool const cells_selected = cur.depth() > 1
1919 && cur.selBegin().at_cell_begin()
1920 && cur.selEnd().at_cell_end();
1921 if (all_selected || (cells_selected && !cur.inset().isTable())) {
1922 // All the contents of the inset if selected, or only at
1923 // least one cell but inset is not a table.
1924 // Select the inset from outside.
1927 cur.selection(true);
1929 } else if (cells_selected) {
1930 // At least one complete cell is selected and inset is a table.
1936 cur.selection(true);
1937 cur.idx() = cur.lastidx();
1938 cur.pit() = cur.lastpit();
1939 cur.pos() = cur.lastpos();
1941 // select current cell
1945 cur.selection(true);
1946 cur.pit() = cur.lastpit();
1947 cur.pos() = cur.lastpos();
1949 cur.setCurrentFont();
1950 dr.screenUpdate(Update::Force);
1955 case LFUN_UNICODE_INSERT: {
1956 if (cmd.argument().empty())
1959 FuncCode code = cur.inset().currentMode() == Inset::MATH_MODE ?
1960 LFUN_MATH_INSERT : LFUN_SELF_INSERT;
1963 docstring const arg = from_utf8(cmd.getArg(i));
1967 LYXERR0("Not a hexstring: " << arg);
1971 char_type c = hexToInt(arg);
1972 if (c >= 32 && c < 0x10ffff) {
1973 LYXERR(Debug::KEY, "Inserting c: " << c);
1974 lyx::dispatch(FuncRequest(code, docstring(1, c)));
1982 // This would be in Buffer class if only Cursor did not
1983 // require a bufferview
1984 case LFUN_INSET_FORALL: {
1985 docstring const name = from_utf8(cmd.getArg(0));
1986 string const commandstr = cmd.getLongArg(1);
1987 FuncRequest const fr = lyxaction.lookupFunc(commandstr);
1989 // an arbitrary number to limit number of iterations
1990 const int max_iter = 100000;
1992 Cursor & curs = d->cursor_;
1993 Cursor const savecur = curs;
1995 if (!curs.nextInset())
1996 curs.forwardInset();
1997 curs.beginUndoGroup();
1998 while(curs && iterations < max_iter) {
1999 Inset * const ins = curs.nextInset();
2002 docstring insname = ins->layoutName();
2003 while (!insname.empty()) {
2004 if (insname == name || name == from_utf8("*")) {
2006 lyx::dispatch(fr, dr);
2010 size_t const i = insname.rfind(':');
2011 if (i == string::npos)
2013 insname = insname.substr(0, i);
2015 // if we did not delete the inset, skip it
2016 if (!curs.nextInset() || curs.nextInset() == ins)
2017 curs.forwardInset();
2021 /** This is a dummy undo record only to remember the cursor
2022 * that has just been set; this will be used on a redo action
2023 * (see ticket #10097)
2025 * FIXME: a better fix would be to have a way to set the
2026 * cursor value directly, but I am not sure it is worth it.
2029 curs.endUndoGroup();
2030 dr.screenUpdate(Update::Force);
2031 dr.forceBufferUpdate();
2033 if (iterations >= max_iter) {
2035 dr.setMessage(bformat(_("`inset-forall' interrupted because number of actions is larger than %1$d"), max_iter));
2037 dr.setMessage(bformat(_("Applied \"%1$s\" to %2$d insets"), from_utf8(commandstr), iterations));
2042 case LFUN_BRANCH_ADD_INSERT: {
2043 docstring branch_name = from_utf8(cmd.getArg(0));
2044 if (branch_name.empty())
2045 if (!Alert::askForText(branch_name, _("Branch name")) ||
2046 branch_name.empty())
2049 DispatchResult drtmp;
2050 buffer_.dispatch(FuncRequest(LFUN_BRANCH_ADD, branch_name), drtmp);
2051 if (drtmp.error()) {
2052 Alert::warning(_("Branch already exists"), drtmp.message());
2055 docstring const sep = buffer_.params().branchlist().separator();
2056 for (docstring const & branch : getVectorFromString(branch_name, sep))
2057 lyx::dispatch(FuncRequest(LFUN_BRANCH_INSERT, branch));
2061 case LFUN_KEYMAP_OFF:
2062 getIntl().keyMapOn(false);
2065 case LFUN_KEYMAP_PRIMARY:
2066 getIntl().keyMapPrim();
2069 case LFUN_KEYMAP_SECONDARY:
2070 getIntl().keyMapSec();
2073 case LFUN_KEYMAP_TOGGLE:
2074 getIntl().toggleKeyMap();
2077 case LFUN_DIALOG_SHOW_NEW_INSET: {
2078 string const name = cmd.getArg(0);
2079 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
2080 if (decodeInsetParam(name, data, buffer_))
2081 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
2083 lyxerr << "Inset type '" << name <<
2084 "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" << endl;
2088 case LFUN_CITATION_INSERT: {
2089 if (argument.empty()) {
2090 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
2093 // we can have one optional argument, delimited by '|'
2094 // citation-insert <key>|<text_before>
2095 // this should be enhanced to also support text_after
2096 // and citation style
2097 string arg = argument;
2099 if (contains(argument, "|")) {
2100 arg = token(argument, '|', 0);
2101 opt1 = token(argument, '|', 1);
2104 // if our cursor is directly in front of or behind a citation inset,
2105 // we will instead add the new key to it.
2106 Inset * inset = cur.nextInset();
2107 if (!inset || inset->lyxCode() != CITE_CODE)
2108 inset = cur.prevInset();
2109 if (inset && inset->lyxCode() == CITE_CODE) {
2110 InsetCitation * icite = static_cast<InsetCitation *>(inset);
2111 if (icite->addKey(arg)) {
2112 dr.forceBufferUpdate();
2113 dr.screenUpdate(Update::FitCursor | Update::SinglePar);
2115 LYXERR0("Discarding optional argument to citation-insert.");
2120 InsetCommandParams icp(CITE_CODE);
2121 icp["key"] = from_utf8(arg);
2123 icp["before"] = from_utf8(opt1);
2125 from_ascii(InsetCitation::last_literal ? "true" : "false");
2126 string icstr = InsetCommand::params2string(icp);
2127 FuncRequest fr(LFUN_INSET_INSERT, icstr);
2132 case LFUN_INSET_APPLY: {
2133 string const name = cmd.getArg(0);
2134 Inset * inset = editedInset(name);
2136 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
2140 // put cursor in front of inset.
2141 if (!setCursorFromInset(inset)) {
2142 LASSERT(false, break);
2145 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
2146 inset->dispatch(cur, fr);
2147 dr.screenUpdate(cur.result().screenUpdate());
2148 if (cur.result().needBufferUpdate())
2149 dr.forceBufferUpdate();
2154 // The change of language of buffer belongs to the Buffer class.
2155 // We have to do it here because we need a cursor for Undo.
2156 // When Undo::recordUndoBufferParams() is implemented someday
2157 // LFUN_BUFFER_LANGUAGE should be handled by the Buffer class.
2158 case LFUN_BUFFER_LANGUAGE: {
2159 Language const * oldL = buffer_.params().language;
2160 Language const * newL = languages.getLanguage(argument);
2161 if (!newL || oldL == newL)
2163 if (oldL->rightToLeft() == newL->rightToLeft()) {
2164 cur.recordUndoFullBuffer();
2165 buffer_.changeLanguage(oldL, newL);
2166 cur.setCurrentFont();
2167 dr.forceBufferUpdate();
2172 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
2173 case LFUN_FILE_INSERT_PLAINTEXT: {
2174 bool const as_paragraph = (act == LFUN_FILE_INSERT_PLAINTEXT_PARA);
2175 string const fname = to_utf8(cmd.argument());
2176 if (!FileName::isAbsolute(fname))
2177 dr.setMessage(_("Absolute filename expected."));
2179 insertPlaintextFile(FileName(fname), as_paragraph);
2184 // OK, so try the Buffer itself...
2185 buffer_.dispatch(cmd, dr);
2186 dispatched = dr.dispatched();
2190 buffer_.undo().endUndoGroup();
2191 dr.dispatched(dispatched);
2193 // NOTE: The code below is copied from Cursor::dispatch. If you
2194 // need to modify this, please update the other one too.
2196 // notify insets we just entered/left
2197 if (cursor() != old) {
2198 old.beginUndoGroup();
2200 bool badcursor = notifyCursorLeavesOrEnters(old, cursor());
2202 cursor().fixIfBroken();
2203 resetInlineCompletionPos();
2210 docstring BufferView::requestSelection()
2212 Cursor & cur = d->cursor_;
2214 LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
2215 if (!cur.selection()) {
2216 d->xsel_cache_.set = false;
2220 LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
2221 if (!d->xsel_cache_.set ||
2222 cur.top() != d->xsel_cache_.cursor ||
2223 cur.realAnchor().top() != d->xsel_cache_.anchor)
2225 d->xsel_cache_.cursor = cur.top();
2226 d->xsel_cache_.anchor = cur.realAnchor().top();
2227 d->xsel_cache_.set = cur.selection();
2228 return cur.selectionAsString(false);
2234 void BufferView::clearSelection()
2236 d->cursor_.clearSelection();
2237 // Clear the selection buffer. Otherwise a subsequent
2238 // middle-mouse-button paste would use the selection buffer,
2239 // not the more current external selection.
2240 cap::clearSelection();
2241 d->xsel_cache_.set = false;
2242 // The buffer did not really change, but this causes the
2243 // redraw we need because we cleared the selection above.
2244 buffer_.changed(false);
2248 void BufferView::resize(int width, int height)
2250 // Update from work area
2254 // Clear the paragraph height cache.
2255 d->par_height_.clear();
2256 // Redo the metrics.
2261 Inset const * BufferView::getCoveringInset(Text const & text,
2264 TextMetrics & tm = d->text_metrics_[&text];
2265 Inset * inset = tm.checkInsetHit(x, y);
2269 if (!inset->descendable(*this))
2270 // No need to go further down if the inset is not
2274 size_t cell_number = inset->nargs();
2275 // Check all the inner cell.
2276 for (size_t i = 0; i != cell_number; ++i) {
2277 Text const * inner_text = inset->getText(i);
2280 Inset const * inset_deeper =
2281 getCoveringInset(*inner_text, x, y);
2283 return inset_deeper;
2291 void BufferView::updateHoveredInset() const
2293 // Get inset under mouse, if there is one.
2294 int const x = d->mouse_position_cache_.x_;
2295 int const y = d->mouse_position_cache_.y_;
2296 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
2298 d->clickable_inset_ = covering_inset && covering_inset->clickable(*this, x, y);
2300 if (covering_inset == d->last_inset_)
2301 // Same inset, no need to do anything...
2304 bool need_redraw = false;
2305 if (d->last_inset_) {
2306 // Remove the hint on the last hovered inset (if any).
2307 need_redraw |= d->last_inset_->setMouseHover(this, false);
2308 d->last_inset_ = nullptr;
2311 if (covering_inset && covering_inset->setMouseHover(this, true)) {
2313 // Only the insets that accept the hover state, do
2314 // clear the last_inset_, so only set the last_inset_
2315 // member if the hovered setting is accepted.
2316 d->last_inset_ = covering_inset;
2320 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
2321 << d->mouse_position_cache_.x_ << ", "
2322 << d->mouse_position_cache_.y_ << ")");
2324 d->update_strategy_ = DecorationUpdate;
2326 // This event (moving without mouse click) is not passed further.
2327 // This should be changed if it is further utilized.
2328 buffer_.changed(false);
2333 void BufferView::clearLastInset(Inset * inset) const
2335 if (d->last_inset_ != inset) {
2336 LYXERR0("Wrong last_inset!");
2339 d->last_inset_ = nullptr;
2343 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
2345 //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
2347 // This is only called for mouse related events including
2348 // LFUN_FILE_OPEN generated by drag-and-drop.
2349 FuncRequest cmd = cmd0;
2351 Cursor old = cursor();
2353 cur.push(buffer_.inset());
2354 cur.selection(d->cursor_.selection());
2356 // Either the inset under the cursor or the
2357 // surrounding Text will handle this event.
2359 // make sure we stay within the screen...
2360 cmd.set_y(min(max(cmd.y(), -1), height_));
2362 d->mouse_position_cache_.x_ = cmd.x();
2363 d->mouse_position_cache_.y_ = cmd.y();
2365 if (cmd.action() == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
2366 updateHoveredInset();
2370 // Build temporary cursor.
2371 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x(), cmd.y());
2373 // If inset is not editable, cur.pos() might point behind the
2374 // inset (depending on cmd.x(), cmd.y()). This is needed for
2375 // editing to fix bug 9628, but e.g. the context menu needs a
2376 // cursor in front of the inset.
2377 if ((inset->hasSettings() || !inset->contextMenuName().empty()
2378 || inset->lyxCode() == SEPARATOR_CODE) &&
2379 cur.nextInset() != inset && cur.prevInset() == inset)
2381 } else if (cur.inTexted() && cur.pos()
2382 && cur.paragraph().isEnvSeparator(cur.pos() - 1)) {
2383 // Always place cursor in front of a separator inset.
2387 // Put anchor at the same position.
2390 cur.beginUndoGroup();
2392 // Try to dispatch to an non-editable inset near this position
2393 // via the temp cursor. If the inset wishes to change the real
2394 // cursor it has to do so explicitly by using
2395 // cur.bv().cursor() = cur; (or similar)
2397 inset->dispatch(cur, cmd);
2399 // Now dispatch to the temporary cursor. If the real cursor should
2400 // be modified, the inset's dispatch has to do so explicitly.
2401 if (!inset || !cur.result().dispatched())
2404 // Notify left insets
2406 bool badcursor = old.fixIfBroken() | cur.fixIfBroken();
2407 badcursor |= notifyCursorLeavesOrEnters(old, cur);
2409 cursor().fixIfBroken();
2414 // Do we have a selection?
2415 theSelection().haveSelection(cursor().selection());
2417 if (cur.needBufferUpdate()) {
2418 cur.clearBufferUpdate();
2419 buffer().updateBuffer();
2422 // If the command has been dispatched,
2423 if (cur.result().dispatched() || cur.result().screenUpdate())
2424 processUpdateFlags(cur.result().screenUpdate());
2428 int BufferView::minVisiblePart()
2430 return 2 * defaultRowHeight();
2434 int BufferView::scroll(int y)
2437 return scrollDown(y);
2439 return scrollUp(-y);
2444 int BufferView::scrollDown(int offset)
2446 Text * text = &buffer_.text();
2447 TextMetrics & tm = d->text_metrics_[text];
2448 int const ymax = height_ + offset;
2450 pair<pit_type, ParagraphMetrics const *> last = tm.last();
2451 int bottom_pos = last.second->position() + last.second->descent();
2452 if (lyxrc.scroll_below_document)
2453 bottom_pos += height_ - minVisiblePart();
2454 if (last.first + 1 == int(text->paragraphs().size())) {
2455 if (bottom_pos <= height_)
2457 offset = min(offset, bottom_pos - height_);
2460 if (bottom_pos > ymax)
2462 tm.newParMetricsDown();
2464 d->anchor_ypos_ -= offset;
2469 int BufferView::scrollUp(int offset)
2471 Text * text = &buffer_.text();
2472 TextMetrics & tm = d->text_metrics_[text];
2473 int ymin = - offset;
2475 pair<pit_type, ParagraphMetrics const *> first = tm.first();
2476 int top_pos = first.second->position() - first.second->ascent();
2477 if (first.first == 0) {
2480 offset = min(offset, - top_pos);
2485 tm.newParMetricsUp();
2487 d->anchor_ypos_ += offset;
2492 bool BufferView::setCursorFromRow(int row)
2494 TexRow::TextEntry start, end;
2495 tie(start,end) = buffer_.texrow().getEntriesFromRow(row);
2496 LYXERR(Debug::LATEX,
2497 "setCursorFromRow: for row " << row << ", TexRow has found "
2498 "start (id=" << start.id << ",pos=" << start.pos << "), "
2499 "end (id=" << end.id << ",pos=" << end.pos << ")");
2500 return setCursorFromEntries(start, end);
2504 bool BufferView::setCursorFromEntries(TexRow::TextEntry start,
2505 TexRow::TextEntry end)
2507 DocIterator dit_start, dit_end;
2508 tie(dit_start,dit_end) =
2509 TexRow::getDocIteratorsFromEntries(start, end, buffer_);
2512 // Setting selection start
2513 d->cursor_.clearSelection();
2514 setCursor(dit_start);
2515 // Setting selection end
2517 d->cursor_.resetAnchor();
2518 setCursorSelectionTo(dit_end);
2524 bool BufferView::setCursorFromInset(Inset const * inset)
2526 // are we already there?
2527 if (cursor().nextInset() == inset)
2530 // Inset is not at cursor position. Find it in the document.
2533 while (cur && cur.nextInset() != inset)
2544 void BufferView::gotoLabel(docstring const & label)
2547 bool have_inactive = false;
2548 for (Buffer const * buf : buffer().allRelatives()) {
2550 for (TocItem const & item : *buf->tocBackend().toc("label")) {
2551 if (label == item.str() && item.isOutput()) {
2552 lyx::dispatch(item.action());
2555 // If we find an inactive label, save it for the case
2556 // that no active one is there
2557 if (label == item.str() && !have_inactive) {
2558 have_inactive = true;
2559 action = item.action();
2563 // We only found an inactive label. Go there.
2565 lyx::dispatch(action);
2569 TextMetrics const & BufferView::textMetrics(Text const * t) const
2571 return const_cast<BufferView *>(this)->textMetrics(t);
2575 TextMetrics & BufferView::textMetrics(Text const * t)
2578 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
2579 if (tmc_it == d->text_metrics_.end()) {
2580 tmc_it = d->text_metrics_.emplace(std::piecewise_construct,
2581 std::forward_as_tuple(t),
2582 std::forward_as_tuple(this, const_cast<Text *>(t))).first;
2584 return tmc_it->second;
2588 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
2591 return textMetrics(t).parMetrics(pit);
2595 int BufferView::workHeight() const
2601 void BufferView::setCursor(DocIterator const & dit)
2604 size_t const n = dit.depth();
2605 for (size_t i = 0; i < n; ++i)
2606 dit[i].inset().edit(d->cursor_, true);
2608 d->cursor_.setCursor(dit);
2609 d->cursor_.selection(false);
2610 d->cursor_.setCurrentFont();
2612 // It seems on general grounds as if this is probably needed, but
2613 // it is not yet clear.
2614 // See bug #7394 and r38388.
2615 // d->cursor.resetAnchor();
2619 void BufferView::setCursorSelectionTo(DocIterator const & dit)
2621 size_t const n = dit.depth();
2622 for (size_t i = 0; i < n; ++i)
2623 dit[i].inset().edit(d->cursor_, true);
2625 d->cursor_.selection(true);
2626 d->cursor_.setCursorSelectionTo(dit);
2627 d->cursor_.setCurrentFont();
2631 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
2633 // Would be wrong to delete anything if we have a selection.
2634 if (cur.selection())
2637 bool need_anchor_change = false;
2638 bool changed = Text::deleteEmptyParagraphMechanism(cur, old,
2639 need_anchor_change);
2641 if (need_anchor_change)
2649 // we would rather not do this here, but it needs to be done before
2650 // the changed() signal is sent.
2651 buffer_.updateBuffer();
2653 buffer_.changed(true);
2658 bool BufferView::mouseSetCursor(Cursor & cur, bool const select)
2660 LASSERT(&cur.bv() == this, return false);
2663 // this event will clear selection so we save selection for
2664 // persistent selection
2665 cap::saveSelection(cursor());
2667 d->cursor_.macroModeClose();
2668 // If a macro has been finalized, the cursor might have been broken
2671 // Has the cursor just left the inset?
2672 bool const leftinset = (&d->cursor_.inset() != &cur.inset());
2674 d->cursor_.fixIfBroken();
2676 // do the dEPM magic if needed
2677 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
2678 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
2679 // the leftinset bool would not be necessary (badcursor instead).
2680 bool update = leftinset;
2683 d->cursor_.setSelection();
2684 d->cursor_.setCursorSelectionTo(cur);
2686 if (d->cursor_.inTexted())
2687 update |= checkDepm(cur, d->cursor_);
2688 d->cursor_.resetAnchor();
2689 d->cursor_.setCursor(cur);
2690 d->cursor_.clearSelection();
2692 d->cursor_.boundary(cur.boundary());
2693 d->cursor_.finishUndo();
2694 d->cursor_.setCurrentFont();
2696 cur.forceBufferUpdate();
2701 void BufferView::putSelectionAt(DocIterator const & cur,
2702 int length, bool backwards)
2704 d->cursor_.clearSelection();
2710 d->cursor_.pos() += length;
2711 d->cursor_.setSelection(d->cursor_, -length);
2713 d->cursor_.setSelection(d->cursor_, length);
2718 bool BufferView::selectIfEmpty(DocIterator & cur)
2720 if ((cur.inTexted() && !cur.paragraph().empty())
2721 || (cur.inMathed() && !cur.cell().empty()))
2724 pit_type const beg_pit = cur.pit();
2726 // The paragraph associated to this item isn't
2727 // the first one, so it can be selected
2730 // We have to resort to select the space between the
2731 // end of this item and the begin of the next one
2735 // If it is the only item in the document,
2736 // nothing can be selected
2739 pit_type const end_pit = cur.pit();
2740 pos_type const end_pos = cur.pos();
2741 d->cursor_.clearSelection();
2743 d->cursor_.setCursor(cur);
2744 d->cursor_.pit() = beg_pit;
2745 d->cursor_.pos() = 0;
2746 d->cursor_.selection(false);
2747 d->cursor_.resetAnchor();
2748 d->cursor_.pit() = end_pit;
2749 d->cursor_.pos() = end_pos;
2750 d->cursor_.setSelection();
2755 Cursor & BufferView::cursor()
2761 Cursor const & BufferView::cursor() const
2767 bool BufferView::singleParUpdate()
2769 Text & buftext = buffer_.text();
2770 pit_type const bottom_pit = d->cursor_.bottom().pit();
2771 TextMetrics & tm = textMetrics(&buftext);
2772 int old_height = tm.parMetrics(bottom_pit).height();
2774 // make sure inline completion pointer is ok
2775 if (d->inlineCompletionPos_.fixIfBroken())
2776 d->inlineCompletionPos_ = DocIterator();
2778 // In Single Paragraph mode, rebreak only
2779 // the (main text, not inset!) paragraph containing the cursor.
2780 // (if this paragraph contains insets etc., rebreaking will
2781 // recursively descend)
2782 tm.redoParagraph(bottom_pit);
2783 ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
2784 if (pm.height() != old_height)
2785 // Paragraph height has changed so we cannot proceed to
2786 // the singlePar optimisation.
2789 tm.updatePosCache(bottom_pit);
2791 LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
2792 << " y2: " << pm.position() + pm.descent()
2793 << " pit: " << bottom_pit
2794 << " singlepar: 1");
2799 void BufferView::updateMetrics()
2801 updateMetrics(d->update_flags_);
2802 d->update_strategy_ = FullScreenUpdate;
2806 void BufferView::updateMetrics(Update::flags & update_flags)
2808 if (height_ == 0 || width_ == 0)
2811 Text & buftext = buffer_.text();
2812 pit_type const npit = int(buftext.paragraphs().size());
2814 // Clear out the position cache in case of full screen redraw,
2815 d->coord_cache_.clear();
2816 d->math_rows_.clear();
2818 // Clear out paragraph metrics to avoid having invalid metrics
2819 // in the cache from paragraphs not relayouted below
2820 // The complete text metrics will be redone.
2821 d->text_metrics_.clear();
2823 TextMetrics & tm = textMetrics(&buftext);
2825 // make sure inline completion pointer is ok
2826 if (d->inlineCompletionPos_.fixIfBroken())
2827 d->inlineCompletionPos_ = DocIterator();
2829 if (d->anchor_pit_ >= npit)
2830 // The anchor pit must have been deleted...
2831 d->anchor_pit_ = npit - 1;
2833 // Rebreak anchor paragraph.
2834 tm.redoParagraph(d->anchor_pit_);
2835 ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
2838 if (d->anchor_pit_ == 0) {
2839 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
2841 // Complete buffer visible? Then it's easy.
2842 if (scrollRange == 0)
2843 d->anchor_ypos_ = anchor_pm.ascent();
2845 // avoid empty space above the first row
2846 d->anchor_ypos_ = min(d->anchor_ypos_, anchor_pm.ascent());
2849 anchor_pm.setPosition(d->anchor_ypos_);
2850 tm.updatePosCache(d->anchor_pit_);
2852 LYXERR(Debug::PAINTING, "metrics: "
2853 << " anchor pit = " << d->anchor_pit_
2854 << " anchor ypos = " << d->anchor_ypos_);
2856 // Redo paragraphs above anchor if necessary.
2857 int y1 = d->anchor_ypos_ - anchor_pm.ascent();
2858 // We are now just above the anchor paragraph.
2859 pit_type pit1 = d->anchor_pit_ - 1;
2860 for (; pit1 >= 0 && y1 >= 0; --pit1) {
2861 tm.redoParagraph(pit1);
2862 ParagraphMetrics & pm = tm.par_metrics_[pit1];
2864 // Save the paragraph position in the cache.
2866 tm.updatePosCache(pit1);
2870 // Redo paragraphs below the anchor if necessary.
2871 int y2 = d->anchor_ypos_ + anchor_pm.descent();
2872 // We are now just below the anchor paragraph.
2873 pit_type pit2 = d->anchor_pit_ + 1;
2874 for (; pit2 < npit && y2 <= height_; ++pit2) {
2875 tm.redoParagraph(pit2);
2876 ParagraphMetrics & pm = tm.par_metrics_[pit2];
2878 // Save the paragraph position in the cache.
2880 tm.updatePosCache(pit2);
2884 LYXERR(Debug::PAINTING, "Metrics: "
2885 << " anchor pit = " << d->anchor_pit_
2886 << " anchor ypos = " << d->anchor_ypos_
2889 << " pit1 = " << pit1
2890 << " pit2 = " << pit2);
2892 // metrics is done, full drawing is necessary now
2893 update_flags = (update_flags & ~Update::Force) | Update::ForceDraw;
2895 // Now update the positions of insets in the cache.
2898 if (lyxerr.debugging(Debug::WORKAREA)) {
2899 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
2900 d->coord_cache_.dump();
2905 void BufferView::updatePosCache()
2907 // this is the "nodraw" drawing stage: only set the positions of the
2908 // insets in metrics cache.
2909 frontend::NullPainter np;
2914 void BufferView::insertLyXFile(FileName const & fname, bool const ignorelang)
2916 LASSERT(d->cursor_.inTexted(), return);
2918 // Get absolute path of file and add ".lyx"
2919 // to the filename if necessary
2920 FileName filename = fileSearch(string(), fname.absFileName(), "lyx");
2922 docstring const disp_fn = makeDisplayPath(filename.absFileName());
2923 // emit message signal.
2924 message(bformat(_("Inserting document %1$s..."), disp_fn));
2927 Buffer buf(filename.absFileName(), false);
2928 if (buf.loadLyXFile() == Buffer::ReadSuccess) {
2929 ErrorList & el = buffer_.errorList("Parse");
2930 // Copy the inserted document error list into the current buffer one.
2931 el = buf.errorList("Parse");
2932 ParagraphList & pars = buf.paragraphs();
2934 // set main language of imported file to context language
2935 buf.changeLanguage(buf.language(), d->cursor_.getFont().language());
2936 buffer_.undo().recordUndo(d->cursor_);
2937 cap::pasteParagraphList(d->cursor_, pars,
2938 buf.params().documentClassPtr(), el);
2939 res = _("Document %1$s inserted.");
2941 res = _("Could not insert document %1$s");
2944 buffer_.changed(true);
2945 // emit message signal.
2946 message(bformat(res, disp_fn));
2950 Point BufferView::coordOffset(DocIterator const & dit) const
2956 // Addup contribution of nested insets, from inside to outside,
2957 // keeping the outer paragraph for a special handling below
2958 for (size_t i = dit.depth() - 1; i >= 1; --i) {
2959 CursorSlice const & sl = dit[i];
2963 // get relative position inside sl.inset()
2964 sl.inset().cursorPos(*this, sl, dit.boundary() && (i + 1 == dit.depth()), xx, yy);
2966 // Make relative position inside of the edited inset relative to sl.inset()
2970 // In case of an RTL inset, the edited inset will be positioned to the left
2973 bool boundary_i = dit.boundary() && i + 1 == dit.depth();
2974 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2979 // remember width for the case that sl.inset() is positioned in an RTL inset
2980 lastw = sl.inset().dimension(*this).wid;
2982 //lyxerr << "Cursor::getPos, i: "
2983 // << i << " x: " << xx << " y: " << y << endl;
2986 // Add contribution of initial rows of outermost paragraph
2987 CursorSlice const & sl = dit[0];
2988 TextMetrics const & tm = textMetrics(sl.text());
2989 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2991 LBUFERR(!pm.rows().empty());
2992 y -= pm.rows()[0].ascent();
2994 // FIXME: document this mess
2996 if (sl.pos() > 0 && dit.depth() == 1) {
2998 if (pos && dit.boundary())
3000 // lyxerr << "coordOffset: boundary:" << dit.boundary() << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
3001 rend = pm.pos2row(pos);
3003 rend = pm.pos2row(sl.pos());
3005 size_t rend = pm.pos2row(sl.pos());
3007 for (size_t rit = 0; rit != rend; ++rit)
3008 y += pm.rows()[rit].height();
3009 y += pm.rows()[rend].ascent();
3011 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
3013 // Make relative position from the nested inset now bufferview absolute.
3014 int xx = bottom_tm.cursorX(dit.bottom(), dit.boundary() && dit.depth() == 1);
3017 // In the RTL case place the nested inset at the left of the cursor in
3018 // the outer paragraph
3019 bool boundary_1 = dit.boundary() && 1 == dit.depth();
3020 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
3028 Point BufferView::getPos(DocIterator const & dit) const
3030 if (!paragraphVisible(dit))
3031 return Point(-1, -1);
3033 CursorSlice const & bot = dit.bottom();
3034 TextMetrics const & tm = textMetrics(bot.text());
3036 // offset from outer paragraph
3037 Point p = coordOffset(dit);
3038 p.y_ += tm.parMetrics(bot.pit()).position();
3043 bool BufferView::paragraphVisible(DocIterator const & dit) const
3045 CursorSlice const & bot = dit.bottom();
3046 TextMetrics const & tm = textMetrics(bot.text());
3048 return tm.contains(bot.pit());
3052 void BufferView::caretPosAndHeight(Point & p, int & h) const
3055 Cursor const & cur = cursor();
3056 if (cur.inMathed()) {
3057 MathRow const & mrow = mathRow(&cur.cell());
3058 asc = mrow.caret_ascent;
3059 des = mrow.caret_descent;
3061 Font const font = cur.real_current_font;
3062 frontend::FontMetrics const & fm = theFontMetrics(font);
3063 asc = fm.maxAscent();
3064 des = fm.maxDescent();
3072 bool BufferView::caretInView() const
3074 if (!paragraphVisible(cursor()))
3078 caretPosAndHeight(p, h);
3080 // does the cursor touch the screen ?
3081 if (p.y_ + h < 0 || p.y_ >= workHeight())
3087 int BufferView::horizScrollOffset() const
3089 return d->horiz_scroll_offset_;
3093 int BufferView::horizScrollOffset(Text const * text,
3094 pit_type pit, pos_type pos) const
3096 // Is this a row that is currently scrolled?
3097 if (!d->current_row_slice_.empty()
3098 && &text->inset() == d->current_row_slice_.inset().asInsetText()
3099 && pit == d->current_row_slice_.pit()
3100 && pos == d->current_row_slice_.pos())
3101 return d->horiz_scroll_offset_;
3106 void BufferView::setCurrentRowSlice(CursorSlice const & rowSlice)
3108 // nothing to do if the cursor was already on this row
3109 if (d->current_row_slice_ == rowSlice)
3112 // if the (previous) current row was scrolled, we have to
3113 // remember it in order to repaint it next time.
3114 if (d->horiz_scroll_offset_ != 0) {
3115 // search the old row in cache and mark it changed
3116 for (auto & tm_pair : d->text_metrics_) {
3117 if (&tm_pair.first->inset() == rowSlice.inset().asInsetText()) {
3118 tm_pair.second.setRowChanged(rowSlice.pit(), rowSlice.pos());
3119 // We found it, no need to continue.
3125 // Since we changed row, the scroll offset is not valid anymore
3126 d->horiz_scroll_offset_ = 0;
3127 d->current_row_slice_ = rowSlice;
3131 void BufferView::checkCursorScrollOffset()
3133 CursorSlice rowSlice = d->cursor_.bottom();
3134 TextMetrics const & tm = textMetrics(rowSlice.text());
3136 // Stop if metrics have not been computed yet, since it means
3137 // that there is nothing to do.
3138 if (!tm.contains(rowSlice.pit()))
3140 ParagraphMetrics const & pm = tm.parMetrics(rowSlice.pit());
3141 Row const & row = pm.getRow(rowSlice.pos(),
3142 d->cursor_.boundary() && rowSlice == d->cursor_.top());
3143 rowSlice.pos() = row.pos();
3145 // Set the row on which the cursor lives.
3146 setCurrentRowSlice(rowSlice);
3148 // Current x position of the cursor in pixels
3149 int cur_x = getPos(d->cursor_).x_;
3151 // Horizontal scroll offset of the cursor row in pixels
3152 int offset = d->horiz_scroll_offset_;
3153 int const MARGIN = 2 * theFontMetrics(d->cursor_.real_current_font).em()
3155 if (row.right_x() <= workWidth() - row.right_margin) {
3156 // Row is narrower than the work area, no offset needed.
3159 if (cur_x - offset < MARGIN) {
3160 // cursor would be too far right
3161 offset = cur_x - MARGIN;
3162 } else if (cur_x - offset > workWidth() - MARGIN) {
3163 // cursor would be too far left
3164 offset = cur_x - workWidth() + MARGIN;
3166 // Correct the offset to make sure that we do not scroll too much
3169 if (row.right_x() - offset < workWidth() - row.right_margin)
3170 offset = row.right_x() - workWidth() + row.right_margin;
3173 //lyxerr << "cur_x=" << cur_x << ", offset=" << offset << ", row.wid=" << row.width() << ", margin=" << MARGIN << endl;
3175 if (offset != d->horiz_scroll_offset_)
3176 LYXERR(Debug::PAINTING, "Horiz. scroll offset changed from "
3177 << d->horiz_scroll_offset_ << " to " << offset);
3179 if (d->update_strategy_ == NoScreenUpdate
3180 && offset != d->horiz_scroll_offset_) {
3181 // FIXME: if one uses SingleParUpdate, then home/end
3182 // will not work on long rows. Why?
3183 d->update_strategy_ = FullScreenUpdate;
3186 d->horiz_scroll_offset_ = offset;
3190 void BufferView::draw(frontend::Painter & pain, bool paint_caret)
3192 if (height_ == 0 || width_ == 0)
3194 LYXERR(Debug::PAINTING, (pain.isNull() ? "\t\t--- START NODRAW ---"
3195 : "\t\t*** START DRAWING ***"));
3196 Text & text = buffer_.text();
3197 TextMetrics const & tm = d->text_metrics_[&text];
3198 int const y = tm.first().second->position();
3199 PainterInfo pi(this, pain);
3201 // Check whether the row where the cursor lives needs to be scrolled.
3202 // Update the drawing strategy if needed.
3203 checkCursorScrollOffset();
3205 switch (d->update_strategy_) {
3207 case NoScreenUpdate:
3208 // no screen painting is actually needed. In nodraw stage
3209 // however, the different coordinates of insets and paragraphs
3210 // needs to be updated.
3211 LYXERR(Debug::PAINTING, "Strategy: NoScreenUpdate");
3212 if (pain.isNull()) {
3213 pi.full_repaint = true;
3216 pi.full_repaint = false;
3221 case SingleParUpdate:
3222 pi.full_repaint = false;
3223 LYXERR(Debug::PAINTING, "Strategy: SingleParUpdate");
3224 // In general, only the current row of the outermost paragraph
3225 // will be redrawn. Particular cases where selection spans
3226 // multiple paragraph are correctly detected in TextMetrics.
3230 case DecorationUpdate:
3231 // FIXME: We should also distinguish DecorationUpdate to avoid text
3232 // drawing if possible. This is not possible to do easily right now
3233 // because of the single backing pixmap.
3235 case FullScreenUpdate:
3237 LYXERR(Debug::PAINTING,
3238 ((d->update_strategy_ == FullScreenUpdate)
3239 ? "Strategy: FullScreenUpdate"
3240 : "Strategy: DecorationUpdate"));
3242 // The whole screen, including insets, will be refreshed.
3243 pi.full_repaint = true;
3245 // Clear background.
3246 pain.fillRectangle(0, 0, width_, height_,
3247 pi.backgroundColor(&buffer_.inset()));
3252 // and possibly grey out below
3253 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3254 int const y2 = lastpm.second->position() + lastpm.second->descent();
3257 Color color = buffer().isInternal()
3258 ? Color_background : Color_bottomarea;
3259 pain.fillRectangle(0, y2, width_, height_ - y2, color);
3263 LYXERR(Debug::PAINTING, (pain.isNull() ? "\t\t --- END NODRAW ---"
3264 : "\t\t *** END DRAWING ***"));
3266 // The scrollbar needs an update.
3269 // Normalize anchor for next time
3270 pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
3271 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3272 for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
3273 ParagraphMetrics const & pm = tm.parMetrics(pit);
3274 if (pm.position() + pm.descent() > 0) {
3275 if (d->anchor_pit_ != pit
3276 || d->anchor_ypos_ != pm.position())
3277 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
3278 << " anchor ypos = " << d->anchor_ypos_);
3279 d->anchor_pit_ = pit;
3280 d->anchor_ypos_ = pm.position();
3284 if (!pain.isNull()) {
3285 // reset the update flags, everything has been done
3286 d->update_flags_ = Update::None;
3289 // If a caret has to be painted, mark its text row as dirty to
3290 //make sure that it will be repainted on next redraw.
3291 /* FIXME: investigate whether this can be avoided when the cursor did not
3295 Row const & caret_row = d->cursor_.textRow();
3296 caret_row.changed(true);
3301 void BufferView::message(docstring const & msg)
3304 d->gui_->message(msg);
3308 void BufferView::showDialog(string const & name)
3311 d->gui_->showDialog(name, string());
3315 void BufferView::showDialog(string const & name,
3316 string const & data, Inset * inset)
3319 d->gui_->showDialog(name, data, inset);
3323 void BufferView::updateDialog(string const & name, string const & data)
3326 d->gui_->updateDialog(name, data);
3330 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
3336 // FIXME: Move this out of BufferView again
3337 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
3339 if (!fname.isReadableFile()) {
3340 docstring const error = from_ascii(strerror(errno));
3341 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3342 docstring const text =
3343 bformat(_("Could not read the specified document\n"
3344 "%1$s\ndue to the error: %2$s"), file, error);
3345 Alert::error(_("Could not read file"), text);
3349 if (!fname.isReadableFile()) {
3350 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3351 docstring const text =
3352 bformat(_("%1$s\n is not readable."), file);
3353 Alert::error(_("Could not open file"), text);
3357 // FIXME UNICODE: We don't know the encoding of the file
3358 docstring file_content = fname.fileContents("UTF-8");
3359 if (file_content.empty()) {
3360 Alert::error(_("Reading not UTF-8 encoded file"),
3361 _("The file is not UTF-8 encoded.\n"
3362 "It will be read as local 8Bit-encoded.\n"
3363 "If this does not give the correct result\n"
3364 "then please change the encoding of the file\n"
3365 "to UTF-8 with a program other than LyX.\n"));
3366 file_content = fname.fileContents("local8bit");
3369 return normalize_c(file_content);
3373 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
3375 docstring const tmpstr = contentsOfPlaintextFile(f);
3380 Cursor & cur = cursor();
3381 cap::replaceSelection(cur);
3382 buffer_.undo().recordUndo(cur);
3384 cur.innerText()->insertStringAsParagraphs(cur, tmpstr, cur.current_font);
3386 cur.innerText()->insertStringAsLines(cur, tmpstr, cur.current_font);
3388 buffer_.changed(true);
3392 docstring const & BufferView::inlineCompletion() const
3394 return d->inlineCompletion_;
3398 size_t const & BufferView::inlineCompletionUniqueChars() const
3400 return d->inlineCompletionUniqueChars_;
3404 DocIterator const & BufferView::inlineCompletionPos() const
3406 return d->inlineCompletionPos_;
3410 void BufferView::resetInlineCompletionPos()
3412 d->inlineCompletionPos_ = DocIterator();
3416 bool samePar(DocIterator const & a, DocIterator const & b)
3418 if (a.empty() && b.empty())
3420 if (a.empty() || b.empty())
3422 if (a.depth() != b.depth())
3424 return &a.innerParagraph() == &b.innerParagraph();
3428 void BufferView::setInlineCompletion(Cursor const & cur, DocIterator const & pos,
3429 docstring const & completion, size_t uniqueChars)
3431 uniqueChars = min(completion.size(), uniqueChars);
3432 bool changed = d->inlineCompletion_ != completion
3433 || d->inlineCompletionUniqueChars_ != uniqueChars;
3434 bool singlePar = true;
3435 d->inlineCompletion_ = completion;
3436 d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
3438 //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
3441 DocIterator const & old = d->inlineCompletionPos_;
3443 //lyxerr << "inlineCompletionPos changed" << std::endl;
3444 // old or pos are in another paragraph?
3445 if ((!samePar(cur, pos) && !pos.empty())
3446 || (!samePar(cur, old) && !old.empty())) {
3448 //lyxerr << "different paragraph" << std::endl;
3450 d->inlineCompletionPos_ = pos;
3455 if (singlePar && !(cur.result().screenUpdate() & Update::Force))
3456 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
3458 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::Force);
3463 bool BufferView::clickableInset() const
3465 return d->clickable_inset_;