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 return dit.paragraph().lookupChange(dit.pos());
693 // this could be used elsewhere as well?
694 // FIXME: This does not work within mathed!
695 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
697 Point const p = getPos(dit);
700 if (p.y_ > workHeight())
706 void BufferView::bookmarkEditPosition()
708 // Don't eat cpu time for each keystroke
709 if (d->cursor_.paragraph().id() == d->bookmark_edit_position_)
712 d->bookmark_edit_position_ = d->cursor_.paragraph().id();
716 void BufferView::saveBookmark(unsigned int idx)
718 // tentatively save bookmark, id and pos will be used to
719 // acturately locate a bookmark in a 'live' lyx session.
720 // pit and pos will be updated with bottom level pit/pos
722 if (!buffer_.isInternal()) {
723 theSession().bookmarks().save(
725 d->cursor_.bottom().pit(),
726 d->cursor_.bottom().pos(),
727 d->cursor_.paragraph().id(),
732 // emit message signal.
733 message(_("Save bookmark"));
738 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
739 int top_id, pos_type top_pos)
741 bool success = false;
744 d->cursor_.clearSelection();
746 // if a valid par_id is given, try it first
747 // This is the case for a 'live' bookmark when unique paragraph ID
748 // is used to track bookmarks.
750 dit = buffer_.getParFromID(top_id);
752 dit.pos() = min(dit.paragraph().size(), top_pos);
753 // Some slices of the iterator may not be
754 // reachable (e.g. closed collapsable inset)
755 // so the dociterator may need to be
756 // shortened. Otherwise, setCursor may crash
757 // lyx when the cursor can not be set to these
759 size_t const n = dit.depth();
760 for (size_t i = 0; i < n; ++i)
761 if (!dit[i].inset().editable()) {
769 // if top_id == 0, or searching through top_id failed
770 // This is the case for a 'restored' bookmark when only bottom
771 // (document level) pit was saved. Because of this, bookmark
772 // restoration is inaccurate. If a bookmark was within an inset,
773 // it will be restored to the left of the outmost inset that contains
775 if (bottom_pit < int(buffer_.paragraphs().size())) {
776 dit = doc_iterator_begin(&buffer_);
778 dit.pit() = bottom_pit;
779 dit.pos() = min(bottom_pos, dit.paragraph().size());
784 // Note: only bottom (document) level pit is set.
786 // set the current font.
787 d->cursor_.setCurrentFont();
788 // To center the screen on this new position we need the
789 // paragraph position which is computed at draw() time.
790 // So we need a redraw!
791 buffer_.changed(false);
800 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
802 if (lyxrc.rtl_support) {
803 if (d->cursor_.real_current_font.isRightToLeft()) {
804 if (d->intl_.keymap == Intl::PRIMARY)
805 d->intl_.keyMapSec();
807 if (d->intl_.keymap == Intl::SECONDARY)
808 d->intl_.keyMapPrim();
812 d->intl_.getTransManager().translateAndInsert(c, t, cur);
816 int BufferView::workWidth() const
822 void BufferView::recenter()
824 showCursor(d->cursor_, true, true);
828 void BufferView::showCursor()
830 showCursor(d->cursor_, false, true);
834 void BufferView::showCursor(DocIterator const & dit,
835 bool recenter, bool update)
837 if (scrollToCursor(dit, recenter) && update) {
838 buffer_.changed(true);
839 updateHoveredInset();
844 void BufferView::scrollToCursor()
846 if (scrollToCursor(d->cursor_, false)) {
847 buffer_.changed(true);
848 updateHoveredInset();
853 bool BufferView::scrollToCursor(DocIterator const & dit, bool recenter)
855 // We are not properly started yet, delay until resizing is
860 LYXERR(Debug::SCROLLING, "recentering!");
862 CursorSlice const & bot = dit.bottom();
863 TextMetrics & tm = d->text_metrics_[bot.text()];
865 pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
866 int bot_pit = bot.pit();
867 if (bot_pit > max_pit) {
868 // FIXME: Why does this happen?
869 LYXERR0("bottom pit is greater that max pit: "
870 << bot_pit << " > " << max_pit);
874 if (bot_pit == tm.first().first - 1)
875 tm.newParMetricsUp();
876 else if (bot_pit == tm.last().first + 1)
877 tm.newParMetricsDown();
879 if (tm.contains(bot_pit)) {
880 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
881 LBUFERR(!pm.rows().empty());
882 // FIXME: smooth scrolling doesn't work in mathed.
883 CursorSlice const & cs = dit.innerTextSlice();
884 int offset = coordOffset(dit).y_;
885 int ypos = pm.position() + offset;
886 Dimension const & row_dim =
887 pm.getRow(cs.pos(), dit.boundary()).dimension();
890 scrolled = scroll(ypos - height_/2);
892 // We try to visualize the whole row, if the row height is larger than
893 // the screen height, we scroll to a heuristic value of height_ / 4.
894 // FIXME: This heuristic value should be replaced by a recursive search
895 // for a row in the inset that can be visualized completely.
896 else if (row_dim.height() > height_) {
897 if (ypos < defaultRowHeight())
898 scrolled = scroll(ypos - height_ / 4);
899 else if (ypos > height_ - defaultRowHeight())
900 scrolled = scroll(ypos - 3 * height_ / 4);
903 // If the top part of the row falls of the screen, we scroll
904 // up to align the top of the row with the top of the screen.
905 else if (ypos - row_dim.ascent() < 0 && ypos < height_) {
906 int ynew = row_dim.ascent();
907 scrolled = scrollUp(ynew - ypos);
910 // If the bottom of the row falls of the screen, we scroll down.
911 else if (ypos + row_dim.descent() > height_ && ypos > 0) {
912 int ynew = height_ - row_dim.descent();
913 scrolled = scrollDown(ypos - ynew);
916 // else, nothing to do, the cursor is already visible so we just return.
917 return scrolled != 0;
920 // fix inline completion position
921 if (d->inlineCompletionPos_.fixIfBroken())
922 d->inlineCompletionPos_ = DocIterator();
924 tm.redoParagraph(bot_pit);
925 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
926 int offset = coordOffset(dit).y_;
928 d->anchor_pit_ = bot_pit;
929 CursorSlice const & cs = dit.innerTextSlice();
930 Dimension const & row_dim =
931 pm.getRow(cs.pos(), dit.boundary()).dimension();
934 d->anchor_ypos_ = height_/2;
935 else if (d->anchor_pit_ == 0)
936 d->anchor_ypos_ = offset + pm.ascent();
937 else if (d->anchor_pit_ == max_pit)
938 d->anchor_ypos_ = height_ - offset - row_dim.descent();
939 else if (offset > height_)
940 d->anchor_ypos_ = height_ - offset - defaultRowHeight();
942 d->anchor_ypos_ = defaultRowHeight() * 2;
948 void BufferView::makeDocumentClass()
950 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
951 buffer_.params().makeDocumentClass();
952 updateDocumentClass(olddc);
956 void BufferView::updateDocumentClass(DocumentClassConstPtr olddc)
958 message(_("Converting document to new document class..."));
960 StableDocIterator backcur(d->cursor_);
961 ErrorList & el = buffer_.errorList("Class Switch");
962 cap::switchBetweenClasses(
963 olddc, buffer_.params().documentClassPtr(),
964 static_cast<InsetText &>(buffer_.inset()), el);
966 setCursor(backcur.asDocIterator(&buffer_));
968 buffer_.errors("Class Switch");
972 /** Return the change status at cursor position, taking in account the
973 * status at each level of the document iterator (a table in a deleted
974 * footnote is deleted).
975 * When \param outer is true, the top slice is not looked at.
977 static Change::Type lookupChangeType(DocIterator const & dit, bool outer = false)
979 size_t const depth = dit.depth() - (outer ? 1 : 0);
981 for (size_t i = 0 ; i < depth ; ++i) {
982 CursorSlice const & slice = dit[i];
983 if (!slice.inset().inMathed()
984 && slice.pos() < slice.paragraph().size()) {
985 Change::Type const ch = slice.paragraph().lookupChange(slice.pos()).type;
986 if (ch != Change::UNCHANGED)
990 return Change::UNCHANGED;
994 bool BufferView::getStatus(FuncRequest const & cmd, FuncStatus & flag)
996 FuncCode const act = cmd.action();
998 // Can we use a readonly buffer?
999 if (buffer_.isReadonly()
1000 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1001 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1002 flag.message(from_utf8(N_("Document is read-only")));
1003 flag.setEnabled(false);
1007 // Are we in a DELETED change-tracking region?
1008 if (lookupChangeType(d->cursor_, true) == Change::DELETED
1009 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1010 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1011 flag.message(from_utf8(N_("This portion of the document is deleted.")));
1012 flag.setEnabled(false);
1016 Cursor & cur = d->cursor_;
1018 if (cur.getStatus(cmd, flag))
1023 // FIXME: This is a bit problematic because we don't check if this is
1024 // a document BufferView or not for these LFUNs. We probably have to
1025 // dispatch both to currentBufferView() and, if that fails,
1026 // to documentBufferView(); same as we do now for current Buffer and
1027 // document Buffer. Ideally those LFUN should go to Buffer as they
1028 // operate on the full Buffer and the cursor is only needed either for
1029 // an Undo record or to restore a cursor position. But we don't know
1030 // how to do that inside Buffer of course.
1031 case LFUN_BUFFER_PARAMS_APPLY:
1032 case LFUN_LAYOUT_MODULES_CLEAR:
1033 case LFUN_LAYOUT_MODULE_ADD:
1034 case LFUN_LAYOUT_RELOAD:
1035 case LFUN_TEXTCLASS_APPLY:
1036 case LFUN_TEXTCLASS_LOAD:
1037 flag.setEnabled(!buffer_.isReadonly());
1041 // We do not use the LyXAction flag for readonly because Undo sets the
1042 // buffer clean/dirty status by itself.
1043 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasUndoStack());
1046 // We do not use the LyXAction flag for readonly because Redo sets the
1047 // buffer clean/dirty status by itself.
1048 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasRedoStack());
1050 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
1051 case LFUN_FILE_INSERT_PLAINTEXT: {
1052 docstring const fname = cmd.argument();
1053 if (!FileName::isAbsolute(to_utf8(fname))) {
1054 flag.message(_("Absolute filename expected."));
1057 flag.setEnabled(cur.inTexted());
1060 case LFUN_FILE_INSERT:
1061 case LFUN_BOOKMARK_SAVE:
1062 // FIXME: Actually, these LFUNS should be moved to Text
1063 flag.setEnabled(cur.inTexted());
1066 case LFUN_FONT_STATE:
1067 case LFUN_LABEL_INSERT:
1068 case LFUN_INFO_INSERT:
1069 case LFUN_PARAGRAPH_GOTO:
1070 case LFUN_NOTE_NEXT:
1071 case LFUN_REFERENCE_NEXT:
1072 case LFUN_WORD_FIND:
1073 case LFUN_WORD_FIND_FORWARD:
1074 case LFUN_WORD_FIND_BACKWARD:
1075 case LFUN_WORD_REPLACE:
1078 case LFUN_MARK_TOGGLE:
1079 case LFUN_SCREEN_RECENTER:
1080 case LFUN_SCREEN_SHOW_CURSOR:
1081 case LFUN_BIBTEX_DATABASE_ADD:
1082 case LFUN_BIBTEX_DATABASE_DEL:
1083 case LFUN_STATISTICS:
1084 case LFUN_KEYMAP_OFF:
1085 case LFUN_KEYMAP_PRIMARY:
1086 case LFUN_KEYMAP_SECONDARY:
1087 case LFUN_KEYMAP_TOGGLE:
1088 flag.setEnabled(true);
1091 case LFUN_WORD_FINDADV: {
1092 FindAndReplaceOptions opt;
1093 istringstream iss(to_utf8(cmd.argument()));
1095 flag.setEnabled(opt.repl_buf_name.empty()
1096 || !buffer_.isReadonly());
1099 case LFUN_LABEL_GOTO: {
1100 flag.setEnabled(!cmd.argument().empty()
1101 || getInsetByCode<InsetRef>(cur, REF_CODE));
1105 case LFUN_CHANGES_TRACK:
1106 flag.setEnabled(true);
1107 flag.setOnOff(buffer_.params().trackChanges);
1110 case LFUN_CHANGES_OUTPUT:
1111 flag.setEnabled(true);
1112 flag.setOnOff(buffer_.params().outputChanges);
1115 case LFUN_CHANGES_MERGE:
1116 case LFUN_CHANGE_NEXT:
1117 case LFUN_CHANGE_PREVIOUS:
1118 case LFUN_ALL_CHANGES_ACCEPT:
1119 case LFUN_ALL_CHANGES_REJECT:
1120 // TODO: context-sensitive enabling of LFUNs
1121 // In principle, these command should only be enabled if there
1122 // is a change in the document. However, without proper
1123 // optimizations, this will inevitably result in poor performance.
1124 flag.setEnabled(true);
1127 case LFUN_BUFFER_TOGGLE_COMPRESSION: {
1128 flag.setOnOff(buffer_.params().compressed);
1132 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC: {
1133 flag.setOnOff(buffer_.params().output_sync);
1137 case LFUN_SCREEN_UP:
1138 case LFUN_SCREEN_DOWN:
1140 case LFUN_SCREEN_UP_SELECT:
1141 case LFUN_SCREEN_DOWN_SELECT:
1142 case LFUN_INSET_FORALL:
1143 flag.setEnabled(true);
1146 case LFUN_LAYOUT_TABULAR:
1147 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
1151 flag.setEnabled(!cur.inset().forcePlainLayout(cur.idx()));
1154 case LFUN_LAYOUT_PARAGRAPH:
1155 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
1158 case LFUN_BRANCH_ADD_INSERT:
1159 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1162 case LFUN_DIALOG_SHOW_NEW_INSET:
1163 // FIXME: this is wrong, but I do not understand the
1165 if (cur.inset().lyxCode() == CAPTION_CODE)
1166 return cur.inset().getStatus(cur, cmd, flag);
1167 // FIXME we should consider passthru paragraphs too.
1168 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1171 case LFUN_CITATION_INSERT: {
1172 FuncRequest fr(LFUN_INSET_INSERT, "citation");
1173 // FIXME: This could turn in a recursive hell.
1174 // Shouldn't we use Buffer::getStatus() instead?
1175 flag.setEnabled(lyx::getStatus(fr).enabled());
1178 case LFUN_INSET_APPLY: {
1179 string const name = cmd.getArg(0);
1180 Inset * inset = editedInset(name);
1182 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1183 if (!inset->getStatus(cur, fr, flag)) {
1184 // Every inset is supposed to handle this
1185 LASSERT(false, break);
1188 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1189 flag = lyx::getStatus(fr);
1202 Inset * BufferView::editedInset(string const & name) const
1204 map<string, Inset *>::const_iterator it = d->edited_insets_.find(name);
1205 return it == d->edited_insets_.end() ? 0 : it->second;
1209 void BufferView::editInset(string const & name, Inset * inset)
1211 d->edited_insets_[name] = inset;
1215 void BufferView::dispatch(FuncRequest const & cmd, DispatchResult & dr)
1217 LYXERR(Debug::ACTION, "BufferView::dispatch: cmd: " << cmd);
1219 string const argument = to_utf8(cmd.argument());
1220 Cursor & cur = d->cursor_;
1222 // Don't dispatch function that does not apply to internal buffers.
1223 if (buffer_.isInternal()
1224 && lyxaction.funcHasFlag(cmd.action(), LyXAction::NoInternal))
1227 // We'll set this back to false if need be.
1228 bool dispatched = true;
1229 buffer_.undo().beginUndoGroup();
1231 FuncCode const act = cmd.action();
1234 case LFUN_BUFFER_PARAMS_APPLY: {
1235 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1236 cur.recordUndoFullDocument();
1237 istringstream ss(to_utf8(cmd.argument()));
1240 int const unknown_tokens = buffer_.readHeader(lex);
1241 if (unknown_tokens != 0) {
1242 LYXERR0("Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1243 << unknown_tokens << " unknown token"
1244 << (unknown_tokens == 1 ? "" : "s"));
1246 updateDocumentClass(olddc);
1248 // We are most certainly here because of a change in the document
1249 // It is then better to make sure that all dialogs are in sync with
1250 // current document settings.
1251 dr.screenUpdate(Update::Force | Update::FitCursor);
1252 dr.forceBufferUpdate();
1256 case LFUN_LAYOUT_MODULES_CLEAR: {
1257 cur.recordUndoFullDocument();
1258 buffer_.params().clearLayoutModules();
1259 makeDocumentClass();
1260 dr.screenUpdate(Update::Force);
1261 dr.forceBufferUpdate();
1265 case LFUN_LAYOUT_MODULE_ADD: {
1266 BufferParams const & params = buffer_.params();
1267 if (!params.layoutModuleCanBeAdded(argument)) {
1268 LYXERR0("Module `" << argument <<
1269 "' cannot be added due to failed requirements or "
1270 "conflicts with installed modules.");
1273 cur.recordUndoFullDocument();
1274 buffer_.params().addLayoutModule(argument);
1275 makeDocumentClass();
1276 dr.screenUpdate(Update::Force);
1277 dr.forceBufferUpdate();
1281 case LFUN_TEXTCLASS_APPLY: {
1282 // since this shortcircuits, the second call is made only if
1284 bool const success =
1285 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1286 LayoutFileList::get().load(argument, buffer_.filePath());
1288 docstring s = bformat(_("The document class `%1$s' "
1289 "could not be loaded."), from_utf8(argument));
1290 frontend::Alert::error(_("Could not load class"), s);
1294 LayoutFile const * old_layout = buffer_.params().baseClass();
1295 LayoutFile const * new_layout = &(LayoutFileList::get()[argument]);
1297 if (old_layout == new_layout)
1301 // Save the old, possibly modular, layout for use in conversion.
1302 cur.recordUndoFullDocument();
1303 buffer_.params().setBaseClass(argument);
1304 makeDocumentClass();
1305 dr.screenUpdate(Update::Force);
1306 dr.forceBufferUpdate();
1310 case LFUN_TEXTCLASS_LOAD: {
1311 // since this shortcircuits, the second call is made only if
1313 bool const success =
1314 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1315 LayoutFileList::get().load(argument, buffer_.filePath());
1317 docstring s = bformat(_("The document class `%1$s' "
1318 "could not be loaded."), from_utf8(argument));
1319 frontend::Alert::error(_("Could not load class"), s);
1324 case LFUN_LAYOUT_RELOAD: {
1325 LayoutFileIndex bc = buffer_.params().baseClassID();
1326 LayoutFileList::get().reset(bc);
1327 buffer_.params().setBaseClass(bc);
1328 makeDocumentClass();
1329 dr.screenUpdate(Update::Force);
1330 dr.forceBufferUpdate();
1335 dr.setMessage(_("Undo"));
1336 cur.clearSelection();
1337 if (!cur.textUndo())
1338 dr.setMessage(_("No further undo information"));
1340 dr.screenUpdate(Update::Force | Update::FitCursor);
1341 dr.forceBufferUpdate();
1345 dr.setMessage(_("Redo"));
1346 cur.clearSelection();
1347 if (!cur.textRedo())
1348 dr.setMessage(_("No further redo information"));
1350 dr.screenUpdate(Update::Force | Update::FitCursor);
1351 dr.forceBufferUpdate();
1354 case LFUN_FONT_STATE:
1355 dr.setMessage(cur.currentState());
1358 case LFUN_BOOKMARK_SAVE:
1359 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1362 case LFUN_LABEL_GOTO: {
1363 docstring label = cmd.argument();
1364 if (label.empty()) {
1366 getInsetByCode<InsetRef>(cur, REF_CODE);
1368 label = inset->getParam("reference");
1369 // persistent=false: use temp_bookmark
1373 if (!label.empty()) {
1375 // at the moment, this is redundant, since gotoLabel will
1376 // eventually call LFUN_PARAGRAPH_GOTO, but it seems best
1378 dr.screenUpdate(Update::Force | Update::FitCursor);
1383 case LFUN_PARAGRAPH_GOTO: {
1384 int const id = convert<int>(cmd.getArg(0));
1385 int const pos = convert<int>(cmd.getArg(1));
1387 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1388 b = theBufferList().next(b)) {
1390 DocIterator dit = b->getParFromID(id);
1392 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1396 LYXERR(Debug::INFO, "Paragraph " << dit.paragraph().id()
1397 << " found in buffer `"
1398 << b->absFileName() << "'.");
1400 if (b == &buffer_) {
1404 dr.screenUpdate(Update::Force | Update::FitCursor);
1406 // Switch to other buffer view and resend cmd
1407 lyx::dispatch(FuncRequest(
1408 LFUN_BUFFER_SWITCH, b->absFileName()));
1416 case LFUN_NOTE_NEXT:
1417 gotoInset(this, NOTE_CODE, false);
1420 case LFUN_REFERENCE_NEXT: {
1421 vector<InsetCode> tmp;
1422 tmp.push_back(LABEL_CODE);
1423 tmp.push_back(REF_CODE);
1424 gotoInset(this, tmp, true);
1428 case LFUN_CHANGES_TRACK:
1429 buffer_.params().trackChanges = !buffer_.params().trackChanges;
1432 case LFUN_CHANGES_OUTPUT:
1433 buffer_.params().outputChanges = !buffer_.params().outputChanges;
1434 if (buffer_.params().outputChanges) {
1435 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1436 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1437 LaTeXFeatures::isAvailable("xcolor");
1439 if (!dvipost && !xcolorulem) {
1440 Alert::warning(_("Changes not shown in LaTeX output"),
1441 _("Changes will not be highlighted in LaTeX output, "
1442 "because neither dvipost nor xcolor/ulem are installed.\n"
1443 "Please install these packages or redefine "
1444 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1445 } else if (!xcolorulem) {
1446 Alert::warning(_("Changes not shown in LaTeX output"),
1447 _("Changes will not be highlighted in LaTeX output "
1448 "when using pdflatex, because xcolor and ulem are not installed.\n"
1449 "Please install both packages or redefine "
1450 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1455 case LFUN_CHANGE_NEXT:
1456 findNextChange(this);
1457 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1458 dr.screenUpdate(Update::Force | Update::FitCursor);
1461 case LFUN_CHANGE_PREVIOUS:
1462 findPreviousChange(this);
1463 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1464 dr.screenUpdate(Update::Force | Update::FitCursor);
1467 case LFUN_CHANGES_MERGE:
1468 if (findNextChange(this) || findPreviousChange(this)) {
1469 dr.screenUpdate(Update::Force | Update::FitCursor);
1470 dr.forceBufferUpdate();
1471 showDialog("changes");
1475 case LFUN_ALL_CHANGES_ACCEPT:
1476 // select complete document
1478 cur.selHandle(true);
1479 buffer_.text().cursorBottom(cur);
1480 // accept everything in a single step to support atomic undo
1481 buffer_.text().acceptOrRejectChanges(cur, Text::ACCEPT);
1483 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1484 dr.screenUpdate(Update::Force | Update::FitCursor);
1485 dr.forceBufferUpdate();
1488 case LFUN_ALL_CHANGES_REJECT:
1489 // select complete document
1491 cur.selHandle(true);
1492 buffer_.text().cursorBottom(cur);
1493 // reject everything in a single step to support atomic undo
1494 // Note: reject does not work recursively; the user may have to repeat the operation
1495 buffer_.text().acceptOrRejectChanges(cur, Text::REJECT);
1497 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1498 dr.screenUpdate(Update::Force | Update::FitCursor);
1499 dr.forceBufferUpdate();
1502 case LFUN_WORD_FIND_FORWARD:
1503 case LFUN_WORD_FIND_BACKWARD: {
1505 // Would it maybe be better if this variable were view specific anyway?
1506 static docstring last_search;
1507 docstring searched_string;
1509 if (!cmd.argument().empty()) {
1510 last_search = cmd.argument();
1511 searched_string = cmd.argument();
1513 searched_string = last_search;
1516 if (searched_string.empty())
1519 bool const fw = act == LFUN_WORD_FIND_FORWARD;
1520 docstring const data =
1521 find2string(searched_string, true, false, fw);
1522 bool found = lyxfind(this, FuncRequest(LFUN_WORD_FIND, data));
1524 dr.screenUpdate(Update::Force | Update::FitCursor);
1534 case LFUN_WORD_FIND: {
1535 FuncRequest req = cmd;
1536 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1537 req = d->search_request_cache_;
1538 if (req.argument().empty()) {
1539 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, "findreplace"));
1542 if (lyxfind(this, req)) {
1543 dr.screenUpdate(Update::Force | Update::FitCursor);
1550 d->search_request_cache_ = req;
1554 case LFUN_WORD_REPLACE: {
1555 bool has_deleted = false;
1556 if (cur.selection()) {
1557 DocIterator beg = cur.selectionBegin();
1558 DocIterator end = cur.selectionEnd();
1559 if (beg.pit() == end.pit()) {
1560 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1561 if (!cur.inMathed() && cur.paragraph().isDeleted(p)) {
1568 if (lyxreplace(this, cmd, has_deleted)) {
1569 dr.forceBufferUpdate();
1570 dr.screenUpdate(Update::Force | Update::FitCursor);
1580 case LFUN_WORD_FINDADV: {
1581 FindAndReplaceOptions opt;
1582 istringstream iss(to_utf8(cmd.argument()));
1584 if (findAdv(this, opt)) {
1585 dr.screenUpdate(Update::Force | Update::FitCursor);
1596 cur.clearSelection();
1597 dr.setMessage(from_utf8(N_("Mark off")));
1601 cur.clearSelection();
1603 dr.setMessage(from_utf8(N_("Mark on")));
1606 case LFUN_MARK_TOGGLE:
1607 cur.setSelection(false);
1610 dr.setMessage(from_utf8(N_("Mark removed")));
1613 dr.setMessage(from_utf8(N_("Mark set")));
1618 case LFUN_SCREEN_SHOW_CURSOR:
1622 case LFUN_SCREEN_RECENTER:
1626 case LFUN_BIBTEX_DATABASE_ADD: {
1627 Cursor tmpcur = cur;
1628 findInset(tmpcur, BIBTEX_CODE, false);
1629 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1632 if (inset->addDatabase(cmd.argument())) {
1633 buffer_.invalidateBibfileCache();
1634 dr.forceBufferUpdate();
1640 case LFUN_BIBTEX_DATABASE_DEL: {
1641 Cursor tmpcur = cur;
1642 findInset(tmpcur, BIBTEX_CODE, false);
1643 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1646 if (inset->delDatabase(cmd.argument())) {
1647 buffer_.invalidateBibfileCache();
1648 dr.forceBufferUpdate();
1654 case LFUN_STATISTICS: {
1655 DocIterator from, to;
1656 if (cur.selection()) {
1657 from = cur.selectionBegin();
1658 to = cur.selectionEnd();
1660 from = doc_iterator_begin(&buffer_);
1661 to = doc_iterator_end(&buffer_);
1663 buffer_.updateStatistics(from, to);
1664 int const words = buffer_.wordCount();
1665 int const chars = buffer_.charCount(false);
1666 int const chars_blanks = buffer_.charCount(true);
1668 if (cur.selection())
1669 message = _("Statistics for the selection:");
1671 message = _("Statistics for the document:");
1674 message += bformat(_("%1$d words"), words);
1676 message += _("One word");
1678 if (chars_blanks != 1)
1679 message += bformat(_("%1$d characters (including blanks)"),
1682 message += _("One character (including blanks)");
1685 message += bformat(_("%1$d characters (excluding blanks)"),
1688 message += _("One character (excluding blanks)");
1690 Alert::information(_("Statistics"), message);
1694 case LFUN_BUFFER_TOGGLE_COMPRESSION:
1695 // turn compression on/off
1696 buffer_.params().compressed = !buffer_.params().compressed;
1699 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
1700 buffer_.params().output_sync = !buffer_.params().output_sync;
1703 case LFUN_SCREEN_UP:
1704 case LFUN_SCREEN_DOWN: {
1705 Point p = getPos(cur);
1706 // This code has been commented out to enable to scroll down a
1707 // document, even if there are large insets in it (see bug #5465).
1708 /*if (p.y_ < 0 || p.y_ > height_) {
1709 // The cursor is off-screen so recenter before proceeding.
1713 int const scrolled = scroll(act == LFUN_SCREEN_UP
1714 ? -height_ : height_);
1715 if (act == LFUN_SCREEN_UP && scrolled > -height_)
1717 if (act == LFUN_SCREEN_DOWN && scrolled < height_)
1718 p = Point(width_, height_);
1720 bool const in_texted = cur.inTexted();
1721 cur.setCursor(doc_iterator_begin(cur.buffer()));
1722 cur.selHandle(false);
1723 buffer_.changed(true);
1724 updateHoveredInset();
1726 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_,
1727 true, act == LFUN_SCREEN_UP);
1728 //FIXME: what to do with cur.x_target()?
1729 bool update = in_texted && cur.bv().checkDepm(cur, old);
1732 if (update || cur.mark())
1733 dr.screenUpdate(Update::Force | Update::FitCursor);
1735 dr.forceBufferUpdate();
1740 string const scroll_type = cmd.getArg(0);
1741 int scroll_step = 0;
1742 if (scroll_type == "line")
1743 scroll_step = d->scrollbarParameters_.single_step;
1744 else if (scroll_type == "page")
1745 scroll_step = d->scrollbarParameters_.page_step;
1748 string const scroll_quantity = cmd.getArg(1);
1749 if (scroll_quantity == "up")
1750 scrollUp(scroll_step);
1751 else if (scroll_quantity == "down")
1752 scrollDown(scroll_step);
1754 int const scroll_value = convert<int>(scroll_quantity);
1756 scroll(scroll_step * scroll_value);
1758 buffer_.changed(true);
1759 updateHoveredInset();
1760 dr.forceBufferUpdate();
1764 case LFUN_SCREEN_UP_SELECT: {
1765 // FIXME: why is the algorithm different from LFUN_SCREEN_UP?
1766 cur.selHandle(true);
1767 if (isTopScreen()) {
1768 lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1772 int y = getPos(cur).y_;
1773 int const ymin = y - height_ + defaultRowHeight();
1774 while (y > ymin && cur.up())
1778 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1782 case LFUN_SCREEN_DOWN_SELECT: {
1783 // FIXME: why is the algorithm different from LFUN_SCREEN_DOWN?
1784 cur.selHandle(true);
1785 if (isBottomScreen()) {
1786 lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1790 int y = getPos(cur).y_;
1791 int const ymax = y + height_ - defaultRowHeight();
1792 while (y < ymax && cur.down())
1796 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1801 // This would be in Buffer class if only Cursor did not
1802 // require a bufferview
1803 case LFUN_INSET_FORALL: {
1804 docstring const name = from_utf8(cmd.getArg(0));
1805 string const commandstr = cmd.getLongArg(1);
1806 FuncRequest const fr = lyxaction.lookupFunc(commandstr);
1808 // an arbitrary number to limit number of iterations
1809 const int max_iter = 100000;
1811 Cursor & cur = d->cursor_;
1812 Cursor const savecur = cur;
1814 if (!cur.nextInset())
1816 cur.beginUndoGroup();
1817 while(cur && iterations < max_iter) {
1818 Inset * const ins = cur.nextInset();
1821 docstring insname = ins->layoutName();
1822 while (!insname.empty()) {
1823 if (insname == name || name == from_utf8("*")) {
1825 lyx::dispatch(fr, dr);
1829 size_t const i = insname.rfind(':');
1830 if (i == string::npos)
1832 insname = insname.substr(0, i);
1834 // if we did not delete the inset, skip it
1835 if (!cur.nextInset() || cur.nextInset() == ins)
1841 dr.screenUpdate(Update::Force);
1842 dr.forceBufferUpdate();
1844 if (iterations >= max_iter) {
1846 dr.setMessage(bformat(_("`inset-forall' interrupted because number of actions is larger than %1$d"), max_iter));
1848 dr.setMessage(bformat(_("Applied \"%1$s\" to %2$d insets"), from_utf8(commandstr), iterations));
1853 case LFUN_BRANCH_ADD_INSERT: {
1854 docstring branch_name = from_utf8(cmd.getArg(0));
1855 if (branch_name.empty())
1856 if (!Alert::askForText(branch_name, _("Branch name")) ||
1857 branch_name.empty())
1860 DispatchResult drtmp;
1861 buffer_.dispatch(FuncRequest(LFUN_BRANCH_ADD, branch_name), drtmp);
1862 if (drtmp.error()) {
1863 Alert::warning(_("Branch already exists"), drtmp.message());
1866 BranchList & branch_list = buffer_.params().branchlist();
1867 vector<docstring> const branches =
1868 getVectorFromString(branch_name, branch_list.separator());
1869 for (vector<docstring>::const_iterator it = branches.begin();
1870 it != branches.end(); ++it) {
1872 lyx::dispatch(FuncRequest(LFUN_BRANCH_INSERT, branch_name));
1877 case LFUN_KEYMAP_OFF:
1878 getIntl().keyMapOn(false);
1881 case LFUN_KEYMAP_PRIMARY:
1882 getIntl().keyMapPrim();
1885 case LFUN_KEYMAP_SECONDARY:
1886 getIntl().keyMapSec();
1889 case LFUN_KEYMAP_TOGGLE:
1890 getIntl().toggleKeyMap();
1893 case LFUN_DIALOG_SHOW_NEW_INSET: {
1894 string const name = cmd.getArg(0);
1895 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
1896 if (decodeInsetParam(name, data, buffer_))
1897 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
1899 lyxerr << "Inset type '" << name <<
1900 "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" << endl;
1904 case LFUN_CITATION_INSERT: {
1905 if (argument.empty()) {
1906 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
1909 // we can have one optional argument, delimited by '|'
1910 // citation-insert <key>|<text_before>
1911 // this should be enhanced to also support text_after
1912 // and citation style
1913 string arg = argument;
1915 if (contains(argument, "|")) {
1916 arg = token(argument, '|', 0);
1917 opt1 = token(argument, '|', 1);
1920 // if our cursor is directly in front of or behind a citation inset,
1921 // we will instead add the new key to it.
1922 Inset * inset = cur.nextInset();
1923 if (!inset || inset->lyxCode() != CITE_CODE)
1924 inset = cur.prevInset();
1925 if (inset && inset->lyxCode() == CITE_CODE) {
1926 InsetCitation * icite = static_cast<InsetCitation *>(inset);
1927 if (icite->addKey(arg)) {
1928 dr.forceBufferUpdate();
1929 dr.screenUpdate(Update::FitCursor | Update::SinglePar);
1931 LYXERR0("Discarding optional argument to citation-insert.");
1936 InsetCommandParams icp(CITE_CODE);
1937 icp["key"] = from_utf8(arg);
1939 icp["before"] = from_utf8(opt1);
1940 string icstr = InsetCommand::params2string(icp);
1941 FuncRequest fr(LFUN_INSET_INSERT, icstr);
1946 case LFUN_INSET_APPLY: {
1947 string const name = cmd.getArg(0);
1948 Inset * inset = editedInset(name);
1950 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1954 // put cursor in front of inset.
1955 if (!setCursorFromInset(inset)) {
1956 LASSERT(false, break);
1959 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1960 inset->dispatch(cur, fr);
1961 dr.screenUpdate(cur.result().screenUpdate());
1962 if (cur.result().needBufferUpdate())
1963 dr.forceBufferUpdate();
1968 // The change of language of buffer belongs to the Buffer class.
1969 // We have to do it here because we need a cursor for Undo.
1970 // When Undo::recordUndoBufferParams() is implemented someday
1971 // LFUN_BUFFER_LANGUAGE should be handled by the Buffer class.
1972 case LFUN_BUFFER_LANGUAGE: {
1973 Language const * oldL = buffer_.params().language;
1974 Language const * newL = languages.getLanguage(argument);
1975 if (!newL || oldL == newL)
1977 if (oldL->rightToLeft() == newL->rightToLeft()) {
1978 cur.recordUndoFullDocument();
1979 buffer_.changeLanguage(oldL, newL);
1980 cur.setCurrentFont();
1981 dr.forceBufferUpdate();
1986 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
1987 case LFUN_FILE_INSERT_PLAINTEXT: {
1988 bool const as_paragraph = (act == LFUN_FILE_INSERT_PLAINTEXT_PARA);
1989 string const fname = to_utf8(cmd.argument());
1990 if (!FileName::isAbsolute(fname))
1991 dr.setMessage(_("Absolute filename expected."));
1993 insertPlaintextFile(FileName(fname), as_paragraph);
1998 // OK, so try the Buffer itself...
1999 buffer_.dispatch(cmd, dr);
2000 dispatched = dr.dispatched();
2004 buffer_.undo().endUndoGroup();
2005 dr.dispatched(dispatched);
2009 docstring const BufferView::requestSelection()
2011 Cursor & cur = d->cursor_;
2013 LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
2014 if (!cur.selection()) {
2015 d->xsel_cache_.set = false;
2019 LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
2020 if (!d->xsel_cache_.set ||
2021 cur.top() != d->xsel_cache_.cursor ||
2022 cur.realAnchor().top() != d->xsel_cache_.anchor)
2024 d->xsel_cache_.cursor = cur.top();
2025 d->xsel_cache_.anchor = cur.realAnchor().top();
2026 d->xsel_cache_.set = cur.selection();
2027 return cur.selectionAsString(false);
2033 void BufferView::clearSelection()
2035 d->cursor_.clearSelection();
2036 // Clear the selection buffer. Otherwise a subsequent
2037 // middle-mouse-button paste would use the selection buffer,
2038 // not the more current external selection.
2039 cap::clearSelection();
2040 d->xsel_cache_.set = false;
2041 // The buffer did not really change, but this causes the
2042 // redraw we need because we cleared the selection above.
2043 buffer_.changed(false);
2047 void BufferView::resize(int width, int height)
2049 // Update from work area
2053 // Clear the paragraph height cache.
2054 d->par_height_.clear();
2055 // Redo the metrics.
2060 Inset const * BufferView::getCoveringInset(Text const & text,
2063 TextMetrics & tm = d->text_metrics_[&text];
2064 Inset * inset = tm.checkInsetHit(x, y);
2068 if (!inset->descendable(*this))
2069 // No need to go further down if the inset is not
2073 size_t cell_number = inset->nargs();
2074 // Check all the inner cell.
2075 for (size_t i = 0; i != cell_number; ++i) {
2076 Text const * inner_text = inset->getText(i);
2079 Inset const * inset_deeper =
2080 getCoveringInset(*inner_text, x, y);
2082 return inset_deeper;
2090 void BufferView::updateHoveredInset() const
2092 // Get inset under mouse, if there is one.
2093 int const x = d->mouse_position_cache_.x_;
2094 int const y = d->mouse_position_cache_.y_;
2095 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
2097 d->clickable_inset_ = covering_inset && covering_inset->clickable(x, y);
2099 if (covering_inset == d->last_inset_)
2100 // Same inset, no need to do anything...
2103 bool need_redraw = false;
2104 if (d->last_inset_) {
2105 // Remove the hint on the last hovered inset (if any).
2106 need_redraw |= d->last_inset_->setMouseHover(this, false);
2110 if (covering_inset && covering_inset->setMouseHover(this, true)) {
2112 // Only the insets that accept the hover state, do
2113 // clear the last_inset_, so only set the last_inset_
2114 // member if the hovered setting is accepted.
2115 d->last_inset_ = covering_inset;
2119 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
2120 << d->mouse_position_cache_.x_ << ", "
2121 << d->mouse_position_cache_.y_ << ")");
2123 d->update_strategy_ = DecorationUpdate;
2125 // This event (moving without mouse click) is not passed further.
2126 // This should be changed if it is further utilized.
2127 buffer_.changed(false);
2132 void BufferView::clearLastInset(Inset * inset) const
2134 if (d->last_inset_ != inset) {
2135 LYXERR0("Wrong last_inset!");
2142 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
2144 //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
2146 // This is only called for mouse related events including
2147 // LFUN_FILE_OPEN generated by drag-and-drop.
2148 FuncRequest cmd = cmd0;
2150 Cursor old = cursor();
2152 cur.push(buffer_.inset());
2153 cur.setSelection(d->cursor_.selection());
2155 // Either the inset under the cursor or the
2156 // surrounding Text will handle this event.
2158 // make sure we stay within the screen...
2159 cmd.set_y(min(max(cmd.y(), -1), height_));
2161 d->mouse_position_cache_.x_ = cmd.x();
2162 d->mouse_position_cache_.y_ = cmd.y();
2164 if (cmd.action() == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
2165 updateHoveredInset();
2169 // Build temporary cursor.
2170 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x(), cmd.y());
2172 // Put anchor at the same position.
2175 cur.beginUndoGroup();
2177 // Try to dispatch to an non-editable inset near this position
2178 // via the temp cursor. If the inset wishes to change the real
2179 // cursor it has to do so explicitly by using
2180 // cur.bv().cursor() = cur; (or similar)
2182 inset->dispatch(cur, cmd);
2184 // Now dispatch to the temporary cursor. If the real cursor should
2185 // be modified, the inset's dispatch has to do so explicitly.
2186 if (!inset || !cur.result().dispatched())
2191 // Notify left insets
2193 bool badcursor = old.fixIfBroken() | cur.fixIfBroken();
2194 badcursor |= notifyCursorLeavesOrEnters(old, cur);
2196 cursor().fixIfBroken();
2199 // Do we have a selection?
2200 theSelection().haveSelection(cursor().selection());
2202 if (cur.needBufferUpdate()) {
2203 cur.clearBufferUpdate();
2204 buffer().updateBuffer();
2207 // If the command has been dispatched,
2208 if (cur.result().dispatched() || cur.result().screenUpdate())
2209 processUpdateFlags(cur.result().screenUpdate());
2213 int BufferView::minVisiblePart()
2215 return 2 * defaultRowHeight();
2219 int BufferView::scroll(int y)
2222 return scrollDown(y);
2224 return scrollUp(-y);
2229 int BufferView::scrollDown(int offset)
2231 Text * text = &buffer_.text();
2232 TextMetrics & tm = d->text_metrics_[text];
2233 int const ymax = height_ + offset;
2235 pair<pit_type, ParagraphMetrics const *> last = tm.last();
2236 int bottom_pos = last.second->position() + last.second->descent();
2237 if (lyxrc.scroll_below_document)
2238 bottom_pos += height_ - minVisiblePart();
2239 if (last.first + 1 == int(text->paragraphs().size())) {
2240 if (bottom_pos <= height_)
2242 offset = min(offset, bottom_pos - height_);
2245 if (bottom_pos > ymax)
2247 tm.newParMetricsDown();
2249 d->anchor_ypos_ -= offset;
2254 int BufferView::scrollUp(int offset)
2256 Text * text = &buffer_.text();
2257 TextMetrics & tm = d->text_metrics_[text];
2258 int ymin = - offset;
2260 pair<pit_type, ParagraphMetrics const *> first = tm.first();
2261 int top_pos = first.second->position() - first.second->ascent();
2262 if (first.first == 0) {
2265 offset = min(offset, - top_pos);
2270 tm.newParMetricsUp();
2272 d->anchor_ypos_ += offset;
2277 void BufferView::setCursorFromRow(int row)
2281 pit_type newpit = 0;
2282 pos_type newpos = 0;
2284 buffer_.texrow().getIdFromRow(row, tmpid, tmppos);
2286 bool posvalid = (tmpid != -1);
2288 // we need to make sure that the row and position
2289 // we got back are valid, because the buffer may well
2290 // have changed since we last generated the LaTeX.
2291 DocIterator const dit = buffer_.getParFromID(tmpid);
2292 if (dit == doc_iterator_end(&buffer_))
2296 // now have to check pos.
2298 Paragraph const & par = buffer_.text().getPar(newpit);
2299 if (newpos > par.size()) {
2300 LYXERR0("Requested position no longer valid.");
2301 newpos = par.size() - 1;
2306 frontend::Alert::error(_("Inverse Search Failed"),
2307 _("Invalid position requested by inverse search.\n"
2308 "You need to update the viewed document."));
2312 buffer_.text().setCursor(d->cursor_, newpit, newpos);
2313 d->cursor_.setSelection(false);
2314 d->cursor_.resetAnchor();
2319 bool BufferView::setCursorFromInset(Inset const * inset)
2321 // are we already there?
2322 if (cursor().nextInset() == inset)
2325 // Inset is not at cursor position. Find it in the document.
2328 while (cur && cur.nextInset() != inset)
2339 void BufferView::gotoLabel(docstring const & label)
2341 ListOfBuffers bufs = buffer().allRelatives();
2342 ListOfBuffers::iterator it = bufs.begin();
2343 for (; it != bufs.end(); ++it) {
2344 Buffer const * buf = *it;
2347 Toc & toc = buf->tocBackend().toc("label");
2348 TocIterator toc_it = toc.begin();
2349 TocIterator end = toc.end();
2350 for (; toc_it != end; ++toc_it) {
2351 if (label == toc_it->str()) {
2352 lyx::dispatch(toc_it->action());
2360 TextMetrics const & BufferView::textMetrics(Text const * t) const
2362 return const_cast<BufferView *>(this)->textMetrics(t);
2366 TextMetrics & BufferView::textMetrics(Text const * t)
2369 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
2370 if (tmc_it == d->text_metrics_.end()) {
2371 tmc_it = d->text_metrics_.insert(
2372 make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
2374 return tmc_it->second;
2378 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
2381 return textMetrics(t).parMetrics(pit);
2385 int BufferView::workHeight() const
2391 void BufferView::setCursor(DocIterator const & dit)
2394 size_t const n = dit.depth();
2395 for (size_t i = 0; i < n; ++i)
2396 dit[i].inset().edit(d->cursor_, true);
2398 d->cursor_.setCursor(dit);
2399 d->cursor_.setSelection(false);
2401 // It seems on general grounds as if this is probably needed, but
2402 // it is not yet clear.
2403 // See bug #7394 and r38388.
2404 // d->cursor.resetAnchor();
2408 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
2410 // Would be wrong to delete anything if we have a selection.
2411 if (cur.selection())
2414 bool need_anchor_change = false;
2415 bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
2416 need_anchor_change);
2418 if (need_anchor_change)
2426 // we would rather not do this here, but it needs to be done before
2427 // the changed() signal is sent.
2428 buffer_.updateBuffer();
2430 buffer_.changed(true);
2435 bool BufferView::mouseSetCursor(Cursor & cur, bool select)
2437 LASSERT(&cur.bv() == this, return false);
2440 // this event will clear selection so we save selection for
2441 // persistent selection
2442 cap::saveSelection(cursor());
2444 d->cursor_.macroModeClose();
2445 // If a macro has been finalized, the cursor might have been broken
2448 // Has the cursor just left the inset?
2449 bool const leftinset = (&d->cursor_.inset() != &cur.inset());
2451 d->cursor_.fixIfBroken();
2453 // FIXME: shift-mouse selection doesn't work well across insets.
2454 bool const do_selection =
2455 select && &d->cursor_.normalAnchor().inset() == &cur.inset();
2457 // do the dEPM magic if needed
2458 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
2459 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
2460 // the leftinset bool would not be necessary (badcursor instead).
2461 bool update = leftinset;
2462 if (!do_selection && d->cursor_.inTexted())
2463 update |= checkDepm(cur, d->cursor_);
2466 d->cursor_.resetAnchor();
2467 d->cursor_.setCursor(cur);
2468 d->cursor_.boundary(cur.boundary());
2470 d->cursor_.setSelection();
2472 d->cursor_.clearSelection();
2474 d->cursor_.finishUndo();
2475 d->cursor_.setCurrentFont();
2477 cur.forceBufferUpdate();
2482 void BufferView::putSelectionAt(DocIterator const & cur,
2483 int length, bool backwards)
2485 d->cursor_.clearSelection();
2491 d->cursor_.pos() += length;
2492 d->cursor_.setSelection(d->cursor_, -length);
2494 d->cursor_.setSelection(d->cursor_, length);
2499 bool BufferView::selectIfEmpty(DocIterator & cur)
2501 if ((cur.inTexted() && !cur.paragraph().empty())
2502 || (cur.inMathed() && !cur.cell().empty()))
2505 pit_type const beg_pit = cur.pit();
2507 // The paragraph associated to this item isn't
2508 // the first one, so it can be selected
2511 // We have to resort to select the space between the
2512 // end of this item and the begin of the next one
2516 // If it is the only item in the document,
2517 // nothing can be selected
2520 pit_type const end_pit = cur.pit();
2521 pos_type const end_pos = cur.pos();
2522 d->cursor_.clearSelection();
2524 d->cursor_.setCursor(cur);
2525 d->cursor_.pit() = beg_pit;
2526 d->cursor_.pos() = 0;
2527 d->cursor_.setSelection(false);
2528 d->cursor_.resetAnchor();
2529 d->cursor_.pit() = end_pit;
2530 d->cursor_.pos() = end_pos;
2531 d->cursor_.setSelection();
2536 Cursor & BufferView::cursor()
2542 Cursor const & BufferView::cursor() const
2548 pit_type BufferView::anchor_ref() const
2550 return d->anchor_pit_;
2554 bool BufferView::singleParUpdate()
2556 Text & buftext = buffer_.text();
2557 pit_type const bottom_pit = d->cursor_.bottom().pit();
2558 TextMetrics & tm = textMetrics(&buftext);
2559 int old_height = tm.parMetrics(bottom_pit).height();
2561 // make sure inline completion pointer is ok
2562 if (d->inlineCompletionPos_.fixIfBroken())
2563 d->inlineCompletionPos_ = DocIterator();
2565 // In Single Paragraph mode, rebreak only
2566 // the (main text, not inset!) paragraph containing the cursor.
2567 // (if this paragraph contains insets etc., rebreaking will
2568 // recursively descend)
2569 tm.redoParagraph(bottom_pit);
2570 ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
2571 if (pm.height() != old_height)
2572 // Paragraph height has changed so we cannot proceed to
2573 // the singlePar optimisation.
2576 d->update_strategy_ = SingleParUpdate;
2578 LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
2579 << " y2: " << pm.position() + pm.descent()
2580 << " pit: " << bottom_pit
2581 << " singlepar: 1");
2586 void BufferView::updateMetrics()
2588 if (height_ == 0 || width_ == 0)
2591 Text & buftext = buffer_.text();
2592 pit_type const npit = int(buftext.paragraphs().size());
2594 // Clear out the position cache in case of full screen redraw,
2595 d->coord_cache_.clear();
2597 // Clear out paragraph metrics to avoid having invalid metrics
2598 // in the cache from paragraphs not relayouted below
2599 // The complete text metrics will be redone.
2600 d->text_metrics_.clear();
2602 TextMetrics & tm = textMetrics(&buftext);
2604 // make sure inline completion pointer is ok
2605 if (d->inlineCompletionPos_.fixIfBroken())
2606 d->inlineCompletionPos_ = DocIterator();
2608 if (d->anchor_pit_ >= npit)
2609 // The anchor pit must have been deleted...
2610 d->anchor_pit_ = npit - 1;
2612 // Rebreak anchor paragraph.
2613 tm.redoParagraph(d->anchor_pit_);
2614 ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
2617 if (d->anchor_pit_ == 0) {
2618 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
2620 // Complete buffer visible? Then it's easy.
2621 if (scrollRange == 0)
2622 d->anchor_ypos_ = anchor_pm.ascent();
2624 // FIXME: Some clever handling needed to show
2625 // the _first_ paragraph up to the top if the cursor is
2626 // in the first line.
2628 anchor_pm.setPosition(d->anchor_ypos_);
2630 LYXERR(Debug::PAINTING, "metrics: "
2631 << " anchor pit = " << d->anchor_pit_
2632 << " anchor ypos = " << d->anchor_ypos_);
2634 // Redo paragraphs above anchor if necessary.
2635 int y1 = d->anchor_ypos_ - anchor_pm.ascent();
2636 // We are now just above the anchor paragraph.
2637 pit_type pit1 = d->anchor_pit_ - 1;
2638 for (; pit1 >= 0 && y1 >= 0; --pit1) {
2639 tm.redoParagraph(pit1);
2640 ParagraphMetrics & pm = tm.par_metrics_[pit1];
2642 // Save the paragraph position in the cache.
2647 // Redo paragraphs below the anchor if necessary.
2648 int y2 = d->anchor_ypos_ + anchor_pm.descent();
2649 // We are now just below the anchor paragraph.
2650 pit_type pit2 = d->anchor_pit_ + 1;
2651 for (; pit2 < npit && y2 <= height_; ++pit2) {
2652 tm.redoParagraph(pit2);
2653 ParagraphMetrics & pm = tm.par_metrics_[pit2];
2655 // Save the paragraph position in the cache.
2660 LYXERR(Debug::PAINTING, "Metrics: "
2661 << " anchor pit = " << d->anchor_pit_
2662 << " anchor ypos = " << d->anchor_ypos_
2665 << " pit1 = " << pit1
2666 << " pit2 = " << pit2);
2668 d->update_strategy_ = FullScreenUpdate;
2670 if (lyxerr.debugging(Debug::WORKAREA)) {
2671 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
2672 d->coord_cache_.dump();
2677 void BufferView::insertLyXFile(FileName const & fname)
2679 LASSERT(d->cursor_.inTexted(), return);
2681 // Get absolute path of file and add ".lyx"
2682 // to the filename if necessary
2683 FileName filename = fileSearch(string(), fname.absFileName(), "lyx");
2685 docstring const disp_fn = makeDisplayPath(filename.absFileName());
2686 // emit message signal.
2687 message(bformat(_("Inserting document %1$s..."), disp_fn));
2690 Buffer buf(filename.absFileName(), false);
2691 if (buf.loadLyXFile() == Buffer::ReadSuccess) {
2692 ErrorList & el = buffer_.errorList("Parse");
2693 // Copy the inserted document error list into the current buffer one.
2694 el = buf.errorList("Parse");
2695 buffer_.undo().recordUndo(d->cursor_);
2696 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
2697 buf.params().documentClassPtr(), el);
2698 res = _("Document %1$s inserted.");
2700 res = _("Could not insert document %1$s");
2703 buffer_.changed(true);
2704 // emit message signal.
2705 message(bformat(res, disp_fn));
2709 Point BufferView::coordOffset(DocIterator const & dit) const
2715 // Addup contribution of nested insets, from inside to outside,
2716 // keeping the outer paragraph for a special handling below
2717 for (size_t i = dit.depth() - 1; i >= 1; --i) {
2718 CursorSlice const & sl = dit[i];
2722 // get relative position inside sl.inset()
2723 sl.inset().cursorPos(*this, sl, dit.boundary() && (i + 1 == dit.depth()), xx, yy);
2725 // Make relative position inside of the edited inset relative to sl.inset()
2729 // In case of an RTL inset, the edited inset will be positioned to the left
2732 bool boundary_i = dit.boundary() && i + 1 == dit.depth();
2733 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2738 // remember width for the case that sl.inset() is positioned in an RTL inset
2739 if (i && dit[i - 1].text()) {
2740 // If this Inset is inside a Text Inset, retrieve the Dimension
2741 // from the containing text instead of using Inset::dimension() which
2742 // might not be implemented.
2743 // FIXME (Abdel 23/09/2007): this is a bit messy because of the
2744 // elimination of Inset::dim_ cache. This coordOffset() method needs
2745 // to be rewritten in light of the new design.
2746 Dimension const & dim = parMetrics(dit[i - 1].text(),
2747 dit[i - 1].pit()).insetDimension(&sl.inset());
2750 Dimension const dim = sl.inset().dimension(*this);
2754 //lyxerr << "Cursor::getPos, i: "
2755 // << i << " x: " << xx << " y: " << y << endl;
2758 // Add contribution of initial rows of outermost paragraph
2759 CursorSlice const & sl = dit[0];
2760 TextMetrics const & tm = textMetrics(sl.text());
2761 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2763 LBUFERR(!pm.rows().empty());
2764 y -= pm.rows()[0].ascent();
2766 // FIXME: document this mess
2768 if (sl.pos() > 0 && dit.depth() == 1) {
2770 if (pos && dit.boundary())
2772 // lyxerr << "coordOffset: boundary:" << dit.boundary() << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
2773 rend = pm.pos2row(pos);
2775 rend = pm.pos2row(sl.pos());
2777 size_t rend = pm.pos2row(sl.pos());
2779 for (size_t rit = 0; rit != rend; ++rit)
2780 y += pm.rows()[rit].height();
2781 y += pm.rows()[rend].ascent();
2783 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
2785 // Make relative position from the nested inset now bufferview absolute.
2786 int xx = bottom_tm.cursorX(dit.bottom(), dit.boundary() && dit.depth() == 1);
2789 // In the RTL case place the nested inset at the left of the cursor in
2790 // the outer paragraph
2791 bool boundary_1 = dit.boundary() && 1 == dit.depth();
2792 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
2800 Point BufferView::getPos(DocIterator const & dit) const
2802 if (!paragraphVisible(dit))
2803 return Point(-1, -1);
2805 CursorSlice const & bot = dit.bottom();
2806 TextMetrics const & tm = textMetrics(bot.text());
2808 // offset from outer paragraph
2809 Point p = coordOffset(dit);
2810 p.y_ += tm.parMetrics(bot.pit()).position();
2815 bool BufferView::paragraphVisible(DocIterator const & dit) const
2817 CursorSlice const & bot = dit.bottom();
2818 TextMetrics const & tm = textMetrics(bot.text());
2820 return tm.contains(bot.pit());
2824 void BufferView::cursorPosAndHeight(Point & p, int & h) const
2826 Cursor const & cur = cursor();
2827 Font const font = cur.getFont();
2828 frontend::FontMetrics const & fm = theFontMetrics(font);
2829 int const asc = fm.maxAscent();
2830 int const des = fm.maxDescent();
2837 bool BufferView::cursorInView(Point const & p, int h) const
2839 Cursor const & cur = cursor();
2840 // does the cursor touch the screen ?
2841 if (p.y_ + h < 0 || p.y_ >= workHeight() || !paragraphVisible(cur))
2847 void BufferView::draw(frontend::Painter & pain)
2849 if (height_ == 0 || width_ == 0)
2851 LYXERR(Debug::PAINTING, "\t\t*** START DRAWING ***");
2853 Text & text = buffer_.text();
2854 TextMetrics const & tm = d->text_metrics_[&text];
2855 int const y = tm.first().second->position();
2856 PainterInfo pi(this, pain);
2858 switch (d->update_strategy_) {
2860 case NoScreenUpdate:
2861 // If no screen painting is actually needed, only some the different
2862 // coordinates of insets and paragraphs needs to be updated.
2863 pi.full_repaint = true;
2864 pi.pain.setDrawingEnabled(false);
2868 case SingleParUpdate:
2869 pi.full_repaint = false;
2870 // In general, only the current row of the outermost paragraph
2871 // will be redrawn. Particular cases where selection spans
2872 // multiple paragraph are correctly detected in TextMetrics.
2876 case DecorationUpdate:
2877 // FIXME: We should also distinguish DecorationUpdate to avoid text
2878 // drawing if possible. This is not possible to do easily right now
2879 // because of the single backing pixmap.
2881 case FullScreenUpdate:
2882 // The whole screen, including insets, will be refreshed.
2883 pi.full_repaint = true;
2885 // Clear background.
2886 pain.fillRectangle(0, 0, width_, height_,
2887 pi.backgroundColor(&buffer_.inset()));
2892 // and possibly grey out below
2893 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2894 int const y2 = lastpm.second->position() + lastpm.second->descent();
2897 Color color = buffer().isInternal()
2898 ? Color_background : Color_bottomarea;
2899 pain.fillRectangle(0, y2, width_, height_ - y2, color);
2903 LYXERR(Debug::PAINTING, "\n\t\t*** END DRAWING ***");
2905 // The scrollbar needs an update.
2908 // Normalize anchor for next time
2909 pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
2910 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2911 for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
2912 ParagraphMetrics const & pm = tm.parMetrics(pit);
2913 if (pm.position() + pm.descent() > 0) {
2914 d->anchor_pit_ = pit;
2915 d->anchor_ypos_ = pm.position();
2919 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
2920 << " anchor ypos = " << d->anchor_ypos_);
2924 void BufferView::message(docstring const & msg)
2927 d->gui_->message(msg);
2931 void BufferView::showDialog(string const & name)
2934 d->gui_->showDialog(name, string());
2938 void BufferView::showDialog(string const & name,
2939 string const & data, Inset * inset)
2942 d->gui_->showDialog(name, data, inset);
2946 void BufferView::updateDialog(string const & name, string const & data)
2949 d->gui_->updateDialog(name, data);
2953 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
2959 // FIXME: Move this out of BufferView again
2960 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
2962 if (!fname.isReadableFile()) {
2963 docstring const error = from_ascii(strerror(errno));
2964 docstring const file = makeDisplayPath(fname.absFileName(), 50);
2965 docstring const text =
2966 bformat(_("Could not read the specified document\n"
2967 "%1$s\ndue to the error: %2$s"), file, error);
2968 Alert::error(_("Could not read file"), text);
2972 if (!fname.isReadableFile()) {
2973 docstring const file = makeDisplayPath(fname.absFileName(), 50);
2974 docstring const text =
2975 bformat(_("%1$s\n is not readable."), file);
2976 Alert::error(_("Could not open file"), text);
2980 // FIXME UNICODE: We don't know the encoding of the file
2981 docstring file_content = fname.fileContents("UTF-8");
2982 if (file_content.empty()) {
2983 Alert::error(_("Reading not UTF-8 encoded file"),
2984 _("The file is not UTF-8 encoded.\n"
2985 "It will be read as local 8Bit-encoded.\n"
2986 "If this does not give the correct result\n"
2987 "then please change the encoding of the file\n"
2988 "to UTF-8 with a program other than LyX.\n"));
2989 file_content = fname.fileContents("local8bit");
2992 return normalize_c(file_content);
2996 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
2998 docstring const tmpstr = contentsOfPlaintextFile(f);
3003 Cursor & cur = cursor();
3004 cap::replaceSelection(cur);
3005 buffer_.undo().recordUndo(cur);
3007 cur.innerText()->insertStringAsParagraphs(cur, tmpstr, cur.current_font);
3009 cur.innerText()->insertStringAsLines(cur, tmpstr, cur.current_font);
3011 buffer_.changed(true);
3015 docstring const & BufferView::inlineCompletion() const
3017 return d->inlineCompletion_;
3021 size_t const & BufferView::inlineCompletionUniqueChars() const
3023 return d->inlineCompletionUniqueChars_;
3027 DocIterator const & BufferView::inlineCompletionPos() const
3029 return d->inlineCompletionPos_;
3033 void BufferView::resetInlineCompletionPos()
3035 d->inlineCompletionPos_ = DocIterator();
3039 bool samePar(DocIterator const & a, DocIterator const & b)
3041 if (a.empty() && b.empty())
3043 if (a.empty() || b.empty())
3045 if (a.depth() != b.depth())
3047 return &a.innerParagraph() == &b.innerParagraph();
3051 void BufferView::setInlineCompletion(Cursor const & cur, DocIterator const & pos,
3052 docstring const & completion, size_t uniqueChars)
3054 uniqueChars = min(completion.size(), uniqueChars);
3055 bool changed = d->inlineCompletion_ != completion
3056 || d->inlineCompletionUniqueChars_ != uniqueChars;
3057 bool singlePar = true;
3058 d->inlineCompletion_ = completion;
3059 d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
3061 //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
3064 DocIterator const & old = d->inlineCompletionPos_;
3066 //lyxerr << "inlineCompletionPos changed" << std::endl;
3067 // old or pos are in another paragraph?
3068 if ((!samePar(cur, pos) && !pos.empty())
3069 || (!samePar(cur, old) && !old.empty())) {
3071 //lyxerr << "different paragraph" << std::endl;
3073 d->inlineCompletionPos_ = pos;
3078 if (singlePar && !(cur.result().screenUpdate() & Update::Force))
3079 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
3081 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::Force);
3086 bool BufferView::clickableInset() const
3088 return d->clickable_inset_;