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"
41 #include "LyXAction.h"
45 #include "MetricsInfo.h"
46 #include "Paragraph.h"
47 #include "ParagraphParameters.h"
48 #include "ParIterator.h"
51 #include "TextClass.h"
52 #include "TextMetrics.h"
54 #include "TocBackend.h"
55 #include "WordLangTuple.h"
57 #include "insets/InsetBibtex.h"
58 #include "insets/InsetCitation.h"
59 #include "insets/InsetCommand.h" // ChangeRefs
60 #include "insets/InsetExternal.h"
61 #include "insets/InsetGraphics.h"
62 #include "insets/InsetNote.h"
63 #include "insets/InsetRef.h"
64 #include "insets/InsetText.h"
66 #include "mathed/MathData.h"
68 #include "frontends/alert.h"
69 #include "frontends/Application.h"
70 #include "frontends/Delegates.h"
71 #include "frontends/FontMetrics.h"
72 #include "frontends/Painter.h"
73 #include "frontends/Selection.h"
75 #include "support/convert.h"
76 #include "support/debug.h"
77 #include "support/ExceptionMessage.h"
78 #include "support/filetools.h"
79 #include "support/gettext.h"
80 #include "support/lassert.h"
81 #include "support/lstrings.h"
82 #include "support/Package.h"
83 #include "support/types.h"
93 using namespace lyx::support;
97 namespace Alert = frontend::Alert;
101 /// Return an inset of this class if it exists at the current cursor position
103 T * getInsetByCode(Cursor const & cur, InsetCode code)
105 DocIterator it = cur;
106 Inset * inset = it.nextInset();
107 if (inset && inset->lyxCode() == code)
108 return static_cast<T*>(inset);
113 /// Note that comparing contents can only be used for InsetCommand
114 bool findNextInset(DocIterator & dit, vector<InsetCode> const & codes,
115 docstring const & contents)
117 DocIterator tmpdit = dit;
120 Inset const * inset = tmpdit.nextInset();
122 bool const valid_code = std::find(codes.begin(), codes.end(),
123 inset->lyxCode()) != codes.end();
124 InsetCommand const * ic = inset->asInsetCommand();
125 bool const same_or_no_contents = contents.empty()
126 || (ic && (ic->getFirstNonOptParam() == contents));
128 if (valid_code && same_or_no_contents) {
133 tmpdit.forwardInset();
140 /// Looks for next inset with one of the given codes.
141 /// Note that same_content can only be used for InsetCommand
142 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
146 DocIterator tmpdit = dit;
147 tmpdit.forwardInset();
151 Inset const * inset = tmpdit.nextInset();
152 if (same_content && inset) {
153 InsetCommand const * ic = inset->asInsetCommand();
155 bool const valid_code = std::find(codes.begin(), codes.end(),
156 ic->lyxCode()) != codes.end();
158 contents = ic->getFirstNonOptParam();
162 if (!findNextInset(tmpdit, codes, contents)) {
163 if (dit.depth() != 1 || dit.pit() != 0 || dit.pos() != 0) {
164 Inset * inset = &tmpdit.bottom().inset();
165 tmpdit = doc_iterator_begin(&inset->buffer(), inset);
166 if (!findNextInset(tmpdit, codes, contents))
178 /// Looks for next inset with the given code
179 void findInset(DocIterator & dit, InsetCode code, bool same_content)
181 findInset(dit, vector<InsetCode>(1, code), same_content);
185 /// Moves cursor to the next inset with one of the given codes.
186 void gotoInset(BufferView * bv, vector<InsetCode> const & codes,
189 Cursor tmpcur = bv->cursor();
190 if (!findInset(tmpcur, codes, same_content)) {
191 bv->cursor().message(_("No more insets"));
195 tmpcur.clearSelection();
196 bv->setCursor(tmpcur);
201 /// Moves cursor to the next inset with given code.
202 void gotoInset(BufferView * bv, InsetCode code, bool same_content)
204 gotoInset(bv, vector<InsetCode>(1, code), same_content);
208 /// A map from a Text to the associated text metrics
209 typedef map<Text const *, TextMetrics> TextMetricsCache;
211 enum ScreenUpdateStrategy {
221 /////////////////////////////////////////////////////////////////////
225 /////////////////////////////////////////////////////////////////////
227 struct BufferView::Private
229 Private(BufferView & bv) : update_strategy_(NoScreenUpdate),
231 anchor_pit_(0), anchor_ypos_(0),
232 inlineCompletionUniqueChars_(0),
233 last_inset_(0), clickable_inset_(false),
234 mouse_position_cache_(),
235 bookmark_edit_position_(-1), gui_(0),
236 horiz_scroll_offset_(0)
240 ScrollbarParameters scrollbarParameters_;
242 ScreenUpdateStrategy update_strategy_;
244 CoordCache coord_cache_;
246 /// Estimated average par height for scrollbar.
248 /// this is used to handle XSelection events in the right manner.
257 pit_type anchor_pit_;
261 vector<int> par_height_;
264 DocIterator inlineCompletionPos_;
266 docstring inlineCompletion_;
268 size_t inlineCompletionUniqueChars_;
270 /// keyboard mapping object.
273 /// last visited inset.
274 /** kept to send setMouseHover(false).
275 * Not owned, so don't delete.
277 Inset const * last_inset_;
278 /// are we hovering something that we can click
279 bool clickable_inset_;
281 /// position of the mouse at the time of the last mouse move
282 /// This is used to update the hovering status of inset in
283 /// cases where the buffer is scrolled, but the mouse didn't move.
284 Point mouse_position_cache_;
286 // cache for id of the paragraph which was edited the last time
287 int bookmark_edit_position_;
289 mutable TextMetricsCache text_metrics_;
292 /** Not owned, so don't delete.
294 frontend::GuiBufferViewDelegate * gui_;
296 /// Cache for Find Next
297 FuncRequest search_request_cache_;
300 map<string, Inset *> edited_insets_;
302 /// When the row where the cursor lies is scrolled, this
303 /// contains the scroll offset
304 int horiz_scroll_offset_;
305 /// a slice pointing to the start of the row where the cursor
306 /// is (at last draw time)
307 CursorSlice current_row_slice_;
308 /// a slice pointing to the start of the row where cursor was
309 /// at previous draw event
310 CursorSlice last_row_slice_;
314 BufferView::BufferView(Buffer & buf)
315 : width_(0), height_(0), full_screen_(false), buffer_(buf),
316 d(new Private(*this))
318 d->xsel_cache_.set = false;
319 d->intl_.initKeyMapper(lyxrc.use_kbmap);
321 d->cursor_.setBuffer(&buf);
322 d->cursor_.push(buffer_.inset());
323 d->cursor_.resetAnchor();
324 d->cursor_.setCurrentFont();
326 buffer_.updatePreviews();
330 BufferView::~BufferView()
332 // current buffer is going to be switched-off, save cursor pos
333 // Ideally, the whole cursor stack should be saved, but session
334 // currently can only handle bottom (whole document) level pit and pos.
335 // That is to say, if a cursor is in a nested inset, it will be
336 // restore to the left of the top level inset.
337 LastFilePosSection::FilePos fp;
338 fp.pit = d->cursor_.bottom().pit();
339 fp.pos = d->cursor_.bottom().pos();
340 theSession().lastFilePos().save(buffer_.fileName(), fp);
343 d->last_inset_->setMouseHover(this, false);
349 int BufferView::rightMargin() const
351 // The additional test for the case the outliner is opened.
353 !lyxrc.full_screen_limit ||
354 width_ < lyxrc.full_screen_width + 20)
357 return (width_ - lyxrc.full_screen_width) / 2;
361 int BufferView::leftMargin() const
363 return rightMargin();
367 bool BufferView::isTopScreen() const
369 return d->scrollbarParameters_.position == d->scrollbarParameters_.min;
373 bool BufferView::isBottomScreen() const
375 return d->scrollbarParameters_.position == d->scrollbarParameters_.max;
379 Intl & BufferView::getIntl()
385 Intl const & BufferView::getIntl() const
391 CoordCache & BufferView::coordCache()
393 return d->coord_cache_;
397 CoordCache const & BufferView::coordCache() const
399 return d->coord_cache_;
403 Buffer & BufferView::buffer()
409 Buffer const & BufferView::buffer() const
415 bool BufferView::needsFitCursor() const
417 if (cursorStatus(d->cursor_) == CUR_INSIDE) {
418 frontend::FontMetrics const & fm =
419 theFontMetrics(d->cursor_.getFont().fontInfo());
420 int const asc = fm.maxAscent();
421 int const des = fm.maxDescent();
422 Point const p = getPos(d->cursor_);
423 if (p.y_ - asc >= 0 && p.y_ + des < height_)
430 void BufferView::processUpdateFlags(Update::flags flags)
432 // This is close to a hot-path.
433 LYXERR(Debug::DEBUG, "BufferView::processUpdateFlags()"
434 << "[fitcursor = " << (flags & Update::FitCursor)
435 << ", forceupdate = " << (flags & Update::Force)
436 << ", singlepar = " << (flags & Update::SinglePar)
437 << "] buffer: " << &buffer_);
439 // FIXME Does this really need doing here? It's done in updateBuffer, and
440 // if the Buffer doesn't need updating, then do the macros?
441 buffer_.updateMacros();
443 // Now do the first drawing step if needed. This consists on updating
444 // the CoordCache in updateMetrics().
445 // The second drawing step is done in WorkArea::redraw() if needed.
446 // FIXME: is this still true now that Buffer::changed() is used all over?
448 // Case when no explicit update is requested.
450 // no need to redraw anything.
451 d->update_strategy_ = NoScreenUpdate;
455 if (flags == Update::Decoration) {
456 d->update_strategy_ = DecorationUpdate;
457 buffer_.changed(false);
461 if (flags == Update::FitCursor
462 || flags == (Update::Decoration | Update::FitCursor)) {
463 // tell the frontend to update the screen if needed.
464 if (needsFitCursor()) {
468 if (flags & Update::Decoration) {
469 d->update_strategy_ = DecorationUpdate;
470 buffer_.changed(false);
473 // no screen update is needed in principle, but this
474 // could change if cursor row needs scrolling.
475 d->update_strategy_ = NoScreenUpdate;
476 buffer_.changed(false);
480 bool const full_metrics = flags & Update::Force || !singleParUpdate();
483 // We have to update the full screen metrics.
486 if (!(flags & Update::FitCursor)) {
487 // Nothing to do anymore. Trigger a redraw and return
488 buffer_.changed(false);
492 // updateMetrics() does not update paragraph position
493 // This is done at draw() time. So we need a redraw!
494 buffer_.changed(false);
496 if (needsFitCursor()) {
497 // The cursor is off screen so ensure it is visible.
502 updateHoveredInset();
506 void BufferView::updateScrollbar()
508 if (height_ == 0 && width_ == 0)
511 // We prefer fixed size line scrolling.
512 d->scrollbarParameters_.single_step = defaultRowHeight();
513 // We prefer full screen page scrolling.
514 d->scrollbarParameters_.page_step = height_;
516 Text & t = buffer_.text();
517 TextMetrics & tm = d->text_metrics_[&t];
519 LYXERR(Debug::GUI, " Updating scrollbar: height: "
520 << t.paragraphs().size()
521 << " curr par: " << d->cursor_.bottom().pit()
522 << " default height " << defaultRowHeight());
524 size_t const parsize = t.paragraphs().size();
525 if (d->par_height_.size() != parsize) {
526 d->par_height_.clear();
527 // FIXME: We assume a default paragraph height of 2 rows. This
528 // should probably be pondered with the screen width.
529 d->par_height_.resize(parsize, defaultRowHeight() * 2);
532 // Look at paragraph heights on-screen
533 pair<pit_type, ParagraphMetrics const *> first = tm.first();
534 pair<pit_type, ParagraphMetrics const *> last = tm.last();
535 for (pit_type pit = first.first; pit <= last.first; ++pit) {
536 d->par_height_[pit] = tm.parMetrics(pit).height();
537 LYXERR(Debug::SCROLLING, "storing height for pit " << pit << " : "
538 << d->par_height_[pit]);
541 int top_pos = first.second->position() - first.second->ascent();
542 int bottom_pos = last.second->position() + last.second->descent();
543 bool first_visible = first.first == 0 && top_pos >= 0;
544 bool last_visible = last.first + 1 == int(parsize) && bottom_pos <= height_;
545 if (first_visible && last_visible) {
546 d->scrollbarParameters_.min = 0;
547 d->scrollbarParameters_.max = 0;
551 d->scrollbarParameters_.min = top_pos;
552 for (size_t i = 0; i != size_t(first.first); ++i)
553 d->scrollbarParameters_.min -= d->par_height_[i];
554 d->scrollbarParameters_.max = bottom_pos;
555 for (size_t i = last.first + 1; i != parsize; ++i)
556 d->scrollbarParameters_.max += d->par_height_[i];
558 d->scrollbarParameters_.position = 0;
559 // The reference is the top position so we remove one page.
560 if (lyxrc.scroll_below_document)
561 d->scrollbarParameters_.max -= minVisiblePart();
563 d->scrollbarParameters_.max -= d->scrollbarParameters_.page_step;
567 ScrollbarParameters const & BufferView::scrollbarParameters() const
569 return d->scrollbarParameters_;
573 docstring BufferView::toolTip(int x, int y) const
575 // Get inset under mouse, if there is one.
576 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
578 // No inset, no tooltip...
580 return covering_inset->toolTip(*this, x, y);
584 string BufferView::contextMenu(int x, int y) const
586 //If there is a selection, return the containing inset menu
587 if (d->cursor_.selection())
588 return d->cursor_.inset().contextMenu(*this, x, y);
590 // Get inset under mouse, if there is one.
591 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
593 return covering_inset->contextMenu(*this, x, y);
595 return buffer_.inset().contextMenu(*this, x, y);
599 void BufferView::scrollDocView(int value, bool update)
601 int const offset = value - d->scrollbarParameters_.position;
603 // No scrolling at all? No need to redraw anything
607 // If the offset is less than 2 screen height, prefer to scroll instead.
608 if (abs(offset) <= 2 * height_) {
609 d->anchor_ypos_ -= offset;
610 buffer_.changed(true);
611 updateHoveredInset();
615 // cut off at the top
616 if (value <= d->scrollbarParameters_.min) {
617 DocIterator dit = doc_iterator_begin(&buffer_);
618 showCursor(dit, false, update);
619 LYXERR(Debug::SCROLLING, "scroll to top");
623 // cut off at the bottom
624 if (value >= d->scrollbarParameters_.max) {
625 DocIterator dit = doc_iterator_end(&buffer_);
627 showCursor(dit, false, update);
628 LYXERR(Debug::SCROLLING, "scroll to bottom");
632 // find paragraph at target position
633 int par_pos = d->scrollbarParameters_.min;
635 for (; i != int(d->par_height_.size()); ++i) {
636 par_pos += d->par_height_[i];
637 if (par_pos >= value)
641 if (par_pos < value) {
642 // It seems we didn't find the correct pit so stay on the safe side and
644 LYXERR0("scrolling position not found!");
645 scrollDocView(d->scrollbarParameters_.max, update);
649 DocIterator dit = doc_iterator_begin(&buffer_);
651 LYXERR(Debug::SCROLLING, "value = " << value << " -> scroll to pit " << i);
652 showCursor(dit, false, update);
656 // FIXME: this method is not working well.
657 void BufferView::setCursorFromScrollbar()
659 TextMetrics & tm = d->text_metrics_[&buffer_.text()];
661 int const height = 2 * defaultRowHeight();
662 int const first = height;
663 int const last = height_ - height;
665 Cursor const & oldcur = d->cursor_;
667 switch (cursorStatus(oldcur)) {
675 int const y = getPos(oldcur).y_;
676 newy = min(last, max(y, first));
680 // We reset the cursor because cursorStatus() does not
681 // work when the cursor is within mathed.
684 tm.setCursorFromCoordinates(cur, 0, newy);
686 // update the bufferview cursor and notify insets
687 // FIXME: Care about the d->cursor_ flags to redraw if needed
688 Cursor old = d->cursor_;
690 // the DEPM call in mouseSetCursor() might have destroyed the
691 // paragraph the cursor is in.
692 bool badcursor = old.fixIfBroken();
693 badcursor |= notifyCursorLeavesOrEnters(old, d->cursor_);
695 d->cursor_.fixIfBroken();
699 Change const BufferView::getCurrentChange() const
701 if (!d->cursor_.selection())
702 return Change(Change::UNCHANGED);
704 DocIterator dit = d->cursor_.selectionBegin();
705 // The selected content might have been changed (see #7685)
706 while (dit.inMathed())
707 // Find enclosing text cursor
709 return dit.paragraph().lookupChange(dit.pos());
713 // this could be used elsewhere as well?
714 // FIXME: This does not work within mathed!
715 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
717 Point const p = getPos(dit);
720 if (p.y_ > workHeight())
726 void BufferView::bookmarkEditPosition()
728 // Don't eat cpu time for each keystroke
729 if (d->cursor_.paragraph().id() == d->bookmark_edit_position_)
732 d->bookmark_edit_position_ = d->cursor_.paragraph().id();
736 void BufferView::saveBookmark(unsigned int idx)
738 // tentatively save bookmark, id and pos will be used to
739 // acturately locate a bookmark in a 'live' lyx session.
740 // pit and pos will be updated with bottom level pit/pos
742 if (!buffer_.isInternal()) {
743 theSession().bookmarks().save(
745 d->cursor_.bottom().pit(),
746 d->cursor_.bottom().pos(),
747 d->cursor_.paragraph().id(),
752 // emit message signal.
753 message(_("Save bookmark"));
758 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
759 int top_id, pos_type top_pos)
761 bool success = false;
764 d->cursor_.clearSelection();
766 // if a valid par_id is given, try it first
767 // This is the case for a 'live' bookmark when unique paragraph ID
768 // is used to track bookmarks.
770 dit = buffer_.getParFromID(top_id);
772 dit.pos() = min(dit.paragraph().size(), top_pos);
773 // Some slices of the iterator may not be
774 // reachable (e.g. closed collapsable inset)
775 // so the dociterator may need to be
776 // shortened. Otherwise, setCursor may crash
777 // lyx when the cursor can not be set to these
779 size_t const n = dit.depth();
780 for (size_t i = 0; i < n; ++i)
781 if (!dit[i].inset().editable()) {
789 // if top_id == 0, or searching through top_id failed
790 // This is the case for a 'restored' bookmark when only bottom
791 // (document level) pit was saved. Because of this, bookmark
792 // restoration is inaccurate. If a bookmark was within an inset,
793 // it will be restored to the left of the outmost inset that contains
795 if (bottom_pit < int(buffer_.paragraphs().size())) {
796 dit = doc_iterator_begin(&buffer_);
798 dit.pit() = bottom_pit;
799 dit.pos() = min(bottom_pos, dit.paragraph().size());
804 // Note: only bottom (document) level pit is set.
806 // set the current font.
807 d->cursor_.setCurrentFont();
808 // To center the screen on this new position we need the
809 // paragraph position which is computed at draw() time.
810 // So we need a redraw!
811 buffer_.changed(false);
812 if (needsFitCursor())
820 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
822 if (d->cursor_.real_current_font.isRightToLeft()) {
823 if (d->intl_.keymap == Intl::PRIMARY)
824 d->intl_.keyMapSec();
826 if (d->intl_.keymap == Intl::SECONDARY)
827 d->intl_.keyMapPrim();
830 d->intl_.getTransManager().translateAndInsert(c, t, cur);
834 int BufferView::workWidth() const
840 void BufferView::recenter()
842 showCursor(d->cursor_, true, true);
846 void BufferView::showCursor()
848 showCursor(d->cursor_, false, true);
852 void BufferView::showCursor(DocIterator const & dit,
853 bool recenter, bool update)
855 if (scrollToCursor(dit, recenter) && update) {
856 buffer_.changed(true);
857 updateHoveredInset();
862 void BufferView::scrollToCursor()
864 if (scrollToCursor(d->cursor_, false)) {
865 buffer_.changed(true);
866 updateHoveredInset();
871 bool BufferView::scrollToCursor(DocIterator const & dit, bool recenter)
873 // We are not properly started yet, delay until resizing is
878 LYXERR(Debug::SCROLLING, "recentering!");
880 CursorSlice const & bot = dit.bottom();
881 TextMetrics & tm = d->text_metrics_[bot.text()];
883 pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
884 int bot_pit = bot.pit();
885 if (bot_pit > max_pit) {
886 // FIXME: Why does this happen?
887 LYXERR0("bottom pit is greater that max pit: "
888 << bot_pit << " > " << max_pit);
892 if (bot_pit == tm.first().first - 1)
893 tm.newParMetricsUp();
894 else if (bot_pit == tm.last().first + 1)
895 tm.newParMetricsDown();
897 if (tm.contains(bot_pit)) {
898 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
899 LBUFERR(!pm.rows().empty());
900 // FIXME: smooth scrolling doesn't work in mathed.
901 CursorSlice const & cs = dit.innerTextSlice();
902 int offset = coordOffset(dit).y_;
903 int ypos = pm.position() + offset;
904 Dimension const & row_dim =
905 pm.getRow(cs.pos(), dit.boundary()).dimension();
908 scrolled = scroll(ypos - height_/2);
910 // We try to visualize the whole row, if the row height is larger than
911 // the screen height, we scroll to a heuristic value of height_ / 4.
912 // FIXME: This heuristic value should be replaced by a recursive search
913 // for a row in the inset that can be visualized completely.
914 else if (row_dim.height() > height_) {
915 if (ypos < defaultRowHeight())
916 scrolled = scroll(ypos - height_ / 4);
917 else if (ypos > height_ - defaultRowHeight())
918 scrolled = scroll(ypos - 3 * height_ / 4);
921 // If the top part of the row falls of the screen, we scroll
922 // up to align the top of the row with the top of the screen.
923 else if (ypos - row_dim.ascent() < 0 && ypos < height_) {
924 int ynew = row_dim.ascent();
925 scrolled = scrollUp(ynew - ypos);
928 // If the bottom of the row falls of the screen, we scroll down.
929 else if (ypos + row_dim.descent() > height_ && ypos > 0) {
930 int ynew = height_ - row_dim.descent();
931 scrolled = scrollDown(ypos - ynew);
934 // else, nothing to do, the cursor is already visible so we just return.
935 return scrolled != 0;
938 // fix inline completion position
939 if (d->inlineCompletionPos_.fixIfBroken())
940 d->inlineCompletionPos_ = DocIterator();
942 tm.redoParagraph(bot_pit);
943 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
944 int offset = coordOffset(dit).y_;
946 d->anchor_pit_ = bot_pit;
947 CursorSlice const & cs = dit.innerTextSlice();
948 Dimension const & row_dim =
949 pm.getRow(cs.pos(), dit.boundary()).dimension();
952 d->anchor_ypos_ = height_/2;
953 else if (d->anchor_pit_ == 0)
954 d->anchor_ypos_ = offset + pm.ascent();
955 else if (d->anchor_pit_ == max_pit)
956 d->anchor_ypos_ = height_ - offset - row_dim.descent();
957 else if (offset > height_)
958 d->anchor_ypos_ = height_ - offset - defaultRowHeight();
960 d->anchor_ypos_ = defaultRowHeight() * 2;
966 void BufferView::makeDocumentClass()
968 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
969 buffer_.params().makeDocumentClass();
970 updateDocumentClass(olddc);
974 void BufferView::updateDocumentClass(DocumentClassConstPtr olddc)
976 message(_("Converting document to new document class..."));
978 StableDocIterator backcur(d->cursor_);
979 ErrorList & el = buffer_.errorList("Class Switch");
980 cap::switchBetweenClasses(
981 olddc, buffer_.params().documentClassPtr(),
982 static_cast<InsetText &>(buffer_.inset()), el);
984 setCursor(backcur.asDocIterator(&buffer_));
986 buffer_.errors("Class Switch");
990 /** Return the change status at cursor position, taking into account the
991 * status at each level of the document iterator (a table in a deleted
992 * footnote is deleted).
993 * When \param outer is true, the top slice is not looked at.
995 static Change::Type lookupChangeType(DocIterator const & dit, bool outer = false)
997 size_t const depth = dit.depth() - (outer ? 1 : 0);
999 for (size_t i = 0 ; i < depth ; ++i) {
1000 CursorSlice const & slice = dit[i];
1001 if (!slice.inset().inMathed()
1002 && slice.pos() < slice.paragraph().size()) {
1003 Change::Type const ch = slice.paragraph().lookupChange(slice.pos()).type;
1004 if (ch != Change::UNCHANGED)
1008 return Change::UNCHANGED;
1012 bool BufferView::getStatus(FuncRequest const & cmd, FuncStatus & flag)
1014 FuncCode const act = cmd.action();
1016 // Can we use a readonly buffer?
1017 if (buffer_.isReadonly()
1018 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1019 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1020 flag.message(from_utf8(N_("Document is read-only")));
1021 flag.setEnabled(false);
1025 // Are we in a DELETED change-tracking region?
1026 if (lookupChangeType(d->cursor_, true) == Change::DELETED
1027 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1028 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1029 flag.message(from_utf8(N_("This portion of the document is deleted.")));
1030 flag.setEnabled(false);
1034 Cursor & cur = d->cursor_;
1036 if (cur.getStatus(cmd, flag))
1041 // FIXME: This is a bit problematic because we don't check if this is
1042 // a document BufferView or not for these LFUNs. We probably have to
1043 // dispatch both to currentBufferView() and, if that fails,
1044 // to documentBufferView(); same as we do now for current Buffer and
1045 // document Buffer. Ideally those LFUN should go to Buffer as they
1046 // operate on the full Buffer and the cursor is only needed either for
1047 // an Undo record or to restore a cursor position. But we don't know
1048 // how to do that inside Buffer of course.
1049 case LFUN_BUFFER_PARAMS_APPLY:
1050 case LFUN_LAYOUT_MODULES_CLEAR:
1051 case LFUN_LAYOUT_MODULE_ADD:
1052 case LFUN_LAYOUT_RELOAD:
1053 case LFUN_TEXTCLASS_APPLY:
1054 case LFUN_TEXTCLASS_LOAD:
1055 flag.setEnabled(!buffer_.isReadonly());
1059 // We do not use the LyXAction flag for readonly because Undo sets the
1060 // buffer clean/dirty status by itself.
1061 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasUndoStack());
1064 // We do not use the LyXAction flag for readonly because Redo sets the
1065 // buffer clean/dirty status by itself.
1066 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasRedoStack());
1068 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
1069 case LFUN_FILE_INSERT_PLAINTEXT: {
1070 docstring const fname = cmd.argument();
1071 if (!FileName::isAbsolute(to_utf8(fname))) {
1072 flag.message(_("Absolute filename expected."));
1075 flag.setEnabled(cur.inTexted());
1078 case LFUN_FILE_INSERT:
1079 case LFUN_BOOKMARK_SAVE:
1080 // FIXME: Actually, these LFUNS should be moved to Text
1081 flag.setEnabled(cur.inTexted());
1084 case LFUN_FONT_STATE:
1085 case LFUN_LABEL_INSERT:
1086 case LFUN_INFO_INSERT:
1087 case LFUN_PARAGRAPH_GOTO:
1088 case LFUN_NOTE_NEXT:
1089 case LFUN_REFERENCE_NEXT:
1090 case LFUN_WORD_FIND:
1091 case LFUN_WORD_FIND_FORWARD:
1092 case LFUN_WORD_FIND_BACKWARD:
1093 case LFUN_WORD_REPLACE:
1096 case LFUN_MARK_TOGGLE:
1097 case LFUN_SCREEN_RECENTER:
1098 case LFUN_SCREEN_SHOW_CURSOR:
1099 case LFUN_BIBTEX_DATABASE_ADD:
1100 case LFUN_BIBTEX_DATABASE_DEL:
1101 case LFUN_STATISTICS:
1102 case LFUN_KEYMAP_OFF:
1103 case LFUN_KEYMAP_PRIMARY:
1104 case LFUN_KEYMAP_SECONDARY:
1105 case LFUN_KEYMAP_TOGGLE:
1106 case LFUN_INSET_SELECT_ALL:
1107 flag.setEnabled(true);
1110 case LFUN_WORD_FINDADV: {
1111 FindAndReplaceOptions opt;
1112 istringstream iss(to_utf8(cmd.argument()));
1114 flag.setEnabled(opt.repl_buf_name.empty()
1115 || !buffer_.isReadonly());
1119 case LFUN_LABEL_GOTO:
1120 flag.setEnabled(!cmd.argument().empty()
1121 || getInsetByCode<InsetRef>(cur, REF_CODE));
1124 case LFUN_CHANGES_TRACK:
1125 flag.setEnabled(true);
1126 flag.setOnOff(buffer_.params().track_changes);
1129 case LFUN_CHANGES_OUTPUT:
1130 flag.setEnabled(true);
1131 flag.setOnOff(buffer_.params().output_changes);
1134 case LFUN_CHANGES_MERGE:
1135 case LFUN_CHANGE_NEXT:
1136 case LFUN_CHANGE_PREVIOUS:
1137 case LFUN_ALL_CHANGES_ACCEPT:
1138 case LFUN_ALL_CHANGES_REJECT:
1139 // TODO: context-sensitive enabling of LFUNs
1140 // In principle, these command should only be enabled if there
1141 // is a change in the document. However, without proper
1142 // optimizations, this will inevitably result in poor performance.
1143 flag.setEnabled(true);
1146 case LFUN_BUFFER_TOGGLE_COMPRESSION: {
1147 flag.setOnOff(buffer_.params().compressed);
1151 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC: {
1152 flag.setOnOff(buffer_.params().output_sync);
1156 case LFUN_SCREEN_UP:
1157 case LFUN_SCREEN_DOWN:
1159 case LFUN_SCREEN_UP_SELECT:
1160 case LFUN_SCREEN_DOWN_SELECT:
1161 case LFUN_INSET_FORALL:
1162 flag.setEnabled(true);
1165 case LFUN_LAYOUT_TABULAR:
1166 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
1170 flag.setEnabled(!cur.inset().forcePlainLayout(cur.idx()));
1173 case LFUN_LAYOUT_PARAGRAPH:
1174 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
1177 case LFUN_BRANCH_ADD_INSERT:
1178 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1181 case LFUN_DIALOG_SHOW_NEW_INSET:
1182 // FIXME: this is wrong, but I do not understand the
1184 if (cur.inset().lyxCode() == CAPTION_CODE)
1185 return cur.inset().getStatus(cur, cmd, flag);
1186 // FIXME we should consider passthru paragraphs too.
1187 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1190 case LFUN_CITATION_INSERT: {
1191 FuncRequest fr(LFUN_INSET_INSERT, "citation");
1192 // FIXME: This could turn in a recursive hell.
1193 // Shouldn't we use Buffer::getStatus() instead?
1194 flag.setEnabled(lyx::getStatus(fr).enabled());
1197 case LFUN_INSET_APPLY: {
1198 string const name = cmd.getArg(0);
1199 Inset * inset = editedInset(name);
1201 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1202 if (!inset->getStatus(cur, fr, flag)) {
1203 // Every inset is supposed to handle this
1204 LASSERT(false, break);
1207 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1208 flag = lyx::getStatus(fr);
1221 Inset * BufferView::editedInset(string const & name) const
1223 map<string, Inset *>::const_iterator it = d->edited_insets_.find(name);
1224 return it == d->edited_insets_.end() ? 0 : it->second;
1228 void BufferView::editInset(string const & name, Inset * inset)
1230 d->edited_insets_[name] = inset;
1234 void BufferView::dispatch(FuncRequest const & cmd, DispatchResult & dr)
1236 LYXERR(Debug::ACTION, "BufferView::dispatch: cmd: " << cmd);
1238 string const argument = to_utf8(cmd.argument());
1239 Cursor & cur = d->cursor_;
1242 // Don't dispatch function that does not apply to internal buffers.
1243 if (buffer_.isInternal()
1244 && lyxaction.funcHasFlag(cmd.action(), LyXAction::NoInternal))
1247 // We'll set this back to false if need be.
1248 bool dispatched = true;
1249 buffer_.undo().beginUndoGroup();
1251 FuncCode const act = cmd.action();
1254 case LFUN_BUFFER_PARAMS_APPLY: {
1255 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1256 cur.recordUndoBufferParams();
1257 istringstream ss(to_utf8(cmd.argument()));
1260 int const unknown_tokens = buffer_.readHeader(lex);
1261 if (unknown_tokens != 0) {
1262 LYXERR0("Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1263 << unknown_tokens << " unknown token"
1264 << (unknown_tokens == 1 ? "" : "s"));
1266 updateDocumentClass(olddc);
1268 // We are most certainly here because of a change in the document
1269 // It is then better to make sure that all dialogs are in sync with
1270 // current document settings.
1271 dr.screenUpdate(Update::Force | Update::FitCursor);
1272 dr.forceBufferUpdate();
1276 case LFUN_LAYOUT_MODULES_CLEAR: {
1277 // FIXME: this modifies the document in cap::switchBetweenClasses
1278 // without calling recordUndo. Fix this before using
1279 // recordUndoBufferParams().
1280 cur.recordUndoFullBuffer();
1281 buffer_.params().clearLayoutModules();
1282 makeDocumentClass();
1283 dr.screenUpdate(Update::Force);
1284 dr.forceBufferUpdate();
1288 case LFUN_LAYOUT_MODULE_ADD: {
1289 BufferParams const & params = buffer_.params();
1290 if (!params.layoutModuleCanBeAdded(argument)) {
1291 LYXERR0("Module `" << argument <<
1292 "' cannot be added due to failed requirements or "
1293 "conflicts with installed modules.");
1296 // FIXME: this modifies the document in cap::switchBetweenClasses
1297 // without calling recordUndo. Fix this before using
1298 // recordUndoBufferParams().
1299 cur.recordUndoFullBuffer();
1300 buffer_.params().addLayoutModule(argument);
1301 makeDocumentClass();
1302 dr.screenUpdate(Update::Force);
1303 dr.forceBufferUpdate();
1307 case LFUN_TEXTCLASS_APPLY: {
1308 // since this shortcircuits, the second call is made only if
1310 bool const success =
1311 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1312 LayoutFileList::get().load(argument, buffer_.filePath());
1314 docstring s = bformat(_("The document class `%1$s' "
1315 "could not be loaded."), from_utf8(argument));
1316 frontend::Alert::error(_("Could not load class"), s);
1320 LayoutFile const * old_layout = buffer_.params().baseClass();
1321 LayoutFile const * new_layout = &(LayoutFileList::get()[argument]);
1323 if (old_layout == new_layout)
1327 // Save the old, possibly modular, layout for use in conversion.
1328 // FIXME: this modifies the document in cap::switchBetweenClasses
1329 // without calling recordUndo. Fix this before using
1330 // recordUndoBufferParams().
1331 cur.recordUndoFullBuffer();
1332 buffer_.params().setBaseClass(argument);
1333 makeDocumentClass();
1334 dr.screenUpdate(Update::Force);
1335 dr.forceBufferUpdate();
1339 case LFUN_TEXTCLASS_LOAD: {
1340 // since this shortcircuits, the second call is made only if
1342 bool const success =
1343 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1344 LayoutFileList::get().load(argument, buffer_.filePath());
1346 docstring s = bformat(_("The document class `%1$s' "
1347 "could not be loaded."), from_utf8(argument));
1348 frontend::Alert::error(_("Could not load class"), s);
1353 case LFUN_LAYOUT_RELOAD: {
1354 LayoutFileIndex bc = buffer_.params().baseClassID();
1355 LayoutFileList::get().reset(bc);
1356 buffer_.params().setBaseClass(bc);
1357 makeDocumentClass();
1358 dr.screenUpdate(Update::Force);
1359 dr.forceBufferUpdate();
1364 dr.setMessage(_("Undo"));
1365 cur.clearSelection();
1366 if (!cur.textUndo())
1367 dr.setMessage(_("No further undo information"));
1369 dr.screenUpdate(Update::Force | Update::FitCursor);
1370 dr.forceBufferUpdate();
1374 dr.setMessage(_("Redo"));
1375 cur.clearSelection();
1376 if (!cur.textRedo())
1377 dr.setMessage(_("No further redo information"));
1379 dr.screenUpdate(Update::Force | Update::FitCursor);
1380 dr.forceBufferUpdate();
1383 case LFUN_FONT_STATE:
1384 dr.setMessage(cur.currentState());
1387 case LFUN_BOOKMARK_SAVE:
1388 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1391 case LFUN_LABEL_GOTO: {
1392 docstring label = cmd.argument();
1393 if (label.empty()) {
1395 getInsetByCode<InsetRef>(cur, REF_CODE);
1397 label = inset->getParam("reference");
1398 // persistent=false: use temp_bookmark
1402 if (!label.empty()) {
1404 // at the moment, this is redundant, since gotoLabel will
1405 // eventually call LFUN_PARAGRAPH_GOTO, but it seems best
1407 dr.screenUpdate(Update::Force | Update::FitCursor);
1412 case LFUN_PARAGRAPH_GOTO: {
1413 int const id = convert<int>(cmd.getArg(0));
1414 int const pos = convert<int>(cmd.getArg(1));
1416 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1417 b = theBufferList().next(b)) {
1420 cur.setCursor(b->getParFromID(id));
1422 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1426 LYXERR(Debug::INFO, "Paragraph " << cur.paragraph().id()
1427 << " found in buffer `"
1428 << b->absFileName() << "'.");
1430 if (b == &buffer_) {
1433 mouseSetCursor(cur);
1434 dr.screenUpdate(Update::Force | Update::FitCursor);
1436 // Switch to other buffer view and resend cmd
1437 lyx::dispatch(FuncRequest(
1438 LFUN_BUFFER_SWITCH, b->absFileName()));
1446 case LFUN_NOTE_NEXT:
1447 gotoInset(this, NOTE_CODE, false);
1450 case LFUN_REFERENCE_NEXT: {
1451 vector<InsetCode> tmp;
1452 tmp.push_back(LABEL_CODE);
1453 tmp.push_back(REF_CODE);
1454 gotoInset(this, tmp, true);
1458 case LFUN_CHANGES_TRACK:
1459 buffer_.params().track_changes = !buffer_.params().track_changes;
1462 case LFUN_CHANGES_OUTPUT:
1463 buffer_.params().output_changes = !buffer_.params().output_changes;
1464 if (buffer_.params().output_changes) {
1465 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1466 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1467 LaTeXFeatures::isAvailable("xcolor");
1469 if (!dvipost && !xcolorulem) {
1470 Alert::warning(_("Changes not shown in LaTeX output"),
1471 _("Changes will not be highlighted in LaTeX output, "
1472 "because neither dvipost nor xcolor/ulem are installed.\n"
1473 "Please install these packages or redefine "
1474 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1475 } else if (!xcolorulem) {
1476 Alert::warning(_("Changes not shown in LaTeX output"),
1477 _("Changes will not be highlighted in LaTeX output "
1478 "when using pdflatex, because xcolor and ulem are not installed.\n"
1479 "Please install both packages or redefine "
1480 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1485 case LFUN_CHANGE_NEXT:
1486 findNextChange(this);
1487 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1488 dr.screenUpdate(Update::Force | Update::FitCursor);
1491 case LFUN_CHANGE_PREVIOUS:
1492 findPreviousChange(this);
1493 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1494 dr.screenUpdate(Update::Force | Update::FitCursor);
1497 case LFUN_CHANGES_MERGE:
1498 if (findNextChange(this) || findPreviousChange(this)) {
1499 dr.screenUpdate(Update::Force | Update::FitCursor);
1500 dr.forceBufferUpdate();
1501 showDialog("changes");
1505 case LFUN_ALL_CHANGES_ACCEPT:
1506 // select complete document
1508 cur.selHandle(true);
1509 buffer_.text().cursorBottom(cur);
1510 // accept everything in a single step to support atomic undo
1511 buffer_.text().acceptOrRejectChanges(cur, Text::ACCEPT);
1513 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1514 dr.screenUpdate(Update::Force | Update::FitCursor);
1515 dr.forceBufferUpdate();
1518 case LFUN_ALL_CHANGES_REJECT:
1519 // select complete document
1521 cur.selHandle(true);
1522 buffer_.text().cursorBottom(cur);
1523 // reject everything in a single step to support atomic undo
1524 // Note: reject does not work recursively; the user may have to repeat the operation
1525 buffer_.text().acceptOrRejectChanges(cur, Text::REJECT);
1527 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1528 dr.screenUpdate(Update::Force | Update::FitCursor);
1529 dr.forceBufferUpdate();
1532 case LFUN_WORD_FIND_FORWARD:
1533 case LFUN_WORD_FIND_BACKWARD: {
1535 // Would it maybe be better if this variable were view specific anyway?
1536 static docstring last_search;
1537 docstring searched_string;
1539 if (!cmd.argument().empty()) {
1540 last_search = cmd.argument();
1541 searched_string = cmd.argument();
1543 searched_string = last_search;
1546 if (searched_string.empty())
1549 bool const fw = act == LFUN_WORD_FIND_FORWARD;
1550 docstring const data =
1551 find2string(searched_string, true, false, fw);
1552 bool found = lyxfind(this, FuncRequest(LFUN_WORD_FIND, data));
1554 dr.screenUpdate(Update::Force | Update::FitCursor);
1564 case LFUN_WORD_FIND: {
1565 FuncRequest req = cmd;
1566 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1567 req = d->search_request_cache_;
1568 if (req.argument().empty()) {
1569 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, "findreplace"));
1572 if (lyxfind(this, req)) {
1573 dr.screenUpdate(Update::Force | Update::FitCursor);
1580 d->search_request_cache_ = req;
1584 case LFUN_WORD_REPLACE: {
1585 bool has_deleted = false;
1586 if (cur.selection()) {
1587 DocIterator beg = cur.selectionBegin();
1588 DocIterator end = cur.selectionEnd();
1589 if (beg.pit() == end.pit()) {
1590 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1591 if (!cur.inMathed() && cur.paragraph().isDeleted(p)) {
1598 if (lyxreplace(this, cmd, has_deleted)) {
1599 dr.forceBufferUpdate();
1600 dr.screenUpdate(Update::Force | Update::FitCursor);
1610 case LFUN_WORD_FINDADV: {
1611 FindAndReplaceOptions opt;
1612 istringstream iss(to_utf8(cmd.argument()));
1614 if (findAdv(this, opt)) {
1615 dr.screenUpdate(Update::Force | Update::FitCursor);
1626 cur.clearSelection();
1627 dr.setMessage(from_utf8(N_("Mark off")));
1631 cur.clearSelection();
1633 dr.setMessage(from_utf8(N_("Mark on")));
1636 case LFUN_MARK_TOGGLE:
1637 cur.setSelection(false);
1640 dr.setMessage(from_utf8(N_("Mark removed")));
1643 dr.setMessage(from_utf8(N_("Mark set")));
1648 case LFUN_SCREEN_SHOW_CURSOR:
1652 case LFUN_SCREEN_RECENTER:
1656 case LFUN_BIBTEX_DATABASE_ADD: {
1657 Cursor tmpcur = cur;
1658 findInset(tmpcur, BIBTEX_CODE, false);
1659 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1662 if (inset->addDatabase(cmd.argument())) {
1663 buffer_.invalidateBibfileCache();
1664 dr.forceBufferUpdate();
1670 case LFUN_BIBTEX_DATABASE_DEL: {
1671 Cursor tmpcur = cur;
1672 findInset(tmpcur, BIBTEX_CODE, false);
1673 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1676 if (inset->delDatabase(cmd.argument())) {
1677 buffer_.invalidateBibfileCache();
1678 dr.forceBufferUpdate();
1684 case LFUN_STATISTICS: {
1685 DocIterator from, to;
1686 if (cur.selection()) {
1687 from = cur.selectionBegin();
1688 to = cur.selectionEnd();
1690 from = doc_iterator_begin(&buffer_);
1691 to = doc_iterator_end(&buffer_);
1693 buffer_.updateStatistics(from, to);
1694 int const words = buffer_.wordCount();
1695 int const chars = buffer_.charCount(false);
1696 int const chars_blanks = buffer_.charCount(true);
1698 if (cur.selection())
1699 message = _("Statistics for the selection:");
1701 message = _("Statistics for the document:");
1704 message += bformat(_("%1$d words"), words);
1706 message += _("One word");
1708 if (chars_blanks != 1)
1709 message += bformat(_("%1$d characters (including blanks)"),
1712 message += _("One character (including blanks)");
1715 message += bformat(_("%1$d characters (excluding blanks)"),
1718 message += _("One character (excluding blanks)");
1720 Alert::information(_("Statistics"), message);
1724 case LFUN_BUFFER_TOGGLE_COMPRESSION:
1725 // turn compression on/off
1726 buffer_.params().compressed = !buffer_.params().compressed;
1729 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
1730 buffer_.params().output_sync = !buffer_.params().output_sync;
1733 case LFUN_SCREEN_UP:
1734 case LFUN_SCREEN_DOWN: {
1735 Point p = getPos(cur);
1736 // This code has been commented out to enable to scroll down a
1737 // document, even if there are large insets in it (see bug #5465).
1738 /*if (p.y_ < 0 || p.y_ > height_) {
1739 // The cursor is off-screen so recenter before proceeding.
1743 int const scrolled = scroll(act == LFUN_SCREEN_UP
1744 ? -height_ : height_);
1745 if (act == LFUN_SCREEN_UP && scrolled > -height_)
1747 if (act == LFUN_SCREEN_DOWN && scrolled < height_)
1748 p = Point(width_, height_);
1749 bool const in_texted = cur.inTexted();
1750 cur.setCursor(doc_iterator_begin(cur.buffer()));
1751 cur.selHandle(false);
1752 buffer_.changed(true);
1753 updateHoveredInset();
1755 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_,
1756 true, act == LFUN_SCREEN_UP);
1757 //FIXME: what to do with cur.x_target()?
1758 bool update = in_texted && cur.bv().checkDepm(cur, old);
1761 if (update || cur.mark())
1762 dr.screenUpdate(Update::Force | Update::FitCursor);
1764 dr.forceBufferUpdate();
1769 string const scroll_type = cmd.getArg(0);
1770 int scroll_step = 0;
1771 if (scroll_type == "line")
1772 scroll_step = d->scrollbarParameters_.single_step;
1773 else if (scroll_type == "page")
1774 scroll_step = d->scrollbarParameters_.page_step;
1777 string const scroll_quantity = cmd.getArg(1);
1778 if (scroll_quantity == "up")
1779 scrollUp(scroll_step);
1780 else if (scroll_quantity == "down")
1781 scrollDown(scroll_step);
1783 int const scroll_value = convert<int>(scroll_quantity);
1785 scroll(scroll_step * scroll_value);
1787 buffer_.changed(true);
1788 updateHoveredInset();
1789 dr.forceBufferUpdate();
1793 case LFUN_SCREEN_UP_SELECT: {
1794 // FIXME: why is the algorithm different from LFUN_SCREEN_UP?
1795 cur.selHandle(true);
1796 if (isTopScreen()) {
1797 lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1801 int y = getPos(cur).y_;
1802 int const ymin = y - height_ + defaultRowHeight();
1803 while (y > ymin && cur.up())
1807 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1811 case LFUN_SCREEN_DOWN_SELECT: {
1812 // FIXME: why is the algorithm different from LFUN_SCREEN_DOWN?
1813 cur.selHandle(true);
1814 if (isBottomScreen()) {
1815 lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1819 int y = getPos(cur).y_;
1820 int const ymax = y + height_ - defaultRowHeight();
1821 while (y < ymax && cur.down())
1825 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1830 case LFUN_INSET_SELECT_ALL:
1832 && cur.selBegin().at_begin()
1833 && cur.selEnd().at_end()) {
1834 // All the contents of the inset if selected.
1835 // Select the inset from outside.
1838 cur.setSelection(true);
1840 } else if (cur.selBegin().idx() != cur.selEnd().idx()
1842 && cur.selBegin().at_cell_begin()
1843 && cur.selEnd().at_cell_end())) {
1844 // At least one complete cell is selected.
1849 cur.setSelection(true);
1850 cur.idx() = cur.lastidx();
1851 cur.pos() = cur.lastpos();
1853 // select current cell
1857 cur.setSelection(true);
1858 cur.pit() = cur.lastpit();
1859 cur.pos() = cur.lastpos();
1861 dr.screenUpdate(Update::Force);
1865 // This would be in Buffer class if only Cursor did not
1866 // require a bufferview
1867 case LFUN_INSET_FORALL: {
1868 docstring const name = from_utf8(cmd.getArg(0));
1869 string const commandstr = cmd.getLongArg(1);
1870 FuncRequest const fr = lyxaction.lookupFunc(commandstr);
1872 // an arbitrary number to limit number of iterations
1873 const int max_iter = 100000;
1875 Cursor & cur = d->cursor_;
1876 Cursor const savecur = cur;
1878 if (!cur.nextInset())
1880 cur.beginUndoGroup();
1881 while(cur && iterations < max_iter) {
1882 Inset * const ins = cur.nextInset();
1885 docstring insname = ins->layoutName();
1886 while (!insname.empty()) {
1887 if (insname == name || name == from_utf8("*")) {
1889 lyx::dispatch(fr, dr);
1893 size_t const i = insname.rfind(':');
1894 if (i == string::npos)
1896 insname = insname.substr(0, i);
1898 // if we did not delete the inset, skip it
1899 if (!cur.nextInset() || cur.nextInset() == ins)
1905 dr.screenUpdate(Update::Force);
1906 dr.forceBufferUpdate();
1908 if (iterations >= max_iter) {
1910 dr.setMessage(bformat(_("`inset-forall' interrupted because number of actions is larger than %1$d"), max_iter));
1912 dr.setMessage(bformat(_("Applied \"%1$s\" to %2$d insets"), from_utf8(commandstr), iterations));
1917 case LFUN_BRANCH_ADD_INSERT: {
1918 docstring branch_name = from_utf8(cmd.getArg(0));
1919 if (branch_name.empty())
1920 if (!Alert::askForText(branch_name, _("Branch name")) ||
1921 branch_name.empty())
1924 DispatchResult drtmp;
1925 buffer_.dispatch(FuncRequest(LFUN_BRANCH_ADD, branch_name), drtmp);
1926 if (drtmp.error()) {
1927 Alert::warning(_("Branch already exists"), drtmp.message());
1930 BranchList & branch_list = buffer_.params().branchlist();
1931 vector<docstring> const branches =
1932 getVectorFromString(branch_name, branch_list.separator());
1933 for (vector<docstring>::const_iterator it = branches.begin();
1934 it != branches.end(); ++it) {
1936 lyx::dispatch(FuncRequest(LFUN_BRANCH_INSERT, branch_name));
1941 case LFUN_KEYMAP_OFF:
1942 getIntl().keyMapOn(false);
1945 case LFUN_KEYMAP_PRIMARY:
1946 getIntl().keyMapPrim();
1949 case LFUN_KEYMAP_SECONDARY:
1950 getIntl().keyMapSec();
1953 case LFUN_KEYMAP_TOGGLE:
1954 getIntl().toggleKeyMap();
1957 case LFUN_DIALOG_SHOW_NEW_INSET: {
1958 string const name = cmd.getArg(0);
1959 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
1960 if (decodeInsetParam(name, data, buffer_))
1961 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
1963 lyxerr << "Inset type '" << name <<
1964 "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" << endl;
1968 case LFUN_CITATION_INSERT: {
1969 if (argument.empty()) {
1970 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
1973 // we can have one optional argument, delimited by '|'
1974 // citation-insert <key>|<text_before>
1975 // this should be enhanced to also support text_after
1976 // and citation style
1977 string arg = argument;
1979 if (contains(argument, "|")) {
1980 arg = token(argument, '|', 0);
1981 opt1 = token(argument, '|', 1);
1984 // if our cursor is directly in front of or behind a citation inset,
1985 // we will instead add the new key to it.
1986 Inset * inset = cur.nextInset();
1987 if (!inset || inset->lyxCode() != CITE_CODE)
1988 inset = cur.prevInset();
1989 if (inset && inset->lyxCode() == CITE_CODE) {
1990 InsetCitation * icite = static_cast<InsetCitation *>(inset);
1991 if (icite->addKey(arg)) {
1992 dr.forceBufferUpdate();
1993 dr.screenUpdate(Update::FitCursor | Update::SinglePar);
1995 LYXERR0("Discarding optional argument to citation-insert.");
2000 InsetCommandParams icp(CITE_CODE);
2001 icp["key"] = from_utf8(arg);
2003 icp["before"] = from_utf8(opt1);
2004 string icstr = InsetCommand::params2string(icp);
2005 FuncRequest fr(LFUN_INSET_INSERT, icstr);
2010 case LFUN_INSET_APPLY: {
2011 string const name = cmd.getArg(0);
2012 Inset * inset = editedInset(name);
2014 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
2018 // put cursor in front of inset.
2019 if (!setCursorFromInset(inset)) {
2020 LASSERT(false, break);
2023 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
2024 inset->dispatch(cur, fr);
2025 dr.screenUpdate(cur.result().screenUpdate());
2026 if (cur.result().needBufferUpdate())
2027 dr.forceBufferUpdate();
2032 // The change of language of buffer belongs to the Buffer class.
2033 // We have to do it here because we need a cursor for Undo.
2034 // When Undo::recordUndoBufferParams() is implemented someday
2035 // LFUN_BUFFER_LANGUAGE should be handled by the Buffer class.
2036 case LFUN_BUFFER_LANGUAGE: {
2037 Language const * oldL = buffer_.params().language;
2038 Language const * newL = languages.getLanguage(argument);
2039 if (!newL || oldL == newL)
2041 if (oldL->rightToLeft() == newL->rightToLeft()) {
2042 cur.recordUndoFullBuffer();
2043 buffer_.changeLanguage(oldL, newL);
2044 cur.setCurrentFont();
2045 dr.forceBufferUpdate();
2050 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
2051 case LFUN_FILE_INSERT_PLAINTEXT: {
2052 bool const as_paragraph = (act == LFUN_FILE_INSERT_PLAINTEXT_PARA);
2053 string const fname = to_utf8(cmd.argument());
2054 if (!FileName::isAbsolute(fname))
2055 dr.setMessage(_("Absolute filename expected."));
2057 insertPlaintextFile(FileName(fname), as_paragraph);
2062 // OK, so try the Buffer itself...
2063 buffer_.dispatch(cmd, dr);
2064 dispatched = dr.dispatched();
2068 buffer_.undo().endUndoGroup();
2069 dr.dispatched(dispatched);
2071 // NOTE: The code below is copied from Cursor::dispatch. If you
2072 // need to modify this, please update the other one too.
2074 // notify insets we just entered/left
2075 if (cursor() != old) {
2076 old.beginUndoGroup();
2078 bool badcursor = notifyCursorLeavesOrEnters(old, cursor());
2080 cursor().fixIfBroken();
2081 resetInlineCompletionPos();
2088 docstring const BufferView::requestSelection()
2090 Cursor & cur = d->cursor_;
2092 LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
2093 if (!cur.selection()) {
2094 d->xsel_cache_.set = false;
2098 LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
2099 if (!d->xsel_cache_.set ||
2100 cur.top() != d->xsel_cache_.cursor ||
2101 cur.realAnchor().top() != d->xsel_cache_.anchor)
2103 d->xsel_cache_.cursor = cur.top();
2104 d->xsel_cache_.anchor = cur.realAnchor().top();
2105 d->xsel_cache_.set = cur.selection();
2106 return cur.selectionAsString(false);
2112 void BufferView::clearSelection()
2114 d->cursor_.clearSelection();
2115 // Clear the selection buffer. Otherwise a subsequent
2116 // middle-mouse-button paste would use the selection buffer,
2117 // not the more current external selection.
2118 cap::clearSelection();
2119 d->xsel_cache_.set = false;
2120 // The buffer did not really change, but this causes the
2121 // redraw we need because we cleared the selection above.
2122 buffer_.changed(false);
2126 void BufferView::resize(int width, int height)
2128 // Update from work area
2132 // Clear the paragraph height cache.
2133 d->par_height_.clear();
2134 // Redo the metrics.
2139 Inset const * BufferView::getCoveringInset(Text const & text,
2142 TextMetrics & tm = d->text_metrics_[&text];
2143 Inset * inset = tm.checkInsetHit(x, y);
2147 if (!inset->descendable(*this))
2148 // No need to go further down if the inset is not
2152 size_t cell_number = inset->nargs();
2153 // Check all the inner cell.
2154 for (size_t i = 0; i != cell_number; ++i) {
2155 Text const * inner_text = inset->getText(i);
2158 Inset const * inset_deeper =
2159 getCoveringInset(*inner_text, x, y);
2161 return inset_deeper;
2169 void BufferView::updateHoveredInset() const
2171 // Get inset under mouse, if there is one.
2172 int const x = d->mouse_position_cache_.x_;
2173 int const y = d->mouse_position_cache_.y_;
2174 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
2176 d->clickable_inset_ = covering_inset && covering_inset->clickable(x, y);
2178 if (covering_inset == d->last_inset_)
2179 // Same inset, no need to do anything...
2182 bool need_redraw = false;
2183 if (d->last_inset_) {
2184 // Remove the hint on the last hovered inset (if any).
2185 need_redraw |= d->last_inset_->setMouseHover(this, false);
2189 if (covering_inset && covering_inset->setMouseHover(this, true)) {
2191 // Only the insets that accept the hover state, do
2192 // clear the last_inset_, so only set the last_inset_
2193 // member if the hovered setting is accepted.
2194 d->last_inset_ = covering_inset;
2198 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
2199 << d->mouse_position_cache_.x_ << ", "
2200 << d->mouse_position_cache_.y_ << ")");
2202 d->update_strategy_ = DecorationUpdate;
2204 // This event (moving without mouse click) is not passed further.
2205 // This should be changed if it is further utilized.
2206 buffer_.changed(false);
2211 void BufferView::clearLastInset(Inset * inset) const
2213 if (d->last_inset_ != inset) {
2214 LYXERR0("Wrong last_inset!");
2221 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
2223 //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
2225 // This is only called for mouse related events including
2226 // LFUN_FILE_OPEN generated by drag-and-drop.
2227 FuncRequest cmd = cmd0;
2229 Cursor old = cursor();
2231 cur.push(buffer_.inset());
2232 cur.setSelection(d->cursor_.selection());
2234 // Either the inset under the cursor or the
2235 // surrounding Text will handle this event.
2237 // make sure we stay within the screen...
2238 cmd.set_y(min(max(cmd.y(), -1), height_));
2240 d->mouse_position_cache_.x_ = cmd.x();
2241 d->mouse_position_cache_.y_ = cmd.y();
2243 if (cmd.action() == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
2244 updateHoveredInset();
2248 // Build temporary cursor.
2249 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x(), cmd.y());
2251 // Put anchor at the same position.
2254 cur.beginUndoGroup();
2256 // Try to dispatch to an non-editable inset near this position
2257 // via the temp cursor. If the inset wishes to change the real
2258 // cursor it has to do so explicitly by using
2259 // cur.bv().cursor() = cur; (or similar)
2261 inset->dispatch(cur, cmd);
2263 // Now dispatch to the temporary cursor. If the real cursor should
2264 // be modified, the inset's dispatch has to do so explicitly.
2265 if (!inset || !cur.result().dispatched())
2270 // Notify left insets
2272 bool badcursor = old.fixIfBroken() | cur.fixIfBroken();
2273 badcursor |= notifyCursorLeavesOrEnters(old, cur);
2275 cursor().fixIfBroken();
2278 // Do we have a selection?
2279 theSelection().haveSelection(cursor().selection());
2281 if (cur.needBufferUpdate()) {
2282 cur.clearBufferUpdate();
2283 buffer().updateBuffer();
2286 // If the command has been dispatched,
2287 if (cur.result().dispatched() || cur.result().screenUpdate())
2288 processUpdateFlags(cur.result().screenUpdate());
2292 int BufferView::minVisiblePart()
2294 return 2 * defaultRowHeight();
2298 int BufferView::scroll(int y)
2301 return scrollDown(y);
2303 return scrollUp(-y);
2308 int BufferView::scrollDown(int offset)
2310 Text * text = &buffer_.text();
2311 TextMetrics & tm = d->text_metrics_[text];
2312 int const ymax = height_ + offset;
2314 pair<pit_type, ParagraphMetrics const *> last = tm.last();
2315 int bottom_pos = last.second->position() + last.second->descent();
2316 if (lyxrc.scroll_below_document)
2317 bottom_pos += height_ - minVisiblePart();
2318 if (last.first + 1 == int(text->paragraphs().size())) {
2319 if (bottom_pos <= height_)
2321 offset = min(offset, bottom_pos - height_);
2324 if (bottom_pos > ymax)
2326 tm.newParMetricsDown();
2328 d->anchor_ypos_ -= offset;
2333 int BufferView::scrollUp(int offset)
2335 Text * text = &buffer_.text();
2336 TextMetrics & tm = d->text_metrics_[text];
2337 int ymin = - offset;
2339 pair<pit_type, ParagraphMetrics const *> first = tm.first();
2340 int top_pos = first.second->position() - first.second->ascent();
2341 if (first.first == 0) {
2344 offset = min(offset, - top_pos);
2349 tm.newParMetricsUp();
2351 d->anchor_ypos_ += offset;
2356 void BufferView::setCursorFromRow(int row)
2360 pit_type newpit = 0;
2361 pos_type newpos = 0;
2363 buffer_.texrow().getIdFromRow(row, tmpid, tmppos);
2365 bool posvalid = (tmpid != -1);
2367 // we need to make sure that the row and position
2368 // we got back are valid, because the buffer may well
2369 // have changed since we last generated the LaTeX.
2370 DocIterator dit = buffer_.getParFromID(tmpid);
2371 if (dit == doc_iterator_end(&buffer_))
2373 else if (dit.depth() > 1) {
2374 // We are in an inset.
2375 pos_type lastpos = dit.lastpos();
2376 dit.pos() = tmppos > lastpos ? lastpos : tmppos;
2382 // now have to check pos.
2384 Paragraph const & par = buffer_.text().getPar(newpit);
2385 if (newpos > par.size()) {
2386 LYXERR0("Requested position no longer valid.");
2387 newpos = par.size() - 1;
2392 frontend::Alert::error(_("Inverse Search Failed"),
2393 _("Invalid position requested by inverse search.\n"
2394 "You need to update the viewed document."));
2398 buffer_.text().setCursor(d->cursor_, newpit, newpos);
2399 d->cursor_.setSelection(false);
2400 d->cursor_.resetAnchor();
2405 bool BufferView::setCursorFromInset(Inset const * inset)
2407 // are we already there?
2408 if (cursor().nextInset() == inset)
2411 // Inset is not at cursor position. Find it in the document.
2414 while (cur && cur.nextInset() != inset)
2425 void BufferView::gotoLabel(docstring const & label)
2427 ListOfBuffers bufs = buffer().allRelatives();
2428 ListOfBuffers::iterator it = bufs.begin();
2429 for (; it != bufs.end(); ++it) {
2430 Buffer const * buf = *it;
2433 shared_ptr<Toc> toc = buf->tocBackend().toc("label");
2434 TocIterator toc_it = toc->begin();
2435 TocIterator end = toc->end();
2436 for (; toc_it != end; ++toc_it) {
2437 if (label == toc_it->str()) {
2438 lyx::dispatch(toc_it->action());
2446 TextMetrics const & BufferView::textMetrics(Text const * t) const
2448 return const_cast<BufferView *>(this)->textMetrics(t);
2452 TextMetrics & BufferView::textMetrics(Text const * t)
2455 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
2456 if (tmc_it == d->text_metrics_.end()) {
2457 tmc_it = d->text_metrics_.insert(
2458 make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
2460 return tmc_it->second;
2464 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
2467 return textMetrics(t).parMetrics(pit);
2471 int BufferView::workHeight() const
2477 void BufferView::setCursor(DocIterator const & dit)
2480 size_t const n = dit.depth();
2481 for (size_t i = 0; i < n; ++i)
2482 dit[i].inset().edit(d->cursor_, true);
2484 d->cursor_.setCursor(dit);
2485 d->cursor_.setSelection(false);
2486 d->cursor_.setCurrentFont();
2488 // It seems on general grounds as if this is probably needed, but
2489 // it is not yet clear.
2490 // See bug #7394 and r38388.
2491 // d->cursor.resetAnchor();
2495 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
2497 // Would be wrong to delete anything if we have a selection.
2498 if (cur.selection())
2501 bool need_anchor_change = false;
2502 bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
2503 need_anchor_change);
2505 if (need_anchor_change)
2513 // we would rather not do this here, but it needs to be done before
2514 // the changed() signal is sent.
2515 buffer_.updateBuffer();
2517 buffer_.changed(true);
2522 bool BufferView::mouseSetCursor(Cursor & cur, bool select)
2524 LASSERT(&cur.bv() == this, return false);
2527 // this event will clear selection so we save selection for
2528 // persistent selection
2529 cap::saveSelection(cursor());
2531 d->cursor_.macroModeClose();
2532 // If a macro has been finalized, the cursor might have been broken
2535 // Has the cursor just left the inset?
2536 bool const leftinset = (&d->cursor_.inset() != &cur.inset());
2538 d->cursor_.fixIfBroken();
2540 // FIXME: shift-mouse selection doesn't work well across insets.
2541 bool const do_selection =
2542 select && &d->cursor_.normalAnchor().inset() == &cur.inset();
2544 // do the dEPM magic if needed
2545 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
2546 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
2547 // the leftinset bool would not be necessary (badcursor instead).
2548 bool update = leftinset;
2549 if (!do_selection && d->cursor_.inTexted())
2550 update |= checkDepm(cur, d->cursor_);
2553 d->cursor_.resetAnchor();
2554 d->cursor_.setCursor(cur);
2555 d->cursor_.boundary(cur.boundary());
2557 d->cursor_.setSelection();
2559 d->cursor_.clearSelection();
2561 d->cursor_.finishUndo();
2562 d->cursor_.setCurrentFont();
2564 cur.forceBufferUpdate();
2569 void BufferView::putSelectionAt(DocIterator const & cur,
2570 int length, bool backwards)
2572 d->cursor_.clearSelection();
2578 d->cursor_.pos() += length;
2579 d->cursor_.setSelection(d->cursor_, -length);
2581 d->cursor_.setSelection(d->cursor_, length);
2586 bool BufferView::selectIfEmpty(DocIterator & cur)
2588 if ((cur.inTexted() && !cur.paragraph().empty())
2589 || (cur.inMathed() && !cur.cell().empty()))
2592 pit_type const beg_pit = cur.pit();
2594 // The paragraph associated to this item isn't
2595 // the first one, so it can be selected
2598 // We have to resort to select the space between the
2599 // end of this item and the begin of the next one
2603 // If it is the only item in the document,
2604 // nothing can be selected
2607 pit_type const end_pit = cur.pit();
2608 pos_type const end_pos = cur.pos();
2609 d->cursor_.clearSelection();
2611 d->cursor_.setCursor(cur);
2612 d->cursor_.pit() = beg_pit;
2613 d->cursor_.pos() = 0;
2614 d->cursor_.setSelection(false);
2615 d->cursor_.resetAnchor();
2616 d->cursor_.pit() = end_pit;
2617 d->cursor_.pos() = end_pos;
2618 d->cursor_.setSelection();
2623 Cursor & BufferView::cursor()
2629 Cursor const & BufferView::cursor() const
2635 pit_type BufferView::anchor_ref() const
2637 return d->anchor_pit_;
2641 bool BufferView::singleParUpdate()
2643 Text & buftext = buffer_.text();
2644 pit_type const bottom_pit = d->cursor_.bottom().pit();
2645 TextMetrics & tm = textMetrics(&buftext);
2646 int old_height = tm.parMetrics(bottom_pit).height();
2648 // make sure inline completion pointer is ok
2649 if (d->inlineCompletionPos_.fixIfBroken())
2650 d->inlineCompletionPos_ = DocIterator();
2652 // In Single Paragraph mode, rebreak only
2653 // the (main text, not inset!) paragraph containing the cursor.
2654 // (if this paragraph contains insets etc., rebreaking will
2655 // recursively descend)
2656 tm.redoParagraph(bottom_pit);
2657 ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
2658 if (pm.height() != old_height)
2659 // Paragraph height has changed so we cannot proceed to
2660 // the singlePar optimisation.
2663 d->update_strategy_ = SingleParUpdate;
2665 LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
2666 << " y2: " << pm.position() + pm.descent()
2667 << " pit: " << bottom_pit
2668 << " singlepar: 1");
2673 void BufferView::updateMetrics()
2675 if (height_ == 0 || width_ == 0)
2678 Text & buftext = buffer_.text();
2679 pit_type const npit = int(buftext.paragraphs().size());
2681 // Clear out the position cache in case of full screen redraw,
2682 d->coord_cache_.clear();
2684 // Clear out paragraph metrics to avoid having invalid metrics
2685 // in the cache from paragraphs not relayouted below
2686 // The complete text metrics will be redone.
2687 d->text_metrics_.clear();
2689 TextMetrics & tm = textMetrics(&buftext);
2691 // make sure inline completion pointer is ok
2692 if (d->inlineCompletionPos_.fixIfBroken())
2693 d->inlineCompletionPos_ = DocIterator();
2695 if (d->anchor_pit_ >= npit)
2696 // The anchor pit must have been deleted...
2697 d->anchor_pit_ = npit - 1;
2699 // Rebreak anchor paragraph.
2700 tm.redoParagraph(d->anchor_pit_);
2701 ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
2704 if (d->anchor_pit_ == 0) {
2705 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
2707 // Complete buffer visible? Then it's easy.
2708 if (scrollRange == 0)
2709 d->anchor_ypos_ = anchor_pm.ascent();
2711 // FIXME: Some clever handling needed to show
2712 // the _first_ paragraph up to the top if the cursor is
2713 // in the first line.
2715 anchor_pm.setPosition(d->anchor_ypos_);
2717 LYXERR(Debug::PAINTING, "metrics: "
2718 << " anchor pit = " << d->anchor_pit_
2719 << " anchor ypos = " << d->anchor_ypos_);
2721 // Redo paragraphs above anchor if necessary.
2722 int y1 = d->anchor_ypos_ - anchor_pm.ascent();
2723 // We are now just above the anchor paragraph.
2724 pit_type pit1 = d->anchor_pit_ - 1;
2725 for (; pit1 >= 0 && y1 >= 0; --pit1) {
2726 tm.redoParagraph(pit1);
2727 ParagraphMetrics & pm = tm.par_metrics_[pit1];
2729 // Save the paragraph position in the cache.
2734 // Redo paragraphs below the anchor if necessary.
2735 int y2 = d->anchor_ypos_ + anchor_pm.descent();
2736 // We are now just below the anchor paragraph.
2737 pit_type pit2 = d->anchor_pit_ + 1;
2738 for (; pit2 < npit && y2 <= height_; ++pit2) {
2739 tm.redoParagraph(pit2);
2740 ParagraphMetrics & pm = tm.par_metrics_[pit2];
2742 // Save the paragraph position in the cache.
2747 LYXERR(Debug::PAINTING, "Metrics: "
2748 << " anchor pit = " << d->anchor_pit_
2749 << " anchor ypos = " << d->anchor_ypos_
2752 << " pit1 = " << pit1
2753 << " pit2 = " << pit2);
2755 d->update_strategy_ = FullScreenUpdate;
2757 if (lyxerr.debugging(Debug::WORKAREA)) {
2758 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
2759 d->coord_cache_.dump();
2764 void BufferView::insertLyXFile(FileName const & fname)
2766 LASSERT(d->cursor_.inTexted(), return);
2768 // Get absolute path of file and add ".lyx"
2769 // to the filename if necessary
2770 FileName filename = fileSearch(string(), fname.absFileName(), "lyx");
2772 docstring const disp_fn = makeDisplayPath(filename.absFileName());
2773 // emit message signal.
2774 message(bformat(_("Inserting document %1$s..."), disp_fn));
2777 Buffer buf(filename.absFileName(), false);
2778 if (buf.loadLyXFile() == Buffer::ReadSuccess) {
2779 ErrorList & el = buffer_.errorList("Parse");
2780 // Copy the inserted document error list into the current buffer one.
2781 el = buf.errorList("Parse");
2782 buffer_.undo().recordUndo(d->cursor_);
2783 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
2784 buf.params().documentClassPtr(), el);
2785 res = _("Document %1$s inserted.");
2787 res = _("Could not insert document %1$s");
2790 buffer_.changed(true);
2791 // emit message signal.
2792 message(bformat(res, disp_fn));
2796 Point BufferView::coordOffset(DocIterator const & dit) const
2802 // Addup contribution of nested insets, from inside to outside,
2803 // keeping the outer paragraph for a special handling below
2804 for (size_t i = dit.depth() - 1; i >= 1; --i) {
2805 CursorSlice const & sl = dit[i];
2809 // get relative position inside sl.inset()
2810 sl.inset().cursorPos(*this, sl, dit.boundary() && (i + 1 == dit.depth()), xx, yy);
2812 // Make relative position inside of the edited inset relative to sl.inset()
2816 // In case of an RTL inset, the edited inset will be positioned to the left
2819 bool boundary_i = dit.boundary() && i + 1 == dit.depth();
2820 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2825 // remember width for the case that sl.inset() is positioned in an RTL inset
2826 if (i && dit[i - 1].text()) {
2827 // If this Inset is inside a Text Inset, retrieve the Dimension
2828 // from the containing text instead of using Inset::dimension() which
2829 // might not be implemented.
2830 // FIXME (Abdel 23/09/2007): this is a bit messy because of the
2831 // elimination of Inset::dim_ cache. This coordOffset() method needs
2832 // to be rewritten in light of the new design.
2833 Dimension const & dim = parMetrics(dit[i - 1].text(),
2834 dit[i - 1].pit()).insetDimension(&sl.inset());
2837 Dimension const dim = sl.inset().dimension(*this);
2841 //lyxerr << "Cursor::getPos, i: "
2842 // << i << " x: " << xx << " y: " << y << endl;
2845 // Add contribution of initial rows of outermost paragraph
2846 CursorSlice const & sl = dit[0];
2847 TextMetrics const & tm = textMetrics(sl.text());
2848 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2850 LBUFERR(!pm.rows().empty());
2851 y -= pm.rows()[0].ascent();
2853 // FIXME: document this mess
2855 if (sl.pos() > 0 && dit.depth() == 1) {
2857 if (pos && dit.boundary())
2859 // lyxerr << "coordOffset: boundary:" << dit.boundary() << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
2860 rend = pm.pos2row(pos);
2862 rend = pm.pos2row(sl.pos());
2864 size_t rend = pm.pos2row(sl.pos());
2866 for (size_t rit = 0; rit != rend; ++rit)
2867 y += pm.rows()[rit].height();
2868 y += pm.rows()[rend].ascent();
2870 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
2872 // Make relative position from the nested inset now bufferview absolute.
2873 int xx = bottom_tm.cursorX(dit.bottom(), dit.boundary() && dit.depth() == 1);
2876 // In the RTL case place the nested inset at the left of the cursor in
2877 // the outer paragraph
2878 bool boundary_1 = dit.boundary() && 1 == dit.depth();
2879 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
2887 Point BufferView::getPos(DocIterator const & dit) const
2889 if (!paragraphVisible(dit))
2890 return Point(-1, -1);
2892 CursorSlice const & bot = dit.bottom();
2893 TextMetrics const & tm = textMetrics(bot.text());
2895 // offset from outer paragraph
2896 Point p = coordOffset(dit);
2897 p.y_ += tm.parMetrics(bot.pit()).position();
2902 bool BufferView::paragraphVisible(DocIterator const & dit) const
2904 CursorSlice const & bot = dit.bottom();
2905 TextMetrics const & tm = textMetrics(bot.text());
2907 return tm.contains(bot.pit());
2911 void BufferView::cursorPosAndHeight(Point & p, int & h) const
2913 Cursor const & cur = cursor();
2914 Font const font = cur.getFont();
2915 frontend::FontMetrics const & fm = theFontMetrics(font);
2916 int const asc = fm.maxAscent();
2917 int const des = fm.maxDescent();
2924 bool BufferView::cursorInView(Point const & p, int h) const
2926 Cursor const & cur = cursor();
2927 // does the cursor touch the screen ?
2928 if (p.y_ + h < 0 || p.y_ >= workHeight() || !paragraphVisible(cur))
2934 int BufferView::horizScrollOffset() const
2936 return d->horiz_scroll_offset_;
2940 CursorSlice const & BufferView::currentRowSlice() const
2942 return d->current_row_slice_;
2946 CursorSlice const & BufferView::lastRowSlice() const
2948 return d->last_row_slice_;
2952 void BufferView::setCurrentRowSlice(CursorSlice const & rowSlice)
2954 // nothing to do if the cursor was already on this row
2955 if (d->current_row_slice_ == rowSlice) {
2956 d->last_row_slice_ = CursorSlice();
2960 // if the (previous) current row was scrolled, we have to
2961 // remember it in order to repaint it next time.
2962 if (d->horiz_scroll_offset_ != 0)
2963 d->last_row_slice_ = d->current_row_slice_;
2965 d->last_row_slice_ = CursorSlice();
2967 // Since we changed row, the scroll offset is not valid anymore
2968 d->horiz_scroll_offset_ = 0;
2969 d->current_row_slice_ = rowSlice;
2973 void BufferView::checkCursorScrollOffset(PainterInfo & pi)
2975 CursorSlice rowSlice = d->cursor_.bottom();
2976 TextMetrics const & tm = textMetrics(rowSlice.text());
2978 // Stop if metrics have not been computed yet, since it means
2979 // that there is nothing to do.
2980 if (!tm.contains(rowSlice.pit()))
2982 ParagraphMetrics const & pm = tm.parMetrics(rowSlice.pit());
2983 Row const & row = pm.getRow(rowSlice.pos(),
2984 d->cursor_.boundary()
2985 && rowSlice == d->cursor_.top());
2986 rowSlice.pos() = row.pos();
2988 // Set the row on which the cursor lives.
2989 setCurrentRowSlice(rowSlice);
2991 // Current x position of the cursor in pixels
2992 int const cur_x = getPos(d->cursor_).x_;
2994 // Horizontal scroll offset of the cursor row in pixels
2995 int offset = d->horiz_scroll_offset_;
2996 int const MARGIN = Length(2, Length::EM).inPixels(pi.base);
2997 if (cur_x < offset + MARGIN) {
2999 offset = cur_x - MARGIN;
3000 } else if (cur_x > offset + workWidth() - MARGIN) {
3002 offset = cur_x - workWidth() + MARGIN;
3005 if (offset < row.left_margin || row.width() <= workWidth())
3008 if (offset != d->horiz_scroll_offset_)
3009 LYXERR(Debug::PAINTING, "Horiz. scroll offset changed from "
3010 << d->horiz_scroll_offset_ << " to " << offset);
3012 if (d->update_strategy_ == NoScreenUpdate
3013 && (offset != d->horiz_scroll_offset_
3014 || !d->last_row_slice_.empty())) {
3015 // FIXME: if one uses SingleParUpdate, then home/end
3016 // will not work on long rows. Why?
3017 d->update_strategy_ = FullScreenUpdate;
3020 d->horiz_scroll_offset_ = offset;
3024 void BufferView::draw(frontend::Painter & pain)
3026 if (height_ == 0 || width_ == 0)
3028 LYXERR(Debug::PAINTING, "\t\t*** START DRAWING ***");
3030 Text & text = buffer_.text();
3031 TextMetrics const & tm = d->text_metrics_[&text];
3032 int const y = tm.first().second->position();
3033 PainterInfo pi(this, pain);
3035 // Check whether the row where the cursor lives needs to be scrolled.
3036 // Update the drawing strategy if needed.
3037 checkCursorScrollOffset(pi);
3039 switch (d->update_strategy_) {
3041 case NoScreenUpdate:
3042 // If no screen painting is actually needed, only some the different
3043 // coordinates of insets and paragraphs needs to be updated.
3044 LYXERR(Debug::PAINTING, "Strategy: NoScreenUpdate");
3045 pi.full_repaint = true;
3046 pi.pain.setDrawingEnabled(false);
3050 case SingleParUpdate:
3051 pi.full_repaint = false;
3052 LYXERR(Debug::PAINTING, "Strategy: SingleParUpdate");
3053 // In general, only the current row of the outermost paragraph
3054 // will be redrawn. Particular cases where selection spans
3055 // multiple paragraph are correctly detected in TextMetrics.
3059 case DecorationUpdate:
3060 // FIXME: We should also distinguish DecorationUpdate to avoid text
3061 // drawing if possible. This is not possible to do easily right now
3062 // because of the single backing pixmap.
3064 case FullScreenUpdate:
3066 LYXERR(Debug::PAINTING,
3067 ((d->update_strategy_ == FullScreenUpdate)
3068 ? "Strategy: FullScreenUpdate"
3069 : "Strategy: DecorationUpdate"));
3071 // The whole screen, including insets, will be refreshed.
3072 pi.full_repaint = true;
3074 // Clear background.
3075 pain.fillRectangle(0, 0, width_, height_,
3076 pi.backgroundColor(&buffer_.inset()));
3081 // and possibly grey out below
3082 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3083 int const y2 = lastpm.second->position() + lastpm.second->descent();
3086 Color color = buffer().isInternal()
3087 ? Color_background : Color_bottomarea;
3088 pain.fillRectangle(0, y2, width_, height_ - y2, color);
3092 LYXERR(Debug::PAINTING, "\n\t\t*** END DRAWING ***");
3094 // The scrollbar needs an update.
3097 // Normalize anchor for next time
3098 pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
3099 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3100 for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
3101 ParagraphMetrics const & pm = tm.parMetrics(pit);
3102 if (pm.position() + pm.descent() > 0) {
3103 d->anchor_pit_ = pit;
3104 d->anchor_ypos_ = pm.position();
3108 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
3109 << " anchor ypos = " << d->anchor_ypos_);
3113 void BufferView::message(docstring const & msg)
3116 d->gui_->message(msg);
3120 void BufferView::showDialog(string const & name)
3123 d->gui_->showDialog(name, string());
3127 void BufferView::showDialog(string const & name,
3128 string const & data, Inset * inset)
3131 d->gui_->showDialog(name, data, inset);
3135 void BufferView::updateDialog(string const & name, string const & data)
3138 d->gui_->updateDialog(name, data);
3142 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
3148 // FIXME: Move this out of BufferView again
3149 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
3151 if (!fname.isReadableFile()) {
3152 docstring const error = from_ascii(strerror(errno));
3153 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3154 docstring const text =
3155 bformat(_("Could not read the specified document\n"
3156 "%1$s\ndue to the error: %2$s"), file, error);
3157 Alert::error(_("Could not read file"), text);
3161 if (!fname.isReadableFile()) {
3162 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3163 docstring const text =
3164 bformat(_("%1$s\n is not readable."), file);
3165 Alert::error(_("Could not open file"), text);
3169 // FIXME UNICODE: We don't know the encoding of the file
3170 docstring file_content = fname.fileContents("UTF-8");
3171 if (file_content.empty()) {
3172 Alert::error(_("Reading not UTF-8 encoded file"),
3173 _("The file is not UTF-8 encoded.\n"
3174 "It will be read as local 8Bit-encoded.\n"
3175 "If this does not give the correct result\n"
3176 "then please change the encoding of the file\n"
3177 "to UTF-8 with a program other than LyX.\n"));
3178 file_content = fname.fileContents("local8bit");
3181 return normalize_c(file_content);
3185 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
3187 docstring const tmpstr = contentsOfPlaintextFile(f);
3192 Cursor & cur = cursor();
3193 cap::replaceSelection(cur);
3194 buffer_.undo().recordUndo(cur);
3196 cur.innerText()->insertStringAsParagraphs(cur, tmpstr, cur.current_font);
3198 cur.innerText()->insertStringAsLines(cur, tmpstr, cur.current_font);
3200 buffer_.changed(true);
3204 docstring const & BufferView::inlineCompletion() const
3206 return d->inlineCompletion_;
3210 size_t const & BufferView::inlineCompletionUniqueChars() const
3212 return d->inlineCompletionUniqueChars_;
3216 DocIterator const & BufferView::inlineCompletionPos() const
3218 return d->inlineCompletionPos_;
3222 void BufferView::resetInlineCompletionPos()
3224 d->inlineCompletionPos_ = DocIterator();
3228 bool samePar(DocIterator const & a, DocIterator const & b)
3230 if (a.empty() && b.empty())
3232 if (a.empty() || b.empty())
3234 if (a.depth() != b.depth())
3236 return &a.innerParagraph() == &b.innerParagraph();
3240 void BufferView::setInlineCompletion(Cursor const & cur, DocIterator const & pos,
3241 docstring const & completion, size_t uniqueChars)
3243 uniqueChars = min(completion.size(), uniqueChars);
3244 bool changed = d->inlineCompletion_ != completion
3245 || d->inlineCompletionUniqueChars_ != uniqueChars;
3246 bool singlePar = true;
3247 d->inlineCompletion_ = completion;
3248 d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
3250 //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
3253 DocIterator const & old = d->inlineCompletionPos_;
3255 //lyxerr << "inlineCompletionPos changed" << std::endl;
3256 // old or pos are in another paragraph?
3257 if ((!samePar(cur, pos) && !pos.empty())
3258 || (!samePar(cur, old) && !old.empty())) {
3260 //lyxerr << "different paragraph" << std::endl;
3262 d->inlineCompletionPos_ = pos;
3267 if (singlePar && !(cur.result().screenUpdate() & Update::Force))
3268 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
3270 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::Force);
3275 bool BufferView::clickableInset() const
3277 return d->clickable_inset_;