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"
54 #include "WordLangTuple.h"
56 #include "insets/InsetBibtex.h"
57 #include "insets/InsetCitation.h"
58 #include "insets/InsetCommand.h" // ChangeRefs
59 #include "insets/InsetExternal.h"
60 #include "insets/InsetGraphics.h"
61 #include "insets/InsetNote.h"
62 #include "insets/InsetRef.h"
63 #include "insets/InsetText.h"
65 #include "mathed/MathData.h"
67 #include "frontends/alert.h"
68 #include "frontends/Application.h"
69 #include "frontends/Delegates.h"
70 #include "frontends/FontMetrics.h"
71 #include "frontends/Painter.h"
72 #include "frontends/Selection.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/lassert.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 /// Note that comparing contents can only be used for InsetCommand
113 bool findNextInset(DocIterator & dit, vector<InsetCode> const & codes,
114 docstring const & contents)
116 DocIterator tmpdit = dit;
119 Inset const * inset = tmpdit.nextInset();
121 bool const valid_code = std::find(codes.begin(), codes.end(),
122 inset->lyxCode()) != codes.end();
123 InsetCommand const * ic = inset->asInsetCommand();
124 bool const same_or_no_contents = contents.empty()
125 || (ic && (ic->getFirstNonOptParam() == contents));
127 if (valid_code && same_or_no_contents) {
132 tmpdit.forwardInset();
139 /// Looks for next inset with one of the given codes.
140 /// Note that same_content can only be used for InsetCommand
141 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
145 DocIterator tmpdit = dit;
146 tmpdit.forwardInset();
150 Inset const * inset = tmpdit.nextInset();
151 if (same_content && inset) {
152 InsetCommand const * ic = inset->asInsetCommand();
154 bool const valid_code = std::find(codes.begin(), codes.end(),
155 ic->lyxCode()) != codes.end();
157 contents = ic->getFirstNonOptParam();
161 if (!findNextInset(tmpdit, codes, contents)) {
162 if (dit.depth() != 1 || dit.pit() != 0 || dit.pos() != 0) {
163 Inset * inset = &tmpdit.bottom().inset();
164 tmpdit = doc_iterator_begin(&inset->buffer(), inset);
165 if (!findNextInset(tmpdit, codes, contents))
177 /// Looks for next inset with the given code
178 void findInset(DocIterator & dit, InsetCode code, bool same_content)
180 findInset(dit, vector<InsetCode>(1, code), same_content);
184 /// Moves cursor to the next inset with one of the given codes.
185 void gotoInset(BufferView * bv, vector<InsetCode> const & codes,
188 Cursor tmpcur = bv->cursor();
189 if (!findInset(tmpcur, codes, same_content)) {
190 bv->cursor().message(_("No more insets"));
194 tmpcur.clearSelection();
195 bv->setCursor(tmpcur);
200 /// Moves cursor to the next inset with given code.
201 void gotoInset(BufferView * bv, InsetCode code, bool same_content)
203 gotoInset(bv, vector<InsetCode>(1, code), same_content);
207 /// A map from a Text to the associated text metrics
208 typedef map<Text const *, TextMetrics> TextMetricsCache;
210 enum ScreenUpdateStrategy {
220 /////////////////////////////////////////////////////////////////////
224 /////////////////////////////////////////////////////////////////////
226 struct BufferView::Private
228 Private(BufferView & bv): wh_(0), cursor_(bv),
229 anchor_pit_(0), anchor_ypos_(0),
230 inlineCompletionUniqueChars_(0),
231 last_inset_(0), clickable_inset_(false),
232 mouse_position_cache_(),
233 bookmark_edit_position_(-1), gui_(0)
237 ScrollbarParameters scrollbarParameters_;
239 ScreenUpdateStrategy update_strategy_;
241 CoordCache coord_cache_;
243 /// Estimated average par height for scrollbar.
245 /// this is used to handle XSelection events in the right manner.
254 pit_type anchor_pit_;
258 vector<int> par_height_;
261 DocIterator inlineCompletionPos_;
263 docstring inlineCompletion_;
265 size_t inlineCompletionUniqueChars_;
267 /// keyboard mapping object.
270 /// last visited inset.
271 /** kept to send setMouseHover(false).
272 * Not owned, so don't delete.
274 Inset const * last_inset_;
275 /// are we hovering something that we can click
276 bool clickable_inset_;
278 /// position of the mouse at the time of the last mouse move
279 /// This is used to update the hovering status of inset in
280 /// cases where the buffer is scrolled, but the mouse didn't move.
281 Point mouse_position_cache_;
283 // cache for id of the paragraph which was edited the last time
284 int bookmark_edit_position_;
286 mutable TextMetricsCache text_metrics_;
289 /** Not owned, so don't delete.
291 frontend::GuiBufferViewDelegate * gui_;
293 /// Cache for Find Next
294 FuncRequest search_request_cache_;
297 map<string, Inset *> edited_insets_;
301 BufferView::BufferView(Buffer & buf)
302 : width_(0), height_(0), full_screen_(false), buffer_(buf),
303 d(new Private(*this))
305 d->xsel_cache_.set = false;
306 d->intl_.initKeyMapper(lyxrc.use_kbmap);
308 d->cursor_.setBuffer(&buf);
309 d->cursor_.push(buffer_.inset());
310 d->cursor_.resetAnchor();
311 d->cursor_.setCurrentFont();
313 buffer_.updatePreviews();
317 BufferView::~BufferView()
319 // current buffer is going to be switched-off, save cursor pos
320 // Ideally, the whole cursor stack should be saved, but session
321 // currently can only handle bottom (whole document) level pit and pos.
322 // That is to say, if a cursor is in a nested inset, it will be
323 // restore to the left of the top level inset.
324 LastFilePosSection::FilePos fp;
325 fp.pit = d->cursor_.bottom().pit();
326 fp.pos = d->cursor_.bottom().pos();
327 theSession().lastFilePos().save(buffer_.fileName(), fp);
330 d->last_inset_->setMouseHover(this, false);
336 int BufferView::rightMargin() const
338 // The additional test for the case the outliner is opened.
340 !lyxrc.full_screen_limit ||
341 width_ < lyxrc.full_screen_width + 20)
344 return (width_ - lyxrc.full_screen_width) / 2;
348 int BufferView::leftMargin() const
350 return rightMargin();
354 bool BufferView::isTopScreen() const
356 return d->scrollbarParameters_.position == d->scrollbarParameters_.min;
360 bool BufferView::isBottomScreen() const
362 return d->scrollbarParameters_.position == d->scrollbarParameters_.max;
366 Intl & BufferView::getIntl()
372 Intl const & BufferView::getIntl() const
378 CoordCache & BufferView::coordCache()
380 return d->coord_cache_;
384 CoordCache const & BufferView::coordCache() const
386 return d->coord_cache_;
390 Buffer & BufferView::buffer()
396 Buffer const & BufferView::buffer() const
402 bool BufferView::fitCursor()
404 if (cursorStatus(d->cursor_) == CUR_INSIDE) {
405 frontend::FontMetrics const & fm =
406 theFontMetrics(d->cursor_.getFont().fontInfo());
407 int const asc = fm.maxAscent();
408 int const des = fm.maxDescent();
409 Point const p = getPos(d->cursor_);
410 if (p.y_ - asc >= 0 && p.y_ + des < height_)
417 void BufferView::processUpdateFlags(Update::flags flags)
419 // This is close to a hot-path.
420 LYXERR(Debug::DEBUG, "BufferView::processUpdateFlags()"
421 << "[fitcursor = " << (flags & Update::FitCursor)
422 << ", forceupdate = " << (flags & Update::Force)
423 << ", singlepar = " << (flags & Update::SinglePar)
424 << "] buffer: " << &buffer_);
426 // FIXME Does this really need doing here? It's done in updateBuffer, and
427 // if the Buffer doesn't need updating, then do the macros?
428 buffer_.updateMacros();
430 // Now do the first drawing step if needed. This consists on updating
431 // the CoordCache in updateMetrics().
432 // The second drawing step is done in WorkArea::redraw() if needed.
434 // Case when no explicit update is requested.
436 // no need to redraw anything.
437 d->update_strategy_ = NoScreenUpdate;
441 if (flags == Update::Decoration) {
442 d->update_strategy_ = DecorationUpdate;
443 buffer_.changed(false);
447 if (flags == Update::FitCursor
448 || flags == (Update::Decoration | Update::FitCursor)) {
449 // tell the frontend to update the screen if needed.
454 if (flags & Update::Decoration) {
455 d->update_strategy_ = DecorationUpdate;
456 buffer_.changed(false);
459 // no screen update is needed.
460 d->update_strategy_ = NoScreenUpdate;
464 bool const full_metrics = flags & Update::Force || !singleParUpdate();
467 // We have to update the full screen metrics.
470 if (!(flags & Update::FitCursor)) {
471 // Nothing to do anymore. Trigger a redraw and return
472 buffer_.changed(false);
476 // updateMetrics() does not update paragraph position
477 // This is done at draw() time. So we need a redraw!
478 buffer_.changed(false);
481 // The cursor is off screen so ensure it is visible.
486 updateHoveredInset();
490 void BufferView::updateScrollbar()
492 if (height_ == 0 && width_ == 0)
495 // We prefer fixed size line scrolling.
496 d->scrollbarParameters_.single_step = defaultRowHeight();
497 // We prefer full screen page scrolling.
498 d->scrollbarParameters_.page_step = height_;
500 Text & t = buffer_.text();
501 TextMetrics & tm = d->text_metrics_[&t];
503 LYXERR(Debug::GUI, " Updating scrollbar: height: "
504 << t.paragraphs().size()
505 << " curr par: " << d->cursor_.bottom().pit()
506 << " default height " << defaultRowHeight());
508 size_t const parsize = t.paragraphs().size();
509 if (d->par_height_.size() != parsize) {
510 d->par_height_.clear();
511 // FIXME: We assume a default paragraph height of 2 rows. This
512 // should probably be pondered with the screen width.
513 d->par_height_.resize(parsize, defaultRowHeight() * 2);
516 // Look at paragraph heights on-screen
517 pair<pit_type, ParagraphMetrics const *> first = tm.first();
518 pair<pit_type, ParagraphMetrics const *> last = tm.last();
519 for (pit_type pit = first.first; pit <= last.first; ++pit) {
520 d->par_height_[pit] = tm.parMetrics(pit).height();
521 LYXERR(Debug::SCROLLING, "storing height for pit " << pit << " : "
522 << d->par_height_[pit]);
525 int top_pos = first.second->position() - first.second->ascent();
526 int bottom_pos = last.second->position() + last.second->descent();
527 bool first_visible = first.first == 0 && top_pos >= 0;
528 bool last_visible = last.first + 1 == int(parsize) && bottom_pos <= height_;
529 if (first_visible && last_visible) {
530 d->scrollbarParameters_.min = 0;
531 d->scrollbarParameters_.max = 0;
535 d->scrollbarParameters_.min = top_pos;
536 for (size_t i = 0; i != size_t(first.first); ++i)
537 d->scrollbarParameters_.min -= d->par_height_[i];
538 d->scrollbarParameters_.max = bottom_pos;
539 for (size_t i = last.first + 1; i != parsize; ++i)
540 d->scrollbarParameters_.max += d->par_height_[i];
542 d->scrollbarParameters_.position = 0;
543 // The reference is the top position so we remove one page.
544 if (lyxrc.scroll_below_document)
545 d->scrollbarParameters_.max -= minVisiblePart();
547 d->scrollbarParameters_.max -= d->scrollbarParameters_.page_step;
551 ScrollbarParameters const & BufferView::scrollbarParameters() const
553 return d->scrollbarParameters_;
557 docstring BufferView::toolTip(int x, int y) const
559 // Get inset under mouse, if there is one.
560 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
562 // No inset, no tooltip...
564 return covering_inset->toolTip(*this, x, y);
568 string BufferView::contextMenu(int x, int y) const
570 //If there is a selection, return the containing inset menu
571 if (d->cursor_.selection())
572 return d->cursor_.inset().contextMenu(*this, x, y);
574 // Get inset under mouse, if there is one.
575 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
577 return covering_inset->contextMenu(*this, x, y);
579 return buffer_.inset().contextMenu(*this, x, y);
583 void BufferView::scrollDocView(int value, bool update)
585 int const offset = value - d->scrollbarParameters_.position;
587 // No scrolling at all? No need to redraw anything
591 // If the offset is less than 2 screen height, prefer to scroll instead.
592 if (abs(offset) <= 2 * height_) {
593 d->anchor_ypos_ -= offset;
594 buffer_.changed(true);
595 updateHoveredInset();
599 // cut off at the top
600 if (value <= d->scrollbarParameters_.min) {
601 DocIterator dit = doc_iterator_begin(&buffer_);
602 showCursor(dit, false, update);
603 LYXERR(Debug::SCROLLING, "scroll to top");
607 // cut off at the bottom
608 if (value >= d->scrollbarParameters_.max) {
609 DocIterator dit = doc_iterator_end(&buffer_);
611 showCursor(dit, false, update);
612 LYXERR(Debug::SCROLLING, "scroll to bottom");
616 // find paragraph at target position
617 int par_pos = d->scrollbarParameters_.min;
619 for (; i != int(d->par_height_.size()); ++i) {
620 par_pos += d->par_height_[i];
621 if (par_pos >= value)
625 if (par_pos < value) {
626 // It seems we didn't find the correct pit so stay on the safe side and
628 LYXERR0("scrolling position not found!");
629 scrollDocView(d->scrollbarParameters_.max, update);
633 DocIterator dit = doc_iterator_begin(&buffer_);
635 LYXERR(Debug::SCROLLING, "value = " << value << " -> scroll to pit " << i);
636 showCursor(dit, false, update);
640 // FIXME: this method is not working well.
641 void BufferView::setCursorFromScrollbar()
643 TextMetrics & tm = d->text_metrics_[&buffer_.text()];
645 int const height = 2 * defaultRowHeight();
646 int const first = height;
647 int const last = height_ - height;
649 Cursor const & oldcur = d->cursor_;
651 switch (cursorStatus(oldcur)) {
659 int const y = getPos(oldcur).y_;
660 newy = min(last, max(y, first));
664 // We reset the cursor because cursorStatus() does not
665 // work when the cursor is within mathed.
668 tm.setCursorFromCoordinates(cur, 0, newy);
670 // update the bufferview cursor and notify insets
671 // FIXME: Care about the d->cursor_ flags to redraw if needed
672 Cursor old = d->cursor_;
674 // the DEPM call in mouseSetCursor() might have destroyed the
675 // paragraph the cursor is in.
676 bool badcursor = old.fixIfBroken();
677 badcursor |= notifyCursorLeavesOrEnters(old, d->cursor_);
679 d->cursor_.fixIfBroken();
683 Change const BufferView::getCurrentChange() const
685 if (!d->cursor_.selection())
686 return Change(Change::UNCHANGED);
688 DocIterator dit = d->cursor_.selectionBegin();
689 // The selected content might have been changed (see #7685)
690 while (dit.inMathed())
691 // Find enclosing text cursor
693 return dit.paragraph().lookupChange(dit.pos());
697 // this could be used elsewhere as well?
698 // FIXME: This does not work within mathed!
699 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
701 Point const p = getPos(dit);
704 if (p.y_ > workHeight())
710 void BufferView::bookmarkEditPosition()
712 // Don't eat cpu time for each keystroke
713 if (d->cursor_.paragraph().id() == d->bookmark_edit_position_)
716 d->bookmark_edit_position_ = d->cursor_.paragraph().id();
720 void BufferView::saveBookmark(unsigned int idx)
722 // tentatively save bookmark, id and pos will be used to
723 // acturately locate a bookmark in a 'live' lyx session.
724 // pit and pos will be updated with bottom level pit/pos
726 if (!buffer_.isInternal()) {
727 theSession().bookmarks().save(
729 d->cursor_.bottom().pit(),
730 d->cursor_.bottom().pos(),
731 d->cursor_.paragraph().id(),
736 // emit message signal.
737 message(_("Save bookmark"));
742 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
743 int top_id, pos_type top_pos)
745 bool success = false;
748 d->cursor_.clearSelection();
750 // if a valid par_id is given, try it first
751 // This is the case for a 'live' bookmark when unique paragraph ID
752 // is used to track bookmarks.
754 dit = buffer_.getParFromID(top_id);
756 dit.pos() = min(dit.paragraph().size(), top_pos);
757 // Some slices of the iterator may not be
758 // reachable (e.g. closed collapsable inset)
759 // so the dociterator may need to be
760 // shortened. Otherwise, setCursor may crash
761 // lyx when the cursor can not be set to these
763 size_t const n = dit.depth();
764 for (size_t i = 0; i < n; ++i)
765 if (!dit[i].inset().editable()) {
773 // if top_id == 0, or searching through top_id failed
774 // This is the case for a 'restored' bookmark when only bottom
775 // (document level) pit was saved. Because of this, bookmark
776 // restoration is inaccurate. If a bookmark was within an inset,
777 // it will be restored to the left of the outmost inset that contains
779 if (bottom_pit < int(buffer_.paragraphs().size())) {
780 dit = doc_iterator_begin(&buffer_);
782 dit.pit() = bottom_pit;
783 dit.pos() = min(bottom_pos, dit.paragraph().size());
788 // Note: only bottom (document) level pit is set.
790 // set the current font.
791 d->cursor_.setCurrentFont();
792 // To center the screen on this new position we need the
793 // paragraph position which is computed at draw() time.
794 // So we need a redraw!
795 buffer_.changed(false);
804 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
806 if (d->cursor_.real_current_font.isRightToLeft()) {
807 if (d->intl_.keymap == Intl::PRIMARY)
808 d->intl_.keyMapSec();
810 if (d->intl_.keymap == Intl::SECONDARY)
811 d->intl_.keyMapPrim();
814 d->intl_.getTransManager().translateAndInsert(c, t, cur);
818 int BufferView::workWidth() const
824 void BufferView::recenter()
826 showCursor(d->cursor_, true, true);
830 void BufferView::showCursor()
832 showCursor(d->cursor_, false, true);
836 void BufferView::showCursor(DocIterator const & dit,
837 bool recenter, bool update)
839 if (scrollToCursor(dit, recenter) && update) {
840 buffer_.changed(true);
841 updateHoveredInset();
846 void BufferView::scrollToCursor()
848 if (scrollToCursor(d->cursor_, false)) {
849 buffer_.changed(true);
850 updateHoveredInset();
855 bool BufferView::scrollToCursor(DocIterator const & dit, bool recenter)
857 // We are not properly started yet, delay until resizing is
862 LYXERR(Debug::SCROLLING, "recentering!");
864 CursorSlice const & bot = dit.bottom();
865 TextMetrics & tm = d->text_metrics_[bot.text()];
867 pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
868 int bot_pit = bot.pit();
869 if (bot_pit > max_pit) {
870 // FIXME: Why does this happen?
871 LYXERR0("bottom pit is greater that max pit: "
872 << bot_pit << " > " << max_pit);
876 if (bot_pit == tm.first().first - 1)
877 tm.newParMetricsUp();
878 else if (bot_pit == tm.last().first + 1)
879 tm.newParMetricsDown();
881 if (tm.contains(bot_pit)) {
882 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
883 LBUFERR(!pm.rows().empty());
884 // FIXME: smooth scrolling doesn't work in mathed.
885 CursorSlice const & cs = dit.innerTextSlice();
886 int offset = coordOffset(dit).y_;
887 int ypos = pm.position() + offset;
888 Dimension const & row_dim =
889 pm.getRow(cs.pos(), dit.boundary()).dimension();
892 scrolled = scroll(ypos - height_/2);
894 // We try to visualize the whole row, if the row height is larger than
895 // the screen height, we scroll to a heuristic value of height_ / 4.
896 // FIXME: This heuristic value should be replaced by a recursive search
897 // for a row in the inset that can be visualized completely.
898 else if (row_dim.height() > height_) {
899 if (ypos < defaultRowHeight())
900 scrolled = scroll(ypos - height_ / 4);
901 else if (ypos > height_ - defaultRowHeight())
902 scrolled = scroll(ypos - 3 * height_ / 4);
905 // If the top part of the row falls of the screen, we scroll
906 // up to align the top of the row with the top of the screen.
907 else if (ypos - row_dim.ascent() < 0 && ypos < height_) {
908 int ynew = row_dim.ascent();
909 scrolled = scrollUp(ynew - ypos);
912 // If the bottom of the row falls of the screen, we scroll down.
913 else if (ypos + row_dim.descent() > height_ && ypos > 0) {
914 int ynew = height_ - row_dim.descent();
915 scrolled = scrollDown(ypos - ynew);
918 // else, nothing to do, the cursor is already visible so we just return.
919 return scrolled != 0;
922 // fix inline completion position
923 if (d->inlineCompletionPos_.fixIfBroken())
924 d->inlineCompletionPos_ = DocIterator();
926 tm.redoParagraph(bot_pit);
927 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
928 int offset = coordOffset(dit).y_;
930 d->anchor_pit_ = bot_pit;
931 CursorSlice const & cs = dit.innerTextSlice();
932 Dimension const & row_dim =
933 pm.getRow(cs.pos(), dit.boundary()).dimension();
936 d->anchor_ypos_ = height_/2;
937 else if (d->anchor_pit_ == 0)
938 d->anchor_ypos_ = offset + pm.ascent();
939 else if (d->anchor_pit_ == max_pit)
940 d->anchor_ypos_ = height_ - offset - row_dim.descent();
941 else if (offset > height_)
942 d->anchor_ypos_ = height_ - offset - defaultRowHeight();
944 d->anchor_ypos_ = defaultRowHeight() * 2;
950 void BufferView::makeDocumentClass()
952 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
953 buffer_.params().makeDocumentClass();
954 updateDocumentClass(olddc);
958 void BufferView::updateDocumentClass(DocumentClassConstPtr olddc)
960 message(_("Converting document to new document class..."));
962 StableDocIterator backcur(d->cursor_);
963 ErrorList & el = buffer_.errorList("Class Switch");
964 cap::switchBetweenClasses(
965 olddc, buffer_.params().documentClassPtr(),
966 static_cast<InsetText &>(buffer_.inset()), el);
968 setCursor(backcur.asDocIterator(&buffer_));
970 buffer_.errors("Class Switch");
974 /** Return the change status at cursor position, taking in account the
975 * status at each level of the document iterator (a table in a deleted
976 * footnote is deleted).
977 * When \param outer is true, the top slice is not looked at.
979 static Change::Type lookupChangeType(DocIterator const & dit, bool outer = false)
981 size_t const depth = dit.depth() - (outer ? 1 : 0);
983 for (size_t i = 0 ; i < depth ; ++i) {
984 CursorSlice const & slice = dit[i];
985 if (!slice.inset().inMathed()
986 && slice.pos() < slice.paragraph().size()) {
987 Change::Type const ch = slice.paragraph().lookupChange(slice.pos()).type;
988 if (ch != Change::UNCHANGED)
992 return Change::UNCHANGED;
996 bool BufferView::getStatus(FuncRequest const & cmd, FuncStatus & flag)
998 FuncCode const act = cmd.action();
1000 // Can we use a readonly buffer?
1001 if (buffer_.isReadonly()
1002 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1003 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1004 flag.message(from_utf8(N_("Document is read-only")));
1005 flag.setEnabled(false);
1009 // Are we in a DELETED change-tracking region?
1010 if (lookupChangeType(d->cursor_, true) == Change::DELETED
1011 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1012 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1013 flag.message(from_utf8(N_("This portion of the document is deleted.")));
1014 flag.setEnabled(false);
1018 Cursor & cur = d->cursor_;
1020 if (cur.getStatus(cmd, flag))
1025 // FIXME: This is a bit problematic because we don't check if this is
1026 // a document BufferView or not for these LFUNs. We probably have to
1027 // dispatch both to currentBufferView() and, if that fails,
1028 // to documentBufferView(); same as we do now for current Buffer and
1029 // document Buffer. Ideally those LFUN should go to Buffer as they
1030 // operate on the full Buffer and the cursor is only needed either for
1031 // an Undo record or to restore a cursor position. But we don't know
1032 // how to do that inside Buffer of course.
1033 case LFUN_BUFFER_PARAMS_APPLY:
1034 case LFUN_LAYOUT_MODULES_CLEAR:
1035 case LFUN_LAYOUT_MODULE_ADD:
1036 case LFUN_LAYOUT_RELOAD:
1037 case LFUN_TEXTCLASS_APPLY:
1038 case LFUN_TEXTCLASS_LOAD:
1039 flag.setEnabled(!buffer_.isReadonly());
1043 // We do not use the LyXAction flag for readonly because Undo sets the
1044 // buffer clean/dirty status by itself.
1045 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasUndoStack());
1048 // We do not use the LyXAction flag for readonly because Redo sets the
1049 // buffer clean/dirty status by itself.
1050 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasRedoStack());
1052 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
1053 case LFUN_FILE_INSERT_PLAINTEXT: {
1054 docstring const fname = cmd.argument();
1055 if (!FileName::isAbsolute(to_utf8(fname))) {
1056 flag.message(_("Absolute filename expected."));
1059 flag.setEnabled(cur.inTexted());
1062 case LFUN_FILE_INSERT:
1063 case LFUN_BOOKMARK_SAVE:
1064 // FIXME: Actually, these LFUNS should be moved to Text
1065 flag.setEnabled(cur.inTexted());
1068 case LFUN_FONT_STATE:
1069 case LFUN_LABEL_INSERT:
1070 case LFUN_INFO_INSERT:
1071 case LFUN_PARAGRAPH_GOTO:
1072 case LFUN_NOTE_NEXT:
1073 case LFUN_REFERENCE_NEXT:
1074 case LFUN_WORD_FIND:
1075 case LFUN_WORD_FIND_FORWARD:
1076 case LFUN_WORD_FIND_BACKWARD:
1077 case LFUN_WORD_REPLACE:
1080 case LFUN_MARK_TOGGLE:
1081 case LFUN_SCREEN_RECENTER:
1082 case LFUN_SCREEN_SHOW_CURSOR:
1083 case LFUN_BIBTEX_DATABASE_ADD:
1084 case LFUN_BIBTEX_DATABASE_DEL:
1085 case LFUN_STATISTICS:
1086 case LFUN_KEYMAP_OFF:
1087 case LFUN_KEYMAP_PRIMARY:
1088 case LFUN_KEYMAP_SECONDARY:
1089 case LFUN_KEYMAP_TOGGLE:
1090 case LFUN_INSET_SELECT_ALL:
1091 flag.setEnabled(true);
1094 case LFUN_WORD_FINDADV: {
1095 FindAndReplaceOptions opt;
1096 istringstream iss(to_utf8(cmd.argument()));
1098 flag.setEnabled(opt.repl_buf_name.empty()
1099 || !buffer_.isReadonly());
1102 case LFUN_LABEL_GOTO: {
1103 flag.setEnabled(!cmd.argument().empty()
1104 || getInsetByCode<InsetRef>(cur, REF_CODE));
1108 case LFUN_CHANGES_TRACK:
1109 flag.setEnabled(true);
1110 flag.setOnOff(buffer_.params().track_changes);
1113 case LFUN_CHANGES_OUTPUT:
1114 flag.setEnabled(true);
1115 flag.setOnOff(buffer_.params().output_changes);
1118 case LFUN_CHANGES_MERGE:
1119 case LFUN_CHANGE_NEXT:
1120 case LFUN_CHANGE_PREVIOUS:
1121 case LFUN_ALL_CHANGES_ACCEPT:
1122 case LFUN_ALL_CHANGES_REJECT:
1123 // TODO: context-sensitive enabling of LFUNs
1124 // In principle, these command should only be enabled if there
1125 // is a change in the document. However, without proper
1126 // optimizations, this will inevitably result in poor performance.
1127 flag.setEnabled(true);
1130 case LFUN_BUFFER_TOGGLE_COMPRESSION: {
1131 flag.setOnOff(buffer_.params().compressed);
1135 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC: {
1136 flag.setOnOff(buffer_.params().output_sync);
1140 case LFUN_SCREEN_UP:
1141 case LFUN_SCREEN_DOWN:
1143 case LFUN_SCREEN_UP_SELECT:
1144 case LFUN_SCREEN_DOWN_SELECT:
1145 case LFUN_INSET_FORALL:
1146 flag.setEnabled(true);
1149 case LFUN_LAYOUT_TABULAR:
1150 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
1154 flag.setEnabled(!cur.inset().forcePlainLayout(cur.idx()));
1157 case LFUN_LAYOUT_PARAGRAPH:
1158 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
1161 case LFUN_BRANCH_ADD_INSERT:
1162 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1165 case LFUN_DIALOG_SHOW_NEW_INSET:
1166 // FIXME: this is wrong, but I do not understand the
1168 if (cur.inset().lyxCode() == CAPTION_CODE)
1169 return cur.inset().getStatus(cur, cmd, flag);
1170 // FIXME we should consider passthru paragraphs too.
1171 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1174 case LFUN_CITATION_INSERT: {
1175 FuncRequest fr(LFUN_INSET_INSERT, "citation");
1176 // FIXME: This could turn in a recursive hell.
1177 // Shouldn't we use Buffer::getStatus() instead?
1178 flag.setEnabled(lyx::getStatus(fr).enabled());
1181 case LFUN_INSET_APPLY: {
1182 string const name = cmd.getArg(0);
1183 Inset * inset = editedInset(name);
1185 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1186 if (!inset->getStatus(cur, fr, flag)) {
1187 // Every inset is supposed to handle this
1188 LASSERT(false, break);
1191 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1192 flag = lyx::getStatus(fr);
1205 Inset * BufferView::editedInset(string const & name) const
1207 map<string, Inset *>::const_iterator it = d->edited_insets_.find(name);
1208 return it == d->edited_insets_.end() ? 0 : it->second;
1212 void BufferView::editInset(string const & name, Inset * inset)
1214 d->edited_insets_[name] = inset;
1218 void BufferView::dispatch(FuncRequest const & cmd, DispatchResult & dr)
1220 LYXERR(Debug::ACTION, "BufferView::dispatch: cmd: " << cmd);
1222 string const argument = to_utf8(cmd.argument());
1223 Cursor & cur = d->cursor_;
1225 // Don't dispatch function that does not apply to internal buffers.
1226 if (buffer_.isInternal()
1227 && lyxaction.funcHasFlag(cmd.action(), LyXAction::NoInternal))
1230 // We'll set this back to false if need be.
1231 bool dispatched = true;
1232 buffer_.undo().beginUndoGroup();
1234 FuncCode const act = cmd.action();
1237 case LFUN_BUFFER_PARAMS_APPLY: {
1238 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1239 cur.recordUndoFullDocument();
1240 istringstream ss(to_utf8(cmd.argument()));
1243 int const unknown_tokens = buffer_.readHeader(lex);
1244 if (unknown_tokens != 0) {
1245 LYXERR0("Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1246 << unknown_tokens << " unknown token"
1247 << (unknown_tokens == 1 ? "" : "s"));
1249 updateDocumentClass(olddc);
1251 // We are most certainly here because of a change in the document
1252 // It is then better to make sure that all dialogs are in sync with
1253 // current document settings.
1254 dr.screenUpdate(Update::Force | Update::FitCursor);
1255 dr.forceBufferUpdate();
1259 case LFUN_LAYOUT_MODULES_CLEAR: {
1260 cur.recordUndoFullDocument();
1261 buffer_.params().clearLayoutModules();
1262 makeDocumentClass();
1263 dr.screenUpdate(Update::Force);
1264 dr.forceBufferUpdate();
1268 case LFUN_LAYOUT_MODULE_ADD: {
1269 BufferParams const & params = buffer_.params();
1270 if (!params.layoutModuleCanBeAdded(argument)) {
1271 LYXERR0("Module `" << argument <<
1272 "' cannot be added due to failed requirements or "
1273 "conflicts with installed modules.");
1276 cur.recordUndoFullDocument();
1277 buffer_.params().addLayoutModule(argument);
1278 makeDocumentClass();
1279 dr.screenUpdate(Update::Force);
1280 dr.forceBufferUpdate();
1284 case LFUN_TEXTCLASS_APPLY: {
1285 // since this shortcircuits, the second call is made only if
1287 bool const success =
1288 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1289 LayoutFileList::get().load(argument, buffer_.filePath());
1291 docstring s = bformat(_("The document class `%1$s' "
1292 "could not be loaded."), from_utf8(argument));
1293 frontend::Alert::error(_("Could not load class"), s);
1297 LayoutFile const * old_layout = buffer_.params().baseClass();
1298 LayoutFile const * new_layout = &(LayoutFileList::get()[argument]);
1300 if (old_layout == new_layout)
1304 // Save the old, possibly modular, layout for use in conversion.
1305 cur.recordUndoFullDocument();
1306 buffer_.params().setBaseClass(argument);
1307 makeDocumentClass();
1308 dr.screenUpdate(Update::Force);
1309 dr.forceBufferUpdate();
1313 case LFUN_TEXTCLASS_LOAD: {
1314 // since this shortcircuits, the second call is made only if
1316 bool const success =
1317 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1318 LayoutFileList::get().load(argument, buffer_.filePath());
1320 docstring s = bformat(_("The document class `%1$s' "
1321 "could not be loaded."), from_utf8(argument));
1322 frontend::Alert::error(_("Could not load class"), s);
1327 case LFUN_LAYOUT_RELOAD: {
1328 LayoutFileIndex bc = buffer_.params().baseClassID();
1329 LayoutFileList::get().reset(bc);
1330 buffer_.params().setBaseClass(bc);
1331 makeDocumentClass();
1332 dr.screenUpdate(Update::Force);
1333 dr.forceBufferUpdate();
1338 dr.setMessage(_("Undo"));
1339 cur.clearSelection();
1340 if (!cur.textUndo())
1341 dr.setMessage(_("No further undo information"));
1343 dr.screenUpdate(Update::Force | Update::FitCursor);
1344 dr.forceBufferUpdate();
1348 dr.setMessage(_("Redo"));
1349 cur.clearSelection();
1350 if (!cur.textRedo())
1351 dr.setMessage(_("No further redo information"));
1353 dr.screenUpdate(Update::Force | Update::FitCursor);
1354 dr.forceBufferUpdate();
1357 case LFUN_FONT_STATE:
1358 dr.setMessage(cur.currentState());
1361 case LFUN_BOOKMARK_SAVE:
1362 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1365 case LFUN_LABEL_GOTO: {
1366 docstring label = cmd.argument();
1367 if (label.empty()) {
1369 getInsetByCode<InsetRef>(cur, REF_CODE);
1371 label = inset->getParam("reference");
1372 // persistent=false: use temp_bookmark
1376 if (!label.empty()) {
1378 // at the moment, this is redundant, since gotoLabel will
1379 // eventually call LFUN_PARAGRAPH_GOTO, but it seems best
1381 dr.screenUpdate(Update::Force | Update::FitCursor);
1386 case LFUN_PARAGRAPH_GOTO: {
1387 int const id = convert<int>(cmd.getArg(0));
1388 int const pos = convert<int>(cmd.getArg(1));
1390 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1391 b = theBufferList().next(b)) {
1393 DocIterator dit = b->getParFromID(id);
1395 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1399 LYXERR(Debug::INFO, "Paragraph " << dit.paragraph().id()
1400 << " found in buffer `"
1401 << b->absFileName() << "'.");
1403 if (b == &buffer_) {
1407 dr.screenUpdate(Update::Force | Update::FitCursor);
1409 // Switch to other buffer view and resend cmd
1410 lyx::dispatch(FuncRequest(
1411 LFUN_BUFFER_SWITCH, b->absFileName()));
1419 case LFUN_NOTE_NEXT:
1420 gotoInset(this, NOTE_CODE, false);
1423 case LFUN_REFERENCE_NEXT: {
1424 vector<InsetCode> tmp;
1425 tmp.push_back(LABEL_CODE);
1426 tmp.push_back(REF_CODE);
1427 gotoInset(this, tmp, true);
1431 case LFUN_CHANGES_TRACK:
1432 buffer_.params().track_changes = !buffer_.params().track_changes;
1435 case LFUN_CHANGES_OUTPUT:
1436 buffer_.params().output_changes = !buffer_.params().output_changes;
1437 if (buffer_.params().output_changes) {
1438 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1439 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1440 LaTeXFeatures::isAvailable("xcolor");
1442 if (!dvipost && !xcolorulem) {
1443 Alert::warning(_("Changes not shown in LaTeX output"),
1444 _("Changes will not be highlighted in LaTeX output, "
1445 "because neither dvipost nor xcolor/ulem are installed.\n"
1446 "Please install these packages or redefine "
1447 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1448 } else if (!xcolorulem) {
1449 Alert::warning(_("Changes not shown in LaTeX output"),
1450 _("Changes will not be highlighted in LaTeX output "
1451 "when using pdflatex, because xcolor and ulem are not installed.\n"
1452 "Please install both packages or redefine "
1453 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1458 case LFUN_CHANGE_NEXT:
1459 findNextChange(this);
1460 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1461 dr.screenUpdate(Update::Force | Update::FitCursor);
1464 case LFUN_CHANGE_PREVIOUS:
1465 findPreviousChange(this);
1466 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1467 dr.screenUpdate(Update::Force | Update::FitCursor);
1470 case LFUN_CHANGES_MERGE:
1471 if (findNextChange(this) || findPreviousChange(this)) {
1472 dr.screenUpdate(Update::Force | Update::FitCursor);
1473 dr.forceBufferUpdate();
1474 showDialog("changes");
1478 case LFUN_ALL_CHANGES_ACCEPT:
1479 // select complete document
1481 cur.selHandle(true);
1482 buffer_.text().cursorBottom(cur);
1483 // accept everything in a single step to support atomic undo
1484 buffer_.text().acceptOrRejectChanges(cur, Text::ACCEPT);
1486 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1487 dr.screenUpdate(Update::Force | Update::FitCursor);
1488 dr.forceBufferUpdate();
1491 case LFUN_ALL_CHANGES_REJECT:
1492 // select complete document
1494 cur.selHandle(true);
1495 buffer_.text().cursorBottom(cur);
1496 // reject everything in a single step to support atomic undo
1497 // Note: reject does not work recursively; the user may have to repeat the operation
1498 buffer_.text().acceptOrRejectChanges(cur, Text::REJECT);
1500 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1501 dr.screenUpdate(Update::Force | Update::FitCursor);
1502 dr.forceBufferUpdate();
1505 case LFUN_WORD_FIND_FORWARD:
1506 case LFUN_WORD_FIND_BACKWARD: {
1508 // Would it maybe be better if this variable were view specific anyway?
1509 static docstring last_search;
1510 docstring searched_string;
1512 if (!cmd.argument().empty()) {
1513 last_search = cmd.argument();
1514 searched_string = cmd.argument();
1516 searched_string = last_search;
1519 if (searched_string.empty())
1522 bool const fw = act == LFUN_WORD_FIND_FORWARD;
1523 docstring const data =
1524 find2string(searched_string, true, false, fw);
1525 bool found = lyxfind(this, FuncRequest(LFUN_WORD_FIND, data));
1527 dr.screenUpdate(Update::Force | Update::FitCursor);
1537 case LFUN_WORD_FIND: {
1538 FuncRequest req = cmd;
1539 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1540 req = d->search_request_cache_;
1541 if (req.argument().empty()) {
1542 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, "findreplace"));
1545 if (lyxfind(this, req)) {
1546 dr.screenUpdate(Update::Force | Update::FitCursor);
1553 d->search_request_cache_ = req;
1557 case LFUN_WORD_REPLACE: {
1558 bool has_deleted = false;
1559 if (cur.selection()) {
1560 DocIterator beg = cur.selectionBegin();
1561 DocIterator end = cur.selectionEnd();
1562 if (beg.pit() == end.pit()) {
1563 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1564 if (!cur.inMathed() && cur.paragraph().isDeleted(p)) {
1571 if (lyxreplace(this, cmd, has_deleted)) {
1572 dr.forceBufferUpdate();
1573 dr.screenUpdate(Update::Force | Update::FitCursor);
1583 case LFUN_WORD_FINDADV: {
1584 FindAndReplaceOptions opt;
1585 istringstream iss(to_utf8(cmd.argument()));
1587 if (findAdv(this, opt)) {
1588 dr.screenUpdate(Update::Force | Update::FitCursor);
1599 cur.clearSelection();
1600 dr.setMessage(from_utf8(N_("Mark off")));
1604 cur.clearSelection();
1606 dr.setMessage(from_utf8(N_("Mark on")));
1609 case LFUN_MARK_TOGGLE:
1610 cur.setSelection(false);
1613 dr.setMessage(from_utf8(N_("Mark removed")));
1616 dr.setMessage(from_utf8(N_("Mark set")));
1621 case LFUN_SCREEN_SHOW_CURSOR:
1625 case LFUN_SCREEN_RECENTER:
1629 case LFUN_BIBTEX_DATABASE_ADD: {
1630 Cursor tmpcur = cur;
1631 findInset(tmpcur, BIBTEX_CODE, false);
1632 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1635 if (inset->addDatabase(cmd.argument())) {
1636 buffer_.invalidateBibfileCache();
1637 dr.forceBufferUpdate();
1643 case LFUN_BIBTEX_DATABASE_DEL: {
1644 Cursor tmpcur = cur;
1645 findInset(tmpcur, BIBTEX_CODE, false);
1646 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1649 if (inset->delDatabase(cmd.argument())) {
1650 buffer_.invalidateBibfileCache();
1651 dr.forceBufferUpdate();
1657 case LFUN_STATISTICS: {
1658 DocIterator from, to;
1659 if (cur.selection()) {
1660 from = cur.selectionBegin();
1661 to = cur.selectionEnd();
1663 from = doc_iterator_begin(&buffer_);
1664 to = doc_iterator_end(&buffer_);
1666 buffer_.updateStatistics(from, to);
1667 int const words = buffer_.wordCount();
1668 int const chars = buffer_.charCount(false);
1669 int const chars_blanks = buffer_.charCount(true);
1671 if (cur.selection())
1672 message = _("Statistics for the selection:");
1674 message = _("Statistics for the document:");
1677 message += bformat(_("%1$d words"), words);
1679 message += _("One word");
1681 if (chars_blanks != 1)
1682 message += bformat(_("%1$d characters (including blanks)"),
1685 message += _("One character (including blanks)");
1688 message += bformat(_("%1$d characters (excluding blanks)"),
1691 message += _("One character (excluding blanks)");
1693 Alert::information(_("Statistics"), message);
1697 case LFUN_BUFFER_TOGGLE_COMPRESSION:
1698 // turn compression on/off
1699 buffer_.params().compressed = !buffer_.params().compressed;
1702 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
1703 buffer_.params().output_sync = !buffer_.params().output_sync;
1706 case LFUN_SCREEN_UP:
1707 case LFUN_SCREEN_DOWN: {
1708 Point p = getPos(cur);
1709 // This code has been commented out to enable to scroll down a
1710 // document, even if there are large insets in it (see bug #5465).
1711 /*if (p.y_ < 0 || p.y_ > height_) {
1712 // The cursor is off-screen so recenter before proceeding.
1716 int const scrolled = scroll(act == LFUN_SCREEN_UP
1717 ? -height_ : height_);
1718 if (act == LFUN_SCREEN_UP && scrolled > -height_)
1720 if (act == LFUN_SCREEN_DOWN && scrolled < height_)
1721 p = Point(width_, height_);
1723 bool const in_texted = cur.inTexted();
1724 cur.setCursor(doc_iterator_begin(cur.buffer()));
1725 cur.selHandle(false);
1726 buffer_.changed(true);
1727 updateHoveredInset();
1729 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_,
1730 true, act == LFUN_SCREEN_UP);
1731 //FIXME: what to do with cur.x_target()?
1732 bool update = in_texted && cur.bv().checkDepm(cur, old);
1735 if (update || cur.mark())
1736 dr.screenUpdate(Update::Force | Update::FitCursor);
1738 dr.forceBufferUpdate();
1743 string const scroll_type = cmd.getArg(0);
1744 int scroll_step = 0;
1745 if (scroll_type == "line")
1746 scroll_step = d->scrollbarParameters_.single_step;
1747 else if (scroll_type == "page")
1748 scroll_step = d->scrollbarParameters_.page_step;
1751 string const scroll_quantity = cmd.getArg(1);
1752 if (scroll_quantity == "up")
1753 scrollUp(scroll_step);
1754 else if (scroll_quantity == "down")
1755 scrollDown(scroll_step);
1757 int const scroll_value = convert<int>(scroll_quantity);
1759 scroll(scroll_step * scroll_value);
1761 buffer_.changed(true);
1762 updateHoveredInset();
1763 dr.forceBufferUpdate();
1767 case LFUN_SCREEN_UP_SELECT: {
1768 // FIXME: why is the algorithm different from LFUN_SCREEN_UP?
1769 cur.selHandle(true);
1770 if (isTopScreen()) {
1771 lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1775 int y = getPos(cur).y_;
1776 int const ymin = y - height_ + defaultRowHeight();
1777 while (y > ymin && cur.up())
1781 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1785 case LFUN_SCREEN_DOWN_SELECT: {
1786 // FIXME: why is the algorithm different from LFUN_SCREEN_DOWN?
1787 cur.selHandle(true);
1788 if (isBottomScreen()) {
1789 lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1793 int y = getPos(cur).y_;
1794 int const ymax = y + height_ - defaultRowHeight();
1795 while (y < ymax && cur.down())
1799 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1804 case LFUN_INSET_SELECT_ALL:
1806 && cur.selBegin().at_begin()
1807 && cur.selEnd().at_end()) {
1808 // All the contents of the inset if selected.
1809 // Select the inset from outside.
1812 cur.setSelection(true);
1814 } else if (cur.selBegin().idx() != cur.selEnd().idx()
1816 && cur.selBegin().at_cell_begin()
1817 && cur.selEnd().at_cell_end())) {
1818 // At least one complete cell is selected.
1823 cur.setSelection(true);
1824 cur.idx() = cur.lastidx();
1825 cur.pos() = cur.lastpos();
1827 // select current cell
1831 cur.setSelection(true);
1832 cur.pit() = cur.lastpit();
1833 cur.pos() = cur.lastpos();
1835 dr.screenUpdate(Update::Force);
1839 // This would be in Buffer class if only Cursor did not
1840 // require a bufferview
1841 case LFUN_INSET_FORALL: {
1842 docstring const name = from_utf8(cmd.getArg(0));
1843 string const commandstr = cmd.getLongArg(1);
1844 FuncRequest const fr = lyxaction.lookupFunc(commandstr);
1846 // an arbitrary number to limit number of iterations
1847 const int max_iter = 100000;
1849 Cursor & cur = d->cursor_;
1850 Cursor const savecur = cur;
1852 if (!cur.nextInset())
1854 cur.beginUndoGroup();
1855 while(cur && iterations < max_iter) {
1856 Inset * const ins = cur.nextInset();
1859 docstring insname = ins->layoutName();
1860 while (!insname.empty()) {
1861 if (insname == name || name == from_utf8("*")) {
1863 lyx::dispatch(fr, dr);
1867 size_t const i = insname.rfind(':');
1868 if (i == string::npos)
1870 insname = insname.substr(0, i);
1872 // if we did not delete the inset, skip it
1873 if (!cur.nextInset() || cur.nextInset() == ins)
1879 dr.screenUpdate(Update::Force);
1880 dr.forceBufferUpdate();
1882 if (iterations >= max_iter) {
1884 dr.setMessage(bformat(_("`inset-forall' interrupted because number of actions is larger than %1$d"), max_iter));
1886 dr.setMessage(bformat(_("Applied \"%1$s\" to %2$d insets"), from_utf8(commandstr), iterations));
1891 case LFUN_BRANCH_ADD_INSERT: {
1892 docstring branch_name = from_utf8(cmd.getArg(0));
1893 if (branch_name.empty())
1894 if (!Alert::askForText(branch_name, _("Branch name")) ||
1895 branch_name.empty())
1898 DispatchResult drtmp;
1899 buffer_.dispatch(FuncRequest(LFUN_BRANCH_ADD, branch_name), drtmp);
1900 if (drtmp.error()) {
1901 Alert::warning(_("Branch already exists"), drtmp.message());
1904 BranchList & branch_list = buffer_.params().branchlist();
1905 vector<docstring> const branches =
1906 getVectorFromString(branch_name, branch_list.separator());
1907 for (vector<docstring>::const_iterator it = branches.begin();
1908 it != branches.end(); ++it) {
1910 lyx::dispatch(FuncRequest(LFUN_BRANCH_INSERT, branch_name));
1915 case LFUN_KEYMAP_OFF:
1916 getIntl().keyMapOn(false);
1919 case LFUN_KEYMAP_PRIMARY:
1920 getIntl().keyMapPrim();
1923 case LFUN_KEYMAP_SECONDARY:
1924 getIntl().keyMapSec();
1927 case LFUN_KEYMAP_TOGGLE:
1928 getIntl().toggleKeyMap();
1931 case LFUN_DIALOG_SHOW_NEW_INSET: {
1932 string const name = cmd.getArg(0);
1933 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
1934 if (decodeInsetParam(name, data, buffer_))
1935 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
1937 lyxerr << "Inset type '" << name <<
1938 "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" << endl;
1942 case LFUN_CITATION_INSERT: {
1943 if (argument.empty()) {
1944 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
1947 // we can have one optional argument, delimited by '|'
1948 // citation-insert <key>|<text_before>
1949 // this should be enhanced to also support text_after
1950 // and citation style
1951 string arg = argument;
1953 if (contains(argument, "|")) {
1954 arg = token(argument, '|', 0);
1955 opt1 = token(argument, '|', 1);
1958 // if our cursor is directly in front of or behind a citation inset,
1959 // we will instead add the new key to it.
1960 Inset * inset = cur.nextInset();
1961 if (!inset || inset->lyxCode() != CITE_CODE)
1962 inset = cur.prevInset();
1963 if (inset && inset->lyxCode() == CITE_CODE) {
1964 InsetCitation * icite = static_cast<InsetCitation *>(inset);
1965 if (icite->addKey(arg)) {
1966 dr.forceBufferUpdate();
1967 dr.screenUpdate(Update::FitCursor | Update::SinglePar);
1969 LYXERR0("Discarding optional argument to citation-insert.");
1974 InsetCommandParams icp(CITE_CODE);
1975 icp["key"] = from_utf8(arg);
1977 icp["before"] = from_utf8(opt1);
1978 string icstr = InsetCommand::params2string(icp);
1979 FuncRequest fr(LFUN_INSET_INSERT, icstr);
1984 case LFUN_INSET_APPLY: {
1985 string const name = cmd.getArg(0);
1986 Inset * inset = editedInset(name);
1988 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1992 // put cursor in front of inset.
1993 if (!setCursorFromInset(inset)) {
1994 LASSERT(false, break);
1997 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1998 inset->dispatch(cur, fr);
1999 dr.screenUpdate(cur.result().screenUpdate());
2000 if (cur.result().needBufferUpdate())
2001 dr.forceBufferUpdate();
2006 // The change of language of buffer belongs to the Buffer class.
2007 // We have to do it here because we need a cursor for Undo.
2008 // When Undo::recordUndoBufferParams() is implemented someday
2009 // LFUN_BUFFER_LANGUAGE should be handled by the Buffer class.
2010 case LFUN_BUFFER_LANGUAGE: {
2011 Language const * oldL = buffer_.params().language;
2012 Language const * newL = languages.getLanguage(argument);
2013 if (!newL || oldL == newL)
2015 if (oldL->rightToLeft() == newL->rightToLeft()) {
2016 cur.recordUndoFullDocument();
2017 buffer_.changeLanguage(oldL, newL);
2018 cur.setCurrentFont();
2019 dr.forceBufferUpdate();
2024 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
2025 case LFUN_FILE_INSERT_PLAINTEXT: {
2026 bool const as_paragraph = (act == LFUN_FILE_INSERT_PLAINTEXT_PARA);
2027 string const fname = to_utf8(cmd.argument());
2028 if (!FileName::isAbsolute(fname))
2029 dr.setMessage(_("Absolute filename expected."));
2031 insertPlaintextFile(FileName(fname), as_paragraph);
2036 // OK, so try the Buffer itself...
2037 buffer_.dispatch(cmd, dr);
2038 dispatched = dr.dispatched();
2042 buffer_.undo().endUndoGroup();
2043 dr.dispatched(dispatched);
2047 docstring const BufferView::requestSelection()
2049 Cursor & cur = d->cursor_;
2051 LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
2052 if (!cur.selection()) {
2053 d->xsel_cache_.set = false;
2057 LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
2058 if (!d->xsel_cache_.set ||
2059 cur.top() != d->xsel_cache_.cursor ||
2060 cur.realAnchor().top() != d->xsel_cache_.anchor)
2062 d->xsel_cache_.cursor = cur.top();
2063 d->xsel_cache_.anchor = cur.realAnchor().top();
2064 d->xsel_cache_.set = cur.selection();
2065 return cur.selectionAsString(false);
2071 void BufferView::clearSelection()
2073 d->cursor_.clearSelection();
2074 // Clear the selection buffer. Otherwise a subsequent
2075 // middle-mouse-button paste would use the selection buffer,
2076 // not the more current external selection.
2077 cap::clearSelection();
2078 d->xsel_cache_.set = false;
2079 // The buffer did not really change, but this causes the
2080 // redraw we need because we cleared the selection above.
2081 buffer_.changed(false);
2085 void BufferView::resize(int width, int height)
2087 // Update from work area
2091 // Clear the paragraph height cache.
2092 d->par_height_.clear();
2093 // Redo the metrics.
2098 Inset const * BufferView::getCoveringInset(Text const & text,
2101 TextMetrics & tm = d->text_metrics_[&text];
2102 Inset * inset = tm.checkInsetHit(x, y);
2106 if (!inset->descendable(*this))
2107 // No need to go further down if the inset is not
2111 size_t cell_number = inset->nargs();
2112 // Check all the inner cell.
2113 for (size_t i = 0; i != cell_number; ++i) {
2114 Text const * inner_text = inset->getText(i);
2117 Inset const * inset_deeper =
2118 getCoveringInset(*inner_text, x, y);
2120 return inset_deeper;
2128 void BufferView::updateHoveredInset() const
2130 // Get inset under mouse, if there is one.
2131 int const x = d->mouse_position_cache_.x_;
2132 int const y = d->mouse_position_cache_.y_;
2133 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
2135 d->clickable_inset_ = covering_inset && covering_inset->clickable(x, y);
2137 if (covering_inset == d->last_inset_)
2138 // Same inset, no need to do anything...
2141 bool need_redraw = false;
2142 if (d->last_inset_) {
2143 // Remove the hint on the last hovered inset (if any).
2144 need_redraw |= d->last_inset_->setMouseHover(this, false);
2148 if (covering_inset && covering_inset->setMouseHover(this, true)) {
2150 // Only the insets that accept the hover state, do
2151 // clear the last_inset_, so only set the last_inset_
2152 // member if the hovered setting is accepted.
2153 d->last_inset_ = covering_inset;
2157 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
2158 << d->mouse_position_cache_.x_ << ", "
2159 << d->mouse_position_cache_.y_ << ")");
2161 d->update_strategy_ = DecorationUpdate;
2163 // This event (moving without mouse click) is not passed further.
2164 // This should be changed if it is further utilized.
2165 buffer_.changed(false);
2170 void BufferView::clearLastInset(Inset * inset) const
2172 if (d->last_inset_ != inset) {
2173 LYXERR0("Wrong last_inset!");
2180 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
2182 //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
2184 // This is only called for mouse related events including
2185 // LFUN_FILE_OPEN generated by drag-and-drop.
2186 FuncRequest cmd = cmd0;
2188 Cursor old = cursor();
2190 cur.push(buffer_.inset());
2191 cur.setSelection(d->cursor_.selection());
2193 // Either the inset under the cursor or the
2194 // surrounding Text will handle this event.
2196 // make sure we stay within the screen...
2197 cmd.set_y(min(max(cmd.y(), -1), height_));
2199 d->mouse_position_cache_.x_ = cmd.x();
2200 d->mouse_position_cache_.y_ = cmd.y();
2202 if (cmd.action() == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
2203 updateHoveredInset();
2207 // Build temporary cursor.
2208 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x(), cmd.y());
2210 // Put anchor at the same position.
2213 cur.beginUndoGroup();
2215 // Try to dispatch to an non-editable inset near this position
2216 // via the temp cursor. If the inset wishes to change the real
2217 // cursor it has to do so explicitly by using
2218 // cur.bv().cursor() = cur; (or similar)
2220 inset->dispatch(cur, cmd);
2222 // Now dispatch to the temporary cursor. If the real cursor should
2223 // be modified, the inset's dispatch has to do so explicitly.
2224 if (!inset || !cur.result().dispatched())
2229 // Notify left insets
2231 bool badcursor = old.fixIfBroken() | cur.fixIfBroken();
2232 badcursor |= notifyCursorLeavesOrEnters(old, cur);
2234 cursor().fixIfBroken();
2237 // Do we have a selection?
2238 theSelection().haveSelection(cursor().selection());
2240 if (cur.needBufferUpdate()) {
2241 cur.clearBufferUpdate();
2242 buffer().updateBuffer();
2245 // If the command has been dispatched,
2246 if (cur.result().dispatched() || cur.result().screenUpdate())
2247 processUpdateFlags(cur.result().screenUpdate());
2251 int BufferView::minVisiblePart()
2253 return 2 * defaultRowHeight();
2257 int BufferView::scroll(int y)
2260 return scrollDown(y);
2262 return scrollUp(-y);
2267 int BufferView::scrollDown(int offset)
2269 Text * text = &buffer_.text();
2270 TextMetrics & tm = d->text_metrics_[text];
2271 int const ymax = height_ + offset;
2273 pair<pit_type, ParagraphMetrics const *> last = tm.last();
2274 int bottom_pos = last.second->position() + last.second->descent();
2275 if (lyxrc.scroll_below_document)
2276 bottom_pos += height_ - minVisiblePart();
2277 if (last.first + 1 == int(text->paragraphs().size())) {
2278 if (bottom_pos <= height_)
2280 offset = min(offset, bottom_pos - height_);
2283 if (bottom_pos > ymax)
2285 tm.newParMetricsDown();
2287 d->anchor_ypos_ -= offset;
2292 int BufferView::scrollUp(int offset)
2294 Text * text = &buffer_.text();
2295 TextMetrics & tm = d->text_metrics_[text];
2296 int ymin = - offset;
2298 pair<pit_type, ParagraphMetrics const *> first = tm.first();
2299 int top_pos = first.second->position() - first.second->ascent();
2300 if (first.first == 0) {
2303 offset = min(offset, - top_pos);
2308 tm.newParMetricsUp();
2310 d->anchor_ypos_ += offset;
2315 void BufferView::setCursorFromRow(int row)
2319 pit_type newpit = 0;
2320 pos_type newpos = 0;
2322 buffer_.texrow().getIdFromRow(row, tmpid, tmppos);
2324 bool posvalid = (tmpid != -1);
2326 // we need to make sure that the row and position
2327 // we got back are valid, because the buffer may well
2328 // have changed since we last generated the LaTeX.
2329 DocIterator dit = buffer_.getParFromID(tmpid);
2330 if (dit == doc_iterator_end(&buffer_))
2332 else if (dit.depth() > 1) {
2333 // We are in an inset.
2334 pos_type lastpos = dit.lastpos();
2335 dit.pos() = tmppos > lastpos ? lastpos : tmppos;
2341 // now have to check pos.
2343 Paragraph const & par = buffer_.text().getPar(newpit);
2344 if (newpos > par.size()) {
2345 LYXERR0("Requested position no longer valid.");
2346 newpos = par.size() - 1;
2351 frontend::Alert::error(_("Inverse Search Failed"),
2352 _("Invalid position requested by inverse search.\n"
2353 "You need to update the viewed document."));
2357 buffer_.text().setCursor(d->cursor_, newpit, newpos);
2358 d->cursor_.setSelection(false);
2359 d->cursor_.resetAnchor();
2364 bool BufferView::setCursorFromInset(Inset const * inset)
2366 // are we already there?
2367 if (cursor().nextInset() == inset)
2370 // Inset is not at cursor position. Find it in the document.
2373 while (cur && cur.nextInset() != inset)
2384 void BufferView::gotoLabel(docstring const & label)
2386 ListOfBuffers bufs = buffer().allRelatives();
2387 ListOfBuffers::iterator it = bufs.begin();
2388 for (; it != bufs.end(); ++it) {
2389 Buffer const * buf = *it;
2392 Toc & toc = buf->tocBackend().toc("label");
2393 TocIterator toc_it = toc.begin();
2394 TocIterator end = toc.end();
2395 for (; toc_it != end; ++toc_it) {
2396 if (label == toc_it->str()) {
2397 lyx::dispatch(toc_it->action());
2405 TextMetrics const & BufferView::textMetrics(Text const * t) const
2407 return const_cast<BufferView *>(this)->textMetrics(t);
2411 TextMetrics & BufferView::textMetrics(Text const * t)
2414 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
2415 if (tmc_it == d->text_metrics_.end()) {
2416 tmc_it = d->text_metrics_.insert(
2417 make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
2419 return tmc_it->second;
2423 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
2426 return textMetrics(t).parMetrics(pit);
2430 int BufferView::workHeight() const
2436 void BufferView::setCursor(DocIterator const & dit)
2439 size_t const n = dit.depth();
2440 for (size_t i = 0; i < n; ++i)
2441 dit[i].inset().edit(d->cursor_, true);
2443 d->cursor_.setCursor(dit);
2444 d->cursor_.setSelection(false);
2446 // It seems on general grounds as if this is probably needed, but
2447 // it is not yet clear.
2448 // See bug #7394 and r38388.
2449 // d->cursor.resetAnchor();
2453 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
2455 // Would be wrong to delete anything if we have a selection.
2456 if (cur.selection())
2459 bool need_anchor_change = false;
2460 bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
2461 need_anchor_change);
2463 if (need_anchor_change)
2471 // we would rather not do this here, but it needs to be done before
2472 // the changed() signal is sent.
2473 buffer_.updateBuffer();
2475 buffer_.changed(true);
2480 bool BufferView::mouseSetCursor(Cursor & cur, bool select)
2482 LASSERT(&cur.bv() == this, return false);
2485 // this event will clear selection so we save selection for
2486 // persistent selection
2487 cap::saveSelection(cursor());
2489 d->cursor_.macroModeClose();
2490 // If a macro has been finalized, the cursor might have been broken
2493 // Has the cursor just left the inset?
2494 bool const leftinset = (&d->cursor_.inset() != &cur.inset());
2496 d->cursor_.fixIfBroken();
2498 // FIXME: shift-mouse selection doesn't work well across insets.
2499 bool const do_selection =
2500 select && &d->cursor_.normalAnchor().inset() == &cur.inset();
2502 // do the dEPM magic if needed
2503 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
2504 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
2505 // the leftinset bool would not be necessary (badcursor instead).
2506 bool update = leftinset;
2507 if (!do_selection && d->cursor_.inTexted())
2508 update |= checkDepm(cur, d->cursor_);
2511 d->cursor_.resetAnchor();
2512 d->cursor_.setCursor(cur);
2513 d->cursor_.boundary(cur.boundary());
2515 d->cursor_.setSelection();
2517 d->cursor_.clearSelection();
2519 d->cursor_.finishUndo();
2520 d->cursor_.setCurrentFont();
2522 cur.forceBufferUpdate();
2527 void BufferView::putSelectionAt(DocIterator const & cur,
2528 int length, bool backwards)
2530 d->cursor_.clearSelection();
2536 d->cursor_.pos() += length;
2537 d->cursor_.setSelection(d->cursor_, -length);
2539 d->cursor_.setSelection(d->cursor_, length);
2544 bool BufferView::selectIfEmpty(DocIterator & cur)
2546 if ((cur.inTexted() && !cur.paragraph().empty())
2547 || (cur.inMathed() && !cur.cell().empty()))
2550 pit_type const beg_pit = cur.pit();
2552 // The paragraph associated to this item isn't
2553 // the first one, so it can be selected
2556 // We have to resort to select the space between the
2557 // end of this item and the begin of the next one
2561 // If it is the only item in the document,
2562 // nothing can be selected
2565 pit_type const end_pit = cur.pit();
2566 pos_type const end_pos = cur.pos();
2567 d->cursor_.clearSelection();
2569 d->cursor_.setCursor(cur);
2570 d->cursor_.pit() = beg_pit;
2571 d->cursor_.pos() = 0;
2572 d->cursor_.setSelection(false);
2573 d->cursor_.resetAnchor();
2574 d->cursor_.pit() = end_pit;
2575 d->cursor_.pos() = end_pos;
2576 d->cursor_.setSelection();
2581 Cursor & BufferView::cursor()
2587 Cursor const & BufferView::cursor() const
2593 pit_type BufferView::anchor_ref() const
2595 return d->anchor_pit_;
2599 bool BufferView::singleParUpdate()
2601 Text & buftext = buffer_.text();
2602 pit_type const bottom_pit = d->cursor_.bottom().pit();
2603 TextMetrics & tm = textMetrics(&buftext);
2604 int old_height = tm.parMetrics(bottom_pit).height();
2606 // make sure inline completion pointer is ok
2607 if (d->inlineCompletionPos_.fixIfBroken())
2608 d->inlineCompletionPos_ = DocIterator();
2610 // In Single Paragraph mode, rebreak only
2611 // the (main text, not inset!) paragraph containing the cursor.
2612 // (if this paragraph contains insets etc., rebreaking will
2613 // recursively descend)
2614 tm.redoParagraph(bottom_pit);
2615 ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
2616 if (pm.height() != old_height)
2617 // Paragraph height has changed so we cannot proceed to
2618 // the singlePar optimisation.
2621 d->update_strategy_ = SingleParUpdate;
2623 LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
2624 << " y2: " << pm.position() + pm.descent()
2625 << " pit: " << bottom_pit
2626 << " singlepar: 1");
2631 void BufferView::updateMetrics()
2633 if (height_ == 0 || width_ == 0)
2636 Text & buftext = buffer_.text();
2637 pit_type const npit = int(buftext.paragraphs().size());
2639 // Clear out the position cache in case of full screen redraw,
2640 d->coord_cache_.clear();
2642 // Clear out paragraph metrics to avoid having invalid metrics
2643 // in the cache from paragraphs not relayouted below
2644 // The complete text metrics will be redone.
2645 d->text_metrics_.clear();
2647 TextMetrics & tm = textMetrics(&buftext);
2649 // make sure inline completion pointer is ok
2650 if (d->inlineCompletionPos_.fixIfBroken())
2651 d->inlineCompletionPos_ = DocIterator();
2653 if (d->anchor_pit_ >= npit)
2654 // The anchor pit must have been deleted...
2655 d->anchor_pit_ = npit - 1;
2657 // Rebreak anchor paragraph.
2658 tm.redoParagraph(d->anchor_pit_);
2659 ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
2662 if (d->anchor_pit_ == 0) {
2663 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
2665 // Complete buffer visible? Then it's easy.
2666 if (scrollRange == 0)
2667 d->anchor_ypos_ = anchor_pm.ascent();
2669 // FIXME: Some clever handling needed to show
2670 // the _first_ paragraph up to the top if the cursor is
2671 // in the first line.
2673 anchor_pm.setPosition(d->anchor_ypos_);
2675 LYXERR(Debug::PAINTING, "metrics: "
2676 << " anchor pit = " << d->anchor_pit_
2677 << " anchor ypos = " << d->anchor_ypos_);
2679 // Redo paragraphs above anchor if necessary.
2680 int y1 = d->anchor_ypos_ - anchor_pm.ascent();
2681 // We are now just above the anchor paragraph.
2682 pit_type pit1 = d->anchor_pit_ - 1;
2683 for (; pit1 >= 0 && y1 >= 0; --pit1) {
2684 tm.redoParagraph(pit1);
2685 ParagraphMetrics & pm = tm.par_metrics_[pit1];
2687 // Save the paragraph position in the cache.
2692 // Redo paragraphs below the anchor if necessary.
2693 int y2 = d->anchor_ypos_ + anchor_pm.descent();
2694 // We are now just below the anchor paragraph.
2695 pit_type pit2 = d->anchor_pit_ + 1;
2696 for (; pit2 < npit && y2 <= height_; ++pit2) {
2697 tm.redoParagraph(pit2);
2698 ParagraphMetrics & pm = tm.par_metrics_[pit2];
2700 // Save the paragraph position in the cache.
2705 LYXERR(Debug::PAINTING, "Metrics: "
2706 << " anchor pit = " << d->anchor_pit_
2707 << " anchor ypos = " << d->anchor_ypos_
2710 << " pit1 = " << pit1
2711 << " pit2 = " << pit2);
2713 d->update_strategy_ = FullScreenUpdate;
2715 if (lyxerr.debugging(Debug::WORKAREA)) {
2716 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
2717 d->coord_cache_.dump();
2722 void BufferView::insertLyXFile(FileName const & fname)
2724 LASSERT(d->cursor_.inTexted(), return);
2726 // Get absolute path of file and add ".lyx"
2727 // to the filename if necessary
2728 FileName filename = fileSearch(string(), fname.absFileName(), "lyx");
2730 docstring const disp_fn = makeDisplayPath(filename.absFileName());
2731 // emit message signal.
2732 message(bformat(_("Inserting document %1$s..."), disp_fn));
2735 Buffer buf(filename.absFileName(), false);
2736 if (buf.loadLyXFile() == Buffer::ReadSuccess) {
2737 ErrorList & el = buffer_.errorList("Parse");
2738 // Copy the inserted document error list into the current buffer one.
2739 el = buf.errorList("Parse");
2740 buffer_.undo().recordUndo(d->cursor_);
2741 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
2742 buf.params().documentClassPtr(), el);
2743 res = _("Document %1$s inserted.");
2745 res = _("Could not insert document %1$s");
2748 buffer_.changed(true);
2749 // emit message signal.
2750 message(bformat(res, disp_fn));
2754 Point BufferView::coordOffset(DocIterator const & dit) const
2760 // Addup contribution of nested insets, from inside to outside,
2761 // keeping the outer paragraph for a special handling below
2762 for (size_t i = dit.depth() - 1; i >= 1; --i) {
2763 CursorSlice const & sl = dit[i];
2767 // get relative position inside sl.inset()
2768 sl.inset().cursorPos(*this, sl, dit.boundary() && (i + 1 == dit.depth()), xx, yy);
2770 // Make relative position inside of the edited inset relative to sl.inset()
2774 // In case of an RTL inset, the edited inset will be positioned to the left
2777 bool boundary_i = dit.boundary() && i + 1 == dit.depth();
2778 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2783 // remember width for the case that sl.inset() is positioned in an RTL inset
2784 if (i && dit[i - 1].text()) {
2785 // If this Inset is inside a Text Inset, retrieve the Dimension
2786 // from the containing text instead of using Inset::dimension() which
2787 // might not be implemented.
2788 // FIXME (Abdel 23/09/2007): this is a bit messy because of the
2789 // elimination of Inset::dim_ cache. This coordOffset() method needs
2790 // to be rewritten in light of the new design.
2791 Dimension const & dim = parMetrics(dit[i - 1].text(),
2792 dit[i - 1].pit()).insetDimension(&sl.inset());
2795 Dimension const dim = sl.inset().dimension(*this);
2799 //lyxerr << "Cursor::getPos, i: "
2800 // << i << " x: " << xx << " y: " << y << endl;
2803 // Add contribution of initial rows of outermost paragraph
2804 CursorSlice const & sl = dit[0];
2805 TextMetrics const & tm = textMetrics(sl.text());
2806 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2808 LBUFERR(!pm.rows().empty());
2809 y -= pm.rows()[0].ascent();
2811 // FIXME: document this mess
2813 if (sl.pos() > 0 && dit.depth() == 1) {
2815 if (pos && dit.boundary())
2817 // lyxerr << "coordOffset: boundary:" << dit.boundary() << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
2818 rend = pm.pos2row(pos);
2820 rend = pm.pos2row(sl.pos());
2822 size_t rend = pm.pos2row(sl.pos());
2824 for (size_t rit = 0; rit != rend; ++rit)
2825 y += pm.rows()[rit].height();
2826 y += pm.rows()[rend].ascent();
2828 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
2830 // Make relative position from the nested inset now bufferview absolute.
2831 int xx = bottom_tm.cursorX(dit.bottom(), dit.boundary() && dit.depth() == 1);
2834 // In the RTL case place the nested inset at the left of the cursor in
2835 // the outer paragraph
2836 bool boundary_1 = dit.boundary() && 1 == dit.depth();
2837 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
2845 Point BufferView::getPos(DocIterator const & dit) const
2847 if (!paragraphVisible(dit))
2848 return Point(-1, -1);
2850 CursorSlice const & bot = dit.bottom();
2851 TextMetrics const & tm = textMetrics(bot.text());
2853 // offset from outer paragraph
2854 Point p = coordOffset(dit);
2855 p.y_ += tm.parMetrics(bot.pit()).position();
2860 bool BufferView::paragraphVisible(DocIterator const & dit) const
2862 CursorSlice const & bot = dit.bottom();
2863 TextMetrics const & tm = textMetrics(bot.text());
2865 return tm.contains(bot.pit());
2869 void BufferView::cursorPosAndHeight(Point & p, int & h) const
2871 Cursor const & cur = cursor();
2872 Font const font = cur.getFont();
2873 frontend::FontMetrics const & fm = theFontMetrics(font);
2874 int const asc = fm.maxAscent();
2875 int const des = fm.maxDescent();
2882 bool BufferView::cursorInView(Point const & p, int h) const
2884 Cursor const & cur = cursor();
2885 // does the cursor touch the screen ?
2886 if (p.y_ + h < 0 || p.y_ >= workHeight() || !paragraphVisible(cur))
2892 void BufferView::draw(frontend::Painter & pain)
2894 if (height_ == 0 || width_ == 0)
2896 LYXERR(Debug::PAINTING, "\t\t*** START DRAWING ***");
2898 Text & text = buffer_.text();
2899 TextMetrics const & tm = d->text_metrics_[&text];
2900 int const y = tm.first().second->position();
2901 PainterInfo pi(this, pain);
2903 switch (d->update_strategy_) {
2905 case NoScreenUpdate:
2906 // If no screen painting is actually needed, only some the different
2907 // coordinates of insets and paragraphs needs to be updated.
2908 pi.full_repaint = true;
2909 pi.pain.setDrawingEnabled(false);
2913 case SingleParUpdate:
2914 pi.full_repaint = false;
2915 // In general, only the current row of the outermost paragraph
2916 // will be redrawn. Particular cases where selection spans
2917 // multiple paragraph are correctly detected in TextMetrics.
2921 case DecorationUpdate:
2922 // FIXME: We should also distinguish DecorationUpdate to avoid text
2923 // drawing if possible. This is not possible to do easily right now
2924 // because of the single backing pixmap.
2926 case FullScreenUpdate:
2927 // The whole screen, including insets, will be refreshed.
2928 pi.full_repaint = true;
2930 // Clear background.
2931 pain.fillRectangle(0, 0, width_, height_,
2932 pi.backgroundColor(&buffer_.inset()));
2937 // and possibly grey out below
2938 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2939 int const y2 = lastpm.second->position() + lastpm.second->descent();
2942 Color color = buffer().isInternal()
2943 ? Color_background : Color_bottomarea;
2944 pain.fillRectangle(0, y2, width_, height_ - y2, color);
2948 LYXERR(Debug::PAINTING, "\n\t\t*** END DRAWING ***");
2950 // The scrollbar needs an update.
2953 // Normalize anchor for next time
2954 pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
2955 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2956 for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
2957 ParagraphMetrics const & pm = tm.parMetrics(pit);
2958 if (pm.position() + pm.descent() > 0) {
2959 d->anchor_pit_ = pit;
2960 d->anchor_ypos_ = pm.position();
2964 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
2965 << " anchor ypos = " << d->anchor_ypos_);
2969 void BufferView::message(docstring const & msg)
2972 d->gui_->message(msg);
2976 void BufferView::showDialog(string const & name)
2979 d->gui_->showDialog(name, string());
2983 void BufferView::showDialog(string const & name,
2984 string const & data, Inset * inset)
2987 d->gui_->showDialog(name, data, inset);
2991 void BufferView::updateDialog(string const & name, string const & data)
2994 d->gui_->updateDialog(name, data);
2998 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
3004 // FIXME: Move this out of BufferView again
3005 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
3007 if (!fname.isReadableFile()) {
3008 docstring const error = from_ascii(strerror(errno));
3009 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3010 docstring const text =
3011 bformat(_("Could not read the specified document\n"
3012 "%1$s\ndue to the error: %2$s"), file, error);
3013 Alert::error(_("Could not read file"), text);
3017 if (!fname.isReadableFile()) {
3018 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3019 docstring const text =
3020 bformat(_("%1$s\n is not readable."), file);
3021 Alert::error(_("Could not open file"), text);
3025 // FIXME UNICODE: We don't know the encoding of the file
3026 docstring file_content = fname.fileContents("UTF-8");
3027 if (file_content.empty()) {
3028 Alert::error(_("Reading not UTF-8 encoded file"),
3029 _("The file is not UTF-8 encoded.\n"
3030 "It will be read as local 8Bit-encoded.\n"
3031 "If this does not give the correct result\n"
3032 "then please change the encoding of the file\n"
3033 "to UTF-8 with a program other than LyX.\n"));
3034 file_content = fname.fileContents("local8bit");
3037 return normalize_c(file_content);
3041 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
3043 docstring const tmpstr = contentsOfPlaintextFile(f);
3048 Cursor & cur = cursor();
3049 cap::replaceSelection(cur);
3050 buffer_.undo().recordUndo(cur);
3052 cur.innerText()->insertStringAsParagraphs(cur, tmpstr, cur.current_font);
3054 cur.innerText()->insertStringAsLines(cur, tmpstr, cur.current_font);
3056 buffer_.changed(true);
3060 docstring const & BufferView::inlineCompletion() const
3062 return d->inlineCompletion_;
3066 size_t const & BufferView::inlineCompletionUniqueChars() const
3068 return d->inlineCompletionUniqueChars_;
3072 DocIterator const & BufferView::inlineCompletionPos() const
3074 return d->inlineCompletionPos_;
3078 void BufferView::resetInlineCompletionPos()
3080 d->inlineCompletionPos_ = DocIterator();
3084 bool samePar(DocIterator const & a, DocIterator const & b)
3086 if (a.empty() && b.empty())
3088 if (a.empty() || b.empty())
3090 if (a.depth() != b.depth())
3092 return &a.innerParagraph() == &b.innerParagraph();
3096 void BufferView::setInlineCompletion(Cursor const & cur, DocIterator const & pos,
3097 docstring const & completion, size_t uniqueChars)
3099 uniqueChars = min(completion.size(), uniqueChars);
3100 bool changed = d->inlineCompletion_ != completion
3101 || d->inlineCompletionUniqueChars_ != uniqueChars;
3102 bool singlePar = true;
3103 d->inlineCompletion_ = completion;
3104 d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
3106 //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
3109 DocIterator const & old = d->inlineCompletionPos_;
3111 //lyxerr << "inlineCompletionPos changed" << std::endl;
3112 // old or pos are in another paragraph?
3113 if ((!samePar(cur, pos) && !pos.empty())
3114 || (!samePar(cur, old) && !old.empty())) {
3116 //lyxerr << "different paragraph" << std::endl;
3118 d->inlineCompletionPos_ = pos;
3123 if (singlePar && !(cur.result().screenUpdate() & Update::Force))
3124 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
3126 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::Force);
3131 bool BufferView::clickableInset() const
3133 return d->clickable_inset_;