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"
64 #include "frontends/Clipboard.h"
66 #include "support/convert.h"
67 #include "support/debug.h"
68 #include "support/docstring.h"
69 #include "support/filetools.h"
70 #include "support/gettext.h"
71 #include "support/lassert.h"
72 #include "support/Length.h"
73 #include "support/lstrings.h"
74 #include "support/lyxlib.h"
75 #include "support/types.h"
87 using namespace lyx::support;
91 namespace Alert = frontend::Alert;
95 /// Return an inset of this class if it exists at the current cursor position
97 T * getInsetByCode(Cursor const & cur, InsetCode code)
100 Inset * inset = it.nextInset();
101 if (inset && inset->lyxCode() == code)
102 return static_cast<T*>(inset);
107 /// Note that comparing contents can only be used for InsetCommand
108 bool findNextInset(DocIterator & dit, vector<InsetCode> const & codes,
109 docstring const & contents)
111 DocIterator tmpdit = dit;
114 Inset const * inset = tmpdit.nextInset();
116 bool const valid_code = std::find(codes.begin(), codes.end(),
117 inset->lyxCode()) != codes.end();
118 InsetCommand const * ic = inset->asInsetCommand();
119 bool const same_or_no_contents = contents.empty()
120 || (ic && (ic->getFirstNonOptParam() == contents));
122 if (valid_code && same_or_no_contents) {
127 tmpdit.forwardInset();
134 /// Looks for next inset with one of the given codes.
135 /// Note that same_content can only be used for InsetCommand
136 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
140 DocIterator tmpdit = dit;
141 tmpdit.forwardInset();
145 Inset const * inset = tmpdit.nextInset();
146 if (same_content && inset) {
147 InsetCommand const * ic = inset->asInsetCommand();
149 bool const valid_code = std::find(codes.begin(), codes.end(),
150 ic->lyxCode()) != codes.end();
152 contents = ic->getFirstNonOptParam();
156 if (!findNextInset(tmpdit, codes, contents)) {
157 if (dit.depth() != 1 || dit.pit() != 0 || dit.pos() != 0) {
158 inset = &tmpdit.bottom().inset();
159 tmpdit = doc_iterator_begin(&inset->buffer(), inset);
160 if (!findNextInset(tmpdit, codes, contents))
172 /// Moves cursor to the next inset with one of the given codes.
173 void gotoInset(BufferView * bv, vector<InsetCode> const & codes,
176 Cursor tmpcur = bv->cursor();
177 if (!findInset(tmpcur, codes, same_content)) {
178 bv->cursor().message(_("No more insets"));
182 tmpcur.clearSelection();
183 bv->setCursor(tmpcur);
188 /// A map from a Text to the associated text metrics
189 typedef map<Text const *, TextMetrics> TextMetricsCache;
191 enum ScreenUpdateStrategy {
201 /////////////////////////////////////////////////////////////////////
205 /////////////////////////////////////////////////////////////////////
207 struct BufferView::Private
209 Private(BufferView & bv) :
210 update_strategy_(FullScreenUpdate),
211 update_flags_(Update::Force),
212 cursor_(bv), anchor_pit_(0), anchor_ypos_(0),
213 wh_(0), inlineCompletionUniqueChars_(0),
214 last_inset_(nullptr), mouse_position_cache_(),
215 gui_(nullptr), bookmark_edit_position_(-1),
216 horiz_scroll_offset_(0), clickable_inset_(false)
218 xsel_cache_.set = false;
222 ScrollbarParameters scrollbarParameters_;
224 ScreenUpdateStrategy update_strategy_;
226 Update::flags update_flags_;
228 CoordCache coord_cache_;
230 typedef map<MathData const *, MathRow> MathRows;
233 /// this is used to handle XSelection events in the right manner.
242 pit_type anchor_pit_;
245 /// Estimated average par height for scrollbar.
248 vector<int> par_height_;
251 DocIterator inlineCompletionPos_;
253 docstring inlineCompletion_;
255 size_t inlineCompletionUniqueChars_;
257 /// keyboard mapping object.
260 /// last visited inset.
261 /** kept to send setMouseHover(false).
262 * Not owned, so don't delete.
264 Inset const * last_inset_;
266 /// position of the mouse at the time of the last mouse move
267 /// This is used to update the hovering status of inset in
268 /// cases where the buffer is scrolled, but the mouse didn't move.
269 Point mouse_position_cache_;
271 mutable TextMetricsCache text_metrics_;
274 /** Not owned, so don't delete.
276 frontend::GuiBufferViewDelegate * gui_;
279 map<string, Inset *> edited_insets_;
281 /// When the row where the cursor lies is scrolled, this
282 /// contains the scroll offset
283 // cache for id of the paragraph which was edited the last time
284 int bookmark_edit_position_;
286 int horiz_scroll_offset_;
287 /// a slice pointing to the start of the row where the cursor
288 /// is (at last draw time)
289 CursorSlice current_row_slice_;
290 /// are we hovering something that we can click
291 bool clickable_inset_;
292 /// shape of the caret
293 frontend::CaretGeometry caret_geometry_;
297 BufferView::BufferView(Buffer & buf)
298 : width_(0), height_(0), full_screen_(false), buffer_(buf),
299 d(new Private(*this))
301 d->xsel_cache_.set = false;
302 d->intl_.initKeyMapper(lyxrc.use_kbmap);
304 d->cursor_.setBuffer(&buf);
305 d->cursor_.push(buffer_.inset());
306 d->cursor_.resetAnchor();
307 d->cursor_.setCurrentFont();
309 buffer_.updatePreviews();
313 BufferView::~BufferView()
315 // current buffer is going to be switched-off, save cursor pos
316 // Ideally, the whole cursor stack should be saved, but session
317 // currently can only handle bottom (whole document) level pit and pos.
318 // That is to say, if a cursor is in a nested inset, it will be
319 // restore to the left of the top level inset.
320 LastFilePosSection::FilePos fp;
321 fp.file = buffer_.fileName();
322 fp.pit = d->cursor_.bottom().pit();
323 fp.pos = d->cursor_.bottom().pos();
324 theSession().lastFilePos().save(fp);
327 d->last_inset_->setMouseHover(this, false);
333 int BufferView::rightMargin() const
335 // The value used to be hardcoded to 10
336 int const default_margin = zoomedPixels(10);
337 // The additional test for the case the outliner is opened.
338 if (!full_screen_ || !lyxrc.full_screen_limit
339 || width_ < lyxrc.full_screen_width + 2 * default_margin)
340 return default_margin;
342 return (width_ - lyxrc.full_screen_width) / 2;
346 int BufferView::leftMargin() const
348 return rightMargin();
352 int BufferView::topMargin() const
354 // Original value was 20px at 100dpi. For internal buffers like in
355 // advanced search and replace, a value of 5px is enough.
356 return zoomedPixels(buffer().isInternal() ? 5 : 20);
360 int BufferView::bottomMargin() const
366 int BufferView::inPixels(Length const & len) const
368 Font const font = buffer().params().getFont();
369 return len.inPixels(workWidth(), theFontMetrics(font).em());
373 int BufferView::zoomedPixels(int pix) const
375 // FIXME: the dpi setting should really depend on the BufferView
376 // (think different monitors).
378 // Zoom factor specified by user in percent
379 double const zoom = lyxrc.currentZoom / 100.0; // [percent]
381 // DPI setting for monitor relative to 100dpi
382 double const dpizoom = lyxrc.dpi / 100.0; // [per 100dpi]
384 return support::iround(pix * zoom * dpizoom);
388 bool BufferView::isTopScreen() const
390 return 0 == d->scrollbarParameters_.min;
394 bool BufferView::isBottomScreen() const
396 return 0 == d->scrollbarParameters_.max;
400 Intl & BufferView::getIntl()
406 Intl const & BufferView::getIntl() const
412 CoordCache & BufferView::coordCache()
414 return d->coord_cache_;
418 CoordCache const & BufferView::coordCache() const
420 return d->coord_cache_;
424 MathRow const & BufferView::mathRow(MathData const * cell) const
426 auto it = d->math_rows_.find(cell);
427 LATTEST(it != d->math_rows_.end());
432 void BufferView::setMathRow(MathData const * cell, MathRow const & mrow)
434 d->math_rows_[cell] = mrow;
438 Buffer & BufferView::buffer()
444 Buffer const & BufferView::buffer() const
450 docstring const & BufferView::searchRequestCache() const
452 return theClipboard().getFindBuffer();
456 void BufferView::setSearchRequestCache(docstring const & text)
464 docstring const search = string2find(text, casesensitive, matchword,
465 forward, wrap, instant, onlysel);
466 theClipboard().setFindBuffer(search);
470 bool BufferView::needsFitCursor() const
472 if (cursorStatus(d->cursor_) == CUR_INSIDE) {
473 frontend::FontMetrics const & fm =
474 theFontMetrics(d->cursor_.getFont().fontInfo());
475 int const asc = fm.maxAscent();
476 int const des = fm.maxDescent();
477 Point const p = getPos(d->cursor_);
478 if (p.y_ - asc >= 0 && p.y_ + des < height_)
487 // this is for debugging only.
488 string flagsAsString(Update::flags flags)
490 if (flags == Update::None)
492 return string((flags & Update::FitCursor) ? "FitCursor " : "")
493 + ((flags & Update::Force) ? "Force " : "")
494 + ((flags & Update::ForceDraw) ? "ForceDraw " : "")
495 + ((flags & Update::SinglePar) ? "SinglePar " : "")
496 + ((flags & Update::Decoration) ? "Decoration " : "");
501 void BufferView::processUpdateFlags(Update::flags flags)
503 LYXERR(Debug::PAINTING, "BufferView::processUpdateFlags( "
504 << flagsAsString(flags) << ") buffer: " << &buffer_);
506 // Case when no explicit update is requested.
507 if (flags == Update::None)
510 /* FIXME We would like to avoid doing this here, since it is very
511 * expensive and is called in updateBuffer already. However, even
512 * inserting a plain character can invalidate the overly fragile
513 * tables of child documents built by updateMacros. Some work is
514 * needed to avoid doing that when not necessary.
516 buffer_.updateMacros();
518 // First check whether the metrics and inset positions should be updated
519 if (flags & Update::Force) {
520 // This will update the CoordCache items and replace Force
521 // with ForceDraw in flags.
522 updateMetrics(flags);
525 // Detect whether we can only repaint a single paragraph (if we
526 // are not already redrawing all).
527 // We handle this before FitCursor because the later will require
528 // correct metrics at cursor position.
529 if (!(flags & Update::ForceDraw)
530 && (flags & Update::SinglePar)
531 && !singleParUpdate())
532 updateMetrics(flags);
534 // Then make sure that the screen contains the cursor if needed
535 if (flags & Update::FitCursor) {
536 if (needsFitCursor()) {
537 // First try to make the selection start visible
538 // (which is just the cursor when there is no selection)
539 scrollToCursor(d->cursor_.selectionBegin(), false);
540 // Metrics have to be recomputed (maybe again)
542 // Is the cursor visible? (only useful if cursor is at end of selection)
543 if (needsFitCursor()) {
544 // then try to make cursor visible instead
545 scrollToCursor(d->cursor_, false);
546 // Metrics have to be recomputed (maybe again)
547 updateMetrics(flags);
550 flags = flags & ~Update::FitCursor;
553 // Add flags to the the update flags. These will be reset to None
554 // after the redraw is actually done
555 d->update_flags_ = d->update_flags_ | flags;
556 LYXERR(Debug::PAINTING, "Cumulative flags: " << flagsAsString(flags));
558 // Now compute the update strategy
559 // Possibly values in flag are None, SinglePar, Decoration, ForceDraw
560 LATTEST((d->update_flags_ & ~(Update::None | Update::SinglePar
561 | Update::Decoration | Update::ForceDraw)) == 0);
563 if (d->update_flags_ & Update::ForceDraw)
564 d->update_strategy_ = FullScreenUpdate;
565 else if (d->update_flags_ & Update::Decoration)
566 d->update_strategy_ = DecorationUpdate;
567 else if (d->update_flags_ & Update::SinglePar)
568 d->update_strategy_ = SingleParUpdate;
570 // no need to redraw anything.
571 d->update_strategy_ = NoScreenUpdate;
574 updateHoveredInset();
577 buffer_.changed(false);
581 void BufferView::updateScrollbar()
583 if (height_ == 0 && width_ == 0)
586 // We prefer fixed size line scrolling.
587 d->scrollbarParameters_.single_step = defaultRowHeight();
588 // We prefer full screen page scrolling.
589 d->scrollbarParameters_.page_step = height_;
591 Text & t = buffer_.text();
592 TextMetrics & tm = d->text_metrics_[&t];
594 LYXERR(Debug::GUI, " Updating scrollbar: height: "
595 << t.paragraphs().size()
596 << " curr par: " << d->cursor_.bottom().pit()
597 << " default height " << defaultRowHeight());
599 size_t const parsize = t.paragraphs().size();
600 if (d->par_height_.size() != parsize) {
601 d->par_height_.clear();
602 // FIXME: We assume a default paragraph height of 2 rows. This
603 // should probably be pondered with the screen width.
604 d->par_height_.resize(parsize, defaultRowHeight() * 2);
607 // Look at paragraph heights on-screen
608 pair<pit_type, ParagraphMetrics const *> first = tm.first();
609 pair<pit_type, ParagraphMetrics const *> last = tm.last();
610 for (pit_type pit = first.first; pit <= last.first; ++pit) {
611 d->par_height_[pit] = tm.parMetrics(pit).height();
612 LYXERR(Debug::SCROLLING, "storing height for pit " << pit << " : "
613 << d->par_height_[pit]);
616 int top_pos = first.second->position() - first.second->ascent();
617 int bottom_pos = last.second->position() + last.second->descent();
618 bool first_visible = first.first == 0 && top_pos >= 0;
619 bool last_visible = last.first + 1 == int(parsize) && bottom_pos <= height_;
620 if (first_visible && last_visible) {
621 d->scrollbarParameters_.min = 0;
622 d->scrollbarParameters_.max = 0;
626 d->scrollbarParameters_.min = top_pos;
627 for (size_t i = 0; i != size_t(first.first); ++i)
628 d->scrollbarParameters_.min -= d->par_height_[i];
629 d->scrollbarParameters_.max = bottom_pos;
630 for (size_t i = last.first + 1; i != parsize; ++i)
631 d->scrollbarParameters_.max += d->par_height_[i];
633 // The reference is the top position so we remove one page.
634 if (lyxrc.scroll_below_document)
635 d->scrollbarParameters_.max -= minVisiblePart();
637 d->scrollbarParameters_.max -= d->scrollbarParameters_.page_step;
639 // 0 must be inside the range as it denotes the current position
640 if (d->scrollbarParameters_.max < 0)
641 d->scrollbarParameters_.max = 0;
642 if (d->scrollbarParameters_.min > 0)
643 d->scrollbarParameters_.min = 0;
647 ScrollbarParameters const & BufferView::scrollbarParameters() const
649 return d->scrollbarParameters_;
653 docstring BufferView::toolTip(int x, int y) const
655 // Get inset under mouse, if there is one.
656 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
658 // No inset, no tooltip...
660 return covering_inset->toolTip(*this, x, y);
664 string BufferView::contextMenu(int x, int y) const
666 //If there is a selection, return the containing inset menu
667 if (d->cursor_.selection())
668 return d->cursor_.inset().contextMenu(*this, x, y);
670 // Get inset under mouse, if there is one.
671 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
673 return covering_inset->contextMenu(*this, x, y);
675 return buffer_.inset().contextMenu(*this, x, y);
680 void BufferView::scrollDocView(int const pixels, bool update)
682 // The scrollbar values are relative to the top of the screen, therefore the
683 // offset is equal to the target value.
685 // No scrolling at all? No need to redraw anything
689 // If the offset is less than 2 screen height, prefer to scroll instead.
690 if (abs(pixels) <= 2 * height_) {
691 d->anchor_ypos_ -= pixels;
692 processUpdateFlags(Update::Force);
696 // cut off at the top
697 if (pixels <= d->scrollbarParameters_.min) {
698 DocIterator dit = doc_iterator_begin(&buffer_);
699 showCursor(dit, false, update);
700 LYXERR(Debug::SCROLLING, "scroll to top");
704 // cut off at the bottom
705 if (pixels >= d->scrollbarParameters_.max) {
706 DocIterator dit = doc_iterator_end(&buffer_);
708 showCursor(dit, false, update);
709 LYXERR(Debug::SCROLLING, "scroll to bottom");
713 // find paragraph at target position
714 int par_pos = d->scrollbarParameters_.min;
716 for (; i != int(d->par_height_.size()); ++i) {
717 par_pos += d->par_height_[i];
718 if (par_pos >= pixels)
722 if (par_pos < pixels) {
723 // It seems we didn't find the correct pit so stay on the safe side and
725 LYXERR0("scrolling position not found!");
726 scrollDocView(d->scrollbarParameters_.max, update);
730 DocIterator dit = doc_iterator_begin(&buffer_);
732 LYXERR(Debug::SCROLLING, "pixels = " << pixels << " -> scroll to pit " << i);
733 showCursor(dit, false, update);
737 // FIXME: this method is not working well.
738 void BufferView::setCursorFromScrollbar()
740 TextMetrics & tm = d->text_metrics_[&buffer_.text()];
742 int const height = 2 * defaultRowHeight();
743 int const first = height;
744 int const last = height_ - height;
746 Cursor const & oldcur = d->cursor_;
748 switch (cursorStatus(oldcur)) {
756 int const y = getPos(oldcur).y_;
757 newy = min(last, max(y, first));
761 // We reset the cursor because cursorStatus() does not
762 // work when the cursor is within mathed.
765 tm.setCursorFromCoordinates(cur, 0, newy);
767 // update the bufferview cursor and notify insets
768 // FIXME: Care about the d->cursor_ flags to redraw if needed
769 Cursor old = d->cursor_;
771 // the DEPM call in mouseSetCursor() might have destroyed the
772 // paragraph the cursor is in.
773 bool badcursor = old.fixIfBroken();
774 badcursor |= notifyCursorLeavesOrEnters(old, d->cursor_);
776 d->cursor_.fixIfBroken();
780 Change const BufferView::getCurrentChange() const
782 if (!d->cursor_.selection())
783 return Change(Change::UNCHANGED);
785 DocIterator dit = d->cursor_.selectionBegin();
786 // The selected content might have been changed (see #7685)
787 dit = dit.getInnerText();
788 return dit.paragraph().lookupChange(dit.pos());
792 // this could be used elsewhere as well?
793 // FIXME: This does not work within mathed!
794 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
796 Point const p = getPos(dit);
799 if (p.y_ > workHeight())
805 void BufferView::bookmarkEditPosition()
807 // Don't eat cpu time for each keystroke
808 if (d->cursor_.paragraph().id() == d->bookmark_edit_position_)
811 d->bookmark_edit_position_ = d->cursor_.paragraph().id();
815 void BufferView::saveBookmark(unsigned int idx)
817 if (buffer().isInternal())
820 // tentatively save bookmark, id and pos will be used to
821 // acturately locate a bookmark in a 'live' lyx session.
822 // pit and pos will be updated with bottom level pit/pos
824 theSession().bookmarks().save(
826 d->cursor_.bottom().pit(),
827 d->cursor_.bottom().pos(),
828 d->cursor_.paragraph().id(),
833 // emit message signal.
834 message(_("Save bookmark"));
838 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
839 int top_id, pos_type top_pos)
841 bool success = false;
844 d->cursor_.clearSelection();
846 // if a valid par_id is given, try it first
847 // This is the case for a 'live' bookmark when unique paragraph ID
848 // is used to track bookmarks.
850 dit = buffer_.getParFromID(top_id);
852 dit.pos() = min(dit.paragraph().size(), top_pos);
853 // Some slices of the iterator may not be
854 // reachable (e.g. closed collapsible inset)
855 // so the dociterator may need to be
856 // shortened. Otherwise, setCursor may crash
857 // lyx when the cursor can not be set to these
859 size_t const n = dit.depth();
860 for (size_t i = 0; i < n; ++i)
861 if (!dit[i].inset().editable()) {
869 // if top_id == 0, or searching through top_id failed
870 // This is the case for a 'restored' bookmark when only bottom
871 // (document level) pit was saved. Because of this, bookmark
872 // restoration is inaccurate. If a bookmark was within an inset,
873 // it will be restored to the left of the outmost inset that contains
875 if (bottom_pit < int(buffer_.paragraphs().size())) {
876 dit = doc_iterator_begin(&buffer_);
878 dit.pit() = bottom_pit;
879 dit.pos() = min(bottom_pos, dit.paragraph().size());
884 // Note: only bottom (document) level pit is set.
886 // set the current font.
887 d->cursor_.setCurrentFont();
888 // Do not forget to reset the anchor (see #9912)
889 d->cursor_.resetAnchor();
890 processUpdateFlags(Update::Force | Update::FitCursor);
897 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
899 if (d->cursor_.real_current_font.isRightToLeft()) {
900 if (d->intl_.keymap == Intl::PRIMARY)
901 d->intl_.keyMapSec();
903 if (d->intl_.keymap == Intl::SECONDARY)
904 d->intl_.keyMapPrim();
907 d->intl_.getTransManager().translateAndInsert(c, t, cur);
911 int BufferView::workWidth() const
917 void BufferView::recenter()
919 showCursor(d->cursor_, true, true);
923 void BufferView::showCursor()
925 showCursor(d->cursor_, false, true);
929 void BufferView::showCursor(DocIterator const & dit,
930 bool recenter, bool update)
932 if (scrollToCursor(dit, recenter) && update)
933 processUpdateFlags(Update::Force);
937 void BufferView::scrollToCursor()
939 if (scrollToCursor(d->cursor_, false))
940 processUpdateFlags(Update::Force);
944 bool BufferView::scrollToCursor(DocIterator const & dit, bool const recenter)
946 // We are not properly started yet, delay until resizing is
952 LYXERR(Debug::SCROLLING, "recentering and scrolling to cursor");
954 LYXERR(Debug::SCROLLING, "scrolling to cursor");
956 CursorSlice const & bot = dit.bottom();
957 TextMetrics & tm = textMetrics(bot.text());
959 pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
960 pos_type bot_pit = bot.pit();
961 if (bot_pit > max_pit) {
962 // FIXME: Why does this happen?
963 LYXERR0("bottom pit is greater that max pit: "
964 << bot_pit << " > " << max_pit);
968 if (bot_pit == tm.first().first - 1)
969 tm.newParMetricsUp();
970 else if (bot_pit == tm.last().first + 1)
971 tm.newParMetricsDown();
973 if (tm.contains(bot_pit)) {
974 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
975 LBUFERR(!pm.rows().empty());
976 // FIXME: smooth scrolling doesn't work in mathed.
977 CursorSlice const & cs = dit.innerTextSlice();
978 int offset = coordOffset(dit).y_;
979 int ypos = pm.position() + offset;
980 Dimension const & row_dim =
981 pm.getRow(cs.pos(), dit.boundary()).dim();
984 scrolled = scroll(ypos - height_/2);
986 // We try to visualize the whole row, if the row height is larger than
987 // the screen height, we scroll to a heuristic value of height_ / 4.
988 // FIXME: This heuristic value should be replaced by a recursive search
989 // for a row in the inset that can be visualized completely.
990 else if (row_dim.height() > height_) {
991 if (ypos < defaultRowHeight())
992 scrolled = scroll(ypos - height_ / 4);
993 else if (ypos > height_ - defaultRowHeight())
994 scrolled = scroll(ypos - 3 * height_ / 4);
997 // If the top part of the row falls of the screen, we scroll
998 // up to align the top of the row with the top of the screen.
999 else if (ypos - row_dim.ascent() < 0 && ypos < height_) {
1000 int ynew = row_dim.ascent();
1001 scrolled = scrollUp(ynew - ypos);
1004 // If the bottom of the row falls of the screen, we scroll down.
1005 else if (ypos + row_dim.descent() > height_ && ypos > 0) {
1006 int ynew = height_ - row_dim.descent();
1007 scrolled = scrollDown(ypos - ynew);
1010 // else, nothing to do, the cursor is already visible so we just return.
1011 return scrolled != 0;
1014 // fix inline completion position
1015 if (d->inlineCompletionPos_.fixIfBroken())
1016 d->inlineCompletionPos_ = DocIterator();
1018 tm.redoParagraph(bot_pit);
1019 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
1020 int offset = coordOffset(dit).y_;
1022 d->anchor_pit_ = bot_pit;
1023 CursorSlice const & cs = dit.innerTextSlice();
1024 ParagraphMetrics const & inner_pm =
1025 textMetrics(cs.text()).parMetrics(cs.pit());
1026 Dimension const & row_dim =
1027 inner_pm.getRow(cs.pos(), dit.boundary()).dim();
1030 d->anchor_ypos_ = height_/2;
1031 else if (d->anchor_pit_ == 0)
1032 d->anchor_ypos_ = offset + pm.ascent();
1033 else if (d->anchor_pit_ == max_pit)
1034 d->anchor_ypos_ = height_ - offset - row_dim.descent();
1035 else if (offset > height_)
1036 d->anchor_ypos_ = height_ - offset - defaultRowHeight();
1038 d->anchor_ypos_ = defaultRowHeight() * 2;
1044 void BufferView::makeDocumentClass()
1046 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1047 buffer_.params().makeDocumentClass(buffer_.isClone(), buffer_.isInternal());
1048 updateDocumentClass(olddc);
1052 void BufferView::updateDocumentClass(DocumentClassConstPtr olddc)
1054 message(_("Converting document to new document class..."));
1056 StableDocIterator backcur(d->cursor_);
1057 ErrorList & el = buffer_.errorList("Class Switch");
1058 cap::switchBetweenClasses(
1059 olddc, buffer_.params().documentClassPtr(),
1060 static_cast<InsetText &>(buffer_.inset()), el);
1062 setCursor(backcur.asDocIterator(&buffer_));
1064 buffer_.errors("Class Switch");
1068 /** Return the change status at cursor position, taking into account the
1069 * status at each level of the document iterator (a table in a deleted
1070 * footnote is deleted).
1071 * When \param outer is true, the top slice is not looked at.
1073 static Change::Type lookupChangeType(DocIterator const & dit, bool outer = false)
1075 size_t const depth = dit.depth() - (outer ? 1 : 0);
1077 for (size_t i = 0 ; i < depth ; ++i) {
1078 CursorSlice const & slice = dit[i];
1079 if (!slice.inset().inMathed()
1080 && slice.pos() < slice.paragraph().size()) {
1081 Change::Type const ch = slice.paragraph().lookupChange(slice.pos()).type;
1082 if (ch != Change::UNCHANGED)
1086 return Change::UNCHANGED;
1090 bool BufferView::getStatus(FuncRequest const & cmd, FuncStatus & flag)
1092 FuncCode const act = cmd.action();
1094 // Can we use a readonly buffer?
1095 if (buffer_.isReadonly()
1096 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1097 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1098 if (buffer_.hasReadonlyFlag())
1099 flag.message(from_utf8(N_("Document is read-only")));
1101 flag.message(from_utf8(N_("Document has been modified externally")));
1102 flag.setEnabled(false);
1106 // Are we in a DELETED change-tracking region?
1107 if (lookupChangeType(d->cursor_, true) == Change::DELETED
1108 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1109 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1110 flag.message(from_utf8(N_("This portion of the document is deleted.")));
1111 flag.setEnabled(false);
1115 Cursor & cur = d->cursor_;
1117 if (cur.getStatus(cmd, flag))
1122 // FIXME: This is a bit problematic because we don't check if this is
1123 // a document BufferView or not for these LFUNs. We probably have to
1124 // dispatch both to currentBufferView() and, if that fails,
1125 // to documentBufferView(); same as we do now for current Buffer and
1126 // document Buffer. Ideally those LFUN should go to Buffer as they
1127 // operate on the full Buffer and the cursor is only needed either for
1128 // an Undo record or to restore a cursor position. But we don't know
1129 // how to do that inside Buffer of course.
1130 case LFUN_BUFFER_PARAMS_APPLY:
1131 case LFUN_LAYOUT_MODULES_CLEAR:
1132 case LFUN_LAYOUT_MODULE_ADD:
1133 case LFUN_LAYOUT_RELOAD:
1134 case LFUN_TEXTCLASS_APPLY:
1135 case LFUN_TEXTCLASS_LOAD:
1136 flag.setEnabled(!buffer_.isReadonly());
1140 // We do not use the LyXAction flag for readonly because Undo sets the
1141 // buffer clean/dirty status by itself.
1142 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasUndoStack());
1145 // We do not use the LyXAction flag for readonly because Redo sets the
1146 // buffer clean/dirty status by itself.
1147 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasRedoStack());
1149 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
1150 case LFUN_FILE_INSERT_PLAINTEXT: {
1151 docstring const & fname = cmd.argument();
1152 if (!FileName::isAbsolute(to_utf8(fname))) {
1153 flag.message(_("Absolute filename expected."));
1156 flag.setEnabled(cur.inTexted());
1159 case LFUN_FILE_INSERT:
1160 case LFUN_BOOKMARK_SAVE:
1161 // FIXME: Actually, these LFUNS should be moved to Text
1162 flag.setEnabled(cur.inTexted());
1165 case LFUN_FONT_STATE:
1166 case LFUN_LABEL_INSERT:
1167 case LFUN_INFO_INSERT:
1168 case LFUN_PARAGRAPH_GOTO:
1169 case LFUN_NOTE_NEXT:
1170 case LFUN_REFERENCE_NEXT:
1171 case LFUN_WORD_FIND:
1172 case LFUN_WORD_FIND_FORWARD:
1173 case LFUN_WORD_FIND_BACKWARD:
1174 case LFUN_WORD_REPLACE:
1177 case LFUN_MARK_TOGGLE:
1178 case LFUN_SEARCH_STRING_SET:
1179 case LFUN_SCREEN_RECENTER:
1180 case LFUN_SCREEN_SHOW_CURSOR:
1181 case LFUN_BIBTEX_DATABASE_ADD:
1182 case LFUN_BIBTEX_DATABASE_DEL:
1183 case LFUN_STATISTICS:
1184 case LFUN_KEYMAP_OFF:
1185 case LFUN_KEYMAP_PRIMARY:
1186 case LFUN_KEYMAP_SECONDARY:
1187 case LFUN_KEYMAP_TOGGLE:
1188 case LFUN_INSET_SELECT_ALL:
1189 flag.setEnabled(true);
1192 case LFUN_GRAPHICS_UNIFY:
1193 flag.setEnabled(cur.countInsetsInSelection(GRAPHICS_CODE)>1);
1196 case LFUN_WORD_FINDADV: {
1197 FindAndReplaceOptions opt;
1198 istringstream iss(to_utf8(cmd.argument()));
1200 flag.setEnabled(opt.repl_buf_name.empty()
1201 || !buffer_.isReadonly());
1205 case LFUN_LABEL_GOTO:
1206 flag.setEnabled(!cmd.argument().empty()
1207 || getInsetByCode<InsetRef>(cur, REF_CODE));
1210 case LFUN_CHANGES_MERGE:
1211 case LFUN_CHANGE_NEXT:
1212 case LFUN_CHANGE_PREVIOUS:
1213 case LFUN_ALL_CHANGES_ACCEPT:
1214 case LFUN_ALL_CHANGES_REJECT:
1215 flag.setEnabled(buffer_.areChangesPresent());
1218 case LFUN_SCREEN_UP:
1219 case LFUN_SCREEN_DOWN:
1221 case LFUN_SCREEN_UP_SELECT:
1222 case LFUN_SCREEN_DOWN_SELECT:
1223 case LFUN_INSET_FORALL:
1224 flag.setEnabled(true);
1227 case LFUN_LAYOUT_TABULAR:
1228 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
1232 flag.setEnabled(!cur.inset().forcePlainLayout(cur.idx()));
1235 case LFUN_LAYOUT_PARAGRAPH:
1236 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
1239 case LFUN_BRANCH_ADD_INSERT:
1240 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1243 case LFUN_DIALOG_SHOW_NEW_INSET:
1244 // FIXME: this is wrong, but I do not understand the
1246 if (cur.inset().lyxCode() == CAPTION_CODE)
1247 return cur.inset().getStatus(cur, cmd, flag);
1248 // FIXME we should consider passthru paragraphs too.
1249 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1252 case LFUN_CITATION_INSERT: {
1253 FuncRequest fr(LFUN_INSET_INSERT, "citation");
1254 // FIXME: This could turn in a recursive hell.
1255 // Shouldn't we use Buffer::getStatus() instead?
1256 flag.setEnabled(lyx::getStatus(fr).enabled());
1259 case LFUN_INSET_APPLY: {
1260 string const name = cmd.getArg(0);
1261 Inset * inset = editedInset(name);
1263 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1264 if (!inset->getStatus(cur, fr, flag)) {
1265 // Every inset is supposed to handle this
1266 LASSERT(false, break);
1269 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1270 flag = lyx::getStatus(fr);
1276 flag.setEnabled(cur.selection());
1287 Inset * BufferView::editedInset(string const & name) const
1289 map<string, Inset *>::const_iterator it = d->edited_insets_.find(name);
1290 return it == d->edited_insets_.end() ? nullptr : it->second;
1294 void BufferView::editInset(string const & name, Inset * inset)
1297 d->edited_insets_[name] = inset;
1299 d->edited_insets_.erase(name);
1303 void BufferView::dispatch(FuncRequest const & cmd, DispatchResult & dr)
1305 LYXERR(Debug::ACTION, "BufferView::dispatch: cmd: " << cmd);
1307 string const argument = to_utf8(cmd.argument());
1308 Cursor & cur = d->cursor_;
1311 // Don't dispatch function that does not apply to internal buffers.
1312 if (buffer_.isInternal()
1313 && lyxaction.funcHasFlag(cmd.action(), LyXAction::NoInternal))
1316 // We'll set this back to false if need be.
1317 bool dispatched = true;
1318 buffer_.undo().beginUndoGroup();
1320 FuncCode const act = cmd.action();
1323 case LFUN_BUFFER_PARAMS_APPLY: {
1324 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1325 cur.recordUndoBufferParams();
1326 istringstream ss(to_utf8(cmd.argument()));
1329 int const unknown_tokens = buffer_.readHeader(lex);
1330 if (unknown_tokens != 0) {
1331 LYXERR0("Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1332 << unknown_tokens << " unknown token"
1333 << (unknown_tokens == 1 ? "" : "s"));
1335 updateDocumentClass(olddc);
1337 // We are most certainly here because of a change in the document
1338 // It is then better to make sure that all dialogs are in sync with
1339 // current document settings.
1340 dr.screenUpdate(Update::Force | Update::FitCursor);
1341 dr.forceBufferUpdate();
1345 case LFUN_LAYOUT_MODULES_CLEAR: {
1346 // FIXME: this modifies the document in cap::switchBetweenClasses
1347 // without calling recordUndo. Fix this before using
1348 // recordUndoBufferParams().
1349 cur.recordUndoFullBuffer();
1350 buffer_.params().clearLayoutModules();
1351 makeDocumentClass();
1352 dr.screenUpdate(Update::Force);
1353 dr.forceBufferUpdate();
1357 case LFUN_LAYOUT_MODULE_ADD: {
1358 BufferParams const & params = buffer_.params();
1359 if (!params.layoutModuleCanBeAdded(argument)) {
1360 LYXERR0("Module `" << argument <<
1361 "' cannot be added due to failed requirements or "
1362 "conflicts with installed modules.");
1365 // FIXME: this modifies the document in cap::switchBetweenClasses
1366 // without calling recordUndo. Fix this before using
1367 // recordUndoBufferParams().
1368 cur.recordUndoFullBuffer();
1369 buffer_.params().addLayoutModule(argument);
1370 makeDocumentClass();
1371 dr.screenUpdate(Update::Force);
1372 dr.forceBufferUpdate();
1376 case LFUN_TEXTCLASS_APPLY: {
1377 // since this shortcircuits, the second call is made only if
1379 bool const success =
1380 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1381 LayoutFileList::get().load(argument, buffer_.filePath());
1383 docstring s = bformat(_("The document class `%1$s' "
1384 "could not be loaded."), from_utf8(argument));
1385 frontend::Alert::error(_("Could not load class"), s);
1389 LayoutFile const * old_layout = buffer_.params().baseClass();
1390 LayoutFile const * new_layout = &(LayoutFileList::get()[argument]);
1392 if (old_layout == new_layout)
1396 // Save the old, possibly modular, layout for use in conversion.
1397 // FIXME: this modifies the document in cap::switchBetweenClasses
1398 // without calling recordUndo. Fix this before using
1399 // recordUndoBufferParams().
1400 cur.recordUndoFullBuffer();
1401 buffer_.params().setBaseClass(argument, buffer_.layoutPos());
1402 makeDocumentClass();
1403 dr.screenUpdate(Update::Force);
1404 dr.forceBufferUpdate();
1408 case LFUN_TEXTCLASS_LOAD: {
1409 // since this shortcircuits, the second call is made only if
1411 bool const success =
1412 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1413 LayoutFileList::get().load(argument, buffer_.filePath());
1415 docstring s = bformat(_("The document class `%1$s' "
1416 "could not be loaded."), from_utf8(argument));
1417 frontend::Alert::error(_("Could not load class"), s);
1422 case LFUN_LAYOUT_RELOAD: {
1423 LayoutFileIndex bc = buffer_.params().baseClassID();
1424 LayoutFileList::get().reset(bc);
1425 buffer_.params().setBaseClass(bc, buffer_.layoutPos());
1426 makeDocumentClass();
1427 dr.screenUpdate(Update::Force);
1428 dr.forceBufferUpdate();
1433 dr.setMessage(_("Undo"));
1434 cur.clearSelection();
1435 // We need to find out if the bibliography information
1436 // has changed. See bug #11055.
1437 // So these should not be references...
1438 string const engine = buffer().params().citeEngine();
1439 CiteEngineType const enginetype = buffer().params().citeEngineType();
1440 if (!cur.undoAction())
1441 dr.setMessage(_("No further undo information"));
1443 dr.screenUpdate(Update::Force | Update::FitCursor);
1444 dr.forceBufferUpdate();
1445 if (buffer().params().citeEngine() != engine ||
1446 buffer().params().citeEngineType() != enginetype)
1447 buffer().invalidateCiteLabels();
1453 dr.setMessage(_("Redo"));
1454 cur.clearSelection();
1455 // We need to find out if the bibliography information
1456 // has changed. See bug #11055.
1457 // So these should not be references...
1458 string const engine = buffer().params().citeEngine();
1459 CiteEngineType const enginetype = buffer().params().citeEngineType();
1460 if (!cur.redoAction())
1461 dr.setMessage(_("No further redo information"));
1463 dr.screenUpdate(Update::Force | Update::FitCursor);
1464 dr.forceBufferUpdate();
1465 if (buffer().params().citeEngine() != engine ||
1466 buffer().params().citeEngineType() != enginetype)
1467 buffer().invalidateCiteLabels();
1472 case LFUN_FONT_STATE:
1473 dr.setMessage(cur.currentState(false));
1476 case LFUN_BOOKMARK_SAVE:
1477 dr.screenUpdate(Update::Force);
1478 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1481 case LFUN_LABEL_GOTO: {
1482 docstring label = cmd.argument();
1483 if (label.empty()) {
1485 getInsetByCode<InsetRef>(cur, REF_CODE);
1487 label = inset->getParam("reference");
1488 // persistent=false: use temp_bookmark
1492 if (!label.empty()) {
1494 // at the moment, this is redundant, since gotoLabel will
1495 // eventually call LFUN_PARAGRAPH_GOTO, but it seems best
1497 dr.screenUpdate(Update::Force | Update::FitCursor);
1502 case LFUN_PARAGRAPH_GOTO: {
1503 int const id = convert<int>(cmd.getArg(0));
1504 pos_type const pos = convert<int>(cmd.getArg(1));
1507 string const str_id_end = cmd.getArg(2);
1508 string const str_pos_end = cmd.getArg(3);
1510 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1511 b = theBufferList().next(b)) {
1514 curs.setCursor(b->getParFromID(id));
1516 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1520 LYXERR(Debug::INFO, "Paragraph " << curs.paragraph().id()
1521 << " found in buffer `"
1522 << b->absFileName() << "'.");
1524 if (b == &buffer_) {
1526 if (str_id_end.empty() || str_pos_end.empty()) {
1529 mouseSetCursor(curs);
1532 int const id_end = convert<int>(str_id_end);
1533 pos_type const pos_end = convert<int>(str_pos_end);
1534 success = setCursorFromEntries({id, pos},
1538 dr.screenUpdate(Update::Force | Update::FitCursor);
1540 // Switch to other buffer view and resend cmd
1541 lyx::dispatch(FuncRequest(
1542 LFUN_BUFFER_SWITCH, b->absFileName()));
1550 case LFUN_NOTE_NEXT:
1551 gotoInset(this, { NOTE_CODE }, false);
1552 // FIXME: if SinglePar is changed to act on the inner
1553 // paragraph, this will not be OK anymore. The update is
1554 // useful for auto-open collapsible insets.
1555 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1558 case LFUN_REFERENCE_NEXT: {
1559 gotoInset(this, { LABEL_CODE, REF_CODE }, true);
1560 // FIXME: if SinglePar is changed to act on the inner
1561 // paragraph, this will not be OK anymore. The update is
1562 // useful for auto-open collapsible insets.
1563 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1567 case LFUN_CHANGE_NEXT:
1568 findNextChange(this);
1569 if (cur.inset().isTable())
1570 // In tables, there might be whole changed rows or columns
1572 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1573 dr.screenUpdate(Update::Force | Update::FitCursor);
1576 case LFUN_CHANGE_PREVIOUS:
1577 findPreviousChange(this);
1578 if (cur.inset().isTable())
1579 // In tables, there might be whole changed rows or columns
1581 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1582 dr.screenUpdate(Update::Force | Update::FitCursor);
1585 case LFUN_CHANGES_MERGE:
1586 if (findNextChange(this) || findPreviousChange(this)) {
1587 dr.screenUpdate(Update::Force | Update::FitCursor);
1588 dr.forceBufferUpdate();
1589 showDialog("changes");
1593 case LFUN_ALL_CHANGES_ACCEPT: {
1594 // select complete document
1596 cur.selHandle(true);
1597 buffer_.text().cursorBottom(cur);
1598 // accept everything in a single step to support atomic undo
1599 // temporarily disable track changes in order to end with really
1600 // no new (e.g., DPSM-caused) changes (see #7487)
1601 bool const track = buffer_.params().track_changes;
1602 buffer_.params().track_changes = false;
1603 buffer_.text().acceptOrRejectChanges(cur, Text::ACCEPT);
1604 buffer_.params().track_changes = track;
1606 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1607 dr.screenUpdate(Update::Force | Update::FitCursor);
1608 dr.forceBufferUpdate();
1612 case LFUN_ALL_CHANGES_REJECT: {
1613 // select complete document
1615 cur.selHandle(true);
1616 buffer_.text().cursorBottom(cur);
1617 // reject everything in a single step to support atomic undo
1618 // temporarily disable track changes in order to end with really
1619 // no new (e.g., DPSM-caused) changes (see #7487)
1620 bool const track = buffer_.params().track_changes;
1621 buffer_.params().track_changes = false;
1622 buffer_.text().acceptOrRejectChanges(cur, Text::REJECT);
1623 buffer_.params().track_changes = track;
1625 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1626 dr.screenUpdate(Update::Force | Update::FitCursor);
1627 dr.forceBufferUpdate();
1631 case LFUN_WORD_FIND_FORWARD:
1632 case LFUN_WORD_FIND_BACKWARD: {
1633 docstring searched_string;
1635 if (!cmd.argument().empty()) {
1636 setSearchRequestCache(cmd.argument());
1637 searched_string = cmd.argument();
1639 searched_string = searchRequestCache();
1642 if (searched_string.empty())
1645 docstring const data =
1646 find2string(searched_string, false, false,
1647 act == LFUN_WORD_FIND_FORWARD, false, false, false);
1648 bool found = lyxfind(this, FuncRequest(LFUN_WORD_FIND, data));
1650 dr.screenUpdate(Update::Force | Update::FitCursor);
1652 dr.setMessage(_("Search string not found!"));
1656 case LFUN_WORD_FIND: {
1657 docstring arg = cmd.argument();
1659 arg = searchRequestCache();
1661 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, "findreplace"));
1664 if (lyxfind(this, FuncRequest(act, arg)))
1665 dr.screenUpdate(Update::Force | Update::FitCursor);
1667 dr.setMessage(_("Search string not found!"));
1669 setSearchRequestCache(arg);
1673 case LFUN_SEARCH_STRING_SET: {
1674 docstring pattern = cmd.argument();
1675 if (!pattern.empty()) {
1676 setSearchRequestCache(pattern);
1679 if (cur.selection())
1680 pattern = cur.selectionAsString(false);
1682 pos_type spos = cur.pos();
1683 cur.innerText()->selectWord(cur, WHOLE_WORD);
1684 pattern = cur.selectionAsString(false);
1685 cur.selection(false);
1688 setSearchRequestCache(pattern);
1692 case LFUN_WORD_REPLACE: {
1693 if (lyxreplace(this, cmd)) {
1694 dr.forceBufferUpdate();
1695 dr.screenUpdate(Update::Force | Update::FitCursor);
1698 dr.setMessage(_("Search string not found!"));
1702 case LFUN_WORD_FINDADV: {
1703 FindAndReplaceOptions opt;
1704 istringstream iss(to_utf8(cmd.argument()));
1706 if (findAdv(this, opt)) {
1707 dr.screenUpdate(Update::Force | Update::FitCursor);
1718 cur.clearSelection();
1719 dr.setMessage(from_utf8(N_("Mark off")));
1723 cur.clearSelection();
1725 dr.setMessage(from_utf8(N_("Mark on")));
1728 case LFUN_MARK_TOGGLE:
1729 cur.selection(false);
1732 dr.setMessage(from_utf8(N_("Mark removed")));
1735 dr.setMessage(from_utf8(N_("Mark set")));
1740 case LFUN_SCREEN_SHOW_CURSOR:
1744 case LFUN_SCREEN_RECENTER:
1748 case LFUN_BIBTEX_DATABASE_ADD: {
1749 Cursor tmpcur = cur;
1750 findInset(tmpcur, { BIBTEX_CODE }, false);
1751 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1754 if (inset->addDatabase(cmd.argument()))
1755 dr.forceBufferUpdate();
1760 case LFUN_BIBTEX_DATABASE_DEL: {
1761 Cursor tmpcur = cur;
1762 findInset(tmpcur, { BIBTEX_CODE }, false);
1763 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1766 if (inset->delDatabase(cmd.argument()))
1767 dr.forceBufferUpdate();
1772 case LFUN_GRAPHICS_UNIFY: {
1774 cur.recordUndoFullBuffer();
1776 DocIterator from, to;
1777 from = cur.selectionBegin();
1778 to = cur.selectionEnd();
1780 string const newId = cmd.getArg(0);
1781 bool fetchId = newId.empty(); //if we wait for groupId from first graphics inset
1783 InsetGraphicsParams grp_par;
1785 InsetGraphics::string2params(graphics::getGroupParams(buffer_, newId), buffer_, grp_par);
1787 if (!from.nextInset()) //move to closest inset
1788 from.forwardInset();
1790 while (!from.empty() && from < to) {
1791 Inset * inset = from.nextInset();
1794 InsetGraphics * ig = inset->asInsetGraphics();
1796 InsetGraphicsParams inspar = ig->getParams();
1801 grp_par.filename = inspar.filename;
1802 ig->setParams(grp_par);
1805 from.forwardInset();
1807 dr.screenUpdate(Update::Force); //needed if triggered from context menu
1811 case LFUN_STATISTICS: {
1812 DocIterator from, to;
1813 if (cur.selection()) {
1814 from = cur.selectionBegin();
1815 to = cur.selectionEnd();
1817 from = doc_iterator_begin(&buffer_);
1818 to = doc_iterator_end(&buffer_);
1820 buffer_.updateStatistics(from, to);
1821 int const words = buffer_.wordCount();
1822 int const chars = buffer_.charCount(false);
1823 int const chars_blanks = buffer_.charCount(true);
1825 if (cur.selection())
1826 message = _("Statistics for the selection:");
1828 message = _("Statistics for the document:");
1831 message += bformat(_("%1$d words"), words);
1833 message += _("One word");
1835 if (chars_blanks != 1)
1836 message += bformat(_("%1$d characters (including blanks)"),
1839 message += _("One character (including blanks)");
1842 message += bformat(_("%1$d characters (excluding blanks)"),
1845 message += _("One character (excluding blanks)");
1847 Alert::information(_("Statistics"), message);
1851 case LFUN_SCREEN_UP:
1852 case LFUN_SCREEN_DOWN: {
1853 Point p = getPos(cur);
1854 // This code has been commented out to enable to scroll down a
1855 // document, even if there are large insets in it (see bug #5465).
1856 /*if (p.y_ < 0 || p.y_ > height_) {
1857 // The cursor is off-screen so recenter before proceeding.
1861 int const scrolled = scroll(act == LFUN_SCREEN_UP
1862 ? -height_ : height_);
1863 if (act == LFUN_SCREEN_UP && scrolled > -height_)
1865 if (act == LFUN_SCREEN_DOWN && scrolled < height_)
1866 p = Point(width_, height_);
1867 bool const in_texted = cur.inTexted();
1868 cur.setCursor(doc_iterator_begin(cur.buffer()));
1869 cur.selHandle(false);
1870 // Force an immediate computation of metrics because we need it below
1873 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_,
1874 true, act == LFUN_SCREEN_UP);
1875 //FIXME: what to do with cur.x_target()?
1876 bool update = in_texted && cur.bv().checkDepm(cur, old);
1879 if (update || cur.mark())
1880 dr.screenUpdate(Update::Force | Update::FitCursor);
1882 dr.forceBufferUpdate();
1887 string const scroll_type = cmd.getArg(0);
1888 int scroll_step = 0;
1889 if (scroll_type == "line")
1890 scroll_step = d->scrollbarParameters_.single_step;
1891 else if (scroll_type == "page")
1892 scroll_step = d->scrollbarParameters_.page_step;
1895 string const scroll_quantity = cmd.getArg(1);
1896 if (scroll_quantity == "up")
1897 scrollUp(scroll_step);
1898 else if (scroll_quantity == "down")
1899 scrollDown(scroll_step);
1901 int const scroll_value = convert<int>(scroll_quantity);
1903 scroll(scroll_step * scroll_value);
1905 dr.screenUpdate(Update::ForceDraw);
1906 dr.forceBufferUpdate();
1910 case LFUN_SCREEN_UP_SELECT: {
1911 // FIXME: why is the algorithm different from LFUN_SCREEN_UP?
1912 cur.selHandle(true);
1913 if (isTopScreen()) {
1914 lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1918 int y = getPos(cur).y_;
1919 int const ymin = y - height_ + defaultRowHeight();
1920 while (y > ymin && cur.up())
1924 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1928 case LFUN_SCREEN_DOWN_SELECT: {
1929 // FIXME: why is the algorithm different from LFUN_SCREEN_DOWN?
1930 cur.selHandle(true);
1931 if (isBottomScreen()) {
1932 lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1936 int y = getPos(cur).y_;
1937 int const ymax = y + height_ - defaultRowHeight();
1938 while (y < ymax && cur.down())
1942 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1947 case LFUN_INSET_SELECT_ALL: {
1948 // true if all cells are selected
1949 bool const all_selected = cur.depth() > 1
1950 && cur.selBegin().at_begin()
1951 && cur.selEnd().at_end();
1952 // true if some cells are selected
1953 bool const cells_selected = cur.depth() > 1
1954 && cur.selBegin().at_cell_begin()
1955 && cur.selEnd().at_cell_end();
1956 if (all_selected || (cells_selected && !cur.inset().isTable())) {
1957 // All the contents of the inset if selected, or only at
1958 // least one cell but inset is not a table.
1959 // Select the inset from outside.
1962 cur.selection(true);
1964 } else if (cells_selected) {
1965 // At least one complete cell is selected and inset is a table.
1971 cur.selection(true);
1972 cur.idx() = cur.lastidx();
1973 cur.pit() = cur.lastpit();
1974 cur.pos() = cur.lastpos();
1976 // select current cell
1980 cur.selection(true);
1981 cur.pit() = cur.lastpit();
1982 cur.pos() = cur.lastpos();
1984 cur.setCurrentFont();
1985 dr.screenUpdate(Update::Force);
1990 case LFUN_UNICODE_INSERT: {
1991 if (cmd.argument().empty())
1994 FuncCode code = cur.inset().currentMode() == Inset::MATH_MODE ?
1995 LFUN_MATH_INSERT : LFUN_SELF_INSERT;
1998 docstring const arg = from_utf8(cmd.getArg(i));
2002 LYXERR0("Not a hexstring: " << arg);
2006 char_type c = hexToInt(arg);
2007 if (c >= 32 && c < 0x10ffff) {
2008 LYXERR(Debug::KEY, "Inserting c: " << c);
2009 lyx::dispatch(FuncRequest(code, docstring(1, c)));
2017 // This would be in Buffer class if only Cursor did not
2018 // require a bufferview
2019 case LFUN_INSET_FORALL: {
2020 docstring const name = from_utf8(cmd.getArg(0));
2021 string const commandstr = cmd.getLongArg(1);
2022 FuncRequest const fr = lyxaction.lookupFunc(commandstr);
2024 // an arbitrary number to limit number of iterations
2025 const int max_iter = 100000;
2027 Cursor & curs = d->cursor_;
2028 Cursor const savecur = curs;
2030 if (!curs.nextInset())
2031 curs.forwardInset();
2032 curs.beginUndoGroup();
2033 while(curs && iterations < max_iter) {
2034 Inset * const ins = curs.nextInset();
2037 docstring insname = ins->layoutName();
2038 while (!insname.empty()) {
2039 if (insname == name || name == from_utf8("*")) {
2041 lyx::dispatch(fr, dr);
2045 size_t const i = insname.rfind(':');
2046 if (i == string::npos)
2048 insname = insname.substr(0, i);
2050 // if we did not delete the inset, skip it
2051 if (!curs.nextInset() || curs.nextInset() == ins)
2052 curs.forwardInset();
2056 /** This is a dummy undo record only to remember the cursor
2057 * that has just been set; this will be used on a redo action
2058 * (see ticket #10097)
2060 * FIXME: a better fix would be to have a way to set the
2061 * cursor value directly, but I am not sure it is worth it.
2064 curs.endUndoGroup();
2065 dr.screenUpdate(Update::Force);
2066 dr.forceBufferUpdate();
2068 if (iterations >= max_iter) {
2070 dr.setMessage(bformat(_("`inset-forall' interrupted because number of actions is larger than %1$d"), max_iter));
2072 dr.setMessage(bformat(_("Applied \"%1$s\" to %2$d insets"), from_utf8(commandstr), iterations));
2077 case LFUN_BRANCH_ADD_INSERT: {
2078 docstring branch_name = from_utf8(cmd.getArg(0));
2079 if (branch_name.empty())
2080 if (!Alert::askForText(branch_name, _("Branch name")) ||
2081 branch_name.empty())
2084 DispatchResult drtmp;
2085 buffer_.dispatch(FuncRequest(LFUN_BRANCH_ADD, branch_name), drtmp);
2086 if (drtmp.error()) {
2087 Alert::warning(_("Branch already exists"), drtmp.message());
2090 docstring const sep = buffer_.params().branchlist().separator();
2091 for (docstring const & branch : getVectorFromString(branch_name, sep))
2092 lyx::dispatch(FuncRequest(LFUN_BRANCH_INSERT, branch));
2096 case LFUN_KEYMAP_OFF:
2097 getIntl().keyMapOn(false);
2100 case LFUN_KEYMAP_PRIMARY:
2101 getIntl().keyMapPrim();
2104 case LFUN_KEYMAP_SECONDARY:
2105 getIntl().keyMapSec();
2108 case LFUN_KEYMAP_TOGGLE:
2109 getIntl().toggleKeyMap();
2112 case LFUN_DIALOG_SHOW_NEW_INSET: {
2113 string const name = cmd.getArg(0);
2114 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
2115 if (decodeInsetParam(name, data, buffer_))
2116 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
2118 lyxerr << "Inset type '" << name <<
2119 "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" << endl;
2123 case LFUN_CITATION_INSERT: {
2124 if (argument.empty()) {
2125 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
2128 // we can have one optional argument, delimited by '|'
2129 // citation-insert <key>|<text_before>
2130 // this should be enhanced to also support text_after
2131 // and citation style
2132 string arg = argument;
2134 if (contains(argument, "|")) {
2135 arg = token(argument, '|', 0);
2136 opt1 = token(argument, '|', 1);
2139 // if our cursor is directly in front of or behind a citation inset,
2140 // we will instead add the new key to it.
2141 Inset * inset = cur.nextInset();
2142 if (!inset || inset->lyxCode() != CITE_CODE)
2143 inset = cur.prevInset();
2144 if (inset && inset->lyxCode() == CITE_CODE) {
2145 InsetCitation * icite = static_cast<InsetCitation *>(inset);
2146 if (icite->addKey(arg)) {
2147 dr.forceBufferUpdate();
2148 dr.screenUpdate(Update::FitCursor | Update::SinglePar);
2150 LYXERR0("Discarding optional argument to citation-insert.");
2155 InsetCommandParams icp(CITE_CODE);
2156 icp["key"] = from_utf8(arg);
2158 icp["before"] = from_utf8(opt1);
2160 from_ascii(InsetCitation::last_literal ? "true" : "false");
2161 string icstr = InsetCommand::params2string(icp);
2162 FuncRequest fr(LFUN_INSET_INSERT, icstr);
2167 case LFUN_INSET_APPLY: {
2168 string const name = cmd.getArg(0);
2169 Inset * inset = editedInset(name);
2171 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
2175 // put cursor in front of inset.
2176 if (!setCursorFromInset(inset)) {
2177 LASSERT(false, break);
2180 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
2181 inset->dispatch(cur, fr);
2182 dr.screenUpdate(cur.result().screenUpdate());
2183 if (cur.result().needBufferUpdate())
2184 dr.forceBufferUpdate();
2189 // The change of language of buffer belongs to the Buffer class.
2190 // We have to do it here because we need a cursor for Undo.
2191 // When Undo::recordUndoBufferParams() is implemented someday
2192 // LFUN_BUFFER_LANGUAGE should be handled by the Buffer class.
2193 case LFUN_BUFFER_LANGUAGE: {
2194 Language const * oldL = buffer_.params().language;
2195 Language const * newL = languages.getLanguage(argument);
2196 if (!newL || oldL == newL)
2198 if (oldL->rightToLeft() == newL->rightToLeft()) {
2199 cur.recordUndoFullBuffer();
2200 buffer_.changeLanguage(oldL, newL);
2201 cur.setCurrentFont();
2202 dr.forceBufferUpdate();
2207 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
2208 case LFUN_FILE_INSERT_PLAINTEXT: {
2209 bool const as_paragraph = (act == LFUN_FILE_INSERT_PLAINTEXT_PARA);
2210 string const fname = to_utf8(cmd.argument());
2211 if (!FileName::isAbsolute(fname))
2212 dr.setMessage(_("Absolute filename expected."));
2214 insertPlaintextFile(FileName(fname), as_paragraph);
2219 cap::copySelection(cur);
2220 cur.message(_("Copy"));
2224 // OK, so try the Buffer itself...
2225 buffer_.dispatch(cmd, dr);
2226 dispatched = dr.dispatched();
2230 buffer_.undo().endUndoGroup();
2231 dr.dispatched(dispatched);
2233 // NOTE: The code below is copied from Cursor::dispatch. If you
2234 // need to modify this, please update the other one too.
2236 // notify insets we just entered/left
2237 if (cursor() != old) {
2238 old.beginUndoGroup();
2240 bool badcursor = notifyCursorLeavesOrEnters(old, cursor());
2242 cursor().fixIfBroken();
2243 resetInlineCompletionPos();
2250 docstring BufferView::requestSelection()
2252 Cursor & cur = d->cursor_;
2254 LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
2255 if (!cur.selection()) {
2256 d->xsel_cache_.set = false;
2260 LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
2261 if (!d->xsel_cache_.set ||
2262 cur.top() != d->xsel_cache_.cursor ||
2263 cur.realAnchor().top() != d->xsel_cache_.anchor)
2265 d->xsel_cache_.cursor = cur.top();
2266 d->xsel_cache_.anchor = cur.realAnchor().top();
2267 d->xsel_cache_.set = cur.selection();
2268 return cur.selectionAsString(false);
2274 void BufferView::clearSelection()
2276 d->cursor_.clearSelection();
2277 // Clear the selection buffer. Otherwise a subsequent
2278 // middle-mouse-button paste would use the selection buffer,
2279 // not the more current external selection.
2280 cap::clearSelection();
2281 d->xsel_cache_.set = false;
2282 // The buffer did not really change, but this causes the
2283 // redraw we need because we cleared the selection above.
2284 buffer_.changed(false);
2288 void BufferView::resize(int width, int height)
2290 // Update from work area
2294 // Clear the paragraph height cache.
2295 d->par_height_.clear();
2296 // Redo the metrics.
2301 Inset const * BufferView::getCoveringInset(Text const & text,
2304 TextMetrics & tm = d->text_metrics_[&text];
2305 Inset * inset = tm.checkInsetHit(x, y);
2309 if (!inset->descendable(*this))
2310 // No need to go further down if the inset is not
2314 size_t cell_number = inset->nargs();
2315 // Check all the inner cell.
2316 for (size_t i = 0; i != cell_number; ++i) {
2317 Text const * inner_text = inset->getText(i);
2320 Inset const * inset_deeper =
2321 getCoveringInset(*inner_text, x, y);
2323 return inset_deeper;
2331 void BufferView::updateHoveredInset() const
2333 // Get inset under mouse, if there is one.
2334 int const x = d->mouse_position_cache_.x_;
2335 int const y = d->mouse_position_cache_.y_;
2336 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
2338 d->clickable_inset_ = covering_inset && covering_inset->clickable(*this, x, y);
2340 if (covering_inset == d->last_inset_)
2341 // Same inset, no need to do anything...
2344 bool need_redraw = false;
2345 if (d->last_inset_) {
2346 // Remove the hint on the last hovered inset (if any).
2347 need_redraw |= d->last_inset_->setMouseHover(this, false);
2348 d->last_inset_ = nullptr;
2351 if (covering_inset && covering_inset->setMouseHover(this, true)) {
2353 // Only the insets that accept the hover state, do
2354 // clear the last_inset_, so only set the last_inset_
2355 // member if the hovered setting is accepted.
2356 d->last_inset_ = covering_inset;
2360 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
2361 << d->mouse_position_cache_.x_ << ", "
2362 << d->mouse_position_cache_.y_ << ")");
2364 d->update_strategy_ = DecorationUpdate;
2366 // This event (moving without mouse click) is not passed further.
2367 // This should be changed if it is further utilized.
2368 buffer_.changed(false);
2373 void BufferView::clearLastInset(Inset * inset) const
2375 if (d->last_inset_ != inset) {
2376 LYXERR0("Wrong last_inset!");
2379 d->last_inset_ = nullptr;
2383 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
2385 //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
2387 // This is only called for mouse related events including
2388 // LFUN_FILE_OPEN generated by drag-and-drop.
2389 FuncRequest cmd = cmd0;
2391 Cursor old = cursor();
2393 cur.push(buffer_.inset());
2394 cur.selection(d->cursor_.selection());
2396 // Either the inset under the cursor or the
2397 // surrounding Text will handle this event.
2399 // make sure we stay within the screen...
2400 cmd.set_y(min(max(cmd.y(), -1), height_));
2402 d->mouse_position_cache_.x_ = cmd.x();
2403 d->mouse_position_cache_.y_ = cmd.y();
2405 if (cmd.action() == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
2406 updateHoveredInset();
2410 // Build temporary cursor.
2411 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x(), cmd.y());
2413 // If inset is not editable, cur.pos() might point behind the
2414 // inset (depending on cmd.x(), cmd.y()). This is needed for
2415 // editing to fix bug 9628, but e.g. the context menu needs a
2416 // cursor in front of the inset.
2417 if ((inset->hasSettings() || !inset->contextMenuName().empty()
2418 || inset->lyxCode() == SEPARATOR_CODE) &&
2419 cur.nextInset() != inset && cur.prevInset() == inset)
2421 } else if (cur.inTexted() && cur.pos()
2422 && cur.paragraph().isEnvSeparator(cur.pos() - 1)) {
2423 // Always place cursor in front of a separator inset.
2427 // Put anchor at the same position.
2430 cur.beginUndoGroup();
2432 // Try to dispatch to an non-editable inset near this position
2433 // via the temp cursor. If the inset wishes to change the real
2434 // cursor it has to do so explicitly by using
2435 // cur.bv().cursor() = cur; (or similar)
2437 inset->dispatch(cur, cmd);
2439 // Now dispatch to the temporary cursor. If the real cursor should
2440 // be modified, the inset's dispatch has to do so explicitly.
2441 if (!inset || !cur.result().dispatched())
2444 // Notify left insets
2446 bool badcursor = old.fixIfBroken() | cur.fixIfBroken();
2447 badcursor |= notifyCursorLeavesOrEnters(old, cur);
2449 cursor().fixIfBroken();
2454 // Do we have a selection?
2455 theSelection().haveSelection(cursor().selection());
2457 if (cur.needBufferUpdate() || buffer().needUpdate()) {
2458 cur.clearBufferUpdate();
2459 buffer().updateBuffer();
2462 // If the command has been dispatched,
2463 if (cur.result().dispatched() || cur.result().screenUpdate())
2464 processUpdateFlags(cur.result().screenUpdate());
2468 int BufferView::minVisiblePart()
2470 return 2 * defaultRowHeight();
2474 int BufferView::scroll(int pixels)
2477 return scrollDown(pixels);
2479 return scrollUp(-pixels);
2484 int BufferView::scrollDown(int pixels)
2486 Text * text = &buffer_.text();
2487 TextMetrics & tm = d->text_metrics_[text];
2488 int const ymax = height_ + pixels;
2490 pair<pit_type, ParagraphMetrics const *> last = tm.last();
2491 int bottom_pos = last.second->position() + last.second->descent();
2492 if (lyxrc.scroll_below_document)
2493 bottom_pos += height_ - minVisiblePart();
2494 if (last.first + 1 == int(text->paragraphs().size())) {
2495 if (bottom_pos <= height_)
2497 pixels = min(pixels, bottom_pos - height_);
2500 if (bottom_pos > ymax)
2502 tm.newParMetricsDown();
2504 d->anchor_ypos_ -= pixels;
2509 int BufferView::scrollUp(int pixels)
2511 Text * text = &buffer_.text();
2512 TextMetrics & tm = d->text_metrics_[text];
2513 int ymin = - pixels;
2515 pair<pit_type, ParagraphMetrics const *> first = tm.first();
2516 int top_pos = first.second->position() - first.second->ascent();
2517 if (first.first == 0) {
2520 pixels = min(pixels, - top_pos);
2525 tm.newParMetricsUp();
2527 d->anchor_ypos_ += pixels;
2532 bool BufferView::setCursorFromRow(int row)
2534 TexRow::TextEntry start, end;
2535 tie(start,end) = buffer_.texrow().getEntriesFromRow(row);
2536 LYXERR(Debug::LATEX,
2537 "setCursorFromRow: for row " << row << ", TexRow has found "
2538 "start (id=" << start.id << ",pos=" << start.pos << "), "
2539 "end (id=" << end.id << ",pos=" << end.pos << ")");
2540 return setCursorFromEntries(start, end);
2544 bool BufferView::setCursorFromEntries(TexRow::TextEntry start,
2545 TexRow::TextEntry end)
2547 DocIterator dit_start, dit_end;
2548 tie(dit_start,dit_end) =
2549 TexRow::getDocIteratorsFromEntries(start, end, buffer_);
2552 // Setting selection start
2553 d->cursor_.clearSelection();
2554 setCursor(dit_start);
2555 // Setting selection end
2557 d->cursor_.resetAnchor();
2558 setCursorSelectionTo(dit_end);
2564 bool BufferView::setCursorFromInset(Inset const * inset)
2566 // are we already there?
2567 if (cursor().nextInset() == inset)
2570 // Inset is not at cursor position. Find it in the document.
2573 while (cur && cur.nextInset() != inset)
2584 void BufferView::gotoLabel(docstring const & label)
2587 bool have_inactive = false;
2588 for (Buffer const * buf : buffer().allRelatives()) {
2590 for (TocItem const & item : *buf->tocBackend().toc("label")) {
2591 if (label == item.str() && item.isOutput()) {
2592 lyx::dispatch(item.action());
2595 // If we find an inactive label, save it for the case
2596 // that no active one is there
2597 if (label == item.str() && !have_inactive) {
2598 have_inactive = true;
2599 action = item.action();
2603 // We only found an inactive label. Go there.
2605 lyx::dispatch(action);
2609 TextMetrics const & BufferView::textMetrics(Text const * t) const
2611 return const_cast<BufferView *>(this)->textMetrics(t);
2615 TextMetrics & BufferView::textMetrics(Text const * t)
2618 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
2619 if (tmc_it == d->text_metrics_.end()) {
2620 tmc_it = d->text_metrics_.emplace(std::piecewise_construct,
2621 std::forward_as_tuple(t),
2622 std::forward_as_tuple(this, const_cast<Text *>(t))).first;
2624 return tmc_it->second;
2628 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
2631 return textMetrics(t).parMetrics(pit);
2635 int BufferView::workHeight() const
2641 void BufferView::setCursor(DocIterator const & dit)
2644 size_t const n = dit.depth();
2645 for (size_t i = 0; i < n; ++i)
2646 dit[i].inset().edit(d->cursor_, true);
2648 d->cursor_.setCursor(dit);
2649 d->cursor_.selection(false);
2650 d->cursor_.setCurrentFont();
2652 // It seems on general grounds as if this is probably needed, but
2653 // it is not yet clear.
2654 // See bug #7394 and r38388.
2655 // d->cursor.resetAnchor();
2659 void BufferView::setCursorSelectionTo(DocIterator const & dit)
2661 size_t const n = dit.depth();
2662 for (size_t i = 0; i < n; ++i)
2663 dit[i].inset().edit(d->cursor_, true);
2665 d->cursor_.selection(true);
2666 d->cursor_.setCursorSelectionTo(dit);
2667 d->cursor_.setCurrentFont();
2671 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
2673 // Would be wrong to delete anything if we have a selection.
2674 if (cur.selection())
2677 bool need_anchor_change = false;
2678 bool changed = Text::deleteEmptyParagraphMechanism(cur, old,
2679 need_anchor_change);
2681 if (need_anchor_change)
2689 // we would rather not do this here, but it needs to be done before
2690 // the changed() signal is sent.
2691 buffer_.updateBuffer();
2693 buffer_.changed(true);
2698 bool BufferView::mouseSetCursor(Cursor & cur, bool const select)
2700 LASSERT(&cur.bv() == this, return false);
2703 // this event will clear selection so we save selection for
2704 // persistent selection
2705 cap::saveSelection(cursor());
2707 d->cursor_.macroModeClose();
2708 // If a macro has been finalized, the cursor might have been broken
2711 // Has the cursor just left the inset?
2712 bool const leftinset = (&d->cursor_.inset() != &cur.inset());
2714 d->cursor_.fixIfBroken();
2716 // do the dEPM magic if needed
2717 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
2718 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
2719 // the leftinset bool would not be necessary (badcursor instead).
2720 bool update = leftinset;
2723 d->cursor_.setSelection();
2724 d->cursor_.setCursorSelectionTo(cur);
2726 if (d->cursor_.inTexted())
2727 update |= checkDepm(cur, d->cursor_);
2728 d->cursor_.resetAnchor();
2729 d->cursor_.setCursor(cur);
2730 d->cursor_.clearSelection();
2732 d->cursor_.boundary(cur.boundary());
2733 d->cursor_.finishUndo();
2734 d->cursor_.setCurrentFont();
2736 cur.forceBufferUpdate();
2741 void BufferView::putSelectionAt(DocIterator const & cur,
2742 int length, bool backwards)
2744 d->cursor_.clearSelection();
2750 d->cursor_.pos() += length;
2751 d->cursor_.setSelection(d->cursor_, -length);
2753 d->cursor_.setSelection(d->cursor_, length);
2758 bool BufferView::selectIfEmpty(DocIterator & cur)
2760 if ((cur.inTexted() && !cur.paragraph().empty())
2761 || (cur.inMathed() && !cur.cell().empty()))
2764 pit_type const beg_pit = cur.pit();
2766 // The paragraph associated to this item isn't
2767 // the first one, so it can be selected
2770 // We have to resort to select the space between the
2771 // end of this item and the begin of the next one
2775 // If it is the only item in the document,
2776 // nothing can be selected
2779 pit_type const end_pit = cur.pit();
2780 pos_type const end_pos = cur.pos();
2781 d->cursor_.clearSelection();
2783 d->cursor_.setCursor(cur);
2784 d->cursor_.pit() = beg_pit;
2785 d->cursor_.pos() = 0;
2786 d->cursor_.selection(false);
2787 d->cursor_.resetAnchor();
2788 d->cursor_.pit() = end_pit;
2789 d->cursor_.pos() = end_pos;
2790 d->cursor_.setSelection();
2795 Cursor & BufferView::cursor()
2801 Cursor const & BufferView::cursor() const
2807 bool BufferView::singleParUpdate()
2809 Text & buftext = buffer_.text();
2810 pit_type const bottom_pit = d->cursor_.bottom().pit();
2811 TextMetrics & tm = textMetrics(&buftext);
2812 Dimension const old_dim = tm.parMetrics(bottom_pit).dim();
2814 // make sure inline completion pointer is ok
2815 if (d->inlineCompletionPos_.fixIfBroken())
2816 d->inlineCompletionPos_ = DocIterator();
2818 // In Single Paragraph mode, rebreak only
2819 // the (main text, not inset!) paragraph containing the cursor.
2820 // (if this paragraph contains insets etc., rebreaking will
2821 // recursively descend)
2822 tm.redoParagraph(bottom_pit);
2823 ParagraphMetrics & pm = tm.parMetrics(bottom_pit);
2824 if (pm.height() != old_dim.height()) {
2825 // Paragraph height has changed so we cannot proceed to
2826 // the singlePar optimisation.
2829 // Since position() points to the baseline of the first row, we
2830 // may have to update it. See ticket #11601 for an example where
2831 // the height does not change but the ascent does.
2832 pm.setPosition(pm.position() - old_dim.ascent() + pm.ascent());
2834 tm.updatePosCache(bottom_pit);
2836 LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
2837 << " y2: " << pm.position() + pm.descent()
2838 << " pit: " << bottom_pit
2839 << " singlepar: 1");
2844 void BufferView::updateMetrics()
2846 updateMetrics(d->update_flags_);
2847 d->update_strategy_ = FullScreenUpdate;
2851 void BufferView::updateMetrics(Update::flags & update_flags)
2853 if (height_ == 0 || width_ == 0)
2856 Text & buftext = buffer_.text();
2857 pit_type const npit = int(buftext.paragraphs().size());
2859 // Clear out the position cache in case of full screen redraw,
2860 d->coord_cache_.clear();
2861 d->math_rows_.clear();
2863 // Clear out paragraph metrics to avoid having invalid metrics
2864 // in the cache from paragraphs not relayouted below
2865 // The complete text metrics will be redone.
2866 d->text_metrics_.clear();
2868 TextMetrics & tm = textMetrics(&buftext);
2870 // make sure inline completion pointer is ok
2871 if (d->inlineCompletionPos_.fixIfBroken())
2872 d->inlineCompletionPos_ = DocIterator();
2874 if (d->anchor_pit_ >= npit)
2875 // The anchor pit must have been deleted...
2876 d->anchor_pit_ = npit - 1;
2878 // Rebreak anchor paragraph.
2879 tm.redoParagraph(d->anchor_pit_);
2880 ParagraphMetrics & anchor_pm = tm.parMetrics(d->anchor_pit_);
2883 if (d->anchor_pit_ == 0) {
2884 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
2886 // Complete buffer visible? Then it's easy.
2887 if (scrollRange == 0)
2888 d->anchor_ypos_ = anchor_pm.ascent();
2890 // avoid empty space above the first row
2891 d->anchor_ypos_ = min(d->anchor_ypos_, anchor_pm.ascent());
2894 anchor_pm.setPosition(d->anchor_ypos_);
2895 tm.updatePosCache(d->anchor_pit_);
2897 LYXERR(Debug::PAINTING, "metrics: "
2898 << " anchor pit = " << d->anchor_pit_
2899 << " anchor ypos = " << d->anchor_ypos_);
2901 // Redo paragraphs above anchor if necessary.
2902 int y1 = d->anchor_ypos_ - anchor_pm.ascent();
2903 // We are now just above the anchor paragraph.
2904 pit_type pit1 = d->anchor_pit_ - 1;
2905 for (; pit1 >= 0 && y1 >= 0; --pit1) {
2906 tm.redoParagraph(pit1);
2907 ParagraphMetrics & pm = tm.parMetrics(pit1);
2909 // Save the paragraph position in the cache.
2911 tm.updatePosCache(pit1);
2915 // Redo paragraphs below the anchor if necessary.
2916 int y2 = d->anchor_ypos_ + anchor_pm.descent();
2917 // We are now just below the anchor paragraph.
2918 pit_type pit2 = d->anchor_pit_ + 1;
2919 for (; pit2 < npit && y2 <= height_; ++pit2) {
2920 tm.redoParagraph(pit2);
2921 ParagraphMetrics & pm = tm.parMetrics(pit2);
2923 // Save the paragraph position in the cache.
2925 tm.updatePosCache(pit2);
2929 LYXERR(Debug::PAINTING, "Metrics: "
2930 << " anchor pit = " << d->anchor_pit_
2931 << " anchor ypos = " << d->anchor_ypos_
2934 << " pit1 = " << pit1
2935 << " pit2 = " << pit2);
2937 // metrics is done, full drawing is necessary now
2938 update_flags = (update_flags & ~Update::Force) | Update::ForceDraw;
2940 // Now update the positions of insets in the cache.
2943 if (lyxerr.debugging(Debug::WORKAREA)) {
2944 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
2945 d->coord_cache_.dump();
2950 void BufferView::updatePosCache()
2952 // this is the "nodraw" drawing stage: only set the positions of the
2953 // insets in metrics cache.
2954 frontend::NullPainter np;
2959 void BufferView::insertLyXFile(FileName const & fname, bool const ignorelang)
2961 LASSERT(d->cursor_.inTexted(), return);
2963 // Get absolute path of file and add ".lyx"
2964 // to the filename if necessary
2965 FileName filename = fileSearch(string(), fname.absFileName(), "lyx");
2967 docstring const disp_fn = makeDisplayPath(filename.absFileName());
2968 // emit message signal.
2969 message(bformat(_("Inserting document %1$s..."), disp_fn));
2972 Buffer buf(filename.absFileName(), false);
2973 if (buf.loadLyXFile() == Buffer::ReadSuccess) {
2974 ErrorList & el = buffer_.errorList("Parse");
2975 // Copy the inserted document error list into the current buffer one.
2976 el = buf.errorList("Parse");
2977 ParagraphList & pars = buf.paragraphs();
2979 // set main language of imported file to context language
2980 buf.changeLanguage(buf.language(), d->cursor_.getFont().language());
2981 buffer_.undo().recordUndo(d->cursor_);
2982 cap::pasteParagraphList(d->cursor_, pars,
2983 buf.params().documentClassPtr(),
2984 buf.params().authors(), el);
2985 res = _("Document %1$s inserted.");
2987 res = _("Could not insert document %1$s");
2990 buffer_.changed(true);
2991 // emit message signal.
2992 message(bformat(res, disp_fn));
2996 Point BufferView::coordOffset(DocIterator const & dit) const
3002 // Addup contribution of nested insets, from inside to outside,
3003 // keeping the outer paragraph for a special handling below
3004 for (size_t i = dit.depth() - 1; i >= 1; --i) {
3005 CursorSlice const & sl = dit[i];
3009 // get relative position inside sl.inset()
3010 sl.inset().cursorPos(*this, sl, dit.boundary() && (i + 1 == dit.depth()), xx, yy);
3012 // Make relative position inside of the edited inset relative to sl.inset()
3016 // In case of an RTL inset, the edited inset will be positioned to the left
3019 bool boundary_i = dit.boundary() && i + 1 == dit.depth();
3020 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
3025 // remember width for the case that sl.inset() is positioned in an RTL inset
3026 lastw = sl.inset().dimension(*this).wid;
3028 //lyxerr << "Cursor::getPos, i: "
3029 // << i << " x: " << xx << " y: " << y << endl;
3032 // Add contribution of initial rows of outermost paragraph
3033 CursorSlice const & sl = dit[0];
3034 TextMetrics const & tm = textMetrics(sl.text());
3035 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
3037 LBUFERR(!pm.rows().empty());
3038 y -= pm.rows()[0].ascent();
3040 // FIXME: document this mess
3042 if (sl.pos() > 0 && dit.depth() == 1) {
3044 if (pos && dit.boundary())
3046 // lyxerr << "coordOffset: boundary:" << dit.boundary() << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
3047 rend = pm.pos2row(pos);
3049 rend = pm.pos2row(sl.pos());
3051 size_t rend = pm.pos2row(sl.pos());
3053 for (size_t rit = 0; rit != rend; ++rit)
3054 y += pm.rows()[rit].height();
3055 y += pm.rows()[rend].ascent();
3057 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
3059 // Make relative position from the nested inset now bufferview absolute.
3060 int xx = bottom_tm.cursorX(dit.bottom(), dit.boundary() && dit.depth() == 1);
3063 // In the RTL case place the nested inset at the left of the cursor in
3064 // the outer paragraph
3065 bool boundary_1 = dit.boundary() && 1 == dit.depth();
3066 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
3074 Point BufferView::getPos(DocIterator const & dit) const
3076 if (!paragraphVisible(dit))
3077 return Point(-1, -1);
3079 CursorSlice const & bot = dit.bottom();
3080 TextMetrics const & tm = textMetrics(bot.text());
3082 // offset from outer paragraph
3083 Point p = coordOffset(dit);
3084 p.y_ += tm.parMetrics(bot.pit()).position();
3089 bool BufferView::paragraphVisible(DocIterator const & dit) const
3091 CursorSlice const & bot = dit.bottom();
3092 TextMetrics const & tm = textMetrics(bot.text());
3094 return tm.contains(bot.pit());
3098 void BufferView::caretPosAndDim(Point & p, Dimension & dim) const
3100 Cursor const & cur = cursor();
3101 if (cur.inMathed()) {
3102 MathRow const & mrow = mathRow(&cur.cell());
3103 dim = mrow.caret_dim;
3105 Font const font = cur.real_current_font;
3106 frontend::FontMetrics const & fm = theFontMetrics(font);
3107 dim.wid = fm.lineWidth();
3108 dim.asc = fm.maxAscent();
3109 dim.des = fm.maxDescent();
3111 if (lyxrc.cursor_width > 0)
3112 dim.wid = lyxrc.cursor_width;
3115 // center fat carets horizontally
3116 p.x_ -= dim.wid / 2;
3122 void BufferView::buildCaretGeometry(bool complet)
3126 caretPosAndDim(p, dim);
3128 Cursor const & cur = d->cursor_;
3129 Font const & realfont = cur.real_current_font;
3130 frontend::FontMetrics const & fm = theFontMetrics(realfont.fontInfo());
3131 bool const isrtl = realfont.isVisibleRightToLeft();
3132 int const dir = isrtl ? -1 : 1;
3134 frontend::CaretGeometry & cg = d->caret_geometry_;
3137 // The caret itself, slanted for italics in text edit mode except
3138 // for selections because the selection rect does not slant
3139 bool const slant = fm.italic() && cur.inTexted() && !cur.selection();
3140 double const slope = slant ? fm.italicSlope() : 0;
3141 cg.shapes.push_back(
3142 {{iround(p.x_ + dim.asc * slope), p.y_},
3143 {iround(p.x_ - dim.des * slope), p.y_ + dim.height()},
3144 {iround(p.x_ + dir * dim.wid - dim.des * slope), p.y_ + dim.height()},
3145 {iround(p.x_ + dir * dim.wid + dim.asc * slope), p.y_}}
3148 // The language indicator _| (if needed)
3149 Language const * doclang = buffer().params().language;
3150 if (!((realfont.language() == doclang && isrtl == doclang->rightToLeft())
3151 || realfont.language() == latex_language)) {
3152 int const lx = dim.height() / 3;
3153 int const xx = iround(p.x_ - dim.des * slope);
3154 int const yy = p.y_ + dim.height();
3155 cg.shapes.push_back(
3156 {{xx, yy - dim.wid},
3157 {xx + dir * (dim.wid + lx - 1), yy - dim.wid},
3158 {xx + dir * (dim.wid + lx - 1), yy},
3163 // The completion triangle |> (if needed)
3165 int const m = p.y_ + dim.height() / 2;
3166 int const d = dim.height() / 8;
3167 // offset for slanted carret
3168 int const sx = iround((dim.asc - (dim.height() / 2 - d)) * slope);
3169 // starting position x
3170 int const xx = p.x_ + dir * dim.wid + sx;
3171 cg.shapes.push_back(
3175 {xx, m + d - dim.wid},
3176 {xx + dir * d - dim.wid, m},
3177 {xx, m - d + dim.wid}}
3181 // compute extremal x values
3183 cg.right = -1000000;
3185 cg.bottom = -1000000;
3186 for (auto const & shape : cg.shapes)
3187 for (Point const & p : shape) {
3188 cg.left = min(cg.left, p.x_);
3189 cg.right = max(cg.right, p.x_);
3190 cg.top = min(cg.top, p.y_);
3191 cg.bottom = max(cg.bottom, p.y_);
3196 frontend::CaretGeometry const & BufferView::caretGeometry() const
3198 return d->caret_geometry_;
3202 bool BufferView::caretInView() const
3204 if (!paragraphVisible(cursor()))
3208 caretPosAndDim(p, dim);
3210 // does the cursor touch the screen ?
3211 if (p.y_ + dim.height() < 0 || p.y_ >= workHeight())
3217 int BufferView::horizScrollOffset() const
3219 return d->horiz_scroll_offset_;
3223 int BufferView::horizScrollOffset(Text const * text,
3224 pit_type pit, pos_type pos) const
3226 // Is this a row that is currently scrolled?
3227 if (!d->current_row_slice_.empty()
3228 && &text->inset() == d->current_row_slice_.inset().asInsetText()
3229 && pit == d->current_row_slice_.pit()
3230 && pos == d->current_row_slice_.pos())
3231 return d->horiz_scroll_offset_;
3236 void BufferView::setCurrentRowSlice(CursorSlice const & rowSlice)
3238 // nothing to do if the cursor was already on this row
3239 if (d->current_row_slice_ == rowSlice)
3242 // if the (previous) current row was scrolled, we have to
3243 // remember it in order to repaint it next time.
3244 if (d->horiz_scroll_offset_ != 0) {
3245 // search the old row in cache and mark it changed
3246 for (auto & tm_pair : d->text_metrics_) {
3247 if (&tm_pair.first->inset() == rowSlice.inset().asInsetText()) {
3248 tm_pair.second.setRowChanged(rowSlice.pit(), rowSlice.pos());
3249 // We found it, no need to continue.
3255 // Since we changed row, the scroll offset is not valid anymore
3256 d->horiz_scroll_offset_ = 0;
3257 d->current_row_slice_ = rowSlice;
3261 void BufferView::checkCursorScrollOffset()
3263 CursorSlice rowSlice = d->cursor_.bottom();
3264 TextMetrics const & tm = textMetrics(rowSlice.text());
3266 // Stop if metrics have not been computed yet, since it means
3267 // that there is nothing to do.
3268 if (!tm.contains(rowSlice.pit()))
3270 ParagraphMetrics const & pm = tm.parMetrics(rowSlice.pit());
3271 Row const & row = pm.getRow(rowSlice.pos(),
3272 d->cursor_.boundary() && rowSlice == d->cursor_.top());
3273 rowSlice.pos() = row.pos();
3275 // Set the row on which the cursor lives.
3276 setCurrentRowSlice(rowSlice);
3278 // Current x position of the cursor in pixels
3279 int cur_x = getPos(d->cursor_).x_;
3281 // Horizontal scroll offset of the cursor row in pixels
3282 int offset = d->horiz_scroll_offset_;
3283 int const MARGIN = 2 * theFontMetrics(d->cursor_.real_current_font).em()
3285 if (row.right_x() <= workWidth() - row.right_margin) {
3286 // Row is narrower than the work area, no offset needed.
3289 if (cur_x - offset < MARGIN) {
3290 // cursor would be too far right
3291 offset = cur_x - MARGIN;
3292 } else if (cur_x - offset > workWidth() - MARGIN) {
3293 // cursor would be too far left
3294 offset = cur_x - workWidth() + MARGIN;
3296 // Correct the offset to make sure that we do not scroll too much
3299 if (row.right_x() - offset < workWidth() - row.right_margin)
3300 offset = row.right_x() - workWidth() + row.right_margin;
3303 //lyxerr << "cur_x=" << cur_x << ", offset=" << offset << ", row.wid=" << row.width() << ", margin=" << MARGIN << endl;
3305 if (offset != d->horiz_scroll_offset_)
3306 LYXERR(Debug::PAINTING, "Horiz. scroll offset changed from "
3307 << d->horiz_scroll_offset_ << " to " << offset);
3309 if (d->update_strategy_ == NoScreenUpdate
3310 && offset != d->horiz_scroll_offset_) {
3311 // FIXME: if one uses SingleParUpdate, then home/end
3312 // will not work on long rows. Why?
3313 d->update_strategy_ = FullScreenUpdate;
3316 d->horiz_scroll_offset_ = offset;
3320 void BufferView::draw(frontend::Painter & pain, bool paint_caret)
3322 if (height_ == 0 || width_ == 0)
3324 LYXERR(Debug::PAINTING, (pain.isNull() ? "\t\t--- START NODRAW ---"
3325 : "\t\t*** START DRAWING ***"));
3326 Text & text = buffer_.text();
3327 TextMetrics const & tm = d->text_metrics_[&text];
3328 int const y = tm.first().second->position();
3329 PainterInfo pi(this, pain);
3331 // Check whether the row where the cursor lives needs to be scrolled.
3332 // Update the drawing strategy if needed.
3333 checkCursorScrollOffset();
3335 switch (d->update_strategy_) {
3337 case NoScreenUpdate:
3338 // no screen painting is actually needed. In nodraw stage
3339 // however, the different coordinates of insets and paragraphs
3340 // needs to be updated.
3341 LYXERR(Debug::PAINTING, "Strategy: NoScreenUpdate");
3342 if (pain.isNull()) {
3343 pi.full_repaint = true;
3346 pi.full_repaint = false;
3351 case SingleParUpdate:
3352 pi.full_repaint = false;
3353 LYXERR(Debug::PAINTING, "Strategy: SingleParUpdate");
3354 // In general, only the current row of the outermost paragraph
3355 // will be redrawn. Particular cases where selection spans
3356 // multiple paragraph are correctly detected in TextMetrics.
3360 case DecorationUpdate:
3361 // FIXME: We should also distinguish DecorationUpdate to avoid text
3362 // drawing if possible. This is not possible to do easily right now
3363 // because of the single backing pixmap.
3365 case FullScreenUpdate:
3367 LYXERR(Debug::PAINTING,
3368 ((d->update_strategy_ == FullScreenUpdate)
3369 ? "Strategy: FullScreenUpdate"
3370 : "Strategy: DecorationUpdate"));
3372 // The whole screen, including insets, will be refreshed.
3373 pi.full_repaint = true;
3375 // Clear background.
3376 pain.fillRectangle(0, 0, width_, height_,
3377 pi.backgroundColor(&buffer_.inset()));
3382 // and possibly grey out below
3383 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3384 int const y2 = lastpm.second->position() + lastpm.second->descent();
3387 Color color = buffer().isInternal()
3388 ? Color_background : Color_bottomarea;
3389 pain.fillRectangle(0, y2, width_, height_ - y2, color);
3393 LYXERR(Debug::PAINTING, (pain.isNull() ? "\t\t --- END NODRAW ---"
3394 : "\t\t *** END DRAWING ***"));
3396 // The scrollbar needs an update.
3397 // FIXME: does it always? see ticket #11947.
3400 // Normalize anchor for next time
3401 pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
3402 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3403 for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
3404 ParagraphMetrics const & pm = tm.parMetrics(pit);
3405 if (pm.position() + pm.descent() > 0) {
3406 if (d->anchor_pit_ != pit
3407 || d->anchor_ypos_ != pm.position())
3408 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
3409 << " anchor ypos = " << d->anchor_ypos_);
3410 d->anchor_pit_ = pit;
3411 d->anchor_ypos_ = pm.position();
3415 if (!pain.isNull()) {
3416 // reset the update flags, everything has been done
3417 d->update_flags_ = Update::None;
3420 // If a caret has to be painted, mark its text row as dirty to
3421 //make sure that it will be repainted on next redraw.
3422 /* FIXME: investigate whether this can be avoided when the cursor did not
3426 Cursor cur(d->cursor_);
3427 while (cur.depth() > 1) {
3428 if (!cur.inTexted())
3430 TextMetrics const & tm = textMetrics(cur.text());
3431 if (d->caret_geometry_.left >= tm.origin().x_
3432 && d->caret_geometry_.right <= tm.origin().x_ + tm.dim().width())
3436 cur.textRow().changed(true);
3441 void BufferView::message(docstring const & msg)
3444 d->gui_->message(msg);
3448 void BufferView::showDialog(string const & name)
3451 d->gui_->showDialog(name, string());
3455 void BufferView::showDialog(string const & name,
3456 string const & data, Inset * inset)
3459 d->gui_->showDialog(name, data, inset);
3463 void BufferView::updateDialog(string const & name, string const & data)
3466 d->gui_->updateDialog(name, data);
3470 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
3476 // FIXME: Move this out of BufferView again
3477 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
3479 if (!fname.isReadableFile()) {
3480 docstring const error = from_ascii(strerror(errno));
3481 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3482 docstring const text =
3483 bformat(_("Could not read the specified document\n"
3484 "%1$s\ndue to the error: %2$s"), file, error);
3485 Alert::error(_("Could not read file"), text);
3489 if (!fname.isReadableFile()) {
3490 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3491 docstring const text =
3492 bformat(_("%1$s\n is not readable."), file);
3493 Alert::error(_("Could not open file"), text);
3497 // FIXME UNICODE: We don't know the encoding of the file
3498 docstring file_content = fname.fileContents("UTF-8");
3499 if (file_content.empty()) {
3500 Alert::error(_("Reading not UTF-8 encoded file"),
3501 _("The file is not UTF-8 encoded.\n"
3502 "It will be read as local 8Bit-encoded.\n"
3503 "If this does not give the correct result\n"
3504 "then please change the encoding of the file\n"
3505 "to UTF-8 with a program other than LyX.\n"));
3506 file_content = fname.fileContents("local8bit");
3509 return normalize_c(file_content);
3513 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
3515 docstring const tmpstr = contentsOfPlaintextFile(f);
3520 Cursor & cur = cursor();
3521 cap::replaceSelection(cur);
3522 buffer_.undo().recordUndo(cur);
3524 cur.innerText()->insertStringAsParagraphs(cur, tmpstr, cur.current_font);
3526 cur.innerText()->insertStringAsLines(cur, tmpstr, cur.current_font);
3528 buffer_.changed(true);
3532 docstring const & BufferView::inlineCompletion() const
3534 return d->inlineCompletion_;
3538 size_t BufferView::inlineCompletionUniqueChars() const
3540 return d->inlineCompletionUniqueChars_;
3544 DocIterator const & BufferView::inlineCompletionPos() const
3546 return d->inlineCompletionPos_;
3550 void BufferView::resetInlineCompletionPos()
3552 d->inlineCompletionPos_ = DocIterator();
3556 bool samePar(DocIterator const & a, DocIterator const & b)
3558 if (a.empty() && b.empty())
3560 if (a.empty() || b.empty())
3562 if (a.depth() != b.depth())
3564 return &a.innerParagraph() == &b.innerParagraph();
3568 void BufferView::setInlineCompletion(Cursor const & cur, DocIterator const & pos,
3569 docstring const & completion, size_t uniqueChars)
3571 uniqueChars = min(completion.size(), uniqueChars);
3572 bool changed = d->inlineCompletion_ != completion
3573 || d->inlineCompletionUniqueChars_ != uniqueChars;
3574 bool singlePar = true;
3575 d->inlineCompletion_ = completion;
3576 d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
3578 //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
3581 DocIterator const & old = d->inlineCompletionPos_;
3583 //lyxerr << "inlineCompletionPos changed" << std::endl;
3584 // old or pos are in another paragraph?
3585 if ((!samePar(cur, pos) && !pos.empty())
3586 || (!samePar(cur, old) && !old.empty())) {
3588 //lyxerr << "different paragraph" << std::endl;
3590 d->inlineCompletionPos_ = pos;
3595 if (singlePar && !(cur.result().screenUpdate() & Update::Force))
3596 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
3598 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::Force);
3603 bool BufferView::clickableInset() const
3605 return d->clickable_inset_;