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 /// Moves cursor to the next inset with one of the given codes.
183 void gotoInset(BufferView * bv, vector<InsetCode> const & codes,
186 Cursor tmpcur = bv->cursor();
187 if (!findInset(tmpcur, codes, same_content)) {
188 bv->cursor().message(_("No more insets"));
192 tmpcur.clearSelection();
193 bv->setCursor(tmpcur);
198 /// A map from a Text to the associated text metrics
199 typedef map<Text const *, TextMetrics> TextMetricsCache;
201 enum ScreenUpdateStrategy {
211 /////////////////////////////////////////////////////////////////////
215 /////////////////////////////////////////////////////////////////////
217 struct BufferView::Private
219 Private(BufferView & bv) :
220 update_strategy_(FullScreenUpdate),
221 update_flags_(Update::Force),
222 cursor_(bv), anchor_pit_(0), anchor_ypos_(0),
223 wh_(0), inlineCompletionUniqueChars_(0),
224 last_inset_(nullptr), mouse_position_cache_(),
225 gui_(nullptr), bookmark_edit_position_(-1),
226 horiz_scroll_offset_(0), clickable_inset_(false)
228 xsel_cache_.set = false;
232 ScrollbarParameters scrollbarParameters_;
234 ScreenUpdateStrategy update_strategy_;
236 Update::flags update_flags_;
238 CoordCache coord_cache_;
240 typedef map<MathData const *, MathRow> MathRows;
243 /// this is used to handle XSelection events in the right manner.
252 pit_type anchor_pit_;
255 /// Estimated average par height for scrollbar.
258 vector<int> par_height_;
261 DocIterator inlineCompletionPos_;
263 docstring inlineCompletion_;
265 size_t inlineCompletionUniqueChars_;
267 /// keyboard mapping object.
270 /// last visited inset.
271 /** kept to send setMouseHover(false).
272 * Not owned, so don't delete.
274 Inset const * last_inset_;
276 /// position of the mouse at the time of the last mouse move
277 /// This is used to update the hovering status of inset in
278 /// cases where the buffer is scrolled, but the mouse didn't move.
279 Point mouse_position_cache_;
281 mutable TextMetricsCache text_metrics_;
284 /** Not owned, so don't delete.
286 frontend::GuiBufferViewDelegate * gui_;
288 /// Cache for Find Next
289 FuncRequest search_request_cache_;
292 map<string, Inset *> edited_insets_;
294 /// When the row where the cursor lies is scrolled, this
295 /// contains the scroll offset
296 // cache for id of the paragraph which was edited the last time
297 int bookmark_edit_position_;
299 int horiz_scroll_offset_;
300 /// a slice pointing to the start of the row where the cursor
301 /// is (at last draw time)
302 CursorSlice current_row_slice_;
303 /// are we hovering something that we can click
304 bool clickable_inset_;
308 BufferView::BufferView(Buffer & buf)
309 : width_(0), height_(0), full_screen_(false), buffer_(buf),
310 d(new Private(*this))
312 d->xsel_cache_.set = false;
313 d->intl_.initKeyMapper(lyxrc.use_kbmap);
315 d->cursor_.setBuffer(&buf);
316 d->cursor_.push(buffer_.inset());
317 d->cursor_.resetAnchor();
318 d->cursor_.setCurrentFont();
320 buffer_.updatePreviews();
324 BufferView::~BufferView()
326 // current buffer is going to be switched-off, save cursor pos
327 // Ideally, the whole cursor stack should be saved, but session
328 // currently can only handle bottom (whole document) level pit and pos.
329 // That is to say, if a cursor is in a nested inset, it will be
330 // restore to the left of the top level inset.
331 LastFilePosSection::FilePos fp;
332 fp.file = buffer_.fileName();
333 fp.pit = d->cursor_.bottom().pit();
334 fp.pos = d->cursor_.bottom().pos();
335 theSession().lastFilePos().save(fp);
338 d->last_inset_->setMouseHover(this, false);
344 int BufferView::rightMargin() const
346 // The value used to be hardcoded to 10
347 int const default_margin = zoomedPixels(10);
348 // The additional test for the case the outliner is opened.
349 if (!full_screen_ || !lyxrc.full_screen_limit
350 || width_ < lyxrc.full_screen_width + 2 * default_margin)
351 return default_margin;
353 return (width_ - lyxrc.full_screen_width) / 2;
357 int BufferView::leftMargin() const
359 return rightMargin();
363 int BufferView::topMargin() const
365 // original value was 20px, which is 0.2in at 100dpi
366 return zoomedPixels(20);
370 int BufferView::bottomMargin() const
372 // original value was 20px, which is 0.2in at 100dpi
373 return zoomedPixels(20);
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
942 LYXERR(Debug::SCROLLING, "recentering and scrolling to cursor");
944 LYXERR(Debug::SCROLLING, "scrolling to cursor");
946 CursorSlice const & bot = dit.bottom();
947 TextMetrics & tm = d->text_metrics_[bot.text()];
949 pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
950 int bot_pit = bot.pit();
951 if (bot_pit > max_pit) {
952 // FIXME: Why does this happen?
953 LYXERR0("bottom pit is greater that max pit: "
954 << bot_pit << " > " << max_pit);
958 if (bot_pit == tm.first().first - 1)
959 tm.newParMetricsUp();
960 else if (bot_pit == tm.last().first + 1)
961 tm.newParMetricsDown();
963 if (tm.contains(bot_pit)) {
964 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
965 LBUFERR(!pm.rows().empty());
966 // FIXME: smooth scrolling doesn't work in mathed.
967 CursorSlice const & cs = dit.innerTextSlice();
968 int offset = coordOffset(dit).y_;
969 int ypos = pm.position() + offset;
970 Dimension const & row_dim =
971 pm.getRow(cs.pos(), dit.boundary()).dim();
974 scrolled = scroll(ypos - height_/2);
976 // We try to visualize the whole row, if the row height is larger than
977 // the screen height, we scroll to a heuristic value of height_ / 4.
978 // FIXME: This heuristic value should be replaced by a recursive search
979 // for a row in the inset that can be visualized completely.
980 else if (row_dim.height() > height_) {
981 if (ypos < defaultRowHeight())
982 scrolled = scroll(ypos - height_ / 4);
983 else if (ypos > height_ - defaultRowHeight())
984 scrolled = scroll(ypos - 3 * height_ / 4);
987 // If the top part of the row falls of the screen, we scroll
988 // up to align the top of the row with the top of the screen.
989 else if (ypos - row_dim.ascent() < 0 && ypos < height_) {
990 int ynew = row_dim.ascent();
991 scrolled = scrollUp(ynew - ypos);
994 // If the bottom of the row falls of the screen, we scroll down.
995 else if (ypos + row_dim.descent() > height_ && ypos > 0) {
996 int ynew = height_ - row_dim.descent();
997 scrolled = scrollDown(ypos - ynew);
1000 // else, nothing to do, the cursor is already visible so we just return.
1001 return scrolled != 0;
1004 // fix inline completion position
1005 if (d->inlineCompletionPos_.fixIfBroken())
1006 d->inlineCompletionPos_ = DocIterator();
1008 tm.redoParagraph(bot_pit);
1009 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
1010 int offset = coordOffset(dit).y_;
1012 d->anchor_pit_ = bot_pit;
1013 CursorSlice const & cs = dit.innerTextSlice();
1014 Dimension const & row_dim =
1015 pm.getRow(cs.pos(), dit.boundary()).dim();
1018 d->anchor_ypos_ = height_/2;
1019 else if (d->anchor_pit_ == 0)
1020 d->anchor_ypos_ = offset + pm.ascent();
1021 else if (d->anchor_pit_ == max_pit)
1022 d->anchor_ypos_ = height_ - offset - row_dim.descent();
1023 else if (offset > height_)
1024 d->anchor_ypos_ = height_ - offset - defaultRowHeight();
1026 d->anchor_ypos_ = defaultRowHeight() * 2;
1032 void BufferView::makeDocumentClass()
1034 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1035 buffer_.params().makeDocumentClass();
1036 updateDocumentClass(olddc);
1040 void BufferView::updateDocumentClass(DocumentClassConstPtr olddc)
1042 message(_("Converting document to new document class..."));
1044 StableDocIterator backcur(d->cursor_);
1045 ErrorList & el = buffer_.errorList("Class Switch");
1046 cap::switchBetweenClasses(
1047 olddc, buffer_.params().documentClassPtr(),
1048 static_cast<InsetText &>(buffer_.inset()), el);
1050 setCursor(backcur.asDocIterator(&buffer_));
1052 buffer_.errors("Class Switch");
1056 /** Return the change status at cursor position, taking into account the
1057 * status at each level of the document iterator (a table in a deleted
1058 * footnote is deleted).
1059 * When \param outer is true, the top slice is not looked at.
1061 static Change::Type lookupChangeType(DocIterator const & dit, bool outer = false)
1063 size_t const depth = dit.depth() - (outer ? 1 : 0);
1065 for (size_t i = 0 ; i < depth ; ++i) {
1066 CursorSlice const & slice = dit[i];
1067 if (!slice.inset().inMathed()
1068 && slice.pos() < slice.paragraph().size()) {
1069 Change::Type const ch = slice.paragraph().lookupChange(slice.pos()).type;
1070 if (ch != Change::UNCHANGED)
1074 return Change::UNCHANGED;
1078 bool BufferView::getStatus(FuncRequest const & cmd, FuncStatus & flag)
1080 FuncCode const act = cmd.action();
1082 // Can we use a readonly buffer?
1083 if (buffer_.isReadonly()
1084 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1085 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1086 if (buffer_.hasReadonlyFlag())
1087 flag.message(from_utf8(N_("Document is read-only")));
1089 flag.message(from_utf8(N_("Document has been modified externally")));
1090 flag.setEnabled(false);
1094 // Are we in a DELETED change-tracking region?
1095 if (lookupChangeType(d->cursor_, true) == Change::DELETED
1096 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1097 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1098 flag.message(from_utf8(N_("This portion of the document is deleted.")));
1099 flag.setEnabled(false);
1103 Cursor & cur = d->cursor_;
1105 if (cur.getStatus(cmd, flag))
1110 // FIXME: This is a bit problematic because we don't check if this is
1111 // a document BufferView or not for these LFUNs. We probably have to
1112 // dispatch both to currentBufferView() and, if that fails,
1113 // to documentBufferView(); same as we do now for current Buffer and
1114 // document Buffer. Ideally those LFUN should go to Buffer as they
1115 // operate on the full Buffer and the cursor is only needed either for
1116 // an Undo record or to restore a cursor position. But we don't know
1117 // how to do that inside Buffer of course.
1118 case LFUN_BUFFER_PARAMS_APPLY:
1119 case LFUN_LAYOUT_MODULES_CLEAR:
1120 case LFUN_LAYOUT_MODULE_ADD:
1121 case LFUN_LAYOUT_RELOAD:
1122 case LFUN_TEXTCLASS_APPLY:
1123 case LFUN_TEXTCLASS_LOAD:
1124 flag.setEnabled(!buffer_.isReadonly());
1128 // We do not use the LyXAction flag for readonly because Undo sets the
1129 // buffer clean/dirty status by itself.
1130 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasUndoStack());
1133 // We do not use the LyXAction flag for readonly because Redo sets the
1134 // buffer clean/dirty status by itself.
1135 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasRedoStack());
1137 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
1138 case LFUN_FILE_INSERT_PLAINTEXT: {
1139 docstring const fname = cmd.argument();
1140 if (!FileName::isAbsolute(to_utf8(fname))) {
1141 flag.message(_("Absolute filename expected."));
1144 flag.setEnabled(cur.inTexted());
1147 case LFUN_FILE_INSERT:
1148 case LFUN_BOOKMARK_SAVE:
1149 // FIXME: Actually, these LFUNS should be moved to Text
1150 flag.setEnabled(cur.inTexted());
1153 case LFUN_FONT_STATE:
1154 case LFUN_LABEL_INSERT:
1155 case LFUN_INFO_INSERT:
1156 case LFUN_PARAGRAPH_GOTO:
1157 case LFUN_NOTE_NEXT:
1158 case LFUN_REFERENCE_NEXT:
1159 case LFUN_WORD_FIND:
1160 case LFUN_WORD_FIND_FORWARD:
1161 case LFUN_WORD_FIND_BACKWARD:
1162 case LFUN_WORD_REPLACE:
1165 case LFUN_MARK_TOGGLE:
1166 case LFUN_SCREEN_RECENTER:
1167 case LFUN_SCREEN_SHOW_CURSOR:
1168 case LFUN_BIBTEX_DATABASE_ADD:
1169 case LFUN_BIBTEX_DATABASE_DEL:
1170 case LFUN_STATISTICS:
1171 case LFUN_KEYMAP_OFF:
1172 case LFUN_KEYMAP_PRIMARY:
1173 case LFUN_KEYMAP_SECONDARY:
1174 case LFUN_KEYMAP_TOGGLE:
1175 case LFUN_INSET_SELECT_ALL:
1176 flag.setEnabled(true);
1179 case LFUN_GRAPHICS_UNIFY:
1180 flag.setEnabled(cur.countInsetsInSelection(GRAPHICS_CODE)>1);
1183 case LFUN_WORD_FINDADV: {
1184 FindAndReplaceOptions opt;
1185 istringstream iss(to_utf8(cmd.argument()));
1187 flag.setEnabled(opt.repl_buf_name.empty()
1188 || !buffer_.isReadonly());
1192 case LFUN_LABEL_GOTO:
1193 flag.setEnabled(!cmd.argument().empty()
1194 || getInsetByCode<InsetRef>(cur, REF_CODE));
1197 case LFUN_CHANGES_MERGE:
1198 case LFUN_CHANGE_NEXT:
1199 case LFUN_CHANGE_PREVIOUS:
1200 case LFUN_ALL_CHANGES_ACCEPT:
1201 case LFUN_ALL_CHANGES_REJECT:
1202 flag.setEnabled(buffer_.areChangesPresent());
1205 case LFUN_SCREEN_UP:
1206 case LFUN_SCREEN_DOWN:
1208 case LFUN_SCREEN_UP_SELECT:
1209 case LFUN_SCREEN_DOWN_SELECT:
1210 case LFUN_INSET_FORALL:
1211 flag.setEnabled(true);
1214 case LFUN_LAYOUT_TABULAR:
1215 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
1219 flag.setEnabled(!cur.inset().forcePlainLayout(cur.idx()));
1222 case LFUN_LAYOUT_PARAGRAPH:
1223 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
1226 case LFUN_BRANCH_ADD_INSERT:
1227 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1230 case LFUN_DIALOG_SHOW_NEW_INSET:
1231 // FIXME: this is wrong, but I do not understand the
1233 if (cur.inset().lyxCode() == CAPTION_CODE)
1234 return cur.inset().getStatus(cur, cmd, flag);
1235 // FIXME we should consider passthru paragraphs too.
1236 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1239 case LFUN_CITATION_INSERT: {
1240 FuncRequest fr(LFUN_INSET_INSERT, "citation");
1241 // FIXME: This could turn in a recursive hell.
1242 // Shouldn't we use Buffer::getStatus() instead?
1243 flag.setEnabled(lyx::getStatus(fr).enabled());
1246 case LFUN_INSET_APPLY: {
1247 string const name = cmd.getArg(0);
1248 Inset * inset = editedInset(name);
1250 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1251 if (!inset->getStatus(cur, fr, flag)) {
1252 // Every inset is supposed to handle this
1253 LASSERT(false, break);
1256 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1257 flag = lyx::getStatus(fr);
1270 Inset * BufferView::editedInset(string const & name) const
1272 map<string, Inset *>::const_iterator it = d->edited_insets_.find(name);
1273 return it == d->edited_insets_.end() ? nullptr : it->second;
1277 void BufferView::editInset(string const & name, Inset * inset)
1280 d->edited_insets_[name] = inset;
1282 d->edited_insets_.erase(name);
1286 void BufferView::dispatch(FuncRequest const & cmd, DispatchResult & dr)
1288 LYXERR(Debug::ACTION, "BufferView::dispatch: cmd: " << cmd);
1290 string const argument = to_utf8(cmd.argument());
1291 Cursor & cur = d->cursor_;
1294 // Don't dispatch function that does not apply to internal buffers.
1295 if (buffer_.isInternal()
1296 && lyxaction.funcHasFlag(cmd.action(), LyXAction::NoInternal))
1299 // We'll set this back to false if need be.
1300 bool dispatched = true;
1301 buffer_.undo().beginUndoGroup();
1303 FuncCode const act = cmd.action();
1306 case LFUN_BUFFER_PARAMS_APPLY: {
1307 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1308 cur.recordUndoBufferParams();
1309 istringstream ss(to_utf8(cmd.argument()));
1312 int const unknown_tokens = buffer_.readHeader(lex);
1313 if (unknown_tokens != 0) {
1314 LYXERR0("Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1315 << unknown_tokens << " unknown token"
1316 << (unknown_tokens == 1 ? "" : "s"));
1318 updateDocumentClass(olddc);
1320 // We are most certainly here because of a change in the document
1321 // It is then better to make sure that all dialogs are in sync with
1322 // current document settings.
1323 dr.screenUpdate(Update::Force | Update::FitCursor);
1324 dr.forceBufferUpdate();
1328 case LFUN_LAYOUT_MODULES_CLEAR: {
1329 // FIXME: this modifies the document in cap::switchBetweenClasses
1330 // without calling recordUndo. Fix this before using
1331 // recordUndoBufferParams().
1332 cur.recordUndoFullBuffer();
1333 buffer_.params().clearLayoutModules();
1334 makeDocumentClass();
1335 dr.screenUpdate(Update::Force);
1336 dr.forceBufferUpdate();
1340 case LFUN_LAYOUT_MODULE_ADD: {
1341 BufferParams const & params = buffer_.params();
1342 if (!params.layoutModuleCanBeAdded(argument)) {
1343 LYXERR0("Module `" << argument <<
1344 "' cannot be added due to failed requirements or "
1345 "conflicts with installed modules.");
1348 // FIXME: this modifies the document in cap::switchBetweenClasses
1349 // without calling recordUndo. Fix this before using
1350 // recordUndoBufferParams().
1351 cur.recordUndoFullBuffer();
1352 buffer_.params().addLayoutModule(argument);
1353 makeDocumentClass();
1354 dr.screenUpdate(Update::Force);
1355 dr.forceBufferUpdate();
1359 case LFUN_TEXTCLASS_APPLY: {
1360 // since this shortcircuits, the second call is made only if
1362 bool const success =
1363 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1364 LayoutFileList::get().load(argument, buffer_.filePath());
1366 docstring s = bformat(_("The document class `%1$s' "
1367 "could not be loaded."), from_utf8(argument));
1368 frontend::Alert::error(_("Could not load class"), s);
1372 LayoutFile const * old_layout = buffer_.params().baseClass();
1373 LayoutFile const * new_layout = &(LayoutFileList::get()[argument]);
1375 if (old_layout == new_layout)
1379 // Save the old, possibly modular, layout for use in conversion.
1380 // FIXME: this modifies the document in cap::switchBetweenClasses
1381 // without calling recordUndo. Fix this before using
1382 // recordUndoBufferParams().
1383 cur.recordUndoFullBuffer();
1384 buffer_.params().setBaseClass(argument, buffer_.layoutPos());
1385 makeDocumentClass();
1386 dr.screenUpdate(Update::Force);
1387 dr.forceBufferUpdate();
1391 case LFUN_TEXTCLASS_LOAD: {
1392 // since this shortcircuits, the second call is made only if
1394 bool const success =
1395 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1396 LayoutFileList::get().load(argument, buffer_.filePath());
1398 docstring s = bformat(_("The document class `%1$s' "
1399 "could not be loaded."), from_utf8(argument));
1400 frontend::Alert::error(_("Could not load class"), s);
1405 case LFUN_LAYOUT_RELOAD: {
1406 LayoutFileIndex bc = buffer_.params().baseClassID();
1407 LayoutFileList::get().reset(bc);
1408 buffer_.params().setBaseClass(bc, buffer_.layoutPos());
1409 makeDocumentClass();
1410 dr.screenUpdate(Update::Force);
1411 dr.forceBufferUpdate();
1416 dr.setMessage(_("Undo"));
1417 cur.clearSelection();
1418 // We need to find out if the bibliography information
1419 // has changed. See bug #11055.
1420 // So these should not be references...
1421 string const engine = buffer().params().citeEngine();
1422 CiteEngineType const enginetype = buffer().params().citeEngineType();
1423 if (!cur.undoAction())
1424 dr.setMessage(_("No further undo information"));
1426 dr.screenUpdate(Update::Force | Update::FitCursor);
1427 dr.forceBufferUpdate();
1428 if (buffer().params().citeEngine() != engine ||
1429 buffer().params().citeEngineType() != enginetype)
1430 buffer().invalidateCiteLabels();
1436 dr.setMessage(_("Redo"));
1437 cur.clearSelection();
1438 // We need to find out if the bibliography information
1439 // has changed. See bug #11055.
1440 // So these should not be references...
1441 string const engine = buffer().params().citeEngine();
1442 CiteEngineType const enginetype = buffer().params().citeEngineType();
1443 if (!cur.redoAction())
1444 dr.setMessage(_("No further redo information"));
1446 dr.screenUpdate(Update::Force | Update::FitCursor);
1447 dr.forceBufferUpdate();
1448 if (buffer().params().citeEngine() != engine ||
1449 buffer().params().citeEngineType() != enginetype)
1450 buffer().invalidateCiteLabels();
1455 case LFUN_FONT_STATE:
1456 dr.setMessage(cur.currentState(false));
1459 case LFUN_BOOKMARK_SAVE:
1460 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1463 case LFUN_LABEL_GOTO: {
1464 docstring label = cmd.argument();
1465 if (label.empty()) {
1467 getInsetByCode<InsetRef>(cur, REF_CODE);
1469 label = inset->getParam("reference");
1470 // persistent=false: use temp_bookmark
1474 if (!label.empty()) {
1476 // at the moment, this is redundant, since gotoLabel will
1477 // eventually call LFUN_PARAGRAPH_GOTO, but it seems best
1479 dr.screenUpdate(Update::Force | Update::FitCursor);
1484 case LFUN_PARAGRAPH_GOTO: {
1485 int const id = convert<int>(cmd.getArg(0));
1486 pos_type const pos = convert<int>(cmd.getArg(1));
1489 string const str_id_end = cmd.getArg(2);
1490 string const str_pos_end = cmd.getArg(3);
1492 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1493 b = theBufferList().next(b)) {
1496 curs.setCursor(b->getParFromID(id));
1498 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1502 LYXERR(Debug::INFO, "Paragraph " << curs.paragraph().id()
1503 << " found in buffer `"
1504 << b->absFileName() << "'.");
1506 if (b == &buffer_) {
1508 if (str_id_end.empty() || str_pos_end.empty()) {
1511 mouseSetCursor(curs);
1514 int const id_end = convert<int>(str_id_end);
1515 pos_type const pos_end = convert<int>(str_pos_end);
1516 success = setCursorFromEntries({id, pos},
1520 dr.screenUpdate(Update::Force | Update::FitCursor);
1522 // Switch to other buffer view and resend cmd
1523 lyx::dispatch(FuncRequest(
1524 LFUN_BUFFER_SWITCH, b->absFileName()));
1532 case LFUN_NOTE_NEXT:
1533 gotoInset(this, { NOTE_CODE }, false);
1534 // FIXME: if SinglePar is changed to act on the inner
1535 // paragraph, this will not be OK anymore. The update is
1536 // useful for auto-open collapsible insets.
1537 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1540 case LFUN_REFERENCE_NEXT: {
1541 gotoInset(this, { LABEL_CODE, REF_CODE }, true);
1542 // FIXME: if SinglePar is changed to act on the inner
1543 // paragraph, this will not be OK anymore. The update is
1544 // useful for auto-open collapsible insets.
1545 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1549 case LFUN_CHANGE_NEXT:
1550 findNextChange(this);
1551 if (cur.inset().isTable())
1552 // In tables, there might be whole changed rows or columns
1554 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1555 dr.screenUpdate(Update::Force | Update::FitCursor);
1558 case LFUN_CHANGE_PREVIOUS:
1559 findPreviousChange(this);
1560 if (cur.inset().isTable())
1561 // In tables, there might be whole changed rows or columns
1563 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1564 dr.screenUpdate(Update::Force | Update::FitCursor);
1567 case LFUN_CHANGES_MERGE:
1568 if (findNextChange(this) || findPreviousChange(this)) {
1569 dr.screenUpdate(Update::Force | Update::FitCursor);
1570 dr.forceBufferUpdate();
1571 showDialog("changes");
1575 case LFUN_ALL_CHANGES_ACCEPT: {
1576 // select complete document
1578 cur.selHandle(true);
1579 buffer_.text().cursorBottom(cur);
1580 // accept everything in a single step to support atomic undo
1581 // temporarily disable track changes in order to end with really
1582 // no new (e.g., DPSM-caused) changes (see #7487)
1583 bool const track = buffer_.params().track_changes;
1584 buffer_.params().track_changes = false;
1585 buffer_.text().acceptOrRejectChanges(cur, Text::ACCEPT);
1586 buffer_.params().track_changes = track;
1588 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1589 dr.screenUpdate(Update::Force | Update::FitCursor);
1590 dr.forceBufferUpdate();
1594 case LFUN_ALL_CHANGES_REJECT: {
1595 // select complete document
1597 cur.selHandle(true);
1598 buffer_.text().cursorBottom(cur);
1599 // reject everything in a single step to support atomic undo
1600 // temporarily disable track changes in order to end with really
1601 // no new (e.g., DPSM-caused) changes (see #7487)
1602 bool const track = buffer_.params().track_changes;
1603 buffer_.params().track_changes = false;
1604 buffer_.text().acceptOrRejectChanges(cur, Text::REJECT);
1605 buffer_.params().track_changes = track;
1607 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1608 dr.screenUpdate(Update::Force | Update::FitCursor);
1609 dr.forceBufferUpdate();
1613 case LFUN_WORD_FIND_FORWARD:
1614 case LFUN_WORD_FIND_BACKWARD: {
1616 // Would it maybe be better if this variable were view specific anyway?
1617 static docstring last_search;
1618 docstring searched_string;
1620 if (!cmd.argument().empty()) {
1621 last_search = cmd.argument();
1622 searched_string = cmd.argument();
1624 searched_string = last_search;
1627 if (searched_string.empty())
1630 bool const fw = act == LFUN_WORD_FIND_FORWARD;
1631 docstring const data =
1632 find2string(searched_string, true, false, fw);
1633 bool found = lyxfind(this, FuncRequest(LFUN_WORD_FIND, data));
1635 dr.screenUpdate(Update::Force | Update::FitCursor);
1639 case LFUN_WORD_FIND: {
1640 FuncRequest req = cmd;
1641 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1642 req = d->search_request_cache_;
1643 if (req.argument().empty()) {
1644 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, "findreplace"));
1647 if (lyxfind(this, req))
1648 dr.screenUpdate(Update::Force | Update::FitCursor);
1650 d->search_request_cache_ = req;
1654 case LFUN_WORD_REPLACE: {
1655 bool has_deleted = false;
1656 if (cur.selection()) {
1657 DocIterator beg = cur.selectionBegin();
1658 DocIterator end = cur.selectionEnd();
1659 if (beg.pit() == end.pit()) {
1660 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1661 if (!cur.inMathed() && cur.paragraph().isDeleted(p)) {
1668 if (lyxreplace(this, cmd, has_deleted)) {
1669 dr.forceBufferUpdate();
1670 dr.screenUpdate(Update::Force | Update::FitCursor);
1675 case LFUN_WORD_FINDADV: {
1676 FindAndReplaceOptions opt;
1677 istringstream iss(to_utf8(cmd.argument()));
1679 if (findAdv(this, opt)) {
1680 dr.screenUpdate(Update::Force | Update::FitCursor);
1691 cur.clearSelection();
1692 dr.setMessage(from_utf8(N_("Mark off")));
1696 cur.clearSelection();
1698 dr.setMessage(from_utf8(N_("Mark on")));
1701 case LFUN_MARK_TOGGLE:
1702 cur.selection(false);
1705 dr.setMessage(from_utf8(N_("Mark removed")));
1708 dr.setMessage(from_utf8(N_("Mark set")));
1713 case LFUN_SCREEN_SHOW_CURSOR:
1717 case LFUN_SCREEN_RECENTER:
1721 case LFUN_BIBTEX_DATABASE_ADD: {
1722 Cursor tmpcur = cur;
1723 findInset(tmpcur, { BIBTEX_CODE }, false);
1724 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1727 if (inset->addDatabase(cmd.argument()))
1728 dr.forceBufferUpdate();
1733 case LFUN_BIBTEX_DATABASE_DEL: {
1734 Cursor tmpcur = cur;
1735 findInset(tmpcur, { BIBTEX_CODE }, false);
1736 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1739 if (inset->delDatabase(cmd.argument()))
1740 dr.forceBufferUpdate();
1745 case LFUN_GRAPHICS_UNIFY: {
1747 cur.recordUndoFullBuffer();
1749 DocIterator from, to;
1750 from = cur.selectionBegin();
1751 to = cur.selectionEnd();
1753 string const newId = cmd.getArg(0);
1754 bool fetchId = newId.empty(); //if we wait for groupId from first graphics inset
1756 InsetGraphicsParams grp_par;
1758 InsetGraphics::string2params(graphics::getGroupParams(buffer_, newId), buffer_, grp_par);
1760 if (!from.nextInset()) //move to closest inset
1761 from.forwardInset();
1763 while (!from.empty() && from < to) {
1764 Inset * inset = from.nextInset();
1767 InsetGraphics * ig = inset->asInsetGraphics();
1769 InsetGraphicsParams inspar = ig->getParams();
1774 grp_par.filename = inspar.filename;
1775 ig->setParams(grp_par);
1778 from.forwardInset();
1780 dr.screenUpdate(Update::Force); //needed if triggered from context menu
1784 case LFUN_STATISTICS: {
1785 DocIterator from, to;
1786 if (cur.selection()) {
1787 from = cur.selectionBegin();
1788 to = cur.selectionEnd();
1790 from = doc_iterator_begin(&buffer_);
1791 to = doc_iterator_end(&buffer_);
1793 buffer_.updateStatistics(from, to);
1794 int const words = buffer_.wordCount();
1795 int const chars = buffer_.charCount(false);
1796 int const chars_blanks = buffer_.charCount(true);
1798 if (cur.selection())
1799 message = _("Statistics for the selection:");
1801 message = _("Statistics for the document:");
1804 message += bformat(_("%1$d words"), words);
1806 message += _("One word");
1808 if (chars_blanks != 1)
1809 message += bformat(_("%1$d characters (including blanks)"),
1812 message += _("One character (including blanks)");
1815 message += bformat(_("%1$d characters (excluding blanks)"),
1818 message += _("One character (excluding blanks)");
1820 Alert::information(_("Statistics"), message);
1824 case LFUN_SCREEN_UP:
1825 case LFUN_SCREEN_DOWN: {
1826 Point p = getPos(cur);
1827 // This code has been commented out to enable to scroll down a
1828 // document, even if there are large insets in it (see bug #5465).
1829 /*if (p.y_ < 0 || p.y_ > height_) {
1830 // The cursor is off-screen so recenter before proceeding.
1834 int const scrolled = scroll(act == LFUN_SCREEN_UP
1835 ? -height_ : height_);
1836 if (act == LFUN_SCREEN_UP && scrolled > -height_)
1838 if (act == LFUN_SCREEN_DOWN && scrolled < height_)
1839 p = Point(width_, height_);
1840 bool const in_texted = cur.inTexted();
1841 cur.setCursor(doc_iterator_begin(cur.buffer()));
1842 cur.selHandle(false);
1843 // Force an immediate computation of metrics because we need it below
1844 processUpdateFlags(Update::Force);
1846 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_,
1847 true, act == LFUN_SCREEN_UP);
1848 //FIXME: what to do with cur.x_target()?
1849 bool update = in_texted && cur.bv().checkDepm(cur, old);
1852 if (update || cur.mark())
1853 dr.screenUpdate(Update::Force | Update::FitCursor);
1855 dr.forceBufferUpdate();
1860 string const scroll_type = cmd.getArg(0);
1861 int scroll_step = 0;
1862 if (scroll_type == "line")
1863 scroll_step = d->scrollbarParameters_.single_step;
1864 else if (scroll_type == "page")
1865 scroll_step = d->scrollbarParameters_.page_step;
1868 string const scroll_quantity = cmd.getArg(1);
1869 if (scroll_quantity == "up")
1870 scrollUp(scroll_step);
1871 else if (scroll_quantity == "down")
1872 scrollDown(scroll_step);
1874 int const scroll_value = convert<int>(scroll_quantity);
1876 scroll(scroll_step * scroll_value);
1878 dr.screenUpdate(Update::ForceDraw);
1879 dr.forceBufferUpdate();
1883 case LFUN_SCREEN_UP_SELECT: {
1884 // FIXME: why is the algorithm different from LFUN_SCREEN_UP?
1885 cur.selHandle(true);
1886 if (isTopScreen()) {
1887 lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1891 int y = getPos(cur).y_;
1892 int const ymin = y - height_ + defaultRowHeight();
1893 while (y > ymin && cur.up())
1897 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1901 case LFUN_SCREEN_DOWN_SELECT: {
1902 // FIXME: why is the algorithm different from LFUN_SCREEN_DOWN?
1903 cur.selHandle(true);
1904 if (isBottomScreen()) {
1905 lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1909 int y = getPos(cur).y_;
1910 int const ymax = y + height_ - defaultRowHeight();
1911 while (y < ymax && cur.down())
1915 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1920 case LFUN_INSET_SELECT_ALL: {
1921 // true if all cells are selected
1922 bool const all_selected = cur.depth() > 1
1923 && cur.selBegin().at_begin()
1924 && cur.selEnd().at_end();
1925 // true if some cells are selected
1926 bool const cells_selected = cur.depth() > 1
1927 && cur.selBegin().at_cell_begin()
1928 && cur.selEnd().at_cell_end();
1929 if (all_selected || (cells_selected && !cur.inset().isTable())) {
1930 // All the contents of the inset if selected, or only at
1931 // least one cell but inset is not a table.
1932 // Select the inset from outside.
1935 cur.selection(true);
1937 } else if (cells_selected) {
1938 // At least one complete cell is selected and inset is a table.
1944 cur.selection(true);
1945 cur.idx() = cur.lastidx();
1946 cur.pit() = cur.lastpit();
1947 cur.pos() = cur.lastpos();
1949 // select current cell
1953 cur.selection(true);
1954 cur.pit() = cur.lastpit();
1955 cur.pos() = cur.lastpos();
1957 cur.setCurrentFont();
1958 dr.screenUpdate(Update::Force);
1963 case LFUN_UNICODE_INSERT: {
1964 if (cmd.argument().empty())
1967 FuncCode code = cur.inset().currentMode() == Inset::MATH_MODE ?
1968 LFUN_MATH_INSERT : LFUN_SELF_INSERT;
1971 docstring const arg = from_utf8(cmd.getArg(i));
1975 LYXERR0("Not a hexstring: " << arg);
1979 char_type c = hexToInt(arg);
1980 if (c >= 32 && c < 0x10ffff) {
1981 LYXERR(Debug::KEY, "Inserting c: " << c);
1982 lyx::dispatch(FuncRequest(code, docstring(1, c)));
1990 // This would be in Buffer class if only Cursor did not
1991 // require a bufferview
1992 case LFUN_INSET_FORALL: {
1993 docstring const name = from_utf8(cmd.getArg(0));
1994 string const commandstr = cmd.getLongArg(1);
1995 FuncRequest const fr = lyxaction.lookupFunc(commandstr);
1997 // an arbitrary number to limit number of iterations
1998 const int max_iter = 100000;
2000 Cursor & curs = d->cursor_;
2001 Cursor const savecur = curs;
2003 if (!curs.nextInset())
2004 curs.forwardInset();
2005 curs.beginUndoGroup();
2006 while(curs && iterations < max_iter) {
2007 Inset * const ins = curs.nextInset();
2010 docstring insname = ins->layoutName();
2011 while (!insname.empty()) {
2012 if (insname == name || name == from_utf8("*")) {
2014 lyx::dispatch(fr, dr);
2018 size_t const i = insname.rfind(':');
2019 if (i == string::npos)
2021 insname = insname.substr(0, i);
2023 // if we did not delete the inset, skip it
2024 if (!curs.nextInset() || curs.nextInset() == ins)
2025 curs.forwardInset();
2029 /** This is a dummy undo record only to remember the cursor
2030 * that has just been set; this will be used on a redo action
2031 * (see ticket #10097)
2033 * FIXME: a better fix would be to have a way to set the
2034 * cursor value directly, but I am not sure it is worth it.
2037 curs.endUndoGroup();
2038 dr.screenUpdate(Update::Force);
2039 dr.forceBufferUpdate();
2041 if (iterations >= max_iter) {
2043 dr.setMessage(bformat(_("`inset-forall' interrupted because number of actions is larger than %1$d"), max_iter));
2045 dr.setMessage(bformat(_("Applied \"%1$s\" to %2$d insets"), from_utf8(commandstr), iterations));
2050 case LFUN_BRANCH_ADD_INSERT: {
2051 docstring branch_name = from_utf8(cmd.getArg(0));
2052 if (branch_name.empty())
2053 if (!Alert::askForText(branch_name, _("Branch name")) ||
2054 branch_name.empty())
2057 DispatchResult drtmp;
2058 buffer_.dispatch(FuncRequest(LFUN_BRANCH_ADD, branch_name), drtmp);
2059 if (drtmp.error()) {
2060 Alert::warning(_("Branch already exists"), drtmp.message());
2063 docstring const sep = buffer_.params().branchlist().separator();
2064 for (docstring const & branch : getVectorFromString(branch_name, sep))
2065 lyx::dispatch(FuncRequest(LFUN_BRANCH_INSERT, branch));
2069 case LFUN_KEYMAP_OFF:
2070 getIntl().keyMapOn(false);
2073 case LFUN_KEYMAP_PRIMARY:
2074 getIntl().keyMapPrim();
2077 case LFUN_KEYMAP_SECONDARY:
2078 getIntl().keyMapSec();
2081 case LFUN_KEYMAP_TOGGLE:
2082 getIntl().toggleKeyMap();
2085 case LFUN_DIALOG_SHOW_NEW_INSET: {
2086 string const name = cmd.getArg(0);
2087 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
2088 if (decodeInsetParam(name, data, buffer_))
2089 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
2091 lyxerr << "Inset type '" << name <<
2092 "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" << endl;
2096 case LFUN_CITATION_INSERT: {
2097 if (argument.empty()) {
2098 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
2101 // we can have one optional argument, delimited by '|'
2102 // citation-insert <key>|<text_before>
2103 // this should be enhanced to also support text_after
2104 // and citation style
2105 string arg = argument;
2107 if (contains(argument, "|")) {
2108 arg = token(argument, '|', 0);
2109 opt1 = token(argument, '|', 1);
2112 // if our cursor is directly in front of or behind a citation inset,
2113 // we will instead add the new key to it.
2114 Inset * inset = cur.nextInset();
2115 if (!inset || inset->lyxCode() != CITE_CODE)
2116 inset = cur.prevInset();
2117 if (inset && inset->lyxCode() == CITE_CODE) {
2118 InsetCitation * icite = static_cast<InsetCitation *>(inset);
2119 if (icite->addKey(arg)) {
2120 dr.forceBufferUpdate();
2121 dr.screenUpdate(Update::FitCursor | Update::SinglePar);
2123 LYXERR0("Discarding optional argument to citation-insert.");
2128 InsetCommandParams icp(CITE_CODE);
2129 icp["key"] = from_utf8(arg);
2131 icp["before"] = from_utf8(opt1);
2133 from_ascii(InsetCitation::last_literal ? "true" : "false");
2134 string icstr = InsetCommand::params2string(icp);
2135 FuncRequest fr(LFUN_INSET_INSERT, icstr);
2140 case LFUN_INSET_APPLY: {
2141 string const name = cmd.getArg(0);
2142 Inset * inset = editedInset(name);
2144 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
2148 // put cursor in front of inset.
2149 if (!setCursorFromInset(inset)) {
2150 LASSERT(false, break);
2153 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
2154 inset->dispatch(cur, fr);
2155 dr.screenUpdate(cur.result().screenUpdate());
2156 if (cur.result().needBufferUpdate())
2157 dr.forceBufferUpdate();
2162 // The change of language of buffer belongs to the Buffer class.
2163 // We have to do it here because we need a cursor for Undo.
2164 // When Undo::recordUndoBufferParams() is implemented someday
2165 // LFUN_BUFFER_LANGUAGE should be handled by the Buffer class.
2166 case LFUN_BUFFER_LANGUAGE: {
2167 Language const * oldL = buffer_.params().language;
2168 Language const * newL = languages.getLanguage(argument);
2169 if (!newL || oldL == newL)
2171 if (oldL->rightToLeft() == newL->rightToLeft()) {
2172 cur.recordUndoFullBuffer();
2173 buffer_.changeLanguage(oldL, newL);
2174 cur.setCurrentFont();
2175 dr.forceBufferUpdate();
2180 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
2181 case LFUN_FILE_INSERT_PLAINTEXT: {
2182 bool const as_paragraph = (act == LFUN_FILE_INSERT_PLAINTEXT_PARA);
2183 string const fname = to_utf8(cmd.argument());
2184 if (!FileName::isAbsolute(fname))
2185 dr.setMessage(_("Absolute filename expected."));
2187 insertPlaintextFile(FileName(fname), as_paragraph);
2192 // OK, so try the Buffer itself...
2193 buffer_.dispatch(cmd, dr);
2194 dispatched = dr.dispatched();
2198 buffer_.undo().endUndoGroup();
2199 dr.dispatched(dispatched);
2201 // NOTE: The code below is copied from Cursor::dispatch. If you
2202 // need to modify this, please update the other one too.
2204 // notify insets we just entered/left
2205 if (cursor() != old) {
2206 old.beginUndoGroup();
2208 bool badcursor = notifyCursorLeavesOrEnters(old, cursor());
2210 cursor().fixIfBroken();
2211 resetInlineCompletionPos();
2218 docstring BufferView::requestSelection()
2220 Cursor & cur = d->cursor_;
2222 LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
2223 if (!cur.selection()) {
2224 d->xsel_cache_.set = false;
2228 LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
2229 if (!d->xsel_cache_.set ||
2230 cur.top() != d->xsel_cache_.cursor ||
2231 cur.realAnchor().top() != d->xsel_cache_.anchor)
2233 d->xsel_cache_.cursor = cur.top();
2234 d->xsel_cache_.anchor = cur.realAnchor().top();
2235 d->xsel_cache_.set = cur.selection();
2236 return cur.selectionAsString(false);
2242 void BufferView::clearSelection()
2244 d->cursor_.clearSelection();
2245 // Clear the selection buffer. Otherwise a subsequent
2246 // middle-mouse-button paste would use the selection buffer,
2247 // not the more current external selection.
2248 cap::clearSelection();
2249 d->xsel_cache_.set = false;
2250 // The buffer did not really change, but this causes the
2251 // redraw we need because we cleared the selection above.
2252 buffer_.changed(false);
2256 void BufferView::resize(int width, int height)
2258 // Update from work area
2262 // Clear the paragraph height cache.
2263 d->par_height_.clear();
2264 // Redo the metrics.
2269 Inset const * BufferView::getCoveringInset(Text const & text,
2272 TextMetrics & tm = d->text_metrics_[&text];
2273 Inset * inset = tm.checkInsetHit(x, y);
2277 if (!inset->descendable(*this))
2278 // No need to go further down if the inset is not
2282 size_t cell_number = inset->nargs();
2283 // Check all the inner cell.
2284 for (size_t i = 0; i != cell_number; ++i) {
2285 Text const * inner_text = inset->getText(i);
2288 Inset const * inset_deeper =
2289 getCoveringInset(*inner_text, x, y);
2291 return inset_deeper;
2299 void BufferView::updateHoveredInset() const
2301 // Get inset under mouse, if there is one.
2302 int const x = d->mouse_position_cache_.x_;
2303 int const y = d->mouse_position_cache_.y_;
2304 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
2306 d->clickable_inset_ = covering_inset && covering_inset->clickable(*this, x, y);
2308 if (covering_inset == d->last_inset_)
2309 // Same inset, no need to do anything...
2312 bool need_redraw = false;
2313 if (d->last_inset_) {
2314 // Remove the hint on the last hovered inset (if any).
2315 need_redraw |= d->last_inset_->setMouseHover(this, false);
2316 d->last_inset_ = nullptr;
2319 if (covering_inset && covering_inset->setMouseHover(this, true)) {
2321 // Only the insets that accept the hover state, do
2322 // clear the last_inset_, so only set the last_inset_
2323 // member if the hovered setting is accepted.
2324 d->last_inset_ = covering_inset;
2328 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
2329 << d->mouse_position_cache_.x_ << ", "
2330 << d->mouse_position_cache_.y_ << ")");
2332 d->update_strategy_ = DecorationUpdate;
2334 // This event (moving without mouse click) is not passed further.
2335 // This should be changed if it is further utilized.
2336 buffer_.changed(false);
2341 void BufferView::clearLastInset(Inset * inset) const
2343 if (d->last_inset_ != inset) {
2344 LYXERR0("Wrong last_inset!");
2347 d->last_inset_ = nullptr;
2351 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
2353 //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
2355 // This is only called for mouse related events including
2356 // LFUN_FILE_OPEN generated by drag-and-drop.
2357 FuncRequest cmd = cmd0;
2359 Cursor old = cursor();
2361 cur.push(buffer_.inset());
2362 cur.selection(d->cursor_.selection());
2364 // Either the inset under the cursor or the
2365 // surrounding Text will handle this event.
2367 // make sure we stay within the screen...
2368 cmd.set_y(min(max(cmd.y(), -1), height_));
2370 d->mouse_position_cache_.x_ = cmd.x();
2371 d->mouse_position_cache_.y_ = cmd.y();
2373 if (cmd.action() == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
2374 updateHoveredInset();
2378 // Build temporary cursor.
2379 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x(), cmd.y());
2381 // If inset is not editable, cur.pos() might point behind the
2382 // inset (depending on cmd.x(), cmd.y()). This is needed for
2383 // editing to fix bug 9628, but e.g. the context menu needs a
2384 // cursor in front of the inset.
2385 if ((inset->hasSettings() || !inset->contextMenuName().empty()
2386 || inset->lyxCode() == SEPARATOR_CODE) &&
2387 cur.nextInset() != inset && cur.prevInset() == inset)
2389 } else if (cur.inTexted() && cur.pos()
2390 && cur.paragraph().isEnvSeparator(cur.pos() - 1)) {
2391 // Always place cursor in front of a separator inset.
2395 // Put anchor at the same position.
2398 cur.beginUndoGroup();
2400 // Try to dispatch to an non-editable inset near this position
2401 // via the temp cursor. If the inset wishes to change the real
2402 // cursor it has to do so explicitly by using
2403 // cur.bv().cursor() = cur; (or similar)
2405 inset->dispatch(cur, cmd);
2407 // Now dispatch to the temporary cursor. If the real cursor should
2408 // be modified, the inset's dispatch has to do so explicitly.
2409 if (!inset || !cur.result().dispatched())
2412 // Notify left insets
2414 bool badcursor = old.fixIfBroken() | cur.fixIfBroken();
2415 badcursor |= notifyCursorLeavesOrEnters(old, cur);
2417 cursor().fixIfBroken();
2422 // Do we have a selection?
2423 theSelection().haveSelection(cursor().selection());
2425 if (cur.needBufferUpdate()) {
2426 cur.clearBufferUpdate();
2427 buffer().updateBuffer();
2430 // If the command has been dispatched,
2431 if (cur.result().dispatched() || cur.result().screenUpdate())
2432 processUpdateFlags(cur.result().screenUpdate());
2436 int BufferView::minVisiblePart()
2438 return 2 * defaultRowHeight();
2442 int BufferView::scroll(int y)
2445 return scrollDown(y);
2447 return scrollUp(-y);
2452 int BufferView::scrollDown(int offset)
2454 Text * text = &buffer_.text();
2455 TextMetrics & tm = d->text_metrics_[text];
2456 int const ymax = height_ + offset;
2458 pair<pit_type, ParagraphMetrics const *> last = tm.last();
2459 int bottom_pos = last.second->position() + last.second->descent();
2460 if (lyxrc.scroll_below_document)
2461 bottom_pos += height_ - minVisiblePart();
2462 if (last.first + 1 == int(text->paragraphs().size())) {
2463 if (bottom_pos <= height_)
2465 offset = min(offset, bottom_pos - height_);
2468 if (bottom_pos > ymax)
2470 tm.newParMetricsDown();
2472 d->anchor_ypos_ -= offset;
2477 int BufferView::scrollUp(int offset)
2479 Text * text = &buffer_.text();
2480 TextMetrics & tm = d->text_metrics_[text];
2481 int ymin = - offset;
2483 pair<pit_type, ParagraphMetrics const *> first = tm.first();
2484 int top_pos = first.second->position() - first.second->ascent();
2485 if (first.first == 0) {
2488 offset = min(offset, - top_pos);
2493 tm.newParMetricsUp();
2495 d->anchor_ypos_ += offset;
2500 bool BufferView::setCursorFromRow(int row)
2502 TexRow::TextEntry start, end;
2503 tie(start,end) = buffer_.texrow().getEntriesFromRow(row);
2504 LYXERR(Debug::LATEX,
2505 "setCursorFromRow: for row " << row << ", TexRow has found "
2506 "start (id=" << start.id << ",pos=" << start.pos << "), "
2507 "end (id=" << end.id << ",pos=" << end.pos << ")");
2508 return setCursorFromEntries(start, end);
2512 bool BufferView::setCursorFromEntries(TexRow::TextEntry start,
2513 TexRow::TextEntry end)
2515 DocIterator dit_start, dit_end;
2516 tie(dit_start,dit_end) =
2517 TexRow::getDocIteratorsFromEntries(start, end, buffer_);
2520 // Setting selection start
2521 d->cursor_.clearSelection();
2522 setCursor(dit_start);
2523 // Setting selection end
2525 d->cursor_.resetAnchor();
2526 setCursorSelectionTo(dit_end);
2532 bool BufferView::setCursorFromInset(Inset const * inset)
2534 // are we already there?
2535 if (cursor().nextInset() == inset)
2538 // Inset is not at cursor position. Find it in the document.
2541 while (cur && cur.nextInset() != inset)
2552 void BufferView::gotoLabel(docstring const & label)
2555 bool have_inactive = false;
2556 for (Buffer const * buf : buffer().allRelatives()) {
2558 for (TocItem const & item : *buf->tocBackend().toc("label")) {
2559 if (label == item.str() && item.isOutput()) {
2560 lyx::dispatch(item.action());
2563 // If we find an inactive label, save it for the case
2564 // that no active one is there
2565 if (label == item.str() && !have_inactive) {
2566 have_inactive = true;
2567 action = item.action();
2571 // We only found an inactive label. Go there.
2573 lyx::dispatch(action);
2577 TextMetrics const & BufferView::textMetrics(Text const * t) const
2579 return const_cast<BufferView *>(this)->textMetrics(t);
2583 TextMetrics & BufferView::textMetrics(Text const * t)
2586 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
2587 if (tmc_it == d->text_metrics_.end()) {
2588 tmc_it = d->text_metrics_.emplace(std::piecewise_construct,
2589 std::forward_as_tuple(t),
2590 std::forward_as_tuple(this, const_cast<Text *>(t))).first;
2592 return tmc_it->second;
2596 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
2599 return textMetrics(t).parMetrics(pit);
2603 int BufferView::workHeight() const
2609 void BufferView::setCursor(DocIterator const & dit)
2612 size_t const n = dit.depth();
2613 for (size_t i = 0; i < n; ++i)
2614 dit[i].inset().edit(d->cursor_, true);
2616 d->cursor_.setCursor(dit);
2617 d->cursor_.selection(false);
2618 d->cursor_.setCurrentFont();
2620 // It seems on general grounds as if this is probably needed, but
2621 // it is not yet clear.
2622 // See bug #7394 and r38388.
2623 // d->cursor.resetAnchor();
2627 void BufferView::setCursorSelectionTo(DocIterator const & dit)
2629 size_t const n = dit.depth();
2630 for (size_t i = 0; i < n; ++i)
2631 dit[i].inset().edit(d->cursor_, true);
2633 d->cursor_.selection(true);
2634 d->cursor_.setCursorSelectionTo(dit);
2635 d->cursor_.setCurrentFont();
2639 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
2641 // Would be wrong to delete anything if we have a selection.
2642 if (cur.selection())
2645 bool need_anchor_change = false;
2646 bool changed = Text::deleteEmptyParagraphMechanism(cur, old,
2647 need_anchor_change);
2649 if (need_anchor_change)
2657 // we would rather not do this here, but it needs to be done before
2658 // the changed() signal is sent.
2659 buffer_.updateBuffer();
2661 buffer_.changed(true);
2666 bool BufferView::mouseSetCursor(Cursor & cur, bool const select)
2668 LASSERT(&cur.bv() == this, return false);
2671 // this event will clear selection so we save selection for
2672 // persistent selection
2673 cap::saveSelection(cursor());
2675 d->cursor_.macroModeClose();
2676 // If a macro has been finalized, the cursor might have been broken
2679 // Has the cursor just left the inset?
2680 bool const leftinset = (&d->cursor_.inset() != &cur.inset());
2682 d->cursor_.fixIfBroken();
2684 // do the dEPM magic if needed
2685 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
2686 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
2687 // the leftinset bool would not be necessary (badcursor instead).
2688 bool update = leftinset;
2691 d->cursor_.setSelection();
2692 d->cursor_.setCursorSelectionTo(cur);
2694 if (d->cursor_.inTexted())
2695 update |= checkDepm(cur, d->cursor_);
2696 d->cursor_.resetAnchor();
2697 d->cursor_.setCursor(cur);
2698 d->cursor_.clearSelection();
2700 d->cursor_.boundary(cur.boundary());
2701 d->cursor_.finishUndo();
2702 d->cursor_.setCurrentFont();
2704 cur.forceBufferUpdate();
2709 void BufferView::putSelectionAt(DocIterator const & cur,
2710 int length, bool backwards)
2712 d->cursor_.clearSelection();
2718 d->cursor_.pos() += length;
2719 d->cursor_.setSelection(d->cursor_, -length);
2721 d->cursor_.setSelection(d->cursor_, length);
2726 bool BufferView::selectIfEmpty(DocIterator & cur)
2728 if ((cur.inTexted() && !cur.paragraph().empty())
2729 || (cur.inMathed() && !cur.cell().empty()))
2732 pit_type const beg_pit = cur.pit();
2734 // The paragraph associated to this item isn't
2735 // the first one, so it can be selected
2738 // We have to resort to select the space between the
2739 // end of this item and the begin of the next one
2743 // If it is the only item in the document,
2744 // nothing can be selected
2747 pit_type const end_pit = cur.pit();
2748 pos_type const end_pos = cur.pos();
2749 d->cursor_.clearSelection();
2751 d->cursor_.setCursor(cur);
2752 d->cursor_.pit() = beg_pit;
2753 d->cursor_.pos() = 0;
2754 d->cursor_.selection(false);
2755 d->cursor_.resetAnchor();
2756 d->cursor_.pit() = end_pit;
2757 d->cursor_.pos() = end_pos;
2758 d->cursor_.setSelection();
2763 Cursor & BufferView::cursor()
2769 Cursor const & BufferView::cursor() const
2775 bool BufferView::singleParUpdate()
2777 Text & buftext = buffer_.text();
2778 pit_type const bottom_pit = d->cursor_.bottom().pit();
2779 TextMetrics & tm = textMetrics(&buftext);
2780 Dimension const old_dim = tm.parMetrics(bottom_pit).dim();
2782 // make sure inline completion pointer is ok
2783 if (d->inlineCompletionPos_.fixIfBroken())
2784 d->inlineCompletionPos_ = DocIterator();
2786 // In Single Paragraph mode, rebreak only
2787 // the (main text, not inset!) paragraph containing the cursor.
2788 // (if this paragraph contains insets etc., rebreaking will
2789 // recursively descend)
2790 tm.redoParagraph(bottom_pit);
2791 ParagraphMetrics & pm = tm.parMetrics(bottom_pit);
2792 if (pm.height() != old_dim.height()) {
2793 // Paragraph height has changed so we cannot proceed to
2794 // the singlePar optimisation.
2797 // Since position() points to the baseline of the first row, we
2798 // may have to update it. See ticket #11601 for an example where
2799 // the height does not change but the ascent does.
2800 pm.setPosition(pm.position() - old_dim.ascent() + pm.ascent());
2802 tm.updatePosCache(bottom_pit);
2804 LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
2805 << " y2: " << pm.position() + pm.descent()
2806 << " pit: " << bottom_pit
2807 << " singlepar: 1");
2812 void BufferView::updateMetrics()
2814 updateMetrics(d->update_flags_);
2815 d->update_strategy_ = FullScreenUpdate;
2819 void BufferView::updateMetrics(Update::flags & update_flags)
2821 if (height_ == 0 || width_ == 0)
2824 Text & buftext = buffer_.text();
2825 pit_type const npit = int(buftext.paragraphs().size());
2827 // Clear out the position cache in case of full screen redraw,
2828 d->coord_cache_.clear();
2829 d->math_rows_.clear();
2831 // Clear out paragraph metrics to avoid having invalid metrics
2832 // in the cache from paragraphs not relayouted below
2833 // The complete text metrics will be redone.
2834 d->text_metrics_.clear();
2836 TextMetrics & tm = textMetrics(&buftext);
2838 // make sure inline completion pointer is ok
2839 if (d->inlineCompletionPos_.fixIfBroken())
2840 d->inlineCompletionPos_ = DocIterator();
2842 if (d->anchor_pit_ >= npit)
2843 // The anchor pit must have been deleted...
2844 d->anchor_pit_ = npit - 1;
2846 // Rebreak anchor paragraph.
2847 tm.redoParagraph(d->anchor_pit_);
2848 ParagraphMetrics & anchor_pm = tm.parMetrics(d->anchor_pit_);
2851 if (d->anchor_pit_ == 0) {
2852 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
2854 // Complete buffer visible? Then it's easy.
2855 if (scrollRange == 0)
2856 d->anchor_ypos_ = anchor_pm.ascent();
2858 // avoid empty space above the first row
2859 d->anchor_ypos_ = min(d->anchor_ypos_, anchor_pm.ascent());
2862 anchor_pm.setPosition(d->anchor_ypos_);
2863 tm.updatePosCache(d->anchor_pit_);
2865 LYXERR(Debug::PAINTING, "metrics: "
2866 << " anchor pit = " << d->anchor_pit_
2867 << " anchor ypos = " << d->anchor_ypos_);
2869 // Redo paragraphs above anchor if necessary.
2870 int y1 = d->anchor_ypos_ - anchor_pm.ascent();
2871 // We are now just above the anchor paragraph.
2872 pit_type pit1 = d->anchor_pit_ - 1;
2873 for (; pit1 >= 0 && y1 >= 0; --pit1) {
2874 tm.redoParagraph(pit1);
2875 ParagraphMetrics & pm = tm.parMetrics(pit1);
2877 // Save the paragraph position in the cache.
2879 tm.updatePosCache(pit1);
2883 // Redo paragraphs below the anchor if necessary.
2884 int y2 = d->anchor_ypos_ + anchor_pm.descent();
2885 // We are now just below the anchor paragraph.
2886 pit_type pit2 = d->anchor_pit_ + 1;
2887 for (; pit2 < npit && y2 <= height_; ++pit2) {
2888 tm.redoParagraph(pit2);
2889 ParagraphMetrics & pm = tm.parMetrics(pit2);
2891 // Save the paragraph position in the cache.
2893 tm.updatePosCache(pit2);
2897 LYXERR(Debug::PAINTING, "Metrics: "
2898 << " anchor pit = " << d->anchor_pit_
2899 << " anchor ypos = " << d->anchor_ypos_
2902 << " pit1 = " << pit1
2903 << " pit2 = " << pit2);
2905 // metrics is done, full drawing is necessary now
2906 update_flags = (update_flags & ~Update::Force) | Update::ForceDraw;
2908 // Now update the positions of insets in the cache.
2911 if (lyxerr.debugging(Debug::WORKAREA)) {
2912 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
2913 d->coord_cache_.dump();
2918 void BufferView::updatePosCache()
2920 // this is the "nodraw" drawing stage: only set the positions of the
2921 // insets in metrics cache.
2922 frontend::NullPainter np;
2927 void BufferView::insertLyXFile(FileName const & fname, bool const ignorelang)
2929 LASSERT(d->cursor_.inTexted(), return);
2931 // Get absolute path of file and add ".lyx"
2932 // to the filename if necessary
2933 FileName filename = fileSearch(string(), fname.absFileName(), "lyx");
2935 docstring const disp_fn = makeDisplayPath(filename.absFileName());
2936 // emit message signal.
2937 message(bformat(_("Inserting document %1$s..."), disp_fn));
2940 Buffer buf(filename.absFileName(), false);
2941 if (buf.loadLyXFile() == Buffer::ReadSuccess) {
2942 ErrorList & el = buffer_.errorList("Parse");
2943 // Copy the inserted document error list into the current buffer one.
2944 el = buf.errorList("Parse");
2945 ParagraphList & pars = buf.paragraphs();
2947 // set main language of imported file to context language
2948 buf.changeLanguage(buf.language(), d->cursor_.getFont().language());
2949 buffer_.undo().recordUndo(d->cursor_);
2950 cap::pasteParagraphList(d->cursor_, pars,
2951 buf.params().documentClassPtr(), el);
2952 res = _("Document %1$s inserted.");
2954 res = _("Could not insert document %1$s");
2957 buffer_.changed(true);
2958 // emit message signal.
2959 message(bformat(res, disp_fn));
2963 Point BufferView::coordOffset(DocIterator const & dit) const
2969 // Addup contribution of nested insets, from inside to outside,
2970 // keeping the outer paragraph for a special handling below
2971 for (size_t i = dit.depth() - 1; i >= 1; --i) {
2972 CursorSlice const & sl = dit[i];
2976 // get relative position inside sl.inset()
2977 sl.inset().cursorPos(*this, sl, dit.boundary() && (i + 1 == dit.depth()), xx, yy);
2979 // Make relative position inside of the edited inset relative to sl.inset()
2983 // In case of an RTL inset, the edited inset will be positioned to the left
2986 bool boundary_i = dit.boundary() && i + 1 == dit.depth();
2987 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2992 // remember width for the case that sl.inset() is positioned in an RTL inset
2993 lastw = sl.inset().dimension(*this).wid;
2995 //lyxerr << "Cursor::getPos, i: "
2996 // << i << " x: " << xx << " y: " << y << endl;
2999 // Add contribution of initial rows of outermost paragraph
3000 CursorSlice const & sl = dit[0];
3001 TextMetrics const & tm = textMetrics(sl.text());
3002 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
3004 LBUFERR(!pm.rows().empty());
3005 y -= pm.rows()[0].ascent();
3007 // FIXME: document this mess
3009 if (sl.pos() > 0 && dit.depth() == 1) {
3011 if (pos && dit.boundary())
3013 // lyxerr << "coordOffset: boundary:" << dit.boundary() << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
3014 rend = pm.pos2row(pos);
3016 rend = pm.pos2row(sl.pos());
3018 size_t rend = pm.pos2row(sl.pos());
3020 for (size_t rit = 0; rit != rend; ++rit)
3021 y += pm.rows()[rit].height();
3022 y += pm.rows()[rend].ascent();
3024 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
3026 // Make relative position from the nested inset now bufferview absolute.
3027 int xx = bottom_tm.cursorX(dit.bottom(), dit.boundary() && dit.depth() == 1);
3030 // In the RTL case place the nested inset at the left of the cursor in
3031 // the outer paragraph
3032 bool boundary_1 = dit.boundary() && 1 == dit.depth();
3033 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
3041 Point BufferView::getPos(DocIterator const & dit) const
3043 if (!paragraphVisible(dit))
3044 return Point(-1, -1);
3046 CursorSlice const & bot = dit.bottom();
3047 TextMetrics const & tm = textMetrics(bot.text());
3049 // offset from outer paragraph
3050 Point p = coordOffset(dit);
3051 p.y_ += tm.parMetrics(bot.pit()).position();
3056 bool BufferView::paragraphVisible(DocIterator const & dit) const
3058 CursorSlice const & bot = dit.bottom();
3059 TextMetrics const & tm = textMetrics(bot.text());
3061 return tm.contains(bot.pit());
3065 void BufferView::caretPosAndHeight(Point & p, int & h) const
3068 Cursor const & cur = cursor();
3069 if (cur.inMathed()) {
3070 MathRow const & mrow = mathRow(&cur.cell());
3071 asc = mrow.caret_ascent;
3072 des = mrow.caret_descent;
3074 Font const font = cur.real_current_font;
3075 frontend::FontMetrics const & fm = theFontMetrics(font);
3076 asc = fm.maxAscent();
3077 des = fm.maxDescent();
3085 bool BufferView::caretInView() const
3087 if (!paragraphVisible(cursor()))
3091 caretPosAndHeight(p, h);
3093 // does the cursor touch the screen ?
3094 if (p.y_ + h < 0 || p.y_ >= workHeight())
3100 int BufferView::horizScrollOffset() const
3102 return d->horiz_scroll_offset_;
3106 int BufferView::horizScrollOffset(Text const * text,
3107 pit_type pit, pos_type pos) const
3109 // Is this a row that is currently scrolled?
3110 if (!d->current_row_slice_.empty()
3111 && &text->inset() == d->current_row_slice_.inset().asInsetText()
3112 && pit == d->current_row_slice_.pit()
3113 && pos == d->current_row_slice_.pos())
3114 return d->horiz_scroll_offset_;
3119 void BufferView::setCurrentRowSlice(CursorSlice const & rowSlice)
3121 // nothing to do if the cursor was already on this row
3122 if (d->current_row_slice_ == rowSlice)
3125 // if the (previous) current row was scrolled, we have to
3126 // remember it in order to repaint it next time.
3127 if (d->horiz_scroll_offset_ != 0) {
3128 // search the old row in cache and mark it changed
3129 for (auto & tm_pair : d->text_metrics_) {
3130 if (&tm_pair.first->inset() == rowSlice.inset().asInsetText()) {
3131 tm_pair.second.setRowChanged(rowSlice.pit(), rowSlice.pos());
3132 // We found it, no need to continue.
3138 // Since we changed row, the scroll offset is not valid anymore
3139 d->horiz_scroll_offset_ = 0;
3140 d->current_row_slice_ = rowSlice;
3144 void BufferView::checkCursorScrollOffset()
3146 CursorSlice rowSlice = d->cursor_.bottom();
3147 TextMetrics const & tm = textMetrics(rowSlice.text());
3149 // Stop if metrics have not been computed yet, since it means
3150 // that there is nothing to do.
3151 if (!tm.contains(rowSlice.pit()))
3153 ParagraphMetrics const & pm = tm.parMetrics(rowSlice.pit());
3154 Row const & row = pm.getRow(rowSlice.pos(),
3155 d->cursor_.boundary() && rowSlice == d->cursor_.top());
3156 rowSlice.pos() = row.pos();
3158 // Set the row on which the cursor lives.
3159 setCurrentRowSlice(rowSlice);
3161 // Current x position of the cursor in pixels
3162 int cur_x = getPos(d->cursor_).x_;
3164 // Horizontal scroll offset of the cursor row in pixels
3165 int offset = d->horiz_scroll_offset_;
3166 int const MARGIN = 2 * theFontMetrics(d->cursor_.real_current_font).em()
3168 if (row.right_x() <= workWidth() - row.right_margin) {
3169 // Row is narrower than the work area, no offset needed.
3172 if (cur_x - offset < MARGIN) {
3173 // cursor would be too far right
3174 offset = cur_x - MARGIN;
3175 } else if (cur_x - offset > workWidth() - MARGIN) {
3176 // cursor would be too far left
3177 offset = cur_x - workWidth() + MARGIN;
3179 // Correct the offset to make sure that we do not scroll too much
3182 if (row.right_x() - offset < workWidth() - row.right_margin)
3183 offset = row.right_x() - workWidth() + row.right_margin;
3186 //lyxerr << "cur_x=" << cur_x << ", offset=" << offset << ", row.wid=" << row.width() << ", margin=" << MARGIN << endl;
3188 if (offset != d->horiz_scroll_offset_)
3189 LYXERR(Debug::PAINTING, "Horiz. scroll offset changed from "
3190 << d->horiz_scroll_offset_ << " to " << offset);
3192 if (d->update_strategy_ == NoScreenUpdate
3193 && offset != d->horiz_scroll_offset_) {
3194 // FIXME: if one uses SingleParUpdate, then home/end
3195 // will not work on long rows. Why?
3196 d->update_strategy_ = FullScreenUpdate;
3199 d->horiz_scroll_offset_ = offset;
3203 void BufferView::draw(frontend::Painter & pain, bool paint_caret)
3205 if (height_ == 0 || width_ == 0)
3207 LYXERR(Debug::PAINTING, (pain.isNull() ? "\t\t--- START NODRAW ---"
3208 : "\t\t*** START DRAWING ***"));
3209 Text & text = buffer_.text();
3210 TextMetrics const & tm = d->text_metrics_[&text];
3211 int const y = tm.first().second->position();
3212 PainterInfo pi(this, pain);
3214 // Check whether the row where the cursor lives needs to be scrolled.
3215 // Update the drawing strategy if needed.
3216 checkCursorScrollOffset();
3218 switch (d->update_strategy_) {
3220 case NoScreenUpdate:
3221 // no screen painting is actually needed. In nodraw stage
3222 // however, the different coordinates of insets and paragraphs
3223 // needs to be updated.
3224 LYXERR(Debug::PAINTING, "Strategy: NoScreenUpdate");
3225 if (pain.isNull()) {
3226 pi.full_repaint = true;
3229 pi.full_repaint = false;
3234 case SingleParUpdate:
3235 pi.full_repaint = false;
3236 LYXERR(Debug::PAINTING, "Strategy: SingleParUpdate");
3237 // In general, only the current row of the outermost paragraph
3238 // will be redrawn. Particular cases where selection spans
3239 // multiple paragraph are correctly detected in TextMetrics.
3243 case DecorationUpdate:
3244 // FIXME: We should also distinguish DecorationUpdate to avoid text
3245 // drawing if possible. This is not possible to do easily right now
3246 // because of the single backing pixmap.
3248 case FullScreenUpdate:
3250 LYXERR(Debug::PAINTING,
3251 ((d->update_strategy_ == FullScreenUpdate)
3252 ? "Strategy: FullScreenUpdate"
3253 : "Strategy: DecorationUpdate"));
3255 // The whole screen, including insets, will be refreshed.
3256 pi.full_repaint = true;
3258 // Clear background.
3259 pain.fillRectangle(0, 0, width_, height_,
3260 pi.backgroundColor(&buffer_.inset()));
3265 // and possibly grey out below
3266 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3267 int const y2 = lastpm.second->position() + lastpm.second->descent();
3270 Color color = buffer().isInternal()
3271 ? Color_background : Color_bottomarea;
3272 pain.fillRectangle(0, y2, width_, height_ - y2, color);
3276 LYXERR(Debug::PAINTING, (pain.isNull() ? "\t\t --- END NODRAW ---"
3277 : "\t\t *** END DRAWING ***"));
3279 // The scrollbar needs an update.
3282 // Normalize anchor for next time
3283 pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
3284 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3285 for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
3286 ParagraphMetrics const & pm = tm.parMetrics(pit);
3287 if (pm.position() + pm.descent() > 0) {
3288 if (d->anchor_pit_ != pit
3289 || d->anchor_ypos_ != pm.position())
3290 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
3291 << " anchor ypos = " << d->anchor_ypos_);
3292 d->anchor_pit_ = pit;
3293 d->anchor_ypos_ = pm.position();
3297 if (!pain.isNull()) {
3298 // reset the update flags, everything has been done
3299 d->update_flags_ = Update::None;
3302 // If a caret has to be painted, mark its text row as dirty to
3303 //make sure that it will be repainted on next redraw.
3304 /* FIXME: investigate whether this can be avoided when the cursor did not
3308 Row const & caret_row = d->cursor_.textRow();
3309 caret_row.changed(true);
3314 void BufferView::message(docstring const & msg)
3317 d->gui_->message(msg);
3321 void BufferView::showDialog(string const & name)
3324 d->gui_->showDialog(name, string());
3328 void BufferView::showDialog(string const & name,
3329 string const & data, Inset * inset)
3332 d->gui_->showDialog(name, data, inset);
3336 void BufferView::updateDialog(string const & name, string const & data)
3339 d->gui_->updateDialog(name, data);
3343 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
3349 // FIXME: Move this out of BufferView again
3350 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
3352 if (!fname.isReadableFile()) {
3353 docstring const error = from_ascii(strerror(errno));
3354 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3355 docstring const text =
3356 bformat(_("Could not read the specified document\n"
3357 "%1$s\ndue to the error: %2$s"), file, error);
3358 Alert::error(_("Could not read file"), text);
3362 if (!fname.isReadableFile()) {
3363 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3364 docstring const text =
3365 bformat(_("%1$s\n is not readable."), file);
3366 Alert::error(_("Could not open file"), text);
3370 // FIXME UNICODE: We don't know the encoding of the file
3371 docstring file_content = fname.fileContents("UTF-8");
3372 if (file_content.empty()) {
3373 Alert::error(_("Reading not UTF-8 encoded file"),
3374 _("The file is not UTF-8 encoded.\n"
3375 "It will be read as local 8Bit-encoded.\n"
3376 "If this does not give the correct result\n"
3377 "then please change the encoding of the file\n"
3378 "to UTF-8 with a program other than LyX.\n"));
3379 file_content = fname.fileContents("local8bit");
3382 return normalize_c(file_content);
3386 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
3388 docstring const tmpstr = contentsOfPlaintextFile(f);
3393 Cursor & cur = cursor();
3394 cap::replaceSelection(cur);
3395 buffer_.undo().recordUndo(cur);
3397 cur.innerText()->insertStringAsParagraphs(cur, tmpstr, cur.current_font);
3399 cur.innerText()->insertStringAsLines(cur, tmpstr, cur.current_font);
3401 buffer_.changed(true);
3405 docstring const & BufferView::inlineCompletion() const
3407 return d->inlineCompletion_;
3411 size_t const & BufferView::inlineCompletionUniqueChars() const
3413 return d->inlineCompletionUniqueChars_;
3417 DocIterator const & BufferView::inlineCompletionPos() const
3419 return d->inlineCompletionPos_;
3423 void BufferView::resetInlineCompletionPos()
3425 d->inlineCompletionPos_ = DocIterator();
3429 bool samePar(DocIterator const & a, DocIterator const & b)
3431 if (a.empty() && b.empty())
3433 if (a.empty() || b.empty())
3435 if (a.depth() != b.depth())
3437 return &a.innerParagraph() == &b.innerParagraph();
3441 void BufferView::setInlineCompletion(Cursor const & cur, DocIterator const & pos,
3442 docstring const & completion, size_t uniqueChars)
3444 uniqueChars = min(completion.size(), uniqueChars);
3445 bool changed = d->inlineCompletion_ != completion
3446 || d->inlineCompletionUniqueChars_ != uniqueChars;
3447 bool singlePar = true;
3448 d->inlineCompletion_ = completion;
3449 d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
3451 //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
3454 DocIterator const & old = d->inlineCompletionPos_;
3456 //lyxerr << "inlineCompletionPos changed" << std::endl;
3457 // old or pos are in another paragraph?
3458 if ((!samePar(cur, pos) && !pos.empty())
3459 || (!samePar(cur, old) && !old.empty())) {
3461 //lyxerr << "different paragraph" << std::endl;
3463 d->inlineCompletionPos_ = pos;
3468 if (singlePar && !(cur.result().screenUpdate() & Update::Force))
3469 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
3471 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::Force);
3476 bool BufferView::clickableInset() const
3478 return d->clickable_inset_;