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_(-1), 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);
320 d->last_inset_->setMouseHover(this, false);
326 int BufferView::rightMargin() const
328 // The additional test for the case the outliner is opened.
330 !lyxrc.full_screen_limit ||
331 width_ < lyxrc.full_screen_width + 20)
334 return (width_ - lyxrc.full_screen_width) / 2;
338 int BufferView::leftMargin() const
340 return rightMargin();
344 bool BufferView::isTopScreen() const
346 return d->scrollbarParameters_.position == d->scrollbarParameters_.min;
350 bool BufferView::isBottomScreen() const
352 return d->scrollbarParameters_.position == d->scrollbarParameters_.max;
356 Intl & BufferView::getIntl()
362 Intl const & BufferView::getIntl() const
368 CoordCache & BufferView::coordCache()
370 return d->coord_cache_;
374 CoordCache const & BufferView::coordCache() const
376 return d->coord_cache_;
380 Buffer & BufferView::buffer()
386 Buffer const & BufferView::buffer() const
392 bool BufferView::fitCursor()
394 if (cursorStatus(d->cursor_) == CUR_INSIDE) {
395 frontend::FontMetrics const & fm =
396 theFontMetrics(d->cursor_.getFont().fontInfo());
397 int const asc = fm.maxAscent();
398 int const des = fm.maxDescent();
399 Point const p = getPos(d->cursor_);
400 if (p.y_ - asc >= 0 && p.y_ + des < height_)
407 void BufferView::processUpdateFlags(Update::flags flags)
409 // This is close to a hot-path.
410 LYXERR(Debug::DEBUG, "BufferView::processUpdateFlags()"
411 << "[fitcursor = " << (flags & Update::FitCursor)
412 << ", forceupdate = " << (flags & Update::Force)
413 << ", singlepar = " << (flags & Update::SinglePar)
414 << "] buffer: " << &buffer_);
416 // FIXME Does this really need doing here? It's done in updateBuffer, and
417 // if the Buffer doesn't need updating, then do the macros?
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, bool update)
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_);
592 showCursor(dit, false, update);
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_);
601 showCursor(dit, false, update);
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, update);
623 DocIterator dit = doc_iterator_begin(&buffer_);
625 LYXERR(Debug::SCROLLING, "value = " << value << " -> scroll to pit " << i);
626 showCursor(dit, false, update);
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).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);
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, true);
815 void BufferView::showCursor()
817 showCursor(d->cursor_, false, true);
821 void BufferView::showCursor(DocIterator const & dit,
822 bool recenter, bool update)
824 if (scrollToCursor(dit, recenter) && update) {
825 buffer_.changed(true);
826 updateHoveredInset();
831 void BufferView::scrollToCursor()
833 if (scrollToCursor(d->cursor_, false)) {
834 buffer_.changed(true);
835 updateHoveredInset();
840 bool BufferView::scrollToCursor(DocIterator const & dit, bool recenter)
842 // We are not properly started yet, delay until resizing is
847 LYXERR(Debug::SCROLLING, "recentering!");
849 CursorSlice const & bot = dit.bottom();
850 TextMetrics & tm = d->text_metrics_[bot.text()];
852 pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
853 int bot_pit = bot.pit();
854 if (bot_pit > max_pit) {
855 // FIXME: Why does this happen?
856 LYXERR0("bottom pit is greater that max pit: "
857 << bot_pit << " > " << max_pit);
861 if (bot_pit == tm.first().first - 1)
862 tm.newParMetricsUp();
863 else if (bot_pit == tm.last().first + 1)
864 tm.newParMetricsDown();
866 if (tm.contains(bot_pit)) {
867 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
868 LASSERT(!pm.rows().empty(), /**/);
869 // FIXME: smooth scrolling doesn't work in mathed.
870 CursorSlice const & cs = dit.innerTextSlice();
871 int offset = coordOffset(dit).y_;
872 int ypos = pm.position() + offset;
873 Dimension const & row_dim =
874 pm.getRow(cs.pos(), dit.boundary()).dimension();
877 scrolled = scroll(ypos - height_/2);
879 // If the top part of the row falls of the screen, we scroll
880 // up to align the top of the row with the top of the screen.
881 else if (ypos - row_dim.ascent() < 0)
882 scrolled = scrollUp(-ypos + row_dim.ascent());
884 // If the bottom of the row falls of the screen, we scroll down.
885 // However, we have to be careful not to scroll that much that
886 // the top falls of the screen.
887 else if (ypos + row_dim.descent() > height_) {
888 int ynew = height_ - row_dim.descent();
889 if (ynew < row_dim.ascent())
890 ynew = row_dim.ascent();
891 int const scroll = ypos - ynew;
892 scrolled = scrollDown(scroll);
895 // else, nothing to do, the cursor is already visible so we just return.
896 return scrolled != 0;
899 // fix inline completion position
900 if (d->inlineCompletionPos_.fixIfBroken())
901 d->inlineCompletionPos_ = DocIterator();
903 tm.redoParagraph(bot_pit);
904 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
905 int offset = coordOffset(dit).y_;
907 d->anchor_pit_ = bot_pit;
908 CursorSlice const & cs = dit.innerTextSlice();
909 Dimension const & row_dim =
910 pm.getRow(cs.pos(), dit.boundary()).dimension();
913 d->anchor_ypos_ = height_/2;
914 else if (d->anchor_pit_ == 0)
915 d->anchor_ypos_ = offset + pm.ascent();
916 else if (d->anchor_pit_ == max_pit)
917 d->anchor_ypos_ = height_ - offset - row_dim.descent();
918 else if (offset > height_)
919 d->anchor_ypos_ = height_ - offset - defaultRowHeight();
921 d->anchor_ypos_ = defaultRowHeight() * 2;
927 void BufferView::updateDocumentClass(DocumentClass const * const olddc)
929 message(_("Converting document to new document class..."));
931 StableDocIterator backcur(d->cursor_);
932 ErrorList & el = buffer_.errorList("Class Switch");
933 cap::switchBetweenClasses(
934 olddc, buffer_.params().documentClassPtr(),
935 static_cast<InsetText &>(buffer_.inset()), el);
937 setCursor(backcur.asDocIterator(&buffer_));
939 buffer_.errors("Class Switch");
942 /** Return the change status at cursor position, taking in account the
943 * status at each level of the document iterator (a table in a deleted
944 * footnote is deleted).
945 * When \param outer is true, the top slice is not looked at.
947 static Change::Type lookupChangeType(DocIterator const & dit, bool outer = false)
949 size_t const depth = dit.depth() - (outer ? 1 : 0);
951 for (size_t i = 0 ; i < depth ; ++i) {
952 CursorSlice const & slice = dit[i];
953 if (!slice.inset().inMathed()
954 && slice.pos() < slice.paragraph().size()) {
955 Change::Type const ch = slice.paragraph().lookupChange(slice.pos()).type;
956 if (ch != Change::UNCHANGED)
960 return Change::UNCHANGED;
964 bool BufferView::getStatus(FuncRequest const & cmd, FuncStatus & flag)
966 FuncCode const act = cmd.action();
968 // Can we use a readonly buffer?
969 if (buffer_.isReadonly()
970 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
971 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
972 flag.message(from_utf8(N_("Document is read-only")));
973 flag.setEnabled(false);
977 // Are we in a DELETED change-tracking region?
978 if (lookupChangeType(d->cursor_, true) == Change::DELETED
979 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
980 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
981 flag.message(from_utf8(N_("This portion of the document is deleted.")));
982 flag.setEnabled(false);
986 Cursor & cur = d->cursor_;
988 if (cur.getStatus(cmd, flag))
993 // FIXME: This is a bit problematic because we don't check if this is
994 // a document BufferView or not for these LFUNs. We probably have to
995 // dispatch both to currentBufferView() and, if that fails,
996 // to documentBufferView(); same as we do now for current Buffer and
997 // document Buffer. Ideally those LFUN should go to Buffer as they
998 // operate on the full Buffer and the cursor is only needed either for
999 // an Undo record or to restore a cursor position. But we don't know
1000 // how to do that inside Buffer of course.
1001 case LFUN_BUFFER_PARAMS_APPLY:
1002 case LFUN_LAYOUT_MODULES_CLEAR:
1003 case LFUN_LAYOUT_MODULE_ADD:
1004 case LFUN_LAYOUT_RELOAD:
1005 case LFUN_TEXTCLASS_APPLY:
1006 case LFUN_TEXTCLASS_LOAD:
1007 flag.setEnabled(!buffer_.isReadonly());
1011 // We do not use the LyXAction flag for readonly because Undo sets the
1012 // buffer clean/dirty status by itself.
1013 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasUndoStack());
1016 // We do not use the LyXAction flag for readonly because Redo sets the
1017 // buffer clean/dirty status by itself.
1018 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasRedoStack());
1020 case LFUN_FILE_INSERT:
1021 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
1022 case LFUN_FILE_INSERT_PLAINTEXT:
1023 case LFUN_BOOKMARK_SAVE:
1024 // FIXME: Actually, these LFUNS should be moved to Text
1025 flag.setEnabled(cur.inTexted());
1028 case LFUN_FONT_STATE:
1029 case LFUN_LABEL_INSERT:
1030 case LFUN_LINE_INSERT:
1031 case LFUN_INFO_INSERT:
1032 case LFUN_PARAGRAPH_GOTO:
1033 case LFUN_NOTE_NEXT:
1034 case LFUN_REFERENCE_NEXT:
1035 case LFUN_WORD_FIND:
1036 case LFUN_WORD_FIND_FORWARD:
1037 case LFUN_WORD_FIND_BACKWARD:
1038 case LFUN_WORD_FINDADV:
1039 case LFUN_WORD_REPLACE:
1042 case LFUN_MARK_TOGGLE:
1043 case LFUN_SCREEN_RECENTER:
1044 case LFUN_SCREEN_SHOW_CURSOR:
1045 case LFUN_BIBTEX_DATABASE_ADD:
1046 case LFUN_BIBTEX_DATABASE_DEL:
1047 case LFUN_STATISTICS:
1048 case LFUN_BRANCH_ADD_INSERT:
1049 case LFUN_KEYMAP_OFF:
1050 case LFUN_KEYMAP_PRIMARY:
1051 case LFUN_KEYMAP_SECONDARY:
1052 case LFUN_KEYMAP_TOGGLE:
1053 flag.setEnabled(true);
1056 case LFUN_LABEL_GOTO: {
1057 flag.setEnabled(!cmd.argument().empty()
1058 || getInsetByCode<InsetRef>(cur, REF_CODE));
1062 case LFUN_CHANGES_TRACK:
1063 flag.setEnabled(true);
1064 flag.setOnOff(buffer_.params().trackChanges);
1067 case LFUN_CHANGES_OUTPUT:
1068 flag.setEnabled(true);
1069 flag.setOnOff(buffer_.params().outputChanges);
1072 case LFUN_CHANGES_MERGE:
1073 case LFUN_CHANGE_NEXT:
1074 case LFUN_CHANGE_PREVIOUS:
1075 case LFUN_ALL_CHANGES_ACCEPT:
1076 case LFUN_ALL_CHANGES_REJECT:
1077 // TODO: context-sensitive enabling of LFUNs
1078 // In principle, these command should only be enabled if there
1079 // is a change in the document. However, without proper
1080 // optimizations, this will inevitably result in poor performance.
1081 flag.setEnabled(true);
1084 case LFUN_BUFFER_TOGGLE_COMPRESSION: {
1085 flag.setOnOff(buffer_.params().compressed);
1089 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC: {
1090 flag.setOnOff(buffer_.params().output_sync);
1094 case LFUN_SCREEN_UP:
1095 case LFUN_SCREEN_DOWN:
1097 case LFUN_SCREEN_UP_SELECT:
1098 case LFUN_SCREEN_DOWN_SELECT:
1099 case LFUN_INSET_FORALL:
1100 flag.setEnabled(true);
1103 case LFUN_LAYOUT_TABULAR:
1104 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
1108 flag.setEnabled(!cur.inset().forcePlainLayout(cur.idx()));
1111 case LFUN_LAYOUT_PARAGRAPH:
1112 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
1115 case LFUN_DIALOG_SHOW_NEW_INSET:
1116 // FIXME: this is wrong, but I do not understand the
1118 if (cur.inset().lyxCode() == CAPTION_CODE)
1119 return cur.inset().getStatus(cur, cmd, flag);
1120 // FIXME we should consider passthru paragraphs too.
1121 flag.setEnabled(!cur.inset().getLayout().isPassThru());
1124 case LFUN_CITATION_INSERT: {
1125 FuncRequest fr(LFUN_INSET_INSERT, "citation");
1126 // FIXME: This could turn in a recursive hell.
1127 // Shouldn't we use Buffer::getStatus() instead?
1128 flag.setEnabled(lyx::getStatus(fr).enabled());
1131 case LFUN_INSET_APPLY: {
1132 string const name = cmd.getArg(0);
1133 Inset * inset = editedInset(name);
1135 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1136 if (!inset->getStatus(cur, fr, flag)) {
1137 // Every inset is supposed to handle this
1138 LASSERT(false, break);
1141 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1142 flag = lyx::getStatus(fr);
1155 Inset * BufferView::editedInset(string const & name) const
1157 map<string, Inset *>::const_iterator it = d->edited_insets_.find(name);
1158 return it == d->edited_insets_.end() ? 0 : it->second;
1162 void BufferView::editInset(string const & name, Inset * inset)
1164 d->edited_insets_[name] = inset;
1168 void BufferView::dispatch(FuncRequest const & cmd, DispatchResult & dr)
1170 //lyxerr << [ cmd = " << cmd << "]" << endl;
1172 // Make sure that the cached BufferView is correct.
1173 LYXERR(Debug::ACTION, " action[" << cmd.action() << ']'
1174 << " arg[" << to_utf8(cmd.argument()) << ']'
1175 << " x[" << cmd.x() << ']'
1176 << " y[" << cmd.y() << ']'
1177 << " button[" << cmd.button() << ']');
1179 string const argument = to_utf8(cmd.argument());
1180 Cursor & cur = d->cursor_;
1182 // Don't dispatch function that does not apply to internal buffers.
1183 if (buffer_.isInternal()
1184 && lyxaction.funcHasFlag(cmd.action(), LyXAction::NoInternal))
1187 // We'll set this back to false if need be.
1188 bool dispatched = true;
1189 buffer_.undo().beginUndoGroup();
1191 FuncCode const act = cmd.action();
1194 case LFUN_BUFFER_PARAMS_APPLY: {
1195 DocumentClass const * const oldClass = buffer_.params().documentClassPtr();
1196 cur.recordUndoFullDocument();
1197 istringstream ss(to_utf8(cmd.argument()));
1200 int const unknown_tokens = buffer_.readHeader(lex);
1201 if (unknown_tokens != 0) {
1202 LYXERR0("Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1203 << unknown_tokens << " unknown token"
1204 << (unknown_tokens == 1 ? "" : "s"));
1206 updateDocumentClass(oldClass);
1208 // We are most certainly here because of a change in the document
1209 // It is then better to make sure that all dialogs are in sync with
1210 // current document settings.
1211 dr.update(Update::Force | Update::FitCursor);
1212 dr.forceBufferUpdate();
1216 case LFUN_LAYOUT_MODULES_CLEAR: {
1217 DocumentClass const * const oldClass =
1218 buffer_.params().documentClassPtr();
1219 cur.recordUndoFullDocument();
1220 buffer_.params().clearLayoutModules();
1221 buffer_.params().makeDocumentClass();
1222 updateDocumentClass(oldClass);
1223 dr.update(Update::Force | Update::FitCursor);
1224 dr.forceBufferUpdate();
1228 case LFUN_LAYOUT_MODULE_ADD: {
1229 BufferParams const & params = buffer_.params();
1230 if (!params.moduleCanBeAdded(argument)) {
1231 LYXERR0("Module `" << argument <<
1232 "' cannot be added due to failed requirements or "
1233 "conflicts with installed modules.");
1236 DocumentClass const * const oldClass = params.documentClassPtr();
1237 cur.recordUndoFullDocument();
1238 buffer_.params().addLayoutModule(argument);
1239 buffer_.params().makeDocumentClass();
1240 updateDocumentClass(oldClass);
1241 dr.update(Update::Force | Update::FitCursor);
1242 dr.forceBufferUpdate();
1246 case LFUN_TEXTCLASS_APPLY: {
1247 // since this shortcircuits, the second call is made only if
1249 bool const success =
1250 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1251 LayoutFileList::get().load(argument, buffer_.filePath());
1253 docstring s = bformat(_("The document class `%1$s' "
1254 "could not be loaded."), from_utf8(argument));
1255 frontend::Alert::error(_("Could not load class"), s);
1259 LayoutFile const * old_layout = buffer_.params().baseClass();
1260 LayoutFile const * new_layout = &(LayoutFileList::get()[argument]);
1262 if (old_layout == new_layout)
1266 // Save the old, possibly modular, layout for use in conversion.
1267 DocumentClass const * const oldDocClass =
1268 buffer_.params().documentClassPtr();
1269 cur.recordUndoFullDocument();
1270 buffer_.params().setBaseClass(argument);
1271 buffer_.params().makeDocumentClass();
1272 updateDocumentClass(oldDocClass);
1273 dr.update(Update::Force | Update::FitCursor);
1274 dr.forceBufferUpdate();
1278 case LFUN_TEXTCLASS_LOAD: {
1279 // since this shortcircuits, the second call is made only if
1281 bool const success =
1282 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1283 LayoutFileList::get().load(argument, buffer_.filePath());
1285 docstring s = bformat(_("The document class `%1$s' "
1286 "could not be loaded."), from_utf8(argument));
1287 frontend::Alert::error(_("Could not load class"), s);
1292 case LFUN_LAYOUT_RELOAD: {
1293 DocumentClass const * const oldClass = buffer_.params().documentClassPtr();
1294 LayoutFileIndex bc = buffer_.params().baseClassID();
1295 LayoutFileList::get().reset(bc);
1296 buffer_.params().setBaseClass(bc);
1297 buffer_.params().makeDocumentClass();
1298 updateDocumentClass(oldClass);
1299 dr.update(Update::Force | Update::FitCursor);
1300 dr.forceBufferUpdate();
1305 dr.setMessage(_("Undo"));
1306 cur.clearSelection();
1307 if (!cur.textUndo())
1308 dr.setMessage(_("No further undo information"));
1310 dr.update(Update::Force | Update::FitCursor);
1311 dr.forceBufferUpdate();
1315 dr.setMessage(_("Redo"));
1316 cur.clearSelection();
1317 if (!cur.textRedo())
1318 dr.setMessage(_("No further redo information"));
1320 dr.update(Update::Force | Update::FitCursor);
1321 dr.forceBufferUpdate();
1324 case LFUN_FONT_STATE:
1325 dr.setMessage(cur.currentState());
1328 case LFUN_BOOKMARK_SAVE:
1329 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1332 case LFUN_LABEL_GOTO: {
1333 docstring label = cmd.argument();
1334 if (label.empty()) {
1336 getInsetByCode<InsetRef>(cur, REF_CODE);
1338 label = inset->getParam("reference");
1339 // persistent=false: use temp_bookmark
1348 case LFUN_PARAGRAPH_GOTO: {
1349 int const id = convert<int>(cmd.getArg(0));
1350 int const pos = convert<int>(cmd.getArg(1));
1352 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1353 b = theBufferList().next(b)) {
1355 DocIterator dit = b->getParFromID(id);
1357 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1361 LYXERR(Debug::INFO, "Paragraph " << dit.paragraph().id()
1362 << " found in buffer `"
1363 << b->absFileName() << "'.");
1365 if (b == &buffer_) {
1369 dr.update(Update::Force | Update::FitCursor);
1371 // Switch to other buffer view and resend cmd
1372 lyx::dispatch(FuncRequest(
1373 LFUN_BUFFER_SWITCH, b->absFileName()));
1381 case LFUN_NOTE_NEXT:
1382 gotoInset(this, NOTE_CODE, false);
1385 case LFUN_REFERENCE_NEXT: {
1386 vector<InsetCode> tmp;
1387 tmp.push_back(LABEL_CODE);
1388 tmp.push_back(REF_CODE);
1389 gotoInset(this, tmp, true);
1393 case LFUN_CHANGES_TRACK:
1394 buffer_.params().trackChanges = !buffer_.params().trackChanges;
1397 case LFUN_CHANGES_OUTPUT:
1398 buffer_.params().outputChanges = !buffer_.params().outputChanges;
1399 if (buffer_.params().outputChanges) {
1400 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1401 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1402 LaTeXFeatures::isAvailable("xcolor");
1404 if (!dvipost && !xcolorulem) {
1405 Alert::warning(_("Changes not shown in LaTeX output"),
1406 _("Changes will not be highlighted in LaTeX output, "
1407 "because neither dvipost nor xcolor/ulem are installed.\n"
1408 "Please install these packages or redefine "
1409 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1410 } else if (!xcolorulem) {
1411 Alert::warning(_("Changes not shown in LaTeX output"),
1412 _("Changes will not be highlighted in LaTeX output "
1413 "when using pdflatex, because xcolor and ulem are not installed.\n"
1414 "Please install both packages or redefine "
1415 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1420 case LFUN_CHANGE_NEXT:
1421 findNextChange(this);
1422 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1423 dr.update(Update::Force | Update::FitCursor);
1426 case LFUN_CHANGE_PREVIOUS:
1427 findPreviousChange(this);
1428 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1429 dr.update(Update::Force | Update::FitCursor);
1432 case LFUN_CHANGES_MERGE:
1433 if (findNextChange(this) || findPreviousChange(this)) {
1434 dr.update(Update::Force | Update::FitCursor);
1435 dr.forceBufferUpdate();
1436 showDialog("changes");
1440 case LFUN_ALL_CHANGES_ACCEPT:
1441 // select complete document
1443 cur.selHandle(true);
1444 buffer_.text().cursorBottom(cur);
1445 // accept everything in a single step to support atomic undo
1446 buffer_.text().acceptOrRejectChanges(cur, Text::ACCEPT);
1447 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1448 dr.update(Update::Force | Update::FitCursor);
1449 dr.forceBufferUpdate();
1452 case LFUN_ALL_CHANGES_REJECT:
1453 // select complete document
1455 cur.selHandle(true);
1456 buffer_.text().cursorBottom(cur);
1457 // reject everything in a single step to support atomic undo
1458 // Note: reject does not work recursively; the user may have to repeat the operation
1459 buffer_.text().acceptOrRejectChanges(cur, Text::REJECT);
1460 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1461 dr.update(Update::Force | Update::FitCursor);
1462 dr.forceBufferUpdate();
1465 case LFUN_WORD_FIND_FORWARD:
1466 case LFUN_WORD_FIND_BACKWARD: {
1467 static docstring last_search;
1468 docstring searched_string;
1470 if (!cmd.argument().empty()) {
1471 last_search = cmd.argument();
1472 searched_string = cmd.argument();
1474 searched_string = last_search;
1477 if (searched_string.empty())
1480 bool const fw = act == LFUN_WORD_FIND_FORWARD;
1481 docstring const data =
1482 find2string(searched_string, true, false, fw);
1483 find(this, FuncRequest(LFUN_WORD_FIND, data));
1487 case LFUN_WORD_FIND: {
1488 FuncRequest req = cmd;
1489 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1490 req = d->search_request_cache_;
1491 if (req.argument().empty()) {
1492 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, "findreplace"));
1495 if (find(this, req))
1498 message(_("String not found!"));
1499 d->search_request_cache_ = req;
1503 case LFUN_WORD_REPLACE: {
1504 bool has_deleted = false;
1505 if (cur.selection()) {
1506 DocIterator beg = cur.selectionBegin();
1507 DocIterator end = cur.selectionEnd();
1508 if (beg.pit() == end.pit()) {
1509 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1511 && cur.paragraph().isDeleted(p))
1516 replace(this, cmd, has_deleted);
1517 dr.forceBufferUpdate();
1521 case LFUN_WORD_FINDADV: {
1522 FindAndReplaceOptions opt;
1523 istringstream iss(to_utf8(cmd.argument()));
1525 if (findAdv(this, opt))
1533 cur.clearSelection();
1534 dr.setMessage(from_utf8(N_("Mark off")));
1538 cur.clearSelection();
1540 dr.setMessage(from_utf8(N_("Mark on")));
1543 case LFUN_MARK_TOGGLE:
1544 cur.setSelection(false);
1547 dr.setMessage(from_utf8(N_("Mark removed")));
1550 dr.setMessage(from_utf8(N_("Mark set")));
1555 case LFUN_SCREEN_SHOW_CURSOR:
1559 case LFUN_SCREEN_RECENTER:
1563 case LFUN_BIBTEX_DATABASE_ADD: {
1564 Cursor tmpcur = cur;
1565 findInset(tmpcur, BIBTEX_CODE, false);
1566 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1569 if (inset->addDatabase(cmd.argument())) {
1570 buffer_.invalidateBibfileCache();
1571 dr.forceBufferUpdate();
1577 case LFUN_BIBTEX_DATABASE_DEL: {
1578 Cursor tmpcur = cur;
1579 findInset(tmpcur, BIBTEX_CODE, false);
1580 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1583 if (inset->delDatabase(cmd.argument())) {
1584 buffer_.invalidateBibfileCache();
1585 dr.forceBufferUpdate();
1591 case LFUN_STATISTICS: {
1592 DocIterator from, to;
1593 if (cur.selection()) {
1594 from = cur.selectionBegin();
1595 to = cur.selectionEnd();
1597 from = doc_iterator_begin(&buffer_);
1598 to = doc_iterator_end(&buffer_);
1600 int const words = countWords(from, to);
1601 int const chars = countChars(from, to, false);
1602 int const chars_blanks = countChars(from, to, true);
1604 if (cur.selection())
1605 message = _("Statistics for the selection:");
1607 message = _("Statistics for the document:");
1610 message += bformat(_("%1$d words"), words);
1612 message += _("One word");
1614 if (chars_blanks != 1)
1615 message += bformat(_("%1$d characters (including blanks)"),
1618 message += _("One character (including blanks)");
1621 message += bformat(_("%1$d characters (excluding blanks)"),
1624 message += _("One character (excluding blanks)");
1626 Alert::information(_("Statistics"), message);
1630 case LFUN_BUFFER_TOGGLE_COMPRESSION:
1631 // turn compression on/off
1632 buffer_.params().compressed = !buffer_.params().compressed;
1635 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
1636 buffer_.params().output_sync = !buffer_.params().output_sync;
1639 case LFUN_SCREEN_UP:
1640 case LFUN_SCREEN_DOWN: {
1641 Point p = getPos(cur);
1642 // This code has been commented out to enable to scroll down a
1643 // document, even if there are large insets in it (see bug #5465).
1644 /*if (p.y_ < 0 || p.y_ > height_) {
1645 // The cursor is off-screen so recenter before proceeding.
1649 int const scrolled = scroll(act == LFUN_SCREEN_UP
1650 ? -height_ : height_);
1651 if (act == LFUN_SCREEN_UP && scrolled > -height_)
1653 if (act == LFUN_SCREEN_DOWN && scrolled < height_)
1654 p = Point(width_, height_);
1656 bool const in_texted = cur.inTexted();
1658 buffer_.changed(true);
1659 updateHoveredInset();
1661 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_,
1662 true, act == LFUN_SCREEN_UP);
1663 //FIXME: what to do with cur.x_target()?
1664 bool update = in_texted && cur.bv().checkDepm(cur, old);
1667 dr.update(Update::Force | Update::FitCursor);
1668 dr.forceBufferUpdate();
1675 dr.forceBufferUpdate();
1678 case LFUN_SCREEN_UP_SELECT: {
1679 cur.selHandle(true);
1680 if (isTopScreen()) {
1681 lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1685 int y = getPos(cur).y_;
1686 int const ymin = y - height_ + defaultRowHeight();
1687 while (y > ymin && cur.up())
1691 dr.update(Update::SinglePar | Update::FitCursor);
1695 case LFUN_SCREEN_DOWN_SELECT: {
1696 cur.selHandle(true);
1697 if (isBottomScreen()) {
1698 lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1702 int y = getPos(cur).y_;
1703 int const ymax = y + height_ - defaultRowHeight();
1704 while (y < ymax && cur.down())
1708 dr.update(Update::SinglePar | Update::FitCursor);
1713 // This would be in Buffer class if only Cursor did not
1714 // require a bufferview
1715 case LFUN_INSET_FORALL: {
1716 docstring const name = from_utf8(cmd.getArg(0));
1717 string const commandstr = cmd.getLongArg(1);
1718 FuncRequest const fr = lyxaction.lookupFunc(commandstr);
1720 // an arbitrary number to limit number of iterations
1721 const int max_iter = 10000;
1723 Cursor & cur = d->cursor_;
1724 Cursor const savecur = cur;
1726 if (!cur.nextInset())
1728 cur.beginUndoGroup();
1729 while(cur && iterations < max_iter) {
1730 Inset * ins = cur.nextInset();
1733 docstring insname = ins->name();
1734 while (!insname.empty()) {
1735 if (insname == name || name == from_utf8("*")) {
1737 lyx::dispatch(fr, dr);
1741 size_t const i = insname.rfind(':');
1742 if (i == string::npos)
1744 insname = insname.substr(0, i);
1751 dr.update(Update::Force);
1752 dr.forceBufferUpdate();
1754 if (iterations >= max_iter) {
1756 dr.setMessage(bformat(_("`inset-forall' interrupted because number of actions is larger than %1$d"), max_iter));
1758 dr.setMessage(bformat(_("Applied \"%1$s\" to %2$d insets"), from_utf8(commandstr), iterations));
1763 case LFUN_BRANCH_ADD_INSERT: {
1764 docstring branch_name = from_utf8(cmd.getArg(0));
1765 if (branch_name.empty())
1766 if (!Alert::askForText(branch_name, _("Branch name")) ||
1767 branch_name.empty())
1770 DispatchResult drtmp;
1771 buffer_.dispatch(FuncRequest(LFUN_BRANCH_ADD, branch_name), drtmp);
1772 if (drtmp.error()) {
1773 Alert::warning(_("Branch already exists"), drtmp.message());
1776 BranchList & branch_list = buffer_.params().branchlist();
1777 vector<docstring> const branches =
1778 getVectorFromString(branch_name, branch_list.separator());
1779 for (vector<docstring>::const_iterator it = branches.begin();
1780 it != branches.end(); ++it) {
1782 lyx::dispatch(FuncRequest(LFUN_BRANCH_INSERT, branch_name));
1787 case LFUN_KEYMAP_OFF:
1788 getIntl().keyMapOn(false);
1791 case LFUN_KEYMAP_PRIMARY:
1792 getIntl().keyMapPrim();
1795 case LFUN_KEYMAP_SECONDARY:
1796 getIntl().keyMapSec();
1799 case LFUN_KEYMAP_TOGGLE:
1800 getIntl().toggleKeyMap();
1803 case LFUN_DIALOG_SHOW_NEW_INSET: {
1804 string const name = cmd.getArg(0);
1805 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
1806 if (decodeInsetParam(name, data, buffer_))
1807 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
1809 lyxerr << "Inset type '" << name <<
1810 "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" << endl;
1814 case LFUN_CITATION_INSERT: {
1815 if (argument.empty()) {
1816 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
1819 // we can have one optional argument, delimited by '|'
1820 // citation-insert <key>|<text_before>
1821 // this should be enhanced to also support text_after
1822 // and citation style
1823 string arg = argument;
1825 if (contains(argument, "|")) {
1826 arg = token(argument, '|', 0);
1827 opt1 = token(argument, '|', 1);
1829 InsetCommandParams icp(CITE_CODE);
1830 icp["key"] = from_utf8(arg);
1832 icp["before"] = from_utf8(opt1);
1833 string icstr = InsetCommand::params2string("citation", icp);
1834 FuncRequest fr(LFUN_INSET_INSERT, icstr);
1839 case LFUN_INSET_APPLY: {
1840 string const name = cmd.getArg(0);
1841 Inset * inset = editedInset(name);
1843 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1847 // put cursor in front of inset.
1848 if (!setCursorFromInset(inset)) {
1849 LASSERT(false, break);
1852 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1853 inset->dispatch(cur, fr);
1854 dr.update(Update::SinglePar | Update::FitCursor);
1855 dr.forceBufferUpdate();
1864 buffer_.undo().endUndoGroup();
1865 dr.dispatched(dispatched);
1870 docstring const BufferView::requestSelection()
1872 Cursor & cur = d->cursor_;
1874 LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
1875 if (!cur.selection()) {
1876 d->xsel_cache_.set = false;
1880 LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
1881 if (!d->xsel_cache_.set ||
1882 cur.top() != d->xsel_cache_.cursor ||
1883 cur.realAnchor().top() != d->xsel_cache_.anchor)
1885 d->xsel_cache_.cursor = cur.top();
1886 d->xsel_cache_.anchor = cur.realAnchor().top();
1887 d->xsel_cache_.set = cur.selection();
1888 return cur.selectionAsString(false);
1894 void BufferView::clearSelection()
1896 d->cursor_.clearSelection();
1897 // Clear the selection buffer. Otherwise a subsequent
1898 // middle-mouse-button paste would use the selection buffer,
1899 // not the more current external selection.
1900 cap::clearSelection();
1901 d->xsel_cache_.set = false;
1902 // The buffer did not really change, but this causes the
1903 // redraw we need because we cleared the selection above.
1904 buffer_.changed(false);
1908 void BufferView::resize(int width, int height)
1910 // Update from work area
1914 // Clear the paragraph height cache.
1915 d->par_height_.clear();
1916 // Redo the metrics.
1921 Inset const * BufferView::getCoveringInset(Text const & text,
1924 TextMetrics & tm = d->text_metrics_[&text];
1925 Inset * inset = tm.checkInsetHit(x, y);
1929 if (!inset->descendable(*this))
1930 // No need to go further down if the inset is not
1934 size_t cell_number = inset->nargs();
1935 // Check all the inner cell.
1936 for (size_t i = 0; i != cell_number; ++i) {
1937 Text const * inner_text = inset->getText(i);
1940 Inset const * inset_deeper =
1941 getCoveringInset(*inner_text, x, y);
1943 return inset_deeper;
1951 void BufferView::updateHoveredInset() const
1953 // Get inset under mouse, if there is one.
1954 Inset const * covering_inset = getCoveringInset(buffer_.text(),
1955 d->mouse_position_cache_.x_, d->mouse_position_cache_.y_);
1956 if (covering_inset == d->last_inset_)
1957 // Same inset, no need to do anything...
1960 bool need_redraw = false;
1961 if (d->last_inset_) {
1962 // Remove the hint on the last hovered inset (if any).
1963 need_redraw |= d->last_inset_->setMouseHover(this, false);
1967 // const_cast because of setMouseHover().
1968 Inset * inset = const_cast<Inset *>(covering_inset);
1969 if (inset && inset->setMouseHover(this, true)) {
1971 // Only the insets that accept the hover state, do
1972 // clear the last_inset_, so only set the last_inset_
1973 // member if the hovered setting is accepted.
1974 d->last_inset_ = inset;
1978 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
1979 << d->mouse_position_cache_.x_ << ", "
1980 << d->mouse_position_cache_.y_ << ")");
1982 d->update_strategy_ = DecorationUpdate;
1984 // This event (moving without mouse click) is not passed further.
1985 // This should be changed if it is further utilized.
1986 buffer_.changed(false);
1991 void BufferView::clearLastInset(Inset * inset) const
1993 if (d->last_inset_ != inset) {
1994 LYXERR0("Wrong last_inset!");
1995 LASSERT(false, /**/);
2001 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
2003 //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
2005 // This is only called for mouse related events including
2006 // LFUN_FILE_OPEN generated by drag-and-drop.
2007 FuncRequest cmd = cmd0;
2009 Cursor old = cursor();
2011 cur.push(buffer_.inset());
2012 cur.setSelection(d->cursor_.selection());
2014 // Either the inset under the cursor or the
2015 // surrounding Text will handle this event.
2017 // make sure we stay within the screen...
2018 cmd.set_y(min(max(cmd.y(), -1), height_));
2020 d->mouse_position_cache_.x_ = cmd.x();
2021 d->mouse_position_cache_.y_ = cmd.y();
2023 if (cmd.action() == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
2024 updateHoveredInset();
2028 // Build temporary cursor.
2029 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x(), cmd.y());
2031 // Put anchor at the same position.
2034 cur.beginUndoGroup();
2036 // Try to dispatch to an non-editable inset near this position
2037 // via the temp cursor. If the inset wishes to change the real
2038 // cursor it has to do so explicitly by using
2039 // cur.bv().cursor() = cur; (or similar)
2041 inset->dispatch(cur, cmd);
2043 // Now dispatch to the temporary cursor. If the real cursor should
2044 // be modified, the inset's dispatch has to do so explicitly.
2045 if (!inset || !cur.result().dispatched())
2050 // Notify left insets
2053 bool badcursor = notifyCursorLeavesOrEnters(old, cur);
2055 cursor().fixIfBroken();
2058 // Do we have a selection?
2059 theSelection().haveSelection(cursor().selection());
2061 // If the command has been dispatched,
2062 if (cur.result().dispatched() || cur.result().update())
2063 processUpdateFlags(cur.result().update());
2067 void BufferView::lfunScroll(FuncRequest const & cmd)
2069 string const scroll_type = cmd.getArg(0);
2070 int scroll_step = 0;
2071 if (scroll_type == "line")
2072 scroll_step = d->scrollbarParameters_.single_step;
2073 else if (scroll_type == "page")
2074 scroll_step = d->scrollbarParameters_.page_step;
2077 string const scroll_quantity = cmd.getArg(1);
2078 if (scroll_quantity == "up")
2079 scrollUp(scroll_step);
2080 else if (scroll_quantity == "down")
2081 scrollDown(scroll_step);
2083 int const scroll_value = convert<int>(scroll_quantity);
2085 scroll(scroll_step * scroll_value);
2087 buffer_.changed(true);
2088 updateHoveredInset();
2092 int BufferView::minVisiblePart()
2094 return 2 * defaultRowHeight();
2098 int BufferView::scroll(int y)
2101 return scrollDown(y);
2103 return scrollUp(-y);
2108 int BufferView::scrollDown(int offset)
2110 Text * text = &buffer_.text();
2111 TextMetrics & tm = d->text_metrics_[text];
2112 int const ymax = height_ + offset;
2114 pair<pit_type, ParagraphMetrics const *> last = tm.last();
2115 int bottom_pos = last.second->position() + last.second->descent();
2116 if (lyxrc.scroll_below_document)
2117 bottom_pos += height_ - minVisiblePart();
2118 if (last.first + 1 == int(text->paragraphs().size())) {
2119 if (bottom_pos <= height_)
2121 offset = min(offset, bottom_pos - height_);
2124 if (bottom_pos > ymax)
2126 tm.newParMetricsDown();
2128 d->anchor_ypos_ -= offset;
2133 int BufferView::scrollUp(int offset)
2135 Text * text = &buffer_.text();
2136 TextMetrics & tm = d->text_metrics_[text];
2137 int ymin = - offset;
2139 pair<pit_type, ParagraphMetrics const *> first = tm.first();
2140 int top_pos = first.second->position() - first.second->ascent();
2141 if (first.first == 0) {
2144 offset = min(offset, - top_pos);
2149 tm.newParMetricsUp();
2151 d->anchor_ypos_ += offset;
2156 void BufferView::setCursorFromRow(int row)
2161 buffer_.texrow().getIdFromRow(row, tmpid, tmppos);
2165 buffer_.text().setCursor(d->cursor_, 0, 0);
2167 buffer_.text().setCursor(d->cursor_, buffer_.getParFromID(tmpid).pit(), tmppos);
2172 bool BufferView::setCursorFromInset(Inset const * inset)
2174 // are we already there?
2175 if (cursor().nextInset() == inset)
2178 // Inset is not at cursor position. Find it in the document.
2181 while (cur && cur.nextInset() != inset)
2192 void BufferView::gotoLabel(docstring const & label)
2194 std::vector<Buffer const *> bufs = buffer().allRelatives();
2195 std::vector<Buffer const *>::iterator it = bufs.begin();
2196 for (; it != bufs.end(); ++it) {
2197 Buffer const * buf = *it;
2200 Toc & toc = buf->tocBackend().toc("label");
2201 TocIterator toc_it = toc.begin();
2202 TocIterator end = toc.end();
2203 for (; toc_it != end; ++toc_it) {
2204 if (label == toc_it->str()) {
2205 lyx::dispatch(toc_it->action());
2213 TextMetrics const & BufferView::textMetrics(Text const * t) const
2215 return const_cast<BufferView *>(this)->textMetrics(t);
2219 TextMetrics & BufferView::textMetrics(Text const * t)
2221 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
2222 if (tmc_it == d->text_metrics_.end()) {
2223 tmc_it = d->text_metrics_.insert(
2224 make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
2226 return tmc_it->second;
2230 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
2233 return textMetrics(t).parMetrics(pit);
2237 int BufferView::workHeight() const
2243 void BufferView::setCursor(DocIterator const & dit)
2246 size_t const n = dit.depth();
2247 for (size_t i = 0; i < n; ++i)
2248 dit[i].inset().edit(d->cursor_, true);
2250 d->cursor_.setCursor(dit);
2251 d->cursor_.setSelection(false);
2255 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
2257 // Would be wrong to delete anything if we have a selection.
2258 if (cur.selection())
2261 bool need_anchor_change = false;
2262 bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
2263 need_anchor_change);
2265 if (need_anchor_change)
2273 cur.forceBufferUpdate();
2274 buffer_.changed(true);
2279 bool BufferView::mouseSetCursor(Cursor & cur, bool select)
2281 LASSERT(&cur.bv() == this, /**/);
2284 // this event will clear selection so we save selection for
2285 // persistent selection
2286 cap::saveSelection(cursor());
2288 d->cursor_.macroModeClose();
2290 // Has the cursor just left the inset?
2291 bool leftinset = (&d->cursor_.inset() != &cur.inset());
2293 d->cursor_.fixIfBroken();
2295 // FIXME: shift-mouse selection doesn't work well across insets.
2296 bool do_selection = select && &d->cursor_.normalAnchor().inset() == &cur.inset();
2298 // do the dEPM magic if needed
2299 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
2300 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
2301 // the leftinset bool would not be necessary (badcursor instead).
2302 bool update = leftinset;
2303 if (!do_selection && d->cursor_.inTexted())
2304 update |= checkDepm(cur, d->cursor_);
2307 d->cursor_.resetAnchor();
2308 d->cursor_.setCursor(cur);
2309 d->cursor_.boundary(cur.boundary());
2311 d->cursor_.setSelection();
2313 d->cursor_.clearSelection();
2315 d->cursor_.finishUndo();
2316 d->cursor_.setCurrentFont();
2318 cur.forceBufferUpdate();
2323 void BufferView::putSelectionAt(DocIterator const & cur,
2324 int length, bool backwards)
2326 d->cursor_.clearSelection();
2332 d->cursor_.pos() += length;
2333 d->cursor_.setSelection(d->cursor_, -length);
2335 d->cursor_.setSelection(d->cursor_, length);
2337 // Ensure a redraw happens in any case because the new selection could
2338 // possibly be on the same screen as the previous selection.
2339 processUpdateFlags(Update::Force | Update::FitCursor);
2343 Cursor & BufferView::cursor()
2349 Cursor const & BufferView::cursor() const
2355 pit_type BufferView::anchor_ref() const
2357 return d->anchor_pit_;
2361 bool BufferView::singleParUpdate()
2363 Text & buftext = buffer_.text();
2364 pit_type const bottom_pit = d->cursor_.bottom().pit();
2365 TextMetrics & tm = textMetrics(&buftext);
2366 int old_height = tm.parMetrics(bottom_pit).height();
2368 // make sure inline completion pointer is ok
2369 if (d->inlineCompletionPos_.fixIfBroken())
2370 d->inlineCompletionPos_ = DocIterator();
2372 // In Single Paragraph mode, rebreak only
2373 // the (main text, not inset!) paragraph containing the cursor.
2374 // (if this paragraph contains insets etc., rebreaking will
2375 // recursively descend)
2376 tm.redoParagraph(bottom_pit);
2377 ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
2378 if (pm.height() != old_height)
2379 // Paragraph height has changed so we cannot proceed to
2380 // the singlePar optimisation.
2383 d->update_strategy_ = SingleParUpdate;
2385 LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
2386 << " y2: " << pm.position() + pm.descent()
2387 << " pit: " << bottom_pit
2388 << " singlepar: 1");
2393 void BufferView::updateMetrics()
2395 if (height_ == 0 || width_ == 0)
2398 Text & buftext = buffer_.text();
2399 pit_type const npit = int(buftext.paragraphs().size());
2401 // Clear out the position cache in case of full screen redraw,
2402 d->coord_cache_.clear();
2404 // Clear out paragraph metrics to avoid having invalid metrics
2405 // in the cache from paragraphs not relayouted below
2406 // The complete text metrics will be redone.
2407 d->text_metrics_.clear();
2409 TextMetrics & tm = textMetrics(&buftext);
2411 // make sure inline completion pointer is ok
2412 if (d->inlineCompletionPos_.fixIfBroken())
2413 d->inlineCompletionPos_ = DocIterator();
2415 if (d->anchor_pit_ >= npit)
2416 // The anchor pit must have been deleted...
2417 d->anchor_pit_ = npit - 1;
2419 // Rebreak anchor paragraph.
2420 tm.redoParagraph(d->anchor_pit_);
2421 ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
2424 if (d->anchor_pit_ == 0) {
2425 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
2427 // Complete buffer visible? Then it's easy.
2428 if (scrollRange == 0)
2429 d->anchor_ypos_ = anchor_pm.ascent();
2431 // FIXME: Some clever handling needed to show
2432 // the _first_ paragraph up to the top if the cursor is
2433 // in the first line.
2435 anchor_pm.setPosition(d->anchor_ypos_);
2437 LYXERR(Debug::PAINTING, "metrics: "
2438 << " anchor pit = " << d->anchor_pit_
2439 << " anchor ypos = " << d->anchor_ypos_);
2441 // Redo paragraphs above anchor if necessary.
2442 int y1 = d->anchor_ypos_ - anchor_pm.ascent();
2443 // We are now just above the anchor paragraph.
2444 pit_type pit1 = d->anchor_pit_ - 1;
2445 for (; pit1 >= 0 && y1 >= 0; --pit1) {
2446 tm.redoParagraph(pit1);
2447 ParagraphMetrics & pm = tm.par_metrics_[pit1];
2449 // Save the paragraph position in the cache.
2454 // Redo paragraphs below the anchor if necessary.
2455 int y2 = d->anchor_ypos_ + anchor_pm.descent();
2456 // We are now just below the anchor paragraph.
2457 pit_type pit2 = d->anchor_pit_ + 1;
2458 for (; pit2 < npit && y2 <= height_; ++pit2) {
2459 tm.redoParagraph(pit2);
2460 ParagraphMetrics & pm = tm.par_metrics_[pit2];
2462 // Save the paragraph position in the cache.
2467 LYXERR(Debug::PAINTING, "Metrics: "
2468 << " anchor pit = " << d->anchor_pit_
2469 << " anchor ypos = " << d->anchor_ypos_
2472 << " pit1 = " << pit1
2473 << " pit2 = " << pit2);
2475 d->update_strategy_ = FullScreenUpdate;
2477 if (lyxerr.debugging(Debug::WORKAREA)) {
2478 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
2479 d->coord_cache_.dump();
2484 void BufferView::insertLyXFile(FileName const & fname)
2486 LASSERT(d->cursor_.inTexted(), /**/);
2488 // Get absolute path of file and add ".lyx"
2489 // to the filename if necessary
2490 FileName filename = fileSearch(string(), fname.absFileName(), "lyx");
2492 docstring const disp_fn = makeDisplayPath(filename.absFileName());
2493 // emit message signal.
2494 message(bformat(_("Inserting document %1$s..."), disp_fn));
2497 Buffer buf("", false);
2498 if (buf.loadLyXFile(filename)) {
2499 ErrorList & el = buffer_.errorList("Parse");
2500 // Copy the inserted document error list into the current buffer one.
2501 el = buf.errorList("Parse");
2502 buffer_.undo().recordUndo(d->cursor_);
2503 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
2504 buf.params().documentClassPtr(), el);
2505 res = _("Document %1$s inserted.");
2507 res = _("Could not insert document %1$s");
2510 buffer_.changed(true);
2511 // emit message signal.
2512 message(bformat(res, disp_fn));
2513 buffer_.errors("Parse");
2517 Point BufferView::coordOffset(DocIterator const & dit) const
2523 // Addup contribution of nested insets, from inside to outside,
2524 // keeping the outer paragraph for a special handling below
2525 for (size_t i = dit.depth() - 1; i >= 1; --i) {
2526 CursorSlice const & sl = dit[i];
2530 // get relative position inside sl.inset()
2531 sl.inset().cursorPos(*this, sl, dit.boundary() && (i + 1 == dit.depth()), xx, yy);
2533 // Make relative position inside of the edited inset relative to sl.inset()
2537 // In case of an RTL inset, the edited inset will be positioned to the left
2540 bool boundary_i = dit.boundary() && i + 1 == dit.depth();
2541 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2546 // remember width for the case that sl.inset() is positioned in an RTL inset
2547 if (i && dit[i - 1].text()) {
2548 // If this Inset is inside a Text Inset, retrieve the Dimension
2549 // from the containing text instead of using Inset::dimension() which
2550 // might not be implemented.
2551 // FIXME (Abdel 23/09/2007): this is a bit messy because of the
2552 // elimination of Inset::dim_ cache. This coordOffset() method needs
2553 // to be rewritten in light of the new design.
2554 Dimension const & dim = parMetrics(dit[i - 1].text(),
2555 dit[i - 1].pit()).insetDimension(&sl.inset());
2558 Dimension const dim = sl.inset().dimension(*this);
2562 //lyxerr << "Cursor::getPos, i: "
2563 // << i << " x: " << xx << " y: " << y << endl;
2566 // Add contribution of initial rows of outermost paragraph
2567 CursorSlice const & sl = dit[0];
2568 TextMetrics const & tm = textMetrics(sl.text());
2569 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2570 LASSERT(!pm.rows().empty(), /**/);
2571 y -= pm.rows()[0].ascent();
2573 // FIXME: document this mess
2575 if (sl.pos() > 0 && dit.depth() == 1) {
2577 if (pos && dit.boundary())
2579 // lyxerr << "coordOffset: boundary:" << dit.boundary() << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
2580 rend = pm.pos2row(pos);
2582 rend = pm.pos2row(sl.pos());
2584 size_t rend = pm.pos2row(sl.pos());
2586 for (size_t rit = 0; rit != rend; ++rit)
2587 y += pm.rows()[rit].height();
2588 y += pm.rows()[rend].ascent();
2590 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
2592 // Make relative position from the nested inset now bufferview absolute.
2593 int xx = bottom_tm.cursorX(dit.bottom(), dit.boundary() && dit.depth() == 1);
2596 // In the RTL case place the nested inset at the left of the cursor in
2597 // the outer paragraph
2598 bool boundary_1 = dit.boundary() && 1 == dit.depth();
2599 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
2607 Point BufferView::getPos(DocIterator const & dit) const
2609 if (!paragraphVisible(dit))
2610 return Point(-1, -1);
2612 CursorSlice const & bot = dit.bottom();
2613 TextMetrics const & tm = textMetrics(bot.text());
2615 // offset from outer paragraph
2616 Point p = coordOffset(dit);
2617 p.y_ += tm.parMetrics(bot.pit()).position();
2622 bool BufferView::paragraphVisible(DocIterator const & dit) const
2624 CursorSlice const & bot = dit.bottom();
2625 TextMetrics const & tm = textMetrics(bot.text());
2627 return tm.contains(bot.pit());
2631 void BufferView::cursorPosAndHeight(Point & p, int & h) const
2633 Cursor const & cur = cursor();
2634 Font const font = cur.getFont();
2635 frontend::FontMetrics const & fm = theFontMetrics(font);
2636 int const asc = fm.maxAscent();
2637 int const des = fm.maxDescent();
2644 bool BufferView::cursorInView(Point const & p, int h) const
2646 Cursor const & cur = cursor();
2647 // does the cursor touch the screen ?
2648 if (p.y_ + h < 0 || p.y_ >= workHeight() || !paragraphVisible(cur))
2654 void BufferView::draw(frontend::Painter & pain)
2656 if (height_ == 0 || width_ == 0)
2658 LYXERR(Debug::PAINTING, "\t\t*** START DRAWING ***");
2660 Text & text = buffer_.text();
2661 TextMetrics const & tm = d->text_metrics_[&text];
2662 int const y = tm.first().second->position();
2663 PainterInfo pi(this, pain);
2665 switch (d->update_strategy_) {
2667 case NoScreenUpdate:
2668 // If no screen painting is actually needed, only some the different
2669 // coordinates of insets and paragraphs needs to be updated.
2670 pi.full_repaint = true;
2671 pi.pain.setDrawingEnabled(false);
2675 case SingleParUpdate:
2676 pi.full_repaint = false;
2677 // In general, only the current row of the outermost paragraph
2678 // will be redrawn. Particular cases where selection spans
2679 // multiple paragraph are correctly detected in TextMetrics.
2683 case DecorationUpdate:
2684 // FIXME: We should also distinguish DecorationUpdate to avoid text
2685 // drawing if possible. This is not possible to do easily right now
2686 // because of the single backing pixmap.
2688 case FullScreenUpdate:
2689 // The whole screen, including insets, will be refreshed.
2690 pi.full_repaint = true;
2692 // Clear background.
2693 pain.fillRectangle(0, 0, width_, height_,
2694 pi.backgroundColor(&buffer_.inset()));
2699 // and possibly grey out below
2700 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2701 int const y2 = lastpm.second->position() + lastpm.second->descent();
2704 Color color = buffer().isInternal()
2705 ? Color_background : Color_bottomarea;
2706 pain.fillRectangle(0, y2, width_, height_ - y2, color);
2710 LYXERR(Debug::PAINTING, "\n\t\t*** END DRAWING ***");
2712 // The scrollbar needs an update.
2715 // Normalize anchor for next time
2716 pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
2717 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2718 for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
2719 ParagraphMetrics const & pm = tm.parMetrics(pit);
2720 if (pm.position() + pm.descent() > 0) {
2721 d->anchor_pit_ = pit;
2722 d->anchor_ypos_ = pm.position();
2726 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
2727 << " anchor ypos = " << d->anchor_ypos_);
2731 void BufferView::message(docstring const & msg)
2734 d->gui_->message(msg);
2738 void BufferView::showDialog(string const & name)
2741 d->gui_->showDialog(name, string());
2745 void BufferView::showDialog(string const & name,
2746 string const & data, Inset * inset)
2749 d->gui_->showDialog(name, data, inset);
2753 void BufferView::updateDialog(string const & name, string const & data)
2756 d->gui_->updateDialog(name, data);
2760 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
2766 // FIXME: Move this out of BufferView again
2767 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
2769 if (!fname.isReadableFile()) {
2770 docstring const error = from_ascii(strerror(errno));
2771 docstring const file = makeDisplayPath(fname.absFileName(), 50);
2772 docstring const text =
2773 bformat(_("Could not read the specified document\n"
2774 "%1$s\ndue to the error: %2$s"), file, error);
2775 Alert::error(_("Could not read file"), text);
2779 if (!fname.isReadableFile()) {
2780 docstring const file = makeDisplayPath(fname.absFileName(), 50);
2781 docstring const text =
2782 bformat(_("%1$s\n is not readable."), file);
2783 Alert::error(_("Could not open file"), text);
2787 // FIXME UNICODE: We don't know the encoding of the file
2788 docstring file_content = fname.fileContents("UTF-8");
2789 if (file_content.empty()) {
2790 Alert::error(_("Reading not UTF-8 encoded file"),
2791 _("The file is not UTF-8 encoded.\n"
2792 "It will be read as local 8Bit-encoded.\n"
2793 "If this does not give the correct result\n"
2794 "then please change the encoding of the file\n"
2795 "to UTF-8 with a program other than LyX.\n"));
2796 file_content = fname.fileContents("local8bit");
2799 return normalize_c(file_content);
2803 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
2805 docstring const tmpstr = contentsOfPlaintextFile(f);
2810 Cursor & cur = cursor();
2811 cap::replaceSelection(cur);
2812 buffer_.undo().recordUndo(cur);
2814 cur.innerText()->insertStringAsParagraphs(cur, tmpstr, cur.current_font);
2816 cur.innerText()->insertStringAsLines(cur, tmpstr, cur.current_font);
2818 buffer_.changed(true);
2822 docstring const & BufferView::inlineCompletion() const
2824 return d->inlineCompletion_;
2828 size_t const & BufferView::inlineCompletionUniqueChars() const
2830 return d->inlineCompletionUniqueChars_;
2834 DocIterator const & BufferView::inlineCompletionPos() const
2836 return d->inlineCompletionPos_;
2840 bool samePar(DocIterator const & a, DocIterator const & b)
2842 if (a.empty() && b.empty())
2844 if (a.empty() || b.empty())
2846 if (a.depth() != b.depth())
2848 return &a.innerParagraph() == &b.innerParagraph();
2852 void BufferView::setInlineCompletion(Cursor & cur, DocIterator const & pos,
2853 docstring const & completion, size_t uniqueChars)
2855 uniqueChars = min(completion.size(), uniqueChars);
2856 bool changed = d->inlineCompletion_ != completion
2857 || d->inlineCompletionUniqueChars_ != uniqueChars;
2858 bool singlePar = true;
2859 d->inlineCompletion_ = completion;
2860 d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
2862 //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
2865 DocIterator const & old = d->inlineCompletionPos_;
2867 //lyxerr << "inlineCompletionPos changed" << std::endl;
2868 // old or pos are in another paragraph?
2869 if ((!samePar(cur, pos) && !pos.empty())
2870 || (!samePar(cur, old) && !old.empty())) {
2872 //lyxerr << "different paragraph" << std::endl;
2874 d->inlineCompletionPos_ = pos;
2879 if (singlePar && !(cur.result().update() & Update::Force))
2880 cur.screenUpdateFlags(cur.result().update() | Update::SinglePar);
2882 cur.screenUpdateFlags(cur.result().update() | Update::Force);