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;
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;
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
460 // updateMetrics() does not update paragraph position
461 // This is done at draw() time. So we need a redraw!
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;
581 // cut off at the top
582 if (value <= d->scrollbarParameters_.min) {
583 DocIterator dit = doc_iterator_begin(&buffer_);
585 LYXERR(Debug::SCROLLING, "scroll to top");
589 // cut off at the bottom
590 if (value >= d->scrollbarParameters_.max) {
591 DocIterator dit = doc_iterator_end(&buffer_);
594 LYXERR(Debug::SCROLLING, "scroll to bottom");
598 // find paragraph at target position
599 int par_pos = d->scrollbarParameters_.min;
601 for (; i != int(d->par_height_.size()); ++i) {
602 par_pos += d->par_height_[i];
603 if (par_pos >= value)
607 if (par_pos < value) {
608 // It seems we didn't find the correct pit so stay on the safe side and
610 LYXERR0("scrolling position not found!");
611 scrollDocView(d->scrollbarParameters_.max);
615 DocIterator dit = doc_iterator_begin(&buffer_);
617 LYXERR(Debug::SCROLLING, "value = " << value << " -> scroll to pit " << i);
622 // FIXME: this method is not working well.
623 void BufferView::setCursorFromScrollbar()
625 TextMetrics & tm = d->text_metrics_[&buffer_.text()];
627 int const height = 2 * defaultRowHeight();
628 int const first = height;
629 int const last = height_ - height;
631 Cursor const & oldcur = d->cursor_;
633 switch (cursorStatus(oldcur)) {
641 int const y = getPos(oldcur, oldcur.boundary()).y_;
642 newy = min(last, max(y, first));
646 // We reset the cursor because cursorStatus() does not
647 // work when the cursor is within mathed.
650 tm.setCursorFromCoordinates(cur, 0, newy);
652 // update the bufferview cursor and notify insets
653 // FIXME: Care about the d->cursor_ flags to redraw if needed
654 Cursor old = d->cursor_;
656 bool badcursor = notifyCursorLeavesOrEnters(old, d->cursor_);
658 d->cursor_.fixIfBroken();
662 Change const BufferView::getCurrentChange() const
664 if (!d->cursor_.selection())
665 return Change(Change::UNCHANGED);
667 DocIterator dit = d->cursor_.selectionBegin();
668 return dit.paragraph().lookupChange(dit.pos());
672 // this could be used elsewhere as well?
673 // FIXME: This does not work within mathed!
674 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
676 Point const p = getPos(dit, dit.boundary());
679 if (p.y_ > workHeight())
685 void BufferView::bookmarkEditPosition()
687 // Don't eat cpu time for each keystroke
688 if (d->cursor_.paragraph().id() == d->bookmark_edit_position_)
691 d->bookmark_edit_position_ = d->cursor_.paragraph().id();
695 void BufferView::saveBookmark(unsigned int idx)
697 // tentatively save bookmark, id and pos will be used to
698 // acturately locate a bookmark in a 'live' lyx session.
699 // pit and pos will be updated with bottom level pit/pos
701 theSession().bookmarks().save(
703 d->cursor_.bottom().pit(),
704 d->cursor_.bottom().pos(),
705 d->cursor_.paragraph().id(),
710 // emit message signal.
711 message(_("Save bookmark"));
715 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
716 int top_id, pos_type top_pos)
718 bool success = false;
721 d->cursor_.clearSelection();
723 // if a valid par_id is given, try it first
724 // This is the case for a 'live' bookmark when unique paragraph ID
725 // is used to track bookmarks.
727 dit = buffer_.getParFromID(top_id);
729 dit.pos() = min(dit.paragraph().size(), top_pos);
730 // Some slices of the iterator may not be
731 // reachable (e.g. closed collapsable inset)
732 // so the dociterator may need to be
733 // shortened. Otherwise, setCursor may crash
734 // lyx when the cursor can not be set to these
736 size_t const n = dit.depth();
737 for (size_t i = 0; i < n; ++i)
738 if (!dit[i].inset().editable()) {
746 // if top_id == 0, or searching through top_id failed
747 // This is the case for a 'restored' bookmark when only bottom
748 // (document level) pit was saved. Because of this, bookmark
749 // restoration is inaccurate. If a bookmark was within an inset,
750 // it will be restored to the left of the outmost inset that contains
752 if (bottom_pit < int(buffer_.paragraphs().size())) {
753 dit = doc_iterator_begin(&buffer_);
755 dit.pit() = bottom_pit;
756 dit.pos() = min(bottom_pos, dit.paragraph().size());
761 // Note: only bottom (document) level pit is set.
763 // set the current font.
764 d->cursor_.setCurrentFont();
765 // To center the screen on this new position we need the
766 // paragraph position which is computed at draw() time.
767 // So we need a redraw!
777 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
779 if (lyxrc.rtl_support) {
780 if (d->cursor_.real_current_font.isRightToLeft()) {
781 if (d->intl_.keymap == Intl::PRIMARY)
782 d->intl_.keyMapSec();
784 if (d->intl_.keymap == Intl::SECONDARY)
785 d->intl_.keyMapPrim();
789 d->intl_.getTransManager().translateAndInsert(c, t, cur);
793 int BufferView::workWidth() const
799 void BufferView::recenter()
801 showCursor(d->cursor_, true);
805 void BufferView::showCursor()
807 showCursor(d->cursor_, false);
811 void BufferView::showCursor(DocIterator const & dit, bool recenter)
813 if (scrollToCursor(dit, recenter))
818 void BufferView::scrollToCursor()
820 scrollToCursor(d->cursor_, false);
824 bool BufferView::scrollToCursor(DocIterator const & dit, bool recenter)
826 // We are not properly started yet, delay until resizing is
831 LYXERR(Debug::SCROLLING, "recentering!");
833 CursorSlice const & bot = dit.bottom();
834 TextMetrics & tm = d->text_metrics_[bot.text()];
836 pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
837 int bot_pit = bot.pit();
838 if (bot_pit > max_pit) {
839 // FIXME: Why does this happen?
840 LYXERR0("bottom pit is greater that max pit: "
841 << bot_pit << " > " << max_pit);
845 if (bot_pit == tm.first().first - 1)
846 tm.newParMetricsUp();
847 else if (bot_pit == tm.last().first + 1)
848 tm.newParMetricsDown();
850 if (tm.contains(bot_pit)) {
851 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
852 LASSERT(!pm.rows().empty(), /**/);
853 // FIXME: smooth scrolling doesn't work in mathed.
854 CursorSlice const & cs = dit.innerTextSlice();
855 int offset = coordOffset(dit, dit.boundary()).y_;
856 int ypos = pm.position() + offset;
857 Dimension const & row_dim =
858 pm.getRow(cs.pos(), dit.boundary()).dimension();
861 scrolled = scroll(ypos - height_/2);
862 else if (ypos - row_dim.ascent() < 0)
863 scrolled = scrollUp(- ypos + row_dim.ascent());
864 else if (ypos + row_dim.descent() > height_)
865 scrolled = scrollDown(ypos - height_ + defaultRowHeight() );
867 // else, nothing to do, the cursor is already visible so we just return.
875 // fix inline completion position
876 if (d->inlineCompletionPos_.fixIfBroken())
877 d->inlineCompletionPos_ = DocIterator();
879 tm.redoParagraph(bot_pit);
880 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
881 int offset = coordOffset(dit, dit.boundary()).y_;
883 d->anchor_pit_ = bot_pit;
884 CursorSlice const & cs = dit.innerTextSlice();
885 Dimension const & row_dim =
886 pm.getRow(cs.pos(), dit.boundary()).dimension();
889 d->anchor_ypos_ = height_/2;
890 else if (d->anchor_pit_ == 0)
891 d->anchor_ypos_ = offset + pm.ascent();
892 else if (d->anchor_pit_ == max_pit)
893 d->anchor_ypos_ = height_ - offset - row_dim.descent();
894 else if (offset > height_)
895 d->anchor_ypos_ = height_ - offset - defaultRowHeight();
897 d->anchor_ypos_ = defaultRowHeight() * 2;
904 void BufferView::updateLayout(DocumentClass const * const oldlayout)
906 message(_("Converting document to new document class..."));
908 StableDocIterator backcur(d->cursor_);
909 ErrorList & el = buffer_.errorList("Class Switch");
910 cap::switchBetweenClasses(
911 oldlayout, buffer_.params().documentClassPtr(),
912 static_cast<InsetText &>(buffer_.inset()), el);
914 setCursor(backcur.asDocIterator(&buffer_));
916 buffer_.errors("Class Switch");
917 buffer_.updateLabels();
920 /** Return the change status at cursor position, taking in account the
921 * status at each level of the document iterator (a table in a deleted
922 * footnote is deleted).
923 * When \param outer is true, the top slice is not looked at.
925 static Change::Type lookupChangeType(DocIterator const & dit, bool outer = false)
927 size_t const depth = dit.depth() - (outer ? 1 : 0);
929 for (size_t i = 0 ; i < depth ; ++i) {
930 CursorSlice const & slice = dit[i];
931 if (!slice.inset().inMathed()
932 && slice.pos() < slice.paragraph().size()) {
933 Change::Type const ch = slice.paragraph().lookupChange(slice.pos()).type;
934 if (ch != Change::UNCHANGED)
938 return Change::UNCHANGED;
942 bool BufferView::getStatus(FuncRequest const & cmd, FuncStatus & flag)
944 // Can we use a readonly buffer?
945 if (buffer_.isReadonly()
946 && !lyxaction.funcHasFlag(cmd.action, LyXAction::ReadOnly)
947 && !lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer)) {
948 flag.message(from_utf8(N_("Document is read-only")));
949 flag.setEnabled(false);
952 // Are we in a DELETED change-tracking region?
953 if (lookupChangeType(d->cursor_, true) == Change::DELETED
954 && !lyxaction.funcHasFlag(cmd.action, LyXAction::ReadOnly)
955 && !lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer)) {
956 flag.message(from_utf8(N_("This portion of the document is deleted.")));
957 flag.setEnabled(false);
961 Cursor & cur = d->cursor_;
963 if (cur.getStatus(cmd, flag))
966 switch (cmd.action) {
968 // FIXME: This is a bit problematic because we don't check is this is a
969 // document BufferView or not for these LFUNs. We probably have to
970 // dispatch both to currentBufferView() and, if that fails,
971 // to documentBufferView(); same as we do know for current Buffer and
972 // document Buffer. Ideally those LFUN should go to Buffer as they*
973 // operate on the full Buffer and the cursor is only needed either for
974 // an Undo record or to restore a cursor position. But we don't know
975 // how to do that inside Buffer of course.
976 case LFUN_BUFFER_PARAMS_APPLY:
977 case LFUN_LAYOUT_MODULES_CLEAR:
978 case LFUN_LAYOUT_MODULE_ADD:
979 case LFUN_LAYOUT_RELOAD:
980 case LFUN_TEXTCLASS_APPLY:
981 case LFUN_TEXTCLASS_LOAD:
982 flag.setEnabled(!buffer_.isReadonly());
986 flag.setEnabled(buffer_.undo().hasUndoStack());
989 flag.setEnabled(buffer_.undo().hasRedoStack());
991 case LFUN_FILE_INSERT:
992 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
993 case LFUN_FILE_INSERT_PLAINTEXT:
994 case LFUN_BOOKMARK_SAVE:
995 // FIXME: Actually, these LFUNS should be moved to Text
996 flag.setEnabled(cur.inTexted());
999 case LFUN_FONT_STATE:
1000 case LFUN_LABEL_INSERT:
1001 case LFUN_INFO_INSERT:
1002 case LFUN_INSET_EDIT:
1003 case LFUN_PARAGRAPH_GOTO:
1004 case LFUN_NOTE_NEXT:
1005 case LFUN_REFERENCE_NEXT:
1006 case LFUN_WORD_FIND:
1007 case LFUN_WORD_FIND_FORWARD:
1008 case LFUN_WORD_FIND_BACKWARD:
1009 case LFUN_WORD_FINDADV:
1010 case LFUN_WORD_REPLACE:
1013 case LFUN_MARK_TOGGLE:
1014 case LFUN_SCREEN_RECENTER:
1015 case LFUN_SCREEN_SHOW_CURSOR:
1016 case LFUN_BIBTEX_DATABASE_ADD:
1017 case LFUN_BIBTEX_DATABASE_DEL:
1018 case LFUN_NOTES_MUTATE:
1019 case LFUN_ALL_INSETS_TOGGLE:
1020 case LFUN_STATISTICS:
1021 case LFUN_BRANCH_ADD_INSERT:
1022 case LFUN_KEYMAP_OFF:
1023 case LFUN_KEYMAP_PRIMARY:
1024 case LFUN_KEYMAP_SECONDARY:
1025 case LFUN_KEYMAP_TOGGLE:
1026 flag.setEnabled(true);
1029 case LFUN_REGEXP_MODE:
1030 // FIXME: Test if current WorkArea is the search WorkArea
1031 flag.setEnabled(buffer().isInternal() && !cur.inRegexped());
1034 case LFUN_LABEL_COPY_AS_REF: {
1035 // if there is an inset at cursor, see whether it
1037 Inset * inset = cur.nextInset();
1038 if (!inset || !inset->getStatus(cur, cmd, flag))
1039 flag.setEnabled(false);
1043 case LFUN_NEXT_INSET_MODIFY: {
1044 // this is the real function we want to invoke
1045 FuncRequest tmpcmd = cmd;
1046 tmpcmd.action = LFUN_INSET_MODIFY;
1047 // if there is an inset at cursor, see whether it
1048 // handles the lfun, other start from scratch
1049 Inset * inset = cur.nextInset();
1050 if (!inset || !inset->getStatus(cur, tmpcmd, flag))
1051 flag = lyx::getStatus(tmpcmd);
1055 case LFUN_LABEL_GOTO: {
1056 flag.setEnabled(!cmd.argument().empty()
1057 || getInsetByCode<InsetRef>(cur, REF_CODE));
1061 case LFUN_CHANGES_TRACK:
1062 flag.setEnabled(true);
1063 flag.setOnOff(buffer_.params().trackChanges);
1066 case LFUN_CHANGES_OUTPUT:
1067 flag.setEnabled(true);
1068 flag.setOnOff(buffer_.params().outputChanges);
1071 case LFUN_CHANGES_MERGE:
1072 case LFUN_CHANGE_NEXT:
1073 case LFUN_CHANGE_PREVIOUS:
1074 case LFUN_ALL_CHANGES_ACCEPT:
1075 case LFUN_ALL_CHANGES_REJECT:
1076 // TODO: context-sensitive enabling of LFUNs
1077 // In principle, these command should only be enabled if there
1078 // is a change in the document. However, without proper
1079 // optimizations, this will inevitably result in poor performance.
1080 flag.setEnabled(true);
1083 case LFUN_BUFFER_TOGGLE_COMPRESSION: {
1084 flag.setOnOff(buffer_.params().compressed);
1088 case LFUN_SCREEN_UP:
1089 case LFUN_SCREEN_DOWN:
1091 case LFUN_SCREEN_UP_SELECT:
1092 case LFUN_SCREEN_DOWN_SELECT:
1093 case LFUN_INSET_FORALL:
1094 flag.setEnabled(true);
1097 case LFUN_LAYOUT_TABULAR:
1098 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
1102 flag.setEnabled(!cur.inset().forcePlainLayout(cur.idx()));
1105 case LFUN_LAYOUT_PARAGRAPH:
1106 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
1109 case LFUN_DIALOG_SHOW_NEW_INSET:
1110 // FIXME: this is wrong, but I do not understand the
1112 if (cur.inset().lyxCode() == CAPTION_CODE)
1113 return cur.inset().getStatus(cur, cmd, flag);
1114 // FIXME we should consider passthru paragraphs too.
1115 flag.setEnabled(!cur.inset().getLayout().isPassThru());
1118 case LFUN_CITATION_INSERT: {
1119 FuncRequest fr(LFUN_INSET_INSERT, "citation");
1120 // FIXME: This could turn in a recursive hell.
1121 // Shouldn't we use Buffer::getStatus() instead?
1122 flag.setEnabled(lyx::getStatus(fr).enabled());
1125 case LFUN_INSET_APPLY: {
1126 string const name = cmd.getArg(0);
1127 Inset * inset = editedInset(name);
1129 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1131 if (!inset->getStatus(cur, fr, fs)) {
1132 // Every inset is supposed to handle this
1133 LASSERT(false, break);
1137 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1138 flag |= lyx::getStatus(fr);
1144 flag.setEnabled(false);
1152 Inset * BufferView::editedInset(string const & name) const
1154 map<string, Inset *>::const_iterator it = d->edited_insets_.find(name);
1155 return it == d->edited_insets_.end() ? 0 : it->second;
1159 void BufferView::editInset(string const & name, Inset * inset)
1161 d->edited_insets_[name] = inset;
1165 bool BufferView::dispatch(FuncRequest const & cmd)
1167 //lyxerr << [ cmd = " << cmd << "]" << endl;
1169 // Make sure that the cached BufferView is correct.
1170 LYXERR(Debug::ACTION, " action[" << cmd.action << ']'
1171 << " arg[" << to_utf8(cmd.argument()) << ']'
1172 << " x[" << cmd.x << ']'
1173 << " y[" << cmd.y << ']'
1174 << " button[" << cmd.button() << ']');
1176 string const argument = to_utf8(cmd.argument());
1177 Cursor & cur = d->cursor_;
1179 // Don't dispatch function that does not apply to internal buffers.
1180 if (buffer_.isInternal()
1181 && lyxaction.funcHasFlag(cmd.action, LyXAction::NoInternal))
1184 // We'll set this back to false if need be.
1185 bool dispatched = true;
1186 buffer_.undo().beginUndoGroup();
1188 switch (cmd.action) {
1190 case LFUN_BUFFER_PARAMS_APPLY: {
1191 DocumentClass const * const oldClass = buffer_.params().documentClassPtr();
1192 cur.recordUndoFullDocument();
1193 istringstream ss(to_utf8(cmd.argument()));
1196 int const unknown_tokens = buffer_.readHeader(lex);
1197 if (unknown_tokens != 0) {
1198 LYXERR0("Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1199 << unknown_tokens << " unknown token"
1200 << (unknown_tokens == 1 ? "" : "s"));
1202 updateLayout(oldClass);
1204 // We are most certainly here because of a change in the document
1205 // It is then better to make sure that all dialogs are in sync with
1206 // current document settings.
1207 processUpdateFlags(Update::Force | Update::FitCursor);
1211 case LFUN_LAYOUT_MODULES_CLEAR: {
1212 DocumentClass const * const oldClass =
1213 buffer_.params().documentClassPtr();
1214 cur.recordUndoFullDocument();
1215 buffer_.params().clearLayoutModules();
1216 buffer_.params().makeDocumentClass();
1217 updateLayout(oldClass);
1218 processUpdateFlags(Update::Force | Update::FitCursor);
1222 case LFUN_LAYOUT_MODULE_ADD: {
1223 BufferParams const & params = buffer_.params();
1224 if (!params.moduleCanBeAdded(argument)) {
1225 LYXERR0("Module `" << argument <<
1226 "' cannot be added due to failed requirements or "
1227 "conflicts with installed modules.");
1230 DocumentClass const * const oldClass = params.documentClassPtr();
1231 cur.recordUndoFullDocument();
1232 buffer_.params().addLayoutModule(argument);
1233 buffer_.params().makeDocumentClass();
1234 updateLayout(oldClass);
1235 processUpdateFlags(Update::Force | Update::FitCursor);
1239 case LFUN_TEXTCLASS_APPLY: {
1240 if (!LayoutFileList::get().load(argument, buffer_.temppath()) &&
1241 !LayoutFileList::get().load(argument, buffer_.filePath()))
1244 LayoutFile const * old_layout = buffer_.params().baseClass();
1245 LayoutFile const * new_layout = &(LayoutFileList::get()[argument]);
1247 if (old_layout == new_layout)
1251 //Save the old, possibly modular, layout for use in conversion.
1252 DocumentClass const * const oldDocClass =
1253 buffer_.params().documentClassPtr();
1254 cur.recordUndoFullDocument();
1255 buffer_.params().setBaseClass(argument);
1256 buffer_.params().makeDocumentClass();
1257 updateLayout(oldDocClass);
1258 processUpdateFlags(Update::Force | Update::FitCursor);
1262 case LFUN_TEXTCLASS_LOAD:
1263 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1264 LayoutFileList::get().load(argument, buffer_.filePath());
1267 case LFUN_LAYOUT_RELOAD: {
1268 DocumentClass const * const oldClass = buffer_.params().documentClassPtr();
1269 LayoutFileIndex bc = buffer_.params().baseClassID();
1270 LayoutFileList::get().reset(bc);
1271 buffer_.params().setBaseClass(bc);
1272 buffer_.params().makeDocumentClass();
1273 updateLayout(oldClass);
1274 processUpdateFlags(Update::Force | Update::FitCursor);
1279 cur.message(_("Undo"));
1280 cur.clearSelection();
1281 if (!cur.textUndo())
1282 cur.message(_("No further undo information"));
1284 processUpdateFlags(Update::Force | Update::FitCursor);
1288 cur.message(_("Redo"));
1289 cur.clearSelection();
1290 if (!cur.textRedo())
1291 cur.message(_("No further redo information"));
1293 processUpdateFlags(Update::Force | Update::FitCursor);
1296 case LFUN_FONT_STATE:
1297 cur.message(cur.currentState());
1300 case LFUN_BOOKMARK_SAVE:
1301 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1304 case LFUN_LABEL_GOTO: {
1305 docstring label = cmd.argument();
1306 if (label.empty()) {
1308 getInsetByCode<InsetRef>(cur, REF_CODE);
1310 label = inset->getParam("reference");
1311 // persistent=false: use temp_bookmark
1320 case LFUN_INSET_EDIT: {
1321 FuncRequest fr(cmd);
1322 // if there is an inset at cursor, see whether it
1324 Inset * inset = cur.nextInset();
1326 inset->dispatch(cur, fr);
1327 // if it did not work, try the underlying inset.
1328 if (!inset || !cur.result().dispatched())
1331 // FIXME I'm adding the last break to solve a crash,
1332 // but that is obviously not right.
1333 if (!cur.result().dispatched())
1334 // It did not work too; no action needed.
1339 case LFUN_PARAGRAPH_GOTO: {
1340 int const id = convert<int>(cmd.getArg(0));
1341 int const pos = convert<int>(cmd.getArg(1));
1343 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1344 b = theBufferList().next(b)) {
1346 DocIterator dit = b->getParFromID(id);
1348 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1352 LYXERR(Debug::INFO, "Paragraph " << dit.paragraph().id()
1353 << " found in buffer `"
1354 << b->absFileName() << "'.");
1356 if (b == &buffer_) {
1360 processUpdateFlags(Update::Force | Update::FitCursor);
1362 // Switch to other buffer view and resend cmd
1363 theLyXFunc().dispatch(FuncRequest(
1364 LFUN_BUFFER_SWITCH, b->absFileName()));
1365 theLyXFunc().dispatch(cmd);
1372 case LFUN_NOTE_NEXT:
1373 gotoInset(this, NOTE_CODE, false);
1376 case LFUN_REFERENCE_NEXT: {
1377 vector<InsetCode> tmp;
1378 tmp.push_back(LABEL_CODE);
1379 tmp.push_back(REF_CODE);
1380 gotoInset(this, tmp, true);
1384 case LFUN_CHANGES_TRACK:
1385 buffer_.params().trackChanges = !buffer_.params().trackChanges;
1388 case LFUN_CHANGES_OUTPUT:
1389 buffer_.params().outputChanges = !buffer_.params().outputChanges;
1390 if (buffer_.params().outputChanges) {
1391 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1392 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1393 LaTeXFeatures::isAvailable("xcolor");
1395 if (!dvipost && !xcolorulem) {
1396 Alert::warning(_("Changes not shown in LaTeX output"),
1397 _("Changes will not be highlighted in LaTeX output, "
1398 "because neither dvipost nor xcolor/ulem are installed.\n"
1399 "Please install these packages or redefine "
1400 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1401 } else if (!xcolorulem) {
1402 Alert::warning(_("Changes not shown in LaTeX output"),
1403 _("Changes will not be highlighted in LaTeX output "
1404 "when using pdflatex, because xcolor and ulem are not installed.\n"
1405 "Please install both packages or redefine "
1406 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1411 case LFUN_CHANGE_NEXT:
1412 findNextChange(this);
1413 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1414 processUpdateFlags(Update::Force | Update::FitCursor);
1417 case LFUN_CHANGE_PREVIOUS:
1418 findPreviousChange(this);
1419 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1420 processUpdateFlags(Update::Force | Update::FitCursor);
1423 case LFUN_CHANGES_MERGE:
1424 if (findNextChange(this) || findPreviousChange(this)) {
1425 processUpdateFlags(Update::Force | Update::FitCursor);
1426 showDialog("changes");
1430 case LFUN_ALL_CHANGES_ACCEPT:
1431 // select complete document
1433 cur.selHandle(true);
1434 buffer_.text().cursorBottom(cur);
1435 // accept everything in a single step to support atomic undo
1436 buffer_.text().acceptOrRejectChanges(cur, Text::ACCEPT);
1437 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1438 processUpdateFlags(Update::Force | Update::FitCursor);
1441 case LFUN_ALL_CHANGES_REJECT:
1442 // select complete document
1444 cur.selHandle(true);
1445 buffer_.text().cursorBottom(cur);
1446 // reject everything in a single step to support atomic undo
1447 // Note: reject does not work recursively; the user may have to repeat the operation
1448 buffer_.text().acceptOrRejectChanges(cur, Text::REJECT);
1449 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1450 processUpdateFlags(Update::Force | Update::FitCursor);
1453 case LFUN_WORD_FIND_FORWARD:
1454 case LFUN_WORD_FIND_BACKWARD: {
1455 static docstring last_search;
1456 docstring searched_string;
1458 if (!cmd.argument().empty()) {
1459 last_search = cmd.argument();
1460 searched_string = cmd.argument();
1462 searched_string = last_search;
1465 if (searched_string.empty())
1468 bool const fw = cmd.action == LFUN_WORD_FIND_FORWARD;
1469 docstring const data =
1470 find2string(searched_string, true, false, fw);
1471 find(this, FuncRequest(LFUN_WORD_FIND, data));
1475 case LFUN_WORD_FIND: {
1476 FuncRequest req = cmd;
1477 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1478 req = d->search_request_cache_;
1479 if (req.argument().empty()) {
1480 theLyXFunc().dispatch(FuncRequest(LFUN_DIALOG_SHOW, "findreplace"));
1483 if (find(this, req))
1486 message(_("String not found!"));
1487 d->search_request_cache_ = req;
1491 case LFUN_WORD_REPLACE: {
1492 bool has_deleted = false;
1493 if (cur.selection()) {
1494 DocIterator beg = cur.selectionBegin();
1495 DocIterator end = cur.selectionEnd();
1496 if (beg.pit() == end.pit()) {
1497 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1498 if (cur.paragraph().isDeleted(p))
1503 replace(this, cmd, has_deleted);
1507 case LFUN_WORD_FINDADV: {
1508 FindAndReplaceOptions opt;
1509 istringstream iss(to_utf8(cmd.argument()));
1511 if (findAdv(this, opt))
1519 cur.clearSelection();
1520 cur.message(from_utf8(N_("Mark off")));
1524 cur.clearSelection();
1526 cur.message(from_utf8(N_("Mark on")));
1529 case LFUN_MARK_TOGGLE:
1530 cur.setSelection(false);
1533 cur.message(from_utf8(N_("Mark removed")));
1536 cur.message(from_utf8(N_("Mark set")));
1541 case LFUN_SCREEN_SHOW_CURSOR:
1545 case LFUN_SCREEN_RECENTER:
1549 case LFUN_BIBTEX_DATABASE_ADD: {
1550 Cursor tmpcur = cur;
1551 findInset(tmpcur, BIBTEX_CODE, false);
1552 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1555 if (inset->addDatabase(cmd.argument()))
1556 buffer_.updateBibfilesCache();
1561 case LFUN_BIBTEX_DATABASE_DEL: {
1562 Cursor tmpcur = cur;
1563 findInset(tmpcur, BIBTEX_CODE, false);
1564 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1567 if (inset->delDatabase(cmd.argument()))
1568 buffer_.updateBibfilesCache();
1573 case LFUN_STATISTICS: {
1574 DocIterator from, to;
1575 if (cur.selection()) {
1576 from = cur.selectionBegin();
1577 to = cur.selectionEnd();
1579 from = doc_iterator_begin(&buffer_);
1580 to = doc_iterator_end(&buffer_);
1582 int const words = countWords(from, to);
1583 int const chars = countChars(from, to, false);
1584 int const chars_blanks = countChars(from, to, true);
1586 if (cur.selection())
1587 message = _("Statistics for the selection:");
1589 message = _("Statistics for the document:");
1592 message += bformat(_("%1$d words"), words);
1594 message += _("One word");
1596 if (chars_blanks != 1)
1597 message += bformat(_("%1$d characters (including blanks)"),
1600 message += _("One character (including blanks)");
1603 message += bformat(_("%1$d characters (excluding blanks)"),
1606 message += _("One character (excluding blanks)");
1608 Alert::information(_("Statistics"), message);
1612 case LFUN_BUFFER_TOGGLE_COMPRESSION:
1613 // turn compression on/off
1614 buffer_.params().compressed = !buffer_.params().compressed;
1617 case LFUN_LABEL_COPY_AS_REF: {
1618 // if there is an inset at cursor, try to copy it
1619 Inset * inset = &cur.inset();
1620 if (!inset || !inset->asInsetMath())
1621 inset = cur.nextInset();
1623 FuncRequest tmpcmd = cmd;
1624 inset->dispatch(cur, tmpcmd);
1626 if (!cur.result().dispatched())
1627 // It did not work too; no action needed.
1629 cur.clearSelection();
1630 processUpdateFlags(Update::SinglePar | Update::FitCursor);
1634 case LFUN_NEXT_INSET_MODIFY: {
1635 // create the the real function we want to invoke
1636 FuncRequest tmpcmd = cmd;
1637 tmpcmd.action = LFUN_INSET_MODIFY;
1638 // if there is an inset at cursor, see whether it
1640 Inset * inset = cur.nextInset();
1643 inset->dispatch(cur, tmpcmd);
1645 // if it did not work, try the underlying inset.
1646 if (!inset || !cur.result().dispatched()) {
1648 cur.dispatch(tmpcmd);
1651 if (!cur.result().dispatched())
1652 // It did not work too; no action needed.
1654 cur.clearSelection();
1655 processUpdateFlags(Update::Force | Update::FitCursor);
1659 case LFUN_SCREEN_UP:
1660 case LFUN_SCREEN_DOWN: {
1661 Point p = getPos(cur, cur.boundary());
1662 // This code has been commented out to enable to scroll down a
1663 // document, even if there are large insets in it (see bug #5465).
1664 /*if (p.y_ < 0 || p.y_ > height_) {
1665 // The cursor is off-screen so recenter before proceeding.
1667 p = getPos(cur, cur.boundary());
1669 int const scrolled = scroll(cmd.action == LFUN_SCREEN_UP
1670 ? -height_ : height_);
1671 if (cmd.action == LFUN_SCREEN_UP && scrolled > -height_)
1673 if (cmd.action == LFUN_SCREEN_DOWN && scrolled < height_)
1674 p = Point(width_, height_);
1676 bool const in_texted = cur.inTexted();
1680 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_,
1681 true, cmd.action == LFUN_SCREEN_UP);
1682 //FIXME: what to do with cur.x_target()?
1683 bool update = in_texted && cur.bv().checkDepm(cur, old);
1686 processUpdateFlags(Update::Force | Update::FitCursor);
1694 case LFUN_SCREEN_UP_SELECT: {
1695 cur.selHandle(true);
1696 if (isTopScreen()) {
1697 lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1701 int y = getPos(cur, cur.boundary()).y_;
1702 int const ymin = y - height_ + defaultRowHeight();
1703 while (y > ymin && cur.up())
1704 y = getPos(cur, cur.boundary()).y_;
1707 processUpdateFlags(Update::SinglePar | Update::FitCursor);
1711 case LFUN_SCREEN_DOWN_SELECT: {
1712 cur.selHandle(true);
1713 if (isBottomScreen()) {
1714 lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1718 int y = getPos(cur, cur.boundary()).y_;
1719 int const ymax = y + height_ - defaultRowHeight();
1720 while (y < ymax && cur.down())
1721 y = getPos(cur, cur.boundary()).y_;
1724 processUpdateFlags(Update::SinglePar | Update::FitCursor);
1728 // This could be rewriten using some command like forall <insetname> <command>
1729 // once the insets refactoring is done.
1730 case LFUN_NOTES_MUTATE: {
1731 if (cmd.argument().empty())
1734 if (mutateNotes(cur, cmd.getArg(0), cmd.getArg(1))) {
1735 processUpdateFlags(Update::Force);
1741 // This would be in Buffer class if only Cursor did not
1742 // require a bufferview
1743 case LFUN_INSET_FORALL: {
1744 docstring const name = from_utf8(cmd.getArg(0));
1745 string const commandstr = cmd.getLongArg(1);
1746 FuncRequest const fr = lyxaction.lookupFunc(commandstr);
1748 // an arbitrary number to limit number of iterations
1749 const int max_iter = 1000;
1751 Cursor & cur = d->cursor_;
1753 if (!cur.nextInset())
1755 cur.beginUndoGroup();
1756 while(cur && iterations < max_iter) {
1757 Inset * ins = cur.nextInset();
1760 docstring insname = ins->name();
1761 while (!insname.empty()) {
1762 if (insname == name || name == from_utf8("*")) {
1768 size_t const i = insname.rfind(':');
1769 if (i == string::npos)
1771 insname = insname.substr(0, i);
1777 processUpdateFlags(Update::Force);
1779 if (iterations >= max_iter)
1780 cur.errorMessage(bformat(_("`inset-forall' interrupted because number of actions is larger than %1$s"), max_iter));
1782 cur.message(bformat(_("Applied \"%1$s\" to %2$d insets"), from_utf8(commandstr), iterations));
1787 case LFUN_ALL_INSETS_TOGGLE: {
1789 string const name = split(to_utf8(cmd.argument()), action, ' ');
1790 InsetCode const inset_code = insetCode(name);
1792 FuncRequest fr(LFUN_INSET_TOGGLE, action);
1794 Inset & inset = cur.buffer()->inset();
1795 InsetIterator it = inset_iterator_begin(inset);
1796 InsetIterator const end = inset_iterator_end(inset);
1797 for (; it != end; ++it) {
1798 if (it->asInsetCollapsable()
1799 && (inset_code == NO_CODE
1800 || inset_code == it->lyxCode())) {
1801 Cursor tmpcur = cur;
1802 tmpcur.pushBackward(*it);
1803 it->dispatch(tmpcur, fr);
1806 processUpdateFlags(Update::Force | Update::FitCursor);
1810 case LFUN_BRANCH_ADD_INSERT: {
1811 docstring branch_name = from_utf8(cmd.getArg(0));
1812 if (branch_name.empty())
1813 if (!Alert::askForText(branch_name, _("Branch name")) ||
1814 branch_name.empty())
1817 DispatchResult drtmp;
1818 buffer_.dispatch(FuncRequest(LFUN_BRANCH_ADD, branch_name), drtmp);
1819 if (drtmp.error()) {
1820 Alert::warning(_("Branch already exists"), drtmp.message());
1823 lyx::dispatch(FuncRequest(LFUN_BRANCH_INSERT, branch_name));
1827 case LFUN_KEYMAP_OFF:
1828 getIntl().keyMapOn(false);
1831 case LFUN_KEYMAP_PRIMARY:
1832 getIntl().keyMapPrim();
1835 case LFUN_KEYMAP_SECONDARY:
1836 getIntl().keyMapSec();
1839 case LFUN_KEYMAP_TOGGLE:
1840 getIntl().toggleKeyMap();
1843 case LFUN_DIALOG_SHOW_NEW_INSET: {
1844 string const name = cmd.getArg(0);
1845 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
1846 if (decodeInsetParam(name, data, buffer_))
1847 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
1849 lyxerr << "Inset type '" << name <<
1850 "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" << endl;
1854 case LFUN_CITATION_INSERT: {
1855 if (argument.empty()) {
1856 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
1859 // we can have one optional argument, delimited by '|'
1860 // citation-insert <key>|<text_before>
1861 // this should be enhanced to also support text_after
1862 // and citation style
1863 string arg = argument;
1865 if (contains(argument, "|")) {
1866 arg = token(argument, '|', 0);
1867 opt1 = token(argument, '|', 1);
1869 InsetCommandParams icp(CITE_CODE);
1870 icp["key"] = from_utf8(arg);
1872 icp["before"] = from_utf8(opt1);
1873 string icstr = InsetCommand::params2string("citation", icp);
1874 FuncRequest fr(LFUN_INSET_INSERT, icstr);
1879 case LFUN_INSET_APPLY: {
1880 string const name = cmd.getArg(0);
1881 Inset * inset = editedInset(name);
1883 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1887 // put cursor in front of inset.
1888 if (!setCursorFromInset(inset)) {
1889 LASSERT(false, break);
1892 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1893 inset->dispatch(cur, fr);
1894 processUpdateFlags(Update::SinglePar | Update::FitCursor);
1903 buffer_.undo().endUndoGroup();
1908 docstring const BufferView::requestSelection()
1910 Cursor & cur = d->cursor_;
1912 LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
1913 if (!cur.selection()) {
1914 d->xsel_cache_.set = false;
1918 LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
1919 if (!d->xsel_cache_.set ||
1920 cur.top() != d->xsel_cache_.cursor ||
1921 cur.anchor_.top() != d->xsel_cache_.anchor)
1923 d->xsel_cache_.cursor = cur.top();
1924 d->xsel_cache_.anchor = cur.anchor_.top();
1925 d->xsel_cache_.set = cur.selection();
1926 return cur.selectionAsString(false);
1932 void BufferView::clearSelection()
1934 d->cursor_.clearSelection();
1935 // Clear the selection buffer. Otherwise a subsequent
1936 // middle-mouse-button paste would use the selection buffer,
1937 // not the more current external selection.
1938 cap::clearSelection();
1939 d->xsel_cache_.set = false;
1940 // The buffer did not really change, but this causes the
1941 // redraw we need because we cleared the selection above.
1946 void BufferView::resize(int width, int height)
1948 // Update from work area
1952 // Clear the paragraph height cache.
1953 d->par_height_.clear();
1954 // Redo the metrics.
1959 Inset const * BufferView::getCoveringInset(Text const & text,
1962 TextMetrics & tm = d->text_metrics_[&text];
1963 Inset * inset = tm.checkInsetHit(x, y);
1967 if (!inset->descendable(*this))
1968 // No need to go further down if the inset is not
1972 size_t cell_number = inset->nargs();
1973 // Check all the inner cell.
1974 for (size_t i = 0; i != cell_number; ++i) {
1975 Text const * inner_text = inset->getText(i);
1978 Inset const * inset_deeper =
1979 getCoveringInset(*inner_text, x, y);
1981 return inset_deeper;
1989 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
1991 //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
1993 // This is only called for mouse related events including
1994 // LFUN_FILE_OPEN generated by drag-and-drop.
1995 FuncRequest cmd = cmd0;
1997 Cursor old = cursor();
1999 cur.push(buffer_.inset());
2000 cur.setSelection(d->cursor_.selection());
2002 // Either the inset under the cursor or the
2003 // surrounding Text will handle this event.
2005 // make sure we stay within the screen...
2006 cmd.y = min(max(cmd.y, -1), height_);
2008 if (cmd.action == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
2010 // Get inset under mouse, if there is one.
2011 Inset const * covering_inset =
2012 getCoveringInset(buffer_.text(), cmd.x, cmd.y);
2013 if (covering_inset == d->last_inset_)
2014 // Same inset, no need to do anything...
2017 bool need_redraw = false;
2018 // const_cast because of setMouseHover().
2019 Inset * inset = const_cast<Inset *>(covering_inset);
2021 // Remove the hint on the last hovered inset (if any).
2022 need_redraw |= d->last_inset_->setMouseHover(false);
2024 // Highlighted the newly hovered inset (if any).
2025 need_redraw |= inset->setMouseHover(true);
2026 d->last_inset_ = inset;
2030 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
2031 << cmd.x << ", " << cmd.y << ")");
2033 d->update_strategy_ = DecorationUpdate;
2035 // This event (moving without mouse click) is not passed further.
2036 // This should be changed if it is further utilized.
2041 // Build temporary cursor.
2042 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x, cmd.y);
2044 // Put anchor at the same position.
2047 cur.beginUndoGroup();
2049 // Try to dispatch to an non-editable inset near this position
2050 // via the temp cursor. If the inset wishes to change the real
2051 // cursor it has to do so explicitly by using
2052 // cur.bv().cursor() = cur; (or similar)
2054 inset->dispatch(cur, cmd);
2056 // Now dispatch to the temporary cursor. If the real cursor should
2057 // be modified, the inset's dispatch has to do so explicitly.
2058 if (!inset || !cur.result().dispatched())
2063 // Notify left insets
2066 bool badcursor = notifyCursorLeavesOrEnters(old, cur);
2068 cursor().fixIfBroken();
2071 // Do we have a selection?
2072 theSelection().haveSelection(cursor().selection());
2074 // If the command has been dispatched,
2075 if (cur.result().dispatched() || cur.result().update())
2076 processUpdateFlags(cur.result().update());
2080 void BufferView::lfunScroll(FuncRequest const & cmd)
2082 string const scroll_type = cmd.getArg(0);
2083 int const scroll_step =
2084 (scroll_type == "line") ? d->scrollbarParameters_.single_step
2085 : (scroll_type == "page") ? d->scrollbarParameters_.page_step : 0;
2086 if (scroll_step == 0)
2088 string const scroll_quantity = cmd.getArg(1);
2089 if (scroll_quantity == "up")
2090 scrollUp(scroll_step);
2091 else if (scroll_quantity == "down")
2092 scrollDown(scroll_step);
2094 int const scroll_value = convert<int>(scroll_quantity);
2096 scroll(scroll_step * scroll_value);
2103 int BufferView::minVisiblePart()
2105 return 2 * defaultRowHeight();
2109 int BufferView::scroll(int y)
2112 return scrollDown(y);
2114 return scrollUp(-y);
2119 int BufferView::scrollDown(int offset)
2121 Text * text = &buffer_.text();
2122 TextMetrics & tm = d->text_metrics_[text];
2123 int const ymax = height_ + offset;
2125 pair<pit_type, ParagraphMetrics const *> last = tm.last();
2126 int bottom_pos = last.second->position() + last.second->descent();
2127 if (lyxrc.scroll_below_document)
2128 bottom_pos += height_ - minVisiblePart();
2129 if (last.first + 1 == int(text->paragraphs().size())) {
2130 if (bottom_pos <= height_)
2132 offset = min(offset, bottom_pos - height_);
2135 if (bottom_pos > ymax)
2137 tm.newParMetricsDown();
2139 d->anchor_ypos_ -= offset;
2144 int BufferView::scrollUp(int offset)
2146 Text * text = &buffer_.text();
2147 TextMetrics & tm = d->text_metrics_[text];
2148 int ymin = - offset;
2150 pair<pit_type, ParagraphMetrics const *> first = tm.first();
2151 int top_pos = first.second->position() - first.second->ascent();
2152 if (first.first == 0) {
2155 offset = min(offset, - top_pos);
2160 tm.newParMetricsUp();
2162 d->anchor_ypos_ += offset;
2167 void BufferView::setCursorFromRow(int row)
2172 buffer_.texrow().getIdFromRow(row, tmpid, tmppos);
2176 buffer_.text().setCursor(d->cursor_, 0, 0);
2178 buffer_.text().setCursor(d->cursor_, buffer_.getParFromID(tmpid).pit(), tmppos);
2183 bool BufferView::setCursorFromInset(Inset const * inset)
2185 // are we already there?
2186 if (cursor().nextInset() == inset)
2189 // Inset is not at cursor position. Find it in the document.
2192 while (cur && cur.nextInset() != inset)
2203 void BufferView::gotoLabel(docstring const & label)
2205 std::vector<Buffer const *> bufs = buffer().allRelatives();
2206 std::vector<Buffer const *>::iterator it = bufs.begin();
2207 for (; it != bufs.end(); ++it) {
2208 Buffer const * buf = *it;
2211 Toc & toc = buf->tocBackend().toc("label");
2212 TocIterator toc_it = toc.begin();
2213 TocIterator end = toc.end();
2214 for (; toc_it != end; ++toc_it) {
2215 if (label == toc_it->str()) {
2216 dispatch(toc_it->action());
2224 TextMetrics const & BufferView::textMetrics(Text const * t) const
2226 return const_cast<BufferView *>(this)->textMetrics(t);
2230 TextMetrics & BufferView::textMetrics(Text const * t)
2232 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
2233 if (tmc_it == d->text_metrics_.end()) {
2234 tmc_it = d->text_metrics_.insert(
2235 make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
2237 return tmc_it->second;
2241 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
2244 return textMetrics(t).parMetrics(pit);
2248 int BufferView::workHeight() const
2254 void BufferView::setCursor(DocIterator const & dit)
2257 size_t const n = dit.depth();
2258 for (size_t i = 0; i < n; ++i)
2259 dit[i].inset().edit(d->cursor_, true);
2261 d->cursor_.setCursor(dit);
2262 d->cursor_.setSelection(false);
2266 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
2268 // Would be wrong to delete anything if we have a selection.
2269 if (cur.selection())
2272 bool need_anchor_change = false;
2273 bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
2274 need_anchor_change);
2276 if (need_anchor_change)
2284 buffer_.updateLabels();
2292 bool BufferView::mouseSetCursor(Cursor & cur, bool select)
2294 LASSERT(&cur.bv() == this, /**/);
2297 // this event will clear selection so we save selection for
2298 // persistent selection
2299 cap::saveSelection(cursor());
2301 d->cursor_.macroModeClose();
2303 // Has the cursor just left the inset?
2304 bool leftinset = (&d->cursor_.inset() != &cur.inset());
2306 d->cursor_.fixIfBroken();
2308 // FIXME: shift-mouse selection doesn't work well across insets.
2309 bool do_selection = select && &d->cursor_.anchor().inset() == &cur.inset();
2311 // do the dEPM magic if needed
2312 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
2313 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
2314 // the leftinset bool would not be necessary (badcursor instead).
2315 bool update = leftinset;
2316 if (!do_selection && d->cursor_.inTexted())
2317 update |= checkDepm(cur, d->cursor_);
2320 d->cursor_.resetAnchor();
2321 d->cursor_.setCursor(cur);
2322 d->cursor_.boundary(cur.boundary());
2324 d->cursor_.setSelection();
2326 d->cursor_.clearSelection();
2328 d->cursor_.finishUndo();
2329 d->cursor_.setCurrentFont();
2334 void BufferView::putSelectionAt(DocIterator const & cur,
2335 int length, bool backwards)
2337 d->cursor_.clearSelection();
2343 d->cursor_.pos() += length;
2344 d->cursor_.setSelection(d->cursor_, -length);
2346 d->cursor_.setSelection(d->cursor_, length);
2348 // Ensure a redraw happens in any case because the new selection could
2349 // possibly be on the same screen as the previous selection.
2350 processUpdateFlags(Update::Force | Update::FitCursor);
2354 Cursor & BufferView::cursor()
2360 Cursor const & BufferView::cursor() const
2366 pit_type BufferView::anchor_ref() const
2368 return d->anchor_pit_;
2372 bool BufferView::singleParUpdate()
2374 Text & buftext = buffer_.text();
2375 pit_type const bottom_pit = d->cursor_.bottom().pit();
2376 TextMetrics & tm = textMetrics(&buftext);
2377 int old_height = tm.parMetrics(bottom_pit).height();
2379 // make sure inline completion pointer is ok
2380 if (d->inlineCompletionPos_.fixIfBroken())
2381 d->inlineCompletionPos_ = DocIterator();
2383 // In Single Paragraph mode, rebreak only
2384 // the (main text, not inset!) paragraph containing the cursor.
2385 // (if this paragraph contains insets etc., rebreaking will
2386 // recursively descend)
2387 tm.redoParagraph(bottom_pit);
2388 ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
2389 if (pm.height() != old_height)
2390 // Paragraph height has changed so we cannot proceed to
2391 // the singlePar optimisation.
2394 d->update_strategy_ = SingleParUpdate;
2396 LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
2397 << " y2: " << pm.position() + pm.descent()
2398 << " pit: " << bottom_pit
2399 << " singlepar: 1");
2404 void BufferView::updateMetrics()
2406 if (height_ == 0 || width_ == 0)
2409 Text & buftext = buffer_.text();
2410 pit_type const npit = int(buftext.paragraphs().size());
2412 // Clear out the position cache in case of full screen redraw,
2413 d->coord_cache_.clear();
2415 // Clear out paragraph metrics to avoid having invalid metrics
2416 // in the cache from paragraphs not relayouted below
2417 // The complete text metrics will be redone.
2418 d->text_metrics_.clear();
2420 TextMetrics & tm = textMetrics(&buftext);
2422 // make sure inline completion pointer is ok
2423 if (d->inlineCompletionPos_.fixIfBroken())
2424 d->inlineCompletionPos_ = DocIterator();
2426 if (d->anchor_pit_ >= npit)
2427 // The anchor pit must have been deleted...
2428 d->anchor_pit_ = npit - 1;
2430 // Rebreak anchor paragraph.
2431 tm.redoParagraph(d->anchor_pit_);
2432 ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
2435 if (d->anchor_pit_ == 0) {
2436 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
2438 // Complete buffer visible? Then it's easy.
2439 if (scrollRange == 0)
2440 d->anchor_ypos_ = anchor_pm.ascent();
2442 // FIXME: Some clever handling needed to show
2443 // the _first_ paragraph up to the top if the cursor is
2444 // in the first line.
2446 anchor_pm.setPosition(d->anchor_ypos_);
2448 LYXERR(Debug::PAINTING, "metrics: "
2449 << " anchor pit = " << d->anchor_pit_
2450 << " anchor ypos = " << d->anchor_ypos_);
2452 // Redo paragraphs above anchor if necessary.
2453 int y1 = d->anchor_ypos_ - anchor_pm.ascent();
2454 // We are now just above the anchor paragraph.
2455 pit_type pit1 = d->anchor_pit_ - 1;
2456 for (; pit1 >= 0 && y1 >= 0; --pit1) {
2457 tm.redoParagraph(pit1);
2458 ParagraphMetrics & pm = tm.par_metrics_[pit1];
2460 // Save the paragraph position in the cache.
2465 // Redo paragraphs below the anchor if necessary.
2466 int y2 = d->anchor_ypos_ + anchor_pm.descent();
2467 // We are now just below the anchor paragraph.
2468 pit_type pit2 = d->anchor_pit_ + 1;
2469 for (; pit2 < npit && y2 <= height_; ++pit2) {
2470 tm.redoParagraph(pit2);
2471 ParagraphMetrics & pm = tm.par_metrics_[pit2];
2473 // Save the paragraph position in the cache.
2478 LYXERR(Debug::PAINTING, "Metrics: "
2479 << " anchor pit = " << d->anchor_pit_
2480 << " anchor ypos = " << d->anchor_ypos_
2483 << " pit1 = " << pit1
2484 << " pit2 = " << pit2);
2486 d->update_strategy_ = FullScreenUpdate;
2488 if (lyxerr.debugging(Debug::WORKAREA)) {
2489 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
2490 d->coord_cache_.dump();
2495 void BufferView::insertLyXFile(FileName const & fname)
2497 LASSERT(d->cursor_.inTexted(), /**/);
2499 // Get absolute path of file and add ".lyx"
2500 // to the filename if necessary
2501 FileName filename = fileSearch(string(), fname.absFilename(), "lyx");
2503 docstring const disp_fn = makeDisplayPath(filename.absFilename());
2504 // emit message signal.
2505 message(bformat(_("Inserting document %1$s..."), disp_fn));
2508 Buffer buf("", false);
2509 if (buf.loadLyXFile(filename)) {
2510 ErrorList & el = buffer_.errorList("Parse");
2511 // Copy the inserted document error list into the current buffer one.
2512 el = buf.errorList("Parse");
2513 buffer_.undo().recordUndo(d->cursor_);
2514 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
2515 buf.params().documentClassPtr(), el);
2516 res = _("Document %1$s inserted.");
2518 res = _("Could not insert document %1$s");
2523 // emit message signal.
2524 message(bformat(res, disp_fn));
2525 buffer_.errors("Parse");
2529 Point BufferView::coordOffset(DocIterator const & dit, bool boundary) const
2535 // Addup contribution of nested insets, from inside to outside,
2536 // keeping the outer paragraph for a special handling below
2537 for (size_t i = dit.depth() - 1; i >= 1; --i) {
2538 CursorSlice const & sl = dit[i];
2542 // get relative position inside sl.inset()
2543 sl.inset().cursorPos(*this, sl, boundary && (i + 1 == dit.depth()), xx, yy);
2545 // Make relative position inside of the edited inset relative to sl.inset()
2549 // In case of an RTL inset, the edited inset will be positioned to the left
2552 bool boundary_i = boundary && i + 1 == dit.depth();
2553 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2558 // remember width for the case that sl.inset() is positioned in an RTL inset
2559 if (i && dit[i - 1].text()) {
2560 // If this Inset is inside a Text Inset, retrieve the Dimension
2561 // from the containing text instead of using Inset::dimension() which
2562 // might not be implemented.
2563 // FIXME (Abdel 23/09/2007): this is a bit messy because of the
2564 // elimination of Inset::dim_ cache. This coordOffset() method needs
2565 // to be rewritten in light of the new design.
2566 Dimension const & dim = parMetrics(dit[i - 1].text(),
2567 dit[i - 1].pit()).insetDimension(&sl.inset());
2570 Dimension const dim = sl.inset().dimension(*this);
2574 //lyxerr << "Cursor::getPos, i: "
2575 // << i << " x: " << xx << " y: " << y << endl;
2578 // Add contribution of initial rows of outermost paragraph
2579 CursorSlice const & sl = dit[0];
2580 TextMetrics const & tm = textMetrics(sl.text());
2581 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2582 LASSERT(!pm.rows().empty(), /**/);
2583 y -= pm.rows()[0].ascent();
2585 // FIXME: document this mess
2587 if (sl.pos() > 0 && dit.depth() == 1) {
2589 if (pos && boundary)
2591 // lyxerr << "coordOffset: boundary:" << boundary << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
2592 rend = pm.pos2row(pos);
2594 rend = pm.pos2row(sl.pos());
2596 size_t rend = pm.pos2row(sl.pos());
2598 for (size_t rit = 0; rit != rend; ++rit)
2599 y += pm.rows()[rit].height();
2600 y += pm.rows()[rend].ascent();
2602 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
2604 // Make relative position from the nested inset now bufferview absolute.
2605 int xx = bottom_tm.cursorX(dit.bottom(), boundary && dit.depth() == 1);
2608 // In the RTL case place the nested inset at the left of the cursor in
2609 // the outer paragraph
2610 bool boundary_1 = boundary && 1 == dit.depth();
2611 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
2619 Point BufferView::getPos(DocIterator const & dit, bool boundary) const
2621 if (!paragraphVisible(dit))
2622 return Point(-1, -1);
2624 CursorSlice const & bot = dit.bottom();
2625 TextMetrics const & tm = textMetrics(bot.text());
2627 Point p = coordOffset(dit, boundary); // offset from outer paragraph
2628 p.y_ += tm.parMetrics(bot.pit()).position();
2633 bool BufferView::paragraphVisible(DocIterator const & dit) const
2635 CursorSlice const & bot = dit.bottom();
2636 TextMetrics const & tm = textMetrics(bot.text());
2638 return tm.contains(bot.pit());
2642 void BufferView::cursorPosAndHeight(Point & p, int & h) const
2644 Cursor const & cur = cursor();
2645 Font const font = cur.getFont();
2646 frontend::FontMetrics const & fm = theFontMetrics(font);
2647 int const asc = fm.maxAscent();
2648 int const des = fm.maxDescent();
2650 p = getPos(cur, cur.boundary());
2655 bool BufferView::cursorInView(Point const & p, int h) const
2657 Cursor const & cur = cursor();
2658 // does the cursor touch the screen ?
2659 if (p.y_ + h < 0 || p.y_ >= workHeight() || !paragraphVisible(cur))
2665 void BufferView::draw(frontend::Painter & pain)
2667 if (height_ == 0 || width_ == 0)
2669 LYXERR(Debug::PAINTING, "\t\t*** START DRAWING ***");
2671 Text & text = buffer_.text();
2672 TextMetrics const & tm = d->text_metrics_[&text];
2673 int const y = tm.first().second->position();
2674 PainterInfo pi(this, pain);
2676 switch (d->update_strategy_) {
2678 case NoScreenUpdate:
2679 // If no screen painting is actually needed, only some the different
2680 // coordinates of insets and paragraphs needs to be updated.
2681 pi.full_repaint = true;
2682 pi.pain.setDrawingEnabled(false);
2686 case SingleParUpdate:
2687 pi.full_repaint = false;
2688 // In general, only the current row of the outermost paragraph
2689 // will be redrawn. Particular cases where selection spans
2690 // multiple paragraph are correctly detected in TextMetrics.
2694 case DecorationUpdate:
2695 // FIXME: We should also distinguish DecorationUpdate to avoid text
2696 // drawing if possible. This is not possible to do easily right now
2697 // because of the single backing pixmap.
2699 case FullScreenUpdate:
2700 // The whole screen, including insets, will be refreshed.
2701 pi.full_repaint = true;
2703 // Clear background.
2704 pain.fillRectangle(0, 0, width_, height_,
2705 pi.backgroundColor(&buffer_.inset()));
2710 // and possibly grey out below
2711 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2712 int const y2 = lastpm.second->position() + lastpm.second->descent();
2715 Color color = buffer().isInternal()
2716 ? Color_background : Color_bottomarea;
2717 pain.fillRectangle(0, y2, width_, height_ - y2, color);
2721 LYXERR(Debug::PAINTING, "\n\t\t*** END DRAWING ***");
2723 // The scrollbar needs an update.
2726 // Normalize anchor for next time
2727 pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
2728 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2729 for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
2730 ParagraphMetrics const & pm = tm.parMetrics(pit);
2731 if (pm.position() + pm.descent() > 0) {
2732 d->anchor_pit_ = pit;
2733 d->anchor_ypos_ = pm.position();
2737 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
2738 << " anchor ypos = " << d->anchor_ypos_);
2742 void BufferView::message(docstring const & msg)
2745 d->gui_->message(msg);
2749 void BufferView::showDialog(string const & name)
2752 d->gui_->showDialog(name, string());
2756 void BufferView::showDialog(string const & name,
2757 string const & data, Inset * inset)
2760 d->gui_->showDialog(name, data, inset);
2764 void BufferView::updateDialog(string const & name, string const & data)
2767 d->gui_->updateDialog(name, data);
2771 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
2777 // FIXME: Move this out of BufferView again
2778 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
2780 if (!fname.isReadableFile()) {
2781 docstring const error = from_ascii(strerror(errno));
2782 docstring const file = makeDisplayPath(fname.absFilename(), 50);
2783 docstring const text =
2784 bformat(_("Could not read the specified document\n"
2785 "%1$s\ndue to the error: %2$s"), file, error);
2786 Alert::error(_("Could not read file"), text);
2790 if (!fname.isReadableFile()) {
2791 docstring const file = makeDisplayPath(fname.absFilename(), 50);
2792 docstring const text =
2793 bformat(_("%1$s\n is not readable."), file);
2794 Alert::error(_("Could not open file"), text);
2798 // FIXME UNICODE: We don't know the encoding of the file
2799 docstring file_content = fname.fileContents("UTF-8");
2800 if (file_content.empty()) {
2801 Alert::error(_("Reading not UTF-8 encoded file"),
2802 _("The file is not UTF-8 encoded.\n"
2803 "It will be read as local 8Bit-encoded.\n"
2804 "If this does not give the correct result\n"
2805 "then please change the encoding of the file\n"
2806 "to UTF-8 with a program other than LyX.\n"));
2807 file_content = fname.fileContents("local8bit");
2810 return normalize_c(file_content);
2814 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
2816 docstring const tmpstr = contentsOfPlaintextFile(f);
2821 Cursor & cur = cursor();
2822 cap::replaceSelection(cur);
2823 buffer_.undo().recordUndo(cur);
2825 cur.innerText()->insertStringAsParagraphs(cur, tmpstr, cur.current_font);
2827 cur.innerText()->insertStringAsLines(cur, tmpstr, cur.current_font);
2834 docstring const & BufferView::inlineCompletion() const
2836 return d->inlineCompletion_;
2840 size_t const & BufferView::inlineCompletionUniqueChars() const
2842 return d->inlineCompletionUniqueChars_;
2846 DocIterator const & BufferView::inlineCompletionPos() const
2848 return d->inlineCompletionPos_;
2852 bool samePar(DocIterator const & a, DocIterator const & b)
2854 if (a.empty() && b.empty())
2856 if (a.empty() || b.empty())
2858 if (a.depth() != b.depth())
2860 return &a.innerParagraph() == &b.innerParagraph();
2864 void BufferView::setInlineCompletion(Cursor & cur, DocIterator const & pos,
2865 docstring const & completion, size_t uniqueChars)
2867 uniqueChars = min(completion.size(), uniqueChars);
2868 bool changed = d->inlineCompletion_ != completion
2869 || d->inlineCompletionUniqueChars_ != uniqueChars;
2870 bool singlePar = true;
2871 d->inlineCompletion_ = completion;
2872 d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
2874 //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
2877 DocIterator const & old = d->inlineCompletionPos_;
2879 //lyxerr << "inlineCompletionPos changed" << std::endl;
2880 // old or pos are in another paragraph?
2881 if ((!samePar(cur, pos) && !pos.empty())
2882 || (!samePar(cur, old) && !old.empty())) {
2884 //lyxerr << "different paragraph" << std::endl;
2886 d->inlineCompletionPos_ = pos;
2891 if (singlePar && !(cur.disp_.update() & Update::Force))
2892 cur.updateFlags(cur.disp_.update() | Update::SinglePar);
2894 cur.updateFlags(cur.disp_.update() | Update::Force);