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)
241 ScrollbarParameters scrollbarParameters_;
243 ScreenUpdateStrategy update_strategy_;
245 CoordCache coord_cache_;
247 /// Estimated average par height for scrollbar.
249 /// this is used to handle XSelection events in the right manner.
258 pit_type anchor_pit_;
262 vector<int> par_height_;
265 DocIterator inlineCompletionPos_;
267 docstring inlineCompletion_;
269 size_t inlineCompletionUniqueChars_;
271 /// keyboard mapping object.
274 /// last visited inset.
275 /** kept to send setMouseHover(false).
276 * Not owned, so don't delete.
278 Inset const * last_inset_;
279 /// are we hovering something that we can click
280 bool clickable_inset_;
282 /// position of the mouse at the time of the last mouse move
283 /// This is used to update the hovering status of inset in
284 /// cases where the buffer is scrolled, but the mouse didn't move.
285 Point mouse_position_cache_;
287 // cache for id of the paragraph which was edited the last time
288 int bookmark_edit_position_;
290 mutable TextMetricsCache text_metrics_;
293 /** Not owned, so don't delete.
295 frontend::GuiBufferViewDelegate * gui_;
297 /// Cache for Find Next
298 FuncRequest search_request_cache_;
301 map<string, Inset *> edited_insets_;
303 /// When the row where the cursor lies is scrolled, this
304 /// contains the scroll offset
305 int horiz_scroll_offset_;
306 /// a slice pointing to the start of the row where the cursor
307 /// is (at last draw time)
308 CursorSlice current_row_slice_;
309 /// a slice pointing to the start of the row where cursor was
310 /// at previous draw event
311 CursorSlice last_row_slice_;
315 BufferView::BufferView(Buffer & buf)
316 : width_(0), height_(0), full_screen_(false), buffer_(buf),
317 d(new Private(*this))
319 d->xsel_cache_.set = false;
320 d->intl_.initKeyMapper(lyxrc.use_kbmap);
322 d->cursor_.setBuffer(&buf);
323 d->cursor_.push(buffer_.inset());
324 d->cursor_.resetAnchor();
325 d->cursor_.setCurrentFont();
327 buffer_.updatePreviews();
331 BufferView::~BufferView()
333 // current buffer is going to be switched-off, save cursor pos
334 // Ideally, the whole cursor stack should be saved, but session
335 // currently can only handle bottom (whole document) level pit and pos.
336 // That is to say, if a cursor is in a nested inset, it will be
337 // restore to the left of the top level inset.
338 LastFilePosSection::FilePos fp;
339 fp.pit = d->cursor_.bottom().pit();
340 fp.pos = d->cursor_.bottom().pos();
341 theSession().lastFilePos().save(buffer_.fileName(), fp);
344 d->last_inset_->setMouseHover(this, false);
350 int BufferView::rightMargin() const
352 // The additional test for the case the outliner is opened.
354 !lyxrc.full_screen_limit ||
355 width_ < lyxrc.full_screen_width + 20)
358 return (width_ - lyxrc.full_screen_width) / 2;
362 int BufferView::leftMargin() const
364 return rightMargin();
368 bool BufferView::isTopScreen() const
370 return d->scrollbarParameters_.position == d->scrollbarParameters_.min;
374 bool BufferView::isBottomScreen() const
376 return d->scrollbarParameters_.position == d->scrollbarParameters_.max;
380 Intl & BufferView::getIntl()
386 Intl const & BufferView::getIntl() const
392 CoordCache & BufferView::coordCache()
394 return d->coord_cache_;
398 CoordCache const & BufferView::coordCache() const
400 return d->coord_cache_;
404 Buffer & BufferView::buffer()
410 Buffer const & BufferView::buffer() const
416 bool BufferView::fitCursor()
418 if (cursorStatus(d->cursor_) == CUR_INSIDE) {
419 frontend::FontMetrics const & fm =
420 theFontMetrics(d->cursor_.getFont().fontInfo());
421 int const asc = fm.maxAscent();
422 int const des = fm.maxDescent();
423 Point const p = getPos(d->cursor_);
424 if (p.y_ - asc >= 0 && p.y_ + des < height_)
431 void BufferView::processUpdateFlags(Update::flags flags)
433 // This is close to a hot-path.
434 LYXERR(Debug::DEBUG, "BufferView::processUpdateFlags()"
435 << "[fitcursor = " << (flags & Update::FitCursor)
436 << ", forceupdate = " << (flags & Update::Force)
437 << ", singlepar = " << (flags & Update::SinglePar)
438 << "] buffer: " << &buffer_);
440 // FIXME Does this really need doing here? It's done in updateBuffer, and
441 // if the Buffer doesn't need updating, then do the macros?
442 buffer_.updateMacros();
444 // Now do the first drawing step if needed. This consists on updating
445 // the CoordCache in updateMetrics().
446 // The second drawing step is done in WorkArea::redraw() if needed.
448 // Case when no explicit update is requested.
450 // no need to redraw anything.
451 d->update_strategy_ = NoScreenUpdate;
455 if (flags == Update::Decoration) {
456 d->update_strategy_ = DecorationUpdate;
457 buffer_.changed(false);
461 if (flags == Update::FitCursor
462 || flags == (Update::Decoration | Update::FitCursor)) {
463 // tell the frontend to update the screen if needed.
468 if (flags & Update::Decoration) {
469 d->update_strategy_ = DecorationUpdate;
470 buffer_.changed(false);
473 // no screen update is needed in principle, but this
474 // could change if cursor row needs scrolling.
475 d->update_strategy_ = NoScreenUpdate;
476 buffer_.changed(false);
480 bool const full_metrics = flags & Update::Force || !singleParUpdate();
483 // We have to update the full screen metrics.
486 if (!(flags & Update::FitCursor)) {
487 // Nothing to do anymore. Trigger a redraw and return
488 buffer_.changed(false);
492 // updateMetrics() does not update paragraph position
493 // This is done at draw() time. So we need a redraw!
494 buffer_.changed(false);
497 // The cursor is off screen so ensure it is visible.
502 updateHoveredInset();
506 void BufferView::updateScrollbar()
508 if (height_ == 0 && width_ == 0)
511 // We prefer fixed size line scrolling.
512 d->scrollbarParameters_.single_step = defaultRowHeight();
513 // We prefer full screen page scrolling.
514 d->scrollbarParameters_.page_step = height_;
516 Text & t = buffer_.text();
517 TextMetrics & tm = d->text_metrics_[&t];
519 LYXERR(Debug::GUI, " Updating scrollbar: height: "
520 << t.paragraphs().size()
521 << " curr par: " << d->cursor_.bottom().pit()
522 << " default height " << defaultRowHeight());
524 size_t const parsize = t.paragraphs().size();
525 if (d->par_height_.size() != parsize) {
526 d->par_height_.clear();
527 // FIXME: We assume a default paragraph height of 2 rows. This
528 // should probably be pondered with the screen width.
529 d->par_height_.resize(parsize, defaultRowHeight() * 2);
532 // Look at paragraph heights on-screen
533 pair<pit_type, ParagraphMetrics const *> first = tm.first();
534 pair<pit_type, ParagraphMetrics const *> last = tm.last();
535 for (pit_type pit = first.first; pit <= last.first; ++pit) {
536 d->par_height_[pit] = tm.parMetrics(pit).height();
537 LYXERR(Debug::SCROLLING, "storing height for pit " << pit << " : "
538 << d->par_height_[pit]);
541 int top_pos = first.second->position() - first.second->ascent();
542 int bottom_pos = last.second->position() + last.second->descent();
543 bool first_visible = first.first == 0 && top_pos >= 0;
544 bool last_visible = last.first + 1 == int(parsize) && bottom_pos <= height_;
545 if (first_visible && last_visible) {
546 d->scrollbarParameters_.min = 0;
547 d->scrollbarParameters_.max = 0;
551 d->scrollbarParameters_.min = top_pos;
552 for (size_t i = 0; i != size_t(first.first); ++i)
553 d->scrollbarParameters_.min -= d->par_height_[i];
554 d->scrollbarParameters_.max = bottom_pos;
555 for (size_t i = last.first + 1; i != parsize; ++i)
556 d->scrollbarParameters_.max += d->par_height_[i];
558 d->scrollbarParameters_.position = 0;
559 // The reference is the top position so we remove one page.
560 if (lyxrc.scroll_below_document)
561 d->scrollbarParameters_.max -= minVisiblePart();
563 d->scrollbarParameters_.max -= d->scrollbarParameters_.page_step;
567 ScrollbarParameters const & BufferView::scrollbarParameters() const
569 return d->scrollbarParameters_;
573 docstring BufferView::toolTip(int x, int y) const
575 // Get inset under mouse, if there is one.
576 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
578 // No inset, no tooltip...
580 return covering_inset->toolTip(*this, x, y);
584 string BufferView::contextMenu(int x, int y) const
586 //If there is a selection, return the containing inset menu
587 if (d->cursor_.selection())
588 return d->cursor_.inset().contextMenu(*this, x, y);
590 // Get inset under mouse, if there is one.
591 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
593 return covering_inset->contextMenu(*this, x, y);
595 return buffer_.inset().contextMenu(*this, x, y);
599 void BufferView::scrollDocView(int value, bool update)
601 int const offset = value - d->scrollbarParameters_.position;
603 // No scrolling at all? No need to redraw anything
607 // If the offset is less than 2 screen height, prefer to scroll instead.
608 if (abs(offset) <= 2 * height_) {
609 d->anchor_ypos_ -= offset;
610 buffer_.changed(true);
611 updateHoveredInset();
615 // cut off at the top
616 if (value <= d->scrollbarParameters_.min) {
617 DocIterator dit = doc_iterator_begin(&buffer_);
618 showCursor(dit, false, update);
619 LYXERR(Debug::SCROLLING, "scroll to top");
623 // cut off at the bottom
624 if (value >= d->scrollbarParameters_.max) {
625 DocIterator dit = doc_iterator_end(&buffer_);
627 showCursor(dit, false, update);
628 LYXERR(Debug::SCROLLING, "scroll to bottom");
632 // find paragraph at target position
633 int par_pos = d->scrollbarParameters_.min;
635 for (; i != int(d->par_height_.size()); ++i) {
636 par_pos += d->par_height_[i];
637 if (par_pos >= value)
641 if (par_pos < value) {
642 // It seems we didn't find the correct pit so stay on the safe side and
644 LYXERR0("scrolling position not found!");
645 scrollDocView(d->scrollbarParameters_.max, update);
649 DocIterator dit = doc_iterator_begin(&buffer_);
651 LYXERR(Debug::SCROLLING, "value = " << value << " -> scroll to pit " << i);
652 showCursor(dit, false, update);
656 // FIXME: this method is not working well.
657 void BufferView::setCursorFromScrollbar()
659 TextMetrics & tm = d->text_metrics_[&buffer_.text()];
661 int const height = 2 * defaultRowHeight();
662 int const first = height;
663 int const last = height_ - height;
665 Cursor const & oldcur = d->cursor_;
667 switch (cursorStatus(oldcur)) {
675 int const y = getPos(oldcur).y_;
676 newy = min(last, max(y, first));
680 // We reset the cursor because cursorStatus() does not
681 // work when the cursor is within mathed.
684 tm.setCursorFromCoordinates(cur, 0, newy);
686 // update the bufferview cursor and notify insets
687 // FIXME: Care about the d->cursor_ flags to redraw if needed
688 Cursor old = d->cursor_;
690 // the DEPM call in mouseSetCursor() might have destroyed the
691 // paragraph the cursor is in.
692 bool badcursor = old.fixIfBroken();
693 badcursor |= notifyCursorLeavesOrEnters(old, d->cursor_);
695 d->cursor_.fixIfBroken();
699 Change const BufferView::getCurrentChange() const
701 if (!d->cursor_.selection())
702 return Change(Change::UNCHANGED);
704 DocIterator dit = d->cursor_.selectionBegin();
705 // The selected content might have been changed (see #7685)
706 while (dit.inMathed())
707 // Find enclosing text cursor
709 return dit.paragraph().lookupChange(dit.pos());
713 // this could be used elsewhere as well?
714 // FIXME: This does not work within mathed!
715 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
717 Point const p = getPos(dit);
720 if (p.y_ > workHeight())
726 void BufferView::bookmarkEditPosition()
728 // Don't eat cpu time for each keystroke
729 if (d->cursor_.paragraph().id() == d->bookmark_edit_position_)
732 d->bookmark_edit_position_ = d->cursor_.paragraph().id();
736 void BufferView::saveBookmark(unsigned int idx)
738 // tentatively save bookmark, id and pos will be used to
739 // acturately locate a bookmark in a 'live' lyx session.
740 // pit and pos will be updated with bottom level pit/pos
742 if (!buffer_.isInternal()) {
743 theSession().bookmarks().save(
745 d->cursor_.bottom().pit(),
746 d->cursor_.bottom().pos(),
747 d->cursor_.paragraph().id(),
752 // emit message signal.
753 message(_("Save bookmark"));
758 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
759 int top_id, pos_type top_pos)
761 bool success = false;
764 d->cursor_.clearSelection();
766 // if a valid par_id is given, try it first
767 // This is the case for a 'live' bookmark when unique paragraph ID
768 // is used to track bookmarks.
770 dit = buffer_.getParFromID(top_id);
772 dit.pos() = min(dit.paragraph().size(), top_pos);
773 // Some slices of the iterator may not be
774 // reachable (e.g. closed collapsable inset)
775 // so the dociterator may need to be
776 // shortened. Otherwise, setCursor may crash
777 // lyx when the cursor can not be set to these
779 size_t const n = dit.depth();
780 for (size_t i = 0; i < n; ++i)
781 if (!dit[i].inset().editable()) {
789 // if top_id == 0, or searching through top_id failed
790 // This is the case for a 'restored' bookmark when only bottom
791 // (document level) pit was saved. Because of this, bookmark
792 // restoration is inaccurate. If a bookmark was within an inset,
793 // it will be restored to the left of the outmost inset that contains
795 if (bottom_pit < int(buffer_.paragraphs().size())) {
796 dit = doc_iterator_begin(&buffer_);
798 dit.pit() = bottom_pit;
799 dit.pos() = min(bottom_pos, dit.paragraph().size());
804 // Note: only bottom (document) level pit is set.
806 // set the current font.
807 d->cursor_.setCurrentFont();
808 // To center the screen on this new position we need the
809 // paragraph position which is computed at draw() time.
810 // So we need a redraw!
811 buffer_.changed(false);
820 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
822 if (d->cursor_.real_current_font.isRightToLeft()) {
823 if (d->intl_.keymap == Intl::PRIMARY)
824 d->intl_.keyMapSec();
826 if (d->intl_.keymap == Intl::SECONDARY)
827 d->intl_.keyMapPrim();
830 d->intl_.getTransManager().translateAndInsert(c, t, cur);
834 int BufferView::workWidth() const
840 void BufferView::recenter()
842 showCursor(d->cursor_, true, true);
846 void BufferView::showCursor()
848 showCursor(d->cursor_, false, true);
852 void BufferView::showCursor(DocIterator const & dit,
853 bool recenter, bool update)
855 if (scrollToCursor(dit, recenter) && update) {
856 buffer_.changed(true);
857 updateHoveredInset();
862 void BufferView::scrollToCursor()
864 if (scrollToCursor(d->cursor_, false)) {
865 buffer_.changed(true);
866 updateHoveredInset();
871 bool BufferView::scrollToCursor(DocIterator const & dit, bool recenter)
873 // We are not properly started yet, delay until resizing is
878 LYXERR(Debug::SCROLLING, "recentering!");
880 CursorSlice const & bot = dit.bottom();
881 TextMetrics & tm = d->text_metrics_[bot.text()];
883 pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
884 int bot_pit = bot.pit();
885 if (bot_pit > max_pit) {
886 // FIXME: Why does this happen?
887 LYXERR0("bottom pit is greater that max pit: "
888 << bot_pit << " > " << max_pit);
892 if (bot_pit == tm.first().first - 1)
893 tm.newParMetricsUp();
894 else if (bot_pit == tm.last().first + 1)
895 tm.newParMetricsDown();
897 if (tm.contains(bot_pit)) {
898 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
899 LBUFERR(!pm.rows().empty());
900 // FIXME: smooth scrolling doesn't work in mathed.
901 CursorSlice const & cs = dit.innerTextSlice();
902 int offset = coordOffset(dit).y_;
903 int ypos = pm.position() + offset;
904 Dimension const & row_dim =
905 pm.getRow(cs.pos(), dit.boundary()).dimension();
908 scrolled = scroll(ypos - height_/2);
910 // We try to visualize the whole row, if the row height is larger than
911 // the screen height, we scroll to a heuristic value of height_ / 4.
912 // FIXME: This heuristic value should be replaced by a recursive search
913 // for a row in the inset that can be visualized completely.
914 else if (row_dim.height() > height_) {
915 if (ypos < defaultRowHeight())
916 scrolled = scroll(ypos - height_ / 4);
917 else if (ypos > height_ - defaultRowHeight())
918 scrolled = scroll(ypos - 3 * height_ / 4);
921 // If the top part of the row falls of the screen, we scroll
922 // up to align the top of the row with the top of the screen.
923 else if (ypos - row_dim.ascent() < 0 && ypos < height_) {
924 int ynew = row_dim.ascent();
925 scrolled = scrollUp(ynew - ypos);
928 // If the bottom of the row falls of the screen, we scroll down.
929 else if (ypos + row_dim.descent() > height_ && ypos > 0) {
930 int ynew = height_ - row_dim.descent();
931 scrolled = scrollDown(ypos - ynew);
934 // else, nothing to do, the cursor is already visible so we just return.
935 return scrolled != 0;
938 // fix inline completion position
939 if (d->inlineCompletionPos_.fixIfBroken())
940 d->inlineCompletionPos_ = DocIterator();
942 tm.redoParagraph(bot_pit);
943 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
944 int offset = coordOffset(dit).y_;
946 d->anchor_pit_ = bot_pit;
947 CursorSlice const & cs = dit.innerTextSlice();
948 Dimension const & row_dim =
949 pm.getRow(cs.pos(), dit.boundary()).dimension();
952 d->anchor_ypos_ = height_/2;
953 else if (d->anchor_pit_ == 0)
954 d->anchor_ypos_ = offset + pm.ascent();
955 else if (d->anchor_pit_ == max_pit)
956 d->anchor_ypos_ = height_ - offset - row_dim.descent();
957 else if (offset > height_)
958 d->anchor_ypos_ = height_ - offset - defaultRowHeight();
960 d->anchor_ypos_ = defaultRowHeight() * 2;
966 void BufferView::makeDocumentClass()
968 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
969 buffer_.params().makeDocumentClass();
970 updateDocumentClass(olddc);
974 void BufferView::updateDocumentClass(DocumentClassConstPtr olddc)
976 message(_("Converting document to new document class..."));
978 StableDocIterator backcur(d->cursor_);
979 ErrorList & el = buffer_.errorList("Class Switch");
980 cap::switchBetweenClasses(
981 olddc, buffer_.params().documentClassPtr(),
982 static_cast<InsetText &>(buffer_.inset()), el);
984 setCursor(backcur.asDocIterator(&buffer_));
986 buffer_.errors("Class Switch");
990 /** Return the change status at cursor position, taking in account the
991 * status at each level of the document iterator (a table in a deleted
992 * footnote is deleted).
993 * When \param outer is true, the top slice is not looked at.
995 static Change::Type lookupChangeType(DocIterator const & dit, bool outer = false)
997 size_t const depth = dit.depth() - (outer ? 1 : 0);
999 for (size_t i = 0 ; i < depth ; ++i) {
1000 CursorSlice const & slice = dit[i];
1001 if (!slice.inset().inMathed()
1002 && slice.pos() < slice.paragraph().size()) {
1003 Change::Type const ch = slice.paragraph().lookupChange(slice.pos()).type;
1004 if (ch != Change::UNCHANGED)
1008 return Change::UNCHANGED;
1012 bool BufferView::getStatus(FuncRequest const & cmd, FuncStatus & flag)
1014 FuncCode const act = cmd.action();
1016 // Can we use a readonly buffer?
1017 if (buffer_.isReadonly()
1018 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1019 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1020 flag.message(from_utf8(N_("Document is read-only")));
1021 flag.setEnabled(false);
1025 // Are we in a DELETED change-tracking region?
1026 if (lookupChangeType(d->cursor_, true) == Change::DELETED
1027 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1028 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1029 flag.message(from_utf8(N_("This portion of the document is deleted.")));
1030 flag.setEnabled(false);
1034 Cursor & cur = d->cursor_;
1036 if (cur.getStatus(cmd, flag))
1041 // FIXME: This is a bit problematic because we don't check if this is
1042 // a document BufferView or not for these LFUNs. We probably have to
1043 // dispatch both to currentBufferView() and, if that fails,
1044 // to documentBufferView(); same as we do now for current Buffer and
1045 // document Buffer. Ideally those LFUN should go to Buffer as they
1046 // operate on the full Buffer and the cursor is only needed either for
1047 // an Undo record or to restore a cursor position. But we don't know
1048 // how to do that inside Buffer of course.
1049 case LFUN_BUFFER_PARAMS_APPLY:
1050 case LFUN_LAYOUT_MODULES_CLEAR:
1051 case LFUN_LAYOUT_MODULE_ADD:
1052 case LFUN_LAYOUT_RELOAD:
1053 case LFUN_TEXTCLASS_APPLY:
1054 case LFUN_TEXTCLASS_LOAD:
1055 flag.setEnabled(!buffer_.isReadonly());
1059 // We do not use the LyXAction flag for readonly because Undo sets the
1060 // buffer clean/dirty status by itself.
1061 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasUndoStack());
1064 // We do not use the LyXAction flag for readonly because Redo sets the
1065 // buffer clean/dirty status by itself.
1066 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasRedoStack());
1068 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
1069 case LFUN_FILE_INSERT_PLAINTEXT: {
1070 docstring const fname = cmd.argument();
1071 if (!FileName::isAbsolute(to_utf8(fname))) {
1072 flag.message(_("Absolute filename expected."));
1075 flag.setEnabled(cur.inTexted());
1078 case LFUN_FILE_INSERT:
1079 case LFUN_BOOKMARK_SAVE:
1080 // FIXME: Actually, these LFUNS should be moved to Text
1081 flag.setEnabled(cur.inTexted());
1084 case LFUN_FONT_STATE:
1085 case LFUN_LABEL_INSERT:
1086 case LFUN_INFO_INSERT:
1087 case LFUN_PARAGRAPH_GOTO:
1088 case LFUN_NOTE_NEXT:
1089 case LFUN_REFERENCE_NEXT:
1090 case LFUN_WORD_FIND:
1091 case LFUN_WORD_FIND_FORWARD:
1092 case LFUN_WORD_FIND_BACKWARD:
1093 case LFUN_WORD_REPLACE:
1096 case LFUN_MARK_TOGGLE:
1097 case LFUN_SCREEN_RECENTER:
1098 case LFUN_SCREEN_SHOW_CURSOR:
1099 case LFUN_BIBTEX_DATABASE_ADD:
1100 case LFUN_BIBTEX_DATABASE_DEL:
1101 case LFUN_STATISTICS:
1102 case LFUN_KEYMAP_OFF:
1103 case LFUN_KEYMAP_PRIMARY:
1104 case LFUN_KEYMAP_SECONDARY:
1105 case LFUN_KEYMAP_TOGGLE:
1106 case LFUN_INSET_SELECT_ALL:
1107 flag.setEnabled(true);
1110 case LFUN_WORD_FINDADV: {
1111 FindAndReplaceOptions opt;
1112 istringstream iss(to_utf8(cmd.argument()));
1114 flag.setEnabled(opt.repl_buf_name.empty()
1115 || !buffer_.isReadonly());
1119 case LFUN_LABEL_GOTO:
1120 flag.setEnabled(!cmd.argument().empty()
1121 || getInsetByCode<InsetRef>(cur, REF_CODE));
1124 case LFUN_CHANGES_TRACK:
1125 flag.setEnabled(true);
1126 flag.setOnOff(buffer_.params().track_changes);
1129 case LFUN_CHANGES_OUTPUT:
1130 flag.setEnabled(true);
1131 flag.setOnOff(buffer_.params().output_changes);
1134 case LFUN_CHANGES_MERGE:
1135 case LFUN_CHANGE_NEXT:
1136 case LFUN_CHANGE_PREVIOUS:
1137 case LFUN_ALL_CHANGES_ACCEPT:
1138 case LFUN_ALL_CHANGES_REJECT:
1139 // TODO: context-sensitive enabling of LFUNs
1140 // In principle, these command should only be enabled if there
1141 // is a change in the document. However, without proper
1142 // optimizations, this will inevitably result in poor performance.
1143 flag.setEnabled(true);
1146 case LFUN_BUFFER_TOGGLE_COMPRESSION: {
1147 flag.setOnOff(buffer_.params().compressed);
1151 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC: {
1152 flag.setOnOff(buffer_.params().output_sync);
1156 case LFUN_SCREEN_UP:
1157 case LFUN_SCREEN_DOWN:
1159 case LFUN_SCREEN_UP_SELECT:
1160 case LFUN_SCREEN_DOWN_SELECT:
1161 case LFUN_INSET_FORALL:
1162 flag.setEnabled(true);
1165 case LFUN_LAYOUT_TABULAR:
1166 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
1170 flag.setEnabled(!cur.inset().forcePlainLayout(cur.idx()));
1173 case LFUN_LAYOUT_PARAGRAPH:
1174 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
1177 case LFUN_BRANCH_ADD_INSERT:
1178 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1181 case LFUN_DIALOG_SHOW_NEW_INSET:
1182 // FIXME: this is wrong, but I do not understand the
1184 if (cur.inset().lyxCode() == CAPTION_CODE)
1185 return cur.inset().getStatus(cur, cmd, flag);
1186 // FIXME we should consider passthru paragraphs too.
1187 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1190 case LFUN_CITATION_INSERT: {
1191 FuncRequest fr(LFUN_INSET_INSERT, "citation");
1192 // FIXME: This could turn in a recursive hell.
1193 // Shouldn't we use Buffer::getStatus() instead?
1194 flag.setEnabled(lyx::getStatus(fr).enabled());
1197 case LFUN_INSET_APPLY: {
1198 string const name = cmd.getArg(0);
1199 Inset * inset = editedInset(name);
1201 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1202 if (!inset->getStatus(cur, fr, flag)) {
1203 // Every inset is supposed to handle this
1204 LASSERT(false, break);
1207 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1208 flag = lyx::getStatus(fr);
1221 Inset * BufferView::editedInset(string const & name) const
1223 map<string, Inset *>::const_iterator it = d->edited_insets_.find(name);
1224 return it == d->edited_insets_.end() ? 0 : it->second;
1228 void BufferView::editInset(string const & name, Inset * inset)
1230 d->edited_insets_[name] = inset;
1234 void BufferView::dispatch(FuncRequest const & cmd, DispatchResult & dr)
1236 LYXERR(Debug::ACTION, "BufferView::dispatch: cmd: " << cmd);
1238 string const argument = to_utf8(cmd.argument());
1239 Cursor & cur = d->cursor_;
1241 // Don't dispatch function that does not apply to internal buffers.
1242 if (buffer_.isInternal()
1243 && lyxaction.funcHasFlag(cmd.action(), LyXAction::NoInternal))
1246 // We'll set this back to false if need be.
1247 bool dispatched = true;
1248 buffer_.undo().beginUndoGroup();
1250 FuncCode const act = cmd.action();
1253 case LFUN_BUFFER_PARAMS_APPLY: {
1254 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1255 cur.recordUndoBufferParams();
1256 istringstream ss(to_utf8(cmd.argument()));
1259 int const unknown_tokens = buffer_.readHeader(lex);
1260 if (unknown_tokens != 0) {
1261 LYXERR0("Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1262 << unknown_tokens << " unknown token"
1263 << (unknown_tokens == 1 ? "" : "s"));
1265 updateDocumentClass(olddc);
1267 // We are most certainly here because of a change in the document
1268 // It is then better to make sure that all dialogs are in sync with
1269 // current document settings.
1270 dr.screenUpdate(Update::Force | Update::FitCursor);
1271 dr.forceBufferUpdate();
1275 case LFUN_LAYOUT_MODULES_CLEAR: {
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().clearLayoutModules();
1281 makeDocumentClass();
1282 dr.screenUpdate(Update::Force);
1283 dr.forceBufferUpdate();
1287 case LFUN_LAYOUT_MODULE_ADD: {
1288 BufferParams const & params = buffer_.params();
1289 if (!params.layoutModuleCanBeAdded(argument)) {
1290 LYXERR0("Module `" << argument <<
1291 "' cannot be added due to failed requirements or "
1292 "conflicts with installed modules.");
1295 // FIXME: this modifies the document in cap::switchBetweenClasses
1296 // without calling recordUndo. Fix this before using
1297 // recordUndoBufferParams().
1298 cur.recordUndoFullBuffer();
1299 buffer_.params().addLayoutModule(argument);
1300 makeDocumentClass();
1301 dr.screenUpdate(Update::Force);
1302 dr.forceBufferUpdate();
1306 case LFUN_TEXTCLASS_APPLY: {
1307 // since this shortcircuits, the second call is made only if
1309 bool const success =
1310 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1311 LayoutFileList::get().load(argument, buffer_.filePath());
1313 docstring s = bformat(_("The document class `%1$s' "
1314 "could not be loaded."), from_utf8(argument));
1315 frontend::Alert::error(_("Could not load class"), s);
1319 LayoutFile const * old_layout = buffer_.params().baseClass();
1320 LayoutFile const * new_layout = &(LayoutFileList::get()[argument]);
1322 if (old_layout == new_layout)
1326 // Save the old, possibly modular, layout for use in conversion.
1327 // FIXME: this modifies the document in cap::switchBetweenClasses
1328 // without calling recordUndo. Fix this before using
1329 // recordUndoBufferParams().
1330 cur.recordUndoFullBuffer();
1331 buffer_.params().setBaseClass(argument);
1332 makeDocumentClass();
1333 dr.screenUpdate(Update::Force);
1334 dr.forceBufferUpdate();
1338 case LFUN_TEXTCLASS_LOAD: {
1339 // since this shortcircuits, the second call is made only if
1341 bool const success =
1342 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1343 LayoutFileList::get().load(argument, buffer_.filePath());
1345 docstring s = bformat(_("The document class `%1$s' "
1346 "could not be loaded."), from_utf8(argument));
1347 frontend::Alert::error(_("Could not load class"), s);
1352 case LFUN_LAYOUT_RELOAD: {
1353 LayoutFileIndex bc = buffer_.params().baseClassID();
1354 LayoutFileList::get().reset(bc);
1355 buffer_.params().setBaseClass(bc);
1356 makeDocumentClass();
1357 dr.screenUpdate(Update::Force);
1358 dr.forceBufferUpdate();
1363 dr.setMessage(_("Undo"));
1364 cur.clearSelection();
1365 if (!cur.textUndo())
1366 dr.setMessage(_("No further undo information"));
1368 dr.screenUpdate(Update::Force | Update::FitCursor);
1369 dr.forceBufferUpdate();
1373 dr.setMessage(_("Redo"));
1374 cur.clearSelection();
1375 if (!cur.textRedo())
1376 dr.setMessage(_("No further redo information"));
1378 dr.screenUpdate(Update::Force | Update::FitCursor);
1379 dr.forceBufferUpdate();
1382 case LFUN_FONT_STATE:
1383 dr.setMessage(cur.currentState());
1386 case LFUN_BOOKMARK_SAVE:
1387 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1390 case LFUN_LABEL_GOTO: {
1391 docstring label = cmd.argument();
1392 if (label.empty()) {
1394 getInsetByCode<InsetRef>(cur, REF_CODE);
1396 label = inset->getParam("reference");
1397 // persistent=false: use temp_bookmark
1401 if (!label.empty()) {
1403 // at the moment, this is redundant, since gotoLabel will
1404 // eventually call LFUN_PARAGRAPH_GOTO, but it seems best
1406 dr.screenUpdate(Update::Force | Update::FitCursor);
1411 case LFUN_PARAGRAPH_GOTO: {
1412 int const id = convert<int>(cmd.getArg(0));
1413 int const pos = convert<int>(cmd.getArg(1));
1415 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1416 b = theBufferList().next(b)) {
1418 DocIterator dit = b->getParFromID(id);
1420 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1424 LYXERR(Debug::INFO, "Paragraph " << dit.paragraph().id()
1425 << " found in buffer `"
1426 << b->absFileName() << "'.");
1428 if (b == &buffer_) {
1432 dr.screenUpdate(Update::Force | Update::FitCursor);
1434 // Switch to other buffer view and resend cmd
1435 lyx::dispatch(FuncRequest(
1436 LFUN_BUFFER_SWITCH, b->absFileName()));
1444 case LFUN_NOTE_NEXT:
1445 gotoInset(this, NOTE_CODE, false);
1448 case LFUN_REFERENCE_NEXT: {
1449 vector<InsetCode> tmp;
1450 tmp.push_back(LABEL_CODE);
1451 tmp.push_back(REF_CODE);
1452 gotoInset(this, tmp, true);
1456 case LFUN_CHANGES_TRACK:
1457 buffer_.params().track_changes = !buffer_.params().track_changes;
1460 case LFUN_CHANGES_OUTPUT:
1461 buffer_.params().output_changes = !buffer_.params().output_changes;
1462 if (buffer_.params().output_changes) {
1463 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1464 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1465 LaTeXFeatures::isAvailable("xcolor");
1467 if (!dvipost && !xcolorulem) {
1468 Alert::warning(_("Changes not shown in LaTeX output"),
1469 _("Changes will not be highlighted in LaTeX output, "
1470 "because neither dvipost nor xcolor/ulem are installed.\n"
1471 "Please install these packages or redefine "
1472 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1473 } else if (!xcolorulem) {
1474 Alert::warning(_("Changes not shown in LaTeX output"),
1475 _("Changes will not be highlighted in LaTeX output "
1476 "when using pdflatex, because xcolor and ulem are not installed.\n"
1477 "Please install both packages or redefine "
1478 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1483 case LFUN_CHANGE_NEXT:
1484 findNextChange(this);
1485 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1486 dr.screenUpdate(Update::Force | Update::FitCursor);
1489 case LFUN_CHANGE_PREVIOUS:
1490 findPreviousChange(this);
1491 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1492 dr.screenUpdate(Update::Force | Update::FitCursor);
1495 case LFUN_CHANGES_MERGE:
1496 if (findNextChange(this) || findPreviousChange(this)) {
1497 dr.screenUpdate(Update::Force | Update::FitCursor);
1498 dr.forceBufferUpdate();
1499 showDialog("changes");
1503 case LFUN_ALL_CHANGES_ACCEPT:
1504 // select complete document
1506 cur.selHandle(true);
1507 buffer_.text().cursorBottom(cur);
1508 // accept everything in a single step to support atomic undo
1509 buffer_.text().acceptOrRejectChanges(cur, Text::ACCEPT);
1511 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1512 dr.screenUpdate(Update::Force | Update::FitCursor);
1513 dr.forceBufferUpdate();
1516 case LFUN_ALL_CHANGES_REJECT:
1517 // select complete document
1519 cur.selHandle(true);
1520 buffer_.text().cursorBottom(cur);
1521 // reject everything in a single step to support atomic undo
1522 // Note: reject does not work recursively; the user may have to repeat the operation
1523 buffer_.text().acceptOrRejectChanges(cur, Text::REJECT);
1525 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1526 dr.screenUpdate(Update::Force | Update::FitCursor);
1527 dr.forceBufferUpdate();
1530 case LFUN_WORD_FIND_FORWARD:
1531 case LFUN_WORD_FIND_BACKWARD: {
1533 // Would it maybe be better if this variable were view specific anyway?
1534 static docstring last_search;
1535 docstring searched_string;
1537 if (!cmd.argument().empty()) {
1538 last_search = cmd.argument();
1539 searched_string = cmd.argument();
1541 searched_string = last_search;
1544 if (searched_string.empty())
1547 bool const fw = act == LFUN_WORD_FIND_FORWARD;
1548 docstring const data =
1549 find2string(searched_string, true, false, fw);
1550 bool found = lyxfind(this, FuncRequest(LFUN_WORD_FIND, data));
1552 dr.screenUpdate(Update::Force | Update::FitCursor);
1562 case LFUN_WORD_FIND: {
1563 FuncRequest req = cmd;
1564 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1565 req = d->search_request_cache_;
1566 if (req.argument().empty()) {
1567 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, "findreplace"));
1570 if (lyxfind(this, req)) {
1571 dr.screenUpdate(Update::Force | Update::FitCursor);
1578 d->search_request_cache_ = req;
1582 case LFUN_WORD_REPLACE: {
1583 bool has_deleted = false;
1584 if (cur.selection()) {
1585 DocIterator beg = cur.selectionBegin();
1586 DocIterator end = cur.selectionEnd();
1587 if (beg.pit() == end.pit()) {
1588 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1589 if (!cur.inMathed() && cur.paragraph().isDeleted(p)) {
1596 if (lyxreplace(this, cmd, has_deleted)) {
1597 dr.forceBufferUpdate();
1598 dr.screenUpdate(Update::Force | Update::FitCursor);
1608 case LFUN_WORD_FINDADV: {
1609 FindAndReplaceOptions opt;
1610 istringstream iss(to_utf8(cmd.argument()));
1612 if (findAdv(this, opt)) {
1613 dr.screenUpdate(Update::Force | Update::FitCursor);
1624 cur.clearSelection();
1625 dr.setMessage(from_utf8(N_("Mark off")));
1629 cur.clearSelection();
1631 dr.setMessage(from_utf8(N_("Mark on")));
1634 case LFUN_MARK_TOGGLE:
1635 cur.setSelection(false);
1638 dr.setMessage(from_utf8(N_("Mark removed")));
1641 dr.setMessage(from_utf8(N_("Mark set")));
1646 case LFUN_SCREEN_SHOW_CURSOR:
1650 case LFUN_SCREEN_RECENTER:
1654 case LFUN_BIBTEX_DATABASE_ADD: {
1655 Cursor tmpcur = cur;
1656 findInset(tmpcur, BIBTEX_CODE, false);
1657 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1660 if (inset->addDatabase(cmd.argument())) {
1661 buffer_.invalidateBibfileCache();
1662 dr.forceBufferUpdate();
1668 case LFUN_BIBTEX_DATABASE_DEL: {
1669 Cursor tmpcur = cur;
1670 findInset(tmpcur, BIBTEX_CODE, false);
1671 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1674 if (inset->delDatabase(cmd.argument())) {
1675 buffer_.invalidateBibfileCache();
1676 dr.forceBufferUpdate();
1682 case LFUN_STATISTICS: {
1683 DocIterator from, to;
1684 if (cur.selection()) {
1685 from = cur.selectionBegin();
1686 to = cur.selectionEnd();
1688 from = doc_iterator_begin(&buffer_);
1689 to = doc_iterator_end(&buffer_);
1691 buffer_.updateStatistics(from, to);
1692 int const words = buffer_.wordCount();
1693 int const chars = buffer_.charCount(false);
1694 int const chars_blanks = buffer_.charCount(true);
1696 if (cur.selection())
1697 message = _("Statistics for the selection:");
1699 message = _("Statistics for the document:");
1702 message += bformat(_("%1$d words"), words);
1704 message += _("One word");
1706 if (chars_blanks != 1)
1707 message += bformat(_("%1$d characters (including blanks)"),
1710 message += _("One character (including blanks)");
1713 message += bformat(_("%1$d characters (excluding blanks)"),
1716 message += _("One character (excluding blanks)");
1718 Alert::information(_("Statistics"), message);
1722 case LFUN_BUFFER_TOGGLE_COMPRESSION:
1723 // turn compression on/off
1724 buffer_.params().compressed = !buffer_.params().compressed;
1727 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
1728 buffer_.params().output_sync = !buffer_.params().output_sync;
1731 case LFUN_SCREEN_UP:
1732 case LFUN_SCREEN_DOWN: {
1733 Point p = getPos(cur);
1734 // This code has been commented out to enable to scroll down a
1735 // document, even if there are large insets in it (see bug #5465).
1736 /*if (p.y_ < 0 || p.y_ > height_) {
1737 // The cursor is off-screen so recenter before proceeding.
1741 int const scrolled = scroll(act == LFUN_SCREEN_UP
1742 ? -height_ : height_);
1743 if (act == LFUN_SCREEN_UP && scrolled > -height_)
1745 if (act == LFUN_SCREEN_DOWN && scrolled < height_)
1746 p = Point(width_, height_);
1748 bool const in_texted = cur.inTexted();
1749 cur.setCursor(doc_iterator_begin(cur.buffer()));
1750 cur.selHandle(false);
1751 buffer_.changed(true);
1752 updateHoveredInset();
1754 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_,
1755 true, act == LFUN_SCREEN_UP);
1756 //FIXME: what to do with cur.x_target()?
1757 bool update = in_texted && cur.bv().checkDepm(cur, old);
1760 if (update || cur.mark())
1761 dr.screenUpdate(Update::Force | Update::FitCursor);
1763 dr.forceBufferUpdate();
1768 string const scroll_type = cmd.getArg(0);
1769 int scroll_step = 0;
1770 if (scroll_type == "line")
1771 scroll_step = d->scrollbarParameters_.single_step;
1772 else if (scroll_type == "page")
1773 scroll_step = d->scrollbarParameters_.page_step;
1776 string const scroll_quantity = cmd.getArg(1);
1777 if (scroll_quantity == "up")
1778 scrollUp(scroll_step);
1779 else if (scroll_quantity == "down")
1780 scrollDown(scroll_step);
1782 int const scroll_value = convert<int>(scroll_quantity);
1784 scroll(scroll_step * scroll_value);
1786 buffer_.changed(true);
1787 updateHoveredInset();
1788 dr.forceBufferUpdate();
1792 case LFUN_SCREEN_UP_SELECT: {
1793 // FIXME: why is the algorithm different from LFUN_SCREEN_UP?
1794 cur.selHandle(true);
1795 if (isTopScreen()) {
1796 lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1800 int y = getPos(cur).y_;
1801 int const ymin = y - height_ + defaultRowHeight();
1802 while (y > ymin && cur.up())
1806 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1810 case LFUN_SCREEN_DOWN_SELECT: {
1811 // FIXME: why is the algorithm different from LFUN_SCREEN_DOWN?
1812 cur.selHandle(true);
1813 if (isBottomScreen()) {
1814 lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1818 int y = getPos(cur).y_;
1819 int const ymax = y + height_ - defaultRowHeight();
1820 while (y < ymax && cur.down())
1824 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1829 case LFUN_INSET_SELECT_ALL:
1831 && cur.selBegin().at_begin()
1832 && cur.selEnd().at_end()) {
1833 // All the contents of the inset if selected.
1834 // Select the inset from outside.
1837 cur.setSelection(true);
1839 } else if (cur.selBegin().idx() != cur.selEnd().idx()
1841 && cur.selBegin().at_cell_begin()
1842 && cur.selEnd().at_cell_end())) {
1843 // At least one complete cell is selected.
1848 cur.setSelection(true);
1849 cur.idx() = cur.lastidx();
1850 cur.pos() = cur.lastpos();
1852 // select current cell
1856 cur.setSelection(true);
1857 cur.pit() = cur.lastpit();
1858 cur.pos() = cur.lastpos();
1860 dr.screenUpdate(Update::Force);
1864 // This would be in Buffer class if only Cursor did not
1865 // require a bufferview
1866 case LFUN_INSET_FORALL: {
1867 docstring const name = from_utf8(cmd.getArg(0));
1868 string const commandstr = cmd.getLongArg(1);
1869 FuncRequest const fr = lyxaction.lookupFunc(commandstr);
1871 // an arbitrary number to limit number of iterations
1872 const int max_iter = 100000;
1874 Cursor & cur = d->cursor_;
1875 Cursor const savecur = cur;
1877 if (!cur.nextInset())
1879 cur.beginUndoGroup();
1880 while(cur && iterations < max_iter) {
1881 Inset * const ins = cur.nextInset();
1884 docstring insname = ins->layoutName();
1885 while (!insname.empty()) {
1886 if (insname == name || name == from_utf8("*")) {
1888 lyx::dispatch(fr, dr);
1892 size_t const i = insname.rfind(':');
1893 if (i == string::npos)
1895 insname = insname.substr(0, i);
1897 // if we did not delete the inset, skip it
1898 if (!cur.nextInset() || cur.nextInset() == ins)
1904 dr.screenUpdate(Update::Force);
1905 dr.forceBufferUpdate();
1907 if (iterations >= max_iter) {
1909 dr.setMessage(bformat(_("`inset-forall' interrupted because number of actions is larger than %1$d"), max_iter));
1911 dr.setMessage(bformat(_("Applied \"%1$s\" to %2$d insets"), from_utf8(commandstr), iterations));
1916 case LFUN_BRANCH_ADD_INSERT: {
1917 docstring branch_name = from_utf8(cmd.getArg(0));
1918 if (branch_name.empty())
1919 if (!Alert::askForText(branch_name, _("Branch name")) ||
1920 branch_name.empty())
1923 DispatchResult drtmp;
1924 buffer_.dispatch(FuncRequest(LFUN_BRANCH_ADD, branch_name), drtmp);
1925 if (drtmp.error()) {
1926 Alert::warning(_("Branch already exists"), drtmp.message());
1929 BranchList & branch_list = buffer_.params().branchlist();
1930 vector<docstring> const branches =
1931 getVectorFromString(branch_name, branch_list.separator());
1932 for (vector<docstring>::const_iterator it = branches.begin();
1933 it != branches.end(); ++it) {
1935 lyx::dispatch(FuncRequest(LFUN_BRANCH_INSERT, branch_name));
1940 case LFUN_KEYMAP_OFF:
1941 getIntl().keyMapOn(false);
1944 case LFUN_KEYMAP_PRIMARY:
1945 getIntl().keyMapPrim();
1948 case LFUN_KEYMAP_SECONDARY:
1949 getIntl().keyMapSec();
1952 case LFUN_KEYMAP_TOGGLE:
1953 getIntl().toggleKeyMap();
1956 case LFUN_DIALOG_SHOW_NEW_INSET: {
1957 string const name = cmd.getArg(0);
1958 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
1959 if (decodeInsetParam(name, data, buffer_))
1960 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
1962 lyxerr << "Inset type '" << name <<
1963 "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" << endl;
1967 case LFUN_CITATION_INSERT: {
1968 if (argument.empty()) {
1969 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
1972 // we can have one optional argument, delimited by '|'
1973 // citation-insert <key>|<text_before>
1974 // this should be enhanced to also support text_after
1975 // and citation style
1976 string arg = argument;
1978 if (contains(argument, "|")) {
1979 arg = token(argument, '|', 0);
1980 opt1 = token(argument, '|', 1);
1983 // if our cursor is directly in front of or behind a citation inset,
1984 // we will instead add the new key to it.
1985 Inset * inset = cur.nextInset();
1986 if (!inset || inset->lyxCode() != CITE_CODE)
1987 inset = cur.prevInset();
1988 if (inset && inset->lyxCode() == CITE_CODE) {
1989 InsetCitation * icite = static_cast<InsetCitation *>(inset);
1990 if (icite->addKey(arg)) {
1991 dr.forceBufferUpdate();
1992 dr.screenUpdate(Update::FitCursor | Update::SinglePar);
1994 LYXERR0("Discarding optional argument to citation-insert.");
1999 InsetCommandParams icp(CITE_CODE);
2000 icp["key"] = from_utf8(arg);
2002 icp["before"] = from_utf8(opt1);
2003 string icstr = InsetCommand::params2string(icp);
2004 FuncRequest fr(LFUN_INSET_INSERT, icstr);
2009 case LFUN_INSET_APPLY: {
2010 string const name = cmd.getArg(0);
2011 Inset * inset = editedInset(name);
2013 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
2017 // put cursor in front of inset.
2018 if (!setCursorFromInset(inset)) {
2019 LASSERT(false, break);
2022 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
2023 inset->dispatch(cur, fr);
2024 dr.screenUpdate(cur.result().screenUpdate());
2025 if (cur.result().needBufferUpdate())
2026 dr.forceBufferUpdate();
2031 // The change of language of buffer belongs to the Buffer class.
2032 // We have to do it here because we need a cursor for Undo.
2033 // When Undo::recordUndoBufferParams() is implemented someday
2034 // LFUN_BUFFER_LANGUAGE should be handled by the Buffer class.
2035 case LFUN_BUFFER_LANGUAGE: {
2036 Language const * oldL = buffer_.params().language;
2037 Language const * newL = languages.getLanguage(argument);
2038 if (!newL || oldL == newL)
2040 if (oldL->rightToLeft() == newL->rightToLeft()) {
2041 cur.recordUndoFullBuffer();
2042 buffer_.changeLanguage(oldL, newL);
2043 cur.setCurrentFont();
2044 dr.forceBufferUpdate();
2049 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
2050 case LFUN_FILE_INSERT_PLAINTEXT: {
2051 bool const as_paragraph = (act == LFUN_FILE_INSERT_PLAINTEXT_PARA);
2052 string const fname = to_utf8(cmd.argument());
2053 if (!FileName::isAbsolute(fname))
2054 dr.setMessage(_("Absolute filename expected."));
2056 insertPlaintextFile(FileName(fname), as_paragraph);
2061 // OK, so try the Buffer itself...
2062 buffer_.dispatch(cmd, dr);
2063 dispatched = dr.dispatched();
2067 buffer_.undo().endUndoGroup();
2068 dr.dispatched(dispatched);
2072 docstring const BufferView::requestSelection()
2074 Cursor & cur = d->cursor_;
2076 LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
2077 if (!cur.selection()) {
2078 d->xsel_cache_.set = false;
2082 LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
2083 if (!d->xsel_cache_.set ||
2084 cur.top() != d->xsel_cache_.cursor ||
2085 cur.realAnchor().top() != d->xsel_cache_.anchor)
2087 d->xsel_cache_.cursor = cur.top();
2088 d->xsel_cache_.anchor = cur.realAnchor().top();
2089 d->xsel_cache_.set = cur.selection();
2090 return cur.selectionAsString(false);
2096 void BufferView::clearSelection()
2098 d->cursor_.clearSelection();
2099 // Clear the selection buffer. Otherwise a subsequent
2100 // middle-mouse-button paste would use the selection buffer,
2101 // not the more current external selection.
2102 cap::clearSelection();
2103 d->xsel_cache_.set = false;
2104 // The buffer did not really change, but this causes the
2105 // redraw we need because we cleared the selection above.
2106 buffer_.changed(false);
2110 void BufferView::resize(int width, int height)
2112 // Update from work area
2116 // Clear the paragraph height cache.
2117 d->par_height_.clear();
2118 // Redo the metrics.
2123 Inset const * BufferView::getCoveringInset(Text const & text,
2126 TextMetrics & tm = d->text_metrics_[&text];
2127 Inset * inset = tm.checkInsetHit(x, y);
2131 if (!inset->descendable(*this))
2132 // No need to go further down if the inset is not
2136 size_t cell_number = inset->nargs();
2137 // Check all the inner cell.
2138 for (size_t i = 0; i != cell_number; ++i) {
2139 Text const * inner_text = inset->getText(i);
2142 Inset const * inset_deeper =
2143 getCoveringInset(*inner_text, x, y);
2145 return inset_deeper;
2153 void BufferView::updateHoveredInset() const
2155 // Get inset under mouse, if there is one.
2156 int const x = d->mouse_position_cache_.x_;
2157 int const y = d->mouse_position_cache_.y_;
2158 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
2160 d->clickable_inset_ = covering_inset && covering_inset->clickable(x, y);
2162 if (covering_inset == d->last_inset_)
2163 // Same inset, no need to do anything...
2166 bool need_redraw = false;
2167 if (d->last_inset_) {
2168 // Remove the hint on the last hovered inset (if any).
2169 need_redraw |= d->last_inset_->setMouseHover(this, false);
2173 if (covering_inset && covering_inset->setMouseHover(this, true)) {
2175 // Only the insets that accept the hover state, do
2176 // clear the last_inset_, so only set the last_inset_
2177 // member if the hovered setting is accepted.
2178 d->last_inset_ = covering_inset;
2182 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
2183 << d->mouse_position_cache_.x_ << ", "
2184 << d->mouse_position_cache_.y_ << ")");
2186 d->update_strategy_ = DecorationUpdate;
2188 // This event (moving without mouse click) is not passed further.
2189 // This should be changed if it is further utilized.
2190 buffer_.changed(false);
2195 void BufferView::clearLastInset(Inset * inset) const
2197 if (d->last_inset_ != inset) {
2198 LYXERR0("Wrong last_inset!");
2205 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
2207 //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
2209 // This is only called for mouse related events including
2210 // LFUN_FILE_OPEN generated by drag-and-drop.
2211 FuncRequest cmd = cmd0;
2213 Cursor old = cursor();
2215 cur.push(buffer_.inset());
2216 cur.setSelection(d->cursor_.selection());
2218 // Either the inset under the cursor or the
2219 // surrounding Text will handle this event.
2221 // make sure we stay within the screen...
2222 cmd.set_y(min(max(cmd.y(), -1), height_));
2224 d->mouse_position_cache_.x_ = cmd.x();
2225 d->mouse_position_cache_.y_ = cmd.y();
2227 if (cmd.action() == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
2228 updateHoveredInset();
2232 // Build temporary cursor.
2233 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x(), cmd.y());
2235 // Put anchor at the same position.
2238 cur.beginUndoGroup();
2240 // Try to dispatch to an non-editable inset near this position
2241 // via the temp cursor. If the inset wishes to change the real
2242 // cursor it has to do so explicitly by using
2243 // cur.bv().cursor() = cur; (or similar)
2245 inset->dispatch(cur, cmd);
2247 // Now dispatch to the temporary cursor. If the real cursor should
2248 // be modified, the inset's dispatch has to do so explicitly.
2249 if (!inset || !cur.result().dispatched())
2254 // Notify left insets
2256 bool badcursor = old.fixIfBroken() | cur.fixIfBroken();
2257 badcursor |= notifyCursorLeavesOrEnters(old, cur);
2259 cursor().fixIfBroken();
2262 // Do we have a selection?
2263 theSelection().haveSelection(cursor().selection());
2265 if (cur.needBufferUpdate()) {
2266 cur.clearBufferUpdate();
2267 buffer().updateBuffer();
2270 // If the command has been dispatched,
2271 if (cur.result().dispatched() || cur.result().screenUpdate())
2272 processUpdateFlags(cur.result().screenUpdate());
2276 int BufferView::minVisiblePart()
2278 return 2 * defaultRowHeight();
2282 int BufferView::scroll(int y)
2285 return scrollDown(y);
2287 return scrollUp(-y);
2292 int BufferView::scrollDown(int offset)
2294 Text * text = &buffer_.text();
2295 TextMetrics & tm = d->text_metrics_[text];
2296 int const ymax = height_ + offset;
2298 pair<pit_type, ParagraphMetrics const *> last = tm.last();
2299 int bottom_pos = last.second->position() + last.second->descent();
2300 if (lyxrc.scroll_below_document)
2301 bottom_pos += height_ - minVisiblePart();
2302 if (last.first + 1 == int(text->paragraphs().size())) {
2303 if (bottom_pos <= height_)
2305 offset = min(offset, bottom_pos - height_);
2308 if (bottom_pos > ymax)
2310 tm.newParMetricsDown();
2312 d->anchor_ypos_ -= offset;
2317 int BufferView::scrollUp(int offset)
2319 Text * text = &buffer_.text();
2320 TextMetrics & tm = d->text_metrics_[text];
2321 int ymin = - offset;
2323 pair<pit_type, ParagraphMetrics const *> first = tm.first();
2324 int top_pos = first.second->position() - first.second->ascent();
2325 if (first.first == 0) {
2328 offset = min(offset, - top_pos);
2333 tm.newParMetricsUp();
2335 d->anchor_ypos_ += offset;
2340 void BufferView::setCursorFromRow(int row)
2344 pit_type newpit = 0;
2345 pos_type newpos = 0;
2347 buffer_.texrow().getIdFromRow(row, tmpid, tmppos);
2349 bool posvalid = (tmpid != -1);
2351 // we need to make sure that the row and position
2352 // we got back are valid, because the buffer may well
2353 // have changed since we last generated the LaTeX.
2354 DocIterator dit = buffer_.getParFromID(tmpid);
2355 if (dit == doc_iterator_end(&buffer_))
2357 else if (dit.depth() > 1) {
2358 // We are in an inset.
2359 pos_type lastpos = dit.lastpos();
2360 dit.pos() = tmppos > lastpos ? lastpos : tmppos;
2366 // now have to check pos.
2368 Paragraph const & par = buffer_.text().getPar(newpit);
2369 if (newpos > par.size()) {
2370 LYXERR0("Requested position no longer valid.");
2371 newpos = par.size() - 1;
2376 frontend::Alert::error(_("Inverse Search Failed"),
2377 _("Invalid position requested by inverse search.\n"
2378 "You need to update the viewed document."));
2382 buffer_.text().setCursor(d->cursor_, newpit, newpos);
2383 d->cursor_.setSelection(false);
2384 d->cursor_.resetAnchor();
2389 bool BufferView::setCursorFromInset(Inset const * inset)
2391 // are we already there?
2392 if (cursor().nextInset() == inset)
2395 // Inset is not at cursor position. Find it in the document.
2398 while (cur && cur.nextInset() != inset)
2409 void BufferView::gotoLabel(docstring const & label)
2411 ListOfBuffers bufs = buffer().allRelatives();
2412 ListOfBuffers::iterator it = bufs.begin();
2413 for (; it != bufs.end(); ++it) {
2414 Buffer const * buf = *it;
2417 Toc & toc = buf->tocBackend().toc("label");
2418 TocIterator toc_it = toc.begin();
2419 TocIterator end = toc.end();
2420 for (; toc_it != end; ++toc_it) {
2421 if (label == toc_it->str()) {
2422 lyx::dispatch(toc_it->action());
2430 TextMetrics const & BufferView::textMetrics(Text const * t) const
2432 return const_cast<BufferView *>(this)->textMetrics(t);
2436 TextMetrics & BufferView::textMetrics(Text const * t)
2439 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
2440 if (tmc_it == d->text_metrics_.end()) {
2441 tmc_it = d->text_metrics_.insert(
2442 make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
2444 return tmc_it->second;
2448 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
2451 return textMetrics(t).parMetrics(pit);
2455 int BufferView::workHeight() const
2461 void BufferView::setCursor(DocIterator const & dit)
2464 size_t const n = dit.depth();
2465 for (size_t i = 0; i < n; ++i)
2466 dit[i].inset().edit(d->cursor_, true);
2468 d->cursor_.setCursor(dit);
2469 d->cursor_.setSelection(false);
2471 // It seems on general grounds as if this is probably needed, but
2472 // it is not yet clear.
2473 // See bug #7394 and r38388.
2474 // d->cursor.resetAnchor();
2478 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
2480 // Would be wrong to delete anything if we have a selection.
2481 if (cur.selection())
2484 bool need_anchor_change = false;
2485 bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
2486 need_anchor_change);
2488 if (need_anchor_change)
2496 // we would rather not do this here, but it needs to be done before
2497 // the changed() signal is sent.
2498 buffer_.updateBuffer();
2500 buffer_.changed(true);
2505 bool BufferView::mouseSetCursor(Cursor & cur, bool select)
2507 LASSERT(&cur.bv() == this, return false);
2510 // this event will clear selection so we save selection for
2511 // persistent selection
2512 cap::saveSelection(cursor());
2514 d->cursor_.macroModeClose();
2515 // If a macro has been finalized, the cursor might have been broken
2518 // Has the cursor just left the inset?
2519 bool const leftinset = (&d->cursor_.inset() != &cur.inset());
2521 d->cursor_.fixIfBroken();
2523 // FIXME: shift-mouse selection doesn't work well across insets.
2524 bool const do_selection =
2525 select && &d->cursor_.normalAnchor().inset() == &cur.inset();
2527 // do the dEPM magic if needed
2528 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
2529 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
2530 // the leftinset bool would not be necessary (badcursor instead).
2531 bool update = leftinset;
2532 if (!do_selection && d->cursor_.inTexted())
2533 update |= checkDepm(cur, d->cursor_);
2536 d->cursor_.resetAnchor();
2537 d->cursor_.setCursor(cur);
2538 d->cursor_.boundary(cur.boundary());
2540 d->cursor_.setSelection();
2542 d->cursor_.clearSelection();
2544 d->cursor_.finishUndo();
2545 d->cursor_.setCurrentFont();
2547 cur.forceBufferUpdate();
2552 void BufferView::putSelectionAt(DocIterator const & cur,
2553 int length, bool backwards)
2555 d->cursor_.clearSelection();
2561 d->cursor_.pos() += length;
2562 d->cursor_.setSelection(d->cursor_, -length);
2564 d->cursor_.setSelection(d->cursor_, length);
2569 bool BufferView::selectIfEmpty(DocIterator & cur)
2571 if ((cur.inTexted() && !cur.paragraph().empty())
2572 || (cur.inMathed() && !cur.cell().empty()))
2575 pit_type const beg_pit = cur.pit();
2577 // The paragraph associated to this item isn't
2578 // the first one, so it can be selected
2581 // We have to resort to select the space between the
2582 // end of this item and the begin of the next one
2586 // If it is the only item in the document,
2587 // nothing can be selected
2590 pit_type const end_pit = cur.pit();
2591 pos_type const end_pos = cur.pos();
2592 d->cursor_.clearSelection();
2594 d->cursor_.setCursor(cur);
2595 d->cursor_.pit() = beg_pit;
2596 d->cursor_.pos() = 0;
2597 d->cursor_.setSelection(false);
2598 d->cursor_.resetAnchor();
2599 d->cursor_.pit() = end_pit;
2600 d->cursor_.pos() = end_pos;
2601 d->cursor_.setSelection();
2606 Cursor & BufferView::cursor()
2612 Cursor const & BufferView::cursor() const
2618 pit_type BufferView::anchor_ref() const
2620 return d->anchor_pit_;
2624 bool BufferView::singleParUpdate()
2626 Text & buftext = buffer_.text();
2627 pit_type const bottom_pit = d->cursor_.bottom().pit();
2628 TextMetrics & tm = textMetrics(&buftext);
2629 int old_height = tm.parMetrics(bottom_pit).height();
2631 // make sure inline completion pointer is ok
2632 if (d->inlineCompletionPos_.fixIfBroken())
2633 d->inlineCompletionPos_ = DocIterator();
2635 // In Single Paragraph mode, rebreak only
2636 // the (main text, not inset!) paragraph containing the cursor.
2637 // (if this paragraph contains insets etc., rebreaking will
2638 // recursively descend)
2639 tm.redoParagraph(bottom_pit);
2640 ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
2641 if (pm.height() != old_height)
2642 // Paragraph height has changed so we cannot proceed to
2643 // the singlePar optimisation.
2646 d->update_strategy_ = SingleParUpdate;
2648 LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
2649 << " y2: " << pm.position() + pm.descent()
2650 << " pit: " << bottom_pit
2651 << " singlepar: 1");
2656 void BufferView::updateMetrics()
2658 if (height_ == 0 || width_ == 0)
2661 Text & buftext = buffer_.text();
2662 pit_type const npit = int(buftext.paragraphs().size());
2664 // Clear out the position cache in case of full screen redraw,
2665 d->coord_cache_.clear();
2667 // Clear out paragraph metrics to avoid having invalid metrics
2668 // in the cache from paragraphs not relayouted below
2669 // The complete text metrics will be redone.
2670 d->text_metrics_.clear();
2672 TextMetrics & tm = textMetrics(&buftext);
2674 // make sure inline completion pointer is ok
2675 if (d->inlineCompletionPos_.fixIfBroken())
2676 d->inlineCompletionPos_ = DocIterator();
2678 if (d->anchor_pit_ >= npit)
2679 // The anchor pit must have been deleted...
2680 d->anchor_pit_ = npit - 1;
2682 // Rebreak anchor paragraph.
2683 tm.redoParagraph(d->anchor_pit_);
2684 ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
2687 if (d->anchor_pit_ == 0) {
2688 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
2690 // Complete buffer visible? Then it's easy.
2691 if (scrollRange == 0)
2692 d->anchor_ypos_ = anchor_pm.ascent();
2694 // FIXME: Some clever handling needed to show
2695 // the _first_ paragraph up to the top if the cursor is
2696 // in the first line.
2698 anchor_pm.setPosition(d->anchor_ypos_);
2700 LYXERR(Debug::PAINTING, "metrics: "
2701 << " anchor pit = " << d->anchor_pit_
2702 << " anchor ypos = " << d->anchor_ypos_);
2704 // Redo paragraphs above anchor if necessary.
2705 int y1 = d->anchor_ypos_ - anchor_pm.ascent();
2706 // We are now just above the anchor paragraph.
2707 pit_type pit1 = d->anchor_pit_ - 1;
2708 for (; pit1 >= 0 && y1 >= 0; --pit1) {
2709 tm.redoParagraph(pit1);
2710 ParagraphMetrics & pm = tm.par_metrics_[pit1];
2712 // Save the paragraph position in the cache.
2717 // Redo paragraphs below the anchor if necessary.
2718 int y2 = d->anchor_ypos_ + anchor_pm.descent();
2719 // We are now just below the anchor paragraph.
2720 pit_type pit2 = d->anchor_pit_ + 1;
2721 for (; pit2 < npit && y2 <= height_; ++pit2) {
2722 tm.redoParagraph(pit2);
2723 ParagraphMetrics & pm = tm.par_metrics_[pit2];
2725 // Save the paragraph position in the cache.
2730 LYXERR(Debug::PAINTING, "Metrics: "
2731 << " anchor pit = " << d->anchor_pit_
2732 << " anchor ypos = " << d->anchor_ypos_
2735 << " pit1 = " << pit1
2736 << " pit2 = " << pit2);
2738 d->update_strategy_ = FullScreenUpdate;
2740 if (lyxerr.debugging(Debug::WORKAREA)) {
2741 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
2742 d->coord_cache_.dump();
2747 void BufferView::insertLyXFile(FileName const & fname)
2749 LASSERT(d->cursor_.inTexted(), return);
2751 // Get absolute path of file and add ".lyx"
2752 // to the filename if necessary
2753 FileName filename = fileSearch(string(), fname.absFileName(), "lyx");
2755 docstring const disp_fn = makeDisplayPath(filename.absFileName());
2756 // emit message signal.
2757 message(bformat(_("Inserting document %1$s..."), disp_fn));
2760 Buffer buf(filename.absFileName(), false);
2761 if (buf.loadLyXFile() == Buffer::ReadSuccess) {
2762 ErrorList & el = buffer_.errorList("Parse");
2763 // Copy the inserted document error list into the current buffer one.
2764 el = buf.errorList("Parse");
2765 buffer_.undo().recordUndo(d->cursor_);
2766 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
2767 buf.params().documentClassPtr(), el);
2768 res = _("Document %1$s inserted.");
2770 res = _("Could not insert document %1$s");
2773 buffer_.changed(true);
2774 // emit message signal.
2775 message(bformat(res, disp_fn));
2779 Point BufferView::coordOffset(DocIterator const & dit) const
2785 // Addup contribution of nested insets, from inside to outside,
2786 // keeping the outer paragraph for a special handling below
2787 for (size_t i = dit.depth() - 1; i >= 1; --i) {
2788 CursorSlice const & sl = dit[i];
2792 // get relative position inside sl.inset()
2793 sl.inset().cursorPos(*this, sl, dit.boundary() && (i + 1 == dit.depth()), xx, yy);
2795 // Make relative position inside of the edited inset relative to sl.inset()
2799 // In case of an RTL inset, the edited inset will be positioned to the left
2802 bool boundary_i = dit.boundary() && i + 1 == dit.depth();
2803 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2808 // remember width for the case that sl.inset() is positioned in an RTL inset
2809 if (i && dit[i - 1].text()) {
2810 // If this Inset is inside a Text Inset, retrieve the Dimension
2811 // from the containing text instead of using Inset::dimension() which
2812 // might not be implemented.
2813 // FIXME (Abdel 23/09/2007): this is a bit messy because of the
2814 // elimination of Inset::dim_ cache. This coordOffset() method needs
2815 // to be rewritten in light of the new design.
2816 Dimension const & dim = parMetrics(dit[i - 1].text(),
2817 dit[i - 1].pit()).insetDimension(&sl.inset());
2820 Dimension const dim = sl.inset().dimension(*this);
2824 //lyxerr << "Cursor::getPos, i: "
2825 // << i << " x: " << xx << " y: " << y << endl;
2828 // Add contribution of initial rows of outermost paragraph
2829 CursorSlice const & sl = dit[0];
2830 TextMetrics const & tm = textMetrics(sl.text());
2831 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2833 LBUFERR(!pm.rows().empty());
2834 y -= pm.rows()[0].ascent();
2836 // FIXME: document this mess
2838 if (sl.pos() > 0 && dit.depth() == 1) {
2840 if (pos && dit.boundary())
2842 // lyxerr << "coordOffset: boundary:" << dit.boundary() << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
2843 rend = pm.pos2row(pos);
2845 rend = pm.pos2row(sl.pos());
2847 size_t rend = pm.pos2row(sl.pos());
2849 for (size_t rit = 0; rit != rend; ++rit)
2850 y += pm.rows()[rit].height();
2851 y += pm.rows()[rend].ascent();
2853 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
2855 // Make relative position from the nested inset now bufferview absolute.
2856 int xx = bottom_tm.cursorX(dit.bottom(), dit.boundary() && dit.depth() == 1);
2859 // In the RTL case place the nested inset at the left of the cursor in
2860 // the outer paragraph
2861 bool boundary_1 = dit.boundary() && 1 == dit.depth();
2862 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
2870 Point BufferView::getPos(DocIterator const & dit) const
2872 if (!paragraphVisible(dit))
2873 return Point(-1, -1);
2875 CursorSlice const & bot = dit.bottom();
2876 TextMetrics const & tm = textMetrics(bot.text());
2878 // offset from outer paragraph
2879 Point p = coordOffset(dit);
2880 p.y_ += tm.parMetrics(bot.pit()).position();
2885 bool BufferView::paragraphVisible(DocIterator const & dit) const
2887 CursorSlice const & bot = dit.bottom();
2888 TextMetrics const & tm = textMetrics(bot.text());
2890 return tm.contains(bot.pit());
2894 void BufferView::cursorPosAndHeight(Point & p, int & h) const
2896 Cursor const & cur = cursor();
2897 Font const font = cur.getFont();
2898 frontend::FontMetrics const & fm = theFontMetrics(font);
2899 int const asc = fm.maxAscent();
2900 int const des = fm.maxDescent();
2907 bool BufferView::cursorInView(Point const & p, int h) const
2909 Cursor const & cur = cursor();
2910 // does the cursor touch the screen ?
2911 if (p.y_ + h < 0 || p.y_ >= workHeight() || !paragraphVisible(cur))
2917 int BufferView::horizScrollOffset() const
2919 return d->horiz_scroll_offset_;
2923 CursorSlice const & BufferView::currentRowSlice() const
2925 return d->current_row_slice_;
2929 CursorSlice const & BufferView::lastRowSlice() const
2931 return d->last_row_slice_;
2935 void BufferView::setCurrentRowSlice(CursorSlice const & rowSlice)
2937 // nothing to do if the cursor was already on this row
2938 if (d->current_row_slice_ == rowSlice) {
2939 d->last_row_slice_ = CursorSlice();
2943 // if the (previous) current row was scrolled, we have to
2944 // remember it in order to repaint it next time.
2945 if (d->horiz_scroll_offset_ != 0)
2946 d->last_row_slice_ = d->current_row_slice_;
2948 d->last_row_slice_ = CursorSlice();
2950 // Since we changed row, the scroll offset is not valid anymore
2951 d->horiz_scroll_offset_ = 0;
2952 d->current_row_slice_ = rowSlice;
2956 void BufferView::checkCursorScrollOffset(PainterInfo & pi)
2958 CursorSlice rowSlice = d->cursor_.bottom();
2959 TextMetrics const & tm = textMetrics(rowSlice.text());
2961 // Stop if metrics have not been computed yet, since it means
2962 // that there is nothing to do.
2963 if (!tm.contains(rowSlice.pit()))
2965 ParagraphMetrics const & pm = tm.parMetrics(rowSlice.pit());
2966 Row const & row = pm.getRow(rowSlice.pos(),
2967 d->cursor_.boundary()
2968 && rowSlice == d->cursor_.top());
2969 rowSlice.pos() = row.pos();
2971 // Set the row on which the cursor lives.
2972 setCurrentRowSlice(rowSlice);
2974 /** FIXME: the code below adds an extraneous computation of inset
2975 * positions, and can therefore be bad for performance (think for
2976 * example about a very large tabular inset. Redawing the row
2977 * where it is means redrawing the whole screen).
2979 * The bug that this fixes is the following: assume that there is
2980 * a very large math inset. Upon entering the inset, when pressing
2981 * `End', the row is not scrolled and the cursor is not visible. I
2982 * am not sure why the extra row computation fixes the problem,
2985 * A proper fix should be found and this code should be removed.
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);
2995 /** END of bad code */
2997 // Current x position of the cursor in pixels
2998 int const 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 = Length(2, Length::EM).inPixels(workWidth());
3003 if (cur_x < offset + MARGIN) {
3005 offset = cur_x - MARGIN;
3006 } else if (cur_x > offset + workWidth() - MARGIN) {
3008 offset = cur_x - workWidth() + MARGIN;
3011 if (offset < row.left_margin || row.width() <= workWidth())
3014 if (offset != d->horiz_scroll_offset_)
3015 LYXERR(Debug::PAINTING, "Horiz. scroll offset changed from "
3016 << d->horiz_scroll_offset_ << " to " << offset);
3018 if (d->update_strategy_ == NoScreenUpdate
3019 && (offset != d->horiz_scroll_offset_
3020 || !d->last_row_slice_.empty())) {
3021 // FIXME: if one uses SingleParUpdate, then home/end
3022 // will not work on long rows. Why?
3023 d->update_strategy_ = FullScreenUpdate;
3026 d->horiz_scroll_offset_ = offset;
3030 void BufferView::draw(frontend::Painter & pain)
3032 if (height_ == 0 || width_ == 0)
3034 LYXERR(Debug::PAINTING, "\t\t*** START DRAWING ***");
3036 Text & text = buffer_.text();
3037 TextMetrics const & tm = d->text_metrics_[&text];
3038 int const y = tm.first().second->position();
3039 PainterInfo pi(this, pain);
3041 // Check whether the row where the cursor lives needs to be scrolled.
3042 // Update the drawing strategy if needed.
3043 checkCursorScrollOffset(pi);
3045 switch (d->update_strategy_) {
3047 case NoScreenUpdate:
3048 // If no screen painting is actually needed, only some the different
3049 // coordinates of insets and paragraphs needs to be updated.
3050 LYXERR(Debug::PAINTING, "Strategy: NoScreenUpdate");
3051 pi.full_repaint = true;
3052 pi.pain.setDrawingEnabled(false);
3056 case SingleParUpdate:
3057 pi.full_repaint = false;
3058 LYXERR(Debug::PAINTING, "Strategy: SingleParUpdate");
3059 // In general, only the current row of the outermost paragraph
3060 // will be redrawn. Particular cases where selection spans
3061 // multiple paragraph are correctly detected in TextMetrics.
3065 case DecorationUpdate:
3066 // FIXME: We should also distinguish DecorationUpdate to avoid text
3067 // drawing if possible. This is not possible to do easily right now
3068 // because of the single backing pixmap.
3070 case FullScreenUpdate:
3072 LYXERR(Debug::PAINTING,
3073 ((d->update_strategy_ == FullScreenUpdate)
3074 ? "Strategy: FullScreenUpdate"
3075 : "Strategy: DecorationUpdate"));
3077 // The whole screen, including insets, will be refreshed.
3078 pi.full_repaint = true;
3080 // Clear background.
3081 pain.fillRectangle(0, 0, width_, height_,
3082 pi.backgroundColor(&buffer_.inset()));
3087 // and possibly grey out below
3088 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3089 int const y2 = lastpm.second->position() + lastpm.second->descent();
3092 Color color = buffer().isInternal()
3093 ? Color_background : Color_bottomarea;
3094 pain.fillRectangle(0, y2, width_, height_ - y2, color);
3098 LYXERR(Debug::PAINTING, "\n\t\t*** END DRAWING ***");
3100 // The scrollbar needs an update.
3103 // Normalize anchor for next time
3104 pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
3105 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3106 for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
3107 ParagraphMetrics const & pm = tm.parMetrics(pit);
3108 if (pm.position() + pm.descent() > 0) {
3109 d->anchor_pit_ = pit;
3110 d->anchor_ypos_ = pm.position();
3114 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
3115 << " anchor ypos = " << d->anchor_ypos_);
3119 void BufferView::message(docstring const & msg)
3122 d->gui_->message(msg);
3126 void BufferView::showDialog(string const & name)
3129 d->gui_->showDialog(name, string());
3133 void BufferView::showDialog(string const & name,
3134 string const & data, Inset * inset)
3137 d->gui_->showDialog(name, data, inset);
3141 void BufferView::updateDialog(string const & name, string const & data)
3144 d->gui_->updateDialog(name, data);
3148 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
3154 // FIXME: Move this out of BufferView again
3155 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
3157 if (!fname.isReadableFile()) {
3158 docstring const error = from_ascii(strerror(errno));
3159 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3160 docstring const text =
3161 bformat(_("Could not read the specified document\n"
3162 "%1$s\ndue to the error: %2$s"), file, error);
3163 Alert::error(_("Could not read file"), text);
3167 if (!fname.isReadableFile()) {
3168 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3169 docstring const text =
3170 bformat(_("%1$s\n is not readable."), file);
3171 Alert::error(_("Could not open file"), text);
3175 // FIXME UNICODE: We don't know the encoding of the file
3176 docstring file_content = fname.fileContents("UTF-8");
3177 if (file_content.empty()) {
3178 Alert::error(_("Reading not UTF-8 encoded file"),
3179 _("The file is not UTF-8 encoded.\n"
3180 "It will be read as local 8Bit-encoded.\n"
3181 "If this does not give the correct result\n"
3182 "then please change the encoding of the file\n"
3183 "to UTF-8 with a program other than LyX.\n"));
3184 file_content = fname.fileContents("local8bit");
3187 return normalize_c(file_content);
3191 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
3193 docstring const tmpstr = contentsOfPlaintextFile(f);
3198 Cursor & cur = cursor();
3199 cap::replaceSelection(cur);
3200 buffer_.undo().recordUndo(cur);
3202 cur.innerText()->insertStringAsParagraphs(cur, tmpstr, cur.current_font);
3204 cur.innerText()->insertStringAsLines(cur, tmpstr, cur.current_font);
3206 buffer_.changed(true);
3210 docstring const & BufferView::inlineCompletion() const
3212 return d->inlineCompletion_;
3216 size_t const & BufferView::inlineCompletionUniqueChars() const
3218 return d->inlineCompletionUniqueChars_;
3222 DocIterator const & BufferView::inlineCompletionPos() const
3224 return d->inlineCompletionPos_;
3228 void BufferView::resetInlineCompletionPos()
3230 d->inlineCompletionPos_ = DocIterator();
3234 bool samePar(DocIterator const & a, DocIterator const & b)
3236 if (a.empty() && b.empty())
3238 if (a.empty() || b.empty())
3240 if (a.depth() != b.depth())
3242 return &a.innerParagraph() == &b.innerParagraph();
3246 void BufferView::setInlineCompletion(Cursor const & cur, DocIterator const & pos,
3247 docstring const & completion, size_t uniqueChars)
3249 uniqueChars = min(completion.size(), uniqueChars);
3250 bool changed = d->inlineCompletion_ != completion
3251 || d->inlineCompletionUniqueChars_ != uniqueChars;
3252 bool singlePar = true;
3253 d->inlineCompletion_ = completion;
3254 d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
3256 //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
3259 DocIterator const & old = d->inlineCompletionPos_;
3261 //lyxerr << "inlineCompletionPos changed" << std::endl;
3262 // old or pos are in another paragraph?
3263 if ((!samePar(cur, pos) && !pos.empty())
3264 || (!samePar(cur, old) && !old.empty())) {
3266 //lyxerr << "different paragraph" << std::endl;
3268 d->inlineCompletionPos_ = pos;
3273 if (singlePar && !(cur.result().screenUpdate() & Update::Force))
3274 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
3276 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::Force);
3281 bool BufferView::clickableInset() const
3283 return d->clickable_inset_;