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 search string for simple search
278 docstring 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 Row const & row = pm.getRow(cs.pos(), dit.boundary());
963 Dimension row_dim = row.dim();
964 // FIXME: the will not be necessary anymore if Row has both a
965 // dim() which is its full dimension and a contentsDim() which
966 // is the dimension of the text only.
967 if (&row == &pm.rows().front())
968 row_dim.asc = pm.ascent();
969 if (&row == &pm.rows().back())
970 row_dim.des = pm.descent();
973 scrolled = scroll(ypos - height_/2);
975 // We try to visualize the whole row, if the row height is larger than
976 // the screen height, we scroll to a heuristic value of height_ / 4.
977 // FIXME: This heuristic value should be replaced by a recursive search
978 // for a row in the inset that can be visualized completely.
979 else if (row_dim.height() > height_) {
980 if (ypos < defaultRowHeight())
981 scrolled = scroll(ypos - height_ / 4);
982 else if (ypos > height_ - defaultRowHeight())
983 scrolled = scroll(ypos - 3 * height_ / 4);
986 // If the top part of the row falls of the screen, we scroll
987 // up to align the top of the row with the top of the screen.
988 else if (ypos - row_dim.ascent() < 0 && ypos < height_) {
989 int ynew = row_dim.ascent();
990 scrolled = scrollUp(ynew - ypos);
993 // If the bottom of the row falls of the screen, we scroll down.
994 else if (ypos + row_dim.descent() > height_ && ypos > 0) {
995 int ynew = height_ - row_dim.descent();
996 scrolled = scrollDown(ypos - ynew);
999 // else, nothing to do, the cursor is already visible so we just return.
1000 return scrolled != 0;
1003 // fix inline completion position
1004 if (d->inlineCompletionPos_.fixIfBroken())
1005 d->inlineCompletionPos_ = DocIterator();
1007 tm.redoParagraph(bot_pit);
1008 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
1009 int offset = coordOffset(dit).y_;
1011 d->anchor_pit_ = bot_pit;
1012 CursorSlice const & cs = dit.innerTextSlice();
1013 Dimension const & row_dim =
1014 pm.getRow(cs.pos(), dit.boundary()).dim();
1017 d->anchor_ypos_ = height_/2;
1018 else if (d->anchor_pit_ == 0)
1019 d->anchor_ypos_ = offset + pm.ascent();
1020 else if (d->anchor_pit_ == max_pit)
1021 d->anchor_ypos_ = height_ - offset - row_dim.descent();
1022 else if (offset > height_)
1023 d->anchor_ypos_ = height_ - offset - defaultRowHeight();
1025 d->anchor_ypos_ = defaultRowHeight() * 2;
1031 void BufferView::makeDocumentClass()
1033 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1034 buffer_.params().makeDocumentClass(buffer_.isClone(), buffer_.isInternal());
1035 updateDocumentClass(olddc);
1039 void BufferView::updateDocumentClass(DocumentClassConstPtr olddc)
1041 message(_("Converting document to new document class..."));
1043 StableDocIterator backcur(d->cursor_);
1044 ErrorList & el = buffer_.errorList("Class Switch");
1045 cap::switchBetweenClasses(
1046 olddc, buffer_.params().documentClassPtr(),
1047 static_cast<InsetText &>(buffer_.inset()), el);
1049 setCursor(backcur.asDocIterator(&buffer_));
1051 buffer_.errors("Class Switch");
1055 /** Return the change status at cursor position, taking into account the
1056 * status at each level of the document iterator (a table in a deleted
1057 * footnote is deleted).
1058 * When \param outer is true, the top slice is not looked at.
1060 static Change::Type lookupChangeType(DocIterator const & dit, bool outer = false)
1062 size_t const depth = dit.depth() - (outer ? 1 : 0);
1064 for (size_t i = 0 ; i < depth ; ++i) {
1065 CursorSlice const & slice = dit[i];
1066 if (!slice.inset().inMathed()
1067 && slice.pos() < slice.paragraph().size()) {
1068 Change::Type const ch = slice.paragraph().lookupChange(slice.pos()).type;
1069 if (ch != Change::UNCHANGED)
1073 return Change::UNCHANGED;
1077 bool BufferView::getStatus(FuncRequest const & cmd, FuncStatus & flag)
1079 FuncCode const act = cmd.action();
1081 // Can we use a readonly buffer?
1082 if (buffer_.isReadonly()
1083 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1084 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1085 if (buffer_.hasReadonlyFlag())
1086 flag.message(from_utf8(N_("Document is read-only")));
1088 flag.message(from_utf8(N_("Document has been modified externally")));
1089 flag.setEnabled(false);
1093 // Are we in a DELETED change-tracking region?
1094 if (lookupChangeType(d->cursor_, true) == Change::DELETED
1095 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1096 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1097 flag.message(from_utf8(N_("This portion of the document is deleted.")));
1098 flag.setEnabled(false);
1102 Cursor & cur = d->cursor_;
1104 if (cur.getStatus(cmd, flag))
1109 // FIXME: This is a bit problematic because we don't check if this is
1110 // a document BufferView or not for these LFUNs. We probably have to
1111 // dispatch both to currentBufferView() and, if that fails,
1112 // to documentBufferView(); same as we do now for current Buffer and
1113 // document Buffer. Ideally those LFUN should go to Buffer as they
1114 // operate on the full Buffer and the cursor is only needed either for
1115 // an Undo record or to restore a cursor position. But we don't know
1116 // how to do that inside Buffer of course.
1117 case LFUN_BUFFER_PARAMS_APPLY:
1118 case LFUN_LAYOUT_MODULES_CLEAR:
1119 case LFUN_LAYOUT_MODULE_ADD:
1120 case LFUN_LAYOUT_RELOAD:
1121 case LFUN_TEXTCLASS_APPLY:
1122 case LFUN_TEXTCLASS_LOAD:
1123 flag.setEnabled(!buffer_.isReadonly());
1127 // We do not use the LyXAction flag for readonly because Undo sets the
1128 // buffer clean/dirty status by itself.
1129 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasUndoStack());
1132 // We do not use the LyXAction flag for readonly because Redo sets the
1133 // buffer clean/dirty status by itself.
1134 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasRedoStack());
1136 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
1137 case LFUN_FILE_INSERT_PLAINTEXT: {
1138 docstring const & fname = cmd.argument();
1139 if (!FileName::isAbsolute(to_utf8(fname))) {
1140 flag.message(_("Absolute filename expected."));
1143 flag.setEnabled(cur.inTexted());
1146 case LFUN_FILE_INSERT:
1147 case LFUN_BOOKMARK_SAVE:
1148 // FIXME: Actually, these LFUNS should be moved to Text
1149 flag.setEnabled(cur.inTexted());
1152 case LFUN_FONT_STATE:
1153 case LFUN_LABEL_INSERT:
1154 case LFUN_INFO_INSERT:
1155 case LFUN_PARAGRAPH_GOTO:
1156 case LFUN_NOTE_NEXT:
1157 case LFUN_REFERENCE_NEXT:
1158 case LFUN_WORD_FIND:
1159 case LFUN_WORD_FIND_FORWARD:
1160 case LFUN_WORD_FIND_BACKWARD:
1161 case LFUN_WORD_REPLACE:
1164 case LFUN_MARK_TOGGLE:
1165 case LFUN_SEARCH_STRING_SET:
1166 case LFUN_SCREEN_RECENTER:
1167 case LFUN_SCREEN_SHOW_CURSOR:
1168 case LFUN_BIBTEX_DATABASE_ADD:
1169 case LFUN_BIBTEX_DATABASE_DEL:
1170 case LFUN_STATISTICS:
1171 case LFUN_KEYMAP_OFF:
1172 case LFUN_KEYMAP_PRIMARY:
1173 case LFUN_KEYMAP_SECONDARY:
1174 case LFUN_KEYMAP_TOGGLE:
1175 case LFUN_INSET_SELECT_ALL:
1176 flag.setEnabled(true);
1179 case LFUN_GRAPHICS_UNIFY:
1180 flag.setEnabled(cur.countInsetsInSelection(GRAPHICS_CODE)>1);
1183 case LFUN_WORD_FINDADV: {
1184 FindAndReplaceOptions opt;
1185 istringstream iss(to_utf8(cmd.argument()));
1187 flag.setEnabled(opt.repl_buf_name.empty()
1188 || !buffer_.isReadonly());
1192 case LFUN_LABEL_GOTO:
1193 flag.setEnabled(!cmd.argument().empty()
1194 || getInsetByCode<InsetRef>(cur, REF_CODE));
1197 case LFUN_CHANGES_MERGE:
1198 case LFUN_CHANGE_NEXT:
1199 case LFUN_CHANGE_PREVIOUS:
1200 case LFUN_ALL_CHANGES_ACCEPT:
1201 case LFUN_ALL_CHANGES_REJECT:
1202 flag.setEnabled(buffer_.areChangesPresent());
1205 case LFUN_SCREEN_UP:
1206 case LFUN_SCREEN_DOWN:
1208 case LFUN_SCREEN_UP_SELECT:
1209 case LFUN_SCREEN_DOWN_SELECT:
1210 case LFUN_INSET_FORALL:
1211 flag.setEnabled(true);
1214 case LFUN_LAYOUT_TABULAR:
1215 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
1219 flag.setEnabled(!cur.inset().forcePlainLayout(cur.idx()));
1222 case LFUN_LAYOUT_PARAGRAPH:
1223 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
1226 case LFUN_BRANCH_ADD_INSERT:
1227 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1230 case LFUN_DIALOG_SHOW_NEW_INSET:
1231 // FIXME: this is wrong, but I do not understand the
1233 if (cur.inset().lyxCode() == CAPTION_CODE)
1234 return cur.inset().getStatus(cur, cmd, flag);
1235 // FIXME we should consider passthru paragraphs too.
1236 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1239 case LFUN_CITATION_INSERT: {
1240 FuncRequest fr(LFUN_INSET_INSERT, "citation");
1241 // FIXME: This could turn in a recursive hell.
1242 // Shouldn't we use Buffer::getStatus() instead?
1243 flag.setEnabled(lyx::getStatus(fr).enabled());
1246 case LFUN_INSET_APPLY: {
1247 string const name = cmd.getArg(0);
1248 Inset * inset = editedInset(name);
1250 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1251 if (!inset->getStatus(cur, fr, flag)) {
1252 // Every inset is supposed to handle this
1253 LASSERT(false, break);
1256 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1257 flag = lyx::getStatus(fr);
1263 flag.setEnabled(cur.selection());
1274 Inset * BufferView::editedInset(string const & name) const
1276 map<string, Inset *>::const_iterator it = d->edited_insets_.find(name);
1277 return it == d->edited_insets_.end() ? nullptr : it->second;
1281 void BufferView::editInset(string const & name, Inset * inset)
1284 d->edited_insets_[name] = inset;
1286 d->edited_insets_.erase(name);
1290 void BufferView::dispatch(FuncRequest const & cmd, DispatchResult & dr)
1292 LYXERR(Debug::ACTION, "BufferView::dispatch: cmd: " << cmd);
1294 string const argument = to_utf8(cmd.argument());
1295 Cursor & cur = d->cursor_;
1298 // Don't dispatch function that does not apply to internal buffers.
1299 if (buffer_.isInternal()
1300 && lyxaction.funcHasFlag(cmd.action(), LyXAction::NoInternal))
1303 // We'll set this back to false if need be.
1304 bool dispatched = true;
1305 buffer_.undo().beginUndoGroup();
1307 FuncCode const act = cmd.action();
1310 case LFUN_BUFFER_PARAMS_APPLY: {
1311 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1312 cur.recordUndoBufferParams();
1313 istringstream ss(to_utf8(cmd.argument()));
1316 int const unknown_tokens = buffer_.readHeader(lex);
1317 if (unknown_tokens != 0) {
1318 LYXERR0("Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1319 << unknown_tokens << " unknown token"
1320 << (unknown_tokens == 1 ? "" : "s"));
1322 updateDocumentClass(olddc);
1324 // We are most certainly here because of a change in the document
1325 // It is then better to make sure that all dialogs are in sync with
1326 // current document settings.
1327 dr.screenUpdate(Update::Force | Update::FitCursor);
1328 dr.forceBufferUpdate();
1332 case LFUN_LAYOUT_MODULES_CLEAR: {
1333 // FIXME: this modifies the document in cap::switchBetweenClasses
1334 // without calling recordUndo. Fix this before using
1335 // recordUndoBufferParams().
1336 cur.recordUndoFullBuffer();
1337 buffer_.params().clearLayoutModules();
1338 makeDocumentClass();
1339 dr.screenUpdate(Update::Force);
1340 dr.forceBufferUpdate();
1344 case LFUN_LAYOUT_MODULE_ADD: {
1345 BufferParams const & params = buffer_.params();
1346 if (!params.layoutModuleCanBeAdded(argument)) {
1347 LYXERR0("Module `" << argument <<
1348 "' cannot be added due to failed requirements or "
1349 "conflicts with installed modules.");
1352 // FIXME: this modifies the document in cap::switchBetweenClasses
1353 // without calling recordUndo. Fix this before using
1354 // recordUndoBufferParams().
1355 cur.recordUndoFullBuffer();
1356 buffer_.params().addLayoutModule(argument);
1357 makeDocumentClass();
1358 dr.screenUpdate(Update::Force);
1359 dr.forceBufferUpdate();
1363 case LFUN_TEXTCLASS_APPLY: {
1364 // since this shortcircuits, the second call is made only if
1366 bool const success =
1367 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1368 LayoutFileList::get().load(argument, buffer_.filePath());
1370 docstring s = bformat(_("The document class `%1$s' "
1371 "could not be loaded."), from_utf8(argument));
1372 frontend::Alert::error(_("Could not load class"), s);
1376 LayoutFile const * old_layout = buffer_.params().baseClass();
1377 LayoutFile const * new_layout = &(LayoutFileList::get()[argument]);
1379 if (old_layout == new_layout)
1383 // Save the old, possibly modular, layout for use in conversion.
1384 // FIXME: this modifies the document in cap::switchBetweenClasses
1385 // without calling recordUndo. Fix this before using
1386 // recordUndoBufferParams().
1387 cur.recordUndoFullBuffer();
1388 buffer_.params().setBaseClass(argument, buffer_.layoutPos());
1389 makeDocumentClass();
1390 dr.screenUpdate(Update::Force);
1391 dr.forceBufferUpdate();
1395 case LFUN_TEXTCLASS_LOAD: {
1396 // since this shortcircuits, the second call is made only if
1398 bool const success =
1399 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1400 LayoutFileList::get().load(argument, buffer_.filePath());
1402 docstring s = bformat(_("The document class `%1$s' "
1403 "could not be loaded."), from_utf8(argument));
1404 frontend::Alert::error(_("Could not load class"), s);
1409 case LFUN_LAYOUT_RELOAD: {
1410 LayoutFileIndex bc = buffer_.params().baseClassID();
1411 LayoutFileList::get().reset(bc);
1412 buffer_.params().setBaseClass(bc, buffer_.layoutPos());
1413 makeDocumentClass();
1414 dr.screenUpdate(Update::Force);
1415 dr.forceBufferUpdate();
1420 dr.setMessage(_("Undo"));
1421 cur.clearSelection();
1422 // We need to find out if the bibliography information
1423 // has changed. See bug #11055.
1424 // So these should not be references...
1425 string const engine = buffer().params().citeEngine();
1426 CiteEngineType const enginetype = buffer().params().citeEngineType();
1427 if (!cur.undoAction())
1428 dr.setMessage(_("No further undo information"));
1430 dr.screenUpdate(Update::Force | Update::FitCursor);
1431 dr.forceBufferUpdate();
1432 if (buffer().params().citeEngine() != engine ||
1433 buffer().params().citeEngineType() != enginetype)
1434 buffer().invalidateCiteLabels();
1440 dr.setMessage(_("Redo"));
1441 cur.clearSelection();
1442 // We need to find out if the bibliography information
1443 // has changed. See bug #11055.
1444 // So these should not be references...
1445 string const engine = buffer().params().citeEngine();
1446 CiteEngineType const enginetype = buffer().params().citeEngineType();
1447 if (!cur.redoAction())
1448 dr.setMessage(_("No further redo information"));
1450 dr.screenUpdate(Update::Force | Update::FitCursor);
1451 dr.forceBufferUpdate();
1452 if (buffer().params().citeEngine() != engine ||
1453 buffer().params().citeEngineType() != enginetype)
1454 buffer().invalidateCiteLabels();
1459 case LFUN_FONT_STATE:
1460 dr.setMessage(cur.currentState(false));
1463 case LFUN_BOOKMARK_SAVE:
1464 dr.screenUpdate(Update::Force);
1465 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1468 case LFUN_LABEL_GOTO: {
1469 docstring label = cmd.argument();
1470 if (label.empty()) {
1472 getInsetByCode<InsetRef>(cur, REF_CODE);
1474 label = inset->getParam("reference");
1475 // persistent=false: use temp_bookmark
1479 if (!label.empty()) {
1481 // at the moment, this is redundant, since gotoLabel will
1482 // eventually call LFUN_PARAGRAPH_GOTO, but it seems best
1484 dr.screenUpdate(Update::Force | Update::FitCursor);
1489 case LFUN_PARAGRAPH_GOTO: {
1490 int const id = convert<int>(cmd.getArg(0));
1491 pos_type const pos = convert<int>(cmd.getArg(1));
1494 string const str_id_end = cmd.getArg(2);
1495 string const str_pos_end = cmd.getArg(3);
1497 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1498 b = theBufferList().next(b)) {
1501 curs.setCursor(b->getParFromID(id));
1503 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1507 LYXERR(Debug::INFO, "Paragraph " << curs.paragraph().id()
1508 << " found in buffer `"
1509 << b->absFileName() << "'.");
1511 if (b == &buffer_) {
1513 if (str_id_end.empty() || str_pos_end.empty()) {
1516 mouseSetCursor(curs);
1519 int const id_end = convert<int>(str_id_end);
1520 pos_type const pos_end = convert<int>(str_pos_end);
1521 success = setCursorFromEntries({id, pos},
1525 dr.screenUpdate(Update::Force | Update::FitCursor);
1527 // Switch to other buffer view and resend cmd
1528 lyx::dispatch(FuncRequest(
1529 LFUN_BUFFER_SWITCH, b->absFileName()));
1537 case LFUN_NOTE_NEXT:
1538 gotoInset(this, { NOTE_CODE }, false);
1539 // FIXME: if SinglePar is changed to act on the inner
1540 // paragraph, this will not be OK anymore. The update is
1541 // useful for auto-open collapsible insets.
1542 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1545 case LFUN_REFERENCE_NEXT: {
1546 gotoInset(this, { LABEL_CODE, REF_CODE }, true);
1547 // FIXME: if SinglePar is changed to act on the inner
1548 // paragraph, this will not be OK anymore. The update is
1549 // useful for auto-open collapsible insets.
1550 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1554 case LFUN_CHANGE_NEXT:
1555 findNextChange(this);
1556 if (cur.inset().isTable())
1557 // In tables, there might be whole changed rows or columns
1559 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1560 dr.screenUpdate(Update::Force | Update::FitCursor);
1563 case LFUN_CHANGE_PREVIOUS:
1564 findPreviousChange(this);
1565 if (cur.inset().isTable())
1566 // In tables, there might be whole changed rows or columns
1568 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1569 dr.screenUpdate(Update::Force | Update::FitCursor);
1572 case LFUN_CHANGES_MERGE:
1573 if (findNextChange(this) || findPreviousChange(this)) {
1574 dr.screenUpdate(Update::Force | Update::FitCursor);
1575 dr.forceBufferUpdate();
1576 showDialog("changes");
1580 case LFUN_ALL_CHANGES_ACCEPT: {
1581 // select complete document
1583 cur.selHandle(true);
1584 buffer_.text().cursorBottom(cur);
1585 // accept everything in a single step to support atomic undo
1586 // temporarily disable track changes in order to end with really
1587 // no new (e.g., DPSM-caused) changes (see #7487)
1588 bool const track = buffer_.params().track_changes;
1589 buffer_.params().track_changes = false;
1590 buffer_.text().acceptOrRejectChanges(cur, Text::ACCEPT);
1591 buffer_.params().track_changes = track;
1593 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1594 dr.screenUpdate(Update::Force | Update::FitCursor);
1595 dr.forceBufferUpdate();
1599 case LFUN_ALL_CHANGES_REJECT: {
1600 // select complete document
1602 cur.selHandle(true);
1603 buffer_.text().cursorBottom(cur);
1604 // reject everything in a single step to support atomic undo
1605 // temporarily disable track changes in order to end with really
1606 // no new (e.g., DPSM-caused) changes (see #7487)
1607 bool const track = buffer_.params().track_changes;
1608 buffer_.params().track_changes = false;
1609 buffer_.text().acceptOrRejectChanges(cur, Text::REJECT);
1610 buffer_.params().track_changes = track;
1612 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1613 dr.screenUpdate(Update::Force | Update::FitCursor);
1614 dr.forceBufferUpdate();
1618 case LFUN_WORD_FIND_FORWARD:
1619 case LFUN_WORD_FIND_BACKWARD: {
1620 docstring searched_string;
1622 if (!cmd.argument().empty()) {
1623 d->search_request_cache_ = cmd.argument();
1624 searched_string = cmd.argument();
1626 searched_string = d->search_request_cache_;
1629 if (searched_string.empty())
1632 bool const fw = act == LFUN_WORD_FIND_FORWARD;
1633 docstring const data =
1634 find2string(searched_string, true, false, fw);
1635 bool found = lyxfind(this, FuncRequest(LFUN_WORD_FIND, data));
1637 dr.screenUpdate(Update::Force | Update::FitCursor);
1639 dr.setMessage(_("Search string not found!"));
1643 case LFUN_WORD_FIND: {
1644 docstring arg = cmd.argument();
1645 if (arg.empty() && !d->search_request_cache_.empty())
1646 arg = d->search_request_cache_;
1648 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, "findreplace"));
1651 if (lyxfind(this, FuncRequest(act, arg)))
1652 dr.screenUpdate(Update::Force | Update::FitCursor);
1654 dr.setMessage(_("Search string not found!"));
1656 d->search_request_cache_ = arg;
1660 case LFUN_SEARCH_STRING_SET: {
1661 docstring pattern = cmd.argument();
1662 if (!pattern.empty()) {
1663 d->search_request_cache_ = pattern;
1666 if (cur.selection())
1667 pattern = cur.selectionAsString(false);
1669 pos_type spos = cur.pos();
1670 cur.innerText()->selectWord(cur, WHOLE_WORD);
1671 pattern = cur.selectionAsString(false);
1672 cur.selection(false);
1675 d->search_request_cache_ = pattern;
1679 case LFUN_WORD_REPLACE: {
1680 if (lyxreplace(this, cmd)) {
1681 dr.forceBufferUpdate();
1682 dr.screenUpdate(Update::Force | Update::FitCursor);
1685 dr.setMessage(_("Search string not found!"));
1689 case LFUN_WORD_FINDADV: {
1690 FindAndReplaceOptions opt;
1691 istringstream iss(to_utf8(cmd.argument()));
1693 if (findAdv(this, opt)) {
1694 dr.screenUpdate(Update::Force | Update::FitCursor);
1705 cur.clearSelection();
1706 dr.setMessage(from_utf8(N_("Mark off")));
1710 cur.clearSelection();
1712 dr.setMessage(from_utf8(N_("Mark on")));
1715 case LFUN_MARK_TOGGLE:
1716 cur.selection(false);
1719 dr.setMessage(from_utf8(N_("Mark removed")));
1722 dr.setMessage(from_utf8(N_("Mark set")));
1727 case LFUN_SCREEN_SHOW_CURSOR:
1731 case LFUN_SCREEN_RECENTER:
1735 case LFUN_BIBTEX_DATABASE_ADD: {
1736 Cursor tmpcur = cur;
1737 findInset(tmpcur, { BIBTEX_CODE }, false);
1738 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1741 if (inset->addDatabase(cmd.argument()))
1742 dr.forceBufferUpdate();
1747 case LFUN_BIBTEX_DATABASE_DEL: {
1748 Cursor tmpcur = cur;
1749 findInset(tmpcur, { BIBTEX_CODE }, false);
1750 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1753 if (inset->delDatabase(cmd.argument()))
1754 dr.forceBufferUpdate();
1759 case LFUN_GRAPHICS_UNIFY: {
1761 cur.recordUndoFullBuffer();
1763 DocIterator from, to;
1764 from = cur.selectionBegin();
1765 to = cur.selectionEnd();
1767 string const newId = cmd.getArg(0);
1768 bool fetchId = newId.empty(); //if we wait for groupId from first graphics inset
1770 InsetGraphicsParams grp_par;
1772 InsetGraphics::string2params(graphics::getGroupParams(buffer_, newId), buffer_, grp_par);
1774 if (!from.nextInset()) //move to closest inset
1775 from.forwardInset();
1777 while (!from.empty() && from < to) {
1778 Inset * inset = from.nextInset();
1781 InsetGraphics * ig = inset->asInsetGraphics();
1783 InsetGraphicsParams inspar = ig->getParams();
1788 grp_par.filename = inspar.filename;
1789 ig->setParams(grp_par);
1792 from.forwardInset();
1794 dr.screenUpdate(Update::Force); //needed if triggered from context menu
1798 case LFUN_STATISTICS: {
1799 DocIterator from, to;
1800 if (cur.selection()) {
1801 from = cur.selectionBegin();
1802 to = cur.selectionEnd();
1804 from = doc_iterator_begin(&buffer_);
1805 to = doc_iterator_end(&buffer_);
1807 buffer_.updateStatistics(from, to);
1808 int const words = buffer_.wordCount();
1809 int const chars = buffer_.charCount(false);
1810 int const chars_blanks = buffer_.charCount(true);
1812 if (cur.selection())
1813 message = _("Statistics for the selection:");
1815 message = _("Statistics for the document:");
1818 message += bformat(_("%1$d words"), words);
1820 message += _("One word");
1822 if (chars_blanks != 1)
1823 message += bformat(_("%1$d characters (including blanks)"),
1826 message += _("One character (including blanks)");
1829 message += bformat(_("%1$d characters (excluding blanks)"),
1832 message += _("One character (excluding blanks)");
1834 Alert::information(_("Statistics"), message);
1838 case LFUN_SCREEN_UP:
1839 case LFUN_SCREEN_DOWN: {
1840 Point p = getPos(cur);
1841 // This code has been commented out to enable to scroll down a
1842 // document, even if there are large insets in it (see bug #5465).
1843 /*if (p.y_ < 0 || p.y_ > height_) {
1844 // The cursor is off-screen so recenter before proceeding.
1848 int const scrolled = scroll(act == LFUN_SCREEN_UP
1849 ? -height_ : height_);
1850 if (act == LFUN_SCREEN_UP && scrolled > -height_)
1852 if (act == LFUN_SCREEN_DOWN && scrolled < height_)
1853 p = Point(width_, height_);
1854 bool const in_texted = cur.inTexted();
1855 cur.setCursor(doc_iterator_begin(cur.buffer()));
1856 cur.selHandle(false);
1857 // Force an immediate computation of metrics because we need it below
1858 processUpdateFlags(Update::Force);
1860 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_,
1861 true, act == LFUN_SCREEN_UP);
1862 //FIXME: what to do with cur.x_target()?
1863 bool update = in_texted && cur.bv().checkDepm(cur, old);
1866 if (update || cur.mark())
1867 dr.screenUpdate(Update::Force | Update::FitCursor);
1869 dr.forceBufferUpdate();
1874 string const scroll_type = cmd.getArg(0);
1875 int scroll_step = 0;
1876 if (scroll_type == "line")
1877 scroll_step = d->scrollbarParameters_.single_step;
1878 else if (scroll_type == "page")
1879 scroll_step = d->scrollbarParameters_.page_step;
1882 string const scroll_quantity = cmd.getArg(1);
1883 if (scroll_quantity == "up")
1884 scrollUp(scroll_step);
1885 else if (scroll_quantity == "down")
1886 scrollDown(scroll_step);
1888 int const scroll_value = convert<int>(scroll_quantity);
1890 scroll(scroll_step * scroll_value);
1892 dr.screenUpdate(Update::ForceDraw);
1893 dr.forceBufferUpdate();
1897 case LFUN_SCREEN_UP_SELECT: {
1898 // FIXME: why is the algorithm different from LFUN_SCREEN_UP?
1899 cur.selHandle(true);
1900 if (isTopScreen()) {
1901 lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1905 int y = getPos(cur).y_;
1906 int const ymin = y - height_ + defaultRowHeight();
1907 while (y > ymin && cur.up())
1911 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1915 case LFUN_SCREEN_DOWN_SELECT: {
1916 // FIXME: why is the algorithm different from LFUN_SCREEN_DOWN?
1917 cur.selHandle(true);
1918 if (isBottomScreen()) {
1919 lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1923 int y = getPos(cur).y_;
1924 int const ymax = y + height_ - defaultRowHeight();
1925 while (y < ymax && cur.down())
1929 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1934 case LFUN_INSET_SELECT_ALL: {
1935 // true if all cells are selected
1936 bool const all_selected = cur.depth() > 1
1937 && cur.selBegin().at_begin()
1938 && cur.selEnd().at_end();
1939 // true if some cells are selected
1940 bool const cells_selected = cur.depth() > 1
1941 && cur.selBegin().at_cell_begin()
1942 && cur.selEnd().at_cell_end();
1943 if (all_selected || (cells_selected && !cur.inset().isTable())) {
1944 // All the contents of the inset if selected, or only at
1945 // least one cell but inset is not a table.
1946 // Select the inset from outside.
1949 cur.selection(true);
1951 } else if (cells_selected) {
1952 // At least one complete cell is selected and inset is a table.
1958 cur.selection(true);
1959 cur.idx() = cur.lastidx();
1960 cur.pit() = cur.lastpit();
1961 cur.pos() = cur.lastpos();
1963 // select current cell
1967 cur.selection(true);
1968 cur.pit() = cur.lastpit();
1969 cur.pos() = cur.lastpos();
1971 cur.setCurrentFont();
1972 dr.screenUpdate(Update::Force);
1977 case LFUN_UNICODE_INSERT: {
1978 if (cmd.argument().empty())
1981 FuncCode code = cur.inset().currentMode() == Inset::MATH_MODE ?
1982 LFUN_MATH_INSERT : LFUN_SELF_INSERT;
1985 docstring const arg = from_utf8(cmd.getArg(i));
1989 LYXERR0("Not a hexstring: " << arg);
1993 char_type c = hexToInt(arg);
1994 if (c >= 32 && c < 0x10ffff) {
1995 LYXERR(Debug::KEY, "Inserting c: " << c);
1996 lyx::dispatch(FuncRequest(code, docstring(1, c)));
2004 // This would be in Buffer class if only Cursor did not
2005 // require a bufferview
2006 case LFUN_INSET_FORALL: {
2007 docstring const name = from_utf8(cmd.getArg(0));
2008 string const commandstr = cmd.getLongArg(1);
2009 FuncRequest const fr = lyxaction.lookupFunc(commandstr);
2011 // an arbitrary number to limit number of iterations
2012 const int max_iter = 100000;
2014 Cursor & curs = d->cursor_;
2015 Cursor const savecur = curs;
2017 if (!curs.nextInset())
2018 curs.forwardInset();
2019 curs.beginUndoGroup();
2020 while(curs && iterations < max_iter) {
2021 Inset * const ins = curs.nextInset();
2024 docstring insname = ins->layoutName();
2025 while (!insname.empty()) {
2026 if (insname == name || name == from_utf8("*")) {
2028 lyx::dispatch(fr, dr);
2032 size_t const i = insname.rfind(':');
2033 if (i == string::npos)
2035 insname = insname.substr(0, i);
2037 // if we did not delete the inset, skip it
2038 if (!curs.nextInset() || curs.nextInset() == ins)
2039 curs.forwardInset();
2043 /** This is a dummy undo record only to remember the cursor
2044 * that has just been set; this will be used on a redo action
2045 * (see ticket #10097)
2047 * FIXME: a better fix would be to have a way to set the
2048 * cursor value directly, but I am not sure it is worth it.
2051 curs.endUndoGroup();
2052 dr.screenUpdate(Update::Force);
2053 dr.forceBufferUpdate();
2055 if (iterations >= max_iter) {
2057 dr.setMessage(bformat(_("`inset-forall' interrupted because number of actions is larger than %1$d"), max_iter));
2059 dr.setMessage(bformat(_("Applied \"%1$s\" to %2$d insets"), from_utf8(commandstr), iterations));
2064 case LFUN_BRANCH_ADD_INSERT: {
2065 docstring branch_name = from_utf8(cmd.getArg(0));
2066 if (branch_name.empty())
2067 if (!Alert::askForText(branch_name, _("Branch name")) ||
2068 branch_name.empty())
2071 DispatchResult drtmp;
2072 buffer_.dispatch(FuncRequest(LFUN_BRANCH_ADD, branch_name), drtmp);
2073 if (drtmp.error()) {
2074 Alert::warning(_("Branch already exists"), drtmp.message());
2077 docstring const sep = buffer_.params().branchlist().separator();
2078 for (docstring const & branch : getVectorFromString(branch_name, sep))
2079 lyx::dispatch(FuncRequest(LFUN_BRANCH_INSERT, branch));
2083 case LFUN_KEYMAP_OFF:
2084 getIntl().keyMapOn(false);
2087 case LFUN_KEYMAP_PRIMARY:
2088 getIntl().keyMapPrim();
2091 case LFUN_KEYMAP_SECONDARY:
2092 getIntl().keyMapSec();
2095 case LFUN_KEYMAP_TOGGLE:
2096 getIntl().toggleKeyMap();
2099 case LFUN_DIALOG_SHOW_NEW_INSET: {
2100 string const name = cmd.getArg(0);
2101 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
2102 if (decodeInsetParam(name, data, buffer_))
2103 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
2105 lyxerr << "Inset type '" << name <<
2106 "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" << endl;
2110 case LFUN_CITATION_INSERT: {
2111 if (argument.empty()) {
2112 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
2115 // we can have one optional argument, delimited by '|'
2116 // citation-insert <key>|<text_before>
2117 // this should be enhanced to also support text_after
2118 // and citation style
2119 string arg = argument;
2121 if (contains(argument, "|")) {
2122 arg = token(argument, '|', 0);
2123 opt1 = token(argument, '|', 1);
2126 // if our cursor is directly in front of or behind a citation inset,
2127 // we will instead add the new key to it.
2128 Inset * inset = cur.nextInset();
2129 if (!inset || inset->lyxCode() != CITE_CODE)
2130 inset = cur.prevInset();
2131 if (inset && inset->lyxCode() == CITE_CODE) {
2132 InsetCitation * icite = static_cast<InsetCitation *>(inset);
2133 if (icite->addKey(arg)) {
2134 dr.forceBufferUpdate();
2135 dr.screenUpdate(Update::FitCursor | Update::SinglePar);
2137 LYXERR0("Discarding optional argument to citation-insert.");
2142 InsetCommandParams icp(CITE_CODE);
2143 icp["key"] = from_utf8(arg);
2145 icp["before"] = from_utf8(opt1);
2147 from_ascii(InsetCitation::last_literal ? "true" : "false");
2148 string icstr = InsetCommand::params2string(icp);
2149 FuncRequest fr(LFUN_INSET_INSERT, icstr);
2154 case LFUN_INSET_APPLY: {
2155 string const name = cmd.getArg(0);
2156 Inset * inset = editedInset(name);
2158 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
2162 // put cursor in front of inset.
2163 if (!setCursorFromInset(inset)) {
2164 LASSERT(false, break);
2167 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
2168 inset->dispatch(cur, fr);
2169 dr.screenUpdate(cur.result().screenUpdate());
2170 if (cur.result().needBufferUpdate())
2171 dr.forceBufferUpdate();
2176 // The change of language of buffer belongs to the Buffer class.
2177 // We have to do it here because we need a cursor for Undo.
2178 // When Undo::recordUndoBufferParams() is implemented someday
2179 // LFUN_BUFFER_LANGUAGE should be handled by the Buffer class.
2180 case LFUN_BUFFER_LANGUAGE: {
2181 Language const * oldL = buffer_.params().language;
2182 Language const * newL = languages.getLanguage(argument);
2183 if (!newL || oldL == newL)
2185 if (oldL->rightToLeft() == newL->rightToLeft()) {
2186 cur.recordUndoFullBuffer();
2187 buffer_.changeLanguage(oldL, newL);
2188 cur.setCurrentFont();
2189 dr.forceBufferUpdate();
2194 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
2195 case LFUN_FILE_INSERT_PLAINTEXT: {
2196 bool const as_paragraph = (act == LFUN_FILE_INSERT_PLAINTEXT_PARA);
2197 string const fname = to_utf8(cmd.argument());
2198 if (!FileName::isAbsolute(fname))
2199 dr.setMessage(_("Absolute filename expected."));
2201 insertPlaintextFile(FileName(fname), as_paragraph);
2206 cap::copySelection(cur);
2207 cur.message(_("Copy"));
2211 // OK, so try the Buffer itself...
2212 buffer_.dispatch(cmd, dr);
2213 dispatched = dr.dispatched();
2217 buffer_.undo().endUndoGroup();
2218 dr.dispatched(dispatched);
2220 // NOTE: The code below is copied from Cursor::dispatch. If you
2221 // need to modify this, please update the other one too.
2223 // notify insets we just entered/left
2224 if (cursor() != old) {
2225 old.beginUndoGroup();
2227 bool badcursor = notifyCursorLeavesOrEnters(old, cursor());
2229 cursor().fixIfBroken();
2230 resetInlineCompletionPos();
2237 docstring BufferView::requestSelection()
2239 Cursor & cur = d->cursor_;
2241 LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
2242 if (!cur.selection()) {
2243 d->xsel_cache_.set = false;
2247 LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
2248 if (!d->xsel_cache_.set ||
2249 cur.top() != d->xsel_cache_.cursor ||
2250 cur.realAnchor().top() != d->xsel_cache_.anchor)
2252 d->xsel_cache_.cursor = cur.top();
2253 d->xsel_cache_.anchor = cur.realAnchor().top();
2254 d->xsel_cache_.set = cur.selection();
2255 return cur.selectionAsString(false);
2261 void BufferView::clearSelection()
2263 d->cursor_.clearSelection();
2264 // Clear the selection buffer. Otherwise a subsequent
2265 // middle-mouse-button paste would use the selection buffer,
2266 // not the more current external selection.
2267 cap::clearSelection();
2268 d->xsel_cache_.set = false;
2269 // The buffer did not really change, but this causes the
2270 // redraw we need because we cleared the selection above.
2271 buffer_.changed(false);
2275 void BufferView::resize(int width, int height)
2277 // Update from work area
2281 // Clear the paragraph height cache.
2282 d->par_height_.clear();
2283 // Redo the metrics.
2288 Inset const * BufferView::getCoveringInset(Text const & text,
2291 TextMetrics & tm = d->text_metrics_[&text];
2292 Inset * inset = tm.checkInsetHit(x, y);
2296 if (!inset->descendable(*this))
2297 // No need to go further down if the inset is not
2301 size_t cell_number = inset->nargs();
2302 // Check all the inner cell.
2303 for (size_t i = 0; i != cell_number; ++i) {
2304 Text const * inner_text = inset->getText(i);
2307 Inset const * inset_deeper =
2308 getCoveringInset(*inner_text, x, y);
2310 return inset_deeper;
2318 void BufferView::updateHoveredInset() const
2320 // Get inset under mouse, if there is one.
2321 int const x = d->mouse_position_cache_.x_;
2322 int const y = d->mouse_position_cache_.y_;
2323 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
2325 d->clickable_inset_ = covering_inset && covering_inset->clickable(*this, x, y);
2327 if (covering_inset == d->last_inset_)
2328 // Same inset, no need to do anything...
2331 bool need_redraw = false;
2332 if (d->last_inset_) {
2333 // Remove the hint on the last hovered inset (if any).
2334 need_redraw |= d->last_inset_->setMouseHover(this, false);
2335 d->last_inset_ = nullptr;
2338 if (covering_inset && covering_inset->setMouseHover(this, true)) {
2340 // Only the insets that accept the hover state, do
2341 // clear the last_inset_, so only set the last_inset_
2342 // member if the hovered setting is accepted.
2343 d->last_inset_ = covering_inset;
2347 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
2348 << d->mouse_position_cache_.x_ << ", "
2349 << d->mouse_position_cache_.y_ << ")");
2351 d->update_strategy_ = DecorationUpdate;
2353 // This event (moving without mouse click) is not passed further.
2354 // This should be changed if it is further utilized.
2355 buffer_.changed(false);
2360 void BufferView::clearLastInset(Inset * inset) const
2362 if (d->last_inset_ != inset) {
2363 LYXERR0("Wrong last_inset!");
2366 d->last_inset_ = nullptr;
2370 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
2372 //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
2374 // This is only called for mouse related events including
2375 // LFUN_FILE_OPEN generated by drag-and-drop.
2376 FuncRequest cmd = cmd0;
2378 Cursor old = cursor();
2380 cur.push(buffer_.inset());
2381 cur.selection(d->cursor_.selection());
2383 // Either the inset under the cursor or the
2384 // surrounding Text will handle this event.
2386 // make sure we stay within the screen...
2387 cmd.set_y(min(max(cmd.y(), -1), height_));
2389 d->mouse_position_cache_.x_ = cmd.x();
2390 d->mouse_position_cache_.y_ = cmd.y();
2392 if (cmd.action() == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
2393 updateHoveredInset();
2397 // Build temporary cursor.
2398 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x(), cmd.y());
2400 // If inset is not editable, cur.pos() might point behind the
2401 // inset (depending on cmd.x(), cmd.y()). This is needed for
2402 // editing to fix bug 9628, but e.g. the context menu needs a
2403 // cursor in front of the inset.
2404 if ((inset->hasSettings() || !inset->contextMenuName().empty()
2405 || inset->lyxCode() == SEPARATOR_CODE) &&
2406 cur.nextInset() != inset && cur.prevInset() == inset)
2408 } else if (cur.inTexted() && cur.pos()
2409 && cur.paragraph().isEnvSeparator(cur.pos() - 1)) {
2410 // Always place cursor in front of a separator inset.
2414 // Put anchor at the same position.
2417 cur.beginUndoGroup();
2419 // Try to dispatch to an non-editable inset near this position
2420 // via the temp cursor. If the inset wishes to change the real
2421 // cursor it has to do so explicitly by using
2422 // cur.bv().cursor() = cur; (or similar)
2424 inset->dispatch(cur, cmd);
2426 // Now dispatch to the temporary cursor. If the real cursor should
2427 // be modified, the inset's dispatch has to do so explicitly.
2428 if (!inset || !cur.result().dispatched())
2431 // Notify left insets
2433 bool badcursor = old.fixIfBroken() | cur.fixIfBroken();
2434 badcursor |= notifyCursorLeavesOrEnters(old, cur);
2436 cursor().fixIfBroken();
2441 // Do we have a selection?
2442 theSelection().haveSelection(cursor().selection());
2444 if (cur.needBufferUpdate() || buffer().needUpdate()) {
2445 cur.clearBufferUpdate();
2446 buffer().updateBuffer();
2449 // If the command has been dispatched,
2450 if (cur.result().dispatched() || cur.result().screenUpdate())
2451 processUpdateFlags(cur.result().screenUpdate());
2455 int BufferView::minVisiblePart()
2457 return 2 * defaultRowHeight();
2461 int BufferView::scroll(int pixels)
2464 return scrollDown(pixels);
2466 return scrollUp(-pixels);
2471 int BufferView::scrollDown(int pixels)
2473 Text * text = &buffer_.text();
2474 TextMetrics & tm = d->text_metrics_[text];
2475 int const ymax = height_ + pixels;
2477 pair<pit_type, ParagraphMetrics const *> last = tm.last();
2478 int bottom_pos = last.second->position() + last.second->descent();
2479 if (lyxrc.scroll_below_document)
2480 bottom_pos += height_ - minVisiblePart();
2481 if (last.first + 1 == int(text->paragraphs().size())) {
2482 if (bottom_pos <= height_)
2484 pixels = min(pixels, bottom_pos - height_);
2487 if (bottom_pos > ymax)
2489 tm.newParMetricsDown();
2491 d->anchor_ypos_ -= pixels;
2496 int BufferView::scrollUp(int pixels)
2498 Text * text = &buffer_.text();
2499 TextMetrics & tm = d->text_metrics_[text];
2500 int ymin = - pixels;
2502 pair<pit_type, ParagraphMetrics const *> first = tm.first();
2503 int top_pos = first.second->position() - first.second->ascent();
2504 if (first.first == 0) {
2507 pixels = min(pixels, - top_pos);
2512 tm.newParMetricsUp();
2514 d->anchor_ypos_ += pixels;
2519 bool BufferView::setCursorFromRow(int row)
2521 TexRow::TextEntry start, end;
2522 tie(start,end) = buffer_.texrow().getEntriesFromRow(row);
2523 LYXERR(Debug::LATEX,
2524 "setCursorFromRow: for row " << row << ", TexRow has found "
2525 "start (id=" << start.id << ",pos=" << start.pos << "), "
2526 "end (id=" << end.id << ",pos=" << end.pos << ")");
2527 return setCursorFromEntries(start, end);
2531 bool BufferView::setCursorFromEntries(TexRow::TextEntry start,
2532 TexRow::TextEntry end)
2534 DocIterator dit_start, dit_end;
2535 tie(dit_start,dit_end) =
2536 TexRow::getDocIteratorsFromEntries(start, end, buffer_);
2539 // Setting selection start
2540 d->cursor_.clearSelection();
2541 setCursor(dit_start);
2542 // Setting selection end
2544 d->cursor_.resetAnchor();
2545 setCursorSelectionTo(dit_end);
2551 bool BufferView::setCursorFromInset(Inset const * inset)
2553 // are we already there?
2554 if (cursor().nextInset() == inset)
2557 // Inset is not at cursor position. Find it in the document.
2560 while (cur && cur.nextInset() != inset)
2571 void BufferView::gotoLabel(docstring const & label)
2574 bool have_inactive = false;
2575 for (Buffer const * buf : buffer().allRelatives()) {
2577 for (TocItem const & item : *buf->tocBackend().toc("label")) {
2578 if (label == item.str() && item.isOutput()) {
2579 lyx::dispatch(item.action());
2582 // If we find an inactive label, save it for the case
2583 // that no active one is there
2584 if (label == item.str() && !have_inactive) {
2585 have_inactive = true;
2586 action = item.action();
2590 // We only found an inactive label. Go there.
2592 lyx::dispatch(action);
2596 TextMetrics const & BufferView::textMetrics(Text const * t) const
2598 return const_cast<BufferView *>(this)->textMetrics(t);
2602 TextMetrics & BufferView::textMetrics(Text const * t)
2605 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
2606 if (tmc_it == d->text_metrics_.end()) {
2607 tmc_it = d->text_metrics_.emplace(std::piecewise_construct,
2608 std::forward_as_tuple(t),
2609 std::forward_as_tuple(this, const_cast<Text *>(t))).first;
2611 return tmc_it->second;
2615 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
2618 return textMetrics(t).parMetrics(pit);
2622 int BufferView::workHeight() const
2628 void BufferView::setCursor(DocIterator const & dit)
2631 size_t const n = dit.depth();
2632 for (size_t i = 0; i < n; ++i)
2633 dit[i].inset().edit(d->cursor_, true);
2635 d->cursor_.setCursor(dit);
2636 d->cursor_.selection(false);
2637 d->cursor_.setCurrentFont();
2639 // It seems on general grounds as if this is probably needed, but
2640 // it is not yet clear.
2641 // See bug #7394 and r38388.
2642 // d->cursor.resetAnchor();
2646 void BufferView::setCursorSelectionTo(DocIterator const & dit)
2648 size_t const n = dit.depth();
2649 for (size_t i = 0; i < n; ++i)
2650 dit[i].inset().edit(d->cursor_, true);
2652 d->cursor_.selection(true);
2653 d->cursor_.setCursorSelectionTo(dit);
2654 d->cursor_.setCurrentFont();
2658 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
2660 // Would be wrong to delete anything if we have a selection.
2661 if (cur.selection())
2664 bool need_anchor_change = false;
2665 bool changed = Text::deleteEmptyParagraphMechanism(cur, old,
2666 need_anchor_change);
2668 if (need_anchor_change)
2676 // we would rather not do this here, but it needs to be done before
2677 // the changed() signal is sent.
2678 buffer_.updateBuffer();
2680 buffer_.changed(true);
2685 bool BufferView::mouseSetCursor(Cursor & cur, bool const select)
2687 LASSERT(&cur.bv() == this, return false);
2690 // this event will clear selection so we save selection for
2691 // persistent selection
2692 cap::saveSelection(cursor());
2694 d->cursor_.macroModeClose();
2695 // If a macro has been finalized, the cursor might have been broken
2698 // Has the cursor just left the inset?
2699 bool const leftinset = (&d->cursor_.inset() != &cur.inset());
2701 d->cursor_.fixIfBroken();
2703 // do the dEPM magic if needed
2704 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
2705 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
2706 // the leftinset bool would not be necessary (badcursor instead).
2707 bool update = leftinset;
2710 d->cursor_.setSelection();
2711 d->cursor_.setCursorSelectionTo(cur);
2713 if (d->cursor_.inTexted())
2714 update |= checkDepm(cur, d->cursor_);
2715 d->cursor_.resetAnchor();
2716 d->cursor_.setCursor(cur);
2717 d->cursor_.clearSelection();
2719 d->cursor_.boundary(cur.boundary());
2720 d->cursor_.finishUndo();
2721 d->cursor_.setCurrentFont();
2723 cur.forceBufferUpdate();
2728 void BufferView::putSelectionAt(DocIterator const & cur,
2729 int length, bool backwards)
2731 d->cursor_.clearSelection();
2737 d->cursor_.pos() += length;
2738 d->cursor_.setSelection(d->cursor_, -length);
2740 d->cursor_.setSelection(d->cursor_, length);
2745 bool BufferView::selectIfEmpty(DocIterator & cur)
2747 if ((cur.inTexted() && !cur.paragraph().empty())
2748 || (cur.inMathed() && !cur.cell().empty()))
2751 pit_type const beg_pit = cur.pit();
2753 // The paragraph associated to this item isn't
2754 // the first one, so it can be selected
2757 // We have to resort to select the space between the
2758 // end of this item and the begin of the next one
2762 // If it is the only item in the document,
2763 // nothing can be selected
2766 pit_type const end_pit = cur.pit();
2767 pos_type const end_pos = cur.pos();
2768 d->cursor_.clearSelection();
2770 d->cursor_.setCursor(cur);
2771 d->cursor_.pit() = beg_pit;
2772 d->cursor_.pos() = 0;
2773 d->cursor_.selection(false);
2774 d->cursor_.resetAnchor();
2775 d->cursor_.pit() = end_pit;
2776 d->cursor_.pos() = end_pos;
2777 d->cursor_.setSelection();
2782 Cursor & BufferView::cursor()
2788 Cursor const & BufferView::cursor() const
2794 bool BufferView::singleParUpdate()
2796 Text & buftext = buffer_.text();
2797 pit_type const bottom_pit = d->cursor_.bottom().pit();
2798 TextMetrics & tm = textMetrics(&buftext);
2799 Dimension const old_dim = tm.parMetrics(bottom_pit).dim();
2801 // make sure inline completion pointer is ok
2802 if (d->inlineCompletionPos_.fixIfBroken())
2803 d->inlineCompletionPos_ = DocIterator();
2805 // In Single Paragraph mode, rebreak only
2806 // the (main text, not inset!) paragraph containing the cursor.
2807 // (if this paragraph contains insets etc., rebreaking will
2808 // recursively descend)
2809 tm.redoParagraph(bottom_pit);
2810 ParagraphMetrics & pm = tm.parMetrics(bottom_pit);
2811 if (pm.height() != old_dim.height()) {
2812 // Paragraph height has changed so we cannot proceed to
2813 // the singlePar optimisation.
2816 // Since position() points to the baseline of the first row, we
2817 // may have to update it. See ticket #11601 for an example where
2818 // the height does not change but the ascent does.
2819 pm.setPosition(pm.position() - old_dim.ascent() + pm.ascent());
2821 tm.updatePosCache(bottom_pit);
2823 LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
2824 << " y2: " << pm.position() + pm.descent()
2825 << " pit: " << bottom_pit
2826 << " singlepar: 1");
2831 void BufferView::updateMetrics()
2833 updateMetrics(d->update_flags_);
2834 d->update_strategy_ = FullScreenUpdate;
2838 void BufferView::updateMetrics(Update::flags & update_flags)
2840 if (height_ == 0 || width_ == 0)
2843 Text & buftext = buffer_.text();
2844 pit_type const npit = int(buftext.paragraphs().size());
2846 // Clear out the position cache in case of full screen redraw,
2847 d->coord_cache_.clear();
2848 d->math_rows_.clear();
2850 // Clear out paragraph metrics to avoid having invalid metrics
2851 // in the cache from paragraphs not relayouted below
2852 // The complete text metrics will be redone.
2853 d->text_metrics_.clear();
2855 TextMetrics & tm = textMetrics(&buftext);
2857 // make sure inline completion pointer is ok
2858 if (d->inlineCompletionPos_.fixIfBroken())
2859 d->inlineCompletionPos_ = DocIterator();
2861 if (d->anchor_pit_ >= npit)
2862 // The anchor pit must have been deleted...
2863 d->anchor_pit_ = npit - 1;
2865 // Rebreak anchor paragraph.
2866 tm.redoParagraph(d->anchor_pit_);
2867 ParagraphMetrics & anchor_pm = tm.parMetrics(d->anchor_pit_);
2870 if (d->anchor_pit_ == 0) {
2871 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
2873 // Complete buffer visible? Then it's easy.
2874 if (scrollRange == 0)
2875 d->anchor_ypos_ = anchor_pm.ascent();
2877 // avoid empty space above the first row
2878 d->anchor_ypos_ = min(d->anchor_ypos_, anchor_pm.ascent());
2881 anchor_pm.setPosition(d->anchor_ypos_);
2882 tm.updatePosCache(d->anchor_pit_);
2884 LYXERR(Debug::PAINTING, "metrics: "
2885 << " anchor pit = " << d->anchor_pit_
2886 << " anchor ypos = " << d->anchor_ypos_);
2888 // Redo paragraphs above anchor if necessary.
2889 int y1 = d->anchor_ypos_ - anchor_pm.ascent();
2890 // We are now just above the anchor paragraph.
2891 pit_type pit1 = d->anchor_pit_ - 1;
2892 for (; pit1 >= 0 && y1 >= 0; --pit1) {
2893 tm.redoParagraph(pit1);
2894 ParagraphMetrics & pm = tm.parMetrics(pit1);
2896 // Save the paragraph position in the cache.
2898 tm.updatePosCache(pit1);
2902 // Redo paragraphs below the anchor if necessary.
2903 int y2 = d->anchor_ypos_ + anchor_pm.descent();
2904 // We are now just below the anchor paragraph.
2905 pit_type pit2 = d->anchor_pit_ + 1;
2906 for (; pit2 < npit && y2 <= height_; ++pit2) {
2907 tm.redoParagraph(pit2);
2908 ParagraphMetrics & pm = tm.parMetrics(pit2);
2910 // Save the paragraph position in the cache.
2912 tm.updatePosCache(pit2);
2916 LYXERR(Debug::PAINTING, "Metrics: "
2917 << " anchor pit = " << d->anchor_pit_
2918 << " anchor ypos = " << d->anchor_ypos_
2921 << " pit1 = " << pit1
2922 << " pit2 = " << pit2);
2924 // metrics is done, full drawing is necessary now
2925 update_flags = (update_flags & ~Update::Force) | Update::ForceDraw;
2927 // Now update the positions of insets in the cache.
2930 if (lyxerr.debugging(Debug::WORKAREA)) {
2931 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
2932 d->coord_cache_.dump();
2937 void BufferView::updatePosCache()
2939 // this is the "nodraw" drawing stage: only set the positions of the
2940 // insets in metrics cache.
2941 frontend::NullPainter np;
2946 void BufferView::insertLyXFile(FileName const & fname, bool const ignorelang)
2948 LASSERT(d->cursor_.inTexted(), return);
2950 // Get absolute path of file and add ".lyx"
2951 // to the filename if necessary
2952 FileName filename = fileSearch(string(), fname.absFileName(), "lyx");
2954 docstring const disp_fn = makeDisplayPath(filename.absFileName());
2955 // emit message signal.
2956 message(bformat(_("Inserting document %1$s..."), disp_fn));
2959 Buffer buf(filename.absFileName(), false);
2960 if (buf.loadLyXFile() == Buffer::ReadSuccess) {
2961 ErrorList & el = buffer_.errorList("Parse");
2962 // Copy the inserted document error list into the current buffer one.
2963 el = buf.errorList("Parse");
2964 ParagraphList & pars = buf.paragraphs();
2966 // set main language of imported file to context language
2967 buf.changeLanguage(buf.language(), d->cursor_.getFont().language());
2968 buffer_.undo().recordUndo(d->cursor_);
2969 cap::pasteParagraphList(d->cursor_, pars,
2970 buf.params().documentClassPtr(),
2971 buf.params().authors(), el);
2972 res = _("Document %1$s inserted.");
2974 res = _("Could not insert document %1$s");
2977 buffer_.changed(true);
2978 // emit message signal.
2979 message(bformat(res, disp_fn));
2983 Point BufferView::coordOffset(DocIterator const & dit) const
2989 // Addup contribution of nested insets, from inside to outside,
2990 // keeping the outer paragraph for a special handling below
2991 for (size_t i = dit.depth() - 1; i >= 1; --i) {
2992 CursorSlice const & sl = dit[i];
2996 // get relative position inside sl.inset()
2997 sl.inset().cursorPos(*this, sl, dit.boundary() && (i + 1 == dit.depth()), xx, yy);
2999 // Make relative position inside of the edited inset relative to sl.inset()
3003 // In case of an RTL inset, the edited inset will be positioned to the left
3006 bool boundary_i = dit.boundary() && i + 1 == dit.depth();
3007 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
3012 // remember width for the case that sl.inset() is positioned in an RTL inset
3013 lastw = sl.inset().dimension(*this).wid;
3015 //lyxerr << "Cursor::getPos, i: "
3016 // << i << " x: " << xx << " y: " << y << endl;
3019 // Add contribution of initial rows of outermost paragraph
3020 CursorSlice const & sl = dit[0];
3021 TextMetrics const & tm = textMetrics(sl.text());
3022 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
3024 LBUFERR(!pm.rows().empty());
3025 y -= pm.rows()[0].ascent();
3027 // FIXME: document this mess
3029 if (sl.pos() > 0 && dit.depth() == 1) {
3031 if (pos && dit.boundary())
3033 // lyxerr << "coordOffset: boundary:" << dit.boundary() << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
3034 rend = pm.pos2row(pos);
3036 rend = pm.pos2row(sl.pos());
3038 size_t rend = pm.pos2row(sl.pos());
3040 for (size_t rit = 0; rit != rend; ++rit)
3041 y += pm.rows()[rit].height();
3042 y += pm.rows()[rend].ascent();
3044 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
3046 // Make relative position from the nested inset now bufferview absolute.
3047 int xx = bottom_tm.cursorX(dit.bottom(), dit.boundary() && dit.depth() == 1);
3050 // In the RTL case place the nested inset at the left of the cursor in
3051 // the outer paragraph
3052 bool boundary_1 = dit.boundary() && 1 == dit.depth();
3053 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
3061 Point BufferView::getPos(DocIterator const & dit) const
3063 if (!paragraphVisible(dit))
3064 return Point(-1, -1);
3066 CursorSlice const & bot = dit.bottom();
3067 TextMetrics const & tm = textMetrics(bot.text());
3069 // offset from outer paragraph
3070 Point p = coordOffset(dit);
3071 p.y_ += tm.parMetrics(bot.pit()).position();
3076 bool BufferView::paragraphVisible(DocIterator const & dit) const
3078 CursorSlice const & bot = dit.bottom();
3079 TextMetrics const & tm = textMetrics(bot.text());
3081 return tm.contains(bot.pit());
3085 void BufferView::caretPosAndDim(Point & p, Dimension & dim) const
3087 Cursor const & cur = cursor();
3088 if (cur.inMathed()) {
3089 MathRow const & mrow = mathRow(&cur.cell());
3090 dim = mrow.caret_dim;
3092 Font const font = cur.real_current_font;
3093 frontend::FontMetrics const & fm = theFontMetrics(font);
3094 dim.wid = fm.lineWidth();
3095 dim.asc = fm.maxAscent();
3096 dim.des = fm.maxDescent();
3098 if (lyxrc.cursor_width > 0)
3099 dim.wid = lyxrc.cursor_width;
3102 // center fat carets horizontally
3103 p.x_ -= dim.wid / 2;
3109 void BufferView::buildCaretGeometry(bool complet)
3113 caretPosAndDim(p, dim);
3115 Cursor const & cur = d->cursor_;
3116 Font const & realfont = cur.real_current_font;
3117 frontend::FontMetrics const & fm = theFontMetrics(realfont.fontInfo());
3118 bool const isrtl = realfont.isVisibleRightToLeft();
3119 int const dir = isrtl ? -1 : 1;
3121 frontend::CaretGeometry & cg = d->caret_geometry_;
3124 // The caret itself, slanted for italics in text edit mode except
3125 // for selections because the selection rect does not slant
3126 bool const slant = fm.italic() && cur.inTexted() && !cur.selection();
3127 double const slope = slant ? fm.italicSlope() : 0;
3128 cg.shapes.push_back(
3129 {{iround(p.x_ + dim.asc * slope), p.y_},
3130 {iround(p.x_ - dim.des * slope), p.y_ + dim.height()},
3131 {iround(p.x_ + dir * dim.wid - dim.des * slope), p.y_ + dim.height()},
3132 {iround(p.x_ + dir * dim.wid + dim.asc * slope), p.y_}}
3135 // The language indicator _| (if needed)
3136 Language const * doclang = buffer().params().language;
3137 if (!((realfont.language() == doclang && isrtl == doclang->rightToLeft())
3138 || realfont.language() == latex_language)) {
3139 int const lx = dim.height() / 3;
3140 int const xx = iround(p.x_ - dim.des * slope);
3141 int const yy = p.y_ + dim.height();
3142 cg.shapes.push_back(
3143 {{xx, yy - dim.wid},
3144 {xx + dir * (dim.wid + lx - 1), yy - dim.wid},
3145 {xx + dir * (dim.wid + lx - 1), yy},
3150 // The completion triangle |> (if needed)
3152 int const m = p.y_ + dim.height() / 2;
3153 int const d = dim.height() / 8;
3154 // offset for slanted carret
3155 int const sx = iround((dim.asc - (dim.height() / 2 - d)) * slope);
3156 // starting position x
3157 int const xx = p.x_ + dir * dim.wid + sx;
3158 cg.shapes.push_back(
3162 {xx, m + d - dim.wid},
3163 {xx + dir * d - dim.wid, m},
3164 {xx, m - d + dim.wid}}
3168 // compute extremal x values
3170 cg.right = -1000000;
3172 cg.bottom = -1000000;
3173 for (auto const & shape : cg.shapes)
3174 for (Point const & p : shape) {
3175 cg.left = min(cg.left, p.x_);
3176 cg.right = max(cg.right, p.x_);
3177 cg.top = min(cg.top, p.y_);
3178 cg.bottom = max(cg.bottom, p.y_);
3183 frontend::CaretGeometry const & BufferView::caretGeometry() const
3185 return d->caret_geometry_;
3189 bool BufferView::caretInView() const
3191 if (!paragraphVisible(cursor()))
3195 caretPosAndDim(p, dim);
3197 // does the cursor touch the screen ?
3198 if (p.y_ + dim.height() < 0 || p.y_ >= workHeight())
3204 int BufferView::horizScrollOffset() const
3206 return d->horiz_scroll_offset_;
3210 int BufferView::horizScrollOffset(Text const * text,
3211 pit_type pit, pos_type pos) const
3213 // Is this a row that is currently scrolled?
3214 if (!d->current_row_slice_.empty()
3215 && &text->inset() == d->current_row_slice_.inset().asInsetText()
3216 && pit == d->current_row_slice_.pit()
3217 && pos == d->current_row_slice_.pos())
3218 return d->horiz_scroll_offset_;
3223 void BufferView::setCurrentRowSlice(CursorSlice const & rowSlice)
3225 // nothing to do if the cursor was already on this row
3226 if (d->current_row_slice_ == rowSlice)
3229 // if the (previous) current row was scrolled, we have to
3230 // remember it in order to repaint it next time.
3231 if (d->horiz_scroll_offset_ != 0) {
3232 // search the old row in cache and mark it changed
3233 for (auto & tm_pair : d->text_metrics_) {
3234 if (&tm_pair.first->inset() == rowSlice.inset().asInsetText()) {
3235 tm_pair.second.setRowChanged(rowSlice.pit(), rowSlice.pos());
3236 // We found it, no need to continue.
3242 // Since we changed row, the scroll offset is not valid anymore
3243 d->horiz_scroll_offset_ = 0;
3244 d->current_row_slice_ = rowSlice;
3248 void BufferView::checkCursorScrollOffset()
3250 CursorSlice rowSlice = d->cursor_.bottom();
3251 TextMetrics const & tm = textMetrics(rowSlice.text());
3253 // Stop if metrics have not been computed yet, since it means
3254 // that there is nothing to do.
3255 if (!tm.contains(rowSlice.pit()))
3257 ParagraphMetrics const & pm = tm.parMetrics(rowSlice.pit());
3258 Row const & row = pm.getRow(rowSlice.pos(),
3259 d->cursor_.boundary() && rowSlice == d->cursor_.top());
3260 rowSlice.pos() = row.pos();
3262 // Set the row on which the cursor lives.
3263 setCurrentRowSlice(rowSlice);
3265 // Current x position of the cursor in pixels
3266 int cur_x = getPos(d->cursor_).x_;
3268 // Horizontal scroll offset of the cursor row in pixels
3269 int offset = d->horiz_scroll_offset_;
3270 int const MARGIN = 2 * theFontMetrics(d->cursor_.real_current_font).em()
3272 if (row.right_x() <= workWidth() - row.right_margin) {
3273 // Row is narrower than the work area, no offset needed.
3276 if (cur_x - offset < MARGIN) {
3277 // cursor would be too far right
3278 offset = cur_x - MARGIN;
3279 } else if (cur_x - offset > workWidth() - MARGIN) {
3280 // cursor would be too far left
3281 offset = cur_x - workWidth() + MARGIN;
3283 // Correct the offset to make sure that we do not scroll too much
3286 if (row.right_x() - offset < workWidth() - row.right_margin)
3287 offset = row.right_x() - workWidth() + row.right_margin;
3290 //lyxerr << "cur_x=" << cur_x << ", offset=" << offset << ", row.wid=" << row.width() << ", margin=" << MARGIN << endl;
3292 if (offset != d->horiz_scroll_offset_)
3293 LYXERR(Debug::PAINTING, "Horiz. scroll offset changed from "
3294 << d->horiz_scroll_offset_ << " to " << offset);
3296 if (d->update_strategy_ == NoScreenUpdate
3297 && offset != d->horiz_scroll_offset_) {
3298 // FIXME: if one uses SingleParUpdate, then home/end
3299 // will not work on long rows. Why?
3300 d->update_strategy_ = FullScreenUpdate;
3303 d->horiz_scroll_offset_ = offset;
3307 void BufferView::draw(frontend::Painter & pain, bool paint_caret)
3309 if (height_ == 0 || width_ == 0)
3311 LYXERR(Debug::PAINTING, (pain.isNull() ? "\t\t--- START NODRAW ---"
3312 : "\t\t*** START DRAWING ***"));
3313 Text & text = buffer_.text();
3314 TextMetrics const & tm = d->text_metrics_[&text];
3315 int const y = tm.first().second->position();
3316 PainterInfo pi(this, pain);
3318 // Check whether the row where the cursor lives needs to be scrolled.
3319 // Update the drawing strategy if needed.
3320 checkCursorScrollOffset();
3322 switch (d->update_strategy_) {
3324 case NoScreenUpdate:
3325 // no screen painting is actually needed. In nodraw stage
3326 // however, the different coordinates of insets and paragraphs
3327 // needs to be updated.
3328 LYXERR(Debug::PAINTING, "Strategy: NoScreenUpdate");
3329 if (pain.isNull()) {
3330 pi.full_repaint = true;
3333 pi.full_repaint = false;
3338 case SingleParUpdate:
3339 pi.full_repaint = false;
3340 LYXERR(Debug::PAINTING, "Strategy: SingleParUpdate");
3341 // In general, only the current row of the outermost paragraph
3342 // will be redrawn. Particular cases where selection spans
3343 // multiple paragraph are correctly detected in TextMetrics.
3347 case DecorationUpdate:
3348 // FIXME: We should also distinguish DecorationUpdate to avoid text
3349 // drawing if possible. This is not possible to do easily right now
3350 // because of the single backing pixmap.
3352 case FullScreenUpdate:
3354 LYXERR(Debug::PAINTING,
3355 ((d->update_strategy_ == FullScreenUpdate)
3356 ? "Strategy: FullScreenUpdate"
3357 : "Strategy: DecorationUpdate"));
3359 // The whole screen, including insets, will be refreshed.
3360 pi.full_repaint = true;
3362 // Clear background.
3363 pain.fillRectangle(0, 0, width_, height_,
3364 pi.backgroundColor(&buffer_.inset()));
3369 // and possibly grey out below
3370 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3371 int const y2 = lastpm.second->position() + lastpm.second->descent();
3374 Color color = buffer().isInternal()
3375 ? Color_background : Color_bottomarea;
3376 pain.fillRectangle(0, y2, width_, height_ - y2, color);
3380 LYXERR(Debug::PAINTING, (pain.isNull() ? "\t\t --- END NODRAW ---"
3381 : "\t\t *** END DRAWING ***"));
3383 // The scrollbar needs an update.
3384 // FIXME: does it always? see ticket #11947.
3387 // Normalize anchor for next time
3388 pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
3389 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3390 for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
3391 ParagraphMetrics const & pm = tm.parMetrics(pit);
3392 if (pm.position() + pm.descent() > 0) {
3393 if (d->anchor_pit_ != pit
3394 || d->anchor_ypos_ != pm.position())
3395 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
3396 << " anchor ypos = " << d->anchor_ypos_);
3397 d->anchor_pit_ = pit;
3398 d->anchor_ypos_ = pm.position();
3402 if (!pain.isNull()) {
3403 // reset the update flags, everything has been done
3404 d->update_flags_ = Update::None;
3407 // If a caret has to be painted, mark its text row as dirty to
3408 //make sure that it will be repainted on next redraw.
3409 /* FIXME: investigate whether this can be avoided when the cursor did not
3413 Cursor cur(d->cursor_);
3414 while (cur.depth() > 1) {
3415 if (!cur.inTexted())
3417 TextMetrics const & tm = textMetrics(cur.text());
3418 if (d->caret_geometry_.left >= tm.origin().x_
3419 && d->caret_geometry_.right <= tm.origin().x_ + tm.dim().width())
3423 cur.textRow().changed(true);
3428 void BufferView::message(docstring const & msg)
3431 d->gui_->message(msg);
3435 void BufferView::showDialog(string const & name)
3438 d->gui_->showDialog(name, string());
3442 void BufferView::showDialog(string const & name,
3443 string const & data, Inset * inset)
3446 d->gui_->showDialog(name, data, inset);
3450 void BufferView::updateDialog(string const & name, string const & data)
3453 d->gui_->updateDialog(name, data);
3457 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
3463 // FIXME: Move this out of BufferView again
3464 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
3466 if (!fname.isReadableFile()) {
3467 docstring const error = from_ascii(strerror(errno));
3468 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3469 docstring const text =
3470 bformat(_("Could not read the specified document\n"
3471 "%1$s\ndue to the error: %2$s"), file, error);
3472 Alert::error(_("Could not read file"), text);
3476 if (!fname.isReadableFile()) {
3477 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3478 docstring const text =
3479 bformat(_("%1$s\n is not readable."), file);
3480 Alert::error(_("Could not open file"), text);
3484 // FIXME UNICODE: We don't know the encoding of the file
3485 docstring file_content = fname.fileContents("UTF-8");
3486 if (file_content.empty()) {
3487 Alert::error(_("Reading not UTF-8 encoded file"),
3488 _("The file is not UTF-8 encoded.\n"
3489 "It will be read as local 8Bit-encoded.\n"
3490 "If this does not give the correct result\n"
3491 "then please change the encoding of the file\n"
3492 "to UTF-8 with a program other than LyX.\n"));
3493 file_content = fname.fileContents("local8bit");
3496 return normalize_c(file_content);
3500 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
3502 docstring const tmpstr = contentsOfPlaintextFile(f);
3507 Cursor & cur = cursor();
3508 cap::replaceSelection(cur);
3509 buffer_.undo().recordUndo(cur);
3511 cur.innerText()->insertStringAsParagraphs(cur, tmpstr, cur.current_font);
3513 cur.innerText()->insertStringAsLines(cur, tmpstr, cur.current_font);
3515 buffer_.changed(true);
3519 docstring const & BufferView::inlineCompletion() const
3521 return d->inlineCompletion_;
3525 size_t BufferView::inlineCompletionUniqueChars() const
3527 return d->inlineCompletionUniqueChars_;
3531 DocIterator const & BufferView::inlineCompletionPos() const
3533 return d->inlineCompletionPos_;
3537 void BufferView::resetInlineCompletionPos()
3539 d->inlineCompletionPos_ = DocIterator();
3543 bool samePar(DocIterator const & a, DocIterator const & b)
3545 if (a.empty() && b.empty())
3547 if (a.empty() || b.empty())
3549 if (a.depth() != b.depth())
3551 return &a.innerParagraph() == &b.innerParagraph();
3555 void BufferView::setInlineCompletion(Cursor const & cur, DocIterator const & pos,
3556 docstring const & completion, size_t uniqueChars)
3558 uniqueChars = min(completion.size(), uniqueChars);
3559 bool changed = d->inlineCompletion_ != completion
3560 || d->inlineCompletionUniqueChars_ != uniqueChars;
3561 bool singlePar = true;
3562 d->inlineCompletion_ = completion;
3563 d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
3565 //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
3568 DocIterator const & old = d->inlineCompletionPos_;
3570 //lyxerr << "inlineCompletionPos changed" << std::endl;
3571 // old or pos are in another paragraph?
3572 if ((!samePar(cur, pos) && !pos.empty())
3573 || (!samePar(cur, old) && !old.empty())) {
3575 //lyxerr << "different paragraph" << std::endl;
3577 d->inlineCompletionPos_ = pos;
3582 if (singlePar && !(cur.result().screenUpdate() & Update::Force))
3583 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
3585 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::Force);
3590 bool BufferView::clickableInset() const
3592 return d->clickable_inset_;