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"
20 #include "buffer_funcs.h"
21 #include "BufferList.h"
22 #include "BufferParams.h"
23 #include "CoordCache.h"
25 #include "CutAndPaste.h"
26 #include "DispatchResult.h"
27 #include "EmbeddedFiles.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"
42 #include "MetricsInfo.h"
43 #include "Paragraph.h"
44 #include "paragraph_funcs.h"
45 #include "ParagraphParameters.h"
46 #include "ParIterator.h"
49 #include "TextClass.h"
50 #include "TextMetrics.h"
53 #include "WordLangTuple.h"
55 #include "insets/InsetBibtex.h"
56 #include "insets/InsetCommand.h" // ChangeRefs
57 #include "insets/InsetRef.h"
58 #include "insets/InsetText.h"
60 #include "frontends/alert.h"
61 #include "frontends/Application.h"
62 #include "frontends/Delegates.h"
63 #include "frontends/FontMetrics.h"
64 #include "frontends/Painter.h"
65 #include "frontends/Selection.h"
67 #include "graphics/Previews.h"
69 #include "support/convert.h"
70 #include "support/debug.h"
71 #include "support/ExceptionMessage.h"
72 #include "support/filetools.h"
73 #include "support/gettext.h"
74 #include "support/lstrings.h"
75 #include "support/Package.h"
76 #include "support/types.h"
85 using namespace lyx::support;
89 namespace Alert = frontend::Alert;
93 /// Return an inset of this class if it exists at the current cursor position
95 T * getInsetByCode(Cursor const & cur, InsetCode code)
98 Inset * inset = it.nextInset();
99 if (inset && inset->lyxCode() == code)
100 return static_cast<T*>(inset);
105 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
108 bool findNextInset(DocIterator & dit, vector<InsetCode> const & codes,
109 docstring const & contents)
111 DocIterator tmpdit = dit;
114 Inset const * inset = tmpdit.nextInset();
116 && std::find(codes.begin(), codes.end(), inset->lyxCode()) != codes.end()
117 && (contents.empty() ||
118 static_cast<InsetCommand const *>(inset)->getFirstNonOptParam() == contents)) {
122 tmpdit.forwardInset();
129 /// Looks for next inset with one of the given codes.
130 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
134 DocIterator tmpdit = dit;
135 tmpdit.forwardInset();
140 Inset const * inset = tmpdit.nextInset();
142 && std::find(codes.begin(), codes.end(), inset->lyxCode()) != codes.end()) {
143 contents = static_cast<InsetCommand const *>(inset)->getFirstNonOptParam();
147 if (!findNextInset(tmpdit, codes, contents)) {
148 if (dit.depth() != 1 || dit.pit() != 0 || dit.pos() != 0) {
149 tmpdit = doc_iterator_begin(tmpdit.bottom().inset());
150 if (!findNextInset(tmpdit, codes, contents))
161 /// Looks for next inset with the given code
162 void findInset(DocIterator & dit, InsetCode code, bool same_content)
164 findInset(dit, vector<InsetCode>(1, code), same_content);
168 /// Moves cursor to the next inset with one of the given codes.
169 void gotoInset(BufferView * bv, vector<InsetCode> const & codes,
172 Cursor tmpcur = bv->cursor();
173 if (!findInset(tmpcur, codes, same_content)) {
174 bv->cursor().message(_("No more insets"));
178 tmpcur.clearSelection();
179 bv->setCursor(tmpcur);
184 /// Moves cursor to the next inset with given code.
185 void gotoInset(BufferView * bv, InsetCode code, bool same_content)
187 gotoInset(bv, vector<InsetCode>(1, code), same_content);
191 /// A map from a Text to the associated text metrics
192 typedef map<Text const *, TextMetrics> TextMetricsCache;
194 enum ScreenUpdateStrategy {
204 /////////////////////////////////////////////////////////////////////
208 /////////////////////////////////////////////////////////////////////
210 struct BufferView::Private
212 Private(BufferView & bv): wh_(0), cursor_(bv),
213 anchor_pit_(0), anchor_ypos_(0),
214 last_inset_(0), gui_(0)
218 ScrollbarParameters scrollbarParameters_;
220 ScreenUpdateStrategy update_strategy_;
222 CoordCache coord_cache_;
224 /// Estimated average par height for scrollbar.
226 /// this is used to handle XSelection events in the right manner.
235 pit_type anchor_pit_;
239 vector<int> par_height_;
241 /// keyboard mapping object.
244 /// last visited inset.
245 /** kept to send setMouseHover(false).
246 * Not owned, so don't delete.
250 mutable TextMetricsCache text_metrics_;
253 /** Not owned, so don't delete.
255 frontend::GuiBufferViewDelegate * gui_;
259 BufferView::BufferView(Buffer & buf)
260 : width_(0), height_(0), full_screen_(false), buffer_(buf), d(new Private(*this))
262 d->xsel_cache_.set = false;
263 d->intl_.initKeyMapper(lyxrc.use_kbmap);
265 d->cursor_.push(buffer_.inset());
266 d->cursor_.resetAnchor();
267 d->cursor_.setCurrentFont();
269 if (graphics::Previews::status() != LyXRC::PREVIEW_OFF)
270 graphics::Previews::get().generateBufferPreviews(buffer_);
274 BufferView::~BufferView()
276 // current buffer is going to be switched-off, save cursor pos
277 // Ideally, the whole cursor stack should be saved, but session
278 // currently can only handle bottom (whole document) level pit and pos.
279 // That is to say, if a cursor is in a nested inset, it will be
280 // restore to the left of the top level inset.
281 LastFilePosSection::FilePos fp;
282 fp.pit = d->cursor_.bottom().pit();
283 fp.pos = d->cursor_.bottom().pos();
284 LyX::ref().session().lastFilePos().save(buffer_.fileName(), fp);
290 int BufferView::rightMargin() const
292 // The additional test for the case the outliner is opened.
294 !lyxrc.full_screen_limit ||
295 width_ < lyxrc.full_screen_width + 20)
298 return (width_ - lyxrc.full_screen_width) / 2;
302 int BufferView::leftMargin() const
304 return rightMargin();
308 Intl & BufferView::getIntl()
314 Intl const & BufferView::getIntl() const
320 CoordCache & BufferView::coordCache()
322 return d->coord_cache_;
326 CoordCache const & BufferView::coordCache() const
328 return d->coord_cache_;
332 Buffer & BufferView::buffer()
338 Buffer const & BufferView::buffer() const
344 bool BufferView::fitCursor()
346 if (cursorStatus(d->cursor_) == CUR_INSIDE) {
347 frontend::FontMetrics const & fm =
348 theFontMetrics(d->cursor_.getFont().fontInfo());
349 int const asc = fm.maxAscent();
350 int const des = fm.maxDescent();
351 Point const p = getPos(d->cursor_, d->cursor_.boundary());
352 if (p.y_ - asc >= 0 && p.y_ + des < height_)
359 void BufferView::processUpdateFlags(Update::flags flags)
361 // last_inset_ points to the last visited inset. This pointer may become
362 // invalid because of keyboard editing. Since all such operations
363 // causes screen update(), I reset last_inset_ to avoid such a problem.
365 // This is close to a hot-path.
366 LYXERR(Debug::DEBUG, "BufferView::processUpdateFlags()"
367 << "[fitcursor = " << (flags & Update::FitCursor)
368 << ", forceupdate = " << (flags & Update::Force)
369 << ", singlepar = " << (flags & Update::SinglePar)
370 << "] buffer: " << &buffer_);
372 buffer_.updateMacros();
374 // Now do the first drawing step if needed. This consists on updating
375 // the CoordCache in updateMetrics().
376 // The second drawing step is done in WorkArea::redraw() if needed.
378 // Case when no explicit update is requested.
380 // no need to redraw anything.
381 d->update_strategy_ = NoScreenUpdate;
385 if (flags == Update::Decoration) {
386 d->update_strategy_ = DecorationUpdate;
391 if (flags == Update::FitCursor
392 || flags == (Update::Decoration | Update::FitCursor)) {
393 // tell the frontend to update the screen if needed.
398 if (flags & Update::Decoration) {
399 d->update_strategy_ = DecorationUpdate;
403 // no screen update is needed.
404 d->update_strategy_ = NoScreenUpdate;
408 bool const full_metrics = flags & Update::Force || !singleParUpdate();
411 // We have to update the full screen metrics.
414 if (!(flags & Update::FitCursor)) {
415 // Nothing to do anymore. Trigger a redraw and return
420 // updateMetrics() does not update paragraph position
421 // This is done at draw() time. So we need a redraw!
425 // The cursor is off screen so ensure it is visible.
432 void BufferView::updateScrollbar()
437 // We prefer fixed size line scrolling.
438 d->scrollbarParameters_.single_step = defaultRowHeight();
439 // We prefer full screen page scrolling.
440 d->scrollbarParameters_.page_step = height_;
442 Text & t = buffer_.text();
443 TextMetrics & tm = d->text_metrics_[&t];
445 LYXERR(Debug::GUI, " Updating scrollbar: height: "
446 << t.paragraphs().size()
447 << " curr par: " << d->cursor_.bottom().pit()
448 << " default height " << defaultRowHeight());
450 size_t const parsize = t.paragraphs().size();
451 if (d->par_height_.size() != parsize) {
452 d->par_height_.clear();
453 // FIXME: We assume a default paragraph height of 2 rows. This
454 // should probably be pondered with the screen width.
455 d->par_height_.resize(parsize, defaultRowHeight() * 2);
458 // Look at paragraph heights on-screen
459 pair<pit_type, ParagraphMetrics const *> first = tm.first();
460 pair<pit_type, ParagraphMetrics const *> last = tm.last();
461 for (pit_type pit = first.first; pit <= last.first; ++pit) {
462 d->par_height_[pit] = tm.parMetrics(pit).height();
463 LYXERR(Debug::SCROLLING, "storing height for pit " << pit << " : "
464 << d->par_height_[pit]);
467 int top_pos = first.second->position() - first.second->ascent();
468 int bottom_pos = last.second->position() + last.second->descent();
469 bool first_visible = first.first == 0 && top_pos >= 0;
470 bool last_visible = last.first + 1 == int(parsize) && bottom_pos <= height_;
471 if (first_visible && last_visible) {
472 d->scrollbarParameters_.min = 0;
473 d->scrollbarParameters_.max = 0;
477 d->scrollbarParameters_.min = top_pos;
478 for (size_t i = 0; i != size_t(first.first); ++i)
479 d->scrollbarParameters_.min -= d->par_height_[i];
480 d->scrollbarParameters_.max = bottom_pos;
481 for (size_t i = last.first + 1; i != parsize; ++i)
482 d->scrollbarParameters_.max += d->par_height_[i];
484 d->scrollbarParameters_.position = 0;
485 // The reference is the top position so we remove one page.
486 d->scrollbarParameters_.max -= d->scrollbarParameters_.page_step;
490 ScrollbarParameters const & BufferView::scrollbarParameters() const
492 return d->scrollbarParameters_;
496 docstring BufferView::toolTip(int x, int y) const
498 // Get inset under mouse, if there is one.
499 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
501 // No inset, no tooltip...
503 return covering_inset->toolTip(*this, x, y);
507 docstring BufferView::contextMenu(int x, int y) const
509 // Get inset under mouse, if there is one.
510 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
512 return covering_inset->contextMenu(*this, x, y);
514 // FIXME: Do something more elaborate here.
515 return from_ascii("edit");
519 void BufferView::scrollDocView(int value)
521 int const offset = value - d->scrollbarParameters_.position;
522 // If the offset is less than 2 screen height, prefer to scroll instead.
523 if (abs(offset) <= 2 * height_) {
528 // cut off at the top
529 if (value <= d->scrollbarParameters_.min) {
530 DocIterator dit = doc_iterator_begin(buffer_.inset());
532 LYXERR(Debug::SCROLLING, "scroll to top");
536 // cut off at the bottom
537 if (value >= d->scrollbarParameters_.max) {
538 DocIterator dit = doc_iterator_end(buffer_.inset());
541 LYXERR(Debug::SCROLLING, "scroll to bottom");
545 // find paragraph at target position
546 int par_pos = d->scrollbarParameters_.min;
548 for (; i != int(d->par_height_.size()); ++i) {
549 par_pos += d->par_height_[i];
550 if (par_pos >= value)
554 if (par_pos < value) {
555 // It seems we didn't find the correct pit so stay on the safe side and
557 LYXERR0("scrolling position not found!");
558 scrollDocView(d->scrollbarParameters_.max);
562 DocIterator dit = doc_iterator_begin(buffer_.inset());
564 LYXERR(Debug::SCROLLING, "value = " << value << " -> scroll to pit " << i);
569 // FIXME: this method is not working well.
570 void BufferView::setCursorFromScrollbar()
572 TextMetrics & tm = d->text_metrics_[&buffer_.text()];
574 int const height = 2 * defaultRowHeight();
575 int const first = height;
576 int const last = height_ - height;
577 Cursor & cur = d->cursor_;
579 switch (cursorStatus(cur)) {
581 // We reset the cursor because cursorStatus() does not
582 // work when the cursor is within mathed.
583 cur.reset(buffer_.inset());
584 tm.setCursorFromCoordinates(cur, 0, first);
585 cur.clearSelection();
588 // We reset the cursor because cursorStatus() does not
589 // work when the cursor is within mathed.
590 cur.reset(buffer_.inset());
591 tm.setCursorFromCoordinates(cur, 0, last);
592 cur.clearSelection();
595 int const y = getPos(cur, cur.boundary()).y_;
596 int const newy = min(last, max(y, first));
598 cur.reset(buffer_.inset());
599 tm.setCursorFromCoordinates(cur, 0, newy);
605 Change const BufferView::getCurrentChange() const
607 if (!d->cursor_.selection())
608 return Change(Change::UNCHANGED);
610 DocIterator dit = d->cursor_.selectionBegin();
611 return dit.paragraph().lookupChange(dit.pos());
615 // this could be used elsewhere as well?
616 // FIXME: This does not work within mathed!
617 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
619 Point const p = getPos(dit, dit.boundary());
622 if (p.y_ > workHeight())
628 void BufferView::saveBookmark(unsigned int idx)
630 // tenatively save bookmark, id and pos will be used to
631 // acturately locate a bookmark in a 'live' lyx session.
632 // pit and pos will be updated with bottom level pit/pos
634 LyX::ref().session().bookmarks().save(
636 d->cursor_.bottom().pit(),
637 d->cursor_.bottom().pos(),
638 d->cursor_.paragraph().id(),
643 // emit message signal.
644 message(_("Save bookmark"));
648 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
649 int top_id, pos_type top_pos)
651 bool success = false;
654 d->cursor_.clearSelection();
656 // if a valid par_id is given, try it first
657 // This is the case for a 'live' bookmark when unique paragraph ID
658 // is used to track bookmarks.
660 dit = buffer_.getParFromID(top_id);
662 dit.pos() = min(dit.paragraph().size(), top_pos);
663 // Some slices of the iterator may not be
664 // reachable (e.g. closed collapsable inset)
665 // so the dociterator may need to be
666 // shortened. Otherwise, setCursor may crash
667 // lyx when the cursor can not be set to these
669 size_t const n = dit.depth();
670 for (size_t i = 0; i < n; ++i)
671 if (dit[i].inset().editable() != Inset::HIGHLY_EDITABLE) {
679 // if top_id == 0, or searching through top_id failed
680 // This is the case for a 'restored' bookmark when only bottom
681 // (document level) pit was saved. Because of this, bookmark
682 // restoration is inaccurate. If a bookmark was within an inset,
683 // it will be restored to the left of the outmost inset that contains
685 if (bottom_pit < int(buffer_.paragraphs().size())) {
686 dit = doc_iterator_begin(buffer_.inset());
688 dit.pit() = bottom_pit;
689 dit.pos() = min(bottom_pos, dit.paragraph().size());
694 // Note: only bottom (document) level pit is set.
696 // set the current font.
697 d->cursor_.setCurrentFont();
698 // To center the screen on this new position we need the
699 // paragraph position which is computed at draw() time.
700 // So we need a redraw!
710 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
712 if (lyxrc.rtl_support) {
713 if (d->cursor_.real_current_font.isRightToLeft()) {
714 if (d->intl_.keymap == Intl::PRIMARY)
715 d->intl_.keyMapSec();
717 if (d->intl_.keymap == Intl::SECONDARY)
718 d->intl_.keyMapPrim();
722 d->intl_.getTransManager().translateAndInsert(c, t, cur);
726 int BufferView::workWidth() const
732 void BufferView::showCursor()
734 showCursor(d->cursor_);
738 void BufferView::showCursor(DocIterator const & dit)
740 // We are not properly started yet, delay until resizing is
745 LYXERR(Debug::SCROLLING, "recentering!");
747 CursorSlice const & bot = dit.bottom();
748 TextMetrics & tm = d->text_metrics_[bot.text()];
750 pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
751 int bot_pit = bot.pit();
752 if (bot_pit > max_pit) {
753 // FIXME: Why does this happen?
754 LYXERR0("bottom pit is greater that max pit: "
755 << bot_pit << " > " << max_pit);
759 if (bot_pit == tm.first().first - 1)
760 tm.newParMetricsUp();
761 else if (bot_pit == tm.last().first + 1)
762 tm.newParMetricsDown();
764 if (tm.has(bot_pit)) {
765 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
766 BOOST_ASSERT(!pm.rows().empty());
767 // FIXME: smooth scrolling doesn't work in mathed.
768 CursorSlice const & cs = dit.innerTextSlice();
769 int offset = coordOffset(dit, dit.boundary()).y_;
770 int ypos = pm.position() + offset;
771 Dimension const & row_dim =
772 pm.getRow(cs.pos(), dit.boundary()).dimension();
773 if (ypos - row_dim.ascent() < 0)
774 scrollUp(- ypos + row_dim.ascent());
775 else if (ypos + row_dim.descent() > height_)
776 scrollDown(ypos - height_ + row_dim.descent());
777 // else, nothing to do, the cursor is already visible so we just return.
781 tm.redoParagraph(bot_pit);
782 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
783 int offset = coordOffset(dit, dit.boundary()).y_;
785 d->anchor_pit_ = bot_pit;
786 CursorSlice const & cs = dit.innerTextSlice();
787 Dimension const & row_dim =
788 pm.getRow(cs.pos(), dit.boundary()).dimension();
790 if (d->anchor_pit_ == 0)
791 d->anchor_ypos_ = offset + pm.ascent();
792 else if (d->anchor_pit_ == max_pit)
793 d->anchor_ypos_ = height_ - offset - row_dim.descent();
795 d->anchor_ypos_ = defaultRowHeight() * 2 - offset - row_dim.descent();
802 FuncStatus BufferView::getStatus(FuncRequest const & cmd)
806 Cursor & cur = d->cursor_;
808 switch (cmd.action) {
811 flag.enabled(buffer_.undo().hasUndoStack());
814 flag.enabled(buffer_.undo().hasRedoStack());
816 case LFUN_FILE_INSERT:
817 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
818 case LFUN_FILE_INSERT_PLAINTEXT:
819 case LFUN_BOOKMARK_SAVE:
820 // FIXME: Actually, these LFUNS should be moved to Text
821 flag.enabled(cur.inTexted());
823 case LFUN_FONT_STATE:
824 case LFUN_LABEL_INSERT:
825 case LFUN_INFO_INSERT:
826 case LFUN_PARAGRAPH_GOTO:
828 case LFUN_REFERENCE_NEXT:
830 case LFUN_WORD_REPLACE:
833 case LFUN_MARK_TOGGLE:
834 case LFUN_SCREEN_RECENTER:
835 case LFUN_BIBTEX_DATABASE_ADD:
836 case LFUN_BIBTEX_DATABASE_DEL:
837 case LFUN_STATISTICS:
838 case LFUN_NEXT_INSET_TOGGLE:
842 case LFUN_LABEL_GOTO: {
843 flag.enabled(!cmd.argument().empty()
844 || getInsetByCode<InsetRef>(cur, REF_CODE));
848 case LFUN_CHANGES_TRACK:
850 flag.setOnOff(buffer_.params().trackChanges);
853 case LFUN_CHANGES_OUTPUT:
855 flag.setOnOff(buffer_.params().outputChanges);
858 case LFUN_CHANGES_MERGE:
859 case LFUN_CHANGE_NEXT:
860 case LFUN_ALL_CHANGES_ACCEPT:
861 case LFUN_ALL_CHANGES_REJECT:
862 // TODO: context-sensitive enabling of LFUNs
863 // In principle, these command should only be enabled if there
864 // is a change in the document. However, without proper
865 // optimizations, this will inevitably result in poor performance.
869 case LFUN_BUFFER_TOGGLE_COMPRESSION: {
870 flag.setOnOff(buffer_.params().compressed);
874 case LFUN_BUFFER_TOGGLE_EMBEDDING: {
875 flag.setOnOff(buffer_.params().embedded);
880 case LFUN_SCREEN_DOWN:
885 // FIXME: LFUN_SCREEN_DOWN_SELECT should be removed from
886 // everywhere else before this can enabled:
887 case LFUN_SCREEN_UP_SELECT:
888 case LFUN_SCREEN_DOWN_SELECT:
892 case LFUN_LAYOUT_TABULAR:
893 flag.enabled(cur.innerInsetOfType(TABULAR_CODE));
897 case LFUN_LAYOUT_PARAGRAPH:
898 flag.enabled(cur.inset().allowParagraphCustomization(cur.idx()));
901 case LFUN_INSET_SETTINGS: {
902 InsetCode code = cur.inset().lyxCode();
906 enable = cmd.argument() == "tabular";
909 enable = cmd.argument() == "ert";
912 enable = cmd.argument() == "float";
915 enable = cmd.argument() == "wrap";
918 enable = cmd.argument() == "note";
921 enable = cmd.argument() == "branch";
924 enable = cmd.argument() == "box";
927 enable = cmd.argument() == "listings";
932 flag.enabled(enable);
936 case LFUN_DIALOG_SHOW_NEW_INSET:
937 flag.enabled(cur.inset().lyxCode() != ERT_CODE &&
938 cur.inset().lyxCode() != LISTINGS_CODE);
939 if (cur.inset().lyxCode() == CAPTION_CODE) {
941 if (cur.inset().getStatus(cur, cmd, flag))
954 bool BufferView::dispatch(FuncRequest const & cmd)
956 //lyxerr << [ cmd = " << cmd << "]" << endl;
958 // Make sure that the cached BufferView is correct.
959 LYXERR(Debug::ACTION, " action[" << cmd.action << ']'
960 << " arg[" << to_utf8(cmd.argument()) << ']'
961 << " x[" << cmd.x << ']'
962 << " y[" << cmd.y << ']'
963 << " button[" << cmd.button() << ']');
965 Cursor & cur = d->cursor_;
967 switch (cmd.action) {
970 cur.message(_("Undo"));
971 cur.clearSelection();
973 cur.message(_("No further undo information"));
975 processUpdateFlags(Update::Force | Update::FitCursor);
979 cur.message(_("Redo"));
980 cur.clearSelection();
982 cur.message(_("No further redo information"));
984 processUpdateFlags(Update::Force | Update::FitCursor);
987 case LFUN_FONT_STATE:
988 cur.message(cur.currentState());
991 case LFUN_BOOKMARK_SAVE:
992 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
995 case LFUN_LABEL_GOTO: {
996 docstring label = cmd.argument();
999 getInsetByCode<InsetRef>(d->cursor_,
1002 label = inset->getParam("reference");
1003 // persistent=false: use temp_bookmark
1013 case LFUN_PARAGRAPH_GOTO: {
1014 int const id = convert<int>(to_utf8(cmd.argument()));
1016 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1017 b = theBufferList().next(b)) {
1019 DocIterator dit = b->getParFromID(id);
1021 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1025 LYXERR(Debug::INFO, "Paragraph " << dit.paragraph().id()
1026 << " found in buffer `"
1027 << b->absFileName() << "'.");
1029 if (b == &buffer_) {
1032 processUpdateFlags(Update::Force | Update::FitCursor);
1034 // Switch to other buffer view and resend cmd
1035 theLyXFunc().dispatch(FuncRequest(
1036 LFUN_BUFFER_SWITCH, b->absFileName()));
1037 theLyXFunc().dispatch(cmd);
1044 case LFUN_NOTE_NEXT:
1045 gotoInset(this, NOTE_CODE, false);
1048 case LFUN_REFERENCE_NEXT: {
1049 vector<InsetCode> tmp;
1050 tmp.push_back(LABEL_CODE);
1051 tmp.push_back(REF_CODE);
1052 gotoInset(this, tmp, true);
1056 case LFUN_CHANGES_TRACK:
1057 buffer_.params().trackChanges = !buffer_.params().trackChanges;
1060 case LFUN_CHANGES_OUTPUT:
1061 buffer_.params().outputChanges = !buffer_.params().outputChanges;
1062 if (buffer_.params().outputChanges) {
1063 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1064 bool xcolorsoul = LaTeXFeatures::isAvailable("soul") &&
1065 LaTeXFeatures::isAvailable("xcolor");
1067 if (!dvipost && !xcolorsoul) {
1068 Alert::warning(_("Changes not shown in LaTeX output"),
1069 _("Changes will not be highlighted in LaTeX output, "
1070 "because neither dvipost nor xcolor/soul are installed.\n"
1071 "Please install these packages or redefine "
1072 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1073 } else if (!xcolorsoul) {
1074 Alert::warning(_("Changes not shown in LaTeX output"),
1075 _("Changes will not be highlighted in LaTeX output "
1076 "when using pdflatex, because xcolor and soul are not installed.\n"
1077 "Please install both packages or redefine "
1078 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1083 case LFUN_CHANGE_NEXT:
1084 findNextChange(this);
1087 case LFUN_CHANGES_MERGE:
1088 if (findNextChange(this))
1089 showDialog("changes");
1092 case LFUN_ALL_CHANGES_ACCEPT:
1093 // select complete document
1094 d->cursor_.reset(buffer_.inset());
1095 d->cursor_.selHandle(true);
1096 buffer_.text().cursorBottom(d->cursor_);
1097 // accept everything in a single step to support atomic undo
1098 buffer_.text().acceptOrRejectChanges(d->cursor_, Text::ACCEPT);
1101 case LFUN_ALL_CHANGES_REJECT:
1102 // select complete document
1103 d->cursor_.reset(buffer_.inset());
1104 d->cursor_.selHandle(true);
1105 buffer_.text().cursorBottom(d->cursor_);
1106 // reject everything in a single step to support atomic undo
1107 // Note: reject does not work recursively; the user may have to repeat the operation
1108 buffer_.text().acceptOrRejectChanges(d->cursor_, Text::REJECT);
1111 case LFUN_WORD_FIND:
1112 if (find(this, cmd))
1115 message(_("String not found!"));
1118 case LFUN_WORD_REPLACE: {
1119 bool has_deleted = false;
1120 if (cur.selection()) {
1121 DocIterator beg = cur.selectionBegin();
1122 DocIterator end = cur.selectionEnd();
1123 if (beg.pit() == end.pit()) {
1124 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1125 if (cur.paragraph().isDeleted(p))
1130 replace(this, cmd, has_deleted);
1135 cur.clearSelection();
1137 cur.message(from_utf8(N_("Mark off")));
1141 cur.clearSelection();
1144 cur.message(from_utf8(N_("Mark on")));
1147 case LFUN_MARK_TOGGLE:
1148 cur.clearSelection();
1151 cur.message(from_utf8(N_("Mark removed")));
1154 cur.message(from_utf8(N_("Mark set")));
1159 case LFUN_SCREEN_RECENTER:
1163 case LFUN_BIBTEX_DATABASE_ADD: {
1164 Cursor tmpcur = d->cursor_;
1165 findInset(tmpcur, BIBTEX_CODE, false);
1166 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1169 if (inset->addDatabase(to_utf8(cmd.argument())))
1170 buffer_.updateBibfilesCache();
1175 case LFUN_BIBTEX_DATABASE_DEL: {
1176 Cursor tmpcur = d->cursor_;
1177 findInset(tmpcur, BIBTEX_CODE, false);
1178 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1181 if (inset->delDatabase(to_utf8(cmd.argument())))
1182 buffer_.updateBibfilesCache();
1187 case LFUN_STATISTICS: {
1188 DocIterator from, to;
1189 if (cur.selection()) {
1190 from = cur.selectionBegin();
1191 to = cur.selectionEnd();
1193 from = doc_iterator_begin(buffer_.inset());
1194 to = doc_iterator_end(buffer_.inset());
1196 int const words = countWords(from, to);
1197 int const chars = countChars(from, to, false);
1198 int const chars_blanks = countChars(from, to, true);
1200 if (cur.selection())
1201 message = _("Statistics for the selection:");
1203 message = _("Statistics for the document:");
1206 message += bformat(_("%1$d words"), words);
1208 message += _("One word");
1210 if (chars_blanks != 1)
1211 message += bformat(_("%1$d characters (including blanks)"),
1214 message += _("One character (including blanks)");
1217 message += bformat(_("%1$d characters (excluding blanks)"),
1220 message += _("One character (excluding blanks)");
1222 Alert::information(_("Statistics"), message);
1226 case LFUN_BUFFER_TOGGLE_COMPRESSION:
1227 // turn compression on/off
1228 buffer_.params().compressed = !buffer_.params().compressed;
1231 case LFUN_BUFFER_TOGGLE_EMBEDDING: {
1232 // turn embedding on/off
1234 buffer_.embeddedFiles().enable(!buffer_.params().embedded, buffer_);
1235 } catch (ExceptionMessage const & message) {
1236 Alert::error(message.title_, message.details_);
1241 case LFUN_NEXT_INSET_TOGGLE: {
1242 // this is the real function we want to invoke
1243 FuncRequest tmpcmd = FuncRequest(LFUN_INSET_TOGGLE, cmd.origin);
1244 // if there is an inset at cursor, see whether it
1246 Inset * inset = cur.nextInset();
1248 if (inset->isActive()) {
1249 Cursor tmpcur = cur;
1250 tmpcur.pushBackward(*inset);
1251 inset->dispatch(tmpcur, tmpcmd);
1252 if (tmpcur.result().dispatched()) {
1255 } else if (inset->editable() == Inset::IS_EDITABLE) {
1256 inset->edit(cur, true);
1259 // if it did not work, try the underlying inset.
1260 if (!cur.result().dispatched())
1261 cur.dispatch(tmpcmd);
1263 if (!cur.result().dispatched())
1264 // It did not work too; no action needed.
1266 cur.clearSelection();
1267 processUpdateFlags(Update::SinglePar | Update::FitCursor);
1271 case LFUN_SCREEN_UP:
1272 case LFUN_SCREEN_DOWN: {
1273 Point p = getPos(cur, cur.boundary());
1274 if (p.y_ < 0 || p.y_ > height_) {
1275 // The cursor is off-screen so recenter before proceeding.
1277 p = getPos(cur, cur.boundary());
1279 scroll(cmd.action == LFUN_SCREEN_UP? - height_ : height_);
1280 cur.reset(buffer_.inset());
1281 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_);
1282 //FIXME: what to do with cur.x_target()?
1291 case LFUN_SCREEN_UP_SELECT:
1292 case LFUN_SCREEN_DOWN_SELECT: {
1293 // Those two are not ready yet for consumption.
1296 cur.selHandle(true);
1297 size_t initial_depth = cur.depth();
1298 Point const p = getPos(cur, cur.boundary());
1299 scroll(cmd.action == LFUN_SCREEN_UP_SELECT? - height_ : height_);
1300 // FIXME: We need to verify if the cursor stayed within an inset...
1301 //cur.reset(buffer_.inset());
1302 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_);
1304 while (cur.depth() > initial_depth) {
1307 // FIXME: we need to do a redraw again because of the selection
1308 // But no screen update is needed.
1309 d->update_strategy_ = NoScreenUpdate;
1322 docstring const BufferView::requestSelection()
1324 Cursor & cur = d->cursor_;
1326 if (!cur.selection()) {
1327 d->xsel_cache_.set = false;
1331 if (!d->xsel_cache_.set ||
1332 cur.top() != d->xsel_cache_.cursor ||
1333 cur.anchor_.top() != d->xsel_cache_.anchor)
1335 d->xsel_cache_.cursor = cur.top();
1336 d->xsel_cache_.anchor = cur.anchor_.top();
1337 d->xsel_cache_.set = cur.selection();
1338 return cur.selectionAsString(false);
1344 void BufferView::clearSelection()
1346 d->cursor_.clearSelection();
1347 // Clear the selection buffer. Otherwise a subsequent
1348 // middle-mouse-button paste would use the selection buffer,
1349 // not the more current external selection.
1350 cap::clearSelection();
1351 d->xsel_cache_.set = false;
1352 // The buffer did not really change, but this causes the
1353 // redraw we need because we cleared the selection above.
1358 void BufferView::resize(int width, int height)
1360 // Update from work area
1364 // Clear the paragraph height cache.
1365 d->par_height_.clear();
1366 // Redo the metrics.
1371 Inset const * BufferView::getCoveringInset(Text const & text,
1374 TextMetrics & tm = d->text_metrics_[&text];
1375 Inset * inset = tm.checkInsetHit(x, y);
1379 if (!inset->descendable())
1380 // No need to go further down if the inset is not
1384 size_t cell_number = inset->nargs();
1385 // Check all the inner cell.
1386 for (size_t i = 0; i != cell_number; ++i) {
1387 Text const * inner_text = inset->getText(i);
1390 Inset const * inset_deeper =
1391 getCoveringInset(*inner_text, x, y);
1393 return inset_deeper;
1401 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
1403 //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
1405 // This is only called for mouse related events including
1406 // LFUN_FILE_OPEN generated by drag-and-drop.
1407 FuncRequest cmd = cmd0;
1410 cur.push(buffer_.inset());
1411 cur.selection() = d->cursor_.selection();
1413 // Either the inset under the cursor or the
1414 // surrounding Text will handle this event.
1416 // make sure we stay within the screen...
1417 cmd.y = min(max(cmd.y, -1), height_);
1419 if (cmd.action == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
1421 // Get inset under mouse, if there is one.
1422 Inset const * covering_inset =
1423 getCoveringInset(buffer_.text(), cmd.x, cmd.y);
1424 if (covering_inset == d->last_inset_)
1425 // Same inset, no need to do anything...
1428 bool need_redraw = false;
1429 // const_cast because of setMouseHover().
1430 Inset * inset = const_cast<Inset *>(covering_inset);
1432 // Remove the hint on the last hovered inset (if any).
1433 need_redraw |= d->last_inset_->setMouseHover(false);
1435 // Highlighted the newly hovered inset (if any).
1436 need_redraw |= inset->setMouseHover(true);
1437 d->last_inset_ = inset;
1441 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
1442 << cmd.x << ", " << cmd.y << ")");
1444 d->update_strategy_ = DecorationUpdate;
1446 // This event (moving without mouse click) is not passed further.
1447 // This should be changed if it is further utilized.
1452 // Build temporary cursor.
1453 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x, cmd.y);
1455 // Put anchor at the same position.
1458 // Try to dispatch to an non-editable inset near this position
1459 // via the temp cursor. If the inset wishes to change the real
1460 // cursor it has to do so explicitly by using
1461 // cur.bv().cursor() = cur; (or similar)
1463 inset->dispatch(cur, cmd);
1465 // Now dispatch to the temporary cursor. If the real cursor should
1466 // be modified, the inset's dispatch has to do so explicitly.
1467 if (!cur.result().dispatched())
1470 //Do we have a selection?
1471 theSelection().haveSelection(cursor().selection());
1473 // If the command has been dispatched,
1474 if (cur.result().dispatched()
1475 // an update is asked,
1476 && cur.result().update())
1477 processUpdateFlags(cur.result().update());
1481 void BufferView::lfunScroll(FuncRequest const & cmd)
1483 string const scroll_type = cmd.getArg(0);
1484 int const scroll_step =
1485 (scroll_type == "line")? d->scrollbarParameters_.single_step
1486 : (scroll_type == "page")? d->scrollbarParameters_.page_step : 0;
1487 if (scroll_step == 0)
1489 string const scroll_quantity = cmd.getArg(1);
1490 if (scroll_quantity == "up")
1491 scrollUp(scroll_step);
1492 else if (scroll_quantity == "down")
1493 scrollDown(scroll_step);
1495 int const scroll_value = convert<int>(scroll_quantity);
1497 scroll(scroll_step * scroll_value);
1502 void BufferView::scroll(int y)
1511 void BufferView::scrollDown(int offset)
1513 Text * text = &buffer_.text();
1514 TextMetrics & tm = d->text_metrics_[text];
1515 int ymax = height_ + offset;
1517 pair<pit_type, ParagraphMetrics const *> last = tm.last();
1518 int bottom_pos = last.second->position() + last.second->descent();
1519 if (last.first + 1 == int(text->paragraphs().size())) {
1520 if (bottom_pos <= height_)
1522 offset = min(offset, bottom_pos - height_);
1525 if (bottom_pos > ymax)
1527 tm.newParMetricsDown();
1529 d->anchor_ypos_ -= offset;
1535 void BufferView::scrollUp(int offset)
1537 Text * text = &buffer_.text();
1538 TextMetrics & tm = d->text_metrics_[text];
1539 int ymin = - offset;
1541 pair<pit_type, ParagraphMetrics const *> first = tm.first();
1542 int top_pos = first.second->position() - first.second->ascent();
1543 if (first.first == 0) {
1546 offset = min(offset, - top_pos);
1551 tm.newParMetricsUp();
1553 d->anchor_ypos_ += offset;
1559 void BufferView::setCursorFromRow(int row)
1564 buffer_.texrow().getIdFromRow(row, tmpid, tmppos);
1566 d->cursor_.reset(buffer_.inset());
1568 buffer_.text().setCursor(d->cursor_, 0, 0);
1570 buffer_.text().setCursor(d->cursor_, buffer_.getParFromID(tmpid).pit(), tmppos);
1574 void BufferView::gotoLabel(docstring const & label)
1576 for (InsetIterator it = inset_iterator_begin(buffer_.inset()); it; ++it) {
1577 vector<docstring> labels;
1578 it->getLabelList(buffer_, labels);
1579 if (std::find(labels.begin(), labels.end(), label) != labels.end()) {
1588 TextMetrics const & BufferView::textMetrics(Text const * t) const
1590 return const_cast<BufferView *>(this)->textMetrics(t);
1594 TextMetrics & BufferView::textMetrics(Text const * t)
1596 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
1597 if (tmc_it == d->text_metrics_.end()) {
1598 tmc_it = d->text_metrics_.insert(
1599 make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
1601 return tmc_it->second;
1605 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
1608 return textMetrics(t).parMetrics(pit);
1612 int BufferView::workHeight() const
1618 void BufferView::setCursor(DocIterator const & dit)
1620 size_t const n = dit.depth();
1621 for (size_t i = 0; i < n; ++i)
1622 dit[i].inset().edit(d->cursor_, true);
1624 d->cursor_.setCursor(dit);
1625 d->cursor_.selection() = false;
1629 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
1631 // Would be wrong to delete anything if we have a selection.
1632 if (cur.selection())
1635 bool need_anchor_change = false;
1636 bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
1637 need_anchor_change);
1639 if (need_anchor_change)
1647 updateLabels(buffer_);
1655 bool BufferView::mouseSetCursor(Cursor & cur, bool select)
1657 BOOST_ASSERT(&cur.bv() == this);
1660 // this event will clear selection so we save selection for
1661 // persistent selection
1662 cap::saveSelection(cursor());
1664 // Has the cursor just left the inset?
1665 bool badcursor = false;
1666 bool leftinset = (&d->cursor_.inset() != &cur.inset());
1668 badcursor = notifyCursorLeaves(d->cursor_, cur);
1670 // FIXME: shift-mouse selection doesn't work well across insets.
1671 bool do_selection = select && &d->cursor_.anchor().inset() == &cur.inset();
1673 // do the dEPM magic if needed
1674 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
1675 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
1676 // the leftinset bool would not be necessary (badcursor instead).
1677 bool update = leftinset;
1678 if (!do_selection && !badcursor && d->cursor_.inTexted())
1679 update |= checkDepm(cur, d->cursor_);
1681 // if the cursor was in an empty script inset and the new
1682 // position is in the nucleus of the inset, notifyCursorLeaves
1683 // will kill the script inset itself. So we check all the
1684 // elements of the cursor to make sure that they are correct.
1685 // For an example, see bug 2933:
1686 // http://bugzilla.lyx.org/show_bug.cgi?id=2933
1687 // The code below could maybe be moved to a DocIterator method.
1688 //lyxerr << "cur before " << cur << endl;
1689 DocIterator dit = doc_iterator_begin(cur.inset());
1690 dit.bottom() = cur.bottom();
1692 while (i < cur.depth() && dit.nextInset() == &cur[i].inset()) {
1693 dit.push_back(cur[i]);
1696 //lyxerr << "5 cur after" << dit <<endl;
1698 d->cursor_.setCursor(dit);
1699 d->cursor_.boundary(cur.boundary());
1701 d->cursor_.setSelection();
1703 d->cursor_.clearSelection();
1705 d->cursor_.finishUndo();
1706 d->cursor_.setCurrentFont();
1711 void BufferView::putSelectionAt(DocIterator const & cur,
1712 int length, bool backwards)
1714 d->cursor_.clearSelection();
1720 d->cursor_.pos() += length;
1721 d->cursor_.setSelection(d->cursor_, -length);
1723 d->cursor_.setSelection(d->cursor_, length);
1725 // Ensure a redraw happens in any case because the new selection could
1726 // possibly be on the same screen as the previous selection.
1727 processUpdateFlags(Update::Force | Update::FitCursor);
1731 Cursor & BufferView::cursor()
1737 Cursor const & BufferView::cursor() const
1743 pit_type BufferView::anchor_ref() const
1745 return d->anchor_pit_;
1749 bool BufferView::singleParUpdate()
1751 Text & buftext = buffer_.text();
1752 pit_type const bottom_pit = d->cursor_.bottom().pit();
1753 TextMetrics & tm = textMetrics(&buftext);
1754 int old_height = tm.parMetrics(bottom_pit).height();
1756 // In Single Paragraph mode, rebreak only
1757 // the (main text, not inset!) paragraph containing the cursor.
1758 // (if this paragraph contains insets etc., rebreaking will
1759 // recursively descend)
1760 tm.redoParagraph(bottom_pit);
1761 ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
1762 if (pm.height() != old_height)
1763 // Paragraph height has changed so we cannot proceed to
1764 // the singlePar optimisation.
1767 d->update_strategy_ = SingleParUpdate;
1769 LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
1770 << " y2: " << pm.position() + pm.descent()
1771 << " pit: " << bottom_pit
1772 << " singlepar: 1");
1777 void BufferView::updateMetrics()
1779 Text & buftext = buffer_.text();
1780 pit_type const npit = int(buftext.paragraphs().size());
1782 // Clear out the position cache in case of full screen redraw,
1783 d->coord_cache_.clear();
1785 // Clear out paragraph metrics to avoid having invalid metrics
1786 // in the cache from paragraphs not relayouted below
1787 // The complete text metrics will be redone.
1788 d->text_metrics_.clear();
1790 TextMetrics & tm = textMetrics(&buftext);
1792 // Rebreak anchor paragraph.
1793 tm.redoParagraph(d->anchor_pit_);
1794 ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
1797 if (d->anchor_pit_ == 0) {
1798 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
1800 // Complete buffer visible? Then it's easy.
1801 if (scrollRange == 0)
1802 d->anchor_ypos_ = anchor_pm.ascent();
1804 // FIXME: Some clever handling needed to show
1805 // the _first_ paragraph up to the top if the cursor is
1806 // in the first line.
1808 anchor_pm.setPosition(d->anchor_ypos_);
1810 LYXERR(Debug::PAINTING, "metrics: "
1811 << " anchor pit = " << d->anchor_pit_
1812 << " anchor ypos = " << d->anchor_ypos_);
1814 // Redo paragraphs above anchor if necessary.
1815 int y1 = d->anchor_ypos_ - anchor_pm.ascent();
1816 // We are now just above the anchor paragraph.
1817 pit_type pit1 = d->anchor_pit_ - 1;
1818 for (; pit1 >= 0 && y1 >= 0; --pit1) {
1819 tm.redoParagraph(pit1);
1820 ParagraphMetrics & pm = tm.par_metrics_[pit1];
1822 // Save the paragraph position in the cache.
1827 // Redo paragraphs below the anchor if necessary.
1828 int y2 = d->anchor_ypos_ + anchor_pm.descent();
1829 // We are now just below the anchor paragraph.
1830 pit_type pit2 = d->anchor_pit_ + 1;
1831 for (; pit2 < npit && y2 <= height_; ++pit2) {
1832 tm.redoParagraph(pit2);
1833 ParagraphMetrics & pm = tm.par_metrics_[pit2];
1835 // Save the paragraph position in the cache.
1840 LYXERR(Debug::PAINTING, "Metrics: "
1841 << " anchor pit = " << d->anchor_pit_
1842 << " anchor ypos = " << d->anchor_ypos_
1845 << " pit1 = " << pit1
1846 << " pit2 = " << pit2);
1848 d->update_strategy_ = FullScreenUpdate;
1850 if (lyxerr.debugging(Debug::WORKAREA)) {
1851 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
1852 d->coord_cache_.dump();
1857 void BufferView::insertLyXFile(FileName const & fname)
1859 BOOST_ASSERT(d->cursor_.inTexted());
1861 // Get absolute path of file and add ".lyx"
1862 // to the filename if necessary
1863 FileName filename = fileSearch(string(), fname.absFilename(), "lyx");
1865 docstring const disp_fn = makeDisplayPath(filename.absFilename());
1866 // emit message signal.
1867 message(bformat(_("Inserting document %1$s..."), disp_fn));
1870 Buffer buf("", false);
1871 if (buf.loadLyXFile(filename)) {
1872 ErrorList & el = buffer_.errorList("Parse");
1873 // Copy the inserted document error list into the current buffer one.
1874 el = buf.errorList("Parse");
1875 buffer_.undo().recordUndo(d->cursor_);
1876 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
1877 buf.params().getTextClassPtr(), el);
1878 res = _("Document %1$s inserted.");
1880 res = _("Could not insert document %1$s");
1885 // emit message signal.
1886 message(bformat(res, disp_fn));
1887 buffer_.errors("Parse");
1891 Point BufferView::coordOffset(DocIterator const & dit, bool boundary) const
1897 // Addup contribution of nested insets, from inside to outside,
1898 // keeping the outer paragraph for a special handling below
1899 for (size_t i = dit.depth() - 1; i >= 1; --i) {
1900 CursorSlice const & sl = dit[i];
1904 // get relative position inside sl.inset()
1905 sl.inset().cursorPos(*this, sl, boundary && (i + 1 == dit.depth()), xx, yy);
1907 // Make relative position inside of the edited inset relative to sl.inset()
1911 // In case of an RTL inset, the edited inset will be positioned to the left
1914 bool boundary_i = boundary && i + 1 == dit.depth();
1915 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
1920 // remember width for the case that sl.inset() is positioned in an RTL inset
1921 if (i && dit[i - 1].text()) {
1922 // If this Inset is inside a Text Inset, retrieve the Dimension
1923 // from the containing text instead of using Inset::dimension() which
1924 // might not be implemented.
1925 // FIXME (Abdel 23/09/2007): this is a bit messy because of the
1926 // elimination of Inset::dim_ cache. This coordOffset() method needs
1927 // to be rewritten in light of the new design.
1928 Dimension const & dim = parMetrics(dit[i - 1].text(),
1929 dit[i - 1].pit()).insetDimension(&sl.inset());
1932 Dimension const dim = sl.inset().dimension(*this);
1936 //lyxerr << "Cursor::getPos, i: "
1937 // << i << " x: " << xx << " y: " << y << endl;
1940 // Add contribution of initial rows of outermost paragraph
1941 CursorSlice const & sl = dit[0];
1942 TextMetrics const & tm = textMetrics(sl.text());
1943 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
1944 BOOST_ASSERT(!pm.rows().empty());
1945 y -= pm.rows()[0].ascent();
1947 // FIXME: document this mess
1949 if (sl.pos() > 0 && dit.depth() == 1) {
1951 if (pos && boundary)
1953 // lyxerr << "coordOffset: boundary:" << boundary << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
1954 rend = pm.pos2row(pos);
1956 rend = pm.pos2row(sl.pos());
1958 size_t rend = pm.pos2row(sl.pos());
1960 for (size_t rit = 0; rit != rend; ++rit)
1961 y += pm.rows()[rit].height();
1962 y += pm.rows()[rend].ascent();
1964 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
1966 // Make relative position from the nested inset now bufferview absolute.
1967 int xx = bottom_tm.cursorX(dit.bottom(), boundary && dit.depth() == 1);
1970 // In the RTL case place the nested inset at the left of the cursor in
1971 // the outer paragraph
1972 bool boundary_1 = boundary && 1 == dit.depth();
1973 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
1981 Point BufferView::getPos(DocIterator const & dit, bool boundary) const
1983 CursorSlice const & bot = dit.bottom();
1984 TextMetrics const & tm = textMetrics(bot.text());
1985 if (!tm.has(bot.pit()))
1986 return Point(-1, -1);
1988 Point p = coordOffset(dit, boundary); // offset from outer paragraph
1989 p.y_ += tm.parMetrics(bot.pit()).position();
1994 void BufferView::draw(frontend::Painter & pain)
1996 LYXERR(Debug::PAINTING, "\t\t*** START DRAWING ***");
1997 Text & text = buffer_.text();
1998 TextMetrics const & tm = d->text_metrics_[&text];
1999 int const y = tm.first().second->position();
2000 PainterInfo pi(this, pain);
2002 switch (d->update_strategy_) {
2004 case NoScreenUpdate:
2005 // If no screen painting is actually needed, only some the different
2006 // coordinates of insets and paragraphs needs to be updated.
2007 pi.full_repaint = true;
2008 pi.pain.setDrawingEnabled(false);
2012 case SingleParUpdate:
2013 pi.full_repaint = false;
2014 // In general, only the current row of the outermost paragraph
2015 // will be redrawn. Particular cases where selection spans
2016 // multiple paragraph are correctly detected in TextMetrics.
2020 case DecorationUpdate:
2021 // FIXME: We should also distinguish DecorationUpdate to avoid text
2022 // drawing if possible. This is not possible to do easily right now
2023 // because of the single backing pixmap.
2025 case FullScreenUpdate:
2026 // The whole screen, including insets, will be refreshed.
2027 pi.full_repaint = true;
2029 // Clear background.
2030 pain.fillRectangle(0, 0, width_, height_,
2031 buffer_.inset().backgroundColor());
2036 // and possibly grey out below
2037 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2038 int const y2 = lastpm.second->position() + lastpm.second->descent();
2040 pain.fillRectangle(0, y2, width_, height_ - y2, Color_bottomarea);
2043 LYXERR(Debug::PAINTING, "\n\t\t*** END DRAWING ***");
2045 // The scrollbar needs an update.
2048 // Normalize anchor for next time
2049 pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
2050 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2051 for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
2052 ParagraphMetrics const & pm = tm.parMetrics(pit);
2053 if (pm.position() + pm.descent() > 0) {
2054 d->anchor_pit_ = pit;
2055 d->anchor_ypos_ = pm.position();
2059 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
2060 << " anchor ypos = " << d->anchor_ypos_);
2064 void BufferView::message(docstring const & msg)
2067 d->gui_->message(msg);
2071 void BufferView::showDialog(string const & name)
2074 d->gui_->showDialog(name, string());
2078 void BufferView::showDialog(string const & name,
2079 string const & data, Inset * inset)
2082 d->gui_->showDialog(name, data, inset);
2086 void BufferView::updateDialog(string const & name, string const & data)
2089 d->gui_->updateDialog(name, data);
2093 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
2099 // FIXME: Move this out of BufferView again
2100 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
2102 if (!fname.isReadableFile()) {
2103 docstring const error = from_ascii(strerror(errno));
2104 docstring const file = makeDisplayPath(fname.absFilename(), 50);
2105 docstring const text =
2106 bformat(_("Could not read the specified document\n"
2107 "%1$s\ndue to the error: %2$s"), file, error);
2108 Alert::error(_("Could not read file"), text);
2112 if (!fname.isReadableFile()) {
2113 docstring const file = makeDisplayPath(fname.absFilename(), 50);
2114 docstring const text =
2115 bformat(_("%1$s\n is not readable."), file);
2116 Alert::error(_("Could not open file"), text);
2120 // FIXME UNICODE: We don't know the encoding of the file
2121 docstring file_content = fname.fileContents("UTF-8");
2122 if (file_content.empty()) {
2123 Alert::error(_("Reading not UTF-8 encoded file"),
2124 _("The file is not UTF-8 encoded.\n"
2125 "It will be read as local 8Bit-encoded.\n"
2126 "If this does not give the correct result\n"
2127 "then please change the encoding of the file\n"
2128 "to UTF-8 with a program other than LyX.\n"));
2129 file_content = fname.fileContents("local8bit");
2132 return normalize_c(file_content);
2136 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
2138 docstring const tmpstr = contentsOfPlaintextFile(f);
2143 Cursor & cur = cursor();
2144 cap::replaceSelection(cur);
2145 buffer_.undo().recordUndo(cur);
2147 cur.innerText()->insertStringAsParagraphs(cur, tmpstr);
2149 cur.innerText()->insertStringAsLines(cur, tmpstr);