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 updateLabels(*buffer_);
192 buffer_->text().setCurrentFont(cursor_);
193 if (buffer_->getCursor().size() > 0 &&
194 buffer_->getAnchor().size() > 0)
196 cursor_.setCursor(buffer_->getAnchor().asDocIterator(&(buffer_->inset())));
197 cursor_.resetAnchor();
198 cursor_.setCursor(buffer_->getCursor().asDocIterator(&(buffer_->inset())));
199 cursor_.setSelection();
200 theSelection().haveSelection(cursor_.selection());
205 updateMetrics(false);
207 if (buffer_ && graphics::Previews::status() != LyXRC::PREVIEW_OFF)
208 graphics::Previews::get().generateBufferPreviews(*buffer_);
212 bool BufferView::loadLyXFile(FileName const & filename, bool tolastfiles)
214 // File already open?
215 if (theBufferList().exists(filename.absFilename())) {
216 docstring const file = makeDisplayPath(filename.absFilename(), 20);
217 docstring text = bformat(_("The document %1$s is already "
218 "loaded.\n\nDo you want to revert "
219 "to the saved version?"), file);
220 int const ret = Alert::prompt(_("Revert to saved document?"),
221 text, 0, 1, _("&Revert"), _("&Switch to document"));
224 setBuffer(theBufferList().getBuffer(filename.absFilename()));
227 // FIXME: should be LFUN_REVERT
228 if (!theBufferList().close(theBufferList().getBuffer(filename.absFilename()), false))
230 // Fall through to new load. (Asger)
236 if (isFileReadable(filename)) {
237 b = theBufferList().newBuffer(filename.absFilename());
238 if (!lyx::loadLyXFile(b, filename)) {
239 theBufferList().release(b);
243 docstring text = bformat(_("The document %1$s does not yet "
244 "exist.\n\nDo you want to create "
245 "a new document?"), from_utf8(filename.absFilename()));
246 int const ret = Alert::prompt(_("Create new document?"),
247 text, 0, 1, _("&Create"), _("Cancel"));
250 b = newFile(filename.absFilename(), string(), true);
258 // Send the "errors" signal in case of parsing errors
261 // scroll to the position when the file was last closed
262 if (lyxrc.use_lastfilepos) {
265 boost::tie(pit, pos) = LyX::ref().session().lastFilePos().load(filename);
266 // I am not sure how to separate the following part to a function
267 // so I will leave this to Lars.
269 // check pit since the document may be externally changed.
270 if ( static_cast<size_t>(pit) < b->paragraphs().size() ) {
271 ParIterator it = b->par_iterator_begin();
272 ParIterator const end = b->par_iterator_end();
273 for (; it != end; ++it)
274 if (it.pit() == pit) {
275 // restored pos may be bigger than it->size
276 setCursor(makeDocIterator(it, min(pos, it->size())));
277 // No need to update the metrics if fitCursor returns false.
279 updateMetrics(false);
286 LyX::ref().session().lastFiles().add(FileName(b->fileName()));
292 void BufferView::reload()
294 if (theBufferList().close(buffer_, false))
295 loadLyXFile(FileName(buffer_->fileName()));
299 void BufferView::resize()
304 lyxerr[Debug::DEBUG] << BOOST_CURRENT_FUNCTION << endl;
306 updateMetrics(false);
311 bool BufferView::fitCursor()
313 if (bv_funcs::status(this, cursor_) == bv_funcs::CUR_INSIDE) {
314 frontend::FontMetrics const & fm =
315 theFontMetrics(cursor_.getFont());
316 int const asc = fm.maxAscent();
317 int const des = fm.maxDescent();
318 Point const p = bv_funcs::getPos(*this, cursor_, cursor_.boundary());
319 if (p.y_ - asc >= 0 && p.y_ + des < height_)
327 bool BufferView::multiParSel()
329 if (!cursor_.selection())
331 bool ret = multiparsel_cache_;
332 multiparsel_cache_ = cursor_.selBegin().pit() != cursor_.selEnd().pit();
333 // Either this, or previous selection spans paragraphs
334 return ret || multiparsel_cache_;
338 bool BufferView::update(Update::flags flags)
340 // last_inset_ points to the last visited inset. This pointer may become
341 // invalid because of keyboard editing. Since all such operations
342 // causes screen update(), I reset last_inset_ to avoid such a problem.
344 // This is close to a hot-path.
345 if (lyxerr.debugging(Debug::DEBUG)) {
347 << BOOST_CURRENT_FUNCTION
348 << "[fitcursor = " << (flags & Update::FitCursor)
349 << ", forceupdate = " << (flags & Update::Force)
350 << ", singlepar = " << (flags & Update::SinglePar)
351 << "] buffer: " << buffer_ << endl;
354 // Check needed to survive LyX startup
358 if (lyxerr.debugging(Debug::WORKAREA)) {
359 lyxerr[Debug::WORKAREA] << "BufferView::update" << std::endl;
362 // Update macro store
363 buffer_->buildMacros();
365 // Now do the first drawing step if needed. This consists on updating
366 // the CoordCache in updateMetrics().
367 // The second drawing step is done in WorkArea::redraw() if needed.
369 // Case when no explicit update is requested.
371 // no need to redraw anything.
375 if (flags == Update::FitCursor) {
376 bool const fit_cursor = fitCursor();
378 updateMetrics(false);
379 // tell the frontend to update the screen if needed.
383 bool full_metrics = flags & Update::Force;
384 if (flags & Update::MultiParSel)
385 full_metrics |= multiParSel();
387 bool const single_par = !full_metrics;
388 updateMetrics(single_par);
390 if (flags & Update::FitCursor && fitCursor())
391 updateMetrics(false);
393 // tell the frontend to update the screen.
398 void BufferView::updateScrollbar()
401 lyxerr[Debug::DEBUG] << BOOST_CURRENT_FUNCTION
402 << " no text in updateScrollbar" << endl;
403 scrollbarParameters_.reset();
407 LyXText & t = buffer_->text();
408 TextMetrics & tm = text_metrics_[&t];
410 int const parsize = int(t.paragraphs().size() - 1);
411 if (anchor_ref_ > parsize) {
412 anchor_ref_ = parsize;
416 if (lyxerr.debugging(Debug::GUI)) {
418 << BOOST_CURRENT_FUNCTION
419 << " Updating scrollbar: height: " << t.paragraphs().size()
420 << " curr par: " << cursor_.bottom().pit()
421 << " default height " << defaultRowHeight() << endl;
424 // It would be better to fix the scrollbar to understand
425 // values in [0..1] and divide everything by wh
427 // estimated average paragraph height:
431 int h = tm.parMetrics(anchor_ref_).height();
433 // Normalize anchor/offset (MV):
434 while (offset_ref_ > h && anchor_ref_ < parsize) {
437 h = tm.parMetrics(anchor_ref_).height();
439 // Look at paragraph heights on-screen
442 for (pit_type pit = anchor_ref_; pit <= parsize; ++pit) {
445 int const h2 = tm.parMetrics(pit).height();
451 int const hav = sumh / nh;
452 // More realistic average paragraph height
457 scrollbarParameters_.height = (parsize + 1) * wh_;
458 scrollbarParameters_.position = anchor_ref_ * wh_ + int(offset_ref_ * wh_ / float(h));
459 scrollbarParameters_.lineScrollHeight = int(wh_ * defaultRowHeight() / float(h));
463 ScrollbarParameters const & BufferView::scrollbarParameters() const
465 return scrollbarParameters_;
469 void BufferView::scrollDocView(int value)
471 lyxerr[Debug::GUI] << BOOST_CURRENT_FUNCTION
472 << "[ value = " << value << "]" << endl;
477 LyXText & t = buffer_->text();
478 TextMetrics & tm = text_metrics_[&t];
480 float const bar = value / float(wh_ * t.paragraphs().size());
482 anchor_ref_ = int(bar * t.paragraphs().size());
483 if (anchor_ref_ > int(t.paragraphs().size()) - 1)
484 anchor_ref_ = int(t.paragraphs().size()) - 1;
486 tm.redoParagraph(anchor_ref_);
487 int const h = tm.parMetrics(anchor_ref_).height();
488 offset_ref_ = int((bar * t.paragraphs().size() - anchor_ref_) * h);
489 updateMetrics(false);
493 void BufferView::setCursorFromScrollbar()
495 LyXText & t = buffer_->text();
497 int const height = 2 * defaultRowHeight();
498 int const first = height;
499 int const last = height_ - height;
500 LCursor & cur = cursor_;
502 bv_funcs::CurStatus st = bv_funcs::status(this, cur);
505 case bv_funcs::CUR_ABOVE:
506 t.setCursorFromCoordinates(cur, 0, first);
507 cur.clearSelection();
509 case bv_funcs::CUR_BELOW:
510 t.setCursorFromCoordinates(cur, 0, last);
511 cur.clearSelection();
513 case bv_funcs::CUR_INSIDE:
514 int const y = bv_funcs::getPos(*this, cur, cur.boundary()).y_;
515 int const newy = min(last, max(y, first));
517 cur.reset(buffer_->inset());
518 t.setCursorFromCoordinates(cur, 0, newy);
524 Change const BufferView::getCurrentChange() const
526 if (!cursor_.selection())
527 return Change(Change::UNCHANGED);
529 DocIterator dit = cursor_.selectionBegin();
530 return dit.paragraph().lookupChange(dit.pos());
534 void BufferView::saveBookmark(bool persistent)
536 LyX::ref().session().bookmarks().save(
537 FileName(buffer_->fileName()),
538 cursor_.paragraph().id(),
543 // emit message signal.
544 message(_("Save bookmark"));
548 void BufferView::moveToPosition(int par_id, pos_type par_pos)
550 cursor_.clearSelection();
552 ParIterator par = buffer_->getParFromID(par_id);
553 if (par == buffer_->par_iterator_end())
556 setCursor(makeDocIterator(par, min(par->size(), par_pos)));
560 void BufferView::switchKeyMap()
562 if (!lyxrc.rtl_support)
565 if (getLyXText()->real_current_font.isRightToLeft()) {
566 if (intl_->keymap == Intl::PRIMARY)
569 if (intl_->keymap == Intl::SECONDARY)
575 int BufferView::workWidth() const
581 void BufferView::center()
583 CursorSlice & bot = cursor_.bottom();
584 TextMetrics & tm = text_metrics_[bot.text()];
585 pit_type const pit = bot.pit();
586 tm.redoParagraph(pit);
587 ParagraphMetrics const & pm = tm.parMetrics(pit);
589 offset_ref_ = bv_funcs::coordOffset(*this, cursor_, cursor_.boundary()).y_
590 + pm.ascent() - height_ / 2;
594 FuncStatus BufferView::getStatus(FuncRequest const & cmd)
598 switch (cmd.action) {
601 flag.enabled(!buffer_->undostack().empty());
604 flag.enabled(!buffer_->redostack().empty());
606 case LFUN_FILE_INSERT:
607 case LFUN_FILE_INSERT_ASCII_PARA:
608 case LFUN_FILE_INSERT_ASCII:
609 case LFUN_BOOKMARK_SAVE:
610 // FIXME: Actually, these LFUNS should be moved to LyXText
611 flag.enabled(cursor_.inTexted());
613 case LFUN_FONT_STATE:
614 case LFUN_LABEL_INSERT:
615 case LFUN_PARAGRAPH_GOTO:
616 // FIXME handle non-trivially
617 case LFUN_OUTLINE_UP:
618 case LFUN_OUTLINE_DOWN:
619 case LFUN_OUTLINE_IN:
620 case LFUN_OUTLINE_OUT:
622 case LFUN_REFERENCE_NEXT:
624 case LFUN_WORD_REPLACE:
627 case LFUN_MARK_TOGGLE:
628 case LFUN_SCREEN_RECENTER:
629 case LFUN_BIBTEX_DATABASE_ADD:
630 case LFUN_BIBTEX_DATABASE_DEL:
631 case LFUN_WORDS_COUNT:
632 case LFUN_NEXT_INSET_TOGGLE:
636 case LFUN_LABEL_GOTO: {
637 flag.enabled(!cmd.argument().empty()
638 || getInsetByCode<InsetRef>(cursor_, InsetBase::REF_CODE));
642 case LFUN_CHANGES_TRACK:
644 flag.setOnOff(buffer_->params().trackChanges);
647 case LFUN_CHANGES_OUTPUT: {
648 OutputParams runparams;
649 LaTeXFeatures features(*buffer_, buffer_->params(), runparams);
650 flag.enabled(buffer_ && features.isAvailable("dvipost"));
651 flag.setOnOff(buffer_->params().outputChanges);
655 case LFUN_CHANGES_MERGE:
656 case LFUN_CHANGE_NEXT:
657 case LFUN_ALL_CHANGES_ACCEPT:
658 case LFUN_ALL_CHANGES_REJECT:
659 // TODO: context-sensitive enabling of LFUNs
660 // In principle, these command should only be enabled if there
661 // is a change in the document. However, without proper
662 // optimizations, this will inevitably result in poor performance.
663 flag.enabled(buffer_);
666 case LFUN_BUFFER_TOGGLE_COMPRESSION: {
667 flag.setOnOff(buffer_->params().compressed);
679 bool BufferView::dispatch(FuncRequest const & cmd)
681 //lyxerr << BOOST_CURRENT_FUNCTION
682 // << [ cmd = " << cmd << "]" << endl;
684 // Make sure that the cached BufferView is correct.
685 lyxerr[Debug::ACTION] << BOOST_CURRENT_FUNCTION
686 << " action[" << cmd.action << ']'
687 << " arg[" << to_utf8(cmd.argument()) << ']'
688 << " x[" << cmd.x << ']'
689 << " y[" << cmd.y << ']'
690 << " button[" << cmd.button() << ']'
693 LCursor & cur = cursor_;
695 switch (cmd.action) {
699 cur.message(_("Undo"));
700 cur.clearSelection();
701 if (!textUndo(*this))
702 cur.message(_("No further undo information"));
710 cur.message(_("Redo"));
711 cur.clearSelection();
712 if (!textRedo(*this))
713 cur.message(_("No further redo information"));
719 case LFUN_FILE_INSERT:
721 menuInsertLyXFile(to_utf8(cmd.argument()));
724 case LFUN_FILE_INSERT_ASCII_PARA:
726 insertAsciiFile(this, to_utf8(cmd.argument()), true);
729 case LFUN_FILE_INSERT_ASCII:
731 insertAsciiFile(this, to_utf8(cmd.argument()), false);
734 case LFUN_FONT_STATE:
735 cur.message(cur.currentState());
738 case LFUN_BOOKMARK_SAVE:
739 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
742 case LFUN_LABEL_GOTO: {
743 docstring label = cmd.argument();
746 getInsetByCode<InsetRef>(cursor_,
747 InsetBase::REF_CODE);
749 label = inset->getParam("reference");
750 // persistent=false: use temp_bookmark
760 case LFUN_PARAGRAPH_GOTO: {
761 int const id = convert<int>(to_utf8(cmd.argument()));
763 for (Buffer * b = buffer_; i == 0 || b != buffer_; b = theBufferList().next(b)) {
764 ParIterator par = b->getParFromID(id);
765 if (par == b->par_iterator_end()) {
767 << "No matching paragraph found! ["
768 << id << "]." << endl;
771 << "Paragraph " << par->id()
772 << " found in buffer `"
773 << b->fileName() << "'." << endl;
777 setCursor(makeDocIterator(par, 0));
781 // Switch to other buffer view and resend cmd
782 theLyXFunc().dispatch(FuncRequest(
783 LFUN_BUFFER_SWITCH, b->fileName()));
784 theLyXFunc().dispatch(cmd);
793 case LFUN_OUTLINE_UP:
794 toc::outline(toc::Up, cursor_);
795 cursor_.text()->setCursor(cursor_, cursor_.pit(), 0);
796 updateLabels(*buffer_);
798 case LFUN_OUTLINE_DOWN:
799 toc::outline(toc::Down, cursor_);
800 cursor_.text()->setCursor(cursor_, cursor_.pit(), 0);
801 updateLabels(*buffer_);
803 case LFUN_OUTLINE_IN:
804 toc::outline(toc::In, cursor_);
805 updateLabels(*buffer_);
807 case LFUN_OUTLINE_OUT:
808 toc::outline(toc::Out, cursor_);
809 updateLabels(*buffer_);
813 bv_funcs::gotoInset(this, InsetBase::NOTE_CODE, false);
816 case LFUN_REFERENCE_NEXT: {
817 vector<InsetBase_code> tmp;
818 tmp.push_back(InsetBase::LABEL_CODE);
819 tmp.push_back(InsetBase::REF_CODE);
820 bv_funcs::gotoInset(this, tmp, true);
824 case LFUN_CHANGES_TRACK:
825 buffer_->params().trackChanges = !buffer_->params().trackChanges;
828 case LFUN_CHANGES_OUTPUT: {
829 buffer_->params().outputChanges = !buffer_->params().outputChanges;
833 case LFUN_CHANGE_NEXT:
834 findNextChange(this);
837 case LFUN_CHANGES_MERGE:
838 if (findNextChange(this))
839 showDialog("changes");
842 case LFUN_ALL_CHANGES_ACCEPT: {
843 cursor_.reset(buffer_->inset());
845 #warning FIXME changes
847 while (findNextChange(this))
848 getLyXText()->acceptChange(cursor_);
853 case LFUN_ALL_CHANGES_REJECT: {
854 cursor_.reset(buffer_->inset());
856 #warning FIXME changes
858 while (findNextChange(this))
859 getLyXText()->rejectChange(cursor_);
867 case LFUN_WORD_REPLACE:
872 cur.clearSelection();
874 cur.message(from_utf8(N_("Mark off")));
878 cur.clearSelection();
881 cur.message(from_utf8(N_("Mark on")));
884 case LFUN_MARK_TOGGLE:
885 cur.clearSelection();
888 cur.message(from_utf8(N_("Mark removed")));
891 cur.message(from_utf8(N_("Mark set")));
896 case LFUN_SCREEN_RECENTER:
900 case LFUN_BIBTEX_DATABASE_ADD: {
901 LCursor tmpcur = cursor_;
902 bv_funcs::findInset(tmpcur, InsetBase::BIBTEX_CODE, false);
903 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
904 InsetBase::BIBTEX_CODE);
906 if (inset->addDatabase(to_utf8(cmd.argument())))
907 buffer_->updateBibfilesCache();
912 case LFUN_BIBTEX_DATABASE_DEL: {
913 LCursor tmpcur = cursor_;
914 bv_funcs::findInset(tmpcur, InsetBase::BIBTEX_CODE, false);
915 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
916 InsetBase::BIBTEX_CODE);
918 if (inset->delDatabase(to_utf8(cmd.argument())))
919 buffer_->updateBibfilesCache();
924 case LFUN_WORDS_COUNT: {
925 DocIterator from, to;
926 if (cur.selection()) {
927 from = cur.selectionBegin();
928 to = cur.selectionEnd();
930 from = doc_iterator_begin(buffer_->inset());
931 to = doc_iterator_end(buffer_->inset());
933 int const count = countWords(from, to);
937 message = bformat(_("%1$d words in selection."),
940 message = bformat(_("%1$d words in document."),
945 message = _("One word in selection.");
947 message = _("One word in document.");
950 Alert::information(_("Count words"), message);
954 case LFUN_BUFFER_TOGGLE_COMPRESSION:
955 // turn compression on/off
956 buffer_->params().compressed = !buffer_->params().compressed;
959 case LFUN_NEXT_INSET_TOGGLE: {
960 // this is the real function we want to invoke
961 FuncRequest tmpcmd = FuncRequest(LFUN_INSET_TOGGLE, cmd.origin);
962 // if there is an inset at cursor, see whether it
964 InsetBase * inset = cur.nextInset();
965 if (inset && inset->isActive()) {
966 LCursor tmpcur = cur;
967 tmpcur.pushLeft(*inset);
968 inset->dispatch(tmpcur, tmpcmd);
969 if (tmpcur.result().dispatched()) {
973 // if it did not work, try the underlying inset.
974 if (!cur.result().dispatched())
975 cur.dispatch(tmpcmd);
977 if (cur.result().dispatched())
978 cur.clearSelection();
991 docstring const BufferView::requestSelection()
996 LCursor & cur = cursor_;
998 if (!cur.selection()) {
999 xsel_cache_.set = false;
1003 if (!xsel_cache_.set ||
1004 cur.top() != xsel_cache_.cursor ||
1005 cur.anchor_.top() != xsel_cache_.anchor)
1007 xsel_cache_.cursor = cur.top();
1008 xsel_cache_.anchor = cur.anchor_.top();
1009 xsel_cache_.set = cur.selection();
1010 return cur.selectionAsString(false);
1016 void BufferView::clearSelection()
1019 cursor_.clearSelection();
1020 xsel_cache_.set = false;
1021 // The buffer did not really change, but this causes the
1022 // redraw we need because we cleared the selection above.
1028 void BufferView::workAreaResize(int width, int height)
1030 // Update from work area
1034 // The complete text metrics will be redone.
1035 text_metrics_.clear();
1042 bool BufferView::workAreaDispatch(FuncRequest const & cmd0)
1044 //lyxerr << BOOST_CURRENT_FUNCTION << "[ cmd0 " << cmd0 << "]" << endl;
1046 // This is only called for mouse related events including
1047 // LFUN_FILE_OPEN generated by drag-and-drop.
1048 FuncRequest cmd = cmd0;
1050 // E.g. Qt mouse press when no buffer
1055 cur.push(buffer_->inset());
1056 cur.selection() = cursor_.selection();
1058 // Either the inset under the cursor or the
1059 // surrounding LyXText will handle this event.
1061 // Build temporary cursor.
1062 cmd.y = min(max(cmd.y, -1), height_);
1063 InsetBase * inset = buffer_->text().editXY(cur, cmd.x, cmd.y);
1065 //lyxerr << BOOST_CURRENT_FUNCTION
1066 // << " * hit inset at tip: " << inset << endl;
1067 //lyxerr << BOOST_CURRENT_FUNCTION
1068 // << " * created temp cursor:" << cur << endl;
1070 // NOTE: editXY returns the top level inset of nested insets. If you happen
1071 // to move from a text (inset=0) to a text inside an inset (e.g. an opened
1072 // footnote inset, again inset=0), that inset will not be redrawn.
1073 if (cmd.action == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
1074 bool need_redraw = false;
1076 if (inset != last_inset_) {
1078 need_redraw |= last_inset_->setMouseHover(false);
1080 need_redraw |= inset->setMouseHover(true);
1081 last_inset_ = inset;
1084 // if last metrics update was in singlepar mode, WorkArea::redraw() will
1085 // not expose the button for redraw. We adjust here the metrics dimension
1086 // to enable a full redraw.
1087 // FIXME: It is possible to redraw only the area around the button!
1088 if (need_redraw && metrics_info_.singlepar) {
1089 // FIXME: It should be possible to redraw only the area around
1090 // the button by doing this:
1092 //metrics_info_.singlepar = false;
1093 //metrics_info_.y1 = ymin of button;
1094 //metrics_info_.y2 = ymax of button;
1096 // Unfortunately, rowpainter.C:paintText() does not distinguish
1097 // between background updates and text updates. So we use the hammer
1098 // solution for now. We could also avoid the updateMetrics() below
1099 // by using the first and last pit of the CoordCache. Have a look
1100 // at LyXText::getPitNearY() to see what I mean.
1102 //metrics_info_.pit1 = first pit of CoordCache;
1103 //metrics_info_.pit2 = last pit of CoordCache;
1104 //metrics_info_.singlepar = false;
1105 //metrics_info_.y1 = 0;
1106 //metrics_info_.y2 = height_;
1108 updateMetrics(false);
1111 // This event (moving without mouse click) is not passed further.
1112 // This should be changed if it is further utilized.
1116 // Put anchor at the same position.
1119 // Try to dispatch to an non-editable inset near this position
1120 // via the temp cursor. If the inset wishes to change the real
1121 // cursor it has to do so explicitly by using
1122 // cur.bv().cursor() = cur; (or similar)
1124 inset->dispatch(cur, cmd);
1127 // Now dispatch to the temporary cursor. If the real cursor should
1128 // be modified, the inset's dispatch has to do so explicitly.
1129 if (!cur.result().dispatched())
1132 // Redraw if requested and necessary.
1133 if (cur.result().dispatched() && cur.result().update())
1134 return update(cur.result().update());
1140 void BufferView::scroll(int /*lines*/)
1145 // LyXText const * t = &buffer_->text();
1146 // int const line_height = defaultRowHeight();
1148 // // The new absolute coordinate
1149 // int new_top_y = top_y() + lines * line_height;
1151 // // Restrict to a valid value
1152 // new_top_y = std::min(t->height() - 4 * line_height, new_top_y);
1153 // new_top_y = std::max(0, new_top_y);
1155 // scrollDocView(new_top_y);
1160 void BufferView::setCursorFromRow(int row)
1165 buffer_->texrow().getIdFromRow(row, tmpid, tmppos);
1168 buffer_->text().setCursor(cursor_, 0, 0);
1170 buffer_->text().setCursor(cursor_, buffer_->getParFromID(tmpid).pit(), tmppos);
1174 void BufferView::gotoLabel(docstring const & label)
1176 for (InsetIterator it = inset_iterator_begin(buffer_->inset()); it; ++it) {
1177 vector<docstring> labels;
1178 it->getLabelList(*buffer_, labels);
1179 if (std::find(labels.begin(), labels.end(), label) != labels.end()) {
1188 LyXText * BufferView::getLyXText()
1190 LyXText * text = cursor_.innerText();
1196 LyXText const * BufferView::getLyXText() const
1198 LyXText const * text = cursor_.innerText();
1204 TextMetrics const & BufferView::textMetrics(LyXText const * t) const
1206 return const_cast<BufferView *>(this)->textMetrics(t);
1210 TextMetrics & BufferView::textMetrics(LyXText const * t)
1212 TextMetricsCache::iterator tmc_it = text_metrics_.find(t);
1213 if (tmc_it == text_metrics_.end()) {
1214 tmc_it = text_metrics_.insert(
1215 make_pair(t, TextMetrics(this, const_cast<LyXText *>(t)))).first;
1217 return tmc_it->second;
1221 ParagraphMetrics const & BufferView::parMetrics(LyXText const * t,
1224 return textMetrics(t).parMetrics(pit);
1228 int BufferView::workHeight() const
1234 void BufferView::setCursor(DocIterator const & dit)
1236 size_t const n = dit.depth();
1237 for (size_t i = 0; i < n; ++i)
1238 dit[i].inset().edit(cursor_, true);
1240 cursor_.setCursor(dit);
1241 cursor_.selection() = false;
1245 bool BufferView::checkDepm(LCursor & cur, LCursor & old)
1247 // Would be wrong to delete anything if we have a selection.
1248 if (cur.selection())
1251 bool need_anchor_change = false;
1252 bool changed = cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
1253 need_anchor_change);
1255 if (need_anchor_change)
1261 updateMetrics(false);
1267 bool BufferView::mouseSetCursor(LCursor & cur)
1269 BOOST_ASSERT(&cur.bv() == this);
1271 // Has the cursor just left the inset?
1272 bool badcursor = false;
1273 if (&cursor_.inset() != &cur.inset())
1274 badcursor = cursor_.inset().notifyCursorLeaves(cursor_);
1276 // do the dEPM magic if needed
1277 // FIXME: move this to InsetText::notifyCursorLeaves?
1278 bool update = false;
1279 if (!badcursor && cursor_.inTexted())
1280 checkDepm(cur, cursor_);
1283 cursor_.clearSelection();
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");