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/Painter.h"
74 #include "frontends/Selection.h"
76 #include "support/convert.h"
77 #include "support/debug.h"
78 #include "support/ExceptionMessage.h"
79 #include "support/filetools.h"
80 #include "support/gettext.h"
81 #include "support/lassert.h"
82 #include "support/lstrings.h"
83 #include "support/Package.h"
84 #include "support/types.h"
94 using namespace lyx::support;
98 namespace Alert = frontend::Alert;
102 /// Return an inset of this class if it exists at the current cursor position
104 T * getInsetByCode(Cursor const & cur, InsetCode code)
106 DocIterator it = cur;
107 Inset * inset = it.nextInset();
108 if (inset && inset->lyxCode() == code)
109 return static_cast<T*>(inset);
114 /// Note that comparing contents can only be used for InsetCommand
115 bool findNextInset(DocIterator & dit, vector<InsetCode> const & codes,
116 docstring const & contents)
118 DocIterator tmpdit = dit;
121 Inset const * inset = tmpdit.nextInset();
123 bool const valid_code = std::find(codes.begin(), codes.end(),
124 inset->lyxCode()) != codes.end();
125 InsetCommand const * ic = inset->asInsetCommand();
126 bool const same_or_no_contents = contents.empty()
127 || (ic && (ic->getFirstNonOptParam() == contents));
129 if (valid_code && same_or_no_contents) {
134 tmpdit.forwardInset();
141 /// Looks for next inset with one of the given codes.
142 /// Note that same_content can only be used for InsetCommand
143 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
147 DocIterator tmpdit = dit;
148 tmpdit.forwardInset();
152 Inset const * inset = tmpdit.nextInset();
153 if (same_content && inset) {
154 InsetCommand const * ic = inset->asInsetCommand();
156 bool const valid_code = std::find(codes.begin(), codes.end(),
157 ic->lyxCode()) != codes.end();
159 contents = ic->getFirstNonOptParam();
163 if (!findNextInset(tmpdit, codes, contents)) {
164 if (dit.depth() != 1 || dit.pit() != 0 || dit.pos() != 0) {
165 Inset * inset = &tmpdit.bottom().inset();
166 tmpdit = doc_iterator_begin(&inset->buffer(), inset);
167 if (!findNextInset(tmpdit, codes, contents))
179 /// Looks for next inset with the given code
180 void findInset(DocIterator & dit, InsetCode code, bool same_content)
182 findInset(dit, vector<InsetCode>(1, code), same_content);
186 /// Moves cursor to the next inset with one of the given codes.
187 void gotoInset(BufferView * bv, vector<InsetCode> const & codes,
190 Cursor tmpcur = bv->cursor();
191 if (!findInset(tmpcur, codes, same_content)) {
192 bv->cursor().message(_("No more insets"));
196 tmpcur.clearSelection();
197 bv->setCursor(tmpcur);
202 /// Moves cursor to the next inset with given code.
203 void gotoInset(BufferView * bv, InsetCode code, bool same_content)
205 gotoInset(bv, vector<InsetCode>(1, code), same_content);
209 /// A map from a Text to the associated text metrics
210 typedef map<Text const *, TextMetrics> TextMetricsCache;
212 enum ScreenUpdateStrategy {
222 /////////////////////////////////////////////////////////////////////
226 /////////////////////////////////////////////////////////////////////
228 struct BufferView::Private
230 Private(BufferView & bv) : update_strategy_(NoScreenUpdate),
232 anchor_pit_(0), anchor_ypos_(0),
233 inlineCompletionUniqueChars_(0),
234 last_inset_(0), clickable_inset_(false),
235 mouse_position_cache_(),
236 bookmark_edit_position_(-1), gui_(0),
237 horiz_scroll_offset_(0)
239 xsel_cache_.set = false;
243 ScrollbarParameters scrollbarParameters_;
245 ScreenUpdateStrategy update_strategy_;
247 CoordCache coord_cache_;
249 /// Estimated average par height for scrollbar.
251 /// this is used to handle XSelection events in the right manner.
260 pit_type anchor_pit_;
264 vector<int> par_height_;
267 DocIterator inlineCompletionPos_;
269 docstring inlineCompletion_;
271 size_t inlineCompletionUniqueChars_;
273 /// keyboard mapping object.
276 /// last visited inset.
277 /** kept to send setMouseHover(false).
278 * Not owned, so don't delete.
280 Inset const * last_inset_;
281 /// are we hovering something that we can click
282 bool clickable_inset_;
284 /// position of the mouse at the time of the last mouse move
285 /// This is used to update the hovering status of inset in
286 /// cases where the buffer is scrolled, but the mouse didn't move.
287 Point mouse_position_cache_;
289 // cache for id of the paragraph which was edited the last time
290 int bookmark_edit_position_;
292 mutable TextMetricsCache text_metrics_;
295 /** Not owned, so don't delete.
297 frontend::GuiBufferViewDelegate * gui_;
299 /// Cache for Find Next
300 FuncRequest search_request_cache_;
303 map<string, Inset *> edited_insets_;
305 /// When the row where the cursor lies is scrolled, this
306 /// contains the scroll offset
307 int horiz_scroll_offset_;
308 /// a slice pointing to the start of the row where the cursor
309 /// is (at last draw time)
310 CursorSlice current_row_slice_;
311 /// a slice pointing to the start of the row where cursor was
312 /// at previous draw event
313 CursorSlice last_row_slice_;
317 BufferView::BufferView(Buffer & buf)
318 : width_(0), height_(0), full_screen_(false), buffer_(buf),
319 d(new Private(*this))
321 d->xsel_cache_.set = false;
322 d->intl_.initKeyMapper(lyxrc.use_kbmap);
324 d->cursor_.setBuffer(&buf);
325 d->cursor_.push(buffer_.inset());
326 d->cursor_.resetAnchor();
327 d->cursor_.setCurrentFont();
329 buffer_.updatePreviews();
333 BufferView::~BufferView()
335 // current buffer is going to be switched-off, save cursor pos
336 // Ideally, the whole cursor stack should be saved, but session
337 // currently can only handle bottom (whole document) level pit and pos.
338 // That is to say, if a cursor is in a nested inset, it will be
339 // restore to the left of the top level inset.
340 LastFilePosSection::FilePos fp;
341 fp.pit = d->cursor_.bottom().pit();
342 fp.pos = d->cursor_.bottom().pos();
343 theSession().lastFilePos().save(buffer_.fileName(), fp);
346 d->last_inset_->setMouseHover(this, false);
352 int BufferView::rightMargin() const
354 // The value used to be hardcoded to 10, which is 0.1in at 100dpi
355 int const default_margin = Length(0.1, Length::IN).inPixels(0);
356 // The additional test for the case the outliner is opened.
357 if (!full_screen_ || !lyxrc.full_screen_limit
358 || width_ < lyxrc.full_screen_width + 2 * default_margin)
359 return default_margin;
361 return (width_ - lyxrc.full_screen_width) / 2;
365 int BufferView::leftMargin() const
367 return rightMargin();
371 int BufferView::inPixels(Length const & len) const
373 Font const font = buffer().params().getFont();
374 return len.inPixels(workWidth(), theFontMetrics(font).em());
378 bool BufferView::isTopScreen() const
380 return 0 == d->scrollbarParameters_.min;
384 bool BufferView::isBottomScreen() const
386 return 0 == d->scrollbarParameters_.max;
390 Intl & BufferView::getIntl()
396 Intl const & BufferView::getIntl() const
402 CoordCache & BufferView::coordCache()
404 return d->coord_cache_;
408 CoordCache const & BufferView::coordCache() const
410 return d->coord_cache_;
414 Buffer & BufferView::buffer()
420 Buffer const & BufferView::buffer() const
426 bool BufferView::needsFitCursor() const
428 if (cursorStatus(d->cursor_) == CUR_INSIDE) {
429 frontend::FontMetrics const & fm =
430 theFontMetrics(d->cursor_.getFont().fontInfo());
431 int const asc = fm.maxAscent();
432 int const des = fm.maxDescent();
433 Point const p = getPos(d->cursor_);
434 if (p.y_ - asc >= 0 && p.y_ + des < height_)
441 void BufferView::processUpdateFlags(Update::flags flags)
443 // This is close to a hot-path.
444 LYXERR(Debug::PAINTING, "BufferView::processUpdateFlags()"
445 << "[fitcursor = " << (flags & Update::FitCursor)
446 << ", forceupdate = " << (flags & Update::Force)
447 << ", singlepar = " << (flags & Update::SinglePar)
448 << "] buffer: " << &buffer_);
450 // FIXME Does this really need doing here? It's done in updateBuffer, and
451 // if the Buffer doesn't need updating, then do the macros?
452 buffer_.updateMacros();
454 // Now do the first drawing step if needed. This consists on updating
455 // the CoordCache in updateMetrics().
456 // The second drawing step is done in WorkArea::redraw() if needed.
457 // FIXME: is this still true now that Buffer::changed() is used all over?
459 // Case when no explicit update is requested.
461 // no need to redraw anything.
462 d->update_strategy_ = NoScreenUpdate;
466 if (flags == Update::Decoration) {
467 d->update_strategy_ = DecorationUpdate;
468 buffer_.changed(false);
472 if (flags == Update::FitCursor
473 || flags == (Update::Decoration | Update::FitCursor)) {
474 // tell the frontend to update the screen if needed.
475 if (needsFitCursor()) {
479 if (flags & Update::Decoration) {
480 d->update_strategy_ = DecorationUpdate;
481 buffer_.changed(false);
484 // no screen update is needed in principle, but this
485 // could change if cursor row needs horizontal scrolling.
486 d->update_strategy_ = NoScreenUpdate;
487 buffer_.changed(false);
491 bool const full_metrics = flags & Update::Force || !singleParUpdate();
494 // We have to update the full screen metrics.
497 if (!(flags & Update::FitCursor)) {
498 // Nothing to do anymore. Trigger a redraw and return
499 buffer_.changed(false);
503 // updateMetrics() does not update paragraph position
504 // This is done at draw() time. So we need a redraw!
505 buffer_.changed(false);
507 if (needsFitCursor()) {
508 // The cursor is off screen so ensure it is visible.
513 updateHoveredInset();
517 void BufferView::updateScrollbar()
519 if (height_ == 0 && width_ == 0)
522 // We prefer fixed size line scrolling.
523 d->scrollbarParameters_.single_step = defaultRowHeight();
524 // We prefer full screen page scrolling.
525 d->scrollbarParameters_.page_step = height_;
527 Text & t = buffer_.text();
528 TextMetrics & tm = d->text_metrics_[&t];
530 LYXERR(Debug::GUI, " Updating scrollbar: height: "
531 << t.paragraphs().size()
532 << " curr par: " << d->cursor_.bottom().pit()
533 << " default height " << defaultRowHeight());
535 size_t const parsize = t.paragraphs().size();
536 if (d->par_height_.size() != parsize) {
537 d->par_height_.clear();
538 // FIXME: We assume a default paragraph height of 2 rows. This
539 // should probably be pondered with the screen width.
540 d->par_height_.resize(parsize, defaultRowHeight() * 2);
543 // Look at paragraph heights on-screen
544 pair<pit_type, ParagraphMetrics const *> first = tm.first();
545 pair<pit_type, ParagraphMetrics const *> last = tm.last();
546 for (pit_type pit = first.first; pit <= last.first; ++pit) {
547 d->par_height_[pit] = tm.parMetrics(pit).height();
548 LYXERR(Debug::SCROLLING, "storing height for pit " << pit << " : "
549 << d->par_height_[pit]);
552 int top_pos = first.second->position() - first.second->ascent();
553 int bottom_pos = last.second->position() + last.second->descent();
554 bool first_visible = first.first == 0 && top_pos >= 0;
555 bool last_visible = last.first + 1 == int(parsize) && bottom_pos <= height_;
556 if (first_visible && last_visible) {
557 d->scrollbarParameters_.min = 0;
558 d->scrollbarParameters_.max = 0;
562 d->scrollbarParameters_.min = top_pos;
563 for (size_t i = 0; i != size_t(first.first); ++i)
564 d->scrollbarParameters_.min -= d->par_height_[i];
565 d->scrollbarParameters_.max = bottom_pos;
566 for (size_t i = last.first + 1; i != parsize; ++i)
567 d->scrollbarParameters_.max += d->par_height_[i];
569 // The reference is the top position so we remove one page.
570 if (lyxrc.scroll_below_document)
571 d->scrollbarParameters_.max -= minVisiblePart();
573 d->scrollbarParameters_.max -= d->scrollbarParameters_.page_step;
575 // 0 must be inside the range as it denotes the current position
576 if (d->scrollbarParameters_.max < 0)
577 d->scrollbarParameters_.max = 0;
578 if (d->scrollbarParameters_.min > 0)
579 d->scrollbarParameters_.min = 0;
583 ScrollbarParameters const & BufferView::scrollbarParameters() const
585 return d->scrollbarParameters_;
589 docstring BufferView::toolTip(int x, int y) const
591 // Get inset under mouse, if there is one.
592 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
594 // No inset, no tooltip...
596 return covering_inset->toolTip(*this, x, y);
600 string BufferView::contextMenu(int x, int y) const
602 //If there is a selection, return the containing inset menu
603 if (d->cursor_.selection())
604 return d->cursor_.inset().contextMenu(*this, x, y);
606 // Get inset under mouse, if there is one.
607 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
609 return covering_inset->contextMenu(*this, x, y);
611 return buffer_.inset().contextMenu(*this, x, y);
616 void BufferView::scrollDocView(int const value, bool update)
618 // The scrollbar values are relative to the top of the screen, therefore the
619 // offset is equal to the target value.
621 // No scrolling at all? No need to redraw anything
625 // If the offset is less than 2 screen height, prefer to scroll instead.
626 if (abs(value) <= 2 * height_) {
627 d->anchor_ypos_ -= value;
628 buffer_.changed(true);
629 updateHoveredInset();
633 // cut off at the top
634 if (value <= d->scrollbarParameters_.min) {
635 DocIterator dit = doc_iterator_begin(&buffer_);
636 showCursor(dit, false, update);
637 LYXERR(Debug::SCROLLING, "scroll to top");
641 // cut off at the bottom
642 if (value >= d->scrollbarParameters_.max) {
643 DocIterator dit = doc_iterator_end(&buffer_);
645 showCursor(dit, false, update);
646 LYXERR(Debug::SCROLLING, "scroll to bottom");
650 // find paragraph at target position
651 int par_pos = d->scrollbarParameters_.min;
653 for (; i != int(d->par_height_.size()); ++i) {
654 par_pos += d->par_height_[i];
655 if (par_pos >= value)
659 if (par_pos < value) {
660 // It seems we didn't find the correct pit so stay on the safe side and
662 LYXERR0("scrolling position not found!");
663 scrollDocView(d->scrollbarParameters_.max, update);
667 DocIterator dit = doc_iterator_begin(&buffer_);
669 LYXERR(Debug::SCROLLING, "value = " << value << " -> scroll to pit " << i);
670 showCursor(dit, false, update);
674 // FIXME: this method is not working well.
675 void BufferView::setCursorFromScrollbar()
677 TextMetrics & tm = d->text_metrics_[&buffer_.text()];
679 int const height = 2 * defaultRowHeight();
680 int const first = height;
681 int const last = height_ - height;
683 Cursor const & oldcur = d->cursor_;
685 switch (cursorStatus(oldcur)) {
693 int const y = getPos(oldcur).y_;
694 newy = min(last, max(y, first));
698 // We reset the cursor because cursorStatus() does not
699 // work when the cursor is within mathed.
702 tm.setCursorFromCoordinates(cur, 0, newy);
704 // update the bufferview cursor and notify insets
705 // FIXME: Care about the d->cursor_ flags to redraw if needed
706 Cursor old = d->cursor_;
708 // the DEPM call in mouseSetCursor() might have destroyed the
709 // paragraph the cursor is in.
710 bool badcursor = old.fixIfBroken();
711 badcursor |= notifyCursorLeavesOrEnters(old, d->cursor_);
713 d->cursor_.fixIfBroken();
717 Change const BufferView::getCurrentChange() const
719 if (!d->cursor_.selection())
720 return Change(Change::UNCHANGED);
722 DocIterator dit = d->cursor_.selectionBegin();
723 // The selected content might have been changed (see #7685)
724 dit = dit.getInnerText();
725 return dit.paragraph().lookupChange(dit.pos());
729 // this could be used elsewhere as well?
730 // FIXME: This does not work within mathed!
731 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
733 Point const p = getPos(dit);
736 if (p.y_ > workHeight())
742 void BufferView::bookmarkEditPosition()
744 // Don't eat cpu time for each keystroke
745 if (d->cursor_.paragraph().id() == d->bookmark_edit_position_)
748 d->bookmark_edit_position_ = d->cursor_.paragraph().id();
752 void BufferView::saveBookmark(unsigned int idx)
754 // tentatively save bookmark, id and pos will be used to
755 // acturately locate a bookmark in a 'live' lyx session.
756 // pit and pos will be updated with bottom level pit/pos
758 if (!buffer_.isInternal()) {
759 theSession().bookmarks().save(
761 d->cursor_.bottom().pit(),
762 d->cursor_.bottom().pos(),
763 d->cursor_.paragraph().id(),
768 // emit message signal.
769 message(_("Save bookmark"));
774 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
775 int top_id, pos_type top_pos)
777 bool success = false;
780 d->cursor_.clearSelection();
782 // if a valid par_id is given, try it first
783 // This is the case for a 'live' bookmark when unique paragraph ID
784 // is used to track bookmarks.
786 dit = buffer_.getParFromID(top_id);
788 dit.pos() = min(dit.paragraph().size(), top_pos);
789 // Some slices of the iterator may not be
790 // reachable (e.g. closed collapsible inset)
791 // so the dociterator may need to be
792 // shortened. Otherwise, setCursor may crash
793 // lyx when the cursor can not be set to these
795 size_t const n = dit.depth();
796 for (size_t i = 0; i < n; ++i)
797 if (!dit[i].inset().editable()) {
805 // if top_id == 0, or searching through top_id failed
806 // This is the case for a 'restored' bookmark when only bottom
807 // (document level) pit was saved. Because of this, bookmark
808 // restoration is inaccurate. If a bookmark was within an inset,
809 // it will be restored to the left of the outmost inset that contains
811 if (bottom_pit < int(buffer_.paragraphs().size())) {
812 dit = doc_iterator_begin(&buffer_);
814 dit.pit() = bottom_pit;
815 dit.pos() = min(bottom_pos, dit.paragraph().size());
820 // Note: only bottom (document) level pit is set.
822 // set the current font.
823 d->cursor_.setCurrentFont();
824 // Do not forget to reset the anchor (see #9912)
825 d->cursor_.resetAnchor();
826 // To center the screen on this new position we need the
827 // paragraph position which is computed at draw() time.
828 // So we need a redraw!
829 buffer_.changed(false);
830 if (needsFitCursor())
838 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
840 if (d->cursor_.real_current_font.isRightToLeft()) {
841 if (d->intl_.keymap == Intl::PRIMARY)
842 d->intl_.keyMapSec();
844 if (d->intl_.keymap == Intl::SECONDARY)
845 d->intl_.keyMapPrim();
848 d->intl_.getTransManager().translateAndInsert(c, t, cur);
852 int BufferView::workWidth() const
858 void BufferView::recenter()
860 showCursor(d->cursor_, true, true);
864 void BufferView::showCursor()
866 showCursor(d->cursor_, false, true);
870 void BufferView::showCursor(DocIterator const & dit,
871 bool recenter, bool update)
873 if (scrollToCursor(dit, recenter) && update) {
874 buffer_.changed(true);
875 updateHoveredInset();
880 void BufferView::scrollToCursor()
882 if (scrollToCursor(d->cursor_, false)) {
883 buffer_.changed(true);
884 updateHoveredInset();
889 bool BufferView::scrollToCursor(DocIterator const & dit, bool const recenter)
891 // We are not properly started yet, delay until resizing is
896 LYXERR(Debug::SCROLLING, "recentering!");
898 CursorSlice const & bot = dit.bottom();
899 TextMetrics & tm = d->text_metrics_[bot.text()];
901 pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
902 int bot_pit = bot.pit();
903 if (bot_pit > max_pit) {
904 // FIXME: Why does this happen?
905 LYXERR0("bottom pit is greater that max pit: "
906 << bot_pit << " > " << max_pit);
910 if (bot_pit == tm.first().first - 1)
911 tm.newParMetricsUp();
912 else if (bot_pit == tm.last().first + 1)
913 tm.newParMetricsDown();
915 if (tm.contains(bot_pit)) {
916 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
917 LBUFERR(!pm.rows().empty());
918 // FIXME: smooth scrolling doesn't work in mathed.
919 CursorSlice const & cs = dit.innerTextSlice();
920 int offset = coordOffset(dit).y_;
921 int ypos = pm.position() + offset;
922 Dimension const & row_dim =
923 pm.getRow(cs.pos(), dit.boundary()).dimension();
926 scrolled = scroll(ypos - height_/2);
928 // We try to visualize the whole row, if the row height is larger than
929 // the screen height, we scroll to a heuristic value of height_ / 4.
930 // FIXME: This heuristic value should be replaced by a recursive search
931 // for a row in the inset that can be visualized completely.
932 else if (row_dim.height() > height_) {
933 if (ypos < defaultRowHeight())
934 scrolled = scroll(ypos - height_ / 4);
935 else if (ypos > height_ - defaultRowHeight())
936 scrolled = scroll(ypos - 3 * height_ / 4);
939 // If the top part of the row falls of the screen, we scroll
940 // up to align the top of the row with the top of the screen.
941 else if (ypos - row_dim.ascent() < 0 && ypos < height_) {
942 int ynew = row_dim.ascent();
943 scrolled = scrollUp(ynew - ypos);
946 // If the bottom of the row falls of the screen, we scroll down.
947 else if (ypos + row_dim.descent() > height_ && ypos > 0) {
948 int ynew = height_ - row_dim.descent();
949 scrolled = scrollDown(ypos - ynew);
952 // else, nothing to do, the cursor is already visible so we just return.
953 return scrolled != 0;
956 // fix inline completion position
957 if (d->inlineCompletionPos_.fixIfBroken())
958 d->inlineCompletionPos_ = DocIterator();
960 tm.redoParagraph(bot_pit);
961 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
962 int offset = coordOffset(dit).y_;
964 d->anchor_pit_ = bot_pit;
965 CursorSlice const & cs = dit.innerTextSlice();
966 Dimension const & row_dim =
967 pm.getRow(cs.pos(), dit.boundary()).dimension();
970 d->anchor_ypos_ = height_/2;
971 else if (d->anchor_pit_ == 0)
972 d->anchor_ypos_ = offset + pm.ascent();
973 else if (d->anchor_pit_ == max_pit)
974 d->anchor_ypos_ = height_ - offset - row_dim.descent();
975 else if (offset > height_)
976 d->anchor_ypos_ = height_ - offset - defaultRowHeight();
978 d->anchor_ypos_ = defaultRowHeight() * 2;
984 void BufferView::makeDocumentClass()
986 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
987 buffer_.params().makeDocumentClass();
988 updateDocumentClass(olddc);
992 void BufferView::updateDocumentClass(DocumentClassConstPtr olddc)
994 message(_("Converting document to new document class..."));
996 StableDocIterator backcur(d->cursor_);
997 ErrorList & el = buffer_.errorList("Class Switch");
998 cap::switchBetweenClasses(
999 olddc, buffer_.params().documentClassPtr(),
1000 static_cast<InsetText &>(buffer_.inset()), el);
1002 setCursor(backcur.asDocIterator(&buffer_));
1004 buffer_.errors("Class Switch");
1008 /** Return the change status at cursor position, taking into account the
1009 * status at each level of the document iterator (a table in a deleted
1010 * footnote is deleted).
1011 * When \param outer is true, the top slice is not looked at.
1013 static Change::Type lookupChangeType(DocIterator const & dit, bool outer = false)
1015 size_t const depth = dit.depth() - (outer ? 1 : 0);
1017 for (size_t i = 0 ; i < depth ; ++i) {
1018 CursorSlice const & slice = dit[i];
1019 if (!slice.inset().inMathed()
1020 && slice.pos() < slice.paragraph().size()) {
1021 Change::Type const ch = slice.paragraph().lookupChange(slice.pos()).type;
1022 if (ch != Change::UNCHANGED)
1026 return Change::UNCHANGED;
1030 bool BufferView::getStatus(FuncRequest const & cmd, FuncStatus & flag)
1032 FuncCode const act = cmd.action();
1034 // Can we use a readonly buffer?
1035 if (buffer_.isReadonly()
1036 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1037 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1038 if (buffer_.hasReadonlyFlag())
1039 flag.message(from_utf8(N_("Document is read-only")));
1041 flag.message(from_utf8(N_("Document has been modified externally")));
1042 flag.setEnabled(false);
1046 // Are we in a DELETED change-tracking region?
1047 if (lookupChangeType(d->cursor_, true) == Change::DELETED
1048 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1049 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1050 flag.message(from_utf8(N_("This portion of the document is deleted.")));
1051 flag.setEnabled(false);
1055 Cursor & cur = d->cursor_;
1057 if (cur.getStatus(cmd, flag))
1062 // FIXME: This is a bit problematic because we don't check if this is
1063 // a document BufferView or not for these LFUNs. We probably have to
1064 // dispatch both to currentBufferView() and, if that fails,
1065 // to documentBufferView(); same as we do now for current Buffer and
1066 // document Buffer. Ideally those LFUN should go to Buffer as they
1067 // operate on the full Buffer and the cursor is only needed either for
1068 // an Undo record or to restore a cursor position. But we don't know
1069 // how to do that inside Buffer of course.
1070 case LFUN_BUFFER_PARAMS_APPLY:
1071 case LFUN_LAYOUT_MODULES_CLEAR:
1072 case LFUN_LAYOUT_MODULE_ADD:
1073 case LFUN_LAYOUT_RELOAD:
1074 case LFUN_TEXTCLASS_APPLY:
1075 case LFUN_TEXTCLASS_LOAD:
1076 flag.setEnabled(!buffer_.isReadonly());
1080 // We do not use the LyXAction flag for readonly because Undo sets the
1081 // buffer clean/dirty status by itself.
1082 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasUndoStack());
1085 // We do not use the LyXAction flag for readonly because Redo sets the
1086 // buffer clean/dirty status by itself.
1087 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasRedoStack());
1089 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
1090 case LFUN_FILE_INSERT_PLAINTEXT: {
1091 docstring const fname = cmd.argument();
1092 if (!FileName::isAbsolute(to_utf8(fname))) {
1093 flag.message(_("Absolute filename expected."));
1096 flag.setEnabled(cur.inTexted());
1099 case LFUN_FILE_INSERT:
1100 case LFUN_BOOKMARK_SAVE:
1101 // FIXME: Actually, these LFUNS should be moved to Text
1102 flag.setEnabled(cur.inTexted());
1105 case LFUN_FONT_STATE:
1106 case LFUN_LABEL_INSERT:
1107 case LFUN_INFO_INSERT:
1108 case LFUN_PARAGRAPH_GOTO:
1109 case LFUN_NOTE_NEXT:
1110 case LFUN_REFERENCE_NEXT:
1111 case LFUN_WORD_FIND:
1112 case LFUN_WORD_FIND_FORWARD:
1113 case LFUN_WORD_FIND_BACKWARD:
1114 case LFUN_WORD_REPLACE:
1117 case LFUN_MARK_TOGGLE:
1118 case LFUN_SCREEN_RECENTER:
1119 case LFUN_SCREEN_SHOW_CURSOR:
1120 case LFUN_BIBTEX_DATABASE_ADD:
1121 case LFUN_BIBTEX_DATABASE_DEL:
1122 case LFUN_STATISTICS:
1123 case LFUN_KEYMAP_OFF:
1124 case LFUN_KEYMAP_PRIMARY:
1125 case LFUN_KEYMAP_SECONDARY:
1126 case LFUN_KEYMAP_TOGGLE:
1127 case LFUN_INSET_SELECT_ALL:
1128 flag.setEnabled(true);
1131 case LFUN_WORD_FINDADV: {
1132 FindAndReplaceOptions opt;
1133 istringstream iss(to_utf8(cmd.argument()));
1135 flag.setEnabled(opt.repl_buf_name.empty()
1136 || !buffer_.isReadonly());
1140 case LFUN_LABEL_GOTO:
1141 flag.setEnabled(!cmd.argument().empty()
1142 || getInsetByCode<InsetRef>(cur, REF_CODE));
1145 case LFUN_CHANGES_MERGE:
1146 case LFUN_CHANGE_NEXT:
1147 case LFUN_CHANGE_PREVIOUS:
1148 case LFUN_ALL_CHANGES_ACCEPT:
1149 case LFUN_ALL_CHANGES_REJECT:
1150 flag.setEnabled(buffer_.areChangesPresent());
1153 case LFUN_SCREEN_UP:
1154 case LFUN_SCREEN_DOWN:
1156 case LFUN_SCREEN_UP_SELECT:
1157 case LFUN_SCREEN_DOWN_SELECT:
1158 case LFUN_INSET_FORALL:
1159 flag.setEnabled(true);
1162 case LFUN_LAYOUT_TABULAR:
1163 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
1167 flag.setEnabled(!cur.inset().forcePlainLayout(cur.idx()));
1170 case LFUN_LAYOUT_PARAGRAPH:
1171 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
1174 case LFUN_BRANCH_ADD_INSERT:
1175 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1178 case LFUN_DIALOG_SHOW_NEW_INSET:
1179 // FIXME: this is wrong, but I do not understand the
1181 if (cur.inset().lyxCode() == CAPTION_CODE)
1182 return cur.inset().getStatus(cur, cmd, flag);
1183 // FIXME we should consider passthru paragraphs too.
1184 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1187 case LFUN_CITATION_INSERT: {
1188 FuncRequest fr(LFUN_INSET_INSERT, "citation");
1189 // FIXME: This could turn in a recursive hell.
1190 // Shouldn't we use Buffer::getStatus() instead?
1191 flag.setEnabled(lyx::getStatus(fr).enabled());
1194 case LFUN_INSET_APPLY: {
1195 string const name = cmd.getArg(0);
1196 Inset * inset = editedInset(name);
1198 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1199 if (!inset->getStatus(cur, fr, flag)) {
1200 // Every inset is supposed to handle this
1201 LASSERT(false, break);
1204 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1205 flag = lyx::getStatus(fr);
1218 Inset * BufferView::editedInset(string const & name) const
1220 map<string, Inset *>::const_iterator it = d->edited_insets_.find(name);
1221 return it == d->edited_insets_.end() ? 0 : it->second;
1225 void BufferView::editInset(string const & name, Inset * inset)
1227 d->edited_insets_[name] = inset;
1231 void BufferView::dispatch(FuncRequest const & cmd, DispatchResult & dr)
1233 LYXERR(Debug::ACTION, "BufferView::dispatch: cmd: " << cmd);
1235 string const argument = to_utf8(cmd.argument());
1236 Cursor & cur = d->cursor_;
1239 // Don't dispatch function that does not apply to internal buffers.
1240 if (buffer_.isInternal()
1241 && lyxaction.funcHasFlag(cmd.action(), LyXAction::NoInternal))
1244 // We'll set this back to false if need be.
1245 bool dispatched = true;
1246 buffer_.undo().beginUndoGroup();
1248 FuncCode const act = cmd.action();
1251 case LFUN_BUFFER_PARAMS_APPLY: {
1252 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1253 cur.recordUndoBufferParams();
1254 istringstream ss(to_utf8(cmd.argument()));
1257 int const unknown_tokens = buffer_.readHeader(lex);
1258 if (unknown_tokens != 0) {
1259 LYXERR0("Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1260 << unknown_tokens << " unknown token"
1261 << (unknown_tokens == 1 ? "" : "s"));
1263 updateDocumentClass(olddc);
1265 // We are most certainly here because of a change in the document
1266 // It is then better to make sure that all dialogs are in sync with
1267 // current document settings.
1268 dr.screenUpdate(Update::Force | Update::FitCursor);
1269 dr.forceBufferUpdate();
1273 case LFUN_LAYOUT_MODULES_CLEAR: {
1274 // FIXME: this modifies the document in cap::switchBetweenClasses
1275 // without calling recordUndo. Fix this before using
1276 // recordUndoBufferParams().
1277 cur.recordUndoFullBuffer();
1278 buffer_.params().clearLayoutModules();
1279 makeDocumentClass();
1280 dr.screenUpdate(Update::Force);
1281 dr.forceBufferUpdate();
1285 case LFUN_LAYOUT_MODULE_ADD: {
1286 BufferParams const & params = buffer_.params();
1287 if (!params.layoutModuleCanBeAdded(argument)) {
1288 LYXERR0("Module `" << argument <<
1289 "' cannot be added due to failed requirements or "
1290 "conflicts with installed modules.");
1293 // FIXME: this modifies the document in cap::switchBetweenClasses
1294 // without calling recordUndo. Fix this before using
1295 // recordUndoBufferParams().
1296 cur.recordUndoFullBuffer();
1297 buffer_.params().addLayoutModule(argument);
1298 makeDocumentClass();
1299 dr.screenUpdate(Update::Force);
1300 dr.forceBufferUpdate();
1304 case LFUN_TEXTCLASS_APPLY: {
1305 // since this shortcircuits, the second call is made only if
1307 bool const success =
1308 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1309 LayoutFileList::get().load(argument, buffer_.filePath());
1311 docstring s = bformat(_("The document class `%1$s' "
1312 "could not be loaded."), from_utf8(argument));
1313 frontend::Alert::error(_("Could not load class"), s);
1317 LayoutFile const * old_layout = buffer_.params().baseClass();
1318 LayoutFile const * new_layout = &(LayoutFileList::get()[argument]);
1320 if (old_layout == new_layout)
1324 // Save the old, possibly modular, layout for use in conversion.
1325 // FIXME: this modifies the document in cap::switchBetweenClasses
1326 // without calling recordUndo. Fix this before using
1327 // recordUndoBufferParams().
1328 cur.recordUndoFullBuffer();
1329 buffer_.params().setBaseClass(argument);
1330 makeDocumentClass();
1331 dr.screenUpdate(Update::Force);
1332 dr.forceBufferUpdate();
1336 case LFUN_TEXTCLASS_LOAD: {
1337 // since this shortcircuits, the second call is made only if
1339 bool const success =
1340 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1341 LayoutFileList::get().load(argument, buffer_.filePath());
1343 docstring s = bformat(_("The document class `%1$s' "
1344 "could not be loaded."), from_utf8(argument));
1345 frontend::Alert::error(_("Could not load class"), s);
1350 case LFUN_LAYOUT_RELOAD: {
1351 LayoutFileIndex bc = buffer_.params().baseClassID();
1352 LayoutFileList::get().reset(bc);
1353 buffer_.params().setBaseClass(bc);
1354 makeDocumentClass();
1355 dr.screenUpdate(Update::Force);
1356 dr.forceBufferUpdate();
1361 dr.setMessage(_("Undo"));
1362 cur.clearSelection();
1363 if (!cur.textUndo())
1364 dr.setMessage(_("No further undo information"));
1366 dr.screenUpdate(Update::Force | Update::FitCursor);
1367 dr.forceBufferUpdate();
1371 dr.setMessage(_("Redo"));
1372 cur.clearSelection();
1373 if (!cur.textRedo())
1374 dr.setMessage(_("No further redo information"));
1376 dr.screenUpdate(Update::Force | Update::FitCursor);
1377 dr.forceBufferUpdate();
1380 case LFUN_FONT_STATE:
1381 dr.setMessage(cur.currentState(false));
1384 case LFUN_BOOKMARK_SAVE:
1385 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1388 case LFUN_LABEL_GOTO: {
1389 docstring label = cmd.argument();
1390 if (label.empty()) {
1392 getInsetByCode<InsetRef>(cur, REF_CODE);
1394 label = inset->getParam("reference");
1395 // persistent=false: use temp_bookmark
1399 if (!label.empty()) {
1401 // at the moment, this is redundant, since gotoLabel will
1402 // eventually call LFUN_PARAGRAPH_GOTO, but it seems best
1404 dr.screenUpdate(Update::Force | Update::FitCursor);
1409 case LFUN_PARAGRAPH_GOTO: {
1410 int const id = convert<int>(cmd.getArg(0));
1411 pos_type const pos = convert<int>(cmd.getArg(1));
1414 string const str_id_end = cmd.getArg(2);
1415 string const str_pos_end = cmd.getArg(3);
1417 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1418 b = theBufferList().next(b)) {
1421 cur.setCursor(b->getParFromID(id));
1423 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1427 LYXERR(Debug::INFO, "Paragraph " << cur.paragraph().id()
1428 << " found in buffer `"
1429 << b->absFileName() << "'.");
1431 if (b == &buffer_) {
1433 if (str_id_end.empty() || str_pos_end.empty()) {
1436 mouseSetCursor(cur);
1439 int const id_end = convert<int>(str_id_end);
1440 pos_type const pos_end = convert<int>(str_pos_end);
1441 success = setCursorFromEntries({id, pos},
1445 dr.screenUpdate(Update::Force | Update::FitCursor);
1447 // Switch to other buffer view and resend cmd
1448 lyx::dispatch(FuncRequest(
1449 LFUN_BUFFER_SWITCH, b->absFileName()));
1457 case LFUN_NOTE_NEXT:
1458 gotoInset(this, NOTE_CODE, false);
1461 case LFUN_REFERENCE_NEXT: {
1462 vector<InsetCode> tmp;
1463 tmp.push_back(LABEL_CODE);
1464 tmp.push_back(REF_CODE);
1465 gotoInset(this, tmp, true);
1469 case LFUN_CHANGE_NEXT:
1470 findNextChange(this);
1471 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1472 dr.screenUpdate(Update::Force | Update::FitCursor);
1475 case LFUN_CHANGE_PREVIOUS:
1476 findPreviousChange(this);
1477 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1478 dr.screenUpdate(Update::Force | Update::FitCursor);
1481 case LFUN_CHANGES_MERGE:
1482 if (findNextChange(this) || findPreviousChange(this)) {
1483 dr.screenUpdate(Update::Force | Update::FitCursor);
1484 dr.forceBufferUpdate();
1485 showDialog("changes");
1489 case LFUN_ALL_CHANGES_ACCEPT:
1490 // select complete document
1492 cur.selHandle(true);
1493 buffer_.text().cursorBottom(cur);
1494 // accept everything in a single step to support atomic undo
1495 buffer_.text().acceptOrRejectChanges(cur, Text::ACCEPT);
1497 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1498 dr.screenUpdate(Update::Force | Update::FitCursor);
1499 dr.forceBufferUpdate();
1502 case LFUN_ALL_CHANGES_REJECT:
1503 // select complete document
1505 cur.selHandle(true);
1506 buffer_.text().cursorBottom(cur);
1507 // reject everything in a single step to support atomic undo
1508 // Note: reject does not work recursively; the user may have to repeat the operation
1509 buffer_.text().acceptOrRejectChanges(cur, Text::REJECT);
1511 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1512 dr.screenUpdate(Update::Force | Update::FitCursor);
1513 dr.forceBufferUpdate();
1516 case LFUN_WORD_FIND_FORWARD:
1517 case LFUN_WORD_FIND_BACKWARD: {
1519 // Would it maybe be better if this variable were view specific anyway?
1520 static docstring last_search;
1521 docstring searched_string;
1523 if (!cmd.argument().empty()) {
1524 last_search = cmd.argument();
1525 searched_string = cmd.argument();
1527 searched_string = last_search;
1530 if (searched_string.empty())
1533 bool const fw = act == LFUN_WORD_FIND_FORWARD;
1534 docstring const data =
1535 find2string(searched_string, true, false, fw);
1536 bool found = lyxfind(this, FuncRequest(LFUN_WORD_FIND, data));
1538 dr.screenUpdate(Update::Force | Update::FitCursor);
1542 case LFUN_WORD_FIND: {
1543 FuncRequest req = cmd;
1544 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1545 req = d->search_request_cache_;
1546 if (req.argument().empty()) {
1547 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, "findreplace"));
1550 if (lyxfind(this, req))
1551 dr.screenUpdate(Update::Force | Update::FitCursor);
1553 d->search_request_cache_ = req;
1557 case LFUN_WORD_REPLACE: {
1558 bool has_deleted = false;
1559 if (cur.selection()) {
1560 DocIterator beg = cur.selectionBegin();
1561 DocIterator end = cur.selectionEnd();
1562 if (beg.pit() == end.pit()) {
1563 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1564 if (!cur.inMathed() && cur.paragraph().isDeleted(p)) {
1571 if (lyxreplace(this, cmd, has_deleted)) {
1572 dr.forceBufferUpdate();
1573 dr.screenUpdate(Update::Force | Update::FitCursor);
1578 case LFUN_WORD_FINDADV: {
1579 FindAndReplaceOptions opt;
1580 istringstream iss(to_utf8(cmd.argument()));
1582 if (findAdv(this, opt)) {
1583 dr.screenUpdate(Update::Force | Update::FitCursor);
1594 cur.clearSelection();
1595 dr.setMessage(from_utf8(N_("Mark off")));
1599 cur.clearSelection();
1601 dr.setMessage(from_utf8(N_("Mark on")));
1604 case LFUN_MARK_TOGGLE:
1605 cur.selection(false);
1608 dr.setMessage(from_utf8(N_("Mark removed")));
1611 dr.setMessage(from_utf8(N_("Mark set")));
1616 case LFUN_SCREEN_SHOW_CURSOR:
1620 case LFUN_SCREEN_RECENTER:
1624 case LFUN_BIBTEX_DATABASE_ADD: {
1625 Cursor tmpcur = cur;
1626 findInset(tmpcur, BIBTEX_CODE, false);
1627 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1630 if (inset->addDatabase(cmd.argument())) {
1631 buffer_.invalidateBibfileCache();
1632 dr.forceBufferUpdate();
1638 case LFUN_BIBTEX_DATABASE_DEL: {
1639 Cursor tmpcur = cur;
1640 findInset(tmpcur, BIBTEX_CODE, false);
1641 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1644 if (inset->delDatabase(cmd.argument())) {
1645 buffer_.invalidateBibfileCache();
1646 dr.forceBufferUpdate();
1652 case LFUN_STATISTICS: {
1653 DocIterator from, to;
1654 if (cur.selection()) {
1655 from = cur.selectionBegin();
1656 to = cur.selectionEnd();
1658 from = doc_iterator_begin(&buffer_);
1659 to = doc_iterator_end(&buffer_);
1661 buffer_.updateStatistics(from, to);
1662 int const words = buffer_.wordCount();
1663 int const chars = buffer_.charCount(false);
1664 int const chars_blanks = buffer_.charCount(true);
1666 if (cur.selection())
1667 message = _("Statistics for the selection:");
1669 message = _("Statistics for the document:");
1672 message += bformat(_("%1$d words"), words);
1674 message += _("One word");
1676 if (chars_blanks != 1)
1677 message += bformat(_("%1$d characters (including blanks)"),
1680 message += _("One character (including blanks)");
1683 message += bformat(_("%1$d characters (excluding blanks)"),
1686 message += _("One character (excluding blanks)");
1688 Alert::information(_("Statistics"), message);
1692 case LFUN_SCREEN_UP:
1693 case LFUN_SCREEN_DOWN: {
1694 Point p = getPos(cur);
1695 // This code has been commented out to enable to scroll down a
1696 // document, even if there are large insets in it (see bug #5465).
1697 /*if (p.y_ < 0 || p.y_ > height_) {
1698 // The cursor is off-screen so recenter before proceeding.
1702 int const scrolled = scroll(act == LFUN_SCREEN_UP
1703 ? -height_ : height_);
1704 if (act == LFUN_SCREEN_UP && scrolled > -height_)
1706 if (act == LFUN_SCREEN_DOWN && scrolled < height_)
1707 p = Point(width_, height_);
1708 bool const in_texted = cur.inTexted();
1709 cur.setCursor(doc_iterator_begin(cur.buffer()));
1710 cur.selHandle(false);
1711 buffer_.changed(true);
1712 updateHoveredInset();
1714 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_,
1715 true, act == LFUN_SCREEN_UP);
1716 //FIXME: what to do with cur.x_target()?
1717 bool update = in_texted && cur.bv().checkDepm(cur, old);
1720 if (update || cur.mark())
1721 dr.screenUpdate(Update::Force | Update::FitCursor);
1723 dr.forceBufferUpdate();
1728 string const scroll_type = cmd.getArg(0);
1729 int scroll_step = 0;
1730 if (scroll_type == "line")
1731 scroll_step = d->scrollbarParameters_.single_step;
1732 else if (scroll_type == "page")
1733 scroll_step = d->scrollbarParameters_.page_step;
1736 string const scroll_quantity = cmd.getArg(1);
1737 if (scroll_quantity == "up")
1738 scrollUp(scroll_step);
1739 else if (scroll_quantity == "down")
1740 scrollDown(scroll_step);
1742 int const scroll_value = convert<int>(scroll_quantity);
1744 scroll(scroll_step * scroll_value);
1746 buffer_.changed(true);
1747 updateHoveredInset();
1748 dr.forceBufferUpdate();
1752 case LFUN_SCREEN_UP_SELECT: {
1753 // FIXME: why is the algorithm different from LFUN_SCREEN_UP?
1754 cur.selHandle(true);
1755 if (isTopScreen()) {
1756 lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1760 int y = getPos(cur).y_;
1761 int const ymin = y - height_ + defaultRowHeight();
1762 while (y > ymin && cur.up())
1766 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1770 case LFUN_SCREEN_DOWN_SELECT: {
1771 // FIXME: why is the algorithm different from LFUN_SCREEN_DOWN?
1772 cur.selHandle(true);
1773 if (isBottomScreen()) {
1774 lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1778 int y = getPos(cur).y_;
1779 int const ymax = y + height_ - defaultRowHeight();
1780 while (y < ymax && cur.down())
1784 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1789 case LFUN_INSET_SELECT_ALL: {
1790 // true if all cells are selected
1791 bool const all_selected = cur.depth() > 1
1792 && cur.selBegin().at_begin()
1793 && cur.selEnd().at_end();
1794 // true if some cells are selected
1795 bool const cells_selected = cur.depth() > 1
1796 && cur.selBegin().at_cell_begin()
1797 && cur.selEnd().at_cell_end();
1798 if (all_selected || (cells_selected && !cur.inset().isTable())) {
1799 // All the contents of the inset if selected, or only at
1800 // least one cell but inset is not a table.
1801 // Select the inset from outside.
1804 cur.selection(true);
1806 } else if (cells_selected) {
1807 // At least one complete cell is selected and inset is a table.
1812 cur.selection(true);
1813 cur.idx() = cur.lastidx();
1814 cur.pos() = cur.lastpos();
1816 // select current cell
1820 cur.selection(true);
1821 cur.pit() = cur.lastpit();
1822 cur.pos() = cur.lastpos();
1824 cur.setCurrentFont();
1825 dr.screenUpdate(Update::Force);
1830 // This would be in Buffer class if only Cursor did not
1831 // require a bufferview
1832 case LFUN_INSET_FORALL: {
1833 docstring const name = from_utf8(cmd.getArg(0));
1834 string const commandstr = cmd.getLongArg(1);
1835 FuncRequest const fr = lyxaction.lookupFunc(commandstr);
1837 // an arbitrary number to limit number of iterations
1838 const int max_iter = 100000;
1840 Cursor & cur = d->cursor_;
1841 Cursor const savecur = cur;
1843 if (!cur.nextInset())
1845 cur.beginUndoGroup();
1846 while(cur && iterations < max_iter) {
1847 Inset * const ins = cur.nextInset();
1850 docstring insname = ins->layoutName();
1851 while (!insname.empty()) {
1852 if (insname == name || name == from_utf8("*")) {
1854 lyx::dispatch(fr, dr);
1858 size_t const i = insname.rfind(':');
1859 if (i == string::npos)
1861 insname = insname.substr(0, i);
1863 // if we did not delete the inset, skip it
1864 if (!cur.nextInset() || cur.nextInset() == ins)
1869 /** This is a dummy undo record only to remember the cursor
1870 * that has just been set; this will be used on a redo action
1871 * (see ticket #10097)
1873 * FIXME: a better fix would be to have a way to set the
1874 * cursor value directly, but I am not sure it is worth it.
1878 dr.screenUpdate(Update::Force);
1879 dr.forceBufferUpdate();
1881 if (iterations >= max_iter) {
1883 dr.setMessage(bformat(_("`inset-forall' interrupted because number of actions is larger than %1$d"), max_iter));
1885 dr.setMessage(bformat(_("Applied \"%1$s\" to %2$d insets"), from_utf8(commandstr), iterations));
1890 case LFUN_BRANCH_ADD_INSERT: {
1891 docstring branch_name = from_utf8(cmd.getArg(0));
1892 if (branch_name.empty())
1893 if (!Alert::askForText(branch_name, _("Branch name")) ||
1894 branch_name.empty())
1897 DispatchResult drtmp;
1898 buffer_.dispatch(FuncRequest(LFUN_BRANCH_ADD, branch_name), drtmp);
1899 if (drtmp.error()) {
1900 Alert::warning(_("Branch already exists"), drtmp.message());
1903 BranchList & branch_list = buffer_.params().branchlist();
1904 vector<docstring> const branches =
1905 getVectorFromString(branch_name, branch_list.separator());
1906 for (vector<docstring>::const_iterator it = branches.begin();
1907 it != branches.end(); ++it) {
1909 lyx::dispatch(FuncRequest(LFUN_BRANCH_INSERT, branch_name));
1914 case LFUN_KEYMAP_OFF:
1915 getIntl().keyMapOn(false);
1918 case LFUN_KEYMAP_PRIMARY:
1919 getIntl().keyMapPrim();
1922 case LFUN_KEYMAP_SECONDARY:
1923 getIntl().keyMapSec();
1926 case LFUN_KEYMAP_TOGGLE:
1927 getIntl().toggleKeyMap();
1930 case LFUN_DIALOG_SHOW_NEW_INSET: {
1931 string const name = cmd.getArg(0);
1932 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
1933 if (decodeInsetParam(name, data, buffer_))
1934 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
1936 lyxerr << "Inset type '" << name <<
1937 "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" << endl;
1941 case LFUN_CITATION_INSERT: {
1942 if (argument.empty()) {
1943 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
1946 // we can have one optional argument, delimited by '|'
1947 // citation-insert <key>|<text_before>
1948 // this should be enhanced to also support text_after
1949 // and citation style
1950 string arg = argument;
1952 if (contains(argument, "|")) {
1953 arg = token(argument, '|', 0);
1954 opt1 = token(argument, '|', 1);
1957 // if our cursor is directly in front of or behind a citation inset,
1958 // we will instead add the new key to it.
1959 Inset * inset = cur.nextInset();
1960 if (!inset || inset->lyxCode() != CITE_CODE)
1961 inset = cur.prevInset();
1962 if (inset && inset->lyxCode() == CITE_CODE) {
1963 InsetCitation * icite = static_cast<InsetCitation *>(inset);
1964 if (icite->addKey(arg)) {
1965 dr.forceBufferUpdate();
1966 dr.screenUpdate(Update::FitCursor | Update::SinglePar);
1968 LYXERR0("Discarding optional argument to citation-insert.");
1973 InsetCommandParams icp(CITE_CODE);
1974 icp["key"] = from_utf8(arg);
1976 icp["before"] = from_utf8(opt1);
1977 string icstr = InsetCommand::params2string(icp);
1978 FuncRequest fr(LFUN_INSET_INSERT, icstr);
1983 case LFUN_INSET_APPLY: {
1984 string const name = cmd.getArg(0);
1985 Inset * inset = editedInset(name);
1987 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1991 // put cursor in front of inset.
1992 if (!setCursorFromInset(inset)) {
1993 LASSERT(false, break);
1996 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1997 inset->dispatch(cur, fr);
1998 dr.screenUpdate(cur.result().screenUpdate());
1999 if (cur.result().needBufferUpdate())
2000 dr.forceBufferUpdate();
2005 // The change of language of buffer belongs to the Buffer class.
2006 // We have to do it here because we need a cursor for Undo.
2007 // When Undo::recordUndoBufferParams() is implemented someday
2008 // LFUN_BUFFER_LANGUAGE should be handled by the Buffer class.
2009 case LFUN_BUFFER_LANGUAGE: {
2010 Language const * oldL = buffer_.params().language;
2011 Language const * newL = languages.getLanguage(argument);
2012 if (!newL || oldL == newL)
2014 if (oldL->rightToLeft() == newL->rightToLeft()) {
2015 cur.recordUndoFullBuffer();
2016 buffer_.changeLanguage(oldL, newL);
2017 cur.setCurrentFont();
2018 dr.forceBufferUpdate();
2023 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
2024 case LFUN_FILE_INSERT_PLAINTEXT: {
2025 bool const as_paragraph = (act == LFUN_FILE_INSERT_PLAINTEXT_PARA);
2026 string const fname = to_utf8(cmd.argument());
2027 if (!FileName::isAbsolute(fname))
2028 dr.setMessage(_("Absolute filename expected."));
2030 insertPlaintextFile(FileName(fname), as_paragraph);
2035 // OK, so try the Buffer itself...
2036 buffer_.dispatch(cmd, dr);
2037 dispatched = dr.dispatched();
2041 buffer_.undo().endUndoGroup();
2042 dr.dispatched(dispatched);
2044 // NOTE: The code below is copied from Cursor::dispatch. If you
2045 // need to modify this, please update the other one too.
2047 // notify insets we just entered/left
2048 if (cursor() != old) {
2049 old.beginUndoGroup();
2051 bool badcursor = notifyCursorLeavesOrEnters(old, cursor());
2053 cursor().fixIfBroken();
2054 resetInlineCompletionPos();
2061 docstring const BufferView::requestSelection()
2063 Cursor & cur = d->cursor_;
2065 LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
2066 if (!cur.selection()) {
2067 d->xsel_cache_.set = false;
2071 LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
2072 if (!d->xsel_cache_.set ||
2073 cur.top() != d->xsel_cache_.cursor ||
2074 cur.realAnchor().top() != d->xsel_cache_.anchor)
2076 d->xsel_cache_.cursor = cur.top();
2077 d->xsel_cache_.anchor = cur.realAnchor().top();
2078 d->xsel_cache_.set = cur.selection();
2079 return cur.selectionAsString(false);
2085 void BufferView::clearSelection()
2087 d->cursor_.clearSelection();
2088 // Clear the selection buffer. Otherwise a subsequent
2089 // middle-mouse-button paste would use the selection buffer,
2090 // not the more current external selection.
2091 cap::clearSelection();
2092 d->xsel_cache_.set = false;
2093 // The buffer did not really change, but this causes the
2094 // redraw we need because we cleared the selection above.
2095 buffer_.changed(false);
2099 void BufferView::resize(int width, int height)
2101 // Update from work area
2105 // Clear the paragraph height cache.
2106 d->par_height_.clear();
2107 // Redo the metrics.
2112 Inset const * BufferView::getCoveringInset(Text const & text,
2115 TextMetrics & tm = d->text_metrics_[&text];
2116 Inset * inset = tm.checkInsetHit(x, y);
2120 if (!inset->descendable(*this))
2121 // No need to go further down if the inset is not
2125 size_t cell_number = inset->nargs();
2126 // Check all the inner cell.
2127 for (size_t i = 0; i != cell_number; ++i) {
2128 Text const * inner_text = inset->getText(i);
2131 Inset const * inset_deeper =
2132 getCoveringInset(*inner_text, x, y);
2134 return inset_deeper;
2142 void BufferView::updateHoveredInset() const
2144 // Get inset under mouse, if there is one.
2145 int const x = d->mouse_position_cache_.x_;
2146 int const y = d->mouse_position_cache_.y_;
2147 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
2149 d->clickable_inset_ = covering_inset && covering_inset->clickable(*this, x, y);
2151 if (covering_inset == d->last_inset_)
2152 // Same inset, no need to do anything...
2155 bool need_redraw = false;
2156 if (d->last_inset_) {
2157 // Remove the hint on the last hovered inset (if any).
2158 need_redraw |= d->last_inset_->setMouseHover(this, false);
2162 if (covering_inset && covering_inset->setMouseHover(this, true)) {
2164 // Only the insets that accept the hover state, do
2165 // clear the last_inset_, so only set the last_inset_
2166 // member if the hovered setting is accepted.
2167 d->last_inset_ = covering_inset;
2171 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
2172 << d->mouse_position_cache_.x_ << ", "
2173 << d->mouse_position_cache_.y_ << ")");
2175 d->update_strategy_ = DecorationUpdate;
2177 // This event (moving without mouse click) is not passed further.
2178 // This should be changed if it is further utilized.
2179 buffer_.changed(false);
2184 void BufferView::clearLastInset(Inset * inset) const
2186 if (d->last_inset_ != inset) {
2187 LYXERR0("Wrong last_inset!");
2194 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
2196 //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
2198 // This is only called for mouse related events including
2199 // LFUN_FILE_OPEN generated by drag-and-drop.
2200 FuncRequest cmd = cmd0;
2202 Cursor old = cursor();
2204 cur.push(buffer_.inset());
2205 cur.selection(d->cursor_.selection());
2207 // Either the inset under the cursor or the
2208 // surrounding Text will handle this event.
2210 // make sure we stay within the screen...
2211 cmd.set_y(min(max(cmd.y(), -1), height_));
2213 d->mouse_position_cache_.x_ = cmd.x();
2214 d->mouse_position_cache_.y_ = cmd.y();
2216 if (cmd.action() == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
2217 updateHoveredInset();
2221 // Build temporary cursor.
2222 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x(), cmd.y());
2224 // If inset is not editable, cur.pos() might point behind the
2225 // inset (depending on cmd.x(), cmd.y()). This is needed for
2226 // editing to fix bug 9628, but e.g. the context menu needs a
2227 // cursor in front of the inset.
2228 if ((inset->hasSettings() || !inset->contextMenuName().empty()
2229 || inset->lyxCode() == SEPARATOR_CODE) &&
2230 cur.nextInset() != inset && cur.prevInset() == inset)
2232 } else if (cur.inTexted() && cur.pos()
2233 && cur.paragraph().isEnvSeparator(cur.pos() - 1)) {
2234 // Always place cursor in front of a separator inset.
2238 // Put anchor at the same position.
2241 cur.beginUndoGroup();
2243 // Try to dispatch to an non-editable inset near this position
2244 // via the temp cursor. If the inset wishes to change the real
2245 // cursor it has to do so explicitly by using
2246 // cur.bv().cursor() = cur; (or similar)
2248 inset->dispatch(cur, cmd);
2250 // Now dispatch to the temporary cursor. If the real cursor should
2251 // be modified, the inset's dispatch has to do so explicitly.
2252 if (!inset || !cur.result().dispatched())
2255 // Notify left insets
2257 bool badcursor = old.fixIfBroken() | cur.fixIfBroken();
2258 badcursor |= notifyCursorLeavesOrEnters(old, cur);
2260 cursor().fixIfBroken();
2265 // Do we have a selection?
2266 theSelection().haveSelection(cursor().selection());
2268 if (cur.needBufferUpdate()) {
2269 cur.clearBufferUpdate();
2270 buffer().updateBuffer();
2273 // If the command has been dispatched,
2274 if (cur.result().dispatched() || cur.result().screenUpdate())
2275 processUpdateFlags(cur.result().screenUpdate());
2279 int BufferView::minVisiblePart()
2281 return 2 * defaultRowHeight();
2285 int BufferView::scroll(int y)
2288 return scrollDown(y);
2290 return scrollUp(-y);
2295 int BufferView::scrollDown(int offset)
2297 Text * text = &buffer_.text();
2298 TextMetrics & tm = d->text_metrics_[text];
2299 int const ymax = height_ + offset;
2301 pair<pit_type, ParagraphMetrics const *> last = tm.last();
2302 int bottom_pos = last.second->position() + last.second->descent();
2303 if (lyxrc.scroll_below_document)
2304 bottom_pos += height_ - minVisiblePart();
2305 if (last.first + 1 == int(text->paragraphs().size())) {
2306 if (bottom_pos <= height_)
2308 offset = min(offset, bottom_pos - height_);
2311 if (bottom_pos > ymax)
2313 tm.newParMetricsDown();
2315 d->anchor_ypos_ -= offset;
2320 int BufferView::scrollUp(int offset)
2322 Text * text = &buffer_.text();
2323 TextMetrics & tm = d->text_metrics_[text];
2324 int ymin = - offset;
2326 pair<pit_type, ParagraphMetrics const *> first = tm.first();
2327 int top_pos = first.second->position() - first.second->ascent();
2328 if (first.first == 0) {
2331 offset = min(offset, - top_pos);
2336 tm.newParMetricsUp();
2338 d->anchor_ypos_ += offset;
2343 bool BufferView::setCursorFromRow(int row)
2345 TexRow::TextEntry start, end;
2346 tie(start,end) = buffer_.texrow().getEntriesFromRow(row);
2347 LYXERR(Debug::LATEX,
2348 "setCursorFromRow: for row " << row << ", TexRow has found "
2349 "start (id=" << start.id << ",pos=" << start.pos << "), "
2350 "end (id=" << end.id << ",pos=" << end.pos << ")");
2351 return setCursorFromEntries(start, end);
2355 bool BufferView::setCursorFromEntries(TexRow::TextEntry start,
2356 TexRow::TextEntry end)
2358 DocIterator dit_start, dit_end;
2359 tie(dit_start,dit_end) =
2360 TexRow::getDocIteratorsFromEntries(start, end, buffer_);
2363 // Setting selection start
2364 d->cursor_.clearSelection();
2365 setCursor(dit_start);
2366 // Setting selection end
2368 d->cursor_.resetAnchor();
2369 setCursorSelectionTo(dit_end);
2375 bool BufferView::setCursorFromInset(Inset const * inset)
2377 // are we already there?
2378 if (cursor().nextInset() == inset)
2381 // Inset is not at cursor position. Find it in the document.
2384 while (cur && cur.nextInset() != inset)
2395 void BufferView::gotoLabel(docstring const & label)
2397 ListOfBuffers bufs = buffer().allRelatives();
2398 ListOfBuffers::iterator it = bufs.begin();
2399 for (; it != bufs.end(); ++it) {
2400 Buffer const * buf = *it;
2403 shared_ptr<Toc> toc = buf->tocBackend().toc("label");
2404 Toc::const_iterator toc_it = toc->begin();
2405 Toc::const_iterator end = toc->end();
2406 for (; toc_it != end; ++toc_it) {
2407 if (label == toc_it->str()) {
2408 lyx::dispatch(toc_it->action());
2416 TextMetrics const & BufferView::textMetrics(Text const * t) const
2418 return const_cast<BufferView *>(this)->textMetrics(t);
2422 TextMetrics & BufferView::textMetrics(Text const * t)
2425 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
2426 if (tmc_it == d->text_metrics_.end()) {
2427 tmc_it = d->text_metrics_.insert(
2428 make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
2430 return tmc_it->second;
2434 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
2437 return textMetrics(t).parMetrics(pit);
2441 int BufferView::workHeight() const
2447 void BufferView::setCursor(DocIterator const & dit)
2450 size_t const n = dit.depth();
2451 for (size_t i = 0; i < n; ++i)
2452 dit[i].inset().edit(d->cursor_, true);
2454 d->cursor_.setCursor(dit);
2455 d->cursor_.selection(false);
2456 d->cursor_.setCurrentFont();
2458 // It seems on general grounds as if this is probably needed, but
2459 // it is not yet clear.
2460 // See bug #7394 and r38388.
2461 // d->cursor.resetAnchor();
2465 void BufferView::setCursorSelectionTo(DocIterator const & dit)
2467 size_t const n = dit.depth();
2468 for (size_t i = 0; i < n; ++i)
2469 dit[i].inset().edit(d->cursor_, true);
2471 d->cursor_.selection(true);
2472 d->cursor_.setCursorSelectionTo(dit);
2473 d->cursor_.setCurrentFont();
2477 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
2479 // Would be wrong to delete anything if we have a selection.
2480 if (cur.selection())
2483 bool need_anchor_change = false;
2484 bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
2485 need_anchor_change);
2487 if (need_anchor_change)
2495 // we would rather not do this here, but it needs to be done before
2496 // the changed() signal is sent.
2497 buffer_.updateBuffer();
2499 buffer_.changed(true);
2504 bool BufferView::mouseSetCursor(Cursor & cur, bool const select)
2506 LASSERT(&cur.bv() == this, return false);
2509 // this event will clear selection so we save selection for
2510 // persistent selection
2511 cap::saveSelection(cursor());
2513 d->cursor_.macroModeClose();
2514 // If a macro has been finalized, the cursor might have been broken
2517 // Has the cursor just left the inset?
2518 bool const leftinset = (&d->cursor_.inset() != &cur.inset());
2520 d->cursor_.fixIfBroken();
2522 // do the dEPM magic if needed
2523 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
2524 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
2525 // the leftinset bool would not be necessary (badcursor instead).
2526 bool update = leftinset;
2529 d->cursor_.setSelection();
2530 d->cursor_.setCursorSelectionTo(cur);
2532 if (d->cursor_.inTexted())
2533 update |= checkDepm(cur, d->cursor_);
2534 d->cursor_.resetAnchor();
2535 d->cursor_.setCursor(cur);
2536 d->cursor_.clearSelection();
2538 d->cursor_.boundary(cur.boundary());
2539 d->cursor_.finishUndo();
2540 d->cursor_.setCurrentFont();
2542 cur.forceBufferUpdate();
2547 void BufferView::putSelectionAt(DocIterator const & cur,
2548 int length, bool backwards)
2550 d->cursor_.clearSelection();
2556 d->cursor_.pos() += length;
2557 d->cursor_.setSelection(d->cursor_, -length);
2559 d->cursor_.setSelection(d->cursor_, length);
2564 bool BufferView::selectIfEmpty(DocIterator & cur)
2566 if ((cur.inTexted() && !cur.paragraph().empty())
2567 || (cur.inMathed() && !cur.cell().empty()))
2570 pit_type const beg_pit = cur.pit();
2572 // The paragraph associated to this item isn't
2573 // the first one, so it can be selected
2576 // We have to resort to select the space between the
2577 // end of this item and the begin of the next one
2581 // If it is the only item in the document,
2582 // nothing can be selected
2585 pit_type const end_pit = cur.pit();
2586 pos_type const end_pos = cur.pos();
2587 d->cursor_.clearSelection();
2589 d->cursor_.setCursor(cur);
2590 d->cursor_.pit() = beg_pit;
2591 d->cursor_.pos() = 0;
2592 d->cursor_.selection(false);
2593 d->cursor_.resetAnchor();
2594 d->cursor_.pit() = end_pit;
2595 d->cursor_.pos() = end_pos;
2596 d->cursor_.setSelection();
2601 Cursor & BufferView::cursor()
2607 Cursor const & BufferView::cursor() const
2613 pit_type BufferView::anchor_ref() const
2615 return d->anchor_pit_;
2619 bool BufferView::singleParUpdate()
2621 Text & buftext = buffer_.text();
2622 pit_type const bottom_pit = d->cursor_.bottom().pit();
2623 TextMetrics & tm = textMetrics(&buftext);
2624 int old_height = tm.parMetrics(bottom_pit).height();
2626 // make sure inline completion pointer is ok
2627 if (d->inlineCompletionPos_.fixIfBroken())
2628 d->inlineCompletionPos_ = DocIterator();
2630 // In Single Paragraph mode, rebreak only
2631 // the (main text, not inset!) paragraph containing the cursor.
2632 // (if this paragraph contains insets etc., rebreaking will
2633 // recursively descend)
2634 tm.redoParagraph(bottom_pit);
2635 ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
2636 if (pm.height() != old_height)
2637 // Paragraph height has changed so we cannot proceed to
2638 // the singlePar optimisation.
2641 d->update_strategy_ = SingleParUpdate;
2643 LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
2644 << " y2: " << pm.position() + pm.descent()
2645 << " pit: " << bottom_pit
2646 << " singlepar: 1");
2651 void BufferView::updateMetrics()
2653 if (height_ == 0 || width_ == 0)
2656 Text & buftext = buffer_.text();
2657 pit_type const npit = int(buftext.paragraphs().size());
2659 // Clear out the position cache in case of full screen redraw,
2660 d->coord_cache_.clear();
2662 // Clear out paragraph metrics to avoid having invalid metrics
2663 // in the cache from paragraphs not relayouted below
2664 // The complete text metrics will be redone.
2665 d->text_metrics_.clear();
2667 TextMetrics & tm = textMetrics(&buftext);
2669 // make sure inline completion pointer is ok
2670 if (d->inlineCompletionPos_.fixIfBroken())
2671 d->inlineCompletionPos_ = DocIterator();
2673 if (d->anchor_pit_ >= npit)
2674 // The anchor pit must have been deleted...
2675 d->anchor_pit_ = npit - 1;
2677 // Rebreak anchor paragraph.
2678 tm.redoParagraph(d->anchor_pit_);
2679 ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
2682 if (d->anchor_pit_ == 0) {
2683 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
2685 // Complete buffer visible? Then it's easy.
2686 if (scrollRange == 0)
2687 d->anchor_ypos_ = anchor_pm.ascent();
2689 // avoid empty space above the first row
2690 d->anchor_ypos_ = min(d->anchor_ypos_, anchor_pm.ascent());
2693 anchor_pm.setPosition(d->anchor_ypos_);
2695 LYXERR(Debug::PAINTING, "metrics: "
2696 << " anchor pit = " << d->anchor_pit_
2697 << " anchor ypos = " << d->anchor_ypos_);
2699 // Redo paragraphs above anchor if necessary.
2700 int y1 = d->anchor_ypos_ - anchor_pm.ascent();
2701 // We are now just above the anchor paragraph.
2702 pit_type pit1 = d->anchor_pit_ - 1;
2703 for (; pit1 >= 0 && y1 >= 0; --pit1) {
2704 tm.redoParagraph(pit1);
2705 ParagraphMetrics & pm = tm.par_metrics_[pit1];
2707 // Save the paragraph position in the cache.
2712 // Redo paragraphs below the anchor if necessary.
2713 int y2 = d->anchor_ypos_ + anchor_pm.descent();
2714 // We are now just below the anchor paragraph.
2715 pit_type pit2 = d->anchor_pit_ + 1;
2716 for (; pit2 < npit && y2 <= height_; ++pit2) {
2717 tm.redoParagraph(pit2);
2718 ParagraphMetrics & pm = tm.par_metrics_[pit2];
2720 // Save the paragraph position in the cache.
2725 LYXERR(Debug::PAINTING, "Metrics: "
2726 << " anchor pit = " << d->anchor_pit_
2727 << " anchor ypos = " << d->anchor_ypos_
2730 << " pit1 = " << pit1
2731 << " pit2 = " << pit2);
2733 d->update_strategy_ = FullScreenUpdate;
2735 if (lyxerr.debugging(Debug::WORKAREA)) {
2736 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
2737 d->coord_cache_.dump();
2742 void BufferView::insertLyXFile(FileName const & fname)
2744 LASSERT(d->cursor_.inTexted(), return);
2746 // Get absolute path of file and add ".lyx"
2747 // to the filename if necessary
2748 FileName filename = fileSearch(string(), fname.absFileName(), "lyx");
2750 docstring const disp_fn = makeDisplayPath(filename.absFileName());
2751 // emit message signal.
2752 message(bformat(_("Inserting document %1$s..."), disp_fn));
2755 Buffer buf(filename.absFileName(), false);
2756 if (buf.loadLyXFile() == Buffer::ReadSuccess) {
2757 ErrorList & el = buffer_.errorList("Parse");
2758 // Copy the inserted document error list into the current buffer one.
2759 el = buf.errorList("Parse");
2760 buffer_.undo().recordUndo(d->cursor_);
2761 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
2762 buf.params().documentClassPtr(), el);
2763 res = _("Document %1$s inserted.");
2765 res = _("Could not insert document %1$s");
2768 buffer_.changed(true);
2769 // emit message signal.
2770 message(bformat(res, disp_fn));
2774 Point BufferView::coordOffset(DocIterator const & dit) const
2780 // Addup contribution of nested insets, from inside to outside,
2781 // keeping the outer paragraph for a special handling below
2782 for (size_t i = dit.depth() - 1; i >= 1; --i) {
2783 CursorSlice const & sl = dit[i];
2787 // get relative position inside sl.inset()
2788 sl.inset().cursorPos(*this, sl, dit.boundary() && (i + 1 == dit.depth()), xx, yy);
2790 // Make relative position inside of the edited inset relative to sl.inset()
2794 // In case of an RTL inset, the edited inset will be positioned to the left
2797 bool boundary_i = dit.boundary() && i + 1 == dit.depth();
2798 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2803 // remember width for the case that sl.inset() is positioned in an RTL inset
2804 lastw = sl.inset().dimension(*this).wid;
2806 //lyxerr << "Cursor::getPos, i: "
2807 // << i << " x: " << xx << " y: " << y << endl;
2810 // Add contribution of initial rows of outermost paragraph
2811 CursorSlice const & sl = dit[0];
2812 TextMetrics const & tm = textMetrics(sl.text());
2813 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2815 LBUFERR(!pm.rows().empty());
2816 y -= pm.rows()[0].ascent();
2818 // FIXME: document this mess
2820 if (sl.pos() > 0 && dit.depth() == 1) {
2822 if (pos && dit.boundary())
2824 // lyxerr << "coordOffset: boundary:" << dit.boundary() << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
2825 rend = pm.pos2row(pos);
2827 rend = pm.pos2row(sl.pos());
2829 size_t rend = pm.pos2row(sl.pos());
2831 for (size_t rit = 0; rit != rend; ++rit)
2832 y += pm.rows()[rit].height();
2833 y += pm.rows()[rend].ascent();
2835 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
2837 // Make relative position from the nested inset now bufferview absolute.
2838 int xx = bottom_tm.cursorX(dit.bottom(), dit.boundary() && dit.depth() == 1);
2841 // In the RTL case place the nested inset at the left of the cursor in
2842 // the outer paragraph
2843 bool boundary_1 = dit.boundary() && 1 == dit.depth();
2844 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
2852 Point BufferView::getPos(DocIterator const & dit) const
2854 if (!paragraphVisible(dit))
2855 return Point(-1, -1);
2857 CursorSlice const & bot = dit.bottom();
2858 TextMetrics const & tm = textMetrics(bot.text());
2860 // offset from outer paragraph
2861 Point p = coordOffset(dit);
2862 p.y_ += tm.parMetrics(bot.pit()).position();
2867 bool BufferView::paragraphVisible(DocIterator const & dit) const
2869 CursorSlice const & bot = dit.bottom();
2870 TextMetrics const & tm = textMetrics(bot.text());
2872 return tm.contains(bot.pit());
2876 void BufferView::cursorPosAndHeight(Point & p, int & h) const
2878 Cursor const & cur = cursor();
2879 Font const font = cur.real_current_font;
2880 frontend::FontMetrics const & fm = theFontMetrics(font);
2881 int const asc = fm.maxAscent();
2882 int const des = fm.maxDescent();
2889 bool BufferView::cursorInView(Point const & p, int h) const
2891 Cursor const & cur = cursor();
2892 // does the cursor touch the screen ?
2893 if (p.y_ + h < 0 || p.y_ >= workHeight() || !paragraphVisible(cur))
2899 int BufferView::horizScrollOffset() const
2901 return d->horiz_scroll_offset_;
2905 int BufferView::horizScrollOffset(Text const * text,
2906 pit_type pit, pos_type pos) const
2908 // Is this a row that is currently scrolled?
2909 if (!d->current_row_slice_.empty()
2910 && &text->inset() == d->current_row_slice_.inset().asInsetText()
2911 && pit == d->current_row_slice_.pit()
2912 && pos == d->current_row_slice_.pos())
2913 return d->horiz_scroll_offset_;
2918 bool BufferView::hadHorizScrollOffset(Text const * text,
2919 pit_type pit, pos_type pos) const
2921 return !d->last_row_slice_.empty()
2922 && &text->inset() == d->last_row_slice_.inset().asInsetText()
2923 && pit == d->last_row_slice_.pit()
2924 && pos == d->last_row_slice_.pos();
2928 void BufferView::setCurrentRowSlice(CursorSlice const & rowSlice)
2930 // nothing to do if the cursor was already on this row
2931 if (d->current_row_slice_ == rowSlice) {
2932 d->last_row_slice_ = CursorSlice();
2936 // if the (previous) current row was scrolled, we have to
2937 // remember it in order to repaint it next time.
2938 if (d->horiz_scroll_offset_ != 0)
2939 d->last_row_slice_ = d->current_row_slice_;
2941 d->last_row_slice_ = CursorSlice();
2943 // Since we changed row, the scroll offset is not valid anymore
2944 d->horiz_scroll_offset_ = 0;
2945 d->current_row_slice_ = rowSlice;
2949 void BufferView::checkCursorScrollOffset(PainterInfo & pi)
2951 CursorSlice rowSlice = d->cursor_.bottom();
2952 TextMetrics const & tm = textMetrics(rowSlice.text());
2954 // Stop if metrics have not been computed yet, since it means
2955 // that there is nothing to do.
2956 if (!tm.contains(rowSlice.pit()))
2958 ParagraphMetrics const & pm = tm.parMetrics(rowSlice.pit());
2959 Row const & row = pm.getRow(rowSlice.pos(),
2960 d->cursor_.boundary() && rowSlice == d->cursor_.top());
2961 rowSlice.pos() = row.pos();
2963 // Set the row on which the cursor lives.
2964 setCurrentRowSlice(rowSlice);
2966 // If insets referred to by cursor are not all in the cache, the positions
2967 // need to be recomputed.
2968 if (!d->cursor_.inCoordCache()) {
2969 /** FIXME: the code below adds an extraneous computation of
2970 * inset positions, and can therefore be bad for performance
2971 * (think for example about a very large tabular inset.
2972 * Redawing the row where it is means redrawing the whole
2975 * The bug that this fixes is the following: assume that there
2976 * is a very large math inset. Upon entering the inset, when
2977 * pressing `End', the row is not scrolled and the cursor is
2978 * not visible. The extra row computation makes sure that the
2979 * inset positions are correctly computed and set in the
2980 * cache. This would not happen if we did not have two-stage
2983 * A proper fix would be to always have proper inset positions
2986 // Force the recomputation of inset positions
2987 bool const drawing = pi.pain.isDrawingEnabled();
2988 pi.pain.setDrawingEnabled(false);
2989 // No need to care about vertical position.
2990 RowPainter rp(pi, buffer().text(), row, -d->horiz_scroll_offset_, 0);
2992 pi.pain.setDrawingEnabled(drawing);
2995 // Current x position of the cursor in pixels
2996 int cur_x = getPos(d->cursor_).x_;
2998 // Horizontal scroll offset of the cursor row in pixels
2999 int offset = d->horiz_scroll_offset_;
3000 int const MARGIN = 2 * theFontMetrics(d->cursor_.real_current_font).em()
3002 if (row.right_x() <= workWidth() - row.right_margin) {
3003 // Row is narrower than the work area, no offset needed.
3006 if (cur_x - offset < MARGIN) {
3007 // cursor would be too far right
3008 offset = cur_x - MARGIN;
3009 } else if (cur_x - offset > workWidth() - MARGIN) {
3010 // cursor would be too far left
3011 offset = cur_x - workWidth() + MARGIN;
3013 // Correct the offset to make sure that we do not scroll too much
3016 if (row.right_x() - offset < workWidth() - row.right_margin)
3017 offset = row.right_x() - workWidth() + row.right_margin;
3020 //lyxerr << "cur_x=" << cur_x << ", offset=" << offset << ", row.wid=" << row.width() << ", margin=" << MARGIN << endl;
3022 if (offset != d->horiz_scroll_offset_)
3023 LYXERR(Debug::PAINTING, "Horiz. scroll offset changed from "
3024 << d->horiz_scroll_offset_ << " to " << offset);
3026 if (d->update_strategy_ == NoScreenUpdate
3027 && (offset != d->horiz_scroll_offset_
3028 || !d->last_row_slice_.empty())) {
3029 // FIXME: if one uses SingleParUpdate, then home/end
3030 // will not work on long rows. Why?
3031 d->update_strategy_ = FullScreenUpdate;
3034 d->horiz_scroll_offset_ = offset;
3038 void BufferView::draw(frontend::Painter & pain)
3040 if (height_ == 0 || width_ == 0)
3042 LYXERR(Debug::PAINTING, "\t\t*** START DRAWING ***");
3044 Text & text = buffer_.text();
3045 TextMetrics const & tm = d->text_metrics_[&text];
3046 int const y = tm.first().second->position();
3047 PainterInfo pi(this, pain);
3049 // Check whether the row where the cursor lives needs to be scrolled.
3050 // Update the drawing strategy if needed.
3051 checkCursorScrollOffset(pi);
3053 switch (d->update_strategy_) {
3055 case NoScreenUpdate:
3056 // If no screen painting is actually needed, only some the different
3057 // coordinates of insets and paragraphs needs to be updated.
3058 LYXERR(Debug::PAINTING, "Strategy: NoScreenUpdate");
3059 pi.full_repaint = true;
3060 pi.pain.setDrawingEnabled(false);
3064 case SingleParUpdate:
3065 pi.full_repaint = false;
3066 LYXERR(Debug::PAINTING, "Strategy: SingleParUpdate");
3067 // In general, only the current row of the outermost paragraph
3068 // will be redrawn. Particular cases where selection spans
3069 // multiple paragraph are correctly detected in TextMetrics.
3073 case DecorationUpdate:
3074 // FIXME: We should also distinguish DecorationUpdate to avoid text
3075 // drawing if possible. This is not possible to do easily right now
3076 // because of the single backing pixmap.
3078 case FullScreenUpdate:
3080 LYXERR(Debug::PAINTING,
3081 ((d->update_strategy_ == FullScreenUpdate)
3082 ? "Strategy: FullScreenUpdate"
3083 : "Strategy: DecorationUpdate"));
3085 // The whole screen, including insets, will be refreshed.
3086 pi.full_repaint = true;
3088 // Clear background.
3089 pain.fillRectangle(0, 0, width_, height_,
3090 pi.backgroundColor(&buffer_.inset()));
3095 // and possibly grey out below
3096 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3097 int const y2 = lastpm.second->position() + lastpm.second->descent();
3100 Color color = buffer().isInternal()
3101 ? Color_background : Color_bottomarea;
3102 pain.fillRectangle(0, y2, width_, height_ - y2, color);
3106 LYXERR(Debug::PAINTING, "\n\t\t*** END DRAWING ***");
3108 // The scrollbar needs an update.
3111 // Normalize anchor for next time
3112 pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
3113 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3114 for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
3115 ParagraphMetrics const & pm = tm.parMetrics(pit);
3116 if (pm.position() + pm.descent() > 0) {
3117 d->anchor_pit_ = pit;
3118 d->anchor_ypos_ = pm.position();
3122 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
3123 << " anchor ypos = " << d->anchor_ypos_);
3127 void BufferView::message(docstring const & msg)
3130 d->gui_->message(msg);
3134 void BufferView::showDialog(string const & name)
3137 d->gui_->showDialog(name, string());
3141 void BufferView::showDialog(string const & name,
3142 string const & data, Inset * inset)
3145 d->gui_->showDialog(name, data, inset);
3149 void BufferView::updateDialog(string const & name, string const & data)
3152 d->gui_->updateDialog(name, data);
3156 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
3162 // FIXME: Move this out of BufferView again
3163 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
3165 if (!fname.isReadableFile()) {
3166 docstring const error = from_ascii(strerror(errno));
3167 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3168 docstring const text =
3169 bformat(_("Could not read the specified document\n"
3170 "%1$s\ndue to the error: %2$s"), file, error);
3171 Alert::error(_("Could not read file"), text);
3175 if (!fname.isReadableFile()) {
3176 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3177 docstring const text =
3178 bformat(_("%1$s\n is not readable."), file);
3179 Alert::error(_("Could not open file"), text);
3183 // FIXME UNICODE: We don't know the encoding of the file
3184 docstring file_content = fname.fileContents("UTF-8");
3185 if (file_content.empty()) {
3186 Alert::error(_("Reading not UTF-8 encoded file"),
3187 _("The file is not UTF-8 encoded.\n"
3188 "It will be read as local 8Bit-encoded.\n"
3189 "If this does not give the correct result\n"
3190 "then please change the encoding of the file\n"
3191 "to UTF-8 with a program other than LyX.\n"));
3192 file_content = fname.fileContents("local8bit");
3195 return normalize_c(file_content);
3199 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
3201 docstring const tmpstr = contentsOfPlaintextFile(f);
3206 Cursor & cur = cursor();
3207 cap::replaceSelection(cur);
3208 buffer_.undo().recordUndo(cur);
3210 cur.innerText()->insertStringAsParagraphs(cur, tmpstr, cur.current_font);
3212 cur.innerText()->insertStringAsLines(cur, tmpstr, cur.current_font);
3214 buffer_.changed(true);
3218 docstring const & BufferView::inlineCompletion() const
3220 return d->inlineCompletion_;
3224 size_t const & BufferView::inlineCompletionUniqueChars() const
3226 return d->inlineCompletionUniqueChars_;
3230 DocIterator const & BufferView::inlineCompletionPos() const
3232 return d->inlineCompletionPos_;
3236 void BufferView::resetInlineCompletionPos()
3238 d->inlineCompletionPos_ = DocIterator();
3242 bool samePar(DocIterator const & a, DocIterator const & b)
3244 if (a.empty() && b.empty())
3246 if (a.empty() || b.empty())
3248 if (a.depth() != b.depth())
3250 return &a.innerParagraph() == &b.innerParagraph();
3254 void BufferView::setInlineCompletion(Cursor const & cur, DocIterator const & pos,
3255 docstring const & completion, size_t uniqueChars)
3257 uniqueChars = min(completion.size(), uniqueChars);
3258 bool changed = d->inlineCompletion_ != completion
3259 || d->inlineCompletionUniqueChars_ != uniqueChars;
3260 bool singlePar = true;
3261 d->inlineCompletion_ = completion;
3262 d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
3264 //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
3267 DocIterator const & old = d->inlineCompletionPos_;
3269 //lyxerr << "inlineCompletionPos changed" << std::endl;
3270 // old or pos are in another paragraph?
3271 if ((!samePar(cur, pos) && !pos.empty())
3272 || (!samePar(cur, old) && !old.empty())) {
3274 //lyxerr << "different paragraph" << std::endl;
3276 d->inlineCompletionPos_ = pos;
3281 if (singlePar && !(cur.result().screenUpdate() & Update::Force))
3282 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
3284 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::Force);
3289 bool BufferView::clickableInset() const
3291 return d->clickable_inset_;