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/InsetMath.h"
54 #include "mathed/MathData.h"
55 #include "mathed/MathRow.h"
57 #include "frontends/alert.h"
58 #include "frontends/CaretGeometry.h"
59 #include "frontends/Delegates.h"
60 #include "frontends/FontMetrics.h"
61 #include "frontends/NullPainter.h"
62 #include "frontends/Painter.h"
63 #include "frontends/Selection.h"
65 #include "support/convert.h"
66 #include "support/debug.h"
67 #include "support/docstring.h"
68 #include "support/filetools.h"
69 #include "support/gettext.h"
70 #include "support/lassert.h"
71 #include "support/Length.h"
72 #include "support/lstrings.h"
73 #include "support/lyxlib.h"
74 #include "support/types.h"
86 using namespace lyx::support;
90 namespace Alert = frontend::Alert;
94 /// Return an inset of this class if it exists at the current cursor position
96 T * getInsetByCode(Cursor const & cur, InsetCode code)
99 Inset * inset = it.nextInset();
100 if (inset && inset->lyxCode() == code)
101 return static_cast<T*>(inset);
106 /// Note that comparing contents can only be used for InsetCommand
107 bool findNextInset(DocIterator & dit, vector<InsetCode> const & codes,
108 docstring const & contents)
110 DocIterator tmpdit = dit;
113 Inset const * inset = tmpdit.nextInset();
115 bool const valid_code = std::find(codes.begin(), codes.end(),
116 inset->lyxCode()) != codes.end();
117 InsetCommand const * ic = inset->asInsetCommand();
118 bool const same_or_no_contents = contents.empty()
119 || (ic && (ic->getFirstNonOptParam() == contents));
121 if (valid_code && same_or_no_contents) {
126 tmpdit.forwardInset();
133 /// Looks for next inset with one of the given codes.
134 /// Note that same_content can only be used for InsetCommand
135 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
139 DocIterator tmpdit = dit;
140 tmpdit.forwardInset();
144 Inset const * inset = tmpdit.nextInset();
145 if (same_content && inset) {
146 InsetCommand const * ic = inset->asInsetCommand();
148 bool const valid_code = std::find(codes.begin(), codes.end(),
149 ic->lyxCode()) != codes.end();
151 contents = ic->getFirstNonOptParam();
155 if (!findNextInset(tmpdit, codes, contents)) {
156 if (dit.depth() != 1 || dit.pit() != 0 || dit.pos() != 0) {
157 inset = &tmpdit.bottom().inset();
158 tmpdit = doc_iterator_begin(&inset->buffer(), inset);
159 if (!findNextInset(tmpdit, codes, contents))
171 /// Moves cursor to the next inset with one of the given codes.
172 void gotoInset(BufferView * bv, vector<InsetCode> const & codes,
175 Cursor tmpcur = bv->cursor();
176 if (!findInset(tmpcur, codes, same_content)) {
177 bv->cursor().message(_("No more insets"));
181 tmpcur.clearSelection();
182 bv->setCursor(tmpcur);
187 /// A map from a Text to the associated text metrics
188 typedef map<Text const *, TextMetrics> TextMetricsCache;
190 enum ScreenUpdateStrategy {
200 /////////////////////////////////////////////////////////////////////
204 /////////////////////////////////////////////////////////////////////
206 struct BufferView::Private
208 Private(BufferView & bv) :
209 update_strategy_(FullScreenUpdate),
210 update_flags_(Update::Force),
211 cursor_(bv), anchor_pit_(0), anchor_ypos_(0),
212 wh_(0), inlineCompletionUniqueChars_(0),
213 last_inset_(nullptr), mouse_position_cache_(),
214 gui_(nullptr), bookmark_edit_position_(-1),
215 horiz_scroll_offset_(0), clickable_inset_(false)
217 xsel_cache_.set = false;
221 ScrollbarParameters scrollbarParameters_;
223 ScreenUpdateStrategy update_strategy_;
225 Update::flags update_flags_;
227 CoordCache coord_cache_;
229 typedef map<MathData const *, MathRow> MathRows;
232 /// this is used to handle XSelection events in the right manner.
241 pit_type anchor_pit_;
244 /// Estimated average par height for scrollbar.
247 vector<int> par_height_;
250 DocIterator inlineCompletionPos_;
252 docstring inlineCompletion_;
254 size_t inlineCompletionUniqueChars_;
256 /// keyboard mapping object.
259 /// last visited inset.
260 /** kept to send setMouseHover(false).
261 * Not owned, so don't delete.
263 Inset const * last_inset_;
265 /// position of the mouse at the time of the last mouse move
266 /// This is used to update the hovering status of inset in
267 /// cases where the buffer is scrolled, but the mouse didn't move.
268 Point mouse_position_cache_;
270 mutable TextMetricsCache text_metrics_;
273 /** Not owned, so don't delete.
275 frontend::GuiBufferViewDelegate * gui_;
277 /// Cache for Find Next
278 FuncRequest search_request_cache_;
281 map<string, Inset *> edited_insets_;
283 /// When the row where the cursor lies is scrolled, this
284 /// contains the scroll offset
285 // cache for id of the paragraph which was edited the last time
286 int bookmark_edit_position_;
288 int horiz_scroll_offset_;
289 /// a slice pointing to the start of the row where the cursor
290 /// is (at last draw time)
291 CursorSlice current_row_slice_;
292 /// are we hovering something that we can click
293 bool clickable_inset_;
294 /// shape of the caret
295 frontend::CaretGeometry caret_geometry_;
299 BufferView::BufferView(Buffer & buf)
300 : width_(0), height_(0), full_screen_(false), buffer_(buf),
301 d(new Private(*this))
303 d->xsel_cache_.set = false;
304 d->intl_.initKeyMapper(lyxrc.use_kbmap);
306 d->cursor_.setBuffer(&buf);
307 d->cursor_.push(buffer_.inset());
308 d->cursor_.resetAnchor();
309 d->cursor_.setCurrentFont();
311 buffer_.updatePreviews();
315 BufferView::~BufferView()
317 // current buffer is going to be switched-off, save cursor pos
318 // Ideally, the whole cursor stack should be saved, but session
319 // currently can only handle bottom (whole document) level pit and pos.
320 // That is to say, if a cursor is in a nested inset, it will be
321 // restore to the left of the top level inset.
322 LastFilePosSection::FilePos fp;
323 fp.file = buffer_.fileName();
324 fp.pit = d->cursor_.bottom().pit();
325 fp.pos = d->cursor_.bottom().pos();
326 theSession().lastFilePos().save(fp);
329 d->last_inset_->setMouseHover(this, false);
335 int BufferView::rightMargin() const
337 // The value used to be hardcoded to 10
338 int const default_margin = zoomedPixels(10);
339 // The additional test for the case the outliner is opened.
340 if (!full_screen_ || !lyxrc.full_screen_limit
341 || width_ < lyxrc.full_screen_width + 2 * default_margin)
342 return default_margin;
344 return (width_ - lyxrc.full_screen_width) / 2;
348 int BufferView::leftMargin() const
350 return rightMargin();
354 int BufferView::topMargin() const
356 // Original value was 20px at 100dpi. For internal buffers like in
357 // advanced search and replace, a value of 5px is enough.
358 return zoomedPixels(buffer().isInternal() ? 5 : 20);
362 int BufferView::bottomMargin() const
368 int BufferView::inPixels(Length const & len) const
370 Font const font = buffer().params().getFont();
371 return len.inPixels(workWidth(), theFontMetrics(font).em());
375 int BufferView::zoomedPixels(int pix) const
377 // FIXME: the dpi setting should really depend on the BufferView
378 // (think different monitors).
380 // Zoom factor specified by user in percent
381 double const zoom = lyxrc.currentZoom / 100.0; // [percent]
383 // DPI setting for monitor relative to 100dpi
384 double const dpizoom = lyxrc.dpi / 100.0; // [per 100dpi]
386 return support::iround(pix * zoom * dpizoom);
390 bool BufferView::isTopScreen() const
392 return 0 == d->scrollbarParameters_.min;
396 bool BufferView::isBottomScreen() const
398 return 0 == d->scrollbarParameters_.max;
402 Intl & BufferView::getIntl()
408 Intl const & BufferView::getIntl() const
414 CoordCache & BufferView::coordCache()
416 return d->coord_cache_;
420 CoordCache const & BufferView::coordCache() const
422 return d->coord_cache_;
426 MathRow const & BufferView::mathRow(MathData const * cell) const
428 auto it = d->math_rows_.find(cell);
429 LATTEST(it != d->math_rows_.end());
434 void BufferView::setMathRow(MathData const * cell, MathRow const & mrow)
436 d->math_rows_[cell] = mrow;
440 Buffer & BufferView::buffer()
446 Buffer const & BufferView::buffer() const
452 bool BufferView::needsFitCursor() const
454 if (cursorStatus(d->cursor_) == CUR_INSIDE) {
455 frontend::FontMetrics const & fm =
456 theFontMetrics(d->cursor_.getFont().fontInfo());
457 int const asc = fm.maxAscent();
458 int const des = fm.maxDescent();
459 Point const p = getPos(d->cursor_);
460 if (p.y_ - asc >= 0 && p.y_ + des < height_)
469 // this is for debugging only.
470 string flagsAsString(Update::flags flags)
472 if (flags == Update::None)
474 return string((flags & Update::FitCursor) ? "FitCursor " : "")
475 + ((flags & Update::Force) ? "Force " : "")
476 + ((flags & Update::ForceDraw) ? "ForceDraw " : "")
477 + ((flags & Update::SinglePar) ? "SinglePar " : "")
478 + ((flags & Update::Decoration) ? "Decoration " : "");
483 void BufferView::processUpdateFlags(Update::flags flags)
485 LYXERR(Debug::PAINTING, "BufferView::processUpdateFlags( "
486 << flagsAsString(flags) << ") buffer: " << &buffer_);
488 // Case when no explicit update is requested.
489 if (flags == Update::None)
492 /* FIXME We would like to avoid doing this here, since it is very
493 * expensive and is called in updateBuffer already. However, even
494 * inserting a plain character can invalidate the overly fragile
495 * tables of child documents built by updateMacros. Some work is
496 * needed to avoid doing that when not necessary.
498 buffer_.updateMacros();
500 // First check whether the metrics and inset positions should be updated
501 if (flags & Update::Force) {
502 // This will update the CoordCache items and replace Force
503 // with ForceDraw in flags.
504 updateMetrics(flags);
507 // Detect whether we can only repaint a single paragraph (if we
508 // are not already redrawing all).
509 // We handle this before FitCursor because the later will require
510 // correct metrics at cursor position.
511 if (!(flags & Update::ForceDraw)
512 && (flags & Update::SinglePar)
513 && !singleParUpdate())
514 updateMetrics(flags);
516 // Then make sure that the screen contains the cursor if needed
517 if (flags & Update::FitCursor) {
518 if (needsFitCursor()) {
519 // First try to make the selection start visible
520 // (which is just the cursor when there is no selection)
521 scrollToCursor(d->cursor_.selectionBegin(), false);
522 // Metrics have to be recomputed (maybe again)
524 // Is the cursor visible? (only useful if cursor is at end of selection)
525 if (needsFitCursor()) {
526 // then try to make cursor visible instead
527 scrollToCursor(d->cursor_, false);
528 // Metrics have to be recomputed (maybe again)
529 updateMetrics(flags);
532 flags = flags & ~Update::FitCursor;
535 // Add flags to the the update flags. These will be reset to None
536 // after the redraw is actually done
537 d->update_flags_ = d->update_flags_ | flags;
538 LYXERR(Debug::PAINTING, "Cumulative flags: " << flagsAsString(flags));
540 // Now compute the update strategy
541 // Possibly values in flag are None, SinglePar, Decoration, ForceDraw
542 LATTEST((d->update_flags_ & ~(Update::None | Update::SinglePar
543 | Update::Decoration | Update::ForceDraw)) == 0);
545 if (d->update_flags_ & Update::ForceDraw)
546 d->update_strategy_ = FullScreenUpdate;
547 else if (d->update_flags_ & Update::Decoration)
548 d->update_strategy_ = DecorationUpdate;
549 else if (d->update_flags_ & Update::SinglePar)
550 d->update_strategy_ = SingleParUpdate;
552 // no need to redraw anything.
553 d->update_strategy_ = NoScreenUpdate;
556 updateHoveredInset();
559 buffer_.changed(false);
563 void BufferView::updateScrollbar()
565 if (height_ == 0 && width_ == 0)
568 // We prefer fixed size line scrolling.
569 d->scrollbarParameters_.single_step = defaultRowHeight();
570 // We prefer full screen page scrolling.
571 d->scrollbarParameters_.page_step = height_;
573 Text & t = buffer_.text();
574 TextMetrics & tm = d->text_metrics_[&t];
576 LYXERR(Debug::GUI, " Updating scrollbar: height: "
577 << t.paragraphs().size()
578 << " curr par: " << d->cursor_.bottom().pit()
579 << " default height " << defaultRowHeight());
581 size_t const parsize = t.paragraphs().size();
582 if (d->par_height_.size() != parsize) {
583 d->par_height_.clear();
584 // FIXME: We assume a default paragraph height of 2 rows. This
585 // should probably be pondered with the screen width.
586 d->par_height_.resize(parsize, defaultRowHeight() * 2);
589 // Look at paragraph heights on-screen
590 pair<pit_type, ParagraphMetrics const *> first = tm.first();
591 pair<pit_type, ParagraphMetrics const *> last = tm.last();
592 for (pit_type pit = first.first; pit <= last.first; ++pit) {
593 d->par_height_[pit] = tm.parMetrics(pit).height();
594 LYXERR(Debug::SCROLLING, "storing height for pit " << pit << " : "
595 << d->par_height_[pit]);
598 int top_pos = first.second->position() - first.second->ascent();
599 int bottom_pos = last.second->position() + last.second->descent();
600 bool first_visible = first.first == 0 && top_pos >= 0;
601 bool last_visible = last.first + 1 == int(parsize) && bottom_pos <= height_;
602 if (first_visible && last_visible) {
603 d->scrollbarParameters_.min = 0;
604 d->scrollbarParameters_.max = 0;
608 d->scrollbarParameters_.min = top_pos;
609 for (size_t i = 0; i != size_t(first.first); ++i)
610 d->scrollbarParameters_.min -= d->par_height_[i];
611 d->scrollbarParameters_.max = bottom_pos;
612 for (size_t i = last.first + 1; i != parsize; ++i)
613 d->scrollbarParameters_.max += d->par_height_[i];
615 // The reference is the top position so we remove one page.
616 if (lyxrc.scroll_below_document)
617 d->scrollbarParameters_.max -= minVisiblePart();
619 d->scrollbarParameters_.max -= d->scrollbarParameters_.page_step;
621 // 0 must be inside the range as it denotes the current position
622 if (d->scrollbarParameters_.max < 0)
623 d->scrollbarParameters_.max = 0;
624 if (d->scrollbarParameters_.min > 0)
625 d->scrollbarParameters_.min = 0;
629 ScrollbarParameters const & BufferView::scrollbarParameters() const
631 return d->scrollbarParameters_;
635 docstring BufferView::toolTip(int x, int y) const
637 // Get inset under mouse, if there is one.
638 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
640 // No inset, no tooltip...
642 return covering_inset->toolTip(*this, x, y);
646 string BufferView::contextMenu(int x, int y) const
648 //If there is a selection, return the containing inset menu
649 if (d->cursor_.selection())
650 return d->cursor_.inset().contextMenu(*this, x, y);
652 // Get inset under mouse, if there is one.
653 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
655 return covering_inset->contextMenu(*this, x, y);
657 return buffer_.inset().contextMenu(*this, x, y);
662 void BufferView::scrollDocView(int const pixels, bool update)
664 // The scrollbar values are relative to the top of the screen, therefore the
665 // offset is equal to the target value.
667 // No scrolling at all? No need to redraw anything
671 // If the offset is less than 2 screen height, prefer to scroll instead.
672 if (abs(pixels) <= 2 * height_) {
673 d->anchor_ypos_ -= pixels;
674 processUpdateFlags(Update::Force);
678 // cut off at the top
679 if (pixels <= d->scrollbarParameters_.min) {
680 DocIterator dit = doc_iterator_begin(&buffer_);
681 showCursor(dit, false, update);
682 LYXERR(Debug::SCROLLING, "scroll to top");
686 // cut off at the bottom
687 if (pixels >= d->scrollbarParameters_.max) {
688 DocIterator dit = doc_iterator_end(&buffer_);
690 showCursor(dit, false, update);
691 LYXERR(Debug::SCROLLING, "scroll to bottom");
695 // find paragraph at target position
696 int par_pos = d->scrollbarParameters_.min;
698 for (; i != int(d->par_height_.size()); ++i) {
699 par_pos += d->par_height_[i];
700 if (par_pos >= pixels)
704 if (par_pos < pixels) {
705 // It seems we didn't find the correct pit so stay on the safe side and
707 LYXERR0("scrolling position not found!");
708 scrollDocView(d->scrollbarParameters_.max, update);
712 DocIterator dit = doc_iterator_begin(&buffer_);
714 LYXERR(Debug::SCROLLING, "pixels = " << pixels << " -> scroll to pit " << i);
715 showCursor(dit, false, update);
719 // FIXME: this method is not working well.
720 void BufferView::setCursorFromScrollbar()
722 TextMetrics & tm = d->text_metrics_[&buffer_.text()];
724 int const height = 2 * defaultRowHeight();
725 int const first = height;
726 int const last = height_ - height;
728 Cursor const & oldcur = d->cursor_;
730 switch (cursorStatus(oldcur)) {
738 int const y = getPos(oldcur).y_;
739 newy = min(last, max(y, first));
743 // We reset the cursor because cursorStatus() does not
744 // work when the cursor is within mathed.
747 tm.setCursorFromCoordinates(cur, 0, newy);
749 // update the bufferview cursor and notify insets
750 // FIXME: Care about the d->cursor_ flags to redraw if needed
751 Cursor old = d->cursor_;
753 // the DEPM call in mouseSetCursor() might have destroyed the
754 // paragraph the cursor is in.
755 bool badcursor = old.fixIfBroken();
756 badcursor |= notifyCursorLeavesOrEnters(old, d->cursor_);
758 d->cursor_.fixIfBroken();
762 Change const BufferView::getCurrentChange() const
764 if (!d->cursor_.selection())
765 return Change(Change::UNCHANGED);
767 DocIterator dit = d->cursor_.selectionBegin();
768 // The selected content might have been changed (see #7685)
769 dit = dit.getInnerText();
770 return dit.paragraph().lookupChange(dit.pos());
774 // this could be used elsewhere as well?
775 // FIXME: This does not work within mathed!
776 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
778 Point const p = getPos(dit);
781 if (p.y_ > workHeight())
787 void BufferView::bookmarkEditPosition()
789 // Don't eat cpu time for each keystroke
790 if (d->cursor_.paragraph().id() == d->bookmark_edit_position_)
793 d->bookmark_edit_position_ = d->cursor_.paragraph().id();
797 void BufferView::saveBookmark(unsigned int idx)
799 if (buffer().isInternal())
802 // tentatively save bookmark, id and pos will be used to
803 // acturately locate a bookmark in a 'live' lyx session.
804 // pit and pos will be updated with bottom level pit/pos
806 theSession().bookmarks().save(
808 d->cursor_.bottom().pit(),
809 d->cursor_.bottom().pos(),
810 d->cursor_.paragraph().id(),
815 // emit message signal.
816 message(_("Save bookmark"));
820 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
821 int top_id, pos_type top_pos)
823 bool success = false;
826 d->cursor_.clearSelection();
828 // if a valid par_id is given, try it first
829 // This is the case for a 'live' bookmark when unique paragraph ID
830 // is used to track bookmarks.
832 dit = buffer_.getParFromID(top_id);
834 dit.pos() = min(dit.paragraph().size(), top_pos);
835 // Some slices of the iterator may not be
836 // reachable (e.g. closed collapsible inset)
837 // so the dociterator may need to be
838 // shortened. Otherwise, setCursor may crash
839 // lyx when the cursor can not be set to these
841 size_t const n = dit.depth();
842 for (size_t i = 0; i < n; ++i)
843 if (!dit[i].inset().editable()) {
851 // if top_id == 0, or searching through top_id failed
852 // This is the case for a 'restored' bookmark when only bottom
853 // (document level) pit was saved. Because of this, bookmark
854 // restoration is inaccurate. If a bookmark was within an inset,
855 // it will be restored to the left of the outmost inset that contains
857 if (bottom_pit < int(buffer_.paragraphs().size())) {
858 dit = doc_iterator_begin(&buffer_);
860 dit.pit() = bottom_pit;
861 dit.pos() = min(bottom_pos, dit.paragraph().size());
866 // Note: only bottom (document) level pit is set.
868 // set the current font.
869 d->cursor_.setCurrentFont();
870 // Do not forget to reset the anchor (see #9912)
871 d->cursor_.resetAnchor();
872 processUpdateFlags(Update::Force | Update::FitCursor);
879 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
881 if (d->cursor_.real_current_font.isRightToLeft()) {
882 if (d->intl_.keymap == Intl::PRIMARY)
883 d->intl_.keyMapSec();
885 if (d->intl_.keymap == Intl::SECONDARY)
886 d->intl_.keyMapPrim();
889 d->intl_.getTransManager().translateAndInsert(c, t, cur);
893 int BufferView::workWidth() const
899 void BufferView::recenter()
901 showCursor(d->cursor_, true, true);
905 void BufferView::showCursor()
907 showCursor(d->cursor_, false, true);
911 void BufferView::showCursor(DocIterator const & dit,
912 bool recenter, bool update)
914 if (scrollToCursor(dit, recenter) && update)
915 processUpdateFlags(Update::Force);
919 void BufferView::scrollToCursor()
921 if (scrollToCursor(d->cursor_, false))
922 processUpdateFlags(Update::Force);
926 bool BufferView::scrollToCursor(DocIterator const & dit, bool const recenter)
928 // We are not properly started yet, delay until resizing is
934 LYXERR(Debug::SCROLLING, "recentering and scrolling to cursor");
936 LYXERR(Debug::SCROLLING, "scrolling to cursor");
938 CursorSlice const & bot = dit.bottom();
939 TextMetrics & tm = d->text_metrics_[bot.text()];
941 pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
942 pos_type bot_pit = bot.pit();
943 if (bot_pit > max_pit) {
944 // FIXME: Why does this happen?
945 LYXERR0("bottom pit is greater that max pit: "
946 << bot_pit << " > " << max_pit);
950 if (bot_pit == tm.first().first - 1)
951 tm.newParMetricsUp();
952 else if (bot_pit == tm.last().first + 1)
953 tm.newParMetricsDown();
955 if (tm.contains(bot_pit)) {
956 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
957 LBUFERR(!pm.rows().empty());
958 // FIXME: smooth scrolling doesn't work in mathed.
959 CursorSlice const & cs = dit.innerTextSlice();
960 int offset = coordOffset(dit).y_;
961 int ypos = pm.position() + offset;
962 Dimension const & row_dim =
963 pm.getRow(cs.pos(), dit.boundary()).dim();
966 scrolled = scroll(ypos - height_/2);
968 // We try to visualize the whole row, if the row height is larger than
969 // the screen height, we scroll to a heuristic value of height_ / 4.
970 // FIXME: This heuristic value should be replaced by a recursive search
971 // for a row in the inset that can be visualized completely.
972 else if (row_dim.height() > height_) {
973 if (ypos < defaultRowHeight())
974 scrolled = scroll(ypos - height_ / 4);
975 else if (ypos > height_ - defaultRowHeight())
976 scrolled = scroll(ypos - 3 * height_ / 4);
979 // If the top part of the row falls of the screen, we scroll
980 // up to align the top of the row with the top of the screen.
981 else if (ypos - row_dim.ascent() < 0 && ypos < height_) {
982 int ynew = row_dim.ascent();
983 scrolled = scrollUp(ynew - ypos);
986 // If the bottom of the row falls of the screen, we scroll down.
987 else if (ypos + row_dim.descent() > height_ && ypos > 0) {
988 int ynew = height_ - row_dim.descent();
989 scrolled = scrollDown(ypos - ynew);
992 // else, nothing to do, the cursor is already visible so we just return.
993 return scrolled != 0;
996 // fix inline completion position
997 if (d->inlineCompletionPos_.fixIfBroken())
998 d->inlineCompletionPos_ = DocIterator();
1000 tm.redoParagraph(bot_pit);
1001 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
1002 int offset = coordOffset(dit).y_;
1004 d->anchor_pit_ = bot_pit;
1005 CursorSlice const & cs = dit.innerTextSlice();
1006 Dimension const & row_dim =
1007 pm.getRow(cs.pos(), dit.boundary()).dim();
1010 d->anchor_ypos_ = height_/2;
1011 else if (d->anchor_pit_ == 0)
1012 d->anchor_ypos_ = offset + pm.ascent();
1013 else if (d->anchor_pit_ == max_pit)
1014 d->anchor_ypos_ = height_ - offset - row_dim.descent();
1015 else if (offset > height_)
1016 d->anchor_ypos_ = height_ - offset - defaultRowHeight();
1018 d->anchor_ypos_ = defaultRowHeight() * 2;
1024 void BufferView::makeDocumentClass()
1026 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1027 buffer_.params().makeDocumentClass();
1028 updateDocumentClass(olddc);
1032 void BufferView::updateDocumentClass(DocumentClassConstPtr olddc)
1034 message(_("Converting document to new document class..."));
1036 StableDocIterator backcur(d->cursor_);
1037 ErrorList & el = buffer_.errorList("Class Switch");
1038 cap::switchBetweenClasses(
1039 olddc, buffer_.params().documentClassPtr(),
1040 static_cast<InsetText &>(buffer_.inset()), el);
1042 setCursor(backcur.asDocIterator(&buffer_));
1044 buffer_.errors("Class Switch");
1048 /** Return the change status at cursor position, taking into account the
1049 * status at each level of the document iterator (a table in a deleted
1050 * footnote is deleted).
1051 * When \param outer is true, the top slice is not looked at.
1053 static Change::Type lookupChangeType(DocIterator const & dit, bool outer = false)
1055 size_t const depth = dit.depth() - (outer ? 1 : 0);
1057 for (size_t i = 0 ; i < depth ; ++i) {
1058 CursorSlice const & slice = dit[i];
1059 if (!slice.inset().inMathed()
1060 && slice.pos() < slice.paragraph().size()) {
1061 Change::Type const ch = slice.paragraph().lookupChange(slice.pos()).type;
1062 if (ch != Change::UNCHANGED)
1066 return Change::UNCHANGED;
1070 bool BufferView::getStatus(FuncRequest const & cmd, FuncStatus & flag)
1072 FuncCode const act = cmd.action();
1074 // Can we use a readonly buffer?
1075 if (buffer_.isReadonly()
1076 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1077 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1078 if (buffer_.hasReadonlyFlag())
1079 flag.message(from_utf8(N_("Document is read-only")));
1081 flag.message(from_utf8(N_("Document has been modified externally")));
1082 flag.setEnabled(false);
1086 // Are we in a DELETED change-tracking region?
1087 if (lookupChangeType(d->cursor_, true) == Change::DELETED
1088 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1089 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1090 flag.message(from_utf8(N_("This portion of the document is deleted.")));
1091 flag.setEnabled(false);
1095 Cursor & cur = d->cursor_;
1097 if (cur.getStatus(cmd, flag))
1102 // FIXME: This is a bit problematic because we don't check if this is
1103 // a document BufferView or not for these LFUNs. We probably have to
1104 // dispatch both to currentBufferView() and, if that fails,
1105 // to documentBufferView(); same as we do now for current Buffer and
1106 // document Buffer. Ideally those LFUN should go to Buffer as they
1107 // operate on the full Buffer and the cursor is only needed either for
1108 // an Undo record or to restore a cursor position. But we don't know
1109 // how to do that inside Buffer of course.
1110 case LFUN_BUFFER_PARAMS_APPLY:
1111 case LFUN_LAYOUT_MODULES_CLEAR:
1112 case LFUN_LAYOUT_MODULE_ADD:
1113 case LFUN_LAYOUT_RELOAD:
1114 case LFUN_TEXTCLASS_APPLY:
1115 case LFUN_TEXTCLASS_LOAD:
1116 flag.setEnabled(!buffer_.isReadonly());
1120 // We do not use the LyXAction flag for readonly because Undo sets the
1121 // buffer clean/dirty status by itself.
1122 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasUndoStack());
1125 // We do not use the LyXAction flag for readonly because Redo sets the
1126 // buffer clean/dirty status by itself.
1127 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasRedoStack());
1129 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
1130 case LFUN_FILE_INSERT_PLAINTEXT: {
1131 docstring const & fname = cmd.argument();
1132 if (!FileName::isAbsolute(to_utf8(fname))) {
1133 flag.message(_("Absolute filename expected."));
1136 flag.setEnabled(cur.inTexted());
1139 case LFUN_FILE_INSERT:
1140 case LFUN_BOOKMARK_SAVE:
1141 // FIXME: Actually, these LFUNS should be moved to Text
1142 flag.setEnabled(cur.inTexted());
1145 case LFUN_FONT_STATE:
1146 case LFUN_LABEL_INSERT:
1147 case LFUN_INFO_INSERT:
1148 case LFUN_PARAGRAPH_GOTO:
1149 case LFUN_NOTE_NEXT:
1150 case LFUN_REFERENCE_NEXT:
1151 case LFUN_WORD_FIND:
1152 case LFUN_WORD_FIND_FORWARD:
1153 case LFUN_WORD_FIND_BACKWARD:
1154 case LFUN_WORD_REPLACE:
1157 case LFUN_MARK_TOGGLE:
1158 case LFUN_SCREEN_RECENTER:
1159 case LFUN_SCREEN_SHOW_CURSOR:
1160 case LFUN_BIBTEX_DATABASE_ADD:
1161 case LFUN_BIBTEX_DATABASE_DEL:
1162 case LFUN_STATISTICS:
1163 case LFUN_KEYMAP_OFF:
1164 case LFUN_KEYMAP_PRIMARY:
1165 case LFUN_KEYMAP_SECONDARY:
1166 case LFUN_KEYMAP_TOGGLE:
1167 case LFUN_INSET_SELECT_ALL:
1168 flag.setEnabled(true);
1171 case LFUN_GRAPHICS_UNIFY:
1172 flag.setEnabled(cur.countInsetsInSelection(GRAPHICS_CODE)>1);
1175 case LFUN_WORD_FINDADV: {
1176 FindAndReplaceOptions opt;
1177 istringstream iss(to_utf8(cmd.argument()));
1179 flag.setEnabled(opt.repl_buf_name.empty()
1180 || !buffer_.isReadonly());
1184 case LFUN_LABEL_GOTO:
1185 flag.setEnabled(!cmd.argument().empty()
1186 || getInsetByCode<InsetRef>(cur, REF_CODE));
1189 case LFUN_CHANGES_MERGE:
1190 case LFUN_CHANGE_NEXT:
1191 case LFUN_CHANGE_PREVIOUS:
1192 case LFUN_ALL_CHANGES_ACCEPT:
1193 case LFUN_ALL_CHANGES_REJECT:
1194 flag.setEnabled(buffer_.areChangesPresent());
1197 case LFUN_SCREEN_UP:
1198 case LFUN_SCREEN_DOWN:
1200 case LFUN_SCREEN_UP_SELECT:
1201 case LFUN_SCREEN_DOWN_SELECT:
1202 case LFUN_INSET_FORALL:
1203 flag.setEnabled(true);
1206 case LFUN_LAYOUT_TABULAR:
1207 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
1211 flag.setEnabled(!cur.inset().forcePlainLayout(cur.idx()));
1214 case LFUN_LAYOUT_PARAGRAPH:
1215 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
1218 case LFUN_BRANCH_ADD_INSERT:
1219 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1222 case LFUN_DIALOG_SHOW_NEW_INSET:
1223 // FIXME: this is wrong, but I do not understand the
1225 if (cur.inset().lyxCode() == CAPTION_CODE)
1226 return cur.inset().getStatus(cur, cmd, flag);
1227 // FIXME we should consider passthru paragraphs too.
1228 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1231 case LFUN_CITATION_INSERT: {
1232 FuncRequest fr(LFUN_INSET_INSERT, "citation");
1233 // FIXME: This could turn in a recursive hell.
1234 // Shouldn't we use Buffer::getStatus() instead?
1235 flag.setEnabled(lyx::getStatus(fr).enabled());
1238 case LFUN_INSET_APPLY: {
1239 string const name = cmd.getArg(0);
1240 Inset * inset = editedInset(name);
1242 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1243 if (!inset->getStatus(cur, fr, flag)) {
1244 // Every inset is supposed to handle this
1245 LASSERT(false, break);
1248 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1249 flag = lyx::getStatus(fr);
1262 Inset * BufferView::editedInset(string const & name) const
1264 map<string, Inset *>::const_iterator it = d->edited_insets_.find(name);
1265 return it == d->edited_insets_.end() ? nullptr : it->second;
1269 void BufferView::editInset(string const & name, Inset * inset)
1272 d->edited_insets_[name] = inset;
1274 d->edited_insets_.erase(name);
1278 void BufferView::dispatch(FuncRequest const & cmd, DispatchResult & dr)
1280 LYXERR(Debug::ACTION, "BufferView::dispatch: cmd: " << cmd);
1282 string const argument = to_utf8(cmd.argument());
1283 Cursor & cur = d->cursor_;
1286 // Don't dispatch function that does not apply to internal buffers.
1287 if (buffer_.isInternal()
1288 && lyxaction.funcHasFlag(cmd.action(), LyXAction::NoInternal))
1291 // We'll set this back to false if need be.
1292 bool dispatched = true;
1293 buffer_.undo().beginUndoGroup();
1295 FuncCode const act = cmd.action();
1298 case LFUN_BUFFER_PARAMS_APPLY: {
1299 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1300 cur.recordUndoBufferParams();
1301 istringstream ss(to_utf8(cmd.argument()));
1304 int const unknown_tokens = buffer_.readHeader(lex);
1305 if (unknown_tokens != 0) {
1306 LYXERR0("Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1307 << unknown_tokens << " unknown token"
1308 << (unknown_tokens == 1 ? "" : "s"));
1310 updateDocumentClass(olddc);
1312 // We are most certainly here because of a change in the document
1313 // It is then better to make sure that all dialogs are in sync with
1314 // current document settings.
1315 dr.screenUpdate(Update::Force | Update::FitCursor);
1316 dr.forceBufferUpdate();
1320 case LFUN_LAYOUT_MODULES_CLEAR: {
1321 // FIXME: this modifies the document in cap::switchBetweenClasses
1322 // without calling recordUndo. Fix this before using
1323 // recordUndoBufferParams().
1324 cur.recordUndoFullBuffer();
1325 buffer_.params().clearLayoutModules();
1326 makeDocumentClass();
1327 dr.screenUpdate(Update::Force);
1328 dr.forceBufferUpdate();
1332 case LFUN_LAYOUT_MODULE_ADD: {
1333 BufferParams const & params = buffer_.params();
1334 if (!params.layoutModuleCanBeAdded(argument)) {
1335 LYXERR0("Module `" << argument <<
1336 "' cannot be added due to failed requirements or "
1337 "conflicts with installed modules.");
1340 // FIXME: this modifies the document in cap::switchBetweenClasses
1341 // without calling recordUndo. Fix this before using
1342 // recordUndoBufferParams().
1343 cur.recordUndoFullBuffer();
1344 buffer_.params().addLayoutModule(argument);
1345 makeDocumentClass();
1346 dr.screenUpdate(Update::Force);
1347 dr.forceBufferUpdate();
1351 case LFUN_TEXTCLASS_APPLY: {
1352 // since this shortcircuits, the second call is made only if
1354 bool const success =
1355 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1356 LayoutFileList::get().load(argument, buffer_.filePath());
1358 docstring s = bformat(_("The document class `%1$s' "
1359 "could not be loaded."), from_utf8(argument));
1360 frontend::Alert::error(_("Could not load class"), s);
1364 LayoutFile const * old_layout = buffer_.params().baseClass();
1365 LayoutFile const * new_layout = &(LayoutFileList::get()[argument]);
1367 if (old_layout == new_layout)
1371 // Save the old, possibly modular, layout for use in conversion.
1372 // FIXME: this modifies the document in cap::switchBetweenClasses
1373 // without calling recordUndo. Fix this before using
1374 // recordUndoBufferParams().
1375 cur.recordUndoFullBuffer();
1376 buffer_.params().setBaseClass(argument, buffer_.layoutPos());
1377 makeDocumentClass();
1378 dr.screenUpdate(Update::Force);
1379 dr.forceBufferUpdate();
1383 case LFUN_TEXTCLASS_LOAD: {
1384 // since this shortcircuits, the second call is made only if
1386 bool const success =
1387 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1388 LayoutFileList::get().load(argument, buffer_.filePath());
1390 docstring s = bformat(_("The document class `%1$s' "
1391 "could not be loaded."), from_utf8(argument));
1392 frontend::Alert::error(_("Could not load class"), s);
1397 case LFUN_LAYOUT_RELOAD: {
1398 LayoutFileIndex bc = buffer_.params().baseClassID();
1399 LayoutFileList::get().reset(bc);
1400 buffer_.params().setBaseClass(bc, buffer_.layoutPos());
1401 makeDocumentClass();
1402 dr.screenUpdate(Update::Force);
1403 dr.forceBufferUpdate();
1408 dr.setMessage(_("Undo"));
1409 cur.clearSelection();
1410 // We need to find out if the bibliography information
1411 // has changed. See bug #11055.
1412 // So these should not be references...
1413 string const engine = buffer().params().citeEngine();
1414 CiteEngineType const enginetype = buffer().params().citeEngineType();
1415 if (!cur.undoAction())
1416 dr.setMessage(_("No further undo information"));
1418 dr.screenUpdate(Update::Force | Update::FitCursor);
1419 dr.forceBufferUpdate();
1420 if (buffer().params().citeEngine() != engine ||
1421 buffer().params().citeEngineType() != enginetype)
1422 buffer().invalidateCiteLabels();
1428 dr.setMessage(_("Redo"));
1429 cur.clearSelection();
1430 // We need to find out if the bibliography information
1431 // has changed. See bug #11055.
1432 // So these should not be references...
1433 string const engine = buffer().params().citeEngine();
1434 CiteEngineType const enginetype = buffer().params().citeEngineType();
1435 if (!cur.redoAction())
1436 dr.setMessage(_("No further redo information"));
1438 dr.screenUpdate(Update::Force | Update::FitCursor);
1439 dr.forceBufferUpdate();
1440 if (buffer().params().citeEngine() != engine ||
1441 buffer().params().citeEngineType() != enginetype)
1442 buffer().invalidateCiteLabels();
1447 case LFUN_FONT_STATE:
1448 dr.setMessage(cur.currentState(false));
1451 case LFUN_BOOKMARK_SAVE:
1452 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1455 case LFUN_LABEL_GOTO: {
1456 docstring label = cmd.argument();
1457 if (label.empty()) {
1459 getInsetByCode<InsetRef>(cur, REF_CODE);
1461 label = inset->getParam("reference");
1462 // persistent=false: use temp_bookmark
1466 if (!label.empty()) {
1468 // at the moment, this is redundant, since gotoLabel will
1469 // eventually call LFUN_PARAGRAPH_GOTO, but it seems best
1471 dr.screenUpdate(Update::Force | Update::FitCursor);
1476 case LFUN_PARAGRAPH_GOTO: {
1477 int const id = convert<int>(cmd.getArg(0));
1478 pos_type const pos = convert<int>(cmd.getArg(1));
1481 string const str_id_end = cmd.getArg(2);
1482 string const str_pos_end = cmd.getArg(3);
1484 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1485 b = theBufferList().next(b)) {
1488 curs.setCursor(b->getParFromID(id));
1490 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1494 LYXERR(Debug::INFO, "Paragraph " << curs.paragraph().id()
1495 << " found in buffer `"
1496 << b->absFileName() << "'.");
1498 if (b == &buffer_) {
1500 if (str_id_end.empty() || str_pos_end.empty()) {
1503 mouseSetCursor(curs);
1506 int const id_end = convert<int>(str_id_end);
1507 pos_type const pos_end = convert<int>(str_pos_end);
1508 success = setCursorFromEntries({id, pos},
1512 dr.screenUpdate(Update::Force | Update::FitCursor);
1514 // Switch to other buffer view and resend cmd
1515 lyx::dispatch(FuncRequest(
1516 LFUN_BUFFER_SWITCH, b->absFileName()));
1524 case LFUN_NOTE_NEXT:
1525 gotoInset(this, { NOTE_CODE }, false);
1526 // FIXME: if SinglePar is changed to act on the inner
1527 // paragraph, this will not be OK anymore. The update is
1528 // useful for auto-open collapsible insets.
1529 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1532 case LFUN_REFERENCE_NEXT: {
1533 gotoInset(this, { LABEL_CODE, REF_CODE }, true);
1534 // FIXME: if SinglePar is changed to act on the inner
1535 // paragraph, this will not be OK anymore. The update is
1536 // useful for auto-open collapsible insets.
1537 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1541 case LFUN_CHANGE_NEXT:
1542 findNextChange(this);
1543 if (cur.inset().isTable())
1544 // In tables, there might be whole changed rows or columns
1546 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1547 dr.screenUpdate(Update::Force | Update::FitCursor);
1550 case LFUN_CHANGE_PREVIOUS:
1551 findPreviousChange(this);
1552 if (cur.inset().isTable())
1553 // In tables, there might be whole changed rows or columns
1555 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1556 dr.screenUpdate(Update::Force | Update::FitCursor);
1559 case LFUN_CHANGES_MERGE:
1560 if (findNextChange(this) || findPreviousChange(this)) {
1561 dr.screenUpdate(Update::Force | Update::FitCursor);
1562 dr.forceBufferUpdate();
1563 showDialog("changes");
1567 case LFUN_ALL_CHANGES_ACCEPT: {
1568 // select complete document
1570 cur.selHandle(true);
1571 buffer_.text().cursorBottom(cur);
1572 // accept everything in a single step to support atomic undo
1573 // temporarily disable track changes in order to end with really
1574 // no new (e.g., DPSM-caused) changes (see #7487)
1575 bool const track = buffer_.params().track_changes;
1576 buffer_.params().track_changes = false;
1577 buffer_.text().acceptOrRejectChanges(cur, Text::ACCEPT);
1578 buffer_.params().track_changes = track;
1580 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1581 dr.screenUpdate(Update::Force | Update::FitCursor);
1582 dr.forceBufferUpdate();
1586 case LFUN_ALL_CHANGES_REJECT: {
1587 // select complete document
1589 cur.selHandle(true);
1590 buffer_.text().cursorBottom(cur);
1591 // reject everything in a single step to support atomic undo
1592 // temporarily disable track changes in order to end with really
1593 // no new (e.g., DPSM-caused) changes (see #7487)
1594 bool const track = buffer_.params().track_changes;
1595 buffer_.params().track_changes = false;
1596 buffer_.text().acceptOrRejectChanges(cur, Text::REJECT);
1597 buffer_.params().track_changes = track;
1599 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1600 dr.screenUpdate(Update::Force | Update::FitCursor);
1601 dr.forceBufferUpdate();
1605 case LFUN_WORD_FIND_FORWARD:
1606 case LFUN_WORD_FIND_BACKWARD: {
1608 // Would it maybe be better if this variable were view specific anyway?
1609 static docstring last_search;
1610 docstring searched_string;
1612 if (!cmd.argument().empty()) {
1613 last_search = cmd.argument();
1614 searched_string = cmd.argument();
1616 searched_string = last_search;
1619 if (searched_string.empty())
1622 bool const fw = act == LFUN_WORD_FIND_FORWARD;
1623 docstring const data =
1624 find2string(searched_string, true, false, fw);
1625 bool found = lyxfind(this, FuncRequest(LFUN_WORD_FIND, data));
1627 dr.screenUpdate(Update::Force | Update::FitCursor);
1629 dr.setMessage(_("Search string not found!"));
1633 case LFUN_WORD_FIND: {
1634 FuncRequest req = cmd;
1635 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1636 req = d->search_request_cache_;
1637 if (req.argument().empty()) {
1638 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, "findreplace"));
1641 if (lyxfind(this, req))
1642 dr.screenUpdate(Update::Force | Update::FitCursor);
1644 dr.setMessage(_("Search string not found!"));
1646 d->search_request_cache_ = req;
1650 case LFUN_WORD_REPLACE: {
1651 bool has_deleted = false;
1652 if (cur.selection()) {
1653 DocIterator beg = cur.selectionBegin();
1654 DocIterator end = cur.selectionEnd();
1655 if (beg.pit() == end.pit()) {
1656 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1657 if (!cur.inMathed() && cur.paragraph().isDeleted(p)) {
1664 if (lyxreplace(this, cmd, has_deleted)) {
1665 dr.forceBufferUpdate();
1666 dr.screenUpdate(Update::Force | Update::FitCursor);
1669 dr.setMessage(_("Search string not found!"));
1673 case LFUN_WORD_FINDADV: {
1674 FindAndReplaceOptions opt;
1675 istringstream iss(to_utf8(cmd.argument()));
1677 if (findAdv(this, opt)) {
1678 dr.screenUpdate(Update::Force | Update::FitCursor);
1689 cur.clearSelection();
1690 dr.setMessage(from_utf8(N_("Mark off")));
1694 cur.clearSelection();
1696 dr.setMessage(from_utf8(N_("Mark on")));
1699 case LFUN_MARK_TOGGLE:
1700 cur.selection(false);
1703 dr.setMessage(from_utf8(N_("Mark removed")));
1706 dr.setMessage(from_utf8(N_("Mark set")));
1711 case LFUN_SCREEN_SHOW_CURSOR:
1715 case LFUN_SCREEN_RECENTER:
1719 case LFUN_BIBTEX_DATABASE_ADD: {
1720 Cursor tmpcur = cur;
1721 findInset(tmpcur, { BIBTEX_CODE }, false);
1722 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1725 if (inset->addDatabase(cmd.argument()))
1726 dr.forceBufferUpdate();
1731 case LFUN_BIBTEX_DATABASE_DEL: {
1732 Cursor tmpcur = cur;
1733 findInset(tmpcur, { BIBTEX_CODE }, false);
1734 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1737 if (inset->delDatabase(cmd.argument()))
1738 dr.forceBufferUpdate();
1743 case LFUN_GRAPHICS_UNIFY: {
1745 cur.recordUndoFullBuffer();
1747 DocIterator from, to;
1748 from = cur.selectionBegin();
1749 to = cur.selectionEnd();
1751 string const newId = cmd.getArg(0);
1752 bool fetchId = newId.empty(); //if we wait for groupId from first graphics inset
1754 InsetGraphicsParams grp_par;
1756 InsetGraphics::string2params(graphics::getGroupParams(buffer_, newId), buffer_, grp_par);
1758 if (!from.nextInset()) //move to closest inset
1759 from.forwardInset();
1761 while (!from.empty() && from < to) {
1762 Inset * inset = from.nextInset();
1765 InsetGraphics * ig = inset->asInsetGraphics();
1767 InsetGraphicsParams inspar = ig->getParams();
1772 grp_par.filename = inspar.filename;
1773 ig->setParams(grp_par);
1776 from.forwardInset();
1778 dr.screenUpdate(Update::Force); //needed if triggered from context menu
1782 case LFUN_STATISTICS: {
1783 DocIterator from, to;
1784 if (cur.selection()) {
1785 from = cur.selectionBegin();
1786 to = cur.selectionEnd();
1788 from = doc_iterator_begin(&buffer_);
1789 to = doc_iterator_end(&buffer_);
1791 buffer_.updateStatistics(from, to);
1792 int const words = buffer_.wordCount();
1793 int const chars = buffer_.charCount(false);
1794 int const chars_blanks = buffer_.charCount(true);
1796 if (cur.selection())
1797 message = _("Statistics for the selection:");
1799 message = _("Statistics for the document:");
1802 message += bformat(_("%1$d words"), words);
1804 message += _("One word");
1806 if (chars_blanks != 1)
1807 message += bformat(_("%1$d characters (including blanks)"),
1810 message += _("One character (including blanks)");
1813 message += bformat(_("%1$d characters (excluding blanks)"),
1816 message += _("One character (excluding blanks)");
1818 Alert::information(_("Statistics"), message);
1822 case LFUN_SCREEN_UP:
1823 case LFUN_SCREEN_DOWN: {
1824 Point p = getPos(cur);
1825 // This code has been commented out to enable to scroll down a
1826 // document, even if there are large insets in it (see bug #5465).
1827 /*if (p.y_ < 0 || p.y_ > height_) {
1828 // The cursor is off-screen so recenter before proceeding.
1832 int const scrolled = scroll(act == LFUN_SCREEN_UP
1833 ? -height_ : height_);
1834 if (act == LFUN_SCREEN_UP && scrolled > -height_)
1836 if (act == LFUN_SCREEN_DOWN && scrolled < height_)
1837 p = Point(width_, height_);
1838 bool const in_texted = cur.inTexted();
1839 cur.setCursor(doc_iterator_begin(cur.buffer()));
1840 cur.selHandle(false);
1841 // Force an immediate computation of metrics because we need it below
1842 processUpdateFlags(Update::Force);
1844 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_,
1845 true, act == LFUN_SCREEN_UP);
1846 //FIXME: what to do with cur.x_target()?
1847 bool update = in_texted && cur.bv().checkDepm(cur, old);
1850 if (update || cur.mark())
1851 dr.screenUpdate(Update::Force | Update::FitCursor);
1853 dr.forceBufferUpdate();
1858 string const scroll_type = cmd.getArg(0);
1859 int scroll_step = 0;
1860 if (scroll_type == "line")
1861 scroll_step = d->scrollbarParameters_.single_step;
1862 else if (scroll_type == "page")
1863 scroll_step = d->scrollbarParameters_.page_step;
1866 string const scroll_quantity = cmd.getArg(1);
1867 if (scroll_quantity == "up")
1868 scrollUp(scroll_step);
1869 else if (scroll_quantity == "down")
1870 scrollDown(scroll_step);
1872 int const scroll_value = convert<int>(scroll_quantity);
1874 scroll(scroll_step * scroll_value);
1876 dr.screenUpdate(Update::ForceDraw);
1877 dr.forceBufferUpdate();
1881 case LFUN_SCREEN_UP_SELECT: {
1882 // FIXME: why is the algorithm different from LFUN_SCREEN_UP?
1883 cur.selHandle(true);
1884 if (isTopScreen()) {
1885 lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1889 int y = getPos(cur).y_;
1890 int const ymin = y - height_ + defaultRowHeight();
1891 while (y > ymin && cur.up())
1895 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1899 case LFUN_SCREEN_DOWN_SELECT: {
1900 // FIXME: why is the algorithm different from LFUN_SCREEN_DOWN?
1901 cur.selHandle(true);
1902 if (isBottomScreen()) {
1903 lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1907 int y = getPos(cur).y_;
1908 int const ymax = y + height_ - defaultRowHeight();
1909 while (y < ymax && cur.down())
1913 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1918 case LFUN_INSET_SELECT_ALL: {
1919 // true if all cells are selected
1920 bool const all_selected = cur.depth() > 1
1921 && cur.selBegin().at_begin()
1922 && cur.selEnd().at_end();
1923 // true if some cells are selected
1924 bool const cells_selected = cur.depth() > 1
1925 && cur.selBegin().at_cell_begin()
1926 && cur.selEnd().at_cell_end();
1927 if (all_selected || (cells_selected && !cur.inset().isTable())) {
1928 // All the contents of the inset if selected, or only at
1929 // least one cell but inset is not a table.
1930 // Select the inset from outside.
1933 cur.selection(true);
1935 } else if (cells_selected) {
1936 // At least one complete cell is selected and inset is a table.
1942 cur.selection(true);
1943 cur.idx() = cur.lastidx();
1944 cur.pit() = cur.lastpit();
1945 cur.pos() = cur.lastpos();
1947 // select current cell
1951 cur.selection(true);
1952 cur.pit() = cur.lastpit();
1953 cur.pos() = cur.lastpos();
1955 cur.setCurrentFont();
1956 dr.screenUpdate(Update::Force);
1961 case LFUN_UNICODE_INSERT: {
1962 if (cmd.argument().empty())
1965 FuncCode code = cur.inset().currentMode() == Inset::MATH_MODE ?
1966 LFUN_MATH_INSERT : LFUN_SELF_INSERT;
1969 docstring const arg = from_utf8(cmd.getArg(i));
1973 LYXERR0("Not a hexstring: " << arg);
1977 char_type c = hexToInt(arg);
1978 if (c >= 32 && c < 0x10ffff) {
1979 LYXERR(Debug::KEY, "Inserting c: " << c);
1980 lyx::dispatch(FuncRequest(code, docstring(1, c)));
1988 // This would be in Buffer class if only Cursor did not
1989 // require a bufferview
1990 case LFUN_INSET_FORALL: {
1991 docstring const name = from_utf8(cmd.getArg(0));
1992 string const commandstr = cmd.getLongArg(1);
1993 FuncRequest const fr = lyxaction.lookupFunc(commandstr);
1995 // an arbitrary number to limit number of iterations
1996 const int max_iter = 100000;
1998 Cursor & curs = d->cursor_;
1999 Cursor const savecur = curs;
2001 if (!curs.nextInset())
2002 curs.forwardInset();
2003 curs.beginUndoGroup();
2004 while(curs && iterations < max_iter) {
2005 Inset * const ins = curs.nextInset();
2008 docstring insname = ins->layoutName();
2009 while (!insname.empty()) {
2010 if (insname == name || name == from_utf8("*")) {
2012 lyx::dispatch(fr, dr);
2016 size_t const i = insname.rfind(':');
2017 if (i == string::npos)
2019 insname = insname.substr(0, i);
2021 // if we did not delete the inset, skip it
2022 if (!curs.nextInset() || curs.nextInset() == ins)
2023 curs.forwardInset();
2027 /** This is a dummy undo record only to remember the cursor
2028 * that has just been set; this will be used on a redo action
2029 * (see ticket #10097)
2031 * FIXME: a better fix would be to have a way to set the
2032 * cursor value directly, but I am not sure it is worth it.
2035 curs.endUndoGroup();
2036 dr.screenUpdate(Update::Force);
2037 dr.forceBufferUpdate();
2039 if (iterations >= max_iter) {
2041 dr.setMessage(bformat(_("`inset-forall' interrupted because number of actions is larger than %1$d"), max_iter));
2043 dr.setMessage(bformat(_("Applied \"%1$s\" to %2$d insets"), from_utf8(commandstr), iterations));
2048 case LFUN_BRANCH_ADD_INSERT: {
2049 docstring branch_name = from_utf8(cmd.getArg(0));
2050 if (branch_name.empty())
2051 if (!Alert::askForText(branch_name, _("Branch name")) ||
2052 branch_name.empty())
2055 DispatchResult drtmp;
2056 buffer_.dispatch(FuncRequest(LFUN_BRANCH_ADD, branch_name), drtmp);
2057 if (drtmp.error()) {
2058 Alert::warning(_("Branch already exists"), drtmp.message());
2061 docstring const sep = buffer_.params().branchlist().separator();
2062 for (docstring const & branch : getVectorFromString(branch_name, sep))
2063 lyx::dispatch(FuncRequest(LFUN_BRANCH_INSERT, branch));
2067 case LFUN_KEYMAP_OFF:
2068 getIntl().keyMapOn(false);
2071 case LFUN_KEYMAP_PRIMARY:
2072 getIntl().keyMapPrim();
2075 case LFUN_KEYMAP_SECONDARY:
2076 getIntl().keyMapSec();
2079 case LFUN_KEYMAP_TOGGLE:
2080 getIntl().toggleKeyMap();
2083 case LFUN_DIALOG_SHOW_NEW_INSET: {
2084 string const name = cmd.getArg(0);
2085 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
2086 if (decodeInsetParam(name, data, buffer_))
2087 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
2089 lyxerr << "Inset type '" << name <<
2090 "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" << endl;
2094 case LFUN_CITATION_INSERT: {
2095 if (argument.empty()) {
2096 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
2099 // we can have one optional argument, delimited by '|'
2100 // citation-insert <key>|<text_before>
2101 // this should be enhanced to also support text_after
2102 // and citation style
2103 string arg = argument;
2105 if (contains(argument, "|")) {
2106 arg = token(argument, '|', 0);
2107 opt1 = token(argument, '|', 1);
2110 // if our cursor is directly in front of or behind a citation inset,
2111 // we will instead add the new key to it.
2112 Inset * inset = cur.nextInset();
2113 if (!inset || inset->lyxCode() != CITE_CODE)
2114 inset = cur.prevInset();
2115 if (inset && inset->lyxCode() == CITE_CODE) {
2116 InsetCitation * icite = static_cast<InsetCitation *>(inset);
2117 if (icite->addKey(arg)) {
2118 dr.forceBufferUpdate();
2119 dr.screenUpdate(Update::FitCursor | Update::SinglePar);
2121 LYXERR0("Discarding optional argument to citation-insert.");
2126 InsetCommandParams icp(CITE_CODE);
2127 icp["key"] = from_utf8(arg);
2129 icp["before"] = from_utf8(opt1);
2131 from_ascii(InsetCitation::last_literal ? "true" : "false");
2132 string icstr = InsetCommand::params2string(icp);
2133 FuncRequest fr(LFUN_INSET_INSERT, icstr);
2138 case LFUN_INSET_APPLY: {
2139 string const name = cmd.getArg(0);
2140 Inset * inset = editedInset(name);
2142 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
2146 // put cursor in front of inset.
2147 if (!setCursorFromInset(inset)) {
2148 LASSERT(false, break);
2151 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
2152 inset->dispatch(cur, fr);
2153 dr.screenUpdate(cur.result().screenUpdate());
2154 if (cur.result().needBufferUpdate())
2155 dr.forceBufferUpdate();
2160 // The change of language of buffer belongs to the Buffer class.
2161 // We have to do it here because we need a cursor for Undo.
2162 // When Undo::recordUndoBufferParams() is implemented someday
2163 // LFUN_BUFFER_LANGUAGE should be handled by the Buffer class.
2164 case LFUN_BUFFER_LANGUAGE: {
2165 Language const * oldL = buffer_.params().language;
2166 Language const * newL = languages.getLanguage(argument);
2167 if (!newL || oldL == newL)
2169 if (oldL->rightToLeft() == newL->rightToLeft()) {
2170 cur.recordUndoFullBuffer();
2171 buffer_.changeLanguage(oldL, newL);
2172 cur.setCurrentFont();
2173 dr.forceBufferUpdate();
2178 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
2179 case LFUN_FILE_INSERT_PLAINTEXT: {
2180 bool const as_paragraph = (act == LFUN_FILE_INSERT_PLAINTEXT_PARA);
2181 string const fname = to_utf8(cmd.argument());
2182 if (!FileName::isAbsolute(fname))
2183 dr.setMessage(_("Absolute filename expected."));
2185 insertPlaintextFile(FileName(fname), as_paragraph);
2190 // OK, so try the Buffer itself...
2191 buffer_.dispatch(cmd, dr);
2192 dispatched = dr.dispatched();
2196 buffer_.undo().endUndoGroup();
2197 dr.dispatched(dispatched);
2199 // NOTE: The code below is copied from Cursor::dispatch. If you
2200 // need to modify this, please update the other one too.
2202 // notify insets we just entered/left
2203 if (cursor() != old) {
2204 old.beginUndoGroup();
2206 bool badcursor = notifyCursorLeavesOrEnters(old, cursor());
2208 cursor().fixIfBroken();
2209 resetInlineCompletionPos();
2216 docstring BufferView::requestSelection()
2218 Cursor & cur = d->cursor_;
2220 LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
2221 if (!cur.selection()) {
2222 d->xsel_cache_.set = false;
2226 LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
2227 if (!d->xsel_cache_.set ||
2228 cur.top() != d->xsel_cache_.cursor ||
2229 cur.realAnchor().top() != d->xsel_cache_.anchor)
2231 d->xsel_cache_.cursor = cur.top();
2232 d->xsel_cache_.anchor = cur.realAnchor().top();
2233 d->xsel_cache_.set = cur.selection();
2234 return cur.selectionAsString(false);
2240 void BufferView::clearSelection()
2242 d->cursor_.clearSelection();
2243 // Clear the selection buffer. Otherwise a subsequent
2244 // middle-mouse-button paste would use the selection buffer,
2245 // not the more current external selection.
2246 cap::clearSelection();
2247 d->xsel_cache_.set = false;
2248 // The buffer did not really change, but this causes the
2249 // redraw we need because we cleared the selection above.
2250 buffer_.changed(false);
2254 void BufferView::resize(int width, int height)
2256 // Update from work area
2260 // Clear the paragraph height cache.
2261 d->par_height_.clear();
2262 // Redo the metrics.
2267 Inset const * BufferView::getCoveringInset(Text const & text,
2270 TextMetrics & tm = d->text_metrics_[&text];
2271 Inset * inset = tm.checkInsetHit(x, y);
2275 if (!inset->descendable(*this))
2276 // No need to go further down if the inset is not
2280 size_t cell_number = inset->nargs();
2281 // Check all the inner cell.
2282 for (size_t i = 0; i != cell_number; ++i) {
2283 Text const * inner_text = inset->getText(i);
2286 Inset const * inset_deeper =
2287 getCoveringInset(*inner_text, x, y);
2289 return inset_deeper;
2297 void BufferView::updateHoveredInset() const
2299 // Get inset under mouse, if there is one.
2300 int const x = d->mouse_position_cache_.x_;
2301 int const y = d->mouse_position_cache_.y_;
2302 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
2304 d->clickable_inset_ = covering_inset && covering_inset->clickable(*this, x, y);
2306 if (covering_inset == d->last_inset_)
2307 // Same inset, no need to do anything...
2310 bool need_redraw = false;
2311 if (d->last_inset_) {
2312 // Remove the hint on the last hovered inset (if any).
2313 need_redraw |= d->last_inset_->setMouseHover(this, false);
2314 d->last_inset_ = nullptr;
2317 if (covering_inset && covering_inset->setMouseHover(this, true)) {
2319 // Only the insets that accept the hover state, do
2320 // clear the last_inset_, so only set the last_inset_
2321 // member if the hovered setting is accepted.
2322 d->last_inset_ = covering_inset;
2326 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
2327 << d->mouse_position_cache_.x_ << ", "
2328 << d->mouse_position_cache_.y_ << ")");
2330 d->update_strategy_ = DecorationUpdate;
2332 // This event (moving without mouse click) is not passed further.
2333 // This should be changed if it is further utilized.
2334 buffer_.changed(false);
2339 void BufferView::clearLastInset(Inset * inset) const
2341 if (d->last_inset_ != inset) {
2342 LYXERR0("Wrong last_inset!");
2345 d->last_inset_ = nullptr;
2349 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
2351 //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
2353 // This is only called for mouse related events including
2354 // LFUN_FILE_OPEN generated by drag-and-drop.
2355 FuncRequest cmd = cmd0;
2357 Cursor old = cursor();
2359 cur.push(buffer_.inset());
2360 cur.selection(d->cursor_.selection());
2362 // Either the inset under the cursor or the
2363 // surrounding Text will handle this event.
2365 // make sure we stay within the screen...
2366 cmd.set_y(min(max(cmd.y(), -1), height_));
2368 d->mouse_position_cache_.x_ = cmd.x();
2369 d->mouse_position_cache_.y_ = cmd.y();
2371 if (cmd.action() == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
2372 updateHoveredInset();
2376 // Build temporary cursor.
2377 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x(), cmd.y());
2379 // If inset is not editable, cur.pos() might point behind the
2380 // inset (depending on cmd.x(), cmd.y()). This is needed for
2381 // editing to fix bug 9628, but e.g. the context menu needs a
2382 // cursor in front of the inset.
2383 if ((inset->hasSettings() || !inset->contextMenuName().empty()
2384 || inset->lyxCode() == SEPARATOR_CODE) &&
2385 cur.nextInset() != inset && cur.prevInset() == inset)
2387 } else if (cur.inTexted() && cur.pos()
2388 && cur.paragraph().isEnvSeparator(cur.pos() - 1)) {
2389 // Always place cursor in front of a separator inset.
2393 // Put anchor at the same position.
2396 cur.beginUndoGroup();
2398 // Try to dispatch to an non-editable inset near this position
2399 // via the temp cursor. If the inset wishes to change the real
2400 // cursor it has to do so explicitly by using
2401 // cur.bv().cursor() = cur; (or similar)
2403 inset->dispatch(cur, cmd);
2405 // Now dispatch to the temporary cursor. If the real cursor should
2406 // be modified, the inset's dispatch has to do so explicitly.
2407 if (!inset || !cur.result().dispatched())
2410 // Notify left insets
2412 bool badcursor = old.fixIfBroken() | cur.fixIfBroken();
2413 badcursor |= notifyCursorLeavesOrEnters(old, cur);
2415 cursor().fixIfBroken();
2420 // Do we have a selection?
2421 theSelection().haveSelection(cursor().selection());
2423 if (cur.needBufferUpdate()) {
2424 cur.clearBufferUpdate();
2425 buffer().updateBuffer();
2428 // If the command has been dispatched,
2429 if (cur.result().dispatched() || cur.result().screenUpdate())
2430 processUpdateFlags(cur.result().screenUpdate());
2434 int BufferView::minVisiblePart()
2436 return 2 * defaultRowHeight();
2440 int BufferView::scroll(int pixels)
2443 return scrollDown(pixels);
2445 return scrollUp(-pixels);
2450 int BufferView::scrollDown(int pixels)
2452 Text * text = &buffer_.text();
2453 TextMetrics & tm = d->text_metrics_[text];
2454 int const ymax = height_ + pixels;
2456 pair<pit_type, ParagraphMetrics const *> last = tm.last();
2457 int bottom_pos = last.second->position() + last.second->descent();
2458 if (lyxrc.scroll_below_document)
2459 bottom_pos += height_ - minVisiblePart();
2460 if (last.first + 1 == int(text->paragraphs().size())) {
2461 if (bottom_pos <= height_)
2463 pixels = min(pixels, bottom_pos - height_);
2466 if (bottom_pos > ymax)
2468 tm.newParMetricsDown();
2470 d->anchor_ypos_ -= pixels;
2475 int BufferView::scrollUp(int pixels)
2477 Text * text = &buffer_.text();
2478 TextMetrics & tm = d->text_metrics_[text];
2479 int ymin = - pixels;
2481 pair<pit_type, ParagraphMetrics const *> first = tm.first();
2482 int top_pos = first.second->position() - first.second->ascent();
2483 if (first.first == 0) {
2486 pixels = min(pixels, - top_pos);
2491 tm.newParMetricsUp();
2493 d->anchor_ypos_ += pixels;
2498 bool BufferView::setCursorFromRow(int row)
2500 TexRow::TextEntry start, end;
2501 tie(start,end) = buffer_.texrow().getEntriesFromRow(row);
2502 LYXERR(Debug::LATEX,
2503 "setCursorFromRow: for row " << row << ", TexRow has found "
2504 "start (id=" << start.id << ",pos=" << start.pos << "), "
2505 "end (id=" << end.id << ",pos=" << end.pos << ")");
2506 return setCursorFromEntries(start, end);
2510 bool BufferView::setCursorFromEntries(TexRow::TextEntry start,
2511 TexRow::TextEntry end)
2513 DocIterator dit_start, dit_end;
2514 tie(dit_start,dit_end) =
2515 TexRow::getDocIteratorsFromEntries(start, end, buffer_);
2518 // Setting selection start
2519 d->cursor_.clearSelection();
2520 setCursor(dit_start);
2521 // Setting selection end
2523 d->cursor_.resetAnchor();
2524 setCursorSelectionTo(dit_end);
2530 bool BufferView::setCursorFromInset(Inset const * inset)
2532 // are we already there?
2533 if (cursor().nextInset() == inset)
2536 // Inset is not at cursor position. Find it in the document.
2539 while (cur && cur.nextInset() != inset)
2550 void BufferView::gotoLabel(docstring const & label)
2553 bool have_inactive = false;
2554 for (Buffer const * buf : buffer().allRelatives()) {
2556 for (TocItem const & item : *buf->tocBackend().toc("label")) {
2557 if (label == item.str() && item.isOutput()) {
2558 lyx::dispatch(item.action());
2561 // If we find an inactive label, save it for the case
2562 // that no active one is there
2563 if (label == item.str() && !have_inactive) {
2564 have_inactive = true;
2565 action = item.action();
2569 // We only found an inactive label. Go there.
2571 lyx::dispatch(action);
2575 TextMetrics const & BufferView::textMetrics(Text const * t) const
2577 return const_cast<BufferView *>(this)->textMetrics(t);
2581 TextMetrics & BufferView::textMetrics(Text const * t)
2584 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
2585 if (tmc_it == d->text_metrics_.end()) {
2586 tmc_it = d->text_metrics_.emplace(std::piecewise_construct,
2587 std::forward_as_tuple(t),
2588 std::forward_as_tuple(this, const_cast<Text *>(t))).first;
2590 return tmc_it->second;
2594 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
2597 return textMetrics(t).parMetrics(pit);
2601 int BufferView::workHeight() const
2607 void BufferView::setCursor(DocIterator const & dit)
2610 size_t const n = dit.depth();
2611 for (size_t i = 0; i < n; ++i)
2612 dit[i].inset().edit(d->cursor_, true);
2614 d->cursor_.setCursor(dit);
2615 d->cursor_.selection(false);
2616 d->cursor_.setCurrentFont();
2618 // It seems on general grounds as if this is probably needed, but
2619 // it is not yet clear.
2620 // See bug #7394 and r38388.
2621 // d->cursor.resetAnchor();
2625 void BufferView::setCursorSelectionTo(DocIterator const & dit)
2627 size_t const n = dit.depth();
2628 for (size_t i = 0; i < n; ++i)
2629 dit[i].inset().edit(d->cursor_, true);
2631 d->cursor_.selection(true);
2632 d->cursor_.setCursorSelectionTo(dit);
2633 d->cursor_.setCurrentFont();
2637 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
2639 // Would be wrong to delete anything if we have a selection.
2640 if (cur.selection())
2643 bool need_anchor_change = false;
2644 bool changed = Text::deleteEmptyParagraphMechanism(cur, old,
2645 need_anchor_change);
2647 if (need_anchor_change)
2655 // we would rather not do this here, but it needs to be done before
2656 // the changed() signal is sent.
2657 buffer_.updateBuffer();
2659 buffer_.changed(true);
2664 bool BufferView::mouseSetCursor(Cursor & cur, bool const select)
2666 LASSERT(&cur.bv() == this, return false);
2669 // this event will clear selection so we save selection for
2670 // persistent selection
2671 cap::saveSelection(cursor());
2673 d->cursor_.macroModeClose();
2674 // If a macro has been finalized, the cursor might have been broken
2677 // Has the cursor just left the inset?
2678 bool const leftinset = (&d->cursor_.inset() != &cur.inset());
2680 d->cursor_.fixIfBroken();
2682 // do the dEPM magic if needed
2683 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
2684 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
2685 // the leftinset bool would not be necessary (badcursor instead).
2686 bool update = leftinset;
2689 d->cursor_.setSelection();
2690 d->cursor_.setCursorSelectionTo(cur);
2692 if (d->cursor_.inTexted())
2693 update |= checkDepm(cur, d->cursor_);
2694 d->cursor_.resetAnchor();
2695 d->cursor_.setCursor(cur);
2696 d->cursor_.clearSelection();
2698 d->cursor_.boundary(cur.boundary());
2699 d->cursor_.finishUndo();
2700 d->cursor_.setCurrentFont();
2702 cur.forceBufferUpdate();
2707 void BufferView::putSelectionAt(DocIterator const & cur,
2708 int length, bool backwards)
2710 d->cursor_.clearSelection();
2716 d->cursor_.pos() += length;
2717 d->cursor_.setSelection(d->cursor_, -length);
2719 d->cursor_.setSelection(d->cursor_, length);
2724 bool BufferView::selectIfEmpty(DocIterator & cur)
2726 if ((cur.inTexted() && !cur.paragraph().empty())
2727 || (cur.inMathed() && !cur.cell().empty()))
2730 pit_type const beg_pit = cur.pit();
2732 // The paragraph associated to this item isn't
2733 // the first one, so it can be selected
2736 // We have to resort to select the space between the
2737 // end of this item and the begin of the next one
2741 // If it is the only item in the document,
2742 // nothing can be selected
2745 pit_type const end_pit = cur.pit();
2746 pos_type const end_pos = cur.pos();
2747 d->cursor_.clearSelection();
2749 d->cursor_.setCursor(cur);
2750 d->cursor_.pit() = beg_pit;
2751 d->cursor_.pos() = 0;
2752 d->cursor_.selection(false);
2753 d->cursor_.resetAnchor();
2754 d->cursor_.pit() = end_pit;
2755 d->cursor_.pos() = end_pos;
2756 d->cursor_.setSelection();
2761 Cursor & BufferView::cursor()
2767 Cursor const & BufferView::cursor() const
2773 bool BufferView::singleParUpdate()
2775 Text & buftext = buffer_.text();
2776 pit_type const bottom_pit = d->cursor_.bottom().pit();
2777 TextMetrics & tm = textMetrics(&buftext);
2778 Dimension const old_dim = tm.parMetrics(bottom_pit).dim();
2780 // make sure inline completion pointer is ok
2781 if (d->inlineCompletionPos_.fixIfBroken())
2782 d->inlineCompletionPos_ = DocIterator();
2784 // In Single Paragraph mode, rebreak only
2785 // the (main text, not inset!) paragraph containing the cursor.
2786 // (if this paragraph contains insets etc., rebreaking will
2787 // recursively descend)
2788 tm.redoParagraph(bottom_pit);
2789 ParagraphMetrics & pm = tm.parMetrics(bottom_pit);
2790 if (pm.height() != old_dim.height()) {
2791 // Paragraph height has changed so we cannot proceed to
2792 // the singlePar optimisation.
2795 // Since position() points to the baseline of the first row, we
2796 // may have to update it. See ticket #11601 for an example where
2797 // the height does not change but the ascent does.
2798 pm.setPosition(pm.position() - old_dim.ascent() + pm.ascent());
2800 tm.updatePosCache(bottom_pit);
2802 LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
2803 << " y2: " << pm.position() + pm.descent()
2804 << " pit: " << bottom_pit
2805 << " singlepar: 1");
2810 void BufferView::updateMetrics()
2812 updateMetrics(d->update_flags_);
2813 d->update_strategy_ = FullScreenUpdate;
2817 void BufferView::updateMetrics(Update::flags & update_flags)
2819 if (height_ == 0 || width_ == 0)
2822 Text & buftext = buffer_.text();
2823 pit_type const npit = int(buftext.paragraphs().size());
2825 // Clear out the position cache in case of full screen redraw,
2826 d->coord_cache_.clear();
2827 d->math_rows_.clear();
2829 // Clear out paragraph metrics to avoid having invalid metrics
2830 // in the cache from paragraphs not relayouted below
2831 // The complete text metrics will be redone.
2832 d->text_metrics_.clear();
2834 TextMetrics & tm = textMetrics(&buftext);
2836 // make sure inline completion pointer is ok
2837 if (d->inlineCompletionPos_.fixIfBroken())
2838 d->inlineCompletionPos_ = DocIterator();
2840 if (d->anchor_pit_ >= npit)
2841 // The anchor pit must have been deleted...
2842 d->anchor_pit_ = npit - 1;
2844 // Rebreak anchor paragraph.
2845 tm.redoParagraph(d->anchor_pit_);
2846 ParagraphMetrics & anchor_pm = tm.parMetrics(d->anchor_pit_);
2849 if (d->anchor_pit_ == 0) {
2850 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
2852 // Complete buffer visible? Then it's easy.
2853 if (scrollRange == 0)
2854 d->anchor_ypos_ = anchor_pm.ascent();
2856 // avoid empty space above the first row
2857 d->anchor_ypos_ = min(d->anchor_ypos_, anchor_pm.ascent());
2860 anchor_pm.setPosition(d->anchor_ypos_);
2861 tm.updatePosCache(d->anchor_pit_);
2863 LYXERR(Debug::PAINTING, "metrics: "
2864 << " anchor pit = " << d->anchor_pit_
2865 << " anchor ypos = " << d->anchor_ypos_);
2867 // Redo paragraphs above anchor if necessary.
2868 int y1 = d->anchor_ypos_ - anchor_pm.ascent();
2869 // We are now just above the anchor paragraph.
2870 pit_type pit1 = d->anchor_pit_ - 1;
2871 for (; pit1 >= 0 && y1 >= 0; --pit1) {
2872 tm.redoParagraph(pit1);
2873 ParagraphMetrics & pm = tm.parMetrics(pit1);
2875 // Save the paragraph position in the cache.
2877 tm.updatePosCache(pit1);
2881 // Redo paragraphs below the anchor if necessary.
2882 int y2 = d->anchor_ypos_ + anchor_pm.descent();
2883 // We are now just below the anchor paragraph.
2884 pit_type pit2 = d->anchor_pit_ + 1;
2885 for (; pit2 < npit && y2 <= height_; ++pit2) {
2886 tm.redoParagraph(pit2);
2887 ParagraphMetrics & pm = tm.parMetrics(pit2);
2889 // Save the paragraph position in the cache.
2891 tm.updatePosCache(pit2);
2895 LYXERR(Debug::PAINTING, "Metrics: "
2896 << " anchor pit = " << d->anchor_pit_
2897 << " anchor ypos = " << d->anchor_ypos_
2900 << " pit1 = " << pit1
2901 << " pit2 = " << pit2);
2903 // metrics is done, full drawing is necessary now
2904 update_flags = (update_flags & ~Update::Force) | Update::ForceDraw;
2906 // Now update the positions of insets in the cache.
2909 if (lyxerr.debugging(Debug::WORKAREA)) {
2910 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
2911 d->coord_cache_.dump();
2916 void BufferView::updatePosCache()
2918 // this is the "nodraw" drawing stage: only set the positions of the
2919 // insets in metrics cache.
2920 frontend::NullPainter np;
2925 void BufferView::insertLyXFile(FileName const & fname, bool const ignorelang)
2927 LASSERT(d->cursor_.inTexted(), return);
2929 // Get absolute path of file and add ".lyx"
2930 // to the filename if necessary
2931 FileName filename = fileSearch(string(), fname.absFileName(), "lyx");
2933 docstring const disp_fn = makeDisplayPath(filename.absFileName());
2934 // emit message signal.
2935 message(bformat(_("Inserting document %1$s..."), disp_fn));
2938 Buffer buf(filename.absFileName(), false);
2939 if (buf.loadLyXFile() == Buffer::ReadSuccess) {
2940 ErrorList & el = buffer_.errorList("Parse");
2941 // Copy the inserted document error list into the current buffer one.
2942 el = buf.errorList("Parse");
2943 ParagraphList & pars = buf.paragraphs();
2945 // set main language of imported file to context language
2946 buf.changeLanguage(buf.language(), d->cursor_.getFont().language());
2947 buffer_.undo().recordUndo(d->cursor_);
2948 cap::pasteParagraphList(d->cursor_, pars,
2949 buf.params().documentClassPtr(), el);
2950 res = _("Document %1$s inserted.");
2952 res = _("Could not insert document %1$s");
2955 buffer_.changed(true);
2956 // emit message signal.
2957 message(bformat(res, disp_fn));
2961 Point BufferView::coordOffset(DocIterator const & dit) const
2967 // Addup contribution of nested insets, from inside to outside,
2968 // keeping the outer paragraph for a special handling below
2969 for (size_t i = dit.depth() - 1; i >= 1; --i) {
2970 CursorSlice const & sl = dit[i];
2974 // get relative position inside sl.inset()
2975 sl.inset().cursorPos(*this, sl, dit.boundary() && (i + 1 == dit.depth()), xx, yy);
2977 // Make relative position inside of the edited inset relative to sl.inset()
2981 // In case of an RTL inset, the edited inset will be positioned to the left
2984 bool boundary_i = dit.boundary() && i + 1 == dit.depth();
2985 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2990 // remember width for the case that sl.inset() is positioned in an RTL inset
2991 lastw = sl.inset().dimension(*this).wid;
2993 //lyxerr << "Cursor::getPos, i: "
2994 // << i << " x: " << xx << " y: " << y << endl;
2997 // Add contribution of initial rows of outermost paragraph
2998 CursorSlice const & sl = dit[0];
2999 TextMetrics const & tm = textMetrics(sl.text());
3000 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
3002 LBUFERR(!pm.rows().empty());
3003 y -= pm.rows()[0].ascent();
3005 // FIXME: document this mess
3007 if (sl.pos() > 0 && dit.depth() == 1) {
3009 if (pos && dit.boundary())
3011 // lyxerr << "coordOffset: boundary:" << dit.boundary() << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
3012 rend = pm.pos2row(pos);
3014 rend = pm.pos2row(sl.pos());
3016 size_t rend = pm.pos2row(sl.pos());
3018 for (size_t rit = 0; rit != rend; ++rit)
3019 y += pm.rows()[rit].height();
3020 y += pm.rows()[rend].ascent();
3022 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
3024 // Make relative position from the nested inset now bufferview absolute.
3025 int xx = bottom_tm.cursorX(dit.bottom(), dit.boundary() && dit.depth() == 1);
3028 // In the RTL case place the nested inset at the left of the cursor in
3029 // the outer paragraph
3030 bool boundary_1 = dit.boundary() && 1 == dit.depth();
3031 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
3039 Point BufferView::getPos(DocIterator const & dit) const
3041 if (!paragraphVisible(dit))
3042 return Point(-1, -1);
3044 CursorSlice const & bot = dit.bottom();
3045 TextMetrics const & tm = textMetrics(bot.text());
3047 // offset from outer paragraph
3048 Point p = coordOffset(dit);
3049 p.y_ += tm.parMetrics(bot.pit()).position();
3054 bool BufferView::paragraphVisible(DocIterator const & dit) const
3056 CursorSlice const & bot = dit.bottom();
3057 TextMetrics const & tm = textMetrics(bot.text());
3059 return tm.contains(bot.pit());
3063 void BufferView::caretPosAndDim(Point & p, Dimension & dim) const
3065 Cursor const & cur = cursor();
3066 if (cur.inMathed()) {
3067 MathRow const & mrow = mathRow(&cur.cell());
3068 dim = mrow.caret_dim;
3070 Font const font = cur.real_current_font;
3071 frontend::FontMetrics const & fm = theFontMetrics(font);
3072 dim.wid = fm.lineWidth();
3073 dim.asc = fm.maxAscent();
3074 dim.des = fm.maxDescent();
3076 if (lyxrc.cursor_width > 0)
3077 dim.wid = lyxrc.cursor_width;
3080 // center fat carets horizontally
3081 p.x_ -= dim.wid / 2;
3087 void BufferView::buildCaretGeometry(bool complet)
3091 caretPosAndDim(p, dim);
3093 Cursor const & cur = d->cursor_;
3094 Font const & realfont = cur.real_current_font;
3095 frontend::FontMetrics const & fm = theFontMetrics(realfont.fontInfo());
3096 bool const isrtl = realfont.isVisibleRightToLeft();
3097 int const dir = isrtl ? -1 : 1;
3099 frontend::CaretGeometry & cg = d->caret_geometry_;
3102 // The caret itself, slanted for italics in text edit mode except
3103 // for selections because the selection rect does not slant
3104 bool const slant = fm.italic() && cur.inTexted() && !cur.selection();
3105 double const slope = slant ? fm.italicSlope() : 0;
3106 cg.shapes.push_back(
3107 {{iround(p.x_ + dim.asc * slope), p.y_},
3108 {iround(p.x_ - dim.des * slope), p.y_ + dim.height()},
3109 {iround(p.x_ + dir * dim.wid - dim.des * slope), p.y_ + dim.height()},
3110 {iround(p.x_ + dir * dim.wid + dim.asc * slope), p.y_}}
3113 // The language indicator _| (if needed)
3114 Language const * doclang = buffer().params().language;
3115 if (!((realfont.language() == doclang && isrtl == doclang->rightToLeft())
3116 || realfont.language() == latex_language)) {
3117 int const lx = dim.height() / 3;
3118 int const xx = iround(p.x_ - dim.des * slope);
3119 int const yy = p.y_ + dim.height();
3120 cg.shapes.push_back(
3121 {{xx, yy - dim.wid},
3122 {xx + dir * (dim.wid + lx - 1), yy - dim.wid},
3123 {xx + dir * (dim.wid + lx - 1), yy},
3128 // The completion triangle |> (if needed)
3130 int const m = p.y_ + dim.height() / 2;
3131 int const d = dim.height() / 8;
3132 // offset for slanted carret
3133 int const sx = iround((dim.asc - (dim.height() / 2 - d)) * slope);
3134 // starting position x
3135 int const xx = p.x_ + dir * dim.wid + sx;
3136 cg.shapes.push_back(
3140 {xx, m + d - dim.wid},
3141 {xx + dir * d - dim.wid, m},
3142 {xx, m - d + dim.wid}}
3146 // compute extremal x values
3148 cg.right = -1000000;
3150 cg.bottom = -1000000;
3151 for (auto const & shape : cg.shapes)
3152 for (Point const & p : shape) {
3153 cg.left = min(cg.left, p.x_);
3154 cg.right = max(cg.right, p.x_);
3155 cg.top = min(cg.top, p.y_);
3156 cg.bottom = max(cg.bottom, p.y_);
3161 frontend::CaretGeometry const & BufferView::caretGeometry() const
3163 return d->caret_geometry_;
3167 bool BufferView::caretInView() const
3169 if (!paragraphVisible(cursor()))
3173 caretPosAndDim(p, dim);
3175 // does the cursor touch the screen ?
3176 if (p.y_ + dim.height() < 0 || p.y_ >= workHeight())
3182 int BufferView::horizScrollOffset() const
3184 return d->horiz_scroll_offset_;
3188 int BufferView::horizScrollOffset(Text const * text,
3189 pit_type pit, pos_type pos) const
3191 // Is this a row that is currently scrolled?
3192 if (!d->current_row_slice_.empty()
3193 && &text->inset() == d->current_row_slice_.inset().asInsetText()
3194 && pit == d->current_row_slice_.pit()
3195 && pos == d->current_row_slice_.pos())
3196 return d->horiz_scroll_offset_;
3201 void BufferView::setCurrentRowSlice(CursorSlice const & rowSlice)
3203 // nothing to do if the cursor was already on this row
3204 if (d->current_row_slice_ == rowSlice)
3207 // if the (previous) current row was scrolled, we have to
3208 // remember it in order to repaint it next time.
3209 if (d->horiz_scroll_offset_ != 0) {
3210 // search the old row in cache and mark it changed
3211 for (auto & tm_pair : d->text_metrics_) {
3212 if (&tm_pair.first->inset() == rowSlice.inset().asInsetText()) {
3213 tm_pair.second.setRowChanged(rowSlice.pit(), rowSlice.pos());
3214 // We found it, no need to continue.
3220 // Since we changed row, the scroll offset is not valid anymore
3221 d->horiz_scroll_offset_ = 0;
3222 d->current_row_slice_ = rowSlice;
3226 void BufferView::checkCursorScrollOffset()
3228 CursorSlice rowSlice = d->cursor_.bottom();
3229 TextMetrics const & tm = textMetrics(rowSlice.text());
3231 // Stop if metrics have not been computed yet, since it means
3232 // that there is nothing to do.
3233 if (!tm.contains(rowSlice.pit()))
3235 ParagraphMetrics const & pm = tm.parMetrics(rowSlice.pit());
3236 Row const & row = pm.getRow(rowSlice.pos(),
3237 d->cursor_.boundary() && rowSlice == d->cursor_.top());
3238 rowSlice.pos() = row.pos();
3240 // Set the row on which the cursor lives.
3241 setCurrentRowSlice(rowSlice);
3243 // Current x position of the cursor in pixels
3244 int cur_x = getPos(d->cursor_).x_;
3246 // Horizontal scroll offset of the cursor row in pixels
3247 int offset = d->horiz_scroll_offset_;
3248 int const MARGIN = 2 * theFontMetrics(d->cursor_.real_current_font).em()
3250 if (row.right_x() <= workWidth() - row.right_margin) {
3251 // Row is narrower than the work area, no offset needed.
3254 if (cur_x - offset < MARGIN) {
3255 // cursor would be too far right
3256 offset = cur_x - MARGIN;
3257 } else if (cur_x - offset > workWidth() - MARGIN) {
3258 // cursor would be too far left
3259 offset = cur_x - workWidth() + MARGIN;
3261 // Correct the offset to make sure that we do not scroll too much
3264 if (row.right_x() - offset < workWidth() - row.right_margin)
3265 offset = row.right_x() - workWidth() + row.right_margin;
3268 //lyxerr << "cur_x=" << cur_x << ", offset=" << offset << ", row.wid=" << row.width() << ", margin=" << MARGIN << endl;
3270 if (offset != d->horiz_scroll_offset_)
3271 LYXERR(Debug::PAINTING, "Horiz. scroll offset changed from "
3272 << d->horiz_scroll_offset_ << " to " << offset);
3274 if (d->update_strategy_ == NoScreenUpdate
3275 && offset != d->horiz_scroll_offset_) {
3276 // FIXME: if one uses SingleParUpdate, then home/end
3277 // will not work on long rows. Why?
3278 d->update_strategy_ = FullScreenUpdate;
3281 d->horiz_scroll_offset_ = offset;
3285 void BufferView::draw(frontend::Painter & pain, bool paint_caret)
3287 if (height_ == 0 || width_ == 0)
3289 LYXERR(Debug::PAINTING, (pain.isNull() ? "\t\t--- START NODRAW ---"
3290 : "\t\t*** START DRAWING ***"));
3291 Text & text = buffer_.text();
3292 TextMetrics const & tm = d->text_metrics_[&text];
3293 int const y = tm.first().second->position();
3294 PainterInfo pi(this, pain);
3296 // Check whether the row where the cursor lives needs to be scrolled.
3297 // Update the drawing strategy if needed.
3298 checkCursorScrollOffset();
3300 switch (d->update_strategy_) {
3302 case NoScreenUpdate:
3303 // no screen painting is actually needed. In nodraw stage
3304 // however, the different coordinates of insets and paragraphs
3305 // needs to be updated.
3306 LYXERR(Debug::PAINTING, "Strategy: NoScreenUpdate");
3307 if (pain.isNull()) {
3308 pi.full_repaint = true;
3311 pi.full_repaint = false;
3316 case SingleParUpdate:
3317 pi.full_repaint = false;
3318 LYXERR(Debug::PAINTING, "Strategy: SingleParUpdate");
3319 // In general, only the current row of the outermost paragraph
3320 // will be redrawn. Particular cases where selection spans
3321 // multiple paragraph are correctly detected in TextMetrics.
3325 case DecorationUpdate:
3326 // FIXME: We should also distinguish DecorationUpdate to avoid text
3327 // drawing if possible. This is not possible to do easily right now
3328 // because of the single backing pixmap.
3330 case FullScreenUpdate:
3332 LYXERR(Debug::PAINTING,
3333 ((d->update_strategy_ == FullScreenUpdate)
3334 ? "Strategy: FullScreenUpdate"
3335 : "Strategy: DecorationUpdate"));
3337 // The whole screen, including insets, will be refreshed.
3338 pi.full_repaint = true;
3340 // Clear background.
3341 pain.fillRectangle(0, 0, width_, height_,
3342 pi.backgroundColor(&buffer_.inset()));
3347 // and possibly grey out below
3348 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3349 int const y2 = lastpm.second->position() + lastpm.second->descent();
3352 Color color = buffer().isInternal()
3353 ? Color_background : Color_bottomarea;
3354 pain.fillRectangle(0, y2, width_, height_ - y2, color);
3358 LYXERR(Debug::PAINTING, (pain.isNull() ? "\t\t --- END NODRAW ---"
3359 : "\t\t *** END DRAWING ***"));
3361 // The scrollbar needs an update.
3362 // FIXME: does it always? see ticket #11947.
3365 // Normalize anchor for next time
3366 pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
3367 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3368 for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
3369 ParagraphMetrics const & pm = tm.parMetrics(pit);
3370 if (pm.position() + pm.descent() > 0) {
3371 if (d->anchor_pit_ != pit
3372 || d->anchor_ypos_ != pm.position())
3373 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
3374 << " anchor ypos = " << d->anchor_ypos_);
3375 d->anchor_pit_ = pit;
3376 d->anchor_ypos_ = pm.position();
3380 if (!pain.isNull()) {
3381 // reset the update flags, everything has been done
3382 d->update_flags_ = Update::None;
3385 // If a caret has to be painted, mark its text row as dirty to
3386 //make sure that it will be repainted on next redraw.
3387 /* FIXME: investigate whether this can be avoided when the cursor did not
3391 Cursor cur(d->cursor_);
3392 while (cur.depth() > 1) {
3393 if (!cur.inTexted())
3395 TextMetrics const & tm = textMetrics(cur.text());
3396 if (d->caret_geometry_.left >= tm.origin().x_
3397 && d->caret_geometry_.right <= tm.origin().x_ + tm.dim().width())
3401 cur.textRow().changed(true);
3406 void BufferView::message(docstring const & msg)
3409 d->gui_->message(msg);
3413 void BufferView::showDialog(string const & name)
3416 d->gui_->showDialog(name, string());
3420 void BufferView::showDialog(string const & name,
3421 string const & data, Inset * inset)
3424 d->gui_->showDialog(name, data, inset);
3428 void BufferView::updateDialog(string const & name, string const & data)
3431 d->gui_->updateDialog(name, data);
3435 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
3441 // FIXME: Move this out of BufferView again
3442 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
3444 if (!fname.isReadableFile()) {
3445 docstring const error = from_ascii(strerror(errno));
3446 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3447 docstring const text =
3448 bformat(_("Could not read the specified document\n"
3449 "%1$s\ndue to the error: %2$s"), file, error);
3450 Alert::error(_("Could not read file"), text);
3454 if (!fname.isReadableFile()) {
3455 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3456 docstring const text =
3457 bformat(_("%1$s\n is not readable."), file);
3458 Alert::error(_("Could not open file"), text);
3462 // FIXME UNICODE: We don't know the encoding of the file
3463 docstring file_content = fname.fileContents("UTF-8");
3464 if (file_content.empty()) {
3465 Alert::error(_("Reading not UTF-8 encoded file"),
3466 _("The file is not UTF-8 encoded.\n"
3467 "It will be read as local 8Bit-encoded.\n"
3468 "If this does not give the correct result\n"
3469 "then please change the encoding of the file\n"
3470 "to UTF-8 with a program other than LyX.\n"));
3471 file_content = fname.fileContents("local8bit");
3474 return normalize_c(file_content);
3478 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
3480 docstring const tmpstr = contentsOfPlaintextFile(f);
3485 Cursor & cur = cursor();
3486 cap::replaceSelection(cur);
3487 buffer_.undo().recordUndo(cur);
3489 cur.innerText()->insertStringAsParagraphs(cur, tmpstr, cur.current_font);
3491 cur.innerText()->insertStringAsLines(cur, tmpstr, cur.current_font);
3493 buffer_.changed(true);
3497 docstring const & BufferView::inlineCompletion() const
3499 return d->inlineCompletion_;
3503 size_t BufferView::inlineCompletionUniqueChars() const
3505 return d->inlineCompletionUniqueChars_;
3509 DocIterator const & BufferView::inlineCompletionPos() const
3511 return d->inlineCompletionPos_;
3515 void BufferView::resetInlineCompletionPos()
3517 d->inlineCompletionPos_ = DocIterator();
3521 bool samePar(DocIterator const & a, DocIterator const & b)
3523 if (a.empty() && b.empty())
3525 if (a.empty() || b.empty())
3527 if (a.depth() != b.depth())
3529 return &a.innerParagraph() == &b.innerParagraph();
3533 void BufferView::setInlineCompletion(Cursor const & cur, DocIterator const & pos,
3534 docstring const & completion, size_t uniqueChars)
3536 uniqueChars = min(completion.size(), uniqueChars);
3537 bool changed = d->inlineCompletion_ != completion
3538 || d->inlineCompletionUniqueChars_ != uniqueChars;
3539 bool singlePar = true;
3540 d->inlineCompletion_ = completion;
3541 d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
3543 //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
3546 DocIterator const & old = d->inlineCompletionPos_;
3548 //lyxerr << "inlineCompletionPos changed" << std::endl;
3549 // old or pos are in another paragraph?
3550 if ((!samePar(cur, pos) && !pos.empty())
3551 || (!samePar(cur, old) && !old.empty())) {
3553 //lyxerr << "different paragraph" << std::endl;
3555 d->inlineCompletionPos_ = pos;
3560 if (singlePar && !(cur.result().screenUpdate() & Update::Force))
3561 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
3563 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::Force);
3568 bool BufferView::clickableInset() const
3570 return d->clickable_inset_;