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 d->scrollbarParameters_.position == d->scrollbarParameters_.min;
377 bool BufferView::isBottomScreen() const
379 return d->scrollbarParameters_.position == 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 d->scrollbarParameters_.position = 0;
563 // The reference is the top position so we remove one page.
564 if (lyxrc.scroll_below_document)
565 d->scrollbarParameters_.max -= minVisiblePart();
567 d->scrollbarParameters_.max -= d->scrollbarParameters_.page_step;
571 ScrollbarParameters const & BufferView::scrollbarParameters() const
573 return d->scrollbarParameters_;
577 docstring BufferView::toolTip(int x, int y) const
579 // Get inset under mouse, if there is one.
580 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
582 // No inset, no tooltip...
584 return covering_inset->toolTip(*this, x, y);
588 string BufferView::contextMenu(int x, int y) const
590 //If there is a selection, return the containing inset menu
591 if (d->cursor_.selection())
592 return d->cursor_.inset().contextMenu(*this, x, y);
594 // Get inset under mouse, if there is one.
595 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
597 return covering_inset->contextMenu(*this, x, y);
599 return buffer_.inset().contextMenu(*this, x, y);
603 void BufferView::scrollDocView(int value, bool update)
605 int const offset = value - d->scrollbarParameters_.position;
607 // No scrolling at all? No need to redraw anything
611 // If the offset is less than 2 screen height, prefer to scroll instead.
612 if (abs(offset) <= 2 * height_) {
613 d->anchor_ypos_ -= offset;
614 buffer_.changed(true);
615 updateHoveredInset();
619 // cut off at the top
620 if (value <= d->scrollbarParameters_.min) {
621 DocIterator dit = doc_iterator_begin(&buffer_);
622 showCursor(dit, false, update);
623 LYXERR(Debug::SCROLLING, "scroll to top");
627 // cut off at the bottom
628 if (value >= d->scrollbarParameters_.max) {
629 DocIterator dit = doc_iterator_end(&buffer_);
631 showCursor(dit, false, update);
632 LYXERR(Debug::SCROLLING, "scroll to bottom");
636 // find paragraph at target position
637 int par_pos = d->scrollbarParameters_.min;
639 for (; i != int(d->par_height_.size()); ++i) {
640 par_pos += d->par_height_[i];
641 if (par_pos >= value)
645 if (par_pos < value) {
646 // It seems we didn't find the correct pit so stay on the safe side and
648 LYXERR0("scrolling position not found!");
649 scrollDocView(d->scrollbarParameters_.max, update);
653 DocIterator dit = doc_iterator_begin(&buffer_);
655 LYXERR(Debug::SCROLLING, "value = " << value << " -> scroll to pit " << i);
656 showCursor(dit, false, update);
660 // FIXME: this method is not working well.
661 void BufferView::setCursorFromScrollbar()
663 TextMetrics & tm = d->text_metrics_[&buffer_.text()];
665 int const height = 2 * defaultRowHeight();
666 int const first = height;
667 int const last = height_ - height;
669 Cursor const & oldcur = d->cursor_;
671 switch (cursorStatus(oldcur)) {
679 int const y = getPos(oldcur).y_;
680 newy = min(last, max(y, first));
684 // We reset the cursor because cursorStatus() does not
685 // work when the cursor is within mathed.
688 tm.setCursorFromCoordinates(cur, 0, newy);
690 // update the bufferview cursor and notify insets
691 // FIXME: Care about the d->cursor_ flags to redraw if needed
692 Cursor old = d->cursor_;
694 // the DEPM call in mouseSetCursor() might have destroyed the
695 // paragraph the cursor is in.
696 bool badcursor = old.fixIfBroken();
697 badcursor |= notifyCursorLeavesOrEnters(old, d->cursor_);
699 d->cursor_.fixIfBroken();
703 Change const BufferView::getCurrentChange() const
705 if (!d->cursor_.selection())
706 return Change(Change::UNCHANGED);
708 DocIterator dit = d->cursor_.selectionBegin();
709 // The selected content might have been changed (see #7685)
710 dit = dit.getInnerText();
711 return dit.paragraph().lookupChange(dit.pos());
715 // this could be used elsewhere as well?
716 // FIXME: This does not work within mathed!
717 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
719 Point const p = getPos(dit);
722 if (p.y_ > workHeight())
728 void BufferView::bookmarkEditPosition()
730 // Don't eat cpu time for each keystroke
731 if (d->cursor_.paragraph().id() == d->bookmark_edit_position_)
734 d->bookmark_edit_position_ = d->cursor_.paragraph().id();
738 void BufferView::saveBookmark(unsigned int idx)
740 // tentatively save bookmark, id and pos will be used to
741 // acturately locate a bookmark in a 'live' lyx session.
742 // pit and pos will be updated with bottom level pit/pos
744 if (!buffer_.isInternal()) {
745 theSession().bookmarks().save(
747 d->cursor_.bottom().pit(),
748 d->cursor_.bottom().pos(),
749 d->cursor_.paragraph().id(),
754 // emit message signal.
755 message(_("Save bookmark"));
760 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
761 int top_id, pos_type top_pos)
763 bool success = false;
766 d->cursor_.clearSelection();
768 // if a valid par_id is given, try it first
769 // This is the case for a 'live' bookmark when unique paragraph ID
770 // is used to track bookmarks.
772 dit = buffer_.getParFromID(top_id);
774 dit.pos() = min(dit.paragraph().size(), top_pos);
775 // Some slices of the iterator may not be
776 // reachable (e.g. closed collapsable inset)
777 // so the dociterator may need to be
778 // shortened. Otherwise, setCursor may crash
779 // lyx when the cursor can not be set to these
781 size_t const n = dit.depth();
782 for (size_t i = 0; i < n; ++i)
783 if (!dit[i].inset().editable()) {
791 // if top_id == 0, or searching through top_id failed
792 // This is the case for a 'restored' bookmark when only bottom
793 // (document level) pit was saved. Because of this, bookmark
794 // restoration is inaccurate. If a bookmark was within an inset,
795 // it will be restored to the left of the outmost inset that contains
797 if (bottom_pit < int(buffer_.paragraphs().size())) {
798 dit = doc_iterator_begin(&buffer_);
800 dit.pit() = bottom_pit;
801 dit.pos() = min(bottom_pos, dit.paragraph().size());
806 // Note: only bottom (document) level pit is set.
808 // set the current font.
809 d->cursor_.setCurrentFont();
810 // Do not forget to reset the anchor (see #9912)
811 d->cursor_.resetAnchor();
812 // To center the screen on this new position we need the
813 // paragraph position which is computed at draw() time.
814 // So we need a redraw!
815 buffer_.changed(false);
816 if (needsFitCursor())
824 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
826 if (d->cursor_.real_current_font.isRightToLeft()) {
827 if (d->intl_.keymap == Intl::PRIMARY)
828 d->intl_.keyMapSec();
830 if (d->intl_.keymap == Intl::SECONDARY)
831 d->intl_.keyMapPrim();
834 d->intl_.getTransManager().translateAndInsert(c, t, cur);
838 int BufferView::workWidth() const
844 void BufferView::recenter()
846 showCursor(d->cursor_, true, true);
850 void BufferView::showCursor()
852 showCursor(d->cursor_, false, true);
856 void BufferView::showCursor(DocIterator const & dit,
857 bool recenter, bool update)
859 if (scrollToCursor(dit, recenter) && update) {
860 buffer_.changed(true);
861 updateHoveredInset();
866 void BufferView::scrollToCursor()
868 if (scrollToCursor(d->cursor_, false)) {
869 buffer_.changed(true);
870 updateHoveredInset();
875 bool BufferView::scrollToCursor(DocIterator const & dit, bool recenter)
877 // We are not properly started yet, delay until resizing is
882 LYXERR(Debug::SCROLLING, "recentering!");
884 CursorSlice const & bot = dit.bottom();
885 TextMetrics & tm = d->text_metrics_[bot.text()];
887 pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
888 int bot_pit = bot.pit();
889 if (bot_pit > max_pit) {
890 // FIXME: Why does this happen?
891 LYXERR0("bottom pit is greater that max pit: "
892 << bot_pit << " > " << max_pit);
896 if (bot_pit == tm.first().first - 1)
897 tm.newParMetricsUp();
898 else if (bot_pit == tm.last().first + 1)
899 tm.newParMetricsDown();
901 if (tm.contains(bot_pit)) {
902 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
903 LBUFERR(!pm.rows().empty());
904 // FIXME: smooth scrolling doesn't work in mathed.
905 CursorSlice const & cs = dit.innerTextSlice();
906 int offset = coordOffset(dit).y_;
907 int ypos = pm.position() + offset;
908 Dimension const & row_dim =
909 pm.getRow(cs.pos(), dit.boundary()).dimension();
912 scrolled = scroll(ypos - height_/2);
914 // We try to visualize the whole row, if the row height is larger than
915 // the screen height, we scroll to a heuristic value of height_ / 4.
916 // FIXME: This heuristic value should be replaced by a recursive search
917 // for a row in the inset that can be visualized completely.
918 else if (row_dim.height() > height_) {
919 if (ypos < defaultRowHeight())
920 scrolled = scroll(ypos - height_ / 4);
921 else if (ypos > height_ - defaultRowHeight())
922 scrolled = scroll(ypos - 3 * height_ / 4);
925 // If the top part of the row falls of the screen, we scroll
926 // up to align the top of the row with the top of the screen.
927 else if (ypos - row_dim.ascent() < 0 && ypos < height_) {
928 int ynew = row_dim.ascent();
929 scrolled = scrollUp(ynew - ypos);
932 // If the bottom of the row falls of the screen, we scroll down.
933 else if (ypos + row_dim.descent() > height_ && ypos > 0) {
934 int ynew = height_ - row_dim.descent();
935 scrolled = scrollDown(ypos - ynew);
938 // else, nothing to do, the cursor is already visible so we just return.
939 return scrolled != 0;
942 // fix inline completion position
943 if (d->inlineCompletionPos_.fixIfBroken())
944 d->inlineCompletionPos_ = DocIterator();
946 tm.redoParagraph(bot_pit);
947 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
948 int offset = coordOffset(dit).y_;
950 d->anchor_pit_ = bot_pit;
951 CursorSlice const & cs = dit.innerTextSlice();
952 Dimension const & row_dim =
953 pm.getRow(cs.pos(), dit.boundary()).dimension();
956 d->anchor_ypos_ = height_/2;
957 else if (d->anchor_pit_ == 0)
958 d->anchor_ypos_ = offset + pm.ascent();
959 else if (d->anchor_pit_ == max_pit)
960 d->anchor_ypos_ = height_ - offset - row_dim.descent();
961 else if (offset > height_)
962 d->anchor_ypos_ = height_ - offset - defaultRowHeight();
964 d->anchor_ypos_ = defaultRowHeight() * 2;
970 void BufferView::makeDocumentClass()
972 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
973 buffer_.params().makeDocumentClass();
974 updateDocumentClass(olddc);
978 void BufferView::updateDocumentClass(DocumentClassConstPtr olddc)
980 message(_("Converting document to new document class..."));
982 StableDocIterator backcur(d->cursor_);
983 ErrorList & el = buffer_.errorList("Class Switch");
984 cap::switchBetweenClasses(
985 olddc, buffer_.params().documentClassPtr(),
986 static_cast<InsetText &>(buffer_.inset()), el);
988 setCursor(backcur.asDocIterator(&buffer_));
990 buffer_.errors("Class Switch");
994 /** Return the change status at cursor position, taking into account the
995 * status at each level of the document iterator (a table in a deleted
996 * footnote is deleted).
997 * When \param outer is true, the top slice is not looked at.
999 static Change::Type lookupChangeType(DocIterator const & dit, bool outer = false)
1001 size_t const depth = dit.depth() - (outer ? 1 : 0);
1003 for (size_t i = 0 ; i < depth ; ++i) {
1004 CursorSlice const & slice = dit[i];
1005 if (!slice.inset().inMathed()
1006 && slice.pos() < slice.paragraph().size()) {
1007 Change::Type const ch = slice.paragraph().lookupChange(slice.pos()).type;
1008 if (ch != Change::UNCHANGED)
1012 return Change::UNCHANGED;
1016 bool BufferView::getStatus(FuncRequest const & cmd, FuncStatus & flag)
1018 FuncCode const act = cmd.action();
1020 // Can we use a readonly buffer?
1021 if (buffer_.isReadonly()
1022 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1023 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1024 flag.message(from_utf8(N_("Document is read-only")));
1025 flag.setEnabled(false);
1029 // Are we in a DELETED change-tracking region?
1030 if (lookupChangeType(d->cursor_, true) == Change::DELETED
1031 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1032 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1033 flag.message(from_utf8(N_("This portion of the document is deleted.")));
1034 flag.setEnabled(false);
1038 Cursor & cur = d->cursor_;
1040 if (cur.getStatus(cmd, flag))
1045 // FIXME: This is a bit problematic because we don't check if this is
1046 // a document BufferView or not for these LFUNs. We probably have to
1047 // dispatch both to currentBufferView() and, if that fails,
1048 // to documentBufferView(); same as we do now for current Buffer and
1049 // document Buffer. Ideally those LFUN should go to Buffer as they
1050 // operate on the full Buffer and the cursor is only needed either for
1051 // an Undo record or to restore a cursor position. But we don't know
1052 // how to do that inside Buffer of course.
1053 case LFUN_BUFFER_PARAMS_APPLY:
1054 case LFUN_LAYOUT_MODULES_CLEAR:
1055 case LFUN_LAYOUT_MODULE_ADD:
1056 case LFUN_LAYOUT_RELOAD:
1057 case LFUN_TEXTCLASS_APPLY:
1058 case LFUN_TEXTCLASS_LOAD:
1059 flag.setEnabled(!buffer_.isReadonly());
1063 // We do not use the LyXAction flag for readonly because Undo sets the
1064 // buffer clean/dirty status by itself.
1065 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasUndoStack());
1068 // We do not use the LyXAction flag for readonly because Redo sets the
1069 // buffer clean/dirty status by itself.
1070 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasRedoStack());
1072 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
1073 case LFUN_FILE_INSERT_PLAINTEXT: {
1074 docstring const fname = cmd.argument();
1075 if (!FileName::isAbsolute(to_utf8(fname))) {
1076 flag.message(_("Absolute filename expected."));
1079 flag.setEnabled(cur.inTexted());
1082 case LFUN_FILE_INSERT:
1083 case LFUN_BOOKMARK_SAVE:
1084 // FIXME: Actually, these LFUNS should be moved to Text
1085 flag.setEnabled(cur.inTexted());
1088 case LFUN_FONT_STATE:
1089 case LFUN_LABEL_INSERT:
1090 case LFUN_INFO_INSERT:
1091 case LFUN_PARAGRAPH_GOTO:
1092 case LFUN_NOTE_NEXT:
1093 case LFUN_REFERENCE_NEXT:
1094 case LFUN_WORD_FIND:
1095 case LFUN_WORD_FIND_FORWARD:
1096 case LFUN_WORD_FIND_BACKWARD:
1097 case LFUN_WORD_REPLACE:
1100 case LFUN_MARK_TOGGLE:
1101 case LFUN_SCREEN_RECENTER:
1102 case LFUN_SCREEN_SHOW_CURSOR:
1103 case LFUN_BIBTEX_DATABASE_ADD:
1104 case LFUN_BIBTEX_DATABASE_DEL:
1105 case LFUN_STATISTICS:
1106 case LFUN_KEYMAP_OFF:
1107 case LFUN_KEYMAP_PRIMARY:
1108 case LFUN_KEYMAP_SECONDARY:
1109 case LFUN_KEYMAP_TOGGLE:
1110 case LFUN_INSET_SELECT_ALL:
1111 flag.setEnabled(true);
1114 case LFUN_WORD_FINDADV: {
1115 FindAndReplaceOptions opt;
1116 istringstream iss(to_utf8(cmd.argument()));
1118 flag.setEnabled(opt.repl_buf_name.empty()
1119 || !buffer_.isReadonly());
1123 case LFUN_LABEL_GOTO:
1124 flag.setEnabled(!cmd.argument().empty()
1125 || getInsetByCode<InsetRef>(cur, REF_CODE));
1128 case LFUN_CHANGES_MERGE:
1129 case LFUN_CHANGE_NEXT:
1130 case LFUN_CHANGE_PREVIOUS:
1131 case LFUN_ALL_CHANGES_ACCEPT:
1132 case LFUN_ALL_CHANGES_REJECT:
1133 // TODO: context-sensitive enabling of LFUNs
1134 // In principle, these command should only be enabled if there
1135 // is a change in the document. However, without proper
1136 // optimizations, this will inevitably result in poor performance.
1137 flag.setEnabled(true);
1140 case LFUN_SCREEN_UP:
1141 case LFUN_SCREEN_DOWN:
1143 case LFUN_SCREEN_UP_SELECT:
1144 case LFUN_SCREEN_DOWN_SELECT:
1145 case LFUN_INSET_FORALL:
1146 flag.setEnabled(true);
1149 case LFUN_LAYOUT_TABULAR:
1150 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
1154 flag.setEnabled(!cur.inset().forcePlainLayout(cur.idx()));
1157 case LFUN_LAYOUT_PARAGRAPH:
1158 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
1161 case LFUN_BRANCH_ADD_INSERT:
1162 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1165 case LFUN_DIALOG_SHOW_NEW_INSET:
1166 // FIXME: this is wrong, but I do not understand the
1168 if (cur.inset().lyxCode() == CAPTION_CODE)
1169 return cur.inset().getStatus(cur, cmd, flag);
1170 // FIXME we should consider passthru paragraphs too.
1171 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1174 case LFUN_CITATION_INSERT: {
1175 FuncRequest fr(LFUN_INSET_INSERT, "citation");
1176 // FIXME: This could turn in a recursive hell.
1177 // Shouldn't we use Buffer::getStatus() instead?
1178 flag.setEnabled(lyx::getStatus(fr).enabled());
1181 case LFUN_INSET_APPLY: {
1182 string const name = cmd.getArg(0);
1183 Inset * inset = editedInset(name);
1185 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1186 if (!inset->getStatus(cur, fr, flag)) {
1187 // Every inset is supposed to handle this
1188 LASSERT(false, break);
1191 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1192 flag = lyx::getStatus(fr);
1205 Inset * BufferView::editedInset(string const & name) const
1207 map<string, Inset *>::const_iterator it = d->edited_insets_.find(name);
1208 return it == d->edited_insets_.end() ? 0 : it->second;
1212 void BufferView::editInset(string const & name, Inset * inset)
1214 d->edited_insets_[name] = inset;
1218 void BufferView::dispatch(FuncRequest const & cmd, DispatchResult & dr)
1220 LYXERR(Debug::ACTION, "BufferView::dispatch: cmd: " << cmd);
1222 string const argument = to_utf8(cmd.argument());
1223 Cursor & cur = d->cursor_;
1226 // Don't dispatch function that does not apply to internal buffers.
1227 if (buffer_.isInternal()
1228 && lyxaction.funcHasFlag(cmd.action(), LyXAction::NoInternal))
1231 // We'll set this back to false if need be.
1232 bool dispatched = true;
1233 buffer_.undo().beginUndoGroup();
1235 FuncCode const act = cmd.action();
1238 case LFUN_BUFFER_PARAMS_APPLY: {
1239 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1240 cur.recordUndoBufferParams();
1241 istringstream ss(to_utf8(cmd.argument()));
1244 int const unknown_tokens = buffer_.readHeader(lex);
1245 if (unknown_tokens != 0) {
1246 LYXERR0("Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1247 << unknown_tokens << " unknown token"
1248 << (unknown_tokens == 1 ? "" : "s"));
1250 updateDocumentClass(olddc);
1252 // We are most certainly here because of a change in the document
1253 // It is then better to make sure that all dialogs are in sync with
1254 // current document settings.
1255 dr.screenUpdate(Update::Force | Update::FitCursor);
1256 dr.forceBufferUpdate();
1260 case LFUN_LAYOUT_MODULES_CLEAR: {
1261 // FIXME: this modifies the document in cap::switchBetweenClasses
1262 // without calling recordUndo. Fix this before using
1263 // recordUndoBufferParams().
1264 cur.recordUndoFullBuffer();
1265 buffer_.params().clearLayoutModules();
1266 makeDocumentClass();
1267 dr.screenUpdate(Update::Force);
1268 dr.forceBufferUpdate();
1272 case LFUN_LAYOUT_MODULE_ADD: {
1273 BufferParams const & params = buffer_.params();
1274 if (!params.layoutModuleCanBeAdded(argument)) {
1275 LYXERR0("Module `" << argument <<
1276 "' cannot be added due to failed requirements or "
1277 "conflicts with installed modules.");
1280 // FIXME: this modifies the document in cap::switchBetweenClasses
1281 // without calling recordUndo. Fix this before using
1282 // recordUndoBufferParams().
1283 cur.recordUndoFullBuffer();
1284 buffer_.params().addLayoutModule(argument);
1285 makeDocumentClass();
1286 dr.screenUpdate(Update::Force);
1287 dr.forceBufferUpdate();
1291 case LFUN_TEXTCLASS_APPLY: {
1292 // since this shortcircuits, the second call is made only if
1294 bool const success =
1295 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1296 LayoutFileList::get().load(argument, buffer_.filePath());
1298 docstring s = bformat(_("The document class `%1$s' "
1299 "could not be loaded."), from_utf8(argument));
1300 frontend::Alert::error(_("Could not load class"), s);
1304 LayoutFile const * old_layout = buffer_.params().baseClass();
1305 LayoutFile const * new_layout = &(LayoutFileList::get()[argument]);
1307 if (old_layout == new_layout)
1311 // Save the old, possibly modular, layout for use in conversion.
1312 // FIXME: this modifies the document in cap::switchBetweenClasses
1313 // without calling recordUndo. Fix this before using
1314 // recordUndoBufferParams().
1315 cur.recordUndoFullBuffer();
1316 buffer_.params().setBaseClass(argument);
1317 makeDocumentClass();
1318 dr.screenUpdate(Update::Force);
1319 dr.forceBufferUpdate();
1323 case LFUN_TEXTCLASS_LOAD: {
1324 // since this shortcircuits, the second call is made only if
1326 bool const success =
1327 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1328 LayoutFileList::get().load(argument, buffer_.filePath());
1330 docstring s = bformat(_("The document class `%1$s' "
1331 "could not be loaded."), from_utf8(argument));
1332 frontend::Alert::error(_("Could not load class"), s);
1337 case LFUN_LAYOUT_RELOAD: {
1338 LayoutFileIndex bc = buffer_.params().baseClassID();
1339 LayoutFileList::get().reset(bc);
1340 buffer_.params().setBaseClass(bc);
1341 makeDocumentClass();
1342 dr.screenUpdate(Update::Force);
1343 dr.forceBufferUpdate();
1348 dr.setMessage(_("Undo"));
1349 cur.clearSelection();
1350 if (!cur.textUndo())
1351 dr.setMessage(_("No further undo information"));
1353 dr.screenUpdate(Update::Force | Update::FitCursor);
1354 dr.forceBufferUpdate();
1358 dr.setMessage(_("Redo"));
1359 cur.clearSelection();
1360 if (!cur.textRedo())
1361 dr.setMessage(_("No further redo information"));
1363 dr.screenUpdate(Update::Force | Update::FitCursor);
1364 dr.forceBufferUpdate();
1367 case LFUN_FONT_STATE:
1368 dr.setMessage(cur.currentState());
1371 case LFUN_BOOKMARK_SAVE:
1372 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1375 case LFUN_LABEL_GOTO: {
1376 docstring label = cmd.argument();
1377 if (label.empty()) {
1379 getInsetByCode<InsetRef>(cur, REF_CODE);
1381 label = inset->getParam("reference");
1382 // persistent=false: use temp_bookmark
1386 if (!label.empty()) {
1388 // at the moment, this is redundant, since gotoLabel will
1389 // eventually call LFUN_PARAGRAPH_GOTO, but it seems best
1391 dr.screenUpdate(Update::Force | Update::FitCursor);
1396 case LFUN_PARAGRAPH_GOTO: {
1397 int const id = convert<int>(cmd.getArg(0));
1398 int const pos = convert<int>(cmd.getArg(1));
1400 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1401 b = theBufferList().next(b)) {
1404 cur.setCursor(b->getParFromID(id));
1406 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1410 LYXERR(Debug::INFO, "Paragraph " << cur.paragraph().id()
1411 << " found in buffer `"
1412 << b->absFileName() << "'.");
1414 if (b == &buffer_) {
1417 mouseSetCursor(cur);
1418 dr.screenUpdate(Update::Force | Update::FitCursor);
1420 // Switch to other buffer view and resend cmd
1421 lyx::dispatch(FuncRequest(
1422 LFUN_BUFFER_SWITCH, b->absFileName()));
1430 case LFUN_NOTE_NEXT:
1431 gotoInset(this, NOTE_CODE, false);
1434 case LFUN_REFERENCE_NEXT: {
1435 vector<InsetCode> tmp;
1436 tmp.push_back(LABEL_CODE);
1437 tmp.push_back(REF_CODE);
1438 gotoInset(this, tmp, true);
1442 case LFUN_CHANGE_NEXT:
1443 findNextChange(this);
1444 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1445 dr.screenUpdate(Update::Force | Update::FitCursor);
1448 case LFUN_CHANGE_PREVIOUS:
1449 findPreviousChange(this);
1450 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1451 dr.screenUpdate(Update::Force | Update::FitCursor);
1454 case LFUN_CHANGES_MERGE:
1455 if (findNextChange(this) || findPreviousChange(this)) {
1456 dr.screenUpdate(Update::Force | Update::FitCursor);
1457 dr.forceBufferUpdate();
1458 showDialog("changes");
1462 case LFUN_ALL_CHANGES_ACCEPT:
1463 // select complete document
1465 cur.selHandle(true);
1466 buffer_.text().cursorBottom(cur);
1467 // accept everything in a single step to support atomic undo
1468 buffer_.text().acceptOrRejectChanges(cur, Text::ACCEPT);
1470 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1471 dr.screenUpdate(Update::Force | Update::FitCursor);
1472 dr.forceBufferUpdate();
1475 case LFUN_ALL_CHANGES_REJECT:
1476 // select complete document
1478 cur.selHandle(true);
1479 buffer_.text().cursorBottom(cur);
1480 // reject everything in a single step to support atomic undo
1481 // Note: reject does not work recursively; the user may have to repeat the operation
1482 buffer_.text().acceptOrRejectChanges(cur, Text::REJECT);
1484 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1485 dr.screenUpdate(Update::Force | Update::FitCursor);
1486 dr.forceBufferUpdate();
1489 case LFUN_WORD_FIND_FORWARD:
1490 case LFUN_WORD_FIND_BACKWARD: {
1492 // Would it maybe be better if this variable were view specific anyway?
1493 static docstring last_search;
1494 docstring searched_string;
1496 if (!cmd.argument().empty()) {
1497 last_search = cmd.argument();
1498 searched_string = cmd.argument();
1500 searched_string = last_search;
1503 if (searched_string.empty())
1506 bool const fw = act == LFUN_WORD_FIND_FORWARD;
1507 docstring const data =
1508 find2string(searched_string, true, false, fw);
1509 bool found = lyxfind(this, FuncRequest(LFUN_WORD_FIND, data));
1511 dr.screenUpdate(Update::Force | Update::FitCursor);
1521 case LFUN_WORD_FIND: {
1522 FuncRequest req = cmd;
1523 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1524 req = d->search_request_cache_;
1525 if (req.argument().empty()) {
1526 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, "findreplace"));
1529 if (lyxfind(this, req)) {
1530 dr.screenUpdate(Update::Force | Update::FitCursor);
1537 d->search_request_cache_ = req;
1541 case LFUN_WORD_REPLACE: {
1542 bool has_deleted = false;
1543 if (cur.selection()) {
1544 DocIterator beg = cur.selectionBegin();
1545 DocIterator end = cur.selectionEnd();
1546 if (beg.pit() == end.pit()) {
1547 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1548 if (!cur.inMathed() && cur.paragraph().isDeleted(p)) {
1555 if (lyxreplace(this, cmd, has_deleted)) {
1556 dr.forceBufferUpdate();
1557 dr.screenUpdate(Update::Force | Update::FitCursor);
1567 case LFUN_WORD_FINDADV: {
1568 FindAndReplaceOptions opt;
1569 istringstream iss(to_utf8(cmd.argument()));
1571 if (findAdv(this, opt)) {
1572 dr.screenUpdate(Update::Force | Update::FitCursor);
1583 cur.clearSelection();
1584 dr.setMessage(from_utf8(N_("Mark off")));
1588 cur.clearSelection();
1590 dr.setMessage(from_utf8(N_("Mark on")));
1593 case LFUN_MARK_TOGGLE:
1594 cur.setSelection(false);
1597 dr.setMessage(from_utf8(N_("Mark removed")));
1600 dr.setMessage(from_utf8(N_("Mark set")));
1605 case LFUN_SCREEN_SHOW_CURSOR:
1609 case LFUN_SCREEN_RECENTER:
1613 case LFUN_BIBTEX_DATABASE_ADD: {
1614 Cursor tmpcur = cur;
1615 findInset(tmpcur, BIBTEX_CODE, false);
1616 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1619 if (inset->addDatabase(cmd.argument())) {
1620 buffer_.invalidateBibfileCache();
1621 dr.forceBufferUpdate();
1627 case LFUN_BIBTEX_DATABASE_DEL: {
1628 Cursor tmpcur = cur;
1629 findInset(tmpcur, BIBTEX_CODE, false);
1630 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1633 if (inset->delDatabase(cmd.argument())) {
1634 buffer_.invalidateBibfileCache();
1635 dr.forceBufferUpdate();
1641 case LFUN_STATISTICS: {
1642 DocIterator from, to;
1643 if (cur.selection()) {
1644 from = cur.selectionBegin();
1645 to = cur.selectionEnd();
1647 from = doc_iterator_begin(&buffer_);
1648 to = doc_iterator_end(&buffer_);
1650 buffer_.updateStatistics(from, to);
1651 int const words = buffer_.wordCount();
1652 int const chars = buffer_.charCount(false);
1653 int const chars_blanks = buffer_.charCount(true);
1655 if (cur.selection())
1656 message = _("Statistics for the selection:");
1658 message = _("Statistics for the document:");
1661 message += bformat(_("%1$d words"), words);
1663 message += _("One word");
1665 if (chars_blanks != 1)
1666 message += bformat(_("%1$d characters (including blanks)"),
1669 message += _("One character (including blanks)");
1672 message += bformat(_("%1$d characters (excluding blanks)"),
1675 message += _("One character (excluding blanks)");
1677 Alert::information(_("Statistics"), message);
1681 case LFUN_SCREEN_UP:
1682 case LFUN_SCREEN_DOWN: {
1683 Point p = getPos(cur);
1684 // This code has been commented out to enable to scroll down a
1685 // document, even if there are large insets in it (see bug #5465).
1686 /*if (p.y_ < 0 || p.y_ > height_) {
1687 // The cursor is off-screen so recenter before proceeding.
1691 int const scrolled = scroll(act == LFUN_SCREEN_UP
1692 ? -height_ : height_);
1693 if (act == LFUN_SCREEN_UP && scrolled > -height_)
1695 if (act == LFUN_SCREEN_DOWN && scrolled < height_)
1696 p = Point(width_, height_);
1697 bool const in_texted = cur.inTexted();
1698 cur.setCursor(doc_iterator_begin(cur.buffer()));
1699 cur.selHandle(false);
1700 buffer_.changed(true);
1701 updateHoveredInset();
1703 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_,
1704 true, act == LFUN_SCREEN_UP);
1705 //FIXME: what to do with cur.x_target()?
1706 bool update = in_texted && cur.bv().checkDepm(cur, old);
1709 if (update || cur.mark())
1710 dr.screenUpdate(Update::Force | Update::FitCursor);
1712 dr.forceBufferUpdate();
1717 string const scroll_type = cmd.getArg(0);
1718 int scroll_step = 0;
1719 if (scroll_type == "line")
1720 scroll_step = d->scrollbarParameters_.single_step;
1721 else if (scroll_type == "page")
1722 scroll_step = d->scrollbarParameters_.page_step;
1725 string const scroll_quantity = cmd.getArg(1);
1726 if (scroll_quantity == "up")
1727 scrollUp(scroll_step);
1728 else if (scroll_quantity == "down")
1729 scrollDown(scroll_step);
1731 int const scroll_value = convert<int>(scroll_quantity);
1733 scroll(scroll_step * scroll_value);
1735 buffer_.changed(true);
1736 updateHoveredInset();
1737 dr.forceBufferUpdate();
1741 case LFUN_SCREEN_UP_SELECT: {
1742 // FIXME: why is the algorithm different from LFUN_SCREEN_UP?
1743 cur.selHandle(true);
1744 if (isTopScreen()) {
1745 lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1749 int y = getPos(cur).y_;
1750 int const ymin = y - height_ + defaultRowHeight();
1751 while (y > ymin && cur.up())
1755 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1759 case LFUN_SCREEN_DOWN_SELECT: {
1760 // FIXME: why is the algorithm different from LFUN_SCREEN_DOWN?
1761 cur.selHandle(true);
1762 if (isBottomScreen()) {
1763 lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1767 int y = getPos(cur).y_;
1768 int const ymax = y + height_ - defaultRowHeight();
1769 while (y < ymax && cur.down())
1773 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1778 case LFUN_INSET_SELECT_ALL: {
1779 // true if all cells are selected
1780 bool const all_selected = cur.depth() > 1
1781 && cur.selBegin().at_begin()
1782 && cur.selEnd().at_end();
1783 // true if some cells are selected
1784 bool const cells_selected = cur.depth() > 1
1785 && cur.selBegin().at_cell_begin()
1786 && cur.selEnd().at_cell_end();
1787 if (all_selected || (cells_selected && !cur.inset().isTable())) {
1788 // All the contents of the inset if selected, or only at
1789 // least one cell but inset is not a table.
1790 // Select the inset from outside.
1793 cur.setSelection(true);
1795 } else if (cells_selected) {
1796 // At least one complete cell is selected and inset is a table.
1801 cur.setSelection(true);
1802 cur.idx() = cur.lastidx();
1803 cur.pos() = cur.lastpos();
1805 // select current cell
1809 cur.setSelection(true);
1810 cur.pit() = cur.lastpit();
1811 cur.pos() = cur.lastpos();
1813 cur.setCurrentFont();
1814 dr.screenUpdate(Update::Force);
1819 // This would be in Buffer class if only Cursor did not
1820 // require a bufferview
1821 case LFUN_INSET_FORALL: {
1822 docstring const name = from_utf8(cmd.getArg(0));
1823 string const commandstr = cmd.getLongArg(1);
1824 FuncRequest const fr = lyxaction.lookupFunc(commandstr);
1826 // an arbitrary number to limit number of iterations
1827 const int max_iter = 100000;
1829 Cursor & cur = d->cursor_;
1830 Cursor const savecur = cur;
1832 if (!cur.nextInset())
1834 cur.beginUndoGroup();
1835 while(cur && iterations < max_iter) {
1836 Inset * const ins = cur.nextInset();
1839 docstring insname = ins->layoutName();
1840 while (!insname.empty()) {
1841 if (insname == name || name == from_utf8("*")) {
1843 lyx::dispatch(fr, dr);
1847 size_t const i = insname.rfind(':');
1848 if (i == string::npos)
1850 insname = insname.substr(0, i);
1852 // if we did not delete the inset, skip it
1853 if (!cur.nextInset() || cur.nextInset() == ins)
1858 /** This is a dummy undo record only to remember the cursor
1859 * that has just been set; this will be used on a redo action
1860 * (see ticket #10097)
1862 * FIXME: a better fix would be to have a way to set the
1863 * cursor value directly, but I am not sure it is worth it.
1867 dr.screenUpdate(Update::Force);
1868 dr.forceBufferUpdate();
1870 if (iterations >= max_iter) {
1872 dr.setMessage(bformat(_("`inset-forall' interrupted because number of actions is larger than %1$d"), max_iter));
1874 dr.setMessage(bformat(_("Applied \"%1$s\" to %2$d insets"), from_utf8(commandstr), iterations));
1879 case LFUN_BRANCH_ADD_INSERT: {
1880 docstring branch_name = from_utf8(cmd.getArg(0));
1881 if (branch_name.empty())
1882 if (!Alert::askForText(branch_name, _("Branch name")) ||
1883 branch_name.empty())
1886 DispatchResult drtmp;
1887 buffer_.dispatch(FuncRequest(LFUN_BRANCH_ADD, branch_name), drtmp);
1888 if (drtmp.error()) {
1889 Alert::warning(_("Branch already exists"), drtmp.message());
1892 BranchList & branch_list = buffer_.params().branchlist();
1893 vector<docstring> const branches =
1894 getVectorFromString(branch_name, branch_list.separator());
1895 for (vector<docstring>::const_iterator it = branches.begin();
1896 it != branches.end(); ++it) {
1898 lyx::dispatch(FuncRequest(LFUN_BRANCH_INSERT, branch_name));
1903 case LFUN_KEYMAP_OFF:
1904 getIntl().keyMapOn(false);
1907 case LFUN_KEYMAP_PRIMARY:
1908 getIntl().keyMapPrim();
1911 case LFUN_KEYMAP_SECONDARY:
1912 getIntl().keyMapSec();
1915 case LFUN_KEYMAP_TOGGLE:
1916 getIntl().toggleKeyMap();
1919 case LFUN_DIALOG_SHOW_NEW_INSET: {
1920 string const name = cmd.getArg(0);
1921 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
1922 if (decodeInsetParam(name, data, buffer_))
1923 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
1925 lyxerr << "Inset type '" << name <<
1926 "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" << endl;
1930 case LFUN_CITATION_INSERT: {
1931 if (argument.empty()) {
1932 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
1935 // we can have one optional argument, delimited by '|'
1936 // citation-insert <key>|<text_before>
1937 // this should be enhanced to also support text_after
1938 // and citation style
1939 string arg = argument;
1941 if (contains(argument, "|")) {
1942 arg = token(argument, '|', 0);
1943 opt1 = token(argument, '|', 1);
1946 // if our cursor is directly in front of or behind a citation inset,
1947 // we will instead add the new key to it.
1948 Inset * inset = cur.nextInset();
1949 if (!inset || inset->lyxCode() != CITE_CODE)
1950 inset = cur.prevInset();
1951 if (inset && inset->lyxCode() == CITE_CODE) {
1952 InsetCitation * icite = static_cast<InsetCitation *>(inset);
1953 if (icite->addKey(arg)) {
1954 dr.forceBufferUpdate();
1955 dr.screenUpdate(Update::FitCursor | Update::SinglePar);
1957 LYXERR0("Discarding optional argument to citation-insert.");
1962 InsetCommandParams icp(CITE_CODE);
1963 icp["key"] = from_utf8(arg);
1965 icp["before"] = from_utf8(opt1);
1966 string icstr = InsetCommand::params2string(icp);
1967 FuncRequest fr(LFUN_INSET_INSERT, icstr);
1972 case LFUN_INSET_APPLY: {
1973 string const name = cmd.getArg(0);
1974 Inset * inset = editedInset(name);
1976 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1980 // put cursor in front of inset.
1981 if (!setCursorFromInset(inset)) {
1982 LASSERT(false, break);
1985 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1986 inset->dispatch(cur, fr);
1987 dr.screenUpdate(cur.result().screenUpdate());
1988 if (cur.result().needBufferUpdate())
1989 dr.forceBufferUpdate();
1994 // The change of language of buffer belongs to the Buffer class.
1995 // We have to do it here because we need a cursor for Undo.
1996 // When Undo::recordUndoBufferParams() is implemented someday
1997 // LFUN_BUFFER_LANGUAGE should be handled by the Buffer class.
1998 case LFUN_BUFFER_LANGUAGE: {
1999 Language const * oldL = buffer_.params().language;
2000 Language const * newL = languages.getLanguage(argument);
2001 if (!newL || oldL == newL)
2003 if (oldL->rightToLeft() == newL->rightToLeft()) {
2004 cur.recordUndoFullBuffer();
2005 buffer_.changeLanguage(oldL, newL);
2006 cur.setCurrentFont();
2007 dr.forceBufferUpdate();
2012 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
2013 case LFUN_FILE_INSERT_PLAINTEXT: {
2014 bool const as_paragraph = (act == LFUN_FILE_INSERT_PLAINTEXT_PARA);
2015 string const fname = to_utf8(cmd.argument());
2016 if (!FileName::isAbsolute(fname))
2017 dr.setMessage(_("Absolute filename expected."));
2019 insertPlaintextFile(FileName(fname), as_paragraph);
2024 // OK, so try the Buffer itself...
2025 buffer_.dispatch(cmd, dr);
2026 dispatched = dr.dispatched();
2030 buffer_.undo().endUndoGroup();
2031 dr.dispatched(dispatched);
2033 // NOTE: The code below is copied from Cursor::dispatch. If you
2034 // need to modify this, please update the other one too.
2036 // notify insets we just entered/left
2037 if (cursor() != old) {
2038 old.beginUndoGroup();
2040 bool badcursor = notifyCursorLeavesOrEnters(old, cursor());
2042 cursor().fixIfBroken();
2043 resetInlineCompletionPos();
2050 docstring const BufferView::requestSelection()
2052 Cursor & cur = d->cursor_;
2054 LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
2055 if (!cur.selection()) {
2056 d->xsel_cache_.set = false;
2060 LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
2061 if (!d->xsel_cache_.set ||
2062 cur.top() != d->xsel_cache_.cursor ||
2063 cur.realAnchor().top() != d->xsel_cache_.anchor)
2065 d->xsel_cache_.cursor = cur.top();
2066 d->xsel_cache_.anchor = cur.realAnchor().top();
2067 d->xsel_cache_.set = cur.selection();
2068 return cur.selectionAsString(false);
2074 void BufferView::clearSelection()
2076 d->cursor_.clearSelection();
2077 // Clear the selection buffer. Otherwise a subsequent
2078 // middle-mouse-button paste would use the selection buffer,
2079 // not the more current external selection.
2080 cap::clearSelection();
2081 d->xsel_cache_.set = false;
2082 // The buffer did not really change, but this causes the
2083 // redraw we need because we cleared the selection above.
2084 buffer_.changed(false);
2088 void BufferView::resize(int width, int height)
2090 // Update from work area
2094 // Clear the paragraph height cache.
2095 d->par_height_.clear();
2096 // Redo the metrics.
2101 Inset const * BufferView::getCoveringInset(Text const & text,
2104 TextMetrics & tm = d->text_metrics_[&text];
2105 Inset * inset = tm.checkInsetHit(x, y);
2109 if (!inset->descendable(*this))
2110 // No need to go further down if the inset is not
2114 size_t cell_number = inset->nargs();
2115 // Check all the inner cell.
2116 for (size_t i = 0; i != cell_number; ++i) {
2117 Text const * inner_text = inset->getText(i);
2120 Inset const * inset_deeper =
2121 getCoveringInset(*inner_text, x, y);
2123 return inset_deeper;
2131 void BufferView::updateHoveredInset() const
2133 // Get inset under mouse, if there is one.
2134 int const x = d->mouse_position_cache_.x_;
2135 int const y = d->mouse_position_cache_.y_;
2136 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
2138 d->clickable_inset_ = covering_inset && covering_inset->clickable(*this, x, y);
2140 if (covering_inset == d->last_inset_)
2141 // Same inset, no need to do anything...
2144 bool need_redraw = false;
2145 if (d->last_inset_) {
2146 // Remove the hint on the last hovered inset (if any).
2147 need_redraw |= d->last_inset_->setMouseHover(this, false);
2151 if (covering_inset && covering_inset->setMouseHover(this, true)) {
2153 // Only the insets that accept the hover state, do
2154 // clear the last_inset_, so only set the last_inset_
2155 // member if the hovered setting is accepted.
2156 d->last_inset_ = covering_inset;
2160 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
2161 << d->mouse_position_cache_.x_ << ", "
2162 << d->mouse_position_cache_.y_ << ")");
2164 d->update_strategy_ = DecorationUpdate;
2166 // This event (moving without mouse click) is not passed further.
2167 // This should be changed if it is further utilized.
2168 buffer_.changed(false);
2173 void BufferView::clearLastInset(Inset * inset) const
2175 if (d->last_inset_ != inset) {
2176 LYXERR0("Wrong last_inset!");
2183 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
2185 //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
2187 // This is only called for mouse related events including
2188 // LFUN_FILE_OPEN generated by drag-and-drop.
2189 FuncRequest cmd = cmd0;
2191 Cursor old = cursor();
2193 cur.push(buffer_.inset());
2194 cur.setSelection(d->cursor_.selection());
2196 // Either the inset under the cursor or the
2197 // surrounding Text will handle this event.
2199 // make sure we stay within the screen...
2200 cmd.set_y(min(max(cmd.y(), -1), height_));
2202 d->mouse_position_cache_.x_ = cmd.x();
2203 d->mouse_position_cache_.y_ = cmd.y();
2205 if (cmd.action() == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
2206 updateHoveredInset();
2210 // Build temporary cursor.
2211 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x(), cmd.y());
2213 // If inset is not editable, cur.pos() might point behind the
2214 // inset (depending on cmd.x(), cmd.y()). This is needed for
2215 // editing to fix bug 9628, but e.g. the context menu needs a
2216 // cursor in front of the inset.
2217 if ((inset->hasSettings() || !inset->contextMenuName().empty()
2218 || inset->lyxCode() == SEPARATOR_CODE) &&
2219 cur.nextInset() != inset && cur.prevInset() == inset)
2221 } else if (cur.inTexted() && cur.pos()
2222 && cur.paragraph().isEnvSeparator(cur.pos() - 1)) {
2223 // Always place cursor in front of a separator inset.
2227 // Put anchor at the same position.
2230 cur.beginUndoGroup();
2232 // Try to dispatch to an non-editable inset near this position
2233 // via the temp cursor. If the inset wishes to change the real
2234 // cursor it has to do so explicitly by using
2235 // cur.bv().cursor() = cur; (or similar)
2237 inset->dispatch(cur, cmd);
2239 // Now dispatch to the temporary cursor. If the real cursor should
2240 // be modified, the inset's dispatch has to do so explicitly.
2241 if (!inset || !cur.result().dispatched())
2244 // Notify left insets
2246 bool badcursor = old.fixIfBroken() | cur.fixIfBroken();
2247 badcursor |= notifyCursorLeavesOrEnters(old, cur);
2249 cursor().fixIfBroken();
2254 // Do we have a selection?
2255 theSelection().haveSelection(cursor().selection());
2257 if (cur.needBufferUpdate()) {
2258 cur.clearBufferUpdate();
2259 buffer().updateBuffer();
2262 // If the command has been dispatched,
2263 if (cur.result().dispatched() || cur.result().screenUpdate())
2264 processUpdateFlags(cur.result().screenUpdate());
2268 int BufferView::minVisiblePart()
2270 return 2 * defaultRowHeight();
2274 int BufferView::scroll(int y)
2277 return scrollDown(y);
2279 return scrollUp(-y);
2284 int BufferView::scrollDown(int offset)
2286 Text * text = &buffer_.text();
2287 TextMetrics & tm = d->text_metrics_[text];
2288 int const ymax = height_ + offset;
2290 pair<pit_type, ParagraphMetrics const *> last = tm.last();
2291 int bottom_pos = last.second->position() + last.second->descent();
2292 if (lyxrc.scroll_below_document)
2293 bottom_pos += height_ - minVisiblePart();
2294 if (last.first + 1 == int(text->paragraphs().size())) {
2295 if (bottom_pos <= height_)
2297 offset = min(offset, bottom_pos - height_);
2300 if (bottom_pos > ymax)
2302 tm.newParMetricsDown();
2304 d->anchor_ypos_ -= offset;
2309 int BufferView::scrollUp(int offset)
2311 Text * text = &buffer_.text();
2312 TextMetrics & tm = d->text_metrics_[text];
2313 int ymin = - offset;
2315 pair<pit_type, ParagraphMetrics const *> first = tm.first();
2316 int top_pos = first.second->position() - first.second->ascent();
2317 if (first.first == 0) {
2320 offset = min(offset, - top_pos);
2325 tm.newParMetricsUp();
2327 d->anchor_ypos_ += offset;
2332 void BufferView::setCursorFromRow(int row)
2334 setCursorFromRow(row, buffer_.texrow());
2338 void BufferView::setCursorFromRow(int row, TexRow const & texrow)
2342 pit_type newpit = 0;
2343 pos_type newpos = 0;
2345 texrow.getIdFromRow(row, tmpid, tmppos);
2347 bool posvalid = (tmpid != -1);
2349 // we need to make sure that the row and position
2350 // we got back are valid, because the buffer may well
2351 // have changed since we last generated the LaTeX.
2352 DocIterator dit = buffer_.getParFromID(tmpid);
2353 if (dit == doc_iterator_end(&buffer_))
2355 else if (dit.depth() > 1) {
2356 // We are in an inset.
2357 pos_type lastpos = dit.lastpos();
2358 dit.pos() = tmppos > lastpos ? lastpos : tmppos;
2364 // now have to check pos.
2366 Paragraph const & par = buffer_.text().getPar(newpit);
2367 if (newpos > par.size()) {
2368 LYXERR0("Requested position no longer valid.");
2369 newpos = par.size() - 1;
2374 frontend::Alert::error(_("Inverse Search Failed"),
2375 _("Invalid position requested by inverse search.\n"
2376 "You need to update the viewed document."));
2380 buffer_.text().setCursor(d->cursor_, newpit, newpos);
2381 d->cursor_.setSelection(false);
2382 d->cursor_.resetAnchor();
2387 bool BufferView::setCursorFromInset(Inset const * inset)
2389 // are we already there?
2390 if (cursor().nextInset() == inset)
2393 // Inset is not at cursor position. Find it in the document.
2396 while (cur && cur.nextInset() != inset)
2407 void BufferView::gotoLabel(docstring const & label)
2409 ListOfBuffers bufs = buffer().allRelatives();
2410 ListOfBuffers::iterator it = bufs.begin();
2411 for (; it != bufs.end(); ++it) {
2412 Buffer const * buf = *it;
2415 shared_ptr<Toc> toc = buf->tocBackend().toc("label");
2416 Toc::const_iterator toc_it = toc->begin();
2417 Toc::const_iterator end = toc->end();
2418 for (; toc_it != end; ++toc_it) {
2419 if (label == toc_it->str()) {
2420 lyx::dispatch(toc_it->action());
2428 TextMetrics const & BufferView::textMetrics(Text const * t) const
2430 return const_cast<BufferView *>(this)->textMetrics(t);
2434 TextMetrics & BufferView::textMetrics(Text const * t)
2437 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
2438 if (tmc_it == d->text_metrics_.end()) {
2439 tmc_it = d->text_metrics_.insert(
2440 make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
2442 return tmc_it->second;
2446 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
2449 return textMetrics(t).parMetrics(pit);
2453 int BufferView::workHeight() const
2459 void BufferView::setCursor(DocIterator const & dit)
2462 size_t const n = dit.depth();
2463 for (size_t i = 0; i < n; ++i)
2464 dit[i].inset().edit(d->cursor_, true);
2466 d->cursor_.setCursor(dit);
2467 d->cursor_.setSelection(false);
2468 d->cursor_.setCurrentFont();
2470 // It seems on general grounds as if this is probably needed, but
2471 // it is not yet clear.
2472 // See bug #7394 and r38388.
2473 // d->cursor.resetAnchor();
2477 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
2479 // Would be wrong to delete anything if we have a selection.
2480 if (cur.selection())
2483 bool need_anchor_change = false;
2484 bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
2485 need_anchor_change);
2487 if (need_anchor_change)
2495 // we would rather not do this here, but it needs to be done before
2496 // the changed() signal is sent.
2497 buffer_.updateBuffer();
2499 buffer_.changed(true);
2504 bool BufferView::mouseSetCursor(Cursor & cur, bool select)
2506 LASSERT(&cur.bv() == this, return false);
2509 // this event will clear selection so we save selection for
2510 // persistent selection
2511 cap::saveSelection(cursor());
2513 d->cursor_.macroModeClose();
2514 // If a macro has been finalized, the cursor might have been broken
2517 // Has the cursor just left the inset?
2518 bool const leftinset = (&d->cursor_.inset() != &cur.inset());
2520 d->cursor_.fixIfBroken();
2522 // FIXME: shift-mouse selection doesn't work well across insets.
2523 bool const do_selection =
2524 select && &d->cursor_.normalAnchor().inset() == &cur.inset();
2526 // do the dEPM magic if needed
2527 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
2528 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
2529 // the leftinset bool would not be necessary (badcursor instead).
2530 bool update = leftinset;
2531 if (!do_selection && d->cursor_.inTexted())
2532 update |= checkDepm(cur, d->cursor_);
2535 d->cursor_.resetAnchor();
2536 d->cursor_.setCursor(cur);
2537 d->cursor_.boundary(cur.boundary());
2539 d->cursor_.setSelection();
2541 d->cursor_.clearSelection();
2543 d->cursor_.finishUndo();
2544 d->cursor_.setCurrentFont();
2546 cur.forceBufferUpdate();
2551 void BufferView::putSelectionAt(DocIterator const & cur,
2552 int length, bool backwards)
2554 d->cursor_.clearSelection();
2560 d->cursor_.pos() += length;
2561 d->cursor_.setSelection(d->cursor_, -length);
2563 d->cursor_.setSelection(d->cursor_, length);
2568 bool BufferView::selectIfEmpty(DocIterator & cur)
2570 if ((cur.inTexted() && !cur.paragraph().empty())
2571 || (cur.inMathed() && !cur.cell().empty()))
2574 pit_type const beg_pit = cur.pit();
2576 // The paragraph associated to this item isn't
2577 // the first one, so it can be selected
2580 // We have to resort to select the space between the
2581 // end of this item and the begin of the next one
2585 // If it is the only item in the document,
2586 // nothing can be selected
2589 pit_type const end_pit = cur.pit();
2590 pos_type const end_pos = cur.pos();
2591 d->cursor_.clearSelection();
2593 d->cursor_.setCursor(cur);
2594 d->cursor_.pit() = beg_pit;
2595 d->cursor_.pos() = 0;
2596 d->cursor_.setSelection(false);
2597 d->cursor_.resetAnchor();
2598 d->cursor_.pit() = end_pit;
2599 d->cursor_.pos() = end_pos;
2600 d->cursor_.setSelection();
2605 Cursor & BufferView::cursor()
2611 Cursor const & BufferView::cursor() const
2617 pit_type BufferView::anchor_ref() const
2619 return d->anchor_pit_;
2623 bool BufferView::singleParUpdate()
2625 Text & buftext = buffer_.text();
2626 pit_type const bottom_pit = d->cursor_.bottom().pit();
2627 TextMetrics & tm = textMetrics(&buftext);
2628 int old_height = tm.parMetrics(bottom_pit).height();
2630 // make sure inline completion pointer is ok
2631 if (d->inlineCompletionPos_.fixIfBroken())
2632 d->inlineCompletionPos_ = DocIterator();
2634 // In Single Paragraph mode, rebreak only
2635 // the (main text, not inset!) paragraph containing the cursor.
2636 // (if this paragraph contains insets etc., rebreaking will
2637 // recursively descend)
2638 tm.redoParagraph(bottom_pit);
2639 ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
2640 if (pm.height() != old_height)
2641 // Paragraph height has changed so we cannot proceed to
2642 // the singlePar optimisation.
2645 d->update_strategy_ = SingleParUpdate;
2647 LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
2648 << " y2: " << pm.position() + pm.descent()
2649 << " pit: " << bottom_pit
2650 << " singlepar: 1");
2655 void BufferView::updateMetrics()
2657 if (height_ == 0 || width_ == 0)
2660 Text & buftext = buffer_.text();
2661 pit_type const npit = int(buftext.paragraphs().size());
2663 // Clear out the position cache in case of full screen redraw,
2664 d->coord_cache_.clear();
2666 // Clear out paragraph metrics to avoid having invalid metrics
2667 // in the cache from paragraphs not relayouted below
2668 // The complete text metrics will be redone.
2669 d->text_metrics_.clear();
2671 TextMetrics & tm = textMetrics(&buftext);
2673 // make sure inline completion pointer is ok
2674 if (d->inlineCompletionPos_.fixIfBroken())
2675 d->inlineCompletionPos_ = DocIterator();
2677 if (d->anchor_pit_ >= npit)
2678 // The anchor pit must have been deleted...
2679 d->anchor_pit_ = npit - 1;
2681 // Rebreak anchor paragraph.
2682 tm.redoParagraph(d->anchor_pit_);
2683 ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
2686 if (d->anchor_pit_ == 0) {
2687 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
2689 // Complete buffer visible? Then it's easy.
2690 if (scrollRange == 0)
2691 d->anchor_ypos_ = anchor_pm.ascent();
2693 // FIXME: Some clever handling needed to show
2694 // the _first_ paragraph up to the top if the cursor is
2695 // in the first line.
2697 anchor_pm.setPosition(d->anchor_ypos_);
2699 LYXERR(Debug::PAINTING, "metrics: "
2700 << " anchor pit = " << d->anchor_pit_
2701 << " anchor ypos = " << d->anchor_ypos_);
2703 // Redo paragraphs above anchor if necessary.
2704 int y1 = d->anchor_ypos_ - anchor_pm.ascent();
2705 // We are now just above the anchor paragraph.
2706 pit_type pit1 = d->anchor_pit_ - 1;
2707 for (; pit1 >= 0 && y1 >= 0; --pit1) {
2708 tm.redoParagraph(pit1);
2709 ParagraphMetrics & pm = tm.par_metrics_[pit1];
2711 // Save the paragraph position in the cache.
2716 // Redo paragraphs below the anchor if necessary.
2717 int y2 = d->anchor_ypos_ + anchor_pm.descent();
2718 // We are now just below the anchor paragraph.
2719 pit_type pit2 = d->anchor_pit_ + 1;
2720 for (; pit2 < npit && y2 <= height_; ++pit2) {
2721 tm.redoParagraph(pit2);
2722 ParagraphMetrics & pm = tm.par_metrics_[pit2];
2724 // Save the paragraph position in the cache.
2729 LYXERR(Debug::PAINTING, "Metrics: "
2730 << " anchor pit = " << d->anchor_pit_
2731 << " anchor ypos = " << d->anchor_ypos_
2734 << " pit1 = " << pit1
2735 << " pit2 = " << pit2);
2737 d->update_strategy_ = FullScreenUpdate;
2739 if (lyxerr.debugging(Debug::WORKAREA)) {
2740 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
2741 d->coord_cache_.dump();
2746 void BufferView::insertLyXFile(FileName const & fname)
2748 LASSERT(d->cursor_.inTexted(), return);
2750 // Get absolute path of file and add ".lyx"
2751 // to the filename if necessary
2752 FileName filename = fileSearch(string(), fname.absFileName(), "lyx");
2754 docstring const disp_fn = makeDisplayPath(filename.absFileName());
2755 // emit message signal.
2756 message(bformat(_("Inserting document %1$s..."), disp_fn));
2759 Buffer buf(filename.absFileName(), false);
2760 if (buf.loadLyXFile() == Buffer::ReadSuccess) {
2761 ErrorList & el = buffer_.errorList("Parse");
2762 // Copy the inserted document error list into the current buffer one.
2763 el = buf.errorList("Parse");
2764 buffer_.undo().recordUndo(d->cursor_);
2765 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
2766 buf.params().documentClassPtr(), el);
2767 res = _("Document %1$s inserted.");
2769 res = _("Could not insert document %1$s");
2772 buffer_.changed(true);
2773 // emit message signal.
2774 message(bformat(res, disp_fn));
2778 Point BufferView::coordOffset(DocIterator const & dit) const
2784 // Addup contribution of nested insets, from inside to outside,
2785 // keeping the outer paragraph for a special handling below
2786 for (size_t i = dit.depth() - 1; i >= 1; --i) {
2787 CursorSlice const & sl = dit[i];
2791 // get relative position inside sl.inset()
2792 sl.inset().cursorPos(*this, sl, dit.boundary() && (i + 1 == dit.depth()), xx, yy);
2794 // Make relative position inside of the edited inset relative to sl.inset()
2798 // In case of an RTL inset, the edited inset will be positioned to the left
2801 bool boundary_i = dit.boundary() && i + 1 == dit.depth();
2802 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2807 // remember width for the case that sl.inset() is positioned in an RTL inset
2808 if (i && dit[i - 1].text()) {
2809 // If this Inset is inside a Text Inset, retrieve the Dimension
2810 // from the containing text instead of using Inset::dimension() which
2811 // might not be implemented.
2812 // FIXME (Abdel 23/09/2007): this is a bit messy because of the
2813 // elimination of Inset::dim_ cache. This coordOffset() method needs
2814 // to be rewritten in light of the new design.
2815 Dimension const & dim = coordCache().getInsets().dim(&sl.inset());
2818 Dimension const dim = sl.inset().dimension(*this);
2822 //lyxerr << "Cursor::getPos, i: "
2823 // << i << " x: " << xx << " y: " << y << endl;
2826 // Add contribution of initial rows of outermost paragraph
2827 CursorSlice const & sl = dit[0];
2828 TextMetrics const & tm = textMetrics(sl.text());
2829 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2831 LBUFERR(!pm.rows().empty());
2832 y -= pm.rows()[0].ascent();
2834 // FIXME: document this mess
2836 if (sl.pos() > 0 && dit.depth() == 1) {
2838 if (pos && dit.boundary())
2840 // lyxerr << "coordOffset: boundary:" << dit.boundary() << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
2841 rend = pm.pos2row(pos);
2843 rend = pm.pos2row(sl.pos());
2845 size_t rend = pm.pos2row(sl.pos());
2847 for (size_t rit = 0; rit != rend; ++rit)
2848 y += pm.rows()[rit].height();
2849 y += pm.rows()[rend].ascent();
2851 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
2853 // Make relative position from the nested inset now bufferview absolute.
2854 int xx = bottom_tm.cursorX(dit.bottom(), dit.boundary() && dit.depth() == 1);
2857 // In the RTL case place the nested inset at the left of the cursor in
2858 // the outer paragraph
2859 bool boundary_1 = dit.boundary() && 1 == dit.depth();
2860 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
2868 Point BufferView::getPos(DocIterator const & dit) const
2870 if (!paragraphVisible(dit))
2871 return Point(-1, -1);
2873 CursorSlice const & bot = dit.bottom();
2874 TextMetrics const & tm = textMetrics(bot.text());
2876 // offset from outer paragraph
2877 Point p = coordOffset(dit);
2878 p.y_ += tm.parMetrics(bot.pit()).position();
2883 bool BufferView::paragraphVisible(DocIterator const & dit) const
2885 CursorSlice const & bot = dit.bottom();
2886 TextMetrics const & tm = textMetrics(bot.text());
2888 return tm.contains(bot.pit());
2892 void BufferView::cursorPosAndHeight(Point & p, int & h) const
2894 Cursor const & cur = cursor();
2895 Font const font = cur.getFont();
2896 frontend::FontMetrics const & fm = theFontMetrics(font);
2897 int const asc = fm.maxAscent();
2898 int const des = fm.maxDescent();
2905 bool BufferView::cursorInView(Point const & p, int h) const
2907 Cursor const & cur = cursor();
2908 // does the cursor touch the screen ?
2909 if (p.y_ + h < 0 || p.y_ >= workHeight() || !paragraphVisible(cur))
2915 int BufferView::horizScrollOffset() const
2917 return d->horiz_scroll_offset_;
2921 CursorSlice const & BufferView::currentRowSlice() const
2923 return d->current_row_slice_;
2927 CursorSlice const & BufferView::lastRowSlice() const
2929 return d->last_row_slice_;
2933 void BufferView::setCurrentRowSlice(CursorSlice const & rowSlice)
2935 // nothing to do if the cursor was already on this row
2936 if (d->current_row_slice_ == rowSlice) {
2937 d->last_row_slice_ = CursorSlice();
2941 // if the (previous) current row was scrolled, we have to
2942 // remember it in order to repaint it next time.
2943 if (d->horiz_scroll_offset_ != 0)
2944 d->last_row_slice_ = d->current_row_slice_;
2946 d->last_row_slice_ = CursorSlice();
2948 // Since we changed row, the scroll offset is not valid anymore
2949 d->horiz_scroll_offset_ = 0;
2950 d->current_row_slice_ = rowSlice;
2954 void BufferView::checkCursorScrollOffset(PainterInfo & pi)
2956 CursorSlice rowSlice = d->cursor_.bottom();
2957 TextMetrics const & tm = textMetrics(rowSlice.text());
2959 // Stop if metrics have not been computed yet, since it means
2960 // that there is nothing to do.
2961 if (!tm.contains(rowSlice.pit()))
2963 ParagraphMetrics const & pm = tm.parMetrics(rowSlice.pit());
2964 Row const & row = pm.getRow(rowSlice.pos(),
2965 d->cursor_.boundary() && rowSlice == d->cursor_.top());
2966 rowSlice.pos() = row.pos();
2968 // Set the row on which the cursor lives.
2969 setCurrentRowSlice(rowSlice);
2971 // If insets referred to by cursor are not all in the cache, the positions
2972 // need to be recomputed.
2973 if (!d->cursor_.inCoordCache()) {
2974 /** FIXME: the code below adds an extraneous computation of
2975 * inset positions, and can therefore be bad for performance
2976 * (think for example about a very large tabular inset.
2977 * Redawing the row where it is means redrawing the whole
2980 * The bug that this fixes is the following: assume that there
2981 * is a very large math inset. Upon entering the inset, when
2982 * pressing `End', the row is not scrolled and the cursor is
2983 * not visible. The extra row computation makes sure that the
2984 * inset positions are correctly computed and set in the
2985 * cache. This would not happen if we did not have two-stage
2988 * A proper fix would be to always have proper inset positions
2991 // Force the recomputation of inset positions
2992 bool const drawing = pi.pain.isDrawingEnabled();
2993 pi.pain.setDrawingEnabled(false);
2994 // No need to care about vertical position.
2995 RowPainter rp(pi, buffer().text(), d->cursor_.bottom().pit(), row,
2996 -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_;