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 "ErrorList.h"
29 #include "FloatList.h"
30 #include "FuncRequest.h"
31 #include "FuncStatus.h"
33 #include "InsetIterator.h"
35 #include "LaTeXFeatures.h"
41 #include "MetricsInfo.h"
42 #include "Paragraph.h"
43 #include "paragraph_funcs.h"
44 #include "ParagraphParameters.h"
45 #include "ParIterator.h"
48 #include "TextClass.h"
49 #include "TextMetrics.h"
51 #include "TocBackend.h"
53 #include "WordLangTuple.h"
55 #include "insets/InsetBibtex.h"
56 #include "insets/InsetCommand.h" // ChangeRefs
57 #include "insets/InsetExternal.h"
58 #include "insets/InsetGraphics.h"
59 #include "insets/InsetRef.h"
60 #include "insets/InsetText.h"
62 #include "frontends/alert.h"
63 #include "frontends/Application.h"
64 #include "frontends/Delegates.h"
65 #include "frontends/FontMetrics.h"
66 #include "frontends/Painter.h"
67 #include "frontends/Selection.h"
69 #include "graphics/Previews.h"
71 #include "support/convert.h"
72 #include "support/debug.h"
73 #include "support/ExceptionMessage.h"
74 #include "support/filetools.h"
75 #include "support/gettext.h"
76 #include "support/lstrings.h"
77 #include "support/Package.h"
78 #include "support/types.h"
87 using namespace lyx::support;
91 namespace Alert = frontend::Alert;
95 /// Return an inset of this class if it exists at the current cursor position
97 T * getInsetByCode(Cursor const & cur, InsetCode code)
100 Inset * inset = it.nextInset();
101 if (inset && inset->lyxCode() == code)
102 return static_cast<T*>(inset);
107 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
110 bool findNextInset(DocIterator & dit, vector<InsetCode> const & codes,
111 docstring const & contents)
113 DocIterator tmpdit = dit;
116 Inset const * inset = tmpdit.nextInset();
118 && std::find(codes.begin(), codes.end(), inset->lyxCode()) != codes.end()
119 && (contents.empty() ||
120 static_cast<InsetCommand const *>(inset)->getFirstNonOptParam() == contents)) {
124 tmpdit.forwardInset();
131 /// Looks for next inset with one of the given codes.
132 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
136 DocIterator tmpdit = dit;
137 tmpdit.forwardInset();
142 Inset const * inset = tmpdit.nextInset();
144 && std::find(codes.begin(), codes.end(), inset->lyxCode()) != codes.end()) {
145 contents = static_cast<InsetCommand const *>(inset)->getFirstNonOptParam();
149 if (!findNextInset(tmpdit, codes, contents)) {
150 if (dit.depth() != 1 || dit.pit() != 0 || dit.pos() != 0) {
151 tmpdit = doc_iterator_begin(tmpdit.bottom().inset());
152 if (!findNextInset(tmpdit, codes, contents))
163 /// Looks for next inset with the given code
164 void findInset(DocIterator & dit, InsetCode code, bool same_content)
166 findInset(dit, vector<InsetCode>(1, code), same_content);
170 /// Moves cursor to the next inset with one of the given codes.
171 void gotoInset(BufferView * bv, vector<InsetCode> const & codes,
174 Cursor tmpcur = bv->cursor();
175 if (!findInset(tmpcur, codes, same_content)) {
176 bv->cursor().message(_("No more insets"));
180 tmpcur.clearSelection();
181 bv->setCursor(tmpcur);
186 /// Moves cursor to the next inset with given code.
187 void gotoInset(BufferView * bv, InsetCode code, bool same_content)
189 gotoInset(bv, vector<InsetCode>(1, code), same_content);
193 /// A map from a Text to the associated text metrics
194 typedef map<Text const *, TextMetrics> TextMetricsCache;
196 enum ScreenUpdateStrategy {
206 /////////////////////////////////////////////////////////////////////
210 /////////////////////////////////////////////////////////////////////
212 struct BufferView::Private
214 Private(BufferView & bv): wh_(0), cursor_(bv),
215 anchor_pit_(0), anchor_ypos_(0),
216 inlineCompletionUniqueChars_(0),
217 last_inset_(0), gui_(0)
221 ScrollbarParameters scrollbarParameters_;
223 ScreenUpdateStrategy update_strategy_;
225 CoordCache coord_cache_;
227 /// Estimated average par height for scrollbar.
229 /// this is used to handle XSelection events in the right manner.
238 pit_type anchor_pit_;
242 vector<int> par_height_;
245 DocIterator inlineCompletionPos_;
247 docstring inlineCompletion_;
249 size_t inlineCompletionUniqueChars_;
251 /// keyboard mapping object.
254 /// last visited inset.
255 /** kept to send setMouseHover(false).
256 * Not owned, so don't delete.
260 mutable TextMetricsCache text_metrics_;
263 /** Not owned, so don't delete.
265 frontend::GuiBufferViewDelegate * gui_;
267 /// Cache for Find Next
268 FuncRequest search_request_cache_;
272 BufferView::BufferView(Buffer & buf)
273 : width_(0), height_(0), full_screen_(false), buffer_(buf), d(new Private(*this))
275 d->xsel_cache_.set = false;
276 d->intl_.initKeyMapper(lyxrc.use_kbmap);
278 d->cursor_.push(buffer_.inset());
279 d->cursor_.resetAnchor();
280 d->cursor_.setCurrentFont();
282 if (graphics::Previews::status() != LyXRC::PREVIEW_OFF)
283 graphics::Previews::get().generateBufferPreviews(buffer_);
287 BufferView::~BufferView()
289 // current buffer is going to be switched-off, save cursor pos
290 // Ideally, the whole cursor stack should be saved, but session
291 // currently can only handle bottom (whole document) level pit and pos.
292 // That is to say, if a cursor is in a nested inset, it will be
293 // restore to the left of the top level inset.
294 LastFilePosSection::FilePos fp;
295 fp.pit = d->cursor_.bottom().pit();
296 fp.pos = d->cursor_.bottom().pos();
297 LyX::ref().session().lastFilePos().save(buffer_.fileName(), fp);
303 int BufferView::rightMargin() const
305 // The additional test for the case the outliner is opened.
307 !lyxrc.full_screen_limit ||
308 width_ < lyxrc.full_screen_width + 20)
311 return (width_ - lyxrc.full_screen_width) / 2;
315 int BufferView::leftMargin() const
317 return rightMargin();
321 bool BufferView::isTopScreen() const
323 return d->scrollbarParameters_.position == d->scrollbarParameters_.min;
327 bool BufferView::isBottomScreen() const
329 return d->scrollbarParameters_.position == d->scrollbarParameters_.max;
333 Intl & BufferView::getIntl()
339 Intl const & BufferView::getIntl() const
345 CoordCache & BufferView::coordCache()
347 return d->coord_cache_;
351 CoordCache const & BufferView::coordCache() const
353 return d->coord_cache_;
357 Buffer & BufferView::buffer()
363 Buffer const & BufferView::buffer() const
369 bool BufferView::fitCursor()
371 if (cursorStatus(d->cursor_) == CUR_INSIDE) {
372 frontend::FontMetrics const & fm =
373 theFontMetrics(d->cursor_.getFont().fontInfo());
374 int const asc = fm.maxAscent();
375 int const des = fm.maxDescent();
376 Point const p = getPos(d->cursor_, d->cursor_.boundary());
377 if (p.y_ - asc >= 0 && p.y_ + des < height_)
384 void BufferView::processUpdateFlags(Update::flags flags)
386 // last_inset_ points to the last visited inset. This pointer may become
387 // invalid because of keyboard editing. Since all such operations
388 // causes screen update(), I reset last_inset_ to avoid such a problem.
390 // This is close to a hot-path.
391 LYXERR(Debug::DEBUG, "BufferView::processUpdateFlags()"
392 << "[fitcursor = " << (flags & Update::FitCursor)
393 << ", forceupdate = " << (flags & Update::Force)
394 << ", singlepar = " << (flags & Update::SinglePar)
395 << "] buffer: " << &buffer_);
397 buffer_.updateMacros();
399 // Now do the first drawing step if needed. This consists on updating
400 // the CoordCache in updateMetrics().
401 // The second drawing step is done in WorkArea::redraw() if needed.
403 // Case when no explicit update is requested.
405 // no need to redraw anything.
406 d->update_strategy_ = NoScreenUpdate;
410 if (flags == Update::Decoration) {
411 d->update_strategy_ = DecorationUpdate;
416 if (flags == Update::FitCursor
417 || flags == (Update::Decoration | Update::FitCursor)) {
418 // tell the frontend to update the screen if needed.
423 if (flags & Update::Decoration) {
424 d->update_strategy_ = DecorationUpdate;
428 // no screen update is needed.
429 d->update_strategy_ = NoScreenUpdate;
433 bool const full_metrics = flags & Update::Force || !singleParUpdate();
436 // We have to update the full screen metrics.
439 if (!(flags & Update::FitCursor)) {
440 // Nothing to do anymore. Trigger a redraw and return
445 // updateMetrics() does not update paragraph position
446 // This is done at draw() time. So we need a redraw!
450 // The cursor is off screen so ensure it is visible.
457 void BufferView::updateScrollbar()
462 // We prefer fixed size line scrolling.
463 d->scrollbarParameters_.single_step = defaultRowHeight();
464 // We prefer full screen page scrolling.
465 d->scrollbarParameters_.page_step = height_;
467 Text & t = buffer_.text();
468 TextMetrics & tm = d->text_metrics_[&t];
470 LYXERR(Debug::GUI, " Updating scrollbar: height: "
471 << t.paragraphs().size()
472 << " curr par: " << d->cursor_.bottom().pit()
473 << " default height " << defaultRowHeight());
475 size_t const parsize = t.paragraphs().size();
476 if (d->par_height_.size() != parsize) {
477 d->par_height_.clear();
478 // FIXME: We assume a default paragraph height of 2 rows. This
479 // should probably be pondered with the screen width.
480 d->par_height_.resize(parsize, defaultRowHeight() * 2);
483 // Look at paragraph heights on-screen
484 pair<pit_type, ParagraphMetrics const *> first = tm.first();
485 pair<pit_type, ParagraphMetrics const *> last = tm.last();
486 for (pit_type pit = first.first; pit <= last.first; ++pit) {
487 d->par_height_[pit] = tm.parMetrics(pit).height();
488 LYXERR(Debug::SCROLLING, "storing height for pit " << pit << " : "
489 << d->par_height_[pit]);
492 int top_pos = first.second->position() - first.second->ascent();
493 int bottom_pos = last.second->position() + last.second->descent();
494 bool first_visible = first.first == 0 && top_pos >= 0;
495 bool last_visible = last.first + 1 == int(parsize) && bottom_pos <= height_;
496 if (first_visible && last_visible) {
497 d->scrollbarParameters_.min = 0;
498 d->scrollbarParameters_.max = 0;
502 d->scrollbarParameters_.min = top_pos;
503 for (size_t i = 0; i != size_t(first.first); ++i)
504 d->scrollbarParameters_.min -= d->par_height_[i];
505 d->scrollbarParameters_.max = bottom_pos;
506 for (size_t i = last.first + 1; i != parsize; ++i)
507 d->scrollbarParameters_.max += d->par_height_[i];
509 d->scrollbarParameters_.position = 0;
510 // The reference is the top position so we remove one page.
511 d->scrollbarParameters_.max -= d->scrollbarParameters_.page_step;
515 ScrollbarParameters const & BufferView::scrollbarParameters() const
517 return d->scrollbarParameters_;
521 docstring BufferView::toolTip(int x, int y) const
523 // Get inset under mouse, if there is one.
524 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
526 // No inset, no tooltip...
528 return covering_inset->toolTip(*this, x, y);
532 docstring BufferView::contextMenu(int x, int y) const
534 // Get inset under mouse, if there is one.
535 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
537 return covering_inset->contextMenu(*this, x, y);
539 return buffer_.inset().contextMenu(*this, x, y);
543 void BufferView::scrollDocView(int value)
545 int const offset = value - d->scrollbarParameters_.position;
546 // If the offset is less than 2 screen height, prefer to scroll instead.
547 if (abs(offset) <= 2 * height_) {
552 // cut off at the top
553 if (value <= d->scrollbarParameters_.min) {
554 DocIterator dit = doc_iterator_begin(buffer_.inset());
556 LYXERR(Debug::SCROLLING, "scroll to top");
560 // cut off at the bottom
561 if (value >= d->scrollbarParameters_.max) {
562 DocIterator dit = doc_iterator_end(buffer_.inset());
565 LYXERR(Debug::SCROLLING, "scroll to bottom");
569 // find paragraph at target position
570 int par_pos = d->scrollbarParameters_.min;
572 for (; i != int(d->par_height_.size()); ++i) {
573 par_pos += d->par_height_[i];
574 if (par_pos >= value)
578 if (par_pos < value) {
579 // It seems we didn't find the correct pit so stay on the safe side and
581 LYXERR0("scrolling position not found!");
582 scrollDocView(d->scrollbarParameters_.max);
586 DocIterator dit = doc_iterator_begin(buffer_.inset());
588 LYXERR(Debug::SCROLLING, "value = " << value << " -> scroll to pit " << i);
593 // FIXME: this method is not working well.
594 void BufferView::setCursorFromScrollbar()
596 TextMetrics & tm = d->text_metrics_[&buffer_.text()];
598 int const height = 2 * defaultRowHeight();
599 int const first = height;
600 int const last = height_ - height;
601 Cursor & cur = d->cursor_;
603 switch (cursorStatus(cur)) {
605 // We reset the cursor because cursorStatus() does not
606 // work when the cursor is within mathed.
607 cur.reset(buffer_.inset());
608 tm.setCursorFromCoordinates(cur, 0, first);
609 cur.clearSelection();
612 // We reset the cursor because cursorStatus() does not
613 // work when the cursor is within mathed.
614 cur.reset(buffer_.inset());
615 tm.setCursorFromCoordinates(cur, 0, last);
616 cur.clearSelection();
619 int const y = getPos(cur, cur.boundary()).y_;
620 int const newy = min(last, max(y, first));
622 cur.reset(buffer_.inset());
623 tm.setCursorFromCoordinates(cur, 0, newy);
629 Change const BufferView::getCurrentChange() const
631 if (!d->cursor_.selection())
632 return Change(Change::UNCHANGED);
634 DocIterator dit = d->cursor_.selectionBegin();
635 return dit.paragraph().lookupChange(dit.pos());
639 // this could be used elsewhere as well?
640 // FIXME: This does not work within mathed!
641 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
643 Point const p = getPos(dit, dit.boundary());
646 if (p.y_ > workHeight())
652 void BufferView::saveBookmark(unsigned int idx)
654 // tenatively save bookmark, id and pos will be used to
655 // acturately locate a bookmark in a 'live' lyx session.
656 // pit and pos will be updated with bottom level pit/pos
658 LyX::ref().session().bookmarks().save(
660 d->cursor_.bottom().pit(),
661 d->cursor_.bottom().pos(),
662 d->cursor_.paragraph().id(),
667 // emit message signal.
668 message(_("Save bookmark"));
672 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
673 int top_id, pos_type top_pos)
675 bool success = false;
678 d->cursor_.clearSelection();
680 // if a valid par_id is given, try it first
681 // This is the case for a 'live' bookmark when unique paragraph ID
682 // is used to track bookmarks.
684 dit = buffer_.getParFromID(top_id);
686 dit.pos() = min(dit.paragraph().size(), top_pos);
687 // Some slices of the iterator may not be
688 // reachable (e.g. closed collapsable inset)
689 // so the dociterator may need to be
690 // shortened. Otherwise, setCursor may crash
691 // lyx when the cursor can not be set to these
693 size_t const n = dit.depth();
694 for (size_t i = 0; i < n; ++i)
695 if (dit[i].inset().editable() != Inset::HIGHLY_EDITABLE) {
703 // if top_id == 0, or searching through top_id failed
704 // This is the case for a 'restored' bookmark when only bottom
705 // (document level) pit was saved. Because of this, bookmark
706 // restoration is inaccurate. If a bookmark was within an inset,
707 // it will be restored to the left of the outmost inset that contains
709 if (bottom_pit < int(buffer_.paragraphs().size())) {
710 dit = doc_iterator_begin(buffer_.inset());
712 dit.pit() = bottom_pit;
713 dit.pos() = min(bottom_pos, dit.paragraph().size());
718 // Note: only bottom (document) level pit is set.
720 // set the current font.
721 d->cursor_.setCurrentFont();
722 // To center the screen on this new position we need the
723 // paragraph position which is computed at draw() time.
724 // So we need a redraw!
734 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
736 if (lyxrc.rtl_support) {
737 if (d->cursor_.real_current_font.isRightToLeft()) {
738 if (d->intl_.keymap == Intl::PRIMARY)
739 d->intl_.keyMapSec();
741 if (d->intl_.keymap == Intl::SECONDARY)
742 d->intl_.keyMapPrim();
746 d->intl_.getTransManager().translateAndInsert(c, t, cur);
750 int BufferView::workWidth() const
756 void BufferView::showCursor()
758 showCursor(d->cursor_);
762 void BufferView::showCursor(DocIterator const & dit)
764 // We are not properly started yet, delay until resizing is
769 LYXERR(Debug::SCROLLING, "recentering!");
771 CursorSlice const & bot = dit.bottom();
772 TextMetrics & tm = d->text_metrics_[bot.text()];
774 pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
775 int bot_pit = bot.pit();
776 if (bot_pit > max_pit) {
777 // FIXME: Why does this happen?
778 LYXERR0("bottom pit is greater that max pit: "
779 << bot_pit << " > " << max_pit);
783 if (bot_pit == tm.first().first - 1)
784 tm.newParMetricsUp();
785 else if (bot_pit == tm.last().first + 1)
786 tm.newParMetricsDown();
788 if (tm.contains(bot_pit)) {
789 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
790 LASSERT(!pm.rows().empty(), /**/);
791 // FIXME: smooth scrolling doesn't work in mathed.
792 CursorSlice const & cs = dit.innerTextSlice();
793 int offset = coordOffset(dit, dit.boundary()).y_;
794 int ypos = pm.position() + offset;
795 Dimension const & row_dim =
796 pm.getRow(cs.pos(), dit.boundary()).dimension();
797 if (ypos - row_dim.ascent() < 0)
798 scrollUp(- ypos + row_dim.ascent());
799 else if (ypos + row_dim.descent() > height_)
800 scrollDown(ypos - height_ + row_dim.descent());
801 // else, nothing to do, the cursor is already visible so we just return.
805 // fix inline completion position
806 if (d->inlineCompletionPos_.fixIfBroken())
807 d->inlineCompletionPos_ = DocIterator();
809 tm.redoParagraph(bot_pit);
810 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
811 int offset = coordOffset(dit, dit.boundary()).y_;
813 d->anchor_pit_ = bot_pit;
814 CursorSlice const & cs = dit.innerTextSlice();
815 Dimension const & row_dim =
816 pm.getRow(cs.pos(), dit.boundary()).dimension();
818 if (d->anchor_pit_ == 0)
819 d->anchor_ypos_ = offset + pm.ascent();
820 else if (d->anchor_pit_ == max_pit)
821 d->anchor_ypos_ = height_ - offset - row_dim.descent();
823 d->anchor_ypos_ = defaultRowHeight() * 2 - offset - row_dim.descent();
830 FuncStatus BufferView::getStatus(FuncRequest const & cmd)
834 Cursor & cur = d->cursor_;
836 switch (cmd.action) {
839 flag.enabled(buffer_.undo().hasUndoStack());
842 flag.enabled(buffer_.undo().hasRedoStack());
844 case LFUN_FILE_INSERT:
845 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
846 case LFUN_FILE_INSERT_PLAINTEXT:
847 case LFUN_BOOKMARK_SAVE:
848 // FIXME: Actually, these LFUNS should be moved to Text
849 flag.enabled(cur.inTexted());
851 case LFUN_FONT_STATE:
852 case LFUN_LABEL_INSERT:
853 case LFUN_INFO_INSERT:
854 case LFUN_INSET_EDIT:
855 case LFUN_PARAGRAPH_GOTO:
857 case LFUN_REFERENCE_NEXT:
859 case LFUN_WORD_REPLACE:
862 case LFUN_MARK_TOGGLE:
863 case LFUN_SCREEN_RECENTER:
864 case LFUN_BIBTEX_DATABASE_ADD:
865 case LFUN_BIBTEX_DATABASE_DEL:
866 case LFUN_STATISTICS:
870 case LFUN_NEXT_INSET_TOGGLE: {
871 // this is the real function we want to invoke
872 FuncRequest tmpcmd = FuncRequest(LFUN_INSET_TOGGLE, cmd.argument());
873 // if there is an inset at cursor, see whether it
875 Inset * inset = cur.nextInset();
877 inset->getStatus(cur, tmpcmd, flag);
881 // if it did not work, try the underlying inset.
882 if (!inset || !cur.result().dispatched())
885 if (!cur.result().dispatched())
891 case LFUN_NEXT_INSET_MODIFY: {
892 // this is the real function we want to invoke
893 FuncRequest tmpcmd = FuncRequest(LFUN_INSET_MODIFY, cmd.argument());
894 // if there is an inset at cursor, see whether it
896 Inset * inset = cur.nextInset();
898 inset->getStatus(cur, tmpcmd, flag);
902 // if it did not work, try the underlying inset.
903 if (!inset || !cur.result().dispatched())
906 if (!cur.result().dispatched())
912 case LFUN_LABEL_GOTO: {
913 flag.enabled(!cmd.argument().empty()
914 || getInsetByCode<InsetRef>(cur, REF_CODE));
918 case LFUN_CHANGES_TRACK:
920 flag.setOnOff(buffer_.params().trackChanges);
923 case LFUN_CHANGES_OUTPUT:
925 flag.setOnOff(buffer_.params().outputChanges);
928 case LFUN_CHANGES_MERGE:
929 case LFUN_CHANGE_NEXT:
930 case LFUN_ALL_CHANGES_ACCEPT:
931 case LFUN_ALL_CHANGES_REJECT:
932 // TODO: context-sensitive enabling of LFUNs
933 // In principle, these command should only be enabled if there
934 // is a change in the document. However, without proper
935 // optimizations, this will inevitably result in poor performance.
939 case LFUN_BUFFER_TOGGLE_COMPRESSION: {
940 flag.setOnOff(buffer_.params().compressed);
945 case LFUN_SCREEN_DOWN:
947 case LFUN_SCREEN_UP_SELECT:
948 case LFUN_SCREEN_DOWN_SELECT:
952 case LFUN_LAYOUT_TABULAR:
953 flag.enabled(cur.innerInsetOfType(TABULAR_CODE));
957 flag.enabled(!cur.inset().forceEmptyLayout(cur.idx()));
960 case LFUN_LAYOUT_PARAGRAPH:
961 flag.enabled(cur.inset().allowParagraphCustomization(cur.idx()));
964 case LFUN_INSET_SETTINGS: {
965 InsetCode code = cur.inset().lyxCode();
967 code = cur.nextInset()->lyxCode();
978 enable = (cmd.argument().empty() ||
979 cmd.getArg(0) == insetName(code));
984 flag.enabled(enable);
988 case LFUN_DIALOG_SHOW_NEW_INSET:
989 flag.enabled(cur.inset().lyxCode() != ERT_CODE &&
990 cur.inset().lyxCode() != LISTINGS_CODE);
991 if (cur.inset().lyxCode() == CAPTION_CODE) {
993 if (cur.inset().getStatus(cur, cmd, flag))
1006 bool BufferView::dispatch(FuncRequest const & cmd)
1008 //lyxerr << [ cmd = " << cmd << "]" << endl;
1010 // Make sure that the cached BufferView is correct.
1011 LYXERR(Debug::ACTION, " action[" << cmd.action << ']'
1012 << " arg[" << to_utf8(cmd.argument()) << ']'
1013 << " x[" << cmd.x << ']'
1014 << " y[" << cmd.y << ']'
1015 << " button[" << cmd.button() << ']');
1017 Cursor & cur = d->cursor_;
1019 switch (cmd.action) {
1022 cur.message(_("Undo"));
1023 cur.clearSelection();
1024 if (!cur.textUndo())
1025 cur.message(_("No further undo information"));
1027 processUpdateFlags(Update::Force | Update::FitCursor);
1031 cur.message(_("Redo"));
1032 cur.clearSelection();
1033 if (!cur.textRedo())
1034 cur.message(_("No further redo information"));
1036 processUpdateFlags(Update::Force | Update::FitCursor);
1039 case LFUN_FONT_STATE:
1040 cur.message(cur.currentState());
1043 case LFUN_BOOKMARK_SAVE:
1044 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1047 case LFUN_LABEL_GOTO: {
1048 docstring label = cmd.argument();
1049 if (label.empty()) {
1051 getInsetByCode<InsetRef>(d->cursor_,
1054 label = inset->getParam("reference");
1055 // persistent=false: use temp_bookmark
1065 case LFUN_INSET_EDIT: {
1066 FuncRequest fr(cmd);
1067 // if there is an inset at cursor, see whether it
1069 Inset * inset = cur.nextInset();
1071 inset->dispatch(cur, fr);
1072 // if it did not work, try the underlying inset.
1073 if (!inset || !cur.result().dispatched())
1076 if (!cur.result().dispatched())
1077 // It did not work too; no action needed.
1081 case LFUN_PARAGRAPH_GOTO: {
1082 int const id = convert<int>(to_utf8(cmd.argument()));
1084 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1085 b = theBufferList().next(b)) {
1087 DocIterator dit = b->getParFromID(id);
1089 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1093 LYXERR(Debug::INFO, "Paragraph " << dit.paragraph().id()
1094 << " found in buffer `"
1095 << b->absFileName() << "'.");
1097 if (b == &buffer_) {
1100 processUpdateFlags(Update::Force | Update::FitCursor);
1102 // Switch to other buffer view and resend cmd
1103 theLyXFunc().dispatch(FuncRequest(
1104 LFUN_BUFFER_SWITCH, b->absFileName()));
1105 theLyXFunc().dispatch(cmd);
1112 case LFUN_NOTE_NEXT:
1113 gotoInset(this, NOTE_CODE, false);
1116 case LFUN_REFERENCE_NEXT: {
1117 vector<InsetCode> tmp;
1118 tmp.push_back(LABEL_CODE);
1119 tmp.push_back(REF_CODE);
1120 gotoInset(this, tmp, true);
1124 case LFUN_CHANGES_TRACK:
1125 buffer_.params().trackChanges = !buffer_.params().trackChanges;
1128 case LFUN_CHANGES_OUTPUT:
1129 buffer_.params().outputChanges = !buffer_.params().outputChanges;
1130 if (buffer_.params().outputChanges) {
1131 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1132 bool xcolorsoul = LaTeXFeatures::isAvailable("soul") &&
1133 LaTeXFeatures::isAvailable("xcolor");
1135 if (!dvipost && !xcolorsoul) {
1136 Alert::warning(_("Changes not shown in LaTeX output"),
1137 _("Changes will not be highlighted in LaTeX output, "
1138 "because neither dvipost nor xcolor/soul are installed.\n"
1139 "Please install these packages or redefine "
1140 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1141 } else if (!xcolorsoul) {
1142 Alert::warning(_("Changes not shown in LaTeX output"),
1143 _("Changes will not be highlighted in LaTeX output "
1144 "when using pdflatex, because xcolor and soul are not installed.\n"
1145 "Please install both packages or redefine "
1146 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1151 case LFUN_CHANGE_NEXT:
1152 findNextChange(this);
1155 case LFUN_CHANGES_MERGE:
1156 if (findNextChange(this))
1157 showDialog("changes");
1160 case LFUN_ALL_CHANGES_ACCEPT:
1161 // select complete document
1162 d->cursor_.reset(buffer_.inset());
1163 d->cursor_.selHandle(true);
1164 buffer_.text().cursorBottom(d->cursor_);
1165 // accept everything in a single step to support atomic undo
1166 buffer_.text().acceptOrRejectChanges(d->cursor_, Text::ACCEPT);
1169 case LFUN_ALL_CHANGES_REJECT:
1170 // select complete document
1171 d->cursor_.reset(buffer_.inset());
1172 d->cursor_.selHandle(true);
1173 buffer_.text().cursorBottom(d->cursor_);
1174 // reject everything in a single step to support atomic undo
1175 // Note: reject does not work recursively; the user may have to repeat the operation
1176 buffer_.text().acceptOrRejectChanges(d->cursor_, Text::REJECT);
1179 case LFUN_WORD_FIND: {
1180 FuncRequest req = cmd;
1181 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1182 req = d->search_request_cache_;
1183 if (find(this, req))
1186 message(_("String not found!"));
1187 d->search_request_cache_ = req;
1191 case LFUN_WORD_REPLACE: {
1192 bool has_deleted = false;
1193 if (cur.selection()) {
1194 DocIterator beg = cur.selectionBegin();
1195 DocIterator end = cur.selectionEnd();
1196 if (beg.pit() == end.pit()) {
1197 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1198 if (cur.paragraph().isDeleted(p))
1203 replace(this, cmd, has_deleted);
1208 cur.clearSelection();
1210 cur.message(from_utf8(N_("Mark off")));
1214 cur.clearSelection();
1217 cur.message(from_utf8(N_("Mark on")));
1220 case LFUN_MARK_TOGGLE:
1221 cur.clearSelection();
1224 cur.message(from_utf8(N_("Mark removed")));
1227 cur.message(from_utf8(N_("Mark set")));
1232 case LFUN_SCREEN_RECENTER:
1236 case LFUN_BIBTEX_DATABASE_ADD: {
1237 Cursor tmpcur = d->cursor_;
1238 findInset(tmpcur, BIBTEX_CODE, false);
1239 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1242 if (inset->addDatabase(cmd.argument()))
1243 buffer_.updateBibfilesCache();
1248 case LFUN_BIBTEX_DATABASE_DEL: {
1249 Cursor tmpcur = d->cursor_;
1250 findInset(tmpcur, BIBTEX_CODE, false);
1251 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1254 if (inset->delDatabase(cmd.argument()))
1255 buffer_.updateBibfilesCache();
1260 case LFUN_STATISTICS: {
1261 DocIterator from, to;
1262 if (cur.selection()) {
1263 from = cur.selectionBegin();
1264 to = cur.selectionEnd();
1266 from = doc_iterator_begin(buffer_.inset());
1267 to = doc_iterator_end(buffer_.inset());
1269 int const words = countWords(from, to);
1270 int const chars = countChars(from, to, false);
1271 int const chars_blanks = countChars(from, to, true);
1273 if (cur.selection())
1274 message = _("Statistics for the selection:");
1276 message = _("Statistics for the document:");
1279 message += bformat(_("%1$d words"), words);
1281 message += _("One word");
1283 if (chars_blanks != 1)
1284 message += bformat(_("%1$d characters (including blanks)"),
1287 message += _("One character (including blanks)");
1290 message += bformat(_("%1$d characters (excluding blanks)"),
1293 message += _("One character (excluding blanks)");
1295 Alert::information(_("Statistics"), message);
1299 case LFUN_BUFFER_TOGGLE_COMPRESSION:
1300 // turn compression on/off
1301 buffer_.params().compressed = !buffer_.params().compressed;
1304 case LFUN_NEXT_INSET_TOGGLE: {
1305 // this is the real function we want to invoke
1306 FuncRequest tmpcmd = FuncRequest(LFUN_INSET_TOGGLE, cmd.origin);
1307 // if there is an inset at cursor, see whether it
1309 Inset * inset = cur.nextInset();
1311 if (inset->isActive()) {
1312 Cursor tmpcur = cur;
1313 tmpcur.pushBackward(*inset);
1314 inset->dispatch(tmpcur, tmpcmd);
1315 if (tmpcur.result().dispatched()) {
1318 } else if (inset->editable() == Inset::IS_EDITABLE) {
1319 inset->edit(cur, true);
1322 // if it did not work, try the underlying inset.
1323 if (!inset || !cur.result().dispatched())
1324 cur.dispatch(tmpcmd);
1326 if (!cur.result().dispatched())
1327 // It did not work too; no action needed.
1329 cur.clearSelection();
1330 processUpdateFlags(Update::SinglePar | Update::FitCursor);
1334 case LFUN_NEXT_INSET_MODIFY: {
1335 // this is the real function we want to invoke
1336 FuncRequest tmpcmd = FuncRequest(LFUN_INSET_MODIFY, cmd.argument());
1337 // if there is an inset at cursor, see whether it
1339 Inset * inset = cur.nextInset();
1341 inset->dispatch(cur, tmpcmd);
1342 // if it did not work, try the underlying inset.
1343 if (!inset || !cur.result().dispatched())
1344 cur.dispatch(tmpcmd);
1346 if (!cur.result().dispatched())
1347 // It did not work too; no action needed.
1349 cur.clearSelection();
1350 processUpdateFlags(Update::Force | Update::FitCursor);
1354 case LFUN_SCREEN_UP:
1355 case LFUN_SCREEN_DOWN: {
1356 Point p = getPos(cur, cur.boundary());
1357 if (p.y_ < 0 || p.y_ > height_) {
1358 // The cursor is off-screen so recenter before proceeding.
1360 p = getPos(cur, cur.boundary());
1362 scroll(cmd.action == LFUN_SCREEN_UP? - height_ : height_);
1363 cur.reset(buffer_.inset());
1364 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_);
1365 //FIXME: what to do with cur.x_target()?
1374 case LFUN_SCREEN_UP_SELECT: {
1375 cur.selHandle(true);
1376 if (isTopScreen()) {
1377 lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1381 int y = getPos(cur, cur.boundary()).y_;
1382 int const ymin = y - height_ + defaultRowHeight();
1383 while (y > ymin && cur.up())
1384 y = getPos(cur, cur.boundary()).y_;
1387 processUpdateFlags(Update::SinglePar | Update::FitCursor);
1391 case LFUN_SCREEN_DOWN_SELECT: {
1392 cur.selHandle(true);
1393 if (isBottomScreen()) {
1394 lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1398 int y = getPos(cur, cur.boundary()).y_;
1399 int const ymax = y + height_ - defaultRowHeight();
1400 while (y < ymax && cur.down())
1401 y = getPos(cur, cur.boundary()).y_;
1404 processUpdateFlags(Update::SinglePar | Update::FitCursor);
1416 docstring const BufferView::requestSelection()
1418 Cursor & cur = d->cursor_;
1420 if (!cur.selection()) {
1421 d->xsel_cache_.set = false;
1425 if (!d->xsel_cache_.set ||
1426 cur.top() != d->xsel_cache_.cursor ||
1427 cur.anchor_.top() != d->xsel_cache_.anchor)
1429 d->xsel_cache_.cursor = cur.top();
1430 d->xsel_cache_.anchor = cur.anchor_.top();
1431 d->xsel_cache_.set = cur.selection();
1432 return cur.selectionAsString(false);
1438 void BufferView::clearSelection()
1440 d->cursor_.clearSelection();
1441 // Clear the selection buffer. Otherwise a subsequent
1442 // middle-mouse-button paste would use the selection buffer,
1443 // not the more current external selection.
1444 cap::clearSelection();
1445 d->xsel_cache_.set = false;
1446 // The buffer did not really change, but this causes the
1447 // redraw we need because we cleared the selection above.
1452 void BufferView::resize(int width, int height)
1454 // Update from work area
1458 // Clear the paragraph height cache.
1459 d->par_height_.clear();
1460 // Redo the metrics.
1465 Inset const * BufferView::getCoveringInset(Text const & text,
1468 TextMetrics & tm = d->text_metrics_[&text];
1469 Inset * inset = tm.checkInsetHit(x, y);
1473 if (!inset->descendable())
1474 // No need to go further down if the inset is not
1478 size_t cell_number = inset->nargs();
1479 // Check all the inner cell.
1480 for (size_t i = 0; i != cell_number; ++i) {
1481 Text const * inner_text = inset->getText(i);
1484 Inset const * inset_deeper =
1485 getCoveringInset(*inner_text, x, y);
1487 return inset_deeper;
1495 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
1497 //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
1499 // This is only called for mouse related events including
1500 // LFUN_FILE_OPEN generated by drag-and-drop.
1501 FuncRequest cmd = cmd0;
1503 Cursor old = cursor();
1505 cur.push(buffer_.inset());
1506 cur.selection() = d->cursor_.selection();
1508 // Either the inset under the cursor or the
1509 // surrounding Text will handle this event.
1511 // make sure we stay within the screen...
1512 cmd.y = min(max(cmd.y, -1), height_);
1514 if (cmd.action == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
1516 // Get inset under mouse, if there is one.
1517 Inset const * covering_inset =
1518 getCoveringInset(buffer_.text(), cmd.x, cmd.y);
1519 if (covering_inset == d->last_inset_)
1520 // Same inset, no need to do anything...
1523 bool need_redraw = false;
1524 // const_cast because of setMouseHover().
1525 Inset * inset = const_cast<Inset *>(covering_inset);
1527 // Remove the hint on the last hovered inset (if any).
1528 need_redraw |= d->last_inset_->setMouseHover(false);
1530 // Highlighted the newly hovered inset (if any).
1531 need_redraw |= inset->setMouseHover(true);
1532 d->last_inset_ = inset;
1536 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
1537 << cmd.x << ", " << cmd.y << ")");
1539 d->update_strategy_ = DecorationUpdate;
1541 // This event (moving without mouse click) is not passed further.
1542 // This should be changed if it is further utilized.
1547 // Build temporary cursor.
1548 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x, cmd.y);
1550 // Put anchor at the same position.
1553 // Try to dispatch to an non-editable inset near this position
1554 // via the temp cursor. If the inset wishes to change the real
1555 // cursor it has to do so explicitly by using
1556 // cur.bv().cursor() = cur; (or similar)
1558 inset->dispatch(cur, cmd);
1560 // Now dispatch to the temporary cursor. If the real cursor should
1561 // be modified, the inset's dispatch has to do so explicitly.
1562 if (!inset || !cur.result().dispatched())
1565 // Notify left insets
1568 bool badcursor = notifyCursorLeaves(old, cur);
1570 cursor().fixIfBroken();
1573 // Do we have a selection?
1574 theSelection().haveSelection(cursor().selection());
1576 // If the command has been dispatched,
1577 if (cur.result().dispatched() || cur.result().update())
1578 processUpdateFlags(cur.result().update());
1582 void BufferView::lfunScroll(FuncRequest const & cmd)
1584 string const scroll_type = cmd.getArg(0);
1585 int const scroll_step =
1586 (scroll_type == "line") ? d->scrollbarParameters_.single_step
1587 : (scroll_type == "page") ? d->scrollbarParameters_.page_step : 0;
1588 if (scroll_step == 0)
1590 string const scroll_quantity = cmd.getArg(1);
1591 if (scroll_quantity == "up")
1592 scrollUp(scroll_step);
1593 else if (scroll_quantity == "down")
1594 scrollDown(scroll_step);
1596 int const scroll_value = convert<int>(scroll_quantity);
1598 scroll(scroll_step * scroll_value);
1603 void BufferView::scroll(int y)
1612 void BufferView::scrollDown(int offset)
1614 Text * text = &buffer_.text();
1615 TextMetrics & tm = d->text_metrics_[text];
1616 int ymax = height_ + offset;
1618 pair<pit_type, ParagraphMetrics const *> last = tm.last();
1619 int bottom_pos = last.second->position() + last.second->descent();
1620 if (last.first + 1 == int(text->paragraphs().size())) {
1621 if (bottom_pos <= height_)
1623 offset = min(offset, bottom_pos - height_);
1626 if (bottom_pos > ymax)
1628 tm.newParMetricsDown();
1630 d->anchor_ypos_ -= offset;
1636 void BufferView::scrollUp(int offset)
1638 Text * text = &buffer_.text();
1639 TextMetrics & tm = d->text_metrics_[text];
1640 int ymin = - offset;
1642 pair<pit_type, ParagraphMetrics const *> first = tm.first();
1643 int top_pos = first.second->position() - first.second->ascent();
1644 if (first.first == 0) {
1647 offset = min(offset, - top_pos);
1652 tm.newParMetricsUp();
1654 d->anchor_ypos_ += offset;
1660 void BufferView::setCursorFromRow(int row)
1665 buffer_.texrow().getIdFromRow(row, tmpid, tmppos);
1667 d->cursor_.reset(buffer_.inset());
1669 buffer_.text().setCursor(d->cursor_, 0, 0);
1671 buffer_.text().setCursor(d->cursor_, buffer_.getParFromID(tmpid).pit(), tmppos);
1675 void BufferView::gotoLabel(docstring const & label)
1677 Toc & toc = buffer().tocBackend().toc("label");
1678 TocIterator toc_it = toc.begin();
1679 TocIterator end = toc.end();
1680 for (; toc_it != end; ++toc_it) {
1681 if (label == toc_it->str())
1682 dispatch(toc_it->action());
1684 //FIXME: We could do a bit more searching thanks to this:
1685 //InsetLabel const * inset = buffer_.insetLabel(label);
1689 TextMetrics const & BufferView::textMetrics(Text const * t) const
1691 return const_cast<BufferView *>(this)->textMetrics(t);
1695 TextMetrics & BufferView::textMetrics(Text const * t)
1697 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
1698 if (tmc_it == d->text_metrics_.end()) {
1699 tmc_it = d->text_metrics_.insert(
1700 make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
1702 return tmc_it->second;
1706 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
1709 return textMetrics(t).parMetrics(pit);
1713 int BufferView::workHeight() const
1719 void BufferView::setCursor(DocIterator const & dit)
1721 size_t const n = dit.depth();
1722 for (size_t i = 0; i < n; ++i)
1723 dit[i].inset().edit(d->cursor_, true);
1725 d->cursor_.setCursor(dit);
1726 d->cursor_.selection() = false;
1730 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
1732 // Would be wrong to delete anything if we have a selection.
1733 if (cur.selection())
1736 bool need_anchor_change = false;
1737 bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
1738 need_anchor_change);
1740 if (need_anchor_change)
1748 updateLabels(buffer_);
1756 bool BufferView::mouseSetCursor(Cursor & cur, bool select)
1758 LASSERT(&cur.bv() == this, /**/);
1761 // this event will clear selection so we save selection for
1762 // persistent selection
1763 cap::saveSelection(cursor());
1765 // Has the cursor just left the inset?
1766 bool badcursor = false;
1767 bool leftinset = (&d->cursor_.inset() != &cur.inset());
1769 d->cursor_.fixIfBroken();
1770 badcursor = notifyCursorLeaves(d->cursor_, cur);
1775 // FIXME: shift-mouse selection doesn't work well across insets.
1776 bool do_selection = select && &d->cursor_.anchor().inset() == &cur.inset();
1778 // do the dEPM magic if needed
1779 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
1780 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
1781 // the leftinset bool would not be necessary (badcursor instead).
1782 bool update = leftinset;
1783 if (!do_selection && !badcursor && d->cursor_.inTexted())
1784 update |= checkDepm(cur, d->cursor_);
1786 d->cursor_.setCursor(cur);
1787 d->cursor_.boundary(cur.boundary());
1789 d->cursor_.setSelection();
1791 d->cursor_.clearSelection();
1793 d->cursor_.finishUndo();
1794 d->cursor_.setCurrentFont();
1799 void BufferView::putSelectionAt(DocIterator const & cur,
1800 int length, bool backwards)
1802 d->cursor_.clearSelection();
1808 d->cursor_.pos() += length;
1809 d->cursor_.setSelection(d->cursor_, -length);
1811 d->cursor_.setSelection(d->cursor_, length);
1813 // Ensure a redraw happens in any case because the new selection could
1814 // possibly be on the same screen as the previous selection.
1815 processUpdateFlags(Update::Force | Update::FitCursor);
1819 Cursor & BufferView::cursor()
1825 Cursor const & BufferView::cursor() const
1831 pit_type BufferView::anchor_ref() const
1833 return d->anchor_pit_;
1837 bool BufferView::singleParUpdate()
1839 Text & buftext = buffer_.text();
1840 pit_type const bottom_pit = d->cursor_.bottom().pit();
1841 TextMetrics & tm = textMetrics(&buftext);
1842 int old_height = tm.parMetrics(bottom_pit).height();
1844 // make sure inline completion pointer is ok
1845 if (d->inlineCompletionPos_.fixIfBroken())
1846 d->inlineCompletionPos_ = DocIterator();
1848 // In Single Paragraph mode, rebreak only
1849 // the (main text, not inset!) paragraph containing the cursor.
1850 // (if this paragraph contains insets etc., rebreaking will
1851 // recursively descend)
1852 tm.redoParagraph(bottom_pit);
1853 ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
1854 if (pm.height() != old_height)
1855 // Paragraph height has changed so we cannot proceed to
1856 // the singlePar optimisation.
1859 d->update_strategy_ = SingleParUpdate;
1861 LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
1862 << " y2: " << pm.position() + pm.descent()
1863 << " pit: " << bottom_pit
1864 << " singlepar: 1");
1869 void BufferView::updateMetrics()
1871 Text & buftext = buffer_.text();
1872 pit_type const npit = int(buftext.paragraphs().size());
1874 // Clear out the position cache in case of full screen redraw,
1875 d->coord_cache_.clear();
1877 // Clear out paragraph metrics to avoid having invalid metrics
1878 // in the cache from paragraphs not relayouted below
1879 // The complete text metrics will be redone.
1880 d->text_metrics_.clear();
1882 TextMetrics & tm = textMetrics(&buftext);
1884 // make sure inline completion pointer is ok
1885 if (d->inlineCompletionPos_.fixIfBroken())
1886 d->inlineCompletionPos_ = DocIterator();
1888 if (d->anchor_pit_ >= npit)
1889 // The anchor pit must have been deleted...
1890 d->anchor_pit_ = npit - 1;
1892 // Rebreak anchor paragraph.
1893 tm.redoParagraph(d->anchor_pit_);
1894 ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
1897 if (d->anchor_pit_ == 0) {
1898 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
1900 // Complete buffer visible? Then it's easy.
1901 if (scrollRange == 0)
1902 d->anchor_ypos_ = anchor_pm.ascent();
1904 // FIXME: Some clever handling needed to show
1905 // the _first_ paragraph up to the top if the cursor is
1906 // in the first line.
1908 anchor_pm.setPosition(d->anchor_ypos_);
1910 LYXERR(Debug::PAINTING, "metrics: "
1911 << " anchor pit = " << d->anchor_pit_
1912 << " anchor ypos = " << d->anchor_ypos_);
1914 // Redo paragraphs above anchor if necessary.
1915 int y1 = d->anchor_ypos_ - anchor_pm.ascent();
1916 // We are now just above the anchor paragraph.
1917 pit_type pit1 = d->anchor_pit_ - 1;
1918 for (; pit1 >= 0 && y1 >= 0; --pit1) {
1919 tm.redoParagraph(pit1);
1920 ParagraphMetrics & pm = tm.par_metrics_[pit1];
1922 // Save the paragraph position in the cache.
1927 // Redo paragraphs below the anchor if necessary.
1928 int y2 = d->anchor_ypos_ + anchor_pm.descent();
1929 // We are now just below the anchor paragraph.
1930 pit_type pit2 = d->anchor_pit_ + 1;
1931 for (; pit2 < npit && y2 <= height_; ++pit2) {
1932 tm.redoParagraph(pit2);
1933 ParagraphMetrics & pm = tm.par_metrics_[pit2];
1935 // Save the paragraph position in the cache.
1940 LYXERR(Debug::PAINTING, "Metrics: "
1941 << " anchor pit = " << d->anchor_pit_
1942 << " anchor ypos = " << d->anchor_ypos_
1945 << " pit1 = " << pit1
1946 << " pit2 = " << pit2);
1948 d->update_strategy_ = FullScreenUpdate;
1950 if (lyxerr.debugging(Debug::WORKAREA)) {
1951 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
1952 d->coord_cache_.dump();
1957 void BufferView::insertLyXFile(FileName const & fname)
1959 LASSERT(d->cursor_.inTexted(), /**/);
1961 // Get absolute path of file and add ".lyx"
1962 // to the filename if necessary
1963 FileName filename = fileSearch(string(), fname.absFilename(), "lyx");
1965 docstring const disp_fn = makeDisplayPath(filename.absFilename());
1966 // emit message signal.
1967 message(bformat(_("Inserting document %1$s..."), disp_fn));
1970 Buffer buf("", false);
1971 if (buf.loadLyXFile(filename)) {
1972 ErrorList & el = buffer_.errorList("Parse");
1973 // Copy the inserted document error list into the current buffer one.
1974 el = buf.errorList("Parse");
1975 buffer_.undo().recordUndo(d->cursor_);
1976 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
1977 buf.params().documentClassPtr(), el);
1978 res = _("Document %1$s inserted.");
1980 res = _("Could not insert document %1$s");
1985 // emit message signal.
1986 message(bformat(res, disp_fn));
1987 buffer_.errors("Parse");
1991 Point BufferView::coordOffset(DocIterator const & dit, bool boundary) const
1997 // Addup contribution of nested insets, from inside to outside,
1998 // keeping the outer paragraph for a special handling below
1999 for (size_t i = dit.depth() - 1; i >= 1; --i) {
2000 CursorSlice const & sl = dit[i];
2004 // get relative position inside sl.inset()
2005 sl.inset().cursorPos(*this, sl, boundary && (i + 1 == dit.depth()), xx, yy);
2007 // Make relative position inside of the edited inset relative to sl.inset()
2011 // In case of an RTL inset, the edited inset will be positioned to the left
2014 bool boundary_i = boundary && i + 1 == dit.depth();
2015 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2020 // remember width for the case that sl.inset() is positioned in an RTL inset
2021 if (i && dit[i - 1].text()) {
2022 // If this Inset is inside a Text Inset, retrieve the Dimension
2023 // from the containing text instead of using Inset::dimension() which
2024 // might not be implemented.
2025 // FIXME (Abdel 23/09/2007): this is a bit messy because of the
2026 // elimination of Inset::dim_ cache. This coordOffset() method needs
2027 // to be rewritten in light of the new design.
2028 Dimension const & dim = parMetrics(dit[i - 1].text(),
2029 dit[i - 1].pit()).insetDimension(&sl.inset());
2032 Dimension const dim = sl.inset().dimension(*this);
2036 //lyxerr << "Cursor::getPos, i: "
2037 // << i << " x: " << xx << " y: " << y << endl;
2040 // Add contribution of initial rows of outermost paragraph
2041 CursorSlice const & sl = dit[0];
2042 TextMetrics const & tm = textMetrics(sl.text());
2043 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2044 LASSERT(!pm.rows().empty(), /**/);
2045 y -= pm.rows()[0].ascent();
2047 // FIXME: document this mess
2049 if (sl.pos() > 0 && dit.depth() == 1) {
2051 if (pos && boundary)
2053 // lyxerr << "coordOffset: boundary:" << boundary << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
2054 rend = pm.pos2row(pos);
2056 rend = pm.pos2row(sl.pos());
2058 size_t rend = pm.pos2row(sl.pos());
2060 for (size_t rit = 0; rit != rend; ++rit)
2061 y += pm.rows()[rit].height();
2062 y += pm.rows()[rend].ascent();
2064 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
2066 // Make relative position from the nested inset now bufferview absolute.
2067 int xx = bottom_tm.cursorX(dit.bottom(), boundary && dit.depth() == 1);
2070 // In the RTL case place the nested inset at the left of the cursor in
2071 // the outer paragraph
2072 bool boundary_1 = boundary && 1 == dit.depth();
2073 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
2081 Point BufferView::getPos(DocIterator const & dit, bool boundary) const
2083 CursorSlice const & bot = dit.bottom();
2084 TextMetrics const & tm = textMetrics(bot.text());
2085 if (!tm.contains(bot.pit()))
2086 return Point(-1, -1);
2088 Point p = coordOffset(dit, boundary); // offset from outer paragraph
2089 p.y_ += tm.parMetrics(bot.pit()).position();
2094 void BufferView::draw(frontend::Painter & pain)
2096 LYXERR(Debug::PAINTING, "\t\t*** START DRAWING ***");
2097 Text & text = buffer_.text();
2098 TextMetrics const & tm = d->text_metrics_[&text];
2099 int const y = tm.first().second->position();
2100 PainterInfo pi(this, pain);
2102 switch (d->update_strategy_) {
2104 case NoScreenUpdate:
2105 // If no screen painting is actually needed, only some the different
2106 // coordinates of insets and paragraphs needs to be updated.
2107 pi.full_repaint = true;
2108 pi.pain.setDrawingEnabled(false);
2112 case SingleParUpdate:
2113 pi.full_repaint = false;
2114 // In general, only the current row of the outermost paragraph
2115 // will be redrawn. Particular cases where selection spans
2116 // multiple paragraph are correctly detected in TextMetrics.
2120 case DecorationUpdate:
2121 // FIXME: We should also distinguish DecorationUpdate to avoid text
2122 // drawing if possible. This is not possible to do easily right now
2123 // because of the single backing pixmap.
2125 case FullScreenUpdate:
2126 // The whole screen, including insets, will be refreshed.
2127 pi.full_repaint = true;
2129 // Clear background.
2130 pain.fillRectangle(0, 0, width_, height_,
2131 buffer_.inset().backgroundColor());
2136 // and possibly grey out below
2137 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2138 int const y2 = lastpm.second->position() + lastpm.second->descent();
2140 pain.fillRectangle(0, y2, width_, height_ - y2, Color_bottomarea);
2143 LYXERR(Debug::PAINTING, "\n\t\t*** END DRAWING ***");
2145 // The scrollbar needs an update.
2148 // Normalize anchor for next time
2149 pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
2150 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2151 for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
2152 ParagraphMetrics const & pm = tm.parMetrics(pit);
2153 if (pm.position() + pm.descent() > 0) {
2154 d->anchor_pit_ = pit;
2155 d->anchor_ypos_ = pm.position();
2159 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
2160 << " anchor ypos = " << d->anchor_ypos_);
2164 void BufferView::message(docstring const & msg)
2167 d->gui_->message(msg);
2171 void BufferView::showDialog(string const & name)
2174 d->gui_->showDialog(name, string());
2178 void BufferView::showDialog(string const & name,
2179 string const & data, Inset * inset)
2182 d->gui_->showDialog(name, data, inset);
2186 void BufferView::updateDialog(string const & name, string const & data)
2189 d->gui_->updateDialog(name, data);
2193 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
2199 // FIXME: Move this out of BufferView again
2200 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
2202 if (!fname.isReadableFile()) {
2203 docstring const error = from_ascii(strerror(errno));
2204 docstring const file = makeDisplayPath(fname.absFilename(), 50);
2205 docstring const text =
2206 bformat(_("Could not read the specified document\n"
2207 "%1$s\ndue to the error: %2$s"), file, error);
2208 Alert::error(_("Could not read file"), text);
2212 if (!fname.isReadableFile()) {
2213 docstring const file = makeDisplayPath(fname.absFilename(), 50);
2214 docstring const text =
2215 bformat(_("%1$s\n is not readable."), file);
2216 Alert::error(_("Could not open file"), text);
2220 // FIXME UNICODE: We don't know the encoding of the file
2221 docstring file_content = fname.fileContents("UTF-8");
2222 if (file_content.empty()) {
2223 Alert::error(_("Reading not UTF-8 encoded file"),
2224 _("The file is not UTF-8 encoded.\n"
2225 "It will be read as local 8Bit-encoded.\n"
2226 "If this does not give the correct result\n"
2227 "then please change the encoding of the file\n"
2228 "to UTF-8 with a program other than LyX.\n"));
2229 file_content = fname.fileContents("local8bit");
2232 return normalize_c(file_content);
2236 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
2238 docstring const tmpstr = contentsOfPlaintextFile(f);
2243 Cursor & cur = cursor();
2244 cap::replaceSelection(cur);
2245 buffer_.undo().recordUndo(cur);
2247 cur.innerText()->insertStringAsParagraphs(cur, tmpstr);
2249 cur.innerText()->insertStringAsLines(cur, tmpstr);
2256 docstring const & BufferView::inlineCompletion() const
2258 return d->inlineCompletion_;
2262 size_t const & BufferView::inlineCompletionUniqueChars() const
2264 return d->inlineCompletionUniqueChars_;
2268 DocIterator const & BufferView::inlineCompletionPos() const
2270 return d->inlineCompletionPos_;
2274 bool samePar(DocIterator const & a, DocIterator const & b)
2276 if (a.empty() && b.empty())
2278 if (a.empty() || b.empty())
2280 return &a.innerParagraph() == &b.innerParagraph();
2284 void BufferView::setInlineCompletion(Cursor & cur, DocIterator const & pos,
2285 docstring const & completion, size_t uniqueChars)
2287 uniqueChars = min(completion.size(), uniqueChars);
2288 bool changed = d->inlineCompletion_ != completion
2289 || d->inlineCompletionUniqueChars_ != uniqueChars;
2290 bool singlePar = true;
2291 d->inlineCompletion_ = completion;
2292 d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
2294 //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
2297 DocIterator const & old = d->inlineCompletionPos_;
2299 //lyxerr << "inlineCompletionPos changed" << std::endl;
2300 // old or pos are in another paragraph?
2301 if ((!samePar(cur, pos) && !pos.empty())
2302 || (!samePar(cur, old) && !old.empty())) {
2304 //lyxerr << "different paragraph" << std::endl;
2306 d->inlineCompletionPos_ = pos;
2311 if (singlePar && !(cur.disp_.update() & Update::Force))
2312 cur.updateFlags(cur.disp_.update() | Update::SinglePar);
2314 cur.updateFlags(cur.disp_.update() | Update::Force);