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"
27 #include "DispatchResult.h"
28 #include "EmbeddedFiles.h"
29 #include "ErrorList.h"
31 #include "FloatList.h"
32 #include "FuncRequest.h"
33 #include "FuncStatus.h"
36 #include "InsetIterator.h"
38 #include "LaTeXFeatures.h"
44 #include "MetricsInfo.h"
45 #include "Paragraph.h"
46 #include "paragraph_funcs.h"
47 #include "ParagraphParameters.h"
48 #include "ParIterator.h"
51 #include "TextClass.h"
52 #include "TextMetrics.h"
55 #include "WordLangTuple.h"
58 #include "insets/InsetBibtex.h"
59 #include "insets/InsetCommand.h" // ChangeRefs
60 #include "insets/InsetRef.h"
61 #include "insets/InsetText.h"
63 #include "frontends/alert.h"
64 #include "frontends/Delegates.h"
65 #include "frontends/FileDialog.h"
66 #include "frontends/FontMetrics.h"
67 #include "frontends/Painter.h"
68 #include "frontends/Selection.h"
70 #include "graphics/Previews.h"
72 #include "support/convert.h"
73 #include "support/FileFilterList.h"
74 #include "support/filetools.h"
75 #include "support/Package.h"
76 #include "support/types.h"
77 #include "support/fs_extras.h"
79 #include <boost/bind.hpp>
80 #include <boost/current_function.hpp>
81 #include <boost/next_prior.hpp>
82 #include <boost/filesystem/operations.hpp>
92 using std::istringstream;
93 using std::istream_iterator;
97 using std::mem_fun_ref;
101 namespace fs = boost::filesystem;
105 using support::addPath;
106 using support::bformat;
107 using support::FileFilterList;
108 using support::FileName;
109 using support::fileSearch;
110 using support::makeDisplayPath;
111 using support::makeAbsPath;
112 using support::package;
114 namespace Alert = frontend::Alert;
118 /// Return an inset of this class if it exists at the current cursor position
120 T * getInsetByCode(Cursor const & cur, InsetCode code)
122 DocIterator it = cur;
123 Inset * inset = it.nextInset();
124 if (inset && inset->lyxCode() == code)
125 return static_cast<T*>(inset);
130 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
133 bool findNextInset(DocIterator & dit, vector<InsetCode> const & codes,
134 docstring const & contents)
136 DocIterator tmpdit = dit;
139 Inset const * inset = tmpdit.nextInset();
141 && find(codes.begin(), codes.end(), inset->lyxCode()) != codes.end()
142 && (contents.empty() ||
143 static_cast<InsetCommand const *>(inset)->getFirstNonOptParam() == contents)) {
147 tmpdit.forwardInset();
154 /// Looks for next inset with one of the given codes.
155 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
159 DocIterator tmpdit = dit;
160 tmpdit.forwardInset();
165 Inset const * inset = tmpdit.nextInset();
167 && find(codes.begin(), codes.end(), inset->lyxCode()) != codes.end()) {
168 contents = static_cast<InsetCommand const *>(inset)->getFirstNonOptParam();
172 if (!findNextInset(tmpdit, codes, contents)) {
173 if (dit.depth() != 1 || dit.pit() != 0 || dit.pos() != 0) {
174 tmpdit = doc_iterator_begin(tmpdit.bottom().inset());
175 if (!findNextInset(tmpdit, codes, contents))
186 /// Looks for next inset with the given code
187 void findInset(DocIterator & dit, InsetCode code, bool same_content)
189 findInset(dit, vector<InsetCode>(1, code), same_content);
193 /// Moves cursor to the next inset with one of the given codes.
194 void gotoInset(BufferView * bv, vector<InsetCode> const & codes,
197 Cursor tmpcur = bv->cursor();
198 if (!findInset(tmpcur, codes, same_content)) {
199 bv->cursor().message(_("No more insets"));
203 tmpcur.clearSelection();
204 bv->setCursor(tmpcur);
208 /// Moves cursor to the next inset with given code.
209 void gotoInset(BufferView * bv, InsetCode code, bool same_content)
211 gotoInset(bv, vector<InsetCode>(1, code), same_content);
216 /// the type of outline operation
218 OutlineUp, // Move this header with text down
219 OutlineDown, // Move this header with text up
220 OutlineIn, // Make this header deeper
221 OutlineOut // Make this header shallower
225 void outline(OutlineOp mode, Cursor & cur)
227 Buffer & buf = cur.buffer();
228 pit_type & pit = cur.pit();
229 ParagraphList & pars = buf.text().paragraphs();
230 ParagraphList::iterator bgn = pars.begin();
231 // The first paragraph of the area to be copied:
232 ParagraphList::iterator start = boost::next(bgn, pit);
233 // The final paragraph of area to be copied:
234 ParagraphList::iterator finish = start;
235 ParagraphList::iterator end = pars.end();
237 TextClass::const_iterator lit =
238 buf.params().getTextClass().begin();
239 TextClass::const_iterator const lend =
240 buf.params().getTextClass().end();
242 int const thistoclevel = start->layout()->toclevel;
246 // Move out (down) from this section header
249 // Seek the one (on same level) below
250 for (; finish != end; ++finish) {
251 toclevel = finish->layout()->toclevel;
252 if (toclevel != Layout::NOT_IN_TOC
253 && toclevel <= thistoclevel) {
257 ParagraphList::iterator dest = start;
258 // Move out (up) from this header
261 // Search previous same-level header above
264 toclevel = dest->layout()->toclevel;
266 && (toclevel == Layout::NOT_IN_TOC
267 || toclevel > thistoclevel));
268 // Not found; do nothing
269 if (toclevel == Layout::NOT_IN_TOC || toclevel > thistoclevel)
271 pit_type const newpit = std::distance(bgn, dest);
272 pit_type const len = std::distance(start, finish);
273 pit_type const deletepit = pit + len;
274 buf.undo().recordUndo(cur, ATOMIC_UNDO, newpit, deletepit - 1);
275 pars.insert(dest, start, finish);
276 start = boost::next(pars.begin(), deletepit);
278 pars.erase(start, finish);
282 // Go down out of current header:
285 // Find next same-level header:
286 for (; finish != end; ++finish) {
287 toclevel = finish->layout()->toclevel;
288 if (toclevel != Layout::NOT_IN_TOC && toclevel <= thistoclevel)
291 ParagraphList::iterator dest = finish;
292 // Go one down from *this* header:
297 // Go further down to find header to insert in front of:
298 for (; dest != end; ++dest) {
299 toclevel = dest->layout()->toclevel;
300 if (toclevel != Layout::NOT_IN_TOC && toclevel <= thistoclevel)
303 // One such was found:
304 pit_type newpit = std::distance(bgn, dest);
305 pit_type const len = std::distance(start, finish);
306 buf.undo().recordUndo(cur, ATOMIC_UNDO, pit, newpit - 1);
307 pars.insert(dest, start, finish);
308 start = boost::next(bgn, pit);
310 pars.erase(start, finish);
314 buf.undo().recordUndo(cur);
315 for (; lit != lend; ++lit) {
316 if ((*lit)->toclevel == thistoclevel + 1 &&
317 start->layout()->labeltype == (*lit)->labeltype) {
318 start->layout((*lit));
324 buf.undo().recordUndo(cur);
325 for (; lit != lend; ++lit) {
326 if ((*lit)->toclevel == thistoclevel - 1 &&
327 start->layout()->labeltype == (*lit)->labeltype) {
328 start->layout((*lit));
338 /// A map from a Text to the associated text metrics
339 typedef std::map<Text const *, TextMetrics> TextMetricsCache;
344 /////////////////////////////////////////////////////////////////////
348 /////////////////////////////////////////////////////////////////////
350 struct BufferView::Private
352 Private(BufferView & bv): wh_(0), cursor_(bv),
353 multiparsel_cache_(false), anchor_ref_(0), offset_ref_(0),
354 need_centering_(false), last_inset_(0), gui_(0)
358 ScrollbarParameters scrollbarParameters_;
360 ViewMetricsInfo metrics_info_;
362 CoordCache coord_cache_;
364 /// Estimated average par height for scrollbar.
366 /// this is used to handle XSelection events in the right manner.
375 bool multiparsel_cache_;
377 pit_type anchor_ref_;
381 bool need_centering_;
383 /// keyboard mapping object.
386 /// last visited inset.
387 /** kept to send setMouseHover(false).
388 * Not owned, so don't delete.
392 mutable TextMetricsCache text_metrics_;
395 /** Not owned, so don't delete.
397 frontend::GuiBufferViewDelegate * gui_;
401 BufferView::BufferView(Buffer & buf)
402 : width_(0), height_(0), buffer_(buf), d(new Private(*this))
404 d->xsel_cache_.set = false;
405 d->intl_.initKeyMapper(lyxrc.use_kbmap);
407 d->cursor_.push(buffer_.inset());
408 d->cursor_.resetAnchor();
409 d->cursor_.setCurrentFont();
411 if (graphics::Previews::status() != LyXRC::PREVIEW_OFF)
412 graphics::Previews::get().generateBufferPreviews(buffer_);
416 BufferView::~BufferView()
418 // current buffer is going to be switched-off, save cursor pos
419 // Ideally, the whole cursor stack should be saved, but session
420 // currently can only handle bottom (whole document) level pit and pos.
421 // That is to say, if a cursor is in a nested inset, it will be
422 // restore to the left of the top level inset.
423 LastFilePosSection::FilePos fp;
424 fp.pit = d->cursor_.bottom().pit();
425 fp.pos = d->cursor_.bottom().pos();
426 LyX::ref().session().lastFilePos().save(buffer_.fileName(), fp);
432 Intl & BufferView::getIntl()
438 Intl const & BufferView::getIntl() const
444 CoordCache & BufferView::coordCache()
446 return d->coord_cache_;
450 CoordCache const & BufferView::coordCache() const
452 return d->coord_cache_;
456 Buffer & BufferView::buffer()
462 Buffer const & BufferView::buffer() const
468 bool BufferView::fitCursor()
470 if (cursorStatus(d->cursor_) == CUR_INSIDE) {
471 frontend::FontMetrics const & fm =
472 theFontMetrics(d->cursor_.getFont().fontInfo());
473 int const asc = fm.maxAscent();
474 int const des = fm.maxDescent();
475 Point const p = getPos(d->cursor_, d->cursor_.boundary());
476 if (p.y_ - asc >= 0 && p.y_ + des < height_)
484 bool BufferView::multiParSel()
486 if (!d->cursor_.selection())
488 bool ret = d->multiparsel_cache_;
489 d->multiparsel_cache_ = d->cursor_.selBegin().pit() != d->cursor_.selEnd().pit();
490 // Either this, or previous selection spans paragraphs
491 return ret || d->multiparsel_cache_;
495 void BufferView::processUpdateFlags(Update::flags flags)
497 // last_inset_ points to the last visited inset. This pointer may become
498 // invalid because of keyboard editing. Since all such operations
499 // causes screen update(), I reset last_inset_ to avoid such a problem.
501 // This is close to a hot-path.
503 << BOOST_CURRENT_FUNCTION
504 << "[fitcursor = " << (flags & Update::FitCursor)
505 << ", forceupdate = " << (flags & Update::Force)
506 << ", singlepar = " << (flags & Update::SinglePar)
507 << "] buffer: " << &buffer_ << endl;
509 // Update macro store
510 if (!(cursor().inMathed() && cursor().inMacroMode()))
511 buffer_.updateMacros();
513 // Now do the first drawing step if needed. This consists on updating
514 // the CoordCache in updateMetrics().
515 // The second drawing step is done in WorkArea::redraw() if needed.
517 // Case when no explicit update is requested.
519 // no need to redraw anything.
520 d->metrics_info_.update_strategy = NoScreenUpdate;
524 if (flags == Update::Decoration) {
525 d->metrics_info_.update_strategy = DecorationUpdate;
530 if (flags == Update::FitCursor
531 || flags == (Update::Decoration | Update::FitCursor)) {
532 bool const fit_cursor = fitCursor();
533 // tell the frontend to update the screen if needed.
535 updateMetrics(false);
539 if (flags & Update::Decoration) {
540 d->metrics_info_.update_strategy = DecorationUpdate;
544 // no screen update is needed.
545 d->metrics_info_.update_strategy = NoScreenUpdate;
549 bool full_metrics = flags & Update::Force;
550 if (flags & Update::MultiParSel)
551 full_metrics |= multiParSel();
553 bool const single_par = !full_metrics;
554 updateMetrics(single_par);
556 if (!(flags & Update::FitCursor)) {
561 //FIXME: updateMetrics() does not update paragraph position
562 // This is done at draw() time. So we need a redraw!
565 // The screen has already been updated thanks to the
566 // 'buffer_.changed()' call three line above. So no need
570 // The screen has been recentered around the cursor position so
572 updateMetrics(false);
577 void BufferView::updateScrollbar()
579 Text & t = buffer_.text();
580 TextMetrics & tm = d->text_metrics_[&t];
582 int const parsize = int(t.paragraphs().size() - 1);
583 if (d->anchor_ref_ > parsize) {
584 d->anchor_ref_ = parsize;
589 << BOOST_CURRENT_FUNCTION
590 << " Updating scrollbar: height: " << t.paragraphs().size()
591 << " curr par: " << d->cursor_.bottom().pit()
592 << " default height " << defaultRowHeight() << endl;
594 // It would be better to fix the scrollbar to understand
595 // values in [0..1] and divide everything by wh
597 // estimated average paragraph height:
599 d->wh_ = height_ / 4;
601 int h = tm.parMetrics(d->anchor_ref_).height();
603 // Normalize anchor/offset (MV):
604 while (d->offset_ref_ > h && d->anchor_ref_ < parsize) {
607 h = tm.parMetrics(d->anchor_ref_).height();
609 // Look at paragraph heights on-screen
612 for (pit_type pit = d->anchor_ref_; pit <= parsize; ++pit) {
615 int const h2 = tm.parMetrics(pit).height();
621 int const hav = sumh / nh;
622 // More realistic average paragraph height
627 d->scrollbarParameters_.height = (parsize + 1) * d->wh_;
628 d->scrollbarParameters_.position = d->anchor_ref_ * d->wh_ + int(d->offset_ref_ * d->wh_ / float(h));
629 d->scrollbarParameters_.lineScrollHeight = int(d->wh_ * defaultRowHeight() / float(h));
633 ScrollbarParameters const & BufferView::scrollbarParameters() const
635 return d->scrollbarParameters_;
639 void BufferView::scrollDocView(int value)
641 LYXERR(Debug::GUI) << BOOST_CURRENT_FUNCTION
642 << "[ value = " << value << "]" << endl;
644 Text & t = buffer_.text();
645 TextMetrics & tm = d->text_metrics_[&t];
647 float const bar = value / float(d->wh_ * t.paragraphs().size());
649 d->anchor_ref_ = int(bar * t.paragraphs().size());
650 if (d->anchor_ref_ > int(t.paragraphs().size()) - 1)
651 d->anchor_ref_ = int(t.paragraphs().size()) - 1;
653 tm.redoParagraph(d->anchor_ref_);
654 int const h = tm.parMetrics(d->anchor_ref_).height();
655 d->offset_ref_ = int((bar * t.paragraphs().size() - d->anchor_ref_) * h);
656 updateMetrics(false);
661 void BufferView::setCursorFromScrollbar()
663 TextMetrics & tm = d->text_metrics_[&buffer_.text()];
665 int const height = 2 * defaultRowHeight();
666 int const first = height;
667 int const last = height_ - height;
668 Cursor & cur = d->cursor_;
670 switch (cursorStatus(cur)) {
672 // We reset the cursor because cursorStatus() does not
673 // work when the cursor is within mathed.
674 cur.reset(buffer_.inset());
675 tm.setCursorFromCoordinates(cur, 0, first);
676 cur.clearSelection();
679 // We reset the cursor because cursorStatus() does not
680 // work when the cursor is within mathed.
681 cur.reset(buffer_.inset());
682 tm.setCursorFromCoordinates(cur, 0, last);
683 cur.clearSelection();
686 int const y = getPos(cur, cur.boundary()).y_;
687 int const newy = min(last, max(y, first));
689 cur.reset(buffer_.inset());
690 tm.setCursorFromCoordinates(cur, 0, newy);
696 Change const BufferView::getCurrentChange() const
698 if (!d->cursor_.selection())
699 return Change(Change::UNCHANGED);
701 DocIterator dit = d->cursor_.selectionBegin();
702 return dit.paragraph().lookupChange(dit.pos());
706 // this could be used elsewhere as well?
707 // FIXME: This does not work within mathed!
708 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
710 Point const p = getPos(dit, dit.boundary());
713 if (p.y_ > workHeight())
719 void BufferView::saveBookmark(unsigned int idx)
721 // tenatively save bookmark, id and pos will be used to
722 // acturately locate a bookmark in a 'live' lyx session.
723 // pit and pos will be updated with bottom level pit/pos
725 LyX::ref().session().bookmarks().save(
727 d->cursor_.bottom().pit(),
728 d->cursor_.bottom().pos(),
729 d->cursor_.paragraph().id(),
734 // emit message signal.
735 message(_("Save bookmark"));
739 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
740 int top_id, pos_type top_pos)
742 bool success = false;
745 d->cursor_.clearSelection();
747 // if a valid par_id is given, try it first
748 // This is the case for a 'live' bookmark when unique paragraph ID
749 // is used to track bookmarks.
751 ParIterator par = buffer_.getParFromID(top_id);
752 if (par != buffer_.par_iterator_end()) {
753 doc_it = makeDocIterator(par, min(par->size(), top_pos));
754 // Some slices of the iterator may not be
755 // reachable (e.g. closed collapsable inset)
756 // so the dociterator may need to be
757 // shortened. Otherwise, setCursor may crash
758 // lyx when the cursor can not be set to these
760 size_t const n = doc_it.depth();
761 for (size_t i = 0; i < n; ++i)
762 if (doc_it[i].inset().editable() != Inset::HIGHLY_EDITABLE) {
770 // if top_id == 0, or searching through top_id failed
771 // This is the case for a 'restored' bookmark when only bottom
772 // (document level) pit was saved. Because of this, bookmark
773 // restoration is inaccurate. If a bookmark was within an inset,
774 // it will be restored to the left of the outmost inset that contains
776 if (static_cast<size_t>(bottom_pit) < buffer_.paragraphs().size()) {
777 doc_it = doc_iterator_begin(buffer_.inset());
778 doc_it.pit() = bottom_pit;
779 doc_it.pos() = min(bottom_pos, doc_it.paragraph().size());
784 // Note: only bottom (document) level pit is set.
786 // set the current font.
787 d->cursor_.setCurrentFont();
788 // center the screen on this new position.
796 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
798 if (lyxrc.rtl_support) {
799 if (d->cursor_.real_current_font.isRightToLeft()) {
800 if (d->intl_.keymap == Intl::PRIMARY)
801 d->intl_.keyMapSec();
803 if (d->intl_.keymap == Intl::SECONDARY)
804 d->intl_.keyMapPrim();
808 d->intl_.getTransManager().translateAndInsert(c, t, cur);
812 int BufferView::workWidth() const
818 void BufferView::updateOffsetRef()
820 // No need to update d->offset_ref_ in this case.
821 if (!d->need_centering_)
824 // We are not properly started yet, delay until resizing is
829 CursorSlice & bot = d->cursor_.bottom();
830 TextMetrics & tm = d->text_metrics_[bot.text()];
831 ParagraphMetrics const & pm = tm.parMetrics(bot.pit());
832 int y = coordOffset(d->cursor_, d->cursor_.boundary()).y_;
833 d->offset_ref_ = y + pm.ascent() - height_ / 2;
835 d->need_centering_ = false;
839 void BufferView::center()
841 d->anchor_ref_ = d->cursor_.bottom().pit();
842 d->need_centering_ = true;
846 FuncStatus BufferView::getStatus(FuncRequest const & cmd)
850 Cursor & cur = d->cursor_;
852 switch (cmd.action) {
855 flag.enabled(buffer_.undo().hasUndoStack());
858 flag.enabled(buffer_.undo().hasRedoStack());
860 case LFUN_FILE_INSERT:
861 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
862 case LFUN_FILE_INSERT_PLAINTEXT:
863 case LFUN_BOOKMARK_SAVE:
864 // FIXME: Actually, these LFUNS should be moved to Text
865 flag.enabled(cur.inTexted());
867 case LFUN_FONT_STATE:
868 case LFUN_LABEL_INSERT:
869 case LFUN_INFO_INSERT:
870 case LFUN_PARAGRAPH_GOTO:
871 // FIXME handle non-trivially
872 case LFUN_OUTLINE_UP:
873 case LFUN_OUTLINE_DOWN:
874 case LFUN_OUTLINE_IN:
875 case LFUN_OUTLINE_OUT:
877 case LFUN_REFERENCE_NEXT:
879 case LFUN_WORD_REPLACE:
882 case LFUN_MARK_TOGGLE:
883 case LFUN_SCREEN_RECENTER:
884 case LFUN_BIBTEX_DATABASE_ADD:
885 case LFUN_BIBTEX_DATABASE_DEL:
886 case LFUN_WORDS_COUNT:
887 case LFUN_NEXT_INSET_TOGGLE:
891 case LFUN_LABEL_GOTO: {
892 flag.enabled(!cmd.argument().empty()
893 || getInsetByCode<InsetRef>(cur, REF_CODE));
897 case LFUN_CHANGES_TRACK:
899 flag.setOnOff(buffer_.params().trackChanges);
902 case LFUN_CHANGES_OUTPUT:
904 flag.setOnOff(buffer_.params().outputChanges);
907 case LFUN_CHANGES_MERGE:
908 case LFUN_CHANGE_NEXT:
909 case LFUN_ALL_CHANGES_ACCEPT:
910 case LFUN_ALL_CHANGES_REJECT:
911 // TODO: context-sensitive enabling of LFUNs
912 // In principle, these command should only be enabled if there
913 // is a change in the document. However, without proper
914 // optimizations, this will inevitably result in poor performance.
918 case LFUN_BUFFER_TOGGLE_COMPRESSION: {
919 flag.setOnOff(buffer_.params().compressed);
923 case LFUN_BUFFER_TOGGLE_EMBEDDING: {
924 flag.setOnOff(buffer_.params().embedded);
929 case LFUN_SCREEN_DOWN:
933 // FIXME: LFUN_SCREEN_DOWN_SELECT should be removed from
934 // everywhere else before this can enabled:
935 case LFUN_SCREEN_UP_SELECT:
936 case LFUN_SCREEN_DOWN_SELECT:
940 case LFUN_LAYOUT_TABULAR:
941 flag.enabled(cur.innerInsetOfType(TABULAR_CODE));
945 case LFUN_LAYOUT_PARAGRAPH:
946 flag.enabled(cur.inset().forceDefaultParagraphs(cur.idx()));
949 case LFUN_INSET_SETTINGS: {
950 InsetCode code = cur.inset().lyxCode();
954 enable = cmd.argument() == "tabular";
957 enable = cmd.argument() == "ert";
960 enable = cmd.argument() == "float";
963 enable = cmd.argument() == "wrap";
966 enable = cmd.argument() == "note";
969 enable = cmd.argument() == "branch";
972 enable = cmd.argument() == "box";
975 enable = cmd.argument() == "listings";
980 flag.enabled(enable);
984 case LFUN_DIALOG_SHOW_NEW_INSET:
985 flag.enabled(cur.inset().lyxCode() != ERT_CODE &&
986 cur.inset().lyxCode() != LISTINGS_CODE);
987 if (cur.inset().lyxCode() == CAPTION_CODE) {
989 if (cur.inset().getStatus(cur, cmd, flag))
1002 Update::flags BufferView::dispatch(FuncRequest const & cmd)
1004 //lyxerr << BOOST_CURRENT_FUNCTION
1005 // << [ cmd = " << cmd << "]" << endl;
1007 // Make sure that the cached BufferView is correct.
1008 LYXERR(Debug::ACTION) << BOOST_CURRENT_FUNCTION
1009 << " action[" << cmd.action << ']'
1010 << " arg[" << to_utf8(cmd.argument()) << ']'
1011 << " x[" << cmd.x << ']'
1012 << " y[" << cmd.y << ']'
1013 << " button[" << cmd.button() << ']'
1016 Cursor & cur = d->cursor_;
1017 // Default Update flags.
1018 Update::flags updateFlags = Update::Force | Update::FitCursor;
1020 switch (cmd.action) {
1023 cur.message(_("Undo"));
1024 cur.clearSelection();
1025 if (!cur.textUndo()) {
1026 cur.message(_("No further undo information"));
1027 updateFlags = Update::None;
1032 cur.message(_("Redo"));
1033 cur.clearSelection();
1034 if (!cur.textRedo()) {
1035 cur.message(_("No further redo information"));
1036 updateFlags = Update::None;
1040 case LFUN_FILE_INSERT:
1042 menuInsertLyXFile(to_utf8(cmd.argument()));
1045 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
1047 insertPlaintextFile(to_utf8(cmd.argument()), true);
1050 case LFUN_FILE_INSERT_PLAINTEXT:
1052 insertPlaintextFile(to_utf8(cmd.argument()), false);
1055 case LFUN_FONT_STATE:
1056 cur.message(cur.currentState());
1059 case LFUN_BOOKMARK_SAVE:
1060 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1063 case LFUN_LABEL_GOTO: {
1064 docstring label = cmd.argument();
1065 if (label.empty()) {
1067 getInsetByCode<InsetRef>(d->cursor_,
1070 label = inset->getParam("reference");
1071 // persistent=false: use temp_bookmark
1081 case LFUN_PARAGRAPH_GOTO: {
1082 int const id = convert<int>(to_utf8(cmd.argument()));
1084 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1085 b = theBufferList().next(b)) {
1087 ParIterator par = b->getParFromID(id);
1088 if (par == b->par_iterator_end()) {
1090 << "No matching paragraph found! ["
1091 << id << "]." << endl;
1094 << "Paragraph " << par->id()
1095 << " found in buffer `"
1096 << b->absFileName() << "'." << endl;
1098 if (b == &buffer_) {
1100 setCursor(makeDocIterator(par, 0));
1102 // Switch to other buffer view and resend cmd
1103 theLyXFunc().dispatch(FuncRequest(
1104 LFUN_BUFFER_SWITCH, b->absFileName()));
1105 theLyXFunc().dispatch(cmd);
1106 updateFlags = Update::None;
1115 case LFUN_OUTLINE_UP:
1116 outline(OutlineUp, d->cursor_);
1117 d->cursor_.text()->setCursor(d->cursor_, d->cursor_.pit(), 0);
1118 updateLabels(buffer_);
1120 case LFUN_OUTLINE_DOWN:
1121 outline(OutlineDown, d->cursor_);
1122 d->cursor_.text()->setCursor(d->cursor_, d->cursor_.pit(), 0);
1123 updateLabels(buffer_);
1125 case LFUN_OUTLINE_IN:
1126 outline(OutlineIn, d->cursor_);
1127 updateLabels(buffer_);
1129 case LFUN_OUTLINE_OUT:
1130 outline(OutlineOut, d->cursor_);
1131 updateLabels(buffer_);
1134 case LFUN_NOTE_NEXT:
1135 gotoInset(this, NOTE_CODE, false);
1138 case LFUN_REFERENCE_NEXT: {
1139 vector<InsetCode> tmp;
1140 tmp.push_back(LABEL_CODE);
1141 tmp.push_back(REF_CODE);
1142 gotoInset(this, tmp, true);
1146 case LFUN_CHANGES_TRACK:
1147 buffer_.params().trackChanges = !buffer_.params().trackChanges;
1150 case LFUN_CHANGES_OUTPUT:
1151 buffer_.params().outputChanges = !buffer_.params().outputChanges;
1152 if (buffer_.params().outputChanges) {
1153 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1154 bool xcolorsoul = LaTeXFeatures::isAvailable("soul") &&
1155 LaTeXFeatures::isAvailable("xcolor");
1157 if (!dvipost && !xcolorsoul) {
1158 Alert::warning(_("Changes not shown in LaTeX output"),
1159 _("Changes will not be highlighted in LaTeX output, "
1160 "because neither dvipost nor xcolor/soul are installed.\n"
1161 "Please install these packages or redefine "
1162 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1163 } else if (!xcolorsoul) {
1164 Alert::warning(_("Changes not shown in LaTeX output"),
1165 _("Changes will not be highlighted in LaTeX output "
1166 "when using pdflatex, because xcolor and soul are not installed.\n"
1167 "Please install both packages or redefine "
1168 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1173 case LFUN_CHANGE_NEXT:
1174 findNextChange(this);
1177 case LFUN_CHANGES_MERGE:
1178 if (findNextChange(this))
1179 showDialog("changes");
1182 case LFUN_ALL_CHANGES_ACCEPT:
1183 // select complete document
1184 d->cursor_.reset(buffer_.inset());
1185 d->cursor_.selHandle(true);
1186 buffer_.text().cursorBottom(d->cursor_);
1187 // accept everything in a single step to support atomic undo
1188 buffer_.text().acceptOrRejectChanges(d->cursor_, Text::ACCEPT);
1191 case LFUN_ALL_CHANGES_REJECT:
1192 // select complete document
1193 d->cursor_.reset(buffer_.inset());
1194 d->cursor_.selHandle(true);
1195 buffer_.text().cursorBottom(d->cursor_);
1196 // reject everything in a single step to support atomic undo
1197 // Note: reject does not work recursively; the user may have to repeat the operation
1198 buffer_.text().acceptOrRejectChanges(d->cursor_, Text::REJECT);
1201 case LFUN_WORD_FIND:
1205 case LFUN_WORD_REPLACE: {
1206 bool has_deleted = false;
1207 if (cur.selection()) {
1208 DocIterator beg = cur.selectionBegin();
1209 DocIterator end = cur.selectionEnd();
1210 if (beg.pit() == end.pit()) {
1211 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1212 if (cur.paragraph().isDeleted(p))
1217 replace(this, cmd, has_deleted);
1222 cur.clearSelection();
1224 cur.message(from_utf8(N_("Mark off")));
1228 cur.clearSelection();
1231 cur.message(from_utf8(N_("Mark on")));
1234 case LFUN_MARK_TOGGLE:
1235 cur.clearSelection();
1238 cur.message(from_utf8(N_("Mark removed")));
1241 cur.message(from_utf8(N_("Mark set")));
1246 case LFUN_SCREEN_RECENTER:
1250 case LFUN_BIBTEX_DATABASE_ADD: {
1251 Cursor tmpcur = d->cursor_;
1252 findInset(tmpcur, BIBTEX_CODE, false);
1253 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1256 if (inset->addDatabase(to_utf8(cmd.argument())))
1257 buffer_.updateBibfilesCache();
1262 case LFUN_BIBTEX_DATABASE_DEL: {
1263 Cursor tmpcur = d->cursor_;
1264 findInset(tmpcur, BIBTEX_CODE, false);
1265 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1268 if (inset->delDatabase(to_utf8(cmd.argument())))
1269 buffer_.updateBibfilesCache();
1274 case LFUN_WORDS_COUNT: {
1275 DocIterator from, to;
1276 if (cur.selection()) {
1277 from = cur.selectionBegin();
1278 to = cur.selectionEnd();
1280 from = doc_iterator_begin(buffer_.inset());
1281 to = doc_iterator_end(buffer_.inset());
1283 int const count = countWords(from, to);
1286 if (cur.selection())
1287 message = bformat(_("%1$d words in selection."),
1290 message = bformat(_("%1$d words in document."),
1294 if (cur.selection())
1295 message = _("One word in selection.");
1297 message = _("One word in document.");
1300 Alert::information(_("Count words"), message);
1304 case LFUN_BUFFER_TOGGLE_COMPRESSION:
1305 // turn compression on/off
1306 buffer_.params().compressed = !buffer_.params().compressed;
1309 case LFUN_BUFFER_TOGGLE_EMBEDDING:
1310 // turn embedding on/off
1311 buffer_.embeddedFiles().enable(!buffer_.params().embedded);
1314 case LFUN_NEXT_INSET_TOGGLE: {
1315 // this is the real function we want to invoke
1316 FuncRequest tmpcmd = FuncRequest(LFUN_INSET_TOGGLE, cmd.origin);
1317 // if there is an inset at cursor, see whether it
1319 Inset * inset = cur.nextInset();
1321 if (inset->isActive()) {
1322 Cursor tmpcur = cur;
1323 tmpcur.pushBackward(*inset);
1324 inset->dispatch(tmpcur, tmpcmd);
1325 if (tmpcur.result().dispatched()) {
1328 } else if (inset->editable() == Inset::IS_EDITABLE) {
1329 inset->edit(cur, true);
1332 // if it did not work, try the underlying inset.
1333 if (!cur.result().dispatched())
1334 cur.dispatch(tmpcmd);
1336 if (cur.result().dispatched())
1337 cur.clearSelection();
1342 case LFUN_SCREEN_UP:
1343 case LFUN_SCREEN_DOWN: {
1344 Point p = getPos(cur, cur.boundary());
1345 if (p.y_ < 0 || p.y_ > height_) {
1346 // The cursor is off-screen so recenter before proceeding.
1348 updateMetrics(false);
1349 //FIXME: updateMetrics() does not update paragraph position
1350 // This is done at draw() time. So we need a redraw!
1352 p = getPos(cur, cur.boundary());
1354 scroll(cmd.action == LFUN_SCREEN_UP? - height_ : height_);
1355 cur.reset(buffer_.inset());
1356 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_);
1357 //FIXME: what to do with cur.x_target()?
1359 // The metrics are already up to date. see scroll()
1360 updateFlags = Update::None;
1364 case LFUN_SCREEN_UP_SELECT:
1365 case LFUN_SCREEN_DOWN_SELECT: {
1366 cur.selHandle(true);
1367 size_t initial_depth = cur.depth();
1368 Point const p = getPos(cur, cur.boundary());
1369 scroll(cmd.action == LFUN_SCREEN_UP_SELECT? - height_ : height_);
1370 // FIXME: We need to verify if the cursor stayed within an inset...
1371 //cur.reset(buffer_.inset());
1372 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_);
1374 while (cur.depth() > initial_depth) {
1377 // FIXME: we need to do a redraw again because of the selection
1379 updateFlags = Update::Force | Update::FitCursor;
1384 updateFlags = Update::None;
1391 docstring const BufferView::requestSelection()
1393 Cursor & cur = d->cursor_;
1395 if (!cur.selection()) {
1396 d->xsel_cache_.set = false;
1400 if (!d->xsel_cache_.set ||
1401 cur.top() != d->xsel_cache_.cursor ||
1402 cur.anchor_.top() != d->xsel_cache_.anchor)
1404 d->xsel_cache_.cursor = cur.top();
1405 d->xsel_cache_.anchor = cur.anchor_.top();
1406 d->xsel_cache_.set = cur.selection();
1407 return cur.selectionAsString(false);
1413 void BufferView::clearSelection()
1415 d->cursor_.clearSelection();
1416 // Clear the selection buffer. Otherwise a subsequent
1417 // middle-mouse-button paste would use the selection buffer,
1418 // not the more current external selection.
1419 cap::clearSelection();
1420 d->xsel_cache_.set = false;
1421 // The buffer did not really change, but this causes the
1422 // redraw we need because we cleared the selection above.
1427 void BufferView::resize(int width, int height)
1429 // Update from work area
1433 updateMetrics(false);
1437 Inset const * BufferView::getCoveringInset(Text const & text, int x, int y)
1439 TextMetrics & tm = d->text_metrics_[&text];
1440 Inset * inset = tm.checkInsetHit(x, y);
1444 if (!inset->descendable())
1445 // No need to go further down if the inset is not
1449 size_t cell_number = inset->nargs();
1450 // Check all the inner cell.
1451 for (size_t i = 0; i != cell_number; ++i) {
1452 Text const * inner_text = inset->getText(i);
1455 Inset const * inset_deeper =
1456 getCoveringInset(*inner_text, x, y);
1458 return inset_deeper;
1466 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
1468 //lyxerr << BOOST_CURRENT_FUNCTION << "[ cmd0 " << cmd0 << "]" << endl;
1470 // This is only called for mouse related events including
1471 // LFUN_FILE_OPEN generated by drag-and-drop.
1472 FuncRequest cmd = cmd0;
1475 cur.push(buffer_.inset());
1476 cur.selection() = d->cursor_.selection();
1478 // Either the inset under the cursor or the
1479 // surrounding Text will handle this event.
1481 // make sure we stay within the screen...
1482 cmd.y = min(max(cmd.y, -1), height_);
1484 if (cmd.action == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
1486 // Get inset under mouse, if there is one.
1487 Inset const * covering_inset =
1488 getCoveringInset(buffer_.text(), cmd.x, cmd.y);
1489 if (covering_inset == d->last_inset_)
1490 // Same inset, no need to do anything...
1493 bool need_redraw = false;
1494 // const_cast because of setMouseHover().
1495 Inset * inset = const_cast<Inset *>(covering_inset);
1497 // Remove the hint on the last hovered inset (if any).
1498 need_redraw |= d->last_inset_->setMouseHover(false);
1500 // Highlighted the newly hovered inset (if any).
1501 need_redraw |= inset->setMouseHover(true);
1502 d->last_inset_ = inset;
1506 // if last metrics update was in singlepar mode, WorkArea::redraw() will
1507 // not expose the button for redraw. We adjust here the metrics dimension
1508 // to enable a full redraw in any case as this is not costly.
1509 TextMetrics & tm = d->text_metrics_[&buffer_.text()];
1510 std::pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
1511 std::pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
1512 int y1 = firstpm.second->position() - firstpm.second->ascent();
1513 int y2 = lastpm.second->position() + lastpm.second->descent();
1514 d->metrics_info_ = ViewMetricsInfo(firstpm.first, lastpm.first, y1, y2,
1515 FullScreenUpdate, buffer_.text().paragraphs().size());
1516 // Reinitialize anchor to first pit.
1517 d->anchor_ref_ = firstpm.first;
1518 d->offset_ref_ = -y1;
1519 LYXERR(Debug::PAINTING)
1520 << "Mouse hover detected at: (" << cmd.x << ", " << cmd.y << ")"
1521 << "\nTriggering redraw: y1: " << y1 << " y2: " << y2
1522 << " pit1: " << firstpm.first << " pit2: " << lastpm.first << endl;
1524 // This event (moving without mouse click) is not passed further.
1525 // This should be changed if it is further utilized.
1530 // Build temporary cursor.
1531 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x, cmd.y);
1533 // Put anchor at the same position.
1536 // Try to dispatch to an non-editable inset near this position
1537 // via the temp cursor. If the inset wishes to change the real
1538 // cursor it has to do so explicitly by using
1539 // cur.bv().cursor() = cur; (or similar)
1541 inset->dispatch(cur, cmd);
1543 // Now dispatch to the temporary cursor. If the real cursor should
1544 // be modified, the inset's dispatch has to do so explicitly.
1545 if (!cur.result().dispatched())
1548 //Do we have a selection?
1549 theSelection().haveSelection(cursor().selection());
1551 // If the command has been dispatched,
1552 if (cur.result().dispatched()
1553 // an update is asked,
1554 && cur.result().update())
1555 processUpdateFlags(cur.result().update());
1559 void BufferView::scroll(int y)
1568 void BufferView::scrollDown(int offset)
1570 Text * text = &buffer_.text();
1571 TextMetrics & tm = d->text_metrics_[text];
1572 int ymax = height_ + offset;
1574 std::pair<pit_type, ParagraphMetrics const *> last = tm.last();
1575 int bottom_pos = last.second->position() + last.second->descent();
1576 if (last.first + 1 == int(text->paragraphs().size())) {
1577 if (bottom_pos <= height_)
1579 offset = min(offset, bottom_pos - height_);
1582 if (bottom_pos > ymax)
1584 tm.newParMetricsDown();
1586 d->offset_ref_ += offset;
1587 updateMetrics(false);
1592 void BufferView::scrollUp(int offset)
1594 Text * text = &buffer_.text();
1595 TextMetrics & tm = d->text_metrics_[text];
1596 int ymin = - offset;
1598 std::pair<pit_type, ParagraphMetrics const *> first = tm.first();
1599 int top_pos = first.second->position() - first.second->ascent();
1600 if (first.first == 0) {
1603 offset = min(offset, - top_pos);
1608 tm.newParMetricsUp();
1610 d->offset_ref_ -= offset;
1611 updateMetrics(false);
1616 void BufferView::setCursorFromRow(int row)
1621 buffer_.texrow().getIdFromRow(row, tmpid, tmppos);
1623 d->cursor_.reset(buffer_.inset());
1625 buffer_.text().setCursor(d->cursor_, 0, 0);
1627 buffer_.text().setCursor(d->cursor_, buffer_.getParFromID(tmpid).pit(), tmppos);
1631 void BufferView::gotoLabel(docstring const & label)
1633 for (InsetIterator it = inset_iterator_begin(buffer_.inset()); it; ++it) {
1634 vector<docstring> labels;
1635 it->getLabelList(buffer_, labels);
1636 if (std::find(labels.begin(), labels.end(), label) != labels.end()) {
1638 processUpdateFlags(Update::FitCursor);
1645 TextMetrics const & BufferView::textMetrics(Text const * t) const
1647 return const_cast<BufferView *>(this)->textMetrics(t);
1651 TextMetrics & BufferView::textMetrics(Text const * t)
1653 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
1654 if (tmc_it == d->text_metrics_.end()) {
1655 tmc_it = d->text_metrics_.insert(
1656 make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
1658 return tmc_it->second;
1662 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
1665 return textMetrics(t).parMetrics(pit);
1669 int BufferView::workHeight() const
1675 void BufferView::setCursor(DocIterator const & dit)
1677 size_t const n = dit.depth();
1678 for (size_t i = 0; i < n; ++i)
1679 dit[i].inset().edit(d->cursor_, true);
1681 d->cursor_.setCursor(dit);
1682 d->cursor_.selection() = false;
1686 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
1688 // Would be wrong to delete anything if we have a selection.
1689 if (cur.selection())
1692 bool need_anchor_change = false;
1693 bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
1694 need_anchor_change);
1696 if (need_anchor_change)
1702 updateLabels(buffer_);
1704 updateMetrics(false);
1710 bool BufferView::mouseSetCursor(Cursor & cur, bool select)
1712 BOOST_ASSERT(&cur.bv() == this);
1715 // this event will clear selection so we save selection for
1716 // persistent selection
1717 cap::saveSelection(cursor());
1719 // Has the cursor just left the inset?
1720 bool badcursor = false;
1721 bool leftinset = (&d->cursor_.inset() != &cur.inset());
1723 badcursor = notifyCursorLeaves(d->cursor_, cur);
1725 // FIXME: shift-mouse selection doesn't work well across insets.
1726 bool do_selection = select && &d->cursor_.anchor().inset() == &cur.inset();
1728 // do the dEPM magic if needed
1729 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
1730 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
1731 // the leftinset bool would not be necessary (badcursor instead).
1732 bool update = leftinset;
1733 if (!do_selection && !badcursor && d->cursor_.inTexted())
1734 update |= checkDepm(cur, d->cursor_);
1736 // if the cursor was in an empty script inset and the new
1737 // position is in the nucleus of the inset, notifyCursorLeaves
1738 // will kill the script inset itself. So we check all the
1739 // elements of the cursor to make sure that they are correct.
1740 // For an example, see bug 2933:
1741 // http://bugzilla.lyx.org/show_bug.cgi?id=2933
1742 // The code below could maybe be moved to a DocIterator method.
1743 //lyxerr << "cur before " << cur <<std::endl;
1744 DocIterator dit(cur.inset());
1745 dit.push_back(cur.bottom());
1747 while (i < cur.depth() && dit.nextInset() == &cur[i].inset()) {
1748 dit.push_back(cur[i]);
1751 //lyxerr << "5 cur after" << dit <<std::endl;
1753 d->cursor_.setCursor(dit);
1754 d->cursor_.boundary(cur.boundary());
1756 d->cursor_.setSelection();
1758 d->cursor_.clearSelection();
1760 d->cursor_.finishUndo();
1761 d->cursor_.setCurrentFont();
1766 void BufferView::putSelectionAt(DocIterator const & cur,
1767 int length, bool backwards)
1769 d->cursor_.clearSelection();
1775 d->cursor_.pos() += length;
1776 d->cursor_.setSelection(d->cursor_, -length);
1778 d->cursor_.setSelection(d->cursor_, length);
1783 Cursor & BufferView::cursor()
1789 Cursor const & BufferView::cursor() const
1795 pit_type BufferView::anchor_ref() const
1797 return d->anchor_ref_;
1801 ViewMetricsInfo const & BufferView::viewMetricsInfo()
1803 return d->metrics_info_;
1807 bool BufferView::singleParUpdate()
1809 Text & buftext = buffer_.text();
1810 pit_type const bottom_pit = d->cursor_.bottom().pit();
1811 TextMetrics & tm = textMetrics(&buftext);
1812 int old_height = tm.parMetrics(bottom_pit).height();
1814 // In Single Paragraph mode, rebreak only
1815 // the (main text, not inset!) paragraph containing the cursor.
1816 // (if this paragraph contains insets etc., rebreaking will
1817 // recursively descend)
1818 tm.redoParagraph(bottom_pit);
1819 ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
1820 if (pm.height() != old_height)
1821 // Paragraph height has changed so we cannot proceed to
1822 // the singlePar optimisation.
1825 int y1 = pm.position() - pm.ascent();
1826 int y2 = pm.position() + pm.descent();
1827 d->metrics_info_ = ViewMetricsInfo(bottom_pit, bottom_pit, y1, y2,
1828 SingleParUpdate, buftext.paragraphs().size());
1829 LYXERR(Debug::PAINTING)
1830 << BOOST_CURRENT_FUNCTION
1833 << " pit: " << bottom_pit
1840 void BufferView::updateMetrics(bool singlepar)
1842 if (singlepar && singleParUpdate())
1843 // No need to update the full screen metrics.
1846 Text & buftext = buffer_.text();
1847 pit_type const npit = int(buftext.paragraphs().size());
1849 if (d->anchor_ref_ > int(npit - 1)) {
1850 d->anchor_ref_ = int(npit - 1);
1854 // Clear out the position cache in case of full screen redraw,
1855 d->coord_cache_.clear();
1857 // Clear out paragraph metrics to avoid having invalid metrics
1858 // in the cache from paragraphs not relayouted below
1859 // The complete text metrics will be redone.
1860 d->text_metrics_.clear();
1862 TextMetrics & tm = textMetrics(&buftext);
1864 pit_type const pit = d->anchor_ref_;
1868 // Rebreak anchor paragraph.
1869 tm.redoParagraph(pit);
1871 // Take care of anchor offset if case a recentering is needed.
1874 int y0 = tm.parMetrics(pit).ascent() - d->offset_ref_;
1876 // Redo paragraphs above anchor if necessary.
1878 while (y1 > 0 && pit1 > 0) {
1879 y1 -= tm.parMetrics(pit1).ascent();
1881 tm.redoParagraph(pit1);
1882 y1 -= tm.parMetrics(pit1).descent();
1885 // Take care of ascent of first line
1886 y1 -= tm.parMetrics(pit1).ascent();
1888 // Normalize anchor for next time
1889 d->anchor_ref_ = pit1;
1890 d->offset_ref_ = -y1;
1892 // Grey at the beginning is ugly
1893 if (pit1 == 0 && y1 > 0) {
1899 // Redo paragraphs below the anchor if necessary.
1901 while (y2 < height_ && pit2 < int(npit) - 1) {
1902 y2 += tm.parMetrics(pit2).descent();
1904 tm.redoParagraph(pit2);
1905 y2 += tm.parMetrics(pit2).ascent();
1908 // Take care of descent of last line
1909 y2 += tm.parMetrics(pit2).descent();
1911 LYXERR(Debug::PAINTING)
1912 << BOOST_CURRENT_FUNCTION
1915 << " pit1: " << pit1
1916 << " pit2: " << pit2
1917 << " npit: " << npit
1921 d->metrics_info_ = ViewMetricsInfo(pit1, pit2, y1, y2,
1922 FullScreenUpdate, npit);
1924 if (lyxerr.debugging(Debug::WORKAREA)) {
1925 LYXERR(Debug::WORKAREA) << "BufferView::updateMetrics" << endl;
1926 d->coord_cache_.dump();
1931 void BufferView::menuInsertLyXFile(string const & filenm)
1933 BOOST_ASSERT(d->cursor_.inTexted());
1934 string filename = filenm;
1936 if (filename.empty()) {
1937 // Launch a file browser
1939 string initpath = lyxrc.document_path;
1940 string const trypath = buffer_.filePath();
1941 // If directory is writeable, use this as default.
1942 if (FileName(trypath).isDirWritable())
1946 FileDialog dlg(_("Select LyX document to insert"), LFUN_FILE_INSERT);
1947 dlg.setButton1(_("Documents|#o#O"), from_utf8(lyxrc.document_path));
1948 dlg.setButton2(_("Examples|#E#e"),
1949 from_utf8(addPath(package().system_support().absFilename(),
1952 FileDialog::Result result =
1953 dlg.open(from_utf8(initpath),
1954 FileFilterList(_("LyX Documents (*.lyx)")),
1957 if (result.first == FileDialog::Later)
1961 filename = to_utf8(result.second);
1963 // check selected filename
1964 if (filename.empty()) {
1965 // emit message signal.
1966 message(_("Canceled."));
1971 // Get absolute path of file and add ".lyx"
1972 // to the filename if necessary
1973 filename = fileSearch(string(), filename, "lyx").absFilename();
1975 docstring const disp_fn = makeDisplayPath(filename);
1976 // emit message signal.
1977 message(bformat(_("Inserting document %1$s..."), disp_fn));
1980 Buffer buf("", false);
1981 if (buf.loadLyXFile(FileName(filename))) {
1982 ErrorList & el = buffer_.errorList("Parse");
1983 // Copy the inserted document error list into the current buffer one.
1984 el = buf.errorList("Parse");
1985 buffer_.undo().recordUndo(d->cursor_);
1986 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
1987 buf.params().getTextClassPtr(), el);
1988 res = _("Document %1$s inserted.");
1990 res = _("Could not insert document %1$s");
1993 // emit message signal.
1994 message(bformat(res, disp_fn));
1995 buffer_.errors("Parse");
1996 updateMetrics(false);
2000 Point BufferView::coordOffset(DocIterator const & dit, bool boundary) const
2006 // Addup contribution of nested insets, from inside to outside,
2007 // keeping the outer paragraph for a special handling below
2008 for (size_t i = dit.depth() - 1; i >= 1; --i) {
2009 CursorSlice const & sl = dit[i];
2013 // get relative position inside sl.inset()
2014 sl.inset().cursorPos(*this, sl, boundary && (i + 1 == dit.depth()), xx, yy);
2016 // Make relative position inside of the edited inset relative to sl.inset()
2020 // In case of an RTL inset, the edited inset will be positioned to the left
2023 bool boundary_i = boundary && i + 1 == dit.depth();
2024 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2029 // remember width for the case that sl.inset() is positioned in an RTL inset
2030 if (i && dit[i - 1].text()) {
2031 // If this Inset is inside a Text Inset, retrieve the Dimension
2032 // from the containing text instead of using Inset::dimension() which
2033 // might not be implemented.
2034 // FIXME (Abdel 23/09/2007): this is a bit messy because of the
2035 // elimination of Inset::dim_ cache. This coordOffset() method needs
2036 // to be rewritten in light of the new design.
2037 Dimension const & dim = parMetrics(dit[i - 1].text(),
2038 dit[i - 1].pit()).insetDimension(&sl.inset());
2041 Dimension const dim = sl.inset().dimension(*this);
2045 //lyxerr << "Cursor::getPos, i: "
2046 // << i << " x: " << xx << " y: " << y << endl;
2049 // Add contribution of initial rows of outermost paragraph
2050 CursorSlice const & sl = dit[0];
2051 TextMetrics const & tm = textMetrics(sl.text());
2052 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2053 BOOST_ASSERT(!pm.rows().empty());
2054 y -= pm.rows()[0].ascent();
2056 // FIXME: document this mess
2058 if (sl.pos() > 0 && dit.depth() == 1) {
2060 if (pos && boundary)
2062 // lyxerr << "coordOffset: boundary:" << boundary << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << std::endl;
2063 rend = pm.pos2row(pos);
2065 rend = pm.pos2row(sl.pos());
2067 size_t rend = pm.pos2row(sl.pos());
2069 for (size_t rit = 0; rit != rend; ++rit)
2070 y += pm.rows()[rit].height();
2071 y += pm.rows()[rend].ascent();
2073 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
2075 // Make relative position from the nested inset now bufferview absolute.
2076 int xx = bottom_tm.cursorX(dit.bottom(), boundary && dit.depth() == 1);
2079 // In the RTL case place the nested inset at the left of the cursor in
2080 // the outer paragraph
2081 bool boundary_1 = boundary && 1 == dit.depth();
2082 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
2090 Point BufferView::getPos(DocIterator const & dit, bool boundary) const
2092 CursorSlice const & bot = dit.bottom();
2093 TextMetrics const & tm = textMetrics(bot.text());
2094 if (!tm.has(bot.pit()))
2095 return Point(-1, -1);
2097 Point p = coordOffset(dit, boundary); // offset from outer paragraph
2098 p.y_ += tm.parMetrics(bot.pit()).position();
2103 void BufferView::draw(frontend::Painter & pain)
2105 PainterInfo pi(this, pain);
2106 // Should the whole screen, including insets, be refreshed?
2107 // FIXME: We should also distinguish DecorationUpdate to avoid text
2108 // drawing if possible. This is not possible to do easily right now
2109 // because of the single backing pixmap.
2110 pi.full_repaint = d->metrics_info_.update_strategy != SingleParUpdate;
2112 if (pi.full_repaint)
2113 // Clear background (if not delegated to rows)
2114 pain.fillRectangle(0, d->metrics_info_.y1, width_,
2115 d->metrics_info_.y2 - d->metrics_info_.y1,
2116 buffer_.inset().backgroundColor());
2118 LYXERR(Debug::PAINTING) << "\t\t*** START DRAWING ***" << endl;
2119 Text & text = buffer_.text();
2120 TextMetrics const & tm = d->text_metrics_[&text];
2121 int y = d->metrics_info_.y1 + tm.parMetrics(d->metrics_info_.p1).ascent();
2122 if (!pi.full_repaint)
2123 tm.drawParagraph(pi, d->metrics_info_.p1, 0, y);
2126 LYXERR(Debug::PAINTING) << "\n\t\t*** END DRAWING ***" << endl;
2128 // and grey out above (should not happen later)
2129 // lyxerr << "par ascent: " << text.getPar(d->metrics_info_.p1).ascent() << endl;
2130 if (d->metrics_info_.y1 > 0
2131 && d->metrics_info_.update_strategy == FullScreenUpdate)
2132 pain.fillRectangle(0, 0, width_, d->metrics_info_.y1, Color_bottomarea);
2134 // and possibly grey out below
2135 // lyxerr << "par descent: " << text.getPar(d->metrics_info_.p1).ascent() << endl;
2136 if (d->metrics_info_.y2 < height_
2137 && d->metrics_info_.update_strategy == FullScreenUpdate)
2138 pain.fillRectangle(0, d->metrics_info_.y2, width_,
2139 height_ - d->metrics_info_.y2, Color_bottomarea);
2143 void BufferView::message(docstring const & msg)
2146 d->gui_->message(msg);
2150 void BufferView::showDialog(std::string const & name)
2153 d->gui_->showDialog(name);
2157 void BufferView::showDialogWithData(std::string const & name,
2158 std::string const & data)
2161 d->gui_->showDialogWithData(name, data);
2165 void BufferView::showInsetDialog(std::string const & name,
2166 std::string const & data, Inset * inset)
2169 d->gui_->showInsetDialog(name, data, inset);
2173 void BufferView::updateDialog(std::string const & name, std::string const & data)
2176 d->gui_->updateDialog(name, data);
2180 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
2186 // FIXME: Move this out of BufferView again
2187 docstring BufferView::contentsOfPlaintextFile(string const & f,
2192 if (fname.empty()) {
2193 FileDialog dlg(_("Select file to insert"),
2195 ? LFUN_FILE_INSERT_PLAINTEXT_PARA
2196 : LFUN_FILE_INSERT_PLAINTEXT) );
2198 FileDialog::Result result =
2199 dlg.open(from_utf8(buffer().filePath()),
2200 FileFilterList(), docstring());
2202 if (result.first == FileDialog::Later)
2205 fname = makeAbsPath(to_utf8(result.second));
2211 if (!fs::is_readable(fname.toFilesystemEncoding())) {
2212 docstring const error = from_ascii(strerror(errno));
2213 docstring const file = makeDisplayPath(fname.absFilename(), 50);
2214 docstring const text =
2215 bformat(_("Could not read the specified document\n"
2216 "%1$s\ndue to the error: %2$s"), file, error);
2217 Alert::error(_("Could not read file"), text);
2221 ifstream ifs(fname.toFilesystemEncoding().c_str());
2223 docstring const error = from_ascii(strerror(errno));
2224 docstring const file = makeDisplayPath(fname.absFilename(), 50);
2225 docstring const text =
2226 bformat(_("Could not open the specified document\n"
2227 "%1$s\ndue to the error: %2$s"), file, error);
2228 Alert::error(_("Could not open file"), text);
2232 ifs.unsetf(std::ios::skipws);
2233 istream_iterator<char> ii(ifs);
2234 istream_iterator<char> end;
2235 #if !defined(USE_INCLUDED_STRING) && !defined(STD_STRING_IS_GOOD)
2236 // We use this until the compilers get better...
2237 std::vector<char> tmp;
2238 copy(ii, end, back_inserter(tmp));
2239 string const tmpstr(tmp.begin(), tmp.end());
2241 // This is what we want to use and what we will use once the
2242 // compilers get good enough.
2243 //string tmpstr(ii, end); // yet a reason for using std::string
2244 // alternate approach to get the file into a string:
2246 copy(ii, end, back_inserter(tmpstr));
2249 // FIXME UNICODE: We don't know the encoding of the file
2250 docstring file_content = from_utf8(tmpstr);
2251 if (file_content.empty()) {
2252 Alert::error(_("Reading not UTF-8 encoded file"),
2253 _("The file is not UTF-8 encoded.\n"
2254 "It will be read as local 8Bit-encoded.\n"
2255 "If this does not give the correct result\n"
2256 "then please change the encoding of the file\n"
2257 "to UTF-8 with a program other than LyX.\n"));
2258 file_content = from_local8bit(tmpstr);
2261 return normalize_c(file_content);
2265 void BufferView::insertPlaintextFile(string const & f, bool asParagraph)
2267 docstring const tmpstr = contentsOfPlaintextFile(f, asParagraph);
2272 Cursor & cur = cursor();
2273 cap::replaceSelection(cur);
2274 buffer_.undo().recordUndo(cur);
2276 cur.innerText()->insertStringAsParagraphs(cur, tmpstr);
2278 cur.innerText()->insertStringAsLines(cur, tmpstr);