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"
55 #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/Delegates.h"
65 #include "frontends/FileDialog.h"
66 #include "frontends/FontMetrics.h"
67 #include "frontends/Painter.h"
68 #include "frontends/Selection.h"
70 #include "graphics/Previews.h"
72 #include "support/convert.h"
73 #include "support/FileFilterList.h"
74 #include "support/filetools.h"
75 #include "support/Package.h"
76 #include "support/types.h"
77 #include "support/fs_extras.h"
79 #include <boost/bind.hpp>
80 #include <boost/current_function.hpp>
81 #include <boost/next_prior.hpp>
82 #include <boost/filesystem/operations.hpp>
92 using std::istringstream;
93 using std::istream_iterator;
97 using std::mem_fun_ref;
101 namespace fs = boost::filesystem;
105 using support::addPath;
106 using support::bformat;
107 using support::FileFilterList;
108 using support::FileName;
109 using support::fileSearch;
110 using support::isDirWriteable;
111 using support::isFileReadable;
112 using support::makeDisplayPath;
113 using support::makeAbsPath;
114 using support::package;
116 namespace Alert = frontend::Alert;
120 /// Return an inset of this class if it exists at the current cursor position
122 T * getInsetByCode(Cursor const & cur, InsetCode code)
124 DocIterator it = cur;
125 Inset * inset = it.nextInset();
126 if (inset && inset->lyxCode() == code)
127 return static_cast<T*>(inset);
132 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
135 bool findNextInset(DocIterator & dit, vector<InsetCode> const & codes,
136 string const & contents)
138 DocIterator tmpdit = dit;
141 Inset const * inset = tmpdit.nextInset();
143 && find(codes.begin(), codes.end(), inset->lyxCode()) != codes.end()
144 && (contents.empty() ||
145 static_cast<InsetCommand const *>(inset)->getContents() == contents)) {
149 tmpdit.forwardInset();
156 /// Looks for next inset with one of the the given code
157 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
161 DocIterator tmpdit = dit;
162 tmpdit.forwardInset();
167 Inset const * inset = tmpdit.nextInset();
169 && find(codes.begin(), codes.end(), inset->lyxCode()) != codes.end()) {
170 contents = static_cast<InsetCommand const *>(inset)->getContents();
174 if (!findNextInset(tmpdit, codes, contents)) {
175 if (dit.depth() != 1 || dit.pit() != 0 || dit.pos() != 0) {
176 tmpdit = doc_iterator_begin(tmpdit.bottom().inset());
177 if (!findNextInset(tmpdit, codes, contents))
188 /// Looks for next inset with the given code
189 void findInset(DocIterator & dit, InsetCode code, bool same_content)
191 findInset(dit, vector<InsetCode>(1, code), same_content);
195 /// Moves cursor to the next inset with one of the given codes.
196 void gotoInset(BufferView * bv, vector<InsetCode> const & codes,
199 Cursor tmpcur = bv->cursor();
200 if (!findInset(tmpcur, codes, same_content)) {
201 bv->cursor().message(_("No more insets"));
205 tmpcur.clearSelection();
206 bv->setCursor(tmpcur);
210 /// Moves cursor to the next inset with given code.
211 void gotoInset(BufferView * bv, InsetCode code, bool same_content)
213 gotoInset(bv, vector<InsetCode>(1, code), same_content);
218 /// the type of outline operation
220 OutlineUp, // Move this header with text down
221 OutlineDown, // Move this header with text up
222 OutlineIn, // Make this header deeper
223 OutlineOut // Make this header shallower
227 void outline(OutlineOp mode, Cursor & cur)
229 Buffer & buf = cur.buffer();
230 pit_type & pit = cur.pit();
231 ParagraphList & pars = buf.text().paragraphs();
232 ParagraphList::iterator bgn = pars.begin();
233 // The first paragraph of the area to be copied:
234 ParagraphList::iterator start = boost::next(bgn, pit);
235 // The final paragraph of area to be copied:
236 ParagraphList::iterator finish = start;
237 ParagraphList::iterator end = pars.end();
239 TextClass::const_iterator lit =
240 buf.params().getTextClass().begin();
241 TextClass::const_iterator const lend =
242 buf.params().getTextClass().end();
244 int const thistoclevel = start->layout()->toclevel;
248 // Move out (down) from this section header
251 // Seek the one (on same level) below
252 for (; finish != end; ++finish) {
253 toclevel = finish->layout()->toclevel;
254 if (toclevel != Layout::NOT_IN_TOC
255 && toclevel <= thistoclevel) {
259 ParagraphList::iterator dest = start;
260 // Move out (up) from this header
263 // Search previous same-level header above
266 toclevel = dest->layout()->toclevel;
268 && (toclevel == Layout::NOT_IN_TOC
269 || toclevel > thistoclevel));
270 // Not found; do nothing
271 if (toclevel == Layout::NOT_IN_TOC || toclevel > thistoclevel)
273 pit_type const newpit = std::distance(bgn, dest);
274 pit_type const len = std::distance(start, finish);
275 pit_type const deletepit = pit + len;
276 recordUndo(cur, Undo::ATOMIC, newpit, deletepit - 1);
277 pars.insert(dest, start, finish);
278 start = boost::next(pars.begin(), deletepit);
280 pars.erase(start, finish);
284 // Go down out of current header:
287 // Find next same-level header:
288 for (; finish != end; ++finish) {
289 toclevel = finish->layout()->toclevel;
290 if (toclevel != Layout::NOT_IN_TOC && toclevel <= thistoclevel)
293 ParagraphList::iterator dest = finish;
294 // Go one down from *this* header:
299 // Go further down to find header to insert in front of:
300 for (; dest != end; ++dest) {
301 toclevel = dest->layout()->toclevel;
302 if (toclevel != Layout::NOT_IN_TOC && toclevel <= thistoclevel)
305 // One such was found:
306 pit_type newpit = std::distance(bgn, dest);
307 pit_type const len = std::distance(start, finish);
308 recordUndo(cur, Undo::ATOMIC, pit, newpit - 1);
309 pars.insert(dest, start, finish);
310 start = boost::next(bgn, pit);
312 pars.erase(start, finish);
317 for (; lit != lend; ++lit) {
318 if ((*lit)->toclevel == thistoclevel + 1 &&
319 start->layout()->labeltype == (*lit)->labeltype) {
320 start->layout((*lit));
327 for (; lit != lend; ++lit) {
328 if ((*lit)->toclevel == thistoclevel - 1 &&
329 start->layout()->labeltype == (*lit)->labeltype) {
330 start->layout((*lit));
340 /// A map from a Text to the associated text metrics
341 typedef std::map<Text const *, TextMetrics> TextMetricsCache;
346 /////////////////////////////////////////////////////////////////////
350 /////////////////////////////////////////////////////////////////////
352 struct BufferView::Private
354 Private(BufferView & bv): wh_(0), cursor_(bv),
355 multiparsel_cache_(false), anchor_ref_(0), offset_ref_(0),
356 need_centering_(false), last_inset_(0), gui_(0)
360 ScrollbarParameters scrollbarParameters_;
362 ViewMetricsInfo metrics_info_;
364 CoordCache coord_cache_;
366 /// Estimated average par height for scrollbar.
368 /// this is used to handle XSelection events in the right manner.
377 bool multiparsel_cache_;
379 pit_type anchor_ref_;
383 bool need_centering_;
385 /// keyboard mapping object.
388 /// last visited inset.
389 /** kept to send setMouseHover(false).
390 * Not owned, so don't delete.
394 mutable TextMetricsCache text_metrics_;
397 /** Not owned, so don't delete.
399 frontend::GuiBufferViewDelegate * gui_;
403 BufferView::BufferView(Buffer & buf)
404 : width_(0), height_(0), buffer_(buf), d(new Private(*this))
406 d->xsel_cache_.set = false;
407 d->intl_.initKeyMapper(lyxrc.use_kbmap);
409 d->cursor_.push(buffer_.inset());
410 d->cursor_.resetAnchor();
411 d->cursor_.setCurrentFont();
413 if (graphics::Previews::status() != LyXRC::PREVIEW_OFF)
414 graphics::Previews::get().generateBufferPreviews(buffer_);
418 BufferView::~BufferView()
420 // current buffer is going to be switched-off, save cursor pos
421 // Ideally, the whole cursor stack should be saved, but session
422 // currently can only handle bottom (whole document) level pit and pos.
423 // That is to say, if a cursor is in a nested inset, it will be
424 // restore to the left of the top level inset.
425 LyX::ref().session().lastFilePos().save(
426 support::FileName(buffer_.fileName()),
427 boost::tie(d->cursor_.bottom().pit(), d->cursor_.bottom().pos()) );
433 Intl & BufferView::getIntl()
439 Intl const & BufferView::getIntl() const
445 CoordCache & BufferView::coordCache()
447 return d->coord_cache_;
451 CoordCache const & BufferView::coordCache() const
453 return d->coord_cache_;
457 Buffer & BufferView::buffer()
463 Buffer const & BufferView::buffer() const
469 bool BufferView::fitCursor()
471 if (cursorStatus(d->cursor_) == CUR_INSIDE) {
472 frontend::FontMetrics const & fm =
473 theFontMetrics(d->cursor_.getFont());
474 int const asc = fm.maxAscent();
475 int const des = fm.maxDescent();
476 Point const p = getPos(d->cursor_, d->cursor_.boundary());
477 if (p.y_ - asc >= 0 && p.y_ + des < height_)
485 bool BufferView::multiParSel()
487 if (!d->cursor_.selection())
489 bool ret = d->multiparsel_cache_;
490 d->multiparsel_cache_ = d->cursor_.selBegin().pit() != d->cursor_.selEnd().pit();
491 // Either this, or previous selection spans paragraphs
492 return ret || d->multiparsel_cache_;
496 void BufferView::processUpdateFlags(Update::flags flags)
498 // last_inset_ points to the last visited inset. This pointer may become
499 // invalid because of keyboard editing. Since all such operations
500 // causes screen update(), I reset last_inset_ to avoid such a problem.
502 // This is close to a hot-path.
504 << BOOST_CURRENT_FUNCTION
505 << "[fitcursor = " << (flags & Update::FitCursor)
506 << ", forceupdate = " << (flags & Update::Force)
507 << ", singlepar = " << (flags & Update::SinglePar)
508 << "] buffer: " << &buffer_ << endl;
510 // Update macro store
511 if (!(cursor().inMathed() && cursor().inMacroMode()))
512 buffer_.buildMacros();
514 // Now do the first drawing step if needed. This consists on updating
515 // the CoordCache in updateMetrics().
516 // The second drawing step is done in WorkArea::redraw() if needed.
518 // Case when no explicit update is requested.
520 // no need to redraw anything.
521 d->metrics_info_.update_strategy = NoScreenUpdate;
525 if (flags == Update::Decoration) {
526 d->metrics_info_.update_strategy = DecorationUpdate;
531 if (flags == Update::FitCursor
532 || flags == (Update::Decoration | Update::FitCursor)) {
533 bool const fit_cursor = fitCursor();
534 // tell the frontend to update the screen if needed.
536 updateMetrics(false);
540 if (flags & Update::Decoration) {
541 d->metrics_info_.update_strategy = DecorationUpdate;
545 // no screen update is needed.
546 d->metrics_info_.update_strategy = NoScreenUpdate;
550 bool full_metrics = flags & Update::Force;
551 if (flags & Update::MultiParSel)
552 full_metrics |= multiParSel();
554 bool const single_par = !full_metrics;
555 updateMetrics(single_par);
557 if (!(flags & Update::FitCursor)) {
562 //FIXME: updateMetrics() does not update paragraph position
563 // This is done at draw() time. So we need a redraw!
566 // The screen has already been updated thanks to the
567 // 'buffer_.changed()' call three line above. So no need
571 // The screen has been recentered around the cursor position so
573 updateMetrics(false);
578 void BufferView::updateScrollbar()
580 Text & t = buffer_.text();
581 TextMetrics & tm = d->text_metrics_[&t];
583 int const parsize = int(t.paragraphs().size() - 1);
584 if (d->anchor_ref_ > parsize) {
585 d->anchor_ref_ = parsize;
590 << BOOST_CURRENT_FUNCTION
591 << " Updating scrollbar: height: " << t.paragraphs().size()
592 << " curr par: " << d->cursor_.bottom().pit()
593 << " default height " << defaultRowHeight() << endl;
595 // It would be better to fix the scrollbar to understand
596 // values in [0..1] and divide everything by wh
598 // estimated average paragraph height:
600 d->wh_ = height_ / 4;
602 int h = tm.parMetrics(d->anchor_ref_).height();
604 // Normalize anchor/offset (MV):
605 while (d->offset_ref_ > h && d->anchor_ref_ < parsize) {
608 h = tm.parMetrics(d->anchor_ref_).height();
610 // Look at paragraph heights on-screen
613 for (pit_type pit = d->anchor_ref_; pit <= parsize; ++pit) {
616 int const h2 = tm.parMetrics(pit).height();
622 int const hav = sumh / nh;
623 // More realistic average paragraph height
628 d->scrollbarParameters_.height = (parsize + 1) * d->wh_;
629 d->scrollbarParameters_.position = d->anchor_ref_ * d->wh_ + int(d->offset_ref_ * d->wh_ / float(h));
630 d->scrollbarParameters_.lineScrollHeight = int(d->wh_ * defaultRowHeight() / float(h));
634 ScrollbarParameters const & BufferView::scrollbarParameters() const
636 return d->scrollbarParameters_;
640 void BufferView::scrollDocView(int value)
642 LYXERR(Debug::GUI) << BOOST_CURRENT_FUNCTION
643 << "[ value = " << value << "]" << endl;
645 Text & t = buffer_.text();
646 TextMetrics & tm = d->text_metrics_[&t];
648 float const bar = value / float(d->wh_ * t.paragraphs().size());
650 d->anchor_ref_ = int(bar * t.paragraphs().size());
651 if (d->anchor_ref_ > int(t.paragraphs().size()) - 1)
652 d->anchor_ref_ = int(t.paragraphs().size()) - 1;
654 tm.redoParagraph(d->anchor_ref_);
655 int const h = tm.parMetrics(d->anchor_ref_).height();
656 d->offset_ref_ = int((bar * t.paragraphs().size() - d->anchor_ref_) * h);
657 updateMetrics(false);
662 void BufferView::setCursorFromScrollbar()
664 TextMetrics & tm = d->text_metrics_[&buffer_.text()];
666 int const height = 2 * defaultRowHeight();
667 int const first = height;
668 int const last = height_ - height;
669 Cursor & cur = d->cursor_;
671 switch (cursorStatus(cur)) {
673 // We reset the cursor because cursorStatus() does not
674 // work when the cursor is within mathed.
675 cur.reset(buffer_.inset());
676 tm.setCursorFromCoordinates(cur, 0, first);
677 cur.clearSelection();
680 // We reset the cursor because cursorStatus() does not
681 // work when the cursor is within mathed.
682 cur.reset(buffer_.inset());
683 tm.setCursorFromCoordinates(cur, 0, last);
684 cur.clearSelection();
687 int const y = getPos(cur, cur.boundary()).y_;
688 int const newy = min(last, max(y, first));
690 cur.reset(buffer_.inset());
691 tm.setCursorFromCoordinates(cur, 0, newy);
697 Change const BufferView::getCurrentChange() const
699 if (!d->cursor_.selection())
700 return Change(Change::UNCHANGED);
702 DocIterator dit = d->cursor_.selectionBegin();
703 return dit.paragraph().lookupChange(dit.pos());
707 // this could be used elsewhere as well?
708 // FIXME: This does not work within mathed!
709 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
711 Point const p = getPos(dit, dit.boundary());
714 if (p.y_ > workHeight())
720 void BufferView::saveBookmark(unsigned int idx)
722 // tenatively save bookmark, id and pos will be used to
723 // acturately locate a bookmark in a 'live' lyx session.
724 // pit and pos will be updated with bottom level pit/pos
726 LyX::ref().session().bookmarks().save(
727 FileName(buffer_.fileName()),
728 d->cursor_.bottom().pit(),
729 d->cursor_.bottom().pos(),
730 d->cursor_.paragraph().id(),
735 // emit message signal.
736 message(_("Save bookmark"));
740 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
741 int top_id, pos_type top_pos)
743 bool success = false;
746 d->cursor_.clearSelection();
748 // if a valid par_id is given, try it first
749 // This is the case for a 'live' bookmark when unique paragraph ID
750 // is used to track bookmarks.
752 ParIterator par = buffer_.getParFromID(top_id);
753 if (par != buffer_.par_iterator_end()) {
754 doc_it = makeDocIterator(par, min(par->size(), top_pos));
755 // Some slices of the iterator may not be
756 // reachable (e.g. closed collapsable inset)
757 // so the dociterator may need to be
758 // shortened. Otherwise, setCursor may crash
759 // lyx when the cursor can not be set to these
761 size_t const n = doc_it.depth();
762 for (size_t i = 0; i < n; ++i)
763 if (doc_it[i].inset().editable() != Inset::HIGHLY_EDITABLE) {
771 // if top_id == 0, or searching through top_id failed
772 // This is the case for a 'restored' bookmark when only bottom
773 // (document level) pit was saved. Because of this, bookmark
774 // restoration is inaccurate. If a bookmark was within an inset,
775 // it will be restored to the left of the outmost inset that contains
777 if (static_cast<size_t>(bottom_pit) < buffer_.paragraphs().size()) {
778 doc_it = doc_iterator_begin(buffer_.inset());
779 doc_it.pit() = bottom_pit;
780 doc_it.pos() = min(bottom_pos, doc_it.paragraph().size());
785 // Note: only bottom (document) level pit is set.
787 // set the current font.
788 d->cursor_.setCurrentFont();
789 // center the screen on this new position.
797 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
799 if (lyxrc.rtl_support) {
800 if (d->cursor_.real_current_font.isRightToLeft()) {
801 if (d->intl_.keymap == Intl::PRIMARY)
802 d->intl_.keyMapSec();
804 if (d->intl_.keymap == Intl::SECONDARY)
805 d->intl_.keyMapPrim();
809 d->intl_.getTransManager().translateAndInsert(c, t, cur);
813 int BufferView::workWidth() const
819 void BufferView::updateOffsetRef()
821 // No need to update d->offset_ref_ in this case.
822 if (!d->need_centering_)
825 // We are not properly started yet, delay until resizing is
830 CursorSlice & bot = d->cursor_.bottom();
831 TextMetrics & tm = d->text_metrics_[bot.text()];
832 ParagraphMetrics const & pm = tm.parMetrics(bot.pit());
833 int y = coordOffset(d->cursor_, d->cursor_.boundary()).y_;
834 d->offset_ref_ = y + pm.ascent() - height_ / 2;
836 d->need_centering_ = false;
840 void BufferView::center()
842 d->anchor_ref_ = d->cursor_.bottom().pit();
843 d->need_centering_ = true;
847 FuncStatus BufferView::getStatus(FuncRequest const & cmd)
851 Cursor & cur = d->cursor_;
853 switch (cmd.action) {
856 flag.enabled(!buffer_.undostack().empty());
859 flag.enabled(!buffer_.redostack().empty());
861 case LFUN_FILE_INSERT:
862 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
863 case LFUN_FILE_INSERT_PLAINTEXT:
864 case LFUN_BOOKMARK_SAVE:
865 // FIXME: Actually, these LFUNS should be moved to Text
866 flag.enabled(cur.inTexted());
868 case LFUN_FONT_STATE:
869 case LFUN_LABEL_INSERT:
870 case LFUN_INFO_INSERT:
871 case LFUN_PARAGRAPH_GOTO:
872 // FIXME handle non-trivially
873 case LFUN_OUTLINE_UP:
874 case LFUN_OUTLINE_DOWN:
875 case LFUN_OUTLINE_IN:
876 case LFUN_OUTLINE_OUT:
878 case LFUN_REFERENCE_NEXT:
880 case LFUN_WORD_REPLACE:
883 case LFUN_MARK_TOGGLE:
884 case LFUN_SCREEN_RECENTER:
885 case LFUN_BIBTEX_DATABASE_ADD:
886 case LFUN_BIBTEX_DATABASE_DEL:
887 case LFUN_WORDS_COUNT:
888 case LFUN_NEXT_INSET_TOGGLE:
892 case LFUN_LABEL_GOTO: {
893 flag.enabled(!cmd.argument().empty()
894 || getInsetByCode<InsetRef>(cur, REF_CODE));
898 case LFUN_CHANGES_TRACK:
900 flag.setOnOff(buffer_.params().trackChanges);
903 case LFUN_CHANGES_OUTPUT:
905 flag.setOnOff(buffer_.params().outputChanges);
908 case LFUN_CHANGES_MERGE:
909 case LFUN_CHANGE_NEXT:
910 case LFUN_ALL_CHANGES_ACCEPT:
911 case LFUN_ALL_CHANGES_REJECT:
912 // TODO: context-sensitive enabling of LFUNs
913 // In principle, these command should only be enabled if there
914 // is a change in the document. However, without proper
915 // optimizations, this will inevitably result in poor performance.
919 case LFUN_BUFFER_TOGGLE_COMPRESSION: {
920 flag.setOnOff(buffer_.params().compressed);
925 case LFUN_SCREEN_DOWN:
929 // FIXME: LFUN_SCREEN_DOWN_SELECT should be removed from
930 // everywhere else before this can enabled:
931 case LFUN_SCREEN_UP_SELECT:
932 case LFUN_SCREEN_DOWN_SELECT:
936 case LFUN_LAYOUT_TABULAR:
937 flag.enabled(cur.innerInsetOfType(TABULAR_CODE));
941 case LFUN_LAYOUT_PARAGRAPH:
942 flag.enabled(cur.inset().forceDefaultParagraphs(cur.idx()));
945 case LFUN_INSET_SETTINGS: {
946 InsetCode code = cur.inset().lyxCode();
950 enable = cmd.argument() == "tabular";
953 enable = cmd.argument() == "ert";
956 enable = cmd.argument() == "float";
959 enable = cmd.argument() == "wrap";
962 enable = cmd.argument() == "note";
965 enable = cmd.argument() == "branch";
968 enable = cmd.argument() == "box";
971 enable = cmd.argument() == "listings";
976 flag.enabled(enable);
980 case LFUN_DIALOG_SHOW_NEW_INSET:
981 flag.enabled(cur.inset().lyxCode() != ERT_CODE &&
982 cur.inset().lyxCode() != LISTINGS_CODE);
983 if (cur.inset().lyxCode() == CAPTION_CODE) {
985 if (cur.inset().getStatus(cur, cmd, flag))
998 Update::flags BufferView::dispatch(FuncRequest const & cmd)
1000 //lyxerr << BOOST_CURRENT_FUNCTION
1001 // << [ cmd = " << cmd << "]" << endl;
1003 // Make sure that the cached BufferView is correct.
1004 LYXERR(Debug::ACTION) << BOOST_CURRENT_FUNCTION
1005 << " action[" << cmd.action << ']'
1006 << " arg[" << to_utf8(cmd.argument()) << ']'
1007 << " x[" << cmd.x << ']'
1008 << " y[" << cmd.y << ']'
1009 << " button[" << cmd.button() << ']'
1012 Cursor & cur = d->cursor_;
1013 // Default Update flags.
1014 Update::flags updateFlags = Update::Force | Update::FitCursor;
1016 switch (cmd.action) {
1019 cur.message(_("Undo"));
1020 cur.clearSelection();
1021 if (!textUndo(*this)) {
1022 cur.message(_("No further undo information"));
1023 updateFlags = Update::None;
1028 cur.message(_("Redo"));
1029 cur.clearSelection();
1030 if (!textRedo(*this)) {
1031 cur.message(_("No further redo information"));
1032 updateFlags = Update::None;
1036 case LFUN_FILE_INSERT:
1038 menuInsertLyXFile(to_utf8(cmd.argument()));
1041 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
1043 insertPlaintextFile(to_utf8(cmd.argument()), true);
1046 case LFUN_FILE_INSERT_PLAINTEXT:
1048 insertPlaintextFile(to_utf8(cmd.argument()), false);
1051 case LFUN_FONT_STATE:
1052 cur.message(cur.currentState());
1055 case LFUN_BOOKMARK_SAVE:
1056 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1059 case LFUN_LABEL_GOTO: {
1060 docstring label = cmd.argument();
1061 if (label.empty()) {
1063 getInsetByCode<InsetRef>(d->cursor_,
1066 label = inset->getParam("reference");
1067 // persistent=false: use temp_bookmark
1077 case LFUN_PARAGRAPH_GOTO: {
1078 int const id = convert<int>(to_utf8(cmd.argument()));
1080 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1081 b = theBufferList().next(b)) {
1083 ParIterator par = b->getParFromID(id);
1084 if (par == b->par_iterator_end()) {
1086 << "No matching paragraph found! ["
1087 << id << "]." << endl;
1090 << "Paragraph " << par->id()
1091 << " found in buffer `"
1092 << b->fileName() << "'." << endl;
1094 if (b == &buffer_) {
1096 setCursor(makeDocIterator(par, 0));
1098 // Switch to other buffer view and resend cmd
1099 theLyXFunc().dispatch(FuncRequest(
1100 LFUN_BUFFER_SWITCH, b->fileName()));
1101 theLyXFunc().dispatch(cmd);
1102 updateFlags = Update::None;
1111 case LFUN_OUTLINE_UP:
1112 outline(OutlineUp, d->cursor_);
1113 d->cursor_.text()->setCursor(d->cursor_, d->cursor_.pit(), 0);
1114 updateLabels(buffer_);
1116 case LFUN_OUTLINE_DOWN:
1117 outline(OutlineDown, d->cursor_);
1118 d->cursor_.text()->setCursor(d->cursor_, d->cursor_.pit(), 0);
1119 updateLabels(buffer_);
1121 case LFUN_OUTLINE_IN:
1122 outline(OutlineIn, d->cursor_);
1123 updateLabels(buffer_);
1125 case LFUN_OUTLINE_OUT:
1126 outline(OutlineOut, d->cursor_);
1127 updateLabels(buffer_);
1130 case LFUN_NOTE_NEXT:
1131 gotoInset(this, NOTE_CODE, false);
1134 case LFUN_REFERENCE_NEXT: {
1135 vector<InsetCode> tmp;
1136 tmp.push_back(LABEL_CODE);
1137 tmp.push_back(REF_CODE);
1138 gotoInset(this, tmp, true);
1142 case LFUN_CHANGES_TRACK:
1143 buffer_.params().trackChanges = !buffer_.params().trackChanges;
1146 case LFUN_CHANGES_OUTPUT:
1147 buffer_.params().outputChanges = !buffer_.params().outputChanges;
1148 if (buffer_.params().outputChanges) {
1149 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1150 bool xcolorsoul = LaTeXFeatures::isAvailable("soul") &&
1151 LaTeXFeatures::isAvailable("xcolor");
1153 if (!dvipost && !xcolorsoul) {
1154 Alert::warning(_("Changes not shown in LaTeX output"),
1155 _("Changes will not be highlighted in LaTeX output, "
1156 "because neither dvipost nor xcolor/soul are installed.\n"
1157 "Please install these packages or redefine "
1158 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1159 } else if (!xcolorsoul) {
1160 Alert::warning(_("Changes not shown in LaTeX output"),
1161 _("Changes will not be highlighted in LaTeX output "
1162 "when using pdflatex, because xcolor and soul are not installed.\n"
1163 "Please install both packages or redefine "
1164 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1169 case LFUN_CHANGE_NEXT:
1170 findNextChange(this);
1173 case LFUN_CHANGES_MERGE:
1174 if (findNextChange(this))
1175 showDialog("changes");
1178 case LFUN_ALL_CHANGES_ACCEPT:
1179 // select complete document
1180 d->cursor_.reset(buffer_.inset());
1181 d->cursor_.selHandle(true);
1182 buffer_.text().cursorBottom(d->cursor_);
1183 // accept everything in a single step to support atomic undo
1184 buffer_.text().acceptOrRejectChanges(d->cursor_, Text::ACCEPT);
1187 case LFUN_ALL_CHANGES_REJECT:
1188 // select complete document
1189 d->cursor_.reset(buffer_.inset());
1190 d->cursor_.selHandle(true);
1191 buffer_.text().cursorBottom(d->cursor_);
1192 // reject everything in a single step to support atomic undo
1193 // Note: reject does not work recursively; the user may have to repeat the operation
1194 buffer_.text().acceptOrRejectChanges(d->cursor_, Text::REJECT);
1197 case LFUN_WORD_FIND:
1201 case LFUN_WORD_REPLACE: {
1202 bool has_deleted = false;
1203 if (cur.selection()) {
1204 DocIterator beg = cur.selectionBegin();
1205 DocIterator end = cur.selectionEnd();
1206 if (beg.pit() == end.pit()) {
1207 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1208 if (cur.paragraph().isDeleted(p))
1213 replace(this, cmd, has_deleted);
1218 cur.clearSelection();
1220 cur.message(from_utf8(N_("Mark off")));
1224 cur.clearSelection();
1227 cur.message(from_utf8(N_("Mark on")));
1230 case LFUN_MARK_TOGGLE:
1231 cur.clearSelection();
1234 cur.message(from_utf8(N_("Mark removed")));
1237 cur.message(from_utf8(N_("Mark set")));
1242 case LFUN_SCREEN_RECENTER:
1246 case LFUN_BIBTEX_DATABASE_ADD: {
1247 Cursor tmpcur = d->cursor_;
1248 findInset(tmpcur, BIBTEX_CODE, false);
1249 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1252 if (inset->addDatabase(to_utf8(cmd.argument())))
1253 buffer_.updateBibfilesCache();
1258 case LFUN_BIBTEX_DATABASE_DEL: {
1259 Cursor tmpcur = d->cursor_;
1260 findInset(tmpcur, BIBTEX_CODE, false);
1261 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1264 if (inset->delDatabase(to_utf8(cmd.argument())))
1265 buffer_.updateBibfilesCache();
1270 case LFUN_WORDS_COUNT: {
1271 DocIterator from, to;
1272 if (cur.selection()) {
1273 from = cur.selectionBegin();
1274 to = cur.selectionEnd();
1276 from = doc_iterator_begin(buffer_.inset());
1277 to = doc_iterator_end(buffer_.inset());
1279 int const count = countWords(from, to);
1282 if (cur.selection())
1283 message = bformat(_("%1$d words in selection."),
1286 message = bformat(_("%1$d words in document."),
1290 if (cur.selection())
1291 message = _("One word in selection.");
1293 message = _("One word in document.");
1296 Alert::information(_("Count words"), message);
1300 case LFUN_BUFFER_TOGGLE_COMPRESSION:
1301 // turn compression on/off
1302 buffer_.params().compressed = !buffer_.params().compressed;
1305 case LFUN_NEXT_INSET_TOGGLE: {
1306 // this is the real function we want to invoke
1307 FuncRequest tmpcmd = FuncRequest(LFUN_INSET_TOGGLE, cmd.origin);
1308 // if there is an inset at cursor, see whether it
1310 Inset * inset = cur.nextInset();
1312 if (inset->isActive()) {
1313 Cursor tmpcur = cur;
1314 tmpcur.pushLeft(*inset);
1315 inset->dispatch(tmpcur, tmpcmd);
1316 if (tmpcur.result().dispatched()) {
1319 } else if (inset->editable() == Inset::IS_EDITABLE) {
1320 inset->edit(cur, true);
1323 // if it did not work, try the underlying inset.
1324 if (!cur.result().dispatched())
1325 cur.dispatch(tmpcmd);
1327 if (cur.result().dispatched())
1328 cur.clearSelection();
1333 case LFUN_SCREEN_UP:
1334 case LFUN_SCREEN_DOWN: {
1335 Point p = getPos(cur, cur.boundary());
1336 if (p.y_ < 0 || p.y_ > height_) {
1337 // The cursor is off-screen so recenter before proceeding.
1339 updateMetrics(false);
1340 //FIXME: updateMetrics() does not update paragraph position
1341 // This is done at draw() time. So we need a redraw!
1343 p = getPos(cur, cur.boundary());
1345 scroll(cmd.action == LFUN_SCREEN_UP? - height_ : height_);
1346 cur.reset(buffer_.inset());
1347 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_);
1348 //FIXME: what to do with cur.x_target()?
1350 // The metrics are already up to date. see scroll()
1351 updateFlags = Update::None;
1355 case LFUN_SCREEN_UP_SELECT:
1356 case LFUN_SCREEN_DOWN_SELECT: {
1357 cur.selHandle(true);
1358 size_t initial_depth = cur.depth();
1359 Point const p = getPos(cur, cur.boundary());
1360 scroll(cmd.action == LFUN_SCREEN_UP_SELECT? - height_ : height_);
1361 // FIXME: We need to verify if the cursor stayed within an inset...
1362 //cur.reset(buffer_.inset());
1363 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_);
1365 while (cur.depth() > initial_depth) {
1368 // FIXME: we need to do a redraw again because of the selection
1370 updateFlags = Update::Force | Update::FitCursor;
1375 updateFlags = Update::None;
1382 docstring const BufferView::requestSelection()
1384 Cursor & cur = d->cursor_;
1386 if (!cur.selection()) {
1387 d->xsel_cache_.set = false;
1391 if (!d->xsel_cache_.set ||
1392 cur.top() != d->xsel_cache_.cursor ||
1393 cur.anchor_.top() != d->xsel_cache_.anchor)
1395 d->xsel_cache_.cursor = cur.top();
1396 d->xsel_cache_.anchor = cur.anchor_.top();
1397 d->xsel_cache_.set = cur.selection();
1398 return cur.selectionAsString(false);
1404 void BufferView::clearSelection()
1406 d->cursor_.clearSelection();
1407 // Clear the selection buffer. Otherwise a subsequent
1408 // middle-mouse-button paste would use the selection buffer,
1409 // not the more current external selection.
1410 cap::clearSelection();
1411 d->xsel_cache_.set = false;
1412 // The buffer did not really change, but this causes the
1413 // redraw we need because we cleared the selection above.
1418 void BufferView::resize(int width, int height)
1420 // Update from work area
1424 updateMetrics(false);
1428 Inset const * BufferView::getCoveringInset(Text const & text, int x, int y)
1430 TextMetrics & tm = d->text_metrics_[&text];
1431 Inset * inset = tm.checkInsetHit(x, y);
1435 if (!inset->descendable())
1436 // No need to go further down if the inset is not
1440 size_t cell_number = inset->nargs();
1441 // Check all the inner cell.
1442 for (size_t i = 0; i != cell_number; ++i) {
1443 Text const * inner_text = inset->getText(i);
1446 Inset const * inset_deeper =
1447 getCoveringInset(*inner_text, x, y);
1449 return inset_deeper;
1457 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
1459 //lyxerr << BOOST_CURRENT_FUNCTION << "[ cmd0 " << cmd0 << "]" << endl;
1461 // This is only called for mouse related events including
1462 // LFUN_FILE_OPEN generated by drag-and-drop.
1463 FuncRequest cmd = cmd0;
1466 cur.push(buffer_.inset());
1467 cur.selection() = d->cursor_.selection();
1469 // Either the inset under the cursor or the
1470 // surrounding Text will handle this event.
1472 // make sure we stay within the screen...
1473 cmd.y = min(max(cmd.y, -1), height_);
1475 if (cmd.action == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
1477 // Get inset under mouse, if there is one.
1478 Inset const * covering_inset =
1479 getCoveringInset(buffer_.text(), cmd.x, cmd.y);
1480 if (covering_inset == d->last_inset_)
1481 // Same inset, no need to do anything...
1484 bool need_redraw = false;
1485 // const_cast because of setMouseHover().
1486 Inset * inset = const_cast<Inset *>(covering_inset);
1488 // Remove the hint on the last hovered inset (if any).
1489 need_redraw |= d->last_inset_->setMouseHover(false);
1491 // Highlighted the newly hovered inset (if any).
1492 need_redraw |= inset->setMouseHover(true);
1493 d->last_inset_ = inset;
1497 // if last metrics update was in singlepar mode, WorkArea::redraw() will
1498 // not expose the button for redraw. We adjust here the metrics dimension
1499 // to enable a full redraw in any case as this is not costly.
1500 TextMetrics & tm = d->text_metrics_[&buffer_.text()];
1501 std::pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
1502 std::pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
1503 int y1 = firstpm.second->position() - firstpm.second->ascent();
1504 int y2 = lastpm.second->position() + lastpm.second->descent();
1505 d->metrics_info_ = ViewMetricsInfo(firstpm.first, lastpm.first, y1, y2,
1506 FullScreenUpdate, buffer_.text().paragraphs().size());
1507 // Reinitialize anchor to first pit.
1508 d->anchor_ref_ = firstpm.first;
1509 d->offset_ref_ = -y1;
1510 LYXERR(Debug::PAINTING)
1511 << "Mouse hover detected at: (" << cmd.x << ", " << cmd.y << ")"
1512 << "\nTriggering redraw: y1: " << y1 << " y2: " << y2
1513 << " pit1: " << firstpm.first << " pit2: " << lastpm.first << endl;
1515 // This event (moving without mouse click) is not passed further.
1516 // This should be changed if it is further utilized.
1521 // Build temporary cursor.
1522 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x, cmd.y);
1524 // Put anchor at the same position.
1527 // Try to dispatch to an non-editable inset near this position
1528 // via the temp cursor. If the inset wishes to change the real
1529 // cursor it has to do so explicitly by using
1530 // cur.bv().cursor() = cur; (or similar)
1532 inset->dispatch(cur, cmd);
1534 // Now dispatch to the temporary cursor. If the real cursor should
1535 // be modified, the inset's dispatch has to do so explicitly.
1536 if (!cur.result().dispatched())
1539 //Do we have a selection?
1540 theSelection().haveSelection(cursor().selection());
1542 // If the command has been dispatched,
1543 if (cur.result().dispatched()
1544 // an update is asked,
1545 && cur.result().update())
1546 processUpdateFlags(cur.result().update());
1550 void BufferView::scroll(int y)
1559 void BufferView::scrollDown(int offset)
1561 Text * text = &buffer_.text();
1562 TextMetrics & tm = d->text_metrics_[text];
1563 int ymax = height_ + offset;
1565 std::pair<pit_type, ParagraphMetrics const *> last = tm.last();
1566 int bottom_pos = last.second->position() + last.second->descent();
1567 if (last.first + 1 == int(text->paragraphs().size())) {
1568 if (bottom_pos <= height_)
1570 offset = min(offset, bottom_pos - height_);
1573 if (bottom_pos > ymax)
1575 tm.newParMetricsDown();
1577 d->offset_ref_ += offset;
1578 updateMetrics(false);
1583 void BufferView::scrollUp(int offset)
1585 Text * text = &buffer_.text();
1586 TextMetrics & tm = d->text_metrics_[text];
1587 int ymin = - offset;
1589 std::pair<pit_type, ParagraphMetrics const *> first = tm.first();
1590 int top_pos = first.second->position() - first.second->ascent();
1591 if (first.first == 0) {
1594 offset = min(offset, - top_pos);
1599 tm.newParMetricsUp();
1601 d->offset_ref_ -= offset;
1602 updateMetrics(false);
1607 void BufferView::setCursorFromRow(int row)
1612 buffer_.texrow().getIdFromRow(row, tmpid, tmppos);
1614 d->cursor_.reset(buffer_.inset());
1616 buffer_.text().setCursor(d->cursor_, 0, 0);
1618 buffer_.text().setCursor(d->cursor_, buffer_.getParFromID(tmpid).pit(), tmppos);
1622 void BufferView::gotoLabel(docstring const & label)
1624 for (InsetIterator it = inset_iterator_begin(buffer_.inset()); it; ++it) {
1625 vector<docstring> labels;
1626 it->getLabelList(buffer_, labels);
1627 if (std::find(labels.begin(), labels.end(), label) != labels.end()) {
1629 processUpdateFlags(Update::FitCursor);
1636 TextMetrics const & BufferView::textMetrics(Text const * t) const
1638 return const_cast<BufferView *>(this)->textMetrics(t);
1642 TextMetrics & BufferView::textMetrics(Text const * t)
1644 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
1645 if (tmc_it == d->text_metrics_.end()) {
1646 tmc_it = d->text_metrics_.insert(
1647 make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
1649 return tmc_it->second;
1653 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
1656 return textMetrics(t).parMetrics(pit);
1660 int BufferView::workHeight() const
1666 void BufferView::setCursor(DocIterator const & dit)
1668 size_t const n = dit.depth();
1669 for (size_t i = 0; i < n; ++i)
1670 dit[i].inset().edit(d->cursor_, true);
1672 d->cursor_.setCursor(dit);
1673 d->cursor_.selection() = false;
1677 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
1679 // Would be wrong to delete anything if we have a selection.
1680 if (cur.selection())
1683 bool need_anchor_change = false;
1684 bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
1685 need_anchor_change);
1687 if (need_anchor_change)
1693 updateLabels(buffer_);
1695 updateMetrics(false);
1701 bool BufferView::mouseSetCursor(Cursor & cur, bool select)
1703 BOOST_ASSERT(&cur.bv() == this);
1706 // this event will clear selection so we save selection for
1707 // persistent selection
1708 cap::saveSelection(cursor());
1710 // Has the cursor just left the inset?
1711 bool badcursor = false;
1712 bool leftinset = (&d->cursor_.inset() != &cur.inset());
1714 badcursor = notifyCursorLeaves(d->cursor_, cur);
1716 // FIXME: shift-mouse selection doesn't work well across insets.
1717 bool do_selection = select && &d->cursor_.anchor().inset() == &cur.inset();
1719 // do the dEPM magic if needed
1720 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
1721 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
1722 // the leftinset bool would not be necessary (badcursor instead).
1723 bool update = leftinset;
1724 if (!do_selection && !badcursor && d->cursor_.inTexted())
1725 update |= checkDepm(cur, d->cursor_);
1727 // if the cursor was in an empty script inset and the new
1728 // position is in the nucleus of the inset, notifyCursorLeaves
1729 // will kill the script inset itself. So we check all the
1730 // elements of the cursor to make sure that they are correct.
1731 // For an example, see bug 2933:
1732 // http://bugzilla.lyx.org/show_bug.cgi?id=2933
1733 // The code below could maybe be moved to a DocIterator method.
1734 //lyxerr << "cur before " << cur <<std::endl;
1735 DocIterator dit(cur.inset());
1736 dit.push_back(cur.bottom());
1738 while (i < cur.depth() && dit.nextInset() == &cur[i].inset()) {
1739 dit.push_back(cur[i]);
1742 //lyxerr << "5 cur after" << dit <<std::endl;
1744 d->cursor_.setCursor(dit);
1745 d->cursor_.boundary(cur.boundary());
1747 d->cursor_.setSelection();
1749 d->cursor_.clearSelection();
1756 void BufferView::putSelectionAt(DocIterator const & cur,
1757 int length, bool backwards)
1759 d->cursor_.clearSelection();
1765 d->cursor_.pos() += length;
1766 d->cursor_.setSelection(d->cursor_, -length);
1768 d->cursor_.setSelection(d->cursor_, length);
1773 Cursor & BufferView::cursor()
1779 Cursor const & BufferView::cursor() const
1785 pit_type BufferView::anchor_ref() const
1787 return d->anchor_ref_;
1791 ViewMetricsInfo const & BufferView::viewMetricsInfo()
1793 return d->metrics_info_;
1797 bool BufferView::singleParUpdate()
1799 Text & buftext = buffer_.text();
1800 pit_type const bottom_pit = d->cursor_.bottom().pit();
1801 TextMetrics & tm = textMetrics(&buftext);
1802 int old_height = tm.parMetrics(bottom_pit).height();
1804 // In Single Paragraph mode, rebreak only
1805 // the (main text, not inset!) paragraph containing the cursor.
1806 // (if this paragraph contains insets etc., rebreaking will
1807 // recursively descend)
1808 tm.redoParagraph(bottom_pit);
1809 ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
1810 if (pm.height() != old_height)
1811 // Paragraph height has changed so we cannot proceed to
1812 // the singlePar optimisation.
1815 int y1 = pm.position() - pm.ascent();
1816 int y2 = pm.position() + pm.descent();
1817 d->metrics_info_ = ViewMetricsInfo(bottom_pit, bottom_pit, y1, y2,
1818 SingleParUpdate, buftext.paragraphs().size());
1819 LYXERR(Debug::PAINTING)
1820 << BOOST_CURRENT_FUNCTION
1823 << " pit: " << bottom_pit
1830 void BufferView::updateMetrics(bool singlepar)
1832 if (singlepar && singleParUpdate())
1833 // No need to update the full screen metrics.
1836 Text & buftext = buffer_.text();
1837 pit_type const npit = int(buftext.paragraphs().size());
1839 if (d->anchor_ref_ > int(npit - 1)) {
1840 d->anchor_ref_ = int(npit - 1);
1844 // Clear out the position cache in case of full screen redraw,
1845 d->coord_cache_.clear();
1847 // Clear out paragraph metrics to avoid having invalid metrics
1848 // in the cache from paragraphs not relayouted below
1849 // The complete text metrics will be redone.
1850 d->text_metrics_.clear();
1852 TextMetrics & tm = textMetrics(&buftext);
1854 pit_type const pit = d->anchor_ref_;
1858 // Rebreak anchor paragraph.
1859 tm.redoParagraph(pit);
1861 // Take care of anchor offset if case a recentering is needed.
1864 int y0 = tm.parMetrics(pit).ascent() - d->offset_ref_;
1866 // Redo paragraphs above anchor if necessary.
1868 while (y1 > 0 && pit1 > 0) {
1869 y1 -= tm.parMetrics(pit1).ascent();
1871 tm.redoParagraph(pit1);
1872 y1 -= tm.parMetrics(pit1).descent();
1875 // Take care of ascent of first line
1876 y1 -= tm.parMetrics(pit1).ascent();
1878 // Normalize anchor for next time
1879 d->anchor_ref_ = pit1;
1880 d->offset_ref_ = -y1;
1882 // Grey at the beginning is ugly
1883 if (pit1 == 0 && y1 > 0) {
1889 // Redo paragraphs below the anchor if necessary.
1891 while (y2 < height_ && pit2 < int(npit) - 1) {
1892 y2 += tm.parMetrics(pit2).descent();
1894 tm.redoParagraph(pit2);
1895 y2 += tm.parMetrics(pit2).ascent();
1898 // Take care of descent of last line
1899 y2 += tm.parMetrics(pit2).descent();
1901 LYXERR(Debug::PAINTING)
1902 << BOOST_CURRENT_FUNCTION
1905 << " pit1: " << pit1
1906 << " pit2: " << pit2
1907 << " npit: " << npit
1911 d->metrics_info_ = ViewMetricsInfo(pit1, pit2, y1, y2,
1912 FullScreenUpdate, npit);
1914 if (lyxerr.debugging(Debug::WORKAREA)) {
1915 LYXERR(Debug::WORKAREA) << "BufferView::updateMetrics" << endl;
1916 d->coord_cache_.dump();
1921 void BufferView::menuInsertLyXFile(string const & filenm)
1923 BOOST_ASSERT(d->cursor_.inTexted());
1924 string filename = filenm;
1926 if (filename.empty()) {
1927 // Launch a file browser
1929 string initpath = lyxrc.document_path;
1930 string const trypath = buffer_.filePath();
1931 // If directory is writeable, use this as default.
1932 if (isDirWriteable(FileName(trypath)))
1936 FileDialog fileDlg(_("Select LyX document to insert"),
1938 make_pair(_("Documents|#o#O"), from_utf8(lyxrc.document_path)),
1939 make_pair(_("Examples|#E#e"),
1940 from_utf8(addPath(package().system_support().absFilename(),
1943 FileDialog::Result result =
1944 fileDlg.open(from_utf8(initpath),
1945 FileFilterList(_("LyX Documents (*.lyx)")),
1948 if (result.first == FileDialog::Later)
1952 filename = to_utf8(result.second);
1954 // check selected filename
1955 if (filename.empty()) {
1956 // emit message signal.
1957 message(_("Canceled."));
1962 // Get absolute path of file and add ".lyx"
1963 // to the filename if necessary
1964 filename = fileSearch(string(), filename, "lyx").absFilename();
1966 docstring const disp_fn = makeDisplayPath(filename);
1967 // emit message signal.
1968 message(bformat(_("Inserting document %1$s..."), disp_fn));
1971 Buffer buf("", false);
1972 if (lyx::loadLyXFile(&buf, FileName(filename))) {
1973 ErrorList & el = buffer_.errorList("Parse");
1974 // Copy the inserted document error list into the current buffer one.
1975 el = buf.errorList("Parse");
1976 recordUndo(d->cursor_);
1977 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
1978 buf.params().getTextClassPtr(), el);
1979 res = _("Document %1$s inserted.");
1981 res = _("Could not insert document %1$s");
1983 // emit message signal.
1984 message(bformat(res, disp_fn));
1985 buffer_.errors("Parse");
1986 updateMetrics(false);
1990 Point BufferView::coordOffset(DocIterator const & dit, bool boundary) const
1996 // Addup contribution of nested insets, from inside to outside,
1997 // keeping the outer paragraph for a special handling below
1998 for (size_t i = dit.depth() - 1; i >= 1; --i) {
1999 CursorSlice const & sl = dit[i];
2003 // get relative position inside sl.inset()
2004 sl.inset().cursorPos(*this, sl, boundary && (i + 1 == dit.depth()), xx, yy);
2006 // Make relative position inside of the edited inset relative to sl.inset()
2010 // In case of an RTL inset, the edited inset will be positioned to the left
2013 bool boundary_i = boundary && i + 1 == dit.depth();
2014 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2019 // remember width for the case that sl.inset() is positioned in an RTL inset
2020 if (i && dit[i - 1].text()) {
2021 // If this Inset is inside a Text Inset, retrieve the Dimension
2022 // from the containing text instead of using Inset::dimension() which
2023 // might not be implemented.
2024 // FIXME (Abdel 23/09/2007): this is a bit messy because of the
2025 // elimination of Inset::dim_ cache. This coordOffset() method needs
2026 // to be rewritten in light of the new design.
2027 Dimension const & dim = parMetrics(dit[i - 1].text(),
2028 dit[i - 1].pit()).insetDimension(&sl.inset());
2031 Dimension const dim = sl.inset().dimension(*this);
2035 //lyxerr << "Cursor::getPos, i: "
2036 // << i << " x: " << xx << " y: " << y << endl;
2039 // Add contribution of initial rows of outermost paragraph
2040 CursorSlice const & sl = dit[0];
2041 TextMetrics const & tm = textMetrics(sl.text());
2042 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2043 BOOST_ASSERT(!pm.rows().empty());
2044 y -= pm.rows()[0].ascent();
2046 // FIXME: document this mess
2048 if (sl.pos() > 0 && dit.depth() == 1) {
2050 if (pos && boundary)
2052 // lyxerr << "coordOffset: boundary:" << boundary << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << std::endl;
2053 rend = pm.pos2row(pos);
2055 rend = pm.pos2row(sl.pos());
2057 size_t rend = pm.pos2row(sl.pos());
2059 for (size_t rit = 0; rit != rend; ++rit)
2060 y += pm.rows()[rit].height();
2061 y += pm.rows()[rend].ascent();
2063 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
2065 // Make relative position from the nested inset now bufferview absolute.
2066 int xx = bottom_tm.cursorX(dit.bottom(), boundary && dit.depth() == 1);
2069 // In the RTL case place the nested inset at the left of the cursor in
2070 // the outer paragraph
2071 bool boundary_1 = boundary && 1 == dit.depth();
2072 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
2080 Point BufferView::getPos(DocIterator const & dit, bool boundary) const
2082 CursorSlice const & bot = dit.bottom();
2083 TextMetrics const & tm = textMetrics(bot.text());
2084 if (!tm.has(bot.pit()))
2085 return Point(-1, -1);
2087 Point p = coordOffset(dit, boundary); // offset from outer paragraph
2088 p.y_ += tm.parMetrics(bot.pit()).position();
2093 void BufferView::draw(frontend::Painter & pain)
2095 PainterInfo pi(this, pain);
2096 // Should the whole screen, including insets, be refreshed?
2097 // FIXME: We should also distinguish DecorationUpdate to avoid text
2098 // drawing if possible. This is not possible to do easily right now
2099 // because of the single backing pixmap.
2100 pi.full_repaint = d->metrics_info_.update_strategy != SingleParUpdate;
2102 if (pi.full_repaint)
2103 // Clear background (if not delegated to rows)
2104 pain.fillRectangle(0, d->metrics_info_.y1, width_,
2105 d->metrics_info_.y2 - d->metrics_info_.y1,
2106 buffer_.inset().backgroundColor());
2108 LYXERR(Debug::PAINTING) << "\t\t*** START DRAWING ***" << endl;
2109 Text & text = buffer_.text();
2110 TextMetrics const & tm = d->text_metrics_[&text];
2111 int y = d->metrics_info_.y1 + tm.parMetrics(d->metrics_info_.p1).ascent();
2112 if (!pi.full_repaint)
2113 tm.drawParagraph(pi, d->metrics_info_.p1, 0, y);
2116 LYXERR(Debug::PAINTING) << "\n\t\t*** END DRAWING ***" << endl;
2118 // and grey out above (should not happen later)
2119 // lyxerr << "par ascent: " << text.getPar(d->metrics_info_.p1).ascent() << endl;
2120 if (d->metrics_info_.y1 > 0
2121 && d->metrics_info_.update_strategy == FullScreenUpdate)
2122 pain.fillRectangle(0, 0, width_, d->metrics_info_.y1, Color::bottomarea);
2124 // and possibly grey out below
2125 // lyxerr << "par descent: " << text.getPar(d->metrics_info_.p1).ascent() << endl;
2126 if (d->metrics_info_.y2 < height_
2127 && d->metrics_info_.update_strategy == FullScreenUpdate)
2128 pain.fillRectangle(0, d->metrics_info_.y2, width_,
2129 height_ - d->metrics_info_.y2, Color::bottomarea);
2133 void BufferView::message(docstring const & msg)
2136 d->gui_->message(msg);
2140 void BufferView::showDialog(std::string const & name)
2143 d->gui_->showDialog(name);
2147 void BufferView::showDialogWithData(std::string const & name,
2148 std::string const & data)
2151 d->gui_->showDialogWithData(name, data);
2155 void BufferView::showInsetDialog(std::string const & name,
2156 std::string const & data, Inset * inset)
2159 d->gui_->showInsetDialog(name, data, inset);
2163 void BufferView::updateDialog(std::string const & name, std::string const & data)
2166 d->gui_->updateDialog(name, data);
2170 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
2176 // FIXME: Move this out of BufferView again
2177 docstring BufferView::contentsOfPlaintextFile(string const & f,
2182 if (fname.empty()) {
2183 FileDialog fileDlg(_("Select file to insert"),
2185 ? LFUN_FILE_INSERT_PLAINTEXT_PARA
2186 : LFUN_FILE_INSERT_PLAINTEXT) );
2188 FileDialog::Result result =
2189 fileDlg.open(from_utf8(buffer().filePath()),
2190 FileFilterList(), docstring());
2192 if (result.first == FileDialog::Later)
2195 fname = makeAbsPath(to_utf8(result.second));
2201 if (!fs::is_readable(fname.toFilesystemEncoding())) {
2202 docstring const error = from_ascii(strerror(errno));
2203 docstring const file = makeDisplayPath(fname.absFilename(), 50);
2204 docstring const text =
2205 bformat(_("Could not read the specified document\n"
2206 "%1$s\ndue to the error: %2$s"), file, error);
2207 Alert::error(_("Could not read file"), text);
2211 ifstream ifs(fname.toFilesystemEncoding().c_str());
2213 docstring const error = from_ascii(strerror(errno));
2214 docstring const file = makeDisplayPath(fname.absFilename(), 50);
2215 docstring const text =
2216 bformat(_("Could not open the specified document\n"
2217 "%1$s\ndue to the error: %2$s"), file, error);
2218 Alert::error(_("Could not open file"), text);
2222 ifs.unsetf(std::ios::skipws);
2223 istream_iterator<char> ii(ifs);
2224 istream_iterator<char> end;
2225 #if !defined(USE_INCLUDED_STRING) && !defined(STD_STRING_IS_GOOD)
2226 // We use this until the compilers get better...
2227 std::vector<char> tmp;
2228 copy(ii, end, back_inserter(tmp));
2229 string const tmpstr(tmp.begin(), tmp.end());
2231 // This is what we want to use and what we will use once the
2232 // compilers get good enough.
2233 //string tmpstr(ii, end); // yet a reason for using std::string
2234 // alternate approach to get the file into a string:
2236 copy(ii, end, back_inserter(tmpstr));
2239 // FIXME UNICODE: We don't know the encoding of the file
2240 docstring file_content = from_utf8(tmpstr);
2241 if (file_content.empty()) {
2242 Alert::error(_("Reading not UTF-8 encoded file"),
2243 _("The file is not UTF-8 encoded.\n"
2244 "It will be read as local 8Bit-encoded.\n"
2245 "If this does not give the correct result\n"
2246 "then please change the encoding of the file\n"
2247 "to UTF-8 with a program other than LyX.\n"));
2248 file_content = from_local8bit(tmpstr);
2251 return normalize_c(file_content);
2255 void BufferView::insertPlaintextFile(string const & f, bool asParagraph)
2257 docstring const tmpstr = contentsOfPlaintextFile(f, asParagraph);
2262 Cursor & cur = cursor();
2263 cap::replaceSelection(cur);
2266 cur.innerText()->insertStringAsParagraphs(cur, tmpstr);
2268 cur.innerText()->insertStringAsLines(cur, tmpstr);