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"
49 #include "RowPainter.h"
52 #include "TextClass.h"
53 #include "TextMetrics.h"
55 #include "TocBackend.h"
56 #include "WordLangTuple.h"
58 #include "insets/InsetBibtex.h"
59 #include "insets/InsetCitation.h"
60 #include "insets/InsetCommand.h" // ChangeRefs
61 #include "insets/InsetExternal.h"
62 #include "insets/InsetGraphics.h"
63 #include "insets/InsetNote.h"
64 #include "insets/InsetRef.h"
65 #include "insets/InsetText.h"
67 #include "mathed/MathData.h"
69 #include "frontends/alert.h"
70 #include "frontends/Application.h"
71 #include "frontends/Delegates.h"
72 #include "frontends/FontMetrics.h"
73 #include "frontends/Painter.h"
74 #include "frontends/Selection.h"
76 #include "support/convert.h"
77 #include "support/debug.h"
78 #include "support/ExceptionMessage.h"
79 #include "support/filetools.h"
80 #include "support/gettext.h"
81 #include "support/lassert.h"
82 #include "support/lstrings.h"
83 #include "support/Package.h"
84 #include "support/types.h"
94 using namespace lyx::support;
98 namespace Alert = frontend::Alert;
102 /// Return an inset of this class if it exists at the current cursor position
104 T * getInsetByCode(Cursor const & cur, InsetCode code)
106 DocIterator it = cur;
107 Inset * inset = it.nextInset();
108 if (inset && inset->lyxCode() == code)
109 return static_cast<T*>(inset);
114 /// Note that comparing contents can only be used for InsetCommand
115 bool findNextInset(DocIterator & dit, vector<InsetCode> const & codes,
116 docstring const & contents)
118 DocIterator tmpdit = dit;
121 Inset const * inset = tmpdit.nextInset();
123 bool const valid_code = std::find(codes.begin(), codes.end(),
124 inset->lyxCode()) != codes.end();
125 InsetCommand const * ic = inset->asInsetCommand();
126 bool const same_or_no_contents = contents.empty()
127 || (ic && (ic->getFirstNonOptParam() == contents));
129 if (valid_code && same_or_no_contents) {
134 tmpdit.forwardInset();
141 /// Looks for next inset with one of the given codes.
142 /// Note that same_content can only be used for InsetCommand
143 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
147 DocIterator tmpdit = dit;
148 tmpdit.forwardInset();
152 Inset const * inset = tmpdit.nextInset();
153 if (same_content && inset) {
154 InsetCommand const * ic = inset->asInsetCommand();
156 bool const valid_code = std::find(codes.begin(), codes.end(),
157 ic->lyxCode()) != codes.end();
159 contents = ic->getFirstNonOptParam();
163 if (!findNextInset(tmpdit, codes, contents)) {
164 if (dit.depth() != 1 || dit.pit() != 0 || dit.pos() != 0) {
165 Inset * inset = &tmpdit.bottom().inset();
166 tmpdit = doc_iterator_begin(&inset->buffer(), inset);
167 if (!findNextInset(tmpdit, codes, contents))
179 /// Looks for next inset with the given code
180 void findInset(DocIterator & dit, InsetCode code, bool same_content)
182 findInset(dit, vector<InsetCode>(1, code), same_content);
186 /// Moves cursor to the next inset with one of the given codes.
187 void gotoInset(BufferView * bv, vector<InsetCode> const & codes,
190 Cursor tmpcur = bv->cursor();
191 if (!findInset(tmpcur, codes, same_content)) {
192 bv->cursor().message(_("No more insets"));
196 tmpcur.clearSelection();
197 bv->setCursor(tmpcur);
202 /// Moves cursor to the next inset with given code.
203 void gotoInset(BufferView * bv, InsetCode code, bool same_content)
205 gotoInset(bv, vector<InsetCode>(1, code), same_content);
209 /// A map from a Text to the associated text metrics
210 typedef map<Text const *, TextMetrics> TextMetricsCache;
212 enum ScreenUpdateStrategy {
222 /////////////////////////////////////////////////////////////////////
226 /////////////////////////////////////////////////////////////////////
228 struct BufferView::Private
230 Private(BufferView & bv) : update_strategy_(NoScreenUpdate),
232 anchor_pit_(0), anchor_ypos_(0),
233 inlineCompletionUniqueChars_(0),
234 last_inset_(0), clickable_inset_(false),
235 mouse_position_cache_(),
236 bookmark_edit_position_(-1), gui_(0),
237 horiz_scroll_offset_(0)
239 xsel_cache_.set = false;
243 ScrollbarParameters scrollbarParameters_;
245 ScreenUpdateStrategy update_strategy_;
247 CoordCache coord_cache_;
249 /// Estimated average par height for scrollbar.
251 /// this is used to handle XSelection events in the right manner.
260 pit_type anchor_pit_;
264 vector<int> par_height_;
267 DocIterator inlineCompletionPos_;
269 docstring inlineCompletion_;
271 size_t inlineCompletionUniqueChars_;
273 /// keyboard mapping object.
276 /// last visited inset.
277 /** kept to send setMouseHover(false).
278 * Not owned, so don't delete.
280 Inset const * last_inset_;
281 /// are we hovering something that we can click
282 bool clickable_inset_;
284 /// position of the mouse at the time of the last mouse move
285 /// This is used to update the hovering status of inset in
286 /// cases where the buffer is scrolled, but the mouse didn't move.
287 Point mouse_position_cache_;
289 // cache for id of the paragraph which was edited the last time
290 int bookmark_edit_position_;
292 mutable TextMetricsCache text_metrics_;
295 /** Not owned, so don't delete.
297 frontend::GuiBufferViewDelegate * gui_;
299 /// Cache for Find Next
300 FuncRequest search_request_cache_;
303 map<string, Inset *> edited_insets_;
305 /// When the row where the cursor lies is scrolled, this
306 /// contains the scroll offset
307 int horiz_scroll_offset_;
308 /// a slice pointing to the start of the row where the cursor
309 /// is (at last draw time)
310 CursorSlice current_row_slice_;
311 /// a slice pointing to the start of the row where cursor was
312 /// at previous draw event
313 CursorSlice last_row_slice_;
317 BufferView::BufferView(Buffer & buf)
318 : width_(0), height_(0), full_screen_(false), buffer_(buf),
319 d(new Private(*this))
321 d->xsel_cache_.set = false;
322 d->intl_.initKeyMapper(lyxrc.use_kbmap);
324 d->cursor_.setBuffer(&buf);
325 d->cursor_.push(buffer_.inset());
326 d->cursor_.resetAnchor();
327 d->cursor_.setCurrentFont();
329 buffer_.updatePreviews();
333 BufferView::~BufferView()
335 // current buffer is going to be switched-off, save cursor pos
336 // Ideally, the whole cursor stack should be saved, but session
337 // currently can only handle bottom (whole document) level pit and pos.
338 // That is to say, if a cursor is in a nested inset, it will be
339 // restore to the left of the top level inset.
340 LastFilePosSection::FilePos fp;
341 fp.pit = d->cursor_.bottom().pit();
342 fp.pos = d->cursor_.bottom().pos();
343 theSession().lastFilePos().save(buffer_.fileName(), fp);
346 d->last_inset_->setMouseHover(this, false);
352 int BufferView::rightMargin() const
354 // The additional test for the case the outliner is opened.
356 !lyxrc.full_screen_limit ||
357 width_ < lyxrc.full_screen_width + 20)
360 return (width_ - lyxrc.full_screen_width) / 2;
364 int BufferView::leftMargin() const
366 return rightMargin();
370 bool BufferView::isTopScreen() const
372 return d->scrollbarParameters_.position == d->scrollbarParameters_.min;
376 bool BufferView::isBottomScreen() const
378 return d->scrollbarParameters_.position == d->scrollbarParameters_.max;
382 Intl & BufferView::getIntl()
388 Intl const & BufferView::getIntl() const
394 CoordCache & BufferView::coordCache()
396 return d->coord_cache_;
400 CoordCache const & BufferView::coordCache() const
402 return d->coord_cache_;
406 Buffer & BufferView::buffer()
412 Buffer const & BufferView::buffer() const
418 bool BufferView::needsFitCursor() const
420 if (cursorStatus(d->cursor_) == CUR_INSIDE) {
421 frontend::FontMetrics const & fm =
422 theFontMetrics(d->cursor_.getFont().fontInfo());
423 int const asc = fm.maxAscent();
424 int const des = fm.maxDescent();
425 Point const p = getPos(d->cursor_);
426 if (p.y_ - asc >= 0 && p.y_ + des < height_)
433 void BufferView::processUpdateFlags(Update::flags flags)
435 // This is close to a hot-path.
436 LYXERR(Debug::DEBUG, "BufferView::processUpdateFlags()"
437 << "[fitcursor = " << (flags & Update::FitCursor)
438 << ", forceupdate = " << (flags & Update::Force)
439 << ", singlepar = " << (flags & Update::SinglePar)
440 << "] buffer: " << &buffer_);
442 // FIXME Does this really need doing here? It's done in updateBuffer, and
443 // if the Buffer doesn't need updating, then do the macros?
444 buffer_.updateMacros();
446 // Now do the first drawing step if needed. This consists on updating
447 // the CoordCache in updateMetrics().
448 // The second drawing step is done in WorkArea::redraw() if needed.
449 // FIXME: is this still true now that Buffer::changed() is used all over?
451 // Case when no explicit update is requested.
453 // no need to redraw anything.
454 d->update_strategy_ = NoScreenUpdate;
458 if (flags == Update::Decoration) {
459 d->update_strategy_ = DecorationUpdate;
460 buffer_.changed(false);
464 if (flags == Update::FitCursor
465 || flags == (Update::Decoration | Update::FitCursor)) {
466 // tell the frontend to update the screen if needed.
467 if (needsFitCursor()) {
471 if (flags & Update::Decoration) {
472 d->update_strategy_ = DecorationUpdate;
473 buffer_.changed(false);
476 // no screen update is needed in principle, but this
477 // could change if cursor row needs horizontal scrolling.
478 d->update_strategy_ = NoScreenUpdate;
479 buffer_.changed(false);
483 bool const full_metrics = flags & Update::Force || !singleParUpdate();
486 // We have to update the full screen metrics.
489 if (!(flags & Update::FitCursor)) {
490 // Nothing to do anymore. Trigger a redraw and return
491 buffer_.changed(false);
495 // updateMetrics() does not update paragraph position
496 // This is done at draw() time. So we need a redraw!
497 buffer_.changed(false);
499 if (needsFitCursor()) {
500 // The cursor is off screen so ensure it is visible.
505 updateHoveredInset();
509 void BufferView::updateScrollbar()
511 if (height_ == 0 && width_ == 0)
514 // We prefer fixed size line scrolling.
515 d->scrollbarParameters_.single_step = defaultRowHeight();
516 // We prefer full screen page scrolling.
517 d->scrollbarParameters_.page_step = height_;
519 Text & t = buffer_.text();
520 TextMetrics & tm = d->text_metrics_[&t];
522 LYXERR(Debug::GUI, " Updating scrollbar: height: "
523 << t.paragraphs().size()
524 << " curr par: " << d->cursor_.bottom().pit()
525 << " default height " << defaultRowHeight());
527 size_t const parsize = t.paragraphs().size();
528 if (d->par_height_.size() != parsize) {
529 d->par_height_.clear();
530 // FIXME: We assume a default paragraph height of 2 rows. This
531 // should probably be pondered with the screen width.
532 d->par_height_.resize(parsize, defaultRowHeight() * 2);
535 // Look at paragraph heights on-screen
536 pair<pit_type, ParagraphMetrics const *> first = tm.first();
537 pair<pit_type, ParagraphMetrics const *> last = tm.last();
538 for (pit_type pit = first.first; pit <= last.first; ++pit) {
539 d->par_height_[pit] = tm.parMetrics(pit).height();
540 LYXERR(Debug::SCROLLING, "storing height for pit " << pit << " : "
541 << d->par_height_[pit]);
544 int top_pos = first.second->position() - first.second->ascent();
545 int bottom_pos = last.second->position() + last.second->descent();
546 bool first_visible = first.first == 0 && top_pos >= 0;
547 bool last_visible = last.first + 1 == int(parsize) && bottom_pos <= height_;
548 if (first_visible && last_visible) {
549 d->scrollbarParameters_.min = 0;
550 d->scrollbarParameters_.max = 0;
554 d->scrollbarParameters_.min = top_pos;
555 for (size_t i = 0; i != size_t(first.first); ++i)
556 d->scrollbarParameters_.min -= d->par_height_[i];
557 d->scrollbarParameters_.max = bottom_pos;
558 for (size_t i = last.first + 1; i != parsize; ++i)
559 d->scrollbarParameters_.max += d->par_height_[i];
561 d->scrollbarParameters_.position = 0;
562 // The reference is the top position so we remove one page.
563 if (lyxrc.scroll_below_document)
564 d->scrollbarParameters_.max -= minVisiblePart();
566 d->scrollbarParameters_.max -= d->scrollbarParameters_.page_step;
570 ScrollbarParameters const & BufferView::scrollbarParameters() const
572 return d->scrollbarParameters_;
576 docstring BufferView::toolTip(int x, int y) const
578 // Get inset under mouse, if there is one.
579 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
581 // No inset, no tooltip...
583 return covering_inset->toolTip(*this, x, y);
587 string BufferView::contextMenu(int x, int y) const
589 //If there is a selection, return the containing inset menu
590 if (d->cursor_.selection())
591 return d->cursor_.inset().contextMenu(*this, x, y);
593 // Get inset under mouse, if there is one.
594 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
596 return covering_inset->contextMenu(*this, x, y);
598 return buffer_.inset().contextMenu(*this, x, y);
602 void BufferView::scrollDocView(int value, bool update)
604 int const offset = value - d->scrollbarParameters_.position;
606 // No scrolling at all? No need to redraw anything
610 // If the offset is less than 2 screen height, prefer to scroll instead.
611 if (abs(offset) <= 2 * height_) {
612 d->anchor_ypos_ -= offset;
613 buffer_.changed(true);
614 updateHoveredInset();
618 // cut off at the top
619 if (value <= d->scrollbarParameters_.min) {
620 DocIterator dit = doc_iterator_begin(&buffer_);
621 showCursor(dit, false, update);
622 LYXERR(Debug::SCROLLING, "scroll to top");
626 // cut off at the bottom
627 if (value >= d->scrollbarParameters_.max) {
628 DocIterator dit = doc_iterator_end(&buffer_);
630 showCursor(dit, false, update);
631 LYXERR(Debug::SCROLLING, "scroll to bottom");
635 // find paragraph at target position
636 int par_pos = d->scrollbarParameters_.min;
638 for (; i != int(d->par_height_.size()); ++i) {
639 par_pos += d->par_height_[i];
640 if (par_pos >= value)
644 if (par_pos < value) {
645 // It seems we didn't find the correct pit so stay on the safe side and
647 LYXERR0("scrolling position not found!");
648 scrollDocView(d->scrollbarParameters_.max, update);
652 DocIterator dit = doc_iterator_begin(&buffer_);
654 LYXERR(Debug::SCROLLING, "value = " << value << " -> scroll to pit " << i);
655 showCursor(dit, false, update);
659 // FIXME: this method is not working well.
660 void BufferView::setCursorFromScrollbar()
662 TextMetrics & tm = d->text_metrics_[&buffer_.text()];
664 int const height = 2 * defaultRowHeight();
665 int const first = height;
666 int const last = height_ - height;
668 Cursor const & oldcur = d->cursor_;
670 switch (cursorStatus(oldcur)) {
678 int const y = getPos(oldcur).y_;
679 newy = min(last, max(y, first));
683 // We reset the cursor because cursorStatus() does not
684 // work when the cursor is within mathed.
687 tm.setCursorFromCoordinates(cur, 0, newy);
689 // update the bufferview cursor and notify insets
690 // FIXME: Care about the d->cursor_ flags to redraw if needed
691 Cursor old = d->cursor_;
693 // the DEPM call in mouseSetCursor() might have destroyed the
694 // paragraph the cursor is in.
695 bool badcursor = old.fixIfBroken();
696 badcursor |= notifyCursorLeavesOrEnters(old, d->cursor_);
698 d->cursor_.fixIfBroken();
702 Change const BufferView::getCurrentChange() const
704 if (!d->cursor_.selection())
705 return Change(Change::UNCHANGED);
707 DocIterator dit = d->cursor_.selectionBegin();
708 // The selected content might have been changed (see #7685)
709 while (dit.inMathed())
710 // Find enclosing text cursor
712 return dit.paragraph().lookupChange(dit.pos());
716 // this could be used elsewhere as well?
717 // FIXME: This does not work within mathed!
718 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
720 Point const p = getPos(dit);
723 if (p.y_ > workHeight())
729 void BufferView::bookmarkEditPosition()
731 // Don't eat cpu time for each keystroke
732 if (d->cursor_.paragraph().id() == d->bookmark_edit_position_)
735 d->bookmark_edit_position_ = d->cursor_.paragraph().id();
739 void BufferView::saveBookmark(unsigned int idx)
741 // tentatively save bookmark, id and pos will be used to
742 // acturately locate a bookmark in a 'live' lyx session.
743 // pit and pos will be updated with bottom level pit/pos
745 if (!buffer_.isInternal()) {
746 theSession().bookmarks().save(
748 d->cursor_.bottom().pit(),
749 d->cursor_.bottom().pos(),
750 d->cursor_.paragraph().id(),
755 // emit message signal.
756 message(_("Save bookmark"));
761 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
762 int top_id, pos_type top_pos)
764 bool success = false;
767 d->cursor_.clearSelection();
769 // if a valid par_id is given, try it first
770 // This is the case for a 'live' bookmark when unique paragraph ID
771 // is used to track bookmarks.
773 dit = buffer_.getParFromID(top_id);
775 dit.pos() = min(dit.paragraph().size(), top_pos);
776 // Some slices of the iterator may not be
777 // reachable (e.g. closed collapsable inset)
778 // so the dociterator may need to be
779 // shortened. Otherwise, setCursor may crash
780 // lyx when the cursor can not be set to these
782 size_t const n = dit.depth();
783 for (size_t i = 0; i < n; ++i)
784 if (!dit[i].inset().editable()) {
792 // if top_id == 0, or searching through top_id failed
793 // This is the case for a 'restored' bookmark when only bottom
794 // (document level) pit was saved. Because of this, bookmark
795 // restoration is inaccurate. If a bookmark was within an inset,
796 // it will be restored to the left of the outmost inset that contains
798 if (bottom_pit < int(buffer_.paragraphs().size())) {
799 dit = doc_iterator_begin(&buffer_);
801 dit.pit() = bottom_pit;
802 dit.pos() = min(bottom_pos, dit.paragraph().size());
807 // Note: only bottom (document) level pit is set.
809 // set the current font.
810 d->cursor_.setCurrentFont();
811 // To center the screen on this new position we need the
812 // paragraph position which is computed at draw() time.
813 // So we need a redraw!
814 buffer_.changed(false);
815 if (needsFitCursor())
823 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
825 if (d->cursor_.real_current_font.isRightToLeft()) {
826 if (d->intl_.keymap == Intl::PRIMARY)
827 d->intl_.keyMapSec();
829 if (d->intl_.keymap == Intl::SECONDARY)
830 d->intl_.keyMapPrim();
833 d->intl_.getTransManager().translateAndInsert(c, t, cur);
837 int BufferView::workWidth() const
843 void BufferView::recenter()
845 showCursor(d->cursor_, true, true);
849 void BufferView::showCursor()
851 showCursor(d->cursor_, false, true);
855 void BufferView::showCursor(DocIterator const & dit,
856 bool recenter, bool update)
858 if (scrollToCursor(dit, recenter) && update) {
859 buffer_.changed(true);
860 updateHoveredInset();
865 void BufferView::scrollToCursor()
867 if (scrollToCursor(d->cursor_, false)) {
868 buffer_.changed(true);
869 updateHoveredInset();
874 bool BufferView::scrollToCursor(DocIterator const & dit, bool recenter)
876 // We are not properly started yet, delay until resizing is
881 LYXERR(Debug::SCROLLING, "recentering!");
883 CursorSlice const & bot = dit.bottom();
884 TextMetrics & tm = d->text_metrics_[bot.text()];
886 pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
887 int bot_pit = bot.pit();
888 if (bot_pit > max_pit) {
889 // FIXME: Why does this happen?
890 LYXERR0("bottom pit is greater that max pit: "
891 << bot_pit << " > " << max_pit);
895 if (bot_pit == tm.first().first - 1)
896 tm.newParMetricsUp();
897 else if (bot_pit == tm.last().first + 1)
898 tm.newParMetricsDown();
900 if (tm.contains(bot_pit)) {
901 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
902 LBUFERR(!pm.rows().empty());
903 // FIXME: smooth scrolling doesn't work in mathed.
904 CursorSlice const & cs = dit.innerTextSlice();
905 int offset = coordOffset(dit).y_;
906 int ypos = pm.position() + offset;
907 Dimension const & row_dim =
908 pm.getRow(cs.pos(), dit.boundary()).dimension();
911 scrolled = scroll(ypos - height_/2);
913 // We try to visualize the whole row, if the row height is larger than
914 // the screen height, we scroll to a heuristic value of height_ / 4.
915 // FIXME: This heuristic value should be replaced by a recursive search
916 // for a row in the inset that can be visualized completely.
917 else if (row_dim.height() > height_) {
918 if (ypos < defaultRowHeight())
919 scrolled = scroll(ypos - height_ / 4);
920 else if (ypos > height_ - defaultRowHeight())
921 scrolled = scroll(ypos - 3 * height_ / 4);
924 // If the top part of the row falls of the screen, we scroll
925 // up to align the top of the row with the top of the screen.
926 else if (ypos - row_dim.ascent() < 0 && ypos < height_) {
927 int ynew = row_dim.ascent();
928 scrolled = scrollUp(ynew - ypos);
931 // If the bottom of the row falls of the screen, we scroll down.
932 else if (ypos + row_dim.descent() > height_ && ypos > 0) {
933 int ynew = height_ - row_dim.descent();
934 scrolled = scrollDown(ypos - ynew);
937 // else, nothing to do, the cursor is already visible so we just return.
938 return scrolled != 0;
941 // fix inline completion position
942 if (d->inlineCompletionPos_.fixIfBroken())
943 d->inlineCompletionPos_ = DocIterator();
945 tm.redoParagraph(bot_pit);
946 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
947 int offset = coordOffset(dit).y_;
949 d->anchor_pit_ = bot_pit;
950 CursorSlice const & cs = dit.innerTextSlice();
951 Dimension const & row_dim =
952 pm.getRow(cs.pos(), dit.boundary()).dimension();
955 d->anchor_ypos_ = height_/2;
956 else if (d->anchor_pit_ == 0)
957 d->anchor_ypos_ = offset + pm.ascent();
958 else if (d->anchor_pit_ == max_pit)
959 d->anchor_ypos_ = height_ - offset - row_dim.descent();
960 else if (offset > height_)
961 d->anchor_ypos_ = height_ - offset - defaultRowHeight();
963 d->anchor_ypos_ = defaultRowHeight() * 2;
969 void BufferView::makeDocumentClass()
971 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
972 buffer_.params().makeDocumentClass();
973 updateDocumentClass(olddc);
977 void BufferView::updateDocumentClass(DocumentClassConstPtr olddc)
979 message(_("Converting document to new document class..."));
981 StableDocIterator backcur(d->cursor_);
982 ErrorList & el = buffer_.errorList("Class Switch");
983 cap::switchBetweenClasses(
984 olddc, buffer_.params().documentClassPtr(),
985 static_cast<InsetText &>(buffer_.inset()), el);
987 setCursor(backcur.asDocIterator(&buffer_));
989 buffer_.errors("Class Switch");
993 /** Return the change status at cursor position, taking into account the
994 * status at each level of the document iterator (a table in a deleted
995 * footnote is deleted).
996 * When \param outer is true, the top slice is not looked at.
998 static Change::Type lookupChangeType(DocIterator const & dit, bool outer = false)
1000 size_t const depth = dit.depth() - (outer ? 1 : 0);
1002 for (size_t i = 0 ; i < depth ; ++i) {
1003 CursorSlice const & slice = dit[i];
1004 if (!slice.inset().inMathed()
1005 && slice.pos() < slice.paragraph().size()) {
1006 Change::Type const ch = slice.paragraph().lookupChange(slice.pos()).type;
1007 if (ch != Change::UNCHANGED)
1011 return Change::UNCHANGED;
1015 bool BufferView::getStatus(FuncRequest const & cmd, FuncStatus & flag)
1017 FuncCode const act = cmd.action();
1019 // Can we use a readonly buffer?
1020 if (buffer_.isReadonly()
1021 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1022 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1023 flag.message(from_utf8(N_("Document is read-only")));
1024 flag.setEnabled(false);
1028 // Are we in a DELETED change-tracking region?
1029 if (lookupChangeType(d->cursor_, true) == Change::DELETED
1030 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1031 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1032 flag.message(from_utf8(N_("This portion of the document is deleted.")));
1033 flag.setEnabled(false);
1037 Cursor & cur = d->cursor_;
1039 if (cur.getStatus(cmd, flag))
1044 // FIXME: This is a bit problematic because we don't check if this is
1045 // a document BufferView or not for these LFUNs. We probably have to
1046 // dispatch both to currentBufferView() and, if that fails,
1047 // to documentBufferView(); same as we do now for current Buffer and
1048 // document Buffer. Ideally those LFUN should go to Buffer as they
1049 // operate on the full Buffer and the cursor is only needed either for
1050 // an Undo record or to restore a cursor position. But we don't know
1051 // how to do that inside Buffer of course.
1052 case LFUN_BUFFER_PARAMS_APPLY:
1053 case LFUN_LAYOUT_MODULES_CLEAR:
1054 case LFUN_LAYOUT_MODULE_ADD:
1055 case LFUN_LAYOUT_RELOAD:
1056 case LFUN_TEXTCLASS_APPLY:
1057 case LFUN_TEXTCLASS_LOAD:
1058 flag.setEnabled(!buffer_.isReadonly());
1062 // We do not use the LyXAction flag for readonly because Undo sets the
1063 // buffer clean/dirty status by itself.
1064 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasUndoStack());
1067 // We do not use the LyXAction flag for readonly because Redo sets the
1068 // buffer clean/dirty status by itself.
1069 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasRedoStack());
1071 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
1072 case LFUN_FILE_INSERT_PLAINTEXT: {
1073 docstring const fname = cmd.argument();
1074 if (!FileName::isAbsolute(to_utf8(fname))) {
1075 flag.message(_("Absolute filename expected."));
1078 flag.setEnabled(cur.inTexted());
1081 case LFUN_FILE_INSERT:
1082 case LFUN_BOOKMARK_SAVE:
1083 // FIXME: Actually, these LFUNS should be moved to Text
1084 flag.setEnabled(cur.inTexted());
1087 case LFUN_FONT_STATE:
1088 case LFUN_LABEL_INSERT:
1089 case LFUN_INFO_INSERT:
1090 case LFUN_PARAGRAPH_GOTO:
1091 case LFUN_NOTE_NEXT:
1092 case LFUN_REFERENCE_NEXT:
1093 case LFUN_WORD_FIND:
1094 case LFUN_WORD_FIND_FORWARD:
1095 case LFUN_WORD_FIND_BACKWARD:
1096 case LFUN_WORD_REPLACE:
1099 case LFUN_MARK_TOGGLE:
1100 case LFUN_SCREEN_RECENTER:
1101 case LFUN_SCREEN_SHOW_CURSOR:
1102 case LFUN_BIBTEX_DATABASE_ADD:
1103 case LFUN_BIBTEX_DATABASE_DEL:
1104 case LFUN_STATISTICS:
1105 case LFUN_KEYMAP_OFF:
1106 case LFUN_KEYMAP_PRIMARY:
1107 case LFUN_KEYMAP_SECONDARY:
1108 case LFUN_KEYMAP_TOGGLE:
1109 case LFUN_INSET_SELECT_ALL:
1110 flag.setEnabled(true);
1113 case LFUN_WORD_FINDADV: {
1114 FindAndReplaceOptions opt;
1115 istringstream iss(to_utf8(cmd.argument()));
1117 flag.setEnabled(opt.repl_buf_name.empty()
1118 || !buffer_.isReadonly());
1122 case LFUN_LABEL_GOTO:
1123 flag.setEnabled(!cmd.argument().empty()
1124 || getInsetByCode<InsetRef>(cur, REF_CODE));
1127 case LFUN_CHANGES_MERGE:
1128 case LFUN_CHANGE_NEXT:
1129 case LFUN_CHANGE_PREVIOUS:
1130 case LFUN_ALL_CHANGES_ACCEPT:
1131 case LFUN_ALL_CHANGES_REJECT:
1132 // TODO: context-sensitive enabling of LFUNs
1133 // In principle, these command should only be enabled if there
1134 // is a change in the document. However, without proper
1135 // optimizations, this will inevitably result in poor performance.
1136 flag.setEnabled(true);
1139 case LFUN_SCREEN_UP:
1140 case LFUN_SCREEN_DOWN:
1142 case LFUN_SCREEN_UP_SELECT:
1143 case LFUN_SCREEN_DOWN_SELECT:
1144 case LFUN_INSET_FORALL:
1145 flag.setEnabled(true);
1148 case LFUN_LAYOUT_TABULAR:
1149 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
1153 flag.setEnabled(!cur.inset().forcePlainLayout(cur.idx()));
1156 case LFUN_LAYOUT_PARAGRAPH:
1157 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
1160 case LFUN_BRANCH_ADD_INSERT:
1161 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1164 case LFUN_DIALOG_SHOW_NEW_INSET:
1165 // FIXME: this is wrong, but I do not understand the
1167 if (cur.inset().lyxCode() == CAPTION_CODE)
1168 return cur.inset().getStatus(cur, cmd, flag);
1169 // FIXME we should consider passthru paragraphs too.
1170 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1173 case LFUN_CITATION_INSERT: {
1174 FuncRequest fr(LFUN_INSET_INSERT, "citation");
1175 // FIXME: This could turn in a recursive hell.
1176 // Shouldn't we use Buffer::getStatus() instead?
1177 flag.setEnabled(lyx::getStatus(fr).enabled());
1180 case LFUN_INSET_APPLY: {
1181 string const name = cmd.getArg(0);
1182 Inset * inset = editedInset(name);
1184 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1185 if (!inset->getStatus(cur, fr, flag)) {
1186 // Every inset is supposed to handle this
1187 LASSERT(false, break);
1190 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1191 flag = lyx::getStatus(fr);
1204 Inset * BufferView::editedInset(string const & name) const
1206 map<string, Inset *>::const_iterator it = d->edited_insets_.find(name);
1207 return it == d->edited_insets_.end() ? 0 : it->second;
1211 void BufferView::editInset(string const & name, Inset * inset)
1213 d->edited_insets_[name] = inset;
1217 void BufferView::dispatch(FuncRequest const & cmd, DispatchResult & dr)
1219 LYXERR(Debug::ACTION, "BufferView::dispatch: cmd: " << cmd);
1221 string const argument = to_utf8(cmd.argument());
1222 Cursor & cur = d->cursor_;
1225 // Don't dispatch function that does not apply to internal buffers.
1226 if (buffer_.isInternal()
1227 && lyxaction.funcHasFlag(cmd.action(), LyXAction::NoInternal))
1230 // We'll set this back to false if need be.
1231 bool dispatched = true;
1232 buffer_.undo().beginUndoGroup();
1234 FuncCode const act = cmd.action();
1237 case LFUN_BUFFER_PARAMS_APPLY: {
1238 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1239 cur.recordUndoBufferParams();
1240 istringstream ss(to_utf8(cmd.argument()));
1243 int const unknown_tokens = buffer_.readHeader(lex);
1244 if (unknown_tokens != 0) {
1245 LYXERR0("Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1246 << unknown_tokens << " unknown token"
1247 << (unknown_tokens == 1 ? "" : "s"));
1249 updateDocumentClass(olddc);
1251 // We are most certainly here because of a change in the document
1252 // It is then better to make sure that all dialogs are in sync with
1253 // current document settings.
1254 dr.screenUpdate(Update::Force | Update::FitCursor);
1255 dr.forceBufferUpdate();
1259 case LFUN_LAYOUT_MODULES_CLEAR: {
1260 // FIXME: this modifies the document in cap::switchBetweenClasses
1261 // without calling recordUndo. Fix this before using
1262 // recordUndoBufferParams().
1263 cur.recordUndoFullBuffer();
1264 buffer_.params().clearLayoutModules();
1265 makeDocumentClass();
1266 dr.screenUpdate(Update::Force);
1267 dr.forceBufferUpdate();
1271 case LFUN_LAYOUT_MODULE_ADD: {
1272 BufferParams const & params = buffer_.params();
1273 if (!params.layoutModuleCanBeAdded(argument)) {
1274 LYXERR0("Module `" << argument <<
1275 "' cannot be added due to failed requirements or "
1276 "conflicts with installed modules.");
1279 // FIXME: this modifies the document in cap::switchBetweenClasses
1280 // without calling recordUndo. Fix this before using
1281 // recordUndoBufferParams().
1282 cur.recordUndoFullBuffer();
1283 buffer_.params().addLayoutModule(argument);
1284 makeDocumentClass();
1285 dr.screenUpdate(Update::Force);
1286 dr.forceBufferUpdate();
1290 case LFUN_TEXTCLASS_APPLY: {
1291 // since this shortcircuits, the second call is made only if
1293 bool const success =
1294 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1295 LayoutFileList::get().load(argument, buffer_.filePath());
1297 docstring s = bformat(_("The document class `%1$s' "
1298 "could not be loaded."), from_utf8(argument));
1299 frontend::Alert::error(_("Could not load class"), s);
1303 LayoutFile const * old_layout = buffer_.params().baseClass();
1304 LayoutFile const * new_layout = &(LayoutFileList::get()[argument]);
1306 if (old_layout == new_layout)
1310 // Save the old, possibly modular, layout for use in conversion.
1311 // FIXME: this modifies the document in cap::switchBetweenClasses
1312 // without calling recordUndo. Fix this before using
1313 // recordUndoBufferParams().
1314 cur.recordUndoFullBuffer();
1315 buffer_.params().setBaseClass(argument);
1316 makeDocumentClass();
1317 dr.screenUpdate(Update::Force);
1318 dr.forceBufferUpdate();
1322 case LFUN_TEXTCLASS_LOAD: {
1323 // since this shortcircuits, the second call is made only if
1325 bool const success =
1326 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1327 LayoutFileList::get().load(argument, buffer_.filePath());
1329 docstring s = bformat(_("The document class `%1$s' "
1330 "could not be loaded."), from_utf8(argument));
1331 frontend::Alert::error(_("Could not load class"), s);
1336 case LFUN_LAYOUT_RELOAD: {
1337 LayoutFileIndex bc = buffer_.params().baseClassID();
1338 LayoutFileList::get().reset(bc);
1339 buffer_.params().setBaseClass(bc);
1340 makeDocumentClass();
1341 dr.screenUpdate(Update::Force);
1342 dr.forceBufferUpdate();
1347 dr.setMessage(_("Undo"));
1348 cur.clearSelection();
1349 if (!cur.textUndo())
1350 dr.setMessage(_("No further undo information"));
1352 dr.screenUpdate(Update::Force | Update::FitCursor);
1353 dr.forceBufferUpdate();
1357 dr.setMessage(_("Redo"));
1358 cur.clearSelection();
1359 if (!cur.textRedo())
1360 dr.setMessage(_("No further redo information"));
1362 dr.screenUpdate(Update::Force | Update::FitCursor);
1363 dr.forceBufferUpdate();
1366 case LFUN_FONT_STATE:
1367 dr.setMessage(cur.currentState());
1370 case LFUN_BOOKMARK_SAVE:
1371 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1374 case LFUN_LABEL_GOTO: {
1375 docstring label = cmd.argument();
1376 if (label.empty()) {
1378 getInsetByCode<InsetRef>(cur, REF_CODE);
1380 label = inset->getParam("reference");
1381 // persistent=false: use temp_bookmark
1385 if (!label.empty()) {
1387 // at the moment, this is redundant, since gotoLabel will
1388 // eventually call LFUN_PARAGRAPH_GOTO, but it seems best
1390 dr.screenUpdate(Update::Force | Update::FitCursor);
1395 case LFUN_PARAGRAPH_GOTO: {
1396 int const id = convert<int>(cmd.getArg(0));
1397 int const pos = convert<int>(cmd.getArg(1));
1399 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1400 b = theBufferList().next(b)) {
1403 cur.setCursor(b->getParFromID(id));
1405 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1409 LYXERR(Debug::INFO, "Paragraph " << cur.paragraph().id()
1410 << " found in buffer `"
1411 << b->absFileName() << "'.");
1413 if (b == &buffer_) {
1416 mouseSetCursor(cur);
1417 dr.screenUpdate(Update::Force | Update::FitCursor);
1419 // Switch to other buffer view and resend cmd
1420 lyx::dispatch(FuncRequest(
1421 LFUN_BUFFER_SWITCH, b->absFileName()));
1429 case LFUN_NOTE_NEXT:
1430 gotoInset(this, NOTE_CODE, false);
1433 case LFUN_REFERENCE_NEXT: {
1434 vector<InsetCode> tmp;
1435 tmp.push_back(LABEL_CODE);
1436 tmp.push_back(REF_CODE);
1437 gotoInset(this, tmp, true);
1441 case LFUN_CHANGE_NEXT:
1442 findNextChange(this);
1443 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1444 dr.screenUpdate(Update::Force | Update::FitCursor);
1447 case LFUN_CHANGE_PREVIOUS:
1448 findPreviousChange(this);
1449 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1450 dr.screenUpdate(Update::Force | Update::FitCursor);
1453 case LFUN_CHANGES_MERGE:
1454 if (findNextChange(this) || findPreviousChange(this)) {
1455 dr.screenUpdate(Update::Force | Update::FitCursor);
1456 dr.forceBufferUpdate();
1457 showDialog("changes");
1461 case LFUN_ALL_CHANGES_ACCEPT:
1462 // select complete document
1464 cur.selHandle(true);
1465 buffer_.text().cursorBottom(cur);
1466 // accept everything in a single step to support atomic undo
1467 buffer_.text().acceptOrRejectChanges(cur, Text::ACCEPT);
1469 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1470 dr.screenUpdate(Update::Force | Update::FitCursor);
1471 dr.forceBufferUpdate();
1474 case LFUN_ALL_CHANGES_REJECT:
1475 // select complete document
1477 cur.selHandle(true);
1478 buffer_.text().cursorBottom(cur);
1479 // reject everything in a single step to support atomic undo
1480 // Note: reject does not work recursively; the user may have to repeat the operation
1481 buffer_.text().acceptOrRejectChanges(cur, Text::REJECT);
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_WORD_FIND_FORWARD:
1489 case LFUN_WORD_FIND_BACKWARD: {
1491 // Would it maybe be better if this variable were view specific anyway?
1492 static docstring last_search;
1493 docstring searched_string;
1495 if (!cmd.argument().empty()) {
1496 last_search = cmd.argument();
1497 searched_string = cmd.argument();
1499 searched_string = last_search;
1502 if (searched_string.empty())
1505 bool const fw = act == LFUN_WORD_FIND_FORWARD;
1506 docstring const data =
1507 find2string(searched_string, true, false, fw);
1508 bool found = lyxfind(this, FuncRequest(LFUN_WORD_FIND, data));
1510 dr.screenUpdate(Update::Force | Update::FitCursor);
1520 case LFUN_WORD_FIND: {
1521 FuncRequest req = cmd;
1522 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1523 req = d->search_request_cache_;
1524 if (req.argument().empty()) {
1525 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, "findreplace"));
1528 if (lyxfind(this, req)) {
1529 dr.screenUpdate(Update::Force | Update::FitCursor);
1536 d->search_request_cache_ = req;
1540 case LFUN_WORD_REPLACE: {
1541 bool has_deleted = false;
1542 if (cur.selection()) {
1543 DocIterator beg = cur.selectionBegin();
1544 DocIterator end = cur.selectionEnd();
1545 if (beg.pit() == end.pit()) {
1546 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1547 if (!cur.inMathed() && cur.paragraph().isDeleted(p)) {
1554 if (lyxreplace(this, cmd, has_deleted)) {
1555 dr.forceBufferUpdate();
1556 dr.screenUpdate(Update::Force | Update::FitCursor);
1566 case LFUN_WORD_FINDADV: {
1567 FindAndReplaceOptions opt;
1568 istringstream iss(to_utf8(cmd.argument()));
1570 if (findAdv(this, opt)) {
1571 dr.screenUpdate(Update::Force | Update::FitCursor);
1582 cur.clearSelection();
1583 dr.setMessage(from_utf8(N_("Mark off")));
1587 cur.clearSelection();
1589 dr.setMessage(from_utf8(N_("Mark on")));
1592 case LFUN_MARK_TOGGLE:
1593 cur.setSelection(false);
1596 dr.setMessage(from_utf8(N_("Mark removed")));
1599 dr.setMessage(from_utf8(N_("Mark set")));
1604 case LFUN_SCREEN_SHOW_CURSOR:
1608 case LFUN_SCREEN_RECENTER:
1612 case LFUN_BIBTEX_DATABASE_ADD: {
1613 Cursor tmpcur = cur;
1614 findInset(tmpcur, BIBTEX_CODE, false);
1615 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1618 if (inset->addDatabase(cmd.argument())) {
1619 buffer_.invalidateBibfileCache();
1620 dr.forceBufferUpdate();
1626 case LFUN_BIBTEX_DATABASE_DEL: {
1627 Cursor tmpcur = cur;
1628 findInset(tmpcur, BIBTEX_CODE, false);
1629 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1632 if (inset->delDatabase(cmd.argument())) {
1633 buffer_.invalidateBibfileCache();
1634 dr.forceBufferUpdate();
1640 case LFUN_STATISTICS: {
1641 DocIterator from, to;
1642 if (cur.selection()) {
1643 from = cur.selectionBegin();
1644 to = cur.selectionEnd();
1646 from = doc_iterator_begin(&buffer_);
1647 to = doc_iterator_end(&buffer_);
1649 buffer_.updateStatistics(from, to);
1650 int const words = buffer_.wordCount();
1651 int const chars = buffer_.charCount(false);
1652 int const chars_blanks = buffer_.charCount(true);
1654 if (cur.selection())
1655 message = _("Statistics for the selection:");
1657 message = _("Statistics for the document:");
1660 message += bformat(_("%1$d words"), words);
1662 message += _("One word");
1664 if (chars_blanks != 1)
1665 message += bformat(_("%1$d characters (including blanks)"),
1668 message += _("One character (including blanks)");
1671 message += bformat(_("%1$d characters (excluding blanks)"),
1674 message += _("One character (excluding blanks)");
1676 Alert::information(_("Statistics"), message);
1680 case LFUN_SCREEN_UP:
1681 case LFUN_SCREEN_DOWN: {
1682 Point p = getPos(cur);
1683 // This code has been commented out to enable to scroll down a
1684 // document, even if there are large insets in it (see bug #5465).
1685 /*if (p.y_ < 0 || p.y_ > height_) {
1686 // The cursor is off-screen so recenter before proceeding.
1690 int const scrolled = scroll(act == LFUN_SCREEN_UP
1691 ? -height_ : height_);
1692 if (act == LFUN_SCREEN_UP && scrolled > -height_)
1694 if (act == LFUN_SCREEN_DOWN && scrolled < height_)
1695 p = Point(width_, height_);
1696 bool const in_texted = cur.inTexted();
1697 cur.setCursor(doc_iterator_begin(cur.buffer()));
1698 cur.selHandle(false);
1699 buffer_.changed(true);
1700 updateHoveredInset();
1702 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_,
1703 true, act == LFUN_SCREEN_UP);
1704 //FIXME: what to do with cur.x_target()?
1705 bool update = in_texted && cur.bv().checkDepm(cur, old);
1708 if (update || cur.mark())
1709 dr.screenUpdate(Update::Force | Update::FitCursor);
1711 dr.forceBufferUpdate();
1716 string const scroll_type = cmd.getArg(0);
1717 int scroll_step = 0;
1718 if (scroll_type == "line")
1719 scroll_step = d->scrollbarParameters_.single_step;
1720 else if (scroll_type == "page")
1721 scroll_step = d->scrollbarParameters_.page_step;
1724 string const scroll_quantity = cmd.getArg(1);
1725 if (scroll_quantity == "up")
1726 scrollUp(scroll_step);
1727 else if (scroll_quantity == "down")
1728 scrollDown(scroll_step);
1730 int const scroll_value = convert<int>(scroll_quantity);
1732 scroll(scroll_step * scroll_value);
1734 buffer_.changed(true);
1735 updateHoveredInset();
1736 dr.forceBufferUpdate();
1740 case LFUN_SCREEN_UP_SELECT: {
1741 // FIXME: why is the algorithm different from LFUN_SCREEN_UP?
1742 cur.selHandle(true);
1743 if (isTopScreen()) {
1744 lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1748 int y = getPos(cur).y_;
1749 int const ymin = y - height_ + defaultRowHeight();
1750 while (y > ymin && cur.up())
1754 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1758 case LFUN_SCREEN_DOWN_SELECT: {
1759 // FIXME: why is the algorithm different from LFUN_SCREEN_DOWN?
1760 cur.selHandle(true);
1761 if (isBottomScreen()) {
1762 lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1766 int y = getPos(cur).y_;
1767 int const ymax = y + height_ - defaultRowHeight();
1768 while (y < ymax && cur.down())
1772 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1777 case LFUN_INSET_SELECT_ALL:
1779 && cur.selBegin().at_begin()
1780 && cur.selEnd().at_end()) {
1781 // All the contents of the inset if selected.
1782 // Select the inset from outside.
1785 cur.setSelection(true);
1787 } else if (cur.selBegin().idx() != cur.selEnd().idx()
1789 && cur.selBegin().at_cell_begin()
1790 && cur.selEnd().at_cell_end())) {
1791 // At least one complete cell is selected.
1796 cur.setSelection(true);
1797 cur.idx() = cur.lastidx();
1798 cur.pos() = cur.lastpos();
1800 // select current cell
1804 cur.setSelection(true);
1805 cur.pit() = cur.lastpit();
1806 cur.pos() = cur.lastpos();
1808 cur.setCurrentFont();
1809 dr.screenUpdate(Update::Force);
1813 // This would be in Buffer class if only Cursor did not
1814 // require a bufferview
1815 case LFUN_INSET_FORALL: {
1816 docstring const name = from_utf8(cmd.getArg(0));
1817 string const commandstr = cmd.getLongArg(1);
1818 FuncRequest const fr = lyxaction.lookupFunc(commandstr);
1820 // an arbitrary number to limit number of iterations
1821 const int max_iter = 100000;
1823 Cursor & cur = d->cursor_;
1824 Cursor const savecur = cur;
1826 if (!cur.nextInset())
1828 cur.beginUndoGroup();
1829 while(cur && iterations < max_iter) {
1830 Inset * const ins = cur.nextInset();
1833 docstring insname = ins->layoutName();
1834 while (!insname.empty()) {
1835 if (insname == name || name == from_utf8("*")) {
1837 lyx::dispatch(fr, dr);
1841 size_t const i = insname.rfind(':');
1842 if (i == string::npos)
1844 insname = insname.substr(0, i);
1846 // if we did not delete the inset, skip it
1847 if (!cur.nextInset() || cur.nextInset() == ins)
1853 dr.screenUpdate(Update::Force);
1854 dr.forceBufferUpdate();
1856 if (iterations >= max_iter) {
1858 dr.setMessage(bformat(_("`inset-forall' interrupted because number of actions is larger than %1$d"), max_iter));
1860 dr.setMessage(bformat(_("Applied \"%1$s\" to %2$d insets"), from_utf8(commandstr), iterations));
1865 case LFUN_BRANCH_ADD_INSERT: {
1866 docstring branch_name = from_utf8(cmd.getArg(0));
1867 if (branch_name.empty())
1868 if (!Alert::askForText(branch_name, _("Branch name")) ||
1869 branch_name.empty())
1872 DispatchResult drtmp;
1873 buffer_.dispatch(FuncRequest(LFUN_BRANCH_ADD, branch_name), drtmp);
1874 if (drtmp.error()) {
1875 Alert::warning(_("Branch already exists"), drtmp.message());
1878 BranchList & branch_list = buffer_.params().branchlist();
1879 vector<docstring> const branches =
1880 getVectorFromString(branch_name, branch_list.separator());
1881 for (vector<docstring>::const_iterator it = branches.begin();
1882 it != branches.end(); ++it) {
1884 lyx::dispatch(FuncRequest(LFUN_BRANCH_INSERT, branch_name));
1889 case LFUN_KEYMAP_OFF:
1890 getIntl().keyMapOn(false);
1893 case LFUN_KEYMAP_PRIMARY:
1894 getIntl().keyMapPrim();
1897 case LFUN_KEYMAP_SECONDARY:
1898 getIntl().keyMapSec();
1901 case LFUN_KEYMAP_TOGGLE:
1902 getIntl().toggleKeyMap();
1905 case LFUN_DIALOG_SHOW_NEW_INSET: {
1906 string const name = cmd.getArg(0);
1907 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
1908 if (decodeInsetParam(name, data, buffer_))
1909 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
1911 lyxerr << "Inset type '" << name <<
1912 "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" << endl;
1916 case LFUN_CITATION_INSERT: {
1917 if (argument.empty()) {
1918 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
1921 // we can have one optional argument, delimited by '|'
1922 // citation-insert <key>|<text_before>
1923 // this should be enhanced to also support text_after
1924 // and citation style
1925 string arg = argument;
1927 if (contains(argument, "|")) {
1928 arg = token(argument, '|', 0);
1929 opt1 = token(argument, '|', 1);
1932 // if our cursor is directly in front of or behind a citation inset,
1933 // we will instead add the new key to it.
1934 Inset * inset = cur.nextInset();
1935 if (!inset || inset->lyxCode() != CITE_CODE)
1936 inset = cur.prevInset();
1937 if (inset && inset->lyxCode() == CITE_CODE) {
1938 InsetCitation * icite = static_cast<InsetCitation *>(inset);
1939 if (icite->addKey(arg)) {
1940 dr.forceBufferUpdate();
1941 dr.screenUpdate(Update::FitCursor | Update::SinglePar);
1943 LYXERR0("Discarding optional argument to citation-insert.");
1948 InsetCommandParams icp(CITE_CODE);
1949 icp["key"] = from_utf8(arg);
1951 icp["before"] = from_utf8(opt1);
1952 string icstr = InsetCommand::params2string(icp);
1953 FuncRequest fr(LFUN_INSET_INSERT, icstr);
1958 case LFUN_INSET_APPLY: {
1959 string const name = cmd.getArg(0);
1960 Inset * inset = editedInset(name);
1962 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1966 // put cursor in front of inset.
1967 if (!setCursorFromInset(inset)) {
1968 LASSERT(false, break);
1971 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1972 inset->dispatch(cur, fr);
1973 dr.screenUpdate(cur.result().screenUpdate());
1974 if (cur.result().needBufferUpdate())
1975 dr.forceBufferUpdate();
1980 // The change of language of buffer belongs to the Buffer class.
1981 // We have to do it here because we need a cursor for Undo.
1982 // When Undo::recordUndoBufferParams() is implemented someday
1983 // LFUN_BUFFER_LANGUAGE should be handled by the Buffer class.
1984 case LFUN_BUFFER_LANGUAGE: {
1985 Language const * oldL = buffer_.params().language;
1986 Language const * newL = languages.getLanguage(argument);
1987 if (!newL || oldL == newL)
1989 if (oldL->rightToLeft() == newL->rightToLeft()) {
1990 cur.recordUndoFullBuffer();
1991 buffer_.changeLanguage(oldL, newL);
1992 cur.setCurrentFont();
1993 dr.forceBufferUpdate();
1998 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
1999 case LFUN_FILE_INSERT_PLAINTEXT: {
2000 bool const as_paragraph = (act == LFUN_FILE_INSERT_PLAINTEXT_PARA);
2001 string const fname = to_utf8(cmd.argument());
2002 if (!FileName::isAbsolute(fname))
2003 dr.setMessage(_("Absolute filename expected."));
2005 insertPlaintextFile(FileName(fname), as_paragraph);
2010 // OK, so try the Buffer itself...
2011 buffer_.dispatch(cmd, dr);
2012 dispatched = dr.dispatched();
2016 buffer_.undo().endUndoGroup();
2017 dr.dispatched(dispatched);
2019 // NOTE: The code below is copied from Cursor::dispatch. If you
2020 // need to modify this, please update the other one too.
2022 // notify insets we just entered/left
2023 if (cursor() != old) {
2024 old.beginUndoGroup();
2026 bool badcursor = notifyCursorLeavesOrEnters(old, cursor());
2028 cursor().fixIfBroken();
2029 resetInlineCompletionPos();
2036 docstring const BufferView::requestSelection()
2038 Cursor & cur = d->cursor_;
2040 LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
2041 if (!cur.selection()) {
2042 d->xsel_cache_.set = false;
2046 LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
2047 if (!d->xsel_cache_.set ||
2048 cur.top() != d->xsel_cache_.cursor ||
2049 cur.realAnchor().top() != d->xsel_cache_.anchor)
2051 d->xsel_cache_.cursor = cur.top();
2052 d->xsel_cache_.anchor = cur.realAnchor().top();
2053 d->xsel_cache_.set = cur.selection();
2054 return cur.selectionAsString(false);
2060 void BufferView::clearSelection()
2062 d->cursor_.clearSelection();
2063 // Clear the selection buffer. Otherwise a subsequent
2064 // middle-mouse-button paste would use the selection buffer,
2065 // not the more current external selection.
2066 cap::clearSelection();
2067 d->xsel_cache_.set = false;
2068 // The buffer did not really change, but this causes the
2069 // redraw we need because we cleared the selection above.
2070 buffer_.changed(false);
2074 void BufferView::resize(int width, int height)
2076 // Update from work area
2080 // Clear the paragraph height cache.
2081 d->par_height_.clear();
2082 // Redo the metrics.
2087 Inset const * BufferView::getCoveringInset(Text const & text,
2090 TextMetrics & tm = d->text_metrics_[&text];
2091 Inset * inset = tm.checkInsetHit(x, y);
2095 if (!inset->descendable(*this))
2096 // No need to go further down if the inset is not
2100 size_t cell_number = inset->nargs();
2101 // Check all the inner cell.
2102 for (size_t i = 0; i != cell_number; ++i) {
2103 Text const * inner_text = inset->getText(i);
2106 Inset const * inset_deeper =
2107 getCoveringInset(*inner_text, x, y);
2109 return inset_deeper;
2117 void BufferView::updateHoveredInset() const
2119 // Get inset under mouse, if there is one.
2120 int const x = d->mouse_position_cache_.x_;
2121 int const y = d->mouse_position_cache_.y_;
2122 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
2124 d->clickable_inset_ = covering_inset && covering_inset->clickable(x, y);
2126 if (covering_inset == d->last_inset_)
2127 // Same inset, no need to do anything...
2130 bool need_redraw = false;
2131 if (d->last_inset_) {
2132 // Remove the hint on the last hovered inset (if any).
2133 need_redraw |= d->last_inset_->setMouseHover(this, false);
2137 if (covering_inset && covering_inset->setMouseHover(this, true)) {
2139 // Only the insets that accept the hover state, do
2140 // clear the last_inset_, so only set the last_inset_
2141 // member if the hovered setting is accepted.
2142 d->last_inset_ = covering_inset;
2146 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
2147 << d->mouse_position_cache_.x_ << ", "
2148 << d->mouse_position_cache_.y_ << ")");
2150 d->update_strategy_ = DecorationUpdate;
2152 // This event (moving without mouse click) is not passed further.
2153 // This should be changed if it is further utilized.
2154 buffer_.changed(false);
2159 void BufferView::clearLastInset(Inset * inset) const
2161 if (d->last_inset_ != inset) {
2162 LYXERR0("Wrong last_inset!");
2169 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
2171 //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
2173 // This is only called for mouse related events including
2174 // LFUN_FILE_OPEN generated by drag-and-drop.
2175 FuncRequest cmd = cmd0;
2177 Cursor old = cursor();
2179 cur.push(buffer_.inset());
2180 cur.setSelection(d->cursor_.selection());
2182 // Either the inset under the cursor or the
2183 // surrounding Text will handle this event.
2185 // make sure we stay within the screen...
2186 cmd.set_y(min(max(cmd.y(), -1), height_));
2188 d->mouse_position_cache_.x_ = cmd.x();
2189 d->mouse_position_cache_.y_ = cmd.y();
2191 if (cmd.action() == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
2192 updateHoveredInset();
2196 // Build temporary cursor.
2197 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x(), cmd.y());
2199 // If inset is not editable, cur.pos() might point behind the
2200 // inset (depending on cmd.x(), cmd.y()). This is needed for
2201 // editing to fix bug 9628, but e.g. the context menu needs a
2202 // cursor in front of the inset.
2203 if (inset->hasSettings() &&
2204 cur.nextInset() != inset && cur.prevInset() == inset)
2208 // Put anchor at the same position.
2211 cur.beginUndoGroup();
2213 // Try to dispatch to an non-editable inset near this position
2214 // via the temp cursor. If the inset wishes to change the real
2215 // cursor it has to do so explicitly by using
2216 // cur.bv().cursor() = cur; (or similar)
2218 inset->dispatch(cur, cmd);
2220 // Now dispatch to the temporary cursor. If the real cursor should
2221 // be modified, the inset's dispatch has to do so explicitly.
2222 if (!inset || !cur.result().dispatched())
2227 // Notify left insets
2229 bool badcursor = old.fixIfBroken() | cur.fixIfBroken();
2230 badcursor |= notifyCursorLeavesOrEnters(old, cur);
2232 cursor().fixIfBroken();
2235 // Do we have a selection?
2236 theSelection().haveSelection(cursor().selection());
2238 if (cur.needBufferUpdate()) {
2239 cur.clearBufferUpdate();
2240 buffer().updateBuffer();
2243 // If the command has been dispatched,
2244 if (cur.result().dispatched() || cur.result().screenUpdate())
2245 processUpdateFlags(cur.result().screenUpdate());
2249 int BufferView::minVisiblePart()
2251 return 2 * defaultRowHeight();
2255 int BufferView::scroll(int y)
2258 return scrollDown(y);
2260 return scrollUp(-y);
2265 int BufferView::scrollDown(int offset)
2267 Text * text = &buffer_.text();
2268 TextMetrics & tm = d->text_metrics_[text];
2269 int const ymax = height_ + offset;
2271 pair<pit_type, ParagraphMetrics const *> last = tm.last();
2272 int bottom_pos = last.second->position() + last.second->descent();
2273 if (lyxrc.scroll_below_document)
2274 bottom_pos += height_ - minVisiblePart();
2275 if (last.first + 1 == int(text->paragraphs().size())) {
2276 if (bottom_pos <= height_)
2278 offset = min(offset, bottom_pos - height_);
2281 if (bottom_pos > ymax)
2283 tm.newParMetricsDown();
2285 d->anchor_ypos_ -= offset;
2290 int BufferView::scrollUp(int offset)
2292 Text * text = &buffer_.text();
2293 TextMetrics & tm = d->text_metrics_[text];
2294 int ymin = - offset;
2296 pair<pit_type, ParagraphMetrics const *> first = tm.first();
2297 int top_pos = first.second->position() - first.second->ascent();
2298 if (first.first == 0) {
2301 offset = min(offset, - top_pos);
2306 tm.newParMetricsUp();
2308 d->anchor_ypos_ += offset;
2313 void BufferView::setCursorFromRow(int row)
2315 setCursorFromRow(row, buffer_.texrow());
2319 void BufferView::setCursorFromRow(int row, TexRow const & texrow)
2323 pit_type newpit = 0;
2324 pos_type newpos = 0;
2326 texrow.getIdFromRow(row, tmpid, tmppos);
2328 bool posvalid = (tmpid != -1);
2330 // we need to make sure that the row and position
2331 // we got back are valid, because the buffer may well
2332 // have changed since we last generated the LaTeX.
2333 DocIterator dit = buffer_.getParFromID(tmpid);
2334 if (dit == doc_iterator_end(&buffer_))
2336 else if (dit.depth() > 1) {
2337 // We are in an inset.
2338 pos_type lastpos = dit.lastpos();
2339 dit.pos() = tmppos > lastpos ? lastpos : tmppos;
2345 // now have to check pos.
2347 Paragraph const & par = buffer_.text().getPar(newpit);
2348 if (newpos > par.size()) {
2349 LYXERR0("Requested position no longer valid.");
2350 newpos = par.size() - 1;
2355 frontend::Alert::error(_("Inverse Search Failed"),
2356 _("Invalid position requested by inverse search.\n"
2357 "You need to update the viewed document."));
2361 buffer_.text().setCursor(d->cursor_, newpit, newpos);
2362 d->cursor_.setSelection(false);
2363 d->cursor_.resetAnchor();
2368 bool BufferView::setCursorFromInset(Inset const * inset)
2370 // are we already there?
2371 if (cursor().nextInset() == inset)
2374 // Inset is not at cursor position. Find it in the document.
2377 while (cur && cur.nextInset() != inset)
2388 void BufferView::gotoLabel(docstring const & label)
2390 ListOfBuffers bufs = buffer().allRelatives();
2391 ListOfBuffers::iterator it = bufs.begin();
2392 for (; it != bufs.end(); ++it) {
2393 Buffer const * buf = *it;
2396 shared_ptr<Toc> toc = buf->tocBackend().toc("label");
2397 TocIterator toc_it = toc->begin();
2398 TocIterator end = toc->end();
2399 for (; toc_it != end; ++toc_it) {
2400 if (label == toc_it->str()) {
2401 lyx::dispatch(toc_it->action());
2409 TextMetrics const & BufferView::textMetrics(Text const * t) const
2411 return const_cast<BufferView *>(this)->textMetrics(t);
2415 TextMetrics & BufferView::textMetrics(Text const * t)
2418 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
2419 if (tmc_it == d->text_metrics_.end()) {
2420 tmc_it = d->text_metrics_.insert(
2421 make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
2423 return tmc_it->second;
2427 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
2430 return textMetrics(t).parMetrics(pit);
2434 int BufferView::workHeight() const
2440 void BufferView::setCursor(DocIterator const & dit)
2443 size_t const n = dit.depth();
2444 for (size_t i = 0; i < n; ++i)
2445 dit[i].inset().edit(d->cursor_, true);
2447 d->cursor_.setCursor(dit);
2448 d->cursor_.setSelection(false);
2449 d->cursor_.setCurrentFont();
2451 // It seems on general grounds as if this is probably needed, but
2452 // it is not yet clear.
2453 // See bug #7394 and r38388.
2454 // d->cursor.resetAnchor();
2458 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
2460 // Would be wrong to delete anything if we have a selection.
2461 if (cur.selection())
2464 bool need_anchor_change = false;
2465 bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
2466 need_anchor_change);
2468 if (need_anchor_change)
2476 // we would rather not do this here, but it needs to be done before
2477 // the changed() signal is sent.
2478 buffer_.updateBuffer();
2480 buffer_.changed(true);
2485 bool BufferView::mouseSetCursor(Cursor & cur, bool select)
2487 LASSERT(&cur.bv() == this, return false);
2490 // this event will clear selection so we save selection for
2491 // persistent selection
2492 cap::saveSelection(cursor());
2494 d->cursor_.macroModeClose();
2495 // If a macro has been finalized, the cursor might have been broken
2498 // Has the cursor just left the inset?
2499 bool const leftinset = (&d->cursor_.inset() != &cur.inset());
2501 d->cursor_.fixIfBroken();
2503 // FIXME: shift-mouse selection doesn't work well across insets.
2504 bool const do_selection =
2505 select && &d->cursor_.normalAnchor().inset() == &cur.inset();
2507 // do the dEPM magic if needed
2508 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
2509 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
2510 // the leftinset bool would not be necessary (badcursor instead).
2511 bool update = leftinset;
2512 if (!do_selection && d->cursor_.inTexted())
2513 update |= checkDepm(cur, d->cursor_);
2516 d->cursor_.resetAnchor();
2517 d->cursor_.setCursor(cur);
2518 d->cursor_.boundary(cur.boundary());
2520 d->cursor_.setSelection();
2522 d->cursor_.clearSelection();
2524 d->cursor_.finishUndo();
2525 d->cursor_.setCurrentFont();
2527 cur.forceBufferUpdate();
2532 void BufferView::putSelectionAt(DocIterator const & cur,
2533 int length, bool backwards)
2535 d->cursor_.clearSelection();
2541 d->cursor_.pos() += length;
2542 d->cursor_.setSelection(d->cursor_, -length);
2544 d->cursor_.setSelection(d->cursor_, length);
2549 bool BufferView::selectIfEmpty(DocIterator & cur)
2551 if ((cur.inTexted() && !cur.paragraph().empty())
2552 || (cur.inMathed() && !cur.cell().empty()))
2555 pit_type const beg_pit = cur.pit();
2557 // The paragraph associated to this item isn't
2558 // the first one, so it can be selected
2561 // We have to resort to select the space between the
2562 // end of this item and the begin of the next one
2566 // If it is the only item in the document,
2567 // nothing can be selected
2570 pit_type const end_pit = cur.pit();
2571 pos_type const end_pos = cur.pos();
2572 d->cursor_.clearSelection();
2574 d->cursor_.setCursor(cur);
2575 d->cursor_.pit() = beg_pit;
2576 d->cursor_.pos() = 0;
2577 d->cursor_.setSelection(false);
2578 d->cursor_.resetAnchor();
2579 d->cursor_.pit() = end_pit;
2580 d->cursor_.pos() = end_pos;
2581 d->cursor_.setSelection();
2586 Cursor & BufferView::cursor()
2592 Cursor const & BufferView::cursor() const
2598 pit_type BufferView::anchor_ref() const
2600 return d->anchor_pit_;
2604 bool BufferView::singleParUpdate()
2606 Text & buftext = buffer_.text();
2607 pit_type const bottom_pit = d->cursor_.bottom().pit();
2608 TextMetrics & tm = textMetrics(&buftext);
2609 int old_height = tm.parMetrics(bottom_pit).height();
2611 // make sure inline completion pointer is ok
2612 if (d->inlineCompletionPos_.fixIfBroken())
2613 d->inlineCompletionPos_ = DocIterator();
2615 // In Single Paragraph mode, rebreak only
2616 // the (main text, not inset!) paragraph containing the cursor.
2617 // (if this paragraph contains insets etc., rebreaking will
2618 // recursively descend)
2619 tm.redoParagraph(bottom_pit);
2620 ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
2621 if (pm.height() != old_height)
2622 // Paragraph height has changed so we cannot proceed to
2623 // the singlePar optimisation.
2626 d->update_strategy_ = SingleParUpdate;
2628 LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
2629 << " y2: " << pm.position() + pm.descent()
2630 << " pit: " << bottom_pit
2631 << " singlepar: 1");
2636 void BufferView::updateMetrics()
2638 if (height_ == 0 || width_ == 0)
2641 Text & buftext = buffer_.text();
2642 pit_type const npit = int(buftext.paragraphs().size());
2644 // Clear out the position cache in case of full screen redraw,
2645 d->coord_cache_.clear();
2647 // Clear out paragraph metrics to avoid having invalid metrics
2648 // in the cache from paragraphs not relayouted below
2649 // The complete text metrics will be redone.
2650 d->text_metrics_.clear();
2652 TextMetrics & tm = textMetrics(&buftext);
2654 // make sure inline completion pointer is ok
2655 if (d->inlineCompletionPos_.fixIfBroken())
2656 d->inlineCompletionPos_ = DocIterator();
2658 if (d->anchor_pit_ >= npit)
2659 // The anchor pit must have been deleted...
2660 d->anchor_pit_ = npit - 1;
2662 // Rebreak anchor paragraph.
2663 tm.redoParagraph(d->anchor_pit_);
2664 ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
2667 if (d->anchor_pit_ == 0) {
2668 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
2670 // Complete buffer visible? Then it's easy.
2671 if (scrollRange == 0)
2672 d->anchor_ypos_ = anchor_pm.ascent();
2674 // FIXME: Some clever handling needed to show
2675 // the _first_ paragraph up to the top if the cursor is
2676 // in the first line.
2678 anchor_pm.setPosition(d->anchor_ypos_);
2680 LYXERR(Debug::PAINTING, "metrics: "
2681 << " anchor pit = " << d->anchor_pit_
2682 << " anchor ypos = " << d->anchor_ypos_);
2684 // Redo paragraphs above anchor if necessary.
2685 int y1 = d->anchor_ypos_ - anchor_pm.ascent();
2686 // We are now just above the anchor paragraph.
2687 pit_type pit1 = d->anchor_pit_ - 1;
2688 for (; pit1 >= 0 && y1 >= 0; --pit1) {
2689 tm.redoParagraph(pit1);
2690 ParagraphMetrics & pm = tm.par_metrics_[pit1];
2692 // Save the paragraph position in the cache.
2697 // Redo paragraphs below the anchor if necessary.
2698 int y2 = d->anchor_ypos_ + anchor_pm.descent();
2699 // We are now just below the anchor paragraph.
2700 pit_type pit2 = d->anchor_pit_ + 1;
2701 for (; pit2 < npit && y2 <= height_; ++pit2) {
2702 tm.redoParagraph(pit2);
2703 ParagraphMetrics & pm = tm.par_metrics_[pit2];
2705 // Save the paragraph position in the cache.
2710 LYXERR(Debug::PAINTING, "Metrics: "
2711 << " anchor pit = " << d->anchor_pit_
2712 << " anchor ypos = " << d->anchor_ypos_
2715 << " pit1 = " << pit1
2716 << " pit2 = " << pit2);
2718 d->update_strategy_ = FullScreenUpdate;
2720 if (lyxerr.debugging(Debug::WORKAREA)) {
2721 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
2722 d->coord_cache_.dump();
2727 void BufferView::insertLyXFile(FileName const & fname)
2729 LASSERT(d->cursor_.inTexted(), return);
2731 // Get absolute path of file and add ".lyx"
2732 // to the filename if necessary
2733 FileName filename = fileSearch(string(), fname.absFileName(), "lyx");
2735 docstring const disp_fn = makeDisplayPath(filename.absFileName());
2736 // emit message signal.
2737 message(bformat(_("Inserting document %1$s..."), disp_fn));
2740 Buffer buf(filename.absFileName(), false);
2741 if (buf.loadLyXFile() == Buffer::ReadSuccess) {
2742 ErrorList & el = buffer_.errorList("Parse");
2743 // Copy the inserted document error list into the current buffer one.
2744 el = buf.errorList("Parse");
2745 buffer_.undo().recordUndo(d->cursor_);
2746 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
2747 buf.params().documentClassPtr(), el);
2748 res = _("Document %1$s inserted.");
2750 res = _("Could not insert document %1$s");
2753 buffer_.changed(true);
2754 // emit message signal.
2755 message(bformat(res, disp_fn));
2759 Point BufferView::coordOffset(DocIterator const & dit) const
2765 // Addup contribution of nested insets, from inside to outside,
2766 // keeping the outer paragraph for a special handling below
2767 for (size_t i = dit.depth() - 1; i >= 1; --i) {
2768 CursorSlice const & sl = dit[i];
2772 // get relative position inside sl.inset()
2773 sl.inset().cursorPos(*this, sl, dit.boundary() && (i + 1 == dit.depth()), xx, yy);
2775 // Make relative position inside of the edited inset relative to sl.inset()
2779 // In case of an RTL inset, the edited inset will be positioned to the left
2782 bool boundary_i = dit.boundary() && i + 1 == dit.depth();
2783 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2788 // remember width for the case that sl.inset() is positioned in an RTL inset
2789 if (i && dit[i - 1].text()) {
2790 // If this Inset is inside a Text Inset, retrieve the Dimension
2791 // from the containing text instead of using Inset::dimension() which
2792 // might not be implemented.
2793 // FIXME (Abdel 23/09/2007): this is a bit messy because of the
2794 // elimination of Inset::dim_ cache. This coordOffset() method needs
2795 // to be rewritten in light of the new design.
2796 Dimension const & dim = coordCache().getInsets().dim(&sl.inset());
2799 Dimension const dim = sl.inset().dimension(*this);
2803 //lyxerr << "Cursor::getPos, i: "
2804 // << i << " x: " << xx << " y: " << y << endl;
2807 // Add contribution of initial rows of outermost paragraph
2808 CursorSlice const & sl = dit[0];
2809 TextMetrics const & tm = textMetrics(sl.text());
2810 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2812 LBUFERR(!pm.rows().empty());
2813 y -= pm.rows()[0].ascent();
2815 // FIXME: document this mess
2817 if (sl.pos() > 0 && dit.depth() == 1) {
2819 if (pos && dit.boundary())
2821 // lyxerr << "coordOffset: boundary:" << dit.boundary() << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
2822 rend = pm.pos2row(pos);
2824 rend = pm.pos2row(sl.pos());
2826 size_t rend = pm.pos2row(sl.pos());
2828 for (size_t rit = 0; rit != rend; ++rit)
2829 y += pm.rows()[rit].height();
2830 y += pm.rows()[rend].ascent();
2832 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
2834 // Make relative position from the nested inset now bufferview absolute.
2835 int xx = bottom_tm.cursorX(dit.bottom(), dit.boundary() && dit.depth() == 1);
2838 // In the RTL case place the nested inset at the left of the cursor in
2839 // the outer paragraph
2840 bool boundary_1 = dit.boundary() && 1 == dit.depth();
2841 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
2849 Point BufferView::getPos(DocIterator const & dit) const
2851 if (!paragraphVisible(dit))
2852 return Point(-1, -1);
2854 CursorSlice const & bot = dit.bottom();
2855 TextMetrics const & tm = textMetrics(bot.text());
2857 // offset from outer paragraph
2858 Point p = coordOffset(dit);
2859 p.y_ += tm.parMetrics(bot.pit()).position();
2864 bool BufferView::paragraphVisible(DocIterator const & dit) const
2866 CursorSlice const & bot = dit.bottom();
2867 TextMetrics const & tm = textMetrics(bot.text());
2869 return tm.contains(bot.pit());
2873 void BufferView::cursorPosAndHeight(Point & p, int & h) const
2875 Cursor const & cur = cursor();
2876 Font const font = cur.getFont();
2877 frontend::FontMetrics const & fm = theFontMetrics(font);
2878 int const asc = fm.maxAscent();
2879 int const des = fm.maxDescent();
2886 bool BufferView::cursorInView(Point const & p, int h) const
2888 Cursor const & cur = cursor();
2889 // does the cursor touch the screen ?
2890 if (p.y_ + h < 0 || p.y_ >= workHeight() || !paragraphVisible(cur))
2896 int BufferView::horizScrollOffset() const
2898 return d->horiz_scroll_offset_;
2902 CursorSlice const & BufferView::currentRowSlice() const
2904 return d->current_row_slice_;
2908 CursorSlice const & BufferView::lastRowSlice() const
2910 return d->last_row_slice_;
2914 void BufferView::setCurrentRowSlice(CursorSlice const & rowSlice)
2916 // nothing to do if the cursor was already on this row
2917 if (d->current_row_slice_ == rowSlice) {
2918 d->last_row_slice_ = CursorSlice();
2922 // if the (previous) current row was scrolled, we have to
2923 // remember it in order to repaint it next time.
2924 if (d->horiz_scroll_offset_ != 0)
2925 d->last_row_slice_ = d->current_row_slice_;
2927 d->last_row_slice_ = CursorSlice();
2929 // Since we changed row, the scroll offset is not valid anymore
2930 d->horiz_scroll_offset_ = 0;
2931 d->current_row_slice_ = rowSlice;
2935 void BufferView::checkCursorScrollOffset(PainterInfo & pi)
2937 CursorSlice rowSlice = d->cursor_.bottom();
2938 TextMetrics const & tm = textMetrics(rowSlice.text());
2940 // Stop if metrics have not been computed yet, since it means
2941 // that there is nothing to do.
2942 if (!tm.contains(rowSlice.pit()))
2944 ParagraphMetrics const & pm = tm.parMetrics(rowSlice.pit());
2945 Row const & row = pm.getRow(rowSlice.pos(),
2946 d->cursor_.boundary() && rowSlice == d->cursor_.top());
2947 rowSlice.pos() = row.pos();
2949 // Set the row on which the cursor lives.
2950 setCurrentRowSlice(rowSlice);
2952 // Current x position of the cursor in pixels
2953 int cur_x = getPos(d->cursor_).x_;
2955 // If cursor offset is left margin and offset is not the leftmost
2956 // position of the row, there is a cache problem.
2957 if (cur_x == row.left_margin && !row.empty()
2958 && d->cursor_.pos() != row.front().left_pos()) {
2959 /** FIXME: the code below adds an extraneous computation of
2960 * inset positions, and can therefore be bad for performance
2961 * (think for example about a very large tabular inset.
2962 * Redawing the row where it is means redrawing the whole
2965 * The bug that this fixes is the following: assume that there
2966 * is a very large math inset. Upon entering the inset, when
2967 * pressing `End', the row is not scrolled and the cursor is
2968 * not visible. The extra row computation makes sure that the
2969 * inset positions are correctly computed and set in the
2970 * cache. This would not happen if we did not have two-stage
2973 * A proper fix should be found and this code should be removed.
2975 // Force the recomputation of inset positions
2976 bool const drawing = pi.pain.isDrawingEnabled();
2977 pi.pain.setDrawingEnabled(false);
2978 // No need to care about vertical position.
2979 RowPainter rp(pi, buffer().text(), d->cursor_.bottom().pit(), row,
2980 -d->horiz_scroll_offset_, 0);
2982 pi.pain.setDrawingEnabled(drawing);
2984 // Recompute current Current x position of the cursor in pixels
2985 cur_x = getPos(d->cursor_).x_;
2988 // Horizontal scroll offset of the cursor row in pixels
2989 int offset = d->horiz_scroll_offset_;
2990 int const MARGIN = 2 * theFontMetrics(d->cursor_.real_current_font).em()
2992 if (row.right_x() <= workWidth() - row.right_margin) {
2993 // Row is narrower than the work area, no offset needed.
2996 if (cur_x - offset < MARGIN) {
2997 // cursor would be too far right
2998 offset = cur_x - MARGIN;
2999 } else if (cur_x - offset > workWidth() - MARGIN) {
3000 // cursor would be too far left
3001 offset = cur_x - workWidth() + MARGIN;
3003 // Correct the offset to make sure that we do not scroll too much
3006 if (row.right_x() - offset < workWidth() - row.right_margin)
3007 offset = row.right_x() - workWidth() + row.right_margin;
3010 //lyxerr << "cur_x=" << cur_x << ", offset=" << offset << ", row.wid=" << row.width() << ", margin=" << MARGIN << endl;
3012 if (offset != d->horiz_scroll_offset_)
3013 LYXERR(Debug::PAINTING, "Horiz. scroll offset changed from "
3014 << d->horiz_scroll_offset_ << " to " << offset);
3016 if (d->update_strategy_ == NoScreenUpdate
3017 && (offset != d->horiz_scroll_offset_
3018 || !d->last_row_slice_.empty())) {
3019 // FIXME: if one uses SingleParUpdate, then home/end
3020 // will not work on long rows. Why?
3021 d->update_strategy_ = FullScreenUpdate;
3024 d->horiz_scroll_offset_ = offset;
3028 void BufferView::draw(frontend::Painter & pain)
3030 if (height_ == 0 || width_ == 0)
3032 LYXERR(Debug::PAINTING, "\t\t*** START DRAWING ***");
3034 Text & text = buffer_.text();
3035 TextMetrics const & tm = d->text_metrics_[&text];
3036 int const y = tm.first().second->position();
3037 PainterInfo pi(this, pain);
3039 // Check whether the row where the cursor lives needs to be scrolled.
3040 // Update the drawing strategy if needed.
3041 checkCursorScrollOffset(pi);
3043 switch (d->update_strategy_) {
3045 case NoScreenUpdate:
3046 // If no screen painting is actually needed, only some the different
3047 // coordinates of insets and paragraphs needs to be updated.
3048 LYXERR(Debug::PAINTING, "Strategy: NoScreenUpdate");
3049 pi.full_repaint = true;
3050 pi.pain.setDrawingEnabled(false);
3054 case SingleParUpdate:
3055 pi.full_repaint = false;
3056 LYXERR(Debug::PAINTING, "Strategy: SingleParUpdate");
3057 // In general, only the current row of the outermost paragraph
3058 // will be redrawn. Particular cases where selection spans
3059 // multiple paragraph are correctly detected in TextMetrics.
3063 case DecorationUpdate:
3064 // FIXME: We should also distinguish DecorationUpdate to avoid text
3065 // drawing if possible. This is not possible to do easily right now
3066 // because of the single backing pixmap.
3068 case FullScreenUpdate:
3070 LYXERR(Debug::PAINTING,
3071 ((d->update_strategy_ == FullScreenUpdate)
3072 ? "Strategy: FullScreenUpdate"
3073 : "Strategy: DecorationUpdate"));
3075 // The whole screen, including insets, will be refreshed.
3076 pi.full_repaint = true;
3078 // Clear background.
3079 pain.fillRectangle(0, 0, width_, height_,
3080 pi.backgroundColor(&buffer_.inset()));
3085 // and possibly grey out below
3086 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3087 int const y2 = lastpm.second->position() + lastpm.second->descent();
3090 Color color = buffer().isInternal()
3091 ? Color_background : Color_bottomarea;
3092 pain.fillRectangle(0, y2, width_, height_ - y2, color);
3096 LYXERR(Debug::PAINTING, "\n\t\t*** END DRAWING ***");
3098 // The scrollbar needs an update.
3101 // Normalize anchor for next time
3102 pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
3103 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3104 for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
3105 ParagraphMetrics const & pm = tm.parMetrics(pit);
3106 if (pm.position() + pm.descent() > 0) {
3107 d->anchor_pit_ = pit;
3108 d->anchor_ypos_ = pm.position();
3112 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
3113 << " anchor ypos = " << d->anchor_ypos_);
3117 void BufferView::message(docstring const & msg)
3120 d->gui_->message(msg);
3124 void BufferView::showDialog(string const & name)
3127 d->gui_->showDialog(name, string());
3131 void BufferView::showDialog(string const & name,
3132 string const & data, Inset * inset)
3135 d->gui_->showDialog(name, data, inset);
3139 void BufferView::updateDialog(string const & name, string const & data)
3142 d->gui_->updateDialog(name, data);
3146 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
3152 // FIXME: Move this out of BufferView again
3153 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
3155 if (!fname.isReadableFile()) {
3156 docstring const error = from_ascii(strerror(errno));
3157 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3158 docstring const text =
3159 bformat(_("Could not read the specified document\n"
3160 "%1$s\ndue to the error: %2$s"), file, error);
3161 Alert::error(_("Could not read file"), text);
3165 if (!fname.isReadableFile()) {
3166 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3167 docstring const text =
3168 bformat(_("%1$s\n is not readable."), file);
3169 Alert::error(_("Could not open file"), text);
3173 // FIXME UNICODE: We don't know the encoding of the file
3174 docstring file_content = fname.fileContents("UTF-8");
3175 if (file_content.empty()) {
3176 Alert::error(_("Reading not UTF-8 encoded file"),
3177 _("The file is not UTF-8 encoded.\n"
3178 "It will be read as local 8Bit-encoded.\n"
3179 "If this does not give the correct result\n"
3180 "then please change the encoding of the file\n"
3181 "to UTF-8 with a program other than LyX.\n"));
3182 file_content = fname.fileContents("local8bit");
3185 return normalize_c(file_content);
3189 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
3191 docstring const tmpstr = contentsOfPlaintextFile(f);
3196 Cursor & cur = cursor();
3197 cap::replaceSelection(cur);
3198 buffer_.undo().recordUndo(cur);
3200 cur.innerText()->insertStringAsParagraphs(cur, tmpstr, cur.current_font);
3202 cur.innerText()->insertStringAsLines(cur, tmpstr, cur.current_font);
3204 buffer_.changed(true);
3208 docstring const & BufferView::inlineCompletion() const
3210 return d->inlineCompletion_;
3214 size_t const & BufferView::inlineCompletionUniqueChars() const
3216 return d->inlineCompletionUniqueChars_;
3220 DocIterator const & BufferView::inlineCompletionPos() const
3222 return d->inlineCompletionPos_;
3226 void BufferView::resetInlineCompletionPos()
3228 d->inlineCompletionPos_ = DocIterator();
3232 bool samePar(DocIterator const & a, DocIterator const & b)
3234 if (a.empty() && b.empty())
3236 if (a.empty() || b.empty())
3238 if (a.depth() != b.depth())
3240 return &a.innerParagraph() == &b.innerParagraph();
3244 void BufferView::setInlineCompletion(Cursor const & cur, DocIterator const & pos,
3245 docstring const & completion, size_t uniqueChars)
3247 uniqueChars = min(completion.size(), uniqueChars);
3248 bool changed = d->inlineCompletion_ != completion
3249 || d->inlineCompletionUniqueChars_ != uniqueChars;
3250 bool singlePar = true;
3251 d->inlineCompletion_ = completion;
3252 d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
3254 //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
3257 DocIterator const & old = d->inlineCompletionPos_;
3259 //lyxerr << "inlineCompletionPos changed" << std::endl;
3260 // old or pos are in another paragraph?
3261 if ((!samePar(cur, pos) && !pos.empty())
3262 || (!samePar(cur, old) && !old.empty())) {
3264 //lyxerr << "different paragraph" << std::endl;
3266 d->inlineCompletionPos_ = pos;
3271 if (singlePar && !(cur.result().screenUpdate() & Update::Force))
3272 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
3274 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::Force);
3279 bool BufferView::clickableInset() const
3281 return d->clickable_inset_;