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"
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>
85 using support::addPath;
86 using support::bformat;
87 using support::FileFilterList;
88 using support::FileName;
89 using support::fileSearch;
90 using support::isDirWriteable;
91 using support::isFileReadable;
92 using support::makeDisplayPath;
93 using support::package;
97 using std::istringstream;
101 using std::mem_fun_ref;
105 namespace Alert = frontend::Alert;
109 /// Return an inset of this class if it exists at the current cursor position
111 T * getInsetByCode(LCursor & cur, InsetBase::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()
126 : width_(0), height_(0), buffer_(0), wh_(0),
128 multiparsel_cache_(false), anchor_ref_(0), offset_ref_(0),
129 intl_(new Intl), last_inset_(0)
131 xsel_cache_.set = false;
132 intl_->initKeyMapper(lyxrc.use_kbmap);
136 BufferView::~BufferView()
141 Buffer * BufferView::buffer() const
147 void BufferView::setBuffer(Buffer * b)
149 lyxerr[Debug::INFO] << BOOST_CURRENT_FUNCTION
150 << "[ b = " << b << "]" << endl;
153 // Save the actual cursor position and anchor inside the
154 // buffer so that it can be restored in case we rechange
155 // to this buffer later on.
156 buffer_->saveCursor(cursor_.selectionBegin(),
157 cursor_.selectionEnd());
158 // current buffer is going to be switched-off, save cursor pos
159 LyX::ref().session().lastFilePos().save(FileName(buffer_->fileName()),
160 boost::tie(cursor_.pit(), cursor_.pos()) );
163 // If we're quitting lyx, don't bother updating stuff
169 // If we are closing current buffer, switch to the first in
172 lyxerr[Debug::INFO] << BOOST_CURRENT_FUNCTION
173 << " No Buffer!" << endl;
174 // We are closing the buffer, use the first buffer as current
175 buffer_ = theBufferList().first();
177 // Set current buffer
182 cursor_ = LCursor(*this);
187 lyxerr[Debug::INFO] << BOOST_CURRENT_FUNCTION
188 << "Buffer addr: " << buffer_ << endl;
189 cursor_.push(buffer_->inset());
190 cursor_.resetAnchor();
191 buffer_->text().setCurrentFont(cursor_);
192 if (buffer_->getCursor().size() > 0 &&
193 buffer_->getAnchor().size() > 0)
195 cursor_.setCursor(buffer_->getAnchor().asDocIterator(&(buffer_->inset())));
196 cursor_.resetAnchor();
197 cursor_.setCursor(buffer_->getCursor().asDocIterator(&(buffer_->inset())));
198 cursor_.setSelection();
199 theSelection().haveSelection(cursor_.selection());
204 updateMetrics(false);
206 if (buffer_ && graphics::Previews::status() != LyXRC::PREVIEW_OFF)
207 graphics::Previews::get().generateBufferPreviews(*buffer_);
211 bool BufferView::loadLyXFile(FileName const & filename, bool tolastfiles)
213 // File already open?
214 if (theBufferList().exists(filename.absFilename())) {
215 docstring const file = makeDisplayPath(filename.absFilename(), 20);
216 docstring text = bformat(_("The document %1$s is already "
217 "loaded.\n\nDo you want to revert "
218 "to the saved version?"), file);
219 int const ret = Alert::prompt(_("Revert to saved document?"),
220 text, 0, 1, _("&Revert"), _("&Switch to document"));
223 setBuffer(theBufferList().getBuffer(filename.absFilename()));
226 // FIXME: should be LFUN_REVERT
227 if (!theBufferList().close(theBufferList().getBuffer(filename.absFilename()), false))
229 // Fall through to new load. (Asger)
235 if (isFileReadable(filename)) {
236 b = theBufferList().newBuffer(filename.absFilename());
237 if (!lyx::loadLyXFile(b, filename)) {
238 theBufferList().release(b);
242 docstring text = bformat(_("The document %1$s does not yet "
243 "exist.\n\nDo you want to create "
244 "a new document?"), from_utf8(filename.absFilename()));
245 int const ret = Alert::prompt(_("Create new document?"),
246 text, 0, 1, _("&Create"), _("Cancel"));
249 b = newFile(filename.absFilename(), string(), true);
257 // Send the "errors" signal in case of parsing errors
260 // Update the labels and section numbering.
261 updateLabels(*buffer_);
262 // scroll to the position when the file was last closed
263 if (lyxrc.use_lastfilepos) {
266 boost::tie(pit, pos) = LyX::ref().session().lastFilePos().load(filename);
267 // if successfully move to pit (returned par_id is not zero), update metrics
268 if (moveToPosition(pit, 0, pos).get<1>()) {
270 updateMetrics(false);
275 LyX::ref().session().lastFiles().add(FileName(b->fileName()));
281 void BufferView::resize()
286 lyxerr[Debug::DEBUG] << BOOST_CURRENT_FUNCTION << endl;
288 updateMetrics(false);
293 bool BufferView::fitCursor()
295 if (bv_funcs::status(this, cursor_) == bv_funcs::CUR_INSIDE) {
296 frontend::FontMetrics const & fm =
297 theFontMetrics(cursor_.getFont());
298 int const asc = fm.maxAscent();
299 int const des = fm.maxDescent();
300 Point const p = bv_funcs::getPos(*this, cursor_, cursor_.boundary());
301 if (p.y_ - asc >= 0 && p.y_ + des < height_)
309 bool BufferView::multiParSel()
311 if (!cursor_.selection())
313 bool ret = multiparsel_cache_;
314 multiparsel_cache_ = cursor_.selBegin().pit() != cursor_.selEnd().pit();
315 // Either this, or previous selection spans paragraphs
316 return ret || multiparsel_cache_;
320 bool BufferView::update(Update::flags flags)
322 // last_inset_ points to the last visited inset. This pointer may become
323 // invalid because of keyboard editing. Since all such operations
324 // causes screen update(), I reset last_inset_ to avoid such a problem.
326 // This is close to a hot-path.
327 if (lyxerr.debugging(Debug::DEBUG)) {
329 << BOOST_CURRENT_FUNCTION
330 << "[fitcursor = " << (flags & Update::FitCursor)
331 << ", forceupdate = " << (flags & Update::Force)
332 << ", singlepar = " << (flags & Update::SinglePar)
333 << "] buffer: " << buffer_ << endl;
336 // Check needed to survive LyX startup
340 if (lyxerr.debugging(Debug::WORKAREA)) {
341 lyxerr[Debug::WORKAREA] << "BufferView::update" << std::endl;
344 // Update macro store
345 buffer_->buildMacros();
347 // Now do the first drawing step if needed. This consists on updating
348 // the CoordCache in updateMetrics().
349 // The second drawing step is done in WorkArea::redraw() if needed.
351 // Case when no explicit update is requested.
353 // no need to redraw anything.
354 metrics_info_.update_strategy = NoScreenUpdate;
358 if (flags == Update::Decoration) {
359 metrics_info_.update_strategy = DecorationUpdate;
363 if (flags == Update::FitCursor
364 || flags == (Update::Decoration | Update::FitCursor)) {
365 bool const fit_cursor = fitCursor();
366 // tell the frontend to update the screen if needed.
368 updateMetrics(false);
371 if (flags & Update::Decoration) {
372 metrics_info_.update_strategy = DecorationUpdate;
375 // no screen update is needed.
376 metrics_info_.update_strategy = NoScreenUpdate;
380 bool full_metrics = flags & Update::Force;
381 if (flags & Update::MultiParSel)
382 full_metrics |= multiParSel();
384 bool const single_par = !full_metrics;
385 updateMetrics(single_par);
387 if (flags & Update::FitCursor && fitCursor())
388 updateMetrics(false);
390 // tell the frontend to update the screen.
395 void BufferView::updateScrollbar()
398 lyxerr[Debug::DEBUG] << BOOST_CURRENT_FUNCTION
399 << " no text in updateScrollbar" << endl;
400 scrollbarParameters_.reset();
404 LyXText & t = buffer_->text();
405 TextMetrics & tm = text_metrics_[&t];
407 int const parsize = int(t.paragraphs().size() - 1);
408 if (anchor_ref_ > parsize) {
409 anchor_ref_ = parsize;
413 if (lyxerr.debugging(Debug::GUI)) {
415 << BOOST_CURRENT_FUNCTION
416 << " Updating scrollbar: height: " << t.paragraphs().size()
417 << " curr par: " << cursor_.bottom().pit()
418 << " default height " << defaultRowHeight() << endl;
421 // It would be better to fix the scrollbar to understand
422 // values in [0..1] and divide everything by wh
424 // estimated average paragraph height:
428 int h = tm.parMetrics(anchor_ref_).height();
430 // Normalize anchor/offset (MV):
431 while (offset_ref_ > h && anchor_ref_ < parsize) {
434 h = tm.parMetrics(anchor_ref_).height();
436 // Look at paragraph heights on-screen
439 for (pit_type pit = anchor_ref_; pit <= parsize; ++pit) {
442 int const h2 = tm.parMetrics(pit).height();
448 int const hav = sumh / nh;
449 // More realistic average paragraph height
454 scrollbarParameters_.height = (parsize + 1) * wh_;
455 scrollbarParameters_.position = anchor_ref_ * wh_ + int(offset_ref_ * wh_ / float(h));
456 scrollbarParameters_.lineScrollHeight = int(wh_ * defaultRowHeight() / float(h));
460 ScrollbarParameters const & BufferView::scrollbarParameters() const
462 return scrollbarParameters_;
466 void BufferView::scrollDocView(int value)
468 lyxerr[Debug::GUI] << BOOST_CURRENT_FUNCTION
469 << "[ value = " << value << "]" << endl;
474 LyXText & t = buffer_->text();
475 TextMetrics & tm = text_metrics_[&t];
477 float const bar = value / float(wh_ * t.paragraphs().size());
479 anchor_ref_ = int(bar * t.paragraphs().size());
480 if (anchor_ref_ > int(t.paragraphs().size()) - 1)
481 anchor_ref_ = int(t.paragraphs().size()) - 1;
483 tm.redoParagraph(anchor_ref_);
484 int const h = tm.parMetrics(anchor_ref_).height();
485 offset_ref_ = int((bar * t.paragraphs().size() - anchor_ref_) * h);
486 updateMetrics(false);
490 void BufferView::setCursorFromScrollbar()
492 LyXText & t = buffer_->text();
494 int const height = 2 * defaultRowHeight();
495 int const first = height;
496 int const last = height_ - height;
497 LCursor & cur = cursor_;
499 bv_funcs::CurStatus st = bv_funcs::status(this, cur);
502 case bv_funcs::CUR_ABOVE:
503 // We reset the cursor because bv_funcs::status() does not
504 // work when the cursor is within mathed.
505 cur.reset(buffer_->inset());
506 t.setCursorFromCoordinates(cur, 0, first);
507 cur.clearSelection();
509 case bv_funcs::CUR_BELOW:
510 // We reset the cursor because bv_funcs::status() does not
511 // work when the cursor is within mathed.
512 cur.reset(buffer_->inset());
513 t.setCursorFromCoordinates(cur, 0, last);
514 cur.clearSelection();
516 case bv_funcs::CUR_INSIDE:
517 int const y = bv_funcs::getPos(*this, cur, cur.boundary()).y_;
518 int const newy = min(last, max(y, first));
520 cur.reset(buffer_->inset());
521 t.setCursorFromCoordinates(cur, 0, newy);
527 Change const BufferView::getCurrentChange() const
529 if (!cursor_.selection())
530 return Change(Change::UNCHANGED);
532 DocIterator dit = cursor_.selectionBegin();
533 return dit.paragraph().lookupChange(dit.pos());
537 void BufferView::saveBookmark(bool persistent)
539 LyX::ref().session().bookmarks().save(
540 FileName(buffer_->fileName()),
542 cursor_.paragraph().id(),
547 // emit message signal.
548 message(_("Save bookmark"));
552 boost::tuple<pit_type, int> BufferView::moveToPosition(pit_type par_pit, int par_id, pos_type par_pos)
554 cursor_.clearSelection();
556 // if a valid par_id is given, try it first
558 ParIterator par = buffer_->getParFromID(par_id);
559 if (par != buffer_->par_iterator_end()) {
560 setCursor(makeDocIterator(par, min(par->size(), par_pos)));
561 return boost::make_tuple(cursor_.pit(), par_id);
564 // if par_id == 0, or searching through par_id failed
565 if (static_cast<size_t>(par_pit) < buffer_->paragraphs().size()) {
566 ParIterator it = buffer_->par_iterator_begin();
567 ParIterator const end = buffer_->par_iterator_end();
568 for (; it != end; ++it)
569 if (it.pit() == par_pit) {
570 // restored pos may be bigger than it->size
571 setCursor(makeDocIterator(it, min(par_pos, it->size())));
572 return boost::make_tuple(par_pit, it->id());
576 return boost::make_tuple(pit_type(0), 0);
580 void BufferView::switchKeyMap()
582 if (!lyxrc.rtl_support)
585 if (getLyXText()->real_current_font.isRightToLeft()) {
586 if (intl_->keymap == Intl::PRIMARY)
589 if (intl_->keymap == Intl::SECONDARY)
595 int BufferView::workWidth() const
601 void BufferView::center()
603 CursorSlice & bot = cursor_.bottom();
604 TextMetrics & tm = text_metrics_[bot.text()];
605 pit_type const pit = bot.pit();
606 tm.redoParagraph(pit);
607 ParagraphMetrics const & pm = tm.parMetrics(pit);
609 offset_ref_ = bv_funcs::coordOffset(*this, cursor_, cursor_.boundary()).y_
610 + pm.ascent() - height_ / 2;
614 FuncStatus BufferView::getStatus(FuncRequest const & cmd)
618 switch (cmd.action) {
621 flag.enabled(!buffer_->undostack().empty());
624 flag.enabled(!buffer_->redostack().empty());
626 case LFUN_FILE_INSERT:
627 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
628 case LFUN_FILE_INSERT_PLAINTEXT:
629 case LFUN_BOOKMARK_SAVE:
630 // FIXME: Actually, these LFUNS should be moved to LyXText
631 flag.enabled(cursor_.inTexted());
633 case LFUN_FONT_STATE:
634 case LFUN_LABEL_INSERT:
635 case LFUN_PARAGRAPH_GOTO:
636 // FIXME handle non-trivially
637 case LFUN_OUTLINE_UP:
638 case LFUN_OUTLINE_DOWN:
639 case LFUN_OUTLINE_IN:
640 case LFUN_OUTLINE_OUT:
642 case LFUN_REFERENCE_NEXT:
644 case LFUN_WORD_REPLACE:
647 case LFUN_MARK_TOGGLE:
648 case LFUN_SCREEN_RECENTER:
649 case LFUN_BIBTEX_DATABASE_ADD:
650 case LFUN_BIBTEX_DATABASE_DEL:
651 case LFUN_WORDS_COUNT:
652 case LFUN_NEXT_INSET_TOGGLE:
656 case LFUN_LABEL_GOTO: {
657 flag.enabled(!cmd.argument().empty()
658 || getInsetByCode<InsetRef>(cursor_, InsetBase::REF_CODE));
662 case LFUN_CHANGES_TRACK:
664 flag.setOnOff(buffer_->params().trackChanges);
667 case LFUN_CHANGES_OUTPUT: {
668 OutputParams runparams;
669 LaTeXFeatures features(*buffer_, buffer_->params(), runparams);
670 flag.enabled(buffer_ && features.isAvailable("dvipost"));
671 flag.setOnOff(buffer_->params().outputChanges);
675 case LFUN_CHANGES_MERGE:
676 case LFUN_CHANGE_NEXT:
677 case LFUN_ALL_CHANGES_ACCEPT:
678 case LFUN_ALL_CHANGES_REJECT:
679 // TODO: context-sensitive enabling of LFUNs
680 // In principle, these command should only be enabled if there
681 // is a change in the document. However, without proper
682 // optimizations, this will inevitably result in poor performance.
683 flag.enabled(buffer_);
686 case LFUN_BUFFER_TOGGLE_COMPRESSION: {
687 flag.setOnOff(buffer_->params().compressed);
699 Update::flags BufferView::dispatch(FuncRequest const & cmd)
701 //lyxerr << BOOST_CURRENT_FUNCTION
702 // << [ cmd = " << cmd << "]" << endl;
704 // Make sure that the cached BufferView is correct.
705 lyxerr[Debug::ACTION] << BOOST_CURRENT_FUNCTION
706 << " action[" << cmd.action << ']'
707 << " arg[" << to_utf8(cmd.argument()) << ']'
708 << " x[" << cmd.x << ']'
709 << " y[" << cmd.y << ']'
710 << " button[" << cmd.button() << ']'
713 // FIXME: this should not be possible.
717 LCursor & cur = cursor_;
718 // Default Update flags.
719 Update::flags updateFlags = Update::Force | Update::FitCursor;
721 switch (cmd.action) {
724 cur.message(_("Undo"));
725 cur.clearSelection();
726 if (!textUndo(*this)) {
727 cur.message(_("No further undo information"));
728 updateFlags = Update::None;
734 cur.message(_("Redo"));
735 cur.clearSelection();
736 if (!textRedo(*this)) {
737 cur.message(_("No further redo information"));
738 updateFlags = Update::None;
743 case LFUN_FILE_INSERT:
745 menuInsertLyXFile(to_utf8(cmd.argument()));
748 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
750 insertPlaintextFile(this, to_utf8(cmd.argument()), true);
753 case LFUN_FILE_INSERT_PLAINTEXT:
755 insertPlaintextFile(this, to_utf8(cmd.argument()), false);
758 case LFUN_FONT_STATE:
759 cur.message(cur.currentState());
762 case LFUN_BOOKMARK_SAVE:
763 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
766 case LFUN_LABEL_GOTO: {
767 docstring label = cmd.argument();
770 getInsetByCode<InsetRef>(cursor_,
771 InsetBase::REF_CODE);
773 label = inset->getParam("reference");
774 // persistent=false: use temp_bookmark
784 case LFUN_PARAGRAPH_GOTO: {
785 int const id = convert<int>(to_utf8(cmd.argument()));
787 for (Buffer * b = buffer_; i == 0 || b != buffer_; b = theBufferList().next(b)) {
788 ParIterator par = b->getParFromID(id);
789 if (par == b->par_iterator_end()) {
791 << "No matching paragraph found! ["
792 << id << "]." << endl;
795 << "Paragraph " << par->id()
796 << " found in buffer `"
797 << b->fileName() << "'." << endl;
801 setCursor(makeDocIterator(par, 0));
804 // Switch to other buffer view and resend cmd
805 theLyXFunc().dispatch(FuncRequest(
806 LFUN_BUFFER_SWITCH, b->fileName()));
807 theLyXFunc().dispatch(cmd);
808 updateFlags = Update::None;
817 case LFUN_OUTLINE_UP:
818 toc::outline(toc::Up, cursor_);
819 cursor_.text()->setCursor(cursor_, cursor_.pit(), 0);
820 updateLabels(*buffer_);
822 case LFUN_OUTLINE_DOWN:
823 toc::outline(toc::Down, cursor_);
824 cursor_.text()->setCursor(cursor_, cursor_.pit(), 0);
825 updateLabels(*buffer_);
827 case LFUN_OUTLINE_IN:
828 toc::outline(toc::In, cursor_);
829 updateLabels(*buffer_);
831 case LFUN_OUTLINE_OUT:
832 toc::outline(toc::Out, cursor_);
833 updateLabels(*buffer_);
837 bv_funcs::gotoInset(this, InsetBase::NOTE_CODE, false);
840 case LFUN_REFERENCE_NEXT: {
841 vector<InsetBase_code> tmp;
842 tmp.push_back(InsetBase::LABEL_CODE);
843 tmp.push_back(InsetBase::REF_CODE);
844 bv_funcs::gotoInset(this, tmp, true);
848 case LFUN_CHANGES_TRACK:
849 buffer_->params().trackChanges = !buffer_->params().trackChanges;
852 case LFUN_CHANGES_OUTPUT:
853 buffer_->params().outputChanges = !buffer_->params().outputChanges;
856 case LFUN_CHANGE_NEXT:
857 findNextChange(this);
860 case LFUN_CHANGES_MERGE:
861 if (findNextChange(this))
862 showDialog("changes");
865 case LFUN_ALL_CHANGES_ACCEPT: {
866 cursor_.reset(buffer_->inset());
868 #warning FIXME changes
870 while (findNextChange(this))
871 getLyXText()->acceptOrRejectChanges(cursor_, LyXText::ACCEPT);
875 case LFUN_ALL_CHANGES_REJECT: {
876 cursor_.reset(buffer_->inset());
878 #warning FIXME changes
880 while (findNextChange(this))
881 getLyXText()->acceptOrRejectChanges(cursor_, LyXText::REJECT);
889 case LFUN_WORD_REPLACE:
894 cur.clearSelection();
896 cur.message(from_utf8(N_("Mark off")));
900 cur.clearSelection();
903 cur.message(from_utf8(N_("Mark on")));
906 case LFUN_MARK_TOGGLE:
907 cur.clearSelection();
910 cur.message(from_utf8(N_("Mark removed")));
913 cur.message(from_utf8(N_("Mark set")));
918 case LFUN_SCREEN_RECENTER:
922 case LFUN_BIBTEX_DATABASE_ADD: {
923 LCursor tmpcur = cursor_;
924 bv_funcs::findInset(tmpcur, InsetBase::BIBTEX_CODE, false);
925 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
926 InsetBase::BIBTEX_CODE);
928 if (inset->addDatabase(to_utf8(cmd.argument())))
929 buffer_->updateBibfilesCache();
934 case LFUN_BIBTEX_DATABASE_DEL: {
935 LCursor tmpcur = cursor_;
936 bv_funcs::findInset(tmpcur, InsetBase::BIBTEX_CODE, false);
937 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
938 InsetBase::BIBTEX_CODE);
940 if (inset->delDatabase(to_utf8(cmd.argument())))
941 buffer_->updateBibfilesCache();
946 case LFUN_WORDS_COUNT: {
947 DocIterator from, to;
948 if (cur.selection()) {
949 from = cur.selectionBegin();
950 to = cur.selectionEnd();
952 from = doc_iterator_begin(buffer_->inset());
953 to = doc_iterator_end(buffer_->inset());
955 int const count = countWords(from, to);
959 message = bformat(_("%1$d words in selection."),
962 message = bformat(_("%1$d words in document."),
967 message = _("One word in selection.");
969 message = _("One word in document.");
972 Alert::information(_("Count words"), message);
976 case LFUN_BUFFER_TOGGLE_COMPRESSION:
977 // turn compression on/off
978 buffer_->params().compressed = !buffer_->params().compressed;
981 case LFUN_NEXT_INSET_TOGGLE: {
982 // this is the real function we want to invoke
983 FuncRequest tmpcmd = FuncRequest(LFUN_INSET_TOGGLE, cmd.origin);
984 // if there is an inset at cursor, see whether it
986 InsetBase * inset = cur.nextInset();
987 if (inset && inset->isActive()) {
988 LCursor tmpcur = cur;
989 tmpcur.pushLeft(*inset);
990 inset->dispatch(tmpcur, tmpcmd);
991 if (tmpcur.result().dispatched()) {
995 // if it did not work, try the underlying inset.
996 if (!cur.result().dispatched())
997 cur.dispatch(tmpcmd);
999 if (cur.result().dispatched())
1000 cur.clearSelection();
1006 updateFlags = Update::None;
1013 docstring const BufferView::requestSelection()
1018 LCursor & cur = cursor_;
1020 if (!cur.selection()) {
1021 xsel_cache_.set = false;
1025 if (!xsel_cache_.set ||
1026 cur.top() != xsel_cache_.cursor ||
1027 cur.anchor_.top() != xsel_cache_.anchor)
1029 xsel_cache_.cursor = cur.top();
1030 xsel_cache_.anchor = cur.anchor_.top();
1031 xsel_cache_.set = cur.selection();
1032 return cur.selectionAsString(false);
1038 void BufferView::clearSelection()
1041 cursor_.clearSelection();
1042 xsel_cache_.set = false;
1043 // The buffer did not really change, but this causes the
1044 // redraw we need because we cleared the selection above.
1050 void BufferView::workAreaResize(int width, int height)
1052 // Update from work area
1056 // The complete text metrics will be redone.
1057 text_metrics_.clear();
1064 bool BufferView::workAreaDispatch(FuncRequest const & cmd0)
1066 //lyxerr << BOOST_CURRENT_FUNCTION << "[ cmd0 " << cmd0 << "]" << endl;
1068 // This is only called for mouse related events including
1069 // LFUN_FILE_OPEN generated by drag-and-drop.
1070 FuncRequest cmd = cmd0;
1072 // E.g. Qt mouse press when no buffer
1077 cur.push(buffer_->inset());
1078 cur.selection() = cursor_.selection();
1080 // Either the inset under the cursor or the
1081 // surrounding LyXText will handle this event.
1083 // Build temporary cursor.
1084 cmd.y = min(max(cmd.y, -1), height_);
1085 InsetBase * inset = buffer_->text().editXY(cur, cmd.x, cmd.y);
1087 //lyxerr << BOOST_CURRENT_FUNCTION
1088 // << " * hit inset at tip: " << inset << endl;
1089 //lyxerr << BOOST_CURRENT_FUNCTION
1090 // << " * created temp cursor:" << cur << endl;
1092 // NOTE: editXY returns the top level inset of nested insets. If you happen
1093 // to move from a text (inset=0) to a text inside an inset (e.g. an opened
1094 // footnote inset, again inset=0), that inset will not be redrawn.
1095 if (cmd.action == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
1096 bool need_redraw = false;
1098 if (inset != last_inset_) {
1100 need_redraw |= last_inset_->setMouseHover(false);
1102 need_redraw |= inset->setMouseHover(true);
1103 last_inset_ = inset;
1106 // if last metrics update was in singlepar mode, WorkArea::redraw() will
1107 // not expose the button for redraw. We adjust here the metrics dimension
1108 // to enable a full redraw.
1109 // FIXME: It is possible to redraw only the area around the button!
1111 && metrics_info_.update_strategy == SingleParUpdate) {
1112 // FIXME: It should be possible to redraw only the area around
1113 // the button by doing this:
1115 //metrics_info_.singlepar = false;
1116 //metrics_info_.y1 = ymin of button;
1117 //metrics_info_.y2 = ymax of button;
1119 // Unfortunately, rowpainter.C:paintText() does not distinguish
1120 // between background updates and text updates. So we use the hammer
1121 // solution for now. We could also avoid the updateMetrics() below
1122 // by using the first and last pit of the CoordCache. Have a look
1123 // at LyXText::getPitNearY() to see what I mean.
1125 //metrics_info_.pit1 = first pit of CoordCache;
1126 //metrics_info_.pit2 = last pit of CoordCache;
1127 //metrics_info_.singlepar = false;
1128 //metrics_info_.y1 = 0;
1129 //metrics_info_.y2 = height_;
1131 updateMetrics(false);
1134 // This event (moving without mouse click) is not passed further.
1135 // This should be changed if it is further utilized.
1139 // Put anchor at the same position.
1142 // Try to dispatch to an non-editable inset near this position
1143 // via the temp cursor. If the inset wishes to change the real
1144 // cursor it has to do so explicitly by using
1145 // cur.bv().cursor() = cur; (or similar)
1147 inset->dispatch(cur, cmd);
1150 // Now dispatch to the temporary cursor. If the real cursor should
1151 // be modified, the inset's dispatch has to do so explicitly.
1152 if (!cur.result().dispatched())
1155 // Redraw if requested and necessary.
1156 if (cur.result().dispatched() && cur.result().update())
1157 return update(cur.result().update());
1163 void BufferView::scroll(int /*lines*/)
1168 // LyXText const * t = &buffer_->text();
1169 // int const line_height = defaultRowHeight();
1171 // // The new absolute coordinate
1172 // int new_top_y = top_y() + lines * line_height;
1174 // // Restrict to a valid value
1175 // new_top_y = std::min(t->height() - 4 * line_height, new_top_y);
1176 // new_top_y = std::max(0, new_top_y);
1178 // scrollDocView(new_top_y);
1183 void BufferView::setCursorFromRow(int row)
1188 buffer_->texrow().getIdFromRow(row, tmpid, tmppos);
1191 buffer_->text().setCursor(cursor_, 0, 0);
1193 buffer_->text().setCursor(cursor_, buffer_->getParFromID(tmpid).pit(), tmppos);
1197 void BufferView::gotoLabel(docstring const & label)
1199 for (InsetIterator it = inset_iterator_begin(buffer_->inset()); it; ++it) {
1200 vector<docstring> labels;
1201 it->getLabelList(*buffer_, labels);
1202 if (std::find(labels.begin(), labels.end(), label) != labels.end()) {
1211 LyXText * BufferView::getLyXText()
1213 LyXText * text = cursor_.innerText();
1219 LyXText const * BufferView::getLyXText() const
1221 LyXText const * text = cursor_.innerText();
1227 TextMetrics const & BufferView::textMetrics(LyXText const * t) const
1229 return const_cast<BufferView *>(this)->textMetrics(t);
1233 TextMetrics & BufferView::textMetrics(LyXText const * t)
1235 TextMetricsCache::iterator tmc_it = text_metrics_.find(t);
1236 if (tmc_it == text_metrics_.end()) {
1237 tmc_it = text_metrics_.insert(
1238 make_pair(t, TextMetrics(this, const_cast<LyXText *>(t)))).first;
1240 return tmc_it->second;
1244 ParagraphMetrics const & BufferView::parMetrics(LyXText const * t,
1247 return textMetrics(t).parMetrics(pit);
1251 int BufferView::workHeight() const
1257 void BufferView::setCursor(DocIterator const & dit)
1259 size_t const n = dit.depth();
1260 for (size_t i = 0; i < n; ++i)
1261 dit[i].inset().edit(cursor_, true);
1263 cursor_.setCursor(dit);
1264 cursor_.selection() = false;
1268 bool BufferView::checkDepm(LCursor & cur, LCursor & old)
1270 // Would be wrong to delete anything if we have a selection.
1271 if (cur.selection())
1274 bool need_anchor_change = false;
1275 bool changed = cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
1276 need_anchor_change);
1278 if (need_anchor_change)
1284 updateMetrics(false);
1290 bool BufferView::mouseSetCursor(LCursor & cur)
1292 BOOST_ASSERT(&cur.bv() == this);
1294 // Has the cursor just left the inset?
1295 bool badcursor = false;
1296 if (&cursor_.inset() != &cur.inset())
1297 badcursor = cursor_.inset().notifyCursorLeaves(cursor_);
1299 // do the dEPM magic if needed
1300 // FIXME: move this to InsetText::notifyCursorLeaves?
1301 bool update = false;
1302 if (!badcursor && cursor_.inTexted())
1303 checkDepm(cur, cursor_);
1305 // if the cursor was in an empty script inset and the new
1306 // position is in the nucleus of the inset, notifyCursorLeaves
1307 // will kill the script inset itself. So we check all the
1308 // elements of the cursor to make sure that they are correct.
1309 // For an example, see bug 2933:
1310 // http://bugzilla.lyx.org/show_bug.cgi?id=2933
1311 // The code below could maybe be moved to a DocIterator method.
1312 //lyxerr << "cur before " << cur <<std::endl;
1313 DocIterator dit(cur.inset());
1314 dit.push_back(cur.bottom());
1316 while (i < cur.depth() && dit.nextInset() == &cur[i].inset()) {
1317 dit.push_back(cur[i]);
1320 //lyxerr << "5 cur after" << dit <<std::endl;
1322 cursor_.setCursor(dit);
1323 cursor_.clearSelection();
1324 // remember new position.
1325 cursor_.setTargetX();
1331 void BufferView::putSelectionAt(DocIterator const & cur,
1332 int length, bool backwards)
1334 cursor_.clearSelection();
1340 cursor_.pos() += length;
1341 cursor_.setSelection(cursor_, -length);
1343 cursor_.setSelection(cursor_, length);
1344 theSelection().haveSelection(cursor_.selection());
1349 LCursor & BufferView::cursor()
1355 LCursor const & BufferView::cursor() const
1361 pit_type BufferView::anchor_ref() const
1367 ViewMetricsInfo const & BufferView::viewMetricsInfo()
1369 return metrics_info_;
1373 // FIXME: We should split-up updateMetrics() for the singlepar case.
1374 void BufferView::updateMetrics(bool singlepar)
1376 LyXText & buftext = buffer_->text();
1377 TextMetrics & tm = textMetrics(&buftext);
1378 pit_type size = int(buftext.paragraphs().size());
1380 if (anchor_ref_ > int(buftext.paragraphs().size() - 1)) {
1381 anchor_ref_ = int(buftext.paragraphs().size() - 1);
1385 // If the paragraph metrics has changed, we can not
1386 // use the singlepar optimisation.
1388 // In Single Paragraph mode, rebreak only
1389 // the (main text, not inset!) paragraph containing the cursor.
1390 // (if this paragraph contains insets etc., rebreaking will
1391 // recursively descend)
1392 && tm.redoParagraph(cursor_.bottom().pit()))
1395 pit_type const pit = anchor_ref_;
1398 size_t const npit = buftext.paragraphs().size();
1400 // Rebreak anchor paragraph.
1402 tm.redoParagraph(pit);
1404 // Clear out the position cache in case of full screen redraw.
1406 coord_cache_.clear();
1408 int y0 = tm.parMetrics(pit).ascent() - offset_ref_;
1410 // Redo paragraphs above anchor if necessary.
1412 while (y1 > 0 && pit1 > 0) {
1413 y1 -= tm.parMetrics(pit1).ascent();
1416 tm.redoParagraph(pit1);
1417 y1 -= tm.parMetrics(pit1).descent();
1421 // Take care of ascent of first line
1422 y1 -= tm.parMetrics(pit1).ascent();
1424 // Normalize anchor for next time
1428 // Grey at the beginning is ugly
1429 if (pit1 == 0 && y1 > 0) {
1435 // Redo paragraphs below the anchor if necessary.
1437 while (y2 < height_ && pit2 < int(npit) - 1) {
1438 y2 += tm.parMetrics(pit2).descent();
1441 tm.redoParagraph(pit2);
1442 y2 += tm.parMetrics(pit2).ascent();
1445 // Take care of descent of last line
1446 y2 += tm.parMetrics(pit2).descent();
1448 // The coordinates of all these paragraphs are correct, cache them
1450 CoordCache::InnerParPosCache & parPos = coord_cache_.parPos()[&buftext];
1451 for (pit_type pit = pit1; pit <= pit2; ++pit) {
1452 ParagraphMetrics const & pm = tm.parMetrics(pit);
1454 parPos[pit] = Point(0, y);
1455 if (singlepar && pit == cursor_.bottom().pit()) {
1456 // In Single Paragraph mode, collect here the
1457 // y1 and y2 of the (one) paragraph the cursor is in
1458 y1 = y - pm.ascent();
1459 y2 = y + pm.descent();
1465 // collect cursor paragraph iter bounds
1466 pit1 = cursor_.bottom().pit();
1467 pit2 = cursor_.bottom().pit();
1470 lyxerr[Debug::DEBUG]
1471 << BOOST_CURRENT_FUNCTION
1474 << " pit1: " << pit1
1475 << " pit2: " << pit2
1476 << " npit: " << npit
1477 << " singlepar: " << singlepar
1481 metrics_info_ = ViewMetricsInfo(pit1, pit2, y1, y2,
1482 singlepar? SingleParUpdate: FullScreenUpdate, size);
1484 if (lyxerr.debugging(Debug::WORKAREA)) {
1485 lyxerr[Debug::WORKAREA] << "BufferView::updateMetrics" << endl;
1486 coord_cache_.dump();
1491 void BufferView::menuInsertLyXFile(string const & filenm)
1493 BOOST_ASSERT(cursor_.inTexted());
1494 string filename = filenm;
1496 if (filename.empty()) {
1497 // Launch a file browser
1499 string initpath = lyxrc.document_path;
1502 string const trypath = buffer_->filePath();
1503 // If directory is writeable, use this as default.
1504 if (isDirWriteable(FileName(trypath)))
1509 FileDialog fileDlg(_("Select LyX document to insert"),
1511 make_pair(_("Documents|#o#O"), from_utf8(lyxrc.document_path)),
1512 make_pair(_("Examples|#E#e"), from_utf8(addPath(package().system_support(), "examples"))));
1514 FileDialog::Result result =
1515 fileDlg.open(from_utf8(initpath),
1516 FileFilterList(_("LyX Documents (*.lyx)")),
1519 if (result.first == FileDialog::Later)
1523 filename = to_utf8(result.second);
1525 // check selected filename
1526 if (filename.empty()) {
1527 // emit message signal.
1528 message(_("Canceled."));
1533 // Get absolute path of file and add ".lyx"
1534 // to the filename if necessary
1535 filename = fileSearch(string(), filename, "lyx").absFilename();
1537 docstring const disp_fn = makeDisplayPath(filename);
1538 // emit message signal.
1539 message(bformat(_("Inserting document %1$s..."), disp_fn));
1542 Buffer buf("", false);
1543 if (lyx::loadLyXFile(&buf, FileName(filename))) {
1544 ErrorList & el = buffer_->errorList("Parse");
1545 // Copy the inserted document error list into the current buffer one.
1546 el = buf.errorList("Parse");
1547 recordUndo(cursor_);
1548 cap::pasteParagraphList(cursor_, buf.paragraphs(),
1549 buf.params().textclass, el);
1550 res = _("Document %1$s inserted.");
1552 res = _("Could not insert document %1$s");
1554 // emit message signal.
1555 message(bformat(res, disp_fn));
1556 buffer_->errors("Parse");