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"
20 #include "buffer_funcs.h"
21 #include "BufferList.h"
22 #include "BufferParams.h"
23 #include "CoordCache.h"
25 #include "CutAndPaste.h"
26 #include "DispatchResult.h"
27 #include "EmbeddedFiles.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"
53 #include "WordLangTuple.h"
55 #include "insets/InsetBibtex.h"
56 #include "insets/InsetCommand.h" // ChangeRefs
57 #include "insets/InsetRef.h"
58 #include "insets/InsetText.h"
60 #include "frontends/alert.h"
61 #include "frontends/Application.h"
62 #include "frontends/Delegates.h"
63 #include "frontends/FontMetrics.h"
64 #include "frontends/Painter.h"
65 #include "frontends/Selection.h"
67 #include "graphics/Previews.h"
69 #include "support/convert.h"
70 #include "support/debug.h"
71 #include "support/ExceptionMessage.h"
72 #include "support/filetools.h"
73 #include "support/gettext.h"
74 #include "support/lstrings.h"
75 #include "support/Package.h"
76 #include "support/types.h"
85 using namespace lyx::support;
89 namespace Alert = frontend::Alert;
93 /// Return an inset of this class if it exists at the current cursor position
95 T * getInsetByCode(Cursor const & cur, InsetCode code)
98 Inset * inset = it.nextInset();
99 if (inset && inset->lyxCode() == code)
100 return static_cast<T*>(inset);
105 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
108 bool findNextInset(DocIterator & dit, vector<InsetCode> const & codes,
109 docstring const & contents)
111 DocIterator tmpdit = dit;
114 Inset const * inset = tmpdit.nextInset();
116 && std::find(codes.begin(), codes.end(), inset->lyxCode()) != codes.end()
117 && (contents.empty() ||
118 static_cast<InsetCommand const *>(inset)->getFirstNonOptParam() == contents)) {
122 tmpdit.forwardInset();
129 /// Looks for next inset with one of the given codes.
130 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
134 DocIterator tmpdit = dit;
135 tmpdit.forwardInset();
140 Inset const * inset = tmpdit.nextInset();
142 && std::find(codes.begin(), codes.end(), inset->lyxCode()) != codes.end()) {
143 contents = static_cast<InsetCommand const *>(inset)->getFirstNonOptParam();
147 if (!findNextInset(tmpdit, codes, contents)) {
148 if (dit.depth() != 1 || dit.pit() != 0 || dit.pos() != 0) {
149 tmpdit = doc_iterator_begin(tmpdit.bottom().inset());
150 if (!findNextInset(tmpdit, codes, contents))
161 /// Looks for next inset with the given code
162 void findInset(DocIterator & dit, InsetCode code, bool same_content)
164 findInset(dit, vector<InsetCode>(1, code), same_content);
168 /// Moves cursor to the next inset with one of the given codes.
169 void gotoInset(BufferView * bv, vector<InsetCode> const & codes,
172 Cursor tmpcur = bv->cursor();
173 if (!findInset(tmpcur, codes, same_content)) {
174 bv->cursor().message(_("No more insets"));
178 tmpcur.clearSelection();
179 bv->setCursor(tmpcur);
184 /// Moves cursor to the next inset with given code.
185 void gotoInset(BufferView * bv, InsetCode code, bool same_content)
187 gotoInset(bv, vector<InsetCode>(1, code), same_content);
191 /// A map from a Text to the associated text metrics
192 typedef map<Text const *, TextMetrics> TextMetricsCache;
194 enum ScreenUpdateStrategy {
204 /////////////////////////////////////////////////////////////////////
208 /////////////////////////////////////////////////////////////////////
210 struct BufferView::Private
212 Private(BufferView & bv): wh_(0), cursor_(bv),
213 anchor_pit_(0), anchor_ypos_(0),
214 last_inset_(0), gui_(0)
218 ScrollbarParameters scrollbarParameters_;
220 ScreenUpdateStrategy update_strategy_;
222 CoordCache coord_cache_;
224 /// Estimated average par height for scrollbar.
226 /// this is used to handle XSelection events in the right manner.
235 pit_type anchor_pit_;
239 vector<int> par_height_;
242 DocIterator inlineCompletionPos;
244 docstring inlineCompletion;
246 size_t inlineCompletionUniqueChars;
248 /// keyboard mapping object.
251 /// last visited inset.
252 /** kept to send setMouseHover(false).
253 * Not owned, so don't delete.
257 mutable TextMetricsCache text_metrics_;
260 /** Not owned, so don't delete.
262 frontend::GuiBufferViewDelegate * gui_;
266 BufferView::BufferView(Buffer & buf)
267 : width_(0), height_(0), full_screen_(false), buffer_(buf), d(new Private(*this))
269 d->xsel_cache_.set = false;
270 d->intl_.initKeyMapper(lyxrc.use_kbmap);
272 d->cursor_.push(buffer_.inset());
273 d->cursor_.resetAnchor();
274 d->cursor_.setCurrentFont();
276 if (graphics::Previews::status() != LyXRC::PREVIEW_OFF)
277 graphics::Previews::get().generateBufferPreviews(buffer_);
281 BufferView::~BufferView()
283 // current buffer is going to be switched-off, save cursor pos
284 // Ideally, the whole cursor stack should be saved, but session
285 // currently can only handle bottom (whole document) level pit and pos.
286 // That is to say, if a cursor is in a nested inset, it will be
287 // restore to the left of the top level inset.
288 LastFilePosSection::FilePos fp;
289 fp.pit = d->cursor_.bottom().pit();
290 fp.pos = d->cursor_.bottom().pos();
291 LyX::ref().session().lastFilePos().save(buffer_.fileName(), fp);
297 int BufferView::rightMargin() const
299 // The additional test for the case the outliner is opened.
301 !lyxrc.full_screen_limit ||
302 width_ < lyxrc.full_screen_width + 20)
305 return (width_ - lyxrc.full_screen_width) / 2;
309 int BufferView::leftMargin() const
311 return rightMargin();
315 bool BufferView::isTopScreen() const
317 return d->scrollbarParameters_.position == d->scrollbarParameters_.min;
321 bool BufferView::isBottomScreen() const
323 return d->scrollbarParameters_.position == d->scrollbarParameters_.max;
327 Intl & BufferView::getIntl()
333 Intl const & BufferView::getIntl() const
339 CoordCache & BufferView::coordCache()
341 return d->coord_cache_;
345 CoordCache const & BufferView::coordCache() const
347 return d->coord_cache_;
351 Buffer & BufferView::buffer()
357 Buffer const & BufferView::buffer() const
363 bool BufferView::fitCursor()
365 if (cursorStatus(d->cursor_) == CUR_INSIDE) {
366 frontend::FontMetrics const & fm =
367 theFontMetrics(d->cursor_.getFont().fontInfo());
368 int const asc = fm.maxAscent();
369 int const des = fm.maxDescent();
370 Point const p = getPos(d->cursor_, d->cursor_.boundary());
371 if (p.y_ - asc >= 0 && p.y_ + des < height_)
378 void BufferView::processUpdateFlags(Update::flags flags)
380 // last_inset_ points to the last visited inset. This pointer may become
381 // invalid because of keyboard editing. Since all such operations
382 // causes screen update(), I reset last_inset_ to avoid such a problem.
384 // This is close to a hot-path.
385 LYXERR(Debug::DEBUG, "BufferView::processUpdateFlags()"
386 << "[fitcursor = " << (flags & Update::FitCursor)
387 << ", forceupdate = " << (flags & Update::Force)
388 << ", singlepar = " << (flags & Update::SinglePar)
389 << "] buffer: " << &buffer_);
391 buffer_.updateMacros();
393 // Now do the first drawing step if needed. This consists on updating
394 // the CoordCache in updateMetrics().
395 // The second drawing step is done in WorkArea::redraw() if needed.
397 // Case when no explicit update is requested.
399 // no need to redraw anything.
400 d->update_strategy_ = NoScreenUpdate;
404 if (flags == Update::Decoration) {
405 d->update_strategy_ = DecorationUpdate;
410 if (flags == Update::FitCursor
411 || flags == (Update::Decoration | Update::FitCursor)) {
412 // tell the frontend to update the screen if needed.
417 if (flags & Update::Decoration) {
418 d->update_strategy_ = DecorationUpdate;
422 // no screen update is needed.
423 d->update_strategy_ = NoScreenUpdate;
427 bool const full_metrics = flags & Update::Force || !singleParUpdate();
430 // We have to update the full screen metrics.
433 if (!(flags & Update::FitCursor)) {
434 // Nothing to do anymore. Trigger a redraw and return
439 // updateMetrics() does not update paragraph position
440 // This is done at draw() time. So we need a redraw!
444 // The cursor is off screen so ensure it is visible.
451 void BufferView::updateScrollbar()
456 // We prefer fixed size line scrolling.
457 d->scrollbarParameters_.single_step = defaultRowHeight();
458 // We prefer full screen page scrolling.
459 d->scrollbarParameters_.page_step = height_;
461 Text & t = buffer_.text();
462 TextMetrics & tm = d->text_metrics_[&t];
464 LYXERR(Debug::GUI, " Updating scrollbar: height: "
465 << t.paragraphs().size()
466 << " curr par: " << d->cursor_.bottom().pit()
467 << " default height " << defaultRowHeight());
469 size_t const parsize = t.paragraphs().size();
470 if (d->par_height_.size() != parsize) {
471 d->par_height_.clear();
472 // FIXME: We assume a default paragraph height of 2 rows. This
473 // should probably be pondered with the screen width.
474 d->par_height_.resize(parsize, defaultRowHeight() * 2);
477 // Look at paragraph heights on-screen
478 pair<pit_type, ParagraphMetrics const *> first = tm.first();
479 pair<pit_type, ParagraphMetrics const *> last = tm.last();
480 for (pit_type pit = first.first; pit <= last.first; ++pit) {
481 d->par_height_[pit] = tm.parMetrics(pit).height();
482 LYXERR(Debug::SCROLLING, "storing height for pit " << pit << " : "
483 << d->par_height_[pit]);
486 int top_pos = first.second->position() - first.second->ascent();
487 int bottom_pos = last.second->position() + last.second->descent();
488 bool first_visible = first.first == 0 && top_pos >= 0;
489 bool last_visible = last.first + 1 == int(parsize) && bottom_pos <= height_;
490 if (first_visible && last_visible) {
491 d->scrollbarParameters_.min = 0;
492 d->scrollbarParameters_.max = 0;
496 d->scrollbarParameters_.min = top_pos;
497 for (size_t i = 0; i != size_t(first.first); ++i)
498 d->scrollbarParameters_.min -= d->par_height_[i];
499 d->scrollbarParameters_.max = bottom_pos;
500 for (size_t i = last.first + 1; i != parsize; ++i)
501 d->scrollbarParameters_.max += d->par_height_[i];
503 d->scrollbarParameters_.position = 0;
504 // The reference is the top position so we remove one page.
505 d->scrollbarParameters_.max -= d->scrollbarParameters_.page_step;
509 ScrollbarParameters const & BufferView::scrollbarParameters() const
511 return d->scrollbarParameters_;
515 docstring BufferView::toolTip(int x, int y) const
517 // Get inset under mouse, if there is one.
518 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
520 // No inset, no tooltip...
522 return covering_inset->toolTip(*this, x, y);
526 docstring BufferView::contextMenu(int x, int y) const
528 // Get inset under mouse, if there is one.
529 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
531 return covering_inset->contextMenu(*this, x, y);
533 // FIXME: Do something more elaborate here.
534 return from_ascii("edit");
538 void BufferView::scrollDocView(int value)
540 int const offset = value - d->scrollbarParameters_.position;
541 // If the offset is less than 2 screen height, prefer to scroll instead.
542 if (abs(offset) <= 2 * height_) {
547 // cut off at the top
548 if (value <= d->scrollbarParameters_.min) {
549 DocIterator dit = doc_iterator_begin(buffer_.inset());
551 LYXERR(Debug::SCROLLING, "scroll to top");
555 // cut off at the bottom
556 if (value >= d->scrollbarParameters_.max) {
557 DocIterator dit = doc_iterator_end(buffer_.inset());
560 LYXERR(Debug::SCROLLING, "scroll to bottom");
564 // find paragraph at target position
565 int par_pos = d->scrollbarParameters_.min;
567 for (; i != int(d->par_height_.size()); ++i) {
568 par_pos += d->par_height_[i];
569 if (par_pos >= value)
573 if (par_pos < value) {
574 // It seems we didn't find the correct pit so stay on the safe side and
576 LYXERR0("scrolling position not found!");
577 scrollDocView(d->scrollbarParameters_.max);
581 DocIterator dit = doc_iterator_begin(buffer_.inset());
583 LYXERR(Debug::SCROLLING, "value = " << value << " -> scroll to pit " << i);
588 // FIXME: this method is not working well.
589 void BufferView::setCursorFromScrollbar()
591 TextMetrics & tm = d->text_metrics_[&buffer_.text()];
593 int const height = 2 * defaultRowHeight();
594 int const first = height;
595 int const last = height_ - height;
596 Cursor & cur = d->cursor_;
598 switch (cursorStatus(cur)) {
600 // We reset the cursor because cursorStatus() does not
601 // work when the cursor is within mathed.
602 cur.reset(buffer_.inset());
603 tm.setCursorFromCoordinates(cur, 0, first);
604 cur.clearSelection();
607 // We reset the cursor because cursorStatus() does not
608 // work when the cursor is within mathed.
609 cur.reset(buffer_.inset());
610 tm.setCursorFromCoordinates(cur, 0, last);
611 cur.clearSelection();
614 int const y = getPos(cur, cur.boundary()).y_;
615 int const newy = min(last, max(y, first));
617 cur.reset(buffer_.inset());
618 tm.setCursorFromCoordinates(cur, 0, newy);
624 Change const BufferView::getCurrentChange() const
626 if (!d->cursor_.selection())
627 return Change(Change::UNCHANGED);
629 DocIterator dit = d->cursor_.selectionBegin();
630 return dit.paragraph().lookupChange(dit.pos());
634 // this could be used elsewhere as well?
635 // FIXME: This does not work within mathed!
636 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
638 Point const p = getPos(dit, dit.boundary());
641 if (p.y_ > workHeight())
647 void BufferView::saveBookmark(unsigned int idx)
649 // tenatively save bookmark, id and pos will be used to
650 // acturately locate a bookmark in a 'live' lyx session.
651 // pit and pos will be updated with bottom level pit/pos
653 LyX::ref().session().bookmarks().save(
655 d->cursor_.bottom().pit(),
656 d->cursor_.bottom().pos(),
657 d->cursor_.paragraph().id(),
662 // emit message signal.
663 message(_("Save bookmark"));
667 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
668 int top_id, pos_type top_pos)
670 bool success = false;
673 d->cursor_.clearSelection();
675 // if a valid par_id is given, try it first
676 // This is the case for a 'live' bookmark when unique paragraph ID
677 // is used to track bookmarks.
679 dit = buffer_.getParFromID(top_id);
681 dit.pos() = min(dit.paragraph().size(), top_pos);
682 // Some slices of the iterator may not be
683 // reachable (e.g. closed collapsable inset)
684 // so the dociterator may need to be
685 // shortened. Otherwise, setCursor may crash
686 // lyx when the cursor can not be set to these
688 size_t const n = dit.depth();
689 for (size_t i = 0; i < n; ++i)
690 if (dit[i].inset().editable() != Inset::HIGHLY_EDITABLE) {
698 // if top_id == 0, or searching through top_id failed
699 // This is the case for a 'restored' bookmark when only bottom
700 // (document level) pit was saved. Because of this, bookmark
701 // restoration is inaccurate. If a bookmark was within an inset,
702 // it will be restored to the left of the outmost inset that contains
704 if (bottom_pit < int(buffer_.paragraphs().size())) {
705 dit = doc_iterator_begin(buffer_.inset());
707 dit.pit() = bottom_pit;
708 dit.pos() = min(bottom_pos, dit.paragraph().size());
713 // Note: only bottom (document) level pit is set.
715 // set the current font.
716 d->cursor_.setCurrentFont();
717 // To center the screen on this new position we need the
718 // paragraph position which is computed at draw() time.
719 // So we need a redraw!
729 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
731 if (lyxrc.rtl_support) {
732 if (d->cursor_.real_current_font.isRightToLeft()) {
733 if (d->intl_.keymap == Intl::PRIMARY)
734 d->intl_.keyMapSec();
736 if (d->intl_.keymap == Intl::SECONDARY)
737 d->intl_.keyMapPrim();
741 d->intl_.getTransManager().translateAndInsert(c, t, cur);
745 int BufferView::workWidth() const
751 void BufferView::showCursor()
753 showCursor(d->cursor_);
757 void BufferView::showCursor(DocIterator const & dit)
759 // We are not properly started yet, delay until resizing is
764 LYXERR(Debug::SCROLLING, "recentering!");
766 CursorSlice const & bot = dit.bottom();
767 TextMetrics & tm = d->text_metrics_[bot.text()];
769 pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
770 int bot_pit = bot.pit();
771 if (bot_pit > max_pit) {
772 // FIXME: Why does this happen?
773 LYXERR0("bottom pit is greater that max pit: "
774 << bot_pit << " > " << max_pit);
778 if (bot_pit == tm.first().first - 1)
779 tm.newParMetricsUp();
780 else if (bot_pit == tm.last().first + 1)
781 tm.newParMetricsDown();
783 if (tm.contains(bot_pit)) {
784 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
785 BOOST_ASSERT(!pm.rows().empty());
786 // FIXME: smooth scrolling doesn't work in mathed.
787 CursorSlice const & cs = dit.innerTextSlice();
788 int offset = coordOffset(dit, dit.boundary()).y_;
789 int ypos = pm.position() + offset;
790 Dimension const & row_dim =
791 pm.getRow(cs.pos(), dit.boundary()).dimension();
792 if (ypos - row_dim.ascent() < 0)
793 scrollUp(- ypos + row_dim.ascent());
794 else if (ypos + row_dim.descent() > height_)
795 scrollDown(ypos - height_ + row_dim.descent());
796 // else, nothing to do, the cursor is already visible so we just return.
800 // fix inline completion position
801 if (d->inlineCompletionPos.fixIfBroken())
802 d->inlineCompletionPos = DocIterator();
804 tm.redoParagraph(bot_pit);
805 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
806 int offset = coordOffset(dit, dit.boundary()).y_;
808 d->anchor_pit_ = bot_pit;
809 CursorSlice const & cs = dit.innerTextSlice();
810 Dimension const & row_dim =
811 pm.getRow(cs.pos(), dit.boundary()).dimension();
813 if (d->anchor_pit_ == 0)
814 d->anchor_ypos_ = offset + pm.ascent();
815 else if (d->anchor_pit_ == max_pit)
816 d->anchor_ypos_ = height_ - offset - row_dim.descent();
818 d->anchor_ypos_ = defaultRowHeight() * 2 - offset - row_dim.descent();
825 FuncStatus BufferView::getStatus(FuncRequest const & cmd)
829 Cursor & cur = d->cursor_;
831 switch (cmd.action) {
834 flag.enabled(buffer_.undo().hasUndoStack());
837 flag.enabled(buffer_.undo().hasRedoStack());
839 case LFUN_FILE_INSERT:
840 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
841 case LFUN_FILE_INSERT_PLAINTEXT:
842 case LFUN_BOOKMARK_SAVE:
843 // FIXME: Actually, these LFUNS should be moved to Text
844 flag.enabled(cur.inTexted());
846 case LFUN_FONT_STATE:
847 case LFUN_LABEL_INSERT:
848 case LFUN_INFO_INSERT:
849 case LFUN_PARAGRAPH_GOTO:
851 case LFUN_REFERENCE_NEXT:
853 case LFUN_WORD_REPLACE:
856 case LFUN_MARK_TOGGLE:
857 case LFUN_SCREEN_RECENTER:
858 case LFUN_BIBTEX_DATABASE_ADD:
859 case LFUN_BIBTEX_DATABASE_DEL:
860 case LFUN_STATISTICS:
861 case LFUN_NEXT_INSET_TOGGLE:
865 case LFUN_LABEL_GOTO: {
866 flag.enabled(!cmd.argument().empty()
867 || getInsetByCode<InsetRef>(cur, REF_CODE));
871 case LFUN_CHANGES_TRACK:
873 flag.setOnOff(buffer_.params().trackChanges);
876 case LFUN_CHANGES_OUTPUT:
878 flag.setOnOff(buffer_.params().outputChanges);
881 case LFUN_CHANGES_MERGE:
882 case LFUN_CHANGE_NEXT:
883 case LFUN_ALL_CHANGES_ACCEPT:
884 case LFUN_ALL_CHANGES_REJECT:
885 // TODO: context-sensitive enabling of LFUNs
886 // In principle, these command should only be enabled if there
887 // is a change in the document. However, without proper
888 // optimizations, this will inevitably result in poor performance.
892 case LFUN_BUFFER_TOGGLE_COMPRESSION: {
893 flag.setOnOff(buffer_.params().compressed);
897 case LFUN_BUFFER_TOGGLE_EMBEDDING: {
898 flag.setOnOff(buffer_.params().embedded);
903 case LFUN_SCREEN_DOWN:
908 // FIXME: LFUN_SCREEN_DOWN_SELECT should be removed from
909 // everywhere else before this can enabled:
910 case LFUN_SCREEN_UP_SELECT:
911 case LFUN_SCREEN_DOWN_SELECT:
915 case LFUN_LAYOUT_TABULAR:
916 flag.enabled(cur.innerInsetOfType(TABULAR_CODE));
920 case LFUN_LAYOUT_PARAGRAPH:
921 flag.enabled(cur.inset().allowParagraphCustomization(cur.idx()));
924 case LFUN_INSET_SETTINGS: {
925 InsetCode code = cur.inset().lyxCode();
929 enable = cmd.argument() == "tabular";
932 enable = cmd.argument() == "ert";
935 enable = cmd.argument() == "float";
938 enable = cmd.argument() == "wrap";
941 enable = cmd.argument() == "note";
944 enable = cmd.argument() == "branch";
947 enable = cmd.argument() == "box";
950 enable = cmd.argument() == "listings";
955 flag.enabled(enable);
959 case LFUN_DIALOG_SHOW_NEW_INSET:
960 flag.enabled(cur.inset().lyxCode() != ERT_CODE &&
961 cur.inset().lyxCode() != LISTINGS_CODE);
962 if (cur.inset().lyxCode() == CAPTION_CODE) {
964 if (cur.inset().getStatus(cur, cmd, flag))
977 bool BufferView::dispatch(FuncRequest const & cmd)
979 //lyxerr << [ cmd = " << cmd << "]" << endl;
981 // Make sure that the cached BufferView is correct.
982 LYXERR(Debug::ACTION, " action[" << cmd.action << ']'
983 << " arg[" << to_utf8(cmd.argument()) << ']'
984 << " x[" << cmd.x << ']'
985 << " y[" << cmd.y << ']'
986 << " button[" << cmd.button() << ']');
988 Cursor & cur = d->cursor_;
990 switch (cmd.action) {
993 cur.message(_("Undo"));
994 cur.clearSelection();
996 cur.message(_("No further undo information"));
998 processUpdateFlags(Update::Force | Update::FitCursor);
1002 cur.message(_("Redo"));
1003 cur.clearSelection();
1004 if (!cur.textRedo())
1005 cur.message(_("No further redo information"));
1007 processUpdateFlags(Update::Force | Update::FitCursor);
1010 case LFUN_FONT_STATE:
1011 cur.message(cur.currentState());
1014 case LFUN_BOOKMARK_SAVE:
1015 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1018 case LFUN_LABEL_GOTO: {
1019 docstring label = cmd.argument();
1020 if (label.empty()) {
1022 getInsetByCode<InsetRef>(d->cursor_,
1025 label = inset->getParam("reference");
1026 // persistent=false: use temp_bookmark
1036 case LFUN_PARAGRAPH_GOTO: {
1037 int const id = convert<int>(to_utf8(cmd.argument()));
1039 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1040 b = theBufferList().next(b)) {
1042 DocIterator dit = b->getParFromID(id);
1044 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1048 LYXERR(Debug::INFO, "Paragraph " << dit.paragraph().id()
1049 << " found in buffer `"
1050 << b->absFileName() << "'.");
1052 if (b == &buffer_) {
1055 processUpdateFlags(Update::Force | Update::FitCursor);
1057 // Switch to other buffer view and resend cmd
1058 theLyXFunc().dispatch(FuncRequest(
1059 LFUN_BUFFER_SWITCH, b->absFileName()));
1060 theLyXFunc().dispatch(cmd);
1067 case LFUN_NOTE_NEXT:
1068 gotoInset(this, NOTE_CODE, false);
1071 case LFUN_REFERENCE_NEXT: {
1072 vector<InsetCode> tmp;
1073 tmp.push_back(LABEL_CODE);
1074 tmp.push_back(REF_CODE);
1075 gotoInset(this, tmp, true);
1079 case LFUN_CHANGES_TRACK:
1080 buffer_.params().trackChanges = !buffer_.params().trackChanges;
1083 case LFUN_CHANGES_OUTPUT:
1084 buffer_.params().outputChanges = !buffer_.params().outputChanges;
1085 if (buffer_.params().outputChanges) {
1086 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1087 bool xcolorsoul = LaTeXFeatures::isAvailable("soul") &&
1088 LaTeXFeatures::isAvailable("xcolor");
1090 if (!dvipost && !xcolorsoul) {
1091 Alert::warning(_("Changes not shown in LaTeX output"),
1092 _("Changes will not be highlighted in LaTeX output, "
1093 "because neither dvipost nor xcolor/soul are installed.\n"
1094 "Please install these packages or redefine "
1095 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1096 } else if (!xcolorsoul) {
1097 Alert::warning(_("Changes not shown in LaTeX output"),
1098 _("Changes will not be highlighted in LaTeX output "
1099 "when using pdflatex, because xcolor and soul are not installed.\n"
1100 "Please install both packages or redefine "
1101 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1106 case LFUN_CHANGE_NEXT:
1107 findNextChange(this);
1110 case LFUN_CHANGES_MERGE:
1111 if (findNextChange(this))
1112 showDialog("changes");
1115 case LFUN_ALL_CHANGES_ACCEPT:
1116 // select complete document
1117 d->cursor_.reset(buffer_.inset());
1118 d->cursor_.selHandle(true);
1119 buffer_.text().cursorBottom(d->cursor_);
1120 // accept everything in a single step to support atomic undo
1121 buffer_.text().acceptOrRejectChanges(d->cursor_, Text::ACCEPT);
1124 case LFUN_ALL_CHANGES_REJECT:
1125 // select complete document
1126 d->cursor_.reset(buffer_.inset());
1127 d->cursor_.selHandle(true);
1128 buffer_.text().cursorBottom(d->cursor_);
1129 // reject everything in a single step to support atomic undo
1130 // Note: reject does not work recursively; the user may have to repeat the operation
1131 buffer_.text().acceptOrRejectChanges(d->cursor_, Text::REJECT);
1134 case LFUN_WORD_FIND:
1135 if (find(this, cmd))
1138 message(_("String not found!"));
1141 case LFUN_WORD_REPLACE: {
1142 bool has_deleted = false;
1143 if (cur.selection()) {
1144 DocIterator beg = cur.selectionBegin();
1145 DocIterator end = cur.selectionEnd();
1146 if (beg.pit() == end.pit()) {
1147 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1148 if (cur.paragraph().isDeleted(p))
1153 replace(this, cmd, has_deleted);
1158 cur.clearSelection();
1160 cur.message(from_utf8(N_("Mark off")));
1164 cur.clearSelection();
1167 cur.message(from_utf8(N_("Mark on")));
1170 case LFUN_MARK_TOGGLE:
1171 cur.clearSelection();
1174 cur.message(from_utf8(N_("Mark removed")));
1177 cur.message(from_utf8(N_("Mark set")));
1182 case LFUN_SCREEN_RECENTER:
1186 case LFUN_BIBTEX_DATABASE_ADD: {
1187 Cursor tmpcur = d->cursor_;
1188 findInset(tmpcur, BIBTEX_CODE, false);
1189 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1192 if (inset->addDatabase(to_utf8(cmd.argument())))
1193 buffer_.updateBibfilesCache();
1198 case LFUN_BIBTEX_DATABASE_DEL: {
1199 Cursor tmpcur = d->cursor_;
1200 findInset(tmpcur, BIBTEX_CODE, false);
1201 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1204 if (inset->delDatabase(to_utf8(cmd.argument())))
1205 buffer_.updateBibfilesCache();
1210 case LFUN_STATISTICS: {
1211 DocIterator from, to;
1212 if (cur.selection()) {
1213 from = cur.selectionBegin();
1214 to = cur.selectionEnd();
1216 from = doc_iterator_begin(buffer_.inset());
1217 to = doc_iterator_end(buffer_.inset());
1219 int const words = countWords(from, to);
1220 int const chars = countChars(from, to, false);
1221 int const chars_blanks = countChars(from, to, true);
1223 if (cur.selection())
1224 message = _("Statistics for the selection:");
1226 message = _("Statistics for the document:");
1229 message += bformat(_("%1$d words"), words);
1231 message += _("One word");
1233 if (chars_blanks != 1)
1234 message += bformat(_("%1$d characters (including blanks)"),
1237 message += _("One character (including blanks)");
1240 message += bformat(_("%1$d characters (excluding blanks)"),
1243 message += _("One character (excluding blanks)");
1245 Alert::information(_("Statistics"), message);
1249 case LFUN_BUFFER_TOGGLE_COMPRESSION:
1250 // turn compression on/off
1251 buffer_.params().compressed = !buffer_.params().compressed;
1254 case LFUN_BUFFER_TOGGLE_EMBEDDING: {
1255 // turn embedding on/off
1257 buffer_.embeddedFiles().enable(!buffer_.params().embedded, buffer_);
1258 } catch (ExceptionMessage const & message) {
1259 Alert::error(message.title_, message.details_);
1264 case LFUN_NEXT_INSET_TOGGLE: {
1265 // this is the real function we want to invoke
1266 FuncRequest tmpcmd = FuncRequest(LFUN_INSET_TOGGLE, cmd.origin);
1267 // if there is an inset at cursor, see whether it
1269 Inset * inset = cur.nextInset();
1271 if (inset->isActive()) {
1272 Cursor tmpcur = cur;
1273 tmpcur.pushBackward(*inset);
1274 inset->dispatch(tmpcur, tmpcmd);
1275 if (tmpcur.result().dispatched()) {
1278 } else if (inset->editable() == Inset::IS_EDITABLE) {
1279 inset->edit(cur, true);
1282 // if it did not work, try the underlying inset.
1283 if (!cur.result().dispatched())
1284 cur.dispatch(tmpcmd);
1286 if (!cur.result().dispatched())
1287 // It did not work too; no action needed.
1289 cur.clearSelection();
1290 processUpdateFlags(Update::SinglePar | Update::FitCursor);
1294 case LFUN_SCREEN_UP:
1295 case LFUN_SCREEN_DOWN: {
1296 Point p = getPos(cur, cur.boundary());
1297 if (p.y_ < 0 || p.y_ > height_) {
1298 // The cursor is off-screen so recenter before proceeding.
1300 p = getPos(cur, cur.boundary());
1302 scroll(cmd.action == LFUN_SCREEN_UP? - height_ : height_);
1303 cur.reset(buffer_.inset());
1304 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_);
1305 //FIXME: what to do with cur.x_target()?
1314 case LFUN_SCREEN_UP_SELECT:
1315 case LFUN_SCREEN_DOWN_SELECT: {
1316 // Those two are not ready yet for consumption.
1319 cur.selHandle(true);
1320 size_t initial_depth = cur.depth();
1321 Point const p = getPos(cur, cur.boundary());
1322 scroll(cmd.action == LFUN_SCREEN_UP_SELECT? - height_ : height_);
1323 // FIXME: We need to verify if the cursor stayed within an inset...
1324 //cur.reset(buffer_.inset());
1325 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_);
1327 while (cur.depth() > initial_depth) {
1330 // FIXME: we need to do a redraw again because of the selection
1331 // But no screen update is needed.
1332 d->update_strategy_ = NoScreenUpdate;
1345 docstring const BufferView::requestSelection()
1347 Cursor & cur = d->cursor_;
1349 if (!cur.selection()) {
1350 d->xsel_cache_.set = false;
1354 if (!d->xsel_cache_.set ||
1355 cur.top() != d->xsel_cache_.cursor ||
1356 cur.anchor_.top() != d->xsel_cache_.anchor)
1358 d->xsel_cache_.cursor = cur.top();
1359 d->xsel_cache_.anchor = cur.anchor_.top();
1360 d->xsel_cache_.set = cur.selection();
1361 return cur.selectionAsString(false);
1367 void BufferView::clearSelection()
1369 d->cursor_.clearSelection();
1370 // Clear the selection buffer. Otherwise a subsequent
1371 // middle-mouse-button paste would use the selection buffer,
1372 // not the more current external selection.
1373 cap::clearSelection();
1374 d->xsel_cache_.set = false;
1375 // The buffer did not really change, but this causes the
1376 // redraw we need because we cleared the selection above.
1381 void BufferView::resize(int width, int height)
1383 // Update from work area
1387 // Clear the paragraph height cache.
1388 d->par_height_.clear();
1389 // Redo the metrics.
1394 Inset const * BufferView::getCoveringInset(Text const & text,
1397 TextMetrics & tm = d->text_metrics_[&text];
1398 Inset * inset = tm.checkInsetHit(x, y);
1402 if (!inset->descendable())
1403 // No need to go further down if the inset is not
1407 size_t cell_number = inset->nargs();
1408 // Check all the inner cell.
1409 for (size_t i = 0; i != cell_number; ++i) {
1410 Text const * inner_text = inset->getText(i);
1413 Inset const * inset_deeper =
1414 getCoveringInset(*inner_text, x, y);
1416 return inset_deeper;
1424 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
1426 //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
1428 // This is only called for mouse related events including
1429 // LFUN_FILE_OPEN generated by drag-and-drop.
1430 FuncRequest cmd = cmd0;
1432 Cursor old = cursor();
1434 cur.push(buffer_.inset());
1435 cur.selection() = d->cursor_.selection();
1437 // Either the inset under the cursor or the
1438 // surrounding Text will handle this event.
1440 // make sure we stay within the screen...
1441 cmd.y = min(max(cmd.y, -1), height_);
1443 if (cmd.action == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
1445 // Get inset under mouse, if there is one.
1446 Inset const * covering_inset =
1447 getCoveringInset(buffer_.text(), cmd.x, cmd.y);
1448 if (covering_inset == d->last_inset_)
1449 // Same inset, no need to do anything...
1452 bool need_redraw = false;
1453 // const_cast because of setMouseHover().
1454 Inset * inset = const_cast<Inset *>(covering_inset);
1456 // Remove the hint on the last hovered inset (if any).
1457 need_redraw |= d->last_inset_->setMouseHover(false);
1459 // Highlighted the newly hovered inset (if any).
1460 need_redraw |= inset->setMouseHover(true);
1461 d->last_inset_ = inset;
1465 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
1466 << cmd.x << ", " << cmd.y << ")");
1468 d->update_strategy_ = DecorationUpdate;
1470 // This event (moving without mouse click) is not passed further.
1471 // This should be changed if it is further utilized.
1476 // Build temporary cursor.
1477 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x, cmd.y);
1479 // Put anchor at the same position.
1482 // Try to dispatch to an non-editable inset near this position
1483 // via the temp cursor. If the inset wishes to change the real
1484 // cursor it has to do so explicitly by using
1485 // cur.bv().cursor() = cur; (or similar)
1487 inset->dispatch(cur, cmd);
1489 // Now dispatch to the temporary cursor. If the real cursor should
1490 // be modified, the inset's dispatch has to do so explicitly.
1491 if (!cur.result().dispatched())
1494 // Notify left insets
1497 bool badcursor = notifyCursorLeaves(old, cur);
1499 cursor().fixIfBroken();
1502 // Do we have a selection?
1503 theSelection().haveSelection(cursor().selection());
1505 // If the command has been dispatched,
1506 if (cur.result().dispatched() || cur.result().update())
1507 processUpdateFlags(cur.result().update());
1511 void BufferView::lfunScroll(FuncRequest const & cmd)
1513 string const scroll_type = cmd.getArg(0);
1514 int const scroll_step =
1515 (scroll_type == "line")? d->scrollbarParameters_.single_step
1516 : (scroll_type == "page")? d->scrollbarParameters_.page_step : 0;
1517 if (scroll_step == 0)
1519 string const scroll_quantity = cmd.getArg(1);
1520 if (scroll_quantity == "up")
1521 scrollUp(scroll_step);
1522 else if (scroll_quantity == "down")
1523 scrollDown(scroll_step);
1525 int const scroll_value = convert<int>(scroll_quantity);
1527 scroll(scroll_step * scroll_value);
1532 void BufferView::scroll(int y)
1541 void BufferView::scrollDown(int offset)
1543 Text * text = &buffer_.text();
1544 TextMetrics & tm = d->text_metrics_[text];
1545 int ymax = height_ + offset;
1547 pair<pit_type, ParagraphMetrics const *> last = tm.last();
1548 int bottom_pos = last.second->position() + last.second->descent();
1549 if (last.first + 1 == int(text->paragraphs().size())) {
1550 if (bottom_pos <= height_)
1552 offset = min(offset, bottom_pos - height_);
1555 if (bottom_pos > ymax)
1557 tm.newParMetricsDown();
1559 d->anchor_ypos_ -= offset;
1565 void BufferView::scrollUp(int offset)
1567 Text * text = &buffer_.text();
1568 TextMetrics & tm = d->text_metrics_[text];
1569 int ymin = - offset;
1571 pair<pit_type, ParagraphMetrics const *> first = tm.first();
1572 int top_pos = first.second->position() - first.second->ascent();
1573 if (first.first == 0) {
1576 offset = min(offset, - top_pos);
1581 tm.newParMetricsUp();
1583 d->anchor_ypos_ += offset;
1589 void BufferView::setCursorFromRow(int row)
1594 buffer_.texrow().getIdFromRow(row, tmpid, tmppos);
1596 d->cursor_.reset(buffer_.inset());
1598 buffer_.text().setCursor(d->cursor_, 0, 0);
1600 buffer_.text().setCursor(d->cursor_, buffer_.getParFromID(tmpid).pit(), tmppos);
1604 void BufferView::gotoLabel(docstring const & label)
1606 for (InsetIterator it = inset_iterator_begin(buffer_.inset()); it; ++it) {
1607 vector<docstring> labels;
1608 it->getLabelList(labels);
1609 if (std::find(labels.begin(), labels.end(), label) != labels.end()) {
1618 TextMetrics const & BufferView::textMetrics(Text const * t) const
1620 return const_cast<BufferView *>(this)->textMetrics(t);
1624 TextMetrics & BufferView::textMetrics(Text const * t)
1626 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
1627 if (tmc_it == d->text_metrics_.end()) {
1628 tmc_it = d->text_metrics_.insert(
1629 make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
1631 return tmc_it->second;
1635 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
1638 return textMetrics(t).parMetrics(pit);
1642 int BufferView::workHeight() const
1648 void BufferView::setCursor(DocIterator const & dit)
1650 size_t const n = dit.depth();
1651 for (size_t i = 0; i < n; ++i)
1652 dit[i].inset().edit(d->cursor_, true);
1654 d->cursor_.setCursor(dit);
1655 d->cursor_.selection() = false;
1659 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
1661 // Would be wrong to delete anything if we have a selection.
1662 if (cur.selection())
1665 bool need_anchor_change = false;
1666 bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
1667 need_anchor_change);
1669 if (need_anchor_change)
1677 updateLabels(buffer_);
1685 bool BufferView::mouseSetCursor(Cursor & cur, bool select)
1687 BOOST_ASSERT(&cur.bv() == this);
1690 // this event will clear selection so we save selection for
1691 // persistent selection
1692 cap::saveSelection(cursor());
1694 // Has the cursor just left the inset?
1695 bool badcursor = false;
1696 bool leftinset = (&d->cursor_.inset() != &cur.inset());
1698 d->cursor_.fixIfBroken();
1699 badcursor = notifyCursorLeaves(d->cursor_, cur);
1704 // FIXME: shift-mouse selection doesn't work well across insets.
1705 bool do_selection = select && &d->cursor_.anchor().inset() == &cur.inset();
1707 // do the dEPM magic if needed
1708 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
1709 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
1710 // the leftinset bool would not be necessary (badcursor instead).
1711 bool update = leftinset;
1712 if (!do_selection && !badcursor && d->cursor_.inTexted())
1713 update |= checkDepm(cur, d->cursor_);
1715 d->cursor_.setCursor(cur);
1716 d->cursor_.boundary(cur.boundary());
1718 d->cursor_.setSelection();
1720 d->cursor_.clearSelection();
1722 d->cursor_.finishUndo();
1723 d->cursor_.setCurrentFont();
1728 void BufferView::putSelectionAt(DocIterator const & cur,
1729 int length, bool backwards)
1731 d->cursor_.clearSelection();
1737 d->cursor_.pos() += length;
1738 d->cursor_.setSelection(d->cursor_, -length);
1740 d->cursor_.setSelection(d->cursor_, length);
1742 // Ensure a redraw happens in any case because the new selection could
1743 // possibly be on the same screen as the previous selection.
1744 processUpdateFlags(Update::Force | Update::FitCursor);
1748 Cursor & BufferView::cursor()
1754 Cursor const & BufferView::cursor() const
1760 pit_type BufferView::anchor_ref() const
1762 return d->anchor_pit_;
1766 bool BufferView::singleParUpdate()
1768 Text & buftext = buffer_.text();
1769 pit_type const bottom_pit = d->cursor_.bottom().pit();
1770 TextMetrics & tm = textMetrics(&buftext);
1771 int old_height = tm.parMetrics(bottom_pit).height();
1773 // make sure inline completion pointer is ok
1774 if (d->inlineCompletionPos.fixIfBroken())
1775 d->inlineCompletionPos = DocIterator();
1777 // In Single Paragraph mode, rebreak only
1778 // the (main text, not inset!) paragraph containing the cursor.
1779 // (if this paragraph contains insets etc., rebreaking will
1780 // recursively descend)
1781 tm.redoParagraph(bottom_pit);
1782 ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
1783 if (pm.height() != old_height)
1784 // Paragraph height has changed so we cannot proceed to
1785 // the singlePar optimisation.
1788 d->update_strategy_ = SingleParUpdate;
1790 LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
1791 << " y2: " << pm.position() + pm.descent()
1792 << " pit: " << bottom_pit
1793 << " singlepar: 1");
1798 void BufferView::updateMetrics()
1800 Text & buftext = buffer_.text();
1801 pit_type const npit = int(buftext.paragraphs().size());
1803 // Clear out the position cache in case of full screen redraw,
1804 d->coord_cache_.clear();
1806 // Clear out paragraph metrics to avoid having invalid metrics
1807 // in the cache from paragraphs not relayouted below
1808 // The complete text metrics will be redone.
1809 d->text_metrics_.clear();
1811 TextMetrics & tm = textMetrics(&buftext);
1813 // make sure inline completion pointer is ok
1814 if (d->inlineCompletionPos.fixIfBroken())
1815 d->inlineCompletionPos = DocIterator();
1817 if (d->anchor_pit_ >= npit)
1818 // The anchor pit must have been deleted...
1819 d->anchor_pit_ = npit - 1;
1821 // Rebreak anchor paragraph.
1822 tm.redoParagraph(d->anchor_pit_);
1823 ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
1826 if (d->anchor_pit_ == 0) {
1827 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
1829 // Complete buffer visible? Then it's easy.
1830 if (scrollRange == 0)
1831 d->anchor_ypos_ = anchor_pm.ascent();
1833 // FIXME: Some clever handling needed to show
1834 // the _first_ paragraph up to the top if the cursor is
1835 // in the first line.
1837 anchor_pm.setPosition(d->anchor_ypos_);
1839 LYXERR(Debug::PAINTING, "metrics: "
1840 << " anchor pit = " << d->anchor_pit_
1841 << " anchor ypos = " << d->anchor_ypos_);
1843 // Redo paragraphs above anchor if necessary.
1844 int y1 = d->anchor_ypos_ - anchor_pm.ascent();
1845 // We are now just above the anchor paragraph.
1846 pit_type pit1 = d->anchor_pit_ - 1;
1847 for (; pit1 >= 0 && y1 >= 0; --pit1) {
1848 tm.redoParagraph(pit1);
1849 ParagraphMetrics & pm = tm.par_metrics_[pit1];
1851 // Save the paragraph position in the cache.
1856 // Redo paragraphs below the anchor if necessary.
1857 int y2 = d->anchor_ypos_ + anchor_pm.descent();
1858 // We are now just below the anchor paragraph.
1859 pit_type pit2 = d->anchor_pit_ + 1;
1860 for (; pit2 < npit && y2 <= height_; ++pit2) {
1861 tm.redoParagraph(pit2);
1862 ParagraphMetrics & pm = tm.par_metrics_[pit2];
1864 // Save the paragraph position in the cache.
1869 LYXERR(Debug::PAINTING, "Metrics: "
1870 << " anchor pit = " << d->anchor_pit_
1871 << " anchor ypos = " << d->anchor_ypos_
1874 << " pit1 = " << pit1
1875 << " pit2 = " << pit2);
1877 d->update_strategy_ = FullScreenUpdate;
1879 if (lyxerr.debugging(Debug::WORKAREA)) {
1880 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
1881 d->coord_cache_.dump();
1886 void BufferView::insertLyXFile(FileName const & fname)
1888 BOOST_ASSERT(d->cursor_.inTexted());
1890 // Get absolute path of file and add ".lyx"
1891 // to the filename if necessary
1892 FileName filename = fileSearch(string(), fname.absFilename(), "lyx");
1894 docstring const disp_fn = makeDisplayPath(filename.absFilename());
1895 // emit message signal.
1896 message(bformat(_("Inserting document %1$s..."), disp_fn));
1899 Buffer buf("", false);
1900 if (buf.loadLyXFile(filename)) {
1901 ErrorList & el = buffer_.errorList("Parse");
1902 // Copy the inserted document error list into the current buffer one.
1903 el = buf.errorList("Parse");
1904 buffer_.undo().recordUndo(d->cursor_);
1905 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
1906 buf.params().documentClassPtr(), el);
1907 res = _("Document %1$s inserted.");
1909 res = _("Could not insert document %1$s");
1914 // emit message signal.
1915 message(bformat(res, disp_fn));
1916 buffer_.errors("Parse");
1920 Point BufferView::coordOffset(DocIterator const & dit, bool boundary) const
1926 // Addup contribution of nested insets, from inside to outside,
1927 // keeping the outer paragraph for a special handling below
1928 for (size_t i = dit.depth() - 1; i >= 1; --i) {
1929 CursorSlice const & sl = dit[i];
1933 // get relative position inside sl.inset()
1934 sl.inset().cursorPos(*this, sl, boundary && (i + 1 == dit.depth()), xx, yy);
1936 // Make relative position inside of the edited inset relative to sl.inset()
1940 // In case of an RTL inset, the edited inset will be positioned to the left
1943 bool boundary_i = boundary && i + 1 == dit.depth();
1944 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
1949 // remember width for the case that sl.inset() is positioned in an RTL inset
1950 if (i && dit[i - 1].text()) {
1951 // If this Inset is inside a Text Inset, retrieve the Dimension
1952 // from the containing text instead of using Inset::dimension() which
1953 // might not be implemented.
1954 // FIXME (Abdel 23/09/2007): this is a bit messy because of the
1955 // elimination of Inset::dim_ cache. This coordOffset() method needs
1956 // to be rewritten in light of the new design.
1957 Dimension const & dim = parMetrics(dit[i - 1].text(),
1958 dit[i - 1].pit()).insetDimension(&sl.inset());
1961 Dimension const dim = sl.inset().dimension(*this);
1965 //lyxerr << "Cursor::getPos, i: "
1966 // << i << " x: " << xx << " y: " << y << endl;
1969 // Add contribution of initial rows of outermost paragraph
1970 CursorSlice const & sl = dit[0];
1971 TextMetrics const & tm = textMetrics(sl.text());
1972 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
1973 BOOST_ASSERT(!pm.rows().empty());
1974 y -= pm.rows()[0].ascent();
1976 // FIXME: document this mess
1978 if (sl.pos() > 0 && dit.depth() == 1) {
1980 if (pos && boundary)
1982 // lyxerr << "coordOffset: boundary:" << boundary << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
1983 rend = pm.pos2row(pos);
1985 rend = pm.pos2row(sl.pos());
1987 size_t rend = pm.pos2row(sl.pos());
1989 for (size_t rit = 0; rit != rend; ++rit)
1990 y += pm.rows()[rit].height();
1991 y += pm.rows()[rend].ascent();
1993 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
1995 // Make relative position from the nested inset now bufferview absolute.
1996 int xx = bottom_tm.cursorX(dit.bottom(), boundary && dit.depth() == 1);
1999 // In the RTL case place the nested inset at the left of the cursor in
2000 // the outer paragraph
2001 bool boundary_1 = boundary && 1 == dit.depth();
2002 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
2010 Point BufferView::getPos(DocIterator const & dit, bool boundary) const
2012 CursorSlice const & bot = dit.bottom();
2013 TextMetrics const & tm = textMetrics(bot.text());
2014 if (!tm.contains(bot.pit()))
2015 return Point(-1, -1);
2017 Point p = coordOffset(dit, boundary); // offset from outer paragraph
2018 p.y_ += tm.parMetrics(bot.pit()).position();
2023 void BufferView::draw(frontend::Painter & pain)
2025 LYXERR(Debug::PAINTING, "\t\t*** START DRAWING ***");
2026 Text & text = buffer_.text();
2027 TextMetrics const & tm = d->text_metrics_[&text];
2028 int const y = tm.first().second->position();
2029 PainterInfo pi(this, pain);
2031 switch (d->update_strategy_) {
2033 case NoScreenUpdate:
2034 // If no screen painting is actually needed, only some the different
2035 // coordinates of insets and paragraphs needs to be updated.
2036 pi.full_repaint = true;
2037 pi.pain.setDrawingEnabled(false);
2041 case SingleParUpdate:
2042 pi.full_repaint = false;
2043 // In general, only the current row of the outermost paragraph
2044 // will be redrawn. Particular cases where selection spans
2045 // multiple paragraph are correctly detected in TextMetrics.
2049 case DecorationUpdate:
2050 // FIXME: We should also distinguish DecorationUpdate to avoid text
2051 // drawing if possible. This is not possible to do easily right now
2052 // because of the single backing pixmap.
2054 case FullScreenUpdate:
2055 // The whole screen, including insets, will be refreshed.
2056 pi.full_repaint = true;
2058 // Clear background.
2059 pain.fillRectangle(0, 0, width_, height_,
2060 buffer_.inset().backgroundColor());
2065 // and possibly grey out below
2066 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2067 int const y2 = lastpm.second->position() + lastpm.second->descent();
2069 pain.fillRectangle(0, y2, width_, height_ - y2, Color_bottomarea);
2072 LYXERR(Debug::PAINTING, "\n\t\t*** END DRAWING ***");
2074 // The scrollbar needs an update.
2077 // Normalize anchor for next time
2078 pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
2079 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2080 for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
2081 ParagraphMetrics const & pm = tm.parMetrics(pit);
2082 if (pm.position() + pm.descent() > 0) {
2083 d->anchor_pit_ = pit;
2084 d->anchor_ypos_ = pm.position();
2088 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
2089 << " anchor ypos = " << d->anchor_ypos_);
2093 void BufferView::message(docstring const & msg)
2096 d->gui_->message(msg);
2100 void BufferView::showDialog(string const & name)
2103 d->gui_->showDialog(name, string());
2107 void BufferView::showDialog(string const & name,
2108 string const & data, Inset * inset)
2111 d->gui_->showDialog(name, data, inset);
2115 void BufferView::updateDialog(string const & name, string const & data)
2118 d->gui_->updateDialog(name, data);
2122 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
2128 // FIXME: Move this out of BufferView again
2129 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
2131 if (!fname.isReadableFile()) {
2132 docstring const error = from_ascii(strerror(errno));
2133 docstring const file = makeDisplayPath(fname.absFilename(), 50);
2134 docstring const text =
2135 bformat(_("Could not read the specified document\n"
2136 "%1$s\ndue to the error: %2$s"), file, error);
2137 Alert::error(_("Could not read file"), text);
2141 if (!fname.isReadableFile()) {
2142 docstring const file = makeDisplayPath(fname.absFilename(), 50);
2143 docstring const text =
2144 bformat(_("%1$s\n is not readable."), file);
2145 Alert::error(_("Could not open file"), text);
2149 // FIXME UNICODE: We don't know the encoding of the file
2150 docstring file_content = fname.fileContents("UTF-8");
2151 if (file_content.empty()) {
2152 Alert::error(_("Reading not UTF-8 encoded file"),
2153 _("The file is not UTF-8 encoded.\n"
2154 "It will be read as local 8Bit-encoded.\n"
2155 "If this does not give the correct result\n"
2156 "then please change the encoding of the file\n"
2157 "to UTF-8 with a program other than LyX.\n"));
2158 file_content = fname.fileContents("local8bit");
2161 return normalize_c(file_content);
2165 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
2167 docstring const tmpstr = contentsOfPlaintextFile(f);
2172 Cursor & cur = cursor();
2173 cap::replaceSelection(cur);
2174 buffer_.undo().recordUndo(cur);
2176 cur.innerText()->insertStringAsParagraphs(cur, tmpstr);
2178 cur.innerText()->insertStringAsLines(cur, tmpstr);
2185 docstring const & BufferView::inlineCompletion() const
2187 return d->inlineCompletion;
2191 size_t const & BufferView::inlineCompletionUniqueChars() const
2193 return d->inlineCompletionUniqueChars;
2197 DocIterator const & BufferView::inlineCompletionPos() const
2199 return d->inlineCompletionPos;
2203 bool samePar(DocIterator const & a, DocIterator const & b)
2205 if (a.empty() && b.empty())
2207 if (a.empty() || b.empty())
2209 return &a.innerParagraph() == &b.innerParagraph();
2213 void BufferView::setInlineCompletion(Cursor & cur, DocIterator const & pos,
2214 docstring const & completion, size_t uniqueChars)
2216 uniqueChars = min(completion.size(), uniqueChars);
2217 bool changed = d->inlineCompletion != completion
2218 || d->inlineCompletionUniqueChars != uniqueChars;
2219 bool singlePar = true;
2220 d->inlineCompletion = completion;
2221 d->inlineCompletionUniqueChars = min(completion.size(), uniqueChars);
2223 //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
2226 DocIterator const & old = d->inlineCompletionPos;
2228 //lyxerr << "inlineCompletionPos changed" << std::endl;
2229 // old or pos are in another paragraph?
2230 if ((!samePar(cur, pos) && !pos.empty())
2231 || (!samePar(cur, old) && !old.empty())) {
2233 //lyxerr << "different paragraph" << std::endl;
2235 d->inlineCompletionPos = pos;
2240 if (singlePar && !(cur.disp_.update() & Update::Force))
2241 cur.updateFlags(cur.disp_.update() | Update::SinglePar);
2243 cur.updateFlags(cur.disp_.update() | Update::Force);