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 tmpdit = doc_iterator_begin(tmpdit.bottom().inset());
154 if (!findNextInset(tmpdit, codes, contents))
165 /// Looks for next inset with the given code
166 void findInset(DocIterator & dit, InsetCode code, bool same_content)
168 findInset(dit, vector<InsetCode>(1, code), same_content);
172 /// Moves cursor to the next inset with one of the given codes.
173 void gotoInset(BufferView * bv, vector<InsetCode> const & codes,
176 Cursor tmpcur = bv->cursor();
177 if (!findInset(tmpcur, codes, same_content)) {
178 bv->cursor().message(_("No more insets"));
182 tmpcur.clearSelection();
183 bv->setCursor(tmpcur);
188 /// Moves cursor to the next inset with given code.
189 void gotoInset(BufferView * bv, InsetCode code, bool same_content)
191 gotoInset(bv, vector<InsetCode>(1, code), same_content);
195 /// A map from a Text to the associated text metrics
196 typedef map<Text const *, TextMetrics> TextMetricsCache;
198 enum ScreenUpdateStrategy {
208 /////////////////////////////////////////////////////////////////////
212 /////////////////////////////////////////////////////////////////////
214 struct BufferView::Private
216 Private(BufferView & bv): wh_(0), cursor_(bv),
217 anchor_pit_(0), anchor_ypos_(0),
218 inlineCompletionUniqueChars_(0),
219 last_inset_(0), gui_(0)
223 ScrollbarParameters scrollbarParameters_;
225 ScreenUpdateStrategy update_strategy_;
227 CoordCache coord_cache_;
229 /// Estimated average par height for scrollbar.
231 /// this is used to handle XSelection events in the right manner.
240 pit_type anchor_pit_;
244 vector<int> par_height_;
247 DocIterator inlineCompletionPos_;
249 docstring inlineCompletion_;
251 size_t inlineCompletionUniqueChars_;
253 /// keyboard mapping object.
256 /// last visited inset.
257 /** kept to send setMouseHover(false).
258 * Not owned, so don't delete.
262 mutable TextMetricsCache text_metrics_;
265 /** Not owned, so don't delete.
267 frontend::GuiBufferViewDelegate * gui_;
269 /// Cache for Find Next
270 FuncRequest search_request_cache_;
274 BufferView::BufferView(Buffer & buf)
275 : width_(0), height_(0), full_screen_(false), buffer_(buf), d(new Private(*this))
277 d->xsel_cache_.set = false;
278 d->intl_.initKeyMapper(lyxrc.use_kbmap);
280 d->cursor_.push(buffer_.inset());
281 d->cursor_.resetAnchor();
282 d->cursor_.setCurrentFont();
284 if (graphics::Previews::status() != LyXRC::PREVIEW_OFF)
285 thePreviews().generateBufferPreviews(buffer_);
289 BufferView::~BufferView()
291 // current buffer is going to be switched-off, save cursor pos
292 // Ideally, the whole cursor stack should be saved, but session
293 // currently can only handle bottom (whole document) level pit and pos.
294 // That is to say, if a cursor is in a nested inset, it will be
295 // restore to the left of the top level inset.
296 LastFilePosSection::FilePos fp;
297 fp.pit = d->cursor_.bottom().pit();
298 fp.pos = d->cursor_.bottom().pos();
299 theSession().lastFilePos().save(buffer_.fileName(), fp);
305 int BufferView::rightMargin() const
307 // The additional test for the case the outliner is opened.
309 !lyxrc.full_screen_limit ||
310 width_ < lyxrc.full_screen_width + 20)
313 return (width_ - lyxrc.full_screen_width) / 2;
317 int BufferView::leftMargin() const
319 return rightMargin();
323 bool BufferView::isTopScreen() const
325 return d->scrollbarParameters_.position == d->scrollbarParameters_.min;
329 bool BufferView::isBottomScreen() const
331 return d->scrollbarParameters_.position == d->scrollbarParameters_.max;
335 Intl & BufferView::getIntl()
341 Intl const & BufferView::getIntl() const
347 CoordCache & BufferView::coordCache()
349 return d->coord_cache_;
353 CoordCache const & BufferView::coordCache() const
355 return d->coord_cache_;
359 Buffer & BufferView::buffer()
365 Buffer const & BufferView::buffer() const
371 bool BufferView::fitCursor()
373 if (cursorStatus(d->cursor_) == CUR_INSIDE) {
374 frontend::FontMetrics const & fm =
375 theFontMetrics(d->cursor_.getFont().fontInfo());
376 int const asc = fm.maxAscent();
377 int const des = fm.maxDescent();
378 Point const p = getPos(d->cursor_, d->cursor_.boundary());
379 if (p.y_ - asc >= 0 && p.y_ + des < height_)
386 void BufferView::processUpdateFlags(Update::flags flags)
388 // last_inset_ points to the last visited inset. This pointer may become
389 // invalid because of keyboard editing. Since all such operations
390 // causes screen update(), I reset last_inset_ to avoid such a problem.
392 // This is close to a hot-path.
393 LYXERR(Debug::DEBUG, "BufferView::processUpdateFlags()"
394 << "[fitcursor = " << (flags & Update::FitCursor)
395 << ", forceupdate = " << (flags & Update::Force)
396 << ", singlepar = " << (flags & Update::SinglePar)
397 << "] buffer: " << &buffer_);
399 buffer_.updateMacros();
401 // Now do the first drawing step if needed. This consists on updating
402 // the CoordCache in updateMetrics().
403 // The second drawing step is done in WorkArea::redraw() if needed.
405 // Case when no explicit update is requested.
407 // no need to redraw anything.
408 d->update_strategy_ = NoScreenUpdate;
412 if (flags == Update::Decoration) {
413 d->update_strategy_ = DecorationUpdate;
418 if (flags == Update::FitCursor
419 || flags == (Update::Decoration | Update::FitCursor)) {
420 // tell the frontend to update the screen if needed.
425 if (flags & Update::Decoration) {
426 d->update_strategy_ = DecorationUpdate;
430 // no screen update is needed.
431 d->update_strategy_ = NoScreenUpdate;
435 bool const full_metrics = flags & Update::Force || !singleParUpdate();
438 // We have to update the full screen metrics.
441 if (!(flags & Update::FitCursor)) {
442 // Nothing to do anymore. Trigger a redraw and return
447 // updateMetrics() does not update paragraph position
448 // This is done at draw() time. So we need a redraw!
452 // The cursor is off screen so ensure it is visible.
459 void BufferView::updateScrollbar()
461 if (height_ == 0 && width_ == 0)
464 // We prefer fixed size line scrolling.
465 d->scrollbarParameters_.single_step = defaultRowHeight();
466 // We prefer full screen page scrolling.
467 d->scrollbarParameters_.page_step = height_;
469 Text & t = buffer_.text();
470 TextMetrics & tm = d->text_metrics_[&t];
472 LYXERR(Debug::GUI, " Updating scrollbar: height: "
473 << t.paragraphs().size()
474 << " curr par: " << d->cursor_.bottom().pit()
475 << " default height " << defaultRowHeight());
477 size_t const parsize = t.paragraphs().size();
478 if (d->par_height_.size() != parsize) {
479 d->par_height_.clear();
480 // FIXME: We assume a default paragraph height of 2 rows. This
481 // should probably be pondered with the screen width.
482 d->par_height_.resize(parsize, defaultRowHeight() * 2);
485 // Look at paragraph heights on-screen
486 pair<pit_type, ParagraphMetrics const *> first = tm.first();
487 pair<pit_type, ParagraphMetrics const *> last = tm.last();
488 for (pit_type pit = first.first; pit <= last.first; ++pit) {
489 d->par_height_[pit] = tm.parMetrics(pit).height();
490 LYXERR(Debug::SCROLLING, "storing height for pit " << pit << " : "
491 << d->par_height_[pit]);
494 int top_pos = first.second->position() - first.second->ascent();
495 int bottom_pos = last.second->position() + last.second->descent();
496 bool first_visible = first.first == 0 && top_pos >= 0;
497 bool last_visible = last.first + 1 == int(parsize) && bottom_pos <= height_;
498 if (first_visible && last_visible) {
499 d->scrollbarParameters_.min = 0;
500 d->scrollbarParameters_.max = 0;
504 d->scrollbarParameters_.min = top_pos;
505 for (size_t i = 0; i != size_t(first.first); ++i)
506 d->scrollbarParameters_.min -= d->par_height_[i];
507 d->scrollbarParameters_.max = bottom_pos;
508 for (size_t i = last.first + 1; i != parsize; ++i)
509 d->scrollbarParameters_.max += d->par_height_[i];
511 d->scrollbarParameters_.position = 0;
512 // The reference is the top position so we remove one page.
513 d->scrollbarParameters_.max -= d->scrollbarParameters_.page_step;
517 ScrollbarParameters const & BufferView::scrollbarParameters() const
519 return d->scrollbarParameters_;
523 docstring BufferView::toolTip(int x, int y) const
525 // Get inset under mouse, if there is one.
526 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
528 // No inset, no tooltip...
530 return covering_inset->toolTip(*this, x, y);
534 docstring BufferView::contextMenu(int x, int y) const
536 //If there is a selection, return the containing inset menu
537 if (d->cursor_.selection())
538 return d->cursor_.inset().contextMenu(*this, x, y);
540 // Get inset under mouse, if there is one.
541 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
543 return covering_inset->contextMenu(*this, x, y);
545 return buffer_.inset().contextMenu(*this, x, y);
549 void BufferView::scrollDocView(int value)
551 int const offset = value - d->scrollbarParameters_.position;
552 // If the offset is less than 2 screen height, prefer to scroll instead.
553 if (abs(offset) <= 2 * height_) {
560 // cut off at the top
561 if (value <= d->scrollbarParameters_.min) {
562 DocIterator dit = doc_iterator_begin(buffer_.inset());
564 LYXERR(Debug::SCROLLING, "scroll to top");
568 // cut off at the bottom
569 if (value >= d->scrollbarParameters_.max) {
570 DocIterator dit = doc_iterator_end(buffer_.inset());
573 LYXERR(Debug::SCROLLING, "scroll to bottom");
577 // find paragraph at target position
578 int par_pos = d->scrollbarParameters_.min;
580 for (; i != int(d->par_height_.size()); ++i) {
581 par_pos += d->par_height_[i];
582 if (par_pos >= value)
586 if (par_pos < value) {
587 // It seems we didn't find the correct pit so stay on the safe side and
589 LYXERR0("scrolling position not found!");
590 scrollDocView(d->scrollbarParameters_.max);
594 DocIterator dit = doc_iterator_begin(buffer_.inset());
596 LYXERR(Debug::SCROLLING, "value = " << value << " -> scroll to pit " << i);
601 // FIXME: this method is not working well.
602 void BufferView::setCursorFromScrollbar()
604 TextMetrics & tm = d->text_metrics_[&buffer_.text()];
606 int const height = 2 * defaultRowHeight();
607 int const first = height;
608 int const last = height_ - height;
610 Cursor const & oldcur = d->cursor_;
612 switch (cursorStatus(oldcur)) {
620 int const y = getPos(oldcur, oldcur.boundary()).y_;
621 newy = min(last, max(y, first));
625 // We reset the cursor because cursorStatus() does not
626 // work when the cursor is within mathed.
628 cur.reset(buffer_.inset());
629 tm.setCursorFromCoordinates(cur, 0, newy);
634 Change const BufferView::getCurrentChange() const
636 if (!d->cursor_.selection())
637 return Change(Change::UNCHANGED);
639 DocIterator dit = d->cursor_.selectionBegin();
640 return dit.paragraph().lookupChange(dit.pos());
644 // this could be used elsewhere as well?
645 // FIXME: This does not work within mathed!
646 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
648 Point const p = getPos(dit, dit.boundary());
651 if (p.y_ > workHeight())
657 void BufferView::saveBookmark(unsigned int idx)
659 // tenatively save bookmark, id and pos will be used to
660 // acturately locate a bookmark in a 'live' lyx session.
661 // pit and pos will be updated with bottom level pit/pos
663 theSession().bookmarks().save(
665 d->cursor_.bottom().pit(),
666 d->cursor_.bottom().pos(),
667 d->cursor_.paragraph().id(),
672 // emit message signal.
673 message(_("Save bookmark"));
677 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
678 int top_id, pos_type top_pos)
680 bool success = false;
683 d->cursor_.clearSelection();
685 // if a valid par_id is given, try it first
686 // This is the case for a 'live' bookmark when unique paragraph ID
687 // is used to track bookmarks.
689 dit = buffer_.getParFromID(top_id);
691 dit.pos() = min(dit.paragraph().size(), top_pos);
692 // Some slices of the iterator may not be
693 // reachable (e.g. closed collapsable inset)
694 // so the dociterator may need to be
695 // shortened. Otherwise, setCursor may crash
696 // lyx when the cursor can not be set to these
698 size_t const n = dit.depth();
699 for (size_t i = 0; i < n; ++i)
700 if (dit[i].inset().editable() != Inset::HIGHLY_EDITABLE) {
708 // if top_id == 0, or searching through top_id failed
709 // This is the case for a 'restored' bookmark when only bottom
710 // (document level) pit was saved. Because of this, bookmark
711 // restoration is inaccurate. If a bookmark was within an inset,
712 // it will be restored to the left of the outmost inset that contains
714 if (bottom_pit < int(buffer_.paragraphs().size())) {
715 dit = doc_iterator_begin(buffer_.inset());
717 dit.pit() = bottom_pit;
718 dit.pos() = min(bottom_pos, dit.paragraph().size());
723 // Note: only bottom (document) level pit is set.
725 // set the current font.
726 d->cursor_.setCurrentFont();
727 // To center the screen on this new position we need the
728 // paragraph position which is computed at draw() time.
729 // So we need a redraw!
739 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
741 if (lyxrc.rtl_support) {
742 if (d->cursor_.real_current_font.isRightToLeft()) {
743 if (d->intl_.keymap == Intl::PRIMARY)
744 d->intl_.keyMapSec();
746 if (d->intl_.keymap == Intl::SECONDARY)
747 d->intl_.keyMapPrim();
751 d->intl_.getTransManager().translateAndInsert(c, t, cur);
755 int BufferView::workWidth() const
761 void BufferView::showCursor()
763 showCursor(d->cursor_);
767 void BufferView::showCursor(DocIterator const & dit)
769 // We are not properly started yet, delay until resizing is
774 LYXERR(Debug::SCROLLING, "recentering!");
776 CursorSlice const & bot = dit.bottom();
777 TextMetrics & tm = d->text_metrics_[bot.text()];
779 pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
780 int bot_pit = bot.pit();
781 if (bot_pit > max_pit) {
782 // FIXME: Why does this happen?
783 LYXERR0("bottom pit is greater that max pit: "
784 << bot_pit << " > " << max_pit);
788 if (bot_pit == tm.first().first - 1)
789 tm.newParMetricsUp();
790 else if (bot_pit == tm.last().first + 1)
791 tm.newParMetricsDown();
793 if (tm.contains(bot_pit)) {
794 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
795 LASSERT(!pm.rows().empty(), /**/);
796 // FIXME: smooth scrolling doesn't work in mathed.
797 CursorSlice const & cs = dit.innerTextSlice();
798 int offset = coordOffset(dit, dit.boundary()).y_;
799 int ypos = pm.position() + offset;
800 Dimension const & row_dim =
801 pm.getRow(cs.pos(), dit.boundary()).dimension();
803 if (ypos - row_dim.ascent() < 0)
804 scrolled = scrollUp(- ypos + row_dim.ascent());
805 else if (ypos + row_dim.descent() > height_)
806 scrolled = scrollDown(ypos - height_ + row_dim.descent());
807 // else, nothing to do, the cursor is already visible so we just return.
815 // fix inline completion position
816 if (d->inlineCompletionPos_.fixIfBroken())
817 d->inlineCompletionPos_ = DocIterator();
819 tm.redoParagraph(bot_pit);
820 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
821 int offset = coordOffset(dit, dit.boundary()).y_;
823 d->anchor_pit_ = bot_pit;
824 CursorSlice const & cs = dit.innerTextSlice();
825 Dimension const & row_dim =
826 pm.getRow(cs.pos(), dit.boundary()).dimension();
828 if (d->anchor_pit_ == 0)
829 d->anchor_ypos_ = offset + pm.ascent();
830 else if (d->anchor_pit_ == max_pit)
831 d->anchor_ypos_ = height_ - offset - row_dim.descent();
833 d->anchor_ypos_ = defaultRowHeight() * 2 - offset - row_dim.descent();
840 FuncStatus BufferView::getStatus(FuncRequest const & cmd)
844 Cursor & cur = d->cursor_;
846 switch (cmd.action) {
849 flag.setEnabled(buffer_.undo().hasUndoStack());
852 flag.setEnabled(buffer_.undo().hasRedoStack());
854 case LFUN_FILE_INSERT:
855 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
856 case LFUN_FILE_INSERT_PLAINTEXT:
857 case LFUN_BOOKMARK_SAVE:
858 // FIXME: Actually, these LFUNS should be moved to Text
859 flag.setEnabled(cur.inTexted());
861 case LFUN_FONT_STATE:
862 case LFUN_LABEL_INSERT:
863 case LFUN_INFO_INSERT:
864 case LFUN_INSET_EDIT:
865 case LFUN_PARAGRAPH_GOTO:
867 case LFUN_REFERENCE_NEXT:
869 case LFUN_WORD_REPLACE:
872 case LFUN_MARK_TOGGLE:
873 case LFUN_SCREEN_RECENTER:
874 case LFUN_BIBTEX_DATABASE_ADD:
875 case LFUN_BIBTEX_DATABASE_DEL:
876 case LFUN_GRAPHICS_GROUPS_UNIFY:
877 case LFUN_NOTES_MUTATE:
878 case LFUN_ALL_INSETS_TOGGLE:
879 case LFUN_STATISTICS:
880 flag.setEnabled(true);
883 case LFUN_NEXT_INSET_TOGGLE:
884 case LFUN_NEXT_INSET_MODIFY: {
885 // this is the real function we want to invoke
886 FuncRequest tmpcmd = cmd;
887 tmpcmd.action = (cmd.action == LFUN_NEXT_INSET_TOGGLE)
888 ? LFUN_INSET_TOGGLE : LFUN_INSET_MODIFY;
889 // if there is an inset at cursor, see whether it
890 // handles the lfun, other start from scratch
891 Inset * inset = cur.nextInset();
892 if (!inset || !inset->getStatus(cur, tmpcmd, flag))
893 flag = lyx::getStatus(tmpcmd);
897 case LFUN_LABEL_GOTO: {
898 flag.setEnabled(!cmd.argument().empty()
899 || getInsetByCode<InsetRef>(cur, REF_CODE));
903 case LFUN_CHANGES_TRACK:
904 flag.setEnabled(true);
905 flag.setOnOff(buffer_.params().trackChanges);
908 case LFUN_CHANGES_OUTPUT:
909 flag.setEnabled(true);
910 flag.setOnOff(buffer_.params().outputChanges);
913 case LFUN_CHANGES_MERGE:
914 case LFUN_CHANGE_NEXT:
915 case LFUN_ALL_CHANGES_ACCEPT:
916 case LFUN_ALL_CHANGES_REJECT:
917 // TODO: context-sensitive enabling of LFUNs
918 // In principle, these command should only be enabled if there
919 // is a change in the document. However, without proper
920 // optimizations, this will inevitably result in poor performance.
921 flag.setEnabled(true);
924 case LFUN_BUFFER_TOGGLE_COMPRESSION: {
925 flag.setOnOff(buffer_.params().compressed);
930 case LFUN_SCREEN_DOWN:
932 case LFUN_SCREEN_UP_SELECT:
933 case LFUN_SCREEN_DOWN_SELECT:
934 flag.setEnabled(true);
937 case LFUN_LAYOUT_TABULAR:
938 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
942 flag.setEnabled(!cur.inset().forcePlainLayout(cur.idx()));
945 case LFUN_LAYOUT_PARAGRAPH:
946 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
949 case LFUN_INSET_SETTINGS: {
950 InsetCode code = cur.inset().lyxCode();
951 if (cmd.getArg(0) == insetName(code)) {
952 flag.setEnabled(true);
956 InsetCode next_code = cur.nextInset()
957 ? cur.nextInset()->lyxCode() : NO_CODE;
958 //FIXME: remove these special cases:
968 enable = (cmd.argument().empty() ||
969 cmd.getArg(0) == insetName(next_code));
974 flag.setEnabled(enable);
978 case LFUN_DIALOG_SHOW_NEW_INSET:
979 flag.setEnabled(cur.inset().lyxCode() != ERT_CODE &&
980 cur.inset().lyxCode() != LISTINGS_CODE);
981 if (cur.inset().lyxCode() == CAPTION_CODE) {
983 if (cur.inset().getStatus(cur, cmd, flag))
988 case LFUN_BRANCH_ACTIVATE:
989 case LFUN_BRANCH_DEACTIVATE: {
991 docstring const branchName = cmd.argument();
992 if (!branchName.empty())
993 enable = buffer_.params().branchlist().find(branchName);
994 flag.setEnabled(enable);
999 flag.setEnabled(false);
1006 bool BufferView::dispatch(FuncRequest const & cmd)
1008 //lyxerr << [ cmd = " << cmd << "]" << endl;
1010 // Make sure that the cached BufferView is correct.
1011 LYXERR(Debug::ACTION, " action[" << cmd.action << ']'
1012 << " arg[" << to_utf8(cmd.argument()) << ']'
1013 << " x[" << cmd.x << ']'
1014 << " y[" << cmd.y << ']'
1015 << " button[" << cmd.button() << ']');
1017 Cursor & cur = d->cursor_;
1019 switch (cmd.action) {
1022 cur.message(_("Undo"));
1023 cur.clearSelection();
1024 if (!cur.textUndo())
1025 cur.message(_("No further undo information"));
1027 processUpdateFlags(Update::Force | Update::FitCursor);
1031 cur.message(_("Redo"));
1032 cur.clearSelection();
1033 if (!cur.textRedo())
1034 cur.message(_("No further redo information"));
1036 processUpdateFlags(Update::Force | Update::FitCursor);
1039 case LFUN_FONT_STATE:
1040 cur.message(cur.currentState());
1043 case LFUN_BOOKMARK_SAVE:
1044 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1047 case LFUN_LABEL_GOTO: {
1048 docstring label = cmd.argument();
1049 if (label.empty()) {
1051 getInsetByCode<InsetRef>(d->cursor_,
1054 label = inset->getParam("reference");
1055 // persistent=false: use temp_bookmark
1065 case LFUN_INSET_EDIT: {
1066 FuncRequest fr(cmd);
1067 // if there is an inset at cursor, see whether it
1069 Inset * inset = cur.nextInset();
1071 inset->dispatch(cur, fr);
1072 // if it did not work, try the underlying inset.
1073 if (!inset || !cur.result().dispatched())
1076 // FIXME I'm adding the last break to solve a crash,
1077 // but that is obviously not right.
1078 if (!cur.result().dispatched())
1079 // It did not work too; no action needed.
1084 case LFUN_PARAGRAPH_GOTO: {
1085 int const id = convert<int>(cmd.getArg(0));
1086 int const pos = convert<int>(cmd.getArg(1));
1088 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1089 b = theBufferList().next(b)) {
1091 DocIterator dit = b->getParFromID(id);
1093 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1097 LYXERR(Debug::INFO, "Paragraph " << dit.paragraph().id()
1098 << " found in buffer `"
1099 << b->absFileName() << "'.");
1101 if (b == &buffer_) {
1105 processUpdateFlags(Update::Force | Update::FitCursor);
1107 // Switch to other buffer view and resend cmd
1108 theLyXFunc().dispatch(FuncRequest(
1109 LFUN_BUFFER_SWITCH, b->absFileName()));
1110 theLyXFunc().dispatch(cmd);
1117 case LFUN_NOTE_NEXT:
1118 gotoInset(this, NOTE_CODE, false);
1121 case LFUN_REFERENCE_NEXT: {
1122 vector<InsetCode> tmp;
1123 tmp.push_back(LABEL_CODE);
1124 tmp.push_back(REF_CODE);
1125 gotoInset(this, tmp, true);
1129 case LFUN_CHANGES_TRACK:
1130 buffer_.params().trackChanges = !buffer_.params().trackChanges;
1133 case LFUN_CHANGES_OUTPUT:
1134 buffer_.params().outputChanges = !buffer_.params().outputChanges;
1135 if (buffer_.params().outputChanges) {
1136 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1137 bool xcolorsoul = LaTeXFeatures::isAvailable("soul") &&
1138 LaTeXFeatures::isAvailable("xcolor");
1140 if (!dvipost && !xcolorsoul) {
1141 Alert::warning(_("Changes not shown in LaTeX output"),
1142 _("Changes will not be highlighted in LaTeX output, "
1143 "because neither dvipost nor xcolor/soul are installed.\n"
1144 "Please install these packages or redefine "
1145 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1146 } else if (!xcolorsoul) {
1147 Alert::warning(_("Changes not shown in LaTeX output"),
1148 _("Changes will not be highlighted in LaTeX output "
1149 "when using pdflatex, because xcolor and soul are not installed.\n"
1150 "Please install both packages or redefine "
1151 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1156 case LFUN_CHANGE_NEXT:
1157 findNextChange(this);
1160 case LFUN_CHANGES_MERGE:
1161 if (findNextChange(this))
1162 showDialog("changes");
1165 case LFUN_ALL_CHANGES_ACCEPT:
1166 // select complete document
1167 d->cursor_.reset(buffer_.inset());
1168 d->cursor_.selHandle(true);
1169 buffer_.text().cursorBottom(d->cursor_);
1170 // accept everything in a single step to support atomic undo
1171 buffer_.text().acceptOrRejectChanges(d->cursor_, Text::ACCEPT);
1172 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1173 processUpdateFlags(Update::Force | Update::FitCursor);
1176 case LFUN_ALL_CHANGES_REJECT:
1177 // select complete document
1178 d->cursor_.reset(buffer_.inset());
1179 d->cursor_.selHandle(true);
1180 buffer_.text().cursorBottom(d->cursor_);
1181 // reject everything in a single step to support atomic undo
1182 // Note: reject does not work recursively; the user may have to repeat the operation
1183 buffer_.text().acceptOrRejectChanges(d->cursor_, Text::REJECT);
1184 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1185 processUpdateFlags(Update::Force | Update::FitCursor);
1188 case LFUN_WORD_FIND: {
1189 FuncRequest req = cmd;
1190 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1191 req = d->search_request_cache_;
1192 if (find(this, req))
1195 message(_("String not found!"));
1196 d->search_request_cache_ = req;
1200 case LFUN_WORD_REPLACE: {
1201 bool has_deleted = false;
1202 if (cur.selection()) {
1203 DocIterator beg = cur.selectionBegin();
1204 DocIterator end = cur.selectionEnd();
1205 if (beg.pit() == end.pit()) {
1206 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1207 if (cur.paragraph().isDeleted(p))
1212 replace(this, cmd, has_deleted);
1217 cur.clearSelection();
1219 cur.message(from_utf8(N_("Mark off")));
1223 cur.clearSelection();
1226 cur.message(from_utf8(N_("Mark on")));
1229 case LFUN_MARK_TOGGLE:
1230 cur.clearSelection();
1233 cur.message(from_utf8(N_("Mark removed")));
1236 cur.message(from_utf8(N_("Mark set")));
1241 case LFUN_SCREEN_RECENTER:
1245 case LFUN_BIBTEX_DATABASE_ADD: {
1246 Cursor tmpcur = d->cursor_;
1247 findInset(tmpcur, BIBTEX_CODE, false);
1248 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1251 if (inset->addDatabase(cmd.argument()))
1252 buffer_.updateBibfilesCache();
1257 case LFUN_BIBTEX_DATABASE_DEL: {
1258 Cursor tmpcur = d->cursor_;
1259 findInset(tmpcur, BIBTEX_CODE, false);
1260 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1263 if (inset->delDatabase(cmd.argument()))
1264 buffer_.updateBibfilesCache();
1269 case LFUN_STATISTICS: {
1270 DocIterator from, to;
1271 if (cur.selection()) {
1272 from = cur.selectionBegin();
1273 to = cur.selectionEnd();
1275 from = doc_iterator_begin(buffer_.inset());
1276 to = doc_iterator_end(buffer_.inset());
1278 int const words = countWords(from, to);
1279 int const chars = countChars(from, to, false);
1280 int const chars_blanks = countChars(from, to, true);
1282 if (cur.selection())
1283 message = _("Statistics for the selection:");
1285 message = _("Statistics for the document:");
1288 message += bformat(_("%1$d words"), words);
1290 message += _("One word");
1292 if (chars_blanks != 1)
1293 message += bformat(_("%1$d characters (including blanks)"),
1296 message += _("One character (including blanks)");
1299 message += bformat(_("%1$d characters (excluding blanks)"),
1302 message += _("One character (excluding blanks)");
1304 Alert::information(_("Statistics"), message);
1308 case LFUN_BUFFER_TOGGLE_COMPRESSION:
1309 // turn compression on/off
1310 buffer_.params().compressed = !buffer_.params().compressed;
1313 case LFUN_NEXT_INSET_TOGGLE: {
1314 // create the the real function we want to invoke
1315 FuncRequest tmpcmd = cmd;
1316 tmpcmd.action = LFUN_INSET_TOGGLE;
1317 // if there is an inset at cursor, see whether it
1319 Inset * inset = cur.nextInset();
1321 if (inset->isActive()) {
1322 Cursor tmpcur = cur;
1323 tmpcur.pushBackward(*inset);
1324 inset->dispatch(tmpcur, tmpcmd);
1325 if (tmpcur.result().dispatched())
1328 inset->dispatch(cur, tmpcmd);
1330 // if it did not work, try the underlying inset.
1331 if (!inset || !cur.result().dispatched())
1332 cur.dispatch(tmpcmd);
1334 if (!cur.result().dispatched())
1335 // It did not work too; no action needed.
1337 cur.clearSelection();
1338 processUpdateFlags(Update::SinglePar | Update::FitCursor);
1342 case LFUN_NEXT_INSET_MODIFY: {
1343 // create the the real function we want to invoke
1344 FuncRequest tmpcmd = cmd;
1345 tmpcmd.action = LFUN_INSET_MODIFY;
1346 // if there is an inset at cursor, see whether it
1348 Inset * inset = cur.nextInset();
1350 inset->dispatch(cur, tmpcmd);
1351 // if it did not work, try the underlying inset.
1352 if (!inset || !cur.result().dispatched())
1353 cur.dispatch(tmpcmd);
1355 if (!cur.result().dispatched())
1356 // It did not work too; no action needed.
1358 cur.clearSelection();
1359 processUpdateFlags(Update::Force | Update::FitCursor);
1363 case LFUN_SCREEN_UP:
1364 case LFUN_SCREEN_DOWN: {
1365 Point p = getPos(cur, cur.boundary());
1366 if (p.y_ < 0 || p.y_ > height_) {
1367 // The cursor is off-screen so recenter before proceeding.
1369 p = getPos(cur, cur.boundary());
1371 int const scrolled = scroll(cmd.action == LFUN_SCREEN_UP
1372 ? - height_ : height_);
1373 if (cmd.action == LFUN_SCREEN_UP && scrolled > - height_)
1375 if (cmd.action == LFUN_SCREEN_DOWN && scrolled < height_)
1376 p = Point(width_, height_);
1377 cur.reset(buffer_.inset());
1380 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_);
1381 //FIXME: what to do with cur.x_target()?
1390 case LFUN_SCREEN_UP_SELECT: {
1391 cur.selHandle(true);
1392 if (isTopScreen()) {
1393 lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1397 int y = getPos(cur, cur.boundary()).y_;
1398 int const ymin = y - height_ + defaultRowHeight();
1399 while (y > ymin && cur.up())
1400 y = getPos(cur, cur.boundary()).y_;
1403 processUpdateFlags(Update::SinglePar | Update::FitCursor);
1407 case LFUN_SCREEN_DOWN_SELECT: {
1408 cur.selHandle(true);
1409 if (isBottomScreen()) {
1410 lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1414 int y = getPos(cur, cur.boundary()).y_;
1415 int const ymax = y + height_ - defaultRowHeight();
1416 while (y < ymax && cur.down())
1417 y = getPos(cur, cur.boundary()).y_;
1420 processUpdateFlags(Update::SinglePar | Update::FitCursor);
1424 case LFUN_BRANCH_ACTIVATE:
1425 case LFUN_BRANCH_DEACTIVATE:
1426 buffer_.dispatch(cmd);
1427 processUpdateFlags(Update::Force);
1430 // These two could be rewriten using some command like forall <insetname> <command>
1431 // once the insets refactoring is done.
1432 case LFUN_GRAPHICS_GROUPS_UNIFY: {
1433 if (cmd.argument().empty())
1435 graphics::unifyGraphicsGroups(cur.buffer(), to_utf8(cmd.argument()));
1436 processUpdateFlags(Update::Force | Update::FitCursor);
1440 case LFUN_NOTES_MUTATE: {
1441 if (cmd.argument().empty())
1444 if (mutateNotes(cur, cmd.getArg(0), cmd.getArg(1))) {
1445 processUpdateFlags(Update::Force);
1450 case LFUN_ALL_INSETS_TOGGLE: {
1452 string const name = split(to_utf8(cmd.argument()), action, ' ');
1453 InsetCode const inset_code = insetCode(name);
1455 FuncRequest fr(LFUN_INSET_TOGGLE, action);
1457 Inset & inset = cur.buffer().inset();
1458 InsetIterator it = inset_iterator_begin(inset);
1459 InsetIterator const end = inset_iterator_end(inset);
1460 for (; it != end; ++it) {
1461 if (it->asInsetCollapsable()
1462 && (inset_code == NO_CODE
1463 || inset_code == it->lyxCode())) {
1464 Cursor tmpcur = cur;
1465 tmpcur.pushBackward(*it);
1466 it->dispatch(tmpcur, fr);
1469 processUpdateFlags(Update::Force | Update::FitCursor);
1481 docstring const BufferView::requestSelection()
1483 Cursor & cur = d->cursor_;
1485 LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
1486 if (!cur.selection()) {
1487 d->xsel_cache_.set = false;
1491 LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
1492 if (!d->xsel_cache_.set ||
1493 cur.top() != d->xsel_cache_.cursor ||
1494 cur.anchor_.top() != d->xsel_cache_.anchor)
1496 d->xsel_cache_.cursor = cur.top();
1497 d->xsel_cache_.anchor = cur.anchor_.top();
1498 d->xsel_cache_.set = cur.selection();
1499 return cur.selectionAsString(false);
1505 void BufferView::clearSelection()
1507 d->cursor_.clearSelection();
1508 // Clear the selection buffer. Otherwise a subsequent
1509 // middle-mouse-button paste would use the selection buffer,
1510 // not the more current external selection.
1511 cap::clearSelection();
1512 d->xsel_cache_.set = false;
1513 // The buffer did not really change, but this causes the
1514 // redraw we need because we cleared the selection above.
1519 void BufferView::resize(int width, int height)
1521 // Update from work area
1525 // Clear the paragraph height cache.
1526 d->par_height_.clear();
1527 // Redo the metrics.
1532 Inset const * BufferView::getCoveringInset(Text const & text,
1535 TextMetrics & tm = d->text_metrics_[&text];
1536 Inset * inset = tm.checkInsetHit(x, y);
1540 if (!inset->descendable())
1541 // No need to go further down if the inset is not
1545 size_t cell_number = inset->nargs();
1546 // Check all the inner cell.
1547 for (size_t i = 0; i != cell_number; ++i) {
1548 Text const * inner_text = inset->getText(i);
1551 Inset const * inset_deeper =
1552 getCoveringInset(*inner_text, x, y);
1554 return inset_deeper;
1562 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
1564 //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
1566 // This is only called for mouse related events including
1567 // LFUN_FILE_OPEN generated by drag-and-drop.
1568 FuncRequest cmd = cmd0;
1570 Cursor old = cursor();
1572 cur.push(buffer_.inset());
1573 cur.selection() = d->cursor_.selection();
1575 // Either the inset under the cursor or the
1576 // surrounding Text will handle this event.
1578 // make sure we stay within the screen...
1579 cmd.y = min(max(cmd.y, -1), height_);
1581 if (cmd.action == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
1583 // Get inset under mouse, if there is one.
1584 Inset const * covering_inset =
1585 getCoveringInset(buffer_.text(), cmd.x, cmd.y);
1586 if (covering_inset == d->last_inset_)
1587 // Same inset, no need to do anything...
1590 bool need_redraw = false;
1591 // const_cast because of setMouseHover().
1592 Inset * inset = const_cast<Inset *>(covering_inset);
1594 // Remove the hint on the last hovered inset (if any).
1595 need_redraw |= d->last_inset_->setMouseHover(false);
1597 // Highlighted the newly hovered inset (if any).
1598 need_redraw |= inset->setMouseHover(true);
1599 d->last_inset_ = inset;
1603 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
1604 << cmd.x << ", " << cmd.y << ")");
1606 d->update_strategy_ = DecorationUpdate;
1608 // This event (moving without mouse click) is not passed further.
1609 // This should be changed if it is further utilized.
1614 // Build temporary cursor.
1615 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x, cmd.y);
1617 // Put anchor at the same position.
1620 cur.beginUndoGroup();
1622 // Try to dispatch to an non-editable inset near this position
1623 // via the temp cursor. If the inset wishes to change the real
1624 // cursor it has to do so explicitly by using
1625 // cur.bv().cursor() = cur; (or similar)
1627 inset->dispatch(cur, cmd);
1629 // Now dispatch to the temporary cursor. If the real cursor should
1630 // be modified, the inset's dispatch has to do so explicitly.
1631 if (!inset || !cur.result().dispatched())
1636 // Notify left insets
1639 bool badcursor = notifyCursorLeaves(old, cur);
1641 cursor().fixIfBroken();
1644 // Do we have a selection?
1645 theSelection().haveSelection(cursor().selection());
1647 // If the command has been dispatched,
1648 if (cur.result().dispatched() || cur.result().update())
1649 processUpdateFlags(cur.result().update());
1653 void BufferView::lfunScroll(FuncRequest const & cmd)
1655 string const scroll_type = cmd.getArg(0);
1656 int const scroll_step =
1657 (scroll_type == "line") ? d->scrollbarParameters_.single_step
1658 : (scroll_type == "page") ? d->scrollbarParameters_.page_step : 0;
1659 if (scroll_step == 0)
1661 string const scroll_quantity = cmd.getArg(1);
1662 if (scroll_quantity == "up")
1663 scrollUp(scroll_step);
1664 else if (scroll_quantity == "down")
1665 scrollDown(scroll_step);
1667 int const scroll_value = convert<int>(scroll_quantity);
1669 scroll(scroll_step * scroll_value);
1676 int BufferView::scroll(int y)
1679 return scrollDown(y);
1681 return scrollUp(-y);
1686 int BufferView::scrollDown(int offset)
1688 Text * text = &buffer_.text();
1689 TextMetrics & tm = d->text_metrics_[text];
1690 int ymax = height_ + offset;
1692 pair<pit_type, ParagraphMetrics const *> last = tm.last();
1693 int bottom_pos = last.second->position() + last.second->descent();
1694 if (last.first + 1 == int(text->paragraphs().size())) {
1695 if (bottom_pos <= height_)
1697 offset = min(offset, bottom_pos - height_);
1700 if (bottom_pos > ymax)
1702 tm.newParMetricsDown();
1704 d->anchor_ypos_ -= offset;
1709 int BufferView::scrollUp(int offset)
1711 Text * text = &buffer_.text();
1712 TextMetrics & tm = d->text_metrics_[text];
1713 int ymin = - offset;
1715 pair<pit_type, ParagraphMetrics const *> first = tm.first();
1716 int top_pos = first.second->position() - first.second->ascent();
1717 if (first.first == 0) {
1720 offset = min(offset, - top_pos);
1725 tm.newParMetricsUp();
1727 d->anchor_ypos_ += offset;
1732 void BufferView::setCursorFromRow(int row)
1737 buffer_.texrow().getIdFromRow(row, tmpid, tmppos);
1739 d->cursor_.reset(buffer_.inset());
1741 buffer_.text().setCursor(d->cursor_, 0, 0);
1743 buffer_.text().setCursor(d->cursor_, buffer_.getParFromID(tmpid).pit(), tmppos);
1747 bool BufferView::setCursorFromInset(Inset const * inset)
1749 // are we already there?
1750 if (cursor().nextInset() == inset)
1753 // Inset is not at cursor position. Find it in the document.
1755 cur.reset(buffer().inset());
1758 while (cur && cur.nextInset() != inset);
1768 void BufferView::gotoLabel(docstring const & label)
1770 Toc & toc = buffer().tocBackend().toc("label");
1771 TocIterator toc_it = toc.begin();
1772 TocIterator end = toc.end();
1773 for (; toc_it != end; ++toc_it) {
1774 if (label == toc_it->str())
1775 dispatch(toc_it->action());
1777 //FIXME: We could do a bit more searching thanks to this:
1778 //InsetLabel const * inset = buffer_.insetLabel(label);
1782 TextMetrics const & BufferView::textMetrics(Text const * t) const
1784 return const_cast<BufferView *>(this)->textMetrics(t);
1788 TextMetrics & BufferView::textMetrics(Text const * t)
1790 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
1791 if (tmc_it == d->text_metrics_.end()) {
1792 tmc_it = d->text_metrics_.insert(
1793 make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
1795 return tmc_it->second;
1799 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
1802 return textMetrics(t).parMetrics(pit);
1806 int BufferView::workHeight() const
1812 void BufferView::setCursor(DocIterator const & dit)
1814 size_t const n = dit.depth();
1815 for (size_t i = 0; i < n; ++i)
1816 dit[i].inset().edit(d->cursor_, true);
1818 d->cursor_.setCursor(dit);
1819 d->cursor_.selection() = false;
1823 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
1825 // Would be wrong to delete anything if we have a selection.
1826 if (cur.selection())
1829 bool need_anchor_change = false;
1830 bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
1831 need_anchor_change);
1833 if (need_anchor_change)
1841 updateLabels(buffer_);
1849 bool BufferView::mouseSetCursor(Cursor & cur, bool select)
1851 LASSERT(&cur.bv() == this, /**/);
1854 // this event will clear selection so we save selection for
1855 // persistent selection
1856 cap::saveSelection(cursor());
1858 // Has the cursor just left the inset?
1859 bool badcursor = false;
1860 bool leftinset = (&d->cursor_.inset() != &cur.inset());
1862 d->cursor_.fixIfBroken();
1863 badcursor = notifyCursorLeaves(d->cursor_, cur);
1868 // FIXME: shift-mouse selection doesn't work well across insets.
1869 bool do_selection = select && &d->cursor_.anchor().inset() == &cur.inset();
1871 // do the dEPM magic if needed
1872 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
1873 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
1874 // the leftinset bool would not be necessary (badcursor instead).
1875 bool update = leftinset;
1876 if (!do_selection && !badcursor && d->cursor_.inTexted())
1877 update |= checkDepm(cur, d->cursor_);
1879 d->cursor_.setCursor(cur);
1880 d->cursor_.boundary(cur.boundary());
1882 d->cursor_.setSelection();
1884 d->cursor_.clearSelection();
1886 d->cursor_.finishUndo();
1887 d->cursor_.setCurrentFont();
1892 void BufferView::putSelectionAt(DocIterator const & cur,
1893 int length, bool backwards)
1895 d->cursor_.clearSelection();
1901 d->cursor_.pos() += length;
1902 d->cursor_.setSelection(d->cursor_, -length);
1904 d->cursor_.setSelection(d->cursor_, length);
1906 // Ensure a redraw happens in any case because the new selection could
1907 // possibly be on the same screen as the previous selection.
1908 processUpdateFlags(Update::Force | Update::FitCursor);
1912 Cursor & BufferView::cursor()
1918 Cursor const & BufferView::cursor() const
1924 pit_type BufferView::anchor_ref() const
1926 return d->anchor_pit_;
1930 bool BufferView::singleParUpdate()
1932 Text & buftext = buffer_.text();
1933 pit_type const bottom_pit = d->cursor_.bottom().pit();
1934 TextMetrics & tm = textMetrics(&buftext);
1935 int old_height = tm.parMetrics(bottom_pit).height();
1937 // make sure inline completion pointer is ok
1938 if (d->inlineCompletionPos_.fixIfBroken())
1939 d->inlineCompletionPos_ = DocIterator();
1941 // In Single Paragraph mode, rebreak only
1942 // the (main text, not inset!) paragraph containing the cursor.
1943 // (if this paragraph contains insets etc., rebreaking will
1944 // recursively descend)
1945 tm.redoParagraph(bottom_pit);
1946 ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
1947 if (pm.height() != old_height)
1948 // Paragraph height has changed so we cannot proceed to
1949 // the singlePar optimisation.
1952 d->update_strategy_ = SingleParUpdate;
1954 LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
1955 << " y2: " << pm.position() + pm.descent()
1956 << " pit: " << bottom_pit
1957 << " singlepar: 1");
1962 void BufferView::updateMetrics()
1964 if (height_ == 0 || width_ == 0)
1967 Text & buftext = buffer_.text();
1968 pit_type const npit = int(buftext.paragraphs().size());
1970 // Clear out the position cache in case of full screen redraw,
1971 d->coord_cache_.clear();
1973 // Clear out paragraph metrics to avoid having invalid metrics
1974 // in the cache from paragraphs not relayouted below
1975 // The complete text metrics will be redone.
1976 d->text_metrics_.clear();
1978 TextMetrics & tm = textMetrics(&buftext);
1980 // make sure inline completion pointer is ok
1981 if (d->inlineCompletionPos_.fixIfBroken())
1982 d->inlineCompletionPos_ = DocIterator();
1984 if (d->anchor_pit_ >= npit)
1985 // The anchor pit must have been deleted...
1986 d->anchor_pit_ = npit - 1;
1988 // Rebreak anchor paragraph.
1989 tm.redoParagraph(d->anchor_pit_);
1990 ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
1993 if (d->anchor_pit_ == 0) {
1994 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
1996 // Complete buffer visible? Then it's easy.
1997 if (scrollRange == 0)
1998 d->anchor_ypos_ = anchor_pm.ascent();
2000 // FIXME: Some clever handling needed to show
2001 // the _first_ paragraph up to the top if the cursor is
2002 // in the first line.
2004 anchor_pm.setPosition(d->anchor_ypos_);
2006 LYXERR(Debug::PAINTING, "metrics: "
2007 << " anchor pit = " << d->anchor_pit_
2008 << " anchor ypos = " << d->anchor_ypos_);
2010 // Redo paragraphs above anchor if necessary.
2011 int y1 = d->anchor_ypos_ - anchor_pm.ascent();
2012 // We are now just above the anchor paragraph.
2013 pit_type pit1 = d->anchor_pit_ - 1;
2014 for (; pit1 >= 0 && y1 >= 0; --pit1) {
2015 tm.redoParagraph(pit1);
2016 ParagraphMetrics & pm = tm.par_metrics_[pit1];
2018 // Save the paragraph position in the cache.
2023 // Redo paragraphs below the anchor if necessary.
2024 int y2 = d->anchor_ypos_ + anchor_pm.descent();
2025 // We are now just below the anchor paragraph.
2026 pit_type pit2 = d->anchor_pit_ + 1;
2027 for (; pit2 < npit && y2 <= height_; ++pit2) {
2028 tm.redoParagraph(pit2);
2029 ParagraphMetrics & pm = tm.par_metrics_[pit2];
2031 // Save the paragraph position in the cache.
2036 LYXERR(Debug::PAINTING, "Metrics: "
2037 << " anchor pit = " << d->anchor_pit_
2038 << " anchor ypos = " << d->anchor_ypos_
2041 << " pit1 = " << pit1
2042 << " pit2 = " << pit2);
2044 d->update_strategy_ = FullScreenUpdate;
2046 if (lyxerr.debugging(Debug::WORKAREA)) {
2047 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
2048 d->coord_cache_.dump();
2053 void BufferView::insertLyXFile(FileName const & fname)
2055 LASSERT(d->cursor_.inTexted(), /**/);
2057 // Get absolute path of file and add ".lyx"
2058 // to the filename if necessary
2059 FileName filename = fileSearch(string(), fname.absFilename(), "lyx");
2061 docstring const disp_fn = makeDisplayPath(filename.absFilename());
2062 // emit message signal.
2063 message(bformat(_("Inserting document %1$s..."), disp_fn));
2066 Buffer buf("", false);
2067 if (buf.loadLyXFile(filename)) {
2068 ErrorList & el = buffer_.errorList("Parse");
2069 // Copy the inserted document error list into the current buffer one.
2070 el = buf.errorList("Parse");
2071 buffer_.undo().recordUndo(d->cursor_);
2072 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
2073 buf.params().documentClassPtr(), el);
2074 res = _("Document %1$s inserted.");
2076 res = _("Could not insert document %1$s");
2081 // emit message signal.
2082 message(bformat(res, disp_fn));
2083 buffer_.errors("Parse");
2087 Point BufferView::coordOffset(DocIterator const & dit, bool boundary) const
2093 // Addup contribution of nested insets, from inside to outside,
2094 // keeping the outer paragraph for a special handling below
2095 for (size_t i = dit.depth() - 1; i >= 1; --i) {
2096 CursorSlice const & sl = dit[i];
2100 // get relative position inside sl.inset()
2101 sl.inset().cursorPos(*this, sl, boundary && (i + 1 == dit.depth()), xx, yy);
2103 // Make relative position inside of the edited inset relative to sl.inset()
2107 // In case of an RTL inset, the edited inset will be positioned to the left
2110 bool boundary_i = boundary && i + 1 == dit.depth();
2111 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2116 // remember width for the case that sl.inset() is positioned in an RTL inset
2117 if (i && dit[i - 1].text()) {
2118 // If this Inset is inside a Text Inset, retrieve the Dimension
2119 // from the containing text instead of using Inset::dimension() which
2120 // might not be implemented.
2121 // FIXME (Abdel 23/09/2007): this is a bit messy because of the
2122 // elimination of Inset::dim_ cache. This coordOffset() method needs
2123 // to be rewritten in light of the new design.
2124 Dimension const & dim = parMetrics(dit[i - 1].text(),
2125 dit[i - 1].pit()).insetDimension(&sl.inset());
2128 Dimension const dim = sl.inset().dimension(*this);
2132 //lyxerr << "Cursor::getPos, i: "
2133 // << i << " x: " << xx << " y: " << y << endl;
2136 // Add contribution of initial rows of outermost paragraph
2137 CursorSlice const & sl = dit[0];
2138 TextMetrics const & tm = textMetrics(sl.text());
2139 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2140 LASSERT(!pm.rows().empty(), /**/);
2141 y -= pm.rows()[0].ascent();
2143 // FIXME: document this mess
2145 if (sl.pos() > 0 && dit.depth() == 1) {
2147 if (pos && boundary)
2149 // lyxerr << "coordOffset: boundary:" << boundary << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
2150 rend = pm.pos2row(pos);
2152 rend = pm.pos2row(sl.pos());
2154 size_t rend = pm.pos2row(sl.pos());
2156 for (size_t rit = 0; rit != rend; ++rit)
2157 y += pm.rows()[rit].height();
2158 y += pm.rows()[rend].ascent();
2160 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
2162 // Make relative position from the nested inset now bufferview absolute.
2163 int xx = bottom_tm.cursorX(dit.bottom(), boundary && dit.depth() == 1);
2166 // In the RTL case place the nested inset at the left of the cursor in
2167 // the outer paragraph
2168 bool boundary_1 = boundary && 1 == dit.depth();
2169 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
2177 Point BufferView::getPos(DocIterator const & dit, bool boundary) const
2179 CursorSlice const & bot = dit.bottom();
2180 TextMetrics const & tm = textMetrics(bot.text());
2181 if (!tm.contains(bot.pit()))
2182 return Point(-1, -1);
2184 Point p = coordOffset(dit, boundary); // offset from outer paragraph
2185 p.y_ += tm.parMetrics(bot.pit()).position();
2190 void BufferView::draw(frontend::Painter & pain)
2192 if (height_ == 0 || width_ == 0)
2194 LYXERR(Debug::PAINTING, "\t\t*** START DRAWING ***");
2195 Text & text = buffer_.text();
2196 TextMetrics const & tm = d->text_metrics_[&text];
2197 int const y = tm.first().second->position();
2198 PainterInfo pi(this, pain);
2200 switch (d->update_strategy_) {
2202 case NoScreenUpdate:
2203 // If no screen painting is actually needed, only some the different
2204 // coordinates of insets and paragraphs needs to be updated.
2205 pi.full_repaint = true;
2206 pi.pain.setDrawingEnabled(false);
2210 case SingleParUpdate:
2211 pi.full_repaint = false;
2212 // In general, only the current row of the outermost paragraph
2213 // will be redrawn. Particular cases where selection spans
2214 // multiple paragraph are correctly detected in TextMetrics.
2218 case DecorationUpdate:
2219 // FIXME: We should also distinguish DecorationUpdate to avoid text
2220 // drawing if possible. This is not possible to do easily right now
2221 // because of the single backing pixmap.
2223 case FullScreenUpdate:
2224 // The whole screen, including insets, will be refreshed.
2225 pi.full_repaint = true;
2227 // Clear background.
2228 pain.fillRectangle(0, 0, width_, height_,
2229 buffer_.inset().backgroundColor());
2234 // and possibly grey out below
2235 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2236 int const y2 = lastpm.second->position() + lastpm.second->descent();
2238 pain.fillRectangle(0, y2, width_, height_ - y2, Color_bottomarea);
2241 LYXERR(Debug::PAINTING, "\n\t\t*** END DRAWING ***");
2243 // The scrollbar needs an update.
2246 // Normalize anchor for next time
2247 pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
2248 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2249 for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
2250 ParagraphMetrics const & pm = tm.parMetrics(pit);
2251 if (pm.position() + pm.descent() > 0) {
2252 d->anchor_pit_ = pit;
2253 d->anchor_ypos_ = pm.position();
2257 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
2258 << " anchor ypos = " << d->anchor_ypos_);
2262 void BufferView::message(docstring const & msg)
2265 d->gui_->message(msg);
2269 void BufferView::showDialog(string const & name)
2272 d->gui_->showDialog(name, string());
2276 void BufferView::showDialog(string const & name,
2277 string const & data, Inset * inset)
2280 d->gui_->showDialog(name, data, inset);
2284 void BufferView::updateDialog(string const & name, string const & data)
2287 d->gui_->updateDialog(name, data);
2291 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
2297 // FIXME: Move this out of BufferView again
2298 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
2300 if (!fname.isReadableFile()) {
2301 docstring const error = from_ascii(strerror(errno));
2302 docstring const file = makeDisplayPath(fname.absFilename(), 50);
2303 docstring const text =
2304 bformat(_("Could not read the specified document\n"
2305 "%1$s\ndue to the error: %2$s"), file, error);
2306 Alert::error(_("Could not read file"), text);
2310 if (!fname.isReadableFile()) {
2311 docstring const file = makeDisplayPath(fname.absFilename(), 50);
2312 docstring const text =
2313 bformat(_("%1$s\n is not readable."), file);
2314 Alert::error(_("Could not open file"), text);
2318 // FIXME UNICODE: We don't know the encoding of the file
2319 docstring file_content = fname.fileContents("UTF-8");
2320 if (file_content.empty()) {
2321 Alert::error(_("Reading not UTF-8 encoded file"),
2322 _("The file is not UTF-8 encoded.\n"
2323 "It will be read as local 8Bit-encoded.\n"
2324 "If this does not give the correct result\n"
2325 "then please change the encoding of the file\n"
2326 "to UTF-8 with a program other than LyX.\n"));
2327 file_content = fname.fileContents("local8bit");
2330 return normalize_c(file_content);
2334 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
2336 docstring const tmpstr = contentsOfPlaintextFile(f);
2341 Cursor & cur = cursor();
2342 cap::replaceSelection(cur);
2343 buffer_.undo().recordUndo(cur);
2345 cur.innerText()->insertStringAsParagraphs(cur, tmpstr);
2347 cur.innerText()->insertStringAsLines(cur, tmpstr);
2354 docstring const & BufferView::inlineCompletion() const
2356 return d->inlineCompletion_;
2360 size_t const & BufferView::inlineCompletionUniqueChars() const
2362 return d->inlineCompletionUniqueChars_;
2366 DocIterator const & BufferView::inlineCompletionPos() const
2368 return d->inlineCompletionPos_;
2372 bool samePar(DocIterator const & a, DocIterator const & b)
2374 if (a.empty() && b.empty())
2376 if (a.empty() || b.empty())
2378 return &a.innerParagraph() == &b.innerParagraph();
2382 void BufferView::setInlineCompletion(Cursor & cur, DocIterator const & pos,
2383 docstring const & completion, size_t uniqueChars)
2385 uniqueChars = min(completion.size(), uniqueChars);
2386 bool changed = d->inlineCompletion_ != completion
2387 || d->inlineCompletionUniqueChars_ != uniqueChars;
2388 bool singlePar = true;
2389 d->inlineCompletion_ = completion;
2390 d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
2392 //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
2395 DocIterator const & old = d->inlineCompletionPos_;
2397 //lyxerr << "inlineCompletionPos changed" << std::endl;
2398 // old or pos are in another paragraph?
2399 if ((!samePar(cur, pos) && !pos.empty())
2400 || (!samePar(cur, old) && !old.empty())) {
2402 //lyxerr << "different paragraph" << std::endl;
2404 d->inlineCompletionPos_ = pos;
2409 if (singlePar && !(cur.disp_.update() & Update::Force))
2410 cur.updateFlags(cur.disp_.update() | Update::SinglePar);
2412 cur.updateFlags(cur.disp_.update() | Update::Force);