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 value used to be hardcoded to 10, which is 2.5mm at 100dpi
355 int const default_margin = Length(2.5, Length::MM).inPixels(0);
356 // The additional test for the case the outliner is opened.
357 if (!full_screen_ || !lyxrc.full_screen_limit
358 || width_ < lyxrc.full_screen_width + 2 * default_margin)
359 return default_margin;
361 return (width_ - lyxrc.full_screen_width) / 2;
365 int BufferView::leftMargin() const
367 return rightMargin();
371 bool BufferView::isTopScreen() const
373 return 0 == d->scrollbarParameters_.min;
377 bool BufferView::isBottomScreen() const
379 return 0 == d->scrollbarParameters_.max;
383 Intl & BufferView::getIntl()
389 Intl const & BufferView::getIntl() const
395 CoordCache & BufferView::coordCache()
397 return d->coord_cache_;
401 CoordCache const & BufferView::coordCache() const
403 return d->coord_cache_;
407 Buffer & BufferView::buffer()
413 Buffer const & BufferView::buffer() const
419 bool BufferView::needsFitCursor() const
421 if (cursorStatus(d->cursor_) == CUR_INSIDE) {
422 frontend::FontMetrics const & fm =
423 theFontMetrics(d->cursor_.getFont().fontInfo());
424 int const asc = fm.maxAscent();
425 int const des = fm.maxDescent();
426 Point const p = getPos(d->cursor_);
427 if (p.y_ - asc >= 0 && p.y_ + des < height_)
434 void BufferView::processUpdateFlags(Update::flags flags)
436 // This is close to a hot-path.
437 LYXERR(Debug::PAINTING, "BufferView::processUpdateFlags()"
438 << "[fitcursor = " << (flags & Update::FitCursor)
439 << ", forceupdate = " << (flags & Update::Force)
440 << ", singlepar = " << (flags & Update::SinglePar)
441 << "] buffer: " << &buffer_);
443 // FIXME Does this really need doing here? It's done in updateBuffer, and
444 // if the Buffer doesn't need updating, then do the macros?
445 buffer_.updateMacros();
447 // Now do the first drawing step if needed. This consists on updating
448 // the CoordCache in updateMetrics().
449 // The second drawing step is done in WorkArea::redraw() if needed.
450 // FIXME: is this still true now that Buffer::changed() is used all over?
452 // Case when no explicit update is requested.
454 // no need to redraw anything.
455 d->update_strategy_ = NoScreenUpdate;
459 if (flags == Update::Decoration) {
460 d->update_strategy_ = DecorationUpdate;
461 buffer_.changed(false);
465 if (flags == Update::FitCursor
466 || flags == (Update::Decoration | Update::FitCursor)) {
467 // tell the frontend to update the screen if needed.
468 if (needsFitCursor()) {
472 if (flags & Update::Decoration) {
473 d->update_strategy_ = DecorationUpdate;
474 buffer_.changed(false);
477 // no screen update is needed in principle, but this
478 // could change if cursor row needs horizontal scrolling.
479 d->update_strategy_ = NoScreenUpdate;
480 buffer_.changed(false);
484 bool const full_metrics = flags & Update::Force || !singleParUpdate();
487 // We have to update the full screen metrics.
490 if (!(flags & Update::FitCursor)) {
491 // Nothing to do anymore. Trigger a redraw and return
492 buffer_.changed(false);
496 // updateMetrics() does not update paragraph position
497 // This is done at draw() time. So we need a redraw!
498 buffer_.changed(false);
500 if (needsFitCursor()) {
501 // The cursor is off screen so ensure it is visible.
506 updateHoveredInset();
510 void BufferView::updateScrollbar()
512 if (height_ == 0 && width_ == 0)
515 // We prefer fixed size line scrolling.
516 d->scrollbarParameters_.single_step = defaultRowHeight();
517 // We prefer full screen page scrolling.
518 d->scrollbarParameters_.page_step = height_;
520 Text & t = buffer_.text();
521 TextMetrics & tm = d->text_metrics_[&t];
523 LYXERR(Debug::GUI, " Updating scrollbar: height: "
524 << t.paragraphs().size()
525 << " curr par: " << d->cursor_.bottom().pit()
526 << " default height " << defaultRowHeight());
528 size_t const parsize = t.paragraphs().size();
529 if (d->par_height_.size() != parsize) {
530 d->par_height_.clear();
531 // FIXME: We assume a default paragraph height of 2 rows. This
532 // should probably be pondered with the screen width.
533 d->par_height_.resize(parsize, defaultRowHeight() * 2);
536 // Look at paragraph heights on-screen
537 pair<pit_type, ParagraphMetrics const *> first = tm.first();
538 pair<pit_type, ParagraphMetrics const *> last = tm.last();
539 for (pit_type pit = first.first; pit <= last.first; ++pit) {
540 d->par_height_[pit] = tm.parMetrics(pit).height();
541 LYXERR(Debug::SCROLLING, "storing height for pit " << pit << " : "
542 << d->par_height_[pit]);
545 int top_pos = first.second->position() - first.second->ascent();
546 int bottom_pos = last.second->position() + last.second->descent();
547 bool first_visible = first.first == 0 && top_pos >= 0;
548 bool last_visible = last.first + 1 == int(parsize) && bottom_pos <= height_;
549 if (first_visible && last_visible) {
550 d->scrollbarParameters_.min = 0;
551 d->scrollbarParameters_.max = 0;
555 d->scrollbarParameters_.min = top_pos;
556 for (size_t i = 0; i != size_t(first.first); ++i)
557 d->scrollbarParameters_.min -= d->par_height_[i];
558 d->scrollbarParameters_.max = bottom_pos;
559 for (size_t i = last.first + 1; i != parsize; ++i)
560 d->scrollbarParameters_.max += d->par_height_[i];
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);
603 void BufferView::scrollDocView(int const value, bool update)
605 // The scrollbar values are relative to the top of the screen, therefore the
606 // offset is equal to the target value.
608 // No scrolling at all? No need to redraw anything
612 // If the offset is less than 2 screen height, prefer to scroll instead.
613 if (abs(value) <= 2 * height_) {
614 d->anchor_ypos_ -= value;
615 buffer_.changed(true);
616 updateHoveredInset();
620 // cut off at the top
621 if (value <= d->scrollbarParameters_.min) {
622 DocIterator dit = doc_iterator_begin(&buffer_);
623 showCursor(dit, false, update);
624 LYXERR(Debug::SCROLLING, "scroll to top");
628 // cut off at the bottom
629 if (value >= d->scrollbarParameters_.max) {
630 DocIterator dit = doc_iterator_end(&buffer_);
632 showCursor(dit, false, update);
633 LYXERR(Debug::SCROLLING, "scroll to bottom");
637 // find paragraph at target position
638 int par_pos = d->scrollbarParameters_.min;
640 for (; i != int(d->par_height_.size()); ++i) {
641 par_pos += d->par_height_[i];
642 if (par_pos >= value)
646 if (par_pos < value) {
647 // It seems we didn't find the correct pit so stay on the safe side and
649 LYXERR0("scrolling position not found!");
650 scrollDocView(d->scrollbarParameters_.max, update);
654 DocIterator dit = doc_iterator_begin(&buffer_);
656 LYXERR(Debug::SCROLLING, "value = " << value << " -> scroll to pit " << i);
657 showCursor(dit, false, update);
661 // FIXME: this method is not working well.
662 void BufferView::setCursorFromScrollbar()
664 TextMetrics & tm = d->text_metrics_[&buffer_.text()];
666 int const height = 2 * defaultRowHeight();
667 int const first = height;
668 int const last = height_ - height;
670 Cursor const & oldcur = d->cursor_;
672 switch (cursorStatus(oldcur)) {
680 int const y = getPos(oldcur).y_;
681 newy = min(last, max(y, first));
685 // We reset the cursor because cursorStatus() does not
686 // work when the cursor is within mathed.
689 tm.setCursorFromCoordinates(cur, 0, newy);
691 // update the bufferview cursor and notify insets
692 // FIXME: Care about the d->cursor_ flags to redraw if needed
693 Cursor old = d->cursor_;
695 // the DEPM call in mouseSetCursor() might have destroyed the
696 // paragraph the cursor is in.
697 bool badcursor = old.fixIfBroken();
698 badcursor |= notifyCursorLeavesOrEnters(old, d->cursor_);
700 d->cursor_.fixIfBroken();
704 Change const BufferView::getCurrentChange() const
706 if (!d->cursor_.selection())
707 return Change(Change::UNCHANGED);
709 DocIterator dit = d->cursor_.selectionBegin();
710 // The selected content might have been changed (see #7685)
711 dit = dit.getInnerText();
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 // Do not forget to reset the anchor (see #9912)
812 d->cursor_.resetAnchor();
813 // To center the screen on this new position we need the
814 // paragraph position which is computed at draw() time.
815 // So we need a redraw!
816 buffer_.changed(false);
817 if (needsFitCursor())
825 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
827 if (d->cursor_.real_current_font.isRightToLeft()) {
828 if (d->intl_.keymap == Intl::PRIMARY)
829 d->intl_.keyMapSec();
831 if (d->intl_.keymap == Intl::SECONDARY)
832 d->intl_.keyMapPrim();
835 d->intl_.getTransManager().translateAndInsert(c, t, cur);
839 int BufferView::workWidth() const
845 void BufferView::recenter()
847 showCursor(d->cursor_, true, true);
851 void BufferView::showCursor()
853 showCursor(d->cursor_, false, true);
857 void BufferView::showCursor(DocIterator const & dit,
858 bool recenter, bool update)
860 if (scrollToCursor(dit, recenter) && update) {
861 buffer_.changed(true);
862 updateHoveredInset();
867 void BufferView::scrollToCursor()
869 if (scrollToCursor(d->cursor_, false)) {
870 buffer_.changed(true);
871 updateHoveredInset();
876 bool BufferView::scrollToCursor(DocIterator const & dit, bool recenter)
878 // We are not properly started yet, delay until resizing is
883 LYXERR(Debug::SCROLLING, "recentering!");
885 CursorSlice const & bot = dit.bottom();
886 TextMetrics & tm = d->text_metrics_[bot.text()];
888 pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
889 int bot_pit = bot.pit();
890 if (bot_pit > max_pit) {
891 // FIXME: Why does this happen?
892 LYXERR0("bottom pit is greater that max pit: "
893 << bot_pit << " > " << max_pit);
897 if (bot_pit == tm.first().first - 1)
898 tm.newParMetricsUp();
899 else if (bot_pit == tm.last().first + 1)
900 tm.newParMetricsDown();
902 if (tm.contains(bot_pit)) {
903 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
904 LBUFERR(!pm.rows().empty());
905 // FIXME: smooth scrolling doesn't work in mathed.
906 CursorSlice const & cs = dit.innerTextSlice();
907 int offset = coordOffset(dit).y_;
908 int ypos = pm.position() + offset;
909 Dimension const & row_dim =
910 pm.getRow(cs.pos(), dit.boundary()).dimension();
913 scrolled = scroll(ypos - height_/2);
915 // We try to visualize the whole row, if the row height is larger than
916 // the screen height, we scroll to a heuristic value of height_ / 4.
917 // FIXME: This heuristic value should be replaced by a recursive search
918 // for a row in the inset that can be visualized completely.
919 else if (row_dim.height() > height_) {
920 if (ypos < defaultRowHeight())
921 scrolled = scroll(ypos - height_ / 4);
922 else if (ypos > height_ - defaultRowHeight())
923 scrolled = scroll(ypos - 3 * height_ / 4);
926 // If the top part of the row falls of the screen, we scroll
927 // up to align the top of the row with the top of the screen.
928 else if (ypos - row_dim.ascent() < 0 && ypos < height_) {
929 int ynew = row_dim.ascent();
930 scrolled = scrollUp(ynew - ypos);
933 // If the bottom of the row falls of the screen, we scroll down.
934 else if (ypos + row_dim.descent() > height_ && ypos > 0) {
935 int ynew = height_ - row_dim.descent();
936 scrolled = scrollDown(ypos - ynew);
939 // else, nothing to do, the cursor is already visible so we just return.
940 return scrolled != 0;
943 // fix inline completion position
944 if (d->inlineCompletionPos_.fixIfBroken())
945 d->inlineCompletionPos_ = DocIterator();
947 tm.redoParagraph(bot_pit);
948 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
949 int offset = coordOffset(dit).y_;
951 d->anchor_pit_ = bot_pit;
952 CursorSlice const & cs = dit.innerTextSlice();
953 Dimension const & row_dim =
954 pm.getRow(cs.pos(), dit.boundary()).dimension();
957 d->anchor_ypos_ = height_/2;
958 else if (d->anchor_pit_ == 0)
959 d->anchor_ypos_ = offset + pm.ascent();
960 else if (d->anchor_pit_ == max_pit)
961 d->anchor_ypos_ = height_ - offset - row_dim.descent();
962 else if (offset > height_)
963 d->anchor_ypos_ = height_ - offset - defaultRowHeight();
965 d->anchor_ypos_ = defaultRowHeight() * 2;
971 void BufferView::makeDocumentClass()
973 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
974 buffer_.params().makeDocumentClass();
975 updateDocumentClass(olddc);
979 void BufferView::updateDocumentClass(DocumentClassConstPtr olddc)
981 message(_("Converting document to new document class..."));
983 StableDocIterator backcur(d->cursor_);
984 ErrorList & el = buffer_.errorList("Class Switch");
985 cap::switchBetweenClasses(
986 olddc, buffer_.params().documentClassPtr(),
987 static_cast<InsetText &>(buffer_.inset()), el);
989 setCursor(backcur.asDocIterator(&buffer_));
991 buffer_.errors("Class Switch");
995 /** Return the change status at cursor position, taking into account the
996 * status at each level of the document iterator (a table in a deleted
997 * footnote is deleted).
998 * When \param outer is true, the top slice is not looked at.
1000 static Change::Type lookupChangeType(DocIterator const & dit, bool outer = false)
1002 size_t const depth = dit.depth() - (outer ? 1 : 0);
1004 for (size_t i = 0 ; i < depth ; ++i) {
1005 CursorSlice const & slice = dit[i];
1006 if (!slice.inset().inMathed()
1007 && slice.pos() < slice.paragraph().size()) {
1008 Change::Type const ch = slice.paragraph().lookupChange(slice.pos()).type;
1009 if (ch != Change::UNCHANGED)
1013 return Change::UNCHANGED;
1017 bool BufferView::getStatus(FuncRequest const & cmd, FuncStatus & flag)
1019 FuncCode const act = cmd.action();
1021 // Can we use a readonly buffer?
1022 if (buffer_.isReadonly()
1023 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1024 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1025 flag.message(from_utf8(N_("Document is read-only")));
1026 flag.setEnabled(false);
1030 // Are we in a DELETED change-tracking region?
1031 if (lookupChangeType(d->cursor_, true) == Change::DELETED
1032 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1033 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1034 flag.message(from_utf8(N_("This portion of the document is deleted.")));
1035 flag.setEnabled(false);
1039 Cursor & cur = d->cursor_;
1041 if (cur.getStatus(cmd, flag))
1046 // FIXME: This is a bit problematic because we don't check if this is
1047 // a document BufferView or not for these LFUNs. We probably have to
1048 // dispatch both to currentBufferView() and, if that fails,
1049 // to documentBufferView(); same as we do now for current Buffer and
1050 // document Buffer. Ideally those LFUN should go to Buffer as they
1051 // operate on the full Buffer and the cursor is only needed either for
1052 // an Undo record or to restore a cursor position. But we don't know
1053 // how to do that inside Buffer of course.
1054 case LFUN_BUFFER_PARAMS_APPLY:
1055 case LFUN_LAYOUT_MODULES_CLEAR:
1056 case LFUN_LAYOUT_MODULE_ADD:
1057 case LFUN_LAYOUT_RELOAD:
1058 case LFUN_TEXTCLASS_APPLY:
1059 case LFUN_TEXTCLASS_LOAD:
1060 flag.setEnabled(!buffer_.isReadonly());
1064 // We do not use the LyXAction flag for readonly because Undo sets the
1065 // buffer clean/dirty status by itself.
1066 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasUndoStack());
1069 // We do not use the LyXAction flag for readonly because Redo sets the
1070 // buffer clean/dirty status by itself.
1071 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasRedoStack());
1073 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
1074 case LFUN_FILE_INSERT_PLAINTEXT: {
1075 docstring const fname = cmd.argument();
1076 if (!FileName::isAbsolute(to_utf8(fname))) {
1077 flag.message(_("Absolute filename expected."));
1080 flag.setEnabled(cur.inTexted());
1083 case LFUN_FILE_INSERT:
1084 case LFUN_BOOKMARK_SAVE:
1085 // FIXME: Actually, these LFUNS should be moved to Text
1086 flag.setEnabled(cur.inTexted());
1089 case LFUN_FONT_STATE:
1090 case LFUN_LABEL_INSERT:
1091 case LFUN_INFO_INSERT:
1092 case LFUN_PARAGRAPH_GOTO:
1093 case LFUN_NOTE_NEXT:
1094 case LFUN_REFERENCE_NEXT:
1095 case LFUN_WORD_FIND:
1096 case LFUN_WORD_FIND_FORWARD:
1097 case LFUN_WORD_FIND_BACKWARD:
1098 case LFUN_WORD_REPLACE:
1101 case LFUN_MARK_TOGGLE:
1102 case LFUN_SCREEN_RECENTER:
1103 case LFUN_SCREEN_SHOW_CURSOR:
1104 case LFUN_BIBTEX_DATABASE_ADD:
1105 case LFUN_BIBTEX_DATABASE_DEL:
1106 case LFUN_STATISTICS:
1107 case LFUN_KEYMAP_OFF:
1108 case LFUN_KEYMAP_PRIMARY:
1109 case LFUN_KEYMAP_SECONDARY:
1110 case LFUN_KEYMAP_TOGGLE:
1111 case LFUN_INSET_SELECT_ALL:
1112 flag.setEnabled(true);
1115 case LFUN_WORD_FINDADV: {
1116 FindAndReplaceOptions opt;
1117 istringstream iss(to_utf8(cmd.argument()));
1119 flag.setEnabled(opt.repl_buf_name.empty()
1120 || !buffer_.isReadonly());
1124 case LFUN_LABEL_GOTO:
1125 flag.setEnabled(!cmd.argument().empty()
1126 || getInsetByCode<InsetRef>(cur, REF_CODE));
1129 case LFUN_CHANGES_MERGE:
1130 case LFUN_CHANGE_NEXT:
1131 case LFUN_CHANGE_PREVIOUS:
1132 case LFUN_ALL_CHANGES_ACCEPT:
1133 case LFUN_ALL_CHANGES_REJECT:
1134 flag.setEnabled(buffer_.areChangesPresent());
1137 case LFUN_SCREEN_UP:
1138 case LFUN_SCREEN_DOWN:
1140 case LFUN_SCREEN_UP_SELECT:
1141 case LFUN_SCREEN_DOWN_SELECT:
1142 case LFUN_INSET_FORALL:
1143 flag.setEnabled(true);
1146 case LFUN_LAYOUT_TABULAR:
1147 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
1151 flag.setEnabled(!cur.inset().forcePlainLayout(cur.idx()));
1154 case LFUN_LAYOUT_PARAGRAPH:
1155 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
1158 case LFUN_BRANCH_ADD_INSERT:
1159 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1162 case LFUN_DIALOG_SHOW_NEW_INSET:
1163 // FIXME: this is wrong, but I do not understand the
1165 if (cur.inset().lyxCode() == CAPTION_CODE)
1166 return cur.inset().getStatus(cur, cmd, flag);
1167 // FIXME we should consider passthru paragraphs too.
1168 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1171 case LFUN_CITATION_INSERT: {
1172 FuncRequest fr(LFUN_INSET_INSERT, "citation");
1173 // FIXME: This could turn in a recursive hell.
1174 // Shouldn't we use Buffer::getStatus() instead?
1175 flag.setEnabled(lyx::getStatus(fr).enabled());
1178 case LFUN_INSET_APPLY: {
1179 string const name = cmd.getArg(0);
1180 Inset * inset = editedInset(name);
1182 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1183 if (!inset->getStatus(cur, fr, flag)) {
1184 // Every inset is supposed to handle this
1185 LASSERT(false, break);
1188 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1189 flag = lyx::getStatus(fr);
1202 Inset * BufferView::editedInset(string const & name) const
1204 map<string, Inset *>::const_iterator it = d->edited_insets_.find(name);
1205 return it == d->edited_insets_.end() ? 0 : it->second;
1209 void BufferView::editInset(string const & name, Inset * inset)
1211 d->edited_insets_[name] = inset;
1215 void BufferView::dispatch(FuncRequest const & cmd, DispatchResult & dr)
1217 LYXERR(Debug::ACTION, "BufferView::dispatch: cmd: " << cmd);
1219 string const argument = to_utf8(cmd.argument());
1220 Cursor & cur = d->cursor_;
1223 // Don't dispatch function that does not apply to internal buffers.
1224 if (buffer_.isInternal()
1225 && lyxaction.funcHasFlag(cmd.action(), LyXAction::NoInternal))
1228 // We'll set this back to false if need be.
1229 bool dispatched = true;
1230 buffer_.undo().beginUndoGroup();
1232 FuncCode const act = cmd.action();
1235 case LFUN_BUFFER_PARAMS_APPLY: {
1236 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1237 cur.recordUndoBufferParams();
1238 istringstream ss(to_utf8(cmd.argument()));
1241 int const unknown_tokens = buffer_.readHeader(lex);
1242 if (unknown_tokens != 0) {
1243 LYXERR0("Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1244 << unknown_tokens << " unknown token"
1245 << (unknown_tokens == 1 ? "" : "s"));
1247 updateDocumentClass(olddc);
1249 // We are most certainly here because of a change in the document
1250 // It is then better to make sure that all dialogs are in sync with
1251 // current document settings.
1252 dr.screenUpdate(Update::Force | Update::FitCursor);
1253 dr.forceBufferUpdate();
1257 case LFUN_LAYOUT_MODULES_CLEAR: {
1258 // FIXME: this modifies the document in cap::switchBetweenClasses
1259 // without calling recordUndo. Fix this before using
1260 // recordUndoBufferParams().
1261 cur.recordUndoFullBuffer();
1262 buffer_.params().clearLayoutModules();
1263 makeDocumentClass();
1264 dr.screenUpdate(Update::Force);
1265 dr.forceBufferUpdate();
1269 case LFUN_LAYOUT_MODULE_ADD: {
1270 BufferParams const & params = buffer_.params();
1271 if (!params.layoutModuleCanBeAdded(argument)) {
1272 LYXERR0("Module `" << argument <<
1273 "' cannot be added due to failed requirements or "
1274 "conflicts with installed modules.");
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().addLayoutModule(argument);
1282 makeDocumentClass();
1283 dr.screenUpdate(Update::Force);
1284 dr.forceBufferUpdate();
1288 case LFUN_TEXTCLASS_APPLY: {
1289 // since this shortcircuits, the second call is made only if
1291 bool const success =
1292 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1293 LayoutFileList::get().load(argument, buffer_.filePath());
1295 docstring s = bformat(_("The document class `%1$s' "
1296 "could not be loaded."), from_utf8(argument));
1297 frontend::Alert::error(_("Could not load class"), s);
1301 LayoutFile const * old_layout = buffer_.params().baseClass();
1302 LayoutFile const * new_layout = &(LayoutFileList::get()[argument]);
1304 if (old_layout == new_layout)
1308 // Save the old, possibly modular, layout for use in conversion.
1309 // FIXME: this modifies the document in cap::switchBetweenClasses
1310 // without calling recordUndo. Fix this before using
1311 // recordUndoBufferParams().
1312 cur.recordUndoFullBuffer();
1313 buffer_.params().setBaseClass(argument);
1314 makeDocumentClass();
1315 dr.screenUpdate(Update::Force);
1316 dr.forceBufferUpdate();
1320 case LFUN_TEXTCLASS_LOAD: {
1321 // since this shortcircuits, the second call is made only if
1323 bool const success =
1324 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1325 LayoutFileList::get().load(argument, buffer_.filePath());
1327 docstring s = bformat(_("The document class `%1$s' "
1328 "could not be loaded."), from_utf8(argument));
1329 frontend::Alert::error(_("Could not load class"), s);
1334 case LFUN_LAYOUT_RELOAD: {
1335 LayoutFileIndex bc = buffer_.params().baseClassID();
1336 LayoutFileList::get().reset(bc);
1337 buffer_.params().setBaseClass(bc);
1338 makeDocumentClass();
1339 dr.screenUpdate(Update::Force);
1340 dr.forceBufferUpdate();
1345 dr.setMessage(_("Undo"));
1346 cur.clearSelection();
1347 if (!cur.textUndo())
1348 dr.setMessage(_("No further undo information"));
1350 dr.screenUpdate(Update::Force | Update::FitCursor);
1351 dr.forceBufferUpdate();
1352 // we only need to do this if we have deleted or restored a
1353 // BiBTeX inset. but there is no other place to do it. one
1354 // obvious idea is to try to do it in a copy constructor for
1355 // InsetBibTeX, but when that is invoked, the buffer_ member
1356 // is not yet set. another idea is to look at the InsetLists
1357 // of the various paragraphs. but we'd have to recurse through
1358 // the contained insets to make that work. it doesn't seem to
1359 // be worth it, as this will not happen that often.
1360 buffer().invalidateBibfileCache();
1361 buffer().removeBiblioTempFiles();
1365 dr.setMessage(_("Redo"));
1366 cur.clearSelection();
1367 if (!cur.textRedo())
1368 dr.setMessage(_("No further redo information"));
1370 dr.screenUpdate(Update::Force | Update::FitCursor);
1371 dr.forceBufferUpdate();
1373 buffer().invalidateBibfileCache();
1374 buffer().removeBiblioTempFiles();
1377 case LFUN_FONT_STATE:
1378 dr.setMessage(cur.currentState());
1381 case LFUN_BOOKMARK_SAVE:
1382 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1385 case LFUN_LABEL_GOTO: {
1386 docstring label = cmd.argument();
1387 if (label.empty()) {
1389 getInsetByCode<InsetRef>(cur, REF_CODE);
1391 label = inset->getParam("reference");
1392 // persistent=false: use temp_bookmark
1396 if (!label.empty()) {
1398 // at the moment, this is redundant, since gotoLabel will
1399 // eventually call LFUN_PARAGRAPH_GOTO, but it seems best
1401 dr.screenUpdate(Update::Force | Update::FitCursor);
1406 case LFUN_PARAGRAPH_GOTO: {
1407 int const id = convert<int>(cmd.getArg(0));
1408 int const pos = convert<int>(cmd.getArg(1));
1410 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1411 b = theBufferList().next(b)) {
1414 cur.setCursor(b->getParFromID(id));
1416 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1420 LYXERR(Debug::INFO, "Paragraph " << cur.paragraph().id()
1421 << " found in buffer `"
1422 << b->absFileName() << "'.");
1424 if (b == &buffer_) {
1427 mouseSetCursor(cur);
1428 dr.screenUpdate(Update::Force | Update::FitCursor);
1430 // Switch to other buffer view and resend cmd
1431 lyx::dispatch(FuncRequest(
1432 LFUN_BUFFER_SWITCH, b->absFileName()));
1440 case LFUN_NOTE_NEXT:
1441 gotoInset(this, NOTE_CODE, false);
1444 case LFUN_REFERENCE_NEXT: {
1445 vector<InsetCode> tmp;
1446 tmp.push_back(LABEL_CODE);
1447 tmp.push_back(REF_CODE);
1448 gotoInset(this, tmp, true);
1452 case LFUN_CHANGE_NEXT:
1453 findNextChange(this);
1454 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1455 dr.screenUpdate(Update::Force | Update::FitCursor);
1458 case LFUN_CHANGE_PREVIOUS:
1459 findPreviousChange(this);
1460 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1461 dr.screenUpdate(Update::Force | Update::FitCursor);
1464 case LFUN_CHANGES_MERGE:
1465 if (findNextChange(this) || findPreviousChange(this)) {
1466 dr.screenUpdate(Update::Force | Update::FitCursor);
1467 dr.forceBufferUpdate();
1468 showDialog("changes");
1472 case LFUN_ALL_CHANGES_ACCEPT:
1473 // select complete document
1475 cur.selHandle(true);
1476 buffer_.text().cursorBottom(cur);
1477 // accept everything in a single step to support atomic undo
1478 buffer_.text().acceptOrRejectChanges(cur, Text::ACCEPT);
1480 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1481 dr.screenUpdate(Update::Force | Update::FitCursor);
1482 dr.forceBufferUpdate();
1485 case LFUN_ALL_CHANGES_REJECT:
1486 // select complete document
1488 cur.selHandle(true);
1489 buffer_.text().cursorBottom(cur);
1490 // reject everything in a single step to support atomic undo
1491 // Note: reject does not work recursively; the user may have to repeat the operation
1492 buffer_.text().acceptOrRejectChanges(cur, Text::REJECT);
1494 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1495 dr.screenUpdate(Update::Force | Update::FitCursor);
1496 dr.forceBufferUpdate();
1499 case LFUN_WORD_FIND_FORWARD:
1500 case LFUN_WORD_FIND_BACKWARD: {
1502 // Would it maybe be better if this variable were view specific anyway?
1503 static docstring last_search;
1504 docstring searched_string;
1506 if (!cmd.argument().empty()) {
1507 last_search = cmd.argument();
1508 searched_string = cmd.argument();
1510 searched_string = last_search;
1513 if (searched_string.empty())
1516 bool const fw = act == LFUN_WORD_FIND_FORWARD;
1517 docstring const data =
1518 find2string(searched_string, true, false, fw);
1519 bool found = lyxfind(this, FuncRequest(LFUN_WORD_FIND, data));
1521 dr.screenUpdate(Update::Force | Update::FitCursor);
1531 case LFUN_WORD_FIND: {
1532 FuncRequest req = cmd;
1533 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1534 req = d->search_request_cache_;
1535 if (req.argument().empty()) {
1536 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, "findreplace"));
1539 if (lyxfind(this, req)) {
1540 dr.screenUpdate(Update::Force | Update::FitCursor);
1547 d->search_request_cache_ = req;
1551 case LFUN_WORD_REPLACE: {
1552 bool has_deleted = false;
1553 if (cur.selection()) {
1554 DocIterator beg = cur.selectionBegin();
1555 DocIterator end = cur.selectionEnd();
1556 if (beg.pit() == end.pit()) {
1557 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1558 if (!cur.inMathed() && cur.paragraph().isDeleted(p)) {
1565 if (lyxreplace(this, cmd, has_deleted)) {
1566 dr.forceBufferUpdate();
1567 dr.screenUpdate(Update::Force | Update::FitCursor);
1577 case LFUN_WORD_FINDADV: {
1578 FindAndReplaceOptions opt;
1579 istringstream iss(to_utf8(cmd.argument()));
1581 if (findAdv(this, opt)) {
1582 dr.screenUpdate(Update::Force | Update::FitCursor);
1593 cur.clearSelection();
1594 dr.setMessage(from_utf8(N_("Mark off")));
1598 cur.clearSelection();
1600 dr.setMessage(from_utf8(N_("Mark on")));
1603 case LFUN_MARK_TOGGLE:
1604 cur.selection(false);
1607 dr.setMessage(from_utf8(N_("Mark removed")));
1610 dr.setMessage(from_utf8(N_("Mark set")));
1615 case LFUN_SCREEN_SHOW_CURSOR:
1619 case LFUN_SCREEN_RECENTER:
1623 case LFUN_BIBTEX_DATABASE_ADD: {
1624 Cursor tmpcur = cur;
1625 findInset(tmpcur, BIBTEX_CODE, false);
1626 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1629 if (inset->addDatabase(cmd.argument())) {
1630 buffer_.invalidateBibfileCache();
1631 dr.forceBufferUpdate();
1637 case LFUN_BIBTEX_DATABASE_DEL: {
1638 Cursor tmpcur = cur;
1639 findInset(tmpcur, BIBTEX_CODE, false);
1640 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1643 if (inset->delDatabase(cmd.argument())) {
1644 buffer_.invalidateBibfileCache();
1645 dr.forceBufferUpdate();
1651 case LFUN_STATISTICS: {
1652 DocIterator from, to;
1653 if (cur.selection()) {
1654 from = cur.selectionBegin();
1655 to = cur.selectionEnd();
1657 from = doc_iterator_begin(&buffer_);
1658 to = doc_iterator_end(&buffer_);
1660 buffer_.updateStatistics(from, to);
1661 int const words = buffer_.wordCount();
1662 int const chars = buffer_.charCount(false);
1663 int const chars_blanks = buffer_.charCount(true);
1665 if (cur.selection())
1666 message = _("Statistics for the selection:");
1668 message = _("Statistics for the document:");
1671 message += bformat(_("%1$d words"), words);
1673 message += _("One word");
1675 if (chars_blanks != 1)
1676 message += bformat(_("%1$d characters (including blanks)"),
1679 message += _("One character (including blanks)");
1682 message += bformat(_("%1$d characters (excluding blanks)"),
1685 message += _("One character (excluding blanks)");
1687 Alert::information(_("Statistics"), message);
1691 case LFUN_SCREEN_UP:
1692 case LFUN_SCREEN_DOWN: {
1693 Point p = getPos(cur);
1694 // This code has been commented out to enable to scroll down a
1695 // document, even if there are large insets in it (see bug #5465).
1696 /*if (p.y_ < 0 || p.y_ > height_) {
1697 // The cursor is off-screen so recenter before proceeding.
1701 int const scrolled = scroll(act == LFUN_SCREEN_UP
1702 ? -height_ : height_);
1703 if (act == LFUN_SCREEN_UP && scrolled > -height_)
1705 if (act == LFUN_SCREEN_DOWN && scrolled < height_)
1706 p = Point(width_, height_);
1707 bool const in_texted = cur.inTexted();
1708 cur.setCursor(doc_iterator_begin(cur.buffer()));
1709 cur.selHandle(false);
1710 buffer_.changed(true);
1711 updateHoveredInset();
1713 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_,
1714 true, act == LFUN_SCREEN_UP);
1715 //FIXME: what to do with cur.x_target()?
1716 bool update = in_texted && cur.bv().checkDepm(cur, old);
1719 if (update || cur.mark())
1720 dr.screenUpdate(Update::Force | Update::FitCursor);
1722 dr.forceBufferUpdate();
1727 string const scroll_type = cmd.getArg(0);
1728 int scroll_step = 0;
1729 if (scroll_type == "line")
1730 scroll_step = d->scrollbarParameters_.single_step;
1731 else if (scroll_type == "page")
1732 scroll_step = d->scrollbarParameters_.page_step;
1735 string const scroll_quantity = cmd.getArg(1);
1736 if (scroll_quantity == "up")
1737 scrollUp(scroll_step);
1738 else if (scroll_quantity == "down")
1739 scrollDown(scroll_step);
1741 int const scroll_value = convert<int>(scroll_quantity);
1743 scroll(scroll_step * scroll_value);
1745 buffer_.changed(true);
1746 updateHoveredInset();
1747 dr.forceBufferUpdate();
1751 case LFUN_SCREEN_UP_SELECT: {
1752 // FIXME: why is the algorithm different from LFUN_SCREEN_UP?
1753 cur.selHandle(true);
1754 if (isTopScreen()) {
1755 lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1759 int y = getPos(cur).y_;
1760 int const ymin = y - height_ + defaultRowHeight();
1761 while (y > ymin && cur.up())
1765 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1769 case LFUN_SCREEN_DOWN_SELECT: {
1770 // FIXME: why is the algorithm different from LFUN_SCREEN_DOWN?
1771 cur.selHandle(true);
1772 if (isBottomScreen()) {
1773 lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1777 int y = getPos(cur).y_;
1778 int const ymax = y + height_ - defaultRowHeight();
1779 while (y < ymax && cur.down())
1783 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1788 case LFUN_INSET_SELECT_ALL: {
1789 // true if all cells are selected
1790 bool const all_selected = cur.depth() > 1
1791 && cur.selBegin().at_begin()
1792 && cur.selEnd().at_end();
1793 // true if some cells are selected
1794 bool const cells_selected = cur.depth() > 1
1795 && cur.selBegin().at_cell_begin()
1796 && cur.selEnd().at_cell_end();
1797 if (all_selected || (cells_selected && !cur.inset().isTable())) {
1798 // All the contents of the inset if selected, or only at
1799 // least one cell but inset is not a table.
1800 // Select the inset from outside.
1803 cur.selection(true);
1805 } else if (cells_selected) {
1806 // At least one complete cell is selected and inset is a table.
1811 cur.selection(true);
1812 cur.idx() = cur.lastidx();
1813 cur.pos() = cur.lastpos();
1815 // select current cell
1819 cur.selection(true);
1820 cur.pit() = cur.lastpit();
1821 cur.pos() = cur.lastpos();
1823 cur.setCurrentFont();
1824 dr.screenUpdate(Update::Force);
1829 // This would be in Buffer class if only Cursor did not
1830 // require a bufferview
1831 case LFUN_INSET_FORALL: {
1832 docstring const name = from_utf8(cmd.getArg(0));
1833 string const commandstr = cmd.getLongArg(1);
1834 FuncRequest const fr = lyxaction.lookupFunc(commandstr);
1836 // an arbitrary number to limit number of iterations
1837 const int max_iter = 100000;
1839 Cursor & cur = d->cursor_;
1840 Cursor const savecur = cur;
1842 if (!cur.nextInset())
1844 cur.beginUndoGroup();
1845 while(cur && iterations < max_iter) {
1846 Inset * const ins = cur.nextInset();
1849 docstring insname = ins->layoutName();
1850 while (!insname.empty()) {
1851 if (insname == name || name == from_utf8("*")) {
1853 lyx::dispatch(fr, dr);
1857 size_t const i = insname.rfind(':');
1858 if (i == string::npos)
1860 insname = insname.substr(0, i);
1862 // if we did not delete the inset, skip it
1863 if (!cur.nextInset() || cur.nextInset() == ins)
1868 /** This is a dummy undo record only to remember the cursor
1869 * that has just been set; this will be used on a redo action
1870 * (see ticket #10097)
1872 * FIXME: a better fix would be to have a way to set the
1873 * cursor value directly, but I am not sure it is worth it.
1877 dr.screenUpdate(Update::Force);
1878 dr.forceBufferUpdate();
1880 if (iterations >= max_iter) {
1882 dr.setMessage(bformat(_("`inset-forall' interrupted because number of actions is larger than %1$d"), max_iter));
1884 dr.setMessage(bformat(_("Applied \"%1$s\" to %2$d insets"), from_utf8(commandstr), iterations));
1889 case LFUN_BRANCH_ADD_INSERT: {
1890 docstring branch_name = from_utf8(cmd.getArg(0));
1891 if (branch_name.empty())
1892 if (!Alert::askForText(branch_name, _("Branch name")) ||
1893 branch_name.empty())
1896 DispatchResult drtmp;
1897 buffer_.dispatch(FuncRequest(LFUN_BRANCH_ADD, branch_name), drtmp);
1898 if (drtmp.error()) {
1899 Alert::warning(_("Branch already exists"), drtmp.message());
1902 BranchList & branch_list = buffer_.params().branchlist();
1903 vector<docstring> const branches =
1904 getVectorFromString(branch_name, branch_list.separator());
1905 for (vector<docstring>::const_iterator it = branches.begin();
1906 it != branches.end(); ++it) {
1908 lyx::dispatch(FuncRequest(LFUN_BRANCH_INSERT, branch_name));
1913 case LFUN_KEYMAP_OFF:
1914 getIntl().keyMapOn(false);
1917 case LFUN_KEYMAP_PRIMARY:
1918 getIntl().keyMapPrim();
1921 case LFUN_KEYMAP_SECONDARY:
1922 getIntl().keyMapSec();
1925 case LFUN_KEYMAP_TOGGLE:
1926 getIntl().toggleKeyMap();
1929 case LFUN_DIALOG_SHOW_NEW_INSET: {
1930 string const name = cmd.getArg(0);
1931 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
1932 if (decodeInsetParam(name, data, buffer_))
1933 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
1935 lyxerr << "Inset type '" << name <<
1936 "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" << endl;
1940 case LFUN_CITATION_INSERT: {
1941 if (argument.empty()) {
1942 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
1945 // we can have one optional argument, delimited by '|'
1946 // citation-insert <key>|<text_before>
1947 // this should be enhanced to also support text_after
1948 // and citation style
1949 string arg = argument;
1951 if (contains(argument, "|")) {
1952 arg = token(argument, '|', 0);
1953 opt1 = token(argument, '|', 1);
1956 // if our cursor is directly in front of or behind a citation inset,
1957 // we will instead add the new key to it.
1958 Inset * inset = cur.nextInset();
1959 if (!inset || inset->lyxCode() != CITE_CODE)
1960 inset = cur.prevInset();
1961 if (inset && inset->lyxCode() == CITE_CODE) {
1962 InsetCitation * icite = static_cast<InsetCitation *>(inset);
1963 if (icite->addKey(arg)) {
1964 dr.forceBufferUpdate();
1965 dr.screenUpdate(Update::FitCursor | Update::SinglePar);
1967 LYXERR0("Discarding optional argument to citation-insert.");
1972 InsetCommandParams icp(CITE_CODE);
1973 icp["key"] = from_utf8(arg);
1975 icp["before"] = from_utf8(opt1);
1976 string icstr = InsetCommand::params2string(icp);
1977 FuncRequest fr(LFUN_INSET_INSERT, icstr);
1982 case LFUN_INSET_APPLY: {
1983 string const name = cmd.getArg(0);
1984 Inset * inset = editedInset(name);
1986 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1990 // put cursor in front of inset.
1991 if (!setCursorFromInset(inset)) {
1992 LASSERT(false, break);
1995 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1996 inset->dispatch(cur, fr);
1997 dr.screenUpdate(cur.result().screenUpdate());
1998 if (cur.result().needBufferUpdate())
1999 dr.forceBufferUpdate();
2004 // The change of language of buffer belongs to the Buffer class.
2005 // We have to do it here because we need a cursor for Undo.
2006 // When Undo::recordUndoBufferParams() is implemented someday
2007 // LFUN_BUFFER_LANGUAGE should be handled by the Buffer class.
2008 case LFUN_BUFFER_LANGUAGE: {
2009 Language const * oldL = buffer_.params().language;
2010 Language const * newL = languages.getLanguage(argument);
2011 if (!newL || oldL == newL)
2013 if (oldL->rightToLeft() == newL->rightToLeft()) {
2014 cur.recordUndoFullBuffer();
2015 buffer_.changeLanguage(oldL, newL);
2016 cur.setCurrentFont();
2017 dr.forceBufferUpdate();
2022 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
2023 case LFUN_FILE_INSERT_PLAINTEXT: {
2024 bool const as_paragraph = (act == LFUN_FILE_INSERT_PLAINTEXT_PARA);
2025 string const fname = to_utf8(cmd.argument());
2026 if (!FileName::isAbsolute(fname))
2027 dr.setMessage(_("Absolute filename expected."));
2029 insertPlaintextFile(FileName(fname), as_paragraph);
2034 // OK, so try the Buffer itself...
2035 buffer_.dispatch(cmd, dr);
2036 dispatched = dr.dispatched();
2040 buffer_.undo().endUndoGroup();
2041 dr.dispatched(dispatched);
2043 // NOTE: The code below is copied from Cursor::dispatch. If you
2044 // need to modify this, please update the other one too.
2046 // notify insets we just entered/left
2047 if (cursor() != old) {
2048 old.beginUndoGroup();
2050 bool badcursor = notifyCursorLeavesOrEnters(old, cursor());
2052 cursor().fixIfBroken();
2053 resetInlineCompletionPos();
2060 docstring const BufferView::requestSelection()
2062 Cursor & cur = d->cursor_;
2064 LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
2065 if (!cur.selection()) {
2066 d->xsel_cache_.set = false;
2070 LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
2071 if (!d->xsel_cache_.set ||
2072 cur.top() != d->xsel_cache_.cursor ||
2073 cur.realAnchor().top() != d->xsel_cache_.anchor)
2075 d->xsel_cache_.cursor = cur.top();
2076 d->xsel_cache_.anchor = cur.realAnchor().top();
2077 d->xsel_cache_.set = cur.selection();
2078 return cur.selectionAsString(false);
2084 void BufferView::clearSelection()
2086 d->cursor_.clearSelection();
2087 // Clear the selection buffer. Otherwise a subsequent
2088 // middle-mouse-button paste would use the selection buffer,
2089 // not the more current external selection.
2090 cap::clearSelection();
2091 d->xsel_cache_.set = false;
2092 // The buffer did not really change, but this causes the
2093 // redraw we need because we cleared the selection above.
2094 buffer_.changed(false);
2098 void BufferView::resize(int width, int height)
2100 // Update from work area
2104 // Clear the paragraph height cache.
2105 d->par_height_.clear();
2106 // Redo the metrics.
2111 Inset const * BufferView::getCoveringInset(Text const & text,
2114 TextMetrics & tm = d->text_metrics_[&text];
2115 Inset * inset = tm.checkInsetHit(x, y);
2119 if (!inset->descendable(*this))
2120 // No need to go further down if the inset is not
2124 size_t cell_number = inset->nargs();
2125 // Check all the inner cell.
2126 for (size_t i = 0; i != cell_number; ++i) {
2127 Text const * inner_text = inset->getText(i);
2130 Inset const * inset_deeper =
2131 getCoveringInset(*inner_text, x, y);
2133 return inset_deeper;
2141 void BufferView::updateHoveredInset() const
2143 // Get inset under mouse, if there is one.
2144 int const x = d->mouse_position_cache_.x_;
2145 int const y = d->mouse_position_cache_.y_;
2146 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
2148 d->clickable_inset_ = covering_inset && covering_inset->clickable(*this, x, y);
2150 if (covering_inset == d->last_inset_)
2151 // Same inset, no need to do anything...
2154 bool need_redraw = false;
2155 if (d->last_inset_) {
2156 // Remove the hint on the last hovered inset (if any).
2157 need_redraw |= d->last_inset_->setMouseHover(this, false);
2161 if (covering_inset && covering_inset->setMouseHover(this, true)) {
2163 // Only the insets that accept the hover state, do
2164 // clear the last_inset_, so only set the last_inset_
2165 // member if the hovered setting is accepted.
2166 d->last_inset_ = covering_inset;
2170 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
2171 << d->mouse_position_cache_.x_ << ", "
2172 << d->mouse_position_cache_.y_ << ")");
2174 d->update_strategy_ = DecorationUpdate;
2176 // This event (moving without mouse click) is not passed further.
2177 // This should be changed if it is further utilized.
2178 buffer_.changed(false);
2183 void BufferView::clearLastInset(Inset * inset) const
2185 if (d->last_inset_ != inset) {
2186 LYXERR0("Wrong last_inset!");
2193 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
2195 //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
2197 // This is only called for mouse related events including
2198 // LFUN_FILE_OPEN generated by drag-and-drop.
2199 FuncRequest cmd = cmd0;
2201 Cursor old = cursor();
2203 cur.push(buffer_.inset());
2204 cur.selection(d->cursor_.selection());
2206 // Either the inset under the cursor or the
2207 // surrounding Text will handle this event.
2209 // make sure we stay within the screen...
2210 cmd.set_y(min(max(cmd.y(), -1), height_));
2212 d->mouse_position_cache_.x_ = cmd.x();
2213 d->mouse_position_cache_.y_ = cmd.y();
2215 if (cmd.action() == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
2216 updateHoveredInset();
2220 // Build temporary cursor.
2221 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x(), cmd.y());
2223 // If inset is not editable, cur.pos() might point behind the
2224 // inset (depending on cmd.x(), cmd.y()). This is needed for
2225 // editing to fix bug 9628, but e.g. the context menu needs a
2226 // cursor in front of the inset.
2227 if ((inset->hasSettings() || !inset->contextMenuName().empty()
2228 || inset->lyxCode() == SEPARATOR_CODE) &&
2229 cur.nextInset() != inset && cur.prevInset() == inset)
2231 } else if (cur.inTexted() && cur.pos()
2232 && cur.paragraph().isEnvSeparator(cur.pos() - 1)) {
2233 // Always place cursor in front of a separator inset.
2237 // Put anchor at the same position.
2240 cur.beginUndoGroup();
2242 // Try to dispatch to an non-editable inset near this position
2243 // via the temp cursor. If the inset wishes to change the real
2244 // cursor it has to do so explicitly by using
2245 // cur.bv().cursor() = cur; (or similar)
2247 inset->dispatch(cur, cmd);
2249 // Now dispatch to the temporary cursor. If the real cursor should
2250 // be modified, the inset's dispatch has to do so explicitly.
2251 if (!inset || !cur.result().dispatched())
2254 // Notify left insets
2256 bool badcursor = old.fixIfBroken() | cur.fixIfBroken();
2257 badcursor |= notifyCursorLeavesOrEnters(old, cur);
2259 cursor().fixIfBroken();
2264 // Do we have a selection?
2265 theSelection().haveSelection(cursor().selection());
2267 if (cur.needBufferUpdate()) {
2268 cur.clearBufferUpdate();
2269 buffer().updateBuffer();
2272 // If the command has been dispatched,
2273 if (cur.result().dispatched() || cur.result().screenUpdate())
2274 processUpdateFlags(cur.result().screenUpdate());
2278 int BufferView::minVisiblePart()
2280 return 2 * defaultRowHeight();
2284 int BufferView::scroll(int y)
2287 return scrollDown(y);
2289 return scrollUp(-y);
2294 int BufferView::scrollDown(int offset)
2296 Text * text = &buffer_.text();
2297 TextMetrics & tm = d->text_metrics_[text];
2298 int const ymax = height_ + offset;
2300 pair<pit_type, ParagraphMetrics const *> last = tm.last();
2301 int bottom_pos = last.second->position() + last.second->descent();
2302 if (lyxrc.scroll_below_document)
2303 bottom_pos += height_ - minVisiblePart();
2304 if (last.first + 1 == int(text->paragraphs().size())) {
2305 if (bottom_pos <= height_)
2307 offset = min(offset, bottom_pos - height_);
2310 if (bottom_pos > ymax)
2312 tm.newParMetricsDown();
2314 d->anchor_ypos_ -= offset;
2319 int BufferView::scrollUp(int offset)
2321 Text * text = &buffer_.text();
2322 TextMetrics & tm = d->text_metrics_[text];
2323 int ymin = - offset;
2325 pair<pit_type, ParagraphMetrics const *> first = tm.first();
2326 int top_pos = first.second->position() - first.second->ascent();
2327 if (first.first == 0) {
2330 offset = min(offset, - top_pos);
2335 tm.newParMetricsUp();
2337 d->anchor_ypos_ += offset;
2342 void BufferView::setCursorFromRow(int row)
2344 setCursorFromRow(row, buffer_.texrow());
2348 void BufferView::setCursorFromRow(int row, TexRow const & texrow)
2352 pit_type newpit = 0;
2353 pos_type newpos = 0;
2355 texrow.getIdFromRow(row, tmpid, tmppos);
2357 bool posvalid = (tmpid != -1);
2359 // we need to make sure that the row and position
2360 // we got back are valid, because the buffer may well
2361 // have changed since we last generated the LaTeX.
2362 DocIterator dit = buffer_.getParFromID(tmpid);
2363 if (dit == doc_iterator_end(&buffer_))
2365 else if (dit.depth() > 1) {
2366 // We are in an inset.
2367 pos_type lastpos = dit.lastpos();
2368 dit.pos() = tmppos > lastpos ? lastpos : tmppos;
2374 // now have to check pos.
2376 Paragraph const & par = buffer_.text().getPar(newpit);
2377 if (newpos > par.size()) {
2378 LYXERR0("Requested position no longer valid.");
2379 newpos = par.size() - 1;
2384 frontend::Alert::error(_("Inverse Search Failed"),
2385 _("Invalid position requested by inverse search.\n"
2386 "You need to update the viewed document."));
2390 buffer_.text().setCursor(d->cursor_, newpit, newpos);
2391 d->cursor_.selection(false);
2392 d->cursor_.resetAnchor();
2397 bool BufferView::setCursorFromInset(Inset const * inset)
2399 // are we already there?
2400 if (cursor().nextInset() == inset)
2403 // Inset is not at cursor position. Find it in the document.
2406 while (cur && cur.nextInset() != inset)
2417 void BufferView::gotoLabel(docstring const & label)
2419 ListOfBuffers bufs = buffer().allRelatives();
2420 ListOfBuffers::iterator it = bufs.begin();
2421 for (; it != bufs.end(); ++it) {
2422 Buffer const * buf = *it;
2425 shared_ptr<Toc> toc = buf->tocBackend().toc("label");
2426 Toc::const_iterator toc_it = toc->begin();
2427 Toc::const_iterator end = toc->end();
2428 for (; toc_it != end; ++toc_it) {
2429 if (label == toc_it->str()) {
2430 lyx::dispatch(toc_it->action());
2438 TextMetrics const & BufferView::textMetrics(Text const * t) const
2440 return const_cast<BufferView *>(this)->textMetrics(t);
2444 TextMetrics & BufferView::textMetrics(Text const * t)
2447 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
2448 if (tmc_it == d->text_metrics_.end()) {
2449 tmc_it = d->text_metrics_.insert(
2450 make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
2452 return tmc_it->second;
2456 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
2459 return textMetrics(t).parMetrics(pit);
2463 int BufferView::workHeight() const
2469 void BufferView::setCursor(DocIterator const & dit)
2472 size_t const n = dit.depth();
2473 for (size_t i = 0; i < n; ++i)
2474 dit[i].inset().edit(d->cursor_, true);
2476 d->cursor_.setCursor(dit);
2477 d->cursor_.selection(false);
2478 d->cursor_.setCurrentFont();
2480 // It seems on general grounds as if this is probably needed, but
2481 // it is not yet clear.
2482 // See bug #7394 and r38388.
2483 // d->cursor.resetAnchor();
2487 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
2489 // Would be wrong to delete anything if we have a selection.
2490 if (cur.selection())
2493 bool need_anchor_change = false;
2494 bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
2495 need_anchor_change);
2497 if (need_anchor_change)
2505 // we would rather not do this here, but it needs to be done before
2506 // the changed() signal is sent.
2507 buffer_.updateBuffer();
2509 buffer_.changed(true);
2514 bool BufferView::mouseSetCursor(Cursor & cur, bool select)
2516 LASSERT(&cur.bv() == this, return false);
2519 // this event will clear selection so we save selection for
2520 // persistent selection
2521 cap::saveSelection(cursor());
2523 d->cursor_.macroModeClose();
2524 // If a macro has been finalized, the cursor might have been broken
2527 // Has the cursor just left the inset?
2528 bool const leftinset = (&d->cursor_.inset() != &cur.inset());
2530 d->cursor_.fixIfBroken();
2532 // FIXME: shift-mouse selection doesn't work well across insets.
2533 bool const do_selection =
2534 select && &d->cursor_.normalAnchor().inset() == &cur.inset();
2536 // do the dEPM magic if needed
2537 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
2538 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
2539 // the leftinset bool would not be necessary (badcursor instead).
2540 bool update = leftinset;
2541 if (!do_selection && d->cursor_.inTexted())
2542 update |= checkDepm(cur, d->cursor_);
2545 d->cursor_.resetAnchor();
2546 d->cursor_.setCursor(cur);
2547 d->cursor_.boundary(cur.boundary());
2549 d->cursor_.setSelection();
2551 d->cursor_.clearSelection();
2553 d->cursor_.finishUndo();
2554 d->cursor_.setCurrentFont();
2556 cur.forceBufferUpdate();
2561 void BufferView::putSelectionAt(DocIterator const & cur,
2562 int length, bool backwards)
2564 d->cursor_.clearSelection();
2570 d->cursor_.pos() += length;
2571 d->cursor_.setSelection(d->cursor_, -length);
2573 d->cursor_.setSelection(d->cursor_, length);
2578 bool BufferView::selectIfEmpty(DocIterator & cur)
2580 if ((cur.inTexted() && !cur.paragraph().empty())
2581 || (cur.inMathed() && !cur.cell().empty()))
2584 pit_type const beg_pit = cur.pit();
2586 // The paragraph associated to this item isn't
2587 // the first one, so it can be selected
2590 // We have to resort to select the space between the
2591 // end of this item and the begin of the next one
2595 // If it is the only item in the document,
2596 // nothing can be selected
2599 pit_type const end_pit = cur.pit();
2600 pos_type const end_pos = cur.pos();
2601 d->cursor_.clearSelection();
2603 d->cursor_.setCursor(cur);
2604 d->cursor_.pit() = beg_pit;
2605 d->cursor_.pos() = 0;
2606 d->cursor_.selection(false);
2607 d->cursor_.resetAnchor();
2608 d->cursor_.pit() = end_pit;
2609 d->cursor_.pos() = end_pos;
2610 d->cursor_.setSelection();
2615 Cursor & BufferView::cursor()
2621 Cursor const & BufferView::cursor() const
2627 pit_type BufferView::anchor_ref() const
2629 return d->anchor_pit_;
2633 bool BufferView::singleParUpdate()
2635 Text & buftext = buffer_.text();
2636 pit_type const bottom_pit = d->cursor_.bottom().pit();
2637 TextMetrics & tm = textMetrics(&buftext);
2638 int old_height = tm.parMetrics(bottom_pit).height();
2640 // make sure inline completion pointer is ok
2641 if (d->inlineCompletionPos_.fixIfBroken())
2642 d->inlineCompletionPos_ = DocIterator();
2644 // In Single Paragraph mode, rebreak only
2645 // the (main text, not inset!) paragraph containing the cursor.
2646 // (if this paragraph contains insets etc., rebreaking will
2647 // recursively descend)
2648 tm.redoParagraph(bottom_pit);
2649 ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
2650 if (pm.height() != old_height)
2651 // Paragraph height has changed so we cannot proceed to
2652 // the singlePar optimisation.
2655 d->update_strategy_ = SingleParUpdate;
2657 LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
2658 << " y2: " << pm.position() + pm.descent()
2659 << " pit: " << bottom_pit
2660 << " singlepar: 1");
2665 void BufferView::updateMetrics()
2667 if (height_ == 0 || width_ == 0)
2670 Text & buftext = buffer_.text();
2671 pit_type const npit = int(buftext.paragraphs().size());
2673 // Clear out the position cache in case of full screen redraw,
2674 d->coord_cache_.clear();
2676 // Clear out paragraph metrics to avoid having invalid metrics
2677 // in the cache from paragraphs not relayouted below
2678 // The complete text metrics will be redone.
2679 d->text_metrics_.clear();
2681 TextMetrics & tm = textMetrics(&buftext);
2683 // make sure inline completion pointer is ok
2684 if (d->inlineCompletionPos_.fixIfBroken())
2685 d->inlineCompletionPos_ = DocIterator();
2687 if (d->anchor_pit_ >= npit)
2688 // The anchor pit must have been deleted...
2689 d->anchor_pit_ = npit - 1;
2691 // Rebreak anchor paragraph.
2692 tm.redoParagraph(d->anchor_pit_);
2693 ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
2696 if (d->anchor_pit_ == 0) {
2697 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
2699 // Complete buffer visible? Then it's easy.
2700 if (scrollRange == 0)
2701 d->anchor_ypos_ = anchor_pm.ascent();
2703 // FIXME: Some clever handling needed to show
2704 // the _first_ paragraph up to the top if the cursor is
2705 // in the first line.
2707 anchor_pm.setPosition(d->anchor_ypos_);
2709 LYXERR(Debug::PAINTING, "metrics: "
2710 << " anchor pit = " << d->anchor_pit_
2711 << " anchor ypos = " << d->anchor_ypos_);
2713 // Redo paragraphs above anchor if necessary.
2714 int y1 = d->anchor_ypos_ - anchor_pm.ascent();
2715 // We are now just above the anchor paragraph.
2716 pit_type pit1 = d->anchor_pit_ - 1;
2717 for (; pit1 >= 0 && y1 >= 0; --pit1) {
2718 tm.redoParagraph(pit1);
2719 ParagraphMetrics & pm = tm.par_metrics_[pit1];
2721 // Save the paragraph position in the cache.
2726 // Redo paragraphs below the anchor if necessary.
2727 int y2 = d->anchor_ypos_ + anchor_pm.descent();
2728 // We are now just below the anchor paragraph.
2729 pit_type pit2 = d->anchor_pit_ + 1;
2730 for (; pit2 < npit && y2 <= height_; ++pit2) {
2731 tm.redoParagraph(pit2);
2732 ParagraphMetrics & pm = tm.par_metrics_[pit2];
2734 // Save the paragraph position in the cache.
2739 LYXERR(Debug::PAINTING, "Metrics: "
2740 << " anchor pit = " << d->anchor_pit_
2741 << " anchor ypos = " << d->anchor_ypos_
2744 << " pit1 = " << pit1
2745 << " pit2 = " << pit2);
2747 d->update_strategy_ = FullScreenUpdate;
2749 if (lyxerr.debugging(Debug::WORKAREA)) {
2750 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
2751 d->coord_cache_.dump();
2756 void BufferView::insertLyXFile(FileName const & fname)
2758 LASSERT(d->cursor_.inTexted(), return);
2760 // Get absolute path of file and add ".lyx"
2761 // to the filename if necessary
2762 FileName filename = fileSearch(string(), fname.absFileName(), "lyx");
2764 docstring const disp_fn = makeDisplayPath(filename.absFileName());
2765 // emit message signal.
2766 message(bformat(_("Inserting document %1$s..."), disp_fn));
2769 Buffer buf(filename.absFileName(), false);
2770 if (buf.loadLyXFile() == Buffer::ReadSuccess) {
2771 ErrorList & el = buffer_.errorList("Parse");
2772 // Copy the inserted document error list into the current buffer one.
2773 el = buf.errorList("Parse");
2774 buffer_.undo().recordUndo(d->cursor_);
2775 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
2776 buf.params().documentClassPtr(), el);
2777 res = _("Document %1$s inserted.");
2779 res = _("Could not insert document %1$s");
2782 buffer_.changed(true);
2783 // emit message signal.
2784 message(bformat(res, disp_fn));
2788 Point BufferView::coordOffset(DocIterator const & dit) const
2794 // Addup contribution of nested insets, from inside to outside,
2795 // keeping the outer paragraph for a special handling below
2796 for (size_t i = dit.depth() - 1; i >= 1; --i) {
2797 CursorSlice const & sl = dit[i];
2801 // get relative position inside sl.inset()
2802 sl.inset().cursorPos(*this, sl, dit.boundary() && (i + 1 == dit.depth()), xx, yy);
2804 // Make relative position inside of the edited inset relative to sl.inset()
2808 // In case of an RTL inset, the edited inset will be positioned to the left
2811 bool boundary_i = dit.boundary() && i + 1 == dit.depth();
2812 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2817 // remember width for the case that sl.inset() is positioned in an RTL inset
2818 if (i && dit[i - 1].text()) {
2819 // If this Inset is inside a Text Inset, retrieve the Dimension
2820 // from the containing text instead of using Inset::dimension() which
2821 // might not be implemented.
2822 // FIXME (Abdel 23/09/2007): this is a bit messy because of the
2823 // elimination of Inset::dim_ cache. This coordOffset() method needs
2824 // to be rewritten in light of the new design.
2825 Dimension const & dim = coordCache().getInsets().dim(&sl.inset());
2828 Dimension const dim = sl.inset().dimension(*this);
2832 //lyxerr << "Cursor::getPos, i: "
2833 // << i << " x: " << xx << " y: " << y << endl;
2836 // Add contribution of initial rows of outermost paragraph
2837 CursorSlice const & sl = dit[0];
2838 TextMetrics const & tm = textMetrics(sl.text());
2839 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2841 LBUFERR(!pm.rows().empty());
2842 y -= pm.rows()[0].ascent();
2844 // FIXME: document this mess
2846 if (sl.pos() > 0 && dit.depth() == 1) {
2848 if (pos && dit.boundary())
2850 // lyxerr << "coordOffset: boundary:" << dit.boundary() << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
2851 rend = pm.pos2row(pos);
2853 rend = pm.pos2row(sl.pos());
2855 size_t rend = pm.pos2row(sl.pos());
2857 for (size_t rit = 0; rit != rend; ++rit)
2858 y += pm.rows()[rit].height();
2859 y += pm.rows()[rend].ascent();
2861 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
2863 // Make relative position from the nested inset now bufferview absolute.
2864 int xx = bottom_tm.cursorX(dit.bottom(), dit.boundary() && dit.depth() == 1);
2867 // In the RTL case place the nested inset at the left of the cursor in
2868 // the outer paragraph
2869 bool boundary_1 = dit.boundary() && 1 == dit.depth();
2870 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
2878 Point BufferView::getPos(DocIterator const & dit) const
2880 if (!paragraphVisible(dit))
2881 return Point(-1, -1);
2883 CursorSlice const & bot = dit.bottom();
2884 TextMetrics const & tm = textMetrics(bot.text());
2886 // offset from outer paragraph
2887 Point p = coordOffset(dit);
2888 p.y_ += tm.parMetrics(bot.pit()).position();
2893 bool BufferView::paragraphVisible(DocIterator const & dit) const
2895 CursorSlice const & bot = dit.bottom();
2896 TextMetrics const & tm = textMetrics(bot.text());
2898 return tm.contains(bot.pit());
2902 void BufferView::cursorPosAndHeight(Point & p, int & h) const
2904 Cursor const & cur = cursor();
2905 Font const font = cur.getFont();
2906 frontend::FontMetrics const & fm = theFontMetrics(font);
2907 int const asc = fm.maxAscent();
2908 int const des = fm.maxDescent();
2915 bool BufferView::cursorInView(Point const & p, int h) const
2917 Cursor const & cur = cursor();
2918 // does the cursor touch the screen ?
2919 if (p.y_ + h < 0 || p.y_ >= workHeight() || !paragraphVisible(cur))
2925 int BufferView::horizScrollOffset() const
2927 return d->horiz_scroll_offset_;
2931 int BufferView::horizScrollOffset(Text const * text,
2932 pit_type pit, pos_type pos) const
2934 // Is this a row that is currently scrolled?
2935 if (!d->current_row_slice_.empty()
2936 && &text->inset() == d->current_row_slice_.inset().asInsetText()
2937 && pit == d->current_row_slice_.pit()
2938 && pos == d->current_row_slice_.pos())
2939 return d->horiz_scroll_offset_;
2944 bool BufferView::hadHorizScrollOffset(Text const * text,
2945 pit_type pit, pos_type pos) const
2947 return !d->last_row_slice_.empty()
2948 && &text->inset() == d->last_row_slice_.inset().asInsetText()
2949 && pit == d->last_row_slice_.pit()
2950 && pos == d->last_row_slice_.pos();
2954 void BufferView::setCurrentRowSlice(CursorSlice const & rowSlice)
2956 // nothing to do if the cursor was already on this row
2957 if (d->current_row_slice_ == rowSlice) {
2958 d->last_row_slice_ = CursorSlice();
2962 // if the (previous) current row was scrolled, we have to
2963 // remember it in order to repaint it next time.
2964 if (d->horiz_scroll_offset_ != 0)
2965 d->last_row_slice_ = d->current_row_slice_;
2967 d->last_row_slice_ = CursorSlice();
2969 // Since we changed row, the scroll offset is not valid anymore
2970 d->horiz_scroll_offset_ = 0;
2971 d->current_row_slice_ = rowSlice;
2975 void BufferView::checkCursorScrollOffset(PainterInfo & pi)
2977 CursorSlice rowSlice = d->cursor_.bottom();
2978 TextMetrics const & tm = textMetrics(rowSlice.text());
2980 // Stop if metrics have not been computed yet, since it means
2981 // that there is nothing to do.
2982 if (!tm.contains(rowSlice.pit()))
2984 ParagraphMetrics const & pm = tm.parMetrics(rowSlice.pit());
2985 Row const & row = pm.getRow(rowSlice.pos(),
2986 d->cursor_.boundary() && rowSlice == d->cursor_.top());
2987 rowSlice.pos() = row.pos();
2989 // Set the row on which the cursor lives.
2990 setCurrentRowSlice(rowSlice);
2992 // If insets referred to by cursor are not all in the cache, the positions
2993 // need to be recomputed.
2994 if (!d->cursor_.inCoordCache()) {
2995 /** FIXME: the code below adds an extraneous computation of
2996 * inset positions, and can therefore be bad for performance
2997 * (think for example about a very large tabular inset.
2998 * Redawing the row where it is means redrawing the whole
3001 * The bug that this fixes is the following: assume that there
3002 * is a very large math inset. Upon entering the inset, when
3003 * pressing `End', the row is not scrolled and the cursor is
3004 * not visible. The extra row computation makes sure that the
3005 * inset positions are correctly computed and set in the
3006 * cache. This would not happen if we did not have two-stage
3009 * A proper fix would be to always have proper inset positions
3012 // Force the recomputation of inset positions
3013 bool const drawing = pi.pain.isDrawingEnabled();
3014 pi.pain.setDrawingEnabled(false);
3015 // No need to care about vertical position.
3016 RowPainter rp(pi, buffer().text(), row, -d->horiz_scroll_offset_, 0);
3018 pi.pain.setDrawingEnabled(drawing);
3021 // Current x position of the cursor in pixels
3022 int cur_x = getPos(d->cursor_).x_;
3024 // Horizontal scroll offset of the cursor row in pixels
3025 int offset = d->horiz_scroll_offset_;
3026 int const MARGIN = 2 * theFontMetrics(d->cursor_.real_current_font).em()
3028 if (row.right_x() <= workWidth() - row.right_margin) {
3029 // Row is narrower than the work area, no offset needed.
3032 if (cur_x - offset < MARGIN) {
3033 // cursor would be too far right
3034 offset = cur_x - MARGIN;
3035 } else if (cur_x - offset > workWidth() - MARGIN) {
3036 // cursor would be too far left
3037 offset = cur_x - workWidth() + MARGIN;
3039 // Correct the offset to make sure that we do not scroll too much
3042 if (row.right_x() - offset < workWidth() - row.right_margin)
3043 offset = row.right_x() - workWidth() + row.right_margin;
3046 //lyxerr << "cur_x=" << cur_x << ", offset=" << offset << ", row.wid=" << row.width() << ", margin=" << MARGIN << endl;
3048 if (offset != d->horiz_scroll_offset_)
3049 LYXERR(Debug::PAINTING, "Horiz. scroll offset changed from "
3050 << d->horiz_scroll_offset_ << " to " << offset);
3052 if (d->update_strategy_ == NoScreenUpdate
3053 && (offset != d->horiz_scroll_offset_
3054 || !d->last_row_slice_.empty())) {
3055 // FIXME: if one uses SingleParUpdate, then home/end
3056 // will not work on long rows. Why?
3057 d->update_strategy_ = FullScreenUpdate;
3060 d->horiz_scroll_offset_ = offset;
3064 void BufferView::draw(frontend::Painter & pain)
3066 if (height_ == 0 || width_ == 0)
3068 LYXERR(Debug::PAINTING, "\t\t*** START DRAWING ***");
3070 Text & text = buffer_.text();
3071 TextMetrics const & tm = d->text_metrics_[&text];
3072 int const y = tm.first().second->position();
3073 PainterInfo pi(this, pain);
3075 // Check whether the row where the cursor lives needs to be scrolled.
3076 // Update the drawing strategy if needed.
3077 checkCursorScrollOffset(pi);
3079 switch (d->update_strategy_) {
3081 case NoScreenUpdate:
3082 // If no screen painting is actually needed, only some the different
3083 // coordinates of insets and paragraphs needs to be updated.
3084 LYXERR(Debug::PAINTING, "Strategy: NoScreenUpdate");
3085 pi.full_repaint = true;
3086 pi.pain.setDrawingEnabled(false);
3090 case SingleParUpdate:
3091 pi.full_repaint = false;
3092 LYXERR(Debug::PAINTING, "Strategy: SingleParUpdate");
3093 // In general, only the current row of the outermost paragraph
3094 // will be redrawn. Particular cases where selection spans
3095 // multiple paragraph are correctly detected in TextMetrics.
3099 case DecorationUpdate:
3100 // FIXME: We should also distinguish DecorationUpdate to avoid text
3101 // drawing if possible. This is not possible to do easily right now
3102 // because of the single backing pixmap.
3104 case FullScreenUpdate:
3106 LYXERR(Debug::PAINTING,
3107 ((d->update_strategy_ == FullScreenUpdate)
3108 ? "Strategy: FullScreenUpdate"
3109 : "Strategy: DecorationUpdate"));
3111 // The whole screen, including insets, will be refreshed.
3112 pi.full_repaint = true;
3114 // Clear background.
3115 pain.fillRectangle(0, 0, width_, height_,
3116 pi.backgroundColor(&buffer_.inset()));
3121 // and possibly grey out below
3122 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3123 int const y2 = lastpm.second->position() + lastpm.second->descent();
3126 Color color = buffer().isInternal()
3127 ? Color_background : Color_bottomarea;
3128 pain.fillRectangle(0, y2, width_, height_ - y2, color);
3132 LYXERR(Debug::PAINTING, "\n\t\t*** END DRAWING ***");
3134 // The scrollbar needs an update.
3137 // Normalize anchor for next time
3138 pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
3139 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3140 for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
3141 ParagraphMetrics const & pm = tm.parMetrics(pit);
3142 if (pm.position() + pm.descent() > 0) {
3143 d->anchor_pit_ = pit;
3144 d->anchor_ypos_ = pm.position();
3148 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
3149 << " anchor ypos = " << d->anchor_ypos_);
3153 void BufferView::message(docstring const & msg)
3156 d->gui_->message(msg);
3160 void BufferView::showDialog(string const & name)
3163 d->gui_->showDialog(name, string());
3167 void BufferView::showDialog(string const & name,
3168 string const & data, Inset * inset)
3171 d->gui_->showDialog(name, data, inset);
3175 void BufferView::updateDialog(string const & name, string const & data)
3178 d->gui_->updateDialog(name, data);
3182 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
3188 // FIXME: Move this out of BufferView again
3189 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
3191 if (!fname.isReadableFile()) {
3192 docstring const error = from_ascii(strerror(errno));
3193 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3194 docstring const text =
3195 bformat(_("Could not read the specified document\n"
3196 "%1$s\ndue to the error: %2$s"), file, error);
3197 Alert::error(_("Could not read file"), text);
3201 if (!fname.isReadableFile()) {
3202 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3203 docstring const text =
3204 bformat(_("%1$s\n is not readable."), file);
3205 Alert::error(_("Could not open file"), text);
3209 // FIXME UNICODE: We don't know the encoding of the file
3210 docstring file_content = fname.fileContents("UTF-8");
3211 if (file_content.empty()) {
3212 Alert::error(_("Reading not UTF-8 encoded file"),
3213 _("The file is not UTF-8 encoded.\n"
3214 "It will be read as local 8Bit-encoded.\n"
3215 "If this does not give the correct result\n"
3216 "then please change the encoding of the file\n"
3217 "to UTF-8 with a program other than LyX.\n"));
3218 file_content = fname.fileContents("local8bit");
3221 return normalize_c(file_content);
3225 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
3227 docstring const tmpstr = contentsOfPlaintextFile(f);
3232 Cursor & cur = cursor();
3233 cap::replaceSelection(cur);
3234 buffer_.undo().recordUndo(cur);
3236 cur.innerText()->insertStringAsParagraphs(cur, tmpstr, cur.current_font);
3238 cur.innerText()->insertStringAsLines(cur, tmpstr, cur.current_font);
3240 buffer_.changed(true);
3244 docstring const & BufferView::inlineCompletion() const
3246 return d->inlineCompletion_;
3250 size_t const & BufferView::inlineCompletionUniqueChars() const
3252 return d->inlineCompletionUniqueChars_;
3256 DocIterator const & BufferView::inlineCompletionPos() const
3258 return d->inlineCompletionPos_;
3262 void BufferView::resetInlineCompletionPos()
3264 d->inlineCompletionPos_ = DocIterator();
3268 bool samePar(DocIterator const & a, DocIterator const & b)
3270 if (a.empty() && b.empty())
3272 if (a.empty() || b.empty())
3274 if (a.depth() != b.depth())
3276 return &a.innerParagraph() == &b.innerParagraph();
3280 void BufferView::setInlineCompletion(Cursor const & cur, DocIterator const & pos,
3281 docstring const & completion, size_t uniqueChars)
3283 uniqueChars = min(completion.size(), uniqueChars);
3284 bool changed = d->inlineCompletion_ != completion
3285 || d->inlineCompletionUniqueChars_ != uniqueChars;
3286 bool singlePar = true;
3287 d->inlineCompletion_ = completion;
3288 d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
3290 //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
3293 DocIterator const & old = d->inlineCompletionPos_;
3295 //lyxerr << "inlineCompletionPos changed" << std::endl;
3296 // old or pos are in another paragraph?
3297 if ((!samePar(cur, pos) && !pos.empty())
3298 || (!samePar(cur, old) && !old.empty())) {
3300 //lyxerr << "different paragraph" << std::endl;
3302 d->inlineCompletionPos_ = pos;
3307 if (singlePar && !(cur.result().screenUpdate() & Update::Force))
3308 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
3310 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::Force);
3315 bool BufferView::clickableInset() const
3317 return d->clickable_inset_;