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 "CoordCache.h"
25 #include "CutAndPaste.h"
27 #include "DispatchResult.h"
28 #include "ErrorList.h"
30 #include "FloatList.h"
31 #include "FuncRequest.h"
32 #include "FuncStatus.h"
35 #include "InsetIterator.h"
37 #include "LaTeXFeatures.h"
38 #include "callback.h" // added for Dispatch functions
44 #include "TextClass.h"
47 #include "Paragraph.h"
48 #include "paragraph_funcs.h"
49 #include "ParagraphParameters.h"
50 #include "ParIterator.h"
55 #include "WordLangTuple.h"
56 #include "MetricsInfo.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/Selection.h"
68 #include "graphics/Previews.h"
70 #include "support/convert.h"
71 #include "support/FileFilterList.h"
72 #include "support/filetools.h"
73 #include "support/Package.h"
74 #include "support/types.h"
76 #include <boost/bind.hpp>
77 #include <boost/current_function.hpp>
84 using std::istringstream;
88 using std::mem_fun_ref;
95 using support::addPath;
96 using support::bformat;
97 using support::FileFilterList;
98 using support::FileName;
99 using support::fileSearch;
100 using support::isDirWriteable;
101 using support::isFileReadable;
102 using support::makeDisplayPath;
103 using support::package;
105 namespace Alert = frontend::Alert;
109 /// Return an inset of this class if it exists at the current cursor position
111 T * getInsetByCode(Cursor & cur, Inset::Code code)
114 DocIterator it = cur;
115 if (it.nextInset() &&
116 it.nextInset()->lyxCode() == code) {
117 inset = static_cast<T*>(it.nextInset());
125 BufferView::BufferView(Buffer & buf)
126 : width_(0), height_(0), buffer_(buf), wh_(0),
128 multiparsel_cache_(false), anchor_ref_(0), offset_ref_(0),
129 need_centering_(false), intl_(new Intl), last_inset_(0)
131 xsel_cache_.set = false;
132 intl_->initKeyMapper(lyxrc.use_kbmap);
134 cursor_.push(buffer_.inset());
135 cursor_.resetAnchor();
136 buffer_.text().setCurrentFont(cursor_);
138 if (graphics::Previews::status() != LyXRC::PREVIEW_OFF)
139 graphics::Previews::get().generateBufferPreviews(buffer_);
143 BufferView::~BufferView()
145 // current buffer is going to be switched-off, save cursor pos
146 // Ideally, the whole cursor stack should be saved, but session
147 // currently can only handle bottom (whole document) level pit and pos.
148 // That is to say, if a cursor is in a nested inset, it will be
149 // restore to the left of the top level inset.
150 LyX::ref().session().lastFilePos().save(
151 support::FileName(buffer_.fileName()),
152 boost::tie(cursor_.bottom().pit(), cursor_.bottom().pos()) );
156 Buffer & BufferView::buffer()
162 Buffer const & BufferView::buffer() const
168 bool BufferView::fitCursor()
170 if (bv_funcs::status(this, cursor_) == bv_funcs::CUR_INSIDE) {
171 frontend::FontMetrics const & fm =
172 theFontMetrics(cursor_.getFont());
173 int const asc = fm.maxAscent();
174 int const des = fm.maxDescent();
175 Point const p = bv_funcs::getPos(*this, cursor_, cursor_.boundary());
176 if (p.y_ - asc >= 0 && p.y_ + des < height_)
184 bool BufferView::multiParSel()
186 if (!cursor_.selection())
188 bool ret = multiparsel_cache_;
189 multiparsel_cache_ = cursor_.selBegin().pit() != cursor_.selEnd().pit();
190 // Either this, or previous selection spans paragraphs
191 return ret || multiparsel_cache_;
195 bool BufferView::update(Update::flags flags)
197 // last_inset_ points to the last visited inset. This pointer may become
198 // invalid because of keyboard editing. Since all such operations
199 // causes screen update(), I reset last_inset_ to avoid such a problem.
201 // This is close to a hot-path.
203 << BOOST_CURRENT_FUNCTION
204 << "[fitcursor = " << (flags & Update::FitCursor)
205 << ", forceupdate = " << (flags & Update::Force)
206 << ", singlepar = " << (flags & Update::SinglePar)
207 << "] buffer: " << &buffer_ << endl;
209 // Update macro store
210 if (!(cursor().inMathed() && cursor().inMacroMode()))
211 buffer_.buildMacros();
213 // Now do the first drawing step if needed. This consists on updating
214 // the CoordCache in updateMetrics().
215 // The second drawing step is done in WorkArea::redraw() if needed.
217 // Case when no explicit update is requested.
219 // no need to redraw anything.
220 metrics_info_.update_strategy = NoScreenUpdate;
224 if (flags == Update::Decoration) {
225 metrics_info_.update_strategy = DecorationUpdate;
229 if (flags == Update::FitCursor
230 || flags == (Update::Decoration | Update::FitCursor)) {
231 bool const fit_cursor = fitCursor();
232 // tell the frontend to update the screen if needed.
234 updateMetrics(false);
237 if (flags & Update::Decoration) {
238 metrics_info_.update_strategy = DecorationUpdate;
241 // no screen update is needed.
242 metrics_info_.update_strategy = NoScreenUpdate;
246 bool full_metrics = flags & Update::Force;
247 if (flags & Update::MultiParSel)
248 full_metrics |= multiParSel();
250 bool const single_par = !full_metrics;
251 updateMetrics(single_par);
253 if (flags & Update::FitCursor && fitCursor())
254 updateMetrics(false);
256 // tell the frontend to update the screen.
261 void BufferView::updateScrollbar()
263 Text & t = buffer_.text();
264 TextMetrics & tm = text_metrics_[&t];
266 int const parsize = int(t.paragraphs().size() - 1);
267 if (anchor_ref_ > parsize) {
268 anchor_ref_ = parsize;
273 << BOOST_CURRENT_FUNCTION
274 << " Updating scrollbar: height: " << t.paragraphs().size()
275 << " curr par: " << cursor_.bottom().pit()
276 << " default height " << defaultRowHeight() << endl;
278 // It would be better to fix the scrollbar to understand
279 // values in [0..1] and divide everything by wh
281 // estimated average paragraph height:
285 int h = tm.parMetrics(anchor_ref_).height();
287 // Normalize anchor/offset (MV):
288 while (offset_ref_ > h && anchor_ref_ < parsize) {
291 h = tm.parMetrics(anchor_ref_).height();
293 // Look at paragraph heights on-screen
296 for (pit_type pit = anchor_ref_; pit <= parsize; ++pit) {
299 int const h2 = tm.parMetrics(pit).height();
305 int const hav = sumh / nh;
306 // More realistic average paragraph height
311 scrollbarParameters_.height = (parsize + 1) * wh_;
312 scrollbarParameters_.position = anchor_ref_ * wh_ + int(offset_ref_ * wh_ / float(h));
313 scrollbarParameters_.lineScrollHeight = int(wh_ * defaultRowHeight() / float(h));
317 ScrollbarParameters const & BufferView::scrollbarParameters() const
319 return scrollbarParameters_;
323 void BufferView::scrollDocView(int value)
325 LYXERR(Debug::GUI) << BOOST_CURRENT_FUNCTION
326 << "[ value = " << value << "]" << endl;
328 Text & t = buffer_.text();
329 TextMetrics & tm = text_metrics_[&t];
331 float const bar = value / float(wh_ * t.paragraphs().size());
333 anchor_ref_ = int(bar * t.paragraphs().size());
334 if (anchor_ref_ > int(t.paragraphs().size()) - 1)
335 anchor_ref_ = int(t.paragraphs().size()) - 1;
337 tm.redoParagraph(anchor_ref_);
338 int const h = tm.parMetrics(anchor_ref_).height();
339 offset_ref_ = int((bar * t.paragraphs().size() - anchor_ref_) * h);
340 updateMetrics(false);
344 void BufferView::setCursorFromScrollbar()
346 Text & t = buffer_.text();
348 int const height = 2 * defaultRowHeight();
349 int const first = height;
350 int const last = height_ - height;
351 Cursor & cur = cursor_;
353 bv_funcs::CurStatus st = bv_funcs::status(this, cur);
356 case bv_funcs::CUR_ABOVE:
357 // We reset the cursor because bv_funcs::status() does not
358 // work when the cursor is within mathed.
359 cur.reset(buffer_.inset());
360 t.setCursorFromCoordinates(cur, 0, first);
361 cur.clearSelection();
363 case bv_funcs::CUR_BELOW:
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 t.setCursorFromCoordinates(cur, 0, last);
368 cur.clearSelection();
370 case bv_funcs::CUR_INSIDE:
371 int const y = bv_funcs::getPos(*this, cur, cur.boundary()).y_;
372 int const newy = min(last, max(y, first));
374 cur.reset(buffer_.inset());
375 t.setCursorFromCoordinates(cur, 0, newy);
381 Change const BufferView::getCurrentChange() const
383 if (!cursor_.selection())
384 return Change(Change::UNCHANGED);
386 DocIterator dit = cursor_.selectionBegin();
387 return dit.paragraph().lookupChange(dit.pos());
391 void BufferView::saveBookmark(unsigned int idx)
393 // tenatively save bookmark, id and pos will be used to
394 // acturately locate a bookmark in a 'live' lyx session.
395 // pit and pos will be updated with bottom level pit/pos
397 LyX::ref().session().bookmarks().save(
398 FileName(buffer_.fileName()),
399 cursor_.bottom().pit(),
400 cursor_.bottom().pos(),
401 cursor_.paragraph().id(),
406 // emit message signal.
407 message(_("Save bookmark"));
411 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
412 int top_id, pos_type top_pos)
414 bool success = false;
417 cursor_.clearSelection();
419 // if a valid par_id is given, try it first
420 // This is the case for a 'live' bookmark when unique paragraph ID
421 // is used to track bookmarks.
423 ParIterator par = buffer_.getParFromID(top_id);
424 if (par != buffer_.par_iterator_end()) {
425 doc_it = makeDocIterator(par, min(par->size(), top_pos));
426 // Some slices of the iterator may not be
427 // reachable (e.g. closed collapsable inset)
428 // so the dociterator may need to be
429 // shortened. Otherwise, setCursor may crash
430 // lyx when the cursor can not be set to these
432 size_t const n = doc_it.depth();
433 for (size_t i = 0; i < n; ++i)
434 if (doc_it[i].inset().editable() != Inset::HIGHLY_EDITABLE) {
442 // if top_id == 0, or searching through top_id failed
443 // This is the case for a 'restored' bookmark when only bottom
444 // (document level) pit was saved. Because of this, bookmark
445 // restoration is inaccurate. If a bookmark was within an inset,
446 // it will be restored to the left of the outmost inset that contains
448 if (static_cast<size_t>(bottom_pit) < buffer_.paragraphs().size()) {
449 doc_it = doc_iterator_begin(buffer_.inset());
450 doc_it.pit() = bottom_pit;
451 doc_it.pos() = min(bottom_pos, doc_it.paragraph().size());
456 // Note: only bottom (document) level pit is set.
458 // set the current font.
459 buffer_.text().setCurrentFont(cursor_);
460 // center the screen on this new position.
468 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
470 if (lyxrc.rtl_support) {
471 if (cursor_.innerText()->real_current_font.isRightToLeft()) {
472 if (intl_->keymap == Intl::PRIMARY)
475 if (intl_->keymap == Intl::SECONDARY)
480 intl_->getTransManager().translateAndInsert(c, t, cur);
484 int BufferView::workWidth() const
490 void BufferView::updateOffsetRef()
492 // No need to update offset_ref_ in this case.
493 if (!need_centering_)
496 // We are not properly started yet, delay until resizing is
501 CursorSlice & bot = cursor_.bottom();
502 TextMetrics & tm = text_metrics_[bot.text()];
503 ParagraphMetrics const & pm = tm.parMetrics(bot.pit());
504 Point p = bv_funcs::coordOffset(*this, cursor_, cursor_.boundary());
505 offset_ref_ = p.y_ + pm.ascent() - height_ / 2;
507 need_centering_ = false;
511 void BufferView::center()
513 anchor_ref_ = cursor_.bottom().pit();
514 need_centering_ = true;
518 FuncStatus BufferView::getStatus(FuncRequest const & cmd)
522 Cursor & cur = cursor_;
524 switch (cmd.action) {
527 flag.enabled(!buffer_.undostack().empty());
530 flag.enabled(!buffer_.redostack().empty());
532 case LFUN_FILE_INSERT:
533 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
534 case LFUN_FILE_INSERT_PLAINTEXT:
535 case LFUN_BOOKMARK_SAVE:
536 // FIXME: Actually, these LFUNS should be moved to Text
537 flag.enabled(cur.inTexted());
539 case LFUN_FONT_STATE:
540 case LFUN_LABEL_INSERT:
541 case LFUN_PARAGRAPH_GOTO:
542 // FIXME handle non-trivially
543 case LFUN_OUTLINE_UP:
544 case LFUN_OUTLINE_DOWN:
545 case LFUN_OUTLINE_IN:
546 case LFUN_OUTLINE_OUT:
548 case LFUN_REFERENCE_NEXT:
550 case LFUN_WORD_REPLACE:
553 case LFUN_MARK_TOGGLE:
554 case LFUN_SCREEN_RECENTER:
555 case LFUN_BIBTEX_DATABASE_ADD:
556 case LFUN_BIBTEX_DATABASE_DEL:
557 case LFUN_WORDS_COUNT:
558 case LFUN_NEXT_INSET_TOGGLE:
562 case LFUN_LABEL_GOTO: {
563 flag.enabled(!cmd.argument().empty()
564 || getInsetByCode<InsetRef>(cur, Inset::REF_CODE));
568 case LFUN_CHANGES_TRACK:
570 flag.setOnOff(buffer_.params().trackChanges);
573 case LFUN_CHANGES_OUTPUT:
575 flag.setOnOff(buffer_.params().outputChanges);
578 case LFUN_CHANGES_MERGE:
579 case LFUN_CHANGE_NEXT:
580 case LFUN_ALL_CHANGES_ACCEPT:
581 case LFUN_ALL_CHANGES_REJECT:
582 // TODO: context-sensitive enabling of LFUNs
583 // In principle, these command should only be enabled if there
584 // is a change in the document. However, without proper
585 // optimizations, this will inevitably result in poor performance.
589 case LFUN_BUFFER_TOGGLE_COMPRESSION: {
590 flag.setOnOff(buffer_.params().compressed);
602 Update::flags BufferView::dispatch(FuncRequest const & cmd)
604 //lyxerr << BOOST_CURRENT_FUNCTION
605 // << [ cmd = " << cmd << "]" << endl;
607 // Make sure that the cached BufferView is correct.
608 LYXERR(Debug::ACTION) << BOOST_CURRENT_FUNCTION
609 << " action[" << cmd.action << ']'
610 << " arg[" << to_utf8(cmd.argument()) << ']'
611 << " x[" << cmd.x << ']'
612 << " y[" << cmd.y << ']'
613 << " button[" << cmd.button() << ']'
616 Cursor & cur = cursor_;
617 // Default Update flags.
618 Update::flags updateFlags = Update::Force | Update::FitCursor;
620 switch (cmd.action) {
623 cur.message(_("Undo"));
624 cur.clearSelection();
625 if (!textUndo(*this)) {
626 cur.message(_("No further undo information"));
627 updateFlags = Update::None;
632 cur.message(_("Redo"));
633 cur.clearSelection();
634 if (!textRedo(*this)) {
635 cur.message(_("No further redo information"));
636 updateFlags = Update::None;
640 case LFUN_FILE_INSERT:
642 menuInsertLyXFile(to_utf8(cmd.argument()));
645 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
647 insertPlaintextFile(this, to_utf8(cmd.argument()), true);
650 case LFUN_FILE_INSERT_PLAINTEXT:
652 insertPlaintextFile(this, to_utf8(cmd.argument()), false);
655 case LFUN_FONT_STATE:
656 cur.message(cur.currentState());
659 case LFUN_BOOKMARK_SAVE:
660 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
663 case LFUN_LABEL_GOTO: {
664 docstring label = cmd.argument();
667 getInsetByCode<InsetRef>(cursor_,
670 label = inset->getParam("reference");
671 // persistent=false: use temp_bookmark
681 case LFUN_PARAGRAPH_GOTO: {
682 int const id = convert<int>(to_utf8(cmd.argument()));
684 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
685 b = theBufferList().next(b)) {
687 ParIterator par = b->getParFromID(id);
688 if (par == b->par_iterator_end()) {
690 << "No matching paragraph found! ["
691 << id << "]." << endl;
694 << "Paragraph " << par->id()
695 << " found in buffer `"
696 << b->fileName() << "'." << endl;
700 setCursor(makeDocIterator(par, 0));
702 // Switch to other buffer view and resend cmd
703 theLyXFunc().dispatch(FuncRequest(
704 LFUN_BUFFER_SWITCH, b->fileName()));
705 theLyXFunc().dispatch(cmd);
706 updateFlags = Update::None;
715 case LFUN_OUTLINE_UP:
716 toc::outline(toc::Up, cursor_);
717 cursor_.text()->setCursor(cursor_, cursor_.pit(), 0);
718 updateLabels(buffer_);
720 case LFUN_OUTLINE_DOWN:
721 toc::outline(toc::Down, cursor_);
722 cursor_.text()->setCursor(cursor_, cursor_.pit(), 0);
723 updateLabels(buffer_);
725 case LFUN_OUTLINE_IN:
726 toc::outline(toc::In, cursor_);
727 updateLabels(buffer_);
729 case LFUN_OUTLINE_OUT:
730 toc::outline(toc::Out, cursor_);
731 updateLabels(buffer_);
735 bv_funcs::gotoInset(this, Inset::NOTE_CODE, false);
738 case LFUN_REFERENCE_NEXT: {
739 vector<Inset_code> tmp;
740 tmp.push_back(Inset::LABEL_CODE);
741 tmp.push_back(Inset::REF_CODE);
742 bv_funcs::gotoInset(this, tmp, true);
746 case LFUN_CHANGES_TRACK:
747 buffer_.params().trackChanges = !buffer_.params().trackChanges;
750 case LFUN_CHANGES_OUTPUT:
751 buffer_.params().outputChanges = !buffer_.params().outputChanges;
752 if (buffer_.params().outputChanges) {
753 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
754 bool xcolorsoul = LaTeXFeatures::isAvailable("soul") &&
755 LaTeXFeatures::isAvailable("xcolor");
757 if (!dvipost && !xcolorsoul) {
758 Alert::warning(_("Changes not shown in LaTeX output"),
759 _("Changes will not be highlighted in LaTeX output, "
760 "because neither dvipost nor xcolor/soul are installed.\n"
761 "Please install these packages or redefine "
762 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
763 } else if (!xcolorsoul) {
764 Alert::warning(_("Changes not shown in LaTeX output"),
765 _("Changes will not be highlighted in LaTeX output "
766 "when using pdflatex, because xcolor and soul are not installed.\n"
767 "Please install both packages or redefine "
768 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
773 case LFUN_CHANGE_NEXT:
774 findNextChange(this);
777 case LFUN_CHANGES_MERGE:
778 if (findNextChange(this))
779 showDialog("changes");
782 case LFUN_ALL_CHANGES_ACCEPT:
783 // select complete document
784 cursor_.reset(buffer_.inset());
785 cursor_.selHandle(true);
786 buffer_.text().cursorBottom(cursor_);
787 // accept everything in a single step to support atomic undo
788 buffer_.text().acceptOrRejectChanges(cursor_, Text::ACCEPT);
791 case LFUN_ALL_CHANGES_REJECT:
792 // select complete document
793 cursor_.reset(buffer_.inset());
794 cursor_.selHandle(true);
795 buffer_.text().cursorBottom(cursor_);
796 // reject everything in a single step to support atomic undo
797 // Note: reject does not work recursively; the user may have to repeat the operation
798 buffer_.text().acceptOrRejectChanges(cursor_, Text::REJECT);
805 case LFUN_WORD_REPLACE: {
806 bool has_deleted = false;
807 if (cur.selection()) {
808 DocIterator beg = cur.selectionBegin();
809 DocIterator end = cur.selectionEnd();
810 if (beg.pit() == end.pit()) {
811 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
812 if (cur.paragraph().isDeleted(p))
817 replace(this, cmd, has_deleted);
822 cur.clearSelection();
824 cur.message(from_utf8(N_("Mark off")));
828 cur.clearSelection();
831 cur.message(from_utf8(N_("Mark on")));
834 case LFUN_MARK_TOGGLE:
835 cur.clearSelection();
838 cur.message(from_utf8(N_("Mark removed")));
841 cur.message(from_utf8(N_("Mark set")));
846 case LFUN_SCREEN_RECENTER:
850 case LFUN_BIBTEX_DATABASE_ADD: {
851 Cursor tmpcur = cursor_;
852 bv_funcs::findInset(tmpcur, Inset::BIBTEX_CODE, false);
853 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
856 if (inset->addDatabase(to_utf8(cmd.argument())))
857 buffer_.updateBibfilesCache();
862 case LFUN_BIBTEX_DATABASE_DEL: {
863 Cursor tmpcur = cursor_;
864 bv_funcs::findInset(tmpcur, Inset::BIBTEX_CODE, false);
865 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
868 if (inset->delDatabase(to_utf8(cmd.argument())))
869 buffer_.updateBibfilesCache();
874 case LFUN_WORDS_COUNT: {
875 DocIterator from, to;
876 if (cur.selection()) {
877 from = cur.selectionBegin();
878 to = cur.selectionEnd();
880 from = doc_iterator_begin(buffer_.inset());
881 to = doc_iterator_end(buffer_.inset());
883 int const count = countWords(from, to);
887 message = bformat(_("%1$d words in selection."),
890 message = bformat(_("%1$d words in document."),
895 message = _("One word in selection.");
897 message = _("One word in document.");
900 Alert::information(_("Count words"), message);
904 case LFUN_BUFFER_TOGGLE_COMPRESSION:
905 // turn compression on/off
906 buffer_.params().compressed = !buffer_.params().compressed;
909 case LFUN_NEXT_INSET_TOGGLE: {
910 // this is the real function we want to invoke
911 FuncRequest tmpcmd = FuncRequest(LFUN_INSET_TOGGLE, cmd.origin);
912 // if there is an inset at cursor, see whether it
914 Inset * inset = cur.nextInset();
915 if (inset && inset->isActive()) {
917 tmpcur.pushLeft(*inset);
918 inset->dispatch(tmpcur, tmpcmd);
919 if (tmpcur.result().dispatched()) {
923 // if it did not work, try the underlying inset.
924 if (!cur.result().dispatched())
925 cur.dispatch(tmpcmd);
927 if (cur.result().dispatched())
928 cur.clearSelection();
934 updateFlags = Update::None;
941 docstring const BufferView::requestSelection()
943 Cursor & cur = cursor_;
945 if (!cur.selection()) {
946 xsel_cache_.set = false;
950 if (!xsel_cache_.set ||
951 cur.top() != xsel_cache_.cursor ||
952 cur.anchor_.top() != xsel_cache_.anchor)
954 xsel_cache_.cursor = cur.top();
955 xsel_cache_.anchor = cur.anchor_.top();
956 xsel_cache_.set = cur.selection();
957 return cur.selectionAsString(false);
963 void BufferView::clearSelection()
965 cursor_.clearSelection();
966 // Clear the selection buffer. Otherwise a subsequent
967 // middle-mouse-button paste would use the selection buffer,
968 // not the more current external selection.
969 cap::clearSelection();
970 xsel_cache_.set = false;
971 // The buffer did not really change, but this causes the
972 // redraw we need because we cleared the selection above.
977 void BufferView::resize(int width, int height)
979 // Update from work area
983 // The complete text metrics will be redone.
984 text_metrics_.clear();
985 updateMetrics(false);
989 Inset const * BufferView::getCoveringInset(Text const & text, int x, int y)
991 pit_type pit = text.getPitNearY(*this, y);
992 BOOST_ASSERT(pit != -1);
993 Paragraph const & par = text.getPar(pit);
996 << BOOST_CURRENT_FUNCTION
1001 InsetList::const_iterator iit = par.insetlist.begin();
1002 InsetList::const_iterator iend = par.insetlist.end();
1003 for (; iit != iend; ++iit) {
1004 Inset * const inset = iit->inset;
1005 if (inset->covers(*this, x, y)) {
1006 if (!inset->descendable())
1007 // No need to go further down if the inset is not
1011 size_t cell_number = inset->nargs();
1012 // Check all the inner cell.
1013 for (size_t i = 0; i != cell_number; ++i) {
1014 Text const * inner_text = inset->getText(i);
1017 Inset const * inset_deeper =
1018 getCoveringInset(*inner_text, x, y);
1020 return inset_deeper;
1024 LYXERR(Debug::DEBUG)
1025 << BOOST_CURRENT_FUNCTION
1026 << ": Hit inset: " << inset << endl;
1030 LYXERR(Debug::DEBUG)
1031 << BOOST_CURRENT_FUNCTION
1032 << ": No inset hit. " << endl;
1037 bool BufferView::workAreaDispatch(FuncRequest const & cmd0)
1039 //lyxerr << BOOST_CURRENT_FUNCTION << "[ cmd0 " << cmd0 << "]" << endl;
1041 // This is only called for mouse related events including
1042 // LFUN_FILE_OPEN generated by drag-and-drop.
1043 FuncRequest cmd = cmd0;
1046 cur.push(buffer_.inset());
1047 cur.selection() = cursor_.selection();
1049 // Either the inset under the cursor or the
1050 // surrounding Text will handle this event.
1052 // make sure we stay within the screen...
1053 cmd.y = min(max(cmd.y, -1), height_);
1055 if (cmd.action == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
1057 // Get inset under mouse, if there is one.
1058 Inset const * covering_inset =
1059 getCoveringInset(buffer_.text(), cmd.x, cmd.y);
1060 if (covering_inset == last_inset_)
1061 // Same inset, no need to do anything...
1064 bool need_redraw = false;
1065 // const_cast because of setMouseHover().
1066 Inset * inset = const_cast<Inset *>(covering_inset);
1068 // Remove the hint on the last hovered inset (if any).
1069 need_redraw |= last_inset_->setMouseHover(false);
1071 // Highlighted the newly hovered inset (if any).
1072 need_redraw |= inset->setMouseHover(true);
1073 last_inset_ = inset;
1075 // if last metrics update was in singlepar mode, WorkArea::redraw() will
1076 // not expose the button for redraw. We adjust here the metrics dimension
1077 // to enable a full redraw.
1078 // FIXME: It is possible to redraw only the area around the button!
1080 && metrics_info_.update_strategy == SingleParUpdate) {
1081 // FIXME: It should be possible to redraw only the area around
1082 // the button by doing this:
1084 //metrics_info_.singlepar = false;
1085 //metrics_info_.y1 = ymin of button;
1086 //metrics_info_.y2 = ymax of button;
1088 // Unfortunately, rowpainter.cpp:paintText() does not distinguish
1089 // between background updates and text updates. So we use the hammer
1090 // solution for now. We could also avoid the updateMetrics() below
1091 // by using the first and last pit of the CoordCache. Have a look
1092 // at Text::getPitNearY() to see what I mean.
1094 //metrics_info_.pit1 = first pit of CoordCache;
1095 //metrics_info_.pit2 = last pit of CoordCache;
1096 //metrics_info_.singlepar = false;
1097 //metrics_info_.y1 = 0;
1098 //metrics_info_.y2 = height_;
1100 updateMetrics(false);
1103 // This event (moving without mouse click) is not passed further.
1104 // This should be changed if it is further utilized.
1108 // Build temporary cursor.
1109 Inset * inset = buffer_.text().editXY(cur, cmd.x, cmd.y);
1111 // Put anchor at the same position.
1114 // Try to dispatch to an non-editable inset near this position
1115 // via the temp cursor. If the inset wishes to change the real
1116 // cursor it has to do so explicitly by using
1117 // cur.bv().cursor() = cur; (or similar)
1119 inset->dispatch(cur, cmd);
1122 // Now dispatch to the temporary cursor. If the real cursor should
1123 // be modified, the inset's dispatch has to do so explicitly.
1124 if (!cur.result().dispatched())
1127 //Do we have a selection?
1128 theSelection().haveSelection(cursor().selection());
1130 // Redraw if requested and necessary.
1131 if (cur.result().dispatched() && cur.result().update())
1132 return update(cur.result().update());
1138 void BufferView::scroll(int /*lines*/)
1140 // Text const * t = buffer_.text();
1141 // int const line_height = defaultRowHeight();
1143 // // The new absolute coordinate
1144 // int new_top_y = top_y() + lines * line_height;
1146 // // Restrict to a valid value
1147 // new_top_y = std::min(t->height() - 4 * line_height, new_top_y);
1148 // new_top_y = std::max(0, new_top_y);
1150 // scrollDocView(new_top_y);
1155 void BufferView::setCursorFromRow(int row)
1160 buffer_.texrow().getIdFromRow(row, tmpid, tmppos);
1162 cursor_.reset(buffer_.inset());
1164 buffer_.text().setCursor(cursor_, 0, 0);
1166 buffer_.text().setCursor(cursor_, buffer_.getParFromID(tmpid).pit(), tmppos);
1170 void BufferView::gotoLabel(docstring const & label)
1172 for (InsetIterator it = inset_iterator_begin(buffer_.inset()); it; ++it) {
1173 vector<docstring> labels;
1174 it->getLabelList(buffer_, labels);
1175 if (std::find(labels.begin(), labels.end(), label) != labels.end()) {
1184 TextMetrics const & BufferView::textMetrics(Text const * t) const
1186 return const_cast<BufferView *>(this)->textMetrics(t);
1190 TextMetrics & BufferView::textMetrics(Text const * t)
1192 TextMetricsCache::iterator tmc_it = text_metrics_.find(t);
1193 if (tmc_it == text_metrics_.end()) {
1194 tmc_it = text_metrics_.insert(
1195 make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
1197 return tmc_it->second;
1201 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
1204 return textMetrics(t).parMetrics(pit);
1208 int BufferView::workHeight() const
1214 void BufferView::setCursor(DocIterator const & dit)
1216 size_t const n = dit.depth();
1217 for (size_t i = 0; i < n; ++i)
1218 dit[i].inset().edit(cursor_, true);
1220 cursor_.setCursor(dit);
1221 cursor_.selection() = false;
1225 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
1227 // Would be wrong to delete anything if we have a selection.
1228 if (cur.selection())
1231 bool need_anchor_change = false;
1232 bool changed = cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
1233 need_anchor_change);
1235 if (need_anchor_change)
1241 updateLabels(buffer_);
1243 updateMetrics(false);
1249 bool BufferView::mouseSetCursor(Cursor & cur)
1251 BOOST_ASSERT(&cur.bv() == this);
1253 // this event will clear selection so we save selection for
1254 // persistent selection
1255 cap::saveSelection(cursor());
1257 // Has the cursor just left the inset?
1258 bool badcursor = false;
1259 bool leftinset = (&cursor_.inset() != &cur.inset());
1261 badcursor = notifyCursorLeaves(cursor_, cur);
1263 // do the dEPM magic if needed
1264 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
1265 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
1266 // the leftinset bool would not be necessary (badcursor instead).
1267 bool update = leftinset;
1268 if (!badcursor && cursor_.inTexted())
1269 update |= checkDepm(cur, cursor_);
1271 // if the cursor was in an empty script inset and the new
1272 // position is in the nucleus of the inset, notifyCursorLeaves
1273 // will kill the script inset itself. So we check all the
1274 // elements of the cursor to make sure that they are correct.
1275 // For an example, see bug 2933:
1276 // http://bugzilla.lyx.org/show_bug.cgi?id=2933
1277 // The code below could maybe be moved to a DocIterator method.
1278 //lyxerr << "cur before " << cur <<std::endl;
1279 DocIterator dit(cur.inset());
1280 dit.push_back(cur.bottom());
1282 while (i < cur.depth() && dit.nextInset() == &cur[i].inset()) {
1283 dit.push_back(cur[i]);
1286 //lyxerr << "5 cur after" << dit <<std::endl;
1288 cursor_.setCursor(dit);
1289 cursor_.boundary(cur.boundary());
1290 cursor_.clearSelection();
1296 void BufferView::putSelectionAt(DocIterator const & cur,
1297 int length, bool backwards)
1299 cursor_.clearSelection();
1305 cursor_.pos() += length;
1306 cursor_.setSelection(cursor_, -length);
1308 cursor_.setSelection(cursor_, length);
1313 Cursor & BufferView::cursor()
1319 Cursor const & BufferView::cursor() const
1325 pit_type BufferView::anchor_ref() const
1331 ViewMetricsInfo const & BufferView::viewMetricsInfo()
1333 return metrics_info_;
1337 // FIXME: We should split-up updateMetrics() for the singlepar case.
1338 void BufferView::updateMetrics(bool singlepar)
1340 Text & buftext = buffer_.text();
1341 TextMetrics & tm = textMetrics(&buftext);
1342 pit_type size = int(buftext.paragraphs().size());
1344 if (anchor_ref_ > int(buftext.paragraphs().size() - 1)) {
1345 anchor_ref_ = int(buftext.paragraphs().size() - 1);
1350 // Clear out the position cache in case of full screen redraw,
1351 coord_cache_.clear();
1353 // Clear out paragraph metrics to avoid having invalid metrics
1354 // in the cache from paragraphs not relayouted below
1358 // If the paragraph metrics has changed, we can not
1359 // use the singlepar optimisation.
1361 // In Single Paragraph mode, rebreak only
1362 // the (main text, not inset!) paragraph containing the cursor.
1363 // (if this paragraph contains insets etc., rebreaking will
1364 // recursively descend)
1365 && tm.redoParagraph(cursor_.bottom().pit()))
1368 pit_type const pit = anchor_ref_;
1371 size_t const npit = buftext.paragraphs().size();
1373 // Rebreak anchor paragraph.
1375 tm.redoParagraph(pit);
1379 int y0 = tm.parMetrics(pit).ascent() - offset_ref_;
1381 // Redo paragraphs above anchor if necessary.
1383 while (y1 > 0 && pit1 > 0) {
1384 y1 -= tm.parMetrics(pit1).ascent();
1387 tm.redoParagraph(pit1);
1388 y1 -= tm.parMetrics(pit1).descent();
1392 // Take care of ascent of first line
1393 y1 -= tm.parMetrics(pit1).ascent();
1395 // Normalize anchor for next time
1399 // Grey at the beginning is ugly
1400 if (pit1 == 0 && y1 > 0) {
1406 // Redo paragraphs below the anchor if necessary.
1408 while (y2 < height_ && pit2 < int(npit) - 1) {
1409 y2 += tm.parMetrics(pit2).descent();
1412 tm.redoParagraph(pit2);
1413 y2 += tm.parMetrics(pit2).ascent();
1416 // Take care of descent of last line
1417 y2 += tm.parMetrics(pit2).descent();
1419 // The coordinates of all these paragraphs are correct, cache them
1421 CoordCache::InnerParPosCache & parPos = coord_cache_.parPos()[&buftext];
1422 for (pit_type pit = pit1; pit <= pit2; ++pit) {
1423 ParagraphMetrics const & pm = tm.parMetrics(pit);
1425 parPos[pit] = Point(0, y);
1426 if (singlepar && pit == cursor_.bottom().pit()) {
1427 // In Single Paragraph mode, collect here the
1428 // y1 and y2 of the (one) paragraph the cursor is in
1429 y1 = y - pm.ascent();
1430 y2 = y + pm.descent();
1436 // collect cursor paragraph iter bounds
1437 pit1 = cursor_.bottom().pit();
1438 pit2 = cursor_.bottom().pit();
1441 LYXERR(Debug::DEBUG)
1442 << BOOST_CURRENT_FUNCTION
1445 << " pit1: " << pit1
1446 << " pit2: " << pit2
1447 << " npit: " << npit
1448 << " singlepar: " << singlepar
1452 metrics_info_ = ViewMetricsInfo(pit1, pit2, y1, y2,
1453 singlepar? SingleParUpdate: FullScreenUpdate, size);
1455 if (lyxerr.debugging(Debug::WORKAREA)) {
1456 LYXERR(Debug::WORKAREA) << "BufferView::updateMetrics" << endl;
1457 coord_cache_.dump();
1462 void BufferView::menuInsertLyXFile(string const & filenm)
1464 BOOST_ASSERT(cursor_.inTexted());
1465 string filename = filenm;
1467 if (filename.empty()) {
1468 // Launch a file browser
1470 string initpath = lyxrc.document_path;
1471 string const trypath = buffer_.filePath();
1472 // If directory is writeable, use this as default.
1473 if (isDirWriteable(FileName(trypath)))
1477 FileDialog fileDlg(_("Select LyX document to insert"),
1479 make_pair(_("Documents|#o#O"), from_utf8(lyxrc.document_path)),
1480 make_pair(_("Examples|#E#e"),
1481 from_utf8(addPath(package().system_support().absFilename(),
1484 FileDialog::Result result =
1485 fileDlg.open(from_utf8(initpath),
1486 FileFilterList(_("LyX Documents (*.lyx)")),
1489 if (result.first == FileDialog::Later)
1493 filename = to_utf8(result.second);
1495 // check selected filename
1496 if (filename.empty()) {
1497 // emit message signal.
1498 message(_("Canceled."));
1503 // Get absolute path of file and add ".lyx"
1504 // to the filename if necessary
1505 filename = fileSearch(string(), filename, "lyx").absFilename();
1507 docstring const disp_fn = makeDisplayPath(filename);
1508 // emit message signal.
1509 message(bformat(_("Inserting document %1$s..."), disp_fn));
1512 Buffer buf("", false);
1513 if (lyx::loadLyXFile(&buf, FileName(filename))) {
1514 ErrorList & el = buffer_.errorList("Parse");
1515 // Copy the inserted document error list into the current buffer one.
1516 el = buf.errorList("Parse");
1517 recordUndo(cursor_);
1518 cap::pasteParagraphList(cursor_, buf.paragraphs(),
1519 buf.params().getTextClass_ptr(), el);
1520 res = _("Document %1$s inserted.");
1522 res = _("Could not insert document %1$s");
1524 // emit message signal.
1525 message(bformat(res, disp_fn));
1526 buffer_.errors("Parse");
1527 updateMetrics(false);