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 LyX::ref().session().lastFilePos().save(FileName(buffer_->fileName()),
172 boost::tie(cursor_.pit(), cursor_.pos()) );
175 // If we're quitting lyx, don't bother updating stuff
181 // If we are closing current buffer, switch to the first in
184 lyxerr[Debug::INFO] << BOOST_CURRENT_FUNCTION
185 << " No Buffer!" << endl;
186 // We are closing the buffer, use the first buffer as current
187 buffer_ = theBufferList().first();
189 // Set current buffer
194 cursor_ = LCursor(*this);
199 lyxerr[Debug::INFO] << BOOST_CURRENT_FUNCTION
200 << "Buffer addr: " << buffer_ << endl;
201 cursor_.push(buffer_->inset());
202 cursor_.resetAnchor();
203 buffer_->text().setCurrentFont(cursor_);
204 if (buffer_->getCursor().size() > 0 &&
205 buffer_->getAnchor().size() > 0)
207 cursor_.setCursor(buffer_->getAnchor().asDocIterator(&(buffer_->inset())));
208 cursor_.resetAnchor();
209 cursor_.setCursor(buffer_->getCursor().asDocIterator(&(buffer_->inset())));
210 cursor_.setSelection();
211 // do not set selection to the new buffer because we
212 // only paste recent selection.
217 updateMetrics(false);
219 if (buffer_ && graphics::Previews::status() != LyXRC::PREVIEW_OFF)
220 graphics::Previews::get().generateBufferPreviews(*buffer_);
224 bool BufferView::loadLyXFile(FileName const & filename, bool tolastfiles)
226 // File already open?
227 if (theBufferList().exists(filename.absFilename())) {
228 docstring const file = makeDisplayPath(filename.absFilename(), 20);
229 docstring text = bformat(_("The document %1$s is already "
230 "loaded.\n\nDo you want to revert "
231 "to the saved version?"), file);
232 int const ret = Alert::prompt(_("Revert to saved document?"),
233 text, 0, 1, _("&Revert"), _("&Switch to document"));
236 setBuffer(theBufferList().getBuffer(filename.absFilename()));
239 // FIXME: should be LFUN_REVERT
240 if (!theBufferList().close(theBufferList().getBuffer(filename.absFilename()), false))
242 // Fall through to new load. (Asger)
248 if (isFileReadable(filename)) {
249 b = theBufferList().newBuffer(filename.absFilename());
250 if (!lyx::loadLyXFile(b, filename)) {
251 theBufferList().release(b);
255 docstring text = bformat(_("The document %1$s does not yet "
256 "exist.\n\nDo you want to create "
257 "a new document?"), from_utf8(filename.absFilename()));
258 int const ret = Alert::prompt(_("Create new document?"),
259 text, 0, 1, _("&Create"), _("Cancel"));
262 b = newFile(filename.absFilename(), string(), true);
270 // Send the "errors" signal in case of parsing errors
273 // Update the labels and section numbering.
274 updateLabels(*buffer_);
275 // scroll to the position when the file was last closed
276 if (lyxrc.use_lastfilepos) {
279 boost::tie(pit, pos) = LyX::ref().session().lastFilePos().load(filename);
280 // if successfully move to pit (returned par_id is not zero), update metrics
281 if (moveToPosition(pit, 0, pos).get<1>()) {
283 updateMetrics(false);
288 LyX::ref().session().lastFiles().add(FileName(b->fileName()));
294 void BufferView::resize()
299 lyxerr[Debug::DEBUG] << BOOST_CURRENT_FUNCTION << endl;
301 updateMetrics(false);
306 bool BufferView::fitCursor()
308 if (bv_funcs::status(this, cursor_) == bv_funcs::CUR_INSIDE) {
309 frontend::FontMetrics const & fm =
310 theFontMetrics(cursor_.getFont());
311 int const asc = fm.maxAscent();
312 int const des = fm.maxDescent();
313 Point const p = bv_funcs::getPos(*this, cursor_, cursor_.boundary());
314 if (p.y_ - asc >= 0 && p.y_ + des < height_)
322 bool BufferView::multiParSel()
324 if (!cursor_.selection())
326 bool ret = multiparsel_cache_;
327 multiparsel_cache_ = cursor_.selBegin().pit() != cursor_.selEnd().pit();
328 // Either this, or previous selection spans paragraphs
329 return ret || multiparsel_cache_;
333 bool BufferView::update(Update::flags flags)
335 // last_inset_ points to the last visited inset. This pointer may become
336 // invalid because of keyboard editing. Since all such operations
337 // causes screen update(), I reset last_inset_ to avoid such a problem.
339 // This is close to a hot-path.
340 if (lyxerr.debugging(Debug::DEBUG)) {
342 << BOOST_CURRENT_FUNCTION
343 << "[fitcursor = " << (flags & Update::FitCursor)
344 << ", forceupdate = " << (flags & Update::Force)
345 << ", singlepar = " << (flags & Update::SinglePar)
346 << "] buffer: " << buffer_ << endl;
349 // Check needed to survive LyX startup
353 if (lyxerr.debugging(Debug::WORKAREA)) {
354 lyxerr[Debug::WORKAREA] << "BufferView::update" << std::endl;
357 // Update macro store
358 buffer_->buildMacros();
360 // Now do the first drawing step if needed. This consists on updating
361 // the CoordCache in updateMetrics().
362 // The second drawing step is done in WorkArea::redraw() if needed.
364 // Case when no explicit update is requested.
366 // no need to redraw anything.
367 metrics_info_.update_strategy = NoScreenUpdate;
371 if (flags == Update::Decoration) {
372 metrics_info_.update_strategy = DecorationUpdate;
376 if (flags == Update::FitCursor
377 || flags == (Update::Decoration | Update::FitCursor)) {
378 bool const fit_cursor = fitCursor();
379 // tell the frontend to update the screen if needed.
381 updateMetrics(false);
384 if (flags & Update::Decoration) {
385 metrics_info_.update_strategy = DecorationUpdate;
388 // no screen update is needed.
389 metrics_info_.update_strategy = NoScreenUpdate;
393 bool full_metrics = flags & Update::Force;
394 if (flags & Update::MultiParSel)
395 full_metrics |= multiParSel();
397 bool const single_par = !full_metrics;
398 updateMetrics(single_par);
400 if (flags & Update::FitCursor && fitCursor())
401 updateMetrics(false);
403 // tell the frontend to update the screen.
408 void BufferView::updateScrollbar()
411 lyxerr[Debug::DEBUG] << BOOST_CURRENT_FUNCTION
412 << " no text in updateScrollbar" << endl;
413 scrollbarParameters_.reset();
417 LyXText & t = buffer_->text();
418 TextMetrics & tm = text_metrics_[&t];
420 int const parsize = int(t.paragraphs().size() - 1);
421 if (anchor_ref_ > parsize) {
422 anchor_ref_ = parsize;
426 if (lyxerr.debugging(Debug::GUI)) {
428 << BOOST_CURRENT_FUNCTION
429 << " Updating scrollbar: height: " << t.paragraphs().size()
430 << " curr par: " << cursor_.bottom().pit()
431 << " default height " << defaultRowHeight() << endl;
434 // It would be better to fix the scrollbar to understand
435 // values in [0..1] and divide everything by wh
437 // estimated average paragraph height:
441 int h = tm.parMetrics(anchor_ref_).height();
443 // Normalize anchor/offset (MV):
444 while (offset_ref_ > h && anchor_ref_ < parsize) {
447 h = tm.parMetrics(anchor_ref_).height();
449 // Look at paragraph heights on-screen
452 for (pit_type pit = anchor_ref_; pit <= parsize; ++pit) {
455 int const h2 = tm.parMetrics(pit).height();
461 int const hav = sumh / nh;
462 // More realistic average paragraph height
467 scrollbarParameters_.height = (parsize + 1) * wh_;
468 scrollbarParameters_.position = anchor_ref_ * wh_ + int(offset_ref_ * wh_ / float(h));
469 scrollbarParameters_.lineScrollHeight = int(wh_ * defaultRowHeight() / float(h));
473 ScrollbarParameters const & BufferView::scrollbarParameters() const
475 return scrollbarParameters_;
479 void BufferView::scrollDocView(int value)
481 lyxerr[Debug::GUI] << BOOST_CURRENT_FUNCTION
482 << "[ value = " << value << "]" << endl;
487 LyXText & t = buffer_->text();
488 TextMetrics & tm = text_metrics_[&t];
490 float const bar = value / float(wh_ * t.paragraphs().size());
492 anchor_ref_ = int(bar * t.paragraphs().size());
493 if (anchor_ref_ > int(t.paragraphs().size()) - 1)
494 anchor_ref_ = int(t.paragraphs().size()) - 1;
496 tm.redoParagraph(anchor_ref_);
497 int const h = tm.parMetrics(anchor_ref_).height();
498 offset_ref_ = int((bar * t.paragraphs().size() - anchor_ref_) * h);
499 updateMetrics(false);
503 void BufferView::setCursorFromScrollbar()
508 LyXText & t = buffer_->text();
510 int const height = 2 * defaultRowHeight();
511 int const first = height;
512 int const last = height_ - height;
513 LCursor & cur = cursor_;
515 bv_funcs::CurStatus st = bv_funcs::status(this, cur);
518 case bv_funcs::CUR_ABOVE:
519 // We reset the cursor because bv_funcs::status() does not
520 // work when the cursor is within mathed.
521 cur.reset(buffer_->inset());
522 t.setCursorFromCoordinates(cur, 0, first);
523 cur.clearSelection();
525 case bv_funcs::CUR_BELOW:
526 // We reset the cursor because bv_funcs::status() does not
527 // work when the cursor is within mathed.
528 cur.reset(buffer_->inset());
529 t.setCursorFromCoordinates(cur, 0, last);
530 cur.clearSelection();
532 case bv_funcs::CUR_INSIDE:
533 int const y = bv_funcs::getPos(*this, cur, cur.boundary()).y_;
534 int const newy = min(last, max(y, first));
536 cur.reset(buffer_->inset());
537 t.setCursorFromCoordinates(cur, 0, newy);
543 Change const BufferView::getCurrentChange() const
545 if (!cursor_.selection())
546 return Change(Change::UNCHANGED);
548 DocIterator dit = cursor_.selectionBegin();
549 return dit.paragraph().lookupChange(dit.pos());
553 void BufferView::saveBookmark(bool persistent)
555 LyX::ref().session().bookmarks().save(
556 FileName(buffer_->fileName()),
558 cursor_.paragraph().id(),
563 // emit message signal.
564 message(_("Save bookmark"));
568 boost::tuple<pit_type, int> BufferView::moveToPosition(pit_type par_pit, int par_id, pos_type par_pos)
570 cursor_.clearSelection();
572 // if a valid par_id is given, try it first
574 ParIterator par = buffer_->getParFromID(par_id);
575 if (par != buffer_->par_iterator_end()) {
576 setCursor(makeDocIterator(par, min(par->size(), par_pos)));
577 return boost::make_tuple(cursor_.pit(), par_id);
580 // if par_id == 0, or searching through par_id failed
581 if (static_cast<size_t>(par_pit) < buffer_->paragraphs().size()) {
582 ParIterator it = buffer_->par_iterator_begin();
583 ParIterator const end = buffer_->par_iterator_end();
584 for (; it != end; ++it)
585 if (it.pit() == par_pit) {
586 // restored pos may be bigger than it->size
587 setCursor(makeDocIterator(it, min(par_pos, it->size())));
588 return boost::make_tuple(par_pit, it->id());
592 return boost::make_tuple(pit_type(0), 0);
596 void BufferView::switchKeyMap()
598 if (!lyxrc.rtl_support)
601 if (cursor_.innerText()->real_current_font.isRightToLeft()) {
602 if (intl_->keymap == Intl::PRIMARY)
605 if (intl_->keymap == Intl::SECONDARY)
611 int BufferView::workWidth() const
617 void BufferView::center()
619 CursorSlice & bot = cursor_.bottom();
620 TextMetrics & tm = text_metrics_[bot.text()];
621 pit_type const pit = bot.pit();
622 tm.redoParagraph(pit);
623 ParagraphMetrics const & pm = tm.parMetrics(pit);
625 offset_ref_ = bv_funcs::coordOffset(*this, cursor_, cursor_.boundary()).y_
626 + pm.ascent() - height_ / 2;
630 FuncStatus BufferView::getStatus(FuncRequest const & cmd)
634 switch (cmd.action) {
637 flag.enabled(!buffer_->undostack().empty());
640 flag.enabled(!buffer_->redostack().empty());
642 case LFUN_FILE_INSERT:
643 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
644 case LFUN_FILE_INSERT_PLAINTEXT:
645 case LFUN_BOOKMARK_SAVE:
646 // FIXME: Actually, these LFUNS should be moved to LyXText
647 flag.enabled(cursor_.inTexted());
649 case LFUN_FONT_STATE:
650 case LFUN_LABEL_INSERT:
651 case LFUN_PARAGRAPH_GOTO:
652 // FIXME handle non-trivially
653 case LFUN_OUTLINE_UP:
654 case LFUN_OUTLINE_DOWN:
655 case LFUN_OUTLINE_IN:
656 case LFUN_OUTLINE_OUT:
658 case LFUN_REFERENCE_NEXT:
660 case LFUN_WORD_REPLACE:
663 case LFUN_MARK_TOGGLE:
664 case LFUN_SCREEN_RECENTER:
665 case LFUN_BIBTEX_DATABASE_ADD:
666 case LFUN_BIBTEX_DATABASE_DEL:
667 case LFUN_WORDS_COUNT:
668 case LFUN_NEXT_INSET_TOGGLE:
672 case LFUN_LABEL_GOTO: {
673 flag.enabled(!cmd.argument().empty()
674 || getInsetByCode<InsetRef>(cursor_, InsetBase::REF_CODE));
678 case LFUN_CHANGES_TRACK:
680 flag.setOnOff(buffer_->params().trackChanges);
683 case LFUN_CHANGES_OUTPUT: {
684 OutputParams runparams;
685 flag.enabled(buffer_ && LaTeXFeatures::isAvailable("dvipost"));
686 flag.setOnOff(buffer_->params().outputChanges);
690 case LFUN_CHANGES_MERGE:
691 case LFUN_CHANGE_NEXT:
692 case LFUN_ALL_CHANGES_ACCEPT:
693 case LFUN_ALL_CHANGES_REJECT:
694 // TODO: context-sensitive enabling of LFUNs
695 // In principle, these command should only be enabled if there
696 // is a change in the document. However, without proper
697 // optimizations, this will inevitably result in poor performance.
698 flag.enabled(buffer_);
701 case LFUN_BUFFER_TOGGLE_COMPRESSION: {
702 flag.setOnOff(buffer_->params().compressed);
714 Update::flags BufferView::dispatch(FuncRequest const & cmd)
716 //lyxerr << BOOST_CURRENT_FUNCTION
717 // << [ cmd = " << cmd << "]" << endl;
719 // Make sure that the cached BufferView is correct.
720 lyxerr[Debug::ACTION] << BOOST_CURRENT_FUNCTION
721 << " action[" << cmd.action << ']'
722 << " arg[" << to_utf8(cmd.argument()) << ']'
723 << " x[" << cmd.x << ']'
724 << " y[" << cmd.y << ']'
725 << " button[" << cmd.button() << ']'
728 // FIXME: this should not be possible.
732 LCursor & cur = cursor_;
733 // Default Update flags.
734 Update::flags updateFlags = Update::Force | Update::FitCursor;
736 switch (cmd.action) {
739 cur.message(_("Undo"));
740 cur.clearSelection();
741 if (!textUndo(*this)) {
742 cur.message(_("No further undo information"));
743 updateFlags = Update::None;
749 cur.message(_("Redo"));
750 cur.clearSelection();
751 if (!textRedo(*this)) {
752 cur.message(_("No further redo information"));
753 updateFlags = Update::None;
758 case LFUN_FILE_INSERT:
760 menuInsertLyXFile(to_utf8(cmd.argument()));
763 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
765 insertPlaintextFile(this, to_utf8(cmd.argument()), true);
768 case LFUN_FILE_INSERT_PLAINTEXT:
770 insertPlaintextFile(this, to_utf8(cmd.argument()), false);
773 case LFUN_FONT_STATE:
774 cur.message(cur.currentState());
777 case LFUN_BOOKMARK_SAVE:
778 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
781 case LFUN_LABEL_GOTO: {
782 docstring label = cmd.argument();
785 getInsetByCode<InsetRef>(cursor_,
786 InsetBase::REF_CODE);
788 label = inset->getParam("reference");
789 // persistent=false: use temp_bookmark
799 case LFUN_PARAGRAPH_GOTO: {
800 int const id = convert<int>(to_utf8(cmd.argument()));
802 for (Buffer * b = buffer_; i == 0 || b != buffer_; b = theBufferList().next(b)) {
803 ParIterator par = b->getParFromID(id);
804 if (par == b->par_iterator_end()) {
806 << "No matching paragraph found! ["
807 << id << "]." << endl;
810 << "Paragraph " << par->id()
811 << " found in buffer `"
812 << b->fileName() << "'." << endl;
816 setCursor(makeDocIterator(par, 0));
819 // Switch to other buffer view and resend cmd
820 theLyXFunc().dispatch(FuncRequest(
821 LFUN_BUFFER_SWITCH, b->fileName()));
822 theLyXFunc().dispatch(cmd);
823 updateFlags = Update::None;
832 case LFUN_OUTLINE_UP:
833 toc::outline(toc::Up, cursor_);
834 cursor_.text()->setCursor(cursor_, cursor_.pit(), 0);
835 updateLabels(*buffer_);
837 case LFUN_OUTLINE_DOWN:
838 toc::outline(toc::Down, cursor_);
839 cursor_.text()->setCursor(cursor_, cursor_.pit(), 0);
840 updateLabels(*buffer_);
842 case LFUN_OUTLINE_IN:
843 toc::outline(toc::In, cursor_);
844 updateLabels(*buffer_);
846 case LFUN_OUTLINE_OUT:
847 toc::outline(toc::Out, cursor_);
848 updateLabels(*buffer_);
852 bv_funcs::gotoInset(this, InsetBase::NOTE_CODE, false);
855 case LFUN_REFERENCE_NEXT: {
856 vector<InsetBase_code> tmp;
857 tmp.push_back(InsetBase::LABEL_CODE);
858 tmp.push_back(InsetBase::REF_CODE);
859 bv_funcs::gotoInset(this, tmp, true);
863 case LFUN_CHANGES_TRACK:
864 buffer_->params().trackChanges = !buffer_->params().trackChanges;
867 case LFUN_CHANGES_OUTPUT:
868 buffer_->params().outputChanges = !buffer_->params().outputChanges;
871 case LFUN_CHANGE_NEXT:
872 findNextChange(this);
875 case LFUN_CHANGES_MERGE:
876 if (findNextChange(this))
877 showDialog("changes");
880 case LFUN_ALL_CHANGES_ACCEPT:
881 // select complete document
882 cursor_.reset(buffer_->inset());
883 cursor_.selHandle(true);
884 buffer_->text().cursorBottom(cursor_);
885 // accept everything in a single step to support atomic undo
886 buffer_->text().acceptOrRejectChanges(cursor_, LyXText::ACCEPT);
889 case LFUN_ALL_CHANGES_REJECT:
890 // select complete document
891 cursor_.reset(buffer_->inset());
892 cursor_.selHandle(true);
893 buffer_->text().cursorBottom(cursor_);
894 // reject everything in a single step to support atomic undo
895 // Note: reject does not work recursively; the user may have to repeat the operation
896 buffer_->text().acceptOrRejectChanges(cursor_, LyXText::REJECT);
903 case LFUN_WORD_REPLACE:
908 cur.clearSelection();
910 cur.message(from_utf8(N_("Mark off")));
914 cur.clearSelection();
917 cur.message(from_utf8(N_("Mark on")));
920 case LFUN_MARK_TOGGLE:
921 cur.clearSelection();
924 cur.message(from_utf8(N_("Mark removed")));
927 cur.message(from_utf8(N_("Mark set")));
932 case LFUN_SCREEN_RECENTER:
936 case LFUN_BIBTEX_DATABASE_ADD: {
937 LCursor tmpcur = cursor_;
938 bv_funcs::findInset(tmpcur, InsetBase::BIBTEX_CODE, false);
939 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
940 InsetBase::BIBTEX_CODE);
942 if (inset->addDatabase(to_utf8(cmd.argument())))
943 buffer_->updateBibfilesCache();
948 case LFUN_BIBTEX_DATABASE_DEL: {
949 LCursor tmpcur = cursor_;
950 bv_funcs::findInset(tmpcur, InsetBase::BIBTEX_CODE, false);
951 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
952 InsetBase::BIBTEX_CODE);
954 if (inset->delDatabase(to_utf8(cmd.argument())))
955 buffer_->updateBibfilesCache();
960 case LFUN_WORDS_COUNT: {
961 DocIterator from, to;
962 if (cur.selection()) {
963 from = cur.selectionBegin();
964 to = cur.selectionEnd();
966 from = doc_iterator_begin(buffer_->inset());
967 to = doc_iterator_end(buffer_->inset());
969 int const count = countWords(from, to);
973 message = bformat(_("%1$d words in selection."),
976 message = bformat(_("%1$d words in document."),
981 message = _("One word in selection.");
983 message = _("One word in document.");
986 Alert::information(_("Count words"), message);
990 case LFUN_BUFFER_TOGGLE_COMPRESSION:
991 // turn compression on/off
992 buffer_->params().compressed = !buffer_->params().compressed;
995 case LFUN_NEXT_INSET_TOGGLE: {
996 // this is the real function we want to invoke
997 FuncRequest tmpcmd = FuncRequest(LFUN_INSET_TOGGLE, cmd.origin);
998 // if there is an inset at cursor, see whether it
1000 InsetBase * inset = cur.nextInset();
1001 if (inset && inset->isActive()) {
1002 LCursor tmpcur = cur;
1003 tmpcur.pushLeft(*inset);
1004 inset->dispatch(tmpcur, tmpcmd);
1005 if (tmpcur.result().dispatched()) {
1009 // if it did not work, try the underlying inset.
1010 if (!cur.result().dispatched())
1011 cur.dispatch(tmpcmd);
1013 if (cur.result().dispatched())
1014 cur.clearSelection();
1020 updateFlags = Update::None;
1027 docstring const BufferView::requestSelection()
1032 LCursor & cur = cursor_;
1034 if (!cur.selection()) {
1035 xsel_cache_.set = false;
1039 if (!xsel_cache_.set ||
1040 cur.top() != xsel_cache_.cursor ||
1041 cur.anchor_.top() != xsel_cache_.anchor)
1043 xsel_cache_.cursor = cur.top();
1044 xsel_cache_.anchor = cur.anchor_.top();
1045 xsel_cache_.set = cur.selection();
1046 return cur.selectionAsString(false);
1052 void BufferView::clearSelection()
1055 cursor_.clearSelection();
1056 // Clear the selection buffer. Otherwise a subsequent
1057 // middle-mouse-button paste would use the selection buffer,
1058 // not the more current external selection.
1059 cap::clearSelection();
1060 xsel_cache_.set = false;
1061 // The buffer did not really change, but this causes the
1062 // redraw we need because we cleared the selection above.
1068 void BufferView::workAreaResize(int width, int height)
1070 // Update from work area
1074 // The complete text metrics will be redone.
1075 text_metrics_.clear();
1082 bool BufferView::workAreaDispatch(FuncRequest const & cmd0)
1084 //lyxerr << BOOST_CURRENT_FUNCTION << "[ cmd0 " << cmd0 << "]" << endl;
1086 // This is only called for mouse related events including
1087 // LFUN_FILE_OPEN generated by drag-and-drop.
1088 FuncRequest cmd = cmd0;
1090 // E.g. Qt mouse press when no buffer
1095 cur.push(buffer_->inset());
1096 cur.selection() = cursor_.selection();
1098 // Either the inset under the cursor or the
1099 // surrounding LyXText will handle this event.
1101 // Build temporary cursor.
1102 cmd.y = min(max(cmd.y, -1), height_);
1103 InsetBase * inset = buffer_->text().editXY(cur, cmd.x, cmd.y);
1105 //lyxerr << BOOST_CURRENT_FUNCTION
1106 // << " * hit inset at tip: " << inset << endl;
1107 //lyxerr << BOOST_CURRENT_FUNCTION
1108 // << " * created temp cursor:" << cur << endl;
1110 // NOTE: editXY returns the top level inset of nested insets. If you happen
1111 // to move from a text (inset=0) to a text inside an inset (e.g. an opened
1112 // footnote inset, again inset=0), that inset will not be redrawn.
1113 if (cmd.action == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
1114 bool need_redraw = false;
1116 if (inset != last_inset_) {
1118 need_redraw |= last_inset_->setMouseHover(false);
1120 need_redraw |= inset->setMouseHover(true);
1121 last_inset_ = inset;
1124 // if last metrics update was in singlepar mode, WorkArea::redraw() will
1125 // not expose the button for redraw. We adjust here the metrics dimension
1126 // to enable a full redraw.
1127 // FIXME: It is possible to redraw only the area around the button!
1129 && metrics_info_.update_strategy == SingleParUpdate) {
1130 // FIXME: It should be possible to redraw only the area around
1131 // the button by doing this:
1133 //metrics_info_.singlepar = false;
1134 //metrics_info_.y1 = ymin of button;
1135 //metrics_info_.y2 = ymax of button;
1137 // Unfortunately, rowpainter.C:paintText() does not distinguish
1138 // between background updates and text updates. So we use the hammer
1139 // solution for now. We could also avoid the updateMetrics() below
1140 // by using the first and last pit of the CoordCache. Have a look
1141 // at LyXText::getPitNearY() to see what I mean.
1143 //metrics_info_.pit1 = first pit of CoordCache;
1144 //metrics_info_.pit2 = last pit of CoordCache;
1145 //metrics_info_.singlepar = false;
1146 //metrics_info_.y1 = 0;
1147 //metrics_info_.y2 = height_;
1149 updateMetrics(false);
1152 // This event (moving without mouse click) is not passed further.
1153 // This should be changed if it is further utilized.
1157 // Put anchor at the same position.
1160 // Try to dispatch to an non-editable inset near this position
1161 // via the temp cursor. If the inset wishes to change the real
1162 // cursor it has to do so explicitly by using
1163 // cur.bv().cursor() = cur; (or similar)
1165 inset->dispatch(cur, cmd);
1168 // Now dispatch to the temporary cursor. If the real cursor should
1169 // be modified, the inset's dispatch has to do so explicitly.
1170 if (!cur.result().dispatched())
1173 // Redraw if requested and necessary.
1174 if (cur.result().dispatched() && cur.result().update())
1175 return update(cur.result().update());
1181 void BufferView::scroll(int /*lines*/)
1186 // LyXText const * t = &buffer_->text();
1187 // int const line_height = defaultRowHeight();
1189 // // The new absolute coordinate
1190 // int new_top_y = top_y() + lines * line_height;
1192 // // Restrict to a valid value
1193 // new_top_y = std::min(t->height() - 4 * line_height, new_top_y);
1194 // new_top_y = std::max(0, new_top_y);
1196 // scrollDocView(new_top_y);
1201 void BufferView::setCursorFromRow(int row)
1206 buffer_->texrow().getIdFromRow(row, tmpid, tmppos);
1209 buffer_->text().setCursor(cursor_, 0, 0);
1211 buffer_->text().setCursor(cursor_, buffer_->getParFromID(tmpid).pit(), tmppos);
1215 void BufferView::gotoLabel(docstring const & label)
1217 for (InsetIterator it = inset_iterator_begin(buffer_->inset()); it; ++it) {
1218 vector<docstring> labels;
1219 it->getLabelList(*buffer_, labels);
1220 if (std::find(labels.begin(), labels.end(), label) != labels.end()) {
1229 TextMetrics const & BufferView::textMetrics(LyXText const * t) const
1231 return const_cast<BufferView *>(this)->textMetrics(t);
1235 TextMetrics & BufferView::textMetrics(LyXText const * t)
1237 TextMetricsCache::iterator tmc_it = text_metrics_.find(t);
1238 if (tmc_it == text_metrics_.end()) {
1239 tmc_it = text_metrics_.insert(
1240 make_pair(t, TextMetrics(this, const_cast<LyXText *>(t)))).first;
1242 return tmc_it->second;
1246 ParagraphMetrics const & BufferView::parMetrics(LyXText const * t,
1249 return textMetrics(t).parMetrics(pit);
1253 int BufferView::workHeight() const
1259 void BufferView::setCursor(DocIterator const & dit)
1261 size_t const n = dit.depth();
1262 for (size_t i = 0; i < n; ++i)
1263 dit[i].inset().edit(cursor_, true);
1265 cursor_.setCursor(dit);
1266 cursor_.selection() = false;
1270 bool BufferView::checkDepm(LCursor & cur, LCursor & old)
1272 // Would be wrong to delete anything if we have a selection.
1273 if (cur.selection())
1276 bool need_anchor_change = false;
1277 bool changed = cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
1278 need_anchor_change);
1280 if (need_anchor_change)
1286 updateLabels(*buffer_);
1288 updateMetrics(false);
1294 bool BufferView::mouseSetCursor(LCursor & cur)
1296 BOOST_ASSERT(&cur.bv() == this);
1298 // Has the cursor just left the inset?
1299 bool badcursor = false;
1300 if (&cursor_.inset() != &cur.inset())
1301 badcursor = cursor_.inset().notifyCursorLeaves(cursor_);
1303 // do the dEPM magic if needed
1304 // FIXME: move this to InsetText::notifyCursorLeaves?
1305 bool update = false;
1306 if (!badcursor && cursor_.inTexted())
1307 checkDepm(cur, cursor_);
1309 // if the cursor was in an empty script inset and the new
1310 // position is in the nucleus of the inset, notifyCursorLeaves
1311 // will kill the script inset itself. So we check all the
1312 // elements of the cursor to make sure that they are correct.
1313 // For an example, see bug 2933:
1314 // http://bugzilla.lyx.org/show_bug.cgi?id=2933
1315 // The code below could maybe be moved to a DocIterator method.
1316 //lyxerr << "cur before " << cur <<std::endl;
1317 DocIterator dit(cur.inset());
1318 dit.push_back(cur.bottom());
1320 while (i < cur.depth() && dit.nextInset() == &cur[i].inset()) {
1321 dit.push_back(cur[i]);
1324 //lyxerr << "5 cur after" << dit <<std::endl;
1326 cursor_.setCursor(dit);
1327 cursor_.clearSelection();
1333 void BufferView::putSelectionAt(DocIterator const & cur,
1334 int length, bool backwards)
1336 cursor_.clearSelection();
1342 cursor_.pos() += length;
1343 cursor_.setSelection(cursor_, -length);
1345 cursor_.setSelection(cursor_, length);
1346 cap::saveSelection(cursor_);
1351 LCursor & BufferView::cursor()
1357 LCursor const & BufferView::cursor() const
1363 pit_type BufferView::anchor_ref() const
1369 ViewMetricsInfo const & BufferView::viewMetricsInfo()
1371 return metrics_info_;
1375 // FIXME: We should split-up updateMetrics() for the singlepar case.
1376 void BufferView::updateMetrics(bool singlepar)
1378 LyXText & buftext = buffer_->text();
1379 TextMetrics & tm = textMetrics(&buftext);
1380 pit_type size = int(buftext.paragraphs().size());
1382 if (anchor_ref_ > int(buftext.paragraphs().size() - 1)) {
1383 anchor_ref_ = int(buftext.paragraphs().size() - 1);
1387 // If the paragraph metrics has changed, we can not
1388 // use the singlepar optimisation.
1390 // In Single Paragraph mode, rebreak only
1391 // the (main text, not inset!) paragraph containing the cursor.
1392 // (if this paragraph contains insets etc., rebreaking will
1393 // recursively descend)
1394 && tm.redoParagraph(cursor_.bottom().pit()))
1397 pit_type const pit = anchor_ref_;
1400 size_t const npit = buftext.paragraphs().size();
1402 // Rebreak anchor paragraph.
1404 tm.redoParagraph(pit);
1406 // Clear out the position cache in case of full screen redraw.
1408 coord_cache_.clear();
1410 int y0 = tm.parMetrics(pit).ascent() - offset_ref_;
1412 // Redo paragraphs above anchor if necessary.
1414 while (y1 > 0 && pit1 > 0) {
1415 y1 -= tm.parMetrics(pit1).ascent();
1418 tm.redoParagraph(pit1);
1419 y1 -= tm.parMetrics(pit1).descent();
1423 // Take care of ascent of first line
1424 y1 -= tm.parMetrics(pit1).ascent();
1426 // Normalize anchor for next time
1430 // Grey at the beginning is ugly
1431 if (pit1 == 0 && y1 > 0) {
1437 // Redo paragraphs below the anchor if necessary.
1439 while (y2 < height_ && pit2 < int(npit) - 1) {
1440 y2 += tm.parMetrics(pit2).descent();
1443 tm.redoParagraph(pit2);
1444 y2 += tm.parMetrics(pit2).ascent();
1447 // Take care of descent of last line
1448 y2 += tm.parMetrics(pit2).descent();
1450 // The coordinates of all these paragraphs are correct, cache them
1452 CoordCache::InnerParPosCache & parPos = coord_cache_.parPos()[&buftext];
1453 for (pit_type pit = pit1; pit <= pit2; ++pit) {
1454 ParagraphMetrics const & pm = tm.parMetrics(pit);
1456 parPos[pit] = Point(0, y);
1457 if (singlepar && pit == cursor_.bottom().pit()) {
1458 // In Single Paragraph mode, collect here the
1459 // y1 and y2 of the (one) paragraph the cursor is in
1460 y1 = y - pm.ascent();
1461 y2 = y + pm.descent();
1467 // collect cursor paragraph iter bounds
1468 pit1 = cursor_.bottom().pit();
1469 pit2 = cursor_.bottom().pit();
1472 lyxerr[Debug::DEBUG]
1473 << BOOST_CURRENT_FUNCTION
1476 << " pit1: " << pit1
1477 << " pit2: " << pit2
1478 << " npit: " << npit
1479 << " singlepar: " << singlepar
1483 metrics_info_ = ViewMetricsInfo(pit1, pit2, y1, y2,
1484 singlepar? SingleParUpdate: FullScreenUpdate, size);
1486 if (lyxerr.debugging(Debug::WORKAREA)) {
1487 lyxerr[Debug::WORKAREA] << "BufferView::updateMetrics" << endl;
1488 coord_cache_.dump();
1493 void BufferView::menuInsertLyXFile(string const & filenm)
1495 BOOST_ASSERT(cursor_.inTexted());
1496 string filename = filenm;
1498 if (filename.empty()) {
1499 // Launch a file browser
1501 string initpath = lyxrc.document_path;
1504 string const trypath = buffer_->filePath();
1505 // If directory is writeable, use this as default.
1506 if (isDirWriteable(FileName(trypath)))
1511 FileDialog fileDlg(_("Select LyX document to insert"),
1513 make_pair(_("Documents|#o#O"), from_utf8(lyxrc.document_path)),
1514 make_pair(_("Examples|#E#e"), from_utf8(addPath(package().system_support(), "examples"))));
1516 FileDialog::Result result =
1517 fileDlg.open(from_utf8(initpath),
1518 FileFilterList(_("LyX Documents (*.lyx)")),
1521 if (result.first == FileDialog::Later)
1525 filename = to_utf8(result.second);
1527 // check selected filename
1528 if (filename.empty()) {
1529 // emit message signal.
1530 message(_("Canceled."));
1535 // Get absolute path of file and add ".lyx"
1536 // to the filename if necessary
1537 filename = fileSearch(string(), filename, "lyx").absFilename();
1539 docstring const disp_fn = makeDisplayPath(filename);
1540 // emit message signal.
1541 message(bformat(_("Inserting document %1$s..."), disp_fn));
1544 Buffer buf("", false);
1545 if (lyx::loadLyXFile(&buf, FileName(filename))) {
1546 ErrorList & el = buffer_->errorList("Parse");
1547 // Copy the inserted document error list into the current buffer one.
1548 el = buf.errorList("Parse");
1549 recordUndo(cursor_);
1550 cap::pasteParagraphList(cursor_, buf.paragraphs(),
1551 buf.params().textclass, el);
1552 res = _("Document %1$s inserted.");
1554 res = _("Could not insert document %1$s");
1556 // emit message signal.
1557 message(bformat(res, disp_fn));
1558 buffer_->errors("Parse");