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_TRACK:
1128 flag.setEnabled(true);
1129 flag.setOnOff(buffer_.params().track_changes);
1132 case LFUN_CHANGES_OUTPUT:
1133 flag.setEnabled(true);
1134 flag.setOnOff(buffer_.params().output_changes);
1137 case LFUN_CHANGES_MERGE:
1138 case LFUN_CHANGE_NEXT:
1139 case LFUN_CHANGE_PREVIOUS:
1140 case LFUN_ALL_CHANGES_ACCEPT:
1141 case LFUN_ALL_CHANGES_REJECT:
1142 // TODO: context-sensitive enabling of LFUNs
1143 // In principle, these command should only be enabled if there
1144 // is a change in the document. However, without proper
1145 // optimizations, this will inevitably result in poor performance.
1146 flag.setEnabled(true);
1149 case LFUN_BUFFER_TOGGLE_COMPRESSION: {
1150 flag.setOnOff(buffer_.params().compressed);
1154 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC: {
1155 flag.setOnOff(buffer_.params().output_sync);
1159 case LFUN_SCREEN_UP:
1160 case LFUN_SCREEN_DOWN:
1162 case LFUN_SCREEN_UP_SELECT:
1163 case LFUN_SCREEN_DOWN_SELECT:
1164 case LFUN_INSET_FORALL:
1165 flag.setEnabled(true);
1168 case LFUN_LAYOUT_TABULAR:
1169 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
1173 flag.setEnabled(!cur.inset().forcePlainLayout(cur.idx()));
1176 case LFUN_LAYOUT_PARAGRAPH:
1177 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
1180 case LFUN_BRANCH_ADD_INSERT:
1181 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1184 case LFUN_DIALOG_SHOW_NEW_INSET:
1185 // FIXME: this is wrong, but I do not understand the
1187 if (cur.inset().lyxCode() == CAPTION_CODE)
1188 return cur.inset().getStatus(cur, cmd, flag);
1189 // FIXME we should consider passthru paragraphs too.
1190 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1193 case LFUN_CITATION_INSERT: {
1194 FuncRequest fr(LFUN_INSET_INSERT, "citation");
1195 // FIXME: This could turn in a recursive hell.
1196 // Shouldn't we use Buffer::getStatus() instead?
1197 flag.setEnabled(lyx::getStatus(fr).enabled());
1200 case LFUN_INSET_APPLY: {
1201 string const name = cmd.getArg(0);
1202 Inset * inset = editedInset(name);
1204 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1205 if (!inset->getStatus(cur, fr, flag)) {
1206 // Every inset is supposed to handle this
1207 LASSERT(false, break);
1210 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1211 flag = lyx::getStatus(fr);
1224 Inset * BufferView::editedInset(string const & name) const
1226 map<string, Inset *>::const_iterator it = d->edited_insets_.find(name);
1227 return it == d->edited_insets_.end() ? 0 : it->second;
1231 void BufferView::editInset(string const & name, Inset * inset)
1233 d->edited_insets_[name] = inset;
1237 void BufferView::dispatch(FuncRequest const & cmd, DispatchResult & dr)
1239 LYXERR(Debug::ACTION, "BufferView::dispatch: cmd: " << cmd);
1241 string const argument = to_utf8(cmd.argument());
1242 Cursor & cur = d->cursor_;
1245 // Don't dispatch function that does not apply to internal buffers.
1246 if (buffer_.isInternal()
1247 && lyxaction.funcHasFlag(cmd.action(), LyXAction::NoInternal))
1250 // We'll set this back to false if need be.
1251 bool dispatched = true;
1252 buffer_.undo().beginUndoGroup();
1254 FuncCode const act = cmd.action();
1257 case LFUN_BUFFER_PARAMS_APPLY: {
1258 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1259 cur.recordUndoBufferParams();
1260 istringstream ss(to_utf8(cmd.argument()));
1263 int const unknown_tokens = buffer_.readHeader(lex);
1264 if (unknown_tokens != 0) {
1265 LYXERR0("Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1266 << unknown_tokens << " unknown token"
1267 << (unknown_tokens == 1 ? "" : "s"));
1269 updateDocumentClass(olddc);
1271 // We are most certainly here because of a change in the document
1272 // It is then better to make sure that all dialogs are in sync with
1273 // current document settings.
1274 dr.screenUpdate(Update::Force | Update::FitCursor);
1275 dr.forceBufferUpdate();
1279 case LFUN_LAYOUT_MODULES_CLEAR: {
1280 // FIXME: this modifies the document in cap::switchBetweenClasses
1281 // without calling recordUndo. Fix this before using
1282 // recordUndoBufferParams().
1283 cur.recordUndoFullBuffer();
1284 buffer_.params().clearLayoutModules();
1285 makeDocumentClass();
1286 dr.screenUpdate(Update::Force);
1287 dr.forceBufferUpdate();
1291 case LFUN_LAYOUT_MODULE_ADD: {
1292 BufferParams const & params = buffer_.params();
1293 if (!params.layoutModuleCanBeAdded(argument)) {
1294 LYXERR0("Module `" << argument <<
1295 "' cannot be added due to failed requirements or "
1296 "conflicts with installed modules.");
1299 // FIXME: this modifies the document in cap::switchBetweenClasses
1300 // without calling recordUndo. Fix this before using
1301 // recordUndoBufferParams().
1302 cur.recordUndoFullBuffer();
1303 buffer_.params().addLayoutModule(argument);
1304 makeDocumentClass();
1305 dr.screenUpdate(Update::Force);
1306 dr.forceBufferUpdate();
1310 case LFUN_TEXTCLASS_APPLY: {
1311 // since this shortcircuits, the second call is made only if
1313 bool const success =
1314 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1315 LayoutFileList::get().load(argument, buffer_.filePath());
1317 docstring s = bformat(_("The document class `%1$s' "
1318 "could not be loaded."), from_utf8(argument));
1319 frontend::Alert::error(_("Could not load class"), s);
1323 LayoutFile const * old_layout = buffer_.params().baseClass();
1324 LayoutFile const * new_layout = &(LayoutFileList::get()[argument]);
1326 if (old_layout == new_layout)
1330 // Save the old, possibly modular, layout for use in conversion.
1331 // FIXME: this modifies the document in cap::switchBetweenClasses
1332 // without calling recordUndo. Fix this before using
1333 // recordUndoBufferParams().
1334 cur.recordUndoFullBuffer();
1335 buffer_.params().setBaseClass(argument);
1336 makeDocumentClass();
1337 dr.screenUpdate(Update::Force);
1338 dr.forceBufferUpdate();
1342 case LFUN_TEXTCLASS_LOAD: {
1343 // since this shortcircuits, the second call is made only if
1345 bool const success =
1346 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1347 LayoutFileList::get().load(argument, buffer_.filePath());
1349 docstring s = bformat(_("The document class `%1$s' "
1350 "could not be loaded."), from_utf8(argument));
1351 frontend::Alert::error(_("Could not load class"), s);
1356 case LFUN_LAYOUT_RELOAD: {
1357 LayoutFileIndex bc = buffer_.params().baseClassID();
1358 LayoutFileList::get().reset(bc);
1359 buffer_.params().setBaseClass(bc);
1360 makeDocumentClass();
1361 dr.screenUpdate(Update::Force);
1362 dr.forceBufferUpdate();
1367 dr.setMessage(_("Undo"));
1368 cur.clearSelection();
1369 if (!cur.textUndo())
1370 dr.setMessage(_("No further undo information"));
1372 dr.screenUpdate(Update::Force | Update::FitCursor);
1373 dr.forceBufferUpdate();
1377 dr.setMessage(_("Redo"));
1378 cur.clearSelection();
1379 if (!cur.textRedo())
1380 dr.setMessage(_("No further redo information"));
1382 dr.screenUpdate(Update::Force | Update::FitCursor);
1383 dr.forceBufferUpdate();
1386 case LFUN_FONT_STATE:
1387 dr.setMessage(cur.currentState());
1390 case LFUN_BOOKMARK_SAVE:
1391 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1394 case LFUN_LABEL_GOTO: {
1395 docstring label = cmd.argument();
1396 if (label.empty()) {
1398 getInsetByCode<InsetRef>(cur, REF_CODE);
1400 label = inset->getParam("reference");
1401 // persistent=false: use temp_bookmark
1405 if (!label.empty()) {
1407 // at the moment, this is redundant, since gotoLabel will
1408 // eventually call LFUN_PARAGRAPH_GOTO, but it seems best
1410 dr.screenUpdate(Update::Force | Update::FitCursor);
1415 case LFUN_PARAGRAPH_GOTO: {
1416 int const id = convert<int>(cmd.getArg(0));
1417 int const pos = convert<int>(cmd.getArg(1));
1419 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1420 b = theBufferList().next(b)) {
1423 cur.setCursor(b->getParFromID(id));
1425 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1429 LYXERR(Debug::INFO, "Paragraph " << cur.paragraph().id()
1430 << " found in buffer `"
1431 << b->absFileName() << "'.");
1433 if (b == &buffer_) {
1436 mouseSetCursor(cur);
1437 dr.screenUpdate(Update::Force | Update::FitCursor);
1439 // Switch to other buffer view and resend cmd
1440 lyx::dispatch(FuncRequest(
1441 LFUN_BUFFER_SWITCH, b->absFileName()));
1449 case LFUN_NOTE_NEXT:
1450 gotoInset(this, NOTE_CODE, false);
1453 case LFUN_REFERENCE_NEXT: {
1454 vector<InsetCode> tmp;
1455 tmp.push_back(LABEL_CODE);
1456 tmp.push_back(REF_CODE);
1457 gotoInset(this, tmp, true);
1461 case LFUN_CHANGES_TRACK:
1462 buffer_.params().track_changes = !buffer_.params().track_changes;
1465 case LFUN_CHANGES_OUTPUT:
1466 buffer_.params().output_changes = !buffer_.params().output_changes;
1467 if (buffer_.params().output_changes) {
1468 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1469 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1470 LaTeXFeatures::isAvailable("xcolor");
1472 if (!dvipost && !xcolorulem) {
1473 Alert::warning(_("Changes not shown in LaTeX output"),
1474 _("Changes will not be highlighted in LaTeX output, "
1475 "because neither dvipost nor xcolor/ulem are installed.\n"
1476 "Please install these packages or redefine "
1477 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1478 } else if (!xcolorulem) {
1479 Alert::warning(_("Changes not shown in LaTeX output"),
1480 _("Changes will not be highlighted in LaTeX output "
1481 "when using pdflatex, because xcolor and ulem are not installed.\n"
1482 "Please install both packages or redefine "
1483 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1488 case LFUN_CHANGE_NEXT:
1489 findNextChange(this);
1490 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1491 dr.screenUpdate(Update::Force | Update::FitCursor);
1494 case LFUN_CHANGE_PREVIOUS:
1495 findPreviousChange(this);
1496 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1497 dr.screenUpdate(Update::Force | Update::FitCursor);
1500 case LFUN_CHANGES_MERGE:
1501 if (findNextChange(this) || findPreviousChange(this)) {
1502 dr.screenUpdate(Update::Force | Update::FitCursor);
1503 dr.forceBufferUpdate();
1504 showDialog("changes");
1508 case LFUN_ALL_CHANGES_ACCEPT:
1509 // select complete document
1511 cur.selHandle(true);
1512 buffer_.text().cursorBottom(cur);
1513 // accept everything in a single step to support atomic undo
1514 buffer_.text().acceptOrRejectChanges(cur, Text::ACCEPT);
1516 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1517 dr.screenUpdate(Update::Force | Update::FitCursor);
1518 dr.forceBufferUpdate();
1521 case LFUN_ALL_CHANGES_REJECT:
1522 // select complete document
1524 cur.selHandle(true);
1525 buffer_.text().cursorBottom(cur);
1526 // reject everything in a single step to support atomic undo
1527 // Note: reject does not work recursively; the user may have to repeat the operation
1528 buffer_.text().acceptOrRejectChanges(cur, Text::REJECT);
1530 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1531 dr.screenUpdate(Update::Force | Update::FitCursor);
1532 dr.forceBufferUpdate();
1535 case LFUN_WORD_FIND_FORWARD:
1536 case LFUN_WORD_FIND_BACKWARD: {
1538 // Would it maybe be better if this variable were view specific anyway?
1539 static docstring last_search;
1540 docstring searched_string;
1542 if (!cmd.argument().empty()) {
1543 last_search = cmd.argument();
1544 searched_string = cmd.argument();
1546 searched_string = last_search;
1549 if (searched_string.empty())
1552 bool const fw = act == LFUN_WORD_FIND_FORWARD;
1553 docstring const data =
1554 find2string(searched_string, true, false, fw);
1555 bool found = lyxfind(this, FuncRequest(LFUN_WORD_FIND, data));
1557 dr.screenUpdate(Update::Force | Update::FitCursor);
1567 case LFUN_WORD_FIND: {
1568 FuncRequest req = cmd;
1569 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1570 req = d->search_request_cache_;
1571 if (req.argument().empty()) {
1572 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, "findreplace"));
1575 if (lyxfind(this, req)) {
1576 dr.screenUpdate(Update::Force | Update::FitCursor);
1583 d->search_request_cache_ = req;
1587 case LFUN_WORD_REPLACE: {
1588 bool has_deleted = false;
1589 if (cur.selection()) {
1590 DocIterator beg = cur.selectionBegin();
1591 DocIterator end = cur.selectionEnd();
1592 if (beg.pit() == end.pit()) {
1593 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1594 if (!cur.inMathed() && cur.paragraph().isDeleted(p)) {
1601 if (lyxreplace(this, cmd, has_deleted)) {
1602 dr.forceBufferUpdate();
1603 dr.screenUpdate(Update::Force | Update::FitCursor);
1613 case LFUN_WORD_FINDADV: {
1614 FindAndReplaceOptions opt;
1615 istringstream iss(to_utf8(cmd.argument()));
1617 if (findAdv(this, opt)) {
1618 dr.screenUpdate(Update::Force | Update::FitCursor);
1629 cur.clearSelection();
1630 dr.setMessage(from_utf8(N_("Mark off")));
1634 cur.clearSelection();
1636 dr.setMessage(from_utf8(N_("Mark on")));
1639 case LFUN_MARK_TOGGLE:
1640 cur.setSelection(false);
1643 dr.setMessage(from_utf8(N_("Mark removed")));
1646 dr.setMessage(from_utf8(N_("Mark set")));
1651 case LFUN_SCREEN_SHOW_CURSOR:
1655 case LFUN_SCREEN_RECENTER:
1659 case LFUN_BIBTEX_DATABASE_ADD: {
1660 Cursor tmpcur = cur;
1661 findInset(tmpcur, BIBTEX_CODE, false);
1662 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1665 if (inset->addDatabase(cmd.argument())) {
1666 buffer_.invalidateBibfileCache();
1667 dr.forceBufferUpdate();
1673 case LFUN_BIBTEX_DATABASE_DEL: {
1674 Cursor tmpcur = cur;
1675 findInset(tmpcur, BIBTEX_CODE, false);
1676 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1679 if (inset->delDatabase(cmd.argument())) {
1680 buffer_.invalidateBibfileCache();
1681 dr.forceBufferUpdate();
1687 case LFUN_STATISTICS: {
1688 DocIterator from, to;
1689 if (cur.selection()) {
1690 from = cur.selectionBegin();
1691 to = cur.selectionEnd();
1693 from = doc_iterator_begin(&buffer_);
1694 to = doc_iterator_end(&buffer_);
1696 buffer_.updateStatistics(from, to);
1697 int const words = buffer_.wordCount();
1698 int const chars = buffer_.charCount(false);
1699 int const chars_blanks = buffer_.charCount(true);
1701 if (cur.selection())
1702 message = _("Statistics for the selection:");
1704 message = _("Statistics for the document:");
1707 message += bformat(_("%1$d words"), words);
1709 message += _("One word");
1711 if (chars_blanks != 1)
1712 message += bformat(_("%1$d characters (including blanks)"),
1715 message += _("One character (including blanks)");
1718 message += bformat(_("%1$d characters (excluding blanks)"),
1721 message += _("One character (excluding blanks)");
1723 Alert::information(_("Statistics"), message);
1727 case LFUN_BUFFER_TOGGLE_COMPRESSION:
1728 // turn compression on/off
1729 buffer_.params().compressed = !buffer_.params().compressed;
1732 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
1733 buffer_.params().output_sync = !buffer_.params().output_sync;
1736 case LFUN_SCREEN_UP:
1737 case LFUN_SCREEN_DOWN: {
1738 Point p = getPos(cur);
1739 // This code has been commented out to enable to scroll down a
1740 // document, even if there are large insets in it (see bug #5465).
1741 /*if (p.y_ < 0 || p.y_ > height_) {
1742 // The cursor is off-screen so recenter before proceeding.
1746 int const scrolled = scroll(act == LFUN_SCREEN_UP
1747 ? -height_ : height_);
1748 if (act == LFUN_SCREEN_UP && scrolled > -height_)
1750 if (act == LFUN_SCREEN_DOWN && scrolled < height_)
1751 p = Point(width_, height_);
1752 bool const in_texted = cur.inTexted();
1753 cur.setCursor(doc_iterator_begin(cur.buffer()));
1754 cur.selHandle(false);
1755 buffer_.changed(true);
1756 updateHoveredInset();
1758 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_,
1759 true, act == LFUN_SCREEN_UP);
1760 //FIXME: what to do with cur.x_target()?
1761 bool update = in_texted && cur.bv().checkDepm(cur, old);
1764 if (update || cur.mark())
1765 dr.screenUpdate(Update::Force | Update::FitCursor);
1767 dr.forceBufferUpdate();
1772 string const scroll_type = cmd.getArg(0);
1773 int scroll_step = 0;
1774 if (scroll_type == "line")
1775 scroll_step = d->scrollbarParameters_.single_step;
1776 else if (scroll_type == "page")
1777 scroll_step = d->scrollbarParameters_.page_step;
1780 string const scroll_quantity = cmd.getArg(1);
1781 if (scroll_quantity == "up")
1782 scrollUp(scroll_step);
1783 else if (scroll_quantity == "down")
1784 scrollDown(scroll_step);
1786 int const scroll_value = convert<int>(scroll_quantity);
1788 scroll(scroll_step * scroll_value);
1790 buffer_.changed(true);
1791 updateHoveredInset();
1792 dr.forceBufferUpdate();
1796 case LFUN_SCREEN_UP_SELECT: {
1797 // FIXME: why is the algorithm different from LFUN_SCREEN_UP?
1798 cur.selHandle(true);
1799 if (isTopScreen()) {
1800 lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1804 int y = getPos(cur).y_;
1805 int const ymin = y - height_ + defaultRowHeight();
1806 while (y > ymin && cur.up())
1810 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1814 case LFUN_SCREEN_DOWN_SELECT: {
1815 // FIXME: why is the algorithm different from LFUN_SCREEN_DOWN?
1816 cur.selHandle(true);
1817 if (isBottomScreen()) {
1818 lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1822 int y = getPos(cur).y_;
1823 int const ymax = y + height_ - defaultRowHeight();
1824 while (y < ymax && cur.down())
1828 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1833 case LFUN_INSET_SELECT_ALL:
1835 && cur.selBegin().at_begin()
1836 && cur.selEnd().at_end()) {
1837 // All the contents of the inset if selected.
1838 // Select the inset from outside.
1841 cur.setSelection(true);
1843 } else if (cur.selBegin().idx() != cur.selEnd().idx()
1845 && cur.selBegin().at_cell_begin()
1846 && cur.selEnd().at_cell_end())) {
1847 // At least one complete cell is selected.
1852 cur.setSelection(true);
1853 cur.idx() = cur.lastidx();
1854 cur.pos() = cur.lastpos();
1856 // select current cell
1860 cur.setSelection(true);
1861 cur.pit() = cur.lastpit();
1862 cur.pos() = cur.lastpos();
1864 cur.setCurrentFont();
1865 dr.screenUpdate(Update::Force);
1869 // This would be in Buffer class if only Cursor did not
1870 // require a bufferview
1871 case LFUN_INSET_FORALL: {
1872 docstring const name = from_utf8(cmd.getArg(0));
1873 string const commandstr = cmd.getLongArg(1);
1874 FuncRequest const fr = lyxaction.lookupFunc(commandstr);
1876 // an arbitrary number to limit number of iterations
1877 const int max_iter = 100000;
1879 Cursor & cur = d->cursor_;
1880 Cursor const savecur = cur;
1882 if (!cur.nextInset())
1884 cur.beginUndoGroup();
1885 while(cur && iterations < max_iter) {
1886 Inset * const ins = cur.nextInset();
1889 docstring insname = ins->layoutName();
1890 while (!insname.empty()) {
1891 if (insname == name || name == from_utf8("*")) {
1893 lyx::dispatch(fr, dr);
1897 size_t const i = insname.rfind(':');
1898 if (i == string::npos)
1900 insname = insname.substr(0, i);
1902 // if we did not delete the inset, skip it
1903 if (!cur.nextInset() || cur.nextInset() == ins)
1909 dr.screenUpdate(Update::Force);
1910 dr.forceBufferUpdate();
1912 if (iterations >= max_iter) {
1914 dr.setMessage(bformat(_("`inset-forall' interrupted because number of actions is larger than %1$d"), max_iter));
1916 dr.setMessage(bformat(_("Applied \"%1$s\" to %2$d insets"), from_utf8(commandstr), iterations));
1921 case LFUN_BRANCH_ADD_INSERT: {
1922 docstring branch_name = from_utf8(cmd.getArg(0));
1923 if (branch_name.empty())
1924 if (!Alert::askForText(branch_name, _("Branch name")) ||
1925 branch_name.empty())
1928 DispatchResult drtmp;
1929 buffer_.dispatch(FuncRequest(LFUN_BRANCH_ADD, branch_name), drtmp);
1930 if (drtmp.error()) {
1931 Alert::warning(_("Branch already exists"), drtmp.message());
1934 BranchList & branch_list = buffer_.params().branchlist();
1935 vector<docstring> const branches =
1936 getVectorFromString(branch_name, branch_list.separator());
1937 for (vector<docstring>::const_iterator it = branches.begin();
1938 it != branches.end(); ++it) {
1940 lyx::dispatch(FuncRequest(LFUN_BRANCH_INSERT, branch_name));
1945 case LFUN_KEYMAP_OFF:
1946 getIntl().keyMapOn(false);
1949 case LFUN_KEYMAP_PRIMARY:
1950 getIntl().keyMapPrim();
1953 case LFUN_KEYMAP_SECONDARY:
1954 getIntl().keyMapSec();
1957 case LFUN_KEYMAP_TOGGLE:
1958 getIntl().toggleKeyMap();
1961 case LFUN_DIALOG_SHOW_NEW_INSET: {
1962 string const name = cmd.getArg(0);
1963 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
1964 if (decodeInsetParam(name, data, buffer_))
1965 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
1967 lyxerr << "Inset type '" << name <<
1968 "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" << endl;
1972 case LFUN_CITATION_INSERT: {
1973 if (argument.empty()) {
1974 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
1977 // we can have one optional argument, delimited by '|'
1978 // citation-insert <key>|<text_before>
1979 // this should be enhanced to also support text_after
1980 // and citation style
1981 string arg = argument;
1983 if (contains(argument, "|")) {
1984 arg = token(argument, '|', 0);
1985 opt1 = token(argument, '|', 1);
1988 // if our cursor is directly in front of or behind a citation inset,
1989 // we will instead add the new key to it.
1990 Inset * inset = cur.nextInset();
1991 if (!inset || inset->lyxCode() != CITE_CODE)
1992 inset = cur.prevInset();
1993 if (inset && inset->lyxCode() == CITE_CODE) {
1994 InsetCitation * icite = static_cast<InsetCitation *>(inset);
1995 if (icite->addKey(arg)) {
1996 dr.forceBufferUpdate();
1997 dr.screenUpdate(Update::FitCursor | Update::SinglePar);
1999 LYXERR0("Discarding optional argument to citation-insert.");
2004 InsetCommandParams icp(CITE_CODE);
2005 icp["key"] = from_utf8(arg);
2007 icp["before"] = from_utf8(opt1);
2008 string icstr = InsetCommand::params2string(icp);
2009 FuncRequest fr(LFUN_INSET_INSERT, icstr);
2014 case LFUN_INSET_APPLY: {
2015 string const name = cmd.getArg(0);
2016 Inset * inset = editedInset(name);
2018 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
2022 // put cursor in front of inset.
2023 if (!setCursorFromInset(inset)) {
2024 LASSERT(false, break);
2027 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
2028 inset->dispatch(cur, fr);
2029 dr.screenUpdate(cur.result().screenUpdate());
2030 if (cur.result().needBufferUpdate())
2031 dr.forceBufferUpdate();
2036 // The change of language of buffer belongs to the Buffer class.
2037 // We have to do it here because we need a cursor for Undo.
2038 // When Undo::recordUndoBufferParams() is implemented someday
2039 // LFUN_BUFFER_LANGUAGE should be handled by the Buffer class.
2040 case LFUN_BUFFER_LANGUAGE: {
2041 Language const * oldL = buffer_.params().language;
2042 Language const * newL = languages.getLanguage(argument);
2043 if (!newL || oldL == newL)
2045 if (oldL->rightToLeft() == newL->rightToLeft()) {
2046 cur.recordUndoFullBuffer();
2047 buffer_.changeLanguage(oldL, newL);
2048 cur.setCurrentFont();
2049 dr.forceBufferUpdate();
2054 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
2055 case LFUN_FILE_INSERT_PLAINTEXT: {
2056 bool const as_paragraph = (act == LFUN_FILE_INSERT_PLAINTEXT_PARA);
2057 string const fname = to_utf8(cmd.argument());
2058 if (!FileName::isAbsolute(fname))
2059 dr.setMessage(_("Absolute filename expected."));
2061 insertPlaintextFile(FileName(fname), as_paragraph);
2066 // OK, so try the Buffer itself...
2067 buffer_.dispatch(cmd, dr);
2068 dispatched = dr.dispatched();
2072 buffer_.undo().endUndoGroup();
2073 dr.dispatched(dispatched);
2075 // NOTE: The code below is copied from Cursor::dispatch. If you
2076 // need to modify this, please update the other one too.
2078 // notify insets we just entered/left
2079 if (cursor() != old) {
2080 old.beginUndoGroup();
2082 bool badcursor = notifyCursorLeavesOrEnters(old, cursor());
2084 cursor().fixIfBroken();
2085 resetInlineCompletionPos();
2092 docstring const BufferView::requestSelection()
2094 Cursor & cur = d->cursor_;
2096 LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
2097 if (!cur.selection()) {
2098 d->xsel_cache_.set = false;
2102 LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
2103 if (!d->xsel_cache_.set ||
2104 cur.top() != d->xsel_cache_.cursor ||
2105 cur.realAnchor().top() != d->xsel_cache_.anchor)
2107 d->xsel_cache_.cursor = cur.top();
2108 d->xsel_cache_.anchor = cur.realAnchor().top();
2109 d->xsel_cache_.set = cur.selection();
2110 return cur.selectionAsString(false);
2116 void BufferView::clearSelection()
2118 d->cursor_.clearSelection();
2119 // Clear the selection buffer. Otherwise a subsequent
2120 // middle-mouse-button paste would use the selection buffer,
2121 // not the more current external selection.
2122 cap::clearSelection();
2123 d->xsel_cache_.set = false;
2124 // The buffer did not really change, but this causes the
2125 // redraw we need because we cleared the selection above.
2126 buffer_.changed(false);
2130 void BufferView::resize(int width, int height)
2132 // Update from work area
2136 // Clear the paragraph height cache.
2137 d->par_height_.clear();
2138 // Redo the metrics.
2143 Inset const * BufferView::getCoveringInset(Text const & text,
2146 TextMetrics & tm = d->text_metrics_[&text];
2147 Inset * inset = tm.checkInsetHit(x, y);
2151 if (!inset->descendable(*this))
2152 // No need to go further down if the inset is not
2156 size_t cell_number = inset->nargs();
2157 // Check all the inner cell.
2158 for (size_t i = 0; i != cell_number; ++i) {
2159 Text const * inner_text = inset->getText(i);
2162 Inset const * inset_deeper =
2163 getCoveringInset(*inner_text, x, y);
2165 return inset_deeper;
2173 void BufferView::updateHoveredInset() const
2175 // Get inset under mouse, if there is one.
2176 int const x = d->mouse_position_cache_.x_;
2177 int const y = d->mouse_position_cache_.y_;
2178 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
2180 d->clickable_inset_ = covering_inset && covering_inset->clickable(x, y);
2182 if (covering_inset == d->last_inset_)
2183 // Same inset, no need to do anything...
2186 bool need_redraw = false;
2187 if (d->last_inset_) {
2188 // Remove the hint on the last hovered inset (if any).
2189 need_redraw |= d->last_inset_->setMouseHover(this, false);
2193 if (covering_inset && covering_inset->setMouseHover(this, true)) {
2195 // Only the insets that accept the hover state, do
2196 // clear the last_inset_, so only set the last_inset_
2197 // member if the hovered setting is accepted.
2198 d->last_inset_ = covering_inset;
2202 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
2203 << d->mouse_position_cache_.x_ << ", "
2204 << d->mouse_position_cache_.y_ << ")");
2206 d->update_strategy_ = DecorationUpdate;
2208 // This event (moving without mouse click) is not passed further.
2209 // This should be changed if it is further utilized.
2210 buffer_.changed(false);
2215 void BufferView::clearLastInset(Inset * inset) const
2217 if (d->last_inset_ != inset) {
2218 LYXERR0("Wrong last_inset!");
2225 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
2227 //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
2229 // This is only called for mouse related events including
2230 // LFUN_FILE_OPEN generated by drag-and-drop.
2231 FuncRequest cmd = cmd0;
2233 Cursor old = cursor();
2235 cur.push(buffer_.inset());
2236 cur.setSelection(d->cursor_.selection());
2238 // Either the inset under the cursor or the
2239 // surrounding Text will handle this event.
2241 // make sure we stay within the screen...
2242 cmd.set_y(min(max(cmd.y(), -1), height_));
2244 d->mouse_position_cache_.x_ = cmd.x();
2245 d->mouse_position_cache_.y_ = cmd.y();
2247 if (cmd.action() == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
2248 updateHoveredInset();
2252 // Build temporary cursor.
2253 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x(), cmd.y());
2255 // If inset is not editable, cur.pos() might point behind the
2256 // inset (depending on cmd.x(), cmd.y()). This is needed for
2257 // editing to fix bug 9628, but e.g. the context menu needs a
2258 // cursor in front of the inset.
2259 if (inset->hasSettings() &&
2260 cur.nextInset() != inset && cur.prevInset() == inset)
2264 // Put anchor at the same position.
2267 cur.beginUndoGroup();
2269 // Try to dispatch to an non-editable inset near this position
2270 // via the temp cursor. If the inset wishes to change the real
2271 // cursor it has to do so explicitly by using
2272 // cur.bv().cursor() = cur; (or similar)
2274 inset->dispatch(cur, cmd);
2276 // Now dispatch to the temporary cursor. If the real cursor should
2277 // be modified, the inset's dispatch has to do so explicitly.
2278 if (!inset || !cur.result().dispatched())
2283 // Notify left insets
2285 bool badcursor = old.fixIfBroken() | cur.fixIfBroken();
2286 badcursor |= notifyCursorLeavesOrEnters(old, cur);
2288 cursor().fixIfBroken();
2291 // Do we have a selection?
2292 theSelection().haveSelection(cursor().selection());
2294 if (cur.needBufferUpdate()) {
2295 cur.clearBufferUpdate();
2296 buffer().updateBuffer();
2299 // If the command has been dispatched,
2300 if (cur.result().dispatched() || cur.result().screenUpdate())
2301 processUpdateFlags(cur.result().screenUpdate());
2305 int BufferView::minVisiblePart()
2307 return 2 * defaultRowHeight();
2311 int BufferView::scroll(int y)
2314 return scrollDown(y);
2316 return scrollUp(-y);
2321 int BufferView::scrollDown(int offset)
2323 Text * text = &buffer_.text();
2324 TextMetrics & tm = d->text_metrics_[text];
2325 int const ymax = height_ + offset;
2327 pair<pit_type, ParagraphMetrics const *> last = tm.last();
2328 int bottom_pos = last.second->position() + last.second->descent();
2329 if (lyxrc.scroll_below_document)
2330 bottom_pos += height_ - minVisiblePart();
2331 if (last.first + 1 == int(text->paragraphs().size())) {
2332 if (bottom_pos <= height_)
2334 offset = min(offset, bottom_pos - height_);
2337 if (bottom_pos > ymax)
2339 tm.newParMetricsDown();
2341 d->anchor_ypos_ -= offset;
2346 int BufferView::scrollUp(int offset)
2348 Text * text = &buffer_.text();
2349 TextMetrics & tm = d->text_metrics_[text];
2350 int ymin = - offset;
2352 pair<pit_type, ParagraphMetrics const *> first = tm.first();
2353 int top_pos = first.second->position() - first.second->ascent();
2354 if (first.first == 0) {
2357 offset = min(offset, - top_pos);
2362 tm.newParMetricsUp();
2364 d->anchor_ypos_ += offset;
2369 void BufferView::setCursorFromRow(int row)
2371 setCursorFromRow(row, buffer_.texrow());
2375 void BufferView::setCursorFromRow(int row, TexRow const & texrow)
2379 pit_type newpit = 0;
2380 pos_type newpos = 0;
2382 texrow.getIdFromRow(row, tmpid, tmppos);
2384 bool posvalid = (tmpid != -1);
2386 // we need to make sure that the row and position
2387 // we got back are valid, because the buffer may well
2388 // have changed since we last generated the LaTeX.
2389 DocIterator dit = buffer_.getParFromID(tmpid);
2390 if (dit == doc_iterator_end(&buffer_))
2392 else if (dit.depth() > 1) {
2393 // We are in an inset.
2394 pos_type lastpos = dit.lastpos();
2395 dit.pos() = tmppos > lastpos ? lastpos : tmppos;
2401 // now have to check pos.
2403 Paragraph const & par = buffer_.text().getPar(newpit);
2404 if (newpos > par.size()) {
2405 LYXERR0("Requested position no longer valid.");
2406 newpos = par.size() - 1;
2411 frontend::Alert::error(_("Inverse Search Failed"),
2412 _("Invalid position requested by inverse search.\n"
2413 "You need to update the viewed document."));
2417 buffer_.text().setCursor(d->cursor_, newpit, newpos);
2418 d->cursor_.setSelection(false);
2419 d->cursor_.resetAnchor();
2424 bool BufferView::setCursorFromInset(Inset const * inset)
2426 // are we already there?
2427 if (cursor().nextInset() == inset)
2430 // Inset is not at cursor position. Find it in the document.
2433 while (cur && cur.nextInset() != inset)
2444 void BufferView::gotoLabel(docstring const & label)
2446 ListOfBuffers bufs = buffer().allRelatives();
2447 ListOfBuffers::iterator it = bufs.begin();
2448 for (; it != bufs.end(); ++it) {
2449 Buffer const * buf = *it;
2452 shared_ptr<Toc> toc = buf->tocBackend().toc("label");
2453 TocIterator toc_it = toc->begin();
2454 TocIterator end = toc->end();
2455 for (; toc_it != end; ++toc_it) {
2456 if (label == toc_it->str()) {
2457 lyx::dispatch(toc_it->action());
2465 TextMetrics const & BufferView::textMetrics(Text const * t) const
2467 return const_cast<BufferView *>(this)->textMetrics(t);
2471 TextMetrics & BufferView::textMetrics(Text const * t)
2474 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
2475 if (tmc_it == d->text_metrics_.end()) {
2476 tmc_it = d->text_metrics_.insert(
2477 make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
2479 return tmc_it->second;
2483 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
2486 return textMetrics(t).parMetrics(pit);
2490 int BufferView::workHeight() const
2496 void BufferView::setCursor(DocIterator const & dit)
2499 size_t const n = dit.depth();
2500 for (size_t i = 0; i < n; ++i)
2501 dit[i].inset().edit(d->cursor_, true);
2503 d->cursor_.setCursor(dit);
2504 d->cursor_.setSelection(false);
2505 d->cursor_.setCurrentFont();
2507 // It seems on general grounds as if this is probably needed, but
2508 // it is not yet clear.
2509 // See bug #7394 and r38388.
2510 // d->cursor.resetAnchor();
2514 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
2516 // Would be wrong to delete anything if we have a selection.
2517 if (cur.selection())
2520 bool need_anchor_change = false;
2521 bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
2522 need_anchor_change);
2524 if (need_anchor_change)
2532 // we would rather not do this here, but it needs to be done before
2533 // the changed() signal is sent.
2534 buffer_.updateBuffer();
2536 buffer_.changed(true);
2541 bool BufferView::mouseSetCursor(Cursor & cur, bool select)
2543 LASSERT(&cur.bv() == this, return false);
2546 // this event will clear selection so we save selection for
2547 // persistent selection
2548 cap::saveSelection(cursor());
2550 d->cursor_.macroModeClose();
2551 // If a macro has been finalized, the cursor might have been broken
2554 // Has the cursor just left the inset?
2555 bool const leftinset = (&d->cursor_.inset() != &cur.inset());
2557 d->cursor_.fixIfBroken();
2559 // FIXME: shift-mouse selection doesn't work well across insets.
2560 bool const do_selection =
2561 select && &d->cursor_.normalAnchor().inset() == &cur.inset();
2563 // do the dEPM magic if needed
2564 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
2565 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
2566 // the leftinset bool would not be necessary (badcursor instead).
2567 bool update = leftinset;
2568 if (!do_selection && d->cursor_.inTexted())
2569 update |= checkDepm(cur, d->cursor_);
2572 d->cursor_.resetAnchor();
2573 d->cursor_.setCursor(cur);
2574 d->cursor_.boundary(cur.boundary());
2576 d->cursor_.setSelection();
2578 d->cursor_.clearSelection();
2580 d->cursor_.finishUndo();
2581 d->cursor_.setCurrentFont();
2583 cur.forceBufferUpdate();
2588 void BufferView::putSelectionAt(DocIterator const & cur,
2589 int length, bool backwards)
2591 d->cursor_.clearSelection();
2597 d->cursor_.pos() += length;
2598 d->cursor_.setSelection(d->cursor_, -length);
2600 d->cursor_.setSelection(d->cursor_, length);
2605 bool BufferView::selectIfEmpty(DocIterator & cur)
2607 if ((cur.inTexted() && !cur.paragraph().empty())
2608 || (cur.inMathed() && !cur.cell().empty()))
2611 pit_type const beg_pit = cur.pit();
2613 // The paragraph associated to this item isn't
2614 // the first one, so it can be selected
2617 // We have to resort to select the space between the
2618 // end of this item and the begin of the next one
2622 // If it is the only item in the document,
2623 // nothing can be selected
2626 pit_type const end_pit = cur.pit();
2627 pos_type const end_pos = cur.pos();
2628 d->cursor_.clearSelection();
2630 d->cursor_.setCursor(cur);
2631 d->cursor_.pit() = beg_pit;
2632 d->cursor_.pos() = 0;
2633 d->cursor_.setSelection(false);
2634 d->cursor_.resetAnchor();
2635 d->cursor_.pit() = end_pit;
2636 d->cursor_.pos() = end_pos;
2637 d->cursor_.setSelection();
2642 Cursor & BufferView::cursor()
2648 Cursor const & BufferView::cursor() const
2654 pit_type BufferView::anchor_ref() const
2656 return d->anchor_pit_;
2660 bool BufferView::singleParUpdate()
2662 Text & buftext = buffer_.text();
2663 pit_type const bottom_pit = d->cursor_.bottom().pit();
2664 TextMetrics & tm = textMetrics(&buftext);
2665 int old_height = tm.parMetrics(bottom_pit).height();
2667 // make sure inline completion pointer is ok
2668 if (d->inlineCompletionPos_.fixIfBroken())
2669 d->inlineCompletionPos_ = DocIterator();
2671 // In Single Paragraph mode, rebreak only
2672 // the (main text, not inset!) paragraph containing the cursor.
2673 // (if this paragraph contains insets etc., rebreaking will
2674 // recursively descend)
2675 tm.redoParagraph(bottom_pit);
2676 ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
2677 if (pm.height() != old_height)
2678 // Paragraph height has changed so we cannot proceed to
2679 // the singlePar optimisation.
2682 d->update_strategy_ = SingleParUpdate;
2684 LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
2685 << " y2: " << pm.position() + pm.descent()
2686 << " pit: " << bottom_pit
2687 << " singlepar: 1");
2692 void BufferView::updateMetrics()
2694 if (height_ == 0 || width_ == 0)
2697 Text & buftext = buffer_.text();
2698 pit_type const npit = int(buftext.paragraphs().size());
2700 // Clear out the position cache in case of full screen redraw,
2701 d->coord_cache_.clear();
2703 // Clear out paragraph metrics to avoid having invalid metrics
2704 // in the cache from paragraphs not relayouted below
2705 // The complete text metrics will be redone.
2706 d->text_metrics_.clear();
2708 TextMetrics & tm = textMetrics(&buftext);
2710 // make sure inline completion pointer is ok
2711 if (d->inlineCompletionPos_.fixIfBroken())
2712 d->inlineCompletionPos_ = DocIterator();
2714 if (d->anchor_pit_ >= npit)
2715 // The anchor pit must have been deleted...
2716 d->anchor_pit_ = npit - 1;
2718 // Rebreak anchor paragraph.
2719 tm.redoParagraph(d->anchor_pit_);
2720 ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
2723 if (d->anchor_pit_ == 0) {
2724 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
2726 // Complete buffer visible? Then it's easy.
2727 if (scrollRange == 0)
2728 d->anchor_ypos_ = anchor_pm.ascent();
2730 // FIXME: Some clever handling needed to show
2731 // the _first_ paragraph up to the top if the cursor is
2732 // in the first line.
2734 anchor_pm.setPosition(d->anchor_ypos_);
2736 LYXERR(Debug::PAINTING, "metrics: "
2737 << " anchor pit = " << d->anchor_pit_
2738 << " anchor ypos = " << d->anchor_ypos_);
2740 // Redo paragraphs above anchor if necessary.
2741 int y1 = d->anchor_ypos_ - anchor_pm.ascent();
2742 // We are now just above the anchor paragraph.
2743 pit_type pit1 = d->anchor_pit_ - 1;
2744 for (; pit1 >= 0 && y1 >= 0; --pit1) {
2745 tm.redoParagraph(pit1);
2746 ParagraphMetrics & pm = tm.par_metrics_[pit1];
2748 // Save the paragraph position in the cache.
2753 // Redo paragraphs below the anchor if necessary.
2754 int y2 = d->anchor_ypos_ + anchor_pm.descent();
2755 // We are now just below the anchor paragraph.
2756 pit_type pit2 = d->anchor_pit_ + 1;
2757 for (; pit2 < npit && y2 <= height_; ++pit2) {
2758 tm.redoParagraph(pit2);
2759 ParagraphMetrics & pm = tm.par_metrics_[pit2];
2761 // Save the paragraph position in the cache.
2766 LYXERR(Debug::PAINTING, "Metrics: "
2767 << " anchor pit = " << d->anchor_pit_
2768 << " anchor ypos = " << d->anchor_ypos_
2771 << " pit1 = " << pit1
2772 << " pit2 = " << pit2);
2774 d->update_strategy_ = FullScreenUpdate;
2776 if (lyxerr.debugging(Debug::WORKAREA)) {
2777 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
2778 d->coord_cache_.dump();
2783 void BufferView::insertLyXFile(FileName const & fname)
2785 LASSERT(d->cursor_.inTexted(), return);
2787 // Get absolute path of file and add ".lyx"
2788 // to the filename if necessary
2789 FileName filename = fileSearch(string(), fname.absFileName(), "lyx");
2791 docstring const disp_fn = makeDisplayPath(filename.absFileName());
2792 // emit message signal.
2793 message(bformat(_("Inserting document %1$s..."), disp_fn));
2796 Buffer buf(filename.absFileName(), false);
2797 if (buf.loadLyXFile() == Buffer::ReadSuccess) {
2798 ErrorList & el = buffer_.errorList("Parse");
2799 // Copy the inserted document error list into the current buffer one.
2800 el = buf.errorList("Parse");
2801 buffer_.undo().recordUndo(d->cursor_);
2802 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
2803 buf.params().documentClassPtr(), el);
2804 res = _("Document %1$s inserted.");
2806 res = _("Could not insert document %1$s");
2809 buffer_.changed(true);
2810 // emit message signal.
2811 message(bformat(res, disp_fn));
2815 Point BufferView::coordOffset(DocIterator const & dit) const
2821 // Addup contribution of nested insets, from inside to outside,
2822 // keeping the outer paragraph for a special handling below
2823 for (size_t i = dit.depth() - 1; i >= 1; --i) {
2824 CursorSlice const & sl = dit[i];
2828 // get relative position inside sl.inset()
2829 sl.inset().cursorPos(*this, sl, dit.boundary() && (i + 1 == dit.depth()), xx, yy);
2831 // Make relative position inside of the edited inset relative to sl.inset()
2835 // In case of an RTL inset, the edited inset will be positioned to the left
2838 bool boundary_i = dit.boundary() && i + 1 == dit.depth();
2839 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2844 // remember width for the case that sl.inset() is positioned in an RTL inset
2845 if (i && dit[i - 1].text()) {
2846 // If this Inset is inside a Text Inset, retrieve the Dimension
2847 // from the containing text instead of using Inset::dimension() which
2848 // might not be implemented.
2849 // FIXME (Abdel 23/09/2007): this is a bit messy because of the
2850 // elimination of Inset::dim_ cache. This coordOffset() method needs
2851 // to be rewritten in light of the new design.
2852 Dimension const & dim = coordCache().getInsets().dim(&sl.inset());
2855 Dimension const dim = sl.inset().dimension(*this);
2859 //lyxerr << "Cursor::getPos, i: "
2860 // << i << " x: " << xx << " y: " << y << endl;
2863 // Add contribution of initial rows of outermost paragraph
2864 CursorSlice const & sl = dit[0];
2865 TextMetrics const & tm = textMetrics(sl.text());
2866 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2868 LBUFERR(!pm.rows().empty());
2869 y -= pm.rows()[0].ascent();
2871 // FIXME: document this mess
2873 if (sl.pos() > 0 && dit.depth() == 1) {
2875 if (pos && dit.boundary())
2877 // lyxerr << "coordOffset: boundary:" << dit.boundary() << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
2878 rend = pm.pos2row(pos);
2880 rend = pm.pos2row(sl.pos());
2882 size_t rend = pm.pos2row(sl.pos());
2884 for (size_t rit = 0; rit != rend; ++rit)
2885 y += pm.rows()[rit].height();
2886 y += pm.rows()[rend].ascent();
2888 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
2890 // Make relative position from the nested inset now bufferview absolute.
2891 int xx = bottom_tm.cursorX(dit.bottom(), dit.boundary() && dit.depth() == 1);
2894 // In the RTL case place the nested inset at the left of the cursor in
2895 // the outer paragraph
2896 bool boundary_1 = dit.boundary() && 1 == dit.depth();
2897 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
2905 Point BufferView::getPos(DocIterator const & dit) const
2907 if (!paragraphVisible(dit))
2908 return Point(-1, -1);
2910 CursorSlice const & bot = dit.bottom();
2911 TextMetrics const & tm = textMetrics(bot.text());
2913 // offset from outer paragraph
2914 Point p = coordOffset(dit);
2915 p.y_ += tm.parMetrics(bot.pit()).position();
2920 bool BufferView::paragraphVisible(DocIterator const & dit) const
2922 CursorSlice const & bot = dit.bottom();
2923 TextMetrics const & tm = textMetrics(bot.text());
2925 return tm.contains(bot.pit());
2929 void BufferView::cursorPosAndHeight(Point & p, int & h) const
2931 Cursor const & cur = cursor();
2932 Font const font = cur.getFont();
2933 frontend::FontMetrics const & fm = theFontMetrics(font);
2934 int const asc = fm.maxAscent();
2935 int const des = fm.maxDescent();
2942 bool BufferView::cursorInView(Point const & p, int h) const
2944 Cursor const & cur = cursor();
2945 // does the cursor touch the screen ?
2946 if (p.y_ + h < 0 || p.y_ >= workHeight() || !paragraphVisible(cur))
2952 int BufferView::horizScrollOffset() const
2954 return d->horiz_scroll_offset_;
2958 CursorSlice const & BufferView::currentRowSlice() const
2960 return d->current_row_slice_;
2964 CursorSlice const & BufferView::lastRowSlice() const
2966 return d->last_row_slice_;
2970 void BufferView::setCurrentRowSlice(CursorSlice const & rowSlice)
2972 // nothing to do if the cursor was already on this row
2973 if (d->current_row_slice_ == rowSlice) {
2974 d->last_row_slice_ = CursorSlice();
2978 // if the (previous) current row was scrolled, we have to
2979 // remember it in order to repaint it next time.
2980 if (d->horiz_scroll_offset_ != 0)
2981 d->last_row_slice_ = d->current_row_slice_;
2983 d->last_row_slice_ = CursorSlice();
2985 // Since we changed row, the scroll offset is not valid anymore
2986 d->horiz_scroll_offset_ = 0;
2987 d->current_row_slice_ = rowSlice;
2991 void BufferView::checkCursorScrollOffset(PainterInfo & pi)
2993 CursorSlice rowSlice = d->cursor_.bottom();
2994 TextMetrics const & tm = textMetrics(rowSlice.text());
2996 // Stop if metrics have not been computed yet, since it means
2997 // that there is nothing to do.
2998 if (!tm.contains(rowSlice.pit()))
3000 ParagraphMetrics const & pm = tm.parMetrics(rowSlice.pit());
3001 Row const & row = pm.getRow(rowSlice.pos(),
3002 d->cursor_.boundary() && rowSlice == d->cursor_.top());
3003 rowSlice.pos() = row.pos();
3005 // Set the row on which the cursor lives.
3006 setCurrentRowSlice(rowSlice);
3008 // Current x position of the cursor in pixels
3009 int cur_x = getPos(d->cursor_).x_;
3011 // If cursor offset is left margin and offset is not the leftmost
3012 // position of the row, there is a cache problem.
3013 if (cur_x == row.left_margin && !row.empty()
3014 && d->cursor_.pos() != row.front().left_pos()) {
3015 /** FIXME: the code below adds an extraneous computation of
3016 * inset positions, and can therefore be bad for performance
3017 * (think for example about a very large tabular inset.
3018 * Redawing the row where it is means redrawing the whole
3021 * The bug that this fixes is the following: assume that there
3022 * is a very large math inset. Upon entering the inset, when
3023 * pressing `End', the row is not scrolled and the cursor is
3024 * not visible. The extra row computation makes sure that the
3025 * inset positions are correctly computed and set in the
3026 * cache. This would not happen if we did not have two-stage
3029 * A proper fix should be found and this code should be removed.
3031 // Force the recomputation of inset positions
3032 bool const drawing = pi.pain.isDrawingEnabled();
3033 pi.pain.setDrawingEnabled(false);
3034 // No need to care about vertical position.
3035 RowPainter rp(pi, buffer().text(), d->cursor_.bottom().pit(), row,
3036 -d->horiz_scroll_offset_, 0);
3038 pi.pain.setDrawingEnabled(drawing);
3040 // Recompute current Current x position of the cursor in pixels
3041 cur_x = getPos(d->cursor_).x_;
3044 // Horizontal scroll offset of the cursor row in pixels
3045 int offset = d->horiz_scroll_offset_;
3046 int const MARGIN = 2 * theFontMetrics(d->cursor_.real_current_font).em()
3048 if (row.width() <= workWidth() - row.right_margin) {
3049 // Row is narrower than the work area, no offset needed.
3052 if (cur_x - offset < MARGIN) {
3053 // cursor would be too far right
3054 offset = cur_x - MARGIN;
3055 } else if (cur_x - offset > workWidth() - MARGIN) {
3056 // cursor would be too far left
3057 offset = cur_x - workWidth() + MARGIN;
3059 // Correct the offset to make sure that we do not scroll too much
3062 if (row.width() - offset < workWidth() - row.right_margin)
3063 offset = row.width() - workWidth() + row.right_margin;
3066 //lyxerr << "cur_x=" << cur_x << ", offset=" << offset << ", row.wid=" << row.width() << ", margin=" << MARGIN << endl;
3068 if (offset != d->horiz_scroll_offset_)
3069 LYXERR(Debug::PAINTING, "Horiz. scroll offset changed from "
3070 << d->horiz_scroll_offset_ << " to " << offset);
3072 if (d->update_strategy_ == NoScreenUpdate
3073 && (offset != d->horiz_scroll_offset_
3074 || !d->last_row_slice_.empty())) {
3075 // FIXME: if one uses SingleParUpdate, then home/end
3076 // will not work on long rows. Why?
3077 d->update_strategy_ = FullScreenUpdate;
3080 d->horiz_scroll_offset_ = offset;
3084 void BufferView::draw(frontend::Painter & pain)
3086 if (height_ == 0 || width_ == 0)
3088 LYXERR(Debug::PAINTING, "\t\t*** START DRAWING ***");
3090 Text & text = buffer_.text();
3091 TextMetrics const & tm = d->text_metrics_[&text];
3092 int const y = tm.first().second->position();
3093 PainterInfo pi(this, pain);
3095 // Check whether the row where the cursor lives needs to be scrolled.
3096 // Update the drawing strategy if needed.
3097 checkCursorScrollOffset(pi);
3099 switch (d->update_strategy_) {
3101 case NoScreenUpdate:
3102 // If no screen painting is actually needed, only some the different
3103 // coordinates of insets and paragraphs needs to be updated.
3104 LYXERR(Debug::PAINTING, "Strategy: NoScreenUpdate");
3105 pi.full_repaint = true;
3106 pi.pain.setDrawingEnabled(false);
3110 case SingleParUpdate:
3111 pi.full_repaint = false;
3112 LYXERR(Debug::PAINTING, "Strategy: SingleParUpdate");
3113 // In general, only the current row of the outermost paragraph
3114 // will be redrawn. Particular cases where selection spans
3115 // multiple paragraph are correctly detected in TextMetrics.
3119 case DecorationUpdate:
3120 // FIXME: We should also distinguish DecorationUpdate to avoid text
3121 // drawing if possible. This is not possible to do easily right now
3122 // because of the single backing pixmap.
3124 case FullScreenUpdate:
3126 LYXERR(Debug::PAINTING,
3127 ((d->update_strategy_ == FullScreenUpdate)
3128 ? "Strategy: FullScreenUpdate"
3129 : "Strategy: DecorationUpdate"));
3131 // The whole screen, including insets, will be refreshed.
3132 pi.full_repaint = true;
3134 // Clear background.
3135 pain.fillRectangle(0, 0, width_, height_,
3136 pi.backgroundColor(&buffer_.inset()));
3141 // and possibly grey out below
3142 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3143 int const y2 = lastpm.second->position() + lastpm.second->descent();
3146 Color color = buffer().isInternal()
3147 ? Color_background : Color_bottomarea;
3148 pain.fillRectangle(0, y2, width_, height_ - y2, color);
3152 LYXERR(Debug::PAINTING, "\n\t\t*** END DRAWING ***");
3154 // The scrollbar needs an update.
3157 // Normalize anchor for next time
3158 pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
3159 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3160 for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
3161 ParagraphMetrics const & pm = tm.parMetrics(pit);
3162 if (pm.position() + pm.descent() > 0) {
3163 d->anchor_pit_ = pit;
3164 d->anchor_ypos_ = pm.position();
3168 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
3169 << " anchor ypos = " << d->anchor_ypos_);
3173 void BufferView::message(docstring const & msg)
3176 d->gui_->message(msg);
3180 void BufferView::showDialog(string const & name)
3183 d->gui_->showDialog(name, string());
3187 void BufferView::showDialog(string const & name,
3188 string const & data, Inset * inset)
3191 d->gui_->showDialog(name, data, inset);
3195 void BufferView::updateDialog(string const & name, string const & data)
3198 d->gui_->updateDialog(name, data);
3202 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
3208 // FIXME: Move this out of BufferView again
3209 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
3211 if (!fname.isReadableFile()) {
3212 docstring const error = from_ascii(strerror(errno));
3213 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3214 docstring const text =
3215 bformat(_("Could not read the specified document\n"
3216 "%1$s\ndue to the error: %2$s"), file, error);
3217 Alert::error(_("Could not read file"), text);
3221 if (!fname.isReadableFile()) {
3222 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3223 docstring const text =
3224 bformat(_("%1$s\n is not readable."), file);
3225 Alert::error(_("Could not open file"), text);
3229 // FIXME UNICODE: We don't know the encoding of the file
3230 docstring file_content = fname.fileContents("UTF-8");
3231 if (file_content.empty()) {
3232 Alert::error(_("Reading not UTF-8 encoded file"),
3233 _("The file is not UTF-8 encoded.\n"
3234 "It will be read as local 8Bit-encoded.\n"
3235 "If this does not give the correct result\n"
3236 "then please change the encoding of the file\n"
3237 "to UTF-8 with a program other than LyX.\n"));
3238 file_content = fname.fileContents("local8bit");
3241 return normalize_c(file_content);
3245 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
3247 docstring const tmpstr = contentsOfPlaintextFile(f);
3252 Cursor & cur = cursor();
3253 cap::replaceSelection(cur);
3254 buffer_.undo().recordUndo(cur);
3256 cur.innerText()->insertStringAsParagraphs(cur, tmpstr, cur.current_font);
3258 cur.innerText()->insertStringAsLines(cur, tmpstr, cur.current_font);
3260 buffer_.changed(true);
3264 docstring const & BufferView::inlineCompletion() const
3266 return d->inlineCompletion_;
3270 size_t const & BufferView::inlineCompletionUniqueChars() const
3272 return d->inlineCompletionUniqueChars_;
3276 DocIterator const & BufferView::inlineCompletionPos() const
3278 return d->inlineCompletionPos_;
3282 void BufferView::resetInlineCompletionPos()
3284 d->inlineCompletionPos_ = DocIterator();
3288 bool samePar(DocIterator const & a, DocIterator const & b)
3290 if (a.empty() && b.empty())
3292 if (a.empty() || b.empty())
3294 if (a.depth() != b.depth())
3296 return &a.innerParagraph() == &b.innerParagraph();
3300 void BufferView::setInlineCompletion(Cursor const & cur, DocIterator const & pos,
3301 docstring const & completion, size_t uniqueChars)
3303 uniqueChars = min(completion.size(), uniqueChars);
3304 bool changed = d->inlineCompletion_ != completion
3305 || d->inlineCompletionUniqueChars_ != uniqueChars;
3306 bool singlePar = true;
3307 d->inlineCompletion_ = completion;
3308 d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
3310 //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
3313 DocIterator const & old = d->inlineCompletionPos_;
3315 //lyxerr << "inlineCompletionPos changed" << std::endl;
3316 // old or pos are in another paragraph?
3317 if ((!samePar(cur, pos) && !pos.empty())
3318 || (!samePar(cur, old) && !old.empty())) {
3320 //lyxerr << "different paragraph" << std::endl;
3322 d->inlineCompletionPos_ = pos;
3327 if (singlePar && !(cur.result().screenUpdate() & Update::Force))
3328 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
3330 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::Force);
3335 bool BufferView::clickableInset() const
3337 return d->clickable_inset_;