3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Alfredo Braunstein
7 * \author Lars Gullik Bjønnes
10 * \author Jürgen Vigna
12 * Full author contact details are available in file CREDITS.
17 #include "BufferView.h"
19 #include "BranchList.h"
21 #include "buffer_funcs.h"
22 #include "BufferList.h"
23 #include "BufferParams.h"
24 #include "CoordCache.h"
26 #include "CutAndPaste.h"
27 #include "DispatchResult.h"
28 #include "ErrorList.h"
30 #include "FloatList.h"
31 #include "FuncRequest.h"
32 #include "FuncStatus.h"
34 #include "InsetIterator.h"
36 #include "LaTeXFeatures.h"
42 #include "MetricsInfo.h"
43 #include "Paragraph.h"
44 #include "paragraph_funcs.h"
45 #include "ParagraphParameters.h"
46 #include "ParIterator.h"
49 #include "TextClass.h"
50 #include "TextMetrics.h"
52 #include "TocBackend.h"
54 #include "WordLangTuple.h"
56 #include "insets/InsetBibtex.h"
57 #include "insets/InsetCommand.h" // ChangeRefs
58 #include "insets/InsetExternal.h"
59 #include "insets/InsetGraphics.h"
60 #include "insets/InsetRef.h"
61 #include "insets/InsetText.h"
63 #include "frontends/alert.h"
64 #include "frontends/Application.h"
65 #include "frontends/Delegates.h"
66 #include "frontends/FontMetrics.h"
67 #include "frontends/Painter.h"
68 #include "frontends/Selection.h"
70 #include "graphics/Previews.h"
72 #include "support/convert.h"
73 #include "support/debug.h"
74 #include "support/ExceptionMessage.h"
75 #include "support/filetools.h"
76 #include "support/gettext.h"
77 #include "support/lstrings.h"
78 #include "support/Package.h"
79 #include "support/types.h"
88 using namespace lyx::support;
92 namespace Alert = frontend::Alert;
96 /// Return an inset of this class if it exists at the current cursor position
98 T * getInsetByCode(Cursor const & cur, InsetCode code)
100 DocIterator it = cur;
101 Inset * inset = it.nextInset();
102 if (inset && inset->lyxCode() == code)
103 return static_cast<T*>(inset);
108 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
111 bool findNextInset(DocIterator & dit, vector<InsetCode> const & codes,
112 docstring const & contents)
114 DocIterator tmpdit = dit;
117 Inset const * inset = tmpdit.nextInset();
119 && std::find(codes.begin(), codes.end(), inset->lyxCode()) != codes.end()
120 && (contents.empty() ||
121 static_cast<InsetCommand const *>(inset)->getFirstNonOptParam() == contents)) {
125 tmpdit.forwardInset();
132 /// Looks for next inset with one of the given codes.
133 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
137 DocIterator tmpdit = dit;
138 tmpdit.forwardInset();
143 Inset const * inset = tmpdit.nextInset();
145 && std::find(codes.begin(), codes.end(), inset->lyxCode()) != codes.end()) {
146 contents = static_cast<InsetCommand const *>(inset)->getFirstNonOptParam();
150 if (!findNextInset(tmpdit, codes, contents)) {
151 if (dit.depth() != 1 || dit.pit() != 0 || dit.pos() != 0) {
152 tmpdit = doc_iterator_begin(tmpdit.bottom().inset());
153 if (!findNextInset(tmpdit, codes, contents))
164 /// Looks for next inset with the given code
165 void findInset(DocIterator & dit, InsetCode code, bool same_content)
167 findInset(dit, vector<InsetCode>(1, code), same_content);
171 /// Moves cursor to the next inset with one of the given codes.
172 void gotoInset(BufferView * bv, vector<InsetCode> const & codes,
175 Cursor tmpcur = bv->cursor();
176 if (!findInset(tmpcur, codes, same_content)) {
177 bv->cursor().message(_("No more insets"));
181 tmpcur.clearSelection();
182 bv->setCursor(tmpcur);
187 /// Moves cursor to the next inset with given code.
188 void gotoInset(BufferView * bv, InsetCode code, bool same_content)
190 gotoInset(bv, vector<InsetCode>(1, code), same_content);
194 /// A map from a Text to the associated text metrics
195 typedef map<Text const *, TextMetrics> TextMetricsCache;
197 enum ScreenUpdateStrategy {
207 /////////////////////////////////////////////////////////////////////
211 /////////////////////////////////////////////////////////////////////
213 struct BufferView::Private
215 Private(BufferView & bv): wh_(0), cursor_(bv),
216 anchor_pit_(0), anchor_ypos_(0),
217 inlineCompletionUniqueChars_(0),
218 last_inset_(0), gui_(0)
222 ScrollbarParameters scrollbarParameters_;
224 ScreenUpdateStrategy update_strategy_;
226 CoordCache coord_cache_;
228 /// Estimated average par height for scrollbar.
230 /// this is used to handle XSelection events in the right manner.
239 pit_type anchor_pit_;
243 vector<int> par_height_;
246 DocIterator inlineCompletionPos_;
248 docstring inlineCompletion_;
250 size_t inlineCompletionUniqueChars_;
252 /// keyboard mapping object.
255 /// last visited inset.
256 /** kept to send setMouseHover(false).
257 * Not owned, so don't delete.
261 mutable TextMetricsCache text_metrics_;
264 /** Not owned, so don't delete.
266 frontend::GuiBufferViewDelegate * gui_;
268 /// Cache for Find Next
269 FuncRequest search_request_cache_;
273 BufferView::BufferView(Buffer & buf)
274 : width_(0), height_(0), full_screen_(false), buffer_(buf), d(new Private(*this))
276 d->xsel_cache_.set = false;
277 d->intl_.initKeyMapper(lyxrc.use_kbmap);
279 d->cursor_.push(buffer_.inset());
280 d->cursor_.resetAnchor();
281 d->cursor_.setCurrentFont();
283 if (graphics::Previews::status() != LyXRC::PREVIEW_OFF)
284 graphics::Previews::get().generateBufferPreviews(buffer_);
288 BufferView::~BufferView()
290 // current buffer is going to be switched-off, save cursor pos
291 // Ideally, the whole cursor stack should be saved, but session
292 // currently can only handle bottom (whole document) level pit and pos.
293 // That is to say, if a cursor is in a nested inset, it will be
294 // restore to the left of the top level inset.
295 LastFilePosSection::FilePos fp;
296 fp.pit = d->cursor_.bottom().pit();
297 fp.pos = d->cursor_.bottom().pos();
298 LyX::ref().session().lastFilePos().save(buffer_.fileName(), fp);
304 int BufferView::rightMargin() const
306 // The additional test for the case the outliner is opened.
308 !lyxrc.full_screen_limit ||
309 width_ < lyxrc.full_screen_width + 20)
312 return (width_ - lyxrc.full_screen_width) / 2;
316 int BufferView::leftMargin() const
318 return rightMargin();
322 bool BufferView::isTopScreen() const
324 return d->scrollbarParameters_.position == d->scrollbarParameters_.min;
328 bool BufferView::isBottomScreen() const
330 return d->scrollbarParameters_.position == d->scrollbarParameters_.max;
334 Intl & BufferView::getIntl()
340 Intl const & BufferView::getIntl() const
346 CoordCache & BufferView::coordCache()
348 return d->coord_cache_;
352 CoordCache const & BufferView::coordCache() const
354 return d->coord_cache_;
358 Buffer & BufferView::buffer()
364 Buffer const & BufferView::buffer() const
370 bool BufferView::fitCursor()
372 if (cursorStatus(d->cursor_) == CUR_INSIDE) {
373 frontend::FontMetrics const & fm =
374 theFontMetrics(d->cursor_.getFont().fontInfo());
375 int const asc = fm.maxAscent();
376 int const des = fm.maxDescent();
377 Point const p = getPos(d->cursor_, d->cursor_.boundary());
378 if (p.y_ - asc >= 0 && p.y_ + des < height_)
385 void BufferView::processUpdateFlags(Update::flags flags)
387 // last_inset_ points to the last visited inset. This pointer may become
388 // invalid because of keyboard editing. Since all such operations
389 // causes screen update(), I reset last_inset_ to avoid such a problem.
391 // This is close to a hot-path.
392 LYXERR(Debug::DEBUG, "BufferView::processUpdateFlags()"
393 << "[fitcursor = " << (flags & Update::FitCursor)
394 << ", forceupdate = " << (flags & Update::Force)
395 << ", singlepar = " << (flags & Update::SinglePar)
396 << "] buffer: " << &buffer_);
398 buffer_.updateMacros();
400 // Now do the first drawing step if needed. This consists on updating
401 // the CoordCache in updateMetrics().
402 // The second drawing step is done in WorkArea::redraw() if needed.
404 // Case when no explicit update is requested.
406 // no need to redraw anything.
407 d->update_strategy_ = NoScreenUpdate;
411 if (flags == Update::Decoration) {
412 d->update_strategy_ = DecorationUpdate;
417 if (flags == Update::FitCursor
418 || flags == (Update::Decoration | Update::FitCursor)) {
419 // tell the frontend to update the screen if needed.
424 if (flags & Update::Decoration) {
425 d->update_strategy_ = DecorationUpdate;
429 // no screen update is needed.
430 d->update_strategy_ = NoScreenUpdate;
434 bool const full_metrics = flags & Update::Force || !singleParUpdate();
437 // We have to update the full screen metrics.
440 if (!(flags & Update::FitCursor)) {
441 // Nothing to do anymore. Trigger a redraw and return
446 // updateMetrics() does not update paragraph position
447 // This is done at draw() time. So we need a redraw!
451 // The cursor is off screen so ensure it is visible.
458 void BufferView::updateScrollbar()
463 // We prefer fixed size line scrolling.
464 d->scrollbarParameters_.single_step = defaultRowHeight();
465 // We prefer full screen page scrolling.
466 d->scrollbarParameters_.page_step = height_;
468 Text & t = buffer_.text();
469 TextMetrics & tm = d->text_metrics_[&t];
471 LYXERR(Debug::GUI, " Updating scrollbar: height: "
472 << t.paragraphs().size()
473 << " curr par: " << d->cursor_.bottom().pit()
474 << " default height " << defaultRowHeight());
476 size_t const parsize = t.paragraphs().size();
477 if (d->par_height_.size() != parsize) {
478 d->par_height_.clear();
479 // FIXME: We assume a default paragraph height of 2 rows. This
480 // should probably be pondered with the screen width.
481 d->par_height_.resize(parsize, defaultRowHeight() * 2);
484 // Look at paragraph heights on-screen
485 pair<pit_type, ParagraphMetrics const *> first = tm.first();
486 pair<pit_type, ParagraphMetrics const *> last = tm.last();
487 for (pit_type pit = first.first; pit <= last.first; ++pit) {
488 d->par_height_[pit] = tm.parMetrics(pit).height();
489 LYXERR(Debug::SCROLLING, "storing height for pit " << pit << " : "
490 << d->par_height_[pit]);
493 int top_pos = first.second->position() - first.second->ascent();
494 int bottom_pos = last.second->position() + last.second->descent();
495 bool first_visible = first.first == 0 && top_pos >= 0;
496 bool last_visible = last.first + 1 == int(parsize) && bottom_pos <= height_;
497 if (first_visible && last_visible) {
498 d->scrollbarParameters_.min = 0;
499 d->scrollbarParameters_.max = 0;
503 d->scrollbarParameters_.min = top_pos;
504 for (size_t i = 0; i != size_t(first.first); ++i)
505 d->scrollbarParameters_.min -= d->par_height_[i];
506 d->scrollbarParameters_.max = bottom_pos;
507 for (size_t i = last.first + 1; i != parsize; ++i)
508 d->scrollbarParameters_.max += d->par_height_[i];
510 d->scrollbarParameters_.position = 0;
511 // The reference is the top position so we remove one page.
512 d->scrollbarParameters_.max -= d->scrollbarParameters_.page_step;
516 ScrollbarParameters const & BufferView::scrollbarParameters() const
518 return d->scrollbarParameters_;
522 docstring BufferView::toolTip(int x, int y) const
524 // Get inset under mouse, if there is one.
525 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
527 // No inset, no tooltip...
529 return covering_inset->toolTip(*this, x, y);
533 docstring BufferView::contextMenu(int x, int y) const
535 // Get inset under mouse, if there is one.
536 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
538 return covering_inset->contextMenu(*this, x, y);
540 return buffer_.inset().contextMenu(*this, x, y);
544 void BufferView::scrollDocView(int value)
546 int const offset = value - d->scrollbarParameters_.position;
547 // If the offset is less than 2 screen height, prefer to scroll instead.
548 if (abs(offset) <= 2 * height_) {
553 // cut off at the top
554 if (value <= d->scrollbarParameters_.min) {
555 DocIterator dit = doc_iterator_begin(buffer_.inset());
557 LYXERR(Debug::SCROLLING, "scroll to top");
561 // cut off at the bottom
562 if (value >= d->scrollbarParameters_.max) {
563 DocIterator dit = doc_iterator_end(buffer_.inset());
566 LYXERR(Debug::SCROLLING, "scroll to bottom");
570 // find paragraph at target position
571 int par_pos = d->scrollbarParameters_.min;
573 for (; i != int(d->par_height_.size()); ++i) {
574 par_pos += d->par_height_[i];
575 if (par_pos >= value)
579 if (par_pos < value) {
580 // It seems we didn't find the correct pit so stay on the safe side and
582 LYXERR0("scrolling position not found!");
583 scrollDocView(d->scrollbarParameters_.max);
587 DocIterator dit = doc_iterator_begin(buffer_.inset());
589 LYXERR(Debug::SCROLLING, "value = " << value << " -> scroll to pit " << i);
594 // FIXME: this method is not working well.
595 void BufferView::setCursorFromScrollbar()
597 TextMetrics & tm = d->text_metrics_[&buffer_.text()];
599 int const height = 2 * defaultRowHeight();
600 int const first = height;
601 int const last = height_ - height;
602 Cursor & cur = d->cursor_;
604 switch (cursorStatus(cur)) {
606 // We reset the cursor because cursorStatus() does not
607 // work when the cursor is within mathed.
608 cur.reset(buffer_.inset());
609 tm.setCursorFromCoordinates(cur, 0, first);
610 cur.clearSelection();
613 // We reset the cursor because cursorStatus() does not
614 // work when the cursor is within mathed.
615 cur.reset(buffer_.inset());
616 tm.setCursorFromCoordinates(cur, 0, last);
617 cur.clearSelection();
620 int const y = getPos(cur, cur.boundary()).y_;
621 int const newy = min(last, max(y, first));
623 cur.reset(buffer_.inset());
624 tm.setCursorFromCoordinates(cur, 0, newy);
630 Change const BufferView::getCurrentChange() const
632 if (!d->cursor_.selection())
633 return Change(Change::UNCHANGED);
635 DocIterator dit = d->cursor_.selectionBegin();
636 return dit.paragraph().lookupChange(dit.pos());
640 // this could be used elsewhere as well?
641 // FIXME: This does not work within mathed!
642 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
644 Point const p = getPos(dit, dit.boundary());
647 if (p.y_ > workHeight())
653 void BufferView::saveBookmark(unsigned int idx)
655 // tenatively save bookmark, id and pos will be used to
656 // acturately locate a bookmark in a 'live' lyx session.
657 // pit and pos will be updated with bottom level pit/pos
659 LyX::ref().session().bookmarks().save(
661 d->cursor_.bottom().pit(),
662 d->cursor_.bottom().pos(),
663 d->cursor_.paragraph().id(),
668 // emit message signal.
669 message(_("Save bookmark"));
673 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
674 int top_id, pos_type top_pos)
676 bool success = false;
679 d->cursor_.clearSelection();
681 // if a valid par_id is given, try it first
682 // This is the case for a 'live' bookmark when unique paragraph ID
683 // is used to track bookmarks.
685 dit = buffer_.getParFromID(top_id);
687 dit.pos() = min(dit.paragraph().size(), top_pos);
688 // Some slices of the iterator may not be
689 // reachable (e.g. closed collapsable inset)
690 // so the dociterator may need to be
691 // shortened. Otherwise, setCursor may crash
692 // lyx when the cursor can not be set to these
694 size_t const n = dit.depth();
695 for (size_t i = 0; i < n; ++i)
696 if (dit[i].inset().editable() != Inset::HIGHLY_EDITABLE) {
704 // if top_id == 0, or searching through top_id failed
705 // This is the case for a 'restored' bookmark when only bottom
706 // (document level) pit was saved. Because of this, bookmark
707 // restoration is inaccurate. If a bookmark was within an inset,
708 // it will be restored to the left of the outmost inset that contains
710 if (bottom_pit < int(buffer_.paragraphs().size())) {
711 dit = doc_iterator_begin(buffer_.inset());
713 dit.pit() = bottom_pit;
714 dit.pos() = min(bottom_pos, dit.paragraph().size());
719 // Note: only bottom (document) level pit is set.
721 // set the current font.
722 d->cursor_.setCurrentFont();
723 // To center the screen on this new position we need the
724 // paragraph position which is computed at draw() time.
725 // So we need a redraw!
735 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
737 if (lyxrc.rtl_support) {
738 if (d->cursor_.real_current_font.isRightToLeft()) {
739 if (d->intl_.keymap == Intl::PRIMARY)
740 d->intl_.keyMapSec();
742 if (d->intl_.keymap == Intl::SECONDARY)
743 d->intl_.keyMapPrim();
747 d->intl_.getTransManager().translateAndInsert(c, t, cur);
751 int BufferView::workWidth() const
757 void BufferView::showCursor()
759 showCursor(d->cursor_);
763 void BufferView::showCursor(DocIterator const & dit)
765 // We are not properly started yet, delay until resizing is
770 LYXERR(Debug::SCROLLING, "recentering!");
772 CursorSlice const & bot = dit.bottom();
773 TextMetrics & tm = d->text_metrics_[bot.text()];
775 pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
776 int bot_pit = bot.pit();
777 if (bot_pit > max_pit) {
778 // FIXME: Why does this happen?
779 LYXERR0("bottom pit is greater that max pit: "
780 << bot_pit << " > " << max_pit);
784 if (bot_pit == tm.first().first - 1)
785 tm.newParMetricsUp();
786 else if (bot_pit == tm.last().first + 1)
787 tm.newParMetricsDown();
789 if (tm.contains(bot_pit)) {
790 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
791 LASSERT(!pm.rows().empty(), /**/);
792 // FIXME: smooth scrolling doesn't work in mathed.
793 CursorSlice const & cs = dit.innerTextSlice();
794 int offset = coordOffset(dit, dit.boundary()).y_;
795 int ypos = pm.position() + offset;
796 Dimension const & row_dim =
797 pm.getRow(cs.pos(), dit.boundary()).dimension();
798 if (ypos - row_dim.ascent() < 0)
799 scrollUp(- ypos + row_dim.ascent());
800 else if (ypos + row_dim.descent() > height_)
801 scrollDown(ypos - height_ + row_dim.descent());
802 // else, nothing to do, the cursor is already visible so we just return.
806 // fix inline completion position
807 if (d->inlineCompletionPos_.fixIfBroken())
808 d->inlineCompletionPos_ = DocIterator();
810 tm.redoParagraph(bot_pit);
811 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
812 int offset = coordOffset(dit, dit.boundary()).y_;
814 d->anchor_pit_ = bot_pit;
815 CursorSlice const & cs = dit.innerTextSlice();
816 Dimension const & row_dim =
817 pm.getRow(cs.pos(), dit.boundary()).dimension();
819 if (d->anchor_pit_ == 0)
820 d->anchor_ypos_ = offset + pm.ascent();
821 else if (d->anchor_pit_ == max_pit)
822 d->anchor_ypos_ = height_ - offset - row_dim.descent();
824 d->anchor_ypos_ = defaultRowHeight() * 2 - offset - row_dim.descent();
831 FuncStatus BufferView::getStatus(FuncRequest const & cmd)
835 Cursor & cur = d->cursor_;
837 switch (cmd.action) {
840 flag.setEnabled(buffer_.undo().hasUndoStack());
843 flag.setEnabled(buffer_.undo().hasRedoStack());
845 case LFUN_FILE_INSERT:
846 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
847 case LFUN_FILE_INSERT_PLAINTEXT:
848 case LFUN_BOOKMARK_SAVE:
849 // FIXME: Actually, these LFUNS should be moved to Text
850 flag.setEnabled(cur.inTexted());
852 case LFUN_FONT_STATE:
853 case LFUN_LABEL_INSERT:
854 case LFUN_INFO_INSERT:
855 case LFUN_INSET_EDIT:
856 case LFUN_PARAGRAPH_GOTO:
858 case LFUN_REFERENCE_NEXT:
860 case LFUN_WORD_REPLACE:
863 case LFUN_MARK_TOGGLE:
864 case LFUN_SCREEN_RECENTER:
865 case LFUN_BIBTEX_DATABASE_ADD:
866 case LFUN_BIBTEX_DATABASE_DEL:
867 case LFUN_STATISTICS:
868 flag.setEnabled(true);
871 case LFUN_NEXT_INSET_TOGGLE:
872 case LFUN_NEXT_INSET_MODIFY: {
873 // this is the real function we want to invoke
874 FuncRequest tmpcmd = cmd;
875 tmpcmd.action = (cmd.action == LFUN_NEXT_INSET_TOGGLE)
876 ? LFUN_INSET_TOGGLE : LFUN_INSET_MODIFY;
877 // if there is an inset at cursor, see whether it
878 // handles the lfun, other start from scratch
879 Inset * inset = cur.nextInset();
880 if (!inset || !inset->getStatus(cur, tmpcmd, flag))
881 flag = lyx::getStatus(tmpcmd);
885 case LFUN_LABEL_GOTO: {
886 flag.setEnabled(!cmd.argument().empty()
887 || getInsetByCode<InsetRef>(cur, REF_CODE));
891 case LFUN_CHANGES_TRACK:
892 flag.setEnabled(true);
893 flag.setOnOff(buffer_.params().trackChanges);
896 case LFUN_CHANGES_OUTPUT:
897 flag.setEnabled(true);
898 flag.setOnOff(buffer_.params().outputChanges);
901 case LFUN_CHANGES_MERGE:
902 case LFUN_CHANGE_NEXT:
903 case LFUN_ALL_CHANGES_ACCEPT:
904 case LFUN_ALL_CHANGES_REJECT:
905 // TODO: context-sensitive enabling of LFUNs
906 // In principle, these command should only be enabled if there
907 // is a change in the document. However, without proper
908 // optimizations, this will inevitably result in poor performance.
909 flag.setEnabled(true);
912 case LFUN_BUFFER_TOGGLE_COMPRESSION: {
913 flag.setOnOff(buffer_.params().compressed);
918 case LFUN_SCREEN_DOWN:
920 case LFUN_SCREEN_UP_SELECT:
921 case LFUN_SCREEN_DOWN_SELECT:
922 flag.setEnabled(true);
925 case LFUN_LAYOUT_TABULAR:
926 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
930 flag.setEnabled(!cur.inset().forceEmptyLayout(cur.idx()));
933 case LFUN_LAYOUT_PARAGRAPH:
934 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
937 case LFUN_INSET_SETTINGS: {
938 InsetCode code = cur.inset().lyxCode();
939 if (cmd.getArg(0) == insetName(code)) {
940 flag.setEnabled(true);
944 InsetCode next_code = cur.nextInset()
945 ? cur.nextInset()->lyxCode() : NO_CODE;
955 enable = (cmd.argument().empty() ||
956 cmd.getArg(0) == insetName(next_code));
961 flag.setEnabled(enable);
965 case LFUN_DIALOG_SHOW_NEW_INSET:
966 flag.setEnabled(cur.inset().lyxCode() != ERT_CODE &&
967 cur.inset().lyxCode() != LISTINGS_CODE);
968 if (cur.inset().lyxCode() == CAPTION_CODE) {
970 if (cur.inset().getStatus(cur, cmd, flag))
975 case LFUN_BRANCH_ACTIVATE:
976 case LFUN_BRANCH_DEACTIVATE: {
978 docstring const branchName = cmd.argument();
979 if (!branchName.empty())
980 enable = buffer_.params().branchlist().find(branchName);
981 flag.setEnabled(enable);
986 flag.setEnabled(false);
993 bool BufferView::dispatch(FuncRequest const & cmd)
995 //lyxerr << [ cmd = " << cmd << "]" << endl;
997 // Make sure that the cached BufferView is correct.
998 LYXERR(Debug::ACTION, " action[" << cmd.action << ']'
999 << " arg[" << to_utf8(cmd.argument()) << ']'
1000 << " x[" << cmd.x << ']'
1001 << " y[" << cmd.y << ']'
1002 << " button[" << cmd.button() << ']');
1004 Cursor & cur = d->cursor_;
1006 switch (cmd.action) {
1009 cur.message(_("Undo"));
1010 cur.clearSelection();
1011 if (!cur.textUndo())
1012 cur.message(_("No further undo information"));
1014 processUpdateFlags(Update::Force | Update::FitCursor);
1018 cur.message(_("Redo"));
1019 cur.clearSelection();
1020 if (!cur.textRedo())
1021 cur.message(_("No further redo information"));
1023 processUpdateFlags(Update::Force | Update::FitCursor);
1026 case LFUN_FONT_STATE:
1027 cur.message(cur.currentState());
1030 case LFUN_BOOKMARK_SAVE:
1031 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1034 case LFUN_LABEL_GOTO: {
1035 docstring label = cmd.argument();
1036 if (label.empty()) {
1038 getInsetByCode<InsetRef>(d->cursor_,
1041 label = inset->getParam("reference");
1042 // persistent=false: use temp_bookmark
1052 case LFUN_INSET_EDIT: {
1053 FuncRequest fr(cmd);
1054 // if there is an inset at cursor, see whether it
1056 Inset * inset = cur.nextInset();
1058 inset->dispatch(cur, fr);
1059 // if it did not work, try the underlying inset.
1060 if (!inset || !cur.result().dispatched())
1063 if (!cur.result().dispatched())
1064 // It did not work too; no action needed.
1068 case LFUN_PARAGRAPH_GOTO: {
1069 int const id = convert<int>(cmd.getArg(0));
1070 int const pos = convert<int>(cmd.getArg(1));
1072 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1073 b = theBufferList().next(b)) {
1075 DocIterator dit = b->getParFromID(id);
1077 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1081 LYXERR(Debug::INFO, "Paragraph " << dit.paragraph().id()
1082 << " found in buffer `"
1083 << b->absFileName() << "'.");
1085 if (b == &buffer_) {
1089 processUpdateFlags(Update::Force | Update::FitCursor);
1091 // Switch to other buffer view and resend cmd
1092 theLyXFunc().dispatch(FuncRequest(
1093 LFUN_BUFFER_SWITCH, b->absFileName()));
1094 theLyXFunc().dispatch(cmd);
1101 case LFUN_NOTE_NEXT:
1102 gotoInset(this, NOTE_CODE, false);
1105 case LFUN_REFERENCE_NEXT: {
1106 vector<InsetCode> tmp;
1107 tmp.push_back(LABEL_CODE);
1108 tmp.push_back(REF_CODE);
1109 gotoInset(this, tmp, true);
1113 case LFUN_CHANGES_TRACK:
1114 buffer_.params().trackChanges = !buffer_.params().trackChanges;
1117 case LFUN_CHANGES_OUTPUT:
1118 buffer_.params().outputChanges = !buffer_.params().outputChanges;
1119 if (buffer_.params().outputChanges) {
1120 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1121 bool xcolorsoul = LaTeXFeatures::isAvailable("soul") &&
1122 LaTeXFeatures::isAvailable("xcolor");
1124 if (!dvipost && !xcolorsoul) {
1125 Alert::warning(_("Changes not shown in LaTeX output"),
1126 _("Changes will not be highlighted in LaTeX output, "
1127 "because neither dvipost nor xcolor/soul are installed.\n"
1128 "Please install these packages or redefine "
1129 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1130 } else if (!xcolorsoul) {
1131 Alert::warning(_("Changes not shown in LaTeX output"),
1132 _("Changes will not be highlighted in LaTeX output "
1133 "when using pdflatex, because xcolor and soul are not installed.\n"
1134 "Please install both packages or redefine "
1135 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1140 case LFUN_CHANGE_NEXT:
1141 findNextChange(this);
1144 case LFUN_CHANGES_MERGE:
1145 if (findNextChange(this))
1146 showDialog("changes");
1149 case LFUN_ALL_CHANGES_ACCEPT:
1150 // select complete document
1151 d->cursor_.reset(buffer_.inset());
1152 d->cursor_.selHandle(true);
1153 buffer_.text().cursorBottom(d->cursor_);
1154 // accept everything in a single step to support atomic undo
1155 buffer_.text().acceptOrRejectChanges(d->cursor_, Text::ACCEPT);
1158 case LFUN_ALL_CHANGES_REJECT:
1159 // select complete document
1160 d->cursor_.reset(buffer_.inset());
1161 d->cursor_.selHandle(true);
1162 buffer_.text().cursorBottom(d->cursor_);
1163 // reject everything in a single step to support atomic undo
1164 // Note: reject does not work recursively; the user may have to repeat the operation
1165 buffer_.text().acceptOrRejectChanges(d->cursor_, Text::REJECT);
1168 case LFUN_WORD_FIND: {
1169 FuncRequest req = cmd;
1170 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1171 req = d->search_request_cache_;
1172 if (find(this, req))
1175 message(_("String not found!"));
1176 d->search_request_cache_ = req;
1180 case LFUN_WORD_REPLACE: {
1181 bool has_deleted = false;
1182 if (cur.selection()) {
1183 DocIterator beg = cur.selectionBegin();
1184 DocIterator end = cur.selectionEnd();
1185 if (beg.pit() == end.pit()) {
1186 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1187 if (cur.paragraph().isDeleted(p))
1192 replace(this, cmd, has_deleted);
1197 cur.clearSelection();
1199 cur.message(from_utf8(N_("Mark off")));
1203 cur.clearSelection();
1206 cur.message(from_utf8(N_("Mark on")));
1209 case LFUN_MARK_TOGGLE:
1210 cur.clearSelection();
1213 cur.message(from_utf8(N_("Mark removed")));
1216 cur.message(from_utf8(N_("Mark set")));
1221 case LFUN_SCREEN_RECENTER:
1225 case LFUN_BIBTEX_DATABASE_ADD: {
1226 Cursor tmpcur = d->cursor_;
1227 findInset(tmpcur, BIBTEX_CODE, false);
1228 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1231 if (inset->addDatabase(cmd.argument()))
1232 buffer_.updateBibfilesCache();
1237 case LFUN_BIBTEX_DATABASE_DEL: {
1238 Cursor tmpcur = d->cursor_;
1239 findInset(tmpcur, BIBTEX_CODE, false);
1240 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1243 if (inset->delDatabase(cmd.argument()))
1244 buffer_.updateBibfilesCache();
1249 case LFUN_STATISTICS: {
1250 DocIterator from, to;
1251 if (cur.selection()) {
1252 from = cur.selectionBegin();
1253 to = cur.selectionEnd();
1255 from = doc_iterator_begin(buffer_.inset());
1256 to = doc_iterator_end(buffer_.inset());
1258 int const words = countWords(from, to);
1259 int const chars = countChars(from, to, false);
1260 int const chars_blanks = countChars(from, to, true);
1262 if (cur.selection())
1263 message = _("Statistics for the selection:");
1265 message = _("Statistics for the document:");
1268 message += bformat(_("%1$d words"), words);
1270 message += _("One word");
1272 if (chars_blanks != 1)
1273 message += bformat(_("%1$d characters (including blanks)"),
1276 message += _("One character (including blanks)");
1279 message += bformat(_("%1$d characters (excluding blanks)"),
1282 message += _("One character (excluding blanks)");
1284 Alert::information(_("Statistics"), message);
1288 case LFUN_BUFFER_TOGGLE_COMPRESSION:
1289 // turn compression on/off
1290 buffer_.params().compressed = !buffer_.params().compressed;
1293 case LFUN_NEXT_INSET_TOGGLE: {
1294 // create the the real function we want to invoke
1295 FuncRequest tmpcmd = cmd;
1296 tmpcmd.action = LFUN_INSET_TOGGLE;
1297 // if there is an inset at cursor, see whether it
1299 Inset * inset = cur.nextInset();
1301 if (inset->isActive()) {
1302 Cursor tmpcur = cur;
1303 tmpcur.pushBackward(*inset);
1304 inset->dispatch(tmpcur, tmpcmd);
1305 if (tmpcur.result().dispatched())
1308 inset->dispatch(cur, tmpcmd);
1310 // if it did not work, try the underlying inset.
1311 if (!inset || !cur.result().dispatched())
1312 cur.dispatch(tmpcmd);
1314 if (!cur.result().dispatched())
1315 // It did not work too; no action needed.
1317 cur.clearSelection();
1318 processUpdateFlags(Update::SinglePar | Update::FitCursor);
1322 case LFUN_NEXT_INSET_MODIFY: {
1323 // create the the real function we want to invoke
1324 FuncRequest tmpcmd = cmd;
1325 tmpcmd.action = LFUN_INSET_MODIFY;
1326 // if there is an inset at cursor, see whether it
1328 Inset * inset = cur.nextInset();
1330 inset->dispatch(cur, tmpcmd);
1331 // if it did not work, try the underlying inset.
1332 if (!inset || !cur.result().dispatched())
1333 cur.dispatch(tmpcmd);
1335 if (!cur.result().dispatched())
1336 // It did not work too; no action needed.
1338 cur.clearSelection();
1339 processUpdateFlags(Update::Force | Update::FitCursor);
1343 case LFUN_SCREEN_UP:
1344 case LFUN_SCREEN_DOWN: {
1345 Point p = getPos(cur, cur.boundary());
1346 if (p.y_ < 0 || p.y_ > height_) {
1347 // The cursor is off-screen so recenter before proceeding.
1349 p = getPos(cur, cur.boundary());
1351 scroll(cmd.action == LFUN_SCREEN_UP? - height_ : height_);
1352 cur.reset(buffer_.inset());
1353 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_);
1354 //FIXME: what to do with cur.x_target()?
1363 case LFUN_SCREEN_UP_SELECT: {
1364 cur.selHandle(true);
1365 if (isTopScreen()) {
1366 lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1370 int y = getPos(cur, cur.boundary()).y_;
1371 int const ymin = y - height_ + defaultRowHeight();
1372 while (y > ymin && cur.up())
1373 y = getPos(cur, cur.boundary()).y_;
1376 processUpdateFlags(Update::SinglePar | Update::FitCursor);
1380 case LFUN_SCREEN_DOWN_SELECT: {
1381 cur.selHandle(true);
1382 if (isBottomScreen()) {
1383 lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1387 int y = getPos(cur, cur.boundary()).y_;
1388 int const ymax = y + height_ - defaultRowHeight();
1389 while (y < ymax && cur.down())
1390 y = getPos(cur, cur.boundary()).y_;
1393 processUpdateFlags(Update::SinglePar | Update::FitCursor);
1397 case LFUN_BRANCH_ACTIVATE:
1398 case LFUN_BRANCH_DEACTIVATE:
1399 buffer_.dispatch(cmd);
1400 processUpdateFlags(Update::Force);
1411 docstring const BufferView::requestSelection()
1413 Cursor & cur = d->cursor_;
1415 if (!cur.selection()) {
1416 d->xsel_cache_.set = false;
1420 if (!d->xsel_cache_.set ||
1421 cur.top() != d->xsel_cache_.cursor ||
1422 cur.anchor_.top() != d->xsel_cache_.anchor)
1424 d->xsel_cache_.cursor = cur.top();
1425 d->xsel_cache_.anchor = cur.anchor_.top();
1426 d->xsel_cache_.set = cur.selection();
1427 return cur.selectionAsString(false);
1433 void BufferView::clearSelection()
1435 d->cursor_.clearSelection();
1436 // Clear the selection buffer. Otherwise a subsequent
1437 // middle-mouse-button paste would use the selection buffer,
1438 // not the more current external selection.
1439 cap::clearSelection();
1440 d->xsel_cache_.set = false;
1441 // The buffer did not really change, but this causes the
1442 // redraw we need because we cleared the selection above.
1447 void BufferView::resize(int width, int height)
1449 // Update from work area
1453 // Clear the paragraph height cache.
1454 d->par_height_.clear();
1455 // Redo the metrics.
1460 Inset const * BufferView::getCoveringInset(Text const & text,
1463 TextMetrics & tm = d->text_metrics_[&text];
1464 Inset * inset = tm.checkInsetHit(x, y);
1468 if (!inset->descendable())
1469 // No need to go further down if the inset is not
1473 size_t cell_number = inset->nargs();
1474 // Check all the inner cell.
1475 for (size_t i = 0; i != cell_number; ++i) {
1476 Text const * inner_text = inset->getText(i);
1479 Inset const * inset_deeper =
1480 getCoveringInset(*inner_text, x, y);
1482 return inset_deeper;
1490 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
1492 //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
1494 // This is only called for mouse related events including
1495 // LFUN_FILE_OPEN generated by drag-and-drop.
1496 FuncRequest cmd = cmd0;
1498 Cursor old = cursor();
1500 cur.push(buffer_.inset());
1501 cur.selection() = d->cursor_.selection();
1503 // Either the inset under the cursor or the
1504 // surrounding Text will handle this event.
1506 // make sure we stay within the screen...
1507 cmd.y = min(max(cmd.y, -1), height_);
1509 if (cmd.action == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
1511 // Get inset under mouse, if there is one.
1512 Inset const * covering_inset =
1513 getCoveringInset(buffer_.text(), cmd.x, cmd.y);
1514 if (covering_inset == d->last_inset_)
1515 // Same inset, no need to do anything...
1518 bool need_redraw = false;
1519 // const_cast because of setMouseHover().
1520 Inset * inset = const_cast<Inset *>(covering_inset);
1522 // Remove the hint on the last hovered inset (if any).
1523 need_redraw |= d->last_inset_->setMouseHover(false);
1525 // Highlighted the newly hovered inset (if any).
1526 need_redraw |= inset->setMouseHover(true);
1527 d->last_inset_ = inset;
1531 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
1532 << cmd.x << ", " << cmd.y << ")");
1534 d->update_strategy_ = DecorationUpdate;
1536 // This event (moving without mouse click) is not passed further.
1537 // This should be changed if it is further utilized.
1542 // Build temporary cursor.
1543 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x, cmd.y);
1545 // Put anchor at the same position.
1548 // Try to dispatch to an non-editable inset near this position
1549 // via the temp cursor. If the inset wishes to change the real
1550 // cursor it has to do so explicitly by using
1551 // cur.bv().cursor() = cur; (or similar)
1553 inset->dispatch(cur, cmd);
1555 // Now dispatch to the temporary cursor. If the real cursor should
1556 // be modified, the inset's dispatch has to do so explicitly.
1557 if (!inset || !cur.result().dispatched())
1560 // Notify left insets
1563 bool badcursor = notifyCursorLeaves(old, cur);
1565 cursor().fixIfBroken();
1568 // Do we have a selection?
1569 theSelection().haveSelection(cursor().selection());
1571 // If the command has been dispatched,
1572 if (cur.result().dispatched() || cur.result().update())
1573 processUpdateFlags(cur.result().update());
1577 void BufferView::lfunScroll(FuncRequest const & cmd)
1579 string const scroll_type = cmd.getArg(0);
1580 int const scroll_step =
1581 (scroll_type == "line") ? d->scrollbarParameters_.single_step
1582 : (scroll_type == "page") ? d->scrollbarParameters_.page_step : 0;
1583 if (scroll_step == 0)
1585 string const scroll_quantity = cmd.getArg(1);
1586 if (scroll_quantity == "up")
1587 scrollUp(scroll_step);
1588 else if (scroll_quantity == "down")
1589 scrollDown(scroll_step);
1591 int const scroll_value = convert<int>(scroll_quantity);
1593 scroll(scroll_step * scroll_value);
1598 void BufferView::scroll(int y)
1607 void BufferView::scrollDown(int offset)
1609 Text * text = &buffer_.text();
1610 TextMetrics & tm = d->text_metrics_[text];
1611 int ymax = height_ + offset;
1613 pair<pit_type, ParagraphMetrics const *> last = tm.last();
1614 int bottom_pos = last.second->position() + last.second->descent();
1615 if (last.first + 1 == int(text->paragraphs().size())) {
1616 if (bottom_pos <= height_)
1618 offset = min(offset, bottom_pos - height_);
1621 if (bottom_pos > ymax)
1623 tm.newParMetricsDown();
1625 d->anchor_ypos_ -= offset;
1631 void BufferView::scrollUp(int offset)
1633 Text * text = &buffer_.text();
1634 TextMetrics & tm = d->text_metrics_[text];
1635 int ymin = - offset;
1637 pair<pit_type, ParagraphMetrics const *> first = tm.first();
1638 int top_pos = first.second->position() - first.second->ascent();
1639 if (first.first == 0) {
1642 offset = min(offset, - top_pos);
1647 tm.newParMetricsUp();
1649 d->anchor_ypos_ += offset;
1655 void BufferView::setCursorFromRow(int row)
1660 buffer_.texrow().getIdFromRow(row, tmpid, tmppos);
1662 d->cursor_.reset(buffer_.inset());
1664 buffer_.text().setCursor(d->cursor_, 0, 0);
1666 buffer_.text().setCursor(d->cursor_, buffer_.getParFromID(tmpid).pit(), tmppos);
1670 void BufferView::gotoLabel(docstring const & label)
1672 Toc & toc = buffer().tocBackend().toc("label");
1673 TocIterator toc_it = toc.begin();
1674 TocIterator end = toc.end();
1675 for (; toc_it != end; ++toc_it) {
1676 if (label == toc_it->str())
1677 dispatch(toc_it->action());
1679 //FIXME: We could do a bit more searching thanks to this:
1680 //InsetLabel const * inset = buffer_.insetLabel(label);
1684 TextMetrics const & BufferView::textMetrics(Text const * t) const
1686 return const_cast<BufferView *>(this)->textMetrics(t);
1690 TextMetrics & BufferView::textMetrics(Text const * t)
1692 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
1693 if (tmc_it == d->text_metrics_.end()) {
1694 tmc_it = d->text_metrics_.insert(
1695 make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
1697 return tmc_it->second;
1701 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
1704 return textMetrics(t).parMetrics(pit);
1708 int BufferView::workHeight() const
1714 void BufferView::setCursor(DocIterator const & dit)
1716 size_t const n = dit.depth();
1717 for (size_t i = 0; i < n; ++i)
1718 dit[i].inset().edit(d->cursor_, true);
1720 d->cursor_.setCursor(dit);
1721 d->cursor_.selection() = false;
1725 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
1727 // Would be wrong to delete anything if we have a selection.
1728 if (cur.selection())
1731 bool need_anchor_change = false;
1732 bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
1733 need_anchor_change);
1735 if (need_anchor_change)
1743 updateLabels(buffer_);
1751 bool BufferView::mouseSetCursor(Cursor & cur, bool select)
1753 LASSERT(&cur.bv() == this, /**/);
1756 // this event will clear selection so we save selection for
1757 // persistent selection
1758 cap::saveSelection(cursor());
1760 // Has the cursor just left the inset?
1761 bool badcursor = false;
1762 bool leftinset = (&d->cursor_.inset() != &cur.inset());
1764 d->cursor_.fixIfBroken();
1765 badcursor = notifyCursorLeaves(d->cursor_, cur);
1770 // FIXME: shift-mouse selection doesn't work well across insets.
1771 bool do_selection = select && &d->cursor_.anchor().inset() == &cur.inset();
1773 // do the dEPM magic if needed
1774 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
1775 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
1776 // the leftinset bool would not be necessary (badcursor instead).
1777 bool update = leftinset;
1778 if (!do_selection && !badcursor && d->cursor_.inTexted())
1779 update |= checkDepm(cur, d->cursor_);
1781 d->cursor_.setCursor(cur);
1782 d->cursor_.boundary(cur.boundary());
1784 d->cursor_.setSelection();
1786 d->cursor_.clearSelection();
1788 d->cursor_.finishUndo();
1789 d->cursor_.setCurrentFont();
1794 void BufferView::putSelectionAt(DocIterator const & cur,
1795 int length, bool backwards)
1797 d->cursor_.clearSelection();
1803 d->cursor_.pos() += length;
1804 d->cursor_.setSelection(d->cursor_, -length);
1806 d->cursor_.setSelection(d->cursor_, length);
1808 // Ensure a redraw happens in any case because the new selection could
1809 // possibly be on the same screen as the previous selection.
1810 processUpdateFlags(Update::Force | Update::FitCursor);
1814 Cursor & BufferView::cursor()
1820 Cursor const & BufferView::cursor() const
1826 pit_type BufferView::anchor_ref() const
1828 return d->anchor_pit_;
1832 bool BufferView::singleParUpdate()
1834 Text & buftext = buffer_.text();
1835 pit_type const bottom_pit = d->cursor_.bottom().pit();
1836 TextMetrics & tm = textMetrics(&buftext);
1837 int old_height = tm.parMetrics(bottom_pit).height();
1839 // make sure inline completion pointer is ok
1840 if (d->inlineCompletionPos_.fixIfBroken())
1841 d->inlineCompletionPos_ = DocIterator();
1843 // In Single Paragraph mode, rebreak only
1844 // the (main text, not inset!) paragraph containing the cursor.
1845 // (if this paragraph contains insets etc., rebreaking will
1846 // recursively descend)
1847 tm.redoParagraph(bottom_pit);
1848 ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
1849 if (pm.height() != old_height)
1850 // Paragraph height has changed so we cannot proceed to
1851 // the singlePar optimisation.
1854 d->update_strategy_ = SingleParUpdate;
1856 LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
1857 << " y2: " << pm.position() + pm.descent()
1858 << " pit: " << bottom_pit
1859 << " singlepar: 1");
1864 void BufferView::updateMetrics()
1866 Text & buftext = buffer_.text();
1867 pit_type const npit = int(buftext.paragraphs().size());
1869 // Clear out the position cache in case of full screen redraw,
1870 d->coord_cache_.clear();
1872 // Clear out paragraph metrics to avoid having invalid metrics
1873 // in the cache from paragraphs not relayouted below
1874 // The complete text metrics will be redone.
1875 d->text_metrics_.clear();
1877 TextMetrics & tm = textMetrics(&buftext);
1879 // make sure inline completion pointer is ok
1880 if (d->inlineCompletionPos_.fixIfBroken())
1881 d->inlineCompletionPos_ = DocIterator();
1883 if (d->anchor_pit_ >= npit)
1884 // The anchor pit must have been deleted...
1885 d->anchor_pit_ = npit - 1;
1887 // Rebreak anchor paragraph.
1888 tm.redoParagraph(d->anchor_pit_);
1889 ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
1892 if (d->anchor_pit_ == 0) {
1893 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
1895 // Complete buffer visible? Then it's easy.
1896 if (scrollRange == 0)
1897 d->anchor_ypos_ = anchor_pm.ascent();
1899 // FIXME: Some clever handling needed to show
1900 // the _first_ paragraph up to the top if the cursor is
1901 // in the first line.
1903 anchor_pm.setPosition(d->anchor_ypos_);
1905 LYXERR(Debug::PAINTING, "metrics: "
1906 << " anchor pit = " << d->anchor_pit_
1907 << " anchor ypos = " << d->anchor_ypos_);
1909 // Redo paragraphs above anchor if necessary.
1910 int y1 = d->anchor_ypos_ - anchor_pm.ascent();
1911 // We are now just above the anchor paragraph.
1912 pit_type pit1 = d->anchor_pit_ - 1;
1913 for (; pit1 >= 0 && y1 >= 0; --pit1) {
1914 tm.redoParagraph(pit1);
1915 ParagraphMetrics & pm = tm.par_metrics_[pit1];
1917 // Save the paragraph position in the cache.
1922 // Redo paragraphs below the anchor if necessary.
1923 int y2 = d->anchor_ypos_ + anchor_pm.descent();
1924 // We are now just below the anchor paragraph.
1925 pit_type pit2 = d->anchor_pit_ + 1;
1926 for (; pit2 < npit && y2 <= height_; ++pit2) {
1927 tm.redoParagraph(pit2);
1928 ParagraphMetrics & pm = tm.par_metrics_[pit2];
1930 // Save the paragraph position in the cache.
1935 LYXERR(Debug::PAINTING, "Metrics: "
1936 << " anchor pit = " << d->anchor_pit_
1937 << " anchor ypos = " << d->anchor_ypos_
1940 << " pit1 = " << pit1
1941 << " pit2 = " << pit2);
1943 d->update_strategy_ = FullScreenUpdate;
1945 if (lyxerr.debugging(Debug::WORKAREA)) {
1946 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
1947 d->coord_cache_.dump();
1952 void BufferView::insertLyXFile(FileName const & fname)
1954 LASSERT(d->cursor_.inTexted(), /**/);
1956 // Get absolute path of file and add ".lyx"
1957 // to the filename if necessary
1958 FileName filename = fileSearch(string(), fname.absFilename(), "lyx");
1960 docstring const disp_fn = makeDisplayPath(filename.absFilename());
1961 // emit message signal.
1962 message(bformat(_("Inserting document %1$s..."), disp_fn));
1965 Buffer buf("", false);
1966 if (buf.loadLyXFile(filename)) {
1967 ErrorList & el = buffer_.errorList("Parse");
1968 // Copy the inserted document error list into the current buffer one.
1969 el = buf.errorList("Parse");
1970 buffer_.undo().recordUndo(d->cursor_);
1971 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
1972 buf.params().documentClassPtr(), el);
1973 res = _("Document %1$s inserted.");
1975 res = _("Could not insert document %1$s");
1980 // emit message signal.
1981 message(bformat(res, disp_fn));
1982 buffer_.errors("Parse");
1986 Point BufferView::coordOffset(DocIterator const & dit, bool boundary) const
1992 // Addup contribution of nested insets, from inside to outside,
1993 // keeping the outer paragraph for a special handling below
1994 for (size_t i = dit.depth() - 1; i >= 1; --i) {
1995 CursorSlice const & sl = dit[i];
1999 // get relative position inside sl.inset()
2000 sl.inset().cursorPos(*this, sl, boundary && (i + 1 == dit.depth()), xx, yy);
2002 // Make relative position inside of the edited inset relative to sl.inset()
2006 // In case of an RTL inset, the edited inset will be positioned to the left
2009 bool boundary_i = boundary && i + 1 == dit.depth();
2010 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2015 // remember width for the case that sl.inset() is positioned in an RTL inset
2016 if (i && dit[i - 1].text()) {
2017 // If this Inset is inside a Text Inset, retrieve the Dimension
2018 // from the containing text instead of using Inset::dimension() which
2019 // might not be implemented.
2020 // FIXME (Abdel 23/09/2007): this is a bit messy because of the
2021 // elimination of Inset::dim_ cache. This coordOffset() method needs
2022 // to be rewritten in light of the new design.
2023 Dimension const & dim = parMetrics(dit[i - 1].text(),
2024 dit[i - 1].pit()).insetDimension(&sl.inset());
2027 Dimension const dim = sl.inset().dimension(*this);
2031 //lyxerr << "Cursor::getPos, i: "
2032 // << i << " x: " << xx << " y: " << y << endl;
2035 // Add contribution of initial rows of outermost paragraph
2036 CursorSlice const & sl = dit[0];
2037 TextMetrics const & tm = textMetrics(sl.text());
2038 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2039 LASSERT(!pm.rows().empty(), /**/);
2040 y -= pm.rows()[0].ascent();
2042 // FIXME: document this mess
2044 if (sl.pos() > 0 && dit.depth() == 1) {
2046 if (pos && boundary)
2048 // lyxerr << "coordOffset: boundary:" << boundary << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
2049 rend = pm.pos2row(pos);
2051 rend = pm.pos2row(sl.pos());
2053 size_t rend = pm.pos2row(sl.pos());
2055 for (size_t rit = 0; rit != rend; ++rit)
2056 y += pm.rows()[rit].height();
2057 y += pm.rows()[rend].ascent();
2059 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
2061 // Make relative position from the nested inset now bufferview absolute.
2062 int xx = bottom_tm.cursorX(dit.bottom(), boundary && dit.depth() == 1);
2065 // In the RTL case place the nested inset at the left of the cursor in
2066 // the outer paragraph
2067 bool boundary_1 = boundary && 1 == dit.depth();
2068 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
2076 Point BufferView::getPos(DocIterator const & dit, bool boundary) const
2078 CursorSlice const & bot = dit.bottom();
2079 TextMetrics const & tm = textMetrics(bot.text());
2080 if (!tm.contains(bot.pit()))
2081 return Point(-1, -1);
2083 Point p = coordOffset(dit, boundary); // offset from outer paragraph
2084 p.y_ += tm.parMetrics(bot.pit()).position();
2089 void BufferView::draw(frontend::Painter & pain)
2091 LYXERR(Debug::PAINTING, "\t\t*** START DRAWING ***");
2092 Text & text = buffer_.text();
2093 TextMetrics const & tm = d->text_metrics_[&text];
2094 int const y = tm.first().second->position();
2095 PainterInfo pi(this, pain);
2097 switch (d->update_strategy_) {
2099 case NoScreenUpdate:
2100 // If no screen painting is actually needed, only some the different
2101 // coordinates of insets and paragraphs needs to be updated.
2102 pi.full_repaint = true;
2103 pi.pain.setDrawingEnabled(false);
2107 case SingleParUpdate:
2108 pi.full_repaint = false;
2109 // In general, only the current row of the outermost paragraph
2110 // will be redrawn. Particular cases where selection spans
2111 // multiple paragraph are correctly detected in TextMetrics.
2115 case DecorationUpdate:
2116 // FIXME: We should also distinguish DecorationUpdate to avoid text
2117 // drawing if possible. This is not possible to do easily right now
2118 // because of the single backing pixmap.
2120 case FullScreenUpdate:
2121 // The whole screen, including insets, will be refreshed.
2122 pi.full_repaint = true;
2124 // Clear background.
2125 pain.fillRectangle(0, 0, width_, height_,
2126 buffer_.inset().backgroundColor());
2131 // and possibly grey out below
2132 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2133 int const y2 = lastpm.second->position() + lastpm.second->descent();
2135 pain.fillRectangle(0, y2, width_, height_ - y2, Color_bottomarea);
2138 LYXERR(Debug::PAINTING, "\n\t\t*** END DRAWING ***");
2140 // The scrollbar needs an update.
2143 // Normalize anchor for next time
2144 pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
2145 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2146 for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
2147 ParagraphMetrics const & pm = tm.parMetrics(pit);
2148 if (pm.position() + pm.descent() > 0) {
2149 d->anchor_pit_ = pit;
2150 d->anchor_ypos_ = pm.position();
2154 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
2155 << " anchor ypos = " << d->anchor_ypos_);
2159 void BufferView::message(docstring const & msg)
2162 d->gui_->message(msg);
2166 void BufferView::showDialog(string const & name)
2169 d->gui_->showDialog(name, string());
2173 void BufferView::showDialog(string const & name,
2174 string const & data, Inset * inset)
2177 d->gui_->showDialog(name, data, inset);
2181 void BufferView::updateDialog(string const & name, string const & data)
2184 d->gui_->updateDialog(name, data);
2188 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
2194 // FIXME: Move this out of BufferView again
2195 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
2197 if (!fname.isReadableFile()) {
2198 docstring const error = from_ascii(strerror(errno));
2199 docstring const file = makeDisplayPath(fname.absFilename(), 50);
2200 docstring const text =
2201 bformat(_("Could not read the specified document\n"
2202 "%1$s\ndue to the error: %2$s"), file, error);
2203 Alert::error(_("Could not read file"), text);
2207 if (!fname.isReadableFile()) {
2208 docstring const file = makeDisplayPath(fname.absFilename(), 50);
2209 docstring const text =
2210 bformat(_("%1$s\n is not readable."), file);
2211 Alert::error(_("Could not open file"), text);
2215 // FIXME UNICODE: We don't know the encoding of the file
2216 docstring file_content = fname.fileContents("UTF-8");
2217 if (file_content.empty()) {
2218 Alert::error(_("Reading not UTF-8 encoded file"),
2219 _("The file is not UTF-8 encoded.\n"
2220 "It will be read as local 8Bit-encoded.\n"
2221 "If this does not give the correct result\n"
2222 "then please change the encoding of the file\n"
2223 "to UTF-8 with a program other than LyX.\n"));
2224 file_content = fname.fileContents("local8bit");
2227 return normalize_c(file_content);
2231 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
2233 docstring const tmpstr = contentsOfPlaintextFile(f);
2238 Cursor & cur = cursor();
2239 cap::replaceSelection(cur);
2240 buffer_.undo().recordUndo(cur);
2242 cur.innerText()->insertStringAsParagraphs(cur, tmpstr);
2244 cur.innerText()->insertStringAsLines(cur, tmpstr);
2251 docstring const & BufferView::inlineCompletion() const
2253 return d->inlineCompletion_;
2257 size_t const & BufferView::inlineCompletionUniqueChars() const
2259 return d->inlineCompletionUniqueChars_;
2263 DocIterator const & BufferView::inlineCompletionPos() const
2265 return d->inlineCompletionPos_;
2269 bool samePar(DocIterator const & a, DocIterator const & b)
2271 if (a.empty() && b.empty())
2273 if (a.empty() || b.empty())
2275 return &a.innerParagraph() == &b.innerParagraph();
2279 void BufferView::setInlineCompletion(Cursor & cur, DocIterator const & pos,
2280 docstring const & completion, size_t uniqueChars)
2282 uniqueChars = min(completion.size(), uniqueChars);
2283 bool changed = d->inlineCompletion_ != completion
2284 || d->inlineCompletionUniqueChars_ != uniqueChars;
2285 bool singlePar = true;
2286 d->inlineCompletion_ = completion;
2287 d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
2289 //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
2292 DocIterator const & old = d->inlineCompletionPos_;
2294 //lyxerr << "inlineCompletionPos changed" << std::endl;
2295 // old or pos are in another paragraph?
2296 if ((!samePar(cur, pos) && !pos.empty())
2297 || (!samePar(cur, old) && !old.empty())) {
2299 //lyxerr << "different paragraph" << std::endl;
2301 d->inlineCompletionPos_ = pos;
2306 if (singlePar && !(cur.disp_.update() & Update::Force))
2307 cur.updateFlags(cur.disp_.update() | Update::SinglePar);
2309 cur.updateFlags(cur.disp_.update() | Update::Force);