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 "callback.h" // added for Dispatch functions
25 #include "CoordCache.h"
26 #include "CutAndPaste.h"
28 #include "DispatchResult.h"
29 #include "ErrorList.h"
31 #include "FloatList.h"
32 #include "FuncRequest.h"
33 #include "FuncStatus.h"
36 #include "InsetIterator.h"
38 #include "LaTeXFeatures.h"
44 #include "MetricsInfo.h"
45 #include "Paragraph.h"
46 #include "paragraph_funcs.h"
47 #include "ParagraphParameters.h"
48 #include "ParIterator.h"
52 #include "TextClass.h"
56 #include "WordLangTuple.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/Painter.h"
67 #include "frontends/Selection.h"
69 #include "graphics/Previews.h"
71 #include "support/convert.h"
72 #include "support/FileFilterList.h"
73 #include "support/filetools.h"
74 #include "support/Package.h"
75 #include "support/types.h"
77 #include <boost/bind.hpp>
78 #include <boost/current_function.hpp>
85 using std::istringstream;
89 using std::mem_fun_ref;
96 using support::addPath;
97 using support::bformat;
98 using support::FileFilterList;
99 using support::FileName;
100 using support::fileSearch;
101 using support::isDirWriteable;
102 using support::isFileReadable;
103 using support::makeDisplayPath;
104 using support::package;
106 namespace Alert = frontend::Alert;
110 /// Return an inset of this class if it exists at the current cursor position
112 T * getInsetByCode(Cursor & cur, Inset::Code code)
115 DocIterator it = cur;
116 if (it.nextInset() &&
117 it.nextInset()->lyxCode() == code) {
118 inset = static_cast<T*>(it.nextInset());
126 BufferView::BufferView(Buffer & buf)
127 : width_(0), height_(0), buffer_(buf), wh_(0),
129 multiparsel_cache_(false), anchor_ref_(0), offset_ref_(0),
130 need_centering_(false), intl_(new Intl), last_inset_(0)
132 xsel_cache_.set = false;
133 intl_->initKeyMapper(lyxrc.use_kbmap);
135 cursor_.push(buffer_.inset());
136 cursor_.resetAnchor();
137 cursor_.setCurrentFont();
139 if (graphics::Previews::status() != LyXRC::PREVIEW_OFF)
140 graphics::Previews::get().generateBufferPreviews(buffer_);
144 BufferView::~BufferView()
146 // current buffer is going to be switched-off, save cursor pos
147 // Ideally, the whole cursor stack should be saved, but session
148 // currently can only handle bottom (whole document) level pit and pos.
149 // That is to say, if a cursor is in a nested inset, it will be
150 // restore to the left of the top level inset.
151 LyX::ref().session().lastFilePos().save(
152 support::FileName(buffer_.fileName()),
153 boost::tie(cursor_.bottom().pit(), cursor_.bottom().pos()) );
157 Buffer & BufferView::buffer()
163 Buffer const & BufferView::buffer() const
169 bool BufferView::fitCursor()
171 if (bv_funcs::status(this, cursor_) == bv_funcs::CUR_INSIDE) {
172 frontend::FontMetrics const & fm =
173 theFontMetrics(cursor_.getFont());
174 int const asc = fm.maxAscent();
175 int const des = fm.maxDescent();
176 Point const p = bv_funcs::getPos(*this, cursor_, cursor_.boundary());
177 if (p.y_ - asc >= 0 && p.y_ + des < height_)
185 bool BufferView::multiParSel()
187 if (!cursor_.selection())
189 bool ret = multiparsel_cache_;
190 multiparsel_cache_ = cursor_.selBegin().pit() != cursor_.selEnd().pit();
191 // Either this, or previous selection spans paragraphs
192 return ret || multiparsel_cache_;
196 bool BufferView::update(Update::flags flags)
198 // last_inset_ points to the last visited inset. This pointer may become
199 // invalid because of keyboard editing. Since all such operations
200 // causes screen update(), I reset last_inset_ to avoid such a problem.
202 // This is close to a hot-path.
204 << BOOST_CURRENT_FUNCTION
205 << "[fitcursor = " << (flags & Update::FitCursor)
206 << ", forceupdate = " << (flags & Update::Force)
207 << ", singlepar = " << (flags & Update::SinglePar)
208 << "] buffer: " << &buffer_ << endl;
210 // Update macro store
211 if (!(cursor().inMathed() && cursor().inMacroMode()))
212 buffer_.buildMacros();
214 // Now do the first drawing step if needed. This consists on updating
215 // the CoordCache in updateMetrics().
216 // The second drawing step is done in WorkArea::redraw() if needed.
218 // Case when no explicit update is requested.
220 // no need to redraw anything.
221 metrics_info_.update_strategy = NoScreenUpdate;
225 if (flags == Update::Decoration) {
226 metrics_info_.update_strategy = DecorationUpdate;
230 if (flags == Update::FitCursor
231 || flags == (Update::Decoration | Update::FitCursor)) {
232 bool const fit_cursor = fitCursor();
233 // tell the frontend to update the screen if needed.
235 updateMetrics(false);
238 if (flags & Update::Decoration) {
239 metrics_info_.update_strategy = DecorationUpdate;
242 // no screen update is needed.
243 metrics_info_.update_strategy = NoScreenUpdate;
247 bool full_metrics = flags & Update::Force;
248 if (flags & Update::MultiParSel)
249 full_metrics |= multiParSel();
251 bool const single_par = !full_metrics;
252 updateMetrics(single_par);
254 if (flags & Update::FitCursor && fitCursor())
255 updateMetrics(false);
257 // tell the frontend to update the screen.
262 void BufferView::updateScrollbar()
264 Text & t = buffer_.text();
265 TextMetrics & tm = text_metrics_[&t];
267 int const parsize = int(t.paragraphs().size() - 1);
268 if (anchor_ref_ > parsize) {
269 anchor_ref_ = parsize;
274 << BOOST_CURRENT_FUNCTION
275 << " Updating scrollbar: height: " << t.paragraphs().size()
276 << " curr par: " << cursor_.bottom().pit()
277 << " default height " << defaultRowHeight() << endl;
279 // It would be better to fix the scrollbar to understand
280 // values in [0..1] and divide everything by wh
282 // estimated average paragraph height:
286 int h = tm.parMetrics(anchor_ref_).height();
288 // Normalize anchor/offset (MV):
289 while (offset_ref_ > h && anchor_ref_ < parsize) {
292 h = tm.parMetrics(anchor_ref_).height();
294 // Look at paragraph heights on-screen
297 for (pit_type pit = anchor_ref_; pit <= parsize; ++pit) {
300 int const h2 = tm.parMetrics(pit).height();
306 int const hav = sumh / nh;
307 // More realistic average paragraph height
312 scrollbarParameters_.height = (parsize + 1) * wh_;
313 scrollbarParameters_.position = anchor_ref_ * wh_ + int(offset_ref_ * wh_ / float(h));
314 scrollbarParameters_.lineScrollHeight = int(wh_ * defaultRowHeight() / float(h));
318 ScrollbarParameters const & BufferView::scrollbarParameters() const
320 return scrollbarParameters_;
324 void BufferView::scrollDocView(int value)
326 LYXERR(Debug::GUI) << BOOST_CURRENT_FUNCTION
327 << "[ value = " << value << "]" << endl;
329 Text & t = buffer_.text();
330 TextMetrics & tm = text_metrics_[&t];
332 float const bar = value / float(wh_ * t.paragraphs().size());
334 anchor_ref_ = int(bar * t.paragraphs().size());
335 if (anchor_ref_ > int(t.paragraphs().size()) - 1)
336 anchor_ref_ = int(t.paragraphs().size()) - 1;
338 tm.redoParagraph(anchor_ref_);
339 int const h = tm.parMetrics(anchor_ref_).height();
340 offset_ref_ = int((bar * t.paragraphs().size() - anchor_ref_) * h);
341 updateMetrics(false);
345 void BufferView::setCursorFromScrollbar()
347 TextMetrics & tm = text_metrics_[&buffer_.text()];
349 int const height = 2 * defaultRowHeight();
350 int const first = height;
351 int const last = height_ - height;
352 Cursor & cur = cursor_;
354 bv_funcs::CurStatus st = bv_funcs::status(this, cur);
357 case bv_funcs::CUR_ABOVE:
358 // We reset the cursor because bv_funcs::status() does not
359 // work when the cursor is within mathed.
360 cur.reset(buffer_.inset());
361 tm.setCursorFromCoordinates(cur, 0, first);
362 cur.clearSelection();
364 case bv_funcs::CUR_BELOW:
365 // We reset the cursor because bv_funcs::status() does not
366 // work when the cursor is within mathed.
367 cur.reset(buffer_.inset());
368 tm.setCursorFromCoordinates(cur, 0, last);
369 cur.clearSelection();
371 case bv_funcs::CUR_INSIDE:
372 int const y = bv_funcs::getPos(*this, cur, cur.boundary()).y_;
373 int const newy = min(last, max(y, first));
375 cur.reset(buffer_.inset());
376 tm.setCursorFromCoordinates(cur, 0, newy);
382 Change const BufferView::getCurrentChange() const
384 if (!cursor_.selection())
385 return Change(Change::UNCHANGED);
387 DocIterator dit = cursor_.selectionBegin();
388 return dit.paragraph().lookupChange(dit.pos());
392 void BufferView::saveBookmark(unsigned int idx)
394 // tenatively save bookmark, id and pos will be used to
395 // acturately locate a bookmark in a 'live' lyx session.
396 // pit and pos will be updated with bottom level pit/pos
398 LyX::ref().session().bookmarks().save(
399 FileName(buffer_.fileName()),
400 cursor_.bottom().pit(),
401 cursor_.bottom().pos(),
402 cursor_.paragraph().id(),
407 // emit message signal.
408 message(_("Save bookmark"));
412 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
413 int top_id, pos_type top_pos)
415 bool success = false;
418 cursor_.clearSelection();
420 // if a valid par_id is given, try it first
421 // This is the case for a 'live' bookmark when unique paragraph ID
422 // is used to track bookmarks.
424 ParIterator par = buffer_.getParFromID(top_id);
425 if (par != buffer_.par_iterator_end()) {
426 doc_it = makeDocIterator(par, min(par->size(), top_pos));
427 // Some slices of the iterator may not be
428 // reachable (e.g. closed collapsable inset)
429 // so the dociterator may need to be
430 // shortened. Otherwise, setCursor may crash
431 // lyx when the cursor can not be set to these
433 size_t const n = doc_it.depth();
434 for (size_t i = 0; i < n; ++i)
435 if (doc_it[i].inset().editable() != Inset::HIGHLY_EDITABLE) {
443 // if top_id == 0, or searching through top_id failed
444 // This is the case for a 'restored' bookmark when only bottom
445 // (document level) pit was saved. Because of this, bookmark
446 // restoration is inaccurate. If a bookmark was within an inset,
447 // it will be restored to the left of the outmost inset that contains
449 if (static_cast<size_t>(bottom_pit) < buffer_.paragraphs().size()) {
450 doc_it = doc_iterator_begin(buffer_.inset());
451 doc_it.pit() = bottom_pit;
452 doc_it.pos() = min(bottom_pos, doc_it.paragraph().size());
457 // Note: only bottom (document) level pit is set.
459 // set the current font.
460 cursor_.setCurrentFont();
461 // center the screen on this new position.
469 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
471 if (lyxrc.rtl_support) {
472 if (cursor_.real_current_font.isRightToLeft()) {
473 if (intl_->keymap == Intl::PRIMARY)
476 if (intl_->keymap == Intl::SECONDARY)
481 intl_->getTransManager().translateAndInsert(c, t, cur);
485 int BufferView::workWidth() const
491 void BufferView::updateOffsetRef()
493 // No need to update offset_ref_ in this case.
494 if (!need_centering_)
497 // We are not properly started yet, delay until resizing is
502 CursorSlice & bot = cursor_.bottom();
503 TextMetrics & tm = text_metrics_[bot.text()];
504 ParagraphMetrics const & pm = tm.parMetrics(bot.pit());
505 Point p = bv_funcs::coordOffset(*this, cursor_, cursor_.boundary());
506 offset_ref_ = p.y_ + pm.ascent() - height_ / 2;
508 need_centering_ = false;
512 void BufferView::center()
514 anchor_ref_ = cursor_.bottom().pit();
515 need_centering_ = true;
519 FuncStatus BufferView::getStatus(FuncRequest const & cmd)
523 Cursor & cur = cursor_;
525 switch (cmd.action) {
528 flag.enabled(!buffer_.undostack().empty());
531 flag.enabled(!buffer_.redostack().empty());
533 case LFUN_FILE_INSERT:
534 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
535 case LFUN_FILE_INSERT_PLAINTEXT:
536 case LFUN_BOOKMARK_SAVE:
537 // FIXME: Actually, these LFUNS should be moved to Text
538 flag.enabled(cur.inTexted());
540 case LFUN_FONT_STATE:
541 case LFUN_LABEL_INSERT:
542 case LFUN_PARAGRAPH_GOTO:
543 // FIXME handle non-trivially
544 case LFUN_OUTLINE_UP:
545 case LFUN_OUTLINE_DOWN:
546 case LFUN_OUTLINE_IN:
547 case LFUN_OUTLINE_OUT:
549 case LFUN_REFERENCE_NEXT:
551 case LFUN_WORD_REPLACE:
554 case LFUN_MARK_TOGGLE:
555 case LFUN_SCREEN_RECENTER:
556 case LFUN_BIBTEX_DATABASE_ADD:
557 case LFUN_BIBTEX_DATABASE_DEL:
558 case LFUN_WORDS_COUNT:
559 case LFUN_NEXT_INSET_TOGGLE:
563 case LFUN_LABEL_GOTO: {
564 flag.enabled(!cmd.argument().empty()
565 || getInsetByCode<InsetRef>(cur, Inset::REF_CODE));
569 case LFUN_CHANGES_TRACK:
571 flag.setOnOff(buffer_.params().trackChanges);
574 case LFUN_CHANGES_OUTPUT:
576 flag.setOnOff(buffer_.params().outputChanges);
579 case LFUN_CHANGES_MERGE:
580 case LFUN_CHANGE_NEXT:
581 case LFUN_ALL_CHANGES_ACCEPT:
582 case LFUN_ALL_CHANGES_REJECT:
583 // TODO: context-sensitive enabling of LFUNs
584 // In principle, these command should only be enabled if there
585 // is a change in the document. However, without proper
586 // optimizations, this will inevitably result in poor performance.
590 case LFUN_BUFFER_TOGGLE_COMPRESSION: {
591 flag.setOnOff(buffer_.params().compressed);
603 Update::flags BufferView::dispatch(FuncRequest const & cmd)
605 //lyxerr << BOOST_CURRENT_FUNCTION
606 // << [ cmd = " << cmd << "]" << endl;
608 // Make sure that the cached BufferView is correct.
609 LYXERR(Debug::ACTION) << BOOST_CURRENT_FUNCTION
610 << " action[" << cmd.action << ']'
611 << " arg[" << to_utf8(cmd.argument()) << ']'
612 << " x[" << cmd.x << ']'
613 << " y[" << cmd.y << ']'
614 << " button[" << cmd.button() << ']'
617 Cursor & cur = cursor_;
618 // Default Update flags.
619 Update::flags updateFlags = Update::Force | Update::FitCursor;
621 switch (cmd.action) {
624 cur.message(_("Undo"));
625 cur.clearSelection();
626 if (!textUndo(*this)) {
627 cur.message(_("No further undo information"));
628 updateFlags = Update::None;
633 cur.message(_("Redo"));
634 cur.clearSelection();
635 if (!textRedo(*this)) {
636 cur.message(_("No further redo information"));
637 updateFlags = Update::None;
641 case LFUN_FILE_INSERT:
643 menuInsertLyXFile(to_utf8(cmd.argument()));
646 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
648 insertPlaintextFile(this, to_utf8(cmd.argument()), true);
651 case LFUN_FILE_INSERT_PLAINTEXT:
653 insertPlaintextFile(this, to_utf8(cmd.argument()), false);
656 case LFUN_FONT_STATE:
657 cur.message(cur.currentState());
660 case LFUN_BOOKMARK_SAVE:
661 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
664 case LFUN_LABEL_GOTO: {
665 docstring label = cmd.argument();
668 getInsetByCode<InsetRef>(cursor_,
671 label = inset->getParam("reference");
672 // persistent=false: use temp_bookmark
682 case LFUN_PARAGRAPH_GOTO: {
683 int const id = convert<int>(to_utf8(cmd.argument()));
685 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
686 b = theBufferList().next(b)) {
688 ParIterator par = b->getParFromID(id);
689 if (par == b->par_iterator_end()) {
691 << "No matching paragraph found! ["
692 << id << "]." << endl;
695 << "Paragraph " << par->id()
696 << " found in buffer `"
697 << b->fileName() << "'." << endl;
701 setCursor(makeDocIterator(par, 0));
703 // Switch to other buffer view and resend cmd
704 theLyXFunc().dispatch(FuncRequest(
705 LFUN_BUFFER_SWITCH, b->fileName()));
706 theLyXFunc().dispatch(cmd);
707 updateFlags = Update::None;
716 case LFUN_OUTLINE_UP:
717 toc::outline(toc::Up, cursor_);
718 cursor_.text()->setCursor(cursor_, cursor_.pit(), 0);
719 updateLabels(buffer_);
721 case LFUN_OUTLINE_DOWN:
722 toc::outline(toc::Down, cursor_);
723 cursor_.text()->setCursor(cursor_, cursor_.pit(), 0);
724 updateLabels(buffer_);
726 case LFUN_OUTLINE_IN:
727 toc::outline(toc::In, cursor_);
728 updateLabels(buffer_);
730 case LFUN_OUTLINE_OUT:
731 toc::outline(toc::Out, cursor_);
732 updateLabels(buffer_);
736 bv_funcs::gotoInset(this, Inset::NOTE_CODE, false);
739 case LFUN_REFERENCE_NEXT: {
740 vector<Inset_code> tmp;
741 tmp.push_back(Inset::LABEL_CODE);
742 tmp.push_back(Inset::REF_CODE);
743 bv_funcs::gotoInset(this, tmp, true);
747 case LFUN_CHANGES_TRACK:
748 buffer_.params().trackChanges = !buffer_.params().trackChanges;
751 case LFUN_CHANGES_OUTPUT:
752 buffer_.params().outputChanges = !buffer_.params().outputChanges;
753 if (buffer_.params().outputChanges) {
754 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
755 bool xcolorsoul = LaTeXFeatures::isAvailable("soul") &&
756 LaTeXFeatures::isAvailable("xcolor");
758 if (!dvipost && !xcolorsoul) {
759 Alert::warning(_("Changes not shown in LaTeX output"),
760 _("Changes will not be highlighted in LaTeX output, "
761 "because neither dvipost nor xcolor/soul are installed.\n"
762 "Please install these packages or redefine "
763 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
764 } else if (!xcolorsoul) {
765 Alert::warning(_("Changes not shown in LaTeX output"),
766 _("Changes will not be highlighted in LaTeX output "
767 "when using pdflatex, because xcolor and soul are not installed.\n"
768 "Please install both packages or redefine "
769 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
774 case LFUN_CHANGE_NEXT:
775 findNextChange(this);
778 case LFUN_CHANGES_MERGE:
779 if (findNextChange(this))
780 showDialog("changes");
783 case LFUN_ALL_CHANGES_ACCEPT:
784 // select complete document
785 cursor_.reset(buffer_.inset());
786 cursor_.selHandle(true);
787 buffer_.text().cursorBottom(cursor_);
788 // accept everything in a single step to support atomic undo
789 buffer_.text().acceptOrRejectChanges(cursor_, Text::ACCEPT);
792 case LFUN_ALL_CHANGES_REJECT:
793 // select complete document
794 cursor_.reset(buffer_.inset());
795 cursor_.selHandle(true);
796 buffer_.text().cursorBottom(cursor_);
797 // reject everything in a single step to support atomic undo
798 // Note: reject does not work recursively; the user may have to repeat the operation
799 buffer_.text().acceptOrRejectChanges(cursor_, Text::REJECT);
806 case LFUN_WORD_REPLACE: {
807 bool has_deleted = false;
808 if (cur.selection()) {
809 DocIterator beg = cur.selectionBegin();
810 DocIterator end = cur.selectionEnd();
811 if (beg.pit() == end.pit()) {
812 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
813 if (cur.paragraph().isDeleted(p))
818 replace(this, cmd, has_deleted);
823 cur.clearSelection();
825 cur.message(from_utf8(N_("Mark off")));
829 cur.clearSelection();
832 cur.message(from_utf8(N_("Mark on")));
835 case LFUN_MARK_TOGGLE:
836 cur.clearSelection();
839 cur.message(from_utf8(N_("Mark removed")));
842 cur.message(from_utf8(N_("Mark set")));
847 case LFUN_SCREEN_RECENTER:
851 case LFUN_BIBTEX_DATABASE_ADD: {
852 Cursor tmpcur = cursor_;
853 bv_funcs::findInset(tmpcur, Inset::BIBTEX_CODE, false);
854 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
857 if (inset->addDatabase(to_utf8(cmd.argument())))
858 buffer_.updateBibfilesCache();
863 case LFUN_BIBTEX_DATABASE_DEL: {
864 Cursor tmpcur = cursor_;
865 bv_funcs::findInset(tmpcur, Inset::BIBTEX_CODE, false);
866 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
869 if (inset->delDatabase(to_utf8(cmd.argument())))
870 buffer_.updateBibfilesCache();
875 case LFUN_WORDS_COUNT: {
876 DocIterator from, to;
877 if (cur.selection()) {
878 from = cur.selectionBegin();
879 to = cur.selectionEnd();
881 from = doc_iterator_begin(buffer_.inset());
882 to = doc_iterator_end(buffer_.inset());
884 int const count = countWords(from, to);
888 message = bformat(_("%1$d words in selection."),
891 message = bformat(_("%1$d words in document."),
896 message = _("One word in selection.");
898 message = _("One word in document.");
901 Alert::information(_("Count words"), message);
905 case LFUN_BUFFER_TOGGLE_COMPRESSION:
906 // turn compression on/off
907 buffer_.params().compressed = !buffer_.params().compressed;
910 case LFUN_NEXT_INSET_TOGGLE: {
911 // this is the real function we want to invoke
912 FuncRequest tmpcmd = FuncRequest(LFUN_INSET_TOGGLE, cmd.origin);
913 // if there is an inset at cursor, see whether it
915 Inset * inset = cur.nextInset();
916 if (inset && inset->isActive()) {
918 tmpcur.pushLeft(*inset);
919 inset->dispatch(tmpcur, tmpcmd);
920 if (tmpcur.result().dispatched()) {
924 // if it did not work, try the underlying inset.
925 if (!cur.result().dispatched())
926 cur.dispatch(tmpcmd);
928 if (cur.result().dispatched())
929 cur.clearSelection();
935 updateFlags = Update::None;
942 docstring const BufferView::requestSelection()
944 Cursor & cur = cursor_;
946 if (!cur.selection()) {
947 xsel_cache_.set = false;
951 if (!xsel_cache_.set ||
952 cur.top() != xsel_cache_.cursor ||
953 cur.anchor_.top() != xsel_cache_.anchor)
955 xsel_cache_.cursor = cur.top();
956 xsel_cache_.anchor = cur.anchor_.top();
957 xsel_cache_.set = cur.selection();
958 return cur.selectionAsString(false);
964 void BufferView::clearSelection()
966 cursor_.clearSelection();
967 // Clear the selection buffer. Otherwise a subsequent
968 // middle-mouse-button paste would use the selection buffer,
969 // not the more current external selection.
970 cap::clearSelection();
971 xsel_cache_.set = false;
972 // The buffer did not really change, but this causes the
973 // redraw we need because we cleared the selection above.
978 void BufferView::resize(int width, int height)
980 // Update from work area
984 updateMetrics(false);
988 Inset const * BufferView::getCoveringInset(Text const & text, int x, int y)
990 pit_type pit = text_metrics_[&text].getPitNearY(y);
991 BOOST_ASSERT(pit != -1);
992 Paragraph const & par = text.getPar(pit);
995 << BOOST_CURRENT_FUNCTION
1000 InsetList::const_iterator iit = par.insetlist.begin();
1001 InsetList::const_iterator iend = par.insetlist.end();
1002 for (; iit != iend; ++iit) {
1003 Inset * const inset = iit->inset;
1004 if (inset->covers(*this, x, y)) {
1005 if (!inset->descendable())
1006 // No need to go further down if the inset is not
1010 size_t cell_number = inset->nargs();
1011 // Check all the inner cell.
1012 for (size_t i = 0; i != cell_number; ++i) {
1013 Text const * inner_text = inset->getText(i);
1016 Inset const * inset_deeper =
1017 getCoveringInset(*inner_text, x, y);
1019 return inset_deeper;
1023 LYXERR(Debug::DEBUG)
1024 << BOOST_CURRENT_FUNCTION
1025 << ": Hit inset: " << inset << endl;
1029 LYXERR(Debug::DEBUG)
1030 << BOOST_CURRENT_FUNCTION
1031 << ": No inset hit. " << endl;
1036 bool BufferView::workAreaDispatch(FuncRequest const & cmd0)
1038 //lyxerr << BOOST_CURRENT_FUNCTION << "[ cmd0 " << cmd0 << "]" << endl;
1040 // This is only called for mouse related events including
1041 // LFUN_FILE_OPEN generated by drag-and-drop.
1042 FuncRequest cmd = cmd0;
1045 cur.push(buffer_.inset());
1046 cur.selection() = cursor_.selection();
1048 // Either the inset under the cursor or the
1049 // surrounding Text will handle this event.
1051 // make sure we stay within the screen...
1052 cmd.y = min(max(cmd.y, -1), height_);
1054 if (cmd.action == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
1056 // Get inset under mouse, if there is one.
1057 Inset const * covering_inset =
1058 getCoveringInset(buffer_.text(), cmd.x, cmd.y);
1059 if (covering_inset == last_inset_)
1060 // Same inset, no need to do anything...
1063 bool need_redraw = false;
1064 // const_cast because of setMouseHover().
1065 Inset * inset = const_cast<Inset *>(covering_inset);
1067 // Remove the hint on the last hovered inset (if any).
1068 need_redraw |= last_inset_->setMouseHover(false);
1070 // Highlighted the newly hovered inset (if any).
1071 need_redraw |= inset->setMouseHover(true);
1072 last_inset_ = inset;
1074 // if last metrics update was in singlepar mode, WorkArea::redraw() will
1075 // not expose the button for redraw. We adjust here the metrics dimension
1076 // to enable a full redraw.
1077 // FIXME: It is possible to redraw only the area around the button!
1079 && metrics_info_.update_strategy == SingleParUpdate) {
1080 // FIXME: It should be possible to redraw only the area around
1081 // the button by doing this:
1083 //metrics_info_.singlepar = false;
1084 //metrics_info_.y1 = ymin of button;
1085 //metrics_info_.y2 = ymax of button;
1087 // Unfortunately, BufferView::draw() does not distinguish
1088 // between background updates and text updates. So we use the hammer
1089 // solution for now. We could also avoid the updateMetrics() below
1090 // by using the first and last pit of the CoordCache. Have a look
1091 // at Text::getPitNearY() to see what I mean.
1093 //metrics_info_.pit1 = first pit of CoordCache;
1094 //metrics_info_.pit2 = last pit of CoordCache;
1095 //metrics_info_.singlepar = false;
1096 //metrics_info_.y1 = 0;
1097 //metrics_info_.y2 = height_;
1099 updateMetrics(false);
1102 // This event (moving without mouse click) is not passed further.
1103 // This should be changed if it is further utilized.
1107 // Build temporary cursor.
1108 Inset * inset = text_metrics_[&buffer_.text()].editXY(cur, cmd.x, cmd.y);
1110 // Put anchor at the same position.
1113 // Try to dispatch to an non-editable inset near this position
1114 // via the temp cursor. If the inset wishes to change the real
1115 // cursor it has to do so explicitly by using
1116 // cur.bv().cursor() = cur; (or similar)
1118 inset->dispatch(cur, cmd);
1121 // Now dispatch to the temporary cursor. If the real cursor should
1122 // be modified, the inset's dispatch has to do so explicitly.
1123 if (!cur.result().dispatched())
1126 //Do we have a selection?
1127 theSelection().haveSelection(cursor().selection());
1129 // Redraw if requested and necessary.
1130 if (cur.result().dispatched() && cur.result().update())
1131 return update(cur.result().update());
1137 void BufferView::scroll(int /*lines*/)
1139 // Text const * t = buffer_.text();
1140 // int const line_height = defaultRowHeight();
1142 // // The new absolute coordinate
1143 // int new_top_y = top_y() + lines * line_height;
1145 // // Restrict to a valid value
1146 // new_top_y = std::min(t->height() - 4 * line_height, new_top_y);
1147 // new_top_y = std::max(0, new_top_y);
1149 // scrollDocView(new_top_y);
1154 void BufferView::setCursorFromRow(int row)
1159 buffer_.texrow().getIdFromRow(row, tmpid, tmppos);
1161 cursor_.reset(buffer_.inset());
1163 buffer_.text().setCursor(cursor_, 0, 0);
1165 buffer_.text().setCursor(cursor_, buffer_.getParFromID(tmpid).pit(), tmppos);
1169 void BufferView::gotoLabel(docstring const & label)
1171 for (InsetIterator it = inset_iterator_begin(buffer_.inset()); it; ++it) {
1172 vector<docstring> labels;
1173 it->getLabelList(buffer_, labels);
1174 if (std::find(labels.begin(), labels.end(), label) != labels.end()) {
1183 TextMetrics const & BufferView::textMetrics(Text const * t) const
1185 return const_cast<BufferView *>(this)->textMetrics(t);
1189 TextMetrics & BufferView::textMetrics(Text const * t)
1191 TextMetricsCache::iterator tmc_it = text_metrics_.find(t);
1192 if (tmc_it == text_metrics_.end()) {
1193 tmc_it = text_metrics_.insert(
1194 make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
1196 return tmc_it->second;
1200 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
1203 return textMetrics(t).parMetrics(pit);
1207 int BufferView::workHeight() const
1213 void BufferView::setCursor(DocIterator const & dit)
1215 size_t const n = dit.depth();
1216 for (size_t i = 0; i < n; ++i)
1217 dit[i].inset().edit(cursor_, true);
1219 cursor_.setCursor(dit);
1220 cursor_.selection() = false;
1224 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
1226 // Would be wrong to delete anything if we have a selection.
1227 if (cur.selection())
1230 bool need_anchor_change = false;
1231 bool changed = cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
1232 need_anchor_change);
1234 if (need_anchor_change)
1240 updateLabels(buffer_);
1242 updateMetrics(false);
1248 bool BufferView::mouseSetCursor(Cursor & cur)
1250 BOOST_ASSERT(&cur.bv() == this);
1252 // this event will clear selection so we save selection for
1253 // persistent selection
1254 cap::saveSelection(cursor());
1256 // Has the cursor just left the inset?
1257 bool badcursor = false;
1258 bool leftinset = (&cursor_.inset() != &cur.inset());
1260 badcursor = notifyCursorLeaves(cursor_, cur);
1262 // do the dEPM magic if needed
1263 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
1264 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
1265 // the leftinset bool would not be necessary (badcursor instead).
1266 bool update = leftinset;
1267 if (!badcursor && cursor_.inTexted())
1268 update |= checkDepm(cur, cursor_);
1270 // if the cursor was in an empty script inset and the new
1271 // position is in the nucleus of the inset, notifyCursorLeaves
1272 // will kill the script inset itself. So we check all the
1273 // elements of the cursor to make sure that they are correct.
1274 // For an example, see bug 2933:
1275 // http://bugzilla.lyx.org/show_bug.cgi?id=2933
1276 // The code below could maybe be moved to a DocIterator method.
1277 //lyxerr << "cur before " << cur <<std::endl;
1278 DocIterator dit(cur.inset());
1279 dit.push_back(cur.bottom());
1281 while (i < cur.depth() && dit.nextInset() == &cur[i].inset()) {
1282 dit.push_back(cur[i]);
1285 //lyxerr << "5 cur after" << dit <<std::endl;
1287 cursor_.setCursor(dit);
1288 cursor_.boundary(cur.boundary());
1289 cursor_.clearSelection();
1295 void BufferView::putSelectionAt(DocIterator const & cur,
1296 int length, bool backwards)
1298 cursor_.clearSelection();
1304 cursor_.pos() += length;
1305 cursor_.setSelection(cursor_, -length);
1307 cursor_.setSelection(cursor_, length);
1312 Cursor & BufferView::cursor()
1318 Cursor const & BufferView::cursor() const
1324 pit_type BufferView::anchor_ref() const
1330 ViewMetricsInfo const & BufferView::viewMetricsInfo()
1332 return metrics_info_;
1336 // FIXME: We should split-up updateMetrics() for the singlepar case.
1337 void BufferView::updateMetrics(bool singlepar)
1339 Text & buftext = buffer_.text();
1340 pit_type size = int(buftext.paragraphs().size());
1342 if (anchor_ref_ > int(buftext.paragraphs().size() - 1)) {
1343 anchor_ref_ = int(buftext.paragraphs().size() - 1);
1348 // Clear out the position cache in case of full screen redraw,
1349 coord_cache_.clear();
1351 // Clear out paragraph metrics to avoid having invalid metrics
1352 // in the cache from paragraphs not relayouted below
1353 // The complete text metrics will be redone.
1354 text_metrics_.clear();
1357 TextMetrics & tm = textMetrics(&buftext);
1359 // If the paragraph metrics has changed, we can not
1360 // use the singlepar optimisation.
1362 // In Single Paragraph mode, rebreak only
1363 // the (main text, not inset!) paragraph containing the cursor.
1364 // (if this paragraph contains insets etc., rebreaking will
1365 // recursively descend)
1366 && tm.redoParagraph(cursor_.bottom().pit()))
1369 pit_type const pit = anchor_ref_;
1372 size_t const npit = buftext.paragraphs().size();
1374 // Rebreak anchor paragraph.
1376 tm.redoParagraph(pit);
1380 int y0 = tm.parMetrics(pit).ascent() - offset_ref_;
1382 // Redo paragraphs above anchor if necessary.
1384 while (y1 > 0 && pit1 > 0) {
1385 y1 -= tm.parMetrics(pit1).ascent();
1388 tm.redoParagraph(pit1);
1389 y1 -= tm.parMetrics(pit1).descent();
1393 // Take care of ascent of first line
1394 y1 -= tm.parMetrics(pit1).ascent();
1396 // Normalize anchor for next time
1400 // Grey at the beginning is ugly
1401 if (pit1 == 0 && y1 > 0) {
1407 // Redo paragraphs below the anchor if necessary.
1409 while (y2 < height_ && pit2 < int(npit) - 1) {
1410 y2 += tm.parMetrics(pit2).descent();
1413 tm.redoParagraph(pit2);
1414 y2 += tm.parMetrics(pit2).ascent();
1417 // Take care of descent of last line
1418 y2 += tm.parMetrics(pit2).descent();
1420 // The coordinates of all these paragraphs are correct, cache them
1422 CoordCache::InnerParPosCache & parPos = coord_cache_.parPos()[&buftext];
1423 for (pit_type pit = pit1; pit <= pit2; ++pit) {
1424 ParagraphMetrics const & pm = tm.parMetrics(pit);
1426 parPos[pit] = Point(0, y);
1427 if (singlepar && pit == cursor_.bottom().pit()) {
1428 // In Single Paragraph mode, collect here the
1429 // y1 and y2 of the (one) paragraph the cursor is in
1430 y1 = y - pm.ascent();
1431 y2 = y + pm.descent();
1437 // collect cursor paragraph iter bounds
1438 pit1 = cursor_.bottom().pit();
1439 pit2 = cursor_.bottom().pit();
1442 LYXERR(Debug::DEBUG)
1443 << BOOST_CURRENT_FUNCTION
1446 << " pit1: " << pit1
1447 << " pit2: " << pit2
1448 << " npit: " << npit
1449 << " singlepar: " << singlepar
1453 metrics_info_ = ViewMetricsInfo(pit1, pit2, y1, y2,
1454 singlepar? SingleParUpdate: FullScreenUpdate, size);
1456 if (lyxerr.debugging(Debug::WORKAREA)) {
1457 LYXERR(Debug::WORKAREA) << "BufferView::updateMetrics" << endl;
1458 coord_cache_.dump();
1463 void BufferView::menuInsertLyXFile(string const & filenm)
1465 BOOST_ASSERT(cursor_.inTexted());
1466 string filename = filenm;
1468 if (filename.empty()) {
1469 // Launch a file browser
1471 string initpath = lyxrc.document_path;
1472 string const trypath = buffer_.filePath();
1473 // If directory is writeable, use this as default.
1474 if (isDirWriteable(FileName(trypath)))
1478 FileDialog fileDlg(_("Select LyX document to insert"),
1480 make_pair(_("Documents|#o#O"), from_utf8(lyxrc.document_path)),
1481 make_pair(_("Examples|#E#e"),
1482 from_utf8(addPath(package().system_support().absFilename(),
1485 FileDialog::Result result =
1486 fileDlg.open(from_utf8(initpath),
1487 FileFilterList(_("LyX Documents (*.lyx)")),
1490 if (result.first == FileDialog::Later)
1494 filename = to_utf8(result.second);
1496 // check selected filename
1497 if (filename.empty()) {
1498 // emit message signal.
1499 message(_("Canceled."));
1504 // Get absolute path of file and add ".lyx"
1505 // to the filename if necessary
1506 filename = fileSearch(string(), filename, "lyx").absFilename();
1508 docstring const disp_fn = makeDisplayPath(filename);
1509 // emit message signal.
1510 message(bformat(_("Inserting document %1$s..."), disp_fn));
1513 Buffer buf("", false);
1514 if (lyx::loadLyXFile(&buf, FileName(filename))) {
1515 ErrorList & el = buffer_.errorList("Parse");
1516 // Copy the inserted document error list into the current buffer one.
1517 el = buf.errorList("Parse");
1518 recordUndo(cursor_);
1519 cap::pasteParagraphList(cursor_, buf.paragraphs(),
1520 buf.params().getTextClass_ptr(), el);
1521 res = _("Document %1$s inserted.");
1523 res = _("Could not insert document %1$s");
1525 // emit message signal.
1526 message(bformat(res, disp_fn));
1527 buffer_.errors("Parse");
1528 updateMetrics(false);
1532 void BufferView::draw(frontend::Painter & pain)
1534 PainterInfo pi(this, pain);
1535 // Should the whole screen, including insets, be refreshed?
1536 // FIXME: We should also distinguish DecorationUpdate to avoid text
1537 // drawing if possible. This is not possible to do easily right now
1538 // because of the single backing pixmap.
1539 pi.full_repaint = metrics_info_.update_strategy != SingleParUpdate;
1541 if (pi.full_repaint)
1542 // Clear background (if not delegated to rows)
1543 pain.fillRectangle(0, metrics_info_.y1, width_,
1544 metrics_info_.y2 - metrics_info_.y1,
1545 buffer_.inset().backgroundColor());
1547 LYXERR(Debug::PAINTING) << "\t\t*** START DRAWING ***" << endl;
1548 Text & text = buffer_.text();
1549 TextMetrics const & tm = text_metrics_[&text];
1550 if (!pi.full_repaint)
1551 tm.drawParagraph(pi, metrics_info_.p1, 0,
1552 metrics_info_.y1 + tm.parMetrics(metrics_info_.p1).ascent());
1554 tm.draw(pi, 0, metrics_info_.y1);
1555 LYXERR(Debug::PAINTING) << "\n\t\t*** END DRAWING ***" << endl;
1557 // and grey out above (should not happen later)
1558 // lyxerr << "par ascent: " << text.getPar(metrics_info_.p1).ascent() << endl;
1559 if (metrics_info_.y1 > 0
1560 && metrics_info_.update_strategy == FullScreenUpdate)
1561 pain.fillRectangle(0, 0, width_, metrics_info_.y1, Color::bottomarea);
1563 // and possibly grey out below
1564 // lyxerr << "par descent: " << text.getPar(metrics_info_.p1).ascent() << endl;
1565 if (metrics_info_.y2 < height_
1566 && metrics_info_.update_strategy == FullScreenUpdate)
1567 pain.fillRectangle(0, metrics_info_.y2, width_,
1568 height_ - metrics_info_.y2, Color::bottomarea);