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 "buffer_funcs.h"
22 #include "BufferList.h"
23 #include "BufferParams.h"
24 #include "CoordCache.h"
26 #include "CutAndPaste.h"
27 #include "DispatchResult.h"
28 #include "ErrorList.h"
30 #include "FloatList.h"
31 #include "FuncRequest.h"
32 #include "FuncStatus.h"
34 #include "InsetIterator.h"
36 #include "LaTeXFeatures.h"
37 #include "LayoutFile.h"
41 #include "LyXAction.h"
45 #include "MetricsInfo.h"
46 #include "Paragraph.h"
47 #include "ParagraphParameters.h"
48 #include "ParIterator.h"
49 #include "RowPainter.h"
52 #include "TextClass.h"
53 #include "TextMetrics.h"
55 #include "TocBackend.h"
56 #include "WordLangTuple.h"
58 #include "insets/InsetBibtex.h"
59 #include "insets/InsetCitation.h"
60 #include "insets/InsetCommand.h" // ChangeRefs
61 #include "insets/InsetExternal.h"
62 #include "insets/InsetGraphics.h"
63 #include "insets/InsetNote.h"
64 #include "insets/InsetRef.h"
65 #include "insets/InsetText.h"
67 #include "mathed/MathData.h"
68 #include "mathed/InsetMathNest.h"
70 #include "frontends/alert.h"
71 #include "frontends/Application.h"
72 #include "frontends/Delegates.h"
73 #include "frontends/FontMetrics.h"
74 #include "frontends/NullPainter.h"
75 #include "frontends/Painter.h"
76 #include "frontends/Selection.h"
78 #include "support/convert.h"
79 #include "support/debug.h"
80 #include "support/ExceptionMessage.h"
81 #include "support/filetools.h"
82 #include "support/gettext.h"
83 #include "support/lassert.h"
84 #include "support/lstrings.h"
85 #include "support/Package.h"
86 #include "support/types.h"
96 using namespace lyx::support;
100 namespace Alert = frontend::Alert;
104 /// Return an inset of this class if it exists at the current cursor position
106 T * getInsetByCode(Cursor const & cur, InsetCode code)
108 DocIterator it = cur;
109 Inset * inset = it.nextInset();
110 if (inset && inset->lyxCode() == code)
111 return static_cast<T*>(inset);
116 /// Note that comparing contents can only be used for InsetCommand
117 bool findNextInset(DocIterator & dit, vector<InsetCode> const & codes,
118 docstring const & contents)
120 DocIterator tmpdit = dit;
123 Inset const * inset = tmpdit.nextInset();
125 bool const valid_code = std::find(codes.begin(), codes.end(),
126 inset->lyxCode()) != codes.end();
127 InsetCommand const * ic = inset->asInsetCommand();
128 bool const same_or_no_contents = contents.empty()
129 || (ic && (ic->getFirstNonOptParam() == contents));
131 if (valid_code && same_or_no_contents) {
136 tmpdit.forwardInset();
143 /// Looks for next inset with one of the given codes.
144 /// Note that same_content can only be used for InsetCommand
145 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
149 DocIterator tmpdit = dit;
150 tmpdit.forwardInset();
154 Inset const * inset = tmpdit.nextInset();
155 if (same_content && inset) {
156 InsetCommand const * ic = inset->asInsetCommand();
158 bool const valid_code = std::find(codes.begin(), codes.end(),
159 ic->lyxCode()) != codes.end();
161 contents = ic->getFirstNonOptParam();
165 if (!findNextInset(tmpdit, codes, contents)) {
166 if (dit.depth() != 1 || dit.pit() != 0 || dit.pos() != 0) {
167 Inset * inset = &tmpdit.bottom().inset();
168 tmpdit = doc_iterator_begin(&inset->buffer(), inset);
169 if (!findNextInset(tmpdit, codes, contents))
181 /// Looks for next inset with the given code
182 void findInset(DocIterator & dit, InsetCode code, bool same_content)
184 findInset(dit, vector<InsetCode>(1, code), same_content);
188 /// Moves cursor to the next inset with one of the given codes.
189 void gotoInset(BufferView * bv, vector<InsetCode> const & codes,
192 Cursor tmpcur = bv->cursor();
193 if (!findInset(tmpcur, codes, same_content)) {
194 bv->cursor().message(_("No more insets"));
198 tmpcur.clearSelection();
199 bv->setCursor(tmpcur);
204 /// Moves cursor to the next inset with given code.
205 void gotoInset(BufferView * bv, InsetCode code, bool same_content)
207 gotoInset(bv, vector<InsetCode>(1, code), same_content);
211 /// A map from a Text to the associated text metrics
212 typedef map<Text const *, TextMetrics> TextMetricsCache;
214 enum ScreenUpdateStrategy {
224 /////////////////////////////////////////////////////////////////////
228 /////////////////////////////////////////////////////////////////////
230 struct BufferView::Private
232 Private(BufferView & bv) :
233 update_strategy_(FullScreenUpdate),
234 update_flags_(Update::Force),
236 anchor_pit_(0), anchor_ypos_(0),
237 inlineCompletionUniqueChars_(0),
238 last_inset_(0), clickable_inset_(false),
239 mouse_position_cache_(),
240 bookmark_edit_position_(-1), gui_(0),
241 horiz_scroll_offset_(0),
242 caret_ascent_(0), caret_descent_(0)
244 xsel_cache_.set = false;
248 ScrollbarParameters scrollbarParameters_;
250 ScreenUpdateStrategy update_strategy_;
252 Update::flags update_flags_;
254 CoordCache coord_cache_;
256 /// Estimated average par height for scrollbar.
258 /// this is used to handle XSelection events in the right manner.
267 pit_type anchor_pit_;
271 vector<int> par_height_;
274 DocIterator inlineCompletionPos_;
276 docstring inlineCompletion_;
278 size_t inlineCompletionUniqueChars_;
280 /// keyboard mapping object.
283 /// last visited inset.
284 /** kept to send setMouseHover(false).
285 * Not owned, so don't delete.
287 Inset const * last_inset_;
288 /// are we hovering something that we can click
289 bool clickable_inset_;
291 /// position of the mouse at the time of the last mouse move
292 /// This is used to update the hovering status of inset in
293 /// cases where the buffer is scrolled, but the mouse didn't move.
294 Point mouse_position_cache_;
296 // cache for id of the paragraph which was edited the last time
297 int bookmark_edit_position_;
299 mutable TextMetricsCache text_metrics_;
302 /** Not owned, so don't delete.
304 frontend::GuiBufferViewDelegate * gui_;
306 /// Cache for Find Next
307 FuncRequest search_request_cache_;
310 map<string, Inset *> edited_insets_;
312 /// When the row where the cursor lies is scrolled, this
313 /// contains the scroll offset
314 int horiz_scroll_offset_;
315 /// a slice pointing to the start of the row where the cursor
316 /// is (at last draw time)
317 CursorSlice current_row_slice_;
318 /// a slice pointing to the start of the row where cursor was
319 /// at previous draw event
320 CursorSlice last_row_slice_;
322 // The vertical size of the blinking caret. Only used for math
323 // Using it for text could be bad when undo restores the cursor
324 // current font, since the caret size could become wrong.
330 BufferView::BufferView(Buffer & buf)
331 : width_(0), height_(0), full_screen_(false), buffer_(buf),
332 d(new Private(*this))
334 d->xsel_cache_.set = false;
335 d->intl_.initKeyMapper(lyxrc.use_kbmap);
337 d->cursor_.setBuffer(&buf);
338 d->cursor_.push(buffer_.inset());
339 d->cursor_.resetAnchor();
340 d->cursor_.setCurrentFont();
342 buffer_.updatePreviews();
346 BufferView::~BufferView()
348 // current buffer is going to be switched-off, save cursor pos
349 // Ideally, the whole cursor stack should be saved, but session
350 // currently can only handle bottom (whole document) level pit and pos.
351 // That is to say, if a cursor is in a nested inset, it will be
352 // restore to the left of the top level inset.
353 LastFilePosSection::FilePos fp;
354 fp.file = buffer_.fileName();
355 fp.pit = d->cursor_.bottom().pit();
356 fp.pos = d->cursor_.bottom().pos();
357 theSession().lastFilePos().save(fp);
360 d->last_inset_->setMouseHover(this, false);
366 int BufferView::rightMargin() const
368 // The value used to be hardcoded to 10, which is 0.1in at 100dpi
369 int const default_margin = Length(0.1, Length::IN).inPixels(0);
370 // The additional test for the case the outliner is opened.
371 if (!full_screen_ || !lyxrc.full_screen_limit
372 || width_ < lyxrc.full_screen_width + 2 * default_margin)
373 return default_margin;
375 return (width_ - lyxrc.full_screen_width) / 2;
379 int BufferView::leftMargin() const
381 return rightMargin();
385 int BufferView::inPixels(Length const & len) const
387 Font const font = buffer().params().getFont();
388 return len.inPixels(workWidth(), theFontMetrics(font).em());
392 bool BufferView::isTopScreen() const
394 return 0 == d->scrollbarParameters_.min;
398 bool BufferView::isBottomScreen() const
400 return 0 == d->scrollbarParameters_.max;
404 Intl & BufferView::getIntl()
410 Intl const & BufferView::getIntl() const
416 CoordCache & BufferView::coordCache()
418 return d->coord_cache_;
422 CoordCache const & BufferView::coordCache() const
424 return d->coord_cache_;
428 Buffer & BufferView::buffer()
434 Buffer const & BufferView::buffer() const
440 bool BufferView::needsFitCursor() const
442 if (cursorStatus(d->cursor_) == CUR_INSIDE) {
443 frontend::FontMetrics const & fm =
444 theFontMetrics(d->cursor_.getFont().fontInfo());
445 int const asc = fm.maxAscent();
446 int const des = fm.maxDescent();
447 Point const p = getPos(d->cursor_);
448 if (p.y_ - asc >= 0 && p.y_ + des < height_)
457 // this is for debugging only.
458 string flagsAsString(Update::flags flags)
460 if (flags == Update::None)
462 return string((flags & Update::FitCursor) ? "FitCursor " : "")
463 + ((flags & Update::Force) ? "Force " : "")
464 + ((flags & Update::ForceDraw) ? "ForceDraw " : "")
465 + ((flags & Update::SinglePar) ? "SinglePar " : "")
466 + ((flags & Update::Decoration) ? "Decoration " : "");
471 void BufferView::processUpdateFlags(Update::flags flags)
473 LYXERR(Debug::PAINTING, "BufferView::processUpdateFlags( "
474 << flagsAsString(flags) << ") buffer: " << &buffer_);
476 // Case when no explicit update is requested.
477 if (flags == Update::None)
480 /* FIXME We would like to avoid doing this here, since it is very
481 * expensive and is called in updateBuffer already. However, even
482 * inserting a plain character can invalidate the overly fragile
483 * tables of child documents built by updateMacros. Some work is
484 * needed to avoid doing that when not necessary.
486 buffer_.updateMacros();
488 // SinglePar is ignored for now (this should probably change). We
489 // set it ourselves below, at the price of always rebreaking the
490 // paragraph at cursor. This can be expensive for large tables.
491 flags = flags & ~Update::SinglePar;
493 // First check whether the metrics and inset positions should be updated
494 if (flags & Update::Force) {
495 // This will update the CoordCache items and replace Force
496 // with ForceDraw in flags.
497 updateMetrics(flags);
500 // Detect whether we can only repaint a single paragraph.
501 // We handle this before FitCursor because the later will require
502 // correct metrics at cursor position.
503 if (!(flags & Update::ForceDraw)) {
504 if (singleParUpdate())
505 flags = flags | Update::SinglePar;
507 updateMetrics(flags);
510 // Then make sure that the screen contains the cursor if needed
511 if (flags & Update::FitCursor) {
512 if (needsFitCursor()) {
513 scrollToCursor(d->cursor_, false);
514 // Metrics have to be recomputed (maybe again)
515 updateMetrics(flags);
517 flags = flags & ~Update::FitCursor;
520 // Add flags to the the update flags. These will be reset to None
521 // after the redraw is actually done
522 d->update_flags_ = d->update_flags_ | flags;
523 LYXERR(Debug::PAINTING, "Cumulative flags: " << flagsAsString(flags));
525 // Now compute the update strategy
526 // Possibly values in flag are None, Decoration, ForceDraw
527 LATTEST((d->update_flags_ & ~(Update::None | Update::SinglePar
528 | Update::Decoration | Update::ForceDraw)) == 0);
530 if (d->update_flags_ & Update::ForceDraw)
531 d->update_strategy_ = FullScreenUpdate;
532 else if (d->update_flags_ & Update::Decoration)
533 d->update_strategy_ = DecorationUpdate;
534 else if (d->update_flags_ & Update::SinglePar)
535 d->update_strategy_ = SingleParUpdate;
537 // no need to redraw anything.
538 d->update_strategy_ = NoScreenUpdate;
541 updateHoveredInset();
544 buffer_.changed(false);
548 void BufferView::updateScrollbar()
550 if (height_ == 0 && width_ == 0)
553 // We prefer fixed size line scrolling.
554 d->scrollbarParameters_.single_step = defaultRowHeight();
555 // We prefer full screen page scrolling.
556 d->scrollbarParameters_.page_step = height_;
558 Text & t = buffer_.text();
559 TextMetrics & tm = d->text_metrics_[&t];
561 LYXERR(Debug::GUI, " Updating scrollbar: height: "
562 << t.paragraphs().size()
563 << " curr par: " << d->cursor_.bottom().pit()
564 << " default height " << defaultRowHeight());
566 size_t const parsize = t.paragraphs().size();
567 if (d->par_height_.size() != parsize) {
568 d->par_height_.clear();
569 // FIXME: We assume a default paragraph height of 2 rows. This
570 // should probably be pondered with the screen width.
571 d->par_height_.resize(parsize, defaultRowHeight() * 2);
574 // Look at paragraph heights on-screen
575 pair<pit_type, ParagraphMetrics const *> first = tm.first();
576 pair<pit_type, ParagraphMetrics const *> last = tm.last();
577 for (pit_type pit = first.first; pit <= last.first; ++pit) {
578 d->par_height_[pit] = tm.parMetrics(pit).height();
579 LYXERR(Debug::SCROLLING, "storing height for pit " << pit << " : "
580 << d->par_height_[pit]);
583 int top_pos = first.second->position() - first.second->ascent();
584 int bottom_pos = last.second->position() + last.second->descent();
585 bool first_visible = first.first == 0 && top_pos >= 0;
586 bool last_visible = last.first + 1 == int(parsize) && bottom_pos <= height_;
587 if (first_visible && last_visible) {
588 d->scrollbarParameters_.min = 0;
589 d->scrollbarParameters_.max = 0;
593 d->scrollbarParameters_.min = top_pos;
594 for (size_t i = 0; i != size_t(first.first); ++i)
595 d->scrollbarParameters_.min -= d->par_height_[i];
596 d->scrollbarParameters_.max = bottom_pos;
597 for (size_t i = last.first + 1; i != parsize; ++i)
598 d->scrollbarParameters_.max += d->par_height_[i];
600 // The reference is the top position so we remove one page.
601 if (lyxrc.scroll_below_document)
602 d->scrollbarParameters_.max -= minVisiblePart();
604 d->scrollbarParameters_.max -= d->scrollbarParameters_.page_step;
606 // 0 must be inside the range as it denotes the current position
607 if (d->scrollbarParameters_.max < 0)
608 d->scrollbarParameters_.max = 0;
609 if (d->scrollbarParameters_.min > 0)
610 d->scrollbarParameters_.min = 0;
614 ScrollbarParameters const & BufferView::scrollbarParameters() const
616 return d->scrollbarParameters_;
620 docstring BufferView::toolTip(int x, int y) const
622 // Get inset under mouse, if there is one.
623 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
625 // No inset, no tooltip...
627 return covering_inset->toolTip(*this, x, y);
631 string BufferView::contextMenu(int x, int y) const
633 //If there is a selection, return the containing inset menu
634 if (d->cursor_.selection())
635 return d->cursor_.inset().contextMenu(*this, x, y);
637 // Get inset under mouse, if there is one.
638 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
640 return covering_inset->contextMenu(*this, x, y);
642 return buffer_.inset().contextMenu(*this, x, y);
647 void BufferView::scrollDocView(int const value, bool update)
649 // The scrollbar values are relative to the top of the screen, therefore the
650 // offset is equal to the target value.
652 // No scrolling at all? No need to redraw anything
656 // If the offset is less than 2 screen height, prefer to scroll instead.
657 if (abs(value) <= 2 * height_) {
658 d->anchor_ypos_ -= value;
659 processUpdateFlags(Update::Force);
663 // cut off at the top
664 if (value <= d->scrollbarParameters_.min) {
665 DocIterator dit = doc_iterator_begin(&buffer_);
666 showCursor(dit, false, update);
667 LYXERR(Debug::SCROLLING, "scroll to top");
671 // cut off at the bottom
672 if (value >= d->scrollbarParameters_.max) {
673 DocIterator dit = doc_iterator_end(&buffer_);
675 showCursor(dit, false, update);
676 LYXERR(Debug::SCROLLING, "scroll to bottom");
680 // find paragraph at target position
681 int par_pos = d->scrollbarParameters_.min;
683 for (; i != int(d->par_height_.size()); ++i) {
684 par_pos += d->par_height_[i];
685 if (par_pos >= value)
689 if (par_pos < value) {
690 // It seems we didn't find the correct pit so stay on the safe side and
692 LYXERR0("scrolling position not found!");
693 scrollDocView(d->scrollbarParameters_.max, update);
697 DocIterator dit = doc_iterator_begin(&buffer_);
699 LYXERR(Debug::SCROLLING, "value = " << value << " -> scroll to pit " << i);
700 showCursor(dit, false, update);
704 // FIXME: this method is not working well.
705 void BufferView::setCursorFromScrollbar()
707 TextMetrics & tm = d->text_metrics_[&buffer_.text()];
709 int const height = 2 * defaultRowHeight();
710 int const first = height;
711 int const last = height_ - height;
713 Cursor const & oldcur = d->cursor_;
715 switch (cursorStatus(oldcur)) {
723 int const y = getPos(oldcur).y_;
724 newy = min(last, max(y, first));
728 // We reset the cursor because cursorStatus() does not
729 // work when the cursor is within mathed.
732 tm.setCursorFromCoordinates(cur, 0, newy);
734 // update the bufferview cursor and notify insets
735 // FIXME: Care about the d->cursor_ flags to redraw if needed
736 Cursor old = d->cursor_;
738 // the DEPM call in mouseSetCursor() might have destroyed the
739 // paragraph the cursor is in.
740 bool badcursor = old.fixIfBroken();
741 badcursor |= notifyCursorLeavesOrEnters(old, d->cursor_);
743 d->cursor_.fixIfBroken();
747 Change const BufferView::getCurrentChange() const
749 if (!d->cursor_.selection())
750 return Change(Change::UNCHANGED);
752 DocIterator dit = d->cursor_.selectionBegin();
753 // The selected content might have been changed (see #7685)
754 dit = dit.getInnerText();
755 return dit.paragraph().lookupChange(dit.pos());
759 // this could be used elsewhere as well?
760 // FIXME: This does not work within mathed!
761 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
763 Point const p = getPos(dit);
766 if (p.y_ > workHeight())
772 void BufferView::bookmarkEditPosition()
774 // Don't eat cpu time for each keystroke
775 if (d->cursor_.paragraph().id() == d->bookmark_edit_position_)
778 d->bookmark_edit_position_ = d->cursor_.paragraph().id();
782 void BufferView::saveBookmark(unsigned int idx)
784 // tentatively save bookmark, id and pos will be used to
785 // acturately locate a bookmark in a 'live' lyx session.
786 // pit and pos will be updated with bottom level pit/pos
788 if (!buffer_.isInternal()) {
789 theSession().bookmarks().save(
791 d->cursor_.bottom().pit(),
792 d->cursor_.bottom().pos(),
793 d->cursor_.paragraph().id(),
798 // emit message signal.
799 message(_("Save bookmark"));
804 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
805 int top_id, pos_type top_pos)
807 bool success = false;
810 d->cursor_.clearSelection();
812 // if a valid par_id is given, try it first
813 // This is the case for a 'live' bookmark when unique paragraph ID
814 // is used to track bookmarks.
816 dit = buffer_.getParFromID(top_id);
818 dit.pos() = min(dit.paragraph().size(), top_pos);
819 // Some slices of the iterator may not be
820 // reachable (e.g. closed collapsible inset)
821 // so the dociterator may need to be
822 // shortened. Otherwise, setCursor may crash
823 // lyx when the cursor can not be set to these
825 size_t const n = dit.depth();
826 for (size_t i = 0; i < n; ++i)
827 if (!dit[i].inset().editable()) {
835 // if top_id == 0, or searching through top_id failed
836 // This is the case for a 'restored' bookmark when only bottom
837 // (document level) pit was saved. Because of this, bookmark
838 // restoration is inaccurate. If a bookmark was within an inset,
839 // it will be restored to the left of the outmost inset that contains
841 if (bottom_pit < int(buffer_.paragraphs().size())) {
842 dit = doc_iterator_begin(&buffer_);
844 dit.pit() = bottom_pit;
845 dit.pos() = min(bottom_pos, dit.paragraph().size());
850 // Note: only bottom (document) level pit is set.
852 // set the current font.
853 d->cursor_.setCurrentFont();
854 // Do not forget to reset the anchor (see #9912)
855 d->cursor_.resetAnchor();
856 processUpdateFlags(Update::Force | Update::FitCursor);
863 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
865 if (d->cursor_.real_current_font.isRightToLeft()) {
866 if (d->intl_.keymap == Intl::PRIMARY)
867 d->intl_.keyMapSec();
869 if (d->intl_.keymap == Intl::SECONDARY)
870 d->intl_.keyMapPrim();
873 d->intl_.getTransManager().translateAndInsert(c, t, cur);
877 int BufferView::workWidth() const
883 void BufferView::recenter()
885 showCursor(d->cursor_, true, true);
889 void BufferView::showCursor()
891 showCursor(d->cursor_, false, true);
895 void BufferView::showCursor(DocIterator const & dit,
896 bool recenter, bool update)
898 if (scrollToCursor(dit, recenter) && update)
899 processUpdateFlags(Update::Force);
903 void BufferView::scrollToCursor()
905 if (scrollToCursor(d->cursor_, false))
906 processUpdateFlags(Update::Force);
910 bool BufferView::scrollToCursor(DocIterator const & dit, bool const recenter)
912 // We are not properly started yet, delay until resizing is
917 LYXERR(Debug::SCROLLING, "recentering!");
919 CursorSlice const & bot = dit.bottom();
920 TextMetrics & tm = d->text_metrics_[bot.text()];
922 pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
923 int bot_pit = bot.pit();
924 if (bot_pit > max_pit) {
925 // FIXME: Why does this happen?
926 LYXERR0("bottom pit is greater that max pit: "
927 << bot_pit << " > " << max_pit);
931 if (bot_pit == tm.first().first - 1)
932 tm.newParMetricsUp();
933 else if (bot_pit == tm.last().first + 1)
934 tm.newParMetricsDown();
936 if (tm.contains(bot_pit)) {
937 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
938 LBUFERR(!pm.rows().empty());
939 // FIXME: smooth scrolling doesn't work in mathed.
940 CursorSlice const & cs = dit.innerTextSlice();
941 int offset = coordOffset(dit).y_;
942 int ypos = pm.position() + offset;
943 Dimension const & row_dim =
944 pm.getRow(cs.pos(), dit.boundary()).dimension();
947 scrolled = scroll(ypos - height_/2);
949 // We try to visualize the whole row, if the row height is larger than
950 // the screen height, we scroll to a heuristic value of height_ / 4.
951 // FIXME: This heuristic value should be replaced by a recursive search
952 // for a row in the inset that can be visualized completely.
953 else if (row_dim.height() > height_) {
954 if (ypos < defaultRowHeight())
955 scrolled = scroll(ypos - height_ / 4);
956 else if (ypos > height_ - defaultRowHeight())
957 scrolled = scroll(ypos - 3 * height_ / 4);
960 // If the top part of the row falls of the screen, we scroll
961 // up to align the top of the row with the top of the screen.
962 else if (ypos - row_dim.ascent() < 0 && ypos < height_) {
963 int ynew = row_dim.ascent();
964 scrolled = scrollUp(ynew - ypos);
967 // If the bottom of the row falls of the screen, we scroll down.
968 else if (ypos + row_dim.descent() > height_ && ypos > 0) {
969 int ynew = height_ - row_dim.descent();
970 scrolled = scrollDown(ypos - ynew);
973 // else, nothing to do, the cursor is already visible so we just return.
974 return scrolled != 0;
977 // fix inline completion position
978 if (d->inlineCompletionPos_.fixIfBroken())
979 d->inlineCompletionPos_ = DocIterator();
981 tm.redoParagraph(bot_pit);
982 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
983 int offset = coordOffset(dit).y_;
985 d->anchor_pit_ = bot_pit;
986 CursorSlice const & cs = dit.innerTextSlice();
987 Dimension const & row_dim =
988 pm.getRow(cs.pos(), dit.boundary()).dimension();
991 d->anchor_ypos_ = height_/2;
992 else if (d->anchor_pit_ == 0)
993 d->anchor_ypos_ = offset + pm.ascent();
994 else if (d->anchor_pit_ == max_pit)
995 d->anchor_ypos_ = height_ - offset - row_dim.descent();
996 else if (offset > height_)
997 d->anchor_ypos_ = height_ - offset - defaultRowHeight();
999 d->anchor_ypos_ = defaultRowHeight() * 2;
1005 void BufferView::makeDocumentClass()
1007 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1008 buffer_.params().makeDocumentClass();
1009 updateDocumentClass(olddc);
1013 void BufferView::updateDocumentClass(DocumentClassConstPtr olddc)
1015 message(_("Converting document to new document class..."));
1017 StableDocIterator backcur(d->cursor_);
1018 ErrorList & el = buffer_.errorList("Class Switch");
1019 cap::switchBetweenClasses(
1020 olddc, buffer_.params().documentClassPtr(),
1021 static_cast<InsetText &>(buffer_.inset()), el);
1023 setCursor(backcur.asDocIterator(&buffer_));
1025 buffer_.errors("Class Switch");
1029 /** Return the change status at cursor position, taking into account the
1030 * status at each level of the document iterator (a table in a deleted
1031 * footnote is deleted).
1032 * When \param outer is true, the top slice is not looked at.
1034 static Change::Type lookupChangeType(DocIterator const & dit, bool outer = false)
1036 size_t const depth = dit.depth() - (outer ? 1 : 0);
1038 for (size_t i = 0 ; i < depth ; ++i) {
1039 CursorSlice const & slice = dit[i];
1040 if (!slice.inset().inMathed()
1041 && slice.pos() < slice.paragraph().size()) {
1042 Change::Type const ch = slice.paragraph().lookupChange(slice.pos()).type;
1043 if (ch != Change::UNCHANGED)
1047 return Change::UNCHANGED;
1051 bool BufferView::getStatus(FuncRequest const & cmd, FuncStatus & flag)
1053 FuncCode const act = cmd.action();
1055 // Can we use a readonly buffer?
1056 if (buffer_.isReadonly()
1057 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1058 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1059 if (buffer_.hasReadonlyFlag())
1060 flag.message(from_utf8(N_("Document is read-only")));
1062 flag.message(from_utf8(N_("Document has been modified externally")));
1063 flag.setEnabled(false);
1067 // Are we in a DELETED change-tracking region?
1068 if (lookupChangeType(d->cursor_, true) == Change::DELETED
1069 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1070 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1071 flag.message(from_utf8(N_("This portion of the document is deleted.")));
1072 flag.setEnabled(false);
1076 Cursor & cur = d->cursor_;
1078 if (cur.getStatus(cmd, flag))
1083 // FIXME: This is a bit problematic because we don't check if this is
1084 // a document BufferView or not for these LFUNs. We probably have to
1085 // dispatch both to currentBufferView() and, if that fails,
1086 // to documentBufferView(); same as we do now for current Buffer and
1087 // document Buffer. Ideally those LFUN should go to Buffer as they
1088 // operate on the full Buffer and the cursor is only needed either for
1089 // an Undo record or to restore a cursor position. But we don't know
1090 // how to do that inside Buffer of course.
1091 case LFUN_BUFFER_PARAMS_APPLY:
1092 case LFUN_LAYOUT_MODULES_CLEAR:
1093 case LFUN_LAYOUT_MODULE_ADD:
1094 case LFUN_LAYOUT_RELOAD:
1095 case LFUN_TEXTCLASS_APPLY:
1096 case LFUN_TEXTCLASS_LOAD:
1097 flag.setEnabled(!buffer_.isReadonly());
1101 // We do not use the LyXAction flag for readonly because Undo sets the
1102 // buffer clean/dirty status by itself.
1103 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasUndoStack());
1106 // We do not use the LyXAction flag for readonly because Redo sets the
1107 // buffer clean/dirty status by itself.
1108 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasRedoStack());
1110 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
1111 case LFUN_FILE_INSERT_PLAINTEXT: {
1112 docstring const fname = cmd.argument();
1113 if (!FileName::isAbsolute(to_utf8(fname))) {
1114 flag.message(_("Absolute filename expected."));
1117 flag.setEnabled(cur.inTexted());
1120 case LFUN_FILE_INSERT:
1121 case LFUN_BOOKMARK_SAVE:
1122 // FIXME: Actually, these LFUNS should be moved to Text
1123 flag.setEnabled(cur.inTexted());
1126 case LFUN_FONT_STATE:
1127 case LFUN_LABEL_INSERT:
1128 case LFUN_INFO_INSERT:
1129 case LFUN_PARAGRAPH_GOTO:
1130 case LFUN_NOTE_NEXT:
1131 case LFUN_REFERENCE_NEXT:
1132 case LFUN_WORD_FIND:
1133 case LFUN_WORD_FIND_FORWARD:
1134 case LFUN_WORD_FIND_BACKWARD:
1135 case LFUN_WORD_REPLACE:
1138 case LFUN_MARK_TOGGLE:
1139 case LFUN_SCREEN_RECENTER:
1140 case LFUN_SCREEN_SHOW_CURSOR:
1141 case LFUN_BIBTEX_DATABASE_ADD:
1142 case LFUN_BIBTEX_DATABASE_DEL:
1143 case LFUN_STATISTICS:
1144 case LFUN_KEYMAP_OFF:
1145 case LFUN_KEYMAP_PRIMARY:
1146 case LFUN_KEYMAP_SECONDARY:
1147 case LFUN_KEYMAP_TOGGLE:
1148 case LFUN_INSET_SELECT_ALL:
1149 flag.setEnabled(true);
1152 case LFUN_GRAPHICS_UNIFY:
1153 flag.setEnabled(cur.countInsetsInSelection(GRAPHICS_CODE)>1);
1156 case LFUN_WORD_FINDADV: {
1157 FindAndReplaceOptions opt;
1158 istringstream iss(to_utf8(cmd.argument()));
1160 flag.setEnabled(opt.repl_buf_name.empty()
1161 || !buffer_.isReadonly());
1165 case LFUN_LABEL_GOTO:
1166 flag.setEnabled(!cmd.argument().empty()
1167 || getInsetByCode<InsetRef>(cur, REF_CODE));
1170 case LFUN_CHANGES_MERGE:
1171 case LFUN_CHANGE_NEXT:
1172 case LFUN_CHANGE_PREVIOUS:
1173 case LFUN_ALL_CHANGES_ACCEPT:
1174 case LFUN_ALL_CHANGES_REJECT:
1175 flag.setEnabled(buffer_.areChangesPresent());
1178 case LFUN_SCREEN_UP:
1179 case LFUN_SCREEN_DOWN:
1181 case LFUN_SCREEN_UP_SELECT:
1182 case LFUN_SCREEN_DOWN_SELECT:
1183 case LFUN_INSET_FORALL:
1184 flag.setEnabled(true);
1187 case LFUN_LAYOUT_TABULAR:
1188 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
1192 flag.setEnabled(!cur.inset().forcePlainLayout(cur.idx()));
1195 case LFUN_LAYOUT_PARAGRAPH:
1196 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
1199 case LFUN_BRANCH_ADD_INSERT:
1200 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1203 case LFUN_DIALOG_SHOW_NEW_INSET:
1204 // FIXME: this is wrong, but I do not understand the
1206 if (cur.inset().lyxCode() == CAPTION_CODE)
1207 return cur.inset().getStatus(cur, cmd, flag);
1208 // FIXME we should consider passthru paragraphs too.
1209 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1212 case LFUN_CITATION_INSERT: {
1213 FuncRequest fr(LFUN_INSET_INSERT, "citation");
1214 // FIXME: This could turn in a recursive hell.
1215 // Shouldn't we use Buffer::getStatus() instead?
1216 flag.setEnabled(lyx::getStatus(fr).enabled());
1219 case LFUN_INSET_APPLY: {
1220 string const name = cmd.getArg(0);
1221 Inset * inset = editedInset(name);
1223 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1224 if (!inset->getStatus(cur, fr, flag)) {
1225 // Every inset is supposed to handle this
1226 LASSERT(false, break);
1229 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1230 flag = lyx::getStatus(fr);
1243 Inset * BufferView::editedInset(string const & name) const
1245 map<string, Inset *>::const_iterator it = d->edited_insets_.find(name);
1246 return it == d->edited_insets_.end() ? 0 : it->second;
1250 void BufferView::editInset(string const & name, Inset * inset)
1253 d->edited_insets_[name] = inset;
1255 d->edited_insets_.erase(name);
1259 void BufferView::dispatch(FuncRequest const & cmd, DispatchResult & dr)
1261 LYXERR(Debug::ACTION, "BufferView::dispatch: cmd: " << cmd);
1263 string const argument = to_utf8(cmd.argument());
1264 Cursor & cur = d->cursor_;
1267 // Don't dispatch function that does not apply to internal buffers.
1268 if (buffer_.isInternal()
1269 && lyxaction.funcHasFlag(cmd.action(), LyXAction::NoInternal))
1272 // We'll set this back to false if need be.
1273 bool dispatched = true;
1274 buffer_.undo().beginUndoGroup();
1276 FuncCode const act = cmd.action();
1279 case LFUN_BUFFER_PARAMS_APPLY: {
1280 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1281 cur.recordUndoBufferParams();
1282 istringstream ss(to_utf8(cmd.argument()));
1285 int const unknown_tokens = buffer_.readHeader(lex);
1286 if (unknown_tokens != 0) {
1287 LYXERR0("Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1288 << unknown_tokens << " unknown token"
1289 << (unknown_tokens == 1 ? "" : "s"));
1291 updateDocumentClass(olddc);
1293 // We are most certainly here because of a change in the document
1294 // It is then better to make sure that all dialogs are in sync with
1295 // current document settings.
1296 dr.screenUpdate(Update::Force | Update::FitCursor);
1297 dr.forceBufferUpdate();
1301 case LFUN_LAYOUT_MODULES_CLEAR: {
1302 // FIXME: this modifies the document in cap::switchBetweenClasses
1303 // without calling recordUndo. Fix this before using
1304 // recordUndoBufferParams().
1305 cur.recordUndoFullBuffer();
1306 buffer_.params().clearLayoutModules();
1307 makeDocumentClass();
1308 dr.screenUpdate(Update::Force);
1309 dr.forceBufferUpdate();
1313 case LFUN_LAYOUT_MODULE_ADD: {
1314 BufferParams const & params = buffer_.params();
1315 if (!params.layoutModuleCanBeAdded(argument)) {
1316 LYXERR0("Module `" << argument <<
1317 "' cannot be added due to failed requirements or "
1318 "conflicts with installed modules.");
1321 // FIXME: this modifies the document in cap::switchBetweenClasses
1322 // without calling recordUndo. Fix this before using
1323 // recordUndoBufferParams().
1324 cur.recordUndoFullBuffer();
1325 buffer_.params().addLayoutModule(argument);
1326 makeDocumentClass();
1327 dr.screenUpdate(Update::Force);
1328 dr.forceBufferUpdate();
1332 case LFUN_TEXTCLASS_APPLY: {
1333 // since this shortcircuits, the second call is made only if
1335 bool const success =
1336 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1337 LayoutFileList::get().load(argument, buffer_.filePath());
1339 docstring s = bformat(_("The document class `%1$s' "
1340 "could not be loaded."), from_utf8(argument));
1341 frontend::Alert::error(_("Could not load class"), s);
1345 LayoutFile const * old_layout = buffer_.params().baseClass();
1346 LayoutFile const * new_layout = &(LayoutFileList::get()[argument]);
1348 if (old_layout == new_layout)
1352 // Save the old, possibly modular, layout for use in conversion.
1353 // FIXME: this modifies the document in cap::switchBetweenClasses
1354 // without calling recordUndo. Fix this before using
1355 // recordUndoBufferParams().
1356 cur.recordUndoFullBuffer();
1357 buffer_.params().setBaseClass(argument, buffer_.layoutPos());
1358 makeDocumentClass();
1359 dr.screenUpdate(Update::Force);
1360 dr.forceBufferUpdate();
1364 case LFUN_TEXTCLASS_LOAD: {
1365 // since this shortcircuits, the second call is made only if
1367 bool const success =
1368 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1369 LayoutFileList::get().load(argument, buffer_.filePath());
1371 docstring s = bformat(_("The document class `%1$s' "
1372 "could not be loaded."), from_utf8(argument));
1373 frontend::Alert::error(_("Could not load class"), s);
1378 case LFUN_LAYOUT_RELOAD: {
1379 LayoutFileIndex bc = buffer_.params().baseClassID();
1380 LayoutFileList::get().reset(bc);
1381 buffer_.params().setBaseClass(bc, buffer_.layoutPos());
1382 makeDocumentClass();
1383 dr.screenUpdate(Update::Force);
1384 dr.forceBufferUpdate();
1389 dr.setMessage(_("Undo"));
1390 cur.clearSelection();
1391 // We need to find out if the bibliography information
1392 // has changed. See bug #11055.
1393 // So these should not be references...
1394 LayoutModuleList const engines = buffer().params().citeEngine();
1395 CiteEngineType const enginetype = buffer().params().citeEngineType();
1396 if (!cur.textUndo())
1397 dr.setMessage(_("No further undo information"));
1399 dr.screenUpdate(Update::Force | Update::FitCursor);
1400 dr.forceBufferUpdate();
1401 if (buffer().params().citeEngine() != engines ||
1402 buffer().params().citeEngineType() != enginetype)
1403 buffer().invalidateCiteLabels();
1409 dr.setMessage(_("Redo"));
1410 cur.clearSelection();
1411 // We need to find out if the bibliography information
1412 // has changed. See bug #11055.
1413 // So these should not be references...
1414 LayoutModuleList const engines = buffer().params().citeEngine();
1415 CiteEngineType const enginetype = buffer().params().citeEngineType();
1416 if (!cur.textRedo())
1417 dr.setMessage(_("No further redo information"));
1419 dr.screenUpdate(Update::Force | Update::FitCursor);
1420 dr.forceBufferUpdate();
1421 if (buffer().params().citeEngine() != engines ||
1422 buffer().params().citeEngineType() != enginetype)
1423 buffer().invalidateCiteLabels();
1428 case LFUN_FONT_STATE:
1429 dr.setMessage(cur.currentState(false));
1432 case LFUN_BOOKMARK_SAVE:
1433 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1436 case LFUN_LABEL_GOTO: {
1437 docstring label = cmd.argument();
1438 if (label.empty()) {
1440 getInsetByCode<InsetRef>(cur, REF_CODE);
1442 label = inset->getParam("reference");
1443 // persistent=false: use temp_bookmark
1447 if (!label.empty()) {
1449 // at the moment, this is redundant, since gotoLabel will
1450 // eventually call LFUN_PARAGRAPH_GOTO, but it seems best
1452 dr.screenUpdate(Update::Force | Update::FitCursor);
1457 case LFUN_PARAGRAPH_GOTO: {
1458 int const id = convert<int>(cmd.getArg(0));
1459 pos_type const pos = convert<int>(cmd.getArg(1));
1462 string const str_id_end = cmd.getArg(2);
1463 string const str_pos_end = cmd.getArg(3);
1465 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1466 b = theBufferList().next(b)) {
1469 cur.setCursor(b->getParFromID(id));
1471 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1475 LYXERR(Debug::INFO, "Paragraph " << cur.paragraph().id()
1476 << " found in buffer `"
1477 << b->absFileName() << "'.");
1479 if (b == &buffer_) {
1481 if (str_id_end.empty() || str_pos_end.empty()) {
1484 mouseSetCursor(cur);
1487 int const id_end = convert<int>(str_id_end);
1488 pos_type const pos_end = convert<int>(str_pos_end);
1489 success = setCursorFromEntries({id, pos},
1493 dr.screenUpdate(Update::Force | Update::FitCursor);
1495 // Switch to other buffer view and resend cmd
1496 lyx::dispatch(FuncRequest(
1497 LFUN_BUFFER_SWITCH, b->absFileName()));
1505 case LFUN_NOTE_NEXT:
1506 gotoInset(this, NOTE_CODE, false);
1507 // FIXME: if SinglePar is changed to act on the inner
1508 // paragraph, this will not be OK anymore. The update is
1509 // useful for auto-open collapsible insets.
1510 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1513 case LFUN_REFERENCE_NEXT: {
1514 vector<InsetCode> tmp;
1515 tmp.push_back(LABEL_CODE);
1516 tmp.push_back(REF_CODE);
1517 gotoInset(this, tmp, true);
1518 // FIXME: if SinglePar is changed to act on the inner
1519 // paragraph, this will not be OK anymore. The update is
1520 // useful for auto-open collapsible insets.
1521 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1525 case LFUN_CHANGE_NEXT:
1526 findNextChange(this);
1527 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1528 dr.screenUpdate(Update::Force | Update::FitCursor);
1531 case LFUN_CHANGE_PREVIOUS:
1532 findPreviousChange(this);
1533 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1534 dr.screenUpdate(Update::Force | Update::FitCursor);
1537 case LFUN_CHANGES_MERGE:
1538 if (findNextChange(this) || findPreviousChange(this)) {
1539 dr.screenUpdate(Update::Force | Update::FitCursor);
1540 dr.forceBufferUpdate();
1541 showDialog("changes");
1545 case LFUN_ALL_CHANGES_ACCEPT:
1546 // select complete document
1548 cur.selHandle(true);
1549 buffer_.text().cursorBottom(cur);
1550 // accept everything in a single step to support atomic undo
1551 buffer_.text().acceptOrRejectChanges(cur, Text::ACCEPT);
1553 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1554 dr.screenUpdate(Update::Force | Update::FitCursor);
1555 dr.forceBufferUpdate();
1558 case LFUN_ALL_CHANGES_REJECT:
1559 // select complete document
1561 cur.selHandle(true);
1562 buffer_.text().cursorBottom(cur);
1563 // reject everything in a single step to support atomic undo
1564 // Note: reject does not work recursively; the user may have to repeat the operation
1565 buffer_.text().acceptOrRejectChanges(cur, Text::REJECT);
1567 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1568 dr.screenUpdate(Update::Force | Update::FitCursor);
1569 dr.forceBufferUpdate();
1572 case LFUN_WORD_FIND_FORWARD:
1573 case LFUN_WORD_FIND_BACKWARD: {
1575 // Would it maybe be better if this variable were view specific anyway?
1576 static docstring last_search;
1577 docstring searched_string;
1579 if (!cmd.argument().empty()) {
1580 last_search = cmd.argument();
1581 searched_string = cmd.argument();
1583 searched_string = last_search;
1586 if (searched_string.empty())
1589 bool const fw = act == LFUN_WORD_FIND_FORWARD;
1590 docstring const data =
1591 find2string(searched_string, true, false, fw);
1592 bool found = lyxfind(this, FuncRequest(LFUN_WORD_FIND, data));
1594 dr.screenUpdate(Update::Force | Update::FitCursor);
1598 case LFUN_WORD_FIND: {
1599 FuncRequest req = cmd;
1600 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1601 req = d->search_request_cache_;
1602 if (req.argument().empty()) {
1603 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, "findreplace"));
1606 if (lyxfind(this, req))
1607 dr.screenUpdate(Update::Force | Update::FitCursor);
1609 d->search_request_cache_ = req;
1613 case LFUN_WORD_REPLACE: {
1614 bool has_deleted = false;
1615 if (cur.selection()) {
1616 DocIterator beg = cur.selectionBegin();
1617 DocIterator end = cur.selectionEnd();
1618 if (beg.pit() == end.pit()) {
1619 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1620 if (!cur.inMathed() && cur.paragraph().isDeleted(p)) {
1627 if (lyxreplace(this, cmd, has_deleted)) {
1628 dr.forceBufferUpdate();
1629 dr.screenUpdate(Update::Force | Update::FitCursor);
1634 case LFUN_WORD_FINDADV: {
1635 FindAndReplaceOptions opt;
1636 istringstream iss(to_utf8(cmd.argument()));
1638 if (findAdv(this, opt)) {
1639 dr.screenUpdate(Update::Force | Update::FitCursor);
1650 cur.clearSelection();
1651 dr.setMessage(from_utf8(N_("Mark off")));
1655 cur.clearSelection();
1657 dr.setMessage(from_utf8(N_("Mark on")));
1660 case LFUN_MARK_TOGGLE:
1661 cur.selection(false);
1664 dr.setMessage(from_utf8(N_("Mark removed")));
1667 dr.setMessage(from_utf8(N_("Mark set")));
1672 case LFUN_SCREEN_SHOW_CURSOR:
1676 case LFUN_SCREEN_RECENTER:
1680 case LFUN_BIBTEX_DATABASE_ADD: {
1681 Cursor tmpcur = cur;
1682 findInset(tmpcur, BIBTEX_CODE, false);
1683 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1686 if (inset->addDatabase(cmd.argument())) {
1687 dr.forceBufferUpdate();
1693 case LFUN_BIBTEX_DATABASE_DEL: {
1694 Cursor tmpcur = cur;
1695 findInset(tmpcur, BIBTEX_CODE, false);
1696 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1699 if (inset->delDatabase(cmd.argument()))
1700 dr.forceBufferUpdate();
1705 case LFUN_GRAPHICS_UNIFY: {
1707 cur.recordUndoFullBuffer();
1709 DocIterator from, to;
1710 from = cur.selectionBegin();
1711 to = cur.selectionEnd();
1713 string const newId = cmd.getArg(0);
1714 bool fetchId = newId.empty(); //if we wait for groupId from first graphics inset
1716 InsetGraphicsParams grp_par;
1718 InsetGraphics::string2params(graphics::getGroupParams(buffer_, newId), buffer_, grp_par);
1720 if (!from.nextInset()) //move to closest inset
1721 from.forwardInset();
1723 while (!from.empty() && from < to) {
1724 Inset * inset = from.nextInset();
1727 if (inset->lyxCode() == GRAPHICS_CODE) {
1728 InsetGraphics & ig = static_cast<InsetGraphics &>(*inset);
1729 InsetGraphicsParams inspar = ig.getParams();
1734 grp_par.filename = inspar.filename;
1735 ig.setParams(grp_par);
1738 from.forwardInset();
1740 dr.screenUpdate(Update::Force); //needed if triggered from context menu
1744 case LFUN_STATISTICS: {
1745 DocIterator from, to;
1746 if (cur.selection()) {
1747 from = cur.selectionBegin();
1748 to = cur.selectionEnd();
1750 from = doc_iterator_begin(&buffer_);
1751 to = doc_iterator_end(&buffer_);
1753 buffer_.updateStatistics(from, to);
1754 int const words = buffer_.wordCount();
1755 int const chars = buffer_.charCount(false);
1756 int const chars_blanks = buffer_.charCount(true);
1758 if (cur.selection())
1759 message = _("Statistics for the selection:");
1761 message = _("Statistics for the document:");
1764 message += bformat(_("%1$d words"), words);
1766 message += _("One word");
1768 if (chars_blanks != 1)
1769 message += bformat(_("%1$d characters (including blanks)"),
1772 message += _("One character (including blanks)");
1775 message += bformat(_("%1$d characters (excluding blanks)"),
1778 message += _("One character (excluding blanks)");
1780 Alert::information(_("Statistics"), message);
1784 case LFUN_SCREEN_UP:
1785 case LFUN_SCREEN_DOWN: {
1786 Point p = getPos(cur);
1787 // This code has been commented out to enable to scroll down a
1788 // document, even if there are large insets in it (see bug #5465).
1789 /*if (p.y_ < 0 || p.y_ > height_) {
1790 // The cursor is off-screen so recenter before proceeding.
1794 int const scrolled = scroll(act == LFUN_SCREEN_UP
1795 ? -height_ : height_);
1796 if (act == LFUN_SCREEN_UP && scrolled > -height_)
1798 if (act == LFUN_SCREEN_DOWN && scrolled < height_)
1799 p = Point(width_, height_);
1800 bool const in_texted = cur.inTexted();
1801 cur.setCursor(doc_iterator_begin(cur.buffer()));
1802 cur.selHandle(false);
1803 // Force an immediate computation of metrics because we need it below
1804 processUpdateFlags(Update::Force);
1806 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_,
1807 true, act == LFUN_SCREEN_UP);
1808 //FIXME: what to do with cur.x_target()?
1809 bool update = in_texted && cur.bv().checkDepm(cur, old);
1812 if (update || cur.mark())
1813 dr.screenUpdate(Update::Force | Update::FitCursor);
1815 dr.forceBufferUpdate();
1820 string const scroll_type = cmd.getArg(0);
1821 int scroll_step = 0;
1822 if (scroll_type == "line")
1823 scroll_step = d->scrollbarParameters_.single_step;
1824 else if (scroll_type == "page")
1825 scroll_step = d->scrollbarParameters_.page_step;
1828 string const scroll_quantity = cmd.getArg(1);
1829 if (scroll_quantity == "up")
1830 scrollUp(scroll_step);
1831 else if (scroll_quantity == "down")
1832 scrollDown(scroll_step);
1834 int const scroll_value = convert<int>(scroll_quantity);
1836 scroll(scroll_step * scroll_value);
1838 dr.screenUpdate(Update::ForceDraw);
1839 dr.forceBufferUpdate();
1843 case LFUN_SCREEN_UP_SELECT: {
1844 // FIXME: why is the algorithm different from LFUN_SCREEN_UP?
1845 cur.selHandle(true);
1846 if (isTopScreen()) {
1847 lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1851 int y = getPos(cur).y_;
1852 int const ymin = y - height_ + defaultRowHeight();
1853 while (y > ymin && cur.up())
1857 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1861 case LFUN_SCREEN_DOWN_SELECT: {
1862 // FIXME: why is the algorithm different from LFUN_SCREEN_DOWN?
1863 cur.selHandle(true);
1864 if (isBottomScreen()) {
1865 lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1869 int y = getPos(cur).y_;
1870 int const ymax = y + height_ - defaultRowHeight();
1871 while (y < ymax && cur.down())
1875 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1880 case LFUN_INSET_SELECT_ALL: {
1881 // true if all cells are selected
1882 bool const all_selected = cur.depth() > 1
1883 && cur.selBegin().at_begin()
1884 && cur.selEnd().at_end();
1885 // true if some cells are selected
1886 bool const cells_selected = cur.depth() > 1
1887 && cur.selBegin().at_cell_begin()
1888 && cur.selEnd().at_cell_end();
1889 if (all_selected || (cells_selected && !cur.inset().isTable())) {
1890 // All the contents of the inset if selected, or only at
1891 // least one cell but inset is not a table.
1892 // Select the inset from outside.
1895 cur.selection(true);
1897 } else if (cells_selected) {
1898 // At least one complete cell is selected and inset is a table.
1904 cur.selection(true);
1905 cur.idx() = cur.lastidx();
1906 cur.pit() = cur.lastpit();
1907 cur.pos() = cur.lastpos();
1909 // select current cell
1913 cur.selection(true);
1914 cur.pit() = cur.lastpit();
1915 cur.pos() = cur.lastpos();
1917 cur.setCurrentFont();
1918 dr.screenUpdate(Update::Force);
1923 case LFUN_UNICODE_INSERT: {
1924 if (cmd.argument().empty())
1927 FuncCode code = cur.inset().currentMode() == Inset::MATH_MODE ?
1928 LFUN_MATH_INSERT : LFUN_SELF_INSERT;
1931 docstring const arg = from_utf8(cmd.getArg(i));
1935 LYXERR0("Not a hexstring: " << arg);
1939 char_type c = hexToInt(arg);
1940 if (c >= 32 && c < 0x10ffff) {
1941 LYXERR(Debug::KEY, "Inserting c: " << c);
1942 lyx::dispatch(FuncRequest(code, docstring(1, c)));
1950 // This would be in Buffer class if only Cursor did not
1951 // require a bufferview
1952 case LFUN_INSET_FORALL: {
1953 docstring const name = from_utf8(cmd.getArg(0));
1954 string const commandstr = cmd.getLongArg(1);
1955 FuncRequest const fr = lyxaction.lookupFunc(commandstr);
1957 // an arbitrary number to limit number of iterations
1958 const int max_iter = 100000;
1960 Cursor & cur = d->cursor_;
1961 Cursor const savecur = cur;
1963 if (!cur.nextInset())
1965 cur.beginUndoGroup();
1966 while(cur && iterations < max_iter) {
1967 Inset * const ins = cur.nextInset();
1970 docstring insname = ins->layoutName();
1971 while (!insname.empty()) {
1972 if (insname == name || name == from_utf8("*")) {
1974 lyx::dispatch(fr, dr);
1978 size_t const i = insname.rfind(':');
1979 if (i == string::npos)
1981 insname = insname.substr(0, i);
1983 // if we did not delete the inset, skip it
1984 if (!cur.nextInset() || cur.nextInset() == ins)
1989 /** This is a dummy undo record only to remember the cursor
1990 * that has just been set; this will be used on a redo action
1991 * (see ticket #10097)
1993 * FIXME: a better fix would be to have a way to set the
1994 * cursor value directly, but I am not sure it is worth it.
1998 dr.screenUpdate(Update::Force);
1999 dr.forceBufferUpdate();
2001 if (iterations >= max_iter) {
2003 dr.setMessage(bformat(_("`inset-forall' interrupted because number of actions is larger than %1$d"), max_iter));
2005 dr.setMessage(bformat(_("Applied \"%1$s\" to %2$d insets"), from_utf8(commandstr), iterations));
2010 case LFUN_BRANCH_ADD_INSERT: {
2011 docstring branch_name = from_utf8(cmd.getArg(0));
2012 if (branch_name.empty())
2013 if (!Alert::askForText(branch_name, _("Branch name")) ||
2014 branch_name.empty())
2017 DispatchResult drtmp;
2018 buffer_.dispatch(FuncRequest(LFUN_BRANCH_ADD, branch_name), drtmp);
2019 if (drtmp.error()) {
2020 Alert::warning(_("Branch already exists"), drtmp.message());
2023 BranchList & branch_list = buffer_.params().branchlist();
2024 vector<docstring> const branches =
2025 getVectorFromString(branch_name, branch_list.separator());
2026 for (vector<docstring>::const_iterator it = branches.begin();
2027 it != branches.end(); ++it) {
2029 lyx::dispatch(FuncRequest(LFUN_BRANCH_INSERT, branch_name));
2034 case LFUN_KEYMAP_OFF:
2035 getIntl().keyMapOn(false);
2038 case LFUN_KEYMAP_PRIMARY:
2039 getIntl().keyMapPrim();
2042 case LFUN_KEYMAP_SECONDARY:
2043 getIntl().keyMapSec();
2046 case LFUN_KEYMAP_TOGGLE:
2047 getIntl().toggleKeyMap();
2050 case LFUN_DIALOG_SHOW_NEW_INSET: {
2051 string const name = cmd.getArg(0);
2052 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
2053 if (decodeInsetParam(name, data, buffer_))
2054 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
2056 lyxerr << "Inset type '" << name <<
2057 "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" << endl;
2061 case LFUN_CITATION_INSERT: {
2062 if (argument.empty()) {
2063 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
2066 // we can have one optional argument, delimited by '|'
2067 // citation-insert <key>|<text_before>
2068 // this should be enhanced to also support text_after
2069 // and citation style
2070 string arg = argument;
2072 if (contains(argument, "|")) {
2073 arg = token(argument, '|', 0);
2074 opt1 = token(argument, '|', 1);
2077 // if our cursor is directly in front of or behind a citation inset,
2078 // we will instead add the new key to it.
2079 Inset * inset = cur.nextInset();
2080 if (!inset || inset->lyxCode() != CITE_CODE)
2081 inset = cur.prevInset();
2082 if (inset && inset->lyxCode() == CITE_CODE) {
2083 InsetCitation * icite = static_cast<InsetCitation *>(inset);
2084 if (icite->addKey(arg)) {
2085 dr.forceBufferUpdate();
2086 dr.screenUpdate(Update::FitCursor | Update::SinglePar);
2088 LYXERR0("Discarding optional argument to citation-insert.");
2093 InsetCommandParams icp(CITE_CODE);
2094 icp["key"] = from_utf8(arg);
2096 icp["before"] = from_utf8(opt1);
2098 from_ascii(InsetCitation::last_literal ? "true" : "false");
2099 string icstr = InsetCommand::params2string(icp);
2100 FuncRequest fr(LFUN_INSET_INSERT, icstr);
2105 case LFUN_INSET_APPLY: {
2106 string const name = cmd.getArg(0);
2107 Inset * inset = editedInset(name);
2109 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
2113 // put cursor in front of inset.
2114 if (!setCursorFromInset(inset)) {
2115 LASSERT(false, break);
2118 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
2119 inset->dispatch(cur, fr);
2120 dr.screenUpdate(cur.result().screenUpdate());
2121 if (cur.result().needBufferUpdate())
2122 dr.forceBufferUpdate();
2127 // The change of language of buffer belongs to the Buffer class.
2128 // We have to do it here because we need a cursor for Undo.
2129 // When Undo::recordUndoBufferParams() is implemented someday
2130 // LFUN_BUFFER_LANGUAGE should be handled by the Buffer class.
2131 case LFUN_BUFFER_LANGUAGE: {
2132 Language const * oldL = buffer_.params().language;
2133 Language const * newL = languages.getLanguage(argument);
2134 if (!newL || oldL == newL)
2136 if (oldL->rightToLeft() == newL->rightToLeft()) {
2137 cur.recordUndoFullBuffer();
2138 buffer_.changeLanguage(oldL, newL);
2139 cur.setCurrentFont();
2140 dr.forceBufferUpdate();
2145 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
2146 case LFUN_FILE_INSERT_PLAINTEXT: {
2147 bool const as_paragraph = (act == LFUN_FILE_INSERT_PLAINTEXT_PARA);
2148 string const fname = to_utf8(cmd.argument());
2149 if (!FileName::isAbsolute(fname))
2150 dr.setMessage(_("Absolute filename expected."));
2152 insertPlaintextFile(FileName(fname), as_paragraph);
2157 // OK, so try the Buffer itself...
2158 buffer_.dispatch(cmd, dr);
2159 dispatched = dr.dispatched();
2163 buffer_.undo().endUndoGroup();
2164 dr.dispatched(dispatched);
2166 // NOTE: The code below is copied from Cursor::dispatch. If you
2167 // need to modify this, please update the other one too.
2169 // notify insets we just entered/left
2170 if (cursor() != old) {
2171 old.beginUndoGroup();
2173 bool badcursor = notifyCursorLeavesOrEnters(old, cursor());
2175 cursor().fixIfBroken();
2176 resetInlineCompletionPos();
2183 docstring const BufferView::requestSelection()
2185 Cursor & cur = d->cursor_;
2187 LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
2188 if (!cur.selection()) {
2189 d->xsel_cache_.set = false;
2193 LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
2194 if (!d->xsel_cache_.set ||
2195 cur.top() != d->xsel_cache_.cursor ||
2196 cur.realAnchor().top() != d->xsel_cache_.anchor)
2198 d->xsel_cache_.cursor = cur.top();
2199 d->xsel_cache_.anchor = cur.realAnchor().top();
2200 d->xsel_cache_.set = cur.selection();
2201 return cur.selectionAsString(false);
2207 void BufferView::clearSelection()
2209 d->cursor_.clearSelection();
2210 // Clear the selection buffer. Otherwise a subsequent
2211 // middle-mouse-button paste would use the selection buffer,
2212 // not the more current external selection.
2213 cap::clearSelection();
2214 d->xsel_cache_.set = false;
2215 // The buffer did not really change, but this causes the
2216 // redraw we need because we cleared the selection above.
2217 buffer_.changed(false);
2221 void BufferView::resize(int width, int height)
2223 // Update from work area
2227 // Clear the paragraph height cache.
2228 d->par_height_.clear();
2229 // Redo the metrics.
2234 Inset const * BufferView::getCoveringInset(Text const & text,
2237 TextMetrics & tm = d->text_metrics_[&text];
2238 Inset * inset = tm.checkInsetHit(x, y);
2242 if (!inset->descendable(*this))
2243 // No need to go further down if the inset is not
2247 size_t cell_number = inset->nargs();
2248 // Check all the inner cell.
2249 for (size_t i = 0; i != cell_number; ++i) {
2250 Text const * inner_text = inset->getText(i);
2253 Inset const * inset_deeper =
2254 getCoveringInset(*inner_text, x, y);
2256 return inset_deeper;
2264 void BufferView::updateHoveredInset() const
2266 // Get inset under mouse, if there is one.
2267 int const x = d->mouse_position_cache_.x_;
2268 int const y = d->mouse_position_cache_.y_;
2269 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
2271 d->clickable_inset_ = covering_inset && covering_inset->clickable(*this, x, y);
2273 if (covering_inset == d->last_inset_)
2274 // Same inset, no need to do anything...
2277 bool need_redraw = false;
2278 if (d->last_inset_) {
2279 // Remove the hint on the last hovered inset (if any).
2280 need_redraw |= d->last_inset_->setMouseHover(this, false);
2284 if (covering_inset && covering_inset->setMouseHover(this, true)) {
2286 // Only the insets that accept the hover state, do
2287 // clear the last_inset_, so only set the last_inset_
2288 // member if the hovered setting is accepted.
2289 d->last_inset_ = covering_inset;
2293 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
2294 << d->mouse_position_cache_.x_ << ", "
2295 << d->mouse_position_cache_.y_ << ")");
2297 d->update_strategy_ = DecorationUpdate;
2299 // This event (moving without mouse click) is not passed further.
2300 // This should be changed if it is further utilized.
2301 buffer_.changed(false);
2306 void BufferView::clearLastInset(Inset * inset) const
2308 if (d->last_inset_ != inset) {
2309 LYXERR0("Wrong last_inset!");
2316 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
2318 //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
2320 // This is only called for mouse related events including
2321 // LFUN_FILE_OPEN generated by drag-and-drop.
2322 FuncRequest cmd = cmd0;
2324 Cursor old = cursor();
2326 cur.push(buffer_.inset());
2327 cur.selection(d->cursor_.selection());
2329 // Either the inset under the cursor or the
2330 // surrounding Text will handle this event.
2332 // make sure we stay within the screen...
2333 cmd.set_y(min(max(cmd.y(), -1), height_));
2335 d->mouse_position_cache_.x_ = cmd.x();
2336 d->mouse_position_cache_.y_ = cmd.y();
2338 if (cmd.action() == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
2339 updateHoveredInset();
2343 // Build temporary cursor.
2344 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x(), cmd.y());
2346 // If inset is not editable, cur.pos() might point behind the
2347 // inset (depending on cmd.x(), cmd.y()). This is needed for
2348 // editing to fix bug 9628, but e.g. the context menu needs a
2349 // cursor in front of the inset.
2350 if ((inset->hasSettings() || !inset->contextMenuName().empty()
2351 || inset->lyxCode() == SEPARATOR_CODE) &&
2352 cur.nextInset() != inset && cur.prevInset() == inset)
2354 } else if (cur.inTexted() && cur.pos()
2355 && cur.paragraph().isEnvSeparator(cur.pos() - 1)) {
2356 // Always place cursor in front of a separator inset.
2360 // Put anchor at the same position.
2363 cur.beginUndoGroup();
2365 // Try to dispatch to an non-editable inset near this position
2366 // via the temp cursor. If the inset wishes to change the real
2367 // cursor it has to do so explicitly by using
2368 // cur.bv().cursor() = cur; (or similar)
2370 inset->dispatch(cur, cmd);
2372 // Now dispatch to the temporary cursor. If the real cursor should
2373 // be modified, the inset's dispatch has to do so explicitly.
2374 if (!inset || !cur.result().dispatched())
2377 // Notify left insets
2379 bool badcursor = old.fixIfBroken() | cur.fixIfBroken();
2380 badcursor |= notifyCursorLeavesOrEnters(old, cur);
2382 cursor().fixIfBroken();
2387 // Do we have a selection?
2388 theSelection().haveSelection(cursor().selection());
2390 if (cur.needBufferUpdate()) {
2391 cur.clearBufferUpdate();
2392 buffer().updateBuffer();
2395 // If the command has been dispatched,
2396 if (cur.result().dispatched() || cur.result().screenUpdate())
2397 processUpdateFlags(cur.result().screenUpdate());
2401 int BufferView::minVisiblePart()
2403 return 2 * defaultRowHeight();
2407 int BufferView::scroll(int y)
2410 return scrollDown(y);
2412 return scrollUp(-y);
2417 int BufferView::scrollDown(int offset)
2419 Text * text = &buffer_.text();
2420 TextMetrics & tm = d->text_metrics_[text];
2421 int const ymax = height_ + offset;
2423 pair<pit_type, ParagraphMetrics const *> last = tm.last();
2424 int bottom_pos = last.second->position() + last.second->descent();
2425 if (lyxrc.scroll_below_document)
2426 bottom_pos += height_ - minVisiblePart();
2427 if (last.first + 1 == int(text->paragraphs().size())) {
2428 if (bottom_pos <= height_)
2430 offset = min(offset, bottom_pos - height_);
2433 if (bottom_pos > ymax)
2435 tm.newParMetricsDown();
2437 d->anchor_ypos_ -= offset;
2442 int BufferView::scrollUp(int offset)
2444 Text * text = &buffer_.text();
2445 TextMetrics & tm = d->text_metrics_[text];
2446 int ymin = - offset;
2448 pair<pit_type, ParagraphMetrics const *> first = tm.first();
2449 int top_pos = first.second->position() - first.second->ascent();
2450 if (first.first == 0) {
2453 offset = min(offset, - top_pos);
2458 tm.newParMetricsUp();
2460 d->anchor_ypos_ += offset;
2465 bool BufferView::setCursorFromRow(int row)
2467 TexRow::TextEntry start, end;
2468 tie(start,end) = buffer_.texrow().getEntriesFromRow(row);
2469 LYXERR(Debug::LATEX,
2470 "setCursorFromRow: for row " << row << ", TexRow has found "
2471 "start (id=" << start.id << ",pos=" << start.pos << "), "
2472 "end (id=" << end.id << ",pos=" << end.pos << ")");
2473 return setCursorFromEntries(start, end);
2477 bool BufferView::setCursorFromEntries(TexRow::TextEntry start,
2478 TexRow::TextEntry end)
2480 DocIterator dit_start, dit_end;
2481 tie(dit_start,dit_end) =
2482 TexRow::getDocIteratorsFromEntries(start, end, buffer_);
2485 // Setting selection start
2486 d->cursor_.clearSelection();
2487 setCursor(dit_start);
2488 // Setting selection end
2490 d->cursor_.resetAnchor();
2491 setCursorSelectionTo(dit_end);
2497 bool BufferView::setCursorFromInset(Inset const * inset)
2499 // are we already there?
2500 if (cursor().nextInset() == inset)
2503 // Inset is not at cursor position. Find it in the document.
2506 while (cur && cur.nextInset() != inset)
2517 void BufferView::gotoLabel(docstring const & label)
2520 bool have_inactive = false;
2521 ListOfBuffers bufs = buffer().allRelatives();
2522 ListOfBuffers::iterator it = bufs.begin();
2523 for (; it != bufs.end(); ++it) {
2524 Buffer const * buf = *it;
2527 shared_ptr<Toc> toc = buf->tocBackend().toc("label");
2528 Toc::const_iterator toc_it = toc->begin();
2529 Toc::const_iterator end = toc->end();
2530 for (; toc_it != end; ++toc_it) {
2531 if (label == toc_it->str() && toc_it->isOutput()) {
2532 lyx::dispatch(toc_it->action());
2535 // If we find an inactive label, save it for the case
2536 // that no active one is there
2537 if (label == toc_it->str() && !have_inactive) {
2538 have_inactive = true;
2539 action = toc_it->action();
2543 // We only found an inactive label. Go there.
2545 lyx::dispatch(action);
2549 TextMetrics const & BufferView::textMetrics(Text const * t) const
2551 return const_cast<BufferView *>(this)->textMetrics(t);
2555 TextMetrics & BufferView::textMetrics(Text const * t)
2558 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
2559 if (tmc_it == d->text_metrics_.end()) {
2560 tmc_it = d->text_metrics_.insert(
2561 make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
2563 return tmc_it->second;
2567 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
2570 return textMetrics(t).parMetrics(pit);
2574 int BufferView::workHeight() const
2580 void BufferView::setCursor(DocIterator const & dit)
2583 size_t const n = dit.depth();
2584 for (size_t i = 0; i < n; ++i)
2585 dit[i].inset().edit(d->cursor_, true);
2587 d->cursor_.setCursor(dit);
2588 d->cursor_.selection(false);
2589 d->cursor_.setCurrentFont();
2591 // It seems on general grounds as if this is probably needed, but
2592 // it is not yet clear.
2593 // See bug #7394 and r38388.
2594 // d->cursor.resetAnchor();
2598 void BufferView::setCursorSelectionTo(DocIterator const & dit)
2600 size_t const n = dit.depth();
2601 for (size_t i = 0; i < n; ++i)
2602 dit[i].inset().edit(d->cursor_, true);
2604 d->cursor_.selection(true);
2605 d->cursor_.setCursorSelectionTo(dit);
2606 d->cursor_.setCurrentFont();
2610 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
2612 // Would be wrong to delete anything if we have a selection.
2613 if (cur.selection())
2616 bool need_anchor_change = false;
2617 bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
2618 need_anchor_change);
2620 if (need_anchor_change)
2628 // we would rather not do this here, but it needs to be done before
2629 // the changed() signal is sent.
2630 buffer_.updateBuffer();
2632 buffer_.changed(true);
2637 bool BufferView::mouseSetCursor(Cursor & cur, bool const select)
2639 LASSERT(&cur.bv() == this, return false);
2642 // this event will clear selection so we save selection for
2643 // persistent selection
2644 cap::saveSelection(cursor());
2646 d->cursor_.macroModeClose();
2647 // If a macro has been finalized, the cursor might have been broken
2650 // Has the cursor just left the inset?
2651 bool const leftinset = (&d->cursor_.inset() != &cur.inset());
2653 d->cursor_.fixIfBroken();
2655 // do the dEPM magic if needed
2656 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
2657 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
2658 // the leftinset bool would not be necessary (badcursor instead).
2659 bool update = leftinset;
2662 d->cursor_.setSelection();
2663 d->cursor_.setCursorSelectionTo(cur);
2665 if (d->cursor_.inTexted())
2666 update |= checkDepm(cur, d->cursor_);
2667 d->cursor_.resetAnchor();
2668 d->cursor_.setCursor(cur);
2669 d->cursor_.clearSelection();
2671 d->cursor_.boundary(cur.boundary());
2672 d->cursor_.finishUndo();
2673 d->cursor_.setCurrentFont();
2675 cur.forceBufferUpdate();
2680 void BufferView::putSelectionAt(DocIterator const & cur,
2681 int length, bool backwards)
2683 d->cursor_.clearSelection();
2689 d->cursor_.pos() += length;
2690 d->cursor_.setSelection(d->cursor_, -length);
2692 d->cursor_.setSelection(d->cursor_, length);
2697 bool BufferView::selectIfEmpty(DocIterator & cur)
2699 if ((cur.inTexted() && !cur.paragraph().empty())
2700 || (cur.inMathed() && !cur.cell().empty()))
2703 pit_type const beg_pit = cur.pit();
2705 // The paragraph associated to this item isn't
2706 // the first one, so it can be selected
2709 // We have to resort to select the space between the
2710 // end of this item and the begin of the next one
2714 // If it is the only item in the document,
2715 // nothing can be selected
2718 pit_type const end_pit = cur.pit();
2719 pos_type const end_pos = cur.pos();
2720 d->cursor_.clearSelection();
2722 d->cursor_.setCursor(cur);
2723 d->cursor_.pit() = beg_pit;
2724 d->cursor_.pos() = 0;
2725 d->cursor_.selection(false);
2726 d->cursor_.resetAnchor();
2727 d->cursor_.pit() = end_pit;
2728 d->cursor_.pos() = end_pos;
2729 d->cursor_.setSelection();
2734 Cursor & BufferView::cursor()
2740 Cursor const & BufferView::cursor() const
2746 pit_type BufferView::anchor_ref() const
2748 return d->anchor_pit_;
2752 bool BufferView::singleParUpdate()
2754 Text & buftext = buffer_.text();
2755 pit_type const bottom_pit = d->cursor_.bottom().pit();
2756 TextMetrics & tm = textMetrics(&buftext);
2757 Dimension const old_dim = tm.parMetrics(bottom_pit).dim();
2759 // make sure inline completion pointer is ok
2760 if (d->inlineCompletionPos_.fixIfBroken())
2761 d->inlineCompletionPos_ = DocIterator();
2763 // In Single Paragraph mode, rebreak only
2764 // the (main text, not inset!) paragraph containing the cursor.
2765 // (if this paragraph contains insets etc., rebreaking will
2766 // recursively descend)
2767 tm.redoParagraph(bottom_pit);
2768 ParagraphMetrics & pm = tm.par_metrics_[bottom_pit];
2769 if (pm.height() != old_dim.height()) {
2770 // Paragraph height has changed so we cannot proceed to
2771 // the singlePar optimisation.
2774 // Since position() points to the baseline of the first row, we
2775 // may have to update it. See ticket #11601 for an example where
2776 // the height does not change but the ascent does.
2777 pm.setPosition(pm.position() - old_dim.ascent() + pm.ascent());
2779 tm.updatePosCache(bottom_pit);
2781 LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
2782 << " y2: " << pm.position() + pm.descent()
2783 << " pit: " << bottom_pit
2784 << " singlepar: 1");
2789 void BufferView::updateMetrics()
2791 updateMetrics(d->update_flags_);
2792 d->update_strategy_ = FullScreenUpdate;
2796 void BufferView::updateMetrics(Update::flags & update_flags)
2798 if (height_ == 0 || width_ == 0)
2801 Text & buftext = buffer_.text();
2802 pit_type const npit = int(buftext.paragraphs().size());
2804 // Clear out the position cache in case of full screen redraw,
2805 d->coord_cache_.clear();
2807 // Clear out paragraph metrics to avoid having invalid metrics
2808 // in the cache from paragraphs not relayouted below
2809 // The complete text metrics will be redone.
2810 d->text_metrics_.clear();
2812 TextMetrics & tm = textMetrics(&buftext);
2814 // make sure inline completion pointer is ok
2815 if (d->inlineCompletionPos_.fixIfBroken())
2816 d->inlineCompletionPos_ = DocIterator();
2818 if (d->anchor_pit_ >= npit)
2819 // The anchor pit must have been deleted...
2820 d->anchor_pit_ = npit - 1;
2822 // Rebreak anchor paragraph.
2823 tm.redoParagraph(d->anchor_pit_);
2824 ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
2827 if (d->anchor_pit_ == 0) {
2828 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
2830 // Complete buffer visible? Then it's easy.
2831 if (scrollRange == 0)
2832 d->anchor_ypos_ = anchor_pm.ascent();
2834 // avoid empty space above the first row
2835 d->anchor_ypos_ = min(d->anchor_ypos_, anchor_pm.ascent());
2838 anchor_pm.setPosition(d->anchor_ypos_);
2839 tm.updatePosCache(d->anchor_pit_);
2841 LYXERR(Debug::PAINTING, "metrics: "
2842 << " anchor pit = " << d->anchor_pit_
2843 << " anchor ypos = " << d->anchor_ypos_);
2845 // Redo paragraphs above anchor if necessary.
2846 int y1 = d->anchor_ypos_ - anchor_pm.ascent();
2847 // We are now just above the anchor paragraph.
2848 pit_type pit1 = d->anchor_pit_ - 1;
2849 for (; pit1 >= 0 && y1 >= 0; --pit1) {
2850 tm.redoParagraph(pit1);
2851 ParagraphMetrics & pm = tm.par_metrics_[pit1];
2853 // Save the paragraph position in the cache.
2855 tm.updatePosCache(pit1);
2859 // Redo paragraphs below the anchor if necessary.
2860 int y2 = d->anchor_ypos_ + anchor_pm.descent();
2861 // We are now just below the anchor paragraph.
2862 pit_type pit2 = d->anchor_pit_ + 1;
2863 for (; pit2 < npit && y2 <= height_; ++pit2) {
2864 tm.redoParagraph(pit2);
2865 ParagraphMetrics & pm = tm.par_metrics_[pit2];
2867 // Save the paragraph position in the cache.
2869 tm.updatePosCache(pit2);
2873 LYXERR(Debug::PAINTING, "Metrics: "
2874 << " anchor pit = " << d->anchor_pit_
2875 << " anchor ypos = " << d->anchor_ypos_
2878 << " pit1 = " << pit1
2879 << " pit2 = " << pit2);
2881 // metrics is done, full drawing is necessary now
2882 update_flags = (update_flags & ~Update::Force) | Update::ForceDraw;
2884 // Now update the positions of insets in the cache.
2887 if (lyxerr.debugging(Debug::WORKAREA)) {
2888 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
2889 d->coord_cache_.dump();
2894 void BufferView::updatePosCache()
2896 // this is the "nodraw" drawing stage: only set the positions of the
2897 // insets in metrics cache.
2898 frontend::NullPainter np;
2903 void BufferView::insertLyXFile(FileName const & fname)
2905 LASSERT(d->cursor_.inTexted(), return);
2907 // Get absolute path of file and add ".lyx"
2908 // to the filename if necessary
2909 FileName filename = fileSearch(string(), fname.absFileName(), "lyx");
2911 docstring const disp_fn = makeDisplayPath(filename.absFileName());
2912 // emit message signal.
2913 message(bformat(_("Inserting document %1$s..."), disp_fn));
2916 Buffer buf(filename.absFileName(), false);
2917 if (buf.loadLyXFile() == Buffer::ReadSuccess) {
2918 ErrorList & el = buffer_.errorList("Parse");
2919 // Copy the inserted document error list into the current buffer one.
2920 el = buf.errorList("Parse");
2921 buffer_.undo().recordUndo(d->cursor_);
2922 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
2923 buf.params().documentClassPtr(), el);
2924 res = _("Document %1$s inserted.");
2926 res = _("Could not insert document %1$s");
2929 buffer_.changed(true);
2930 // emit message signal.
2931 message(bformat(res, disp_fn));
2935 Point BufferView::coordOffset(DocIterator const & dit) const
2941 // Addup contribution of nested insets, from inside to outside,
2942 // keeping the outer paragraph for a special handling below
2943 for (size_t i = dit.depth() - 1; i >= 1; --i) {
2944 CursorSlice const & sl = dit[i];
2948 // get relative position inside sl.inset()
2949 sl.inset().cursorPos(*this, sl, dit.boundary() && (i + 1 == dit.depth()), xx, yy);
2951 // Make relative position inside of the edited inset relative to sl.inset()
2955 // In case of an RTL inset, the edited inset will be positioned to the left
2958 bool boundary_i = dit.boundary() && i + 1 == dit.depth();
2959 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2964 // remember width for the case that sl.inset() is positioned in an RTL inset
2965 lastw = sl.inset().dimension(*this).wid;
2967 //lyxerr << "Cursor::getPos, i: "
2968 // << i << " x: " << xx << " y: " << y << endl;
2971 // Add contribution of initial rows of outermost paragraph
2972 CursorSlice const & sl = dit[0];
2973 TextMetrics const & tm = textMetrics(sl.text());
2974 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2976 LBUFERR(!pm.rows().empty());
2977 y -= pm.rows()[0].ascent();
2979 // FIXME: document this mess
2981 if (sl.pos() > 0 && dit.depth() == 1) {
2983 if (pos && dit.boundary())
2985 // lyxerr << "coordOffset: boundary:" << dit.boundary() << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
2986 rend = pm.pos2row(pos);
2988 rend = pm.pos2row(sl.pos());
2990 size_t rend = pm.pos2row(sl.pos());
2992 for (size_t rit = 0; rit != rend; ++rit)
2993 y += pm.rows()[rit].height();
2994 y += pm.rows()[rend].ascent();
2996 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
2998 // Make relative position from the nested inset now bufferview absolute.
2999 int xx = bottom_tm.cursorX(dit.bottom(), dit.boundary() && dit.depth() == 1);
3002 // In the RTL case place the nested inset at the left of the cursor in
3003 // the outer paragraph
3004 bool boundary_1 = dit.boundary() && 1 == dit.depth();
3005 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
3013 Point BufferView::getPos(DocIterator const & dit) const
3015 if (!paragraphVisible(dit))
3016 return Point(-1, -1);
3018 CursorSlice const & bot = dit.bottom();
3019 TextMetrics const & tm = textMetrics(bot.text());
3021 // offset from outer paragraph
3022 Point p = coordOffset(dit);
3023 p.y_ += tm.parMetrics(bot.pit()).position();
3028 bool BufferView::paragraphVisible(DocIterator const & dit) const
3030 CursorSlice const & bot = dit.bottom();
3031 TextMetrics const & tm = textMetrics(bot.text());
3033 return tm.contains(bot.pit());
3037 void BufferView::setCaretAscentDescent(int asc, int des)
3039 d->caret_ascent_ = asc;
3040 d->caret_descent_ = des;
3044 void BufferView::caretPosAndHeight(Point & p, int & h) const
3047 Cursor const & cur = cursor();
3048 if (cur.inMathed()) {
3049 asc = d->caret_ascent_;
3050 des = d->caret_descent_;
3052 Font const font = cur.real_current_font;
3053 frontend::FontMetrics const & fm = theFontMetrics(font);
3054 asc = fm.maxAscent();
3055 des = fm.maxDescent();
3063 bool BufferView::caretInView() const
3065 if (!paragraphVisible(cursor()))
3069 caretPosAndHeight(p, h);
3071 // does the cursor touch the screen ?
3072 if (p.y_ + h < 0 || p.y_ >= workHeight())
3078 int BufferView::horizScrollOffset() const
3080 return d->horiz_scroll_offset_;
3084 int BufferView::horizScrollOffset(Text const * text,
3085 pit_type pit, pos_type pos) const
3087 // Is this a row that is currently scrolled?
3088 if (!d->current_row_slice_.empty()
3089 && &text->inset() == d->current_row_slice_.inset().asInsetText()
3090 && pit == d->current_row_slice_.pit()
3091 && pos == d->current_row_slice_.pos())
3092 return d->horiz_scroll_offset_;
3097 bool BufferView::hadHorizScrollOffset(Text const * text,
3098 pit_type pit, pos_type pos) const
3100 return !d->last_row_slice_.empty()
3101 && &text->inset() == d->last_row_slice_.inset().asInsetText()
3102 && pit == d->last_row_slice_.pit()
3103 && pos == d->last_row_slice_.pos();
3107 void BufferView::setCurrentRowSlice(CursorSlice const & rowSlice)
3109 // nothing to do if the cursor was already on this row
3110 if (d->current_row_slice_ == rowSlice) {
3111 d->last_row_slice_ = CursorSlice();
3115 // if the (previous) current row was scrolled, we have to
3116 // remember it in order to repaint it next time.
3117 if (d->horiz_scroll_offset_ != 0)
3118 d->last_row_slice_ = d->current_row_slice_;
3120 d->last_row_slice_ = CursorSlice();
3122 // Since we changed row, the scroll offset is not valid anymore
3123 d->horiz_scroll_offset_ = 0;
3124 d->current_row_slice_ = rowSlice;
3128 void BufferView::checkCursorScrollOffset()
3130 CursorSlice rowSlice = d->cursor_.bottom();
3131 TextMetrics const & tm = textMetrics(rowSlice.text());
3133 // Stop if metrics have not been computed yet, since it means
3134 // that there is nothing to do.
3135 if (!tm.contains(rowSlice.pit()))
3137 ParagraphMetrics const & pm = tm.parMetrics(rowSlice.pit());
3138 Row const & row = pm.getRow(rowSlice.pos(),
3139 d->cursor_.boundary() && rowSlice == d->cursor_.top());
3140 rowSlice.pos() = row.pos();
3142 // Set the row on which the cursor lives.
3143 setCurrentRowSlice(rowSlice);
3145 // Current x position of the cursor in pixels
3146 int cur_x = getPos(d->cursor_).x_;
3148 // Horizontal scroll offset of the cursor row in pixels
3149 int offset = d->horiz_scroll_offset_;
3150 int const MARGIN = 2 * theFontMetrics(d->cursor_.real_current_font).em()
3152 if (row.right_x() <= workWidth() - row.right_margin) {
3153 // Row is narrower than the work area, no offset needed.
3156 if (cur_x - offset < MARGIN) {
3157 // cursor would be too far right
3158 offset = cur_x - MARGIN;
3159 } else if (cur_x - offset > workWidth() - MARGIN) {
3160 // cursor would be too far left
3161 offset = cur_x - workWidth() + MARGIN;
3163 // Correct the offset to make sure that we do not scroll too much
3166 if (row.right_x() - offset < workWidth() - row.right_margin)
3167 offset = row.right_x() - workWidth() + row.right_margin;
3170 //lyxerr << "cur_x=" << cur_x << ", offset=" << offset << ", row.wid=" << row.width() << ", margin=" << MARGIN << endl;
3172 if (offset != d->horiz_scroll_offset_)
3173 LYXERR(Debug::PAINTING, "Horiz. scroll offset changed from "
3174 << d->horiz_scroll_offset_ << " to " << offset);
3176 if (d->update_strategy_ == NoScreenUpdate
3177 && (offset != d->horiz_scroll_offset_
3178 || !d->last_row_slice_.empty())) {
3179 // FIXME: if one uses SingleParUpdate, then home/end
3180 // will not work on long rows. Why?
3181 d->update_strategy_ = FullScreenUpdate;
3184 d->horiz_scroll_offset_ = offset;
3188 void BufferView::draw(frontend::Painter & pain, bool paint_caret)
3190 if (height_ == 0 || width_ == 0)
3192 LYXERR(Debug::PAINTING, (pain.isNull() ? "\t\t--- START NODRAW ---"
3193 : "\t\t*** START DRAWING ***"));
3194 Text & text = buffer_.text();
3195 TextMetrics const & tm = d->text_metrics_[&text];
3196 int const y = tm.first().second->position();
3197 PainterInfo pi(this, pain);
3199 // Check whether the row where the cursor lives needs to be scrolled.
3200 // Update the drawing strategy if needed.
3201 checkCursorScrollOffset();
3203 switch (d->update_strategy_) {
3205 case NoScreenUpdate:
3206 // no screen painting is actually needed. In nodraw stage
3207 // however, the different coordinates of insets and paragraphs
3208 // needs to be updated.
3209 LYXERR(Debug::PAINTING, "Strategy: NoScreenUpdate");
3210 pi.full_repaint = false;
3211 if (pain.isNull()) {
3212 pi.full_repaint = true;
3215 pi.full_repaint = false;
3220 case SingleParUpdate:
3221 pi.full_repaint = false;
3222 LYXERR(Debug::PAINTING, "Strategy: SingleParUpdate");
3223 // In general, only the current row of the outermost paragraph
3224 // will be redrawn. Particular cases where selection spans
3225 // multiple paragraph are correctly detected in TextMetrics.
3229 case DecorationUpdate:
3230 // FIXME: We should also distinguish DecorationUpdate to avoid text
3231 // drawing if possible. This is not possible to do easily right now
3232 // because of the single backing pixmap.
3234 case FullScreenUpdate:
3236 LYXERR(Debug::PAINTING,
3237 ((d->update_strategy_ == FullScreenUpdate)
3238 ? "Strategy: FullScreenUpdate"
3239 : "Strategy: DecorationUpdate"));
3241 // The whole screen, including insets, will be refreshed.
3242 pi.full_repaint = true;
3244 // Clear background.
3245 pain.fillRectangle(0, 0, width_, height_,
3246 pi.backgroundColor(&buffer_.inset()));
3251 // and possibly grey out below
3252 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3253 int const y2 = lastpm.second->position() + lastpm.second->descent();
3256 Color color = buffer().isInternal()
3257 ? Color_background : Color_bottomarea;
3258 pain.fillRectangle(0, y2, width_, height_ - y2, color);
3262 LYXERR(Debug::PAINTING, (pain.isNull() ? "\t\t --- END NODRAW ---"
3263 : "\t\t *** END DRAWING ***"));
3265 // The scrollbar needs an update.
3268 // Normalize anchor for next time
3269 pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
3270 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3271 for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
3272 ParagraphMetrics const & pm = tm.parMetrics(pit);
3273 if (pm.position() + pm.descent() > 0) {
3274 if (d->anchor_pit_ != pit
3275 || d->anchor_ypos_ != pm.position())
3276 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
3277 << " anchor ypos = " << d->anchor_ypos_);
3278 d->anchor_pit_ = pit;
3279 d->anchor_ypos_ = pm.position();
3283 if (!pain.isNull()) {
3284 // reset the update flags, everything has been done
3285 d->update_flags_ = Update::None;
3288 // If a caret has to be painted, mark its text row as dirty to
3289 //make sure that it will be repainted on next redraw.
3290 /* FIXME: investigate whether this can be avoided when the cursor did not
3294 Row const & caret_row = d->cursor_.textRow();
3295 caret_row.changed(true);
3300 void BufferView::message(docstring const & msg)
3303 d->gui_->message(msg);
3307 void BufferView::showDialog(string const & name)
3310 d->gui_->showDialog(name, string());
3314 void BufferView::showDialog(string const & name,
3315 string const & data, Inset * inset)
3318 d->gui_->showDialog(name, data, inset);
3322 void BufferView::updateDialog(string const & name, string const & data)
3325 d->gui_->updateDialog(name, data);
3329 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
3335 // FIXME: Move this out of BufferView again
3336 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
3338 if (!fname.isReadableFile()) {
3339 docstring const error = from_ascii(strerror(errno));
3340 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3341 docstring const text =
3342 bformat(_("Could not read the specified document\n"
3343 "%1$s\ndue to the error: %2$s"), file, error);
3344 Alert::error(_("Could not read file"), text);
3348 if (!fname.isReadableFile()) {
3349 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3350 docstring const text =
3351 bformat(_("%1$s\n is not readable."), file);
3352 Alert::error(_("Could not open file"), text);
3356 // FIXME UNICODE: We don't know the encoding of the file
3357 docstring file_content = fname.fileContents("UTF-8");
3358 if (file_content.empty()) {
3359 Alert::error(_("Reading not UTF-8 encoded file"),
3360 _("The file is not UTF-8 encoded.\n"
3361 "It will be read as local 8Bit-encoded.\n"
3362 "If this does not give the correct result\n"
3363 "then please change the encoding of the file\n"
3364 "to UTF-8 with a program other than LyX.\n"));
3365 file_content = fname.fileContents("local8bit");
3368 return normalize_c(file_content);
3372 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
3374 docstring const tmpstr = contentsOfPlaintextFile(f);
3379 Cursor & cur = cursor();
3380 cap::replaceSelection(cur);
3381 buffer_.undo().recordUndo(cur);
3383 cur.innerText()->insertStringAsParagraphs(cur, tmpstr, cur.current_font);
3385 cur.innerText()->insertStringAsLines(cur, tmpstr, cur.current_font);
3387 buffer_.changed(true);
3391 docstring const & BufferView::inlineCompletion() const
3393 return d->inlineCompletion_;
3397 size_t const & BufferView::inlineCompletionUniqueChars() const
3399 return d->inlineCompletionUniqueChars_;
3403 DocIterator const & BufferView::inlineCompletionPos() const
3405 return d->inlineCompletionPos_;
3409 void BufferView::resetInlineCompletionPos()
3411 d->inlineCompletionPos_ = DocIterator();
3415 bool samePar(DocIterator const & a, DocIterator const & b)
3417 if (a.empty() && b.empty())
3419 if (a.empty() || b.empty())
3421 if (a.depth() != b.depth())
3423 return &a.innerParagraph() == &b.innerParagraph();
3427 void BufferView::setInlineCompletion(Cursor const & cur, DocIterator const & pos,
3428 docstring const & completion, size_t uniqueChars)
3430 uniqueChars = min(completion.size(), uniqueChars);
3431 bool changed = d->inlineCompletion_ != completion
3432 || d->inlineCompletionUniqueChars_ != uniqueChars;
3433 bool singlePar = true;
3434 d->inlineCompletion_ = completion;
3435 d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
3437 //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
3440 DocIterator const & old = d->inlineCompletionPos_;
3442 //lyxerr << "inlineCompletionPos changed" << std::endl;
3443 // old or pos are in another paragraph?
3444 if ((!samePar(cur, pos) && !pos.empty())
3445 || (!samePar(cur, old) && !old.empty())) {
3447 //lyxerr << "different paragraph" << std::endl;
3449 d->inlineCompletionPos_ = pos;
3454 if (singlePar && !(cur.result().screenUpdate() & Update::Force))
3455 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
3457 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::Force);
3462 bool BufferView::clickableInset() const
3464 return d->clickable_inset_;