3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Alfredo Braunstein
7 * \author Lars Gullik Bjønnes
10 * \author Jürgen Vigna
12 * Full author contact details are available in file CREDITS.
17 #include "BufferView.h"
19 #include "BranchList.h"
21 #include "buffer_funcs.h"
22 #include "BufferList.h"
23 #include "BufferParams.h"
24 #include "CoordCache.h"
26 #include "CutAndPaste.h"
27 #include "DispatchResult.h"
28 #include "ErrorList.h"
30 #include "FloatList.h"
31 #include "FuncRequest.h"
32 #include "FuncStatus.h"
34 #include "InsetIterator.h"
36 #include "LaTeXFeatures.h"
37 #include "LayoutFile.h"
41 #include "LyXAction.h"
45 #include "MetricsInfo.h"
46 #include "Paragraph.h"
47 #include "ParagraphParameters.h"
48 #include "ParIterator.h"
51 #include "TextClass.h"
52 #include "TextMetrics.h"
54 #include "TocBackend.h"
55 #include "WordLangTuple.h"
57 #include "insets/InsetBibtex.h"
58 #include "insets/InsetCitation.h"
59 #include "insets/InsetCommand.h" // ChangeRefs
60 #include "insets/InsetExternal.h"
61 #include "insets/InsetGraphics.h"
62 #include "insets/InsetNote.h"
63 #include "insets/InsetRef.h"
64 #include "insets/InsetText.h"
66 #include "mathed/MathData.h"
68 #include "frontends/alert.h"
69 #include "frontends/Application.h"
70 #include "frontends/Delegates.h"
71 #include "frontends/FontMetrics.h"
72 #include "frontends/Painter.h"
73 #include "frontends/Selection.h"
75 #include "support/convert.h"
76 #include "support/debug.h"
77 #include "support/ExceptionMessage.h"
78 #include "support/filetools.h"
79 #include "support/gettext.h"
80 #include "support/lassert.h"
81 #include "support/lstrings.h"
82 #include "support/Package.h"
83 #include "support/types.h"
93 using namespace lyx::support;
97 namespace Alert = frontend::Alert;
101 /// Return an inset of this class if it exists at the current cursor position
103 T * getInsetByCode(Cursor const & cur, InsetCode code)
105 DocIterator it = cur;
106 Inset * inset = it.nextInset();
107 if (inset && inset->lyxCode() == code)
108 return static_cast<T*>(inset);
113 /// Note that comparing contents can only be used for InsetCommand
114 bool findNextInset(DocIterator & dit, vector<InsetCode> const & codes,
115 docstring const & contents)
117 DocIterator tmpdit = dit;
120 Inset const * inset = tmpdit.nextInset();
122 bool const valid_code = std::find(codes.begin(), codes.end(),
123 inset->lyxCode()) != codes.end();
124 InsetCommand const * ic = inset->asInsetCommand();
125 bool const same_or_no_contents = contents.empty()
126 || (ic && (ic->getFirstNonOptParam() == contents));
128 if (valid_code && same_or_no_contents) {
133 tmpdit.forwardInset();
140 /// Looks for next inset with one of the given codes.
141 /// Note that same_content can only be used for InsetCommand
142 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
146 DocIterator tmpdit = dit;
147 tmpdit.forwardInset();
151 Inset const * inset = tmpdit.nextInset();
152 if (same_content && inset) {
153 InsetCommand const * ic = inset->asInsetCommand();
155 bool const valid_code = std::find(codes.begin(), codes.end(),
156 ic->lyxCode()) != codes.end();
158 contents = ic->getFirstNonOptParam();
162 if (!findNextInset(tmpdit, codes, contents)) {
163 if (dit.depth() != 1 || dit.pit() != 0 || dit.pos() != 0) {
164 Inset * inset = &tmpdit.bottom().inset();
165 tmpdit = doc_iterator_begin(&inset->buffer(), inset);
166 if (!findNextInset(tmpdit, codes, contents))
178 /// Looks for next inset with the given code
179 void findInset(DocIterator & dit, InsetCode code, bool same_content)
181 findInset(dit, vector<InsetCode>(1, code), same_content);
185 /// Moves cursor to the next inset with one of the given codes.
186 void gotoInset(BufferView * bv, vector<InsetCode> const & codes,
189 Cursor tmpcur = bv->cursor();
190 if (!findInset(tmpcur, codes, same_content)) {
191 bv->cursor().message(_("No more insets"));
195 tmpcur.clearSelection();
196 bv->setCursor(tmpcur);
201 /// Moves cursor to the next inset with given code.
202 void gotoInset(BufferView * bv, InsetCode code, bool same_content)
204 gotoInset(bv, vector<InsetCode>(1, code), same_content);
208 /// A map from a Text to the associated text metrics
209 typedef map<Text const *, TextMetrics> TextMetricsCache;
211 enum ScreenUpdateStrategy {
221 /////////////////////////////////////////////////////////////////////
225 /////////////////////////////////////////////////////////////////////
227 struct BufferView::Private
229 Private(BufferView & bv) : update_strategy_(NoScreenUpdate),
231 anchor_pit_(0), anchor_ypos_(0),
232 inlineCompletionUniqueChars_(0),
233 last_inset_(0), clickable_inset_(false),
234 mouse_position_cache_(),
235 bookmark_edit_position_(-1), gui_(0),
236 horiz_scroll_offset_(0)
238 xsel_cache_.set = false;
242 ScrollbarParameters scrollbarParameters_;
244 ScreenUpdateStrategy update_strategy_;
246 CoordCache coord_cache_;
248 /// Estimated average par height for scrollbar.
250 /// this is used to handle XSelection events in the right manner.
259 pit_type anchor_pit_;
263 vector<int> par_height_;
266 DocIterator inlineCompletionPos_;
268 docstring inlineCompletion_;
270 size_t inlineCompletionUniqueChars_;
272 /// keyboard mapping object.
275 /// last visited inset.
276 /** kept to send setMouseHover(false).
277 * Not owned, so don't delete.
279 Inset const * last_inset_;
280 /// are we hovering something that we can click
281 bool clickable_inset_;
283 /// position of the mouse at the time of the last mouse move
284 /// This is used to update the hovering status of inset in
285 /// cases where the buffer is scrolled, but the mouse didn't move.
286 Point mouse_position_cache_;
288 // cache for id of the paragraph which was edited the last time
289 int bookmark_edit_position_;
291 mutable TextMetricsCache text_metrics_;
294 /** Not owned, so don't delete.
296 frontend::GuiBufferViewDelegate * gui_;
298 /// Cache for Find Next
299 FuncRequest search_request_cache_;
302 map<string, Inset *> edited_insets_;
304 /// When the row where the cursor lies is scrolled, this
305 /// contains the scroll offset
306 int horiz_scroll_offset_;
307 /// a slice pointing to the start of the row where the cursor
308 /// is (at last draw time)
309 CursorSlice current_row_slice_;
310 /// a slice pointing to the start of the row where cursor was
311 /// at previous draw event
312 CursorSlice last_row_slice_;
316 BufferView::BufferView(Buffer & buf)
317 : width_(0), height_(0), full_screen_(false), buffer_(buf),
318 d(new Private(*this))
320 d->xsel_cache_.set = false;
321 d->intl_.initKeyMapper(lyxrc.use_kbmap);
323 d->cursor_.setBuffer(&buf);
324 d->cursor_.push(buffer_.inset());
325 d->cursor_.resetAnchor();
326 d->cursor_.setCurrentFont();
328 buffer_.updatePreviews();
332 BufferView::~BufferView()
334 // current buffer is going to be switched-off, save cursor pos
335 // Ideally, the whole cursor stack should be saved, but session
336 // currently can only handle bottom (whole document) level pit and pos.
337 // That is to say, if a cursor is in a nested inset, it will be
338 // restore to the left of the top level inset.
339 LastFilePosSection::FilePos fp;
340 fp.pit = d->cursor_.bottom().pit();
341 fp.pos = d->cursor_.bottom().pos();
342 theSession().lastFilePos().save(buffer_.fileName(), fp);
345 d->last_inset_->setMouseHover(this, false);
351 int BufferView::rightMargin() const
353 // The additional test for the case the outliner is opened.
355 !lyxrc.full_screen_limit ||
356 width_ < lyxrc.full_screen_width + 20)
359 return (width_ - lyxrc.full_screen_width) / 2;
363 int BufferView::leftMargin() const
365 return rightMargin();
369 bool BufferView::isTopScreen() const
371 return d->scrollbarParameters_.position == d->scrollbarParameters_.min;
375 bool BufferView::isBottomScreen() const
377 return d->scrollbarParameters_.position == d->scrollbarParameters_.max;
381 Intl & BufferView::getIntl()
387 Intl const & BufferView::getIntl() const
393 CoordCache & BufferView::coordCache()
395 return d->coord_cache_;
399 CoordCache const & BufferView::coordCache() const
401 return d->coord_cache_;
405 Buffer & BufferView::buffer()
411 Buffer const & BufferView::buffer() const
417 bool BufferView::needsFitCursor() const
419 if (cursorStatus(d->cursor_) == CUR_INSIDE) {
420 frontend::FontMetrics const & fm =
421 theFontMetrics(d->cursor_.getFont().fontInfo());
422 int const asc = fm.maxAscent();
423 int const des = fm.maxDescent();
424 Point const p = getPos(d->cursor_);
425 if (p.y_ - asc >= 0 && p.y_ + des < height_)
432 void BufferView::processUpdateFlags(Update::flags flags)
434 // This is close to a hot-path.
435 LYXERR(Debug::DEBUG, "BufferView::processUpdateFlags()"
436 << "[fitcursor = " << (flags & Update::FitCursor)
437 << ", forceupdate = " << (flags & Update::Force)
438 << ", singlepar = " << (flags & Update::SinglePar)
439 << "] buffer: " << &buffer_);
441 // FIXME Does this really need doing here? It's done in updateBuffer, and
442 // if the Buffer doesn't need updating, then do the macros?
443 buffer_.updateMacros();
445 // Now do the first drawing step if needed. This consists on updating
446 // the CoordCache in updateMetrics().
447 // The second drawing step is done in WorkArea::redraw() if needed.
448 // FIXME: is this still true now that Buffer::changed() is used all over?
450 // Case when no explicit update is requested.
452 // no need to redraw anything.
453 d->update_strategy_ = NoScreenUpdate;
457 if (flags == Update::Decoration) {
458 d->update_strategy_ = DecorationUpdate;
459 buffer_.changed(false);
463 if (flags == Update::FitCursor
464 || flags == (Update::Decoration | Update::FitCursor)) {
465 // tell the frontend to update the screen if needed.
466 if (needsFitCursor()) {
470 if (flags & Update::Decoration) {
471 d->update_strategy_ = DecorationUpdate;
472 buffer_.changed(false);
475 // no screen update is needed in principle, but this
476 // could change if cursor row needs horizontal scrolling.
477 d->update_strategy_ = NoScreenUpdate;
478 buffer_.changed(false);
482 bool const full_metrics = flags & Update::Force || !singleParUpdate();
485 // We have to update the full screen metrics.
488 if (!(flags & Update::FitCursor)) {
489 // Nothing to do anymore. Trigger a redraw and return
490 buffer_.changed(false);
494 // updateMetrics() does not update paragraph position
495 // This is done at draw() time. So we need a redraw!
496 buffer_.changed(false);
498 if (needsFitCursor()) {
499 // The cursor is off screen so ensure it is visible.
504 updateHoveredInset();
508 void BufferView::updateScrollbar()
510 if (height_ == 0 && width_ == 0)
513 // We prefer fixed size line scrolling.
514 d->scrollbarParameters_.single_step = defaultRowHeight();
515 // We prefer full screen page scrolling.
516 d->scrollbarParameters_.page_step = height_;
518 Text & t = buffer_.text();
519 TextMetrics & tm = d->text_metrics_[&t];
521 LYXERR(Debug::GUI, " Updating scrollbar: height: "
522 << t.paragraphs().size()
523 << " curr par: " << d->cursor_.bottom().pit()
524 << " default height " << defaultRowHeight());
526 size_t const parsize = t.paragraphs().size();
527 if (d->par_height_.size() != parsize) {
528 d->par_height_.clear();
529 // FIXME: We assume a default paragraph height of 2 rows. This
530 // should probably be pondered with the screen width.
531 d->par_height_.resize(parsize, defaultRowHeight() * 2);
534 // Look at paragraph heights on-screen
535 pair<pit_type, ParagraphMetrics const *> first = tm.first();
536 pair<pit_type, ParagraphMetrics const *> last = tm.last();
537 for (pit_type pit = first.first; pit <= last.first; ++pit) {
538 d->par_height_[pit] = tm.parMetrics(pit).height();
539 LYXERR(Debug::SCROLLING, "storing height for pit " << pit << " : "
540 << d->par_height_[pit]);
543 int top_pos = first.second->position() - first.second->ascent();
544 int bottom_pos = last.second->position() + last.second->descent();
545 bool first_visible = first.first == 0 && top_pos >= 0;
546 bool last_visible = last.first + 1 == int(parsize) && bottom_pos <= height_;
547 if (first_visible && last_visible) {
548 d->scrollbarParameters_.min = 0;
549 d->scrollbarParameters_.max = 0;
553 d->scrollbarParameters_.min = top_pos;
554 for (size_t i = 0; i != size_t(first.first); ++i)
555 d->scrollbarParameters_.min -= d->par_height_[i];
556 d->scrollbarParameters_.max = bottom_pos;
557 for (size_t i = last.first + 1; i != parsize; ++i)
558 d->scrollbarParameters_.max += d->par_height_[i];
560 d->scrollbarParameters_.position = 0;
561 // The reference is the top position so we remove one page.
562 if (lyxrc.scroll_below_document)
563 d->scrollbarParameters_.max -= minVisiblePart();
565 d->scrollbarParameters_.max -= d->scrollbarParameters_.page_step;
569 ScrollbarParameters const & BufferView::scrollbarParameters() const
571 return d->scrollbarParameters_;
575 docstring BufferView::toolTip(int x, int y) const
577 // Get inset under mouse, if there is one.
578 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
580 // No inset, no tooltip...
582 return covering_inset->toolTip(*this, x, y);
586 string BufferView::contextMenu(int x, int y) const
588 //If there is a selection, return the containing inset menu
589 if (d->cursor_.selection())
590 return d->cursor_.inset().contextMenu(*this, x, y);
592 // Get inset under mouse, if there is one.
593 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
595 return covering_inset->contextMenu(*this, x, y);
597 return buffer_.inset().contextMenu(*this, x, y);
601 void BufferView::scrollDocView(int value, bool update)
603 int const offset = value - d->scrollbarParameters_.position;
605 // No scrolling at all? No need to redraw anything
609 // If the offset is less than 2 screen height, prefer to scroll instead.
610 if (abs(offset) <= 2 * height_) {
611 d->anchor_ypos_ -= offset;
612 buffer_.changed(true);
613 updateHoveredInset();
617 // cut off at the top
618 if (value <= d->scrollbarParameters_.min) {
619 DocIterator dit = doc_iterator_begin(&buffer_);
620 showCursor(dit, false, update);
621 LYXERR(Debug::SCROLLING, "scroll to top");
625 // cut off at the bottom
626 if (value >= d->scrollbarParameters_.max) {
627 DocIterator dit = doc_iterator_end(&buffer_);
629 showCursor(dit, false, update);
630 LYXERR(Debug::SCROLLING, "scroll to bottom");
634 // find paragraph at target position
635 int par_pos = d->scrollbarParameters_.min;
637 for (; i != int(d->par_height_.size()); ++i) {
638 par_pos += d->par_height_[i];
639 if (par_pos >= value)
643 if (par_pos < value) {
644 // It seems we didn't find the correct pit so stay on the safe side and
646 LYXERR0("scrolling position not found!");
647 scrollDocView(d->scrollbarParameters_.max, update);
651 DocIterator dit = doc_iterator_begin(&buffer_);
653 LYXERR(Debug::SCROLLING, "value = " << value << " -> scroll to pit " << i);
654 showCursor(dit, false, update);
658 // FIXME: this method is not working well.
659 void BufferView::setCursorFromScrollbar()
661 TextMetrics & tm = d->text_metrics_[&buffer_.text()];
663 int const height = 2 * defaultRowHeight();
664 int const first = height;
665 int const last = height_ - height;
667 Cursor const & oldcur = d->cursor_;
669 switch (cursorStatus(oldcur)) {
677 int const y = getPos(oldcur).y_;
678 newy = min(last, max(y, first));
682 // We reset the cursor because cursorStatus() does not
683 // work when the cursor is within mathed.
686 tm.setCursorFromCoordinates(cur, 0, newy);
688 // update the bufferview cursor and notify insets
689 // FIXME: Care about the d->cursor_ flags to redraw if needed
690 Cursor old = d->cursor_;
692 // the DEPM call in mouseSetCursor() might have destroyed the
693 // paragraph the cursor is in.
694 bool badcursor = old.fixIfBroken();
695 badcursor |= notifyCursorLeavesOrEnters(old, d->cursor_);
697 d->cursor_.fixIfBroken();
701 Change const BufferView::getCurrentChange() const
703 if (!d->cursor_.selection())
704 return Change(Change::UNCHANGED);
706 DocIterator dit = d->cursor_.selectionBegin();
707 // The selected content might have been changed (see #7685)
708 while (dit.inMathed())
709 // Find enclosing text cursor
711 return dit.paragraph().lookupChange(dit.pos());
715 // this could be used elsewhere as well?
716 // FIXME: This does not work within mathed!
717 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
719 Point const p = getPos(dit);
722 if (p.y_ > workHeight())
728 void BufferView::bookmarkEditPosition()
730 // Don't eat cpu time for each keystroke
731 if (d->cursor_.paragraph().id() == d->bookmark_edit_position_)
734 d->bookmark_edit_position_ = d->cursor_.paragraph().id();
738 void BufferView::saveBookmark(unsigned int idx)
740 // tentatively save bookmark, id and pos will be used to
741 // acturately locate a bookmark in a 'live' lyx session.
742 // pit and pos will be updated with bottom level pit/pos
744 if (!buffer_.isInternal()) {
745 theSession().bookmarks().save(
747 d->cursor_.bottom().pit(),
748 d->cursor_.bottom().pos(),
749 d->cursor_.paragraph().id(),
754 // emit message signal.
755 message(_("Save bookmark"));
760 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
761 int top_id, pos_type top_pos)
763 bool success = false;
766 d->cursor_.clearSelection();
768 // if a valid par_id is given, try it first
769 // This is the case for a 'live' bookmark when unique paragraph ID
770 // is used to track bookmarks.
772 dit = buffer_.getParFromID(top_id);
774 dit.pos() = min(dit.paragraph().size(), top_pos);
775 // Some slices of the iterator may not be
776 // reachable (e.g. closed collapsable inset)
777 // so the dociterator may need to be
778 // shortened. Otherwise, setCursor may crash
779 // lyx when the cursor can not be set to these
781 size_t const n = dit.depth();
782 for (size_t i = 0; i < n; ++i)
783 if (!dit[i].inset().editable()) {
791 // if top_id == 0, or searching through top_id failed
792 // This is the case for a 'restored' bookmark when only bottom
793 // (document level) pit was saved. Because of this, bookmark
794 // restoration is inaccurate. If a bookmark was within an inset,
795 // it will be restored to the left of the outmost inset that contains
797 if (bottom_pit < int(buffer_.paragraphs().size())) {
798 dit = doc_iterator_begin(&buffer_);
800 dit.pit() = bottom_pit;
801 dit.pos() = min(bottom_pos, dit.paragraph().size());
806 // Note: only bottom (document) level pit is set.
808 // set the current font.
809 d->cursor_.setCurrentFont();
810 // To center the screen on this new position we need the
811 // paragraph position which is computed at draw() time.
812 // So we need a redraw!
813 buffer_.changed(false);
814 if (needsFitCursor())
822 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
824 if (d->cursor_.real_current_font.isRightToLeft()) {
825 if (d->intl_.keymap == Intl::PRIMARY)
826 d->intl_.keyMapSec();
828 if (d->intl_.keymap == Intl::SECONDARY)
829 d->intl_.keyMapPrim();
832 d->intl_.getTransManager().translateAndInsert(c, t, cur);
836 int BufferView::workWidth() const
842 void BufferView::recenter()
844 showCursor(d->cursor_, true, true);
848 void BufferView::showCursor()
850 showCursor(d->cursor_, false, true);
854 void BufferView::showCursor(DocIterator const & dit,
855 bool recenter, bool update)
857 if (scrollToCursor(dit, recenter) && update) {
858 buffer_.changed(true);
859 updateHoveredInset();
864 void BufferView::scrollToCursor()
866 if (scrollToCursor(d->cursor_, false)) {
867 buffer_.changed(true);
868 updateHoveredInset();
873 bool BufferView::scrollToCursor(DocIterator const & dit, bool recenter)
875 // We are not properly started yet, delay until resizing is
880 LYXERR(Debug::SCROLLING, "recentering!");
882 CursorSlice const & bot = dit.bottom();
883 TextMetrics & tm = d->text_metrics_[bot.text()];
885 pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
886 int bot_pit = bot.pit();
887 if (bot_pit > max_pit) {
888 // FIXME: Why does this happen?
889 LYXERR0("bottom pit is greater that max pit: "
890 << bot_pit << " > " << max_pit);
894 if (bot_pit == tm.first().first - 1)
895 tm.newParMetricsUp();
896 else if (bot_pit == tm.last().first + 1)
897 tm.newParMetricsDown();
899 if (tm.contains(bot_pit)) {
900 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
901 LBUFERR(!pm.rows().empty());
902 // FIXME: smooth scrolling doesn't work in mathed.
903 CursorSlice const & cs = dit.innerTextSlice();
904 int offset = coordOffset(dit).y_;
905 int ypos = pm.position() + offset;
906 Dimension const & row_dim =
907 pm.getRow(cs.pos(), dit.boundary()).dimension();
910 scrolled = scroll(ypos - height_/2);
912 // We try to visualize the whole row, if the row height is larger than
913 // the screen height, we scroll to a heuristic value of height_ / 4.
914 // FIXME: This heuristic value should be replaced by a recursive search
915 // for a row in the inset that can be visualized completely.
916 else if (row_dim.height() > height_) {
917 if (ypos < defaultRowHeight())
918 scrolled = scroll(ypos - height_ / 4);
919 else if (ypos > height_ - defaultRowHeight())
920 scrolled = scroll(ypos - 3 * height_ / 4);
923 // If the top part of the row falls of the screen, we scroll
924 // up to align the top of the row with the top of the screen.
925 else if (ypos - row_dim.ascent() < 0 && ypos < height_) {
926 int ynew = row_dim.ascent();
927 scrolled = scrollUp(ynew - ypos);
930 // If the bottom of the row falls of the screen, we scroll down.
931 else if (ypos + row_dim.descent() > height_ && ypos > 0) {
932 int ynew = height_ - row_dim.descent();
933 scrolled = scrollDown(ypos - ynew);
936 // else, nothing to do, the cursor is already visible so we just return.
937 return scrolled != 0;
940 // fix inline completion position
941 if (d->inlineCompletionPos_.fixIfBroken())
942 d->inlineCompletionPos_ = DocIterator();
944 tm.redoParagraph(bot_pit);
945 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
946 int offset = coordOffset(dit).y_;
948 d->anchor_pit_ = bot_pit;
949 CursorSlice const & cs = dit.innerTextSlice();
950 Dimension const & row_dim =
951 pm.getRow(cs.pos(), dit.boundary()).dimension();
954 d->anchor_ypos_ = height_/2;
955 else if (d->anchor_pit_ == 0)
956 d->anchor_ypos_ = offset + pm.ascent();
957 else if (d->anchor_pit_ == max_pit)
958 d->anchor_ypos_ = height_ - offset - row_dim.descent();
959 else if (offset > height_)
960 d->anchor_ypos_ = height_ - offset - defaultRowHeight();
962 d->anchor_ypos_ = defaultRowHeight() * 2;
968 void BufferView::makeDocumentClass()
970 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
971 buffer_.params().makeDocumentClass();
972 updateDocumentClass(olddc);
976 void BufferView::updateDocumentClass(DocumentClassConstPtr olddc)
978 message(_("Converting document to new document class..."));
980 StableDocIterator backcur(d->cursor_);
981 ErrorList & el = buffer_.errorList("Class Switch");
982 cap::switchBetweenClasses(
983 olddc, buffer_.params().documentClassPtr(),
984 static_cast<InsetText &>(buffer_.inset()), el);
986 setCursor(backcur.asDocIterator(&buffer_));
988 buffer_.errors("Class Switch");
992 /** Return the change status at cursor position, taking into account the
993 * status at each level of the document iterator (a table in a deleted
994 * footnote is deleted).
995 * When \param outer is true, the top slice is not looked at.
997 static Change::Type lookupChangeType(DocIterator const & dit, bool outer = false)
999 size_t const depth = dit.depth() - (outer ? 1 : 0);
1001 for (size_t i = 0 ; i < depth ; ++i) {
1002 CursorSlice const & slice = dit[i];
1003 if (!slice.inset().inMathed()
1004 && slice.pos() < slice.paragraph().size()) {
1005 Change::Type const ch = slice.paragraph().lookupChange(slice.pos()).type;
1006 if (ch != Change::UNCHANGED)
1010 return Change::UNCHANGED;
1014 bool BufferView::getStatus(FuncRequest const & cmd, FuncStatus & flag)
1016 FuncCode const act = cmd.action();
1018 // Can we use a readonly buffer?
1019 if (buffer_.isReadonly()
1020 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1021 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1022 flag.message(from_utf8(N_("Document is read-only")));
1023 flag.setEnabled(false);
1027 // Are we in a DELETED change-tracking region?
1028 if (lookupChangeType(d->cursor_, true) == Change::DELETED
1029 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1030 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1031 flag.message(from_utf8(N_("This portion of the document is deleted.")));
1032 flag.setEnabled(false);
1036 Cursor & cur = d->cursor_;
1038 if (cur.getStatus(cmd, flag))
1043 // FIXME: This is a bit problematic because we don't check if this is
1044 // a document BufferView or not for these LFUNs. We probably have to
1045 // dispatch both to currentBufferView() and, if that fails,
1046 // to documentBufferView(); same as we do now for current Buffer and
1047 // document Buffer. Ideally those LFUN should go to Buffer as they
1048 // operate on the full Buffer and the cursor is only needed either for
1049 // an Undo record or to restore a cursor position. But we don't know
1050 // how to do that inside Buffer of course.
1051 case LFUN_BUFFER_PARAMS_APPLY:
1052 case LFUN_LAYOUT_MODULES_CLEAR:
1053 case LFUN_LAYOUT_MODULE_ADD:
1054 case LFUN_LAYOUT_RELOAD:
1055 case LFUN_TEXTCLASS_APPLY:
1056 case LFUN_TEXTCLASS_LOAD:
1057 flag.setEnabled(!buffer_.isReadonly());
1061 // We do not use the LyXAction flag for readonly because Undo sets the
1062 // buffer clean/dirty status by itself.
1063 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasUndoStack());
1066 // We do not use the LyXAction flag for readonly because Redo sets the
1067 // buffer clean/dirty status by itself.
1068 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasRedoStack());
1070 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
1071 case LFUN_FILE_INSERT_PLAINTEXT: {
1072 docstring const fname = cmd.argument();
1073 if (!FileName::isAbsolute(to_utf8(fname))) {
1074 flag.message(_("Absolute filename expected."));
1077 flag.setEnabled(cur.inTexted());
1080 case LFUN_FILE_INSERT:
1081 case LFUN_BOOKMARK_SAVE:
1082 // FIXME: Actually, these LFUNS should be moved to Text
1083 flag.setEnabled(cur.inTexted());
1086 case LFUN_FONT_STATE:
1087 case LFUN_LABEL_INSERT:
1088 case LFUN_INFO_INSERT:
1089 case LFUN_PARAGRAPH_GOTO:
1090 case LFUN_NOTE_NEXT:
1091 case LFUN_REFERENCE_NEXT:
1092 case LFUN_WORD_FIND:
1093 case LFUN_WORD_FIND_FORWARD:
1094 case LFUN_WORD_FIND_BACKWARD:
1095 case LFUN_WORD_REPLACE:
1098 case LFUN_MARK_TOGGLE:
1099 case LFUN_SCREEN_RECENTER:
1100 case LFUN_SCREEN_SHOW_CURSOR:
1101 case LFUN_BIBTEX_DATABASE_ADD:
1102 case LFUN_BIBTEX_DATABASE_DEL:
1103 case LFUN_STATISTICS:
1104 case LFUN_KEYMAP_OFF:
1105 case LFUN_KEYMAP_PRIMARY:
1106 case LFUN_KEYMAP_SECONDARY:
1107 case LFUN_KEYMAP_TOGGLE:
1108 case LFUN_INSET_SELECT_ALL:
1109 flag.setEnabled(true);
1112 case LFUN_WORD_FINDADV: {
1113 FindAndReplaceOptions opt;
1114 istringstream iss(to_utf8(cmd.argument()));
1116 flag.setEnabled(opt.repl_buf_name.empty()
1117 || !buffer_.isReadonly());
1121 case LFUN_LABEL_GOTO:
1122 flag.setEnabled(!cmd.argument().empty()
1123 || getInsetByCode<InsetRef>(cur, REF_CODE));
1126 case LFUN_CHANGES_TRACK:
1127 flag.setEnabled(true);
1128 flag.setOnOff(buffer_.params().track_changes);
1131 case LFUN_CHANGES_OUTPUT:
1132 flag.setEnabled(true);
1133 flag.setOnOff(buffer_.params().output_changes);
1136 case LFUN_CHANGES_MERGE:
1137 case LFUN_CHANGE_NEXT:
1138 case LFUN_CHANGE_PREVIOUS:
1139 case LFUN_ALL_CHANGES_ACCEPT:
1140 case LFUN_ALL_CHANGES_REJECT:
1141 // TODO: context-sensitive enabling of LFUNs
1142 // In principle, these command should only be enabled if there
1143 // is a change in the document. However, without proper
1144 // optimizations, this will inevitably result in poor performance.
1145 flag.setEnabled(true);
1148 case LFUN_BUFFER_TOGGLE_COMPRESSION: {
1149 flag.setOnOff(buffer_.params().compressed);
1153 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC: {
1154 flag.setOnOff(buffer_.params().output_sync);
1158 case LFUN_SCREEN_UP:
1159 case LFUN_SCREEN_DOWN:
1161 case LFUN_SCREEN_UP_SELECT:
1162 case LFUN_SCREEN_DOWN_SELECT:
1163 case LFUN_INSET_FORALL:
1164 flag.setEnabled(true);
1167 case LFUN_LAYOUT_TABULAR:
1168 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
1172 flag.setEnabled(!cur.inset().forcePlainLayout(cur.idx()));
1175 case LFUN_LAYOUT_PARAGRAPH:
1176 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
1179 case LFUN_BRANCH_ADD_INSERT:
1180 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1183 case LFUN_DIALOG_SHOW_NEW_INSET:
1184 // FIXME: this is wrong, but I do not understand the
1186 if (cur.inset().lyxCode() == CAPTION_CODE)
1187 return cur.inset().getStatus(cur, cmd, flag);
1188 // FIXME we should consider passthru paragraphs too.
1189 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1192 case LFUN_CITATION_INSERT: {
1193 FuncRequest fr(LFUN_INSET_INSERT, "citation");
1194 // FIXME: This could turn in a recursive hell.
1195 // Shouldn't we use Buffer::getStatus() instead?
1196 flag.setEnabled(lyx::getStatus(fr).enabled());
1199 case LFUN_INSET_APPLY: {
1200 string const name = cmd.getArg(0);
1201 Inset * inset = editedInset(name);
1203 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1204 if (!inset->getStatus(cur, fr, flag)) {
1205 // Every inset is supposed to handle this
1206 LASSERT(false, break);
1209 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1210 flag = lyx::getStatus(fr);
1223 Inset * BufferView::editedInset(string const & name) const
1225 map<string, Inset *>::const_iterator it = d->edited_insets_.find(name);
1226 return it == d->edited_insets_.end() ? 0 : it->second;
1230 void BufferView::editInset(string const & name, Inset * inset)
1232 d->edited_insets_[name] = inset;
1236 void BufferView::dispatch(FuncRequest const & cmd, DispatchResult & dr)
1238 LYXERR(Debug::ACTION, "BufferView::dispatch: cmd: " << cmd);
1240 string const argument = to_utf8(cmd.argument());
1241 Cursor & cur = d->cursor_;
1244 // Don't dispatch function that does not apply to internal buffers.
1245 if (buffer_.isInternal()
1246 && lyxaction.funcHasFlag(cmd.action(), LyXAction::NoInternal))
1249 // We'll set this back to false if need be.
1250 bool dispatched = true;
1251 buffer_.undo().beginUndoGroup();
1253 FuncCode const act = cmd.action();
1256 case LFUN_BUFFER_PARAMS_APPLY: {
1257 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1258 cur.recordUndoBufferParams();
1259 istringstream ss(to_utf8(cmd.argument()));
1262 int const unknown_tokens = buffer_.readHeader(lex);
1263 if (unknown_tokens != 0) {
1264 LYXERR0("Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1265 << unknown_tokens << " unknown token"
1266 << (unknown_tokens == 1 ? "" : "s"));
1268 updateDocumentClass(olddc);
1270 // We are most certainly here because of a change in the document
1271 // It is then better to make sure that all dialogs are in sync with
1272 // current document settings.
1273 dr.screenUpdate(Update::Force | Update::FitCursor);
1274 dr.forceBufferUpdate();
1278 case LFUN_LAYOUT_MODULES_CLEAR: {
1279 // FIXME: this modifies the document in cap::switchBetweenClasses
1280 // without calling recordUndo. Fix this before using
1281 // recordUndoBufferParams().
1282 cur.recordUndoFullBuffer();
1283 buffer_.params().clearLayoutModules();
1284 makeDocumentClass();
1285 dr.screenUpdate(Update::Force);
1286 dr.forceBufferUpdate();
1290 case LFUN_LAYOUT_MODULE_ADD: {
1291 BufferParams const & params = buffer_.params();
1292 if (!params.layoutModuleCanBeAdded(argument)) {
1293 LYXERR0("Module `" << argument <<
1294 "' cannot be added due to failed requirements or "
1295 "conflicts with installed modules.");
1298 // FIXME: this modifies the document in cap::switchBetweenClasses
1299 // without calling recordUndo. Fix this before using
1300 // recordUndoBufferParams().
1301 cur.recordUndoFullBuffer();
1302 buffer_.params().addLayoutModule(argument);
1303 makeDocumentClass();
1304 dr.screenUpdate(Update::Force);
1305 dr.forceBufferUpdate();
1309 case LFUN_TEXTCLASS_APPLY: {
1310 // since this shortcircuits, the second call is made only if
1312 bool const success =
1313 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1314 LayoutFileList::get().load(argument, buffer_.filePath());
1316 docstring s = bformat(_("The document class `%1$s' "
1317 "could not be loaded."), from_utf8(argument));
1318 frontend::Alert::error(_("Could not load class"), s);
1322 LayoutFile const * old_layout = buffer_.params().baseClass();
1323 LayoutFile const * new_layout = &(LayoutFileList::get()[argument]);
1325 if (old_layout == new_layout)
1329 // Save the old, possibly modular, layout for use in conversion.
1330 // FIXME: this modifies the document in cap::switchBetweenClasses
1331 // without calling recordUndo. Fix this before using
1332 // recordUndoBufferParams().
1333 cur.recordUndoFullBuffer();
1334 buffer_.params().setBaseClass(argument);
1335 makeDocumentClass();
1336 dr.screenUpdate(Update::Force);
1337 dr.forceBufferUpdate();
1341 case LFUN_TEXTCLASS_LOAD: {
1342 // since this shortcircuits, the second call is made only if
1344 bool const success =
1345 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1346 LayoutFileList::get().load(argument, buffer_.filePath());
1348 docstring s = bformat(_("The document class `%1$s' "
1349 "could not be loaded."), from_utf8(argument));
1350 frontend::Alert::error(_("Could not load class"), s);
1355 case LFUN_LAYOUT_RELOAD: {
1356 LayoutFileIndex bc = buffer_.params().baseClassID();
1357 LayoutFileList::get().reset(bc);
1358 buffer_.params().setBaseClass(bc);
1359 makeDocumentClass();
1360 dr.screenUpdate(Update::Force);
1361 dr.forceBufferUpdate();
1366 dr.setMessage(_("Undo"));
1367 cur.clearSelection();
1368 if (!cur.textUndo())
1369 dr.setMessage(_("No further undo information"));
1371 dr.screenUpdate(Update::Force | Update::FitCursor);
1372 dr.forceBufferUpdate();
1376 dr.setMessage(_("Redo"));
1377 cur.clearSelection();
1378 if (!cur.textRedo())
1379 dr.setMessage(_("No further redo information"));
1381 dr.screenUpdate(Update::Force | Update::FitCursor);
1382 dr.forceBufferUpdate();
1385 case LFUN_FONT_STATE:
1386 dr.setMessage(cur.currentState());
1389 case LFUN_BOOKMARK_SAVE:
1390 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1393 case LFUN_LABEL_GOTO: {
1394 docstring label = cmd.argument();
1395 if (label.empty()) {
1397 getInsetByCode<InsetRef>(cur, REF_CODE);
1399 label = inset->getParam("reference");
1400 // persistent=false: use temp_bookmark
1404 if (!label.empty()) {
1406 // at the moment, this is redundant, since gotoLabel will
1407 // eventually call LFUN_PARAGRAPH_GOTO, but it seems best
1409 dr.screenUpdate(Update::Force | Update::FitCursor);
1414 case LFUN_PARAGRAPH_GOTO: {
1415 int const id = convert<int>(cmd.getArg(0));
1416 int const pos = convert<int>(cmd.getArg(1));
1418 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1419 b = theBufferList().next(b)) {
1422 cur.setCursor(b->getParFromID(id));
1424 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1428 LYXERR(Debug::INFO, "Paragraph " << cur.paragraph().id()
1429 << " found in buffer `"
1430 << b->absFileName() << "'.");
1432 if (b == &buffer_) {
1435 mouseSetCursor(cur);
1436 dr.screenUpdate(Update::Force | Update::FitCursor);
1438 // Switch to other buffer view and resend cmd
1439 lyx::dispatch(FuncRequest(
1440 LFUN_BUFFER_SWITCH, b->absFileName()));
1448 case LFUN_NOTE_NEXT:
1449 gotoInset(this, NOTE_CODE, false);
1452 case LFUN_REFERENCE_NEXT: {
1453 vector<InsetCode> tmp;
1454 tmp.push_back(LABEL_CODE);
1455 tmp.push_back(REF_CODE);
1456 gotoInset(this, tmp, true);
1460 case LFUN_CHANGES_TRACK:
1461 buffer_.params().track_changes = !buffer_.params().track_changes;
1464 case LFUN_CHANGES_OUTPUT:
1465 buffer_.params().output_changes = !buffer_.params().output_changes;
1466 if (buffer_.params().output_changes) {
1467 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1468 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1469 LaTeXFeatures::isAvailable("xcolor");
1471 if (!dvipost && !xcolorulem) {
1472 Alert::warning(_("Changes not shown in LaTeX output"),
1473 _("Changes will not be highlighted in LaTeX output, "
1474 "because neither dvipost nor xcolor/ulem are installed.\n"
1475 "Please install these packages or redefine "
1476 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1477 } else if (!xcolorulem) {
1478 Alert::warning(_("Changes not shown in LaTeX output"),
1479 _("Changes will not be highlighted in LaTeX output "
1480 "when using pdflatex, because xcolor and ulem are not installed.\n"
1481 "Please install both packages or redefine "
1482 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1487 case LFUN_CHANGE_NEXT:
1488 findNextChange(this);
1489 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1490 dr.screenUpdate(Update::Force | Update::FitCursor);
1493 case LFUN_CHANGE_PREVIOUS:
1494 findPreviousChange(this);
1495 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1496 dr.screenUpdate(Update::Force | Update::FitCursor);
1499 case LFUN_CHANGES_MERGE:
1500 if (findNextChange(this) || findPreviousChange(this)) {
1501 dr.screenUpdate(Update::Force | Update::FitCursor);
1502 dr.forceBufferUpdate();
1503 showDialog("changes");
1507 case LFUN_ALL_CHANGES_ACCEPT:
1508 // select complete document
1510 cur.selHandle(true);
1511 buffer_.text().cursorBottom(cur);
1512 // accept everything in a single step to support atomic undo
1513 buffer_.text().acceptOrRejectChanges(cur, Text::ACCEPT);
1515 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1516 dr.screenUpdate(Update::Force | Update::FitCursor);
1517 dr.forceBufferUpdate();
1520 case LFUN_ALL_CHANGES_REJECT:
1521 // select complete document
1523 cur.selHandle(true);
1524 buffer_.text().cursorBottom(cur);
1525 // reject everything in a single step to support atomic undo
1526 // Note: reject does not work recursively; the user may have to repeat the operation
1527 buffer_.text().acceptOrRejectChanges(cur, Text::REJECT);
1529 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1530 dr.screenUpdate(Update::Force | Update::FitCursor);
1531 dr.forceBufferUpdate();
1534 case LFUN_WORD_FIND_FORWARD:
1535 case LFUN_WORD_FIND_BACKWARD: {
1537 // Would it maybe be better if this variable were view specific anyway?
1538 static docstring last_search;
1539 docstring searched_string;
1541 if (!cmd.argument().empty()) {
1542 last_search = cmd.argument();
1543 searched_string = cmd.argument();
1545 searched_string = last_search;
1548 if (searched_string.empty())
1551 bool const fw = act == LFUN_WORD_FIND_FORWARD;
1552 docstring const data =
1553 find2string(searched_string, true, false, fw);
1554 bool found = lyxfind(this, FuncRequest(LFUN_WORD_FIND, data));
1556 dr.screenUpdate(Update::Force | Update::FitCursor);
1566 case LFUN_WORD_FIND: {
1567 FuncRequest req = cmd;
1568 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1569 req = d->search_request_cache_;
1570 if (req.argument().empty()) {
1571 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, "findreplace"));
1574 if (lyxfind(this, req)) {
1575 dr.screenUpdate(Update::Force | Update::FitCursor);
1582 d->search_request_cache_ = req;
1586 case LFUN_WORD_REPLACE: {
1587 bool has_deleted = false;
1588 if (cur.selection()) {
1589 DocIterator beg = cur.selectionBegin();
1590 DocIterator end = cur.selectionEnd();
1591 if (beg.pit() == end.pit()) {
1592 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1593 if (!cur.inMathed() && cur.paragraph().isDeleted(p)) {
1600 if (lyxreplace(this, cmd, has_deleted)) {
1601 dr.forceBufferUpdate();
1602 dr.screenUpdate(Update::Force | Update::FitCursor);
1612 case LFUN_WORD_FINDADV: {
1613 FindAndReplaceOptions opt;
1614 istringstream iss(to_utf8(cmd.argument()));
1616 if (findAdv(this, opt)) {
1617 dr.screenUpdate(Update::Force | Update::FitCursor);
1628 cur.clearSelection();
1629 dr.setMessage(from_utf8(N_("Mark off")));
1633 cur.clearSelection();
1635 dr.setMessage(from_utf8(N_("Mark on")));
1638 case LFUN_MARK_TOGGLE:
1639 cur.setSelection(false);
1642 dr.setMessage(from_utf8(N_("Mark removed")));
1645 dr.setMessage(from_utf8(N_("Mark set")));
1650 case LFUN_SCREEN_SHOW_CURSOR:
1654 case LFUN_SCREEN_RECENTER:
1658 case LFUN_BIBTEX_DATABASE_ADD: {
1659 Cursor tmpcur = cur;
1660 findInset(tmpcur, BIBTEX_CODE, false);
1661 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1664 if (inset->addDatabase(cmd.argument())) {
1665 buffer_.invalidateBibfileCache();
1666 dr.forceBufferUpdate();
1672 case LFUN_BIBTEX_DATABASE_DEL: {
1673 Cursor tmpcur = cur;
1674 findInset(tmpcur, BIBTEX_CODE, false);
1675 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1678 if (inset->delDatabase(cmd.argument())) {
1679 buffer_.invalidateBibfileCache();
1680 dr.forceBufferUpdate();
1686 case LFUN_STATISTICS: {
1687 DocIterator from, to;
1688 if (cur.selection()) {
1689 from = cur.selectionBegin();
1690 to = cur.selectionEnd();
1692 from = doc_iterator_begin(&buffer_);
1693 to = doc_iterator_end(&buffer_);
1695 buffer_.updateStatistics(from, to);
1696 int const words = buffer_.wordCount();
1697 int const chars = buffer_.charCount(false);
1698 int const chars_blanks = buffer_.charCount(true);
1700 if (cur.selection())
1701 message = _("Statistics for the selection:");
1703 message = _("Statistics for the document:");
1706 message += bformat(_("%1$d words"), words);
1708 message += _("One word");
1710 if (chars_blanks != 1)
1711 message += bformat(_("%1$d characters (including blanks)"),
1714 message += _("One character (including blanks)");
1717 message += bformat(_("%1$d characters (excluding blanks)"),
1720 message += _("One character (excluding blanks)");
1722 Alert::information(_("Statistics"), message);
1726 case LFUN_BUFFER_TOGGLE_COMPRESSION:
1727 // turn compression on/off
1728 buffer_.params().compressed = !buffer_.params().compressed;
1731 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
1732 buffer_.params().output_sync = !buffer_.params().output_sync;
1735 case LFUN_SCREEN_UP:
1736 case LFUN_SCREEN_DOWN: {
1737 Point p = getPos(cur);
1738 // This code has been commented out to enable to scroll down a
1739 // document, even if there are large insets in it (see bug #5465).
1740 /*if (p.y_ < 0 || p.y_ > height_) {
1741 // The cursor is off-screen so recenter before proceeding.
1745 int const scrolled = scroll(act == LFUN_SCREEN_UP
1746 ? -height_ : height_);
1747 if (act == LFUN_SCREEN_UP && scrolled > -height_)
1749 if (act == LFUN_SCREEN_DOWN && scrolled < height_)
1750 p = Point(width_, height_);
1751 bool const in_texted = cur.inTexted();
1752 cur.setCursor(doc_iterator_begin(cur.buffer()));
1753 cur.selHandle(false);
1754 buffer_.changed(true);
1755 updateHoveredInset();
1757 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_,
1758 true, act == LFUN_SCREEN_UP);
1759 //FIXME: what to do with cur.x_target()?
1760 bool update = in_texted && cur.bv().checkDepm(cur, old);
1763 if (update || cur.mark())
1764 dr.screenUpdate(Update::Force | Update::FitCursor);
1766 dr.forceBufferUpdate();
1771 string const scroll_type = cmd.getArg(0);
1772 int scroll_step = 0;
1773 if (scroll_type == "line")
1774 scroll_step = d->scrollbarParameters_.single_step;
1775 else if (scroll_type == "page")
1776 scroll_step = d->scrollbarParameters_.page_step;
1779 string const scroll_quantity = cmd.getArg(1);
1780 if (scroll_quantity == "up")
1781 scrollUp(scroll_step);
1782 else if (scroll_quantity == "down")
1783 scrollDown(scroll_step);
1785 int const scroll_value = convert<int>(scroll_quantity);
1787 scroll(scroll_step * scroll_value);
1789 buffer_.changed(true);
1790 updateHoveredInset();
1791 dr.forceBufferUpdate();
1795 case LFUN_SCREEN_UP_SELECT: {
1796 // FIXME: why is the algorithm different from LFUN_SCREEN_UP?
1797 cur.selHandle(true);
1798 if (isTopScreen()) {
1799 lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1803 int y = getPos(cur).y_;
1804 int const ymin = y - height_ + defaultRowHeight();
1805 while (y > ymin && cur.up())
1809 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1813 case LFUN_SCREEN_DOWN_SELECT: {
1814 // FIXME: why is the algorithm different from LFUN_SCREEN_DOWN?
1815 cur.selHandle(true);
1816 if (isBottomScreen()) {
1817 lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1821 int y = getPos(cur).y_;
1822 int const ymax = y + height_ - defaultRowHeight();
1823 while (y < ymax && cur.down())
1827 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1832 case LFUN_INSET_SELECT_ALL:
1834 && cur.selBegin().at_begin()
1835 && cur.selEnd().at_end()) {
1836 // All the contents of the inset if selected.
1837 // Select the inset from outside.
1840 cur.setSelection(true);
1842 } else if (cur.selBegin().idx() != cur.selEnd().idx()
1844 && cur.selBegin().at_cell_begin()
1845 && cur.selEnd().at_cell_end())) {
1846 // At least one complete cell is selected.
1851 cur.setSelection(true);
1852 cur.idx() = cur.lastidx();
1853 cur.pos() = cur.lastpos();
1855 // select current cell
1859 cur.setSelection(true);
1860 cur.pit() = cur.lastpit();
1861 cur.pos() = cur.lastpos();
1863 dr.screenUpdate(Update::Force);
1867 // This would be in Buffer class if only Cursor did not
1868 // require a bufferview
1869 case LFUN_INSET_FORALL: {
1870 docstring const name = from_utf8(cmd.getArg(0));
1871 string const commandstr = cmd.getLongArg(1);
1872 FuncRequest const fr = lyxaction.lookupFunc(commandstr);
1874 // an arbitrary number to limit number of iterations
1875 const int max_iter = 100000;
1877 Cursor & cur = d->cursor_;
1878 Cursor const savecur = cur;
1880 if (!cur.nextInset())
1882 cur.beginUndoGroup();
1883 while(cur && iterations < max_iter) {
1884 Inset * const ins = cur.nextInset();
1887 docstring insname = ins->layoutName();
1888 while (!insname.empty()) {
1889 if (insname == name || name == from_utf8("*")) {
1891 lyx::dispatch(fr, dr);
1895 size_t const i = insname.rfind(':');
1896 if (i == string::npos)
1898 insname = insname.substr(0, i);
1900 // if we did not delete the inset, skip it
1901 if (!cur.nextInset() || cur.nextInset() == ins)
1907 dr.screenUpdate(Update::Force);
1908 dr.forceBufferUpdate();
1910 if (iterations >= max_iter) {
1912 dr.setMessage(bformat(_("`inset-forall' interrupted because number of actions is larger than %1$d"), max_iter));
1914 dr.setMessage(bformat(_("Applied \"%1$s\" to %2$d insets"), from_utf8(commandstr), iterations));
1919 case LFUN_BRANCH_ADD_INSERT: {
1920 docstring branch_name = from_utf8(cmd.getArg(0));
1921 if (branch_name.empty())
1922 if (!Alert::askForText(branch_name, _("Branch name")) ||
1923 branch_name.empty())
1926 DispatchResult drtmp;
1927 buffer_.dispatch(FuncRequest(LFUN_BRANCH_ADD, branch_name), drtmp);
1928 if (drtmp.error()) {
1929 Alert::warning(_("Branch already exists"), drtmp.message());
1932 BranchList & branch_list = buffer_.params().branchlist();
1933 vector<docstring> const branches =
1934 getVectorFromString(branch_name, branch_list.separator());
1935 for (vector<docstring>::const_iterator it = branches.begin();
1936 it != branches.end(); ++it) {
1938 lyx::dispatch(FuncRequest(LFUN_BRANCH_INSERT, branch_name));
1943 case LFUN_KEYMAP_OFF:
1944 getIntl().keyMapOn(false);
1947 case LFUN_KEYMAP_PRIMARY:
1948 getIntl().keyMapPrim();
1951 case LFUN_KEYMAP_SECONDARY:
1952 getIntl().keyMapSec();
1955 case LFUN_KEYMAP_TOGGLE:
1956 getIntl().toggleKeyMap();
1959 case LFUN_DIALOG_SHOW_NEW_INSET: {
1960 string const name = cmd.getArg(0);
1961 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
1962 if (decodeInsetParam(name, data, buffer_))
1963 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
1965 lyxerr << "Inset type '" << name <<
1966 "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" << endl;
1970 case LFUN_CITATION_INSERT: {
1971 if (argument.empty()) {
1972 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
1975 // we can have one optional argument, delimited by '|'
1976 // citation-insert <key>|<text_before>
1977 // this should be enhanced to also support text_after
1978 // and citation style
1979 string arg = argument;
1981 if (contains(argument, "|")) {
1982 arg = token(argument, '|', 0);
1983 opt1 = token(argument, '|', 1);
1986 // if our cursor is directly in front of or behind a citation inset,
1987 // we will instead add the new key to it.
1988 Inset * inset = cur.nextInset();
1989 if (!inset || inset->lyxCode() != CITE_CODE)
1990 inset = cur.prevInset();
1991 if (inset && inset->lyxCode() == CITE_CODE) {
1992 InsetCitation * icite = static_cast<InsetCitation *>(inset);
1993 if (icite->addKey(arg)) {
1994 dr.forceBufferUpdate();
1995 dr.screenUpdate(Update::FitCursor | Update::SinglePar);
1997 LYXERR0("Discarding optional argument to citation-insert.");
2002 InsetCommandParams icp(CITE_CODE);
2003 icp["key"] = from_utf8(arg);
2005 icp["before"] = from_utf8(opt1);
2006 string icstr = InsetCommand::params2string(icp);
2007 FuncRequest fr(LFUN_INSET_INSERT, icstr);
2012 case LFUN_INSET_APPLY: {
2013 string const name = cmd.getArg(0);
2014 Inset * inset = editedInset(name);
2016 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
2020 // put cursor in front of inset.
2021 if (!setCursorFromInset(inset)) {
2022 LASSERT(false, break);
2025 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
2026 inset->dispatch(cur, fr);
2027 dr.screenUpdate(cur.result().screenUpdate());
2028 if (cur.result().needBufferUpdate())
2029 dr.forceBufferUpdate();
2034 // The change of language of buffer belongs to the Buffer class.
2035 // We have to do it here because we need a cursor for Undo.
2036 // When Undo::recordUndoBufferParams() is implemented someday
2037 // LFUN_BUFFER_LANGUAGE should be handled by the Buffer class.
2038 case LFUN_BUFFER_LANGUAGE: {
2039 Language const * oldL = buffer_.params().language;
2040 Language const * newL = languages.getLanguage(argument);
2041 if (!newL || oldL == newL)
2043 if (oldL->rightToLeft() == newL->rightToLeft()) {
2044 cur.recordUndoFullBuffer();
2045 buffer_.changeLanguage(oldL, newL);
2046 cur.setCurrentFont();
2047 dr.forceBufferUpdate();
2052 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
2053 case LFUN_FILE_INSERT_PLAINTEXT: {
2054 bool const as_paragraph = (act == LFUN_FILE_INSERT_PLAINTEXT_PARA);
2055 string const fname = to_utf8(cmd.argument());
2056 if (!FileName::isAbsolute(fname))
2057 dr.setMessage(_("Absolute filename expected."));
2059 insertPlaintextFile(FileName(fname), as_paragraph);
2064 // OK, so try the Buffer itself...
2065 buffer_.dispatch(cmd, dr);
2066 dispatched = dr.dispatched();
2070 buffer_.undo().endUndoGroup();
2071 dr.dispatched(dispatched);
2073 // NOTE: The code below is copied from Cursor::dispatch. If you
2074 // need to modify this, please update the other one too.
2076 // notify insets we just entered/left
2077 if (cursor() != old) {
2078 old.beginUndoGroup();
2080 bool badcursor = notifyCursorLeavesOrEnters(old, cursor());
2082 cursor().fixIfBroken();
2083 resetInlineCompletionPos();
2090 docstring const BufferView::requestSelection()
2092 Cursor & cur = d->cursor_;
2094 LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
2095 if (!cur.selection()) {
2096 d->xsel_cache_.set = false;
2100 LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
2101 if (!d->xsel_cache_.set ||
2102 cur.top() != d->xsel_cache_.cursor ||
2103 cur.realAnchor().top() != d->xsel_cache_.anchor)
2105 d->xsel_cache_.cursor = cur.top();
2106 d->xsel_cache_.anchor = cur.realAnchor().top();
2107 d->xsel_cache_.set = cur.selection();
2108 return cur.selectionAsString(false);
2114 void BufferView::clearSelection()
2116 d->cursor_.clearSelection();
2117 // Clear the selection buffer. Otherwise a subsequent
2118 // middle-mouse-button paste would use the selection buffer,
2119 // not the more current external selection.
2120 cap::clearSelection();
2121 d->xsel_cache_.set = false;
2122 // The buffer did not really change, but this causes the
2123 // redraw we need because we cleared the selection above.
2124 buffer_.changed(false);
2128 void BufferView::resize(int width, int height)
2130 // Update from work area
2134 // Clear the paragraph height cache.
2135 d->par_height_.clear();
2136 // Redo the metrics.
2141 Inset const * BufferView::getCoveringInset(Text const & text,
2144 TextMetrics & tm = d->text_metrics_[&text];
2145 Inset * inset = tm.checkInsetHit(x, y);
2149 if (!inset->descendable(*this))
2150 // No need to go further down if the inset is not
2154 size_t cell_number = inset->nargs();
2155 // Check all the inner cell.
2156 for (size_t i = 0; i != cell_number; ++i) {
2157 Text const * inner_text = inset->getText(i);
2160 Inset const * inset_deeper =
2161 getCoveringInset(*inner_text, x, y);
2163 return inset_deeper;
2171 void BufferView::updateHoveredInset() const
2173 // Get inset under mouse, if there is one.
2174 int const x = d->mouse_position_cache_.x_;
2175 int const y = d->mouse_position_cache_.y_;
2176 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
2178 d->clickable_inset_ = covering_inset && covering_inset->clickable(x, y);
2180 if (covering_inset == d->last_inset_)
2181 // Same inset, no need to do anything...
2184 bool need_redraw = false;
2185 if (d->last_inset_) {
2186 // Remove the hint on the last hovered inset (if any).
2187 need_redraw |= d->last_inset_->setMouseHover(this, false);
2191 if (covering_inset && covering_inset->setMouseHover(this, true)) {
2193 // Only the insets that accept the hover state, do
2194 // clear the last_inset_, so only set the last_inset_
2195 // member if the hovered setting is accepted.
2196 d->last_inset_ = covering_inset;
2200 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
2201 << d->mouse_position_cache_.x_ << ", "
2202 << d->mouse_position_cache_.y_ << ")");
2204 d->update_strategy_ = DecorationUpdate;
2206 // This event (moving without mouse click) is not passed further.
2207 // This should be changed if it is further utilized.
2208 buffer_.changed(false);
2213 void BufferView::clearLastInset(Inset * inset) const
2215 if (d->last_inset_ != inset) {
2216 LYXERR0("Wrong last_inset!");
2223 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
2225 //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
2227 // This is only called for mouse related events including
2228 // LFUN_FILE_OPEN generated by drag-and-drop.
2229 FuncRequest cmd = cmd0;
2231 Cursor old = cursor();
2233 cur.push(buffer_.inset());
2234 cur.setSelection(d->cursor_.selection());
2236 // Either the inset under the cursor or the
2237 // surrounding Text will handle this event.
2239 // make sure we stay within the screen...
2240 cmd.set_y(min(max(cmd.y(), -1), height_));
2242 d->mouse_position_cache_.x_ = cmd.x();
2243 d->mouse_position_cache_.y_ = cmd.y();
2245 if (cmd.action() == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
2246 updateHoveredInset();
2250 // Build temporary cursor.
2251 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x(), cmd.y());
2253 // Put anchor at the same position.
2256 cur.beginUndoGroup();
2258 // Try to dispatch to an non-editable inset near this position
2259 // via the temp cursor. If the inset wishes to change the real
2260 // cursor it has to do so explicitly by using
2261 // cur.bv().cursor() = cur; (or similar)
2263 inset->dispatch(cur, cmd);
2265 // Now dispatch to the temporary cursor. If the real cursor should
2266 // be modified, the inset's dispatch has to do so explicitly.
2267 if (!inset || !cur.result().dispatched())
2272 // Notify left insets
2274 bool badcursor = old.fixIfBroken() | cur.fixIfBroken();
2275 badcursor |= notifyCursorLeavesOrEnters(old, cur);
2277 cursor().fixIfBroken();
2280 // Do we have a selection?
2281 theSelection().haveSelection(cursor().selection());
2283 if (cur.needBufferUpdate()) {
2284 cur.clearBufferUpdate();
2285 buffer().updateBuffer();
2288 // If the command has been dispatched,
2289 if (cur.result().dispatched() || cur.result().screenUpdate())
2290 processUpdateFlags(cur.result().screenUpdate());
2294 int BufferView::minVisiblePart()
2296 return 2 * defaultRowHeight();
2300 int BufferView::scroll(int y)
2303 return scrollDown(y);
2305 return scrollUp(-y);
2310 int BufferView::scrollDown(int offset)
2312 Text * text = &buffer_.text();
2313 TextMetrics & tm = d->text_metrics_[text];
2314 int const ymax = height_ + offset;
2316 pair<pit_type, ParagraphMetrics const *> last = tm.last();
2317 int bottom_pos = last.second->position() + last.second->descent();
2318 if (lyxrc.scroll_below_document)
2319 bottom_pos += height_ - minVisiblePart();
2320 if (last.first + 1 == int(text->paragraphs().size())) {
2321 if (bottom_pos <= height_)
2323 offset = min(offset, bottom_pos - height_);
2326 if (bottom_pos > ymax)
2328 tm.newParMetricsDown();
2330 d->anchor_ypos_ -= offset;
2335 int BufferView::scrollUp(int offset)
2337 Text * text = &buffer_.text();
2338 TextMetrics & tm = d->text_metrics_[text];
2339 int ymin = - offset;
2341 pair<pit_type, ParagraphMetrics const *> first = tm.first();
2342 int top_pos = first.second->position() - first.second->ascent();
2343 if (first.first == 0) {
2346 offset = min(offset, - top_pos);
2351 tm.newParMetricsUp();
2353 d->anchor_ypos_ += offset;
2358 void BufferView::setCursorFromRow(int row)
2362 pit_type newpit = 0;
2363 pos_type newpos = 0;
2365 buffer_.texrow().getIdFromRow(row, tmpid, tmppos);
2367 bool posvalid = (tmpid != -1);
2369 // we need to make sure that the row and position
2370 // we got back are valid, because the buffer may well
2371 // have changed since we last generated the LaTeX.
2372 DocIterator dit = buffer_.getParFromID(tmpid);
2373 if (dit == doc_iterator_end(&buffer_))
2375 else if (dit.depth() > 1) {
2376 // We are in an inset.
2377 pos_type lastpos = dit.lastpos();
2378 dit.pos() = tmppos > lastpos ? lastpos : tmppos;
2384 // now have to check pos.
2386 Paragraph const & par = buffer_.text().getPar(newpit);
2387 if (newpos > par.size()) {
2388 LYXERR0("Requested position no longer valid.");
2389 newpos = par.size() - 1;
2394 frontend::Alert::error(_("Inverse Search Failed"),
2395 _("Invalid position requested by inverse search.\n"
2396 "You need to update the viewed document."));
2400 buffer_.text().setCursor(d->cursor_, newpit, newpos);
2401 d->cursor_.setSelection(false);
2402 d->cursor_.resetAnchor();
2407 bool BufferView::setCursorFromInset(Inset const * inset)
2409 // are we already there?
2410 if (cursor().nextInset() == inset)
2413 // Inset is not at cursor position. Find it in the document.
2416 while (cur && cur.nextInset() != inset)
2427 void BufferView::gotoLabel(docstring const & label)
2429 ListOfBuffers bufs = buffer().allRelatives();
2430 ListOfBuffers::iterator it = bufs.begin();
2431 for (; it != bufs.end(); ++it) {
2432 Buffer const * buf = *it;
2435 shared_ptr<Toc> toc = buf->tocBackend().toc("label");
2436 TocIterator toc_it = toc->begin();
2437 TocIterator end = toc->end();
2438 for (; toc_it != end; ++toc_it) {
2439 if (label == toc_it->str()) {
2440 lyx::dispatch(toc_it->action());
2448 TextMetrics const & BufferView::textMetrics(Text const * t) const
2450 return const_cast<BufferView *>(this)->textMetrics(t);
2454 TextMetrics & BufferView::textMetrics(Text const * t)
2457 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
2458 if (tmc_it == d->text_metrics_.end()) {
2459 tmc_it = d->text_metrics_.insert(
2460 make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
2462 return tmc_it->second;
2466 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
2469 return textMetrics(t).parMetrics(pit);
2473 int BufferView::workHeight() const
2479 void BufferView::setCursor(DocIterator const & dit)
2482 size_t const n = dit.depth();
2483 for (size_t i = 0; i < n; ++i)
2484 dit[i].inset().edit(d->cursor_, true);
2486 d->cursor_.setCursor(dit);
2487 d->cursor_.setSelection(false);
2488 d->cursor_.setCurrentFont();
2490 // It seems on general grounds as if this is probably needed, but
2491 // it is not yet clear.
2492 // See bug #7394 and r38388.
2493 // d->cursor.resetAnchor();
2497 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
2499 // Would be wrong to delete anything if we have a selection.
2500 if (cur.selection())
2503 bool need_anchor_change = false;
2504 bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
2505 need_anchor_change);
2507 if (need_anchor_change)
2515 // we would rather not do this here, but it needs to be done before
2516 // the changed() signal is sent.
2517 buffer_.updateBuffer();
2519 buffer_.changed(true);
2524 bool BufferView::mouseSetCursor(Cursor & cur, bool select)
2526 LASSERT(&cur.bv() == this, return false);
2529 // this event will clear selection so we save selection for
2530 // persistent selection
2531 cap::saveSelection(cursor());
2533 d->cursor_.macroModeClose();
2534 // If a macro has been finalized, the cursor might have been broken
2537 // Has the cursor just left the inset?
2538 bool const leftinset = (&d->cursor_.inset() != &cur.inset());
2540 d->cursor_.fixIfBroken();
2542 // FIXME: shift-mouse selection doesn't work well across insets.
2543 bool const do_selection =
2544 select && &d->cursor_.normalAnchor().inset() == &cur.inset();
2546 // do the dEPM magic if needed
2547 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
2548 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
2549 // the leftinset bool would not be necessary (badcursor instead).
2550 bool update = leftinset;
2551 if (!do_selection && d->cursor_.inTexted())
2552 update |= checkDepm(cur, d->cursor_);
2555 d->cursor_.resetAnchor();
2556 d->cursor_.setCursor(cur);
2557 d->cursor_.boundary(cur.boundary());
2559 d->cursor_.setSelection();
2561 d->cursor_.clearSelection();
2563 d->cursor_.finishUndo();
2564 d->cursor_.setCurrentFont();
2566 cur.forceBufferUpdate();
2571 void BufferView::putSelectionAt(DocIterator const & cur,
2572 int length, bool backwards)
2574 d->cursor_.clearSelection();
2580 d->cursor_.pos() += length;
2581 d->cursor_.setSelection(d->cursor_, -length);
2583 d->cursor_.setSelection(d->cursor_, length);
2588 bool BufferView::selectIfEmpty(DocIterator & cur)
2590 if ((cur.inTexted() && !cur.paragraph().empty())
2591 || (cur.inMathed() && !cur.cell().empty()))
2594 pit_type const beg_pit = cur.pit();
2596 // The paragraph associated to this item isn't
2597 // the first one, so it can be selected
2600 // We have to resort to select the space between the
2601 // end of this item and the begin of the next one
2605 // If it is the only item in the document,
2606 // nothing can be selected
2609 pit_type const end_pit = cur.pit();
2610 pos_type const end_pos = cur.pos();
2611 d->cursor_.clearSelection();
2613 d->cursor_.setCursor(cur);
2614 d->cursor_.pit() = beg_pit;
2615 d->cursor_.pos() = 0;
2616 d->cursor_.setSelection(false);
2617 d->cursor_.resetAnchor();
2618 d->cursor_.pit() = end_pit;
2619 d->cursor_.pos() = end_pos;
2620 d->cursor_.setSelection();
2625 Cursor & BufferView::cursor()
2631 Cursor const & BufferView::cursor() const
2637 pit_type BufferView::anchor_ref() const
2639 return d->anchor_pit_;
2643 bool BufferView::singleParUpdate()
2645 Text & buftext = buffer_.text();
2646 pit_type const bottom_pit = d->cursor_.bottom().pit();
2647 TextMetrics & tm = textMetrics(&buftext);
2648 int old_height = tm.parMetrics(bottom_pit).height();
2650 // make sure inline completion pointer is ok
2651 if (d->inlineCompletionPos_.fixIfBroken())
2652 d->inlineCompletionPos_ = DocIterator();
2654 // In Single Paragraph mode, rebreak only
2655 // the (main text, not inset!) paragraph containing the cursor.
2656 // (if this paragraph contains insets etc., rebreaking will
2657 // recursively descend)
2658 tm.redoParagraph(bottom_pit);
2659 ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
2660 if (pm.height() != old_height)
2661 // Paragraph height has changed so we cannot proceed to
2662 // the singlePar optimisation.
2665 d->update_strategy_ = SingleParUpdate;
2667 LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
2668 << " y2: " << pm.position() + pm.descent()
2669 << " pit: " << bottom_pit
2670 << " singlepar: 1");
2675 void BufferView::updateMetrics()
2677 if (height_ == 0 || width_ == 0)
2680 Text & buftext = buffer_.text();
2681 pit_type const npit = int(buftext.paragraphs().size());
2683 // Clear out the position cache in case of full screen redraw,
2684 d->coord_cache_.clear();
2686 // Clear out paragraph metrics to avoid having invalid metrics
2687 // in the cache from paragraphs not relayouted below
2688 // The complete text metrics will be redone.
2689 d->text_metrics_.clear();
2691 TextMetrics & tm = textMetrics(&buftext);
2693 // make sure inline completion pointer is ok
2694 if (d->inlineCompletionPos_.fixIfBroken())
2695 d->inlineCompletionPos_ = DocIterator();
2697 if (d->anchor_pit_ >= npit)
2698 // The anchor pit must have been deleted...
2699 d->anchor_pit_ = npit - 1;
2701 // Rebreak anchor paragraph.
2702 tm.redoParagraph(d->anchor_pit_);
2703 ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
2706 if (d->anchor_pit_ == 0) {
2707 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
2709 // Complete buffer visible? Then it's easy.
2710 if (scrollRange == 0)
2711 d->anchor_ypos_ = anchor_pm.ascent();
2713 // FIXME: Some clever handling needed to show
2714 // the _first_ paragraph up to the top if the cursor is
2715 // in the first line.
2717 anchor_pm.setPosition(d->anchor_ypos_);
2719 LYXERR(Debug::PAINTING, "metrics: "
2720 << " anchor pit = " << d->anchor_pit_
2721 << " anchor ypos = " << d->anchor_ypos_);
2723 // Redo paragraphs above anchor if necessary.
2724 int y1 = d->anchor_ypos_ - anchor_pm.ascent();
2725 // We are now just above the anchor paragraph.
2726 pit_type pit1 = d->anchor_pit_ - 1;
2727 for (; pit1 >= 0 && y1 >= 0; --pit1) {
2728 tm.redoParagraph(pit1);
2729 ParagraphMetrics & pm = tm.par_metrics_[pit1];
2731 // Save the paragraph position in the cache.
2736 // Redo paragraphs below the anchor if necessary.
2737 int y2 = d->anchor_ypos_ + anchor_pm.descent();
2738 // We are now just below the anchor paragraph.
2739 pit_type pit2 = d->anchor_pit_ + 1;
2740 for (; pit2 < npit && y2 <= height_; ++pit2) {
2741 tm.redoParagraph(pit2);
2742 ParagraphMetrics & pm = tm.par_metrics_[pit2];
2744 // Save the paragraph position in the cache.
2749 LYXERR(Debug::PAINTING, "Metrics: "
2750 << " anchor pit = " << d->anchor_pit_
2751 << " anchor ypos = " << d->anchor_ypos_
2754 << " pit1 = " << pit1
2755 << " pit2 = " << pit2);
2757 d->update_strategy_ = FullScreenUpdate;
2759 if (lyxerr.debugging(Debug::WORKAREA)) {
2760 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
2761 d->coord_cache_.dump();
2766 void BufferView::insertLyXFile(FileName const & fname)
2768 LASSERT(d->cursor_.inTexted(), return);
2770 // Get absolute path of file and add ".lyx"
2771 // to the filename if necessary
2772 FileName filename = fileSearch(string(), fname.absFileName(), "lyx");
2774 docstring const disp_fn = makeDisplayPath(filename.absFileName());
2775 // emit message signal.
2776 message(bformat(_("Inserting document %1$s..."), disp_fn));
2779 Buffer buf(filename.absFileName(), false);
2780 if (buf.loadLyXFile() == Buffer::ReadSuccess) {
2781 ErrorList & el = buffer_.errorList("Parse");
2782 // Copy the inserted document error list into the current buffer one.
2783 el = buf.errorList("Parse");
2784 buffer_.undo().recordUndo(d->cursor_);
2785 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
2786 buf.params().documentClassPtr(), el);
2787 res = _("Document %1$s inserted.");
2789 res = _("Could not insert document %1$s");
2792 buffer_.changed(true);
2793 // emit message signal.
2794 message(bformat(res, disp_fn));
2798 Point BufferView::coordOffset(DocIterator const & dit) const
2804 // Addup contribution of nested insets, from inside to outside,
2805 // keeping the outer paragraph for a special handling below
2806 for (size_t i = dit.depth() - 1; i >= 1; --i) {
2807 CursorSlice const & sl = dit[i];
2811 // get relative position inside sl.inset()
2812 sl.inset().cursorPos(*this, sl, dit.boundary() && (i + 1 == dit.depth()), xx, yy);
2814 // Make relative position inside of the edited inset relative to sl.inset()
2818 // In case of an RTL inset, the edited inset will be positioned to the left
2821 bool boundary_i = dit.boundary() && i + 1 == dit.depth();
2822 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2827 // remember width for the case that sl.inset() is positioned in an RTL inset
2828 if (i && dit[i - 1].text()) {
2829 // If this Inset is inside a Text Inset, retrieve the Dimension
2830 // from the containing text instead of using Inset::dimension() which
2831 // might not be implemented.
2832 // FIXME (Abdel 23/09/2007): this is a bit messy because of the
2833 // elimination of Inset::dim_ cache. This coordOffset() method needs
2834 // to be rewritten in light of the new design.
2835 Dimension const & dim = parMetrics(dit[i - 1].text(),
2836 dit[i - 1].pit()).insetDimension(&sl.inset());
2839 Dimension const dim = sl.inset().dimension(*this);
2843 //lyxerr << "Cursor::getPos, i: "
2844 // << i << " x: " << xx << " y: " << y << endl;
2847 // Add contribution of initial rows of outermost paragraph
2848 CursorSlice const & sl = dit[0];
2849 TextMetrics const & tm = textMetrics(sl.text());
2850 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2852 LBUFERR(!pm.rows().empty());
2853 y -= pm.rows()[0].ascent();
2855 // FIXME: document this mess
2857 if (sl.pos() > 0 && dit.depth() == 1) {
2859 if (pos && dit.boundary())
2861 // lyxerr << "coordOffset: boundary:" << dit.boundary() << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
2862 rend = pm.pos2row(pos);
2864 rend = pm.pos2row(sl.pos());
2866 size_t rend = pm.pos2row(sl.pos());
2868 for (size_t rit = 0; rit != rend; ++rit)
2869 y += pm.rows()[rit].height();
2870 y += pm.rows()[rend].ascent();
2872 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
2874 // Make relative position from the nested inset now bufferview absolute.
2875 int xx = bottom_tm.cursorX(dit.bottom(), dit.boundary() && dit.depth() == 1);
2878 // In the RTL case place the nested inset at the left of the cursor in
2879 // the outer paragraph
2880 bool boundary_1 = dit.boundary() && 1 == dit.depth();
2881 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
2889 Point BufferView::getPos(DocIterator const & dit) const
2891 if (!paragraphVisible(dit))
2892 return Point(-1, -1);
2894 CursorSlice const & bot = dit.bottom();
2895 TextMetrics const & tm = textMetrics(bot.text());
2897 // offset from outer paragraph
2898 Point p = coordOffset(dit);
2899 p.y_ += tm.parMetrics(bot.pit()).position();
2904 bool BufferView::paragraphVisible(DocIterator const & dit) const
2906 CursorSlice const & bot = dit.bottom();
2907 TextMetrics const & tm = textMetrics(bot.text());
2909 return tm.contains(bot.pit());
2913 void BufferView::cursorPosAndHeight(Point & p, int & h) const
2915 Cursor const & cur = cursor();
2916 Font const font = cur.getFont();
2917 frontend::FontMetrics const & fm = theFontMetrics(font);
2918 int const asc = fm.maxAscent();
2919 int const des = fm.maxDescent();
2926 bool BufferView::cursorInView(Point const & p, int h) const
2928 Cursor const & cur = cursor();
2929 // does the cursor touch the screen ?
2930 if (p.y_ + h < 0 || p.y_ >= workHeight() || !paragraphVisible(cur))
2936 int BufferView::horizScrollOffset() const
2938 return d->horiz_scroll_offset_;
2942 CursorSlice const & BufferView::currentRowSlice() const
2944 return d->current_row_slice_;
2948 CursorSlice const & BufferView::lastRowSlice() const
2950 return d->last_row_slice_;
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()
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 // Current x position of the cursor in pixels
2993 int const cur_x = getPos(d->cursor_).x_;
2995 // Horizontal scroll offset of the cursor row in pixels
2996 int offset = d->horiz_scroll_offset_;
2997 int const MARGIN = 2 * theFontMetrics(d->cursor_.real_current_font).em();
2998 //lyxerr << "cur_x=" << cur_x << ", offset=" << offset << ", margin=" << MARGIN << endl;
2999 if (cur_x < offset + MARGIN) {
3001 offset = cur_x - MARGIN;
3002 } else if (cur_x > offset + workWidth() - MARGIN) {
3004 offset = cur_x - workWidth() + MARGIN;
3007 if (offset < row.left_margin || row.width() <= workWidth())
3010 if (offset != d->horiz_scroll_offset_)
3011 LYXERR(Debug::PAINTING, "Horiz. scroll offset changed from "
3012 << d->horiz_scroll_offset_ << " to " << offset);
3014 if (d->update_strategy_ == NoScreenUpdate
3015 && (offset != d->horiz_scroll_offset_
3016 || !d->last_row_slice_.empty())) {
3017 // FIXME: if one uses SingleParUpdate, then home/end
3018 // will not work on long rows. Why?
3019 d->update_strategy_ = FullScreenUpdate;
3022 d->horiz_scroll_offset_ = offset;
3026 void BufferView::draw(frontend::Painter & pain)
3028 if (height_ == 0 || width_ == 0)
3030 LYXERR(Debug::PAINTING, "\t\t*** START DRAWING ***");
3032 Text & text = buffer_.text();
3033 TextMetrics const & tm = d->text_metrics_[&text];
3034 int const y = tm.first().second->position();
3035 PainterInfo pi(this, pain);
3037 // Check whether the row where the cursor lives needs to be scrolled.
3038 // Update the drawing strategy if needed.
3039 checkCursorScrollOffset();
3041 switch (d->update_strategy_) {
3043 case NoScreenUpdate:
3044 // If no screen painting is actually needed, only some the different
3045 // coordinates of insets and paragraphs needs to be updated.
3046 LYXERR(Debug::PAINTING, "Strategy: NoScreenUpdate");
3047 pi.full_repaint = true;
3048 pi.pain.setDrawingEnabled(false);
3052 case SingleParUpdate:
3053 pi.full_repaint = false;
3054 LYXERR(Debug::PAINTING, "Strategy: SingleParUpdate");
3055 // In general, only the current row of the outermost paragraph
3056 // will be redrawn. Particular cases where selection spans
3057 // multiple paragraph are correctly detected in TextMetrics.
3061 case DecorationUpdate:
3062 // FIXME: We should also distinguish DecorationUpdate to avoid text
3063 // drawing if possible. This is not possible to do easily right now
3064 // because of the single backing pixmap.
3066 case FullScreenUpdate:
3068 LYXERR(Debug::PAINTING,
3069 ((d->update_strategy_ == FullScreenUpdate)
3070 ? "Strategy: FullScreenUpdate"
3071 : "Strategy: DecorationUpdate"));
3073 // The whole screen, including insets, will be refreshed.
3074 pi.full_repaint = true;
3076 // Clear background.
3077 pain.fillRectangle(0, 0, width_, height_,
3078 pi.backgroundColor(&buffer_.inset()));
3083 // and possibly grey out below
3084 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3085 int const y2 = lastpm.second->position() + lastpm.second->descent();
3088 Color color = buffer().isInternal()
3089 ? Color_background : Color_bottomarea;
3090 pain.fillRectangle(0, y2, width_, height_ - y2, color);
3094 LYXERR(Debug::PAINTING, "\n\t\t*** END DRAWING ***");
3096 // The scrollbar needs an update.
3099 // Normalize anchor for next time
3100 pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
3101 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3102 for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
3103 ParagraphMetrics const & pm = tm.parMetrics(pit);
3104 if (pm.position() + pm.descent() > 0) {
3105 d->anchor_pit_ = pit;
3106 d->anchor_ypos_ = pm.position();
3110 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
3111 << " anchor ypos = " << d->anchor_ypos_);
3115 void BufferView::message(docstring const & msg)
3118 d->gui_->message(msg);
3122 void BufferView::showDialog(string const & name)
3125 d->gui_->showDialog(name, string());
3129 void BufferView::showDialog(string const & name,
3130 string const & data, Inset * inset)
3133 d->gui_->showDialog(name, data, inset);
3137 void BufferView::updateDialog(string const & name, string const & data)
3140 d->gui_->updateDialog(name, data);
3144 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
3150 // FIXME: Move this out of BufferView again
3151 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
3153 if (!fname.isReadableFile()) {
3154 docstring const error = from_ascii(strerror(errno));
3155 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3156 docstring const text =
3157 bformat(_("Could not read the specified document\n"
3158 "%1$s\ndue to the error: %2$s"), file, error);
3159 Alert::error(_("Could not read file"), text);
3163 if (!fname.isReadableFile()) {
3164 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3165 docstring const text =
3166 bformat(_("%1$s\n is not readable."), file);
3167 Alert::error(_("Could not open file"), text);
3171 // FIXME UNICODE: We don't know the encoding of the file
3172 docstring file_content = fname.fileContents("UTF-8");
3173 if (file_content.empty()) {
3174 Alert::error(_("Reading not UTF-8 encoded file"),
3175 _("The file is not UTF-8 encoded.\n"
3176 "It will be read as local 8Bit-encoded.\n"
3177 "If this does not give the correct result\n"
3178 "then please change the encoding of the file\n"
3179 "to UTF-8 with a program other than LyX.\n"));
3180 file_content = fname.fileContents("local8bit");
3183 return normalize_c(file_content);
3187 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
3189 docstring const tmpstr = contentsOfPlaintextFile(f);
3194 Cursor & cur = cursor();
3195 cap::replaceSelection(cur);
3196 buffer_.undo().recordUndo(cur);
3198 cur.innerText()->insertStringAsParagraphs(cur, tmpstr, cur.current_font);
3200 cur.innerText()->insertStringAsLines(cur, tmpstr, cur.current_font);
3202 buffer_.changed(true);
3206 docstring const & BufferView::inlineCompletion() const
3208 return d->inlineCompletion_;
3212 size_t const & BufferView::inlineCompletionUniqueChars() const
3214 return d->inlineCompletionUniqueChars_;
3218 DocIterator const & BufferView::inlineCompletionPos() const
3220 return d->inlineCompletionPos_;
3224 void BufferView::resetInlineCompletionPos()
3226 d->inlineCompletionPos_ = DocIterator();
3230 bool samePar(DocIterator const & a, DocIterator const & b)
3232 if (a.empty() && b.empty())
3234 if (a.empty() || b.empty())
3236 if (a.depth() != b.depth())
3238 return &a.innerParagraph() == &b.innerParagraph();
3242 void BufferView::setInlineCompletion(Cursor const & cur, DocIterator const & pos,
3243 docstring const & completion, size_t uniqueChars)
3245 uniqueChars = min(completion.size(), uniqueChars);
3246 bool changed = d->inlineCompletion_ != completion
3247 || d->inlineCompletionUniqueChars_ != uniqueChars;
3248 bool singlePar = true;
3249 d->inlineCompletion_ = completion;
3250 d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
3252 //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
3255 DocIterator const & old = d->inlineCompletionPos_;
3257 //lyxerr << "inlineCompletionPos changed" << std::endl;
3258 // old or pos are in another paragraph?
3259 if ((!samePar(cur, pos) && !pos.empty())
3260 || (!samePar(cur, old) && !old.empty())) {
3262 //lyxerr << "different paragraph" << std::endl;
3264 d->inlineCompletionPos_ = pos;
3269 if (singlePar && !(cur.result().screenUpdate() & Update::Force))
3270 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
3272 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::Force);
3277 bool BufferView::clickableInset() const
3279 return d->clickable_inset_;