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;
553 // No scrolling at all? No need to redraw anything
557 // If the offset is less than 2 screen height, prefer to scroll instead.
558 if (abs(offset) <= 2 * height_) {
559 d->anchor_ypos_ -= offset;
565 // cut off at the top
566 if (value <= d->scrollbarParameters_.min) {
567 DocIterator dit = doc_iterator_begin(buffer_.inset());
569 LYXERR(Debug::SCROLLING, "scroll to top");
573 // cut off at the bottom
574 if (value >= d->scrollbarParameters_.max) {
575 DocIterator dit = doc_iterator_end(buffer_.inset());
578 LYXERR(Debug::SCROLLING, "scroll to bottom");
582 // find paragraph at target position
583 int par_pos = d->scrollbarParameters_.min;
585 for (; i != int(d->par_height_.size()); ++i) {
586 par_pos += d->par_height_[i];
587 if (par_pos >= value)
591 if (par_pos < value) {
592 // It seems we didn't find the correct pit so stay on the safe side and
594 LYXERR0("scrolling position not found!");
595 scrollDocView(d->scrollbarParameters_.max);
599 DocIterator dit = doc_iterator_begin(buffer_.inset());
601 LYXERR(Debug::SCROLLING, "value = " << value << " -> scroll to pit " << i);
606 // FIXME: this method is not working well.
607 void BufferView::setCursorFromScrollbar()
609 TextMetrics & tm = d->text_metrics_[&buffer_.text()];
611 int const height = 2 * defaultRowHeight();
612 int const first = height;
613 int const last = height_ - height;
615 Cursor const & oldcur = d->cursor_;
617 switch (cursorStatus(oldcur)) {
625 int const y = getPos(oldcur, oldcur.boundary()).y_;
626 newy = min(last, max(y, first));
630 // We reset the cursor because cursorStatus() does not
631 // work when the cursor is within mathed.
633 cur.reset(buffer_.inset());
634 tm.setCursorFromCoordinates(cur, 0, newy);
636 // update the bufferview cursor and notify insets
637 // FIXME: Care about the d->cursor_ flags to redraw if needed
638 Cursor old = d->cursor_;
640 bool badcursor = notifyCursorLeavesOrEnters(old, d->cursor_);
642 d->cursor_.fixIfBroken();
646 Change const BufferView::getCurrentChange() const
648 if (!d->cursor_.selection())
649 return Change(Change::UNCHANGED);
651 DocIterator dit = d->cursor_.selectionBegin();
652 return dit.paragraph().lookupChange(dit.pos());
656 // this could be used elsewhere as well?
657 // FIXME: This does not work within mathed!
658 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
660 Point const p = getPos(dit, dit.boundary());
663 if (p.y_ > workHeight())
669 void BufferView::saveBookmark(unsigned int idx)
671 // tenatively save bookmark, id and pos will be used to
672 // acturately locate a bookmark in a 'live' lyx session.
673 // pit and pos will be updated with bottom level pit/pos
675 theSession().bookmarks().save(
677 d->cursor_.bottom().pit(),
678 d->cursor_.bottom().pos(),
679 d->cursor_.paragraph().id(),
684 // emit message signal.
685 message(_("Save bookmark"));
689 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
690 int top_id, pos_type top_pos)
692 bool success = false;
695 d->cursor_.clearSelection();
697 // if a valid par_id is given, try it first
698 // This is the case for a 'live' bookmark when unique paragraph ID
699 // is used to track bookmarks.
701 dit = buffer_.getParFromID(top_id);
703 dit.pos() = min(dit.paragraph().size(), top_pos);
704 // Some slices of the iterator may not be
705 // reachable (e.g. closed collapsable inset)
706 // so the dociterator may need to be
707 // shortened. Otherwise, setCursor may crash
708 // lyx when the cursor can not be set to these
710 size_t const n = dit.depth();
711 for (size_t i = 0; i < n; ++i)
712 if (dit[i].inset().editable() != Inset::HIGHLY_EDITABLE) {
720 // if top_id == 0, or searching through top_id failed
721 // This is the case for a 'restored' bookmark when only bottom
722 // (document level) pit was saved. Because of this, bookmark
723 // restoration is inaccurate. If a bookmark was within an inset,
724 // it will be restored to the left of the outmost inset that contains
726 if (bottom_pit < int(buffer_.paragraphs().size())) {
727 dit = doc_iterator_begin(buffer_.inset());
729 dit.pit() = bottom_pit;
730 dit.pos() = min(bottom_pos, dit.paragraph().size());
735 // Note: only bottom (document) level pit is set.
737 // set the current font.
738 d->cursor_.setCurrentFont();
739 // To center the screen on this new position we need the
740 // paragraph position which is computed at draw() time.
741 // So we need a redraw!
751 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
753 if (lyxrc.rtl_support) {
754 if (d->cursor_.real_current_font.isRightToLeft()) {
755 if (d->intl_.keymap == Intl::PRIMARY)
756 d->intl_.keyMapSec();
758 if (d->intl_.keymap == Intl::SECONDARY)
759 d->intl_.keyMapPrim();
763 d->intl_.getTransManager().translateAndInsert(c, t, cur);
767 int BufferView::workWidth() const
773 void BufferView::showCursor()
775 showCursor(d->cursor_);
779 void BufferView::showCursor(DocIterator const & dit)
781 // We are not properly started yet, delay until resizing is
786 LYXERR(Debug::SCROLLING, "recentering!");
788 CursorSlice const & bot = dit.bottom();
789 TextMetrics & tm = d->text_metrics_[bot.text()];
791 pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
792 int bot_pit = bot.pit();
793 if (bot_pit > max_pit) {
794 // FIXME: Why does this happen?
795 LYXERR0("bottom pit is greater that max pit: "
796 << bot_pit << " > " << max_pit);
800 if (bot_pit == tm.first().first - 1)
801 tm.newParMetricsUp();
802 else if (bot_pit == tm.last().first + 1)
803 tm.newParMetricsDown();
805 if (tm.contains(bot_pit)) {
806 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
807 LASSERT(!pm.rows().empty(), /**/);
808 // FIXME: smooth scrolling doesn't work in mathed.
809 CursorSlice const & cs = dit.innerTextSlice();
810 int offset = coordOffset(dit, dit.boundary()).y_;
811 int ypos = pm.position() + offset;
812 Dimension const & row_dim =
813 pm.getRow(cs.pos(), dit.boundary()).dimension();
815 if (ypos - row_dim.ascent() < 0)
816 scrolled = scrollUp(- ypos + row_dim.ascent());
817 else if (ypos + row_dim.descent() > height_)
818 scrolled = scrollDown(ypos - height_ + row_dim.descent());
819 // else, nothing to do, the cursor is already visible so we just return.
827 // fix inline completion position
828 if (d->inlineCompletionPos_.fixIfBroken())
829 d->inlineCompletionPos_ = DocIterator();
831 tm.redoParagraph(bot_pit);
832 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
833 int offset = coordOffset(dit, dit.boundary()).y_;
835 d->anchor_pit_ = bot_pit;
836 CursorSlice const & cs = dit.innerTextSlice();
837 Dimension const & row_dim =
838 pm.getRow(cs.pos(), dit.boundary()).dimension();
840 if (d->anchor_pit_ == 0)
841 d->anchor_ypos_ = offset + pm.ascent();
842 else if (d->anchor_pit_ == max_pit)
843 d->anchor_ypos_ = height_ - offset - row_dim.descent();
845 d->anchor_ypos_ = defaultRowHeight() * 2 - offset - row_dim.descent();
852 FuncStatus BufferView::getStatus(FuncRequest const & cmd)
856 Cursor & cur = d->cursor_;
858 switch (cmd.action) {
861 flag.setEnabled(buffer_.undo().hasUndoStack());
864 flag.setEnabled(buffer_.undo().hasRedoStack());
866 case LFUN_FILE_INSERT:
867 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
868 case LFUN_FILE_INSERT_PLAINTEXT:
869 case LFUN_BOOKMARK_SAVE:
870 // FIXME: Actually, these LFUNS should be moved to Text
871 flag.setEnabled(cur.inTexted());
873 case LFUN_FONT_STATE:
874 case LFUN_LABEL_INSERT:
875 case LFUN_INFO_INSERT:
876 case LFUN_INSET_EDIT:
877 case LFUN_PARAGRAPH_GOTO:
879 case LFUN_REFERENCE_NEXT:
881 case LFUN_WORD_FINDADV:
882 case LFUN_WORD_REPLACE:
885 case LFUN_MARK_TOGGLE:
886 case LFUN_SCREEN_RECENTER:
887 case LFUN_BIBTEX_DATABASE_ADD:
888 case LFUN_BIBTEX_DATABASE_DEL:
889 case LFUN_NOTES_MUTATE:
890 case LFUN_ALL_INSETS_TOGGLE:
891 case LFUN_STATISTICS:
892 flag.setEnabled(true);
895 // @todo Test if current WorkArea is the search WorkArea
896 case LFUN_REGEXP_MODE:
897 flag.setEnabled(! this->cursor().inRegexped());
900 case LFUN_COPY_LABEL_AS_REF: {
901 // if there is an inset at cursor, see whether it
902 // handles the lfun, other start from scratch
903 Inset * inset = cur.nextInset();
904 if (!inset || !inset->getStatus(cur, cmd, flag))
905 flag = lyx::getStatus(cmd);
909 case LFUN_NEXT_INSET_TOGGLE:
910 case LFUN_NEXT_INSET_MODIFY: {
911 // this is the real function we want to invoke
912 FuncRequest tmpcmd = cmd;
913 tmpcmd.action = (cmd.action == LFUN_NEXT_INSET_TOGGLE)
914 ? LFUN_INSET_TOGGLE : LFUN_INSET_MODIFY;
915 // if there is an inset at cursor, see whether it
916 // handles the lfun, other start from scratch
917 Inset * inset = cur.nextInset();
918 if (!inset || !inset->getStatus(cur, tmpcmd, flag))
919 flag = lyx::getStatus(tmpcmd);
923 case LFUN_LABEL_GOTO: {
924 flag.setEnabled(!cmd.argument().empty()
925 || getInsetByCode<InsetRef>(cur, REF_CODE));
929 case LFUN_CHANGES_TRACK:
930 flag.setEnabled(true);
931 flag.setOnOff(buffer_.params().trackChanges);
934 case LFUN_CHANGES_OUTPUT:
935 flag.setEnabled(true);
936 flag.setOnOff(buffer_.params().outputChanges);
939 case LFUN_CHANGES_MERGE:
940 case LFUN_CHANGE_NEXT:
941 case LFUN_ALL_CHANGES_ACCEPT:
942 case LFUN_ALL_CHANGES_REJECT:
943 // TODO: context-sensitive enabling of LFUNs
944 // In principle, these command should only be enabled if there
945 // is a change in the document. However, without proper
946 // optimizations, this will inevitably result in poor performance.
947 flag.setEnabled(true);
950 case LFUN_BUFFER_TOGGLE_COMPRESSION: {
951 flag.setOnOff(buffer_.params().compressed);
956 case LFUN_SCREEN_DOWN:
958 case LFUN_SCREEN_UP_SELECT:
959 case LFUN_SCREEN_DOWN_SELECT:
960 flag.setEnabled(true);
963 case LFUN_LAYOUT_TABULAR:
964 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
968 flag.setEnabled(!cur.inset().forcePlainLayout(cur.idx()));
971 case LFUN_LAYOUT_PARAGRAPH:
972 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
975 case LFUN_INSET_SETTINGS: {
976 InsetCode code = cur.inset().lyxCode();
977 if (cmd.getArg(0) == insetName(code)) {
978 flag.setEnabled(true);
982 InsetCode next_code = cur.nextInset()
983 ? cur.nextInset()->lyxCode() : NO_CODE;
984 //FIXME: remove these special cases:
994 enable = (cmd.argument().empty() ||
995 cmd.getArg(0) == insetName(next_code));
1000 flag.setEnabled(enable);
1004 case LFUN_DIALOG_SHOW_NEW_INSET:
1005 flag.setEnabled(cur.inset().lyxCode() != ERT_CODE &&
1006 cur.inset().lyxCode() != LISTINGS_CODE);
1007 if (cur.inset().lyxCode() == CAPTION_CODE) {
1009 if (cur.inset().getStatus(cur, cmd, flag))
1014 case LFUN_BRANCH_ACTIVATE:
1015 case LFUN_BRANCH_DEACTIVATE: {
1016 bool enable = false;
1017 docstring const branchName = cmd.argument();
1018 if (!branchName.empty())
1019 enable = buffer_.params().branchlist().find(branchName);
1020 flag.setEnabled(enable);
1025 flag.setEnabled(false);
1032 bool BufferView::dispatch(FuncRequest const & cmd)
1034 //lyxerr << [ cmd = " << cmd << "]" << endl;
1036 // Make sure that the cached BufferView is correct.
1037 LYXERR(Debug::ACTION, " action[" << cmd.action << ']'
1038 << " arg[" << to_utf8(cmd.argument()) << ']'
1039 << " x[" << cmd.x << ']'
1040 << " y[" << cmd.y << ']'
1041 << " button[" << cmd.button() << ']');
1043 Cursor & cur = d->cursor_;
1045 switch (cmd.action) {
1048 cur.message(_("Undo"));
1049 cur.clearSelection();
1050 if (!cur.textUndo())
1051 cur.message(_("No further undo information"));
1053 processUpdateFlags(Update::Force | Update::FitCursor);
1057 cur.message(_("Redo"));
1058 cur.clearSelection();
1059 if (!cur.textRedo())
1060 cur.message(_("No further redo information"));
1062 processUpdateFlags(Update::Force | Update::FitCursor);
1065 case LFUN_FONT_STATE:
1066 cur.message(cur.currentState());
1069 case LFUN_BOOKMARK_SAVE:
1070 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1073 case LFUN_LABEL_GOTO: {
1074 docstring label = cmd.argument();
1075 if (label.empty()) {
1077 getInsetByCode<InsetRef>(d->cursor_,
1080 label = inset->getParam("reference");
1081 // persistent=false: use temp_bookmark
1091 case LFUN_INSET_EDIT: {
1092 FuncRequest fr(cmd);
1093 // if there is an inset at cursor, see whether it
1095 Inset * inset = cur.nextInset();
1097 inset->dispatch(cur, fr);
1098 // if it did not work, try the underlying inset.
1099 if (!inset || !cur.result().dispatched())
1102 // FIXME I'm adding the last break to solve a crash,
1103 // but that is obviously not right.
1104 if (!cur.result().dispatched())
1105 // It did not work too; no action needed.
1110 case LFUN_PARAGRAPH_GOTO: {
1111 int const id = convert<int>(cmd.getArg(0));
1112 int const pos = convert<int>(cmd.getArg(1));
1114 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1115 b = theBufferList().next(b)) {
1117 DocIterator dit = b->getParFromID(id);
1119 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1123 LYXERR(Debug::INFO, "Paragraph " << dit.paragraph().id()
1124 << " found in buffer `"
1125 << b->absFileName() << "'.");
1127 if (b == &buffer_) {
1131 processUpdateFlags(Update::Force | Update::FitCursor);
1133 // Switch to other buffer view and resend cmd
1134 theLyXFunc().dispatch(FuncRequest(
1135 LFUN_BUFFER_SWITCH, b->absFileName()));
1136 theLyXFunc().dispatch(cmd);
1143 case LFUN_NOTE_NEXT:
1144 gotoInset(this, NOTE_CODE, false);
1147 case LFUN_REFERENCE_NEXT: {
1148 vector<InsetCode> tmp;
1149 tmp.push_back(LABEL_CODE);
1150 tmp.push_back(REF_CODE);
1151 gotoInset(this, tmp, true);
1155 case LFUN_CHANGES_TRACK:
1156 buffer_.params().trackChanges = !buffer_.params().trackChanges;
1159 case LFUN_CHANGES_OUTPUT:
1160 buffer_.params().outputChanges = !buffer_.params().outputChanges;
1161 if (buffer_.params().outputChanges) {
1162 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1163 bool xcolorsoul = LaTeXFeatures::isAvailable("soul") &&
1164 LaTeXFeatures::isAvailable("xcolor");
1166 if (!dvipost && !xcolorsoul) {
1167 Alert::warning(_("Changes not shown in LaTeX output"),
1168 _("Changes will not be highlighted in LaTeX output, "
1169 "because neither dvipost nor xcolor/soul are installed.\n"
1170 "Please install these packages or redefine "
1171 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1172 } else if (!xcolorsoul) {
1173 Alert::warning(_("Changes not shown in LaTeX output"),
1174 _("Changes will not be highlighted in LaTeX output "
1175 "when using pdflatex, because xcolor and soul are not installed.\n"
1176 "Please install both packages or redefine "
1177 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1182 case LFUN_CHANGE_NEXT:
1183 findNextChange(this);
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_CHANGES_MERGE:
1189 if (findNextChange(this)) {
1190 processUpdateFlags(Update::Force | Update::FitCursor);
1191 showDialog("changes");
1195 case LFUN_ALL_CHANGES_ACCEPT:
1196 // select complete document
1197 d->cursor_.reset(buffer_.inset());
1198 d->cursor_.selHandle(true);
1199 buffer_.text().cursorBottom(d->cursor_);
1200 // accept everything in a single step to support atomic undo
1201 buffer_.text().acceptOrRejectChanges(d->cursor_, Text::ACCEPT);
1202 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1203 processUpdateFlags(Update::Force | Update::FitCursor);
1206 case LFUN_ALL_CHANGES_REJECT:
1207 // select complete document
1208 d->cursor_.reset(buffer_.inset());
1209 d->cursor_.selHandle(true);
1210 buffer_.text().cursorBottom(d->cursor_);
1211 // reject everything in a single step to support atomic undo
1212 // Note: reject does not work recursively; the user may have to repeat the operation
1213 buffer_.text().acceptOrRejectChanges(d->cursor_, Text::REJECT);
1214 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1215 processUpdateFlags(Update::Force | Update::FitCursor);
1218 case LFUN_WORD_FIND: {
1219 FuncRequest req = cmd;
1220 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1221 req = d->search_request_cache_;
1222 if (req.argument().empty()) {
1223 theLyXFunc().dispatch(FuncRequest(LFUN_DIALOG_SHOW, "findreplace"));
1226 if (find(this, req))
1229 message(_("String not found!"));
1230 d->search_request_cache_ = req;
1234 case LFUN_WORD_REPLACE: {
1235 bool has_deleted = false;
1236 if (cur.selection()) {
1237 DocIterator beg = cur.selectionBegin();
1238 DocIterator end = cur.selectionEnd();
1239 if (beg.pit() == end.pit()) {
1240 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1241 if (cur.paragraph().isDeleted(p))
1246 replace(this, cmd, has_deleted);
1250 case LFUN_WORD_FINDADV:
1255 cur.clearSelection();
1257 cur.message(from_utf8(N_("Mark off")));
1261 cur.clearSelection();
1264 cur.message(from_utf8(N_("Mark on")));
1267 case LFUN_MARK_TOGGLE:
1268 cur.clearSelection();
1271 cur.message(from_utf8(N_("Mark removed")));
1274 cur.message(from_utf8(N_("Mark set")));
1279 case LFUN_SCREEN_RECENTER:
1283 case LFUN_BIBTEX_DATABASE_ADD: {
1284 Cursor tmpcur = d->cursor_;
1285 findInset(tmpcur, BIBTEX_CODE, false);
1286 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1289 if (inset->addDatabase(cmd.argument()))
1290 buffer_.updateBibfilesCache();
1295 case LFUN_BIBTEX_DATABASE_DEL: {
1296 Cursor tmpcur = d->cursor_;
1297 findInset(tmpcur, BIBTEX_CODE, false);
1298 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1301 if (inset->delDatabase(cmd.argument()))
1302 buffer_.updateBibfilesCache();
1307 case LFUN_STATISTICS: {
1308 DocIterator from, to;
1309 if (cur.selection()) {
1310 from = cur.selectionBegin();
1311 to = cur.selectionEnd();
1313 from = doc_iterator_begin(buffer_.inset());
1314 to = doc_iterator_end(buffer_.inset());
1316 int const words = countWords(from, to);
1317 int const chars = countChars(from, to, false);
1318 int const chars_blanks = countChars(from, to, true);
1320 if (cur.selection())
1321 message = _("Statistics for the selection:");
1323 message = _("Statistics for the document:");
1326 message += bformat(_("%1$d words"), words);
1328 message += _("One word");
1330 if (chars_blanks != 1)
1331 message += bformat(_("%1$d characters (including blanks)"),
1334 message += _("One character (including blanks)");
1337 message += bformat(_("%1$d characters (excluding blanks)"),
1340 message += _("One character (excluding blanks)");
1342 Alert::information(_("Statistics"), message);
1346 case LFUN_BUFFER_TOGGLE_COMPRESSION:
1347 // turn compression on/off
1348 buffer_.params().compressed = !buffer_.params().compressed;
1350 case LFUN_COPY_LABEL_AS_REF: {
1351 // if there is an inset at cursor, try to copy it
1352 Inset * inset = cur.nextInset();
1354 FuncRequest tmpcmd = cmd;
1355 inset->dispatch(cur, tmpcmd);
1357 if (!cur.result().dispatched())
1358 // It did not work too; no action needed.
1360 cur.clearSelection();
1361 processUpdateFlags(Update::SinglePar | Update::FitCursor);
1364 case LFUN_NEXT_INSET_TOGGLE: {
1365 // create the the real function we want to invoke
1366 FuncRequest tmpcmd = cmd;
1367 tmpcmd.action = LFUN_INSET_TOGGLE;
1368 // if there is an inset at cursor, see whether it
1370 Inset * inset = cur.nextInset();
1372 if (inset->isActive()) {
1373 Cursor tmpcur = cur;
1374 tmpcur.pushBackward(*inset);
1375 inset->dispatch(tmpcur, tmpcmd);
1376 if (tmpcur.result().dispatched())
1379 inset->dispatch(cur, tmpcmd);
1381 // if it did not work, try the underlying inset.
1382 if (!inset || !cur.result().dispatched())
1383 cur.dispatch(tmpcmd);
1385 if (!cur.result().dispatched())
1386 // It did not work too; no action needed.
1388 cur.clearSelection();
1389 processUpdateFlags(Update::SinglePar | Update::FitCursor);
1393 case LFUN_NEXT_INSET_MODIFY: {
1394 // create the the real function we want to invoke
1395 FuncRequest tmpcmd = cmd;
1396 tmpcmd.action = LFUN_INSET_MODIFY;
1397 // if there is an inset at cursor, see whether it
1399 Inset * inset = cur.nextInset();
1401 inset->dispatch(cur, tmpcmd);
1402 // if it did not work, try the underlying inset.
1403 if (!inset || !cur.result().dispatched())
1404 cur.dispatch(tmpcmd);
1406 if (!cur.result().dispatched())
1407 // It did not work too; no action needed.
1409 cur.clearSelection();
1410 processUpdateFlags(Update::Force | Update::FitCursor);
1414 case LFUN_SCREEN_UP:
1415 case LFUN_SCREEN_DOWN: {
1416 Point p = getPos(cur, cur.boundary());
1417 if (p.y_ < 0 || p.y_ > height_) {
1418 // The cursor is off-screen so recenter before proceeding.
1420 p = getPos(cur, cur.boundary());
1422 int const scrolled = scroll(cmd.action == LFUN_SCREEN_UP
1423 ? - height_ : height_);
1424 if (cmd.action == LFUN_SCREEN_UP && scrolled > - height_)
1426 if (cmd.action == LFUN_SCREEN_DOWN && scrolled < height_)
1427 p = Point(width_, height_);
1428 cur.reset(buffer_.inset());
1431 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_);
1432 //FIXME: what to do with cur.x_target()?
1441 case LFUN_SCREEN_UP_SELECT: {
1442 cur.selHandle(true);
1443 if (isTopScreen()) {
1444 lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1448 int y = getPos(cur, cur.boundary()).y_;
1449 int const ymin = y - height_ + defaultRowHeight();
1450 while (y > ymin && cur.up())
1451 y = getPos(cur, cur.boundary()).y_;
1454 processUpdateFlags(Update::SinglePar | Update::FitCursor);
1458 case LFUN_SCREEN_DOWN_SELECT: {
1459 cur.selHandle(true);
1460 if (isBottomScreen()) {
1461 lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1465 int y = getPos(cur, cur.boundary()).y_;
1466 int const ymax = y + height_ - defaultRowHeight();
1467 while (y < ymax && cur.down())
1468 y = getPos(cur, cur.boundary()).y_;
1471 processUpdateFlags(Update::SinglePar | Update::FitCursor);
1475 case LFUN_BRANCH_ACTIVATE:
1476 case LFUN_BRANCH_DEACTIVATE:
1477 buffer_.dispatch(cmd);
1478 processUpdateFlags(Update::Force);
1481 // This could be rewriten using some command like forall <insetname> <command>
1482 // once the insets refactoring is done.
1483 case LFUN_NOTES_MUTATE: {
1484 if (cmd.argument().empty())
1487 if (mutateNotes(cur, cmd.getArg(0), cmd.getArg(1))) {
1488 processUpdateFlags(Update::Force);
1493 case LFUN_ALL_INSETS_TOGGLE: {
1495 string const name = split(to_utf8(cmd.argument()), action, ' ');
1496 InsetCode const inset_code = insetCode(name);
1498 FuncRequest fr(LFUN_INSET_TOGGLE, action);
1500 Inset & inset = cur.buffer().inset();
1501 InsetIterator it = inset_iterator_begin(inset);
1502 InsetIterator const end = inset_iterator_end(inset);
1503 for (; it != end; ++it) {
1504 if (it->asInsetCollapsable()
1505 && (inset_code == NO_CODE
1506 || inset_code == it->lyxCode())) {
1507 Cursor tmpcur = cur;
1508 tmpcur.pushBackward(*it);
1509 it->dispatch(tmpcur, fr);
1512 processUpdateFlags(Update::Force | Update::FitCursor);
1524 docstring const BufferView::requestSelection()
1526 Cursor & cur = d->cursor_;
1528 LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
1529 if (!cur.selection()) {
1530 d->xsel_cache_.set = false;
1534 LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
1535 if (!d->xsel_cache_.set ||
1536 cur.top() != d->xsel_cache_.cursor ||
1537 cur.anchor_.top() != d->xsel_cache_.anchor)
1539 d->xsel_cache_.cursor = cur.top();
1540 d->xsel_cache_.anchor = cur.anchor_.top();
1541 d->xsel_cache_.set = cur.selection();
1542 return cur.selectionAsString(false);
1548 void BufferView::clearSelection()
1550 d->cursor_.clearSelection();
1551 // Clear the selection buffer. Otherwise a subsequent
1552 // middle-mouse-button paste would use the selection buffer,
1553 // not the more current external selection.
1554 cap::clearSelection();
1555 d->xsel_cache_.set = false;
1556 // The buffer did not really change, but this causes the
1557 // redraw we need because we cleared the selection above.
1562 void BufferView::resize(int width, int height)
1564 // Update from work area
1568 // Clear the paragraph height cache.
1569 d->par_height_.clear();
1570 // Redo the metrics.
1575 Inset const * BufferView::getCoveringInset(Text const & text,
1578 TextMetrics & tm = d->text_metrics_[&text];
1579 Inset * inset = tm.checkInsetHit(x, y);
1583 if (!inset->descendable())
1584 // No need to go further down if the inset is not
1588 size_t cell_number = inset->nargs();
1589 // Check all the inner cell.
1590 for (size_t i = 0; i != cell_number; ++i) {
1591 Text const * inner_text = inset->getText(i);
1594 Inset const * inset_deeper =
1595 getCoveringInset(*inner_text, x, y);
1597 return inset_deeper;
1605 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
1607 //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
1609 // This is only called for mouse related events including
1610 // LFUN_FILE_OPEN generated by drag-and-drop.
1611 FuncRequest cmd = cmd0;
1613 Cursor old = cursor();
1615 cur.push(buffer_.inset());
1616 cur.setSelection(d->cursor_.selection());
1618 // Either the inset under the cursor or the
1619 // surrounding Text will handle this event.
1621 // make sure we stay within the screen...
1622 cmd.y = min(max(cmd.y, -1), height_);
1624 if (cmd.action == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
1626 // Get inset under mouse, if there is one.
1627 Inset const * covering_inset =
1628 getCoveringInset(buffer_.text(), cmd.x, cmd.y);
1629 if (covering_inset == d->last_inset_)
1630 // Same inset, no need to do anything...
1633 bool need_redraw = false;
1634 // const_cast because of setMouseHover().
1635 Inset * inset = const_cast<Inset *>(covering_inset);
1637 // Remove the hint on the last hovered inset (if any).
1638 need_redraw |= d->last_inset_->setMouseHover(false);
1640 // Highlighted the newly hovered inset (if any).
1641 need_redraw |= inset->setMouseHover(true);
1642 d->last_inset_ = inset;
1646 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
1647 << cmd.x << ", " << cmd.y << ")");
1649 d->update_strategy_ = DecorationUpdate;
1651 // This event (moving without mouse click) is not passed further.
1652 // This should be changed if it is further utilized.
1657 // Build temporary cursor.
1658 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x, cmd.y);
1660 // Put anchor at the same position.
1663 cur.beginUndoGroup();
1665 // Try to dispatch to an non-editable inset near this position
1666 // via the temp cursor. If the inset wishes to change the real
1667 // cursor it has to do so explicitly by using
1668 // cur.bv().cursor() = cur; (or similar)
1670 inset->dispatch(cur, cmd);
1672 // Now dispatch to the temporary cursor. If the real cursor should
1673 // be modified, the inset's dispatch has to do so explicitly.
1674 if (!inset || !cur.result().dispatched())
1679 // Notify left insets
1682 bool badcursor = notifyCursorLeavesOrEnters(old, cur);
1684 cursor().fixIfBroken();
1687 // Do we have a selection?
1688 theSelection().haveSelection(cursor().selection());
1690 // If the command has been dispatched,
1691 if (cur.result().dispatched() || cur.result().update())
1692 processUpdateFlags(cur.result().update());
1696 void BufferView::lfunScroll(FuncRequest const & cmd)
1698 string const scroll_type = cmd.getArg(0);
1699 int const scroll_step =
1700 (scroll_type == "line") ? d->scrollbarParameters_.single_step
1701 : (scroll_type == "page") ? d->scrollbarParameters_.page_step : 0;
1702 if (scroll_step == 0)
1704 string const scroll_quantity = cmd.getArg(1);
1705 if (scroll_quantity == "up")
1706 scrollUp(scroll_step);
1707 else if (scroll_quantity == "down")
1708 scrollDown(scroll_step);
1710 int const scroll_value = convert<int>(scroll_quantity);
1712 scroll(scroll_step * scroll_value);
1719 int BufferView::scroll(int y)
1722 return scrollDown(y);
1724 return scrollUp(-y);
1729 int BufferView::scrollDown(int offset)
1731 Text * text = &buffer_.text();
1732 TextMetrics & tm = d->text_metrics_[text];
1733 int ymax = height_ + offset;
1735 pair<pit_type, ParagraphMetrics const *> last = tm.last();
1736 int bottom_pos = last.second->position() + last.second->descent();
1737 if (last.first + 1 == int(text->paragraphs().size())) {
1738 if (bottom_pos <= height_)
1740 offset = min(offset, bottom_pos - height_);
1743 if (bottom_pos > ymax)
1745 tm.newParMetricsDown();
1747 d->anchor_ypos_ -= offset;
1752 int BufferView::scrollUp(int offset)
1754 Text * text = &buffer_.text();
1755 TextMetrics & tm = d->text_metrics_[text];
1756 int ymin = - offset;
1758 pair<pit_type, ParagraphMetrics const *> first = tm.first();
1759 int top_pos = first.second->position() - first.second->ascent();
1760 if (first.first == 0) {
1763 offset = min(offset, - top_pos);
1768 tm.newParMetricsUp();
1770 d->anchor_ypos_ += offset;
1775 void BufferView::setCursorFromRow(int row)
1780 buffer_.texrow().getIdFromRow(row, tmpid, tmppos);
1782 d->cursor_.reset(buffer_.inset());
1784 buffer_.text().setCursor(d->cursor_, 0, 0);
1786 buffer_.text().setCursor(d->cursor_, buffer_.getParFromID(tmpid).pit(), tmppos);
1790 bool BufferView::setCursorFromInset(Inset const * inset)
1792 // are we already there?
1793 if (cursor().nextInset() == inset)
1796 // Inset is not at cursor position. Find it in the document.
1798 cur.reset(buffer().inset());
1799 while (cur && cur.nextInset() != inset)
1810 void BufferView::gotoLabel(docstring const & label)
1812 Toc & toc = buffer().tocBackend().toc("label");
1813 TocIterator toc_it = toc.begin();
1814 TocIterator end = toc.end();
1815 for (; toc_it != end; ++toc_it) {
1816 if (label == toc_it->str())
1817 dispatch(toc_it->action());
1819 //FIXME: We could do a bit more searching thanks to this:
1820 //InsetLabel const * inset = buffer_.insetLabel(label);
1824 TextMetrics const & BufferView::textMetrics(Text const * t) const
1826 return const_cast<BufferView *>(this)->textMetrics(t);
1830 TextMetrics & BufferView::textMetrics(Text const * t)
1832 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
1833 if (tmc_it == d->text_metrics_.end()) {
1834 tmc_it = d->text_metrics_.insert(
1835 make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
1837 return tmc_it->second;
1841 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
1844 return textMetrics(t).parMetrics(pit);
1848 int BufferView::workHeight() const
1854 void BufferView::setCursor(DocIterator const & dit)
1856 size_t const n = dit.depth();
1857 for (size_t i = 0; i < n; ++i)
1858 dit[i].inset().edit(d->cursor_, true);
1860 d->cursor_.setCursor(dit);
1861 d->cursor_.setSelection(false);
1865 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
1867 // Would be wrong to delete anything if we have a selection.
1868 if (cur.selection())
1871 bool need_anchor_change = false;
1872 bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
1873 need_anchor_change);
1875 if (need_anchor_change)
1883 buffer_.updateLabels();
1891 bool BufferView::mouseSetCursor(Cursor & cur, bool select)
1893 LASSERT(&cur.bv() == this, /**/);
1896 // this event will clear selection so we save selection for
1897 // persistent selection
1898 cap::saveSelection(cursor());
1900 // Has the cursor just left the inset?
1901 bool leftinset = (&d->cursor_.inset() != &cur.inset());
1903 d->cursor_.fixIfBroken();
1905 // FIXME: shift-mouse selection doesn't work well across insets.
1906 bool do_selection = select && &d->cursor_.anchor().inset() == &cur.inset();
1908 // do the dEPM magic if needed
1909 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
1910 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
1911 // the leftinset bool would not be necessary (badcursor instead).
1912 bool update = leftinset;
1913 if (!do_selection && d->cursor_.inTexted())
1914 update |= checkDepm(cur, d->cursor_);
1916 d->cursor_.setCursor(cur);
1917 d->cursor_.boundary(cur.boundary());
1919 d->cursor_.setSelection();
1921 d->cursor_.clearSelection();
1923 d->cursor_.finishUndo();
1924 d->cursor_.setCurrentFont();
1929 void BufferView::putSelectionAt(DocIterator const & cur,
1930 int length, bool backwards)
1932 d->cursor_.clearSelection();
1938 d->cursor_.pos() += length;
1939 d->cursor_.setSelection(d->cursor_, -length);
1941 d->cursor_.setSelection(d->cursor_, length);
1943 // Ensure a redraw happens in any case because the new selection could
1944 // possibly be on the same screen as the previous selection.
1945 processUpdateFlags(Update::Force | Update::FitCursor);
1949 Cursor & BufferView::cursor()
1955 Cursor const & BufferView::cursor() const
1961 pit_type BufferView::anchor_ref() const
1963 return d->anchor_pit_;
1967 bool BufferView::singleParUpdate()
1969 Text & buftext = buffer_.text();
1970 pit_type const bottom_pit = d->cursor_.bottom().pit();
1971 TextMetrics & tm = textMetrics(&buftext);
1972 int old_height = tm.parMetrics(bottom_pit).height();
1974 // make sure inline completion pointer is ok
1975 if (d->inlineCompletionPos_.fixIfBroken())
1976 d->inlineCompletionPos_ = DocIterator();
1978 // In Single Paragraph mode, rebreak only
1979 // the (main text, not inset!) paragraph containing the cursor.
1980 // (if this paragraph contains insets etc., rebreaking will
1981 // recursively descend)
1982 tm.redoParagraph(bottom_pit);
1983 ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
1984 if (pm.height() != old_height)
1985 // Paragraph height has changed so we cannot proceed to
1986 // the singlePar optimisation.
1989 d->update_strategy_ = SingleParUpdate;
1991 LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
1992 << " y2: " << pm.position() + pm.descent()
1993 << " pit: " << bottom_pit
1994 << " singlepar: 1");
1999 void BufferView::updateMetrics()
2001 if (height_ == 0 || width_ == 0)
2004 Text & buftext = buffer_.text();
2005 pit_type const npit = int(buftext.paragraphs().size());
2007 // Clear out the position cache in case of full screen redraw,
2008 d->coord_cache_.clear();
2010 // Clear out paragraph metrics to avoid having invalid metrics
2011 // in the cache from paragraphs not relayouted below
2012 // The complete text metrics will be redone.
2013 d->text_metrics_.clear();
2015 TextMetrics & tm = textMetrics(&buftext);
2017 // make sure inline completion pointer is ok
2018 if (d->inlineCompletionPos_.fixIfBroken())
2019 d->inlineCompletionPos_ = DocIterator();
2021 if (d->anchor_pit_ >= npit)
2022 // The anchor pit must have been deleted...
2023 d->anchor_pit_ = npit - 1;
2025 // Rebreak anchor paragraph.
2026 tm.redoParagraph(d->anchor_pit_);
2027 ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
2030 if (d->anchor_pit_ == 0) {
2031 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
2033 // Complete buffer visible? Then it's easy.
2034 if (scrollRange == 0)
2035 d->anchor_ypos_ = anchor_pm.ascent();
2037 // FIXME: Some clever handling needed to show
2038 // the _first_ paragraph up to the top if the cursor is
2039 // in the first line.
2041 anchor_pm.setPosition(d->anchor_ypos_);
2043 LYXERR(Debug::PAINTING, "metrics: "
2044 << " anchor pit = " << d->anchor_pit_
2045 << " anchor ypos = " << d->anchor_ypos_);
2047 // Redo paragraphs above anchor if necessary.
2048 int y1 = d->anchor_ypos_ - anchor_pm.ascent();
2049 // We are now just above the anchor paragraph.
2050 pit_type pit1 = d->anchor_pit_ - 1;
2051 for (; pit1 >= 0 && y1 >= 0; --pit1) {
2052 tm.redoParagraph(pit1);
2053 ParagraphMetrics & pm = tm.par_metrics_[pit1];
2055 // Save the paragraph position in the cache.
2060 // Redo paragraphs below the anchor if necessary.
2061 int y2 = d->anchor_ypos_ + anchor_pm.descent();
2062 // We are now just below the anchor paragraph.
2063 pit_type pit2 = d->anchor_pit_ + 1;
2064 for (; pit2 < npit && y2 <= height_; ++pit2) {
2065 tm.redoParagraph(pit2);
2066 ParagraphMetrics & pm = tm.par_metrics_[pit2];
2068 // Save the paragraph position in the cache.
2073 LYXERR(Debug::PAINTING, "Metrics: "
2074 << " anchor pit = " << d->anchor_pit_
2075 << " anchor ypos = " << d->anchor_ypos_
2078 << " pit1 = " << pit1
2079 << " pit2 = " << pit2);
2081 d->update_strategy_ = FullScreenUpdate;
2083 if (lyxerr.debugging(Debug::WORKAREA)) {
2084 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
2085 d->coord_cache_.dump();
2090 void BufferView::insertLyXFile(FileName const & fname)
2092 LASSERT(d->cursor_.inTexted(), /**/);
2094 // Get absolute path of file and add ".lyx"
2095 // to the filename if necessary
2096 FileName filename = fileSearch(string(), fname.absFilename(), "lyx");
2098 docstring const disp_fn = makeDisplayPath(filename.absFilename());
2099 // emit message signal.
2100 message(bformat(_("Inserting document %1$s..."), disp_fn));
2103 Buffer buf("", false);
2104 if (buf.loadLyXFile(filename)) {
2105 ErrorList & el = buffer_.errorList("Parse");
2106 // Copy the inserted document error list into the current buffer one.
2107 el = buf.errorList("Parse");
2108 buffer_.undo().recordUndo(d->cursor_);
2109 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
2110 buf.params().documentClassPtr(), el);
2111 res = _("Document %1$s inserted.");
2113 res = _("Could not insert document %1$s");
2118 // emit message signal.
2119 message(bformat(res, disp_fn));
2120 buffer_.errors("Parse");
2124 Point BufferView::coordOffset(DocIterator const & dit, bool boundary) const
2130 // Addup contribution of nested insets, from inside to outside,
2131 // keeping the outer paragraph for a special handling below
2132 for (size_t i = dit.depth() - 1; i >= 1; --i) {
2133 CursorSlice const & sl = dit[i];
2137 // get relative position inside sl.inset()
2138 sl.inset().cursorPos(*this, sl, boundary && (i + 1 == dit.depth()), xx, yy);
2140 // Make relative position inside of the edited inset relative to sl.inset()
2144 // In case of an RTL inset, the edited inset will be positioned to the left
2147 bool boundary_i = boundary && i + 1 == dit.depth();
2148 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2153 // remember width for the case that sl.inset() is positioned in an RTL inset
2154 if (i && dit[i - 1].text()) {
2155 // If this Inset is inside a Text Inset, retrieve the Dimension
2156 // from the containing text instead of using Inset::dimension() which
2157 // might not be implemented.
2158 // FIXME (Abdel 23/09/2007): this is a bit messy because of the
2159 // elimination of Inset::dim_ cache. This coordOffset() method needs
2160 // to be rewritten in light of the new design.
2161 Dimension const & dim = parMetrics(dit[i - 1].text(),
2162 dit[i - 1].pit()).insetDimension(&sl.inset());
2165 Dimension const dim = sl.inset().dimension(*this);
2169 //lyxerr << "Cursor::getPos, i: "
2170 // << i << " x: " << xx << " y: " << y << endl;
2173 // Add contribution of initial rows of outermost paragraph
2174 CursorSlice const & sl = dit[0];
2175 TextMetrics const & tm = textMetrics(sl.text());
2176 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2177 LASSERT(!pm.rows().empty(), /**/);
2178 y -= pm.rows()[0].ascent();
2180 // FIXME: document this mess
2182 if (sl.pos() > 0 && dit.depth() == 1) {
2184 if (pos && boundary)
2186 // lyxerr << "coordOffset: boundary:" << boundary << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
2187 rend = pm.pos2row(pos);
2189 rend = pm.pos2row(sl.pos());
2191 size_t rend = pm.pos2row(sl.pos());
2193 for (size_t rit = 0; rit != rend; ++rit)
2194 y += pm.rows()[rit].height();
2195 y += pm.rows()[rend].ascent();
2197 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
2199 // Make relative position from the nested inset now bufferview absolute.
2200 int xx = bottom_tm.cursorX(dit.bottom(), boundary && dit.depth() == 1);
2203 // In the RTL case place the nested inset at the left of the cursor in
2204 // the outer paragraph
2205 bool boundary_1 = boundary && 1 == dit.depth();
2206 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
2214 Point BufferView::getPos(DocIterator const & dit, bool boundary) const
2216 CursorSlice const & bot = dit.bottom();
2217 TextMetrics const & tm = textMetrics(bot.text());
2218 if (!tm.contains(bot.pit()))
2219 return Point(-1, -1);
2221 Point p = coordOffset(dit, boundary); // offset from outer paragraph
2222 p.y_ += tm.parMetrics(bot.pit()).position();
2227 void BufferView::draw(frontend::Painter & pain)
2229 if (height_ == 0 || width_ == 0)
2231 LYXERR(Debug::PAINTING, "\t\t*** START DRAWING ***");
2233 Text & text = buffer_.text();
2234 TextMetrics const & tm = d->text_metrics_[&text];
2235 int const y = tm.first().second->position();
2236 PainterInfo pi(this, pain);
2238 switch (d->update_strategy_) {
2240 case NoScreenUpdate:
2241 // If no screen painting is actually needed, only some the different
2242 // coordinates of insets and paragraphs needs to be updated.
2243 pi.full_repaint = true;
2244 pi.pain.setDrawingEnabled(false);
2248 case SingleParUpdate:
2249 pi.full_repaint = false;
2250 // In general, only the current row of the outermost paragraph
2251 // will be redrawn. Particular cases where selection spans
2252 // multiple paragraph are correctly detected in TextMetrics.
2256 case DecorationUpdate:
2257 // FIXME: We should also distinguish DecorationUpdate to avoid text
2258 // drawing if possible. This is not possible to do easily right now
2259 // because of the single backing pixmap.
2261 case FullScreenUpdate:
2262 // The whole screen, including insets, will be refreshed.
2263 pi.full_repaint = true;
2265 // Clear background.
2266 pain.fillRectangle(0, 0, width_, height_,
2267 pi.backgroundColor(&buffer_.inset()));
2272 // and possibly grey out below
2273 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2274 int const y2 = lastpm.second->position() + lastpm.second->descent();
2276 pain.fillRectangle(0, y2, width_, height_ - y2, Color_bottomarea);
2279 LYXERR(Debug::PAINTING, "\n\t\t*** END DRAWING ***");
2281 // The scrollbar needs an update.
2284 // Normalize anchor for next time
2285 pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
2286 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2287 for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
2288 ParagraphMetrics const & pm = tm.parMetrics(pit);
2289 if (pm.position() + pm.descent() > 0) {
2290 d->anchor_pit_ = pit;
2291 d->anchor_ypos_ = pm.position();
2295 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
2296 << " anchor ypos = " << d->anchor_ypos_);
2300 void BufferView::message(docstring const & msg)
2303 d->gui_->message(msg);
2307 void BufferView::showDialog(string const & name)
2310 d->gui_->showDialog(name, string());
2314 void BufferView::showDialog(string const & name,
2315 string const & data, Inset * inset)
2318 d->gui_->showDialog(name, data, inset);
2322 void BufferView::updateDialog(string const & name, string const & data)
2325 d->gui_->updateDialog(name, data);
2329 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
2335 // FIXME: Move this out of BufferView again
2336 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
2338 if (!fname.isReadableFile()) {
2339 docstring const error = from_ascii(strerror(errno));
2340 docstring const file = makeDisplayPath(fname.absFilename(), 50);
2341 docstring const text =
2342 bformat(_("Could not read the specified document\n"
2343 "%1$s\ndue to the error: %2$s"), file, error);
2344 Alert::error(_("Could not read file"), text);
2348 if (!fname.isReadableFile()) {
2349 docstring const file = makeDisplayPath(fname.absFilename(), 50);
2350 docstring const text =
2351 bformat(_("%1$s\n is not readable."), file);
2352 Alert::error(_("Could not open file"), text);
2356 // FIXME UNICODE: We don't know the encoding of the file
2357 docstring file_content = fname.fileContents("UTF-8");
2358 if (file_content.empty()) {
2359 Alert::error(_("Reading not UTF-8 encoded file"),
2360 _("The file is not UTF-8 encoded.\n"
2361 "It will be read as local 8Bit-encoded.\n"
2362 "If this does not give the correct result\n"
2363 "then please change the encoding of the file\n"
2364 "to UTF-8 with a program other than LyX.\n"));
2365 file_content = fname.fileContents("local8bit");
2368 return normalize_c(file_content);
2372 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
2374 docstring const tmpstr = contentsOfPlaintextFile(f);
2379 Cursor & cur = cursor();
2380 cap::replaceSelection(cur);
2381 buffer_.undo().recordUndo(cur);
2383 cur.innerText()->insertStringAsParagraphs(cur, tmpstr);
2385 cur.innerText()->insertStringAsLines(cur, tmpstr);
2392 docstring const & BufferView::inlineCompletion() const
2394 return d->inlineCompletion_;
2398 size_t const & BufferView::inlineCompletionUniqueChars() const
2400 return d->inlineCompletionUniqueChars_;
2404 DocIterator const & BufferView::inlineCompletionPos() const
2406 return d->inlineCompletionPos_;
2410 bool samePar(DocIterator const & a, DocIterator const & b)
2412 if (a.empty() && b.empty())
2414 if (a.empty() || b.empty())
2416 return &a.innerParagraph() == &b.innerParagraph();
2420 void BufferView::setInlineCompletion(Cursor & cur, DocIterator const & pos,
2421 docstring const & completion, size_t uniqueChars)
2423 uniqueChars = min(completion.size(), uniqueChars);
2424 bool changed = d->inlineCompletion_ != completion
2425 || d->inlineCompletionUniqueChars_ != uniqueChars;
2426 bool singlePar = true;
2427 d->inlineCompletion_ = completion;
2428 d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
2430 //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
2433 DocIterator const & old = d->inlineCompletionPos_;
2435 //lyxerr << "inlineCompletionPos changed" << std::endl;
2436 // old or pos are in another paragraph?
2437 if ((!samePar(cur, pos) && !pos.empty())
2438 || (!samePar(cur, old) && !old.empty())) {
2440 //lyxerr << "different paragraph" << std::endl;
2442 d->inlineCompletionPos_ = pos;
2447 if (singlePar && !(cur.disp_.update() & Update::Force))
2448 cur.updateFlags(cur.disp_.update() | Update::SinglePar);
2450 cur.updateFlags(cur.disp_.update() | Update::Force);