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"
45 #include "MetricsInfo.h"
46 #include "Paragraph.h"
47 #include "ParagraphParameters.h"
48 #include "ParIterator.h"
51 #include "TextClass.h"
52 #include "TextMetrics.h"
54 #include "TocBackend.h"
56 #include "WordLangTuple.h"
58 #include "insets/InsetBibtex.h"
59 #include "insets/InsetCommand.h" // ChangeRefs
60 #include "insets/InsetExternal.h"
61 #include "insets/InsetGraphics.h"
62 #include "insets/InsetRef.h"
63 #include "insets/InsetText.h"
64 #include "insets/InsetNote.h"
66 #include "frontends/alert.h"
67 #include "frontends/Application.h"
68 #include "frontends/Delegates.h"
69 #include "frontends/FontMetrics.h"
70 #include "frontends/Painter.h"
71 #include "frontends/Selection.h"
73 #include "graphics/Previews.h"
75 #include "support/convert.h"
76 #include "support/debug.h"
77 #include "support/ExceptionMessage.h"
78 #include "support/filetools.h"
79 #include "support/gettext.h"
80 #include "support/lstrings.h"
81 #include "support/Package.h"
82 #include "support/types.h"
92 using namespace lyx::support;
96 namespace Alert = frontend::Alert;
100 /// Return an inset of this class if it exists at the current cursor position
102 T * getInsetByCode(Cursor const & cur, InsetCode code)
104 DocIterator it = cur;
105 Inset * inset = it.nextInset();
106 if (inset && inset->lyxCode() == code)
107 return static_cast<T*>(inset);
112 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
115 bool findNextInset(DocIterator & dit, vector<InsetCode> const & codes,
116 docstring const & contents)
118 DocIterator tmpdit = dit;
121 Inset const * inset = tmpdit.nextInset();
123 && std::find(codes.begin(), codes.end(), inset->lyxCode()) != codes.end()
124 && (contents.empty() ||
125 static_cast<InsetCommand const *>(inset)->getFirstNonOptParam() == contents)) {
129 tmpdit.forwardInset();
136 /// Looks for next inset with one of the given codes.
137 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
141 DocIterator tmpdit = dit;
142 tmpdit.forwardInset();
147 Inset const * inset = tmpdit.nextInset();
149 && std::find(codes.begin(), codes.end(), inset->lyxCode()) != codes.end()) {
150 contents = static_cast<InsetCommand const *>(inset)->getFirstNonOptParam();
154 if (!findNextInset(tmpdit, codes, contents)) {
155 if (dit.depth() != 1 || dit.pit() != 0 || dit.pos() != 0) {
156 Inset * inset = &tmpdit.bottom().inset();
157 tmpdit = doc_iterator_begin(&inset->buffer(), inset);
158 if (!findNextInset(tmpdit, codes, contents))
170 /// Looks for next inset with the given code
171 void findInset(DocIterator & dit, InsetCode code, bool same_content)
173 findInset(dit, vector<InsetCode>(1, code), same_content);
177 /// Moves cursor to the next inset with one of the given codes.
178 void gotoInset(BufferView * bv, vector<InsetCode> const & codes,
181 Cursor tmpcur = bv->cursor();
182 if (!findInset(tmpcur, codes, same_content)) {
183 bv->cursor().message(_("No more insets"));
187 tmpcur.clearSelection();
188 bv->setCursor(tmpcur);
193 /// Moves cursor to the next inset with given code.
194 void gotoInset(BufferView * bv, InsetCode code, bool same_content)
196 gotoInset(bv, vector<InsetCode>(1, code), same_content);
200 /// A map from a Text to the associated text metrics
201 typedef map<Text const *, TextMetrics> TextMetricsCache;
203 enum ScreenUpdateStrategy {
213 /////////////////////////////////////////////////////////////////////
217 /////////////////////////////////////////////////////////////////////
219 struct BufferView::Private
221 Private(BufferView & bv): wh_(0), cursor_(bv),
222 anchor_pit_(0), anchor_ypos_(0),
223 inlineCompletionUniqueChars_(0),
224 last_inset_(0), 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 // cache for id of the paragraph which was edited the last time
268 int bookmark_edit_position_;
270 mutable TextMetricsCache text_metrics_;
273 /** Not owned, so don't delete.
275 frontend::GuiBufferViewDelegate * gui_;
277 /// Cache for Find Next
278 FuncRequest search_request_cache_;
281 map<string, Inset *> edited_insets_;
285 BufferView::BufferView(Buffer & buf)
286 : width_(0), height_(0), full_screen_(false), buffer_(buf),
287 d(new Private(*this))
289 d->xsel_cache_.set = false;
290 d->intl_.initKeyMapper(lyxrc.use_kbmap);
292 d->cursor_.setBuffer(&buf);
293 d->cursor_.push(buffer_.inset());
294 d->cursor_.resetAnchor();
295 d->cursor_.setCurrentFont();
297 if (graphics::Previews::status() != LyXRC::PREVIEW_OFF)
298 thePreviews().generateBufferPreviews(buffer_);
302 BufferView::~BufferView()
304 // current buffer is going to be switched-off, save cursor pos
305 // Ideally, the whole cursor stack should be saved, but session
306 // currently can only handle bottom (whole document) level pit and pos.
307 // That is to say, if a cursor is in a nested inset, it will be
308 // restore to the left of the top level inset.
309 LastFilePosSection::FilePos fp;
310 fp.pit = d->cursor_.bottom().pit();
311 fp.pos = d->cursor_.bottom().pos();
312 theSession().lastFilePos().save(buffer_.fileName(), fp);
318 int BufferView::rightMargin() const
320 // The additional test for the case the outliner is opened.
322 !lyxrc.full_screen_limit ||
323 width_ < lyxrc.full_screen_width + 20)
326 return (width_ - lyxrc.full_screen_width) / 2;
330 int BufferView::leftMargin() const
332 return rightMargin();
336 bool BufferView::isTopScreen() const
338 return d->scrollbarParameters_.position == d->scrollbarParameters_.min;
342 bool BufferView::isBottomScreen() const
344 return d->scrollbarParameters_.position == d->scrollbarParameters_.max;
348 Intl & BufferView::getIntl()
354 Intl const & BufferView::getIntl() const
360 CoordCache & BufferView::coordCache()
362 return d->coord_cache_;
366 CoordCache const & BufferView::coordCache() const
368 return d->coord_cache_;
372 Buffer & BufferView::buffer()
378 Buffer const & BufferView::buffer() const
384 bool BufferView::fitCursor()
386 if (cursorStatus(d->cursor_) == CUR_INSIDE) {
387 frontend::FontMetrics const & fm =
388 theFontMetrics(d->cursor_.getFont().fontInfo());
389 int const asc = fm.maxAscent();
390 int const des = fm.maxDescent();
391 Point const p = getPos(d->cursor_, d->cursor_.boundary());
392 if (p.y_ - asc >= 0 && p.y_ + des < height_)
399 void BufferView::processUpdateFlags(Update::flags flags)
401 // last_inset_ points to the last visited inset. This pointer may become
402 // invalid because of keyboard editing. Since all such operations
403 // causes screen update(), I reset last_inset_ to avoid such a problem.
405 // This is close to a hot-path.
406 LYXERR(Debug::DEBUG, "BufferView::processUpdateFlags()"
407 << "[fitcursor = " << (flags & Update::FitCursor)
408 << ", forceupdate = " << (flags & Update::Force)
409 << ", singlepar = " << (flags & Update::SinglePar)
410 << "] buffer: " << &buffer_);
412 buffer_.updateMacros();
414 // Now do the first drawing step if needed. This consists on updating
415 // the CoordCache in updateMetrics().
416 // The second drawing step is done in WorkArea::redraw() if needed.
418 // Case when no explicit update is requested.
420 // no need to redraw anything.
421 d->update_strategy_ = NoScreenUpdate;
425 if (flags == Update::Decoration) {
426 d->update_strategy_ = DecorationUpdate;
427 buffer_.changed(false);
431 if (flags == Update::FitCursor
432 || flags == (Update::Decoration | Update::FitCursor)) {
433 // tell the frontend to update the screen if needed.
438 if (flags & Update::Decoration) {
439 d->update_strategy_ = DecorationUpdate;
440 buffer_.changed(false);
443 // no screen update is needed.
444 d->update_strategy_ = NoScreenUpdate;
448 bool const full_metrics = flags & Update::Force || !singleParUpdate();
451 // We have to update the full screen metrics.
454 if (!(flags & Update::FitCursor)) {
455 // Nothing to do anymore. Trigger a redraw and return
456 buffer_.changed(false);
460 // updateMetrics() does not update paragraph position
461 // This is done at draw() time. So we need a redraw!
462 buffer_.changed(false);
465 // The cursor is off screen so ensure it is visible.
472 void BufferView::updateScrollbar()
474 if (height_ == 0 && width_ == 0)
477 // We prefer fixed size line scrolling.
478 d->scrollbarParameters_.single_step = defaultRowHeight();
479 // We prefer full screen page scrolling.
480 d->scrollbarParameters_.page_step = height_;
482 Text & t = buffer_.text();
483 TextMetrics & tm = d->text_metrics_[&t];
485 LYXERR(Debug::GUI, " Updating scrollbar: height: "
486 << t.paragraphs().size()
487 << " curr par: " << d->cursor_.bottom().pit()
488 << " default height " << defaultRowHeight());
490 size_t const parsize = t.paragraphs().size();
491 if (d->par_height_.size() != parsize) {
492 d->par_height_.clear();
493 // FIXME: We assume a default paragraph height of 2 rows. This
494 // should probably be pondered with the screen width.
495 d->par_height_.resize(parsize, defaultRowHeight() * 2);
498 // Look at paragraph heights on-screen
499 pair<pit_type, ParagraphMetrics const *> first = tm.first();
500 pair<pit_type, ParagraphMetrics const *> last = tm.last();
501 for (pit_type pit = first.first; pit <= last.first; ++pit) {
502 d->par_height_[pit] = tm.parMetrics(pit).height();
503 LYXERR(Debug::SCROLLING, "storing height for pit " << pit << " : "
504 << d->par_height_[pit]);
507 int top_pos = first.second->position() - first.second->ascent();
508 int bottom_pos = last.second->position() + last.second->descent();
509 bool first_visible = first.first == 0 && top_pos >= 0;
510 bool last_visible = last.first + 1 == int(parsize) && bottom_pos <= height_;
511 if (first_visible && last_visible) {
512 d->scrollbarParameters_.min = 0;
513 d->scrollbarParameters_.max = 0;
517 d->scrollbarParameters_.min = top_pos;
518 for (size_t i = 0; i != size_t(first.first); ++i)
519 d->scrollbarParameters_.min -= d->par_height_[i];
520 d->scrollbarParameters_.max = bottom_pos;
521 for (size_t i = last.first + 1; i != parsize; ++i)
522 d->scrollbarParameters_.max += d->par_height_[i];
524 d->scrollbarParameters_.position = 0;
525 // The reference is the top position so we remove one page.
526 if (lyxrc.scroll_below_document)
527 d->scrollbarParameters_.max -= minVisiblePart();
529 d->scrollbarParameters_.max -= d->scrollbarParameters_.page_step;
533 ScrollbarParameters const & BufferView::scrollbarParameters() const
535 return d->scrollbarParameters_;
539 docstring BufferView::toolTip(int x, int y) const
541 // Get inset under mouse, if there is one.
542 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
544 // No inset, no tooltip...
546 return covering_inset->toolTip(*this, x, y);
550 docstring BufferView::contextMenu(int x, int y) const
552 //If there is a selection, return the containing inset menu
553 if (d->cursor_.selection())
554 return d->cursor_.inset().contextMenu(*this, x, y);
556 // Get inset under mouse, if there is one.
557 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
559 return covering_inset->contextMenu(*this, x, y);
561 return buffer_.inset().contextMenu(*this, x, y);
565 void BufferView::scrollDocView(int value)
567 int const offset = value - d->scrollbarParameters_.position;
569 // No scrolling at all? No need to redraw anything
573 // If the offset is less than 2 screen height, prefer to scroll instead.
574 if (abs(offset) <= 2 * height_) {
575 d->anchor_ypos_ -= offset;
576 buffer_.changed(true);
580 // cut off at the top
581 if (value <= d->scrollbarParameters_.min) {
582 DocIterator dit = doc_iterator_begin(&buffer_);
584 LYXERR(Debug::SCROLLING, "scroll to top");
588 // cut off at the bottom
589 if (value >= d->scrollbarParameters_.max) {
590 DocIterator dit = doc_iterator_end(&buffer_);
593 LYXERR(Debug::SCROLLING, "scroll to bottom");
597 // find paragraph at target position
598 int par_pos = d->scrollbarParameters_.min;
600 for (; i != int(d->par_height_.size()); ++i) {
601 par_pos += d->par_height_[i];
602 if (par_pos >= value)
606 if (par_pos < value) {
607 // It seems we didn't find the correct pit so stay on the safe side and
609 LYXERR0("scrolling position not found!");
610 scrollDocView(d->scrollbarParameters_.max);
614 DocIterator dit = doc_iterator_begin(&buffer_);
616 LYXERR(Debug::SCROLLING, "value = " << value << " -> scroll to pit " << i);
621 // FIXME: this method is not working well.
622 void BufferView::setCursorFromScrollbar()
624 TextMetrics & tm = d->text_metrics_[&buffer_.text()];
626 int const height = 2 * defaultRowHeight();
627 int const first = height;
628 int const last = height_ - height;
630 Cursor const & oldcur = d->cursor_;
632 switch (cursorStatus(oldcur)) {
640 int const y = getPos(oldcur, oldcur.boundary()).y_;
641 newy = min(last, max(y, first));
645 // We reset the cursor because cursorStatus() does not
646 // work when the cursor is within mathed.
649 tm.setCursorFromCoordinates(cur, 0, newy);
651 // update the bufferview cursor and notify insets
652 // FIXME: Care about the d->cursor_ flags to redraw if needed
653 Cursor old = d->cursor_;
655 bool badcursor = notifyCursorLeavesOrEnters(old, d->cursor_);
657 d->cursor_.fixIfBroken();
661 Change const BufferView::getCurrentChange() const
663 if (!d->cursor_.selection())
664 return Change(Change::UNCHANGED);
666 DocIterator dit = d->cursor_.selectionBegin();
667 return dit.paragraph().lookupChange(dit.pos());
671 // this could be used elsewhere as well?
672 // FIXME: This does not work within mathed!
673 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
675 Point const p = getPos(dit, dit.boundary());
678 if (p.y_ > workHeight())
684 void BufferView::bookmarkEditPosition()
686 // Don't eat cpu time for each keystroke
687 if (d->cursor_.paragraph().id() == d->bookmark_edit_position_)
690 d->bookmark_edit_position_ = d->cursor_.paragraph().id();
694 void BufferView::saveBookmark(unsigned int idx)
696 // tentatively save bookmark, id and pos will be used to
697 // acturately locate a bookmark in a 'live' lyx session.
698 // pit and pos will be updated with bottom level pit/pos
700 theSession().bookmarks().save(
702 d->cursor_.bottom().pit(),
703 d->cursor_.bottom().pos(),
704 d->cursor_.paragraph().id(),
709 // emit message signal.
710 message(_("Save bookmark"));
714 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
715 int top_id, pos_type top_pos)
717 bool success = false;
720 d->cursor_.clearSelection();
722 // if a valid par_id is given, try it first
723 // This is the case for a 'live' bookmark when unique paragraph ID
724 // is used to track bookmarks.
726 dit = buffer_.getParFromID(top_id);
728 dit.pos() = min(dit.paragraph().size(), top_pos);
729 // Some slices of the iterator may not be
730 // reachable (e.g. closed collapsable inset)
731 // so the dociterator may need to be
732 // shortened. Otherwise, setCursor may crash
733 // lyx when the cursor can not be set to these
735 size_t const n = dit.depth();
736 for (size_t i = 0; i < n; ++i)
737 if (!dit[i].inset().editable()) {
745 // if top_id == 0, or searching through top_id failed
746 // This is the case for a 'restored' bookmark when only bottom
747 // (document level) pit was saved. Because of this, bookmark
748 // restoration is inaccurate. If a bookmark was within an inset,
749 // it will be restored to the left of the outmost inset that contains
751 if (bottom_pit < int(buffer_.paragraphs().size())) {
752 dit = doc_iterator_begin(&buffer_);
754 dit.pit() = bottom_pit;
755 dit.pos() = min(bottom_pos, dit.paragraph().size());
760 // Note: only bottom (document) level pit is set.
762 // set the current font.
763 d->cursor_.setCurrentFont();
764 // To center the screen on this new position we need the
765 // paragraph position which is computed at draw() time.
766 // So we need a redraw!
767 buffer_.changed(false);
776 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
778 if (lyxrc.rtl_support) {
779 if (d->cursor_.real_current_font.isRightToLeft()) {
780 if (d->intl_.keymap == Intl::PRIMARY)
781 d->intl_.keyMapSec();
783 if (d->intl_.keymap == Intl::SECONDARY)
784 d->intl_.keyMapPrim();
788 d->intl_.getTransManager().translateAndInsert(c, t, cur);
792 int BufferView::workWidth() const
798 void BufferView::recenter()
800 showCursor(d->cursor_, true);
804 void BufferView::showCursor()
806 showCursor(d->cursor_, false);
810 void BufferView::showCursor(DocIterator const & dit, bool recenter)
812 if (scrollToCursor(dit, recenter))
813 buffer_.changed(false);
817 void BufferView::scrollToCursor()
819 scrollToCursor(d->cursor_, false);
823 bool BufferView::scrollToCursor(DocIterator const & dit, bool recenter)
825 // We are not properly started yet, delay until resizing is
830 LYXERR(Debug::SCROLLING, "recentering!");
832 CursorSlice const & bot = dit.bottom();
833 TextMetrics & tm = d->text_metrics_[bot.text()];
835 pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
836 int bot_pit = bot.pit();
837 if (bot_pit > max_pit) {
838 // FIXME: Why does this happen?
839 LYXERR0("bottom pit is greater that max pit: "
840 << bot_pit << " > " << max_pit);
844 if (bot_pit == tm.first().first - 1)
845 tm.newParMetricsUp();
846 else if (bot_pit == tm.last().first + 1)
847 tm.newParMetricsDown();
849 if (tm.contains(bot_pit)) {
850 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
851 LASSERT(!pm.rows().empty(), /**/);
852 // FIXME: smooth scrolling doesn't work in mathed.
853 CursorSlice const & cs = dit.innerTextSlice();
854 int offset = coordOffset(dit, dit.boundary()).y_;
855 int ypos = pm.position() + offset;
856 Dimension const & row_dim =
857 pm.getRow(cs.pos(), dit.boundary()).dimension();
860 scrolled = scroll(ypos - height_/2);
861 else if (ypos - row_dim.ascent() < 0)
862 scrolled = scrollUp(- ypos + row_dim.ascent());
863 else if (ypos + row_dim.descent() > height_)
864 scrolled = scrollDown(ypos - height_ + defaultRowHeight() );
866 // else, nothing to do, the cursor is already visible so we just return.
874 // fix inline completion position
875 if (d->inlineCompletionPos_.fixIfBroken())
876 d->inlineCompletionPos_ = DocIterator();
878 tm.redoParagraph(bot_pit);
879 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
880 int offset = coordOffset(dit, dit.boundary()).y_;
882 d->anchor_pit_ = bot_pit;
883 CursorSlice const & cs = dit.innerTextSlice();
884 Dimension const & row_dim =
885 pm.getRow(cs.pos(), dit.boundary()).dimension();
888 d->anchor_ypos_ = height_/2;
889 else if (d->anchor_pit_ == 0)
890 d->anchor_ypos_ = offset + pm.ascent();
891 else if (d->anchor_pit_ == max_pit)
892 d->anchor_ypos_ = height_ - offset - row_dim.descent();
893 else if (offset > height_)
894 d->anchor_ypos_ = height_ - offset - defaultRowHeight();
896 d->anchor_ypos_ = defaultRowHeight() * 2;
903 void BufferView::updateLayout(DocumentClass const * const oldlayout)
905 message(_("Converting document to new document class..."));
907 StableDocIterator backcur(d->cursor_);
908 ErrorList & el = buffer_.errorList("Class Switch");
909 cap::switchBetweenClasses(
910 oldlayout, buffer_.params().documentClassPtr(),
911 static_cast<InsetText &>(buffer_.inset()), el);
913 setCursor(backcur.asDocIterator(&buffer_));
915 buffer_.errors("Class Switch");
916 buffer_.updateLabels();
919 /** Return the change status at cursor position, taking in account the
920 * status at each level of the document iterator (a table in a deleted
921 * footnote is deleted).
922 * When \param outer is true, the top slice is not looked at.
924 static Change::Type lookupChangeType(DocIterator const & dit, bool outer = false)
926 size_t const depth = dit.depth() - (outer ? 1 : 0);
928 for (size_t i = 0 ; i < depth ; ++i) {
929 CursorSlice const & slice = dit[i];
930 if (!slice.inset().inMathed()
931 && slice.pos() < slice.paragraph().size()) {
932 Change::Type const ch = slice.paragraph().lookupChange(slice.pos()).type;
933 if (ch != Change::UNCHANGED)
937 return Change::UNCHANGED;
941 bool BufferView::getStatus(FuncRequest const & cmd, FuncStatus & flag)
943 // Can we use a readonly buffer?
944 if (buffer_.isReadonly()
945 && !lyxaction.funcHasFlag(cmd.action, LyXAction::ReadOnly)
946 && !lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer)) {
947 flag.message(from_utf8(N_("Document is read-only")));
948 flag.setEnabled(false);
951 // Are we in a DELETED change-tracking region?
952 if (lookupChangeType(d->cursor_, true) == Change::DELETED
953 && !lyxaction.funcHasFlag(cmd.action, LyXAction::ReadOnly)
954 && !lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer)) {
955 flag.message(from_utf8(N_("This portion of the document is deleted.")));
956 flag.setEnabled(false);
960 Cursor & cur = d->cursor_;
962 if (cur.getStatus(cmd, flag))
965 switch (cmd.action) {
967 // FIXME: This is a bit problematic because we don't check is this is a
968 // document BufferView or not for these LFUNs. We probably have to
969 // dispatch both to currentBufferView() and, if that fails,
970 // to documentBufferView(); same as we do know for current Buffer and
971 // document Buffer. Ideally those LFUN should go to Buffer as they*
972 // operate on the full Buffer and the cursor is only needed either for
973 // an Undo record or to restore a cursor position. But we don't know
974 // how to do that inside Buffer of course.
975 case LFUN_BUFFER_PARAMS_APPLY:
976 case LFUN_LAYOUT_MODULES_CLEAR:
977 case LFUN_LAYOUT_MODULE_ADD:
978 case LFUN_LAYOUT_RELOAD:
979 case LFUN_TEXTCLASS_APPLY:
980 case LFUN_TEXTCLASS_LOAD:
981 flag.setEnabled(!buffer_.isReadonly());
985 flag.setEnabled(buffer_.undo().hasUndoStack());
988 flag.setEnabled(buffer_.undo().hasRedoStack());
990 case LFUN_FILE_INSERT:
991 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
992 case LFUN_FILE_INSERT_PLAINTEXT:
993 case LFUN_BOOKMARK_SAVE:
994 // FIXME: Actually, these LFUNS should be moved to Text
995 flag.setEnabled(cur.inTexted());
998 case LFUN_FONT_STATE:
999 case LFUN_LABEL_INSERT:
1000 case LFUN_INFO_INSERT:
1001 case LFUN_INSET_EDIT:
1002 case LFUN_PARAGRAPH_GOTO:
1003 case LFUN_NOTE_NEXT:
1004 case LFUN_REFERENCE_NEXT:
1005 case LFUN_WORD_FIND:
1006 case LFUN_WORD_FIND_FORWARD:
1007 case LFUN_WORD_FIND_BACKWARD:
1008 case LFUN_WORD_FINDADV:
1009 case LFUN_WORD_REPLACE:
1012 case LFUN_MARK_TOGGLE:
1013 case LFUN_SCREEN_RECENTER:
1014 case LFUN_SCREEN_SHOW_CURSOR:
1015 case LFUN_BIBTEX_DATABASE_ADD:
1016 case LFUN_BIBTEX_DATABASE_DEL:
1017 case LFUN_NOTES_MUTATE:
1018 case LFUN_ALL_INSETS_TOGGLE:
1019 case LFUN_STATISTICS:
1020 case LFUN_BRANCH_ADD_INSERT:
1021 case LFUN_KEYMAP_OFF:
1022 case LFUN_KEYMAP_PRIMARY:
1023 case LFUN_KEYMAP_SECONDARY:
1024 case LFUN_KEYMAP_TOGGLE:
1025 flag.setEnabled(true);
1028 case LFUN_REGEXP_MODE:
1029 // FIXME: Test if current WorkArea is the search WorkArea
1030 flag.setEnabled(buffer().isInternal() && !cur.inRegexped());
1033 case LFUN_LABEL_COPY_AS_REF: {
1034 // if there is an inset at cursor, see whether it
1036 Inset * inset = cur.nextInset();
1037 if (!inset || !inset->getStatus(cur, cmd, flag))
1038 flag.setEnabled(false);
1042 case LFUN_LABEL_GOTO: {
1043 flag.setEnabled(!cmd.argument().empty()
1044 || getInsetByCode<InsetRef>(cur, REF_CODE));
1048 case LFUN_CHANGES_TRACK:
1049 flag.setEnabled(true);
1050 flag.setOnOff(buffer_.params().trackChanges);
1053 case LFUN_CHANGES_OUTPUT:
1054 flag.setEnabled(true);
1055 flag.setOnOff(buffer_.params().outputChanges);
1058 case LFUN_CHANGES_MERGE:
1059 case LFUN_CHANGE_NEXT:
1060 case LFUN_CHANGE_PREVIOUS:
1061 case LFUN_ALL_CHANGES_ACCEPT:
1062 case LFUN_ALL_CHANGES_REJECT:
1063 // TODO: context-sensitive enabling of LFUNs
1064 // In principle, these command should only be enabled if there
1065 // is a change in the document. However, without proper
1066 // optimizations, this will inevitably result in poor performance.
1067 flag.setEnabled(true);
1070 case LFUN_BUFFER_TOGGLE_COMPRESSION: {
1071 flag.setOnOff(buffer_.params().compressed);
1075 case LFUN_SCREEN_UP:
1076 case LFUN_SCREEN_DOWN:
1078 case LFUN_SCREEN_UP_SELECT:
1079 case LFUN_SCREEN_DOWN_SELECT:
1080 case LFUN_INSET_FORALL:
1081 flag.setEnabled(true);
1084 case LFUN_LAYOUT_TABULAR:
1085 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
1089 flag.setEnabled(!cur.inset().forcePlainLayout(cur.idx()));
1092 case LFUN_LAYOUT_PARAGRAPH:
1093 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
1096 case LFUN_DIALOG_SHOW_NEW_INSET:
1097 // FIXME: this is wrong, but I do not understand the
1099 if (cur.inset().lyxCode() == CAPTION_CODE)
1100 return cur.inset().getStatus(cur, cmd, flag);
1101 // FIXME we should consider passthru paragraphs too.
1102 flag.setEnabled(!cur.inset().getLayout().isPassThru());
1105 case LFUN_CITATION_INSERT: {
1106 FuncRequest fr(LFUN_INSET_INSERT, "citation");
1107 // FIXME: This could turn in a recursive hell.
1108 // Shouldn't we use Buffer::getStatus() instead?
1109 flag.setEnabled(lyx::getStatus(fr).enabled());
1112 case LFUN_INSET_APPLY: {
1113 string const name = cmd.getArg(0);
1114 Inset * inset = editedInset(name);
1116 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1118 if (!inset->getStatus(cur, fr, fs)) {
1119 // Every inset is supposed to handle this
1120 LASSERT(false, break);
1124 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1125 flag |= lyx::getStatus(fr);
1131 flag.setEnabled(false);
1139 Inset * BufferView::editedInset(string const & name) const
1141 map<string, Inset *>::const_iterator it = d->edited_insets_.find(name);
1142 return it == d->edited_insets_.end() ? 0 : it->second;
1146 void BufferView::editInset(string const & name, Inset * inset)
1148 d->edited_insets_[name] = inset;
1152 bool BufferView::dispatch(FuncRequest const & cmd)
1154 //lyxerr << [ cmd = " << cmd << "]" << endl;
1156 // Make sure that the cached BufferView is correct.
1157 LYXERR(Debug::ACTION, " action[" << cmd.action << ']'
1158 << " arg[" << to_utf8(cmd.argument()) << ']'
1159 << " x[" << cmd.x << ']'
1160 << " y[" << cmd.y << ']'
1161 << " button[" << cmd.button() << ']');
1163 string const argument = to_utf8(cmd.argument());
1164 Cursor & cur = d->cursor_;
1166 // Don't dispatch function that does not apply to internal buffers.
1167 if (buffer_.isInternal()
1168 && lyxaction.funcHasFlag(cmd.action, LyXAction::NoInternal))
1171 // We'll set this back to false if need be.
1172 bool dispatched = true;
1173 buffer_.undo().beginUndoGroup();
1175 switch (cmd.action) {
1177 case LFUN_BUFFER_PARAMS_APPLY: {
1178 DocumentClass const * const oldClass = buffer_.params().documentClassPtr();
1179 cur.recordUndoFullDocument();
1180 istringstream ss(to_utf8(cmd.argument()));
1183 int const unknown_tokens = buffer_.readHeader(lex);
1184 if (unknown_tokens != 0) {
1185 LYXERR0("Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1186 << unknown_tokens << " unknown token"
1187 << (unknown_tokens == 1 ? "" : "s"));
1189 updateLayout(oldClass);
1191 // We are most certainly here because of a change in the document
1192 // It is then better to make sure that all dialogs are in sync with
1193 // current document settings.
1194 processUpdateFlags(Update::Force | Update::FitCursor);
1198 case LFUN_LAYOUT_MODULES_CLEAR: {
1199 DocumentClass const * const oldClass =
1200 buffer_.params().documentClassPtr();
1201 cur.recordUndoFullDocument();
1202 buffer_.params().clearLayoutModules();
1203 buffer_.params().makeDocumentClass();
1204 updateLayout(oldClass);
1205 processUpdateFlags(Update::Force | Update::FitCursor);
1209 case LFUN_LAYOUT_MODULE_ADD: {
1210 BufferParams const & params = buffer_.params();
1211 if (!params.moduleCanBeAdded(argument)) {
1212 LYXERR0("Module `" << argument <<
1213 "' cannot be added due to failed requirements or "
1214 "conflicts with installed modules.");
1217 DocumentClass const * const oldClass = params.documentClassPtr();
1218 cur.recordUndoFullDocument();
1219 buffer_.params().addLayoutModule(argument);
1220 buffer_.params().makeDocumentClass();
1221 updateLayout(oldClass);
1222 processUpdateFlags(Update::Force | Update::FitCursor);
1226 case LFUN_TEXTCLASS_APPLY: {
1227 if (!LayoutFileList::get().load(argument, buffer_.temppath()) &&
1228 !LayoutFileList::get().load(argument, buffer_.filePath()))
1231 LayoutFile const * old_layout = buffer_.params().baseClass();
1232 LayoutFile const * new_layout = &(LayoutFileList::get()[argument]);
1234 if (old_layout == new_layout)
1238 //Save the old, possibly modular, layout for use in conversion.
1239 DocumentClass const * const oldDocClass =
1240 buffer_.params().documentClassPtr();
1241 cur.recordUndoFullDocument();
1242 buffer_.params().setBaseClass(argument);
1243 buffer_.params().makeDocumentClass();
1244 updateLayout(oldDocClass);
1245 processUpdateFlags(Update::Force | Update::FitCursor);
1249 case LFUN_TEXTCLASS_LOAD:
1250 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1251 LayoutFileList::get().load(argument, buffer_.filePath());
1254 case LFUN_LAYOUT_RELOAD: {
1255 DocumentClass const * const oldClass = buffer_.params().documentClassPtr();
1256 LayoutFileIndex bc = buffer_.params().baseClassID();
1257 LayoutFileList::get().reset(bc);
1258 buffer_.params().setBaseClass(bc);
1259 buffer_.params().makeDocumentClass();
1260 updateLayout(oldClass);
1261 processUpdateFlags(Update::Force | Update::FitCursor);
1266 cur.message(_("Undo"));
1267 cur.clearSelection();
1268 if (!cur.textUndo())
1269 cur.message(_("No further undo information"));
1271 processUpdateFlags(Update::Force | Update::FitCursor);
1275 cur.message(_("Redo"));
1276 cur.clearSelection();
1277 if (!cur.textRedo())
1278 cur.message(_("No further redo information"));
1280 processUpdateFlags(Update::Force | Update::FitCursor);
1283 case LFUN_FONT_STATE:
1284 cur.message(cur.currentState());
1287 case LFUN_BOOKMARK_SAVE:
1288 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1291 case LFUN_LABEL_GOTO: {
1292 docstring label = cmd.argument();
1293 if (label.empty()) {
1295 getInsetByCode<InsetRef>(cur, REF_CODE);
1297 label = inset->getParam("reference");
1298 // persistent=false: use temp_bookmark
1307 case LFUN_INSET_EDIT: {
1308 FuncRequest fr(cmd);
1309 // if there is an inset at cursor, see whether it
1311 Inset * inset = cur.nextInset();
1313 inset->dispatch(cur, fr);
1314 // if it did not work, try the underlying inset.
1315 if (!inset || !cur.result().dispatched())
1318 // FIXME I'm adding the last break to solve a crash,
1319 // but that is obviously not right.
1320 if (!cur.result().dispatched())
1321 // It did not work too; no action needed.
1326 case LFUN_PARAGRAPH_GOTO: {
1327 int const id = convert<int>(cmd.getArg(0));
1328 int const pos = convert<int>(cmd.getArg(1));
1330 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1331 b = theBufferList().next(b)) {
1333 DocIterator dit = b->getParFromID(id);
1335 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1339 LYXERR(Debug::INFO, "Paragraph " << dit.paragraph().id()
1340 << " found in buffer `"
1341 << b->absFileName() << "'.");
1343 if (b == &buffer_) {
1347 processUpdateFlags(Update::Force | Update::FitCursor);
1349 // Switch to other buffer view and resend cmd
1350 theLyXFunc().dispatch(FuncRequest(
1351 LFUN_BUFFER_SWITCH, b->absFileName()));
1352 theLyXFunc().dispatch(cmd);
1359 case LFUN_NOTE_NEXT:
1360 gotoInset(this, NOTE_CODE, false);
1363 case LFUN_REFERENCE_NEXT: {
1364 vector<InsetCode> tmp;
1365 tmp.push_back(LABEL_CODE);
1366 tmp.push_back(REF_CODE);
1367 gotoInset(this, tmp, true);
1371 case LFUN_CHANGES_TRACK:
1372 buffer_.params().trackChanges = !buffer_.params().trackChanges;
1375 case LFUN_CHANGES_OUTPUT:
1376 buffer_.params().outputChanges = !buffer_.params().outputChanges;
1377 if (buffer_.params().outputChanges) {
1378 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1379 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1380 LaTeXFeatures::isAvailable("xcolor");
1382 if (!dvipost && !xcolorulem) {
1383 Alert::warning(_("Changes not shown in LaTeX output"),
1384 _("Changes will not be highlighted in LaTeX output, "
1385 "because neither dvipost nor xcolor/ulem are installed.\n"
1386 "Please install these packages or redefine "
1387 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1388 } else if (!xcolorulem) {
1389 Alert::warning(_("Changes not shown in LaTeX output"),
1390 _("Changes will not be highlighted in LaTeX output "
1391 "when using pdflatex, because xcolor and ulem are not installed.\n"
1392 "Please install both packages or redefine "
1393 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1398 case LFUN_CHANGE_NEXT:
1399 findNextChange(this);
1400 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1401 processUpdateFlags(Update::Force | Update::FitCursor);
1404 case LFUN_CHANGE_PREVIOUS:
1405 findPreviousChange(this);
1406 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1407 processUpdateFlags(Update::Force | Update::FitCursor);
1410 case LFUN_CHANGES_MERGE:
1411 if (findNextChange(this) || findPreviousChange(this)) {
1412 processUpdateFlags(Update::Force | Update::FitCursor);
1413 showDialog("changes");
1417 case LFUN_ALL_CHANGES_ACCEPT:
1418 // select complete document
1420 cur.selHandle(true);
1421 buffer_.text().cursorBottom(cur);
1422 // accept everything in a single step to support atomic undo
1423 buffer_.text().acceptOrRejectChanges(cur, Text::ACCEPT);
1424 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1425 processUpdateFlags(Update::Force | Update::FitCursor);
1428 case LFUN_ALL_CHANGES_REJECT:
1429 // select complete document
1431 cur.selHandle(true);
1432 buffer_.text().cursorBottom(cur);
1433 // reject everything in a single step to support atomic undo
1434 // Note: reject does not work recursively; the user may have to repeat the operation
1435 buffer_.text().acceptOrRejectChanges(cur, Text::REJECT);
1436 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1437 processUpdateFlags(Update::Force | Update::FitCursor);
1440 case LFUN_WORD_FIND_FORWARD:
1441 case LFUN_WORD_FIND_BACKWARD: {
1442 static docstring last_search;
1443 docstring searched_string;
1445 if (!cmd.argument().empty()) {
1446 last_search = cmd.argument();
1447 searched_string = cmd.argument();
1449 searched_string = last_search;
1452 if (searched_string.empty())
1455 bool const fw = cmd.action == LFUN_WORD_FIND_FORWARD;
1456 docstring const data =
1457 find2string(searched_string, true, false, fw);
1458 find(this, FuncRequest(LFUN_WORD_FIND, data));
1462 case LFUN_WORD_FIND: {
1463 FuncRequest req = cmd;
1464 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1465 req = d->search_request_cache_;
1466 if (req.argument().empty()) {
1467 theLyXFunc().dispatch(FuncRequest(LFUN_DIALOG_SHOW, "findreplace"));
1470 if (find(this, req))
1473 message(_("String not found!"));
1474 d->search_request_cache_ = req;
1478 case LFUN_WORD_REPLACE: {
1479 bool has_deleted = false;
1480 if (cur.selection()) {
1481 DocIterator beg = cur.selectionBegin();
1482 DocIterator end = cur.selectionEnd();
1483 if (beg.pit() == end.pit()) {
1484 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1485 if (cur.paragraph().isDeleted(p))
1490 replace(this, cmd, has_deleted);
1494 case LFUN_WORD_FINDADV: {
1495 FindAndReplaceOptions opt;
1496 istringstream iss(to_utf8(cmd.argument()));
1498 if (findAdv(this, opt))
1506 cur.clearSelection();
1507 cur.message(from_utf8(N_("Mark off")));
1511 cur.clearSelection();
1513 cur.message(from_utf8(N_("Mark on")));
1516 case LFUN_MARK_TOGGLE:
1517 cur.setSelection(false);
1520 cur.message(from_utf8(N_("Mark removed")));
1523 cur.message(from_utf8(N_("Mark set")));
1528 case LFUN_SCREEN_SHOW_CURSOR:
1532 case LFUN_SCREEN_RECENTER:
1536 case LFUN_BIBTEX_DATABASE_ADD: {
1537 Cursor tmpcur = cur;
1538 findInset(tmpcur, BIBTEX_CODE, false);
1539 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1542 if (inset->addDatabase(cmd.argument()))
1543 buffer_.updateBibfilesCache();
1548 case LFUN_BIBTEX_DATABASE_DEL: {
1549 Cursor tmpcur = cur;
1550 findInset(tmpcur, BIBTEX_CODE, false);
1551 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1554 if (inset->delDatabase(cmd.argument()))
1555 buffer_.updateBibfilesCache();
1560 case LFUN_STATISTICS: {
1561 DocIterator from, to;
1562 if (cur.selection()) {
1563 from = cur.selectionBegin();
1564 to = cur.selectionEnd();
1566 from = doc_iterator_begin(&buffer_);
1567 to = doc_iterator_end(&buffer_);
1569 int const words = countWords(from, to);
1570 int const chars = countChars(from, to, false);
1571 int const chars_blanks = countChars(from, to, true);
1573 if (cur.selection())
1574 message = _("Statistics for the selection:");
1576 message = _("Statistics for the document:");
1579 message += bformat(_("%1$d words"), words);
1581 message += _("One word");
1583 if (chars_blanks != 1)
1584 message += bformat(_("%1$d characters (including blanks)"),
1587 message += _("One character (including blanks)");
1590 message += bformat(_("%1$d characters (excluding blanks)"),
1593 message += _("One character (excluding blanks)");
1595 Alert::information(_("Statistics"), message);
1599 case LFUN_BUFFER_TOGGLE_COMPRESSION:
1600 // turn compression on/off
1601 buffer_.params().compressed = !buffer_.params().compressed;
1604 case LFUN_LABEL_COPY_AS_REF: {
1605 // if there is an inset at cursor, try to copy it
1606 Inset * inset = &cur.inset();
1607 if (!inset || !inset->asInsetMath())
1608 inset = cur.nextInset();
1610 FuncRequest tmpcmd = cmd;
1611 inset->dispatch(cur, tmpcmd);
1613 if (!cur.result().dispatched())
1614 // It did not work too; no action needed.
1616 cur.clearSelection();
1617 processUpdateFlags(Update::SinglePar | Update::FitCursor);
1621 case LFUN_SCREEN_UP:
1622 case LFUN_SCREEN_DOWN: {
1623 Point p = getPos(cur, cur.boundary());
1624 // This code has been commented out to enable to scroll down a
1625 // document, even if there are large insets in it (see bug #5465).
1626 /*if (p.y_ < 0 || p.y_ > height_) {
1627 // The cursor is off-screen so recenter before proceeding.
1629 p = getPos(cur, cur.boundary());
1631 int const scrolled = scroll(cmd.action == LFUN_SCREEN_UP
1632 ? -height_ : height_);
1633 if (cmd.action == LFUN_SCREEN_UP && scrolled > -height_)
1635 if (cmd.action == LFUN_SCREEN_DOWN && scrolled < height_)
1636 p = Point(width_, height_);
1638 bool const in_texted = cur.inTexted();
1640 buffer_.changed(true);
1641 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_,
1642 true, cmd.action == LFUN_SCREEN_UP);
1643 //FIXME: what to do with cur.x_target()?
1644 bool update = in_texted && cur.bv().checkDepm(cur, old);
1647 processUpdateFlags(Update::Force | Update::FitCursor);
1655 case LFUN_SCREEN_UP_SELECT: {
1656 cur.selHandle(true);
1657 if (isTopScreen()) {
1658 lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1662 int y = getPos(cur, cur.boundary()).y_;
1663 int const ymin = y - height_ + defaultRowHeight();
1664 while (y > ymin && cur.up())
1665 y = getPos(cur, cur.boundary()).y_;
1668 processUpdateFlags(Update::SinglePar | Update::FitCursor);
1672 case LFUN_SCREEN_DOWN_SELECT: {
1673 cur.selHandle(true);
1674 if (isBottomScreen()) {
1675 lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1679 int y = getPos(cur, cur.boundary()).y_;
1680 int const ymax = y + height_ - defaultRowHeight();
1681 while (y < ymax && cur.down())
1682 y = getPos(cur, cur.boundary()).y_;
1685 processUpdateFlags(Update::SinglePar | Update::FitCursor);
1689 // This could be rewriten using some command like forall <insetname> <command>
1690 // once the insets refactoring is done.
1691 case LFUN_NOTES_MUTATE: {
1692 if (cmd.argument().empty())
1695 if (mutateNotes(cur, cmd.getArg(0), cmd.getArg(1))) {
1696 processUpdateFlags(Update::Force);
1702 // This would be in Buffer class if only Cursor did not
1703 // require a bufferview
1704 case LFUN_INSET_FORALL: {
1705 docstring const name = from_utf8(cmd.getArg(0));
1706 string const commandstr = cmd.getLongArg(1);
1707 FuncRequest const fr = lyxaction.lookupFunc(commandstr);
1709 // an arbitrary number to limit number of iterations
1710 const int max_iter = 10000;
1712 Cursor & cur = d->cursor_;
1713 Cursor const savecur = cur;
1715 if (!cur.nextInset())
1717 cur.beginUndoGroup();
1718 while(cur && iterations < max_iter) {
1719 Inset * ins = cur.nextInset();
1722 docstring insname = ins->name();
1723 while (!insname.empty()) {
1724 if (insname == name || name == from_utf8("*")) {
1730 size_t const i = insname.rfind(':');
1731 if (i == string::npos)
1733 insname = insname.substr(0, i);
1740 processUpdateFlags(Update::Force);
1742 if (iterations >= max_iter)
1743 cur.errorMessage(bformat(_("`inset-forall' interrupted because number of actions is larger than %1$d"), max_iter));
1745 cur.message(bformat(_("Applied \"%1$s\" to %2$d insets"), from_utf8(commandstr), iterations));
1750 case LFUN_ALL_INSETS_TOGGLE: {
1752 string const name = split(to_utf8(cmd.argument()), action, ' ');
1753 InsetCode const inset_code = insetCode(name);
1755 FuncRequest fr(LFUN_INSET_TOGGLE, action);
1757 Inset & inset = cur.buffer()->inset();
1758 InsetIterator it = inset_iterator_begin(inset);
1759 InsetIterator const end = inset_iterator_end(inset);
1760 for (; it != end; ++it) {
1761 if (it->asInsetCollapsable()
1762 && (inset_code == NO_CODE
1763 || inset_code == it->lyxCode())) {
1764 Cursor tmpcur = cur;
1765 tmpcur.pushBackward(*it);
1766 it->dispatch(tmpcur, fr);
1769 processUpdateFlags(Update::Force | Update::FitCursor);
1773 case LFUN_BRANCH_ADD_INSERT: {
1774 docstring branch_name = from_utf8(cmd.getArg(0));
1775 if (branch_name.empty())
1776 if (!Alert::askForText(branch_name, _("Branch name")) ||
1777 branch_name.empty())
1780 DispatchResult drtmp;
1781 buffer_.dispatch(FuncRequest(LFUN_BRANCH_ADD, branch_name), drtmp);
1782 if (drtmp.error()) {
1783 Alert::warning(_("Branch already exists"), drtmp.message());
1786 lyx::dispatch(FuncRequest(LFUN_BRANCH_INSERT, branch_name));
1790 case LFUN_KEYMAP_OFF:
1791 getIntl().keyMapOn(false);
1794 case LFUN_KEYMAP_PRIMARY:
1795 getIntl().keyMapPrim();
1798 case LFUN_KEYMAP_SECONDARY:
1799 getIntl().keyMapSec();
1802 case LFUN_KEYMAP_TOGGLE:
1803 getIntl().toggleKeyMap();
1806 case LFUN_DIALOG_SHOW_NEW_INSET: {
1807 string const name = cmd.getArg(0);
1808 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
1809 if (decodeInsetParam(name, data, buffer_))
1810 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
1812 lyxerr << "Inset type '" << name <<
1813 "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" << endl;
1817 case LFUN_CITATION_INSERT: {
1818 if (argument.empty()) {
1819 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
1822 // we can have one optional argument, delimited by '|'
1823 // citation-insert <key>|<text_before>
1824 // this should be enhanced to also support text_after
1825 // and citation style
1826 string arg = argument;
1828 if (contains(argument, "|")) {
1829 arg = token(argument, '|', 0);
1830 opt1 = token(argument, '|', 1);
1832 InsetCommandParams icp(CITE_CODE);
1833 icp["key"] = from_utf8(arg);
1835 icp["before"] = from_utf8(opt1);
1836 string icstr = InsetCommand::params2string("citation", icp);
1837 FuncRequest fr(LFUN_INSET_INSERT, icstr);
1842 case LFUN_INSET_APPLY: {
1843 string const name = cmd.getArg(0);
1844 Inset * inset = editedInset(name);
1846 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1850 // put cursor in front of inset.
1851 if (!setCursorFromInset(inset)) {
1852 LASSERT(false, break);
1855 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1856 inset->dispatch(cur, fr);
1857 processUpdateFlags(Update::SinglePar | Update::FitCursor);
1866 buffer_.undo().endUndoGroup();
1871 docstring const BufferView::requestSelection()
1873 Cursor & cur = d->cursor_;
1875 LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
1876 if (!cur.selection()) {
1877 d->xsel_cache_.set = false;
1881 LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
1882 if (!d->xsel_cache_.set ||
1883 cur.top() != d->xsel_cache_.cursor ||
1884 cur.anchor_.top() != d->xsel_cache_.anchor)
1886 d->xsel_cache_.cursor = cur.top();
1887 d->xsel_cache_.anchor = cur.anchor_.top();
1888 d->xsel_cache_.set = cur.selection();
1889 return cur.selectionAsString(false);
1895 void BufferView::clearSelection()
1897 d->cursor_.clearSelection();
1898 // Clear the selection buffer. Otherwise a subsequent
1899 // middle-mouse-button paste would use the selection buffer,
1900 // not the more current external selection.
1901 cap::clearSelection();
1902 d->xsel_cache_.set = false;
1903 // The buffer did not really change, but this causes the
1904 // redraw we need because we cleared the selection above.
1905 buffer_.changed(false);
1909 void BufferView::resize(int width, int height)
1911 // Update from work area
1915 // Clear the paragraph height cache.
1916 d->par_height_.clear();
1917 // Redo the metrics.
1922 Inset const * BufferView::getCoveringInset(Text const & text,
1925 TextMetrics & tm = d->text_metrics_[&text];
1926 Inset * inset = tm.checkInsetHit(x, y);
1930 if (!inset->descendable(*this))
1931 // No need to go further down if the inset is not
1935 size_t cell_number = inset->nargs();
1936 // Check all the inner cell.
1937 for (size_t i = 0; i != cell_number; ++i) {
1938 Text const * inner_text = inset->getText(i);
1941 Inset const * inset_deeper =
1942 getCoveringInset(*inner_text, x, y);
1944 return inset_deeper;
1952 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
1954 //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
1956 // This is only called for mouse related events including
1957 // LFUN_FILE_OPEN generated by drag-and-drop.
1958 FuncRequest cmd = cmd0;
1960 Cursor old = cursor();
1962 cur.push(buffer_.inset());
1963 cur.setSelection(d->cursor_.selection());
1965 // Either the inset under the cursor or the
1966 // surrounding Text will handle this event.
1968 // make sure we stay within the screen...
1969 cmd.y = min(max(cmd.y, -1), height_);
1971 if (cmd.action == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
1973 // Get inset under mouse, if there is one.
1974 Inset const * covering_inset =
1975 getCoveringInset(buffer_.text(), cmd.x, cmd.y);
1976 if (covering_inset == d->last_inset_)
1977 // Same inset, no need to do anything...
1980 bool need_redraw = false;
1981 // const_cast because of setMouseHover().
1982 Inset * inset = const_cast<Inset *>(covering_inset);
1984 // Remove the hint on the last hovered inset (if any).
1985 need_redraw |= d->last_inset_->setMouseHover(false);
1987 // Highlighted the newly hovered inset (if any).
1988 need_redraw |= inset->setMouseHover(true);
1989 d->last_inset_ = inset;
1993 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
1994 << cmd.x << ", " << cmd.y << ")");
1996 d->update_strategy_ = DecorationUpdate;
1998 // This event (moving without mouse click) is not passed further.
1999 // This should be changed if it is further utilized.
2000 buffer_.changed(false);
2004 // Build temporary cursor.
2005 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x, cmd.y);
2007 // Put anchor at the same position.
2010 cur.beginUndoGroup();
2012 // Try to dispatch to an non-editable inset near this position
2013 // via the temp cursor. If the inset wishes to change the real
2014 // cursor it has to do so explicitly by using
2015 // cur.bv().cursor() = cur; (or similar)
2017 inset->dispatch(cur, cmd);
2019 // Now dispatch to the temporary cursor. If the real cursor should
2020 // be modified, the inset's dispatch has to do so explicitly.
2021 if (!inset || !cur.result().dispatched())
2026 // Notify left insets
2029 bool badcursor = notifyCursorLeavesOrEnters(old, cur);
2031 cursor().fixIfBroken();
2034 // Do we have a selection?
2035 theSelection().haveSelection(cursor().selection());
2037 // If the command has been dispatched,
2038 if (cur.result().dispatched() || cur.result().update())
2039 processUpdateFlags(cur.result().update());
2043 void BufferView::lfunScroll(FuncRequest const & cmd)
2045 string const scroll_type = cmd.getArg(0);
2046 int const scroll_step =
2047 (scroll_type == "line") ? d->scrollbarParameters_.single_step
2048 : (scroll_type == "page") ? d->scrollbarParameters_.page_step : 0;
2049 if (scroll_step == 0)
2051 string const scroll_quantity = cmd.getArg(1);
2052 if (scroll_quantity == "up")
2053 scrollUp(scroll_step);
2054 else if (scroll_quantity == "down")
2055 scrollDown(scroll_step);
2057 int const scroll_value = convert<int>(scroll_quantity);
2059 scroll(scroll_step * scroll_value);
2061 buffer_.changed(true);
2065 int BufferView::minVisiblePart()
2067 return 2 * defaultRowHeight();
2071 int BufferView::scroll(int y)
2074 return scrollDown(y);
2076 return scrollUp(-y);
2081 int BufferView::scrollDown(int offset)
2083 Text * text = &buffer_.text();
2084 TextMetrics & tm = d->text_metrics_[text];
2085 int const ymax = height_ + offset;
2087 pair<pit_type, ParagraphMetrics const *> last = tm.last();
2088 int bottom_pos = last.second->position() + last.second->descent();
2089 if (lyxrc.scroll_below_document)
2090 bottom_pos += height_ - minVisiblePart();
2091 if (last.first + 1 == int(text->paragraphs().size())) {
2092 if (bottom_pos <= height_)
2094 offset = min(offset, bottom_pos - height_);
2097 if (bottom_pos > ymax)
2099 tm.newParMetricsDown();
2101 d->anchor_ypos_ -= offset;
2106 int BufferView::scrollUp(int offset)
2108 Text * text = &buffer_.text();
2109 TextMetrics & tm = d->text_metrics_[text];
2110 int ymin = - offset;
2112 pair<pit_type, ParagraphMetrics const *> first = tm.first();
2113 int top_pos = first.second->position() - first.second->ascent();
2114 if (first.first == 0) {
2117 offset = min(offset, - top_pos);
2122 tm.newParMetricsUp();
2124 d->anchor_ypos_ += offset;
2129 void BufferView::setCursorFromRow(int row)
2134 buffer_.texrow().getIdFromRow(row, tmpid, tmppos);
2138 buffer_.text().setCursor(d->cursor_, 0, 0);
2140 buffer_.text().setCursor(d->cursor_, buffer_.getParFromID(tmpid).pit(), tmppos);
2145 bool BufferView::setCursorFromInset(Inset const * inset)
2147 // are we already there?
2148 if (cursor().nextInset() == inset)
2151 // Inset is not at cursor position. Find it in the document.
2154 while (cur && cur.nextInset() != inset)
2165 void BufferView::gotoLabel(docstring const & label)
2167 std::vector<Buffer const *> bufs = buffer().allRelatives();
2168 std::vector<Buffer const *>::iterator it = bufs.begin();
2169 for (; it != bufs.end(); ++it) {
2170 Buffer const * buf = *it;
2173 Toc & toc = buf->tocBackend().toc("label");
2174 TocIterator toc_it = toc.begin();
2175 TocIterator end = toc.end();
2176 for (; toc_it != end; ++toc_it) {
2177 if (label == toc_it->str()) {
2178 dispatch(toc_it->action());
2186 TextMetrics const & BufferView::textMetrics(Text const * t) const
2188 return const_cast<BufferView *>(this)->textMetrics(t);
2192 TextMetrics & BufferView::textMetrics(Text const * t)
2194 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
2195 if (tmc_it == d->text_metrics_.end()) {
2196 tmc_it = d->text_metrics_.insert(
2197 make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
2199 return tmc_it->second;
2203 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
2206 return textMetrics(t).parMetrics(pit);
2210 int BufferView::workHeight() const
2216 void BufferView::setCursor(DocIterator const & dit)
2219 size_t const n = dit.depth();
2220 for (size_t i = 0; i < n; ++i)
2221 dit[i].inset().edit(d->cursor_, true);
2223 d->cursor_.setCursor(dit);
2224 d->cursor_.setSelection(false);
2228 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
2230 // Would be wrong to delete anything if we have a selection.
2231 if (cur.selection())
2234 bool need_anchor_change = false;
2235 bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
2236 need_anchor_change);
2238 if (need_anchor_change)
2246 buffer_.updateLabels();
2247 buffer_.changed(true);
2252 bool BufferView::mouseSetCursor(Cursor & cur, bool select)
2254 LASSERT(&cur.bv() == this, /**/);
2257 // this event will clear selection so we save selection for
2258 // persistent selection
2259 cap::saveSelection(cursor());
2261 d->cursor_.macroModeClose();
2263 // Has the cursor just left the inset?
2264 bool leftinset = (&d->cursor_.inset() != &cur.inset());
2266 d->cursor_.fixIfBroken();
2268 // FIXME: shift-mouse selection doesn't work well across insets.
2269 bool do_selection = select && &d->cursor_.anchor().inset() == &cur.inset();
2271 // do the dEPM magic if needed
2272 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
2273 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
2274 // the leftinset bool would not be necessary (badcursor instead).
2275 bool update = leftinset;
2276 if (!do_selection && d->cursor_.inTexted())
2277 update |= checkDepm(cur, d->cursor_);
2280 d->cursor_.resetAnchor();
2281 d->cursor_.setCursor(cur);
2282 d->cursor_.boundary(cur.boundary());
2284 d->cursor_.setSelection();
2286 d->cursor_.clearSelection();
2288 d->cursor_.finishUndo();
2289 d->cursor_.setCurrentFont();
2294 void BufferView::putSelectionAt(DocIterator const & cur,
2295 int length, bool backwards)
2297 d->cursor_.clearSelection();
2303 d->cursor_.pos() += length;
2304 d->cursor_.setSelection(d->cursor_, -length);
2306 d->cursor_.setSelection(d->cursor_, length);
2308 // Ensure a redraw happens in any case because the new selection could
2309 // possibly be on the same screen as the previous selection.
2310 processUpdateFlags(Update::Force | Update::FitCursor);
2314 Cursor & BufferView::cursor()
2320 Cursor const & BufferView::cursor() const
2326 pit_type BufferView::anchor_ref() const
2328 return d->anchor_pit_;
2332 bool BufferView::singleParUpdate()
2334 Text & buftext = buffer_.text();
2335 pit_type const bottom_pit = d->cursor_.bottom().pit();
2336 TextMetrics & tm = textMetrics(&buftext);
2337 int old_height = tm.parMetrics(bottom_pit).height();
2339 // make sure inline completion pointer is ok
2340 if (d->inlineCompletionPos_.fixIfBroken())
2341 d->inlineCompletionPos_ = DocIterator();
2343 // In Single Paragraph mode, rebreak only
2344 // the (main text, not inset!) paragraph containing the cursor.
2345 // (if this paragraph contains insets etc., rebreaking will
2346 // recursively descend)
2347 tm.redoParagraph(bottom_pit);
2348 ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
2349 if (pm.height() != old_height)
2350 // Paragraph height has changed so we cannot proceed to
2351 // the singlePar optimisation.
2354 d->update_strategy_ = SingleParUpdate;
2356 LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
2357 << " y2: " << pm.position() + pm.descent()
2358 << " pit: " << bottom_pit
2359 << " singlepar: 1");
2364 void BufferView::updateMetrics()
2366 if (height_ == 0 || width_ == 0)
2369 Text & buftext = buffer_.text();
2370 pit_type const npit = int(buftext.paragraphs().size());
2372 // Clear out the position cache in case of full screen redraw,
2373 d->coord_cache_.clear();
2375 // Clear out paragraph metrics to avoid having invalid metrics
2376 // in the cache from paragraphs not relayouted below
2377 // The complete text metrics will be redone.
2378 d->text_metrics_.clear();
2380 TextMetrics & tm = textMetrics(&buftext);
2382 // make sure inline completion pointer is ok
2383 if (d->inlineCompletionPos_.fixIfBroken())
2384 d->inlineCompletionPos_ = DocIterator();
2386 if (d->anchor_pit_ >= npit)
2387 // The anchor pit must have been deleted...
2388 d->anchor_pit_ = npit - 1;
2390 // Rebreak anchor paragraph.
2391 tm.redoParagraph(d->anchor_pit_);
2392 ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
2395 if (d->anchor_pit_ == 0) {
2396 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
2398 // Complete buffer visible? Then it's easy.
2399 if (scrollRange == 0)
2400 d->anchor_ypos_ = anchor_pm.ascent();
2402 // FIXME: Some clever handling needed to show
2403 // the _first_ paragraph up to the top if the cursor is
2404 // in the first line.
2406 anchor_pm.setPosition(d->anchor_ypos_);
2408 LYXERR(Debug::PAINTING, "metrics: "
2409 << " anchor pit = " << d->anchor_pit_
2410 << " anchor ypos = " << d->anchor_ypos_);
2412 // Redo paragraphs above anchor if necessary.
2413 int y1 = d->anchor_ypos_ - anchor_pm.ascent();
2414 // We are now just above the anchor paragraph.
2415 pit_type pit1 = d->anchor_pit_ - 1;
2416 for (; pit1 >= 0 && y1 >= 0; --pit1) {
2417 tm.redoParagraph(pit1);
2418 ParagraphMetrics & pm = tm.par_metrics_[pit1];
2420 // Save the paragraph position in the cache.
2425 // Redo paragraphs below the anchor if necessary.
2426 int y2 = d->anchor_ypos_ + anchor_pm.descent();
2427 // We are now just below the anchor paragraph.
2428 pit_type pit2 = d->anchor_pit_ + 1;
2429 for (; pit2 < npit && y2 <= height_; ++pit2) {
2430 tm.redoParagraph(pit2);
2431 ParagraphMetrics & pm = tm.par_metrics_[pit2];
2433 // Save the paragraph position in the cache.
2438 LYXERR(Debug::PAINTING, "Metrics: "
2439 << " anchor pit = " << d->anchor_pit_
2440 << " anchor ypos = " << d->anchor_ypos_
2443 << " pit1 = " << pit1
2444 << " pit2 = " << pit2);
2446 d->update_strategy_ = FullScreenUpdate;
2448 if (lyxerr.debugging(Debug::WORKAREA)) {
2449 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
2450 d->coord_cache_.dump();
2455 void BufferView::insertLyXFile(FileName const & fname)
2457 LASSERT(d->cursor_.inTexted(), /**/);
2459 // Get absolute path of file and add ".lyx"
2460 // to the filename if necessary
2461 FileName filename = fileSearch(string(), fname.absFilename(), "lyx");
2463 docstring const disp_fn = makeDisplayPath(filename.absFilename());
2464 // emit message signal.
2465 message(bformat(_("Inserting document %1$s..."), disp_fn));
2468 Buffer buf("", false);
2469 if (buf.loadLyXFile(filename)) {
2470 ErrorList & el = buffer_.errorList("Parse");
2471 // Copy the inserted document error list into the current buffer one.
2472 el = buf.errorList("Parse");
2473 buffer_.undo().recordUndo(d->cursor_);
2474 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
2475 buf.params().documentClassPtr(), el);
2476 res = _("Document %1$s inserted.");
2478 res = _("Could not insert document %1$s");
2481 buffer_.changed(true);
2482 // emit message signal.
2483 message(bformat(res, disp_fn));
2484 buffer_.errors("Parse");
2488 Point BufferView::coordOffset(DocIterator const & dit, bool boundary) const
2494 // Addup contribution of nested insets, from inside to outside,
2495 // keeping the outer paragraph for a special handling below
2496 for (size_t i = dit.depth() - 1; i >= 1; --i) {
2497 CursorSlice const & sl = dit[i];
2501 // get relative position inside sl.inset()
2502 sl.inset().cursorPos(*this, sl, boundary && (i + 1 == dit.depth()), xx, yy);
2504 // Make relative position inside of the edited inset relative to sl.inset()
2508 // In case of an RTL inset, the edited inset will be positioned to the left
2511 bool boundary_i = boundary && i + 1 == dit.depth();
2512 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2517 // remember width for the case that sl.inset() is positioned in an RTL inset
2518 if (i && dit[i - 1].text()) {
2519 // If this Inset is inside a Text Inset, retrieve the Dimension
2520 // from the containing text instead of using Inset::dimension() which
2521 // might not be implemented.
2522 // FIXME (Abdel 23/09/2007): this is a bit messy because of the
2523 // elimination of Inset::dim_ cache. This coordOffset() method needs
2524 // to be rewritten in light of the new design.
2525 Dimension const & dim = parMetrics(dit[i - 1].text(),
2526 dit[i - 1].pit()).insetDimension(&sl.inset());
2529 Dimension const dim = sl.inset().dimension(*this);
2533 //lyxerr << "Cursor::getPos, i: "
2534 // << i << " x: " << xx << " y: " << y << endl;
2537 // Add contribution of initial rows of outermost paragraph
2538 CursorSlice const & sl = dit[0];
2539 TextMetrics const & tm = textMetrics(sl.text());
2540 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2541 LASSERT(!pm.rows().empty(), /**/);
2542 y -= pm.rows()[0].ascent();
2544 // FIXME: document this mess
2546 if (sl.pos() > 0 && dit.depth() == 1) {
2548 if (pos && boundary)
2550 // lyxerr << "coordOffset: boundary:" << boundary << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
2551 rend = pm.pos2row(pos);
2553 rend = pm.pos2row(sl.pos());
2555 size_t rend = pm.pos2row(sl.pos());
2557 for (size_t rit = 0; rit != rend; ++rit)
2558 y += pm.rows()[rit].height();
2559 y += pm.rows()[rend].ascent();
2561 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
2563 // Make relative position from the nested inset now bufferview absolute.
2564 int xx = bottom_tm.cursorX(dit.bottom(), boundary && dit.depth() == 1);
2567 // In the RTL case place the nested inset at the left of the cursor in
2568 // the outer paragraph
2569 bool boundary_1 = boundary && 1 == dit.depth();
2570 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
2578 Point BufferView::getPos(DocIterator const & dit, bool boundary) const
2580 if (!paragraphVisible(dit))
2581 return Point(-1, -1);
2583 CursorSlice const & bot = dit.bottom();
2584 TextMetrics const & tm = textMetrics(bot.text());
2586 Point p = coordOffset(dit, boundary); // offset from outer paragraph
2587 p.y_ += tm.parMetrics(bot.pit()).position();
2592 bool BufferView::paragraphVisible(DocIterator const & dit) const
2594 CursorSlice const & bot = dit.bottom();
2595 TextMetrics const & tm = textMetrics(bot.text());
2597 return tm.contains(bot.pit());
2601 void BufferView::cursorPosAndHeight(Point & p, int & h) const
2603 Cursor const & cur = cursor();
2604 Font const font = cur.getFont();
2605 frontend::FontMetrics const & fm = theFontMetrics(font);
2606 int const asc = fm.maxAscent();
2607 int const des = fm.maxDescent();
2609 p = getPos(cur, cur.boundary());
2614 bool BufferView::cursorInView(Point const & p, int h) const
2616 Cursor const & cur = cursor();
2617 // does the cursor touch the screen ?
2618 if (p.y_ + h < 0 || p.y_ >= workHeight() || !paragraphVisible(cur))
2624 void BufferView::draw(frontend::Painter & pain)
2626 if (height_ == 0 || width_ == 0)
2628 LYXERR(Debug::PAINTING, "\t\t*** START DRAWING ***");
2630 Text & text = buffer_.text();
2631 TextMetrics const & tm = d->text_metrics_[&text];
2632 int const y = tm.first().second->position();
2633 PainterInfo pi(this, pain);
2635 switch (d->update_strategy_) {
2637 case NoScreenUpdate:
2638 // If no screen painting is actually needed, only some the different
2639 // coordinates of insets and paragraphs needs to be updated.
2640 pi.full_repaint = true;
2641 pi.pain.setDrawingEnabled(false);
2645 case SingleParUpdate:
2646 pi.full_repaint = false;
2647 // In general, only the current row of the outermost paragraph
2648 // will be redrawn. Particular cases where selection spans
2649 // multiple paragraph are correctly detected in TextMetrics.
2653 case DecorationUpdate:
2654 // FIXME: We should also distinguish DecorationUpdate to avoid text
2655 // drawing if possible. This is not possible to do easily right now
2656 // because of the single backing pixmap.
2658 case FullScreenUpdate:
2659 // The whole screen, including insets, will be refreshed.
2660 pi.full_repaint = true;
2662 // Clear background.
2663 pain.fillRectangle(0, 0, width_, height_,
2664 pi.backgroundColor(&buffer_.inset()));
2669 // and possibly grey out below
2670 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2671 int const y2 = lastpm.second->position() + lastpm.second->descent();
2674 Color color = buffer().isInternal()
2675 ? Color_background : Color_bottomarea;
2676 pain.fillRectangle(0, y2, width_, height_ - y2, color);
2680 LYXERR(Debug::PAINTING, "\n\t\t*** END DRAWING ***");
2682 // The scrollbar needs an update.
2685 // Normalize anchor for next time
2686 pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
2687 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2688 for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
2689 ParagraphMetrics const & pm = tm.parMetrics(pit);
2690 if (pm.position() + pm.descent() > 0) {
2691 d->anchor_pit_ = pit;
2692 d->anchor_ypos_ = pm.position();
2696 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
2697 << " anchor ypos = " << d->anchor_ypos_);
2701 void BufferView::message(docstring const & msg)
2704 d->gui_->message(msg);
2708 void BufferView::showDialog(string const & name)
2711 d->gui_->showDialog(name, string());
2715 void BufferView::showDialog(string const & name,
2716 string const & data, Inset * inset)
2719 d->gui_->showDialog(name, data, inset);
2723 void BufferView::updateDialog(string const & name, string const & data)
2726 d->gui_->updateDialog(name, data);
2730 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
2736 // FIXME: Move this out of BufferView again
2737 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
2739 if (!fname.isReadableFile()) {
2740 docstring const error = from_ascii(strerror(errno));
2741 docstring const file = makeDisplayPath(fname.absFilename(), 50);
2742 docstring const text =
2743 bformat(_("Could not read the specified document\n"
2744 "%1$s\ndue to the error: %2$s"), file, error);
2745 Alert::error(_("Could not read file"), text);
2749 if (!fname.isReadableFile()) {
2750 docstring const file = makeDisplayPath(fname.absFilename(), 50);
2751 docstring const text =
2752 bformat(_("%1$s\n is not readable."), file);
2753 Alert::error(_("Could not open file"), text);
2757 // FIXME UNICODE: We don't know the encoding of the file
2758 docstring file_content = fname.fileContents("UTF-8");
2759 if (file_content.empty()) {
2760 Alert::error(_("Reading not UTF-8 encoded file"),
2761 _("The file is not UTF-8 encoded.\n"
2762 "It will be read as local 8Bit-encoded.\n"
2763 "If this does not give the correct result\n"
2764 "then please change the encoding of the file\n"
2765 "to UTF-8 with a program other than LyX.\n"));
2766 file_content = fname.fileContents("local8bit");
2769 return normalize_c(file_content);
2773 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
2775 docstring const tmpstr = contentsOfPlaintextFile(f);
2780 Cursor & cur = cursor();
2781 cap::replaceSelection(cur);
2782 buffer_.undo().recordUndo(cur);
2784 cur.innerText()->insertStringAsParagraphs(cur, tmpstr, cur.current_font);
2786 cur.innerText()->insertStringAsLines(cur, tmpstr, cur.current_font);
2788 buffer_.changed(true);
2792 docstring const & BufferView::inlineCompletion() const
2794 return d->inlineCompletion_;
2798 size_t const & BufferView::inlineCompletionUniqueChars() const
2800 return d->inlineCompletionUniqueChars_;
2804 DocIterator const & BufferView::inlineCompletionPos() const
2806 return d->inlineCompletionPos_;
2810 bool samePar(DocIterator const & a, DocIterator const & b)
2812 if (a.empty() && b.empty())
2814 if (a.empty() || b.empty())
2816 if (a.depth() != b.depth())
2818 return &a.innerParagraph() == &b.innerParagraph();
2822 void BufferView::setInlineCompletion(Cursor & cur, DocIterator const & pos,
2823 docstring const & completion, size_t uniqueChars)
2825 uniqueChars = min(completion.size(), uniqueChars);
2826 bool changed = d->inlineCompletion_ != completion
2827 || d->inlineCompletionUniqueChars_ != uniqueChars;
2828 bool singlePar = true;
2829 d->inlineCompletion_ = completion;
2830 d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
2832 //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
2835 DocIterator const & old = d->inlineCompletionPos_;
2837 //lyxerr << "inlineCompletionPos changed" << std::endl;
2838 // old or pos are in another paragraph?
2839 if ((!samePar(cur, pos) && !pos.empty())
2840 || (!samePar(cur, old) && !old.empty())) {
2842 //lyxerr << "different paragraph" << std::endl;
2844 d->inlineCompletionPos_ = pos;
2849 if (singlePar && !(cur.disp_.update() & Update::Force))
2850 cur.updateFlags(cur.disp_.update() | Update::SinglePar);
2852 cur.updateFlags(cur.disp_.update() | Update::Force);