3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Alfredo Braunstein
7 * \author Lars Gullik Bjønnes
10 * \author Jürgen Vigna
12 * Full author contact details are available in file CREDITS.
17 #include "BufferView.h"
19 #include "BranchList.h"
21 #include "buffer_funcs.h"
22 #include "BufferList.h"
23 #include "BufferParams.h"
24 #include "CoordCache.h"
26 #include "CutAndPaste.h"
27 #include "DispatchResult.h"
28 #include "ErrorList.h"
30 #include "FloatList.h"
31 #include "FuncRequest.h"
32 #include "FuncStatus.h"
34 #include "InsetIterator.h"
36 #include "LaTeXFeatures.h"
37 #include "LayoutFile.h"
40 #include "LyXAction.h"
45 #include "MetricsInfo.h"
46 #include "Paragraph.h"
47 #include "ParagraphParameters.h"
48 #include "ParIterator.h"
51 #include "TextClass.h"
52 #include "TextMetrics.h"
54 #include "TocBackend.h"
56 #include "WordLangTuple.h"
58 #include "insets/InsetBibtex.h"
59 #include "insets/InsetCommand.h" // ChangeRefs
60 #include "insets/InsetExternal.h"
61 #include "insets/InsetGraphics.h"
62 #include "insets/InsetRef.h"
63 #include "insets/InsetText.h"
64 #include "insets/InsetNote.h"
66 #include "frontends/alert.h"
67 #include "frontends/Application.h"
68 #include "frontends/Delegates.h"
69 #include "frontends/FontMetrics.h"
70 #include "frontends/Painter.h"
71 #include "frontends/Selection.h"
73 #include "graphics/Previews.h"
75 #include "support/convert.h"
76 #include "support/debug.h"
77 #include "support/ExceptionMessage.h"
78 #include "support/filetools.h"
79 #include "support/gettext.h"
80 #include "support/lstrings.h"
81 #include "support/Package.h"
82 #include "support/types.h"
92 using namespace lyx::support;
96 namespace Alert = frontend::Alert;
100 /// Return an inset of this class if it exists at the current cursor position
102 T * getInsetByCode(Cursor const & cur, InsetCode code)
104 DocIterator it = cur;
105 Inset * inset = it.nextInset();
106 if (inset && inset->lyxCode() == code)
107 return static_cast<T*>(inset);
112 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
115 bool findNextInset(DocIterator & dit, vector<InsetCode> const & codes,
116 docstring const & contents)
118 DocIterator tmpdit = dit;
121 Inset const * inset = tmpdit.nextInset();
123 && std::find(codes.begin(), codes.end(), inset->lyxCode()) != codes.end()
124 && (contents.empty() ||
125 static_cast<InsetCommand const *>(inset)->getFirstNonOptParam() == contents)) {
129 tmpdit.forwardInset();
136 /// Looks for next inset with one of the given codes.
137 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
141 DocIterator tmpdit = dit;
142 tmpdit.forwardInset();
147 Inset const * inset = tmpdit.nextInset();
149 && std::find(codes.begin(), codes.end(), inset->lyxCode()) != codes.end()) {
150 contents = static_cast<InsetCommand const *>(inset)->getFirstNonOptParam();
154 if (!findNextInset(tmpdit, codes, contents)) {
155 if (dit.depth() != 1 || dit.pit() != 0 || dit.pos() != 0) {
156 Inset * inset = &tmpdit.bottom().inset();
157 tmpdit = doc_iterator_begin(&inset->buffer(), inset);
158 if (!findNextInset(tmpdit, codes, contents))
170 /// Looks for next inset with the given code
171 void findInset(DocIterator & dit, InsetCode code, bool same_content)
173 findInset(dit, vector<InsetCode>(1, code), same_content);
177 /// Moves cursor to the next inset with one of the given codes.
178 void gotoInset(BufferView * bv, vector<InsetCode> const & codes,
181 Cursor tmpcur = bv->cursor();
182 if (!findInset(tmpcur, codes, same_content)) {
183 bv->cursor().message(_("No more insets"));
187 tmpcur.clearSelection();
188 bv->setCursor(tmpcur);
193 /// Moves cursor to the next inset with given code.
194 void gotoInset(BufferView * bv, InsetCode code, bool same_content)
196 gotoInset(bv, vector<InsetCode>(1, code), same_content);
200 /// A map from a Text to the associated text metrics
201 typedef map<Text const *, TextMetrics> TextMetricsCache;
203 enum ScreenUpdateStrategy {
213 /////////////////////////////////////////////////////////////////////
217 /////////////////////////////////////////////////////////////////////
219 struct BufferView::Private
221 Private(BufferView & bv): wh_(0), cursor_(bv),
222 anchor_pit_(0), anchor_ypos_(0),
223 inlineCompletionUniqueChars_(0),
224 last_inset_(0), bookmark_edit_position_(0), gui_(0)
228 ScrollbarParameters scrollbarParameters_;
230 ScreenUpdateStrategy update_strategy_;
232 CoordCache coord_cache_;
234 /// Estimated average par height for scrollbar.
236 /// this is used to handle XSelection events in the right manner.
245 pit_type anchor_pit_;
249 vector<int> par_height_;
252 DocIterator inlineCompletionPos_;
254 docstring inlineCompletion_;
256 size_t inlineCompletionUniqueChars_;
258 /// keyboard mapping object.
261 /// last visited inset.
262 /** kept to send setMouseHover(false).
263 * Not owned, so don't delete.
267 // cache for id of the paragraph which was edited the last time
268 int bookmark_edit_position_;
270 mutable TextMetricsCache text_metrics_;
273 /** Not owned, so don't delete.
275 frontend::GuiBufferViewDelegate * gui_;
277 /// Cache for Find Next
278 FuncRequest search_request_cache_;
282 BufferView::BufferView(Buffer & buf)
283 : width_(0), height_(0), full_screen_(false), buffer_(buf),
284 d(new Private(*this))
286 d->xsel_cache_.set = false;
287 d->intl_.initKeyMapper(lyxrc.use_kbmap);
289 d->cursor_.setBuffer(&buf);
290 d->cursor_.push(buffer_.inset());
291 d->cursor_.resetAnchor();
292 d->cursor_.setCurrentFont();
294 if (graphics::Previews::status() != LyXRC::PREVIEW_OFF)
295 thePreviews().generateBufferPreviews(buffer_);
299 BufferView::~BufferView()
301 // current buffer is going to be switched-off, save cursor pos
302 // Ideally, the whole cursor stack should be saved, but session
303 // currently can only handle bottom (whole document) level pit and pos.
304 // That is to say, if a cursor is in a nested inset, it will be
305 // restore to the left of the top level inset.
306 LastFilePosSection::FilePos fp;
307 fp.pit = d->cursor_.bottom().pit();
308 fp.pos = d->cursor_.bottom().pos();
309 theSession().lastFilePos().save(buffer_.fileName(), fp);
315 int BufferView::rightMargin() const
317 // The additional test for the case the outliner is opened.
319 !lyxrc.full_screen_limit ||
320 width_ < lyxrc.full_screen_width + 20)
323 return (width_ - lyxrc.full_screen_width) / 2;
327 int BufferView::leftMargin() const
329 return rightMargin();
333 bool BufferView::isTopScreen() const
335 return d->scrollbarParameters_.position == d->scrollbarParameters_.min;
339 bool BufferView::isBottomScreen() const
341 return d->scrollbarParameters_.position == d->scrollbarParameters_.max;
345 Intl & BufferView::getIntl()
351 Intl const & BufferView::getIntl() const
357 CoordCache & BufferView::coordCache()
359 return d->coord_cache_;
363 CoordCache const & BufferView::coordCache() const
365 return d->coord_cache_;
369 Buffer & BufferView::buffer()
375 Buffer const & BufferView::buffer() const
381 bool BufferView::fitCursor()
383 if (cursorStatus(d->cursor_) == CUR_INSIDE) {
384 frontend::FontMetrics const & fm =
385 theFontMetrics(d->cursor_.getFont().fontInfo());
386 int const asc = fm.maxAscent();
387 int const des = fm.maxDescent();
388 Point const p = getPos(d->cursor_, d->cursor_.boundary());
389 if (p.y_ - asc >= 0 && p.y_ + des < height_)
396 void BufferView::processUpdateFlags(Update::flags flags)
398 // last_inset_ points to the last visited inset. This pointer may become
399 // invalid because of keyboard editing. Since all such operations
400 // causes screen update(), I reset last_inset_ to avoid such a problem.
402 // This is close to a hot-path.
403 LYXERR(Debug::DEBUG, "BufferView::processUpdateFlags()"
404 << "[fitcursor = " << (flags & Update::FitCursor)
405 << ", forceupdate = " << (flags & Update::Force)
406 << ", singlepar = " << (flags & Update::SinglePar)
407 << "] buffer: " << &buffer_);
409 buffer_.updateMacros();
411 // Now do the first drawing step if needed. This consists on updating
412 // the CoordCache in updateMetrics().
413 // The second drawing step is done in WorkArea::redraw() if needed.
415 // Case when no explicit update is requested.
417 // no need to redraw anything.
418 d->update_strategy_ = NoScreenUpdate;
422 if (flags == Update::Decoration) {
423 d->update_strategy_ = DecorationUpdate;
428 if (flags == Update::FitCursor
429 || flags == (Update::Decoration | Update::FitCursor)) {
430 // tell the frontend to update the screen if needed.
435 if (flags & Update::Decoration) {
436 d->update_strategy_ = DecorationUpdate;
440 // no screen update is needed.
441 d->update_strategy_ = NoScreenUpdate;
445 bool const full_metrics = flags & Update::Force || !singleParUpdate();
448 // We have to update the full screen metrics.
451 if (!(flags & Update::FitCursor)) {
452 // Nothing to do anymore. Trigger a redraw and return
457 // updateMetrics() does not update paragraph position
458 // This is done at draw() time. So we need a redraw!
462 // The cursor is off screen so ensure it is visible.
469 void BufferView::updateScrollbar()
471 if (height_ == 0 && width_ == 0)
474 // We prefer fixed size line scrolling.
475 d->scrollbarParameters_.single_step = defaultRowHeight();
476 // We prefer full screen page scrolling.
477 d->scrollbarParameters_.page_step = height_;
479 Text & t = buffer_.text();
480 TextMetrics & tm = d->text_metrics_[&t];
482 LYXERR(Debug::GUI, " Updating scrollbar: height: "
483 << t.paragraphs().size()
484 << " curr par: " << d->cursor_.bottom().pit()
485 << " default height " << defaultRowHeight());
487 size_t const parsize = t.paragraphs().size();
488 if (d->par_height_.size() != parsize) {
489 d->par_height_.clear();
490 // FIXME: We assume a default paragraph height of 2 rows. This
491 // should probably be pondered with the screen width.
492 d->par_height_.resize(parsize, defaultRowHeight() * 2);
495 // Look at paragraph heights on-screen
496 pair<pit_type, ParagraphMetrics const *> first = tm.first();
497 pair<pit_type, ParagraphMetrics const *> last = tm.last();
498 for (pit_type pit = first.first; pit <= last.first; ++pit) {
499 d->par_height_[pit] = tm.parMetrics(pit).height();
500 LYXERR(Debug::SCROLLING, "storing height for pit " << pit << " : "
501 << d->par_height_[pit]);
504 int top_pos = first.second->position() - first.second->ascent();
505 int bottom_pos = last.second->position() + last.second->descent();
506 bool first_visible = first.first == 0 && top_pos >= 0;
507 bool last_visible = last.first + 1 == int(parsize) && bottom_pos <= height_;
508 if (first_visible && last_visible) {
509 d->scrollbarParameters_.min = 0;
510 d->scrollbarParameters_.max = 0;
514 d->scrollbarParameters_.min = top_pos;
515 for (size_t i = 0; i != size_t(first.first); ++i)
516 d->scrollbarParameters_.min -= d->par_height_[i];
517 d->scrollbarParameters_.max = bottom_pos;
518 for (size_t i = last.first + 1; i != parsize; ++i)
519 d->scrollbarParameters_.max += d->par_height_[i];
521 d->scrollbarParameters_.position = 0;
522 // The reference is the top position so we remove one page.
523 if (lyxrc.scroll_below_document)
524 d->scrollbarParameters_.max -= minVisiblePart();
526 d->scrollbarParameters_.max -= d->scrollbarParameters_.page_step;
530 ScrollbarParameters const & BufferView::scrollbarParameters() const
532 return d->scrollbarParameters_;
536 docstring BufferView::toolTip(int x, int y) const
538 // Get inset under mouse, if there is one.
539 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
541 // No inset, no tooltip...
543 return covering_inset->toolTip(*this, x, y);
547 docstring BufferView::contextMenu(int x, int y) const
549 //If there is a selection, return the containing inset menu
550 if (d->cursor_.selection())
551 return d->cursor_.inset().contextMenu(*this, x, y);
553 // Get inset under mouse, if there is one.
554 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
556 return covering_inset->contextMenu(*this, x, y);
558 return buffer_.inset().contextMenu(*this, x, y);
562 void BufferView::scrollDocView(int value)
564 int const offset = value - d->scrollbarParameters_.position;
566 // No scrolling at all? No need to redraw anything
570 // If the offset is less than 2 screen height, prefer to scroll instead.
571 if (abs(offset) <= 2 * height_) {
572 d->anchor_ypos_ -= offset;
578 // cut off at the top
579 if (value <= d->scrollbarParameters_.min) {
580 DocIterator dit = doc_iterator_begin(&buffer_);
582 LYXERR(Debug::SCROLLING, "scroll to top");
586 // cut off at the bottom
587 if (value >= d->scrollbarParameters_.max) {
588 DocIterator dit = doc_iterator_end(&buffer_);
591 LYXERR(Debug::SCROLLING, "scroll to bottom");
595 // find paragraph at target position
596 int par_pos = d->scrollbarParameters_.min;
598 for (; i != int(d->par_height_.size()); ++i) {
599 par_pos += d->par_height_[i];
600 if (par_pos >= value)
604 if (par_pos < value) {
605 // It seems we didn't find the correct pit so stay on the safe side and
607 LYXERR0("scrolling position not found!");
608 scrollDocView(d->scrollbarParameters_.max);
612 DocIterator dit = doc_iterator_begin(&buffer_);
614 LYXERR(Debug::SCROLLING, "value = " << value << " -> scroll to pit " << i);
619 // FIXME: this method is not working well.
620 void BufferView::setCursorFromScrollbar()
622 TextMetrics & tm = d->text_metrics_[&buffer_.text()];
624 int const height = 2 * defaultRowHeight();
625 int const first = height;
626 int const last = height_ - height;
628 Cursor const & oldcur = d->cursor_;
630 switch (cursorStatus(oldcur)) {
638 int const y = getPos(oldcur, oldcur.boundary()).y_;
639 newy = min(last, max(y, first));
643 // We reset the cursor because cursorStatus() does not
644 // work when the cursor is within mathed.
646 cur.reset(buffer_.inset());
647 tm.setCursorFromCoordinates(cur, 0, newy);
649 // update the bufferview cursor and notify insets
650 // FIXME: Care about the d->cursor_ flags to redraw if needed
651 Cursor old = d->cursor_;
653 bool badcursor = notifyCursorLeavesOrEnters(old, d->cursor_);
655 d->cursor_.fixIfBroken();
659 Change const BufferView::getCurrentChange() const
661 if (!d->cursor_.selection())
662 return Change(Change::UNCHANGED);
664 DocIterator dit = d->cursor_.selectionBegin();
665 return dit.paragraph().lookupChange(dit.pos());
669 // this could be used elsewhere as well?
670 // FIXME: This does not work within mathed!
671 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
673 Point const p = getPos(dit, dit.boundary());
676 if (p.y_ > workHeight())
682 void BufferView::bookmarkEditPosition()
684 // Don't eat cpu time for each keystroke
685 if (d->cursor_.paragraph().id() == d->bookmark_edit_position_)
688 d->bookmark_edit_position_ = d->cursor_.paragraph().id();
692 void BufferView::saveBookmark(unsigned int idx)
694 // tentatively save bookmark, id and pos will be used to
695 // acturately locate a bookmark in a 'live' lyx session.
696 // pit and pos will be updated with bottom level pit/pos
698 theSession().bookmarks().save(
700 d->cursor_.bottom().pit(),
701 d->cursor_.bottom().pos(),
702 d->cursor_.paragraph().id(),
707 // emit message signal.
708 message(_("Save bookmark"));
712 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
713 int top_id, pos_type top_pos)
715 bool success = false;
718 d->cursor_.clearSelection();
720 // if a valid par_id is given, try it first
721 // This is the case for a 'live' bookmark when unique paragraph ID
722 // is used to track bookmarks.
724 dit = buffer_.getParFromID(top_id);
726 dit.pos() = min(dit.paragraph().size(), top_pos);
727 // Some slices of the iterator may not be
728 // reachable (e.g. closed collapsable inset)
729 // so the dociterator may need to be
730 // shortened. Otherwise, setCursor may crash
731 // lyx when the cursor can not be set to these
733 size_t const n = dit.depth();
734 for (size_t i = 0; i < n; ++i)
735 if (!dit[i].inset().editable()) {
743 // if top_id == 0, or searching through top_id failed
744 // This is the case for a 'restored' bookmark when only bottom
745 // (document level) pit was saved. Because of this, bookmark
746 // restoration is inaccurate. If a bookmark was within an inset,
747 // it will be restored to the left of the outmost inset that contains
749 if (bottom_pit < int(buffer_.paragraphs().size())) {
750 dit = doc_iterator_begin(&buffer_);
752 dit.pit() = bottom_pit;
753 dit.pos() = min(bottom_pos, dit.paragraph().size());
758 // Note: only bottom (document) level pit is set.
760 // set the current font.
761 d->cursor_.setCurrentFont();
762 // To center the screen on this new position we need the
763 // paragraph position which is computed at draw() time.
764 // So we need a redraw!
774 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
776 if (lyxrc.rtl_support) {
777 if (d->cursor_.real_current_font.isRightToLeft()) {
778 if (d->intl_.keymap == Intl::PRIMARY)
779 d->intl_.keyMapSec();
781 if (d->intl_.keymap == Intl::SECONDARY)
782 d->intl_.keyMapPrim();
786 d->intl_.getTransManager().translateAndInsert(c, t, cur);
790 int BufferView::workWidth() const
796 void BufferView::recenter()
798 showCursor(d->cursor_, true);
802 void BufferView::showCursor()
804 showCursor(d->cursor_, false);
808 void BufferView::showCursor(DocIterator const & dit, bool recenter)
810 if (scrollToCursor(dit, recenter))
815 void BufferView::scrollToCursor()
817 scrollToCursor(d->cursor_, false);
821 bool BufferView::scrollToCursor(DocIterator const & dit, bool recenter)
823 // We are not properly started yet, delay until resizing is
828 LYXERR(Debug::SCROLLING, "recentering!");
830 CursorSlice const & bot = dit.bottom();
831 TextMetrics & tm = d->text_metrics_[bot.text()];
833 pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
834 int bot_pit = bot.pit();
835 if (bot_pit > max_pit) {
836 // FIXME: Why does this happen?
837 LYXERR0("bottom pit is greater that max pit: "
838 << bot_pit << " > " << max_pit);
842 if (bot_pit == tm.first().first - 1)
843 tm.newParMetricsUp();
844 else if (bot_pit == tm.last().first + 1)
845 tm.newParMetricsDown();
847 if (tm.contains(bot_pit)) {
848 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
849 LASSERT(!pm.rows().empty(), /**/);
850 // FIXME: smooth scrolling doesn't work in mathed.
851 CursorSlice const & cs = dit.innerTextSlice();
852 int offset = coordOffset(dit, dit.boundary()).y_;
853 int ypos = pm.position() + offset;
854 Dimension const & row_dim =
855 pm.getRow(cs.pos(), dit.boundary()).dimension();
858 scrolled = scroll(ypos - height_/2);
859 else if (ypos - row_dim.ascent() < 0)
860 scrolled = scrollUp(- ypos + row_dim.ascent());
861 else if (ypos + row_dim.descent() > height_)
862 scrolled = scrollDown(ypos - height_ + defaultRowHeight() );
864 // else, nothing to do, the cursor is already visible so we just return.
872 // fix inline completion position
873 if (d->inlineCompletionPos_.fixIfBroken())
874 d->inlineCompletionPos_ = DocIterator();
876 tm.redoParagraph(bot_pit);
877 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
878 int offset = coordOffset(dit, dit.boundary()).y_;
880 d->anchor_pit_ = bot_pit;
881 CursorSlice const & cs = dit.innerTextSlice();
882 Dimension const & row_dim =
883 pm.getRow(cs.pos(), dit.boundary()).dimension();
886 d->anchor_ypos_ = height_/2;
887 else if (d->anchor_pit_ == 0)
888 d->anchor_ypos_ = offset + pm.ascent();
889 else if (d->anchor_pit_ == max_pit)
890 d->anchor_ypos_ = height_ - offset - row_dim.descent();
891 else if (offset > height_)
892 d->anchor_ypos_ = height_ - offset - defaultRowHeight();
894 d->anchor_ypos_ = defaultRowHeight() * 2;
901 void BufferView::updateLayout(DocumentClass const * const oldlayout)
903 message(_("Converting document to new document class..."));
905 StableDocIterator backcur(d->cursor_);
906 ErrorList & el = buffer_.errorList("Class Switch");
907 cap::switchBetweenClasses(
908 oldlayout, buffer_.params().documentClassPtr(),
909 static_cast<InsetText &>(buffer_.inset()), el);
911 setCursor(backcur.asDocIterator(&buffer_));
913 buffer_.errors("Class Switch");
914 buffer_.updateLabels();
917 /** Return the change status at cursor position, taking in account the
918 * status at each level of the document iterator (a table in a deleted
919 * footnote is deleted).
920 * When \param outer is true, the top slice is not looked at.
922 static Change::Type lookupChangeType(DocIterator const & dit, bool outer = false)
924 size_t const depth = dit.depth() - (outer ? 1 : 0);
926 for (size_t i = 0 ; i < depth ; ++i) {
927 CursorSlice const & slice = dit[i];
928 if (!slice.inset().inMathed()
929 && slice.pos() < slice.paragraph().size()) {
930 Change::Type const ch = slice.paragraph().lookupChange(slice.pos()).type;
931 if (ch != Change::UNCHANGED)
935 return Change::UNCHANGED;
939 static bool getLocalStatus(Cursor cursor, FuncRequest const & cmd, FuncStatus & status)
941 // Try to fix cursor in case it is broken.
942 cursor.fixIfBroken();
944 // This is, of course, a mess. Better create a new doc iterator and use
945 // this in Inset::getStatus. This might require an additional
946 // BufferView * arg, though (which should be avoided)
947 //Cursor safe = *this;
949 for ( ; cursor.depth(); cursor.pop()) {
950 //lyxerr << "\nCursor::getStatus: cmd: " << cmd << endl << *this << endl;
951 LASSERT(cursor.idx() <= cursor.lastidx(), /**/);
952 LASSERT(cursor.pit() <= cursor.lastpit(), /**/);
953 LASSERT(cursor.pos() <= cursor.lastpos(), /**/);
955 // The inset's getStatus() will return 'true' if it made
956 // a definitive decision on whether it want to handle the
957 // request or not. The result of this decision is put into
958 // the 'status' parameter.
959 if (cursor.inset().getStatus(cursor, cmd, status)) {
968 bool BufferView::getStatus(FuncRequest const & cmd, FuncStatus & flag)
970 // Can we use a readonly buffer?
971 if (buffer_.isReadonly()
972 && !lyxaction.funcHasFlag(cmd.action, LyXAction::ReadOnly)
973 && !lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer)) {
974 flag.message(from_utf8(N_("Document is read-only")));
975 flag.setEnabled(false);
978 // Are we in a DELETED change-tracking region?
979 if (lookupChangeType(d->cursor_, true) == Change::DELETED
980 && !lyxaction.funcHasFlag(cmd.action, LyXAction::ReadOnly)
981 && !lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer)) {
982 flag.message(from_utf8(N_("This portion of the document is deleted.")));
983 flag.setEnabled(false);
987 Cursor & cur = d->cursor_;
989 // Is this a function that acts on inset at point?
990 Inset * inset = cur.nextInset();
991 if (lyxaction.funcHasFlag(cmd.action, LyXAction::AtPoint)
992 && inset && inset->getStatus(cur, cmd, flag))
995 if (getLocalStatus(cur, cmd, flag))
998 switch (cmd.action) {
1000 // FIXME: This is a bit problematic because we don't check is this is a
1001 // document BufferView or not for these LFUNs. We probably have to
1002 // dispatch both to currentBufferView() and, if that fails,
1003 // to documentBufferView(); same as we do know for current Buffer and
1004 // document Buffer. Ideally those LFUN should go to Buffer as they*
1005 // operate on the full Buffer and the cursor is only needed either for
1006 // an Undo record or to restore a cursor position. But we don't know
1007 // how to do that inside Buffer of course.
1008 case LFUN_BUFFER_PARAMS_APPLY:
1009 case LFUN_LAYOUT_MODULES_CLEAR:
1010 case LFUN_LAYOUT_MODULE_ADD:
1011 case LFUN_LAYOUT_RELOAD:
1012 case LFUN_TEXTCLASS_APPLY:
1013 case LFUN_TEXTCLASS_LOAD:
1014 flag.setEnabled(!buffer_.isReadonly());
1018 flag.setEnabled(buffer_.undo().hasUndoStack());
1021 flag.setEnabled(buffer_.undo().hasRedoStack());
1023 case LFUN_FILE_INSERT:
1024 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
1025 case LFUN_FILE_INSERT_PLAINTEXT:
1026 case LFUN_BOOKMARK_SAVE:
1027 // FIXME: Actually, these LFUNS should be moved to Text
1028 flag.setEnabled(cur.inTexted());
1031 case LFUN_FONT_STATE:
1032 case LFUN_LABEL_INSERT:
1033 case LFUN_INFO_INSERT:
1034 case LFUN_INSET_EDIT:
1035 case LFUN_PARAGRAPH_GOTO:
1036 case LFUN_NOTE_NEXT:
1037 case LFUN_REFERENCE_NEXT:
1038 case LFUN_WORD_FIND:
1039 case LFUN_WORD_FIND_FORWARD:
1040 case LFUN_WORD_FIND_BACKWARD:
1041 case LFUN_WORD_FINDADV:
1042 case LFUN_WORD_REPLACE:
1045 case LFUN_MARK_TOGGLE:
1046 case LFUN_SCREEN_RECENTER:
1047 case LFUN_SCREEN_SHOW_CURSOR:
1048 case LFUN_BIBTEX_DATABASE_ADD:
1049 case LFUN_BIBTEX_DATABASE_DEL:
1050 case LFUN_NOTES_MUTATE:
1051 case LFUN_ALL_INSETS_TOGGLE:
1052 case LFUN_STATISTICS:
1053 case LFUN_BRANCH_ADD_INSERT:
1054 case LFUN_KEYMAP_OFF:
1055 case LFUN_KEYMAP_PRIMARY:
1056 case LFUN_KEYMAP_SECONDARY:
1057 case LFUN_KEYMAP_TOGGLE:
1058 flag.setEnabled(true);
1061 case LFUN_REGEXP_MODE:
1062 // FIXME: Test if current WorkArea is the search WorkArea
1063 flag.setEnabled(buffer().isInternal() && !cur.inRegexped());
1066 case LFUN_LABEL_COPY_AS_REF: {
1067 // if there is an inset at cursor, see whether it
1069 Inset * inset = cur.nextInset();
1070 if (!inset || !inset->getStatus(cur, cmd, flag))
1071 flag.setEnabled(false);
1075 case LFUN_NEXT_INSET_MODIFY: {
1076 // this is the real function we want to invoke
1077 FuncRequest tmpcmd = cmd;
1078 tmpcmd.action = LFUN_INSET_MODIFY;
1079 // if there is an inset at cursor, see whether it
1080 // handles the lfun, other start from scratch
1081 Inset * inset = cur.nextInset();
1082 if (!inset || !inset->getStatus(cur, tmpcmd, flag))
1083 flag = lyx::getStatus(tmpcmd);
1087 case LFUN_LABEL_GOTO: {
1088 flag.setEnabled(!cmd.argument().empty()
1089 || getInsetByCode<InsetRef>(cur, REF_CODE));
1093 case LFUN_CHANGES_TRACK:
1094 flag.setEnabled(true);
1095 flag.setOnOff(buffer_.params().trackChanges);
1098 case LFUN_CHANGES_OUTPUT:
1099 flag.setEnabled(true);
1100 flag.setOnOff(buffer_.params().outputChanges);
1103 case LFUN_CHANGES_MERGE:
1104 case LFUN_CHANGE_NEXT:
1105 case LFUN_CHANGE_PREVIOUS:
1106 case LFUN_ALL_CHANGES_ACCEPT:
1107 case LFUN_ALL_CHANGES_REJECT:
1108 // TODO: context-sensitive enabling of LFUNs
1109 // In principle, these command should only be enabled if there
1110 // is a change in the document. However, without proper
1111 // optimizations, this will inevitably result in poor performance.
1112 flag.setEnabled(true);
1115 case LFUN_BUFFER_TOGGLE_COMPRESSION: {
1116 flag.setOnOff(buffer_.params().compressed);
1120 case LFUN_SCREEN_UP:
1121 case LFUN_SCREEN_DOWN:
1123 case LFUN_SCREEN_UP_SELECT:
1124 case LFUN_SCREEN_DOWN_SELECT:
1125 flag.setEnabled(true);
1128 case LFUN_LAYOUT_TABULAR:
1129 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
1133 flag.setEnabled(!cur.inset().forcePlainLayout(cur.idx()));
1136 case LFUN_LAYOUT_PARAGRAPH:
1137 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
1140 case LFUN_DIALOG_SHOW_NEW_INSET:
1141 // FIXME: this is wrong, but I do not understand the
1143 if (cur.inset().lyxCode() == CAPTION_CODE)
1144 return cur.inset().getStatus(cur, cmd, flag);
1145 // FIXME we should consider passthru paragraphs too.
1146 flag.setEnabled(!cur.inset().getLayout().isPassThru());
1150 flag.setEnabled(false);
1158 bool BufferView::dispatch(FuncRequest const & cmd)
1160 //lyxerr << [ cmd = " << cmd << "]" << endl;
1162 // Make sure that the cached BufferView is correct.
1163 LYXERR(Debug::ACTION, " action[" << cmd.action << ']'
1164 << " arg[" << to_utf8(cmd.argument()) << ']'
1165 << " x[" << cmd.x << ']'
1166 << " y[" << cmd.y << ']'
1167 << " button[" << cmd.button() << ']');
1169 string const argument = to_utf8(cmd.argument());
1170 Cursor & cur = d->cursor_;
1172 // Don't dispatch function that does not apply to internal buffers.
1173 if (buffer_.isInternal() && lyxaction.funcHasFlag(cmd.action, LyXAction::NoInternal))
1176 switch (cmd.action) {
1178 case LFUN_BUFFER_PARAMS_APPLY: {
1179 DocumentClass const * const oldClass = buffer_.params().documentClassPtr();
1180 cur.recordUndoFullDocument();
1181 istringstream ss(to_utf8(cmd.argument()));
1184 int const unknown_tokens = buffer_.readHeader(lex);
1185 if (unknown_tokens != 0) {
1186 LYXERR0("Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1187 << unknown_tokens << " unknown token"
1188 << (unknown_tokens == 1 ? "" : "s"));
1190 updateLayout(oldClass);
1192 // We are most certainly here because of a change in the document
1193 // It is then better to make sure that all dialogs are in sync with
1194 // current document settings.
1195 processUpdateFlags(Update::Force | Update::FitCursor);
1199 case LFUN_LAYOUT_MODULES_CLEAR: {
1200 DocumentClass const * const oldClass =
1201 buffer_.params().documentClassPtr();
1202 cur.recordUndoFullDocument();
1203 buffer_.params().clearLayoutModules();
1204 buffer_.params().makeDocumentClass();
1205 updateLayout(oldClass);
1206 processUpdateFlags(Update::Force | Update::FitCursor);
1210 case LFUN_LAYOUT_MODULE_ADD: {
1211 BufferParams const & params = buffer_.params();
1212 if (!params.moduleCanBeAdded(argument)) {
1213 LYXERR0("Module `" << argument <<
1214 "' cannot be added due to failed requirements or "
1215 "conflicts with installed modules.");
1218 DocumentClass const * const oldClass = params.documentClassPtr();
1219 cur.recordUndoFullDocument();
1220 buffer_.params().addLayoutModule(argument);
1221 buffer_.params().makeDocumentClass();
1222 updateLayout(oldClass);
1223 processUpdateFlags(Update::Force | Update::FitCursor);
1227 case LFUN_TEXTCLASS_APPLY: {
1228 if (!LayoutFileList::get().load(argument, buffer_.temppath()) &&
1229 !LayoutFileList::get().load(argument, buffer_.filePath()))
1232 LayoutFile const * old_layout = buffer_.params().baseClass();
1233 LayoutFile const * new_layout = &(LayoutFileList::get()[argument]);
1235 if (old_layout == new_layout)
1239 //Save the old, possibly modular, layout for use in conversion.
1240 DocumentClass const * const oldDocClass =
1241 buffer_.params().documentClassPtr();
1242 cur.recordUndoFullDocument();
1243 buffer_.params().setBaseClass(argument);
1244 buffer_.params().makeDocumentClass();
1245 updateLayout(oldDocClass);
1246 processUpdateFlags(Update::Force | Update::FitCursor);
1250 case LFUN_TEXTCLASS_LOAD:
1251 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1252 LayoutFileList::get().load(argument, buffer_.filePath());
1255 case LFUN_LAYOUT_RELOAD: {
1256 DocumentClass const * const oldClass = buffer_.params().documentClassPtr();
1257 LayoutFileIndex bc = buffer_.params().baseClassID();
1258 LayoutFileList::get().reset(bc);
1259 buffer_.params().setBaseClass(bc);
1260 buffer_.params().makeDocumentClass();
1261 updateLayout(oldClass);
1262 processUpdateFlags(Update::Force | Update::FitCursor);
1267 cur.message(_("Undo"));
1268 cur.clearSelection();
1269 if (!cur.textUndo())
1270 cur.message(_("No further undo information"));
1272 processUpdateFlags(Update::Force | Update::FitCursor);
1276 cur.message(_("Redo"));
1277 cur.clearSelection();
1278 if (!cur.textRedo())
1279 cur.message(_("No further redo information"));
1281 processUpdateFlags(Update::Force | Update::FitCursor);
1284 case LFUN_FONT_STATE:
1285 cur.message(cur.currentState());
1288 case LFUN_BOOKMARK_SAVE:
1289 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1292 case LFUN_LABEL_GOTO: {
1293 docstring label = cmd.argument();
1294 if (label.empty()) {
1296 getInsetByCode<InsetRef>(cur, REF_CODE);
1298 label = inset->getParam("reference");
1299 // persistent=false: use temp_bookmark
1308 case LFUN_INSET_EDIT: {
1309 FuncRequest fr(cmd);
1310 // if there is an inset at cursor, see whether it
1312 Inset * inset = cur.nextInset();
1314 inset->dispatch(cur, fr);
1315 // if it did not work, try the underlying inset.
1316 if (!inset || !cur.result().dispatched())
1319 // FIXME I'm adding the last break to solve a crash,
1320 // but that is obviously not right.
1321 if (!cur.result().dispatched())
1322 // It did not work too; no action needed.
1327 case LFUN_PARAGRAPH_GOTO: {
1328 int const id = convert<int>(cmd.getArg(0));
1329 int const pos = convert<int>(cmd.getArg(1));
1331 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1332 b = theBufferList().next(b)) {
1334 DocIterator dit = b->getParFromID(id);
1336 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1340 LYXERR(Debug::INFO, "Paragraph " << dit.paragraph().id()
1341 << " found in buffer `"
1342 << b->absFileName() << "'.");
1344 if (b == &buffer_) {
1348 processUpdateFlags(Update::Force | Update::FitCursor);
1350 // Switch to other buffer view and resend cmd
1351 theLyXFunc().dispatch(FuncRequest(
1352 LFUN_BUFFER_SWITCH, b->absFileName()));
1353 theLyXFunc().dispatch(cmd);
1360 case LFUN_NOTE_NEXT:
1361 gotoInset(this, NOTE_CODE, false);
1364 case LFUN_REFERENCE_NEXT: {
1365 vector<InsetCode> tmp;
1366 tmp.push_back(LABEL_CODE);
1367 tmp.push_back(REF_CODE);
1368 gotoInset(this, tmp, true);
1372 case LFUN_CHANGES_TRACK:
1373 buffer_.params().trackChanges = !buffer_.params().trackChanges;
1376 case LFUN_CHANGES_OUTPUT:
1377 buffer_.params().outputChanges = !buffer_.params().outputChanges;
1378 if (buffer_.params().outputChanges) {
1379 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1380 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1381 LaTeXFeatures::isAvailable("xcolor");
1383 if (!dvipost && !xcolorulem) {
1384 Alert::warning(_("Changes not shown in LaTeX output"),
1385 _("Changes will not be highlighted in LaTeX output, "
1386 "because neither dvipost nor xcolor/ulem are installed.\n"
1387 "Please install these packages or redefine "
1388 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1389 } else if (!xcolorulem) {
1390 Alert::warning(_("Changes not shown in LaTeX output"),
1391 _("Changes will not be highlighted in LaTeX output "
1392 "when using pdflatex, because xcolor and ulem are not installed.\n"
1393 "Please install both packages or redefine "
1394 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1399 case LFUN_CHANGE_NEXT:
1400 findNextChange(this);
1401 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1402 processUpdateFlags(Update::Force | Update::FitCursor);
1405 case LFUN_CHANGE_PREVIOUS:
1406 findPreviousChange(this);
1407 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1408 processUpdateFlags(Update::Force | Update::FitCursor);
1411 case LFUN_CHANGES_MERGE:
1412 if (findNextChange(this) || findPreviousChange(this)) {
1413 processUpdateFlags(Update::Force | Update::FitCursor);
1414 showDialog("changes");
1418 case LFUN_ALL_CHANGES_ACCEPT:
1419 // select complete document
1420 cur.reset(buffer_.inset());
1421 cur.selHandle(true);
1422 buffer_.text().cursorBottom(cur);
1423 // accept everything in a single step to support atomic undo
1424 buffer_.text().acceptOrRejectChanges(cur, Text::ACCEPT);
1425 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1426 processUpdateFlags(Update::Force | Update::FitCursor);
1429 case LFUN_ALL_CHANGES_REJECT:
1430 // select complete document
1431 cur.reset(buffer_.inset());
1432 cur.selHandle(true);
1433 buffer_.text().cursorBottom(cur);
1434 // reject everything in a single step to support atomic undo
1435 // Note: reject does not work recursively; the user may have to repeat the operation
1436 buffer_.text().acceptOrRejectChanges(cur, Text::REJECT);
1437 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1438 processUpdateFlags(Update::Force | Update::FitCursor);
1441 case LFUN_WORD_FIND_FORWARD:
1442 case LFUN_WORD_FIND_BACKWARD: {
1443 static docstring last_search;
1444 docstring searched_string;
1446 if (!cmd.argument().empty()) {
1447 last_search = cmd.argument();
1448 searched_string = cmd.argument();
1450 searched_string = last_search;
1453 if (searched_string.empty())
1456 bool const fw = cmd.action == LFUN_WORD_FIND_FORWARD;
1457 docstring const data =
1458 find2string(searched_string, true, false, fw);
1459 find(this, FuncRequest(LFUN_WORD_FIND, data));
1463 case LFUN_WORD_FIND: {
1464 FuncRequest req = cmd;
1465 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1466 req = d->search_request_cache_;
1467 if (req.argument().empty()) {
1468 theLyXFunc().dispatch(FuncRequest(LFUN_DIALOG_SHOW, "findreplace"));
1471 if (find(this, req))
1474 message(_("String not found!"));
1475 d->search_request_cache_ = req;
1479 case LFUN_WORD_REPLACE: {
1480 bool has_deleted = false;
1481 if (cur.selection()) {
1482 DocIterator beg = cur.selectionBegin();
1483 DocIterator end = cur.selectionEnd();
1484 if (beg.pit() == end.pit()) {
1485 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1486 if (cur.paragraph().isDeleted(p))
1491 replace(this, cmd, has_deleted);
1495 case LFUN_WORD_FINDADV:
1500 cur.clearSelection();
1501 cur.message(from_utf8(N_("Mark off")));
1505 cur.clearSelection();
1507 cur.message(from_utf8(N_("Mark on")));
1510 case LFUN_MARK_TOGGLE:
1511 cur.setSelection(false);
1514 cur.message(from_utf8(N_("Mark removed")));
1517 cur.message(from_utf8(N_("Mark set")));
1522 case LFUN_SCREEN_SHOW_CURSOR:
1526 case LFUN_SCREEN_RECENTER:
1530 case LFUN_BIBTEX_DATABASE_ADD: {
1531 Cursor tmpcur = cur;
1532 findInset(tmpcur, BIBTEX_CODE, false);
1533 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1536 if (inset->addDatabase(cmd.argument()))
1537 buffer_.updateBibfilesCache();
1542 case LFUN_BIBTEX_DATABASE_DEL: {
1543 Cursor tmpcur = cur;
1544 findInset(tmpcur, BIBTEX_CODE, false);
1545 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1548 if (inset->delDatabase(cmd.argument()))
1549 buffer_.updateBibfilesCache();
1554 case LFUN_STATISTICS: {
1555 DocIterator from, to;
1556 if (cur.selection()) {
1557 from = cur.selectionBegin();
1558 to = cur.selectionEnd();
1560 from = doc_iterator_begin(&buffer_);
1561 to = doc_iterator_end(&buffer_);
1563 int const words = countWords(from, to);
1564 int const chars = countChars(from, to, false);
1565 int const chars_blanks = countChars(from, to, true);
1567 if (cur.selection())
1568 message = _("Statistics for the selection:");
1570 message = _("Statistics for the document:");
1573 message += bformat(_("%1$d words"), words);
1575 message += _("One word");
1577 if (chars_blanks != 1)
1578 message += bformat(_("%1$d characters (including blanks)"),
1581 message += _("One character (including blanks)");
1584 message += bformat(_("%1$d characters (excluding blanks)"),
1587 message += _("One character (excluding blanks)");
1589 Alert::information(_("Statistics"), message);
1593 case LFUN_BUFFER_TOGGLE_COMPRESSION:
1594 // turn compression on/off
1595 buffer_.params().compressed = !buffer_.params().compressed;
1598 case LFUN_LABEL_COPY_AS_REF: {
1599 // if there is an inset at cursor, try to copy it
1600 Inset * inset = &cur.inset();
1601 if (!inset || !inset->asInsetMath())
1602 inset = cur.nextInset();
1604 FuncRequest tmpcmd = cmd;
1605 inset->dispatch(cur, tmpcmd);
1607 if (!cur.result().dispatched())
1608 // It did not work too; no action needed.
1610 cur.clearSelection();
1611 processUpdateFlags(Update::SinglePar | Update::FitCursor);
1615 case LFUN_NEXT_INSET_MODIFY: {
1616 // create the the real function we want to invoke
1617 FuncRequest tmpcmd = cmd;
1618 tmpcmd.action = LFUN_INSET_MODIFY;
1619 // if there is an inset at cursor, see whether it
1621 Inset * inset = cur.nextInset();
1624 inset->dispatch(cur, tmpcmd);
1626 // if it did not work, try the underlying inset.
1627 if (!inset || !cur.result().dispatched()) {
1629 cur.dispatch(tmpcmd);
1632 if (!cur.result().dispatched())
1633 // It did not work too; no action needed.
1635 cur.clearSelection();
1636 processUpdateFlags(Update::Force | Update::FitCursor);
1640 case LFUN_SCREEN_UP:
1641 case LFUN_SCREEN_DOWN: {
1642 Point p = getPos(cur, cur.boundary());
1643 // This code has been commented out to enable to scroll down a
1644 // document, even if there are large insets in it (see bug #5465).
1645 /*if (p.y_ < 0 || p.y_ > height_) {
1646 // The cursor is off-screen so recenter before proceeding.
1648 p = getPos(cur, cur.boundary());
1650 int const scrolled = scroll(cmd.action == LFUN_SCREEN_UP
1651 ? -height_ : height_);
1652 if (cmd.action == LFUN_SCREEN_UP && scrolled > -height_)
1654 if (cmd.action == LFUN_SCREEN_DOWN && scrolled < height_)
1655 p = Point(width_, height_);
1657 bool const in_texted = cur.inTexted();
1658 cur.reset(buffer_.inset());
1661 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_,
1662 true, cmd.action == LFUN_SCREEN_UP);
1663 //FIXME: what to do with cur.x_target()?
1664 bool update = in_texted && cur.bv().checkDepm(cur, old);
1667 processUpdateFlags(Update::Force | Update::FitCursor);
1675 case LFUN_SCREEN_UP_SELECT: {
1676 cur.selHandle(true);
1677 if (isTopScreen()) {
1678 lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1682 int y = getPos(cur, cur.boundary()).y_;
1683 int const ymin = y - height_ + defaultRowHeight();
1684 while (y > ymin && cur.up())
1685 y = getPos(cur, cur.boundary()).y_;
1688 processUpdateFlags(Update::SinglePar | Update::FitCursor);
1692 case LFUN_SCREEN_DOWN_SELECT: {
1693 cur.selHandle(true);
1694 if (isBottomScreen()) {
1695 lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1699 int y = getPos(cur, cur.boundary()).y_;
1700 int const ymax = y + height_ - defaultRowHeight();
1701 while (y < ymax && cur.down())
1702 y = getPos(cur, cur.boundary()).y_;
1705 processUpdateFlags(Update::SinglePar | Update::FitCursor);
1709 // This could be rewriten using some command like forall <insetname> <command>
1710 // once the insets refactoring is done.
1711 case LFUN_NOTES_MUTATE: {
1712 if (cmd.argument().empty())
1715 if (mutateNotes(cur, cmd.getArg(0), cmd.getArg(1))) {
1716 processUpdateFlags(Update::Force);
1721 case LFUN_ALL_INSETS_TOGGLE: {
1723 string const name = split(to_utf8(cmd.argument()), action, ' ');
1724 InsetCode const inset_code = insetCode(name);
1726 FuncRequest fr(LFUN_INSET_TOGGLE, action);
1728 Inset & inset = cur.buffer()->inset();
1729 InsetIterator it = inset_iterator_begin(inset);
1730 InsetIterator const end = inset_iterator_end(inset);
1731 for (; it != end; ++it) {
1732 if (it->asInsetCollapsable()
1733 && (inset_code == NO_CODE
1734 || inset_code == it->lyxCode())) {
1735 Cursor tmpcur = cur;
1736 tmpcur.pushBackward(*it);
1737 it->dispatch(tmpcur, fr);
1740 processUpdateFlags(Update::Force | Update::FitCursor);
1744 case LFUN_BRANCH_ADD_INSERT: {
1745 docstring branch_name = from_utf8(cmd.getArg(0));
1746 if (branch_name.empty())
1747 if (!Alert::askForText(branch_name, _("Branch name")) ||
1748 branch_name.empty())
1751 DispatchResult drtmp;
1752 buffer_.dispatch(FuncRequest(LFUN_BRANCH_ADD, branch_name), drtmp);
1753 if (drtmp.error()) {
1754 Alert::warning(_("Branch already exists"), drtmp.message());
1757 BranchList & branch_list = buffer_.params().branchlist();
1758 Branch const * branch = branch_list.find(branch_name);
1759 string const x11hexname = X11hexname(branch->color());
1760 docstring const str = branch_name + ' ' + from_ascii(x11hexname);
1761 lyx::dispatch(FuncRequest(LFUN_SET_COLOR, str));
1762 lyx::dispatch(FuncRequest(LFUN_BRANCH_INSERT, branch_name));
1766 case LFUN_KEYMAP_OFF:
1767 getIntl().keyMapOn(false);
1770 case LFUN_KEYMAP_PRIMARY:
1771 getIntl().keyMapPrim();
1774 case LFUN_KEYMAP_SECONDARY:
1775 getIntl().keyMapSec();
1778 case LFUN_KEYMAP_TOGGLE:
1779 getIntl().toggleKeyMap();
1790 docstring const BufferView::requestSelection()
1792 Cursor & cur = d->cursor_;
1794 LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
1795 if (!cur.selection()) {
1796 d->xsel_cache_.set = false;
1800 LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
1801 if (!d->xsel_cache_.set ||
1802 cur.top() != d->xsel_cache_.cursor ||
1803 cur.anchor_.top() != d->xsel_cache_.anchor)
1805 d->xsel_cache_.cursor = cur.top();
1806 d->xsel_cache_.anchor = cur.anchor_.top();
1807 d->xsel_cache_.set = cur.selection();
1808 return cur.selectionAsString(false);
1814 void BufferView::clearSelection()
1816 d->cursor_.clearSelection();
1817 // Clear the selection buffer. Otherwise a subsequent
1818 // middle-mouse-button paste would use the selection buffer,
1819 // not the more current external selection.
1820 cap::clearSelection();
1821 d->xsel_cache_.set = false;
1822 // The buffer did not really change, but this causes the
1823 // redraw we need because we cleared the selection above.
1828 void BufferView::resize(int width, int height)
1830 // Update from work area
1834 // Clear the paragraph height cache.
1835 d->par_height_.clear();
1836 // Redo the metrics.
1841 Inset const * BufferView::getCoveringInset(Text const & text,
1844 TextMetrics & tm = d->text_metrics_[&text];
1845 Inset * inset = tm.checkInsetHit(x, y);
1849 if (!inset->descendable())
1850 // No need to go further down if the inset is not
1854 size_t cell_number = inset->nargs();
1855 // Check all the inner cell.
1856 for (size_t i = 0; i != cell_number; ++i) {
1857 Text const * inner_text = inset->getText(i);
1860 Inset const * inset_deeper =
1861 getCoveringInset(*inner_text, x, y);
1863 return inset_deeper;
1871 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
1873 //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
1875 // This is only called for mouse related events including
1876 // LFUN_FILE_OPEN generated by drag-and-drop.
1877 FuncRequest cmd = cmd0;
1879 Cursor old = cursor();
1881 cur.push(buffer_.inset());
1882 cur.setSelection(d->cursor_.selection());
1884 // Either the inset under the cursor or the
1885 // surrounding Text will handle this event.
1887 // make sure we stay within the screen...
1888 cmd.y = min(max(cmd.y, -1), height_);
1890 if (cmd.action == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
1892 // Get inset under mouse, if there is one.
1893 Inset const * covering_inset =
1894 getCoveringInset(buffer_.text(), cmd.x, cmd.y);
1895 if (covering_inset == d->last_inset_)
1896 // Same inset, no need to do anything...
1899 bool need_redraw = false;
1900 // const_cast because of setMouseHover().
1901 Inset * inset = const_cast<Inset *>(covering_inset);
1903 // Remove the hint on the last hovered inset (if any).
1904 need_redraw |= d->last_inset_->setMouseHover(false);
1906 // Highlighted the newly hovered inset (if any).
1907 need_redraw |= inset->setMouseHover(true);
1908 d->last_inset_ = inset;
1912 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
1913 << cmd.x << ", " << cmd.y << ")");
1915 d->update_strategy_ = DecorationUpdate;
1917 // This event (moving without mouse click) is not passed further.
1918 // This should be changed if it is further utilized.
1923 // Build temporary cursor.
1924 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x, cmd.y);
1926 // Put anchor at the same position.
1929 cur.beginUndoGroup();
1931 // Try to dispatch to an non-editable inset near this position
1932 // via the temp cursor. If the inset wishes to change the real
1933 // cursor it has to do so explicitly by using
1934 // cur.bv().cursor() = cur; (or similar)
1936 inset->dispatch(cur, cmd);
1938 // Now dispatch to the temporary cursor. If the real cursor should
1939 // be modified, the inset's dispatch has to do so explicitly.
1940 if (!inset || !cur.result().dispatched())
1945 // Notify left insets
1948 bool badcursor = notifyCursorLeavesOrEnters(old, cur);
1950 cursor().fixIfBroken();
1953 // Do we have a selection?
1954 theSelection().haveSelection(cursor().selection());
1956 // If the command has been dispatched,
1957 if (cur.result().dispatched() || cur.result().update())
1958 processUpdateFlags(cur.result().update());
1962 void BufferView::lfunScroll(FuncRequest const & cmd)
1964 string const scroll_type = cmd.getArg(0);
1965 int const scroll_step =
1966 (scroll_type == "line") ? d->scrollbarParameters_.single_step
1967 : (scroll_type == "page") ? d->scrollbarParameters_.page_step : 0;
1968 if (scroll_step == 0)
1970 string const scroll_quantity = cmd.getArg(1);
1971 if (scroll_quantity == "up")
1972 scrollUp(scroll_step);
1973 else if (scroll_quantity == "down")
1974 scrollDown(scroll_step);
1976 int const scroll_value = convert<int>(scroll_quantity);
1978 scroll(scroll_step * scroll_value);
1985 int BufferView::minVisiblePart()
1987 return 2 * defaultRowHeight();
1991 int BufferView::scroll(int y)
1994 return scrollDown(y);
1996 return scrollUp(-y);
2001 int BufferView::scrollDown(int offset)
2003 Text * text = &buffer_.text();
2004 TextMetrics & tm = d->text_metrics_[text];
2005 int const ymax = height_ + offset;
2007 pair<pit_type, ParagraphMetrics const *> last = tm.last();
2008 int bottom_pos = last.second->position() + last.second->descent();
2009 if (lyxrc.scroll_below_document)
2010 bottom_pos += height_ - minVisiblePart();
2011 if (last.first + 1 == int(text->paragraphs().size())) {
2012 if (bottom_pos <= height_)
2014 offset = min(offset, bottom_pos - height_);
2017 if (bottom_pos > ymax)
2019 tm.newParMetricsDown();
2021 d->anchor_ypos_ -= offset;
2026 int BufferView::scrollUp(int offset)
2028 Text * text = &buffer_.text();
2029 TextMetrics & tm = d->text_metrics_[text];
2030 int ymin = - offset;
2032 pair<pit_type, ParagraphMetrics const *> first = tm.first();
2033 int top_pos = first.second->position() - first.second->ascent();
2034 if (first.first == 0) {
2037 offset = min(offset, - top_pos);
2042 tm.newParMetricsUp();
2044 d->anchor_ypos_ += offset;
2049 void BufferView::setCursorFromRow(int row)
2054 buffer_.texrow().getIdFromRow(row, tmpid, tmppos);
2056 d->cursor_.reset(buffer_.inset());
2058 buffer_.text().setCursor(d->cursor_, 0, 0);
2060 buffer_.text().setCursor(d->cursor_, buffer_.getParFromID(tmpid).pit(), tmppos);
2064 bool BufferView::setCursorFromInset(Inset const * inset)
2066 // are we already there?
2067 if (cursor().nextInset() == inset)
2070 // Inset is not at cursor position. Find it in the document.
2072 cur.reset(buffer().inset());
2073 while (cur && cur.nextInset() != inset)
2084 void BufferView::gotoLabel(docstring const & label)
2086 std::vector<Buffer const *> bufs = buffer().allRelatives();
2087 std::vector<Buffer const *>::iterator it = bufs.begin();
2088 for (; it != bufs.end(); ++it) {
2089 Buffer const * buf = *it;
2092 Toc & toc = buf->tocBackend().toc("label");
2093 TocIterator toc_it = toc.begin();
2094 TocIterator end = toc.end();
2095 for (; toc_it != end; ++toc_it) {
2096 if (label == toc_it->str()) {
2097 dispatch(toc_it->action());
2105 TextMetrics const & BufferView::textMetrics(Text const * t) const
2107 return const_cast<BufferView *>(this)->textMetrics(t);
2111 TextMetrics & BufferView::textMetrics(Text const * t)
2113 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
2114 if (tmc_it == d->text_metrics_.end()) {
2115 tmc_it = d->text_metrics_.insert(
2116 make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
2118 return tmc_it->second;
2122 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
2125 return textMetrics(t).parMetrics(pit);
2129 int BufferView::workHeight() const
2135 void BufferView::setCursor(DocIterator const & dit)
2137 d->cursor_.reset(buffer().inset());
2138 size_t const n = dit.depth();
2139 for (size_t i = 0; i < n; ++i)
2140 dit[i].inset().edit(d->cursor_, true);
2142 d->cursor_.setCursor(dit);
2143 d->cursor_.setSelection(false);
2147 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
2149 // Would be wrong to delete anything if we have a selection.
2150 if (cur.selection())
2153 bool need_anchor_change = false;
2154 bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
2155 need_anchor_change);
2157 if (need_anchor_change)
2165 buffer_.updateLabels();
2173 bool BufferView::mouseSetCursor(Cursor & cur, bool select)
2175 LASSERT(&cur.bv() == this, /**/);
2178 // this event will clear selection so we save selection for
2179 // persistent selection
2180 cap::saveSelection(cursor());
2182 // Has the cursor just left the inset?
2183 bool leftinset = (&d->cursor_.inset() != &cur.inset());
2185 d->cursor_.fixIfBroken();
2187 // FIXME: shift-mouse selection doesn't work well across insets.
2188 bool do_selection = select && &d->cursor_.anchor().inset() == &cur.inset();
2190 // do the dEPM magic if needed
2191 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
2192 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
2193 // the leftinset bool would not be necessary (badcursor instead).
2194 bool update = leftinset;
2195 if (!do_selection && d->cursor_.inTexted())
2196 update |= checkDepm(cur, d->cursor_);
2197 d->cursor_.macroModeClose();
2199 d->cursor_.resetAnchor();
2200 d->cursor_.setCursor(cur);
2201 d->cursor_.boundary(cur.boundary());
2203 d->cursor_.setSelection();
2205 d->cursor_.clearSelection();
2207 d->cursor_.finishUndo();
2208 d->cursor_.setCurrentFont();
2213 void BufferView::putSelectionAt(DocIterator const & cur,
2214 int length, bool backwards)
2216 d->cursor_.clearSelection();
2222 d->cursor_.pos() += length;
2223 d->cursor_.setSelection(d->cursor_, -length);
2225 d->cursor_.setSelection(d->cursor_, length);
2227 // Ensure a redraw happens in any case because the new selection could
2228 // possibly be on the same screen as the previous selection.
2229 processUpdateFlags(Update::Force | Update::FitCursor);
2233 Cursor & BufferView::cursor()
2239 Cursor const & BufferView::cursor() const
2245 pit_type BufferView::anchor_ref() const
2247 return d->anchor_pit_;
2251 bool BufferView::singleParUpdate()
2253 Text & buftext = buffer_.text();
2254 pit_type const bottom_pit = d->cursor_.bottom().pit();
2255 TextMetrics & tm = textMetrics(&buftext);
2256 int old_height = tm.parMetrics(bottom_pit).height();
2258 // make sure inline completion pointer is ok
2259 if (d->inlineCompletionPos_.fixIfBroken())
2260 d->inlineCompletionPos_ = DocIterator();
2262 // In Single Paragraph mode, rebreak only
2263 // the (main text, not inset!) paragraph containing the cursor.
2264 // (if this paragraph contains insets etc., rebreaking will
2265 // recursively descend)
2266 tm.redoParagraph(bottom_pit);
2267 ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
2268 if (pm.height() != old_height)
2269 // Paragraph height has changed so we cannot proceed to
2270 // the singlePar optimisation.
2273 d->update_strategy_ = SingleParUpdate;
2275 LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
2276 << " y2: " << pm.position() + pm.descent()
2277 << " pit: " << bottom_pit
2278 << " singlepar: 1");
2283 void BufferView::updateMetrics()
2285 if (height_ == 0 || width_ == 0)
2288 Text & buftext = buffer_.text();
2289 pit_type const npit = int(buftext.paragraphs().size());
2291 // Clear out the position cache in case of full screen redraw,
2292 d->coord_cache_.clear();
2294 // Clear out paragraph metrics to avoid having invalid metrics
2295 // in the cache from paragraphs not relayouted below
2296 // The complete text metrics will be redone.
2297 d->text_metrics_.clear();
2299 TextMetrics & tm = textMetrics(&buftext);
2301 // make sure inline completion pointer is ok
2302 if (d->inlineCompletionPos_.fixIfBroken())
2303 d->inlineCompletionPos_ = DocIterator();
2305 if (d->anchor_pit_ >= npit)
2306 // The anchor pit must have been deleted...
2307 d->anchor_pit_ = npit - 1;
2309 // Rebreak anchor paragraph.
2310 tm.redoParagraph(d->anchor_pit_);
2311 ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
2314 if (d->anchor_pit_ == 0) {
2315 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
2317 // Complete buffer visible? Then it's easy.
2318 if (scrollRange == 0)
2319 d->anchor_ypos_ = anchor_pm.ascent();
2321 // FIXME: Some clever handling needed to show
2322 // the _first_ paragraph up to the top if the cursor is
2323 // in the first line.
2325 anchor_pm.setPosition(d->anchor_ypos_);
2327 LYXERR(Debug::PAINTING, "metrics: "
2328 << " anchor pit = " << d->anchor_pit_
2329 << " anchor ypos = " << d->anchor_ypos_);
2331 // Redo paragraphs above anchor if necessary.
2332 int y1 = d->anchor_ypos_ - anchor_pm.ascent();
2333 // We are now just above the anchor paragraph.
2334 pit_type pit1 = d->anchor_pit_ - 1;
2335 for (; pit1 >= 0 && y1 >= 0; --pit1) {
2336 tm.redoParagraph(pit1);
2337 ParagraphMetrics & pm = tm.par_metrics_[pit1];
2339 // Save the paragraph position in the cache.
2344 // Redo paragraphs below the anchor if necessary.
2345 int y2 = d->anchor_ypos_ + anchor_pm.descent();
2346 // We are now just below the anchor paragraph.
2347 pit_type pit2 = d->anchor_pit_ + 1;
2348 for (; pit2 < npit && y2 <= height_; ++pit2) {
2349 tm.redoParagraph(pit2);
2350 ParagraphMetrics & pm = tm.par_metrics_[pit2];
2352 // Save the paragraph position in the cache.
2357 LYXERR(Debug::PAINTING, "Metrics: "
2358 << " anchor pit = " << d->anchor_pit_
2359 << " anchor ypos = " << d->anchor_ypos_
2362 << " pit1 = " << pit1
2363 << " pit2 = " << pit2);
2365 d->update_strategy_ = FullScreenUpdate;
2367 if (lyxerr.debugging(Debug::WORKAREA)) {
2368 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
2369 d->coord_cache_.dump();
2374 void BufferView::insertLyXFile(FileName const & fname)
2376 LASSERT(d->cursor_.inTexted(), /**/);
2378 // Get absolute path of file and add ".lyx"
2379 // to the filename if necessary
2380 FileName filename = fileSearch(string(), fname.absFilename(), "lyx");
2382 docstring const disp_fn = makeDisplayPath(filename.absFilename());
2383 // emit message signal.
2384 message(bformat(_("Inserting document %1$s..."), disp_fn));
2387 Buffer buf("", false);
2388 if (buf.loadLyXFile(filename)) {
2389 ErrorList & el = buffer_.errorList("Parse");
2390 // Copy the inserted document error list into the current buffer one.
2391 el = buf.errorList("Parse");
2392 buffer_.undo().recordUndo(d->cursor_);
2393 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
2394 buf.params().documentClassPtr(), el);
2395 res = _("Document %1$s inserted.");
2397 res = _("Could not insert document %1$s");
2402 // emit message signal.
2403 message(bformat(res, disp_fn));
2404 buffer_.errors("Parse");
2408 Point BufferView::coordOffset(DocIterator const & dit, bool boundary) const
2414 // Addup contribution of nested insets, from inside to outside,
2415 // keeping the outer paragraph for a special handling below
2416 for (size_t i = dit.depth() - 1; i >= 1; --i) {
2417 CursorSlice const & sl = dit[i];
2421 // get relative position inside sl.inset()
2422 sl.inset().cursorPos(*this, sl, boundary && (i + 1 == dit.depth()), xx, yy);
2424 // Make relative position inside of the edited inset relative to sl.inset()
2428 // In case of an RTL inset, the edited inset will be positioned to the left
2431 bool boundary_i = boundary && i + 1 == dit.depth();
2432 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2437 // remember width for the case that sl.inset() is positioned in an RTL inset
2438 if (i && dit[i - 1].text()) {
2439 // If this Inset is inside a Text Inset, retrieve the Dimension
2440 // from the containing text instead of using Inset::dimension() which
2441 // might not be implemented.
2442 // FIXME (Abdel 23/09/2007): this is a bit messy because of the
2443 // elimination of Inset::dim_ cache. This coordOffset() method needs
2444 // to be rewritten in light of the new design.
2445 Dimension const & dim = parMetrics(dit[i - 1].text(),
2446 dit[i - 1].pit()).insetDimension(&sl.inset());
2449 Dimension const dim = sl.inset().dimension(*this);
2453 //lyxerr << "Cursor::getPos, i: "
2454 // << i << " x: " << xx << " y: " << y << endl;
2457 // Add contribution of initial rows of outermost paragraph
2458 CursorSlice const & sl = dit[0];
2459 TextMetrics const & tm = textMetrics(sl.text());
2460 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2461 LASSERT(!pm.rows().empty(), /**/);
2462 y -= pm.rows()[0].ascent();
2464 // FIXME: document this mess
2466 if (sl.pos() > 0 && dit.depth() == 1) {
2468 if (pos && boundary)
2470 // lyxerr << "coordOffset: boundary:" << boundary << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
2471 rend = pm.pos2row(pos);
2473 rend = pm.pos2row(sl.pos());
2475 size_t rend = pm.pos2row(sl.pos());
2477 for (size_t rit = 0; rit != rend; ++rit)
2478 y += pm.rows()[rit].height();
2479 y += pm.rows()[rend].ascent();
2481 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
2483 // Make relative position from the nested inset now bufferview absolute.
2484 int xx = bottom_tm.cursorX(dit.bottom(), boundary && dit.depth() == 1);
2487 // In the RTL case place the nested inset at the left of the cursor in
2488 // the outer paragraph
2489 bool boundary_1 = boundary && 1 == dit.depth();
2490 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
2498 Point BufferView::getPos(DocIterator const & dit, bool boundary) const
2500 if (!paragraphVisible(dit))
2501 return Point(-1, -1);
2503 CursorSlice const & bot = dit.bottom();
2504 TextMetrics const & tm = textMetrics(bot.text());
2506 Point p = coordOffset(dit, boundary); // offset from outer paragraph
2507 p.y_ += tm.parMetrics(bot.pit()).position();
2512 bool BufferView::paragraphVisible(DocIterator const & dit) const
2514 CursorSlice const & bot = dit.bottom();
2515 TextMetrics const & tm = textMetrics(bot.text());
2517 return tm.contains(bot.pit());
2521 void BufferView::cursorPosAndHeight(Point & p, int & h) const
2523 Cursor const & cur = cursor();
2524 Font const font = cur.getFont();
2525 frontend::FontMetrics const & fm = theFontMetrics(font);
2526 int const asc = fm.maxAscent();
2527 int const des = fm.maxDescent();
2529 p = getPos(cur, cur.boundary());
2534 bool BufferView::cursorInView(Point const & p, int h) const
2536 Cursor const & cur = cursor();
2537 // does the cursor touch the screen ?
2538 if (p.y_ + h < 0 || p.y_ >= workHeight() || !paragraphVisible(cur))
2544 void BufferView::draw(frontend::Painter & pain)
2546 if (height_ == 0 || width_ == 0)
2548 LYXERR(Debug::PAINTING, "\t\t*** START DRAWING ***");
2550 Text & text = buffer_.text();
2551 TextMetrics const & tm = d->text_metrics_[&text];
2552 int const y = tm.first().second->position();
2553 PainterInfo pi(this, pain);
2555 switch (d->update_strategy_) {
2557 case NoScreenUpdate:
2558 // If no screen painting is actually needed, only some the different
2559 // coordinates of insets and paragraphs needs to be updated.
2560 pi.full_repaint = true;
2561 pi.pain.setDrawingEnabled(false);
2565 case SingleParUpdate:
2566 pi.full_repaint = false;
2567 // In general, only the current row of the outermost paragraph
2568 // will be redrawn. Particular cases where selection spans
2569 // multiple paragraph are correctly detected in TextMetrics.
2573 case DecorationUpdate:
2574 // FIXME: We should also distinguish DecorationUpdate to avoid text
2575 // drawing if possible. This is not possible to do easily right now
2576 // because of the single backing pixmap.
2578 case FullScreenUpdate:
2579 // The whole screen, including insets, will be refreshed.
2580 pi.full_repaint = true;
2582 // Clear background.
2583 pain.fillRectangle(0, 0, width_, height_,
2584 pi.backgroundColor(&buffer_.inset()));
2589 // and possibly grey out below
2590 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2591 int const y2 = lastpm.second->position() + lastpm.second->descent();
2594 Color color = buffer().isInternal()
2595 ? Color_background : Color_bottomarea;
2596 pain.fillRectangle(0, y2, width_, height_ - y2, color);
2600 LYXERR(Debug::PAINTING, "\n\t\t*** END DRAWING ***");
2602 // The scrollbar needs an update.
2605 // Normalize anchor for next time
2606 pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
2607 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2608 for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
2609 ParagraphMetrics const & pm = tm.parMetrics(pit);
2610 if (pm.position() + pm.descent() > 0) {
2611 d->anchor_pit_ = pit;
2612 d->anchor_ypos_ = pm.position();
2616 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
2617 << " anchor ypos = " << d->anchor_ypos_);
2621 void BufferView::message(docstring const & msg)
2624 d->gui_->message(msg);
2628 void BufferView::showDialog(string const & name)
2631 d->gui_->showDialog(name, string());
2635 void BufferView::showDialog(string const & name,
2636 string const & data, Inset * inset)
2639 d->gui_->showDialog(name, data, inset);
2643 void BufferView::updateDialog(string const & name, string const & data)
2646 d->gui_->updateDialog(name, data);
2650 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
2656 // FIXME: Move this out of BufferView again
2657 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
2659 if (!fname.isReadableFile()) {
2660 docstring const error = from_ascii(strerror(errno));
2661 docstring const file = makeDisplayPath(fname.absFilename(), 50);
2662 docstring const text =
2663 bformat(_("Could not read the specified document\n"
2664 "%1$s\ndue to the error: %2$s"), file, error);
2665 Alert::error(_("Could not read file"), text);
2669 if (!fname.isReadableFile()) {
2670 docstring const file = makeDisplayPath(fname.absFilename(), 50);
2671 docstring const text =
2672 bformat(_("%1$s\n is not readable."), file);
2673 Alert::error(_("Could not open file"), text);
2677 // FIXME UNICODE: We don't know the encoding of the file
2678 docstring file_content = fname.fileContents("UTF-8");
2679 if (file_content.empty()) {
2680 Alert::error(_("Reading not UTF-8 encoded file"),
2681 _("The file is not UTF-8 encoded.\n"
2682 "It will be read as local 8Bit-encoded.\n"
2683 "If this does not give the correct result\n"
2684 "then please change the encoding of the file\n"
2685 "to UTF-8 with a program other than LyX.\n"));
2686 file_content = fname.fileContents("local8bit");
2689 return normalize_c(file_content);
2693 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
2695 docstring const tmpstr = contentsOfPlaintextFile(f);
2700 Cursor & cur = cursor();
2701 cap::replaceSelection(cur);
2702 buffer_.undo().recordUndo(cur);
2704 cur.innerText()->insertStringAsParagraphs(cur, tmpstr, cur.current_font);
2706 cur.innerText()->insertStringAsLines(cur, tmpstr, cur.current_font);
2713 docstring const & BufferView::inlineCompletion() const
2715 return d->inlineCompletion_;
2719 size_t const & BufferView::inlineCompletionUniqueChars() const
2721 return d->inlineCompletionUniqueChars_;
2725 DocIterator const & BufferView::inlineCompletionPos() const
2727 return d->inlineCompletionPos_;
2731 bool samePar(DocIterator const & a, DocIterator const & b)
2733 if (a.empty() && b.empty())
2735 if (a.empty() || b.empty())
2737 if (a.depth() != b.depth())
2739 return &a.innerParagraph() == &b.innerParagraph();
2743 void BufferView::setInlineCompletion(Cursor & cur, DocIterator const & pos,
2744 docstring const & completion, size_t uniqueChars)
2746 uniqueChars = min(completion.size(), uniqueChars);
2747 bool changed = d->inlineCompletion_ != completion
2748 || d->inlineCompletionUniqueChars_ != uniqueChars;
2749 bool singlePar = true;
2750 d->inlineCompletion_ = completion;
2751 d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
2753 //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
2756 DocIterator const & old = d->inlineCompletionPos_;
2758 //lyxerr << "inlineCompletionPos changed" << std::endl;
2759 // old or pos are in another paragraph?
2760 if ((!samePar(cur, pos) && !pos.empty())
2761 || (!samePar(cur, old) && !old.empty())) {
2763 //lyxerr << "different paragraph" << std::endl;
2765 d->inlineCompletionPos_ = pos;
2770 if (singlePar && !(cur.disp_.update() & Update::Force))
2771 cur.updateFlags(cur.disp_.update() | Update::SinglePar);
2773 cur.updateFlags(cur.disp_.update() | Update::Force);