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 // Get inset under mouse, if there is one.
537 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
539 return covering_inset->contextMenu(*this, x, y);
541 return buffer_.inset().contextMenu(*this, x, y);
545 void BufferView::scrollDocView(int value)
547 int const offset = value - d->scrollbarParameters_.position;
548 // If the offset is less than 2 screen height, prefer to scroll instead.
549 if (abs(offset) <= 2 * height_) {
556 // cut off at the top
557 if (value <= d->scrollbarParameters_.min) {
558 DocIterator dit = doc_iterator_begin(buffer_.inset());
560 LYXERR(Debug::SCROLLING, "scroll to top");
564 // cut off at the bottom
565 if (value >= d->scrollbarParameters_.max) {
566 DocIterator dit = doc_iterator_end(buffer_.inset());
569 LYXERR(Debug::SCROLLING, "scroll to bottom");
573 // find paragraph at target position
574 int par_pos = d->scrollbarParameters_.min;
576 for (; i != int(d->par_height_.size()); ++i) {
577 par_pos += d->par_height_[i];
578 if (par_pos >= value)
582 if (par_pos < value) {
583 // It seems we didn't find the correct pit so stay on the safe side and
585 LYXERR0("scrolling position not found!");
586 scrollDocView(d->scrollbarParameters_.max);
590 DocIterator dit = doc_iterator_begin(buffer_.inset());
592 LYXERR(Debug::SCROLLING, "value = " << value << " -> scroll to pit " << i);
597 // FIXME: this method is not working well.
598 void BufferView::setCursorFromScrollbar()
600 TextMetrics & tm = d->text_metrics_[&buffer_.text()];
602 int const height = 2 * defaultRowHeight();
603 int const first = height;
604 int const last = height_ - height;
605 Cursor & cur = d->cursor_;
607 switch (cursorStatus(cur)) {
609 // We reset the cursor because cursorStatus() does not
610 // work when the cursor is within mathed.
611 cur.reset(buffer_.inset());
612 tm.setCursorFromCoordinates(cur, 0, first);
613 cur.clearSelection();
616 // We reset the cursor because cursorStatus() does not
617 // work when the cursor is within mathed.
618 cur.reset(buffer_.inset());
619 tm.setCursorFromCoordinates(cur, 0, last);
620 cur.clearSelection();
623 int const y = getPos(cur, cur.boundary()).y_;
624 int const newy = min(last, max(y, first));
626 cur.reset(buffer_.inset());
627 tm.setCursorFromCoordinates(cur, 0, newy);
633 Change const BufferView::getCurrentChange() const
635 if (!d->cursor_.selection())
636 return Change(Change::UNCHANGED);
638 DocIterator dit = d->cursor_.selectionBegin();
639 return dit.paragraph().lookupChange(dit.pos());
643 // this could be used elsewhere as well?
644 // FIXME: This does not work within mathed!
645 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
647 Point const p = getPos(dit, dit.boundary());
650 if (p.y_ > workHeight())
656 void BufferView::saveBookmark(unsigned int idx)
658 // tenatively save bookmark, id and pos will be used to
659 // acturately locate a bookmark in a 'live' lyx session.
660 // pit and pos will be updated with bottom level pit/pos
662 theSession().bookmarks().save(
664 d->cursor_.bottom().pit(),
665 d->cursor_.bottom().pos(),
666 d->cursor_.paragraph().id(),
671 // emit message signal.
672 message(_("Save bookmark"));
676 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
677 int top_id, pos_type top_pos)
679 bool success = false;
682 d->cursor_.clearSelection();
684 // if a valid par_id is given, try it first
685 // This is the case for a 'live' bookmark when unique paragraph ID
686 // is used to track bookmarks.
688 dit = buffer_.getParFromID(top_id);
690 dit.pos() = min(dit.paragraph().size(), top_pos);
691 // Some slices of the iterator may not be
692 // reachable (e.g. closed collapsable inset)
693 // so the dociterator may need to be
694 // shortened. Otherwise, setCursor may crash
695 // lyx when the cursor can not be set to these
697 size_t const n = dit.depth();
698 for (size_t i = 0; i < n; ++i)
699 if (dit[i].inset().editable() != Inset::HIGHLY_EDITABLE) {
707 // if top_id == 0, or searching through top_id failed
708 // This is the case for a 'restored' bookmark when only bottom
709 // (document level) pit was saved. Because of this, bookmark
710 // restoration is inaccurate. If a bookmark was within an inset,
711 // it will be restored to the left of the outmost inset that contains
713 if (bottom_pit < int(buffer_.paragraphs().size())) {
714 dit = doc_iterator_begin(buffer_.inset());
716 dit.pit() = bottom_pit;
717 dit.pos() = min(bottom_pos, dit.paragraph().size());
722 // Note: only bottom (document) level pit is set.
724 // set the current font.
725 d->cursor_.setCurrentFont();
726 // To center the screen on this new position we need the
727 // paragraph position which is computed at draw() time.
728 // So we need a redraw!
738 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
740 if (lyxrc.rtl_support) {
741 if (d->cursor_.real_current_font.isRightToLeft()) {
742 if (d->intl_.keymap == Intl::PRIMARY)
743 d->intl_.keyMapSec();
745 if (d->intl_.keymap == Intl::SECONDARY)
746 d->intl_.keyMapPrim();
750 d->intl_.getTransManager().translateAndInsert(c, t, cur);
754 int BufferView::workWidth() const
760 void BufferView::showCursor()
762 showCursor(d->cursor_);
766 void BufferView::showCursor(DocIterator const & dit)
768 // We are not properly started yet, delay until resizing is
773 LYXERR(Debug::SCROLLING, "recentering!");
775 CursorSlice const & bot = dit.bottom();
776 TextMetrics & tm = d->text_metrics_[bot.text()];
778 pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
779 int bot_pit = bot.pit();
780 if (bot_pit > max_pit) {
781 // FIXME: Why does this happen?
782 LYXERR0("bottom pit is greater that max pit: "
783 << bot_pit << " > " << max_pit);
787 if (bot_pit == tm.first().first - 1)
788 tm.newParMetricsUp();
789 else if (bot_pit == tm.last().first + 1)
790 tm.newParMetricsDown();
792 if (tm.contains(bot_pit)) {
793 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
794 LASSERT(!pm.rows().empty(), /**/);
795 // FIXME: smooth scrolling doesn't work in mathed.
796 CursorSlice const & cs = dit.innerTextSlice();
797 int offset = coordOffset(dit, dit.boundary()).y_;
798 int ypos = pm.position() + offset;
799 Dimension const & row_dim =
800 pm.getRow(cs.pos(), dit.boundary()).dimension();
802 if (ypos - row_dim.ascent() < 0)
803 scrolled = scrollUp(- ypos + row_dim.ascent());
804 else if (ypos + row_dim.descent() > height_)
805 scrolled = scrollDown(ypos - height_ + row_dim.descent());
806 // else, nothing to do, the cursor is already visible so we just return.
814 // fix inline completion position
815 if (d->inlineCompletionPos_.fixIfBroken())
816 d->inlineCompletionPos_ = DocIterator();
818 tm.redoParagraph(bot_pit);
819 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
820 int offset = coordOffset(dit, dit.boundary()).y_;
822 d->anchor_pit_ = bot_pit;
823 CursorSlice const & cs = dit.innerTextSlice();
824 Dimension const & row_dim =
825 pm.getRow(cs.pos(), dit.boundary()).dimension();
827 if (d->anchor_pit_ == 0)
828 d->anchor_ypos_ = offset + pm.ascent();
829 else if (d->anchor_pit_ == max_pit)
830 d->anchor_ypos_ = height_ - offset - row_dim.descent();
832 d->anchor_ypos_ = defaultRowHeight() * 2 - offset - row_dim.descent();
839 FuncStatus BufferView::getStatus(FuncRequest const & cmd)
843 Cursor & cur = d->cursor_;
845 switch (cmd.action) {
848 flag.setEnabled(buffer_.undo().hasUndoStack());
851 flag.setEnabled(buffer_.undo().hasRedoStack());
853 case LFUN_FILE_INSERT:
854 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
855 case LFUN_FILE_INSERT_PLAINTEXT:
856 case LFUN_BOOKMARK_SAVE:
857 // FIXME: Actually, these LFUNS should be moved to Text
858 flag.setEnabled(cur.inTexted());
860 case LFUN_FONT_STATE:
861 case LFUN_LABEL_INSERT:
862 case LFUN_INFO_INSERT:
863 case LFUN_INSET_EDIT:
864 case LFUN_PARAGRAPH_GOTO:
866 case LFUN_REFERENCE_NEXT:
868 case LFUN_WORD_REPLACE:
871 case LFUN_MARK_TOGGLE:
872 case LFUN_SCREEN_RECENTER:
873 case LFUN_BIBTEX_DATABASE_ADD:
874 case LFUN_BIBTEX_DATABASE_DEL:
875 case LFUN_GRAPHICS_GROUPS_UNIFY:
876 case LFUN_NOTES_MUTATE:
877 case LFUN_ALL_INSETS_TOGGLE:
878 case LFUN_STATISTICS:
879 flag.setEnabled(true);
882 case LFUN_NEXT_INSET_TOGGLE:
883 case LFUN_NEXT_INSET_MODIFY: {
884 // this is the real function we want to invoke
885 FuncRequest tmpcmd = cmd;
886 tmpcmd.action = (cmd.action == LFUN_NEXT_INSET_TOGGLE)
887 ? LFUN_INSET_TOGGLE : LFUN_INSET_MODIFY;
888 // if there is an inset at cursor, see whether it
889 // handles the lfun, other start from scratch
890 Inset * inset = cur.nextInset();
891 if (!inset || !inset->getStatus(cur, tmpcmd, flag))
892 flag = lyx::getStatus(tmpcmd);
896 case LFUN_LABEL_GOTO: {
897 flag.setEnabled(!cmd.argument().empty()
898 || getInsetByCode<InsetRef>(cur, REF_CODE));
902 case LFUN_CHANGES_TRACK:
903 flag.setEnabled(true);
904 flag.setOnOff(buffer_.params().trackChanges);
907 case LFUN_CHANGES_OUTPUT:
908 flag.setEnabled(true);
909 flag.setOnOff(buffer_.params().outputChanges);
912 case LFUN_CHANGES_MERGE:
913 case LFUN_CHANGE_NEXT:
914 case LFUN_ALL_CHANGES_ACCEPT:
915 case LFUN_ALL_CHANGES_REJECT:
916 // TODO: context-sensitive enabling of LFUNs
917 // In principle, these command should only be enabled if there
918 // is a change in the document. However, without proper
919 // optimizations, this will inevitably result in poor performance.
920 flag.setEnabled(true);
923 case LFUN_BUFFER_TOGGLE_COMPRESSION: {
924 flag.setOnOff(buffer_.params().compressed);
929 case LFUN_SCREEN_DOWN:
931 case LFUN_SCREEN_UP_SELECT:
932 case LFUN_SCREEN_DOWN_SELECT:
933 flag.setEnabled(true);
936 case LFUN_LAYOUT_TABULAR:
937 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
941 flag.setEnabled(!cur.inset().forcePlainLayout(cur.idx()));
944 case LFUN_LAYOUT_PARAGRAPH:
945 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
948 case LFUN_INSET_SETTINGS: {
949 InsetCode code = cur.inset().lyxCode();
950 if (cmd.getArg(0) == insetName(code)) {
951 flag.setEnabled(true);
955 InsetCode next_code = cur.nextInset()
956 ? cur.nextInset()->lyxCode() : NO_CODE;
957 //FIXME: remove these special cases:
967 enable = (cmd.argument().empty() ||
968 cmd.getArg(0) == insetName(next_code));
973 flag.setEnabled(enable);
977 case LFUN_DIALOG_SHOW_NEW_INSET:
978 flag.setEnabled(cur.inset().lyxCode() != ERT_CODE &&
979 cur.inset().lyxCode() != LISTINGS_CODE);
980 if (cur.inset().lyxCode() == CAPTION_CODE) {
982 if (cur.inset().getStatus(cur, cmd, flag))
987 case LFUN_BRANCH_ACTIVATE:
988 case LFUN_BRANCH_DEACTIVATE: {
990 docstring const branchName = cmd.argument();
991 if (!branchName.empty())
992 enable = buffer_.params().branchlist().find(branchName);
993 flag.setEnabled(enable);
998 flag.setEnabled(false);
1005 bool BufferView::dispatch(FuncRequest const & cmd)
1007 //lyxerr << [ cmd = " << cmd << "]" << endl;
1009 // Make sure that the cached BufferView is correct.
1010 LYXERR(Debug::ACTION, " action[" << cmd.action << ']'
1011 << " arg[" << to_utf8(cmd.argument()) << ']'
1012 << " x[" << cmd.x << ']'
1013 << " y[" << cmd.y << ']'
1014 << " button[" << cmd.button() << ']');
1016 Cursor & cur = d->cursor_;
1018 switch (cmd.action) {
1021 cur.message(_("Undo"));
1022 cur.clearSelection();
1023 if (!cur.textUndo())
1024 cur.message(_("No further undo information"));
1026 processUpdateFlags(Update::Force | Update::FitCursor);
1030 cur.message(_("Redo"));
1031 cur.clearSelection();
1032 if (!cur.textRedo())
1033 cur.message(_("No further redo information"));
1035 processUpdateFlags(Update::Force | Update::FitCursor);
1038 case LFUN_FONT_STATE:
1039 cur.message(cur.currentState());
1042 case LFUN_BOOKMARK_SAVE:
1043 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1046 case LFUN_LABEL_GOTO: {
1047 docstring label = cmd.argument();
1048 if (label.empty()) {
1050 getInsetByCode<InsetRef>(d->cursor_,
1053 label = inset->getParam("reference");
1054 // persistent=false: use temp_bookmark
1064 case LFUN_INSET_EDIT: {
1065 FuncRequest fr(cmd);
1066 // if there is an inset at cursor, see whether it
1068 Inset * inset = cur.nextInset();
1070 inset->dispatch(cur, fr);
1071 // if it did not work, try the underlying inset.
1072 if (!inset || !cur.result().dispatched())
1075 // FIXME I'm adding the last break to solve a crash,
1076 // but that is obviously not right.
1077 if (!cur.result().dispatched())
1078 // It did not work too; no action needed.
1083 case LFUN_PARAGRAPH_GOTO: {
1084 int const id = convert<int>(cmd.getArg(0));
1085 int const pos = convert<int>(cmd.getArg(1));
1087 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1088 b = theBufferList().next(b)) {
1090 DocIterator dit = b->getParFromID(id);
1092 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1096 LYXERR(Debug::INFO, "Paragraph " << dit.paragraph().id()
1097 << " found in buffer `"
1098 << b->absFileName() << "'.");
1100 if (b == &buffer_) {
1104 processUpdateFlags(Update::Force | Update::FitCursor);
1106 // Switch to other buffer view and resend cmd
1107 theLyXFunc().dispatch(FuncRequest(
1108 LFUN_BUFFER_SWITCH, b->absFileName()));
1109 theLyXFunc().dispatch(cmd);
1116 case LFUN_NOTE_NEXT:
1117 gotoInset(this, NOTE_CODE, false);
1120 case LFUN_REFERENCE_NEXT: {
1121 vector<InsetCode> tmp;
1122 tmp.push_back(LABEL_CODE);
1123 tmp.push_back(REF_CODE);
1124 gotoInset(this, tmp, true);
1128 case LFUN_CHANGES_TRACK:
1129 buffer_.params().trackChanges = !buffer_.params().trackChanges;
1132 case LFUN_CHANGES_OUTPUT:
1133 buffer_.params().outputChanges = !buffer_.params().outputChanges;
1134 if (buffer_.params().outputChanges) {
1135 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1136 bool xcolorsoul = LaTeXFeatures::isAvailable("soul") &&
1137 LaTeXFeatures::isAvailable("xcolor");
1139 if (!dvipost && !xcolorsoul) {
1140 Alert::warning(_("Changes not shown in LaTeX output"),
1141 _("Changes will not be highlighted in LaTeX output, "
1142 "because neither dvipost nor xcolor/soul are installed.\n"
1143 "Please install these packages or redefine "
1144 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1145 } else if (!xcolorsoul) {
1146 Alert::warning(_("Changes not shown in LaTeX output"),
1147 _("Changes will not be highlighted in LaTeX output "
1148 "when using pdflatex, because xcolor and soul are not installed.\n"
1149 "Please install both packages or redefine "
1150 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1155 case LFUN_CHANGE_NEXT:
1156 findNextChange(this);
1159 case LFUN_CHANGES_MERGE:
1160 if (findNextChange(this))
1161 showDialog("changes");
1164 case LFUN_ALL_CHANGES_ACCEPT:
1165 // select complete document
1166 d->cursor_.reset(buffer_.inset());
1167 d->cursor_.selHandle(true);
1168 buffer_.text().cursorBottom(d->cursor_);
1169 // accept everything in a single step to support atomic undo
1170 buffer_.text().acceptOrRejectChanges(d->cursor_, Text::ACCEPT);
1171 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1172 processUpdateFlags(Update::Force | Update::FitCursor);
1175 case LFUN_ALL_CHANGES_REJECT:
1176 // select complete document
1177 d->cursor_.reset(buffer_.inset());
1178 d->cursor_.selHandle(true);
1179 buffer_.text().cursorBottom(d->cursor_);
1180 // reject everything in a single step to support atomic undo
1181 // Note: reject does not work recursively; the user may have to repeat the operation
1182 buffer_.text().acceptOrRejectChanges(d->cursor_, Text::REJECT);
1183 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1184 processUpdateFlags(Update::Force | Update::FitCursor);
1187 case LFUN_WORD_FIND: {
1188 FuncRequest req = cmd;
1189 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1190 req = d->search_request_cache_;
1191 if (find(this, req))
1194 message(_("String not found!"));
1195 d->search_request_cache_ = req;
1199 case LFUN_WORD_REPLACE: {
1200 bool has_deleted = false;
1201 if (cur.selection()) {
1202 DocIterator beg = cur.selectionBegin();
1203 DocIterator end = cur.selectionEnd();
1204 if (beg.pit() == end.pit()) {
1205 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1206 if (cur.paragraph().isDeleted(p))
1211 replace(this, cmd, has_deleted);
1216 cur.clearSelection();
1218 cur.message(from_utf8(N_("Mark off")));
1222 cur.clearSelection();
1225 cur.message(from_utf8(N_("Mark on")));
1228 case LFUN_MARK_TOGGLE:
1229 cur.clearSelection();
1232 cur.message(from_utf8(N_("Mark removed")));
1235 cur.message(from_utf8(N_("Mark set")));
1240 case LFUN_SCREEN_RECENTER:
1244 case LFUN_BIBTEX_DATABASE_ADD: {
1245 Cursor tmpcur = d->cursor_;
1246 findInset(tmpcur, BIBTEX_CODE, false);
1247 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1250 if (inset->addDatabase(cmd.argument()))
1251 buffer_.updateBibfilesCache();
1256 case LFUN_BIBTEX_DATABASE_DEL: {
1257 Cursor tmpcur = d->cursor_;
1258 findInset(tmpcur, BIBTEX_CODE, false);
1259 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1262 if (inset->delDatabase(cmd.argument()))
1263 buffer_.updateBibfilesCache();
1268 case LFUN_STATISTICS: {
1269 DocIterator from, to;
1270 if (cur.selection()) {
1271 from = cur.selectionBegin();
1272 to = cur.selectionEnd();
1274 from = doc_iterator_begin(buffer_.inset());
1275 to = doc_iterator_end(buffer_.inset());
1277 int const words = countWords(from, to);
1278 int const chars = countChars(from, to, false);
1279 int const chars_blanks = countChars(from, to, true);
1281 if (cur.selection())
1282 message = _("Statistics for the selection:");
1284 message = _("Statistics for the document:");
1287 message += bformat(_("%1$d words"), words);
1289 message += _("One word");
1291 if (chars_blanks != 1)
1292 message += bformat(_("%1$d characters (including blanks)"),
1295 message += _("One character (including blanks)");
1298 message += bformat(_("%1$d characters (excluding blanks)"),
1301 message += _("One character (excluding blanks)");
1303 Alert::information(_("Statistics"), message);
1307 case LFUN_BUFFER_TOGGLE_COMPRESSION:
1308 // turn compression on/off
1309 buffer_.params().compressed = !buffer_.params().compressed;
1312 case LFUN_NEXT_INSET_TOGGLE: {
1313 // create the the real function we want to invoke
1314 FuncRequest tmpcmd = cmd;
1315 tmpcmd.action = LFUN_INSET_TOGGLE;
1316 // if there is an inset at cursor, see whether it
1318 Inset * inset = cur.nextInset();
1320 if (inset->isActive()) {
1321 Cursor tmpcur = cur;
1322 tmpcur.pushBackward(*inset);
1323 inset->dispatch(tmpcur, tmpcmd);
1324 if (tmpcur.result().dispatched())
1327 inset->dispatch(cur, tmpcmd);
1329 // if it did not work, try the underlying inset.
1330 if (!inset || !cur.result().dispatched())
1331 cur.dispatch(tmpcmd);
1333 if (!cur.result().dispatched())
1334 // It did not work too; no action needed.
1336 cur.clearSelection();
1337 processUpdateFlags(Update::SinglePar | Update::FitCursor);
1341 case LFUN_NEXT_INSET_MODIFY: {
1342 // create the the real function we want to invoke
1343 FuncRequest tmpcmd = cmd;
1344 tmpcmd.action = LFUN_INSET_MODIFY;
1345 // if there is an inset at cursor, see whether it
1347 Inset * inset = cur.nextInset();
1349 inset->dispatch(cur, tmpcmd);
1350 // if it did not work, try the underlying inset.
1351 if (!inset || !cur.result().dispatched())
1352 cur.dispatch(tmpcmd);
1354 if (!cur.result().dispatched())
1355 // It did not work too; no action needed.
1357 cur.clearSelection();
1358 processUpdateFlags(Update::Force | Update::FitCursor);
1362 case LFUN_SCREEN_UP:
1363 case LFUN_SCREEN_DOWN: {
1364 Point p = getPos(cur, cur.boundary());
1365 if (p.y_ < 0 || p.y_ > height_) {
1366 // The cursor is off-screen so recenter before proceeding.
1368 p = getPos(cur, cur.boundary());
1370 int const scrolled = scroll(cmd.action == LFUN_SCREEN_UP
1371 ? - height_ : height_);
1372 if (cmd.action == LFUN_SCREEN_UP && scrolled > - height_)
1374 if (cmd.action == LFUN_SCREEN_DOWN && scrolled < height_)
1375 p = Point(width_, height_);
1376 cur.reset(buffer_.inset());
1379 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_);
1380 //FIXME: what to do with cur.x_target()?
1389 case LFUN_SCREEN_UP_SELECT: {
1390 cur.selHandle(true);
1391 if (isTopScreen()) {
1392 lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1396 int y = getPos(cur, cur.boundary()).y_;
1397 int const ymin = y - height_ + defaultRowHeight();
1398 while (y > ymin && cur.up())
1399 y = getPos(cur, cur.boundary()).y_;
1402 processUpdateFlags(Update::SinglePar | Update::FitCursor);
1406 case LFUN_SCREEN_DOWN_SELECT: {
1407 cur.selHandle(true);
1408 if (isBottomScreen()) {
1409 lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1413 int y = getPos(cur, cur.boundary()).y_;
1414 int const ymax = y + height_ - defaultRowHeight();
1415 while (y < ymax && cur.down())
1416 y = getPos(cur, cur.boundary()).y_;
1419 processUpdateFlags(Update::SinglePar | Update::FitCursor);
1423 case LFUN_BRANCH_ACTIVATE:
1424 case LFUN_BRANCH_DEACTIVATE:
1425 buffer_.dispatch(cmd);
1426 processUpdateFlags(Update::Force);
1429 // These two could be rewriten using some command like forall <insetname> <command>
1430 // once the insets refactoring is done.
1431 case LFUN_GRAPHICS_GROUPS_UNIFY: {
1432 if (cmd.argument().empty())
1434 //view()->cursor().recordUndoFullDocument(); let inset-apply do that job
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())
1443 cur.recordUndoFullDocument();
1445 if (mutateNotes(cur, cmd.getArg(0), cmd.getArg(1))) {
1446 processUpdateFlags(Update::Force);
1451 case LFUN_ALL_INSETS_TOGGLE: {
1453 string const name = split(to_utf8(cmd.argument()), action, ' ');
1454 InsetCode const inset_code = insetCode(name);
1456 FuncRequest fr(LFUN_INSET_TOGGLE, action);
1458 Inset & inset = cur.buffer().inset();
1459 InsetIterator it = inset_iterator_begin(inset);
1460 InsetIterator const end = inset_iterator_end(inset);
1461 for (; it != end; ++it) {
1462 if (it->asInsetCollapsable()
1463 && (inset_code == NO_CODE
1464 || inset_code == it->lyxCode())) {
1465 Cursor tmpcur = cur;
1466 tmpcur.pushBackward(*it);
1467 it->dispatch(tmpcur, fr);
1470 processUpdateFlags(Update::Force | Update::FitCursor);
1482 docstring const BufferView::requestSelection()
1484 Cursor & cur = d->cursor_;
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 // Try to dispatch to an non-editable inset near this position
1621 // via the temp cursor. If the inset wishes to change the real
1622 // cursor it has to do so explicitly by using
1623 // cur.bv().cursor() = cur; (or similar)
1625 inset->dispatch(cur, cmd);
1627 // Now dispatch to the temporary cursor. If the real cursor should
1628 // be modified, the inset's dispatch has to do so explicitly.
1629 if (!inset || !cur.result().dispatched())
1632 // Notify left insets
1635 bool badcursor = notifyCursorLeaves(old, cur);
1637 cursor().fixIfBroken();
1640 // Do we have a selection?
1641 theSelection().haveSelection(cursor().selection());
1643 // If the command has been dispatched,
1644 if (cur.result().dispatched() || cur.result().update())
1645 processUpdateFlags(cur.result().update());
1649 void BufferView::lfunScroll(FuncRequest const & cmd)
1651 string const scroll_type = cmd.getArg(0);
1652 int const scroll_step =
1653 (scroll_type == "line") ? d->scrollbarParameters_.single_step
1654 : (scroll_type == "page") ? d->scrollbarParameters_.page_step : 0;
1655 if (scroll_step == 0)
1657 string const scroll_quantity = cmd.getArg(1);
1658 if (scroll_quantity == "up")
1659 scrollUp(scroll_step);
1660 else if (scroll_quantity == "down")
1661 scrollDown(scroll_step);
1663 int const scroll_value = convert<int>(scroll_quantity);
1665 scroll(scroll_step * scroll_value);
1672 int BufferView::scroll(int y)
1675 return scrollDown(y);
1677 return scrollUp(-y);
1682 int BufferView::scrollDown(int offset)
1684 Text * text = &buffer_.text();
1685 TextMetrics & tm = d->text_metrics_[text];
1686 int ymax = height_ + offset;
1688 pair<pit_type, ParagraphMetrics const *> last = tm.last();
1689 int bottom_pos = last.second->position() + last.second->descent();
1690 if (last.first + 1 == int(text->paragraphs().size())) {
1691 if (bottom_pos <= height_)
1693 offset = min(offset, bottom_pos - height_);
1696 if (bottom_pos > ymax)
1698 tm.newParMetricsDown();
1700 d->anchor_ypos_ -= offset;
1705 int BufferView::scrollUp(int offset)
1707 Text * text = &buffer_.text();
1708 TextMetrics & tm = d->text_metrics_[text];
1709 int ymin = - offset;
1711 pair<pit_type, ParagraphMetrics const *> first = tm.first();
1712 int top_pos = first.second->position() - first.second->ascent();
1713 if (first.first == 0) {
1716 offset = min(offset, - top_pos);
1721 tm.newParMetricsUp();
1723 d->anchor_ypos_ += offset;
1728 void BufferView::setCursorFromRow(int row)
1733 buffer_.texrow().getIdFromRow(row, tmpid, tmppos);
1735 d->cursor_.reset(buffer_.inset());
1737 buffer_.text().setCursor(d->cursor_, 0, 0);
1739 buffer_.text().setCursor(d->cursor_, buffer_.getParFromID(tmpid).pit(), tmppos);
1743 void BufferView::gotoLabel(docstring const & label)
1745 Toc & toc = buffer().tocBackend().toc("label");
1746 TocIterator toc_it = toc.begin();
1747 TocIterator end = toc.end();
1748 for (; toc_it != end; ++toc_it) {
1749 if (label == toc_it->str())
1750 dispatch(toc_it->action());
1752 //FIXME: We could do a bit more searching thanks to this:
1753 //InsetLabel const * inset = buffer_.insetLabel(label);
1757 TextMetrics const & BufferView::textMetrics(Text const * t) const
1759 return const_cast<BufferView *>(this)->textMetrics(t);
1763 TextMetrics & BufferView::textMetrics(Text const * t)
1765 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
1766 if (tmc_it == d->text_metrics_.end()) {
1767 tmc_it = d->text_metrics_.insert(
1768 make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
1770 return tmc_it->second;
1774 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
1777 return textMetrics(t).parMetrics(pit);
1781 int BufferView::workHeight() const
1787 void BufferView::setCursor(DocIterator const & dit)
1789 size_t const n = dit.depth();
1790 for (size_t i = 0; i < n; ++i)
1791 dit[i].inset().edit(d->cursor_, true);
1793 d->cursor_.setCursor(dit);
1794 d->cursor_.selection() = false;
1798 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
1800 // Would be wrong to delete anything if we have a selection.
1801 if (cur.selection())
1804 bool need_anchor_change = false;
1805 bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
1806 need_anchor_change);
1808 if (need_anchor_change)
1816 updateLabels(buffer_);
1824 bool BufferView::mouseSetCursor(Cursor & cur, bool select)
1826 LASSERT(&cur.bv() == this, /**/);
1829 // this event will clear selection so we save selection for
1830 // persistent selection
1831 cap::saveSelection(cursor());
1833 // Has the cursor just left the inset?
1834 bool badcursor = false;
1835 bool leftinset = (&d->cursor_.inset() != &cur.inset());
1837 d->cursor_.fixIfBroken();
1838 badcursor = notifyCursorLeaves(d->cursor_, cur);
1843 // FIXME: shift-mouse selection doesn't work well across insets.
1844 bool do_selection = select && &d->cursor_.anchor().inset() == &cur.inset();
1846 // do the dEPM magic if needed
1847 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
1848 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
1849 // the leftinset bool would not be necessary (badcursor instead).
1850 bool update = leftinset;
1851 if (!do_selection && !badcursor && d->cursor_.inTexted())
1852 update |= checkDepm(cur, d->cursor_);
1854 d->cursor_.setCursor(cur);
1855 d->cursor_.boundary(cur.boundary());
1857 d->cursor_.setSelection();
1859 d->cursor_.clearSelection();
1861 d->cursor_.finishUndo();
1862 d->cursor_.setCurrentFont();
1867 void BufferView::putSelectionAt(DocIterator const & cur,
1868 int length, bool backwards)
1870 d->cursor_.clearSelection();
1876 d->cursor_.pos() += length;
1877 d->cursor_.setSelection(d->cursor_, -length);
1879 d->cursor_.setSelection(d->cursor_, length);
1881 // Ensure a redraw happens in any case because the new selection could
1882 // possibly be on the same screen as the previous selection.
1883 processUpdateFlags(Update::Force | Update::FitCursor);
1887 Cursor & BufferView::cursor()
1893 Cursor const & BufferView::cursor() const
1899 pit_type BufferView::anchor_ref() const
1901 return d->anchor_pit_;
1905 bool BufferView::singleParUpdate()
1907 Text & buftext = buffer_.text();
1908 pit_type const bottom_pit = d->cursor_.bottom().pit();
1909 TextMetrics & tm = textMetrics(&buftext);
1910 int old_height = tm.parMetrics(bottom_pit).height();
1912 // make sure inline completion pointer is ok
1913 if (d->inlineCompletionPos_.fixIfBroken())
1914 d->inlineCompletionPos_ = DocIterator();
1916 // In Single Paragraph mode, rebreak only
1917 // the (main text, not inset!) paragraph containing the cursor.
1918 // (if this paragraph contains insets etc., rebreaking will
1919 // recursively descend)
1920 tm.redoParagraph(bottom_pit);
1921 ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
1922 if (pm.height() != old_height)
1923 // Paragraph height has changed so we cannot proceed to
1924 // the singlePar optimisation.
1927 d->update_strategy_ = SingleParUpdate;
1929 LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
1930 << " y2: " << pm.position() + pm.descent()
1931 << " pit: " << bottom_pit
1932 << " singlepar: 1");
1937 void BufferView::updateMetrics()
1939 if (height_ == 0 || width_ == 0)
1942 Text & buftext = buffer_.text();
1943 pit_type const npit = int(buftext.paragraphs().size());
1945 // Clear out the position cache in case of full screen redraw,
1946 d->coord_cache_.clear();
1948 // Clear out paragraph metrics to avoid having invalid metrics
1949 // in the cache from paragraphs not relayouted below
1950 // The complete text metrics will be redone.
1951 d->text_metrics_.clear();
1953 TextMetrics & tm = textMetrics(&buftext);
1955 // make sure inline completion pointer is ok
1956 if (d->inlineCompletionPos_.fixIfBroken())
1957 d->inlineCompletionPos_ = DocIterator();
1959 if (d->anchor_pit_ >= npit)
1960 // The anchor pit must have been deleted...
1961 d->anchor_pit_ = npit - 1;
1963 // Rebreak anchor paragraph.
1964 tm.redoParagraph(d->anchor_pit_);
1965 ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
1968 if (d->anchor_pit_ == 0) {
1969 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
1971 // Complete buffer visible? Then it's easy.
1972 if (scrollRange == 0)
1973 d->anchor_ypos_ = anchor_pm.ascent();
1975 // FIXME: Some clever handling needed to show
1976 // the _first_ paragraph up to the top if the cursor is
1977 // in the first line.
1979 anchor_pm.setPosition(d->anchor_ypos_);
1981 LYXERR(Debug::PAINTING, "metrics: "
1982 << " anchor pit = " << d->anchor_pit_
1983 << " anchor ypos = " << d->anchor_ypos_);
1985 // Redo paragraphs above anchor if necessary.
1986 int y1 = d->anchor_ypos_ - anchor_pm.ascent();
1987 // We are now just above the anchor paragraph.
1988 pit_type pit1 = d->anchor_pit_ - 1;
1989 for (; pit1 >= 0 && y1 >= 0; --pit1) {
1990 tm.redoParagraph(pit1);
1991 ParagraphMetrics & pm = tm.par_metrics_[pit1];
1993 // Save the paragraph position in the cache.
1998 // Redo paragraphs below the anchor if necessary.
1999 int y2 = d->anchor_ypos_ + anchor_pm.descent();
2000 // We are now just below the anchor paragraph.
2001 pit_type pit2 = d->anchor_pit_ + 1;
2002 for (; pit2 < npit && y2 <= height_; ++pit2) {
2003 tm.redoParagraph(pit2);
2004 ParagraphMetrics & pm = tm.par_metrics_[pit2];
2006 // Save the paragraph position in the cache.
2011 LYXERR(Debug::PAINTING, "Metrics: "
2012 << " anchor pit = " << d->anchor_pit_
2013 << " anchor ypos = " << d->anchor_ypos_
2016 << " pit1 = " << pit1
2017 << " pit2 = " << pit2);
2019 d->update_strategy_ = FullScreenUpdate;
2021 if (lyxerr.debugging(Debug::WORKAREA)) {
2022 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
2023 d->coord_cache_.dump();
2028 void BufferView::insertLyXFile(FileName const & fname)
2030 LASSERT(d->cursor_.inTexted(), /**/);
2032 // Get absolute path of file and add ".lyx"
2033 // to the filename if necessary
2034 FileName filename = fileSearch(string(), fname.absFilename(), "lyx");
2036 docstring const disp_fn = makeDisplayPath(filename.absFilename());
2037 // emit message signal.
2038 message(bformat(_("Inserting document %1$s..."), disp_fn));
2041 Buffer buf("", false);
2042 if (buf.loadLyXFile(filename)) {
2043 ErrorList & el = buffer_.errorList("Parse");
2044 // Copy the inserted document error list into the current buffer one.
2045 el = buf.errorList("Parse");
2046 buffer_.undo().recordUndo(d->cursor_);
2047 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
2048 buf.params().documentClassPtr(), el);
2049 res = _("Document %1$s inserted.");
2051 res = _("Could not insert document %1$s");
2056 // emit message signal.
2057 message(bformat(res, disp_fn));
2058 buffer_.errors("Parse");
2062 Point BufferView::coordOffset(DocIterator const & dit, bool boundary) const
2068 // Addup contribution of nested insets, from inside to outside,
2069 // keeping the outer paragraph for a special handling below
2070 for (size_t i = dit.depth() - 1; i >= 1; --i) {
2071 CursorSlice const & sl = dit[i];
2075 // get relative position inside sl.inset()
2076 sl.inset().cursorPos(*this, sl, boundary && (i + 1 == dit.depth()), xx, yy);
2078 // Make relative position inside of the edited inset relative to sl.inset()
2082 // In case of an RTL inset, the edited inset will be positioned to the left
2085 bool boundary_i = boundary && i + 1 == dit.depth();
2086 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2091 // remember width for the case that sl.inset() is positioned in an RTL inset
2092 if (i && dit[i - 1].text()) {
2093 // If this Inset is inside a Text Inset, retrieve the Dimension
2094 // from the containing text instead of using Inset::dimension() which
2095 // might not be implemented.
2096 // FIXME (Abdel 23/09/2007): this is a bit messy because of the
2097 // elimination of Inset::dim_ cache. This coordOffset() method needs
2098 // to be rewritten in light of the new design.
2099 Dimension const & dim = parMetrics(dit[i - 1].text(),
2100 dit[i - 1].pit()).insetDimension(&sl.inset());
2103 Dimension const dim = sl.inset().dimension(*this);
2107 //lyxerr << "Cursor::getPos, i: "
2108 // << i << " x: " << xx << " y: " << y << endl;
2111 // Add contribution of initial rows of outermost paragraph
2112 CursorSlice const & sl = dit[0];
2113 TextMetrics const & tm = textMetrics(sl.text());
2114 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2115 LASSERT(!pm.rows().empty(), /**/);
2116 y -= pm.rows()[0].ascent();
2118 // FIXME: document this mess
2120 if (sl.pos() > 0 && dit.depth() == 1) {
2122 if (pos && boundary)
2124 // lyxerr << "coordOffset: boundary:" << boundary << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
2125 rend = pm.pos2row(pos);
2127 rend = pm.pos2row(sl.pos());
2129 size_t rend = pm.pos2row(sl.pos());
2131 for (size_t rit = 0; rit != rend; ++rit)
2132 y += pm.rows()[rit].height();
2133 y += pm.rows()[rend].ascent();
2135 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
2137 // Make relative position from the nested inset now bufferview absolute.
2138 int xx = bottom_tm.cursorX(dit.bottom(), boundary && dit.depth() == 1);
2141 // In the RTL case place the nested inset at the left of the cursor in
2142 // the outer paragraph
2143 bool boundary_1 = boundary && 1 == dit.depth();
2144 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
2152 Point BufferView::getPos(DocIterator const & dit, bool boundary) const
2154 CursorSlice const & bot = dit.bottom();
2155 TextMetrics const & tm = textMetrics(bot.text());
2156 if (!tm.contains(bot.pit()))
2157 return Point(-1, -1);
2159 Point p = coordOffset(dit, boundary); // offset from outer paragraph
2160 p.y_ += tm.parMetrics(bot.pit()).position();
2165 void BufferView::draw(frontend::Painter & pain)
2167 if (height_ == 0 || width_ == 0)
2169 LYXERR(Debug::PAINTING, "\t\t*** START DRAWING ***");
2170 Text & text = buffer_.text();
2171 TextMetrics const & tm = d->text_metrics_[&text];
2172 int const y = tm.first().second->position();
2173 PainterInfo pi(this, pain);
2175 switch (d->update_strategy_) {
2177 case NoScreenUpdate:
2178 // If no screen painting is actually needed, only some the different
2179 // coordinates of insets and paragraphs needs to be updated.
2180 pi.full_repaint = true;
2181 pi.pain.setDrawingEnabled(false);
2185 case SingleParUpdate:
2186 pi.full_repaint = false;
2187 // In general, only the current row of the outermost paragraph
2188 // will be redrawn. Particular cases where selection spans
2189 // multiple paragraph are correctly detected in TextMetrics.
2193 case DecorationUpdate:
2194 // FIXME: We should also distinguish DecorationUpdate to avoid text
2195 // drawing if possible. This is not possible to do easily right now
2196 // because of the single backing pixmap.
2198 case FullScreenUpdate:
2199 // The whole screen, including insets, will be refreshed.
2200 pi.full_repaint = true;
2202 // Clear background.
2203 pain.fillRectangle(0, 0, width_, height_,
2204 buffer_.inset().backgroundColor());
2209 // and possibly grey out below
2210 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2211 int const y2 = lastpm.second->position() + lastpm.second->descent();
2213 pain.fillRectangle(0, y2, width_, height_ - y2, Color_bottomarea);
2216 LYXERR(Debug::PAINTING, "\n\t\t*** END DRAWING ***");
2218 // The scrollbar needs an update.
2221 // Normalize anchor for next time
2222 pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
2223 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2224 for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
2225 ParagraphMetrics const & pm = tm.parMetrics(pit);
2226 if (pm.position() + pm.descent() > 0) {
2227 d->anchor_pit_ = pit;
2228 d->anchor_ypos_ = pm.position();
2232 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
2233 << " anchor ypos = " << d->anchor_ypos_);
2237 void BufferView::message(docstring const & msg)
2240 d->gui_->message(msg);
2244 void BufferView::showDialog(string const & name)
2247 d->gui_->showDialog(name, string());
2251 void BufferView::showDialog(string const & name,
2252 string const & data, Inset * inset)
2255 d->gui_->showDialog(name, data, inset);
2259 void BufferView::updateDialog(string const & name, string const & data)
2262 d->gui_->updateDialog(name, data);
2266 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
2272 // FIXME: Move this out of BufferView again
2273 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
2275 if (!fname.isReadableFile()) {
2276 docstring const error = from_ascii(strerror(errno));
2277 docstring const file = makeDisplayPath(fname.absFilename(), 50);
2278 docstring const text =
2279 bformat(_("Could not read the specified document\n"
2280 "%1$s\ndue to the error: %2$s"), file, error);
2281 Alert::error(_("Could not read file"), text);
2285 if (!fname.isReadableFile()) {
2286 docstring const file = makeDisplayPath(fname.absFilename(), 50);
2287 docstring const text =
2288 bformat(_("%1$s\n is not readable."), file);
2289 Alert::error(_("Could not open file"), text);
2293 // FIXME UNICODE: We don't know the encoding of the file
2294 docstring file_content = fname.fileContents("UTF-8");
2295 if (file_content.empty()) {
2296 Alert::error(_("Reading not UTF-8 encoded file"),
2297 _("The file is not UTF-8 encoded.\n"
2298 "It will be read as local 8Bit-encoded.\n"
2299 "If this does not give the correct result\n"
2300 "then please change the encoding of the file\n"
2301 "to UTF-8 with a program other than LyX.\n"));
2302 file_content = fname.fileContents("local8bit");
2305 return normalize_c(file_content);
2309 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
2311 docstring const tmpstr = contentsOfPlaintextFile(f);
2316 Cursor & cur = cursor();
2317 cap::replaceSelection(cur);
2318 buffer_.undo().recordUndo(cur);
2320 cur.innerText()->insertStringAsParagraphs(cur, tmpstr);
2322 cur.innerText()->insertStringAsLines(cur, tmpstr);
2329 docstring const & BufferView::inlineCompletion() const
2331 return d->inlineCompletion_;
2335 size_t const & BufferView::inlineCompletionUniqueChars() const
2337 return d->inlineCompletionUniqueChars_;
2341 DocIterator const & BufferView::inlineCompletionPos() const
2343 return d->inlineCompletionPos_;
2347 bool samePar(DocIterator const & a, DocIterator const & b)
2349 if (a.empty() && b.empty())
2351 if (a.empty() || b.empty())
2353 return &a.innerParagraph() == &b.innerParagraph();
2357 void BufferView::setInlineCompletion(Cursor & cur, DocIterator const & pos,
2358 docstring const & completion, size_t uniqueChars)
2360 uniqueChars = min(completion.size(), uniqueChars);
2361 bool changed = d->inlineCompletion_ != completion
2362 || d->inlineCompletionUniqueChars_ != uniqueChars;
2363 bool singlePar = true;
2364 d->inlineCompletion_ = completion;
2365 d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
2367 //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
2370 DocIterator const & old = d->inlineCompletionPos_;
2372 //lyxerr << "inlineCompletionPos changed" << std::endl;
2373 // old or pos are in another paragraph?
2374 if ((!samePar(cur, pos) && !pos.empty())
2375 || (!samePar(cur, old) && !old.empty())) {
2377 //lyxerr << "different paragraph" << std::endl;
2379 d->inlineCompletionPos_ = pos;
2384 if (singlePar && !(cur.disp_.update() & Update::Force))
2385 cur.updateFlags(cur.disp_.update() | Update::SinglePar);
2387 cur.updateFlags(cur.disp_.update() | Update::Force);