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 "lyx_cb.h" // added for Dispatch functions
42 #include "lyxlayout.h"
44 #include "lyxtextclass.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"
67 #include "graphics/Previews.h"
69 #include "support/convert.h"
70 #include "support/filefilterlist.h"
71 #include "support/filetools.h"
72 #include "support/package.h"
73 #include "support/types.h"
75 #include <boost/bind.hpp>
76 #include <boost/current_function.hpp>
84 using support::addPath;
85 using support::bformat;
86 using support::FileFilterList;
87 using support::FileName;
88 using support::fileSearch;
89 using support::isDirWriteable;
90 using support::isFileReadable;
91 using support::makeDisplayPath;
92 using support::package;
96 using std::istringstream;
100 using std::mem_fun_ref;
104 namespace Alert = frontend::Alert;
108 /// Return an inset of this class if it exists at the current cursor position
110 T * getInsetByCode(LCursor & cur, InsetBase::Code code)
113 DocIterator it = cur;
114 if (it.nextInset() &&
115 it.nextInset()->lyxCode() == code) {
116 inset = static_cast<T*>(it.nextInset());
124 BufferView::BufferView()
125 : width_(0), height_(0), buffer_(0), wh_(0),
127 multiparsel_cache_(false), anchor_ref_(0), offset_ref_(0),
128 intl_(new Intl), last_inset_(0)
130 xsel_cache_.set = false;
131 intl_->initKeyMapper(lyxrc.use_kbmap);
135 BufferView::~BufferView()
140 Buffer * BufferView::buffer() const
146 void BufferView::setBuffer(Buffer * b)
148 LYXERR(Debug::INFO) << BOOST_CURRENT_FUNCTION
149 << "[ b = " << b << "]" << endl;
152 // Save the actual cursor position and anchor inside the
153 // buffer so that it can be restored in case we rechange
154 // to this buffer later on.
155 buffer_->saveCursor(cursor_.selectionBegin(),
156 cursor_.selectionEnd());
157 // update bookmark pit of the current buffer before switch
158 for (size_t i = 0; i < LyX::ref().session().bookmarks().size(); ++i) {
159 BookmarksSection::Bookmark const & bm = LyX::ref().session().bookmarks().bookmark(i);
160 if (buffer()->fileName() != bm.filename.absFilename())
162 // if par_id or pit has been changed, reset par_pit and par_id
163 // see http://bugzilla.lyx.org/show_bug.cgi?id=3092
166 boost::tie(new_pit, new_id) = moveToPosition(bm.par_pit, bm.par_id, bm.par_pos);
167 if (bm.par_pit != new_pit || bm.par_id != new_id)
168 const_cast<BookmarksSection::Bookmark &>(bm).setPos(new_pit, new_id);
170 // current buffer is going to be switched-off, save cursor pos
171 // Ideally, the whole cursor stack should be saved, but session
172 // currently can only handle bottom (whole document) level pit and pos.
173 // That is to say, if a cursor is in a nested inset, it will be
174 // restore to the left of the top level inset.
175 LyX::ref().session().lastFilePos().save(FileName(buffer_->fileName()),
176 boost::tie(cursor_.bottom().pit(), cursor_.bottom().pos()) );
179 // If we're quitting lyx, don't bother updating stuff
185 // If we are closing current buffer, switch to the first in
188 LYXERR(Debug::INFO) << BOOST_CURRENT_FUNCTION
189 << " No Buffer!" << endl;
190 // We are closing the buffer, use the first buffer as current
191 buffer_ = theBufferList().first();
193 // Set current buffer
198 cursor_ = LCursor(*this);
203 LYXERR(Debug::INFO) << BOOST_CURRENT_FUNCTION
204 << "Buffer addr: " << buffer_ << endl;
205 cursor_.push(buffer_->inset());
206 cursor_.resetAnchor();
207 buffer_->text().setCurrentFont(cursor_);
208 if (buffer_->getCursor().size() > 0 &&
209 buffer_->getAnchor().size() > 0)
211 cursor_.setCursor(buffer_->getAnchor().asDocIterator(&(buffer_->inset())));
212 cursor_.resetAnchor();
213 cursor_.setCursor(buffer_->getCursor().asDocIterator(&(buffer_->inset())));
214 cursor_.setSelection();
215 // do not set selection to the new buffer because we
216 // only paste recent selection.
221 updateMetrics(false);
223 if (buffer_ && graphics::Previews::status() != LyXRC::PREVIEW_OFF)
224 graphics::Previews::get().generateBufferPreviews(*buffer_);
228 bool BufferView::loadLyXFile(FileName const & filename, bool tolastfiles)
230 // File already open?
231 if (theBufferList().exists(filename.absFilename())) {
232 docstring const file = makeDisplayPath(filename.absFilename(), 20);
233 docstring text = bformat(_("The document %1$s is already "
234 "loaded.\n\nDo you want to revert "
235 "to the saved version?"), file);
236 int const ret = Alert::prompt(_("Revert to saved document?"),
237 text, 0, 1, _("&Revert"), _("&Switch to document"));
240 setBuffer(theBufferList().getBuffer(filename.absFilename()));
243 // FIXME: should be LFUN_REVERT
244 if (!theBufferList().close(theBufferList().getBuffer(filename.absFilename()), false))
246 // Fall through to new load. (Asger)
252 if (isFileReadable(filename)) {
253 b = theBufferList().newBuffer(filename.absFilename());
254 if (!lyx::loadLyXFile(b, filename)) {
255 theBufferList().release(b);
259 docstring text = bformat(_("The document %1$s does not yet "
260 "exist.\n\nDo you want to create "
261 "a new document?"), from_utf8(filename.absFilename()));
262 int const ret = Alert::prompt(_("Create new document?"),
263 text, 0, 1, _("&Create"), _("Cancel"));
266 b = newFile(filename.absFilename(), string(), true);
274 // Send the "errors" signal in case of parsing errors
277 // Update the labels and section numbering.
278 updateLabels(*buffer_);
279 // scroll to the position when the file was last closed
280 if (lyxrc.use_lastfilepos) {
283 boost::tie(pit, pos) = LyX::ref().session().lastFilePos().load(filename);
284 // if successfully move to pit (returned par_id is not zero), update metrics and reset font
285 if (moveToPosition(pit, 0, pos).get<1>()) {
287 updateMetrics(false);
288 buffer_->text().setCurrentFont(cursor_);
293 LyX::ref().session().lastFiles().add(FileName(b->fileName()));
299 void BufferView::resize()
304 LYXERR(Debug::DEBUG) << BOOST_CURRENT_FUNCTION << endl;
306 updateMetrics(false);
311 bool BufferView::fitCursor()
313 if (bv_funcs::status(this, cursor_) == bv_funcs::CUR_INSIDE) {
314 frontend::FontMetrics const & fm =
315 theFontMetrics(cursor_.getFont());
316 int const asc = fm.maxAscent();
317 int const des = fm.maxDescent();
318 Point const p = bv_funcs::getPos(*this, cursor_, cursor_.boundary());
319 if (p.y_ - asc >= 0 && p.y_ + des < height_)
327 bool BufferView::multiParSel()
329 if (!cursor_.selection())
331 bool ret = multiparsel_cache_;
332 multiparsel_cache_ = cursor_.selBegin().pit() != cursor_.selEnd().pit();
333 // Either this, or previous selection spans paragraphs
334 return ret || multiparsel_cache_;
338 bool BufferView::update(Update::flags flags)
340 // last_inset_ points to the last visited inset. This pointer may become
341 // invalid because of keyboard editing. Since all such operations
342 // causes screen update(), I reset last_inset_ to avoid such a problem.
344 // This is close to a hot-path.
346 << BOOST_CURRENT_FUNCTION
347 << "[fitcursor = " << (flags & Update::FitCursor)
348 << ", forceupdate = " << (flags & Update::Force)
349 << ", singlepar = " << (flags & Update::SinglePar)
350 << "] buffer: " << buffer_ << endl;
352 // Check needed to survive LyX startup
356 LYXERR(Debug::WORKAREA) << "BufferView::update" << std::endl;
358 // Update macro store
359 buffer_->buildMacros();
361 // Now do the first drawing step if needed. This consists on updating
362 // the CoordCache in updateMetrics().
363 // The second drawing step is done in WorkArea::redraw() if needed.
365 // Case when no explicit update is requested.
367 // no need to redraw anything.
368 metrics_info_.update_strategy = NoScreenUpdate;
372 if (flags == Update::Decoration) {
373 metrics_info_.update_strategy = DecorationUpdate;
377 if (flags == Update::FitCursor
378 || flags == (Update::Decoration | Update::FitCursor)) {
379 bool const fit_cursor = fitCursor();
380 // tell the frontend to update the screen if needed.
382 updateMetrics(false);
385 if (flags & Update::Decoration) {
386 metrics_info_.update_strategy = DecorationUpdate;
389 // no screen update is needed.
390 metrics_info_.update_strategy = NoScreenUpdate;
394 bool full_metrics = flags & Update::Force;
395 if (flags & Update::MultiParSel)
396 full_metrics |= multiParSel();
398 bool const single_par = !full_metrics;
399 updateMetrics(single_par);
401 if (flags & Update::FitCursor && fitCursor())
402 updateMetrics(false);
404 // tell the frontend to update the screen.
409 void BufferView::updateScrollbar()
412 LYXERR(Debug::DEBUG) << BOOST_CURRENT_FUNCTION
413 << " no text in updateScrollbar" << endl;
414 scrollbarParameters_.reset();
418 LyXText & t = buffer_->text();
419 TextMetrics & tm = text_metrics_[&t];
421 int const parsize = int(t.paragraphs().size() - 1);
422 if (anchor_ref_ > parsize) {
423 anchor_ref_ = parsize;
428 << BOOST_CURRENT_FUNCTION
429 << " Updating scrollbar: height: " << t.paragraphs().size()
430 << " curr par: " << cursor_.bottom().pit()
431 << " default height " << defaultRowHeight() << endl;
433 // It would be better to fix the scrollbar to understand
434 // values in [0..1] and divide everything by wh
436 // estimated average paragraph height:
440 int h = tm.parMetrics(anchor_ref_).height();
442 // Normalize anchor/offset (MV):
443 while (offset_ref_ > h && anchor_ref_ < parsize) {
446 h = tm.parMetrics(anchor_ref_).height();
448 // Look at paragraph heights on-screen
451 for (pit_type pit = anchor_ref_; pit <= parsize; ++pit) {
454 int const h2 = tm.parMetrics(pit).height();
460 int const hav = sumh / nh;
461 // More realistic average paragraph height
466 scrollbarParameters_.height = (parsize + 1) * wh_;
467 scrollbarParameters_.position = anchor_ref_ * wh_ + int(offset_ref_ * wh_ / float(h));
468 scrollbarParameters_.lineScrollHeight = int(wh_ * defaultRowHeight() / float(h));
472 ScrollbarParameters const & BufferView::scrollbarParameters() const
474 return scrollbarParameters_;
478 void BufferView::scrollDocView(int value)
480 LYXERR(Debug::GUI) << BOOST_CURRENT_FUNCTION
481 << "[ value = " << value << "]" << endl;
486 LyXText & t = buffer_->text();
487 TextMetrics & tm = text_metrics_[&t];
489 float const bar = value / float(wh_ * t.paragraphs().size());
491 anchor_ref_ = int(bar * t.paragraphs().size());
492 if (anchor_ref_ > int(t.paragraphs().size()) - 1)
493 anchor_ref_ = int(t.paragraphs().size()) - 1;
495 tm.redoParagraph(anchor_ref_);
496 int const h = tm.parMetrics(anchor_ref_).height();
497 offset_ref_ = int((bar * t.paragraphs().size() - anchor_ref_) * h);
498 updateMetrics(false);
502 void BufferView::setCursorFromScrollbar()
507 LyXText & t = buffer_->text();
509 int const height = 2 * defaultRowHeight();
510 int const first = height;
511 int const last = height_ - height;
512 LCursor & cur = cursor_;
514 bv_funcs::CurStatus st = bv_funcs::status(this, cur);
517 case bv_funcs::CUR_ABOVE:
518 // We reset the cursor because bv_funcs::status() does not
519 // work when the cursor is within mathed.
520 cur.reset(buffer_->inset());
521 t.setCursorFromCoordinates(cur, 0, first);
522 cur.clearSelection();
524 case bv_funcs::CUR_BELOW:
525 // We reset the cursor because bv_funcs::status() does not
526 // work when the cursor is within mathed.
527 cur.reset(buffer_->inset());
528 t.setCursorFromCoordinates(cur, 0, last);
529 cur.clearSelection();
531 case bv_funcs::CUR_INSIDE:
532 int const y = bv_funcs::getPos(*this, cur, cur.boundary()).y_;
533 int const newy = min(last, max(y, first));
535 cur.reset(buffer_->inset());
536 t.setCursorFromCoordinates(cur, 0, newy);
542 Change const BufferView::getCurrentChange() const
544 if (!cursor_.selection())
545 return Change(Change::UNCHANGED);
547 DocIterator dit = cursor_.selectionBegin();
548 return dit.paragraph().lookupChange(dit.pos());
552 void BufferView::saveBookmark(unsigned int idx)
554 LyX::ref().session().bookmarks().save(
555 FileName(buffer_->fileName()),
557 cursor_.paragraph().id(),
562 // emit message signal.
563 message(_("Save bookmark"));
567 boost::tuple<pit_type, int> BufferView::moveToPosition(pit_type par_pit, int par_id, pos_type par_pos)
569 cursor_.clearSelection();
571 // if a valid par_id is given, try it first
573 ParIterator par = buffer_->getParFromID(par_id);
574 if (par != buffer_->par_iterator_end()) {
575 setCursor(makeDocIterator(par, min(par->size(), par_pos)));
576 return boost::make_tuple(cursor_.pit(), par_id);
579 // if par_id == 0, or searching through par_id failed
580 if (static_cast<size_t>(par_pit) < buffer_->paragraphs().size()) {
581 ParIterator it = buffer_->par_iterator_begin();
582 ParIterator const end = buffer_->par_iterator_end();
583 for (; it != end; ++it)
584 if (it.pit() == par_pit) {
585 // restored pos may be bigger than it->size
586 setCursor(makeDocIterator(it, min(par_pos, it->size())));
587 return boost::make_tuple(par_pit, it->id());
591 return boost::make_tuple(pit_type(0), 0);
595 void BufferView::switchKeyMap()
597 if (!lyxrc.rtl_support)
600 if (cursor_.innerText()->real_current_font.isRightToLeft()) {
601 if (intl_->keymap == Intl::PRIMARY)
604 if (intl_->keymap == Intl::SECONDARY)
610 int BufferView::workWidth() const
616 void BufferView::center()
618 CursorSlice & bot = cursor_.bottom();
619 TextMetrics & tm = text_metrics_[bot.text()];
620 pit_type const pit = bot.pit();
621 tm.redoParagraph(pit);
622 ParagraphMetrics const & pm = tm.parMetrics(pit);
624 offset_ref_ = bv_funcs::coordOffset(*this, cursor_, cursor_.boundary()).y_
625 + pm.ascent() - height_ / 2;
629 FuncStatus BufferView::getStatus(FuncRequest const & cmd)
633 switch (cmd.action) {
636 flag.enabled(!buffer_->undostack().empty());
639 flag.enabled(!buffer_->redostack().empty());
641 case LFUN_FILE_INSERT:
642 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
643 case LFUN_FILE_INSERT_PLAINTEXT:
644 case LFUN_BOOKMARK_SAVE:
645 // FIXME: Actually, these LFUNS should be moved to LyXText
646 flag.enabled(cursor_.inTexted());
648 case LFUN_FONT_STATE:
649 case LFUN_LABEL_INSERT:
650 case LFUN_PARAGRAPH_GOTO:
651 // FIXME handle non-trivially
652 case LFUN_OUTLINE_UP:
653 case LFUN_OUTLINE_DOWN:
654 case LFUN_OUTLINE_IN:
655 case LFUN_OUTLINE_OUT:
657 case LFUN_REFERENCE_NEXT:
659 case LFUN_WORD_REPLACE:
662 case LFUN_MARK_TOGGLE:
663 case LFUN_SCREEN_RECENTER:
664 case LFUN_BIBTEX_DATABASE_ADD:
665 case LFUN_BIBTEX_DATABASE_DEL:
666 case LFUN_WORDS_COUNT:
667 case LFUN_NEXT_INSET_TOGGLE:
671 case LFUN_LABEL_GOTO: {
672 flag.enabled(!cmd.argument().empty()
673 || getInsetByCode<InsetRef>(cursor_, InsetBase::REF_CODE));
677 case LFUN_CHANGES_TRACK:
679 flag.setOnOff(buffer_->params().trackChanges);
682 case LFUN_CHANGES_OUTPUT:
683 flag.enabled(buffer_ && LaTeXFeatures::isAvailable("dvipost"));
684 flag.setOnOff(buffer_->params().outputChanges);
687 case LFUN_CHANGES_MERGE:
688 case LFUN_CHANGE_NEXT:
689 case LFUN_ALL_CHANGES_ACCEPT:
690 case LFUN_ALL_CHANGES_REJECT:
691 // TODO: context-sensitive enabling of LFUNs
692 // In principle, these command should only be enabled if there
693 // is a change in the document. However, without proper
694 // optimizations, this will inevitably result in poor performance.
695 flag.enabled(buffer_);
698 case LFUN_BUFFER_TOGGLE_COMPRESSION: {
699 flag.setOnOff(buffer_->params().compressed);
711 Update::flags BufferView::dispatch(FuncRequest const & cmd)
713 //lyxerr << BOOST_CURRENT_FUNCTION
714 // << [ cmd = " << cmd << "]" << endl;
716 // Make sure that the cached BufferView is correct.
717 LYXERR(Debug::ACTION) << BOOST_CURRENT_FUNCTION
718 << " action[" << cmd.action << ']'
719 << " arg[" << to_utf8(cmd.argument()) << ']'
720 << " x[" << cmd.x << ']'
721 << " y[" << cmd.y << ']'
722 << " button[" << cmd.button() << ']'
725 // FIXME: this should not be possible.
729 LCursor & cur = cursor_;
730 // Default Update flags.
731 Update::flags updateFlags = Update::Force | Update::FitCursor;
733 switch (cmd.action) {
736 cur.message(_("Undo"));
737 cur.clearSelection();
738 if (!textUndo(*this)) {
739 cur.message(_("No further undo information"));
740 updateFlags = Update::None;
746 cur.message(_("Redo"));
747 cur.clearSelection();
748 if (!textRedo(*this)) {
749 cur.message(_("No further redo information"));
750 updateFlags = Update::None;
755 case LFUN_FILE_INSERT:
757 menuInsertLyXFile(to_utf8(cmd.argument()));
760 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
762 insertPlaintextFile(this, to_utf8(cmd.argument()), true);
765 case LFUN_FILE_INSERT_PLAINTEXT:
767 insertPlaintextFile(this, to_utf8(cmd.argument()), false);
770 case LFUN_FONT_STATE:
771 cur.message(cur.currentState());
774 case LFUN_BOOKMARK_SAVE:
775 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
778 case LFUN_LABEL_GOTO: {
779 docstring label = cmd.argument();
782 getInsetByCode<InsetRef>(cursor_,
783 InsetBase::REF_CODE);
785 label = inset->getParam("reference");
786 // persistent=false: use temp_bookmark
796 case LFUN_PARAGRAPH_GOTO: {
797 int const id = convert<int>(to_utf8(cmd.argument()));
799 for (Buffer * b = buffer_; i == 0 || b != buffer_; b = theBufferList().next(b)) {
800 ParIterator par = b->getParFromID(id);
801 if (par == b->par_iterator_end()) {
803 << "No matching paragraph found! ["
804 << id << "]." << endl;
807 << "Paragraph " << par->id()
808 << " found in buffer `"
809 << b->fileName() << "'." << endl;
813 setCursor(makeDocIterator(par, 0));
816 // Switch to other buffer view and resend cmd
817 theLyXFunc().dispatch(FuncRequest(
818 LFUN_BUFFER_SWITCH, b->fileName()));
819 theLyXFunc().dispatch(cmd);
820 updateFlags = Update::None;
829 case LFUN_OUTLINE_UP:
830 toc::outline(toc::Up, cursor_);
831 cursor_.text()->setCursor(cursor_, cursor_.pit(), 0);
832 updateLabels(*buffer_);
834 case LFUN_OUTLINE_DOWN:
835 toc::outline(toc::Down, cursor_);
836 cursor_.text()->setCursor(cursor_, cursor_.pit(), 0);
837 updateLabels(*buffer_);
839 case LFUN_OUTLINE_IN:
840 toc::outline(toc::In, cursor_);
841 updateLabels(*buffer_);
843 case LFUN_OUTLINE_OUT:
844 toc::outline(toc::Out, cursor_);
845 updateLabels(*buffer_);
849 bv_funcs::gotoInset(this, InsetBase::NOTE_CODE, false);
852 case LFUN_REFERENCE_NEXT: {
853 vector<InsetBase_code> tmp;
854 tmp.push_back(InsetBase::LABEL_CODE);
855 tmp.push_back(InsetBase::REF_CODE);
856 bv_funcs::gotoInset(this, tmp, true);
860 case LFUN_CHANGES_TRACK:
861 buffer_->params().trackChanges = !buffer_->params().trackChanges;
864 case LFUN_CHANGES_OUTPUT:
865 buffer_->params().outputChanges = !buffer_->params().outputChanges;
868 case LFUN_CHANGE_NEXT:
869 findNextChange(this);
872 case LFUN_CHANGES_MERGE:
873 if (findNextChange(this))
874 showDialog("changes");
877 case LFUN_ALL_CHANGES_ACCEPT:
878 // select complete document
879 cursor_.reset(buffer_->inset());
880 cursor_.selHandle(true);
881 buffer_->text().cursorBottom(cursor_);
882 // accept everything in a single step to support atomic undo
883 buffer_->text().acceptOrRejectChanges(cursor_, LyXText::ACCEPT);
886 case LFUN_ALL_CHANGES_REJECT:
887 // select complete document
888 cursor_.reset(buffer_->inset());
889 cursor_.selHandle(true);
890 buffer_->text().cursorBottom(cursor_);
891 // reject everything in a single step to support atomic undo
892 // Note: reject does not work recursively; the user may have to repeat the operation
893 buffer_->text().acceptOrRejectChanges(cursor_, LyXText::REJECT);
900 case LFUN_WORD_REPLACE:
905 cur.clearSelection();
907 cur.message(from_utf8(N_("Mark off")));
911 cur.clearSelection();
914 cur.message(from_utf8(N_("Mark on")));
917 case LFUN_MARK_TOGGLE:
918 cur.clearSelection();
921 cur.message(from_utf8(N_("Mark removed")));
924 cur.message(from_utf8(N_("Mark set")));
929 case LFUN_SCREEN_RECENTER:
933 case LFUN_BIBTEX_DATABASE_ADD: {
934 LCursor tmpcur = cursor_;
935 bv_funcs::findInset(tmpcur, InsetBase::BIBTEX_CODE, false);
936 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
937 InsetBase::BIBTEX_CODE);
939 if (inset->addDatabase(to_utf8(cmd.argument())))
940 buffer_->updateBibfilesCache();
945 case LFUN_BIBTEX_DATABASE_DEL: {
946 LCursor tmpcur = cursor_;
947 bv_funcs::findInset(tmpcur, InsetBase::BIBTEX_CODE, false);
948 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
949 InsetBase::BIBTEX_CODE);
951 if (inset->delDatabase(to_utf8(cmd.argument())))
952 buffer_->updateBibfilesCache();
957 case LFUN_WORDS_COUNT: {
958 DocIterator from, to;
959 if (cur.selection()) {
960 from = cur.selectionBegin();
961 to = cur.selectionEnd();
963 from = doc_iterator_begin(buffer_->inset());
964 to = doc_iterator_end(buffer_->inset());
966 int const count = countWords(from, to);
970 message = bformat(_("%1$d words in selection."),
973 message = bformat(_("%1$d words in document."),
978 message = _("One word in selection.");
980 message = _("One word in document.");
983 Alert::information(_("Count words"), message);
987 case LFUN_BUFFER_TOGGLE_COMPRESSION:
988 // turn compression on/off
989 buffer_->params().compressed = !buffer_->params().compressed;
992 case LFUN_NEXT_INSET_TOGGLE: {
993 // this is the real function we want to invoke
994 FuncRequest tmpcmd = FuncRequest(LFUN_INSET_TOGGLE, cmd.origin);
995 // if there is an inset at cursor, see whether it
997 InsetBase * inset = cur.nextInset();
998 if (inset && inset->isActive()) {
999 LCursor tmpcur = cur;
1000 tmpcur.pushLeft(*inset);
1001 inset->dispatch(tmpcur, tmpcmd);
1002 if (tmpcur.result().dispatched()) {
1006 // if it did not work, try the underlying inset.
1007 if (!cur.result().dispatched())
1008 cur.dispatch(tmpcmd);
1010 if (cur.result().dispatched())
1011 cur.clearSelection();
1017 updateFlags = Update::None;
1024 docstring const BufferView::requestSelection()
1029 LCursor & cur = cursor_;
1031 if (!cur.selection()) {
1032 xsel_cache_.set = false;
1036 if (!xsel_cache_.set ||
1037 cur.top() != xsel_cache_.cursor ||
1038 cur.anchor_.top() != xsel_cache_.anchor)
1040 xsel_cache_.cursor = cur.top();
1041 xsel_cache_.anchor = cur.anchor_.top();
1042 xsel_cache_.set = cur.selection();
1043 return cur.selectionAsString(false);
1049 void BufferView::clearSelection()
1052 cursor_.clearSelection();
1053 // Clear the selection buffer. Otherwise a subsequent
1054 // middle-mouse-button paste would use the selection buffer,
1055 // not the more current external selection.
1056 cap::clearSelection();
1057 xsel_cache_.set = false;
1058 // The buffer did not really change, but this causes the
1059 // redraw we need because we cleared the selection above.
1065 void BufferView::workAreaResize(int width, int height)
1067 // Update from work area
1071 // The complete text metrics will be redone.
1072 text_metrics_.clear();
1079 InsetBase const * BufferView::getCoveringInset(LyXText const & text, int x, int y)
1081 pit_type pit = text.getPitNearY(*this, y);
1082 BOOST_ASSERT(pit != -1);
1083 Paragraph const & par = text.getPar(pit);
1085 LYXERR(Debug::DEBUG)
1086 << BOOST_CURRENT_FUNCTION
1091 InsetList::const_iterator iit = par.insetlist.begin();
1092 InsetList::const_iterator iend = par.insetlist.end();
1093 for (; iit != iend; ++iit) {
1094 InsetBase * const inset = iit->inset;
1095 if (inset->covers(*this, x, y)) {
1096 if (!inset->descendable())
1097 // No need to go further down if the inset is not
1101 size_t cell_number = inset->nargs();
1102 // Check all the inner cell.
1103 for (size_t i = 0; i != cell_number; ++i) {
1104 LyXText const * inner_text = inset->getText(i);
1107 InsetBase const * inset_deeper =
1108 getCoveringInset(*inner_text, x, y);
1110 return inset_deeper;
1114 LYXERR(Debug::DEBUG)
1115 << BOOST_CURRENT_FUNCTION
1116 << ": Hit inset: " << inset << endl;
1120 LYXERR(Debug::DEBUG)
1121 << BOOST_CURRENT_FUNCTION
1122 << ": No inset hit. " << endl;
1127 bool BufferView::workAreaDispatch(FuncRequest const & cmd0)
1129 //lyxerr << BOOST_CURRENT_FUNCTION << "[ cmd0 " << cmd0 << "]" << endl;
1131 // This is only called for mouse related events including
1132 // LFUN_FILE_OPEN generated by drag-and-drop.
1133 FuncRequest cmd = cmd0;
1135 // E.g. Qt mouse press when no buffer
1140 cur.push(buffer_->inset());
1141 cur.selection() = cursor_.selection();
1143 // Either the inset under the cursor or the
1144 // surrounding LyXText will handle this event.
1146 // make sure we stay within the screen...
1147 cmd.y = min(max(cmd.y, -1), height_);
1149 if (cmd.action == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
1151 // Get inset under mouse, if there is one.
1152 InsetBase const * covering_inset =
1153 getCoveringInset(buffer_->text(), cmd.x, cmd.y);
1154 if (covering_inset == last_inset_)
1155 // Same inset, no need to do anything...
1158 bool need_redraw = false;
1159 // const_cast because of setMouseHover().
1160 InsetBase * inset = const_cast<InsetBase *>(covering_inset);
1162 // Remove the hint on the last hovered inset (if any).
1163 need_redraw |= last_inset_->setMouseHover(false);
1165 // Highlighted the newly hovered inset (if any).
1166 need_redraw |= inset->setMouseHover(true);
1167 last_inset_ = inset;
1169 // if last metrics update was in singlepar mode, WorkArea::redraw() will
1170 // not expose the button for redraw. We adjust here the metrics dimension
1171 // to enable a full redraw.
1172 // FIXME: It is possible to redraw only the area around the button!
1174 && metrics_info_.update_strategy == SingleParUpdate) {
1175 // FIXME: It should be possible to redraw only the area around
1176 // the button by doing this:
1178 //metrics_info_.singlepar = false;
1179 //metrics_info_.y1 = ymin of button;
1180 //metrics_info_.y2 = ymax of button;
1182 // Unfortunately, rowpainter.C:paintText() does not distinguish
1183 // between background updates and text updates. So we use the hammer
1184 // solution for now. We could also avoid the updateMetrics() below
1185 // by using the first and last pit of the CoordCache. Have a look
1186 // at LyXText::getPitNearY() to see what I mean.
1188 //metrics_info_.pit1 = first pit of CoordCache;
1189 //metrics_info_.pit2 = last pit of CoordCache;
1190 //metrics_info_.singlepar = false;
1191 //metrics_info_.y1 = 0;
1192 //metrics_info_.y2 = height_;
1194 updateMetrics(false);
1197 // This event (moving without mouse click) is not passed further.
1198 // This should be changed if it is further utilized.
1202 // Build temporary cursor.
1203 InsetBase * inset = buffer_->text().editXY(cur, cmd.x, cmd.y);
1205 // Put anchor at the same position.
1208 // Try to dispatch to an non-editable inset near this position
1209 // via the temp cursor. If the inset wishes to change the real
1210 // cursor it has to do so explicitly by using
1211 // cur.bv().cursor() = cur; (or similar)
1213 inset->dispatch(cur, cmd);
1216 // Now dispatch to the temporary cursor. If the real cursor should
1217 // be modified, the inset's dispatch has to do so explicitly.
1218 if (!cur.result().dispatched())
1221 // Redraw if requested and necessary.
1222 if (cur.result().dispatched() && cur.result().update())
1223 return update(cur.result().update());
1229 void BufferView::scroll(int /*lines*/)
1234 // LyXText const * t = &buffer_->text();
1235 // int const line_height = defaultRowHeight();
1237 // // The new absolute coordinate
1238 // int new_top_y = top_y() + lines * line_height;
1240 // // Restrict to a valid value
1241 // new_top_y = std::min(t->height() - 4 * line_height, new_top_y);
1242 // new_top_y = std::max(0, new_top_y);
1244 // scrollDocView(new_top_y);
1249 void BufferView::setCursorFromRow(int row)
1254 buffer_->texrow().getIdFromRow(row, tmpid, tmppos);
1257 buffer_->text().setCursor(cursor_, 0, 0);
1259 buffer_->text().setCursor(cursor_, buffer_->getParFromID(tmpid).pit(), tmppos);
1263 void BufferView::gotoLabel(docstring const & label)
1265 for (InsetIterator it = inset_iterator_begin(buffer_->inset()); it; ++it) {
1266 vector<docstring> labels;
1267 it->getLabelList(*buffer_, labels);
1268 if (std::find(labels.begin(), labels.end(), label) != labels.end()) {
1277 TextMetrics const & BufferView::textMetrics(LyXText const * t) const
1279 return const_cast<BufferView *>(this)->textMetrics(t);
1283 TextMetrics & BufferView::textMetrics(LyXText const * t)
1285 TextMetricsCache::iterator tmc_it = text_metrics_.find(t);
1286 if (tmc_it == text_metrics_.end()) {
1287 tmc_it = text_metrics_.insert(
1288 make_pair(t, TextMetrics(this, const_cast<LyXText *>(t)))).first;
1290 return tmc_it->second;
1294 ParagraphMetrics const & BufferView::parMetrics(LyXText const * t,
1297 return textMetrics(t).parMetrics(pit);
1301 int BufferView::workHeight() const
1307 void BufferView::setCursor(DocIterator const & dit)
1309 size_t const n = dit.depth();
1310 for (size_t i = 0; i < n; ++i)
1311 dit[i].inset().edit(cursor_, true);
1313 cursor_.setCursor(dit);
1314 cursor_.selection() = false;
1318 bool BufferView::checkDepm(LCursor & cur, LCursor & old)
1320 // Would be wrong to delete anything if we have a selection.
1321 if (cur.selection())
1324 bool need_anchor_change = false;
1325 bool changed = cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
1326 need_anchor_change);
1328 if (need_anchor_change)
1334 updateLabels(*buffer_);
1336 updateMetrics(false);
1342 bool BufferView::mouseSetCursor(LCursor & cur)
1344 BOOST_ASSERT(&cur.bv() == this);
1346 // Has the cursor just left the inset?
1347 bool badcursor = false;
1348 bool leftinset = (&cursor_.inset() != &cur.inset());
1350 badcursor = cursor_.inset().notifyCursorLeaves(cursor_);
1352 // do the dEPM magic if needed
1353 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
1354 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
1355 // the leftinset bool would not be necessary (badcursor instead).
1356 bool update = leftinset;
1357 if (!badcursor && cursor_.inTexted())
1358 update |= checkDepm(cur, cursor_);
1360 // if the cursor was in an empty script inset and the new
1361 // position is in the nucleus of the inset, notifyCursorLeaves
1362 // will kill the script inset itself. So we check all the
1363 // elements of the cursor to make sure that they are correct.
1364 // For an example, see bug 2933:
1365 // http://bugzilla.lyx.org/show_bug.cgi?id=2933
1366 // The code below could maybe be moved to a DocIterator method.
1367 //lyxerr << "cur before " << cur <<std::endl;
1368 DocIterator dit(cur.inset());
1369 dit.push_back(cur.bottom());
1371 while (i < cur.depth() && dit.nextInset() == &cur[i].inset()) {
1372 dit.push_back(cur[i]);
1375 //lyxerr << "5 cur after" << dit <<std::endl;
1377 cursor_.setCursor(dit);
1378 cursor_.clearSelection();
1384 void BufferView::putSelectionAt(DocIterator const & cur,
1385 int length, bool backwards)
1387 cursor_.clearSelection();
1393 cursor_.pos() += length;
1394 cursor_.setSelection(cursor_, -length);
1396 cursor_.setSelection(cursor_, length);
1397 cap::saveSelection(cursor_);
1402 LCursor & BufferView::cursor()
1408 LCursor const & BufferView::cursor() const
1414 pit_type BufferView::anchor_ref() const
1420 ViewMetricsInfo const & BufferView::viewMetricsInfo()
1422 return metrics_info_;
1426 // FIXME: We should split-up updateMetrics() for the singlepar case.
1427 void BufferView::updateMetrics(bool singlepar)
1429 LyXText & buftext = buffer_->text();
1430 TextMetrics & tm = textMetrics(&buftext);
1431 pit_type size = int(buftext.paragraphs().size());
1433 if (anchor_ref_ > int(buftext.paragraphs().size() - 1)) {
1434 anchor_ref_ = int(buftext.paragraphs().size() - 1);
1438 // If the paragraph metrics has changed, we can not
1439 // use the singlepar optimisation.
1441 // In Single Paragraph mode, rebreak only
1442 // the (main text, not inset!) paragraph containing the cursor.
1443 // (if this paragraph contains insets etc., rebreaking will
1444 // recursively descend)
1445 && tm.redoParagraph(cursor_.bottom().pit()))
1448 pit_type const pit = anchor_ref_;
1451 size_t const npit = buftext.paragraphs().size();
1453 // Rebreak anchor paragraph.
1455 tm.redoParagraph(pit);
1457 // Clear out the position cache in case of full screen redraw.
1459 coord_cache_.clear();
1461 int y0 = tm.parMetrics(pit).ascent() - offset_ref_;
1463 // Redo paragraphs above anchor if necessary.
1465 while (y1 > 0 && pit1 > 0) {
1466 y1 -= tm.parMetrics(pit1).ascent();
1469 tm.redoParagraph(pit1);
1470 y1 -= tm.parMetrics(pit1).descent();
1474 // Take care of ascent of first line
1475 y1 -= tm.parMetrics(pit1).ascent();
1477 // Normalize anchor for next time
1481 // Grey at the beginning is ugly
1482 if (pit1 == 0 && y1 > 0) {
1488 // Redo paragraphs below the anchor if necessary.
1490 while (y2 < height_ && pit2 < int(npit) - 1) {
1491 y2 += tm.parMetrics(pit2).descent();
1494 tm.redoParagraph(pit2);
1495 y2 += tm.parMetrics(pit2).ascent();
1498 // Take care of descent of last line
1499 y2 += tm.parMetrics(pit2).descent();
1501 // The coordinates of all these paragraphs are correct, cache them
1503 CoordCache::InnerParPosCache & parPos = coord_cache_.parPos()[&buftext];
1504 for (pit_type pit = pit1; pit <= pit2; ++pit) {
1505 ParagraphMetrics const & pm = tm.parMetrics(pit);
1507 parPos[pit] = Point(0, y);
1508 if (singlepar && pit == cursor_.bottom().pit()) {
1509 // In Single Paragraph mode, collect here the
1510 // y1 and y2 of the (one) paragraph the cursor is in
1511 y1 = y - pm.ascent();
1512 y2 = y + pm.descent();
1518 // collect cursor paragraph iter bounds
1519 pit1 = cursor_.bottom().pit();
1520 pit2 = cursor_.bottom().pit();
1523 LYXERR(Debug::DEBUG)
1524 << BOOST_CURRENT_FUNCTION
1527 << " pit1: " << pit1
1528 << " pit2: " << pit2
1529 << " npit: " << npit
1530 << " singlepar: " << singlepar
1534 metrics_info_ = ViewMetricsInfo(pit1, pit2, y1, y2,
1535 singlepar? SingleParUpdate: FullScreenUpdate, size);
1537 if (lyxerr.debugging(Debug::WORKAREA)) {
1538 LYXERR(Debug::WORKAREA) << "BufferView::updateMetrics" << endl;
1539 coord_cache_.dump();
1544 void BufferView::menuInsertLyXFile(string const & filenm)
1546 BOOST_ASSERT(cursor_.inTexted());
1547 string filename = filenm;
1549 if (filename.empty()) {
1550 // Launch a file browser
1552 string initpath = lyxrc.document_path;
1555 string const trypath = buffer_->filePath();
1556 // If directory is writeable, use this as default.
1557 if (isDirWriteable(FileName(trypath)))
1562 FileDialog fileDlg(_("Select LyX document to insert"),
1564 make_pair(_("Documents|#o#O"), from_utf8(lyxrc.document_path)),
1565 make_pair(_("Examples|#E#e"), from_utf8(addPath(package().system_support().absFilename(), "examples"))));
1567 FileDialog::Result result =
1568 fileDlg.open(from_utf8(initpath),
1569 FileFilterList(_("LyX Documents (*.lyx)")),
1572 if (result.first == FileDialog::Later)
1576 filename = to_utf8(result.second);
1578 // check selected filename
1579 if (filename.empty()) {
1580 // emit message signal.
1581 message(_("Canceled."));
1586 // Get absolute path of file and add ".lyx"
1587 // to the filename if necessary
1588 filename = fileSearch(string(), filename, "lyx").absFilename();
1590 docstring const disp_fn = makeDisplayPath(filename);
1591 // emit message signal.
1592 message(bformat(_("Inserting document %1$s..."), disp_fn));
1595 Buffer buf("", false);
1596 if (lyx::loadLyXFile(&buf, FileName(filename))) {
1597 ErrorList & el = buffer_->errorList("Parse");
1598 // Copy the inserted document error list into the current buffer one.
1599 el = buf.errorList("Parse");
1600 recordUndo(cursor_);
1601 cap::pasteParagraphList(cursor_, buf.paragraphs(),
1602 buf.params().textclass, el);
1603 res = _("Document %1$s inserted.");
1605 res = _("Could not insert document %1$s");
1607 // emit message signal.
1608 message(bformat(res, disp_fn));
1609 buffer_->errors("Parse");