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 "bufferview_funcs.h"
24 #include "callback.h" // added for Dispatch functions
25 #include "CoordCache.h"
26 #include "CutAndPaste.h"
28 #include "DispatchResult.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"
52 #include "TextClass.h"
56 #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/FileDialog.h"
65 #include "frontends/FontMetrics.h"
66 #include "frontends/Painter.h"
67 #include "frontends/Selection.h"
69 #include "graphics/Previews.h"
71 #include "support/convert.h"
72 #include "support/FileFilterList.h"
73 #include "support/filetools.h"
74 #include "support/Package.h"
75 #include "support/types.h"
77 #include <boost/bind.hpp>
78 #include <boost/current_function.hpp>
85 using std::istringstream;
89 using std::mem_fun_ref;
96 using support::addPath;
97 using support::bformat;
98 using support::FileFilterList;
99 using support::FileName;
100 using support::fileSearch;
101 using support::isDirWriteable;
102 using support::isFileReadable;
103 using support::makeDisplayPath;
104 using support::package;
106 namespace Alert = frontend::Alert;
110 /// Return an inset of this class if it exists at the current cursor position
112 T * getInsetByCode(Cursor & cur, Inset::Code code)
115 DocIterator it = cur;
116 if (it.nextInset() &&
117 it.nextInset()->lyxCode() == code) {
118 inset = static_cast<T*>(it.nextInset());
126 BufferView::BufferView(Buffer & buf)
127 : width_(0), height_(0), buffer_(buf), wh_(0),
129 multiparsel_cache_(false), anchor_ref_(0), offset_ref_(0),
130 need_centering_(false), intl_(new Intl), last_inset_(0)
132 xsel_cache_.set = false;
133 intl_->initKeyMapper(lyxrc.use_kbmap);
135 cursor_.push(buffer_.inset());
136 cursor_.resetAnchor();
137 cursor_.setCurrentFont();
139 if (graphics::Previews::status() != LyXRC::PREVIEW_OFF)
140 graphics::Previews::get().generateBufferPreviews(buffer_);
144 BufferView::~BufferView()
146 // current buffer is going to be switched-off, save cursor pos
147 // Ideally, the whole cursor stack should be saved, but session
148 // currently can only handle bottom (whole document) level pit and pos.
149 // That is to say, if a cursor is in a nested inset, it will be
150 // restore to the left of the top level inset.
151 LyX::ref().session().lastFilePos().save(
152 support::FileName(buffer_.fileName()),
153 boost::tie(cursor_.bottom().pit(), cursor_.bottom().pos()) );
157 Buffer & BufferView::buffer()
163 Buffer const & BufferView::buffer() const
169 bool BufferView::fitCursor()
171 if (bv_funcs::status(this, cursor_) == bv_funcs::CUR_INSIDE) {
172 frontend::FontMetrics const & fm =
173 theFontMetrics(cursor_.getFont());
174 int const asc = fm.maxAscent();
175 int const des = fm.maxDescent();
176 Point const p = bv_funcs::getPos(*this, cursor_, cursor_.boundary());
177 if (p.y_ - asc >= 0 && p.y_ + des < height_)
185 bool BufferView::multiParSel()
187 if (!cursor_.selection())
189 bool ret = multiparsel_cache_;
190 multiparsel_cache_ = cursor_.selBegin().pit() != cursor_.selEnd().pit();
191 // Either this, or previous selection spans paragraphs
192 return ret || multiparsel_cache_;
196 bool BufferView::update(Update::flags flags)
198 // last_inset_ points to the last visited inset. This pointer may become
199 // invalid because of keyboard editing. Since all such operations
200 // causes screen update(), I reset last_inset_ to avoid such a problem.
202 // This is close to a hot-path.
204 << BOOST_CURRENT_FUNCTION
205 << "[fitcursor = " << (flags & Update::FitCursor)
206 << ", forceupdate = " << (flags & Update::Force)
207 << ", singlepar = " << (flags & Update::SinglePar)
208 << "] buffer: " << &buffer_ << endl;
210 // Update macro store
211 if (!(cursor().inMathed() && cursor().inMacroMode()))
212 buffer_.buildMacros();
214 // Now do the first drawing step if needed. This consists on updating
215 // the CoordCache in updateMetrics().
216 // The second drawing step is done in WorkArea::redraw() if needed.
218 // Case when no explicit update is requested.
220 // no need to redraw anything.
221 metrics_info_.update_strategy = NoScreenUpdate;
225 if (flags == Update::Decoration) {
226 metrics_info_.update_strategy = DecorationUpdate;
230 if (flags == Update::FitCursor
231 || flags == (Update::Decoration | Update::FitCursor)) {
232 bool const fit_cursor = fitCursor();
233 // tell the frontend to update the screen if needed.
235 updateMetrics(false);
238 if (flags & Update::Decoration) {
239 metrics_info_.update_strategy = DecorationUpdate;
242 // no screen update is needed.
243 metrics_info_.update_strategy = NoScreenUpdate;
247 bool full_metrics = flags & Update::Force;
248 if (flags & Update::MultiParSel)
249 full_metrics |= multiParSel();
251 bool const single_par = !full_metrics;
252 updateMetrics(single_par);
254 if (flags & Update::FitCursor) {
255 //FIXME: updateMetrics() does not update paragraph position
256 // This is done at draw() time. So we need a redraw!
259 updateMetrics(false);
262 // tell the frontend to update the screen.
267 void BufferView::updateScrollbar()
269 Text & t = buffer_.text();
270 TextMetrics & tm = text_metrics_[&t];
272 int const parsize = int(t.paragraphs().size() - 1);
273 if (anchor_ref_ > parsize) {
274 anchor_ref_ = parsize;
279 << BOOST_CURRENT_FUNCTION
280 << " Updating scrollbar: height: " << t.paragraphs().size()
281 << " curr par: " << cursor_.bottom().pit()
282 << " default height " << defaultRowHeight() << endl;
284 // It would be better to fix the scrollbar to understand
285 // values in [0..1] and divide everything by wh
287 // estimated average paragraph height:
291 int h = tm.parMetrics(anchor_ref_).height();
293 // Normalize anchor/offset (MV):
294 while (offset_ref_ > h && anchor_ref_ < parsize) {
297 h = tm.parMetrics(anchor_ref_).height();
299 // Look at paragraph heights on-screen
302 for (pit_type pit = anchor_ref_; pit <= parsize; ++pit) {
305 int const h2 = tm.parMetrics(pit).height();
311 int const hav = sumh / nh;
312 // More realistic average paragraph height
317 scrollbarParameters_.height = (parsize + 1) * wh_;
318 scrollbarParameters_.position = anchor_ref_ * wh_ + int(offset_ref_ * wh_ / float(h));
319 scrollbarParameters_.lineScrollHeight = int(wh_ * defaultRowHeight() / float(h));
323 ScrollbarParameters const & BufferView::scrollbarParameters() const
325 return scrollbarParameters_;
329 void BufferView::scrollDocView(int value)
331 LYXERR(Debug::GUI) << BOOST_CURRENT_FUNCTION
332 << "[ value = " << value << "]" << endl;
334 Text & t = buffer_.text();
335 TextMetrics & tm = text_metrics_[&t];
337 float const bar = value / float(wh_ * t.paragraphs().size());
339 anchor_ref_ = int(bar * t.paragraphs().size());
340 if (anchor_ref_ > int(t.paragraphs().size()) - 1)
341 anchor_ref_ = int(t.paragraphs().size()) - 1;
343 tm.redoParagraph(anchor_ref_);
344 int const h = tm.parMetrics(anchor_ref_).height();
345 offset_ref_ = int((bar * t.paragraphs().size() - anchor_ref_) * h);
346 updateMetrics(false);
351 void BufferView::setCursorFromScrollbar()
353 TextMetrics & tm = text_metrics_[&buffer_.text()];
355 int const height = 2 * defaultRowHeight();
356 int const first = height;
357 int const last = height_ - height;
358 Cursor & cur = cursor_;
360 bv_funcs::CurStatus st = bv_funcs::status(this, cur);
363 case bv_funcs::CUR_ABOVE:
364 // We reset the cursor because bv_funcs::status() does not
365 // work when the cursor is within mathed.
366 cur.reset(buffer_.inset());
367 tm.setCursorFromCoordinates(cur, 0, first);
368 cur.clearSelection();
370 case bv_funcs::CUR_BELOW:
371 // We reset the cursor because bv_funcs::status() does not
372 // work when the cursor is within mathed.
373 cur.reset(buffer_.inset());
374 tm.setCursorFromCoordinates(cur, 0, last);
375 cur.clearSelection();
377 case bv_funcs::CUR_INSIDE:
378 int const y = bv_funcs::getPos(*this, cur, cur.boundary()).y_;
379 int const newy = min(last, max(y, first));
381 cur.reset(buffer_.inset());
382 tm.setCursorFromCoordinates(cur, 0, newy);
388 Change const BufferView::getCurrentChange() const
390 if (!cursor_.selection())
391 return Change(Change::UNCHANGED);
393 DocIterator dit = cursor_.selectionBegin();
394 return dit.paragraph().lookupChange(dit.pos());
398 void BufferView::saveBookmark(unsigned int idx)
400 // tenatively save bookmark, id and pos will be used to
401 // acturately locate a bookmark in a 'live' lyx session.
402 // pit and pos will be updated with bottom level pit/pos
404 LyX::ref().session().bookmarks().save(
405 FileName(buffer_.fileName()),
406 cursor_.bottom().pit(),
407 cursor_.bottom().pos(),
408 cursor_.paragraph().id(),
413 // emit message signal.
414 message(_("Save bookmark"));
418 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
419 int top_id, pos_type top_pos)
421 bool success = false;
424 cursor_.clearSelection();
426 // if a valid par_id is given, try it first
427 // This is the case for a 'live' bookmark when unique paragraph ID
428 // is used to track bookmarks.
430 ParIterator par = buffer_.getParFromID(top_id);
431 if (par != buffer_.par_iterator_end()) {
432 doc_it = makeDocIterator(par, min(par->size(), top_pos));
433 // Some slices of the iterator may not be
434 // reachable (e.g. closed collapsable inset)
435 // so the dociterator may need to be
436 // shortened. Otherwise, setCursor may crash
437 // lyx when the cursor can not be set to these
439 size_t const n = doc_it.depth();
440 for (size_t i = 0; i < n; ++i)
441 if (doc_it[i].inset().editable() != Inset::HIGHLY_EDITABLE) {
449 // if top_id == 0, or searching through top_id failed
450 // This is the case for a 'restored' bookmark when only bottom
451 // (document level) pit was saved. Because of this, bookmark
452 // restoration is inaccurate. If a bookmark was within an inset,
453 // it will be restored to the left of the outmost inset that contains
455 if (static_cast<size_t>(bottom_pit) < buffer_.paragraphs().size()) {
456 doc_it = doc_iterator_begin(buffer_.inset());
457 doc_it.pit() = bottom_pit;
458 doc_it.pos() = min(bottom_pos, doc_it.paragraph().size());
463 // Note: only bottom (document) level pit is set.
465 // set the current font.
466 cursor_.setCurrentFont();
467 // center the screen on this new position.
475 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
477 if (lyxrc.rtl_support) {
478 if (cursor_.real_current_font.isRightToLeft()) {
479 if (intl_->keymap == Intl::PRIMARY)
482 if (intl_->keymap == Intl::SECONDARY)
487 intl_->getTransManager().translateAndInsert(c, t, cur);
491 int BufferView::workWidth() const
497 void BufferView::updateOffsetRef()
499 // No need to update offset_ref_ in this case.
500 if (!need_centering_)
503 // We are not properly started yet, delay until resizing is
508 CursorSlice & bot = cursor_.bottom();
509 TextMetrics & tm = text_metrics_[bot.text()];
510 ParagraphMetrics const & pm = tm.parMetrics(bot.pit());
511 Point p = bv_funcs::coordOffset(*this, cursor_, cursor_.boundary());
512 offset_ref_ = p.y_ + pm.ascent() - height_ / 2;
514 need_centering_ = false;
518 void BufferView::center()
520 anchor_ref_ = cursor_.bottom().pit();
521 need_centering_ = true;
525 FuncStatus BufferView::getStatus(FuncRequest const & cmd)
529 Cursor & cur = cursor_;
531 switch (cmd.action) {
534 flag.enabled(!buffer_.undostack().empty());
537 flag.enabled(!buffer_.redostack().empty());
539 case LFUN_FILE_INSERT:
540 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
541 case LFUN_FILE_INSERT_PLAINTEXT:
542 case LFUN_BOOKMARK_SAVE:
543 // FIXME: Actually, these LFUNS should be moved to Text
544 flag.enabled(cur.inTexted());
546 case LFUN_FONT_STATE:
547 case LFUN_LABEL_INSERT:
548 case LFUN_PARAGRAPH_GOTO:
549 // FIXME handle non-trivially
550 case LFUN_OUTLINE_UP:
551 case LFUN_OUTLINE_DOWN:
552 case LFUN_OUTLINE_IN:
553 case LFUN_OUTLINE_OUT:
555 case LFUN_REFERENCE_NEXT:
557 case LFUN_WORD_REPLACE:
560 case LFUN_MARK_TOGGLE:
561 case LFUN_SCREEN_RECENTER:
562 case LFUN_BIBTEX_DATABASE_ADD:
563 case LFUN_BIBTEX_DATABASE_DEL:
564 case LFUN_WORDS_COUNT:
565 case LFUN_NEXT_INSET_TOGGLE:
569 case LFUN_LABEL_GOTO: {
570 flag.enabled(!cmd.argument().empty()
571 || getInsetByCode<InsetRef>(cur, Inset::REF_CODE));
575 case LFUN_CHANGES_TRACK:
577 flag.setOnOff(buffer_.params().trackChanges);
580 case LFUN_CHANGES_OUTPUT:
582 flag.setOnOff(buffer_.params().outputChanges);
585 case LFUN_CHANGES_MERGE:
586 case LFUN_CHANGE_NEXT:
587 case LFUN_ALL_CHANGES_ACCEPT:
588 case LFUN_ALL_CHANGES_REJECT:
589 // TODO: context-sensitive enabling of LFUNs
590 // In principle, these command should only be enabled if there
591 // is a change in the document. However, without proper
592 // optimizations, this will inevitably result in poor performance.
596 case LFUN_BUFFER_TOGGLE_COMPRESSION: {
597 flag.setOnOff(buffer_.params().compressed);
602 case LFUN_SCREEN_DOWN:
606 // FIXME: LFUN_SCREEN_DOWN_SELECT should be removed from
607 // everywhere else before this can enabled:
608 case LFUN_SCREEN_UP_SELECT:
609 case LFUN_SCREEN_DOWN_SELECT:
621 Update::flags BufferView::dispatch(FuncRequest const & cmd)
623 //lyxerr << BOOST_CURRENT_FUNCTION
624 // << [ cmd = " << cmd << "]" << endl;
626 // Make sure that the cached BufferView is correct.
627 LYXERR(Debug::ACTION) << BOOST_CURRENT_FUNCTION
628 << " action[" << cmd.action << ']'
629 << " arg[" << to_utf8(cmd.argument()) << ']'
630 << " x[" << cmd.x << ']'
631 << " y[" << cmd.y << ']'
632 << " button[" << cmd.button() << ']'
635 Cursor & cur = cursor_;
636 // Default Update flags.
637 Update::flags updateFlags = Update::Force | Update::FitCursor;
639 switch (cmd.action) {
642 cur.message(_("Undo"));
643 cur.clearSelection();
644 if (!textUndo(*this)) {
645 cur.message(_("No further undo information"));
646 updateFlags = Update::None;
651 cur.message(_("Redo"));
652 cur.clearSelection();
653 if (!textRedo(*this)) {
654 cur.message(_("No further redo information"));
655 updateFlags = Update::None;
659 case LFUN_FILE_INSERT:
661 menuInsertLyXFile(to_utf8(cmd.argument()));
664 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
666 insertPlaintextFile(this, to_utf8(cmd.argument()), true);
669 case LFUN_FILE_INSERT_PLAINTEXT:
671 insertPlaintextFile(this, to_utf8(cmd.argument()), false);
674 case LFUN_FONT_STATE:
675 cur.message(cur.currentState());
678 case LFUN_BOOKMARK_SAVE:
679 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
682 case LFUN_LABEL_GOTO: {
683 docstring label = cmd.argument();
686 getInsetByCode<InsetRef>(cursor_,
689 label = inset->getParam("reference");
690 // persistent=false: use temp_bookmark
700 case LFUN_PARAGRAPH_GOTO: {
701 int const id = convert<int>(to_utf8(cmd.argument()));
703 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
704 b = theBufferList().next(b)) {
706 ParIterator par = b->getParFromID(id);
707 if (par == b->par_iterator_end()) {
709 << "No matching paragraph found! ["
710 << id << "]." << endl;
713 << "Paragraph " << par->id()
714 << " found in buffer `"
715 << b->fileName() << "'." << endl;
719 setCursor(makeDocIterator(par, 0));
721 // Switch to other buffer view and resend cmd
722 theLyXFunc().dispatch(FuncRequest(
723 LFUN_BUFFER_SWITCH, b->fileName()));
724 theLyXFunc().dispatch(cmd);
725 updateFlags = Update::None;
734 case LFUN_OUTLINE_UP:
735 toc::outline(toc::Up, cursor_);
736 cursor_.text()->setCursor(cursor_, cursor_.pit(), 0);
737 updateLabels(buffer_);
739 case LFUN_OUTLINE_DOWN:
740 toc::outline(toc::Down, cursor_);
741 cursor_.text()->setCursor(cursor_, cursor_.pit(), 0);
742 updateLabels(buffer_);
744 case LFUN_OUTLINE_IN:
745 toc::outline(toc::In, cursor_);
746 updateLabels(buffer_);
748 case LFUN_OUTLINE_OUT:
749 toc::outline(toc::Out, cursor_);
750 updateLabels(buffer_);
754 bv_funcs::gotoInset(this, Inset::NOTE_CODE, false);
757 case LFUN_REFERENCE_NEXT: {
758 vector<Inset_code> tmp;
759 tmp.push_back(Inset::LABEL_CODE);
760 tmp.push_back(Inset::REF_CODE);
761 bv_funcs::gotoInset(this, tmp, true);
765 case LFUN_CHANGES_TRACK:
766 buffer_.params().trackChanges = !buffer_.params().trackChanges;
769 case LFUN_CHANGES_OUTPUT:
770 buffer_.params().outputChanges = !buffer_.params().outputChanges;
771 if (buffer_.params().outputChanges) {
772 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
773 bool xcolorsoul = LaTeXFeatures::isAvailable("soul") &&
774 LaTeXFeatures::isAvailable("xcolor");
776 if (!dvipost && !xcolorsoul) {
777 Alert::warning(_("Changes not shown in LaTeX output"),
778 _("Changes will not be highlighted in LaTeX output, "
779 "because neither dvipost nor xcolor/soul are installed.\n"
780 "Please install these packages or redefine "
781 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
782 } else if (!xcolorsoul) {
783 Alert::warning(_("Changes not shown in LaTeX output"),
784 _("Changes will not be highlighted in LaTeX output "
785 "when using pdflatex, because xcolor and soul are not installed.\n"
786 "Please install both packages or redefine "
787 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
792 case LFUN_CHANGE_NEXT:
793 findNextChange(this);
796 case LFUN_CHANGES_MERGE:
797 if (findNextChange(this))
798 showDialog("changes");
801 case LFUN_ALL_CHANGES_ACCEPT:
802 // select complete document
803 cursor_.reset(buffer_.inset());
804 cursor_.selHandle(true);
805 buffer_.text().cursorBottom(cursor_);
806 // accept everything in a single step to support atomic undo
807 buffer_.text().acceptOrRejectChanges(cursor_, Text::ACCEPT);
810 case LFUN_ALL_CHANGES_REJECT:
811 // select complete document
812 cursor_.reset(buffer_.inset());
813 cursor_.selHandle(true);
814 buffer_.text().cursorBottom(cursor_);
815 // reject everything in a single step to support atomic undo
816 // Note: reject does not work recursively; the user may have to repeat the operation
817 buffer_.text().acceptOrRejectChanges(cursor_, Text::REJECT);
824 case LFUN_WORD_REPLACE: {
825 bool has_deleted = false;
826 if (cur.selection()) {
827 DocIterator beg = cur.selectionBegin();
828 DocIterator end = cur.selectionEnd();
829 if (beg.pit() == end.pit()) {
830 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
831 if (cur.paragraph().isDeleted(p))
836 replace(this, cmd, has_deleted);
841 cur.clearSelection();
843 cur.message(from_utf8(N_("Mark off")));
847 cur.clearSelection();
850 cur.message(from_utf8(N_("Mark on")));
853 case LFUN_MARK_TOGGLE:
854 cur.clearSelection();
857 cur.message(from_utf8(N_("Mark removed")));
860 cur.message(from_utf8(N_("Mark set")));
865 case LFUN_SCREEN_RECENTER:
869 case LFUN_BIBTEX_DATABASE_ADD: {
870 Cursor tmpcur = cursor_;
871 bv_funcs::findInset(tmpcur, Inset::BIBTEX_CODE, false);
872 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
875 if (inset->addDatabase(to_utf8(cmd.argument())))
876 buffer_.updateBibfilesCache();
881 case LFUN_BIBTEX_DATABASE_DEL: {
882 Cursor tmpcur = cursor_;
883 bv_funcs::findInset(tmpcur, Inset::BIBTEX_CODE, false);
884 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
887 if (inset->delDatabase(to_utf8(cmd.argument())))
888 buffer_.updateBibfilesCache();
893 case LFUN_WORDS_COUNT: {
894 DocIterator from, to;
895 if (cur.selection()) {
896 from = cur.selectionBegin();
897 to = cur.selectionEnd();
899 from = doc_iterator_begin(buffer_.inset());
900 to = doc_iterator_end(buffer_.inset());
902 int const count = countWords(from, to);
906 message = bformat(_("%1$d words in selection."),
909 message = bformat(_("%1$d words in document."),
914 message = _("One word in selection.");
916 message = _("One word in document.");
919 Alert::information(_("Count words"), message);
923 case LFUN_BUFFER_TOGGLE_COMPRESSION:
924 // turn compression on/off
925 buffer_.params().compressed = !buffer_.params().compressed;
928 case LFUN_NEXT_INSET_TOGGLE: {
929 // this is the real function we want to invoke
930 FuncRequest tmpcmd = FuncRequest(LFUN_INSET_TOGGLE, cmd.origin);
931 // if there is an inset at cursor, see whether it
933 Inset * inset = cur.nextInset();
935 if (inset->isActive()) {
937 tmpcur.pushLeft(*inset);
938 inset->dispatch(tmpcur, tmpcmd);
939 if (tmpcur.result().dispatched()) {
942 } else if (inset->editable() == Inset::IS_EDITABLE) {
943 inset->edit(cur, true);
946 // if it did not work, try the underlying inset.
947 if (!cur.result().dispatched())
948 cur.dispatch(tmpcmd);
950 if (cur.result().dispatched())
951 cur.clearSelection();
957 case LFUN_SCREEN_DOWN: {
958 Point p = bv_funcs::getPos(*this, cur, cur.boundary());
959 if (p.y_ < 0 || p.y_ > height_) {
960 // The cursor is off-screen so recenter before proceeding.
962 updateMetrics(false);
963 //FIXME: updateMetrics() does not update paragraph position
964 // This is done at draw() time. So we need a redraw!
966 p = bv_funcs::getPos(*this, cur, cur.boundary());
968 scroll(cmd.action == LFUN_SCREEN_UP? - height_ : height_);
969 cur.reset(buffer_.inset());
970 text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_);
971 //FIXME: what to do with cur.x_target()?
973 // The metrics are already up to date. see scroll()
974 updateFlags = Update::None;
978 case LFUN_SCREEN_UP_SELECT:
979 case LFUN_SCREEN_DOWN_SELECT: {
981 size_t initial_depth = cur.depth();
982 Point const p = bv_funcs::getPos(*this, cur, cur.boundary());
983 scroll(cmd.action == LFUN_SCREEN_UP_SELECT? - height_ : height_);
984 // FIXME: We need to verify if the cursor stayed within an inset...
985 //cur.reset(buffer_.inset());
986 text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_);
988 while (cur.depth() > initial_depth) {
991 // FIXME: we need to do a redraw again because of the selection
993 updateFlags = Update::Force | Update::FitCursor;
998 updateFlags = Update::None;
1005 docstring const BufferView::requestSelection()
1007 Cursor & cur = cursor_;
1009 if (!cur.selection()) {
1010 xsel_cache_.set = false;
1014 if (!xsel_cache_.set ||
1015 cur.top() != xsel_cache_.cursor ||
1016 cur.anchor_.top() != xsel_cache_.anchor)
1018 xsel_cache_.cursor = cur.top();
1019 xsel_cache_.anchor = cur.anchor_.top();
1020 xsel_cache_.set = cur.selection();
1021 return cur.selectionAsString(false);
1027 void BufferView::clearSelection()
1029 cursor_.clearSelection();
1030 // Clear the selection buffer. Otherwise a subsequent
1031 // middle-mouse-button paste would use the selection buffer,
1032 // not the more current external selection.
1033 cap::clearSelection();
1034 xsel_cache_.set = false;
1035 // The buffer did not really change, but this causes the
1036 // redraw we need because we cleared the selection above.
1041 void BufferView::resize(int width, int height)
1043 // Update from work area
1047 updateMetrics(false);
1051 Inset const * BufferView::getCoveringInset(Text const & text, int x, int y)
1053 TextMetrics & tm = text_metrics_[&text];
1054 Inset * inset = tm.checkInsetHit(x, y);
1058 if (!inset->descendable())
1059 // No need to go further down if the inset is not
1063 size_t cell_number = inset->nargs();
1064 // Check all the inner cell.
1065 for (size_t i = 0; i != cell_number; ++i) {
1066 Text const * inner_text = inset->getText(i);
1069 Inset const * inset_deeper =
1070 getCoveringInset(*inner_text, x, y);
1072 return inset_deeper;
1080 bool BufferView::workAreaDispatch(FuncRequest const & cmd0)
1082 //lyxerr << BOOST_CURRENT_FUNCTION << "[ cmd0 " << cmd0 << "]" << endl;
1084 // This is only called for mouse related events including
1085 // LFUN_FILE_OPEN generated by drag-and-drop.
1086 FuncRequest cmd = cmd0;
1089 cur.push(buffer_.inset());
1090 cur.selection() = cursor_.selection();
1092 // Either the inset under the cursor or the
1093 // surrounding Text will handle this event.
1095 // make sure we stay within the screen...
1096 cmd.y = min(max(cmd.y, -1), height_);
1098 if (cmd.action == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
1100 // Get inset under mouse, if there is one.
1101 Inset const * covering_inset =
1102 getCoveringInset(buffer_.text(), cmd.x, cmd.y);
1103 if (covering_inset == last_inset_)
1104 // Same inset, no need to do anything...
1107 bool need_redraw = false;
1108 // const_cast because of setMouseHover().
1109 Inset * inset = const_cast<Inset *>(covering_inset);
1111 // Remove the hint on the last hovered inset (if any).
1112 need_redraw |= last_inset_->setMouseHover(false);
1114 // Highlighted the newly hovered inset (if any).
1115 need_redraw |= inset->setMouseHover(true);
1116 last_inset_ = inset;
1120 // if last metrics update was in singlepar mode, WorkArea::redraw() will
1121 // not expose the button for redraw. We adjust here the metrics dimension
1122 // to enable a full redraw in any case as this is not costly.
1123 TextMetrics & tm = text_metrics_[&buffer_.text()];
1124 std::pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
1125 std::pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
1126 int y1 = firstpm.second->position() - firstpm.second->ascent();
1127 int y2 = lastpm.second->position() + lastpm.second->descent();
1128 metrics_info_ = ViewMetricsInfo(firstpm.first, lastpm.first, y1, y2,
1129 FullScreenUpdate, buffer_.text().paragraphs().size());
1130 // Reinitialize anchor to first pit.
1131 anchor_ref_ = firstpm.first;
1133 LYXERR(Debug::PAINTING)
1134 << "Mouse hover detected at: (" << cmd.x << ", " << cmd.y << ")"
1135 << "\nTriggering redraw: y1: " << y1 << " y2: " << y2
1136 << " pit1: " << firstpm.first << " pit2: " << lastpm.first << endl;
1138 // This event (moving without mouse click) is not passed further.
1139 // This should be changed if it is further utilized.
1143 // Build temporary cursor.
1144 Inset * inset = text_metrics_[&buffer_.text()].editXY(cur, cmd.x, cmd.y);
1146 // Put anchor at the same position.
1149 // Try to dispatch to an non-editable inset near this position
1150 // via the temp cursor. If the inset wishes to change the real
1151 // cursor it has to do so explicitly by using
1152 // cur.bv().cursor() = cur; (or similar)
1154 inset->dispatch(cur, cmd);
1157 // Now dispatch to the temporary cursor. If the real cursor should
1158 // be modified, the inset's dispatch has to do so explicitly.
1159 if (!cur.result().dispatched())
1162 //Do we have a selection?
1163 theSelection().haveSelection(cursor().selection());
1165 // Redraw if requested and necessary.
1166 if (cur.result().dispatched() && cur.result().update())
1167 return update(cur.result().update());
1173 void BufferView::scroll(int y)
1182 void BufferView::scrollDown(int offset)
1184 Text * text = &buffer_.text();
1185 TextMetrics & tm = text_metrics_[text];
1186 int ymax = height_ + offset;
1188 std::pair<pit_type, ParagraphMetrics const *> last = tm.last();
1189 int bottom_pos = last.second->position() + last.second->descent();
1190 if (last.first == text->paragraphs().size() - 1) {
1191 if (bottom_pos <= height_)
1193 offset = min(offset, bottom_pos - height_);
1196 if (bottom_pos > ymax)
1198 tm.newParMetricsDown();
1200 offset_ref_ += offset;
1201 updateMetrics(false);
1206 void BufferView::scrollUp(int offset)
1208 Text * text = &buffer_.text();
1209 TextMetrics & tm = text_metrics_[text];
1210 int ymin = - offset;
1212 std::pair<pit_type, ParagraphMetrics const *> first = tm.first();
1213 int top_pos = first.second->position() - first.second->ascent();
1214 if (first.first == 0) {
1217 offset = min(offset, - top_pos);
1222 tm.newParMetricsUp();
1224 offset_ref_ -= offset;
1225 updateMetrics(false);
1230 void BufferView::setCursorFromRow(int row)
1235 buffer_.texrow().getIdFromRow(row, tmpid, tmppos);
1237 cursor_.reset(buffer_.inset());
1239 buffer_.text().setCursor(cursor_, 0, 0);
1241 buffer_.text().setCursor(cursor_, buffer_.getParFromID(tmpid).pit(), tmppos);
1245 void BufferView::gotoLabel(docstring const & label)
1247 for (InsetIterator it = inset_iterator_begin(buffer_.inset()); it; ++it) {
1248 vector<docstring> labels;
1249 it->getLabelList(buffer_, labels);
1250 if (std::find(labels.begin(), labels.end(), label) != labels.end()) {
1259 TextMetrics const & BufferView::textMetrics(Text const * t) const
1261 return const_cast<BufferView *>(this)->textMetrics(t);
1265 TextMetrics & BufferView::textMetrics(Text const * t)
1267 TextMetricsCache::iterator tmc_it = text_metrics_.find(t);
1268 if (tmc_it == text_metrics_.end()) {
1269 tmc_it = text_metrics_.insert(
1270 make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
1272 return tmc_it->second;
1276 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
1279 return textMetrics(t).parMetrics(pit);
1283 int BufferView::workHeight() const
1289 void BufferView::setCursor(DocIterator const & dit)
1291 size_t const n = dit.depth();
1292 for (size_t i = 0; i < n; ++i)
1293 dit[i].inset().edit(cursor_, true);
1295 cursor_.setCursor(dit);
1296 cursor_.selection() = false;
1300 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
1302 // Would be wrong to delete anything if we have a selection.
1303 if (cur.selection())
1306 bool need_anchor_change = false;
1307 bool changed = cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
1308 need_anchor_change);
1310 if (need_anchor_change)
1316 updateLabels(buffer_);
1318 updateMetrics(false);
1324 bool BufferView::mouseSetCursor(Cursor & cur)
1326 BOOST_ASSERT(&cur.bv() == this);
1328 // this event will clear selection so we save selection for
1329 // persistent selection
1330 cap::saveSelection(cursor());
1332 // Has the cursor just left the inset?
1333 bool badcursor = false;
1334 bool leftinset = (&cursor_.inset() != &cur.inset());
1336 badcursor = notifyCursorLeaves(cursor_, cur);
1338 // do the dEPM magic if needed
1339 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
1340 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
1341 // the leftinset bool would not be necessary (badcursor instead).
1342 bool update = leftinset;
1343 if (!badcursor && cursor_.inTexted())
1344 update |= checkDepm(cur, cursor_);
1346 // if the cursor was in an empty script inset and the new
1347 // position is in the nucleus of the inset, notifyCursorLeaves
1348 // will kill the script inset itself. So we check all the
1349 // elements of the cursor to make sure that they are correct.
1350 // For an example, see bug 2933:
1351 // http://bugzilla.lyx.org/show_bug.cgi?id=2933
1352 // The code below could maybe be moved to a DocIterator method.
1353 //lyxerr << "cur before " << cur <<std::endl;
1354 DocIterator dit(cur.inset());
1355 dit.push_back(cur.bottom());
1357 while (i < cur.depth() && dit.nextInset() == &cur[i].inset()) {
1358 dit.push_back(cur[i]);
1361 //lyxerr << "5 cur after" << dit <<std::endl;
1363 cursor_.setCursor(dit);
1364 cursor_.boundary(cur.boundary());
1365 cursor_.clearSelection();
1371 void BufferView::putSelectionAt(DocIterator const & cur,
1372 int length, bool backwards)
1374 cursor_.clearSelection();
1380 cursor_.pos() += length;
1381 cursor_.setSelection(cursor_, -length);
1383 cursor_.setSelection(cursor_, length);
1388 Cursor & BufferView::cursor()
1394 Cursor const & BufferView::cursor() const
1400 pit_type BufferView::anchor_ref() const
1406 ViewMetricsInfo const & BufferView::viewMetricsInfo()
1408 return metrics_info_;
1412 // FIXME: We should split-up updateMetrics() for the singlepar case.
1413 void BufferView::updateMetrics(bool singlepar)
1415 Text & buftext = buffer_.text();
1416 pit_type const npit = int(buftext.paragraphs().size());
1418 if (anchor_ref_ > int(npit - 1)) {
1419 anchor_ref_ = int(npit - 1);
1424 // Clear out the position cache in case of full screen redraw,
1425 coord_cache_.clear();
1427 // Clear out paragraph metrics to avoid having invalid metrics
1428 // in the cache from paragraphs not relayouted below
1429 // The complete text metrics will be redone.
1430 text_metrics_.clear();
1433 TextMetrics & tm = textMetrics(&buftext);
1435 pit_type const bottom_pit = cursor_.bottom().pit();
1436 // If the paragraph metrics has changed, we can not
1437 // use the singlepar optimisation.
1439 // In Single Paragraph mode, rebreak only
1440 // the (main text, not inset!) paragraph containing the cursor.
1441 // (if this paragraph contains insets etc., rebreaking will
1442 // recursively descend)
1443 && !tm.redoParagraph(bottom_pit)) {
1446 // collect cursor paragraph iter bounds
1447 ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
1448 int y1 = pm.position() - pm.ascent();
1449 int y2 = pm.position() + pm.descent();
1450 metrics_info_ = ViewMetricsInfo(bottom_pit, bottom_pit, y1, y2,
1451 SingleParUpdate, npit);
1452 LYXERR(Debug::PAINTING)
1453 << BOOST_CURRENT_FUNCTION
1456 << " pit: " << bottom_pit
1457 << " singlepar: " << singlepar
1462 pit_type const pit = anchor_ref_;
1466 // Rebreak anchor paragraph.
1467 tm.redoParagraph(pit);
1471 int y0 = tm.parMetrics(pit).ascent() - offset_ref_;
1473 // Redo paragraphs above anchor if necessary.
1475 while (y1 > 0 && pit1 > 0) {
1476 y1 -= tm.parMetrics(pit1).ascent();
1478 tm.redoParagraph(pit1);
1479 y1 -= tm.parMetrics(pit1).descent();
1482 // Take care of ascent of first line
1483 y1 -= tm.parMetrics(pit1).ascent();
1485 // Normalize anchor for next time
1489 // Grey at the beginning is ugly
1490 if (pit1 == 0 && y1 > 0) {
1496 // Redo paragraphs below the anchor if necessary.
1498 while (y2 < height_ && pit2 < int(npit) - 1) {
1499 y2 += tm.parMetrics(pit2).descent();
1501 tm.redoParagraph(pit2);
1502 y2 += tm.parMetrics(pit2).ascent();
1505 // Take care of descent of last line
1506 y2 += tm.parMetrics(pit2).descent();
1508 LYXERR(Debug::PAINTING)
1509 << BOOST_CURRENT_FUNCTION
1512 << " pit1: " << pit1
1513 << " pit2: " << pit2
1514 << " npit: " << npit
1515 << " singlepar: " << singlepar
1518 metrics_info_ = ViewMetricsInfo(pit1, pit2, y1, y2,
1519 FullScreenUpdate, npit);
1521 if (lyxerr.debugging(Debug::WORKAREA)) {
1522 LYXERR(Debug::WORKAREA) << "BufferView::updateMetrics" << endl;
1523 coord_cache_.dump();
1528 void BufferView::menuInsertLyXFile(string const & filenm)
1530 BOOST_ASSERT(cursor_.inTexted());
1531 string filename = filenm;
1533 if (filename.empty()) {
1534 // Launch a file browser
1536 string initpath = lyxrc.document_path;
1537 string const trypath = buffer_.filePath();
1538 // If directory is writeable, use this as default.
1539 if (isDirWriteable(FileName(trypath)))
1543 FileDialog fileDlg(_("Select LyX document to insert"),
1545 make_pair(_("Documents|#o#O"), from_utf8(lyxrc.document_path)),
1546 make_pair(_("Examples|#E#e"),
1547 from_utf8(addPath(package().system_support().absFilename(),
1550 FileDialog::Result result =
1551 fileDlg.open(from_utf8(initpath),
1552 FileFilterList(_("LyX Documents (*.lyx)")),
1555 if (result.first == FileDialog::Later)
1559 filename = to_utf8(result.second);
1561 // check selected filename
1562 if (filename.empty()) {
1563 // emit message signal.
1564 message(_("Canceled."));
1569 // Get absolute path of file and add ".lyx"
1570 // to the filename if necessary
1571 filename = fileSearch(string(), filename, "lyx").absFilename();
1573 docstring const disp_fn = makeDisplayPath(filename);
1574 // emit message signal.
1575 message(bformat(_("Inserting document %1$s..."), disp_fn));
1578 Buffer buf("", false);
1579 if (lyx::loadLyXFile(&buf, FileName(filename))) {
1580 ErrorList & el = buffer_.errorList("Parse");
1581 // Copy the inserted document error list into the current buffer one.
1582 el = buf.errorList("Parse");
1583 recordUndo(cursor_);
1584 cap::pasteParagraphList(cursor_, buf.paragraphs(),
1585 buf.params().getTextClassPtr(), el);
1586 res = _("Document %1$s inserted.");
1588 res = _("Could not insert document %1$s");
1590 // emit message signal.
1591 message(bformat(res, disp_fn));
1592 buffer_.errors("Parse");
1593 updateMetrics(false);
1597 void BufferView::draw(frontend::Painter & pain)
1599 PainterInfo pi(this, pain);
1600 // Should the whole screen, including insets, be refreshed?
1601 // FIXME: We should also distinguish DecorationUpdate to avoid text
1602 // drawing if possible. This is not possible to do easily right now
1603 // because of the single backing pixmap.
1604 pi.full_repaint = metrics_info_.update_strategy != SingleParUpdate;
1606 if (pi.full_repaint)
1607 // Clear background (if not delegated to rows)
1608 pain.fillRectangle(0, metrics_info_.y1, width_,
1609 metrics_info_.y2 - metrics_info_.y1,
1610 buffer_.inset().backgroundColor());
1612 LYXERR(Debug::PAINTING) << "\t\t*** START DRAWING ***" << endl;
1613 Text & text = buffer_.text();
1614 TextMetrics const & tm = text_metrics_[&text];
1615 int y = metrics_info_.y1 + tm.parMetrics(metrics_info_.p1).ascent();
1616 if (!pi.full_repaint)
1617 tm.drawParagraph(pi, metrics_info_.p1, 0, y);
1620 LYXERR(Debug::PAINTING) << "\n\t\t*** END DRAWING ***" << endl;
1622 // and grey out above (should not happen later)
1623 // lyxerr << "par ascent: " << text.getPar(metrics_info_.p1).ascent() << endl;
1624 if (metrics_info_.y1 > 0
1625 && metrics_info_.update_strategy == FullScreenUpdate)
1626 pain.fillRectangle(0, 0, width_, metrics_info_.y1, Color::bottomarea);
1628 // and possibly grey out below
1629 // lyxerr << "par descent: " << text.getPar(metrics_info_.p1).ascent() << endl;
1630 if (metrics_info_.y2 < height_
1631 && metrics_info_.update_strategy == FullScreenUpdate)
1632 pain.fillRectangle(0, metrics_info_.y2, width_,
1633 height_ - metrics_info_.y2, Color::bottomarea);