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"
37 #include "LayoutFile.h"
40 #include "LyXAction.h"
44 #include "MetricsInfo.h"
45 #include "Paragraph.h"
46 #include "ParagraphParameters.h"
47 #include "ParIterator.h"
50 #include "TextClass.h"
51 #include "TextMetrics.h"
53 #include "TocBackend.h"
55 #include "WordLangTuple.h"
57 #include "insets/InsetBibtex.h"
58 #include "insets/InsetCommand.h" // ChangeRefs
59 #include "insets/InsetExternal.h"
60 #include "insets/InsetGraphics.h"
61 #include "insets/InsetRef.h"
62 #include "insets/InsetText.h"
63 #include "insets/InsetNote.h"
65 #include "frontends/alert.h"
66 #include "frontends/Application.h"
67 #include "frontends/Delegates.h"
68 #include "frontends/FontMetrics.h"
69 #include "frontends/Painter.h"
70 #include "frontends/Selection.h"
72 #include "graphics/Previews.h"
74 #include "support/convert.h"
75 #include "support/debug.h"
76 #include "support/ExceptionMessage.h"
77 #include "support/filetools.h"
78 #include "support/gettext.h"
79 #include "support/lstrings.h"
80 #include "support/Package.h"
81 #include "support/types.h"
91 using namespace lyx::support;
95 namespace Alert = frontend::Alert;
99 /// Return an inset of this class if it exists at the current cursor position
101 T * getInsetByCode(Cursor const & cur, InsetCode code)
103 DocIterator it = cur;
104 Inset * inset = it.nextInset();
105 if (inset && inset->lyxCode() == code)
106 return static_cast<T*>(inset);
111 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
114 bool findNextInset(DocIterator & dit, vector<InsetCode> const & codes,
115 docstring const & contents)
117 DocIterator tmpdit = dit;
120 Inset const * inset = tmpdit.nextInset();
122 && std::find(codes.begin(), codes.end(), inset->lyxCode()) != codes.end()
123 && (contents.empty() ||
124 static_cast<InsetCommand const *>(inset)->getFirstNonOptParam() == contents)) {
128 tmpdit.forwardInset();
135 /// Looks for next inset with one of the given codes.
136 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
140 DocIterator tmpdit = dit;
141 tmpdit.forwardInset();
146 Inset const * inset = tmpdit.nextInset();
148 && std::find(codes.begin(), codes.end(), inset->lyxCode()) != codes.end()) {
149 contents = static_cast<InsetCommand const *>(inset)->getFirstNonOptParam();
153 if (!findNextInset(tmpdit, codes, contents)) {
154 if (dit.depth() != 1 || dit.pit() != 0 || dit.pos() != 0) {
155 Inset * inset = &tmpdit.bottom().inset();
156 tmpdit = doc_iterator_begin(&inset->buffer(), inset);
157 if (!findNextInset(tmpdit, codes, contents))
169 /// Looks for next inset with the given code
170 void findInset(DocIterator & dit, InsetCode code, bool same_content)
172 findInset(dit, vector<InsetCode>(1, code), same_content);
176 /// Moves cursor to the next inset with one of the given codes.
177 void gotoInset(BufferView * bv, vector<InsetCode> const & codes,
180 Cursor tmpcur = bv->cursor();
181 if (!findInset(tmpcur, codes, same_content)) {
182 bv->cursor().message(_("No more insets"));
186 tmpcur.clearSelection();
187 bv->setCursor(tmpcur);
192 /// Moves cursor to the next inset with given code.
193 void gotoInset(BufferView * bv, InsetCode code, bool same_content)
195 gotoInset(bv, vector<InsetCode>(1, code), same_content);
199 /// A map from a Text to the associated text metrics
200 typedef map<Text const *, TextMetrics> TextMetricsCache;
202 enum ScreenUpdateStrategy {
212 /////////////////////////////////////////////////////////////////////
216 /////////////////////////////////////////////////////////////////////
218 struct BufferView::Private
220 Private(BufferView & bv): wh_(0), cursor_(bv),
221 anchor_pit_(0), anchor_ypos_(0),
222 inlineCompletionUniqueChars_(0),
223 last_inset_(0), mouse_position_cache_(),
224 bookmark_edit_position_(0), gui_(0)
228 ScrollbarParameters scrollbarParameters_;
230 ScreenUpdateStrategy update_strategy_;
232 CoordCache coord_cache_;
234 /// Estimated average par height for scrollbar.
236 /// this is used to handle XSelection events in the right manner.
245 pit_type anchor_pit_;
249 vector<int> par_height_;
252 DocIterator inlineCompletionPos_;
254 docstring inlineCompletion_;
256 size_t inlineCompletionUniqueChars_;
258 /// keyboard mapping object.
261 /// last visited inset.
262 /** kept to send setMouseHover(false).
263 * Not owned, so don't delete.
267 /// position of the mouse at the time of the last mouse move
268 /// This is used to update the hovering status of inset in
269 /// cases where the buffer is scrolled, but the mouse didn't move.
270 Point mouse_position_cache_;
272 // cache for id of the paragraph which was edited the last time
273 int bookmark_edit_position_;
275 mutable TextMetricsCache text_metrics_;
278 /** Not owned, so don't delete.
280 frontend::GuiBufferViewDelegate * gui_;
282 /// Cache for Find Next
283 FuncRequest search_request_cache_;
286 map<string, Inset *> edited_insets_;
290 BufferView::BufferView(Buffer & buf)
291 : width_(0), height_(0), full_screen_(false), buffer_(buf),
292 d(new Private(*this))
294 d->xsel_cache_.set = false;
295 d->intl_.initKeyMapper(lyxrc.use_kbmap);
297 d->cursor_.setBuffer(&buf);
298 d->cursor_.push(buffer_.inset());
299 d->cursor_.resetAnchor();
300 d->cursor_.setCurrentFont();
302 if (graphics::Previews::status() != LyXRC::PREVIEW_OFF)
303 thePreviews().generateBufferPreviews(buffer_);
307 BufferView::~BufferView()
309 // current buffer is going to be switched-off, save cursor pos
310 // Ideally, the whole cursor stack should be saved, but session
311 // currently can only handle bottom (whole document) level pit and pos.
312 // That is to say, if a cursor is in a nested inset, it will be
313 // restore to the left of the top level inset.
314 LastFilePosSection::FilePos fp;
315 fp.pit = d->cursor_.bottom().pit();
316 fp.pos = d->cursor_.bottom().pos();
317 theSession().lastFilePos().save(buffer_.fileName(), fp);
323 int BufferView::rightMargin() const
325 // The additional test for the case the outliner is opened.
327 !lyxrc.full_screen_limit ||
328 width_ < lyxrc.full_screen_width + 20)
331 return (width_ - lyxrc.full_screen_width) / 2;
335 int BufferView::leftMargin() const
337 return rightMargin();
341 bool BufferView::isTopScreen() const
343 return d->scrollbarParameters_.position == d->scrollbarParameters_.min;
347 bool BufferView::isBottomScreen() const
349 return d->scrollbarParameters_.position == d->scrollbarParameters_.max;
353 Intl & BufferView::getIntl()
359 Intl const & BufferView::getIntl() const
365 CoordCache & BufferView::coordCache()
367 return d->coord_cache_;
371 CoordCache const & BufferView::coordCache() const
373 return d->coord_cache_;
377 Buffer & BufferView::buffer()
383 Buffer const & BufferView::buffer() const
389 bool BufferView::fitCursor()
391 if (cursorStatus(d->cursor_) == CUR_INSIDE) {
392 frontend::FontMetrics const & fm =
393 theFontMetrics(d->cursor_.getFont().fontInfo());
394 int const asc = fm.maxAscent();
395 int const des = fm.maxDescent();
396 Point const p = getPos(d->cursor_, d->cursor_.boundary());
397 if (p.y_ - asc >= 0 && p.y_ + des < height_)
404 void BufferView::processUpdateFlags(Update::flags flags)
406 // last_inset_ points to the last visited inset. This pointer may become
407 // invalid because of keyboard editing. Since all such operations
408 // causes screen update(), I reset last_inset_ to avoid such a problem.
411 // This is close to a hot-path.
412 LYXERR(Debug::DEBUG, "BufferView::processUpdateFlags()"
413 << "[fitcursor = " << (flags & Update::FitCursor)
414 << ", forceupdate = " << (flags & Update::Force)
415 << ", singlepar = " << (flags & Update::SinglePar)
416 << "] buffer: " << &buffer_);
418 buffer_.updateMacros();
420 // Now do the first drawing step if needed. This consists on updating
421 // the CoordCache in updateMetrics().
422 // The second drawing step is done in WorkArea::redraw() if needed.
424 // Case when no explicit update is requested.
426 // no need to redraw anything.
427 d->update_strategy_ = NoScreenUpdate;
431 if (flags == Update::Decoration) {
432 d->update_strategy_ = DecorationUpdate;
433 buffer_.changed(false);
437 if (flags == Update::FitCursor
438 || flags == (Update::Decoration | Update::FitCursor)) {
439 // tell the frontend to update the screen if needed.
444 if (flags & Update::Decoration) {
445 d->update_strategy_ = DecorationUpdate;
446 buffer_.changed(false);
449 // no screen update is needed.
450 d->update_strategy_ = NoScreenUpdate;
454 bool const full_metrics = flags & Update::Force || !singleParUpdate();
457 // We have to update the full screen metrics.
460 if (!(flags & Update::FitCursor)) {
461 // Nothing to do anymore. Trigger a redraw and return
462 buffer_.changed(false);
466 // updateMetrics() does not update paragraph position
467 // This is done at draw() time. So we need a redraw!
468 buffer_.changed(false);
471 // The cursor is off screen so ensure it is visible.
476 updateHoveredInset();
480 void BufferView::updateScrollbar()
482 if (height_ == 0 && width_ == 0)
485 // We prefer fixed size line scrolling.
486 d->scrollbarParameters_.single_step = defaultRowHeight();
487 // We prefer full screen page scrolling.
488 d->scrollbarParameters_.page_step = height_;
490 Text & t = buffer_.text();
491 TextMetrics & tm = d->text_metrics_[&t];
493 LYXERR(Debug::GUI, " Updating scrollbar: height: "
494 << t.paragraphs().size()
495 << " curr par: " << d->cursor_.bottom().pit()
496 << " default height " << defaultRowHeight());
498 size_t const parsize = t.paragraphs().size();
499 if (d->par_height_.size() != parsize) {
500 d->par_height_.clear();
501 // FIXME: We assume a default paragraph height of 2 rows. This
502 // should probably be pondered with the screen width.
503 d->par_height_.resize(parsize, defaultRowHeight() * 2);
506 // Look at paragraph heights on-screen
507 pair<pit_type, ParagraphMetrics const *> first = tm.first();
508 pair<pit_type, ParagraphMetrics const *> last = tm.last();
509 for (pit_type pit = first.first; pit <= last.first; ++pit) {
510 d->par_height_[pit] = tm.parMetrics(pit).height();
511 LYXERR(Debug::SCROLLING, "storing height for pit " << pit << " : "
512 << d->par_height_[pit]);
515 int top_pos = first.second->position() - first.second->ascent();
516 int bottom_pos = last.second->position() + last.second->descent();
517 bool first_visible = first.first == 0 && top_pos >= 0;
518 bool last_visible = last.first + 1 == int(parsize) && bottom_pos <= height_;
519 if (first_visible && last_visible) {
520 d->scrollbarParameters_.min = 0;
521 d->scrollbarParameters_.max = 0;
525 d->scrollbarParameters_.min = top_pos;
526 for (size_t i = 0; i != size_t(first.first); ++i)
527 d->scrollbarParameters_.min -= d->par_height_[i];
528 d->scrollbarParameters_.max = bottom_pos;
529 for (size_t i = last.first + 1; i != parsize; ++i)
530 d->scrollbarParameters_.max += d->par_height_[i];
532 d->scrollbarParameters_.position = 0;
533 // The reference is the top position so we remove one page.
534 if (lyxrc.scroll_below_document)
535 d->scrollbarParameters_.max -= minVisiblePart();
537 d->scrollbarParameters_.max -= d->scrollbarParameters_.page_step;
541 ScrollbarParameters const & BufferView::scrollbarParameters() const
543 return d->scrollbarParameters_;
547 docstring BufferView::toolTip(int x, int y) const
549 // Get inset under mouse, if there is one.
550 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
552 // No inset, no tooltip...
554 return covering_inset->toolTip(*this, x, y);
558 docstring BufferView::contextMenu(int x, int y) const
560 //If there is a selection, return the containing inset menu
561 if (d->cursor_.selection())
562 return d->cursor_.inset().contextMenu(*this, x, y);
564 // Get inset under mouse, if there is one.
565 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
567 return covering_inset->contextMenu(*this, x, y);
569 return buffer_.inset().contextMenu(*this, x, y);
573 void BufferView::scrollDocView(int value)
575 int const offset = value - d->scrollbarParameters_.position;
577 // No scrolling at all? No need to redraw anything
581 // If the offset is less than 2 screen height, prefer to scroll instead.
582 if (abs(offset) <= 2 * height_) {
583 d->anchor_ypos_ -= offset;
584 buffer_.changed(true);
585 updateHoveredInset();
589 // cut off at the top
590 if (value <= d->scrollbarParameters_.min) {
591 DocIterator dit = doc_iterator_begin(&buffer_);
593 LYXERR(Debug::SCROLLING, "scroll to top");
597 // cut off at the bottom
598 if (value >= d->scrollbarParameters_.max) {
599 DocIterator dit = doc_iterator_end(&buffer_);
602 LYXERR(Debug::SCROLLING, "scroll to bottom");
606 // find paragraph at target position
607 int par_pos = d->scrollbarParameters_.min;
609 for (; i != int(d->par_height_.size()); ++i) {
610 par_pos += d->par_height_[i];
611 if (par_pos >= value)
615 if (par_pos < value) {
616 // It seems we didn't find the correct pit so stay on the safe side and
618 LYXERR0("scrolling position not found!");
619 scrollDocView(d->scrollbarParameters_.max);
623 DocIterator dit = doc_iterator_begin(&buffer_);
625 LYXERR(Debug::SCROLLING, "value = " << value << " -> scroll to pit " << i);
630 // FIXME: this method is not working well.
631 void BufferView::setCursorFromScrollbar()
633 TextMetrics & tm = d->text_metrics_[&buffer_.text()];
635 int const height = 2 * defaultRowHeight();
636 int const first = height;
637 int const last = height_ - height;
639 Cursor const & oldcur = d->cursor_;
641 switch (cursorStatus(oldcur)) {
649 int const y = getPos(oldcur, oldcur.boundary()).y_;
650 newy = min(last, max(y, first));
654 // We reset the cursor because cursorStatus() does not
655 // work when the cursor is within mathed.
658 tm.setCursorFromCoordinates(cur, 0, newy);
660 // update the bufferview cursor and notify insets
661 // FIXME: Care about the d->cursor_ flags to redraw if needed
662 Cursor old = d->cursor_;
664 bool badcursor = notifyCursorLeavesOrEnters(old, d->cursor_);
666 d->cursor_.fixIfBroken();
670 Change const BufferView::getCurrentChange() const
672 if (!d->cursor_.selection())
673 return Change(Change::UNCHANGED);
675 DocIterator dit = d->cursor_.selectionBegin();
676 return dit.paragraph().lookupChange(dit.pos());
680 // this could be used elsewhere as well?
681 // FIXME: This does not work within mathed!
682 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
684 Point const p = getPos(dit, dit.boundary());
687 if (p.y_ > workHeight())
693 void BufferView::bookmarkEditPosition()
695 // Don't eat cpu time for each keystroke
696 if (d->cursor_.paragraph().id() == d->bookmark_edit_position_)
699 d->bookmark_edit_position_ = d->cursor_.paragraph().id();
703 void BufferView::saveBookmark(unsigned int idx)
705 // tentatively save bookmark, id and pos will be used to
706 // acturately locate a bookmark in a 'live' lyx session.
707 // pit and pos will be updated with bottom level pit/pos
709 if (!buffer_.isInternal()) {
710 theSession().bookmarks().save(
712 d->cursor_.bottom().pit(),
713 d->cursor_.bottom().pos(),
714 d->cursor_.paragraph().id(),
719 // emit message signal.
720 message(_("Save bookmark"));
725 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
726 int top_id, pos_type top_pos)
728 bool success = false;
731 d->cursor_.clearSelection();
733 // if a valid par_id is given, try it first
734 // This is the case for a 'live' bookmark when unique paragraph ID
735 // is used to track bookmarks.
737 dit = buffer_.getParFromID(top_id);
739 dit.pos() = min(dit.paragraph().size(), top_pos);
740 // Some slices of the iterator may not be
741 // reachable (e.g. closed collapsable inset)
742 // so the dociterator may need to be
743 // shortened. Otherwise, setCursor may crash
744 // lyx when the cursor can not be set to these
746 size_t const n = dit.depth();
747 for (size_t i = 0; i < n; ++i)
748 if (!dit[i].inset().editable()) {
756 // if top_id == 0, or searching through top_id failed
757 // This is the case for a 'restored' bookmark when only bottom
758 // (document level) pit was saved. Because of this, bookmark
759 // restoration is inaccurate. If a bookmark was within an inset,
760 // it will be restored to the left of the outmost inset that contains
762 if (bottom_pit < int(buffer_.paragraphs().size())) {
763 dit = doc_iterator_begin(&buffer_);
765 dit.pit() = bottom_pit;
766 dit.pos() = min(bottom_pos, dit.paragraph().size());
771 // Note: only bottom (document) level pit is set.
773 // set the current font.
774 d->cursor_.setCurrentFont();
775 // To center the screen on this new position we need the
776 // paragraph position which is computed at draw() time.
777 // So we need a redraw!
778 buffer_.changed(false);
787 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
789 if (lyxrc.rtl_support) {
790 if (d->cursor_.real_current_font.isRightToLeft()) {
791 if (d->intl_.keymap == Intl::PRIMARY)
792 d->intl_.keyMapSec();
794 if (d->intl_.keymap == Intl::SECONDARY)
795 d->intl_.keyMapPrim();
799 d->intl_.getTransManager().translateAndInsert(c, t, cur);
803 int BufferView::workWidth() const
809 void BufferView::recenter()
811 showCursor(d->cursor_, true);
815 void BufferView::showCursor()
817 showCursor(d->cursor_, false);
821 void BufferView::showCursor(DocIterator const & dit, bool recenter)
823 if (scrollToCursor(dit, recenter)) {
824 buffer_.changed(true);
825 updateHoveredInset();
830 void BufferView::scrollToCursor()
832 if (scrollToCursor(d->cursor_, false)) {
833 buffer_.changed(true);
834 updateHoveredInset();
839 bool BufferView::scrollToCursor(DocIterator const & dit, bool recenter)
841 // We are not properly started yet, delay until resizing is
846 LYXERR(Debug::SCROLLING, "recentering!");
848 CursorSlice const & bot = dit.bottom();
849 TextMetrics & tm = d->text_metrics_[bot.text()];
851 pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
852 int bot_pit = bot.pit();
853 if (bot_pit > max_pit) {
854 // FIXME: Why does this happen?
855 LYXERR0("bottom pit is greater that max pit: "
856 << bot_pit << " > " << max_pit);
860 if (bot_pit == tm.first().first - 1)
861 tm.newParMetricsUp();
862 else if (bot_pit == tm.last().first + 1)
863 tm.newParMetricsDown();
865 if (tm.contains(bot_pit)) {
866 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
867 LASSERT(!pm.rows().empty(), /**/);
868 // FIXME: smooth scrolling doesn't work in mathed.
869 CursorSlice const & cs = dit.innerTextSlice();
870 int offset = coordOffset(dit, dit.boundary()).y_;
871 int ypos = pm.position() + offset;
872 Dimension const & row_dim =
873 pm.getRow(cs.pos(), dit.boundary()).dimension();
876 scrolled = scroll(ypos - height_/2);
877 else if (ypos - row_dim.ascent() < 0)
878 scrolled = scrollUp(- ypos + row_dim.ascent());
879 else if (ypos + row_dim.descent() > height_)
880 scrolled = scrollDown(ypos - height_ + defaultRowHeight() );
882 // else, nothing to do, the cursor is already visible so we just return.
883 return scrolled != 0;
886 // fix inline completion position
887 if (d->inlineCompletionPos_.fixIfBroken())
888 d->inlineCompletionPos_ = DocIterator();
890 tm.redoParagraph(bot_pit);
891 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
892 int offset = coordOffset(dit, dit.boundary()).y_;
894 d->anchor_pit_ = bot_pit;
895 CursorSlice const & cs = dit.innerTextSlice();
896 Dimension const & row_dim =
897 pm.getRow(cs.pos(), dit.boundary()).dimension();
900 d->anchor_ypos_ = height_/2;
901 else if (d->anchor_pit_ == 0)
902 d->anchor_ypos_ = offset + pm.ascent();
903 else if (d->anchor_pit_ == max_pit)
904 d->anchor_ypos_ = height_ - offset - row_dim.descent();
905 else if (offset > height_)
906 d->anchor_ypos_ = height_ - offset - defaultRowHeight();
908 d->anchor_ypos_ = defaultRowHeight() * 2;
914 void BufferView::updateDocumentClass(DocumentClass const * const olddc)
916 message(_("Converting document to new document class..."));
918 StableDocIterator backcur(d->cursor_);
919 ErrorList & el = buffer_.errorList("Class Switch");
920 cap::switchBetweenClasses(
921 olddc, buffer_.params().documentClassPtr(),
922 static_cast<InsetText &>(buffer_.inset()), el);
924 setCursor(backcur.asDocIterator(&buffer_));
926 buffer_.errors("Class Switch");
927 buffer_.updateBuffer();
930 /** Return the change status at cursor position, taking in account the
931 * status at each level of the document iterator (a table in a deleted
932 * footnote is deleted).
933 * When \param outer is true, the top slice is not looked at.
935 static Change::Type lookupChangeType(DocIterator const & dit, bool outer = false)
937 size_t const depth = dit.depth() - (outer ? 1 : 0);
939 for (size_t i = 0 ; i < depth ; ++i) {
940 CursorSlice const & slice = dit[i];
941 if (!slice.inset().inMathed()
942 && slice.pos() < slice.paragraph().size()) {
943 Change::Type const ch = slice.paragraph().lookupChange(slice.pos()).type;
944 if (ch != Change::UNCHANGED)
948 return Change::UNCHANGED;
952 bool BufferView::getStatus(FuncRequest const & cmd, FuncStatus & flag)
954 FuncCode const act = cmd.action();
956 // Can we use a readonly buffer?
957 if (buffer_.isReadonly()
958 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
959 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
960 flag.message(from_utf8(N_("Document is read-only")));
961 flag.setEnabled(false);
965 // Are we in a DELETED change-tracking region?
966 if (lookupChangeType(d->cursor_, true) == Change::DELETED
967 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
968 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
969 flag.message(from_utf8(N_("This portion of the document is deleted.")));
970 flag.setEnabled(false);
974 Cursor & cur = d->cursor_;
976 if (cur.getStatus(cmd, flag))
981 // FIXME: This is a bit problematic because we don't check if this is
982 // a document BufferView or not for these LFUNs. We probably have to
983 // dispatch both to currentBufferView() and, if that fails,
984 // to documentBufferView(); same as we do know for current Buffer and
985 // document Buffer. Ideally those LFUN should go to Buffer as they*
986 // operate on the full Buffer and the cursor is only needed either for
987 // an Undo record or to restore a cursor position. But we don't know
988 // how to do that inside Buffer of course.
989 case LFUN_BUFFER_PARAMS_APPLY:
990 case LFUN_LAYOUT_MODULES_CLEAR:
991 case LFUN_LAYOUT_MODULE_ADD:
992 case LFUN_LAYOUT_RELOAD:
993 case LFUN_TEXTCLASS_APPLY:
994 case LFUN_TEXTCLASS_LOAD:
995 flag.setEnabled(!buffer_.isReadonly());
999 flag.setEnabled(buffer_.undo().hasUndoStack());
1002 flag.setEnabled(buffer_.undo().hasRedoStack());
1004 case LFUN_FILE_INSERT:
1005 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
1006 case LFUN_FILE_INSERT_PLAINTEXT:
1007 case LFUN_BOOKMARK_SAVE:
1008 // FIXME: Actually, these LFUNS should be moved to Text
1009 flag.setEnabled(cur.inTexted());
1012 case LFUN_FONT_STATE:
1013 case LFUN_LABEL_INSERT:
1014 case LFUN_INFO_INSERT:
1015 case LFUN_INSET_EDIT:
1016 case LFUN_PARAGRAPH_GOTO:
1017 case LFUN_NOTE_NEXT:
1018 case LFUN_REFERENCE_NEXT:
1019 case LFUN_WORD_FIND:
1020 case LFUN_WORD_FIND_FORWARD:
1021 case LFUN_WORD_FIND_BACKWARD:
1022 case LFUN_WORD_FINDADV:
1023 case LFUN_WORD_REPLACE:
1026 case LFUN_MARK_TOGGLE:
1027 case LFUN_SCREEN_RECENTER:
1028 case LFUN_SCREEN_SHOW_CURSOR:
1029 case LFUN_BIBTEX_DATABASE_ADD:
1030 case LFUN_BIBTEX_DATABASE_DEL:
1031 case LFUN_STATISTICS:
1032 case LFUN_BRANCH_ADD_INSERT:
1033 case LFUN_KEYMAP_OFF:
1034 case LFUN_KEYMAP_PRIMARY:
1035 case LFUN_KEYMAP_SECONDARY:
1036 case LFUN_KEYMAP_TOGGLE:
1037 flag.setEnabled(true);
1040 case LFUN_LABEL_COPY_AS_REF: {
1041 // if there is an inset at cursor, see whether it
1043 Inset * inset = cur.nextInset();
1044 if (!inset || !inset->getStatus(cur, cmd, flag))
1045 flag.setEnabled(false);
1049 case LFUN_LABEL_GOTO: {
1050 flag.setEnabled(!cmd.argument().empty()
1051 || getInsetByCode<InsetRef>(cur, REF_CODE));
1055 case LFUN_CHANGES_TRACK:
1056 flag.setEnabled(true);
1057 flag.setOnOff(buffer_.params().trackChanges);
1060 case LFUN_CHANGES_OUTPUT:
1061 flag.setEnabled(true);
1062 flag.setOnOff(buffer_.params().outputChanges);
1065 case LFUN_CHANGES_MERGE:
1066 case LFUN_CHANGE_NEXT:
1067 case LFUN_CHANGE_PREVIOUS:
1068 case LFUN_ALL_CHANGES_ACCEPT:
1069 case LFUN_ALL_CHANGES_REJECT:
1070 // TODO: context-sensitive enabling of LFUNs
1071 // In principle, these command should only be enabled if there
1072 // is a change in the document. However, without proper
1073 // optimizations, this will inevitably result in poor performance.
1074 flag.setEnabled(true);
1077 case LFUN_BUFFER_TOGGLE_COMPRESSION: {
1078 flag.setOnOff(buffer_.params().compressed);
1082 case LFUN_SCREEN_UP:
1083 case LFUN_SCREEN_DOWN:
1085 case LFUN_SCREEN_UP_SELECT:
1086 case LFUN_SCREEN_DOWN_SELECT:
1087 case LFUN_INSET_FORALL:
1088 flag.setEnabled(true);
1091 case LFUN_LAYOUT_TABULAR:
1092 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
1096 flag.setEnabled(!cur.inset().forcePlainLayout(cur.idx()));
1099 case LFUN_LAYOUT_PARAGRAPH:
1100 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
1103 case LFUN_DIALOG_SHOW_NEW_INSET:
1104 // FIXME: this is wrong, but I do not understand the
1106 if (cur.inset().lyxCode() == CAPTION_CODE)
1107 return cur.inset().getStatus(cur, cmd, flag);
1108 // FIXME we should consider passthru paragraphs too.
1109 flag.setEnabled(!cur.inset().getLayout().isPassThru());
1112 case LFUN_CITATION_INSERT: {
1113 FuncRequest fr(LFUN_INSET_INSERT, "citation");
1114 // FIXME: This could turn in a recursive hell.
1115 // Shouldn't we use Buffer::getStatus() instead?
1116 flag.setEnabled(lyx::getStatus(fr).enabled());
1119 case LFUN_INSET_APPLY: {
1120 string const name = cmd.getArg(0);
1121 Inset * inset = editedInset(name);
1123 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1125 if (!inset->getStatus(cur, fr, fs)) {
1126 // Every inset is supposed to handle this
1127 LASSERT(false, break);
1131 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1132 flag |= lyx::getStatus(fr);
1138 flag.setEnabled(false);
1146 Inset * BufferView::editedInset(string const & name) const
1148 map<string, Inset *>::const_iterator it = d->edited_insets_.find(name);
1149 return it == d->edited_insets_.end() ? 0 : it->second;
1153 void BufferView::editInset(string const & name, Inset * inset)
1155 d->edited_insets_[name] = inset;
1159 void BufferView::dispatch(FuncRequest const & cmd, DispatchResult & dr)
1161 //lyxerr << [ cmd = " << cmd << "]" << endl;
1163 // Make sure that the cached BufferView is correct.
1164 LYXERR(Debug::ACTION, " action[" << cmd.action() << ']'
1165 << " arg[" << to_utf8(cmd.argument()) << ']'
1166 << " x[" << cmd.x() << ']'
1167 << " y[" << cmd.y() << ']'
1168 << " button[" << cmd.button() << ']');
1170 string const argument = to_utf8(cmd.argument());
1171 Cursor & cur = d->cursor_;
1173 // Don't dispatch function that does not apply to internal buffers.
1174 if (buffer_.isInternal()
1175 && lyxaction.funcHasFlag(cmd.action(), LyXAction::NoInternal))
1178 // We'll set this back to false if need be.
1179 bool dispatched = true;
1180 buffer_.undo().beginUndoGroup();
1182 FuncCode const act = cmd.action();
1185 case LFUN_BUFFER_PARAMS_APPLY: {
1186 DocumentClass const * const oldClass = buffer_.params().documentClassPtr();
1187 cur.recordUndoFullDocument();
1188 istringstream ss(to_utf8(cmd.argument()));
1191 int const unknown_tokens = buffer_.readHeader(lex);
1192 if (unknown_tokens != 0) {
1193 LYXERR0("Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1194 << unknown_tokens << " unknown token"
1195 << (unknown_tokens == 1 ? "" : "s"));
1197 updateDocumentClass(oldClass);
1199 // We are most certainly here because of a change in the document
1200 // It is then better to make sure that all dialogs are in sync with
1201 // current document settings.
1202 dr.update(Update::Force | Update::FitCursor);
1206 case LFUN_LAYOUT_MODULES_CLEAR: {
1207 DocumentClass const * const oldClass =
1208 buffer_.params().documentClassPtr();
1209 cur.recordUndoFullDocument();
1210 buffer_.params().clearLayoutModules();
1211 buffer_.params().makeDocumentClass();
1212 updateDocumentClass(oldClass);
1213 dr.update(Update::Force | Update::FitCursor);
1217 case LFUN_LAYOUT_MODULE_ADD: {
1218 BufferParams const & params = buffer_.params();
1219 if (!params.moduleCanBeAdded(argument)) {
1220 LYXERR0("Module `" << argument <<
1221 "' cannot be added due to failed requirements or "
1222 "conflicts with installed modules.");
1225 DocumentClass const * const oldClass = params.documentClassPtr();
1226 cur.recordUndoFullDocument();
1227 buffer_.params().addLayoutModule(argument);
1228 buffer_.params().makeDocumentClass();
1229 updateDocumentClass(oldClass);
1230 dr.update(Update::Force | Update::FitCursor);
1234 case LFUN_TEXTCLASS_APPLY: {
1235 if (!LayoutFileList::get().load(argument, buffer_.temppath()) &&
1236 !LayoutFileList::get().load(argument, buffer_.filePath()))
1239 LayoutFile const * old_layout = buffer_.params().baseClass();
1240 LayoutFile const * new_layout = &(LayoutFileList::get()[argument]);
1242 if (old_layout == new_layout)
1246 //Save the old, possibly modular, layout for use in conversion.
1247 DocumentClass const * const oldDocClass =
1248 buffer_.params().documentClassPtr();
1249 cur.recordUndoFullDocument();
1250 buffer_.params().setBaseClass(argument);
1251 buffer_.params().makeDocumentClass();
1252 updateDocumentClass(oldDocClass);
1253 dr.update(Update::Force | Update::FitCursor);
1257 case LFUN_TEXTCLASS_LOAD:
1258 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1259 LayoutFileList::get().load(argument, buffer_.filePath());
1262 case LFUN_LAYOUT_RELOAD: {
1263 DocumentClass const * const oldClass = buffer_.params().documentClassPtr();
1264 LayoutFileIndex bc = buffer_.params().baseClassID();
1265 LayoutFileList::get().reset(bc);
1266 buffer_.params().setBaseClass(bc);
1267 buffer_.params().makeDocumentClass();
1268 updateDocumentClass(oldClass);
1269 dr.update(Update::Force | Update::FitCursor);
1274 dr.setMessage(_("Undo"));
1275 cur.clearSelection();
1276 if (!cur.textUndo())
1277 dr.setMessage(_("No further undo information"));
1279 dr.update(Update::Force | Update::FitCursor);
1283 dr.setMessage(_("Redo"));
1284 cur.clearSelection();
1285 if (!cur.textRedo())
1286 dr.setMessage(_("No further redo information"));
1288 dr.update(Update::Force | Update::FitCursor);
1291 case LFUN_FONT_STATE:
1292 dr.setMessage(cur.currentState());
1295 case LFUN_BOOKMARK_SAVE:
1296 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1299 case LFUN_LABEL_GOTO: {
1300 docstring label = cmd.argument();
1301 if (label.empty()) {
1303 getInsetByCode<InsetRef>(cur, REF_CODE);
1305 label = inset->getParam("reference");
1306 // persistent=false: use temp_bookmark
1315 case LFUN_INSET_EDIT: {
1316 FuncRequest fr(cmd);
1317 // if there is an inset at cursor, see whether it
1319 Inset * inset = cur.nextInset();
1321 inset->dispatch(cur, fr);
1322 // if it did not work, try the underlying inset.
1323 if (!inset || !cur.result().dispatched())
1326 // FIXME I'm adding the last break to solve a crash,
1327 // but that is obviously not right.
1328 if (!cur.result().dispatched())
1329 // It did not work too; no action needed.
1334 case LFUN_PARAGRAPH_GOTO: {
1335 int const id = convert<int>(cmd.getArg(0));
1336 int const pos = convert<int>(cmd.getArg(1));
1338 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1339 b = theBufferList().next(b)) {
1341 DocIterator dit = b->getParFromID(id);
1343 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1347 LYXERR(Debug::INFO, "Paragraph " << dit.paragraph().id()
1348 << " found in buffer `"
1349 << b->absFileName() << "'.");
1351 if (b == &buffer_) {
1355 dr.update(Update::Force | Update::FitCursor);
1357 // Switch to other buffer view and resend cmd
1358 lyx::dispatch(FuncRequest(
1359 LFUN_BUFFER_SWITCH, b->absFileName()));
1367 case LFUN_NOTE_NEXT:
1368 gotoInset(this, NOTE_CODE, false);
1371 case LFUN_REFERENCE_NEXT: {
1372 vector<InsetCode> tmp;
1373 tmp.push_back(LABEL_CODE);
1374 tmp.push_back(REF_CODE);
1375 gotoInset(this, tmp, true);
1379 case LFUN_CHANGES_TRACK:
1380 buffer_.params().trackChanges = !buffer_.params().trackChanges;
1383 case LFUN_CHANGES_OUTPUT:
1384 buffer_.params().outputChanges = !buffer_.params().outputChanges;
1385 if (buffer_.params().outputChanges) {
1386 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1387 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1388 LaTeXFeatures::isAvailable("xcolor");
1390 if (!dvipost && !xcolorulem) {
1391 Alert::warning(_("Changes not shown in LaTeX output"),
1392 _("Changes will not be highlighted in LaTeX output, "
1393 "because neither dvipost nor xcolor/ulem are installed.\n"
1394 "Please install these packages or redefine "
1395 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1396 } else if (!xcolorulem) {
1397 Alert::warning(_("Changes not shown in LaTeX output"),
1398 _("Changes will not be highlighted in LaTeX output "
1399 "when using pdflatex, because xcolor and ulem are not installed.\n"
1400 "Please install both packages or redefine "
1401 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1406 case LFUN_CHANGE_NEXT:
1407 findNextChange(this);
1408 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1409 dr.update(Update::Force | Update::FitCursor);
1412 case LFUN_CHANGE_PREVIOUS:
1413 findPreviousChange(this);
1414 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1415 dr.update(Update::Force | Update::FitCursor);
1418 case LFUN_CHANGES_MERGE:
1419 if (findNextChange(this) || findPreviousChange(this)) {
1420 dr.update(Update::Force | Update::FitCursor);
1421 showDialog("changes");
1425 case LFUN_ALL_CHANGES_ACCEPT:
1426 // select complete document
1428 cur.selHandle(true);
1429 buffer_.text().cursorBottom(cur);
1430 // accept everything in a single step to support atomic undo
1431 buffer_.text().acceptOrRejectChanges(cur, Text::ACCEPT);
1432 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1433 dr.update(Update::Force | Update::FitCursor);
1436 case LFUN_ALL_CHANGES_REJECT:
1437 // select complete document
1439 cur.selHandle(true);
1440 buffer_.text().cursorBottom(cur);
1441 // reject everything in a single step to support atomic undo
1442 // Note: reject does not work recursively; the user may have to repeat the operation
1443 buffer_.text().acceptOrRejectChanges(cur, Text::REJECT);
1444 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1445 dr.update(Update::Force | Update::FitCursor);
1448 case LFUN_WORD_FIND_FORWARD:
1449 case LFUN_WORD_FIND_BACKWARD: {
1450 static docstring last_search;
1451 docstring searched_string;
1453 if (!cmd.argument().empty()) {
1454 last_search = cmd.argument();
1455 searched_string = cmd.argument();
1457 searched_string = last_search;
1460 if (searched_string.empty())
1463 bool const fw = act == LFUN_WORD_FIND_FORWARD;
1464 docstring const data =
1465 find2string(searched_string, true, false, fw);
1466 find(this, FuncRequest(LFUN_WORD_FIND, data));
1470 case LFUN_WORD_FIND: {
1471 FuncRequest req = cmd;
1472 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1473 req = d->search_request_cache_;
1474 if (req.argument().empty()) {
1475 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, "findreplace"));
1478 if (find(this, req))
1481 message(_("String not found!"));
1482 d->search_request_cache_ = req;
1486 case LFUN_WORD_REPLACE: {
1487 bool has_deleted = false;
1488 if (cur.selection()) {
1489 DocIterator beg = cur.selectionBegin();
1490 DocIterator end = cur.selectionEnd();
1491 if (beg.pit() == end.pit()) {
1492 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1494 && cur.paragraph().isDeleted(p))
1499 replace(this, cmd, has_deleted);
1503 case LFUN_WORD_FINDADV: {
1504 FindAndReplaceOptions opt;
1505 istringstream iss(to_utf8(cmd.argument()));
1507 if (findAdv(this, opt))
1515 cur.clearSelection();
1516 dr.setMessage(from_utf8(N_("Mark off")));
1520 cur.clearSelection();
1522 dr.setMessage(from_utf8(N_("Mark on")));
1525 case LFUN_MARK_TOGGLE:
1526 cur.setSelection(false);
1529 dr.setMessage(from_utf8(N_("Mark removed")));
1532 dr.setMessage(from_utf8(N_("Mark set")));
1537 case LFUN_SCREEN_SHOW_CURSOR:
1541 case LFUN_SCREEN_RECENTER:
1545 case LFUN_BIBTEX_DATABASE_ADD: {
1546 Cursor tmpcur = cur;
1547 findInset(tmpcur, BIBTEX_CODE, false);
1548 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1551 if (inset->addDatabase(cmd.argument()))
1552 buffer_.updateBibfilesCache();
1557 case LFUN_BIBTEX_DATABASE_DEL: {
1558 Cursor tmpcur = cur;
1559 findInset(tmpcur, BIBTEX_CODE, false);
1560 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1563 if (inset->delDatabase(cmd.argument()))
1564 buffer_.updateBibfilesCache();
1569 case LFUN_STATISTICS: {
1570 DocIterator from, to;
1571 if (cur.selection()) {
1572 from = cur.selectionBegin();
1573 to = cur.selectionEnd();
1575 from = doc_iterator_begin(&buffer_);
1576 to = doc_iterator_end(&buffer_);
1578 int const words = countWords(from, to);
1579 int const chars = countChars(from, to, false);
1580 int const chars_blanks = countChars(from, to, true);
1582 if (cur.selection())
1583 message = _("Statistics for the selection:");
1585 message = _("Statistics for the document:");
1588 message += bformat(_("%1$d words"), words);
1590 message += _("One word");
1592 if (chars_blanks != 1)
1593 message += bformat(_("%1$d characters (including blanks)"),
1596 message += _("One character (including blanks)");
1599 message += bformat(_("%1$d characters (excluding blanks)"),
1602 message += _("One character (excluding blanks)");
1604 Alert::information(_("Statistics"), message);
1608 case LFUN_BUFFER_TOGGLE_COMPRESSION:
1609 // turn compression on/off
1610 buffer_.params().compressed = !buffer_.params().compressed;
1613 case LFUN_LABEL_COPY_AS_REF: {
1614 // if there is an inset at cursor, try to copy it
1615 Inset * inset = &cur.inset();
1616 if (!inset || !inset->asInsetMath())
1617 inset = cur.nextInset();
1619 FuncRequest tmpcmd = cmd;
1620 inset->dispatch(cur, tmpcmd);
1622 if (!cur.result().dispatched())
1623 // It did not work too; no action needed.
1625 cur.clearSelection();
1626 dr.update(Update::SinglePar | Update::FitCursor);
1630 case LFUN_SCREEN_UP:
1631 case LFUN_SCREEN_DOWN: {
1632 Point p = getPos(cur, cur.boundary());
1633 // This code has been commented out to enable to scroll down a
1634 // document, even if there are large insets in it (see bug #5465).
1635 /*if (p.y_ < 0 || p.y_ > height_) {
1636 // The cursor is off-screen so recenter before proceeding.
1638 p = getPos(cur, cur.boundary());
1640 int const scrolled = scroll(act == LFUN_SCREEN_UP
1641 ? -height_ : height_);
1642 if (act == LFUN_SCREEN_UP && scrolled > -height_)
1644 if (act == LFUN_SCREEN_DOWN && scrolled < height_)
1645 p = Point(width_, height_);
1647 bool const in_texted = cur.inTexted();
1649 buffer_.changed(true);
1650 updateHoveredInset();
1652 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_,
1653 true, act == LFUN_SCREEN_UP);
1654 //FIXME: what to do with cur.x_target()?
1655 bool update = in_texted && cur.bv().checkDepm(cur, old);
1658 dr.update(Update::Force | Update::FitCursor);
1666 case LFUN_SCREEN_UP_SELECT: {
1667 cur.selHandle(true);
1668 if (isTopScreen()) {
1669 lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1673 int y = getPos(cur, cur.boundary()).y_;
1674 int const ymin = y - height_ + defaultRowHeight();
1675 while (y > ymin && cur.up())
1676 y = getPos(cur, cur.boundary()).y_;
1679 dr.update(Update::SinglePar | Update::FitCursor);
1683 case LFUN_SCREEN_DOWN_SELECT: {
1684 cur.selHandle(true);
1685 if (isBottomScreen()) {
1686 lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1690 int y = getPos(cur, cur.boundary()).y_;
1691 int const ymax = y + height_ - defaultRowHeight();
1692 while (y < ymax && cur.down())
1693 y = getPos(cur, cur.boundary()).y_;
1696 dr.update(Update::SinglePar | Update::FitCursor);
1701 // This would be in Buffer class if only Cursor did not
1702 // require a bufferview
1703 case LFUN_INSET_FORALL: {
1704 docstring const name = from_utf8(cmd.getArg(0));
1705 string const commandstr = cmd.getLongArg(1);
1706 FuncRequest const fr = lyxaction.lookupFunc(commandstr);
1708 // an arbitrary number to limit number of iterations
1709 const int max_iter = 10000;
1711 Cursor & cur = d->cursor_;
1712 Cursor const savecur = cur;
1714 if (!cur.nextInset())
1716 cur.beginUndoGroup();
1717 while(cur && iterations < max_iter) {
1718 Inset * ins = cur.nextInset();
1721 docstring insname = ins->name();
1722 while (!insname.empty()) {
1723 if (insname == name || name == from_utf8("*")) {
1725 lyx::dispatch(fr, dr);
1729 size_t const i = insname.rfind(':');
1730 if (i == string::npos)
1732 insname = insname.substr(0, i);
1739 dr.update(Update::Force);
1741 if (iterations >= max_iter) {
1743 dr.setMessage(bformat(_("`inset-forall' interrupted because number of actions is larger than %1$d"), max_iter));
1745 dr.setMessage(bformat(_("Applied \"%1$s\" to %2$d insets"), from_utf8(commandstr), iterations));
1750 case LFUN_BRANCH_ADD_INSERT: {
1751 docstring branch_name = from_utf8(cmd.getArg(0));
1752 if (branch_name.empty())
1753 if (!Alert::askForText(branch_name, _("Branch name")) ||
1754 branch_name.empty())
1757 DispatchResult drtmp;
1758 buffer_.dispatch(FuncRequest(LFUN_BRANCH_ADD, branch_name), drtmp);
1759 if (drtmp.error()) {
1760 Alert::warning(_("Branch already exists"), drtmp.message());
1763 lyx::dispatch(FuncRequest(LFUN_BRANCH_INSERT, branch_name));
1767 case LFUN_KEYMAP_OFF:
1768 getIntl().keyMapOn(false);
1771 case LFUN_KEYMAP_PRIMARY:
1772 getIntl().keyMapPrim();
1775 case LFUN_KEYMAP_SECONDARY:
1776 getIntl().keyMapSec();
1779 case LFUN_KEYMAP_TOGGLE:
1780 getIntl().toggleKeyMap();
1783 case LFUN_DIALOG_SHOW_NEW_INSET: {
1784 string const name = cmd.getArg(0);
1785 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
1786 if (decodeInsetParam(name, data, buffer_))
1787 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
1789 lyxerr << "Inset type '" << name <<
1790 "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" << endl;
1794 case LFUN_CITATION_INSERT: {
1795 if (argument.empty()) {
1796 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
1799 // we can have one optional argument, delimited by '|'
1800 // citation-insert <key>|<text_before>
1801 // this should be enhanced to also support text_after
1802 // and citation style
1803 string arg = argument;
1805 if (contains(argument, "|")) {
1806 arg = token(argument, '|', 0);
1807 opt1 = token(argument, '|', 1);
1809 InsetCommandParams icp(CITE_CODE);
1810 icp["key"] = from_utf8(arg);
1812 icp["before"] = from_utf8(opt1);
1813 string icstr = InsetCommand::params2string("citation", icp);
1814 FuncRequest fr(LFUN_INSET_INSERT, icstr);
1819 case LFUN_INSET_APPLY: {
1820 string const name = cmd.getArg(0);
1821 Inset * inset = editedInset(name);
1823 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1827 // put cursor in front of inset.
1828 if (!setCursorFromInset(inset)) {
1829 LASSERT(false, break);
1832 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1833 inset->dispatch(cur, fr);
1834 dr.update(Update::SinglePar | Update::FitCursor);
1843 buffer_.undo().endUndoGroup();
1844 dr.dispatched(dispatched);
1849 docstring const BufferView::requestSelection()
1851 Cursor & cur = d->cursor_;
1853 LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
1854 if (!cur.selection()) {
1855 d->xsel_cache_.set = false;
1859 LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
1860 if (!d->xsel_cache_.set ||
1861 cur.top() != d->xsel_cache_.cursor ||
1862 cur.anchor_.top() != d->xsel_cache_.anchor)
1864 d->xsel_cache_.cursor = cur.top();
1865 d->xsel_cache_.anchor = cur.anchor_.top();
1866 d->xsel_cache_.set = cur.selection();
1867 return cur.selectionAsString(false);
1873 void BufferView::clearSelection()
1875 d->cursor_.clearSelection();
1876 // Clear the selection buffer. Otherwise a subsequent
1877 // middle-mouse-button paste would use the selection buffer,
1878 // not the more current external selection.
1879 cap::clearSelection();
1880 d->xsel_cache_.set = false;
1881 // The buffer did not really change, but this causes the
1882 // redraw we need because we cleared the selection above.
1883 buffer_.changed(false);
1887 void BufferView::resize(int width, int height)
1889 // Update from work area
1893 // Clear the paragraph height cache.
1894 d->par_height_.clear();
1895 // Redo the metrics.
1900 Inset const * BufferView::getCoveringInset(Text const & text,
1903 TextMetrics & tm = d->text_metrics_[&text];
1904 Inset * inset = tm.checkInsetHit(x, y);
1908 if (!inset->descendable(*this))
1909 // No need to go further down if the inset is not
1913 size_t cell_number = inset->nargs();
1914 // Check all the inner cell.
1915 for (size_t i = 0; i != cell_number; ++i) {
1916 Text const * inner_text = inset->getText(i);
1919 Inset const * inset_deeper =
1920 getCoveringInset(*inner_text, x, y);
1922 return inset_deeper;
1930 void BufferView::updateHoveredInset() const
1932 // Get inset under mouse, if there is one.
1933 Inset const * covering_inset = getCoveringInset(buffer_.text(),
1934 d->mouse_position_cache_.x_, d->mouse_position_cache_.y_);
1935 if (covering_inset == d->last_inset_)
1936 // Same inset, no need to do anything...
1939 bool need_redraw = false;
1941 // Remove the hint on the last hovered inset (if any).
1942 need_redraw |= d->last_inset_->setMouseHover(false);
1944 // const_cast because of setMouseHover().
1945 Inset * inset = const_cast<Inset *>(covering_inset);
1947 // Highlight the newly hovered inset (if any).
1948 need_redraw |= inset->setMouseHover(true);
1950 d->last_inset_ = inset;
1953 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
1954 << d->mouse_position_cache_.x_ << ", "
1955 << d->mouse_position_cache_.y_ << ")");
1957 d->update_strategy_ = DecorationUpdate;
1959 // This event (moving without mouse click) is not passed further.
1960 // This should be changed if it is further utilized.
1961 buffer_.changed(false);
1966 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
1968 //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
1970 // This is only called for mouse related events including
1971 // LFUN_FILE_OPEN generated by drag-and-drop.
1972 FuncRequest cmd = cmd0;
1974 Cursor old = cursor();
1976 cur.push(buffer_.inset());
1977 cur.setSelection(d->cursor_.selection());
1979 // Either the inset under the cursor or the
1980 // surrounding Text will handle this event.
1982 // make sure we stay within the screen...
1983 cmd.set_y(min(max(cmd.y(), -1), height_));
1985 d->mouse_position_cache_.x_ = cmd.x();
1986 d->mouse_position_cache_.y_ = cmd.y();
1988 if (cmd.action() == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
1989 updateHoveredInset();
1993 // Build temporary cursor.
1994 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x(), cmd.y());
1996 // Put anchor at the same position.
1999 cur.beginUndoGroup();
2001 // Try to dispatch to an non-editable inset near this position
2002 // via the temp cursor. If the inset wishes to change the real
2003 // cursor it has to do so explicitly by using
2004 // cur.bv().cursor() = cur; (or similar)
2006 inset->dispatch(cur, cmd);
2008 // Now dispatch to the temporary cursor. If the real cursor should
2009 // be modified, the inset's dispatch has to do so explicitly.
2010 if (!inset || !cur.result().dispatched())
2015 // Notify left insets
2018 bool badcursor = notifyCursorLeavesOrEnters(old, cur);
2020 cursor().fixIfBroken();
2023 // Do we have a selection?
2024 theSelection().haveSelection(cursor().selection());
2026 // If the command has been dispatched,
2027 if (cur.result().dispatched() || cur.result().update())
2028 processUpdateFlags(cur.result().update());
2032 void BufferView::lfunScroll(FuncRequest const & cmd)
2034 string const scroll_type = cmd.getArg(0);
2035 int scroll_step = 0;
2036 if (scroll_type == "line")
2037 scroll_step = d->scrollbarParameters_.single_step;
2038 else if (scroll_type == "page")
2039 scroll_step = d->scrollbarParameters_.page_step;
2042 string const scroll_quantity = cmd.getArg(1);
2043 if (scroll_quantity == "up")
2044 scrollUp(scroll_step);
2045 else if (scroll_quantity == "down")
2046 scrollDown(scroll_step);
2048 int const scroll_value = convert<int>(scroll_quantity);
2050 scroll(scroll_step * scroll_value);
2052 buffer_.changed(true);
2053 updateHoveredInset();
2057 int BufferView::minVisiblePart()
2059 return 2 * defaultRowHeight();
2063 int BufferView::scroll(int y)
2066 return scrollDown(y);
2068 return scrollUp(-y);
2073 int BufferView::scrollDown(int offset)
2075 Text * text = &buffer_.text();
2076 TextMetrics & tm = d->text_metrics_[text];
2077 int const ymax = height_ + offset;
2079 pair<pit_type, ParagraphMetrics const *> last = tm.last();
2080 int bottom_pos = last.second->position() + last.second->descent();
2081 if (lyxrc.scroll_below_document)
2082 bottom_pos += height_ - minVisiblePart();
2083 if (last.first + 1 == int(text->paragraphs().size())) {
2084 if (bottom_pos <= height_)
2086 offset = min(offset, bottom_pos - height_);
2089 if (bottom_pos > ymax)
2091 tm.newParMetricsDown();
2093 d->anchor_ypos_ -= offset;
2098 int BufferView::scrollUp(int offset)
2100 Text * text = &buffer_.text();
2101 TextMetrics & tm = d->text_metrics_[text];
2102 int ymin = - offset;
2104 pair<pit_type, ParagraphMetrics const *> first = tm.first();
2105 int top_pos = first.second->position() - first.second->ascent();
2106 if (first.first == 0) {
2109 offset = min(offset, - top_pos);
2114 tm.newParMetricsUp();
2116 d->anchor_ypos_ += offset;
2121 void BufferView::setCursorFromRow(int row)
2126 buffer_.texrow().getIdFromRow(row, tmpid, tmppos);
2130 buffer_.text().setCursor(d->cursor_, 0, 0);
2132 buffer_.text().setCursor(d->cursor_, buffer_.getParFromID(tmpid).pit(), tmppos);
2137 bool BufferView::setCursorFromInset(Inset const * inset)
2139 // are we already there?
2140 if (cursor().nextInset() == inset)
2143 // Inset is not at cursor position. Find it in the document.
2146 while (cur && cur.nextInset() != inset)
2157 void BufferView::gotoLabel(docstring const & label)
2159 std::vector<Buffer const *> bufs = buffer().allRelatives();
2160 std::vector<Buffer const *>::iterator it = bufs.begin();
2161 for (; it != bufs.end(); ++it) {
2162 Buffer const * buf = *it;
2165 Toc & toc = buf->tocBackend().toc("label");
2166 TocIterator toc_it = toc.begin();
2167 TocIterator end = toc.end();
2168 for (; toc_it != end; ++toc_it) {
2169 if (label == toc_it->str()) {
2170 lyx::dispatch(toc_it->action());
2178 TextMetrics const & BufferView::textMetrics(Text const * t) const
2180 return const_cast<BufferView *>(this)->textMetrics(t);
2184 TextMetrics & BufferView::textMetrics(Text const * t)
2186 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
2187 if (tmc_it == d->text_metrics_.end()) {
2188 tmc_it = d->text_metrics_.insert(
2189 make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
2191 return tmc_it->second;
2195 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
2198 return textMetrics(t).parMetrics(pit);
2202 int BufferView::workHeight() const
2208 void BufferView::setCursor(DocIterator const & dit)
2211 size_t const n = dit.depth();
2212 for (size_t i = 0; i < n; ++i)
2213 dit[i].inset().edit(d->cursor_, true);
2215 d->cursor_.setCursor(dit);
2216 d->cursor_.setSelection(false);
2220 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
2222 // Would be wrong to delete anything if we have a selection.
2223 if (cur.selection())
2226 bool need_anchor_change = false;
2227 bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
2228 need_anchor_change);
2230 if (need_anchor_change)
2238 buffer_.updateBuffer();
2239 buffer_.changed(true);
2244 bool BufferView::mouseSetCursor(Cursor & cur, bool select)
2246 LASSERT(&cur.bv() == this, /**/);
2249 // this event will clear selection so we save selection for
2250 // persistent selection
2251 cap::saveSelection(cursor());
2253 d->cursor_.macroModeClose();
2255 // Has the cursor just left the inset?
2256 bool leftinset = (&d->cursor_.inset() != &cur.inset());
2258 d->cursor_.fixIfBroken();
2260 // FIXME: shift-mouse selection doesn't work well across insets.
2261 bool do_selection = select && &d->cursor_.normalAnchor().inset() == &cur.inset();
2263 // do the dEPM magic if needed
2264 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
2265 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
2266 // the leftinset bool would not be necessary (badcursor instead).
2267 bool update = leftinset;
2268 if (!do_selection && d->cursor_.inTexted())
2269 update |= checkDepm(cur, d->cursor_);
2272 d->cursor_.resetAnchor();
2273 d->cursor_.setCursor(cur);
2274 d->cursor_.boundary(cur.boundary());
2276 d->cursor_.setSelection();
2278 d->cursor_.clearSelection();
2280 d->cursor_.finishUndo();
2281 d->cursor_.setCurrentFont();
2286 void BufferView::putSelectionAt(DocIterator const & cur,
2287 int length, bool backwards)
2289 d->cursor_.clearSelection();
2295 d->cursor_.pos() += length;
2296 d->cursor_.setSelection(d->cursor_, -length);
2298 d->cursor_.setSelection(d->cursor_, length);
2300 // Ensure a redraw happens in any case because the new selection could
2301 // possibly be on the same screen as the previous selection.
2302 processUpdateFlags(Update::Force | Update::FitCursor);
2306 Cursor & BufferView::cursor()
2312 Cursor const & BufferView::cursor() const
2318 pit_type BufferView::anchor_ref() const
2320 return d->anchor_pit_;
2324 bool BufferView::singleParUpdate()
2326 Text & buftext = buffer_.text();
2327 pit_type const bottom_pit = d->cursor_.bottom().pit();
2328 TextMetrics & tm = textMetrics(&buftext);
2329 int old_height = tm.parMetrics(bottom_pit).height();
2331 // make sure inline completion pointer is ok
2332 if (d->inlineCompletionPos_.fixIfBroken())
2333 d->inlineCompletionPos_ = DocIterator();
2335 // In Single Paragraph mode, rebreak only
2336 // the (main text, not inset!) paragraph containing the cursor.
2337 // (if this paragraph contains insets etc., rebreaking will
2338 // recursively descend)
2339 tm.redoParagraph(bottom_pit);
2340 ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
2341 if (pm.height() != old_height)
2342 // Paragraph height has changed so we cannot proceed to
2343 // the singlePar optimisation.
2346 d->update_strategy_ = SingleParUpdate;
2348 LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
2349 << " y2: " << pm.position() + pm.descent()
2350 << " pit: " << bottom_pit
2351 << " singlepar: 1");
2356 void BufferView::updateMetrics()
2358 if (height_ == 0 || width_ == 0)
2361 Text & buftext = buffer_.text();
2362 pit_type const npit = int(buftext.paragraphs().size());
2364 // Clear out the position cache in case of full screen redraw,
2365 d->coord_cache_.clear();
2367 // Clear out paragraph metrics to avoid having invalid metrics
2368 // in the cache from paragraphs not relayouted below
2369 // The complete text metrics will be redone.
2370 d->text_metrics_.clear();
2372 TextMetrics & tm = textMetrics(&buftext);
2374 // make sure inline completion pointer is ok
2375 if (d->inlineCompletionPos_.fixIfBroken())
2376 d->inlineCompletionPos_ = DocIterator();
2378 if (d->anchor_pit_ >= npit)
2379 // The anchor pit must have been deleted...
2380 d->anchor_pit_ = npit - 1;
2382 // Rebreak anchor paragraph.
2383 tm.redoParagraph(d->anchor_pit_);
2384 ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
2387 if (d->anchor_pit_ == 0) {
2388 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
2390 // Complete buffer visible? Then it's easy.
2391 if (scrollRange == 0)
2392 d->anchor_ypos_ = anchor_pm.ascent();
2394 // FIXME: Some clever handling needed to show
2395 // the _first_ paragraph up to the top if the cursor is
2396 // in the first line.
2398 anchor_pm.setPosition(d->anchor_ypos_);
2400 LYXERR(Debug::PAINTING, "metrics: "
2401 << " anchor pit = " << d->anchor_pit_
2402 << " anchor ypos = " << d->anchor_ypos_);
2404 // Redo paragraphs above anchor if necessary.
2405 int y1 = d->anchor_ypos_ - anchor_pm.ascent();
2406 // We are now just above the anchor paragraph.
2407 pit_type pit1 = d->anchor_pit_ - 1;
2408 for (; pit1 >= 0 && y1 >= 0; --pit1) {
2409 tm.redoParagraph(pit1);
2410 ParagraphMetrics & pm = tm.par_metrics_[pit1];
2412 // Save the paragraph position in the cache.
2417 // Redo paragraphs below the anchor if necessary.
2418 int y2 = d->anchor_ypos_ + anchor_pm.descent();
2419 // We are now just below the anchor paragraph.
2420 pit_type pit2 = d->anchor_pit_ + 1;
2421 for (; pit2 < npit && y2 <= height_; ++pit2) {
2422 tm.redoParagraph(pit2);
2423 ParagraphMetrics & pm = tm.par_metrics_[pit2];
2425 // Save the paragraph position in the cache.
2430 LYXERR(Debug::PAINTING, "Metrics: "
2431 << " anchor pit = " << d->anchor_pit_
2432 << " anchor ypos = " << d->anchor_ypos_
2435 << " pit1 = " << pit1
2436 << " pit2 = " << pit2);
2438 d->update_strategy_ = FullScreenUpdate;
2440 if (lyxerr.debugging(Debug::WORKAREA)) {
2441 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
2442 d->coord_cache_.dump();
2447 void BufferView::insertLyXFile(FileName const & fname)
2449 LASSERT(d->cursor_.inTexted(), /**/);
2451 // Get absolute path of file and add ".lyx"
2452 // to the filename if necessary
2453 FileName filename = fileSearch(string(), fname.absFilename(), "lyx");
2455 docstring const disp_fn = makeDisplayPath(filename.absFilename());
2456 // emit message signal.
2457 message(bformat(_("Inserting document %1$s..."), disp_fn));
2460 Buffer buf("", false);
2461 if (buf.loadLyXFile(filename)) {
2462 ErrorList & el = buffer_.errorList("Parse");
2463 // Copy the inserted document error list into the current buffer one.
2464 el = buf.errorList("Parse");
2465 buffer_.undo().recordUndo(d->cursor_);
2466 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
2467 buf.params().documentClassPtr(), el);
2468 res = _("Document %1$s inserted.");
2470 res = _("Could not insert document %1$s");
2473 buffer_.changed(true);
2474 // emit message signal.
2475 message(bformat(res, disp_fn));
2476 buffer_.errors("Parse");
2480 Point BufferView::coordOffset(DocIterator const & dit, bool boundary) const
2486 // Addup contribution of nested insets, from inside to outside,
2487 // keeping the outer paragraph for a special handling below
2488 for (size_t i = dit.depth() - 1; i >= 1; --i) {
2489 CursorSlice const & sl = dit[i];
2493 // get relative position inside sl.inset()
2494 sl.inset().cursorPos(*this, sl, boundary && (i + 1 == dit.depth()), xx, yy);
2496 // Make relative position inside of the edited inset relative to sl.inset()
2500 // In case of an RTL inset, the edited inset will be positioned to the left
2503 bool boundary_i = boundary && i + 1 == dit.depth();
2504 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2509 // remember width for the case that sl.inset() is positioned in an RTL inset
2510 if (i && dit[i - 1].text()) {
2511 // If this Inset is inside a Text Inset, retrieve the Dimension
2512 // from the containing text instead of using Inset::dimension() which
2513 // might not be implemented.
2514 // FIXME (Abdel 23/09/2007): this is a bit messy because of the
2515 // elimination of Inset::dim_ cache. This coordOffset() method needs
2516 // to be rewritten in light of the new design.
2517 Dimension const & dim = parMetrics(dit[i - 1].text(),
2518 dit[i - 1].pit()).insetDimension(&sl.inset());
2521 Dimension const dim = sl.inset().dimension(*this);
2525 //lyxerr << "Cursor::getPos, i: "
2526 // << i << " x: " << xx << " y: " << y << endl;
2529 // Add contribution of initial rows of outermost paragraph
2530 CursorSlice const & sl = dit[0];
2531 TextMetrics const & tm = textMetrics(sl.text());
2532 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2533 LASSERT(!pm.rows().empty(), /**/);
2534 y -= pm.rows()[0].ascent();
2536 // FIXME: document this mess
2538 if (sl.pos() > 0 && dit.depth() == 1) {
2540 if (pos && boundary)
2542 // lyxerr << "coordOffset: boundary:" << boundary << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
2543 rend = pm.pos2row(pos);
2545 rend = pm.pos2row(sl.pos());
2547 size_t rend = pm.pos2row(sl.pos());
2549 for (size_t rit = 0; rit != rend; ++rit)
2550 y += pm.rows()[rit].height();
2551 y += pm.rows()[rend].ascent();
2553 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
2555 // Make relative position from the nested inset now bufferview absolute.
2556 int xx = bottom_tm.cursorX(dit.bottom(), boundary && dit.depth() == 1);
2559 // In the RTL case place the nested inset at the left of the cursor in
2560 // the outer paragraph
2561 bool boundary_1 = boundary && 1 == dit.depth();
2562 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
2570 Point BufferView::getPos(DocIterator const & dit, bool boundary) const
2572 if (!paragraphVisible(dit))
2573 return Point(-1, -1);
2575 CursorSlice const & bot = dit.bottom();
2576 TextMetrics const & tm = textMetrics(bot.text());
2578 Point p = coordOffset(dit, boundary); // offset from outer paragraph
2579 p.y_ += tm.parMetrics(bot.pit()).position();
2584 bool BufferView::paragraphVisible(DocIterator const & dit) const
2586 CursorSlice const & bot = dit.bottom();
2587 TextMetrics const & tm = textMetrics(bot.text());
2589 return tm.contains(bot.pit());
2593 void BufferView::cursorPosAndHeight(Point & p, int & h) const
2595 Cursor const & cur = cursor();
2596 Font const font = cur.getFont();
2597 frontend::FontMetrics const & fm = theFontMetrics(font);
2598 int const asc = fm.maxAscent();
2599 int const des = fm.maxDescent();
2601 p = getPos(cur, cur.boundary());
2606 bool BufferView::cursorInView(Point const & p, int h) const
2608 Cursor const & cur = cursor();
2609 // does the cursor touch the screen ?
2610 if (p.y_ + h < 0 || p.y_ >= workHeight() || !paragraphVisible(cur))
2616 void BufferView::draw(frontend::Painter & pain)
2618 if (height_ == 0 || width_ == 0)
2620 LYXERR(Debug::PAINTING, "\t\t*** START DRAWING ***");
2622 Text & text = buffer_.text();
2623 TextMetrics const & tm = d->text_metrics_[&text];
2624 int const y = tm.first().second->position();
2625 PainterInfo pi(this, pain);
2627 switch (d->update_strategy_) {
2629 case NoScreenUpdate:
2630 // If no screen painting is actually needed, only some the different
2631 // coordinates of insets and paragraphs needs to be updated.
2632 pi.full_repaint = true;
2633 pi.pain.setDrawingEnabled(false);
2637 case SingleParUpdate:
2638 pi.full_repaint = false;
2639 // In general, only the current row of the outermost paragraph
2640 // will be redrawn. Particular cases where selection spans
2641 // multiple paragraph are correctly detected in TextMetrics.
2645 case DecorationUpdate:
2646 // FIXME: We should also distinguish DecorationUpdate to avoid text
2647 // drawing if possible. This is not possible to do easily right now
2648 // because of the single backing pixmap.
2650 case FullScreenUpdate:
2651 // The whole screen, including insets, will be refreshed.
2652 pi.full_repaint = true;
2654 // Clear background.
2655 pain.fillRectangle(0, 0, width_, height_,
2656 pi.backgroundColor(&buffer_.inset()));
2661 // and possibly grey out below
2662 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2663 int const y2 = lastpm.second->position() + lastpm.second->descent();
2666 Color color = buffer().isInternal()
2667 ? Color_background : Color_bottomarea;
2668 pain.fillRectangle(0, y2, width_, height_ - y2, color);
2672 LYXERR(Debug::PAINTING, "\n\t\t*** END DRAWING ***");
2674 // The scrollbar needs an update.
2677 // Normalize anchor for next time
2678 pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
2679 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2680 for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
2681 ParagraphMetrics const & pm = tm.parMetrics(pit);
2682 if (pm.position() + pm.descent() > 0) {
2683 d->anchor_pit_ = pit;
2684 d->anchor_ypos_ = pm.position();
2688 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
2689 << " anchor ypos = " << d->anchor_ypos_);
2693 void BufferView::message(docstring const & msg)
2696 d->gui_->message(msg);
2700 void BufferView::showDialog(string const & name)
2703 d->gui_->showDialog(name, string());
2707 void BufferView::showDialog(string const & name,
2708 string const & data, Inset * inset)
2711 d->gui_->showDialog(name, data, inset);
2715 void BufferView::updateDialog(string const & name, string const & data)
2718 d->gui_->updateDialog(name, data);
2722 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
2728 // FIXME: Move this out of BufferView again
2729 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
2731 if (!fname.isReadableFile()) {
2732 docstring const error = from_ascii(strerror(errno));
2733 docstring const file = makeDisplayPath(fname.absFilename(), 50);
2734 docstring const text =
2735 bformat(_("Could not read the specified document\n"
2736 "%1$s\ndue to the error: %2$s"), file, error);
2737 Alert::error(_("Could not read file"), text);
2741 if (!fname.isReadableFile()) {
2742 docstring const file = makeDisplayPath(fname.absFilename(), 50);
2743 docstring const text =
2744 bformat(_("%1$s\n is not readable."), file);
2745 Alert::error(_("Could not open file"), text);
2749 // FIXME UNICODE: We don't know the encoding of the file
2750 docstring file_content = fname.fileContents("UTF-8");
2751 if (file_content.empty()) {
2752 Alert::error(_("Reading not UTF-8 encoded file"),
2753 _("The file is not UTF-8 encoded.\n"
2754 "It will be read as local 8Bit-encoded.\n"
2755 "If this does not give the correct result\n"
2756 "then please change the encoding of the file\n"
2757 "to UTF-8 with a program other than LyX.\n"));
2758 file_content = fname.fileContents("local8bit");
2761 return normalize_c(file_content);
2765 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
2767 docstring const tmpstr = contentsOfPlaintextFile(f);
2772 Cursor & cur = cursor();
2773 cap::replaceSelection(cur);
2774 buffer_.undo().recordUndo(cur);
2776 cur.innerText()->insertStringAsParagraphs(cur, tmpstr, cur.current_font);
2778 cur.innerText()->insertStringAsLines(cur, tmpstr, cur.current_font);
2780 buffer_.changed(true);
2784 docstring const & BufferView::inlineCompletion() const
2786 return d->inlineCompletion_;
2790 size_t const & BufferView::inlineCompletionUniqueChars() const
2792 return d->inlineCompletionUniqueChars_;
2796 DocIterator const & BufferView::inlineCompletionPos() const
2798 return d->inlineCompletionPos_;
2802 bool samePar(DocIterator const & a, DocIterator const & b)
2804 if (a.empty() && b.empty())
2806 if (a.empty() || b.empty())
2808 if (a.depth() != b.depth())
2810 return &a.innerParagraph() == &b.innerParagraph();
2814 void BufferView::setInlineCompletion(Cursor & cur, DocIterator const & pos,
2815 docstring const & completion, size_t uniqueChars)
2817 uniqueChars = min(completion.size(), uniqueChars);
2818 bool changed = d->inlineCompletion_ != completion
2819 || d->inlineCompletionUniqueChars_ != uniqueChars;
2820 bool singlePar = true;
2821 d->inlineCompletion_ = completion;
2822 d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
2824 //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
2827 DocIterator const & old = d->inlineCompletionPos_;
2829 //lyxerr << "inlineCompletionPos changed" << std::endl;
2830 // old or pos are in another paragraph?
2831 if ((!samePar(cur, pos) && !pos.empty())
2832 || (!samePar(cur, old) && !old.empty())) {
2834 //lyxerr << "different paragraph" << std::endl;
2836 d->inlineCompletionPos_ = pos;
2841 if (singlePar && !(cur.result().update() & Update::Force))
2842 cur.updateFlags(cur.result().update() | Update::SinglePar);
2844 cur.updateFlags(cur.result().update() | Update::Force);