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"
68 #include "mathed/InsetMathNest.h"
70 #include "frontends/alert.h"
71 #include "frontends/Application.h"
72 #include "frontends/Delegates.h"
73 #include "frontends/FontMetrics.h"
74 #include "frontends/NullPainter.h"
75 #include "frontends/Painter.h"
76 #include "frontends/Selection.h"
78 #include "support/convert.h"
79 #include "support/debug.h"
80 #include "support/ExceptionMessage.h"
81 #include "support/filetools.h"
82 #include "support/gettext.h"
83 #include "support/lassert.h"
84 #include "support/lstrings.h"
85 #include "support/lyxlib.h"
86 #include "support/Package.h"
87 #include "support/types.h"
97 using namespace lyx::support;
101 namespace Alert = frontend::Alert;
105 /// Return an inset of this class if it exists at the current cursor position
107 T * getInsetByCode(Cursor const & cur, InsetCode code)
109 DocIterator it = cur;
110 Inset * inset = it.nextInset();
111 if (inset && inset->lyxCode() == code)
112 return static_cast<T*>(inset);
117 /// Note that comparing contents can only be used for InsetCommand
118 bool findNextInset(DocIterator & dit, vector<InsetCode> const & codes,
119 docstring const & contents)
121 DocIterator tmpdit = dit;
124 Inset const * inset = tmpdit.nextInset();
126 bool const valid_code = std::find(codes.begin(), codes.end(),
127 inset->lyxCode()) != codes.end();
128 InsetCommand const * ic = inset->asInsetCommand();
129 bool const same_or_no_contents = contents.empty()
130 || (ic && (ic->getFirstNonOptParam() == contents));
132 if (valid_code && same_or_no_contents) {
137 tmpdit.forwardInset();
144 /// Looks for next inset with one of the given codes.
145 /// Note that same_content can only be used for InsetCommand
146 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
150 DocIterator tmpdit = dit;
151 tmpdit.forwardInset();
155 Inset const * inset = tmpdit.nextInset();
156 if (same_content && inset) {
157 InsetCommand const * ic = inset->asInsetCommand();
159 bool const valid_code = std::find(codes.begin(), codes.end(),
160 ic->lyxCode()) != codes.end();
162 contents = ic->getFirstNonOptParam();
166 if (!findNextInset(tmpdit, codes, contents)) {
167 if (dit.depth() != 1 || dit.pit() != 0 || dit.pos() != 0) {
168 inset = &tmpdit.bottom().inset();
169 tmpdit = doc_iterator_begin(&inset->buffer(), inset);
170 if (!findNextInset(tmpdit, codes, contents))
182 /// Looks for next inset with the given code
183 void findInset(DocIterator & dit, InsetCode code, bool same_content)
185 findInset(dit, vector<InsetCode>(1, code), same_content);
189 /// Moves cursor to the next inset with one of the given codes.
190 void gotoInset(BufferView * bv, vector<InsetCode> const & codes,
193 Cursor tmpcur = bv->cursor();
194 if (!findInset(tmpcur, codes, same_content)) {
195 bv->cursor().message(_("No more insets"));
199 tmpcur.clearSelection();
200 bv->setCursor(tmpcur);
205 /// Moves cursor to the next inset with given code.
206 void gotoInset(BufferView * bv, InsetCode code, bool same_content)
208 gotoInset(bv, vector<InsetCode>(1, code), same_content);
212 /// A map from a Text to the associated text metrics
213 typedef map<Text const *, TextMetrics> TextMetricsCache;
215 enum ScreenUpdateStrategy {
225 /////////////////////////////////////////////////////////////////////
229 /////////////////////////////////////////////////////////////////////
231 struct BufferView::Private
233 Private(BufferView & bv) :
234 update_strategy_(FullScreenUpdate),
235 update_flags_(Update::Force),
237 anchor_pit_(0), anchor_ypos_(0),
238 inlineCompletionUniqueChars_(0),
239 last_inset_(0), clickable_inset_(false),
240 mouse_position_cache_(),
241 bookmark_edit_position_(-1), gui_(0),
242 horiz_scroll_offset_(0),
243 caret_ascent_(0), caret_descent_(0)
245 xsel_cache_.set = false;
249 ScrollbarParameters scrollbarParameters_;
251 ScreenUpdateStrategy update_strategy_;
253 Update::flags update_flags_;
255 CoordCache coord_cache_;
257 /// Estimated average par height for scrollbar.
259 /// this is used to handle XSelection events in the right manner.
268 pit_type anchor_pit_;
272 vector<int> par_height_;
275 DocIterator inlineCompletionPos_;
277 docstring inlineCompletion_;
279 size_t inlineCompletionUniqueChars_;
281 /// keyboard mapping object.
284 /// last visited inset.
285 /** kept to send setMouseHover(false).
286 * Not owned, so don't delete.
288 Inset const * last_inset_;
289 /// are we hovering something that we can click
290 bool clickable_inset_;
292 /// position of the mouse at the time of the last mouse move
293 /// This is used to update the hovering status of inset in
294 /// cases where the buffer is scrolled, but the mouse didn't move.
295 Point mouse_position_cache_;
297 // cache for id of the paragraph which was edited the last time
298 int bookmark_edit_position_;
300 mutable TextMetricsCache text_metrics_;
303 /** Not owned, so don't delete.
305 frontend::GuiBufferViewDelegate * gui_;
307 /// Cache for Find Next
308 FuncRequest search_request_cache_;
311 map<string, Inset *> edited_insets_;
313 /// When the row where the cursor lies is scrolled, this
314 /// contains the scroll offset
315 int horiz_scroll_offset_;
316 /// a slice pointing to the start of the row where the cursor
317 /// is (at last draw time)
318 CursorSlice current_row_slice_;
319 /// a slice pointing to the start of the row where cursor was
320 /// at previous draw event
321 CursorSlice last_row_slice_;
323 // The vertical size of the blinking caret. Only used for math
324 // Using it for text could be bad when undo restores the cursor
325 // current font, since the caret size could become wrong.
331 BufferView::BufferView(Buffer & buf)
332 : width_(0), height_(0), full_screen_(false), buffer_(buf),
333 d(new Private(*this))
335 d->xsel_cache_.set = false;
336 d->intl_.initKeyMapper(lyxrc.use_kbmap);
338 d->cursor_.setBuffer(&buf);
339 d->cursor_.push(buffer_.inset());
340 d->cursor_.resetAnchor();
341 d->cursor_.setCurrentFont();
343 buffer_.updatePreviews();
347 BufferView::~BufferView()
349 // current buffer is going to be switched-off, save cursor pos
350 // Ideally, the whole cursor stack should be saved, but session
351 // currently can only handle bottom (whole document) level pit and pos.
352 // That is to say, if a cursor is in a nested inset, it will be
353 // restore to the left of the top level inset.
354 LastFilePosSection::FilePos fp;
355 fp.pit = d->cursor_.bottom().pit();
356 fp.pos = d->cursor_.bottom().pos();
357 theSession().lastFilePos().save(buffer_.fileName(), fp);
360 d->last_inset_->setMouseHover(this, false);
366 int BufferView::rightMargin() const
368 // The value used to be hardcoded to 10
369 int const default_margin = zoomedPixels(10);
370 // The additional test for the case the outliner is opened.
371 if (!full_screen_ || !lyxrc.full_screen_limit
372 || width_ < lyxrc.full_screen_width + 2 * default_margin)
373 return default_margin;
375 return (width_ - lyxrc.full_screen_width) / 2;
379 int BufferView::leftMargin() const
381 return rightMargin();
385 int BufferView::inPixels(Length const & len) const
387 Font const font = buffer().params().getFont();
388 return len.inPixels(workWidth(), theFontMetrics(font).em());
392 int BufferView::zoomedPixels(int pix) const
394 // FIXME: the dpi setting should really depend on the BufferView
395 // (think different monitors).
397 // Zoom factor specified by user in percent
398 double const zoom = lyxrc.currentZoom / 100.0; // [percent]
400 // DPI setting for monitor relative to 100dpi
401 double const dpizoom = lyxrc.dpi / 100.0; // [per 100dpi]
403 return support::iround(pix * zoom * dpizoom);
407 bool BufferView::isTopScreen() const
409 return 0 == d->scrollbarParameters_.min;
413 bool BufferView::isBottomScreen() const
415 return 0 == d->scrollbarParameters_.max;
419 Intl & BufferView::getIntl()
425 Intl const & BufferView::getIntl() const
431 CoordCache & BufferView::coordCache()
433 return d->coord_cache_;
437 CoordCache const & BufferView::coordCache() const
439 return d->coord_cache_;
443 Buffer & BufferView::buffer()
449 Buffer const & BufferView::buffer() const
455 bool BufferView::needsFitCursor() const
457 if (cursorStatus(d->cursor_) == CUR_INSIDE) {
458 frontend::FontMetrics const & fm =
459 theFontMetrics(d->cursor_.getFont().fontInfo());
460 int const asc = fm.maxAscent();
461 int const des = fm.maxDescent();
462 Point const p = getPos(d->cursor_);
463 if (p.y_ - asc >= 0 && p.y_ + des < height_)
472 // this is for debugging only.
473 string flagsAsString(Update::flags flags)
475 if (flags == Update::None)
477 return string((flags & Update::FitCursor) ? "FitCursor " : "")
478 + ((flags & Update::Force) ? "Force " : "")
479 + ((flags & Update::ForceDraw) ? "ForceDraw " : "")
480 + ((flags & Update::SinglePar) ? "SinglePar " : "");
485 void BufferView::processUpdateFlags(Update::flags flags)
487 LYXERR(Debug::PAINTING, "BufferView::processUpdateFlags( "
488 << flagsAsString(flags) << ") buffer: " << &buffer_);
490 // Case when no explicit update is requested.
491 if (flags == Update::None)
494 // SinglePar is ignored for now (this should probably change). We
495 // set it ourselves below, at the price of always rebreaking the
496 // paragraph at cursor. This can be expensive for large tables.
497 flags = flags & ~Update::SinglePar;
499 // First check whether the metrics and inset positions should be updated
500 if (flags & Update::Force) {
501 // This will update the CoordCache items and replace Force
502 // with ForceDraw in flags.
503 updateMetrics(flags);
506 // Then make sure that the screen contains the cursor if needed
507 if (flags & Update::FitCursor) {
508 if (needsFitCursor()) {
509 scrollToCursor(d->cursor_, false);
510 // Metrics have to be recomputed (maybe again)
511 updateMetrics(flags);
513 flags = flags & ~Update::FitCursor;
516 // Finally detect whether we can only repaint a single paragraph
517 if (!(flags & Update::ForceDraw)) {
518 if (singleParUpdate())
519 flags = flags | Update::SinglePar;
521 updateMetrics(flags);
524 // Add flags to the the update flags. These will be reset to None
525 // after the redraw is actually done
526 d->update_flags_ = d->update_flags_ | flags;
527 LYXERR(Debug::PAINTING, "Cumulative flags: " << flagsAsString(flags));
529 // Now compute the update strategy
530 // Possibly values in flag are None, Decoration, ForceDraw
531 LATTEST((d->update_flags_ & ~(Update::None | Update::SinglePar
532 | Update::Decoration | Update::ForceDraw)) == 0);
534 if (d->update_flags_ & Update::ForceDraw)
535 d->update_strategy_ = FullScreenUpdate;
536 else if (d->update_flags_ & Update::Decoration)
537 d->update_strategy_ = DecorationUpdate;
538 else if (d->update_flags_ & Update::SinglePar)
539 d->update_strategy_ = SingleParUpdate;
541 // no need to redraw anything.
542 d->update_strategy_ = NoScreenUpdate;
545 updateHoveredInset();
548 buffer_.changed(false);
552 void BufferView::updateScrollbar()
554 if (height_ == 0 && width_ == 0)
557 // We prefer fixed size line scrolling.
558 d->scrollbarParameters_.single_step = defaultRowHeight();
559 // We prefer full screen page scrolling.
560 d->scrollbarParameters_.page_step = height_;
562 Text & t = buffer_.text();
563 TextMetrics & tm = d->text_metrics_[&t];
565 LYXERR(Debug::GUI, " Updating scrollbar: height: "
566 << t.paragraphs().size()
567 << " curr par: " << d->cursor_.bottom().pit()
568 << " default height " << defaultRowHeight());
570 size_t const parsize = t.paragraphs().size();
571 if (d->par_height_.size() != parsize) {
572 d->par_height_.clear();
573 // FIXME: We assume a default paragraph height of 2 rows. This
574 // should probably be pondered with the screen width.
575 d->par_height_.resize(parsize, defaultRowHeight() * 2);
578 // Look at paragraph heights on-screen
579 pair<pit_type, ParagraphMetrics const *> first = tm.first();
580 pair<pit_type, ParagraphMetrics const *> last = tm.last();
581 for (pit_type pit = first.first; pit <= last.first; ++pit) {
582 d->par_height_[pit] = tm.parMetrics(pit).height();
583 LYXERR(Debug::SCROLLING, "storing height for pit " << pit << " : "
584 << d->par_height_[pit]);
587 int top_pos = first.second->position() - first.second->ascent();
588 int bottom_pos = last.second->position() + last.second->descent();
589 bool first_visible = first.first == 0 && top_pos >= 0;
590 bool last_visible = last.first + 1 == int(parsize) && bottom_pos <= height_;
591 if (first_visible && last_visible) {
592 d->scrollbarParameters_.min = 0;
593 d->scrollbarParameters_.max = 0;
597 d->scrollbarParameters_.min = top_pos;
598 for (size_t i = 0; i != size_t(first.first); ++i)
599 d->scrollbarParameters_.min -= d->par_height_[i];
600 d->scrollbarParameters_.max = bottom_pos;
601 for (size_t i = last.first + 1; i != parsize; ++i)
602 d->scrollbarParameters_.max += d->par_height_[i];
604 // The reference is the top position so we remove one page.
605 if (lyxrc.scroll_below_document)
606 d->scrollbarParameters_.max -= minVisiblePart();
608 d->scrollbarParameters_.max -= d->scrollbarParameters_.page_step;
610 // 0 must be inside the range as it denotes the current position
611 if (d->scrollbarParameters_.max < 0)
612 d->scrollbarParameters_.max = 0;
613 if (d->scrollbarParameters_.min > 0)
614 d->scrollbarParameters_.min = 0;
618 ScrollbarParameters const & BufferView::scrollbarParameters() const
620 return d->scrollbarParameters_;
624 docstring BufferView::toolTip(int x, int y) const
626 // Get inset under mouse, if there is one.
627 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
629 // No inset, no tooltip...
631 return covering_inset->toolTip(*this, x, y);
635 string BufferView::contextMenu(int x, int y) const
637 //If there is a selection, return the containing inset menu
638 if (d->cursor_.selection())
639 return d->cursor_.inset().contextMenu(*this, x, y);
641 // Get inset under mouse, if there is one.
642 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
644 return covering_inset->contextMenu(*this, x, y);
646 return buffer_.inset().contextMenu(*this, x, y);
651 void BufferView::scrollDocView(int const value, bool update)
653 // The scrollbar values are relative to the top of the screen, therefore the
654 // offset is equal to the target value.
656 // No scrolling at all? No need to redraw anything
660 // If the offset is less than 2 screen height, prefer to scroll instead.
661 if (abs(value) <= 2 * height_) {
662 d->anchor_ypos_ -= value;
663 processUpdateFlags(Update::Force);
667 // cut off at the top
668 if (value <= d->scrollbarParameters_.min) {
669 DocIterator dit = doc_iterator_begin(&buffer_);
670 showCursor(dit, false, update);
671 LYXERR(Debug::SCROLLING, "scroll to top");
675 // cut off at the bottom
676 if (value >= d->scrollbarParameters_.max) {
677 DocIterator dit = doc_iterator_end(&buffer_);
679 showCursor(dit, false, update);
680 LYXERR(Debug::SCROLLING, "scroll to bottom");
684 // find paragraph at target position
685 int par_pos = d->scrollbarParameters_.min;
687 for (; i != int(d->par_height_.size()); ++i) {
688 par_pos += d->par_height_[i];
689 if (par_pos >= value)
693 if (par_pos < value) {
694 // It seems we didn't find the correct pit so stay on the safe side and
696 LYXERR0("scrolling position not found!");
697 scrollDocView(d->scrollbarParameters_.max, update);
701 DocIterator dit = doc_iterator_begin(&buffer_);
703 LYXERR(Debug::SCROLLING, "value = " << value << " -> scroll to pit " << i);
704 showCursor(dit, false, update);
708 // FIXME: this method is not working well.
709 void BufferView::setCursorFromScrollbar()
711 TextMetrics & tm = d->text_metrics_[&buffer_.text()];
713 int const height = 2 * defaultRowHeight();
714 int const first = height;
715 int const last = height_ - height;
717 Cursor const & oldcur = d->cursor_;
719 switch (cursorStatus(oldcur)) {
727 int const y = getPos(oldcur).y_;
728 newy = min(last, max(y, first));
732 // We reset the cursor because cursorStatus() does not
733 // work when the cursor is within mathed.
736 tm.setCursorFromCoordinates(cur, 0, newy);
738 // update the bufferview cursor and notify insets
739 // FIXME: Care about the d->cursor_ flags to redraw if needed
740 Cursor old = d->cursor_;
742 // the DEPM call in mouseSetCursor() might have destroyed the
743 // paragraph the cursor is in.
744 bool badcursor = old.fixIfBroken();
745 badcursor |= notifyCursorLeavesOrEnters(old, d->cursor_);
747 d->cursor_.fixIfBroken();
751 Change const BufferView::getCurrentChange() const
753 if (!d->cursor_.selection())
754 return Change(Change::UNCHANGED);
756 DocIterator dit = d->cursor_.selectionBegin();
757 // The selected content might have been changed (see #7685)
758 dit = dit.getInnerText();
759 return dit.paragraph().lookupChange(dit.pos());
763 // this could be used elsewhere as well?
764 // FIXME: This does not work within mathed!
765 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
767 Point const p = getPos(dit);
770 if (p.y_ > workHeight())
776 void BufferView::bookmarkEditPosition()
778 // Don't eat cpu time for each keystroke
779 if (d->cursor_.paragraph().id() == d->bookmark_edit_position_)
782 d->bookmark_edit_position_ = d->cursor_.paragraph().id();
786 void BufferView::saveBookmark(unsigned int idx)
788 // tentatively save bookmark, id and pos will be used to
789 // acturately locate a bookmark in a 'live' lyx session.
790 // pit and pos will be updated with bottom level pit/pos
792 if (!buffer_.isInternal()) {
793 theSession().bookmarks().save(
795 d->cursor_.bottom().pit(),
796 d->cursor_.bottom().pos(),
797 d->cursor_.paragraph().id(),
802 // emit message signal.
803 message(_("Save bookmark"));
808 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
809 int top_id, pos_type top_pos)
811 bool success = false;
814 d->cursor_.clearSelection();
816 // if a valid par_id is given, try it first
817 // This is the case for a 'live' bookmark when unique paragraph ID
818 // is used to track bookmarks.
820 dit = buffer_.getParFromID(top_id);
822 dit.pos() = min(dit.paragraph().size(), top_pos);
823 // Some slices of the iterator may not be
824 // reachable (e.g. closed collapsible inset)
825 // so the dociterator may need to be
826 // shortened. Otherwise, setCursor may crash
827 // lyx when the cursor can not be set to these
829 size_t const n = dit.depth();
830 for (size_t i = 0; i < n; ++i)
831 if (!dit[i].inset().editable()) {
839 // if top_id == 0, or searching through top_id failed
840 // This is the case for a 'restored' bookmark when only bottom
841 // (document level) pit was saved. Because of this, bookmark
842 // restoration is inaccurate. If a bookmark was within an inset,
843 // it will be restored to the left of the outmost inset that contains
845 if (bottom_pit < int(buffer_.paragraphs().size())) {
846 dit = doc_iterator_begin(&buffer_);
848 dit.pit() = bottom_pit;
849 dit.pos() = min(bottom_pos, dit.paragraph().size());
854 // Note: only bottom (document) level pit is set.
856 // set the current font.
857 d->cursor_.setCurrentFont();
858 // Do not forget to reset the anchor (see #9912)
859 d->cursor_.resetAnchor();
860 processUpdateFlags(Update::FitCursor);
867 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
869 if (d->cursor_.real_current_font.isRightToLeft()) {
870 if (d->intl_.keymap == Intl::PRIMARY)
871 d->intl_.keyMapSec();
873 if (d->intl_.keymap == Intl::SECONDARY)
874 d->intl_.keyMapPrim();
877 d->intl_.getTransManager().translateAndInsert(c, t, cur);
881 int BufferView::workWidth() const
887 void BufferView::recenter()
889 showCursor(d->cursor_, true, true);
893 void BufferView::showCursor()
895 showCursor(d->cursor_, false, true);
899 void BufferView::showCursor(DocIterator const & dit,
900 bool recenter, bool update)
902 if (scrollToCursor(dit, recenter) && update)
903 processUpdateFlags(Update::Force);
907 void BufferView::scrollToCursor()
909 if (scrollToCursor(d->cursor_, false))
910 processUpdateFlags(Update::Force);
914 bool BufferView::scrollToCursor(DocIterator const & dit, bool const recenter)
916 // We are not properly started yet, delay until resizing is
921 LYXERR(Debug::SCROLLING, "recentering!");
923 CursorSlice const & bot = dit.bottom();
924 TextMetrics & tm = d->text_metrics_[bot.text()];
926 pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
927 int bot_pit = bot.pit();
928 if (bot_pit > max_pit) {
929 // FIXME: Why does this happen?
930 LYXERR0("bottom pit is greater that max pit: "
931 << bot_pit << " > " << max_pit);
935 if (bot_pit == tm.first().first - 1)
936 tm.newParMetricsUp();
937 else if (bot_pit == tm.last().first + 1)
938 tm.newParMetricsDown();
940 if (tm.contains(bot_pit)) {
941 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
942 LBUFERR(!pm.rows().empty());
943 // FIXME: smooth scrolling doesn't work in mathed.
944 CursorSlice const & cs = dit.innerTextSlice();
945 int offset = coordOffset(dit).y_;
946 int ypos = pm.position() + offset;
947 Dimension const & row_dim =
948 pm.getRow(cs.pos(), dit.boundary()).dimension();
951 scrolled = scroll(ypos - height_/2);
953 // We try to visualize the whole row, if the row height is larger than
954 // the screen height, we scroll to a heuristic value of height_ / 4.
955 // FIXME: This heuristic value should be replaced by a recursive search
956 // for a row in the inset that can be visualized completely.
957 else if (row_dim.height() > height_) {
958 if (ypos < defaultRowHeight())
959 scrolled = scroll(ypos - height_ / 4);
960 else if (ypos > height_ - defaultRowHeight())
961 scrolled = scroll(ypos - 3 * height_ / 4);
964 // If the top part of the row falls of the screen, we scroll
965 // up to align the top of the row with the top of the screen.
966 else if (ypos - row_dim.ascent() < 0 && ypos < height_) {
967 int ynew = row_dim.ascent();
968 scrolled = scrollUp(ynew - ypos);
971 // If the bottom of the row falls of the screen, we scroll down.
972 else if (ypos + row_dim.descent() > height_ && ypos > 0) {
973 int ynew = height_ - row_dim.descent();
974 scrolled = scrollDown(ypos - ynew);
977 // else, nothing to do, the cursor is already visible so we just return.
978 return scrolled != 0;
981 // fix inline completion position
982 if (d->inlineCompletionPos_.fixIfBroken())
983 d->inlineCompletionPos_ = DocIterator();
985 tm.redoParagraph(bot_pit);
986 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
987 int offset = coordOffset(dit).y_;
989 d->anchor_pit_ = bot_pit;
990 CursorSlice const & cs = dit.innerTextSlice();
991 Dimension const & row_dim =
992 pm.getRow(cs.pos(), dit.boundary()).dimension();
995 d->anchor_ypos_ = height_/2;
996 else if (d->anchor_pit_ == 0)
997 d->anchor_ypos_ = offset + pm.ascent();
998 else if (d->anchor_pit_ == max_pit)
999 d->anchor_ypos_ = height_ - offset - row_dim.descent();
1000 else if (offset > height_)
1001 d->anchor_ypos_ = height_ - offset - defaultRowHeight();
1003 d->anchor_ypos_ = defaultRowHeight() * 2;
1009 void BufferView::makeDocumentClass()
1011 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1012 buffer_.params().makeDocumentClass();
1013 updateDocumentClass(olddc);
1017 void BufferView::updateDocumentClass(DocumentClassConstPtr olddc)
1019 message(_("Converting document to new document class..."));
1021 StableDocIterator backcur(d->cursor_);
1022 ErrorList & el = buffer_.errorList("Class Switch");
1023 cap::switchBetweenClasses(
1024 olddc, buffer_.params().documentClassPtr(),
1025 static_cast<InsetText &>(buffer_.inset()), el);
1027 setCursor(backcur.asDocIterator(&buffer_));
1029 buffer_.errors("Class Switch");
1033 /** Return the change status at cursor position, taking into account the
1034 * status at each level of the document iterator (a table in a deleted
1035 * footnote is deleted).
1036 * When \param outer is true, the top slice is not looked at.
1038 static Change::Type lookupChangeType(DocIterator const & dit, bool outer = false)
1040 size_t const depth = dit.depth() - (outer ? 1 : 0);
1042 for (size_t i = 0 ; i < depth ; ++i) {
1043 CursorSlice const & slice = dit[i];
1044 if (!slice.inset().inMathed()
1045 && slice.pos() < slice.paragraph().size()) {
1046 Change::Type const ch = slice.paragraph().lookupChange(slice.pos()).type;
1047 if (ch != Change::UNCHANGED)
1051 return Change::UNCHANGED;
1055 bool BufferView::getStatus(FuncRequest const & cmd, FuncStatus & flag)
1057 FuncCode const act = cmd.action();
1059 // Can we use a readonly buffer?
1060 if (buffer_.isReadonly()
1061 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1062 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1063 if (buffer_.hasReadonlyFlag())
1064 flag.message(from_utf8(N_("Document is read-only")));
1066 flag.message(from_utf8(N_("Document has been modified externally")));
1067 flag.setEnabled(false);
1071 // Are we in a DELETED change-tracking region?
1072 if (lookupChangeType(d->cursor_, true) == Change::DELETED
1073 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1074 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1075 flag.message(from_utf8(N_("This portion of the document is deleted.")));
1076 flag.setEnabled(false);
1080 Cursor & cur = d->cursor_;
1082 if (cur.getStatus(cmd, flag))
1087 // FIXME: This is a bit problematic because we don't check if this is
1088 // a document BufferView or not for these LFUNs. We probably have to
1089 // dispatch both to currentBufferView() and, if that fails,
1090 // to documentBufferView(); same as we do now for current Buffer and
1091 // document Buffer. Ideally those LFUN should go to Buffer as they
1092 // operate on the full Buffer and the cursor is only needed either for
1093 // an Undo record or to restore a cursor position. But we don't know
1094 // how to do that inside Buffer of course.
1095 case LFUN_BUFFER_PARAMS_APPLY:
1096 case LFUN_LAYOUT_MODULES_CLEAR:
1097 case LFUN_LAYOUT_MODULE_ADD:
1098 case LFUN_LAYOUT_RELOAD:
1099 case LFUN_TEXTCLASS_APPLY:
1100 case LFUN_TEXTCLASS_LOAD:
1101 flag.setEnabled(!buffer_.isReadonly());
1105 // We do not use the LyXAction flag for readonly because Undo sets the
1106 // buffer clean/dirty status by itself.
1107 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasUndoStack());
1110 // We do not use the LyXAction flag for readonly because Redo sets the
1111 // buffer clean/dirty status by itself.
1112 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasRedoStack());
1114 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
1115 case LFUN_FILE_INSERT_PLAINTEXT: {
1116 docstring const fname = cmd.argument();
1117 if (!FileName::isAbsolute(to_utf8(fname))) {
1118 flag.message(_("Absolute filename expected."));
1121 flag.setEnabled(cur.inTexted());
1124 case LFUN_FILE_INSERT:
1125 case LFUN_BOOKMARK_SAVE:
1126 // FIXME: Actually, these LFUNS should be moved to Text
1127 flag.setEnabled(cur.inTexted());
1130 case LFUN_FONT_STATE:
1131 case LFUN_LABEL_INSERT:
1132 case LFUN_INFO_INSERT:
1133 case LFUN_PARAGRAPH_GOTO:
1134 case LFUN_NOTE_NEXT:
1135 case LFUN_REFERENCE_NEXT:
1136 case LFUN_WORD_FIND:
1137 case LFUN_WORD_FIND_FORWARD:
1138 case LFUN_WORD_FIND_BACKWARD:
1139 case LFUN_WORD_REPLACE:
1142 case LFUN_MARK_TOGGLE:
1143 case LFUN_SCREEN_RECENTER:
1144 case LFUN_SCREEN_SHOW_CURSOR:
1145 case LFUN_BIBTEX_DATABASE_ADD:
1146 case LFUN_BIBTEX_DATABASE_DEL:
1147 case LFUN_STATISTICS:
1148 case LFUN_KEYMAP_OFF:
1149 case LFUN_KEYMAP_PRIMARY:
1150 case LFUN_KEYMAP_SECONDARY:
1151 case LFUN_KEYMAP_TOGGLE:
1152 case LFUN_INSET_SELECT_ALL:
1153 flag.setEnabled(true);
1156 case LFUN_GRAPHICS_UNIFY:
1157 flag.setEnabled(cur.countInsetsInSelection(GRAPHICS_CODE)>1);
1160 case LFUN_WORD_FINDADV: {
1161 FindAndReplaceOptions opt;
1162 istringstream iss(to_utf8(cmd.argument()));
1164 flag.setEnabled(opt.repl_buf_name.empty()
1165 || !buffer_.isReadonly());
1169 case LFUN_LABEL_GOTO:
1170 flag.setEnabled(!cmd.argument().empty()
1171 || getInsetByCode<InsetRef>(cur, REF_CODE));
1174 case LFUN_CHANGES_MERGE:
1175 case LFUN_CHANGE_NEXT:
1176 case LFUN_CHANGE_PREVIOUS:
1177 case LFUN_ALL_CHANGES_ACCEPT:
1178 case LFUN_ALL_CHANGES_REJECT:
1179 flag.setEnabled(buffer_.areChangesPresent());
1182 case LFUN_SCREEN_UP:
1183 case LFUN_SCREEN_DOWN:
1185 case LFUN_SCREEN_UP_SELECT:
1186 case LFUN_SCREEN_DOWN_SELECT:
1187 case LFUN_INSET_FORALL:
1188 flag.setEnabled(true);
1191 case LFUN_LAYOUT_TABULAR:
1192 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
1196 flag.setEnabled(!cur.inset().forcePlainLayout(cur.idx()));
1199 case LFUN_LAYOUT_PARAGRAPH:
1200 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
1203 case LFUN_BRANCH_ADD_INSERT:
1204 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1207 case LFUN_DIALOG_SHOW_NEW_INSET:
1208 // FIXME: this is wrong, but I do not understand the
1210 if (cur.inset().lyxCode() == CAPTION_CODE)
1211 return cur.inset().getStatus(cur, cmd, flag);
1212 // FIXME we should consider passthru paragraphs too.
1213 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1216 case LFUN_CITATION_INSERT: {
1217 FuncRequest fr(LFUN_INSET_INSERT, "citation");
1218 // FIXME: This could turn in a recursive hell.
1219 // Shouldn't we use Buffer::getStatus() instead?
1220 flag.setEnabled(lyx::getStatus(fr).enabled());
1223 case LFUN_INSET_APPLY: {
1224 string const name = cmd.getArg(0);
1225 Inset * inset = editedInset(name);
1227 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1228 if (!inset->getStatus(cur, fr, flag)) {
1229 // Every inset is supposed to handle this
1230 LASSERT(false, break);
1233 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1234 flag = lyx::getStatus(fr);
1247 Inset * BufferView::editedInset(string const & name) const
1249 map<string, Inset *>::const_iterator it = d->edited_insets_.find(name);
1250 return it == d->edited_insets_.end() ? 0 : it->second;
1254 void BufferView::editInset(string const & name, Inset * inset)
1256 d->edited_insets_[name] = inset;
1260 void BufferView::dispatch(FuncRequest const & cmd, DispatchResult & dr)
1262 LYXERR(Debug::ACTION, "BufferView::dispatch: cmd: " << cmd);
1264 string const argument = to_utf8(cmd.argument());
1265 Cursor & cur = d->cursor_;
1268 // Don't dispatch function that does not apply to internal buffers.
1269 if (buffer_.isInternal()
1270 && lyxaction.funcHasFlag(cmd.action(), LyXAction::NoInternal))
1273 // We'll set this back to false if need be.
1274 bool dispatched = true;
1275 buffer_.undo().beginUndoGroup();
1277 FuncCode const act = cmd.action();
1280 case LFUN_BUFFER_PARAMS_APPLY: {
1281 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1282 cur.recordUndoBufferParams();
1283 istringstream ss(to_utf8(cmd.argument()));
1286 int const unknown_tokens = buffer_.readHeader(lex);
1287 if (unknown_tokens != 0) {
1288 LYXERR0("Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1289 << unknown_tokens << " unknown token"
1290 << (unknown_tokens == 1 ? "" : "s"));
1292 updateDocumentClass(olddc);
1294 // We are most certainly here because of a change in the document
1295 // It is then better to make sure that all dialogs are in sync with
1296 // current document settings.
1297 dr.screenUpdate(Update::Force | Update::FitCursor);
1298 dr.forceBufferUpdate();
1302 case LFUN_LAYOUT_MODULES_CLEAR: {
1303 // FIXME: this modifies the document in cap::switchBetweenClasses
1304 // without calling recordUndo. Fix this before using
1305 // recordUndoBufferParams().
1306 cur.recordUndoFullBuffer();
1307 buffer_.params().clearLayoutModules();
1308 makeDocumentClass();
1309 dr.screenUpdate(Update::Force);
1310 dr.forceBufferUpdate();
1314 case LFUN_LAYOUT_MODULE_ADD: {
1315 BufferParams const & params = buffer_.params();
1316 if (!params.layoutModuleCanBeAdded(argument)) {
1317 LYXERR0("Module `" << argument <<
1318 "' cannot be added due to failed requirements or "
1319 "conflicts with installed modules.");
1322 // FIXME: this modifies the document in cap::switchBetweenClasses
1323 // without calling recordUndo. Fix this before using
1324 // recordUndoBufferParams().
1325 cur.recordUndoFullBuffer();
1326 buffer_.params().addLayoutModule(argument);
1327 makeDocumentClass();
1328 dr.screenUpdate(Update::Force);
1329 dr.forceBufferUpdate();
1333 case LFUN_TEXTCLASS_APPLY: {
1334 // since this shortcircuits, the second call is made only if
1336 bool const success =
1337 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1338 LayoutFileList::get().load(argument, buffer_.filePath());
1340 docstring s = bformat(_("The document class `%1$s' "
1341 "could not be loaded."), from_utf8(argument));
1342 frontend::Alert::error(_("Could not load class"), s);
1346 LayoutFile const * old_layout = buffer_.params().baseClass();
1347 LayoutFile const * new_layout = &(LayoutFileList::get()[argument]);
1349 if (old_layout == new_layout)
1353 // Save the old, possibly modular, layout for use in conversion.
1354 // FIXME: this modifies the document in cap::switchBetweenClasses
1355 // without calling recordUndo. Fix this before using
1356 // recordUndoBufferParams().
1357 cur.recordUndoFullBuffer();
1358 buffer_.params().setBaseClass(argument);
1359 makeDocumentClass();
1360 dr.screenUpdate(Update::Force);
1361 dr.forceBufferUpdate();
1365 case LFUN_TEXTCLASS_LOAD: {
1366 // since this shortcircuits, the second call is made only if
1368 bool const success =
1369 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1370 LayoutFileList::get().load(argument, buffer_.filePath());
1372 docstring s = bformat(_("The document class `%1$s' "
1373 "could not be loaded."), from_utf8(argument));
1374 frontend::Alert::error(_("Could not load class"), s);
1379 case LFUN_LAYOUT_RELOAD: {
1380 LayoutFileIndex bc = buffer_.params().baseClassID();
1381 LayoutFileList::get().reset(bc);
1382 buffer_.params().setBaseClass(bc);
1383 makeDocumentClass();
1384 dr.screenUpdate(Update::Force);
1385 dr.forceBufferUpdate();
1390 dr.setMessage(_("Undo"));
1391 cur.clearSelection();
1392 // We need to find out if the bibliography information
1393 // has changed. See bug #11055.
1394 // So these should not be references...
1395 LayoutModuleList const engines = buffer().params().citeEngine();
1396 CiteEngineType const enginetype = buffer().params().citeEngineType();
1397 if (!cur.textUndo())
1398 dr.setMessage(_("No further undo information"));
1400 dr.screenUpdate(Update::Force | Update::FitCursor);
1401 dr.forceBufferUpdate();
1402 if (buffer().params().citeEngine() != engines ||
1403 buffer().params().citeEngineType() != enginetype)
1404 buffer().invalidateCiteLabels();
1410 dr.setMessage(_("Redo"));
1411 cur.clearSelection();
1412 // We need to find out if the bibliography information
1413 // has changed. See bug #11055.
1414 // So these should not be references...
1415 LayoutModuleList const engines = buffer().params().citeEngine();
1416 CiteEngineType const enginetype = buffer().params().citeEngineType();
1417 if (!cur.textRedo())
1418 dr.setMessage(_("No further redo information"));
1420 dr.screenUpdate(Update::Force | Update::FitCursor);
1421 dr.forceBufferUpdate();
1422 if (buffer().params().citeEngine() != engines ||
1423 buffer().params().citeEngineType() != enginetype)
1424 buffer().invalidateCiteLabels();
1429 case LFUN_FONT_STATE:
1430 dr.setMessage(cur.currentState(false));
1433 case LFUN_BOOKMARK_SAVE:
1434 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1437 case LFUN_LABEL_GOTO: {
1438 docstring label = cmd.argument();
1439 if (label.empty()) {
1441 getInsetByCode<InsetRef>(cur, REF_CODE);
1443 label = inset->getParam("reference");
1444 // persistent=false: use temp_bookmark
1448 if (!label.empty()) {
1450 // at the moment, this is redundant, since gotoLabel will
1451 // eventually call LFUN_PARAGRAPH_GOTO, but it seems best
1453 dr.screenUpdate(Update::Force | Update::FitCursor);
1458 case LFUN_PARAGRAPH_GOTO: {
1459 int const id = convert<int>(cmd.getArg(0));
1460 pos_type const pos = convert<int>(cmd.getArg(1));
1463 string const str_id_end = cmd.getArg(2);
1464 string const str_pos_end = cmd.getArg(3);
1466 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1467 b = theBufferList().next(b)) {
1470 curs.setCursor(b->getParFromID(id));
1472 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1476 LYXERR(Debug::INFO, "Paragraph " << curs.paragraph().id()
1477 << " found in buffer `"
1478 << b->absFileName() << "'.");
1480 if (b == &buffer_) {
1482 if (str_id_end.empty() || str_pos_end.empty()) {
1485 mouseSetCursor(curs);
1488 int const id_end = convert<int>(str_id_end);
1489 pos_type const pos_end = convert<int>(str_pos_end);
1490 success = setCursorFromEntries({id, pos},
1494 dr.screenUpdate(Update::Force | Update::FitCursor);
1496 // Switch to other buffer view and resend cmd
1497 lyx::dispatch(FuncRequest(
1498 LFUN_BUFFER_SWITCH, b->absFileName()));
1506 case LFUN_NOTE_NEXT:
1507 gotoInset(this, NOTE_CODE, false);
1510 case LFUN_REFERENCE_NEXT: {
1511 vector<InsetCode> tmp;
1512 tmp.push_back(LABEL_CODE);
1513 tmp.push_back(REF_CODE);
1514 gotoInset(this, tmp, true);
1518 case LFUN_CHANGE_NEXT:
1519 findNextChange(this);
1520 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1521 dr.screenUpdate(Update::Force | Update::FitCursor);
1524 case LFUN_CHANGE_PREVIOUS:
1525 findPreviousChange(this);
1526 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1527 dr.screenUpdate(Update::Force | Update::FitCursor);
1530 case LFUN_CHANGES_MERGE:
1531 if (findNextChange(this) || findPreviousChange(this)) {
1532 dr.screenUpdate(Update::Force | Update::FitCursor);
1533 dr.forceBufferUpdate();
1534 showDialog("changes");
1538 case LFUN_ALL_CHANGES_ACCEPT:
1539 // select complete document
1541 cur.selHandle(true);
1542 buffer_.text().cursorBottom(cur);
1543 // accept everything in a single step to support atomic undo
1544 buffer_.text().acceptOrRejectChanges(cur, Text::ACCEPT);
1546 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1547 dr.screenUpdate(Update::Force | Update::FitCursor);
1548 dr.forceBufferUpdate();
1551 case LFUN_ALL_CHANGES_REJECT:
1552 // select complete document
1554 cur.selHandle(true);
1555 buffer_.text().cursorBottom(cur);
1556 // reject everything in a single step to support atomic undo
1557 // Note: reject does not work recursively; the user may have to repeat the operation
1558 buffer_.text().acceptOrRejectChanges(cur, Text::REJECT);
1560 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1561 dr.screenUpdate(Update::Force | Update::FitCursor);
1562 dr.forceBufferUpdate();
1565 case LFUN_WORD_FIND_FORWARD:
1566 case LFUN_WORD_FIND_BACKWARD: {
1568 // Would it maybe be better if this variable were view specific anyway?
1569 static docstring last_search;
1570 docstring searched_string;
1572 if (!cmd.argument().empty()) {
1573 last_search = cmd.argument();
1574 searched_string = cmd.argument();
1576 searched_string = last_search;
1579 if (searched_string.empty())
1582 bool const fw = act == LFUN_WORD_FIND_FORWARD;
1583 docstring const data =
1584 find2string(searched_string, true, false, fw);
1585 bool found = lyxfind(this, FuncRequest(LFUN_WORD_FIND, data));
1587 dr.screenUpdate(Update::Force | Update::FitCursor);
1591 case LFUN_WORD_FIND: {
1592 FuncRequest req = cmd;
1593 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1594 req = d->search_request_cache_;
1595 if (req.argument().empty()) {
1596 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, "findreplace"));
1599 if (lyxfind(this, req))
1600 dr.screenUpdate(Update::Force | Update::FitCursor);
1602 d->search_request_cache_ = req;
1606 case LFUN_WORD_REPLACE: {
1607 bool has_deleted = false;
1608 if (cur.selection()) {
1609 DocIterator beg = cur.selectionBegin();
1610 DocIterator end = cur.selectionEnd();
1611 if (beg.pit() == end.pit()) {
1612 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1613 if (!cur.inMathed() && cur.paragraph().isDeleted(p)) {
1620 if (lyxreplace(this, cmd, has_deleted)) {
1621 dr.forceBufferUpdate();
1622 dr.screenUpdate(Update::Force | Update::FitCursor);
1627 case LFUN_WORD_FINDADV: {
1628 FindAndReplaceOptions opt;
1629 istringstream iss(to_utf8(cmd.argument()));
1631 if (findAdv(this, opt)) {
1632 dr.screenUpdate(Update::Force | Update::FitCursor);
1643 cur.clearSelection();
1644 dr.setMessage(from_utf8(N_("Mark off")));
1648 cur.clearSelection();
1650 dr.setMessage(from_utf8(N_("Mark on")));
1653 case LFUN_MARK_TOGGLE:
1654 cur.selection(false);
1657 dr.setMessage(from_utf8(N_("Mark removed")));
1660 dr.setMessage(from_utf8(N_("Mark set")));
1665 case LFUN_SCREEN_SHOW_CURSOR:
1669 case LFUN_SCREEN_RECENTER:
1673 case LFUN_BIBTEX_DATABASE_ADD: {
1674 Cursor tmpcur = cur;
1675 findInset(tmpcur, BIBTEX_CODE, false);
1676 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1679 if (inset->addDatabase(cmd.argument()))
1680 dr.forceBufferUpdate();
1685 case LFUN_BIBTEX_DATABASE_DEL: {
1686 Cursor tmpcur = cur;
1687 findInset(tmpcur, BIBTEX_CODE, false);
1688 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1691 if (inset->delDatabase(cmd.argument()))
1692 dr.forceBufferUpdate();
1697 case LFUN_GRAPHICS_UNIFY: {
1699 cur.recordUndoFullBuffer();
1701 DocIterator from, to;
1702 from = cur.selectionBegin();
1703 to = cur.selectionEnd();
1705 string const newId = cmd.getArg(0);
1706 bool fetchId = newId.empty(); //if we wait for groupId from first graphics inset
1708 InsetGraphicsParams grp_par;
1710 InsetGraphics::string2params(graphics::getGroupParams(buffer_, newId), buffer_, grp_par);
1712 if (!from.nextInset()) //move to closest inset
1713 from.forwardInset();
1715 while (!from.empty() && from < to) {
1716 Inset * inset = from.nextInset();
1719 InsetGraphics * ig = inset->asInsetGraphics();
1721 InsetGraphicsParams inspar = ig->getParams();
1726 grp_par.filename = inspar.filename;
1727 ig->setParams(grp_par);
1730 from.forwardInset();
1732 dr.screenUpdate(Update::Force); //needed if triggered from context menu
1736 case LFUN_STATISTICS: {
1737 DocIterator from, to;
1738 if (cur.selection()) {
1739 from = cur.selectionBegin();
1740 to = cur.selectionEnd();
1742 from = doc_iterator_begin(&buffer_);
1743 to = doc_iterator_end(&buffer_);
1745 buffer_.updateStatistics(from, to);
1746 int const words = buffer_.wordCount();
1747 int const chars = buffer_.charCount(false);
1748 int const chars_blanks = buffer_.charCount(true);
1750 if (cur.selection())
1751 message = _("Statistics for the selection:");
1753 message = _("Statistics for the document:");
1756 message += bformat(_("%1$d words"), words);
1758 message += _("One word");
1760 if (chars_blanks != 1)
1761 message += bformat(_("%1$d characters (including blanks)"),
1764 message += _("One character (including blanks)");
1767 message += bformat(_("%1$d characters (excluding blanks)"),
1770 message += _("One character (excluding blanks)");
1772 Alert::information(_("Statistics"), message);
1776 case LFUN_SCREEN_UP:
1777 case LFUN_SCREEN_DOWN: {
1778 Point p = getPos(cur);
1779 // This code has been commented out to enable to scroll down a
1780 // document, even if there are large insets in it (see bug #5465).
1781 /*if (p.y_ < 0 || p.y_ > height_) {
1782 // The cursor is off-screen so recenter before proceeding.
1786 int const scrolled = scroll(act == LFUN_SCREEN_UP
1787 ? -height_ : height_);
1788 if (act == LFUN_SCREEN_UP && scrolled > -height_)
1790 if (act == LFUN_SCREEN_DOWN && scrolled < height_)
1791 p = Point(width_, height_);
1792 bool const in_texted = cur.inTexted();
1793 cur.setCursor(doc_iterator_begin(cur.buffer()));
1794 cur.selHandle(false);
1795 // Force an immediate computation of metrics because we need it below
1796 processUpdateFlags(Update::Force);
1798 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_,
1799 true, act == LFUN_SCREEN_UP);
1800 //FIXME: what to do with cur.x_target()?
1801 bool update = in_texted && cur.bv().checkDepm(cur, old);
1804 if (update || cur.mark())
1805 dr.screenUpdate(Update::Force | Update::FitCursor);
1807 dr.forceBufferUpdate();
1812 string const scroll_type = cmd.getArg(0);
1813 int scroll_step = 0;
1814 if (scroll_type == "line")
1815 scroll_step = d->scrollbarParameters_.single_step;
1816 else if (scroll_type == "page")
1817 scroll_step = d->scrollbarParameters_.page_step;
1820 string const scroll_quantity = cmd.getArg(1);
1821 if (scroll_quantity == "up")
1822 scrollUp(scroll_step);
1823 else if (scroll_quantity == "down")
1824 scrollDown(scroll_step);
1826 int const scroll_value = convert<int>(scroll_quantity);
1828 scroll(scroll_step * scroll_value);
1830 dr.screenUpdate(Update::ForceDraw);
1831 dr.forceBufferUpdate();
1835 case LFUN_SCREEN_UP_SELECT: {
1836 // FIXME: why is the algorithm different from LFUN_SCREEN_UP?
1837 cur.selHandle(true);
1838 if (isTopScreen()) {
1839 lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1843 int y = getPos(cur).y_;
1844 int const ymin = y - height_ + defaultRowHeight();
1845 while (y > ymin && cur.up())
1849 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1853 case LFUN_SCREEN_DOWN_SELECT: {
1854 // FIXME: why is the algorithm different from LFUN_SCREEN_DOWN?
1855 cur.selHandle(true);
1856 if (isBottomScreen()) {
1857 lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1861 int y = getPos(cur).y_;
1862 int const ymax = y + height_ - defaultRowHeight();
1863 while (y < ymax && cur.down())
1867 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1872 case LFUN_INSET_SELECT_ALL: {
1873 // true if all cells are selected
1874 bool const all_selected = cur.depth() > 1
1875 && cur.selBegin().at_begin()
1876 && cur.selEnd().at_end();
1877 // true if some cells are selected
1878 bool const cells_selected = cur.depth() > 1
1879 && cur.selBegin().at_cell_begin()
1880 && cur.selEnd().at_cell_end();
1881 if (all_selected || (cells_selected && !cur.inset().isTable())) {
1882 // All the contents of the inset if selected, or only at
1883 // least one cell but inset is not a table.
1884 // Select the inset from outside.
1887 cur.selection(true);
1889 } else if (cells_selected) {
1890 // At least one complete cell is selected and inset is a table.
1895 cur.selection(true);
1896 cur.idx() = cur.lastidx();
1897 cur.pos() = cur.lastpos();
1899 // select current cell
1903 cur.selection(true);
1904 cur.pit() = cur.lastpit();
1905 cur.pos() = cur.lastpos();
1907 cur.setCurrentFont();
1908 dr.screenUpdate(Update::Force);
1913 case LFUN_UNICODE_INSERT: {
1914 if (cmd.argument().empty())
1917 FuncCode code = cur.inset().currentMode() == Inset::MATH_MODE ?
1918 LFUN_MATH_INSERT : LFUN_SELF_INSERT;
1921 docstring const arg = from_utf8(cmd.getArg(i));
1925 LYXERR0("Not a hexstring: " << arg);
1929 char_type c = hexToInt(arg);
1930 if (c >= 32 && c < 0x10ffff) {
1931 LYXERR(Debug::KEY, "Inserting c: " << c);
1932 lyx::dispatch(FuncRequest(code, docstring(1, c)));
1940 // This would be in Buffer class if only Cursor did not
1941 // require a bufferview
1942 case LFUN_INSET_FORALL: {
1943 docstring const name = from_utf8(cmd.getArg(0));
1944 string const commandstr = cmd.getLongArg(1);
1945 FuncRequest const fr = lyxaction.lookupFunc(commandstr);
1947 // an arbitrary number to limit number of iterations
1948 const int max_iter = 100000;
1950 Cursor & curs = d->cursor_;
1951 Cursor const savecur = curs;
1953 if (!curs.nextInset())
1954 curs.forwardInset();
1955 curs.beginUndoGroup();
1956 while(curs && iterations < max_iter) {
1957 Inset * const ins = curs.nextInset();
1960 docstring insname = ins->layoutName();
1961 while (!insname.empty()) {
1962 if (insname == name || name == from_utf8("*")) {
1964 lyx::dispatch(fr, dr);
1968 size_t const i = insname.rfind(':');
1969 if (i == string::npos)
1971 insname = insname.substr(0, i);
1973 // if we did not delete the inset, skip it
1974 if (!curs.nextInset() || curs.nextInset() == ins)
1975 curs.forwardInset();
1979 /** This is a dummy undo record only to remember the cursor
1980 * that has just been set; this will be used on a redo action
1981 * (see ticket #10097)
1983 * FIXME: a better fix would be to have a way to set the
1984 * cursor value directly, but I am not sure it is worth it.
1987 curs.endUndoGroup();
1988 dr.screenUpdate(Update::Force);
1989 dr.forceBufferUpdate();
1991 if (iterations >= max_iter) {
1993 dr.setMessage(bformat(_("`inset-forall' interrupted because number of actions is larger than %1$d"), max_iter));
1995 dr.setMessage(bformat(_("Applied \"%1$s\" to %2$d insets"), from_utf8(commandstr), iterations));
2000 case LFUN_BRANCH_ADD_INSERT: {
2001 docstring branch_name = from_utf8(cmd.getArg(0));
2002 if (branch_name.empty())
2003 if (!Alert::askForText(branch_name, _("Branch name")) ||
2004 branch_name.empty())
2007 DispatchResult drtmp;
2008 buffer_.dispatch(FuncRequest(LFUN_BRANCH_ADD, branch_name), drtmp);
2009 if (drtmp.error()) {
2010 Alert::warning(_("Branch already exists"), drtmp.message());
2013 docstring const sep = buffer_.params().branchlist().separator();
2014 for (docstring const & branch : getVectorFromString(branch_name, sep))
2015 lyx::dispatch(FuncRequest(LFUN_BRANCH_INSERT, branch));
2019 case LFUN_KEYMAP_OFF:
2020 getIntl().keyMapOn(false);
2023 case LFUN_KEYMAP_PRIMARY:
2024 getIntl().keyMapPrim();
2027 case LFUN_KEYMAP_SECONDARY:
2028 getIntl().keyMapSec();
2031 case LFUN_KEYMAP_TOGGLE:
2032 getIntl().toggleKeyMap();
2035 case LFUN_DIALOG_SHOW_NEW_INSET: {
2036 string const name = cmd.getArg(0);
2037 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
2038 if (decodeInsetParam(name, data, buffer_))
2039 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
2041 lyxerr << "Inset type '" << name <<
2042 "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" << endl;
2046 case LFUN_CITATION_INSERT: {
2047 if (argument.empty()) {
2048 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
2051 // we can have one optional argument, delimited by '|'
2052 // citation-insert <key>|<text_before>
2053 // this should be enhanced to also support text_after
2054 // and citation style
2055 string arg = argument;
2057 if (contains(argument, "|")) {
2058 arg = token(argument, '|', 0);
2059 opt1 = token(argument, '|', 1);
2062 // if our cursor is directly in front of or behind a citation inset,
2063 // we will instead add the new key to it.
2064 Inset * inset = cur.nextInset();
2065 if (!inset || inset->lyxCode() != CITE_CODE)
2066 inset = cur.prevInset();
2067 if (inset && inset->lyxCode() == CITE_CODE) {
2068 InsetCitation * icite = static_cast<InsetCitation *>(inset);
2069 if (icite->addKey(arg)) {
2070 dr.forceBufferUpdate();
2071 dr.screenUpdate(Update::FitCursor | Update::SinglePar);
2073 LYXERR0("Discarding optional argument to citation-insert.");
2078 InsetCommandParams icp(CITE_CODE);
2079 icp["key"] = from_utf8(arg);
2081 icp["before"] = from_utf8(opt1);
2083 from_ascii(InsetCitation::last_literal ? "true" : "false");
2084 string icstr = InsetCommand::params2string(icp);
2085 FuncRequest fr(LFUN_INSET_INSERT, icstr);
2090 case LFUN_INSET_APPLY: {
2091 string const name = cmd.getArg(0);
2092 Inset * inset = editedInset(name);
2094 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
2098 // put cursor in front of inset.
2099 if (!setCursorFromInset(inset)) {
2100 LASSERT(false, break);
2103 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
2104 inset->dispatch(cur, fr);
2105 dr.screenUpdate(cur.result().screenUpdate());
2106 if (cur.result().needBufferUpdate())
2107 dr.forceBufferUpdate();
2112 // The change of language of buffer belongs to the Buffer class.
2113 // We have to do it here because we need a cursor for Undo.
2114 // When Undo::recordUndoBufferParams() is implemented someday
2115 // LFUN_BUFFER_LANGUAGE should be handled by the Buffer class.
2116 case LFUN_BUFFER_LANGUAGE: {
2117 Language const * oldL = buffer_.params().language;
2118 Language const * newL = languages.getLanguage(argument);
2119 if (!newL || oldL == newL)
2121 if (oldL->rightToLeft() == newL->rightToLeft()) {
2122 cur.recordUndoFullBuffer();
2123 buffer_.changeLanguage(oldL, newL);
2124 cur.setCurrentFont();
2125 dr.forceBufferUpdate();
2130 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
2131 case LFUN_FILE_INSERT_PLAINTEXT: {
2132 bool const as_paragraph = (act == LFUN_FILE_INSERT_PLAINTEXT_PARA);
2133 string const fname = to_utf8(cmd.argument());
2134 if (!FileName::isAbsolute(fname))
2135 dr.setMessage(_("Absolute filename expected."));
2137 insertPlaintextFile(FileName(fname), as_paragraph);
2142 // OK, so try the Buffer itself...
2143 buffer_.dispatch(cmd, dr);
2144 dispatched = dr.dispatched();
2148 buffer_.undo().endUndoGroup();
2149 dr.dispatched(dispatched);
2151 // NOTE: The code below is copied from Cursor::dispatch. If you
2152 // need to modify this, please update the other one too.
2154 // notify insets we just entered/left
2155 if (cursor() != old) {
2156 old.beginUndoGroup();
2158 bool badcursor = notifyCursorLeavesOrEnters(old, cursor());
2160 cursor().fixIfBroken();
2161 resetInlineCompletionPos();
2168 docstring const BufferView::requestSelection()
2170 Cursor & cur = d->cursor_;
2172 LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
2173 if (!cur.selection()) {
2174 d->xsel_cache_.set = false;
2178 LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
2179 if (!d->xsel_cache_.set ||
2180 cur.top() != d->xsel_cache_.cursor ||
2181 cur.realAnchor().top() != d->xsel_cache_.anchor)
2183 d->xsel_cache_.cursor = cur.top();
2184 d->xsel_cache_.anchor = cur.realAnchor().top();
2185 d->xsel_cache_.set = cur.selection();
2186 return cur.selectionAsString(false);
2192 void BufferView::clearSelection()
2194 d->cursor_.clearSelection();
2195 // Clear the selection buffer. Otherwise a subsequent
2196 // middle-mouse-button paste would use the selection buffer,
2197 // not the more current external selection.
2198 cap::clearSelection();
2199 d->xsel_cache_.set = false;
2200 // The buffer did not really change, but this causes the
2201 // redraw we need because we cleared the selection above.
2202 buffer_.changed(false);
2206 void BufferView::resize(int width, int height)
2208 // Update from work area
2212 // Clear the paragraph height cache.
2213 d->par_height_.clear();
2214 // Redo the metrics.
2219 Inset const * BufferView::getCoveringInset(Text const & text,
2222 TextMetrics & tm = d->text_metrics_[&text];
2223 Inset * inset = tm.checkInsetHit(x, y);
2227 if (!inset->descendable(*this))
2228 // No need to go further down if the inset is not
2232 size_t cell_number = inset->nargs();
2233 // Check all the inner cell.
2234 for (size_t i = 0; i != cell_number; ++i) {
2235 Text const * inner_text = inset->getText(i);
2238 Inset const * inset_deeper =
2239 getCoveringInset(*inner_text, x, y);
2241 return inset_deeper;
2249 void BufferView::updateHoveredInset() const
2251 // Get inset under mouse, if there is one.
2252 int const x = d->mouse_position_cache_.x_;
2253 int const y = d->mouse_position_cache_.y_;
2254 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
2256 d->clickable_inset_ = covering_inset && covering_inset->clickable(*this, x, y);
2258 if (covering_inset == d->last_inset_)
2259 // Same inset, no need to do anything...
2262 bool need_redraw = false;
2263 if (d->last_inset_) {
2264 // Remove the hint on the last hovered inset (if any).
2265 need_redraw |= d->last_inset_->setMouseHover(this, false);
2269 if (covering_inset && covering_inset->setMouseHover(this, true)) {
2271 // Only the insets that accept the hover state, do
2272 // clear the last_inset_, so only set the last_inset_
2273 // member if the hovered setting is accepted.
2274 d->last_inset_ = covering_inset;
2278 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
2279 << d->mouse_position_cache_.x_ << ", "
2280 << d->mouse_position_cache_.y_ << ")");
2282 d->update_strategy_ = DecorationUpdate;
2284 // This event (moving without mouse click) is not passed further.
2285 // This should be changed if it is further utilized.
2286 buffer_.changed(false);
2291 void BufferView::clearLastInset(Inset * inset) const
2293 if (d->last_inset_ != inset) {
2294 LYXERR0("Wrong last_inset!");
2301 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
2303 //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
2305 // This is only called for mouse related events including
2306 // LFUN_FILE_OPEN generated by drag-and-drop.
2307 FuncRequest cmd = cmd0;
2309 Cursor old = cursor();
2311 cur.push(buffer_.inset());
2312 cur.selection(d->cursor_.selection());
2314 // Either the inset under the cursor or the
2315 // surrounding Text will handle this event.
2317 // make sure we stay within the screen...
2318 cmd.set_y(min(max(cmd.y(), -1), height_));
2320 d->mouse_position_cache_.x_ = cmd.x();
2321 d->mouse_position_cache_.y_ = cmd.y();
2323 if (cmd.action() == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
2324 updateHoveredInset();
2328 // Build temporary cursor.
2329 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x(), cmd.y());
2331 // If inset is not editable, cur.pos() might point behind the
2332 // inset (depending on cmd.x(), cmd.y()). This is needed for
2333 // editing to fix bug 9628, but e.g. the context menu needs a
2334 // cursor in front of the inset.
2335 if ((inset->hasSettings() || !inset->contextMenuName().empty()
2336 || inset->lyxCode() == SEPARATOR_CODE) &&
2337 cur.nextInset() != inset && cur.prevInset() == inset)
2339 } else if (cur.inTexted() && cur.pos()
2340 && cur.paragraph().isEnvSeparator(cur.pos() - 1)) {
2341 // Always place cursor in front of a separator inset.
2345 // Put anchor at the same position.
2348 cur.beginUndoGroup();
2350 // Try to dispatch to an non-editable inset near this position
2351 // via the temp cursor. If the inset wishes to change the real
2352 // cursor it has to do so explicitly by using
2353 // cur.bv().cursor() = cur; (or similar)
2355 inset->dispatch(cur, cmd);
2357 // Now dispatch to the temporary cursor. If the real cursor should
2358 // be modified, the inset's dispatch has to do so explicitly.
2359 if (!inset || !cur.result().dispatched())
2362 // Notify left insets
2364 bool badcursor = old.fixIfBroken() | cur.fixIfBroken();
2365 badcursor |= notifyCursorLeavesOrEnters(old, cur);
2367 cursor().fixIfBroken();
2372 // Do we have a selection?
2373 theSelection().haveSelection(cursor().selection());
2375 if (cur.needBufferUpdate()) {
2376 cur.clearBufferUpdate();
2377 buffer().updateBuffer();
2380 // If the command has been dispatched,
2381 if (cur.result().dispatched() || cur.result().screenUpdate())
2382 processUpdateFlags(cur.result().screenUpdate());
2386 int BufferView::minVisiblePart()
2388 return 2 * defaultRowHeight();
2392 int BufferView::scroll(int y)
2395 return scrollDown(y);
2397 return scrollUp(-y);
2402 int BufferView::scrollDown(int offset)
2404 Text * text = &buffer_.text();
2405 TextMetrics & tm = d->text_metrics_[text];
2406 int const ymax = height_ + offset;
2408 pair<pit_type, ParagraphMetrics const *> last = tm.last();
2409 int bottom_pos = last.second->position() + last.second->descent();
2410 if (lyxrc.scroll_below_document)
2411 bottom_pos += height_ - minVisiblePart();
2412 if (last.first + 1 == int(text->paragraphs().size())) {
2413 if (bottom_pos <= height_)
2415 offset = min(offset, bottom_pos - height_);
2418 if (bottom_pos > ymax)
2420 tm.newParMetricsDown();
2422 d->anchor_ypos_ -= offset;
2427 int BufferView::scrollUp(int offset)
2429 Text * text = &buffer_.text();
2430 TextMetrics & tm = d->text_metrics_[text];
2431 int ymin = - offset;
2433 pair<pit_type, ParagraphMetrics const *> first = tm.first();
2434 int top_pos = first.second->position() - first.second->ascent();
2435 if (first.first == 0) {
2438 offset = min(offset, - top_pos);
2443 tm.newParMetricsUp();
2445 d->anchor_ypos_ += offset;
2450 bool BufferView::setCursorFromRow(int row)
2452 TexRow::TextEntry start, end;
2453 tie(start,end) = buffer_.texrow().getEntriesFromRow(row);
2454 LYXERR(Debug::LATEX,
2455 "setCursorFromRow: for row " << row << ", TexRow has found "
2456 "start (id=" << start.id << ",pos=" << start.pos << "), "
2457 "end (id=" << end.id << ",pos=" << end.pos << ")");
2458 return setCursorFromEntries(start, end);
2462 bool BufferView::setCursorFromEntries(TexRow::TextEntry start,
2463 TexRow::TextEntry end)
2465 DocIterator dit_start, dit_end;
2466 tie(dit_start,dit_end) =
2467 TexRow::getDocIteratorsFromEntries(start, end, buffer_);
2470 // Setting selection start
2471 d->cursor_.clearSelection();
2472 setCursor(dit_start);
2473 // Setting selection end
2475 d->cursor_.resetAnchor();
2476 setCursorSelectionTo(dit_end);
2482 bool BufferView::setCursorFromInset(Inset const * inset)
2484 // are we already there?
2485 if (cursor().nextInset() == inset)
2488 // Inset is not at cursor position. Find it in the document.
2491 while (cur && cur.nextInset() != inset)
2502 void BufferView::gotoLabel(docstring const & label)
2504 for (Buffer const * buf : buffer().allRelatives()) {
2506 for (TocItem const & item : *buf->tocBackend().toc("label")) {
2507 if (label == item.str()) {
2508 lyx::dispatch(item.action());
2516 TextMetrics const & BufferView::textMetrics(Text const * t) const
2518 return const_cast<BufferView *>(this)->textMetrics(t);
2522 TextMetrics & BufferView::textMetrics(Text const * t)
2525 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
2526 if (tmc_it == d->text_metrics_.end()) {
2527 tmc_it = d->text_metrics_.insert(
2528 make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
2530 return tmc_it->second;
2534 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
2537 return textMetrics(t).parMetrics(pit);
2541 int BufferView::workHeight() const
2547 void BufferView::setCursor(DocIterator const & dit)
2550 size_t const n = dit.depth();
2551 for (size_t i = 0; i < n; ++i)
2552 dit[i].inset().edit(d->cursor_, true);
2554 d->cursor_.setCursor(dit);
2555 d->cursor_.selection(false);
2556 d->cursor_.setCurrentFont();
2558 // It seems on general grounds as if this is probably needed, but
2559 // it is not yet clear.
2560 // See bug #7394 and r38388.
2561 // d->cursor.resetAnchor();
2565 void BufferView::setCursorSelectionTo(DocIterator const & dit)
2567 size_t const n = dit.depth();
2568 for (size_t i = 0; i < n; ++i)
2569 dit[i].inset().edit(d->cursor_, true);
2571 d->cursor_.selection(true);
2572 d->cursor_.setCursorSelectionTo(dit);
2573 d->cursor_.setCurrentFont();
2577 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
2579 // Would be wrong to delete anything if we have a selection.
2580 if (cur.selection())
2583 bool need_anchor_change = false;
2584 bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
2585 need_anchor_change);
2587 if (need_anchor_change)
2595 // we would rather not do this here, but it needs to be done before
2596 // the changed() signal is sent.
2597 buffer_.updateBuffer();
2599 buffer_.changed(true);
2604 bool BufferView::mouseSetCursor(Cursor & cur, bool const select)
2606 LASSERT(&cur.bv() == this, return false);
2609 // this event will clear selection so we save selection for
2610 // persistent selection
2611 cap::saveSelection(cursor());
2613 d->cursor_.macroModeClose();
2614 // If a macro has been finalized, the cursor might have been broken
2617 // Has the cursor just left the inset?
2618 bool const leftinset = (&d->cursor_.inset() != &cur.inset());
2620 d->cursor_.fixIfBroken();
2622 // do the dEPM magic if needed
2623 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
2624 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
2625 // the leftinset bool would not be necessary (badcursor instead).
2626 bool update = leftinset;
2629 d->cursor_.setSelection();
2630 d->cursor_.setCursorSelectionTo(cur);
2632 if (d->cursor_.inTexted())
2633 update |= checkDepm(cur, d->cursor_);
2634 d->cursor_.resetAnchor();
2635 d->cursor_.setCursor(cur);
2636 d->cursor_.clearSelection();
2638 d->cursor_.boundary(cur.boundary());
2639 d->cursor_.finishUndo();
2640 d->cursor_.setCurrentFont();
2642 cur.forceBufferUpdate();
2647 void BufferView::putSelectionAt(DocIterator const & cur,
2648 int length, bool backwards)
2650 d->cursor_.clearSelection();
2656 d->cursor_.pos() += length;
2657 d->cursor_.setSelection(d->cursor_, -length);
2659 d->cursor_.setSelection(d->cursor_, length);
2664 bool BufferView::selectIfEmpty(DocIterator & cur)
2666 if ((cur.inTexted() && !cur.paragraph().empty())
2667 || (cur.inMathed() && !cur.cell().empty()))
2670 pit_type const beg_pit = cur.pit();
2672 // The paragraph associated to this item isn't
2673 // the first one, so it can be selected
2676 // We have to resort to select the space between the
2677 // end of this item and the begin of the next one
2681 // If it is the only item in the document,
2682 // nothing can be selected
2685 pit_type const end_pit = cur.pit();
2686 pos_type const end_pos = cur.pos();
2687 d->cursor_.clearSelection();
2689 d->cursor_.setCursor(cur);
2690 d->cursor_.pit() = beg_pit;
2691 d->cursor_.pos() = 0;
2692 d->cursor_.selection(false);
2693 d->cursor_.resetAnchor();
2694 d->cursor_.pit() = end_pit;
2695 d->cursor_.pos() = end_pos;
2696 d->cursor_.setSelection();
2701 Cursor & BufferView::cursor()
2707 Cursor const & BufferView::cursor() const
2713 bool BufferView::singleParUpdate()
2715 Text & buftext = buffer_.text();
2716 pit_type const bottom_pit = d->cursor_.bottom().pit();
2717 TextMetrics & tm = textMetrics(&buftext);
2718 int old_height = tm.parMetrics(bottom_pit).height();
2720 // make sure inline completion pointer is ok
2721 if (d->inlineCompletionPos_.fixIfBroken())
2722 d->inlineCompletionPos_ = DocIterator();
2724 // In Single Paragraph mode, rebreak only
2725 // the (main text, not inset!) paragraph containing the cursor.
2726 // (if this paragraph contains insets etc., rebreaking will
2727 // recursively descend)
2728 tm.redoParagraph(bottom_pit);
2729 ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
2730 if (pm.height() != old_height)
2731 // Paragraph height has changed so we cannot proceed to
2732 // the singlePar optimisation.
2735 tm.updatePosCache(bottom_pit);
2737 LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
2738 << " y2: " << pm.position() + pm.descent()
2739 << " pit: " << bottom_pit
2740 << " singlepar: 1");
2745 void BufferView::updateMetrics()
2747 updateMetrics(d->update_flags_);
2748 d->update_strategy_ = FullScreenUpdate;
2752 void BufferView::updateMetrics(Update::flags & update_flags)
2754 if (height_ == 0 || width_ == 0)
2757 Text & buftext = buffer_.text();
2758 pit_type const npit = int(buftext.paragraphs().size());
2760 // Clear out the position cache in case of full screen redraw,
2761 d->coord_cache_.clear();
2763 // Clear out paragraph metrics to avoid having invalid metrics
2764 // in the cache from paragraphs not relayouted below
2765 // The complete text metrics will be redone.
2766 d->text_metrics_.clear();
2768 TextMetrics & tm = textMetrics(&buftext);
2770 // make sure inline completion pointer is ok
2771 if (d->inlineCompletionPos_.fixIfBroken())
2772 d->inlineCompletionPos_ = DocIterator();
2774 if (d->anchor_pit_ >= npit)
2775 // The anchor pit must have been deleted...
2776 d->anchor_pit_ = npit - 1;
2778 // Rebreak anchor paragraph.
2779 tm.redoParagraph(d->anchor_pit_);
2780 ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
2783 if (d->anchor_pit_ == 0) {
2784 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
2786 // Complete buffer visible? Then it's easy.
2787 if (scrollRange == 0)
2788 d->anchor_ypos_ = anchor_pm.ascent();
2790 // avoid empty space above the first row
2791 d->anchor_ypos_ = min(d->anchor_ypos_, anchor_pm.ascent());
2794 anchor_pm.setPosition(d->anchor_ypos_);
2795 tm.updatePosCache(d->anchor_pit_);
2797 LYXERR(Debug::PAINTING, "metrics: "
2798 << " anchor pit = " << d->anchor_pit_
2799 << " anchor ypos = " << d->anchor_ypos_);
2801 // Redo paragraphs above anchor if necessary.
2802 int y1 = d->anchor_ypos_ - anchor_pm.ascent();
2803 // We are now just above the anchor paragraph.
2804 pit_type pit1 = d->anchor_pit_ - 1;
2805 for (; pit1 >= 0 && y1 >= 0; --pit1) {
2806 tm.redoParagraph(pit1);
2807 ParagraphMetrics & pm = tm.par_metrics_[pit1];
2809 // Save the paragraph position in the cache.
2811 tm.updatePosCache(pit1);
2815 // Redo paragraphs below the anchor if necessary.
2816 int y2 = d->anchor_ypos_ + anchor_pm.descent();
2817 // We are now just below the anchor paragraph.
2818 pit_type pit2 = d->anchor_pit_ + 1;
2819 for (; pit2 < npit && y2 <= height_; ++pit2) {
2820 tm.redoParagraph(pit2);
2821 ParagraphMetrics & pm = tm.par_metrics_[pit2];
2823 // Save the paragraph position in the cache.
2825 tm.updatePosCache(pit2);
2829 LYXERR(Debug::PAINTING, "Metrics: "
2830 << " anchor pit = " << d->anchor_pit_
2831 << " anchor ypos = " << d->anchor_ypos_
2834 << " pit1 = " << pit1
2835 << " pit2 = " << pit2);
2837 // metrics is done, full drawing is necessary now
2838 update_flags = (update_flags & ~Update::Force) | Update::ForceDraw;
2840 // Now update the positions of insets in the cache.
2843 if (lyxerr.debugging(Debug::WORKAREA)) {
2844 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
2845 d->coord_cache_.dump();
2850 void BufferView::updatePosCache()
2852 // this is the "nodraw" drawing stage: only set the positions of the
2853 // insets in metrics cache.
2854 frontend::NullPainter np;
2859 void BufferView::insertLyXFile(FileName const & fname)
2861 LASSERT(d->cursor_.inTexted(), return);
2863 // Get absolute path of file and add ".lyx"
2864 // to the filename if necessary
2865 FileName filename = fileSearch(string(), fname.absFileName(), "lyx");
2867 docstring const disp_fn = makeDisplayPath(filename.absFileName());
2868 // emit message signal.
2869 message(bformat(_("Inserting document %1$s..."), disp_fn));
2872 Buffer buf(filename.absFileName(), false);
2873 if (buf.loadLyXFile() == Buffer::ReadSuccess) {
2874 ErrorList & el = buffer_.errorList("Parse");
2875 // Copy the inserted document error list into the current buffer one.
2876 el = buf.errorList("Parse");
2877 buffer_.undo().recordUndo(d->cursor_);
2878 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
2879 buf.params().documentClassPtr(), el);
2880 res = _("Document %1$s inserted.");
2882 res = _("Could not insert document %1$s");
2885 buffer_.changed(true);
2886 // emit message signal.
2887 message(bformat(res, disp_fn));
2891 Point BufferView::coordOffset(DocIterator const & dit) const
2897 // Addup contribution of nested insets, from inside to outside,
2898 // keeping the outer paragraph for a special handling below
2899 for (size_t i = dit.depth() - 1; i >= 1; --i) {
2900 CursorSlice const & sl = dit[i];
2904 // get relative position inside sl.inset()
2905 sl.inset().cursorPos(*this, sl, dit.boundary() && (i + 1 == dit.depth()), xx, yy);
2907 // Make relative position inside of the edited inset relative to sl.inset()
2911 // In case of an RTL inset, the edited inset will be positioned to the left
2914 bool boundary_i = dit.boundary() && i + 1 == dit.depth();
2915 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2920 // remember width for the case that sl.inset() is positioned in an RTL inset
2921 lastw = sl.inset().dimension(*this).wid;
2923 //lyxerr << "Cursor::getPos, i: "
2924 // << i << " x: " << xx << " y: " << y << endl;
2927 // Add contribution of initial rows of outermost paragraph
2928 CursorSlice const & sl = dit[0];
2929 TextMetrics const & tm = textMetrics(sl.text());
2930 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2932 LBUFERR(!pm.rows().empty());
2933 y -= pm.rows()[0].ascent();
2935 // FIXME: document this mess
2937 if (sl.pos() > 0 && dit.depth() == 1) {
2939 if (pos && dit.boundary())
2941 // lyxerr << "coordOffset: boundary:" << dit.boundary() << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
2942 rend = pm.pos2row(pos);
2944 rend = pm.pos2row(sl.pos());
2946 size_t rend = pm.pos2row(sl.pos());
2948 for (size_t rit = 0; rit != rend; ++rit)
2949 y += pm.rows()[rit].height();
2950 y += pm.rows()[rend].ascent();
2952 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
2954 // Make relative position from the nested inset now bufferview absolute.
2955 int xx = bottom_tm.cursorX(dit.bottom(), dit.boundary() && dit.depth() == 1);
2958 // In the RTL case place the nested inset at the left of the cursor in
2959 // the outer paragraph
2960 bool boundary_1 = dit.boundary() && 1 == dit.depth();
2961 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
2969 Point BufferView::getPos(DocIterator const & dit) const
2971 if (!paragraphVisible(dit))
2972 return Point(-1, -1);
2974 CursorSlice const & bot = dit.bottom();
2975 TextMetrics const & tm = textMetrics(bot.text());
2977 // offset from outer paragraph
2978 Point p = coordOffset(dit);
2979 p.y_ += tm.parMetrics(bot.pit()).position();
2984 bool BufferView::paragraphVisible(DocIterator const & dit) const
2986 CursorSlice const & bot = dit.bottom();
2987 TextMetrics const & tm = textMetrics(bot.text());
2989 return tm.contains(bot.pit());
2993 void BufferView::setCaretAscentDescent(int asc, int des)
2995 d->caret_ascent_ = asc;
2996 d->caret_descent_ = des;
3000 void BufferView::caretPosAndHeight(Point & p, int & h) const
3003 Cursor const & cur = cursor();
3004 if (cur.inMathed()) {
3005 asc = d->caret_ascent_;
3006 des = d->caret_descent_;
3008 Font const font = cur.real_current_font;
3009 frontend::FontMetrics const & fm = theFontMetrics(font);
3010 asc = fm.maxAscent();
3011 des = fm.maxDescent();
3019 bool BufferView::cursorInView(Point const & p, int h) const
3021 Cursor const & cur = cursor();
3022 // does the cursor touch the screen ?
3023 if (p.y_ + h < 0 || p.y_ >= workHeight() || !paragraphVisible(cur))
3029 int BufferView::horizScrollOffset() const
3031 return d->horiz_scroll_offset_;
3035 int BufferView::horizScrollOffset(Text const * text,
3036 pit_type pit, pos_type pos) const
3038 // Is this a row that is currently scrolled?
3039 if (!d->current_row_slice_.empty()
3040 && &text->inset() == d->current_row_slice_.inset().asInsetText()
3041 && pit == d->current_row_slice_.pit()
3042 && pos == d->current_row_slice_.pos())
3043 return d->horiz_scroll_offset_;
3048 bool BufferView::hadHorizScrollOffset(Text const * text,
3049 pit_type pit, pos_type pos) const
3051 return !d->last_row_slice_.empty()
3052 && &text->inset() == d->last_row_slice_.inset().asInsetText()
3053 && pit == d->last_row_slice_.pit()
3054 && pos == d->last_row_slice_.pos();
3058 void BufferView::setCurrentRowSlice(CursorSlice const & rowSlice)
3060 // nothing to do if the cursor was already on this row
3061 if (d->current_row_slice_ == rowSlice) {
3062 d->last_row_slice_ = CursorSlice();
3066 // if the (previous) current row was scrolled, we have to
3067 // remember it in order to repaint it next time.
3068 if (d->horiz_scroll_offset_ != 0)
3069 d->last_row_slice_ = d->current_row_slice_;
3071 d->last_row_slice_ = CursorSlice();
3073 // Since we changed row, the scroll offset is not valid anymore
3074 d->horiz_scroll_offset_ = 0;
3075 d->current_row_slice_ = rowSlice;
3079 void BufferView::checkCursorScrollOffset()
3081 CursorSlice rowSlice = d->cursor_.bottom();
3082 TextMetrics const & tm = textMetrics(rowSlice.text());
3084 // Stop if metrics have not been computed yet, since it means
3085 // that there is nothing to do.
3086 if (!tm.contains(rowSlice.pit()))
3088 ParagraphMetrics const & pm = tm.parMetrics(rowSlice.pit());
3089 Row const & row = pm.getRow(rowSlice.pos(),
3090 d->cursor_.boundary() && rowSlice == d->cursor_.top());
3091 rowSlice.pos() = row.pos();
3093 // Set the row on which the cursor lives.
3094 setCurrentRowSlice(rowSlice);
3096 // Current x position of the cursor in pixels
3097 int cur_x = getPos(d->cursor_).x_;
3099 // Horizontal scroll offset of the cursor row in pixels
3100 int offset = d->horiz_scroll_offset_;
3101 int const MARGIN = 2 * theFontMetrics(d->cursor_.real_current_font).em()
3103 if (row.right_x() <= workWidth() - row.right_margin) {
3104 // Row is narrower than the work area, no offset needed.
3107 if (cur_x - offset < MARGIN) {
3108 // cursor would be too far right
3109 offset = cur_x - MARGIN;
3110 } else if (cur_x - offset > workWidth() - MARGIN) {
3111 // cursor would be too far left
3112 offset = cur_x - workWidth() + MARGIN;
3114 // Correct the offset to make sure that we do not scroll too much
3117 if (row.right_x() - offset < workWidth() - row.right_margin)
3118 offset = row.right_x() - workWidth() + row.right_margin;
3121 //lyxerr << "cur_x=" << cur_x << ", offset=" << offset << ", row.wid=" << row.width() << ", margin=" << MARGIN << endl;
3123 if (offset != d->horiz_scroll_offset_)
3124 LYXERR(Debug::PAINTING, "Horiz. scroll offset changed from "
3125 << d->horiz_scroll_offset_ << " to " << offset);
3127 if (d->update_strategy_ == NoScreenUpdate
3128 && (offset != d->horiz_scroll_offset_
3129 || !d->last_row_slice_.empty())) {
3130 // FIXME: if one uses SingleParUpdate, then home/end
3131 // will not work on long rows. Why?
3132 d->update_strategy_ = FullScreenUpdate;
3135 d->horiz_scroll_offset_ = offset;
3139 void BufferView::draw(frontend::Painter & pain, bool paint_caret)
3141 if (height_ == 0 || width_ == 0)
3143 LYXERR(Debug::PAINTING, (pain.isNull() ? "\t\t--- START NODRAW ---"
3144 : "\t\t*** START DRAWING ***"));
3145 Text & text = buffer_.text();
3146 TextMetrics const & tm = d->text_metrics_[&text];
3147 int const y = tm.first().second->position();
3148 PainterInfo pi(this, pain);
3150 // Check whether the row where the cursor lives needs to be scrolled.
3151 // Update the drawing strategy if needed.
3152 checkCursorScrollOffset();
3154 switch (d->update_strategy_) {
3156 case NoScreenUpdate:
3157 // no screen painting is actually needed. In nodraw stage
3158 // however, the different coordinates of insets and paragraphs
3159 // needs to be updated.
3160 LYXERR(Debug::PAINTING, "Strategy: NoScreenUpdate");
3161 pi.full_repaint = false;
3162 if (pain.isNull()) {
3163 pi.full_repaint = true;
3166 pi.full_repaint = false;
3171 case SingleParUpdate:
3172 pi.full_repaint = false;
3173 LYXERR(Debug::PAINTING, "Strategy: SingleParUpdate");
3174 // In general, only the current row of the outermost paragraph
3175 // will be redrawn. Particular cases where selection spans
3176 // multiple paragraph are correctly detected in TextMetrics.
3180 case DecorationUpdate:
3181 // FIXME: We should also distinguish DecorationUpdate to avoid text
3182 // drawing if possible. This is not possible to do easily right now
3183 // because of the single backing pixmap.
3185 case FullScreenUpdate:
3187 LYXERR(Debug::PAINTING,
3188 ((d->update_strategy_ == FullScreenUpdate)
3189 ? "Strategy: FullScreenUpdate"
3190 : "Strategy: DecorationUpdate"));
3192 // The whole screen, including insets, will be refreshed.
3193 pi.full_repaint = true;
3195 // Clear background.
3196 pain.fillRectangle(0, 0, width_, height_,
3197 pi.backgroundColor(&buffer_.inset()));
3202 // and possibly grey out below
3203 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3204 int const y2 = lastpm.second->position() + lastpm.second->descent();
3207 Color color = buffer().isInternal()
3208 ? Color_background : Color_bottomarea;
3209 pain.fillRectangle(0, y2, width_, height_ - y2, color);
3213 LYXERR(Debug::PAINTING, (pain.isNull() ? "\t\t --- END NODRAW ---"
3214 : "\t\t *** END DRAWING ***"));
3216 // The scrollbar needs an update.
3219 // Normalize anchor for next time
3220 pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
3221 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3222 for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
3223 ParagraphMetrics const & pm = tm.parMetrics(pit);
3224 if (pm.position() + pm.descent() > 0) {
3225 if (d->anchor_pit_ != pit
3226 || d->anchor_ypos_ != pm.position())
3227 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
3228 << " anchor ypos = " << d->anchor_ypos_);
3229 d->anchor_pit_ = pit;
3230 d->anchor_ypos_ = pm.position();
3234 if (!pain.isNull()) {
3235 // reset the update flags, everything has been done
3236 d->update_flags_ = Update::None;
3239 // If a caret has to be painted, mark its text row as dirty to
3240 //make sure that it will be repainted on next redraw.
3241 /* FIXME: investigate whether this can be avoided when the cursor did not
3245 Row const & caret_row = d->cursor_.textRow();
3246 caret_row.changed(true);
3251 void BufferView::message(docstring const & msg)
3254 d->gui_->message(msg);
3258 void BufferView::showDialog(string const & name)
3261 d->gui_->showDialog(name, string());
3265 void BufferView::showDialog(string const & name,
3266 string const & data, Inset * inset)
3269 d->gui_->showDialog(name, data, inset);
3273 void BufferView::updateDialog(string const & name, string const & data)
3276 d->gui_->updateDialog(name, data);
3280 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
3286 // FIXME: Move this out of BufferView again
3287 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
3289 if (!fname.isReadableFile()) {
3290 docstring const error = from_ascii(strerror(errno));
3291 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3292 docstring const text =
3293 bformat(_("Could not read the specified document\n"
3294 "%1$s\ndue to the error: %2$s"), file, error);
3295 Alert::error(_("Could not read file"), text);
3299 if (!fname.isReadableFile()) {
3300 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3301 docstring const text =
3302 bformat(_("%1$s\n is not readable."), file);
3303 Alert::error(_("Could not open file"), text);
3307 // FIXME UNICODE: We don't know the encoding of the file
3308 docstring file_content = fname.fileContents("UTF-8");
3309 if (file_content.empty()) {
3310 Alert::error(_("Reading not UTF-8 encoded file"),
3311 _("The file is not UTF-8 encoded.\n"
3312 "It will be read as local 8Bit-encoded.\n"
3313 "If this does not give the correct result\n"
3314 "then please change the encoding of the file\n"
3315 "to UTF-8 with a program other than LyX.\n"));
3316 file_content = fname.fileContents("local8bit");
3319 return normalize_c(file_content);
3323 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
3325 docstring const tmpstr = contentsOfPlaintextFile(f);
3330 Cursor & cur = cursor();
3331 cap::replaceSelection(cur);
3332 buffer_.undo().recordUndo(cur);
3334 cur.innerText()->insertStringAsParagraphs(cur, tmpstr, cur.current_font);
3336 cur.innerText()->insertStringAsLines(cur, tmpstr, cur.current_font);
3338 buffer_.changed(true);
3342 docstring const & BufferView::inlineCompletion() const
3344 return d->inlineCompletion_;
3348 size_t const & BufferView::inlineCompletionUniqueChars() const
3350 return d->inlineCompletionUniqueChars_;
3354 DocIterator const & BufferView::inlineCompletionPos() const
3356 return d->inlineCompletionPos_;
3360 void BufferView::resetInlineCompletionPos()
3362 d->inlineCompletionPos_ = DocIterator();
3366 bool samePar(DocIterator const & a, DocIterator const & b)
3368 if (a.empty() && b.empty())
3370 if (a.empty() || b.empty())
3372 if (a.depth() != b.depth())
3374 return &a.innerParagraph() == &b.innerParagraph();
3378 void BufferView::setInlineCompletion(Cursor const & cur, DocIterator const & pos,
3379 docstring const & completion, size_t uniqueChars)
3381 uniqueChars = min(completion.size(), uniqueChars);
3382 bool changed = d->inlineCompletion_ != completion
3383 || d->inlineCompletionUniqueChars_ != uniqueChars;
3384 bool singlePar = true;
3385 d->inlineCompletion_ = completion;
3386 d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
3388 //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
3391 DocIterator const & old = d->inlineCompletionPos_;
3393 //lyxerr << "inlineCompletionPos changed" << std::endl;
3394 // old or pos are in another paragraph?
3395 if ((!samePar(cur, pos) && !pos.empty())
3396 || (!samePar(cur, old) && !old.empty())) {
3398 //lyxerr << "different paragraph" << std::endl;
3400 d->inlineCompletionPos_ = pos;
3405 if (singlePar && !(cur.result().screenUpdate() & Update::Force))
3406 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
3408 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::Force);
3413 bool BufferView::clickableInset() const
3415 return d->clickable_inset_;