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 "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"
43 #include "MetricsInfo.h"
44 #include "Paragraph.h"
45 #include "paragraph_funcs.h"
46 #include "ParagraphParameters.h"
47 #include "ParIterator.h"
50 #include "TextClass.h"
51 #include "TextMetrics.h"
54 #include "WordLangTuple.h"
57 #include "insets/InsetBibtex.h"
58 #include "insets/InsetCommand.h" // ChangeRefs
59 #include "insets/InsetRef.h"
60 #include "insets/InsetText.h"
62 #include "frontends/alert.h"
63 #include "frontends/Delegates.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"
76 #include "support/fs_extras.h"
78 #include <boost/bind.hpp>
79 #include <boost/current_function.hpp>
80 #include <boost/next_prior.hpp>
81 #include <boost/filesystem/operations.hpp>
91 using std::istringstream;
92 using std::istream_iterator;
96 using std::mem_fun_ref;
100 namespace fs = boost::filesystem;
104 using support::addPath;
105 using support::bformat;
106 using support::FileFilterList;
107 using support::FileName;
108 using support::fileSearch;
109 using support::makeDisplayPath;
110 using support::makeAbsPath;
111 using support::package;
113 namespace Alert = frontend::Alert;
117 /// Return an inset of this class if it exists at the current cursor position
119 T * getInsetByCode(Cursor const & cur, InsetCode code)
121 DocIterator it = cur;
122 Inset * inset = it.nextInset();
123 if (inset && inset->lyxCode() == code)
124 return static_cast<T*>(inset);
129 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
132 bool findNextInset(DocIterator & dit, vector<InsetCode> const & codes,
133 string const & contents)
135 DocIterator tmpdit = dit;
138 Inset const * inset = tmpdit.nextInset();
140 && find(codes.begin(), codes.end(), inset->lyxCode()) != codes.end()
141 && (contents.empty() ||
142 static_cast<InsetCommand const *>(inset)->getContents() == contents)) {
146 tmpdit.forwardInset();
153 /// Looks for next inset with one of the the given code
154 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
158 DocIterator tmpdit = dit;
159 tmpdit.forwardInset();
164 Inset const * inset = tmpdit.nextInset();
166 && find(codes.begin(), codes.end(), inset->lyxCode()) != codes.end()) {
167 contents = static_cast<InsetCommand const *>(inset)->getContents();
171 if (!findNextInset(tmpdit, codes, contents)) {
172 if (dit.depth() != 1 || dit.pit() != 0 || dit.pos() != 0) {
173 tmpdit = doc_iterator_begin(tmpdit.bottom().inset());
174 if (!findNextInset(tmpdit, codes, contents))
185 /// Looks for next inset with the given code
186 void findInset(DocIterator & dit, InsetCode code, bool same_content)
188 findInset(dit, vector<InsetCode>(1, code), same_content);
192 /// Moves cursor to the next inset with one of the given codes.
193 void gotoInset(BufferView * bv, vector<InsetCode> const & codes,
196 Cursor tmpcur = bv->cursor();
197 if (!findInset(tmpcur, codes, same_content)) {
198 bv->cursor().message(_("No more insets"));
202 tmpcur.clearSelection();
203 bv->setCursor(tmpcur);
207 /// Moves cursor to the next inset with given code.
208 void gotoInset(BufferView * bv, InsetCode code, bool same_content)
210 gotoInset(bv, vector<InsetCode>(1, code), same_content);
215 /// the type of outline operation
217 OutlineUp, // Move this header with text down
218 OutlineDown, // Move this header with text up
219 OutlineIn, // Make this header deeper
220 OutlineOut // Make this header shallower
224 void outline(OutlineOp mode, Cursor & cur)
226 Buffer & buf = cur.buffer();
227 pit_type & pit = cur.pit();
228 ParagraphList & pars = buf.text().paragraphs();
229 ParagraphList::iterator bgn = pars.begin();
230 // The first paragraph of the area to be copied:
231 ParagraphList::iterator start = boost::next(bgn, pit);
232 // The final paragraph of area to be copied:
233 ParagraphList::iterator finish = start;
234 ParagraphList::iterator end = pars.end();
236 TextClass::const_iterator lit =
237 buf.params().getTextClass().begin();
238 TextClass::const_iterator const lend =
239 buf.params().getTextClass().end();
241 int const thistoclevel = start->layout()->toclevel;
245 // Move out (down) from this section header
248 // Seek the one (on same level) below
249 for (; finish != end; ++finish) {
250 toclevel = finish->layout()->toclevel;
251 if (toclevel != Layout::NOT_IN_TOC
252 && toclevel <= thistoclevel) {
256 ParagraphList::iterator dest = start;
257 // Move out (up) from this header
260 // Search previous same-level header above
263 toclevel = dest->layout()->toclevel;
265 && (toclevel == Layout::NOT_IN_TOC
266 || toclevel > thistoclevel));
267 // Not found; do nothing
268 if (toclevel == Layout::NOT_IN_TOC || toclevel > thistoclevel)
270 pit_type const newpit = std::distance(bgn, dest);
271 pit_type const len = std::distance(start, finish);
272 pit_type const deletepit = pit + len;
273 buf.undo().recordUndo(cur, ATOMIC_UNDO, newpit, deletepit - 1);
274 pars.insert(dest, start, finish);
275 start = boost::next(pars.begin(), deletepit);
277 pars.erase(start, finish);
281 // Go down out of current header:
284 // Find next same-level header:
285 for (; finish != end; ++finish) {
286 toclevel = finish->layout()->toclevel;
287 if (toclevel != Layout::NOT_IN_TOC && toclevel <= thistoclevel)
290 ParagraphList::iterator dest = finish;
291 // Go one down from *this* header:
296 // Go further down to find header to insert in front of:
297 for (; dest != end; ++dest) {
298 toclevel = dest->layout()->toclevel;
299 if (toclevel != Layout::NOT_IN_TOC && toclevel <= thistoclevel)
302 // One such was found:
303 pit_type newpit = std::distance(bgn, dest);
304 pit_type const len = std::distance(start, finish);
305 buf.undo().recordUndo(cur, ATOMIC_UNDO, pit, newpit - 1);
306 pars.insert(dest, start, finish);
307 start = boost::next(bgn, pit);
309 pars.erase(start, finish);
313 buf.undo().recordUndo(cur);
314 for (; lit != lend; ++lit) {
315 if ((*lit)->toclevel == thistoclevel + 1 &&
316 start->layout()->labeltype == (*lit)->labeltype) {
317 start->layout((*lit));
323 buf.undo().recordUndo(cur);
324 for (; lit != lend; ++lit) {
325 if ((*lit)->toclevel == thistoclevel - 1 &&
326 start->layout()->labeltype == (*lit)->labeltype) {
327 start->layout((*lit));
337 /// A map from a Text to the associated text metrics
338 typedef std::map<Text const *, TextMetrics> TextMetricsCache;
343 /////////////////////////////////////////////////////////////////////
347 /////////////////////////////////////////////////////////////////////
349 struct BufferView::Private
351 Private(BufferView & bv): wh_(0), cursor_(bv),
352 multiparsel_cache_(false), anchor_ref_(0), offset_ref_(0),
353 need_centering_(false), last_inset_(0), gui_(0)
357 ScrollbarParameters scrollbarParameters_;
359 ViewMetricsInfo metrics_info_;
361 CoordCache coord_cache_;
363 /// Estimated average par height for scrollbar.
365 /// this is used to handle XSelection events in the right manner.
374 bool multiparsel_cache_;
376 pit_type anchor_ref_;
380 bool need_centering_;
382 /// keyboard mapping object.
385 /// last visited inset.
386 /** kept to send setMouseHover(false).
387 * Not owned, so don't delete.
391 mutable TextMetricsCache text_metrics_;
394 /** Not owned, so don't delete.
396 frontend::GuiBufferViewDelegate * gui_;
400 BufferView::BufferView(Buffer & buf)
401 : width_(0), height_(0), buffer_(buf), d(new Private(*this))
403 d->xsel_cache_.set = false;
404 d->intl_.initKeyMapper(lyxrc.use_kbmap);
406 d->cursor_.push(buffer_.inset());
407 d->cursor_.resetAnchor();
408 d->cursor_.setCurrentFont();
410 if (graphics::Previews::status() != LyXRC::PREVIEW_OFF)
411 graphics::Previews::get().generateBufferPreviews(buffer_);
415 BufferView::~BufferView()
417 // current buffer is going to be switched-off, save cursor pos
418 // Ideally, the whole cursor stack should be saved, but session
419 // currently can only handle bottom (whole document) level pit and pos.
420 // That is to say, if a cursor is in a nested inset, it will be
421 // restore to the left of the top level inset.
422 LyX::ref().session().lastFilePos().save(
423 support::FileName(buffer_.fileName()),
424 boost::tie(d->cursor_.bottom().pit(), d->cursor_.bottom().pos()) );
430 Intl & BufferView::getIntl()
436 Intl const & BufferView::getIntl() const
442 CoordCache & BufferView::coordCache()
444 return d->coord_cache_;
448 CoordCache const & BufferView::coordCache() const
450 return d->coord_cache_;
454 Buffer & BufferView::buffer()
460 Buffer const & BufferView::buffer() const
466 bool BufferView::fitCursor()
468 if (cursorStatus(d->cursor_) == CUR_INSIDE) {
469 frontend::FontMetrics const & fm =
470 theFontMetrics(d->cursor_.getFont());
471 int const asc = fm.maxAscent();
472 int const des = fm.maxDescent();
473 Point const p = getPos(d->cursor_, d->cursor_.boundary());
474 if (p.y_ - asc >= 0 && p.y_ + des < height_)
482 bool BufferView::multiParSel()
484 if (!d->cursor_.selection())
486 bool ret = d->multiparsel_cache_;
487 d->multiparsel_cache_ = d->cursor_.selBegin().pit() != d->cursor_.selEnd().pit();
488 // Either this, or previous selection spans paragraphs
489 return ret || d->multiparsel_cache_;
493 void BufferView::processUpdateFlags(Update::flags flags)
495 // last_inset_ points to the last visited inset. This pointer may become
496 // invalid because of keyboard editing. Since all such operations
497 // causes screen update(), I reset last_inset_ to avoid such a problem.
499 // This is close to a hot-path.
501 << BOOST_CURRENT_FUNCTION
502 << "[fitcursor = " << (flags & Update::FitCursor)
503 << ", forceupdate = " << (flags & Update::Force)
504 << ", singlepar = " << (flags & Update::SinglePar)
505 << "] buffer: " << &buffer_ << endl;
507 // Update macro store
508 if (!(cursor().inMathed() && cursor().inMacroMode()))
509 buffer_.buildMacros();
511 // Now do the first drawing step if needed. This consists on updating
512 // the CoordCache in updateMetrics().
513 // The second drawing step is done in WorkArea::redraw() if needed.
515 // Case when no explicit update is requested.
517 // no need to redraw anything.
518 d->metrics_info_.update_strategy = NoScreenUpdate;
522 if (flags == Update::Decoration) {
523 d->metrics_info_.update_strategy = DecorationUpdate;
528 if (flags == Update::FitCursor
529 || flags == (Update::Decoration | Update::FitCursor)) {
530 bool const fit_cursor = fitCursor();
531 // tell the frontend to update the screen if needed.
533 updateMetrics(false);
537 if (flags & Update::Decoration) {
538 d->metrics_info_.update_strategy = DecorationUpdate;
542 // no screen update is needed.
543 d->metrics_info_.update_strategy = NoScreenUpdate;
547 bool full_metrics = flags & Update::Force;
548 if (flags & Update::MultiParSel)
549 full_metrics |= multiParSel();
551 bool const single_par = !full_metrics;
552 updateMetrics(single_par);
554 if (!(flags & Update::FitCursor)) {
559 //FIXME: updateMetrics() does not update paragraph position
560 // This is done at draw() time. So we need a redraw!
563 // The screen has already been updated thanks to the
564 // 'buffer_.changed()' call three line above. So no need
568 // The screen has been recentered around the cursor position so
570 updateMetrics(false);
575 void BufferView::updateScrollbar()
577 Text & t = buffer_.text();
578 TextMetrics & tm = d->text_metrics_[&t];
580 int const parsize = int(t.paragraphs().size() - 1);
581 if (d->anchor_ref_ > parsize) {
582 d->anchor_ref_ = parsize;
587 << BOOST_CURRENT_FUNCTION
588 << " Updating scrollbar: height: " << t.paragraphs().size()
589 << " curr par: " << d->cursor_.bottom().pit()
590 << " default height " << defaultRowHeight() << endl;
592 // It would be better to fix the scrollbar to understand
593 // values in [0..1] and divide everything by wh
595 // estimated average paragraph height:
597 d->wh_ = height_ / 4;
599 int h = tm.parMetrics(d->anchor_ref_).height();
601 // Normalize anchor/offset (MV):
602 while (d->offset_ref_ > h && d->anchor_ref_ < parsize) {
605 h = tm.parMetrics(d->anchor_ref_).height();
607 // Look at paragraph heights on-screen
610 for (pit_type pit = d->anchor_ref_; pit <= parsize; ++pit) {
613 int const h2 = tm.parMetrics(pit).height();
619 int const hav = sumh / nh;
620 // More realistic average paragraph height
625 d->scrollbarParameters_.height = (parsize + 1) * d->wh_;
626 d->scrollbarParameters_.position = d->anchor_ref_ * d->wh_ + int(d->offset_ref_ * d->wh_ / float(h));
627 d->scrollbarParameters_.lineScrollHeight = int(d->wh_ * defaultRowHeight() / float(h));
631 ScrollbarParameters const & BufferView::scrollbarParameters() const
633 return d->scrollbarParameters_;
637 void BufferView::scrollDocView(int value)
639 LYXERR(Debug::GUI) << BOOST_CURRENT_FUNCTION
640 << "[ value = " << value << "]" << endl;
642 Text & t = buffer_.text();
643 TextMetrics & tm = d->text_metrics_[&t];
645 float const bar = value / float(d->wh_ * t.paragraphs().size());
647 d->anchor_ref_ = int(bar * t.paragraphs().size());
648 if (d->anchor_ref_ > int(t.paragraphs().size()) - 1)
649 d->anchor_ref_ = int(t.paragraphs().size()) - 1;
651 tm.redoParagraph(d->anchor_ref_);
652 int const h = tm.parMetrics(d->anchor_ref_).height();
653 d->offset_ref_ = int((bar * t.paragraphs().size() - d->anchor_ref_) * h);
654 updateMetrics(false);
659 void BufferView::setCursorFromScrollbar()
661 TextMetrics & tm = d->text_metrics_[&buffer_.text()];
663 int const height = 2 * defaultRowHeight();
664 int const first = height;
665 int const last = height_ - height;
666 Cursor & cur = d->cursor_;
668 switch (cursorStatus(cur)) {
670 // We reset the cursor because cursorStatus() does not
671 // work when the cursor is within mathed.
672 cur.reset(buffer_.inset());
673 tm.setCursorFromCoordinates(cur, 0, first);
674 cur.clearSelection();
677 // We reset the cursor because cursorStatus() does not
678 // work when the cursor is within mathed.
679 cur.reset(buffer_.inset());
680 tm.setCursorFromCoordinates(cur, 0, last);
681 cur.clearSelection();
684 int const y = getPos(cur, cur.boundary()).y_;
685 int const newy = min(last, max(y, first));
687 cur.reset(buffer_.inset());
688 tm.setCursorFromCoordinates(cur, 0, newy);
694 Change const BufferView::getCurrentChange() const
696 if (!d->cursor_.selection())
697 return Change(Change::UNCHANGED);
699 DocIterator dit = d->cursor_.selectionBegin();
700 return dit.paragraph().lookupChange(dit.pos());
704 // this could be used elsewhere as well?
705 // FIXME: This does not work within mathed!
706 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
708 Point const p = getPos(dit, dit.boundary());
711 if (p.y_ > workHeight())
717 void BufferView::saveBookmark(unsigned int idx)
719 // tenatively save bookmark, id and pos will be used to
720 // acturately locate a bookmark in a 'live' lyx session.
721 // pit and pos will be updated with bottom level pit/pos
723 LyX::ref().session().bookmarks().save(
724 FileName(buffer_.fileName()),
725 d->cursor_.bottom().pit(),
726 d->cursor_.bottom().pos(),
727 d->cursor_.paragraph().id(),
732 // emit message signal.
733 message(_("Save bookmark"));
737 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
738 int top_id, pos_type top_pos)
740 bool success = false;
743 d->cursor_.clearSelection();
745 // if a valid par_id is given, try it first
746 // This is the case for a 'live' bookmark when unique paragraph ID
747 // is used to track bookmarks.
749 ParIterator par = buffer_.getParFromID(top_id);
750 if (par != buffer_.par_iterator_end()) {
751 doc_it = makeDocIterator(par, min(par->size(), top_pos));
752 // Some slices of the iterator may not be
753 // reachable (e.g. closed collapsable inset)
754 // so the dociterator may need to be
755 // shortened. Otherwise, setCursor may crash
756 // lyx when the cursor can not be set to these
758 size_t const n = doc_it.depth();
759 for (size_t i = 0; i < n; ++i)
760 if (doc_it[i].inset().editable() != Inset::HIGHLY_EDITABLE) {
768 // if top_id == 0, or searching through top_id failed
769 // This is the case for a 'restored' bookmark when only bottom
770 // (document level) pit was saved. Because of this, bookmark
771 // restoration is inaccurate. If a bookmark was within an inset,
772 // it will be restored to the left of the outmost inset that contains
774 if (static_cast<size_t>(bottom_pit) < buffer_.paragraphs().size()) {
775 doc_it = doc_iterator_begin(buffer_.inset());
776 doc_it.pit() = bottom_pit;
777 doc_it.pos() = min(bottom_pos, doc_it.paragraph().size());
782 // Note: only bottom (document) level pit is set.
784 // set the current font.
785 d->cursor_.setCurrentFont();
786 // center the screen on this new position.
794 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
796 if (lyxrc.rtl_support) {
797 if (d->cursor_.real_current_font.isRightToLeft()) {
798 if (d->intl_.keymap == Intl::PRIMARY)
799 d->intl_.keyMapSec();
801 if (d->intl_.keymap == Intl::SECONDARY)
802 d->intl_.keyMapPrim();
806 d->intl_.getTransManager().translateAndInsert(c, t, cur);
810 int BufferView::workWidth() const
816 void BufferView::updateOffsetRef()
818 // No need to update d->offset_ref_ in this case.
819 if (!d->need_centering_)
822 // We are not properly started yet, delay until resizing is
827 CursorSlice & bot = d->cursor_.bottom();
828 TextMetrics & tm = d->text_metrics_[bot.text()];
829 ParagraphMetrics const & pm = tm.parMetrics(bot.pit());
830 int y = coordOffset(d->cursor_, d->cursor_.boundary()).y_;
831 d->offset_ref_ = y + pm.ascent() - height_ / 2;
833 d->need_centering_ = false;
837 void BufferView::center()
839 d->anchor_ref_ = d->cursor_.bottom().pit();
840 d->need_centering_ = true;
844 FuncStatus BufferView::getStatus(FuncRequest const & cmd)
848 Cursor & cur = d->cursor_;
850 switch (cmd.action) {
853 flag.enabled(buffer_.undo().hasUndoStack());
856 flag.enabled(buffer_.undo().hasRedoStack());
858 case LFUN_FILE_INSERT:
859 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
860 case LFUN_FILE_INSERT_PLAINTEXT:
861 case LFUN_BOOKMARK_SAVE:
862 // FIXME: Actually, these LFUNS should be moved to Text
863 flag.enabled(cur.inTexted());
865 case LFUN_FONT_STATE:
866 case LFUN_LABEL_INSERT:
867 case LFUN_INFO_INSERT:
868 case LFUN_PARAGRAPH_GOTO:
869 // FIXME handle non-trivially
870 case LFUN_OUTLINE_UP:
871 case LFUN_OUTLINE_DOWN:
872 case LFUN_OUTLINE_IN:
873 case LFUN_OUTLINE_OUT:
875 case LFUN_REFERENCE_NEXT:
877 case LFUN_WORD_REPLACE:
880 case LFUN_MARK_TOGGLE:
881 case LFUN_SCREEN_RECENTER:
882 case LFUN_BIBTEX_DATABASE_ADD:
883 case LFUN_BIBTEX_DATABASE_DEL:
884 case LFUN_WORDS_COUNT:
885 case LFUN_NEXT_INSET_TOGGLE:
889 case LFUN_LABEL_GOTO: {
890 flag.enabled(!cmd.argument().empty()
891 || getInsetByCode<InsetRef>(cur, REF_CODE));
895 case LFUN_CHANGES_TRACK:
897 flag.setOnOff(buffer_.params().trackChanges);
900 case LFUN_CHANGES_OUTPUT:
902 flag.setOnOff(buffer_.params().outputChanges);
905 case LFUN_CHANGES_MERGE:
906 case LFUN_CHANGE_NEXT:
907 case LFUN_ALL_CHANGES_ACCEPT:
908 case LFUN_ALL_CHANGES_REJECT:
909 // TODO: context-sensitive enabling of LFUNs
910 // In principle, these command should only be enabled if there
911 // is a change in the document. However, without proper
912 // optimizations, this will inevitably result in poor performance.
916 case LFUN_BUFFER_TOGGLE_COMPRESSION: {
917 flag.setOnOff(buffer_.params().compressed);
922 case LFUN_SCREEN_DOWN:
926 // FIXME: LFUN_SCREEN_DOWN_SELECT should be removed from
927 // everywhere else before this can enabled:
928 case LFUN_SCREEN_UP_SELECT:
929 case LFUN_SCREEN_DOWN_SELECT:
933 case LFUN_LAYOUT_TABULAR:
934 flag.enabled(cur.innerInsetOfType(TABULAR_CODE));
938 case LFUN_LAYOUT_PARAGRAPH:
939 flag.enabled(cur.inset().forceDefaultParagraphs(cur.idx()));
942 case LFUN_INSET_SETTINGS: {
943 InsetCode code = cur.inset().lyxCode();
947 enable = cmd.argument() == "tabular";
950 enable = cmd.argument() == "ert";
953 enable = cmd.argument() == "float";
956 enable = cmd.argument() == "wrap";
959 enable = cmd.argument() == "note";
962 enable = cmd.argument() == "branch";
965 enable = cmd.argument() == "box";
968 enable = cmd.argument() == "listings";
973 flag.enabled(enable);
977 case LFUN_DIALOG_SHOW_NEW_INSET:
978 flag.enabled(cur.inset().lyxCode() != ERT_CODE &&
979 cur.inset().lyxCode() != LISTINGS_CODE);
980 if (cur.inset().lyxCode() == CAPTION_CODE) {
982 if (cur.inset().getStatus(cur, cmd, flag))
995 Update::flags BufferView::dispatch(FuncRequest const & cmd)
997 //lyxerr << BOOST_CURRENT_FUNCTION
998 // << [ cmd = " << cmd << "]" << endl;
1000 // Make sure that the cached BufferView is correct.
1001 LYXERR(Debug::ACTION) << BOOST_CURRENT_FUNCTION
1002 << " action[" << cmd.action << ']'
1003 << " arg[" << to_utf8(cmd.argument()) << ']'
1004 << " x[" << cmd.x << ']'
1005 << " y[" << cmd.y << ']'
1006 << " button[" << cmd.button() << ']'
1009 Cursor & cur = d->cursor_;
1010 // Default Update flags.
1011 Update::flags updateFlags = Update::Force | Update::FitCursor;
1013 switch (cmd.action) {
1016 cur.message(_("Undo"));
1017 cur.clearSelection();
1018 if (!cur.textUndo()) {
1019 cur.message(_("No further undo information"));
1020 updateFlags = Update::None;
1025 cur.message(_("Redo"));
1026 cur.clearSelection();
1027 if (!cur.textRedo()) {
1028 cur.message(_("No further redo information"));
1029 updateFlags = Update::None;
1033 case LFUN_FILE_INSERT:
1035 menuInsertLyXFile(to_utf8(cmd.argument()));
1038 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
1040 insertPlaintextFile(to_utf8(cmd.argument()), true);
1043 case LFUN_FILE_INSERT_PLAINTEXT:
1045 insertPlaintextFile(to_utf8(cmd.argument()), false);
1048 case LFUN_FONT_STATE:
1049 cur.message(cur.currentState());
1052 case LFUN_BOOKMARK_SAVE:
1053 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1056 case LFUN_LABEL_GOTO: {
1057 docstring label = cmd.argument();
1058 if (label.empty()) {
1060 getInsetByCode<InsetRef>(d->cursor_,
1063 label = inset->getParam("reference");
1064 // persistent=false: use temp_bookmark
1074 case LFUN_PARAGRAPH_GOTO: {
1075 int const id = convert<int>(to_utf8(cmd.argument()));
1077 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1078 b = theBufferList().next(b)) {
1080 ParIterator par = b->getParFromID(id);
1081 if (par == b->par_iterator_end()) {
1083 << "No matching paragraph found! ["
1084 << id << "]." << endl;
1087 << "Paragraph " << par->id()
1088 << " found in buffer `"
1089 << b->fileName() << "'." << endl;
1091 if (b == &buffer_) {
1093 setCursor(makeDocIterator(par, 0));
1095 // Switch to other buffer view and resend cmd
1096 theLyXFunc().dispatch(FuncRequest(
1097 LFUN_BUFFER_SWITCH, b->fileName()));
1098 theLyXFunc().dispatch(cmd);
1099 updateFlags = Update::None;
1108 case LFUN_OUTLINE_UP:
1109 outline(OutlineUp, d->cursor_);
1110 d->cursor_.text()->setCursor(d->cursor_, d->cursor_.pit(), 0);
1111 updateLabels(buffer_);
1113 case LFUN_OUTLINE_DOWN:
1114 outline(OutlineDown, d->cursor_);
1115 d->cursor_.text()->setCursor(d->cursor_, d->cursor_.pit(), 0);
1116 updateLabels(buffer_);
1118 case LFUN_OUTLINE_IN:
1119 outline(OutlineIn, d->cursor_);
1120 updateLabels(buffer_);
1122 case LFUN_OUTLINE_OUT:
1123 outline(OutlineOut, d->cursor_);
1124 updateLabels(buffer_);
1127 case LFUN_NOTE_NEXT:
1128 gotoInset(this, NOTE_CODE, false);
1131 case LFUN_REFERENCE_NEXT: {
1132 vector<InsetCode> tmp;
1133 tmp.push_back(LABEL_CODE);
1134 tmp.push_back(REF_CODE);
1135 gotoInset(this, tmp, true);
1139 case LFUN_CHANGES_TRACK:
1140 buffer_.params().trackChanges = !buffer_.params().trackChanges;
1143 case LFUN_CHANGES_OUTPUT:
1144 buffer_.params().outputChanges = !buffer_.params().outputChanges;
1145 if (buffer_.params().outputChanges) {
1146 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1147 bool xcolorsoul = LaTeXFeatures::isAvailable("soul") &&
1148 LaTeXFeatures::isAvailable("xcolor");
1150 if (!dvipost && !xcolorsoul) {
1151 Alert::warning(_("Changes not shown in LaTeX output"),
1152 _("Changes will not be highlighted in LaTeX output, "
1153 "because neither dvipost nor xcolor/soul are installed.\n"
1154 "Please install these packages or redefine "
1155 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1156 } else if (!xcolorsoul) {
1157 Alert::warning(_("Changes not shown in LaTeX output"),
1158 _("Changes will not be highlighted in LaTeX output "
1159 "when using pdflatex, because xcolor and soul are not installed.\n"
1160 "Please install both packages or redefine "
1161 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1166 case LFUN_CHANGE_NEXT:
1167 findNextChange(this);
1170 case LFUN_CHANGES_MERGE:
1171 if (findNextChange(this))
1172 showDialog("changes");
1175 case LFUN_ALL_CHANGES_ACCEPT:
1176 // select complete document
1177 d->cursor_.reset(buffer_.inset());
1178 d->cursor_.selHandle(true);
1179 buffer_.text().cursorBottom(d->cursor_);
1180 // accept everything in a single step to support atomic undo
1181 buffer_.text().acceptOrRejectChanges(d->cursor_, Text::ACCEPT);
1184 case LFUN_ALL_CHANGES_REJECT:
1185 // select complete document
1186 d->cursor_.reset(buffer_.inset());
1187 d->cursor_.selHandle(true);
1188 buffer_.text().cursorBottom(d->cursor_);
1189 // reject everything in a single step to support atomic undo
1190 // Note: reject does not work recursively; the user may have to repeat the operation
1191 buffer_.text().acceptOrRejectChanges(d->cursor_, Text::REJECT);
1194 case LFUN_WORD_FIND:
1198 case LFUN_WORD_REPLACE: {
1199 bool has_deleted = false;
1200 if (cur.selection()) {
1201 DocIterator beg = cur.selectionBegin();
1202 DocIterator end = cur.selectionEnd();
1203 if (beg.pit() == end.pit()) {
1204 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1205 if (cur.paragraph().isDeleted(p))
1210 replace(this, cmd, has_deleted);
1215 cur.clearSelection();
1217 cur.message(from_utf8(N_("Mark off")));
1221 cur.clearSelection();
1224 cur.message(from_utf8(N_("Mark on")));
1227 case LFUN_MARK_TOGGLE:
1228 cur.clearSelection();
1231 cur.message(from_utf8(N_("Mark removed")));
1234 cur.message(from_utf8(N_("Mark set")));
1239 case LFUN_SCREEN_RECENTER:
1243 case LFUN_BIBTEX_DATABASE_ADD: {
1244 Cursor tmpcur = d->cursor_;
1245 findInset(tmpcur, BIBTEX_CODE, false);
1246 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1249 if (inset->addDatabase(to_utf8(cmd.argument())))
1250 buffer_.updateBibfilesCache();
1255 case LFUN_BIBTEX_DATABASE_DEL: {
1256 Cursor tmpcur = d->cursor_;
1257 findInset(tmpcur, BIBTEX_CODE, false);
1258 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1261 if (inset->delDatabase(to_utf8(cmd.argument())))
1262 buffer_.updateBibfilesCache();
1267 case LFUN_WORDS_COUNT: {
1268 DocIterator from, to;
1269 if (cur.selection()) {
1270 from = cur.selectionBegin();
1271 to = cur.selectionEnd();
1273 from = doc_iterator_begin(buffer_.inset());
1274 to = doc_iterator_end(buffer_.inset());
1276 int const count = countWords(from, to);
1279 if (cur.selection())
1280 message = bformat(_("%1$d words in selection."),
1283 message = bformat(_("%1$d words in document."),
1287 if (cur.selection())
1288 message = _("One word in selection.");
1290 message = _("One word in document.");
1293 Alert::information(_("Count words"), message);
1297 case LFUN_BUFFER_TOGGLE_COMPRESSION:
1298 // turn compression on/off
1299 buffer_.params().compressed = !buffer_.params().compressed;
1302 case LFUN_NEXT_INSET_TOGGLE: {
1303 // this is the real function we want to invoke
1304 FuncRequest tmpcmd = FuncRequest(LFUN_INSET_TOGGLE, cmd.origin);
1305 // if there is an inset at cursor, see whether it
1307 Inset * inset = cur.nextInset();
1309 if (inset->isActive()) {
1310 Cursor tmpcur = cur;
1311 tmpcur.pushLeft(*inset);
1312 inset->dispatch(tmpcur, tmpcmd);
1313 if (tmpcur.result().dispatched()) {
1316 } else if (inset->editable() == Inset::IS_EDITABLE) {
1317 inset->edit(cur, true);
1320 // if it did not work, try the underlying inset.
1321 if (!cur.result().dispatched())
1322 cur.dispatch(tmpcmd);
1324 if (cur.result().dispatched())
1325 cur.clearSelection();
1330 case LFUN_SCREEN_UP:
1331 case LFUN_SCREEN_DOWN: {
1332 Point p = getPos(cur, cur.boundary());
1333 if (p.y_ < 0 || p.y_ > height_) {
1334 // The cursor is off-screen so recenter before proceeding.
1336 updateMetrics(false);
1337 //FIXME: updateMetrics() does not update paragraph position
1338 // This is done at draw() time. So we need a redraw!
1340 p = getPos(cur, cur.boundary());
1342 scroll(cmd.action == LFUN_SCREEN_UP? - height_ : height_);
1343 cur.reset(buffer_.inset());
1344 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_);
1345 //FIXME: what to do with cur.x_target()?
1347 // The metrics are already up to date. see scroll()
1348 updateFlags = Update::None;
1352 case LFUN_SCREEN_UP_SELECT:
1353 case LFUN_SCREEN_DOWN_SELECT: {
1354 cur.selHandle(true);
1355 size_t initial_depth = cur.depth();
1356 Point const p = getPos(cur, cur.boundary());
1357 scroll(cmd.action == LFUN_SCREEN_UP_SELECT? - height_ : height_);
1358 // FIXME: We need to verify if the cursor stayed within an inset...
1359 //cur.reset(buffer_.inset());
1360 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_);
1362 while (cur.depth() > initial_depth) {
1365 // FIXME: we need to do a redraw again because of the selection
1367 updateFlags = Update::Force | Update::FitCursor;
1372 updateFlags = Update::None;
1379 docstring const BufferView::requestSelection()
1381 Cursor & cur = d->cursor_;
1383 if (!cur.selection()) {
1384 d->xsel_cache_.set = false;
1388 if (!d->xsel_cache_.set ||
1389 cur.top() != d->xsel_cache_.cursor ||
1390 cur.anchor_.top() != d->xsel_cache_.anchor)
1392 d->xsel_cache_.cursor = cur.top();
1393 d->xsel_cache_.anchor = cur.anchor_.top();
1394 d->xsel_cache_.set = cur.selection();
1395 return cur.selectionAsString(false);
1401 void BufferView::clearSelection()
1403 d->cursor_.clearSelection();
1404 // Clear the selection buffer. Otherwise a subsequent
1405 // middle-mouse-button paste would use the selection buffer,
1406 // not the more current external selection.
1407 cap::clearSelection();
1408 d->xsel_cache_.set = false;
1409 // The buffer did not really change, but this causes the
1410 // redraw we need because we cleared the selection above.
1415 void BufferView::resize(int width, int height)
1417 // Update from work area
1421 updateMetrics(false);
1425 Inset const * BufferView::getCoveringInset(Text const & text, int x, int y)
1427 TextMetrics & tm = d->text_metrics_[&text];
1428 Inset * inset = tm.checkInsetHit(x, y);
1432 if (!inset->descendable())
1433 // No need to go further down if the inset is not
1437 size_t cell_number = inset->nargs();
1438 // Check all the inner cell.
1439 for (size_t i = 0; i != cell_number; ++i) {
1440 Text const * inner_text = inset->getText(i);
1443 Inset const * inset_deeper =
1444 getCoveringInset(*inner_text, x, y);
1446 return inset_deeper;
1454 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
1456 //lyxerr << BOOST_CURRENT_FUNCTION << "[ cmd0 " << cmd0 << "]" << endl;
1458 // This is only called for mouse related events including
1459 // LFUN_FILE_OPEN generated by drag-and-drop.
1460 FuncRequest cmd = cmd0;
1463 cur.push(buffer_.inset());
1464 cur.selection() = d->cursor_.selection();
1466 // Either the inset under the cursor or the
1467 // surrounding Text will handle this event.
1469 // make sure we stay within the screen...
1470 cmd.y = min(max(cmd.y, -1), height_);
1472 if (cmd.action == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
1474 // Get inset under mouse, if there is one.
1475 Inset const * covering_inset =
1476 getCoveringInset(buffer_.text(), cmd.x, cmd.y);
1477 if (covering_inset == d->last_inset_)
1478 // Same inset, no need to do anything...
1481 bool need_redraw = false;
1482 // const_cast because of setMouseHover().
1483 Inset * inset = const_cast<Inset *>(covering_inset);
1485 // Remove the hint on the last hovered inset (if any).
1486 need_redraw |= d->last_inset_->setMouseHover(false);
1488 // Highlighted the newly hovered inset (if any).
1489 need_redraw |= inset->setMouseHover(true);
1490 d->last_inset_ = inset;
1494 // if last metrics update was in singlepar mode, WorkArea::redraw() will
1495 // not expose the button for redraw. We adjust here the metrics dimension
1496 // to enable a full redraw in any case as this is not costly.
1497 TextMetrics & tm = d->text_metrics_[&buffer_.text()];
1498 std::pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
1499 std::pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
1500 int y1 = firstpm.second->position() - firstpm.second->ascent();
1501 int y2 = lastpm.second->position() + lastpm.second->descent();
1502 d->metrics_info_ = ViewMetricsInfo(firstpm.first, lastpm.first, y1, y2,
1503 FullScreenUpdate, buffer_.text().paragraphs().size());
1504 // Reinitialize anchor to first pit.
1505 d->anchor_ref_ = firstpm.first;
1506 d->offset_ref_ = -y1;
1507 LYXERR(Debug::PAINTING)
1508 << "Mouse hover detected at: (" << cmd.x << ", " << cmd.y << ")"
1509 << "\nTriggering redraw: y1: " << y1 << " y2: " << y2
1510 << " pit1: " << firstpm.first << " pit2: " << lastpm.first << endl;
1512 // This event (moving without mouse click) is not passed further.
1513 // This should be changed if it is further utilized.
1518 // Build temporary cursor.
1519 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x, cmd.y);
1521 // Put anchor at the same position.
1524 // Try to dispatch to an non-editable inset near this position
1525 // via the temp cursor. If the inset wishes to change the real
1526 // cursor it has to do so explicitly by using
1527 // cur.bv().cursor() = cur; (or similar)
1529 inset->dispatch(cur, cmd);
1531 // Now dispatch to the temporary cursor. If the real cursor should
1532 // be modified, the inset's dispatch has to do so explicitly.
1533 if (!cur.result().dispatched())
1536 //Do we have a selection?
1537 theSelection().haveSelection(cursor().selection());
1539 // If the command has been dispatched,
1540 if (cur.result().dispatched()
1541 // an update is asked,
1542 && cur.result().update())
1543 processUpdateFlags(cur.result().update());
1547 void BufferView::scroll(int y)
1556 void BufferView::scrollDown(int offset)
1558 Text * text = &buffer_.text();
1559 TextMetrics & tm = d->text_metrics_[text];
1560 int ymax = height_ + offset;
1562 std::pair<pit_type, ParagraphMetrics const *> last = tm.last();
1563 int bottom_pos = last.second->position() + last.second->descent();
1564 if (last.first + 1 == int(text->paragraphs().size())) {
1565 if (bottom_pos <= height_)
1567 offset = min(offset, bottom_pos - height_);
1570 if (bottom_pos > ymax)
1572 tm.newParMetricsDown();
1574 d->offset_ref_ += offset;
1575 updateMetrics(false);
1580 void BufferView::scrollUp(int offset)
1582 Text * text = &buffer_.text();
1583 TextMetrics & tm = d->text_metrics_[text];
1584 int ymin = - offset;
1586 std::pair<pit_type, ParagraphMetrics const *> first = tm.first();
1587 int top_pos = first.second->position() - first.second->ascent();
1588 if (first.first == 0) {
1591 offset = min(offset, - top_pos);
1596 tm.newParMetricsUp();
1598 d->offset_ref_ -= offset;
1599 updateMetrics(false);
1604 void BufferView::setCursorFromRow(int row)
1609 buffer_.texrow().getIdFromRow(row, tmpid, tmppos);
1611 d->cursor_.reset(buffer_.inset());
1613 buffer_.text().setCursor(d->cursor_, 0, 0);
1615 buffer_.text().setCursor(d->cursor_, buffer_.getParFromID(tmpid).pit(), tmppos);
1619 void BufferView::gotoLabel(docstring const & label)
1621 for (InsetIterator it = inset_iterator_begin(buffer_.inset()); it; ++it) {
1622 vector<docstring> labels;
1623 it->getLabelList(buffer_, labels);
1624 if (std::find(labels.begin(), labels.end(), label) != labels.end()) {
1626 processUpdateFlags(Update::FitCursor);
1633 TextMetrics const & BufferView::textMetrics(Text const * t) const
1635 return const_cast<BufferView *>(this)->textMetrics(t);
1639 TextMetrics & BufferView::textMetrics(Text const * t)
1641 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
1642 if (tmc_it == d->text_metrics_.end()) {
1643 tmc_it = d->text_metrics_.insert(
1644 make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
1646 return tmc_it->second;
1650 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
1653 return textMetrics(t).parMetrics(pit);
1657 int BufferView::workHeight() const
1663 void BufferView::setCursor(DocIterator const & dit)
1665 size_t const n = dit.depth();
1666 for (size_t i = 0; i < n; ++i)
1667 dit[i].inset().edit(d->cursor_, true);
1669 d->cursor_.setCursor(dit);
1670 d->cursor_.selection() = false;
1674 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
1676 // Would be wrong to delete anything if we have a selection.
1677 if (cur.selection())
1680 bool need_anchor_change = false;
1681 bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
1682 need_anchor_change);
1684 if (need_anchor_change)
1690 updateLabels(buffer_);
1692 updateMetrics(false);
1698 bool BufferView::mouseSetCursor(Cursor & cur, bool select)
1700 BOOST_ASSERT(&cur.bv() == this);
1703 // this event will clear selection so we save selection for
1704 // persistent selection
1705 cap::saveSelection(cursor());
1707 // Has the cursor just left the inset?
1708 bool badcursor = false;
1709 bool leftinset = (&d->cursor_.inset() != &cur.inset());
1711 badcursor = notifyCursorLeaves(d->cursor_, cur);
1713 // FIXME: shift-mouse selection doesn't work well across insets.
1714 bool do_selection = select && &d->cursor_.anchor().inset() == &cur.inset();
1716 // do the dEPM magic if needed
1717 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
1718 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
1719 // the leftinset bool would not be necessary (badcursor instead).
1720 bool update = leftinset;
1721 if (!do_selection && !badcursor && d->cursor_.inTexted())
1722 update |= checkDepm(cur, d->cursor_);
1724 // if the cursor was in an empty script inset and the new
1725 // position is in the nucleus of the inset, notifyCursorLeaves
1726 // will kill the script inset itself. So we check all the
1727 // elements of the cursor to make sure that they are correct.
1728 // For an example, see bug 2933:
1729 // http://bugzilla.lyx.org/show_bug.cgi?id=2933
1730 // The code below could maybe be moved to a DocIterator method.
1731 //lyxerr << "cur before " << cur <<std::endl;
1732 DocIterator dit(cur.inset());
1733 dit.push_back(cur.bottom());
1735 while (i < cur.depth() && dit.nextInset() == &cur[i].inset()) {
1736 dit.push_back(cur[i]);
1739 //lyxerr << "5 cur after" << dit <<std::endl;
1741 d->cursor_.setCursor(dit);
1742 d->cursor_.boundary(cur.boundary());
1744 d->cursor_.setSelection();
1746 d->cursor_.clearSelection();
1748 d->cursor_.finishUndo();
1753 void BufferView::putSelectionAt(DocIterator const & cur,
1754 int length, bool backwards)
1756 d->cursor_.clearSelection();
1762 d->cursor_.pos() += length;
1763 d->cursor_.setSelection(d->cursor_, -length);
1765 d->cursor_.setSelection(d->cursor_, length);
1770 Cursor & BufferView::cursor()
1776 Cursor const & BufferView::cursor() const
1782 pit_type BufferView::anchor_ref() const
1784 return d->anchor_ref_;
1788 ViewMetricsInfo const & BufferView::viewMetricsInfo()
1790 return d->metrics_info_;
1794 bool BufferView::singleParUpdate()
1796 Text & buftext = buffer_.text();
1797 pit_type const bottom_pit = d->cursor_.bottom().pit();
1798 TextMetrics & tm = textMetrics(&buftext);
1799 int old_height = tm.parMetrics(bottom_pit).height();
1801 // In Single Paragraph mode, rebreak only
1802 // the (main text, not inset!) paragraph containing the cursor.
1803 // (if this paragraph contains insets etc., rebreaking will
1804 // recursively descend)
1805 tm.redoParagraph(bottom_pit);
1806 ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
1807 if (pm.height() != old_height)
1808 // Paragraph height has changed so we cannot proceed to
1809 // the singlePar optimisation.
1812 int y1 = pm.position() - pm.ascent();
1813 int y2 = pm.position() + pm.descent();
1814 d->metrics_info_ = ViewMetricsInfo(bottom_pit, bottom_pit, y1, y2,
1815 SingleParUpdate, buftext.paragraphs().size());
1816 LYXERR(Debug::PAINTING)
1817 << BOOST_CURRENT_FUNCTION
1820 << " pit: " << bottom_pit
1827 void BufferView::updateMetrics(bool singlepar)
1829 if (singlepar && singleParUpdate())
1830 // No need to update the full screen metrics.
1833 Text & buftext = buffer_.text();
1834 pit_type const npit = int(buftext.paragraphs().size());
1836 if (d->anchor_ref_ > int(npit - 1)) {
1837 d->anchor_ref_ = int(npit - 1);
1841 // Clear out the position cache in case of full screen redraw,
1842 d->coord_cache_.clear();
1844 // Clear out paragraph metrics to avoid having invalid metrics
1845 // in the cache from paragraphs not relayouted below
1846 // The complete text metrics will be redone.
1847 d->text_metrics_.clear();
1849 TextMetrics & tm = textMetrics(&buftext);
1851 pit_type const pit = d->anchor_ref_;
1855 // Rebreak anchor paragraph.
1856 tm.redoParagraph(pit);
1858 // Take care of anchor offset if case a recentering is needed.
1861 int y0 = tm.parMetrics(pit).ascent() - d->offset_ref_;
1863 // Redo paragraphs above anchor if necessary.
1865 while (y1 > 0 && pit1 > 0) {
1866 y1 -= tm.parMetrics(pit1).ascent();
1868 tm.redoParagraph(pit1);
1869 y1 -= tm.parMetrics(pit1).descent();
1872 // Take care of ascent of first line
1873 y1 -= tm.parMetrics(pit1).ascent();
1875 // Normalize anchor for next time
1876 d->anchor_ref_ = pit1;
1877 d->offset_ref_ = -y1;
1879 // Grey at the beginning is ugly
1880 if (pit1 == 0 && y1 > 0) {
1886 // Redo paragraphs below the anchor if necessary.
1888 while (y2 < height_ && pit2 < int(npit) - 1) {
1889 y2 += tm.parMetrics(pit2).descent();
1891 tm.redoParagraph(pit2);
1892 y2 += tm.parMetrics(pit2).ascent();
1895 // Take care of descent of last line
1896 y2 += tm.parMetrics(pit2).descent();
1898 LYXERR(Debug::PAINTING)
1899 << BOOST_CURRENT_FUNCTION
1902 << " pit1: " << pit1
1903 << " pit2: " << pit2
1904 << " npit: " << npit
1908 d->metrics_info_ = ViewMetricsInfo(pit1, pit2, y1, y2,
1909 FullScreenUpdate, npit);
1911 if (lyxerr.debugging(Debug::WORKAREA)) {
1912 LYXERR(Debug::WORKAREA) << "BufferView::updateMetrics" << endl;
1913 d->coord_cache_.dump();
1918 void BufferView::menuInsertLyXFile(string const & filenm)
1920 BOOST_ASSERT(d->cursor_.inTexted());
1921 string filename = filenm;
1923 if (filename.empty()) {
1924 // Launch a file browser
1926 string initpath = lyxrc.document_path;
1927 string const trypath = buffer_.filePath();
1928 // If directory is writeable, use this as default.
1929 if (FileName(trypath).isDirWritable())
1933 FileDialog fileDlg(_("Select LyX document to insert"),
1935 make_pair(_("Documents|#o#O"), from_utf8(lyxrc.document_path)),
1936 make_pair(_("Examples|#E#e"),
1937 from_utf8(addPath(package().system_support().absFilename(),
1940 FileDialog::Result result =
1941 fileDlg.open(from_utf8(initpath),
1942 FileFilterList(_("LyX Documents (*.lyx)")),
1945 if (result.first == FileDialog::Later)
1949 filename = to_utf8(result.second);
1951 // check selected filename
1952 if (filename.empty()) {
1953 // emit message signal.
1954 message(_("Canceled."));
1959 // Get absolute path of file and add ".lyx"
1960 // to the filename if necessary
1961 filename = fileSearch(string(), filename, "lyx").absFilename();
1963 docstring const disp_fn = makeDisplayPath(filename);
1964 // emit message signal.
1965 message(bformat(_("Inserting document %1$s..."), disp_fn));
1968 Buffer buf("", false);
1969 if (lyx::loadLyXFile(&buf, FileName(filename))) {
1970 ErrorList & el = buffer_.errorList("Parse");
1971 // Copy the inserted document error list into the current buffer one.
1972 el = buf.errorList("Parse");
1973 buffer_.undo().recordUndo(d->cursor_);
1974 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
1975 buf.params().getTextClassPtr(), el);
1976 res = _("Document %1$s inserted.");
1978 res = _("Could not insert document %1$s");
1980 // emit message signal.
1981 message(bformat(res, disp_fn));
1982 buffer_.errors("Parse");
1983 updateMetrics(false);
1987 Point BufferView::coordOffset(DocIterator const & dit, bool boundary) const
1993 // Addup contribution of nested insets, from inside to outside,
1994 // keeping the outer paragraph for a special handling below
1995 for (size_t i = dit.depth() - 1; i >= 1; --i) {
1996 CursorSlice const & sl = dit[i];
2000 // get relative position inside sl.inset()
2001 sl.inset().cursorPos(*this, sl, boundary && (i + 1 == dit.depth()), xx, yy);
2003 // Make relative position inside of the edited inset relative to sl.inset()
2007 // In case of an RTL inset, the edited inset will be positioned to the left
2010 bool boundary_i = boundary && i + 1 == dit.depth();
2011 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2016 // remember width for the case that sl.inset() is positioned in an RTL inset
2017 if (i && dit[i - 1].text()) {
2018 // If this Inset is inside a Text Inset, retrieve the Dimension
2019 // from the containing text instead of using Inset::dimension() which
2020 // might not be implemented.
2021 // FIXME (Abdel 23/09/2007): this is a bit messy because of the
2022 // elimination of Inset::dim_ cache. This coordOffset() method needs
2023 // to be rewritten in light of the new design.
2024 Dimension const & dim = parMetrics(dit[i - 1].text(),
2025 dit[i - 1].pit()).insetDimension(&sl.inset());
2028 Dimension const dim = sl.inset().dimension(*this);
2032 //lyxerr << "Cursor::getPos, i: "
2033 // << i << " x: " << xx << " y: " << y << endl;
2036 // Add contribution of initial rows of outermost paragraph
2037 CursorSlice const & sl = dit[0];
2038 TextMetrics const & tm = textMetrics(sl.text());
2039 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2040 BOOST_ASSERT(!pm.rows().empty());
2041 y -= pm.rows()[0].ascent();
2043 // FIXME: document this mess
2045 if (sl.pos() > 0 && dit.depth() == 1) {
2047 if (pos && boundary)
2049 // lyxerr << "coordOffset: boundary:" << boundary << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << std::endl;
2050 rend = pm.pos2row(pos);
2052 rend = pm.pos2row(sl.pos());
2054 size_t rend = pm.pos2row(sl.pos());
2056 for (size_t rit = 0; rit != rend; ++rit)
2057 y += pm.rows()[rit].height();
2058 y += pm.rows()[rend].ascent();
2060 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
2062 // Make relative position from the nested inset now bufferview absolute.
2063 int xx = bottom_tm.cursorX(dit.bottom(), boundary && dit.depth() == 1);
2066 // In the RTL case place the nested inset at the left of the cursor in
2067 // the outer paragraph
2068 bool boundary_1 = boundary && 1 == dit.depth();
2069 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
2077 Point BufferView::getPos(DocIterator const & dit, bool boundary) const
2079 CursorSlice const & bot = dit.bottom();
2080 TextMetrics const & tm = textMetrics(bot.text());
2081 if (!tm.has(bot.pit()))
2082 return Point(-1, -1);
2084 Point p = coordOffset(dit, boundary); // offset from outer paragraph
2085 p.y_ += tm.parMetrics(bot.pit()).position();
2090 void BufferView::draw(frontend::Painter & pain)
2092 PainterInfo pi(this, pain);
2093 // Should the whole screen, including insets, be refreshed?
2094 // FIXME: We should also distinguish DecorationUpdate to avoid text
2095 // drawing if possible. This is not possible to do easily right now
2096 // because of the single backing pixmap.
2097 pi.full_repaint = d->metrics_info_.update_strategy != SingleParUpdate;
2099 if (pi.full_repaint)
2100 // Clear background (if not delegated to rows)
2101 pain.fillRectangle(0, d->metrics_info_.y1, width_,
2102 d->metrics_info_.y2 - d->metrics_info_.y1,
2103 buffer_.inset().backgroundColor());
2105 LYXERR(Debug::PAINTING) << "\t\t*** START DRAWING ***" << endl;
2106 Text & text = buffer_.text();
2107 TextMetrics const & tm = d->text_metrics_[&text];
2108 int y = d->metrics_info_.y1 + tm.parMetrics(d->metrics_info_.p1).ascent();
2109 if (!pi.full_repaint)
2110 tm.drawParagraph(pi, d->metrics_info_.p1, 0, y);
2113 LYXERR(Debug::PAINTING) << "\n\t\t*** END DRAWING ***" << endl;
2115 // and grey out above (should not happen later)
2116 // lyxerr << "par ascent: " << text.getPar(d->metrics_info_.p1).ascent() << endl;
2117 if (d->metrics_info_.y1 > 0
2118 && d->metrics_info_.update_strategy == FullScreenUpdate)
2119 pain.fillRectangle(0, 0, width_, d->metrics_info_.y1, Color::bottomarea);
2121 // and possibly grey out below
2122 // lyxerr << "par descent: " << text.getPar(d->metrics_info_.p1).ascent() << endl;
2123 if (d->metrics_info_.y2 < height_
2124 && d->metrics_info_.update_strategy == FullScreenUpdate)
2125 pain.fillRectangle(0, d->metrics_info_.y2, width_,
2126 height_ - d->metrics_info_.y2, Color::bottomarea);
2130 void BufferView::message(docstring const & msg)
2133 d->gui_->message(msg);
2137 void BufferView::showDialog(std::string const & name)
2140 d->gui_->showDialog(name);
2144 void BufferView::showDialogWithData(std::string const & name,
2145 std::string const & data)
2148 d->gui_->showDialogWithData(name, data);
2152 void BufferView::showInsetDialog(std::string const & name,
2153 std::string const & data, Inset * inset)
2156 d->gui_->showInsetDialog(name, data, inset);
2160 void BufferView::updateDialog(std::string const & name, std::string const & data)
2163 d->gui_->updateDialog(name, data);
2167 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
2173 // FIXME: Move this out of BufferView again
2174 docstring BufferView::contentsOfPlaintextFile(string const & f,
2179 if (fname.empty()) {
2180 FileDialog fileDlg(_("Select file to insert"),
2182 ? LFUN_FILE_INSERT_PLAINTEXT_PARA
2183 : LFUN_FILE_INSERT_PLAINTEXT) );
2185 FileDialog::Result result =
2186 fileDlg.open(from_utf8(buffer().filePath()),
2187 FileFilterList(), docstring());
2189 if (result.first == FileDialog::Later)
2192 fname = makeAbsPath(to_utf8(result.second));
2198 if (!fs::is_readable(fname.toFilesystemEncoding())) {
2199 docstring const error = from_ascii(strerror(errno));
2200 docstring const file = makeDisplayPath(fname.absFilename(), 50);
2201 docstring const text =
2202 bformat(_("Could not read the specified document\n"
2203 "%1$s\ndue to the error: %2$s"), file, error);
2204 Alert::error(_("Could not read file"), text);
2208 ifstream ifs(fname.toFilesystemEncoding().c_str());
2210 docstring const error = from_ascii(strerror(errno));
2211 docstring const file = makeDisplayPath(fname.absFilename(), 50);
2212 docstring const text =
2213 bformat(_("Could not open the specified document\n"
2214 "%1$s\ndue to the error: %2$s"), file, error);
2215 Alert::error(_("Could not open file"), text);
2219 ifs.unsetf(std::ios::skipws);
2220 istream_iterator<char> ii(ifs);
2221 istream_iterator<char> end;
2222 #if !defined(USE_INCLUDED_STRING) && !defined(STD_STRING_IS_GOOD)
2223 // We use this until the compilers get better...
2224 std::vector<char> tmp;
2225 copy(ii, end, back_inserter(tmp));
2226 string const tmpstr(tmp.begin(), tmp.end());
2228 // This is what we want to use and what we will use once the
2229 // compilers get good enough.
2230 //string tmpstr(ii, end); // yet a reason for using std::string
2231 // alternate approach to get the file into a string:
2233 copy(ii, end, back_inserter(tmpstr));
2236 // FIXME UNICODE: We don't know the encoding of the file
2237 docstring file_content = from_utf8(tmpstr);
2238 if (file_content.empty()) {
2239 Alert::error(_("Reading not UTF-8 encoded file"),
2240 _("The file is not UTF-8 encoded.\n"
2241 "It will be read as local 8Bit-encoded.\n"
2242 "If this does not give the correct result\n"
2243 "then please change the encoding of the file\n"
2244 "to UTF-8 with a program other than LyX.\n"));
2245 file_content = from_local8bit(tmpstr);
2248 return normalize_c(file_content);
2252 void BufferView::insertPlaintextFile(string const & f, bool asParagraph)
2254 docstring const tmpstr = contentsOfPlaintextFile(f, asParagraph);
2259 Cursor & cur = cursor();
2260 cap::replaceSelection(cur);
2261 buffer_.undo().recordUndo(cur);
2263 cur.innerText()->insertStringAsParagraphs(cur, tmpstr);
2265 cur.innerText()->insertStringAsLines(cur, tmpstr);