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 anchor_ref_(0), offset_ref_(0), need_centering_(false),
354 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 pit_type anchor_ref_;
379 bool need_centering_;
381 /// keyboard mapping object.
384 /// last visited inset.
385 /** kept to send setMouseHover(false).
386 * Not owned, so don't delete.
390 mutable TextMetricsCache text_metrics_;
393 /** Not owned, so don't delete.
395 frontend::GuiBufferViewDelegate * gui_;
399 BufferView::BufferView(Buffer & buf)
400 : width_(0), height_(0), buffer_(buf), d(new Private(*this))
402 d->xsel_cache_.set = false;
403 d->intl_.initKeyMapper(lyxrc.use_kbmap);
405 d->cursor_.push(buffer_.inset());
406 d->cursor_.resetAnchor();
407 d->cursor_.setCurrentFont();
409 if (graphics::Previews::status() != LyXRC::PREVIEW_OFF)
410 graphics::Previews::get().generateBufferPreviews(buffer_);
414 BufferView::~BufferView()
416 // current buffer is going to be switched-off, save cursor pos
417 // Ideally, the whole cursor stack should be saved, but session
418 // currently can only handle bottom (whole document) level pit and pos.
419 // That is to say, if a cursor is in a nested inset, it will be
420 // restore to the left of the top level inset.
421 LastFilePosSection::FilePos fp;
422 fp.pit = d->cursor_.bottom().pit();
423 fp.pos = d->cursor_.bottom().pos();
424 LyX::ref().session().lastFilePos().save(buffer_.fileName(), fp);
430 Intl & BufferView::getIntl()
436 Intl const & BufferView::getIntl() const
442 CoordCache & BufferView::coordCache()
444 return d->coord_cache_;
448 CoordCache const & BufferView::coordCache() const
450 return d->coord_cache_;
454 Buffer & BufferView::buffer()
460 Buffer const & BufferView::buffer() const
466 bool BufferView::fitCursor()
468 if (cursorStatus(d->cursor_) == CUR_INSIDE) {
469 frontend::FontMetrics const & fm =
470 theFontMetrics(d->cursor_.getFont().fontInfo());
471 int const asc = fm.maxAscent();
472 int const des = fm.maxDescent();
473 Point const p = getPos(d->cursor_, d->cursor_.boundary());
474 if (p.y_ - asc >= 0 && p.y_ + des < height_)
482 void BufferView::processUpdateFlags(Update::flags flags)
484 // last_inset_ points to the last visited inset. This pointer may become
485 // invalid because of keyboard editing. Since all such operations
486 // causes screen update(), I reset last_inset_ to avoid such a problem.
488 // This is close to a hot-path.
490 << BOOST_CURRENT_FUNCTION
491 << "[fitcursor = " << (flags & Update::FitCursor)
492 << ", forceupdate = " << (flags & Update::Force)
493 << ", singlepar = " << (flags & Update::SinglePar)
494 << "] buffer: " << &buffer_ << endl;
496 // Update macro store
497 if (!(cursor().inMathed() && cursor().inMacroMode()))
498 buffer_.updateMacros();
500 // Now do the first drawing step if needed. This consists on updating
501 // the CoordCache in updateMetrics().
502 // The second drawing step is done in WorkArea::redraw() if needed.
504 // Case when no explicit update is requested.
506 // no need to redraw anything.
507 d->metrics_info_.update_strategy = NoScreenUpdate;
511 if (flags == Update::Decoration) {
512 d->metrics_info_.update_strategy = DecorationUpdate;
517 if (flags == Update::FitCursor
518 || flags == (Update::Decoration | Update::FitCursor)) {
519 bool const fit_cursor = fitCursor();
520 // tell the frontend to update the screen if needed.
526 if (flags & Update::Decoration) {
527 d->metrics_info_.update_strategy = DecorationUpdate;
531 // no screen update is needed.
532 d->metrics_info_.update_strategy = NoScreenUpdate;
536 bool const full_metrics = flags & Update::Force;
538 if (full_metrics || !singleParUpdate())
539 // We have to update the full screen metrics.
542 if (!(flags & Update::FitCursor)) {
547 //FIXME: updateMetrics() does not update paragraph position
548 // This is done at draw() time. So we need a redraw!
551 // The screen has already been updated thanks to the
552 // 'buffer_.changed()' call three line above. So no need
556 // The screen has been recentered around the cursor position so
563 void BufferView::updateScrollbar()
565 Text & t = buffer_.text();
566 TextMetrics & tm = d->text_metrics_[&t];
568 int const parsize = int(t.paragraphs().size() - 1);
569 if (d->anchor_ref_ > parsize) {
570 d->anchor_ref_ = parsize;
575 << BOOST_CURRENT_FUNCTION
576 << " Updating scrollbar: height: " << t.paragraphs().size()
577 << " curr par: " << d->cursor_.bottom().pit()
578 << " default height " << defaultRowHeight() << endl;
580 // It would be better to fix the scrollbar to understand
581 // values in [0..1] and divide everything by wh
583 // estimated average paragraph height:
585 d->wh_ = height_ / 4;
587 int h = tm.parMetrics(d->anchor_ref_).height();
589 // Normalize anchor/offset (MV):
590 while (d->offset_ref_ > h && d->anchor_ref_ < parsize) {
593 h = tm.parMetrics(d->anchor_ref_).height();
595 // Look at paragraph heights on-screen
598 for (pit_type pit = d->anchor_ref_; pit <= parsize; ++pit) {
601 int const h2 = tm.parMetrics(pit).height();
607 int const hav = sumh / nh;
608 // More realistic average paragraph height
613 d->scrollbarParameters_.height = (parsize + 1) * d->wh_;
614 d->scrollbarParameters_.position = d->anchor_ref_ * d->wh_ + int(d->offset_ref_ * d->wh_ / float(h));
615 d->scrollbarParameters_.lineScrollHeight = int(d->wh_ * defaultRowHeight() / float(h));
619 ScrollbarParameters const & BufferView::scrollbarParameters() const
621 return d->scrollbarParameters_;
625 void BufferView::scrollDocView(int value)
627 LYXERR(Debug::GUI) << BOOST_CURRENT_FUNCTION
628 << "[ value = " << value << "]" << endl;
630 Text & t = buffer_.text();
631 TextMetrics & tm = d->text_metrics_[&t];
633 float const bar = value / float(d->wh_ * t.paragraphs().size());
635 d->anchor_ref_ = int(bar * t.paragraphs().size());
636 if (d->anchor_ref_ > int(t.paragraphs().size()) - 1)
637 d->anchor_ref_ = int(t.paragraphs().size()) - 1;
639 tm.redoParagraph(d->anchor_ref_);
640 int const h = tm.parMetrics(d->anchor_ref_).height();
641 d->offset_ref_ = int((bar * t.paragraphs().size() - d->anchor_ref_) * h);
647 void BufferView::setCursorFromScrollbar()
649 TextMetrics & tm = d->text_metrics_[&buffer_.text()];
651 int const height = 2 * defaultRowHeight();
652 int const first = height;
653 int const last = height_ - height;
654 Cursor & cur = d->cursor_;
656 switch (cursorStatus(cur)) {
658 // We reset the cursor because cursorStatus() does not
659 // work when the cursor is within mathed.
660 cur.reset(buffer_.inset());
661 tm.setCursorFromCoordinates(cur, 0, first);
662 cur.clearSelection();
665 // We reset the cursor because cursorStatus() does not
666 // work when the cursor is within mathed.
667 cur.reset(buffer_.inset());
668 tm.setCursorFromCoordinates(cur, 0, last);
669 cur.clearSelection();
672 int const y = getPos(cur, cur.boundary()).y_;
673 int const newy = min(last, max(y, first));
675 cur.reset(buffer_.inset());
676 tm.setCursorFromCoordinates(cur, 0, newy);
682 Change const BufferView::getCurrentChange() const
684 if (!d->cursor_.selection())
685 return Change(Change::UNCHANGED);
687 DocIterator dit = d->cursor_.selectionBegin();
688 return dit.paragraph().lookupChange(dit.pos());
692 // this could be used elsewhere as well?
693 // FIXME: This does not work within mathed!
694 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
696 Point const p = getPos(dit, dit.boundary());
699 if (p.y_ > workHeight())
705 void BufferView::saveBookmark(unsigned int idx)
707 // tenatively save bookmark, id and pos will be used to
708 // acturately locate a bookmark in a 'live' lyx session.
709 // pit and pos will be updated with bottom level pit/pos
711 LyX::ref().session().bookmarks().save(
713 d->cursor_.bottom().pit(),
714 d->cursor_.bottom().pos(),
715 d->cursor_.paragraph().id(),
720 // emit message signal.
721 message(_("Save bookmark"));
725 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
726 int top_id, pos_type top_pos)
728 bool success = false;
731 d->cursor_.clearSelection();
733 // if a valid par_id is given, try it first
734 // This is the case for a 'live' bookmark when unique paragraph ID
735 // is used to track bookmarks.
737 ParIterator par = buffer_.getParFromID(top_id);
738 if (par != buffer_.par_iterator_end()) {
739 doc_it = makeDocIterator(par, min(par->size(), top_pos));
740 // Some slices of the iterator may not be
741 // reachable (e.g. closed collapsable inset)
742 // so the dociterator may need to be
743 // shortened. Otherwise, setCursor may crash
744 // lyx when the cursor can not be set to these
746 size_t const n = doc_it.depth();
747 for (size_t i = 0; i < n; ++i)
748 if (doc_it[i].inset().editable() != Inset::HIGHLY_EDITABLE) {
756 // if top_id == 0, or searching through top_id failed
757 // This is the case for a 'restored' bookmark when only bottom
758 // (document level) pit was saved. Because of this, bookmark
759 // restoration is inaccurate. If a bookmark was within an inset,
760 // it will be restored to the left of the outmost inset that contains
762 if (static_cast<size_t>(bottom_pit) < buffer_.paragraphs().size()) {
763 doc_it = doc_iterator_begin(buffer_.inset());
764 doc_it.pit() = bottom_pit;
765 doc_it.pos() = min(bottom_pos, doc_it.paragraph().size());
770 // Note: only bottom (document) level pit is set.
772 // set the current font.
773 d->cursor_.setCurrentFont();
774 // center the screen on this new position.
782 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
784 if (lyxrc.rtl_support) {
785 if (d->cursor_.real_current_font.isRightToLeft()) {
786 if (d->intl_.keymap == Intl::PRIMARY)
787 d->intl_.keyMapSec();
789 if (d->intl_.keymap == Intl::SECONDARY)
790 d->intl_.keyMapPrim();
794 d->intl_.getTransManager().translateAndInsert(c, t, cur);
798 int BufferView::workWidth() const
804 void BufferView::updateOffsetRef()
806 // No need to update d->offset_ref_ in this case.
807 if (!d->need_centering_)
810 // We are not properly started yet, delay until resizing is
815 CursorSlice & bot = d->cursor_.bottom();
816 TextMetrics & tm = d->text_metrics_[bot.text()];
817 ParagraphMetrics const & pm = tm.parMetrics(bot.pit());
818 int y = coordOffset(d->cursor_, d->cursor_.boundary()).y_;
819 d->offset_ref_ = y + pm.ascent() - height_ / 2;
821 d->need_centering_ = false;
825 void BufferView::center()
827 d->anchor_ref_ = d->cursor_.bottom().pit();
828 d->need_centering_ = true;
832 FuncStatus BufferView::getStatus(FuncRequest const & cmd)
836 Cursor & cur = d->cursor_;
838 switch (cmd.action) {
841 flag.enabled(buffer_.undo().hasUndoStack());
844 flag.enabled(buffer_.undo().hasRedoStack());
846 case LFUN_FILE_INSERT:
847 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
848 case LFUN_FILE_INSERT_PLAINTEXT:
849 case LFUN_BOOKMARK_SAVE:
850 // FIXME: Actually, these LFUNS should be moved to Text
851 flag.enabled(cur.inTexted());
853 case LFUN_FONT_STATE:
854 case LFUN_LABEL_INSERT:
855 case LFUN_INFO_INSERT:
856 case LFUN_PARAGRAPH_GOTO:
857 // FIXME handle non-trivially
858 case LFUN_OUTLINE_UP:
859 case LFUN_OUTLINE_DOWN:
860 case LFUN_OUTLINE_IN:
861 case LFUN_OUTLINE_OUT:
863 case LFUN_REFERENCE_NEXT:
865 case LFUN_WORD_REPLACE:
868 case LFUN_MARK_TOGGLE:
869 case LFUN_SCREEN_RECENTER:
870 case LFUN_BIBTEX_DATABASE_ADD:
871 case LFUN_BIBTEX_DATABASE_DEL:
872 case LFUN_WORDS_COUNT:
873 case LFUN_NEXT_INSET_TOGGLE:
877 case LFUN_LABEL_GOTO: {
878 flag.enabled(!cmd.argument().empty()
879 || getInsetByCode<InsetRef>(cur, REF_CODE));
883 case LFUN_CHANGES_TRACK:
885 flag.setOnOff(buffer_.params().trackChanges);
888 case LFUN_CHANGES_OUTPUT:
890 flag.setOnOff(buffer_.params().outputChanges);
893 case LFUN_CHANGES_MERGE:
894 case LFUN_CHANGE_NEXT:
895 case LFUN_ALL_CHANGES_ACCEPT:
896 case LFUN_ALL_CHANGES_REJECT:
897 // TODO: context-sensitive enabling of LFUNs
898 // In principle, these command should only be enabled if there
899 // is a change in the document. However, without proper
900 // optimizations, this will inevitably result in poor performance.
904 case LFUN_BUFFER_TOGGLE_COMPRESSION: {
905 flag.setOnOff(buffer_.params().compressed);
909 case LFUN_BUFFER_TOGGLE_EMBEDDING: {
910 flag.setOnOff(buffer_.params().embedded);
915 case LFUN_SCREEN_DOWN:
919 // FIXME: LFUN_SCREEN_DOWN_SELECT should be removed from
920 // everywhere else before this can enabled:
921 case LFUN_SCREEN_UP_SELECT:
922 case LFUN_SCREEN_DOWN_SELECT:
926 case LFUN_LAYOUT_TABULAR:
927 flag.enabled(cur.innerInsetOfType(TABULAR_CODE));
931 case LFUN_LAYOUT_PARAGRAPH:
932 flag.enabled(cur.inset().forceDefaultParagraphs(cur.idx()));
935 case LFUN_INSET_SETTINGS: {
936 InsetCode code = cur.inset().lyxCode();
940 enable = cmd.argument() == "tabular";
943 enable = cmd.argument() == "ert";
946 enable = cmd.argument() == "float";
949 enable = cmd.argument() == "wrap";
952 enable = cmd.argument() == "note";
955 enable = cmd.argument() == "branch";
958 enable = cmd.argument() == "box";
961 enable = cmd.argument() == "listings";
966 flag.enabled(enable);
970 case LFUN_DIALOG_SHOW_NEW_INSET:
971 flag.enabled(cur.inset().lyxCode() != ERT_CODE &&
972 cur.inset().lyxCode() != LISTINGS_CODE);
973 if (cur.inset().lyxCode() == CAPTION_CODE) {
975 if (cur.inset().getStatus(cur, cmd, flag))
988 Update::flags BufferView::dispatch(FuncRequest const & cmd)
990 //lyxerr << BOOST_CURRENT_FUNCTION
991 // << [ cmd = " << cmd << "]" << endl;
993 // Make sure that the cached BufferView is correct.
994 LYXERR(Debug::ACTION) << BOOST_CURRENT_FUNCTION
995 << " action[" << cmd.action << ']'
996 << " arg[" << to_utf8(cmd.argument()) << ']'
997 << " x[" << cmd.x << ']'
998 << " y[" << cmd.y << ']'
999 << " button[" << cmd.button() << ']'
1002 Cursor & cur = d->cursor_;
1003 // Default Update flags.
1004 Update::flags updateFlags = Update::Force | Update::FitCursor;
1006 switch (cmd.action) {
1009 cur.message(_("Undo"));
1010 cur.clearSelection();
1011 if (!cur.textUndo()) {
1012 cur.message(_("No further undo information"));
1013 updateFlags = Update::None;
1018 cur.message(_("Redo"));
1019 cur.clearSelection();
1020 if (!cur.textRedo()) {
1021 cur.message(_("No further redo information"));
1022 updateFlags = Update::None;
1026 case LFUN_FILE_INSERT:
1028 menuInsertLyXFile(to_utf8(cmd.argument()));
1031 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
1033 insertPlaintextFile(to_utf8(cmd.argument()), true);
1036 case LFUN_FILE_INSERT_PLAINTEXT:
1038 insertPlaintextFile(to_utf8(cmd.argument()), false);
1041 case LFUN_FONT_STATE:
1042 cur.message(cur.currentState());
1045 case LFUN_BOOKMARK_SAVE:
1046 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1049 case LFUN_LABEL_GOTO: {
1050 docstring label = cmd.argument();
1051 if (label.empty()) {
1053 getInsetByCode<InsetRef>(d->cursor_,
1056 label = inset->getParam("reference");
1057 // persistent=false: use temp_bookmark
1067 case LFUN_PARAGRAPH_GOTO: {
1068 int const id = convert<int>(to_utf8(cmd.argument()));
1070 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1071 b = theBufferList().next(b)) {
1073 ParIterator par = b->getParFromID(id);
1074 if (par == b->par_iterator_end()) {
1076 << "No matching paragraph found! ["
1077 << id << "]." << endl;
1080 << "Paragraph " << par->id()
1081 << " found in buffer `"
1082 << b->absFileName() << "'." << endl;
1084 if (b == &buffer_) {
1086 setCursor(makeDocIterator(par, 0));
1088 // Switch to other buffer view and resend cmd
1089 theLyXFunc().dispatch(FuncRequest(
1090 LFUN_BUFFER_SWITCH, b->absFileName()));
1091 theLyXFunc().dispatch(cmd);
1092 updateFlags = Update::None;
1101 case LFUN_OUTLINE_UP:
1102 outline(OutlineUp, d->cursor_);
1103 d->cursor_.text()->setCursor(d->cursor_, d->cursor_.pit(), 0);
1104 updateLabels(buffer_);
1106 case LFUN_OUTLINE_DOWN:
1107 outline(OutlineDown, d->cursor_);
1108 d->cursor_.text()->setCursor(d->cursor_, d->cursor_.pit(), 0);
1109 updateLabels(buffer_);
1111 case LFUN_OUTLINE_IN:
1112 outline(OutlineIn, d->cursor_);
1113 updateLabels(buffer_);
1115 case LFUN_OUTLINE_OUT:
1116 outline(OutlineOut, d->cursor_);
1117 updateLabels(buffer_);
1120 case LFUN_NOTE_NEXT:
1121 gotoInset(this, NOTE_CODE, false);
1124 case LFUN_REFERENCE_NEXT: {
1125 vector<InsetCode> tmp;
1126 tmp.push_back(LABEL_CODE);
1127 tmp.push_back(REF_CODE);
1128 gotoInset(this, tmp, true);
1132 case LFUN_CHANGES_TRACK:
1133 buffer_.params().trackChanges = !buffer_.params().trackChanges;
1136 case LFUN_CHANGES_OUTPUT:
1137 buffer_.params().outputChanges = !buffer_.params().outputChanges;
1138 if (buffer_.params().outputChanges) {
1139 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1140 bool xcolorsoul = LaTeXFeatures::isAvailable("soul") &&
1141 LaTeXFeatures::isAvailable("xcolor");
1143 if (!dvipost && !xcolorsoul) {
1144 Alert::warning(_("Changes not shown in LaTeX output"),
1145 _("Changes will not be highlighted in LaTeX output, "
1146 "because neither dvipost nor xcolor/soul are installed.\n"
1147 "Please install these packages or redefine "
1148 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1149 } else if (!xcolorsoul) {
1150 Alert::warning(_("Changes not shown in LaTeX output"),
1151 _("Changes will not be highlighted in LaTeX output "
1152 "when using pdflatex, because xcolor and soul are not installed.\n"
1153 "Please install both packages or redefine "
1154 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1159 case LFUN_CHANGE_NEXT:
1160 findNextChange(this);
1163 case LFUN_CHANGES_MERGE:
1164 if (findNextChange(this))
1165 showDialog("changes");
1168 case LFUN_ALL_CHANGES_ACCEPT:
1169 // select complete document
1170 d->cursor_.reset(buffer_.inset());
1171 d->cursor_.selHandle(true);
1172 buffer_.text().cursorBottom(d->cursor_);
1173 // accept everything in a single step to support atomic undo
1174 buffer_.text().acceptOrRejectChanges(d->cursor_, Text::ACCEPT);
1177 case LFUN_ALL_CHANGES_REJECT:
1178 // select complete document
1179 d->cursor_.reset(buffer_.inset());
1180 d->cursor_.selHandle(true);
1181 buffer_.text().cursorBottom(d->cursor_);
1182 // reject everything in a single step to support atomic undo
1183 // Note: reject does not work recursively; the user may have to repeat the operation
1184 buffer_.text().acceptOrRejectChanges(d->cursor_, Text::REJECT);
1187 case LFUN_WORD_FIND:
1191 case LFUN_WORD_REPLACE: {
1192 bool has_deleted = false;
1193 if (cur.selection()) {
1194 DocIterator beg = cur.selectionBegin();
1195 DocIterator end = cur.selectionEnd();
1196 if (beg.pit() == end.pit()) {
1197 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1198 if (cur.paragraph().isDeleted(p))
1203 replace(this, cmd, has_deleted);
1208 cur.clearSelection();
1210 cur.message(from_utf8(N_("Mark off")));
1214 cur.clearSelection();
1217 cur.message(from_utf8(N_("Mark on")));
1220 case LFUN_MARK_TOGGLE:
1221 cur.clearSelection();
1224 cur.message(from_utf8(N_("Mark removed")));
1227 cur.message(from_utf8(N_("Mark set")));
1232 case LFUN_SCREEN_RECENTER:
1236 case LFUN_BIBTEX_DATABASE_ADD: {
1237 Cursor tmpcur = d->cursor_;
1238 findInset(tmpcur, BIBTEX_CODE, false);
1239 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1242 if (inset->addDatabase(to_utf8(cmd.argument())))
1243 buffer_.updateBibfilesCache();
1248 case LFUN_BIBTEX_DATABASE_DEL: {
1249 Cursor tmpcur = d->cursor_;
1250 findInset(tmpcur, BIBTEX_CODE, false);
1251 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1254 if (inset->delDatabase(to_utf8(cmd.argument())))
1255 buffer_.updateBibfilesCache();
1260 case LFUN_WORDS_COUNT: {
1261 DocIterator from, to;
1262 if (cur.selection()) {
1263 from = cur.selectionBegin();
1264 to = cur.selectionEnd();
1266 from = doc_iterator_begin(buffer_.inset());
1267 to = doc_iterator_end(buffer_.inset());
1269 int const count = countWords(from, to);
1272 if (cur.selection())
1273 message = bformat(_("%1$d words in selection."),
1276 message = bformat(_("%1$d words in document."),
1280 if (cur.selection())
1281 message = _("One word in selection.");
1283 message = _("One word in document.");
1286 Alert::information(_("Count words"), message);
1290 case LFUN_BUFFER_TOGGLE_COMPRESSION:
1291 // turn compression on/off
1292 buffer_.params().compressed = !buffer_.params().compressed;
1295 case LFUN_BUFFER_TOGGLE_EMBEDDING:
1296 // turn embedding on/off
1297 buffer_.embeddedFiles().enable(!buffer_.params().embedded);
1300 case LFUN_NEXT_INSET_TOGGLE: {
1301 // this is the real function we want to invoke
1302 FuncRequest tmpcmd = FuncRequest(LFUN_INSET_TOGGLE, cmd.origin);
1303 // if there is an inset at cursor, see whether it
1305 Inset * inset = cur.nextInset();
1307 if (inset->isActive()) {
1308 Cursor tmpcur = cur;
1309 tmpcur.pushBackward(*inset);
1310 inset->dispatch(tmpcur, tmpcmd);
1311 if (tmpcur.result().dispatched()) {
1314 } else if (inset->editable() == Inset::IS_EDITABLE) {
1315 inset->edit(cur, true);
1318 // if it did not work, try the underlying inset.
1319 if (!cur.result().dispatched())
1320 cur.dispatch(tmpcmd);
1322 if (cur.result().dispatched())
1323 cur.clearSelection();
1328 case LFUN_SCREEN_UP:
1329 case LFUN_SCREEN_DOWN: {
1330 Point p = getPos(cur, cur.boundary());
1331 if (p.y_ < 0 || p.y_ > height_) {
1332 // The cursor is off-screen so recenter before proceeding.
1335 //FIXME: updateMetrics() does not update paragraph position
1336 // This is done at draw() time. So we need a redraw!
1338 p = getPos(cur, cur.boundary());
1340 scroll(cmd.action == LFUN_SCREEN_UP? - height_ : height_);
1341 cur.reset(buffer_.inset());
1342 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_);
1343 //FIXME: what to do with cur.x_target()?
1345 // The metrics are already up to date. see scroll()
1346 updateFlags = Update::None;
1350 case LFUN_SCREEN_UP_SELECT:
1351 case LFUN_SCREEN_DOWN_SELECT: {
1352 cur.selHandle(true);
1353 size_t initial_depth = cur.depth();
1354 Point const p = getPos(cur, cur.boundary());
1355 scroll(cmd.action == LFUN_SCREEN_UP_SELECT? - height_ : height_);
1356 // FIXME: We need to verify if the cursor stayed within an inset...
1357 //cur.reset(buffer_.inset());
1358 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_);
1360 while (cur.depth() > initial_depth) {
1363 // FIXME: we need to do a redraw again because of the selection
1365 updateFlags = Update::Force | Update::FitCursor;
1370 updateFlags = Update::None;
1377 docstring const BufferView::requestSelection()
1379 Cursor & cur = d->cursor_;
1381 if (!cur.selection()) {
1382 d->xsel_cache_.set = false;
1386 if (!d->xsel_cache_.set ||
1387 cur.top() != d->xsel_cache_.cursor ||
1388 cur.anchor_.top() != d->xsel_cache_.anchor)
1390 d->xsel_cache_.cursor = cur.top();
1391 d->xsel_cache_.anchor = cur.anchor_.top();
1392 d->xsel_cache_.set = cur.selection();
1393 return cur.selectionAsString(false);
1399 void BufferView::clearSelection()
1401 d->cursor_.clearSelection();
1402 // Clear the selection buffer. Otherwise a subsequent
1403 // middle-mouse-button paste would use the selection buffer,
1404 // not the more current external selection.
1405 cap::clearSelection();
1406 d->xsel_cache_.set = false;
1407 // The buffer did not really change, but this causes the
1408 // redraw we need because we cleared the selection above.
1413 void BufferView::resize(int width, int height)
1415 // Update from work area
1423 Inset const * BufferView::getCoveringInset(Text const & text, int x, int y)
1425 TextMetrics & tm = d->text_metrics_[&text];
1426 Inset * inset = tm.checkInsetHit(x, y);
1430 if (!inset->descendable())
1431 // No need to go further down if the inset is not
1435 size_t cell_number = inset->nargs();
1436 // Check all the inner cell.
1437 for (size_t i = 0; i != cell_number; ++i) {
1438 Text const * inner_text = inset->getText(i);
1441 Inset const * inset_deeper =
1442 getCoveringInset(*inner_text, x, y);
1444 return inset_deeper;
1452 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
1454 //lyxerr << BOOST_CURRENT_FUNCTION << "[ cmd0 " << cmd0 << "]" << endl;
1456 // This is only called for mouse related events including
1457 // LFUN_FILE_OPEN generated by drag-and-drop.
1458 FuncRequest cmd = cmd0;
1461 cur.push(buffer_.inset());
1462 cur.selection() = d->cursor_.selection();
1464 // Either the inset under the cursor or the
1465 // surrounding Text will handle this event.
1467 // make sure we stay within the screen...
1468 cmd.y = min(max(cmd.y, -1), height_);
1470 if (cmd.action == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
1472 // Get inset under mouse, if there is one.
1473 Inset const * covering_inset =
1474 getCoveringInset(buffer_.text(), cmd.x, cmd.y);
1475 if (covering_inset == d->last_inset_)
1476 // Same inset, no need to do anything...
1479 bool need_redraw = false;
1480 // const_cast because of setMouseHover().
1481 Inset * inset = const_cast<Inset *>(covering_inset);
1483 // Remove the hint on the last hovered inset (if any).
1484 need_redraw |= d->last_inset_->setMouseHover(false);
1486 // Highlighted the newly hovered inset (if any).
1487 need_redraw |= inset->setMouseHover(true);
1488 d->last_inset_ = inset;
1492 // if last metrics update was in singlepar mode, WorkArea::redraw() will
1493 // not expose the button for redraw. We adjust here the metrics dimension
1494 // to enable a full redraw in any case as this is not costly.
1495 TextMetrics & tm = d->text_metrics_[&buffer_.text()];
1496 std::pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
1497 std::pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
1498 int y1 = firstpm.second->position() - firstpm.second->ascent();
1499 int y2 = lastpm.second->position() + lastpm.second->descent();
1500 d->metrics_info_ = ViewMetricsInfo(firstpm.first, lastpm.first, y1, y2,
1501 FullScreenUpdate, buffer_.text().paragraphs().size());
1502 // Reinitialize anchor to first pit.
1503 d->anchor_ref_ = firstpm.first;
1504 d->offset_ref_ = -y1;
1505 LYXERR(Debug::PAINTING)
1506 << "Mouse hover detected at: (" << cmd.x << ", " << cmd.y << ")"
1507 << "\nTriggering redraw: y1: " << y1 << " y2: " << y2
1508 << " pit1: " << firstpm.first << " pit2: " << lastpm.first << endl;
1510 // This event (moving without mouse click) is not passed further.
1511 // This should be changed if it is further utilized.
1516 // Build temporary cursor.
1517 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x, cmd.y);
1519 // Put anchor at the same position.
1522 // Try to dispatch to an non-editable inset near this position
1523 // via the temp cursor. If the inset wishes to change the real
1524 // cursor it has to do so explicitly by using
1525 // cur.bv().cursor() = cur; (or similar)
1527 inset->dispatch(cur, cmd);
1529 // Now dispatch to the temporary cursor. If the real cursor should
1530 // be modified, the inset's dispatch has to do so explicitly.
1531 if (!cur.result().dispatched())
1534 //Do we have a selection?
1535 theSelection().haveSelection(cursor().selection());
1537 // If the command has been dispatched,
1538 if (cur.result().dispatched()
1539 // an update is asked,
1540 && cur.result().update())
1541 processUpdateFlags(cur.result().update());
1545 void BufferView::scroll(int y)
1554 void BufferView::scrollDown(int offset)
1556 Text * text = &buffer_.text();
1557 TextMetrics & tm = d->text_metrics_[text];
1558 int ymax = height_ + offset;
1560 std::pair<pit_type, ParagraphMetrics const *> last = tm.last();
1561 int bottom_pos = last.second->position() + last.second->descent();
1562 if (last.first + 1 == int(text->paragraphs().size())) {
1563 if (bottom_pos <= height_)
1565 offset = min(offset, bottom_pos - height_);
1568 if (bottom_pos > ymax)
1570 tm.newParMetricsDown();
1572 d->offset_ref_ += offset;
1578 void BufferView::scrollUp(int offset)
1580 Text * text = &buffer_.text();
1581 TextMetrics & tm = d->text_metrics_[text];
1582 int ymin = - offset;
1584 std::pair<pit_type, ParagraphMetrics const *> first = tm.first();
1585 int top_pos = first.second->position() - first.second->ascent();
1586 if (first.first == 0) {
1589 offset = min(offset, - top_pos);
1594 tm.newParMetricsUp();
1596 d->offset_ref_ -= offset;
1602 void BufferView::setCursorFromRow(int row)
1607 buffer_.texrow().getIdFromRow(row, tmpid, tmppos);
1609 d->cursor_.reset(buffer_.inset());
1611 buffer_.text().setCursor(d->cursor_, 0, 0);
1613 buffer_.text().setCursor(d->cursor_, buffer_.getParFromID(tmpid).pit(), tmppos);
1617 void BufferView::gotoLabel(docstring const & label)
1619 for (InsetIterator it = inset_iterator_begin(buffer_.inset()); it; ++it) {
1620 vector<docstring> labels;
1621 it->getLabelList(buffer_, labels);
1622 if (std::find(labels.begin(), labels.end(), label) != labels.end()) {
1624 processUpdateFlags(Update::FitCursor);
1631 TextMetrics const & BufferView::textMetrics(Text const * t) const
1633 return const_cast<BufferView *>(this)->textMetrics(t);
1637 TextMetrics & BufferView::textMetrics(Text const * t)
1639 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
1640 if (tmc_it == d->text_metrics_.end()) {
1641 tmc_it = d->text_metrics_.insert(
1642 make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
1644 return tmc_it->second;
1648 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
1651 return textMetrics(t).parMetrics(pit);
1655 int BufferView::workHeight() const
1661 void BufferView::setCursor(DocIterator const & dit)
1663 size_t const n = dit.depth();
1664 for (size_t i = 0; i < n; ++i)
1665 dit[i].inset().edit(d->cursor_, true);
1667 d->cursor_.setCursor(dit);
1668 d->cursor_.selection() = false;
1672 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
1674 // Would be wrong to delete anything if we have a selection.
1675 if (cur.selection())
1678 bool need_anchor_change = false;
1679 bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
1680 need_anchor_change);
1682 if (need_anchor_change)
1688 updateLabels(buffer_);
1696 bool BufferView::mouseSetCursor(Cursor & cur, bool select)
1698 BOOST_ASSERT(&cur.bv() == this);
1701 // this event will clear selection so we save selection for
1702 // persistent selection
1703 cap::saveSelection(cursor());
1705 // Has the cursor just left the inset?
1706 bool badcursor = false;
1707 bool leftinset = (&d->cursor_.inset() != &cur.inset());
1709 badcursor = notifyCursorLeaves(d->cursor_, cur);
1711 // FIXME: shift-mouse selection doesn't work well across insets.
1712 bool do_selection = select && &d->cursor_.anchor().inset() == &cur.inset();
1714 // do the dEPM magic if needed
1715 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
1716 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
1717 // the leftinset bool would not be necessary (badcursor instead).
1718 bool update = leftinset;
1719 if (!do_selection && !badcursor && d->cursor_.inTexted())
1720 update |= checkDepm(cur, d->cursor_);
1722 // if the cursor was in an empty script inset and the new
1723 // position is in the nucleus of the inset, notifyCursorLeaves
1724 // will kill the script inset itself. So we check all the
1725 // elements of the cursor to make sure that they are correct.
1726 // For an example, see bug 2933:
1727 // http://bugzilla.lyx.org/show_bug.cgi?id=2933
1728 // The code below could maybe be moved to a DocIterator method.
1729 //lyxerr << "cur before " << cur <<std::endl;
1730 DocIterator dit(cur.inset());
1731 dit.push_back(cur.bottom());
1733 while (i < cur.depth() && dit.nextInset() == &cur[i].inset()) {
1734 dit.push_back(cur[i]);
1737 //lyxerr << "5 cur after" << dit <<std::endl;
1739 d->cursor_.setCursor(dit);
1740 d->cursor_.boundary(cur.boundary());
1742 d->cursor_.setSelection();
1744 d->cursor_.clearSelection();
1746 d->cursor_.finishUndo();
1747 d->cursor_.setCurrentFont();
1752 void BufferView::putSelectionAt(DocIterator const & cur,
1753 int length, bool backwards)
1755 d->cursor_.clearSelection();
1761 d->cursor_.pos() += length;
1762 d->cursor_.setSelection(d->cursor_, -length);
1764 d->cursor_.setSelection(d->cursor_, length);
1769 Cursor & BufferView::cursor()
1775 Cursor const & BufferView::cursor() const
1781 pit_type BufferView::anchor_ref() const
1783 return d->anchor_ref_;
1787 ViewMetricsInfo const & BufferView::viewMetricsInfo()
1789 return d->metrics_info_;
1793 bool BufferView::singleParUpdate()
1795 Text & buftext = buffer_.text();
1796 pit_type const bottom_pit = d->cursor_.bottom().pit();
1797 TextMetrics & tm = textMetrics(&buftext);
1798 int old_height = tm.parMetrics(bottom_pit).height();
1800 // In Single Paragraph mode, rebreak only
1801 // the (main text, not inset!) paragraph containing the cursor.
1802 // (if this paragraph contains insets etc., rebreaking will
1803 // recursively descend)
1804 tm.redoParagraph(bottom_pit);
1805 ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
1806 if (pm.height() != old_height)
1807 // Paragraph height has changed so we cannot proceed to
1808 // the singlePar optimisation.
1811 int y1 = pm.position() - pm.ascent();
1812 int y2 = pm.position() + pm.descent();
1813 d->metrics_info_ = ViewMetricsInfo(bottom_pit, bottom_pit, y1, y2,
1814 SingleParUpdate, buftext.paragraphs().size());
1815 LYXERR(Debug::PAINTING)
1816 << BOOST_CURRENT_FUNCTION
1819 << " pit: " << bottom_pit
1826 void BufferView::updateMetrics()
1828 Text & buftext = buffer_.text();
1829 pit_type const npit = int(buftext.paragraphs().size());
1831 if (d->anchor_ref_ > int(npit - 1)) {
1832 d->anchor_ref_ = int(npit - 1);
1836 // Clear out the position cache in case of full screen redraw,
1837 d->coord_cache_.clear();
1839 // Clear out paragraph metrics to avoid having invalid metrics
1840 // in the cache from paragraphs not relayouted below
1841 // The complete text metrics will be redone.
1842 d->text_metrics_.clear();
1844 TextMetrics & tm = textMetrics(&buftext);
1846 pit_type const pit = d->anchor_ref_;
1850 // Rebreak anchor paragraph.
1851 tm.redoParagraph(pit);
1853 // Take care of anchor offset if case a recentering is needed.
1856 int y0 = tm.parMetrics(pit).ascent() - d->offset_ref_;
1858 // Redo paragraphs above anchor if necessary.
1860 while (y1 > 0 && pit1 > 0) {
1861 y1 -= tm.parMetrics(pit1).ascent();
1863 tm.redoParagraph(pit1);
1864 y1 -= tm.parMetrics(pit1).descent();
1867 // Take care of ascent of first line
1868 y1 -= tm.parMetrics(pit1).ascent();
1870 // Normalize anchor for next time
1871 d->anchor_ref_ = pit1;
1872 d->offset_ref_ = -y1;
1874 // Grey at the beginning is ugly
1875 if (pit1 == 0 && y1 > 0) {
1881 // Redo paragraphs below the anchor if necessary.
1883 while (y2 < height_ && pit2 < int(npit) - 1) {
1884 y2 += tm.parMetrics(pit2).descent();
1886 tm.redoParagraph(pit2);
1887 y2 += tm.parMetrics(pit2).ascent();
1890 // Take care of descent of last line
1891 y2 += tm.parMetrics(pit2).descent();
1893 LYXERR(Debug::PAINTING)
1894 << BOOST_CURRENT_FUNCTION
1897 << " pit1: " << pit1
1898 << " pit2: " << pit2
1899 << " npit: " << npit
1903 d->metrics_info_ = ViewMetricsInfo(pit1, pit2, y1, y2,
1904 FullScreenUpdate, npit);
1906 if (lyxerr.debugging(Debug::WORKAREA)) {
1907 LYXERR(Debug::WORKAREA) << "BufferView::updateMetrics" << endl;
1908 d->coord_cache_.dump();
1913 void BufferView::menuInsertLyXFile(string const & filenm)
1915 BOOST_ASSERT(d->cursor_.inTexted());
1916 string filename = filenm;
1918 if (filename.empty()) {
1919 // Launch a file browser
1921 string initpath = lyxrc.document_path;
1922 string const trypath = buffer_.filePath();
1923 // If directory is writeable, use this as default.
1924 if (FileName(trypath).isDirWritable())
1928 FileDialog dlg(_("Select LyX document to insert"), LFUN_FILE_INSERT);
1929 dlg.setButton1(_("Documents|#o#O"), from_utf8(lyxrc.document_path));
1930 dlg.setButton2(_("Examples|#E#e"),
1931 from_utf8(addPath(package().system_support().absFilename(),
1934 FileDialog::Result result =
1935 dlg.open(from_utf8(initpath),
1936 FileFilterList(_("LyX Documents (*.lyx)")),
1939 if (result.first == FileDialog::Later)
1943 filename = to_utf8(result.second);
1945 // check selected filename
1946 if (filename.empty()) {
1947 // emit message signal.
1948 message(_("Canceled."));
1953 // Get absolute path of file and add ".lyx"
1954 // to the filename if necessary
1955 filename = fileSearch(string(), filename, "lyx").absFilename();
1957 docstring const disp_fn = makeDisplayPath(filename);
1958 // emit message signal.
1959 message(bformat(_("Inserting document %1$s..."), disp_fn));
1962 Buffer buf("", false);
1963 if (buf.loadLyXFile(FileName(filename))) {
1964 ErrorList & el = buffer_.errorList("Parse");
1965 // Copy the inserted document error list into the current buffer one.
1966 el = buf.errorList("Parse");
1967 buffer_.undo().recordUndo(d->cursor_);
1968 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
1969 buf.params().getTextClassPtr(), el);
1970 res = _("Document %1$s inserted.");
1972 res = _("Could not insert document %1$s");
1975 // emit message signal.
1976 message(bformat(res, disp_fn));
1977 buffer_.errors("Parse");
1982 Point BufferView::coordOffset(DocIterator const & dit, bool boundary) const
1988 // Addup contribution of nested insets, from inside to outside,
1989 // keeping the outer paragraph for a special handling below
1990 for (size_t i = dit.depth() - 1; i >= 1; --i) {
1991 CursorSlice const & sl = dit[i];
1995 // get relative position inside sl.inset()
1996 sl.inset().cursorPos(*this, sl, boundary && (i + 1 == dit.depth()), xx, yy);
1998 // Make relative position inside of the edited inset relative to sl.inset()
2002 // In case of an RTL inset, the edited inset will be positioned to the left
2005 bool boundary_i = boundary && i + 1 == dit.depth();
2006 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2011 // remember width for the case that sl.inset() is positioned in an RTL inset
2012 if (i && dit[i - 1].text()) {
2013 // If this Inset is inside a Text Inset, retrieve the Dimension
2014 // from the containing text instead of using Inset::dimension() which
2015 // might not be implemented.
2016 // FIXME (Abdel 23/09/2007): this is a bit messy because of the
2017 // elimination of Inset::dim_ cache. This coordOffset() method needs
2018 // to be rewritten in light of the new design.
2019 Dimension const & dim = parMetrics(dit[i - 1].text(),
2020 dit[i - 1].pit()).insetDimension(&sl.inset());
2023 Dimension const dim = sl.inset().dimension(*this);
2027 //lyxerr << "Cursor::getPos, i: "
2028 // << i << " x: " << xx << " y: " << y << endl;
2031 // Add contribution of initial rows of outermost paragraph
2032 CursorSlice const & sl = dit[0];
2033 TextMetrics const & tm = textMetrics(sl.text());
2034 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2035 BOOST_ASSERT(!pm.rows().empty());
2036 y -= pm.rows()[0].ascent();
2038 // FIXME: document this mess
2040 if (sl.pos() > 0 && dit.depth() == 1) {
2042 if (pos && boundary)
2044 // lyxerr << "coordOffset: boundary:" << boundary << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << std::endl;
2045 rend = pm.pos2row(pos);
2047 rend = pm.pos2row(sl.pos());
2049 size_t rend = pm.pos2row(sl.pos());
2051 for (size_t rit = 0; rit != rend; ++rit)
2052 y += pm.rows()[rit].height();
2053 y += pm.rows()[rend].ascent();
2055 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
2057 // Make relative position from the nested inset now bufferview absolute.
2058 int xx = bottom_tm.cursorX(dit.bottom(), boundary && dit.depth() == 1);
2061 // In the RTL case place the nested inset at the left of the cursor in
2062 // the outer paragraph
2063 bool boundary_1 = boundary && 1 == dit.depth();
2064 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
2072 Point BufferView::getPos(DocIterator const & dit, bool boundary) const
2074 CursorSlice const & bot = dit.bottom();
2075 TextMetrics const & tm = textMetrics(bot.text());
2076 if (!tm.has(bot.pit()))
2077 return Point(-1, -1);
2079 Point p = coordOffset(dit, boundary); // offset from outer paragraph
2080 p.y_ += tm.parMetrics(bot.pit()).position();
2085 void BufferView::draw(frontend::Painter & pain)
2087 PainterInfo pi(this, pain);
2088 // Should the whole screen, including insets, be refreshed?
2089 // FIXME: We should also distinguish DecorationUpdate to avoid text
2090 // drawing if possible. This is not possible to do easily right now
2091 // because of the single backing pixmap.
2092 pi.full_repaint = d->metrics_info_.update_strategy != SingleParUpdate;
2094 if (pi.full_repaint)
2095 // Clear background (if not delegated to rows)
2096 pain.fillRectangle(0, d->metrics_info_.y1, width_,
2097 d->metrics_info_.y2 - d->metrics_info_.y1,
2098 buffer_.inset().backgroundColor());
2100 LYXERR(Debug::PAINTING) << "\t\t*** START DRAWING ***" << endl;
2101 Text & text = buffer_.text();
2102 TextMetrics const & tm = d->text_metrics_[&text];
2103 int y = d->metrics_info_.y1 + tm.parMetrics(d->metrics_info_.p1).ascent();
2104 if (!pi.full_repaint)
2105 tm.drawParagraph(pi, d->metrics_info_.p1, 0, y);
2108 LYXERR(Debug::PAINTING) << "\n\t\t*** END DRAWING ***" << endl;
2110 // and grey out above (should not happen later)
2111 // lyxerr << "par ascent: " << text.getPar(d->metrics_info_.p1).ascent() << endl;
2112 if (d->metrics_info_.y1 > 0
2113 && d->metrics_info_.update_strategy == FullScreenUpdate)
2114 pain.fillRectangle(0, 0, width_, d->metrics_info_.y1, Color_bottomarea);
2116 // and possibly grey out below
2117 // lyxerr << "par descent: " << text.getPar(d->metrics_info_.p1).ascent() << endl;
2118 if (d->metrics_info_.y2 < height_
2119 && d->metrics_info_.update_strategy == FullScreenUpdate)
2120 pain.fillRectangle(0, d->metrics_info_.y2, width_,
2121 height_ - d->metrics_info_.y2, Color_bottomarea);
2125 void BufferView::message(docstring const & msg)
2128 d->gui_->message(msg);
2132 void BufferView::showDialog(std::string const & name)
2135 d->gui_->showDialog(name);
2139 void BufferView::showDialogWithData(std::string const & name,
2140 std::string const & data)
2143 d->gui_->showDialogWithData(name, data);
2147 void BufferView::showInsetDialog(std::string const & name,
2148 std::string const & data, Inset * inset)
2151 d->gui_->showInsetDialog(name, data, inset);
2155 void BufferView::updateDialog(std::string const & name, std::string const & data)
2158 d->gui_->updateDialog(name, data);
2162 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
2168 // FIXME: Move this out of BufferView again
2169 docstring BufferView::contentsOfPlaintextFile(string const & f,
2174 if (fname.empty()) {
2175 FileDialog dlg(_("Select file to insert"),
2177 ? LFUN_FILE_INSERT_PLAINTEXT_PARA
2178 : LFUN_FILE_INSERT_PLAINTEXT) );
2180 FileDialog::Result result =
2181 dlg.open(from_utf8(buffer().filePath()),
2182 FileFilterList(), docstring());
2184 if (result.first == FileDialog::Later)
2187 fname = makeAbsPath(to_utf8(result.second));
2193 if (!fs::is_readable(fname.toFilesystemEncoding())) {
2194 docstring const error = from_ascii(strerror(errno));
2195 docstring const file = makeDisplayPath(fname.absFilename(), 50);
2196 docstring const text =
2197 bformat(_("Could not read the specified document\n"
2198 "%1$s\ndue to the error: %2$s"), file, error);
2199 Alert::error(_("Could not read file"), text);
2203 ifstream ifs(fname.toFilesystemEncoding().c_str());
2205 docstring const error = from_ascii(strerror(errno));
2206 docstring const file = makeDisplayPath(fname.absFilename(), 50);
2207 docstring const text =
2208 bformat(_("Could not open the specified document\n"
2209 "%1$s\ndue to the error: %2$s"), file, error);
2210 Alert::error(_("Could not open file"), text);
2214 ifs.unsetf(std::ios::skipws);
2215 istream_iterator<char> ii(ifs);
2216 istream_iterator<char> end;
2217 #if !defined(USE_INCLUDED_STRING) && !defined(STD_STRING_IS_GOOD)
2218 // We use this until the compilers get better...
2219 std::vector<char> tmp;
2220 copy(ii, end, back_inserter(tmp));
2221 string const tmpstr(tmp.begin(), tmp.end());
2223 // This is what we want to use and what we will use once the
2224 // compilers get good enough.
2225 //string tmpstr(ii, end); // yet a reason for using std::string
2226 // alternate approach to get the file into a string:
2228 copy(ii, end, back_inserter(tmpstr));
2231 // FIXME UNICODE: We don't know the encoding of the file
2232 docstring file_content = from_utf8(tmpstr);
2233 if (file_content.empty()) {
2234 Alert::error(_("Reading not UTF-8 encoded file"),
2235 _("The file is not UTF-8 encoded.\n"
2236 "It will be read as local 8Bit-encoded.\n"
2237 "If this does not give the correct result\n"
2238 "then please change the encoding of the file\n"
2239 "to UTF-8 with a program other than LyX.\n"));
2240 file_content = from_local8bit(tmpstr);
2243 return normalize_c(file_content);
2247 void BufferView::insertPlaintextFile(string const & f, bool asParagraph)
2249 docstring const tmpstr = contentsOfPlaintextFile(f, asParagraph);
2254 Cursor & cur = cursor();
2255 cap::replaceSelection(cur);
2256 buffer_.undo().recordUndo(cur);
2258 cur.innerText()->insertStringAsParagraphs(cur, tmpstr);
2260 cur.innerText()->insertStringAsLines(cur, tmpstr);