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/FileFilterList.h"
73 #include "support/filetools.h"
74 #include "support/gettext.h"
75 #include "support/lstrings.h"
76 #include "support/Package.h"
77 #include "support/types.h"
86 using namespace lyx::support;
90 namespace Alert = frontend::Alert;
94 /// Return an inset of this class if it exists at the current cursor position
96 T * getInsetByCode(Cursor const & cur, InsetCode code)
99 Inset * inset = it.nextInset();
100 if (inset && inset->lyxCode() == code)
101 return static_cast<T*>(inset);
106 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
109 bool findNextInset(DocIterator & dit, vector<InsetCode> const & codes,
110 docstring const & contents)
112 DocIterator tmpdit = dit;
115 Inset const * inset = tmpdit.nextInset();
117 && find(codes.begin(), codes.end(), inset->lyxCode()) != codes.end()
118 && (contents.empty() ||
119 static_cast<InsetCommand const *>(inset)->getFirstNonOptParam() == contents)) {
123 tmpdit.forwardInset();
130 /// Looks for next inset with one of the given codes.
131 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
135 DocIterator tmpdit = dit;
136 tmpdit.forwardInset();
141 Inset const * inset = tmpdit.nextInset();
143 && find(codes.begin(), codes.end(), inset->lyxCode()) != codes.end()) {
144 contents = static_cast<InsetCommand const *>(inset)->getFirstNonOptParam();
148 if (!findNextInset(tmpdit, codes, contents)) {
149 if (dit.depth() != 1 || dit.pit() != 0 || dit.pos() != 0) {
150 tmpdit = doc_iterator_begin(tmpdit.bottom().inset());
151 if (!findNextInset(tmpdit, codes, contents))
162 /// Looks for next inset with the given code
163 void findInset(DocIterator & dit, InsetCode code, bool same_content)
165 findInset(dit, vector<InsetCode>(1, code), same_content);
169 /// Moves cursor to the next inset with one of the given codes.
170 void gotoInset(BufferView * bv, vector<InsetCode> const & codes,
173 Cursor tmpcur = bv->cursor();
174 if (!findInset(tmpcur, codes, same_content)) {
175 bv->cursor().message(_("No more insets"));
179 tmpcur.clearSelection();
180 bv->setCursor(tmpcur);
185 /// Moves cursor to the next inset with given code.
186 void gotoInset(BufferView * bv, InsetCode code, bool same_content)
188 gotoInset(bv, vector<InsetCode>(1, code), same_content);
192 /// A map from a Text to the associated text metrics
193 typedef map<Text const *, TextMetrics> TextMetricsCache;
195 enum ScreenUpdateStrategy {
205 /////////////////////////////////////////////////////////////////////
209 /////////////////////////////////////////////////////////////////////
211 struct BufferView::Private
213 Private(BufferView & bv): wh_(0), cursor_(bv),
214 anchor_pit_(0), anchor_ypos_(0),
215 last_inset_(0), gui_(0)
219 ScrollbarParameters scrollbarParameters_;
221 ScreenUpdateStrategy update_strategy_;
223 CoordCache coord_cache_;
225 /// Estimated average par height for scrollbar.
227 /// this is used to handle XSelection events in the right manner.
236 pit_type anchor_pit_;
240 vector<int> par_height_;
242 /// keyboard mapping object.
245 /// last visited inset.
246 /** kept to send setMouseHover(false).
247 * Not owned, so don't delete.
251 mutable TextMetricsCache text_metrics_;
254 /** Not owned, so don't delete.
256 frontend::GuiBufferViewDelegate * gui_;
260 BufferView::BufferView(Buffer & buf)
261 : width_(0), height_(0), buffer_(buf), d(new Private(*this))
263 d->xsel_cache_.set = false;
264 d->intl_.initKeyMapper(lyxrc.use_kbmap);
266 d->cursor_.push(buffer_.inset());
267 d->cursor_.resetAnchor();
268 d->cursor_.setCurrentFont();
270 if (graphics::Previews::status() != LyXRC::PREVIEW_OFF)
271 graphics::Previews::get().generateBufferPreviews(buffer_);
275 BufferView::~BufferView()
277 // current buffer is going to be switched-off, save cursor pos
278 // Ideally, the whole cursor stack should be saved, but session
279 // currently can only handle bottom (whole document) level pit and pos.
280 // That is to say, if a cursor is in a nested inset, it will be
281 // restore to the left of the top level inset.
282 LastFilePosSection::FilePos fp;
283 fp.pit = d->cursor_.bottom().pit();
284 fp.pos = d->cursor_.bottom().pos();
285 LyX::ref().session().lastFilePos().save(buffer_.fileName(), fp);
291 Intl & BufferView::getIntl()
297 Intl const & BufferView::getIntl() const
303 CoordCache & BufferView::coordCache()
305 return d->coord_cache_;
309 CoordCache const & BufferView::coordCache() const
311 return d->coord_cache_;
315 Buffer & BufferView::buffer()
321 Buffer const & BufferView::buffer() const
327 bool BufferView::fitCursor()
329 if (cursorStatus(d->cursor_) == CUR_INSIDE) {
330 frontend::FontMetrics const & fm =
331 theFontMetrics(d->cursor_.getFont().fontInfo());
332 int const asc = fm.maxAscent();
333 int const des = fm.maxDescent();
334 Point const p = getPos(d->cursor_, d->cursor_.boundary());
335 if (p.y_ - asc >= 0 && p.y_ + des < height_)
342 void BufferView::processUpdateFlags(Update::flags flags)
344 // last_inset_ points to the last visited inset. This pointer may become
345 // invalid because of keyboard editing. Since all such operations
346 // causes screen update(), I reset last_inset_ to avoid such a problem.
348 // This is close to a hot-path.
349 LYXERR(Debug::DEBUG, "BufferView::processUpdateFlags()"
350 << "[fitcursor = " << (flags & Update::FitCursor)
351 << ", forceupdate = " << (flags & Update::Force)
352 << ", singlepar = " << (flags & Update::SinglePar)
353 << "] buffer: " << &buffer_);
355 buffer_.updateMacros();
357 // Now do the first drawing step if needed. This consists on updating
358 // the CoordCache in updateMetrics().
359 // The second drawing step is done in WorkArea::redraw() if needed.
361 // Case when no explicit update is requested.
363 // no need to redraw anything.
364 d->update_strategy_ = NoScreenUpdate;
368 if (flags == Update::Decoration) {
369 d->update_strategy_ = DecorationUpdate;
374 if (flags == Update::FitCursor
375 || flags == (Update::Decoration | Update::FitCursor)) {
376 // tell the frontend to update the screen if needed.
381 if (flags & Update::Decoration) {
382 d->update_strategy_ = DecorationUpdate;
386 // no screen update is needed.
387 d->update_strategy_ = NoScreenUpdate;
391 bool const full_metrics = flags & Update::Force || !singleParUpdate();
394 // We have to update the full screen metrics.
397 if (!(flags & Update::FitCursor)) {
398 // Nothing to do anymore. Trigger a redraw and return
403 // updateMetrics() does not update paragraph position
404 // This is done at draw() time. So we need a redraw!
408 // The cursor is off screen so ensure it is visible.
415 void BufferView::updateScrollbar()
420 Text & t = buffer_.text();
421 TextMetrics & tm = d->text_metrics_[&t];
423 LYXERR(Debug::GUI, " Updating scrollbar: height: "
424 << t.paragraphs().size()
425 << " curr par: " << d->cursor_.bottom().pit()
426 << " default height " << defaultRowHeight());
428 int const parsize = int(t.paragraphs().size());
429 if (d->par_height_.size() != parsize) {
430 d->par_height_.clear();
431 // FIXME: We assume a default paragraph height of 2 rows. This
432 // should probably be pondered with the screen width.
433 d->par_height_.resize(parsize, defaultRowHeight() * 2);
436 // It would be better to fix the scrollbar to understand
437 // values in [0..1] and divide everything by wh
439 // Look at paragraph heights on-screen
440 pit_type first_visible_pit = -1;
441 pair<pit_type, ParagraphMetrics const *> first = tm.first();
442 pair<pit_type, ParagraphMetrics const *> last = tm.last();
443 for (pit_type pit = first.first; pit <= last.first; ++pit) {
444 ParagraphMetrics const & pm = tm.parMetrics(pit);
445 d->par_height_[pit] = pm.height();
446 if (first_visible_pit >= 0 || pm.position() + pm.descent() <= 0)
448 first_visible_pit = pit;
449 LYXERR(Debug::SCROLLING, "first visible pit " << first_visible_pit);
450 // FIXME: we should look for the first visible row within
451 // the deepest inset!
452 int row_pos = pm.position();
453 size_t const nrows = pm.rows().size();
454 for (size_t i = 0; i != nrows; ++i) {
455 Row const & row = pm.rows()[i];
457 LYXERR(Debug::SCROLLING, "first visible row " << i
458 << "(row pos = " << row_pos << ");");
461 row_pos += row.height();
463 d->scrollbarParameters_.position = row_pos;
466 d->scrollbarParameters_.height = 0;
467 for (size_t i = 0; i != d->par_height_.size(); ++i) {
468 if (i == first_visible_pit)
469 d->scrollbarParameters_.position += d->scrollbarParameters_.height;
470 d->scrollbarParameters_.height += d->par_height_[i];
473 // We prefer fixed size line scrolling.
474 d->scrollbarParameters_.lineScrollHeight = defaultRowHeight();
478 ScrollbarParameters const & BufferView::scrollbarParameters() const
480 return d->scrollbarParameters_;
484 docstring BufferView::toolTip(int x, int y) const
486 // Get inset under mouse, if there is one.
487 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
489 // No inset, no tooltip...
491 return covering_inset->toolTip(*this, x, y);
495 docstring BufferView::contextMenu(int x, int y) const
497 // Get inset under mouse, if there is one.
498 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
500 return covering_inset->contextMenu(*this, x, y);
502 // FIXME: Do something more elaborate here.
503 return from_ascii("edit");
507 void BufferView::scrollDocView(int value)
509 int const offset = value - d->scrollbarParameters_.position;
510 // If the offset is less than 2 screen height, prefer to scroll instead.
511 if (abs(offset) <= 2 * height_) {
517 for (size_t i = 0; i != d->par_height_.size(); ++i) {
518 par_pos += d->par_height_[i];
519 if (par_pos >= value) {
520 d->anchor_pit_ = pit_type(i);
525 LYXERR(Debug::SCROLLING, "value = " << value
526 << "\tanchor_ref_ = " << d->anchor_pit_
527 << "\tpar_pos = " << par_pos);
529 d->anchor_ypos_ = par_pos - value;
535 // FIXME: this method is not working well.
536 void BufferView::setCursorFromScrollbar()
538 TextMetrics & tm = d->text_metrics_[&buffer_.text()];
540 int const height = 2 * defaultRowHeight();
541 int const first = height;
542 int const last = height_ - height;
543 Cursor & cur = d->cursor_;
545 switch (cursorStatus(cur)) {
547 // We reset the cursor because cursorStatus() does not
548 // work when the cursor is within mathed.
549 cur.reset(buffer_.inset());
550 tm.setCursorFromCoordinates(cur, 0, first);
551 cur.clearSelection();
554 // We reset the cursor because cursorStatus() does not
555 // work when the cursor is within mathed.
556 cur.reset(buffer_.inset());
557 tm.setCursorFromCoordinates(cur, 0, last);
558 cur.clearSelection();
561 int const y = getPos(cur, cur.boundary()).y_;
562 int const newy = min(last, max(y, first));
564 cur.reset(buffer_.inset());
565 tm.setCursorFromCoordinates(cur, 0, newy);
571 Change const BufferView::getCurrentChange() const
573 if (!d->cursor_.selection())
574 return Change(Change::UNCHANGED);
576 DocIterator dit = d->cursor_.selectionBegin();
577 return dit.paragraph().lookupChange(dit.pos());
581 // this could be used elsewhere as well?
582 // FIXME: This does not work within mathed!
583 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
585 Point const p = getPos(dit, dit.boundary());
588 if (p.y_ > workHeight())
594 void BufferView::saveBookmark(unsigned int idx)
596 // tenatively save bookmark, id and pos will be used to
597 // acturately locate a bookmark in a 'live' lyx session.
598 // pit and pos will be updated with bottom level pit/pos
600 LyX::ref().session().bookmarks().save(
602 d->cursor_.bottom().pit(),
603 d->cursor_.bottom().pos(),
604 d->cursor_.paragraph().id(),
609 // emit message signal.
610 message(_("Save bookmark"));
614 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
615 int top_id, pos_type top_pos)
617 bool success = false;
620 d->cursor_.clearSelection();
622 // if a valid par_id is given, try it first
623 // This is the case for a 'live' bookmark when unique paragraph ID
624 // is used to track bookmarks.
626 ParIterator par = buffer_.getParFromID(top_id);
627 if (par != buffer_.par_iterator_end()) {
628 doc_it = makeDocIterator(par, min(par->size(), top_pos));
629 // Some slices of the iterator may not be
630 // reachable (e.g. closed collapsable inset)
631 // so the dociterator may need to be
632 // shortened. Otherwise, setCursor may crash
633 // lyx when the cursor can not be set to these
635 size_t const n = doc_it.depth();
636 for (size_t i = 0; i < n; ++i)
637 if (doc_it[i].inset().editable() != Inset::HIGHLY_EDITABLE) {
645 // if top_id == 0, or searching through top_id failed
646 // This is the case for a 'restored' bookmark when only bottom
647 // (document level) pit was saved. Because of this, bookmark
648 // restoration is inaccurate. If a bookmark was within an inset,
649 // it will be restored to the left of the outmost inset that contains
651 if (static_cast<size_t>(bottom_pit) < buffer_.paragraphs().size()) {
652 doc_it = doc_iterator_begin(buffer_.inset());
653 doc_it.pit() = bottom_pit;
654 doc_it.pos() = min(bottom_pos, doc_it.paragraph().size());
659 // Note: only bottom (document) level pit is set.
661 // set the current font.
662 d->cursor_.setCurrentFont();
663 // To center the screen on this new position we need the
664 // paragraph position which is computed at draw() time.
665 // So we need a redraw!
675 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
677 if (lyxrc.rtl_support) {
678 if (d->cursor_.real_current_font.isRightToLeft()) {
679 if (d->intl_.keymap == Intl::PRIMARY)
680 d->intl_.keyMapSec();
682 if (d->intl_.keymap == Intl::SECONDARY)
683 d->intl_.keyMapPrim();
687 d->intl_.getTransManager().translateAndInsert(c, t, cur);
691 int BufferView::workWidth() const
697 void BufferView::showCursor()
699 // We are not properly started yet, delay until resizing is
704 LYXERR(Debug::SCROLLING, "recentering!");
706 CursorSlice & bot = d->cursor_.bottom();
707 TextMetrics & tm = d->text_metrics_[bot.text()];
709 pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
710 int bot_pit = d->cursor_.bottom().pit();
711 if (bot_pit > max_pit) {
712 // FIXME: Why does this happen?
713 LYXERR0("bottom pit is greater that max pit: "
714 << bot_pit << " > " << max_pit);
718 if (bot_pit == tm.first().first - 1)
719 tm.newParMetricsUp();
720 else if (bot_pit == tm.last().first + 1)
721 tm.newParMetricsDown();
723 if (tm.has(bot_pit)) {
724 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
725 int offset = coordOffset(d->cursor_, d->cursor_.boundary()).y_;
726 int ypos = pm.position() + offset;
727 Dimension const & row_dim = d->cursor_.textRow().dimension();
728 if (ypos - row_dim.ascent() < 0)
729 scrollUp(- ypos + row_dim.ascent());
730 else if (ypos + row_dim.descent() > height_)
731 scrollDown(ypos - height_ + row_dim.descent());
732 // else, nothing to do, the cursor is already visible so we just return.
736 tm.redoParagraph(bot_pit);
737 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
738 int offset = coordOffset(d->cursor_, d->cursor_.boundary()).y_;
740 d->anchor_pit_ = bot_pit;
741 Dimension const & row_dim = d->cursor_.textRow().dimension();
743 if (d->anchor_pit_ == 0)
744 d->anchor_ypos_ = offset + pm.ascent();
745 else if (d->anchor_pit_ == max_pit)
746 d->anchor_ypos_ = height_ - offset - row_dim.descent();
748 d->anchor_ypos_ = defaultRowHeight() * 2 - offset - row_dim.descent();
755 FuncStatus BufferView::getStatus(FuncRequest const & cmd)
759 Cursor & cur = d->cursor_;
761 switch (cmd.action) {
764 flag.enabled(buffer_.undo().hasUndoStack());
767 flag.enabled(buffer_.undo().hasRedoStack());
769 case LFUN_FILE_INSERT:
770 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
771 case LFUN_FILE_INSERT_PLAINTEXT:
772 case LFUN_BOOKMARK_SAVE:
773 // FIXME: Actually, these LFUNS should be moved to Text
774 flag.enabled(cur.inTexted());
776 case LFUN_FONT_STATE:
777 case LFUN_LABEL_INSERT:
778 case LFUN_INFO_INSERT:
779 case LFUN_PARAGRAPH_GOTO:
781 case LFUN_REFERENCE_NEXT:
783 case LFUN_WORD_REPLACE:
786 case LFUN_MARK_TOGGLE:
787 case LFUN_SCREEN_RECENTER:
788 case LFUN_BIBTEX_DATABASE_ADD:
789 case LFUN_BIBTEX_DATABASE_DEL:
790 case LFUN_STATISTICS:
791 case LFUN_NEXT_INSET_TOGGLE:
795 case LFUN_LABEL_GOTO: {
796 flag.enabled(!cmd.argument().empty()
797 || getInsetByCode<InsetRef>(cur, REF_CODE));
801 case LFUN_CHANGES_TRACK:
803 flag.setOnOff(buffer_.params().trackChanges);
806 case LFUN_CHANGES_OUTPUT:
808 flag.setOnOff(buffer_.params().outputChanges);
811 case LFUN_CHANGES_MERGE:
812 case LFUN_CHANGE_NEXT:
813 case LFUN_ALL_CHANGES_ACCEPT:
814 case LFUN_ALL_CHANGES_REJECT:
815 // TODO: context-sensitive enabling of LFUNs
816 // In principle, these command should only be enabled if there
817 // is a change in the document. However, without proper
818 // optimizations, this will inevitably result in poor performance.
822 case LFUN_BUFFER_TOGGLE_COMPRESSION: {
823 flag.setOnOff(buffer_.params().compressed);
827 case LFUN_BUFFER_TOGGLE_EMBEDDING: {
828 flag.setOnOff(buffer_.params().embedded);
833 case LFUN_SCREEN_DOWN:
838 // FIXME: LFUN_SCREEN_DOWN_SELECT should be removed from
839 // everywhere else before this can enabled:
840 case LFUN_SCREEN_UP_SELECT:
841 case LFUN_SCREEN_DOWN_SELECT:
845 case LFUN_LAYOUT_TABULAR:
846 flag.enabled(cur.innerInsetOfType(TABULAR_CODE));
850 case LFUN_LAYOUT_PARAGRAPH:
851 flag.enabled(cur.inset().forceDefaultParagraphs(cur.idx()));
854 case LFUN_INSET_SETTINGS: {
855 InsetCode code = cur.inset().lyxCode();
859 enable = cmd.argument() == "tabular";
862 enable = cmd.argument() == "ert";
865 enable = cmd.argument() == "float";
868 enable = cmd.argument() == "wrap";
871 enable = cmd.argument() == "note";
874 enable = cmd.argument() == "branch";
877 enable = cmd.argument() == "box";
880 enable = cmd.argument() == "listings";
885 flag.enabled(enable);
889 case LFUN_DIALOG_SHOW_NEW_INSET:
890 flag.enabled(cur.inset().lyxCode() != ERT_CODE &&
891 cur.inset().lyxCode() != LISTINGS_CODE);
892 if (cur.inset().lyxCode() == CAPTION_CODE) {
894 if (cur.inset().getStatus(cur, cmd, flag))
907 bool BufferView::dispatch(FuncRequest const & cmd)
909 //lyxerr << [ cmd = " << cmd << "]" << endl;
911 // Make sure that the cached BufferView is correct.
912 LYXERR(Debug::ACTION, " action[" << cmd.action << ']'
913 << " arg[" << to_utf8(cmd.argument()) << ']'
914 << " x[" << cmd.x << ']'
915 << " y[" << cmd.y << ']'
916 << " button[" << cmd.button() << ']');
918 Cursor & cur = d->cursor_;
920 switch (cmd.action) {
923 cur.message(_("Undo"));
924 cur.clearSelection();
926 cur.message(_("No further undo information"));
928 processUpdateFlags(Update::Force | Update::FitCursor);
932 cur.message(_("Redo"));
933 cur.clearSelection();
935 cur.message(_("No further redo information"));
937 processUpdateFlags(Update::Force | Update::FitCursor);
940 case LFUN_FONT_STATE:
941 cur.message(cur.currentState());
944 case LFUN_BOOKMARK_SAVE:
945 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
948 case LFUN_LABEL_GOTO: {
949 docstring label = cmd.argument();
952 getInsetByCode<InsetRef>(d->cursor_,
955 label = inset->getParam("reference");
956 // persistent=false: use temp_bookmark
966 case LFUN_PARAGRAPH_GOTO: {
967 int const id = convert<int>(to_utf8(cmd.argument()));
969 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
970 b = theBufferList().next(b)) {
972 ParIterator par = b->getParFromID(id);
973 if (par == b->par_iterator_end()) {
974 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
976 LYXERR(Debug::INFO, "Paragraph " << par->id()
977 << " found in buffer `"
978 << b->absFileName() << "'.");
982 setCursor(makeDocIterator(par, 0));
985 // Switch to other buffer view and resend cmd
986 theLyXFunc().dispatch(FuncRequest(
987 LFUN_BUFFER_SWITCH, b->absFileName()));
988 theLyXFunc().dispatch(cmd);
998 gotoInset(this, NOTE_CODE, false);
1001 case LFUN_REFERENCE_NEXT: {
1002 vector<InsetCode> tmp;
1003 tmp.push_back(LABEL_CODE);
1004 tmp.push_back(REF_CODE);
1005 gotoInset(this, tmp, true);
1009 case LFUN_CHANGES_TRACK:
1010 buffer_.params().trackChanges = !buffer_.params().trackChanges;
1013 case LFUN_CHANGES_OUTPUT:
1014 buffer_.params().outputChanges = !buffer_.params().outputChanges;
1015 if (buffer_.params().outputChanges) {
1016 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1017 bool xcolorsoul = LaTeXFeatures::isAvailable("soul") &&
1018 LaTeXFeatures::isAvailable("xcolor");
1020 if (!dvipost && !xcolorsoul) {
1021 Alert::warning(_("Changes not shown in LaTeX output"),
1022 _("Changes will not be highlighted in LaTeX output, "
1023 "because neither dvipost nor xcolor/soul are installed.\n"
1024 "Please install these packages or redefine "
1025 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1026 } else if (!xcolorsoul) {
1027 Alert::warning(_("Changes not shown in LaTeX output"),
1028 _("Changes will not be highlighted in LaTeX output "
1029 "when using pdflatex, because xcolor and soul are not installed.\n"
1030 "Please install both packages or redefine "
1031 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1036 case LFUN_CHANGE_NEXT:
1037 findNextChange(this);
1040 case LFUN_CHANGES_MERGE:
1041 if (findNextChange(this))
1042 showDialog("changes");
1045 case LFUN_ALL_CHANGES_ACCEPT:
1046 // select complete document
1047 d->cursor_.reset(buffer_.inset());
1048 d->cursor_.selHandle(true);
1049 buffer_.text().cursorBottom(d->cursor_);
1050 // accept everything in a single step to support atomic undo
1051 buffer_.text().acceptOrRejectChanges(d->cursor_, Text::ACCEPT);
1054 case LFUN_ALL_CHANGES_REJECT:
1055 // select complete document
1056 d->cursor_.reset(buffer_.inset());
1057 d->cursor_.selHandle(true);
1058 buffer_.text().cursorBottom(d->cursor_);
1059 // reject everything in a single step to support atomic undo
1060 // Note: reject does not work recursively; the user may have to repeat the operation
1061 buffer_.text().acceptOrRejectChanges(d->cursor_, Text::REJECT);
1064 case LFUN_WORD_FIND:
1068 case LFUN_WORD_REPLACE: {
1069 bool has_deleted = false;
1070 if (cur.selection()) {
1071 DocIterator beg = cur.selectionBegin();
1072 DocIterator end = cur.selectionEnd();
1073 if (beg.pit() == end.pit()) {
1074 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1075 if (cur.paragraph().isDeleted(p))
1080 replace(this, cmd, has_deleted);
1085 cur.clearSelection();
1087 cur.message(from_utf8(N_("Mark off")));
1091 cur.clearSelection();
1094 cur.message(from_utf8(N_("Mark on")));
1097 case LFUN_MARK_TOGGLE:
1098 cur.clearSelection();
1101 cur.message(from_utf8(N_("Mark removed")));
1104 cur.message(from_utf8(N_("Mark set")));
1109 case LFUN_SCREEN_RECENTER:
1113 case LFUN_BIBTEX_DATABASE_ADD: {
1114 Cursor tmpcur = d->cursor_;
1115 findInset(tmpcur, BIBTEX_CODE, false);
1116 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1119 if (inset->addDatabase(to_utf8(cmd.argument())))
1120 buffer_.updateBibfilesCache();
1125 case LFUN_BIBTEX_DATABASE_DEL: {
1126 Cursor tmpcur = d->cursor_;
1127 findInset(tmpcur, BIBTEX_CODE, false);
1128 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1131 if (inset->delDatabase(to_utf8(cmd.argument())))
1132 buffer_.updateBibfilesCache();
1137 case LFUN_STATISTICS: {
1138 DocIterator from, to;
1139 if (cur.selection()) {
1140 from = cur.selectionBegin();
1141 to = cur.selectionEnd();
1143 from = doc_iterator_begin(buffer_.inset());
1144 to = doc_iterator_end(buffer_.inset());
1146 int const words = countWords(from, to);
1147 int const chars = countChars(from, to, false);
1148 int const chars_blanks = countChars(from, to, true);
1150 if (cur.selection())
1151 message = _("Statistics for the selection:\n");
1153 message = _("Statistics for the document:\n");
1155 message += bformat(_("\n%1$d words"), words);
1157 message += _("\nOne word");
1158 if (chars_blanks != 1)
1159 message += bformat(_("\n%1$d characters (including blanks)"),
1162 message += _("\nOne character (including blanks)");
1164 message += bformat(_("\n%1$d characters (excluding blanks)"),
1167 message += _("\nOne character (excluding blanks)");
1169 Alert::information(_("Statistics"), message);
1173 case LFUN_BUFFER_TOGGLE_COMPRESSION:
1174 // turn compression on/off
1175 buffer_.params().compressed = !buffer_.params().compressed;
1178 case LFUN_BUFFER_TOGGLE_EMBEDDING: {
1179 // turn embedding on/off
1181 buffer_.embeddedFiles().enable(!buffer_.params().embedded, buffer_);
1182 } catch (ExceptionMessage const & message) {
1183 Alert::error(message.title_, message.details_);
1188 case LFUN_NEXT_INSET_TOGGLE: {
1189 // this is the real function we want to invoke
1190 FuncRequest tmpcmd = FuncRequest(LFUN_INSET_TOGGLE, cmd.origin);
1191 // if there is an inset at cursor, see whether it
1193 Inset * inset = cur.nextInset();
1195 if (inset->isActive()) {
1196 Cursor tmpcur = cur;
1197 tmpcur.pushBackward(*inset);
1198 inset->dispatch(tmpcur, tmpcmd);
1199 if (tmpcur.result().dispatched()) {
1202 } else if (inset->editable() == Inset::IS_EDITABLE) {
1203 inset->edit(cur, true);
1206 // if it did not work, try the underlying inset.
1207 if (!cur.result().dispatched())
1208 cur.dispatch(tmpcmd);
1210 if (!cur.result().dispatched())
1211 // It did not work too; no action needed.
1213 cur.clearSelection();
1214 processUpdateFlags(Update::SinglePar | Update::FitCursor);
1218 case LFUN_SCREEN_UP:
1219 case LFUN_SCREEN_DOWN: {
1220 Point p = getPos(cur, cur.boundary());
1221 if (p.y_ < 0 || p.y_ > height_) {
1222 // The cursor is off-screen so recenter before proceeding.
1224 p = getPos(cur, cur.boundary());
1226 scroll(cmd.action == LFUN_SCREEN_UP? - height_ : height_);
1227 cur.reset(buffer_.inset());
1228 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_);
1229 //FIXME: what to do with cur.x_target()?
1238 case LFUN_SCREEN_UP_SELECT:
1239 case LFUN_SCREEN_DOWN_SELECT: {
1240 // Those two are not ready yet for consumption.
1243 cur.selHandle(true);
1244 size_t initial_depth = cur.depth();
1245 Point const p = getPos(cur, cur.boundary());
1246 scroll(cmd.action == LFUN_SCREEN_UP_SELECT? - height_ : height_);
1247 // FIXME: We need to verify if the cursor stayed within an inset...
1248 //cur.reset(buffer_.inset());
1249 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_);
1251 while (cur.depth() > initial_depth) {
1254 // FIXME: we need to do a redraw again because of the selection
1255 // But no screen update is needed.
1256 d->update_strategy_ = NoScreenUpdate;
1269 docstring const BufferView::requestSelection()
1271 Cursor & cur = d->cursor_;
1273 if (!cur.selection()) {
1274 d->xsel_cache_.set = false;
1278 if (!d->xsel_cache_.set ||
1279 cur.top() != d->xsel_cache_.cursor ||
1280 cur.anchor_.top() != d->xsel_cache_.anchor)
1282 d->xsel_cache_.cursor = cur.top();
1283 d->xsel_cache_.anchor = cur.anchor_.top();
1284 d->xsel_cache_.set = cur.selection();
1285 return cur.selectionAsString(false);
1291 void BufferView::clearSelection()
1293 d->cursor_.clearSelection();
1294 // Clear the selection buffer. Otherwise a subsequent
1295 // middle-mouse-button paste would use the selection buffer,
1296 // not the more current external selection.
1297 cap::clearSelection();
1298 d->xsel_cache_.set = false;
1299 // The buffer did not really change, but this causes the
1300 // redraw we need because we cleared the selection above.
1305 void BufferView::resize(int width, int height)
1307 // Update from work area
1311 // Clear the paragraph height cache.
1312 d->par_height_.clear();
1318 Inset const * BufferView::getCoveringInset(Text const & text,
1321 TextMetrics & tm = d->text_metrics_[&text];
1322 Inset * inset = tm.checkInsetHit(x, y);
1326 if (!inset->descendable())
1327 // No need to go further down if the inset is not
1331 size_t cell_number = inset->nargs();
1332 // Check all the inner cell.
1333 for (size_t i = 0; i != cell_number; ++i) {
1334 Text const * inner_text = inset->getText(i);
1337 Inset const * inset_deeper =
1338 getCoveringInset(*inner_text, x, y);
1340 return inset_deeper;
1348 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
1350 //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
1352 // This is only called for mouse related events including
1353 // LFUN_FILE_OPEN generated by drag-and-drop.
1354 FuncRequest cmd = cmd0;
1357 cur.push(buffer_.inset());
1358 cur.selection() = d->cursor_.selection();
1360 // Either the inset under the cursor or the
1361 // surrounding Text will handle this event.
1363 // make sure we stay within the screen...
1364 cmd.y = min(max(cmd.y, -1), height_);
1366 if (cmd.action == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
1368 // Get inset under mouse, if there is one.
1369 Inset const * covering_inset =
1370 getCoveringInset(buffer_.text(), cmd.x, cmd.y);
1371 if (covering_inset == d->last_inset_)
1372 // Same inset, no need to do anything...
1375 bool need_redraw = false;
1376 // const_cast because of setMouseHover().
1377 Inset * inset = const_cast<Inset *>(covering_inset);
1379 // Remove the hint on the last hovered inset (if any).
1380 need_redraw |= d->last_inset_->setMouseHover(false);
1382 // Highlighted the newly hovered inset (if any).
1383 need_redraw |= inset->setMouseHover(true);
1384 d->last_inset_ = inset;
1388 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
1389 << cmd.x << ", " << cmd.y << ")");
1391 d->update_strategy_ = DecorationUpdate;
1393 // This event (moving without mouse click) is not passed further.
1394 // This should be changed if it is further utilized.
1399 // Build temporary cursor.
1400 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x, cmd.y);
1402 // Put anchor at the same position.
1405 // Try to dispatch to an non-editable inset near this position
1406 // via the temp cursor. If the inset wishes to change the real
1407 // cursor it has to do so explicitly by using
1408 // cur.bv().cursor() = cur; (or similar)
1410 inset->dispatch(cur, cmd);
1412 // Now dispatch to the temporary cursor. If the real cursor should
1413 // be modified, the inset's dispatch has to do so explicitly.
1414 if (!cur.result().dispatched())
1417 //Do we have a selection?
1418 theSelection().haveSelection(cursor().selection());
1420 // If the command has been dispatched,
1421 if (cur.result().dispatched()
1422 // an update is asked,
1423 && cur.result().update())
1424 processUpdateFlags(cur.result().update());
1428 void BufferView::lfunScroll(FuncRequest const & cmd)
1430 string const scroll_type = cmd.getArg(0);
1431 int const scroll_step =
1432 (scroll_type == "line")? d->scrollbarParameters_.lineScrollHeight
1433 : (scroll_type == "page")? height_ : 0;
1434 if (scroll_step == 0)
1436 string const scroll_quantity = cmd.getArg(1);
1437 if (scroll_quantity == "up")
1438 scrollUp(scroll_step);
1439 else if (scroll_quantity == "down")
1440 scrollDown(scroll_step);
1442 int const scroll_value = convert<int>(scroll_quantity);
1444 scroll(scroll_step * scroll_value);
1449 void BufferView::scroll(int y)
1458 void BufferView::scrollDown(int offset)
1460 Text * text = &buffer_.text();
1461 TextMetrics & tm = d->text_metrics_[text];
1462 int ymax = height_ + offset;
1464 pair<pit_type, ParagraphMetrics const *> last = tm.last();
1465 int bottom_pos = last.second->position() + last.second->descent();
1466 if (last.first + 1 == int(text->paragraphs().size())) {
1467 if (bottom_pos <= height_)
1469 offset = min(offset, bottom_pos - height_);
1472 if (bottom_pos > ymax)
1474 tm.newParMetricsDown();
1476 d->anchor_ypos_ -= offset;
1482 void BufferView::scrollUp(int offset)
1484 Text * text = &buffer_.text();
1485 TextMetrics & tm = d->text_metrics_[text];
1486 int ymin = - offset;
1488 pair<pit_type, ParagraphMetrics const *> first = tm.first();
1489 int top_pos = first.second->position() - first.second->ascent();
1490 if (first.first == 0) {
1493 offset = min(offset, - top_pos);
1498 tm.newParMetricsUp();
1500 d->anchor_ypos_ += offset;
1506 void BufferView::setCursorFromRow(int row)
1511 buffer_.texrow().getIdFromRow(row, tmpid, tmppos);
1513 d->cursor_.reset(buffer_.inset());
1515 buffer_.text().setCursor(d->cursor_, 0, 0);
1517 buffer_.text().setCursor(d->cursor_, buffer_.getParFromID(tmpid).pit(), tmppos);
1521 void BufferView::gotoLabel(docstring const & label)
1523 for (InsetIterator it = inset_iterator_begin(buffer_.inset()); it; ++it) {
1524 vector<docstring> labels;
1525 it->getLabelList(buffer_, labels);
1526 if (find(labels.begin(), labels.end(), label) != labels.end()) {
1535 TextMetrics const & BufferView::textMetrics(Text const * t) const
1537 return const_cast<BufferView *>(this)->textMetrics(t);
1541 TextMetrics & BufferView::textMetrics(Text const * t)
1543 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
1544 if (tmc_it == d->text_metrics_.end()) {
1545 tmc_it = d->text_metrics_.insert(
1546 make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
1548 return tmc_it->second;
1552 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
1555 return textMetrics(t).parMetrics(pit);
1559 int BufferView::workHeight() const
1565 void BufferView::setCursor(DocIterator const & dit)
1567 size_t const n = dit.depth();
1568 for (size_t i = 0; i < n; ++i)
1569 dit[i].inset().edit(d->cursor_, true);
1571 d->cursor_.setCursor(dit);
1572 d->cursor_.selection() = false;
1576 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
1578 // Would be wrong to delete anything if we have a selection.
1579 if (cur.selection())
1582 bool need_anchor_change = false;
1583 bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
1584 need_anchor_change);
1586 if (need_anchor_change)
1594 updateLabels(buffer_);
1602 bool BufferView::mouseSetCursor(Cursor & cur, bool select)
1604 BOOST_ASSERT(&cur.bv() == this);
1607 // this event will clear selection so we save selection for
1608 // persistent selection
1609 cap::saveSelection(cursor());
1611 // Has the cursor just left the inset?
1612 bool badcursor = false;
1613 bool leftinset = (&d->cursor_.inset() != &cur.inset());
1615 badcursor = notifyCursorLeaves(d->cursor_, cur);
1617 // FIXME: shift-mouse selection doesn't work well across insets.
1618 bool do_selection = select && &d->cursor_.anchor().inset() == &cur.inset();
1620 // do the dEPM magic if needed
1621 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
1622 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
1623 // the leftinset bool would not be necessary (badcursor instead).
1624 bool update = leftinset;
1625 if (!do_selection && !badcursor && d->cursor_.inTexted())
1626 update |= checkDepm(cur, d->cursor_);
1628 // if the cursor was in an empty script inset and the new
1629 // position is in the nucleus of the inset, notifyCursorLeaves
1630 // will kill the script inset itself. So we check all the
1631 // elements of the cursor to make sure that they are correct.
1632 // For an example, see bug 2933:
1633 // http://bugzilla.lyx.org/show_bug.cgi?id=2933
1634 // The code below could maybe be moved to a DocIterator method.
1635 //lyxerr << "cur before " << cur <<endl;
1636 DocIterator dit(cur.inset());
1637 dit.push_back(cur.bottom());
1639 while (i < cur.depth() && dit.nextInset() == &cur[i].inset()) {
1640 dit.push_back(cur[i]);
1643 //lyxerr << "5 cur after" << dit <<endl;
1645 d->cursor_.setCursor(dit);
1646 d->cursor_.boundary(cur.boundary());
1648 d->cursor_.setSelection();
1650 d->cursor_.clearSelection();
1652 d->cursor_.finishUndo();
1653 d->cursor_.setCurrentFont();
1658 void BufferView::putSelectionAt(DocIterator const & cur,
1659 int length, bool backwards)
1661 d->cursor_.clearSelection();
1667 d->cursor_.pos() += length;
1668 d->cursor_.setSelection(d->cursor_, -length);
1670 d->cursor_.setSelection(d->cursor_, length);
1675 Cursor & BufferView::cursor()
1681 Cursor const & BufferView::cursor() const
1687 pit_type BufferView::anchor_ref() const
1689 return d->anchor_pit_;
1693 bool BufferView::singleParUpdate()
1695 Text & buftext = buffer_.text();
1696 pit_type const bottom_pit = d->cursor_.bottom().pit();
1697 TextMetrics & tm = textMetrics(&buftext);
1698 int old_height = tm.parMetrics(bottom_pit).height();
1700 // In Single Paragraph mode, rebreak only
1701 // the (main text, not inset!) paragraph containing the cursor.
1702 // (if this paragraph contains insets etc., rebreaking will
1703 // recursively descend)
1704 tm.redoParagraph(bottom_pit);
1705 ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
1706 if (pm.height() != old_height)
1707 // Paragraph height has changed so we cannot proceed to
1708 // the singlePar optimisation.
1711 d->update_strategy_ = SingleParUpdate;
1713 LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
1714 << " y2: " << pm.position() + pm.descent()
1715 << " pit: " << bottom_pit
1716 << " singlepar: 1");
1721 void BufferView::updateMetrics()
1723 Text & buftext = buffer_.text();
1724 pit_type const npit = int(buftext.paragraphs().size());
1726 // Clear out the position cache in case of full screen redraw,
1727 d->coord_cache_.clear();
1729 // Clear out paragraph metrics to avoid having invalid metrics
1730 // in the cache from paragraphs not relayouted below
1731 // The complete text metrics will be redone.
1732 d->text_metrics_.clear();
1734 TextMetrics & tm = textMetrics(&buftext);
1736 // Rebreak anchor paragraph.
1737 tm.redoParagraph(d->anchor_pit_);
1738 ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
1739 anchor_pm.setPosition(d->anchor_ypos_);
1741 LYXERR(Debug::PAINTING, "metrics: "
1742 << " anchor pit = " << d->anchor_pit_
1743 << " anchor ypos = " << d->anchor_ypos_);
1745 // Redo paragraphs above anchor if necessary.
1746 int y1 = d->anchor_ypos_ - anchor_pm.ascent();
1747 // We are now just above the anchor paragraph.
1748 pit_type pit1 = d->anchor_pit_ - 1;
1749 for (; pit1 >= 0 && y1 >= 0; --pit1) {
1750 tm.redoParagraph(pit1);
1751 ParagraphMetrics & pm = tm.par_metrics_[pit1];
1753 // Save the paragraph position in the cache.
1758 // Redo paragraphs below the anchor if necessary.
1759 int y2 = d->anchor_ypos_ + anchor_pm.descent();
1760 // We are now just below the anchor paragraph.
1761 pit_type pit2 = d->anchor_pit_ + 1;
1762 for (; pit2 < npit && y2 <= height_; ++pit2) {
1763 tm.redoParagraph(pit2);
1764 ParagraphMetrics & pm = tm.par_metrics_[pit2];
1766 // Save the paragraph position in the cache.
1771 LYXERR(Debug::PAINTING, "Metrics: "
1772 << " anchor pit = " << d->anchor_pit_
1773 << " anchor ypos = " << d->anchor_ypos_
1776 << " pit1 = " << pit1
1777 << " pit2 = " << pit2);
1779 d->update_strategy_ = FullScreenUpdate;
1781 if (lyxerr.debugging(Debug::WORKAREA)) {
1782 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
1783 d->coord_cache_.dump();
1788 void BufferView::insertLyXFile(FileName const & fname)
1790 BOOST_ASSERT(d->cursor_.inTexted());
1792 // Get absolute path of file and add ".lyx"
1793 // to the filename if necessary
1794 FileName filename = fileSearch(string(), fname.absFilename(), "lyx");
1796 docstring const disp_fn = makeDisplayPath(filename.absFilename());
1797 // emit message signal.
1798 message(bformat(_("Inserting document %1$s..."), disp_fn));
1801 Buffer buf("", false);
1802 if (buf.loadLyXFile(filename)) {
1803 ErrorList & el = buffer_.errorList("Parse");
1804 // Copy the inserted document error list into the current buffer one.
1805 el = buf.errorList("Parse");
1806 buffer_.undo().recordUndo(d->cursor_);
1807 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
1808 buf.params().getTextClassPtr(), el);
1809 res = _("Document %1$s inserted.");
1811 res = _("Could not insert document %1$s");
1816 // emit message signal.
1817 message(bformat(res, disp_fn));
1818 buffer_.errors("Parse");
1822 Point BufferView::coordOffset(DocIterator const & dit, bool boundary) const
1828 // Addup contribution of nested insets, from inside to outside,
1829 // keeping the outer paragraph for a special handling below
1830 for (size_t i = dit.depth() - 1; i >= 1; --i) {
1831 CursorSlice const & sl = dit[i];
1835 // get relative position inside sl.inset()
1836 sl.inset().cursorPos(*this, sl, boundary && (i + 1 == dit.depth()), xx, yy);
1838 // Make relative position inside of the edited inset relative to sl.inset()
1842 // In case of an RTL inset, the edited inset will be positioned to the left
1845 bool boundary_i = boundary && i + 1 == dit.depth();
1846 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
1851 // remember width for the case that sl.inset() is positioned in an RTL inset
1852 if (i && dit[i - 1].text()) {
1853 // If this Inset is inside a Text Inset, retrieve the Dimension
1854 // from the containing text instead of using Inset::dimension() which
1855 // might not be implemented.
1856 // FIXME (Abdel 23/09/2007): this is a bit messy because of the
1857 // elimination of Inset::dim_ cache. This coordOffset() method needs
1858 // to be rewritten in light of the new design.
1859 Dimension const & dim = parMetrics(dit[i - 1].text(),
1860 dit[i - 1].pit()).insetDimension(&sl.inset());
1863 Dimension const dim = sl.inset().dimension(*this);
1867 //lyxerr << "Cursor::getPos, i: "
1868 // << i << " x: " << xx << " y: " << y << endl;
1871 // Add contribution of initial rows of outermost paragraph
1872 CursorSlice const & sl = dit[0];
1873 TextMetrics const & tm = textMetrics(sl.text());
1874 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
1875 BOOST_ASSERT(!pm.rows().empty());
1876 y -= pm.rows()[0].ascent();
1878 // FIXME: document this mess
1880 if (sl.pos() > 0 && dit.depth() == 1) {
1882 if (pos && boundary)
1884 // lyxerr << "coordOffset: boundary:" << boundary << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
1885 rend = pm.pos2row(pos);
1887 rend = pm.pos2row(sl.pos());
1889 size_t rend = pm.pos2row(sl.pos());
1891 for (size_t rit = 0; rit != rend; ++rit)
1892 y += pm.rows()[rit].height();
1893 y += pm.rows()[rend].ascent();
1895 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
1897 // Make relative position from the nested inset now bufferview absolute.
1898 int xx = bottom_tm.cursorX(dit.bottom(), boundary && dit.depth() == 1);
1901 // In the RTL case place the nested inset at the left of the cursor in
1902 // the outer paragraph
1903 bool boundary_1 = boundary && 1 == dit.depth();
1904 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
1912 Point BufferView::getPos(DocIterator const & dit, bool boundary) const
1914 CursorSlice const & bot = dit.bottom();
1915 TextMetrics const & tm = textMetrics(bot.text());
1916 if (!tm.has(bot.pit()))
1917 return Point(-1, -1);
1919 Point p = coordOffset(dit, boundary); // offset from outer paragraph
1920 p.y_ += tm.parMetrics(bot.pit()).position();
1925 void BufferView::draw(frontend::Painter & pain)
1927 LYXERR(Debug::PAINTING, "\t\t*** START DRAWING ***");
1928 Text & text = buffer_.text();
1929 TextMetrics const & tm = d->text_metrics_[&text];
1930 int const y = tm.first().second->position();
1931 PainterInfo pi(this, pain);
1933 switch (d->update_strategy_) {
1935 case NoScreenUpdate:
1936 // If no screen painting is actually needed, only some the different
1937 // coordinates of insets and paragraphs needs to be updated.
1938 pi.full_repaint = true;
1939 pi.pain.setDrawingEnabled(false);
1943 case SingleParUpdate:
1944 pi.full_repaint = false;
1945 // In general, only the current row of the outermost paragraph
1946 // will be redrawn. Particular cases where selection spans
1947 // multiple paragraph are correctly detected in TextMetrics.
1951 case DecorationUpdate:
1952 // FIXME: We should also distinguish DecorationUpdate to avoid text
1953 // drawing if possible. This is not possible to do easily right now
1954 // because of the single backing pixmap.
1956 case FullScreenUpdate:
1957 // The whole screen, including insets, will be refreshed.
1958 pi.full_repaint = true;
1960 // Clear background.
1961 pain.fillRectangle(0, 0, width_, height_,
1962 buffer_.inset().backgroundColor());
1967 // and possibly grey out below
1968 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
1969 int const y2 = lastpm.second->position() + lastpm.second->descent();
1971 pain.fillRectangle(0, y2, width_, height_ - y2, Color_bottomarea);
1974 LYXERR(Debug::PAINTING, "\n\t\t*** END DRAWING ***");
1976 // The scrollbar needs an update.
1979 // Normalize anchor for next time
1980 pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
1981 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
1982 for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
1983 ParagraphMetrics const & pm = tm.parMetrics(pit);
1984 if (pm.position() + pm.descent() > 0) {
1985 d->anchor_pit_ = pit;
1986 d->anchor_ypos_ = pm.position();
1990 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
1991 << " anchor ypos = " << d->anchor_ypos_);
1995 void BufferView::message(docstring const & msg)
1998 d->gui_->message(msg);
2002 void BufferView::showDialog(string const & name)
2005 d->gui_->showDialog(name, string());
2009 void BufferView::showDialog(string const & name,
2010 string const & data, Inset * inset)
2013 d->gui_->showDialog(name, data, inset);
2017 void BufferView::updateDialog(string const & name, string const & data)
2020 d->gui_->updateDialog(name, data);
2024 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
2030 // FIXME: Move this out of BufferView again
2031 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
2033 if (!fname.isReadableFile()) {
2034 docstring const error = from_ascii(strerror(errno));
2035 docstring const file = makeDisplayPath(fname.absFilename(), 50);
2036 docstring const text =
2037 bformat(_("Could not read the specified document\n"
2038 "%1$s\ndue to the error: %2$s"), file, error);
2039 Alert::error(_("Could not read file"), text);
2043 if (!fname.isReadableFile()) {
2044 docstring const file = makeDisplayPath(fname.absFilename(), 50);
2045 docstring const text =
2046 bformat(_("%1$s\n is not readable."), file);
2047 Alert::error(_("Could not open file"), text);
2051 // FIXME UNICODE: We don't know the encoding of the file
2052 docstring file_content = fname.fileContents("UTF-8");
2053 if (file_content.empty()) {
2054 Alert::error(_("Reading not UTF-8 encoded file"),
2055 _("The file is not UTF-8 encoded.\n"
2056 "It will be read as local 8Bit-encoded.\n"
2057 "If this does not give the correct result\n"
2058 "then please change the encoding of the file\n"
2059 "to UTF-8 with a program other than LyX.\n"));
2060 file_content = fname.fileContents("local8bit");
2063 return normalize_c(file_content);
2067 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
2069 docstring const tmpstr = contentsOfPlaintextFile(f);
2074 Cursor & cur = cursor();
2075 cap::replaceSelection(cur);
2076 buffer_.undo().recordUndo(cur);
2078 cur.innerText()->insertStringAsParagraphs(cur, tmpstr);
2080 cur.innerText()->insertStringAsLines(cur, tmpstr);