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);
261 // The screen has already been updated thanks to the
262 // 'buffer_.changed()' call three line above. So no need
267 // tell the frontend to update the screen.
272 void BufferView::updateScrollbar()
274 Text & t = buffer_.text();
275 TextMetrics & tm = text_metrics_[&t];
277 int const parsize = int(t.paragraphs().size() - 1);
278 if (anchor_ref_ > parsize) {
279 anchor_ref_ = parsize;
284 << BOOST_CURRENT_FUNCTION
285 << " Updating scrollbar: height: " << t.paragraphs().size()
286 << " curr par: " << cursor_.bottom().pit()
287 << " default height " << defaultRowHeight() << endl;
289 // It would be better to fix the scrollbar to understand
290 // values in [0..1] and divide everything by wh
292 // estimated average paragraph height:
296 int h = tm.parMetrics(anchor_ref_).height();
298 // Normalize anchor/offset (MV):
299 while (offset_ref_ > h && anchor_ref_ < parsize) {
302 h = tm.parMetrics(anchor_ref_).height();
304 // Look at paragraph heights on-screen
307 for (pit_type pit = anchor_ref_; pit <= parsize; ++pit) {
310 int const h2 = tm.parMetrics(pit).height();
316 int const hav = sumh / nh;
317 // More realistic average paragraph height
322 scrollbarParameters_.height = (parsize + 1) * wh_;
323 scrollbarParameters_.position = anchor_ref_ * wh_ + int(offset_ref_ * wh_ / float(h));
324 scrollbarParameters_.lineScrollHeight = int(wh_ * defaultRowHeight() / float(h));
328 ScrollbarParameters const & BufferView::scrollbarParameters() const
330 return scrollbarParameters_;
334 void BufferView::scrollDocView(int value)
336 LYXERR(Debug::GUI) << BOOST_CURRENT_FUNCTION
337 << "[ value = " << value << "]" << endl;
339 Text & t = buffer_.text();
340 TextMetrics & tm = text_metrics_[&t];
342 float const bar = value / float(wh_ * t.paragraphs().size());
344 anchor_ref_ = int(bar * t.paragraphs().size());
345 if (anchor_ref_ > int(t.paragraphs().size()) - 1)
346 anchor_ref_ = int(t.paragraphs().size()) - 1;
348 tm.redoParagraph(anchor_ref_);
349 int const h = tm.parMetrics(anchor_ref_).height();
350 offset_ref_ = int((bar * t.paragraphs().size() - anchor_ref_) * h);
351 updateMetrics(false);
356 void BufferView::setCursorFromScrollbar()
358 TextMetrics & tm = text_metrics_[&buffer_.text()];
360 int const height = 2 * defaultRowHeight();
361 int const first = height;
362 int const last = height_ - height;
363 Cursor & cur = cursor_;
365 bv_funcs::CurStatus st = bv_funcs::status(this, cur);
368 case bv_funcs::CUR_ABOVE:
369 // We reset the cursor because bv_funcs::status() does not
370 // work when the cursor is within mathed.
371 cur.reset(buffer_.inset());
372 tm.setCursorFromCoordinates(cur, 0, first);
373 cur.clearSelection();
375 case bv_funcs::CUR_BELOW:
376 // We reset the cursor because bv_funcs::status() does not
377 // work when the cursor is within mathed.
378 cur.reset(buffer_.inset());
379 tm.setCursorFromCoordinates(cur, 0, last);
380 cur.clearSelection();
382 case bv_funcs::CUR_INSIDE:
383 int const y = bv_funcs::getPos(*this, cur, cur.boundary()).y_;
384 int const newy = min(last, max(y, first));
386 cur.reset(buffer_.inset());
387 tm.setCursorFromCoordinates(cur, 0, newy);
393 Change const BufferView::getCurrentChange() const
395 if (!cursor_.selection())
396 return Change(Change::UNCHANGED);
398 DocIterator dit = cursor_.selectionBegin();
399 return dit.paragraph().lookupChange(dit.pos());
403 void BufferView::saveBookmark(unsigned int idx)
405 // tenatively save bookmark, id and pos will be used to
406 // acturately locate a bookmark in a 'live' lyx session.
407 // pit and pos will be updated with bottom level pit/pos
409 LyX::ref().session().bookmarks().save(
410 FileName(buffer_.fileName()),
411 cursor_.bottom().pit(),
412 cursor_.bottom().pos(),
413 cursor_.paragraph().id(),
418 // emit message signal.
419 message(_("Save bookmark"));
423 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
424 int top_id, pos_type top_pos)
426 bool success = false;
429 cursor_.clearSelection();
431 // if a valid par_id is given, try it first
432 // This is the case for a 'live' bookmark when unique paragraph ID
433 // is used to track bookmarks.
435 ParIterator par = buffer_.getParFromID(top_id);
436 if (par != buffer_.par_iterator_end()) {
437 doc_it = makeDocIterator(par, min(par->size(), top_pos));
438 // Some slices of the iterator may not be
439 // reachable (e.g. closed collapsable inset)
440 // so the dociterator may need to be
441 // shortened. Otherwise, setCursor may crash
442 // lyx when the cursor can not be set to these
444 size_t const n = doc_it.depth();
445 for (size_t i = 0; i < n; ++i)
446 if (doc_it[i].inset().editable() != Inset::HIGHLY_EDITABLE) {
454 // if top_id == 0, or searching through top_id failed
455 // This is the case for a 'restored' bookmark when only bottom
456 // (document level) pit was saved. Because of this, bookmark
457 // restoration is inaccurate. If a bookmark was within an inset,
458 // it will be restored to the left of the outmost inset that contains
460 if (static_cast<size_t>(bottom_pit) < buffer_.paragraphs().size()) {
461 doc_it = doc_iterator_begin(buffer_.inset());
462 doc_it.pit() = bottom_pit;
463 doc_it.pos() = min(bottom_pos, doc_it.paragraph().size());
468 // Note: only bottom (document) level pit is set.
470 // set the current font.
471 cursor_.setCurrentFont();
472 // center the screen on this new position.
480 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
482 if (lyxrc.rtl_support) {
483 if (cursor_.real_current_font.isRightToLeft()) {
484 if (intl_->keymap == Intl::PRIMARY)
487 if (intl_->keymap == Intl::SECONDARY)
492 intl_->getTransManager().translateAndInsert(c, t, cur);
496 int BufferView::workWidth() const
502 void BufferView::updateOffsetRef()
504 // No need to update offset_ref_ in this case.
505 if (!need_centering_)
508 // We are not properly started yet, delay until resizing is
513 CursorSlice & bot = cursor_.bottom();
514 TextMetrics & tm = text_metrics_[bot.text()];
515 ParagraphMetrics const & pm = tm.parMetrics(bot.pit());
516 Point p = bv_funcs::coordOffset(*this, cursor_, cursor_.boundary());
517 offset_ref_ = p.y_ + pm.ascent() - height_ / 2;
519 need_centering_ = false;
523 void BufferView::center()
525 anchor_ref_ = cursor_.bottom().pit();
526 need_centering_ = true;
530 FuncStatus BufferView::getStatus(FuncRequest const & cmd)
534 Cursor & cur = cursor_;
536 switch (cmd.action) {
539 flag.enabled(!buffer_.undostack().empty());
542 flag.enabled(!buffer_.redostack().empty());
544 case LFUN_FILE_INSERT:
545 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
546 case LFUN_FILE_INSERT_PLAINTEXT:
547 case LFUN_BOOKMARK_SAVE:
548 // FIXME: Actually, these LFUNS should be moved to Text
549 flag.enabled(cur.inTexted());
551 case LFUN_FONT_STATE:
552 case LFUN_LABEL_INSERT:
553 case LFUN_PARAGRAPH_GOTO:
554 // FIXME handle non-trivially
555 case LFUN_OUTLINE_UP:
556 case LFUN_OUTLINE_DOWN:
557 case LFUN_OUTLINE_IN:
558 case LFUN_OUTLINE_OUT:
560 case LFUN_REFERENCE_NEXT:
562 case LFUN_WORD_REPLACE:
565 case LFUN_MARK_TOGGLE:
566 case LFUN_SCREEN_RECENTER:
567 case LFUN_BIBTEX_DATABASE_ADD:
568 case LFUN_BIBTEX_DATABASE_DEL:
569 case LFUN_WORDS_COUNT:
570 case LFUN_NEXT_INSET_TOGGLE:
574 case LFUN_LABEL_GOTO: {
575 flag.enabled(!cmd.argument().empty()
576 || getInsetByCode<InsetRef>(cur, Inset::REF_CODE));
580 case LFUN_CHANGES_TRACK:
582 flag.setOnOff(buffer_.params().trackChanges);
585 case LFUN_CHANGES_OUTPUT:
587 flag.setOnOff(buffer_.params().outputChanges);
590 case LFUN_CHANGES_MERGE:
591 case LFUN_CHANGE_NEXT:
592 case LFUN_ALL_CHANGES_ACCEPT:
593 case LFUN_ALL_CHANGES_REJECT:
594 // TODO: context-sensitive enabling of LFUNs
595 // In principle, these command should only be enabled if there
596 // is a change in the document. However, without proper
597 // optimizations, this will inevitably result in poor performance.
601 case LFUN_BUFFER_TOGGLE_COMPRESSION: {
602 flag.setOnOff(buffer_.params().compressed);
607 case LFUN_SCREEN_DOWN:
611 // FIXME: LFUN_SCREEN_DOWN_SELECT should be removed from
612 // everywhere else before this can enabled:
613 case LFUN_SCREEN_UP_SELECT:
614 case LFUN_SCREEN_DOWN_SELECT:
626 Update::flags BufferView::dispatch(FuncRequest const & cmd)
628 //lyxerr << BOOST_CURRENT_FUNCTION
629 // << [ cmd = " << cmd << "]" << endl;
631 // Make sure that the cached BufferView is correct.
632 LYXERR(Debug::ACTION) << BOOST_CURRENT_FUNCTION
633 << " action[" << cmd.action << ']'
634 << " arg[" << to_utf8(cmd.argument()) << ']'
635 << " x[" << cmd.x << ']'
636 << " y[" << cmd.y << ']'
637 << " button[" << cmd.button() << ']'
640 Cursor & cur = cursor_;
641 // Default Update flags.
642 Update::flags updateFlags = Update::Force | Update::FitCursor;
644 switch (cmd.action) {
647 cur.message(_("Undo"));
648 cur.clearSelection();
649 if (!textUndo(*this)) {
650 cur.message(_("No further undo information"));
651 updateFlags = Update::None;
656 cur.message(_("Redo"));
657 cur.clearSelection();
658 if (!textRedo(*this)) {
659 cur.message(_("No further redo information"));
660 updateFlags = Update::None;
664 case LFUN_FILE_INSERT:
666 menuInsertLyXFile(to_utf8(cmd.argument()));
669 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
671 insertPlaintextFile(this, to_utf8(cmd.argument()), true);
674 case LFUN_FILE_INSERT_PLAINTEXT:
676 insertPlaintextFile(this, to_utf8(cmd.argument()), false);
679 case LFUN_FONT_STATE:
680 cur.message(cur.currentState());
683 case LFUN_BOOKMARK_SAVE:
684 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
687 case LFUN_LABEL_GOTO: {
688 docstring label = cmd.argument();
691 getInsetByCode<InsetRef>(cursor_,
694 label = inset->getParam("reference");
695 // persistent=false: use temp_bookmark
705 case LFUN_PARAGRAPH_GOTO: {
706 int const id = convert<int>(to_utf8(cmd.argument()));
708 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
709 b = theBufferList().next(b)) {
711 ParIterator par = b->getParFromID(id);
712 if (par == b->par_iterator_end()) {
714 << "No matching paragraph found! ["
715 << id << "]." << endl;
718 << "Paragraph " << par->id()
719 << " found in buffer `"
720 << b->fileName() << "'." << endl;
724 setCursor(makeDocIterator(par, 0));
726 // Switch to other buffer view and resend cmd
727 theLyXFunc().dispatch(FuncRequest(
728 LFUN_BUFFER_SWITCH, b->fileName()));
729 theLyXFunc().dispatch(cmd);
730 updateFlags = Update::None;
739 case LFUN_OUTLINE_UP:
740 toc::outline(toc::Up, cursor_);
741 cursor_.text()->setCursor(cursor_, cursor_.pit(), 0);
742 updateLabels(buffer_);
744 case LFUN_OUTLINE_DOWN:
745 toc::outline(toc::Down, cursor_);
746 cursor_.text()->setCursor(cursor_, cursor_.pit(), 0);
747 updateLabels(buffer_);
749 case LFUN_OUTLINE_IN:
750 toc::outline(toc::In, cursor_);
751 updateLabels(buffer_);
753 case LFUN_OUTLINE_OUT:
754 toc::outline(toc::Out, cursor_);
755 updateLabels(buffer_);
759 bv_funcs::gotoInset(this, Inset::NOTE_CODE, false);
762 case LFUN_REFERENCE_NEXT: {
763 vector<Inset_code> tmp;
764 tmp.push_back(Inset::LABEL_CODE);
765 tmp.push_back(Inset::REF_CODE);
766 bv_funcs::gotoInset(this, tmp, true);
770 case LFUN_CHANGES_TRACK:
771 buffer_.params().trackChanges = !buffer_.params().trackChanges;
774 case LFUN_CHANGES_OUTPUT:
775 buffer_.params().outputChanges = !buffer_.params().outputChanges;
776 if (buffer_.params().outputChanges) {
777 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
778 bool xcolorsoul = LaTeXFeatures::isAvailable("soul") &&
779 LaTeXFeatures::isAvailable("xcolor");
781 if (!dvipost && !xcolorsoul) {
782 Alert::warning(_("Changes not shown in LaTeX output"),
783 _("Changes will not be highlighted in LaTeX output, "
784 "because neither dvipost nor xcolor/soul are installed.\n"
785 "Please install these packages or redefine "
786 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
787 } else if (!xcolorsoul) {
788 Alert::warning(_("Changes not shown in LaTeX output"),
789 _("Changes will not be highlighted in LaTeX output "
790 "when using pdflatex, because xcolor and soul are not installed.\n"
791 "Please install both packages or redefine "
792 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
797 case LFUN_CHANGE_NEXT:
798 findNextChange(this);
801 case LFUN_CHANGES_MERGE:
802 if (findNextChange(this))
803 showDialog("changes");
806 case LFUN_ALL_CHANGES_ACCEPT:
807 // select complete document
808 cursor_.reset(buffer_.inset());
809 cursor_.selHandle(true);
810 buffer_.text().cursorBottom(cursor_);
811 // accept everything in a single step to support atomic undo
812 buffer_.text().acceptOrRejectChanges(cursor_, Text::ACCEPT);
815 case LFUN_ALL_CHANGES_REJECT:
816 // select complete document
817 cursor_.reset(buffer_.inset());
818 cursor_.selHandle(true);
819 buffer_.text().cursorBottom(cursor_);
820 // reject everything in a single step to support atomic undo
821 // Note: reject does not work recursively; the user may have to repeat the operation
822 buffer_.text().acceptOrRejectChanges(cursor_, Text::REJECT);
829 case LFUN_WORD_REPLACE: {
830 bool has_deleted = false;
831 if (cur.selection()) {
832 DocIterator beg = cur.selectionBegin();
833 DocIterator end = cur.selectionEnd();
834 if (beg.pit() == end.pit()) {
835 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
836 if (cur.paragraph().isDeleted(p))
841 replace(this, cmd, has_deleted);
846 cur.clearSelection();
848 cur.message(from_utf8(N_("Mark off")));
852 cur.clearSelection();
855 cur.message(from_utf8(N_("Mark on")));
858 case LFUN_MARK_TOGGLE:
859 cur.clearSelection();
862 cur.message(from_utf8(N_("Mark removed")));
865 cur.message(from_utf8(N_("Mark set")));
870 case LFUN_SCREEN_RECENTER:
874 case LFUN_BIBTEX_DATABASE_ADD: {
875 Cursor tmpcur = cursor_;
876 bv_funcs::findInset(tmpcur, Inset::BIBTEX_CODE, false);
877 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
880 if (inset->addDatabase(to_utf8(cmd.argument())))
881 buffer_.updateBibfilesCache();
886 case LFUN_BIBTEX_DATABASE_DEL: {
887 Cursor tmpcur = cursor_;
888 bv_funcs::findInset(tmpcur, Inset::BIBTEX_CODE, false);
889 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
892 if (inset->delDatabase(to_utf8(cmd.argument())))
893 buffer_.updateBibfilesCache();
898 case LFUN_WORDS_COUNT: {
899 DocIterator from, to;
900 if (cur.selection()) {
901 from = cur.selectionBegin();
902 to = cur.selectionEnd();
904 from = doc_iterator_begin(buffer_.inset());
905 to = doc_iterator_end(buffer_.inset());
907 int const count = countWords(from, to);
911 message = bformat(_("%1$d words in selection."),
914 message = bformat(_("%1$d words in document."),
919 message = _("One word in selection.");
921 message = _("One word in document.");
924 Alert::information(_("Count words"), message);
928 case LFUN_BUFFER_TOGGLE_COMPRESSION:
929 // turn compression on/off
930 buffer_.params().compressed = !buffer_.params().compressed;
933 case LFUN_NEXT_INSET_TOGGLE: {
934 // this is the real function we want to invoke
935 FuncRequest tmpcmd = FuncRequest(LFUN_INSET_TOGGLE, cmd.origin);
936 // if there is an inset at cursor, see whether it
938 Inset * inset = cur.nextInset();
940 if (inset->isActive()) {
942 tmpcur.pushLeft(*inset);
943 inset->dispatch(tmpcur, tmpcmd);
944 if (tmpcur.result().dispatched()) {
947 } else if (inset->editable() == Inset::IS_EDITABLE) {
948 inset->edit(cur, true);
951 // if it did not work, try the underlying inset.
952 if (!cur.result().dispatched())
953 cur.dispatch(tmpcmd);
955 if (cur.result().dispatched())
956 cur.clearSelection();
962 case LFUN_SCREEN_DOWN: {
963 Point p = bv_funcs::getPos(*this, cur, cur.boundary());
964 if (p.y_ < 0 || p.y_ > height_) {
965 // The cursor is off-screen so recenter before proceeding.
967 updateMetrics(false);
968 //FIXME: updateMetrics() does not update paragraph position
969 // This is done at draw() time. So we need a redraw!
971 p = bv_funcs::getPos(*this, cur, cur.boundary());
973 scroll(cmd.action == LFUN_SCREEN_UP? - height_ : height_);
974 cur.reset(buffer_.inset());
975 text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_);
976 //FIXME: what to do with cur.x_target()?
978 // The metrics are already up to date. see scroll()
979 updateFlags = Update::None;
983 case LFUN_SCREEN_UP_SELECT:
984 case LFUN_SCREEN_DOWN_SELECT: {
986 size_t initial_depth = cur.depth();
987 Point const p = bv_funcs::getPos(*this, cur, cur.boundary());
988 scroll(cmd.action == LFUN_SCREEN_UP_SELECT? - height_ : height_);
989 // FIXME: We need to verify if the cursor stayed within an inset...
990 //cur.reset(buffer_.inset());
991 text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_);
993 while (cur.depth() > initial_depth) {
996 // FIXME: we need to do a redraw again because of the selection
998 updateFlags = Update::Force | Update::FitCursor;
1003 updateFlags = Update::None;
1010 docstring const BufferView::requestSelection()
1012 Cursor & cur = cursor_;
1014 if (!cur.selection()) {
1015 xsel_cache_.set = false;
1019 if (!xsel_cache_.set ||
1020 cur.top() != xsel_cache_.cursor ||
1021 cur.anchor_.top() != xsel_cache_.anchor)
1023 xsel_cache_.cursor = cur.top();
1024 xsel_cache_.anchor = cur.anchor_.top();
1025 xsel_cache_.set = cur.selection();
1026 return cur.selectionAsString(false);
1032 void BufferView::clearSelection()
1034 cursor_.clearSelection();
1035 // Clear the selection buffer. Otherwise a subsequent
1036 // middle-mouse-button paste would use the selection buffer,
1037 // not the more current external selection.
1038 cap::clearSelection();
1039 xsel_cache_.set = false;
1040 // The buffer did not really change, but this causes the
1041 // redraw we need because we cleared the selection above.
1046 void BufferView::resize(int width, int height)
1048 // Update from work area
1052 updateMetrics(false);
1056 Inset const * BufferView::getCoveringInset(Text const & text, int x, int y)
1058 TextMetrics & tm = text_metrics_[&text];
1059 Inset * inset = tm.checkInsetHit(x, y);
1063 if (!inset->descendable())
1064 // No need to go further down if the inset is not
1068 size_t cell_number = inset->nargs();
1069 // Check all the inner cell.
1070 for (size_t i = 0; i != cell_number; ++i) {
1071 Text const * inner_text = inset->getText(i);
1074 Inset const * inset_deeper =
1075 getCoveringInset(*inner_text, x, y);
1077 return inset_deeper;
1085 bool BufferView::workAreaDispatch(FuncRequest const & cmd0)
1087 //lyxerr << BOOST_CURRENT_FUNCTION << "[ cmd0 " << cmd0 << "]" << endl;
1089 // This is only called for mouse related events including
1090 // LFUN_FILE_OPEN generated by drag-and-drop.
1091 FuncRequest cmd = cmd0;
1094 cur.push(buffer_.inset());
1095 cur.selection() = cursor_.selection();
1097 // Either the inset under the cursor or the
1098 // surrounding Text will handle this event.
1100 // make sure we stay within the screen...
1101 cmd.y = min(max(cmd.y, -1), height_);
1103 if (cmd.action == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
1105 // Get inset under mouse, if there is one.
1106 Inset const * covering_inset =
1107 getCoveringInset(buffer_.text(), cmd.x, cmd.y);
1108 if (covering_inset == last_inset_)
1109 // Same inset, no need to do anything...
1112 bool need_redraw = false;
1113 // const_cast because of setMouseHover().
1114 Inset * inset = const_cast<Inset *>(covering_inset);
1116 // Remove the hint on the last hovered inset (if any).
1117 need_redraw |= last_inset_->setMouseHover(false);
1119 // Highlighted the newly hovered inset (if any).
1120 need_redraw |= inset->setMouseHover(true);
1121 last_inset_ = inset;
1125 // if last metrics update was in singlepar mode, WorkArea::redraw() will
1126 // not expose the button for redraw. We adjust here the metrics dimension
1127 // to enable a full redraw in any case as this is not costly.
1128 TextMetrics & tm = text_metrics_[&buffer_.text()];
1129 std::pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
1130 std::pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
1131 int y1 = firstpm.second->position() - firstpm.second->ascent();
1132 int y2 = lastpm.second->position() + lastpm.second->descent();
1133 metrics_info_ = ViewMetricsInfo(firstpm.first, lastpm.first, y1, y2,
1134 FullScreenUpdate, buffer_.text().paragraphs().size());
1135 // Reinitialize anchor to first pit.
1136 anchor_ref_ = firstpm.first;
1138 LYXERR(Debug::PAINTING)
1139 << "Mouse hover detected at: (" << cmd.x << ", " << cmd.y << ")"
1140 << "\nTriggering redraw: y1: " << y1 << " y2: " << y2
1141 << " pit1: " << firstpm.first << " pit2: " << lastpm.first << endl;
1143 // This event (moving without mouse click) is not passed further.
1144 // This should be changed if it is further utilized.
1148 // Build temporary cursor.
1149 Inset * inset = text_metrics_[&buffer_.text()].editXY(cur, cmd.x, cmd.y);
1151 // Put anchor at the same position.
1154 // Try to dispatch to an non-editable inset near this position
1155 // via the temp cursor. If the inset wishes to change the real
1156 // cursor it has to do so explicitly by using
1157 // cur.bv().cursor() = cur; (or similar)
1159 inset->dispatch(cur, cmd);
1162 // Now dispatch to the temporary cursor. If the real cursor should
1163 // be modified, the inset's dispatch has to do so explicitly.
1164 if (!cur.result().dispatched())
1167 //Do we have a selection?
1168 theSelection().haveSelection(cursor().selection());
1170 // Redraw if requested and necessary.
1171 if (cur.result().dispatched() && cur.result().update())
1172 return update(cur.result().update());
1178 void BufferView::scroll(int y)
1187 void BufferView::scrollDown(int offset)
1189 Text * text = &buffer_.text();
1190 TextMetrics & tm = text_metrics_[text];
1191 int ymax = height_ + offset;
1193 std::pair<pit_type, ParagraphMetrics const *> last = tm.last();
1194 int bottom_pos = last.second->position() + last.second->descent();
1195 if (last.first == text->paragraphs().size() - 1) {
1196 if (bottom_pos <= height_)
1198 offset = min(offset, bottom_pos - height_);
1201 if (bottom_pos > ymax)
1203 tm.newParMetricsDown();
1205 offset_ref_ += offset;
1206 updateMetrics(false);
1211 void BufferView::scrollUp(int offset)
1213 Text * text = &buffer_.text();
1214 TextMetrics & tm = text_metrics_[text];
1215 int ymin = - offset;
1217 std::pair<pit_type, ParagraphMetrics const *> first = tm.first();
1218 int top_pos = first.second->position() - first.second->ascent();
1219 if (first.first == 0) {
1222 offset = min(offset, - top_pos);
1227 tm.newParMetricsUp();
1229 offset_ref_ -= offset;
1230 updateMetrics(false);
1235 void BufferView::setCursorFromRow(int row)
1240 buffer_.texrow().getIdFromRow(row, tmpid, tmppos);
1242 cursor_.reset(buffer_.inset());
1244 buffer_.text().setCursor(cursor_, 0, 0);
1246 buffer_.text().setCursor(cursor_, buffer_.getParFromID(tmpid).pit(), tmppos);
1250 void BufferView::gotoLabel(docstring const & label)
1252 for (InsetIterator it = inset_iterator_begin(buffer_.inset()); it; ++it) {
1253 vector<docstring> labels;
1254 it->getLabelList(buffer_, labels);
1255 if (std::find(labels.begin(), labels.end(), label) != labels.end()) {
1264 TextMetrics const & BufferView::textMetrics(Text const * t) const
1266 return const_cast<BufferView *>(this)->textMetrics(t);
1270 TextMetrics & BufferView::textMetrics(Text const * t)
1272 TextMetricsCache::iterator tmc_it = text_metrics_.find(t);
1273 if (tmc_it == text_metrics_.end()) {
1274 tmc_it = text_metrics_.insert(
1275 make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
1277 return tmc_it->second;
1281 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
1284 return textMetrics(t).parMetrics(pit);
1288 int BufferView::workHeight() const
1294 void BufferView::setCursor(DocIterator const & dit)
1296 size_t const n = dit.depth();
1297 for (size_t i = 0; i < n; ++i)
1298 dit[i].inset().edit(cursor_, true);
1300 cursor_.setCursor(dit);
1301 cursor_.selection() = false;
1305 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
1307 // Would be wrong to delete anything if we have a selection.
1308 if (cur.selection())
1311 bool need_anchor_change = false;
1312 bool changed = cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
1313 need_anchor_change);
1315 if (need_anchor_change)
1321 updateLabels(buffer_);
1323 updateMetrics(false);
1329 bool BufferView::mouseSetCursor(Cursor & cur)
1331 BOOST_ASSERT(&cur.bv() == this);
1333 // this event will clear selection so we save selection for
1334 // persistent selection
1335 cap::saveSelection(cursor());
1337 // Has the cursor just left the inset?
1338 bool badcursor = false;
1339 bool leftinset = (&cursor_.inset() != &cur.inset());
1341 badcursor = notifyCursorLeaves(cursor_, cur);
1343 // do the dEPM magic if needed
1344 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
1345 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
1346 // the leftinset bool would not be necessary (badcursor instead).
1347 bool update = leftinset;
1348 if (!badcursor && cursor_.inTexted())
1349 update |= checkDepm(cur, cursor_);
1351 // if the cursor was in an empty script inset and the new
1352 // position is in the nucleus of the inset, notifyCursorLeaves
1353 // will kill the script inset itself. So we check all the
1354 // elements of the cursor to make sure that they are correct.
1355 // For an example, see bug 2933:
1356 // http://bugzilla.lyx.org/show_bug.cgi?id=2933
1357 // The code below could maybe be moved to a DocIterator method.
1358 //lyxerr << "cur before " << cur <<std::endl;
1359 DocIterator dit(cur.inset());
1360 dit.push_back(cur.bottom());
1362 while (i < cur.depth() && dit.nextInset() == &cur[i].inset()) {
1363 dit.push_back(cur[i]);
1366 //lyxerr << "5 cur after" << dit <<std::endl;
1368 cursor_.setCursor(dit);
1369 cursor_.boundary(cur.boundary());
1370 cursor_.clearSelection();
1376 void BufferView::putSelectionAt(DocIterator const & cur,
1377 int length, bool backwards)
1379 cursor_.clearSelection();
1385 cursor_.pos() += length;
1386 cursor_.setSelection(cursor_, -length);
1388 cursor_.setSelection(cursor_, length);
1393 Cursor & BufferView::cursor()
1399 Cursor const & BufferView::cursor() const
1405 pit_type BufferView::anchor_ref() const
1411 ViewMetricsInfo const & BufferView::viewMetricsInfo()
1413 return metrics_info_;
1417 bool BufferView::singleParUpdate()
1419 Text & buftext = buffer_.text();
1420 pit_type const bottom_pit = cursor_.bottom().pit();
1421 TextMetrics & tm = textMetrics(&buftext);
1422 int old_height = tm.parMetrics(bottom_pit).height();
1424 // In Single Paragraph mode, rebreak only
1425 // the (main text, not inset!) paragraph containing the cursor.
1426 // (if this paragraph contains insets etc., rebreaking will
1427 // recursively descend)
1428 tm.redoParagraph(bottom_pit);
1429 ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
1430 if (pm.height() != old_height)
1431 // Paragraph height has changed so we cannot proceed to
1432 // the singlePar optimisation.
1435 int y1 = pm.position() - pm.ascent();
1436 int y2 = pm.position() + pm.descent();
1437 metrics_info_ = ViewMetricsInfo(bottom_pit, bottom_pit, y1, y2,
1438 SingleParUpdate, buftext.paragraphs().size());
1439 LYXERR(Debug::PAINTING)
1440 << BOOST_CURRENT_FUNCTION
1443 << " pit: " << bottom_pit
1450 void BufferView::updateMetrics(bool singlepar)
1452 if (singlepar && singleParUpdate())
1453 // No need to update the full screen metrics.
1456 Text & buftext = buffer_.text();
1457 pit_type const npit = int(buftext.paragraphs().size());
1459 if (anchor_ref_ > int(npit - 1)) {
1460 anchor_ref_ = int(npit - 1);
1464 // Clear out the position cache in case of full screen redraw,
1465 coord_cache_.clear();
1467 // Clear out paragraph metrics to avoid having invalid metrics
1468 // in the cache from paragraphs not relayouted below
1469 // The complete text metrics will be redone.
1470 text_metrics_.clear();
1472 TextMetrics & tm = textMetrics(&buftext);
1474 pit_type const pit = anchor_ref_;
1478 // Rebreak anchor paragraph.
1479 tm.redoParagraph(pit);
1481 // Take care of anchor offset if case a recentering is needed.
1484 int y0 = tm.parMetrics(pit).ascent() - offset_ref_;
1486 // Redo paragraphs above anchor if necessary.
1488 while (y1 > 0 && pit1 > 0) {
1489 y1 -= tm.parMetrics(pit1).ascent();
1491 tm.redoParagraph(pit1);
1492 y1 -= tm.parMetrics(pit1).descent();
1495 // Take care of ascent of first line
1496 y1 -= tm.parMetrics(pit1).ascent();
1498 // Normalize anchor for next time
1502 // Grey at the beginning is ugly
1503 if (pit1 == 0 && y1 > 0) {
1509 // Redo paragraphs below the anchor if necessary.
1511 while (y2 < height_ && pit2 < int(npit) - 1) {
1512 y2 += tm.parMetrics(pit2).descent();
1514 tm.redoParagraph(pit2);
1515 y2 += tm.parMetrics(pit2).ascent();
1518 // Take care of descent of last line
1519 y2 += tm.parMetrics(pit2).descent();
1521 LYXERR(Debug::PAINTING)
1522 << BOOST_CURRENT_FUNCTION
1525 << " pit1: " << pit1
1526 << " pit2: " << pit2
1527 << " npit: " << npit
1531 metrics_info_ = ViewMetricsInfo(pit1, pit2, y1, y2,
1532 FullScreenUpdate, npit);
1534 if (lyxerr.debugging(Debug::WORKAREA)) {
1535 LYXERR(Debug::WORKAREA) << "BufferView::updateMetrics" << endl;
1536 coord_cache_.dump();
1541 void BufferView::menuInsertLyXFile(string const & filenm)
1543 BOOST_ASSERT(cursor_.inTexted());
1544 string filename = filenm;
1546 if (filename.empty()) {
1547 // Launch a file browser
1549 string initpath = lyxrc.document_path;
1550 string const trypath = buffer_.filePath();
1551 // If directory is writeable, use this as default.
1552 if (isDirWriteable(FileName(trypath)))
1556 FileDialog fileDlg(_("Select LyX document to insert"),
1558 make_pair(_("Documents|#o#O"), from_utf8(lyxrc.document_path)),
1559 make_pair(_("Examples|#E#e"),
1560 from_utf8(addPath(package().system_support().absFilename(),
1563 FileDialog::Result result =
1564 fileDlg.open(from_utf8(initpath),
1565 FileFilterList(_("LyX Documents (*.lyx)")),
1568 if (result.first == FileDialog::Later)
1572 filename = to_utf8(result.second);
1574 // check selected filename
1575 if (filename.empty()) {
1576 // emit message signal.
1577 message(_("Canceled."));
1582 // Get absolute path of file and add ".lyx"
1583 // to the filename if necessary
1584 filename = fileSearch(string(), filename, "lyx").absFilename();
1586 docstring const disp_fn = makeDisplayPath(filename);
1587 // emit message signal.
1588 message(bformat(_("Inserting document %1$s..."), disp_fn));
1591 Buffer buf("", false);
1592 if (lyx::loadLyXFile(&buf, FileName(filename))) {
1593 ErrorList & el = buffer_.errorList("Parse");
1594 // Copy the inserted document error list into the current buffer one.
1595 el = buf.errorList("Parse");
1596 recordUndo(cursor_);
1597 cap::pasteParagraphList(cursor_, buf.paragraphs(),
1598 buf.params().getTextClassPtr(), el);
1599 res = _("Document %1$s inserted.");
1601 res = _("Could not insert document %1$s");
1603 // emit message signal.
1604 message(bformat(res, disp_fn));
1605 buffer_.errors("Parse");
1606 updateMetrics(false);
1610 void BufferView::draw(frontend::Painter & pain)
1612 PainterInfo pi(this, pain);
1613 // Should the whole screen, including insets, be refreshed?
1614 // FIXME: We should also distinguish DecorationUpdate to avoid text
1615 // drawing if possible. This is not possible to do easily right now
1616 // because of the single backing pixmap.
1617 pi.full_repaint = metrics_info_.update_strategy != SingleParUpdate;
1619 if (pi.full_repaint)
1620 // Clear background (if not delegated to rows)
1621 pain.fillRectangle(0, metrics_info_.y1, width_,
1622 metrics_info_.y2 - metrics_info_.y1,
1623 buffer_.inset().backgroundColor());
1625 LYXERR(Debug::PAINTING) << "\t\t*** START DRAWING ***" << endl;
1626 Text & text = buffer_.text();
1627 TextMetrics const & tm = text_metrics_[&text];
1628 int y = metrics_info_.y1 + tm.parMetrics(metrics_info_.p1).ascent();
1629 if (!pi.full_repaint)
1630 tm.drawParagraph(pi, metrics_info_.p1, 0, y);
1633 LYXERR(Debug::PAINTING) << "\n\t\t*** END DRAWING ***" << endl;
1635 // and grey out above (should not happen later)
1636 // lyxerr << "par ascent: " << text.getPar(metrics_info_.p1).ascent() << endl;
1637 if (metrics_info_.y1 > 0
1638 && metrics_info_.update_strategy == FullScreenUpdate)
1639 pain.fillRectangle(0, 0, width_, metrics_info_.y1, Color::bottomarea);
1641 // and possibly grey out below
1642 // lyxerr << "par descent: " << text.getPar(metrics_info_.p1).ascent() << endl;
1643 if (metrics_info_.y2 < height_
1644 && metrics_info_.update_strategy == FullScreenUpdate)
1645 pain.fillRectangle(0, metrics_info_.y2, width_,
1646 height_ - metrics_info_.y2, Color::bottomarea);