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 2.5mm at 100dpi
355 int const default_margin = Length(2.5, Length::MM).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 bool BufferView::isTopScreen() const
373 return 0 == d->scrollbarParameters_.min;
377 bool BufferView::isBottomScreen() const
379 return 0 == d->scrollbarParameters_.max;
383 Intl & BufferView::getIntl()
389 Intl const & BufferView::getIntl() const
395 CoordCache & BufferView::coordCache()
397 return d->coord_cache_;
401 CoordCache const & BufferView::coordCache() const
403 return d->coord_cache_;
407 Buffer & BufferView::buffer()
413 Buffer const & BufferView::buffer() const
419 bool BufferView::needsFitCursor() const
421 if (cursorStatus(d->cursor_) == CUR_INSIDE) {
422 frontend::FontMetrics const & fm =
423 theFontMetrics(d->cursor_.getFont().fontInfo());
424 int const asc = fm.maxAscent();
425 int const des = fm.maxDescent();
426 Point const p = getPos(d->cursor_);
427 if (p.y_ - asc >= 0 && p.y_ + des < height_)
434 void BufferView::processUpdateFlags(Update::flags flags)
436 // This is close to a hot-path.
437 LYXERR(Debug::PAINTING, "BufferView::processUpdateFlags()"
438 << "[fitcursor = " << (flags & Update::FitCursor)
439 << ", forceupdate = " << (flags & Update::Force)
440 << ", singlepar = " << (flags & Update::SinglePar)
441 << "] buffer: " << &buffer_);
443 // FIXME Does this really need doing here? It's done in updateBuffer, and
444 // if the Buffer doesn't need updating, then do the macros?
445 buffer_.updateMacros();
447 // Now do the first drawing step if needed. This consists on updating
448 // the CoordCache in updateMetrics().
449 // The second drawing step is done in WorkArea::redraw() if needed.
450 // FIXME: is this still true now that Buffer::changed() is used all over?
452 // Case when no explicit update is requested.
454 // no need to redraw anything.
455 d->update_strategy_ = NoScreenUpdate;
459 if (flags == Update::Decoration) {
460 d->update_strategy_ = DecorationUpdate;
461 buffer_.changed(false);
465 if (flags == Update::FitCursor
466 || flags == (Update::Decoration | Update::FitCursor)) {
467 // tell the frontend to update the screen if needed.
468 if (needsFitCursor()) {
472 if (flags & Update::Decoration) {
473 d->update_strategy_ = DecorationUpdate;
474 buffer_.changed(false);
477 // no screen update is needed in principle, but this
478 // could change if cursor row needs horizontal scrolling.
479 d->update_strategy_ = NoScreenUpdate;
480 buffer_.changed(false);
484 bool const full_metrics = flags & Update::Force || !singleParUpdate();
487 // We have to update the full screen metrics.
490 if (!(flags & Update::FitCursor)) {
491 // Nothing to do anymore. Trigger a redraw and return
492 buffer_.changed(false);
496 // updateMetrics() does not update paragraph position
497 // This is done at draw() time. So we need a redraw!
498 buffer_.changed(false);
500 if (needsFitCursor()) {
501 // The cursor is off screen so ensure it is visible.
506 updateHoveredInset();
510 void BufferView::updateScrollbar()
512 if (height_ == 0 && width_ == 0)
515 // We prefer fixed size line scrolling.
516 d->scrollbarParameters_.single_step = defaultRowHeight();
517 // We prefer full screen page scrolling.
518 d->scrollbarParameters_.page_step = height_;
520 Text & t = buffer_.text();
521 TextMetrics & tm = d->text_metrics_[&t];
523 LYXERR(Debug::GUI, " Updating scrollbar: height: "
524 << t.paragraphs().size()
525 << " curr par: " << d->cursor_.bottom().pit()
526 << " default height " << defaultRowHeight());
528 size_t const parsize = t.paragraphs().size();
529 if (d->par_height_.size() != parsize) {
530 d->par_height_.clear();
531 // FIXME: We assume a default paragraph height of 2 rows. This
532 // should probably be pondered with the screen width.
533 d->par_height_.resize(parsize, defaultRowHeight() * 2);
536 // Look at paragraph heights on-screen
537 pair<pit_type, ParagraphMetrics const *> first = tm.first();
538 pair<pit_type, ParagraphMetrics const *> last = tm.last();
539 for (pit_type pit = first.first; pit <= last.first; ++pit) {
540 d->par_height_[pit] = tm.parMetrics(pit).height();
541 LYXERR(Debug::SCROLLING, "storing height for pit " << pit << " : "
542 << d->par_height_[pit]);
545 int top_pos = first.second->position() - first.second->ascent();
546 int bottom_pos = last.second->position() + last.second->descent();
547 bool first_visible = first.first == 0 && top_pos >= 0;
548 bool last_visible = last.first + 1 == int(parsize) && bottom_pos <= height_;
549 if (first_visible && last_visible) {
550 d->scrollbarParameters_.min = 0;
551 d->scrollbarParameters_.max = 0;
555 d->scrollbarParameters_.min = top_pos;
556 for (size_t i = 0; i != size_t(first.first); ++i)
557 d->scrollbarParameters_.min -= d->par_height_[i];
558 d->scrollbarParameters_.max = bottom_pos;
559 for (size_t i = last.first + 1; i != parsize; ++i)
560 d->scrollbarParameters_.max += d->par_height_[i];
562 // The reference is the top position so we remove one page.
563 if (lyxrc.scroll_below_document)
564 d->scrollbarParameters_.max -= minVisiblePart();
566 d->scrollbarParameters_.max -= d->scrollbarParameters_.page_step;
568 // 0 must be inside the range as it denotes the current position
569 if (d->scrollbarParameters_.max < 0)
570 d->scrollbarParameters_.max = 0;
571 if (d->scrollbarParameters_.min > 0)
572 d->scrollbarParameters_.min = 0;
576 ScrollbarParameters const & BufferView::scrollbarParameters() const
578 return d->scrollbarParameters_;
582 docstring BufferView::toolTip(int x, int y) const
584 // Get inset under mouse, if there is one.
585 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
587 // No inset, no tooltip...
589 return covering_inset->toolTip(*this, x, y);
593 string BufferView::contextMenu(int x, int y) const
595 //If there is a selection, return the containing inset menu
596 if (d->cursor_.selection())
597 return d->cursor_.inset().contextMenu(*this, x, y);
599 // Get inset under mouse, if there is one.
600 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
602 return covering_inset->contextMenu(*this, x, y);
604 return buffer_.inset().contextMenu(*this, x, y);
609 void BufferView::scrollDocView(int const value, bool update)
611 // The scrollbar values are relative to the top of the screen, therefore the
612 // offset is equal to the target value.
614 // No scrolling at all? No need to redraw anything
618 // If the offset is less than 2 screen height, prefer to scroll instead.
619 if (abs(value) <= 2 * height_) {
620 d->anchor_ypos_ -= value;
621 buffer_.changed(true);
622 updateHoveredInset();
626 // cut off at the top
627 if (value <= d->scrollbarParameters_.min) {
628 DocIterator dit = doc_iterator_begin(&buffer_);
629 showCursor(dit, false, update);
630 LYXERR(Debug::SCROLLING, "scroll to top");
634 // cut off at the bottom
635 if (value >= d->scrollbarParameters_.max) {
636 DocIterator dit = doc_iterator_end(&buffer_);
638 showCursor(dit, false, update);
639 LYXERR(Debug::SCROLLING, "scroll to bottom");
643 // find paragraph at target position
644 int par_pos = d->scrollbarParameters_.min;
646 for (; i != int(d->par_height_.size()); ++i) {
647 par_pos += d->par_height_[i];
648 if (par_pos >= value)
652 if (par_pos < value) {
653 // It seems we didn't find the correct pit so stay on the safe side and
655 LYXERR0("scrolling position not found!");
656 scrollDocView(d->scrollbarParameters_.max, update);
660 DocIterator dit = doc_iterator_begin(&buffer_);
662 LYXERR(Debug::SCROLLING, "value = " << value << " -> scroll to pit " << i);
663 showCursor(dit, false, update);
667 // FIXME: this method is not working well.
668 void BufferView::setCursorFromScrollbar()
670 TextMetrics & tm = d->text_metrics_[&buffer_.text()];
672 int const height = 2 * defaultRowHeight();
673 int const first = height;
674 int const last = height_ - height;
676 Cursor const & oldcur = d->cursor_;
678 switch (cursorStatus(oldcur)) {
686 int const y = getPos(oldcur).y_;
687 newy = min(last, max(y, first));
691 // We reset the cursor because cursorStatus() does not
692 // work when the cursor is within mathed.
695 tm.setCursorFromCoordinates(cur, 0, newy);
697 // update the bufferview cursor and notify insets
698 // FIXME: Care about the d->cursor_ flags to redraw if needed
699 Cursor old = d->cursor_;
701 // the DEPM call in mouseSetCursor() might have destroyed the
702 // paragraph the cursor is in.
703 bool badcursor = old.fixIfBroken();
704 badcursor |= notifyCursorLeavesOrEnters(old, d->cursor_);
706 d->cursor_.fixIfBroken();
710 Change const BufferView::getCurrentChange() const
712 if (!d->cursor_.selection())
713 return Change(Change::UNCHANGED);
715 DocIterator dit = d->cursor_.selectionBegin();
716 // The selected content might have been changed (see #7685)
717 dit = dit.getInnerText();
718 return dit.paragraph().lookupChange(dit.pos());
722 // this could be used elsewhere as well?
723 // FIXME: This does not work within mathed!
724 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
726 Point const p = getPos(dit);
729 if (p.y_ > workHeight())
735 void BufferView::bookmarkEditPosition()
737 // Don't eat cpu time for each keystroke
738 if (d->cursor_.paragraph().id() == d->bookmark_edit_position_)
741 d->bookmark_edit_position_ = d->cursor_.paragraph().id();
745 void BufferView::saveBookmark(unsigned int idx)
747 // tentatively save bookmark, id and pos will be used to
748 // acturately locate a bookmark in a 'live' lyx session.
749 // pit and pos will be updated with bottom level pit/pos
751 if (!buffer_.isInternal()) {
752 theSession().bookmarks().save(
754 d->cursor_.bottom().pit(),
755 d->cursor_.bottom().pos(),
756 d->cursor_.paragraph().id(),
761 // emit message signal.
762 message(_("Save bookmark"));
767 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
768 int top_id, pos_type top_pos)
770 bool success = false;
773 d->cursor_.clearSelection();
775 // if a valid par_id is given, try it first
776 // This is the case for a 'live' bookmark when unique paragraph ID
777 // is used to track bookmarks.
779 dit = buffer_.getParFromID(top_id);
781 dit.pos() = min(dit.paragraph().size(), top_pos);
782 // Some slices of the iterator may not be
783 // reachable (e.g. closed collapsable inset)
784 // so the dociterator may need to be
785 // shortened. Otherwise, setCursor may crash
786 // lyx when the cursor can not be set to these
788 size_t const n = dit.depth();
789 for (size_t i = 0; i < n; ++i)
790 if (!dit[i].inset().editable()) {
798 // if top_id == 0, or searching through top_id failed
799 // This is the case for a 'restored' bookmark when only bottom
800 // (document level) pit was saved. Because of this, bookmark
801 // restoration is inaccurate. If a bookmark was within an inset,
802 // it will be restored to the left of the outmost inset that contains
804 if (bottom_pit < int(buffer_.paragraphs().size())) {
805 dit = doc_iterator_begin(&buffer_);
807 dit.pit() = bottom_pit;
808 dit.pos() = min(bottom_pos, dit.paragraph().size());
813 // Note: only bottom (document) level pit is set.
815 // set the current font.
816 d->cursor_.setCurrentFont();
817 // Do not forget to reset the anchor (see #9912)
818 d->cursor_.resetAnchor();
819 // To center the screen on this new position we need the
820 // paragraph position which is computed at draw() time.
821 // So we need a redraw!
822 buffer_.changed(false);
823 if (needsFitCursor())
831 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
833 if (d->cursor_.real_current_font.isRightToLeft()) {
834 if (d->intl_.keymap == Intl::PRIMARY)
835 d->intl_.keyMapSec();
837 if (d->intl_.keymap == Intl::SECONDARY)
838 d->intl_.keyMapPrim();
841 d->intl_.getTransManager().translateAndInsert(c, t, cur);
845 int BufferView::workWidth() const
851 void BufferView::recenter()
853 showCursor(d->cursor_, true, true);
857 void BufferView::showCursor()
859 showCursor(d->cursor_, false, true);
863 void BufferView::showCursor(DocIterator const & dit,
864 bool recenter, bool update)
866 if (scrollToCursor(dit, recenter) && update) {
867 buffer_.changed(true);
868 updateHoveredInset();
873 void BufferView::scrollToCursor()
875 if (scrollToCursor(d->cursor_, false)) {
876 buffer_.changed(true);
877 updateHoveredInset();
882 bool BufferView::scrollToCursor(DocIterator const & dit, bool const recenter)
884 // We are not properly started yet, delay until resizing is
889 LYXERR(Debug::SCROLLING, "recentering!");
891 CursorSlice const & bot = dit.bottom();
892 TextMetrics & tm = d->text_metrics_[bot.text()];
894 pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
895 int bot_pit = bot.pit();
896 if (bot_pit > max_pit) {
897 // FIXME: Why does this happen?
898 LYXERR0("bottom pit is greater that max pit: "
899 << bot_pit << " > " << max_pit);
903 if (bot_pit == tm.first().first - 1)
904 tm.newParMetricsUp();
905 else if (bot_pit == tm.last().first + 1)
906 tm.newParMetricsDown();
908 if (tm.contains(bot_pit)) {
909 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
910 LBUFERR(!pm.rows().empty());
911 // FIXME: smooth scrolling doesn't work in mathed.
912 CursorSlice const & cs = dit.innerTextSlice();
913 int offset = coordOffset(dit).y_;
914 int ypos = pm.position() + offset;
915 Dimension const & row_dim =
916 pm.getRow(cs.pos(), dit.boundary()).dimension();
919 scrolled = scroll(ypos - height_/2);
921 // We try to visualize the whole row, if the row height is larger than
922 // the screen height, we scroll to a heuristic value of height_ / 4.
923 // FIXME: This heuristic value should be replaced by a recursive search
924 // for a row in the inset that can be visualized completely.
925 else if (row_dim.height() > height_) {
926 if (ypos < defaultRowHeight())
927 scrolled = scroll(ypos - height_ / 4);
928 else if (ypos > height_ - defaultRowHeight())
929 scrolled = scroll(ypos - 3 * height_ / 4);
932 // If the top part of the row falls of the screen, we scroll
933 // up to align the top of the row with the top of the screen.
934 else if (ypos - row_dim.ascent() < 0 && ypos < height_) {
935 int ynew = row_dim.ascent();
936 scrolled = scrollUp(ynew - ypos);
939 // If the bottom of the row falls of the screen, we scroll down.
940 else if (ypos + row_dim.descent() > height_ && ypos > 0) {
941 int ynew = height_ - row_dim.descent();
942 scrolled = scrollDown(ypos - ynew);
945 // else, nothing to do, the cursor is already visible so we just return.
946 return scrolled != 0;
949 // fix inline completion position
950 if (d->inlineCompletionPos_.fixIfBroken())
951 d->inlineCompletionPos_ = DocIterator();
953 tm.redoParagraph(bot_pit);
954 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
955 int offset = coordOffset(dit).y_;
957 d->anchor_pit_ = bot_pit;
958 CursorSlice const & cs = dit.innerTextSlice();
959 Dimension const & row_dim =
960 pm.getRow(cs.pos(), dit.boundary()).dimension();
963 d->anchor_ypos_ = height_/2;
964 else if (d->anchor_pit_ == 0)
965 d->anchor_ypos_ = offset + pm.ascent();
966 else if (d->anchor_pit_ == max_pit)
967 d->anchor_ypos_ = height_ - offset - row_dim.descent();
968 else if (offset > height_)
969 d->anchor_ypos_ = height_ - offset - defaultRowHeight();
971 d->anchor_ypos_ = defaultRowHeight() * 2;
977 void BufferView::makeDocumentClass()
979 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
980 buffer_.params().makeDocumentClass();
981 updateDocumentClass(olddc);
985 void BufferView::updateDocumentClass(DocumentClassConstPtr olddc)
987 message(_("Converting document to new document class..."));
989 StableDocIterator backcur(d->cursor_);
990 ErrorList & el = buffer_.errorList("Class Switch");
991 cap::switchBetweenClasses(
992 olddc, buffer_.params().documentClassPtr(),
993 static_cast<InsetText &>(buffer_.inset()), el);
995 setCursor(backcur.asDocIterator(&buffer_));
997 buffer_.errors("Class Switch");
1001 /** Return the change status at cursor position, taking into account the
1002 * status at each level of the document iterator (a table in a deleted
1003 * footnote is deleted).
1004 * When \param outer is true, the top slice is not looked at.
1006 static Change::Type lookupChangeType(DocIterator const & dit, bool outer = false)
1008 size_t const depth = dit.depth() - (outer ? 1 : 0);
1010 for (size_t i = 0 ; i < depth ; ++i) {
1011 CursorSlice const & slice = dit[i];
1012 if (!slice.inset().inMathed()
1013 && slice.pos() < slice.paragraph().size()) {
1014 Change::Type const ch = slice.paragraph().lookupChange(slice.pos()).type;
1015 if (ch != Change::UNCHANGED)
1019 return Change::UNCHANGED;
1023 bool BufferView::getStatus(FuncRequest const & cmd, FuncStatus & flag)
1025 FuncCode const act = cmd.action();
1027 // Can we use a readonly buffer?
1028 if (buffer_.isReadonly()
1029 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1030 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1031 if (buffer_.hasReadonlyFlag())
1032 flag.message(from_utf8(N_("Document is read-only")));
1034 flag.message(from_utf8(N_("Document has been modified externally")));
1035 flag.setEnabled(false);
1039 // Are we in a DELETED change-tracking region?
1040 if (lookupChangeType(d->cursor_, true) == Change::DELETED
1041 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1042 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1043 flag.message(from_utf8(N_("This portion of the document is deleted.")));
1044 flag.setEnabled(false);
1048 Cursor & cur = d->cursor_;
1050 if (cur.getStatus(cmd, flag))
1055 // FIXME: This is a bit problematic because we don't check if this is
1056 // a document BufferView or not for these LFUNs. We probably have to
1057 // dispatch both to currentBufferView() and, if that fails,
1058 // to documentBufferView(); same as we do now for current Buffer and
1059 // document Buffer. Ideally those LFUN should go to Buffer as they
1060 // operate on the full Buffer and the cursor is only needed either for
1061 // an Undo record or to restore a cursor position. But we don't know
1062 // how to do that inside Buffer of course.
1063 case LFUN_BUFFER_PARAMS_APPLY:
1064 case LFUN_LAYOUT_MODULES_CLEAR:
1065 case LFUN_LAYOUT_MODULE_ADD:
1066 case LFUN_LAYOUT_RELOAD:
1067 case LFUN_TEXTCLASS_APPLY:
1068 case LFUN_TEXTCLASS_LOAD:
1069 flag.setEnabled(!buffer_.isReadonly());
1073 // We do not use the LyXAction flag for readonly because Undo sets the
1074 // buffer clean/dirty status by itself.
1075 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasUndoStack());
1078 // We do not use the LyXAction flag for readonly because Redo sets the
1079 // buffer clean/dirty status by itself.
1080 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasRedoStack());
1082 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
1083 case LFUN_FILE_INSERT_PLAINTEXT: {
1084 docstring const fname = cmd.argument();
1085 if (!FileName::isAbsolute(to_utf8(fname))) {
1086 flag.message(_("Absolute filename expected."));
1089 flag.setEnabled(cur.inTexted());
1092 case LFUN_FILE_INSERT:
1093 case LFUN_BOOKMARK_SAVE:
1094 // FIXME: Actually, these LFUNS should be moved to Text
1095 flag.setEnabled(cur.inTexted());
1098 case LFUN_FONT_STATE:
1099 case LFUN_LABEL_INSERT:
1100 case LFUN_INFO_INSERT:
1101 case LFUN_PARAGRAPH_GOTO:
1102 case LFUN_NOTE_NEXT:
1103 case LFUN_REFERENCE_NEXT:
1104 case LFUN_WORD_FIND:
1105 case LFUN_WORD_FIND_FORWARD:
1106 case LFUN_WORD_FIND_BACKWARD:
1107 case LFUN_WORD_REPLACE:
1110 case LFUN_MARK_TOGGLE:
1111 case LFUN_SCREEN_RECENTER:
1112 case LFUN_SCREEN_SHOW_CURSOR:
1113 case LFUN_BIBTEX_DATABASE_ADD:
1114 case LFUN_BIBTEX_DATABASE_DEL:
1115 case LFUN_STATISTICS:
1116 case LFUN_KEYMAP_OFF:
1117 case LFUN_KEYMAP_PRIMARY:
1118 case LFUN_KEYMAP_SECONDARY:
1119 case LFUN_KEYMAP_TOGGLE:
1120 case LFUN_INSET_SELECT_ALL:
1121 flag.setEnabled(true);
1124 case LFUN_WORD_FINDADV: {
1125 FindAndReplaceOptions opt;
1126 istringstream iss(to_utf8(cmd.argument()));
1128 flag.setEnabled(opt.repl_buf_name.empty()
1129 || !buffer_.isReadonly());
1133 case LFUN_LABEL_GOTO:
1134 flag.setEnabled(!cmd.argument().empty()
1135 || getInsetByCode<InsetRef>(cur, REF_CODE));
1138 case LFUN_CHANGES_MERGE:
1139 case LFUN_CHANGE_NEXT:
1140 case LFUN_CHANGE_PREVIOUS:
1141 case LFUN_ALL_CHANGES_ACCEPT:
1142 case LFUN_ALL_CHANGES_REJECT:
1143 flag.setEnabled(buffer_.areChangesPresent());
1146 case LFUN_SCREEN_UP:
1147 case LFUN_SCREEN_DOWN:
1149 case LFUN_SCREEN_UP_SELECT:
1150 case LFUN_SCREEN_DOWN_SELECT:
1151 case LFUN_INSET_FORALL:
1152 flag.setEnabled(true);
1155 case LFUN_LAYOUT_TABULAR:
1156 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
1160 flag.setEnabled(!cur.inset().forcePlainLayout(cur.idx()));
1163 case LFUN_LAYOUT_PARAGRAPH:
1164 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
1167 case LFUN_BRANCH_ADD_INSERT:
1168 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1171 case LFUN_DIALOG_SHOW_NEW_INSET:
1172 // FIXME: this is wrong, but I do not understand the
1174 if (cur.inset().lyxCode() == CAPTION_CODE)
1175 return cur.inset().getStatus(cur, cmd, flag);
1176 // FIXME we should consider passthru paragraphs too.
1177 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1180 case LFUN_CITATION_INSERT: {
1181 FuncRequest fr(LFUN_INSET_INSERT, "citation");
1182 // FIXME: This could turn in a recursive hell.
1183 // Shouldn't we use Buffer::getStatus() instead?
1184 flag.setEnabled(lyx::getStatus(fr).enabled());
1187 case LFUN_INSET_APPLY: {
1188 string const name = cmd.getArg(0);
1189 Inset * inset = editedInset(name);
1191 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1192 if (!inset->getStatus(cur, fr, flag)) {
1193 // Every inset is supposed to handle this
1194 LASSERT(false, break);
1197 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1198 flag = lyx::getStatus(fr);
1211 Inset * BufferView::editedInset(string const & name) const
1213 map<string, Inset *>::const_iterator it = d->edited_insets_.find(name);
1214 return it == d->edited_insets_.end() ? 0 : it->second;
1218 void BufferView::editInset(string const & name, Inset * inset)
1220 d->edited_insets_[name] = inset;
1224 void BufferView::dispatch(FuncRequest const & cmd, DispatchResult & dr)
1226 LYXERR(Debug::ACTION, "BufferView::dispatch: cmd: " << cmd);
1228 string const argument = to_utf8(cmd.argument());
1229 Cursor & cur = d->cursor_;
1232 // Don't dispatch function that does not apply to internal buffers.
1233 if (buffer_.isInternal()
1234 && lyxaction.funcHasFlag(cmd.action(), LyXAction::NoInternal))
1237 // We'll set this back to false if need be.
1238 bool dispatched = true;
1239 buffer_.undo().beginUndoGroup();
1241 FuncCode const act = cmd.action();
1244 case LFUN_BUFFER_PARAMS_APPLY: {
1245 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1246 cur.recordUndoBufferParams();
1247 istringstream ss(to_utf8(cmd.argument()));
1250 int const unknown_tokens = buffer_.readHeader(lex);
1251 if (unknown_tokens != 0) {
1252 LYXERR0("Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1253 << unknown_tokens << " unknown token"
1254 << (unknown_tokens == 1 ? "" : "s"));
1256 updateDocumentClass(olddc);
1258 // We are most certainly here because of a change in the document
1259 // It is then better to make sure that all dialogs are in sync with
1260 // current document settings.
1261 dr.screenUpdate(Update::Force | Update::FitCursor);
1262 dr.forceBufferUpdate();
1266 case LFUN_LAYOUT_MODULES_CLEAR: {
1267 // FIXME: this modifies the document in cap::switchBetweenClasses
1268 // without calling recordUndo. Fix this before using
1269 // recordUndoBufferParams().
1270 cur.recordUndoFullBuffer();
1271 buffer_.params().clearLayoutModules();
1272 makeDocumentClass();
1273 dr.screenUpdate(Update::Force);
1274 dr.forceBufferUpdate();
1278 case LFUN_LAYOUT_MODULE_ADD: {
1279 BufferParams const & params = buffer_.params();
1280 if (!params.layoutModuleCanBeAdded(argument)) {
1281 LYXERR0("Module `" << argument <<
1282 "' cannot be added due to failed requirements or "
1283 "conflicts with installed modules.");
1286 // FIXME: this modifies the document in cap::switchBetweenClasses
1287 // without calling recordUndo. Fix this before using
1288 // recordUndoBufferParams().
1289 cur.recordUndoFullBuffer();
1290 buffer_.params().addLayoutModule(argument);
1291 makeDocumentClass();
1292 dr.screenUpdate(Update::Force);
1293 dr.forceBufferUpdate();
1297 case LFUN_TEXTCLASS_APPLY: {
1298 // since this shortcircuits, the second call is made only if
1300 bool const success =
1301 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1302 LayoutFileList::get().load(argument, buffer_.filePath());
1304 docstring s = bformat(_("The document class `%1$s' "
1305 "could not be loaded."), from_utf8(argument));
1306 frontend::Alert::error(_("Could not load class"), s);
1310 LayoutFile const * old_layout = buffer_.params().baseClass();
1311 LayoutFile const * new_layout = &(LayoutFileList::get()[argument]);
1313 if (old_layout == new_layout)
1317 // Save the old, possibly modular, layout for use in conversion.
1318 // FIXME: this modifies the document in cap::switchBetweenClasses
1319 // without calling recordUndo. Fix this before using
1320 // recordUndoBufferParams().
1321 cur.recordUndoFullBuffer();
1322 buffer_.params().setBaseClass(argument);
1323 makeDocumentClass();
1324 dr.screenUpdate(Update::Force);
1325 dr.forceBufferUpdate();
1329 case LFUN_TEXTCLASS_LOAD: {
1330 // since this shortcircuits, the second call is made only if
1332 bool const success =
1333 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1334 LayoutFileList::get().load(argument, buffer_.filePath());
1336 docstring s = bformat(_("The document class `%1$s' "
1337 "could not be loaded."), from_utf8(argument));
1338 frontend::Alert::error(_("Could not load class"), s);
1343 case LFUN_LAYOUT_RELOAD: {
1344 LayoutFileIndex bc = buffer_.params().baseClassID();
1345 LayoutFileList::get().reset(bc);
1346 buffer_.params().setBaseClass(bc);
1347 makeDocumentClass();
1348 dr.screenUpdate(Update::Force);
1349 dr.forceBufferUpdate();
1354 dr.setMessage(_("Undo"));
1355 cur.clearSelection();
1356 if (!cur.textUndo())
1357 dr.setMessage(_("No further undo information"));
1359 dr.screenUpdate(Update::Force | Update::FitCursor);
1360 dr.forceBufferUpdate();
1361 // we only need to do this if we have deleted or restored a
1362 // BiBTeX inset. but there is no other place to do it. one
1363 // obvious idea is to try to do it in a copy constructor for
1364 // InsetBibTeX, but when that is invoked, the buffer_ member
1365 // is not yet set. another idea is to look at the InsetLists
1366 // of the various paragraphs. but we'd have to recurse through
1367 // the contained insets to make that work. it doesn't seem to
1368 // be worth it, as this will not happen that often.
1369 buffer().invalidateBibfileCache();
1370 buffer().removeBiblioTempFiles();
1374 dr.setMessage(_("Redo"));
1375 cur.clearSelection();
1376 if (!cur.textRedo())
1377 dr.setMessage(_("No further redo information"));
1379 dr.screenUpdate(Update::Force | Update::FitCursor);
1380 dr.forceBufferUpdate();
1382 buffer().invalidateBibfileCache();
1383 buffer().removeBiblioTempFiles();
1386 case LFUN_FONT_STATE:
1387 dr.setMessage(cur.currentState());
1390 case LFUN_BOOKMARK_SAVE:
1391 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1394 case LFUN_LABEL_GOTO: {
1395 docstring label = cmd.argument();
1396 if (label.empty()) {
1398 getInsetByCode<InsetRef>(cur, REF_CODE);
1400 label = inset->getParam("reference");
1401 // persistent=false: use temp_bookmark
1405 if (!label.empty()) {
1407 // at the moment, this is redundant, since gotoLabel will
1408 // eventually call LFUN_PARAGRAPH_GOTO, but it seems best
1410 dr.screenUpdate(Update::Force | Update::FitCursor);
1415 case LFUN_PARAGRAPH_GOTO: {
1416 int const id = convert<int>(cmd.getArg(0));
1417 pos_type const pos = convert<int>(cmd.getArg(1));
1420 string const str_id_end = cmd.getArg(2);
1421 string const str_pos_end = cmd.getArg(3);
1423 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1424 b = theBufferList().next(b)) {
1427 cur.setCursor(b->getParFromID(id));
1429 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1433 LYXERR(Debug::INFO, "Paragraph " << cur.paragraph().id()
1434 << " found in buffer `"
1435 << b->absFileName() << "'.");
1437 if (b == &buffer_) {
1439 if (str_id_end.empty() || str_pos_end.empty()) {
1442 mouseSetCursor(cur);
1445 int const id_end = convert<int>(str_id_end);
1446 pos_type const pos_end = convert<int>(str_pos_end);
1447 success = setCursorFromEntries({id, pos},
1451 dr.screenUpdate(Update::Force | Update::FitCursor);
1453 // Switch to other buffer view and resend cmd
1454 lyx::dispatch(FuncRequest(
1455 LFUN_BUFFER_SWITCH, b->absFileName()));
1463 case LFUN_NOTE_NEXT:
1464 gotoInset(this, NOTE_CODE, false);
1467 case LFUN_REFERENCE_NEXT: {
1468 vector<InsetCode> tmp;
1469 tmp.push_back(LABEL_CODE);
1470 tmp.push_back(REF_CODE);
1471 gotoInset(this, tmp, true);
1475 case LFUN_CHANGE_NEXT:
1476 findNextChange(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_CHANGE_PREVIOUS:
1482 findPreviousChange(this);
1483 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1484 dr.screenUpdate(Update::Force | Update::FitCursor);
1487 case LFUN_CHANGES_MERGE:
1488 if (findNextChange(this) || findPreviousChange(this)) {
1489 dr.screenUpdate(Update::Force | Update::FitCursor);
1490 dr.forceBufferUpdate();
1491 showDialog("changes");
1495 case LFUN_ALL_CHANGES_ACCEPT:
1496 // select complete document
1498 cur.selHandle(true);
1499 buffer_.text().cursorBottom(cur);
1500 // accept everything in a single step to support atomic undo
1501 buffer_.text().acceptOrRejectChanges(cur, Text::ACCEPT);
1503 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1504 dr.screenUpdate(Update::Force | Update::FitCursor);
1505 dr.forceBufferUpdate();
1508 case LFUN_ALL_CHANGES_REJECT:
1509 // select complete document
1511 cur.selHandle(true);
1512 buffer_.text().cursorBottom(cur);
1513 // reject everything in a single step to support atomic undo
1514 // Note: reject does not work recursively; the user may have to repeat the operation
1515 buffer_.text().acceptOrRejectChanges(cur, Text::REJECT);
1517 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1518 dr.screenUpdate(Update::Force | Update::FitCursor);
1519 dr.forceBufferUpdate();
1522 case LFUN_WORD_FIND_FORWARD:
1523 case LFUN_WORD_FIND_BACKWARD: {
1525 // Would it maybe be better if this variable were view specific anyway?
1526 static docstring last_search;
1527 docstring searched_string;
1529 if (!cmd.argument().empty()) {
1530 last_search = cmd.argument();
1531 searched_string = cmd.argument();
1533 searched_string = last_search;
1536 if (searched_string.empty())
1539 bool const fw = act == LFUN_WORD_FIND_FORWARD;
1540 docstring const data =
1541 find2string(searched_string, true, false, fw);
1542 bool found = lyxfind(this, FuncRequest(LFUN_WORD_FIND, data));
1544 dr.screenUpdate(Update::Force | Update::FitCursor);
1548 case LFUN_WORD_FIND: {
1549 FuncRequest req = cmd;
1550 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1551 req = d->search_request_cache_;
1552 if (req.argument().empty()) {
1553 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, "findreplace"));
1556 if (lyxfind(this, req))
1557 dr.screenUpdate(Update::Force | Update::FitCursor);
1559 d->search_request_cache_ = req;
1563 case LFUN_WORD_REPLACE: {
1564 bool has_deleted = false;
1565 if (cur.selection()) {
1566 DocIterator beg = cur.selectionBegin();
1567 DocIterator end = cur.selectionEnd();
1568 if (beg.pit() == end.pit()) {
1569 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1570 if (!cur.inMathed() && cur.paragraph().isDeleted(p)) {
1577 if (lyxreplace(this, cmd, has_deleted)) {
1578 dr.forceBufferUpdate();
1579 dr.screenUpdate(Update::Force | Update::FitCursor);
1584 case LFUN_WORD_FINDADV: {
1585 FindAndReplaceOptions opt;
1586 istringstream iss(to_utf8(cmd.argument()));
1588 if (findAdv(this, opt)) {
1589 dr.screenUpdate(Update::Force | Update::FitCursor);
1600 cur.clearSelection();
1601 dr.setMessage(from_utf8(N_("Mark off")));
1605 cur.clearSelection();
1607 dr.setMessage(from_utf8(N_("Mark on")));
1610 case LFUN_MARK_TOGGLE:
1611 cur.selection(false);
1614 dr.setMessage(from_utf8(N_("Mark removed")));
1617 dr.setMessage(from_utf8(N_("Mark set")));
1622 case LFUN_SCREEN_SHOW_CURSOR:
1626 case LFUN_SCREEN_RECENTER:
1630 case LFUN_BIBTEX_DATABASE_ADD: {
1631 Cursor tmpcur = cur;
1632 findInset(tmpcur, BIBTEX_CODE, false);
1633 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1636 if (inset->addDatabase(cmd.argument())) {
1637 buffer_.invalidateBibfileCache();
1638 dr.forceBufferUpdate();
1644 case LFUN_BIBTEX_DATABASE_DEL: {
1645 Cursor tmpcur = cur;
1646 findInset(tmpcur, BIBTEX_CODE, false);
1647 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1650 if (inset->delDatabase(cmd.argument())) {
1651 buffer_.invalidateBibfileCache();
1652 dr.forceBufferUpdate();
1658 case LFUN_STATISTICS: {
1659 DocIterator from, to;
1660 if (cur.selection()) {
1661 from = cur.selectionBegin();
1662 to = cur.selectionEnd();
1664 from = doc_iterator_begin(&buffer_);
1665 to = doc_iterator_end(&buffer_);
1667 buffer_.updateStatistics(from, to);
1668 int const words = buffer_.wordCount();
1669 int const chars = buffer_.charCount(false);
1670 int const chars_blanks = buffer_.charCount(true);
1672 if (cur.selection())
1673 message = _("Statistics for the selection:");
1675 message = _("Statistics for the document:");
1678 message += bformat(_("%1$d words"), words);
1680 message += _("One word");
1682 if (chars_blanks != 1)
1683 message += bformat(_("%1$d characters (including blanks)"),
1686 message += _("One character (including blanks)");
1689 message += bformat(_("%1$d characters (excluding blanks)"),
1692 message += _("One character (excluding blanks)");
1694 Alert::information(_("Statistics"), message);
1698 case LFUN_SCREEN_UP:
1699 case LFUN_SCREEN_DOWN: {
1700 Point p = getPos(cur);
1701 // This code has been commented out to enable to scroll down a
1702 // document, even if there are large insets in it (see bug #5465).
1703 /*if (p.y_ < 0 || p.y_ > height_) {
1704 // The cursor is off-screen so recenter before proceeding.
1708 int const scrolled = scroll(act == LFUN_SCREEN_UP
1709 ? -height_ : height_);
1710 if (act == LFUN_SCREEN_UP && scrolled > -height_)
1712 if (act == LFUN_SCREEN_DOWN && scrolled < height_)
1713 p = Point(width_, height_);
1714 bool const in_texted = cur.inTexted();
1715 cur.setCursor(doc_iterator_begin(cur.buffer()));
1716 cur.selHandle(false);
1717 buffer_.changed(true);
1718 updateHoveredInset();
1720 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_,
1721 true, act == LFUN_SCREEN_UP);
1722 //FIXME: what to do with cur.x_target()?
1723 bool update = in_texted && cur.bv().checkDepm(cur, old);
1726 if (update || cur.mark())
1727 dr.screenUpdate(Update::Force | Update::FitCursor);
1729 dr.forceBufferUpdate();
1734 string const scroll_type = cmd.getArg(0);
1735 int scroll_step = 0;
1736 if (scroll_type == "line")
1737 scroll_step = d->scrollbarParameters_.single_step;
1738 else if (scroll_type == "page")
1739 scroll_step = d->scrollbarParameters_.page_step;
1742 string const scroll_quantity = cmd.getArg(1);
1743 if (scroll_quantity == "up")
1744 scrollUp(scroll_step);
1745 else if (scroll_quantity == "down")
1746 scrollDown(scroll_step);
1748 int const scroll_value = convert<int>(scroll_quantity);
1750 scroll(scroll_step * scroll_value);
1752 buffer_.changed(true);
1753 updateHoveredInset();
1754 dr.forceBufferUpdate();
1758 case LFUN_SCREEN_UP_SELECT: {
1759 // FIXME: why is the algorithm different from LFUN_SCREEN_UP?
1760 cur.selHandle(true);
1761 if (isTopScreen()) {
1762 lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1766 int y = getPos(cur).y_;
1767 int const ymin = y - height_ + defaultRowHeight();
1768 while (y > ymin && cur.up())
1772 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1776 case LFUN_SCREEN_DOWN_SELECT: {
1777 // FIXME: why is the algorithm different from LFUN_SCREEN_DOWN?
1778 cur.selHandle(true);
1779 if (isBottomScreen()) {
1780 lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1784 int y = getPos(cur).y_;
1785 int const ymax = y + height_ - defaultRowHeight();
1786 while (y < ymax && cur.down())
1790 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1795 case LFUN_INSET_SELECT_ALL: {
1796 // true if all cells are selected
1797 bool const all_selected = cur.depth() > 1
1798 && cur.selBegin().at_begin()
1799 && cur.selEnd().at_end();
1800 // true if some cells are selected
1801 bool const cells_selected = cur.depth() > 1
1802 && cur.selBegin().at_cell_begin()
1803 && cur.selEnd().at_cell_end();
1804 if (all_selected || (cells_selected && !cur.inset().isTable())) {
1805 // All the contents of the inset if selected, or only at
1806 // least one cell but inset is not a table.
1807 // Select the inset from outside.
1810 cur.selection(true);
1812 } else if (cells_selected) {
1813 // At least one complete cell is selected and inset is a table.
1818 cur.selection(true);
1819 cur.idx() = cur.lastidx();
1820 cur.pos() = cur.lastpos();
1822 // select current cell
1826 cur.selection(true);
1827 cur.pit() = cur.lastpit();
1828 cur.pos() = cur.lastpos();
1830 cur.setCurrentFont();
1831 dr.screenUpdate(Update::Force);
1836 // This would be in Buffer class if only Cursor did not
1837 // require a bufferview
1838 case LFUN_INSET_FORALL: {
1839 docstring const name = from_utf8(cmd.getArg(0));
1840 string const commandstr = cmd.getLongArg(1);
1841 FuncRequest const fr = lyxaction.lookupFunc(commandstr);
1843 // an arbitrary number to limit number of iterations
1844 const int max_iter = 100000;
1846 Cursor & cur = d->cursor_;
1847 Cursor const savecur = cur;
1849 if (!cur.nextInset())
1851 cur.beginUndoGroup();
1852 while(cur && iterations < max_iter) {
1853 Inset * const ins = cur.nextInset();
1856 docstring insname = ins->layoutName();
1857 while (!insname.empty()) {
1858 if (insname == name || name == from_utf8("*")) {
1860 lyx::dispatch(fr, dr);
1864 size_t const i = insname.rfind(':');
1865 if (i == string::npos)
1867 insname = insname.substr(0, i);
1869 // if we did not delete the inset, skip it
1870 if (!cur.nextInset() || cur.nextInset() == ins)
1875 /** This is a dummy undo record only to remember the cursor
1876 * that has just been set; this will be used on a redo action
1877 * (see ticket #10097)
1879 * FIXME: a better fix would be to have a way to set the
1880 * cursor value directly, but I am not sure it is worth it.
1884 dr.screenUpdate(Update::Force);
1885 dr.forceBufferUpdate();
1887 if (iterations >= max_iter) {
1889 dr.setMessage(bformat(_("`inset-forall' interrupted because number of actions is larger than %1$d"), max_iter));
1891 dr.setMessage(bformat(_("Applied \"%1$s\" to %2$d insets"), from_utf8(commandstr), iterations));
1896 case LFUN_BRANCH_ADD_INSERT: {
1897 docstring branch_name = from_utf8(cmd.getArg(0));
1898 if (branch_name.empty())
1899 if (!Alert::askForText(branch_name, _("Branch name")) ||
1900 branch_name.empty())
1903 DispatchResult drtmp;
1904 buffer_.dispatch(FuncRequest(LFUN_BRANCH_ADD, branch_name), drtmp);
1905 if (drtmp.error()) {
1906 Alert::warning(_("Branch already exists"), drtmp.message());
1909 BranchList & branch_list = buffer_.params().branchlist();
1910 vector<docstring> const branches =
1911 getVectorFromString(branch_name, branch_list.separator());
1912 for (vector<docstring>::const_iterator it = branches.begin();
1913 it != branches.end(); ++it) {
1915 lyx::dispatch(FuncRequest(LFUN_BRANCH_INSERT, branch_name));
1920 case LFUN_KEYMAP_OFF:
1921 getIntl().keyMapOn(false);
1924 case LFUN_KEYMAP_PRIMARY:
1925 getIntl().keyMapPrim();
1928 case LFUN_KEYMAP_SECONDARY:
1929 getIntl().keyMapSec();
1932 case LFUN_KEYMAP_TOGGLE:
1933 getIntl().toggleKeyMap();
1936 case LFUN_DIALOG_SHOW_NEW_INSET: {
1937 string const name = cmd.getArg(0);
1938 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
1939 if (decodeInsetParam(name, data, buffer_))
1940 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
1942 lyxerr << "Inset type '" << name <<
1943 "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" << endl;
1947 case LFUN_CITATION_INSERT: {
1948 if (argument.empty()) {
1949 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
1952 // we can have one optional argument, delimited by '|'
1953 // citation-insert <key>|<text_before>
1954 // this should be enhanced to also support text_after
1955 // and citation style
1956 string arg = argument;
1958 if (contains(argument, "|")) {
1959 arg = token(argument, '|', 0);
1960 opt1 = token(argument, '|', 1);
1963 // if our cursor is directly in front of or behind a citation inset,
1964 // we will instead add the new key to it.
1965 Inset * inset = cur.nextInset();
1966 if (!inset || inset->lyxCode() != CITE_CODE)
1967 inset = cur.prevInset();
1968 if (inset && inset->lyxCode() == CITE_CODE) {
1969 InsetCitation * icite = static_cast<InsetCitation *>(inset);
1970 if (icite->addKey(arg)) {
1971 dr.forceBufferUpdate();
1972 dr.screenUpdate(Update::FitCursor | Update::SinglePar);
1974 LYXERR0("Discarding optional argument to citation-insert.");
1979 InsetCommandParams icp(CITE_CODE);
1980 icp["key"] = from_utf8(arg);
1982 icp["before"] = from_utf8(opt1);
1983 string icstr = InsetCommand::params2string(icp);
1984 FuncRequest fr(LFUN_INSET_INSERT, icstr);
1989 case LFUN_INSET_APPLY: {
1990 string const name = cmd.getArg(0);
1991 Inset * inset = editedInset(name);
1993 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1997 // put cursor in front of inset.
1998 if (!setCursorFromInset(inset)) {
1999 LASSERT(false, break);
2002 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
2003 inset->dispatch(cur, fr);
2004 dr.screenUpdate(cur.result().screenUpdate());
2005 if (cur.result().needBufferUpdate())
2006 dr.forceBufferUpdate();
2011 // The change of language of buffer belongs to the Buffer class.
2012 // We have to do it here because we need a cursor for Undo.
2013 // When Undo::recordUndoBufferParams() is implemented someday
2014 // LFUN_BUFFER_LANGUAGE should be handled by the Buffer class.
2015 case LFUN_BUFFER_LANGUAGE: {
2016 Language const * oldL = buffer_.params().language;
2017 Language const * newL = languages.getLanguage(argument);
2018 if (!newL || oldL == newL)
2020 if (oldL->rightToLeft() == newL->rightToLeft()) {
2021 cur.recordUndoFullBuffer();
2022 buffer_.changeLanguage(oldL, newL);
2023 cur.setCurrentFont();
2024 dr.forceBufferUpdate();
2029 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
2030 case LFUN_FILE_INSERT_PLAINTEXT: {
2031 bool const as_paragraph = (act == LFUN_FILE_INSERT_PLAINTEXT_PARA);
2032 string const fname = to_utf8(cmd.argument());
2033 if (!FileName::isAbsolute(fname))
2034 dr.setMessage(_("Absolute filename expected."));
2036 insertPlaintextFile(FileName(fname), as_paragraph);
2041 // OK, so try the Buffer itself...
2042 buffer_.dispatch(cmd, dr);
2043 dispatched = dr.dispatched();
2047 buffer_.undo().endUndoGroup();
2048 dr.dispatched(dispatched);
2050 // NOTE: The code below is copied from Cursor::dispatch. If you
2051 // need to modify this, please update the other one too.
2053 // notify insets we just entered/left
2054 if (cursor() != old) {
2055 old.beginUndoGroup();
2057 bool badcursor = notifyCursorLeavesOrEnters(old, cursor());
2059 cursor().fixIfBroken();
2060 resetInlineCompletionPos();
2067 docstring const BufferView::requestSelection()
2069 Cursor & cur = d->cursor_;
2071 LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
2072 if (!cur.selection()) {
2073 d->xsel_cache_.set = false;
2077 LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
2078 if (!d->xsel_cache_.set ||
2079 cur.top() != d->xsel_cache_.cursor ||
2080 cur.realAnchor().top() != d->xsel_cache_.anchor)
2082 d->xsel_cache_.cursor = cur.top();
2083 d->xsel_cache_.anchor = cur.realAnchor().top();
2084 d->xsel_cache_.set = cur.selection();
2085 return cur.selectionAsString(false);
2091 void BufferView::clearSelection()
2093 d->cursor_.clearSelection();
2094 // Clear the selection buffer. Otherwise a subsequent
2095 // middle-mouse-button paste would use the selection buffer,
2096 // not the more current external selection.
2097 cap::clearSelection();
2098 d->xsel_cache_.set = false;
2099 // The buffer did not really change, but this causes the
2100 // redraw we need because we cleared the selection above.
2101 buffer_.changed(false);
2105 void BufferView::resize(int width, int height)
2107 // Update from work area
2111 // Clear the paragraph height cache.
2112 d->par_height_.clear();
2113 // Redo the metrics.
2118 Inset const * BufferView::getCoveringInset(Text const & text,
2121 TextMetrics & tm = d->text_metrics_[&text];
2122 Inset * inset = tm.checkInsetHit(x, y);
2126 if (!inset->descendable(*this))
2127 // No need to go further down if the inset is not
2131 size_t cell_number = inset->nargs();
2132 // Check all the inner cell.
2133 for (size_t i = 0; i != cell_number; ++i) {
2134 Text const * inner_text = inset->getText(i);
2137 Inset const * inset_deeper =
2138 getCoveringInset(*inner_text, x, y);
2140 return inset_deeper;
2148 void BufferView::updateHoveredInset() const
2150 // Get inset under mouse, if there is one.
2151 int const x = d->mouse_position_cache_.x_;
2152 int const y = d->mouse_position_cache_.y_;
2153 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
2155 d->clickable_inset_ = covering_inset && covering_inset->clickable(*this, x, y);
2157 if (covering_inset == d->last_inset_)
2158 // Same inset, no need to do anything...
2161 bool need_redraw = false;
2162 if (d->last_inset_) {
2163 // Remove the hint on the last hovered inset (if any).
2164 need_redraw |= d->last_inset_->setMouseHover(this, false);
2168 if (covering_inset && covering_inset->setMouseHover(this, true)) {
2170 // Only the insets that accept the hover state, do
2171 // clear the last_inset_, so only set the last_inset_
2172 // member if the hovered setting is accepted.
2173 d->last_inset_ = covering_inset;
2177 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
2178 << d->mouse_position_cache_.x_ << ", "
2179 << d->mouse_position_cache_.y_ << ")");
2181 d->update_strategy_ = DecorationUpdate;
2183 // This event (moving without mouse click) is not passed further.
2184 // This should be changed if it is further utilized.
2185 buffer_.changed(false);
2190 void BufferView::clearLastInset(Inset * inset) const
2192 if (d->last_inset_ != inset) {
2193 LYXERR0("Wrong last_inset!");
2200 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
2202 //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
2204 // This is only called for mouse related events including
2205 // LFUN_FILE_OPEN generated by drag-and-drop.
2206 FuncRequest cmd = cmd0;
2208 Cursor old = cursor();
2210 cur.push(buffer_.inset());
2211 cur.selection(d->cursor_.selection());
2213 // Either the inset under the cursor or the
2214 // surrounding Text will handle this event.
2216 // make sure we stay within the screen...
2217 cmd.set_y(min(max(cmd.y(), -1), height_));
2219 d->mouse_position_cache_.x_ = cmd.x();
2220 d->mouse_position_cache_.y_ = cmd.y();
2222 if (cmd.action() == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
2223 updateHoveredInset();
2227 // Build temporary cursor.
2228 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x(), cmd.y());
2230 // If inset is not editable, cur.pos() might point behind the
2231 // inset (depending on cmd.x(), cmd.y()). This is needed for
2232 // editing to fix bug 9628, but e.g. the context menu needs a
2233 // cursor in front of the inset.
2234 if ((inset->hasSettings() || !inset->contextMenuName().empty()
2235 || inset->lyxCode() == SEPARATOR_CODE) &&
2236 cur.nextInset() != inset && cur.prevInset() == inset)
2238 } else if (cur.inTexted() && cur.pos()
2239 && cur.paragraph().isEnvSeparator(cur.pos() - 1)) {
2240 // Always place cursor in front of a separator inset.
2244 // Put anchor at the same position.
2247 cur.beginUndoGroup();
2249 // Try to dispatch to an non-editable inset near this position
2250 // via the temp cursor. If the inset wishes to change the real
2251 // cursor it has to do so explicitly by using
2252 // cur.bv().cursor() = cur; (or similar)
2254 inset->dispatch(cur, cmd);
2256 // Now dispatch to the temporary cursor. If the real cursor should
2257 // be modified, the inset's dispatch has to do so explicitly.
2258 if (!inset || !cur.result().dispatched())
2261 // Notify left insets
2263 bool badcursor = old.fixIfBroken() | cur.fixIfBroken();
2264 badcursor |= notifyCursorLeavesOrEnters(old, cur);
2266 cursor().fixIfBroken();
2271 // Do we have a selection?
2272 theSelection().haveSelection(cursor().selection());
2274 if (cur.needBufferUpdate()) {
2275 cur.clearBufferUpdate();
2276 buffer().updateBuffer();
2279 // If the command has been dispatched,
2280 if (cur.result().dispatched() || cur.result().screenUpdate())
2281 processUpdateFlags(cur.result().screenUpdate());
2285 int BufferView::minVisiblePart()
2287 return 2 * defaultRowHeight();
2291 int BufferView::scroll(int y)
2294 return scrollDown(y);
2296 return scrollUp(-y);
2301 int BufferView::scrollDown(int offset)
2303 Text * text = &buffer_.text();
2304 TextMetrics & tm = d->text_metrics_[text];
2305 int const ymax = height_ + offset;
2307 pair<pit_type, ParagraphMetrics const *> last = tm.last();
2308 int bottom_pos = last.second->position() + last.second->descent();
2309 if (lyxrc.scroll_below_document)
2310 bottom_pos += height_ - minVisiblePart();
2311 if (last.first + 1 == int(text->paragraphs().size())) {
2312 if (bottom_pos <= height_)
2314 offset = min(offset, bottom_pos - height_);
2317 if (bottom_pos > ymax)
2319 tm.newParMetricsDown();
2321 d->anchor_ypos_ -= offset;
2326 int BufferView::scrollUp(int offset)
2328 Text * text = &buffer_.text();
2329 TextMetrics & tm = d->text_metrics_[text];
2330 int ymin = - offset;
2332 pair<pit_type, ParagraphMetrics const *> first = tm.first();
2333 int top_pos = first.second->position() - first.second->ascent();
2334 if (first.first == 0) {
2337 offset = min(offset, - top_pos);
2342 tm.newParMetricsUp();
2344 d->anchor_ypos_ += offset;
2349 bool BufferView::setCursorFromRow(int row)
2351 TexRow::TextEntry start, end;
2352 tie(start,end) = buffer_.texrow().getEntriesFromRow(row);
2353 LYXERR(Debug::LATEX,
2354 "setCursorFromRow: for row " << row << ", TexRow has found "
2355 "start (id=" << start.id << ",pos=" << start.pos << "), "
2356 "end (id=" << end.id << ",pos=" << end.pos << ")");
2357 return setCursorFromEntries(start, end);
2361 bool BufferView::setCursorFromEntries(TexRow::TextEntry start,
2362 TexRow::TextEntry end)
2364 DocIterator dit_start, dit_end;
2365 tie(dit_start,dit_end) =
2366 TexRow::getDocIteratorsFromEntries(start, end, buffer_);
2369 // Setting selection start
2370 d->cursor_.clearSelection();
2371 setCursor(dit_start);
2372 // Setting selection end
2374 d->cursor_.resetAnchor();
2375 setCursorSelectionTo(dit_end);
2381 bool BufferView::setCursorFromInset(Inset const * inset)
2383 // are we already there?
2384 if (cursor().nextInset() == inset)
2387 // Inset is not at cursor position. Find it in the document.
2390 while (cur && cur.nextInset() != inset)
2401 void BufferView::gotoLabel(docstring const & label)
2403 ListOfBuffers bufs = buffer().allRelatives();
2404 ListOfBuffers::iterator it = bufs.begin();
2405 for (; it != bufs.end(); ++it) {
2406 Buffer const * buf = *it;
2409 shared_ptr<Toc> toc = buf->tocBackend().toc("label");
2410 Toc::const_iterator toc_it = toc->begin();
2411 Toc::const_iterator end = toc->end();
2412 for (; toc_it != end; ++toc_it) {
2413 if (label == toc_it->str()) {
2414 lyx::dispatch(toc_it->action());
2422 TextMetrics const & BufferView::textMetrics(Text const * t) const
2424 return const_cast<BufferView *>(this)->textMetrics(t);
2428 TextMetrics & BufferView::textMetrics(Text const * t)
2431 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
2432 if (tmc_it == d->text_metrics_.end()) {
2433 tmc_it = d->text_metrics_.insert(
2434 make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
2436 return tmc_it->second;
2440 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
2443 return textMetrics(t).parMetrics(pit);
2447 int BufferView::workHeight() const
2453 void BufferView::setCursor(DocIterator const & dit)
2456 size_t const n = dit.depth();
2457 for (size_t i = 0; i < n; ++i)
2458 dit[i].inset().edit(d->cursor_, true);
2460 d->cursor_.setCursor(dit);
2461 d->cursor_.selection(false);
2462 d->cursor_.setCurrentFont();
2464 // It seems on general grounds as if this is probably needed, but
2465 // it is not yet clear.
2466 // See bug #7394 and r38388.
2467 // d->cursor.resetAnchor();
2471 void BufferView::setCursorSelectionTo(DocIterator const & dit)
2473 size_t const n = dit.depth();
2474 for (size_t i = 0; i < n; ++i)
2475 dit[i].inset().edit(d->cursor_, true);
2477 d->cursor_.selection(true);
2478 d->cursor_.setCursorSelectionTo(dit);
2479 d->cursor_.setCurrentFont();
2483 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
2485 // Would be wrong to delete anything if we have a selection.
2486 if (cur.selection())
2489 bool need_anchor_change = false;
2490 bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
2491 need_anchor_change);
2493 if (need_anchor_change)
2501 // we would rather not do this here, but it needs to be done before
2502 // the changed() signal is sent.
2503 buffer_.updateBuffer();
2505 buffer_.changed(true);
2510 bool BufferView::mouseSetCursor(Cursor & cur, bool const select)
2512 LASSERT(&cur.bv() == this, return false);
2515 // this event will clear selection so we save selection for
2516 // persistent selection
2517 cap::saveSelection(cursor());
2519 d->cursor_.macroModeClose();
2520 // If a macro has been finalized, the cursor might have been broken
2523 // Has the cursor just left the inset?
2524 bool const leftinset = (&d->cursor_.inset() != &cur.inset());
2526 d->cursor_.fixIfBroken();
2528 // do the dEPM magic if needed
2529 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
2530 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
2531 // the leftinset bool would not be necessary (badcursor instead).
2532 bool update = leftinset;
2535 d->cursor_.setSelection();
2536 d->cursor_.setCursorSelectionTo(cur);
2538 if (d->cursor_.inTexted())
2539 update |= checkDepm(cur, d->cursor_);
2540 d->cursor_.resetAnchor();
2541 d->cursor_.setCursor(cur);
2542 d->cursor_.clearSelection();
2544 d->cursor_.boundary(cur.boundary());
2545 d->cursor_.finishUndo();
2546 d->cursor_.setCurrentFont();
2548 cur.forceBufferUpdate();
2553 void BufferView::putSelectionAt(DocIterator const & cur,
2554 int length, bool backwards)
2556 d->cursor_.clearSelection();
2562 d->cursor_.pos() += length;
2563 d->cursor_.setSelection(d->cursor_, -length);
2565 d->cursor_.setSelection(d->cursor_, length);
2570 bool BufferView::selectIfEmpty(DocIterator & cur)
2572 if ((cur.inTexted() && !cur.paragraph().empty())
2573 || (cur.inMathed() && !cur.cell().empty()))
2576 pit_type const beg_pit = cur.pit();
2578 // The paragraph associated to this item isn't
2579 // the first one, so it can be selected
2582 // We have to resort to select the space between the
2583 // end of this item and the begin of the next one
2587 // If it is the only item in the document,
2588 // nothing can be selected
2591 pit_type const end_pit = cur.pit();
2592 pos_type const end_pos = cur.pos();
2593 d->cursor_.clearSelection();
2595 d->cursor_.setCursor(cur);
2596 d->cursor_.pit() = beg_pit;
2597 d->cursor_.pos() = 0;
2598 d->cursor_.selection(false);
2599 d->cursor_.resetAnchor();
2600 d->cursor_.pit() = end_pit;
2601 d->cursor_.pos() = end_pos;
2602 d->cursor_.setSelection();
2607 Cursor & BufferView::cursor()
2613 Cursor const & BufferView::cursor() const
2619 pit_type BufferView::anchor_ref() const
2621 return d->anchor_pit_;
2625 bool BufferView::singleParUpdate()
2627 Text & buftext = buffer_.text();
2628 pit_type const bottom_pit = d->cursor_.bottom().pit();
2629 TextMetrics & tm = textMetrics(&buftext);
2630 int old_height = tm.parMetrics(bottom_pit).height();
2632 // make sure inline completion pointer is ok
2633 if (d->inlineCompletionPos_.fixIfBroken())
2634 d->inlineCompletionPos_ = DocIterator();
2636 // In Single Paragraph mode, rebreak only
2637 // the (main text, not inset!) paragraph containing the cursor.
2638 // (if this paragraph contains insets etc., rebreaking will
2639 // recursively descend)
2640 tm.redoParagraph(bottom_pit);
2641 ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
2642 if (pm.height() != old_height)
2643 // Paragraph height has changed so we cannot proceed to
2644 // the singlePar optimisation.
2647 d->update_strategy_ = SingleParUpdate;
2649 LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
2650 << " y2: " << pm.position() + pm.descent()
2651 << " pit: " << bottom_pit
2652 << " singlepar: 1");
2657 void BufferView::updateMetrics()
2659 if (height_ == 0 || width_ == 0)
2662 Text & buftext = buffer_.text();
2663 pit_type const npit = int(buftext.paragraphs().size());
2665 // Clear out the position cache in case of full screen redraw,
2666 d->coord_cache_.clear();
2668 // Clear out paragraph metrics to avoid having invalid metrics
2669 // in the cache from paragraphs not relayouted below
2670 // The complete text metrics will be redone.
2671 d->text_metrics_.clear();
2673 TextMetrics & tm = textMetrics(&buftext);
2675 // make sure inline completion pointer is ok
2676 if (d->inlineCompletionPos_.fixIfBroken())
2677 d->inlineCompletionPos_ = DocIterator();
2679 if (d->anchor_pit_ >= npit)
2680 // The anchor pit must have been deleted...
2681 d->anchor_pit_ = npit - 1;
2683 // Rebreak anchor paragraph.
2684 tm.redoParagraph(d->anchor_pit_);
2685 ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
2688 if (d->anchor_pit_ == 0) {
2689 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
2691 // Complete buffer visible? Then it's easy.
2692 if (scrollRange == 0)
2693 d->anchor_ypos_ = anchor_pm.ascent();
2695 // FIXME: Some clever handling needed to show
2696 // the _first_ paragraph up to the top if the cursor is
2697 // in the first line.
2699 anchor_pm.setPosition(d->anchor_ypos_);
2701 LYXERR(Debug::PAINTING, "metrics: "
2702 << " anchor pit = " << d->anchor_pit_
2703 << " anchor ypos = " << d->anchor_ypos_);
2705 // Redo paragraphs above anchor if necessary.
2706 int y1 = d->anchor_ypos_ - anchor_pm.ascent();
2707 // We are now just above the anchor paragraph.
2708 pit_type pit1 = d->anchor_pit_ - 1;
2709 for (; pit1 >= 0 && y1 >= 0; --pit1) {
2710 tm.redoParagraph(pit1);
2711 ParagraphMetrics & pm = tm.par_metrics_[pit1];
2713 // Save the paragraph position in the cache.
2718 // Redo paragraphs below the anchor if necessary.
2719 int y2 = d->anchor_ypos_ + anchor_pm.descent();
2720 // We are now just below the anchor paragraph.
2721 pit_type pit2 = d->anchor_pit_ + 1;
2722 for (; pit2 < npit && y2 <= height_; ++pit2) {
2723 tm.redoParagraph(pit2);
2724 ParagraphMetrics & pm = tm.par_metrics_[pit2];
2726 // Save the paragraph position in the cache.
2731 LYXERR(Debug::PAINTING, "Metrics: "
2732 << " anchor pit = " << d->anchor_pit_
2733 << " anchor ypos = " << d->anchor_ypos_
2736 << " pit1 = " << pit1
2737 << " pit2 = " << pit2);
2739 d->update_strategy_ = FullScreenUpdate;
2741 if (lyxerr.debugging(Debug::WORKAREA)) {
2742 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
2743 d->coord_cache_.dump();
2748 void BufferView::insertLyXFile(FileName const & fname)
2750 LASSERT(d->cursor_.inTexted(), return);
2752 // Get absolute path of file and add ".lyx"
2753 // to the filename if necessary
2754 FileName filename = fileSearch(string(), fname.absFileName(), "lyx");
2756 docstring const disp_fn = makeDisplayPath(filename.absFileName());
2757 // emit message signal.
2758 message(bformat(_("Inserting document %1$s..."), disp_fn));
2761 Buffer buf(filename.absFileName(), false);
2762 if (buf.loadLyXFile() == Buffer::ReadSuccess) {
2763 ErrorList & el = buffer_.errorList("Parse");
2764 // Copy the inserted document error list into the current buffer one.
2765 el = buf.errorList("Parse");
2766 buffer_.undo().recordUndo(d->cursor_);
2767 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
2768 buf.params().documentClassPtr(), el);
2769 res = _("Document %1$s inserted.");
2771 res = _("Could not insert document %1$s");
2774 buffer_.changed(true);
2775 // emit message signal.
2776 message(bformat(res, disp_fn));
2780 Point BufferView::coordOffset(DocIterator const & dit) const
2786 // Addup contribution of nested insets, from inside to outside,
2787 // keeping the outer paragraph for a special handling below
2788 for (size_t i = dit.depth() - 1; i >= 1; --i) {
2789 CursorSlice const & sl = dit[i];
2793 // get relative position inside sl.inset()
2794 sl.inset().cursorPos(*this, sl, dit.boundary() && (i + 1 == dit.depth()), xx, yy);
2796 // Make relative position inside of the edited inset relative to sl.inset()
2800 // In case of an RTL inset, the edited inset will be positioned to the left
2803 bool boundary_i = dit.boundary() && i + 1 == dit.depth();
2804 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2809 // remember width for the case that sl.inset() is positioned in an RTL inset
2810 lastw = sl.inset().dimension(*this).wid;
2812 //lyxerr << "Cursor::getPos, i: "
2813 // << i << " x: " << xx << " y: " << y << endl;
2816 // Add contribution of initial rows of outermost paragraph
2817 CursorSlice const & sl = dit[0];
2818 TextMetrics const & tm = textMetrics(sl.text());
2819 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2821 LBUFERR(!pm.rows().empty());
2822 y -= pm.rows()[0].ascent();
2824 // FIXME: document this mess
2826 if (sl.pos() > 0 && dit.depth() == 1) {
2828 if (pos && dit.boundary())
2830 // lyxerr << "coordOffset: boundary:" << dit.boundary() << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
2831 rend = pm.pos2row(pos);
2833 rend = pm.pos2row(sl.pos());
2835 size_t rend = pm.pos2row(sl.pos());
2837 for (size_t rit = 0; rit != rend; ++rit)
2838 y += pm.rows()[rit].height();
2839 y += pm.rows()[rend].ascent();
2841 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
2843 // Make relative position from the nested inset now bufferview absolute.
2844 int xx = bottom_tm.cursorX(dit.bottom(), dit.boundary() && dit.depth() == 1);
2847 // In the RTL case place the nested inset at the left of the cursor in
2848 // the outer paragraph
2849 bool boundary_1 = dit.boundary() && 1 == dit.depth();
2850 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
2858 Point BufferView::getPos(DocIterator const & dit) const
2860 if (!paragraphVisible(dit))
2861 return Point(-1, -1);
2863 CursorSlice const & bot = dit.bottom();
2864 TextMetrics const & tm = textMetrics(bot.text());
2866 // offset from outer paragraph
2867 Point p = coordOffset(dit);
2868 p.y_ += tm.parMetrics(bot.pit()).position();
2873 bool BufferView::paragraphVisible(DocIterator const & dit) const
2875 CursorSlice const & bot = dit.bottom();
2876 TextMetrics const & tm = textMetrics(bot.text());
2878 return tm.contains(bot.pit());
2882 void BufferView::cursorPosAndHeight(Point & p, int & h) const
2884 Cursor const & cur = cursor();
2885 Font const font = cur.real_current_font;
2886 frontend::FontMetrics const & fm = theFontMetrics(font);
2887 int const asc = fm.maxAscent();
2888 int const des = fm.maxDescent();
2895 bool BufferView::cursorInView(Point const & p, int h) const
2897 Cursor const & cur = cursor();
2898 // does the cursor touch the screen ?
2899 if (p.y_ + h < 0 || p.y_ >= workHeight() || !paragraphVisible(cur))
2905 int BufferView::horizScrollOffset() const
2907 return d->horiz_scroll_offset_;
2911 int BufferView::horizScrollOffset(Text const * text,
2912 pit_type pit, pos_type pos) const
2914 // Is this a row that is currently scrolled?
2915 if (!d->current_row_slice_.empty()
2916 && &text->inset() == d->current_row_slice_.inset().asInsetText()
2917 && pit == d->current_row_slice_.pit()
2918 && pos == d->current_row_slice_.pos())
2919 return d->horiz_scroll_offset_;
2924 bool BufferView::hadHorizScrollOffset(Text const * text,
2925 pit_type pit, pos_type pos) const
2927 return !d->last_row_slice_.empty()
2928 && &text->inset() == d->last_row_slice_.inset().asInsetText()
2929 && pit == d->last_row_slice_.pit()
2930 && pos == d->last_row_slice_.pos();
2934 void BufferView::setCurrentRowSlice(CursorSlice const & rowSlice)
2936 // nothing to do if the cursor was already on this row
2937 if (d->current_row_slice_ == rowSlice) {
2938 d->last_row_slice_ = CursorSlice();
2942 // if the (previous) current row was scrolled, we have to
2943 // remember it in order to repaint it next time.
2944 if (d->horiz_scroll_offset_ != 0)
2945 d->last_row_slice_ = d->current_row_slice_;
2947 d->last_row_slice_ = CursorSlice();
2949 // Since we changed row, the scroll offset is not valid anymore
2950 d->horiz_scroll_offset_ = 0;
2951 d->current_row_slice_ = rowSlice;
2955 void BufferView::checkCursorScrollOffset(PainterInfo & pi)
2957 CursorSlice rowSlice = d->cursor_.bottom();
2958 TextMetrics const & tm = textMetrics(rowSlice.text());
2960 // Stop if metrics have not been computed yet, since it means
2961 // that there is nothing to do.
2962 if (!tm.contains(rowSlice.pit()))
2964 ParagraphMetrics const & pm = tm.parMetrics(rowSlice.pit());
2965 Row const & row = pm.getRow(rowSlice.pos(),
2966 d->cursor_.boundary() && rowSlice == d->cursor_.top());
2967 rowSlice.pos() = row.pos();
2969 // Set the row on which the cursor lives.
2970 setCurrentRowSlice(rowSlice);
2972 // If insets referred to by cursor are not all in the cache, the positions
2973 // need to be recomputed.
2974 if (!d->cursor_.inCoordCache()) {
2975 /** FIXME: the code below adds an extraneous computation of
2976 * inset positions, and can therefore be bad for performance
2977 * (think for example about a very large tabular inset.
2978 * Redawing the row where it is means redrawing the whole
2981 * The bug that this fixes is the following: assume that there
2982 * is a very large math inset. Upon entering the inset, when
2983 * pressing `End', the row is not scrolled and the cursor is
2984 * not visible. The extra row computation makes sure that the
2985 * inset positions are correctly computed and set in the
2986 * cache. This would not happen if we did not have two-stage
2989 * A proper fix would be to always have proper inset positions
2992 // Force the recomputation of inset positions
2993 bool const drawing = pi.pain.isDrawingEnabled();
2994 pi.pain.setDrawingEnabled(false);
2995 // No need to care about vertical position.
2996 RowPainter rp(pi, buffer().text(), row, -d->horiz_scroll_offset_, 0);
2998 pi.pain.setDrawingEnabled(drawing);
3001 // Current x position of the cursor in pixels
3002 int cur_x = getPos(d->cursor_).x_;
3004 // Horizontal scroll offset of the cursor row in pixels
3005 int offset = d->horiz_scroll_offset_;
3006 int const MARGIN = 2 * theFontMetrics(d->cursor_.real_current_font).em()
3008 if (row.right_x() <= workWidth() - row.right_margin) {
3009 // Row is narrower than the work area, no offset needed.
3012 if (cur_x - offset < MARGIN) {
3013 // cursor would be too far right
3014 offset = cur_x - MARGIN;
3015 } else if (cur_x - offset > workWidth() - MARGIN) {
3016 // cursor would be too far left
3017 offset = cur_x - workWidth() + MARGIN;
3019 // Correct the offset to make sure that we do not scroll too much
3022 if (row.right_x() - offset < workWidth() - row.right_margin)
3023 offset = row.right_x() - workWidth() + row.right_margin;
3026 //lyxerr << "cur_x=" << cur_x << ", offset=" << offset << ", row.wid=" << row.width() << ", margin=" << MARGIN << endl;
3028 if (offset != d->horiz_scroll_offset_)
3029 LYXERR(Debug::PAINTING, "Horiz. scroll offset changed from "
3030 << d->horiz_scroll_offset_ << " to " << offset);
3032 if (d->update_strategy_ == NoScreenUpdate
3033 && (offset != d->horiz_scroll_offset_
3034 || !d->last_row_slice_.empty())) {
3035 // FIXME: if one uses SingleParUpdate, then home/end
3036 // will not work on long rows. Why?
3037 d->update_strategy_ = FullScreenUpdate;
3040 d->horiz_scroll_offset_ = offset;
3044 void BufferView::draw(frontend::Painter & pain)
3046 if (height_ == 0 || width_ == 0)
3048 LYXERR(Debug::PAINTING, "\t\t*** START DRAWING ***");
3050 Text & text = buffer_.text();
3051 TextMetrics const & tm = d->text_metrics_[&text];
3052 int const y = tm.first().second->position();
3053 PainterInfo pi(this, pain);
3055 // Check whether the row where the cursor lives needs to be scrolled.
3056 // Update the drawing strategy if needed.
3057 checkCursorScrollOffset(pi);
3059 switch (d->update_strategy_) {
3061 case NoScreenUpdate:
3062 // If no screen painting is actually needed, only some the different
3063 // coordinates of insets and paragraphs needs to be updated.
3064 LYXERR(Debug::PAINTING, "Strategy: NoScreenUpdate");
3065 pi.full_repaint = true;
3066 pi.pain.setDrawingEnabled(false);
3070 case SingleParUpdate:
3071 pi.full_repaint = false;
3072 LYXERR(Debug::PAINTING, "Strategy: SingleParUpdate");
3073 // In general, only the current row of the outermost paragraph
3074 // will be redrawn. Particular cases where selection spans
3075 // multiple paragraph are correctly detected in TextMetrics.
3079 case DecorationUpdate:
3080 // FIXME: We should also distinguish DecorationUpdate to avoid text
3081 // drawing if possible. This is not possible to do easily right now
3082 // because of the single backing pixmap.
3084 case FullScreenUpdate:
3086 LYXERR(Debug::PAINTING,
3087 ((d->update_strategy_ == FullScreenUpdate)
3088 ? "Strategy: FullScreenUpdate"
3089 : "Strategy: DecorationUpdate"));
3091 // The whole screen, including insets, will be refreshed.
3092 pi.full_repaint = true;
3094 // Clear background.
3095 pain.fillRectangle(0, 0, width_, height_,
3096 pi.backgroundColor(&buffer_.inset()));
3101 // and possibly grey out below
3102 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3103 int const y2 = lastpm.second->position() + lastpm.second->descent();
3106 Color color = buffer().isInternal()
3107 ? Color_background : Color_bottomarea;
3108 pain.fillRectangle(0, y2, width_, height_ - y2, color);
3112 LYXERR(Debug::PAINTING, "\n\t\t*** END DRAWING ***");
3114 // The scrollbar needs an update.
3117 // Normalize anchor for next time
3118 pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
3119 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3120 for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
3121 ParagraphMetrics const & pm = tm.parMetrics(pit);
3122 if (pm.position() + pm.descent() > 0) {
3123 d->anchor_pit_ = pit;
3124 d->anchor_ypos_ = pm.position();
3128 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
3129 << " anchor ypos = " << d->anchor_ypos_);
3133 void BufferView::message(docstring const & msg)
3136 d->gui_->message(msg);
3140 void BufferView::showDialog(string const & name)
3143 d->gui_->showDialog(name, string());
3147 void BufferView::showDialog(string const & name,
3148 string const & data, Inset * inset)
3151 d->gui_->showDialog(name, data, inset);
3155 void BufferView::updateDialog(string const & name, string const & data)
3158 d->gui_->updateDialog(name, data);
3162 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
3168 // FIXME: Move this out of BufferView again
3169 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
3171 if (!fname.isReadableFile()) {
3172 docstring const error = from_ascii(strerror(errno));
3173 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3174 docstring const text =
3175 bformat(_("Could not read the specified document\n"
3176 "%1$s\ndue to the error: %2$s"), file, error);
3177 Alert::error(_("Could not read file"), text);
3181 if (!fname.isReadableFile()) {
3182 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3183 docstring const text =
3184 bformat(_("%1$s\n is not readable."), file);
3185 Alert::error(_("Could not open file"), text);
3189 // FIXME UNICODE: We don't know the encoding of the file
3190 docstring file_content = fname.fileContents("UTF-8");
3191 if (file_content.empty()) {
3192 Alert::error(_("Reading not UTF-8 encoded file"),
3193 _("The file is not UTF-8 encoded.\n"
3194 "It will be read as local 8Bit-encoded.\n"
3195 "If this does not give the correct result\n"
3196 "then please change the encoding of the file\n"
3197 "to UTF-8 with a program other than LyX.\n"));
3198 file_content = fname.fileContents("local8bit");
3201 return normalize_c(file_content);
3205 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
3207 docstring const tmpstr = contentsOfPlaintextFile(f);
3212 Cursor & cur = cursor();
3213 cap::replaceSelection(cur);
3214 buffer_.undo().recordUndo(cur);
3216 cur.innerText()->insertStringAsParagraphs(cur, tmpstr, cur.current_font);
3218 cur.innerText()->insertStringAsLines(cur, tmpstr, cur.current_font);
3220 buffer_.changed(true);
3224 docstring const & BufferView::inlineCompletion() const
3226 return d->inlineCompletion_;
3230 size_t const & BufferView::inlineCompletionUniqueChars() const
3232 return d->inlineCompletionUniqueChars_;
3236 DocIterator const & BufferView::inlineCompletionPos() const
3238 return d->inlineCompletionPos_;
3242 void BufferView::resetInlineCompletionPos()
3244 d->inlineCompletionPos_ = DocIterator();
3248 bool samePar(DocIterator const & a, DocIterator const & b)
3250 if (a.empty() && b.empty())
3252 if (a.empty() || b.empty())
3254 if (a.depth() != b.depth())
3256 return &a.innerParagraph() == &b.innerParagraph();
3260 void BufferView::setInlineCompletion(Cursor const & cur, DocIterator const & pos,
3261 docstring const & completion, size_t uniqueChars)
3263 uniqueChars = min(completion.size(), uniqueChars);
3264 bool changed = d->inlineCompletion_ != completion
3265 || d->inlineCompletionUniqueChars_ != uniqueChars;
3266 bool singlePar = true;
3267 d->inlineCompletion_ = completion;
3268 d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
3270 //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
3273 DocIterator const & old = d->inlineCompletionPos_;
3275 //lyxerr << "inlineCompletionPos changed" << std::endl;
3276 // old or pos are in another paragraph?
3277 if ((!samePar(cur, pos) && !pos.empty())
3278 || (!samePar(cur, old) && !old.empty())) {
3280 //lyxerr << "different paragraph" << std::endl;
3282 d->inlineCompletionPos_ = pos;
3287 if (singlePar && !(cur.result().screenUpdate() & Update::Force))
3288 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
3290 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::Force);
3295 bool BufferView::clickableInset() const
3297 return d->clickable_inset_;