3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Alfredo Braunstein
7 * \author Lars Gullik Bjønnes
10 * \author Jürgen Vigna
12 * Full author contact details are available in file CREDITS.
17 #include "BufferView.h"
19 #include "BranchList.h"
21 #include "buffer_funcs.h"
22 #include "BufferList.h"
23 #include "BufferParams.h"
24 #include "CoordCache.h"
26 #include "CutAndPaste.h"
27 #include "DispatchResult.h"
28 #include "ErrorList.h"
30 #include "FloatList.h"
31 #include "FuncRequest.h"
32 #include "FuncStatus.h"
34 #include "InsetIterator.h"
36 #include "LaTeXFeatures.h"
37 #include "LayoutFile.h"
40 #include "LyXAction.h"
44 #include "MetricsInfo.h"
45 #include "Paragraph.h"
46 #include "ParagraphParameters.h"
47 #include "ParIterator.h"
50 #include "TextClass.h"
51 #include "TextMetrics.h"
53 #include "TocBackend.h"
55 #include "WordLangTuple.h"
57 #include "insets/InsetBibtex.h"
58 #include "insets/InsetCommand.h" // ChangeRefs
59 #include "insets/InsetExternal.h"
60 #include "insets/InsetGraphics.h"
61 #include "insets/InsetRef.h"
62 #include "insets/InsetText.h"
63 #include "insets/InsetNote.h"
65 #include "frontends/alert.h"
66 #include "frontends/Application.h"
67 #include "frontends/Delegates.h"
68 #include "frontends/FontMetrics.h"
69 #include "frontends/Painter.h"
70 #include "frontends/Selection.h"
72 #include "graphics/Previews.h"
74 #include "support/convert.h"
75 #include "support/debug.h"
76 #include "support/ExceptionMessage.h"
77 #include "support/filetools.h"
78 #include "support/gettext.h"
79 #include "support/lstrings.h"
80 #include "support/Package.h"
81 #include "support/types.h"
91 using namespace lyx::support;
95 namespace Alert = frontend::Alert;
99 /// Return an inset of this class if it exists at the current cursor position
101 T * getInsetByCode(Cursor const & cur, InsetCode code)
103 DocIterator it = cur;
104 Inset * inset = it.nextInset();
105 if (inset && inset->lyxCode() == code)
106 return static_cast<T*>(inset);
111 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
114 bool findNextInset(DocIterator & dit, vector<InsetCode> const & codes,
115 docstring const & contents)
117 DocIterator tmpdit = dit;
120 Inset const * inset = tmpdit.nextInset();
122 && std::find(codes.begin(), codes.end(), inset->lyxCode()) != codes.end()
123 && (contents.empty() ||
124 static_cast<InsetCommand const *>(inset)->getFirstNonOptParam() == contents)) {
128 tmpdit.forwardInset();
135 /// Looks for next inset with one of the given codes.
136 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
140 DocIterator tmpdit = dit;
141 tmpdit.forwardInset();
146 Inset const * inset = tmpdit.nextInset();
148 && std::find(codes.begin(), codes.end(), inset->lyxCode()) != codes.end()) {
149 contents = static_cast<InsetCommand const *>(inset)->getFirstNonOptParam();
153 if (!findNextInset(tmpdit, codes, contents)) {
154 if (dit.depth() != 1 || dit.pit() != 0 || dit.pos() != 0) {
155 Inset * inset = &tmpdit.bottom().inset();
156 tmpdit = doc_iterator_begin(&inset->buffer(), inset);
157 if (!findNextInset(tmpdit, codes, contents))
169 /// Looks for next inset with the given code
170 void findInset(DocIterator & dit, InsetCode code, bool same_content)
172 findInset(dit, vector<InsetCode>(1, code), same_content);
176 /// Moves cursor to the next inset with one of the given codes.
177 void gotoInset(BufferView * bv, vector<InsetCode> const & codes,
180 Cursor tmpcur = bv->cursor();
181 if (!findInset(tmpcur, codes, same_content)) {
182 bv->cursor().message(_("No more insets"));
186 tmpcur.clearSelection();
187 bv->setCursor(tmpcur);
192 /// Moves cursor to the next inset with given code.
193 void gotoInset(BufferView * bv, InsetCode code, bool same_content)
195 gotoInset(bv, vector<InsetCode>(1, code), same_content);
199 /// A map from a Text to the associated text metrics
200 typedef map<Text const *, TextMetrics> TextMetricsCache;
202 enum ScreenUpdateStrategy {
212 /////////////////////////////////////////////////////////////////////
216 /////////////////////////////////////////////////////////////////////
218 struct BufferView::Private
220 Private(BufferView & bv): wh_(0), cursor_(bv),
221 anchor_pit_(0), anchor_ypos_(0),
222 inlineCompletionUniqueChars_(0),
223 last_inset_(0), mouse_position_cache_(),
224 bookmark_edit_position_(0), gui_(0)
228 ScrollbarParameters scrollbarParameters_;
230 ScreenUpdateStrategy update_strategy_;
232 CoordCache coord_cache_;
234 /// Estimated average par height for scrollbar.
236 /// this is used to handle XSelection events in the right manner.
245 pit_type anchor_pit_;
249 vector<int> par_height_;
252 DocIterator inlineCompletionPos_;
254 docstring inlineCompletion_;
256 size_t inlineCompletionUniqueChars_;
258 /// keyboard mapping object.
261 /// last visited inset.
262 /** kept to send setMouseHover(false).
263 * Not owned, so don't delete.
267 /// position of the mouse at the time of the last mouse move
268 /// This is used to update the hovering status of inset in
269 /// cases where the buffer is scrolled, but the mouse didn't move.
270 Point mouse_position_cache_;
272 // cache for id of the paragraph which was edited the last time
273 int bookmark_edit_position_;
275 mutable TextMetricsCache text_metrics_;
278 /** Not owned, so don't delete.
280 frontend::GuiBufferViewDelegate * gui_;
282 /// Cache for Find Next
283 FuncRequest search_request_cache_;
286 map<string, Inset *> edited_insets_;
290 BufferView::BufferView(Buffer & buf)
291 : width_(0), height_(0), full_screen_(false), buffer_(buf),
292 d(new Private(*this))
294 d->xsel_cache_.set = false;
295 d->intl_.initKeyMapper(lyxrc.use_kbmap);
297 d->cursor_.setBuffer(&buf);
298 d->cursor_.push(buffer_.inset());
299 d->cursor_.resetAnchor();
300 d->cursor_.setCurrentFont();
302 if (graphics::Previews::status() != LyXRC::PREVIEW_OFF)
303 thePreviews().generateBufferPreviews(buffer_);
307 BufferView::~BufferView()
309 // current buffer is going to be switched-off, save cursor pos
310 // Ideally, the whole cursor stack should be saved, but session
311 // currently can only handle bottom (whole document) level pit and pos.
312 // That is to say, if a cursor is in a nested inset, it will be
313 // restore to the left of the top level inset.
314 LastFilePosSection::FilePos fp;
315 fp.pit = d->cursor_.bottom().pit();
316 fp.pos = d->cursor_.bottom().pos();
317 theSession().lastFilePos().save(buffer_.fileName(), fp);
320 d->last_inset_->setMouseHover(this, false);
326 int BufferView::rightMargin() const
328 // The additional test for the case the outliner is opened.
330 !lyxrc.full_screen_limit ||
331 width_ < lyxrc.full_screen_width + 20)
334 return (width_ - lyxrc.full_screen_width) / 2;
338 int BufferView::leftMargin() const
340 return rightMargin();
344 bool BufferView::isTopScreen() const
346 return d->scrollbarParameters_.position == d->scrollbarParameters_.min;
350 bool BufferView::isBottomScreen() const
352 return d->scrollbarParameters_.position == d->scrollbarParameters_.max;
356 Intl & BufferView::getIntl()
362 Intl const & BufferView::getIntl() const
368 CoordCache & BufferView::coordCache()
370 return d->coord_cache_;
374 CoordCache const & BufferView::coordCache() const
376 return d->coord_cache_;
380 Buffer & BufferView::buffer()
386 Buffer const & BufferView::buffer() const
392 bool BufferView::fitCursor()
394 if (cursorStatus(d->cursor_) == CUR_INSIDE) {
395 frontend::FontMetrics const & fm =
396 theFontMetrics(d->cursor_.getFont().fontInfo());
397 int const asc = fm.maxAscent();
398 int const des = fm.maxDescent();
399 Point const p = getPos(d->cursor_);
400 if (p.y_ - asc >= 0 && p.y_ + des < height_)
407 void BufferView::processUpdateFlags(Update::flags flags)
409 // This is close to a hot-path.
410 LYXERR(Debug::DEBUG, "BufferView::processUpdateFlags()"
411 << "[fitcursor = " << (flags & Update::FitCursor)
412 << ", forceupdate = " << (flags & Update::Force)
413 << ", singlepar = " << (flags & Update::SinglePar)
414 << "] buffer: " << &buffer_);
416 buffer_.updateMacros();
418 // Now do the first drawing step if needed. This consists on updating
419 // the CoordCache in updateMetrics().
420 // The second drawing step is done in WorkArea::redraw() if needed.
422 // Case when no explicit update is requested.
424 // no need to redraw anything.
425 d->update_strategy_ = NoScreenUpdate;
429 if (flags == Update::Decoration) {
430 d->update_strategy_ = DecorationUpdate;
431 buffer_.changed(false);
435 if (flags == Update::FitCursor
436 || flags == (Update::Decoration | Update::FitCursor)) {
437 // tell the frontend to update the screen if needed.
442 if (flags & Update::Decoration) {
443 d->update_strategy_ = DecorationUpdate;
444 buffer_.changed(false);
447 // no screen update is needed.
448 d->update_strategy_ = NoScreenUpdate;
452 bool const full_metrics = flags & Update::Force || !singleParUpdate();
455 // We have to update the full screen metrics.
458 if (!(flags & Update::FitCursor)) {
459 // Nothing to do anymore. Trigger a redraw and return
460 buffer_.changed(false);
464 // updateMetrics() does not update paragraph position
465 // This is done at draw() time. So we need a redraw!
466 buffer_.changed(false);
469 // The cursor is off screen so ensure it is visible.
474 updateHoveredInset();
478 void BufferView::updateScrollbar()
480 if (height_ == 0 && width_ == 0)
483 // We prefer fixed size line scrolling.
484 d->scrollbarParameters_.single_step = defaultRowHeight();
485 // We prefer full screen page scrolling.
486 d->scrollbarParameters_.page_step = height_;
488 Text & t = buffer_.text();
489 TextMetrics & tm = d->text_metrics_[&t];
491 LYXERR(Debug::GUI, " Updating scrollbar: height: "
492 << t.paragraphs().size()
493 << " curr par: " << d->cursor_.bottom().pit()
494 << " default height " << defaultRowHeight());
496 size_t const parsize = t.paragraphs().size();
497 if (d->par_height_.size() != parsize) {
498 d->par_height_.clear();
499 // FIXME: We assume a default paragraph height of 2 rows. This
500 // should probably be pondered with the screen width.
501 d->par_height_.resize(parsize, defaultRowHeight() * 2);
504 // Look at paragraph heights on-screen
505 pair<pit_type, ParagraphMetrics const *> first = tm.first();
506 pair<pit_type, ParagraphMetrics const *> last = tm.last();
507 for (pit_type pit = first.first; pit <= last.first; ++pit) {
508 d->par_height_[pit] = tm.parMetrics(pit).height();
509 LYXERR(Debug::SCROLLING, "storing height for pit " << pit << " : "
510 << d->par_height_[pit]);
513 int top_pos = first.second->position() - first.second->ascent();
514 int bottom_pos = last.second->position() + last.second->descent();
515 bool first_visible = first.first == 0 && top_pos >= 0;
516 bool last_visible = last.first + 1 == int(parsize) && bottom_pos <= height_;
517 if (first_visible && last_visible) {
518 d->scrollbarParameters_.min = 0;
519 d->scrollbarParameters_.max = 0;
523 d->scrollbarParameters_.min = top_pos;
524 for (size_t i = 0; i != size_t(first.first); ++i)
525 d->scrollbarParameters_.min -= d->par_height_[i];
526 d->scrollbarParameters_.max = bottom_pos;
527 for (size_t i = last.first + 1; i != parsize; ++i)
528 d->scrollbarParameters_.max += d->par_height_[i];
530 d->scrollbarParameters_.position = 0;
531 // The reference is the top position so we remove one page.
532 if (lyxrc.scroll_below_document)
533 d->scrollbarParameters_.max -= minVisiblePart();
535 d->scrollbarParameters_.max -= d->scrollbarParameters_.page_step;
539 ScrollbarParameters const & BufferView::scrollbarParameters() const
541 return d->scrollbarParameters_;
545 docstring BufferView::toolTip(int x, int y) const
547 // Get inset under mouse, if there is one.
548 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
550 // No inset, no tooltip...
552 return covering_inset->toolTip(*this, x, y);
556 docstring BufferView::contextMenu(int x, int y) const
558 //If there is a selection, return the containing inset menu
559 if (d->cursor_.selection())
560 return d->cursor_.inset().contextMenu(*this, x, y);
562 // Get inset under mouse, if there is one.
563 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
565 return covering_inset->contextMenu(*this, x, y);
567 return buffer_.inset().contextMenu(*this, x, y);
571 void BufferView::scrollDocView(int value)
573 int const offset = value - d->scrollbarParameters_.position;
575 // No scrolling at all? No need to redraw anything
579 // If the offset is less than 2 screen height, prefer to scroll instead.
580 if (abs(offset) <= 2 * height_) {
581 d->anchor_ypos_ -= offset;
582 buffer_.changed(true);
583 updateHoveredInset();
587 // cut off at the top
588 if (value <= d->scrollbarParameters_.min) {
589 DocIterator dit = doc_iterator_begin(&buffer_);
591 LYXERR(Debug::SCROLLING, "scroll to top");
595 // cut off at the bottom
596 if (value >= d->scrollbarParameters_.max) {
597 DocIterator dit = doc_iterator_end(&buffer_);
600 LYXERR(Debug::SCROLLING, "scroll to bottom");
604 // find paragraph at target position
605 int par_pos = d->scrollbarParameters_.min;
607 for (; i != int(d->par_height_.size()); ++i) {
608 par_pos += d->par_height_[i];
609 if (par_pos >= value)
613 if (par_pos < value) {
614 // It seems we didn't find the correct pit so stay on the safe side and
616 LYXERR0("scrolling position not found!");
617 scrollDocView(d->scrollbarParameters_.max);
621 DocIterator dit = doc_iterator_begin(&buffer_);
623 LYXERR(Debug::SCROLLING, "value = " << value << " -> scroll to pit " << i);
628 // FIXME: this method is not working well.
629 void BufferView::setCursorFromScrollbar()
631 TextMetrics & tm = d->text_metrics_[&buffer_.text()];
633 int const height = 2 * defaultRowHeight();
634 int const first = height;
635 int const last = height_ - height;
637 Cursor const & oldcur = d->cursor_;
639 switch (cursorStatus(oldcur)) {
647 int const y = getPos(oldcur).y_;
648 newy = min(last, max(y, first));
652 // We reset the cursor because cursorStatus() does not
653 // work when the cursor is within mathed.
656 tm.setCursorFromCoordinates(cur, 0, newy);
658 // update the bufferview cursor and notify insets
659 // FIXME: Care about the d->cursor_ flags to redraw if needed
660 Cursor old = d->cursor_;
662 bool badcursor = notifyCursorLeavesOrEnters(old, d->cursor_);
664 d->cursor_.fixIfBroken();
668 Change const BufferView::getCurrentChange() const
670 if (!d->cursor_.selection())
671 return Change(Change::UNCHANGED);
673 DocIterator dit = d->cursor_.selectionBegin();
674 return dit.paragraph().lookupChange(dit.pos());
678 // this could be used elsewhere as well?
679 // FIXME: This does not work within mathed!
680 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
682 Point const p = getPos(dit);
685 if (p.y_ > workHeight())
691 void BufferView::bookmarkEditPosition()
693 // Don't eat cpu time for each keystroke
694 if (d->cursor_.paragraph().id() == d->bookmark_edit_position_)
697 d->bookmark_edit_position_ = d->cursor_.paragraph().id();
701 void BufferView::saveBookmark(unsigned int idx)
703 // tentatively save bookmark, id and pos will be used to
704 // acturately locate a bookmark in a 'live' lyx session.
705 // pit and pos will be updated with bottom level pit/pos
707 if (!buffer_.isInternal()) {
708 theSession().bookmarks().save(
710 d->cursor_.bottom().pit(),
711 d->cursor_.bottom().pos(),
712 d->cursor_.paragraph().id(),
717 // emit message signal.
718 message(_("Save bookmark"));
723 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
724 int top_id, pos_type top_pos)
726 bool success = false;
729 d->cursor_.clearSelection();
731 // if a valid par_id is given, try it first
732 // This is the case for a 'live' bookmark when unique paragraph ID
733 // is used to track bookmarks.
735 dit = buffer_.getParFromID(top_id);
737 dit.pos() = min(dit.paragraph().size(), top_pos);
738 // Some slices of the iterator may not be
739 // reachable (e.g. closed collapsable inset)
740 // so the dociterator may need to be
741 // shortened. Otherwise, setCursor may crash
742 // lyx when the cursor can not be set to these
744 size_t const n = dit.depth();
745 for (size_t i = 0; i < n; ++i)
746 if (!dit[i].inset().editable()) {
754 // if top_id == 0, or searching through top_id failed
755 // This is the case for a 'restored' bookmark when only bottom
756 // (document level) pit was saved. Because of this, bookmark
757 // restoration is inaccurate. If a bookmark was within an inset,
758 // it will be restored to the left of the outmost inset that contains
760 if (bottom_pit < int(buffer_.paragraphs().size())) {
761 dit = doc_iterator_begin(&buffer_);
763 dit.pit() = bottom_pit;
764 dit.pos() = min(bottom_pos, dit.paragraph().size());
769 // Note: only bottom (document) level pit is set.
771 // set the current font.
772 d->cursor_.setCurrentFont();
773 // To center the screen on this new position we need the
774 // paragraph position which is computed at draw() time.
775 // So we need a redraw!
776 buffer_.changed(false);
785 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
787 if (lyxrc.rtl_support) {
788 if (d->cursor_.real_current_font.isRightToLeft()) {
789 if (d->intl_.keymap == Intl::PRIMARY)
790 d->intl_.keyMapSec();
792 if (d->intl_.keymap == Intl::SECONDARY)
793 d->intl_.keyMapPrim();
797 d->intl_.getTransManager().translateAndInsert(c, t, cur);
801 int BufferView::workWidth() const
807 void BufferView::recenter()
809 showCursor(d->cursor_, true);
813 void BufferView::showCursor()
815 showCursor(d->cursor_, false);
819 void BufferView::showCursor(DocIterator const & dit, bool recenter)
821 if (scrollToCursor(dit, recenter)) {
822 buffer_.changed(true);
823 updateHoveredInset();
828 void BufferView::scrollToCursor()
830 if (scrollToCursor(d->cursor_, false)) {
831 buffer_.changed(true);
832 updateHoveredInset();
837 bool BufferView::scrollToCursor(DocIterator const & dit, bool recenter)
839 // We are not properly started yet, delay until resizing is
844 LYXERR(Debug::SCROLLING, "recentering!");
846 CursorSlice const & bot = dit.bottom();
847 TextMetrics & tm = d->text_metrics_[bot.text()];
849 pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
850 int bot_pit = bot.pit();
851 if (bot_pit > max_pit) {
852 // FIXME: Why does this happen?
853 LYXERR0("bottom pit is greater that max pit: "
854 << bot_pit << " > " << max_pit);
858 if (bot_pit == tm.first().first - 1)
859 tm.newParMetricsUp();
860 else if (bot_pit == tm.last().first + 1)
861 tm.newParMetricsDown();
863 if (tm.contains(bot_pit)) {
864 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
865 LASSERT(!pm.rows().empty(), /**/);
866 // FIXME: smooth scrolling doesn't work in mathed.
867 CursorSlice const & cs = dit.innerTextSlice();
868 int offset = coordOffset(dit).y_;
869 int ypos = pm.position() + offset;
870 Dimension const & row_dim =
871 pm.getRow(cs.pos(), dit.boundary()).dimension();
874 scrolled = scroll(ypos - height_/2);
876 // If the top part of the row falls of the screen, we scroll
877 // up to align the top of the row with the top of the screen.
878 else if (ypos - row_dim.ascent() < 0)
879 scrolled = scrollUp(-ypos + row_dim.ascent());
881 // If the bottom of the row falls of the screen, we scroll down.
882 // However, we have to be careful not to scroll that much that
883 // the top falls of the screen.
884 else if (ypos + row_dim.descent() > height_) {
885 int ynew = height_ - row_dim.descent();
886 if (ynew < row_dim.ascent())
887 ynew = row_dim.ascent();
888 int const scroll = ypos - ynew;
889 scrolled = scrollDown(scroll);
892 // else, nothing to do, the cursor is already visible so we just return.
893 return scrolled != 0;
896 // fix inline completion position
897 if (d->inlineCompletionPos_.fixIfBroken())
898 d->inlineCompletionPos_ = DocIterator();
900 tm.redoParagraph(bot_pit);
901 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
902 int offset = coordOffset(dit).y_;
904 d->anchor_pit_ = bot_pit;
905 CursorSlice const & cs = dit.innerTextSlice();
906 Dimension const & row_dim =
907 pm.getRow(cs.pos(), dit.boundary()).dimension();
910 d->anchor_ypos_ = height_/2;
911 else if (d->anchor_pit_ == 0)
912 d->anchor_ypos_ = offset + pm.ascent();
913 else if (d->anchor_pit_ == max_pit)
914 d->anchor_ypos_ = height_ - offset - row_dim.descent();
915 else if (offset > height_)
916 d->anchor_ypos_ = height_ - offset - defaultRowHeight();
918 d->anchor_ypos_ = defaultRowHeight() * 2;
924 void BufferView::updateDocumentClass(DocumentClass const * const olddc)
926 message(_("Converting document to new document class..."));
928 StableDocIterator backcur(d->cursor_);
929 ErrorList & el = buffer_.errorList("Class Switch");
930 cap::switchBetweenClasses(
931 olddc, buffer_.params().documentClassPtr(),
932 static_cast<InsetText &>(buffer_.inset()), el);
934 setCursor(backcur.asDocIterator(&buffer_));
936 buffer_.errors("Class Switch");
937 buffer_.updateBuffer();
940 /** Return the change status at cursor position, taking in account the
941 * status at each level of the document iterator (a table in a deleted
942 * footnote is deleted).
943 * When \param outer is true, the top slice is not looked at.
945 static Change::Type lookupChangeType(DocIterator const & dit, bool outer = false)
947 size_t const depth = dit.depth() - (outer ? 1 : 0);
949 for (size_t i = 0 ; i < depth ; ++i) {
950 CursorSlice const & slice = dit[i];
951 if (!slice.inset().inMathed()
952 && slice.pos() < slice.paragraph().size()) {
953 Change::Type const ch = slice.paragraph().lookupChange(slice.pos()).type;
954 if (ch != Change::UNCHANGED)
958 return Change::UNCHANGED;
962 bool BufferView::getStatus(FuncRequest const & cmd, FuncStatus & flag)
964 FuncCode const act = cmd.action();
966 // Can we use a readonly buffer?
967 if (buffer_.isReadonly()
968 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
969 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
970 flag.message(from_utf8(N_("Document is read-only")));
971 flag.setEnabled(false);
975 // Are we in a DELETED change-tracking region?
976 if (lookupChangeType(d->cursor_, true) == Change::DELETED
977 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
978 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
979 flag.message(from_utf8(N_("This portion of the document is deleted.")));
980 flag.setEnabled(false);
984 Cursor & cur = d->cursor_;
986 if (cur.getStatus(cmd, flag))
991 // FIXME: This is a bit problematic because we don't check if this is
992 // a document BufferView or not for these LFUNs. We probably have to
993 // dispatch both to currentBufferView() and, if that fails,
994 // to documentBufferView(); same as we do know for current Buffer and
995 // document Buffer. Ideally those LFUN should go to Buffer as they*
996 // operate on the full Buffer and the cursor is only needed either for
997 // an Undo record or to restore a cursor position. But we don't know
998 // how to do that inside Buffer of course.
999 case LFUN_BUFFER_PARAMS_APPLY:
1000 case LFUN_LAYOUT_MODULES_CLEAR:
1001 case LFUN_LAYOUT_MODULE_ADD:
1002 case LFUN_LAYOUT_RELOAD:
1003 case LFUN_TEXTCLASS_APPLY:
1004 case LFUN_TEXTCLASS_LOAD:
1005 flag.setEnabled(!buffer_.isReadonly());
1009 flag.setEnabled(buffer_.undo().hasUndoStack());
1012 flag.setEnabled(buffer_.undo().hasRedoStack());
1014 case LFUN_FILE_INSERT:
1015 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
1016 case LFUN_FILE_INSERT_PLAINTEXT:
1017 case LFUN_BOOKMARK_SAVE:
1018 // FIXME: Actually, these LFUNS should be moved to Text
1019 flag.setEnabled(cur.inTexted());
1022 case LFUN_FONT_STATE:
1023 case LFUN_LABEL_INSERT:
1024 case LFUN_INFO_INSERT:
1025 case LFUN_PARAGRAPH_GOTO:
1026 case LFUN_NOTE_NEXT:
1027 case LFUN_REFERENCE_NEXT:
1028 case LFUN_WORD_FIND:
1029 case LFUN_WORD_FIND_FORWARD:
1030 case LFUN_WORD_FIND_BACKWARD:
1031 case LFUN_WORD_FINDADV:
1032 case LFUN_WORD_REPLACE:
1035 case LFUN_MARK_TOGGLE:
1036 case LFUN_SCREEN_RECENTER:
1037 case LFUN_SCREEN_SHOW_CURSOR:
1038 case LFUN_BIBTEX_DATABASE_ADD:
1039 case LFUN_BIBTEX_DATABASE_DEL:
1040 case LFUN_STATISTICS:
1041 case LFUN_BRANCH_ADD_INSERT:
1042 case LFUN_KEYMAP_OFF:
1043 case LFUN_KEYMAP_PRIMARY:
1044 case LFUN_KEYMAP_SECONDARY:
1045 case LFUN_KEYMAP_TOGGLE:
1046 flag.setEnabled(true);
1049 case LFUN_LABEL_GOTO: {
1050 flag.setEnabled(!cmd.argument().empty()
1051 || getInsetByCode<InsetRef>(cur, REF_CODE));
1055 case LFUN_CHANGES_TRACK:
1056 flag.setEnabled(true);
1057 flag.setOnOff(buffer_.params().trackChanges);
1060 case LFUN_CHANGES_OUTPUT:
1061 flag.setEnabled(true);
1062 flag.setOnOff(buffer_.params().outputChanges);
1065 case LFUN_CHANGES_MERGE:
1066 case LFUN_CHANGE_NEXT:
1067 case LFUN_CHANGE_PREVIOUS:
1068 case LFUN_ALL_CHANGES_ACCEPT:
1069 case LFUN_ALL_CHANGES_REJECT:
1070 // TODO: context-sensitive enabling of LFUNs
1071 // In principle, these command should only be enabled if there
1072 // is a change in the document. However, without proper
1073 // optimizations, this will inevitably result in poor performance.
1074 flag.setEnabled(true);
1077 case LFUN_BUFFER_TOGGLE_COMPRESSION: {
1078 flag.setOnOff(buffer_.params().compressed);
1082 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC: {
1083 flag.setOnOff(buffer_.params().output_sync);
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());
1129 if (!inset->getStatus(cur, fr, flag)) {
1130 // Every inset is supposed to handle this
1131 LASSERT(false, break);
1134 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1135 flag = lyx::getStatus(fr);
1148 Inset * BufferView::editedInset(string const & name) const
1150 map<string, Inset *>::const_iterator it = d->edited_insets_.find(name);
1151 return it == d->edited_insets_.end() ? 0 : it->second;
1155 void BufferView::editInset(string const & name, Inset * inset)
1157 d->edited_insets_[name] = inset;
1161 void BufferView::dispatch(FuncRequest const & cmd, DispatchResult & dr)
1163 //lyxerr << [ cmd = " << cmd << "]" << endl;
1165 // Make sure that the cached BufferView is correct.
1166 LYXERR(Debug::ACTION, " action[" << cmd.action() << ']'
1167 << " arg[" << to_utf8(cmd.argument()) << ']'
1168 << " x[" << cmd.x() << ']'
1169 << " y[" << cmd.y() << ']'
1170 << " button[" << cmd.button() << ']');
1172 string const argument = to_utf8(cmd.argument());
1173 Cursor & cur = d->cursor_;
1175 // Don't dispatch function that does not apply to internal buffers.
1176 if (buffer_.isInternal()
1177 && lyxaction.funcHasFlag(cmd.action(), LyXAction::NoInternal))
1180 // We'll set this back to false if need be.
1181 bool dispatched = true;
1182 buffer_.undo().beginUndoGroup();
1184 FuncCode const act = cmd.action();
1187 case LFUN_BUFFER_PARAMS_APPLY: {
1188 DocumentClass const * const oldClass = buffer_.params().documentClassPtr();
1189 cur.recordUndoFullDocument();
1190 istringstream ss(to_utf8(cmd.argument()));
1193 int const unknown_tokens = buffer_.readHeader(lex);
1194 if (unknown_tokens != 0) {
1195 LYXERR0("Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1196 << unknown_tokens << " unknown token"
1197 << (unknown_tokens == 1 ? "" : "s"));
1199 updateDocumentClass(oldClass);
1201 // We are most certainly here because of a change in the document
1202 // It is then better to make sure that all dialogs are in sync with
1203 // current document settings.
1204 dr.update(Update::Force | Update::FitCursor);
1208 case LFUN_LAYOUT_MODULES_CLEAR: {
1209 DocumentClass const * const oldClass =
1210 buffer_.params().documentClassPtr();
1211 cur.recordUndoFullDocument();
1212 buffer_.params().clearLayoutModules();
1213 buffer_.params().makeDocumentClass();
1214 updateDocumentClass(oldClass);
1215 dr.update(Update::Force | Update::FitCursor);
1219 case LFUN_LAYOUT_MODULE_ADD: {
1220 BufferParams const & params = buffer_.params();
1221 if (!params.moduleCanBeAdded(argument)) {
1222 LYXERR0("Module `" << argument <<
1223 "' cannot be added due to failed requirements or "
1224 "conflicts with installed modules.");
1227 DocumentClass const * const oldClass = params.documentClassPtr();
1228 cur.recordUndoFullDocument();
1229 buffer_.params().addLayoutModule(argument);
1230 buffer_.params().makeDocumentClass();
1231 updateDocumentClass(oldClass);
1232 dr.update(Update::Force | Update::FitCursor);
1236 case LFUN_TEXTCLASS_APPLY: {
1237 if (!LayoutFileList::get().load(argument, buffer_.temppath()) &&
1238 !LayoutFileList::get().load(argument, buffer_.filePath()))
1241 LayoutFile const * old_layout = buffer_.params().baseClass();
1242 LayoutFile const * new_layout = &(LayoutFileList::get()[argument]);
1244 if (old_layout == new_layout)
1248 //Save the old, possibly modular, layout for use in conversion.
1249 DocumentClass const * const oldDocClass =
1250 buffer_.params().documentClassPtr();
1251 cur.recordUndoFullDocument();
1252 buffer_.params().setBaseClass(argument);
1253 buffer_.params().makeDocumentClass();
1254 updateDocumentClass(oldDocClass);
1255 dr.update(Update::Force | Update::FitCursor);
1259 case LFUN_TEXTCLASS_LOAD:
1260 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1261 LayoutFileList::get().load(argument, buffer_.filePath());
1264 case LFUN_LAYOUT_RELOAD: {
1265 DocumentClass const * const oldClass = buffer_.params().documentClassPtr();
1266 LayoutFileIndex bc = buffer_.params().baseClassID();
1267 LayoutFileList::get().reset(bc);
1268 buffer_.params().setBaseClass(bc);
1269 buffer_.params().makeDocumentClass();
1270 updateDocumentClass(oldClass);
1271 dr.update(Update::Force | Update::FitCursor);
1276 dr.setMessage(_("Undo"));
1277 cur.clearSelection();
1278 if (!cur.textUndo())
1279 dr.setMessage(_("No further undo information"));
1281 dr.update(Update::Force | Update::FitCursor);
1285 dr.setMessage(_("Redo"));
1286 cur.clearSelection();
1287 if (!cur.textRedo())
1288 dr.setMessage(_("No further redo information"));
1290 dr.update(Update::Force | Update::FitCursor);
1293 case LFUN_FONT_STATE:
1294 dr.setMessage(cur.currentState());
1297 case LFUN_BOOKMARK_SAVE:
1298 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1301 case LFUN_LABEL_GOTO: {
1302 docstring label = cmd.argument();
1303 if (label.empty()) {
1305 getInsetByCode<InsetRef>(cur, REF_CODE);
1307 label = inset->getParam("reference");
1308 // persistent=false: use temp_bookmark
1317 case LFUN_PARAGRAPH_GOTO: {
1318 int const id = convert<int>(cmd.getArg(0));
1319 int const pos = convert<int>(cmd.getArg(1));
1321 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1322 b = theBufferList().next(b)) {
1324 DocIterator dit = b->getParFromID(id);
1326 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1330 LYXERR(Debug::INFO, "Paragraph " << dit.paragraph().id()
1331 << " found in buffer `"
1332 << b->absFileName() << "'.");
1334 if (b == &buffer_) {
1338 dr.update(Update::Force | Update::FitCursor);
1340 // Switch to other buffer view and resend cmd
1341 lyx::dispatch(FuncRequest(
1342 LFUN_BUFFER_SWITCH, b->absFileName()));
1350 case LFUN_NOTE_NEXT:
1351 gotoInset(this, NOTE_CODE, false);
1354 case LFUN_REFERENCE_NEXT: {
1355 vector<InsetCode> tmp;
1356 tmp.push_back(LABEL_CODE);
1357 tmp.push_back(REF_CODE);
1358 gotoInset(this, tmp, true);
1362 case LFUN_CHANGES_TRACK:
1363 buffer_.params().trackChanges = !buffer_.params().trackChanges;
1366 case LFUN_CHANGES_OUTPUT:
1367 buffer_.params().outputChanges = !buffer_.params().outputChanges;
1368 if (buffer_.params().outputChanges) {
1369 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1370 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1371 LaTeXFeatures::isAvailable("xcolor");
1373 if (!dvipost && !xcolorulem) {
1374 Alert::warning(_("Changes not shown in LaTeX output"),
1375 _("Changes will not be highlighted in LaTeX output, "
1376 "because neither dvipost nor xcolor/ulem are installed.\n"
1377 "Please install these packages or redefine "
1378 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1379 } else if (!xcolorulem) {
1380 Alert::warning(_("Changes not shown in LaTeX output"),
1381 _("Changes will not be highlighted in LaTeX output "
1382 "when using pdflatex, because xcolor and ulem are not installed.\n"
1383 "Please install both packages or redefine "
1384 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1389 case LFUN_CHANGE_NEXT:
1390 findNextChange(this);
1391 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1392 dr.update(Update::Force | Update::FitCursor);
1395 case LFUN_CHANGE_PREVIOUS:
1396 findPreviousChange(this);
1397 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1398 dr.update(Update::Force | Update::FitCursor);
1401 case LFUN_CHANGES_MERGE:
1402 if (findNextChange(this) || findPreviousChange(this)) {
1403 dr.update(Update::Force | Update::FitCursor);
1404 showDialog("changes");
1408 case LFUN_ALL_CHANGES_ACCEPT:
1409 // select complete document
1411 cur.selHandle(true);
1412 buffer_.text().cursorBottom(cur);
1413 // accept everything in a single step to support atomic undo
1414 buffer_.text().acceptOrRejectChanges(cur, Text::ACCEPT);
1415 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1416 dr.update(Update::Force | Update::FitCursor);
1419 case LFUN_ALL_CHANGES_REJECT:
1420 // select complete document
1422 cur.selHandle(true);
1423 buffer_.text().cursorBottom(cur);
1424 // reject everything in a single step to support atomic undo
1425 // Note: reject does not work recursively; the user may have to repeat the operation
1426 buffer_.text().acceptOrRejectChanges(cur, Text::REJECT);
1427 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1428 dr.update(Update::Force | Update::FitCursor);
1431 case LFUN_WORD_FIND_FORWARD:
1432 case LFUN_WORD_FIND_BACKWARD: {
1433 static docstring last_search;
1434 docstring searched_string;
1436 if (!cmd.argument().empty()) {
1437 last_search = cmd.argument();
1438 searched_string = cmd.argument();
1440 searched_string = last_search;
1443 if (searched_string.empty())
1446 bool const fw = act == LFUN_WORD_FIND_FORWARD;
1447 docstring const data =
1448 find2string(searched_string, true, false, fw);
1449 find(this, FuncRequest(LFUN_WORD_FIND, data));
1453 case LFUN_WORD_FIND: {
1454 FuncRequest req = cmd;
1455 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1456 req = d->search_request_cache_;
1457 if (req.argument().empty()) {
1458 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, "findreplace"));
1461 if (find(this, req))
1464 message(_("String not found!"));
1465 d->search_request_cache_ = req;
1469 case LFUN_WORD_REPLACE: {
1470 bool has_deleted = false;
1471 if (cur.selection()) {
1472 DocIterator beg = cur.selectionBegin();
1473 DocIterator end = cur.selectionEnd();
1474 if (beg.pit() == end.pit()) {
1475 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1477 && cur.paragraph().isDeleted(p))
1482 replace(this, cmd, has_deleted);
1486 case LFUN_WORD_FINDADV: {
1487 FindAndReplaceOptions opt;
1488 istringstream iss(to_utf8(cmd.argument()));
1490 if (findAdv(this, opt))
1498 cur.clearSelection();
1499 dr.setMessage(from_utf8(N_("Mark off")));
1503 cur.clearSelection();
1505 dr.setMessage(from_utf8(N_("Mark on")));
1508 case LFUN_MARK_TOGGLE:
1509 cur.setSelection(false);
1512 dr.setMessage(from_utf8(N_("Mark removed")));
1515 dr.setMessage(from_utf8(N_("Mark set")));
1520 case LFUN_SCREEN_SHOW_CURSOR:
1524 case LFUN_SCREEN_RECENTER:
1528 case LFUN_BIBTEX_DATABASE_ADD: {
1529 Cursor tmpcur = cur;
1530 findInset(tmpcur, BIBTEX_CODE, false);
1531 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1534 if (inset->addDatabase(cmd.argument()))
1535 buffer_.updateBibfilesCache();
1540 case LFUN_BIBTEX_DATABASE_DEL: {
1541 Cursor tmpcur = cur;
1542 findInset(tmpcur, BIBTEX_CODE, false);
1543 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1546 if (inset->delDatabase(cmd.argument()))
1547 buffer_.updateBibfilesCache();
1552 case LFUN_STATISTICS: {
1553 DocIterator from, to;
1554 if (cur.selection()) {
1555 from = cur.selectionBegin();
1556 to = cur.selectionEnd();
1558 from = doc_iterator_begin(&buffer_);
1559 to = doc_iterator_end(&buffer_);
1561 int const words = countWords(from, to);
1562 int const chars = countChars(from, to, false);
1563 int const chars_blanks = countChars(from, to, true);
1565 if (cur.selection())
1566 message = _("Statistics for the selection:");
1568 message = _("Statistics for the document:");
1571 message += bformat(_("%1$d words"), words);
1573 message += _("One word");
1575 if (chars_blanks != 1)
1576 message += bformat(_("%1$d characters (including blanks)"),
1579 message += _("One character (including blanks)");
1582 message += bformat(_("%1$d characters (excluding blanks)"),
1585 message += _("One character (excluding blanks)");
1587 Alert::information(_("Statistics"), message);
1591 case LFUN_BUFFER_TOGGLE_COMPRESSION:
1592 // turn compression on/off
1593 buffer_.params().compressed = !buffer_.params().compressed;
1596 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
1597 buffer_.params().output_sync = !buffer_.params().output_sync;
1600 case LFUN_SCREEN_UP:
1601 case LFUN_SCREEN_DOWN: {
1602 Point p = getPos(cur);
1603 // This code has been commented out to enable to scroll down a
1604 // document, even if there are large insets in it (see bug #5465).
1605 /*if (p.y_ < 0 || p.y_ > height_) {
1606 // The cursor is off-screen so recenter before proceeding.
1610 int const scrolled = scroll(act == LFUN_SCREEN_UP
1611 ? -height_ : height_);
1612 if (act == LFUN_SCREEN_UP && scrolled > -height_)
1614 if (act == LFUN_SCREEN_DOWN && scrolled < height_)
1615 p = Point(width_, height_);
1617 bool const in_texted = cur.inTexted();
1619 buffer_.changed(true);
1620 updateHoveredInset();
1622 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_,
1623 true, act == LFUN_SCREEN_UP);
1624 //FIXME: what to do with cur.x_target()?
1625 bool update = in_texted && cur.bv().checkDepm(cur, old);
1628 dr.update(Update::Force | Update::FitCursor);
1636 case LFUN_SCREEN_UP_SELECT: {
1637 cur.selHandle(true);
1638 if (isTopScreen()) {
1639 lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1643 int y = getPos(cur).y_;
1644 int const ymin = y - height_ + defaultRowHeight();
1645 while (y > ymin && cur.up())
1649 dr.update(Update::SinglePar | Update::FitCursor);
1653 case LFUN_SCREEN_DOWN_SELECT: {
1654 cur.selHandle(true);
1655 if (isBottomScreen()) {
1656 lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1660 int y = getPos(cur).y_;
1661 int const ymax = y + height_ - defaultRowHeight();
1662 while (y < ymax && cur.down())
1666 dr.update(Update::SinglePar | Update::FitCursor);
1671 // This would be in Buffer class if only Cursor did not
1672 // require a bufferview
1673 case LFUN_INSET_FORALL: {
1674 docstring const name = from_utf8(cmd.getArg(0));
1675 string const commandstr = cmd.getLongArg(1);
1676 FuncRequest const fr = lyxaction.lookupFunc(commandstr);
1678 // an arbitrary number to limit number of iterations
1679 const int max_iter = 10000;
1681 Cursor & cur = d->cursor_;
1682 Cursor const savecur = cur;
1684 if (!cur.nextInset())
1686 cur.beginUndoGroup();
1687 while(cur && iterations < max_iter) {
1688 Inset * ins = cur.nextInset();
1691 docstring insname = ins->name();
1692 while (!insname.empty()) {
1693 if (insname == name || name == from_utf8("*")) {
1695 lyx::dispatch(fr, dr);
1699 size_t const i = insname.rfind(':');
1700 if (i == string::npos)
1702 insname = insname.substr(0, i);
1709 dr.update(Update::Force);
1711 if (iterations >= max_iter) {
1713 dr.setMessage(bformat(_("`inset-forall' interrupted because number of actions is larger than %1$d"), max_iter));
1715 dr.setMessage(bformat(_("Applied \"%1$s\" to %2$d insets"), from_utf8(commandstr), iterations));
1720 case LFUN_BRANCH_ADD_INSERT: {
1721 docstring branch_name = from_utf8(cmd.getArg(0));
1722 if (branch_name.empty())
1723 if (!Alert::askForText(branch_name, _("Branch name")) ||
1724 branch_name.empty())
1727 DispatchResult drtmp;
1728 buffer_.dispatch(FuncRequest(LFUN_BRANCH_ADD, branch_name), drtmp);
1729 if (drtmp.error()) {
1730 Alert::warning(_("Branch already exists"), drtmp.message());
1733 lyx::dispatch(FuncRequest(LFUN_BRANCH_INSERT, branch_name));
1737 case LFUN_KEYMAP_OFF:
1738 getIntl().keyMapOn(false);
1741 case LFUN_KEYMAP_PRIMARY:
1742 getIntl().keyMapPrim();
1745 case LFUN_KEYMAP_SECONDARY:
1746 getIntl().keyMapSec();
1749 case LFUN_KEYMAP_TOGGLE:
1750 getIntl().toggleKeyMap();
1753 case LFUN_DIALOG_SHOW_NEW_INSET: {
1754 string const name = cmd.getArg(0);
1755 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
1756 if (decodeInsetParam(name, data, buffer_))
1757 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
1759 lyxerr << "Inset type '" << name <<
1760 "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" << endl;
1764 case LFUN_CITATION_INSERT: {
1765 if (argument.empty()) {
1766 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
1769 // we can have one optional argument, delimited by '|'
1770 // citation-insert <key>|<text_before>
1771 // this should be enhanced to also support text_after
1772 // and citation style
1773 string arg = argument;
1775 if (contains(argument, "|")) {
1776 arg = token(argument, '|', 0);
1777 opt1 = token(argument, '|', 1);
1779 InsetCommandParams icp(CITE_CODE);
1780 icp["key"] = from_utf8(arg);
1782 icp["before"] = from_utf8(opt1);
1783 string icstr = InsetCommand::params2string("citation", icp);
1784 FuncRequest fr(LFUN_INSET_INSERT, icstr);
1789 case LFUN_INSET_APPLY: {
1790 string const name = cmd.getArg(0);
1791 Inset * inset = editedInset(name);
1793 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1797 // put cursor in front of inset.
1798 if (!setCursorFromInset(inset)) {
1799 LASSERT(false, break);
1802 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1803 inset->dispatch(cur, fr);
1804 dr.update(Update::SinglePar | Update::FitCursor);
1813 buffer_.undo().endUndoGroup();
1814 dr.dispatched(dispatched);
1819 docstring const BufferView::requestSelection()
1821 Cursor & cur = d->cursor_;
1823 LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
1824 if (!cur.selection()) {
1825 d->xsel_cache_.set = false;
1829 LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
1830 if (!d->xsel_cache_.set ||
1831 cur.top() != d->xsel_cache_.cursor ||
1832 cur.realAnchor().top() != d->xsel_cache_.anchor)
1834 d->xsel_cache_.cursor = cur.top();
1835 d->xsel_cache_.anchor = cur.realAnchor().top();
1836 d->xsel_cache_.set = cur.selection();
1837 return cur.selectionAsString(false);
1843 void BufferView::clearSelection()
1845 d->cursor_.clearSelection();
1846 // Clear the selection buffer. Otherwise a subsequent
1847 // middle-mouse-button paste would use the selection buffer,
1848 // not the more current external selection.
1849 cap::clearSelection();
1850 d->xsel_cache_.set = false;
1851 // The buffer did not really change, but this causes the
1852 // redraw we need because we cleared the selection above.
1853 buffer_.changed(false);
1857 void BufferView::resize(int width, int height)
1859 // Update from work area
1863 // Clear the paragraph height cache.
1864 d->par_height_.clear();
1865 // Redo the metrics.
1870 Inset const * BufferView::getCoveringInset(Text const & text,
1873 TextMetrics & tm = d->text_metrics_[&text];
1874 Inset * inset = tm.checkInsetHit(x, y);
1878 if (!inset->descendable(*this))
1879 // No need to go further down if the inset is not
1883 size_t cell_number = inset->nargs();
1884 // Check all the inner cell.
1885 for (size_t i = 0; i != cell_number; ++i) {
1886 Text const * inner_text = inset->getText(i);
1889 Inset const * inset_deeper =
1890 getCoveringInset(*inner_text, x, y);
1892 return inset_deeper;
1900 void BufferView::updateHoveredInset() const
1902 // Get inset under mouse, if there is one.
1903 Inset const * covering_inset = getCoveringInset(buffer_.text(),
1904 d->mouse_position_cache_.x_, d->mouse_position_cache_.y_);
1905 if (covering_inset == d->last_inset_)
1906 // Same inset, no need to do anything...
1909 bool need_redraw = false;
1910 if (d->last_inset_) {
1911 // Remove the hint on the last hovered inset (if any).
1912 need_redraw |= d->last_inset_->setMouseHover(this, false);
1916 // const_cast because of setMouseHover().
1917 Inset * inset = const_cast<Inset *>(covering_inset);
1918 if (inset && inset->setMouseHover(this, true)) {
1920 // Only the insets that accept the hover state, do
1921 // clear the last_inset_, so only set the last_inset_
1922 // member if the hovered setting is accepted.
1923 d->last_inset_ = inset;
1927 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
1928 << d->mouse_position_cache_.x_ << ", "
1929 << d->mouse_position_cache_.y_ << ")");
1931 d->update_strategy_ = DecorationUpdate;
1933 // This event (moving without mouse click) is not passed further.
1934 // This should be changed if it is further utilized.
1935 buffer_.changed(false);
1940 void BufferView::clearLastInset(Inset * inset) const
1942 if (d->last_inset_ != inset) {
1943 LYXERR0("Wrong last_inset!");
1944 LASSERT(false, /**/);
1950 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
1952 //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
1954 // This is only called for mouse related events including
1955 // LFUN_FILE_OPEN generated by drag-and-drop.
1956 FuncRequest cmd = cmd0;
1958 Cursor old = cursor();
1960 cur.push(buffer_.inset());
1961 cur.setSelection(d->cursor_.selection());
1963 // Either the inset under the cursor or the
1964 // surrounding Text will handle this event.
1966 // make sure we stay within the screen...
1967 cmd.set_y(min(max(cmd.y(), -1), height_));
1969 d->mouse_position_cache_.x_ = cmd.x();
1970 d->mouse_position_cache_.y_ = cmd.y();
1972 if (cmd.action() == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
1973 updateHoveredInset();
1977 // Build temporary cursor.
1978 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x(), cmd.y());
1980 // Put anchor at the same position.
1983 cur.beginUndoGroup();
1985 // Try to dispatch to an non-editable inset near this position
1986 // via the temp cursor. If the inset wishes to change the real
1987 // cursor it has to do so explicitly by using
1988 // cur.bv().cursor() = cur; (or similar)
1990 inset->dispatch(cur, cmd);
1992 // Now dispatch to the temporary cursor. If the real cursor should
1993 // be modified, the inset's dispatch has to do so explicitly.
1994 if (!inset || !cur.result().dispatched())
1999 // Notify left insets
2002 bool badcursor = notifyCursorLeavesOrEnters(old, cur);
2004 cursor().fixIfBroken();
2007 // Do we have a selection?
2008 theSelection().haveSelection(cursor().selection());
2010 // If the command has been dispatched,
2011 if (cur.result().dispatched() || cur.result().update())
2012 processUpdateFlags(cur.result().update());
2016 void BufferView::lfunScroll(FuncRequest const & cmd)
2018 string const scroll_type = cmd.getArg(0);
2019 int scroll_step = 0;
2020 if (scroll_type == "line")
2021 scroll_step = d->scrollbarParameters_.single_step;
2022 else if (scroll_type == "page")
2023 scroll_step = d->scrollbarParameters_.page_step;
2026 string const scroll_quantity = cmd.getArg(1);
2027 if (scroll_quantity == "up")
2028 scrollUp(scroll_step);
2029 else if (scroll_quantity == "down")
2030 scrollDown(scroll_step);
2032 int const scroll_value = convert<int>(scroll_quantity);
2034 scroll(scroll_step * scroll_value);
2036 buffer_.changed(true);
2037 updateHoveredInset();
2041 int BufferView::minVisiblePart()
2043 return 2 * defaultRowHeight();
2047 int BufferView::scroll(int y)
2050 return scrollDown(y);
2052 return scrollUp(-y);
2057 int BufferView::scrollDown(int offset)
2059 Text * text = &buffer_.text();
2060 TextMetrics & tm = d->text_metrics_[text];
2061 int const ymax = height_ + offset;
2063 pair<pit_type, ParagraphMetrics const *> last = tm.last();
2064 int bottom_pos = last.second->position() + last.second->descent();
2065 if (lyxrc.scroll_below_document)
2066 bottom_pos += height_ - minVisiblePart();
2067 if (last.first + 1 == int(text->paragraphs().size())) {
2068 if (bottom_pos <= height_)
2070 offset = min(offset, bottom_pos - height_);
2073 if (bottom_pos > ymax)
2075 tm.newParMetricsDown();
2077 d->anchor_ypos_ -= offset;
2082 int BufferView::scrollUp(int offset)
2084 Text * text = &buffer_.text();
2085 TextMetrics & tm = d->text_metrics_[text];
2086 int ymin = - offset;
2088 pair<pit_type, ParagraphMetrics const *> first = tm.first();
2089 int top_pos = first.second->position() - first.second->ascent();
2090 if (first.first == 0) {
2093 offset = min(offset, - top_pos);
2098 tm.newParMetricsUp();
2100 d->anchor_ypos_ += offset;
2105 void BufferView::setCursorFromRow(int row)
2110 buffer_.texrow().getIdFromRow(row, tmpid, tmppos);
2114 buffer_.text().setCursor(d->cursor_, 0, 0);
2116 buffer_.text().setCursor(d->cursor_, buffer_.getParFromID(tmpid).pit(), tmppos);
2121 bool BufferView::setCursorFromInset(Inset const * inset)
2123 // are we already there?
2124 if (cursor().nextInset() == inset)
2127 // Inset is not at cursor position. Find it in the document.
2130 while (cur && cur.nextInset() != inset)
2141 void BufferView::gotoLabel(docstring const & label)
2143 std::vector<Buffer const *> bufs = buffer().allRelatives();
2144 std::vector<Buffer const *>::iterator it = bufs.begin();
2145 for (; it != bufs.end(); ++it) {
2146 Buffer const * buf = *it;
2149 Toc & toc = buf->tocBackend().toc("label");
2150 TocIterator toc_it = toc.begin();
2151 TocIterator end = toc.end();
2152 for (; toc_it != end; ++toc_it) {
2153 if (label == toc_it->str()) {
2154 lyx::dispatch(toc_it->action());
2162 TextMetrics const & BufferView::textMetrics(Text const * t) const
2164 return const_cast<BufferView *>(this)->textMetrics(t);
2168 TextMetrics & BufferView::textMetrics(Text const * t)
2170 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
2171 if (tmc_it == d->text_metrics_.end()) {
2172 tmc_it = d->text_metrics_.insert(
2173 make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
2175 return tmc_it->second;
2179 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
2182 return textMetrics(t).parMetrics(pit);
2186 int BufferView::workHeight() const
2192 void BufferView::setCursor(DocIterator const & dit)
2195 size_t const n = dit.depth();
2196 for (size_t i = 0; i < n; ++i)
2197 dit[i].inset().edit(d->cursor_, true);
2199 d->cursor_.setCursor(dit);
2200 d->cursor_.setSelection(false);
2204 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
2206 // Would be wrong to delete anything if we have a selection.
2207 if (cur.selection())
2210 bool need_anchor_change = false;
2211 bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
2212 need_anchor_change);
2214 if (need_anchor_change)
2222 buffer_.updateBuffer();
2223 buffer_.changed(true);
2228 bool BufferView::mouseSetCursor(Cursor & cur, bool select)
2230 LASSERT(&cur.bv() == this, /**/);
2233 // this event will clear selection so we save selection for
2234 // persistent selection
2235 cap::saveSelection(cursor());
2237 d->cursor_.macroModeClose();
2239 // Has the cursor just left the inset?
2240 bool leftinset = (&d->cursor_.inset() != &cur.inset());
2242 d->cursor_.fixIfBroken();
2244 // FIXME: shift-mouse selection doesn't work well across insets.
2245 bool do_selection = select && &d->cursor_.normalAnchor().inset() == &cur.inset();
2247 // do the dEPM magic if needed
2248 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
2249 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
2250 // the leftinset bool would not be necessary (badcursor instead).
2251 bool update = leftinset;
2252 if (!do_selection && d->cursor_.inTexted())
2253 update |= checkDepm(cur, d->cursor_);
2256 d->cursor_.resetAnchor();
2257 d->cursor_.setCursor(cur);
2258 d->cursor_.boundary(cur.boundary());
2260 d->cursor_.setSelection();
2262 d->cursor_.clearSelection();
2264 d->cursor_.finishUndo();
2265 d->cursor_.setCurrentFont();
2270 void BufferView::putSelectionAt(DocIterator const & cur,
2271 int length, bool backwards)
2273 d->cursor_.clearSelection();
2279 d->cursor_.pos() += length;
2280 d->cursor_.setSelection(d->cursor_, -length);
2282 d->cursor_.setSelection(d->cursor_, length);
2284 // Ensure a redraw happens in any case because the new selection could
2285 // possibly be on the same screen as the previous selection.
2286 processUpdateFlags(Update::Force | Update::FitCursor);
2290 Cursor & BufferView::cursor()
2296 Cursor const & BufferView::cursor() const
2302 pit_type BufferView::anchor_ref() const
2304 return d->anchor_pit_;
2308 bool BufferView::singleParUpdate()
2310 Text & buftext = buffer_.text();
2311 pit_type const bottom_pit = d->cursor_.bottom().pit();
2312 TextMetrics & tm = textMetrics(&buftext);
2313 int old_height = tm.parMetrics(bottom_pit).height();
2315 // make sure inline completion pointer is ok
2316 if (d->inlineCompletionPos_.fixIfBroken())
2317 d->inlineCompletionPos_ = DocIterator();
2319 // In Single Paragraph mode, rebreak only
2320 // the (main text, not inset!) paragraph containing the cursor.
2321 // (if this paragraph contains insets etc., rebreaking will
2322 // recursively descend)
2323 tm.redoParagraph(bottom_pit);
2324 ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
2325 if (pm.height() != old_height)
2326 // Paragraph height has changed so we cannot proceed to
2327 // the singlePar optimisation.
2330 d->update_strategy_ = SingleParUpdate;
2332 LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
2333 << " y2: " << pm.position() + pm.descent()
2334 << " pit: " << bottom_pit
2335 << " singlepar: 1");
2340 void BufferView::updateMetrics()
2342 if (height_ == 0 || width_ == 0)
2345 Text & buftext = buffer_.text();
2346 pit_type const npit = int(buftext.paragraphs().size());
2348 // Clear out the position cache in case of full screen redraw,
2349 d->coord_cache_.clear();
2351 // Clear out paragraph metrics to avoid having invalid metrics
2352 // in the cache from paragraphs not relayouted below
2353 // The complete text metrics will be redone.
2354 d->text_metrics_.clear();
2356 TextMetrics & tm = textMetrics(&buftext);
2358 // make sure inline completion pointer is ok
2359 if (d->inlineCompletionPos_.fixIfBroken())
2360 d->inlineCompletionPos_ = DocIterator();
2362 if (d->anchor_pit_ >= npit)
2363 // The anchor pit must have been deleted...
2364 d->anchor_pit_ = npit - 1;
2366 // Rebreak anchor paragraph.
2367 tm.redoParagraph(d->anchor_pit_);
2368 ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
2371 if (d->anchor_pit_ == 0) {
2372 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
2374 // Complete buffer visible? Then it's easy.
2375 if (scrollRange == 0)
2376 d->anchor_ypos_ = anchor_pm.ascent();
2378 // FIXME: Some clever handling needed to show
2379 // the _first_ paragraph up to the top if the cursor is
2380 // in the first line.
2382 anchor_pm.setPosition(d->anchor_ypos_);
2384 LYXERR(Debug::PAINTING, "metrics: "
2385 << " anchor pit = " << d->anchor_pit_
2386 << " anchor ypos = " << d->anchor_ypos_);
2388 // Redo paragraphs above anchor if necessary.
2389 int y1 = d->anchor_ypos_ - anchor_pm.ascent();
2390 // We are now just above the anchor paragraph.
2391 pit_type pit1 = d->anchor_pit_ - 1;
2392 for (; pit1 >= 0 && y1 >= 0; --pit1) {
2393 tm.redoParagraph(pit1);
2394 ParagraphMetrics & pm = tm.par_metrics_[pit1];
2396 // Save the paragraph position in the cache.
2401 // Redo paragraphs below the anchor if necessary.
2402 int y2 = d->anchor_ypos_ + anchor_pm.descent();
2403 // We are now just below the anchor paragraph.
2404 pit_type pit2 = d->anchor_pit_ + 1;
2405 for (; pit2 < npit && y2 <= height_; ++pit2) {
2406 tm.redoParagraph(pit2);
2407 ParagraphMetrics & pm = tm.par_metrics_[pit2];
2409 // Save the paragraph position in the cache.
2414 LYXERR(Debug::PAINTING, "Metrics: "
2415 << " anchor pit = " << d->anchor_pit_
2416 << " anchor ypos = " << d->anchor_ypos_
2419 << " pit1 = " << pit1
2420 << " pit2 = " << pit2);
2422 d->update_strategy_ = FullScreenUpdate;
2424 if (lyxerr.debugging(Debug::WORKAREA)) {
2425 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
2426 d->coord_cache_.dump();
2431 void BufferView::insertLyXFile(FileName const & fname)
2433 LASSERT(d->cursor_.inTexted(), /**/);
2435 // Get absolute path of file and add ".lyx"
2436 // to the filename if necessary
2437 FileName filename = fileSearch(string(), fname.absFileName(), "lyx");
2439 docstring const disp_fn = makeDisplayPath(filename.absFileName());
2440 // emit message signal.
2441 message(bformat(_("Inserting document %1$s..."), disp_fn));
2444 Buffer buf("", false);
2445 if (buf.loadLyXFile(filename)) {
2446 ErrorList & el = buffer_.errorList("Parse");
2447 // Copy the inserted document error list into the current buffer one.
2448 el = buf.errorList("Parse");
2449 buffer_.undo().recordUndo(d->cursor_);
2450 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
2451 buf.params().documentClassPtr(), el);
2452 res = _("Document %1$s inserted.");
2454 res = _("Could not insert document %1$s");
2457 buffer_.changed(true);
2458 // emit message signal.
2459 message(bformat(res, disp_fn));
2460 buffer_.errors("Parse");
2464 Point BufferView::coordOffset(DocIterator const & dit) const
2470 // Addup contribution of nested insets, from inside to outside,
2471 // keeping the outer paragraph for a special handling below
2472 for (size_t i = dit.depth() - 1; i >= 1; --i) {
2473 CursorSlice const & sl = dit[i];
2477 // get relative position inside sl.inset()
2478 sl.inset().cursorPos(*this, sl, dit.boundary() && (i + 1 == dit.depth()), xx, yy);
2480 // Make relative position inside of the edited inset relative to sl.inset()
2484 // In case of an RTL inset, the edited inset will be positioned to the left
2487 bool boundary_i = dit.boundary() && i + 1 == dit.depth();
2488 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2493 // remember width for the case that sl.inset() is positioned in an RTL inset
2494 if (i && dit[i - 1].text()) {
2495 // If this Inset is inside a Text Inset, retrieve the Dimension
2496 // from the containing text instead of using Inset::dimension() which
2497 // might not be implemented.
2498 // FIXME (Abdel 23/09/2007): this is a bit messy because of the
2499 // elimination of Inset::dim_ cache. This coordOffset() method needs
2500 // to be rewritten in light of the new design.
2501 Dimension const & dim = parMetrics(dit[i - 1].text(),
2502 dit[i - 1].pit()).insetDimension(&sl.inset());
2505 Dimension const dim = sl.inset().dimension(*this);
2509 //lyxerr << "Cursor::getPos, i: "
2510 // << i << " x: " << xx << " y: " << y << endl;
2513 // Add contribution of initial rows of outermost paragraph
2514 CursorSlice const & sl = dit[0];
2515 TextMetrics const & tm = textMetrics(sl.text());
2516 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2517 LASSERT(!pm.rows().empty(), /**/);
2518 y -= pm.rows()[0].ascent();
2520 // FIXME: document this mess
2522 if (sl.pos() > 0 && dit.depth() == 1) {
2524 if (pos && dit.boundary())
2526 // lyxerr << "coordOffset: boundary:" << dit.boundary() << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
2527 rend = pm.pos2row(pos);
2529 rend = pm.pos2row(sl.pos());
2531 size_t rend = pm.pos2row(sl.pos());
2533 for (size_t rit = 0; rit != rend; ++rit)
2534 y += pm.rows()[rit].height();
2535 y += pm.rows()[rend].ascent();
2537 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
2539 // Make relative position from the nested inset now bufferview absolute.
2540 int xx = bottom_tm.cursorX(dit.bottom(), dit.boundary() && dit.depth() == 1);
2543 // In the RTL case place the nested inset at the left of the cursor in
2544 // the outer paragraph
2545 bool boundary_1 = dit.boundary() && 1 == dit.depth();
2546 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
2554 Point BufferView::getPos(DocIterator const & dit) const
2556 if (!paragraphVisible(dit))
2557 return Point(-1, -1);
2559 CursorSlice const & bot = dit.bottom();
2560 TextMetrics const & tm = textMetrics(bot.text());
2562 // offset from outer paragraph
2563 Point p = coordOffset(dit);
2564 p.y_ += tm.parMetrics(bot.pit()).position();
2569 bool BufferView::paragraphVisible(DocIterator const & dit) const
2571 CursorSlice const & bot = dit.bottom();
2572 TextMetrics const & tm = textMetrics(bot.text());
2574 return tm.contains(bot.pit());
2578 void BufferView::cursorPosAndHeight(Point & p, int & h) const
2580 Cursor const & cur = cursor();
2581 Font const font = cur.getFont();
2582 frontend::FontMetrics const & fm = theFontMetrics(font);
2583 int const asc = fm.maxAscent();
2584 int const des = fm.maxDescent();
2591 bool BufferView::cursorInView(Point const & p, int h) const
2593 Cursor const & cur = cursor();
2594 // does the cursor touch the screen ?
2595 if (p.y_ + h < 0 || p.y_ >= workHeight() || !paragraphVisible(cur))
2601 void BufferView::draw(frontend::Painter & pain)
2603 if (height_ == 0 || width_ == 0)
2605 LYXERR(Debug::PAINTING, "\t\t*** START DRAWING ***");
2607 Text & text = buffer_.text();
2608 TextMetrics const & tm = d->text_metrics_[&text];
2609 int const y = tm.first().second->position();
2610 PainterInfo pi(this, pain);
2612 switch (d->update_strategy_) {
2614 case NoScreenUpdate:
2615 // If no screen painting is actually needed, only some the different
2616 // coordinates of insets and paragraphs needs to be updated.
2617 pi.full_repaint = true;
2618 pi.pain.setDrawingEnabled(false);
2622 case SingleParUpdate:
2623 pi.full_repaint = false;
2624 // In general, only the current row of the outermost paragraph
2625 // will be redrawn. Particular cases where selection spans
2626 // multiple paragraph are correctly detected in TextMetrics.
2630 case DecorationUpdate:
2631 // FIXME: We should also distinguish DecorationUpdate to avoid text
2632 // drawing if possible. This is not possible to do easily right now
2633 // because of the single backing pixmap.
2635 case FullScreenUpdate:
2636 // The whole screen, including insets, will be refreshed.
2637 pi.full_repaint = true;
2639 // Clear background.
2640 pain.fillRectangle(0, 0, width_, height_,
2641 pi.backgroundColor(&buffer_.inset()));
2646 // and possibly grey out below
2647 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2648 int const y2 = lastpm.second->position() + lastpm.second->descent();
2651 Color color = buffer().isInternal()
2652 ? Color_background : Color_bottomarea;
2653 pain.fillRectangle(0, y2, width_, height_ - y2, color);
2657 LYXERR(Debug::PAINTING, "\n\t\t*** END DRAWING ***");
2659 // The scrollbar needs an update.
2662 // Normalize anchor for next time
2663 pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
2664 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2665 for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
2666 ParagraphMetrics const & pm = tm.parMetrics(pit);
2667 if (pm.position() + pm.descent() > 0) {
2668 d->anchor_pit_ = pit;
2669 d->anchor_ypos_ = pm.position();
2673 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
2674 << " anchor ypos = " << d->anchor_ypos_);
2678 void BufferView::message(docstring const & msg)
2681 d->gui_->message(msg);
2685 void BufferView::showDialog(string const & name)
2688 d->gui_->showDialog(name, string());
2692 void BufferView::showDialog(string const & name,
2693 string const & data, Inset * inset)
2696 d->gui_->showDialog(name, data, inset);
2700 void BufferView::updateDialog(string const & name, string const & data)
2703 d->gui_->updateDialog(name, data);
2707 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
2713 // FIXME: Move this out of BufferView again
2714 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
2716 if (!fname.isReadableFile()) {
2717 docstring const error = from_ascii(strerror(errno));
2718 docstring const file = makeDisplayPath(fname.absFileName(), 50);
2719 docstring const text =
2720 bformat(_("Could not read the specified document\n"
2721 "%1$s\ndue to the error: %2$s"), file, error);
2722 Alert::error(_("Could not read file"), text);
2726 if (!fname.isReadableFile()) {
2727 docstring const file = makeDisplayPath(fname.absFileName(), 50);
2728 docstring const text =
2729 bformat(_("%1$s\n is not readable."), file);
2730 Alert::error(_("Could not open file"), text);
2734 // FIXME UNICODE: We don't know the encoding of the file
2735 docstring file_content = fname.fileContents("UTF-8");
2736 if (file_content.empty()) {
2737 Alert::error(_("Reading not UTF-8 encoded file"),
2738 _("The file is not UTF-8 encoded.\n"
2739 "It will be read as local 8Bit-encoded.\n"
2740 "If this does not give the correct result\n"
2741 "then please change the encoding of the file\n"
2742 "to UTF-8 with a program other than LyX.\n"));
2743 file_content = fname.fileContents("local8bit");
2746 return normalize_c(file_content);
2750 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
2752 docstring const tmpstr = contentsOfPlaintextFile(f);
2757 Cursor & cur = cursor();
2758 cap::replaceSelection(cur);
2759 buffer_.undo().recordUndo(cur);
2761 cur.innerText()->insertStringAsParagraphs(cur, tmpstr, cur.current_font);
2763 cur.innerText()->insertStringAsLines(cur, tmpstr, cur.current_font);
2765 buffer_.changed(true);
2769 docstring const & BufferView::inlineCompletion() const
2771 return d->inlineCompletion_;
2775 size_t const & BufferView::inlineCompletionUniqueChars() const
2777 return d->inlineCompletionUniqueChars_;
2781 DocIterator const & BufferView::inlineCompletionPos() const
2783 return d->inlineCompletionPos_;
2787 bool samePar(DocIterator const & a, DocIterator const & b)
2789 if (a.empty() && b.empty())
2791 if (a.empty() || b.empty())
2793 if (a.depth() != b.depth())
2795 return &a.innerParagraph() == &b.innerParagraph();
2799 void BufferView::setInlineCompletion(Cursor & cur, DocIterator const & pos,
2800 docstring const & completion, size_t uniqueChars)
2802 uniqueChars = min(completion.size(), uniqueChars);
2803 bool changed = d->inlineCompletion_ != completion
2804 || d->inlineCompletionUniqueChars_ != uniqueChars;
2805 bool singlePar = true;
2806 d->inlineCompletion_ = completion;
2807 d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
2809 //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
2812 DocIterator const & old = d->inlineCompletionPos_;
2814 //lyxerr << "inlineCompletionPos changed" << std::endl;
2815 // old or pos are in another paragraph?
2816 if ((!samePar(cur, pos) && !pos.empty())
2817 || (!samePar(cur, old) && !old.empty())) {
2819 //lyxerr << "different paragraph" << std::endl;
2821 d->inlineCompletionPos_ = pos;
2826 if (singlePar && !(cur.result().update() & Update::Force))
2827 cur.updateFlags(cur.result().update() | Update::SinglePar);
2829 cur.updateFlags(cur.result().update() | Update::Force);