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/InsetCommand.h" // ChangeRefs
58 #include "insets/InsetExternal.h"
59 #include "insets/InsetGraphics.h"
60 #include "insets/InsetNote.h"
61 #include "insets/InsetRef.h"
62 #include "insets/InsetText.h"
64 #include "frontends/alert.h"
65 #include "frontends/Application.h"
66 #include "frontends/Delegates.h"
67 #include "frontends/FontMetrics.h"
68 #include "frontends/Painter.h"
69 #include "frontends/Selection.h"
71 #include "support/convert.h"
72 #include "support/debug.h"
73 #include "support/ExceptionMessage.h"
74 #include "support/filetools.h"
75 #include "support/gettext.h"
76 #include "support/lassert.h"
77 #include "support/lstrings.h"
78 #include "support/Package.h"
79 #include "support/types.h"
89 using namespace lyx::support;
93 namespace Alert = frontend::Alert;
97 /// Return an inset of this class if it exists at the current cursor position
99 T * getInsetByCode(Cursor const & cur, InsetCode code)
101 DocIterator it = cur;
102 Inset * inset = it.nextInset();
103 if (inset && inset->lyxCode() == code)
104 return static_cast<T*>(inset);
108 /// Note that comparing contents can only be used for InsetCommand
109 bool findNextInset(DocIterator & dit, vector<InsetCode> const & codes,
110 docstring const & contents)
112 DocIterator tmpdit = dit;
115 Inset const * inset = tmpdit.nextInset();
117 bool const valid_code = std::find(codes.begin(), codes.end(),
118 inset->lyxCode()) != codes.end();
119 InsetCommand const * ic = inset->asInsetCommand();
120 bool const same_or_no_contents = contents.empty()
121 || (ic && (ic->getFirstNonOptParam() == contents));
123 if (valid_code && same_or_no_contents) {
128 tmpdit.forwardInset();
135 /// Looks for next inset with one of the given codes.
136 /// Note that same_content can only be used for InsetCommand
137 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
141 DocIterator tmpdit = dit;
142 tmpdit.forwardInset();
146 Inset const * inset = tmpdit.nextInset();
147 if (same_content && inset) {
148 InsetCommand const * ic = inset->asInsetCommand();
150 bool const valid_code = std::find(codes.begin(), codes.end(),
151 ic->lyxCode()) != codes.end();
153 contents = ic->getFirstNonOptParam();
157 if (!findNextInset(tmpdit, codes, contents)) {
158 if (dit.depth() != 1 || dit.pit() != 0 || dit.pos() != 0) {
159 Inset * inset = &tmpdit.bottom().inset();
160 tmpdit = doc_iterator_begin(&inset->buffer(), inset);
161 if (!findNextInset(tmpdit, codes, contents))
173 /// Looks for next inset with the given code
174 void findInset(DocIterator & dit, InsetCode code, bool same_content)
176 findInset(dit, vector<InsetCode>(1, code), same_content);
180 /// Moves cursor to the next inset with one of the given codes.
181 void gotoInset(BufferView * bv, vector<InsetCode> const & codes,
184 Cursor tmpcur = bv->cursor();
185 if (!findInset(tmpcur, codes, same_content)) {
186 bv->cursor().message(_("No more insets"));
190 tmpcur.clearSelection();
191 bv->setCursor(tmpcur);
196 /// Moves cursor to the next inset with given code.
197 void gotoInset(BufferView * bv, InsetCode code, bool same_content)
199 gotoInset(bv, vector<InsetCode>(1, code), same_content);
203 /// A map from a Text to the associated text metrics
204 typedef map<Text const *, TextMetrics> TextMetricsCache;
206 enum ScreenUpdateStrategy {
216 /////////////////////////////////////////////////////////////////////
220 /////////////////////////////////////////////////////////////////////
222 struct BufferView::Private
224 Private(BufferView & bv): wh_(0), cursor_(bv),
225 anchor_pit_(0), anchor_ypos_(0),
226 inlineCompletionUniqueChars_(0),
227 last_inset_(0), clickable_inset_(false),
228 mouse_position_cache_(),
229 bookmark_edit_position_(-1), gui_(0)
233 ScrollbarParameters scrollbarParameters_;
235 ScreenUpdateStrategy update_strategy_;
237 CoordCache coord_cache_;
239 /// Estimated average par height for scrollbar.
241 /// this is used to handle XSelection events in the right manner.
250 pit_type anchor_pit_;
254 vector<int> par_height_;
257 DocIterator inlineCompletionPos_;
259 docstring inlineCompletion_;
261 size_t inlineCompletionUniqueChars_;
263 /// keyboard mapping object.
266 /// last visited inset.
267 /** kept to send setMouseHover(false).
268 * Not owned, so don't delete.
270 Inset const * last_inset_;
271 /// are we hovering something that we can click
272 bool clickable_inset_;
274 /// position of the mouse at the time of the last mouse move
275 /// This is used to update the hovering status of inset in
276 /// cases where the buffer is scrolled, but the mouse didn't move.
277 Point mouse_position_cache_;
279 // cache for id of the paragraph which was edited the last time
280 int bookmark_edit_position_;
282 mutable TextMetricsCache text_metrics_;
285 /** Not owned, so don't delete.
287 frontend::GuiBufferViewDelegate * gui_;
289 /// Cache for Find Next
290 FuncRequest search_request_cache_;
293 map<string, Inset *> edited_insets_;
297 BufferView::BufferView(Buffer & buf)
298 : width_(0), height_(0), full_screen_(false), buffer_(buf),
299 d(new Private(*this))
301 d->xsel_cache_.set = false;
302 d->intl_.initKeyMapper(lyxrc.use_kbmap);
304 d->cursor_.setBuffer(&buf);
305 d->cursor_.push(buffer_.inset());
306 d->cursor_.resetAnchor();
307 d->cursor_.setCurrentFont();
309 buffer_.updatePreviews();
313 BufferView::~BufferView()
315 // current buffer is going to be switched-off, save cursor pos
316 // Ideally, the whole cursor stack should be saved, but session
317 // currently can only handle bottom (whole document) level pit and pos.
318 // That is to say, if a cursor is in a nested inset, it will be
319 // restore to the left of the top level inset.
320 LastFilePosSection::FilePos fp;
321 fp.pit = d->cursor_.bottom().pit();
322 fp.pos = d->cursor_.bottom().pos();
323 theSession().lastFilePos().save(buffer_.fileName(), fp);
326 d->last_inset_->setMouseHover(this, false);
332 int BufferView::rightMargin() const
334 // The additional test for the case the outliner is opened.
336 !lyxrc.full_screen_limit ||
337 width_ < lyxrc.full_screen_width + 20)
340 return (width_ - lyxrc.full_screen_width) / 2;
344 int BufferView::leftMargin() const
346 return rightMargin();
350 bool BufferView::isTopScreen() const
352 return d->scrollbarParameters_.position == d->scrollbarParameters_.min;
356 bool BufferView::isBottomScreen() const
358 return d->scrollbarParameters_.position == d->scrollbarParameters_.max;
362 Intl & BufferView::getIntl()
368 Intl const & BufferView::getIntl() const
374 CoordCache & BufferView::coordCache()
376 return d->coord_cache_;
380 CoordCache const & BufferView::coordCache() const
382 return d->coord_cache_;
386 Buffer & BufferView::buffer()
392 Buffer const & BufferView::buffer() const
398 bool BufferView::fitCursor()
400 if (cursorStatus(d->cursor_) == CUR_INSIDE) {
401 frontend::FontMetrics const & fm =
402 theFontMetrics(d->cursor_.getFont().fontInfo());
403 int const asc = fm.maxAscent();
404 int const des = fm.maxDescent();
405 Point const p = getPos(d->cursor_);
406 if (p.y_ - asc >= 0 && p.y_ + des < height_)
413 void BufferView::processUpdateFlags(Update::flags flags)
415 // This is close to a hot-path.
416 LYXERR(Debug::DEBUG, "BufferView::processUpdateFlags()"
417 << "[fitcursor = " << (flags & Update::FitCursor)
418 << ", forceupdate = " << (flags & Update::Force)
419 << ", singlepar = " << (flags & Update::SinglePar)
420 << "] buffer: " << &buffer_);
422 // FIXME Does this really need doing here? It's done in updateBuffer, and
423 // if the Buffer doesn't need updating, then do the macros?
424 buffer_.updateMacros();
426 // Now do the first drawing step if needed. This consists on updating
427 // the CoordCache in updateMetrics().
428 // The second drawing step is done in WorkArea::redraw() if needed.
430 // Case when no explicit update is requested.
432 // no need to redraw anything.
433 d->update_strategy_ = NoScreenUpdate;
437 if (flags == Update::Decoration) {
438 d->update_strategy_ = DecorationUpdate;
439 buffer_.changed(false);
443 if (flags == Update::FitCursor
444 || flags == (Update::Decoration | Update::FitCursor)) {
445 // tell the frontend to update the screen if needed.
450 if (flags & Update::Decoration) {
451 d->update_strategy_ = DecorationUpdate;
452 buffer_.changed(false);
455 // no screen update is needed.
456 d->update_strategy_ = NoScreenUpdate;
460 bool const full_metrics = flags & Update::Force || !singleParUpdate();
463 // We have to update the full screen metrics.
466 if (!(flags & Update::FitCursor)) {
467 // Nothing to do anymore. Trigger a redraw and return
468 buffer_.changed(false);
472 // updateMetrics() does not update paragraph position
473 // This is done at draw() time. So we need a redraw!
474 buffer_.changed(false);
477 // The cursor is off screen so ensure it is visible.
482 updateHoveredInset();
486 void BufferView::updateScrollbar()
488 if (height_ == 0 && width_ == 0)
491 // We prefer fixed size line scrolling.
492 d->scrollbarParameters_.single_step = defaultRowHeight();
493 // We prefer full screen page scrolling.
494 d->scrollbarParameters_.page_step = height_;
496 Text & t = buffer_.text();
497 TextMetrics & tm = d->text_metrics_[&t];
499 LYXERR(Debug::GUI, " Updating scrollbar: height: "
500 << t.paragraphs().size()
501 << " curr par: " << d->cursor_.bottom().pit()
502 << " default height " << defaultRowHeight());
504 size_t const parsize = t.paragraphs().size();
505 if (d->par_height_.size() != parsize) {
506 d->par_height_.clear();
507 // FIXME: We assume a default paragraph height of 2 rows. This
508 // should probably be pondered with the screen width.
509 d->par_height_.resize(parsize, defaultRowHeight() * 2);
512 // Look at paragraph heights on-screen
513 pair<pit_type, ParagraphMetrics const *> first = tm.first();
514 pair<pit_type, ParagraphMetrics const *> last = tm.last();
515 for (pit_type pit = first.first; pit <= last.first; ++pit) {
516 d->par_height_[pit] = tm.parMetrics(pit).height();
517 LYXERR(Debug::SCROLLING, "storing height for pit " << pit << " : "
518 << d->par_height_[pit]);
521 int top_pos = first.second->position() - first.second->ascent();
522 int bottom_pos = last.second->position() + last.second->descent();
523 bool first_visible = first.first == 0 && top_pos >= 0;
524 bool last_visible = last.first + 1 == int(parsize) && bottom_pos <= height_;
525 if (first_visible && last_visible) {
526 d->scrollbarParameters_.min = 0;
527 d->scrollbarParameters_.max = 0;
531 d->scrollbarParameters_.min = top_pos;
532 for (size_t i = 0; i != size_t(first.first); ++i)
533 d->scrollbarParameters_.min -= d->par_height_[i];
534 d->scrollbarParameters_.max = bottom_pos;
535 for (size_t i = last.first + 1; i != parsize; ++i)
536 d->scrollbarParameters_.max += d->par_height_[i];
538 d->scrollbarParameters_.position = 0;
539 // The reference is the top position so we remove one page.
540 if (lyxrc.scroll_below_document)
541 d->scrollbarParameters_.max -= minVisiblePart();
543 d->scrollbarParameters_.max -= d->scrollbarParameters_.page_step;
547 ScrollbarParameters const & BufferView::scrollbarParameters() const
549 return d->scrollbarParameters_;
553 docstring BufferView::toolTip(int x, int y) const
555 // Get inset under mouse, if there is one.
556 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
558 // No inset, no tooltip...
560 return covering_inset->toolTip(*this, x, y);
564 string BufferView::contextMenu(int x, int y) const
566 //If there is a selection, return the containing inset menu
567 if (d->cursor_.selection())
568 return d->cursor_.inset().contextMenu(*this, x, y);
570 // Get inset under mouse, if there is one.
571 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
573 return covering_inset->contextMenu(*this, x, y);
575 return buffer_.inset().contextMenu(*this, x, y);
579 void BufferView::scrollDocView(int value, bool update)
581 int const offset = value - d->scrollbarParameters_.position;
583 // No scrolling at all? No need to redraw anything
587 // If the offset is less than 2 screen height, prefer to scroll instead.
588 if (abs(offset) <= 2 * height_) {
589 d->anchor_ypos_ -= offset;
590 buffer_.changed(true);
591 updateHoveredInset();
595 // cut off at the top
596 if (value <= d->scrollbarParameters_.min) {
597 DocIterator dit = doc_iterator_begin(&buffer_);
598 showCursor(dit, false, update);
599 LYXERR(Debug::SCROLLING, "scroll to top");
603 // cut off at the bottom
604 if (value >= d->scrollbarParameters_.max) {
605 DocIterator dit = doc_iterator_end(&buffer_);
607 showCursor(dit, false, update);
608 LYXERR(Debug::SCROLLING, "scroll to bottom");
612 // find paragraph at target position
613 int par_pos = d->scrollbarParameters_.min;
615 for (; i != int(d->par_height_.size()); ++i) {
616 par_pos += d->par_height_[i];
617 if (par_pos >= value)
621 if (par_pos < value) {
622 // It seems we didn't find the correct pit so stay on the safe side and
624 LYXERR0("scrolling position not found!");
625 scrollDocView(d->scrollbarParameters_.max, update);
629 DocIterator dit = doc_iterator_begin(&buffer_);
631 LYXERR(Debug::SCROLLING, "value = " << value << " -> scroll to pit " << i);
632 showCursor(dit, false, update);
636 // FIXME: this method is not working well.
637 void BufferView::setCursorFromScrollbar()
639 TextMetrics & tm = d->text_metrics_[&buffer_.text()];
641 int const height = 2 * defaultRowHeight();
642 int const first = height;
643 int const last = height_ - height;
645 Cursor const & oldcur = d->cursor_;
647 switch (cursorStatus(oldcur)) {
655 int const y = getPos(oldcur).y_;
656 newy = min(last, max(y, first));
660 // We reset the cursor because cursorStatus() does not
661 // work when the cursor is within mathed.
664 tm.setCursorFromCoordinates(cur, 0, newy);
666 // update the bufferview cursor and notify insets
667 // FIXME: Care about the d->cursor_ flags to redraw if needed
668 Cursor old = d->cursor_;
670 // the DEPM call in mouseSetCursor() might have destroyed the
671 // paragraph the cursor is in.
672 bool badcursor = old.fixIfBroken();
673 badcursor |= notifyCursorLeavesOrEnters(old, d->cursor_);
675 d->cursor_.fixIfBroken();
679 Change const BufferView::getCurrentChange() const
681 if (!d->cursor_.selection())
682 return Change(Change::UNCHANGED);
684 DocIterator dit = d->cursor_.selectionBegin();
685 return dit.paragraph().lookupChange(dit.pos());
689 // this could be used elsewhere as well?
690 // FIXME: This does not work within mathed!
691 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
693 Point const p = getPos(dit);
696 if (p.y_ > workHeight())
702 void BufferView::bookmarkEditPosition()
704 // Don't eat cpu time for each keystroke
705 if (d->cursor_.paragraph().id() == d->bookmark_edit_position_)
708 d->bookmark_edit_position_ = d->cursor_.paragraph().id();
712 void BufferView::saveBookmark(unsigned int idx)
714 // tentatively save bookmark, id and pos will be used to
715 // acturately locate a bookmark in a 'live' lyx session.
716 // pit and pos will be updated with bottom level pit/pos
718 if (!buffer_.isInternal()) {
719 theSession().bookmarks().save(
721 d->cursor_.bottom().pit(),
722 d->cursor_.bottom().pos(),
723 d->cursor_.paragraph().id(),
728 // emit message signal.
729 message(_("Save bookmark"));
734 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
735 int top_id, pos_type top_pos)
737 bool success = false;
740 d->cursor_.clearSelection();
742 // if a valid par_id is given, try it first
743 // This is the case for a 'live' bookmark when unique paragraph ID
744 // is used to track bookmarks.
746 dit = buffer_.getParFromID(top_id);
748 dit.pos() = min(dit.paragraph().size(), top_pos);
749 // Some slices of the iterator may not be
750 // reachable (e.g. closed collapsable inset)
751 // so the dociterator may need to be
752 // shortened. Otherwise, setCursor may crash
753 // lyx when the cursor can not be set to these
755 size_t const n = dit.depth();
756 for (size_t i = 0; i < n; ++i)
757 if (!dit[i].inset().editable()) {
765 // if top_id == 0, or searching through top_id failed
766 // This is the case for a 'restored' bookmark when only bottom
767 // (document level) pit was saved. Because of this, bookmark
768 // restoration is inaccurate. If a bookmark was within an inset,
769 // it will be restored to the left of the outmost inset that contains
771 if (bottom_pit < int(buffer_.paragraphs().size())) {
772 dit = doc_iterator_begin(&buffer_);
774 dit.pit() = bottom_pit;
775 dit.pos() = min(bottom_pos, dit.paragraph().size());
780 // Note: only bottom (document) level pit is set.
782 // set the current font.
783 d->cursor_.setCurrentFont();
784 // To center the screen on this new position we need the
785 // paragraph position which is computed at draw() time.
786 // So we need a redraw!
787 buffer_.changed(false);
796 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
798 if (lyxrc.rtl_support) {
799 if (d->cursor_.real_current_font.isRightToLeft()) {
800 if (d->intl_.keymap == Intl::PRIMARY)
801 d->intl_.keyMapSec();
803 if (d->intl_.keymap == Intl::SECONDARY)
804 d->intl_.keyMapPrim();
808 d->intl_.getTransManager().translateAndInsert(c, t, cur);
812 int BufferView::workWidth() const
818 void BufferView::recenter()
820 showCursor(d->cursor_, true, true);
824 void BufferView::showCursor()
826 showCursor(d->cursor_, false, true);
830 void BufferView::showCursor(DocIterator const & dit,
831 bool recenter, bool update)
833 if (scrollToCursor(dit, recenter) && update) {
834 buffer_.changed(true);
835 updateHoveredInset();
840 void BufferView::scrollToCursor()
842 if (scrollToCursor(d->cursor_, false)) {
843 buffer_.changed(true);
844 updateHoveredInset();
849 bool BufferView::scrollToCursor(DocIterator const & dit, bool recenter)
851 // We are not properly started yet, delay until resizing is
856 LYXERR(Debug::SCROLLING, "recentering!");
858 CursorSlice const & bot = dit.bottom();
859 TextMetrics & tm = d->text_metrics_[bot.text()];
861 pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
862 int bot_pit = bot.pit();
863 if (bot_pit > max_pit) {
864 // FIXME: Why does this happen?
865 LYXERR0("bottom pit is greater that max pit: "
866 << bot_pit << " > " << max_pit);
870 if (bot_pit == tm.first().first - 1)
871 tm.newParMetricsUp();
872 else if (bot_pit == tm.last().first + 1)
873 tm.newParMetricsDown();
875 if (tm.contains(bot_pit)) {
876 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
877 LASSERT(!pm.rows().empty(), /**/);
878 // FIXME: smooth scrolling doesn't work in mathed.
879 CursorSlice const & cs = dit.innerTextSlice();
880 int offset = coordOffset(dit).y_;
881 int ypos = pm.position() + offset;
882 Dimension const & row_dim =
883 pm.getRow(cs.pos(), dit.boundary()).dimension();
886 scrolled = scroll(ypos - height_/2);
888 // We try to visualize the whole row, if the row height is larger than
889 // the screen height, we scroll to a heuristic value of height_ / 4.
890 // FIXME: This heuristic value should be replaced by a recursive search
891 // for a row in the inset that can be visualized completely.
892 else if (row_dim.height() > height_) {
893 if (ypos < defaultRowHeight())
894 scrolled = scroll(ypos - height_ / 4);
895 else if (ypos > height_ - defaultRowHeight())
896 scrolled = scroll(ypos - 3 * height_ / 4);
899 // If the top part of the row falls of the screen, we scroll
900 // up to align the top of the row with the top of the screen.
901 else if (ypos - row_dim.ascent() < 0 && ypos < height_) {
902 int ynew = row_dim.ascent();
903 scrolled = scrollUp(ynew - ypos);
906 // If the bottom of the row falls of the screen, we scroll down.
907 else if (ypos + row_dim.descent() > height_ && ypos > 0) {
908 int ynew = height_ - row_dim.descent();
909 scrolled = scrollDown(ypos - ynew);
912 // else, nothing to do, the cursor is already visible so we just return.
913 return scrolled != 0;
916 // fix inline completion position
917 if (d->inlineCompletionPos_.fixIfBroken())
918 d->inlineCompletionPos_ = DocIterator();
920 tm.redoParagraph(bot_pit);
921 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
922 int offset = coordOffset(dit).y_;
924 d->anchor_pit_ = bot_pit;
925 CursorSlice const & cs = dit.innerTextSlice();
926 Dimension const & row_dim =
927 pm.getRow(cs.pos(), dit.boundary()).dimension();
930 d->anchor_ypos_ = height_/2;
931 else if (d->anchor_pit_ == 0)
932 d->anchor_ypos_ = offset + pm.ascent();
933 else if (d->anchor_pit_ == max_pit)
934 d->anchor_ypos_ = height_ - offset - row_dim.descent();
935 else if (offset > height_)
936 d->anchor_ypos_ = height_ - offset - defaultRowHeight();
938 d->anchor_ypos_ = defaultRowHeight() * 2;
944 void BufferView::updateDocumentClass(DocumentClass const * const olddc)
946 message(_("Converting document to new document class..."));
948 StableDocIterator backcur(d->cursor_);
949 ErrorList & el = buffer_.errorList("Class Switch");
950 cap::switchBetweenClasses(
951 olddc, buffer_.params().documentClassPtr(),
952 static_cast<InsetText &>(buffer_.inset()), el);
954 setCursor(backcur.asDocIterator(&buffer_));
956 buffer_.errors("Class Switch");
959 /** Return the change status at cursor position, taking in account the
960 * status at each level of the document iterator (a table in a deleted
961 * footnote is deleted).
962 * When \param outer is true, the top slice is not looked at.
964 static Change::Type lookupChangeType(DocIterator const & dit, bool outer = false)
966 size_t const depth = dit.depth() - (outer ? 1 : 0);
968 for (size_t i = 0 ; i < depth ; ++i) {
969 CursorSlice const & slice = dit[i];
970 if (!slice.inset().inMathed()
971 && slice.pos() < slice.paragraph().size()) {
972 Change::Type const ch = slice.paragraph().lookupChange(slice.pos()).type;
973 if (ch != Change::UNCHANGED)
977 return Change::UNCHANGED;
981 bool BufferView::getStatus(FuncRequest const & cmd, FuncStatus & flag)
983 FuncCode const act = cmd.action();
985 // Can we use a readonly buffer?
986 if (buffer_.isReadonly()
987 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
988 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
989 flag.message(from_utf8(N_("Document is read-only")));
990 flag.setEnabled(false);
994 // Are we in a DELETED change-tracking region?
995 if (lookupChangeType(d->cursor_, true) == Change::DELETED
996 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
997 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
998 flag.message(from_utf8(N_("This portion of the document is deleted.")));
999 flag.setEnabled(false);
1003 Cursor & cur = d->cursor_;
1005 if (cur.getStatus(cmd, flag))
1010 // FIXME: This is a bit problematic because we don't check if this is
1011 // a document BufferView or not for these LFUNs. We probably have to
1012 // dispatch both to currentBufferView() and, if that fails,
1013 // to documentBufferView(); same as we do now for current Buffer and
1014 // document Buffer. Ideally those LFUN should go to Buffer as they
1015 // operate on the full Buffer and the cursor is only needed either for
1016 // an Undo record or to restore a cursor position. But we don't know
1017 // how to do that inside Buffer of course.
1018 case LFUN_BUFFER_PARAMS_APPLY:
1019 case LFUN_LAYOUT_MODULES_CLEAR:
1020 case LFUN_LAYOUT_MODULE_ADD:
1021 case LFUN_LAYOUT_RELOAD:
1022 case LFUN_TEXTCLASS_APPLY:
1023 case LFUN_TEXTCLASS_LOAD:
1024 flag.setEnabled(!buffer_.isReadonly());
1028 // We do not use the LyXAction flag for readonly because Undo sets the
1029 // buffer clean/dirty status by itself.
1030 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasUndoStack());
1033 // We do not use the LyXAction flag for readonly because Redo sets the
1034 // buffer clean/dirty status by itself.
1035 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasRedoStack());
1037 case LFUN_FILE_INSERT:
1038 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
1039 case LFUN_FILE_INSERT_PLAINTEXT:
1040 case LFUN_BOOKMARK_SAVE:
1041 // FIXME: Actually, these LFUNS should be moved to Text
1042 flag.setEnabled(cur.inTexted());
1045 case LFUN_FONT_STATE:
1046 case LFUN_LABEL_INSERT:
1047 case LFUN_INFO_INSERT:
1048 case LFUN_PARAGRAPH_GOTO:
1049 case LFUN_NOTE_NEXT:
1050 case LFUN_REFERENCE_NEXT:
1051 case LFUN_WORD_FIND:
1052 case LFUN_WORD_FIND_FORWARD:
1053 case LFUN_WORD_FIND_BACKWARD:
1054 case LFUN_WORD_FINDADV:
1055 case LFUN_WORD_REPLACE:
1058 case LFUN_MARK_TOGGLE:
1059 case LFUN_SCREEN_RECENTER:
1060 case LFUN_SCREEN_SHOW_CURSOR:
1061 case LFUN_BIBTEX_DATABASE_ADD:
1062 case LFUN_BIBTEX_DATABASE_DEL:
1063 case LFUN_STATISTICS:
1064 case LFUN_BRANCH_ADD_INSERT:
1065 case LFUN_KEYMAP_OFF:
1066 case LFUN_KEYMAP_PRIMARY:
1067 case LFUN_KEYMAP_SECONDARY:
1068 case LFUN_KEYMAP_TOGGLE:
1069 flag.setEnabled(true);
1072 case LFUN_LABEL_GOTO: {
1073 flag.setEnabled(!cmd.argument().empty()
1074 || getInsetByCode<InsetRef>(cur, REF_CODE));
1078 case LFUN_CHANGES_TRACK:
1079 flag.setEnabled(true);
1080 flag.setOnOff(buffer_.params().trackChanges);
1083 case LFUN_CHANGES_OUTPUT:
1084 flag.setEnabled(true);
1085 flag.setOnOff(buffer_.params().outputChanges);
1088 case LFUN_CHANGES_MERGE:
1089 case LFUN_CHANGE_NEXT:
1090 case LFUN_CHANGE_PREVIOUS:
1091 case LFUN_ALL_CHANGES_ACCEPT:
1092 case LFUN_ALL_CHANGES_REJECT:
1093 // TODO: context-sensitive enabling of LFUNs
1094 // In principle, these command should only be enabled if there
1095 // is a change in the document. However, without proper
1096 // optimizations, this will inevitably result in poor performance.
1097 flag.setEnabled(true);
1100 case LFUN_BUFFER_TOGGLE_COMPRESSION: {
1101 flag.setOnOff(buffer_.params().compressed);
1105 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC: {
1106 flag.setOnOff(buffer_.params().output_sync);
1110 case LFUN_SCREEN_UP:
1111 case LFUN_SCREEN_DOWN:
1113 case LFUN_SCREEN_UP_SELECT:
1114 case LFUN_SCREEN_DOWN_SELECT:
1115 case LFUN_INSET_FORALL:
1116 flag.setEnabled(true);
1119 case LFUN_LAYOUT_TABULAR:
1120 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
1124 flag.setEnabled(!cur.inset().forcePlainLayout(cur.idx()));
1127 case LFUN_LAYOUT_PARAGRAPH:
1128 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
1131 case LFUN_DIALOG_SHOW_NEW_INSET:
1132 // FIXME: this is wrong, but I do not understand the
1134 if (cur.inset().lyxCode() == CAPTION_CODE)
1135 return cur.inset().getStatus(cur, cmd, flag);
1136 // FIXME we should consider passthru paragraphs too.
1137 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1140 case LFUN_CITATION_INSERT: {
1141 FuncRequest fr(LFUN_INSET_INSERT, "citation");
1142 // FIXME: This could turn in a recursive hell.
1143 // Shouldn't we use Buffer::getStatus() instead?
1144 flag.setEnabled(lyx::getStatus(fr).enabled());
1147 case LFUN_INSET_APPLY: {
1148 string const name = cmd.getArg(0);
1149 Inset * inset = editedInset(name);
1151 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1152 if (!inset->getStatus(cur, fr, flag)) {
1153 // Every inset is supposed to handle this
1154 LASSERT(false, break);
1157 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1158 flag = lyx::getStatus(fr);
1163 // FIXME We do not really want this here, but at present we need to
1164 // handle their dispatch here, for reasons explained there, so we'll
1165 // handle this here, too, for consistency.
1166 case LFUN_BRANCH_ACTIVATE:
1167 case LFUN_BRANCH_DEACTIVATE: {
1168 BranchList const & branchList = buffer().params().branchlist();
1169 docstring const branchName = cmd.argument();
1170 flag.setEnabled(!branchName.empty() && branchList.find(branchName));
1182 Inset * BufferView::editedInset(string const & name) const
1184 map<string, Inset *>::const_iterator it = d->edited_insets_.find(name);
1185 return it == d->edited_insets_.end() ? 0 : it->second;
1189 void BufferView::editInset(string const & name, Inset * inset)
1191 d->edited_insets_[name] = inset;
1195 void BufferView::dispatch(FuncRequest const & cmd, DispatchResult & dr)
1197 //lyxerr << [ cmd = " << cmd << "]" << endl;
1199 // Make sure that the cached BufferView is correct.
1200 LYXERR(Debug::ACTION, " action[" << cmd.action() << ']'
1201 << " arg[" << to_utf8(cmd.argument()) << ']'
1202 << " x[" << cmd.x() << ']'
1203 << " y[" << cmd.y() << ']'
1204 << " button[" << cmd.button() << ']');
1206 string const argument = to_utf8(cmd.argument());
1207 Cursor & cur = d->cursor_;
1209 // Don't dispatch function that does not apply to internal buffers.
1210 if (buffer_.isInternal()
1211 && lyxaction.funcHasFlag(cmd.action(), LyXAction::NoInternal))
1214 // We'll set this back to false if need be.
1215 bool dispatched = true;
1216 buffer_.undo().beginUndoGroup();
1218 FuncCode const act = cmd.action();
1221 case LFUN_BUFFER_PARAMS_APPLY: {
1222 DocumentClass const * const oldClass = buffer_.params().documentClassPtr();
1223 cur.recordUndoFullDocument();
1224 istringstream ss(to_utf8(cmd.argument()));
1227 int const unknown_tokens = buffer_.readHeader(lex);
1228 if (unknown_tokens != 0) {
1229 LYXERR0("Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1230 << unknown_tokens << " unknown token"
1231 << (unknown_tokens == 1 ? "" : "s"));
1233 updateDocumentClass(oldClass);
1235 // We are most certainly here because of a change in the document
1236 // It is then better to make sure that all dialogs are in sync with
1237 // current document settings.
1238 dr.screenUpdate(Update::Force | Update::FitCursor);
1239 dr.forceBufferUpdate();
1243 case LFUN_LAYOUT_MODULES_CLEAR: {
1244 DocumentClass const * const oldClass =
1245 buffer_.params().documentClassPtr();
1246 cur.recordUndoFullDocument();
1247 buffer_.params().clearLayoutModules();
1248 buffer_.params().makeDocumentClass();
1249 updateDocumentClass(oldClass);
1250 dr.screenUpdate(Update::Force);
1251 dr.forceBufferUpdate();
1255 case LFUN_LAYOUT_MODULE_ADD: {
1256 BufferParams const & params = buffer_.params();
1257 if (!params.moduleCanBeAdded(argument)) {
1258 LYXERR0("Module `" << argument <<
1259 "' cannot be added due to failed requirements or "
1260 "conflicts with installed modules.");
1263 DocumentClass const * const oldClass = params.documentClassPtr();
1264 cur.recordUndoFullDocument();
1265 buffer_.params().addLayoutModule(argument);
1266 buffer_.params().makeDocumentClass();
1267 updateDocumentClass(oldClass);
1268 dr.screenUpdate(Update::Force);
1269 dr.forceBufferUpdate();
1273 case LFUN_TEXTCLASS_APPLY: {
1274 // since this shortcircuits, the second call is made only if
1276 bool const success =
1277 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1278 LayoutFileList::get().load(argument, buffer_.filePath());
1280 docstring s = bformat(_("The document class `%1$s' "
1281 "could not be loaded."), from_utf8(argument));
1282 frontend::Alert::error(_("Could not load class"), s);
1286 LayoutFile const * old_layout = buffer_.params().baseClass();
1287 LayoutFile const * new_layout = &(LayoutFileList::get()[argument]);
1289 if (old_layout == new_layout)
1293 // Save the old, possibly modular, layout for use in conversion.
1294 DocumentClass const * const oldDocClass =
1295 buffer_.params().documentClassPtr();
1296 cur.recordUndoFullDocument();
1297 buffer_.params().setBaseClass(argument);
1298 buffer_.params().makeDocumentClass();
1299 updateDocumentClass(oldDocClass);
1300 dr.screenUpdate(Update::Force);
1301 dr.forceBufferUpdate();
1305 case LFUN_TEXTCLASS_LOAD: {
1306 // since this shortcircuits, the second call is made only if
1308 bool const success =
1309 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1310 LayoutFileList::get().load(argument, buffer_.filePath());
1312 docstring s = bformat(_("The document class `%1$s' "
1313 "could not be loaded."), from_utf8(argument));
1314 frontend::Alert::error(_("Could not load class"), s);
1319 case LFUN_LAYOUT_RELOAD: {
1320 DocumentClass const * const oldClass = buffer_.params().documentClassPtr();
1321 LayoutFileIndex bc = buffer_.params().baseClassID();
1322 LayoutFileList::get().reset(bc);
1323 buffer_.params().setBaseClass(bc);
1324 buffer_.params().makeDocumentClass();
1325 updateDocumentClass(oldClass);
1326 dr.screenUpdate(Update::Force);
1327 dr.forceBufferUpdate();
1332 dr.setMessage(_("Undo"));
1333 cur.clearSelection();
1334 if (!cur.textUndo())
1335 dr.setMessage(_("No further undo information"));
1337 dr.screenUpdate(Update::Force | Update::FitCursor);
1338 dr.forceBufferUpdate();
1342 dr.setMessage(_("Redo"));
1343 cur.clearSelection();
1344 if (!cur.textRedo())
1345 dr.setMessage(_("No further redo information"));
1347 dr.screenUpdate(Update::Force | Update::FitCursor);
1348 dr.forceBufferUpdate();
1351 case LFUN_FONT_STATE:
1352 dr.setMessage(cur.currentState());
1355 case LFUN_BOOKMARK_SAVE:
1356 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1359 case LFUN_LABEL_GOTO: {
1360 docstring label = cmd.argument();
1361 if (label.empty()) {
1363 getInsetByCode<InsetRef>(cur, REF_CODE);
1365 label = inset->getParam("reference");
1366 // persistent=false: use temp_bookmark
1370 if (!label.empty()) {
1372 // at the moment, this is redundant, since gotoLabel will
1373 // eventually call LFUN_PARAGRAPH_GOTO, but it seems best
1375 dr.screenUpdate(Update::Force | Update::FitCursor);
1380 case LFUN_PARAGRAPH_GOTO: {
1381 int const id = convert<int>(cmd.getArg(0));
1382 int const pos = convert<int>(cmd.getArg(1));
1384 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1385 b = theBufferList().next(b)) {
1387 DocIterator dit = b->getParFromID(id);
1389 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1393 LYXERR(Debug::INFO, "Paragraph " << dit.paragraph().id()
1394 << " found in buffer `"
1395 << b->absFileName() << "'.");
1397 if (b == &buffer_) {
1401 dr.screenUpdate(Update::Force | Update::FitCursor);
1403 // Switch to other buffer view and resend cmd
1404 lyx::dispatch(FuncRequest(
1405 LFUN_BUFFER_SWITCH, b->absFileName()));
1413 case LFUN_NOTE_NEXT:
1414 gotoInset(this, NOTE_CODE, false);
1417 case LFUN_REFERENCE_NEXT: {
1418 vector<InsetCode> tmp;
1419 tmp.push_back(LABEL_CODE);
1420 tmp.push_back(REF_CODE);
1421 gotoInset(this, tmp, true);
1425 case LFUN_CHANGES_TRACK:
1426 buffer_.params().trackChanges = !buffer_.params().trackChanges;
1429 case LFUN_CHANGES_OUTPUT:
1430 buffer_.params().outputChanges = !buffer_.params().outputChanges;
1431 if (buffer_.params().outputChanges) {
1432 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1433 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1434 LaTeXFeatures::isAvailable("xcolor");
1436 if (!dvipost && !xcolorulem) {
1437 Alert::warning(_("Changes not shown in LaTeX output"),
1438 _("Changes will not be highlighted in LaTeX output, "
1439 "because neither dvipost nor xcolor/ulem are installed.\n"
1440 "Please install these packages or redefine "
1441 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1442 } else if (!xcolorulem) {
1443 Alert::warning(_("Changes not shown in LaTeX output"),
1444 _("Changes will not be highlighted in LaTeX output "
1445 "when using pdflatex, because xcolor and ulem are not installed.\n"
1446 "Please install both packages or redefine "
1447 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1452 case LFUN_CHANGE_NEXT:
1453 findNextChange(this);
1454 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1455 dr.screenUpdate(Update::Force | Update::FitCursor);
1458 case LFUN_CHANGE_PREVIOUS:
1459 findPreviousChange(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_CHANGES_MERGE:
1465 if (findNextChange(this) || findPreviousChange(this)) {
1466 dr.screenUpdate(Update::Force | Update::FitCursor);
1467 dr.forceBufferUpdate();
1468 showDialog("changes");
1472 case LFUN_ALL_CHANGES_ACCEPT:
1473 // select complete document
1475 cur.selHandle(true);
1476 buffer_.text().cursorBottom(cur);
1477 // accept everything in a single step to support atomic undo
1478 buffer_.text().acceptOrRejectChanges(cur, Text::ACCEPT);
1480 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1481 dr.screenUpdate(Update::Force | Update::FitCursor);
1482 dr.forceBufferUpdate();
1485 case LFUN_ALL_CHANGES_REJECT:
1486 // select complete document
1488 cur.selHandle(true);
1489 buffer_.text().cursorBottom(cur);
1490 // reject everything in a single step to support atomic undo
1491 // Note: reject does not work recursively; the user may have to repeat the operation
1492 buffer_.text().acceptOrRejectChanges(cur, Text::REJECT);
1494 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1495 dr.screenUpdate(Update::Force | Update::FitCursor);
1496 dr.forceBufferUpdate();
1499 case LFUN_WORD_FIND_FORWARD:
1500 case LFUN_WORD_FIND_BACKWARD: {
1501 static docstring last_search;
1502 docstring searched_string;
1504 if (!cmd.argument().empty()) {
1505 last_search = cmd.argument();
1506 searched_string = cmd.argument();
1508 searched_string = last_search;
1511 if (searched_string.empty())
1514 bool const fw = act == LFUN_WORD_FIND_FORWARD;
1515 docstring const data =
1516 find2string(searched_string, true, false, fw);
1517 bool found = lyxfind(this, FuncRequest(LFUN_WORD_FIND, data));
1519 dr.screenUpdate(Update::Force | Update::FitCursor);
1523 case LFUN_WORD_FIND: {
1524 FuncRequest req = cmd;
1525 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1526 req = d->search_request_cache_;
1527 if (req.argument().empty()) {
1528 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, "findreplace"));
1531 if (lyxfind(this, req))
1532 dr.screenUpdate(Update::Force | Update::FitCursor);
1534 message(_("String not found!"));
1535 d->search_request_cache_ = req;
1539 case LFUN_WORD_REPLACE: {
1540 bool has_deleted = false;
1541 if (cur.selection()) {
1542 DocIterator beg = cur.selectionBegin();
1543 DocIterator end = cur.selectionEnd();
1544 if (beg.pit() == end.pit()) {
1545 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1546 if (!cur.inMathed() && cur.paragraph().isDeleted(p)) {
1553 if (lyxreplace(this, cmd, has_deleted)) {
1554 dr.forceBufferUpdate();
1555 dr.screenUpdate(Update::Force | Update::FitCursor);
1560 case LFUN_WORD_FINDADV: {
1561 FindAndReplaceOptions opt;
1562 istringstream iss(to_utf8(cmd.argument()));
1564 if (findAdv(this, opt)) {
1565 dr.screenUpdate(Update::Force | Update::FitCursor);
1576 cur.clearSelection();
1577 dr.setMessage(from_utf8(N_("Mark off")));
1581 cur.clearSelection();
1583 dr.setMessage(from_utf8(N_("Mark on")));
1586 case LFUN_MARK_TOGGLE:
1587 cur.setSelection(false);
1590 dr.setMessage(from_utf8(N_("Mark removed")));
1593 dr.setMessage(from_utf8(N_("Mark set")));
1598 case LFUN_SCREEN_SHOW_CURSOR:
1602 case LFUN_SCREEN_RECENTER:
1606 case LFUN_BIBTEX_DATABASE_ADD: {
1607 Cursor tmpcur = cur;
1608 findInset(tmpcur, BIBTEX_CODE, false);
1609 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1612 if (inset->addDatabase(cmd.argument())) {
1613 buffer_.invalidateBibfileCache();
1614 dr.forceBufferUpdate();
1620 case LFUN_BIBTEX_DATABASE_DEL: {
1621 Cursor tmpcur = cur;
1622 findInset(tmpcur, BIBTEX_CODE, false);
1623 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1626 if (inset->delDatabase(cmd.argument())) {
1627 buffer_.invalidateBibfileCache();
1628 dr.forceBufferUpdate();
1634 case LFUN_STATISTICS: {
1635 DocIterator from, to;
1636 if (cur.selection()) {
1637 from = cur.selectionBegin();
1638 to = cur.selectionEnd();
1640 from = doc_iterator_begin(&buffer_);
1641 to = doc_iterator_end(&buffer_);
1643 int const words = countWords(from, to);
1644 int const chars = countChars(from, to, false);
1645 int const chars_blanks = countChars(from, to, true);
1647 if (cur.selection())
1648 message = _("Statistics for the selection:");
1650 message = _("Statistics for the document:");
1653 message += bformat(_("%1$d words"), words);
1655 message += _("One word");
1657 if (chars_blanks != 1)
1658 message += bformat(_("%1$d characters (including blanks)"),
1661 message += _("One character (including blanks)");
1664 message += bformat(_("%1$d characters (excluding blanks)"),
1667 message += _("One character (excluding blanks)");
1669 Alert::information(_("Statistics"), message);
1673 case LFUN_BUFFER_TOGGLE_COMPRESSION:
1674 // turn compression on/off
1675 buffer_.params().compressed = !buffer_.params().compressed;
1678 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
1679 buffer_.params().output_sync = !buffer_.params().output_sync;
1682 case LFUN_SCREEN_UP:
1683 case LFUN_SCREEN_DOWN: {
1684 Point p = getPos(cur);
1685 // This code has been commented out to enable to scroll down a
1686 // document, even if there are large insets in it (see bug #5465).
1687 /*if (p.y_ < 0 || p.y_ > height_) {
1688 // The cursor is off-screen so recenter before proceeding.
1692 int const scrolled = scroll(act == LFUN_SCREEN_UP
1693 ? -height_ : height_);
1694 if (act == LFUN_SCREEN_UP && scrolled > -height_)
1696 if (act == LFUN_SCREEN_DOWN && scrolled < height_)
1697 p = Point(width_, height_);
1699 bool const in_texted = cur.inTexted();
1701 buffer_.changed(true);
1702 updateHoveredInset();
1704 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_,
1705 true, act == LFUN_SCREEN_UP);
1707 //FIXME: what to do with cur.x_target()?
1708 bool update = in_texted && cur.bv().checkDepm(cur, old);
1711 dr.screenUpdate(Update::Force | Update::FitCursor);
1712 dr.forceBufferUpdate();
1719 dr.forceBufferUpdate();
1722 case LFUN_SCREEN_UP_SELECT: {
1723 cur.selHandle(true);
1724 if (isTopScreen()) {
1725 lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1729 int y = getPos(cur).y_;
1730 int const ymin = y - height_ + defaultRowHeight();
1731 while (y > ymin && cur.up())
1735 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1739 case LFUN_SCREEN_DOWN_SELECT: {
1740 cur.selHandle(true);
1741 if (isBottomScreen()) {
1742 lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1746 int y = getPos(cur).y_;
1747 int const ymax = y + height_ - defaultRowHeight();
1748 while (y < ymax && cur.down())
1752 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1757 // This would be in Buffer class if only Cursor did not
1758 // require a bufferview
1759 case LFUN_INSET_FORALL: {
1760 docstring const name = from_utf8(cmd.getArg(0));
1761 string const commandstr = cmd.getLongArg(1);
1762 FuncRequest const fr = lyxaction.lookupFunc(commandstr);
1764 // an arbitrary number to limit number of iterations
1765 const int max_iter = 10000;
1767 Cursor & cur = d->cursor_;
1768 Cursor const savecur = cur;
1770 if (!cur.nextInset())
1772 cur.beginUndoGroup();
1773 while(cur && iterations < max_iter) {
1774 Inset * ins = cur.nextInset();
1777 docstring insname = ins->layoutName();
1778 while (!insname.empty()) {
1779 if (insname == name || name == from_utf8("*")) {
1781 lyx::dispatch(fr, dr);
1785 size_t const i = insname.rfind(':');
1786 if (i == string::npos)
1788 insname = insname.substr(0, i);
1795 dr.screenUpdate(Update::Force);
1796 dr.forceBufferUpdate();
1798 if (iterations >= max_iter) {
1800 dr.setMessage(bformat(_("`inset-forall' interrupted because number of actions is larger than %1$d"), max_iter));
1802 dr.setMessage(bformat(_("Applied \"%1$s\" to %2$d insets"), from_utf8(commandstr), iterations));
1807 case LFUN_BRANCH_ADD_INSERT: {
1808 docstring branch_name = from_utf8(cmd.getArg(0));
1809 if (branch_name.empty())
1810 if (!Alert::askForText(branch_name, _("Branch name")) ||
1811 branch_name.empty())
1814 DispatchResult drtmp;
1815 buffer_.dispatch(FuncRequest(LFUN_BRANCH_ADD, branch_name), drtmp);
1816 if (drtmp.error()) {
1817 Alert::warning(_("Branch already exists"), drtmp.message());
1820 BranchList & branch_list = buffer_.params().branchlist();
1821 vector<docstring> const branches =
1822 getVectorFromString(branch_name, branch_list.separator());
1823 for (vector<docstring>::const_iterator it = branches.begin();
1824 it != branches.end(); ++it) {
1826 lyx::dispatch(FuncRequest(LFUN_BRANCH_INSERT, branch_name));
1831 case LFUN_KEYMAP_OFF:
1832 getIntl().keyMapOn(false);
1835 case LFUN_KEYMAP_PRIMARY:
1836 getIntl().keyMapPrim();
1839 case LFUN_KEYMAP_SECONDARY:
1840 getIntl().keyMapSec();
1843 case LFUN_KEYMAP_TOGGLE:
1844 getIntl().toggleKeyMap();
1847 case LFUN_DIALOG_SHOW_NEW_INSET: {
1848 string const name = cmd.getArg(0);
1849 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
1850 if (decodeInsetParam(name, data, buffer_))
1851 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
1853 lyxerr << "Inset type '" << name <<
1854 "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" << endl;
1858 case LFUN_CITATION_INSERT: {
1859 if (argument.empty()) {
1860 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
1863 // we can have one optional argument, delimited by '|'
1864 // citation-insert <key>|<text_before>
1865 // this should be enhanced to also support text_after
1866 // and citation style
1867 string arg = argument;
1869 if (contains(argument, "|")) {
1870 arg = token(argument, '|', 0);
1871 opt1 = token(argument, '|', 1);
1873 InsetCommandParams icp(CITE_CODE);
1874 icp["key"] = from_utf8(arg);
1876 icp["before"] = from_utf8(opt1);
1877 string icstr = InsetCommand::params2string(icp);
1878 FuncRequest fr(LFUN_INSET_INSERT, icstr);
1883 case LFUN_INSET_APPLY: {
1884 string const name = cmd.getArg(0);
1885 Inset * inset = editedInset(name);
1887 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1891 // put cursor in front of inset.
1892 if (!setCursorFromInset(inset)) {
1893 LASSERT(false, break);
1896 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1897 inset->dispatch(cur, fr);
1898 dr.screenUpdate(cur.result().screenUpdate());
1899 if (cur.result().needBufferUpdate())
1900 dr.forceBufferUpdate();
1905 // The change of language of buffer belongs to the Buffer class.
1906 // We have to do it here because we need a cursor for Undo.
1907 // When Undo::recordUndoBufferParams() is implemented someday
1908 // LFUN_BUFFER_LANGUAGE should be handled by the Buffer class.
1909 case LFUN_BUFFER_LANGUAGE: {
1910 Language const * oldL = buffer_.params().language;
1911 Language const * newL = languages.getLanguage(argument);
1912 if (!newL || oldL == newL)
1914 if (oldL->rightToLeft() == newL->rightToLeft()) {
1915 cur.recordUndoFullDocument();
1916 buffer_.changeLanguage(oldL, newL);
1917 cur.setCurrentFont();
1918 dr.forceBufferUpdate();
1923 // FIXME We do not really want this here, but it has to be at present
1924 // because we need a cursor for the recordUndoFullDocument call. What
1925 // we would really like is a recordUndoBufferParams call that did not
1926 // need a cursor, but we do not have that yet.
1927 // So, if this does get fixed, this code can be moved back to Buffer.cpp,
1928 // and the corresponding code in getStatus() should be moved back, too.
1929 case LFUN_BRANCH_ACTIVATE:
1930 case LFUN_BRANCH_DEACTIVATE: {
1931 BranchList & branch_list = buffer().params().branchlist();
1932 docstring const branch_name = cmd.argument();
1933 // the case without a branch name is handled elsewhere
1934 if (branch_name.empty()) {
1938 Branch * branch = branch_list.find(branch_name);
1940 LYXERR0("Branch " << branch_name << " does not exist.");
1942 docstring const msg =
1943 bformat(_("Branch \"%1$s\" does not exist."), branch_name);
1947 bool activate = cmd.action() == LFUN_BRANCH_ACTIVATE;
1948 if (branch->isSelected() != activate) {
1949 branch->setSelected(activate);
1950 cur.recordUndoFullDocument();
1952 dr.screenUpdate(Update::Force);
1953 dr.forceBufferUpdate();
1959 // OK, so try the Buffer itself...
1960 buffer_.dispatch(cmd, dr);
1961 dispatched = dr.dispatched();
1965 buffer_.undo().endUndoGroup();
1966 dr.dispatched(dispatched);
1970 docstring const BufferView::requestSelection()
1972 Cursor & cur = d->cursor_;
1974 LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
1975 if (!cur.selection()) {
1976 d->xsel_cache_.set = false;
1980 LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
1981 if (!d->xsel_cache_.set ||
1982 cur.top() != d->xsel_cache_.cursor ||
1983 cur.realAnchor().top() != d->xsel_cache_.anchor)
1985 d->xsel_cache_.cursor = cur.top();
1986 d->xsel_cache_.anchor = cur.realAnchor().top();
1987 d->xsel_cache_.set = cur.selection();
1988 return cur.selectionAsString(false);
1994 void BufferView::clearSelection()
1996 d->cursor_.clearSelection();
1997 // Clear the selection buffer. Otherwise a subsequent
1998 // middle-mouse-button paste would use the selection buffer,
1999 // not the more current external selection.
2000 cap::clearSelection();
2001 d->xsel_cache_.set = false;
2002 // The buffer did not really change, but this causes the
2003 // redraw we need because we cleared the selection above.
2004 buffer_.changed(false);
2008 void BufferView::resize(int width, int height)
2010 // Update from work area
2014 // Clear the paragraph height cache.
2015 d->par_height_.clear();
2016 // Redo the metrics.
2021 Inset const * BufferView::getCoveringInset(Text const & text,
2024 TextMetrics & tm = d->text_metrics_[&text];
2025 Inset * inset = tm.checkInsetHit(x, y);
2029 if (!inset->descendable(*this))
2030 // No need to go further down if the inset is not
2034 size_t cell_number = inset->nargs();
2035 // Check all the inner cell.
2036 for (size_t i = 0; i != cell_number; ++i) {
2037 Text const * inner_text = inset->getText(i);
2040 Inset const * inset_deeper =
2041 getCoveringInset(*inner_text, x, y);
2043 return inset_deeper;
2051 void BufferView::updateHoveredInset() const
2053 // Get inset under mouse, if there is one.
2054 int const x = d->mouse_position_cache_.x_;
2055 int const y = d->mouse_position_cache_.y_;
2056 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
2058 d->clickable_inset_ = covering_inset && covering_inset->clickable(x, y);
2060 if (covering_inset == d->last_inset_)
2061 // Same inset, no need to do anything...
2064 bool need_redraw = false;
2065 if (d->last_inset_) {
2066 // Remove the hint on the last hovered inset (if any).
2067 need_redraw |= d->last_inset_->setMouseHover(this, false);
2071 if (covering_inset && covering_inset->setMouseHover(this, true)) {
2073 // Only the insets that accept the hover state, do
2074 // clear the last_inset_, so only set the last_inset_
2075 // member if the hovered setting is accepted.
2076 d->last_inset_ = covering_inset;
2080 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
2081 << d->mouse_position_cache_.x_ << ", "
2082 << d->mouse_position_cache_.y_ << ")");
2084 d->update_strategy_ = DecorationUpdate;
2086 // This event (moving without mouse click) is not passed further.
2087 // This should be changed if it is further utilized.
2088 buffer_.changed(false);
2093 void BufferView::clearLastInset(Inset * inset) const
2095 if (d->last_inset_ != inset) {
2096 LYXERR0("Wrong last_inset!");
2097 LASSERT(false, /**/);
2103 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
2105 //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
2107 // This is only called for mouse related events including
2108 // LFUN_FILE_OPEN generated by drag-and-drop.
2109 FuncRequest cmd = cmd0;
2111 Cursor old = cursor();
2113 cur.push(buffer_.inset());
2114 cur.setSelection(d->cursor_.selection());
2116 // Either the inset under the cursor or the
2117 // surrounding Text will handle this event.
2119 // make sure we stay within the screen...
2120 cmd.set_y(min(max(cmd.y(), -1), height_));
2122 d->mouse_position_cache_.x_ = cmd.x();
2123 d->mouse_position_cache_.y_ = cmd.y();
2125 if (cmd.action() == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
2126 updateHoveredInset();
2130 // Build temporary cursor.
2131 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x(), cmd.y());
2133 // Put anchor at the same position.
2136 cur.beginUndoGroup();
2138 // Try to dispatch to an non-editable inset near this position
2139 // via the temp cursor. If the inset wishes to change the real
2140 // cursor it has to do so explicitly by using
2141 // cur.bv().cursor() = cur; (or similar)
2143 inset->dispatch(cur, cmd);
2145 // Now dispatch to the temporary cursor. If the real cursor should
2146 // be modified, the inset's dispatch has to do so explicitly.
2147 if (!inset || !cur.result().dispatched())
2152 // Notify left insets
2155 bool badcursor = notifyCursorLeavesOrEnters(old, cur);
2157 cursor().fixIfBroken();
2160 // Do we have a selection?
2161 theSelection().haveSelection(cursor().selection());
2163 if (cur.needBufferUpdate()) {
2164 cur.clearBufferUpdate();
2165 buffer().updateBuffer();
2168 // If the command has been dispatched,
2169 if (cur.result().dispatched() || cur.result().screenUpdate())
2170 processUpdateFlags(cur.result().screenUpdate());
2174 void BufferView::lfunScroll(FuncRequest const & cmd)
2176 string const scroll_type = cmd.getArg(0);
2177 int scroll_step = 0;
2178 if (scroll_type == "line")
2179 scroll_step = d->scrollbarParameters_.single_step;
2180 else if (scroll_type == "page")
2181 scroll_step = d->scrollbarParameters_.page_step;
2184 string const scroll_quantity = cmd.getArg(1);
2185 if (scroll_quantity == "up")
2186 scrollUp(scroll_step);
2187 else if (scroll_quantity == "down")
2188 scrollDown(scroll_step);
2190 int const scroll_value = convert<int>(scroll_quantity);
2192 scroll(scroll_step * scroll_value);
2194 buffer_.changed(true);
2195 updateHoveredInset();
2199 int BufferView::minVisiblePart()
2201 return 2 * defaultRowHeight();
2205 int BufferView::scroll(int y)
2208 return scrollDown(y);
2210 return scrollUp(-y);
2215 int BufferView::scrollDown(int offset)
2217 Text * text = &buffer_.text();
2218 TextMetrics & tm = d->text_metrics_[text];
2219 int const ymax = height_ + offset;
2221 pair<pit_type, ParagraphMetrics const *> last = tm.last();
2222 int bottom_pos = last.second->position() + last.second->descent();
2223 if (lyxrc.scroll_below_document)
2224 bottom_pos += height_ - minVisiblePart();
2225 if (last.first + 1 == int(text->paragraphs().size())) {
2226 if (bottom_pos <= height_)
2228 offset = min(offset, bottom_pos - height_);
2231 if (bottom_pos > ymax)
2233 tm.newParMetricsDown();
2235 d->anchor_ypos_ -= offset;
2240 int BufferView::scrollUp(int offset)
2242 Text * text = &buffer_.text();
2243 TextMetrics & tm = d->text_metrics_[text];
2244 int ymin = - offset;
2246 pair<pit_type, ParagraphMetrics const *> first = tm.first();
2247 int top_pos = first.second->position() - first.second->ascent();
2248 if (first.first == 0) {
2251 offset = min(offset, - top_pos);
2256 tm.newParMetricsUp();
2258 d->anchor_ypos_ += offset;
2263 void BufferView::setCursorFromRow(int row)
2267 pit_type newpit = 0;
2268 pos_type newpos = 0;
2270 buffer_.texrow().getIdFromRow(row, tmpid, tmppos);
2272 bool posvalid = (tmpid != -1);
2274 // we need to make sure that the row and position
2275 // we got back are valid, because the buffer may well
2276 // have changed since we last generated the LaTeX.
2277 DocIterator const dit = buffer_.getParFromID(tmpid);
2278 if (dit == doc_iterator_end(&buffer_))
2282 // now have to check pos.
2284 Paragraph const & par = buffer_.text().getPar(newpit);
2285 if (newpos > par.size()) {
2286 LYXERR0("Requested position no longer valid.");
2287 newpos = par.size() - 1;
2292 frontend::Alert::error(_("Inverse Search Failed"),
2293 _("Invalid position requested by inverse search.\n"
2294 "You need to update the viewed document."));
2298 buffer_.text().setCursor(d->cursor_, newpit, newpos);
2299 d->cursor_.setSelection(false);
2300 d->cursor_.resetAnchor();
2305 bool BufferView::setCursorFromInset(Inset const * inset)
2307 // are we already there?
2308 if (cursor().nextInset() == inset)
2311 // Inset is not at cursor position. Find it in the document.
2314 while (cur && cur.nextInset() != inset)
2325 void BufferView::gotoLabel(docstring const & label)
2327 ListOfBuffers bufs = buffer().allRelatives();
2328 ListOfBuffers::iterator it = bufs.begin();
2329 for (; it != bufs.end(); ++it) {
2330 Buffer const * buf = *it;
2333 Toc & toc = buf->tocBackend().toc("label");
2334 TocIterator toc_it = toc.begin();
2335 TocIterator end = toc.end();
2336 for (; toc_it != end; ++toc_it) {
2337 if (label == toc_it->str()) {
2338 lyx::dispatch(toc_it->action());
2346 TextMetrics const & BufferView::textMetrics(Text const * t) const
2348 return const_cast<BufferView *>(this)->textMetrics(t);
2352 TextMetrics & BufferView::textMetrics(Text const * t)
2355 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
2356 if (tmc_it == d->text_metrics_.end()) {
2357 tmc_it = d->text_metrics_.insert(
2358 make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
2360 return tmc_it->second;
2364 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
2367 return textMetrics(t).parMetrics(pit);
2371 int BufferView::workHeight() const
2377 void BufferView::setCursor(DocIterator const & dit)
2380 size_t const n = dit.depth();
2381 for (size_t i = 0; i < n; ++i)
2382 dit[i].inset().edit(d->cursor_, true);
2384 d->cursor_.setCursor(dit);
2385 d->cursor_.setSelection(false);
2387 // It seems on general grounds as if this is probably needed, but
2388 // it is not yet clear.
2389 // See bug #7394 and r38388.
2390 // d->cursor.resetAnchor();
2394 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
2396 // Would be wrong to delete anything if we have a selection.
2397 if (cur.selection())
2400 bool need_anchor_change = false;
2401 bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
2402 need_anchor_change);
2404 if (need_anchor_change)
2412 cur.forceBufferUpdate();
2413 cur.screenUpdateFlags(Update::Force);
2418 bool BufferView::mouseSetCursor(Cursor & cur, bool select)
2420 LASSERT(&cur.bv() == this, /**/);
2423 // this event will clear selection so we save selection for
2424 // persistent selection
2425 cap::saveSelection(cursor());
2427 d->cursor_.macroModeClose();
2429 // Has the cursor just left the inset?
2430 bool const leftinset = (&d->cursor_.inset() != &cur.inset());
2432 d->cursor_.fixIfBroken();
2434 // FIXME: shift-mouse selection doesn't work well across insets.
2435 bool const do_selection =
2436 select && &d->cursor_.normalAnchor().inset() == &cur.inset();
2438 // do the dEPM magic if needed
2439 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
2440 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
2441 // the leftinset bool would not be necessary (badcursor instead).
2442 bool update = leftinset;
2443 if (!do_selection && d->cursor_.inTexted())
2444 update |= checkDepm(cur, d->cursor_);
2447 d->cursor_.resetAnchor();
2448 d->cursor_.setCursor(cur);
2449 d->cursor_.boundary(cur.boundary());
2451 d->cursor_.setSelection();
2453 d->cursor_.clearSelection();
2455 d->cursor_.finishUndo();
2456 d->cursor_.setCurrentFont();
2458 cur.forceBufferUpdate();
2463 void BufferView::putSelectionAt(DocIterator const & cur,
2464 int length, bool backwards)
2466 d->cursor_.clearSelection();
2472 d->cursor_.pos() += length;
2473 d->cursor_.setSelection(d->cursor_, -length);
2475 d->cursor_.setSelection(d->cursor_, length);
2480 bool BufferView::selectIfEmpty(DocIterator & cur)
2482 if (!cur.paragraph().empty())
2485 pit_type const beg_pit = cur.pit();
2487 // The paragraph associated to this item isn't
2488 // the first one, so it can be selected
2491 // We have to resort to select the space between the
2492 // end of this item and the begin of the next one
2496 // If it is the only item in the document,
2497 // nothing can be selected
2500 pit_type const end_pit = cur.pit();
2501 pos_type const end_pos = cur.pos();
2502 d->cursor_.clearSelection();
2504 d->cursor_.setCursor(cur);
2505 d->cursor_.pit() = beg_pit;
2506 d->cursor_.pos() = 0;
2507 d->cursor_.setSelection(false);
2508 d->cursor_.resetAnchor();
2509 d->cursor_.pit() = end_pit;
2510 d->cursor_.pos() = end_pos;
2511 d->cursor_.setSelection();
2516 Cursor & BufferView::cursor()
2522 Cursor const & BufferView::cursor() const
2528 pit_type BufferView::anchor_ref() const
2530 return d->anchor_pit_;
2534 bool BufferView::singleParUpdate()
2536 Text & buftext = buffer_.text();
2537 pit_type const bottom_pit = d->cursor_.bottom().pit();
2538 TextMetrics & tm = textMetrics(&buftext);
2539 int old_height = tm.parMetrics(bottom_pit).height();
2541 // make sure inline completion pointer is ok
2542 if (d->inlineCompletionPos_.fixIfBroken())
2543 d->inlineCompletionPos_ = DocIterator();
2545 // In Single Paragraph mode, rebreak only
2546 // the (main text, not inset!) paragraph containing the cursor.
2547 // (if this paragraph contains insets etc., rebreaking will
2548 // recursively descend)
2549 tm.redoParagraph(bottom_pit);
2550 ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
2551 if (pm.height() != old_height)
2552 // Paragraph height has changed so we cannot proceed to
2553 // the singlePar optimisation.
2556 d->update_strategy_ = SingleParUpdate;
2558 LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
2559 << " y2: " << pm.position() + pm.descent()
2560 << " pit: " << bottom_pit
2561 << " singlepar: 1");
2566 void BufferView::updateMetrics()
2568 if (height_ == 0 || width_ == 0)
2571 Text & buftext = buffer_.text();
2572 pit_type const npit = int(buftext.paragraphs().size());
2574 // Clear out the position cache in case of full screen redraw,
2575 d->coord_cache_.clear();
2577 // Clear out paragraph metrics to avoid having invalid metrics
2578 // in the cache from paragraphs not relayouted below
2579 // The complete text metrics will be redone.
2580 d->text_metrics_.clear();
2582 TextMetrics & tm = textMetrics(&buftext);
2584 // make sure inline completion pointer is ok
2585 if (d->inlineCompletionPos_.fixIfBroken())
2586 d->inlineCompletionPos_ = DocIterator();
2588 if (d->anchor_pit_ >= npit)
2589 // The anchor pit must have been deleted...
2590 d->anchor_pit_ = npit - 1;
2592 // Rebreak anchor paragraph.
2593 tm.redoParagraph(d->anchor_pit_);
2594 ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
2597 if (d->anchor_pit_ == 0) {
2598 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
2600 // Complete buffer visible? Then it's easy.
2601 if (scrollRange == 0)
2602 d->anchor_ypos_ = anchor_pm.ascent();
2604 // FIXME: Some clever handling needed to show
2605 // the _first_ paragraph up to the top if the cursor is
2606 // in the first line.
2608 anchor_pm.setPosition(d->anchor_ypos_);
2610 LYXERR(Debug::PAINTING, "metrics: "
2611 << " anchor pit = " << d->anchor_pit_
2612 << " anchor ypos = " << d->anchor_ypos_);
2614 // Redo paragraphs above anchor if necessary.
2615 int y1 = d->anchor_ypos_ - anchor_pm.ascent();
2616 // We are now just above the anchor paragraph.
2617 pit_type pit1 = d->anchor_pit_ - 1;
2618 for (; pit1 >= 0 && y1 >= 0; --pit1) {
2619 tm.redoParagraph(pit1);
2620 ParagraphMetrics & pm = tm.par_metrics_[pit1];
2622 // Save the paragraph position in the cache.
2627 // Redo paragraphs below the anchor if necessary.
2628 int y2 = d->anchor_ypos_ + anchor_pm.descent();
2629 // We are now just below the anchor paragraph.
2630 pit_type pit2 = d->anchor_pit_ + 1;
2631 for (; pit2 < npit && y2 <= height_; ++pit2) {
2632 tm.redoParagraph(pit2);
2633 ParagraphMetrics & pm = tm.par_metrics_[pit2];
2635 // Save the paragraph position in the cache.
2640 LYXERR(Debug::PAINTING, "Metrics: "
2641 << " anchor pit = " << d->anchor_pit_
2642 << " anchor ypos = " << d->anchor_ypos_
2645 << " pit1 = " << pit1
2646 << " pit2 = " << pit2);
2648 d->update_strategy_ = FullScreenUpdate;
2650 if (lyxerr.debugging(Debug::WORKAREA)) {
2651 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
2652 d->coord_cache_.dump();
2657 void BufferView::insertLyXFile(FileName const & fname)
2659 LASSERT(d->cursor_.inTexted(), /**/);
2661 // Get absolute path of file and add ".lyx"
2662 // to the filename if necessary
2663 FileName filename = fileSearch(string(), fname.absFileName(), "lyx");
2665 docstring const disp_fn = makeDisplayPath(filename.absFileName());
2666 // emit message signal.
2667 message(bformat(_("Inserting document %1$s..."), disp_fn));
2670 Buffer buf(filename.absFileName(), false);
2671 if (buf.loadLyXFile() == Buffer::ReadSuccess) {
2672 ErrorList & el = buffer_.errorList("Parse");
2673 // Copy the inserted document error list into the current buffer one.
2674 el = buf.errorList("Parse");
2675 buffer_.undo().recordUndo(d->cursor_);
2676 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
2677 buf.params().documentClassPtr(), el);
2678 res = _("Document %1$s inserted.");
2680 res = _("Could not insert document %1$s");
2683 buffer_.changed(true);
2684 // emit message signal.
2685 message(bformat(res, disp_fn));
2689 Point BufferView::coordOffset(DocIterator const & dit) const
2695 // Addup contribution of nested insets, from inside to outside,
2696 // keeping the outer paragraph for a special handling below
2697 for (size_t i = dit.depth() - 1; i >= 1; --i) {
2698 CursorSlice const & sl = dit[i];
2702 // get relative position inside sl.inset()
2703 sl.inset().cursorPos(*this, sl, dit.boundary() && (i + 1 == dit.depth()), xx, yy);
2705 // Make relative position inside of the edited inset relative to sl.inset()
2709 // In case of an RTL inset, the edited inset will be positioned to the left
2712 bool boundary_i = dit.boundary() && i + 1 == dit.depth();
2713 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2718 // remember width for the case that sl.inset() is positioned in an RTL inset
2719 if (i && dit[i - 1].text()) {
2720 // If this Inset is inside a Text Inset, retrieve the Dimension
2721 // from the containing text instead of using Inset::dimension() which
2722 // might not be implemented.
2723 // FIXME (Abdel 23/09/2007): this is a bit messy because of the
2724 // elimination of Inset::dim_ cache. This coordOffset() method needs
2725 // to be rewritten in light of the new design.
2726 Dimension const & dim = parMetrics(dit[i - 1].text(),
2727 dit[i - 1].pit()).insetDimension(&sl.inset());
2730 Dimension const dim = sl.inset().dimension(*this);
2734 //lyxerr << "Cursor::getPos, i: "
2735 // << i << " x: " << xx << " y: " << y << endl;
2738 // Add contribution of initial rows of outermost paragraph
2739 CursorSlice const & sl = dit[0];
2740 TextMetrics const & tm = textMetrics(sl.text());
2741 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2742 LASSERT(!pm.rows().empty(), /**/);
2743 y -= pm.rows()[0].ascent();
2745 // FIXME: document this mess
2747 if (sl.pos() > 0 && dit.depth() == 1) {
2749 if (pos && dit.boundary())
2751 // lyxerr << "coordOffset: boundary:" << dit.boundary() << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
2752 rend = pm.pos2row(pos);
2754 rend = pm.pos2row(sl.pos());
2756 size_t rend = pm.pos2row(sl.pos());
2758 for (size_t rit = 0; rit != rend; ++rit)
2759 y += pm.rows()[rit].height();
2760 y += pm.rows()[rend].ascent();
2762 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
2764 // Make relative position from the nested inset now bufferview absolute.
2765 int xx = bottom_tm.cursorX(dit.bottom(), dit.boundary() && dit.depth() == 1);
2768 // In the RTL case place the nested inset at the left of the cursor in
2769 // the outer paragraph
2770 bool boundary_1 = dit.boundary() && 1 == dit.depth();
2771 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
2779 Point BufferView::getPos(DocIterator const & dit) const
2781 if (!paragraphVisible(dit))
2782 return Point(-1, -1);
2784 CursorSlice const & bot = dit.bottom();
2785 TextMetrics const & tm = textMetrics(bot.text());
2787 // offset from outer paragraph
2788 Point p = coordOffset(dit);
2789 p.y_ += tm.parMetrics(bot.pit()).position();
2794 bool BufferView::paragraphVisible(DocIterator const & dit) const
2796 CursorSlice const & bot = dit.bottom();
2797 TextMetrics const & tm = textMetrics(bot.text());
2799 return tm.contains(bot.pit());
2803 void BufferView::cursorPosAndHeight(Point & p, int & h) const
2805 Cursor const & cur = cursor();
2806 Font const font = cur.getFont();
2807 frontend::FontMetrics const & fm = theFontMetrics(font);
2808 int const asc = fm.maxAscent();
2809 int const des = fm.maxDescent();
2816 bool BufferView::cursorInView(Point const & p, int h) const
2818 Cursor const & cur = cursor();
2819 // does the cursor touch the screen ?
2820 if (p.y_ + h < 0 || p.y_ >= workHeight() || !paragraphVisible(cur))
2826 void BufferView::draw(frontend::Painter & pain)
2828 if (height_ == 0 || width_ == 0)
2830 LYXERR(Debug::PAINTING, "\t\t*** START DRAWING ***");
2832 Text & text = buffer_.text();
2833 TextMetrics const & tm = d->text_metrics_[&text];
2834 int const y = tm.first().second->position();
2835 PainterInfo pi(this, pain);
2837 switch (d->update_strategy_) {
2839 case NoScreenUpdate:
2840 // If no screen painting is actually needed, only some the different
2841 // coordinates of insets and paragraphs needs to be updated.
2842 pi.full_repaint = true;
2843 pi.pain.setDrawingEnabled(false);
2847 case SingleParUpdate:
2848 pi.full_repaint = false;
2849 // In general, only the current row of the outermost paragraph
2850 // will be redrawn. Particular cases where selection spans
2851 // multiple paragraph are correctly detected in TextMetrics.
2855 case DecorationUpdate:
2856 // FIXME: We should also distinguish DecorationUpdate to avoid text
2857 // drawing if possible. This is not possible to do easily right now
2858 // because of the single backing pixmap.
2860 case FullScreenUpdate:
2861 // The whole screen, including insets, will be refreshed.
2862 pi.full_repaint = true;
2864 // Clear background.
2865 pain.fillRectangle(0, 0, width_, height_,
2866 pi.backgroundColor(&buffer_.inset()));
2871 // and possibly grey out below
2872 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2873 int const y2 = lastpm.second->position() + lastpm.second->descent();
2876 Color color = buffer().isInternal()
2877 ? Color_background : Color_bottomarea;
2878 pain.fillRectangle(0, y2, width_, height_ - y2, color);
2882 LYXERR(Debug::PAINTING, "\n\t\t*** END DRAWING ***");
2884 // The scrollbar needs an update.
2887 // Normalize anchor for next time
2888 pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
2889 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2890 for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
2891 ParagraphMetrics const & pm = tm.parMetrics(pit);
2892 if (pm.position() + pm.descent() > 0) {
2893 d->anchor_pit_ = pit;
2894 d->anchor_ypos_ = pm.position();
2898 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
2899 << " anchor ypos = " << d->anchor_ypos_);
2903 void BufferView::message(docstring const & msg)
2906 d->gui_->message(msg);
2910 void BufferView::showDialog(string const & name)
2913 d->gui_->showDialog(name, string());
2917 void BufferView::showDialog(string const & name,
2918 string const & data, Inset * inset)
2921 d->gui_->showDialog(name, data, inset);
2925 void BufferView::updateDialog(string const & name, string const & data)
2928 d->gui_->updateDialog(name, data);
2932 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
2938 // FIXME: Move this out of BufferView again
2939 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
2941 if (!fname.isReadableFile()) {
2942 docstring const error = from_ascii(strerror(errno));
2943 docstring const file = makeDisplayPath(fname.absFileName(), 50);
2944 docstring const text =
2945 bformat(_("Could not read the specified document\n"
2946 "%1$s\ndue to the error: %2$s"), file, error);
2947 Alert::error(_("Could not read file"), text);
2951 if (!fname.isReadableFile()) {
2952 docstring const file = makeDisplayPath(fname.absFileName(), 50);
2953 docstring const text =
2954 bformat(_("%1$s\n is not readable."), file);
2955 Alert::error(_("Could not open file"), text);
2959 // FIXME UNICODE: We don't know the encoding of the file
2960 docstring file_content = fname.fileContents("UTF-8");
2961 if (file_content.empty()) {
2962 Alert::error(_("Reading not UTF-8 encoded file"),
2963 _("The file is not UTF-8 encoded.\n"
2964 "It will be read as local 8Bit-encoded.\n"
2965 "If this does not give the correct result\n"
2966 "then please change the encoding of the file\n"
2967 "to UTF-8 with a program other than LyX.\n"));
2968 file_content = fname.fileContents("local8bit");
2971 return normalize_c(file_content);
2975 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
2977 docstring const tmpstr = contentsOfPlaintextFile(f);
2982 Cursor & cur = cursor();
2983 cap::replaceSelection(cur);
2984 buffer_.undo().recordUndo(cur);
2986 cur.innerText()->insertStringAsParagraphs(cur, tmpstr, cur.current_font);
2988 cur.innerText()->insertStringAsLines(cur, tmpstr, cur.current_font);
2990 buffer_.changed(true);
2994 docstring const & BufferView::inlineCompletion() const
2996 return d->inlineCompletion_;
3000 size_t const & BufferView::inlineCompletionUniqueChars() const
3002 return d->inlineCompletionUniqueChars_;
3006 DocIterator const & BufferView::inlineCompletionPos() const
3008 return d->inlineCompletionPos_;
3012 void BufferView::resetInlineCompletionPos()
3014 d->inlineCompletionPos_ = DocIterator();
3018 bool samePar(DocIterator const & a, DocIterator const & b)
3020 if (a.empty() && b.empty())
3022 if (a.empty() || b.empty())
3024 if (a.depth() != b.depth())
3026 return &a.innerParagraph() == &b.innerParagraph();
3030 void BufferView::setInlineCompletion(Cursor const & cur, DocIterator const & pos,
3031 docstring const & completion, size_t uniqueChars)
3033 uniqueChars = min(completion.size(), uniqueChars);
3034 bool changed = d->inlineCompletion_ != completion
3035 || d->inlineCompletionUniqueChars_ != uniqueChars;
3036 bool singlePar = true;
3037 d->inlineCompletion_ = completion;
3038 d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
3040 //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
3043 DocIterator const & old = d->inlineCompletionPos_;
3045 //lyxerr << "inlineCompletionPos changed" << std::endl;
3046 // old or pos are in another paragraph?
3047 if ((!samePar(cur, pos) && !pos.empty())
3048 || (!samePar(cur, old) && !old.empty())) {
3050 //lyxerr << "different paragraph" << std::endl;
3052 d->inlineCompletionPos_ = pos;
3057 if (singlePar && !(cur.result().screenUpdate() & Update::Force))
3058 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
3060 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::Force);
3065 bool BufferView::clickableInset() const
3067 return d->clickable_inset_;