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 "callback.h" // added for Dispatch functions
44 #include "TextClass.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>
84 using std::istringstream;
88 using std::mem_fun_ref;
95 using support::addPath;
96 using support::bformat;
97 using support::FileFilterList;
98 using support::FileName;
99 using support::fileSearch;
100 using support::isDirWriteable;
101 using support::isFileReadable;
102 using support::makeDisplayPath;
103 using support::package;
105 namespace Alert = frontend::Alert;
109 /// Return an inset of this class if it exists at the current cursor position
111 T * getInsetByCode(Cursor & cur, Inset::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(Buffer & buf)
126 : width_(0), height_(0), buffer_(buf), 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);
134 cursor_.push(buffer_.inset());
135 cursor_.resetAnchor();
136 buffer_.text().setCurrentFont(cursor_);
138 if (graphics::Previews::status() != LyXRC::PREVIEW_OFF)
139 graphics::Previews::get().generateBufferPreviews(buffer_);
143 BufferView::~BufferView()
145 // current buffer is going to be switched-off, save cursor pos
146 // Ideally, the whole cursor stack should be saved, but session
147 // currently can only handle bottom (whole document) level pit and pos.
148 // That is to say, if a cursor is in a nested inset, it will be
149 // restore to the left of the top level inset.
150 LyX::ref().session().lastFilePos().save(
151 support::FileName(buffer_.fileName()),
152 boost::tie(cursor_.bottom().pit(), cursor_.bottom().pos()) );
156 Buffer & BufferView::buffer()
162 Buffer const & BufferView::buffer() const
168 bool BufferView::fitCursor()
170 if (bv_funcs::status(this, cursor_) == bv_funcs::CUR_INSIDE) {
171 frontend::FontMetrics const & fm =
172 theFontMetrics(cursor_.getFont());
173 int const asc = fm.maxAscent();
174 int const des = fm.maxDescent();
175 Point const p = bv_funcs::getPos(*this, cursor_, cursor_.boundary());
176 if (p.y_ - asc >= 0 && p.y_ + des < height_)
184 bool BufferView::multiParSel()
186 if (!cursor_.selection())
188 bool ret = multiparsel_cache_;
189 multiparsel_cache_ = cursor_.selBegin().pit() != cursor_.selEnd().pit();
190 // Either this, or previous selection spans paragraphs
191 return ret || multiparsel_cache_;
195 bool BufferView::update(Update::flags flags)
197 // last_inset_ points to the last visited inset. This pointer may become
198 // invalid because of keyboard editing. Since all such operations
199 // causes screen update(), I reset last_inset_ to avoid such a problem.
201 // This is close to a hot-path.
203 << BOOST_CURRENT_FUNCTION
204 << "[fitcursor = " << (flags & Update::FitCursor)
205 << ", forceupdate = " << (flags & Update::Force)
206 << ", singlepar = " << (flags & Update::SinglePar)
207 << "] buffer: " << &buffer_ << endl;
209 // Update macro store
210 if (!(cursor().inMathed() && cursor().inMacroMode()))
211 buffer_.buildMacros();
213 // Now do the first drawing step if needed. This consists on updating
214 // the CoordCache in updateMetrics().
215 // The second drawing step is done in WorkArea::redraw() if needed.
217 // Case when no explicit update is requested.
219 // no need to redraw anything.
220 metrics_info_.update_strategy = NoScreenUpdate;
224 if (flags == Update::Decoration) {
225 metrics_info_.update_strategy = DecorationUpdate;
229 if (flags == Update::FitCursor
230 || flags == (Update::Decoration | Update::FitCursor)) {
231 bool const fit_cursor = fitCursor();
232 // tell the frontend to update the screen if needed.
234 updateMetrics(false);
237 if (flags & Update::Decoration) {
238 metrics_info_.update_strategy = DecorationUpdate;
241 // no screen update is needed.
242 metrics_info_.update_strategy = NoScreenUpdate;
246 bool full_metrics = flags & Update::Force;
247 if (flags & Update::MultiParSel)
248 full_metrics |= multiParSel();
250 bool const single_par = !full_metrics;
251 updateMetrics(single_par);
253 if (flags & Update::FitCursor && fitCursor())
254 updateMetrics(false);
256 // tell the frontend to update the screen.
261 void BufferView::updateScrollbar()
263 Text & t = buffer_.text();
264 TextMetrics & tm = text_metrics_[&t];
266 int const parsize = int(t.paragraphs().size() - 1);
267 if (anchor_ref_ > parsize) {
268 anchor_ref_ = parsize;
273 << BOOST_CURRENT_FUNCTION
274 << " Updating scrollbar: height: " << t.paragraphs().size()
275 << " curr par: " << cursor_.bottom().pit()
276 << " default height " << defaultRowHeight() << endl;
278 // It would be better to fix the scrollbar to understand
279 // values in [0..1] and divide everything by wh
281 // estimated average paragraph height:
285 int h = tm.parMetrics(anchor_ref_).height();
287 // Normalize anchor/offset (MV):
288 while (offset_ref_ > h && anchor_ref_ < parsize) {
291 h = tm.parMetrics(anchor_ref_).height();
293 // Look at paragraph heights on-screen
296 for (pit_type pit = anchor_ref_; pit <= parsize; ++pit) {
299 int const h2 = tm.parMetrics(pit).height();
305 int const hav = sumh / nh;
306 // More realistic average paragraph height
311 scrollbarParameters_.height = (parsize + 1) * wh_;
312 scrollbarParameters_.position = anchor_ref_ * wh_ + int(offset_ref_ * wh_ / float(h));
313 scrollbarParameters_.lineScrollHeight = int(wh_ * defaultRowHeight() / float(h));
317 ScrollbarParameters const & BufferView::scrollbarParameters() const
319 return scrollbarParameters_;
323 void BufferView::scrollDocView(int value)
325 LYXERR(Debug::GUI) << BOOST_CURRENT_FUNCTION
326 << "[ value = " << value << "]" << endl;
328 Text & t = buffer_.text();
329 TextMetrics & tm = text_metrics_[&t];
331 float const bar = value / float(wh_ * t.paragraphs().size());
333 anchor_ref_ = int(bar * t.paragraphs().size());
334 if (anchor_ref_ > int(t.paragraphs().size()) - 1)
335 anchor_ref_ = int(t.paragraphs().size()) - 1;
337 tm.redoParagraph(anchor_ref_);
338 int const h = tm.parMetrics(anchor_ref_).height();
339 offset_ref_ = int((bar * t.paragraphs().size() - anchor_ref_) * h);
340 updateMetrics(false);
344 void BufferView::setCursorFromScrollbar()
346 Text & t = buffer_.text();
348 int const height = 2 * defaultRowHeight();
349 int const first = height;
350 int const last = height_ - height;
351 Cursor & cur = cursor_;
353 bv_funcs::CurStatus st = bv_funcs::status(this, cur);
356 case bv_funcs::CUR_ABOVE:
357 // We reset the cursor because bv_funcs::status() does not
358 // work when the cursor is within mathed.
359 cur.reset(buffer_.inset());
360 t.setCursorFromCoordinates(cur, 0, first);
361 cur.clearSelection();
363 case bv_funcs::CUR_BELOW:
364 // We reset the cursor because bv_funcs::status() does not
365 // work when the cursor is within mathed.
366 cur.reset(buffer_.inset());
367 t.setCursorFromCoordinates(cur, 0, last);
368 cur.clearSelection();
370 case bv_funcs::CUR_INSIDE:
371 int const y = bv_funcs::getPos(*this, cur, cur.boundary()).y_;
372 int const newy = min(last, max(y, first));
374 cur.reset(buffer_.inset());
375 t.setCursorFromCoordinates(cur, 0, newy);
381 Change const BufferView::getCurrentChange() const
383 if (!cursor_.selection())
384 return Change(Change::UNCHANGED);
386 DocIterator dit = cursor_.selectionBegin();
387 return dit.paragraph().lookupChange(dit.pos());
391 void BufferView::saveBookmark(unsigned int idx)
393 // tenatively save bookmark, id and pos will be used to
394 // acturately locate a bookmark in a 'live' lyx session.
395 // pit and pos will be updated with bottom level pit/pos
397 LyX::ref().session().bookmarks().save(
398 FileName(buffer_.fileName()),
399 cursor_.bottom().pit(),
400 cursor_.bottom().pos(),
401 cursor_.paragraph().id(),
406 // emit message signal.
407 message(_("Save bookmark"));
411 boost::tuple<pit_type, pos_type, int> BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
412 int top_id, pos_type top_pos)
414 cursor_.clearSelection();
416 // if a valid par_id is given, try it first
417 // This is the case for a 'live' bookmark when unique paragraph ID
418 // is used to track bookmarks.
420 ParIterator par = buffer_.getParFromID(top_id);
421 if (par != buffer_.par_iterator_end()) {
422 DocIterator dit = makeDocIterator(par, min(par->size(), top_pos));
423 // Some slices of the iterator may not be
424 // reachable (e.g. closed collapsable inset)
425 // so the dociterator may need to be
426 // shortened. Otherwise, setCursor may crash
427 // lyx when the cursor can not be set to these
429 size_t const n = dit.depth();
430 for (size_t i = 0; i < n; ++i)
431 if (dit[i].inset().editable() != Inset::HIGHLY_EDITABLE) {
436 // Note: return bottom (document) level pit.
437 return boost::make_tuple(cursor_.bottom().pit(), cursor_.bottom().pos(), top_id);
440 // if top_id == 0, or searching through top_id failed
441 // This is the case for a 'restored' bookmark when only bottom
442 // (document level) pit was saved. Because of this, bookmark
443 // restoration is inaccurate. If a bookmark was within an inset,
444 // it will be restored to the left of the outmost inset that contains
446 if (static_cast<size_t>(bottom_pit) < buffer_.paragraphs().size()) {
447 DocIterator it = doc_iterator_begin(buffer_.inset());
448 it.pit() = bottom_pit;
449 it.pos() = min(bottom_pos, it.paragraph().size());
451 return boost::make_tuple(it.pit(), it.pos(),
452 it.paragraph().id());
455 return boost::make_tuple(pit_type(0), pos_type(0), 0);
459 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
461 if (lyxrc.rtl_support) {
462 if (cursor_.innerText()->real_current_font.isRightToLeft()) {
463 if (intl_->keymap == Intl::PRIMARY)
466 if (intl_->keymap == Intl::SECONDARY)
471 intl_->getTransManager().translateAndInsert(c, t, cur);
475 int BufferView::workWidth() const
481 void BufferView::center()
483 CursorSlice & bot = cursor_.bottom();
484 TextMetrics & tm = text_metrics_[bot.text()];
485 pit_type const pit = bot.pit();
486 tm.redoParagraph(pit);
487 ParagraphMetrics const & pm = tm.parMetrics(pit);
489 offset_ref_ = bv_funcs::coordOffset(*this, cursor_, cursor_.boundary()).y_
490 + pm.ascent() - height_ / 2;
494 FuncStatus BufferView::getStatus(FuncRequest const & cmd)
498 Cursor & cur = cursor_;
500 switch (cmd.action) {
503 flag.enabled(!buffer_.undostack().empty());
506 flag.enabled(!buffer_.redostack().empty());
508 case LFUN_FILE_INSERT:
509 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
510 case LFUN_FILE_INSERT_PLAINTEXT:
511 case LFUN_BOOKMARK_SAVE:
512 // FIXME: Actually, these LFUNS should be moved to Text
513 flag.enabled(cur.inTexted());
515 case LFUN_FONT_STATE:
516 case LFUN_LABEL_INSERT:
517 case LFUN_PARAGRAPH_GOTO:
518 // FIXME handle non-trivially
519 case LFUN_OUTLINE_UP:
520 case LFUN_OUTLINE_DOWN:
521 case LFUN_OUTLINE_IN:
522 case LFUN_OUTLINE_OUT:
524 case LFUN_REFERENCE_NEXT:
526 case LFUN_WORD_REPLACE:
529 case LFUN_MARK_TOGGLE:
530 case LFUN_SCREEN_RECENTER:
531 case LFUN_BIBTEX_DATABASE_ADD:
532 case LFUN_BIBTEX_DATABASE_DEL:
533 case LFUN_WORDS_COUNT:
534 case LFUN_NEXT_INSET_TOGGLE:
538 case LFUN_LABEL_GOTO: {
539 flag.enabled(!cmd.argument().empty()
540 || getInsetByCode<InsetRef>(cur, Inset::REF_CODE));
544 case LFUN_CHANGES_TRACK:
546 flag.setOnOff(buffer_.params().trackChanges);
549 case LFUN_CHANGES_OUTPUT:
551 flag.setOnOff(buffer_.params().outputChanges);
554 case LFUN_CHANGES_MERGE:
555 case LFUN_CHANGE_NEXT:
556 case LFUN_ALL_CHANGES_ACCEPT:
557 case LFUN_ALL_CHANGES_REJECT:
558 // TODO: context-sensitive enabling of LFUNs
559 // In principle, these command should only be enabled if there
560 // is a change in the document. However, without proper
561 // optimizations, this will inevitably result in poor performance.
565 case LFUN_BUFFER_TOGGLE_COMPRESSION: {
566 flag.setOnOff(buffer_.params().compressed);
578 Update::flags BufferView::dispatch(FuncRequest const & cmd)
580 //lyxerr << BOOST_CURRENT_FUNCTION
581 // << [ cmd = " << cmd << "]" << endl;
583 // Make sure that the cached BufferView is correct.
584 LYXERR(Debug::ACTION) << BOOST_CURRENT_FUNCTION
585 << " action[" << cmd.action << ']'
586 << " arg[" << to_utf8(cmd.argument()) << ']'
587 << " x[" << cmd.x << ']'
588 << " y[" << cmd.y << ']'
589 << " button[" << cmd.button() << ']'
592 Cursor & cur = cursor_;
593 // Default Update flags.
594 Update::flags updateFlags = Update::Force | Update::FitCursor;
596 switch (cmd.action) {
599 cur.message(_("Undo"));
600 cur.clearSelection();
601 if (!textUndo(*this)) {
602 cur.message(_("No further undo information"));
603 updateFlags = Update::None;
608 cur.message(_("Redo"));
609 cur.clearSelection();
610 if (!textRedo(*this)) {
611 cur.message(_("No further redo information"));
612 updateFlags = Update::None;
616 case LFUN_FILE_INSERT:
618 menuInsertLyXFile(to_utf8(cmd.argument()));
621 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
623 insertPlaintextFile(this, to_utf8(cmd.argument()), true);
626 case LFUN_FILE_INSERT_PLAINTEXT:
628 insertPlaintextFile(this, to_utf8(cmd.argument()), false);
631 case LFUN_FONT_STATE:
632 cur.message(cur.currentState());
635 case LFUN_BOOKMARK_SAVE:
636 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
639 case LFUN_LABEL_GOTO: {
640 docstring label = cmd.argument();
643 getInsetByCode<InsetRef>(cursor_,
646 label = inset->getParam("reference");
647 // persistent=false: use temp_bookmark
657 case LFUN_PARAGRAPH_GOTO: {
658 int const id = convert<int>(to_utf8(cmd.argument()));
660 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
661 b = theBufferList().next(b)) {
663 ParIterator par = b->getParFromID(id);
664 if (par == b->par_iterator_end()) {
666 << "No matching paragraph found! ["
667 << id << "]." << endl;
670 << "Paragraph " << par->id()
671 << " found in buffer `"
672 << b->fileName() << "'." << endl;
676 setCursor(makeDocIterator(par, 0));
678 // Switch to other buffer view and resend cmd
679 theLyXFunc().dispatch(FuncRequest(
680 LFUN_BUFFER_SWITCH, b->fileName()));
681 theLyXFunc().dispatch(cmd);
682 updateFlags = Update::None;
691 case LFUN_OUTLINE_UP:
692 toc::outline(toc::Up, cursor_);
693 cursor_.text()->setCursor(cursor_, cursor_.pit(), 0);
694 updateLabels(buffer_);
696 case LFUN_OUTLINE_DOWN:
697 toc::outline(toc::Down, cursor_);
698 cursor_.text()->setCursor(cursor_, cursor_.pit(), 0);
699 updateLabels(buffer_);
701 case LFUN_OUTLINE_IN:
702 toc::outline(toc::In, cursor_);
703 updateLabels(buffer_);
705 case LFUN_OUTLINE_OUT:
706 toc::outline(toc::Out, cursor_);
707 updateLabels(buffer_);
711 bv_funcs::gotoInset(this, Inset::NOTE_CODE, false);
714 case LFUN_REFERENCE_NEXT: {
715 vector<Inset_code> tmp;
716 tmp.push_back(Inset::LABEL_CODE);
717 tmp.push_back(Inset::REF_CODE);
718 bv_funcs::gotoInset(this, tmp, true);
722 case LFUN_CHANGES_TRACK:
723 buffer_.params().trackChanges = !buffer_.params().trackChanges;
726 case LFUN_CHANGES_OUTPUT:
727 buffer_.params().outputChanges = !buffer_.params().outputChanges;
728 if (buffer_.params().outputChanges) {
729 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
730 bool xcolorsoul = LaTeXFeatures::isAvailable("soul") &&
731 LaTeXFeatures::isAvailable("xcolor");
733 if (!dvipost && !xcolorsoul) {
734 Alert::warning(_("Changes not shown in LaTeX output"),
735 _("Changes will not be highlighted in LaTeX output, "
736 "because neither dvipost nor xcolor/soul are installed.\n"
737 "Please install these packages or redefine "
738 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
739 } else if (!xcolorsoul) {
740 Alert::warning(_("Changes not shown in LaTeX output"),
741 _("Changes will not be highlighted in LaTeX output "
742 "when using pdflatex, because xcolor and soul are not installed.\n"
743 "Please install both packages or redefine "
744 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
749 case LFUN_CHANGE_NEXT:
750 findNextChange(this);
753 case LFUN_CHANGES_MERGE:
754 if (findNextChange(this))
755 showDialog("changes");
758 case LFUN_ALL_CHANGES_ACCEPT:
759 // select complete document
760 cursor_.reset(buffer_.inset());
761 cursor_.selHandle(true);
762 buffer_.text().cursorBottom(cursor_);
763 // accept everything in a single step to support atomic undo
764 buffer_.text().acceptOrRejectChanges(cursor_, Text::ACCEPT);
767 case LFUN_ALL_CHANGES_REJECT:
768 // select complete document
769 cursor_.reset(buffer_.inset());
770 cursor_.selHandle(true);
771 buffer_.text().cursorBottom(cursor_);
772 // reject everything in a single step to support atomic undo
773 // Note: reject does not work recursively; the user may have to repeat the operation
774 buffer_.text().acceptOrRejectChanges(cursor_, Text::REJECT);
781 case LFUN_WORD_REPLACE: {
782 bool has_deleted = false;
783 if (cur.selection()) {
784 DocIterator beg = cur.selectionBegin();
785 DocIterator end = cur.selectionEnd();
786 if (beg.pit() == end.pit()) {
787 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
788 if (cur.paragraph().isDeleted(p))
793 replace(this, cmd, has_deleted);
798 cur.clearSelection();
800 cur.message(from_utf8(N_("Mark off")));
804 cur.clearSelection();
807 cur.message(from_utf8(N_("Mark on")));
810 case LFUN_MARK_TOGGLE:
811 cur.clearSelection();
814 cur.message(from_utf8(N_("Mark removed")));
817 cur.message(from_utf8(N_("Mark set")));
822 case LFUN_SCREEN_RECENTER:
826 case LFUN_BIBTEX_DATABASE_ADD: {
827 Cursor tmpcur = cursor_;
828 bv_funcs::findInset(tmpcur, Inset::BIBTEX_CODE, false);
829 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
832 if (inset->addDatabase(to_utf8(cmd.argument())))
833 buffer_.updateBibfilesCache();
838 case LFUN_BIBTEX_DATABASE_DEL: {
839 Cursor tmpcur = cursor_;
840 bv_funcs::findInset(tmpcur, Inset::BIBTEX_CODE, false);
841 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
844 if (inset->delDatabase(to_utf8(cmd.argument())))
845 buffer_.updateBibfilesCache();
850 case LFUN_WORDS_COUNT: {
851 DocIterator from, to;
852 if (cur.selection()) {
853 from = cur.selectionBegin();
854 to = cur.selectionEnd();
856 from = doc_iterator_begin(buffer_.inset());
857 to = doc_iterator_end(buffer_.inset());
859 int const count = countWords(from, to);
863 message = bformat(_("%1$d words in selection."),
866 message = bformat(_("%1$d words in document."),
871 message = _("One word in selection.");
873 message = _("One word in document.");
876 Alert::information(_("Count words"), message);
880 case LFUN_BUFFER_TOGGLE_COMPRESSION:
881 // turn compression on/off
882 buffer_.params().compressed = !buffer_.params().compressed;
885 case LFUN_NEXT_INSET_TOGGLE: {
886 // this is the real function we want to invoke
887 FuncRequest tmpcmd = FuncRequest(LFUN_INSET_TOGGLE, cmd.origin);
888 // if there is an inset at cursor, see whether it
890 Inset * inset = cur.nextInset();
891 if (inset && inset->isActive()) {
893 tmpcur.pushLeft(*inset);
894 inset->dispatch(tmpcur, tmpcmd);
895 if (tmpcur.result().dispatched()) {
899 // if it did not work, try the underlying inset.
900 if (!cur.result().dispatched())
901 cur.dispatch(tmpcmd);
903 if (cur.result().dispatched())
904 cur.clearSelection();
910 updateFlags = Update::None;
917 docstring const BufferView::requestSelection()
919 Cursor & cur = cursor_;
921 if (!cur.selection()) {
922 xsel_cache_.set = false;
926 if (!xsel_cache_.set ||
927 cur.top() != xsel_cache_.cursor ||
928 cur.anchor_.top() != xsel_cache_.anchor)
930 xsel_cache_.cursor = cur.top();
931 xsel_cache_.anchor = cur.anchor_.top();
932 xsel_cache_.set = cur.selection();
933 return cur.selectionAsString(false);
939 void BufferView::clearSelection()
941 cursor_.clearSelection();
942 // Clear the selection buffer. Otherwise a subsequent
943 // middle-mouse-button paste would use the selection buffer,
944 // not the more current external selection.
945 cap::clearSelection();
946 xsel_cache_.set = false;
947 // The buffer did not really change, but this causes the
948 // redraw we need because we cleared the selection above.
953 void BufferView::workAreaResize(int width, int height)
955 // Update from work area
959 // The complete text metrics will be redone.
960 text_metrics_.clear();
961 updateMetrics(false);
965 Inset const * BufferView::getCoveringInset(Text const & text, int x, int y)
967 pit_type pit = text.getPitNearY(*this, y);
968 BOOST_ASSERT(pit != -1);
969 Paragraph const & par = text.getPar(pit);
972 << BOOST_CURRENT_FUNCTION
977 InsetList::const_iterator iit = par.insetlist.begin();
978 InsetList::const_iterator iend = par.insetlist.end();
979 for (; iit != iend; ++iit) {
980 Inset * const inset = iit->inset;
981 if (inset->covers(*this, x, y)) {
982 if (!inset->descendable())
983 // No need to go further down if the inset is not
987 size_t cell_number = inset->nargs();
988 // Check all the inner cell.
989 for (size_t i = 0; i != cell_number; ++i) {
990 Text const * inner_text = inset->getText(i);
993 Inset const * inset_deeper =
994 getCoveringInset(*inner_text, x, y);
1000 LYXERR(Debug::DEBUG)
1001 << BOOST_CURRENT_FUNCTION
1002 << ": Hit inset: " << inset << endl;
1006 LYXERR(Debug::DEBUG)
1007 << BOOST_CURRENT_FUNCTION
1008 << ": No inset hit. " << endl;
1013 bool BufferView::workAreaDispatch(FuncRequest const & cmd0)
1015 //lyxerr << BOOST_CURRENT_FUNCTION << "[ cmd0 " << cmd0 << "]" << endl;
1017 // This is only called for mouse related events including
1018 // LFUN_FILE_OPEN generated by drag-and-drop.
1019 FuncRequest cmd = cmd0;
1022 cur.push(buffer_.inset());
1023 cur.selection() = cursor_.selection();
1025 // Either the inset under the cursor or the
1026 // surrounding Text will handle this event.
1028 // make sure we stay within the screen...
1029 cmd.y = min(max(cmd.y, -1), height_);
1031 if (cmd.action == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
1033 // Get inset under mouse, if there is one.
1034 Inset const * covering_inset =
1035 getCoveringInset(buffer_.text(), cmd.x, cmd.y);
1036 if (covering_inset == last_inset_)
1037 // Same inset, no need to do anything...
1040 bool need_redraw = false;
1041 // const_cast because of setMouseHover().
1042 Inset * inset = const_cast<Inset *>(covering_inset);
1044 // Remove the hint on the last hovered inset (if any).
1045 need_redraw |= last_inset_->setMouseHover(false);
1047 // Highlighted the newly hovered inset (if any).
1048 need_redraw |= inset->setMouseHover(true);
1049 last_inset_ = inset;
1051 // if last metrics update was in singlepar mode, WorkArea::redraw() will
1052 // not expose the button for redraw. We adjust here the metrics dimension
1053 // to enable a full redraw.
1054 // FIXME: It is possible to redraw only the area around the button!
1056 && metrics_info_.update_strategy == SingleParUpdate) {
1057 // FIXME: It should be possible to redraw only the area around
1058 // the button by doing this:
1060 //metrics_info_.singlepar = false;
1061 //metrics_info_.y1 = ymin of button;
1062 //metrics_info_.y2 = ymax of button;
1064 // Unfortunately, rowpainter.cpp:paintText() does not distinguish
1065 // between background updates and text updates. So we use the hammer
1066 // solution for now. We could also avoid the updateMetrics() below
1067 // by using the first and last pit of the CoordCache. Have a look
1068 // at Text::getPitNearY() to see what I mean.
1070 //metrics_info_.pit1 = first pit of CoordCache;
1071 //metrics_info_.pit2 = last pit of CoordCache;
1072 //metrics_info_.singlepar = false;
1073 //metrics_info_.y1 = 0;
1074 //metrics_info_.y2 = height_;
1076 updateMetrics(false);
1079 // This event (moving without mouse click) is not passed further.
1080 // This should be changed if it is further utilized.
1084 // Build temporary cursor.
1085 Inset * inset = buffer_.text().editXY(cur, cmd.x, cmd.y);
1087 // Put anchor at the same position.
1090 // Try to dispatch to an non-editable inset near this position
1091 // via the temp cursor. If the inset wishes to change the real
1092 // cursor it has to do so explicitly by using
1093 // cur.bv().cursor() = cur; (or similar)
1095 inset->dispatch(cur, cmd);
1098 // Now dispatch to the temporary cursor. If the real cursor should
1099 // be modified, the inset's dispatch has to do so explicitly.
1100 if (!cur.result().dispatched())
1103 //Do we have a selection?
1104 theSelection().haveSelection(cursor().selection());
1106 // Redraw if requested and necessary.
1107 if (cur.result().dispatched() && cur.result().update())
1108 return update(cur.result().update());
1114 void BufferView::scroll(int /*lines*/)
1116 // Text const * t = buffer_.text();
1117 // int const line_height = defaultRowHeight();
1119 // // The new absolute coordinate
1120 // int new_top_y = top_y() + lines * line_height;
1122 // // Restrict to a valid value
1123 // new_top_y = std::min(t->height() - 4 * line_height, new_top_y);
1124 // new_top_y = std::max(0, new_top_y);
1126 // scrollDocView(new_top_y);
1131 void BufferView::setCursorFromRow(int row)
1136 buffer_.texrow().getIdFromRow(row, tmpid, tmppos);
1138 cursor_.reset(buffer_.inset());
1140 buffer_.text().setCursor(cursor_, 0, 0);
1142 buffer_.text().setCursor(cursor_, buffer_.getParFromID(tmpid).pit(), tmppos);
1146 void BufferView::gotoLabel(docstring const & label)
1148 for (InsetIterator it = inset_iterator_begin(buffer_.inset()); it; ++it) {
1149 vector<docstring> labels;
1150 it->getLabelList(buffer_, labels);
1151 if (std::find(labels.begin(), labels.end(), label) != labels.end()) {
1160 TextMetrics const & BufferView::textMetrics(Text const * t) const
1162 return const_cast<BufferView *>(this)->textMetrics(t);
1166 TextMetrics & BufferView::textMetrics(Text const * t)
1168 TextMetricsCache::iterator tmc_it = text_metrics_.find(t);
1169 if (tmc_it == text_metrics_.end()) {
1170 tmc_it = text_metrics_.insert(
1171 make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
1173 return tmc_it->second;
1177 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
1180 return textMetrics(t).parMetrics(pit);
1184 int BufferView::workHeight() const
1190 void BufferView::setCursor(DocIterator const & dit)
1192 size_t const n = dit.depth();
1193 for (size_t i = 0; i < n; ++i)
1194 dit[i].inset().edit(cursor_, true);
1196 cursor_.setCursor(dit);
1197 cursor_.selection() = false;
1201 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
1203 // Would be wrong to delete anything if we have a selection.
1204 if (cur.selection())
1207 bool need_anchor_change = false;
1208 bool changed = cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
1209 need_anchor_change);
1211 if (need_anchor_change)
1217 updateLabels(buffer_);
1219 updateMetrics(false);
1225 bool BufferView::mouseSetCursor(Cursor & cur)
1227 BOOST_ASSERT(&cur.bv() == this);
1229 // this event will clear selection so we save selection for
1230 // persistent selection
1231 cap::saveSelection(cursor());
1233 // Has the cursor just left the inset?
1234 bool badcursor = false;
1235 bool leftinset = (&cursor_.inset() != &cur.inset());
1237 badcursor = notifyCursorLeaves(cursor_, cur);
1239 // do the dEPM magic if needed
1240 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
1241 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
1242 // the leftinset bool would not be necessary (badcursor instead).
1243 bool update = leftinset;
1244 if (!badcursor && cursor_.inTexted())
1245 update |= checkDepm(cur, cursor_);
1247 // if the cursor was in an empty script inset and the new
1248 // position is in the nucleus of the inset, notifyCursorLeaves
1249 // will kill the script inset itself. So we check all the
1250 // elements of the cursor to make sure that they are correct.
1251 // For an example, see bug 2933:
1252 // http://bugzilla.lyx.org/show_bug.cgi?id=2933
1253 // The code below could maybe be moved to a DocIterator method.
1254 //lyxerr << "cur before " << cur <<std::endl;
1255 DocIterator dit(cur.inset());
1256 dit.push_back(cur.bottom());
1258 while (i < cur.depth() && dit.nextInset() == &cur[i].inset()) {
1259 dit.push_back(cur[i]);
1262 //lyxerr << "5 cur after" << dit <<std::endl;
1264 cursor_.setCursor(dit);
1265 cursor_.boundary(cur.boundary());
1266 cursor_.clearSelection();
1272 void BufferView::putSelectionAt(DocIterator const & cur,
1273 int length, bool backwards)
1275 cursor_.clearSelection();
1281 cursor_.pos() += length;
1282 cursor_.setSelection(cursor_, -length);
1284 cursor_.setSelection(cursor_, length);
1289 Cursor & BufferView::cursor()
1295 Cursor const & BufferView::cursor() const
1301 pit_type BufferView::anchor_ref() const
1307 ViewMetricsInfo const & BufferView::viewMetricsInfo()
1309 return metrics_info_;
1313 // FIXME: We should split-up updateMetrics() for the singlepar case.
1314 void BufferView::updateMetrics(bool singlepar)
1316 Text & buftext = buffer_.text();
1317 TextMetrics & tm = textMetrics(&buftext);
1318 pit_type size = int(buftext.paragraphs().size());
1320 if (anchor_ref_ > int(buftext.paragraphs().size() - 1)) {
1321 anchor_ref_ = int(buftext.paragraphs().size() - 1);
1326 // Clear out the position cache in case of full screen redraw,
1327 coord_cache_.clear();
1329 // Clear out paragraph metrics to avoid having invalid metrics
1330 // in the cache from paragraphs not relayouted below
1334 // If the paragraph metrics has changed, we can not
1335 // use the singlepar optimisation.
1337 // In Single Paragraph mode, rebreak only
1338 // the (main text, not inset!) paragraph containing the cursor.
1339 // (if this paragraph contains insets etc., rebreaking will
1340 // recursively descend)
1341 && tm.redoParagraph(cursor_.bottom().pit()))
1344 pit_type const pit = anchor_ref_;
1347 size_t const npit = buftext.paragraphs().size();
1349 // Rebreak anchor paragraph.
1351 tm.redoParagraph(pit);
1353 int y0 = tm.parMetrics(pit).ascent() - offset_ref_;
1355 // Redo paragraphs above anchor if necessary.
1357 while (y1 > 0 && pit1 > 0) {
1358 y1 -= tm.parMetrics(pit1).ascent();
1361 tm.redoParagraph(pit1);
1362 y1 -= tm.parMetrics(pit1).descent();
1366 // Take care of ascent of first line
1367 y1 -= tm.parMetrics(pit1).ascent();
1369 // Normalize anchor for next time
1373 // Grey at the beginning is ugly
1374 if (pit1 == 0 && y1 > 0) {
1380 // Redo paragraphs below the anchor if necessary.
1382 while (y2 < height_ && pit2 < int(npit) - 1) {
1383 y2 += tm.parMetrics(pit2).descent();
1386 tm.redoParagraph(pit2);
1387 y2 += tm.parMetrics(pit2).ascent();
1390 // Take care of descent of last line
1391 y2 += tm.parMetrics(pit2).descent();
1393 // The coordinates of all these paragraphs are correct, cache them
1395 CoordCache::InnerParPosCache & parPos = coord_cache_.parPos()[&buftext];
1396 for (pit_type pit = pit1; pit <= pit2; ++pit) {
1397 ParagraphMetrics const & pm = tm.parMetrics(pit);
1399 parPos[pit] = Point(0, y);
1400 if (singlepar && pit == cursor_.bottom().pit()) {
1401 // In Single Paragraph mode, collect here the
1402 // y1 and y2 of the (one) paragraph the cursor is in
1403 y1 = y - pm.ascent();
1404 y2 = y + pm.descent();
1410 // collect cursor paragraph iter bounds
1411 pit1 = cursor_.bottom().pit();
1412 pit2 = cursor_.bottom().pit();
1415 LYXERR(Debug::DEBUG)
1416 << BOOST_CURRENT_FUNCTION
1419 << " pit1: " << pit1
1420 << " pit2: " << pit2
1421 << " npit: " << npit
1422 << " singlepar: " << singlepar
1426 metrics_info_ = ViewMetricsInfo(pit1, pit2, y1, y2,
1427 singlepar? SingleParUpdate: FullScreenUpdate, size);
1429 if (lyxerr.debugging(Debug::WORKAREA)) {
1430 LYXERR(Debug::WORKAREA) << "BufferView::updateMetrics" << endl;
1431 coord_cache_.dump();
1436 void BufferView::menuInsertLyXFile(string const & filenm)
1438 BOOST_ASSERT(cursor_.inTexted());
1439 string filename = filenm;
1441 if (filename.empty()) {
1442 // Launch a file browser
1444 string initpath = lyxrc.document_path;
1445 string const trypath = buffer_.filePath();
1446 // If directory is writeable, use this as default.
1447 if (isDirWriteable(FileName(trypath)))
1451 FileDialog fileDlg(_("Select LyX document to insert"),
1453 make_pair(_("Documents|#o#O"), from_utf8(lyxrc.document_path)),
1454 make_pair(_("Examples|#E#e"),
1455 from_utf8(addPath(package().system_support().absFilename(),
1458 FileDialog::Result result =
1459 fileDlg.open(from_utf8(initpath),
1460 FileFilterList(_("LyX Documents (*.lyx)")),
1463 if (result.first == FileDialog::Later)
1467 filename = to_utf8(result.second);
1469 // check selected filename
1470 if (filename.empty()) {
1471 // emit message signal.
1472 message(_("Canceled."));
1477 // Get absolute path of file and add ".lyx"
1478 // to the filename if necessary
1479 filename = fileSearch(string(), filename, "lyx").absFilename();
1481 docstring const disp_fn = makeDisplayPath(filename);
1482 // emit message signal.
1483 message(bformat(_("Inserting document %1$s..."), disp_fn));
1486 Buffer buf("", false);
1487 if (lyx::loadLyXFile(&buf, FileName(filename))) {
1488 ErrorList & el = buffer_.errorList("Parse");
1489 // Copy the inserted document error list into the current buffer one.
1490 el = buf.errorList("Parse");
1491 recordUndo(cursor_);
1492 cap::pasteParagraphList(cursor_, buf.paragraphs(),
1493 buf.params().textclass, el);
1494 res = _("Document %1$s inserted.");
1496 res = _("Could not insert document %1$s");
1498 // emit message signal.
1499 message(bformat(res, disp_fn));
1500 buffer_.errors("Parse");
1501 updateMetrics(false);