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"
69 #include "frontends/alert.h"
70 #include "frontends/Application.h"
71 #include "frontends/Delegates.h"
72 #include "frontends/FontMetrics.h"
73 #include "frontends/NullPainter.h"
74 #include "frontends/Painter.h"
75 #include "frontends/Selection.h"
77 #include "support/convert.h"
78 #include "support/debug.h"
79 #include "support/ExceptionMessage.h"
80 #include "support/filetools.h"
81 #include "support/gettext.h"
82 #include "support/lassert.h"
83 #include "support/lstrings.h"
84 #include "support/Package.h"
85 #include "support/types.h"
95 using namespace lyx::support;
99 namespace Alert = frontend::Alert;
103 /// Return an inset of this class if it exists at the current cursor position
105 T * getInsetByCode(Cursor const & cur, InsetCode code)
107 DocIterator it = cur;
108 Inset * inset = it.nextInset();
109 if (inset && inset->lyxCode() == code)
110 return static_cast<T*>(inset);
115 /// Note that comparing contents can only be used for InsetCommand
116 bool findNextInset(DocIterator & dit, vector<InsetCode> const & codes,
117 docstring const & contents)
119 DocIterator tmpdit = dit;
122 Inset const * inset = tmpdit.nextInset();
124 bool const valid_code = std::find(codes.begin(), codes.end(),
125 inset->lyxCode()) != codes.end();
126 InsetCommand const * ic = inset->asInsetCommand();
127 bool const same_or_no_contents = contents.empty()
128 || (ic && (ic->getFirstNonOptParam() == contents));
130 if (valid_code && same_or_no_contents) {
135 tmpdit.forwardInset();
142 /// Looks for next inset with one of the given codes.
143 /// Note that same_content can only be used for InsetCommand
144 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
148 DocIterator tmpdit = dit;
149 tmpdit.forwardInset();
153 Inset const * inset = tmpdit.nextInset();
154 if (same_content && inset) {
155 InsetCommand const * ic = inset->asInsetCommand();
157 bool const valid_code = std::find(codes.begin(), codes.end(),
158 ic->lyxCode()) != codes.end();
160 contents = ic->getFirstNonOptParam();
164 if (!findNextInset(tmpdit, codes, contents)) {
165 if (dit.depth() != 1 || dit.pit() != 0 || dit.pos() != 0) {
166 Inset * inset = &tmpdit.bottom().inset();
167 tmpdit = doc_iterator_begin(&inset->buffer(), inset);
168 if (!findNextInset(tmpdit, codes, contents))
180 /// Looks for next inset with the given code
181 void findInset(DocIterator & dit, InsetCode code, bool same_content)
183 findInset(dit, vector<InsetCode>(1, code), same_content);
187 /// Moves cursor to the next inset with one of the given codes.
188 void gotoInset(BufferView * bv, vector<InsetCode> const & codes,
191 Cursor tmpcur = bv->cursor();
192 if (!findInset(tmpcur, codes, same_content)) {
193 bv->cursor().message(_("No more insets"));
197 tmpcur.clearSelection();
198 bv->setCursor(tmpcur);
203 /// Moves cursor to the next inset with given code.
204 void gotoInset(BufferView * bv, InsetCode code, bool same_content)
206 gotoInset(bv, vector<InsetCode>(1, code), same_content);
210 /// A map from a Text to the associated text metrics
211 typedef map<Text const *, TextMetrics> TextMetricsCache;
213 enum ScreenUpdateStrategy {
223 /////////////////////////////////////////////////////////////////////
227 /////////////////////////////////////////////////////////////////////
229 struct BufferView::Private
231 Private(BufferView & bv) : update_strategy_(FullScreenUpdate),
232 update_flags_(Update::Force),
234 anchor_pit_(0), anchor_ypos_(0),
235 inlineCompletionUniqueChars_(0),
236 last_inset_(0), clickable_inset_(false),
237 mouse_position_cache_(),
238 bookmark_edit_position_(-1), gui_(0),
239 horiz_scroll_offset_(0), repaint_caret_row_(false)
241 xsel_cache_.set = false;
245 ScrollbarParameters scrollbarParameters_;
247 ScreenUpdateStrategy update_strategy_;
249 Update::flags update_flags_;
251 CoordCache coord_cache_;
253 /// Estimated average par height for scrollbar.
255 /// this is used to handle XSelection events in the right manner.
264 pit_type anchor_pit_;
268 vector<int> par_height_;
271 DocIterator inlineCompletionPos_;
273 docstring inlineCompletion_;
275 size_t inlineCompletionUniqueChars_;
277 /// keyboard mapping object.
280 /// last visited inset.
281 /** kept to send setMouseHover(false).
282 * Not owned, so don't delete.
284 Inset const * last_inset_;
285 /// are we hovering something that we can click
286 bool clickable_inset_;
288 /// position of the mouse at the time of the last mouse move
289 /// This is used to update the hovering status of inset in
290 /// cases where the buffer is scrolled, but the mouse didn't move.
291 Point mouse_position_cache_;
293 // cache for id of the paragraph which was edited the last time
294 int bookmark_edit_position_;
296 mutable TextMetricsCache text_metrics_;
299 /** Not owned, so don't delete.
301 frontend::GuiBufferViewDelegate * gui_;
303 /// Cache for Find Next
304 FuncRequest search_request_cache_;
307 map<string, Inset *> edited_insets_;
309 /// When the row where the cursor lies is scrolled, this
310 /// contains the scroll offset
311 int horiz_scroll_offset_;
312 /// a slice pointing to the start of the row where the cursor
313 /// is (at last draw time)
314 CursorSlice current_row_slice_;
315 /// a slice pointing to the start of the row where cursor was
316 /// at previous draw event
317 CursorSlice last_row_slice_;
319 /// a slice pointing to where the cursor has been drawn after the current
321 CursorSlice caret_slice_;
322 /// indicates whether the caret slice needs to be repainted in this draw() run.
323 bool repaint_caret_row_;
327 BufferView::BufferView(Buffer & buf)
328 : width_(0), height_(0), full_screen_(false), buffer_(buf),
329 d(new Private(*this))
331 d->xsel_cache_.set = false;
332 d->intl_.initKeyMapper(lyxrc.use_kbmap);
334 d->cursor_.setBuffer(&buf);
335 d->cursor_.push(buffer_.inset());
336 d->cursor_.resetAnchor();
337 d->cursor_.setCurrentFont();
339 buffer_.updatePreviews();
343 BufferView::~BufferView()
345 // current buffer is going to be switched-off, save cursor pos
346 // Ideally, the whole cursor stack should be saved, but session
347 // currently can only handle bottom (whole document) level pit and pos.
348 // That is to say, if a cursor is in a nested inset, it will be
349 // restore to the left of the top level inset.
350 LastFilePosSection::FilePos fp;
351 fp.pit = d->cursor_.bottom().pit();
352 fp.pos = d->cursor_.bottom().pos();
353 theSession().lastFilePos().save(buffer_.fileName(), fp);
356 d->last_inset_->setMouseHover(this, false);
362 int BufferView::rightMargin() const
364 // The value used to be hardcoded to 10, which is 0.1in at 100dpi
365 int const default_margin = Length(0.1, Length::IN).inPixels(0);
366 // The additional test for the case the outliner is opened.
367 if (!full_screen_ || !lyxrc.full_screen_limit
368 || width_ < lyxrc.full_screen_width + 2 * default_margin)
369 return default_margin;
371 return (width_ - lyxrc.full_screen_width) / 2;
375 int BufferView::leftMargin() const
377 return rightMargin();
381 int BufferView::inPixels(Length const & len) const
383 Font const font = buffer().params().getFont();
384 return len.inPixels(workWidth(), theFontMetrics(font).em());
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 Buffer & BufferView::buffer()
430 Buffer const & BufferView::buffer() const
436 bool BufferView::needsFitCursor() const
438 if (cursorStatus(d->cursor_) == CUR_INSIDE) {
439 frontend::FontMetrics const & fm =
440 theFontMetrics(d->cursor_.getFont().fontInfo());
441 int const asc = fm.maxAscent();
442 int const des = fm.maxDescent();
443 Point const p = getPos(d->cursor_);
444 if (p.y_ - asc >= 0 && p.y_ + des < height_)
451 void BufferView::processUpdateFlags(Update::flags flags)
453 // The update flags are reset to None after the redraw is actually done
454 d->update_flags_ = d->update_flags_ | flags;
456 // This is close to a hot-path.
457 LYXERR(Debug::PAINTING, "BufferView::processUpdateFlags( "
458 << ((d->update_flags_ & Update::FitCursor) ? "fitcursor " : "")
459 << ((d->update_flags_ & Update::Force) ? "forceupdate " : "")
460 << ((d->update_flags_ & Update::ForceDraw) ? "forcedraw " : "")
461 << ((d->update_flags_ & Update::SinglePar) ? "singlepar " : "")
462 << ") buffer: " << &buffer_);
464 // Now do the first drawing step if needed. This consists on updating
465 // the CoordCache in updateMetrics().
466 // The second drawing step is done in WorkArea::redraw() if needed.
467 // FIXME: is this still true now that Buffer::changed() is used all over?
469 // Case when no explicit update is requested.
470 if (!d->update_flags_) {
471 // no need to redraw anything.
472 d->update_strategy_ = NoScreenUpdate;
476 if (d->update_flags_ == Update::Decoration) {
477 d->update_strategy_ = DecorationUpdate;
478 buffer_.changed(false);
482 if (d->update_flags_ == Update::FitCursor
483 || d->update_flags_ == (Update::Decoration | Update::FitCursor)) {
484 // tell the frontend to update the screen if needed.
485 if (needsFitCursor()) {
489 if (d->update_flags_ & Update::Decoration) {
490 d->update_strategy_ = DecorationUpdate;
491 buffer_.changed(false);
494 // no screen update is needed in principle, but this
495 // could change if cursor row needs horizontal scrolling.
496 d->update_strategy_ = NoScreenUpdate;
497 buffer_.changed(false);
501 // We test against the flags parameter here to honor explicit metrics requests
502 bool const full_metrics = flags & Update::Force || !singleParUpdate();
505 // We have to update the full screen metrics.
507 if (d->update_flags_ & Update::ForceDraw)
508 d->update_strategy_ = FullScreenUpdate;
510 if (!(d->update_flags_ & Update::FitCursor)) {
511 // Nothing to do anymore. Trigger a redraw and return.
512 buffer_.changed(false);
516 if (needsFitCursor()) {
517 // The cursor is off screen so ensure it is visible.
522 updateHoveredInset();
525 buffer_.changed(false);
529 void BufferView::updateScrollbar()
531 if (height_ == 0 && width_ == 0)
534 // We prefer fixed size line scrolling.
535 d->scrollbarParameters_.single_step = defaultRowHeight();
536 // We prefer full screen page scrolling.
537 d->scrollbarParameters_.page_step = height_;
539 Text & t = buffer_.text();
540 TextMetrics & tm = d->text_metrics_[&t];
542 LYXERR(Debug::GUI, " Updating scrollbar: height: "
543 << t.paragraphs().size()
544 << " curr par: " << d->cursor_.bottom().pit()
545 << " default height " << defaultRowHeight());
547 size_t const parsize = t.paragraphs().size();
548 if (d->par_height_.size() != parsize) {
549 d->par_height_.clear();
550 // FIXME: We assume a default paragraph height of 2 rows. This
551 // should probably be pondered with the screen width.
552 d->par_height_.resize(parsize, defaultRowHeight() * 2);
555 // Look at paragraph heights on-screen
556 pair<pit_type, ParagraphMetrics const *> first = tm.first();
557 pair<pit_type, ParagraphMetrics const *> last = tm.last();
558 for (pit_type pit = first.first; pit <= last.first; ++pit) {
559 d->par_height_[pit] = tm.parMetrics(pit).height();
560 LYXERR(Debug::SCROLLING, "storing height for pit " << pit << " : "
561 << d->par_height_[pit]);
564 int top_pos = first.second->position() - first.second->ascent();
565 int bottom_pos = last.second->position() + last.second->descent();
566 bool first_visible = first.first == 0 && top_pos >= 0;
567 bool last_visible = last.first + 1 == int(parsize) && bottom_pos <= height_;
568 if (first_visible && last_visible) {
569 d->scrollbarParameters_.min = 0;
570 d->scrollbarParameters_.max = 0;
574 d->scrollbarParameters_.min = top_pos;
575 for (size_t i = 0; i != size_t(first.first); ++i)
576 d->scrollbarParameters_.min -= d->par_height_[i];
577 d->scrollbarParameters_.max = bottom_pos;
578 for (size_t i = last.first + 1; i != parsize; ++i)
579 d->scrollbarParameters_.max += d->par_height_[i];
581 // The reference is the top position so we remove one page.
582 if (lyxrc.scroll_below_document)
583 d->scrollbarParameters_.max -= minVisiblePart();
585 d->scrollbarParameters_.max -= d->scrollbarParameters_.page_step;
587 // 0 must be inside the range as it denotes the current position
588 if (d->scrollbarParameters_.max < 0)
589 d->scrollbarParameters_.max = 0;
590 if (d->scrollbarParameters_.min > 0)
591 d->scrollbarParameters_.min = 0;
595 ScrollbarParameters const & BufferView::scrollbarParameters() const
597 return d->scrollbarParameters_;
601 docstring BufferView::toolTip(int x, int y) const
603 // Get inset under mouse, if there is one.
604 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
606 // No inset, no tooltip...
608 return covering_inset->toolTip(*this, x, y);
612 string BufferView::contextMenu(int x, int y) const
614 //If there is a selection, return the containing inset menu
615 if (d->cursor_.selection())
616 return d->cursor_.inset().contextMenu(*this, x, y);
618 // Get inset under mouse, if there is one.
619 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
621 return covering_inset->contextMenu(*this, x, y);
623 return buffer_.inset().contextMenu(*this, x, y);
628 void BufferView::scrollDocView(int const value, bool update)
630 // The scrollbar values are relative to the top of the screen, therefore the
631 // offset is equal to the target value.
633 // No scrolling at all? No need to redraw anything
637 // If the offset is less than 2 screen height, prefer to scroll instead.
638 if (abs(value) <= 2 * height_) {
639 d->anchor_ypos_ -= value;
640 buffer_.changed(true);
641 updateHoveredInset();
645 // cut off at the top
646 if (value <= d->scrollbarParameters_.min) {
647 DocIterator dit = doc_iterator_begin(&buffer_);
648 showCursor(dit, false, update);
649 LYXERR(Debug::SCROLLING, "scroll to top");
653 // cut off at the bottom
654 if (value >= d->scrollbarParameters_.max) {
655 DocIterator dit = doc_iterator_end(&buffer_);
657 showCursor(dit, false, update);
658 LYXERR(Debug::SCROLLING, "scroll to bottom");
662 // find paragraph at target position
663 int par_pos = d->scrollbarParameters_.min;
665 for (; i != int(d->par_height_.size()); ++i) {
666 par_pos += d->par_height_[i];
667 if (par_pos >= value)
671 if (par_pos < value) {
672 // It seems we didn't find the correct pit so stay on the safe side and
674 LYXERR0("scrolling position not found!");
675 scrollDocView(d->scrollbarParameters_.max, update);
679 DocIterator dit = doc_iterator_begin(&buffer_);
681 LYXERR(Debug::SCROLLING, "value = " << value << " -> scroll to pit " << i);
682 showCursor(dit, false, update);
686 // FIXME: this method is not working well.
687 void BufferView::setCursorFromScrollbar()
689 TextMetrics & tm = d->text_metrics_[&buffer_.text()];
691 int const height = 2 * defaultRowHeight();
692 int const first = height;
693 int const last = height_ - height;
695 Cursor const & oldcur = d->cursor_;
697 switch (cursorStatus(oldcur)) {
705 int const y = getPos(oldcur).y_;
706 newy = min(last, max(y, first));
710 // We reset the cursor because cursorStatus() does not
711 // work when the cursor is within mathed.
714 tm.setCursorFromCoordinates(cur, 0, newy);
716 // update the bufferview cursor and notify insets
717 // FIXME: Care about the d->cursor_ flags to redraw if needed
718 Cursor old = d->cursor_;
720 // the DEPM call in mouseSetCursor() might have destroyed the
721 // paragraph the cursor is in.
722 bool badcursor = old.fixIfBroken();
723 badcursor |= notifyCursorLeavesOrEnters(old, d->cursor_);
725 d->cursor_.fixIfBroken();
729 Change const BufferView::getCurrentChange() const
731 if (!d->cursor_.selection())
732 return Change(Change::UNCHANGED);
734 DocIterator dit = d->cursor_.selectionBegin();
735 // The selected content might have been changed (see #7685)
736 dit = dit.getInnerText();
737 return dit.paragraph().lookupChange(dit.pos());
741 // this could be used elsewhere as well?
742 // FIXME: This does not work within mathed!
743 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
745 Point const p = getPos(dit);
748 if (p.y_ > workHeight())
754 void BufferView::bookmarkEditPosition()
756 // Don't eat cpu time for each keystroke
757 if (d->cursor_.paragraph().id() == d->bookmark_edit_position_)
760 d->bookmark_edit_position_ = d->cursor_.paragraph().id();
764 void BufferView::saveBookmark(unsigned int idx)
766 // tentatively save bookmark, id and pos will be used to
767 // acturately locate a bookmark in a 'live' lyx session.
768 // pit and pos will be updated with bottom level pit/pos
770 if (!buffer_.isInternal()) {
771 theSession().bookmarks().save(
773 d->cursor_.bottom().pit(),
774 d->cursor_.bottom().pos(),
775 d->cursor_.paragraph().id(),
780 // emit message signal.
781 message(_("Save bookmark"));
786 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
787 int top_id, pos_type top_pos)
789 bool success = false;
792 d->cursor_.clearSelection();
794 // if a valid par_id is given, try it first
795 // This is the case for a 'live' bookmark when unique paragraph ID
796 // is used to track bookmarks.
798 dit = buffer_.getParFromID(top_id);
800 dit.pos() = min(dit.paragraph().size(), top_pos);
801 // Some slices of the iterator may not be
802 // reachable (e.g. closed collapsible inset)
803 // so the dociterator may need to be
804 // shortened. Otherwise, setCursor may crash
805 // lyx when the cursor can not be set to these
807 size_t const n = dit.depth();
808 for (size_t i = 0; i < n; ++i)
809 if (!dit[i].inset().editable()) {
817 // if top_id == 0, or searching through top_id failed
818 // This is the case for a 'restored' bookmark when only bottom
819 // (document level) pit was saved. Because of this, bookmark
820 // restoration is inaccurate. If a bookmark was within an inset,
821 // it will be restored to the left of the outmost inset that contains
823 if (bottom_pit < int(buffer_.paragraphs().size())) {
824 dit = doc_iterator_begin(&buffer_);
826 dit.pit() = bottom_pit;
827 dit.pos() = min(bottom_pos, dit.paragraph().size());
832 // Note: only bottom (document) level pit is set.
834 // set the current font.
835 d->cursor_.setCurrentFont();
836 // Do not forget to reset the anchor (see #9912)
837 d->cursor_.resetAnchor();
838 // To center the screen on this new position we need the
839 // paragraph position which is computed at draw() time.
840 // So we need a redraw!
841 buffer_.changed(false);
842 if (needsFitCursor())
850 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
852 if (d->cursor_.real_current_font.isRightToLeft()) {
853 if (d->intl_.keymap == Intl::PRIMARY)
854 d->intl_.keyMapSec();
856 if (d->intl_.keymap == Intl::SECONDARY)
857 d->intl_.keyMapPrim();
860 d->intl_.getTransManager().translateAndInsert(c, t, cur);
864 int BufferView::workWidth() const
870 void BufferView::recenter()
872 showCursor(d->cursor_, true, true);
876 void BufferView::showCursor()
878 showCursor(d->cursor_, false, true);
882 void BufferView::showCursor(DocIterator const & dit,
883 bool recenter, bool update)
885 if (scrollToCursor(dit, recenter) && update) {
886 buffer_.changed(true);
887 updateHoveredInset();
892 void BufferView::scrollToCursor()
894 if (scrollToCursor(d->cursor_, false)) {
895 buffer_.changed(true);
896 updateHoveredInset();
901 bool BufferView::scrollToCursor(DocIterator const & dit, bool const recenter)
903 // We are not properly started yet, delay until resizing is
908 LYXERR(Debug::SCROLLING, "recentering!");
910 CursorSlice const & bot = dit.bottom();
911 TextMetrics & tm = d->text_metrics_[bot.text()];
913 pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
914 int bot_pit = bot.pit();
915 if (bot_pit > max_pit) {
916 // FIXME: Why does this happen?
917 LYXERR0("bottom pit is greater that max pit: "
918 << bot_pit << " > " << max_pit);
922 if (bot_pit == tm.first().first - 1)
923 tm.newParMetricsUp();
924 else if (bot_pit == tm.last().first + 1)
925 tm.newParMetricsDown();
927 if (tm.contains(bot_pit)) {
928 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
929 LBUFERR(!pm.rows().empty());
930 // FIXME: smooth scrolling doesn't work in mathed.
931 CursorSlice const & cs = dit.innerTextSlice();
932 int offset = coordOffset(dit).y_;
933 int ypos = pm.position() + offset;
934 Dimension const & row_dim =
935 pm.getRow(cs.pos(), dit.boundary()).dimension();
938 scrolled = scroll(ypos - height_/2);
940 // We try to visualize the whole row, if the row height is larger than
941 // the screen height, we scroll to a heuristic value of height_ / 4.
942 // FIXME: This heuristic value should be replaced by a recursive search
943 // for a row in the inset that can be visualized completely.
944 else if (row_dim.height() > height_) {
945 if (ypos < defaultRowHeight())
946 scrolled = scroll(ypos - height_ / 4);
947 else if (ypos > height_ - defaultRowHeight())
948 scrolled = scroll(ypos - 3 * height_ / 4);
951 // If the top part of the row falls of the screen, we scroll
952 // up to align the top of the row with the top of the screen.
953 else if (ypos - row_dim.ascent() < 0 && ypos < height_) {
954 int ynew = row_dim.ascent();
955 scrolled = scrollUp(ynew - ypos);
958 // If the bottom of the row falls of the screen, we scroll down.
959 else if (ypos + row_dim.descent() > height_ && ypos > 0) {
960 int ynew = height_ - row_dim.descent();
961 scrolled = scrollDown(ypos - ynew);
964 // else, nothing to do, the cursor is already visible so we just return.
965 return scrolled != 0;
968 // fix inline completion position
969 if (d->inlineCompletionPos_.fixIfBroken())
970 d->inlineCompletionPos_ = DocIterator();
972 tm.redoParagraph(bot_pit);
973 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
974 int offset = coordOffset(dit).y_;
976 d->anchor_pit_ = bot_pit;
977 CursorSlice const & cs = dit.innerTextSlice();
978 Dimension const & row_dim =
979 pm.getRow(cs.pos(), dit.boundary()).dimension();
982 d->anchor_ypos_ = height_/2;
983 else if (d->anchor_pit_ == 0)
984 d->anchor_ypos_ = offset + pm.ascent();
985 else if (d->anchor_pit_ == max_pit)
986 d->anchor_ypos_ = height_ - offset - row_dim.descent();
987 else if (offset > height_)
988 d->anchor_ypos_ = height_ - offset - defaultRowHeight();
990 d->anchor_ypos_ = defaultRowHeight() * 2;
996 void BufferView::makeDocumentClass()
998 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
999 buffer_.params().makeDocumentClass();
1000 updateDocumentClass(olddc);
1004 void BufferView::updateDocumentClass(DocumentClassConstPtr olddc)
1006 message(_("Converting document to new document class..."));
1008 StableDocIterator backcur(d->cursor_);
1009 ErrorList & el = buffer_.errorList("Class Switch");
1010 cap::switchBetweenClasses(
1011 olddc, buffer_.params().documentClassPtr(),
1012 static_cast<InsetText &>(buffer_.inset()), el);
1014 setCursor(backcur.asDocIterator(&buffer_));
1016 buffer_.errors("Class Switch");
1020 /** Return the change status at cursor position, taking into account the
1021 * status at each level of the document iterator (a table in a deleted
1022 * footnote is deleted).
1023 * When \param outer is true, the top slice is not looked at.
1025 static Change::Type lookupChangeType(DocIterator const & dit, bool outer = false)
1027 size_t const depth = dit.depth() - (outer ? 1 : 0);
1029 for (size_t i = 0 ; i < depth ; ++i) {
1030 CursorSlice const & slice = dit[i];
1031 if (!slice.inset().inMathed()
1032 && slice.pos() < slice.paragraph().size()) {
1033 Change::Type const ch = slice.paragraph().lookupChange(slice.pos()).type;
1034 if (ch != Change::UNCHANGED)
1038 return Change::UNCHANGED;
1042 bool BufferView::getStatus(FuncRequest const & cmd, FuncStatus & flag)
1044 FuncCode const act = cmd.action();
1046 // Can we use a readonly buffer?
1047 if (buffer_.isReadonly()
1048 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1049 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1050 if (buffer_.hasReadonlyFlag())
1051 flag.message(from_utf8(N_("Document is read-only")));
1053 flag.message(from_utf8(N_("Document has been modified externally")));
1054 flag.setEnabled(false);
1058 // Are we in a DELETED change-tracking region?
1059 if (lookupChangeType(d->cursor_, true) == Change::DELETED
1060 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1061 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1062 flag.message(from_utf8(N_("This portion of the document is deleted.")));
1063 flag.setEnabled(false);
1067 Cursor & cur = d->cursor_;
1069 if (cur.getStatus(cmd, flag))
1074 // FIXME: This is a bit problematic because we don't check if this is
1075 // a document BufferView or not for these LFUNs. We probably have to
1076 // dispatch both to currentBufferView() and, if that fails,
1077 // to documentBufferView(); same as we do now for current Buffer and
1078 // document Buffer. Ideally those LFUN should go to Buffer as they
1079 // operate on the full Buffer and the cursor is only needed either for
1080 // an Undo record or to restore a cursor position. But we don't know
1081 // how to do that inside Buffer of course.
1082 case LFUN_BUFFER_PARAMS_APPLY:
1083 case LFUN_LAYOUT_MODULES_CLEAR:
1084 case LFUN_LAYOUT_MODULE_ADD:
1085 case LFUN_LAYOUT_RELOAD:
1086 case LFUN_TEXTCLASS_APPLY:
1087 case LFUN_TEXTCLASS_LOAD:
1088 flag.setEnabled(!buffer_.isReadonly());
1092 // We do not use the LyXAction flag for readonly because Undo sets the
1093 // buffer clean/dirty status by itself.
1094 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasUndoStack());
1097 // We do not use the LyXAction flag for readonly because Redo sets the
1098 // buffer clean/dirty status by itself.
1099 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasRedoStack());
1101 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
1102 case LFUN_FILE_INSERT_PLAINTEXT: {
1103 docstring const fname = cmd.argument();
1104 if (!FileName::isAbsolute(to_utf8(fname))) {
1105 flag.message(_("Absolute filename expected."));
1108 flag.setEnabled(cur.inTexted());
1111 case LFUN_FILE_INSERT:
1112 case LFUN_BOOKMARK_SAVE:
1113 // FIXME: Actually, these LFUNS should be moved to Text
1114 flag.setEnabled(cur.inTexted());
1117 case LFUN_FONT_STATE:
1118 case LFUN_LABEL_INSERT:
1119 case LFUN_INFO_INSERT:
1120 case LFUN_PARAGRAPH_GOTO:
1121 case LFUN_NOTE_NEXT:
1122 case LFUN_REFERENCE_NEXT:
1123 case LFUN_WORD_FIND:
1124 case LFUN_WORD_FIND_FORWARD:
1125 case LFUN_WORD_FIND_BACKWARD:
1126 case LFUN_WORD_REPLACE:
1129 case LFUN_MARK_TOGGLE:
1130 case LFUN_SCREEN_RECENTER:
1131 case LFUN_SCREEN_SHOW_CURSOR:
1132 case LFUN_BIBTEX_DATABASE_ADD:
1133 case LFUN_BIBTEX_DATABASE_DEL:
1134 case LFUN_STATISTICS:
1135 case LFUN_KEYMAP_OFF:
1136 case LFUN_KEYMAP_PRIMARY:
1137 case LFUN_KEYMAP_SECONDARY:
1138 case LFUN_KEYMAP_TOGGLE:
1139 case LFUN_INSET_SELECT_ALL:
1140 flag.setEnabled(true);
1143 case LFUN_WORD_FINDADV: {
1144 FindAndReplaceOptions opt;
1145 istringstream iss(to_utf8(cmd.argument()));
1147 flag.setEnabled(opt.repl_buf_name.empty()
1148 || !buffer_.isReadonly());
1152 case LFUN_LABEL_GOTO:
1153 flag.setEnabled(!cmd.argument().empty()
1154 || getInsetByCode<InsetRef>(cur, REF_CODE));
1157 case LFUN_CHANGES_MERGE:
1158 case LFUN_CHANGE_NEXT:
1159 case LFUN_CHANGE_PREVIOUS:
1160 case LFUN_ALL_CHANGES_ACCEPT:
1161 case LFUN_ALL_CHANGES_REJECT:
1162 flag.setEnabled(buffer_.areChangesPresent());
1165 case LFUN_SCREEN_UP:
1166 case LFUN_SCREEN_DOWN:
1168 case LFUN_SCREEN_UP_SELECT:
1169 case LFUN_SCREEN_DOWN_SELECT:
1170 case LFUN_INSET_FORALL:
1171 flag.setEnabled(true);
1174 case LFUN_LAYOUT_TABULAR:
1175 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
1179 flag.setEnabled(!cur.inset().forcePlainLayout(cur.idx()));
1182 case LFUN_LAYOUT_PARAGRAPH:
1183 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
1186 case LFUN_BRANCH_ADD_INSERT:
1187 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1190 case LFUN_DIALOG_SHOW_NEW_INSET:
1191 // FIXME: this is wrong, but I do not understand the
1193 if (cur.inset().lyxCode() == CAPTION_CODE)
1194 return cur.inset().getStatus(cur, cmd, flag);
1195 // FIXME we should consider passthru paragraphs too.
1196 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1199 case LFUN_CITATION_INSERT: {
1200 FuncRequest fr(LFUN_INSET_INSERT, "citation");
1201 // FIXME: This could turn in a recursive hell.
1202 // Shouldn't we use Buffer::getStatus() instead?
1203 flag.setEnabled(lyx::getStatus(fr).enabled());
1206 case LFUN_INSET_APPLY: {
1207 string const name = cmd.getArg(0);
1208 Inset * inset = editedInset(name);
1210 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1211 if (!inset->getStatus(cur, fr, flag)) {
1212 // Every inset is supposed to handle this
1213 LASSERT(false, break);
1216 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1217 flag = lyx::getStatus(fr);
1230 Inset * BufferView::editedInset(string const & name) const
1232 map<string, Inset *>::const_iterator it = d->edited_insets_.find(name);
1233 return it == d->edited_insets_.end() ? 0 : it->second;
1237 void BufferView::editInset(string const & name, Inset * inset)
1239 d->edited_insets_[name] = inset;
1243 void BufferView::dispatch(FuncRequest const & cmd, DispatchResult & dr)
1245 LYXERR(Debug::ACTION, "BufferView::dispatch: cmd: " << cmd);
1247 string const argument = to_utf8(cmd.argument());
1248 Cursor & cur = d->cursor_;
1251 // Don't dispatch function that does not apply to internal buffers.
1252 if (buffer_.isInternal()
1253 && lyxaction.funcHasFlag(cmd.action(), LyXAction::NoInternal))
1256 // We'll set this back to false if need be.
1257 bool dispatched = true;
1258 buffer_.undo().beginUndoGroup();
1260 FuncCode const act = cmd.action();
1263 case LFUN_BUFFER_PARAMS_APPLY: {
1264 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1265 cur.recordUndoBufferParams();
1266 istringstream ss(to_utf8(cmd.argument()));
1269 int const unknown_tokens = buffer_.readHeader(lex);
1270 if (unknown_tokens != 0) {
1271 LYXERR0("Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1272 << unknown_tokens << " unknown token"
1273 << (unknown_tokens == 1 ? "" : "s"));
1275 updateDocumentClass(olddc);
1277 // We are most certainly here because of a change in the document
1278 // It is then better to make sure that all dialogs are in sync with
1279 // current document settings.
1280 dr.screenUpdate(Update::Force | Update::FitCursor);
1281 dr.forceBufferUpdate();
1285 case LFUN_LAYOUT_MODULES_CLEAR: {
1286 // FIXME: this modifies the document in cap::switchBetweenClasses
1287 // without calling recordUndo. Fix this before using
1288 // recordUndoBufferParams().
1289 cur.recordUndoFullBuffer();
1290 buffer_.params().clearLayoutModules();
1291 makeDocumentClass();
1292 dr.screenUpdate(Update::Force);
1293 dr.forceBufferUpdate();
1297 case LFUN_LAYOUT_MODULE_ADD: {
1298 BufferParams const & params = buffer_.params();
1299 if (!params.layoutModuleCanBeAdded(argument)) {
1300 LYXERR0("Module `" << argument <<
1301 "' cannot be added due to failed requirements or "
1302 "conflicts with installed modules.");
1305 // FIXME: this modifies the document in cap::switchBetweenClasses
1306 // without calling recordUndo. Fix this before using
1307 // recordUndoBufferParams().
1308 cur.recordUndoFullBuffer();
1309 buffer_.params().addLayoutModule(argument);
1310 makeDocumentClass();
1311 dr.screenUpdate(Update::Force);
1312 dr.forceBufferUpdate();
1316 case LFUN_TEXTCLASS_APPLY: {
1317 // since this shortcircuits, the second call is made only if
1319 bool const success =
1320 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1321 LayoutFileList::get().load(argument, buffer_.filePath());
1323 docstring s = bformat(_("The document class `%1$s' "
1324 "could not be loaded."), from_utf8(argument));
1325 frontend::Alert::error(_("Could not load class"), s);
1329 LayoutFile const * old_layout = buffer_.params().baseClass();
1330 LayoutFile const * new_layout = &(LayoutFileList::get()[argument]);
1332 if (old_layout == new_layout)
1336 // Save the old, possibly modular, layout for use in conversion.
1337 // FIXME: this modifies the document in cap::switchBetweenClasses
1338 // without calling recordUndo. Fix this before using
1339 // recordUndoBufferParams().
1340 cur.recordUndoFullBuffer();
1341 buffer_.params().setBaseClass(argument);
1342 makeDocumentClass();
1343 dr.screenUpdate(Update::Force);
1344 dr.forceBufferUpdate();
1348 case LFUN_TEXTCLASS_LOAD: {
1349 // since this shortcircuits, the second call is made only if
1351 bool const success =
1352 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1353 LayoutFileList::get().load(argument, buffer_.filePath());
1355 docstring s = bformat(_("The document class `%1$s' "
1356 "could not be loaded."), from_utf8(argument));
1357 frontend::Alert::error(_("Could not load class"), s);
1362 case LFUN_LAYOUT_RELOAD: {
1363 LayoutFileIndex bc = buffer_.params().baseClassID();
1364 LayoutFileList::get().reset(bc);
1365 buffer_.params().setBaseClass(bc);
1366 makeDocumentClass();
1367 dr.screenUpdate(Update::Force);
1368 dr.forceBufferUpdate();
1373 dr.setMessage(_("Undo"));
1374 cur.clearSelection();
1375 if (!cur.textUndo())
1376 dr.setMessage(_("No further undo information"));
1378 dr.screenUpdate(Update::Force | Update::FitCursor);
1379 dr.forceBufferUpdate();
1383 dr.setMessage(_("Redo"));
1384 cur.clearSelection();
1385 if (!cur.textRedo())
1386 dr.setMessage(_("No further redo information"));
1388 dr.screenUpdate(Update::Force | Update::FitCursor);
1389 dr.forceBufferUpdate();
1392 case LFUN_FONT_STATE:
1393 dr.setMessage(cur.currentState(false));
1396 case LFUN_BOOKMARK_SAVE:
1397 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1400 case LFUN_LABEL_GOTO: {
1401 docstring label = cmd.argument();
1402 if (label.empty()) {
1404 getInsetByCode<InsetRef>(cur, REF_CODE);
1406 label = inset->getParam("reference");
1407 // persistent=false: use temp_bookmark
1411 if (!label.empty()) {
1413 // at the moment, this is redundant, since gotoLabel will
1414 // eventually call LFUN_PARAGRAPH_GOTO, but it seems best
1416 dr.screenUpdate(Update::Force | Update::FitCursor);
1421 case LFUN_PARAGRAPH_GOTO: {
1422 int const id = convert<int>(cmd.getArg(0));
1423 pos_type const pos = convert<int>(cmd.getArg(1));
1426 string const str_id_end = cmd.getArg(2);
1427 string const str_pos_end = cmd.getArg(3);
1429 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1430 b = theBufferList().next(b)) {
1433 cur.setCursor(b->getParFromID(id));
1435 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1439 LYXERR(Debug::INFO, "Paragraph " << cur.paragraph().id()
1440 << " found in buffer `"
1441 << b->absFileName() << "'.");
1443 if (b == &buffer_) {
1445 if (str_id_end.empty() || str_pos_end.empty()) {
1448 mouseSetCursor(cur);
1451 int const id_end = convert<int>(str_id_end);
1452 pos_type const pos_end = convert<int>(str_pos_end);
1453 success = setCursorFromEntries({id, pos},
1457 dr.screenUpdate(Update::Force | Update::FitCursor);
1459 // Switch to other buffer view and resend cmd
1460 lyx::dispatch(FuncRequest(
1461 LFUN_BUFFER_SWITCH, b->absFileName()));
1469 case LFUN_NOTE_NEXT:
1470 gotoInset(this, NOTE_CODE, false);
1473 case LFUN_REFERENCE_NEXT: {
1474 vector<InsetCode> tmp;
1475 tmp.push_back(LABEL_CODE);
1476 tmp.push_back(REF_CODE);
1477 gotoInset(this, tmp, true);
1481 case LFUN_CHANGE_NEXT:
1482 findNextChange(this);
1483 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1484 dr.screenUpdate(Update::Force | Update::FitCursor);
1487 case LFUN_CHANGE_PREVIOUS:
1488 findPreviousChange(this);
1489 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1490 dr.screenUpdate(Update::Force | Update::FitCursor);
1493 case LFUN_CHANGES_MERGE:
1494 if (findNextChange(this) || findPreviousChange(this)) {
1495 dr.screenUpdate(Update::Force | Update::FitCursor);
1496 dr.forceBufferUpdate();
1497 showDialog("changes");
1501 case LFUN_ALL_CHANGES_ACCEPT:
1502 // select complete document
1504 cur.selHandle(true);
1505 buffer_.text().cursorBottom(cur);
1506 // accept everything in a single step to support atomic undo
1507 buffer_.text().acceptOrRejectChanges(cur, Text::ACCEPT);
1509 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1510 dr.screenUpdate(Update::Force | Update::FitCursor);
1511 dr.forceBufferUpdate();
1514 case LFUN_ALL_CHANGES_REJECT:
1515 // select complete document
1517 cur.selHandle(true);
1518 buffer_.text().cursorBottom(cur);
1519 // reject everything in a single step to support atomic undo
1520 // Note: reject does not work recursively; the user may have to repeat the operation
1521 buffer_.text().acceptOrRejectChanges(cur, Text::REJECT);
1523 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1524 dr.screenUpdate(Update::Force | Update::FitCursor);
1525 dr.forceBufferUpdate();
1528 case LFUN_WORD_FIND_FORWARD:
1529 case LFUN_WORD_FIND_BACKWARD: {
1531 // Would it maybe be better if this variable were view specific anyway?
1532 static docstring last_search;
1533 docstring searched_string;
1535 if (!cmd.argument().empty()) {
1536 last_search = cmd.argument();
1537 searched_string = cmd.argument();
1539 searched_string = last_search;
1542 if (searched_string.empty())
1545 bool const fw = act == LFUN_WORD_FIND_FORWARD;
1546 docstring const data =
1547 find2string(searched_string, true, false, fw);
1548 bool found = lyxfind(this, FuncRequest(LFUN_WORD_FIND, data));
1550 dr.screenUpdate(Update::Force | Update::FitCursor);
1554 case LFUN_WORD_FIND: {
1555 FuncRequest req = cmd;
1556 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1557 req = d->search_request_cache_;
1558 if (req.argument().empty()) {
1559 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, "findreplace"));
1562 if (lyxfind(this, req))
1563 dr.screenUpdate(Update::Force | Update::FitCursor);
1565 d->search_request_cache_ = req;
1569 case LFUN_WORD_REPLACE: {
1570 bool has_deleted = false;
1571 if (cur.selection()) {
1572 DocIterator beg = cur.selectionBegin();
1573 DocIterator end = cur.selectionEnd();
1574 if (beg.pit() == end.pit()) {
1575 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1576 if (!cur.inMathed() && cur.paragraph().isDeleted(p)) {
1583 if (lyxreplace(this, cmd, has_deleted)) {
1584 dr.forceBufferUpdate();
1585 dr.screenUpdate(Update::Force | Update::FitCursor);
1590 case LFUN_WORD_FINDADV: {
1591 FindAndReplaceOptions opt;
1592 istringstream iss(to_utf8(cmd.argument()));
1594 if (findAdv(this, opt)) {
1595 dr.screenUpdate(Update::Force | Update::FitCursor);
1606 cur.clearSelection();
1607 dr.setMessage(from_utf8(N_("Mark off")));
1611 cur.clearSelection();
1613 dr.setMessage(from_utf8(N_("Mark on")));
1616 case LFUN_MARK_TOGGLE:
1617 cur.selection(false);
1620 dr.setMessage(from_utf8(N_("Mark removed")));
1623 dr.setMessage(from_utf8(N_("Mark set")));
1628 case LFUN_SCREEN_SHOW_CURSOR:
1632 case LFUN_SCREEN_RECENTER:
1636 case LFUN_BIBTEX_DATABASE_ADD: {
1637 Cursor tmpcur = cur;
1638 findInset(tmpcur, BIBTEX_CODE, false);
1639 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1642 if (inset->addDatabase(cmd.argument())) {
1643 buffer_.invalidateBibfileCache();
1644 dr.forceBufferUpdate();
1650 case LFUN_BIBTEX_DATABASE_DEL: {
1651 Cursor tmpcur = cur;
1652 findInset(tmpcur, BIBTEX_CODE, false);
1653 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1656 if (inset->delDatabase(cmd.argument())) {
1657 buffer_.invalidateBibfileCache();
1658 dr.forceBufferUpdate();
1664 case LFUN_STATISTICS: {
1665 DocIterator from, to;
1666 if (cur.selection()) {
1667 from = cur.selectionBegin();
1668 to = cur.selectionEnd();
1670 from = doc_iterator_begin(&buffer_);
1671 to = doc_iterator_end(&buffer_);
1673 buffer_.updateStatistics(from, to);
1674 int const words = buffer_.wordCount();
1675 int const chars = buffer_.charCount(false);
1676 int const chars_blanks = buffer_.charCount(true);
1678 if (cur.selection())
1679 message = _("Statistics for the selection:");
1681 message = _("Statistics for the document:");
1684 message += bformat(_("%1$d words"), words);
1686 message += _("One word");
1688 if (chars_blanks != 1)
1689 message += bformat(_("%1$d characters (including blanks)"),
1692 message += _("One character (including blanks)");
1695 message += bformat(_("%1$d characters (excluding blanks)"),
1698 message += _("One character (excluding blanks)");
1700 Alert::information(_("Statistics"), message);
1704 case LFUN_SCREEN_UP:
1705 case LFUN_SCREEN_DOWN: {
1706 Point p = getPos(cur);
1707 // This code has been commented out to enable to scroll down a
1708 // document, even if there are large insets in it (see bug #5465).
1709 /*if (p.y_ < 0 || p.y_ > height_) {
1710 // The cursor is off-screen so recenter before proceeding.
1714 int const scrolled = scroll(act == LFUN_SCREEN_UP
1715 ? -height_ : height_);
1716 if (act == LFUN_SCREEN_UP && scrolled > -height_)
1718 if (act == LFUN_SCREEN_DOWN && scrolled < height_)
1719 p = Point(width_, height_);
1720 bool const in_texted = cur.inTexted();
1721 cur.setCursor(doc_iterator_begin(cur.buffer()));
1722 cur.selHandle(false);
1723 buffer_.changed(true);
1724 updateHoveredInset();
1726 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_,
1727 true, act == LFUN_SCREEN_UP);
1728 //FIXME: what to do with cur.x_target()?
1729 bool update = in_texted && cur.bv().checkDepm(cur, old);
1732 if (update || cur.mark())
1733 dr.screenUpdate(Update::Force | Update::FitCursor);
1735 dr.forceBufferUpdate();
1740 string const scroll_type = cmd.getArg(0);
1741 int scroll_step = 0;
1742 if (scroll_type == "line")
1743 scroll_step = d->scrollbarParameters_.single_step;
1744 else if (scroll_type == "page")
1745 scroll_step = d->scrollbarParameters_.page_step;
1748 string const scroll_quantity = cmd.getArg(1);
1749 if (scroll_quantity == "up")
1750 scrollUp(scroll_step);
1751 else if (scroll_quantity == "down")
1752 scrollDown(scroll_step);
1754 int const scroll_value = convert<int>(scroll_quantity);
1756 scroll(scroll_step * scroll_value);
1758 buffer_.changed(true);
1759 updateHoveredInset();
1760 dr.forceBufferUpdate();
1764 case LFUN_SCREEN_UP_SELECT: {
1765 // FIXME: why is the algorithm different from LFUN_SCREEN_UP?
1766 cur.selHandle(true);
1767 if (isTopScreen()) {
1768 lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1772 int y = getPos(cur).y_;
1773 int const ymin = y - height_ + defaultRowHeight();
1774 while (y > ymin && cur.up())
1778 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1782 case LFUN_SCREEN_DOWN_SELECT: {
1783 // FIXME: why is the algorithm different from LFUN_SCREEN_DOWN?
1784 cur.selHandle(true);
1785 if (isBottomScreen()) {
1786 lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1790 int y = getPos(cur).y_;
1791 int const ymax = y + height_ - defaultRowHeight();
1792 while (y < ymax && cur.down())
1796 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1801 case LFUN_INSET_SELECT_ALL: {
1802 // true if all cells are selected
1803 bool const all_selected = cur.depth() > 1
1804 && cur.selBegin().at_begin()
1805 && cur.selEnd().at_end();
1806 // true if some cells are selected
1807 bool const cells_selected = cur.depth() > 1
1808 && cur.selBegin().at_cell_begin()
1809 && cur.selEnd().at_cell_end();
1810 if (all_selected || (cells_selected && !cur.inset().isTable())) {
1811 // All the contents of the inset if selected, or only at
1812 // least one cell but inset is not a table.
1813 // Select the inset from outside.
1816 cur.selection(true);
1818 } else if (cells_selected) {
1819 // At least one complete cell is selected and inset is a table.
1824 cur.selection(true);
1825 cur.idx() = cur.lastidx();
1826 cur.pos() = cur.lastpos();
1828 // select current cell
1832 cur.selection(true);
1833 cur.pit() = cur.lastpit();
1834 cur.pos() = cur.lastpos();
1836 cur.setCurrentFont();
1837 dr.screenUpdate(Update::Force);
1842 // This would be in Buffer class if only Cursor did not
1843 // require a bufferview
1844 case LFUN_INSET_FORALL: {
1845 docstring const name = from_utf8(cmd.getArg(0));
1846 string const commandstr = cmd.getLongArg(1);
1847 FuncRequest const fr = lyxaction.lookupFunc(commandstr);
1849 // an arbitrary number to limit number of iterations
1850 const int max_iter = 100000;
1852 Cursor & cur = d->cursor_;
1853 Cursor const savecur = cur;
1855 if (!cur.nextInset())
1857 cur.beginUndoGroup();
1858 while(cur && iterations < max_iter) {
1859 Inset * const ins = cur.nextInset();
1862 docstring insname = ins->layoutName();
1863 while (!insname.empty()) {
1864 if (insname == name || name == from_utf8("*")) {
1866 lyx::dispatch(fr, dr);
1870 size_t const i = insname.rfind(':');
1871 if (i == string::npos)
1873 insname = insname.substr(0, i);
1875 // if we did not delete the inset, skip it
1876 if (!cur.nextInset() || cur.nextInset() == ins)
1881 /** This is a dummy undo record only to remember the cursor
1882 * that has just been set; this will be used on a redo action
1883 * (see ticket #10097)
1885 * FIXME: a better fix would be to have a way to set the
1886 * cursor value directly, but I am not sure it is worth it.
1890 dr.screenUpdate(Update::Force);
1891 dr.forceBufferUpdate();
1893 if (iterations >= max_iter) {
1895 dr.setMessage(bformat(_("`inset-forall' interrupted because number of actions is larger than %1$d"), max_iter));
1897 dr.setMessage(bformat(_("Applied \"%1$s\" to %2$d insets"), from_utf8(commandstr), iterations));
1902 case LFUN_BRANCH_ADD_INSERT: {
1903 docstring branch_name = from_utf8(cmd.getArg(0));
1904 if (branch_name.empty())
1905 if (!Alert::askForText(branch_name, _("Branch name")) ||
1906 branch_name.empty())
1909 DispatchResult drtmp;
1910 buffer_.dispatch(FuncRequest(LFUN_BRANCH_ADD, branch_name), drtmp);
1911 if (drtmp.error()) {
1912 Alert::warning(_("Branch already exists"), drtmp.message());
1915 BranchList & branch_list = buffer_.params().branchlist();
1916 vector<docstring> const branches =
1917 getVectorFromString(branch_name, branch_list.separator());
1918 for (vector<docstring>::const_iterator it = branches.begin();
1919 it != branches.end(); ++it) {
1921 lyx::dispatch(FuncRequest(LFUN_BRANCH_INSERT, branch_name));
1926 case LFUN_KEYMAP_OFF:
1927 getIntl().keyMapOn(false);
1930 case LFUN_KEYMAP_PRIMARY:
1931 getIntl().keyMapPrim();
1934 case LFUN_KEYMAP_SECONDARY:
1935 getIntl().keyMapSec();
1938 case LFUN_KEYMAP_TOGGLE:
1939 getIntl().toggleKeyMap();
1942 case LFUN_DIALOG_SHOW_NEW_INSET: {
1943 string const name = cmd.getArg(0);
1944 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
1945 if (decodeInsetParam(name, data, buffer_))
1946 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
1948 lyxerr << "Inset type '" << name <<
1949 "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" << endl;
1953 case LFUN_CITATION_INSERT: {
1954 if (argument.empty()) {
1955 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
1958 // we can have one optional argument, delimited by '|'
1959 // citation-insert <key>|<text_before>
1960 // this should be enhanced to also support text_after
1961 // and citation style
1962 string arg = argument;
1964 if (contains(argument, "|")) {
1965 arg = token(argument, '|', 0);
1966 opt1 = token(argument, '|', 1);
1969 // if our cursor is directly in front of or behind a citation inset,
1970 // we will instead add the new key to it.
1971 Inset * inset = cur.nextInset();
1972 if (!inset || inset->lyxCode() != CITE_CODE)
1973 inset = cur.prevInset();
1974 if (inset && inset->lyxCode() == CITE_CODE) {
1975 InsetCitation * icite = static_cast<InsetCitation *>(inset);
1976 if (icite->addKey(arg)) {
1977 dr.forceBufferUpdate();
1978 dr.screenUpdate(Update::FitCursor | Update::SinglePar);
1980 LYXERR0("Discarding optional argument to citation-insert.");
1985 InsetCommandParams icp(CITE_CODE);
1986 icp["key"] = from_utf8(arg);
1988 icp["before"] = from_utf8(opt1);
1989 string icstr = InsetCommand::params2string(icp);
1990 FuncRequest fr(LFUN_INSET_INSERT, icstr);
1995 case LFUN_INSET_APPLY: {
1996 string const name = cmd.getArg(0);
1997 Inset * inset = editedInset(name);
1999 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
2003 // put cursor in front of inset.
2004 if (!setCursorFromInset(inset)) {
2005 LASSERT(false, break);
2008 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
2009 inset->dispatch(cur, fr);
2010 dr.screenUpdate(cur.result().screenUpdate());
2011 if (cur.result().needBufferUpdate())
2012 dr.forceBufferUpdate();
2017 // The change of language of buffer belongs to the Buffer class.
2018 // We have to do it here because we need a cursor for Undo.
2019 // When Undo::recordUndoBufferParams() is implemented someday
2020 // LFUN_BUFFER_LANGUAGE should be handled by the Buffer class.
2021 case LFUN_BUFFER_LANGUAGE: {
2022 Language const * oldL = buffer_.params().language;
2023 Language const * newL = languages.getLanguage(argument);
2024 if (!newL || oldL == newL)
2026 if (oldL->rightToLeft() == newL->rightToLeft()) {
2027 cur.recordUndoFullBuffer();
2028 buffer_.changeLanguage(oldL, newL);
2029 cur.setCurrentFont();
2030 dr.forceBufferUpdate();
2035 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
2036 case LFUN_FILE_INSERT_PLAINTEXT: {
2037 bool const as_paragraph = (act == LFUN_FILE_INSERT_PLAINTEXT_PARA);
2038 string const fname = to_utf8(cmd.argument());
2039 if (!FileName::isAbsolute(fname))
2040 dr.setMessage(_("Absolute filename expected."));
2042 insertPlaintextFile(FileName(fname), as_paragraph);
2047 // OK, so try the Buffer itself...
2048 buffer_.dispatch(cmd, dr);
2049 dispatched = dr.dispatched();
2053 buffer_.undo().endUndoGroup();
2054 dr.dispatched(dispatched);
2056 // NOTE: The code below is copied from Cursor::dispatch. If you
2057 // need to modify this, please update the other one too.
2059 // notify insets we just entered/left
2060 if (cursor() != old) {
2061 old.beginUndoGroup();
2063 bool badcursor = notifyCursorLeavesOrEnters(old, cursor());
2065 cursor().fixIfBroken();
2066 resetInlineCompletionPos();
2073 docstring const BufferView::requestSelection()
2075 Cursor & cur = d->cursor_;
2077 LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
2078 if (!cur.selection()) {
2079 d->xsel_cache_.set = false;
2083 LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
2084 if (!d->xsel_cache_.set ||
2085 cur.top() != d->xsel_cache_.cursor ||
2086 cur.realAnchor().top() != d->xsel_cache_.anchor)
2088 d->xsel_cache_.cursor = cur.top();
2089 d->xsel_cache_.anchor = cur.realAnchor().top();
2090 d->xsel_cache_.set = cur.selection();
2091 return cur.selectionAsString(false);
2097 void BufferView::clearSelection()
2099 d->cursor_.clearSelection();
2100 // Clear the selection buffer. Otherwise a subsequent
2101 // middle-mouse-button paste would use the selection buffer,
2102 // not the more current external selection.
2103 cap::clearSelection();
2104 d->xsel_cache_.set = false;
2105 // The buffer did not really change, but this causes the
2106 // redraw we need because we cleared the selection above.
2107 buffer_.changed(false);
2111 void BufferView::resize(int width, int height)
2113 // Update from work area
2117 // Clear the paragraph height cache.
2118 d->par_height_.clear();
2119 // Redo the metrics.
2124 Inset const * BufferView::getCoveringInset(Text const & text,
2127 TextMetrics & tm = d->text_metrics_[&text];
2128 Inset * inset = tm.checkInsetHit(x, y);
2132 if (!inset->descendable(*this))
2133 // No need to go further down if the inset is not
2137 size_t cell_number = inset->nargs();
2138 // Check all the inner cell.
2139 for (size_t i = 0; i != cell_number; ++i) {
2140 Text const * inner_text = inset->getText(i);
2143 Inset const * inset_deeper =
2144 getCoveringInset(*inner_text, x, y);
2146 return inset_deeper;
2154 void BufferView::updateHoveredInset() const
2156 // Get inset under mouse, if there is one.
2157 int const x = d->mouse_position_cache_.x_;
2158 int const y = d->mouse_position_cache_.y_;
2159 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
2161 d->clickable_inset_ = covering_inset && covering_inset->clickable(*this, x, y);
2163 if (covering_inset == d->last_inset_)
2164 // Same inset, no need to do anything...
2167 bool need_redraw = false;
2168 if (d->last_inset_) {
2169 // Remove the hint on the last hovered inset (if any).
2170 need_redraw |= d->last_inset_->setMouseHover(this, false);
2174 if (covering_inset && covering_inset->setMouseHover(this, true)) {
2176 // Only the insets that accept the hover state, do
2177 // clear the last_inset_, so only set the last_inset_
2178 // member if the hovered setting is accepted.
2179 d->last_inset_ = covering_inset;
2183 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
2184 << d->mouse_position_cache_.x_ << ", "
2185 << d->mouse_position_cache_.y_ << ")");
2187 d->update_strategy_ = DecorationUpdate;
2189 // This event (moving without mouse click) is not passed further.
2190 // This should be changed if it is further utilized.
2191 buffer_.changed(false);
2196 void BufferView::clearLastInset(Inset * inset) const
2198 if (d->last_inset_ != inset) {
2199 LYXERR0("Wrong last_inset!");
2206 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
2208 //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
2210 // This is only called for mouse related events including
2211 // LFUN_FILE_OPEN generated by drag-and-drop.
2212 FuncRequest cmd = cmd0;
2214 Cursor old = cursor();
2216 cur.push(buffer_.inset());
2217 cur.selection(d->cursor_.selection());
2219 // Either the inset under the cursor or the
2220 // surrounding Text will handle this event.
2222 // make sure we stay within the screen...
2223 cmd.set_y(min(max(cmd.y(), -1), height_));
2225 d->mouse_position_cache_.x_ = cmd.x();
2226 d->mouse_position_cache_.y_ = cmd.y();
2228 if (cmd.action() == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
2229 updateHoveredInset();
2233 // Build temporary cursor.
2234 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x(), cmd.y());
2236 // If inset is not editable, cur.pos() might point behind the
2237 // inset (depending on cmd.x(), cmd.y()). This is needed for
2238 // editing to fix bug 9628, but e.g. the context menu needs a
2239 // cursor in front of the inset.
2240 if ((inset->hasSettings() || !inset->contextMenuName().empty()
2241 || inset->lyxCode() == SEPARATOR_CODE) &&
2242 cur.nextInset() != inset && cur.prevInset() == inset)
2244 } else if (cur.inTexted() && cur.pos()
2245 && cur.paragraph().isEnvSeparator(cur.pos() - 1)) {
2246 // Always place cursor in front of a separator inset.
2250 // Put anchor at the same position.
2253 cur.beginUndoGroup();
2255 // Try to dispatch to an non-editable inset near this position
2256 // via the temp cursor. If the inset wishes to change the real
2257 // cursor it has to do so explicitly by using
2258 // cur.bv().cursor() = cur; (or similar)
2260 inset->dispatch(cur, cmd);
2262 // Now dispatch to the temporary cursor. If the real cursor should
2263 // be modified, the inset's dispatch has to do so explicitly.
2264 if (!inset || !cur.result().dispatched())
2267 // Notify left insets
2269 bool badcursor = old.fixIfBroken() | cur.fixIfBroken();
2270 badcursor |= notifyCursorLeavesOrEnters(old, cur);
2272 cursor().fixIfBroken();
2277 // Do we have a selection?
2278 theSelection().haveSelection(cursor().selection());
2280 if (cur.needBufferUpdate()) {
2281 cur.clearBufferUpdate();
2282 buffer().updateBuffer();
2285 // If the command has been dispatched,
2286 if (cur.result().dispatched() || cur.result().screenUpdate())
2287 processUpdateFlags(cur.result().screenUpdate());
2291 int BufferView::minVisiblePart()
2293 return 2 * defaultRowHeight();
2297 int BufferView::scroll(int y)
2300 return scrollDown(y);
2302 return scrollUp(-y);
2307 int BufferView::scrollDown(int offset)
2309 Text * text = &buffer_.text();
2310 TextMetrics & tm = d->text_metrics_[text];
2311 int const ymax = height_ + offset;
2313 pair<pit_type, ParagraphMetrics const *> last = tm.last();
2314 int bottom_pos = last.second->position() + last.second->descent();
2315 if (lyxrc.scroll_below_document)
2316 bottom_pos += height_ - minVisiblePart();
2317 if (last.first + 1 == int(text->paragraphs().size())) {
2318 if (bottom_pos <= height_)
2320 offset = min(offset, bottom_pos - height_);
2323 if (bottom_pos > ymax)
2325 tm.newParMetricsDown();
2327 d->anchor_ypos_ -= offset;
2332 int BufferView::scrollUp(int offset)
2334 Text * text = &buffer_.text();
2335 TextMetrics & tm = d->text_metrics_[text];
2336 int ymin = - offset;
2338 pair<pit_type, ParagraphMetrics const *> first = tm.first();
2339 int top_pos = first.second->position() - first.second->ascent();
2340 if (first.first == 0) {
2343 offset = min(offset, - top_pos);
2348 tm.newParMetricsUp();
2350 d->anchor_ypos_ += offset;
2355 bool BufferView::setCursorFromRow(int row)
2357 TexRow::TextEntry start, end;
2358 tie(start,end) = buffer_.texrow().getEntriesFromRow(row);
2359 LYXERR(Debug::LATEX,
2360 "setCursorFromRow: for row " << row << ", TexRow has found "
2361 "start (id=" << start.id << ",pos=" << start.pos << "), "
2362 "end (id=" << end.id << ",pos=" << end.pos << ")");
2363 return setCursorFromEntries(start, end);
2367 bool BufferView::setCursorFromEntries(TexRow::TextEntry start,
2368 TexRow::TextEntry end)
2370 DocIterator dit_start, dit_end;
2371 tie(dit_start,dit_end) =
2372 TexRow::getDocIteratorsFromEntries(start, end, buffer_);
2375 // Setting selection start
2376 d->cursor_.clearSelection();
2377 setCursor(dit_start);
2378 // Setting selection end
2380 d->cursor_.resetAnchor();
2381 setCursorSelectionTo(dit_end);
2387 bool BufferView::setCursorFromInset(Inset const * inset)
2389 // are we already there?
2390 if (cursor().nextInset() == inset)
2393 // Inset is not at cursor position. Find it in the document.
2396 while (cur && cur.nextInset() != inset)
2407 void BufferView::gotoLabel(docstring const & label)
2409 ListOfBuffers bufs = buffer().allRelatives();
2410 ListOfBuffers::iterator it = bufs.begin();
2411 for (; it != bufs.end(); ++it) {
2412 Buffer const * buf = *it;
2415 shared_ptr<Toc> toc = buf->tocBackend().toc("label");
2416 Toc::const_iterator toc_it = toc->begin();
2417 Toc::const_iterator end = toc->end();
2418 for (; toc_it != end; ++toc_it) {
2419 if (label == toc_it->str()) {
2420 lyx::dispatch(toc_it->action());
2428 TextMetrics const & BufferView::textMetrics(Text const * t) const
2430 return const_cast<BufferView *>(this)->textMetrics(t);
2434 TextMetrics & BufferView::textMetrics(Text const * t)
2437 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
2438 if (tmc_it == d->text_metrics_.end()) {
2439 tmc_it = d->text_metrics_.insert(
2440 make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
2442 return tmc_it->second;
2446 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
2449 return textMetrics(t).parMetrics(pit);
2453 int BufferView::workHeight() const
2459 void BufferView::setCursor(DocIterator const & dit)
2462 size_t const n = dit.depth();
2463 for (size_t i = 0; i < n; ++i)
2464 dit[i].inset().edit(d->cursor_, true);
2466 d->cursor_.setCursor(dit);
2467 d->cursor_.selection(false);
2468 d->cursor_.setCurrentFont();
2470 // It seems on general grounds as if this is probably needed, but
2471 // it is not yet clear.
2472 // See bug #7394 and r38388.
2473 // d->cursor.resetAnchor();
2477 void BufferView::setCursorSelectionTo(DocIterator const & dit)
2479 size_t const n = dit.depth();
2480 for (size_t i = 0; i < n; ++i)
2481 dit[i].inset().edit(d->cursor_, true);
2483 d->cursor_.selection(true);
2484 d->cursor_.setCursorSelectionTo(dit);
2485 d->cursor_.setCurrentFont();
2489 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
2491 // Would be wrong to delete anything if we have a selection.
2492 if (cur.selection())
2495 bool need_anchor_change = false;
2496 bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
2497 need_anchor_change);
2499 if (need_anchor_change)
2507 // we would rather not do this here, but it needs to be done before
2508 // the changed() signal is sent.
2509 buffer_.updateBuffer();
2511 buffer_.changed(true);
2516 bool BufferView::mouseSetCursor(Cursor & cur, bool const select)
2518 LASSERT(&cur.bv() == this, return false);
2521 // this event will clear selection so we save selection for
2522 // persistent selection
2523 cap::saveSelection(cursor());
2525 d->cursor_.macroModeClose();
2526 // If a macro has been finalized, the cursor might have been broken
2529 // Has the cursor just left the inset?
2530 bool const leftinset = (&d->cursor_.inset() != &cur.inset());
2532 d->cursor_.fixIfBroken();
2534 // do the dEPM magic if needed
2535 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
2536 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
2537 // the leftinset bool would not be necessary (badcursor instead).
2538 bool update = leftinset;
2541 d->cursor_.setSelection();
2542 d->cursor_.setCursorSelectionTo(cur);
2544 if (d->cursor_.inTexted())
2545 update |= checkDepm(cur, d->cursor_);
2546 d->cursor_.resetAnchor();
2547 d->cursor_.setCursor(cur);
2548 d->cursor_.clearSelection();
2550 d->cursor_.boundary(cur.boundary());
2551 d->cursor_.finishUndo();
2552 d->cursor_.setCurrentFont();
2554 cur.forceBufferUpdate();
2559 void BufferView::putSelectionAt(DocIterator const & cur,
2560 int length, bool backwards)
2562 d->cursor_.clearSelection();
2568 d->cursor_.pos() += length;
2569 d->cursor_.setSelection(d->cursor_, -length);
2571 d->cursor_.setSelection(d->cursor_, length);
2576 bool BufferView::selectIfEmpty(DocIterator & cur)
2578 if ((cur.inTexted() && !cur.paragraph().empty())
2579 || (cur.inMathed() && !cur.cell().empty()))
2582 pit_type const beg_pit = cur.pit();
2584 // The paragraph associated to this item isn't
2585 // the first one, so it can be selected
2588 // We have to resort to select the space between the
2589 // end of this item and the begin of the next one
2593 // If it is the only item in the document,
2594 // nothing can be selected
2597 pit_type const end_pit = cur.pit();
2598 pos_type const end_pos = cur.pos();
2599 d->cursor_.clearSelection();
2601 d->cursor_.setCursor(cur);
2602 d->cursor_.pit() = beg_pit;
2603 d->cursor_.pos() = 0;
2604 d->cursor_.selection(false);
2605 d->cursor_.resetAnchor();
2606 d->cursor_.pit() = end_pit;
2607 d->cursor_.pos() = end_pos;
2608 d->cursor_.setSelection();
2613 Cursor & BufferView::cursor()
2619 Cursor const & BufferView::cursor() const
2625 pit_type BufferView::anchor_ref() const
2627 return d->anchor_pit_;
2631 bool BufferView::singleParUpdate()
2633 Text & buftext = buffer_.text();
2634 pit_type const bottom_pit = d->cursor_.bottom().pit();
2635 TextMetrics & tm = textMetrics(&buftext);
2636 int old_height = tm.parMetrics(bottom_pit).height();
2638 // make sure inline completion pointer is ok
2639 if (d->inlineCompletionPos_.fixIfBroken())
2640 d->inlineCompletionPos_ = DocIterator();
2642 // In Single Paragraph mode, rebreak only
2643 // the (main text, not inset!) paragraph containing the cursor.
2644 // (if this paragraph contains insets etc., rebreaking will
2645 // recursively descend)
2646 tm.redoParagraph(bottom_pit);
2647 ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
2648 if (pm.height() != old_height)
2649 // Paragraph height has changed so we cannot proceed to
2650 // the singlePar optimisation.
2653 tm.updatePosCache(bottom_pit);
2654 d->update_strategy_ = SingleParUpdate;
2656 LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
2657 << " y2: " << pm.position() + pm.descent()
2658 << " pit: " << bottom_pit
2659 << " singlepar: 1");
2664 void BufferView::updateMetrics()
2666 if (height_ == 0 || width_ == 0)
2669 Text & buftext = buffer_.text();
2670 pit_type const npit = int(buftext.paragraphs().size());
2672 // Clear out the position cache in case of full screen redraw,
2673 d->coord_cache_.clear();
2675 // Clear out paragraph metrics to avoid having invalid metrics
2676 // in the cache from paragraphs not relayouted below
2677 // The complete text metrics will be redone.
2678 d->text_metrics_.clear();
2680 TextMetrics & tm = textMetrics(&buftext);
2682 // make sure inline completion pointer is ok
2683 if (d->inlineCompletionPos_.fixIfBroken())
2684 d->inlineCompletionPos_ = DocIterator();
2686 if (d->anchor_pit_ >= npit)
2687 // The anchor pit must have been deleted...
2688 d->anchor_pit_ = npit - 1;
2690 // Rebreak anchor paragraph.
2691 tm.redoParagraph(d->anchor_pit_);
2692 ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
2695 if (d->anchor_pit_ == 0) {
2696 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
2698 // Complete buffer visible? Then it's easy.
2699 if (scrollRange == 0)
2700 d->anchor_ypos_ = anchor_pm.ascent();
2702 // avoid empty space above the first row
2703 d->anchor_ypos_ = min(d->anchor_ypos_, anchor_pm.ascent());
2706 anchor_pm.setPosition(d->anchor_ypos_);
2707 tm.updatePosCache(d->anchor_pit_);
2709 LYXERR(Debug::PAINTING, "metrics: "
2710 << " anchor pit = " << d->anchor_pit_
2711 << " anchor ypos = " << d->anchor_ypos_);
2713 // Redo paragraphs above anchor if necessary.
2714 int y1 = d->anchor_ypos_ - anchor_pm.ascent();
2715 // We are now just above the anchor paragraph.
2716 pit_type pit1 = d->anchor_pit_ - 1;
2717 for (; pit1 >= 0 && y1 >= 0; --pit1) {
2718 tm.redoParagraph(pit1);
2719 ParagraphMetrics & pm = tm.par_metrics_[pit1];
2721 // Save the paragraph position in the cache.
2723 tm.updatePosCache(pit1);
2727 // Redo paragraphs below the anchor if necessary.
2728 int y2 = d->anchor_ypos_ + anchor_pm.descent();
2729 // We are now just below the anchor paragraph.
2730 pit_type pit2 = d->anchor_pit_ + 1;
2731 for (; pit2 < npit && y2 <= height_; ++pit2) {
2732 tm.redoParagraph(pit2);
2733 ParagraphMetrics & pm = tm.par_metrics_[pit2];
2735 // Save the paragraph position in the cache.
2737 tm.updatePosCache(pit2);
2741 LYXERR(Debug::PAINTING, "Metrics: "
2742 << " anchor pit = " << d->anchor_pit_
2743 << " anchor ypos = " << d->anchor_ypos_
2746 << " pit1 = " << pit1
2747 << " pit2 = " << pit2);
2749 // It is not necessary anymore to compute metrics, but a redraw is needed
2750 d->update_flags_ = (d->update_flags_ & ~Update::Force) | Update::ForceDraw;
2752 // Now update the positions of insets in the cache.
2755 if (lyxerr.debugging(Debug::WORKAREA)) {
2756 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
2757 d->coord_cache_.dump();
2762 void BufferView::updatePosCache()
2764 // this is the "nodraw" drawing stage: only set the positions of the
2765 // insets in metrics cache.
2766 frontend::NullPainter np;
2771 void BufferView::insertLyXFile(FileName const & fname)
2773 LASSERT(d->cursor_.inTexted(), return);
2775 // Get absolute path of file and add ".lyx"
2776 // to the filename if necessary
2777 FileName filename = fileSearch(string(), fname.absFileName(), "lyx");
2779 docstring const disp_fn = makeDisplayPath(filename.absFileName());
2780 // emit message signal.
2781 message(bformat(_("Inserting document %1$s..."), disp_fn));
2784 Buffer buf(filename.absFileName(), false);
2785 if (buf.loadLyXFile() == Buffer::ReadSuccess) {
2786 ErrorList & el = buffer_.errorList("Parse");
2787 // Copy the inserted document error list into the current buffer one.
2788 el = buf.errorList("Parse");
2789 buffer_.undo().recordUndo(d->cursor_);
2790 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
2791 buf.params().documentClassPtr(), el);
2792 res = _("Document %1$s inserted.");
2794 res = _("Could not insert document %1$s");
2797 buffer_.changed(true);
2798 // emit message signal.
2799 message(bformat(res, disp_fn));
2803 Point BufferView::coordOffset(DocIterator const & dit) const
2809 // Addup contribution of nested insets, from inside to outside,
2810 // keeping the outer paragraph for a special handling below
2811 for (size_t i = dit.depth() - 1; i >= 1; --i) {
2812 CursorSlice const & sl = dit[i];
2816 // get relative position inside sl.inset()
2817 sl.inset().cursorPos(*this, sl, dit.boundary() && (i + 1 == dit.depth()), xx, yy);
2819 // Make relative position inside of the edited inset relative to sl.inset()
2823 // In case of an RTL inset, the edited inset will be positioned to the left
2826 bool boundary_i = dit.boundary() && i + 1 == dit.depth();
2827 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2832 // remember width for the case that sl.inset() is positioned in an RTL inset
2833 lastw = sl.inset().dimension(*this).wid;
2835 //lyxerr << "Cursor::getPos, i: "
2836 // << i << " x: " << xx << " y: " << y << endl;
2839 // Add contribution of initial rows of outermost paragraph
2840 CursorSlice const & sl = dit[0];
2841 TextMetrics const & tm = textMetrics(sl.text());
2842 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2844 LBUFERR(!pm.rows().empty());
2845 y -= pm.rows()[0].ascent();
2847 // FIXME: document this mess
2849 if (sl.pos() > 0 && dit.depth() == 1) {
2851 if (pos && dit.boundary())
2853 // lyxerr << "coordOffset: boundary:" << dit.boundary() << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
2854 rend = pm.pos2row(pos);
2856 rend = pm.pos2row(sl.pos());
2858 size_t rend = pm.pos2row(sl.pos());
2860 for (size_t rit = 0; rit != rend; ++rit)
2861 y += pm.rows()[rit].height();
2862 y += pm.rows()[rend].ascent();
2864 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
2866 // Make relative position from the nested inset now bufferview absolute.
2867 int xx = bottom_tm.cursorX(dit.bottom(), dit.boundary() && dit.depth() == 1);
2870 // In the RTL case place the nested inset at the left of the cursor in
2871 // the outer paragraph
2872 bool boundary_1 = dit.boundary() && 1 == dit.depth();
2873 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
2881 Point BufferView::getPos(DocIterator const & dit) const
2883 if (!paragraphVisible(dit))
2884 return Point(-1, -1);
2886 CursorSlice const & bot = dit.bottom();
2887 TextMetrics const & tm = textMetrics(bot.text());
2889 // offset from outer paragraph
2890 Point p = coordOffset(dit);
2891 p.y_ += tm.parMetrics(bot.pit()).position();
2896 bool BufferView::paragraphVisible(DocIterator const & dit) const
2898 CursorSlice const & bot = dit.bottom();
2899 TextMetrics const & tm = textMetrics(bot.text());
2901 return tm.contains(bot.pit());
2905 void BufferView::caretPosAndHeight(Point & p, int & h) const
2907 Cursor const & cur = cursor();
2908 Font const font = cur.real_current_font;
2909 frontend::FontMetrics const & fm = theFontMetrics(font);
2910 int const asc = fm.maxAscent();
2911 int const des = fm.maxDescent();
2918 bool BufferView::cursorInView(Point const & p, int h) const
2920 Cursor const & cur = cursor();
2921 // does the cursor touch the screen ?
2922 if (p.y_ + h < 0 || p.y_ >= workHeight() || !paragraphVisible(cur))
2928 int BufferView::horizScrollOffset() const
2930 return d->horiz_scroll_offset_;
2934 int BufferView::horizScrollOffset(Text const * text,
2935 pit_type pit, pos_type pos) const
2937 // Is this a row that is currently scrolled?
2938 if (!d->current_row_slice_.empty()
2939 && &text->inset() == d->current_row_slice_.inset().asInsetText()
2940 && pit == d->current_row_slice_.pit()
2941 && pos == d->current_row_slice_.pos())
2942 return d->horiz_scroll_offset_;
2947 bool BufferView::hadHorizScrollOffset(Text const * text,
2948 pit_type pit, pos_type pos) const
2950 return !d->last_row_slice_.empty()
2951 && &text->inset() == d->last_row_slice_.inset().asInsetText()
2952 && pit == d->last_row_slice_.pit()
2953 && pos == d->last_row_slice_.pos();
2957 void BufferView::setCurrentRowSlice(CursorSlice const & rowSlice)
2959 // nothing to do if the cursor was already on this row
2960 if (d->current_row_slice_ == rowSlice) {
2961 d->last_row_slice_ = CursorSlice();
2965 // if the (previous) current row was scrolled, we have to
2966 // remember it in order to repaint it next time.
2967 if (d->horiz_scroll_offset_ != 0)
2968 d->last_row_slice_ = d->current_row_slice_;
2970 d->last_row_slice_ = CursorSlice();
2972 // Since we changed row, the scroll offset is not valid anymore
2973 d->horiz_scroll_offset_ = 0;
2974 d->current_row_slice_ = rowSlice;
2980 bool sliceInRow(CursorSlice const & cs, Text const * text, Row const & row)
2982 return !cs.empty() && cs.text() == text && cs.pit() == row.pit()
2983 && row.pos() <= cs.pos() && cs.pos() <= row.endpos();
2989 bool BufferView::needRepaint(Text const * text, Row const & row) const
2991 return d->repaint_caret_row_ && sliceInRow(d->caret_slice_, text, row);
2995 void BufferView::checkCursorScrollOffset()
2997 CursorSlice rowSlice = d->cursor_.bottom();
2998 TextMetrics const & tm = textMetrics(rowSlice.text());
3000 // Stop if metrics have not been computed yet, since it means
3001 // that there is nothing to do.
3002 if (!tm.contains(rowSlice.pit()))
3004 ParagraphMetrics const & pm = tm.parMetrics(rowSlice.pit());
3005 Row const & row = pm.getRow(rowSlice.pos(),
3006 d->cursor_.boundary() && rowSlice == d->cursor_.top());
3007 rowSlice.pos() = row.pos();
3009 // Set the row on which the cursor lives.
3010 setCurrentRowSlice(rowSlice);
3012 // Current x position of the cursor in pixels
3013 int cur_x = getPos(d->cursor_).x_;
3015 // Horizontal scroll offset of the cursor row in pixels
3016 int offset = d->horiz_scroll_offset_;
3017 int const MARGIN = 2 * theFontMetrics(d->cursor_.real_current_font).em()
3019 if (row.right_x() <= workWidth() - row.right_margin) {
3020 // Row is narrower than the work area, no offset needed.
3023 if (cur_x - offset < MARGIN) {
3024 // cursor would be too far right
3025 offset = cur_x - MARGIN;
3026 } else if (cur_x - offset > workWidth() - MARGIN) {
3027 // cursor would be too far left
3028 offset = cur_x - workWidth() + MARGIN;
3030 // Correct the offset to make sure that we do not scroll too much
3033 if (row.right_x() - offset < workWidth() - row.right_margin)
3034 offset = row.right_x() - workWidth() + row.right_margin;
3037 //lyxerr << "cur_x=" << cur_x << ", offset=" << offset << ", row.wid=" << row.width() << ", margin=" << MARGIN << endl;
3039 if (offset != d->horiz_scroll_offset_)
3040 LYXERR(Debug::PAINTING, "Horiz. scroll offset changed from "
3041 << d->horiz_scroll_offset_ << " to " << offset);
3043 if (d->update_strategy_ == NoScreenUpdate
3044 && (offset != d->horiz_scroll_offset_
3045 || !d->last_row_slice_.empty())) {
3046 // FIXME: if one uses SingleParUpdate, then home/end
3047 // will not work on long rows. Why?
3048 d->update_strategy_ = FullScreenUpdate;
3051 d->horiz_scroll_offset_ = offset;
3055 void BufferView::draw(frontend::Painter & pain, bool paint_caret)
3057 if (height_ == 0 || width_ == 0)
3059 LYXERR(Debug::PAINTING, "\t\t*** START DRAWING ***");
3061 Text & text = buffer_.text();
3062 TextMetrics const & tm = d->text_metrics_[&text];
3063 int const y = tm.first().second->position();
3064 PainterInfo pi(this, pain);
3066 /** A repaint of the previous caret row is needed if there is
3067 * caret painted on screen and either
3068 * 1/ a new caret has to be painted at a place different from
3070 * 2/ there is no need for a caret anymore.
3072 d->repaint_caret_row_ = !d->caret_slice_.empty() &&
3073 ((paint_caret && d->cursor_.top() != d->caret_slice_)
3076 // Check whether the row where the cursor lives needs to be scrolled.
3077 // Update the drawing strategy if needed.
3078 checkCursorScrollOffset();
3080 switch (d->update_strategy_) {
3082 case NoScreenUpdate:
3083 // no screen painting is actually needed. In nodraw stage
3084 // however, the different coordinates of insets and paragraphs
3085 // needs to be updated.
3086 LYXERR(Debug::PAINTING, "Strategy: NoScreenUpdate");
3087 pi.full_repaint = false;
3088 if (pain.isNull()) {
3089 pi.full_repaint = true;
3091 } else if (d->repaint_caret_row_) {
3092 pi.full_repaint = false;
3097 case SingleParUpdate:
3098 pi.full_repaint = false;
3099 LYXERR(Debug::PAINTING, "Strategy: SingleParUpdate");
3100 // In general, only the current row of the outermost paragraph
3101 // will be redrawn. Particular cases where selection spans
3102 // multiple paragraph are correctly detected in TextMetrics.
3106 case DecorationUpdate:
3107 // FIXME: We should also distinguish DecorationUpdate to avoid text
3108 // drawing if possible. This is not possible to do easily right now
3109 // because of the single backing pixmap.
3111 case FullScreenUpdate:
3113 LYXERR(Debug::PAINTING,
3114 ((d->update_strategy_ == FullScreenUpdate)
3115 ? "Strategy: FullScreenUpdate"
3116 : "Strategy: DecorationUpdate"));
3118 // The whole screen, including insets, will be refreshed.
3119 pi.full_repaint = true;
3121 // Clear background.
3122 pain.fillRectangle(0, 0, width_, height_,
3123 pi.backgroundColor(&buffer_.inset()));
3128 // and possibly grey out below
3129 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3130 int const y2 = lastpm.second->position() + lastpm.second->descent();
3133 Color color = buffer().isInternal()
3134 ? Color_background : Color_bottomarea;
3135 pain.fillRectangle(0, y2, width_, height_ - y2, color);
3139 LYXERR(Debug::PAINTING, "\n\t\t*** END DRAWING ***");
3141 // The scrollbar needs an update.
3144 // Normalize anchor for next time
3145 pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
3146 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3147 for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
3148 ParagraphMetrics const & pm = tm.parMetrics(pit);
3149 if (pm.position() + pm.descent() > 0) {
3150 d->anchor_pit_ = pit;
3151 d->anchor_ypos_ = pm.position();
3155 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
3156 << " anchor ypos = " << d->anchor_ypos_);
3158 if (!pain.isNull()) {
3159 // reset the update flags, everything has been done
3160 d->update_flags_ = Update::None;
3163 // Remember what has just been done for the next draw() step
3165 d->caret_slice_ = d->cursor_.top();
3167 d->caret_slice_ = CursorSlice();
3171 void BufferView::message(docstring const & msg)
3174 d->gui_->message(msg);
3178 void BufferView::showDialog(string const & name)
3181 d->gui_->showDialog(name, string());
3185 void BufferView::showDialog(string const & name,
3186 string const & data, Inset * inset)
3189 d->gui_->showDialog(name, data, inset);
3193 void BufferView::updateDialog(string const & name, string const & data)
3196 d->gui_->updateDialog(name, data);
3200 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
3206 // FIXME: Move this out of BufferView again
3207 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
3209 if (!fname.isReadableFile()) {
3210 docstring const error = from_ascii(strerror(errno));
3211 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3212 docstring const text =
3213 bformat(_("Could not read the specified document\n"
3214 "%1$s\ndue to the error: %2$s"), file, error);
3215 Alert::error(_("Could not read file"), text);
3219 if (!fname.isReadableFile()) {
3220 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3221 docstring const text =
3222 bformat(_("%1$s\n is not readable."), file);
3223 Alert::error(_("Could not open file"), text);
3227 // FIXME UNICODE: We don't know the encoding of the file
3228 docstring file_content = fname.fileContents("UTF-8");
3229 if (file_content.empty()) {
3230 Alert::error(_("Reading not UTF-8 encoded file"),
3231 _("The file is not UTF-8 encoded.\n"
3232 "It will be read as local 8Bit-encoded.\n"
3233 "If this does not give the correct result\n"
3234 "then please change the encoding of the file\n"
3235 "to UTF-8 with a program other than LyX.\n"));
3236 file_content = fname.fileContents("local8bit");
3239 return normalize_c(file_content);
3243 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
3245 docstring const tmpstr = contentsOfPlaintextFile(f);
3250 Cursor & cur = cursor();
3251 cap::replaceSelection(cur);
3252 buffer_.undo().recordUndo(cur);
3254 cur.innerText()->insertStringAsParagraphs(cur, tmpstr, cur.current_font);
3256 cur.innerText()->insertStringAsLines(cur, tmpstr, cur.current_font);
3258 buffer_.changed(true);
3262 docstring const & BufferView::inlineCompletion() const
3264 return d->inlineCompletion_;
3268 size_t const & BufferView::inlineCompletionUniqueChars() const
3270 return d->inlineCompletionUniqueChars_;
3274 DocIterator const & BufferView::inlineCompletionPos() const
3276 return d->inlineCompletionPos_;
3280 void BufferView::resetInlineCompletionPos()
3282 d->inlineCompletionPos_ = DocIterator();
3286 bool samePar(DocIterator const & a, DocIterator const & b)
3288 if (a.empty() && b.empty())
3290 if (a.empty() || b.empty())
3292 if (a.depth() != b.depth())
3294 return &a.innerParagraph() == &b.innerParagraph();
3298 void BufferView::setInlineCompletion(Cursor const & cur, DocIterator const & pos,
3299 docstring const & completion, size_t uniqueChars)
3301 uniqueChars = min(completion.size(), uniqueChars);
3302 bool changed = d->inlineCompletion_ != completion
3303 || d->inlineCompletionUniqueChars_ != uniqueChars;
3304 bool singlePar = true;
3305 d->inlineCompletion_ = completion;
3306 d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
3308 //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
3311 DocIterator const & old = d->inlineCompletionPos_;
3313 //lyxerr << "inlineCompletionPos changed" << std::endl;
3314 // old or pos are in another paragraph?
3315 if ((!samePar(cur, pos) && !pos.empty())
3316 || (!samePar(cur, old) && !old.empty())) {
3318 //lyxerr << "different paragraph" << std::endl;
3320 d->inlineCompletionPos_ = pos;
3325 if (singlePar && !(cur.result().screenUpdate() & Update::Force))
3326 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
3328 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::Force);
3333 bool BufferView::clickableInset() const
3335 return d->clickable_inset_;