3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Alfredo Braunstein
7 * \author Lars Gullik Bjønnes
10 * \author Jürgen Vigna
12 * Full author contact details are available in file CREDITS.
17 #include "BufferView.h"
19 #include "BranchList.h"
21 #include "BufferList.h"
22 #include "BufferParams.h"
23 #include "BiblioInfo.h"
24 #include "CoordCache.h"
26 #include "CutAndPaste.h"
27 #include "DispatchResult.h"
28 #include "ErrorList.h"
29 #include "FuncRequest.h"
30 #include "FuncStatus.h"
33 #include "LayoutFile.h"
36 #include "LyXAction.h"
39 #include "MetricsInfo.h"
40 #include "Paragraph.h"
42 #include "texstream.h"
44 #include "TextMetrics.h"
46 #include "TocBackend.h"
48 #include "insets/InsetBibtex.h"
49 #include "insets/InsetCitation.h"
50 #include "insets/InsetCommand.h" // ChangeRefs
51 #include "insets/InsetGraphics.h"
52 #include "insets/InsetIndex.h"
53 #include "insets/InsetRef.h"
54 #include "insets/InsetText.h"
56 #include "mathed/InsetMathNest.h"
57 #include "mathed/InsetMathRef.h"
58 #include "mathed/MathData.h"
59 #include "mathed/MathRow.h"
61 #include "frontends/alert.h"
62 #include "frontends/CaretGeometry.h"
63 #include "frontends/Delegates.h"
64 #include "frontends/FontMetrics.h"
65 #include "frontends/NullPainter.h"
66 #include "frontends/Painter.h"
67 #include "frontends/Selection.h"
68 #include "frontends/Clipboard.h"
70 #include "support/convert.h"
71 #include "support/debug.h"
72 #include "support/docstring.h"
73 #include "support/docstring_list.h"
74 #include "support/filetools.h"
75 #include "support/gettext.h"
76 #include "support/lassert.h"
77 #include "support/Length.h"
78 #include "support/lstrings.h"
79 #include "support/lyxlib.h"
80 #include "support/types.h"
92 using namespace lyx::support;
96 namespace Alert = frontend::Alert;
100 /// Return an inset of this class if it exists at the current cursor position
102 T * getInsetByCode(Cursor const & cur, InsetCode code)
104 DocIterator it = cur;
105 Inset * inset = it.nextInset();
106 if (inset && inset->lyxCode() == code)
107 return static_cast<T*>(inset);
112 /// Note that comparing contents can only be used for InsetCommand
113 bool findNextInset(DocIterator & dit, vector<InsetCode> const & codes,
114 docstring const & contents)
116 DocIterator tmpdit = dit;
119 Inset const * inset = tmpdit.nextInset();
121 bool const valid_code = std::find(codes.begin(), codes.end(),
122 inset->lyxCode()) != codes.end();
123 InsetCommand const * ic = inset->asInsetCommand();
124 bool const same_or_no_contents = contents.empty()
125 || (ic && (ic->getFirstNonOptParam() == contents));
127 if (valid_code && same_or_no_contents) {
132 tmpdit.forwardInset();
139 /// Looks for next inset with one of the given codes.
140 /// Note that same_content can only be used for InsetCommand
141 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
145 DocIterator tmpdit = dit;
146 tmpdit.forwardInset();
150 Inset const * inset = tmpdit.nextInset();
151 if (same_content && inset) {
152 InsetCommand const * ic = inset->asInsetCommand();
154 bool const valid_code = std::find(codes.begin(), codes.end(),
155 ic->lyxCode()) != codes.end();
157 contents = ic->getFirstNonOptParam();
161 if (!findNextInset(tmpdit, codes, contents)) {
162 if (dit.depth() != 1 || dit.pit() != 0 || dit.pos() != 0) {
163 inset = &tmpdit.bottom().inset();
164 tmpdit = doc_iterator_begin(&inset->buffer(), inset);
165 if (!findNextInset(tmpdit, codes, contents))
177 /// Moves cursor to the next inset with one of the given codes.
178 bool gotoInset(BufferView * bv, vector<InsetCode> const & codes,
181 Cursor tmpcur = bv->cursor();
182 if (!findInset(tmpcur, codes, same_content)) {
183 bv->cursor().message(_("No more insets"));
187 tmpcur.clearSelection();
188 bv->setCursor(tmpcur);
189 return bv->scrollToCursor(bv->cursor(), SCROLL_TOP);
193 /// A map from a Text to the associated text metrics
194 typedef map<Text const *, TextMetrics> TextMetricsCache;
196 enum ScreenUpdateStrategy {
206 /////////////////////////////////////////////////////////////////////
210 /////////////////////////////////////////////////////////////////////
212 struct BufferView::Private
214 Private(BufferView & bv) :
215 update_strategy_(FullScreenUpdate),
216 update_flags_(Update::Force),
217 cursor_(bv), anchor_pit_(0), anchor_ypos_(0),
218 wh_(0), inlineCompletionUniqueChars_(0),
219 last_inset_(nullptr), mouse_position_cache_(),
220 gui_(nullptr), bookmark_edit_position_(-1),
221 horiz_scroll_offset_(0), clickable_inset_(false)
223 xsel_cache_.set = false;
227 ScrollbarParameters scrollbarParameters_;
229 ScreenUpdateStrategy update_strategy_;
231 Update::flags update_flags_;
233 CoordCache coord_cache_;
235 typedef unordered_map<MathData const *, MathRow> MathRows;
238 /// this is used to handle XSelection events in the right manner.
247 pit_type anchor_pit_;
250 /// Estimated average par height for scrollbar.
253 vector<int> par_height_;
256 DocIterator inlineCompletionPos_;
258 docstring inlineCompletion_;
260 size_t inlineCompletionUniqueChars_;
262 /// keyboard mapping object.
265 /// last visited inset.
266 /** kept to send setMouseHover(false).
267 * Not owned, so don't delete.
269 Inset const * last_inset_;
271 /// position of the mouse at the time of the last mouse move
272 /// This is used to update the hovering status of inset in
273 /// cases where the buffer is scrolled, but the mouse didn't move.
274 Point mouse_position_cache_;
276 mutable TextMetricsCache text_metrics_;
279 /** Not owned, so don't delete.
281 frontend::GuiBufferViewDelegate * gui_;
284 map<string, Inset *> edited_insets_;
286 /// When the row where the cursor lies is scrolled, this
287 /// contains the scroll offset
288 // cache for id of the paragraph which was edited the last time
289 int bookmark_edit_position_;
291 int horiz_scroll_offset_;
292 /// a slice pointing to the start of the row where the cursor
293 /// is (at last draw time)
294 CursorSlice current_row_slice_;
295 /// are we hovering something that we can click
296 bool clickable_inset_;
297 /// shape of the caret
298 frontend::CaretGeometry caret_geometry_;
300 bool mouse_selecting_ = false;
304 BufferView::BufferView(Buffer & buf)
305 : width_(0), height_(0), full_screen_(false), buffer_(buf),
306 d(new Private(*this))
308 d->xsel_cache_.set = false;
309 d->intl_.initKeyMapper(lyxrc.use_kbmap);
311 d->cursor_.setBuffer(&buf);
312 d->cursor_.push(buffer_.inset());
313 d->cursor_.resetAnchor();
314 d->cursor_.setCurrentFont();
316 buffer_.updatePreviews();
320 BufferView::~BufferView()
322 // current buffer is going to be switched-off, save cursor pos
323 // Ideally, the whole cursor stack should be saved, but session
324 // currently can only handle bottom (whole document) level pit and pos.
325 // That is to say, if a cursor is in a nested inset, it will be
326 // restore to the left of the top level inset.
327 LastFilePosSection::FilePos fp;
328 fp.file = buffer_.fileName();
329 fp.pit = d->cursor_.bottom().pit();
330 fp.pos = d->cursor_.bottom().pos();
331 theSession().lastFilePos().save(fp);
334 d->last_inset_->setMouseHover(this, false);
340 int BufferView::defaultMargin() const
342 // The value used to be hardcoded to 10
343 return zoomedPixels(20);
347 int BufferView::rightMargin() const
349 const int screen_width = inPixels(lyxrc.screen_width);
351 // The additional test for the case the outliner is opened.
352 if (!lyxrc.screen_limit || width_ < screen_width + 2 * defaultMargin()) {
353 return defaultMargin();
355 return (width_ - screen_width) / 2;
360 int BufferView::leftMargin() const
362 return rightMargin();
366 int BufferView::topMargin() const
368 // Original value was 20px at 100dpi. For internal buffers like in
369 // advanced search and replace, a value of 5px is enough.
370 return zoomedPixels(buffer().isInternal() ? 5 : 20);
374 int BufferView::bottomMargin() const
380 int BufferView::inPixels(Length const & len) const
382 Font const font = buffer().params().getFont();
383 return len.inPixels(workWidth(), theFontMetrics(font).em());
387 int BufferView::zoomedPixels(int pix) const
389 // FIXME: the dpi setting should really depend on the BufferView
390 // (think different monitors).
392 // Zoom factor specified by user in percent
393 double const zoom = lyxrc.currentZoom / 100.0; // [percent]
395 // DPI setting for monitor relative to 100dpi
396 double const dpizoom = lyxrc.dpi / 100.0; // [per 100dpi]
398 return support::iround(pix * zoom * dpizoom);
402 bool BufferView::isTopScreen() const
404 return 0 == d->scrollbarParameters_.min;
408 bool BufferView::isBottomScreen() const
410 return 0 == d->scrollbarParameters_.max;
414 Intl & BufferView::getIntl()
420 Intl const & BufferView::getIntl() const
426 CoordCache & BufferView::coordCache()
428 return d->coord_cache_;
432 CoordCache const & BufferView::coordCache() const
434 return d->coord_cache_;
438 MathRow const & BufferView::mathRow(MathData const * cell) const
440 auto it = d->math_rows_.find(cell);
441 LATTEST(it != d->math_rows_.end());
446 void BufferView::setMathRow(MathData const * cell, MathRow const & mrow)
448 d->math_rows_[cell] = mrow;
452 Buffer & BufferView::buffer()
458 Buffer const & BufferView::buffer() const
464 docstring const & BufferView::searchRequestCache() const
466 return theClipboard().getFindBuffer();
470 void BufferView::setSearchRequestCache(docstring const & text)
478 docstring const search = string2find(text, casesensitive, matchword,
479 forward, wrap, instant, onlysel);
480 theClipboard().setFindBuffer(search);
484 bool BufferView::needsFitCursor() const
486 if (cursorStatus(d->cursor_) == CUR_INSIDE) {
487 frontend::FontMetrics const & fm =
488 theFontMetrics(d->cursor_.getFont().fontInfo());
489 int const asc = fm.maxAscent();
490 int const des = fm.maxDescent();
491 Point const p = getPos(d->cursor_);
492 if (p.y_ - asc >= 0 && p.y_ + des < height_)
501 // this is for debugging only.
502 string flagsAsString(Update::flags flags)
504 if (flags == Update::None)
506 return string((flags & Update::FitCursor) ? "FitCursor " : "")
507 + ((flags & Update::Force) ? "Force " : "")
508 + ((flags & Update::ForceDraw) ? "ForceDraw " : "")
509 + ((flags & Update::SinglePar) ? "SinglePar " : "")
510 + ((flags & Update::Decoration) ? "Decoration " : "");
515 void BufferView::processUpdateFlags(Update::flags flags)
517 LYXERR(Debug::PAINTING, "BufferView::processUpdateFlags( "
518 << flagsAsString(flags) << ") buffer: " << &buffer_);
520 // Case when no explicit update is requested.
521 if (flags == Update::None)
524 /* FIXME We would like to avoid doing this here, since it is very
525 * expensive and is called in updateBuffer already. However, even
526 * inserting a plain character can invalidate the overly fragile
527 * tables of child documents built by updateMacros. Some work is
528 * needed to avoid doing that when not necessary.
530 buffer_.updateMacros();
532 // First check whether the metrics and inset positions should be updated
533 if (flags & Update::Force) {
534 // This will update the CoordCache items and replace Force
535 // with ForceDraw in flags.
536 updateMetrics(flags);
539 // Detect whether we can only repaint a single paragraph (if we
540 // are not already redrawing all).
541 // We handle this before FitCursor because the later will require
542 // correct metrics at cursor position.
543 if (!(flags & Update::ForceDraw)
544 && (flags & Update::SinglePar)
545 && !singleParUpdate())
546 updateMetrics(flags);
548 // Then make sure that the screen contains the cursor if needed
549 if (flags & Update::FitCursor) {
550 if (needsFitCursor()) {
551 // First try to make the selection start visible
552 // (which is just the cursor when there is no selection)
553 scrollToCursor(d->cursor_.selectionBegin(), SCROLL_VISIBLE);
554 // Metrics have to be recomputed (maybe again)
556 // Is the cursor visible? (only useful if cursor is at end of selection)
557 if (needsFitCursor()) {
558 // then try to make cursor visible instead
559 scrollToCursor(d->cursor_, SCROLL_VISIBLE);
560 // Metrics have to be recomputed (maybe again)
561 updateMetrics(flags);
564 flags = flags & ~Update::FitCursor;
567 // Add flags to the the update flags. These will be reset to None
568 // after the redraw is actually done
569 d->update_flags_ = d->update_flags_ | flags;
570 LYXERR(Debug::PAINTING, "Cumulative flags: " << flagsAsString(flags));
572 // Now compute the update strategy
573 // Possibly values in flag are None, SinglePar, Decoration, ForceDraw
574 LATTEST((d->update_flags_ & ~(Update::None | Update::SinglePar
575 | Update::Decoration | Update::ForceDraw)) == 0);
577 if (d->update_flags_ & Update::ForceDraw)
578 d->update_strategy_ = FullScreenUpdate;
579 else if (d->update_flags_ & Update::Decoration)
580 d->update_strategy_ = DecorationUpdate;
581 else if (d->update_flags_ & Update::SinglePar)
582 d->update_strategy_ = SingleParUpdate;
584 // no need to redraw anything.
585 d->update_strategy_ = NoScreenUpdate;
588 updateHoveredInset();
591 buffer_.changed(false);
595 void BufferView::updateScrollbarParameters()
597 if (height_ == 0 && width_ == 0)
600 // We prefer fixed size line scrolling.
601 d->scrollbarParameters_.single_step = defaultRowHeight();
602 // We prefer full screen page scrolling.
603 d->scrollbarParameters_.page_step = height_;
605 Text & t = buffer_.text();
606 TextMetrics & tm = d->text_metrics_[&t];
608 LYXERR(Debug::GUI, " Updating scrollbar: height: "
609 << t.paragraphs().size()
610 << " curr par: " << d->cursor_.bottom().pit()
611 << " default height " << defaultRowHeight());
613 size_t const parsize = t.paragraphs().size();
614 if (d->par_height_.size() != parsize) {
615 d->par_height_.clear();
616 // FIXME: We assume a default paragraph height of 2 rows. This
617 // should probably be pondered with the screen width.
618 d->par_height_.resize(parsize, defaultRowHeight() * 2);
621 // Look at paragraph heights on-screen
622 pair<pit_type, ParagraphMetrics const *> first = tm.first();
623 pair<pit_type, ParagraphMetrics const *> last = tm.last();
624 for (pit_type pit = first.first; pit <= last.first; ++pit) {
625 d->par_height_[pit] = tm.parMetrics(pit).height();
626 LYXERR(Debug::SCROLLING, "storing height for pit " << pit << " : "
627 << d->par_height_[pit]);
630 int top_pos = first.second->position() - first.second->ascent();
631 int bottom_pos = last.second->position() + last.second->descent();
632 bool first_visible = first.first == 0 && top_pos >= 0;
633 bool last_visible = last.first + 1 == int(parsize) && bottom_pos <= height_;
634 if (first_visible && last_visible) {
635 d->scrollbarParameters_.min = 0;
636 d->scrollbarParameters_.max = 0;
640 d->scrollbarParameters_.min = top_pos;
641 for (size_t i = 0; i != size_t(first.first); ++i)
642 d->scrollbarParameters_.min -= d->par_height_[i];
643 d->scrollbarParameters_.max = bottom_pos;
644 for (size_t i = last.first + 1; i != parsize; ++i)
645 d->scrollbarParameters_.max += d->par_height_[i];
647 // The reference is the top position so we remove one page.
648 if (lyxrc.scroll_below_document)
649 d->scrollbarParameters_.max -= minVisiblePart();
651 d->scrollbarParameters_.max -= d->scrollbarParameters_.page_step;
653 // 0 must be inside the range as it denotes the current position
654 if (d->scrollbarParameters_.max < 0)
655 d->scrollbarParameters_.max = 0;
656 if (d->scrollbarParameters_.min > 0)
657 d->scrollbarParameters_.min = 0;
661 ScrollbarParameters const & BufferView::scrollbarParameters() const
663 return d->scrollbarParameters_;
667 docstring BufferView::toolTip(int x, int y) const
669 // Get inset under mouse, if there is one.
670 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
672 // No inset, no tooltip...
674 return covering_inset->toolTip(*this, x, y);
678 string BufferView::contextMenu(int x, int y) const
680 //If there is a selection, return the containing inset menu
681 if (d->cursor_.selection())
682 return d->cursor_.inset().contextMenu(*this, x, y);
684 // Get inset under mouse, if there is one.
685 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
686 if (covering_inset) {
687 if (covering_inset->asInsetMath()) {
688 CoordCache::Insets const & inset_cache =
689 coordCache().getInsets();
690 Inset const * inner_inset = mathContextMenu(
691 covering_inset->asInsetMath()->asNestInset(),
694 return inner_inset->contextMenu(*this, x, y);
696 return covering_inset->contextMenu(*this, x, y);
699 return buffer_.inset().contextMenu(*this, x, y);
703 Inset const * BufferView::mathContextMenu(InsetMathNest const * inset,
704 CoordCache::Insets const & inset_cache, int x, int y) const
706 for (size_t i = 0; i < inset->nargs(); ++i) {
707 MathData const & ar = inset->cell(i);
708 for (size_t j = 0; j < ar.size(); ++j) {
709 string const name = lyxerr.debugging(Debug::MATHED)
710 ? insetName(ar[j].nucleus()->lyxCode())
712 LYXERR(Debug::MATHED, "Examining inset: " << name);
713 if (!ar[j].nucleus()->contextMenuName().empty()) {
714 if (inset_cache.covers(ar[j].nucleus(), x, y)) {
715 LYXERR(Debug::MATHED, "Hit inset: "
717 return ar[j].nucleus();
720 InsetMathNest const * imn =
721 ar[j].nucleus()->asNestInset();
723 Inset const * inner =
724 mathContextMenu(imn, inset_cache, x, y);
734 void BufferView::scrollDocView(int const pixels, bool update)
736 // The scrollbar values are relative to the top of the screen, therefore the
737 // offset is equal to the target value.
739 // No scrolling at all? No need to redraw anything
743 // If the offset is less than 2 screen height, prefer to scroll instead.
744 if (abs(pixels) <= 2 * height_) {
745 d->anchor_ypos_ -= pixels;
746 processUpdateFlags(Update::Force);
750 // cut off at the top
751 if (pixels <= d->scrollbarParameters_.min) {
752 DocIterator dit = doc_iterator_begin(&buffer_);
753 showCursor(dit, SCROLL_VISIBLE, update);
754 LYXERR(Debug::SCROLLING, "scroll to top");
758 // cut off at the bottom
759 if (pixels >= d->scrollbarParameters_.max) {
760 DocIterator dit = doc_iterator_end(&buffer_);
762 showCursor(dit, SCROLL_VISIBLE, update);
763 LYXERR(Debug::SCROLLING, "scroll to bottom");
767 // find paragraph at target position
768 int par_pos = d->scrollbarParameters_.min;
770 for (; i != int(d->par_height_.size()); ++i) {
771 par_pos += d->par_height_[i];
772 if (par_pos >= pixels)
776 if (par_pos < pixels) {
777 // It seems we didn't find the correct pit so stay on the safe side and
779 LYXERR0("scrolling position not found!");
780 scrollDocView(d->scrollbarParameters_.max, update);
784 DocIterator dit = doc_iterator_begin(&buffer_);
786 LYXERR(Debug::SCROLLING, "pixels = " << pixels << " -> scroll to pit " << i);
787 showCursor(dit, SCROLL_VISIBLE, update);
791 // FIXME: this method is not working well.
792 void BufferView::setCursorFromScrollbar()
794 TextMetrics & tm = d->text_metrics_[&buffer_.text()];
796 int const height = 2 * defaultRowHeight();
797 int const first = height;
798 int const last = height_ - height;
800 Cursor const & oldcur = d->cursor_;
802 switch (cursorStatus(oldcur)) {
810 int const y = getPos(oldcur).y_;
811 newy = min(last, max(y, first));
815 // We reset the cursor because cursorStatus() does not
816 // work when the cursor is within mathed.
819 tm.setCursorFromCoordinates(cur, 0, newy);
821 // update the bufferview cursor and notify insets
822 // FIXME: Care about the d->cursor_ flags to redraw if needed
823 Cursor old = d->cursor_;
825 // the DEPM call in mouseSetCursor() might have destroyed the
826 // paragraph the cursor is in.
827 bool badcursor = old.fixIfBroken();
828 badcursor |= notifyCursorLeavesOrEnters(old, d->cursor_);
830 d->cursor_.fixIfBroken();
834 Change const BufferView::getCurrentChange() const
836 if (!d->cursor_.selection())
837 return Change(Change::UNCHANGED);
839 DocIterator dit = d->cursor_.selectionBegin();
840 // The selected content might have been changed (see #7685)
841 dit = dit.getInnerText();
842 return dit.paragraph().lookupChange(dit.pos());
846 // this could be used elsewhere as well?
847 // FIXME: This does not work within mathed!
848 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
850 Point const p = getPos(dit);
853 if (p.y_ > workHeight())
859 void BufferView::bookmarkEditPosition()
861 // Don't eat cpu time for each keystroke
862 if (d->cursor_.paragraph().id() == d->bookmark_edit_position_)
865 d->bookmark_edit_position_ = d->cursor_.paragraph().id();
869 void BufferView::saveBookmark(unsigned int idx)
871 if (buffer().isInternal())
874 // tentatively save bookmark, id and pos will be used to
875 // acturately locate a bookmark in a 'live' lyx session.
876 // pit and pos will be updated with bottom level pit/pos
878 theSession().bookmarks().save(
880 d->cursor_.bottom().pit(),
881 d->cursor_.bottom().pos(),
882 d->cursor_.paragraph().id(),
887 // emit message signal.
888 message(_("Save bookmark"));
892 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
893 int top_id, pos_type top_pos)
895 bool success = false;
898 d->cursor_.clearSelection();
900 // if a valid par_id is given, try it first
901 // This is the case for a 'live' bookmark when unique paragraph ID
902 // is used to track bookmarks.
904 dit = buffer_.getParFromID(top_id);
906 dit.pos() = min(dit.paragraph().size(), top_pos);
907 // Some slices of the iterator may not be
908 // reachable (e.g. closed collapsible inset)
909 // so the dociterator may need to be
910 // shortened. Otherwise, setCursor may crash
911 // lyx when the cursor can not be set to these
913 size_t const n = dit.depth();
914 for (size_t i = 0; i < n; ++i)
915 if (!dit[i].inset().editable()) {
923 // if top_id == 0, or searching through top_id failed
924 // This is the case for a 'restored' bookmark when only bottom
925 // (document level) pit was saved. Because of this, bookmark
926 // restoration is inaccurate. If a bookmark was within an inset,
927 // it will be restored to the left of the outmost inset that contains
929 if (!success && bottom_pit < int(buffer_.paragraphs().size())) {
930 dit = doc_iterator_begin(&buffer_);
932 dit.pit() = bottom_pit;
933 dit.pos() = min(bottom_pos, dit.paragraph().size());
938 // Note: only bottom (document) level pit is set.
940 // set the current font.
941 d->cursor_.setCurrentFont();
942 // Do not forget to reset the anchor (see #9912)
943 d->cursor_.resetAnchor();
944 processUpdateFlags(Update::Force | Update::FitCursor);
951 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
953 if (d->cursor_.real_current_font.isRightToLeft()) {
954 if (d->intl_.keymap == Intl::PRIMARY)
955 d->intl_.keyMapSec();
957 if (d->intl_.keymap == Intl::SECONDARY)
958 d->intl_.keyMapPrim();
961 d->intl_.getTransManager().translateAndInsert(c, t, cur);
965 int BufferView::workWidth() const
971 void BufferView::recenter()
973 showCursor(d->cursor_, SCROLL_CENTER, true);
977 void BufferView::showCursor()
979 showCursor(d->cursor_, SCROLL_VISIBLE, true);
983 void BufferView::showCursor(DocIterator const & dit, ScrollType how,
986 if (scrollToCursor(dit, how) && update)
987 processUpdateFlags(Update::Force);
991 bool BufferView::scrollToCursor(DocIterator const & dit, ScrollType how)
993 // We are not properly started yet, delay until resizing is done.
997 if (how == SCROLL_CENTER)
998 LYXERR(Debug::SCROLLING, "Centering cursor in workarea");
999 else if (how == SCROLL_TOP)
1000 LYXERR(Debug::SCROLLING, "Setting cursor to top of workarea");
1002 LYXERR(Debug::SCROLLING, "Making sure cursor is visible in workarea");
1004 CursorSlice const & bot = dit.bottom();
1005 TextMetrics & tm = textMetrics(bot.text());
1007 pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
1008 pos_type bot_pit = bot.pit();
1009 if (bot_pit > max_pit) {
1010 // FIXME: Why does this happen?
1011 LYXERR0("bottom pit is greater that max pit: "
1012 << bot_pit << " > " << max_pit);
1016 if (bot_pit == tm.first().first - 1)
1017 tm.newParMetricsUp();
1018 else if (bot_pit == tm.last().first + 1)
1019 tm.newParMetricsDown();
1021 if (tm.contains(bot_pit) && how == SCROLL_VISIBLE) {
1022 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
1023 LBUFERR(!pm.rows().empty());
1024 // FIXME: smooth scrolling doesn't work in mathed.
1025 CursorSlice const & cs = dit.innerTextSlice();
1026 int const ypos = pm.position() + coordOffset(dit).y_;
1027 ParagraphMetrics const & inner_pm =
1028 textMetrics(cs.text()).parMetrics(cs.pit());
1029 Dimension const & row_dim =
1030 inner_pm.getRow(cs.pos(), dit.boundary()).dim();
1033 // We try to visualize the whole row, if the row height is larger than
1034 // the screen height, we scroll to a heuristic value of height_ / 4.
1035 // FIXME: This heuristic value should be replaced by a recursive search
1036 // for a row in the inset that can be visualized completely.
1037 if (row_dim.height() > height_) {
1038 if (ypos < defaultRowHeight())
1039 scrolled = scroll(ypos - height_ / 4);
1040 else if (ypos > height_ - defaultRowHeight())
1041 scrolled = scroll(ypos - 3 * height_ / 4);
1044 // If the top part of the row falls of the screen, we scroll
1045 // up to align the top of the row with the top of the screen.
1046 else if (ypos - row_dim.ascent() < 0 && ypos < height_) {
1047 int const ynew = row_dim.ascent();
1048 scrolled = scrollUp(ynew - ypos);
1051 // If the bottom of the row falls of the screen, we scroll down.
1052 else if (ypos + row_dim.descent() > height_ && ypos > 0) {
1053 int const ynew = height_ - row_dim.descent();
1054 scrolled = scrollDown(ypos - ynew);
1057 // else, nothing to do, the cursor is already visible so we just return.
1058 return scrolled != 0;
1061 // fix inline completion position
1062 if (d->inlineCompletionPos_.fixIfBroken())
1063 d->inlineCompletionPos_ = DocIterator();
1065 tm.redoParagraph(bot_pit);
1066 int const offset = coordOffset(dit).y_;
1067 d->anchor_pit_ = bot_pit;
1069 CursorSlice const & cs = dit.innerTextSlice();
1070 ParagraphMetrics const & inner_pm =
1071 textMetrics(cs.text()).parMetrics(cs.pit());
1072 Dimension const & row_dim =
1073 inner_pm.getRow(cs.pos(), dit.boundary()).dim();
1075 int const old_ypos = d->anchor_ypos_;
1076 d->anchor_ypos_ = - offset + row_dim.ascent();
1077 if (how == SCROLL_CENTER)
1078 d->anchor_ypos_ += height_/2 - row_dim.height() / 2;
1079 return d->anchor_ypos_ != old_ypos;
1083 void BufferView::makeDocumentClass()
1085 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1086 buffer_.params().makeDocumentClass(buffer_.isClone(), buffer_.isInternal());
1087 updateDocumentClass(olddc);
1091 void BufferView::updateDocumentClass(DocumentClassConstPtr olddc)
1093 StableDocIterator backcur(d->cursor_);
1094 ErrorList & el = buffer_.errorList("Class Switch");
1095 cap::switchBetweenClasses(
1096 olddc, buffer_.params().documentClassPtr(),
1097 static_cast<InsetText &>(buffer_.inset()), el);
1099 setCursor(backcur.asDocIterator(&buffer_));
1101 buffer_.errors("Class Switch");
1105 /** Return the change status at cursor position, taking into account the
1106 * status at each level of the document iterator (a table in a deleted
1107 * footnote is deleted).
1108 * When \param outer is true, the top slice is not looked at.
1110 static Change::Type lookupChangeType(DocIterator const & dit, bool outer = false)
1112 size_t const depth = dit.depth() - (outer ? 1 : 0);
1114 for (size_t i = 0 ; i < depth ; ++i) {
1115 CursorSlice const & slice = dit[i];
1116 if (!slice.inset().inMathed()
1117 && slice.pos() < slice.paragraph().size()) {
1118 Change::Type const ch = slice.paragraph().lookupChange(slice.pos()).type;
1119 if (ch != Change::UNCHANGED)
1123 return Change::UNCHANGED;
1127 bool BufferView::getStatus(FuncRequest const & cmd, FuncStatus & flag)
1129 FuncCode const act = cmd.action();
1131 // Can we use a readonly buffer?
1132 if (buffer_.isReadonly()
1133 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1134 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1135 if (buffer_.hasReadonlyFlag())
1136 flag.message(from_utf8(N_("Document is read-only")));
1138 flag.message(from_utf8(N_("Document has been modified externally")));
1139 flag.setEnabled(false);
1143 // Are we in a DELETED change-tracking region?
1144 if (lookupChangeType(d->cursor_, true) == Change::DELETED
1145 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1146 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1147 flag.message(from_utf8(N_("This portion of the document is deleted.")));
1148 flag.setEnabled(false);
1152 Cursor & cur = d->cursor_;
1154 if (cur.getStatus(cmd, flag))
1159 // FIXME: This is a bit problematic because we don't check if this is
1160 // a document BufferView or not for these LFUNs. We probably have to
1161 // dispatch both to currentBufferView() and, if that fails,
1162 // to documentBufferView(); same as we do now for current Buffer and
1163 // document Buffer. Ideally those LFUN should go to Buffer as they
1164 // operate on the full Buffer and the cursor is only needed either for
1165 // an Undo record or to restore a cursor position. But we don't know
1166 // how to do that inside Buffer of course.
1167 case LFUN_BUFFER_PARAMS_APPLY:
1168 case LFUN_LAYOUT_MODULES_CLEAR:
1169 case LFUN_LAYOUT_MODULE_ADD:
1170 case LFUN_LAYOUT_RELOAD:
1171 case LFUN_TEXTCLASS_APPLY:
1172 case LFUN_TEXTCLASS_LOAD:
1173 flag.setEnabled(!buffer_.isReadonly());
1177 // We do not use the LyXAction flag for readonly because Undo sets the
1178 // buffer clean/dirty status by itself.
1179 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasUndoStack());
1182 // We do not use the LyXAction flag for readonly because Redo sets the
1183 // buffer clean/dirty status by itself.
1184 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasRedoStack());
1186 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
1187 case LFUN_FILE_INSERT_PLAINTEXT: {
1188 docstring const & fname = cmd.argument();
1189 if (!FileName::isAbsolute(to_utf8(fname))) {
1190 flag.message(_("Absolute filename expected."));
1193 flag.setEnabled(cur.inTexted());
1196 case LFUN_FILE_INSERT:
1197 case LFUN_BOOKMARK_SAVE:
1198 // FIXME: Actually, these LFUNS should be moved to Text
1199 flag.setEnabled(cur.inTexted());
1202 case LFUN_FONT_STATE:
1203 case LFUN_LABEL_INSERT:
1204 case LFUN_INFO_INSERT:
1205 case LFUN_PARAGRAPH_GOTO:
1206 case LFUN_NOTE_NEXT:
1207 case LFUN_REFERENCE_NEXT:
1208 case LFUN_WORD_FIND:
1209 case LFUN_WORD_FIND_FORWARD:
1210 case LFUN_WORD_FIND_BACKWARD:
1211 case LFUN_WORD_REPLACE:
1214 case LFUN_MARK_TOGGLE:
1215 case LFUN_SEARCH_STRING_SET:
1216 case LFUN_SCREEN_RECENTER:
1217 case LFUN_SCREEN_SHOW_CURSOR:
1218 case LFUN_BIBTEX_DATABASE_ADD:
1219 case LFUN_BIBTEX_DATABASE_DEL:
1220 case LFUN_BIBTEX_DATABASE_LIST:
1221 case LFUN_STATISTICS:
1222 case LFUN_KEYMAP_OFF:
1223 case LFUN_KEYMAP_PRIMARY:
1224 case LFUN_KEYMAP_SECONDARY:
1225 case LFUN_KEYMAP_TOGGLE:
1226 case LFUN_INSET_SELECT_ALL:
1227 flag.setEnabled(true);
1230 case LFUN_GRAPHICS_UNIFY:
1231 flag.setEnabled(cur.countInsetsInSelection(GRAPHICS_CODE)>1);
1234 case LFUN_WORD_FINDADV: {
1235 FindAndReplaceOptions opt;
1236 istringstream iss(to_utf8(cmd.argument()));
1238 flag.setEnabled(opt.repl_buf_name.empty()
1239 || !buffer_.isReadonly());
1243 case LFUN_LABEL_GOTO:
1244 flag.setEnabled(!cmd.argument().empty()
1245 || getInsetByCode<InsetRef>(cur, REF_CODE)
1246 || getInsetByCode<InsetMathRef>(cur, MATH_REF_CODE));
1249 case LFUN_CHANGES_MERGE:
1250 case LFUN_CHANGE_NEXT:
1251 case LFUN_CHANGE_PREVIOUS:
1252 case LFUN_ALL_CHANGES_ACCEPT:
1253 case LFUN_ALL_CHANGES_REJECT:
1254 flag.setEnabled(buffer_.areChangesPresent());
1257 case LFUN_SCREEN_UP:
1258 case LFUN_SCREEN_DOWN:
1260 case LFUN_SCREEN_UP_SELECT:
1261 case LFUN_SCREEN_DOWN_SELECT:
1262 case LFUN_INSET_FORALL:
1263 flag.setEnabled(true);
1266 case LFUN_LAYOUT_TABULAR:
1267 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
1271 flag.setEnabled(!cur.inset().forcePlainLayout(cur.idx()));
1274 case LFUN_LAYOUT_PARAGRAPH:
1275 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
1278 case LFUN_BRANCH_ADD_INSERT:
1279 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1282 case LFUN_DIALOG_SHOW_NEW_INSET:
1283 // FIXME: this is wrong, but I do not understand the
1285 if (cur.inset().lyxCode() == CAPTION_CODE)
1286 return cur.inset().getStatus(cur, cmd, flag);
1287 // FIXME we should consider passthru paragraphs too.
1288 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1291 case LFUN_CITATION_INSERT: {
1292 FuncRequest fr(LFUN_INSET_INSERT, "citation");
1293 // FIXME: This could turn in a recursive hell.
1294 // Shouldn't we use Buffer::getStatus() instead?
1295 flag.setEnabled(lyx::getStatus(fr).enabled());
1298 case LFUN_INSET_APPLY: {
1299 string const name = cmd.getArg(0);
1300 Inset * inset = editedInset(name);
1302 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1303 if (!inset->getStatus(cur, fr, flag)) {
1304 // Every inset is supposed to handle this
1305 LASSERT(false, break);
1308 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1309 flag = lyx::getStatus(fr);
1315 flag.setEnabled(cur.selection());
1326 Inset * BufferView::editedInset(string const & name) const
1328 map<string, Inset *>::const_iterator it = d->edited_insets_.find(name);
1329 return it == d->edited_insets_.end() ? nullptr : it->second;
1333 void BufferView::editInset(string const & name, Inset * inset)
1336 d->edited_insets_[name] = inset;
1338 d->edited_insets_.erase(name);
1342 void BufferView::dispatch(FuncRequest const & cmd, DispatchResult & dr)
1344 LYXERR(Debug::ACTION, "BufferView::dispatch: cmd: " << cmd);
1346 string const argument = to_utf8(cmd.argument());
1347 Cursor & cur = d->cursor_;
1350 // Don't dispatch function that does not apply to internal buffers.
1351 if (buffer_.isInternal()
1352 && lyxaction.funcHasFlag(cmd.action(), LyXAction::NoInternal))
1355 // We'll set this back to false if need be.
1356 bool dispatched = true;
1357 buffer_.undo().beginUndoGroup();
1359 FuncCode const act = cmd.action();
1362 case LFUN_BUFFER_PARAMS_APPLY: {
1363 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1364 cur.recordUndoBufferParams();
1365 istringstream ss(to_utf8(cmd.argument()));
1368 int const unknown_tokens = buffer_.readHeader(lex);
1369 if (unknown_tokens != 0) {
1370 LYXERR0("Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1371 << unknown_tokens << " unknown token"
1372 << (unknown_tokens == 1 ? "" : "s"));
1374 updateDocumentClass(olddc);
1376 // We are most certainly here because of a change in the document
1377 // It is then better to make sure that all dialogs are in sync with
1378 // current document settings.
1379 dr.screenUpdate(Update::Force | Update::FitCursor);
1380 dr.forceBufferUpdate();
1384 case LFUN_LAYOUT_MODULES_CLEAR: {
1385 // FIXME: this modifies the document in cap::switchBetweenClasses
1386 // without calling recordUndo. Fix this before using
1387 // recordUndoBufferParams().
1388 cur.recordUndoFullBuffer();
1389 buffer_.params().clearLayoutModules();
1390 makeDocumentClass();
1391 dr.screenUpdate(Update::Force);
1392 dr.forceBufferUpdate();
1396 case LFUN_LAYOUT_MODULE_ADD: {
1397 BufferParams const & params = buffer_.params();
1398 if (!params.layoutModuleCanBeAdded(argument)) {
1399 LYXERR0("Module `" << argument <<
1400 "' cannot be added due to failed requirements or "
1401 "conflicts with installed modules.");
1404 // FIXME: this modifies the document in cap::switchBetweenClasses
1405 // without calling recordUndo. Fix this before using
1406 // recordUndoBufferParams().
1407 cur.recordUndoFullBuffer();
1408 buffer_.params().addLayoutModule(argument);
1409 makeDocumentClass();
1410 dr.screenUpdate(Update::Force);
1411 dr.forceBufferUpdate();
1415 case LFUN_TEXTCLASS_APPLY: {
1416 // since this shortcircuits, the second call is made only if
1418 bool const success =
1419 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1420 LayoutFileList::get().load(argument, buffer_.filePath());
1422 docstring s = bformat(_("The document class `%1$s' "
1423 "could not be loaded."), from_utf8(argument));
1424 frontend::Alert::error(_("Could not load class"), s);
1428 LayoutFile const * old_layout = buffer_.params().baseClass();
1429 LayoutFile const * new_layout = &(LayoutFileList::get()[argument]);
1431 if (old_layout == new_layout)
1435 // Save the old, possibly modular, layout for use in conversion.
1436 // FIXME: this modifies the document in cap::switchBetweenClasses
1437 // without calling recordUndo. Fix this before using
1438 // recordUndoBufferParams().
1439 cur.recordUndoFullBuffer();
1440 buffer_.params().setBaseClass(argument, buffer_.layoutPos());
1441 makeDocumentClass();
1442 dr.screenUpdate(Update::Force);
1443 dr.forceBufferUpdate();
1447 case LFUN_TEXTCLASS_LOAD: {
1448 // since this shortcircuits, the second call is made only if
1450 bool const success =
1451 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1452 LayoutFileList::get().load(argument, buffer_.filePath());
1454 docstring s = bformat(_("The document class `%1$s' "
1455 "could not be loaded."), from_utf8(argument));
1456 frontend::Alert::error(_("Could not load class"), s);
1461 case LFUN_LAYOUT_RELOAD: {
1462 LayoutFileIndex bc = buffer_.params().baseClassID();
1463 LayoutFileList::get().reset(bc);
1464 buffer_.params().setBaseClass(bc, buffer_.layoutPos());
1465 makeDocumentClass();
1466 dr.screenUpdate(Update::Force);
1467 dr.forceBufferUpdate();
1472 dr.setMessage(_("Undo"));
1473 cur.clearSelection();
1474 // We need to find out if the bibliography information
1475 // has changed. See bug #11055.
1476 // So these should not be references...
1477 string const engine = buffer().params().citeEngine();
1478 CiteEngineType const enginetype = buffer().params().citeEngineType();
1479 if (!cur.undoAction())
1480 dr.setMessage(_("No further undo information"));
1482 dr.screenUpdate(Update::Force | Update::FitCursor);
1483 dr.forceBufferUpdate();
1484 resetInlineCompletionPos();
1485 if (buffer().params().citeEngine() != engine ||
1486 buffer().params().citeEngineType() != enginetype)
1487 buffer().invalidateCiteLabels();
1493 dr.setMessage(_("Redo"));
1494 cur.clearSelection();
1495 // We need to find out if the bibliography information
1496 // has changed. See bug #11055.
1497 // So these should not be references...
1498 string const engine = buffer().params().citeEngine();
1499 CiteEngineType const enginetype = buffer().params().citeEngineType();
1500 if (!cur.redoAction())
1501 dr.setMessage(_("No further redo information"));
1503 dr.screenUpdate(Update::Force | Update::FitCursor);
1504 dr.forceBufferUpdate();
1505 resetInlineCompletionPos();
1506 if (buffer().params().citeEngine() != engine ||
1507 buffer().params().citeEngineType() != enginetype)
1508 buffer().invalidateCiteLabels();
1513 case LFUN_FONT_STATE:
1514 dr.setMessage(cur.currentState(false));
1517 case LFUN_BOOKMARK_SAVE:
1518 dr.screenUpdate(Update::Force);
1519 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1522 case LFUN_LABEL_GOTO: {
1523 docstring label = cmd.argument();
1524 if (label.empty()) {
1526 getInsetByCode<InsetRef>(cur, REF_CODE);
1528 label = inset->getParam("reference");
1529 // persistent=false: use temp_bookmark
1533 if (!label.empty()) {
1535 // at the moment, this is redundant, since gotoLabel will
1536 // eventually call LFUN_PARAGRAPH_GOTO, but it seems best
1538 dr.screenUpdate(Update::Force | Update::FitCursor);
1540 InsetMathRef * minset =
1541 getInsetByCode<InsetMathRef>(cur, MATH_REF_CODE);
1543 lyx::dispatch(FuncRequest(LFUN_LABEL_GOTO,
1544 minset->getTarget()));
1549 case LFUN_PARAGRAPH_GOTO: {
1550 int const id = convert<int>(cmd.getArg(0));
1551 pos_type const pos = convert<int>(cmd.getArg(1));
1554 string const str_id_end = cmd.getArg(2);
1555 string const str_pos_end = cmd.getArg(3);
1557 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1558 b = theBufferList().next(b)) {
1561 curs.setCursor(b->getParFromID(id));
1563 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1567 LYXERR(Debug::INFO, "Paragraph " << curs.paragraph().id()
1568 << " found in buffer `"
1569 << b->absFileName() << "'.");
1571 if (b == &buffer_) {
1573 if (str_id_end.empty() || str_pos_end.empty()) {
1576 mouseSetCursor(curs);
1579 int const id_end = convert<int>(str_id_end);
1580 pos_type const pos_end = convert<int>(str_pos_end);
1581 success = setCursorFromEntries({id, pos},
1584 if (success && scrollToCursor(d->cursor_, SCROLL_TOP))
1585 dr.screenUpdate(Update::Force);
1587 // Switch to other buffer view and resend cmd
1588 lyx::dispatch(FuncRequest(
1589 LFUN_BUFFER_SWITCH, b->absFileName()));
1597 case LFUN_NOTE_NEXT:
1598 if (gotoInset(this, { NOTE_CODE }, false))
1599 dr.screenUpdate(Update::Force);
1602 case LFUN_REFERENCE_NEXT: {
1603 if (gotoInset(this, { LABEL_CODE, REF_CODE }, true))
1604 dr.screenUpdate(Update::Force);
1608 case LFUN_CHANGE_NEXT:
1609 findNextChange(this);
1610 if (cur.inset().isTable())
1611 // In tables, there might be whole changed rows or columns
1613 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1614 dr.screenUpdate(Update::Force | Update::FitCursor);
1617 case LFUN_CHANGE_PREVIOUS:
1618 findPreviousChange(this);
1619 if (cur.inset().isTable())
1620 // In tables, there might be whole changed rows or columns
1622 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1623 dr.screenUpdate(Update::Force | Update::FitCursor);
1626 case LFUN_CHANGES_MERGE:
1627 if (findNextChange(this) || findPreviousChange(this)) {
1628 dr.screenUpdate(Update::Force | Update::FitCursor);
1629 dr.forceBufferUpdate();
1630 showDialog("changes");
1634 case LFUN_ALL_CHANGES_ACCEPT: {
1635 // select complete document
1637 cur.selHandle(true);
1638 buffer_.text().cursorBottom(cur);
1639 // accept everything in a single step to support atomic undo
1640 // temporarily disable track changes in order to end with really
1641 // no new (e.g., DPSM-caused) changes (see #7487)
1642 bool const track = buffer_.params().track_changes;
1643 buffer_.params().track_changes = false;
1644 buffer_.text().acceptOrRejectChanges(cur, Text::ACCEPT);
1645 buffer_.params().track_changes = track;
1647 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1648 dr.screenUpdate(Update::Force | Update::FitCursor);
1649 dr.forceBufferUpdate();
1653 case LFUN_ALL_CHANGES_REJECT: {
1654 // select complete document
1656 cur.selHandle(true);
1657 buffer_.text().cursorBottom(cur);
1658 // reject everything in a single step to support atomic undo
1659 // temporarily disable track changes in order to end with really
1660 // no new (e.g., DPSM-caused) changes (see #7487)
1661 bool const track = buffer_.params().track_changes;
1662 buffer_.params().track_changes = false;
1663 buffer_.text().acceptOrRejectChanges(cur, Text::REJECT);
1664 buffer_.params().track_changes = track;
1666 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1667 dr.screenUpdate(Update::Force | Update::FitCursor);
1668 dr.forceBufferUpdate();
1672 case LFUN_WORD_FIND_FORWARD:
1673 case LFUN_WORD_FIND_BACKWARD: {
1674 docstring searched_string;
1676 if (!cmd.argument().empty()) {
1677 setSearchRequestCache(cmd.argument());
1678 searched_string = cmd.argument();
1680 searched_string = searchRequestCache();
1683 if (searched_string.empty())
1686 docstring const data =
1687 find2string(searched_string, false, false,
1688 act == LFUN_WORD_FIND_FORWARD, false, false, false);
1689 bool found = lyxfind(this, FuncRequest(LFUN_WORD_FIND, data));
1691 dr.screenUpdate(Update::Force | Update::FitCursor);
1693 dr.setMessage(_("Search string not found!"));
1697 case LFUN_WORD_FIND: {
1698 docstring arg = cmd.argument();
1700 arg = searchRequestCache();
1702 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, "findreplace"));
1705 if (lyxfind(this, FuncRequest(act, arg)))
1706 dr.screenUpdate(Update::Force | Update::FitCursor);
1708 dr.setMessage(_("Search string not found!"));
1710 setSearchRequestCache(arg);
1714 case LFUN_SEARCH_STRING_SET: {
1715 docstring pattern = cmd.argument();
1716 if (!pattern.empty()) {
1717 setSearchRequestCache(pattern);
1720 if (cur.selection())
1721 pattern = cur.selectionAsString(false);
1722 else if (!cur.inTexted())
1723 break; // not suitable for selectWord at cursor
1725 pos_type spos = cur.pos();
1726 cur.innerText()->selectWord(cur, WHOLE_WORD);
1727 pattern = cur.selectionAsString(false);
1728 cur.selection(false);
1731 setSearchRequestCache(pattern);
1735 case LFUN_WORD_REPLACE: {
1736 if (lyxreplace(this, cmd)) {
1737 dr.forceBufferUpdate();
1738 dr.screenUpdate(Update::Force | Update::FitCursor);
1741 dr.setMessage(_("Search string not found!"));
1745 case LFUN_WORD_FINDADV: {
1746 FindAndReplaceOptions opt;
1747 istringstream iss(to_utf8(cmd.argument()));
1749 if (findAdv(this, opt)) {
1750 dr.screenUpdate(Update::Force | Update::FitCursor);
1760 case LFUN_INDEX_TAG_ALL: {
1761 Inset * ins = cur.nextInset();
1762 if (!ins || ins->lyxCode() != INDEX_CODE)
1763 // not at index inset
1766 // clone the index inset
1768 new InsetIndex(static_cast<InsetIndex &>(*cur.nextInset()));
1769 // In order to avoid duplication, we compare the
1770 // LaTeX output if we find another index inset after
1772 odocstringstream oilatex;
1773 otexstream oits(oilatex);
1774 OutputParams rp(&cur.buffer()->params().encoding());
1775 ins->latex(oits, rp);
1776 cap::copyInsetToTemp(cur, cins);
1778 // move backwards into preceding word
1779 // skip over other index insets
1780 cur.backwardPosIgnoreCollapsed();
1782 if (cur.inset().lyxCode() == INDEX_CODE)
1784 else if (cur.prevInset() && cur.prevInset()->lyxCode() == INDEX_CODE)
1785 cur.backwardPosIgnoreCollapsed();
1789 if (!cur.inTexted()) {
1790 // Nothing to do here.
1791 setCursorFromInset(ins);
1794 // Get word or selection
1795 cur.text()->selectWord(cur, WHOLE_WORD);
1796 docstring const searched_string = cur.selectionAsString(false);
1797 // Start from the beginning
1798 lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN));
1799 while (findOne(this, searched_string,
1800 false,// case sensitive
1801 true,// match whole word only
1803 false,//find deleted
1807 false// only selection
1809 cur.clearSelection();
1810 Inset * ains = cur.nextInset();
1811 if (ains && ains->lyxCode() == INDEX_CODE) {
1812 // We have an index inset.
1813 // Check whether it has the same
1814 // LaTeX content and move on if so.
1815 odocstringstream filatex;
1816 otexstream fits(filatex);
1817 ains->latex(fits, rp);
1818 if (oilatex.str() == filatex.str())
1821 // Paste the inset and possibly continue
1822 cap::pasteFromTemp(cursor(), cursor().buffer()->errorList("Paste"));
1824 // Go back to start position.
1825 setCursorFromInset(ins);
1826 dr.screenUpdate(cur.result().screenUpdate());
1827 if (cur.result().needBufferUpdate())
1828 dr.forceBufferUpdate();
1833 cur.clearSelection();
1834 dr.setMessage(from_utf8(N_("Mark off")));
1838 cur.clearSelection();
1840 dr.setMessage(from_utf8(N_("Mark on")));
1843 case LFUN_MARK_TOGGLE:
1844 cur.selection(false);
1847 dr.setMessage(from_utf8(N_("Mark removed")));
1850 dr.setMessage(from_utf8(N_("Mark set")));
1855 case LFUN_SCREEN_SHOW_CURSOR:
1859 case LFUN_SCREEN_RECENTER:
1863 case LFUN_BIBTEX_DATABASE_ADD: {
1864 Cursor tmpcur = cur;
1865 findInset(tmpcur, { BIBTEX_CODE }, false);
1866 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1869 if (inset->addDatabase(cmd.argument()))
1870 dr.forceBufferUpdate();
1875 case LFUN_BIBTEX_DATABASE_DEL: {
1876 Cursor tmpcur = cur;
1877 findInset(tmpcur, { BIBTEX_CODE }, false);
1878 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1881 if (inset->delDatabase(cmd.argument()))
1882 dr.forceBufferUpdate();
1887 case LFUN_GRAPHICS_UNIFY: {
1889 cur.recordUndoFullBuffer();
1891 DocIterator from, to;
1892 from = cur.selectionBegin();
1893 to = cur.selectionEnd();
1895 string const newId = cmd.getArg(0);
1896 bool fetchId = newId.empty(); //if we wait for groupId from first graphics inset
1898 InsetGraphicsParams grp_par;
1900 InsetGraphics::string2params(graphics::getGroupParams(buffer_, newId), buffer_, grp_par);
1902 if (!from.nextInset()) //move to closest inset
1903 from.forwardInset();
1905 while (!from.empty() && from < to) {
1906 Inset * inset = from.nextInset();
1909 InsetGraphics * ig = inset->asInsetGraphics();
1911 InsetGraphicsParams inspar = ig->getParams();
1916 grp_par.filename = inspar.filename;
1917 ig->setParams(grp_par);
1920 from.forwardInset();
1922 dr.screenUpdate(Update::Force); //needed if triggered from context menu
1926 case LFUN_BIBTEX_DATABASE_LIST: {
1927 docstring_list const & files = buffer_.getBibfiles();
1930 char const separator(os::path_separator());
1931 for (auto const & file : files) {
1935 result += separator;
1937 FileName const fn = buffer_.getBibfilePath(file);
1938 string const path = fn.realPath();
1939 result += from_utf8(os::external_path(path));
1941 dr.setMessage(result);
1945 case LFUN_STATISTICS: {
1946 DocIterator from, to;
1947 if (cur.selection()) {
1948 from = cur.selectionBegin();
1949 to = cur.selectionEnd();
1951 from = doc_iterator_begin(&buffer_);
1952 to = doc_iterator_end(&buffer_);
1954 buffer_.updateStatistics(from, to);
1955 int const words = buffer_.wordCount();
1956 int const chars = buffer_.charCount(false);
1957 int const chars_blanks = buffer_.charCount(true);
1959 if (cur.selection())
1960 message = _("Statistics for the selection:");
1962 message = _("Statistics for the document:");
1965 message += bformat(_("%1$d words"), words);
1967 message += _("One word");
1969 if (chars_blanks != 1)
1970 message += bformat(_("%1$d characters"), chars_blanks);
1972 message += _("One character");
1975 message += bformat(_("%1$d characters (no blanks)"), chars);
1977 message += _("One character (no blanks)");
1979 Alert::information(_("Statistics"), message);
1983 case LFUN_SCREEN_UP:
1984 case LFUN_SCREEN_DOWN: {
1985 Point p = getPos(cur);
1986 // This code has been commented out to enable to scroll down a
1987 // document, even if there are large insets in it (see bug #5465).
1988 /*if (p.y_ < 0 || p.y_ > height_) {
1989 // The cursor is off-screen so recenter before proceeding.
1993 int const scrolled = scroll(act == LFUN_SCREEN_UP
1994 ? -height_ : height_);
1995 if (act == LFUN_SCREEN_UP && scrolled > -height_)
1997 if (act == LFUN_SCREEN_DOWN && scrolled < height_)
1998 p = Point(width_, height_);
1999 bool const in_texted = cur.inTexted();
2000 cur.setCursor(doc_iterator_begin(cur.buffer()));
2001 cur.selHandle(false);
2002 // Force an immediate computation of metrics because we need it below
2004 processUpdateFlags(Update::Force);
2006 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_,
2007 true, act == LFUN_SCREEN_UP);
2008 //FIXME: what to do with cur.x_target()?
2009 bool update = in_texted && cur.bv().checkDepm(cur, old);
2012 if (update || cur.mark())
2013 dr.screenUpdate(Update::Force | Update::FitCursor);
2015 dr.forceBufferUpdate();
2020 string const scroll_type = cmd.getArg(0);
2021 int scroll_step = 0;
2022 if (scroll_type == "line")
2023 scroll_step = d->scrollbarParameters_.single_step;
2024 else if (scroll_type == "page")
2025 scroll_step = d->scrollbarParameters_.page_step;
2028 string const scroll_quantity = cmd.getArg(1);
2029 if (scroll_quantity == "up")
2030 scrollUp(scroll_step);
2031 else if (scroll_quantity == "down")
2032 scrollDown(scroll_step);
2034 int const scroll_value = convert<int>(scroll_quantity);
2036 scroll(scroll_step * scroll_value);
2038 dr.screenUpdate(Update::ForceDraw);
2039 dr.forceBufferUpdate();
2043 case LFUN_SCREEN_UP_SELECT: {
2044 // FIXME: why is the algorithm different from LFUN_SCREEN_UP?
2045 cur.selHandle(true);
2046 if (isTopScreen()) {
2047 lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
2051 int y = getPos(cur).y_;
2052 int const ymin = y - height_ + defaultRowHeight();
2053 while (y > ymin && cur.up())
2057 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
2061 case LFUN_SCREEN_DOWN_SELECT: {
2062 // FIXME: why is the algorithm different from LFUN_SCREEN_DOWN?
2063 cur.selHandle(true);
2064 if (isBottomScreen()) {
2065 lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
2069 int y = getPos(cur).y_;
2070 int const ymax = y + height_ - defaultRowHeight();
2071 while (y < ymax && cur.down())
2075 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
2080 case LFUN_INSET_SELECT_ALL: {
2081 // true if all cells are selected
2082 bool const all_selected = cur.depth() > 1
2083 && cur.selBegin().at_begin()
2084 && cur.selEnd().at_end();
2085 // true if some cells are selected
2086 bool const cells_selected = cur.depth() > 1
2087 && cur.selBegin().at_cell_begin()
2088 && cur.selEnd().at_cell_end();
2089 if (all_selected || (cells_selected && !cur.inset().isTable())) {
2090 // All the contents of the inset if selected, or only at
2091 // least one cell but inset is not a table.
2092 // Select the inset from outside.
2095 cur.selection(true);
2097 } else if (cells_selected) {
2098 // At least one complete cell is selected and inset is a table.
2104 cur.selection(true);
2105 cur.idx() = cur.lastidx();
2106 cur.pit() = cur.lastpit();
2107 cur.pos() = cur.lastpos();
2109 // select current cell
2113 cur.selection(true);
2114 cur.pit() = cur.lastpit();
2115 cur.pos() = cur.lastpos();
2117 cur.setCurrentFont();
2118 dr.screenUpdate(Update::Force);
2123 case LFUN_UNICODE_INSERT: {
2124 if (cmd.argument().empty())
2127 FuncCode code = cur.inset().currentMode() == Inset::MATH_MODE ?
2128 LFUN_MATH_INSERT : LFUN_SELF_INSERT;
2131 docstring const arg = from_utf8(cmd.getArg(i));
2135 LYXERR0("Not a hexstring: " << arg);
2139 char_type c = hexToInt(arg);
2140 if (c >= 32 && c < 0x10ffff) {
2141 LYXERR(Debug::KEY, "Inserting c: " << c);
2142 lyx::dispatch(FuncRequest(code, docstring(1, c)));
2150 // This would be in Buffer class if only Cursor did not
2151 // require a bufferview
2152 case LFUN_INSET_FORALL: {
2153 docstring const name = from_utf8(cmd.getArg(0));
2154 string const commandstr = cmd.getLongArg(1);
2155 FuncRequest const fr = lyxaction.lookupFunc(commandstr);
2157 // an arbitrary number to limit number of iterations
2158 const int max_iter = 100000;
2160 Cursor & bvcur = d->cursor_;
2161 Cursor const savecur = bvcur;
2163 if (!bvcur.nextInset())
2164 bvcur.forwardInset();
2165 bvcur.beginUndoGroup();
2166 while(bvcur && iterations < max_iter) {
2167 Inset * const ins = bvcur.nextInset();
2170 docstring insname = ins->layoutName();
2171 while (!insname.empty()) {
2172 if (insname == name || name == from_utf8("*")) {
2173 lyx::dispatch(fr, dr);
2174 // we do not want to remember selection here
2175 bvcur.clearSelection();
2179 size_t const i = insname.rfind(':');
2180 if (i == string::npos)
2182 insname = insname.substr(0, i);
2184 // if we did not delete the inset, skip it
2185 if (!bvcur.nextInset() || bvcur.nextInset() == ins)
2186 bvcur.forwardInset();
2189 bvcur.fixIfBroken();
2190 /** This is a dummy undo record only to remember the cursor
2191 * that has just been set; this will be used on a redo action
2192 * (see ticket #10097)
2194 * FIXME: a better fix would be to have a way to set the
2195 * cursor value directly, but I am not sure it is worth it.
2198 bvcur.endUndoGroup();
2199 dr.screenUpdate(Update::Force);
2200 dr.forceBufferUpdate();
2202 if (iterations >= max_iter) {
2204 dr.setMessage(bformat(_("`inset-forall' interrupted because number of actions is larger than %1$d"), max_iter));
2206 dr.setMessage(bformat(_("Applied \"%1$s\" to %2$d insets"), from_utf8(commandstr), iterations));
2211 case LFUN_BRANCH_ADD_INSERT: {
2212 docstring branch_name = from_utf8(cmd.getArg(0));
2213 if (branch_name.empty())
2214 if (!Alert::askForText(branch_name, _("Branch name")) ||
2215 branch_name.empty())
2218 DispatchResult drtmp;
2219 buffer_.dispatch(FuncRequest(LFUN_BRANCH_ADD, branch_name), drtmp);
2220 if (drtmp.error()) {
2221 Alert::warning(_("Branch already exists"), drtmp.message());
2224 docstring const sep = buffer_.params().branchlist().separator();
2225 for (docstring const & branch : getVectorFromString(branch_name, sep))
2226 lyx::dispatch(FuncRequest(LFUN_BRANCH_INSERT, branch));
2230 case LFUN_KEYMAP_OFF:
2231 getIntl().keyMapOn(false);
2234 case LFUN_KEYMAP_PRIMARY:
2235 getIntl().keyMapPrim();
2238 case LFUN_KEYMAP_SECONDARY:
2239 getIntl().keyMapSec();
2242 case LFUN_KEYMAP_TOGGLE:
2243 getIntl().toggleKeyMap();
2246 case LFUN_DIALOG_SHOW_NEW_INSET: {
2247 string const name = cmd.getArg(0);
2248 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
2249 if (decodeInsetParam(name, data, buffer_))
2250 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
2252 lyxerr << "Inset type '" << name <<
2253 "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" << endl;
2257 case LFUN_CITATION_INSERT: {
2258 if (argument.empty()) {
2259 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
2262 // we can have one optional argument, delimited by '|'
2263 // citation-insert <key>|<text_before>
2264 // this should be enhanced to also support text_after
2265 // and citation style
2266 string arg = argument;
2268 if (contains(argument, "|")) {
2269 arg = token(argument, '|', 0);
2270 opt1 = token(argument, '|', 1);
2273 // if our cursor is directly in front of or behind a citation inset,
2274 // we will instead add the new key to it.
2275 Inset * inset = cur.nextInset();
2276 if (!inset || inset->lyxCode() != CITE_CODE)
2277 inset = cur.prevInset();
2278 if (inset && inset->lyxCode() == CITE_CODE) {
2279 InsetCitation * icite = static_cast<InsetCitation *>(inset);
2280 if (icite->addKey(arg)) {
2281 dr.forceBufferUpdate();
2282 dr.screenUpdate(Update::FitCursor | Update::SinglePar);
2284 LYXERR0("Discarding optional argument to citation-insert.");
2289 InsetCommandParams icp(CITE_CODE);
2290 icp["key"] = from_utf8(arg);
2292 icp["before"] = from_utf8(opt1);
2294 from_ascii(InsetCitation::last_literal ? "true" : "false");
2295 string icstr = InsetCommand::params2string(icp);
2296 FuncRequest fr(LFUN_INSET_INSERT, icstr);
2299 // if the request comes from the LyX server, then we
2300 // return a list of the undefined keys, in case some
2301 // action could be taken.
2302 if (cmd.origin() != FuncRequest::LYXSERVER)
2305 vector<docstring> keys = getVectorFromString(from_utf8(arg));
2306 vector<docstring>::iterator it = keys.begin();
2307 vector<docstring>::const_iterator end = keys.end();
2309 BiblioInfo const & bibInfo = buffer_.masterBibInfo();
2310 const BiblioInfo::const_iterator bibEnd = bibInfo.end();
2312 if (bibInfo.find(*it) != bibEnd) {
2313 it = keys.erase(it);
2318 dr.setMessage(getStringFromVector(keys));
2323 case LFUN_INSET_APPLY: {
2324 string const name = cmd.getArg(0);
2325 Inset * inset = editedInset(name);
2327 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
2331 // put cursor in front of inset.
2332 if (!setCursorFromInset(inset)) {
2333 LASSERT(false, break);
2336 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
2337 inset->dispatch(cur, fr);
2338 dr.screenUpdate(cur.result().screenUpdate());
2339 if (cur.result().needBufferUpdate())
2340 dr.forceBufferUpdate();
2345 // The change of language of buffer belongs to the Buffer class.
2346 // We have to do it here because we need a cursor for Undo.
2347 // When Undo::recordUndoBufferParams() is implemented someday
2348 // LFUN_BUFFER_LANGUAGE should be handled by the Buffer class.
2349 case LFUN_BUFFER_LANGUAGE: {
2350 Language const * oldL = buffer_.params().language;
2351 Language const * newL = languages.getLanguage(argument);
2352 if (!newL || oldL == newL)
2354 if (oldL->rightToLeft() == newL->rightToLeft()) {
2355 cur.recordUndoFullBuffer();
2356 buffer_.changeLanguage(oldL, newL);
2357 cur.setCurrentFont();
2358 dr.forceBufferUpdate();
2363 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
2364 case LFUN_FILE_INSERT_PLAINTEXT: {
2365 bool const as_paragraph = (act == LFUN_FILE_INSERT_PLAINTEXT_PARA);
2366 string const fname = to_utf8(cmd.argument());
2367 if (!FileName::isAbsolute(fname))
2368 dr.setMessage(_("Absolute filename expected."));
2370 insertPlaintextFile(FileName(fname), as_paragraph);
2375 // With multi-cell table content, we pass down to the inset
2376 if (cur.inTexted() && cur.selection()
2377 && cur.selectionBegin().idx() != cur.selectionEnd().idx()) {
2378 buffer_.dispatch(cmd, dr);
2379 dispatched = dr.dispatched();
2382 cap::copySelection(cur);
2383 cur.message(_("Copy"));
2387 // OK, so try the Buffer itself...
2388 buffer_.dispatch(cmd, dr);
2389 dispatched = dr.dispatched();
2393 buffer_.undo().endUndoGroup();
2394 dr.dispatched(dispatched);
2396 // NOTE: The code below is copied from Cursor::dispatch. If you
2397 // need to modify this, please update the other one too.
2399 // notify insets we just entered/left
2400 if (cursor() != old) {
2401 old.beginUndoGroup();
2403 bool badcursor = notifyCursorLeavesOrEnters(old, cursor());
2405 cursor().fixIfBroken();
2406 resetInlineCompletionPos();
2413 docstring BufferView::requestSelection()
2415 Cursor & cur = d->cursor_;
2417 LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
2418 if (!cur.selection()) {
2419 d->xsel_cache_.set = false;
2423 LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
2424 if (!d->xsel_cache_.set ||
2425 cur.top() != d->xsel_cache_.cursor ||
2426 cur.realAnchor().top() != d->xsel_cache_.anchor)
2428 d->xsel_cache_.cursor = cur.top();
2429 d->xsel_cache_.anchor = cur.realAnchor().top();
2430 d->xsel_cache_.set = cur.selection();
2431 return cur.selectionAsString(false);
2437 void BufferView::clearSelection()
2439 d->cursor_.clearSelection();
2440 // Clear the selection buffer. Otherwise a subsequent
2441 // middle-mouse-button paste would use the selection buffer,
2442 // not the more current external selection.
2443 cap::clearSelection();
2444 d->xsel_cache_.set = false;
2445 // The buffer did not really change, but this causes the
2446 // redraw we need because we cleared the selection above.
2447 buffer_.changed(false);
2451 void BufferView::resize(int width, int height)
2453 // Update from work area
2457 // Clear the paragraph height cache.
2458 d->par_height_.clear();
2459 // Redo the metrics.
2464 Inset const * BufferView::getCoveringInset(Text const & text,
2467 TextMetrics & tm = d->text_metrics_[&text];
2468 Inset * inset = tm.checkInsetHit(x, y);
2472 if (!inset->descendable(*this))
2473 // No need to go further down if the inset is not
2477 size_t cell_number = inset->nargs();
2478 // Check all the inner cell.
2479 for (size_t i = 0; i != cell_number; ++i) {
2480 Text const * inner_text = inset->getText(i);
2483 Inset const * inset_deeper =
2484 getCoveringInset(*inner_text, x, y);
2486 return inset_deeper;
2494 Inset const * BufferView::clickableMathInset(InsetMathNest const * inset,
2495 CoordCache::Insets const & inset_cache, int x, int y) const
2497 for (size_t i = 0; i < inset->nargs(); ++i) {
2498 MathData const & ar = inset->cell(i);
2499 for (size_t j = 0; j < ar.size(); ++j) {
2500 string const name = lyxerr.debugging(Debug::MATHED)
2501 ? insetName(ar[j].nucleus()->lyxCode())
2503 LYXERR(Debug::MATHED, "Checking inset: " << name);
2504 if (ar[j].nucleus()->clickable(*this, x, y)) {
2505 if (inset_cache.covers(ar[j].nucleus(), x, y)) {
2506 LYXERR(Debug::MATHED, "Clickable inset: "
2508 return ar[j].nucleus();
2511 InsetMathNest const * imn =
2512 ar[j].nucleus()->asNestInset();
2514 Inset const * inner =
2515 clickableMathInset(imn, inset_cache, x, y);
2525 void BufferView::updateHoveredInset() const
2527 // Get inset under mouse, if there is one.
2528 int const x = d->mouse_position_cache_.x_;
2529 int const y = d->mouse_position_cache_.y_;
2530 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
2531 if (covering_inset && covering_inset->asInsetMath()) {
2532 Inset const * inner_inset = clickableMathInset(
2533 covering_inset->asInsetMath()->asNestInset(),
2534 coordCache().getInsets(), x, y);
2536 covering_inset = inner_inset;
2539 d->clickable_inset_ = covering_inset && covering_inset->clickable(*this, x, y);
2541 if (covering_inset == d->last_inset_)
2542 // Same inset, no need to do anything...
2545 bool need_redraw = false;
2546 if (d->last_inset_) {
2547 // Remove the hint on the last hovered inset (if any).
2548 need_redraw |= d->last_inset_->setMouseHover(this, false);
2549 d->last_inset_ = nullptr;
2552 if (covering_inset && covering_inset->setMouseHover(this, true)) {
2554 // Only the insets that accept the hover state, do
2555 // clear the last_inset_, so only set the last_inset_
2556 // member if the hovered setting is accepted.
2557 d->last_inset_ = covering_inset;
2561 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
2562 << d->mouse_position_cache_.x_ << ", "
2563 << d->mouse_position_cache_.y_ << ")");
2565 d->update_strategy_ = DecorationUpdate;
2567 // This event (moving without mouse click) is not passed further.
2568 // This should be changed if it is further utilized.
2569 buffer_.changed(false);
2574 void BufferView::clearLastInset(Inset * inset) const
2576 if (d->last_inset_ != inset) {
2577 LYXERR0("Wrong last_inset!");
2580 d->last_inset_ = nullptr;
2584 bool BufferView::mouseSelecting() const
2586 return d->mouse_selecting_;
2590 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
2592 //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
2594 // This is only called for mouse related events including
2595 // LFUN_FILE_OPEN generated by drag-and-drop.
2596 FuncRequest cmd = cmd0;
2598 Cursor old = cursor();
2600 cur.push(buffer_.inset());
2601 cur.selection(d->cursor_.selection());
2603 // Either the inset under the cursor or the
2604 // surrounding Text will handle this event.
2606 // make sure we stay within the screen...
2607 cmd.set_y(min(max(cmd.y(), -1), height_));
2609 d->mouse_position_cache_.x_ = cmd.x();
2610 d->mouse_position_cache_.y_ = cmd.y();
2612 d->mouse_selecting_ =
2613 cmd.action() == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::button1;
2615 if (cmd.action() == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
2616 updateHoveredInset();
2620 // Build temporary cursor.
2621 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x(), cmd.y());
2623 // If inset is not editable, cur.pos() might point behind the
2624 // inset (depending on cmd.x(), cmd.y()). This is needed for
2625 // editing to fix bug 9628, but e.g. the context menu needs a
2626 // cursor in front of the inset.
2627 if ((inset->hasSettings() || !inset->contextMenuName().empty()
2628 || inset->lyxCode() == SEPARATOR_CODE) &&
2629 cur.nextInset() != inset && cur.prevInset() == inset)
2631 } else if (cur.inTexted() && cur.pos()
2632 && cur.paragraph().isEnvSeparator(cur.pos() - 1)) {
2633 // Always place cursor in front of a separator inset.
2637 // Put anchor at the same position.
2640 cur.beginUndoGroup();
2642 // Try to dispatch to an non-editable inset near this position
2643 // via the temp cursor. If the inset wishes to change the real
2644 // cursor it has to do so explicitly by using
2645 // cur.bv().cursor() = cur; (or similar)
2647 inset->dispatch(cur, cmd);
2649 // Now dispatch to the temporary cursor. If the real cursor should
2650 // be modified, the inset's dispatch has to do so explicitly.
2651 if (!inset || !cur.result().dispatched())
2654 // Notify left insets
2656 bool badcursor = old.fixIfBroken() || cur.fixIfBroken();
2657 badcursor = badcursor || notifyCursorLeavesOrEnters(old, cur);
2659 cursor().fixIfBroken();
2664 // Do we have a selection?
2665 theSelection().haveSelection(cursor().selection());
2667 if (cur.needBufferUpdate() || buffer().needUpdate()) {
2668 cur.clearBufferUpdate();
2669 buffer().updateBuffer();
2672 // If the command has been dispatched,
2673 if (cur.result().dispatched() || cur.result().screenUpdate())
2674 processUpdateFlags(cur.result().screenUpdate());
2678 int BufferView::minVisiblePart()
2680 return 2 * defaultRowHeight();
2684 int BufferView::scroll(int pixels)
2687 return scrollDown(pixels);
2689 return scrollUp(-pixels);
2694 int BufferView::scrollDown(int pixels)
2696 Text * text = &buffer_.text();
2697 TextMetrics & tm = d->text_metrics_[text];
2698 int const ymax = height_ + pixels;
2700 pair<pit_type, ParagraphMetrics const *> last = tm.last();
2701 int bottom_pos = last.second->position() + last.second->descent();
2702 if (lyxrc.scroll_below_document)
2703 bottom_pos += height_ - minVisiblePart();
2704 if (last.first + 1 == int(text->paragraphs().size())) {
2705 if (bottom_pos <= height_)
2707 pixels = min(pixels, bottom_pos - height_);
2710 if (bottom_pos > ymax)
2712 tm.newParMetricsDown();
2714 d->anchor_ypos_ -= pixels;
2719 int BufferView::scrollUp(int pixels)
2721 Text * text = &buffer_.text();
2722 TextMetrics & tm = d->text_metrics_[text];
2723 int ymin = - pixels;
2725 pair<pit_type, ParagraphMetrics const *> first = tm.first();
2726 int top_pos = first.second->position() - first.second->ascent();
2727 if (first.first == 0) {
2730 pixels = min(pixels, - top_pos);
2735 tm.newParMetricsUp();
2737 d->anchor_ypos_ += pixels;
2742 bool BufferView::setCursorFromRow(int row)
2744 TexRow::TextEntry start, end;
2745 tie(start,end) = buffer_.texrow().getEntriesFromRow(row);
2746 LYXERR(Debug::OUTFILE,
2747 "setCursorFromRow: for row " << row << ", TexRow has found "
2748 "start (id=" << start.id << ",pos=" << start.pos << "), "
2749 "end (id=" << end.id << ",pos=" << end.pos << ")");
2750 return setCursorFromEntries(start, end);
2754 bool BufferView::setCursorFromEntries(TexRow::TextEntry start,
2755 TexRow::TextEntry end)
2757 DocIterator dit_start, dit_end;
2758 tie(dit_start,dit_end) =
2759 TexRow::getDocIteratorsFromEntries(start, end, buffer_);
2762 // Setting selection start
2763 d->cursor_.clearSelection();
2764 setCursor(dit_start);
2765 // Setting selection end
2767 d->cursor_.resetAnchor();
2768 setCursorSelectionTo(dit_end);
2774 bool BufferView::setCursorFromInset(Inset const * inset)
2776 // are we already there?
2777 if (cursor().nextInset() == inset)
2780 // Inset is not at cursor position. Find it in the document.
2783 while (cur && cur.nextInset() != inset)
2794 void BufferView::gotoLabel(docstring const & label)
2797 bool have_inactive = false;
2798 for (Buffer const * buf : buffer().allRelatives()) {
2800 for (TocItem const & item : *buf->tocBackend().toc("label")) {
2801 if (label == item.str() && item.isOutput()) {
2802 lyx::dispatch(item.action());
2805 // If we find an inactive label, save it for the case
2806 // that no active one is there
2807 if (label == item.str() && !have_inactive) {
2808 have_inactive = true;
2809 action = item.action();
2813 // We only found an inactive label. Go there.
2815 lyx::dispatch(action);
2819 TextMetrics const & BufferView::textMetrics(Text const * t) const
2821 return const_cast<BufferView *>(this)->textMetrics(t);
2825 TextMetrics & BufferView::textMetrics(Text const * t)
2828 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
2829 if (tmc_it == d->text_metrics_.end()) {
2830 tmc_it = d->text_metrics_.emplace(std::piecewise_construct,
2831 std::forward_as_tuple(t),
2832 std::forward_as_tuple(this, const_cast<Text *>(t))).first;
2834 return tmc_it->second;
2838 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
2841 return textMetrics(t).parMetrics(pit);
2845 int BufferView::workHeight() const
2851 void BufferView::setCursor(DocIterator const & dit)
2854 size_t const n = dit.depth();
2855 for (size_t i = 0; i < n; ++i)
2856 dit[i].inset().edit(d->cursor_, true);
2858 d->cursor_.setCursor(dit);
2859 d->cursor_.selection(false);
2860 d->cursor_.setCurrentFont();
2862 // It seems on general grounds as if this is probably needed, but
2863 // it is not yet clear.
2864 // See bug #7394 and r38388.
2865 // d->cursor.resetAnchor();
2869 void BufferView::setCursorSelectionTo(DocIterator const & dit)
2871 size_t const n = dit.depth();
2872 for (size_t i = 0; i < n; ++i)
2873 dit[i].inset().edit(d->cursor_, true);
2875 d->cursor_.selection(true);
2876 d->cursor_.setCursorSelectionTo(dit);
2877 d->cursor_.setCurrentFont();
2881 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
2883 // Would be wrong to delete anything if we have a selection.
2884 if (cur.selection())
2887 bool need_anchor_change = false;
2888 bool changed = Text::deleteEmptyParagraphMechanism(cur, old,
2889 need_anchor_change);
2891 if (need_anchor_change)
2899 // we would rather not do this here, but it needs to be done before
2900 // the changed() signal is sent.
2901 buffer_.updateBuffer();
2903 buffer_.changed(true);
2908 bool BufferView::mouseSetCursor(Cursor & cur, bool const select)
2910 LASSERT(&cur.bv() == this, return false);
2913 // this event will clear selection so we save selection for
2914 // persistent selection
2915 cap::saveSelection(cursor());
2917 d->cursor_.macroModeClose();
2918 // If a macro has been finalized, the cursor might have been broken
2921 // Has the cursor just left the inset?
2922 bool const leftinset = (&d->cursor_.inset() != &cur.inset());
2924 d->cursor_.fixIfBroken();
2926 // do the dEPM magic if needed
2927 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
2928 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
2929 // the leftinset bool would not be necessary (badcursor instead).
2930 bool update = leftinset;
2933 d->cursor_.setSelection();
2934 d->cursor_.setCursorSelectionTo(cur);
2936 if (d->cursor_.inTexted())
2937 update |= checkDepm(cur, d->cursor_);
2938 d->cursor_.resetAnchor();
2939 d->cursor_.setCursor(cur);
2940 d->cursor_.clearSelection();
2942 d->cursor_.boundary(cur.boundary());
2943 d->cursor_.finishUndo();
2944 d->cursor_.setCurrentFont();
2946 cur.forceBufferUpdate();
2951 void BufferView::putSelectionAt(DocIterator const & cur,
2952 int length, bool backwards)
2954 d->cursor_.clearSelection();
2960 d->cursor_.pos() += length;
2961 d->cursor_.setSelection(d->cursor_, -length);
2963 d->cursor_.setSelection(d->cursor_, length);
2968 bool BufferView::selectIfEmpty(DocIterator & cur)
2970 if ((cur.inTexted() && !cur.paragraph().empty())
2971 || (cur.inMathed() && !cur.cell().empty()))
2974 pit_type const beg_pit = cur.pit();
2976 // The paragraph associated to this item isn't
2977 // the first one, so it can be selected
2980 // We have to resort to select the space between the
2981 // end of this item and the begin of the next one
2985 // If it is the only item in the document,
2986 // nothing can be selected
2989 pit_type const end_pit = cur.pit();
2990 pos_type const end_pos = cur.pos();
2991 d->cursor_.clearSelection();
2993 d->cursor_.setCursor(cur);
2994 d->cursor_.pit() = beg_pit;
2995 d->cursor_.pos() = 0;
2996 d->cursor_.selection(false);
2997 d->cursor_.resetAnchor();
2998 d->cursor_.pit() = end_pit;
2999 d->cursor_.pos() = end_pos;
3000 d->cursor_.setSelection();
3005 Cursor & BufferView::cursor()
3011 Cursor const & BufferView::cursor() const
3017 bool BufferView::singleParUpdate()
3019 Text & buftext = buffer_.text();
3020 pit_type const bottom_pit = d->cursor_.bottom().pit();
3021 TextMetrics & tm = textMetrics(&buftext);
3022 Dimension const old_dim = tm.parMetrics(bottom_pit).dim();
3024 // make sure inline completion pointer is ok
3025 if (d->inlineCompletionPos_.fixIfBroken())
3026 d->inlineCompletionPos_ = DocIterator();
3028 // In Single Paragraph mode, rebreak only
3029 // the (main text, not inset!) paragraph containing the cursor.
3030 // (if this paragraph contains insets etc., rebreaking will
3031 // recursively descend)
3032 tm.redoParagraph(bottom_pit);
3033 ParagraphMetrics & pm = tm.parMetrics(bottom_pit);
3034 if (pm.height() != old_dim.height()) {
3035 // Paragraph height has changed so we cannot proceed to
3036 // the singlePar optimisation.
3039 // Since position() points to the baseline of the first row, we
3040 // may have to update it. See ticket #11601 for an example where
3041 // the height does not change but the ascent does.
3042 pm.setPosition(pm.position() - old_dim.ascent() + pm.ascent());
3044 tm.updatePosCache(bottom_pit);
3046 LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
3047 << " y2: " << pm.position() + pm.descent()
3048 << " pit: " << bottom_pit
3049 << " singlepar: 1");
3054 void BufferView::updateMetrics()
3056 updateMetrics(d->update_flags_);
3057 d->update_strategy_ = FullScreenUpdate;
3061 void BufferView::updateMetrics(Update::flags & update_flags)
3063 if (height_ == 0 || width_ == 0)
3066 Text & buftext = buffer_.text();
3067 pit_type const npit = int(buftext.paragraphs().size());
3069 // Clear out the position cache in case of full screen redraw,
3070 d->coord_cache_.clear();
3071 d->math_rows_.clear();
3073 // Clear out paragraph metrics to avoid having invalid metrics
3074 // in the cache from paragraphs not relayouted below
3075 // The complete text metrics will be redone.
3076 d->text_metrics_.clear();
3078 TextMetrics & tm = textMetrics(&buftext);
3080 // make sure inline completion pointer is ok
3081 if (d->inlineCompletionPos_.fixIfBroken())
3082 d->inlineCompletionPos_ = DocIterator();
3084 if (d->anchor_pit_ >= npit)
3085 // The anchor pit must have been deleted...
3086 d->anchor_pit_ = npit - 1;
3088 // Rebreak anchor paragraph.
3089 tm.redoParagraph(d->anchor_pit_);
3090 ParagraphMetrics & anchor_pm = tm.parMetrics(d->anchor_pit_);
3093 if (d->anchor_pit_ == 0) {
3094 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
3096 // Complete buffer visible? Then it's easy.
3097 if (scrollRange == 0)
3098 d->anchor_ypos_ = anchor_pm.ascent();
3100 // avoid empty space above the first row
3101 d->anchor_ypos_ = min(d->anchor_ypos_, anchor_pm.ascent());
3104 anchor_pm.setPosition(d->anchor_ypos_);
3105 tm.updatePosCache(d->anchor_pit_);
3107 LYXERR(Debug::PAINTING, "metrics: "
3108 << " anchor pit = " << d->anchor_pit_
3109 << " anchor ypos = " << d->anchor_ypos_);
3111 // Redo paragraphs above anchor if necessary.
3112 int y1 = d->anchor_ypos_ - anchor_pm.ascent();
3113 // We are now just above the anchor paragraph.
3114 pit_type pit1 = d->anchor_pit_ - 1;
3115 for (; pit1 >= 0 && y1 >= 0; --pit1) {
3116 tm.redoParagraph(pit1);
3117 ParagraphMetrics & pm = tm.parMetrics(pit1);
3119 // Save the paragraph position in the cache.
3121 tm.updatePosCache(pit1);
3125 // Redo paragraphs below the anchor if necessary.
3126 int y2 = d->anchor_ypos_ + anchor_pm.descent();
3127 // We are now just below the anchor paragraph.
3128 pit_type pit2 = d->anchor_pit_ + 1;
3129 for (; pit2 < npit && y2 <= height_; ++pit2) {
3130 tm.redoParagraph(pit2);
3131 ParagraphMetrics & pm = tm.parMetrics(pit2);
3133 // Save the paragraph position in the cache.
3135 tm.updatePosCache(pit2);
3139 LYXERR(Debug::PAINTING, "Metrics: "
3140 << " anchor pit = " << d->anchor_pit_
3141 << " anchor ypos = " << d->anchor_ypos_
3144 << " pit1 = " << pit1
3145 << " pit2 = " << pit2);
3147 // metrics is done, full drawing is necessary now
3148 update_flags = (update_flags & ~Update::Force) | Update::ForceDraw;
3150 // Now update the positions of insets in the cache.
3153 if (lyxerr.debugging(Debug::WORKAREA)) {
3154 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
3155 d->coord_cache_.dump();
3160 void BufferView::updatePosCache()
3162 // this is the "nodraw" drawing stage: only set the positions of the
3163 // insets in metrics cache.
3164 frontend::NullPainter np;
3169 void BufferView::insertLyXFile(FileName const & fname, bool const ignorelang)
3171 LASSERT(d->cursor_.inTexted(), return);
3173 // Get absolute path of file and add ".lyx"
3174 // to the filename if necessary
3175 FileName filename = fileSearch(string(), fname.absFileName(), "lyx");
3177 docstring const disp_fn = makeDisplayPath(filename.absFileName());
3178 // emit message signal.
3179 message(bformat(_("Inserting document %1$s..."), disp_fn));
3182 Buffer buf(filename.absFileName(), false);
3183 if (buf.loadLyXFile() == Buffer::ReadSuccess) {
3184 ErrorList & el = buffer_.errorList("Parse");
3185 // Copy the inserted document error list into the current buffer one.
3186 el = buf.errorList("Parse");
3187 ParagraphList & pars = buf.paragraphs();
3189 // set main language of imported file to context language
3190 buf.changeLanguage(buf.language(), d->cursor_.getFont().language());
3191 buffer_.undo().recordUndo(d->cursor_);
3192 cap::pasteParagraphList(d->cursor_, pars,
3193 buf.params().documentClassPtr(),
3194 buf.params().authors(), el);
3195 res = _("Document %1$s inserted.");
3197 res = _("Could not insert document %1$s");
3200 buffer_.changed(true);
3201 // emit message signal.
3202 message(bformat(res, disp_fn));
3206 Point BufferView::coordOffset(DocIterator const & dit) const
3212 // Addup contribution of nested insets, from inside to outside,
3213 // keeping the outer paragraph for a special handling below
3214 for (size_t i = dit.depth() - 1; i >= 1; --i) {
3215 CursorSlice const & sl = dit[i];
3219 // get relative position inside sl.inset()
3220 sl.inset().cursorPos(*this, sl, dit.boundary() && (i + 1 == dit.depth()), xx, yy);
3222 // Make relative position inside of the edited inset relative to sl.inset()
3226 // In case of an RTL inset, the edited inset will be positioned to the left
3229 bool boundary_i = dit.boundary() && i + 1 == dit.depth();
3230 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
3235 // remember width for the case that sl.inset() is positioned in an RTL inset
3236 lastw = sl.inset().dimension(*this).wid;
3238 //lyxerr << "Cursor::getPos, i: "
3239 // << i << " x: " << xx << " y: " << y << endl;
3242 // Add contribution of initial rows of outermost paragraph
3243 CursorSlice const & sl = dit[0];
3244 TextMetrics const & tm = textMetrics(sl.text());
3245 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
3247 LBUFERR(!pm.rows().empty());
3248 y -= pm.rows()[0].ascent();
3250 // FIXME: document this mess
3252 if (sl.pos() > 0 && dit.depth() == 1) {
3254 if (pos && dit.boundary())
3256 // lyxerr << "coordOffset: boundary:" << dit.boundary() << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
3257 rend = pm.pos2row(pos);
3259 rend = pm.pos2row(sl.pos());
3261 size_t rend = pm.pos2row(sl.pos());
3263 for (size_t rit = 0; rit != rend; ++rit)
3264 y += pm.rows()[rit].height();
3265 y += pm.rows()[rend].ascent();
3267 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
3269 // Make relative position from the nested inset now bufferview absolute.
3270 int xx = bottom_tm.cursorX(dit.bottom(), dit.boundary() && dit.depth() == 1);
3273 // In the RTL case place the nested inset at the left of the cursor in
3274 // the outer paragraph
3275 bool boundary_1 = dit.boundary() && 1 == dit.depth();
3276 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
3284 Point BufferView::getPos(DocIterator const & dit) const
3286 if (!paragraphVisible(dit))
3287 return Point(-1, -1);
3289 CursorSlice const & bot = dit.bottom();
3290 TextMetrics const & tm = textMetrics(bot.text());
3292 // offset from outer paragraph
3293 Point p = coordOffset(dit);
3294 p.y_ += tm.parMetrics(bot.pit()).position();
3299 bool BufferView::paragraphVisible(DocIterator const & dit) const
3301 CursorSlice const & bot = dit.bottom();
3302 TextMetrics const & tm = textMetrics(bot.text());
3304 return tm.contains(bot.pit());
3308 void BufferView::caretPosAndDim(Point & p, Dimension & dim) const
3310 Cursor const & cur = cursor();
3311 if (cur.inMathed()) {
3312 MathRow const & mrow = mathRow(&cur.cell());
3313 dim = mrow.caret_dim;
3315 Font const font = cur.real_current_font;
3316 frontend::FontMetrics const & fm = theFontMetrics(font);
3317 // lineWidth() can be 0 to mean 'thin line' on HiDpi, but the
3318 // caret drawing code is not prepared for that.
3319 dim.wid = max(fm.lineWidth(), 1);
3320 dim.asc = fm.maxAscent();
3321 dim.des = fm.maxDescent();
3323 if (lyxrc.cursor_width > 0)
3324 dim.wid = lyxrc.cursor_width;
3327 // center fat carets horizontally
3328 p.x_ -= dim.wid / 2;
3334 void BufferView::buildCaretGeometry(bool complet)
3338 caretPosAndDim(p, dim);
3340 Cursor const & cur = d->cursor_;
3341 Font const & realfont = cur.real_current_font;
3342 frontend::FontMetrics const & fm = theFontMetrics(realfont.fontInfo());
3343 bool const isrtl = realfont.isVisibleRightToLeft();
3344 int const dir = isrtl ? -1 : 1;
3346 frontend::CaretGeometry & cg = d->caret_geometry_;
3349 // The caret itself, slanted for italics in text edit mode except
3350 // for selections because the selection rect does not slant
3351 bool const slant = fm.italic() && cur.inTexted() && !cur.selection();
3352 double const slope = slant ? fm.italicSlope() : 0;
3353 cg.shapes.push_back(
3354 {{iround(p.x_ + dim.asc * slope), p.y_},
3355 {iround(p.x_ - dim.des * slope), p.y_ + dim.height()},
3356 {iround(p.x_ + dir * dim.wid - dim.des * slope), p.y_ + dim.height()},
3357 {iround(p.x_ + dir * dim.wid + dim.asc * slope), p.y_}}
3360 // The language indicator _| (if needed)
3361 Language const * doclang = buffer().params().language;
3362 if (!((realfont.language() == doclang && isrtl == doclang->rightToLeft())
3363 || realfont.language() == latex_language)) {
3364 int const lx = dim.height() / 3;
3365 int const xx = iround(p.x_ - dim.des * slope);
3366 int const yy = p.y_ + dim.height();
3367 cg.shapes.push_back(
3368 {{xx, yy - dim.wid},
3369 {xx + dir * (dim.wid + lx - 1), yy - dim.wid},
3370 {xx + dir * (dim.wid + lx - 1), yy},
3375 // The completion triangle |> (if needed)
3377 int const m = p.y_ + dim.height() / 2;
3378 int const d = dim.height() / 8;
3379 // offset for slanted carret
3380 int const sx = iround((dim.asc - (dim.height() / 2 - d)) * slope);
3381 // starting position x
3382 int const xx = p.x_ + dir * dim.wid + sx;
3383 cg.shapes.push_back(
3387 {xx, m + d - dim.wid},
3388 {xx + dir * d - dim.wid, m},
3389 {xx, m - d + dim.wid}}
3393 // compute extremal x values
3395 cg.right = -1000000;
3397 cg.bottom = -1000000;
3398 for (auto const & shape : cg.shapes)
3399 for (Point const & p : shape) {
3400 cg.left = min(cg.left, p.x_);
3401 cg.right = max(cg.right, p.x_);
3402 cg.top = min(cg.top, p.y_);
3403 cg.bottom = max(cg.bottom, p.y_);
3408 frontend::CaretGeometry const & BufferView::caretGeometry() const
3410 return d->caret_geometry_;
3414 bool BufferView::caretInView() const
3416 if (!paragraphVisible(cursor()))
3420 caretPosAndDim(p, dim);
3422 // does the cursor touch the screen ?
3423 if (p.y_ + dim.height() < 0 || p.y_ >= workHeight())
3429 int BufferView::horizScrollOffset() const
3431 return d->horiz_scroll_offset_;
3435 int BufferView::horizScrollOffset(Text const * text,
3436 pit_type pit, pos_type pos) const
3438 // Is this a row that is currently scrolled?
3439 if (!d->current_row_slice_.empty()
3440 && &text->inset() == d->current_row_slice_.inset().asInsetText()
3441 && pit == d->current_row_slice_.pit()
3442 && pos == d->current_row_slice_.pos())
3443 return d->horiz_scroll_offset_;
3448 void BufferView::setCurrentRowSlice(CursorSlice const & rowSlice)
3450 // nothing to do if the cursor was already on this row
3451 if (d->current_row_slice_ == rowSlice)
3454 // if the (previous) current row was scrolled, we have to
3455 // remember it in order to repaint it next time.
3456 if (d->horiz_scroll_offset_ != 0) {
3457 // search the old row in cache and mark it changed
3458 for (auto & tm_pair : d->text_metrics_) {
3459 if (&tm_pair.first->inset() == rowSlice.inset().asInsetText()) {
3460 tm_pair.second.setRowChanged(rowSlice.pit(), rowSlice.pos());
3461 // We found it, no need to continue.
3467 // Since we changed row, the scroll offset is not valid anymore
3468 d->horiz_scroll_offset_ = 0;
3469 d->current_row_slice_ = rowSlice;
3473 void BufferView::checkCursorScrollOffset()
3475 CursorSlice rowSlice = d->cursor_.bottom();
3476 TextMetrics const & tm = textMetrics(rowSlice.text());
3478 // Stop if metrics have not been computed yet, since it means
3479 // that there is nothing to do.
3480 if (!tm.contains(rowSlice.pit()))
3482 ParagraphMetrics const & pm = tm.parMetrics(rowSlice.pit());
3483 Row const & row = pm.getRow(rowSlice.pos(),
3484 d->cursor_.boundary() && rowSlice == d->cursor_.top());
3485 rowSlice.pos() = row.pos();
3487 // Set the row on which the cursor lives.
3488 setCurrentRowSlice(rowSlice);
3490 // Current x position of the cursor in pixels
3491 int cur_x = getPos(d->cursor_).x_;
3493 // Horizontal scroll offset of the cursor row in pixels
3494 int offset = d->horiz_scroll_offset_;
3495 int const MARGIN = 2 * theFontMetrics(d->cursor_.real_current_font).em()
3497 if (row.right_x() <= workWidth() - row.right_margin) {
3498 // Row is narrower than the work area, no offset needed.
3501 if (cur_x - offset < MARGIN) {
3502 // cursor would be too far right
3503 offset = cur_x - MARGIN;
3504 } else if (cur_x - offset > workWidth() - MARGIN) {
3505 // cursor would be too far left
3506 offset = cur_x - workWidth() + MARGIN;
3508 // Correct the offset to make sure that we do not scroll too much
3511 if (row.right_x() - offset < workWidth() - row.right_margin)
3512 offset = row.right_x() - workWidth() + row.right_margin;
3515 //lyxerr << "cur_x=" << cur_x << ", offset=" << offset << ", row.wid=" << row.width() << ", margin=" << MARGIN << endl;
3517 if (offset != d->horiz_scroll_offset_) {
3518 LYXERR(Debug::PAINTING, "Horiz. scroll offset changed from "
3519 << d->horiz_scroll_offset_ << " to " << offset);
3521 if (d->update_strategy_ == NoScreenUpdate)
3522 d->update_strategy_ = SingleParUpdate;
3525 d->horiz_scroll_offset_ = offset;
3529 void BufferView::draw(frontend::Painter & pain, bool paint_caret)
3531 if (height_ == 0 || width_ == 0)
3533 LYXERR(Debug::PAINTING, (pain.isNull() ? "\t\t--- START NODRAW ---"
3534 : "\t\t*** START DRAWING ***"));
3535 Text & text = buffer_.text();
3536 TextMetrics const & tm = d->text_metrics_[&text];
3537 int const y = tm.first().second->position();
3538 PainterInfo pi(this, pain);
3540 // Check whether the row where the cursor lives needs to be scrolled.
3541 // Update the drawing strategy if needed.
3542 checkCursorScrollOffset();
3544 switch (d->update_strategy_) {
3546 case NoScreenUpdate:
3547 // no screen painting is actually needed. In nodraw stage
3548 // however, the different coordinates of insets and paragraphs
3549 // needs to be updated.
3550 LYXERR(Debug::PAINTING, "Strategy: NoScreenUpdate");
3551 if (pain.isNull()) {
3552 pi.full_repaint = true;
3555 pi.full_repaint = false;
3560 case SingleParUpdate:
3561 pi.full_repaint = false;
3562 LYXERR(Debug::PAINTING, "Strategy: SingleParUpdate");
3563 // In general, only the current row of the outermost paragraph
3564 // will be redrawn. Particular cases where selection spans
3565 // multiple paragraph are correctly detected in TextMetrics.
3569 case DecorationUpdate:
3570 // FIXME: We should also distinguish DecorationUpdate to avoid text
3571 // drawing if possible. This is not possible to do easily right now
3572 // because of the single backing pixmap.
3574 case FullScreenUpdate:
3576 LYXERR(Debug::PAINTING,
3577 ((d->update_strategy_ == FullScreenUpdate)
3578 ? "Strategy: FullScreenUpdate"
3579 : "Strategy: DecorationUpdate"));
3581 // The whole screen, including insets, will be refreshed.
3582 pi.full_repaint = true;
3584 // Clear background.
3585 pain.fillRectangle(0, 0, width_, height_,
3586 pi.backgroundColor(&buffer_.inset()));
3591 // and possibly grey out below
3592 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3593 int const y2 = lastpm.second->position() + lastpm.second->descent();
3596 Color color = buffer().isInternal()
3597 ? Color_background : Color_bottomarea;
3598 pain.fillRectangle(0, y2, width_, height_ - y2, color);
3602 LYXERR(Debug::PAINTING, (pain.isNull() ? "\t\t --- END NODRAW ---"
3603 : "\t\t *** END DRAWING ***"));
3605 // The scrollbar needs an update.
3606 // FIXME: does it always? see ticket #11947.
3607 updateScrollbarParameters();
3609 // Normalize anchor for next time
3610 pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
3611 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3612 for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
3613 ParagraphMetrics const & pm = tm.parMetrics(pit);
3614 if (pm.position() + pm.descent() > 0) {
3615 if (d->anchor_pit_ != pit
3616 || d->anchor_ypos_ != pm.position())
3617 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
3618 << " anchor ypos = " << d->anchor_ypos_);
3619 d->anchor_pit_ = pit;
3620 d->anchor_ypos_ = pm.position();
3624 if (!pain.isNull()) {
3625 // reset the update flags, everything has been done
3626 d->update_flags_ = Update::None;
3629 // If a caret has to be painted, mark its text row as dirty to
3630 //make sure that it will be repainted on next redraw.
3631 /* FIXME: investigate whether this can be avoided when the cursor did not
3635 Cursor cur(d->cursor_);
3636 while (cur.depth() > 1) {
3637 if (!cur.inTexted())
3639 TextMetrics const & tm = textMetrics(cur.text());
3640 if (d->caret_geometry_.left >= tm.origin().x_
3641 && d->caret_geometry_.right <= tm.origin().x_ + tm.dim().width())
3645 cur.textRow().changed(true);
3650 void BufferView::message(docstring const & msg)
3653 d->gui_->message(msg);
3657 void BufferView::showDialog(string const & name)
3660 d->gui_->showDialog(name, string());
3664 void BufferView::showDialog(string const & name,
3665 string const & data, Inset * inset)
3668 d->gui_->showDialog(name, data, inset);
3672 void BufferView::updateDialog(string const & name, string const & data)
3675 d->gui_->updateDialog(name, data);
3679 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
3685 // FIXME: Move this out of BufferView again
3686 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
3688 if (!fname.isReadableFile()) {
3689 docstring const error = from_ascii(strerror(errno));
3690 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3691 docstring const text =
3692 bformat(_("Could not read the specified document\n"
3693 "%1$s\ndue to the error: %2$s"), file, error);
3694 Alert::error(_("Could not read file"), text);
3698 if (!fname.isReadableFile()) {
3699 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3700 docstring const text =
3701 bformat(_("%1$s\n is not readable."), file);
3702 Alert::error(_("Could not open file"), text);
3706 // FIXME UNICODE: We don't know the encoding of the file
3707 docstring file_content = fname.fileContents("UTF-8");
3708 if (file_content.empty()) {
3709 Alert::error(_("Reading not UTF-8 encoded file"),
3710 _("The file is not UTF-8 encoded.\n"
3711 "It will be read as local 8Bit-encoded.\n"
3712 "If this does not give the correct result\n"
3713 "then please change the encoding of the file\n"
3714 "to UTF-8 with a program other than LyX.\n"));
3715 file_content = fname.fileContents("local8bit");
3718 return normalize_c(file_content);
3722 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
3724 docstring const tmpstr = contentsOfPlaintextFile(f);
3729 Cursor & cur = cursor();
3730 cap::replaceSelection(cur);
3731 buffer_.undo().recordUndo(cur);
3733 cur.innerText()->insertStringAsParagraphs(cur, tmpstr, cur.current_font);
3735 cur.innerText()->insertStringAsLines(cur, tmpstr, cur.current_font);
3737 buffer_.changed(true);
3741 docstring const & BufferView::inlineCompletion() const
3743 return d->inlineCompletion_;
3747 size_t BufferView::inlineCompletionUniqueChars() const
3749 return d->inlineCompletionUniqueChars_;
3753 DocIterator const & BufferView::inlineCompletionPos() const
3755 return d->inlineCompletionPos_;
3759 void BufferView::resetInlineCompletionPos()
3761 d->inlineCompletionPos_ = DocIterator();
3765 bool samePar(DocIterator const & a, DocIterator const & b)
3767 if (a.empty() && b.empty())
3769 if (a.empty() || b.empty())
3771 if (a.depth() != b.depth())
3773 return &a.innerParagraph() == &b.innerParagraph();
3777 void BufferView::setInlineCompletion(Cursor const & cur, DocIterator const & pos,
3778 docstring const & completion, size_t uniqueChars)
3780 uniqueChars = min(completion.size(), uniqueChars);
3781 bool changed = d->inlineCompletion_ != completion
3782 || d->inlineCompletionUniqueChars_ != uniqueChars;
3783 bool singlePar = true;
3784 d->inlineCompletion_ = completion;
3785 d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
3787 //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
3790 DocIterator const & old = d->inlineCompletionPos_;
3792 //lyxerr << "inlineCompletionPos changed" << std::endl;
3793 // old or pos are in another paragraph?
3794 if ((!samePar(cur, pos) && !pos.empty())
3795 || (!samePar(cur, old) && !old.empty())) {
3797 //lyxerr << "different paragraph" << std::endl;
3799 d->inlineCompletionPos_ = pos;
3804 if (singlePar && !(cur.result().screenUpdate() & Update::Force))
3805 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
3807 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::Force);
3812 bool BufferView::clickableInset() const
3814 return d->clickable_inset_;