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 flag.message(from_utf8(N_("Document is read-only")));
1032 flag.setEnabled(false);
1036 // Are we in a DELETED change-tracking region?
1037 if (lookupChangeType(d->cursor_, true) == Change::DELETED
1038 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1039 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1040 flag.message(from_utf8(N_("This portion of the document is deleted.")));
1041 flag.setEnabled(false);
1045 Cursor & cur = d->cursor_;
1047 if (cur.getStatus(cmd, flag))
1052 // FIXME: This is a bit problematic because we don't check if this is
1053 // a document BufferView or not for these LFUNs. We probably have to
1054 // dispatch both to currentBufferView() and, if that fails,
1055 // to documentBufferView(); same as we do now for current Buffer and
1056 // document Buffer. Ideally those LFUN should go to Buffer as they
1057 // operate on the full Buffer and the cursor is only needed either for
1058 // an Undo record or to restore a cursor position. But we don't know
1059 // how to do that inside Buffer of course.
1060 case LFUN_BUFFER_PARAMS_APPLY:
1061 case LFUN_LAYOUT_MODULES_CLEAR:
1062 case LFUN_LAYOUT_MODULE_ADD:
1063 case LFUN_LAYOUT_RELOAD:
1064 case LFUN_TEXTCLASS_APPLY:
1065 case LFUN_TEXTCLASS_LOAD:
1066 flag.setEnabled(!buffer_.isReadonly());
1070 // We do not use the LyXAction flag for readonly because Undo sets the
1071 // buffer clean/dirty status by itself.
1072 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasUndoStack());
1075 // We do not use the LyXAction flag for readonly because Redo sets the
1076 // buffer clean/dirty status by itself.
1077 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasRedoStack());
1079 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
1080 case LFUN_FILE_INSERT_PLAINTEXT: {
1081 docstring const fname = cmd.argument();
1082 if (!FileName::isAbsolute(to_utf8(fname))) {
1083 flag.message(_("Absolute filename expected."));
1086 flag.setEnabled(cur.inTexted());
1089 case LFUN_FILE_INSERT:
1090 case LFUN_BOOKMARK_SAVE:
1091 // FIXME: Actually, these LFUNS should be moved to Text
1092 flag.setEnabled(cur.inTexted());
1095 case LFUN_FONT_STATE:
1096 case LFUN_LABEL_INSERT:
1097 case LFUN_INFO_INSERT:
1098 case LFUN_PARAGRAPH_GOTO:
1099 case LFUN_NOTE_NEXT:
1100 case LFUN_REFERENCE_NEXT:
1101 case LFUN_WORD_FIND:
1102 case LFUN_WORD_FIND_FORWARD:
1103 case LFUN_WORD_FIND_BACKWARD:
1104 case LFUN_WORD_REPLACE:
1107 case LFUN_MARK_TOGGLE:
1108 case LFUN_SCREEN_RECENTER:
1109 case LFUN_SCREEN_SHOW_CURSOR:
1110 case LFUN_BIBTEX_DATABASE_ADD:
1111 case LFUN_BIBTEX_DATABASE_DEL:
1112 case LFUN_STATISTICS:
1113 case LFUN_KEYMAP_OFF:
1114 case LFUN_KEYMAP_PRIMARY:
1115 case LFUN_KEYMAP_SECONDARY:
1116 case LFUN_KEYMAP_TOGGLE:
1117 case LFUN_INSET_SELECT_ALL:
1118 flag.setEnabled(true);
1121 case LFUN_WORD_FINDADV: {
1122 FindAndReplaceOptions opt;
1123 istringstream iss(to_utf8(cmd.argument()));
1125 flag.setEnabled(opt.repl_buf_name.empty()
1126 || !buffer_.isReadonly());
1130 case LFUN_LABEL_GOTO:
1131 flag.setEnabled(!cmd.argument().empty()
1132 || getInsetByCode<InsetRef>(cur, REF_CODE));
1135 case LFUN_CHANGES_MERGE:
1136 case LFUN_CHANGE_NEXT:
1137 case LFUN_CHANGE_PREVIOUS:
1138 case LFUN_ALL_CHANGES_ACCEPT:
1139 case LFUN_ALL_CHANGES_REJECT:
1140 flag.setEnabled(buffer_.areChangesPresent());
1143 case LFUN_SCREEN_UP:
1144 case LFUN_SCREEN_DOWN:
1146 case LFUN_SCREEN_UP_SELECT:
1147 case LFUN_SCREEN_DOWN_SELECT:
1148 case LFUN_INSET_FORALL:
1149 flag.setEnabled(true);
1152 case LFUN_LAYOUT_TABULAR:
1153 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
1157 flag.setEnabled(!cur.inset().forcePlainLayout(cur.idx()));
1160 case LFUN_LAYOUT_PARAGRAPH:
1161 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
1164 case LFUN_BRANCH_ADD_INSERT:
1165 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1168 case LFUN_DIALOG_SHOW_NEW_INSET:
1169 // FIXME: this is wrong, but I do not understand the
1171 if (cur.inset().lyxCode() == CAPTION_CODE)
1172 return cur.inset().getStatus(cur, cmd, flag);
1173 // FIXME we should consider passthru paragraphs too.
1174 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1177 case LFUN_CITATION_INSERT: {
1178 FuncRequest fr(LFUN_INSET_INSERT, "citation");
1179 // FIXME: This could turn in a recursive hell.
1180 // Shouldn't we use Buffer::getStatus() instead?
1181 flag.setEnabled(lyx::getStatus(fr).enabled());
1184 case LFUN_INSET_APPLY: {
1185 string const name = cmd.getArg(0);
1186 Inset * inset = editedInset(name);
1188 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1189 if (!inset->getStatus(cur, fr, flag)) {
1190 // Every inset is supposed to handle this
1191 LASSERT(false, break);
1194 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1195 flag = lyx::getStatus(fr);
1208 Inset * BufferView::editedInset(string const & name) const
1210 map<string, Inset *>::const_iterator it = d->edited_insets_.find(name);
1211 return it == d->edited_insets_.end() ? 0 : it->second;
1215 void BufferView::editInset(string const & name, Inset * inset)
1217 d->edited_insets_[name] = inset;
1221 void BufferView::dispatch(FuncRequest const & cmd, DispatchResult & dr)
1223 LYXERR(Debug::ACTION, "BufferView::dispatch: cmd: " << cmd);
1225 string const argument = to_utf8(cmd.argument());
1226 Cursor & cur = d->cursor_;
1229 // Don't dispatch function that does not apply to internal buffers.
1230 if (buffer_.isInternal()
1231 && lyxaction.funcHasFlag(cmd.action(), LyXAction::NoInternal))
1234 // We'll set this back to false if need be.
1235 bool dispatched = true;
1236 buffer_.undo().beginUndoGroup();
1238 FuncCode const act = cmd.action();
1241 case LFUN_BUFFER_PARAMS_APPLY: {
1242 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1243 cur.recordUndoBufferParams();
1244 istringstream ss(to_utf8(cmd.argument()));
1247 int const unknown_tokens = buffer_.readHeader(lex);
1248 if (unknown_tokens != 0) {
1249 LYXERR0("Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1250 << unknown_tokens << " unknown token"
1251 << (unknown_tokens == 1 ? "" : "s"));
1253 updateDocumentClass(olddc);
1255 // We are most certainly here because of a change in the document
1256 // It is then better to make sure that all dialogs are in sync with
1257 // current document settings.
1258 dr.screenUpdate(Update::Force | Update::FitCursor);
1259 dr.forceBufferUpdate();
1263 case LFUN_LAYOUT_MODULES_CLEAR: {
1264 // FIXME: this modifies the document in cap::switchBetweenClasses
1265 // without calling recordUndo. Fix this before using
1266 // recordUndoBufferParams().
1267 cur.recordUndoFullBuffer();
1268 buffer_.params().clearLayoutModules();
1269 makeDocumentClass();
1270 dr.screenUpdate(Update::Force);
1271 dr.forceBufferUpdate();
1275 case LFUN_LAYOUT_MODULE_ADD: {
1276 BufferParams const & params = buffer_.params();
1277 if (!params.layoutModuleCanBeAdded(argument)) {
1278 LYXERR0("Module `" << argument <<
1279 "' cannot be added due to failed requirements or "
1280 "conflicts with installed modules.");
1283 // FIXME: this modifies the document in cap::switchBetweenClasses
1284 // without calling recordUndo. Fix this before using
1285 // recordUndoBufferParams().
1286 cur.recordUndoFullBuffer();
1287 buffer_.params().addLayoutModule(argument);
1288 makeDocumentClass();
1289 dr.screenUpdate(Update::Force);
1290 dr.forceBufferUpdate();
1294 case LFUN_TEXTCLASS_APPLY: {
1295 // since this shortcircuits, the second call is made only if
1297 bool const success =
1298 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1299 LayoutFileList::get().load(argument, buffer_.filePath());
1301 docstring s = bformat(_("The document class `%1$s' "
1302 "could not be loaded."), from_utf8(argument));
1303 frontend::Alert::error(_("Could not load class"), s);
1307 LayoutFile const * old_layout = buffer_.params().baseClass();
1308 LayoutFile const * new_layout = &(LayoutFileList::get()[argument]);
1310 if (old_layout == new_layout)
1314 // Save the old, possibly modular, layout for use in conversion.
1315 // FIXME: this modifies the document in cap::switchBetweenClasses
1316 // without calling recordUndo. Fix this before using
1317 // recordUndoBufferParams().
1318 cur.recordUndoFullBuffer();
1319 buffer_.params().setBaseClass(argument);
1320 makeDocumentClass();
1321 dr.screenUpdate(Update::Force);
1322 dr.forceBufferUpdate();
1326 case LFUN_TEXTCLASS_LOAD: {
1327 // since this shortcircuits, the second call is made only if
1329 bool const success =
1330 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1331 LayoutFileList::get().load(argument, buffer_.filePath());
1333 docstring s = bformat(_("The document class `%1$s' "
1334 "could not be loaded."), from_utf8(argument));
1335 frontend::Alert::error(_("Could not load class"), s);
1340 case LFUN_LAYOUT_RELOAD: {
1341 LayoutFileIndex bc = buffer_.params().baseClassID();
1342 LayoutFileList::get().reset(bc);
1343 buffer_.params().setBaseClass(bc);
1344 makeDocumentClass();
1345 dr.screenUpdate(Update::Force);
1346 dr.forceBufferUpdate();
1351 dr.setMessage(_("Undo"));
1352 cur.clearSelection();
1353 if (!cur.textUndo())
1354 dr.setMessage(_("No further undo information"));
1356 dr.screenUpdate(Update::Force | Update::FitCursor);
1357 dr.forceBufferUpdate();
1358 // we only need to do this if we have deleted or restored a
1359 // BiBTeX inset. but there is no other place to do it. one
1360 // obvious idea is to try to do it in a copy constructor for
1361 // InsetBibTeX, but when that is invoked, the buffer_ member
1362 // is not yet set. another idea is to look at the InsetLists
1363 // of the various paragraphs. but we'd have to recurse through
1364 // the contained insets to make that work. it doesn't seem to
1365 // be worth it, as this will not happen that often.
1366 buffer().invalidateBibfileCache();
1367 buffer().removeBiblioTempFiles();
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();
1379 buffer().invalidateBibfileCache();
1380 buffer().removeBiblioTempFiles();
1383 case LFUN_FONT_STATE:
1384 dr.setMessage(cur.currentState());
1387 case LFUN_BOOKMARK_SAVE:
1388 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1391 case LFUN_LABEL_GOTO: {
1392 docstring label = cmd.argument();
1393 if (label.empty()) {
1395 getInsetByCode<InsetRef>(cur, REF_CODE);
1397 label = inset->getParam("reference");
1398 // persistent=false: use temp_bookmark
1402 if (!label.empty()) {
1404 // at the moment, this is redundant, since gotoLabel will
1405 // eventually call LFUN_PARAGRAPH_GOTO, but it seems best
1407 dr.screenUpdate(Update::Force | Update::FitCursor);
1412 case LFUN_PARAGRAPH_GOTO: {
1413 int const id = convert<int>(cmd.getArg(0));
1414 int const pos = convert<int>(cmd.getArg(1));
1416 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1417 b = theBufferList().next(b)) {
1420 cur.setCursor(b->getParFromID(id));
1422 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1426 LYXERR(Debug::INFO, "Paragraph " << cur.paragraph().id()
1427 << " found in buffer `"
1428 << b->absFileName() << "'.");
1430 if (b == &buffer_) {
1433 mouseSetCursor(cur);
1434 dr.screenUpdate(Update::Force | Update::FitCursor);
1436 // Switch to other buffer view and resend cmd
1437 lyx::dispatch(FuncRequest(
1438 LFUN_BUFFER_SWITCH, b->absFileName()));
1446 case LFUN_NOTE_NEXT:
1447 gotoInset(this, NOTE_CODE, false);
1450 case LFUN_REFERENCE_NEXT: {
1451 vector<InsetCode> tmp;
1452 tmp.push_back(LABEL_CODE);
1453 tmp.push_back(REF_CODE);
1454 gotoInset(this, tmp, true);
1458 case LFUN_CHANGE_NEXT:
1459 findNextChange(this);
1460 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1461 dr.screenUpdate(Update::Force | Update::FitCursor);
1464 case LFUN_CHANGE_PREVIOUS:
1465 findPreviousChange(this);
1466 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1467 dr.screenUpdate(Update::Force | Update::FitCursor);
1470 case LFUN_CHANGES_MERGE:
1471 if (findNextChange(this) || findPreviousChange(this)) {
1472 dr.screenUpdate(Update::Force | Update::FitCursor);
1473 dr.forceBufferUpdate();
1474 showDialog("changes");
1478 case LFUN_ALL_CHANGES_ACCEPT:
1479 // select complete document
1481 cur.selHandle(true);
1482 buffer_.text().cursorBottom(cur);
1483 // accept everything in a single step to support atomic undo
1484 buffer_.text().acceptOrRejectChanges(cur, Text::ACCEPT);
1486 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1487 dr.screenUpdate(Update::Force | Update::FitCursor);
1488 dr.forceBufferUpdate();
1491 case LFUN_ALL_CHANGES_REJECT:
1492 // select complete document
1494 cur.selHandle(true);
1495 buffer_.text().cursorBottom(cur);
1496 // reject everything in a single step to support atomic undo
1497 // Note: reject does not work recursively; the user may have to repeat the operation
1498 buffer_.text().acceptOrRejectChanges(cur, Text::REJECT);
1500 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1501 dr.screenUpdate(Update::Force | Update::FitCursor);
1502 dr.forceBufferUpdate();
1505 case LFUN_WORD_FIND_FORWARD:
1506 case LFUN_WORD_FIND_BACKWARD: {
1508 // Would it maybe be better if this variable were view specific anyway?
1509 static docstring last_search;
1510 docstring searched_string;
1512 if (!cmd.argument().empty()) {
1513 last_search = cmd.argument();
1514 searched_string = cmd.argument();
1516 searched_string = last_search;
1519 if (searched_string.empty())
1522 bool const fw = act == LFUN_WORD_FIND_FORWARD;
1523 docstring const data =
1524 find2string(searched_string, true, false, fw);
1525 bool found = lyxfind(this, FuncRequest(LFUN_WORD_FIND, data));
1527 dr.screenUpdate(Update::Force | Update::FitCursor);
1537 case LFUN_WORD_FIND: {
1538 FuncRequest req = cmd;
1539 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1540 req = d->search_request_cache_;
1541 if (req.argument().empty()) {
1542 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, "findreplace"));
1545 if (lyxfind(this, req)) {
1546 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);
1583 case LFUN_WORD_FINDADV: {
1584 FindAndReplaceOptions opt;
1585 istringstream iss(to_utf8(cmd.argument()));
1587 if (findAdv(this, opt)) {
1588 dr.screenUpdate(Update::Force | Update::FitCursor);
1599 cur.clearSelection();
1600 dr.setMessage(from_utf8(N_("Mark off")));
1604 cur.clearSelection();
1606 dr.setMessage(from_utf8(N_("Mark on")));
1609 case LFUN_MARK_TOGGLE:
1610 cur.selection(false);
1613 dr.setMessage(from_utf8(N_("Mark removed")));
1616 dr.setMessage(from_utf8(N_("Mark set")));
1621 case LFUN_SCREEN_SHOW_CURSOR:
1625 case LFUN_SCREEN_RECENTER:
1629 case LFUN_BIBTEX_DATABASE_ADD: {
1630 Cursor tmpcur = cur;
1631 findInset(tmpcur, BIBTEX_CODE, false);
1632 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1635 if (inset->addDatabase(cmd.argument())) {
1636 buffer_.invalidateBibfileCache();
1637 dr.forceBufferUpdate();
1643 case LFUN_BIBTEX_DATABASE_DEL: {
1644 Cursor tmpcur = cur;
1645 findInset(tmpcur, BIBTEX_CODE, false);
1646 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1649 if (inset->delDatabase(cmd.argument())) {
1650 buffer_.invalidateBibfileCache();
1651 dr.forceBufferUpdate();
1657 case LFUN_STATISTICS: {
1658 DocIterator from, to;
1659 if (cur.selection()) {
1660 from = cur.selectionBegin();
1661 to = cur.selectionEnd();
1663 from = doc_iterator_begin(&buffer_);
1664 to = doc_iterator_end(&buffer_);
1666 buffer_.updateStatistics(from, to);
1667 int const words = buffer_.wordCount();
1668 int const chars = buffer_.charCount(false);
1669 int const chars_blanks = buffer_.charCount(true);
1671 if (cur.selection())
1672 message = _("Statistics for the selection:");
1674 message = _("Statistics for the document:");
1677 message += bformat(_("%1$d words"), words);
1679 message += _("One word");
1681 if (chars_blanks != 1)
1682 message += bformat(_("%1$d characters (including blanks)"),
1685 message += _("One character (including blanks)");
1688 message += bformat(_("%1$d characters (excluding blanks)"),
1691 message += _("One character (excluding blanks)");
1693 Alert::information(_("Statistics"), message);
1697 case LFUN_SCREEN_UP:
1698 case LFUN_SCREEN_DOWN: {
1699 Point p = getPos(cur);
1700 // This code has been commented out to enable to scroll down a
1701 // document, even if there are large insets in it (see bug #5465).
1702 /*if (p.y_ < 0 || p.y_ > height_) {
1703 // The cursor is off-screen so recenter before proceeding.
1707 int const scrolled = scroll(act == LFUN_SCREEN_UP
1708 ? -height_ : height_);
1709 if (act == LFUN_SCREEN_UP && scrolled > -height_)
1711 if (act == LFUN_SCREEN_DOWN && scrolled < height_)
1712 p = Point(width_, height_);
1713 bool const in_texted = cur.inTexted();
1714 cur.setCursor(doc_iterator_begin(cur.buffer()));
1715 cur.selHandle(false);
1716 buffer_.changed(true);
1717 updateHoveredInset();
1719 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_,
1720 true, act == LFUN_SCREEN_UP);
1721 //FIXME: what to do with cur.x_target()?
1722 bool update = in_texted && cur.bv().checkDepm(cur, old);
1725 if (update || cur.mark())
1726 dr.screenUpdate(Update::Force | Update::FitCursor);
1728 dr.forceBufferUpdate();
1733 string const scroll_type = cmd.getArg(0);
1734 int scroll_step = 0;
1735 if (scroll_type == "line")
1736 scroll_step = d->scrollbarParameters_.single_step;
1737 else if (scroll_type == "page")
1738 scroll_step = d->scrollbarParameters_.page_step;
1741 string const scroll_quantity = cmd.getArg(1);
1742 if (scroll_quantity == "up")
1743 scrollUp(scroll_step);
1744 else if (scroll_quantity == "down")
1745 scrollDown(scroll_step);
1747 int const scroll_value = convert<int>(scroll_quantity);
1749 scroll(scroll_step * scroll_value);
1751 buffer_.changed(true);
1752 updateHoveredInset();
1753 dr.forceBufferUpdate();
1757 case LFUN_SCREEN_UP_SELECT: {
1758 // FIXME: why is the algorithm different from LFUN_SCREEN_UP?
1759 cur.selHandle(true);
1760 if (isTopScreen()) {
1761 lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1765 int y = getPos(cur).y_;
1766 int const ymin = y - height_ + defaultRowHeight();
1767 while (y > ymin && cur.up())
1771 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1775 case LFUN_SCREEN_DOWN_SELECT: {
1776 // FIXME: why is the algorithm different from LFUN_SCREEN_DOWN?
1777 cur.selHandle(true);
1778 if (isBottomScreen()) {
1779 lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1783 int y = getPos(cur).y_;
1784 int const ymax = y + height_ - defaultRowHeight();
1785 while (y < ymax && cur.down())
1789 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1794 case LFUN_INSET_SELECT_ALL: {
1795 // true if all cells are selected
1796 bool const all_selected = cur.depth() > 1
1797 && cur.selBegin().at_begin()
1798 && cur.selEnd().at_end();
1799 // true if some cells are selected
1800 bool const cells_selected = cur.depth() > 1
1801 && cur.selBegin().at_cell_begin()
1802 && cur.selEnd().at_cell_end();
1803 if (all_selected || (cells_selected && !cur.inset().isTable())) {
1804 // All the contents of the inset if selected, or only at
1805 // least one cell but inset is not a table.
1806 // Select the inset from outside.
1809 cur.selection(true);
1811 } else if (cells_selected) {
1812 // At least one complete cell is selected and inset is a table.
1817 cur.selection(true);
1818 cur.idx() = cur.lastidx();
1819 cur.pos() = cur.lastpos();
1821 // select current cell
1825 cur.selection(true);
1826 cur.pit() = cur.lastpit();
1827 cur.pos() = cur.lastpos();
1829 cur.setCurrentFont();
1830 dr.screenUpdate(Update::Force);
1835 // This would be in Buffer class if only Cursor did not
1836 // require a bufferview
1837 case LFUN_INSET_FORALL: {
1838 docstring const name = from_utf8(cmd.getArg(0));
1839 string const commandstr = cmd.getLongArg(1);
1840 FuncRequest const fr = lyxaction.lookupFunc(commandstr);
1842 // an arbitrary number to limit number of iterations
1843 const int max_iter = 100000;
1845 Cursor & cur = d->cursor_;
1846 Cursor const savecur = cur;
1848 if (!cur.nextInset())
1850 cur.beginUndoGroup();
1851 while(cur && iterations < max_iter) {
1852 Inset * const ins = cur.nextInset();
1855 docstring insname = ins->layoutName();
1856 while (!insname.empty()) {
1857 if (insname == name || name == from_utf8("*")) {
1859 lyx::dispatch(fr, dr);
1863 size_t const i = insname.rfind(':');
1864 if (i == string::npos)
1866 insname = insname.substr(0, i);
1868 // if we did not delete the inset, skip it
1869 if (!cur.nextInset() || cur.nextInset() == ins)
1874 /** This is a dummy undo record only to remember the cursor
1875 * that has just been set; this will be used on a redo action
1876 * (see ticket #10097)
1878 * FIXME: a better fix would be to have a way to set the
1879 * cursor value directly, but I am not sure it is worth it.
1883 dr.screenUpdate(Update::Force);
1884 dr.forceBufferUpdate();
1886 if (iterations >= max_iter) {
1888 dr.setMessage(bformat(_("`inset-forall' interrupted because number of actions is larger than %1$d"), max_iter));
1890 dr.setMessage(bformat(_("Applied \"%1$s\" to %2$d insets"), from_utf8(commandstr), iterations));
1895 case LFUN_BRANCH_ADD_INSERT: {
1896 docstring branch_name = from_utf8(cmd.getArg(0));
1897 if (branch_name.empty())
1898 if (!Alert::askForText(branch_name, _("Branch name")) ||
1899 branch_name.empty())
1902 DispatchResult drtmp;
1903 buffer_.dispatch(FuncRequest(LFUN_BRANCH_ADD, branch_name), drtmp);
1904 if (drtmp.error()) {
1905 Alert::warning(_("Branch already exists"), drtmp.message());
1908 BranchList & branch_list = buffer_.params().branchlist();
1909 vector<docstring> const branches =
1910 getVectorFromString(branch_name, branch_list.separator());
1911 for (vector<docstring>::const_iterator it = branches.begin();
1912 it != branches.end(); ++it) {
1914 lyx::dispatch(FuncRequest(LFUN_BRANCH_INSERT, branch_name));
1919 case LFUN_KEYMAP_OFF:
1920 getIntl().keyMapOn(false);
1923 case LFUN_KEYMAP_PRIMARY:
1924 getIntl().keyMapPrim();
1927 case LFUN_KEYMAP_SECONDARY:
1928 getIntl().keyMapSec();
1931 case LFUN_KEYMAP_TOGGLE:
1932 getIntl().toggleKeyMap();
1935 case LFUN_DIALOG_SHOW_NEW_INSET: {
1936 string const name = cmd.getArg(0);
1937 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
1938 if (decodeInsetParam(name, data, buffer_))
1939 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
1941 lyxerr << "Inset type '" << name <<
1942 "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" << endl;
1946 case LFUN_CITATION_INSERT: {
1947 if (argument.empty()) {
1948 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
1951 // we can have one optional argument, delimited by '|'
1952 // citation-insert <key>|<text_before>
1953 // this should be enhanced to also support text_after
1954 // and citation style
1955 string arg = argument;
1957 if (contains(argument, "|")) {
1958 arg = token(argument, '|', 0);
1959 opt1 = token(argument, '|', 1);
1962 // if our cursor is directly in front of or behind a citation inset,
1963 // we will instead add the new key to it.
1964 Inset * inset = cur.nextInset();
1965 if (!inset || inset->lyxCode() != CITE_CODE)
1966 inset = cur.prevInset();
1967 if (inset && inset->lyxCode() == CITE_CODE) {
1968 InsetCitation * icite = static_cast<InsetCitation *>(inset);
1969 if (icite->addKey(arg)) {
1970 dr.forceBufferUpdate();
1971 dr.screenUpdate(Update::FitCursor | Update::SinglePar);
1973 LYXERR0("Discarding optional argument to citation-insert.");
1978 InsetCommandParams icp(CITE_CODE);
1979 icp["key"] = from_utf8(arg);
1981 icp["before"] = from_utf8(opt1);
1982 string icstr = InsetCommand::params2string(icp);
1983 FuncRequest fr(LFUN_INSET_INSERT, icstr);
1988 case LFUN_INSET_APPLY: {
1989 string const name = cmd.getArg(0);
1990 Inset * inset = editedInset(name);
1992 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1996 // put cursor in front of inset.
1997 if (!setCursorFromInset(inset)) {
1998 LASSERT(false, break);
2001 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
2002 inset->dispatch(cur, fr);
2003 dr.screenUpdate(cur.result().screenUpdate());
2004 if (cur.result().needBufferUpdate())
2005 dr.forceBufferUpdate();
2010 // The change of language of buffer belongs to the Buffer class.
2011 // We have to do it here because we need a cursor for Undo.
2012 // When Undo::recordUndoBufferParams() is implemented someday
2013 // LFUN_BUFFER_LANGUAGE should be handled by the Buffer class.
2014 case LFUN_BUFFER_LANGUAGE: {
2015 Language const * oldL = buffer_.params().language;
2016 Language const * newL = languages.getLanguage(argument);
2017 if (!newL || oldL == newL)
2019 if (oldL->rightToLeft() == newL->rightToLeft()) {
2020 cur.recordUndoFullBuffer();
2021 buffer_.changeLanguage(oldL, newL);
2022 cur.setCurrentFont();
2023 dr.forceBufferUpdate();
2028 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
2029 case LFUN_FILE_INSERT_PLAINTEXT: {
2030 bool const as_paragraph = (act == LFUN_FILE_INSERT_PLAINTEXT_PARA);
2031 string const fname = to_utf8(cmd.argument());
2032 if (!FileName::isAbsolute(fname))
2033 dr.setMessage(_("Absolute filename expected."));
2035 insertPlaintextFile(FileName(fname), as_paragraph);
2040 // OK, so try the Buffer itself...
2041 buffer_.dispatch(cmd, dr);
2042 dispatched = dr.dispatched();
2046 buffer_.undo().endUndoGroup();
2047 dr.dispatched(dispatched);
2049 // NOTE: The code below is copied from Cursor::dispatch. If you
2050 // need to modify this, please update the other one too.
2052 // notify insets we just entered/left
2053 if (cursor() != old) {
2054 old.beginUndoGroup();
2056 bool badcursor = notifyCursorLeavesOrEnters(old, cursor());
2058 cursor().fixIfBroken();
2059 resetInlineCompletionPos();
2066 docstring const BufferView::requestSelection()
2068 Cursor & cur = d->cursor_;
2070 LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
2071 if (!cur.selection()) {
2072 d->xsel_cache_.set = false;
2076 LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
2077 if (!d->xsel_cache_.set ||
2078 cur.top() != d->xsel_cache_.cursor ||
2079 cur.realAnchor().top() != d->xsel_cache_.anchor)
2081 d->xsel_cache_.cursor = cur.top();
2082 d->xsel_cache_.anchor = cur.realAnchor().top();
2083 d->xsel_cache_.set = cur.selection();
2084 return cur.selectionAsString(false);
2090 void BufferView::clearSelection()
2092 d->cursor_.clearSelection();
2093 // Clear the selection buffer. Otherwise a subsequent
2094 // middle-mouse-button paste would use the selection buffer,
2095 // not the more current external selection.
2096 cap::clearSelection();
2097 d->xsel_cache_.set = false;
2098 // The buffer did not really change, but this causes the
2099 // redraw we need because we cleared the selection above.
2100 buffer_.changed(false);
2104 void BufferView::resize(int width, int height)
2106 // Update from work area
2110 // Clear the paragraph height cache.
2111 d->par_height_.clear();
2112 // Redo the metrics.
2117 Inset const * BufferView::getCoveringInset(Text const & text,
2120 TextMetrics & tm = d->text_metrics_[&text];
2121 Inset * inset = tm.checkInsetHit(x, y);
2125 if (!inset->descendable(*this))
2126 // No need to go further down if the inset is not
2130 size_t cell_number = inset->nargs();
2131 // Check all the inner cell.
2132 for (size_t i = 0; i != cell_number; ++i) {
2133 Text const * inner_text = inset->getText(i);
2136 Inset const * inset_deeper =
2137 getCoveringInset(*inner_text, x, y);
2139 return inset_deeper;
2147 void BufferView::updateHoveredInset() const
2149 // Get inset under mouse, if there is one.
2150 int const x = d->mouse_position_cache_.x_;
2151 int const y = d->mouse_position_cache_.y_;
2152 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
2154 d->clickable_inset_ = covering_inset && covering_inset->clickable(*this, x, y);
2156 if (covering_inset == d->last_inset_)
2157 // Same inset, no need to do anything...
2160 bool need_redraw = false;
2161 if (d->last_inset_) {
2162 // Remove the hint on the last hovered inset (if any).
2163 need_redraw |= d->last_inset_->setMouseHover(this, false);
2167 if (covering_inset && covering_inset->setMouseHover(this, true)) {
2169 // Only the insets that accept the hover state, do
2170 // clear the last_inset_, so only set the last_inset_
2171 // member if the hovered setting is accepted.
2172 d->last_inset_ = covering_inset;
2176 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
2177 << d->mouse_position_cache_.x_ << ", "
2178 << d->mouse_position_cache_.y_ << ")");
2180 d->update_strategy_ = DecorationUpdate;
2182 // This event (moving without mouse click) is not passed further.
2183 // This should be changed if it is further utilized.
2184 buffer_.changed(false);
2189 void BufferView::clearLastInset(Inset * inset) const
2191 if (d->last_inset_ != inset) {
2192 LYXERR0("Wrong last_inset!");
2199 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
2201 //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
2203 // This is only called for mouse related events including
2204 // LFUN_FILE_OPEN generated by drag-and-drop.
2205 FuncRequest cmd = cmd0;
2207 Cursor old = cursor();
2209 cur.push(buffer_.inset());
2210 cur.selection(d->cursor_.selection());
2212 // Either the inset under the cursor or the
2213 // surrounding Text will handle this event.
2215 // make sure we stay within the screen...
2216 cmd.set_y(min(max(cmd.y(), -1), height_));
2218 d->mouse_position_cache_.x_ = cmd.x();
2219 d->mouse_position_cache_.y_ = cmd.y();
2221 if (cmd.action() == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
2222 updateHoveredInset();
2226 // Build temporary cursor.
2227 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x(), cmd.y());
2229 // If inset is not editable, cur.pos() might point behind the
2230 // inset (depending on cmd.x(), cmd.y()). This is needed for
2231 // editing to fix bug 9628, but e.g. the context menu needs a
2232 // cursor in front of the inset.
2233 if ((inset->hasSettings() || !inset->contextMenuName().empty()
2234 || inset->lyxCode() == SEPARATOR_CODE) &&
2235 cur.nextInset() != inset && cur.prevInset() == inset)
2237 } else if (cur.inTexted() && cur.pos()
2238 && cur.paragraph().isEnvSeparator(cur.pos() - 1)) {
2239 // Always place cursor in front of a separator inset.
2243 // Put anchor at the same position.
2246 cur.beginUndoGroup();
2248 // Try to dispatch to an non-editable inset near this position
2249 // via the temp cursor. If the inset wishes to change the real
2250 // cursor it has to do so explicitly by using
2251 // cur.bv().cursor() = cur; (or similar)
2253 inset->dispatch(cur, cmd);
2255 // Now dispatch to the temporary cursor. If the real cursor should
2256 // be modified, the inset's dispatch has to do so explicitly.
2257 if (!inset || !cur.result().dispatched())
2260 // Notify left insets
2262 bool badcursor = old.fixIfBroken() | cur.fixIfBroken();
2263 badcursor |= notifyCursorLeavesOrEnters(old, cur);
2265 cursor().fixIfBroken();
2270 // Do we have a selection?
2271 theSelection().haveSelection(cursor().selection());
2273 if (cur.needBufferUpdate()) {
2274 cur.clearBufferUpdate();
2275 buffer().updateBuffer();
2278 // If the command has been dispatched,
2279 if (cur.result().dispatched() || cur.result().screenUpdate())
2280 processUpdateFlags(cur.result().screenUpdate());
2284 int BufferView::minVisiblePart()
2286 return 2 * defaultRowHeight();
2290 int BufferView::scroll(int y)
2293 return scrollDown(y);
2295 return scrollUp(-y);
2300 int BufferView::scrollDown(int offset)
2302 Text * text = &buffer_.text();
2303 TextMetrics & tm = d->text_metrics_[text];
2304 int const ymax = height_ + offset;
2306 pair<pit_type, ParagraphMetrics const *> last = tm.last();
2307 int bottom_pos = last.second->position() + last.second->descent();
2308 if (lyxrc.scroll_below_document)
2309 bottom_pos += height_ - minVisiblePart();
2310 if (last.first + 1 == int(text->paragraphs().size())) {
2311 if (bottom_pos <= height_)
2313 offset = min(offset, bottom_pos - height_);
2316 if (bottom_pos > ymax)
2318 tm.newParMetricsDown();
2320 d->anchor_ypos_ -= offset;
2325 int BufferView::scrollUp(int offset)
2327 Text * text = &buffer_.text();
2328 TextMetrics & tm = d->text_metrics_[text];
2329 int ymin = - offset;
2331 pair<pit_type, ParagraphMetrics const *> first = tm.first();
2332 int top_pos = first.second->position() - first.second->ascent();
2333 if (first.first == 0) {
2336 offset = min(offset, - top_pos);
2341 tm.newParMetricsUp();
2343 d->anchor_ypos_ += offset;
2348 void BufferView::setCursorFromRow(int row)
2350 setCursorFromRow(row, buffer_.texrow());
2354 void BufferView::setCursorFromRow(int row, TexRow const & texrow)
2358 pit_type newpit = 0;
2359 pos_type newpos = 0;
2361 texrow.getIdFromRow(row, tmpid, tmppos);
2363 bool posvalid = (tmpid != -1);
2365 // we need to make sure that the row and position
2366 // we got back are valid, because the buffer may well
2367 // have changed since we last generated the LaTeX.
2368 DocIterator dit = buffer_.getParFromID(tmpid);
2369 if (dit == doc_iterator_end(&buffer_))
2371 else if (dit.depth() > 1) {
2372 // We are in an inset.
2373 pos_type lastpos = dit.lastpos();
2374 dit.pos() = tmppos > lastpos ? lastpos : tmppos;
2380 // now have to check pos.
2382 Paragraph const & par = buffer_.text().getPar(newpit);
2383 if (newpos > par.size()) {
2384 LYXERR0("Requested position no longer valid.");
2385 newpos = par.size() - 1;
2390 frontend::Alert::error(_("Inverse Search Failed"),
2391 _("Invalid position requested by inverse search.\n"
2392 "You need to update the viewed document."));
2396 buffer_.text().setCursor(d->cursor_, newpit, newpos);
2397 d->cursor_.selection(false);
2398 d->cursor_.resetAnchor();
2403 bool BufferView::setCursorFromInset(Inset const * inset)
2405 // are we already there?
2406 if (cursor().nextInset() == inset)
2409 // Inset is not at cursor position. Find it in the document.
2412 while (cur && cur.nextInset() != inset)
2423 void BufferView::gotoLabel(docstring const & label)
2425 ListOfBuffers bufs = buffer().allRelatives();
2426 ListOfBuffers::iterator it = bufs.begin();
2427 for (; it != bufs.end(); ++it) {
2428 Buffer const * buf = *it;
2431 shared_ptr<Toc> toc = buf->tocBackend().toc("label");
2432 Toc::const_iterator toc_it = toc->begin();
2433 Toc::const_iterator end = toc->end();
2434 for (; toc_it != end; ++toc_it) {
2435 if (label == toc_it->str()) {
2436 lyx::dispatch(toc_it->action());
2444 TextMetrics const & BufferView::textMetrics(Text const * t) const
2446 return const_cast<BufferView *>(this)->textMetrics(t);
2450 TextMetrics & BufferView::textMetrics(Text const * t)
2453 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
2454 if (tmc_it == d->text_metrics_.end()) {
2455 tmc_it = d->text_metrics_.insert(
2456 make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
2458 return tmc_it->second;
2462 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
2465 return textMetrics(t).parMetrics(pit);
2469 int BufferView::workHeight() const
2475 void BufferView::setCursor(DocIterator const & dit)
2478 size_t const n = dit.depth();
2479 for (size_t i = 0; i < n; ++i)
2480 dit[i].inset().edit(d->cursor_, true);
2482 d->cursor_.setCursor(dit);
2483 d->cursor_.selection(false);
2484 d->cursor_.setCurrentFont();
2486 // It seems on general grounds as if this is probably needed, but
2487 // it is not yet clear.
2488 // See bug #7394 and r38388.
2489 // d->cursor.resetAnchor();
2493 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
2495 // Would be wrong to delete anything if we have a selection.
2496 if (cur.selection())
2499 bool need_anchor_change = false;
2500 bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
2501 need_anchor_change);
2503 if (need_anchor_change)
2511 // we would rather not do this here, but it needs to be done before
2512 // the changed() signal is sent.
2513 buffer_.updateBuffer();
2515 buffer_.changed(true);
2520 bool BufferView::mouseSetCursor(Cursor & cur, bool select)
2522 LASSERT(&cur.bv() == this, return false);
2525 // this event will clear selection so we save selection for
2526 // persistent selection
2527 cap::saveSelection(cursor());
2529 d->cursor_.macroModeClose();
2530 // If a macro has been finalized, the cursor might have been broken
2533 // Has the cursor just left the inset?
2534 bool const leftinset = (&d->cursor_.inset() != &cur.inset());
2536 d->cursor_.fixIfBroken();
2538 // FIXME: shift-mouse selection doesn't work well across insets.
2539 bool const do_selection =
2540 select && &d->cursor_.normalAnchor().inset() == &cur.inset();
2542 // do the dEPM magic if needed
2543 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
2544 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
2545 // the leftinset bool would not be necessary (badcursor instead).
2546 bool update = leftinset;
2547 if (!do_selection && d->cursor_.inTexted())
2548 update |= checkDepm(cur, d->cursor_);
2551 d->cursor_.resetAnchor();
2552 d->cursor_.setCursor(cur);
2553 d->cursor_.boundary(cur.boundary());
2555 d->cursor_.setSelection();
2557 d->cursor_.clearSelection();
2559 d->cursor_.finishUndo();
2560 d->cursor_.setCurrentFont();
2562 cur.forceBufferUpdate();
2567 void BufferView::putSelectionAt(DocIterator const & cur,
2568 int length, bool backwards)
2570 d->cursor_.clearSelection();
2576 d->cursor_.pos() += length;
2577 d->cursor_.setSelection(d->cursor_, -length);
2579 d->cursor_.setSelection(d->cursor_, length);
2584 bool BufferView::selectIfEmpty(DocIterator & cur)
2586 if ((cur.inTexted() && !cur.paragraph().empty())
2587 || (cur.inMathed() && !cur.cell().empty()))
2590 pit_type const beg_pit = cur.pit();
2592 // The paragraph associated to this item isn't
2593 // the first one, so it can be selected
2596 // We have to resort to select the space between the
2597 // end of this item and the begin of the next one
2601 // If it is the only item in the document,
2602 // nothing can be selected
2605 pit_type const end_pit = cur.pit();
2606 pos_type const end_pos = cur.pos();
2607 d->cursor_.clearSelection();
2609 d->cursor_.setCursor(cur);
2610 d->cursor_.pit() = beg_pit;
2611 d->cursor_.pos() = 0;
2612 d->cursor_.selection(false);
2613 d->cursor_.resetAnchor();
2614 d->cursor_.pit() = end_pit;
2615 d->cursor_.pos() = end_pos;
2616 d->cursor_.setSelection();
2621 Cursor & BufferView::cursor()
2627 Cursor const & BufferView::cursor() const
2633 pit_type BufferView::anchor_ref() const
2635 return d->anchor_pit_;
2639 bool BufferView::singleParUpdate()
2641 Text & buftext = buffer_.text();
2642 pit_type const bottom_pit = d->cursor_.bottom().pit();
2643 TextMetrics & tm = textMetrics(&buftext);
2644 int old_height = tm.parMetrics(bottom_pit).height();
2646 // make sure inline completion pointer is ok
2647 if (d->inlineCompletionPos_.fixIfBroken())
2648 d->inlineCompletionPos_ = DocIterator();
2650 // In Single Paragraph mode, rebreak only
2651 // the (main text, not inset!) paragraph containing the cursor.
2652 // (if this paragraph contains insets etc., rebreaking will
2653 // recursively descend)
2654 tm.redoParagraph(bottom_pit);
2655 ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
2656 if (pm.height() != old_height)
2657 // Paragraph height has changed so we cannot proceed to
2658 // the singlePar optimisation.
2661 d->update_strategy_ = SingleParUpdate;
2663 LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
2664 << " y2: " << pm.position() + pm.descent()
2665 << " pit: " << bottom_pit
2666 << " singlepar: 1");
2671 void BufferView::updateMetrics()
2673 if (height_ == 0 || width_ == 0)
2676 Text & buftext = buffer_.text();
2677 pit_type const npit = int(buftext.paragraphs().size());
2679 // Clear out the position cache in case of full screen redraw,
2680 d->coord_cache_.clear();
2682 // Clear out paragraph metrics to avoid having invalid metrics
2683 // in the cache from paragraphs not relayouted below
2684 // The complete text metrics will be redone.
2685 d->text_metrics_.clear();
2687 TextMetrics & tm = textMetrics(&buftext);
2689 // make sure inline completion pointer is ok
2690 if (d->inlineCompletionPos_.fixIfBroken())
2691 d->inlineCompletionPos_ = DocIterator();
2693 if (d->anchor_pit_ >= npit)
2694 // The anchor pit must have been deleted...
2695 d->anchor_pit_ = npit - 1;
2697 // Rebreak anchor paragraph.
2698 tm.redoParagraph(d->anchor_pit_);
2699 ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
2702 if (d->anchor_pit_ == 0) {
2703 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
2705 // Complete buffer visible? Then it's easy.
2706 if (scrollRange == 0)
2707 d->anchor_ypos_ = anchor_pm.ascent();
2709 // FIXME: Some clever handling needed to show
2710 // the _first_ paragraph up to the top if the cursor is
2711 // in the first line.
2713 anchor_pm.setPosition(d->anchor_ypos_);
2715 LYXERR(Debug::PAINTING, "metrics: "
2716 << " anchor pit = " << d->anchor_pit_
2717 << " anchor ypos = " << d->anchor_ypos_);
2719 // Redo paragraphs above anchor if necessary.
2720 int y1 = d->anchor_ypos_ - anchor_pm.ascent();
2721 // We are now just above the anchor paragraph.
2722 pit_type pit1 = d->anchor_pit_ - 1;
2723 for (; pit1 >= 0 && y1 >= 0; --pit1) {
2724 tm.redoParagraph(pit1);
2725 ParagraphMetrics & pm = tm.par_metrics_[pit1];
2727 // Save the paragraph position in the cache.
2732 // Redo paragraphs below the anchor if necessary.
2733 int y2 = d->anchor_ypos_ + anchor_pm.descent();
2734 // We are now just below the anchor paragraph.
2735 pit_type pit2 = d->anchor_pit_ + 1;
2736 for (; pit2 < npit && y2 <= height_; ++pit2) {
2737 tm.redoParagraph(pit2);
2738 ParagraphMetrics & pm = tm.par_metrics_[pit2];
2740 // Save the paragraph position in the cache.
2745 LYXERR(Debug::PAINTING, "Metrics: "
2746 << " anchor pit = " << d->anchor_pit_
2747 << " anchor ypos = " << d->anchor_ypos_
2750 << " pit1 = " << pit1
2751 << " pit2 = " << pit2);
2753 d->update_strategy_ = FullScreenUpdate;
2755 if (lyxerr.debugging(Debug::WORKAREA)) {
2756 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
2757 d->coord_cache_.dump();
2762 void BufferView::insertLyXFile(FileName const & fname)
2764 LASSERT(d->cursor_.inTexted(), return);
2766 // Get absolute path of file and add ".lyx"
2767 // to the filename if necessary
2768 FileName filename = fileSearch(string(), fname.absFileName(), "lyx");
2770 docstring const disp_fn = makeDisplayPath(filename.absFileName());
2771 // emit message signal.
2772 message(bformat(_("Inserting document %1$s..."), disp_fn));
2775 Buffer buf(filename.absFileName(), false);
2776 if (buf.loadLyXFile() == Buffer::ReadSuccess) {
2777 ErrorList & el = buffer_.errorList("Parse");
2778 // Copy the inserted document error list into the current buffer one.
2779 el = buf.errorList("Parse");
2780 buffer_.undo().recordUndo(d->cursor_);
2781 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
2782 buf.params().documentClassPtr(), el);
2783 res = _("Document %1$s inserted.");
2785 res = _("Could not insert document %1$s");
2788 buffer_.changed(true);
2789 // emit message signal.
2790 message(bformat(res, disp_fn));
2794 Point BufferView::coordOffset(DocIterator const & dit) const
2800 // Addup contribution of nested insets, from inside to outside,
2801 // keeping the outer paragraph for a special handling below
2802 for (size_t i = dit.depth() - 1; i >= 1; --i) {
2803 CursorSlice const & sl = dit[i];
2807 // get relative position inside sl.inset()
2808 sl.inset().cursorPos(*this, sl, dit.boundary() && (i + 1 == dit.depth()), xx, yy);
2810 // Make relative position inside of the edited inset relative to sl.inset()
2814 // In case of an RTL inset, the edited inset will be positioned to the left
2817 bool boundary_i = dit.boundary() && i + 1 == dit.depth();
2818 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2823 // remember width for the case that sl.inset() is positioned in an RTL inset
2824 if (i && dit[i - 1].text()) {
2825 // If this Inset is inside a Text Inset, retrieve the Dimension
2826 // from the containing text instead of using Inset::dimension() which
2827 // might not be implemented.
2828 // FIXME (Abdel 23/09/2007): this is a bit messy because of the
2829 // elimination of Inset::dim_ cache. This coordOffset() method needs
2830 // to be rewritten in light of the new design.
2831 Dimension const & dim = coordCache().getInsets().dim(&sl.inset());
2834 Dimension const dim = sl.inset().dimension(*this);
2838 //lyxerr << "Cursor::getPos, i: "
2839 // << i << " x: " << xx << " y: " << y << endl;
2842 // Add contribution of initial rows of outermost paragraph
2843 CursorSlice const & sl = dit[0];
2844 TextMetrics const & tm = textMetrics(sl.text());
2845 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2847 LBUFERR(!pm.rows().empty());
2848 y -= pm.rows()[0].ascent();
2850 // FIXME: document this mess
2852 if (sl.pos() > 0 && dit.depth() == 1) {
2854 if (pos && dit.boundary())
2856 // lyxerr << "coordOffset: boundary:" << dit.boundary() << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
2857 rend = pm.pos2row(pos);
2859 rend = pm.pos2row(sl.pos());
2861 size_t rend = pm.pos2row(sl.pos());
2863 for (size_t rit = 0; rit != rend; ++rit)
2864 y += pm.rows()[rit].height();
2865 y += pm.rows()[rend].ascent();
2867 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
2869 // Make relative position from the nested inset now bufferview absolute.
2870 int xx = bottom_tm.cursorX(dit.bottom(), dit.boundary() && dit.depth() == 1);
2873 // In the RTL case place the nested inset at the left of the cursor in
2874 // the outer paragraph
2875 bool boundary_1 = dit.boundary() && 1 == dit.depth();
2876 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
2884 Point BufferView::getPos(DocIterator const & dit) const
2886 if (!paragraphVisible(dit))
2887 return Point(-1, -1);
2889 CursorSlice const & bot = dit.bottom();
2890 TextMetrics const & tm = textMetrics(bot.text());
2892 // offset from outer paragraph
2893 Point p = coordOffset(dit);
2894 p.y_ += tm.parMetrics(bot.pit()).position();
2899 bool BufferView::paragraphVisible(DocIterator const & dit) const
2901 CursorSlice const & bot = dit.bottom();
2902 TextMetrics const & tm = textMetrics(bot.text());
2904 return tm.contains(bot.pit());
2908 void BufferView::cursorPosAndHeight(Point & p, int & h) const
2910 Cursor const & cur = cursor();
2911 Font const font = cur.getFont();
2912 frontend::FontMetrics const & fm = theFontMetrics(font);
2913 int const asc = fm.maxAscent();
2914 int const des = fm.maxDescent();
2921 bool BufferView::cursorInView(Point const & p, int h) const
2923 Cursor const & cur = cursor();
2924 // does the cursor touch the screen ?
2925 if (p.y_ + h < 0 || p.y_ >= workHeight() || !paragraphVisible(cur))
2931 int BufferView::horizScrollOffset() const
2933 return d->horiz_scroll_offset_;
2937 int BufferView::horizScrollOffset(Text const * text,
2938 pit_type pit, pos_type pos) const
2940 // Is this a row that is currently scrolled?
2941 if (!d->current_row_slice_.empty()
2942 && &text->inset() == d->current_row_slice_.inset().asInsetText()
2943 && pit == d->current_row_slice_.pit()
2944 && pos == d->current_row_slice_.pos())
2945 return d->horiz_scroll_offset_;
2950 bool BufferView::hadHorizScrollOffset(Text const * text,
2951 pit_type pit, pos_type pos) const
2953 return !d->last_row_slice_.empty()
2954 && &text->inset() == d->last_row_slice_.inset().asInsetText()
2955 && pit == d->last_row_slice_.pit()
2956 && pos == d->last_row_slice_.pos();
2960 void BufferView::setCurrentRowSlice(CursorSlice const & rowSlice)
2962 // nothing to do if the cursor was already on this row
2963 if (d->current_row_slice_ == rowSlice) {
2964 d->last_row_slice_ = CursorSlice();
2968 // if the (previous) current row was scrolled, we have to
2969 // remember it in order to repaint it next time.
2970 if (d->horiz_scroll_offset_ != 0)
2971 d->last_row_slice_ = d->current_row_slice_;
2973 d->last_row_slice_ = CursorSlice();
2975 // Since we changed row, the scroll offset is not valid anymore
2976 d->horiz_scroll_offset_ = 0;
2977 d->current_row_slice_ = rowSlice;
2981 void BufferView::checkCursorScrollOffset(PainterInfo & pi)
2983 CursorSlice rowSlice = d->cursor_.bottom();
2984 TextMetrics const & tm = textMetrics(rowSlice.text());
2986 // Stop if metrics have not been computed yet, since it means
2987 // that there is nothing to do.
2988 if (!tm.contains(rowSlice.pit()))
2990 ParagraphMetrics const & pm = tm.parMetrics(rowSlice.pit());
2991 Row const & row = pm.getRow(rowSlice.pos(),
2992 d->cursor_.boundary() && rowSlice == d->cursor_.top());
2993 rowSlice.pos() = row.pos();
2995 // Set the row on which the cursor lives.
2996 setCurrentRowSlice(rowSlice);
2998 // If insets referred to by cursor are not all in the cache, the positions
2999 // need to be recomputed.
3000 if (!d->cursor_.inCoordCache()) {
3001 /** FIXME: the code below adds an extraneous computation of
3002 * inset positions, and can therefore be bad for performance
3003 * (think for example about a very large tabular inset.
3004 * Redawing the row where it is means redrawing the whole
3007 * The bug that this fixes is the following: assume that there
3008 * is a very large math inset. Upon entering the inset, when
3009 * pressing `End', the row is not scrolled and the cursor is
3010 * not visible. The extra row computation makes sure that the
3011 * inset positions are correctly computed and set in the
3012 * cache. This would not happen if we did not have two-stage
3015 * A proper fix would be to always have proper inset positions
3018 // Force the recomputation of inset positions
3019 bool const drawing = pi.pain.isDrawingEnabled();
3020 pi.pain.setDrawingEnabled(false);
3021 // No need to care about vertical position.
3022 RowPainter rp(pi, buffer().text(), row, -d->horiz_scroll_offset_, 0);
3024 pi.pain.setDrawingEnabled(drawing);
3027 // Current x position of the cursor in pixels
3028 int cur_x = getPos(d->cursor_).x_;
3030 // Horizontal scroll offset of the cursor row in pixels
3031 int offset = d->horiz_scroll_offset_;
3032 int const MARGIN = 2 * theFontMetrics(d->cursor_.real_current_font).em()
3034 if (row.right_x() <= workWidth() - row.right_margin) {
3035 // Row is narrower than the work area, no offset needed.
3038 if (cur_x - offset < MARGIN) {
3039 // cursor would be too far right
3040 offset = cur_x - MARGIN;
3041 } else if (cur_x - offset > workWidth() - MARGIN) {
3042 // cursor would be too far left
3043 offset = cur_x - workWidth() + MARGIN;
3045 // Correct the offset to make sure that we do not scroll too much
3048 if (row.right_x() - offset < workWidth() - row.right_margin)
3049 offset = row.right_x() - workWidth() + row.right_margin;
3052 //lyxerr << "cur_x=" << cur_x << ", offset=" << offset << ", row.wid=" << row.width() << ", margin=" << MARGIN << endl;
3054 if (offset != d->horiz_scroll_offset_)
3055 LYXERR(Debug::PAINTING, "Horiz. scroll offset changed from "
3056 << d->horiz_scroll_offset_ << " to " << offset);
3058 if (d->update_strategy_ == NoScreenUpdate
3059 && (offset != d->horiz_scroll_offset_
3060 || !d->last_row_slice_.empty())) {
3061 // FIXME: if one uses SingleParUpdate, then home/end
3062 // will not work on long rows. Why?
3063 d->update_strategy_ = FullScreenUpdate;
3066 d->horiz_scroll_offset_ = offset;
3070 void BufferView::draw(frontend::Painter & pain)
3072 if (height_ == 0 || width_ == 0)
3074 LYXERR(Debug::PAINTING, "\t\t*** START DRAWING ***");
3076 Text & text = buffer_.text();
3077 TextMetrics const & tm = d->text_metrics_[&text];
3078 int const y = tm.first().second->position();
3079 PainterInfo pi(this, pain);
3081 // Check whether the row where the cursor lives needs to be scrolled.
3082 // Update the drawing strategy if needed.
3083 checkCursorScrollOffset(pi);
3085 switch (d->update_strategy_) {
3087 case NoScreenUpdate:
3088 // If no screen painting is actually needed, only some the different
3089 // coordinates of insets and paragraphs needs to be updated.
3090 LYXERR(Debug::PAINTING, "Strategy: NoScreenUpdate");
3091 pi.full_repaint = true;
3092 pi.pain.setDrawingEnabled(false);
3096 case SingleParUpdate:
3097 pi.full_repaint = false;
3098 LYXERR(Debug::PAINTING, "Strategy: SingleParUpdate");
3099 // In general, only the current row of the outermost paragraph
3100 // will be redrawn. Particular cases where selection spans
3101 // multiple paragraph are correctly detected in TextMetrics.
3105 case DecorationUpdate:
3106 // FIXME: We should also distinguish DecorationUpdate to avoid text
3107 // drawing if possible. This is not possible to do easily right now
3108 // because of the single backing pixmap.
3110 case FullScreenUpdate:
3112 LYXERR(Debug::PAINTING,
3113 ((d->update_strategy_ == FullScreenUpdate)
3114 ? "Strategy: FullScreenUpdate"
3115 : "Strategy: DecorationUpdate"));
3117 // The whole screen, including insets, will be refreshed.
3118 pi.full_repaint = true;
3120 // Clear background.
3121 pain.fillRectangle(0, 0, width_, height_,
3122 pi.backgroundColor(&buffer_.inset()));
3127 // and possibly grey out below
3128 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3129 int const y2 = lastpm.second->position() + lastpm.second->descent();
3132 Color color = buffer().isInternal()
3133 ? Color_background : Color_bottomarea;
3134 pain.fillRectangle(0, y2, width_, height_ - y2, color);
3138 LYXERR(Debug::PAINTING, "\n\t\t*** END DRAWING ***");
3140 // The scrollbar needs an update.
3143 // Normalize anchor for next time
3144 pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
3145 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3146 for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
3147 ParagraphMetrics const & pm = tm.parMetrics(pit);
3148 if (pm.position() + pm.descent() > 0) {
3149 d->anchor_pit_ = pit;
3150 d->anchor_ypos_ = pm.position();
3154 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
3155 << " anchor ypos = " << d->anchor_ypos_);
3159 void BufferView::message(docstring const & msg)
3162 d->gui_->message(msg);
3166 void BufferView::showDialog(string const & name)
3169 d->gui_->showDialog(name, string());
3173 void BufferView::showDialog(string const & name,
3174 string const & data, Inset * inset)
3177 d->gui_->showDialog(name, data, inset);
3181 void BufferView::updateDialog(string const & name, string const & data)
3184 d->gui_->updateDialog(name, data);
3188 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
3194 // FIXME: Move this out of BufferView again
3195 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
3197 if (!fname.isReadableFile()) {
3198 docstring const error = from_ascii(strerror(errno));
3199 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3200 docstring const text =
3201 bformat(_("Could not read the specified document\n"
3202 "%1$s\ndue to the error: %2$s"), file, error);
3203 Alert::error(_("Could not read file"), text);
3207 if (!fname.isReadableFile()) {
3208 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3209 docstring const text =
3210 bformat(_("%1$s\n is not readable."), file);
3211 Alert::error(_("Could not open file"), text);
3215 // FIXME UNICODE: We don't know the encoding of the file
3216 docstring file_content = fname.fileContents("UTF-8");
3217 if (file_content.empty()) {
3218 Alert::error(_("Reading not UTF-8 encoded file"),
3219 _("The file is not UTF-8 encoded.\n"
3220 "It will be read as local 8Bit-encoded.\n"
3221 "If this does not give the correct result\n"
3222 "then please change the encoding of the file\n"
3223 "to UTF-8 with a program other than LyX.\n"));
3224 file_content = fname.fileContents("local8bit");
3227 return normalize_c(file_content);
3231 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
3233 docstring const tmpstr = contentsOfPlaintextFile(f);
3238 Cursor & cur = cursor();
3239 cap::replaceSelection(cur);
3240 buffer_.undo().recordUndo(cur);
3242 cur.innerText()->insertStringAsParagraphs(cur, tmpstr, cur.current_font);
3244 cur.innerText()->insertStringAsLines(cur, tmpstr, cur.current_font);
3246 buffer_.changed(true);
3250 docstring const & BufferView::inlineCompletion() const
3252 return d->inlineCompletion_;
3256 size_t const & BufferView::inlineCompletionUniqueChars() const
3258 return d->inlineCompletionUniqueChars_;
3262 DocIterator const & BufferView::inlineCompletionPos() const
3264 return d->inlineCompletionPos_;
3268 void BufferView::resetInlineCompletionPos()
3270 d->inlineCompletionPos_ = DocIterator();
3274 bool samePar(DocIterator const & a, DocIterator const & b)
3276 if (a.empty() && b.empty())
3278 if (a.empty() || b.empty())
3280 if (a.depth() != b.depth())
3282 return &a.innerParagraph() == &b.innerParagraph();
3286 void BufferView::setInlineCompletion(Cursor const & cur, DocIterator const & pos,
3287 docstring const & completion, size_t uniqueChars)
3289 uniqueChars = min(completion.size(), uniqueChars);
3290 bool changed = d->inlineCompletion_ != completion
3291 || d->inlineCompletionUniqueChars_ != uniqueChars;
3292 bool singlePar = true;
3293 d->inlineCompletion_ = completion;
3294 d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
3296 //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
3299 DocIterator const & old = d->inlineCompletionPos_;
3301 //lyxerr << "inlineCompletionPos changed" << std::endl;
3302 // old or pos are in another paragraph?
3303 if ((!samePar(cur, pos) && !pos.empty())
3304 || (!samePar(cur, old) && !old.empty())) {
3306 //lyxerr << "different paragraph" << std::endl;
3308 d->inlineCompletionPos_ = pos;
3313 if (singlePar && !(cur.result().screenUpdate() & Update::Force))
3314 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
3316 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::Force);
3321 bool BufferView::clickableInset() const
3323 return d->clickable_inset_;