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 // tentatively save bookmark, id and pos will be used to
800 // acturately locate a bookmark in a 'live' lyx session.
801 // pit and pos will be updated with bottom level pit/pos
803 if (!buffer_.isInternal()) {
804 theSession().bookmarks().save(
806 d->cursor_.bottom().pit(),
807 d->cursor_.bottom().pos(),
808 d->cursor_.paragraph().id(),
813 // emit message signal.
814 message(_("Save bookmark"));
819 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
820 int top_id, pos_type top_pos)
822 bool success = false;
825 d->cursor_.clearSelection();
827 // if a valid par_id is given, try it first
828 // This is the case for a 'live' bookmark when unique paragraph ID
829 // is used to track bookmarks.
831 dit = buffer_.getParFromID(top_id);
833 dit.pos() = min(dit.paragraph().size(), top_pos);
834 // Some slices of the iterator may not be
835 // reachable (e.g. closed collapsible inset)
836 // so the dociterator may need to be
837 // shortened. Otherwise, setCursor may crash
838 // lyx when the cursor can not be set to these
840 size_t const n = dit.depth();
841 for (size_t i = 0; i < n; ++i)
842 if (!dit[i].inset().editable()) {
850 // if top_id == 0, or searching through top_id failed
851 // This is the case for a 'restored' bookmark when only bottom
852 // (document level) pit was saved. Because of this, bookmark
853 // restoration is inaccurate. If a bookmark was within an inset,
854 // it will be restored to the left of the outmost inset that contains
856 if (bottom_pit < int(buffer_.paragraphs().size())) {
857 dit = doc_iterator_begin(&buffer_);
859 dit.pit() = bottom_pit;
860 dit.pos() = min(bottom_pos, dit.paragraph().size());
865 // Note: only bottom (document) level pit is set.
867 // set the current font.
868 d->cursor_.setCurrentFont();
869 // Do not forget to reset the anchor (see #9912)
870 d->cursor_.resetAnchor();
871 processUpdateFlags(Update::Force | Update::FitCursor);
878 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
880 if (d->cursor_.real_current_font.isRightToLeft()) {
881 if (d->intl_.keymap == Intl::PRIMARY)
882 d->intl_.keyMapSec();
884 if (d->intl_.keymap == Intl::SECONDARY)
885 d->intl_.keyMapPrim();
888 d->intl_.getTransManager().translateAndInsert(c, t, cur);
892 int BufferView::workWidth() const
898 void BufferView::recenter()
900 showCursor(d->cursor_, true, true);
904 void BufferView::showCursor()
906 showCursor(d->cursor_, false, true);
910 void BufferView::showCursor(DocIterator const & dit,
911 bool recenter, bool update)
913 if (scrollToCursor(dit, recenter) && update)
914 processUpdateFlags(Update::Force);
918 void BufferView::scrollToCursor()
920 if (scrollToCursor(d->cursor_, false))
921 processUpdateFlags(Update::Force);
925 bool BufferView::scrollToCursor(DocIterator const & dit, bool const recenter)
927 // We are not properly started yet, delay until resizing is
933 LYXERR(Debug::SCROLLING, "recentering and scrolling to cursor");
935 LYXERR(Debug::SCROLLING, "scrolling to cursor");
937 CursorSlice const & bot = dit.bottom();
938 TextMetrics & tm = d->text_metrics_[bot.text()];
940 pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
941 pos_type bot_pit = bot.pit();
942 if (bot_pit > max_pit) {
943 // FIXME: Why does this happen?
944 LYXERR0("bottom pit is greater that max pit: "
945 << bot_pit << " > " << max_pit);
949 if (bot_pit == tm.first().first - 1)
950 tm.newParMetricsUp();
951 else if (bot_pit == tm.last().first + 1)
952 tm.newParMetricsDown();
954 if (tm.contains(bot_pit)) {
955 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
956 LBUFERR(!pm.rows().empty());
957 // FIXME: smooth scrolling doesn't work in mathed.
958 CursorSlice const & cs = dit.innerTextSlice();
959 int offset = coordOffset(dit).y_;
960 int ypos = pm.position() + offset;
961 Dimension const & row_dim =
962 pm.getRow(cs.pos(), dit.boundary()).dim();
965 scrolled = scroll(ypos - height_/2);
967 // We try to visualize the whole row, if the row height is larger than
968 // the screen height, we scroll to a heuristic value of height_ / 4.
969 // FIXME: This heuristic value should be replaced by a recursive search
970 // for a row in the inset that can be visualized completely.
971 else if (row_dim.height() > height_) {
972 if (ypos < defaultRowHeight())
973 scrolled = scroll(ypos - height_ / 4);
974 else if (ypos > height_ - defaultRowHeight())
975 scrolled = scroll(ypos - 3 * height_ / 4);
978 // If the top part of the row falls of the screen, we scroll
979 // up to align the top of the row with the top of the screen.
980 else if (ypos - row_dim.ascent() < 0 && ypos < height_) {
981 int ynew = row_dim.ascent();
982 scrolled = scrollUp(ynew - ypos);
985 // If the bottom of the row falls of the screen, we scroll down.
986 else if (ypos + row_dim.descent() > height_ && ypos > 0) {
987 int ynew = height_ - row_dim.descent();
988 scrolled = scrollDown(ypos - ynew);
991 // else, nothing to do, the cursor is already visible so we just return.
992 return scrolled != 0;
995 // fix inline completion position
996 if (d->inlineCompletionPos_.fixIfBroken())
997 d->inlineCompletionPos_ = DocIterator();
999 tm.redoParagraph(bot_pit);
1000 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
1001 int offset = coordOffset(dit).y_;
1003 d->anchor_pit_ = bot_pit;
1004 CursorSlice const & cs = dit.innerTextSlice();
1005 Dimension const & row_dim =
1006 pm.getRow(cs.pos(), dit.boundary()).dim();
1009 d->anchor_ypos_ = height_/2;
1010 else if (d->anchor_pit_ == 0)
1011 d->anchor_ypos_ = offset + pm.ascent();
1012 else if (d->anchor_pit_ == max_pit)
1013 d->anchor_ypos_ = height_ - offset - row_dim.descent();
1014 else if (offset > height_)
1015 d->anchor_ypos_ = height_ - offset - defaultRowHeight();
1017 d->anchor_ypos_ = defaultRowHeight() * 2;
1023 void BufferView::makeDocumentClass()
1025 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1026 buffer_.params().makeDocumentClass();
1027 updateDocumentClass(olddc);
1031 void BufferView::updateDocumentClass(DocumentClassConstPtr olddc)
1033 message(_("Converting document to new document class..."));
1035 StableDocIterator backcur(d->cursor_);
1036 ErrorList & el = buffer_.errorList("Class Switch");
1037 cap::switchBetweenClasses(
1038 olddc, buffer_.params().documentClassPtr(),
1039 static_cast<InsetText &>(buffer_.inset()), el);
1041 setCursor(backcur.asDocIterator(&buffer_));
1043 buffer_.errors("Class Switch");
1047 /** Return the change status at cursor position, taking into account the
1048 * status at each level of the document iterator (a table in a deleted
1049 * footnote is deleted).
1050 * When \param outer is true, the top slice is not looked at.
1052 static Change::Type lookupChangeType(DocIterator const & dit, bool outer = false)
1054 size_t const depth = dit.depth() - (outer ? 1 : 0);
1056 for (size_t i = 0 ; i < depth ; ++i) {
1057 CursorSlice const & slice = dit[i];
1058 if (!slice.inset().inMathed()
1059 && slice.pos() < slice.paragraph().size()) {
1060 Change::Type const ch = slice.paragraph().lookupChange(slice.pos()).type;
1061 if (ch != Change::UNCHANGED)
1065 return Change::UNCHANGED;
1069 bool BufferView::getStatus(FuncRequest const & cmd, FuncStatus & flag)
1071 FuncCode const act = cmd.action();
1073 // Can we use a readonly buffer?
1074 if (buffer_.isReadonly()
1075 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1076 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1077 if (buffer_.hasReadonlyFlag())
1078 flag.message(from_utf8(N_("Document is read-only")));
1080 flag.message(from_utf8(N_("Document has been modified externally")));
1081 flag.setEnabled(false);
1085 // Are we in a DELETED change-tracking region?
1086 if (lookupChangeType(d->cursor_, true) == Change::DELETED
1087 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1088 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1089 flag.message(from_utf8(N_("This portion of the document is deleted.")));
1090 flag.setEnabled(false);
1094 Cursor & cur = d->cursor_;
1096 if (cur.getStatus(cmd, flag))
1101 // FIXME: This is a bit problematic because we don't check if this is
1102 // a document BufferView or not for these LFUNs. We probably have to
1103 // dispatch both to currentBufferView() and, if that fails,
1104 // to documentBufferView(); same as we do now for current Buffer and
1105 // document Buffer. Ideally those LFUN should go to Buffer as they
1106 // operate on the full Buffer and the cursor is only needed either for
1107 // an Undo record or to restore a cursor position. But we don't know
1108 // how to do that inside Buffer of course.
1109 case LFUN_BUFFER_PARAMS_APPLY:
1110 case LFUN_LAYOUT_MODULES_CLEAR:
1111 case LFUN_LAYOUT_MODULE_ADD:
1112 case LFUN_LAYOUT_RELOAD:
1113 case LFUN_TEXTCLASS_APPLY:
1114 case LFUN_TEXTCLASS_LOAD:
1115 flag.setEnabled(!buffer_.isReadonly());
1119 // We do not use the LyXAction flag for readonly because Undo sets the
1120 // buffer clean/dirty status by itself.
1121 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasUndoStack());
1124 // We do not use the LyXAction flag for readonly because Redo sets the
1125 // buffer clean/dirty status by itself.
1126 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasRedoStack());
1128 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
1129 case LFUN_FILE_INSERT_PLAINTEXT: {
1130 docstring const & fname = cmd.argument();
1131 if (!FileName::isAbsolute(to_utf8(fname))) {
1132 flag.message(_("Absolute filename expected."));
1135 flag.setEnabled(cur.inTexted());
1138 case LFUN_FILE_INSERT:
1139 case LFUN_BOOKMARK_SAVE:
1140 // FIXME: Actually, these LFUNS should be moved to Text
1141 flag.setEnabled(cur.inTexted());
1144 case LFUN_FONT_STATE:
1145 case LFUN_LABEL_INSERT:
1146 case LFUN_INFO_INSERT:
1147 case LFUN_PARAGRAPH_GOTO:
1148 case LFUN_NOTE_NEXT:
1149 case LFUN_REFERENCE_NEXT:
1150 case LFUN_WORD_FIND:
1151 case LFUN_WORD_FIND_FORWARD:
1152 case LFUN_WORD_FIND_BACKWARD:
1153 case LFUN_WORD_REPLACE:
1156 case LFUN_MARK_TOGGLE:
1157 case LFUN_SCREEN_RECENTER:
1158 case LFUN_SCREEN_SHOW_CURSOR:
1159 case LFUN_BIBTEX_DATABASE_ADD:
1160 case LFUN_BIBTEX_DATABASE_DEL:
1161 case LFUN_STATISTICS:
1162 case LFUN_KEYMAP_OFF:
1163 case LFUN_KEYMAP_PRIMARY:
1164 case LFUN_KEYMAP_SECONDARY:
1165 case LFUN_KEYMAP_TOGGLE:
1166 case LFUN_INSET_SELECT_ALL:
1167 flag.setEnabled(true);
1170 case LFUN_GRAPHICS_UNIFY:
1171 flag.setEnabled(cur.countInsetsInSelection(GRAPHICS_CODE)>1);
1174 case LFUN_WORD_FINDADV: {
1175 FindAndReplaceOptions opt;
1176 istringstream iss(to_utf8(cmd.argument()));
1178 flag.setEnabled(opt.repl_buf_name.empty()
1179 || !buffer_.isReadonly());
1183 case LFUN_LABEL_GOTO:
1184 flag.setEnabled(!cmd.argument().empty()
1185 || getInsetByCode<InsetRef>(cur, REF_CODE));
1188 case LFUN_CHANGES_MERGE:
1189 case LFUN_CHANGE_NEXT:
1190 case LFUN_CHANGE_PREVIOUS:
1191 case LFUN_ALL_CHANGES_ACCEPT:
1192 case LFUN_ALL_CHANGES_REJECT:
1193 flag.setEnabled(buffer_.areChangesPresent());
1196 case LFUN_SCREEN_UP:
1197 case LFUN_SCREEN_DOWN:
1199 case LFUN_SCREEN_UP_SELECT:
1200 case LFUN_SCREEN_DOWN_SELECT:
1201 case LFUN_INSET_FORALL:
1202 flag.setEnabled(true);
1205 case LFUN_LAYOUT_TABULAR:
1206 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
1210 flag.setEnabled(!cur.inset().forcePlainLayout(cur.idx()));
1213 case LFUN_LAYOUT_PARAGRAPH:
1214 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
1217 case LFUN_BRANCH_ADD_INSERT:
1218 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1221 case LFUN_DIALOG_SHOW_NEW_INSET:
1222 // FIXME: this is wrong, but I do not understand the
1224 if (cur.inset().lyxCode() == CAPTION_CODE)
1225 return cur.inset().getStatus(cur, cmd, flag);
1226 // FIXME we should consider passthru paragraphs too.
1227 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1230 case LFUN_CITATION_INSERT: {
1231 FuncRequest fr(LFUN_INSET_INSERT, "citation");
1232 // FIXME: This could turn in a recursive hell.
1233 // Shouldn't we use Buffer::getStatus() instead?
1234 flag.setEnabled(lyx::getStatus(fr).enabled());
1237 case LFUN_INSET_APPLY: {
1238 string const name = cmd.getArg(0);
1239 Inset * inset = editedInset(name);
1241 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1242 if (!inset->getStatus(cur, fr, flag)) {
1243 // Every inset is supposed to handle this
1244 LASSERT(false, break);
1247 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1248 flag = lyx::getStatus(fr);
1261 Inset * BufferView::editedInset(string const & name) const
1263 map<string, Inset *>::const_iterator it = d->edited_insets_.find(name);
1264 return it == d->edited_insets_.end() ? nullptr : it->second;
1268 void BufferView::editInset(string const & name, Inset * inset)
1271 d->edited_insets_[name] = inset;
1273 d->edited_insets_.erase(name);
1277 void BufferView::dispatch(FuncRequest const & cmd, DispatchResult & dr)
1279 LYXERR(Debug::ACTION, "BufferView::dispatch: cmd: " << cmd);
1281 string const argument = to_utf8(cmd.argument());
1282 Cursor & cur = d->cursor_;
1285 // Don't dispatch function that does not apply to internal buffers.
1286 if (buffer_.isInternal()
1287 && lyxaction.funcHasFlag(cmd.action(), LyXAction::NoInternal))
1290 // We'll set this back to false if need be.
1291 bool dispatched = true;
1292 buffer_.undo().beginUndoGroup();
1294 FuncCode const act = cmd.action();
1297 case LFUN_BUFFER_PARAMS_APPLY: {
1298 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1299 cur.recordUndoBufferParams();
1300 istringstream ss(to_utf8(cmd.argument()));
1303 int const unknown_tokens = buffer_.readHeader(lex);
1304 if (unknown_tokens != 0) {
1305 LYXERR0("Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1306 << unknown_tokens << " unknown token"
1307 << (unknown_tokens == 1 ? "" : "s"));
1309 updateDocumentClass(olddc);
1311 // We are most certainly here because of a change in the document
1312 // It is then better to make sure that all dialogs are in sync with
1313 // current document settings.
1314 dr.screenUpdate(Update::Force | Update::FitCursor);
1315 dr.forceBufferUpdate();
1319 case LFUN_LAYOUT_MODULES_CLEAR: {
1320 // FIXME: this modifies the document in cap::switchBetweenClasses
1321 // without calling recordUndo. Fix this before using
1322 // recordUndoBufferParams().
1323 cur.recordUndoFullBuffer();
1324 buffer_.params().clearLayoutModules();
1325 makeDocumentClass();
1326 dr.screenUpdate(Update::Force);
1327 dr.forceBufferUpdate();
1331 case LFUN_LAYOUT_MODULE_ADD: {
1332 BufferParams const & params = buffer_.params();
1333 if (!params.layoutModuleCanBeAdded(argument)) {
1334 LYXERR0("Module `" << argument <<
1335 "' cannot be added due to failed requirements or "
1336 "conflicts with installed modules.");
1339 // FIXME: this modifies the document in cap::switchBetweenClasses
1340 // without calling recordUndo. Fix this before using
1341 // recordUndoBufferParams().
1342 cur.recordUndoFullBuffer();
1343 buffer_.params().addLayoutModule(argument);
1344 makeDocumentClass();
1345 dr.screenUpdate(Update::Force);
1346 dr.forceBufferUpdate();
1350 case LFUN_TEXTCLASS_APPLY: {
1351 // since this shortcircuits, the second call is made only if
1353 bool const success =
1354 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1355 LayoutFileList::get().load(argument, buffer_.filePath());
1357 docstring s = bformat(_("The document class `%1$s' "
1358 "could not be loaded."), from_utf8(argument));
1359 frontend::Alert::error(_("Could not load class"), s);
1363 LayoutFile const * old_layout = buffer_.params().baseClass();
1364 LayoutFile const * new_layout = &(LayoutFileList::get()[argument]);
1366 if (old_layout == new_layout)
1370 // Save the old, possibly modular, layout for use in conversion.
1371 // FIXME: this modifies the document in cap::switchBetweenClasses
1372 // without calling recordUndo. Fix this before using
1373 // recordUndoBufferParams().
1374 cur.recordUndoFullBuffer();
1375 buffer_.params().setBaseClass(argument, buffer_.layoutPos());
1376 makeDocumentClass();
1377 dr.screenUpdate(Update::Force);
1378 dr.forceBufferUpdate();
1382 case LFUN_TEXTCLASS_LOAD: {
1383 // since this shortcircuits, the second call is made only if
1385 bool const success =
1386 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1387 LayoutFileList::get().load(argument, buffer_.filePath());
1389 docstring s = bformat(_("The document class `%1$s' "
1390 "could not be loaded."), from_utf8(argument));
1391 frontend::Alert::error(_("Could not load class"), s);
1396 case LFUN_LAYOUT_RELOAD: {
1397 LayoutFileIndex bc = buffer_.params().baseClassID();
1398 LayoutFileList::get().reset(bc);
1399 buffer_.params().setBaseClass(bc, buffer_.layoutPos());
1400 makeDocumentClass();
1401 dr.screenUpdate(Update::Force);
1402 dr.forceBufferUpdate();
1407 dr.setMessage(_("Undo"));
1408 cur.clearSelection();
1409 // We need to find out if the bibliography information
1410 // has changed. See bug #11055.
1411 // So these should not be references...
1412 string const engine = buffer().params().citeEngine();
1413 CiteEngineType const enginetype = buffer().params().citeEngineType();
1414 if (!cur.undoAction())
1415 dr.setMessage(_("No further undo information"));
1417 dr.screenUpdate(Update::Force | Update::FitCursor);
1418 dr.forceBufferUpdate();
1419 if (buffer().params().citeEngine() != engine ||
1420 buffer().params().citeEngineType() != enginetype)
1421 buffer().invalidateCiteLabels();
1427 dr.setMessage(_("Redo"));
1428 cur.clearSelection();
1429 // We need to find out if the bibliography information
1430 // has changed. See bug #11055.
1431 // So these should not be references...
1432 string const engine = buffer().params().citeEngine();
1433 CiteEngineType const enginetype = buffer().params().citeEngineType();
1434 if (!cur.redoAction())
1435 dr.setMessage(_("No further redo information"));
1437 dr.screenUpdate(Update::Force | Update::FitCursor);
1438 dr.forceBufferUpdate();
1439 if (buffer().params().citeEngine() != engine ||
1440 buffer().params().citeEngineType() != enginetype)
1441 buffer().invalidateCiteLabels();
1446 case LFUN_FONT_STATE:
1447 dr.setMessage(cur.currentState(false));
1450 case LFUN_BOOKMARK_SAVE:
1451 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1454 case LFUN_LABEL_GOTO: {
1455 docstring label = cmd.argument();
1456 if (label.empty()) {
1458 getInsetByCode<InsetRef>(cur, REF_CODE);
1460 label = inset->getParam("reference");
1461 // persistent=false: use temp_bookmark
1465 if (!label.empty()) {
1467 // at the moment, this is redundant, since gotoLabel will
1468 // eventually call LFUN_PARAGRAPH_GOTO, but it seems best
1470 dr.screenUpdate(Update::Force | Update::FitCursor);
1475 case LFUN_PARAGRAPH_GOTO: {
1476 int const id = convert<int>(cmd.getArg(0));
1477 pos_type const pos = convert<int>(cmd.getArg(1));
1480 string const str_id_end = cmd.getArg(2);
1481 string const str_pos_end = cmd.getArg(3);
1483 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1484 b = theBufferList().next(b)) {
1487 curs.setCursor(b->getParFromID(id));
1489 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1493 LYXERR(Debug::INFO, "Paragraph " << curs.paragraph().id()
1494 << " found in buffer `"
1495 << b->absFileName() << "'.");
1497 if (b == &buffer_) {
1499 if (str_id_end.empty() || str_pos_end.empty()) {
1502 mouseSetCursor(curs);
1505 int const id_end = convert<int>(str_id_end);
1506 pos_type const pos_end = convert<int>(str_pos_end);
1507 success = setCursorFromEntries({id, pos},
1511 dr.screenUpdate(Update::Force | Update::FitCursor);
1513 // Switch to other buffer view and resend cmd
1514 lyx::dispatch(FuncRequest(
1515 LFUN_BUFFER_SWITCH, b->absFileName()));
1523 case LFUN_NOTE_NEXT:
1524 gotoInset(this, { NOTE_CODE }, false);
1525 // FIXME: if SinglePar is changed to act on the inner
1526 // paragraph, this will not be OK anymore. The update is
1527 // useful for auto-open collapsible insets.
1528 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1531 case LFUN_REFERENCE_NEXT: {
1532 gotoInset(this, { LABEL_CODE, REF_CODE }, true);
1533 // FIXME: if SinglePar is changed to act on the inner
1534 // paragraph, this will not be OK anymore. The update is
1535 // useful for auto-open collapsible insets.
1536 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1540 case LFUN_CHANGE_NEXT:
1541 findNextChange(this);
1542 if (cur.inset().isTable())
1543 // In tables, there might be whole changed rows or columns
1545 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1546 dr.screenUpdate(Update::Force | Update::FitCursor);
1549 case LFUN_CHANGE_PREVIOUS:
1550 findPreviousChange(this);
1551 if (cur.inset().isTable())
1552 // In tables, there might be whole changed rows or columns
1554 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1555 dr.screenUpdate(Update::Force | Update::FitCursor);
1558 case LFUN_CHANGES_MERGE:
1559 if (findNextChange(this) || findPreviousChange(this)) {
1560 dr.screenUpdate(Update::Force | Update::FitCursor);
1561 dr.forceBufferUpdate();
1562 showDialog("changes");
1566 case LFUN_ALL_CHANGES_ACCEPT: {
1567 // select complete document
1569 cur.selHandle(true);
1570 buffer_.text().cursorBottom(cur);
1571 // accept everything in a single step to support atomic undo
1572 // temporarily disable track changes in order to end with really
1573 // no new (e.g., DPSM-caused) changes (see #7487)
1574 bool const track = buffer_.params().track_changes;
1575 buffer_.params().track_changes = false;
1576 buffer_.text().acceptOrRejectChanges(cur, Text::ACCEPT);
1577 buffer_.params().track_changes = track;
1579 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1580 dr.screenUpdate(Update::Force | Update::FitCursor);
1581 dr.forceBufferUpdate();
1585 case LFUN_ALL_CHANGES_REJECT: {
1586 // select complete document
1588 cur.selHandle(true);
1589 buffer_.text().cursorBottom(cur);
1590 // reject everything in a single step to support atomic undo
1591 // temporarily disable track changes in order to end with really
1592 // no new (e.g., DPSM-caused) changes (see #7487)
1593 bool const track = buffer_.params().track_changes;
1594 buffer_.params().track_changes = false;
1595 buffer_.text().acceptOrRejectChanges(cur, Text::REJECT);
1596 buffer_.params().track_changes = track;
1598 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1599 dr.screenUpdate(Update::Force | Update::FitCursor);
1600 dr.forceBufferUpdate();
1604 case LFUN_WORD_FIND_FORWARD:
1605 case LFUN_WORD_FIND_BACKWARD: {
1607 // Would it maybe be better if this variable were view specific anyway?
1608 static docstring last_search;
1609 docstring searched_string;
1611 if (!cmd.argument().empty()) {
1612 last_search = cmd.argument();
1613 searched_string = cmd.argument();
1615 searched_string = last_search;
1618 if (searched_string.empty())
1621 bool const fw = act == LFUN_WORD_FIND_FORWARD;
1622 docstring const data =
1623 find2string(searched_string, true, false, fw);
1624 bool found = lyxfind(this, FuncRequest(LFUN_WORD_FIND, data));
1626 dr.screenUpdate(Update::Force | Update::FitCursor);
1630 case LFUN_WORD_FIND: {
1631 FuncRequest req = cmd;
1632 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1633 req = d->search_request_cache_;
1634 if (req.argument().empty()) {
1635 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, "findreplace"));
1638 if (lyxfind(this, req))
1639 dr.screenUpdate(Update::Force | Update::FitCursor);
1641 d->search_request_cache_ = req;
1645 case LFUN_WORD_REPLACE: {
1646 bool has_deleted = false;
1647 if (cur.selection()) {
1648 DocIterator beg = cur.selectionBegin();
1649 DocIterator end = cur.selectionEnd();
1650 if (beg.pit() == end.pit()) {
1651 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1652 if (!cur.inMathed() && cur.paragraph().isDeleted(p)) {
1659 if (lyxreplace(this, cmd, has_deleted)) {
1660 dr.forceBufferUpdate();
1661 dr.screenUpdate(Update::Force | Update::FitCursor);
1666 case LFUN_WORD_FINDADV: {
1667 FindAndReplaceOptions opt;
1668 istringstream iss(to_utf8(cmd.argument()));
1670 if (findAdv(this, opt)) {
1671 dr.screenUpdate(Update::Force | Update::FitCursor);
1682 cur.clearSelection();
1683 dr.setMessage(from_utf8(N_("Mark off")));
1687 cur.clearSelection();
1689 dr.setMessage(from_utf8(N_("Mark on")));
1692 case LFUN_MARK_TOGGLE:
1693 cur.selection(false);
1696 dr.setMessage(from_utf8(N_("Mark removed")));
1699 dr.setMessage(from_utf8(N_("Mark set")));
1704 case LFUN_SCREEN_SHOW_CURSOR:
1708 case LFUN_SCREEN_RECENTER:
1712 case LFUN_BIBTEX_DATABASE_ADD: {
1713 Cursor tmpcur = cur;
1714 findInset(tmpcur, { BIBTEX_CODE }, false);
1715 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1718 if (inset->addDatabase(cmd.argument()))
1719 dr.forceBufferUpdate();
1724 case LFUN_BIBTEX_DATABASE_DEL: {
1725 Cursor tmpcur = cur;
1726 findInset(tmpcur, { BIBTEX_CODE }, false);
1727 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1730 if (inset->delDatabase(cmd.argument()))
1731 dr.forceBufferUpdate();
1736 case LFUN_GRAPHICS_UNIFY: {
1738 cur.recordUndoFullBuffer();
1740 DocIterator from, to;
1741 from = cur.selectionBegin();
1742 to = cur.selectionEnd();
1744 string const newId = cmd.getArg(0);
1745 bool fetchId = newId.empty(); //if we wait for groupId from first graphics inset
1747 InsetGraphicsParams grp_par;
1749 InsetGraphics::string2params(graphics::getGroupParams(buffer_, newId), buffer_, grp_par);
1751 if (!from.nextInset()) //move to closest inset
1752 from.forwardInset();
1754 while (!from.empty() && from < to) {
1755 Inset * inset = from.nextInset();
1758 InsetGraphics * ig = inset->asInsetGraphics();
1760 InsetGraphicsParams inspar = ig->getParams();
1765 grp_par.filename = inspar.filename;
1766 ig->setParams(grp_par);
1769 from.forwardInset();
1771 dr.screenUpdate(Update::Force); //needed if triggered from context menu
1775 case LFUN_STATISTICS: {
1776 DocIterator from, to;
1777 if (cur.selection()) {
1778 from = cur.selectionBegin();
1779 to = cur.selectionEnd();
1781 from = doc_iterator_begin(&buffer_);
1782 to = doc_iterator_end(&buffer_);
1784 buffer_.updateStatistics(from, to);
1785 int const words = buffer_.wordCount();
1786 int const chars = buffer_.charCount(false);
1787 int const chars_blanks = buffer_.charCount(true);
1789 if (cur.selection())
1790 message = _("Statistics for the selection:");
1792 message = _("Statistics for the document:");
1795 message += bformat(_("%1$d words"), words);
1797 message += _("One word");
1799 if (chars_blanks != 1)
1800 message += bformat(_("%1$d characters (including blanks)"),
1803 message += _("One character (including blanks)");
1806 message += bformat(_("%1$d characters (excluding blanks)"),
1809 message += _("One character (excluding blanks)");
1811 Alert::information(_("Statistics"), message);
1815 case LFUN_SCREEN_UP:
1816 case LFUN_SCREEN_DOWN: {
1817 Point p = getPos(cur);
1818 // This code has been commented out to enable to scroll down a
1819 // document, even if there are large insets in it (see bug #5465).
1820 /*if (p.y_ < 0 || p.y_ > height_) {
1821 // The cursor is off-screen so recenter before proceeding.
1825 int const scrolled = scroll(act == LFUN_SCREEN_UP
1826 ? -height_ : height_);
1827 if (act == LFUN_SCREEN_UP && scrolled > -height_)
1829 if (act == LFUN_SCREEN_DOWN && scrolled < height_)
1830 p = Point(width_, height_);
1831 bool const in_texted = cur.inTexted();
1832 cur.setCursor(doc_iterator_begin(cur.buffer()));
1833 cur.selHandle(false);
1834 // Force an immediate computation of metrics because we need it below
1835 processUpdateFlags(Update::Force);
1837 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_,
1838 true, act == LFUN_SCREEN_UP);
1839 //FIXME: what to do with cur.x_target()?
1840 bool update = in_texted && cur.bv().checkDepm(cur, old);
1843 if (update || cur.mark())
1844 dr.screenUpdate(Update::Force | Update::FitCursor);
1846 dr.forceBufferUpdate();
1851 string const scroll_type = cmd.getArg(0);
1852 int scroll_step = 0;
1853 if (scroll_type == "line")
1854 scroll_step = d->scrollbarParameters_.single_step;
1855 else if (scroll_type == "page")
1856 scroll_step = d->scrollbarParameters_.page_step;
1859 string const scroll_quantity = cmd.getArg(1);
1860 if (scroll_quantity == "up")
1861 scrollUp(scroll_step);
1862 else if (scroll_quantity == "down")
1863 scrollDown(scroll_step);
1865 int const scroll_value = convert<int>(scroll_quantity);
1867 scroll(scroll_step * scroll_value);
1869 dr.screenUpdate(Update::ForceDraw);
1870 dr.forceBufferUpdate();
1874 case LFUN_SCREEN_UP_SELECT: {
1875 // FIXME: why is the algorithm different from LFUN_SCREEN_UP?
1876 cur.selHandle(true);
1877 if (isTopScreen()) {
1878 lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1882 int y = getPos(cur).y_;
1883 int const ymin = y - height_ + defaultRowHeight();
1884 while (y > ymin && cur.up())
1888 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1892 case LFUN_SCREEN_DOWN_SELECT: {
1893 // FIXME: why is the algorithm different from LFUN_SCREEN_DOWN?
1894 cur.selHandle(true);
1895 if (isBottomScreen()) {
1896 lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1900 int y = getPos(cur).y_;
1901 int const ymax = y + height_ - defaultRowHeight();
1902 while (y < ymax && cur.down())
1906 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1911 case LFUN_INSET_SELECT_ALL: {
1912 // true if all cells are selected
1913 bool const all_selected = cur.depth() > 1
1914 && cur.selBegin().at_begin()
1915 && cur.selEnd().at_end();
1916 // true if some cells are selected
1917 bool const cells_selected = cur.depth() > 1
1918 && cur.selBegin().at_cell_begin()
1919 && cur.selEnd().at_cell_end();
1920 if (all_selected || (cells_selected && !cur.inset().isTable())) {
1921 // All the contents of the inset if selected, or only at
1922 // least one cell but inset is not a table.
1923 // Select the inset from outside.
1926 cur.selection(true);
1928 } else if (cells_selected) {
1929 // At least one complete cell is selected and inset is a table.
1935 cur.selection(true);
1936 cur.idx() = cur.lastidx();
1937 cur.pit() = cur.lastpit();
1938 cur.pos() = cur.lastpos();
1940 // select current cell
1944 cur.selection(true);
1945 cur.pit() = cur.lastpit();
1946 cur.pos() = cur.lastpos();
1948 cur.setCurrentFont();
1949 dr.screenUpdate(Update::Force);
1954 case LFUN_UNICODE_INSERT: {
1955 if (cmd.argument().empty())
1958 FuncCode code = cur.inset().currentMode() == Inset::MATH_MODE ?
1959 LFUN_MATH_INSERT : LFUN_SELF_INSERT;
1962 docstring const arg = from_utf8(cmd.getArg(i));
1966 LYXERR0("Not a hexstring: " << arg);
1970 char_type c = hexToInt(arg);
1971 if (c >= 32 && c < 0x10ffff) {
1972 LYXERR(Debug::KEY, "Inserting c: " << c);
1973 lyx::dispatch(FuncRequest(code, docstring(1, c)));
1981 // This would be in Buffer class if only Cursor did not
1982 // require a bufferview
1983 case LFUN_INSET_FORALL: {
1984 docstring const name = from_utf8(cmd.getArg(0));
1985 string const commandstr = cmd.getLongArg(1);
1986 FuncRequest const fr = lyxaction.lookupFunc(commandstr);
1988 // an arbitrary number to limit number of iterations
1989 const int max_iter = 100000;
1991 Cursor & curs = d->cursor_;
1992 Cursor const savecur = curs;
1994 if (!curs.nextInset())
1995 curs.forwardInset();
1996 curs.beginUndoGroup();
1997 while(curs && iterations < max_iter) {
1998 Inset * const ins = curs.nextInset();
2001 docstring insname = ins->layoutName();
2002 while (!insname.empty()) {
2003 if (insname == name || name == from_utf8("*")) {
2005 lyx::dispatch(fr, dr);
2009 size_t const i = insname.rfind(':');
2010 if (i == string::npos)
2012 insname = insname.substr(0, i);
2014 // if we did not delete the inset, skip it
2015 if (!curs.nextInset() || curs.nextInset() == ins)
2016 curs.forwardInset();
2020 /** This is a dummy undo record only to remember the cursor
2021 * that has just been set; this will be used on a redo action
2022 * (see ticket #10097)
2024 * FIXME: a better fix would be to have a way to set the
2025 * cursor value directly, but I am not sure it is worth it.
2028 curs.endUndoGroup();
2029 dr.screenUpdate(Update::Force);
2030 dr.forceBufferUpdate();
2032 if (iterations >= max_iter) {
2034 dr.setMessage(bformat(_("`inset-forall' interrupted because number of actions is larger than %1$d"), max_iter));
2036 dr.setMessage(bformat(_("Applied \"%1$s\" to %2$d insets"), from_utf8(commandstr), iterations));
2041 case LFUN_BRANCH_ADD_INSERT: {
2042 docstring branch_name = from_utf8(cmd.getArg(0));
2043 if (branch_name.empty())
2044 if (!Alert::askForText(branch_name, _("Branch name")) ||
2045 branch_name.empty())
2048 DispatchResult drtmp;
2049 buffer_.dispatch(FuncRequest(LFUN_BRANCH_ADD, branch_name), drtmp);
2050 if (drtmp.error()) {
2051 Alert::warning(_("Branch already exists"), drtmp.message());
2054 docstring const sep = buffer_.params().branchlist().separator();
2055 for (docstring const & branch : getVectorFromString(branch_name, sep))
2056 lyx::dispatch(FuncRequest(LFUN_BRANCH_INSERT, branch));
2060 case LFUN_KEYMAP_OFF:
2061 getIntl().keyMapOn(false);
2064 case LFUN_KEYMAP_PRIMARY:
2065 getIntl().keyMapPrim();
2068 case LFUN_KEYMAP_SECONDARY:
2069 getIntl().keyMapSec();
2072 case LFUN_KEYMAP_TOGGLE:
2073 getIntl().toggleKeyMap();
2076 case LFUN_DIALOG_SHOW_NEW_INSET: {
2077 string const name = cmd.getArg(0);
2078 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
2079 if (decodeInsetParam(name, data, buffer_))
2080 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
2082 lyxerr << "Inset type '" << name <<
2083 "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" << endl;
2087 case LFUN_CITATION_INSERT: {
2088 if (argument.empty()) {
2089 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
2092 // we can have one optional argument, delimited by '|'
2093 // citation-insert <key>|<text_before>
2094 // this should be enhanced to also support text_after
2095 // and citation style
2096 string arg = argument;
2098 if (contains(argument, "|")) {
2099 arg = token(argument, '|', 0);
2100 opt1 = token(argument, '|', 1);
2103 // if our cursor is directly in front of or behind a citation inset,
2104 // we will instead add the new key to it.
2105 Inset * inset = cur.nextInset();
2106 if (!inset || inset->lyxCode() != CITE_CODE)
2107 inset = cur.prevInset();
2108 if (inset && inset->lyxCode() == CITE_CODE) {
2109 InsetCitation * icite = static_cast<InsetCitation *>(inset);
2110 if (icite->addKey(arg)) {
2111 dr.forceBufferUpdate();
2112 dr.screenUpdate(Update::FitCursor | Update::SinglePar);
2114 LYXERR0("Discarding optional argument to citation-insert.");
2119 InsetCommandParams icp(CITE_CODE);
2120 icp["key"] = from_utf8(arg);
2122 icp["before"] = from_utf8(opt1);
2124 from_ascii(InsetCitation::last_literal ? "true" : "false");
2125 string icstr = InsetCommand::params2string(icp);
2126 FuncRequest fr(LFUN_INSET_INSERT, icstr);
2131 case LFUN_INSET_APPLY: {
2132 string const name = cmd.getArg(0);
2133 Inset * inset = editedInset(name);
2135 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
2139 // put cursor in front of inset.
2140 if (!setCursorFromInset(inset)) {
2141 LASSERT(false, break);
2144 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
2145 inset->dispatch(cur, fr);
2146 dr.screenUpdate(cur.result().screenUpdate());
2147 if (cur.result().needBufferUpdate())
2148 dr.forceBufferUpdate();
2153 // The change of language of buffer belongs to the Buffer class.
2154 // We have to do it here because we need a cursor for Undo.
2155 // When Undo::recordUndoBufferParams() is implemented someday
2156 // LFUN_BUFFER_LANGUAGE should be handled by the Buffer class.
2157 case LFUN_BUFFER_LANGUAGE: {
2158 Language const * oldL = buffer_.params().language;
2159 Language const * newL = languages.getLanguage(argument);
2160 if (!newL || oldL == newL)
2162 if (oldL->rightToLeft() == newL->rightToLeft()) {
2163 cur.recordUndoFullBuffer();
2164 buffer_.changeLanguage(oldL, newL);
2165 cur.setCurrentFont();
2166 dr.forceBufferUpdate();
2171 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
2172 case LFUN_FILE_INSERT_PLAINTEXT: {
2173 bool const as_paragraph = (act == LFUN_FILE_INSERT_PLAINTEXT_PARA);
2174 string const fname = to_utf8(cmd.argument());
2175 if (!FileName::isAbsolute(fname))
2176 dr.setMessage(_("Absolute filename expected."));
2178 insertPlaintextFile(FileName(fname), as_paragraph);
2183 // OK, so try the Buffer itself...
2184 buffer_.dispatch(cmd, dr);
2185 dispatched = dr.dispatched();
2189 buffer_.undo().endUndoGroup();
2190 dr.dispatched(dispatched);
2192 // NOTE: The code below is copied from Cursor::dispatch. If you
2193 // need to modify this, please update the other one too.
2195 // notify insets we just entered/left
2196 if (cursor() != old) {
2197 old.beginUndoGroup();
2199 bool badcursor = notifyCursorLeavesOrEnters(old, cursor());
2201 cursor().fixIfBroken();
2202 resetInlineCompletionPos();
2209 docstring BufferView::requestSelection()
2211 Cursor & cur = d->cursor_;
2213 LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
2214 if (!cur.selection()) {
2215 d->xsel_cache_.set = false;
2219 LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
2220 if (!d->xsel_cache_.set ||
2221 cur.top() != d->xsel_cache_.cursor ||
2222 cur.realAnchor().top() != d->xsel_cache_.anchor)
2224 d->xsel_cache_.cursor = cur.top();
2225 d->xsel_cache_.anchor = cur.realAnchor().top();
2226 d->xsel_cache_.set = cur.selection();
2227 return cur.selectionAsString(false);
2233 void BufferView::clearSelection()
2235 d->cursor_.clearSelection();
2236 // Clear the selection buffer. Otherwise a subsequent
2237 // middle-mouse-button paste would use the selection buffer,
2238 // not the more current external selection.
2239 cap::clearSelection();
2240 d->xsel_cache_.set = false;
2241 // The buffer did not really change, but this causes the
2242 // redraw we need because we cleared the selection above.
2243 buffer_.changed(false);
2247 void BufferView::resize(int width, int height)
2249 // Update from work area
2253 // Clear the paragraph height cache.
2254 d->par_height_.clear();
2255 // Redo the metrics.
2260 Inset const * BufferView::getCoveringInset(Text const & text,
2263 TextMetrics & tm = d->text_metrics_[&text];
2264 Inset * inset = tm.checkInsetHit(x, y);
2268 if (!inset->descendable(*this))
2269 // No need to go further down if the inset is not
2273 size_t cell_number = inset->nargs();
2274 // Check all the inner cell.
2275 for (size_t i = 0; i != cell_number; ++i) {
2276 Text const * inner_text = inset->getText(i);
2279 Inset const * inset_deeper =
2280 getCoveringInset(*inner_text, x, y);
2282 return inset_deeper;
2290 void BufferView::updateHoveredInset() const
2292 // Get inset under mouse, if there is one.
2293 int const x = d->mouse_position_cache_.x_;
2294 int const y = d->mouse_position_cache_.y_;
2295 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
2297 d->clickable_inset_ = covering_inset && covering_inset->clickable(*this, x, y);
2299 if (covering_inset == d->last_inset_)
2300 // Same inset, no need to do anything...
2303 bool need_redraw = false;
2304 if (d->last_inset_) {
2305 // Remove the hint on the last hovered inset (if any).
2306 need_redraw |= d->last_inset_->setMouseHover(this, false);
2307 d->last_inset_ = nullptr;
2310 if (covering_inset && covering_inset->setMouseHover(this, true)) {
2312 // Only the insets that accept the hover state, do
2313 // clear the last_inset_, so only set the last_inset_
2314 // member if the hovered setting is accepted.
2315 d->last_inset_ = covering_inset;
2319 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
2320 << d->mouse_position_cache_.x_ << ", "
2321 << d->mouse_position_cache_.y_ << ")");
2323 d->update_strategy_ = DecorationUpdate;
2325 // This event (moving without mouse click) is not passed further.
2326 // This should be changed if it is further utilized.
2327 buffer_.changed(false);
2332 void BufferView::clearLastInset(Inset * inset) const
2334 if (d->last_inset_ != inset) {
2335 LYXERR0("Wrong last_inset!");
2338 d->last_inset_ = nullptr;
2342 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
2344 //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
2346 // This is only called for mouse related events including
2347 // LFUN_FILE_OPEN generated by drag-and-drop.
2348 FuncRequest cmd = cmd0;
2350 Cursor old = cursor();
2352 cur.push(buffer_.inset());
2353 cur.selection(d->cursor_.selection());
2355 // Either the inset under the cursor or the
2356 // surrounding Text will handle this event.
2358 // make sure we stay within the screen...
2359 cmd.set_y(min(max(cmd.y(), -1), height_));
2361 d->mouse_position_cache_.x_ = cmd.x();
2362 d->mouse_position_cache_.y_ = cmd.y();
2364 if (cmd.action() == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
2365 updateHoveredInset();
2369 // Build temporary cursor.
2370 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x(), cmd.y());
2372 // If inset is not editable, cur.pos() might point behind the
2373 // inset (depending on cmd.x(), cmd.y()). This is needed for
2374 // editing to fix bug 9628, but e.g. the context menu needs a
2375 // cursor in front of the inset.
2376 if ((inset->hasSettings() || !inset->contextMenuName().empty()
2377 || inset->lyxCode() == SEPARATOR_CODE) &&
2378 cur.nextInset() != inset && cur.prevInset() == inset)
2380 } else if (cur.inTexted() && cur.pos()
2381 && cur.paragraph().isEnvSeparator(cur.pos() - 1)) {
2382 // Always place cursor in front of a separator inset.
2386 // Put anchor at the same position.
2389 cur.beginUndoGroup();
2391 // Try to dispatch to an non-editable inset near this position
2392 // via the temp cursor. If the inset wishes to change the real
2393 // cursor it has to do so explicitly by using
2394 // cur.bv().cursor() = cur; (or similar)
2396 inset->dispatch(cur, cmd);
2398 // Now dispatch to the temporary cursor. If the real cursor should
2399 // be modified, the inset's dispatch has to do so explicitly.
2400 if (!inset || !cur.result().dispatched())
2403 // Notify left insets
2405 bool badcursor = old.fixIfBroken() | cur.fixIfBroken();
2406 badcursor |= notifyCursorLeavesOrEnters(old, cur);
2408 cursor().fixIfBroken();
2413 // Do we have a selection?
2414 theSelection().haveSelection(cursor().selection());
2416 if (cur.needBufferUpdate()) {
2417 cur.clearBufferUpdate();
2418 buffer().updateBuffer();
2421 // If the command has been dispatched,
2422 if (cur.result().dispatched() || cur.result().screenUpdate())
2423 processUpdateFlags(cur.result().screenUpdate());
2427 int BufferView::minVisiblePart()
2429 return 2 * defaultRowHeight();
2433 int BufferView::scroll(int pixels)
2436 return scrollDown(pixels);
2438 return scrollUp(-pixels);
2443 int BufferView::scrollDown(int pixels)
2445 Text * text = &buffer_.text();
2446 TextMetrics & tm = d->text_metrics_[text];
2447 int const ymax = height_ + pixels;
2449 pair<pit_type, ParagraphMetrics const *> last = tm.last();
2450 int bottom_pos = last.second->position() + last.second->descent();
2451 if (lyxrc.scroll_below_document)
2452 bottom_pos += height_ - minVisiblePart();
2453 if (last.first + 1 == int(text->paragraphs().size())) {
2454 if (bottom_pos <= height_)
2456 pixels = min(pixels, bottom_pos - height_);
2459 if (bottom_pos > ymax)
2461 tm.newParMetricsDown();
2463 d->anchor_ypos_ -= pixels;
2468 int BufferView::scrollUp(int pixels)
2470 Text * text = &buffer_.text();
2471 TextMetrics & tm = d->text_metrics_[text];
2472 int ymin = - pixels;
2474 pair<pit_type, ParagraphMetrics const *> first = tm.first();
2475 int top_pos = first.second->position() - first.second->ascent();
2476 if (first.first == 0) {
2479 pixels = min(pixels, - top_pos);
2484 tm.newParMetricsUp();
2486 d->anchor_ypos_ += pixels;
2491 bool BufferView::setCursorFromRow(int row)
2493 TexRow::TextEntry start, end;
2494 tie(start,end) = buffer_.texrow().getEntriesFromRow(row);
2495 LYXERR(Debug::LATEX,
2496 "setCursorFromRow: for row " << row << ", TexRow has found "
2497 "start (id=" << start.id << ",pos=" << start.pos << "), "
2498 "end (id=" << end.id << ",pos=" << end.pos << ")");
2499 return setCursorFromEntries(start, end);
2503 bool BufferView::setCursorFromEntries(TexRow::TextEntry start,
2504 TexRow::TextEntry end)
2506 DocIterator dit_start, dit_end;
2507 tie(dit_start,dit_end) =
2508 TexRow::getDocIteratorsFromEntries(start, end, buffer_);
2511 // Setting selection start
2512 d->cursor_.clearSelection();
2513 setCursor(dit_start);
2514 // Setting selection end
2516 d->cursor_.resetAnchor();
2517 setCursorSelectionTo(dit_end);
2523 bool BufferView::setCursorFromInset(Inset const * inset)
2525 // are we already there?
2526 if (cursor().nextInset() == inset)
2529 // Inset is not at cursor position. Find it in the document.
2532 while (cur && cur.nextInset() != inset)
2543 void BufferView::gotoLabel(docstring const & label)
2546 bool have_inactive = false;
2547 for (Buffer const * buf : buffer().allRelatives()) {
2549 for (TocItem const & item : *buf->tocBackend().toc("label")) {
2550 if (label == item.str() && item.isOutput()) {
2551 lyx::dispatch(item.action());
2554 // If we find an inactive label, save it for the case
2555 // that no active one is there
2556 if (label == item.str() && !have_inactive) {
2557 have_inactive = true;
2558 action = item.action();
2562 // We only found an inactive label. Go there.
2564 lyx::dispatch(action);
2568 TextMetrics const & BufferView::textMetrics(Text const * t) const
2570 return const_cast<BufferView *>(this)->textMetrics(t);
2574 TextMetrics & BufferView::textMetrics(Text const * t)
2577 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
2578 if (tmc_it == d->text_metrics_.end()) {
2579 tmc_it = d->text_metrics_.emplace(std::piecewise_construct,
2580 std::forward_as_tuple(t),
2581 std::forward_as_tuple(this, const_cast<Text *>(t))).first;
2583 return tmc_it->second;
2587 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
2590 return textMetrics(t).parMetrics(pit);
2594 int BufferView::workHeight() const
2600 void BufferView::setCursor(DocIterator const & dit)
2603 size_t const n = dit.depth();
2604 for (size_t i = 0; i < n; ++i)
2605 dit[i].inset().edit(d->cursor_, true);
2607 d->cursor_.setCursor(dit);
2608 d->cursor_.selection(false);
2609 d->cursor_.setCurrentFont();
2611 // It seems on general grounds as if this is probably needed, but
2612 // it is not yet clear.
2613 // See bug #7394 and r38388.
2614 // d->cursor.resetAnchor();
2618 void BufferView::setCursorSelectionTo(DocIterator const & dit)
2620 size_t const n = dit.depth();
2621 for (size_t i = 0; i < n; ++i)
2622 dit[i].inset().edit(d->cursor_, true);
2624 d->cursor_.selection(true);
2625 d->cursor_.setCursorSelectionTo(dit);
2626 d->cursor_.setCurrentFont();
2630 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
2632 // Would be wrong to delete anything if we have a selection.
2633 if (cur.selection())
2636 bool need_anchor_change = false;
2637 bool changed = Text::deleteEmptyParagraphMechanism(cur, old,
2638 need_anchor_change);
2640 if (need_anchor_change)
2648 // we would rather not do this here, but it needs to be done before
2649 // the changed() signal is sent.
2650 buffer_.updateBuffer();
2652 buffer_.changed(true);
2657 bool BufferView::mouseSetCursor(Cursor & cur, bool const select)
2659 LASSERT(&cur.bv() == this, return false);
2662 // this event will clear selection so we save selection for
2663 // persistent selection
2664 cap::saveSelection(cursor());
2666 d->cursor_.macroModeClose();
2667 // If a macro has been finalized, the cursor might have been broken
2670 // Has the cursor just left the inset?
2671 bool const leftinset = (&d->cursor_.inset() != &cur.inset());
2673 d->cursor_.fixIfBroken();
2675 // do the dEPM magic if needed
2676 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
2677 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
2678 // the leftinset bool would not be necessary (badcursor instead).
2679 bool update = leftinset;
2682 d->cursor_.setSelection();
2683 d->cursor_.setCursorSelectionTo(cur);
2685 if (d->cursor_.inTexted())
2686 update |= checkDepm(cur, d->cursor_);
2687 d->cursor_.resetAnchor();
2688 d->cursor_.setCursor(cur);
2689 d->cursor_.clearSelection();
2691 d->cursor_.boundary(cur.boundary());
2692 d->cursor_.finishUndo();
2693 d->cursor_.setCurrentFont();
2695 cur.forceBufferUpdate();
2700 void BufferView::putSelectionAt(DocIterator const & cur,
2701 int length, bool backwards)
2703 d->cursor_.clearSelection();
2709 d->cursor_.pos() += length;
2710 d->cursor_.setSelection(d->cursor_, -length);
2712 d->cursor_.setSelection(d->cursor_, length);
2717 bool BufferView::selectIfEmpty(DocIterator & cur)
2719 if ((cur.inTexted() && !cur.paragraph().empty())
2720 || (cur.inMathed() && !cur.cell().empty()))
2723 pit_type const beg_pit = cur.pit();
2725 // The paragraph associated to this item isn't
2726 // the first one, so it can be selected
2729 // We have to resort to select the space between the
2730 // end of this item and the begin of the next one
2734 // If it is the only item in the document,
2735 // nothing can be selected
2738 pit_type const end_pit = cur.pit();
2739 pos_type const end_pos = cur.pos();
2740 d->cursor_.clearSelection();
2742 d->cursor_.setCursor(cur);
2743 d->cursor_.pit() = beg_pit;
2744 d->cursor_.pos() = 0;
2745 d->cursor_.selection(false);
2746 d->cursor_.resetAnchor();
2747 d->cursor_.pit() = end_pit;
2748 d->cursor_.pos() = end_pos;
2749 d->cursor_.setSelection();
2754 Cursor & BufferView::cursor()
2760 Cursor const & BufferView::cursor() const
2766 bool BufferView::singleParUpdate()
2768 Text & buftext = buffer_.text();
2769 pit_type const bottom_pit = d->cursor_.bottom().pit();
2770 TextMetrics & tm = textMetrics(&buftext);
2771 Dimension const old_dim = tm.parMetrics(bottom_pit).dim();
2773 // make sure inline completion pointer is ok
2774 if (d->inlineCompletionPos_.fixIfBroken())
2775 d->inlineCompletionPos_ = DocIterator();
2777 // In Single Paragraph mode, rebreak only
2778 // the (main text, not inset!) paragraph containing the cursor.
2779 // (if this paragraph contains insets etc., rebreaking will
2780 // recursively descend)
2781 tm.redoParagraph(bottom_pit);
2782 ParagraphMetrics & pm = tm.parMetrics(bottom_pit);
2783 if (pm.height() != old_dim.height()) {
2784 // Paragraph height has changed so we cannot proceed to
2785 // the singlePar optimisation.
2788 // Since position() points to the baseline of the first row, we
2789 // may have to update it. See ticket #11601 for an example where
2790 // the height does not change but the ascent does.
2791 pm.setPosition(pm.position() - old_dim.ascent() + pm.ascent());
2793 tm.updatePosCache(bottom_pit);
2795 LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
2796 << " y2: " << pm.position() + pm.descent()
2797 << " pit: " << bottom_pit
2798 << " singlepar: 1");
2803 void BufferView::updateMetrics()
2805 updateMetrics(d->update_flags_);
2806 d->update_strategy_ = FullScreenUpdate;
2810 void BufferView::updateMetrics(Update::flags & update_flags)
2812 if (height_ == 0 || width_ == 0)
2815 Text & buftext = buffer_.text();
2816 pit_type const npit = int(buftext.paragraphs().size());
2818 // Clear out the position cache in case of full screen redraw,
2819 d->coord_cache_.clear();
2820 d->math_rows_.clear();
2822 // Clear out paragraph metrics to avoid having invalid metrics
2823 // in the cache from paragraphs not relayouted below
2824 // The complete text metrics will be redone.
2825 d->text_metrics_.clear();
2827 TextMetrics & tm = textMetrics(&buftext);
2829 // make sure inline completion pointer is ok
2830 if (d->inlineCompletionPos_.fixIfBroken())
2831 d->inlineCompletionPos_ = DocIterator();
2833 if (d->anchor_pit_ >= npit)
2834 // The anchor pit must have been deleted...
2835 d->anchor_pit_ = npit - 1;
2837 // Rebreak anchor paragraph.
2838 tm.redoParagraph(d->anchor_pit_);
2839 ParagraphMetrics & anchor_pm = tm.parMetrics(d->anchor_pit_);
2842 if (d->anchor_pit_ == 0) {
2843 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
2845 // Complete buffer visible? Then it's easy.
2846 if (scrollRange == 0)
2847 d->anchor_ypos_ = anchor_pm.ascent();
2849 // avoid empty space above the first row
2850 d->anchor_ypos_ = min(d->anchor_ypos_, anchor_pm.ascent());
2853 anchor_pm.setPosition(d->anchor_ypos_);
2854 tm.updatePosCache(d->anchor_pit_);
2856 LYXERR(Debug::PAINTING, "metrics: "
2857 << " anchor pit = " << d->anchor_pit_
2858 << " anchor ypos = " << d->anchor_ypos_);
2860 // Redo paragraphs above anchor if necessary.
2861 int y1 = d->anchor_ypos_ - anchor_pm.ascent();
2862 // We are now just above the anchor paragraph.
2863 pit_type pit1 = d->anchor_pit_ - 1;
2864 for (; pit1 >= 0 && y1 >= 0; --pit1) {
2865 tm.redoParagraph(pit1);
2866 ParagraphMetrics & pm = tm.parMetrics(pit1);
2868 // Save the paragraph position in the cache.
2870 tm.updatePosCache(pit1);
2874 // Redo paragraphs below the anchor if necessary.
2875 int y2 = d->anchor_ypos_ + anchor_pm.descent();
2876 // We are now just below the anchor paragraph.
2877 pit_type pit2 = d->anchor_pit_ + 1;
2878 for (; pit2 < npit && y2 <= height_; ++pit2) {
2879 tm.redoParagraph(pit2);
2880 ParagraphMetrics & pm = tm.parMetrics(pit2);
2882 // Save the paragraph position in the cache.
2884 tm.updatePosCache(pit2);
2888 LYXERR(Debug::PAINTING, "Metrics: "
2889 << " anchor pit = " << d->anchor_pit_
2890 << " anchor ypos = " << d->anchor_ypos_
2893 << " pit1 = " << pit1
2894 << " pit2 = " << pit2);
2896 // metrics is done, full drawing is necessary now
2897 update_flags = (update_flags & ~Update::Force) | Update::ForceDraw;
2899 // Now update the positions of insets in the cache.
2902 if (lyxerr.debugging(Debug::WORKAREA)) {
2903 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
2904 d->coord_cache_.dump();
2909 void BufferView::updatePosCache()
2911 // this is the "nodraw" drawing stage: only set the positions of the
2912 // insets in metrics cache.
2913 frontend::NullPainter np;
2918 void BufferView::insertLyXFile(FileName const & fname, bool const ignorelang)
2920 LASSERT(d->cursor_.inTexted(), return);
2922 // Get absolute path of file and add ".lyx"
2923 // to the filename if necessary
2924 FileName filename = fileSearch(string(), fname.absFileName(), "lyx");
2926 docstring const disp_fn = makeDisplayPath(filename.absFileName());
2927 // emit message signal.
2928 message(bformat(_("Inserting document %1$s..."), disp_fn));
2931 Buffer buf(filename.absFileName(), false);
2932 if (buf.loadLyXFile() == Buffer::ReadSuccess) {
2933 ErrorList & el = buffer_.errorList("Parse");
2934 // Copy the inserted document error list into the current buffer one.
2935 el = buf.errorList("Parse");
2936 ParagraphList & pars = buf.paragraphs();
2938 // set main language of imported file to context language
2939 buf.changeLanguage(buf.language(), d->cursor_.getFont().language());
2940 buffer_.undo().recordUndo(d->cursor_);
2941 cap::pasteParagraphList(d->cursor_, pars,
2942 buf.params().documentClassPtr(), el);
2943 res = _("Document %1$s inserted.");
2945 res = _("Could not insert document %1$s");
2948 buffer_.changed(true);
2949 // emit message signal.
2950 message(bformat(res, disp_fn));
2954 Point BufferView::coordOffset(DocIterator const & dit) const
2960 // Addup contribution of nested insets, from inside to outside,
2961 // keeping the outer paragraph for a special handling below
2962 for (size_t i = dit.depth() - 1; i >= 1; --i) {
2963 CursorSlice const & sl = dit[i];
2967 // get relative position inside sl.inset()
2968 sl.inset().cursorPos(*this, sl, dit.boundary() && (i + 1 == dit.depth()), xx, yy);
2970 // Make relative position inside of the edited inset relative to sl.inset()
2974 // In case of an RTL inset, the edited inset will be positioned to the left
2977 bool boundary_i = dit.boundary() && i + 1 == dit.depth();
2978 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2983 // remember width for the case that sl.inset() is positioned in an RTL inset
2984 lastw = sl.inset().dimension(*this).wid;
2986 //lyxerr << "Cursor::getPos, i: "
2987 // << i << " x: " << xx << " y: " << y << endl;
2990 // Add contribution of initial rows of outermost paragraph
2991 CursorSlice const & sl = dit[0];
2992 TextMetrics const & tm = textMetrics(sl.text());
2993 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2995 LBUFERR(!pm.rows().empty());
2996 y -= pm.rows()[0].ascent();
2998 // FIXME: document this mess
3000 if (sl.pos() > 0 && dit.depth() == 1) {
3002 if (pos && dit.boundary())
3004 // lyxerr << "coordOffset: boundary:" << dit.boundary() << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
3005 rend = pm.pos2row(pos);
3007 rend = pm.pos2row(sl.pos());
3009 size_t rend = pm.pos2row(sl.pos());
3011 for (size_t rit = 0; rit != rend; ++rit)
3012 y += pm.rows()[rit].height();
3013 y += pm.rows()[rend].ascent();
3015 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
3017 // Make relative position from the nested inset now bufferview absolute.
3018 int xx = bottom_tm.cursorX(dit.bottom(), dit.boundary() && dit.depth() == 1);
3021 // In the RTL case place the nested inset at the left of the cursor in
3022 // the outer paragraph
3023 bool boundary_1 = dit.boundary() && 1 == dit.depth();
3024 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
3032 Point BufferView::getPos(DocIterator const & dit) const
3034 if (!paragraphVisible(dit))
3035 return Point(-1, -1);
3037 CursorSlice const & bot = dit.bottom();
3038 TextMetrics const & tm = textMetrics(bot.text());
3040 // offset from outer paragraph
3041 Point p = coordOffset(dit);
3042 p.y_ += tm.parMetrics(bot.pit()).position();
3047 bool BufferView::paragraphVisible(DocIterator const & dit) const
3049 CursorSlice const & bot = dit.bottom();
3050 TextMetrics const & tm = textMetrics(bot.text());
3052 return tm.contains(bot.pit());
3056 void BufferView::caretPosAndDim(Point & p, Dimension & dim) const
3058 Cursor const & cur = cursor();
3059 if (cur.inMathed()) {
3060 MathRow const & mrow = mathRow(&cur.cell());
3061 dim = mrow.caret_dim;
3063 Font const font = cur.real_current_font;
3064 frontend::FontMetrics const & fm = theFontMetrics(font);
3065 dim.wid = fm.lineWidth();
3066 dim.asc = fm.maxAscent();
3067 dim.des = fm.maxDescent();
3069 if (lyxrc.cursor_width > 0)
3070 dim.wid = lyxrc.cursor_width;
3073 // center fat carets horizontally
3074 p.x_ -= dim.wid / 2;
3080 void BufferView::buildCaretGeometry(bool complet)
3084 caretPosAndDim(p, dim);
3086 Cursor const & cur = d->cursor_;
3087 Font const & realfont = cur.real_current_font;
3088 frontend::FontMetrics const & fm = theFontMetrics(realfont.fontInfo());
3089 bool const isrtl = realfont.isVisibleRightToLeft();
3090 int const dir = isrtl ? -1 : 1;
3092 frontend::CaretGeometry & cg = d->caret_geometry_;
3095 // The caret itself, slanted for italics in text edit mode except
3096 // for selections because the selection rect does not slant
3097 bool const slant = fm.italic() && cur.inTexted() && !cur.selection();
3098 double const slope = slant ? fm.italicSlope() : 0;
3099 cg.shapes.push_back(
3100 {{iround(p.x_ + dim.asc * slope), p.y_},
3101 {iround(p.x_ - dim.des * slope), p.y_ + dim.height()},
3102 {iround(p.x_ + dir * dim.wid - dim.des * slope), p.y_ + dim.height()},
3103 {iround(p.x_ + dir * dim.wid + dim.asc * slope), p.y_}}
3106 // The language indicator _| (if needed)
3107 Language const * doclang = buffer().params().language;
3108 if (!((realfont.language() == doclang && isrtl == doclang->rightToLeft())
3109 || realfont.language() == latex_language)) {
3110 int const lx = dim.height() / 3;
3111 int const xx = iround(p.x_ - dim.des * slope);
3112 int const yy = p.y_ + dim.height();
3113 cg.shapes.push_back(
3114 {{xx, yy - dim.wid},
3115 {xx + dir * (dim.wid + lx - 1), yy - dim.wid},
3116 {xx + dir * (dim.wid + lx - 1), yy},
3121 // The completion triangle |> (if needed)
3123 int const m = p.y_ + dim.height() / 2;
3124 int const d = dim.height() / 8;
3125 // offset for slanted carret
3126 int const sx = iround((dim.asc - (dim.height() / 2 - d)) * slope);
3127 // starting position x
3128 int const xx = p.x_ + dir * dim.wid + sx;
3129 cg.shapes.push_back(
3133 {xx, m + d - dim.wid},
3134 {xx + dir * d - dim.wid, m},
3135 {xx, m - d + dim.wid}}
3139 // compute extremal x values
3141 cg.right = -1000000;
3143 cg.bottom = -1000000;
3144 for (auto const & shape : cg.shapes)
3145 for (Point const & p : shape) {
3146 cg.left = min(cg.left, p.x_);
3147 cg.right = max(cg.right, p.x_);
3148 cg.top = min(cg.top, p.y_);
3149 cg.bottom = max(cg.bottom, p.y_);
3154 frontend::CaretGeometry const & BufferView::caretGeometry() const
3156 return d->caret_geometry_;
3160 bool BufferView::caretInView() const
3162 if (!paragraphVisible(cursor()))
3166 caretPosAndDim(p, dim);
3168 // does the cursor touch the screen ?
3169 if (p.y_ + dim.height() < 0 || p.y_ >= workHeight())
3175 int BufferView::horizScrollOffset() const
3177 return d->horiz_scroll_offset_;
3181 int BufferView::horizScrollOffset(Text const * text,
3182 pit_type pit, pos_type pos) const
3184 // Is this a row that is currently scrolled?
3185 if (!d->current_row_slice_.empty()
3186 && &text->inset() == d->current_row_slice_.inset().asInsetText()
3187 && pit == d->current_row_slice_.pit()
3188 && pos == d->current_row_slice_.pos())
3189 return d->horiz_scroll_offset_;
3194 void BufferView::setCurrentRowSlice(CursorSlice const & rowSlice)
3196 // nothing to do if the cursor was already on this row
3197 if (d->current_row_slice_ == rowSlice)
3200 // if the (previous) current row was scrolled, we have to
3201 // remember it in order to repaint it next time.
3202 if (d->horiz_scroll_offset_ != 0) {
3203 // search the old row in cache and mark it changed
3204 for (auto & tm_pair : d->text_metrics_) {
3205 if (&tm_pair.first->inset() == rowSlice.inset().asInsetText()) {
3206 tm_pair.second.setRowChanged(rowSlice.pit(), rowSlice.pos());
3207 // We found it, no need to continue.
3213 // Since we changed row, the scroll offset is not valid anymore
3214 d->horiz_scroll_offset_ = 0;
3215 d->current_row_slice_ = rowSlice;
3219 void BufferView::checkCursorScrollOffset()
3221 CursorSlice rowSlice = d->cursor_.bottom();
3222 TextMetrics const & tm = textMetrics(rowSlice.text());
3224 // Stop if metrics have not been computed yet, since it means
3225 // that there is nothing to do.
3226 if (!tm.contains(rowSlice.pit()))
3228 ParagraphMetrics const & pm = tm.parMetrics(rowSlice.pit());
3229 Row const & row = pm.getRow(rowSlice.pos(),
3230 d->cursor_.boundary() && rowSlice == d->cursor_.top());
3231 rowSlice.pos() = row.pos();
3233 // Set the row on which the cursor lives.
3234 setCurrentRowSlice(rowSlice);
3236 // Current x position of the cursor in pixels
3237 int cur_x = getPos(d->cursor_).x_;
3239 // Horizontal scroll offset of the cursor row in pixels
3240 int offset = d->horiz_scroll_offset_;
3241 int const MARGIN = 2 * theFontMetrics(d->cursor_.real_current_font).em()
3243 if (row.right_x() <= workWidth() - row.right_margin) {
3244 // Row is narrower than the work area, no offset needed.
3247 if (cur_x - offset < MARGIN) {
3248 // cursor would be too far right
3249 offset = cur_x - MARGIN;
3250 } else if (cur_x - offset > workWidth() - MARGIN) {
3251 // cursor would be too far left
3252 offset = cur_x - workWidth() + MARGIN;
3254 // Correct the offset to make sure that we do not scroll too much
3257 if (row.right_x() - offset < workWidth() - row.right_margin)
3258 offset = row.right_x() - workWidth() + row.right_margin;
3261 //lyxerr << "cur_x=" << cur_x << ", offset=" << offset << ", row.wid=" << row.width() << ", margin=" << MARGIN << endl;
3263 if (offset != d->horiz_scroll_offset_)
3264 LYXERR(Debug::PAINTING, "Horiz. scroll offset changed from "
3265 << d->horiz_scroll_offset_ << " to " << offset);
3267 if (d->update_strategy_ == NoScreenUpdate
3268 && offset != d->horiz_scroll_offset_) {
3269 // FIXME: if one uses SingleParUpdate, then home/end
3270 // will not work on long rows. Why?
3271 d->update_strategy_ = FullScreenUpdate;
3274 d->horiz_scroll_offset_ = offset;
3278 void BufferView::draw(frontend::Painter & pain, bool paint_caret)
3280 if (height_ == 0 || width_ == 0)
3282 LYXERR(Debug::PAINTING, (pain.isNull() ? "\t\t--- START NODRAW ---"
3283 : "\t\t*** START DRAWING ***"));
3284 Text & text = buffer_.text();
3285 TextMetrics const & tm = d->text_metrics_[&text];
3286 int const y = tm.first().second->position();
3287 PainterInfo pi(this, pain);
3289 // Check whether the row where the cursor lives needs to be scrolled.
3290 // Update the drawing strategy if needed.
3291 checkCursorScrollOffset();
3293 switch (d->update_strategy_) {
3295 case NoScreenUpdate:
3296 // no screen painting is actually needed. In nodraw stage
3297 // however, the different coordinates of insets and paragraphs
3298 // needs to be updated.
3299 LYXERR(Debug::PAINTING, "Strategy: NoScreenUpdate");
3300 if (pain.isNull()) {
3301 pi.full_repaint = true;
3304 pi.full_repaint = false;
3309 case SingleParUpdate:
3310 pi.full_repaint = false;
3311 LYXERR(Debug::PAINTING, "Strategy: SingleParUpdate");
3312 // In general, only the current row of the outermost paragraph
3313 // will be redrawn. Particular cases where selection spans
3314 // multiple paragraph are correctly detected in TextMetrics.
3318 case DecorationUpdate:
3319 // FIXME: We should also distinguish DecorationUpdate to avoid text
3320 // drawing if possible. This is not possible to do easily right now
3321 // because of the single backing pixmap.
3323 case FullScreenUpdate:
3325 LYXERR(Debug::PAINTING,
3326 ((d->update_strategy_ == FullScreenUpdate)
3327 ? "Strategy: FullScreenUpdate"
3328 : "Strategy: DecorationUpdate"));
3330 // The whole screen, including insets, will be refreshed.
3331 pi.full_repaint = true;
3333 // Clear background.
3334 pain.fillRectangle(0, 0, width_, height_,
3335 pi.backgroundColor(&buffer_.inset()));
3340 // and possibly grey out below
3341 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3342 int const y2 = lastpm.second->position() + lastpm.second->descent();
3345 Color color = buffer().isInternal()
3346 ? Color_background : Color_bottomarea;
3347 pain.fillRectangle(0, y2, width_, height_ - y2, color);
3351 LYXERR(Debug::PAINTING, (pain.isNull() ? "\t\t --- END NODRAW ---"
3352 : "\t\t *** END DRAWING ***"));
3354 // The scrollbar needs an update.
3355 // FIXME: does it always? see ticket #11947.
3358 // Normalize anchor for next time
3359 pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
3360 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3361 for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
3362 ParagraphMetrics const & pm = tm.parMetrics(pit);
3363 if (pm.position() + pm.descent() > 0) {
3364 if (d->anchor_pit_ != pit
3365 || d->anchor_ypos_ != pm.position())
3366 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
3367 << " anchor ypos = " << d->anchor_ypos_);
3368 d->anchor_pit_ = pit;
3369 d->anchor_ypos_ = pm.position();
3373 if (!pain.isNull()) {
3374 // reset the update flags, everything has been done
3375 d->update_flags_ = Update::None;
3378 // If a caret has to be painted, mark its text row as dirty to
3379 //make sure that it will be repainted on next redraw.
3380 /* FIXME: investigate whether this can be avoided when the cursor did not
3384 Cursor cur(d->cursor_);
3385 while (cur.depth() > 1) {
3386 if (!cur.inTexted())
3388 TextMetrics const & tm = textMetrics(cur.text());
3389 if (d->caret_geometry_.left >= tm.origin().x_
3390 && d->caret_geometry_.right <= tm.origin().x_ + tm.dim().width())
3394 cur.textRow().changed(true);
3399 void BufferView::message(docstring const & msg)
3402 d->gui_->message(msg);
3406 void BufferView::showDialog(string const & name)
3409 d->gui_->showDialog(name, string());
3413 void BufferView::showDialog(string const & name,
3414 string const & data, Inset * inset)
3417 d->gui_->showDialog(name, data, inset);
3421 void BufferView::updateDialog(string const & name, string const & data)
3424 d->gui_->updateDialog(name, data);
3428 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
3434 // FIXME: Move this out of BufferView again
3435 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
3437 if (!fname.isReadableFile()) {
3438 docstring const error = from_ascii(strerror(errno));
3439 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3440 docstring const text =
3441 bformat(_("Could not read the specified document\n"
3442 "%1$s\ndue to the error: %2$s"), file, error);
3443 Alert::error(_("Could not read file"), text);
3447 if (!fname.isReadableFile()) {
3448 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3449 docstring const text =
3450 bformat(_("%1$s\n is not readable."), file);
3451 Alert::error(_("Could not open file"), text);
3455 // FIXME UNICODE: We don't know the encoding of the file
3456 docstring file_content = fname.fileContents("UTF-8");
3457 if (file_content.empty()) {
3458 Alert::error(_("Reading not UTF-8 encoded file"),
3459 _("The file is not UTF-8 encoded.\n"
3460 "It will be read as local 8Bit-encoded.\n"
3461 "If this does not give the correct result\n"
3462 "then please change the encoding of the file\n"
3463 "to UTF-8 with a program other than LyX.\n"));
3464 file_content = fname.fileContents("local8bit");
3467 return normalize_c(file_content);
3471 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
3473 docstring const tmpstr = contentsOfPlaintextFile(f);
3478 Cursor & cur = cursor();
3479 cap::replaceSelection(cur);
3480 buffer_.undo().recordUndo(cur);
3482 cur.innerText()->insertStringAsParagraphs(cur, tmpstr, cur.current_font);
3484 cur.innerText()->insertStringAsLines(cur, tmpstr, cur.current_font);
3486 buffer_.changed(true);
3490 docstring const & BufferView::inlineCompletion() const
3492 return d->inlineCompletion_;
3496 size_t BufferView::inlineCompletionUniqueChars() const
3498 return d->inlineCompletionUniqueChars_;
3502 DocIterator const & BufferView::inlineCompletionPos() const
3504 return d->inlineCompletionPos_;
3508 void BufferView::resetInlineCompletionPos()
3510 d->inlineCompletionPos_ = DocIterator();
3514 bool samePar(DocIterator const & a, DocIterator const & b)
3516 if (a.empty() && b.empty())
3518 if (a.empty() || b.empty())
3520 if (a.depth() != b.depth())
3522 return &a.innerParagraph() == &b.innerParagraph();
3526 void BufferView::setInlineCompletion(Cursor const & cur, DocIterator const & pos,
3527 docstring const & completion, size_t uniqueChars)
3529 uniqueChars = min(completion.size(), uniqueChars);
3530 bool changed = d->inlineCompletion_ != completion
3531 || d->inlineCompletionUniqueChars_ != uniqueChars;
3532 bool singlePar = true;
3533 d->inlineCompletion_ = completion;
3534 d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
3536 //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
3539 DocIterator const & old = d->inlineCompletionPos_;
3541 //lyxerr << "inlineCompletionPos changed" << std::endl;
3542 // old or pos are in another paragraph?
3543 if ((!samePar(cur, pos) && !pos.empty())
3544 || (!samePar(cur, old) && !old.empty())) {
3546 //lyxerr << "different paragraph" << std::endl;
3548 d->inlineCompletionPos_ = pos;
3553 if (singlePar && !(cur.result().screenUpdate() & Update::Force))
3554 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
3556 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::Force);
3561 bool BufferView::clickableInset() const
3563 return d->clickable_inset_;