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"
42 #include "MetricsInfo.h"
43 #include "Paragraph.h"
44 #include "paragraph_funcs.h"
45 #include "ParagraphParameters.h"
46 #include "ParIterator.h"
49 #include "TextClass.h"
50 #include "TextMetrics.h"
52 #include "TocBackend.h"
54 #include "WordLangTuple.h"
56 #include "insets/InsetBibtex.h"
57 #include "insets/InsetCommand.h" // ChangeRefs
58 #include "insets/InsetExternal.h"
59 #include "insets/InsetGraphics.h"
60 #include "insets/InsetRef.h"
61 #include "insets/InsetText.h"
62 #include "insets/InsetNote.h"
64 #include "frontends/alert.h"
65 #include "frontends/Application.h"
66 #include "frontends/Delegates.h"
67 #include "frontends/FontMetrics.h"
68 #include "frontends/Painter.h"
69 #include "frontends/Selection.h"
71 #include "graphics/Previews.h"
73 #include "support/convert.h"
74 #include "support/debug.h"
75 #include "support/ExceptionMessage.h"
76 #include "support/filetools.h"
77 #include "support/gettext.h"
78 #include "support/lstrings.h"
79 #include "support/Package.h"
80 #include "support/types.h"
89 using namespace lyx::support;
93 namespace Alert = frontend::Alert;
97 /// Return an inset of this class if it exists at the current cursor position
99 T * getInsetByCode(Cursor const & cur, InsetCode code)
101 DocIterator it = cur;
102 Inset * inset = it.nextInset();
103 if (inset && inset->lyxCode() == code)
104 return static_cast<T*>(inset);
109 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
112 bool findNextInset(DocIterator & dit, vector<InsetCode> const & codes,
113 docstring const & contents)
115 DocIterator tmpdit = dit;
118 Inset const * inset = tmpdit.nextInset();
120 && std::find(codes.begin(), codes.end(), inset->lyxCode()) != codes.end()
121 && (contents.empty() ||
122 static_cast<InsetCommand const *>(inset)->getFirstNonOptParam() == contents)) {
126 tmpdit.forwardInset();
133 /// Looks for next inset with one of the given codes.
134 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
138 DocIterator tmpdit = dit;
139 tmpdit.forwardInset();
144 Inset const * inset = tmpdit.nextInset();
146 && std::find(codes.begin(), codes.end(), inset->lyxCode()) != codes.end()) {
147 contents = static_cast<InsetCommand const *>(inset)->getFirstNonOptParam();
151 if (!findNextInset(tmpdit, codes, contents)) {
152 if (dit.depth() != 1 || dit.pit() != 0 || dit.pos() != 0) {
153 Inset * inset = &tmpdit.bottom().inset();
154 tmpdit = doc_iterator_begin(&inset->buffer(), inset);
155 if (!findNextInset(tmpdit, codes, contents))
167 /// Looks for next inset with the given code
168 void findInset(DocIterator & dit, InsetCode code, bool same_content)
170 findInset(dit, vector<InsetCode>(1, code), same_content);
174 /// Moves cursor to the next inset with one of the given codes.
175 void gotoInset(BufferView * bv, vector<InsetCode> const & codes,
178 Cursor tmpcur = bv->cursor();
179 if (!findInset(tmpcur, codes, same_content)) {
180 bv->cursor().message(_("No more insets"));
184 tmpcur.clearSelection();
185 bv->setCursor(tmpcur);
190 /// Moves cursor to the next inset with given code.
191 void gotoInset(BufferView * bv, InsetCode code, bool same_content)
193 gotoInset(bv, vector<InsetCode>(1, code), same_content);
197 /// A map from a Text to the associated text metrics
198 typedef map<Text const *, TextMetrics> TextMetricsCache;
200 enum ScreenUpdateStrategy {
210 /////////////////////////////////////////////////////////////////////
214 /////////////////////////////////////////////////////////////////////
216 struct BufferView::Private
218 Private(BufferView & bv): wh_(0), cursor_(bv),
219 anchor_pit_(0), anchor_ypos_(0),
220 inlineCompletionUniqueChars_(0),
221 last_inset_(0), bookmark_edit_position_(0), gui_(0)
225 ScrollbarParameters scrollbarParameters_;
227 ScreenUpdateStrategy update_strategy_;
229 CoordCache coord_cache_;
231 /// Estimated average par height for scrollbar.
233 /// this is used to handle XSelection events in the right manner.
242 pit_type anchor_pit_;
246 vector<int> par_height_;
249 DocIterator inlineCompletionPos_;
251 docstring inlineCompletion_;
253 size_t inlineCompletionUniqueChars_;
255 /// keyboard mapping object.
258 /// last visited inset.
259 /** kept to send setMouseHover(false).
260 * Not owned, so don't delete.
264 // cache for id of the paragraph which was edited the last time
265 int bookmark_edit_position_;
267 mutable TextMetricsCache text_metrics_;
270 /** Not owned, so don't delete.
272 frontend::GuiBufferViewDelegate * gui_;
274 /// Cache for Find Next
275 FuncRequest search_request_cache_;
279 BufferView::BufferView(Buffer & buf)
280 : width_(0), height_(0), full_screen_(false), buffer_(buf),
281 d(new Private(*this))
283 d->xsel_cache_.set = false;
284 d->intl_.initKeyMapper(lyxrc.use_kbmap);
286 d->cursor_.setBuffer(&buf);
287 d->cursor_.push(buffer_.inset());
288 d->cursor_.resetAnchor();
289 d->cursor_.setCurrentFont();
291 if (graphics::Previews::status() != LyXRC::PREVIEW_OFF)
292 thePreviews().generateBufferPreviews(buffer_);
296 BufferView::~BufferView()
298 // current buffer is going to be switched-off, save cursor pos
299 // Ideally, the whole cursor stack should be saved, but session
300 // currently can only handle bottom (whole document) level pit and pos.
301 // That is to say, if a cursor is in a nested inset, it will be
302 // restore to the left of the top level inset.
303 LastFilePosSection::FilePos fp;
304 fp.pit = d->cursor_.bottom().pit();
305 fp.pos = d->cursor_.bottom().pos();
306 theSession().lastFilePos().save(buffer_.fileName(), fp);
312 int BufferView::rightMargin() const
314 // The additional test for the case the outliner is opened.
316 !lyxrc.full_screen_limit ||
317 width_ < lyxrc.full_screen_width + 20)
320 return (width_ - lyxrc.full_screen_width) / 2;
324 int BufferView::leftMargin() const
326 return rightMargin();
330 bool BufferView::isTopScreen() const
332 return d->scrollbarParameters_.position == d->scrollbarParameters_.min;
336 bool BufferView::isBottomScreen() const
338 return d->scrollbarParameters_.position == d->scrollbarParameters_.max;
342 Intl & BufferView::getIntl()
348 Intl const & BufferView::getIntl() const
354 CoordCache & BufferView::coordCache()
356 return d->coord_cache_;
360 CoordCache const & BufferView::coordCache() const
362 return d->coord_cache_;
366 Buffer & BufferView::buffer()
372 Buffer const & BufferView::buffer() const
378 bool BufferView::fitCursor()
380 if (cursorStatus(d->cursor_) == CUR_INSIDE) {
381 frontend::FontMetrics const & fm =
382 theFontMetrics(d->cursor_.getFont().fontInfo());
383 int const asc = fm.maxAscent();
384 int const des = fm.maxDescent();
385 Point const p = getPos(d->cursor_, d->cursor_.boundary());
386 if (p.y_ - asc >= 0 && p.y_ + des < height_)
393 void BufferView::processUpdateFlags(Update::flags flags)
395 // last_inset_ points to the last visited inset. This pointer may become
396 // invalid because of keyboard editing. Since all such operations
397 // causes screen update(), I reset last_inset_ to avoid such a problem.
399 // This is close to a hot-path.
400 LYXERR(Debug::DEBUG, "BufferView::processUpdateFlags()"
401 << "[fitcursor = " << (flags & Update::FitCursor)
402 << ", forceupdate = " << (flags & Update::Force)
403 << ", singlepar = " << (flags & Update::SinglePar)
404 << "] buffer: " << &buffer_);
406 buffer_.updateMacros();
408 // Now do the first drawing step if needed. This consists on updating
409 // the CoordCache in updateMetrics().
410 // The second drawing step is done in WorkArea::redraw() if needed.
412 // Case when no explicit update is requested.
414 // no need to redraw anything.
415 d->update_strategy_ = NoScreenUpdate;
419 if (flags == Update::Decoration) {
420 d->update_strategy_ = DecorationUpdate;
425 if (flags == Update::FitCursor
426 || flags == (Update::Decoration | Update::FitCursor)) {
427 // tell the frontend to update the screen if needed.
432 if (flags & Update::Decoration) {
433 d->update_strategy_ = DecorationUpdate;
437 // no screen update is needed.
438 d->update_strategy_ = NoScreenUpdate;
442 bool const full_metrics = flags & Update::Force || !singleParUpdate();
445 // We have to update the full screen metrics.
448 if (!(flags & Update::FitCursor)) {
449 // Nothing to do anymore. Trigger a redraw and return
454 // updateMetrics() does not update paragraph position
455 // This is done at draw() time. So we need a redraw!
459 // The cursor is off screen so ensure it is visible.
466 void BufferView::updateScrollbar()
468 if (height_ == 0 && width_ == 0)
471 // We prefer fixed size line scrolling.
472 d->scrollbarParameters_.single_step = defaultRowHeight();
473 // We prefer full screen page scrolling.
474 d->scrollbarParameters_.page_step = height_;
476 Text & t = buffer_.text();
477 TextMetrics & tm = d->text_metrics_[&t];
479 LYXERR(Debug::GUI, " Updating scrollbar: height: "
480 << t.paragraphs().size()
481 << " curr par: " << d->cursor_.bottom().pit()
482 << " default height " << defaultRowHeight());
484 size_t const parsize = t.paragraphs().size();
485 if (d->par_height_.size() != parsize) {
486 d->par_height_.clear();
487 // FIXME: We assume a default paragraph height of 2 rows. This
488 // should probably be pondered with the screen width.
489 d->par_height_.resize(parsize, defaultRowHeight() * 2);
492 // Look at paragraph heights on-screen
493 pair<pit_type, ParagraphMetrics const *> first = tm.first();
494 pair<pit_type, ParagraphMetrics const *> last = tm.last();
495 for (pit_type pit = first.first; pit <= last.first; ++pit) {
496 d->par_height_[pit] = tm.parMetrics(pit).height();
497 LYXERR(Debug::SCROLLING, "storing height for pit " << pit << " : "
498 << d->par_height_[pit]);
501 int top_pos = first.second->position() - first.second->ascent();
502 int bottom_pos = last.second->position() + last.second->descent();
503 bool first_visible = first.first == 0 && top_pos >= 0;
504 bool last_visible = last.first + 1 == int(parsize) && bottom_pos <= height_;
505 if (first_visible && last_visible) {
506 d->scrollbarParameters_.min = 0;
507 d->scrollbarParameters_.max = 0;
511 d->scrollbarParameters_.min = top_pos;
512 for (size_t i = 0; i != size_t(first.first); ++i)
513 d->scrollbarParameters_.min -= d->par_height_[i];
514 d->scrollbarParameters_.max = bottom_pos;
515 for (size_t i = last.first + 1; i != parsize; ++i)
516 d->scrollbarParameters_.max += d->par_height_[i];
518 d->scrollbarParameters_.position = 0;
519 // The reference is the top position so we remove one page.
520 if (lyxrc.scroll_below_document)
521 d->scrollbarParameters_.max -= minVisiblePart();
523 d->scrollbarParameters_.max -= d->scrollbarParameters_.page_step;
527 ScrollbarParameters const & BufferView::scrollbarParameters() const
529 return d->scrollbarParameters_;
533 docstring BufferView::toolTip(int x, int y) const
535 // Get inset under mouse, if there is one.
536 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
538 // No inset, no tooltip...
540 return covering_inset->toolTip(*this, x, y);
544 docstring BufferView::contextMenu(int x, int y) const
546 //If there is a selection, return the containing inset menu
547 if (d->cursor_.selection())
548 return d->cursor_.inset().contextMenu(*this, x, y);
550 // Get inset under mouse, if there is one.
551 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
553 return covering_inset->contextMenu(*this, x, y);
555 return buffer_.inset().contextMenu(*this, x, y);
559 void BufferView::scrollDocView(int value)
561 int const offset = value - d->scrollbarParameters_.position;
563 // No scrolling at all? No need to redraw anything
567 // If the offset is less than 2 screen height, prefer to scroll instead.
568 if (abs(offset) <= 2 * height_) {
569 d->anchor_ypos_ -= offset;
575 // cut off at the top
576 if (value <= d->scrollbarParameters_.min) {
577 DocIterator dit = doc_iterator_begin(&buffer_);
579 LYXERR(Debug::SCROLLING, "scroll to top");
583 // cut off at the bottom
584 if (value >= d->scrollbarParameters_.max) {
585 DocIterator dit = doc_iterator_end(&buffer_);
588 LYXERR(Debug::SCROLLING, "scroll to bottom");
592 // find paragraph at target position
593 int par_pos = d->scrollbarParameters_.min;
595 for (; i != int(d->par_height_.size()); ++i) {
596 par_pos += d->par_height_[i];
597 if (par_pos >= value)
601 if (par_pos < value) {
602 // It seems we didn't find the correct pit so stay on the safe side and
604 LYXERR0("scrolling position not found!");
605 scrollDocView(d->scrollbarParameters_.max);
609 DocIterator dit = doc_iterator_begin(&buffer_);
611 LYXERR(Debug::SCROLLING, "value = " << value << " -> scroll to pit " << i);
616 // FIXME: this method is not working well.
617 void BufferView::setCursorFromScrollbar()
619 TextMetrics & tm = d->text_metrics_[&buffer_.text()];
621 int const height = 2 * defaultRowHeight();
622 int const first = height;
623 int const last = height_ - height;
625 Cursor const & oldcur = d->cursor_;
627 switch (cursorStatus(oldcur)) {
635 int const y = getPos(oldcur, oldcur.boundary()).y_;
636 newy = min(last, max(y, first));
640 // We reset the cursor because cursorStatus() does not
641 // work when the cursor is within mathed.
643 cur.reset(buffer_.inset());
644 tm.setCursorFromCoordinates(cur, 0, newy);
646 // update the bufferview cursor and notify insets
647 // FIXME: Care about the d->cursor_ flags to redraw if needed
648 Cursor old = d->cursor_;
650 bool badcursor = notifyCursorLeavesOrEnters(old, d->cursor_);
652 d->cursor_.fixIfBroken();
656 Change const BufferView::getCurrentChange() const
658 if (!d->cursor_.selection())
659 return Change(Change::UNCHANGED);
661 DocIterator dit = d->cursor_.selectionBegin();
662 return dit.paragraph().lookupChange(dit.pos());
666 // this could be used elsewhere as well?
667 // FIXME: This does not work within mathed!
668 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
670 Point const p = getPos(dit, dit.boundary());
673 if (p.y_ > workHeight())
679 void BufferView::bookmarkEditPosition()
681 // Don't eat cpu time for each keystroke
682 if (d->cursor_.paragraph().id() == d->bookmark_edit_position_)
685 d->bookmark_edit_position_ = d->cursor_.paragraph().id();
689 void BufferView::saveBookmark(unsigned int idx)
691 // tentatively save bookmark, id and pos will be used to
692 // acturately locate a bookmark in a 'live' lyx session.
693 // pit and pos will be updated with bottom level pit/pos
695 theSession().bookmarks().save(
697 d->cursor_.bottom().pit(),
698 d->cursor_.bottom().pos(),
699 d->cursor_.paragraph().id(),
704 // emit message signal.
705 message(_("Save bookmark"));
709 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
710 int top_id, pos_type top_pos)
712 bool success = false;
715 d->cursor_.clearSelection();
717 // if a valid par_id is given, try it first
718 // This is the case for a 'live' bookmark when unique paragraph ID
719 // is used to track bookmarks.
721 dit = buffer_.getParFromID(top_id);
723 dit.pos() = min(dit.paragraph().size(), top_pos);
724 // Some slices of the iterator may not be
725 // reachable (e.g. closed collapsable inset)
726 // so the dociterator may need to be
727 // shortened. Otherwise, setCursor may crash
728 // lyx when the cursor can not be set to these
730 size_t const n = dit.depth();
731 for (size_t i = 0; i < n; ++i)
732 if (dit[i].inset().editable() != Inset::HIGHLY_EDITABLE) {
740 // if top_id == 0, or searching through top_id failed
741 // This is the case for a 'restored' bookmark when only bottom
742 // (document level) pit was saved. Because of this, bookmark
743 // restoration is inaccurate. If a bookmark was within an inset,
744 // it will be restored to the left of the outmost inset that contains
746 if (bottom_pit < int(buffer_.paragraphs().size())) {
747 dit = doc_iterator_begin(&buffer_);
749 dit.pit() = bottom_pit;
750 dit.pos() = min(bottom_pos, dit.paragraph().size());
755 // Note: only bottom (document) level pit is set.
757 // set the current font.
758 d->cursor_.setCurrentFont();
759 // To center the screen on this new position we need the
760 // paragraph position which is computed at draw() time.
761 // So we need a redraw!
771 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
773 if (lyxrc.rtl_support) {
774 if (d->cursor_.real_current_font.isRightToLeft()) {
775 if (d->intl_.keymap == Intl::PRIMARY)
776 d->intl_.keyMapSec();
778 if (d->intl_.keymap == Intl::SECONDARY)
779 d->intl_.keyMapPrim();
783 d->intl_.getTransManager().translateAndInsert(c, t, cur);
787 int BufferView::workWidth() const
793 void BufferView::recenter()
795 showCursor(d->cursor_, true);
799 void BufferView::showCursor()
801 showCursor(d->cursor_, false);
805 void BufferView::showCursor(DocIterator const & dit, bool recenter)
807 if (scrollToCursor(dit, recenter))
812 void BufferView::scrollToCursor()
814 scrollToCursor(d->cursor_, false);
818 bool BufferView::scrollToCursor(DocIterator const & dit, bool recenter)
820 // We are not properly started yet, delay until resizing is
825 LYXERR(Debug::SCROLLING, "recentering!");
827 CursorSlice const & bot = dit.bottom();
828 TextMetrics & tm = d->text_metrics_[bot.text()];
830 pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
831 int bot_pit = bot.pit();
832 if (bot_pit > max_pit) {
833 // FIXME: Why does this happen?
834 LYXERR0("bottom pit is greater that max pit: "
835 << bot_pit << " > " << max_pit);
839 if (bot_pit == tm.first().first - 1)
840 tm.newParMetricsUp();
841 else if (bot_pit == tm.last().first + 1)
842 tm.newParMetricsDown();
844 if (tm.contains(bot_pit)) {
845 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
846 LASSERT(!pm.rows().empty(), /**/);
847 // FIXME: smooth scrolling doesn't work in mathed.
848 CursorSlice const & cs = dit.innerTextSlice();
849 int offset = coordOffset(dit, dit.boundary()).y_;
850 int ypos = pm.position() + offset;
851 Dimension const & row_dim =
852 pm.getRow(cs.pos(), dit.boundary()).dimension();
855 scrolled = scroll(ypos - height_/2);
856 else if (ypos - row_dim.ascent() < 0)
857 scrolled = scrollUp(- ypos + row_dim.ascent());
858 else if (ypos + row_dim.descent() > height_)
859 scrolled = scrollDown(ypos - height_ + defaultRowHeight() );
861 // else, nothing to do, the cursor is already visible so we just return.
869 // fix inline completion position
870 if (d->inlineCompletionPos_.fixIfBroken())
871 d->inlineCompletionPos_ = DocIterator();
873 tm.redoParagraph(bot_pit);
874 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
875 int offset = coordOffset(dit, dit.boundary()).y_;
877 d->anchor_pit_ = bot_pit;
878 CursorSlice const & cs = dit.innerTextSlice();
879 Dimension const & row_dim =
880 pm.getRow(cs.pos(), dit.boundary()).dimension();
883 d->anchor_ypos_ = height_/2;
884 else if (d->anchor_pit_ == 0)
885 d->anchor_ypos_ = offset + pm.ascent();
886 else if (d->anchor_pit_ == max_pit)
887 d->anchor_ypos_ = height_ - offset - row_dim.descent();
888 else if (offset > height_)
889 d->anchor_ypos_ = height_ - offset - defaultRowHeight();
891 d->anchor_ypos_ = defaultRowHeight() * 2;
898 FuncStatus BufferView::getStatus(FuncRequest const & cmd)
902 Cursor & cur = d->cursor_;
904 switch (cmd.action) {
907 flag.setEnabled(buffer_.undo().hasUndoStack());
910 flag.setEnabled(buffer_.undo().hasRedoStack());
912 case LFUN_FILE_INSERT:
913 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
914 case LFUN_FILE_INSERT_PLAINTEXT:
915 case LFUN_BOOKMARK_SAVE:
916 // FIXME: Actually, these LFUNS should be moved to Text
917 flag.setEnabled(cur.inTexted());
919 case LFUN_FONT_STATE:
920 case LFUN_LABEL_INSERT:
921 case LFUN_INFO_INSERT:
922 case LFUN_INSET_EDIT:
923 case LFUN_PARAGRAPH_GOTO:
925 case LFUN_REFERENCE_NEXT:
927 case LFUN_WORD_FINDADV:
928 case LFUN_WORD_REPLACE:
931 case LFUN_MARK_TOGGLE:
932 case LFUN_SCREEN_RECENTER:
933 case LFUN_SCREEN_SHOW_CURSOR:
934 case LFUN_BIBTEX_DATABASE_ADD:
935 case LFUN_BIBTEX_DATABASE_DEL:
936 case LFUN_NOTES_MUTATE:
937 case LFUN_ALL_INSETS_TOGGLE:
938 case LFUN_STATISTICS:
939 flag.setEnabled(true);
942 // @todo Test if current WorkArea is the search WorkArea
943 case LFUN_REGEXP_MODE:
944 flag.setEnabled(! this->cursor().inRegexped());
947 case LFUN_COPY_LABEL_AS_REF: {
948 // if there is an inset at cursor, see whether it
950 Inset * inset = cur.nextInset();
951 if (!inset || !inset->getStatus(cur, cmd, flag))
952 flag.setEnabled(false);
956 case LFUN_NEXT_INSET_MODIFY: {
957 // this is the real function we want to invoke
958 FuncRequest tmpcmd = cmd;
959 tmpcmd.action = LFUN_INSET_MODIFY;
960 // if there is an inset at cursor, see whether it
961 // handles the lfun, other start from scratch
962 Inset * inset = cur.nextInset();
963 if (!inset || !inset->getStatus(cur, tmpcmd, flag))
964 flag = lyx::getStatus(tmpcmd);
968 case LFUN_LABEL_GOTO: {
969 flag.setEnabled(!cmd.argument().empty()
970 || getInsetByCode<InsetRef>(cur, REF_CODE));
974 case LFUN_CHANGES_TRACK:
975 flag.setEnabled(true);
976 flag.setOnOff(buffer_.params().trackChanges);
979 case LFUN_CHANGES_OUTPUT:
980 flag.setEnabled(true);
981 flag.setOnOff(buffer_.params().outputChanges);
984 case LFUN_CHANGES_MERGE:
985 case LFUN_CHANGE_NEXT:
986 case LFUN_ALL_CHANGES_ACCEPT:
987 case LFUN_ALL_CHANGES_REJECT:
988 // TODO: context-sensitive enabling of LFUNs
989 // In principle, these command should only be enabled if there
990 // is a change in the document. However, without proper
991 // optimizations, this will inevitably result in poor performance.
992 flag.setEnabled(true);
995 case LFUN_BUFFER_TOGGLE_COMPRESSION: {
996 flag.setOnOff(buffer_.params().compressed);
1000 case LFUN_SCREEN_UP:
1001 case LFUN_SCREEN_DOWN:
1003 case LFUN_SCREEN_UP_SELECT:
1004 case LFUN_SCREEN_DOWN_SELECT:
1005 flag.setEnabled(true);
1008 case LFUN_LAYOUT_TABULAR:
1009 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
1013 flag.setEnabled(!cur.inset().forcePlainLayout(cur.idx()));
1016 case LFUN_LAYOUT_PARAGRAPH:
1017 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
1020 case LFUN_INSET_SETTINGS: {
1021 InsetCode code = cur.inset().lyxCode();
1022 if (cmd.getArg(0) == insetName(code)) {
1023 flag.setEnabled(true);
1026 bool enable = false;
1027 InsetCode next_code = cur.nextInset()
1028 ? cur.nextInset()->lyxCode() : NO_CODE;
1029 //FIXME: remove these special cases:
1030 switch (next_code) {
1040 enable = (cmd.argument().empty() ||
1041 cmd.getArg(0) == insetName(next_code));
1046 flag.setEnabled(enable);
1050 case LFUN_DIALOG_SHOW_NEW_INSET:
1051 flag.setEnabled(cur.inset().lyxCode() != ERT_CODE &&
1052 cur.inset().lyxCode() != LISTINGS_CODE);
1053 if (cur.inset().lyxCode() == CAPTION_CODE) {
1055 if (cur.inset().getStatus(cur, cmd, flag))
1060 case LFUN_BRANCH_ACTIVATE:
1061 case LFUN_BRANCH_DEACTIVATE: {
1062 BranchList const & branchList = buffer_.params().branchlist();
1063 docstring const branchName = cmd.argument();
1064 flag.setEnabled(!branchName.empty()
1065 && branchList.find(branchName));
1070 flag.setEnabled(false);
1077 bool BufferView::dispatch(FuncRequest const & cmd)
1079 //lyxerr << [ cmd = " << cmd << "]" << endl;
1081 // Make sure that the cached BufferView is correct.
1082 LYXERR(Debug::ACTION, " action[" << cmd.action << ']'
1083 << " arg[" << to_utf8(cmd.argument()) << ']'
1084 << " x[" << cmd.x << ']'
1085 << " y[" << cmd.y << ']'
1086 << " button[" << cmd.button() << ']');
1088 Cursor & cur = d->cursor_;
1090 switch (cmd.action) {
1093 cur.message(_("Undo"));
1094 cur.clearSelection();
1095 if (!cur.textUndo())
1096 cur.message(_("No further undo information"));
1098 processUpdateFlags(Update::Force | Update::FitCursor);
1102 cur.message(_("Redo"));
1103 cur.clearSelection();
1104 if (!cur.textRedo())
1105 cur.message(_("No further redo information"));
1107 processUpdateFlags(Update::Force | Update::FitCursor);
1110 case LFUN_FONT_STATE:
1111 cur.message(cur.currentState());
1114 case LFUN_BOOKMARK_SAVE:
1115 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1118 case LFUN_LABEL_GOTO: {
1119 docstring label = cmd.argument();
1120 if (label.empty()) {
1122 getInsetByCode<InsetRef>(d->cursor_, REF_CODE);
1124 label = inset->getParam("reference");
1125 // persistent=false: use temp_bookmark
1134 case LFUN_INSET_EDIT: {
1135 FuncRequest fr(cmd);
1136 // if there is an inset at cursor, see whether it
1138 Inset * inset = cur.nextInset();
1140 inset->dispatch(cur, fr);
1141 // if it did not work, try the underlying inset.
1142 if (!inset || !cur.result().dispatched())
1145 // FIXME I'm adding the last break to solve a crash,
1146 // but that is obviously not right.
1147 if (!cur.result().dispatched())
1148 // It did not work too; no action needed.
1153 case LFUN_PARAGRAPH_GOTO: {
1154 int const id = convert<int>(cmd.getArg(0));
1155 int const pos = convert<int>(cmd.getArg(1));
1157 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1158 b = theBufferList().next(b)) {
1160 DocIterator dit = b->getParFromID(id);
1162 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1166 LYXERR(Debug::INFO, "Paragraph " << dit.paragraph().id()
1167 << " found in buffer `"
1168 << b->absFileName() << "'.");
1170 if (b == &buffer_) {
1174 processUpdateFlags(Update::Force | Update::FitCursor);
1176 // Switch to other buffer view and resend cmd
1177 theLyXFunc().dispatch(FuncRequest(
1178 LFUN_BUFFER_SWITCH, b->absFileName()));
1179 theLyXFunc().dispatch(cmd);
1186 case LFUN_NOTE_NEXT:
1187 gotoInset(this, NOTE_CODE, false);
1190 case LFUN_REFERENCE_NEXT: {
1191 vector<InsetCode> tmp;
1192 tmp.push_back(LABEL_CODE);
1193 tmp.push_back(REF_CODE);
1194 gotoInset(this, tmp, true);
1198 case LFUN_CHANGES_TRACK:
1199 buffer_.params().trackChanges = !buffer_.params().trackChanges;
1202 case LFUN_CHANGES_OUTPUT:
1203 buffer_.params().outputChanges = !buffer_.params().outputChanges;
1204 if (buffer_.params().outputChanges) {
1205 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1206 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1207 LaTeXFeatures::isAvailable("xcolor");
1209 if (!dvipost && !xcolorulem) {
1210 Alert::warning(_("Changes not shown in LaTeX output"),
1211 _("Changes will not be highlighted in LaTeX output, "
1212 "because neither dvipost nor xcolor/ulem are installed.\n"
1213 "Please install these packages or redefine "
1214 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1215 } else if (!xcolorulem) {
1216 Alert::warning(_("Changes not shown in LaTeX output"),
1217 _("Changes will not be highlighted in LaTeX output "
1218 "when using pdflatex, because xcolor and ulem are not installed.\n"
1219 "Please install both packages or redefine "
1220 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1225 case LFUN_CHANGE_NEXT:
1226 findNextChange(this);
1227 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1228 processUpdateFlags(Update::Force | Update::FitCursor);
1231 case LFUN_CHANGES_MERGE:
1232 if (findNextChange(this)) {
1233 processUpdateFlags(Update::Force | Update::FitCursor);
1234 showDialog("changes");
1238 case LFUN_ALL_CHANGES_ACCEPT:
1239 // select complete document
1240 d->cursor_.reset(buffer_.inset());
1241 d->cursor_.selHandle(true);
1242 buffer_.text().cursorBottom(d->cursor_);
1243 // accept everything in a single step to support atomic undo
1244 buffer_.text().acceptOrRejectChanges(d->cursor_, Text::ACCEPT);
1245 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1246 processUpdateFlags(Update::Force | Update::FitCursor);
1249 case LFUN_ALL_CHANGES_REJECT:
1250 // select complete document
1251 d->cursor_.reset(buffer_.inset());
1252 d->cursor_.selHandle(true);
1253 buffer_.text().cursorBottom(d->cursor_);
1254 // reject everything in a single step to support atomic undo
1255 // Note: reject does not work recursively; the user may have to repeat the operation
1256 buffer_.text().acceptOrRejectChanges(d->cursor_, Text::REJECT);
1257 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1258 processUpdateFlags(Update::Force | Update::FitCursor);
1261 case LFUN_WORD_FIND: {
1262 FuncRequest req = cmd;
1263 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1264 req = d->search_request_cache_;
1265 if (req.argument().empty()) {
1266 theLyXFunc().dispatch(FuncRequest(LFUN_DIALOG_SHOW, "findreplace"));
1269 if (find(this, req))
1272 message(_("String not found!"));
1273 d->search_request_cache_ = req;
1277 case LFUN_WORD_REPLACE: {
1278 bool has_deleted = false;
1279 if (cur.selection()) {
1280 DocIterator beg = cur.selectionBegin();
1281 DocIterator end = cur.selectionEnd();
1282 if (beg.pit() == end.pit()) {
1283 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1284 if (cur.paragraph().isDeleted(p))
1289 replace(this, cmd, has_deleted);
1293 case LFUN_WORD_FINDADV:
1298 cur.clearSelection();
1300 cur.message(from_utf8(N_("Mark off")));
1304 cur.clearSelection();
1307 cur.message(from_utf8(N_("Mark on")));
1310 case LFUN_MARK_TOGGLE:
1311 cur.clearSelection();
1314 cur.message(from_utf8(N_("Mark removed")));
1317 cur.message(from_utf8(N_("Mark set")));
1322 case LFUN_SCREEN_SHOW_CURSOR:
1326 case LFUN_SCREEN_RECENTER:
1330 case LFUN_BIBTEX_DATABASE_ADD: {
1331 Cursor tmpcur = d->cursor_;
1332 findInset(tmpcur, BIBTEX_CODE, false);
1333 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1336 if (inset->addDatabase(cmd.argument()))
1337 buffer_.updateBibfilesCache();
1342 case LFUN_BIBTEX_DATABASE_DEL: {
1343 Cursor tmpcur = d->cursor_;
1344 findInset(tmpcur, BIBTEX_CODE, false);
1345 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1348 if (inset->delDatabase(cmd.argument()))
1349 buffer_.updateBibfilesCache();
1354 case LFUN_STATISTICS: {
1355 DocIterator from, to;
1356 if (cur.selection()) {
1357 from = cur.selectionBegin();
1358 to = cur.selectionEnd();
1360 from = doc_iterator_begin(&buffer_);
1361 to = doc_iterator_end(&buffer_);
1363 int const words = countWords(from, to);
1364 int const chars = countChars(from, to, false);
1365 int const chars_blanks = countChars(from, to, true);
1367 if (cur.selection())
1368 message = _("Statistics for the selection:");
1370 message = _("Statistics for the document:");
1373 message += bformat(_("%1$d words"), words);
1375 message += _("One word");
1377 if (chars_blanks != 1)
1378 message += bformat(_("%1$d characters (including blanks)"),
1381 message += _("One character (including blanks)");
1384 message += bformat(_("%1$d characters (excluding blanks)"),
1387 message += _("One character (excluding blanks)");
1389 Alert::information(_("Statistics"), message);
1393 case LFUN_BUFFER_TOGGLE_COMPRESSION:
1394 // turn compression on/off
1395 buffer_.params().compressed = !buffer_.params().compressed;
1397 case LFUN_COPY_LABEL_AS_REF: {
1398 // if there is an inset at cursor, try to copy it
1399 Inset * inset = cur.nextInset();
1401 FuncRequest tmpcmd = cmd;
1402 inset->dispatch(cur, tmpcmd);
1404 if (!cur.result().dispatched())
1405 // It did not work too; no action needed.
1407 cur.clearSelection();
1408 processUpdateFlags(Update::SinglePar | Update::FitCursor);
1411 case LFUN_NEXT_INSET_MODIFY: {
1412 // create the the real function we want to invoke
1413 FuncRequest tmpcmd = cmd;
1414 tmpcmd.action = LFUN_INSET_MODIFY;
1415 // if there is an inset at cursor, see whether it
1417 Inset * inset = cur.nextInset();
1420 inset->dispatch(cur, tmpcmd);
1422 // if it did not work, try the underlying inset.
1423 if (!inset || !cur.result().dispatched()) {
1425 cur.dispatch(tmpcmd);
1428 if (!cur.result().dispatched())
1429 // It did not work too; no action needed.
1431 cur.clearSelection();
1432 processUpdateFlags(Update::Force | Update::FitCursor);
1436 case LFUN_SCREEN_UP:
1437 case LFUN_SCREEN_DOWN: {
1438 Point p = getPos(cur, cur.boundary());
1439 if (p.y_ < 0 || p.y_ > height_) {
1440 // The cursor is off-screen so recenter before proceeding.
1442 p = getPos(cur, cur.boundary());
1444 int const scrolled = scroll(cmd.action == LFUN_SCREEN_UP
1445 ? - height_ : height_);
1446 if (cmd.action == LFUN_SCREEN_UP && scrolled > - height_)
1448 if (cmd.action == LFUN_SCREEN_DOWN && scrolled < height_)
1449 p = Point(width_, height_);
1451 bool const in_texted = cur.inTexted();
1452 cur.reset(buffer_.inset());
1455 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_);
1456 //FIXME: what to do with cur.x_target()?
1457 bool update = in_texted && cur.bv().checkDepm(cur, old);
1460 processUpdateFlags(Update::Force | Update::FitCursor);
1468 case LFUN_SCREEN_UP_SELECT: {
1469 cur.selHandle(true);
1470 if (isTopScreen()) {
1471 lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1475 int y = getPos(cur, cur.boundary()).y_;
1476 int const ymin = y - height_ + defaultRowHeight();
1477 while (y > ymin && cur.up())
1478 y = getPos(cur, cur.boundary()).y_;
1481 processUpdateFlags(Update::SinglePar | Update::FitCursor);
1485 case LFUN_SCREEN_DOWN_SELECT: {
1486 cur.selHandle(true);
1487 if (isBottomScreen()) {
1488 lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1492 int y = getPos(cur, cur.boundary()).y_;
1493 int const ymax = y + height_ - defaultRowHeight();
1494 while (y < ymax && cur.down())
1495 y = getPos(cur, cur.boundary()).y_;
1498 processUpdateFlags(Update::SinglePar | Update::FitCursor);
1502 case LFUN_BRANCH_ACTIVATE:
1503 case LFUN_BRANCH_DEACTIVATE:
1504 if (cmd.argument().empty())
1506 buffer_.dispatch(cmd);
1507 processUpdateFlags(Update::Force);
1510 // This could be rewriten using some command like forall <insetname> <command>
1511 // once the insets refactoring is done.
1512 case LFUN_NOTES_MUTATE: {
1513 if (cmd.argument().empty())
1516 if (mutateNotes(cur, cmd.getArg(0), cmd.getArg(1))) {
1517 processUpdateFlags(Update::Force);
1522 case LFUN_ALL_INSETS_TOGGLE: {
1524 string const name = split(to_utf8(cmd.argument()), action, ' ');
1525 InsetCode const inset_code = insetCode(name);
1527 FuncRequest fr(LFUN_INSET_TOGGLE, action);
1529 Inset & inset = cur.buffer()->inset();
1530 InsetIterator it = inset_iterator_begin(inset);
1531 InsetIterator const end = inset_iterator_end(inset);
1532 for (; it != end; ++it) {
1533 if (it->asInsetCollapsable()
1534 && (inset_code == NO_CODE
1535 || inset_code == it->lyxCode())) {
1536 Cursor tmpcur = cur;
1537 tmpcur.pushBackward(*it);
1538 it->dispatch(tmpcur, fr);
1541 processUpdateFlags(Update::Force | Update::FitCursor);
1553 docstring const BufferView::requestSelection()
1555 Cursor & cur = d->cursor_;
1557 LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
1558 if (!cur.selection()) {
1559 d->xsel_cache_.set = false;
1563 LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
1564 if (!d->xsel_cache_.set ||
1565 cur.top() != d->xsel_cache_.cursor ||
1566 cur.anchor_.top() != d->xsel_cache_.anchor)
1568 d->xsel_cache_.cursor = cur.top();
1569 d->xsel_cache_.anchor = cur.anchor_.top();
1570 d->xsel_cache_.set = cur.selection();
1571 return cur.selectionAsString(false);
1577 void BufferView::clearSelection()
1579 d->cursor_.clearSelection();
1580 // Clear the selection buffer. Otherwise a subsequent
1581 // middle-mouse-button paste would use the selection buffer,
1582 // not the more current external selection.
1583 cap::clearSelection();
1584 d->xsel_cache_.set = false;
1585 // The buffer did not really change, but this causes the
1586 // redraw we need because we cleared the selection above.
1591 void BufferView::resize(int width, int height)
1593 // Update from work area
1597 // Clear the paragraph height cache.
1598 d->par_height_.clear();
1599 // Redo the metrics.
1604 Inset const * BufferView::getCoveringInset(Text const & text,
1607 TextMetrics & tm = d->text_metrics_[&text];
1608 Inset * inset = tm.checkInsetHit(x, y);
1612 if (!inset->descendable())
1613 // No need to go further down if the inset is not
1617 size_t cell_number = inset->nargs();
1618 // Check all the inner cell.
1619 for (size_t i = 0; i != cell_number; ++i) {
1620 Text const * inner_text = inset->getText(i);
1623 Inset const * inset_deeper =
1624 getCoveringInset(*inner_text, x, y);
1626 return inset_deeper;
1634 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
1636 //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
1638 // This is only called for mouse related events including
1639 // LFUN_FILE_OPEN generated by drag-and-drop.
1640 FuncRequest cmd = cmd0;
1642 Cursor old = cursor();
1644 cur.push(buffer_.inset());
1645 cur.setSelection(d->cursor_.selection());
1647 // Either the inset under the cursor or the
1648 // surrounding Text will handle this event.
1650 // make sure we stay within the screen...
1651 cmd.y = min(max(cmd.y, -1), height_);
1653 if (cmd.action == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
1655 // Get inset under mouse, if there is one.
1656 Inset const * covering_inset =
1657 getCoveringInset(buffer_.text(), cmd.x, cmd.y);
1658 if (covering_inset == d->last_inset_)
1659 // Same inset, no need to do anything...
1662 bool need_redraw = false;
1663 // const_cast because of setMouseHover().
1664 Inset * inset = const_cast<Inset *>(covering_inset);
1666 // Remove the hint on the last hovered inset (if any).
1667 need_redraw |= d->last_inset_->setMouseHover(false);
1669 // Highlighted the newly hovered inset (if any).
1670 need_redraw |= inset->setMouseHover(true);
1671 d->last_inset_ = inset;
1675 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
1676 << cmd.x << ", " << cmd.y << ")");
1678 d->update_strategy_ = DecorationUpdate;
1680 // This event (moving without mouse click) is not passed further.
1681 // This should be changed if it is further utilized.
1686 // Build temporary cursor.
1687 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x, cmd.y);
1689 // Put anchor at the same position.
1692 cur.beginUndoGroup();
1694 // Try to dispatch to an non-editable inset near this position
1695 // via the temp cursor. If the inset wishes to change the real
1696 // cursor it has to do so explicitly by using
1697 // cur.bv().cursor() = cur; (or similar)
1699 inset->dispatch(cur, cmd);
1701 // Now dispatch to the temporary cursor. If the real cursor should
1702 // be modified, the inset's dispatch has to do so explicitly.
1703 if (!inset || !cur.result().dispatched())
1708 // Notify left insets
1711 bool badcursor = notifyCursorLeavesOrEnters(old, cur);
1713 cursor().fixIfBroken();
1716 // Do we have a selection?
1717 theSelection().haveSelection(cursor().selection());
1719 // If the command has been dispatched,
1720 if (cur.result().dispatched() || cur.result().update())
1721 processUpdateFlags(cur.result().update());
1725 void BufferView::lfunScroll(FuncRequest const & cmd)
1727 string const scroll_type = cmd.getArg(0);
1728 int const scroll_step =
1729 (scroll_type == "line") ? d->scrollbarParameters_.single_step
1730 : (scroll_type == "page") ? d->scrollbarParameters_.page_step : 0;
1731 if (scroll_step == 0)
1733 string const scroll_quantity = cmd.getArg(1);
1734 if (scroll_quantity == "up")
1735 scrollUp(scroll_step);
1736 else if (scroll_quantity == "down")
1737 scrollDown(scroll_step);
1739 int const scroll_value = convert<int>(scroll_quantity);
1741 scroll(scroll_step * scroll_value);
1748 int BufferView::minVisiblePart()
1750 return 2 * defaultRowHeight();
1754 int BufferView::scroll(int y)
1757 return scrollDown(y);
1759 return scrollUp(-y);
1764 int BufferView::scrollDown(int offset)
1766 Text * text = &buffer_.text();
1767 TextMetrics & tm = d->text_metrics_[text];
1768 int const ymax = height_ + offset;
1770 pair<pit_type, ParagraphMetrics const *> last = tm.last();
1771 int bottom_pos = last.second->position() + last.second->descent();
1772 if (lyxrc.scroll_below_document)
1773 bottom_pos += height_ - minVisiblePart();
1774 if (last.first + 1 == int(text->paragraphs().size())) {
1775 if (bottom_pos <= height_)
1777 offset = min(offset, bottom_pos - height_);
1780 if (bottom_pos > ymax)
1782 tm.newParMetricsDown();
1784 d->anchor_ypos_ -= offset;
1789 int BufferView::scrollUp(int offset)
1791 Text * text = &buffer_.text();
1792 TextMetrics & tm = d->text_metrics_[text];
1793 int ymin = - offset;
1795 pair<pit_type, ParagraphMetrics const *> first = tm.first();
1796 int top_pos = first.second->position() - first.second->ascent();
1797 if (first.first == 0) {
1800 offset = min(offset, - top_pos);
1805 tm.newParMetricsUp();
1807 d->anchor_ypos_ += offset;
1812 void BufferView::setCursorFromRow(int row)
1817 buffer_.texrow().getIdFromRow(row, tmpid, tmppos);
1819 d->cursor_.reset(buffer_.inset());
1821 buffer_.text().setCursor(d->cursor_, 0, 0);
1823 buffer_.text().setCursor(d->cursor_, buffer_.getParFromID(tmpid).pit(), tmppos);
1827 bool BufferView::setCursorFromInset(Inset const * inset)
1829 // are we already there?
1830 if (cursor().nextInset() == inset)
1833 // Inset is not at cursor position. Find it in the document.
1835 cur.reset(buffer().inset());
1836 while (cur && cur.nextInset() != inset)
1847 void BufferView::gotoLabel(docstring const & label)
1849 std::vector<Buffer const *> bufs = buffer().allRelatives();
1850 std::vector<Buffer const *>::iterator it = bufs.begin();
1851 for (; it != bufs.end(); ++it) {
1852 Buffer const * buf = *it;
1855 Toc & toc = buf->tocBackend().toc("label");
1856 TocIterator toc_it = toc.begin();
1857 TocIterator end = toc.end();
1858 for (; toc_it != end; ++toc_it) {
1859 if (label == toc_it->str()) {
1860 dispatch(toc_it->action());
1868 TextMetrics const & BufferView::textMetrics(Text const * t) const
1870 return const_cast<BufferView *>(this)->textMetrics(t);
1874 TextMetrics & BufferView::textMetrics(Text const * t)
1876 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
1877 if (tmc_it == d->text_metrics_.end()) {
1878 tmc_it = d->text_metrics_.insert(
1879 make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
1881 return tmc_it->second;
1885 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
1888 return textMetrics(t).parMetrics(pit);
1892 int BufferView::workHeight() const
1898 void BufferView::setCursor(DocIterator const & dit)
1900 size_t const n = dit.depth();
1901 for (size_t i = 0; i < n; ++i)
1902 dit[i].inset().edit(d->cursor_, true);
1904 d->cursor_.setCursor(dit);
1905 d->cursor_.setSelection(false);
1909 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
1911 // Would be wrong to delete anything if we have a selection.
1912 if (cur.selection())
1915 bool need_anchor_change = false;
1916 bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
1917 need_anchor_change);
1919 if (need_anchor_change)
1927 buffer_.updateLabels();
1935 bool BufferView::mouseSetCursor(Cursor & cur, bool select)
1937 LASSERT(&cur.bv() == this, /**/);
1940 // this event will clear selection so we save selection for
1941 // persistent selection
1942 cap::saveSelection(cursor());
1944 // Has the cursor just left the inset?
1945 bool leftinset = (&d->cursor_.inset() != &cur.inset());
1947 d->cursor_.fixIfBroken();
1949 // FIXME: shift-mouse selection doesn't work well across insets.
1950 bool do_selection = select && &d->cursor_.anchor().inset() == &cur.inset();
1952 // do the dEPM magic if needed
1953 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
1954 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
1955 // the leftinset bool would not be necessary (badcursor instead).
1956 bool update = leftinset;
1957 if (!do_selection && d->cursor_.inTexted())
1958 update |= checkDepm(cur, d->cursor_);
1960 d->cursor_.setCursor(cur);
1961 d->cursor_.boundary(cur.boundary());
1963 d->cursor_.setSelection();
1965 d->cursor_.clearSelection();
1967 d->cursor_.finishUndo();
1968 d->cursor_.setCurrentFont();
1973 void BufferView::putSelectionAt(DocIterator const & cur,
1974 int length, bool backwards)
1976 d->cursor_.clearSelection();
1982 d->cursor_.pos() += length;
1983 d->cursor_.setSelection(d->cursor_, -length);
1985 d->cursor_.setSelection(d->cursor_, length);
1987 // Ensure a redraw happens in any case because the new selection could
1988 // possibly be on the same screen as the previous selection.
1989 processUpdateFlags(Update::Force | Update::FitCursor);
1993 Cursor & BufferView::cursor()
1999 Cursor const & BufferView::cursor() const
2005 pit_type BufferView::anchor_ref() const
2007 return d->anchor_pit_;
2011 bool BufferView::singleParUpdate()
2013 Text & buftext = buffer_.text();
2014 pit_type const bottom_pit = d->cursor_.bottom().pit();
2015 TextMetrics & tm = textMetrics(&buftext);
2016 int old_height = tm.parMetrics(bottom_pit).height();
2018 // make sure inline completion pointer is ok
2019 if (d->inlineCompletionPos_.fixIfBroken())
2020 d->inlineCompletionPos_ = DocIterator();
2022 // In Single Paragraph mode, rebreak only
2023 // the (main text, not inset!) paragraph containing the cursor.
2024 // (if this paragraph contains insets etc., rebreaking will
2025 // recursively descend)
2026 tm.redoParagraph(bottom_pit);
2027 ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
2028 if (pm.height() != old_height)
2029 // Paragraph height has changed so we cannot proceed to
2030 // the singlePar optimisation.
2033 d->update_strategy_ = SingleParUpdate;
2035 LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
2036 << " y2: " << pm.position() + pm.descent()
2037 << " pit: " << bottom_pit
2038 << " singlepar: 1");
2043 void BufferView::updateMetrics()
2045 if (height_ == 0 || width_ == 0)
2048 Text & buftext = buffer_.text();
2049 pit_type const npit = int(buftext.paragraphs().size());
2051 // Clear out the position cache in case of full screen redraw,
2052 d->coord_cache_.clear();
2054 // Clear out paragraph metrics to avoid having invalid metrics
2055 // in the cache from paragraphs not relayouted below
2056 // The complete text metrics will be redone.
2057 d->text_metrics_.clear();
2059 TextMetrics & tm = textMetrics(&buftext);
2061 // make sure inline completion pointer is ok
2062 if (d->inlineCompletionPos_.fixIfBroken())
2063 d->inlineCompletionPos_ = DocIterator();
2065 if (d->anchor_pit_ >= npit)
2066 // The anchor pit must have been deleted...
2067 d->anchor_pit_ = npit - 1;
2069 // Rebreak anchor paragraph.
2070 tm.redoParagraph(d->anchor_pit_);
2071 ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
2074 if (d->anchor_pit_ == 0) {
2075 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
2077 // Complete buffer visible? Then it's easy.
2078 if (scrollRange == 0)
2079 d->anchor_ypos_ = anchor_pm.ascent();
2081 // FIXME: Some clever handling needed to show
2082 // the _first_ paragraph up to the top if the cursor is
2083 // in the first line.
2085 anchor_pm.setPosition(d->anchor_ypos_);
2087 LYXERR(Debug::PAINTING, "metrics: "
2088 << " anchor pit = " << d->anchor_pit_
2089 << " anchor ypos = " << d->anchor_ypos_);
2091 // Redo paragraphs above anchor if necessary.
2092 int y1 = d->anchor_ypos_ - anchor_pm.ascent();
2093 // We are now just above the anchor paragraph.
2094 pit_type pit1 = d->anchor_pit_ - 1;
2095 for (; pit1 >= 0 && y1 >= 0; --pit1) {
2096 tm.redoParagraph(pit1);
2097 ParagraphMetrics & pm = tm.par_metrics_[pit1];
2099 // Save the paragraph position in the cache.
2104 // Redo paragraphs below the anchor if necessary.
2105 int y2 = d->anchor_ypos_ + anchor_pm.descent();
2106 // We are now just below the anchor paragraph.
2107 pit_type pit2 = d->anchor_pit_ + 1;
2108 for (; pit2 < npit && y2 <= height_; ++pit2) {
2109 tm.redoParagraph(pit2);
2110 ParagraphMetrics & pm = tm.par_metrics_[pit2];
2112 // Save the paragraph position in the cache.
2117 LYXERR(Debug::PAINTING, "Metrics: "
2118 << " anchor pit = " << d->anchor_pit_
2119 << " anchor ypos = " << d->anchor_ypos_
2122 << " pit1 = " << pit1
2123 << " pit2 = " << pit2);
2125 d->update_strategy_ = FullScreenUpdate;
2127 if (lyxerr.debugging(Debug::WORKAREA)) {
2128 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
2129 d->coord_cache_.dump();
2134 void BufferView::insertLyXFile(FileName const & fname)
2136 LASSERT(d->cursor_.inTexted(), /**/);
2138 // Get absolute path of file and add ".lyx"
2139 // to the filename if necessary
2140 FileName filename = fileSearch(string(), fname.absFilename(), "lyx");
2142 docstring const disp_fn = makeDisplayPath(filename.absFilename());
2143 // emit message signal.
2144 message(bformat(_("Inserting document %1$s..."), disp_fn));
2147 Buffer buf("", false);
2148 if (buf.loadLyXFile(filename)) {
2149 ErrorList & el = buffer_.errorList("Parse");
2150 // Copy the inserted document error list into the current buffer one.
2151 el = buf.errorList("Parse");
2152 buffer_.undo().recordUndo(d->cursor_);
2153 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
2154 buf.params().documentClassPtr(), el);
2155 res = _("Document %1$s inserted.");
2157 res = _("Could not insert document %1$s");
2162 // emit message signal.
2163 message(bformat(res, disp_fn));
2164 buffer_.errors("Parse");
2168 Point BufferView::coordOffset(DocIterator const & dit, bool boundary) const
2174 // Addup contribution of nested insets, from inside to outside,
2175 // keeping the outer paragraph for a special handling below
2176 for (size_t i = dit.depth() - 1; i >= 1; --i) {
2177 CursorSlice const & sl = dit[i];
2181 // get relative position inside sl.inset()
2182 sl.inset().cursorPos(*this, sl, boundary && (i + 1 == dit.depth()), xx, yy);
2184 // Make relative position inside of the edited inset relative to sl.inset()
2188 // In case of an RTL inset, the edited inset will be positioned to the left
2191 bool boundary_i = boundary && i + 1 == dit.depth();
2192 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2197 // remember width for the case that sl.inset() is positioned in an RTL inset
2198 if (i && dit[i - 1].text()) {
2199 // If this Inset is inside a Text Inset, retrieve the Dimension
2200 // from the containing text instead of using Inset::dimension() which
2201 // might not be implemented.
2202 // FIXME (Abdel 23/09/2007): this is a bit messy because of the
2203 // elimination of Inset::dim_ cache. This coordOffset() method needs
2204 // to be rewritten in light of the new design.
2205 Dimension const & dim = parMetrics(dit[i - 1].text(),
2206 dit[i - 1].pit()).insetDimension(&sl.inset());
2209 Dimension const dim = sl.inset().dimension(*this);
2213 //lyxerr << "Cursor::getPos, i: "
2214 // << i << " x: " << xx << " y: " << y << endl;
2217 // Add contribution of initial rows of outermost paragraph
2218 CursorSlice const & sl = dit[0];
2219 TextMetrics const & tm = textMetrics(sl.text());
2220 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2221 LASSERT(!pm.rows().empty(), /**/);
2222 y -= pm.rows()[0].ascent();
2224 // FIXME: document this mess
2226 if (sl.pos() > 0 && dit.depth() == 1) {
2228 if (pos && boundary)
2230 // lyxerr << "coordOffset: boundary:" << boundary << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
2231 rend = pm.pos2row(pos);
2233 rend = pm.pos2row(sl.pos());
2235 size_t rend = pm.pos2row(sl.pos());
2237 for (size_t rit = 0; rit != rend; ++rit)
2238 y += pm.rows()[rit].height();
2239 y += pm.rows()[rend].ascent();
2241 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
2243 // Make relative position from the nested inset now bufferview absolute.
2244 int xx = bottom_tm.cursorX(dit.bottom(), boundary && dit.depth() == 1);
2247 // In the RTL case place the nested inset at the left of the cursor in
2248 // the outer paragraph
2249 bool boundary_1 = boundary && 1 == dit.depth();
2250 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
2258 Point BufferView::getPos(DocIterator const & dit, bool boundary) const
2260 if (!paragraphVisible(dit))
2261 return Point(-1, -1);
2263 CursorSlice const & bot = dit.bottom();
2264 TextMetrics const & tm = textMetrics(bot.text());
2266 Point p = coordOffset(dit, boundary); // offset from outer paragraph
2267 p.y_ += tm.parMetrics(bot.pit()).position();
2272 bool BufferView::paragraphVisible(DocIterator const & dit) const
2274 CursorSlice const & bot = dit.bottom();
2275 TextMetrics const & tm = textMetrics(bot.text());
2277 return tm.contains(bot.pit());
2281 void BufferView::draw(frontend::Painter & pain)
2283 if (height_ == 0 || width_ == 0)
2285 LYXERR(Debug::PAINTING, "\t\t*** START DRAWING ***");
2287 Text & text = buffer_.text();
2288 TextMetrics const & tm = d->text_metrics_[&text];
2289 int const y = tm.first().second->position();
2290 PainterInfo pi(this, pain);
2292 switch (d->update_strategy_) {
2294 case NoScreenUpdate:
2295 // If no screen painting is actually needed, only some the different
2296 // coordinates of insets and paragraphs needs to be updated.
2297 pi.full_repaint = true;
2298 pi.pain.setDrawingEnabled(false);
2302 case SingleParUpdate:
2303 pi.full_repaint = false;
2304 // In general, only the current row of the outermost paragraph
2305 // will be redrawn. Particular cases where selection spans
2306 // multiple paragraph are correctly detected in TextMetrics.
2310 case DecorationUpdate:
2311 // FIXME: We should also distinguish DecorationUpdate to avoid text
2312 // drawing if possible. This is not possible to do easily right now
2313 // because of the single backing pixmap.
2315 case FullScreenUpdate:
2316 // The whole screen, including insets, will be refreshed.
2317 pi.full_repaint = true;
2319 // Clear background.
2320 pain.fillRectangle(0, 0, width_, height_,
2321 pi.backgroundColor(&buffer_.inset()));
2326 // and possibly grey out below
2327 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2328 int const y2 = lastpm.second->position() + lastpm.second->descent();
2330 pain.fillRectangle(0, y2, width_, height_ - y2, Color_bottomarea);
2333 LYXERR(Debug::PAINTING, "\n\t\t*** END DRAWING ***");
2335 // The scrollbar needs an update.
2338 // Normalize anchor for next time
2339 pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
2340 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2341 for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
2342 ParagraphMetrics const & pm = tm.parMetrics(pit);
2343 if (pm.position() + pm.descent() > 0) {
2344 d->anchor_pit_ = pit;
2345 d->anchor_ypos_ = pm.position();
2349 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
2350 << " anchor ypos = " << d->anchor_ypos_);
2354 void BufferView::message(docstring const & msg)
2357 d->gui_->message(msg);
2361 void BufferView::showDialog(string const & name)
2364 d->gui_->showDialog(name, string());
2368 void BufferView::showDialog(string const & name,
2369 string const & data, Inset * inset)
2372 d->gui_->showDialog(name, data, inset);
2376 void BufferView::updateDialog(string const & name, string const & data)
2379 d->gui_->updateDialog(name, data);
2383 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
2389 // FIXME: Move this out of BufferView again
2390 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
2392 if (!fname.isReadableFile()) {
2393 docstring const error = from_ascii(strerror(errno));
2394 docstring const file = makeDisplayPath(fname.absFilename(), 50);
2395 docstring const text =
2396 bformat(_("Could not read the specified document\n"
2397 "%1$s\ndue to the error: %2$s"), file, error);
2398 Alert::error(_("Could not read file"), text);
2402 if (!fname.isReadableFile()) {
2403 docstring const file = makeDisplayPath(fname.absFilename(), 50);
2404 docstring const text =
2405 bformat(_("%1$s\n is not readable."), file);
2406 Alert::error(_("Could not open file"), text);
2410 // FIXME UNICODE: We don't know the encoding of the file
2411 docstring file_content = fname.fileContents("UTF-8");
2412 if (file_content.empty()) {
2413 Alert::error(_("Reading not UTF-8 encoded file"),
2414 _("The file is not UTF-8 encoded.\n"
2415 "It will be read as local 8Bit-encoded.\n"
2416 "If this does not give the correct result\n"
2417 "then please change the encoding of the file\n"
2418 "to UTF-8 with a program other than LyX.\n"));
2419 file_content = fname.fileContents("local8bit");
2422 return normalize_c(file_content);
2426 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
2428 docstring const tmpstr = contentsOfPlaintextFile(f);
2433 Cursor & cur = cursor();
2434 cap::replaceSelection(cur);
2435 buffer_.undo().recordUndo(cur);
2437 cur.innerText()->insertStringAsParagraphs(cur, tmpstr);
2439 cur.innerText()->insertStringAsLines(cur, tmpstr);
2446 docstring const & BufferView::inlineCompletion() const
2448 return d->inlineCompletion_;
2452 size_t const & BufferView::inlineCompletionUniqueChars() const
2454 return d->inlineCompletionUniqueChars_;
2458 DocIterator const & BufferView::inlineCompletionPos() const
2460 return d->inlineCompletionPos_;
2464 bool samePar(DocIterator const & a, DocIterator const & b)
2466 if (a.empty() && b.empty())
2468 if (a.empty() || b.empty())
2470 if (a.depth() != b.depth())
2472 return &a.innerParagraph() == &b.innerParagraph();
2476 void BufferView::setInlineCompletion(Cursor & cur, DocIterator const & pos,
2477 docstring const & completion, size_t uniqueChars)
2479 uniqueChars = min(completion.size(), uniqueChars);
2480 bool changed = d->inlineCompletion_ != completion
2481 || d->inlineCompletionUniqueChars_ != uniqueChars;
2482 bool singlePar = true;
2483 d->inlineCompletion_ = completion;
2484 d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
2486 //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
2489 DocIterator const & old = d->inlineCompletionPos_;
2491 //lyxerr << "inlineCompletionPos changed" << std::endl;
2492 // old or pos are in another paragraph?
2493 if ((!samePar(cur, pos) && !pos.empty())
2494 || (!samePar(cur, old) && !old.empty())) {
2496 //lyxerr << "different paragraph" << std::endl;
2498 d->inlineCompletionPos_ = pos;
2503 if (singlePar && !(cur.disp_.update() & Update::Force))
2504 cur.updateFlags(cur.disp_.update() | Update::SinglePar);
2506 cur.updateFlags(cur.disp_.update() | Update::Force);