3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Alfredo Braunstein
7 * \author Lars Gullik Bjønnes
10 * \author Jürgen Vigna
12 * Full author contact details are available in file CREDITS.
17 #include "BufferView.h"
19 #include "BranchList.h"
21 #include "BufferList.h"
22 #include "BufferParams.h"
23 #include "CoordCache.h"
25 #include "CutAndPaste.h"
26 #include "DispatchResult.h"
27 #include "ErrorList.h"
28 #include "FuncRequest.h"
29 #include "FuncStatus.h"
32 #include "LayoutFile.h"
35 #include "LyXAction.h"
38 #include "MetricsInfo.h"
39 #include "Paragraph.h"
42 #include "TextMetrics.h"
44 #include "TocBackend.h"
46 #include "insets/InsetBibtex.h"
47 #include "insets/InsetCitation.h"
48 #include "insets/InsetCommand.h" // ChangeRefs
49 #include "insets/InsetGraphics.h"
50 #include "insets/InsetRef.h"
51 #include "insets/InsetText.h"
53 #include "mathed/MathData.h"
55 #include "frontends/alert.h"
56 #include "frontends/CaretGeometry.h"
57 #include "frontends/Delegates.h"
58 #include "frontends/FontMetrics.h"
59 #include "frontends/NullPainter.h"
60 #include "frontends/Painter.h"
61 #include "frontends/Selection.h"
63 #include "support/convert.h"
64 #include "support/debug.h"
65 #include "support/docstring.h"
66 #include "support/filetools.h"
67 #include "support/gettext.h"
68 #include "support/lassert.h"
69 #include "support/Length.h"
70 #include "support/lstrings.h"
71 #include "support/lyxlib.h"
72 #include "support/types.h"
84 using namespace lyx::support;
88 namespace Alert = frontend::Alert;
92 /// Return an inset of this class if it exists at the current cursor position
94 T * getInsetByCode(Cursor const & cur, InsetCode code)
97 Inset * inset = it.nextInset();
98 if (inset && inset->lyxCode() == code)
99 return static_cast<T*>(inset);
104 /// Note that comparing contents can only be used for InsetCommand
105 bool findNextInset(DocIterator & dit, vector<InsetCode> const & codes,
106 docstring const & contents)
108 DocIterator tmpdit = dit;
111 Inset const * inset = tmpdit.nextInset();
113 bool const valid_code = std::find(codes.begin(), codes.end(),
114 inset->lyxCode()) != codes.end();
115 InsetCommand const * ic = inset->asInsetCommand();
116 bool const same_or_no_contents = contents.empty()
117 || (ic && (ic->getFirstNonOptParam() == contents));
119 if (valid_code && same_or_no_contents) {
124 tmpdit.forwardInset();
131 /// Looks for next inset with one of the given codes.
132 /// Note that same_content can only be used for InsetCommand
133 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
137 DocIterator tmpdit = dit;
138 tmpdit.forwardInset();
142 Inset const * inset = tmpdit.nextInset();
143 if (same_content && inset) {
144 InsetCommand const * ic = inset->asInsetCommand();
146 bool const valid_code = std::find(codes.begin(), codes.end(),
147 ic->lyxCode()) != codes.end();
149 contents = ic->getFirstNonOptParam();
153 if (!findNextInset(tmpdit, codes, contents)) {
154 if (dit.depth() != 1 || dit.pit() != 0 || dit.pos() != 0) {
155 inset = &tmpdit.bottom().inset();
156 tmpdit = doc_iterator_begin(&inset->buffer(), inset);
157 if (!findNextInset(tmpdit, codes, contents))
169 /// Moves cursor to the next inset with one of the given codes.
170 void gotoInset(BufferView * bv, vector<InsetCode> const & codes,
173 Cursor tmpcur = bv->cursor();
174 if (!findInset(tmpcur, codes, same_content)) {
175 bv->cursor().message(_("No more insets"));
179 tmpcur.clearSelection();
180 bv->setCursor(tmpcur);
185 /// A map from a Text to the associated text metrics
186 typedef map<Text const *, TextMetrics> TextMetricsCache;
188 enum ScreenUpdateStrategy {
198 /////////////////////////////////////////////////////////////////////
202 /////////////////////////////////////////////////////////////////////
204 struct BufferView::Private
206 Private(BufferView & bv) :
207 update_strategy_(FullScreenUpdate),
208 update_flags_(Update::Force),
209 cursor_(bv), anchor_pit_(0), anchor_ypos_(0),
210 wh_(0), inlineCompletionUniqueChars_(0),
211 last_inset_(nullptr), mouse_position_cache_(),
212 gui_(nullptr), bookmark_edit_position_(-1),
213 horiz_scroll_offset_(0), clickable_inset_(false)
215 xsel_cache_.set = false;
219 ScrollbarParameters scrollbarParameters_;
221 ScreenUpdateStrategy update_strategy_;
223 Update::flags update_flags_;
225 CoordCache coord_cache_;
227 typedef map<MathData const *, MathRow> MathRows;
230 /// this is used to handle XSelection events in the right manner.
239 pit_type anchor_pit_;
242 /// Estimated average par height for scrollbar.
245 vector<int> par_height_;
248 DocIterator inlineCompletionPos_;
250 docstring inlineCompletion_;
252 size_t inlineCompletionUniqueChars_;
254 /// keyboard mapping object.
257 /// last visited inset.
258 /** kept to send setMouseHover(false).
259 * Not owned, so don't delete.
261 Inset const * last_inset_;
263 /// position of the mouse at the time of the last mouse move
264 /// This is used to update the hovering status of inset in
265 /// cases where the buffer is scrolled, but the mouse didn't move.
266 Point mouse_position_cache_;
268 mutable TextMetricsCache text_metrics_;
271 /** Not owned, so don't delete.
273 frontend::GuiBufferViewDelegate * gui_;
275 /// Cache for Find Next
276 FuncRequest search_request_cache_;
279 map<string, Inset *> edited_insets_;
281 /// When the row where the cursor lies is scrolled, this
282 /// contains the scroll offset
283 // cache for id of the paragraph which was edited the last time
284 int bookmark_edit_position_;
286 int horiz_scroll_offset_;
287 /// a slice pointing to the start of the row where the cursor
288 /// is (at last draw time)
289 CursorSlice current_row_slice_;
290 /// are we hovering something that we can click
291 bool clickable_inset_;
292 /// shape of the caret
293 frontend::CaretGeometry caret_geometry_;
297 BufferView::BufferView(Buffer & buf)
298 : width_(0), height_(0), full_screen_(false), buffer_(buf),
299 d(new Private(*this))
301 d->xsel_cache_.set = false;
302 d->intl_.initKeyMapper(lyxrc.use_kbmap);
304 d->cursor_.setBuffer(&buf);
305 d->cursor_.push(buffer_.inset());
306 d->cursor_.resetAnchor();
307 d->cursor_.setCurrentFont();
309 buffer_.updatePreviews();
313 BufferView::~BufferView()
315 // current buffer is going to be switched-off, save cursor pos
316 // Ideally, the whole cursor stack should be saved, but session
317 // currently can only handle bottom (whole document) level pit and pos.
318 // That is to say, if a cursor is in a nested inset, it will be
319 // restore to the left of the top level inset.
320 LastFilePosSection::FilePos fp;
321 fp.file = buffer_.fileName();
322 fp.pit = d->cursor_.bottom().pit();
323 fp.pos = d->cursor_.bottom().pos();
324 theSession().lastFilePos().save(fp);
327 d->last_inset_->setMouseHover(this, false);
333 int BufferView::rightMargin() const
335 // The value used to be hardcoded to 10
336 int const default_margin = zoomedPixels(10);
337 // The additional test for the case the outliner is opened.
338 if (!full_screen_ || !lyxrc.full_screen_limit
339 || width_ < lyxrc.full_screen_width + 2 * default_margin)
340 return default_margin;
342 return (width_ - lyxrc.full_screen_width) / 2;
346 int BufferView::leftMargin() const
348 return rightMargin();
352 int BufferView::topMargin() const
354 // original value was 20px, which is 0.2in at 100dpi
355 return zoomedPixels(20);
359 int BufferView::bottomMargin() const
361 // original value was 20px, which is 0.2in at 100dpi
362 return zoomedPixels(20);
366 int BufferView::inPixels(Length const & len) const
368 Font const font = buffer().params().getFont();
369 return len.inPixels(workWidth(), theFontMetrics(font).em());
373 int BufferView::zoomedPixels(int pix) const
375 // FIXME: the dpi setting should really depend on the BufferView
376 // (think different monitors).
378 // Zoom factor specified by user in percent
379 double const zoom = lyxrc.currentZoom / 100.0; // [percent]
381 // DPI setting for monitor relative to 100dpi
382 double const dpizoom = lyxrc.dpi / 100.0; // [per 100dpi]
384 return support::iround(pix * zoom * dpizoom);
388 bool BufferView::isTopScreen() const
390 return 0 == d->scrollbarParameters_.min;
394 bool BufferView::isBottomScreen() const
396 return 0 == d->scrollbarParameters_.max;
400 Intl & BufferView::getIntl()
406 Intl const & BufferView::getIntl() const
412 CoordCache & BufferView::coordCache()
414 return d->coord_cache_;
418 CoordCache const & BufferView::coordCache() const
420 return d->coord_cache_;
424 MathRow const & BufferView::mathRow(MathData const * cell) const
426 auto it = d->math_rows_.find(cell);
427 LATTEST(it != d->math_rows_.end());
432 void BufferView::setMathRow(MathData const * cell, MathRow const & mrow)
434 d->math_rows_[cell] = mrow;
438 Buffer & BufferView::buffer()
444 Buffer const & BufferView::buffer() const
450 bool BufferView::needsFitCursor() const
452 if (cursorStatus(d->cursor_) == CUR_INSIDE) {
453 frontend::FontMetrics const & fm =
454 theFontMetrics(d->cursor_.getFont().fontInfo());
455 int const asc = fm.maxAscent();
456 int const des = fm.maxDescent();
457 Point const p = getPos(d->cursor_);
458 if (p.y_ - asc >= 0 && p.y_ + des < height_)
467 // this is for debugging only.
468 string flagsAsString(Update::flags flags)
470 if (flags == Update::None)
472 return string((flags & Update::FitCursor) ? "FitCursor " : "")
473 + ((flags & Update::Force) ? "Force " : "")
474 + ((flags & Update::ForceDraw) ? "ForceDraw " : "")
475 + ((flags & Update::SinglePar) ? "SinglePar " : "")
476 + ((flags & Update::Decoration) ? "Decoration " : "");
481 void BufferView::processUpdateFlags(Update::flags flags)
483 LYXERR(Debug::PAINTING, "BufferView::processUpdateFlags( "
484 << flagsAsString(flags) << ") buffer: " << &buffer_);
486 // Case when no explicit update is requested.
487 if (flags == Update::None)
490 /* FIXME We would like to avoid doing this here, since it is very
491 * expensive and is called in updateBuffer already. However, even
492 * inserting a plain character can invalidate the overly fragile
493 * tables of child documents built by updateMacros. Some work is
494 * needed to avoid doing that when not necessary.
496 buffer_.updateMacros();
498 // First check whether the metrics and inset positions should be updated
499 if (flags & Update::Force) {
500 // This will update the CoordCache items and replace Force
501 // with ForceDraw in flags.
502 updateMetrics(flags);
505 // Detect whether we can only repaint a single paragraph (if we
506 // are not already redrawing all).
507 // We handle this before FitCursor because the later will require
508 // correct metrics at cursor position.
509 if (!(flags & Update::ForceDraw)
510 && (flags & Update::SinglePar)
511 && !singleParUpdate())
512 updateMetrics(flags);
514 // Then make sure that the screen contains the cursor if needed
515 if (flags & Update::FitCursor) {
516 if (needsFitCursor()) {
517 // First try to make the selection start visible
518 // (which is just the cursor when there is no selection)
519 scrollToCursor(d->cursor_.selectionBegin(), false);
520 // Metrics have to be recomputed (maybe again)
522 // Is the cursor visible? (only useful if cursor is at end of selection)
523 if (needsFitCursor()) {
524 // then try to make cursor visible instead
525 scrollToCursor(d->cursor_, false);
526 // Metrics have to be recomputed (maybe again)
527 updateMetrics(flags);
530 flags = flags & ~Update::FitCursor;
533 // Add flags to the the update flags. These will be reset to None
534 // after the redraw is actually done
535 d->update_flags_ = d->update_flags_ | flags;
536 LYXERR(Debug::PAINTING, "Cumulative flags: " << flagsAsString(flags));
538 // Now compute the update strategy
539 // Possibly values in flag are None, SinglePar, Decoration, ForceDraw
540 LATTEST((d->update_flags_ & ~(Update::None | Update::SinglePar
541 | Update::Decoration | Update::ForceDraw)) == 0);
543 if (d->update_flags_ & Update::ForceDraw)
544 d->update_strategy_ = FullScreenUpdate;
545 else if (d->update_flags_ & Update::Decoration)
546 d->update_strategy_ = DecorationUpdate;
547 else if (d->update_flags_ & Update::SinglePar)
548 d->update_strategy_ = SingleParUpdate;
550 // no need to redraw anything.
551 d->update_strategy_ = NoScreenUpdate;
554 updateHoveredInset();
557 buffer_.changed(false);
561 void BufferView::updateScrollbar()
563 if (height_ == 0 && width_ == 0)
566 // We prefer fixed size line scrolling.
567 d->scrollbarParameters_.single_step = defaultRowHeight();
568 // We prefer full screen page scrolling.
569 d->scrollbarParameters_.page_step = height_;
571 Text & t = buffer_.text();
572 TextMetrics & tm = d->text_metrics_[&t];
574 LYXERR(Debug::GUI, " Updating scrollbar: height: "
575 << t.paragraphs().size()
576 << " curr par: " << d->cursor_.bottom().pit()
577 << " default height " << defaultRowHeight());
579 size_t const parsize = t.paragraphs().size();
580 if (d->par_height_.size() != parsize) {
581 d->par_height_.clear();
582 // FIXME: We assume a default paragraph height of 2 rows. This
583 // should probably be pondered with the screen width.
584 d->par_height_.resize(parsize, defaultRowHeight() * 2);
587 // Look at paragraph heights on-screen
588 pair<pit_type, ParagraphMetrics const *> first = tm.first();
589 pair<pit_type, ParagraphMetrics const *> last = tm.last();
590 for (pit_type pit = first.first; pit <= last.first; ++pit) {
591 d->par_height_[pit] = tm.parMetrics(pit).height();
592 LYXERR(Debug::SCROLLING, "storing height for pit " << pit << " : "
593 << d->par_height_[pit]);
596 int top_pos = first.second->position() - first.second->ascent();
597 int bottom_pos = last.second->position() + last.second->descent();
598 bool first_visible = first.first == 0 && top_pos >= 0;
599 bool last_visible = last.first + 1 == int(parsize) && bottom_pos <= height_;
600 if (first_visible && last_visible) {
601 d->scrollbarParameters_.min = 0;
602 d->scrollbarParameters_.max = 0;
606 d->scrollbarParameters_.min = top_pos;
607 for (size_t i = 0; i != size_t(first.first); ++i)
608 d->scrollbarParameters_.min -= d->par_height_[i];
609 d->scrollbarParameters_.max = bottom_pos;
610 for (size_t i = last.first + 1; i != parsize; ++i)
611 d->scrollbarParameters_.max += d->par_height_[i];
613 // The reference is the top position so we remove one page.
614 if (lyxrc.scroll_below_document)
615 d->scrollbarParameters_.max -= minVisiblePart();
617 d->scrollbarParameters_.max -= d->scrollbarParameters_.page_step;
619 // 0 must be inside the range as it denotes the current position
620 if (d->scrollbarParameters_.max < 0)
621 d->scrollbarParameters_.max = 0;
622 if (d->scrollbarParameters_.min > 0)
623 d->scrollbarParameters_.min = 0;
627 ScrollbarParameters const & BufferView::scrollbarParameters() const
629 return d->scrollbarParameters_;
633 docstring BufferView::toolTip(int x, int y) const
635 // Get inset under mouse, if there is one.
636 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
638 // No inset, no tooltip...
640 return covering_inset->toolTip(*this, x, y);
644 string BufferView::contextMenu(int x, int y) const
646 //If there is a selection, return the containing inset menu
647 if (d->cursor_.selection())
648 return d->cursor_.inset().contextMenu(*this, x, y);
650 // Get inset under mouse, if there is one.
651 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
653 return covering_inset->contextMenu(*this, x, y);
655 return buffer_.inset().contextMenu(*this, x, y);
660 void BufferView::scrollDocView(int const pixels, bool update)
662 // The scrollbar values are relative to the top of the screen, therefore the
663 // offset is equal to the target value.
665 // No scrolling at all? No need to redraw anything
669 // If the offset is less than 2 screen height, prefer to scroll instead.
670 if (abs(pixels) <= 2 * height_) {
671 d->anchor_ypos_ -= pixels;
672 processUpdateFlags(Update::Force);
676 // cut off at the top
677 if (pixels <= d->scrollbarParameters_.min) {
678 DocIterator dit = doc_iterator_begin(&buffer_);
679 showCursor(dit, false, update);
680 LYXERR(Debug::SCROLLING, "scroll to top");
684 // cut off at the bottom
685 if (pixels >= d->scrollbarParameters_.max) {
686 DocIterator dit = doc_iterator_end(&buffer_);
688 showCursor(dit, false, update);
689 LYXERR(Debug::SCROLLING, "scroll to bottom");
693 // find paragraph at target position
694 int par_pos = d->scrollbarParameters_.min;
696 for (; i != int(d->par_height_.size()); ++i) {
697 par_pos += d->par_height_[i];
698 if (par_pos >= pixels)
702 if (par_pos < pixels) {
703 // It seems we didn't find the correct pit so stay on the safe side and
705 LYXERR0("scrolling position not found!");
706 scrollDocView(d->scrollbarParameters_.max, update);
710 DocIterator dit = doc_iterator_begin(&buffer_);
712 LYXERR(Debug::SCROLLING, "pixels = " << pixels << " -> scroll to pit " << i);
713 showCursor(dit, false, update);
717 // FIXME: this method is not working well.
718 void BufferView::setCursorFromScrollbar()
720 TextMetrics & tm = d->text_metrics_[&buffer_.text()];
722 int const height = 2 * defaultRowHeight();
723 int const first = height;
724 int const last = height_ - height;
726 Cursor const & oldcur = d->cursor_;
728 switch (cursorStatus(oldcur)) {
736 int const y = getPos(oldcur).y_;
737 newy = min(last, max(y, first));
741 // We reset the cursor because cursorStatus() does not
742 // work when the cursor is within mathed.
745 tm.setCursorFromCoordinates(cur, 0, newy);
747 // update the bufferview cursor and notify insets
748 // FIXME: Care about the d->cursor_ flags to redraw if needed
749 Cursor old = d->cursor_;
751 // the DEPM call in mouseSetCursor() might have destroyed the
752 // paragraph the cursor is in.
753 bool badcursor = old.fixIfBroken();
754 badcursor |= notifyCursorLeavesOrEnters(old, d->cursor_);
756 d->cursor_.fixIfBroken();
760 Change const BufferView::getCurrentChange() const
762 if (!d->cursor_.selection())
763 return Change(Change::UNCHANGED);
765 DocIterator dit = d->cursor_.selectionBegin();
766 // The selected content might have been changed (see #7685)
767 dit = dit.getInnerText();
768 return dit.paragraph().lookupChange(dit.pos());
772 // this could be used elsewhere as well?
773 // FIXME: This does not work within mathed!
774 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
776 Point const p = getPos(dit);
779 if (p.y_ > workHeight())
785 void BufferView::bookmarkEditPosition()
787 // Don't eat cpu time for each keystroke
788 if (d->cursor_.paragraph().id() == d->bookmark_edit_position_)
791 d->bookmark_edit_position_ = d->cursor_.paragraph().id();
795 void BufferView::saveBookmark(unsigned int idx)
797 // tentatively save bookmark, id and pos will be used to
798 // acturately locate a bookmark in a 'live' lyx session.
799 // pit and pos will be updated with bottom level pit/pos
801 if (!buffer_.isInternal()) {
802 theSession().bookmarks().save(
804 d->cursor_.bottom().pit(),
805 d->cursor_.bottom().pos(),
806 d->cursor_.paragraph().id(),
811 // emit message signal.
812 message(_("Save bookmark"));
817 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
818 int top_id, pos_type top_pos)
820 bool success = false;
823 d->cursor_.clearSelection();
825 // if a valid par_id is given, try it first
826 // This is the case for a 'live' bookmark when unique paragraph ID
827 // is used to track bookmarks.
829 dit = buffer_.getParFromID(top_id);
831 dit.pos() = min(dit.paragraph().size(), top_pos);
832 // Some slices of the iterator may not be
833 // reachable (e.g. closed collapsible inset)
834 // so the dociterator may need to be
835 // shortened. Otherwise, setCursor may crash
836 // lyx when the cursor can not be set to these
838 size_t const n = dit.depth();
839 for (size_t i = 0; i < n; ++i)
840 if (!dit[i].inset().editable()) {
848 // if top_id == 0, or searching through top_id failed
849 // This is the case for a 'restored' bookmark when only bottom
850 // (document level) pit was saved. Because of this, bookmark
851 // restoration is inaccurate. If a bookmark was within an inset,
852 // it will be restored to the left of the outmost inset that contains
854 if (bottom_pit < int(buffer_.paragraphs().size())) {
855 dit = doc_iterator_begin(&buffer_);
857 dit.pit() = bottom_pit;
858 dit.pos() = min(bottom_pos, dit.paragraph().size());
863 // Note: only bottom (document) level pit is set.
865 // set the current font.
866 d->cursor_.setCurrentFont();
867 // Do not forget to reset the anchor (see #9912)
868 d->cursor_.resetAnchor();
869 processUpdateFlags(Update::Force | Update::FitCursor);
876 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
878 if (d->cursor_.real_current_font.isRightToLeft()) {
879 if (d->intl_.keymap == Intl::PRIMARY)
880 d->intl_.keyMapSec();
882 if (d->intl_.keymap == Intl::SECONDARY)
883 d->intl_.keyMapPrim();
886 d->intl_.getTransManager().translateAndInsert(c, t, cur);
890 int BufferView::workWidth() const
896 void BufferView::recenter()
898 showCursor(d->cursor_, true, true);
902 void BufferView::showCursor()
904 showCursor(d->cursor_, false, true);
908 void BufferView::showCursor(DocIterator const & dit,
909 bool recenter, bool update)
911 if (scrollToCursor(dit, recenter) && update)
912 processUpdateFlags(Update::Force);
916 void BufferView::scrollToCursor()
918 if (scrollToCursor(d->cursor_, false))
919 processUpdateFlags(Update::Force);
923 bool BufferView::scrollToCursor(DocIterator const & dit, bool const recenter)
925 // We are not properly started yet, delay until resizing is
931 LYXERR(Debug::SCROLLING, "recentering and scrolling to cursor");
933 LYXERR(Debug::SCROLLING, "scrolling to cursor");
935 CursorSlice const & bot = dit.bottom();
936 TextMetrics & tm = d->text_metrics_[bot.text()];
938 pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
939 pos_type bot_pit = bot.pit();
940 if (bot_pit > max_pit) {
941 // FIXME: Why does this happen?
942 LYXERR0("bottom pit is greater that max pit: "
943 << bot_pit << " > " << max_pit);
947 if (bot_pit == tm.first().first - 1)
948 tm.newParMetricsUp();
949 else if (bot_pit == tm.last().first + 1)
950 tm.newParMetricsDown();
952 if (tm.contains(bot_pit)) {
953 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
954 LBUFERR(!pm.rows().empty());
955 // FIXME: smooth scrolling doesn't work in mathed.
956 CursorSlice const & cs = dit.innerTextSlice();
957 int offset = coordOffset(dit).y_;
958 int ypos = pm.position() + offset;
959 Dimension const & row_dim =
960 pm.getRow(cs.pos(), dit.boundary()).dim();
963 scrolled = scroll(ypos - height_/2);
965 // We try to visualize the whole row, if the row height is larger than
966 // the screen height, we scroll to a heuristic value of height_ / 4.
967 // FIXME: This heuristic value should be replaced by a recursive search
968 // for a row in the inset that can be visualized completely.
969 else if (row_dim.height() > height_) {
970 if (ypos < defaultRowHeight())
971 scrolled = scroll(ypos - height_ / 4);
972 else if (ypos > height_ - defaultRowHeight())
973 scrolled = scroll(ypos - 3 * height_ / 4);
976 // If the top part of the row falls of the screen, we scroll
977 // up to align the top of the row with the top of the screen.
978 else if (ypos - row_dim.ascent() < 0 && ypos < height_) {
979 int ynew = row_dim.ascent();
980 scrolled = scrollUp(ynew - ypos);
983 // If the bottom of the row falls of the screen, we scroll down.
984 else if (ypos + row_dim.descent() > height_ && ypos > 0) {
985 int ynew = height_ - row_dim.descent();
986 scrolled = scrollDown(ypos - ynew);
989 // else, nothing to do, the cursor is already visible so we just return.
990 return scrolled != 0;
993 // fix inline completion position
994 if (d->inlineCompletionPos_.fixIfBroken())
995 d->inlineCompletionPos_ = DocIterator();
997 tm.redoParagraph(bot_pit);
998 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
999 int offset = coordOffset(dit).y_;
1001 d->anchor_pit_ = bot_pit;
1002 CursorSlice const & cs = dit.innerTextSlice();
1003 Dimension const & row_dim =
1004 pm.getRow(cs.pos(), dit.boundary()).dim();
1007 d->anchor_ypos_ = height_/2;
1008 else if (d->anchor_pit_ == 0)
1009 d->anchor_ypos_ = offset + pm.ascent();
1010 else if (d->anchor_pit_ == max_pit)
1011 d->anchor_ypos_ = height_ - offset - row_dim.descent();
1012 else if (offset > height_)
1013 d->anchor_ypos_ = height_ - offset - defaultRowHeight();
1015 d->anchor_ypos_ = defaultRowHeight() * 2;
1021 void BufferView::makeDocumentClass()
1023 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1024 buffer_.params().makeDocumentClass();
1025 updateDocumentClass(olddc);
1029 void BufferView::updateDocumentClass(DocumentClassConstPtr olddc)
1031 message(_("Converting document to new document class..."));
1033 StableDocIterator backcur(d->cursor_);
1034 ErrorList & el = buffer_.errorList("Class Switch");
1035 cap::switchBetweenClasses(
1036 olddc, buffer_.params().documentClassPtr(),
1037 static_cast<InsetText &>(buffer_.inset()), el);
1039 setCursor(backcur.asDocIterator(&buffer_));
1041 buffer_.errors("Class Switch");
1045 /** Return the change status at cursor position, taking into account the
1046 * status at each level of the document iterator (a table in a deleted
1047 * footnote is deleted).
1048 * When \param outer is true, the top slice is not looked at.
1050 static Change::Type lookupChangeType(DocIterator const & dit, bool outer = false)
1052 size_t const depth = dit.depth() - (outer ? 1 : 0);
1054 for (size_t i = 0 ; i < depth ; ++i) {
1055 CursorSlice const & slice = dit[i];
1056 if (!slice.inset().inMathed()
1057 && slice.pos() < slice.paragraph().size()) {
1058 Change::Type const ch = slice.paragraph().lookupChange(slice.pos()).type;
1059 if (ch != Change::UNCHANGED)
1063 return Change::UNCHANGED;
1067 bool BufferView::getStatus(FuncRequest const & cmd, FuncStatus & flag)
1069 FuncCode const act = cmd.action();
1071 // Can we use a readonly buffer?
1072 if (buffer_.isReadonly()
1073 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1074 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1075 if (buffer_.hasReadonlyFlag())
1076 flag.message(from_utf8(N_("Document is read-only")));
1078 flag.message(from_utf8(N_("Document has been modified externally")));
1079 flag.setEnabled(false);
1083 // Are we in a DELETED change-tracking region?
1084 if (lookupChangeType(d->cursor_, true) == Change::DELETED
1085 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1086 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1087 flag.message(from_utf8(N_("This portion of the document is deleted.")));
1088 flag.setEnabled(false);
1092 Cursor & cur = d->cursor_;
1094 if (cur.getStatus(cmd, flag))
1099 // FIXME: This is a bit problematic because we don't check if this is
1100 // a document BufferView or not for these LFUNs. We probably have to
1101 // dispatch both to currentBufferView() and, if that fails,
1102 // to documentBufferView(); same as we do now for current Buffer and
1103 // document Buffer. Ideally those LFUN should go to Buffer as they
1104 // operate on the full Buffer and the cursor is only needed either for
1105 // an Undo record or to restore a cursor position. But we don't know
1106 // how to do that inside Buffer of course.
1107 case LFUN_BUFFER_PARAMS_APPLY:
1108 case LFUN_LAYOUT_MODULES_CLEAR:
1109 case LFUN_LAYOUT_MODULE_ADD:
1110 case LFUN_LAYOUT_RELOAD:
1111 case LFUN_TEXTCLASS_APPLY:
1112 case LFUN_TEXTCLASS_LOAD:
1113 flag.setEnabled(!buffer_.isReadonly());
1117 // We do not use the LyXAction flag for readonly because Undo sets the
1118 // buffer clean/dirty status by itself.
1119 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasUndoStack());
1122 // We do not use the LyXAction flag for readonly because Redo sets the
1123 // buffer clean/dirty status by itself.
1124 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasRedoStack());
1126 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
1127 case LFUN_FILE_INSERT_PLAINTEXT: {
1128 docstring const & fname = cmd.argument();
1129 if (!FileName::isAbsolute(to_utf8(fname))) {
1130 flag.message(_("Absolute filename expected."));
1133 flag.setEnabled(cur.inTexted());
1136 case LFUN_FILE_INSERT:
1137 case LFUN_BOOKMARK_SAVE:
1138 // FIXME: Actually, these LFUNS should be moved to Text
1139 flag.setEnabled(cur.inTexted());
1142 case LFUN_FONT_STATE:
1143 case LFUN_LABEL_INSERT:
1144 case LFUN_INFO_INSERT:
1145 case LFUN_PARAGRAPH_GOTO:
1146 case LFUN_NOTE_NEXT:
1147 case LFUN_REFERENCE_NEXT:
1148 case LFUN_WORD_FIND:
1149 case LFUN_WORD_FIND_FORWARD:
1150 case LFUN_WORD_FIND_BACKWARD:
1151 case LFUN_WORD_REPLACE:
1154 case LFUN_MARK_TOGGLE:
1155 case LFUN_SCREEN_RECENTER:
1156 case LFUN_SCREEN_SHOW_CURSOR:
1157 case LFUN_BIBTEX_DATABASE_ADD:
1158 case LFUN_BIBTEX_DATABASE_DEL:
1159 case LFUN_STATISTICS:
1160 case LFUN_KEYMAP_OFF:
1161 case LFUN_KEYMAP_PRIMARY:
1162 case LFUN_KEYMAP_SECONDARY:
1163 case LFUN_KEYMAP_TOGGLE:
1164 case LFUN_INSET_SELECT_ALL:
1165 flag.setEnabled(true);
1168 case LFUN_GRAPHICS_UNIFY:
1169 flag.setEnabled(cur.countInsetsInSelection(GRAPHICS_CODE)>1);
1172 case LFUN_WORD_FINDADV: {
1173 FindAndReplaceOptions opt;
1174 istringstream iss(to_utf8(cmd.argument()));
1176 flag.setEnabled(opt.repl_buf_name.empty()
1177 || !buffer_.isReadonly());
1181 case LFUN_LABEL_GOTO:
1182 flag.setEnabled(!cmd.argument().empty()
1183 || getInsetByCode<InsetRef>(cur, REF_CODE));
1186 case LFUN_CHANGES_MERGE:
1187 case LFUN_CHANGE_NEXT:
1188 case LFUN_CHANGE_PREVIOUS:
1189 case LFUN_ALL_CHANGES_ACCEPT:
1190 case LFUN_ALL_CHANGES_REJECT:
1191 flag.setEnabled(buffer_.areChangesPresent());
1194 case LFUN_SCREEN_UP:
1195 case LFUN_SCREEN_DOWN:
1197 case LFUN_SCREEN_UP_SELECT:
1198 case LFUN_SCREEN_DOWN_SELECT:
1199 case LFUN_INSET_FORALL:
1200 flag.setEnabled(true);
1203 case LFUN_LAYOUT_TABULAR:
1204 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
1208 flag.setEnabled(!cur.inset().forcePlainLayout(cur.idx()));
1211 case LFUN_LAYOUT_PARAGRAPH:
1212 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
1215 case LFUN_BRANCH_ADD_INSERT:
1216 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1219 case LFUN_DIALOG_SHOW_NEW_INSET:
1220 // FIXME: this is wrong, but I do not understand the
1222 if (cur.inset().lyxCode() == CAPTION_CODE)
1223 return cur.inset().getStatus(cur, cmd, flag);
1224 // FIXME we should consider passthru paragraphs too.
1225 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1228 case LFUN_CITATION_INSERT: {
1229 FuncRequest fr(LFUN_INSET_INSERT, "citation");
1230 // FIXME: This could turn in a recursive hell.
1231 // Shouldn't we use Buffer::getStatus() instead?
1232 flag.setEnabled(lyx::getStatus(fr).enabled());
1235 case LFUN_INSET_APPLY: {
1236 string const name = cmd.getArg(0);
1237 Inset * inset = editedInset(name);
1239 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1240 if (!inset->getStatus(cur, fr, flag)) {
1241 // Every inset is supposed to handle this
1242 LASSERT(false, break);
1245 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1246 flag = lyx::getStatus(fr);
1259 Inset * BufferView::editedInset(string const & name) const
1261 map<string, Inset *>::const_iterator it = d->edited_insets_.find(name);
1262 return it == d->edited_insets_.end() ? nullptr : it->second;
1266 void BufferView::editInset(string const & name, Inset * inset)
1269 d->edited_insets_[name] = inset;
1271 d->edited_insets_.erase(name);
1275 void BufferView::dispatch(FuncRequest const & cmd, DispatchResult & dr)
1277 LYXERR(Debug::ACTION, "BufferView::dispatch: cmd: " << cmd);
1279 string const argument = to_utf8(cmd.argument());
1280 Cursor & cur = d->cursor_;
1283 // Don't dispatch function that does not apply to internal buffers.
1284 if (buffer_.isInternal()
1285 && lyxaction.funcHasFlag(cmd.action(), LyXAction::NoInternal))
1288 // We'll set this back to false if need be.
1289 bool dispatched = true;
1290 buffer_.undo().beginUndoGroup();
1292 FuncCode const act = cmd.action();
1295 case LFUN_BUFFER_PARAMS_APPLY: {
1296 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1297 cur.recordUndoBufferParams();
1298 istringstream ss(to_utf8(cmd.argument()));
1301 int const unknown_tokens = buffer_.readHeader(lex);
1302 if (unknown_tokens != 0) {
1303 LYXERR0("Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1304 << unknown_tokens << " unknown token"
1305 << (unknown_tokens == 1 ? "" : "s"));
1307 updateDocumentClass(olddc);
1309 // We are most certainly here because of a change in the document
1310 // It is then better to make sure that all dialogs are in sync with
1311 // current document settings.
1312 dr.screenUpdate(Update::Force | Update::FitCursor);
1313 dr.forceBufferUpdate();
1317 case LFUN_LAYOUT_MODULES_CLEAR: {
1318 // FIXME: this modifies the document in cap::switchBetweenClasses
1319 // without calling recordUndo. Fix this before using
1320 // recordUndoBufferParams().
1321 cur.recordUndoFullBuffer();
1322 buffer_.params().clearLayoutModules();
1323 makeDocumentClass();
1324 dr.screenUpdate(Update::Force);
1325 dr.forceBufferUpdate();
1329 case LFUN_LAYOUT_MODULE_ADD: {
1330 BufferParams const & params = buffer_.params();
1331 if (!params.layoutModuleCanBeAdded(argument)) {
1332 LYXERR0("Module `" << argument <<
1333 "' cannot be added due to failed requirements or "
1334 "conflicts with installed modules.");
1337 // FIXME: this modifies the document in cap::switchBetweenClasses
1338 // without calling recordUndo. Fix this before using
1339 // recordUndoBufferParams().
1340 cur.recordUndoFullBuffer();
1341 buffer_.params().addLayoutModule(argument);
1342 makeDocumentClass();
1343 dr.screenUpdate(Update::Force);
1344 dr.forceBufferUpdate();
1348 case LFUN_TEXTCLASS_APPLY: {
1349 // since this shortcircuits, the second call is made only if
1351 bool const success =
1352 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1353 LayoutFileList::get().load(argument, buffer_.filePath());
1355 docstring s = bformat(_("The document class `%1$s' "
1356 "could not be loaded."), from_utf8(argument));
1357 frontend::Alert::error(_("Could not load class"), s);
1361 LayoutFile const * old_layout = buffer_.params().baseClass();
1362 LayoutFile const * new_layout = &(LayoutFileList::get()[argument]);
1364 if (old_layout == new_layout)
1368 // Save the old, possibly modular, layout for use in conversion.
1369 // FIXME: this modifies the document in cap::switchBetweenClasses
1370 // without calling recordUndo. Fix this before using
1371 // recordUndoBufferParams().
1372 cur.recordUndoFullBuffer();
1373 buffer_.params().setBaseClass(argument, buffer_.layoutPos());
1374 makeDocumentClass();
1375 dr.screenUpdate(Update::Force);
1376 dr.forceBufferUpdate();
1380 case LFUN_TEXTCLASS_LOAD: {
1381 // since this shortcircuits, the second call is made only if
1383 bool const success =
1384 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1385 LayoutFileList::get().load(argument, buffer_.filePath());
1387 docstring s = bformat(_("The document class `%1$s' "
1388 "could not be loaded."), from_utf8(argument));
1389 frontend::Alert::error(_("Could not load class"), s);
1394 case LFUN_LAYOUT_RELOAD: {
1395 LayoutFileIndex bc = buffer_.params().baseClassID();
1396 LayoutFileList::get().reset(bc);
1397 buffer_.params().setBaseClass(bc, buffer_.layoutPos());
1398 makeDocumentClass();
1399 dr.screenUpdate(Update::Force);
1400 dr.forceBufferUpdate();
1405 dr.setMessage(_("Undo"));
1406 cur.clearSelection();
1407 // We need to find out if the bibliography information
1408 // has changed. See bug #11055.
1409 // So these should not be references...
1410 string const engine = buffer().params().citeEngine();
1411 CiteEngineType const enginetype = buffer().params().citeEngineType();
1412 if (!cur.undoAction())
1413 dr.setMessage(_("No further undo information"));
1415 dr.screenUpdate(Update::Force | Update::FitCursor);
1416 dr.forceBufferUpdate();
1417 if (buffer().params().citeEngine() != engine ||
1418 buffer().params().citeEngineType() != enginetype)
1419 buffer().invalidateCiteLabels();
1425 dr.setMessage(_("Redo"));
1426 cur.clearSelection();
1427 // We need to find out if the bibliography information
1428 // has changed. See bug #11055.
1429 // So these should not be references...
1430 string const engine = buffer().params().citeEngine();
1431 CiteEngineType const enginetype = buffer().params().citeEngineType();
1432 if (!cur.redoAction())
1433 dr.setMessage(_("No further redo information"));
1435 dr.screenUpdate(Update::Force | Update::FitCursor);
1436 dr.forceBufferUpdate();
1437 if (buffer().params().citeEngine() != engine ||
1438 buffer().params().citeEngineType() != enginetype)
1439 buffer().invalidateCiteLabels();
1444 case LFUN_FONT_STATE:
1445 dr.setMessage(cur.currentState(false));
1448 case LFUN_BOOKMARK_SAVE:
1449 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1452 case LFUN_LABEL_GOTO: {
1453 docstring label = cmd.argument();
1454 if (label.empty()) {
1456 getInsetByCode<InsetRef>(cur, REF_CODE);
1458 label = inset->getParam("reference");
1459 // persistent=false: use temp_bookmark
1463 if (!label.empty()) {
1465 // at the moment, this is redundant, since gotoLabel will
1466 // eventually call LFUN_PARAGRAPH_GOTO, but it seems best
1468 dr.screenUpdate(Update::Force | Update::FitCursor);
1473 case LFUN_PARAGRAPH_GOTO: {
1474 int const id = convert<int>(cmd.getArg(0));
1475 pos_type const pos = convert<int>(cmd.getArg(1));
1478 string const str_id_end = cmd.getArg(2);
1479 string const str_pos_end = cmd.getArg(3);
1481 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1482 b = theBufferList().next(b)) {
1485 curs.setCursor(b->getParFromID(id));
1487 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1491 LYXERR(Debug::INFO, "Paragraph " << curs.paragraph().id()
1492 << " found in buffer `"
1493 << b->absFileName() << "'.");
1495 if (b == &buffer_) {
1497 if (str_id_end.empty() || str_pos_end.empty()) {
1500 mouseSetCursor(curs);
1503 int const id_end = convert<int>(str_id_end);
1504 pos_type const pos_end = convert<int>(str_pos_end);
1505 success = setCursorFromEntries({id, pos},
1509 dr.screenUpdate(Update::Force | Update::FitCursor);
1511 // Switch to other buffer view and resend cmd
1512 lyx::dispatch(FuncRequest(
1513 LFUN_BUFFER_SWITCH, b->absFileName()));
1521 case LFUN_NOTE_NEXT:
1522 gotoInset(this, { NOTE_CODE }, false);
1523 // FIXME: if SinglePar is changed to act on the inner
1524 // paragraph, this will not be OK anymore. The update is
1525 // useful for auto-open collapsible insets.
1526 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1529 case LFUN_REFERENCE_NEXT: {
1530 gotoInset(this, { LABEL_CODE, REF_CODE }, true);
1531 // FIXME: if SinglePar is changed to act on the inner
1532 // paragraph, this will not be OK anymore. The update is
1533 // useful for auto-open collapsible insets.
1534 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1538 case LFUN_CHANGE_NEXT:
1539 findNextChange(this);
1540 if (cur.inset().isTable())
1541 // In tables, there might be whole changed rows or columns
1543 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1544 dr.screenUpdate(Update::Force | Update::FitCursor);
1547 case LFUN_CHANGE_PREVIOUS:
1548 findPreviousChange(this);
1549 if (cur.inset().isTable())
1550 // In tables, there might be whole changed rows or columns
1552 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1553 dr.screenUpdate(Update::Force | Update::FitCursor);
1556 case LFUN_CHANGES_MERGE:
1557 if (findNextChange(this) || findPreviousChange(this)) {
1558 dr.screenUpdate(Update::Force | Update::FitCursor);
1559 dr.forceBufferUpdate();
1560 showDialog("changes");
1564 case LFUN_ALL_CHANGES_ACCEPT: {
1565 // select complete document
1567 cur.selHandle(true);
1568 buffer_.text().cursorBottom(cur);
1569 // accept everything in a single step to support atomic undo
1570 // temporarily disable track changes in order to end with really
1571 // no new (e.g., DPSM-caused) changes (see #7487)
1572 bool const track = buffer_.params().track_changes;
1573 buffer_.params().track_changes = false;
1574 buffer_.text().acceptOrRejectChanges(cur, Text::ACCEPT);
1575 buffer_.params().track_changes = track;
1577 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1578 dr.screenUpdate(Update::Force | Update::FitCursor);
1579 dr.forceBufferUpdate();
1583 case LFUN_ALL_CHANGES_REJECT: {
1584 // select complete document
1586 cur.selHandle(true);
1587 buffer_.text().cursorBottom(cur);
1588 // reject everything in a single step to support atomic undo
1589 // temporarily disable track changes in order to end with really
1590 // no new (e.g., DPSM-caused) changes (see #7487)
1591 bool const track = buffer_.params().track_changes;
1592 buffer_.params().track_changes = false;
1593 buffer_.text().acceptOrRejectChanges(cur, Text::REJECT);
1594 buffer_.params().track_changes = track;
1596 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1597 dr.screenUpdate(Update::Force | Update::FitCursor);
1598 dr.forceBufferUpdate();
1602 case LFUN_WORD_FIND_FORWARD:
1603 case LFUN_WORD_FIND_BACKWARD: {
1605 // Would it maybe be better if this variable were view specific anyway?
1606 static docstring last_search;
1607 docstring searched_string;
1609 if (!cmd.argument().empty()) {
1610 last_search = cmd.argument();
1611 searched_string = cmd.argument();
1613 searched_string = last_search;
1616 if (searched_string.empty())
1619 bool const fw = act == LFUN_WORD_FIND_FORWARD;
1620 docstring const data =
1621 find2string(searched_string, true, false, fw);
1622 bool found = lyxfind(this, FuncRequest(LFUN_WORD_FIND, data));
1624 dr.screenUpdate(Update::Force | Update::FitCursor);
1628 case LFUN_WORD_FIND: {
1629 FuncRequest req = cmd;
1630 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1631 req = d->search_request_cache_;
1632 if (req.argument().empty()) {
1633 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, "findreplace"));
1636 if (lyxfind(this, req))
1637 dr.screenUpdate(Update::Force | Update::FitCursor);
1639 d->search_request_cache_ = req;
1643 case LFUN_WORD_REPLACE: {
1644 bool has_deleted = false;
1645 if (cur.selection()) {
1646 DocIterator beg = cur.selectionBegin();
1647 DocIterator end = cur.selectionEnd();
1648 if (beg.pit() == end.pit()) {
1649 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1650 if (!cur.inMathed() && cur.paragraph().isDeleted(p)) {
1657 if (lyxreplace(this, cmd, has_deleted)) {
1658 dr.forceBufferUpdate();
1659 dr.screenUpdate(Update::Force | Update::FitCursor);
1664 case LFUN_WORD_FINDADV: {
1665 FindAndReplaceOptions opt;
1666 istringstream iss(to_utf8(cmd.argument()));
1668 if (findAdv(this, opt)) {
1669 dr.screenUpdate(Update::Force | Update::FitCursor);
1680 cur.clearSelection();
1681 dr.setMessage(from_utf8(N_("Mark off")));
1685 cur.clearSelection();
1687 dr.setMessage(from_utf8(N_("Mark on")));
1690 case LFUN_MARK_TOGGLE:
1691 cur.selection(false);
1694 dr.setMessage(from_utf8(N_("Mark removed")));
1697 dr.setMessage(from_utf8(N_("Mark set")));
1702 case LFUN_SCREEN_SHOW_CURSOR:
1706 case LFUN_SCREEN_RECENTER:
1710 case LFUN_BIBTEX_DATABASE_ADD: {
1711 Cursor tmpcur = cur;
1712 findInset(tmpcur, { BIBTEX_CODE }, false);
1713 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1716 if (inset->addDatabase(cmd.argument()))
1717 dr.forceBufferUpdate();
1722 case LFUN_BIBTEX_DATABASE_DEL: {
1723 Cursor tmpcur = cur;
1724 findInset(tmpcur, { BIBTEX_CODE }, false);
1725 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1728 if (inset->delDatabase(cmd.argument()))
1729 dr.forceBufferUpdate();
1734 case LFUN_GRAPHICS_UNIFY: {
1736 cur.recordUndoFullBuffer();
1738 DocIterator from, to;
1739 from = cur.selectionBegin();
1740 to = cur.selectionEnd();
1742 string const newId = cmd.getArg(0);
1743 bool fetchId = newId.empty(); //if we wait for groupId from first graphics inset
1745 InsetGraphicsParams grp_par;
1747 InsetGraphics::string2params(graphics::getGroupParams(buffer_, newId), buffer_, grp_par);
1749 if (!from.nextInset()) //move to closest inset
1750 from.forwardInset();
1752 while (!from.empty() && from < to) {
1753 Inset * inset = from.nextInset();
1756 InsetGraphics * ig = inset->asInsetGraphics();
1758 InsetGraphicsParams inspar = ig->getParams();
1763 grp_par.filename = inspar.filename;
1764 ig->setParams(grp_par);
1767 from.forwardInset();
1769 dr.screenUpdate(Update::Force); //needed if triggered from context menu
1773 case LFUN_STATISTICS: {
1774 DocIterator from, to;
1775 if (cur.selection()) {
1776 from = cur.selectionBegin();
1777 to = cur.selectionEnd();
1779 from = doc_iterator_begin(&buffer_);
1780 to = doc_iterator_end(&buffer_);
1782 buffer_.updateStatistics(from, to);
1783 int const words = buffer_.wordCount();
1784 int const chars = buffer_.charCount(false);
1785 int const chars_blanks = buffer_.charCount(true);
1787 if (cur.selection())
1788 message = _("Statistics for the selection:");
1790 message = _("Statistics for the document:");
1793 message += bformat(_("%1$d words"), words);
1795 message += _("One word");
1797 if (chars_blanks != 1)
1798 message += bformat(_("%1$d characters (including blanks)"),
1801 message += _("One character (including blanks)");
1804 message += bformat(_("%1$d characters (excluding blanks)"),
1807 message += _("One character (excluding blanks)");
1809 Alert::information(_("Statistics"), message);
1813 case LFUN_SCREEN_UP:
1814 case LFUN_SCREEN_DOWN: {
1815 Point p = getPos(cur);
1816 // This code has been commented out to enable to scroll down a
1817 // document, even if there are large insets in it (see bug #5465).
1818 /*if (p.y_ < 0 || p.y_ > height_) {
1819 // The cursor is off-screen so recenter before proceeding.
1823 int const scrolled = scroll(act == LFUN_SCREEN_UP
1824 ? -height_ : height_);
1825 if (act == LFUN_SCREEN_UP && scrolled > -height_)
1827 if (act == LFUN_SCREEN_DOWN && scrolled < height_)
1828 p = Point(width_, height_);
1829 bool const in_texted = cur.inTexted();
1830 cur.setCursor(doc_iterator_begin(cur.buffer()));
1831 cur.selHandle(false);
1832 // Force an immediate computation of metrics because we need it below
1833 processUpdateFlags(Update::Force);
1835 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_,
1836 true, act == LFUN_SCREEN_UP);
1837 //FIXME: what to do with cur.x_target()?
1838 bool update = in_texted && cur.bv().checkDepm(cur, old);
1841 if (update || cur.mark())
1842 dr.screenUpdate(Update::Force | Update::FitCursor);
1844 dr.forceBufferUpdate();
1849 string const scroll_type = cmd.getArg(0);
1850 int scroll_step = 0;
1851 if (scroll_type == "line")
1852 scroll_step = d->scrollbarParameters_.single_step;
1853 else if (scroll_type == "page")
1854 scroll_step = d->scrollbarParameters_.page_step;
1857 string const scroll_quantity = cmd.getArg(1);
1858 if (scroll_quantity == "up")
1859 scrollUp(scroll_step);
1860 else if (scroll_quantity == "down")
1861 scrollDown(scroll_step);
1863 int const scroll_value = convert<int>(scroll_quantity);
1865 scroll(scroll_step * scroll_value);
1867 dr.screenUpdate(Update::ForceDraw);
1868 dr.forceBufferUpdate();
1872 case LFUN_SCREEN_UP_SELECT: {
1873 // FIXME: why is the algorithm different from LFUN_SCREEN_UP?
1874 cur.selHandle(true);
1875 if (isTopScreen()) {
1876 lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1880 int y = getPos(cur).y_;
1881 int const ymin = y - height_ + defaultRowHeight();
1882 while (y > ymin && cur.up())
1886 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1890 case LFUN_SCREEN_DOWN_SELECT: {
1891 // FIXME: why is the algorithm different from LFUN_SCREEN_DOWN?
1892 cur.selHandle(true);
1893 if (isBottomScreen()) {
1894 lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1898 int y = getPos(cur).y_;
1899 int const ymax = y + height_ - defaultRowHeight();
1900 while (y < ymax && cur.down())
1904 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1909 case LFUN_INSET_SELECT_ALL: {
1910 // true if all cells are selected
1911 bool const all_selected = cur.depth() > 1
1912 && cur.selBegin().at_begin()
1913 && cur.selEnd().at_end();
1914 // true if some cells are selected
1915 bool const cells_selected = cur.depth() > 1
1916 && cur.selBegin().at_cell_begin()
1917 && cur.selEnd().at_cell_end();
1918 if (all_selected || (cells_selected && !cur.inset().isTable())) {
1919 // All the contents of the inset if selected, or only at
1920 // least one cell but inset is not a table.
1921 // Select the inset from outside.
1924 cur.selection(true);
1926 } else if (cells_selected) {
1927 // At least one complete cell is selected and inset is a table.
1933 cur.selection(true);
1934 cur.idx() = cur.lastidx();
1935 cur.pit() = cur.lastpit();
1936 cur.pos() = cur.lastpos();
1938 // select current cell
1942 cur.selection(true);
1943 cur.pit() = cur.lastpit();
1944 cur.pos() = cur.lastpos();
1946 cur.setCurrentFont();
1947 dr.screenUpdate(Update::Force);
1952 case LFUN_UNICODE_INSERT: {
1953 if (cmd.argument().empty())
1956 FuncCode code = cur.inset().currentMode() == Inset::MATH_MODE ?
1957 LFUN_MATH_INSERT : LFUN_SELF_INSERT;
1960 docstring const arg = from_utf8(cmd.getArg(i));
1964 LYXERR0("Not a hexstring: " << arg);
1968 char_type c = hexToInt(arg);
1969 if (c >= 32 && c < 0x10ffff) {
1970 LYXERR(Debug::KEY, "Inserting c: " << c);
1971 lyx::dispatch(FuncRequest(code, docstring(1, c)));
1979 // This would be in Buffer class if only Cursor did not
1980 // require a bufferview
1981 case LFUN_INSET_FORALL: {
1982 docstring const name = from_utf8(cmd.getArg(0));
1983 string const commandstr = cmd.getLongArg(1);
1984 FuncRequest const fr = lyxaction.lookupFunc(commandstr);
1986 // an arbitrary number to limit number of iterations
1987 const int max_iter = 100000;
1989 Cursor & curs = d->cursor_;
1990 Cursor const savecur = curs;
1992 if (!curs.nextInset())
1993 curs.forwardInset();
1994 curs.beginUndoGroup();
1995 while(curs && iterations < max_iter) {
1996 Inset * const ins = curs.nextInset();
1999 docstring insname = ins->layoutName();
2000 while (!insname.empty()) {
2001 if (insname == name || name == from_utf8("*")) {
2003 lyx::dispatch(fr, dr);
2007 size_t const i = insname.rfind(':');
2008 if (i == string::npos)
2010 insname = insname.substr(0, i);
2012 // if we did not delete the inset, skip it
2013 if (!curs.nextInset() || curs.nextInset() == ins)
2014 curs.forwardInset();
2018 /** This is a dummy undo record only to remember the cursor
2019 * that has just been set; this will be used on a redo action
2020 * (see ticket #10097)
2022 * FIXME: a better fix would be to have a way to set the
2023 * cursor value directly, but I am not sure it is worth it.
2026 curs.endUndoGroup();
2027 dr.screenUpdate(Update::Force);
2028 dr.forceBufferUpdate();
2030 if (iterations >= max_iter) {
2032 dr.setMessage(bformat(_("`inset-forall' interrupted because number of actions is larger than %1$d"), max_iter));
2034 dr.setMessage(bformat(_("Applied \"%1$s\" to %2$d insets"), from_utf8(commandstr), iterations));
2039 case LFUN_BRANCH_ADD_INSERT: {
2040 docstring branch_name = from_utf8(cmd.getArg(0));
2041 if (branch_name.empty())
2042 if (!Alert::askForText(branch_name, _("Branch name")) ||
2043 branch_name.empty())
2046 DispatchResult drtmp;
2047 buffer_.dispatch(FuncRequest(LFUN_BRANCH_ADD, branch_name), drtmp);
2048 if (drtmp.error()) {
2049 Alert::warning(_("Branch already exists"), drtmp.message());
2052 docstring const sep = buffer_.params().branchlist().separator();
2053 for (docstring const & branch : getVectorFromString(branch_name, sep))
2054 lyx::dispatch(FuncRequest(LFUN_BRANCH_INSERT, branch));
2058 case LFUN_KEYMAP_OFF:
2059 getIntl().keyMapOn(false);
2062 case LFUN_KEYMAP_PRIMARY:
2063 getIntl().keyMapPrim();
2066 case LFUN_KEYMAP_SECONDARY:
2067 getIntl().keyMapSec();
2070 case LFUN_KEYMAP_TOGGLE:
2071 getIntl().toggleKeyMap();
2074 case LFUN_DIALOG_SHOW_NEW_INSET: {
2075 string const name = cmd.getArg(0);
2076 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
2077 if (decodeInsetParam(name, data, buffer_))
2078 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
2080 lyxerr << "Inset type '" << name <<
2081 "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" << endl;
2085 case LFUN_CITATION_INSERT: {
2086 if (argument.empty()) {
2087 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
2090 // we can have one optional argument, delimited by '|'
2091 // citation-insert <key>|<text_before>
2092 // this should be enhanced to also support text_after
2093 // and citation style
2094 string arg = argument;
2096 if (contains(argument, "|")) {
2097 arg = token(argument, '|', 0);
2098 opt1 = token(argument, '|', 1);
2101 // if our cursor is directly in front of or behind a citation inset,
2102 // we will instead add the new key to it.
2103 Inset * inset = cur.nextInset();
2104 if (!inset || inset->lyxCode() != CITE_CODE)
2105 inset = cur.prevInset();
2106 if (inset && inset->lyxCode() == CITE_CODE) {
2107 InsetCitation * icite = static_cast<InsetCitation *>(inset);
2108 if (icite->addKey(arg)) {
2109 dr.forceBufferUpdate();
2110 dr.screenUpdate(Update::FitCursor | Update::SinglePar);
2112 LYXERR0("Discarding optional argument to citation-insert.");
2117 InsetCommandParams icp(CITE_CODE);
2118 icp["key"] = from_utf8(arg);
2120 icp["before"] = from_utf8(opt1);
2122 from_ascii(InsetCitation::last_literal ? "true" : "false");
2123 string icstr = InsetCommand::params2string(icp);
2124 FuncRequest fr(LFUN_INSET_INSERT, icstr);
2129 case LFUN_INSET_APPLY: {
2130 string const name = cmd.getArg(0);
2131 Inset * inset = editedInset(name);
2133 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
2137 // put cursor in front of inset.
2138 if (!setCursorFromInset(inset)) {
2139 LASSERT(false, break);
2142 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
2143 inset->dispatch(cur, fr);
2144 dr.screenUpdate(cur.result().screenUpdate());
2145 if (cur.result().needBufferUpdate())
2146 dr.forceBufferUpdate();
2151 // The change of language of buffer belongs to the Buffer class.
2152 // We have to do it here because we need a cursor for Undo.
2153 // When Undo::recordUndoBufferParams() is implemented someday
2154 // LFUN_BUFFER_LANGUAGE should be handled by the Buffer class.
2155 case LFUN_BUFFER_LANGUAGE: {
2156 Language const * oldL = buffer_.params().language;
2157 Language const * newL = languages.getLanguage(argument);
2158 if (!newL || oldL == newL)
2160 if (oldL->rightToLeft() == newL->rightToLeft()) {
2161 cur.recordUndoFullBuffer();
2162 buffer_.changeLanguage(oldL, newL);
2163 cur.setCurrentFont();
2164 dr.forceBufferUpdate();
2169 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
2170 case LFUN_FILE_INSERT_PLAINTEXT: {
2171 bool const as_paragraph = (act == LFUN_FILE_INSERT_PLAINTEXT_PARA);
2172 string const fname = to_utf8(cmd.argument());
2173 if (!FileName::isAbsolute(fname))
2174 dr.setMessage(_("Absolute filename expected."));
2176 insertPlaintextFile(FileName(fname), as_paragraph);
2181 // OK, so try the Buffer itself...
2182 buffer_.dispatch(cmd, dr);
2183 dispatched = dr.dispatched();
2187 buffer_.undo().endUndoGroup();
2188 dr.dispatched(dispatched);
2190 // NOTE: The code below is copied from Cursor::dispatch. If you
2191 // need to modify this, please update the other one too.
2193 // notify insets we just entered/left
2194 if (cursor() != old) {
2195 old.beginUndoGroup();
2197 bool badcursor = notifyCursorLeavesOrEnters(old, cursor());
2199 cursor().fixIfBroken();
2200 resetInlineCompletionPos();
2207 docstring BufferView::requestSelection()
2209 Cursor & cur = d->cursor_;
2211 LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
2212 if (!cur.selection()) {
2213 d->xsel_cache_.set = false;
2217 LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
2218 if (!d->xsel_cache_.set ||
2219 cur.top() != d->xsel_cache_.cursor ||
2220 cur.realAnchor().top() != d->xsel_cache_.anchor)
2222 d->xsel_cache_.cursor = cur.top();
2223 d->xsel_cache_.anchor = cur.realAnchor().top();
2224 d->xsel_cache_.set = cur.selection();
2225 return cur.selectionAsString(false);
2231 void BufferView::clearSelection()
2233 d->cursor_.clearSelection();
2234 // Clear the selection buffer. Otherwise a subsequent
2235 // middle-mouse-button paste would use the selection buffer,
2236 // not the more current external selection.
2237 cap::clearSelection();
2238 d->xsel_cache_.set = false;
2239 // The buffer did not really change, but this causes the
2240 // redraw we need because we cleared the selection above.
2241 buffer_.changed(false);
2245 void BufferView::resize(int width, int height)
2247 // Update from work area
2251 // Clear the paragraph height cache.
2252 d->par_height_.clear();
2253 // Redo the metrics.
2258 Inset const * BufferView::getCoveringInset(Text const & text,
2261 TextMetrics & tm = d->text_metrics_[&text];
2262 Inset * inset = tm.checkInsetHit(x, y);
2266 if (!inset->descendable(*this))
2267 // No need to go further down if the inset is not
2271 size_t cell_number = inset->nargs();
2272 // Check all the inner cell.
2273 for (size_t i = 0; i != cell_number; ++i) {
2274 Text const * inner_text = inset->getText(i);
2277 Inset const * inset_deeper =
2278 getCoveringInset(*inner_text, x, y);
2280 return inset_deeper;
2288 void BufferView::updateHoveredInset() const
2290 // Get inset under mouse, if there is one.
2291 int const x = d->mouse_position_cache_.x_;
2292 int const y = d->mouse_position_cache_.y_;
2293 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
2295 d->clickable_inset_ = covering_inset && covering_inset->clickable(*this, x, y);
2297 if (covering_inset == d->last_inset_)
2298 // Same inset, no need to do anything...
2301 bool need_redraw = false;
2302 if (d->last_inset_) {
2303 // Remove the hint on the last hovered inset (if any).
2304 need_redraw |= d->last_inset_->setMouseHover(this, false);
2305 d->last_inset_ = nullptr;
2308 if (covering_inset && covering_inset->setMouseHover(this, true)) {
2310 // Only the insets that accept the hover state, do
2311 // clear the last_inset_, so only set the last_inset_
2312 // member if the hovered setting is accepted.
2313 d->last_inset_ = covering_inset;
2317 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
2318 << d->mouse_position_cache_.x_ << ", "
2319 << d->mouse_position_cache_.y_ << ")");
2321 d->update_strategy_ = DecorationUpdate;
2323 // This event (moving without mouse click) is not passed further.
2324 // This should be changed if it is further utilized.
2325 buffer_.changed(false);
2330 void BufferView::clearLastInset(Inset * inset) const
2332 if (d->last_inset_ != inset) {
2333 LYXERR0("Wrong last_inset!");
2336 d->last_inset_ = nullptr;
2340 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
2342 //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
2344 // This is only called for mouse related events including
2345 // LFUN_FILE_OPEN generated by drag-and-drop.
2346 FuncRequest cmd = cmd0;
2348 Cursor old = cursor();
2350 cur.push(buffer_.inset());
2351 cur.selection(d->cursor_.selection());
2353 // Either the inset under the cursor or the
2354 // surrounding Text will handle this event.
2356 // make sure we stay within the screen...
2357 cmd.set_y(min(max(cmd.y(), -1), height_));
2359 d->mouse_position_cache_.x_ = cmd.x();
2360 d->mouse_position_cache_.y_ = cmd.y();
2362 if (cmd.action() == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
2363 updateHoveredInset();
2367 // Build temporary cursor.
2368 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x(), cmd.y());
2370 // If inset is not editable, cur.pos() might point behind the
2371 // inset (depending on cmd.x(), cmd.y()). This is needed for
2372 // editing to fix bug 9628, but e.g. the context menu needs a
2373 // cursor in front of the inset.
2374 if ((inset->hasSettings() || !inset->contextMenuName().empty()
2375 || inset->lyxCode() == SEPARATOR_CODE) &&
2376 cur.nextInset() != inset && cur.prevInset() == inset)
2378 } else if (cur.inTexted() && cur.pos()
2379 && cur.paragraph().isEnvSeparator(cur.pos() - 1)) {
2380 // Always place cursor in front of a separator inset.
2384 // Put anchor at the same position.
2387 cur.beginUndoGroup();
2389 // Try to dispatch to an non-editable inset near this position
2390 // via the temp cursor. If the inset wishes to change the real
2391 // cursor it has to do so explicitly by using
2392 // cur.bv().cursor() = cur; (or similar)
2394 inset->dispatch(cur, cmd);
2396 // Now dispatch to the temporary cursor. If the real cursor should
2397 // be modified, the inset's dispatch has to do so explicitly.
2398 if (!inset || !cur.result().dispatched())
2401 // Notify left insets
2403 bool badcursor = old.fixIfBroken() | cur.fixIfBroken();
2404 badcursor |= notifyCursorLeavesOrEnters(old, cur);
2406 cursor().fixIfBroken();
2411 // Do we have a selection?
2412 theSelection().haveSelection(cursor().selection());
2414 if (cur.needBufferUpdate()) {
2415 cur.clearBufferUpdate();
2416 buffer().updateBuffer();
2419 // If the command has been dispatched,
2420 if (cur.result().dispatched() || cur.result().screenUpdate())
2421 processUpdateFlags(cur.result().screenUpdate());
2425 int BufferView::minVisiblePart()
2427 return 2 * defaultRowHeight();
2431 int BufferView::scroll(int pixels)
2434 return scrollDown(pixels);
2436 return scrollUp(-pixels);
2441 int BufferView::scrollDown(int pixels)
2443 Text * text = &buffer_.text();
2444 TextMetrics & tm = d->text_metrics_[text];
2445 int const ymax = height_ + pixels;
2447 pair<pit_type, ParagraphMetrics const *> last = tm.last();
2448 int bottom_pos = last.second->position() + last.second->descent();
2449 if (lyxrc.scroll_below_document)
2450 bottom_pos += height_ - minVisiblePart();
2451 if (last.first + 1 == int(text->paragraphs().size())) {
2452 if (bottom_pos <= height_)
2454 pixels = min(pixels, bottom_pos - height_);
2457 if (bottom_pos > ymax)
2459 tm.newParMetricsDown();
2461 d->anchor_ypos_ -= pixels;
2466 int BufferView::scrollUp(int pixels)
2468 Text * text = &buffer_.text();
2469 TextMetrics & tm = d->text_metrics_[text];
2470 int ymin = - pixels;
2472 pair<pit_type, ParagraphMetrics const *> first = tm.first();
2473 int top_pos = first.second->position() - first.second->ascent();
2474 if (first.first == 0) {
2477 pixels = min(pixels, - top_pos);
2482 tm.newParMetricsUp();
2484 d->anchor_ypos_ += pixels;
2489 bool BufferView::setCursorFromRow(int row)
2491 TexRow::TextEntry start, end;
2492 tie(start,end) = buffer_.texrow().getEntriesFromRow(row);
2493 LYXERR(Debug::LATEX,
2494 "setCursorFromRow: for row " << row << ", TexRow has found "
2495 "start (id=" << start.id << ",pos=" << start.pos << "), "
2496 "end (id=" << end.id << ",pos=" << end.pos << ")");
2497 return setCursorFromEntries(start, end);
2501 bool BufferView::setCursorFromEntries(TexRow::TextEntry start,
2502 TexRow::TextEntry end)
2504 DocIterator dit_start, dit_end;
2505 tie(dit_start,dit_end) =
2506 TexRow::getDocIteratorsFromEntries(start, end, buffer_);
2509 // Setting selection start
2510 d->cursor_.clearSelection();
2511 setCursor(dit_start);
2512 // Setting selection end
2514 d->cursor_.resetAnchor();
2515 setCursorSelectionTo(dit_end);
2521 bool BufferView::setCursorFromInset(Inset const * inset)
2523 // are we already there?
2524 if (cursor().nextInset() == inset)
2527 // Inset is not at cursor position. Find it in the document.
2530 while (cur && cur.nextInset() != inset)
2541 void BufferView::gotoLabel(docstring const & label)
2544 bool have_inactive = false;
2545 for (Buffer const * buf : buffer().allRelatives()) {
2547 for (TocItem const & item : *buf->tocBackend().toc("label")) {
2548 if (label == item.str() && item.isOutput()) {
2549 lyx::dispatch(item.action());
2552 // If we find an inactive label, save it for the case
2553 // that no active one is there
2554 if (label == item.str() && !have_inactive) {
2555 have_inactive = true;
2556 action = item.action();
2560 // We only found an inactive label. Go there.
2562 lyx::dispatch(action);
2566 TextMetrics const & BufferView::textMetrics(Text const * t) const
2568 return const_cast<BufferView *>(this)->textMetrics(t);
2572 TextMetrics & BufferView::textMetrics(Text const * t)
2575 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
2576 if (tmc_it == d->text_metrics_.end()) {
2577 tmc_it = d->text_metrics_.emplace(std::piecewise_construct,
2578 std::forward_as_tuple(t),
2579 std::forward_as_tuple(this, const_cast<Text *>(t))).first;
2581 return tmc_it->second;
2585 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
2588 return textMetrics(t).parMetrics(pit);
2592 int BufferView::workHeight() const
2598 void BufferView::setCursor(DocIterator const & dit)
2601 size_t const n = dit.depth();
2602 for (size_t i = 0; i < n; ++i)
2603 dit[i].inset().edit(d->cursor_, true);
2605 d->cursor_.setCursor(dit);
2606 d->cursor_.selection(false);
2607 d->cursor_.setCurrentFont();
2609 // It seems on general grounds as if this is probably needed, but
2610 // it is not yet clear.
2611 // See bug #7394 and r38388.
2612 // d->cursor.resetAnchor();
2616 void BufferView::setCursorSelectionTo(DocIterator const & dit)
2618 size_t const n = dit.depth();
2619 for (size_t i = 0; i < n; ++i)
2620 dit[i].inset().edit(d->cursor_, true);
2622 d->cursor_.selection(true);
2623 d->cursor_.setCursorSelectionTo(dit);
2624 d->cursor_.setCurrentFont();
2628 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
2630 // Would be wrong to delete anything if we have a selection.
2631 if (cur.selection())
2634 bool need_anchor_change = false;
2635 bool changed = Text::deleteEmptyParagraphMechanism(cur, old,
2636 need_anchor_change);
2638 if (need_anchor_change)
2646 // we would rather not do this here, but it needs to be done before
2647 // the changed() signal is sent.
2648 buffer_.updateBuffer();
2650 buffer_.changed(true);
2655 bool BufferView::mouseSetCursor(Cursor & cur, bool const select)
2657 LASSERT(&cur.bv() == this, return false);
2660 // this event will clear selection so we save selection for
2661 // persistent selection
2662 cap::saveSelection(cursor());
2664 d->cursor_.macroModeClose();
2665 // If a macro has been finalized, the cursor might have been broken
2668 // Has the cursor just left the inset?
2669 bool const leftinset = (&d->cursor_.inset() != &cur.inset());
2671 d->cursor_.fixIfBroken();
2673 // do the dEPM magic if needed
2674 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
2675 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
2676 // the leftinset bool would not be necessary (badcursor instead).
2677 bool update = leftinset;
2680 d->cursor_.setSelection();
2681 d->cursor_.setCursorSelectionTo(cur);
2683 if (d->cursor_.inTexted())
2684 update |= checkDepm(cur, d->cursor_);
2685 d->cursor_.resetAnchor();
2686 d->cursor_.setCursor(cur);
2687 d->cursor_.clearSelection();
2689 d->cursor_.boundary(cur.boundary());
2690 d->cursor_.finishUndo();
2691 d->cursor_.setCurrentFont();
2693 cur.forceBufferUpdate();
2698 void BufferView::putSelectionAt(DocIterator const & cur,
2699 int length, bool backwards)
2701 d->cursor_.clearSelection();
2707 d->cursor_.pos() += length;
2708 d->cursor_.setSelection(d->cursor_, -length);
2710 d->cursor_.setSelection(d->cursor_, length);
2715 bool BufferView::selectIfEmpty(DocIterator & cur)
2717 if ((cur.inTexted() && !cur.paragraph().empty())
2718 || (cur.inMathed() && !cur.cell().empty()))
2721 pit_type const beg_pit = cur.pit();
2723 // The paragraph associated to this item isn't
2724 // the first one, so it can be selected
2727 // We have to resort to select the space between the
2728 // end of this item and the begin of the next one
2732 // If it is the only item in the document,
2733 // nothing can be selected
2736 pit_type const end_pit = cur.pit();
2737 pos_type const end_pos = cur.pos();
2738 d->cursor_.clearSelection();
2740 d->cursor_.setCursor(cur);
2741 d->cursor_.pit() = beg_pit;
2742 d->cursor_.pos() = 0;
2743 d->cursor_.selection(false);
2744 d->cursor_.resetAnchor();
2745 d->cursor_.pit() = end_pit;
2746 d->cursor_.pos() = end_pos;
2747 d->cursor_.setSelection();
2752 Cursor & BufferView::cursor()
2758 Cursor const & BufferView::cursor() const
2764 bool BufferView::singleParUpdate()
2766 Text & buftext = buffer_.text();
2767 pit_type const bottom_pit = d->cursor_.bottom().pit();
2768 TextMetrics & tm = textMetrics(&buftext);
2769 Dimension const old_dim = tm.parMetrics(bottom_pit).dim();
2771 // make sure inline completion pointer is ok
2772 if (d->inlineCompletionPos_.fixIfBroken())
2773 d->inlineCompletionPos_ = DocIterator();
2775 // In Single Paragraph mode, rebreak only
2776 // the (main text, not inset!) paragraph containing the cursor.
2777 // (if this paragraph contains insets etc., rebreaking will
2778 // recursively descend)
2779 tm.redoParagraph(bottom_pit);
2780 ParagraphMetrics & pm = tm.parMetrics(bottom_pit);
2781 if (pm.height() != old_dim.height()) {
2782 // Paragraph height has changed so we cannot proceed to
2783 // the singlePar optimisation.
2786 // Since position() points to the baseline of the first row, we
2787 // may have to update it. See ticket #11601 for an example where
2788 // the height does not change but the ascent does.
2789 pm.setPosition(pm.position() - old_dim.ascent() + pm.ascent());
2791 tm.updatePosCache(bottom_pit);
2793 LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
2794 << " y2: " << pm.position() + pm.descent()
2795 << " pit: " << bottom_pit
2796 << " singlepar: 1");
2801 void BufferView::updateMetrics()
2803 updateMetrics(d->update_flags_);
2804 d->update_strategy_ = FullScreenUpdate;
2808 void BufferView::updateMetrics(Update::flags & update_flags)
2810 if (height_ == 0 || width_ == 0)
2813 Text & buftext = buffer_.text();
2814 pit_type const npit = int(buftext.paragraphs().size());
2816 // Clear out the position cache in case of full screen redraw,
2817 d->coord_cache_.clear();
2818 d->math_rows_.clear();
2820 // Clear out paragraph metrics to avoid having invalid metrics
2821 // in the cache from paragraphs not relayouted below
2822 // The complete text metrics will be redone.
2823 d->text_metrics_.clear();
2825 TextMetrics & tm = textMetrics(&buftext);
2827 // make sure inline completion pointer is ok
2828 if (d->inlineCompletionPos_.fixIfBroken())
2829 d->inlineCompletionPos_ = DocIterator();
2831 if (d->anchor_pit_ >= npit)
2832 // The anchor pit must have been deleted...
2833 d->anchor_pit_ = npit - 1;
2835 // Rebreak anchor paragraph.
2836 tm.redoParagraph(d->anchor_pit_);
2837 ParagraphMetrics & anchor_pm = tm.parMetrics(d->anchor_pit_);
2840 if (d->anchor_pit_ == 0) {
2841 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
2843 // Complete buffer visible? Then it's easy.
2844 if (scrollRange == 0)
2845 d->anchor_ypos_ = anchor_pm.ascent();
2847 // avoid empty space above the first row
2848 d->anchor_ypos_ = min(d->anchor_ypos_, anchor_pm.ascent());
2851 anchor_pm.setPosition(d->anchor_ypos_);
2852 tm.updatePosCache(d->anchor_pit_);
2854 LYXERR(Debug::PAINTING, "metrics: "
2855 << " anchor pit = " << d->anchor_pit_
2856 << " anchor ypos = " << d->anchor_ypos_);
2858 // Redo paragraphs above anchor if necessary.
2859 int y1 = d->anchor_ypos_ - anchor_pm.ascent();
2860 // We are now just above the anchor paragraph.
2861 pit_type pit1 = d->anchor_pit_ - 1;
2862 for (; pit1 >= 0 && y1 >= 0; --pit1) {
2863 tm.redoParagraph(pit1);
2864 ParagraphMetrics & pm = tm.parMetrics(pit1);
2866 // Save the paragraph position in the cache.
2868 tm.updatePosCache(pit1);
2872 // Redo paragraphs below the anchor if necessary.
2873 int y2 = d->anchor_ypos_ + anchor_pm.descent();
2874 // We are now just below the anchor paragraph.
2875 pit_type pit2 = d->anchor_pit_ + 1;
2876 for (; pit2 < npit && y2 <= height_; ++pit2) {
2877 tm.redoParagraph(pit2);
2878 ParagraphMetrics & pm = tm.parMetrics(pit2);
2880 // Save the paragraph position in the cache.
2882 tm.updatePosCache(pit2);
2886 LYXERR(Debug::PAINTING, "Metrics: "
2887 << " anchor pit = " << d->anchor_pit_
2888 << " anchor ypos = " << d->anchor_ypos_
2891 << " pit1 = " << pit1
2892 << " pit2 = " << pit2);
2894 // metrics is done, full drawing is necessary now
2895 update_flags = (update_flags & ~Update::Force) | Update::ForceDraw;
2897 // Now update the positions of insets in the cache.
2900 if (lyxerr.debugging(Debug::WORKAREA)) {
2901 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
2902 d->coord_cache_.dump();
2907 void BufferView::updatePosCache()
2909 // this is the "nodraw" drawing stage: only set the positions of the
2910 // insets in metrics cache.
2911 frontend::NullPainter np;
2916 void BufferView::insertLyXFile(FileName const & fname, bool const ignorelang)
2918 LASSERT(d->cursor_.inTexted(), return);
2920 // Get absolute path of file and add ".lyx"
2921 // to the filename if necessary
2922 FileName filename = fileSearch(string(), fname.absFileName(), "lyx");
2924 docstring const disp_fn = makeDisplayPath(filename.absFileName());
2925 // emit message signal.
2926 message(bformat(_("Inserting document %1$s..."), disp_fn));
2929 Buffer buf(filename.absFileName(), false);
2930 if (buf.loadLyXFile() == Buffer::ReadSuccess) {
2931 ErrorList & el = buffer_.errorList("Parse");
2932 // Copy the inserted document error list into the current buffer one.
2933 el = buf.errorList("Parse");
2934 ParagraphList & pars = buf.paragraphs();
2936 // set main language of imported file to context language
2937 buf.changeLanguage(buf.language(), d->cursor_.getFont().language());
2938 buffer_.undo().recordUndo(d->cursor_);
2939 cap::pasteParagraphList(d->cursor_, pars,
2940 buf.params().documentClassPtr(), el);
2941 res = _("Document %1$s inserted.");
2943 res = _("Could not insert document %1$s");
2946 buffer_.changed(true);
2947 // emit message signal.
2948 message(bformat(res, disp_fn));
2952 Point BufferView::coordOffset(DocIterator const & dit) const
2958 // Addup contribution of nested insets, from inside to outside,
2959 // keeping the outer paragraph for a special handling below
2960 for (size_t i = dit.depth() - 1; i >= 1; --i) {
2961 CursorSlice const & sl = dit[i];
2965 // get relative position inside sl.inset()
2966 sl.inset().cursorPos(*this, sl, dit.boundary() && (i + 1 == dit.depth()), xx, yy);
2968 // Make relative position inside of the edited inset relative to sl.inset()
2972 // In case of an RTL inset, the edited inset will be positioned to the left
2975 bool boundary_i = dit.boundary() && i + 1 == dit.depth();
2976 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2981 // remember width for the case that sl.inset() is positioned in an RTL inset
2982 lastw = sl.inset().dimension(*this).wid;
2984 //lyxerr << "Cursor::getPos, i: "
2985 // << i << " x: " << xx << " y: " << y << endl;
2988 // Add contribution of initial rows of outermost paragraph
2989 CursorSlice const & sl = dit[0];
2990 TextMetrics const & tm = textMetrics(sl.text());
2991 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2993 LBUFERR(!pm.rows().empty());
2994 y -= pm.rows()[0].ascent();
2996 // FIXME: document this mess
2998 if (sl.pos() > 0 && dit.depth() == 1) {
3000 if (pos && dit.boundary())
3002 // lyxerr << "coordOffset: boundary:" << dit.boundary() << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
3003 rend = pm.pos2row(pos);
3005 rend = pm.pos2row(sl.pos());
3007 size_t rend = pm.pos2row(sl.pos());
3009 for (size_t rit = 0; rit != rend; ++rit)
3010 y += pm.rows()[rit].height();
3011 y += pm.rows()[rend].ascent();
3013 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
3015 // Make relative position from the nested inset now bufferview absolute.
3016 int xx = bottom_tm.cursorX(dit.bottom(), dit.boundary() && dit.depth() == 1);
3019 // In the RTL case place the nested inset at the left of the cursor in
3020 // the outer paragraph
3021 bool boundary_1 = dit.boundary() && 1 == dit.depth();
3022 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
3030 Point BufferView::getPos(DocIterator const & dit) const
3032 if (!paragraphVisible(dit))
3033 return Point(-1, -1);
3035 CursorSlice const & bot = dit.bottom();
3036 TextMetrics const & tm = textMetrics(bot.text());
3038 // offset from outer paragraph
3039 Point p = coordOffset(dit);
3040 p.y_ += tm.parMetrics(bot.pit()).position();
3045 bool BufferView::paragraphVisible(DocIterator const & dit) const
3047 CursorSlice const & bot = dit.bottom();
3048 TextMetrics const & tm = textMetrics(bot.text());
3050 return tm.contains(bot.pit());
3054 void BufferView::caretPosAndDim(Point & p, Dimension & dim) const
3056 Cursor const & cur = cursor();
3057 if (cur.inMathed()) {
3058 MathRow const & mrow = mathRow(&cur.cell());
3059 dim = mrow.caret_dim;
3061 Font const font = cur.real_current_font;
3062 frontend::FontMetrics const & fm = theFontMetrics(font);
3063 dim.wid = fm.lineWidth();
3064 dim.asc = fm.maxAscent();
3065 dim.des = fm.maxDescent();
3067 if (lyxrc.cursor_width > 0)
3068 dim.wid = lyxrc.cursor_width;
3071 // center fat carets horizontally
3072 p.x_ -= dim.wid / 2;
3078 void BufferView::buildCaretGeometry(bool complet)
3082 caretPosAndDim(p, dim);
3084 Cursor const & cur = d->cursor_;
3085 Font const & realfont = cur.real_current_font;
3086 frontend::FontMetrics const & fm = theFontMetrics(realfont.fontInfo());
3087 bool const isrtl = realfont.isVisibleRightToLeft();
3088 int const dir = isrtl ? -1 : 1;
3090 frontend::CaretGeometry & cg = d->caret_geometry_;
3093 // The caret itself, slanted for italics in text edit mode except
3094 // for selections because the selection rect does not slant
3095 bool const slant = fm.italic() && cur.inTexted() && !cur.selection();
3096 double const slope = slant ? fm.italicSlope() : 0;
3097 cg.shapes.push_back(
3098 {{iround(p.x_ + dim.asc * slope), p.y_},
3099 {iround(p.x_ - dim.des * slope), p.y_ + dim.height()},
3100 {iround(p.x_ + dir * dim.wid - dim.des * slope), p.y_ + dim.height()},
3101 {iround(p.x_ + dir * dim.wid + dim.asc * slope), p.y_}}
3104 // The language indicator _| (if needed)
3105 Language const * doclang = buffer().params().language;
3106 if (!((realfont.language() == doclang && isrtl == doclang->rightToLeft())
3107 || realfont.language() == latex_language)) {
3108 int const lx = dim.height() / 3;
3109 int const xx = iround(p.x_ - dim.des * slope);
3110 int const yy = p.y_ + dim.height();
3111 cg.shapes.push_back(
3112 {{xx, yy - dim.wid},
3113 {xx + dir * (dim.wid + lx - 1), yy - dim.wid},
3114 {xx + dir * (dim.wid + lx - 1), yy},
3119 // The completion triangle |> (if needed)
3121 int const m = p.y_ + dim.height() / 2;
3122 int const d = dim.height() / 8;
3123 // offset for slanted carret
3124 int const sx = iround((dim.asc - (dim.height() / 2 - d)) * slope);
3125 // starting position x
3126 int const xx = p.x_ + dir * dim.wid + sx;
3127 cg.shapes.push_back(
3131 {xx, m + d - dim.wid},
3132 {xx + dir * d - dim.wid, m},
3133 {xx, m - d + dim.wid}}
3137 // compute extremal x values
3139 cg.right = -1000000;
3141 cg.bottom = -1000000;
3142 for (auto const & shape : cg.shapes)
3143 for (Point const & p : shape) {
3144 cg.left = min(cg.left, p.x_);
3145 cg.right = max(cg.right, p.x_);
3146 cg.top = min(cg.top, p.y_);
3147 cg.bottom = max(cg.bottom, p.y_);
3152 frontend::CaretGeometry const & BufferView::caretGeometry() const
3154 return d->caret_geometry_;
3158 bool BufferView::caretInView() const
3160 if (!paragraphVisible(cursor()))
3164 caretPosAndDim(p, dim);
3166 // does the cursor touch the screen ?
3167 if (p.y_ + dim.height() < 0 || p.y_ >= workHeight())
3173 int BufferView::horizScrollOffset() const
3175 return d->horiz_scroll_offset_;
3179 int BufferView::horizScrollOffset(Text const * text,
3180 pit_type pit, pos_type pos) const
3182 // Is this a row that is currently scrolled?
3183 if (!d->current_row_slice_.empty()
3184 && &text->inset() == d->current_row_slice_.inset().asInsetText()
3185 && pit == d->current_row_slice_.pit()
3186 && pos == d->current_row_slice_.pos())
3187 return d->horiz_scroll_offset_;
3192 void BufferView::setCurrentRowSlice(CursorSlice const & rowSlice)
3194 // nothing to do if the cursor was already on this row
3195 if (d->current_row_slice_ == rowSlice)
3198 // if the (previous) current row was scrolled, we have to
3199 // remember it in order to repaint it next time.
3200 if (d->horiz_scroll_offset_ != 0) {
3201 // search the old row in cache and mark it changed
3202 for (auto & tm_pair : d->text_metrics_) {
3203 if (&tm_pair.first->inset() == rowSlice.inset().asInsetText()) {
3204 tm_pair.second.setRowChanged(rowSlice.pit(), rowSlice.pos());
3205 // We found it, no need to continue.
3211 // Since we changed row, the scroll offset is not valid anymore
3212 d->horiz_scroll_offset_ = 0;
3213 d->current_row_slice_ = rowSlice;
3217 void BufferView::checkCursorScrollOffset()
3219 CursorSlice rowSlice = d->cursor_.bottom();
3220 TextMetrics const & tm = textMetrics(rowSlice.text());
3222 // Stop if metrics have not been computed yet, since it means
3223 // that there is nothing to do.
3224 if (!tm.contains(rowSlice.pit()))
3226 ParagraphMetrics const & pm = tm.parMetrics(rowSlice.pit());
3227 Row const & row = pm.getRow(rowSlice.pos(),
3228 d->cursor_.boundary() && rowSlice == d->cursor_.top());
3229 rowSlice.pos() = row.pos();
3231 // Set the row on which the cursor lives.
3232 setCurrentRowSlice(rowSlice);
3234 // Current x position of the cursor in pixels
3235 int cur_x = getPos(d->cursor_).x_;
3237 // Horizontal scroll offset of the cursor row in pixels
3238 int offset = d->horiz_scroll_offset_;
3239 int const MARGIN = 2 * theFontMetrics(d->cursor_.real_current_font).em()
3241 if (row.right_x() <= workWidth() - row.right_margin) {
3242 // Row is narrower than the work area, no offset needed.
3245 if (cur_x - offset < MARGIN) {
3246 // cursor would be too far right
3247 offset = cur_x - MARGIN;
3248 } else if (cur_x - offset > workWidth() - MARGIN) {
3249 // cursor would be too far left
3250 offset = cur_x - workWidth() + MARGIN;
3252 // Correct the offset to make sure that we do not scroll too much
3255 if (row.right_x() - offset < workWidth() - row.right_margin)
3256 offset = row.right_x() - workWidth() + row.right_margin;
3259 //lyxerr << "cur_x=" << cur_x << ", offset=" << offset << ", row.wid=" << row.width() << ", margin=" << MARGIN << endl;
3261 if (offset != d->horiz_scroll_offset_)
3262 LYXERR(Debug::PAINTING, "Horiz. scroll offset changed from "
3263 << d->horiz_scroll_offset_ << " to " << offset);
3265 if (d->update_strategy_ == NoScreenUpdate
3266 && offset != d->horiz_scroll_offset_) {
3267 // FIXME: if one uses SingleParUpdate, then home/end
3268 // will not work on long rows. Why?
3269 d->update_strategy_ = FullScreenUpdate;
3272 d->horiz_scroll_offset_ = offset;
3276 void BufferView::draw(frontend::Painter & pain, bool paint_caret)
3278 if (height_ == 0 || width_ == 0)
3280 LYXERR(Debug::PAINTING, (pain.isNull() ? "\t\t--- START NODRAW ---"
3281 : "\t\t*** START DRAWING ***"));
3282 Text & text = buffer_.text();
3283 TextMetrics const & tm = d->text_metrics_[&text];
3284 int const y = tm.first().second->position();
3285 PainterInfo pi(this, pain);
3287 // Check whether the row where the cursor lives needs to be scrolled.
3288 // Update the drawing strategy if needed.
3289 checkCursorScrollOffset();
3291 switch (d->update_strategy_) {
3293 case NoScreenUpdate:
3294 // no screen painting is actually needed. In nodraw stage
3295 // however, the different coordinates of insets and paragraphs
3296 // needs to be updated.
3297 LYXERR(Debug::PAINTING, "Strategy: NoScreenUpdate");
3298 if (pain.isNull()) {
3299 pi.full_repaint = true;
3302 pi.full_repaint = false;
3307 case SingleParUpdate:
3308 pi.full_repaint = false;
3309 LYXERR(Debug::PAINTING, "Strategy: SingleParUpdate");
3310 // In general, only the current row of the outermost paragraph
3311 // will be redrawn. Particular cases where selection spans
3312 // multiple paragraph are correctly detected in TextMetrics.
3316 case DecorationUpdate:
3317 // FIXME: We should also distinguish DecorationUpdate to avoid text
3318 // drawing if possible. This is not possible to do easily right now
3319 // because of the single backing pixmap.
3321 case FullScreenUpdate:
3323 LYXERR(Debug::PAINTING,
3324 ((d->update_strategy_ == FullScreenUpdate)
3325 ? "Strategy: FullScreenUpdate"
3326 : "Strategy: DecorationUpdate"));
3328 // The whole screen, including insets, will be refreshed.
3329 pi.full_repaint = true;
3331 // Clear background.
3332 pain.fillRectangle(0, 0, width_, height_,
3333 pi.backgroundColor(&buffer_.inset()));
3338 // and possibly grey out below
3339 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3340 int const y2 = lastpm.second->position() + lastpm.second->descent();
3343 Color color = buffer().isInternal()
3344 ? Color_background : Color_bottomarea;
3345 pain.fillRectangle(0, y2, width_, height_ - y2, color);
3349 LYXERR(Debug::PAINTING, (pain.isNull() ? "\t\t --- END NODRAW ---"
3350 : "\t\t *** END DRAWING ***"));
3352 // The scrollbar needs an update.
3353 // FIXME: does it always? see ticket #11947.
3356 // Normalize anchor for next time
3357 pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
3358 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3359 for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
3360 ParagraphMetrics const & pm = tm.parMetrics(pit);
3361 if (pm.position() + pm.descent() > 0) {
3362 if (d->anchor_pit_ != pit
3363 || d->anchor_ypos_ != pm.position())
3364 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
3365 << " anchor ypos = " << d->anchor_ypos_);
3366 d->anchor_pit_ = pit;
3367 d->anchor_ypos_ = pm.position();
3371 if (!pain.isNull()) {
3372 // reset the update flags, everything has been done
3373 d->update_flags_ = Update::None;
3376 // If a caret has to be painted, mark its text row as dirty to
3377 //make sure that it will be repainted on next redraw.
3378 /* FIXME: investigate whether this can be avoided when the cursor did not
3382 Cursor cur(d->cursor_);
3383 while (cur.depth() > 1) {
3384 if (!cur.inTexted())
3386 TextMetrics const & tm = textMetrics(cur.text());
3387 if (d->caret_geometry_.left >= tm.origin().x_
3388 && d->caret_geometry_.right <= tm.origin().x_ + tm.dim().width())
3392 cur.textRow().changed(true);
3397 void BufferView::message(docstring const & msg)
3400 d->gui_->message(msg);
3404 void BufferView::showDialog(string const & name)
3407 d->gui_->showDialog(name, string());
3411 void BufferView::showDialog(string const & name,
3412 string const & data, Inset * inset)
3415 d->gui_->showDialog(name, data, inset);
3419 void BufferView::updateDialog(string const & name, string const & data)
3422 d->gui_->updateDialog(name, data);
3426 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
3432 // FIXME: Move this out of BufferView again
3433 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
3435 if (!fname.isReadableFile()) {
3436 docstring const error = from_ascii(strerror(errno));
3437 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3438 docstring const text =
3439 bformat(_("Could not read the specified document\n"
3440 "%1$s\ndue to the error: %2$s"), file, error);
3441 Alert::error(_("Could not read file"), text);
3445 if (!fname.isReadableFile()) {
3446 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3447 docstring const text =
3448 bformat(_("%1$s\n is not readable."), file);
3449 Alert::error(_("Could not open file"), text);
3453 // FIXME UNICODE: We don't know the encoding of the file
3454 docstring file_content = fname.fileContents("UTF-8");
3455 if (file_content.empty()) {
3456 Alert::error(_("Reading not UTF-8 encoded file"),
3457 _("The file is not UTF-8 encoded.\n"
3458 "It will be read as local 8Bit-encoded.\n"
3459 "If this does not give the correct result\n"
3460 "then please change the encoding of the file\n"
3461 "to UTF-8 with a program other than LyX.\n"));
3462 file_content = fname.fileContents("local8bit");
3465 return normalize_c(file_content);
3469 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
3471 docstring const tmpstr = contentsOfPlaintextFile(f);
3476 Cursor & cur = cursor();
3477 cap::replaceSelection(cur);
3478 buffer_.undo().recordUndo(cur);
3480 cur.innerText()->insertStringAsParagraphs(cur, tmpstr, cur.current_font);
3482 cur.innerText()->insertStringAsLines(cur, tmpstr, cur.current_font);
3484 buffer_.changed(true);
3488 docstring const & BufferView::inlineCompletion() const
3490 return d->inlineCompletion_;
3494 size_t BufferView::inlineCompletionUniqueChars() const
3496 return d->inlineCompletionUniqueChars_;
3500 DocIterator const & BufferView::inlineCompletionPos() const
3502 return d->inlineCompletionPos_;
3506 void BufferView::resetInlineCompletionPos()
3508 d->inlineCompletionPos_ = DocIterator();
3512 bool samePar(DocIterator const & a, DocIterator const & b)
3514 if (a.empty() && b.empty())
3516 if (a.empty() || b.empty())
3518 if (a.depth() != b.depth())
3520 return &a.innerParagraph() == &b.innerParagraph();
3524 void BufferView::setInlineCompletion(Cursor const & cur, DocIterator const & pos,
3525 docstring const & completion, size_t uniqueChars)
3527 uniqueChars = min(completion.size(), uniqueChars);
3528 bool changed = d->inlineCompletion_ != completion
3529 || d->inlineCompletionUniqueChars_ != uniqueChars;
3530 bool singlePar = true;
3531 d->inlineCompletion_ = completion;
3532 d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
3534 //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
3537 DocIterator const & old = d->inlineCompletionPos_;
3539 //lyxerr << "inlineCompletionPos changed" << std::endl;
3540 // old or pos are in another paragraph?
3541 if ((!samePar(cur, pos) && !pos.empty())
3542 || (!samePar(cur, old) && !old.empty())) {
3544 //lyxerr << "different paragraph" << std::endl;
3546 d->inlineCompletionPos_ = pos;
3551 if (singlePar && !(cur.result().screenUpdate() & Update::Force))
3552 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
3554 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::Force);
3559 bool BufferView::clickableInset() const
3561 return d->clickable_inset_;