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"
63 #include "frontends/alert.h"
64 #include "frontends/Application.h"
65 #include "frontends/Delegates.h"
66 #include "frontends/FontMetrics.h"
67 #include "frontends/Painter.h"
68 #include "frontends/Selection.h"
70 #include "graphics/Previews.h"
72 #include "support/convert.h"
73 #include "support/debug.h"
74 #include "support/ExceptionMessage.h"
75 #include "support/filetools.h"
76 #include "support/gettext.h"
77 #include "support/lstrings.h"
78 #include "support/Package.h"
79 #include "support/types.h"
88 using namespace lyx::support;
92 namespace Alert = frontend::Alert;
96 /// Return an inset of this class if it exists at the current cursor position
98 T * getInsetByCode(Cursor const & cur, InsetCode code)
100 DocIterator it = cur;
101 Inset * inset = it.nextInset();
102 if (inset && inset->lyxCode() == code)
103 return static_cast<T*>(inset);
108 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
111 bool findNextInset(DocIterator & dit, vector<InsetCode> const & codes,
112 docstring const & contents)
114 DocIterator tmpdit = dit;
117 Inset const * inset = tmpdit.nextInset();
119 && std::find(codes.begin(), codes.end(), inset->lyxCode()) != codes.end()
120 && (contents.empty() ||
121 static_cast<InsetCommand const *>(inset)->getFirstNonOptParam() == contents)) {
125 tmpdit.forwardInset();
132 /// Looks for next inset with one of the given codes.
133 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
137 DocIterator tmpdit = dit;
138 tmpdit.forwardInset();
143 Inset const * inset = tmpdit.nextInset();
145 && std::find(codes.begin(), codes.end(), inset->lyxCode()) != codes.end()) {
146 contents = static_cast<InsetCommand const *>(inset)->getFirstNonOptParam();
150 if (!findNextInset(tmpdit, codes, contents)) {
151 if (dit.depth() != 1 || dit.pit() != 0 || dit.pos() != 0) {
152 tmpdit = doc_iterator_begin(tmpdit.bottom().inset());
153 if (!findNextInset(tmpdit, codes, contents))
164 /// Looks for next inset with the given code
165 void findInset(DocIterator & dit, InsetCode code, bool same_content)
167 findInset(dit, vector<InsetCode>(1, code), same_content);
171 /// Moves cursor to the next inset with one of the given codes.
172 void gotoInset(BufferView * bv, vector<InsetCode> const & codes,
175 Cursor tmpcur = bv->cursor();
176 if (!findInset(tmpcur, codes, same_content)) {
177 bv->cursor().message(_("No more insets"));
181 tmpcur.clearSelection();
182 bv->setCursor(tmpcur);
187 /// Moves cursor to the next inset with given code.
188 void gotoInset(BufferView * bv, InsetCode code, bool same_content)
190 gotoInset(bv, vector<InsetCode>(1, code), same_content);
194 /// A map from a Text to the associated text metrics
195 typedef map<Text const *, TextMetrics> TextMetricsCache;
197 enum ScreenUpdateStrategy {
207 /////////////////////////////////////////////////////////////////////
211 /////////////////////////////////////////////////////////////////////
213 struct BufferView::Private
215 Private(BufferView & bv): wh_(0), cursor_(bv),
216 anchor_pit_(0), anchor_ypos_(0),
217 inlineCompletionUniqueChars_(0),
218 last_inset_(0), gui_(0)
222 ScrollbarParameters scrollbarParameters_;
224 ScreenUpdateStrategy update_strategy_;
226 CoordCache coord_cache_;
228 /// Estimated average par height for scrollbar.
230 /// this is used to handle XSelection events in the right manner.
239 pit_type anchor_pit_;
243 vector<int> par_height_;
246 DocIterator inlineCompletionPos_;
248 docstring inlineCompletion_;
250 size_t inlineCompletionUniqueChars_;
252 /// keyboard mapping object.
255 /// last visited inset.
256 /** kept to send setMouseHover(false).
257 * Not owned, so don't delete.
261 mutable TextMetricsCache text_metrics_;
264 /** Not owned, so don't delete.
266 frontend::GuiBufferViewDelegate * gui_;
268 /// Cache for Find Next
269 FuncRequest search_request_cache_;
273 BufferView::BufferView(Buffer & buf)
274 : width_(0), height_(0), full_screen_(false), buffer_(buf), d(new Private(*this))
276 d->xsel_cache_.set = false;
277 d->intl_.initKeyMapper(lyxrc.use_kbmap);
279 d->cursor_.push(buffer_.inset());
280 d->cursor_.resetAnchor();
281 d->cursor_.setCurrentFont();
283 if (graphics::Previews::status() != LyXRC::PREVIEW_OFF)
284 graphics::Previews::get().generateBufferPreviews(buffer_);
288 BufferView::~BufferView()
290 // current buffer is going to be switched-off, save cursor pos
291 // Ideally, the whole cursor stack should be saved, but session
292 // currently can only handle bottom (whole document) level pit and pos.
293 // That is to say, if a cursor is in a nested inset, it will be
294 // restore to the left of the top level inset.
295 LastFilePosSection::FilePos fp;
296 fp.pit = d->cursor_.bottom().pit();
297 fp.pos = d->cursor_.bottom().pos();
298 LyX::ref().session().lastFilePos().save(buffer_.fileName(), fp);
304 int BufferView::rightMargin() const
306 // The additional test for the case the outliner is opened.
308 !lyxrc.full_screen_limit ||
309 width_ < lyxrc.full_screen_width + 20)
312 return (width_ - lyxrc.full_screen_width) / 2;
316 int BufferView::leftMargin() const
318 return rightMargin();
322 bool BufferView::isTopScreen() const
324 return d->scrollbarParameters_.position == d->scrollbarParameters_.min;
328 bool BufferView::isBottomScreen() const
330 return d->scrollbarParameters_.position == d->scrollbarParameters_.max;
334 Intl & BufferView::getIntl()
340 Intl const & BufferView::getIntl() const
346 CoordCache & BufferView::coordCache()
348 return d->coord_cache_;
352 CoordCache const & BufferView::coordCache() const
354 return d->coord_cache_;
358 Buffer & BufferView::buffer()
364 Buffer const & BufferView::buffer() const
370 bool BufferView::fitCursor()
372 if (cursorStatus(d->cursor_) == CUR_INSIDE) {
373 frontend::FontMetrics const & fm =
374 theFontMetrics(d->cursor_.getFont().fontInfo());
375 int const asc = fm.maxAscent();
376 int const des = fm.maxDescent();
377 Point const p = getPos(d->cursor_, d->cursor_.boundary());
378 if (p.y_ - asc >= 0 && p.y_ + des < height_)
385 void BufferView::processUpdateFlags(Update::flags flags)
387 // last_inset_ points to the last visited inset. This pointer may become
388 // invalid because of keyboard editing. Since all such operations
389 // causes screen update(), I reset last_inset_ to avoid such a problem.
391 // This is close to a hot-path.
392 LYXERR(Debug::DEBUG, "BufferView::processUpdateFlags()"
393 << "[fitcursor = " << (flags & Update::FitCursor)
394 << ", forceupdate = " << (flags & Update::Force)
395 << ", singlepar = " << (flags & Update::SinglePar)
396 << "] buffer: " << &buffer_);
398 buffer_.updateMacros();
400 // Now do the first drawing step if needed. This consists on updating
401 // the CoordCache in updateMetrics().
402 // The second drawing step is done in WorkArea::redraw() if needed.
404 // Case when no explicit update is requested.
406 // no need to redraw anything.
407 d->update_strategy_ = NoScreenUpdate;
411 if (flags == Update::Decoration) {
412 d->update_strategy_ = DecorationUpdate;
417 if (flags == Update::FitCursor
418 || flags == (Update::Decoration | Update::FitCursor)) {
419 // tell the frontend to update the screen if needed.
424 if (flags & Update::Decoration) {
425 d->update_strategy_ = DecorationUpdate;
429 // no screen update is needed.
430 d->update_strategy_ = NoScreenUpdate;
434 bool const full_metrics = flags & Update::Force || !singleParUpdate();
437 // We have to update the full screen metrics.
440 if (!(flags & Update::FitCursor)) {
441 // Nothing to do anymore. Trigger a redraw and return
446 // updateMetrics() does not update paragraph position
447 // This is done at draw() time. So we need a redraw!
451 // The cursor is off screen so ensure it is visible.
458 void BufferView::updateScrollbar()
463 // We prefer fixed size line scrolling.
464 d->scrollbarParameters_.single_step = defaultRowHeight();
465 // We prefer full screen page scrolling.
466 d->scrollbarParameters_.page_step = height_;
468 Text & t = buffer_.text();
469 TextMetrics & tm = d->text_metrics_[&t];
471 LYXERR(Debug::GUI, " Updating scrollbar: height: "
472 << t.paragraphs().size()
473 << " curr par: " << d->cursor_.bottom().pit()
474 << " default height " << defaultRowHeight());
476 size_t const parsize = t.paragraphs().size();
477 if (d->par_height_.size() != parsize) {
478 d->par_height_.clear();
479 // FIXME: We assume a default paragraph height of 2 rows. This
480 // should probably be pondered with the screen width.
481 d->par_height_.resize(parsize, defaultRowHeight() * 2);
484 // Look at paragraph heights on-screen
485 pair<pit_type, ParagraphMetrics const *> first = tm.first();
486 pair<pit_type, ParagraphMetrics const *> last = tm.last();
487 for (pit_type pit = first.first; pit <= last.first; ++pit) {
488 d->par_height_[pit] = tm.parMetrics(pit).height();
489 LYXERR(Debug::SCROLLING, "storing height for pit " << pit << " : "
490 << d->par_height_[pit]);
493 int top_pos = first.second->position() - first.second->ascent();
494 int bottom_pos = last.second->position() + last.second->descent();
495 bool first_visible = first.first == 0 && top_pos >= 0;
496 bool last_visible = last.first + 1 == int(parsize) && bottom_pos <= height_;
497 if (first_visible && last_visible) {
498 d->scrollbarParameters_.min = 0;
499 d->scrollbarParameters_.max = 0;
503 d->scrollbarParameters_.min = top_pos;
504 for (size_t i = 0; i != size_t(first.first); ++i)
505 d->scrollbarParameters_.min -= d->par_height_[i];
506 d->scrollbarParameters_.max = bottom_pos;
507 for (size_t i = last.first + 1; i != parsize; ++i)
508 d->scrollbarParameters_.max += d->par_height_[i];
510 d->scrollbarParameters_.position = 0;
511 // The reference is the top position so we remove one page.
512 d->scrollbarParameters_.max -= d->scrollbarParameters_.page_step;
516 ScrollbarParameters const & BufferView::scrollbarParameters() const
518 return d->scrollbarParameters_;
522 docstring BufferView::toolTip(int x, int y) const
524 // Get inset under mouse, if there is one.
525 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
527 // No inset, no tooltip...
529 return covering_inset->toolTip(*this, x, y);
533 docstring BufferView::contextMenu(int x, int y) const
535 // Get inset under mouse, if there is one.
536 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
538 return covering_inset->contextMenu(*this, x, y);
540 return buffer_.inset().contextMenu(*this, x, y);
544 void BufferView::scrollDocView(int value)
546 int const offset = value - d->scrollbarParameters_.position;
547 // If the offset is less than 2 screen height, prefer to scroll instead.
548 if (abs(offset) <= 2 * height_) {
553 // cut off at the top
554 if (value <= d->scrollbarParameters_.min) {
555 DocIterator dit = doc_iterator_begin(buffer_.inset());
557 LYXERR(Debug::SCROLLING, "scroll to top");
561 // cut off at the bottom
562 if (value >= d->scrollbarParameters_.max) {
563 DocIterator dit = doc_iterator_end(buffer_.inset());
566 LYXERR(Debug::SCROLLING, "scroll to bottom");
570 // find paragraph at target position
571 int par_pos = d->scrollbarParameters_.min;
573 for (; i != int(d->par_height_.size()); ++i) {
574 par_pos += d->par_height_[i];
575 if (par_pos >= value)
579 if (par_pos < value) {
580 // It seems we didn't find the correct pit so stay on the safe side and
582 LYXERR0("scrolling position not found!");
583 scrollDocView(d->scrollbarParameters_.max);
587 DocIterator dit = doc_iterator_begin(buffer_.inset());
589 LYXERR(Debug::SCROLLING, "value = " << value << " -> scroll to pit " << i);
594 // FIXME: this method is not working well.
595 void BufferView::setCursorFromScrollbar()
597 TextMetrics & tm = d->text_metrics_[&buffer_.text()];
599 int const height = 2 * defaultRowHeight();
600 int const first = height;
601 int const last = height_ - height;
602 Cursor & cur = d->cursor_;
604 switch (cursorStatus(cur)) {
606 // We reset the cursor because cursorStatus() does not
607 // work when the cursor is within mathed.
608 cur.reset(buffer_.inset());
609 tm.setCursorFromCoordinates(cur, 0, first);
610 cur.clearSelection();
613 // We reset the cursor because cursorStatus() does not
614 // work when the cursor is within mathed.
615 cur.reset(buffer_.inset());
616 tm.setCursorFromCoordinates(cur, 0, last);
617 cur.clearSelection();
620 int const y = getPos(cur, cur.boundary()).y_;
621 int const newy = min(last, max(y, first));
623 cur.reset(buffer_.inset());
624 tm.setCursorFromCoordinates(cur, 0, newy);
630 Change const BufferView::getCurrentChange() const
632 if (!d->cursor_.selection())
633 return Change(Change::UNCHANGED);
635 DocIterator dit = d->cursor_.selectionBegin();
636 return dit.paragraph().lookupChange(dit.pos());
640 // this could be used elsewhere as well?
641 // FIXME: This does not work within mathed!
642 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
644 Point const p = getPos(dit, dit.boundary());
647 if (p.y_ > workHeight())
653 void BufferView::saveBookmark(unsigned int idx)
655 // tenatively save bookmark, id and pos will be used to
656 // acturately locate a bookmark in a 'live' lyx session.
657 // pit and pos will be updated with bottom level pit/pos
659 LyX::ref().session().bookmarks().save(
661 d->cursor_.bottom().pit(),
662 d->cursor_.bottom().pos(),
663 d->cursor_.paragraph().id(),
668 // emit message signal.
669 message(_("Save bookmark"));
673 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
674 int top_id, pos_type top_pos)
676 bool success = false;
679 d->cursor_.clearSelection();
681 // if a valid par_id is given, try it first
682 // This is the case for a 'live' bookmark when unique paragraph ID
683 // is used to track bookmarks.
685 dit = buffer_.getParFromID(top_id);
687 dit.pos() = min(dit.paragraph().size(), top_pos);
688 // Some slices of the iterator may not be
689 // reachable (e.g. closed collapsable inset)
690 // so the dociterator may need to be
691 // shortened. Otherwise, setCursor may crash
692 // lyx when the cursor can not be set to these
694 size_t const n = dit.depth();
695 for (size_t i = 0; i < n; ++i)
696 if (dit[i].inset().editable() != Inset::HIGHLY_EDITABLE) {
704 // if top_id == 0, or searching through top_id failed
705 // This is the case for a 'restored' bookmark when only bottom
706 // (document level) pit was saved. Because of this, bookmark
707 // restoration is inaccurate. If a bookmark was within an inset,
708 // it will be restored to the left of the outmost inset that contains
710 if (bottom_pit < int(buffer_.paragraphs().size())) {
711 dit = doc_iterator_begin(buffer_.inset());
713 dit.pit() = bottom_pit;
714 dit.pos() = min(bottom_pos, dit.paragraph().size());
719 // Note: only bottom (document) level pit is set.
721 // set the current font.
722 d->cursor_.setCurrentFont();
723 // To center the screen on this new position we need the
724 // paragraph position which is computed at draw() time.
725 // So we need a redraw!
735 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
737 if (lyxrc.rtl_support) {
738 if (d->cursor_.real_current_font.isRightToLeft()) {
739 if (d->intl_.keymap == Intl::PRIMARY)
740 d->intl_.keyMapSec();
742 if (d->intl_.keymap == Intl::SECONDARY)
743 d->intl_.keyMapPrim();
747 d->intl_.getTransManager().translateAndInsert(c, t, cur);
751 int BufferView::workWidth() const
757 void BufferView::showCursor()
759 showCursor(d->cursor_);
763 void BufferView::showCursor(DocIterator const & dit)
765 // We are not properly started yet, delay until resizing is
770 LYXERR(Debug::SCROLLING, "recentering!");
772 CursorSlice const & bot = dit.bottom();
773 TextMetrics & tm = d->text_metrics_[bot.text()];
775 pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
776 int bot_pit = bot.pit();
777 if (bot_pit > max_pit) {
778 // FIXME: Why does this happen?
779 LYXERR0("bottom pit is greater that max pit: "
780 << bot_pit << " > " << max_pit);
784 if (bot_pit == tm.first().first - 1)
785 tm.newParMetricsUp();
786 else if (bot_pit == tm.last().first + 1)
787 tm.newParMetricsDown();
789 if (tm.contains(bot_pit)) {
790 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
791 LASSERT(!pm.rows().empty(), /**/);
792 // FIXME: smooth scrolling doesn't work in mathed.
793 CursorSlice const & cs = dit.innerTextSlice();
794 int offset = coordOffset(dit, dit.boundary()).y_;
795 int ypos = pm.position() + offset;
796 Dimension const & row_dim =
797 pm.getRow(cs.pos(), dit.boundary()).dimension();
798 if (ypos - row_dim.ascent() < 0)
799 scrollUp(- ypos + row_dim.ascent());
800 else if (ypos + row_dim.descent() > height_)
801 scrollDown(ypos - height_ + row_dim.descent());
802 // else, nothing to do, the cursor is already visible so we just return.
806 // fix inline completion position
807 if (d->inlineCompletionPos_.fixIfBroken())
808 d->inlineCompletionPos_ = DocIterator();
810 tm.redoParagraph(bot_pit);
811 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
812 int offset = coordOffset(dit, dit.boundary()).y_;
814 d->anchor_pit_ = bot_pit;
815 CursorSlice const & cs = dit.innerTextSlice();
816 Dimension const & row_dim =
817 pm.getRow(cs.pos(), dit.boundary()).dimension();
819 if (d->anchor_pit_ == 0)
820 d->anchor_ypos_ = offset + pm.ascent();
821 else if (d->anchor_pit_ == max_pit)
822 d->anchor_ypos_ = height_ - offset - row_dim.descent();
824 d->anchor_ypos_ = defaultRowHeight() * 2 - offset - row_dim.descent();
831 FuncStatus BufferView::getStatus(FuncRequest const & cmd)
835 Cursor & cur = d->cursor_;
837 switch (cmd.action) {
840 flag.setEnabled(buffer_.undo().hasUndoStack());
843 flag.setEnabled(buffer_.undo().hasRedoStack());
845 case LFUN_FILE_INSERT:
846 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
847 case LFUN_FILE_INSERT_PLAINTEXT:
848 case LFUN_BOOKMARK_SAVE:
849 // FIXME: Actually, these LFUNS should be moved to Text
850 flag.setEnabled(cur.inTexted());
852 case LFUN_FONT_STATE:
853 case LFUN_LABEL_INSERT:
854 case LFUN_INFO_INSERT:
855 case LFUN_INSET_EDIT:
856 case LFUN_PARAGRAPH_GOTO:
858 case LFUN_REFERENCE_NEXT:
860 case LFUN_WORD_REPLACE:
863 case LFUN_MARK_TOGGLE:
864 case LFUN_SCREEN_RECENTER:
865 case LFUN_BIBTEX_DATABASE_ADD:
866 case LFUN_BIBTEX_DATABASE_DEL:
867 case LFUN_STATISTICS:
868 flag.setEnabled(true);
871 case LFUN_NEXT_INSET_TOGGLE:
872 case LFUN_NEXT_INSET_MODIFY: {
873 // this is the real function we want to invoke
874 FuncRequest tmpcmd = cmd;
875 tmpcmd.action = (cmd.action == LFUN_NEXT_INSET_TOGGLE)
876 ? LFUN_INSET_TOGGLE : LFUN_INSET_MODIFY;
877 // if there is an inset at cursor, see whether it
878 // handles the lfun, other start from scratch
879 Inset * inset = cur.nextInset();
880 if (!inset || !inset->getStatus(cur, tmpcmd, flag))
881 flag = lyx::getStatus(tmpcmd);
885 case LFUN_LABEL_GOTO: {
886 flag.setEnabled(!cmd.argument().empty()
887 || getInsetByCode<InsetRef>(cur, REF_CODE));
891 case LFUN_CHANGES_TRACK:
892 flag.setEnabled(true);
893 flag.setOnOff(buffer_.params().trackChanges);
896 case LFUN_CHANGES_OUTPUT:
897 flag.setEnabled(true);
898 flag.setOnOff(buffer_.params().outputChanges);
901 case LFUN_CHANGES_MERGE:
902 case LFUN_CHANGE_NEXT:
903 case LFUN_ALL_CHANGES_ACCEPT:
904 case LFUN_ALL_CHANGES_REJECT:
905 // TODO: context-sensitive enabling of LFUNs
906 // In principle, these command should only be enabled if there
907 // is a change in the document. However, without proper
908 // optimizations, this will inevitably result in poor performance.
909 flag.setEnabled(true);
912 case LFUN_BUFFER_TOGGLE_COMPRESSION: {
913 flag.setOnOff(buffer_.params().compressed);
918 case LFUN_SCREEN_DOWN:
920 case LFUN_SCREEN_UP_SELECT:
921 case LFUN_SCREEN_DOWN_SELECT:
922 flag.setEnabled(true);
925 case LFUN_LAYOUT_TABULAR:
926 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
930 flag.setEnabled(!cur.inset().forceEmptyLayout(cur.idx()));
933 case LFUN_LAYOUT_PARAGRAPH:
934 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
937 case LFUN_INSET_SETTINGS: {
938 InsetCode code = cur.inset().lyxCode();
939 if (cmd.getArg(0) == insetName(code)) {
940 flag.setEnabled(true);
944 InsetCode next_code = cur.nextInset()
945 ? cur.nextInset()->lyxCode() : NO_CODE;
946 //FIXME: remove these special cases:
956 enable = (cmd.argument().empty() ||
957 cmd.getArg(0) == insetName(next_code));
962 flag.setEnabled(enable);
966 case LFUN_DIALOG_SHOW_NEW_INSET:
967 flag.setEnabled(cur.inset().lyxCode() != ERT_CODE &&
968 cur.inset().lyxCode() != LISTINGS_CODE);
969 if (cur.inset().lyxCode() == CAPTION_CODE) {
971 if (cur.inset().getStatus(cur, cmd, flag))
976 case LFUN_BRANCH_ACTIVATE:
977 case LFUN_BRANCH_DEACTIVATE: {
979 docstring const branchName = cmd.argument();
980 if (!branchName.empty())
981 enable = buffer_.params().branchlist().find(branchName);
982 flag.setEnabled(enable);
987 flag.setEnabled(false);
994 bool BufferView::dispatch(FuncRequest const & cmd)
996 //lyxerr << [ cmd = " << cmd << "]" << endl;
998 // Make sure that the cached BufferView is correct.
999 LYXERR(Debug::ACTION, " action[" << cmd.action << ']'
1000 << " arg[" << to_utf8(cmd.argument()) << ']'
1001 << " x[" << cmd.x << ']'
1002 << " y[" << cmd.y << ']'
1003 << " button[" << cmd.button() << ']');
1005 Cursor & cur = d->cursor_;
1007 switch (cmd.action) {
1010 cur.message(_("Undo"));
1011 cur.clearSelection();
1012 if (!cur.textUndo())
1013 cur.message(_("No further undo information"));
1015 processUpdateFlags(Update::Force | Update::FitCursor);
1019 cur.message(_("Redo"));
1020 cur.clearSelection();
1021 if (!cur.textRedo())
1022 cur.message(_("No further redo information"));
1024 processUpdateFlags(Update::Force | Update::FitCursor);
1027 case LFUN_FONT_STATE:
1028 cur.message(cur.currentState());
1031 case LFUN_BOOKMARK_SAVE:
1032 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1035 case LFUN_LABEL_GOTO: {
1036 docstring label = cmd.argument();
1037 if (label.empty()) {
1039 getInsetByCode<InsetRef>(d->cursor_,
1042 label = inset->getParam("reference");
1043 // persistent=false: use temp_bookmark
1053 case LFUN_INSET_EDIT: {
1054 FuncRequest fr(cmd);
1055 // if there is an inset at cursor, see whether it
1057 Inset * inset = cur.nextInset();
1059 inset->dispatch(cur, fr);
1060 // if it did not work, try the underlying inset.
1061 if (!inset || !cur.result().dispatched())
1064 if (!cur.result().dispatched())
1065 // It did not work too; no action needed.
1069 case LFUN_PARAGRAPH_GOTO: {
1070 int const id = convert<int>(cmd.getArg(0));
1071 int const pos = convert<int>(cmd.getArg(1));
1073 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1074 b = theBufferList().next(b)) {
1076 DocIterator dit = b->getParFromID(id);
1078 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1082 LYXERR(Debug::INFO, "Paragraph " << dit.paragraph().id()
1083 << " found in buffer `"
1084 << b->absFileName() << "'.");
1086 if (b == &buffer_) {
1090 processUpdateFlags(Update::Force | Update::FitCursor);
1092 // Switch to other buffer view and resend cmd
1093 theLyXFunc().dispatch(FuncRequest(
1094 LFUN_BUFFER_SWITCH, b->absFileName()));
1095 theLyXFunc().dispatch(cmd);
1102 case LFUN_NOTE_NEXT:
1103 gotoInset(this, NOTE_CODE, false);
1106 case LFUN_REFERENCE_NEXT: {
1107 vector<InsetCode> tmp;
1108 tmp.push_back(LABEL_CODE);
1109 tmp.push_back(REF_CODE);
1110 gotoInset(this, tmp, true);
1114 case LFUN_CHANGES_TRACK:
1115 buffer_.params().trackChanges = !buffer_.params().trackChanges;
1118 case LFUN_CHANGES_OUTPUT:
1119 buffer_.params().outputChanges = !buffer_.params().outputChanges;
1120 if (buffer_.params().outputChanges) {
1121 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1122 bool xcolorsoul = LaTeXFeatures::isAvailable("soul") &&
1123 LaTeXFeatures::isAvailable("xcolor");
1125 if (!dvipost && !xcolorsoul) {
1126 Alert::warning(_("Changes not shown in LaTeX output"),
1127 _("Changes will not be highlighted in LaTeX output, "
1128 "because neither dvipost nor xcolor/soul are installed.\n"
1129 "Please install these packages or redefine "
1130 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1131 } else if (!xcolorsoul) {
1132 Alert::warning(_("Changes not shown in LaTeX output"),
1133 _("Changes will not be highlighted in LaTeX output "
1134 "when using pdflatex, because xcolor and soul are not installed.\n"
1135 "Please install both packages or redefine "
1136 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1141 case LFUN_CHANGE_NEXT:
1142 findNextChange(this);
1145 case LFUN_CHANGES_MERGE:
1146 if (findNextChange(this))
1147 showDialog("changes");
1150 case LFUN_ALL_CHANGES_ACCEPT:
1151 // select complete document
1152 d->cursor_.reset(buffer_.inset());
1153 d->cursor_.selHandle(true);
1154 buffer_.text().cursorBottom(d->cursor_);
1155 // accept everything in a single step to support atomic undo
1156 buffer_.text().acceptOrRejectChanges(d->cursor_, Text::ACCEPT);
1159 case LFUN_ALL_CHANGES_REJECT:
1160 // select complete document
1161 d->cursor_.reset(buffer_.inset());
1162 d->cursor_.selHandle(true);
1163 buffer_.text().cursorBottom(d->cursor_);
1164 // reject everything in a single step to support atomic undo
1165 // Note: reject does not work recursively; the user may have to repeat the operation
1166 buffer_.text().acceptOrRejectChanges(d->cursor_, Text::REJECT);
1169 case LFUN_WORD_FIND: {
1170 FuncRequest req = cmd;
1171 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1172 req = d->search_request_cache_;
1173 if (find(this, req))
1176 message(_("String not found!"));
1177 d->search_request_cache_ = req;
1181 case LFUN_WORD_REPLACE: {
1182 bool has_deleted = false;
1183 if (cur.selection()) {
1184 DocIterator beg = cur.selectionBegin();
1185 DocIterator end = cur.selectionEnd();
1186 if (beg.pit() == end.pit()) {
1187 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1188 if (cur.paragraph().isDeleted(p))
1193 replace(this, cmd, has_deleted);
1198 cur.clearSelection();
1200 cur.message(from_utf8(N_("Mark off")));
1204 cur.clearSelection();
1207 cur.message(from_utf8(N_("Mark on")));
1210 case LFUN_MARK_TOGGLE:
1211 cur.clearSelection();
1214 cur.message(from_utf8(N_("Mark removed")));
1217 cur.message(from_utf8(N_("Mark set")));
1222 case LFUN_SCREEN_RECENTER:
1226 case LFUN_BIBTEX_DATABASE_ADD: {
1227 Cursor tmpcur = d->cursor_;
1228 findInset(tmpcur, BIBTEX_CODE, false);
1229 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1232 if (inset->addDatabase(cmd.argument()))
1233 buffer_.updateBibfilesCache();
1238 case LFUN_BIBTEX_DATABASE_DEL: {
1239 Cursor tmpcur = d->cursor_;
1240 findInset(tmpcur, BIBTEX_CODE, false);
1241 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1244 if (inset->delDatabase(cmd.argument()))
1245 buffer_.updateBibfilesCache();
1250 case LFUN_STATISTICS: {
1251 DocIterator from, to;
1252 if (cur.selection()) {
1253 from = cur.selectionBegin();
1254 to = cur.selectionEnd();
1256 from = doc_iterator_begin(buffer_.inset());
1257 to = doc_iterator_end(buffer_.inset());
1259 int const words = countWords(from, to);
1260 int const chars = countChars(from, to, false);
1261 int const chars_blanks = countChars(from, to, true);
1263 if (cur.selection())
1264 message = _("Statistics for the selection:");
1266 message = _("Statistics for the document:");
1269 message += bformat(_("%1$d words"), words);
1271 message += _("One word");
1273 if (chars_blanks != 1)
1274 message += bformat(_("%1$d characters (including blanks)"),
1277 message += _("One character (including blanks)");
1280 message += bformat(_("%1$d characters (excluding blanks)"),
1283 message += _("One character (excluding blanks)");
1285 Alert::information(_("Statistics"), message);
1289 case LFUN_BUFFER_TOGGLE_COMPRESSION:
1290 // turn compression on/off
1291 buffer_.params().compressed = !buffer_.params().compressed;
1294 case LFUN_NEXT_INSET_TOGGLE: {
1295 // create the the real function we want to invoke
1296 FuncRequest tmpcmd = cmd;
1297 tmpcmd.action = LFUN_INSET_TOGGLE;
1298 // if there is an inset at cursor, see whether it
1300 Inset * inset = cur.nextInset();
1302 if (inset->isActive()) {
1303 Cursor tmpcur = cur;
1304 tmpcur.pushBackward(*inset);
1305 inset->dispatch(tmpcur, tmpcmd);
1306 if (tmpcur.result().dispatched())
1309 inset->dispatch(cur, tmpcmd);
1311 // if it did not work, try the underlying inset.
1312 if (!inset || !cur.result().dispatched())
1313 cur.dispatch(tmpcmd);
1315 if (!cur.result().dispatched())
1316 // It did not work too; no action needed.
1318 cur.clearSelection();
1319 processUpdateFlags(Update::SinglePar | Update::FitCursor);
1323 case LFUN_NEXT_INSET_MODIFY: {
1324 // create the the real function we want to invoke
1325 FuncRequest tmpcmd = cmd;
1326 tmpcmd.action = LFUN_INSET_MODIFY;
1327 // if there is an inset at cursor, see whether it
1329 Inset * inset = cur.nextInset();
1331 inset->dispatch(cur, tmpcmd);
1332 // if it did not work, try the underlying inset.
1333 if (!inset || !cur.result().dispatched())
1334 cur.dispatch(tmpcmd);
1336 if (!cur.result().dispatched())
1337 // It did not work too; no action needed.
1339 cur.clearSelection();
1340 processUpdateFlags(Update::Force | Update::FitCursor);
1344 case LFUN_SCREEN_UP:
1345 case LFUN_SCREEN_DOWN: {
1346 Point p = getPos(cur, cur.boundary());
1347 if (p.y_ < 0 || p.y_ > height_) {
1348 // The cursor is off-screen so recenter before proceeding.
1350 p = getPos(cur, cur.boundary());
1352 scroll(cmd.action == LFUN_SCREEN_UP? - height_ : height_);
1353 cur.reset(buffer_.inset());
1354 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_);
1355 //FIXME: what to do with cur.x_target()?
1364 case LFUN_SCREEN_UP_SELECT: {
1365 cur.selHandle(true);
1366 if (isTopScreen()) {
1367 lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1371 int y = getPos(cur, cur.boundary()).y_;
1372 int const ymin = y - height_ + defaultRowHeight();
1373 while (y > ymin && cur.up())
1374 y = getPos(cur, cur.boundary()).y_;
1377 processUpdateFlags(Update::SinglePar | Update::FitCursor);
1381 case LFUN_SCREEN_DOWN_SELECT: {
1382 cur.selHandle(true);
1383 if (isBottomScreen()) {
1384 lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1388 int y = getPos(cur, cur.boundary()).y_;
1389 int const ymax = y + height_ - defaultRowHeight();
1390 while (y < ymax && cur.down())
1391 y = getPos(cur, cur.boundary()).y_;
1394 processUpdateFlags(Update::SinglePar | Update::FitCursor);
1398 case LFUN_BRANCH_ACTIVATE:
1399 case LFUN_BRANCH_DEACTIVATE:
1400 buffer_.dispatch(cmd);
1401 processUpdateFlags(Update::Force);
1412 docstring const BufferView::requestSelection()
1414 Cursor & cur = d->cursor_;
1416 if (!cur.selection()) {
1417 d->xsel_cache_.set = false;
1421 if (!d->xsel_cache_.set ||
1422 cur.top() != d->xsel_cache_.cursor ||
1423 cur.anchor_.top() != d->xsel_cache_.anchor)
1425 d->xsel_cache_.cursor = cur.top();
1426 d->xsel_cache_.anchor = cur.anchor_.top();
1427 d->xsel_cache_.set = cur.selection();
1428 return cur.selectionAsString(false);
1434 void BufferView::clearSelection()
1436 d->cursor_.clearSelection();
1437 // Clear the selection buffer. Otherwise a subsequent
1438 // middle-mouse-button paste would use the selection buffer,
1439 // not the more current external selection.
1440 cap::clearSelection();
1441 d->xsel_cache_.set = false;
1442 // The buffer did not really change, but this causes the
1443 // redraw we need because we cleared the selection above.
1448 void BufferView::resize(int width, int height)
1450 // Update from work area
1454 // Clear the paragraph height cache.
1455 d->par_height_.clear();
1456 // Redo the metrics.
1461 Inset const * BufferView::getCoveringInset(Text const & text,
1464 TextMetrics & tm = d->text_metrics_[&text];
1465 Inset * inset = tm.checkInsetHit(x, y);
1469 if (!inset->descendable())
1470 // No need to go further down if the inset is not
1474 size_t cell_number = inset->nargs();
1475 // Check all the inner cell.
1476 for (size_t i = 0; i != cell_number; ++i) {
1477 Text const * inner_text = inset->getText(i);
1480 Inset const * inset_deeper =
1481 getCoveringInset(*inner_text, x, y);
1483 return inset_deeper;
1491 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
1493 //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
1495 // This is only called for mouse related events including
1496 // LFUN_FILE_OPEN generated by drag-and-drop.
1497 FuncRequest cmd = cmd0;
1499 Cursor old = cursor();
1501 cur.push(buffer_.inset());
1502 cur.selection() = d->cursor_.selection();
1504 // Either the inset under the cursor or the
1505 // surrounding Text will handle this event.
1507 // make sure we stay within the screen...
1508 cmd.y = min(max(cmd.y, -1), height_);
1510 if (cmd.action == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
1512 // Get inset under mouse, if there is one.
1513 Inset const * covering_inset =
1514 getCoveringInset(buffer_.text(), cmd.x, cmd.y);
1515 if (covering_inset == d->last_inset_)
1516 // Same inset, no need to do anything...
1519 bool need_redraw = false;
1520 // const_cast because of setMouseHover().
1521 Inset * inset = const_cast<Inset *>(covering_inset);
1523 // Remove the hint on the last hovered inset (if any).
1524 need_redraw |= d->last_inset_->setMouseHover(false);
1526 // Highlighted the newly hovered inset (if any).
1527 need_redraw |= inset->setMouseHover(true);
1528 d->last_inset_ = inset;
1532 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
1533 << cmd.x << ", " << cmd.y << ")");
1535 d->update_strategy_ = DecorationUpdate;
1537 // This event (moving without mouse click) is not passed further.
1538 // This should be changed if it is further utilized.
1543 // Build temporary cursor.
1544 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x, cmd.y);
1546 // Put anchor at the same position.
1549 // Try to dispatch to an non-editable inset near this position
1550 // via the temp cursor. If the inset wishes to change the real
1551 // cursor it has to do so explicitly by using
1552 // cur.bv().cursor() = cur; (or similar)
1554 inset->dispatch(cur, cmd);
1556 // Now dispatch to the temporary cursor. If the real cursor should
1557 // be modified, the inset's dispatch has to do so explicitly.
1558 if (!inset || !cur.result().dispatched())
1561 // Notify left insets
1564 bool badcursor = notifyCursorLeaves(old, cur);
1566 cursor().fixIfBroken();
1569 // Do we have a selection?
1570 theSelection().haveSelection(cursor().selection());
1572 // If the command has been dispatched,
1573 if (cur.result().dispatched() || cur.result().update())
1574 processUpdateFlags(cur.result().update());
1578 void BufferView::lfunScroll(FuncRequest const & cmd)
1580 string const scroll_type = cmd.getArg(0);
1581 int const scroll_step =
1582 (scroll_type == "line") ? d->scrollbarParameters_.single_step
1583 : (scroll_type == "page") ? d->scrollbarParameters_.page_step : 0;
1584 if (scroll_step == 0)
1586 string const scroll_quantity = cmd.getArg(1);
1587 if (scroll_quantity == "up")
1588 scrollUp(scroll_step);
1589 else if (scroll_quantity == "down")
1590 scrollDown(scroll_step);
1592 int const scroll_value = convert<int>(scroll_quantity);
1594 scroll(scroll_step * scroll_value);
1599 void BufferView::scroll(int y)
1608 void BufferView::scrollDown(int offset)
1610 Text * text = &buffer_.text();
1611 TextMetrics & tm = d->text_metrics_[text];
1612 int ymax = height_ + offset;
1614 pair<pit_type, ParagraphMetrics const *> last = tm.last();
1615 int bottom_pos = last.second->position() + last.second->descent();
1616 if (last.first + 1 == int(text->paragraphs().size())) {
1617 if (bottom_pos <= height_)
1619 offset = min(offset, bottom_pos - height_);
1622 if (bottom_pos > ymax)
1624 tm.newParMetricsDown();
1626 d->anchor_ypos_ -= offset;
1632 void BufferView::scrollUp(int offset)
1634 Text * text = &buffer_.text();
1635 TextMetrics & tm = d->text_metrics_[text];
1636 int ymin = - offset;
1638 pair<pit_type, ParagraphMetrics const *> first = tm.first();
1639 int top_pos = first.second->position() - first.second->ascent();
1640 if (first.first == 0) {
1643 offset = min(offset, - top_pos);
1648 tm.newParMetricsUp();
1650 d->anchor_ypos_ += offset;
1656 void BufferView::setCursorFromRow(int row)
1661 buffer_.texrow().getIdFromRow(row, tmpid, tmppos);
1663 d->cursor_.reset(buffer_.inset());
1665 buffer_.text().setCursor(d->cursor_, 0, 0);
1667 buffer_.text().setCursor(d->cursor_, buffer_.getParFromID(tmpid).pit(), tmppos);
1671 void BufferView::gotoLabel(docstring const & label)
1673 Toc & toc = buffer().tocBackend().toc("label");
1674 TocIterator toc_it = toc.begin();
1675 TocIterator end = toc.end();
1676 for (; toc_it != end; ++toc_it) {
1677 if (label == toc_it->str())
1678 dispatch(toc_it->action());
1680 //FIXME: We could do a bit more searching thanks to this:
1681 //InsetLabel const * inset = buffer_.insetLabel(label);
1685 TextMetrics const & BufferView::textMetrics(Text const * t) const
1687 return const_cast<BufferView *>(this)->textMetrics(t);
1691 TextMetrics & BufferView::textMetrics(Text const * t)
1693 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
1694 if (tmc_it == d->text_metrics_.end()) {
1695 tmc_it = d->text_metrics_.insert(
1696 make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
1698 return tmc_it->second;
1702 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
1705 return textMetrics(t).parMetrics(pit);
1709 int BufferView::workHeight() const
1715 void BufferView::setCursor(DocIterator const & dit)
1717 size_t const n = dit.depth();
1718 for (size_t i = 0; i < n; ++i)
1719 dit[i].inset().edit(d->cursor_, true);
1721 d->cursor_.setCursor(dit);
1722 d->cursor_.selection() = false;
1726 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
1728 // Would be wrong to delete anything if we have a selection.
1729 if (cur.selection())
1732 bool need_anchor_change = false;
1733 bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
1734 need_anchor_change);
1736 if (need_anchor_change)
1744 updateLabels(buffer_);
1752 bool BufferView::mouseSetCursor(Cursor & cur, bool select)
1754 LASSERT(&cur.bv() == this, /**/);
1757 // this event will clear selection so we save selection for
1758 // persistent selection
1759 cap::saveSelection(cursor());
1761 // Has the cursor just left the inset?
1762 bool badcursor = false;
1763 bool leftinset = (&d->cursor_.inset() != &cur.inset());
1765 d->cursor_.fixIfBroken();
1766 badcursor = notifyCursorLeaves(d->cursor_, cur);
1771 // FIXME: shift-mouse selection doesn't work well across insets.
1772 bool do_selection = select && &d->cursor_.anchor().inset() == &cur.inset();
1774 // do the dEPM magic if needed
1775 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
1776 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
1777 // the leftinset bool would not be necessary (badcursor instead).
1778 bool update = leftinset;
1779 if (!do_selection && !badcursor && d->cursor_.inTexted())
1780 update |= checkDepm(cur, d->cursor_);
1782 d->cursor_.setCursor(cur);
1783 d->cursor_.boundary(cur.boundary());
1785 d->cursor_.setSelection();
1787 d->cursor_.clearSelection();
1789 d->cursor_.finishUndo();
1790 d->cursor_.setCurrentFont();
1795 void BufferView::putSelectionAt(DocIterator const & cur,
1796 int length, bool backwards)
1798 d->cursor_.clearSelection();
1804 d->cursor_.pos() += length;
1805 d->cursor_.setSelection(d->cursor_, -length);
1807 d->cursor_.setSelection(d->cursor_, length);
1809 // Ensure a redraw happens in any case because the new selection could
1810 // possibly be on the same screen as the previous selection.
1811 processUpdateFlags(Update::Force | Update::FitCursor);
1815 Cursor & BufferView::cursor()
1821 Cursor const & BufferView::cursor() const
1827 pit_type BufferView::anchor_ref() const
1829 return d->anchor_pit_;
1833 bool BufferView::singleParUpdate()
1835 Text & buftext = buffer_.text();
1836 pit_type const bottom_pit = d->cursor_.bottom().pit();
1837 TextMetrics & tm = textMetrics(&buftext);
1838 int old_height = tm.parMetrics(bottom_pit).height();
1840 // make sure inline completion pointer is ok
1841 if (d->inlineCompletionPos_.fixIfBroken())
1842 d->inlineCompletionPos_ = DocIterator();
1844 // In Single Paragraph mode, rebreak only
1845 // the (main text, not inset!) paragraph containing the cursor.
1846 // (if this paragraph contains insets etc., rebreaking will
1847 // recursively descend)
1848 tm.redoParagraph(bottom_pit);
1849 ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
1850 if (pm.height() != old_height)
1851 // Paragraph height has changed so we cannot proceed to
1852 // the singlePar optimisation.
1855 d->update_strategy_ = SingleParUpdate;
1857 LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
1858 << " y2: " << pm.position() + pm.descent()
1859 << " pit: " << bottom_pit
1860 << " singlepar: 1");
1865 void BufferView::updateMetrics()
1867 Text & buftext = buffer_.text();
1868 pit_type const npit = int(buftext.paragraphs().size());
1870 // Clear out the position cache in case of full screen redraw,
1871 d->coord_cache_.clear();
1873 // Clear out paragraph metrics to avoid having invalid metrics
1874 // in the cache from paragraphs not relayouted below
1875 // The complete text metrics will be redone.
1876 d->text_metrics_.clear();
1878 TextMetrics & tm = textMetrics(&buftext);
1880 // make sure inline completion pointer is ok
1881 if (d->inlineCompletionPos_.fixIfBroken())
1882 d->inlineCompletionPos_ = DocIterator();
1884 if (d->anchor_pit_ >= npit)
1885 // The anchor pit must have been deleted...
1886 d->anchor_pit_ = npit - 1;
1888 // Rebreak anchor paragraph.
1889 tm.redoParagraph(d->anchor_pit_);
1890 ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
1893 if (d->anchor_pit_ == 0) {
1894 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
1896 // Complete buffer visible? Then it's easy.
1897 if (scrollRange == 0)
1898 d->anchor_ypos_ = anchor_pm.ascent();
1900 // FIXME: Some clever handling needed to show
1901 // the _first_ paragraph up to the top if the cursor is
1902 // in the first line.
1904 anchor_pm.setPosition(d->anchor_ypos_);
1906 LYXERR(Debug::PAINTING, "metrics: "
1907 << " anchor pit = " << d->anchor_pit_
1908 << " anchor ypos = " << d->anchor_ypos_);
1910 // Redo paragraphs above anchor if necessary.
1911 int y1 = d->anchor_ypos_ - anchor_pm.ascent();
1912 // We are now just above the anchor paragraph.
1913 pit_type pit1 = d->anchor_pit_ - 1;
1914 for (; pit1 >= 0 && y1 >= 0; --pit1) {
1915 tm.redoParagraph(pit1);
1916 ParagraphMetrics & pm = tm.par_metrics_[pit1];
1918 // Save the paragraph position in the cache.
1923 // Redo paragraphs below the anchor if necessary.
1924 int y2 = d->anchor_ypos_ + anchor_pm.descent();
1925 // We are now just below the anchor paragraph.
1926 pit_type pit2 = d->anchor_pit_ + 1;
1927 for (; pit2 < npit && y2 <= height_; ++pit2) {
1928 tm.redoParagraph(pit2);
1929 ParagraphMetrics & pm = tm.par_metrics_[pit2];
1931 // Save the paragraph position in the cache.
1936 LYXERR(Debug::PAINTING, "Metrics: "
1937 << " anchor pit = " << d->anchor_pit_
1938 << " anchor ypos = " << d->anchor_ypos_
1941 << " pit1 = " << pit1
1942 << " pit2 = " << pit2);
1944 d->update_strategy_ = FullScreenUpdate;
1946 if (lyxerr.debugging(Debug::WORKAREA)) {
1947 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
1948 d->coord_cache_.dump();
1953 void BufferView::insertLyXFile(FileName const & fname)
1955 LASSERT(d->cursor_.inTexted(), /**/);
1957 // Get absolute path of file and add ".lyx"
1958 // to the filename if necessary
1959 FileName filename = fileSearch(string(), fname.absFilename(), "lyx");
1961 docstring const disp_fn = makeDisplayPath(filename.absFilename());
1962 // emit message signal.
1963 message(bformat(_("Inserting document %1$s..."), disp_fn));
1966 Buffer buf("", false);
1967 if (buf.loadLyXFile(filename)) {
1968 ErrorList & el = buffer_.errorList("Parse");
1969 // Copy the inserted document error list into the current buffer one.
1970 el = buf.errorList("Parse");
1971 buffer_.undo().recordUndo(d->cursor_);
1972 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
1973 buf.params().documentClassPtr(), el);
1974 res = _("Document %1$s inserted.");
1976 res = _("Could not insert document %1$s");
1981 // emit message signal.
1982 message(bformat(res, disp_fn));
1983 buffer_.errors("Parse");
1987 Point BufferView::coordOffset(DocIterator const & dit, bool boundary) const
1993 // Addup contribution of nested insets, from inside to outside,
1994 // keeping the outer paragraph for a special handling below
1995 for (size_t i = dit.depth() - 1; i >= 1; --i) {
1996 CursorSlice const & sl = dit[i];
2000 // get relative position inside sl.inset()
2001 sl.inset().cursorPos(*this, sl, boundary && (i + 1 == dit.depth()), xx, yy);
2003 // Make relative position inside of the edited inset relative to sl.inset()
2007 // In case of an RTL inset, the edited inset will be positioned to the left
2010 bool boundary_i = boundary && i + 1 == dit.depth();
2011 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2016 // remember width for the case that sl.inset() is positioned in an RTL inset
2017 if (i && dit[i - 1].text()) {
2018 // If this Inset is inside a Text Inset, retrieve the Dimension
2019 // from the containing text instead of using Inset::dimension() which
2020 // might not be implemented.
2021 // FIXME (Abdel 23/09/2007): this is a bit messy because of the
2022 // elimination of Inset::dim_ cache. This coordOffset() method needs
2023 // to be rewritten in light of the new design.
2024 Dimension const & dim = parMetrics(dit[i - 1].text(),
2025 dit[i - 1].pit()).insetDimension(&sl.inset());
2028 Dimension const dim = sl.inset().dimension(*this);
2032 //lyxerr << "Cursor::getPos, i: "
2033 // << i << " x: " << xx << " y: " << y << endl;
2036 // Add contribution of initial rows of outermost paragraph
2037 CursorSlice const & sl = dit[0];
2038 TextMetrics const & tm = textMetrics(sl.text());
2039 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2040 LASSERT(!pm.rows().empty(), /**/);
2041 y -= pm.rows()[0].ascent();
2043 // FIXME: document this mess
2045 if (sl.pos() > 0 && dit.depth() == 1) {
2047 if (pos && boundary)
2049 // lyxerr << "coordOffset: boundary:" << boundary << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
2050 rend = pm.pos2row(pos);
2052 rend = pm.pos2row(sl.pos());
2054 size_t rend = pm.pos2row(sl.pos());
2056 for (size_t rit = 0; rit != rend; ++rit)
2057 y += pm.rows()[rit].height();
2058 y += pm.rows()[rend].ascent();
2060 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
2062 // Make relative position from the nested inset now bufferview absolute.
2063 int xx = bottom_tm.cursorX(dit.bottom(), boundary && dit.depth() == 1);
2066 // In the RTL case place the nested inset at the left of the cursor in
2067 // the outer paragraph
2068 bool boundary_1 = boundary && 1 == dit.depth();
2069 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
2077 Point BufferView::getPos(DocIterator const & dit, bool boundary) const
2079 CursorSlice const & bot = dit.bottom();
2080 TextMetrics const & tm = textMetrics(bot.text());
2081 if (!tm.contains(bot.pit()))
2082 return Point(-1, -1);
2084 Point p = coordOffset(dit, boundary); // offset from outer paragraph
2085 p.y_ += tm.parMetrics(bot.pit()).position();
2090 void BufferView::draw(frontend::Painter & pain)
2092 LYXERR(Debug::PAINTING, "\t\t*** START DRAWING ***");
2093 Text & text = buffer_.text();
2094 TextMetrics const & tm = d->text_metrics_[&text];
2095 int const y = tm.first().second->position();
2096 PainterInfo pi(this, pain);
2098 switch (d->update_strategy_) {
2100 case NoScreenUpdate:
2101 // If no screen painting is actually needed, only some the different
2102 // coordinates of insets and paragraphs needs to be updated.
2103 pi.full_repaint = true;
2104 pi.pain.setDrawingEnabled(false);
2108 case SingleParUpdate:
2109 pi.full_repaint = false;
2110 // In general, only the current row of the outermost paragraph
2111 // will be redrawn. Particular cases where selection spans
2112 // multiple paragraph are correctly detected in TextMetrics.
2116 case DecorationUpdate:
2117 // FIXME: We should also distinguish DecorationUpdate to avoid text
2118 // drawing if possible. This is not possible to do easily right now
2119 // because of the single backing pixmap.
2121 case FullScreenUpdate:
2122 // The whole screen, including insets, will be refreshed.
2123 pi.full_repaint = true;
2125 // Clear background.
2126 pain.fillRectangle(0, 0, width_, height_,
2127 buffer_.inset().backgroundColor());
2132 // and possibly grey out below
2133 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2134 int const y2 = lastpm.second->position() + lastpm.second->descent();
2136 pain.fillRectangle(0, y2, width_, height_ - y2, Color_bottomarea);
2139 LYXERR(Debug::PAINTING, "\n\t\t*** END DRAWING ***");
2141 // The scrollbar needs an update.
2144 // Normalize anchor for next time
2145 pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
2146 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2147 for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
2148 ParagraphMetrics const & pm = tm.parMetrics(pit);
2149 if (pm.position() + pm.descent() > 0) {
2150 d->anchor_pit_ = pit;
2151 d->anchor_ypos_ = pm.position();
2155 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
2156 << " anchor ypos = " << d->anchor_ypos_);
2160 void BufferView::message(docstring const & msg)
2163 d->gui_->message(msg);
2167 void BufferView::showDialog(string const & name)
2170 d->gui_->showDialog(name, string());
2174 void BufferView::showDialog(string const & name,
2175 string const & data, Inset * inset)
2178 d->gui_->showDialog(name, data, inset);
2182 void BufferView::updateDialog(string const & name, string const & data)
2185 d->gui_->updateDialog(name, data);
2189 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
2195 // FIXME: Move this out of BufferView again
2196 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
2198 if (!fname.isReadableFile()) {
2199 docstring const error = from_ascii(strerror(errno));
2200 docstring const file = makeDisplayPath(fname.absFilename(), 50);
2201 docstring const text =
2202 bformat(_("Could not read the specified document\n"
2203 "%1$s\ndue to the error: %2$s"), file, error);
2204 Alert::error(_("Could not read file"), text);
2208 if (!fname.isReadableFile()) {
2209 docstring const file = makeDisplayPath(fname.absFilename(), 50);
2210 docstring const text =
2211 bformat(_("%1$s\n is not readable."), file);
2212 Alert::error(_("Could not open file"), text);
2216 // FIXME UNICODE: We don't know the encoding of the file
2217 docstring file_content = fname.fileContents("UTF-8");
2218 if (file_content.empty()) {
2219 Alert::error(_("Reading not UTF-8 encoded file"),
2220 _("The file is not UTF-8 encoded.\n"
2221 "It will be read as local 8Bit-encoded.\n"
2222 "If this does not give the correct result\n"
2223 "then please change the encoding of the file\n"
2224 "to UTF-8 with a program other than LyX.\n"));
2225 file_content = fname.fileContents("local8bit");
2228 return normalize_c(file_content);
2232 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
2234 docstring const tmpstr = contentsOfPlaintextFile(f);
2239 Cursor & cur = cursor();
2240 cap::replaceSelection(cur);
2241 buffer_.undo().recordUndo(cur);
2243 cur.innerText()->insertStringAsParagraphs(cur, tmpstr);
2245 cur.innerText()->insertStringAsLines(cur, tmpstr);
2252 docstring const & BufferView::inlineCompletion() const
2254 return d->inlineCompletion_;
2258 size_t const & BufferView::inlineCompletionUniqueChars() const
2260 return d->inlineCompletionUniqueChars_;
2264 DocIterator const & BufferView::inlineCompletionPos() const
2266 return d->inlineCompletionPos_;
2270 bool samePar(DocIterator const & a, DocIterator const & b)
2272 if (a.empty() && b.empty())
2274 if (a.empty() || b.empty())
2276 return &a.innerParagraph() == &b.innerParagraph();
2280 void BufferView::setInlineCompletion(Cursor & cur, DocIterator const & pos,
2281 docstring const & completion, size_t uniqueChars)
2283 uniqueChars = min(completion.size(), uniqueChars);
2284 bool changed = d->inlineCompletion_ != completion
2285 || d->inlineCompletionUniqueChars_ != uniqueChars;
2286 bool singlePar = true;
2287 d->inlineCompletion_ = completion;
2288 d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
2290 //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
2293 DocIterator const & old = d->inlineCompletionPos_;
2295 //lyxerr << "inlineCompletionPos changed" << std::endl;
2296 // old or pos are in another paragraph?
2297 if ((!samePar(cur, pos) && !pos.empty())
2298 || (!samePar(cur, old) && !old.empty())) {
2300 //lyxerr << "different paragraph" << std::endl;
2302 d->inlineCompletionPos_ = pos;
2307 if (singlePar && !(cur.disp_.update() & Update::Force))
2308 cur.updateFlags(cur.disp_.update() | Update::SinglePar);
2310 cur.updateFlags(cur.disp_.update() | Update::Force);