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/lyxlib.h"
86 #include "support/Package.h"
87 #include "support/types.h"
97 using namespace lyx::support;
101 namespace Alert = frontend::Alert;
105 /// Return an inset of this class if it exists at the current cursor position
107 T * getInsetByCode(Cursor const & cur, InsetCode code)
109 DocIterator it = cur;
110 Inset * inset = it.nextInset();
111 if (inset && inset->lyxCode() == code)
112 return static_cast<T*>(inset);
117 /// Note that comparing contents can only be used for InsetCommand
118 bool findNextInset(DocIterator & dit, vector<InsetCode> const & codes,
119 docstring const & contents)
121 DocIterator tmpdit = dit;
124 Inset const * inset = tmpdit.nextInset();
126 bool const valid_code = std::find(codes.begin(), codes.end(),
127 inset->lyxCode()) != codes.end();
128 InsetCommand const * ic = inset->asInsetCommand();
129 bool const same_or_no_contents = contents.empty()
130 || (ic && (ic->getFirstNonOptParam() == contents));
132 if (valid_code && same_or_no_contents) {
137 tmpdit.forwardInset();
144 /// Looks for next inset with one of the given codes.
145 /// Note that same_content can only be used for InsetCommand
146 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
150 DocIterator tmpdit = dit;
151 tmpdit.forwardInset();
155 Inset const * inset = tmpdit.nextInset();
156 if (same_content && inset) {
157 InsetCommand const * ic = inset->asInsetCommand();
159 bool const valid_code = std::find(codes.begin(), codes.end(),
160 ic->lyxCode()) != codes.end();
162 contents = ic->getFirstNonOptParam();
166 if (!findNextInset(tmpdit, codes, contents)) {
167 if (dit.depth() != 1 || dit.pit() != 0 || dit.pos() != 0) {
168 inset = &tmpdit.bottom().inset();
169 tmpdit = doc_iterator_begin(&inset->buffer(), inset);
170 if (!findNextInset(tmpdit, codes, contents))
182 /// Looks for next inset with the given code
183 void findInset(DocIterator & dit, InsetCode code, bool same_content)
185 findInset(dit, vector<InsetCode>(1, code), same_content);
189 /// Moves cursor to the next inset with one of the given codes.
190 void gotoInset(BufferView * bv, vector<InsetCode> const & codes,
193 Cursor tmpcur = bv->cursor();
194 if (!findInset(tmpcur, codes, same_content)) {
195 bv->cursor().message(_("No more insets"));
199 tmpcur.clearSelection();
200 bv->setCursor(tmpcur);
205 /// Moves cursor to the next inset with given code.
206 void gotoInset(BufferView * bv, InsetCode code, bool same_content)
208 gotoInset(bv, vector<InsetCode>(1, code), same_content);
212 /// A map from a Text to the associated text metrics
213 typedef map<Text const *, TextMetrics> TextMetricsCache;
215 enum ScreenUpdateStrategy {
225 /////////////////////////////////////////////////////////////////////
229 /////////////////////////////////////////////////////////////////////
231 struct BufferView::Private
233 Private(BufferView & bv) : 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)
243 xsel_cache_.set = false;
247 ScrollbarParameters scrollbarParameters_;
249 ScreenUpdateStrategy update_strategy_;
251 Update::flags update_flags_;
253 CoordCache coord_cache_;
255 /// Estimated average par height for scrollbar.
257 /// this is used to handle XSelection events in the right manner.
266 pit_type anchor_pit_;
270 vector<int> par_height_;
273 DocIterator inlineCompletionPos_;
275 docstring inlineCompletion_;
277 size_t inlineCompletionUniqueChars_;
279 /// keyboard mapping object.
282 /// last visited inset.
283 /** kept to send setMouseHover(false).
284 * Not owned, so don't delete.
286 Inset const * last_inset_;
287 /// are we hovering something that we can click
288 bool clickable_inset_;
290 /// position of the mouse at the time of the last mouse move
291 /// This is used to update the hovering status of inset in
292 /// cases where the buffer is scrolled, but the mouse didn't move.
293 Point mouse_position_cache_;
295 // cache for id of the paragraph which was edited the last time
296 int bookmark_edit_position_;
298 mutable TextMetricsCache text_metrics_;
301 /** Not owned, so don't delete.
303 frontend::GuiBufferViewDelegate * gui_;
305 /// Cache for Find Next
306 FuncRequest search_request_cache_;
309 map<string, Inset *> edited_insets_;
311 /// When the row where the cursor lies is scrolled, this
312 /// contains the scroll offset
313 int horiz_scroll_offset_;
314 /// a slice pointing to the start of the row where the cursor
315 /// is (at last draw time)
316 CursorSlice current_row_slice_;
317 /// a slice pointing to the start of the row where cursor was
318 /// at previous draw event
319 CursorSlice last_row_slice_;
323 BufferView::BufferView(Buffer & buf)
324 : width_(0), height_(0), full_screen_(false), buffer_(buf),
325 d(new Private(*this))
327 d->xsel_cache_.set = false;
328 d->intl_.initKeyMapper(lyxrc.use_kbmap);
330 d->cursor_.setBuffer(&buf);
331 d->cursor_.push(buffer_.inset());
332 d->cursor_.resetAnchor();
333 d->cursor_.setCurrentFont();
335 buffer_.updatePreviews();
339 BufferView::~BufferView()
341 // current buffer is going to be switched-off, save cursor pos
342 // Ideally, the whole cursor stack should be saved, but session
343 // currently can only handle bottom (whole document) level pit and pos.
344 // That is to say, if a cursor is in a nested inset, it will be
345 // restore to the left of the top level inset.
346 LastFilePosSection::FilePos fp;
347 fp.pit = d->cursor_.bottom().pit();
348 fp.pos = d->cursor_.bottom().pos();
349 theSession().lastFilePos().save(buffer_.fileName(), fp);
352 d->last_inset_->setMouseHover(this, false);
358 int BufferView::rightMargin() const
360 // The value used to be hardcoded to 10
361 int const default_margin = zoomedPixels(10);
362 // The additional test for the case the outliner is opened.
363 if (!full_screen_ || !lyxrc.full_screen_limit
364 || width_ < lyxrc.full_screen_width + 2 * default_margin)
365 return default_margin;
367 return (width_ - lyxrc.full_screen_width) / 2;
371 int BufferView::leftMargin() const
373 return rightMargin();
377 int BufferView::inPixels(Length const & len) const
379 Font const font = buffer().params().getFont();
380 return len.inPixels(workWidth(), theFontMetrics(font).em());
384 int BufferView::zoomedPixels(int pix) const
386 // FIXME: the dpi setting should really depend on the BufferView
387 // (think different monitors).
389 // Zoom factor specified by user in percent
390 double const zoom = lyxrc.currentZoom / 100.0; // [percent]
392 // DPI setting for monitor relative to 100dpi
393 double const dpizoom = lyxrc.dpi / 100.0; // [per 100dpi]
395 return support::iround(pix * zoom * dpizoom);
399 bool BufferView::isTopScreen() const
401 return 0 == d->scrollbarParameters_.min;
405 bool BufferView::isBottomScreen() const
407 return 0 == d->scrollbarParameters_.max;
411 Intl & BufferView::getIntl()
417 Intl const & BufferView::getIntl() const
423 CoordCache & BufferView::coordCache()
425 return d->coord_cache_;
429 CoordCache const & BufferView::coordCache() const
431 return d->coord_cache_;
435 Buffer & BufferView::buffer()
441 Buffer const & BufferView::buffer() const
447 bool BufferView::needsFitCursor() const
449 if (cursorStatus(d->cursor_) == CUR_INSIDE) {
450 frontend::FontMetrics const & fm =
451 theFontMetrics(d->cursor_.getFont().fontInfo());
452 int const asc = fm.maxAscent();
453 int const des = fm.maxDescent();
454 Point const p = getPos(d->cursor_);
455 if (p.y_ - asc >= 0 && p.y_ + des < height_)
464 // this is for debugging only.
465 string flagsAsString(Update::flags flags)
467 if (flags == Update::None)
469 return string((flags & Update::FitCursor) ? "FitCursor " : "")
470 + ((flags & Update::Force) ? "Force " : "")
471 + ((flags & Update::ForceDraw) ? "ForceDraw " : "")
472 + ((flags & Update::SinglePar) ? "SinglePar " : "");
477 void BufferView::processUpdateFlags(Update::flags flags)
479 LYXERR(Debug::PAINTING, "BufferView::processUpdateFlags( "
480 << flagsAsString(flags) << ") buffer: " << &buffer_);
482 // Case when no explicit update is requested.
483 if (flags == Update::None)
486 // SinglePar is ignored for now (this should probably change). We
487 // set it ourselves below, at the price of always rebreaking the
488 // paragraph at cursor. This can be expensive for large tables.
489 flags = flags & ~Update::SinglePar;
491 // First check whether the metrics and inset positions should be updated
492 if (flags & Update::Force) {
493 // This will update the CoordCache items and replace Force
494 // with ForceDraw in flags.
495 updateMetrics(flags);
498 // Then make sure that the screen contains the cursor if needed
499 if (flags & Update::FitCursor) {
500 if (needsFitCursor()) {
501 scrollToCursor(d->cursor_, false);
502 // Metrics have to be recomputed (maybe again)
503 updateMetrics(flags);
505 flags = flags & ~Update::FitCursor;
508 // Finally detect whether we can only repaint a single paragraph
509 if (!(flags & Update::ForceDraw)) {
510 if (singleParUpdate())
511 flags = flags | Update::SinglePar;
513 updateMetrics(flags);
516 // Add flags to the the update flags. These will be reset to None
517 // after the redraw is actually done
518 d->update_flags_ = d->update_flags_ | flags;
519 LYXERR(Debug::PAINTING, "Cumulative flags: " << flagsAsString(flags));
521 // Now compute the update strategy
522 // Possibly values in flag are None, Decoration, ForceDraw
523 LATTEST((d->update_flags_ & ~(Update::None | Update::SinglePar
524 | Update::Decoration | Update::ForceDraw)) == 0);
526 if (d->update_flags_ & Update::ForceDraw)
527 d->update_strategy_ = FullScreenUpdate;
528 else if (d->update_flags_ & Update::Decoration)
529 d->update_strategy_ = DecorationUpdate;
530 else if (d->update_flags_ & Update::SinglePar)
531 d->update_strategy_ = SingleParUpdate;
533 // no need to redraw anything.
534 d->update_strategy_ = NoScreenUpdate;
537 updateHoveredInset();
540 buffer_.changed(false);
544 void BufferView::updateScrollbar()
546 if (height_ == 0 && width_ == 0)
549 // We prefer fixed size line scrolling.
550 d->scrollbarParameters_.single_step = defaultRowHeight();
551 // We prefer full screen page scrolling.
552 d->scrollbarParameters_.page_step = height_;
554 Text & t = buffer_.text();
555 TextMetrics & tm = d->text_metrics_[&t];
557 LYXERR(Debug::GUI, " Updating scrollbar: height: "
558 << t.paragraphs().size()
559 << " curr par: " << d->cursor_.bottom().pit()
560 << " default height " << defaultRowHeight());
562 size_t const parsize = t.paragraphs().size();
563 if (d->par_height_.size() != parsize) {
564 d->par_height_.clear();
565 // FIXME: We assume a default paragraph height of 2 rows. This
566 // should probably be pondered with the screen width.
567 d->par_height_.resize(parsize, defaultRowHeight() * 2);
570 // Look at paragraph heights on-screen
571 pair<pit_type, ParagraphMetrics const *> first = tm.first();
572 pair<pit_type, ParagraphMetrics const *> last = tm.last();
573 for (pit_type pit = first.first; pit <= last.first; ++pit) {
574 d->par_height_[pit] = tm.parMetrics(pit).height();
575 LYXERR(Debug::SCROLLING, "storing height for pit " << pit << " : "
576 << d->par_height_[pit]);
579 int top_pos = first.second->position() - first.second->ascent();
580 int bottom_pos = last.second->position() + last.second->descent();
581 bool first_visible = first.first == 0 && top_pos >= 0;
582 bool last_visible = last.first + 1 == int(parsize) && bottom_pos <= height_;
583 if (first_visible && last_visible) {
584 d->scrollbarParameters_.min = 0;
585 d->scrollbarParameters_.max = 0;
589 d->scrollbarParameters_.min = top_pos;
590 for (size_t i = 0; i != size_t(first.first); ++i)
591 d->scrollbarParameters_.min -= d->par_height_[i];
592 d->scrollbarParameters_.max = bottom_pos;
593 for (size_t i = last.first + 1; i != parsize; ++i)
594 d->scrollbarParameters_.max += d->par_height_[i];
596 // The reference is the top position so we remove one page.
597 if (lyxrc.scroll_below_document)
598 d->scrollbarParameters_.max -= minVisiblePart();
600 d->scrollbarParameters_.max -= d->scrollbarParameters_.page_step;
602 // 0 must be inside the range as it denotes the current position
603 if (d->scrollbarParameters_.max < 0)
604 d->scrollbarParameters_.max = 0;
605 if (d->scrollbarParameters_.min > 0)
606 d->scrollbarParameters_.min = 0;
610 ScrollbarParameters const & BufferView::scrollbarParameters() const
612 return d->scrollbarParameters_;
616 docstring BufferView::toolTip(int x, int y) const
618 // Get inset under mouse, if there is one.
619 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
621 // No inset, no tooltip...
623 return covering_inset->toolTip(*this, x, y);
627 string BufferView::contextMenu(int x, int y) const
629 //If there is a selection, return the containing inset menu
630 if (d->cursor_.selection())
631 return d->cursor_.inset().contextMenu(*this, x, y);
633 // Get inset under mouse, if there is one.
634 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
636 return covering_inset->contextMenu(*this, x, y);
638 return buffer_.inset().contextMenu(*this, x, y);
643 void BufferView::scrollDocView(int const value, bool update)
645 // The scrollbar values are relative to the top of the screen, therefore the
646 // offset is equal to the target value.
648 // No scrolling at all? No need to redraw anything
652 // If the offset is less than 2 screen height, prefer to scroll instead.
653 if (abs(value) <= 2 * height_) {
654 d->anchor_ypos_ -= value;
655 processUpdateFlags(Update::Force);
659 // cut off at the top
660 if (value <= d->scrollbarParameters_.min) {
661 DocIterator dit = doc_iterator_begin(&buffer_);
662 showCursor(dit, false, update);
663 LYXERR(Debug::SCROLLING, "scroll to top");
667 // cut off at the bottom
668 if (value >= d->scrollbarParameters_.max) {
669 DocIterator dit = doc_iterator_end(&buffer_);
671 showCursor(dit, false, update);
672 LYXERR(Debug::SCROLLING, "scroll to bottom");
676 // find paragraph at target position
677 int par_pos = d->scrollbarParameters_.min;
679 for (; i != int(d->par_height_.size()); ++i) {
680 par_pos += d->par_height_[i];
681 if (par_pos >= value)
685 if (par_pos < value) {
686 // It seems we didn't find the correct pit so stay on the safe side and
688 LYXERR0("scrolling position not found!");
689 scrollDocView(d->scrollbarParameters_.max, update);
693 DocIterator dit = doc_iterator_begin(&buffer_);
695 LYXERR(Debug::SCROLLING, "value = " << value << " -> scroll to pit " << i);
696 showCursor(dit, false, update);
700 // FIXME: this method is not working well.
701 void BufferView::setCursorFromScrollbar()
703 TextMetrics & tm = d->text_metrics_[&buffer_.text()];
705 int const height = 2 * defaultRowHeight();
706 int const first = height;
707 int const last = height_ - height;
709 Cursor const & oldcur = d->cursor_;
711 switch (cursorStatus(oldcur)) {
719 int const y = getPos(oldcur).y_;
720 newy = min(last, max(y, first));
724 // We reset the cursor because cursorStatus() does not
725 // work when the cursor is within mathed.
728 tm.setCursorFromCoordinates(cur, 0, newy);
730 // update the bufferview cursor and notify insets
731 // FIXME: Care about the d->cursor_ flags to redraw if needed
732 Cursor old = d->cursor_;
734 // the DEPM call in mouseSetCursor() might have destroyed the
735 // paragraph the cursor is in.
736 bool badcursor = old.fixIfBroken();
737 badcursor |= notifyCursorLeavesOrEnters(old, d->cursor_);
739 d->cursor_.fixIfBroken();
743 Change const BufferView::getCurrentChange() const
745 if (!d->cursor_.selection())
746 return Change(Change::UNCHANGED);
748 DocIterator dit = d->cursor_.selectionBegin();
749 // The selected content might have been changed (see #7685)
750 dit = dit.getInnerText();
751 return dit.paragraph().lookupChange(dit.pos());
755 // this could be used elsewhere as well?
756 // FIXME: This does not work within mathed!
757 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
759 Point const p = getPos(dit);
762 if (p.y_ > workHeight())
768 void BufferView::bookmarkEditPosition()
770 // Don't eat cpu time for each keystroke
771 if (d->cursor_.paragraph().id() == d->bookmark_edit_position_)
774 d->bookmark_edit_position_ = d->cursor_.paragraph().id();
778 void BufferView::saveBookmark(unsigned int idx)
780 // tentatively save bookmark, id and pos will be used to
781 // acturately locate a bookmark in a 'live' lyx session.
782 // pit and pos will be updated with bottom level pit/pos
784 if (!buffer_.isInternal()) {
785 theSession().bookmarks().save(
787 d->cursor_.bottom().pit(),
788 d->cursor_.bottom().pos(),
789 d->cursor_.paragraph().id(),
794 // emit message signal.
795 message(_("Save bookmark"));
800 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
801 int top_id, pos_type top_pos)
803 bool success = false;
806 d->cursor_.clearSelection();
808 // if a valid par_id is given, try it first
809 // This is the case for a 'live' bookmark when unique paragraph ID
810 // is used to track bookmarks.
812 dit = buffer_.getParFromID(top_id);
814 dit.pos() = min(dit.paragraph().size(), top_pos);
815 // Some slices of the iterator may not be
816 // reachable (e.g. closed collapsible inset)
817 // so the dociterator may need to be
818 // shortened. Otherwise, setCursor may crash
819 // lyx when the cursor can not be set to these
821 size_t const n = dit.depth();
822 for (size_t i = 0; i < n; ++i)
823 if (!dit[i].inset().editable()) {
831 // if top_id == 0, or searching through top_id failed
832 // This is the case for a 'restored' bookmark when only bottom
833 // (document level) pit was saved. Because of this, bookmark
834 // restoration is inaccurate. If a bookmark was within an inset,
835 // it will be restored to the left of the outmost inset that contains
837 if (bottom_pit < int(buffer_.paragraphs().size())) {
838 dit = doc_iterator_begin(&buffer_);
840 dit.pit() = bottom_pit;
841 dit.pos() = min(bottom_pos, dit.paragraph().size());
846 // Note: only bottom (document) level pit is set.
848 // set the current font.
849 d->cursor_.setCurrentFont();
850 // Do not forget to reset the anchor (see #9912)
851 d->cursor_.resetAnchor();
852 processUpdateFlags(Update::FitCursor);
859 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
861 if (d->cursor_.real_current_font.isRightToLeft()) {
862 if (d->intl_.keymap == Intl::PRIMARY)
863 d->intl_.keyMapSec();
865 if (d->intl_.keymap == Intl::SECONDARY)
866 d->intl_.keyMapPrim();
869 d->intl_.getTransManager().translateAndInsert(c, t, cur);
873 int BufferView::workWidth() const
879 void BufferView::recenter()
881 showCursor(d->cursor_, true, true);
885 void BufferView::showCursor()
887 showCursor(d->cursor_, false, true);
891 void BufferView::showCursor(DocIterator const & dit,
892 bool recenter, bool update)
894 if (scrollToCursor(dit, recenter) && update)
895 processUpdateFlags(Update::Force);
899 void BufferView::scrollToCursor()
901 if (scrollToCursor(d->cursor_, false))
902 processUpdateFlags(Update::Force);
906 bool BufferView::scrollToCursor(DocIterator const & dit, bool const recenter)
908 // We are not properly started yet, delay until resizing is
913 LYXERR(Debug::SCROLLING, "recentering!");
915 CursorSlice const & bot = dit.bottom();
916 TextMetrics & tm = d->text_metrics_[bot.text()];
918 pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
919 int bot_pit = bot.pit();
920 if (bot_pit > max_pit) {
921 // FIXME: Why does this happen?
922 LYXERR0("bottom pit is greater that max pit: "
923 << bot_pit << " > " << max_pit);
927 if (bot_pit == tm.first().first - 1)
928 tm.newParMetricsUp();
929 else if (bot_pit == tm.last().first + 1)
930 tm.newParMetricsDown();
932 if (tm.contains(bot_pit)) {
933 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
934 LBUFERR(!pm.rows().empty());
935 // FIXME: smooth scrolling doesn't work in mathed.
936 CursorSlice const & cs = dit.innerTextSlice();
937 int offset = coordOffset(dit).y_;
938 int ypos = pm.position() + offset;
939 Dimension const & row_dim =
940 pm.getRow(cs.pos(), dit.boundary()).dimension();
943 scrolled = scroll(ypos - height_/2);
945 // We try to visualize the whole row, if the row height is larger than
946 // the screen height, we scroll to a heuristic value of height_ / 4.
947 // FIXME: This heuristic value should be replaced by a recursive search
948 // for a row in the inset that can be visualized completely.
949 else if (row_dim.height() > height_) {
950 if (ypos < defaultRowHeight())
951 scrolled = scroll(ypos - height_ / 4);
952 else if (ypos > height_ - defaultRowHeight())
953 scrolled = scroll(ypos - 3 * height_ / 4);
956 // If the top part of the row falls of the screen, we scroll
957 // up to align the top of the row with the top of the screen.
958 else if (ypos - row_dim.ascent() < 0 && ypos < height_) {
959 int ynew = row_dim.ascent();
960 scrolled = scrollUp(ynew - ypos);
963 // If the bottom of the row falls of the screen, we scroll down.
964 else if (ypos + row_dim.descent() > height_ && ypos > 0) {
965 int ynew = height_ - row_dim.descent();
966 scrolled = scrollDown(ypos - ynew);
969 // else, nothing to do, the cursor is already visible so we just return.
970 return scrolled != 0;
973 // fix inline completion position
974 if (d->inlineCompletionPos_.fixIfBroken())
975 d->inlineCompletionPos_ = DocIterator();
977 tm.redoParagraph(bot_pit);
978 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
979 int offset = coordOffset(dit).y_;
981 d->anchor_pit_ = bot_pit;
982 CursorSlice const & cs = dit.innerTextSlice();
983 Dimension const & row_dim =
984 pm.getRow(cs.pos(), dit.boundary()).dimension();
987 d->anchor_ypos_ = height_/2;
988 else if (d->anchor_pit_ == 0)
989 d->anchor_ypos_ = offset + pm.ascent();
990 else if (d->anchor_pit_ == max_pit)
991 d->anchor_ypos_ = height_ - offset - row_dim.descent();
992 else if (offset > height_)
993 d->anchor_ypos_ = height_ - offset - defaultRowHeight();
995 d->anchor_ypos_ = defaultRowHeight() * 2;
1001 void BufferView::makeDocumentClass()
1003 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1004 buffer_.params().makeDocumentClass();
1005 updateDocumentClass(olddc);
1009 void BufferView::updateDocumentClass(DocumentClassConstPtr olddc)
1011 message(_("Converting document to new document class..."));
1013 StableDocIterator backcur(d->cursor_);
1014 ErrorList & el = buffer_.errorList("Class Switch");
1015 cap::switchBetweenClasses(
1016 olddc, buffer_.params().documentClassPtr(),
1017 static_cast<InsetText &>(buffer_.inset()), el);
1019 setCursor(backcur.asDocIterator(&buffer_));
1021 buffer_.errors("Class Switch");
1025 /** Return the change status at cursor position, taking into account the
1026 * status at each level of the document iterator (a table in a deleted
1027 * footnote is deleted).
1028 * When \param outer is true, the top slice is not looked at.
1030 static Change::Type lookupChangeType(DocIterator const & dit, bool outer = false)
1032 size_t const depth = dit.depth() - (outer ? 1 : 0);
1034 for (size_t i = 0 ; i < depth ; ++i) {
1035 CursorSlice const & slice = dit[i];
1036 if (!slice.inset().inMathed()
1037 && slice.pos() < slice.paragraph().size()) {
1038 Change::Type const ch = slice.paragraph().lookupChange(slice.pos()).type;
1039 if (ch != Change::UNCHANGED)
1043 return Change::UNCHANGED;
1047 bool BufferView::getStatus(FuncRequest const & cmd, FuncStatus & flag)
1049 FuncCode const act = cmd.action();
1051 // Can we use a readonly buffer?
1052 if (buffer_.isReadonly()
1053 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1054 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1055 if (buffer_.hasReadonlyFlag())
1056 flag.message(from_utf8(N_("Document is read-only")));
1058 flag.message(from_utf8(N_("Document has been modified externally")));
1059 flag.setEnabled(false);
1063 // Are we in a DELETED change-tracking region?
1064 if (lookupChangeType(d->cursor_, true) == Change::DELETED
1065 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1066 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1067 flag.message(from_utf8(N_("This portion of the document is deleted.")));
1068 flag.setEnabled(false);
1072 Cursor & cur = d->cursor_;
1074 if (cur.getStatus(cmd, flag))
1079 // FIXME: This is a bit problematic because we don't check if this is
1080 // a document BufferView or not for these LFUNs. We probably have to
1081 // dispatch both to currentBufferView() and, if that fails,
1082 // to documentBufferView(); same as we do now for current Buffer and
1083 // document Buffer. Ideally those LFUN should go to Buffer as they
1084 // operate on the full Buffer and the cursor is only needed either for
1085 // an Undo record or to restore a cursor position. But we don't know
1086 // how to do that inside Buffer of course.
1087 case LFUN_BUFFER_PARAMS_APPLY:
1088 case LFUN_LAYOUT_MODULES_CLEAR:
1089 case LFUN_LAYOUT_MODULE_ADD:
1090 case LFUN_LAYOUT_RELOAD:
1091 case LFUN_TEXTCLASS_APPLY:
1092 case LFUN_TEXTCLASS_LOAD:
1093 flag.setEnabled(!buffer_.isReadonly());
1097 // We do not use the LyXAction flag for readonly because Undo sets the
1098 // buffer clean/dirty status by itself.
1099 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasUndoStack());
1102 // We do not use the LyXAction flag for readonly because Redo sets the
1103 // buffer clean/dirty status by itself.
1104 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasRedoStack());
1106 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
1107 case LFUN_FILE_INSERT_PLAINTEXT: {
1108 docstring const fname = cmd.argument();
1109 if (!FileName::isAbsolute(to_utf8(fname))) {
1110 flag.message(_("Absolute filename expected."));
1113 flag.setEnabled(cur.inTexted());
1116 case LFUN_FILE_INSERT:
1117 case LFUN_BOOKMARK_SAVE:
1118 // FIXME: Actually, these LFUNS should be moved to Text
1119 flag.setEnabled(cur.inTexted());
1122 case LFUN_FONT_STATE:
1123 case LFUN_LABEL_INSERT:
1124 case LFUN_INFO_INSERT:
1125 case LFUN_PARAGRAPH_GOTO:
1126 case LFUN_NOTE_NEXT:
1127 case LFUN_REFERENCE_NEXT:
1128 case LFUN_WORD_FIND:
1129 case LFUN_WORD_FIND_FORWARD:
1130 case LFUN_WORD_FIND_BACKWARD:
1131 case LFUN_WORD_REPLACE:
1134 case LFUN_MARK_TOGGLE:
1135 case LFUN_SCREEN_RECENTER:
1136 case LFUN_SCREEN_SHOW_CURSOR:
1137 case LFUN_BIBTEX_DATABASE_ADD:
1138 case LFUN_BIBTEX_DATABASE_DEL:
1139 case LFUN_STATISTICS:
1140 case LFUN_KEYMAP_OFF:
1141 case LFUN_KEYMAP_PRIMARY:
1142 case LFUN_KEYMAP_SECONDARY:
1143 case LFUN_KEYMAP_TOGGLE:
1144 case LFUN_INSET_SELECT_ALL:
1145 flag.setEnabled(true);
1148 case LFUN_GRAPHICS_UNIFY:
1149 flag.setEnabled(cur.selection());
1152 case LFUN_WORD_FINDADV: {
1153 FindAndReplaceOptions opt;
1154 istringstream iss(to_utf8(cmd.argument()));
1156 flag.setEnabled(opt.repl_buf_name.empty()
1157 || !buffer_.isReadonly());
1161 case LFUN_LABEL_GOTO:
1162 flag.setEnabled(!cmd.argument().empty()
1163 || getInsetByCode<InsetRef>(cur, REF_CODE));
1166 case LFUN_CHANGES_MERGE:
1167 case LFUN_CHANGE_NEXT:
1168 case LFUN_CHANGE_PREVIOUS:
1169 case LFUN_ALL_CHANGES_ACCEPT:
1170 case LFUN_ALL_CHANGES_REJECT:
1171 flag.setEnabled(buffer_.areChangesPresent());
1174 case LFUN_SCREEN_UP:
1175 case LFUN_SCREEN_DOWN:
1177 case LFUN_SCREEN_UP_SELECT:
1178 case LFUN_SCREEN_DOWN_SELECT:
1179 case LFUN_INSET_FORALL:
1180 flag.setEnabled(true);
1183 case LFUN_LAYOUT_TABULAR:
1184 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
1188 flag.setEnabled(!cur.inset().forcePlainLayout(cur.idx()));
1191 case LFUN_LAYOUT_PARAGRAPH:
1192 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
1195 case LFUN_BRANCH_ADD_INSERT:
1196 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1199 case LFUN_DIALOG_SHOW_NEW_INSET:
1200 // FIXME: this is wrong, but I do not understand the
1202 if (cur.inset().lyxCode() == CAPTION_CODE)
1203 return cur.inset().getStatus(cur, cmd, flag);
1204 // FIXME we should consider passthru paragraphs too.
1205 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1208 case LFUN_CITATION_INSERT: {
1209 FuncRequest fr(LFUN_INSET_INSERT, "citation");
1210 // FIXME: This could turn in a recursive hell.
1211 // Shouldn't we use Buffer::getStatus() instead?
1212 flag.setEnabled(lyx::getStatus(fr).enabled());
1215 case LFUN_INSET_APPLY: {
1216 string const name = cmd.getArg(0);
1217 Inset * inset = editedInset(name);
1219 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1220 if (!inset->getStatus(cur, fr, flag)) {
1221 // Every inset is supposed to handle this
1222 LASSERT(false, break);
1225 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1226 flag = lyx::getStatus(fr);
1239 Inset * BufferView::editedInset(string const & name) const
1241 map<string, Inset *>::const_iterator it = d->edited_insets_.find(name);
1242 return it == d->edited_insets_.end() ? 0 : it->second;
1246 void BufferView::editInset(string const & name, Inset * inset)
1248 d->edited_insets_[name] = inset;
1252 void BufferView::dispatch(FuncRequest const & cmd, DispatchResult & dr)
1254 LYXERR(Debug::ACTION, "BufferView::dispatch: cmd: " << cmd);
1256 string const argument = to_utf8(cmd.argument());
1257 Cursor & cur = d->cursor_;
1260 // Don't dispatch function that does not apply to internal buffers.
1261 if (buffer_.isInternal()
1262 && lyxaction.funcHasFlag(cmd.action(), LyXAction::NoInternal))
1265 // We'll set this back to false if need be.
1266 bool dispatched = true;
1267 buffer_.undo().beginUndoGroup();
1269 FuncCode const act = cmd.action();
1272 case LFUN_BUFFER_PARAMS_APPLY: {
1273 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1274 cur.recordUndoBufferParams();
1275 istringstream ss(to_utf8(cmd.argument()));
1278 int const unknown_tokens = buffer_.readHeader(lex);
1279 if (unknown_tokens != 0) {
1280 LYXERR0("Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1281 << unknown_tokens << " unknown token"
1282 << (unknown_tokens == 1 ? "" : "s"));
1284 updateDocumentClass(olddc);
1286 // We are most certainly here because of a change in the document
1287 // It is then better to make sure that all dialogs are in sync with
1288 // current document settings.
1289 dr.screenUpdate(Update::Force | Update::FitCursor);
1290 dr.forceBufferUpdate();
1294 case LFUN_LAYOUT_MODULES_CLEAR: {
1295 // FIXME: this modifies the document in cap::switchBetweenClasses
1296 // without calling recordUndo. Fix this before using
1297 // recordUndoBufferParams().
1298 cur.recordUndoFullBuffer();
1299 buffer_.params().clearLayoutModules();
1300 makeDocumentClass();
1301 dr.screenUpdate(Update::Force);
1302 dr.forceBufferUpdate();
1306 case LFUN_LAYOUT_MODULE_ADD: {
1307 BufferParams const & params = buffer_.params();
1308 if (!params.layoutModuleCanBeAdded(argument)) {
1309 LYXERR0("Module `" << argument <<
1310 "' cannot be added due to failed requirements or "
1311 "conflicts with installed modules.");
1314 // FIXME: this modifies the document in cap::switchBetweenClasses
1315 // without calling recordUndo. Fix this before using
1316 // recordUndoBufferParams().
1317 cur.recordUndoFullBuffer();
1318 buffer_.params().addLayoutModule(argument);
1319 makeDocumentClass();
1320 dr.screenUpdate(Update::Force);
1321 dr.forceBufferUpdate();
1325 case LFUN_TEXTCLASS_APPLY: {
1326 // since this shortcircuits, the second call is made only if
1328 bool const success =
1329 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1330 LayoutFileList::get().load(argument, buffer_.filePath());
1332 docstring s = bformat(_("The document class `%1$s' "
1333 "could not be loaded."), from_utf8(argument));
1334 frontend::Alert::error(_("Could not load class"), s);
1338 LayoutFile const * old_layout = buffer_.params().baseClass();
1339 LayoutFile const * new_layout = &(LayoutFileList::get()[argument]);
1341 if (old_layout == new_layout)
1345 // Save the old, possibly modular, layout for use in conversion.
1346 // FIXME: this modifies the document in cap::switchBetweenClasses
1347 // without calling recordUndo. Fix this before using
1348 // recordUndoBufferParams().
1349 cur.recordUndoFullBuffer();
1350 buffer_.params().setBaseClass(argument);
1351 makeDocumentClass();
1352 dr.screenUpdate(Update::Force);
1353 dr.forceBufferUpdate();
1357 case LFUN_TEXTCLASS_LOAD: {
1358 // since this shortcircuits, the second call is made only if
1360 bool const success =
1361 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1362 LayoutFileList::get().load(argument, buffer_.filePath());
1364 docstring s = bformat(_("The document class `%1$s' "
1365 "could not be loaded."), from_utf8(argument));
1366 frontend::Alert::error(_("Could not load class"), s);
1371 case LFUN_LAYOUT_RELOAD: {
1372 LayoutFileIndex bc = buffer_.params().baseClassID();
1373 LayoutFileList::get().reset(bc);
1374 buffer_.params().setBaseClass(bc);
1375 makeDocumentClass();
1376 dr.screenUpdate(Update::Force);
1377 dr.forceBufferUpdate();
1382 dr.setMessage(_("Undo"));
1383 cur.clearSelection();
1384 // We need to find out if the bibliography information
1385 // has changed. See bug #11055.
1386 // So these should not be references...
1387 LayoutModuleList const engines = buffer().params().citeEngine();
1388 CiteEngineType const enginetype = buffer().params().citeEngineType();
1389 if (!cur.textUndo())
1390 dr.setMessage(_("No further undo information"));
1392 dr.screenUpdate(Update::Force | Update::FitCursor);
1393 dr.forceBufferUpdate();
1394 if (buffer().params().citeEngine() != engines ||
1395 buffer().params().citeEngineType() != enginetype)
1396 buffer().invalidateCiteLabels();
1402 dr.setMessage(_("Redo"));
1403 cur.clearSelection();
1404 // We need to find out if the bibliography information
1405 // has changed. See bug #11055.
1406 // So these should not be references...
1407 LayoutModuleList const engines = buffer().params().citeEngine();
1408 CiteEngineType const enginetype = buffer().params().citeEngineType();
1409 if (!cur.textRedo())
1410 dr.setMessage(_("No further redo information"));
1412 dr.screenUpdate(Update::Force | Update::FitCursor);
1413 dr.forceBufferUpdate();
1414 if (buffer().params().citeEngine() != engines ||
1415 buffer().params().citeEngineType() != enginetype)
1416 buffer().invalidateCiteLabels();
1421 case LFUN_FONT_STATE:
1422 dr.setMessage(cur.currentState(false));
1425 case LFUN_BOOKMARK_SAVE:
1426 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1429 case LFUN_LABEL_GOTO: {
1430 docstring label = cmd.argument();
1431 if (label.empty()) {
1433 getInsetByCode<InsetRef>(cur, REF_CODE);
1435 label = inset->getParam("reference");
1436 // persistent=false: use temp_bookmark
1440 if (!label.empty()) {
1442 // at the moment, this is redundant, since gotoLabel will
1443 // eventually call LFUN_PARAGRAPH_GOTO, but it seems best
1445 dr.screenUpdate(Update::Force | Update::FitCursor);
1450 case LFUN_PARAGRAPH_GOTO: {
1451 int const id = convert<int>(cmd.getArg(0));
1452 pos_type const pos = convert<int>(cmd.getArg(1));
1455 string const str_id_end = cmd.getArg(2);
1456 string const str_pos_end = cmd.getArg(3);
1458 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1459 b = theBufferList().next(b)) {
1462 curs.setCursor(b->getParFromID(id));
1464 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1468 LYXERR(Debug::INFO, "Paragraph " << curs.paragraph().id()
1469 << " found in buffer `"
1470 << b->absFileName() << "'.");
1472 if (b == &buffer_) {
1474 if (str_id_end.empty() || str_pos_end.empty()) {
1477 mouseSetCursor(curs);
1480 int const id_end = convert<int>(str_id_end);
1481 pos_type const pos_end = convert<int>(str_pos_end);
1482 success = setCursorFromEntries({id, pos},
1486 dr.screenUpdate(Update::Force | Update::FitCursor);
1488 // Switch to other buffer view and resend cmd
1489 lyx::dispatch(FuncRequest(
1490 LFUN_BUFFER_SWITCH, b->absFileName()));
1498 case LFUN_NOTE_NEXT:
1499 gotoInset(this, NOTE_CODE, false);
1502 case LFUN_REFERENCE_NEXT: {
1503 vector<InsetCode> tmp;
1504 tmp.push_back(LABEL_CODE);
1505 tmp.push_back(REF_CODE);
1506 gotoInset(this, tmp, true);
1510 case LFUN_CHANGE_NEXT:
1511 findNextChange(this);
1512 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1513 dr.screenUpdate(Update::Force | Update::FitCursor);
1516 case LFUN_CHANGE_PREVIOUS:
1517 findPreviousChange(this);
1518 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1519 dr.screenUpdate(Update::Force | Update::FitCursor);
1522 case LFUN_CHANGES_MERGE:
1523 if (findNextChange(this) || findPreviousChange(this)) {
1524 dr.screenUpdate(Update::Force | Update::FitCursor);
1525 dr.forceBufferUpdate();
1526 showDialog("changes");
1530 case LFUN_ALL_CHANGES_ACCEPT:
1531 // select complete document
1533 cur.selHandle(true);
1534 buffer_.text().cursorBottom(cur);
1535 // accept everything in a single step to support atomic undo
1536 buffer_.text().acceptOrRejectChanges(cur, Text::ACCEPT);
1538 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1539 dr.screenUpdate(Update::Force | Update::FitCursor);
1540 dr.forceBufferUpdate();
1543 case LFUN_ALL_CHANGES_REJECT:
1544 // select complete document
1546 cur.selHandle(true);
1547 buffer_.text().cursorBottom(cur);
1548 // reject everything in a single step to support atomic undo
1549 // Note: reject does not work recursively; the user may have to repeat the operation
1550 buffer_.text().acceptOrRejectChanges(cur, Text::REJECT);
1552 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1553 dr.screenUpdate(Update::Force | Update::FitCursor);
1554 dr.forceBufferUpdate();
1557 case LFUN_WORD_FIND_FORWARD:
1558 case LFUN_WORD_FIND_BACKWARD: {
1560 // Would it maybe be better if this variable were view specific anyway?
1561 static docstring last_search;
1562 docstring searched_string;
1564 if (!cmd.argument().empty()) {
1565 last_search = cmd.argument();
1566 searched_string = cmd.argument();
1568 searched_string = last_search;
1571 if (searched_string.empty())
1574 bool const fw = act == LFUN_WORD_FIND_FORWARD;
1575 docstring const data =
1576 find2string(searched_string, true, false, fw);
1577 bool found = lyxfind(this, FuncRequest(LFUN_WORD_FIND, data));
1579 dr.screenUpdate(Update::Force | Update::FitCursor);
1583 case LFUN_WORD_FIND: {
1584 FuncRequest req = cmd;
1585 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1586 req = d->search_request_cache_;
1587 if (req.argument().empty()) {
1588 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, "findreplace"));
1591 if (lyxfind(this, req))
1592 dr.screenUpdate(Update::Force | Update::FitCursor);
1594 d->search_request_cache_ = req;
1598 case LFUN_WORD_REPLACE: {
1599 bool has_deleted = false;
1600 if (cur.selection()) {
1601 DocIterator beg = cur.selectionBegin();
1602 DocIterator end = cur.selectionEnd();
1603 if (beg.pit() == end.pit()) {
1604 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1605 if (!cur.inMathed() && cur.paragraph().isDeleted(p)) {
1612 if (lyxreplace(this, cmd, has_deleted)) {
1613 dr.forceBufferUpdate();
1614 dr.screenUpdate(Update::Force | Update::FitCursor);
1619 case LFUN_WORD_FINDADV: {
1620 FindAndReplaceOptions opt;
1621 istringstream iss(to_utf8(cmd.argument()));
1623 if (findAdv(this, opt)) {
1624 dr.screenUpdate(Update::Force | Update::FitCursor);
1635 cur.clearSelection();
1636 dr.setMessage(from_utf8(N_("Mark off")));
1640 cur.clearSelection();
1642 dr.setMessage(from_utf8(N_("Mark on")));
1645 case LFUN_MARK_TOGGLE:
1646 cur.selection(false);
1649 dr.setMessage(from_utf8(N_("Mark removed")));
1652 dr.setMessage(from_utf8(N_("Mark set")));
1657 case LFUN_SCREEN_SHOW_CURSOR:
1661 case LFUN_SCREEN_RECENTER:
1665 case LFUN_BIBTEX_DATABASE_ADD: {
1666 Cursor tmpcur = cur;
1667 findInset(tmpcur, BIBTEX_CODE, false);
1668 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1671 if (inset->addDatabase(cmd.argument()))
1672 dr.forceBufferUpdate();
1677 case LFUN_BIBTEX_DATABASE_DEL: {
1678 Cursor tmpcur = cur;
1679 findInset(tmpcur, BIBTEX_CODE, false);
1680 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1683 if (inset->delDatabase(cmd.argument()))
1684 dr.forceBufferUpdate();
1689 case LFUN_GRAPHICS_UNIFY: {
1691 cur.recordUndoFullBuffer();
1693 DocIterator from, to;
1694 from = cur.selectionBegin();
1695 to = cur.selectionEnd();
1697 string const newId = cmd.getArg(0);
1698 bool fetchId = newId.empty(); //if we wait for groupId from first graphics inset
1700 InsetGraphicsParams grp_par;
1702 InsetGraphics::string2params(graphics::getGroupParams(buffer_, newId), buffer_, grp_par);
1704 if (!from.nextInset()) //move to closest inset
1705 from.forwardInset();
1707 while (!from.empty() && from < to) {
1708 Inset * inset = from.nextInset();
1711 InsetGraphics * ig = inset->asInsetGraphics();
1713 InsetGraphicsParams inspar = ig->getParams();
1718 grp_par.filename = inspar.filename;
1719 ig->setParams(grp_par);
1722 from.forwardInset();
1724 dr.screenUpdate(Update::Force); //needed if triggered from context menu
1728 case LFUN_STATISTICS: {
1729 DocIterator from, to;
1730 if (cur.selection()) {
1731 from = cur.selectionBegin();
1732 to = cur.selectionEnd();
1734 from = doc_iterator_begin(&buffer_);
1735 to = doc_iterator_end(&buffer_);
1737 buffer_.updateStatistics(from, to);
1738 int const words = buffer_.wordCount();
1739 int const chars = buffer_.charCount(false);
1740 int const chars_blanks = buffer_.charCount(true);
1742 if (cur.selection())
1743 message = _("Statistics for the selection:");
1745 message = _("Statistics for the document:");
1748 message += bformat(_("%1$d words"), words);
1750 message += _("One word");
1752 if (chars_blanks != 1)
1753 message += bformat(_("%1$d characters (including blanks)"),
1756 message += _("One character (including blanks)");
1759 message += bformat(_("%1$d characters (excluding blanks)"),
1762 message += _("One character (excluding blanks)");
1764 Alert::information(_("Statistics"), message);
1768 case LFUN_SCREEN_UP:
1769 case LFUN_SCREEN_DOWN: {
1770 Point p = getPos(cur);
1771 // This code has been commented out to enable to scroll down a
1772 // document, even if there are large insets in it (see bug #5465).
1773 /*if (p.y_ < 0 || p.y_ > height_) {
1774 // The cursor is off-screen so recenter before proceeding.
1778 int const scrolled = scroll(act == LFUN_SCREEN_UP
1779 ? -height_ : height_);
1780 if (act == LFUN_SCREEN_UP && scrolled > -height_)
1782 if (act == LFUN_SCREEN_DOWN && scrolled < height_)
1783 p = Point(width_, height_);
1784 bool const in_texted = cur.inTexted();
1785 cur.setCursor(doc_iterator_begin(cur.buffer()));
1786 cur.selHandle(false);
1787 // Force an immediate computation of metrics because we need it below
1788 processUpdateFlags(Update::Force);
1790 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_,
1791 true, act == LFUN_SCREEN_UP);
1792 //FIXME: what to do with cur.x_target()?
1793 bool update = in_texted && cur.bv().checkDepm(cur, old);
1796 if (update || cur.mark())
1797 dr.screenUpdate(Update::Force | Update::FitCursor);
1799 dr.forceBufferUpdate();
1804 string const scroll_type = cmd.getArg(0);
1805 int scroll_step = 0;
1806 if (scroll_type == "line")
1807 scroll_step = d->scrollbarParameters_.single_step;
1808 else if (scroll_type == "page")
1809 scroll_step = d->scrollbarParameters_.page_step;
1812 string const scroll_quantity = cmd.getArg(1);
1813 if (scroll_quantity == "up")
1814 scrollUp(scroll_step);
1815 else if (scroll_quantity == "down")
1816 scrollDown(scroll_step);
1818 int const scroll_value = convert<int>(scroll_quantity);
1820 scroll(scroll_step * scroll_value);
1822 dr.screenUpdate(Update::ForceDraw);
1823 dr.forceBufferUpdate();
1827 case LFUN_SCREEN_UP_SELECT: {
1828 // FIXME: why is the algorithm different from LFUN_SCREEN_UP?
1829 cur.selHandle(true);
1830 if (isTopScreen()) {
1831 lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1835 int y = getPos(cur).y_;
1836 int const ymin = y - height_ + defaultRowHeight();
1837 while (y > ymin && cur.up())
1841 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1845 case LFUN_SCREEN_DOWN_SELECT: {
1846 // FIXME: why is the algorithm different from LFUN_SCREEN_DOWN?
1847 cur.selHandle(true);
1848 if (isBottomScreen()) {
1849 lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1853 int y = getPos(cur).y_;
1854 int const ymax = y + height_ - defaultRowHeight();
1855 while (y < ymax && cur.down())
1859 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1864 case LFUN_INSET_SELECT_ALL: {
1865 // true if all cells are selected
1866 bool const all_selected = cur.depth() > 1
1867 && cur.selBegin().at_begin()
1868 && cur.selEnd().at_end();
1869 // true if some cells are selected
1870 bool const cells_selected = cur.depth() > 1
1871 && cur.selBegin().at_cell_begin()
1872 && cur.selEnd().at_cell_end();
1873 if (all_selected || (cells_selected && !cur.inset().isTable())) {
1874 // All the contents of the inset if selected, or only at
1875 // least one cell but inset is not a table.
1876 // Select the inset from outside.
1879 cur.selection(true);
1881 } else if (cells_selected) {
1882 // At least one complete cell is selected and inset is a table.
1887 cur.selection(true);
1888 cur.idx() = cur.lastidx();
1889 cur.pos() = cur.lastpos();
1891 // select current cell
1895 cur.selection(true);
1896 cur.pit() = cur.lastpit();
1897 cur.pos() = cur.lastpos();
1899 cur.setCurrentFont();
1900 dr.screenUpdate(Update::Force);
1905 case LFUN_UNICODE_INSERT: {
1906 if (cmd.argument().empty())
1909 FuncCode code = cur.inset().currentMode() == Inset::MATH_MODE ?
1910 LFUN_MATH_INSERT : LFUN_SELF_INSERT;
1913 docstring const arg = from_utf8(cmd.getArg(i));
1917 LYXERR0("Not a hexstring: " << arg);
1921 char_type c = hexToInt(arg);
1922 if (c >= 32 && c < 0x10ffff) {
1923 LYXERR(Debug::KEY, "Inserting c: " << c);
1924 lyx::dispatch(FuncRequest(code, docstring(1, c)));
1932 // This would be in Buffer class if only Cursor did not
1933 // require a bufferview
1934 case LFUN_INSET_FORALL: {
1935 docstring const name = from_utf8(cmd.getArg(0));
1936 string const commandstr = cmd.getLongArg(1);
1937 FuncRequest const fr = lyxaction.lookupFunc(commandstr);
1939 // an arbitrary number to limit number of iterations
1940 const int max_iter = 100000;
1942 Cursor & curs = d->cursor_;
1943 Cursor const savecur = curs;
1945 if (!curs.nextInset())
1946 curs.forwardInset();
1947 curs.beginUndoGroup();
1948 while(curs && iterations < max_iter) {
1949 Inset * const ins = curs.nextInset();
1952 docstring insname = ins->layoutName();
1953 while (!insname.empty()) {
1954 if (insname == name || name == from_utf8("*")) {
1956 lyx::dispatch(fr, dr);
1960 size_t const i = insname.rfind(':');
1961 if (i == string::npos)
1963 insname = insname.substr(0, i);
1965 // if we did not delete the inset, skip it
1966 if (!curs.nextInset() || curs.nextInset() == ins)
1967 curs.forwardInset();
1971 /** This is a dummy undo record only to remember the cursor
1972 * that has just been set; this will be used on a redo action
1973 * (see ticket #10097)
1975 * FIXME: a better fix would be to have a way to set the
1976 * cursor value directly, but I am not sure it is worth it.
1979 curs.endUndoGroup();
1980 dr.screenUpdate(Update::Force);
1981 dr.forceBufferUpdate();
1983 if (iterations >= max_iter) {
1985 dr.setMessage(bformat(_("`inset-forall' interrupted because number of actions is larger than %1$d"), max_iter));
1987 dr.setMessage(bformat(_("Applied \"%1$s\" to %2$d insets"), from_utf8(commandstr), iterations));
1992 case LFUN_BRANCH_ADD_INSERT: {
1993 docstring branch_name = from_utf8(cmd.getArg(0));
1994 if (branch_name.empty())
1995 if (!Alert::askForText(branch_name, _("Branch name")) ||
1996 branch_name.empty())
1999 DispatchResult drtmp;
2000 buffer_.dispatch(FuncRequest(LFUN_BRANCH_ADD, branch_name), drtmp);
2001 if (drtmp.error()) {
2002 Alert::warning(_("Branch already exists"), drtmp.message());
2005 docstring const sep = buffer_.params().branchlist().separator();
2006 for (docstring const & branch : getVectorFromString(branch_name, sep))
2007 lyx::dispatch(FuncRequest(LFUN_BRANCH_INSERT, branch));
2011 case LFUN_KEYMAP_OFF:
2012 getIntl().keyMapOn(false);
2015 case LFUN_KEYMAP_PRIMARY:
2016 getIntl().keyMapPrim();
2019 case LFUN_KEYMAP_SECONDARY:
2020 getIntl().keyMapSec();
2023 case LFUN_KEYMAP_TOGGLE:
2024 getIntl().toggleKeyMap();
2027 case LFUN_DIALOG_SHOW_NEW_INSET: {
2028 string const name = cmd.getArg(0);
2029 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
2030 if (decodeInsetParam(name, data, buffer_))
2031 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
2033 lyxerr << "Inset type '" << name <<
2034 "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" << endl;
2038 case LFUN_CITATION_INSERT: {
2039 if (argument.empty()) {
2040 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
2043 // we can have one optional argument, delimited by '|'
2044 // citation-insert <key>|<text_before>
2045 // this should be enhanced to also support text_after
2046 // and citation style
2047 string arg = argument;
2049 if (contains(argument, "|")) {
2050 arg = token(argument, '|', 0);
2051 opt1 = token(argument, '|', 1);
2054 // if our cursor is directly in front of or behind a citation inset,
2055 // we will instead add the new key to it.
2056 Inset * inset = cur.nextInset();
2057 if (!inset || inset->lyxCode() != CITE_CODE)
2058 inset = cur.prevInset();
2059 if (inset && inset->lyxCode() == CITE_CODE) {
2060 InsetCitation * icite = static_cast<InsetCitation *>(inset);
2061 if (icite->addKey(arg)) {
2062 dr.forceBufferUpdate();
2063 dr.screenUpdate(Update::FitCursor | Update::SinglePar);
2065 LYXERR0("Discarding optional argument to citation-insert.");
2070 InsetCommandParams icp(CITE_CODE);
2071 icp["key"] = from_utf8(arg);
2073 icp["before"] = from_utf8(opt1);
2075 from_ascii(InsetCitation::last_literal ? "true" : "false");
2076 string icstr = InsetCommand::params2string(icp);
2077 FuncRequest fr(LFUN_INSET_INSERT, icstr);
2082 case LFUN_INSET_APPLY: {
2083 string const name = cmd.getArg(0);
2084 Inset * inset = editedInset(name);
2086 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
2090 // put cursor in front of inset.
2091 if (!setCursorFromInset(inset)) {
2092 LASSERT(false, break);
2095 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
2096 inset->dispatch(cur, fr);
2097 dr.screenUpdate(cur.result().screenUpdate());
2098 if (cur.result().needBufferUpdate())
2099 dr.forceBufferUpdate();
2104 // The change of language of buffer belongs to the Buffer class.
2105 // We have to do it here because we need a cursor for Undo.
2106 // When Undo::recordUndoBufferParams() is implemented someday
2107 // LFUN_BUFFER_LANGUAGE should be handled by the Buffer class.
2108 case LFUN_BUFFER_LANGUAGE: {
2109 Language const * oldL = buffer_.params().language;
2110 Language const * newL = languages.getLanguage(argument);
2111 if (!newL || oldL == newL)
2113 if (oldL->rightToLeft() == newL->rightToLeft()) {
2114 cur.recordUndoFullBuffer();
2115 buffer_.changeLanguage(oldL, newL);
2116 cur.setCurrentFont();
2117 dr.forceBufferUpdate();
2122 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
2123 case LFUN_FILE_INSERT_PLAINTEXT: {
2124 bool const as_paragraph = (act == LFUN_FILE_INSERT_PLAINTEXT_PARA);
2125 string const fname = to_utf8(cmd.argument());
2126 if (!FileName::isAbsolute(fname))
2127 dr.setMessage(_("Absolute filename expected."));
2129 insertPlaintextFile(FileName(fname), as_paragraph);
2134 // OK, so try the Buffer itself...
2135 buffer_.dispatch(cmd, dr);
2136 dispatched = dr.dispatched();
2140 buffer_.undo().endUndoGroup();
2141 dr.dispatched(dispatched);
2143 // NOTE: The code below is copied from Cursor::dispatch. If you
2144 // need to modify this, please update the other one too.
2146 // notify insets we just entered/left
2147 if (cursor() != old) {
2148 old.beginUndoGroup();
2150 bool badcursor = notifyCursorLeavesOrEnters(old, cursor());
2152 cursor().fixIfBroken();
2153 resetInlineCompletionPos();
2160 docstring const BufferView::requestSelection()
2162 Cursor & cur = d->cursor_;
2164 LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
2165 if (!cur.selection()) {
2166 d->xsel_cache_.set = false;
2170 LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
2171 if (!d->xsel_cache_.set ||
2172 cur.top() != d->xsel_cache_.cursor ||
2173 cur.realAnchor().top() != d->xsel_cache_.anchor)
2175 d->xsel_cache_.cursor = cur.top();
2176 d->xsel_cache_.anchor = cur.realAnchor().top();
2177 d->xsel_cache_.set = cur.selection();
2178 return cur.selectionAsString(false);
2184 void BufferView::clearSelection()
2186 d->cursor_.clearSelection();
2187 // Clear the selection buffer. Otherwise a subsequent
2188 // middle-mouse-button paste would use the selection buffer,
2189 // not the more current external selection.
2190 cap::clearSelection();
2191 d->xsel_cache_.set = false;
2192 // The buffer did not really change, but this causes the
2193 // redraw we need because we cleared the selection above.
2194 buffer_.changed(false);
2198 void BufferView::resize(int width, int height)
2200 // Update from work area
2204 // Clear the paragraph height cache.
2205 d->par_height_.clear();
2206 // Redo the metrics.
2211 Inset const * BufferView::getCoveringInset(Text const & text,
2214 TextMetrics & tm = d->text_metrics_[&text];
2215 Inset * inset = tm.checkInsetHit(x, y);
2219 if (!inset->descendable(*this))
2220 // No need to go further down if the inset is not
2224 size_t cell_number = inset->nargs();
2225 // Check all the inner cell.
2226 for (size_t i = 0; i != cell_number; ++i) {
2227 Text const * inner_text = inset->getText(i);
2230 Inset const * inset_deeper =
2231 getCoveringInset(*inner_text, x, y);
2233 return inset_deeper;
2241 void BufferView::updateHoveredInset() const
2243 // Get inset under mouse, if there is one.
2244 int const x = d->mouse_position_cache_.x_;
2245 int const y = d->mouse_position_cache_.y_;
2246 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
2248 d->clickable_inset_ = covering_inset && covering_inset->clickable(*this, x, y);
2250 if (covering_inset == d->last_inset_)
2251 // Same inset, no need to do anything...
2254 bool need_redraw = false;
2255 if (d->last_inset_) {
2256 // Remove the hint on the last hovered inset (if any).
2257 need_redraw |= d->last_inset_->setMouseHover(this, false);
2261 if (covering_inset && covering_inset->setMouseHover(this, true)) {
2263 // Only the insets that accept the hover state, do
2264 // clear the last_inset_, so only set the last_inset_
2265 // member if the hovered setting is accepted.
2266 d->last_inset_ = covering_inset;
2270 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
2271 << d->mouse_position_cache_.x_ << ", "
2272 << d->mouse_position_cache_.y_ << ")");
2274 d->update_strategy_ = DecorationUpdate;
2276 // This event (moving without mouse click) is not passed further.
2277 // This should be changed if it is further utilized.
2278 buffer_.changed(false);
2283 void BufferView::clearLastInset(Inset * inset) const
2285 if (d->last_inset_ != inset) {
2286 LYXERR0("Wrong last_inset!");
2293 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
2295 //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
2297 // This is only called for mouse related events including
2298 // LFUN_FILE_OPEN generated by drag-and-drop.
2299 FuncRequest cmd = cmd0;
2301 Cursor old = cursor();
2303 cur.push(buffer_.inset());
2304 cur.selection(d->cursor_.selection());
2306 // Either the inset under the cursor or the
2307 // surrounding Text will handle this event.
2309 // make sure we stay within the screen...
2310 cmd.set_y(min(max(cmd.y(), -1), height_));
2312 d->mouse_position_cache_.x_ = cmd.x();
2313 d->mouse_position_cache_.y_ = cmd.y();
2315 if (cmd.action() == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
2316 updateHoveredInset();
2320 // Build temporary cursor.
2321 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x(), cmd.y());
2323 // If inset is not editable, cur.pos() might point behind the
2324 // inset (depending on cmd.x(), cmd.y()). This is needed for
2325 // editing to fix bug 9628, but e.g. the context menu needs a
2326 // cursor in front of the inset.
2327 if ((inset->hasSettings() || !inset->contextMenuName().empty()
2328 || inset->lyxCode() == SEPARATOR_CODE) &&
2329 cur.nextInset() != inset && cur.prevInset() == inset)
2331 } else if (cur.inTexted() && cur.pos()
2332 && cur.paragraph().isEnvSeparator(cur.pos() - 1)) {
2333 // Always place cursor in front of a separator inset.
2337 // Put anchor at the same position.
2340 cur.beginUndoGroup();
2342 // Try to dispatch to an non-editable inset near this position
2343 // via the temp cursor. If the inset wishes to change the real
2344 // cursor it has to do so explicitly by using
2345 // cur.bv().cursor() = cur; (or similar)
2347 inset->dispatch(cur, cmd);
2349 // Now dispatch to the temporary cursor. If the real cursor should
2350 // be modified, the inset's dispatch has to do so explicitly.
2351 if (!inset || !cur.result().dispatched())
2354 // Notify left insets
2356 bool badcursor = old.fixIfBroken() | cur.fixIfBroken();
2357 badcursor |= notifyCursorLeavesOrEnters(old, cur);
2359 cursor().fixIfBroken();
2364 // Do we have a selection?
2365 theSelection().haveSelection(cursor().selection());
2367 if (cur.needBufferUpdate()) {
2368 cur.clearBufferUpdate();
2369 buffer().updateBuffer();
2372 // If the command has been dispatched,
2373 if (cur.result().dispatched() || cur.result().screenUpdate())
2374 processUpdateFlags(cur.result().screenUpdate());
2378 int BufferView::minVisiblePart()
2380 return 2 * defaultRowHeight();
2384 int BufferView::scroll(int y)
2387 return scrollDown(y);
2389 return scrollUp(-y);
2394 int BufferView::scrollDown(int offset)
2396 Text * text = &buffer_.text();
2397 TextMetrics & tm = d->text_metrics_[text];
2398 int const ymax = height_ + offset;
2400 pair<pit_type, ParagraphMetrics const *> last = tm.last();
2401 int bottom_pos = last.second->position() + last.second->descent();
2402 if (lyxrc.scroll_below_document)
2403 bottom_pos += height_ - minVisiblePart();
2404 if (last.first + 1 == int(text->paragraphs().size())) {
2405 if (bottom_pos <= height_)
2407 offset = min(offset, bottom_pos - height_);
2410 if (bottom_pos > ymax)
2412 tm.newParMetricsDown();
2414 d->anchor_ypos_ -= offset;
2419 int BufferView::scrollUp(int offset)
2421 Text * text = &buffer_.text();
2422 TextMetrics & tm = d->text_metrics_[text];
2423 int ymin = - offset;
2425 pair<pit_type, ParagraphMetrics const *> first = tm.first();
2426 int top_pos = first.second->position() - first.second->ascent();
2427 if (first.first == 0) {
2430 offset = min(offset, - top_pos);
2435 tm.newParMetricsUp();
2437 d->anchor_ypos_ += offset;
2442 bool BufferView::setCursorFromRow(int row)
2444 TexRow::TextEntry start, end;
2445 tie(start,end) = buffer_.texrow().getEntriesFromRow(row);
2446 LYXERR(Debug::LATEX,
2447 "setCursorFromRow: for row " << row << ", TexRow has found "
2448 "start (id=" << start.id << ",pos=" << start.pos << "), "
2449 "end (id=" << end.id << ",pos=" << end.pos << ")");
2450 return setCursorFromEntries(start, end);
2454 bool BufferView::setCursorFromEntries(TexRow::TextEntry start,
2455 TexRow::TextEntry end)
2457 DocIterator dit_start, dit_end;
2458 tie(dit_start,dit_end) =
2459 TexRow::getDocIteratorsFromEntries(start, end, buffer_);
2462 // Setting selection start
2463 d->cursor_.clearSelection();
2464 setCursor(dit_start);
2465 // Setting selection end
2467 d->cursor_.resetAnchor();
2468 setCursorSelectionTo(dit_end);
2474 bool BufferView::setCursorFromInset(Inset const * inset)
2476 // are we already there?
2477 if (cursor().nextInset() == inset)
2480 // Inset is not at cursor position. Find it in the document.
2483 while (cur && cur.nextInset() != inset)
2494 void BufferView::gotoLabel(docstring const & label)
2496 for (Buffer const * buf : buffer().allRelatives()) {
2498 for (TocItem const & item : *buf->tocBackend().toc("label")) {
2499 if (label == item.str()) {
2500 lyx::dispatch(item.action());
2508 TextMetrics const & BufferView::textMetrics(Text const * t) const
2510 return const_cast<BufferView *>(this)->textMetrics(t);
2514 TextMetrics & BufferView::textMetrics(Text const * t)
2517 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
2518 if (tmc_it == d->text_metrics_.end()) {
2519 tmc_it = d->text_metrics_.insert(
2520 make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
2522 return tmc_it->second;
2526 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
2529 return textMetrics(t).parMetrics(pit);
2533 int BufferView::workHeight() const
2539 void BufferView::setCursor(DocIterator const & dit)
2542 size_t const n = dit.depth();
2543 for (size_t i = 0; i < n; ++i)
2544 dit[i].inset().edit(d->cursor_, true);
2546 d->cursor_.setCursor(dit);
2547 d->cursor_.selection(false);
2548 d->cursor_.setCurrentFont();
2550 // It seems on general grounds as if this is probably needed, but
2551 // it is not yet clear.
2552 // See bug #7394 and r38388.
2553 // d->cursor.resetAnchor();
2557 void BufferView::setCursorSelectionTo(DocIterator const & dit)
2559 size_t const n = dit.depth();
2560 for (size_t i = 0; i < n; ++i)
2561 dit[i].inset().edit(d->cursor_, true);
2563 d->cursor_.selection(true);
2564 d->cursor_.setCursorSelectionTo(dit);
2565 d->cursor_.setCurrentFont();
2569 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
2571 // Would be wrong to delete anything if we have a selection.
2572 if (cur.selection())
2575 bool need_anchor_change = false;
2576 bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
2577 need_anchor_change);
2579 if (need_anchor_change)
2587 // we would rather not do this here, but it needs to be done before
2588 // the changed() signal is sent.
2589 buffer_.updateBuffer();
2591 buffer_.changed(true);
2596 bool BufferView::mouseSetCursor(Cursor & cur, bool const select)
2598 LASSERT(&cur.bv() == this, return false);
2601 // this event will clear selection so we save selection for
2602 // persistent selection
2603 cap::saveSelection(cursor());
2605 d->cursor_.macroModeClose();
2606 // If a macro has been finalized, the cursor might have been broken
2609 // Has the cursor just left the inset?
2610 bool const leftinset = (&d->cursor_.inset() != &cur.inset());
2612 d->cursor_.fixIfBroken();
2614 // do the dEPM magic if needed
2615 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
2616 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
2617 // the leftinset bool would not be necessary (badcursor instead).
2618 bool update = leftinset;
2621 d->cursor_.setSelection();
2622 d->cursor_.setCursorSelectionTo(cur);
2624 if (d->cursor_.inTexted())
2625 update |= checkDepm(cur, d->cursor_);
2626 d->cursor_.resetAnchor();
2627 d->cursor_.setCursor(cur);
2628 d->cursor_.clearSelection();
2630 d->cursor_.boundary(cur.boundary());
2631 d->cursor_.finishUndo();
2632 d->cursor_.setCurrentFont();
2634 cur.forceBufferUpdate();
2639 void BufferView::putSelectionAt(DocIterator const & cur,
2640 int length, bool backwards)
2642 d->cursor_.clearSelection();
2648 d->cursor_.pos() += length;
2649 d->cursor_.setSelection(d->cursor_, -length);
2651 d->cursor_.setSelection(d->cursor_, length);
2656 bool BufferView::selectIfEmpty(DocIterator & cur)
2658 if ((cur.inTexted() && !cur.paragraph().empty())
2659 || (cur.inMathed() && !cur.cell().empty()))
2662 pit_type const beg_pit = cur.pit();
2664 // The paragraph associated to this item isn't
2665 // the first one, so it can be selected
2668 // We have to resort to select the space between the
2669 // end of this item and the begin of the next one
2673 // If it is the only item in the document,
2674 // nothing can be selected
2677 pit_type const end_pit = cur.pit();
2678 pos_type const end_pos = cur.pos();
2679 d->cursor_.clearSelection();
2681 d->cursor_.setCursor(cur);
2682 d->cursor_.pit() = beg_pit;
2683 d->cursor_.pos() = 0;
2684 d->cursor_.selection(false);
2685 d->cursor_.resetAnchor();
2686 d->cursor_.pit() = end_pit;
2687 d->cursor_.pos() = end_pos;
2688 d->cursor_.setSelection();
2693 Cursor & BufferView::cursor()
2699 Cursor const & BufferView::cursor() const
2705 bool BufferView::singleParUpdate()
2707 Text & buftext = buffer_.text();
2708 pit_type const bottom_pit = d->cursor_.bottom().pit();
2709 TextMetrics & tm = textMetrics(&buftext);
2710 int old_height = tm.parMetrics(bottom_pit).height();
2712 // make sure inline completion pointer is ok
2713 if (d->inlineCompletionPos_.fixIfBroken())
2714 d->inlineCompletionPos_ = DocIterator();
2716 // In Single Paragraph mode, rebreak only
2717 // the (main text, not inset!) paragraph containing the cursor.
2718 // (if this paragraph contains insets etc., rebreaking will
2719 // recursively descend)
2720 tm.redoParagraph(bottom_pit);
2721 ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
2722 if (pm.height() != old_height)
2723 // Paragraph height has changed so we cannot proceed to
2724 // the singlePar optimisation.
2727 tm.updatePosCache(bottom_pit);
2729 LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
2730 << " y2: " << pm.position() + pm.descent()
2731 << " pit: " << bottom_pit
2732 << " singlepar: 1");
2737 void BufferView::updateMetrics()
2739 updateMetrics(d->update_flags_);
2740 d->update_strategy_ = FullScreenUpdate;
2744 void BufferView::updateMetrics(Update::flags & update_flags)
2746 if (height_ == 0 || width_ == 0)
2749 Text & buftext = buffer_.text();
2750 pit_type const npit = int(buftext.paragraphs().size());
2752 // Clear out the position cache in case of full screen redraw,
2753 d->coord_cache_.clear();
2755 // Clear out paragraph metrics to avoid having invalid metrics
2756 // in the cache from paragraphs not relayouted below
2757 // The complete text metrics will be redone.
2758 d->text_metrics_.clear();
2760 TextMetrics & tm = textMetrics(&buftext);
2762 // make sure inline completion pointer is ok
2763 if (d->inlineCompletionPos_.fixIfBroken())
2764 d->inlineCompletionPos_ = DocIterator();
2766 if (d->anchor_pit_ >= npit)
2767 // The anchor pit must have been deleted...
2768 d->anchor_pit_ = npit - 1;
2770 // Rebreak anchor paragraph.
2771 tm.redoParagraph(d->anchor_pit_);
2772 ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
2775 if (d->anchor_pit_ == 0) {
2776 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
2778 // Complete buffer visible? Then it's easy.
2779 if (scrollRange == 0)
2780 d->anchor_ypos_ = anchor_pm.ascent();
2782 // avoid empty space above the first row
2783 d->anchor_ypos_ = min(d->anchor_ypos_, anchor_pm.ascent());
2786 anchor_pm.setPosition(d->anchor_ypos_);
2787 tm.updatePosCache(d->anchor_pit_);
2789 LYXERR(Debug::PAINTING, "metrics: "
2790 << " anchor pit = " << d->anchor_pit_
2791 << " anchor ypos = " << d->anchor_ypos_);
2793 // Redo paragraphs above anchor if necessary.
2794 int y1 = d->anchor_ypos_ - anchor_pm.ascent();
2795 // We are now just above the anchor paragraph.
2796 pit_type pit1 = d->anchor_pit_ - 1;
2797 for (; pit1 >= 0 && y1 >= 0; --pit1) {
2798 tm.redoParagraph(pit1);
2799 ParagraphMetrics & pm = tm.par_metrics_[pit1];
2801 // Save the paragraph position in the cache.
2803 tm.updatePosCache(pit1);
2807 // Redo paragraphs below the anchor if necessary.
2808 int y2 = d->anchor_ypos_ + anchor_pm.descent();
2809 // We are now just below the anchor paragraph.
2810 pit_type pit2 = d->anchor_pit_ + 1;
2811 for (; pit2 < npit && y2 <= height_; ++pit2) {
2812 tm.redoParagraph(pit2);
2813 ParagraphMetrics & pm = tm.par_metrics_[pit2];
2815 // Save the paragraph position in the cache.
2817 tm.updatePosCache(pit2);
2821 LYXERR(Debug::PAINTING, "Metrics: "
2822 << " anchor pit = " << d->anchor_pit_
2823 << " anchor ypos = " << d->anchor_ypos_
2826 << " pit1 = " << pit1
2827 << " pit2 = " << pit2);
2829 // metrics is done, full drawing is necessary now
2830 update_flags = (update_flags & ~Update::Force) | Update::ForceDraw;
2832 // Now update the positions of insets in the cache.
2835 if (lyxerr.debugging(Debug::WORKAREA)) {
2836 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
2837 d->coord_cache_.dump();
2842 void BufferView::updatePosCache()
2844 // this is the "nodraw" drawing stage: only set the positions of the
2845 // insets in metrics cache.
2846 frontend::NullPainter np;
2851 void BufferView::insertLyXFile(FileName const & fname)
2853 LASSERT(d->cursor_.inTexted(), return);
2855 // Get absolute path of file and add ".lyx"
2856 // to the filename if necessary
2857 FileName filename = fileSearch(string(), fname.absFileName(), "lyx");
2859 docstring const disp_fn = makeDisplayPath(filename.absFileName());
2860 // emit message signal.
2861 message(bformat(_("Inserting document %1$s..."), disp_fn));
2864 Buffer buf(filename.absFileName(), false);
2865 if (buf.loadLyXFile() == Buffer::ReadSuccess) {
2866 ErrorList & el = buffer_.errorList("Parse");
2867 // Copy the inserted document error list into the current buffer one.
2868 el = buf.errorList("Parse");
2869 buffer_.undo().recordUndo(d->cursor_);
2870 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
2871 buf.params().documentClassPtr(), el);
2872 res = _("Document %1$s inserted.");
2874 res = _("Could not insert document %1$s");
2877 buffer_.changed(true);
2878 // emit message signal.
2879 message(bformat(res, disp_fn));
2883 Point BufferView::coordOffset(DocIterator const & dit) const
2889 // Addup contribution of nested insets, from inside to outside,
2890 // keeping the outer paragraph for a special handling below
2891 for (size_t i = dit.depth() - 1; i >= 1; --i) {
2892 CursorSlice const & sl = dit[i];
2896 // get relative position inside sl.inset()
2897 sl.inset().cursorPos(*this, sl, dit.boundary() && (i + 1 == dit.depth()), xx, yy);
2899 // Make relative position inside of the edited inset relative to sl.inset()
2903 // In case of an RTL inset, the edited inset will be positioned to the left
2906 bool boundary_i = dit.boundary() && i + 1 == dit.depth();
2907 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2912 // remember width for the case that sl.inset() is positioned in an RTL inset
2913 lastw = sl.inset().dimension(*this).wid;
2915 //lyxerr << "Cursor::getPos, i: "
2916 // << i << " x: " << xx << " y: " << y << endl;
2919 // Add contribution of initial rows of outermost paragraph
2920 CursorSlice const & sl = dit[0];
2921 TextMetrics const & tm = textMetrics(sl.text());
2922 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2924 LBUFERR(!pm.rows().empty());
2925 y -= pm.rows()[0].ascent();
2927 // FIXME: document this mess
2929 if (sl.pos() > 0 && dit.depth() == 1) {
2931 if (pos && dit.boundary())
2933 // lyxerr << "coordOffset: boundary:" << dit.boundary() << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
2934 rend = pm.pos2row(pos);
2936 rend = pm.pos2row(sl.pos());
2938 size_t rend = pm.pos2row(sl.pos());
2940 for (size_t rit = 0; rit != rend; ++rit)
2941 y += pm.rows()[rit].height();
2942 y += pm.rows()[rend].ascent();
2944 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
2946 // Make relative position from the nested inset now bufferview absolute.
2947 int xx = bottom_tm.cursorX(dit.bottom(), dit.boundary() && dit.depth() == 1);
2950 // In the RTL case place the nested inset at the left of the cursor in
2951 // the outer paragraph
2952 bool boundary_1 = dit.boundary() && 1 == dit.depth();
2953 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
2961 Point BufferView::getPos(DocIterator const & dit) const
2963 if (!paragraphVisible(dit))
2964 return Point(-1, -1);
2966 CursorSlice const & bot = dit.bottom();
2967 TextMetrics const & tm = textMetrics(bot.text());
2969 // offset from outer paragraph
2970 Point p = coordOffset(dit);
2971 p.y_ += tm.parMetrics(bot.pit()).position();
2976 bool BufferView::paragraphVisible(DocIterator const & dit) const
2978 CursorSlice const & bot = dit.bottom();
2979 TextMetrics const & tm = textMetrics(bot.text());
2981 return tm.contains(bot.pit());
2985 void BufferView::caretPosAndHeight(Point & p, int & h) const
2987 Cursor const & cur = cursor();
2988 Font const font = cur.real_current_font;
2989 frontend::FontMetrics const & fm = theFontMetrics(font);
2990 int const asc = fm.maxAscent();
2991 int const des = fm.maxDescent();
2998 bool BufferView::cursorInView(Point const & p, int h) const
3000 Cursor const & cur = cursor();
3001 // does the cursor touch the screen ?
3002 if (p.y_ + h < 0 || p.y_ >= workHeight() || !paragraphVisible(cur))
3008 int BufferView::horizScrollOffset() const
3010 return d->horiz_scroll_offset_;
3014 int BufferView::horizScrollOffset(Text const * text,
3015 pit_type pit, pos_type pos) const
3017 // Is this a row that is currently scrolled?
3018 if (!d->current_row_slice_.empty()
3019 && &text->inset() == d->current_row_slice_.inset().asInsetText()
3020 && pit == d->current_row_slice_.pit()
3021 && pos == d->current_row_slice_.pos())
3022 return d->horiz_scroll_offset_;
3027 bool BufferView::hadHorizScrollOffset(Text const * text,
3028 pit_type pit, pos_type pos) const
3030 return !d->last_row_slice_.empty()
3031 && &text->inset() == d->last_row_slice_.inset().asInsetText()
3032 && pit == d->last_row_slice_.pit()
3033 && pos == d->last_row_slice_.pos();
3037 void BufferView::setCurrentRowSlice(CursorSlice const & rowSlice)
3039 // nothing to do if the cursor was already on this row
3040 if (d->current_row_slice_ == rowSlice) {
3041 d->last_row_slice_ = CursorSlice();
3045 // if the (previous) current row was scrolled, we have to
3046 // remember it in order to repaint it next time.
3047 if (d->horiz_scroll_offset_ != 0)
3048 d->last_row_slice_ = d->current_row_slice_;
3050 d->last_row_slice_ = CursorSlice();
3052 // Since we changed row, the scroll offset is not valid anymore
3053 d->horiz_scroll_offset_ = 0;
3054 d->current_row_slice_ = rowSlice;
3058 void BufferView::checkCursorScrollOffset()
3060 CursorSlice rowSlice = d->cursor_.bottom();
3061 TextMetrics const & tm = textMetrics(rowSlice.text());
3063 // Stop if metrics have not been computed yet, since it means
3064 // that there is nothing to do.
3065 if (!tm.contains(rowSlice.pit()))
3067 ParagraphMetrics const & pm = tm.parMetrics(rowSlice.pit());
3068 Row const & row = pm.getRow(rowSlice.pos(),
3069 d->cursor_.boundary() && rowSlice == d->cursor_.top());
3070 rowSlice.pos() = row.pos();
3072 // Set the row on which the cursor lives.
3073 setCurrentRowSlice(rowSlice);
3075 // Current x position of the cursor in pixels
3076 int cur_x = getPos(d->cursor_).x_;
3078 // Horizontal scroll offset of the cursor row in pixels
3079 int offset = d->horiz_scroll_offset_;
3080 int const MARGIN = 2 * theFontMetrics(d->cursor_.real_current_font).em()
3082 if (row.right_x() <= workWidth() - row.right_margin) {
3083 // Row is narrower than the work area, no offset needed.
3086 if (cur_x - offset < MARGIN) {
3087 // cursor would be too far right
3088 offset = cur_x - MARGIN;
3089 } else if (cur_x - offset > workWidth() - MARGIN) {
3090 // cursor would be too far left
3091 offset = cur_x - workWidth() + MARGIN;
3093 // Correct the offset to make sure that we do not scroll too much
3096 if (row.right_x() - offset < workWidth() - row.right_margin)
3097 offset = row.right_x() - workWidth() + row.right_margin;
3100 //lyxerr << "cur_x=" << cur_x << ", offset=" << offset << ", row.wid=" << row.width() << ", margin=" << MARGIN << endl;
3102 if (offset != d->horiz_scroll_offset_)
3103 LYXERR(Debug::PAINTING, "Horiz. scroll offset changed from "
3104 << d->horiz_scroll_offset_ << " to " << offset);
3106 if (d->update_strategy_ == NoScreenUpdate
3107 && (offset != d->horiz_scroll_offset_
3108 || !d->last_row_slice_.empty())) {
3109 // FIXME: if one uses SingleParUpdate, then home/end
3110 // will not work on long rows. Why?
3111 d->update_strategy_ = FullScreenUpdate;
3114 d->horiz_scroll_offset_ = offset;
3118 void BufferView::draw(frontend::Painter & pain, bool paint_caret)
3120 if (height_ == 0 || width_ == 0)
3122 LYXERR(Debug::PAINTING, (pain.isNull() ? "\t\t--- START NODRAW ---"
3123 : "\t\t*** START DRAWING ***"));
3124 Text & text = buffer_.text();
3125 TextMetrics const & tm = d->text_metrics_[&text];
3126 int const y = tm.first().second->position();
3127 PainterInfo pi(this, pain);
3129 // Check whether the row where the cursor lives needs to be scrolled.
3130 // Update the drawing strategy if needed.
3131 checkCursorScrollOffset();
3133 switch (d->update_strategy_) {
3135 case NoScreenUpdate:
3136 // no screen painting is actually needed. In nodraw stage
3137 // however, the different coordinates of insets and paragraphs
3138 // needs to be updated.
3139 LYXERR(Debug::PAINTING, "Strategy: NoScreenUpdate");
3140 pi.full_repaint = false;
3141 if (pain.isNull()) {
3142 pi.full_repaint = true;
3145 pi.full_repaint = false;
3150 case SingleParUpdate:
3151 pi.full_repaint = false;
3152 LYXERR(Debug::PAINTING, "Strategy: SingleParUpdate");
3153 // In general, only the current row of the outermost paragraph
3154 // will be redrawn. Particular cases where selection spans
3155 // multiple paragraph are correctly detected in TextMetrics.
3159 case DecorationUpdate:
3160 // FIXME: We should also distinguish DecorationUpdate to avoid text
3161 // drawing if possible. This is not possible to do easily right now
3162 // because of the single backing pixmap.
3164 case FullScreenUpdate:
3166 LYXERR(Debug::PAINTING,
3167 ((d->update_strategy_ == FullScreenUpdate)
3168 ? "Strategy: FullScreenUpdate"
3169 : "Strategy: DecorationUpdate"));
3171 // The whole screen, including insets, will be refreshed.
3172 pi.full_repaint = true;
3174 // Clear background.
3175 pain.fillRectangle(0, 0, width_, height_,
3176 pi.backgroundColor(&buffer_.inset()));
3181 // and possibly grey out below
3182 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3183 int const y2 = lastpm.second->position() + lastpm.second->descent();
3186 Color color = buffer().isInternal()
3187 ? Color_background : Color_bottomarea;
3188 pain.fillRectangle(0, y2, width_, height_ - y2, color);
3192 LYXERR(Debug::PAINTING, (pain.isNull() ? "\t\t --- END NODRAW ---"
3193 : "\t\t *** END DRAWING ***"));
3195 // The scrollbar needs an update.
3198 // Normalize anchor for next time
3199 pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
3200 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3201 for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
3202 ParagraphMetrics const & pm = tm.parMetrics(pit);
3203 if (pm.position() + pm.descent() > 0) {
3204 if (d->anchor_pit_ != pit
3205 || d->anchor_ypos_ != pm.position())
3206 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
3207 << " anchor ypos = " << d->anchor_ypos_);
3208 d->anchor_pit_ = pit;
3209 d->anchor_ypos_ = pm.position();
3213 if (!pain.isNull()) {
3214 // reset the update flags, everything has been done
3215 d->update_flags_ = Update::None;
3218 // If a caret has to be painted, mark its text row as dirty to
3219 //make sure that it will be repainted on next redraw.
3220 /* FIXME: investigate whether this can be avoided when the cursor did not
3224 Row const & caret_row = d->cursor_.textRow();
3225 caret_row.changed(true);
3230 void BufferView::message(docstring const & msg)
3233 d->gui_->message(msg);
3237 void BufferView::showDialog(string const & name)
3240 d->gui_->showDialog(name, string());
3244 void BufferView::showDialog(string const & name,
3245 string const & data, Inset * inset)
3248 d->gui_->showDialog(name, data, inset);
3252 void BufferView::updateDialog(string const & name, string const & data)
3255 d->gui_->updateDialog(name, data);
3259 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
3265 // FIXME: Move this out of BufferView again
3266 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
3268 if (!fname.isReadableFile()) {
3269 docstring const error = from_ascii(strerror(errno));
3270 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3271 docstring const text =
3272 bformat(_("Could not read the specified document\n"
3273 "%1$s\ndue to the error: %2$s"), file, error);
3274 Alert::error(_("Could not read file"), text);
3278 if (!fname.isReadableFile()) {
3279 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3280 docstring const text =
3281 bformat(_("%1$s\n is not readable."), file);
3282 Alert::error(_("Could not open file"), text);
3286 // FIXME UNICODE: We don't know the encoding of the file
3287 docstring file_content = fname.fileContents("UTF-8");
3288 if (file_content.empty()) {
3289 Alert::error(_("Reading not UTF-8 encoded file"),
3290 _("The file is not UTF-8 encoded.\n"
3291 "It will be read as local 8Bit-encoded.\n"
3292 "If this does not give the correct result\n"
3293 "then please change the encoding of the file\n"
3294 "to UTF-8 with a program other than LyX.\n"));
3295 file_content = fname.fileContents("local8bit");
3298 return normalize_c(file_content);
3302 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
3304 docstring const tmpstr = contentsOfPlaintextFile(f);
3309 Cursor & cur = cursor();
3310 cap::replaceSelection(cur);
3311 buffer_.undo().recordUndo(cur);
3313 cur.innerText()->insertStringAsParagraphs(cur, tmpstr, cur.current_font);
3315 cur.innerText()->insertStringAsLines(cur, tmpstr, cur.current_font);
3317 buffer_.changed(true);
3321 docstring const & BufferView::inlineCompletion() const
3323 return d->inlineCompletion_;
3327 size_t const & BufferView::inlineCompletionUniqueChars() const
3329 return d->inlineCompletionUniqueChars_;
3333 DocIterator const & BufferView::inlineCompletionPos() const
3335 return d->inlineCompletionPos_;
3339 void BufferView::resetInlineCompletionPos()
3341 d->inlineCompletionPos_ = DocIterator();
3345 bool samePar(DocIterator const & a, DocIterator const & b)
3347 if (a.empty() && b.empty())
3349 if (a.empty() || b.empty())
3351 if (a.depth() != b.depth())
3353 return &a.innerParagraph() == &b.innerParagraph();
3357 void BufferView::setInlineCompletion(Cursor const & cur, DocIterator const & pos,
3358 docstring const & completion, size_t uniqueChars)
3360 uniqueChars = min(completion.size(), uniqueChars);
3361 bool changed = d->inlineCompletion_ != completion
3362 || d->inlineCompletionUniqueChars_ != uniqueChars;
3363 bool singlePar = true;
3364 d->inlineCompletion_ = completion;
3365 d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
3367 //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
3370 DocIterator const & old = d->inlineCompletionPos_;
3372 //lyxerr << "inlineCompletionPos changed" << std::endl;
3373 // old or pos are in another paragraph?
3374 if ((!samePar(cur, pos) && !pos.empty())
3375 || (!samePar(cur, old) && !old.empty())) {
3377 //lyxerr << "different paragraph" << std::endl;
3379 d->inlineCompletionPos_ = pos;
3384 if (singlePar && !(cur.result().screenUpdate() & Update::Force))
3385 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
3387 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::Force);
3392 bool BufferView::clickableInset() const
3394 return d->clickable_inset_;