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.
357 if (flags == Update::FitCursor) {
358 bool const fit_cursor = fitCursor();
360 updateMetrics(false);
361 // tell the frontend to update the screen if needed.
365 bool full_metrics = flags & Update::Force;
366 if (flags & Update::MultiParSel)
367 full_metrics |= multiParSel();
369 bool const single_par = !full_metrics;
370 updateMetrics(single_par);
372 if (flags & Update::FitCursor && fitCursor())
373 updateMetrics(false);
375 // tell the frontend to update the screen.
380 void BufferView::updateScrollbar()
383 lyxerr[Debug::DEBUG] << BOOST_CURRENT_FUNCTION
384 << " no text in updateScrollbar" << endl;
385 scrollbarParameters_.reset();
389 LyXText & t = buffer_->text();
390 TextMetrics & tm = text_metrics_[&t];
392 int const parsize = int(t.paragraphs().size() - 1);
393 if (anchor_ref_ > parsize) {
394 anchor_ref_ = parsize;
398 if (lyxerr.debugging(Debug::GUI)) {
400 << BOOST_CURRENT_FUNCTION
401 << " Updating scrollbar: height: " << t.paragraphs().size()
402 << " curr par: " << cursor_.bottom().pit()
403 << " default height " << defaultRowHeight() << endl;
406 // It would be better to fix the scrollbar to understand
407 // values in [0..1] and divide everything by wh
409 // estimated average paragraph height:
413 int h = tm.parMetrics(anchor_ref_).height();
415 // Normalize anchor/offset (MV):
416 while (offset_ref_ > h && anchor_ref_ < parsize) {
419 h = tm.parMetrics(anchor_ref_).height();
421 // Look at paragraph heights on-screen
424 for (pit_type pit = anchor_ref_; pit <= parsize; ++pit) {
427 int const h2 = tm.parMetrics(pit).height();
433 int const hav = sumh / nh;
434 // More realistic average paragraph height
439 scrollbarParameters_.height = (parsize + 1) * wh_;
440 scrollbarParameters_.position = anchor_ref_ * wh_ + int(offset_ref_ * wh_ / float(h));
441 scrollbarParameters_.lineScrollHeight = int(wh_ * defaultRowHeight() / float(h));
445 ScrollbarParameters const & BufferView::scrollbarParameters() const
447 return scrollbarParameters_;
451 void BufferView::scrollDocView(int value)
453 lyxerr[Debug::GUI] << BOOST_CURRENT_FUNCTION
454 << "[ value = " << value << "]" << endl;
459 LyXText & t = buffer_->text();
460 TextMetrics & tm = text_metrics_[&t];
462 float const bar = value / float(wh_ * t.paragraphs().size());
464 anchor_ref_ = int(bar * t.paragraphs().size());
465 if (anchor_ref_ > int(t.paragraphs().size()) - 1)
466 anchor_ref_ = int(t.paragraphs().size()) - 1;
468 tm.redoParagraph(anchor_ref_);
469 int const h = tm.parMetrics(anchor_ref_).height();
470 offset_ref_ = int((bar * t.paragraphs().size() - anchor_ref_) * h);
471 updateMetrics(false);
475 void BufferView::setCursorFromScrollbar()
477 LyXText & t = buffer_->text();
479 int const height = 2 * defaultRowHeight();
480 int const first = height;
481 int const last = height_ - height;
482 LCursor & cur = cursor_;
484 bv_funcs::CurStatus st = bv_funcs::status(this, cur);
487 case bv_funcs::CUR_ABOVE:
488 t.setCursorFromCoordinates(cur, 0, first);
489 cur.clearSelection();
491 case bv_funcs::CUR_BELOW:
492 t.setCursorFromCoordinates(cur, 0, last);
493 cur.clearSelection();
495 case bv_funcs::CUR_INSIDE:
496 int const y = bv_funcs::getPos(*this, cur, cur.boundary()).y_;
497 int const newy = min(last, max(y, first));
499 cur.reset(buffer_->inset());
500 t.setCursorFromCoordinates(cur, 0, newy);
506 Change const BufferView::getCurrentChange() const
508 if (!cursor_.selection())
509 return Change(Change::UNCHANGED);
511 DocIterator dit = cursor_.selectionBegin();
512 return dit.paragraph().lookupChange(dit.pos());
516 void BufferView::saveBookmark(bool persistent)
518 LyX::ref().session().bookmarks().save(
519 FileName(buffer_->fileName()),
521 cursor_.paragraph().id(),
526 // emit message signal.
527 message(_("Save bookmark"));
531 boost::tuple<pit_type, int> BufferView::moveToPosition(pit_type par_pit, int par_id, pos_type par_pos)
533 cursor_.clearSelection();
535 // if a valid par_id is given, try it first
537 ParIterator par = buffer_->getParFromID(par_id);
538 if (par != buffer_->par_iterator_end()) {
539 setCursor(makeDocIterator(par, min(par->size(), par_pos)));
540 return boost::make_tuple(cursor_.pit(), par_id);
543 // if par_id == 0, or searching through par_id failed
544 if (static_cast<size_t>(par_pit) < buffer_->paragraphs().size()) {
545 ParIterator it = buffer_->par_iterator_begin();
546 ParIterator const end = buffer_->par_iterator_end();
547 for (; it != end; ++it)
548 if (it.pit() == par_pit) {
549 // restored pos may be bigger than it->size
550 setCursor(makeDocIterator(it, min(par_pos, it->size())));
551 return boost::make_tuple(par_pit, it->id());
555 return boost::make_tuple(pit_type(0), 0);
559 void BufferView::switchKeyMap()
561 if (!lyxrc.rtl_support)
564 if (getLyXText()->real_current_font.isRightToLeft()) {
565 if (intl_->keymap == Intl::PRIMARY)
568 if (intl_->keymap == Intl::SECONDARY)
574 int BufferView::workWidth() const
580 void BufferView::center()
582 CursorSlice & bot = cursor_.bottom();
583 TextMetrics & tm = text_metrics_[bot.text()];
584 pit_type const pit = bot.pit();
585 tm.redoParagraph(pit);
586 ParagraphMetrics const & pm = tm.parMetrics(pit);
588 offset_ref_ = bv_funcs::coordOffset(*this, cursor_, cursor_.boundary()).y_
589 + pm.ascent() - height_ / 2;
593 FuncStatus BufferView::getStatus(FuncRequest const & cmd)
597 switch (cmd.action) {
600 flag.enabled(!buffer_->undostack().empty());
603 flag.enabled(!buffer_->redostack().empty());
605 case LFUN_FILE_INSERT:
606 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
607 case LFUN_FILE_INSERT_PLAINTEXT:
608 case LFUN_BOOKMARK_SAVE:
609 // FIXME: Actually, these LFUNS should be moved to LyXText
610 flag.enabled(cursor_.inTexted());
612 case LFUN_FONT_STATE:
613 case LFUN_LABEL_INSERT:
614 case LFUN_PARAGRAPH_GOTO:
615 // FIXME handle non-trivially
616 case LFUN_OUTLINE_UP:
617 case LFUN_OUTLINE_DOWN:
618 case LFUN_OUTLINE_IN:
619 case LFUN_OUTLINE_OUT:
621 case LFUN_REFERENCE_NEXT:
623 case LFUN_WORD_REPLACE:
626 case LFUN_MARK_TOGGLE:
627 case LFUN_SCREEN_RECENTER:
628 case LFUN_BIBTEX_DATABASE_ADD:
629 case LFUN_BIBTEX_DATABASE_DEL:
630 case LFUN_WORDS_COUNT:
631 case LFUN_NEXT_INSET_TOGGLE:
635 case LFUN_LABEL_GOTO: {
636 flag.enabled(!cmd.argument().empty()
637 || getInsetByCode<InsetRef>(cursor_, InsetBase::REF_CODE));
641 case LFUN_CHANGES_TRACK:
643 flag.setOnOff(buffer_->params().trackChanges);
646 case LFUN_CHANGES_OUTPUT: {
647 OutputParams runparams;
648 LaTeXFeatures features(*buffer_, buffer_->params(), runparams);
649 flag.enabled(buffer_ && features.isAvailable("dvipost"));
650 flag.setOnOff(buffer_->params().outputChanges);
654 case LFUN_CHANGES_MERGE:
655 case LFUN_CHANGE_NEXT:
656 case LFUN_ALL_CHANGES_ACCEPT:
657 case LFUN_ALL_CHANGES_REJECT:
658 // TODO: context-sensitive enabling of LFUNs
659 // In principle, these command should only be enabled if there
660 // is a change in the document. However, without proper
661 // optimizations, this will inevitably result in poor performance.
662 flag.enabled(buffer_);
665 case LFUN_BUFFER_TOGGLE_COMPRESSION: {
666 flag.setOnOff(buffer_->params().compressed);
678 bool BufferView::dispatch(FuncRequest const & cmd)
680 //lyxerr << BOOST_CURRENT_FUNCTION
681 // << [ cmd = " << cmd << "]" << endl;
683 // Make sure that the cached BufferView is correct.
684 lyxerr[Debug::ACTION] << BOOST_CURRENT_FUNCTION
685 << " action[" << cmd.action << ']'
686 << " arg[" << to_utf8(cmd.argument()) << ']'
687 << " x[" << cmd.x << ']'
688 << " y[" << cmd.y << ']'
689 << " button[" << cmd.button() << ']'
692 LCursor & cur = cursor_;
694 switch (cmd.action) {
698 cur.message(_("Undo"));
699 cur.clearSelection();
700 if (!textUndo(*this))
701 cur.message(_("No further undo information"));
709 cur.message(_("Redo"));
710 cur.clearSelection();
711 if (!textRedo(*this))
712 cur.message(_("No further redo information"));
718 case LFUN_FILE_INSERT:
720 menuInsertLyXFile(to_utf8(cmd.argument()));
723 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
725 insertPlaintextFile(this, to_utf8(cmd.argument()), true);
728 case LFUN_FILE_INSERT_PLAINTEXT:
730 insertPlaintextFile(this, to_utf8(cmd.argument()), false);
733 case LFUN_FONT_STATE:
734 cur.message(cur.currentState());
737 case LFUN_BOOKMARK_SAVE:
738 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
741 case LFUN_LABEL_GOTO: {
742 docstring label = cmd.argument();
745 getInsetByCode<InsetRef>(cursor_,
746 InsetBase::REF_CODE);
748 label = inset->getParam("reference");
749 // persistent=false: use temp_bookmark
759 case LFUN_PARAGRAPH_GOTO: {
760 int const id = convert<int>(to_utf8(cmd.argument()));
762 for (Buffer * b = buffer_; i == 0 || b != buffer_; b = theBufferList().next(b)) {
763 ParIterator par = b->getParFromID(id);
764 if (par == b->par_iterator_end()) {
766 << "No matching paragraph found! ["
767 << id << "]." << endl;
770 << "Paragraph " << par->id()
771 << " found in buffer `"
772 << b->fileName() << "'." << endl;
776 setCursor(makeDocIterator(par, 0));
780 // Switch to other buffer view and resend cmd
781 theLyXFunc().dispatch(FuncRequest(
782 LFUN_BUFFER_SWITCH, b->fileName()));
783 theLyXFunc().dispatch(cmd);
792 case LFUN_OUTLINE_UP:
793 toc::outline(toc::Up, cursor_);
794 cursor_.text()->setCursor(cursor_, cursor_.pit(), 0);
795 updateLabels(*buffer_);
797 case LFUN_OUTLINE_DOWN:
798 toc::outline(toc::Down, cursor_);
799 cursor_.text()->setCursor(cursor_, cursor_.pit(), 0);
800 updateLabels(*buffer_);
802 case LFUN_OUTLINE_IN:
803 toc::outline(toc::In, cursor_);
804 updateLabels(*buffer_);
806 case LFUN_OUTLINE_OUT:
807 toc::outline(toc::Out, cursor_);
808 updateLabels(*buffer_);
812 bv_funcs::gotoInset(this, InsetBase::NOTE_CODE, false);
815 case LFUN_REFERENCE_NEXT: {
816 vector<InsetBase_code> tmp;
817 tmp.push_back(InsetBase::LABEL_CODE);
818 tmp.push_back(InsetBase::REF_CODE);
819 bv_funcs::gotoInset(this, tmp, true);
823 case LFUN_CHANGES_TRACK:
824 buffer_->params().trackChanges = !buffer_->params().trackChanges;
827 case LFUN_CHANGES_OUTPUT: {
828 buffer_->params().outputChanges = !buffer_->params().outputChanges;
832 case LFUN_CHANGE_NEXT:
833 findNextChange(this);
836 case LFUN_CHANGES_MERGE:
837 if (findNextChange(this))
838 showDialog("changes");
841 case LFUN_ALL_CHANGES_ACCEPT: {
842 cursor_.reset(buffer_->inset());
844 #warning FIXME changes
846 while (findNextChange(this))
847 getLyXText()->acceptChange(cursor_);
852 case LFUN_ALL_CHANGES_REJECT: {
853 cursor_.reset(buffer_->inset());
855 #warning FIXME changes
857 while (findNextChange(this))
858 getLyXText()->rejectChange(cursor_);
866 case LFUN_WORD_REPLACE:
871 cur.clearSelection();
873 cur.message(from_utf8(N_("Mark off")));
877 cur.clearSelection();
880 cur.message(from_utf8(N_("Mark on")));
883 case LFUN_MARK_TOGGLE:
884 cur.clearSelection();
887 cur.message(from_utf8(N_("Mark removed")));
890 cur.message(from_utf8(N_("Mark set")));
895 case LFUN_SCREEN_RECENTER:
899 case LFUN_BIBTEX_DATABASE_ADD: {
900 LCursor tmpcur = cursor_;
901 bv_funcs::findInset(tmpcur, InsetBase::BIBTEX_CODE, false);
902 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
903 InsetBase::BIBTEX_CODE);
905 if (inset->addDatabase(to_utf8(cmd.argument())))
906 buffer_->updateBibfilesCache();
911 case LFUN_BIBTEX_DATABASE_DEL: {
912 LCursor tmpcur = cursor_;
913 bv_funcs::findInset(tmpcur, InsetBase::BIBTEX_CODE, false);
914 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
915 InsetBase::BIBTEX_CODE);
917 if (inset->delDatabase(to_utf8(cmd.argument())))
918 buffer_->updateBibfilesCache();
923 case LFUN_WORDS_COUNT: {
924 DocIterator from, to;
925 if (cur.selection()) {
926 from = cur.selectionBegin();
927 to = cur.selectionEnd();
929 from = doc_iterator_begin(buffer_->inset());
930 to = doc_iterator_end(buffer_->inset());
932 int const count = countWords(from, to);
936 message = bformat(_("%1$d words in selection."),
939 message = bformat(_("%1$d words in document."),
944 message = _("One word in selection.");
946 message = _("One word in document.");
949 Alert::information(_("Count words"), message);
953 case LFUN_BUFFER_TOGGLE_COMPRESSION:
954 // turn compression on/off
955 buffer_->params().compressed = !buffer_->params().compressed;
958 case LFUN_NEXT_INSET_TOGGLE: {
959 // this is the real function we want to invoke
960 FuncRequest tmpcmd = FuncRequest(LFUN_INSET_TOGGLE, cmd.origin);
961 // if there is an inset at cursor, see whether it
963 InsetBase * inset = cur.nextInset();
964 if (inset && inset->isActive()) {
965 LCursor tmpcur = cur;
966 tmpcur.pushLeft(*inset);
967 inset->dispatch(tmpcur, tmpcmd);
968 if (tmpcur.result().dispatched()) {
972 // if it did not work, try the underlying inset.
973 if (!cur.result().dispatched())
974 cur.dispatch(tmpcmd);
976 if (cur.result().dispatched())
977 cur.clearSelection();
990 docstring const BufferView::requestSelection()
995 LCursor & cur = cursor_;
997 if (!cur.selection()) {
998 xsel_cache_.set = false;
1002 if (!xsel_cache_.set ||
1003 cur.top() != xsel_cache_.cursor ||
1004 cur.anchor_.top() != xsel_cache_.anchor)
1006 xsel_cache_.cursor = cur.top();
1007 xsel_cache_.anchor = cur.anchor_.top();
1008 xsel_cache_.set = cur.selection();
1009 return cur.selectionAsString(false);
1015 void BufferView::clearSelection()
1018 cursor_.clearSelection();
1019 xsel_cache_.set = false;
1020 // The buffer did not really change, but this causes the
1021 // redraw we need because we cleared the selection above.
1027 void BufferView::workAreaResize(int width, int height)
1029 // Update from work area
1033 // The complete text metrics will be redone.
1034 text_metrics_.clear();
1041 bool BufferView::workAreaDispatch(FuncRequest const & cmd0)
1043 //lyxerr << BOOST_CURRENT_FUNCTION << "[ cmd0 " << cmd0 << "]" << endl;
1045 // This is only called for mouse related events including
1046 // LFUN_FILE_OPEN generated by drag-and-drop.
1047 FuncRequest cmd = cmd0;
1049 // E.g. Qt mouse press when no buffer
1054 cur.push(buffer_->inset());
1055 cur.selection() = cursor_.selection();
1057 // Either the inset under the cursor or the
1058 // surrounding LyXText will handle this event.
1060 // Build temporary cursor.
1061 cmd.y = min(max(cmd.y, -1), height_);
1062 InsetBase * inset = buffer_->text().editXY(cur, cmd.x, cmd.y);
1064 //lyxerr << BOOST_CURRENT_FUNCTION
1065 // << " * hit inset at tip: " << inset << endl;
1066 //lyxerr << BOOST_CURRENT_FUNCTION
1067 // << " * created temp cursor:" << cur << endl;
1069 // NOTE: editXY returns the top level inset of nested insets. If you happen
1070 // to move from a text (inset=0) to a text inside an inset (e.g. an opened
1071 // footnote inset, again inset=0), that inset will not be redrawn.
1072 if (cmd.action == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
1073 bool need_redraw = false;
1075 if (inset != last_inset_) {
1077 need_redraw |= last_inset_->setMouseHover(false);
1079 need_redraw |= inset->setMouseHover(true);
1080 last_inset_ = inset;
1083 // if last metrics update was in singlepar mode, WorkArea::redraw() will
1084 // not expose the button for redraw. We adjust here the metrics dimension
1085 // to enable a full redraw.
1086 // FIXME: It is possible to redraw only the area around the button!
1087 if (need_redraw && metrics_info_.singlepar) {
1088 // FIXME: It should be possible to redraw only the area around
1089 // the button by doing this:
1091 //metrics_info_.singlepar = false;
1092 //metrics_info_.y1 = ymin of button;
1093 //metrics_info_.y2 = ymax of button;
1095 // Unfortunately, rowpainter.C:paintText() does not distinguish
1096 // between background updates and text updates. So we use the hammer
1097 // solution for now. We could also avoid the updateMetrics() below
1098 // by using the first and last pit of the CoordCache. Have a look
1099 // at LyXText::getPitNearY() to see what I mean.
1101 //metrics_info_.pit1 = first pit of CoordCache;
1102 //metrics_info_.pit2 = last pit of CoordCache;
1103 //metrics_info_.singlepar = false;
1104 //metrics_info_.y1 = 0;
1105 //metrics_info_.y2 = height_;
1107 updateMetrics(false);
1110 // This event (moving without mouse click) is not passed further.
1111 // This should be changed if it is further utilized.
1115 // Put anchor at the same position.
1118 // Try to dispatch to an non-editable inset near this position
1119 // via the temp cursor. If the inset wishes to change the real
1120 // cursor it has to do so explicitly by using
1121 // cur.bv().cursor() = cur; (or similar)
1123 inset->dispatch(cur, cmd);
1126 // Now dispatch to the temporary cursor. If the real cursor should
1127 // be modified, the inset's dispatch has to do so explicitly.
1128 if (!cur.result().dispatched())
1131 // Redraw if requested and necessary.
1132 if (cur.result().dispatched() && cur.result().update())
1133 return update(cur.result().update());
1139 void BufferView::scroll(int /*lines*/)
1144 // LyXText const * t = &buffer_->text();
1145 // int const line_height = defaultRowHeight();
1147 // // The new absolute coordinate
1148 // int new_top_y = top_y() + lines * line_height;
1150 // // Restrict to a valid value
1151 // new_top_y = std::min(t->height() - 4 * line_height, new_top_y);
1152 // new_top_y = std::max(0, new_top_y);
1154 // scrollDocView(new_top_y);
1159 void BufferView::setCursorFromRow(int row)
1164 buffer_->texrow().getIdFromRow(row, tmpid, tmppos);
1167 buffer_->text().setCursor(cursor_, 0, 0);
1169 buffer_->text().setCursor(cursor_, buffer_->getParFromID(tmpid).pit(), tmppos);
1173 void BufferView::gotoLabel(docstring const & label)
1175 for (InsetIterator it = inset_iterator_begin(buffer_->inset()); it; ++it) {
1176 vector<docstring> labels;
1177 it->getLabelList(*buffer_, labels);
1178 if (std::find(labels.begin(), labels.end(), label) != labels.end()) {
1187 LyXText * BufferView::getLyXText()
1189 LyXText * text = cursor_.innerText();
1195 LyXText const * BufferView::getLyXText() const
1197 LyXText const * text = cursor_.innerText();
1203 TextMetrics const & BufferView::textMetrics(LyXText const * t) const
1205 return const_cast<BufferView *>(this)->textMetrics(t);
1209 TextMetrics & BufferView::textMetrics(LyXText const * t)
1211 TextMetricsCache::iterator tmc_it = text_metrics_.find(t);
1212 if (tmc_it == text_metrics_.end()) {
1213 tmc_it = text_metrics_.insert(
1214 make_pair(t, TextMetrics(this, const_cast<LyXText *>(t)))).first;
1216 return tmc_it->second;
1220 ParagraphMetrics const & BufferView::parMetrics(LyXText const * t,
1223 return textMetrics(t).parMetrics(pit);
1227 int BufferView::workHeight() const
1233 void BufferView::setCursor(DocIterator const & dit)
1235 size_t const n = dit.depth();
1236 for (size_t i = 0; i < n; ++i)
1237 dit[i].inset().edit(cursor_, true);
1239 cursor_.setCursor(dit);
1240 cursor_.selection() = false;
1244 bool BufferView::checkDepm(LCursor & cur, LCursor & old)
1246 // Would be wrong to delete anything if we have a selection.
1247 if (cur.selection())
1250 bool need_anchor_change = false;
1251 bool changed = cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
1252 need_anchor_change);
1254 if (need_anchor_change)
1260 updateMetrics(false);
1266 bool BufferView::mouseSetCursor(LCursor & cur)
1268 BOOST_ASSERT(&cur.bv() == this);
1270 // Has the cursor just left the inset?
1271 bool badcursor = false;
1272 if (&cursor_.inset() != &cur.inset())
1273 badcursor = cursor_.inset().notifyCursorLeaves(cursor_);
1275 // do the dEPM magic if needed
1276 // FIXME: move this to InsetText::notifyCursorLeaves?
1277 bool update = false;
1278 if (!badcursor && cursor_.inTexted())
1279 checkDepm(cur, cursor_);
1282 cursor_.clearSelection();
1283 // remember new position.
1284 cursor_.setTargetX();
1290 void BufferView::putSelectionAt(DocIterator const & cur,
1291 int length, bool backwards)
1293 cursor_.clearSelection();
1299 cursor_.pos() += length;
1300 cursor_.setSelection(cursor_, -length);
1302 cursor_.setSelection(cursor_, length);
1303 theSelection().haveSelection(cursor_.selection());
1308 LCursor & BufferView::cursor()
1314 LCursor const & BufferView::cursor() const
1320 pit_type BufferView::anchor_ref() const
1326 ViewMetricsInfo const & BufferView::viewMetricsInfo()
1328 return metrics_info_;
1332 // FIXME: We should split-up updateMetrics() for the singlepar case.
1333 void BufferView::updateMetrics(bool singlepar)
1335 LyXText & buftext = buffer_->text();
1336 TextMetrics & tm = textMetrics(&buftext);
1337 pit_type size = int(buftext.paragraphs().size());
1339 if (anchor_ref_ > int(buftext.paragraphs().size() - 1)) {
1340 anchor_ref_ = int(buftext.paragraphs().size() - 1);
1344 // If the paragraph metrics has changed, we can not
1345 // use the singlepar optimisation.
1347 // In Single Paragraph mode, rebreak only
1348 // the (main text, not inset!) paragraph containing the cursor.
1349 // (if this paragraph contains insets etc., rebreaking will
1350 // recursively descend)
1351 && tm.redoParagraph(cursor_.bottom().pit()))
1354 pit_type const pit = anchor_ref_;
1357 size_t const npit = buftext.paragraphs().size();
1359 // Rebreak anchor paragraph.
1361 tm.redoParagraph(pit);
1363 // Clear out the position cache in case of full screen redraw.
1365 coord_cache_.clear();
1367 int y0 = tm.parMetrics(pit).ascent() - offset_ref_;
1369 // Redo paragraphs above anchor if necessary.
1371 while (y1 > 0 && pit1 > 0) {
1372 y1 -= tm.parMetrics(pit1).ascent();
1375 tm.redoParagraph(pit1);
1376 y1 -= tm.parMetrics(pit1).descent();
1380 // Take care of ascent of first line
1381 y1 -= tm.parMetrics(pit1).ascent();
1383 // Normalize anchor for next time
1387 // Grey at the beginning is ugly
1388 if (pit1 == 0 && y1 > 0) {
1394 // Redo paragraphs below the anchor if necessary.
1396 while (y2 < height_ && pit2 < int(npit) - 1) {
1397 y2 += tm.parMetrics(pit2).descent();
1400 tm.redoParagraph(pit2);
1401 y2 += tm.parMetrics(pit2).ascent();
1404 // Take care of descent of last line
1405 y2 += tm.parMetrics(pit2).descent();
1407 // The coordinates of all these paragraphs are correct, cache them
1409 CoordCache::InnerParPosCache & parPos = coord_cache_.parPos()[&buftext];
1410 for (pit_type pit = pit1; pit <= pit2; ++pit) {
1411 ParagraphMetrics const & pm = tm.parMetrics(pit);
1413 parPos[pit] = Point(0, y);
1414 if (singlepar && pit == cursor_.bottom().pit()) {
1415 // In Single Paragraph mode, collect here the
1416 // y1 and y2 of the (one) paragraph the cursor is in
1417 y1 = y - pm.ascent();
1418 y2 = y + pm.descent();
1424 // collect cursor paragraph iter bounds
1425 pit1 = cursor_.bottom().pit();
1426 pit2 = cursor_.bottom().pit();
1429 lyxerr[Debug::DEBUG]
1430 << BOOST_CURRENT_FUNCTION
1433 << " pit1: " << pit1
1434 << " pit2: " << pit2
1435 << " npit: " << npit
1436 << " singlepar: " << singlepar
1440 metrics_info_ = ViewMetricsInfo(pit1, pit2, y1, y2, singlepar, size);
1442 if (lyxerr.debugging(Debug::WORKAREA)) {
1443 lyxerr[Debug::WORKAREA] << "BufferView::updateMetrics" << endl;
1444 coord_cache_.dump();
1449 void BufferView::menuInsertLyXFile(string const & filenm)
1451 BOOST_ASSERT(cursor_.inTexted());
1452 string filename = filenm;
1454 if (filename.empty()) {
1455 // Launch a file browser
1457 string initpath = lyxrc.document_path;
1460 string const trypath = buffer_->filePath();
1461 // If directory is writeable, use this as default.
1462 if (isDirWriteable(FileName(trypath)))
1467 FileDialog fileDlg(_("Select LyX document to insert"),
1469 make_pair(_("Documents|#o#O"), from_utf8(lyxrc.document_path)),
1470 make_pair(_("Examples|#E#e"), from_utf8(addPath(package().system_support(), "examples"))));
1472 FileDialog::Result result =
1473 fileDlg.open(from_utf8(initpath),
1474 FileFilterList(_("LyX Documents (*.lyx)")),
1477 if (result.first == FileDialog::Later)
1481 filename = to_utf8(result.second);
1483 // check selected filename
1484 if (filename.empty()) {
1485 // emit message signal.
1486 message(_("Canceled."));
1491 // Get absolute path of file and add ".lyx"
1492 // to the filename if necessary
1493 filename = fileSearch(string(), filename, "lyx").absFilename();
1495 docstring const disp_fn = makeDisplayPath(filename);
1496 // emit message signal.
1497 message(bformat(_("Inserting document %1$s..."), disp_fn));
1500 Buffer buf("", false);
1501 if (lyx::loadLyXFile(&buf, FileName(filename))) {
1502 ErrorList & el = buffer_->errorList("Parse");
1503 // Copy the inserted document error list into the current buffer one.
1504 el = buf.errorList("Parse");
1505 recordUndo(cursor_);
1506 cap::pasteParagraphList(cursor_, buf.paragraphs(),
1507 buf.params().textclass, el);
1508 res = _("Document %1$s inserted.");
1510 res = _("Could not insert document %1$s");
1512 // emit message signal.
1513 message(bformat(res, disp_fn));
1514 buffer_->errors("Parse");