3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Alfredo Braunstein
7 * \author Lars Gullik Bjønnes
10 * \author Jürgen Vigna
12 * Full author contact details are available in file CREDITS.
17 #include "BufferView.h"
19 #include "BranchList.h"
21 #include "buffer_funcs.h"
22 #include "BufferList.h"
23 #include "BufferParams.h"
24 #include "CoordCache.h"
26 #include "CutAndPaste.h"
27 #include "DispatchResult.h"
28 #include "ErrorList.h"
30 #include "FloatList.h"
31 #include "FuncRequest.h"
32 #include "FuncStatus.h"
34 #include "InsetIterator.h"
36 #include "LaTeXFeatures.h"
37 #include "LayoutFile.h"
40 #include "LyXAction.h"
45 #include "MetricsInfo.h"
46 #include "Paragraph.h"
47 #include "ParagraphParameters.h"
48 #include "ParIterator.h"
51 #include "TextClass.h"
52 #include "TextMetrics.h"
54 #include "TocBackend.h"
56 #include "WordLangTuple.h"
58 #include "insets/InsetBibtex.h"
59 #include "insets/InsetCommand.h" // ChangeRefs
60 #include "insets/InsetExternal.h"
61 #include "insets/InsetGraphics.h"
62 #include "insets/InsetRef.h"
63 #include "insets/InsetText.h"
64 #include "insets/InsetNote.h"
66 #include "frontends/alert.h"
67 #include "frontends/Application.h"
68 #include "frontends/Delegates.h"
69 #include "frontends/FontMetrics.h"
70 #include "frontends/Painter.h"
71 #include "frontends/Selection.h"
73 #include "graphics/Previews.h"
75 #include "support/convert.h"
76 #include "support/debug.h"
77 #include "support/ExceptionMessage.h"
78 #include "support/filetools.h"
79 #include "support/gettext.h"
80 #include "support/lstrings.h"
81 #include "support/Package.h"
82 #include "support/types.h"
92 using namespace lyx::support;
96 namespace Alert = frontend::Alert;
100 /// Return an inset of this class if it exists at the current cursor position
102 T * getInsetByCode(Cursor const & cur, InsetCode code)
104 DocIterator it = cur;
105 Inset * inset = it.nextInset();
106 if (inset && inset->lyxCode() == code)
107 return static_cast<T*>(inset);
112 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
115 bool findNextInset(DocIterator & dit, vector<InsetCode> const & codes,
116 docstring const & contents)
118 DocIterator tmpdit = dit;
121 Inset const * inset = tmpdit.nextInset();
123 && std::find(codes.begin(), codes.end(), inset->lyxCode()) != codes.end()
124 && (contents.empty() ||
125 static_cast<InsetCommand const *>(inset)->getFirstNonOptParam() == contents)) {
129 tmpdit.forwardInset();
136 /// Looks for next inset with one of the given codes.
137 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
141 DocIterator tmpdit = dit;
142 tmpdit.forwardInset();
147 Inset const * inset = tmpdit.nextInset();
149 && std::find(codes.begin(), codes.end(), inset->lyxCode()) != codes.end()) {
150 contents = static_cast<InsetCommand const *>(inset)->getFirstNonOptParam();
154 if (!findNextInset(tmpdit, codes, contents)) {
155 if (dit.depth() != 1 || dit.pit() != 0 || dit.pos() != 0) {
156 Inset * inset = &tmpdit.bottom().inset();
157 tmpdit = doc_iterator_begin(&inset->buffer(), inset);
158 if (!findNextInset(tmpdit, codes, contents))
170 /// Looks for next inset with the given code
171 void findInset(DocIterator & dit, InsetCode code, bool same_content)
173 findInset(dit, vector<InsetCode>(1, code), same_content);
177 /// Moves cursor to the next inset with one of the given codes.
178 void gotoInset(BufferView * bv, vector<InsetCode> const & codes,
181 Cursor tmpcur = bv->cursor();
182 if (!findInset(tmpcur, codes, same_content)) {
183 bv->cursor().message(_("No more insets"));
187 tmpcur.clearSelection();
188 bv->setCursor(tmpcur);
193 /// Moves cursor to the next inset with given code.
194 void gotoInset(BufferView * bv, InsetCode code, bool same_content)
196 gotoInset(bv, vector<InsetCode>(1, code), same_content);
200 /// A map from a Text to the associated text metrics
201 typedef map<Text const *, TextMetrics> TextMetricsCache;
203 enum ScreenUpdateStrategy {
213 /////////////////////////////////////////////////////////////////////
217 /////////////////////////////////////////////////////////////////////
219 struct BufferView::Private
221 Private(BufferView & bv): wh_(0), cursor_(bv),
222 anchor_pit_(0), anchor_ypos_(0),
223 inlineCompletionUniqueChars_(0),
224 last_inset_(0), bookmark_edit_position_(0), gui_(0)
228 ScrollbarParameters scrollbarParameters_;
230 ScreenUpdateStrategy update_strategy_;
232 CoordCache coord_cache_;
234 /// Estimated average par height for scrollbar.
236 /// this is used to handle XSelection events in the right manner.
245 pit_type anchor_pit_;
249 vector<int> par_height_;
252 DocIterator inlineCompletionPos_;
254 docstring inlineCompletion_;
256 size_t inlineCompletionUniqueChars_;
258 /// keyboard mapping object.
261 /// last visited inset.
262 /** kept to send setMouseHover(false).
263 * Not owned, so don't delete.
267 // cache for id of the paragraph which was edited the last time
268 int bookmark_edit_position_;
270 mutable TextMetricsCache text_metrics_;
273 /** Not owned, so don't delete.
275 frontend::GuiBufferViewDelegate * gui_;
277 /// Cache for Find Next
278 FuncRequest search_request_cache_;
281 map<string, Inset *> edited_insets_;
285 BufferView::BufferView(Buffer & buf)
286 : width_(0), height_(0), full_screen_(false), buffer_(buf),
287 d(new Private(*this))
289 d->xsel_cache_.set = false;
290 d->intl_.initKeyMapper(lyxrc.use_kbmap);
292 d->cursor_.setBuffer(&buf);
293 d->cursor_.push(buffer_.inset());
294 d->cursor_.resetAnchor();
295 d->cursor_.setCurrentFont();
297 if (graphics::Previews::status() != LyXRC::PREVIEW_OFF)
298 thePreviews().generateBufferPreviews(buffer_);
302 BufferView::~BufferView()
304 // current buffer is going to be switched-off, save cursor pos
305 // Ideally, the whole cursor stack should be saved, but session
306 // currently can only handle bottom (whole document) level pit and pos.
307 // That is to say, if a cursor is in a nested inset, it will be
308 // restore to the left of the top level inset.
309 LastFilePosSection::FilePos fp;
310 fp.pit = d->cursor_.bottom().pit();
311 fp.pos = d->cursor_.bottom().pos();
312 theSession().lastFilePos().save(buffer_.fileName(), fp);
318 int BufferView::rightMargin() const
320 // The additional test for the case the outliner is opened.
322 !lyxrc.full_screen_limit ||
323 width_ < lyxrc.full_screen_width + 20)
326 return (width_ - lyxrc.full_screen_width) / 2;
330 int BufferView::leftMargin() const
332 return rightMargin();
336 bool BufferView::isTopScreen() const
338 return d->scrollbarParameters_.position == d->scrollbarParameters_.min;
342 bool BufferView::isBottomScreen() const
344 return d->scrollbarParameters_.position == d->scrollbarParameters_.max;
348 Intl & BufferView::getIntl()
354 Intl const & BufferView::getIntl() const
360 CoordCache & BufferView::coordCache()
362 return d->coord_cache_;
366 CoordCache const & BufferView::coordCache() const
368 return d->coord_cache_;
372 Buffer & BufferView::buffer()
378 Buffer const & BufferView::buffer() const
384 bool BufferView::fitCursor()
386 if (cursorStatus(d->cursor_) == CUR_INSIDE) {
387 frontend::FontMetrics const & fm =
388 theFontMetrics(d->cursor_.getFont().fontInfo());
389 int const asc = fm.maxAscent();
390 int const des = fm.maxDescent();
391 Point const p = getPos(d->cursor_, d->cursor_.boundary());
392 if (p.y_ - asc >= 0 && p.y_ + des < height_)
399 void BufferView::processUpdateFlags(Update::flags flags)
401 // last_inset_ points to the last visited inset. This pointer may become
402 // invalid because of keyboard editing. Since all such operations
403 // causes screen update(), I reset last_inset_ to avoid such a problem.
405 // This is close to a hot-path.
406 LYXERR(Debug::DEBUG, "BufferView::processUpdateFlags()"
407 << "[fitcursor = " << (flags & Update::FitCursor)
408 << ", forceupdate = " << (flags & Update::Force)
409 << ", singlepar = " << (flags & Update::SinglePar)
410 << "] buffer: " << &buffer_);
412 buffer_.updateMacros();
414 // Now do the first drawing step if needed. This consists on updating
415 // the CoordCache in updateMetrics().
416 // The second drawing step is done in WorkArea::redraw() if needed.
418 // Case when no explicit update is requested.
420 // no need to redraw anything.
421 d->update_strategy_ = NoScreenUpdate;
425 if (flags == Update::Decoration) {
426 d->update_strategy_ = DecorationUpdate;
427 buffer_.changed(false);
431 if (flags == Update::FitCursor
432 || flags == (Update::Decoration | Update::FitCursor)) {
433 // tell the frontend to update the screen if needed.
438 if (flags & Update::Decoration) {
439 d->update_strategy_ = DecorationUpdate;
440 buffer_.changed(false);
443 // no screen update is needed.
444 d->update_strategy_ = NoScreenUpdate;
448 bool const full_metrics = flags & Update::Force || !singleParUpdate();
451 // We have to update the full screen metrics.
454 if (!(flags & Update::FitCursor)) {
455 // Nothing to do anymore. Trigger a redraw and return
456 buffer_.changed(false);
460 // updateMetrics() does not update paragraph position
461 // This is done at draw() time. So we need a redraw!
462 buffer_.changed(false);
465 // The cursor is off screen so ensure it is visible.
472 void BufferView::updateScrollbar()
474 if (height_ == 0 && width_ == 0)
477 // We prefer fixed size line scrolling.
478 d->scrollbarParameters_.single_step = defaultRowHeight();
479 // We prefer full screen page scrolling.
480 d->scrollbarParameters_.page_step = height_;
482 Text & t = buffer_.text();
483 TextMetrics & tm = d->text_metrics_[&t];
485 LYXERR(Debug::GUI, " Updating scrollbar: height: "
486 << t.paragraphs().size()
487 << " curr par: " << d->cursor_.bottom().pit()
488 << " default height " << defaultRowHeight());
490 size_t const parsize = t.paragraphs().size();
491 if (d->par_height_.size() != parsize) {
492 d->par_height_.clear();
493 // FIXME: We assume a default paragraph height of 2 rows. This
494 // should probably be pondered with the screen width.
495 d->par_height_.resize(parsize, defaultRowHeight() * 2);
498 // Look at paragraph heights on-screen
499 pair<pit_type, ParagraphMetrics const *> first = tm.first();
500 pair<pit_type, ParagraphMetrics const *> last = tm.last();
501 for (pit_type pit = first.first; pit <= last.first; ++pit) {
502 d->par_height_[pit] = tm.parMetrics(pit).height();
503 LYXERR(Debug::SCROLLING, "storing height for pit " << pit << " : "
504 << d->par_height_[pit]);
507 int top_pos = first.second->position() - first.second->ascent();
508 int bottom_pos = last.second->position() + last.second->descent();
509 bool first_visible = first.first == 0 && top_pos >= 0;
510 bool last_visible = last.first + 1 == int(parsize) && bottom_pos <= height_;
511 if (first_visible && last_visible) {
512 d->scrollbarParameters_.min = 0;
513 d->scrollbarParameters_.max = 0;
517 d->scrollbarParameters_.min = top_pos;
518 for (size_t i = 0; i != size_t(first.first); ++i)
519 d->scrollbarParameters_.min -= d->par_height_[i];
520 d->scrollbarParameters_.max = bottom_pos;
521 for (size_t i = last.first + 1; i != parsize; ++i)
522 d->scrollbarParameters_.max += d->par_height_[i];
524 d->scrollbarParameters_.position = 0;
525 // The reference is the top position so we remove one page.
526 if (lyxrc.scroll_below_document)
527 d->scrollbarParameters_.max -= minVisiblePart();
529 d->scrollbarParameters_.max -= d->scrollbarParameters_.page_step;
533 ScrollbarParameters const & BufferView::scrollbarParameters() const
535 return d->scrollbarParameters_;
539 docstring BufferView::toolTip(int x, int y) const
541 // Get inset under mouse, if there is one.
542 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
544 // No inset, no tooltip...
546 return covering_inset->toolTip(*this, x, y);
550 docstring BufferView::contextMenu(int x, int y) const
552 //If there is a selection, return the containing inset menu
553 if (d->cursor_.selection())
554 return d->cursor_.inset().contextMenu(*this, x, y);
556 // Get inset under mouse, if there is one.
557 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
559 return covering_inset->contextMenu(*this, x, y);
561 return buffer_.inset().contextMenu(*this, x, y);
565 void BufferView::scrollDocView(int value)
567 int const offset = value - d->scrollbarParameters_.position;
569 // No scrolling at all? No need to redraw anything
573 // If the offset is less than 2 screen height, prefer to scroll instead.
574 if (abs(offset) <= 2 * height_) {
575 d->anchor_ypos_ -= offset;
576 buffer_.changed(true);
580 // cut off at the top
581 if (value <= d->scrollbarParameters_.min) {
582 DocIterator dit = doc_iterator_begin(&buffer_);
584 LYXERR(Debug::SCROLLING, "scroll to top");
588 // cut off at the bottom
589 if (value >= d->scrollbarParameters_.max) {
590 DocIterator dit = doc_iterator_end(&buffer_);
593 LYXERR(Debug::SCROLLING, "scroll to bottom");
597 // find paragraph at target position
598 int par_pos = d->scrollbarParameters_.min;
600 for (; i != int(d->par_height_.size()); ++i) {
601 par_pos += d->par_height_[i];
602 if (par_pos >= value)
606 if (par_pos < value) {
607 // It seems we didn't find the correct pit so stay on the safe side and
609 LYXERR0("scrolling position not found!");
610 scrollDocView(d->scrollbarParameters_.max);
614 DocIterator dit = doc_iterator_begin(&buffer_);
616 LYXERR(Debug::SCROLLING, "value = " << value << " -> scroll to pit " << i);
621 // FIXME: this method is not working well.
622 void BufferView::setCursorFromScrollbar()
624 TextMetrics & tm = d->text_metrics_[&buffer_.text()];
626 int const height = 2 * defaultRowHeight();
627 int const first = height;
628 int const last = height_ - height;
630 Cursor const & oldcur = d->cursor_;
632 switch (cursorStatus(oldcur)) {
640 int const y = getPos(oldcur, oldcur.boundary()).y_;
641 newy = min(last, max(y, first));
645 // We reset the cursor because cursorStatus() does not
646 // work when the cursor is within mathed.
649 tm.setCursorFromCoordinates(cur, 0, newy);
651 // update the bufferview cursor and notify insets
652 // FIXME: Care about the d->cursor_ flags to redraw if needed
653 Cursor old = d->cursor_;
655 bool badcursor = notifyCursorLeavesOrEnters(old, d->cursor_);
657 d->cursor_.fixIfBroken();
661 Change const BufferView::getCurrentChange() const
663 if (!d->cursor_.selection())
664 return Change(Change::UNCHANGED);
666 DocIterator dit = d->cursor_.selectionBegin();
667 return dit.paragraph().lookupChange(dit.pos());
671 // this could be used elsewhere as well?
672 // FIXME: This does not work within mathed!
673 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
675 Point const p = getPos(dit, dit.boundary());
678 if (p.y_ > workHeight())
684 void BufferView::bookmarkEditPosition()
686 // Don't eat cpu time for each keystroke
687 if (d->cursor_.paragraph().id() == d->bookmark_edit_position_)
690 d->bookmark_edit_position_ = d->cursor_.paragraph().id();
694 void BufferView::saveBookmark(unsigned int idx)
696 // tentatively save bookmark, id and pos will be used to
697 // acturately locate a bookmark in a 'live' lyx session.
698 // pit and pos will be updated with bottom level pit/pos
700 theSession().bookmarks().save(
702 d->cursor_.bottom().pit(),
703 d->cursor_.bottom().pos(),
704 d->cursor_.paragraph().id(),
709 // emit message signal.
710 message(_("Save bookmark"));
714 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
715 int top_id, pos_type top_pos)
717 bool success = false;
720 d->cursor_.clearSelection();
722 // if a valid par_id is given, try it first
723 // This is the case for a 'live' bookmark when unique paragraph ID
724 // is used to track bookmarks.
726 dit = buffer_.getParFromID(top_id);
728 dit.pos() = min(dit.paragraph().size(), top_pos);
729 // Some slices of the iterator may not be
730 // reachable (e.g. closed collapsable inset)
731 // so the dociterator may need to be
732 // shortened. Otherwise, setCursor may crash
733 // lyx when the cursor can not be set to these
735 size_t const n = dit.depth();
736 for (size_t i = 0; i < n; ++i)
737 if (!dit[i].inset().editable()) {
745 // if top_id == 0, or searching through top_id failed
746 // This is the case for a 'restored' bookmark when only bottom
747 // (document level) pit was saved. Because of this, bookmark
748 // restoration is inaccurate. If a bookmark was within an inset,
749 // it will be restored to the left of the outmost inset that contains
751 if (bottom_pit < int(buffer_.paragraphs().size())) {
752 dit = doc_iterator_begin(&buffer_);
754 dit.pit() = bottom_pit;
755 dit.pos() = min(bottom_pos, dit.paragraph().size());
760 // Note: only bottom (document) level pit is set.
762 // set the current font.
763 d->cursor_.setCurrentFont();
764 // To center the screen on this new position we need the
765 // paragraph position which is computed at draw() time.
766 // So we need a redraw!
767 buffer_.changed(false);
776 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
778 if (lyxrc.rtl_support) {
779 if (d->cursor_.real_current_font.isRightToLeft()) {
780 if (d->intl_.keymap == Intl::PRIMARY)
781 d->intl_.keyMapSec();
783 if (d->intl_.keymap == Intl::SECONDARY)
784 d->intl_.keyMapPrim();
788 d->intl_.getTransManager().translateAndInsert(c, t, cur);
792 int BufferView::workWidth() const
798 void BufferView::recenter()
800 showCursor(d->cursor_, true);
804 void BufferView::showCursor()
806 showCursor(d->cursor_, false);
810 void BufferView::showCursor(DocIterator const & dit, bool recenter)
812 if (scrollToCursor(dit, recenter))
813 buffer_.changed(false);
817 void BufferView::scrollToCursor()
819 scrollToCursor(d->cursor_, false);
823 bool BufferView::scrollToCursor(DocIterator const & dit, bool recenter)
825 // We are not properly started yet, delay until resizing is
830 LYXERR(Debug::SCROLLING, "recentering!");
832 CursorSlice const & bot = dit.bottom();
833 TextMetrics & tm = d->text_metrics_[bot.text()];
835 pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
836 int bot_pit = bot.pit();
837 if (bot_pit > max_pit) {
838 // FIXME: Why does this happen?
839 LYXERR0("bottom pit is greater that max pit: "
840 << bot_pit << " > " << max_pit);
844 if (bot_pit == tm.first().first - 1)
845 tm.newParMetricsUp();
846 else if (bot_pit == tm.last().first + 1)
847 tm.newParMetricsDown();
849 if (tm.contains(bot_pit)) {
850 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
851 LASSERT(!pm.rows().empty(), /**/);
852 // FIXME: smooth scrolling doesn't work in mathed.
853 CursorSlice const & cs = dit.innerTextSlice();
854 int offset = coordOffset(dit, dit.boundary()).y_;
855 int ypos = pm.position() + offset;
856 Dimension const & row_dim =
857 pm.getRow(cs.pos(), dit.boundary()).dimension();
860 scrolled = scroll(ypos - height_/2);
861 else if (ypos - row_dim.ascent() < 0)
862 scrolled = scrollUp(- ypos + row_dim.ascent());
863 else if (ypos + row_dim.descent() > height_)
864 scrolled = scrollDown(ypos - height_ + defaultRowHeight() );
866 // else, nothing to do, the cursor is already visible so we just return.
874 // fix inline completion position
875 if (d->inlineCompletionPos_.fixIfBroken())
876 d->inlineCompletionPos_ = DocIterator();
878 tm.redoParagraph(bot_pit);
879 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
880 int offset = coordOffset(dit, dit.boundary()).y_;
882 d->anchor_pit_ = bot_pit;
883 CursorSlice const & cs = dit.innerTextSlice();
884 Dimension const & row_dim =
885 pm.getRow(cs.pos(), dit.boundary()).dimension();
888 d->anchor_ypos_ = height_/2;
889 else if (d->anchor_pit_ == 0)
890 d->anchor_ypos_ = offset + pm.ascent();
891 else if (d->anchor_pit_ == max_pit)
892 d->anchor_ypos_ = height_ - offset - row_dim.descent();
893 else if (offset > height_)
894 d->anchor_ypos_ = height_ - offset - defaultRowHeight();
896 d->anchor_ypos_ = defaultRowHeight() * 2;
903 void BufferView::updateLayout(DocumentClass const * const oldlayout)
905 message(_("Converting document to new document class..."));
907 StableDocIterator backcur(d->cursor_);
908 ErrorList & el = buffer_.errorList("Class Switch");
909 cap::switchBetweenClasses(
910 oldlayout, buffer_.params().documentClassPtr(),
911 static_cast<InsetText &>(buffer_.inset()), el);
913 setCursor(backcur.asDocIterator(&buffer_));
915 buffer_.errors("Class Switch");
916 buffer_.updateLabels();
919 /** Return the change status at cursor position, taking in account the
920 * status at each level of the document iterator (a table in a deleted
921 * footnote is deleted).
922 * When \param outer is true, the top slice is not looked at.
924 static Change::Type lookupChangeType(DocIterator const & dit, bool outer = false)
926 size_t const depth = dit.depth() - (outer ? 1 : 0);
928 for (size_t i = 0 ; i < depth ; ++i) {
929 CursorSlice const & slice = dit[i];
930 if (!slice.inset().inMathed()
931 && slice.pos() < slice.paragraph().size()) {
932 Change::Type const ch = slice.paragraph().lookupChange(slice.pos()).type;
933 if (ch != Change::UNCHANGED)
937 return Change::UNCHANGED;
941 bool BufferView::getStatus(FuncRequest const & cmd, FuncStatus & flag)
943 // Can we use a readonly buffer?
944 if (buffer_.isReadonly()
945 && !lyxaction.funcHasFlag(cmd.action, LyXAction::ReadOnly)
946 && !lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer)) {
947 flag.message(from_utf8(N_("Document is read-only")));
948 flag.setEnabled(false);
951 // Are we in a DELETED change-tracking region?
952 if (lookupChangeType(d->cursor_, true) == Change::DELETED
953 && !lyxaction.funcHasFlag(cmd.action, LyXAction::ReadOnly)
954 && !lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer)) {
955 flag.message(from_utf8(N_("This portion of the document is deleted.")));
956 flag.setEnabled(false);
960 Cursor & cur = d->cursor_;
962 if (cur.getStatus(cmd, flag))
965 switch (cmd.action) {
967 // FIXME: This is a bit problematic because we don't check is this is a
968 // document BufferView or not for these LFUNs. We probably have to
969 // dispatch both to currentBufferView() and, if that fails,
970 // to documentBufferView(); same as we do know for current Buffer and
971 // document Buffer. Ideally those LFUN should go to Buffer as they*
972 // operate on the full Buffer and the cursor is only needed either for
973 // an Undo record or to restore a cursor position. But we don't know
974 // how to do that inside Buffer of course.
975 case LFUN_BUFFER_PARAMS_APPLY:
976 case LFUN_LAYOUT_MODULES_CLEAR:
977 case LFUN_LAYOUT_MODULE_ADD:
978 case LFUN_LAYOUT_RELOAD:
979 case LFUN_TEXTCLASS_APPLY:
980 case LFUN_TEXTCLASS_LOAD:
981 flag.setEnabled(!buffer_.isReadonly());
985 flag.setEnabled(buffer_.undo().hasUndoStack());
988 flag.setEnabled(buffer_.undo().hasRedoStack());
990 case LFUN_FILE_INSERT:
991 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
992 case LFUN_FILE_INSERT_PLAINTEXT:
993 case LFUN_BOOKMARK_SAVE:
994 // FIXME: Actually, these LFUNS should be moved to Text
995 flag.setEnabled(cur.inTexted());
998 case LFUN_FONT_STATE:
999 case LFUN_LABEL_INSERT:
1000 case LFUN_INFO_INSERT:
1001 case LFUN_INSET_EDIT:
1002 case LFUN_PARAGRAPH_GOTO:
1003 case LFUN_NOTE_NEXT:
1004 case LFUN_REFERENCE_NEXT:
1005 case LFUN_WORD_FIND:
1006 case LFUN_WORD_FIND_FORWARD:
1007 case LFUN_WORD_FIND_BACKWARD:
1008 case LFUN_WORD_FINDADV:
1009 case LFUN_WORD_REPLACE:
1012 case LFUN_MARK_TOGGLE:
1013 case LFUN_SCREEN_RECENTER:
1014 case LFUN_SCREEN_SHOW_CURSOR:
1015 case LFUN_BIBTEX_DATABASE_ADD:
1016 case LFUN_BIBTEX_DATABASE_DEL:
1017 case LFUN_NOTES_MUTATE:
1018 case LFUN_ALL_INSETS_TOGGLE:
1019 case LFUN_STATISTICS:
1020 case LFUN_BRANCH_ADD_INSERT:
1021 case LFUN_KEYMAP_OFF:
1022 case LFUN_KEYMAP_PRIMARY:
1023 case LFUN_KEYMAP_SECONDARY:
1024 case LFUN_KEYMAP_TOGGLE:
1025 flag.setEnabled(true);
1028 case LFUN_REGEXP_MODE:
1029 // FIXME: Test if current WorkArea is the search WorkArea
1030 flag.setEnabled(buffer().isInternal() && !cur.inRegexped());
1033 case LFUN_LABEL_COPY_AS_REF: {
1034 // if there is an inset at cursor, see whether it
1036 Inset * inset = cur.nextInset();
1037 if (!inset || !inset->getStatus(cur, cmd, flag))
1038 flag.setEnabled(false);
1042 case LFUN_NEXT_INSET_MODIFY: {
1043 // this is the real function we want to invoke
1044 FuncRequest tmpcmd = cmd;
1045 tmpcmd.action = LFUN_INSET_MODIFY;
1046 // if there is an inset at cursor, see whether it
1047 // handles the lfun, other start from scratch
1048 Inset * inset = cur.nextInset();
1049 if (!inset || !inset->getStatus(cur, tmpcmd, flag))
1050 flag = lyx::getStatus(tmpcmd);
1054 case LFUN_LABEL_GOTO: {
1055 flag.setEnabled(!cmd.argument().empty()
1056 || getInsetByCode<InsetRef>(cur, REF_CODE));
1060 case LFUN_CHANGES_TRACK:
1061 flag.setEnabled(true);
1062 flag.setOnOff(buffer_.params().trackChanges);
1065 case LFUN_CHANGES_OUTPUT:
1066 flag.setEnabled(true);
1067 flag.setOnOff(buffer_.params().outputChanges);
1070 case LFUN_CHANGES_MERGE:
1071 case LFUN_CHANGE_NEXT:
1072 case LFUN_CHANGE_PREVIOUS:
1073 case LFUN_ALL_CHANGES_ACCEPT:
1074 case LFUN_ALL_CHANGES_REJECT:
1075 // TODO: context-sensitive enabling of LFUNs
1076 // In principle, these command should only be enabled if there
1077 // is a change in the document. However, without proper
1078 // optimizations, this will inevitably result in poor performance.
1079 flag.setEnabled(true);
1082 case LFUN_BUFFER_TOGGLE_COMPRESSION: {
1083 flag.setOnOff(buffer_.params().compressed);
1087 case LFUN_SCREEN_UP:
1088 case LFUN_SCREEN_DOWN:
1090 case LFUN_SCREEN_UP_SELECT:
1091 case LFUN_SCREEN_DOWN_SELECT:
1092 case LFUN_INSET_FORALL:
1093 flag.setEnabled(true);
1096 case LFUN_LAYOUT_TABULAR:
1097 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
1101 flag.setEnabled(!cur.inset().forcePlainLayout(cur.idx()));
1104 case LFUN_LAYOUT_PARAGRAPH:
1105 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
1108 case LFUN_DIALOG_SHOW_NEW_INSET:
1109 // FIXME: this is wrong, but I do not understand the
1111 if (cur.inset().lyxCode() == CAPTION_CODE)
1112 return cur.inset().getStatus(cur, cmd, flag);
1113 // FIXME we should consider passthru paragraphs too.
1114 flag.setEnabled(!cur.inset().getLayout().isPassThru());
1117 case LFUN_CITATION_INSERT: {
1118 FuncRequest fr(LFUN_INSET_INSERT, "citation");
1119 // FIXME: This could turn in a recursive hell.
1120 // Shouldn't we use Buffer::getStatus() instead?
1121 flag.setEnabled(lyx::getStatus(fr).enabled());
1124 case LFUN_INSET_APPLY: {
1125 string const name = cmd.getArg(0);
1126 Inset * inset = editedInset(name);
1128 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1130 if (!inset->getStatus(cur, fr, fs)) {
1131 // Every inset is supposed to handle this
1132 LASSERT(false, break);
1136 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1137 flag |= lyx::getStatus(fr);
1143 flag.setEnabled(false);
1151 Inset * BufferView::editedInset(string const & name) const
1153 map<string, Inset *>::const_iterator it = d->edited_insets_.find(name);
1154 return it == d->edited_insets_.end() ? 0 : it->second;
1158 void BufferView::editInset(string const & name, Inset * inset)
1160 d->edited_insets_[name] = inset;
1164 bool BufferView::dispatch(FuncRequest const & cmd)
1166 //lyxerr << [ cmd = " << cmd << "]" << endl;
1168 // Make sure that the cached BufferView is correct.
1169 LYXERR(Debug::ACTION, " action[" << cmd.action << ']'
1170 << " arg[" << to_utf8(cmd.argument()) << ']'
1171 << " x[" << cmd.x << ']'
1172 << " y[" << cmd.y << ']'
1173 << " button[" << cmd.button() << ']');
1175 string const argument = to_utf8(cmd.argument());
1176 Cursor & cur = d->cursor_;
1178 // Don't dispatch function that does not apply to internal buffers.
1179 if (buffer_.isInternal()
1180 && lyxaction.funcHasFlag(cmd.action, LyXAction::NoInternal))
1183 // We'll set this back to false if need be.
1184 bool dispatched = true;
1185 buffer_.undo().beginUndoGroup();
1187 switch (cmd.action) {
1189 case LFUN_BUFFER_PARAMS_APPLY: {
1190 DocumentClass const * const oldClass = buffer_.params().documentClassPtr();
1191 cur.recordUndoFullDocument();
1192 istringstream ss(to_utf8(cmd.argument()));
1195 int const unknown_tokens = buffer_.readHeader(lex);
1196 if (unknown_tokens != 0) {
1197 LYXERR0("Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1198 << unknown_tokens << " unknown token"
1199 << (unknown_tokens == 1 ? "" : "s"));
1201 updateLayout(oldClass);
1203 // We are most certainly here because of a change in the document
1204 // It is then better to make sure that all dialogs are in sync with
1205 // current document settings.
1206 processUpdateFlags(Update::Force | Update::FitCursor);
1210 case LFUN_LAYOUT_MODULES_CLEAR: {
1211 DocumentClass const * const oldClass =
1212 buffer_.params().documentClassPtr();
1213 cur.recordUndoFullDocument();
1214 buffer_.params().clearLayoutModules();
1215 buffer_.params().makeDocumentClass();
1216 updateLayout(oldClass);
1217 processUpdateFlags(Update::Force | Update::FitCursor);
1221 case LFUN_LAYOUT_MODULE_ADD: {
1222 BufferParams const & params = buffer_.params();
1223 if (!params.moduleCanBeAdded(argument)) {
1224 LYXERR0("Module `" << argument <<
1225 "' cannot be added due to failed requirements or "
1226 "conflicts with installed modules.");
1229 DocumentClass const * const oldClass = params.documentClassPtr();
1230 cur.recordUndoFullDocument();
1231 buffer_.params().addLayoutModule(argument);
1232 buffer_.params().makeDocumentClass();
1233 updateLayout(oldClass);
1234 processUpdateFlags(Update::Force | Update::FitCursor);
1238 case LFUN_TEXTCLASS_APPLY: {
1239 if (!LayoutFileList::get().load(argument, buffer_.temppath()) &&
1240 !LayoutFileList::get().load(argument, buffer_.filePath()))
1243 LayoutFile const * old_layout = buffer_.params().baseClass();
1244 LayoutFile const * new_layout = &(LayoutFileList::get()[argument]);
1246 if (old_layout == new_layout)
1250 //Save the old, possibly modular, layout for use in conversion.
1251 DocumentClass const * const oldDocClass =
1252 buffer_.params().documentClassPtr();
1253 cur.recordUndoFullDocument();
1254 buffer_.params().setBaseClass(argument);
1255 buffer_.params().makeDocumentClass();
1256 updateLayout(oldDocClass);
1257 processUpdateFlags(Update::Force | Update::FitCursor);
1261 case LFUN_TEXTCLASS_LOAD:
1262 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1263 LayoutFileList::get().load(argument, buffer_.filePath());
1266 case LFUN_LAYOUT_RELOAD: {
1267 DocumentClass const * const oldClass = buffer_.params().documentClassPtr();
1268 LayoutFileIndex bc = buffer_.params().baseClassID();
1269 LayoutFileList::get().reset(bc);
1270 buffer_.params().setBaseClass(bc);
1271 buffer_.params().makeDocumentClass();
1272 updateLayout(oldClass);
1273 processUpdateFlags(Update::Force | Update::FitCursor);
1278 cur.message(_("Undo"));
1279 cur.clearSelection();
1280 if (!cur.textUndo())
1281 cur.message(_("No further undo information"));
1283 processUpdateFlags(Update::Force | Update::FitCursor);
1287 cur.message(_("Redo"));
1288 cur.clearSelection();
1289 if (!cur.textRedo())
1290 cur.message(_("No further redo information"));
1292 processUpdateFlags(Update::Force | Update::FitCursor);
1295 case LFUN_FONT_STATE:
1296 cur.message(cur.currentState());
1299 case LFUN_BOOKMARK_SAVE:
1300 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1303 case LFUN_LABEL_GOTO: {
1304 docstring label = cmd.argument();
1305 if (label.empty()) {
1307 getInsetByCode<InsetRef>(cur, REF_CODE);
1309 label = inset->getParam("reference");
1310 // persistent=false: use temp_bookmark
1319 case LFUN_INSET_EDIT: {
1320 FuncRequest fr(cmd);
1321 // if there is an inset at cursor, see whether it
1323 Inset * inset = cur.nextInset();
1325 inset->dispatch(cur, fr);
1326 // if it did not work, try the underlying inset.
1327 if (!inset || !cur.result().dispatched())
1330 // FIXME I'm adding the last break to solve a crash,
1331 // but that is obviously not right.
1332 if (!cur.result().dispatched())
1333 // It did not work too; no action needed.
1338 case LFUN_PARAGRAPH_GOTO: {
1339 int const id = convert<int>(cmd.getArg(0));
1340 int const pos = convert<int>(cmd.getArg(1));
1342 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1343 b = theBufferList().next(b)) {
1345 DocIterator dit = b->getParFromID(id);
1347 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1351 LYXERR(Debug::INFO, "Paragraph " << dit.paragraph().id()
1352 << " found in buffer `"
1353 << b->absFileName() << "'.");
1355 if (b == &buffer_) {
1359 processUpdateFlags(Update::Force | Update::FitCursor);
1361 // Switch to other buffer view and resend cmd
1362 theLyXFunc().dispatch(FuncRequest(
1363 LFUN_BUFFER_SWITCH, b->absFileName()));
1364 theLyXFunc().dispatch(cmd);
1371 case LFUN_NOTE_NEXT:
1372 gotoInset(this, NOTE_CODE, false);
1375 case LFUN_REFERENCE_NEXT: {
1376 vector<InsetCode> tmp;
1377 tmp.push_back(LABEL_CODE);
1378 tmp.push_back(REF_CODE);
1379 gotoInset(this, tmp, true);
1383 case LFUN_CHANGES_TRACK:
1384 buffer_.params().trackChanges = !buffer_.params().trackChanges;
1387 case LFUN_CHANGES_OUTPUT:
1388 buffer_.params().outputChanges = !buffer_.params().outputChanges;
1389 if (buffer_.params().outputChanges) {
1390 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1391 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1392 LaTeXFeatures::isAvailable("xcolor");
1394 if (!dvipost && !xcolorulem) {
1395 Alert::warning(_("Changes not shown in LaTeX output"),
1396 _("Changes will not be highlighted in LaTeX output, "
1397 "because neither dvipost nor xcolor/ulem are installed.\n"
1398 "Please install these packages or redefine "
1399 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1400 } else if (!xcolorulem) {
1401 Alert::warning(_("Changes not shown in LaTeX output"),
1402 _("Changes will not be highlighted in LaTeX output "
1403 "when using pdflatex, because xcolor and ulem are not installed.\n"
1404 "Please install both packages or redefine "
1405 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1410 case LFUN_CHANGE_NEXT:
1411 findNextChange(this);
1412 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1413 processUpdateFlags(Update::Force | Update::FitCursor);
1416 case LFUN_CHANGE_PREVIOUS:
1417 findPreviousChange(this);
1418 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1419 processUpdateFlags(Update::Force | Update::FitCursor);
1422 case LFUN_CHANGES_MERGE:
1423 if (findNextChange(this) || findPreviousChange(this)) {
1424 processUpdateFlags(Update::Force | Update::FitCursor);
1425 showDialog("changes");
1429 case LFUN_ALL_CHANGES_ACCEPT:
1430 // select complete document
1432 cur.selHandle(true);
1433 buffer_.text().cursorBottom(cur);
1434 // accept everything in a single step to support atomic undo
1435 buffer_.text().acceptOrRejectChanges(cur, Text::ACCEPT);
1436 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1437 processUpdateFlags(Update::Force | Update::FitCursor);
1440 case LFUN_ALL_CHANGES_REJECT:
1441 // select complete document
1443 cur.selHandle(true);
1444 buffer_.text().cursorBottom(cur);
1445 // reject everything in a single step to support atomic undo
1446 // Note: reject does not work recursively; the user may have to repeat the operation
1447 buffer_.text().acceptOrRejectChanges(cur, Text::REJECT);
1448 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1449 processUpdateFlags(Update::Force | Update::FitCursor);
1452 case LFUN_WORD_FIND_FORWARD:
1453 case LFUN_WORD_FIND_BACKWARD: {
1454 static docstring last_search;
1455 docstring searched_string;
1457 if (!cmd.argument().empty()) {
1458 last_search = cmd.argument();
1459 searched_string = cmd.argument();
1461 searched_string = last_search;
1464 if (searched_string.empty())
1467 bool const fw = cmd.action == LFUN_WORD_FIND_FORWARD;
1468 docstring const data =
1469 find2string(searched_string, true, false, fw);
1470 find(this, FuncRequest(LFUN_WORD_FIND, data));
1474 case LFUN_WORD_FIND: {
1475 FuncRequest req = cmd;
1476 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1477 req = d->search_request_cache_;
1478 if (req.argument().empty()) {
1479 theLyXFunc().dispatch(FuncRequest(LFUN_DIALOG_SHOW, "findreplace"));
1482 if (find(this, req))
1485 message(_("String not found!"));
1486 d->search_request_cache_ = req;
1490 case LFUN_WORD_REPLACE: {
1491 bool has_deleted = false;
1492 if (cur.selection()) {
1493 DocIterator beg = cur.selectionBegin();
1494 DocIterator end = cur.selectionEnd();
1495 if (beg.pit() == end.pit()) {
1496 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1497 if (cur.paragraph().isDeleted(p))
1502 replace(this, cmd, has_deleted);
1506 case LFUN_WORD_FINDADV: {
1507 FindAndReplaceOptions opt;
1508 istringstream iss(to_utf8(cmd.argument()));
1510 if (findAdv(this, opt))
1518 cur.clearSelection();
1519 cur.message(from_utf8(N_("Mark off")));
1523 cur.clearSelection();
1525 cur.message(from_utf8(N_("Mark on")));
1528 case LFUN_MARK_TOGGLE:
1529 cur.setSelection(false);
1532 cur.message(from_utf8(N_("Mark removed")));
1535 cur.message(from_utf8(N_("Mark set")));
1540 case LFUN_SCREEN_SHOW_CURSOR:
1544 case LFUN_SCREEN_RECENTER:
1548 case LFUN_BIBTEX_DATABASE_ADD: {
1549 Cursor tmpcur = cur;
1550 findInset(tmpcur, BIBTEX_CODE, false);
1551 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1554 if (inset->addDatabase(cmd.argument()))
1555 buffer_.updateBibfilesCache();
1560 case LFUN_BIBTEX_DATABASE_DEL: {
1561 Cursor tmpcur = cur;
1562 findInset(tmpcur, BIBTEX_CODE, false);
1563 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1566 if (inset->delDatabase(cmd.argument()))
1567 buffer_.updateBibfilesCache();
1572 case LFUN_STATISTICS: {
1573 DocIterator from, to;
1574 if (cur.selection()) {
1575 from = cur.selectionBegin();
1576 to = cur.selectionEnd();
1578 from = doc_iterator_begin(&buffer_);
1579 to = doc_iterator_end(&buffer_);
1581 int const words = countWords(from, to);
1582 int const chars = countChars(from, to, false);
1583 int const chars_blanks = countChars(from, to, true);
1585 if (cur.selection())
1586 message = _("Statistics for the selection:");
1588 message = _("Statistics for the document:");
1591 message += bformat(_("%1$d words"), words);
1593 message += _("One word");
1595 if (chars_blanks != 1)
1596 message += bformat(_("%1$d characters (including blanks)"),
1599 message += _("One character (including blanks)");
1602 message += bformat(_("%1$d characters (excluding blanks)"),
1605 message += _("One character (excluding blanks)");
1607 Alert::information(_("Statistics"), message);
1611 case LFUN_BUFFER_TOGGLE_COMPRESSION:
1612 // turn compression on/off
1613 buffer_.params().compressed = !buffer_.params().compressed;
1616 case LFUN_LABEL_COPY_AS_REF: {
1617 // if there is an inset at cursor, try to copy it
1618 Inset * inset = &cur.inset();
1619 if (!inset || !inset->asInsetMath())
1620 inset = cur.nextInset();
1622 FuncRequest tmpcmd = cmd;
1623 inset->dispatch(cur, tmpcmd);
1625 if (!cur.result().dispatched())
1626 // It did not work too; no action needed.
1628 cur.clearSelection();
1629 processUpdateFlags(Update::SinglePar | Update::FitCursor);
1633 case LFUN_NEXT_INSET_MODIFY: {
1634 // create the the real function we want to invoke
1635 FuncRequest tmpcmd = cmd;
1636 tmpcmd.action = LFUN_INSET_MODIFY;
1637 // if there is an inset at cursor, see whether it
1639 Inset * inset = cur.nextInset();
1642 inset->dispatch(cur, tmpcmd);
1644 // if it did not work, try the underlying inset.
1645 if (!inset || !cur.result().dispatched()) {
1647 cur.dispatch(tmpcmd);
1650 if (!cur.result().dispatched())
1651 // It did not work too; no action needed.
1653 cur.clearSelection();
1654 processUpdateFlags(Update::Force | Update::FitCursor);
1658 case LFUN_SCREEN_UP:
1659 case LFUN_SCREEN_DOWN: {
1660 Point p = getPos(cur, cur.boundary());
1661 // This code has been commented out to enable to scroll down a
1662 // document, even if there are large insets in it (see bug #5465).
1663 /*if (p.y_ < 0 || p.y_ > height_) {
1664 // The cursor is off-screen so recenter before proceeding.
1666 p = getPos(cur, cur.boundary());
1668 int const scrolled = scroll(cmd.action == LFUN_SCREEN_UP
1669 ? -height_ : height_);
1670 if (cmd.action == LFUN_SCREEN_UP && scrolled > -height_)
1672 if (cmd.action == LFUN_SCREEN_DOWN && scrolled < height_)
1673 p = Point(width_, height_);
1675 bool const in_texted = cur.inTexted();
1677 buffer_.changed(true);
1678 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_,
1679 true, cmd.action == LFUN_SCREEN_UP);
1680 //FIXME: what to do with cur.x_target()?
1681 bool update = in_texted && cur.bv().checkDepm(cur, old);
1684 processUpdateFlags(Update::Force | Update::FitCursor);
1692 case LFUN_SCREEN_UP_SELECT: {
1693 cur.selHandle(true);
1694 if (isTopScreen()) {
1695 lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1699 int y = getPos(cur, cur.boundary()).y_;
1700 int const ymin = y - height_ + defaultRowHeight();
1701 while (y > ymin && cur.up())
1702 y = getPos(cur, cur.boundary()).y_;
1705 processUpdateFlags(Update::SinglePar | Update::FitCursor);
1709 case LFUN_SCREEN_DOWN_SELECT: {
1710 cur.selHandle(true);
1711 if (isBottomScreen()) {
1712 lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1716 int y = getPos(cur, cur.boundary()).y_;
1717 int const ymax = y + height_ - defaultRowHeight();
1718 while (y < ymax && cur.down())
1719 y = getPos(cur, cur.boundary()).y_;
1722 processUpdateFlags(Update::SinglePar | Update::FitCursor);
1726 // This could be rewriten using some command like forall <insetname> <command>
1727 // once the insets refactoring is done.
1728 case LFUN_NOTES_MUTATE: {
1729 if (cmd.argument().empty())
1732 if (mutateNotes(cur, cmd.getArg(0), cmd.getArg(1))) {
1733 processUpdateFlags(Update::Force);
1739 // This would be in Buffer class if only Cursor did not
1740 // require a bufferview
1741 case LFUN_INSET_FORALL: {
1742 docstring const name = from_utf8(cmd.getArg(0));
1743 string const commandstr = cmd.getLongArg(1);
1744 FuncRequest const fr = lyxaction.lookupFunc(commandstr);
1746 // an arbitrary number to limit number of iterations
1747 const int max_iter = 1000;
1749 Cursor & cur = d->cursor_;
1751 if (!cur.nextInset())
1753 cur.beginUndoGroup();
1754 while(cur && iterations < max_iter) {
1755 Inset * ins = cur.nextInset();
1758 docstring insname = ins->name();
1759 while (!insname.empty()) {
1760 if (insname == name || name == from_utf8("*")) {
1766 size_t const i = insname.rfind(':');
1767 if (i == string::npos)
1769 insname = insname.substr(0, i);
1775 processUpdateFlags(Update::Force);
1777 if (iterations >= max_iter)
1778 cur.errorMessage(bformat(_("`inset-forall' interrupted because number of actions is larger than %1$d"), max_iter));
1780 cur.message(bformat(_("Applied \"%1$s\" to %2$d insets"), from_utf8(commandstr), iterations));
1785 case LFUN_ALL_INSETS_TOGGLE: {
1787 string const name = split(to_utf8(cmd.argument()), action, ' ');
1788 InsetCode const inset_code = insetCode(name);
1790 FuncRequest fr(LFUN_INSET_TOGGLE, action);
1792 Inset & inset = cur.buffer()->inset();
1793 InsetIterator it = inset_iterator_begin(inset);
1794 InsetIterator const end = inset_iterator_end(inset);
1795 for (; it != end; ++it) {
1796 if (it->asInsetCollapsable()
1797 && (inset_code == NO_CODE
1798 || inset_code == it->lyxCode())) {
1799 Cursor tmpcur = cur;
1800 tmpcur.pushBackward(*it);
1801 it->dispatch(tmpcur, fr);
1804 processUpdateFlags(Update::Force | Update::FitCursor);
1808 case LFUN_BRANCH_ADD_INSERT: {
1809 docstring branch_name = from_utf8(cmd.getArg(0));
1810 if (branch_name.empty())
1811 if (!Alert::askForText(branch_name, _("Branch name")) ||
1812 branch_name.empty())
1815 DispatchResult drtmp;
1816 buffer_.dispatch(FuncRequest(LFUN_BRANCH_ADD, branch_name), drtmp);
1817 if (drtmp.error()) {
1818 Alert::warning(_("Branch already exists"), drtmp.message());
1821 lyx::dispatch(FuncRequest(LFUN_BRANCH_INSERT, branch_name));
1825 case LFUN_KEYMAP_OFF:
1826 getIntl().keyMapOn(false);
1829 case LFUN_KEYMAP_PRIMARY:
1830 getIntl().keyMapPrim();
1833 case LFUN_KEYMAP_SECONDARY:
1834 getIntl().keyMapSec();
1837 case LFUN_KEYMAP_TOGGLE:
1838 getIntl().toggleKeyMap();
1841 case LFUN_DIALOG_SHOW_NEW_INSET: {
1842 string const name = cmd.getArg(0);
1843 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
1844 if (decodeInsetParam(name, data, buffer_))
1845 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
1847 lyxerr << "Inset type '" << name <<
1848 "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" << endl;
1852 case LFUN_CITATION_INSERT: {
1853 if (argument.empty()) {
1854 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
1857 // we can have one optional argument, delimited by '|'
1858 // citation-insert <key>|<text_before>
1859 // this should be enhanced to also support text_after
1860 // and citation style
1861 string arg = argument;
1863 if (contains(argument, "|")) {
1864 arg = token(argument, '|', 0);
1865 opt1 = token(argument, '|', 1);
1867 InsetCommandParams icp(CITE_CODE);
1868 icp["key"] = from_utf8(arg);
1870 icp["before"] = from_utf8(opt1);
1871 string icstr = InsetCommand::params2string("citation", icp);
1872 FuncRequest fr(LFUN_INSET_INSERT, icstr);
1877 case LFUN_INSET_APPLY: {
1878 string const name = cmd.getArg(0);
1879 Inset * inset = editedInset(name);
1881 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1885 // put cursor in front of inset.
1886 if (!setCursorFromInset(inset)) {
1887 LASSERT(false, break);
1890 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1891 inset->dispatch(cur, fr);
1892 processUpdateFlags(Update::SinglePar | Update::FitCursor);
1901 buffer_.undo().endUndoGroup();
1906 docstring const BufferView::requestSelection()
1908 Cursor & cur = d->cursor_;
1910 LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
1911 if (!cur.selection()) {
1912 d->xsel_cache_.set = false;
1916 LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
1917 if (!d->xsel_cache_.set ||
1918 cur.top() != d->xsel_cache_.cursor ||
1919 cur.anchor_.top() != d->xsel_cache_.anchor)
1921 d->xsel_cache_.cursor = cur.top();
1922 d->xsel_cache_.anchor = cur.anchor_.top();
1923 d->xsel_cache_.set = cur.selection();
1924 return cur.selectionAsString(false);
1930 void BufferView::clearSelection()
1932 d->cursor_.clearSelection();
1933 // Clear the selection buffer. Otherwise a subsequent
1934 // middle-mouse-button paste would use the selection buffer,
1935 // not the more current external selection.
1936 cap::clearSelection();
1937 d->xsel_cache_.set = false;
1938 // The buffer did not really change, but this causes the
1939 // redraw we need because we cleared the selection above.
1940 buffer_.changed(false);
1944 void BufferView::resize(int width, int height)
1946 // Update from work area
1950 // Clear the paragraph height cache.
1951 d->par_height_.clear();
1952 // Redo the metrics.
1957 Inset const * BufferView::getCoveringInset(Text const & text,
1960 TextMetrics & tm = d->text_metrics_[&text];
1961 Inset * inset = tm.checkInsetHit(x, y);
1965 if (!inset->descendable(*this))
1966 // No need to go further down if the inset is not
1970 size_t cell_number = inset->nargs();
1971 // Check all the inner cell.
1972 for (size_t i = 0; i != cell_number; ++i) {
1973 Text const * inner_text = inset->getText(i);
1976 Inset const * inset_deeper =
1977 getCoveringInset(*inner_text, x, y);
1979 return inset_deeper;
1987 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
1989 //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
1991 // This is only called for mouse related events including
1992 // LFUN_FILE_OPEN generated by drag-and-drop.
1993 FuncRequest cmd = cmd0;
1995 Cursor old = cursor();
1997 cur.push(buffer_.inset());
1998 cur.setSelection(d->cursor_.selection());
2000 // Either the inset under the cursor or the
2001 // surrounding Text will handle this event.
2003 // make sure we stay within the screen...
2004 cmd.y = min(max(cmd.y, -1), height_);
2006 if (cmd.action == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
2008 // Get inset under mouse, if there is one.
2009 Inset const * covering_inset =
2010 getCoveringInset(buffer_.text(), cmd.x, cmd.y);
2011 if (covering_inset == d->last_inset_)
2012 // Same inset, no need to do anything...
2015 bool need_redraw = false;
2016 // const_cast because of setMouseHover().
2017 Inset * inset = const_cast<Inset *>(covering_inset);
2019 // Remove the hint on the last hovered inset (if any).
2020 need_redraw |= d->last_inset_->setMouseHover(false);
2022 // Highlighted the newly hovered inset (if any).
2023 need_redraw |= inset->setMouseHover(true);
2024 d->last_inset_ = inset;
2028 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
2029 << cmd.x << ", " << cmd.y << ")");
2031 d->update_strategy_ = DecorationUpdate;
2033 // This event (moving without mouse click) is not passed further.
2034 // This should be changed if it is further utilized.
2035 buffer_.changed(false);
2039 // Build temporary cursor.
2040 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x, cmd.y);
2042 // Put anchor at the same position.
2045 cur.beginUndoGroup();
2047 // Try to dispatch to an non-editable inset near this position
2048 // via the temp cursor. If the inset wishes to change the real
2049 // cursor it has to do so explicitly by using
2050 // cur.bv().cursor() = cur; (or similar)
2052 inset->dispatch(cur, cmd);
2054 // Now dispatch to the temporary cursor. If the real cursor should
2055 // be modified, the inset's dispatch has to do so explicitly.
2056 if (!inset || !cur.result().dispatched())
2061 // Notify left insets
2064 bool badcursor = notifyCursorLeavesOrEnters(old, cur);
2066 cursor().fixIfBroken();
2069 // Do we have a selection?
2070 theSelection().haveSelection(cursor().selection());
2072 // If the command has been dispatched,
2073 if (cur.result().dispatched() || cur.result().update())
2074 processUpdateFlags(cur.result().update());
2078 void BufferView::lfunScroll(FuncRequest const & cmd)
2080 string const scroll_type = cmd.getArg(0);
2081 int const scroll_step =
2082 (scroll_type == "line") ? d->scrollbarParameters_.single_step
2083 : (scroll_type == "page") ? d->scrollbarParameters_.page_step : 0;
2084 if (scroll_step == 0)
2086 string const scroll_quantity = cmd.getArg(1);
2087 if (scroll_quantity == "up")
2088 scrollUp(scroll_step);
2089 else if (scroll_quantity == "down")
2090 scrollDown(scroll_step);
2092 int const scroll_value = convert<int>(scroll_quantity);
2094 scroll(scroll_step * scroll_value);
2096 buffer_.changed(true);
2100 int BufferView::minVisiblePart()
2102 return 2 * defaultRowHeight();
2106 int BufferView::scroll(int y)
2109 return scrollDown(y);
2111 return scrollUp(-y);
2116 int BufferView::scrollDown(int offset)
2118 Text * text = &buffer_.text();
2119 TextMetrics & tm = d->text_metrics_[text];
2120 int const ymax = height_ + offset;
2122 pair<pit_type, ParagraphMetrics const *> last = tm.last();
2123 int bottom_pos = last.second->position() + last.second->descent();
2124 if (lyxrc.scroll_below_document)
2125 bottom_pos += height_ - minVisiblePart();
2126 if (last.first + 1 == int(text->paragraphs().size())) {
2127 if (bottom_pos <= height_)
2129 offset = min(offset, bottom_pos - height_);
2132 if (bottom_pos > ymax)
2134 tm.newParMetricsDown();
2136 d->anchor_ypos_ -= offset;
2141 int BufferView::scrollUp(int offset)
2143 Text * text = &buffer_.text();
2144 TextMetrics & tm = d->text_metrics_[text];
2145 int ymin = - offset;
2147 pair<pit_type, ParagraphMetrics const *> first = tm.first();
2148 int top_pos = first.second->position() - first.second->ascent();
2149 if (first.first == 0) {
2152 offset = min(offset, - top_pos);
2157 tm.newParMetricsUp();
2159 d->anchor_ypos_ += offset;
2164 void BufferView::setCursorFromRow(int row)
2169 buffer_.texrow().getIdFromRow(row, tmpid, tmppos);
2173 buffer_.text().setCursor(d->cursor_, 0, 0);
2175 buffer_.text().setCursor(d->cursor_, buffer_.getParFromID(tmpid).pit(), tmppos);
2180 bool BufferView::setCursorFromInset(Inset const * inset)
2182 // are we already there?
2183 if (cursor().nextInset() == inset)
2186 // Inset is not at cursor position. Find it in the document.
2189 while (cur && cur.nextInset() != inset)
2200 void BufferView::gotoLabel(docstring const & label)
2202 std::vector<Buffer const *> bufs = buffer().allRelatives();
2203 std::vector<Buffer const *>::iterator it = bufs.begin();
2204 for (; it != bufs.end(); ++it) {
2205 Buffer const * buf = *it;
2208 Toc & toc = buf->tocBackend().toc("label");
2209 TocIterator toc_it = toc.begin();
2210 TocIterator end = toc.end();
2211 for (; toc_it != end; ++toc_it) {
2212 if (label == toc_it->str()) {
2213 dispatch(toc_it->action());
2221 TextMetrics const & BufferView::textMetrics(Text const * t) const
2223 return const_cast<BufferView *>(this)->textMetrics(t);
2227 TextMetrics & BufferView::textMetrics(Text const * t)
2229 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
2230 if (tmc_it == d->text_metrics_.end()) {
2231 tmc_it = d->text_metrics_.insert(
2232 make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
2234 return tmc_it->second;
2238 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
2241 return textMetrics(t).parMetrics(pit);
2245 int BufferView::workHeight() const
2251 void BufferView::setCursor(DocIterator const & dit)
2254 size_t const n = dit.depth();
2255 for (size_t i = 0; i < n; ++i)
2256 dit[i].inset().edit(d->cursor_, true);
2258 d->cursor_.setCursor(dit);
2259 d->cursor_.setSelection(false);
2263 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
2265 // Would be wrong to delete anything if we have a selection.
2266 if (cur.selection())
2269 bool need_anchor_change = false;
2270 bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
2271 need_anchor_change);
2273 if (need_anchor_change)
2281 buffer_.updateLabels();
2282 buffer_.changed(true);
2287 bool BufferView::mouseSetCursor(Cursor & cur, bool select)
2289 LASSERT(&cur.bv() == this, /**/);
2292 // this event will clear selection so we save selection for
2293 // persistent selection
2294 cap::saveSelection(cursor());
2296 d->cursor_.macroModeClose();
2298 // Has the cursor just left the inset?
2299 bool leftinset = (&d->cursor_.inset() != &cur.inset());
2301 d->cursor_.fixIfBroken();
2303 // FIXME: shift-mouse selection doesn't work well across insets.
2304 bool do_selection = select && &d->cursor_.anchor().inset() == &cur.inset();
2306 // do the dEPM magic if needed
2307 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
2308 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
2309 // the leftinset bool would not be necessary (badcursor instead).
2310 bool update = leftinset;
2311 if (!do_selection && d->cursor_.inTexted())
2312 update |= checkDepm(cur, d->cursor_);
2315 d->cursor_.resetAnchor();
2316 d->cursor_.setCursor(cur);
2317 d->cursor_.boundary(cur.boundary());
2319 d->cursor_.setSelection();
2321 d->cursor_.clearSelection();
2323 d->cursor_.finishUndo();
2324 d->cursor_.setCurrentFont();
2329 void BufferView::putSelectionAt(DocIterator const & cur,
2330 int length, bool backwards)
2332 d->cursor_.clearSelection();
2338 d->cursor_.pos() += length;
2339 d->cursor_.setSelection(d->cursor_, -length);
2341 d->cursor_.setSelection(d->cursor_, length);
2343 // Ensure a redraw happens in any case because the new selection could
2344 // possibly be on the same screen as the previous selection.
2345 processUpdateFlags(Update::Force | Update::FitCursor);
2349 Cursor & BufferView::cursor()
2355 Cursor const & BufferView::cursor() const
2361 pit_type BufferView::anchor_ref() const
2363 return d->anchor_pit_;
2367 bool BufferView::singleParUpdate()
2369 Text & buftext = buffer_.text();
2370 pit_type const bottom_pit = d->cursor_.bottom().pit();
2371 TextMetrics & tm = textMetrics(&buftext);
2372 int old_height = tm.parMetrics(bottom_pit).height();
2374 // make sure inline completion pointer is ok
2375 if (d->inlineCompletionPos_.fixIfBroken())
2376 d->inlineCompletionPos_ = DocIterator();
2378 // In Single Paragraph mode, rebreak only
2379 // the (main text, not inset!) paragraph containing the cursor.
2380 // (if this paragraph contains insets etc., rebreaking will
2381 // recursively descend)
2382 tm.redoParagraph(bottom_pit);
2383 ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
2384 if (pm.height() != old_height)
2385 // Paragraph height has changed so we cannot proceed to
2386 // the singlePar optimisation.
2389 d->update_strategy_ = SingleParUpdate;
2391 LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
2392 << " y2: " << pm.position() + pm.descent()
2393 << " pit: " << bottom_pit
2394 << " singlepar: 1");
2399 void BufferView::updateMetrics()
2401 if (height_ == 0 || width_ == 0)
2404 Text & buftext = buffer_.text();
2405 pit_type const npit = int(buftext.paragraphs().size());
2407 // Clear out the position cache in case of full screen redraw,
2408 d->coord_cache_.clear();
2410 // Clear out paragraph metrics to avoid having invalid metrics
2411 // in the cache from paragraphs not relayouted below
2412 // The complete text metrics will be redone.
2413 d->text_metrics_.clear();
2415 TextMetrics & tm = textMetrics(&buftext);
2417 // make sure inline completion pointer is ok
2418 if (d->inlineCompletionPos_.fixIfBroken())
2419 d->inlineCompletionPos_ = DocIterator();
2421 if (d->anchor_pit_ >= npit)
2422 // The anchor pit must have been deleted...
2423 d->anchor_pit_ = npit - 1;
2425 // Rebreak anchor paragraph.
2426 tm.redoParagraph(d->anchor_pit_);
2427 ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
2430 if (d->anchor_pit_ == 0) {
2431 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
2433 // Complete buffer visible? Then it's easy.
2434 if (scrollRange == 0)
2435 d->anchor_ypos_ = anchor_pm.ascent();
2437 // FIXME: Some clever handling needed to show
2438 // the _first_ paragraph up to the top if the cursor is
2439 // in the first line.
2441 anchor_pm.setPosition(d->anchor_ypos_);
2443 LYXERR(Debug::PAINTING, "metrics: "
2444 << " anchor pit = " << d->anchor_pit_
2445 << " anchor ypos = " << d->anchor_ypos_);
2447 // Redo paragraphs above anchor if necessary.
2448 int y1 = d->anchor_ypos_ - anchor_pm.ascent();
2449 // We are now just above the anchor paragraph.
2450 pit_type pit1 = d->anchor_pit_ - 1;
2451 for (; pit1 >= 0 && y1 >= 0; --pit1) {
2452 tm.redoParagraph(pit1);
2453 ParagraphMetrics & pm = tm.par_metrics_[pit1];
2455 // Save the paragraph position in the cache.
2460 // Redo paragraphs below the anchor if necessary.
2461 int y2 = d->anchor_ypos_ + anchor_pm.descent();
2462 // We are now just below the anchor paragraph.
2463 pit_type pit2 = d->anchor_pit_ + 1;
2464 for (; pit2 < npit && y2 <= height_; ++pit2) {
2465 tm.redoParagraph(pit2);
2466 ParagraphMetrics & pm = tm.par_metrics_[pit2];
2468 // Save the paragraph position in the cache.
2473 LYXERR(Debug::PAINTING, "Metrics: "
2474 << " anchor pit = " << d->anchor_pit_
2475 << " anchor ypos = " << d->anchor_ypos_
2478 << " pit1 = " << pit1
2479 << " pit2 = " << pit2);
2481 d->update_strategy_ = FullScreenUpdate;
2483 if (lyxerr.debugging(Debug::WORKAREA)) {
2484 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
2485 d->coord_cache_.dump();
2490 void BufferView::insertLyXFile(FileName const & fname)
2492 LASSERT(d->cursor_.inTexted(), /**/);
2494 // Get absolute path of file and add ".lyx"
2495 // to the filename if necessary
2496 FileName filename = fileSearch(string(), fname.absFilename(), "lyx");
2498 docstring const disp_fn = makeDisplayPath(filename.absFilename());
2499 // emit message signal.
2500 message(bformat(_("Inserting document %1$s..."), disp_fn));
2503 Buffer buf("", false);
2504 if (buf.loadLyXFile(filename)) {
2505 ErrorList & el = buffer_.errorList("Parse");
2506 // Copy the inserted document error list into the current buffer one.
2507 el = buf.errorList("Parse");
2508 buffer_.undo().recordUndo(d->cursor_);
2509 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
2510 buf.params().documentClassPtr(), el);
2511 res = _("Document %1$s inserted.");
2513 res = _("Could not insert document %1$s");
2516 buffer_.changed(true);
2517 // emit message signal.
2518 message(bformat(res, disp_fn));
2519 buffer_.errors("Parse");
2523 Point BufferView::coordOffset(DocIterator const & dit, bool boundary) const
2529 // Addup contribution of nested insets, from inside to outside,
2530 // keeping the outer paragraph for a special handling below
2531 for (size_t i = dit.depth() - 1; i >= 1; --i) {
2532 CursorSlice const & sl = dit[i];
2536 // get relative position inside sl.inset()
2537 sl.inset().cursorPos(*this, sl, boundary && (i + 1 == dit.depth()), xx, yy);
2539 // Make relative position inside of the edited inset relative to sl.inset()
2543 // In case of an RTL inset, the edited inset will be positioned to the left
2546 bool boundary_i = boundary && i + 1 == dit.depth();
2547 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2552 // remember width for the case that sl.inset() is positioned in an RTL inset
2553 if (i && dit[i - 1].text()) {
2554 // If this Inset is inside a Text Inset, retrieve the Dimension
2555 // from the containing text instead of using Inset::dimension() which
2556 // might not be implemented.
2557 // FIXME (Abdel 23/09/2007): this is a bit messy because of the
2558 // elimination of Inset::dim_ cache. This coordOffset() method needs
2559 // to be rewritten in light of the new design.
2560 Dimension const & dim = parMetrics(dit[i - 1].text(),
2561 dit[i - 1].pit()).insetDimension(&sl.inset());
2564 Dimension const dim = sl.inset().dimension(*this);
2568 //lyxerr << "Cursor::getPos, i: "
2569 // << i << " x: " << xx << " y: " << y << endl;
2572 // Add contribution of initial rows of outermost paragraph
2573 CursorSlice const & sl = dit[0];
2574 TextMetrics const & tm = textMetrics(sl.text());
2575 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2576 LASSERT(!pm.rows().empty(), /**/);
2577 y -= pm.rows()[0].ascent();
2579 // FIXME: document this mess
2581 if (sl.pos() > 0 && dit.depth() == 1) {
2583 if (pos && boundary)
2585 // lyxerr << "coordOffset: boundary:" << boundary << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
2586 rend = pm.pos2row(pos);
2588 rend = pm.pos2row(sl.pos());
2590 size_t rend = pm.pos2row(sl.pos());
2592 for (size_t rit = 0; rit != rend; ++rit)
2593 y += pm.rows()[rit].height();
2594 y += pm.rows()[rend].ascent();
2596 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
2598 // Make relative position from the nested inset now bufferview absolute.
2599 int xx = bottom_tm.cursorX(dit.bottom(), boundary && dit.depth() == 1);
2602 // In the RTL case place the nested inset at the left of the cursor in
2603 // the outer paragraph
2604 bool boundary_1 = boundary && 1 == dit.depth();
2605 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
2613 Point BufferView::getPos(DocIterator const & dit, bool boundary) const
2615 if (!paragraphVisible(dit))
2616 return Point(-1, -1);
2618 CursorSlice const & bot = dit.bottom();
2619 TextMetrics const & tm = textMetrics(bot.text());
2621 Point p = coordOffset(dit, boundary); // offset from outer paragraph
2622 p.y_ += tm.parMetrics(bot.pit()).position();
2627 bool BufferView::paragraphVisible(DocIterator const & dit) const
2629 CursorSlice const & bot = dit.bottom();
2630 TextMetrics const & tm = textMetrics(bot.text());
2632 return tm.contains(bot.pit());
2636 void BufferView::cursorPosAndHeight(Point & p, int & h) const
2638 Cursor const & cur = cursor();
2639 Font const font = cur.getFont();
2640 frontend::FontMetrics const & fm = theFontMetrics(font);
2641 int const asc = fm.maxAscent();
2642 int const des = fm.maxDescent();
2644 p = getPos(cur, cur.boundary());
2649 bool BufferView::cursorInView(Point const & p, int h) const
2651 Cursor const & cur = cursor();
2652 // does the cursor touch the screen ?
2653 if (p.y_ + h < 0 || p.y_ >= workHeight() || !paragraphVisible(cur))
2659 void BufferView::draw(frontend::Painter & pain)
2661 if (height_ == 0 || width_ == 0)
2663 LYXERR(Debug::PAINTING, "\t\t*** START DRAWING ***");
2665 Text & text = buffer_.text();
2666 TextMetrics const & tm = d->text_metrics_[&text];
2667 int const y = tm.first().second->position();
2668 PainterInfo pi(this, pain);
2670 switch (d->update_strategy_) {
2672 case NoScreenUpdate:
2673 // If no screen painting is actually needed, only some the different
2674 // coordinates of insets and paragraphs needs to be updated.
2675 pi.full_repaint = true;
2676 pi.pain.setDrawingEnabled(false);
2680 case SingleParUpdate:
2681 pi.full_repaint = false;
2682 // In general, only the current row of the outermost paragraph
2683 // will be redrawn. Particular cases where selection spans
2684 // multiple paragraph are correctly detected in TextMetrics.
2688 case DecorationUpdate:
2689 // FIXME: We should also distinguish DecorationUpdate to avoid text
2690 // drawing if possible. This is not possible to do easily right now
2691 // because of the single backing pixmap.
2693 case FullScreenUpdate:
2694 // The whole screen, including insets, will be refreshed.
2695 pi.full_repaint = true;
2697 // Clear background.
2698 pain.fillRectangle(0, 0, width_, height_,
2699 pi.backgroundColor(&buffer_.inset()));
2704 // and possibly grey out below
2705 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2706 int const y2 = lastpm.second->position() + lastpm.second->descent();
2709 Color color = buffer().isInternal()
2710 ? Color_background : Color_bottomarea;
2711 pain.fillRectangle(0, y2, width_, height_ - y2, color);
2715 LYXERR(Debug::PAINTING, "\n\t\t*** END DRAWING ***");
2717 // The scrollbar needs an update.
2720 // Normalize anchor for next time
2721 pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
2722 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2723 for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
2724 ParagraphMetrics const & pm = tm.parMetrics(pit);
2725 if (pm.position() + pm.descent() > 0) {
2726 d->anchor_pit_ = pit;
2727 d->anchor_ypos_ = pm.position();
2731 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
2732 << " anchor ypos = " << d->anchor_ypos_);
2736 void BufferView::message(docstring const & msg)
2739 d->gui_->message(msg);
2743 void BufferView::showDialog(string const & name)
2746 d->gui_->showDialog(name, string());
2750 void BufferView::showDialog(string const & name,
2751 string const & data, Inset * inset)
2754 d->gui_->showDialog(name, data, inset);
2758 void BufferView::updateDialog(string const & name, string const & data)
2761 d->gui_->updateDialog(name, data);
2765 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
2771 // FIXME: Move this out of BufferView again
2772 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
2774 if (!fname.isReadableFile()) {
2775 docstring const error = from_ascii(strerror(errno));
2776 docstring const file = makeDisplayPath(fname.absFilename(), 50);
2777 docstring const text =
2778 bformat(_("Could not read the specified document\n"
2779 "%1$s\ndue to the error: %2$s"), file, error);
2780 Alert::error(_("Could not read file"), text);
2784 if (!fname.isReadableFile()) {
2785 docstring const file = makeDisplayPath(fname.absFilename(), 50);
2786 docstring const text =
2787 bformat(_("%1$s\n is not readable."), file);
2788 Alert::error(_("Could not open file"), text);
2792 // FIXME UNICODE: We don't know the encoding of the file
2793 docstring file_content = fname.fileContents("UTF-8");
2794 if (file_content.empty()) {
2795 Alert::error(_("Reading not UTF-8 encoded file"),
2796 _("The file is not UTF-8 encoded.\n"
2797 "It will be read as local 8Bit-encoded.\n"
2798 "If this does not give the correct result\n"
2799 "then please change the encoding of the file\n"
2800 "to UTF-8 with a program other than LyX.\n"));
2801 file_content = fname.fileContents("local8bit");
2804 return normalize_c(file_content);
2808 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
2810 docstring const tmpstr = contentsOfPlaintextFile(f);
2815 Cursor & cur = cursor();
2816 cap::replaceSelection(cur);
2817 buffer_.undo().recordUndo(cur);
2819 cur.innerText()->insertStringAsParagraphs(cur, tmpstr, cur.current_font);
2821 cur.innerText()->insertStringAsLines(cur, tmpstr, cur.current_font);
2823 buffer_.changed(true);
2827 docstring const & BufferView::inlineCompletion() const
2829 return d->inlineCompletion_;
2833 size_t const & BufferView::inlineCompletionUniqueChars() const
2835 return d->inlineCompletionUniqueChars_;
2839 DocIterator const & BufferView::inlineCompletionPos() const
2841 return d->inlineCompletionPos_;
2845 bool samePar(DocIterator const & a, DocIterator const & b)
2847 if (a.empty() && b.empty())
2849 if (a.empty() || b.empty())
2851 if (a.depth() != b.depth())
2853 return &a.innerParagraph() == &b.innerParagraph();
2857 void BufferView::setInlineCompletion(Cursor & cur, DocIterator const & pos,
2858 docstring const & completion, size_t uniqueChars)
2860 uniqueChars = min(completion.size(), uniqueChars);
2861 bool changed = d->inlineCompletion_ != completion
2862 || d->inlineCompletionUniqueChars_ != uniqueChars;
2863 bool singlePar = true;
2864 d->inlineCompletion_ = completion;
2865 d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
2867 //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
2870 DocIterator const & old = d->inlineCompletionPos_;
2872 //lyxerr << "inlineCompletionPos changed" << std::endl;
2873 // old or pos are in another paragraph?
2874 if ((!samePar(cur, pos) && !pos.empty())
2875 || (!samePar(cur, old) && !old.empty())) {
2877 //lyxerr << "different paragraph" << std::endl;
2879 d->inlineCompletionPos_ = pos;
2884 if (singlePar && !(cur.disp_.update() & Update::Force))
2885 cur.updateFlags(cur.disp_.update() | Update::SinglePar);
2887 cur.updateFlags(cur.disp_.update() | Update::Force);