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);
323 int BufferView::rightMargin() const
325 // The additional test for the case the outliner is opened.
327 !lyxrc.full_screen_limit ||
328 width_ < lyxrc.full_screen_width + 20)
331 return (width_ - lyxrc.full_screen_width) / 2;
335 int BufferView::leftMargin() const
337 return rightMargin();
341 bool BufferView::isTopScreen() const
343 return d->scrollbarParameters_.position == d->scrollbarParameters_.min;
347 bool BufferView::isBottomScreen() const
349 return d->scrollbarParameters_.position == d->scrollbarParameters_.max;
353 Intl & BufferView::getIntl()
359 Intl const & BufferView::getIntl() const
365 CoordCache & BufferView::coordCache()
367 return d->coord_cache_;
371 CoordCache const & BufferView::coordCache() const
373 return d->coord_cache_;
377 Buffer & BufferView::buffer()
383 Buffer const & BufferView::buffer() const
389 bool BufferView::fitCursor()
391 if (cursorStatus(d->cursor_) == CUR_INSIDE) {
392 frontend::FontMetrics const & fm =
393 theFontMetrics(d->cursor_.getFont().fontInfo());
394 int const asc = fm.maxAscent();
395 int const des = fm.maxDescent();
396 Point const p = getPos(d->cursor_, d->cursor_.boundary());
397 if (p.y_ - asc >= 0 && p.y_ + des < height_)
404 void BufferView::processUpdateFlags(Update::flags flags)
406 // last_inset_ points to the last visited inset. This pointer may become
407 // invalid because of keyboard editing. Since all such operations
408 // causes screen update(), I reset last_inset_ to avoid such a problem.
411 // This is close to a hot-path.
412 LYXERR(Debug::DEBUG, "BufferView::processUpdateFlags()"
413 << "[fitcursor = " << (flags & Update::FitCursor)
414 << ", forceupdate = " << (flags & Update::Force)
415 << ", singlepar = " << (flags & Update::SinglePar)
416 << "] buffer: " << &buffer_);
418 buffer_.updateMacros();
420 // Now do the first drawing step if needed. This consists on updating
421 // the CoordCache in updateMetrics().
422 // The second drawing step is done in WorkArea::redraw() if needed.
424 // Case when no explicit update is requested.
426 // no need to redraw anything.
427 d->update_strategy_ = NoScreenUpdate;
431 if (flags == Update::Decoration) {
432 d->update_strategy_ = DecorationUpdate;
433 buffer_.changed(false);
437 if (flags == Update::FitCursor
438 || flags == (Update::Decoration | Update::FitCursor)) {
439 // tell the frontend to update the screen if needed.
444 if (flags & Update::Decoration) {
445 d->update_strategy_ = DecorationUpdate;
446 buffer_.changed(false);
449 // no screen update is needed.
450 d->update_strategy_ = NoScreenUpdate;
454 bool const full_metrics = flags & Update::Force || !singleParUpdate();
457 // We have to update the full screen metrics.
460 if (!(flags & Update::FitCursor)) {
461 // Nothing to do anymore. Trigger a redraw and return
462 buffer_.changed(false);
466 // updateMetrics() does not update paragraph position
467 // This is done at draw() time. So we need a redraw!
468 buffer_.changed(false);
471 // The cursor is off screen so ensure it is visible.
476 updateHoveredInset();
480 void BufferView::updateScrollbar()
482 if (height_ == 0 && width_ == 0)
485 // We prefer fixed size line scrolling.
486 d->scrollbarParameters_.single_step = defaultRowHeight();
487 // We prefer full screen page scrolling.
488 d->scrollbarParameters_.page_step = height_;
490 Text & t = buffer_.text();
491 TextMetrics & tm = d->text_metrics_[&t];
493 LYXERR(Debug::GUI, " Updating scrollbar: height: "
494 << t.paragraphs().size()
495 << " curr par: " << d->cursor_.bottom().pit()
496 << " default height " << defaultRowHeight());
498 size_t const parsize = t.paragraphs().size();
499 if (d->par_height_.size() != parsize) {
500 d->par_height_.clear();
501 // FIXME: We assume a default paragraph height of 2 rows. This
502 // should probably be pondered with the screen width.
503 d->par_height_.resize(parsize, defaultRowHeight() * 2);
506 // Look at paragraph heights on-screen
507 pair<pit_type, ParagraphMetrics const *> first = tm.first();
508 pair<pit_type, ParagraphMetrics const *> last = tm.last();
509 for (pit_type pit = first.first; pit <= last.first; ++pit) {
510 d->par_height_[pit] = tm.parMetrics(pit).height();
511 LYXERR(Debug::SCROLLING, "storing height for pit " << pit << " : "
512 << d->par_height_[pit]);
515 int top_pos = first.second->position() - first.second->ascent();
516 int bottom_pos = last.second->position() + last.second->descent();
517 bool first_visible = first.first == 0 && top_pos >= 0;
518 bool last_visible = last.first + 1 == int(parsize) && bottom_pos <= height_;
519 if (first_visible && last_visible) {
520 d->scrollbarParameters_.min = 0;
521 d->scrollbarParameters_.max = 0;
525 d->scrollbarParameters_.min = top_pos;
526 for (size_t i = 0; i != size_t(first.first); ++i)
527 d->scrollbarParameters_.min -= d->par_height_[i];
528 d->scrollbarParameters_.max = bottom_pos;
529 for (size_t i = last.first + 1; i != parsize; ++i)
530 d->scrollbarParameters_.max += d->par_height_[i];
532 d->scrollbarParameters_.position = 0;
533 // The reference is the top position so we remove one page.
534 if (lyxrc.scroll_below_document)
535 d->scrollbarParameters_.max -= minVisiblePart();
537 d->scrollbarParameters_.max -= d->scrollbarParameters_.page_step;
541 ScrollbarParameters const & BufferView::scrollbarParameters() const
543 return d->scrollbarParameters_;
547 docstring BufferView::toolTip(int x, int y) const
549 // Get inset under mouse, if there is one.
550 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
552 // No inset, no tooltip...
554 return covering_inset->toolTip(*this, x, y);
558 docstring BufferView::contextMenu(int x, int y) const
560 //If there is a selection, return the containing inset menu
561 if (d->cursor_.selection())
562 return d->cursor_.inset().contextMenu(*this, x, y);
564 // Get inset under mouse, if there is one.
565 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
567 return covering_inset->contextMenu(*this, x, y);
569 return buffer_.inset().contextMenu(*this, x, y);
573 void BufferView::scrollDocView(int value)
575 int const offset = value - d->scrollbarParameters_.position;
577 // No scrolling at all? No need to redraw anything
581 // If the offset is less than 2 screen height, prefer to scroll instead.
582 if (abs(offset) <= 2 * height_) {
583 d->anchor_ypos_ -= offset;
584 buffer_.changed(true);
585 updateHoveredInset();
589 // cut off at the top
590 if (value <= d->scrollbarParameters_.min) {
591 DocIterator dit = doc_iterator_begin(&buffer_);
593 LYXERR(Debug::SCROLLING, "scroll to top");
597 // cut off at the bottom
598 if (value >= d->scrollbarParameters_.max) {
599 DocIterator dit = doc_iterator_end(&buffer_);
602 LYXERR(Debug::SCROLLING, "scroll to bottom");
606 // find paragraph at target position
607 int par_pos = d->scrollbarParameters_.min;
609 for (; i != int(d->par_height_.size()); ++i) {
610 par_pos += d->par_height_[i];
611 if (par_pos >= value)
615 if (par_pos < value) {
616 // It seems we didn't find the correct pit so stay on the safe side and
618 LYXERR0("scrolling position not found!");
619 scrollDocView(d->scrollbarParameters_.max);
623 DocIterator dit = doc_iterator_begin(&buffer_);
625 LYXERR(Debug::SCROLLING, "value = " << value << " -> scroll to pit " << i);
630 // FIXME: this method is not working well.
631 void BufferView::setCursorFromScrollbar()
633 TextMetrics & tm = d->text_metrics_[&buffer_.text()];
635 int const height = 2 * defaultRowHeight();
636 int const first = height;
637 int const last = height_ - height;
639 Cursor const & oldcur = d->cursor_;
641 switch (cursorStatus(oldcur)) {
649 int const y = getPos(oldcur, oldcur.boundary()).y_;
650 newy = min(last, max(y, first));
654 // We reset the cursor because cursorStatus() does not
655 // work when the cursor is within mathed.
658 tm.setCursorFromCoordinates(cur, 0, newy);
660 // update the bufferview cursor and notify insets
661 // FIXME: Care about the d->cursor_ flags to redraw if needed
662 Cursor old = d->cursor_;
664 bool badcursor = notifyCursorLeavesOrEnters(old, d->cursor_);
666 d->cursor_.fixIfBroken();
670 Change const BufferView::getCurrentChange() const
672 if (!d->cursor_.selection())
673 return Change(Change::UNCHANGED);
675 DocIterator dit = d->cursor_.selectionBegin();
676 return dit.paragraph().lookupChange(dit.pos());
680 // this could be used elsewhere as well?
681 // FIXME: This does not work within mathed!
682 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
684 Point const p = getPos(dit, dit.boundary());
687 if (p.y_ > workHeight())
693 void BufferView::bookmarkEditPosition()
695 // Don't eat cpu time for each keystroke
696 if (d->cursor_.paragraph().id() == d->bookmark_edit_position_)
699 d->bookmark_edit_position_ = d->cursor_.paragraph().id();
703 void BufferView::saveBookmark(unsigned int idx)
705 // tentatively save bookmark, id and pos will be used to
706 // acturately locate a bookmark in a 'live' lyx session.
707 // pit and pos will be updated with bottom level pit/pos
709 if (!buffer_.isInternal()) {
710 theSession().bookmarks().save(
712 d->cursor_.bottom().pit(),
713 d->cursor_.bottom().pos(),
714 d->cursor_.paragraph().id(),
719 // emit message signal.
720 message(_("Save bookmark"));
725 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
726 int top_id, pos_type top_pos)
728 bool success = false;
731 d->cursor_.clearSelection();
733 // if a valid par_id is given, try it first
734 // This is the case for a 'live' bookmark when unique paragraph ID
735 // is used to track bookmarks.
737 dit = buffer_.getParFromID(top_id);
739 dit.pos() = min(dit.paragraph().size(), top_pos);
740 // Some slices of the iterator may not be
741 // reachable (e.g. closed collapsable inset)
742 // so the dociterator may need to be
743 // shortened. Otherwise, setCursor may crash
744 // lyx when the cursor can not be set to these
746 size_t const n = dit.depth();
747 for (size_t i = 0; i < n; ++i)
748 if (!dit[i].inset().editable()) {
756 // if top_id == 0, or searching through top_id failed
757 // This is the case for a 'restored' bookmark when only bottom
758 // (document level) pit was saved. Because of this, bookmark
759 // restoration is inaccurate. If a bookmark was within an inset,
760 // it will be restored to the left of the outmost inset that contains
762 if (bottom_pit < int(buffer_.paragraphs().size())) {
763 dit = doc_iterator_begin(&buffer_);
765 dit.pit() = bottom_pit;
766 dit.pos() = min(bottom_pos, dit.paragraph().size());
771 // Note: only bottom (document) level pit is set.
773 // set the current font.
774 d->cursor_.setCurrentFont();
775 // To center the screen on this new position we need the
776 // paragraph position which is computed at draw() time.
777 // So we need a redraw!
778 buffer_.changed(false);
787 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
789 if (lyxrc.rtl_support) {
790 if (d->cursor_.real_current_font.isRightToLeft()) {
791 if (d->intl_.keymap == Intl::PRIMARY)
792 d->intl_.keyMapSec();
794 if (d->intl_.keymap == Intl::SECONDARY)
795 d->intl_.keyMapPrim();
799 d->intl_.getTransManager().translateAndInsert(c, t, cur);
803 int BufferView::workWidth() const
809 void BufferView::recenter()
811 showCursor(d->cursor_, true);
815 void BufferView::showCursor()
817 showCursor(d->cursor_, false);
821 void BufferView::showCursor(DocIterator const & dit, bool recenter)
823 if (scrollToCursor(dit, recenter)) {
824 buffer_.changed(true);
825 updateHoveredInset();
830 void BufferView::scrollToCursor()
832 if (scrollToCursor(d->cursor_, false)) {
833 buffer_.changed(true);
834 updateHoveredInset();
839 bool BufferView::scrollToCursor(DocIterator const & dit, bool recenter)
841 // We are not properly started yet, delay until resizing is
846 LYXERR(Debug::SCROLLING, "recentering!");
848 CursorSlice const & bot = dit.bottom();
849 TextMetrics & tm = d->text_metrics_[bot.text()];
851 pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
852 int bot_pit = bot.pit();
853 if (bot_pit > max_pit) {
854 // FIXME: Why does this happen?
855 LYXERR0("bottom pit is greater that max pit: "
856 << bot_pit << " > " << max_pit);
860 if (bot_pit == tm.first().first - 1)
861 tm.newParMetricsUp();
862 else if (bot_pit == tm.last().first + 1)
863 tm.newParMetricsDown();
865 if (tm.contains(bot_pit)) {
866 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
867 LASSERT(!pm.rows().empty(), /**/);
868 // FIXME: smooth scrolling doesn't work in mathed.
869 CursorSlice const & cs = dit.innerTextSlice();
870 int offset = coordOffset(dit, dit.boundary()).y_;
871 int ypos = pm.position() + offset;
872 Dimension const & row_dim =
873 pm.getRow(cs.pos(), dit.boundary()).dimension();
876 scrolled = scroll(ypos - height_/2);
877 else if (ypos - row_dim.ascent() < 0)
878 scrolled = scrollUp(- ypos + row_dim.ascent());
879 else if (ypos + row_dim.descent() > height_)
880 scrolled = scrollDown(ypos - height_ + defaultRowHeight() );
882 // else, nothing to do, the cursor is already visible so we just return.
883 return scrolled != 0;
886 // fix inline completion position
887 if (d->inlineCompletionPos_.fixIfBroken())
888 d->inlineCompletionPos_ = DocIterator();
890 tm.redoParagraph(bot_pit);
891 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
892 int offset = coordOffset(dit, dit.boundary()).y_;
894 d->anchor_pit_ = bot_pit;
895 CursorSlice const & cs = dit.innerTextSlice();
896 Dimension const & row_dim =
897 pm.getRow(cs.pos(), dit.boundary()).dimension();
900 d->anchor_ypos_ = height_/2;
901 else if (d->anchor_pit_ == 0)
902 d->anchor_ypos_ = offset + pm.ascent();
903 else if (d->anchor_pit_ == max_pit)
904 d->anchor_ypos_ = height_ - offset - row_dim.descent();
905 else if (offset > height_)
906 d->anchor_ypos_ = height_ - offset - defaultRowHeight();
908 d->anchor_ypos_ = defaultRowHeight() * 2;
914 void BufferView::updateDocumentClass(DocumentClass const * const olddc)
916 message(_("Converting document to new document class..."));
918 StableDocIterator backcur(d->cursor_);
919 ErrorList & el = buffer_.errorList("Class Switch");
920 cap::switchBetweenClasses(
921 olddc, buffer_.params().documentClassPtr(),
922 static_cast<InsetText &>(buffer_.inset()), el);
924 setCursor(backcur.asDocIterator(&buffer_));
926 buffer_.errors("Class Switch");
927 buffer_.updateBuffer();
930 /** Return the change status at cursor position, taking in account the
931 * status at each level of the document iterator (a table in a deleted
932 * footnote is deleted).
933 * When \param outer is true, the top slice is not looked at.
935 static Change::Type lookupChangeType(DocIterator const & dit, bool outer = false)
937 size_t const depth = dit.depth() - (outer ? 1 : 0);
939 for (size_t i = 0 ; i < depth ; ++i) {
940 CursorSlice const & slice = dit[i];
941 if (!slice.inset().inMathed()
942 && slice.pos() < slice.paragraph().size()) {
943 Change::Type const ch = slice.paragraph().lookupChange(slice.pos()).type;
944 if (ch != Change::UNCHANGED)
948 return Change::UNCHANGED;
952 bool BufferView::getStatus(FuncRequest const & cmd, FuncStatus & flag)
954 FuncCode const act = cmd.action();
956 // Can we use a readonly buffer?
957 if (buffer_.isReadonly()
958 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
959 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
960 flag.message(from_utf8(N_("Document is read-only")));
961 flag.setEnabled(false);
965 // Are we in a DELETED change-tracking region?
966 if (lookupChangeType(d->cursor_, true) == Change::DELETED
967 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
968 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
969 flag.message(from_utf8(N_("This portion of the document is deleted.")));
970 flag.setEnabled(false);
974 Cursor & cur = d->cursor_;
976 if (cur.getStatus(cmd, flag))
981 // FIXME: This is a bit problematic because we don't check if this is
982 // a document BufferView or not for these LFUNs. We probably have to
983 // dispatch both to currentBufferView() and, if that fails,
984 // to documentBufferView(); same as we do know for current Buffer and
985 // document Buffer. Ideally those LFUN should go to Buffer as they*
986 // operate on the full Buffer and the cursor is only needed either for
987 // an Undo record or to restore a cursor position. But we don't know
988 // how to do that inside Buffer of course.
989 case LFUN_BUFFER_PARAMS_APPLY:
990 case LFUN_LAYOUT_MODULES_CLEAR:
991 case LFUN_LAYOUT_MODULE_ADD:
992 case LFUN_LAYOUT_RELOAD:
993 case LFUN_TEXTCLASS_APPLY:
994 case LFUN_TEXTCLASS_LOAD:
995 flag.setEnabled(!buffer_.isReadonly());
999 flag.setEnabled(buffer_.undo().hasUndoStack());
1002 flag.setEnabled(buffer_.undo().hasRedoStack());
1004 case LFUN_FILE_INSERT:
1005 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
1006 case LFUN_FILE_INSERT_PLAINTEXT:
1007 case LFUN_BOOKMARK_SAVE:
1008 // FIXME: Actually, these LFUNS should be moved to Text
1009 flag.setEnabled(cur.inTexted());
1012 case LFUN_FONT_STATE:
1013 case LFUN_LABEL_INSERT:
1014 case LFUN_INFO_INSERT:
1015 case LFUN_PARAGRAPH_GOTO:
1016 case LFUN_NOTE_NEXT:
1017 case LFUN_REFERENCE_NEXT:
1018 case LFUN_WORD_FIND:
1019 case LFUN_WORD_FIND_FORWARD:
1020 case LFUN_WORD_FIND_BACKWARD:
1021 case LFUN_WORD_FINDADV:
1022 case LFUN_WORD_REPLACE:
1025 case LFUN_MARK_TOGGLE:
1026 case LFUN_SCREEN_RECENTER:
1027 case LFUN_SCREEN_SHOW_CURSOR:
1028 case LFUN_BIBTEX_DATABASE_ADD:
1029 case LFUN_BIBTEX_DATABASE_DEL:
1030 case LFUN_STATISTICS:
1031 case LFUN_BRANCH_ADD_INSERT:
1032 case LFUN_KEYMAP_OFF:
1033 case LFUN_KEYMAP_PRIMARY:
1034 case LFUN_KEYMAP_SECONDARY:
1035 case LFUN_KEYMAP_TOGGLE:
1036 flag.setEnabled(true);
1039 case LFUN_LABEL_GOTO: {
1040 flag.setEnabled(!cmd.argument().empty()
1041 || getInsetByCode<InsetRef>(cur, REF_CODE));
1045 case LFUN_CHANGES_TRACK:
1046 flag.setEnabled(true);
1047 flag.setOnOff(buffer_.params().trackChanges);
1050 case LFUN_CHANGES_OUTPUT:
1051 flag.setEnabled(true);
1052 flag.setOnOff(buffer_.params().outputChanges);
1055 case LFUN_CHANGES_MERGE:
1056 case LFUN_CHANGE_NEXT:
1057 case LFUN_CHANGE_PREVIOUS:
1058 case LFUN_ALL_CHANGES_ACCEPT:
1059 case LFUN_ALL_CHANGES_REJECT:
1060 // TODO: context-sensitive enabling of LFUNs
1061 // In principle, these command should only be enabled if there
1062 // is a change in the document. However, without proper
1063 // optimizations, this will inevitably result in poor performance.
1064 flag.setEnabled(true);
1067 case LFUN_BUFFER_TOGGLE_COMPRESSION: {
1068 flag.setOnOff(buffer_.params().compressed);
1072 case LFUN_SCREEN_UP:
1073 case LFUN_SCREEN_DOWN:
1075 case LFUN_SCREEN_UP_SELECT:
1076 case LFUN_SCREEN_DOWN_SELECT:
1077 case LFUN_INSET_FORALL:
1078 flag.setEnabled(true);
1081 case LFUN_LAYOUT_TABULAR:
1082 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
1086 flag.setEnabled(!cur.inset().forcePlainLayout(cur.idx()));
1089 case LFUN_LAYOUT_PARAGRAPH:
1090 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
1093 case LFUN_DIALOG_SHOW_NEW_INSET:
1094 // FIXME: this is wrong, but I do not understand the
1096 if (cur.inset().lyxCode() == CAPTION_CODE)
1097 return cur.inset().getStatus(cur, cmd, flag);
1098 // FIXME we should consider passthru paragraphs too.
1099 flag.setEnabled(!cur.inset().getLayout().isPassThru());
1102 case LFUN_CITATION_INSERT: {
1103 FuncRequest fr(LFUN_INSET_INSERT, "citation");
1104 // FIXME: This could turn in a recursive hell.
1105 // Shouldn't we use Buffer::getStatus() instead?
1106 flag.setEnabled(lyx::getStatus(fr).enabled());
1109 case LFUN_INSET_APPLY: {
1110 string const name = cmd.getArg(0);
1111 Inset * inset = editedInset(name);
1113 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1114 if (!inset->getStatus(cur, fr, flag)) {
1115 // Every inset is supposed to handle this
1116 LASSERT(false, break);
1119 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1120 flag = lyx::getStatus(fr);
1133 Inset * BufferView::editedInset(string const & name) const
1135 map<string, Inset *>::const_iterator it = d->edited_insets_.find(name);
1136 return it == d->edited_insets_.end() ? 0 : it->second;
1140 void BufferView::editInset(string const & name, Inset * inset)
1142 d->edited_insets_[name] = inset;
1146 void BufferView::dispatch(FuncRequest const & cmd, DispatchResult & dr)
1148 //lyxerr << [ cmd = " << cmd << "]" << endl;
1150 // Make sure that the cached BufferView is correct.
1151 LYXERR(Debug::ACTION, " action[" << cmd.action() << ']'
1152 << " arg[" << to_utf8(cmd.argument()) << ']'
1153 << " x[" << cmd.x() << ']'
1154 << " y[" << cmd.y() << ']'
1155 << " button[" << cmd.button() << ']');
1157 string const argument = to_utf8(cmd.argument());
1158 Cursor & cur = d->cursor_;
1160 // Don't dispatch function that does not apply to internal buffers.
1161 if (buffer_.isInternal()
1162 && lyxaction.funcHasFlag(cmd.action(), LyXAction::NoInternal))
1165 // We'll set this back to false if need be.
1166 bool dispatched = true;
1167 buffer_.undo().beginUndoGroup();
1169 FuncCode const act = cmd.action();
1172 case LFUN_BUFFER_PARAMS_APPLY: {
1173 DocumentClass const * const oldClass = buffer_.params().documentClassPtr();
1174 cur.recordUndoFullDocument();
1175 istringstream ss(to_utf8(cmd.argument()));
1178 int const unknown_tokens = buffer_.readHeader(lex);
1179 if (unknown_tokens != 0) {
1180 LYXERR0("Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1181 << unknown_tokens << " unknown token"
1182 << (unknown_tokens == 1 ? "" : "s"));
1184 updateDocumentClass(oldClass);
1186 // We are most certainly here because of a change in the document
1187 // It is then better to make sure that all dialogs are in sync with
1188 // current document settings.
1189 dr.update(Update::Force | Update::FitCursor);
1193 case LFUN_LAYOUT_MODULES_CLEAR: {
1194 DocumentClass const * const oldClass =
1195 buffer_.params().documentClassPtr();
1196 cur.recordUndoFullDocument();
1197 buffer_.params().clearLayoutModules();
1198 buffer_.params().makeDocumentClass();
1199 updateDocumentClass(oldClass);
1200 dr.update(Update::Force | Update::FitCursor);
1204 case LFUN_LAYOUT_MODULE_ADD: {
1205 BufferParams const & params = buffer_.params();
1206 if (!params.moduleCanBeAdded(argument)) {
1207 LYXERR0("Module `" << argument <<
1208 "' cannot be added due to failed requirements or "
1209 "conflicts with installed modules.");
1212 DocumentClass const * const oldClass = params.documentClassPtr();
1213 cur.recordUndoFullDocument();
1214 buffer_.params().addLayoutModule(argument);
1215 buffer_.params().makeDocumentClass();
1216 updateDocumentClass(oldClass);
1217 dr.update(Update::Force | Update::FitCursor);
1221 case LFUN_TEXTCLASS_APPLY: {
1222 if (!LayoutFileList::get().load(argument, buffer_.temppath()) &&
1223 !LayoutFileList::get().load(argument, buffer_.filePath()))
1226 LayoutFile const * old_layout = buffer_.params().baseClass();
1227 LayoutFile const * new_layout = &(LayoutFileList::get()[argument]);
1229 if (old_layout == new_layout)
1233 //Save the old, possibly modular, layout for use in conversion.
1234 DocumentClass const * const oldDocClass =
1235 buffer_.params().documentClassPtr();
1236 cur.recordUndoFullDocument();
1237 buffer_.params().setBaseClass(argument);
1238 buffer_.params().makeDocumentClass();
1239 updateDocumentClass(oldDocClass);
1240 dr.update(Update::Force | Update::FitCursor);
1244 case LFUN_TEXTCLASS_LOAD:
1245 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1246 LayoutFileList::get().load(argument, buffer_.filePath());
1249 case LFUN_LAYOUT_RELOAD: {
1250 DocumentClass const * const oldClass = buffer_.params().documentClassPtr();
1251 LayoutFileIndex bc = buffer_.params().baseClassID();
1252 LayoutFileList::get().reset(bc);
1253 buffer_.params().setBaseClass(bc);
1254 buffer_.params().makeDocumentClass();
1255 updateDocumentClass(oldClass);
1256 dr.update(Update::Force | Update::FitCursor);
1261 dr.setMessage(_("Undo"));
1262 cur.clearSelection();
1263 if (!cur.textUndo())
1264 dr.setMessage(_("No further undo information"));
1266 dr.update(Update::Force | Update::FitCursor);
1270 dr.setMessage(_("Redo"));
1271 cur.clearSelection();
1272 if (!cur.textRedo())
1273 dr.setMessage(_("No further redo information"));
1275 dr.update(Update::Force | Update::FitCursor);
1278 case LFUN_FONT_STATE:
1279 dr.setMessage(cur.currentState());
1282 case LFUN_BOOKMARK_SAVE:
1283 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1286 case LFUN_LABEL_GOTO: {
1287 docstring label = cmd.argument();
1288 if (label.empty()) {
1290 getInsetByCode<InsetRef>(cur, REF_CODE);
1292 label = inset->getParam("reference");
1293 // persistent=false: use temp_bookmark
1302 case LFUN_PARAGRAPH_GOTO: {
1303 int const id = convert<int>(cmd.getArg(0));
1304 int const pos = convert<int>(cmd.getArg(1));
1306 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1307 b = theBufferList().next(b)) {
1309 DocIterator dit = b->getParFromID(id);
1311 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1315 LYXERR(Debug::INFO, "Paragraph " << dit.paragraph().id()
1316 << " found in buffer `"
1317 << b->absFileName() << "'.");
1319 if (b == &buffer_) {
1323 dr.update(Update::Force | Update::FitCursor);
1325 // Switch to other buffer view and resend cmd
1326 lyx::dispatch(FuncRequest(
1327 LFUN_BUFFER_SWITCH, b->absFileName()));
1335 case LFUN_NOTE_NEXT:
1336 gotoInset(this, NOTE_CODE, false);
1339 case LFUN_REFERENCE_NEXT: {
1340 vector<InsetCode> tmp;
1341 tmp.push_back(LABEL_CODE);
1342 tmp.push_back(REF_CODE);
1343 gotoInset(this, tmp, true);
1347 case LFUN_CHANGES_TRACK:
1348 buffer_.params().trackChanges = !buffer_.params().trackChanges;
1351 case LFUN_CHANGES_OUTPUT:
1352 buffer_.params().outputChanges = !buffer_.params().outputChanges;
1353 if (buffer_.params().outputChanges) {
1354 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1355 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1356 LaTeXFeatures::isAvailable("xcolor");
1358 if (!dvipost && !xcolorulem) {
1359 Alert::warning(_("Changes not shown in LaTeX output"),
1360 _("Changes will not be highlighted in LaTeX output, "
1361 "because neither dvipost nor xcolor/ulem are installed.\n"
1362 "Please install these packages or redefine "
1363 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1364 } else if (!xcolorulem) {
1365 Alert::warning(_("Changes not shown in LaTeX output"),
1366 _("Changes will not be highlighted in LaTeX output "
1367 "when using pdflatex, because xcolor and ulem are not installed.\n"
1368 "Please install both packages or redefine "
1369 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1374 case LFUN_CHANGE_NEXT:
1375 findNextChange(this);
1376 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1377 dr.update(Update::Force | Update::FitCursor);
1380 case LFUN_CHANGE_PREVIOUS:
1381 findPreviousChange(this);
1382 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1383 dr.update(Update::Force | Update::FitCursor);
1386 case LFUN_CHANGES_MERGE:
1387 if (findNextChange(this) || findPreviousChange(this)) {
1388 dr.update(Update::Force | Update::FitCursor);
1389 showDialog("changes");
1393 case LFUN_ALL_CHANGES_ACCEPT:
1394 // select complete document
1396 cur.selHandle(true);
1397 buffer_.text().cursorBottom(cur);
1398 // accept everything in a single step to support atomic undo
1399 buffer_.text().acceptOrRejectChanges(cur, Text::ACCEPT);
1400 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1401 dr.update(Update::Force | Update::FitCursor);
1404 case LFUN_ALL_CHANGES_REJECT:
1405 // select complete document
1407 cur.selHandle(true);
1408 buffer_.text().cursorBottom(cur);
1409 // reject everything in a single step to support atomic undo
1410 // Note: reject does not work recursively; the user may have to repeat the operation
1411 buffer_.text().acceptOrRejectChanges(cur, Text::REJECT);
1412 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1413 dr.update(Update::Force | Update::FitCursor);
1416 case LFUN_WORD_FIND_FORWARD:
1417 case LFUN_WORD_FIND_BACKWARD: {
1418 static docstring last_search;
1419 docstring searched_string;
1421 if (!cmd.argument().empty()) {
1422 last_search = cmd.argument();
1423 searched_string = cmd.argument();
1425 searched_string = last_search;
1428 if (searched_string.empty())
1431 bool const fw = act == LFUN_WORD_FIND_FORWARD;
1432 docstring const data =
1433 find2string(searched_string, true, false, fw);
1434 find(this, FuncRequest(LFUN_WORD_FIND, data));
1438 case LFUN_WORD_FIND: {
1439 FuncRequest req = cmd;
1440 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1441 req = d->search_request_cache_;
1442 if (req.argument().empty()) {
1443 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, "findreplace"));
1446 if (find(this, req))
1449 message(_("String not found!"));
1450 d->search_request_cache_ = req;
1454 case LFUN_WORD_REPLACE: {
1455 bool has_deleted = false;
1456 if (cur.selection()) {
1457 DocIterator beg = cur.selectionBegin();
1458 DocIterator end = cur.selectionEnd();
1459 if (beg.pit() == end.pit()) {
1460 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1462 && cur.paragraph().isDeleted(p))
1467 replace(this, cmd, has_deleted);
1471 case LFUN_WORD_FINDADV: {
1472 FindAndReplaceOptions opt;
1473 istringstream iss(to_utf8(cmd.argument()));
1475 if (findAdv(this, opt))
1483 cur.clearSelection();
1484 dr.setMessage(from_utf8(N_("Mark off")));
1488 cur.clearSelection();
1490 dr.setMessage(from_utf8(N_("Mark on")));
1493 case LFUN_MARK_TOGGLE:
1494 cur.setSelection(false);
1497 dr.setMessage(from_utf8(N_("Mark removed")));
1500 dr.setMessage(from_utf8(N_("Mark set")));
1505 case LFUN_SCREEN_SHOW_CURSOR:
1509 case LFUN_SCREEN_RECENTER:
1513 case LFUN_BIBTEX_DATABASE_ADD: {
1514 Cursor tmpcur = cur;
1515 findInset(tmpcur, BIBTEX_CODE, false);
1516 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1519 if (inset->addDatabase(cmd.argument()))
1520 buffer_.updateBibfilesCache();
1525 case LFUN_BIBTEX_DATABASE_DEL: {
1526 Cursor tmpcur = cur;
1527 findInset(tmpcur, BIBTEX_CODE, false);
1528 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1531 if (inset->delDatabase(cmd.argument()))
1532 buffer_.updateBibfilesCache();
1537 case LFUN_STATISTICS: {
1538 DocIterator from, to;
1539 if (cur.selection()) {
1540 from = cur.selectionBegin();
1541 to = cur.selectionEnd();
1543 from = doc_iterator_begin(&buffer_);
1544 to = doc_iterator_end(&buffer_);
1546 int const words = countWords(from, to);
1547 int const chars = countChars(from, to, false);
1548 int const chars_blanks = countChars(from, to, true);
1550 if (cur.selection())
1551 message = _("Statistics for the selection:");
1553 message = _("Statistics for the document:");
1556 message += bformat(_("%1$d words"), words);
1558 message += _("One word");
1560 if (chars_blanks != 1)
1561 message += bformat(_("%1$d characters (including blanks)"),
1564 message += _("One character (including blanks)");
1567 message += bformat(_("%1$d characters (excluding blanks)"),
1570 message += _("One character (excluding blanks)");
1572 Alert::information(_("Statistics"), message);
1576 case LFUN_BUFFER_TOGGLE_COMPRESSION:
1577 // turn compression on/off
1578 buffer_.params().compressed = !buffer_.params().compressed;
1581 case LFUN_SCREEN_UP:
1582 case LFUN_SCREEN_DOWN: {
1583 Point p = getPos(cur, cur.boundary());
1584 // This code has been commented out to enable to scroll down a
1585 // document, even if there are large insets in it (see bug #5465).
1586 /*if (p.y_ < 0 || p.y_ > height_) {
1587 // The cursor is off-screen so recenter before proceeding.
1589 p = getPos(cur, cur.boundary());
1591 int const scrolled = scroll(act == LFUN_SCREEN_UP
1592 ? -height_ : height_);
1593 if (act == LFUN_SCREEN_UP && scrolled > -height_)
1595 if (act == LFUN_SCREEN_DOWN && scrolled < height_)
1596 p = Point(width_, height_);
1598 bool const in_texted = cur.inTexted();
1600 buffer_.changed(true);
1601 updateHoveredInset();
1603 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_,
1604 true, act == LFUN_SCREEN_UP);
1605 //FIXME: what to do with cur.x_target()?
1606 bool update = in_texted && cur.bv().checkDepm(cur, old);
1609 dr.update(Update::Force | Update::FitCursor);
1617 case LFUN_SCREEN_UP_SELECT: {
1618 cur.selHandle(true);
1619 if (isTopScreen()) {
1620 lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1624 int y = getPos(cur, cur.boundary()).y_;
1625 int const ymin = y - height_ + defaultRowHeight();
1626 while (y > ymin && cur.up())
1627 y = getPos(cur, cur.boundary()).y_;
1630 dr.update(Update::SinglePar | Update::FitCursor);
1634 case LFUN_SCREEN_DOWN_SELECT: {
1635 cur.selHandle(true);
1636 if (isBottomScreen()) {
1637 lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1641 int y = getPos(cur, cur.boundary()).y_;
1642 int const ymax = y + height_ - defaultRowHeight();
1643 while (y < ymax && cur.down())
1644 y = getPos(cur, cur.boundary()).y_;
1647 dr.update(Update::SinglePar | Update::FitCursor);
1652 // This would be in Buffer class if only Cursor did not
1653 // require a bufferview
1654 case LFUN_INSET_FORALL: {
1655 docstring const name = from_utf8(cmd.getArg(0));
1656 string const commandstr = cmd.getLongArg(1);
1657 FuncRequest const fr = lyxaction.lookupFunc(commandstr);
1659 // an arbitrary number to limit number of iterations
1660 const int max_iter = 10000;
1662 Cursor & cur = d->cursor_;
1663 Cursor const savecur = cur;
1665 if (!cur.nextInset())
1667 cur.beginUndoGroup();
1668 while(cur && iterations < max_iter) {
1669 Inset * ins = cur.nextInset();
1672 docstring insname = ins->name();
1673 while (!insname.empty()) {
1674 if (insname == name || name == from_utf8("*")) {
1676 lyx::dispatch(fr, dr);
1680 size_t const i = insname.rfind(':');
1681 if (i == string::npos)
1683 insname = insname.substr(0, i);
1690 dr.update(Update::Force);
1692 if (iterations >= max_iter) {
1694 dr.setMessage(bformat(_("`inset-forall' interrupted because number of actions is larger than %1$d"), max_iter));
1696 dr.setMessage(bformat(_("Applied \"%1$s\" to %2$d insets"), from_utf8(commandstr), iterations));
1701 case LFUN_BRANCH_ADD_INSERT: {
1702 docstring branch_name = from_utf8(cmd.getArg(0));
1703 if (branch_name.empty())
1704 if (!Alert::askForText(branch_name, _("Branch name")) ||
1705 branch_name.empty())
1708 DispatchResult drtmp;
1709 buffer_.dispatch(FuncRequest(LFUN_BRANCH_ADD, branch_name), drtmp);
1710 if (drtmp.error()) {
1711 Alert::warning(_("Branch already exists"), drtmp.message());
1714 lyx::dispatch(FuncRequest(LFUN_BRANCH_INSERT, branch_name));
1718 case LFUN_KEYMAP_OFF:
1719 getIntl().keyMapOn(false);
1722 case LFUN_KEYMAP_PRIMARY:
1723 getIntl().keyMapPrim();
1726 case LFUN_KEYMAP_SECONDARY:
1727 getIntl().keyMapSec();
1730 case LFUN_KEYMAP_TOGGLE:
1731 getIntl().toggleKeyMap();
1734 case LFUN_DIALOG_SHOW_NEW_INSET: {
1735 string const name = cmd.getArg(0);
1736 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
1737 if (decodeInsetParam(name, data, buffer_))
1738 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
1740 lyxerr << "Inset type '" << name <<
1741 "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" << endl;
1745 case LFUN_CITATION_INSERT: {
1746 if (argument.empty()) {
1747 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
1750 // we can have one optional argument, delimited by '|'
1751 // citation-insert <key>|<text_before>
1752 // this should be enhanced to also support text_after
1753 // and citation style
1754 string arg = argument;
1756 if (contains(argument, "|")) {
1757 arg = token(argument, '|', 0);
1758 opt1 = token(argument, '|', 1);
1760 InsetCommandParams icp(CITE_CODE);
1761 icp["key"] = from_utf8(arg);
1763 icp["before"] = from_utf8(opt1);
1764 string icstr = InsetCommand::params2string("citation", icp);
1765 FuncRequest fr(LFUN_INSET_INSERT, icstr);
1770 case LFUN_INSET_APPLY: {
1771 string const name = cmd.getArg(0);
1772 Inset * inset = editedInset(name);
1774 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1778 // put cursor in front of inset.
1779 if (!setCursorFromInset(inset)) {
1780 LASSERT(false, break);
1783 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1784 inset->dispatch(cur, fr);
1785 dr.update(Update::SinglePar | Update::FitCursor);
1794 buffer_.undo().endUndoGroup();
1795 dr.dispatched(dispatched);
1800 docstring const BufferView::requestSelection()
1802 Cursor & cur = d->cursor_;
1804 LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
1805 if (!cur.selection()) {
1806 d->xsel_cache_.set = false;
1810 LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
1811 if (!d->xsel_cache_.set ||
1812 cur.top() != d->xsel_cache_.cursor ||
1813 cur.realAnchor().top() != d->xsel_cache_.anchor)
1815 d->xsel_cache_.cursor = cur.top();
1816 d->xsel_cache_.anchor = cur.realAnchor().top();
1817 d->xsel_cache_.set = cur.selection();
1818 return cur.selectionAsString(false);
1824 void BufferView::clearSelection()
1826 d->cursor_.clearSelection();
1827 // Clear the selection buffer. Otherwise a subsequent
1828 // middle-mouse-button paste would use the selection buffer,
1829 // not the more current external selection.
1830 cap::clearSelection();
1831 d->xsel_cache_.set = false;
1832 // The buffer did not really change, but this causes the
1833 // redraw we need because we cleared the selection above.
1834 buffer_.changed(false);
1838 void BufferView::resize(int width, int height)
1840 // Update from work area
1844 // Clear the paragraph height cache.
1845 d->par_height_.clear();
1846 // Redo the metrics.
1851 Inset const * BufferView::getCoveringInset(Text const & text,
1854 TextMetrics & tm = d->text_metrics_[&text];
1855 Inset * inset = tm.checkInsetHit(x, y);
1859 if (!inset->descendable(*this))
1860 // No need to go further down if the inset is not
1864 size_t cell_number = inset->nargs();
1865 // Check all the inner cell.
1866 for (size_t i = 0; i != cell_number; ++i) {
1867 Text const * inner_text = inset->getText(i);
1870 Inset const * inset_deeper =
1871 getCoveringInset(*inner_text, x, y);
1873 return inset_deeper;
1881 void BufferView::updateHoveredInset() const
1883 // Get inset under mouse, if there is one.
1884 Inset const * covering_inset = getCoveringInset(buffer_.text(),
1885 d->mouse_position_cache_.x_, d->mouse_position_cache_.y_);
1886 if (covering_inset == d->last_inset_)
1887 // Same inset, no need to do anything...
1890 bool need_redraw = false;
1892 // Remove the hint on the last hovered inset (if any).
1893 need_redraw |= d->last_inset_->setMouseHover(false);
1895 // const_cast because of setMouseHover().
1896 Inset * inset = const_cast<Inset *>(covering_inset);
1898 // Highlight the newly hovered inset (if any).
1899 need_redraw |= inset->setMouseHover(true);
1901 d->last_inset_ = inset;
1904 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
1905 << d->mouse_position_cache_.x_ << ", "
1906 << d->mouse_position_cache_.y_ << ")");
1908 d->update_strategy_ = DecorationUpdate;
1910 // This event (moving without mouse click) is not passed further.
1911 // This should be changed if it is further utilized.
1912 buffer_.changed(false);
1917 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
1919 //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
1921 // This is only called for mouse related events including
1922 // LFUN_FILE_OPEN generated by drag-and-drop.
1923 FuncRequest cmd = cmd0;
1925 Cursor old = cursor();
1927 cur.push(buffer_.inset());
1928 cur.setSelection(d->cursor_.selection());
1930 // Either the inset under the cursor or the
1931 // surrounding Text will handle this event.
1933 // make sure we stay within the screen...
1934 cmd.set_y(min(max(cmd.y(), -1), height_));
1936 d->mouse_position_cache_.x_ = cmd.x();
1937 d->mouse_position_cache_.y_ = cmd.y();
1939 if (cmd.action() == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
1940 updateHoveredInset();
1944 // Build temporary cursor.
1945 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x(), cmd.y());
1947 // Put anchor at the same position.
1950 cur.beginUndoGroup();
1952 // Try to dispatch to an non-editable inset near this position
1953 // via the temp cursor. If the inset wishes to change the real
1954 // cursor it has to do so explicitly by using
1955 // cur.bv().cursor() = cur; (or similar)
1957 inset->dispatch(cur, cmd);
1959 // Now dispatch to the temporary cursor. If the real cursor should
1960 // be modified, the inset's dispatch has to do so explicitly.
1961 if (!inset || !cur.result().dispatched())
1966 // Notify left insets
1969 bool badcursor = notifyCursorLeavesOrEnters(old, cur);
1971 cursor().fixIfBroken();
1974 // Do we have a selection?
1975 theSelection().haveSelection(cursor().selection());
1977 // If the command has been dispatched,
1978 if (cur.result().dispatched() || cur.result().update())
1979 processUpdateFlags(cur.result().update());
1983 void BufferView::lfunScroll(FuncRequest const & cmd)
1985 string const scroll_type = cmd.getArg(0);
1986 int scroll_step = 0;
1987 if (scroll_type == "line")
1988 scroll_step = d->scrollbarParameters_.single_step;
1989 else if (scroll_type == "page")
1990 scroll_step = d->scrollbarParameters_.page_step;
1993 string const scroll_quantity = cmd.getArg(1);
1994 if (scroll_quantity == "up")
1995 scrollUp(scroll_step);
1996 else if (scroll_quantity == "down")
1997 scrollDown(scroll_step);
1999 int const scroll_value = convert<int>(scroll_quantity);
2001 scroll(scroll_step * scroll_value);
2003 buffer_.changed(true);
2004 updateHoveredInset();
2008 int BufferView::minVisiblePart()
2010 return 2 * defaultRowHeight();
2014 int BufferView::scroll(int y)
2017 return scrollDown(y);
2019 return scrollUp(-y);
2024 int BufferView::scrollDown(int offset)
2026 Text * text = &buffer_.text();
2027 TextMetrics & tm = d->text_metrics_[text];
2028 int const ymax = height_ + offset;
2030 pair<pit_type, ParagraphMetrics const *> last = tm.last();
2031 int bottom_pos = last.second->position() + last.second->descent();
2032 if (lyxrc.scroll_below_document)
2033 bottom_pos += height_ - minVisiblePart();
2034 if (last.first + 1 == int(text->paragraphs().size())) {
2035 if (bottom_pos <= height_)
2037 offset = min(offset, bottom_pos - height_);
2040 if (bottom_pos > ymax)
2042 tm.newParMetricsDown();
2044 d->anchor_ypos_ -= offset;
2049 int BufferView::scrollUp(int offset)
2051 Text * text = &buffer_.text();
2052 TextMetrics & tm = d->text_metrics_[text];
2053 int ymin = - offset;
2055 pair<pit_type, ParagraphMetrics const *> first = tm.first();
2056 int top_pos = first.second->position() - first.second->ascent();
2057 if (first.first == 0) {
2060 offset = min(offset, - top_pos);
2065 tm.newParMetricsUp();
2067 d->anchor_ypos_ += offset;
2072 void BufferView::setCursorFromRow(int row)
2077 buffer_.texrow().getIdFromRow(row, tmpid, tmppos);
2081 buffer_.text().setCursor(d->cursor_, 0, 0);
2083 buffer_.text().setCursor(d->cursor_, buffer_.getParFromID(tmpid).pit(), tmppos);
2088 bool BufferView::setCursorFromInset(Inset const * inset)
2090 // are we already there?
2091 if (cursor().nextInset() == inset)
2094 // Inset is not at cursor position. Find it in the document.
2097 while (cur && cur.nextInset() != inset)
2108 void BufferView::gotoLabel(docstring const & label)
2110 std::vector<Buffer const *> bufs = buffer().allRelatives();
2111 std::vector<Buffer const *>::iterator it = bufs.begin();
2112 for (; it != bufs.end(); ++it) {
2113 Buffer const * buf = *it;
2116 Toc & toc = buf->tocBackend().toc("label");
2117 TocIterator toc_it = toc.begin();
2118 TocIterator end = toc.end();
2119 for (; toc_it != end; ++toc_it) {
2120 if (label == toc_it->str()) {
2121 lyx::dispatch(toc_it->action());
2129 TextMetrics const & BufferView::textMetrics(Text const * t) const
2131 return const_cast<BufferView *>(this)->textMetrics(t);
2135 TextMetrics & BufferView::textMetrics(Text const * t)
2137 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
2138 if (tmc_it == d->text_metrics_.end()) {
2139 tmc_it = d->text_metrics_.insert(
2140 make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
2142 return tmc_it->second;
2146 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
2149 return textMetrics(t).parMetrics(pit);
2153 int BufferView::workHeight() const
2159 void BufferView::setCursor(DocIterator const & dit)
2162 size_t const n = dit.depth();
2163 for (size_t i = 0; i < n; ++i)
2164 dit[i].inset().edit(d->cursor_, true);
2166 d->cursor_.setCursor(dit);
2167 d->cursor_.setSelection(false);
2171 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
2173 // Would be wrong to delete anything if we have a selection.
2174 if (cur.selection())
2177 bool need_anchor_change = false;
2178 bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
2179 need_anchor_change);
2181 if (need_anchor_change)
2189 buffer_.updateBuffer();
2190 buffer_.changed(true);
2195 bool BufferView::mouseSetCursor(Cursor & cur, bool select)
2197 LASSERT(&cur.bv() == this, /**/);
2200 // this event will clear selection so we save selection for
2201 // persistent selection
2202 cap::saveSelection(cursor());
2204 d->cursor_.macroModeClose();
2206 // Has the cursor just left the inset?
2207 bool leftinset = (&d->cursor_.inset() != &cur.inset());
2209 d->cursor_.fixIfBroken();
2211 // FIXME: shift-mouse selection doesn't work well across insets.
2212 bool do_selection = select && &d->cursor_.normalAnchor().inset() == &cur.inset();
2214 // do the dEPM magic if needed
2215 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
2216 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
2217 // the leftinset bool would not be necessary (badcursor instead).
2218 bool update = leftinset;
2219 if (!do_selection && d->cursor_.inTexted())
2220 update |= checkDepm(cur, d->cursor_);
2223 d->cursor_.resetAnchor();
2224 d->cursor_.setCursor(cur);
2225 d->cursor_.boundary(cur.boundary());
2227 d->cursor_.setSelection();
2229 d->cursor_.clearSelection();
2231 d->cursor_.finishUndo();
2232 d->cursor_.setCurrentFont();
2237 void BufferView::putSelectionAt(DocIterator const & cur,
2238 int length, bool backwards)
2240 d->cursor_.clearSelection();
2246 d->cursor_.pos() += length;
2247 d->cursor_.setSelection(d->cursor_, -length);
2249 d->cursor_.setSelection(d->cursor_, length);
2251 // Ensure a redraw happens in any case because the new selection could
2252 // possibly be on the same screen as the previous selection.
2253 processUpdateFlags(Update::Force | Update::FitCursor);
2257 Cursor & BufferView::cursor()
2263 Cursor const & BufferView::cursor() const
2269 pit_type BufferView::anchor_ref() const
2271 return d->anchor_pit_;
2275 bool BufferView::singleParUpdate()
2277 Text & buftext = buffer_.text();
2278 pit_type const bottom_pit = d->cursor_.bottom().pit();
2279 TextMetrics & tm = textMetrics(&buftext);
2280 int old_height = tm.parMetrics(bottom_pit).height();
2282 // make sure inline completion pointer is ok
2283 if (d->inlineCompletionPos_.fixIfBroken())
2284 d->inlineCompletionPos_ = DocIterator();
2286 // In Single Paragraph mode, rebreak only
2287 // the (main text, not inset!) paragraph containing the cursor.
2288 // (if this paragraph contains insets etc., rebreaking will
2289 // recursively descend)
2290 tm.redoParagraph(bottom_pit);
2291 ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
2292 if (pm.height() != old_height)
2293 // Paragraph height has changed so we cannot proceed to
2294 // the singlePar optimisation.
2297 d->update_strategy_ = SingleParUpdate;
2299 LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
2300 << " y2: " << pm.position() + pm.descent()
2301 << " pit: " << bottom_pit
2302 << " singlepar: 1");
2307 void BufferView::updateMetrics()
2309 if (height_ == 0 || width_ == 0)
2312 Text & buftext = buffer_.text();
2313 pit_type const npit = int(buftext.paragraphs().size());
2315 // Clear out the position cache in case of full screen redraw,
2316 d->coord_cache_.clear();
2318 // Clear out paragraph metrics to avoid having invalid metrics
2319 // in the cache from paragraphs not relayouted below
2320 // The complete text metrics will be redone.
2321 d->text_metrics_.clear();
2323 TextMetrics & tm = textMetrics(&buftext);
2325 // make sure inline completion pointer is ok
2326 if (d->inlineCompletionPos_.fixIfBroken())
2327 d->inlineCompletionPos_ = DocIterator();
2329 if (d->anchor_pit_ >= npit)
2330 // The anchor pit must have been deleted...
2331 d->anchor_pit_ = npit - 1;
2333 // Rebreak anchor paragraph.
2334 tm.redoParagraph(d->anchor_pit_);
2335 ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
2338 if (d->anchor_pit_ == 0) {
2339 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
2341 // Complete buffer visible? Then it's easy.
2342 if (scrollRange == 0)
2343 d->anchor_ypos_ = anchor_pm.ascent();
2345 // FIXME: Some clever handling needed to show
2346 // the _first_ paragraph up to the top if the cursor is
2347 // in the first line.
2349 anchor_pm.setPosition(d->anchor_ypos_);
2351 LYXERR(Debug::PAINTING, "metrics: "
2352 << " anchor pit = " << d->anchor_pit_
2353 << " anchor ypos = " << d->anchor_ypos_);
2355 // Redo paragraphs above anchor if necessary.
2356 int y1 = d->anchor_ypos_ - anchor_pm.ascent();
2357 // We are now just above the anchor paragraph.
2358 pit_type pit1 = d->anchor_pit_ - 1;
2359 for (; pit1 >= 0 && y1 >= 0; --pit1) {
2360 tm.redoParagraph(pit1);
2361 ParagraphMetrics & pm = tm.par_metrics_[pit1];
2363 // Save the paragraph position in the cache.
2368 // Redo paragraphs below the anchor if necessary.
2369 int y2 = d->anchor_ypos_ + anchor_pm.descent();
2370 // We are now just below the anchor paragraph.
2371 pit_type pit2 = d->anchor_pit_ + 1;
2372 for (; pit2 < npit && y2 <= height_; ++pit2) {
2373 tm.redoParagraph(pit2);
2374 ParagraphMetrics & pm = tm.par_metrics_[pit2];
2376 // Save the paragraph position in the cache.
2381 LYXERR(Debug::PAINTING, "Metrics: "
2382 << " anchor pit = " << d->anchor_pit_
2383 << " anchor ypos = " << d->anchor_ypos_
2386 << " pit1 = " << pit1
2387 << " pit2 = " << pit2);
2389 d->update_strategy_ = FullScreenUpdate;
2391 if (lyxerr.debugging(Debug::WORKAREA)) {
2392 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
2393 d->coord_cache_.dump();
2398 void BufferView::insertLyXFile(FileName const & fname)
2400 LASSERT(d->cursor_.inTexted(), /**/);
2402 // Get absolute path of file and add ".lyx"
2403 // to the filename if necessary
2404 FileName filename = fileSearch(string(), fname.absFileName(), "lyx");
2406 docstring const disp_fn = makeDisplayPath(filename.absFileName());
2407 // emit message signal.
2408 message(bformat(_("Inserting document %1$s..."), disp_fn));
2411 Buffer buf("", false);
2412 if (buf.loadLyXFile(filename)) {
2413 ErrorList & el = buffer_.errorList("Parse");
2414 // Copy the inserted document error list into the current buffer one.
2415 el = buf.errorList("Parse");
2416 buffer_.undo().recordUndo(d->cursor_);
2417 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
2418 buf.params().documentClassPtr(), el);
2419 res = _("Document %1$s inserted.");
2421 res = _("Could not insert document %1$s");
2424 buffer_.changed(true);
2425 // emit message signal.
2426 message(bformat(res, disp_fn));
2427 buffer_.errors("Parse");
2431 Point BufferView::coordOffset(DocIterator const & dit, bool boundary) const
2437 // Addup contribution of nested insets, from inside to outside,
2438 // keeping the outer paragraph for a special handling below
2439 for (size_t i = dit.depth() - 1; i >= 1; --i) {
2440 CursorSlice const & sl = dit[i];
2444 // get relative position inside sl.inset()
2445 sl.inset().cursorPos(*this, sl, boundary && (i + 1 == dit.depth()), xx, yy);
2447 // Make relative position inside of the edited inset relative to sl.inset()
2451 // In case of an RTL inset, the edited inset will be positioned to the left
2454 bool boundary_i = boundary && i + 1 == dit.depth();
2455 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2460 // remember width for the case that sl.inset() is positioned in an RTL inset
2461 if (i && dit[i - 1].text()) {
2462 // If this Inset is inside a Text Inset, retrieve the Dimension
2463 // from the containing text instead of using Inset::dimension() which
2464 // might not be implemented.
2465 // FIXME (Abdel 23/09/2007): this is a bit messy because of the
2466 // elimination of Inset::dim_ cache. This coordOffset() method needs
2467 // to be rewritten in light of the new design.
2468 Dimension const & dim = parMetrics(dit[i - 1].text(),
2469 dit[i - 1].pit()).insetDimension(&sl.inset());
2472 Dimension const dim = sl.inset().dimension(*this);
2476 //lyxerr << "Cursor::getPos, i: "
2477 // << i << " x: " << xx << " y: " << y << endl;
2480 // Add contribution of initial rows of outermost paragraph
2481 CursorSlice const & sl = dit[0];
2482 TextMetrics const & tm = textMetrics(sl.text());
2483 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2484 LASSERT(!pm.rows().empty(), /**/);
2485 y -= pm.rows()[0].ascent();
2487 // FIXME: document this mess
2489 if (sl.pos() > 0 && dit.depth() == 1) {
2491 if (pos && boundary)
2493 // lyxerr << "coordOffset: boundary:" << boundary << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
2494 rend = pm.pos2row(pos);
2496 rend = pm.pos2row(sl.pos());
2498 size_t rend = pm.pos2row(sl.pos());
2500 for (size_t rit = 0; rit != rend; ++rit)
2501 y += pm.rows()[rit].height();
2502 y += pm.rows()[rend].ascent();
2504 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
2506 // Make relative position from the nested inset now bufferview absolute.
2507 int xx = bottom_tm.cursorX(dit.bottom(), boundary && dit.depth() == 1);
2510 // In the RTL case place the nested inset at the left of the cursor in
2511 // the outer paragraph
2512 bool boundary_1 = boundary && 1 == dit.depth();
2513 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
2521 Point BufferView::getPos(DocIterator const & dit, bool boundary) const
2523 if (!paragraphVisible(dit))
2524 return Point(-1, -1);
2526 CursorSlice const & bot = dit.bottom();
2527 TextMetrics const & tm = textMetrics(bot.text());
2529 Point p = coordOffset(dit, boundary); // offset from outer paragraph
2530 p.y_ += tm.parMetrics(bot.pit()).position();
2535 bool BufferView::paragraphVisible(DocIterator const & dit) const
2537 CursorSlice const & bot = dit.bottom();
2538 TextMetrics const & tm = textMetrics(bot.text());
2540 return tm.contains(bot.pit());
2544 void BufferView::cursorPosAndHeight(Point & p, int & h) const
2546 Cursor const & cur = cursor();
2547 Font const font = cur.getFont();
2548 frontend::FontMetrics const & fm = theFontMetrics(font);
2549 int const asc = fm.maxAscent();
2550 int const des = fm.maxDescent();
2552 p = getPos(cur, cur.boundary());
2557 bool BufferView::cursorInView(Point const & p, int h) const
2559 Cursor const & cur = cursor();
2560 // does the cursor touch the screen ?
2561 if (p.y_ + h < 0 || p.y_ >= workHeight() || !paragraphVisible(cur))
2567 void BufferView::draw(frontend::Painter & pain)
2569 if (height_ == 0 || width_ == 0)
2571 LYXERR(Debug::PAINTING, "\t\t*** START DRAWING ***");
2573 Text & text = buffer_.text();
2574 TextMetrics const & tm = d->text_metrics_[&text];
2575 int const y = tm.first().second->position();
2576 PainterInfo pi(this, pain);
2578 switch (d->update_strategy_) {
2580 case NoScreenUpdate:
2581 // If no screen painting is actually needed, only some the different
2582 // coordinates of insets and paragraphs needs to be updated.
2583 pi.full_repaint = true;
2584 pi.pain.setDrawingEnabled(false);
2588 case SingleParUpdate:
2589 pi.full_repaint = false;
2590 // In general, only the current row of the outermost paragraph
2591 // will be redrawn. Particular cases where selection spans
2592 // multiple paragraph are correctly detected in TextMetrics.
2596 case DecorationUpdate:
2597 // FIXME: We should also distinguish DecorationUpdate to avoid text
2598 // drawing if possible. This is not possible to do easily right now
2599 // because of the single backing pixmap.
2601 case FullScreenUpdate:
2602 // The whole screen, including insets, will be refreshed.
2603 pi.full_repaint = true;
2605 // Clear background.
2606 pain.fillRectangle(0, 0, width_, height_,
2607 pi.backgroundColor(&buffer_.inset()));
2612 // and possibly grey out below
2613 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2614 int const y2 = lastpm.second->position() + lastpm.second->descent();
2617 Color color = buffer().isInternal()
2618 ? Color_background : Color_bottomarea;
2619 pain.fillRectangle(0, y2, width_, height_ - y2, color);
2623 LYXERR(Debug::PAINTING, "\n\t\t*** END DRAWING ***");
2625 // The scrollbar needs an update.
2628 // Normalize anchor for next time
2629 pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
2630 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2631 for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
2632 ParagraphMetrics const & pm = tm.parMetrics(pit);
2633 if (pm.position() + pm.descent() > 0) {
2634 d->anchor_pit_ = pit;
2635 d->anchor_ypos_ = pm.position();
2639 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
2640 << " anchor ypos = " << d->anchor_ypos_);
2644 void BufferView::message(docstring const & msg)
2647 d->gui_->message(msg);
2651 void BufferView::showDialog(string const & name)
2654 d->gui_->showDialog(name, string());
2658 void BufferView::showDialog(string const & name,
2659 string const & data, Inset * inset)
2662 d->gui_->showDialog(name, data, inset);
2666 void BufferView::updateDialog(string const & name, string const & data)
2669 d->gui_->updateDialog(name, data);
2673 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
2679 // FIXME: Move this out of BufferView again
2680 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
2682 if (!fname.isReadableFile()) {
2683 docstring const error = from_ascii(strerror(errno));
2684 docstring const file = makeDisplayPath(fname.absFileName(), 50);
2685 docstring const text =
2686 bformat(_("Could not read the specified document\n"
2687 "%1$s\ndue to the error: %2$s"), file, error);
2688 Alert::error(_("Could not read file"), text);
2692 if (!fname.isReadableFile()) {
2693 docstring const file = makeDisplayPath(fname.absFileName(), 50);
2694 docstring const text =
2695 bformat(_("%1$s\n is not readable."), file);
2696 Alert::error(_("Could not open file"), text);
2700 // FIXME UNICODE: We don't know the encoding of the file
2701 docstring file_content = fname.fileContents("UTF-8");
2702 if (file_content.empty()) {
2703 Alert::error(_("Reading not UTF-8 encoded file"),
2704 _("The file is not UTF-8 encoded.\n"
2705 "It will be read as local 8Bit-encoded.\n"
2706 "If this does not give the correct result\n"
2707 "then please change the encoding of the file\n"
2708 "to UTF-8 with a program other than LyX.\n"));
2709 file_content = fname.fileContents("local8bit");
2712 return normalize_c(file_content);
2716 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
2718 docstring const tmpstr = contentsOfPlaintextFile(f);
2723 Cursor & cur = cursor();
2724 cap::replaceSelection(cur);
2725 buffer_.undo().recordUndo(cur);
2727 cur.innerText()->insertStringAsParagraphs(cur, tmpstr, cur.current_font);
2729 cur.innerText()->insertStringAsLines(cur, tmpstr, cur.current_font);
2731 buffer_.changed(true);
2735 docstring const & BufferView::inlineCompletion() const
2737 return d->inlineCompletion_;
2741 size_t const & BufferView::inlineCompletionUniqueChars() const
2743 return d->inlineCompletionUniqueChars_;
2747 DocIterator const & BufferView::inlineCompletionPos() const
2749 return d->inlineCompletionPos_;
2753 bool samePar(DocIterator const & a, DocIterator const & b)
2755 if (a.empty() && b.empty())
2757 if (a.empty() || b.empty())
2759 if (a.depth() != b.depth())
2761 return &a.innerParagraph() == &b.innerParagraph();
2765 void BufferView::setInlineCompletion(Cursor & cur, DocIterator const & pos,
2766 docstring const & completion, size_t uniqueChars)
2768 uniqueChars = min(completion.size(), uniqueChars);
2769 bool changed = d->inlineCompletion_ != completion
2770 || d->inlineCompletionUniqueChars_ != uniqueChars;
2771 bool singlePar = true;
2772 d->inlineCompletion_ = completion;
2773 d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
2775 //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
2778 DocIterator const & old = d->inlineCompletionPos_;
2780 //lyxerr << "inlineCompletionPos changed" << std::endl;
2781 // old or pos are in another paragraph?
2782 if ((!samePar(cur, pos) && !pos.empty())
2783 || (!samePar(cur, old) && !old.empty())) {
2785 //lyxerr << "different paragraph" << std::endl;
2787 d->inlineCompletionPos_ = pos;
2792 if (singlePar && !(cur.result().update() & Update::Force))
2793 cur.updateFlags(cur.result().update() | Update::SinglePar);
2795 cur.updateFlags(cur.result().update() | Update::Force);