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 flag.setEnabled(buffer_.areChangesPresent());
1136 case LFUN_SCREEN_UP:
1137 case LFUN_SCREEN_DOWN:
1139 case LFUN_SCREEN_UP_SELECT:
1140 case LFUN_SCREEN_DOWN_SELECT:
1141 case LFUN_INSET_FORALL:
1142 flag.setEnabled(true);
1145 case LFUN_LAYOUT_TABULAR:
1146 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
1150 flag.setEnabled(!cur.inset().forcePlainLayout(cur.idx()));
1153 case LFUN_LAYOUT_PARAGRAPH:
1154 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
1157 case LFUN_BRANCH_ADD_INSERT:
1158 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1161 case LFUN_DIALOG_SHOW_NEW_INSET:
1162 // FIXME: this is wrong, but I do not understand the
1164 if (cur.inset().lyxCode() == CAPTION_CODE)
1165 return cur.inset().getStatus(cur, cmd, flag);
1166 // FIXME we should consider passthru paragraphs too.
1167 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1170 case LFUN_CITATION_INSERT: {
1171 FuncRequest fr(LFUN_INSET_INSERT, "citation");
1172 // FIXME: This could turn in a recursive hell.
1173 // Shouldn't we use Buffer::getStatus() instead?
1174 flag.setEnabled(lyx::getStatus(fr).enabled());
1177 case LFUN_INSET_APPLY: {
1178 string const name = cmd.getArg(0);
1179 Inset * inset = editedInset(name);
1181 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1182 if (!inset->getStatus(cur, fr, flag)) {
1183 // Every inset is supposed to handle this
1184 LASSERT(false, break);
1187 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1188 flag = lyx::getStatus(fr);
1201 Inset * BufferView::editedInset(string const & name) const
1203 map<string, Inset *>::const_iterator it = d->edited_insets_.find(name);
1204 return it == d->edited_insets_.end() ? 0 : it->second;
1208 void BufferView::editInset(string const & name, Inset * inset)
1210 d->edited_insets_[name] = inset;
1214 void BufferView::dispatch(FuncRequest const & cmd, DispatchResult & dr)
1216 LYXERR(Debug::ACTION, "BufferView::dispatch: cmd: " << cmd);
1218 string const argument = to_utf8(cmd.argument());
1219 Cursor & cur = d->cursor_;
1222 // Don't dispatch function that does not apply to internal buffers.
1223 if (buffer_.isInternal()
1224 && lyxaction.funcHasFlag(cmd.action(), LyXAction::NoInternal))
1227 // We'll set this back to false if need be.
1228 bool dispatched = true;
1229 buffer_.undo().beginUndoGroup();
1231 FuncCode const act = cmd.action();
1234 case LFUN_BUFFER_PARAMS_APPLY: {
1235 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1236 cur.recordUndoBufferParams();
1237 istringstream ss(to_utf8(cmd.argument()));
1240 int const unknown_tokens = buffer_.readHeader(lex);
1241 if (unknown_tokens != 0) {
1242 LYXERR0("Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1243 << unknown_tokens << " unknown token"
1244 << (unknown_tokens == 1 ? "" : "s"));
1246 updateDocumentClass(olddc);
1248 // We are most certainly here because of a change in the document
1249 // It is then better to make sure that all dialogs are in sync with
1250 // current document settings.
1251 dr.screenUpdate(Update::Force | Update::FitCursor);
1252 dr.forceBufferUpdate();
1256 case LFUN_LAYOUT_MODULES_CLEAR: {
1257 // FIXME: this modifies the document in cap::switchBetweenClasses
1258 // without calling recordUndo. Fix this before using
1259 // recordUndoBufferParams().
1260 cur.recordUndoFullBuffer();
1261 buffer_.params().clearLayoutModules();
1262 makeDocumentClass();
1263 dr.screenUpdate(Update::Force);
1264 dr.forceBufferUpdate();
1268 case LFUN_LAYOUT_MODULE_ADD: {
1269 BufferParams const & params = buffer_.params();
1270 if (!params.layoutModuleCanBeAdded(argument)) {
1271 LYXERR0("Module `" << argument <<
1272 "' cannot be added due to failed requirements or "
1273 "conflicts with installed modules.");
1276 // FIXME: this modifies the document in cap::switchBetweenClasses
1277 // without calling recordUndo. Fix this before using
1278 // recordUndoBufferParams().
1279 cur.recordUndoFullBuffer();
1280 buffer_.params().addLayoutModule(argument);
1281 makeDocumentClass();
1282 dr.screenUpdate(Update::Force);
1283 dr.forceBufferUpdate();
1287 case LFUN_TEXTCLASS_APPLY: {
1288 // since this shortcircuits, the second call is made only if
1290 bool const success =
1291 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1292 LayoutFileList::get().load(argument, buffer_.filePath());
1294 docstring s = bformat(_("The document class `%1$s' "
1295 "could not be loaded."), from_utf8(argument));
1296 frontend::Alert::error(_("Could not load class"), s);
1300 LayoutFile const * old_layout = buffer_.params().baseClass();
1301 LayoutFile const * new_layout = &(LayoutFileList::get()[argument]);
1303 if (old_layout == new_layout)
1307 // Save the old, possibly modular, layout for use in conversion.
1308 // FIXME: this modifies the document in cap::switchBetweenClasses
1309 // without calling recordUndo. Fix this before using
1310 // recordUndoBufferParams().
1311 cur.recordUndoFullBuffer();
1312 buffer_.params().setBaseClass(argument);
1313 makeDocumentClass();
1314 dr.screenUpdate(Update::Force);
1315 dr.forceBufferUpdate();
1319 case LFUN_TEXTCLASS_LOAD: {
1320 // since this shortcircuits, the second call is made only if
1322 bool const success =
1323 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1324 LayoutFileList::get().load(argument, buffer_.filePath());
1326 docstring s = bformat(_("The document class `%1$s' "
1327 "could not be loaded."), from_utf8(argument));
1328 frontend::Alert::error(_("Could not load class"), s);
1333 case LFUN_LAYOUT_RELOAD: {
1334 LayoutFileIndex bc = buffer_.params().baseClassID();
1335 LayoutFileList::get().reset(bc);
1336 buffer_.params().setBaseClass(bc);
1337 makeDocumentClass();
1338 dr.screenUpdate(Update::Force);
1339 dr.forceBufferUpdate();
1344 dr.setMessage(_("Undo"));
1345 cur.clearSelection();
1346 if (!cur.textUndo())
1347 dr.setMessage(_("No further undo information"));
1349 dr.screenUpdate(Update::Force | Update::FitCursor);
1350 dr.forceBufferUpdate();
1354 dr.setMessage(_("Redo"));
1355 cur.clearSelection();
1356 if (!cur.textRedo())
1357 dr.setMessage(_("No further redo information"));
1359 dr.screenUpdate(Update::Force | Update::FitCursor);
1360 dr.forceBufferUpdate();
1363 case LFUN_FONT_STATE:
1364 dr.setMessage(cur.currentState());
1367 case LFUN_BOOKMARK_SAVE:
1368 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1371 case LFUN_LABEL_GOTO: {
1372 docstring label = cmd.argument();
1373 if (label.empty()) {
1375 getInsetByCode<InsetRef>(cur, REF_CODE);
1377 label = inset->getParam("reference");
1378 // persistent=false: use temp_bookmark
1382 if (!label.empty()) {
1384 // at the moment, this is redundant, since gotoLabel will
1385 // eventually call LFUN_PARAGRAPH_GOTO, but it seems best
1387 dr.screenUpdate(Update::Force | Update::FitCursor);
1392 case LFUN_PARAGRAPH_GOTO: {
1393 int const id = convert<int>(cmd.getArg(0));
1394 int const pos = convert<int>(cmd.getArg(1));
1396 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1397 b = theBufferList().next(b)) {
1400 cur.setCursor(b->getParFromID(id));
1402 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1406 LYXERR(Debug::INFO, "Paragraph " << cur.paragraph().id()
1407 << " found in buffer `"
1408 << b->absFileName() << "'.");
1410 if (b == &buffer_) {
1413 mouseSetCursor(cur);
1414 dr.screenUpdate(Update::Force | Update::FitCursor);
1416 // Switch to other buffer view and resend cmd
1417 lyx::dispatch(FuncRequest(
1418 LFUN_BUFFER_SWITCH, b->absFileName()));
1426 case LFUN_NOTE_NEXT:
1427 gotoInset(this, NOTE_CODE, false);
1430 case LFUN_REFERENCE_NEXT: {
1431 vector<InsetCode> tmp;
1432 tmp.push_back(LABEL_CODE);
1433 tmp.push_back(REF_CODE);
1434 gotoInset(this, tmp, true);
1438 case LFUN_CHANGE_NEXT:
1439 findNextChange(this);
1440 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1441 dr.screenUpdate(Update::Force | Update::FitCursor);
1444 case LFUN_CHANGE_PREVIOUS:
1445 findPreviousChange(this);
1446 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1447 dr.screenUpdate(Update::Force | Update::FitCursor);
1450 case LFUN_CHANGES_MERGE:
1451 if (findNextChange(this) || findPreviousChange(this)) {
1452 dr.screenUpdate(Update::Force | Update::FitCursor);
1453 dr.forceBufferUpdate();
1454 showDialog("changes");
1458 case LFUN_ALL_CHANGES_ACCEPT:
1459 // select complete document
1461 cur.selHandle(true);
1462 buffer_.text().cursorBottom(cur);
1463 // accept everything in a single step to support atomic undo
1464 buffer_.text().acceptOrRejectChanges(cur, Text::ACCEPT);
1466 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1467 dr.screenUpdate(Update::Force | Update::FitCursor);
1468 dr.forceBufferUpdate();
1471 case LFUN_ALL_CHANGES_REJECT:
1472 // select complete document
1474 cur.selHandle(true);
1475 buffer_.text().cursorBottom(cur);
1476 // reject everything in a single step to support atomic undo
1477 // Note: reject does not work recursively; the user may have to repeat the operation
1478 buffer_.text().acceptOrRejectChanges(cur, Text::REJECT);
1480 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1481 dr.screenUpdate(Update::Force | Update::FitCursor);
1482 dr.forceBufferUpdate();
1485 case LFUN_WORD_FIND_FORWARD:
1486 case LFUN_WORD_FIND_BACKWARD: {
1488 // Would it maybe be better if this variable were view specific anyway?
1489 static docstring last_search;
1490 docstring searched_string;
1492 if (!cmd.argument().empty()) {
1493 last_search = cmd.argument();
1494 searched_string = cmd.argument();
1496 searched_string = last_search;
1499 if (searched_string.empty())
1502 bool const fw = act == LFUN_WORD_FIND_FORWARD;
1503 docstring const data =
1504 find2string(searched_string, true, false, fw);
1505 bool found = lyxfind(this, FuncRequest(LFUN_WORD_FIND, data));
1507 dr.screenUpdate(Update::Force | Update::FitCursor);
1517 case LFUN_WORD_FIND: {
1518 FuncRequest req = cmd;
1519 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1520 req = d->search_request_cache_;
1521 if (req.argument().empty()) {
1522 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, "findreplace"));
1525 if (lyxfind(this, req)) {
1526 dr.screenUpdate(Update::Force | Update::FitCursor);
1533 d->search_request_cache_ = req;
1537 case LFUN_WORD_REPLACE: {
1538 bool has_deleted = false;
1539 if (cur.selection()) {
1540 DocIterator beg = cur.selectionBegin();
1541 DocIterator end = cur.selectionEnd();
1542 if (beg.pit() == end.pit()) {
1543 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1544 if (!cur.inMathed() && cur.paragraph().isDeleted(p)) {
1551 if (lyxreplace(this, cmd, has_deleted)) {
1552 dr.forceBufferUpdate();
1553 dr.screenUpdate(Update::Force | Update::FitCursor);
1563 case LFUN_WORD_FINDADV: {
1564 FindAndReplaceOptions opt;
1565 istringstream iss(to_utf8(cmd.argument()));
1567 if (findAdv(this, opt)) {
1568 dr.screenUpdate(Update::Force | Update::FitCursor);
1579 cur.clearSelection();
1580 dr.setMessage(from_utf8(N_("Mark off")));
1584 cur.clearSelection();
1586 dr.setMessage(from_utf8(N_("Mark on")));
1589 case LFUN_MARK_TOGGLE:
1590 cur.setSelection(false);
1593 dr.setMessage(from_utf8(N_("Mark removed")));
1596 dr.setMessage(from_utf8(N_("Mark set")));
1601 case LFUN_SCREEN_SHOW_CURSOR:
1605 case LFUN_SCREEN_RECENTER:
1609 case LFUN_BIBTEX_DATABASE_ADD: {
1610 Cursor tmpcur = cur;
1611 findInset(tmpcur, BIBTEX_CODE, false);
1612 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1615 if (inset->addDatabase(cmd.argument())) {
1616 buffer_.invalidateBibfileCache();
1617 dr.forceBufferUpdate();
1623 case LFUN_BIBTEX_DATABASE_DEL: {
1624 Cursor tmpcur = cur;
1625 findInset(tmpcur, BIBTEX_CODE, false);
1626 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1629 if (inset->delDatabase(cmd.argument())) {
1630 buffer_.invalidateBibfileCache();
1631 dr.forceBufferUpdate();
1637 case LFUN_STATISTICS: {
1638 DocIterator from, to;
1639 if (cur.selection()) {
1640 from = cur.selectionBegin();
1641 to = cur.selectionEnd();
1643 from = doc_iterator_begin(&buffer_);
1644 to = doc_iterator_end(&buffer_);
1646 buffer_.updateStatistics(from, to);
1647 int const words = buffer_.wordCount();
1648 int const chars = buffer_.charCount(false);
1649 int const chars_blanks = buffer_.charCount(true);
1651 if (cur.selection())
1652 message = _("Statistics for the selection:");
1654 message = _("Statistics for the document:");
1657 message += bformat(_("%1$d words"), words);
1659 message += _("One word");
1661 if (chars_blanks != 1)
1662 message += bformat(_("%1$d characters (including blanks)"),
1665 message += _("One character (including blanks)");
1668 message += bformat(_("%1$d characters (excluding blanks)"),
1671 message += _("One character (excluding blanks)");
1673 Alert::information(_("Statistics"), message);
1677 case LFUN_SCREEN_UP:
1678 case LFUN_SCREEN_DOWN: {
1679 Point p = getPos(cur);
1680 // This code has been commented out to enable to scroll down a
1681 // document, even if there are large insets in it (see bug #5465).
1682 /*if (p.y_ < 0 || p.y_ > height_) {
1683 // The cursor is off-screen so recenter before proceeding.
1687 int const scrolled = scroll(act == LFUN_SCREEN_UP
1688 ? -height_ : height_);
1689 if (act == LFUN_SCREEN_UP && scrolled > -height_)
1691 if (act == LFUN_SCREEN_DOWN && scrolled < height_)
1692 p = Point(width_, height_);
1693 bool const in_texted = cur.inTexted();
1694 cur.setCursor(doc_iterator_begin(cur.buffer()));
1695 cur.selHandle(false);
1696 buffer_.changed(true);
1697 updateHoveredInset();
1699 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_,
1700 true, act == LFUN_SCREEN_UP);
1701 //FIXME: what to do with cur.x_target()?
1702 bool update = in_texted && cur.bv().checkDepm(cur, old);
1705 if (update || cur.mark())
1706 dr.screenUpdate(Update::Force | Update::FitCursor);
1708 dr.forceBufferUpdate();
1713 string const scroll_type = cmd.getArg(0);
1714 int scroll_step = 0;
1715 if (scroll_type == "line")
1716 scroll_step = d->scrollbarParameters_.single_step;
1717 else if (scroll_type == "page")
1718 scroll_step = d->scrollbarParameters_.page_step;
1721 string const scroll_quantity = cmd.getArg(1);
1722 if (scroll_quantity == "up")
1723 scrollUp(scroll_step);
1724 else if (scroll_quantity == "down")
1725 scrollDown(scroll_step);
1727 int const scroll_value = convert<int>(scroll_quantity);
1729 scroll(scroll_step * scroll_value);
1731 buffer_.changed(true);
1732 updateHoveredInset();
1733 dr.forceBufferUpdate();
1737 case LFUN_SCREEN_UP_SELECT: {
1738 // FIXME: why is the algorithm different from LFUN_SCREEN_UP?
1739 cur.selHandle(true);
1740 if (isTopScreen()) {
1741 lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1745 int y = getPos(cur).y_;
1746 int const ymin = y - height_ + defaultRowHeight();
1747 while (y > ymin && cur.up())
1751 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1755 case LFUN_SCREEN_DOWN_SELECT: {
1756 // FIXME: why is the algorithm different from LFUN_SCREEN_DOWN?
1757 cur.selHandle(true);
1758 if (isBottomScreen()) {
1759 lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1763 int y = getPos(cur).y_;
1764 int const ymax = y + height_ - defaultRowHeight();
1765 while (y < ymax && cur.down())
1769 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1774 case LFUN_INSET_SELECT_ALL: {
1775 // true if all cells are selected
1776 bool const all_selected = cur.depth() > 1
1777 && cur.selBegin().at_begin()
1778 && cur.selEnd().at_end();
1779 // true if some cells are selected
1780 bool const cells_selected = cur.depth() > 1
1781 && cur.selBegin().at_cell_begin()
1782 && cur.selEnd().at_cell_end();
1783 if (all_selected || (cells_selected && !cur.inset().isTable())) {
1784 // All the contents of the inset if selected, or only at
1785 // least one cell but inset is not a table.
1786 // Select the inset from outside.
1789 cur.setSelection(true);
1791 } else if (cells_selected) {
1792 // At least one complete cell is selected and inset is a table.
1797 cur.setSelection(true);
1798 cur.idx() = cur.lastidx();
1799 cur.pos() = cur.lastpos();
1801 // select current cell
1805 cur.setSelection(true);
1806 cur.pit() = cur.lastpit();
1807 cur.pos() = cur.lastpos();
1809 cur.setCurrentFont();
1810 dr.screenUpdate(Update::Force);
1815 // This would be in Buffer class if only Cursor did not
1816 // require a bufferview
1817 case LFUN_INSET_FORALL: {
1818 docstring const name = from_utf8(cmd.getArg(0));
1819 string const commandstr = cmd.getLongArg(1);
1820 FuncRequest const fr = lyxaction.lookupFunc(commandstr);
1822 // an arbitrary number to limit number of iterations
1823 const int max_iter = 100000;
1825 Cursor & cur = d->cursor_;
1826 Cursor const savecur = cur;
1828 if (!cur.nextInset())
1830 cur.beginUndoGroup();
1831 while(cur && iterations < max_iter) {
1832 Inset * const ins = cur.nextInset();
1835 docstring insname = ins->layoutName();
1836 while (!insname.empty()) {
1837 if (insname == name || name == from_utf8("*")) {
1839 lyx::dispatch(fr, dr);
1843 size_t const i = insname.rfind(':');
1844 if (i == string::npos)
1846 insname = insname.substr(0, i);
1848 // if we did not delete the inset, skip it
1849 if (!cur.nextInset() || cur.nextInset() == ins)
1854 /** This is a dummy undo record only to remember the cursor
1855 * that has just been set; this will be used on a redo action
1856 * (see ticket #10097)
1858 * FIXME: a better fix would be to have a way to set the
1859 * cursor value directly, but I am not sure it is worth it.
1863 dr.screenUpdate(Update::Force);
1864 dr.forceBufferUpdate();
1866 if (iterations >= max_iter) {
1868 dr.setMessage(bformat(_("`inset-forall' interrupted because number of actions is larger than %1$d"), max_iter));
1870 dr.setMessage(bformat(_("Applied \"%1$s\" to %2$d insets"), from_utf8(commandstr), iterations));
1875 case LFUN_BRANCH_ADD_INSERT: {
1876 docstring branch_name = from_utf8(cmd.getArg(0));
1877 if (branch_name.empty())
1878 if (!Alert::askForText(branch_name, _("Branch name")) ||
1879 branch_name.empty())
1882 DispatchResult drtmp;
1883 buffer_.dispatch(FuncRequest(LFUN_BRANCH_ADD, branch_name), drtmp);
1884 if (drtmp.error()) {
1885 Alert::warning(_("Branch already exists"), drtmp.message());
1888 BranchList & branch_list = buffer_.params().branchlist();
1889 vector<docstring> const branches =
1890 getVectorFromString(branch_name, branch_list.separator());
1891 for (vector<docstring>::const_iterator it = branches.begin();
1892 it != branches.end(); ++it) {
1894 lyx::dispatch(FuncRequest(LFUN_BRANCH_INSERT, branch_name));
1899 case LFUN_KEYMAP_OFF:
1900 getIntl().keyMapOn(false);
1903 case LFUN_KEYMAP_PRIMARY:
1904 getIntl().keyMapPrim();
1907 case LFUN_KEYMAP_SECONDARY:
1908 getIntl().keyMapSec();
1911 case LFUN_KEYMAP_TOGGLE:
1912 getIntl().toggleKeyMap();
1915 case LFUN_DIALOG_SHOW_NEW_INSET: {
1916 string const name = cmd.getArg(0);
1917 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
1918 if (decodeInsetParam(name, data, buffer_))
1919 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
1921 lyxerr << "Inset type '" << name <<
1922 "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" << endl;
1926 case LFUN_CITATION_INSERT: {
1927 if (argument.empty()) {
1928 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
1931 // we can have one optional argument, delimited by '|'
1932 // citation-insert <key>|<text_before>
1933 // this should be enhanced to also support text_after
1934 // and citation style
1935 string arg = argument;
1937 if (contains(argument, "|")) {
1938 arg = token(argument, '|', 0);
1939 opt1 = token(argument, '|', 1);
1942 // if our cursor is directly in front of or behind a citation inset,
1943 // we will instead add the new key to it.
1944 Inset * inset = cur.nextInset();
1945 if (!inset || inset->lyxCode() != CITE_CODE)
1946 inset = cur.prevInset();
1947 if (inset && inset->lyxCode() == CITE_CODE) {
1948 InsetCitation * icite = static_cast<InsetCitation *>(inset);
1949 if (icite->addKey(arg)) {
1950 dr.forceBufferUpdate();
1951 dr.screenUpdate(Update::FitCursor | Update::SinglePar);
1953 LYXERR0("Discarding optional argument to citation-insert.");
1958 InsetCommandParams icp(CITE_CODE);
1959 icp["key"] = from_utf8(arg);
1961 icp["before"] = from_utf8(opt1);
1962 string icstr = InsetCommand::params2string(icp);
1963 FuncRequest fr(LFUN_INSET_INSERT, icstr);
1968 case LFUN_INSET_APPLY: {
1969 string const name = cmd.getArg(0);
1970 Inset * inset = editedInset(name);
1972 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1976 // put cursor in front of inset.
1977 if (!setCursorFromInset(inset)) {
1978 LASSERT(false, break);
1981 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1982 inset->dispatch(cur, fr);
1983 dr.screenUpdate(cur.result().screenUpdate());
1984 if (cur.result().needBufferUpdate())
1985 dr.forceBufferUpdate();
1990 // The change of language of buffer belongs to the Buffer class.
1991 // We have to do it here because we need a cursor for Undo.
1992 // When Undo::recordUndoBufferParams() is implemented someday
1993 // LFUN_BUFFER_LANGUAGE should be handled by the Buffer class.
1994 case LFUN_BUFFER_LANGUAGE: {
1995 Language const * oldL = buffer_.params().language;
1996 Language const * newL = languages.getLanguage(argument);
1997 if (!newL || oldL == newL)
1999 if (oldL->rightToLeft() == newL->rightToLeft()) {
2000 cur.recordUndoFullBuffer();
2001 buffer_.changeLanguage(oldL, newL);
2002 cur.setCurrentFont();
2003 dr.forceBufferUpdate();
2008 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
2009 case LFUN_FILE_INSERT_PLAINTEXT: {
2010 bool const as_paragraph = (act == LFUN_FILE_INSERT_PLAINTEXT_PARA);
2011 string const fname = to_utf8(cmd.argument());
2012 if (!FileName::isAbsolute(fname))
2013 dr.setMessage(_("Absolute filename expected."));
2015 insertPlaintextFile(FileName(fname), as_paragraph);
2020 // OK, so try the Buffer itself...
2021 buffer_.dispatch(cmd, dr);
2022 dispatched = dr.dispatched();
2026 buffer_.undo().endUndoGroup();
2027 dr.dispatched(dispatched);
2029 // NOTE: The code below is copied from Cursor::dispatch. If you
2030 // need to modify this, please update the other one too.
2032 // notify insets we just entered/left
2033 if (cursor() != old) {
2034 old.beginUndoGroup();
2036 bool badcursor = notifyCursorLeavesOrEnters(old, cursor());
2038 cursor().fixIfBroken();
2039 resetInlineCompletionPos();
2046 docstring const BufferView::requestSelection()
2048 Cursor & cur = d->cursor_;
2050 LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
2051 if (!cur.selection()) {
2052 d->xsel_cache_.set = false;
2056 LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
2057 if (!d->xsel_cache_.set ||
2058 cur.top() != d->xsel_cache_.cursor ||
2059 cur.realAnchor().top() != d->xsel_cache_.anchor)
2061 d->xsel_cache_.cursor = cur.top();
2062 d->xsel_cache_.anchor = cur.realAnchor().top();
2063 d->xsel_cache_.set = cur.selection();
2064 return cur.selectionAsString(false);
2070 void BufferView::clearSelection()
2072 d->cursor_.clearSelection();
2073 // Clear the selection buffer. Otherwise a subsequent
2074 // middle-mouse-button paste would use the selection buffer,
2075 // not the more current external selection.
2076 cap::clearSelection();
2077 d->xsel_cache_.set = false;
2078 // The buffer did not really change, but this causes the
2079 // redraw we need because we cleared the selection above.
2080 buffer_.changed(false);
2084 void BufferView::resize(int width, int height)
2086 // Update from work area
2090 // Clear the paragraph height cache.
2091 d->par_height_.clear();
2092 // Redo the metrics.
2097 Inset const * BufferView::getCoveringInset(Text const & text,
2100 TextMetrics & tm = d->text_metrics_[&text];
2101 Inset * inset = tm.checkInsetHit(x, y);
2105 if (!inset->descendable(*this))
2106 // No need to go further down if the inset is not
2110 size_t cell_number = inset->nargs();
2111 // Check all the inner cell.
2112 for (size_t i = 0; i != cell_number; ++i) {
2113 Text const * inner_text = inset->getText(i);
2116 Inset const * inset_deeper =
2117 getCoveringInset(*inner_text, x, y);
2119 return inset_deeper;
2127 void BufferView::updateHoveredInset() const
2129 // Get inset under mouse, if there is one.
2130 int const x = d->mouse_position_cache_.x_;
2131 int const y = d->mouse_position_cache_.y_;
2132 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
2134 d->clickable_inset_ = covering_inset && covering_inset->clickable(*this, x, y);
2136 if (covering_inset == d->last_inset_)
2137 // Same inset, no need to do anything...
2140 bool need_redraw = false;
2141 if (d->last_inset_) {
2142 // Remove the hint on the last hovered inset (if any).
2143 need_redraw |= d->last_inset_->setMouseHover(this, false);
2147 if (covering_inset && covering_inset->setMouseHover(this, true)) {
2149 // Only the insets that accept the hover state, do
2150 // clear the last_inset_, so only set the last_inset_
2151 // member if the hovered setting is accepted.
2152 d->last_inset_ = covering_inset;
2156 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
2157 << d->mouse_position_cache_.x_ << ", "
2158 << d->mouse_position_cache_.y_ << ")");
2160 d->update_strategy_ = DecorationUpdate;
2162 // This event (moving without mouse click) is not passed further.
2163 // This should be changed if it is further utilized.
2164 buffer_.changed(false);
2169 void BufferView::clearLastInset(Inset * inset) const
2171 if (d->last_inset_ != inset) {
2172 LYXERR0("Wrong last_inset!");
2179 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
2181 //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
2183 // This is only called for mouse related events including
2184 // LFUN_FILE_OPEN generated by drag-and-drop.
2185 FuncRequest cmd = cmd0;
2187 Cursor old = cursor();
2189 cur.push(buffer_.inset());
2190 cur.setSelection(d->cursor_.selection());
2192 // Either the inset under the cursor or the
2193 // surrounding Text will handle this event.
2195 // make sure we stay within the screen...
2196 cmd.set_y(min(max(cmd.y(), -1), height_));
2198 d->mouse_position_cache_.x_ = cmd.x();
2199 d->mouse_position_cache_.y_ = cmd.y();
2201 if (cmd.action() == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
2202 updateHoveredInset();
2206 // Build temporary cursor.
2207 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x(), cmd.y());
2209 // If inset is not editable, cur.pos() might point behind the
2210 // inset (depending on cmd.x(), cmd.y()). This is needed for
2211 // editing to fix bug 9628, but e.g. the context menu needs a
2212 // cursor in front of the inset.
2213 if ((inset->hasSettings() || !inset->contextMenuName().empty()
2214 || inset->lyxCode() == SEPARATOR_CODE) &&
2215 cur.nextInset() != inset && cur.prevInset() == inset)
2217 } else if (cur.inTexted() && cur.pos()
2218 && cur.paragraph().isEnvSeparator(cur.pos() - 1)) {
2219 // Always place cursor in front of a separator inset.
2223 // Put anchor at the same position.
2226 cur.beginUndoGroup();
2228 // Try to dispatch to an non-editable inset near this position
2229 // via the temp cursor. If the inset wishes to change the real
2230 // cursor it has to do so explicitly by using
2231 // cur.bv().cursor() = cur; (or similar)
2233 inset->dispatch(cur, cmd);
2235 // Now dispatch to the temporary cursor. If the real cursor should
2236 // be modified, the inset's dispatch has to do so explicitly.
2237 if (!inset || !cur.result().dispatched())
2240 // Notify left insets
2242 bool badcursor = old.fixIfBroken() | cur.fixIfBroken();
2243 badcursor |= notifyCursorLeavesOrEnters(old, cur);
2245 cursor().fixIfBroken();
2250 // Do we have a selection?
2251 theSelection().haveSelection(cursor().selection());
2253 if (cur.needBufferUpdate()) {
2254 cur.clearBufferUpdate();
2255 buffer().updateBuffer();
2258 // If the command has been dispatched,
2259 if (cur.result().dispatched() || cur.result().screenUpdate())
2260 processUpdateFlags(cur.result().screenUpdate());
2264 int BufferView::minVisiblePart()
2266 return 2 * defaultRowHeight();
2270 int BufferView::scroll(int y)
2273 return scrollDown(y);
2275 return scrollUp(-y);
2280 int BufferView::scrollDown(int offset)
2282 Text * text = &buffer_.text();
2283 TextMetrics & tm = d->text_metrics_[text];
2284 int const ymax = height_ + offset;
2286 pair<pit_type, ParagraphMetrics const *> last = tm.last();
2287 int bottom_pos = last.second->position() + last.second->descent();
2288 if (lyxrc.scroll_below_document)
2289 bottom_pos += height_ - minVisiblePart();
2290 if (last.first + 1 == int(text->paragraphs().size())) {
2291 if (bottom_pos <= height_)
2293 offset = min(offset, bottom_pos - height_);
2296 if (bottom_pos > ymax)
2298 tm.newParMetricsDown();
2300 d->anchor_ypos_ -= offset;
2305 int BufferView::scrollUp(int offset)
2307 Text * text = &buffer_.text();
2308 TextMetrics & tm = d->text_metrics_[text];
2309 int ymin = - offset;
2311 pair<pit_type, ParagraphMetrics const *> first = tm.first();
2312 int top_pos = first.second->position() - first.second->ascent();
2313 if (first.first == 0) {
2316 offset = min(offset, - top_pos);
2321 tm.newParMetricsUp();
2323 d->anchor_ypos_ += offset;
2328 void BufferView::setCursorFromRow(int row)
2330 setCursorFromRow(row, buffer_.texrow());
2334 void BufferView::setCursorFromRow(int row, TexRow const & texrow)
2338 pit_type newpit = 0;
2339 pos_type newpos = 0;
2341 texrow.getIdFromRow(row, tmpid, tmppos);
2343 bool posvalid = (tmpid != -1);
2345 // we need to make sure that the row and position
2346 // we got back are valid, because the buffer may well
2347 // have changed since we last generated the LaTeX.
2348 DocIterator dit = buffer_.getParFromID(tmpid);
2349 if (dit == doc_iterator_end(&buffer_))
2351 else if (dit.depth() > 1) {
2352 // We are in an inset.
2353 pos_type lastpos = dit.lastpos();
2354 dit.pos() = tmppos > lastpos ? lastpos : tmppos;
2360 // now have to check pos.
2362 Paragraph const & par = buffer_.text().getPar(newpit);
2363 if (newpos > par.size()) {
2364 LYXERR0("Requested position no longer valid.");
2365 newpos = par.size() - 1;
2370 frontend::Alert::error(_("Inverse Search Failed"),
2371 _("Invalid position requested by inverse search.\n"
2372 "You need to update the viewed document."));
2376 buffer_.text().setCursor(d->cursor_, newpit, newpos);
2377 d->cursor_.setSelection(false);
2378 d->cursor_.resetAnchor();
2383 bool BufferView::setCursorFromInset(Inset const * inset)
2385 // are we already there?
2386 if (cursor().nextInset() == inset)
2389 // Inset is not at cursor position. Find it in the document.
2392 while (cur && cur.nextInset() != inset)
2403 void BufferView::gotoLabel(docstring const & label)
2405 ListOfBuffers bufs = buffer().allRelatives();
2406 ListOfBuffers::iterator it = bufs.begin();
2407 for (; it != bufs.end(); ++it) {
2408 Buffer const * buf = *it;
2411 shared_ptr<Toc> toc = buf->tocBackend().toc("label");
2412 TocIterator toc_it = toc->begin();
2413 TocIterator end = toc->end();
2414 for (; toc_it != end; ++toc_it) {
2415 if (label == toc_it->str()) {
2416 lyx::dispatch(toc_it->action());
2424 TextMetrics const & BufferView::textMetrics(Text const * t) const
2426 return const_cast<BufferView *>(this)->textMetrics(t);
2430 TextMetrics & BufferView::textMetrics(Text const * t)
2433 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
2434 if (tmc_it == d->text_metrics_.end()) {
2435 tmc_it = d->text_metrics_.insert(
2436 make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
2438 return tmc_it->second;
2442 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
2445 return textMetrics(t).parMetrics(pit);
2449 int BufferView::workHeight() const
2455 void BufferView::setCursor(DocIterator const & dit)
2458 size_t const n = dit.depth();
2459 for (size_t i = 0; i < n; ++i)
2460 dit[i].inset().edit(d->cursor_, true);
2462 d->cursor_.setCursor(dit);
2463 d->cursor_.setSelection(false);
2464 d->cursor_.setCurrentFont();
2466 // It seems on general grounds as if this is probably needed, but
2467 // it is not yet clear.
2468 // See bug #7394 and r38388.
2469 // d->cursor.resetAnchor();
2473 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
2475 // Would be wrong to delete anything if we have a selection.
2476 if (cur.selection())
2479 bool need_anchor_change = false;
2480 bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
2481 need_anchor_change);
2483 if (need_anchor_change)
2491 // we would rather not do this here, but it needs to be done before
2492 // the changed() signal is sent.
2493 buffer_.updateBuffer();
2495 buffer_.changed(true);
2500 bool BufferView::mouseSetCursor(Cursor & cur, bool select)
2502 LASSERT(&cur.bv() == this, return false);
2505 // this event will clear selection so we save selection for
2506 // persistent selection
2507 cap::saveSelection(cursor());
2509 d->cursor_.macroModeClose();
2510 // If a macro has been finalized, the cursor might have been broken
2513 // Has the cursor just left the inset?
2514 bool const leftinset = (&d->cursor_.inset() != &cur.inset());
2516 d->cursor_.fixIfBroken();
2518 // FIXME: shift-mouse selection doesn't work well across insets.
2519 bool const do_selection =
2520 select && &d->cursor_.normalAnchor().inset() == &cur.inset();
2522 // do the dEPM magic if needed
2523 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
2524 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
2525 // the leftinset bool would not be necessary (badcursor instead).
2526 bool update = leftinset;
2527 if (!do_selection && d->cursor_.inTexted())
2528 update |= checkDepm(cur, d->cursor_);
2531 d->cursor_.resetAnchor();
2532 d->cursor_.setCursor(cur);
2533 d->cursor_.boundary(cur.boundary());
2535 d->cursor_.setSelection();
2537 d->cursor_.clearSelection();
2539 d->cursor_.finishUndo();
2540 d->cursor_.setCurrentFont();
2542 cur.forceBufferUpdate();
2547 void BufferView::putSelectionAt(DocIterator const & cur,
2548 int length, bool backwards)
2550 d->cursor_.clearSelection();
2556 d->cursor_.pos() += length;
2557 d->cursor_.setSelection(d->cursor_, -length);
2559 d->cursor_.setSelection(d->cursor_, length);
2564 bool BufferView::selectIfEmpty(DocIterator & cur)
2566 if ((cur.inTexted() && !cur.paragraph().empty())
2567 || (cur.inMathed() && !cur.cell().empty()))
2570 pit_type const beg_pit = cur.pit();
2572 // The paragraph associated to this item isn't
2573 // the first one, so it can be selected
2576 // We have to resort to select the space between the
2577 // end of this item and the begin of the next one
2581 // If it is the only item in the document,
2582 // nothing can be selected
2585 pit_type const end_pit = cur.pit();
2586 pos_type const end_pos = cur.pos();
2587 d->cursor_.clearSelection();
2589 d->cursor_.setCursor(cur);
2590 d->cursor_.pit() = beg_pit;
2591 d->cursor_.pos() = 0;
2592 d->cursor_.setSelection(false);
2593 d->cursor_.resetAnchor();
2594 d->cursor_.pit() = end_pit;
2595 d->cursor_.pos() = end_pos;
2596 d->cursor_.setSelection();
2601 Cursor & BufferView::cursor()
2607 Cursor const & BufferView::cursor() const
2613 pit_type BufferView::anchor_ref() const
2615 return d->anchor_pit_;
2619 bool BufferView::singleParUpdate()
2621 Text & buftext = buffer_.text();
2622 pit_type const bottom_pit = d->cursor_.bottom().pit();
2623 TextMetrics & tm = textMetrics(&buftext);
2624 int old_height = tm.parMetrics(bottom_pit).height();
2626 // make sure inline completion pointer is ok
2627 if (d->inlineCompletionPos_.fixIfBroken())
2628 d->inlineCompletionPos_ = DocIterator();
2630 // In Single Paragraph mode, rebreak only
2631 // the (main text, not inset!) paragraph containing the cursor.
2632 // (if this paragraph contains insets etc., rebreaking will
2633 // recursively descend)
2634 tm.redoParagraph(bottom_pit);
2635 ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
2636 if (pm.height() != old_height)
2637 // Paragraph height has changed so we cannot proceed to
2638 // the singlePar optimisation.
2641 d->update_strategy_ = SingleParUpdate;
2643 LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
2644 << " y2: " << pm.position() + pm.descent()
2645 << " pit: " << bottom_pit
2646 << " singlepar: 1");
2651 void BufferView::updateMetrics()
2653 if (height_ == 0 || width_ == 0)
2656 Text & buftext = buffer_.text();
2657 pit_type const npit = int(buftext.paragraphs().size());
2659 // Clear out the position cache in case of full screen redraw,
2660 d->coord_cache_.clear();
2662 // Clear out paragraph metrics to avoid having invalid metrics
2663 // in the cache from paragraphs not relayouted below
2664 // The complete text metrics will be redone.
2665 d->text_metrics_.clear();
2667 TextMetrics & tm = textMetrics(&buftext);
2669 // make sure inline completion pointer is ok
2670 if (d->inlineCompletionPos_.fixIfBroken())
2671 d->inlineCompletionPos_ = DocIterator();
2673 if (d->anchor_pit_ >= npit)
2674 // The anchor pit must have been deleted...
2675 d->anchor_pit_ = npit - 1;
2677 // Rebreak anchor paragraph.
2678 tm.redoParagraph(d->anchor_pit_);
2679 ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
2682 if (d->anchor_pit_ == 0) {
2683 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
2685 // Complete buffer visible? Then it's easy.
2686 if (scrollRange == 0)
2687 d->anchor_ypos_ = anchor_pm.ascent();
2689 // FIXME: Some clever handling needed to show
2690 // the _first_ paragraph up to the top if the cursor is
2691 // in the first line.
2693 anchor_pm.setPosition(d->anchor_ypos_);
2695 LYXERR(Debug::PAINTING, "metrics: "
2696 << " anchor pit = " << d->anchor_pit_
2697 << " anchor ypos = " << d->anchor_ypos_);
2699 // Redo paragraphs above anchor if necessary.
2700 int y1 = d->anchor_ypos_ - anchor_pm.ascent();
2701 // We are now just above the anchor paragraph.
2702 pit_type pit1 = d->anchor_pit_ - 1;
2703 for (; pit1 >= 0 && y1 >= 0; --pit1) {
2704 tm.redoParagraph(pit1);
2705 ParagraphMetrics & pm = tm.par_metrics_[pit1];
2707 // Save the paragraph position in the cache.
2712 // Redo paragraphs below the anchor if necessary.
2713 int y2 = d->anchor_ypos_ + anchor_pm.descent();
2714 // We are now just below the anchor paragraph.
2715 pit_type pit2 = d->anchor_pit_ + 1;
2716 for (; pit2 < npit && y2 <= height_; ++pit2) {
2717 tm.redoParagraph(pit2);
2718 ParagraphMetrics & pm = tm.par_metrics_[pit2];
2720 // Save the paragraph position in the cache.
2725 LYXERR(Debug::PAINTING, "Metrics: "
2726 << " anchor pit = " << d->anchor_pit_
2727 << " anchor ypos = " << d->anchor_ypos_
2730 << " pit1 = " << pit1
2731 << " pit2 = " << pit2);
2733 d->update_strategy_ = FullScreenUpdate;
2735 if (lyxerr.debugging(Debug::WORKAREA)) {
2736 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
2737 d->coord_cache_.dump();
2742 void BufferView::insertLyXFile(FileName const & fname)
2744 LASSERT(d->cursor_.inTexted(), return);
2746 // Get absolute path of file and add ".lyx"
2747 // to the filename if necessary
2748 FileName filename = fileSearch(string(), fname.absFileName(), "lyx");
2750 docstring const disp_fn = makeDisplayPath(filename.absFileName());
2751 // emit message signal.
2752 message(bformat(_("Inserting document %1$s..."), disp_fn));
2755 Buffer buf(filename.absFileName(), false);
2756 if (buf.loadLyXFile() == Buffer::ReadSuccess) {
2757 ErrorList & el = buffer_.errorList("Parse");
2758 // Copy the inserted document error list into the current buffer one.
2759 el = buf.errorList("Parse");
2760 buffer_.undo().recordUndo(d->cursor_);
2761 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
2762 buf.params().documentClassPtr(), el);
2763 res = _("Document %1$s inserted.");
2765 res = _("Could not insert document %1$s");
2768 buffer_.changed(true);
2769 // emit message signal.
2770 message(bformat(res, disp_fn));
2774 Point BufferView::coordOffset(DocIterator const & dit) const
2780 // Addup contribution of nested insets, from inside to outside,
2781 // keeping the outer paragraph for a special handling below
2782 for (size_t i = dit.depth() - 1; i >= 1; --i) {
2783 CursorSlice const & sl = dit[i];
2787 // get relative position inside sl.inset()
2788 sl.inset().cursorPos(*this, sl, dit.boundary() && (i + 1 == dit.depth()), xx, yy);
2790 // Make relative position inside of the edited inset relative to sl.inset()
2794 // In case of an RTL inset, the edited inset will be positioned to the left
2797 bool boundary_i = dit.boundary() && i + 1 == dit.depth();
2798 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2803 // remember width for the case that sl.inset() is positioned in an RTL inset
2804 if (i && dit[i - 1].text()) {
2805 // If this Inset is inside a Text Inset, retrieve the Dimension
2806 // from the containing text instead of using Inset::dimension() which
2807 // might not be implemented.
2808 // FIXME (Abdel 23/09/2007): this is a bit messy because of the
2809 // elimination of Inset::dim_ cache. This coordOffset() method needs
2810 // to be rewritten in light of the new design.
2811 Dimension const & dim = coordCache().getInsets().dim(&sl.inset());
2814 Dimension const dim = sl.inset().dimension(*this);
2818 //lyxerr << "Cursor::getPos, i: "
2819 // << i << " x: " << xx << " y: " << y << endl;
2822 // Add contribution of initial rows of outermost paragraph
2823 CursorSlice const & sl = dit[0];
2824 TextMetrics const & tm = textMetrics(sl.text());
2825 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2827 LBUFERR(!pm.rows().empty());
2828 y -= pm.rows()[0].ascent();
2830 // FIXME: document this mess
2832 if (sl.pos() > 0 && dit.depth() == 1) {
2834 if (pos && dit.boundary())
2836 // lyxerr << "coordOffset: boundary:" << dit.boundary() << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
2837 rend = pm.pos2row(pos);
2839 rend = pm.pos2row(sl.pos());
2841 size_t rend = pm.pos2row(sl.pos());
2843 for (size_t rit = 0; rit != rend; ++rit)
2844 y += pm.rows()[rit].height();
2845 y += pm.rows()[rend].ascent();
2847 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
2849 // Make relative position from the nested inset now bufferview absolute.
2850 int xx = bottom_tm.cursorX(dit.bottom(), dit.boundary() && dit.depth() == 1);
2853 // In the RTL case place the nested inset at the left of the cursor in
2854 // the outer paragraph
2855 bool boundary_1 = dit.boundary() && 1 == dit.depth();
2856 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
2864 Point BufferView::getPos(DocIterator const & dit) const
2866 if (!paragraphVisible(dit))
2867 return Point(-1, -1);
2869 CursorSlice const & bot = dit.bottom();
2870 TextMetrics const & tm = textMetrics(bot.text());
2872 // offset from outer paragraph
2873 Point p = coordOffset(dit);
2874 p.y_ += tm.parMetrics(bot.pit()).position();
2879 bool BufferView::paragraphVisible(DocIterator const & dit) const
2881 CursorSlice const & bot = dit.bottom();
2882 TextMetrics const & tm = textMetrics(bot.text());
2884 return tm.contains(bot.pit());
2888 void BufferView::cursorPosAndHeight(Point & p, int & h) const
2890 Cursor const & cur = cursor();
2891 Font const font = cur.getFont();
2892 frontend::FontMetrics const & fm = theFontMetrics(font);
2893 int const asc = fm.maxAscent();
2894 int const des = fm.maxDescent();
2901 bool BufferView::cursorInView(Point const & p, int h) const
2903 Cursor const & cur = cursor();
2904 // does the cursor touch the screen ?
2905 if (p.y_ + h < 0 || p.y_ >= workHeight() || !paragraphVisible(cur))
2911 int BufferView::horizScrollOffset() const
2913 return d->horiz_scroll_offset_;
2917 CursorSlice const & BufferView::currentRowSlice() const
2919 return d->current_row_slice_;
2923 CursorSlice const & BufferView::lastRowSlice() const
2925 return d->last_row_slice_;
2929 void BufferView::setCurrentRowSlice(CursorSlice const & rowSlice)
2931 // nothing to do if the cursor was already on this row
2932 if (d->current_row_slice_ == rowSlice) {
2933 d->last_row_slice_ = CursorSlice();
2937 // if the (previous) current row was scrolled, we have to
2938 // remember it in order to repaint it next time.
2939 if (d->horiz_scroll_offset_ != 0)
2940 d->last_row_slice_ = d->current_row_slice_;
2942 d->last_row_slice_ = CursorSlice();
2944 // Since we changed row, the scroll offset is not valid anymore
2945 d->horiz_scroll_offset_ = 0;
2946 d->current_row_slice_ = rowSlice;
2950 void BufferView::checkCursorScrollOffset(PainterInfo & pi)
2952 CursorSlice rowSlice = d->cursor_.bottom();
2953 TextMetrics const & tm = textMetrics(rowSlice.text());
2955 // Stop if metrics have not been computed yet, since it means
2956 // that there is nothing to do.
2957 if (!tm.contains(rowSlice.pit()))
2959 ParagraphMetrics const & pm = tm.parMetrics(rowSlice.pit());
2960 Row const & row = pm.getRow(rowSlice.pos(),
2961 d->cursor_.boundary() && rowSlice == d->cursor_.top());
2962 rowSlice.pos() = row.pos();
2964 // Set the row on which the cursor lives.
2965 setCurrentRowSlice(rowSlice);
2967 // If insets referred to by cursor are not all in the cache, the positions
2968 // need to be recomputed.
2969 if (!d->cursor_.inCoordCache()) {
2970 /** FIXME: the code below adds an extraneous computation of
2971 * inset positions, and can therefore be bad for performance
2972 * (think for example about a very large tabular inset.
2973 * Redawing the row where it is means redrawing the whole
2976 * The bug that this fixes is the following: assume that there
2977 * is a very large math inset. Upon entering the inset, when
2978 * pressing `End', the row is not scrolled and the cursor is
2979 * not visible. The extra row computation makes sure that the
2980 * inset positions are correctly computed and set in the
2981 * cache. This would not happen if we did not have two-stage
2984 * A proper fix would be to always have proper inset positions
2987 // Force the recomputation of inset positions
2988 bool const drawing = pi.pain.isDrawingEnabled();
2989 pi.pain.setDrawingEnabled(false);
2990 // No need to care about vertical position.
2991 RowPainter rp(pi, buffer().text(), d->cursor_.bottom().pit(), row,
2992 -d->horiz_scroll_offset_, 0);
2994 pi.pain.setDrawingEnabled(drawing);
2997 // Current x position of the cursor in pixels
2998 int cur_x = getPos(d->cursor_).x_;
3000 // Horizontal scroll offset of the cursor row in pixels
3001 int offset = d->horiz_scroll_offset_;
3002 int const MARGIN = 2 * theFontMetrics(d->cursor_.real_current_font).em()
3004 if (row.right_x() <= workWidth() - row.right_margin) {
3005 // Row is narrower than the work area, no offset needed.
3008 if (cur_x - offset < MARGIN) {
3009 // cursor would be too far right
3010 offset = cur_x - MARGIN;
3011 } else if (cur_x - offset > workWidth() - MARGIN) {
3012 // cursor would be too far left
3013 offset = cur_x - workWidth() + MARGIN;
3015 // Correct the offset to make sure that we do not scroll too much
3018 if (row.right_x() - offset < workWidth() - row.right_margin)
3019 offset = row.right_x() - workWidth() + row.right_margin;
3022 //lyxerr << "cur_x=" << cur_x << ", offset=" << offset << ", row.wid=" << row.width() << ", margin=" << MARGIN << endl;
3024 if (offset != d->horiz_scroll_offset_)
3025 LYXERR(Debug::PAINTING, "Horiz. scroll offset changed from "
3026 << d->horiz_scroll_offset_ << " to " << offset);
3028 if (d->update_strategy_ == NoScreenUpdate
3029 && (offset != d->horiz_scroll_offset_
3030 || !d->last_row_slice_.empty())) {
3031 // FIXME: if one uses SingleParUpdate, then home/end
3032 // will not work on long rows. Why?
3033 d->update_strategy_ = FullScreenUpdate;
3036 d->horiz_scroll_offset_ = offset;
3040 void BufferView::draw(frontend::Painter & pain)
3042 if (height_ == 0 || width_ == 0)
3044 LYXERR(Debug::PAINTING, "\t\t*** START DRAWING ***");
3046 Text & text = buffer_.text();
3047 TextMetrics const & tm = d->text_metrics_[&text];
3048 int const y = tm.first().second->position();
3049 PainterInfo pi(this, pain);
3051 // Check whether the row where the cursor lives needs to be scrolled.
3052 // Update the drawing strategy if needed.
3053 checkCursorScrollOffset(pi);
3055 switch (d->update_strategy_) {
3057 case NoScreenUpdate:
3058 // If no screen painting is actually needed, only some the different
3059 // coordinates of insets and paragraphs needs to be updated.
3060 LYXERR(Debug::PAINTING, "Strategy: NoScreenUpdate");
3061 pi.full_repaint = true;
3062 pi.pain.setDrawingEnabled(false);
3066 case SingleParUpdate:
3067 pi.full_repaint = false;
3068 LYXERR(Debug::PAINTING, "Strategy: SingleParUpdate");
3069 // In general, only the current row of the outermost paragraph
3070 // will be redrawn. Particular cases where selection spans
3071 // multiple paragraph are correctly detected in TextMetrics.
3075 case DecorationUpdate:
3076 // FIXME: We should also distinguish DecorationUpdate to avoid text
3077 // drawing if possible. This is not possible to do easily right now
3078 // because of the single backing pixmap.
3080 case FullScreenUpdate:
3082 LYXERR(Debug::PAINTING,
3083 ((d->update_strategy_ == FullScreenUpdate)
3084 ? "Strategy: FullScreenUpdate"
3085 : "Strategy: DecorationUpdate"));
3087 // The whole screen, including insets, will be refreshed.
3088 pi.full_repaint = true;
3090 // Clear background.
3091 pain.fillRectangle(0, 0, width_, height_,
3092 pi.backgroundColor(&buffer_.inset()));
3097 // and possibly grey out below
3098 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3099 int const y2 = lastpm.second->position() + lastpm.second->descent();
3102 Color color = buffer().isInternal()
3103 ? Color_background : Color_bottomarea;
3104 pain.fillRectangle(0, y2, width_, height_ - y2, color);
3108 LYXERR(Debug::PAINTING, "\n\t\t*** END DRAWING ***");
3110 // The scrollbar needs an update.
3113 // Normalize anchor for next time
3114 pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
3115 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3116 for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
3117 ParagraphMetrics const & pm = tm.parMetrics(pit);
3118 if (pm.position() + pm.descent() > 0) {
3119 d->anchor_pit_ = pit;
3120 d->anchor_ypos_ = pm.position();
3124 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
3125 << " anchor ypos = " << d->anchor_ypos_);
3129 void BufferView::message(docstring const & msg)
3132 d->gui_->message(msg);
3136 void BufferView::showDialog(string const & name)
3139 d->gui_->showDialog(name, string());
3143 void BufferView::showDialog(string const & name,
3144 string const & data, Inset * inset)
3147 d->gui_->showDialog(name, data, inset);
3151 void BufferView::updateDialog(string const & name, string const & data)
3154 d->gui_->updateDialog(name, data);
3158 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
3164 // FIXME: Move this out of BufferView again
3165 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
3167 if (!fname.isReadableFile()) {
3168 docstring const error = from_ascii(strerror(errno));
3169 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3170 docstring const text =
3171 bformat(_("Could not read the specified document\n"
3172 "%1$s\ndue to the error: %2$s"), file, error);
3173 Alert::error(_("Could not read file"), text);
3177 if (!fname.isReadableFile()) {
3178 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3179 docstring const text =
3180 bformat(_("%1$s\n is not readable."), file);
3181 Alert::error(_("Could not open file"), text);
3185 // FIXME UNICODE: We don't know the encoding of the file
3186 docstring file_content = fname.fileContents("UTF-8");
3187 if (file_content.empty()) {
3188 Alert::error(_("Reading not UTF-8 encoded file"),
3189 _("The file is not UTF-8 encoded.\n"
3190 "It will be read as local 8Bit-encoded.\n"
3191 "If this does not give the correct result\n"
3192 "then please change the encoding of the file\n"
3193 "to UTF-8 with a program other than LyX.\n"));
3194 file_content = fname.fileContents("local8bit");
3197 return normalize_c(file_content);
3201 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
3203 docstring const tmpstr = contentsOfPlaintextFile(f);
3208 Cursor & cur = cursor();
3209 cap::replaceSelection(cur);
3210 buffer_.undo().recordUndo(cur);
3212 cur.innerText()->insertStringAsParagraphs(cur, tmpstr, cur.current_font);
3214 cur.innerText()->insertStringAsLines(cur, tmpstr, cur.current_font);
3216 buffer_.changed(true);
3220 docstring const & BufferView::inlineCompletion() const
3222 return d->inlineCompletion_;
3226 size_t const & BufferView::inlineCompletionUniqueChars() const
3228 return d->inlineCompletionUniqueChars_;
3232 DocIterator const & BufferView::inlineCompletionPos() const
3234 return d->inlineCompletionPos_;
3238 void BufferView::resetInlineCompletionPos()
3240 d->inlineCompletionPos_ = DocIterator();
3244 bool samePar(DocIterator const & a, DocIterator const & b)
3246 if (a.empty() && b.empty())
3248 if (a.empty() || b.empty())
3250 if (a.depth() != b.depth())
3252 return &a.innerParagraph() == &b.innerParagraph();
3256 void BufferView::setInlineCompletion(Cursor const & cur, DocIterator const & pos,
3257 docstring const & completion, size_t uniqueChars)
3259 uniqueChars = min(completion.size(), uniqueChars);
3260 bool changed = d->inlineCompletion_ != completion
3261 || d->inlineCompletionUniqueChars_ != uniqueChars;
3262 bool singlePar = true;
3263 d->inlineCompletion_ = completion;
3264 d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
3266 //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
3269 DocIterator const & old = d->inlineCompletionPos_;
3271 //lyxerr << "inlineCompletionPos changed" << std::endl;
3272 // old or pos are in another paragraph?
3273 if ((!samePar(cur, pos) && !pos.empty())
3274 || (!samePar(cur, old) && !old.empty())) {
3276 //lyxerr << "different paragraph" << std::endl;
3278 d->inlineCompletionPos_ = pos;
3283 if (singlePar && !(cur.result().screenUpdate() & Update::Force))
3284 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
3286 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::Force);
3291 bool BufferView::clickableInset() const
3293 return d->clickable_inset_;