]> git.lyx.org Git - lyx.git/blob - src/BufferView.cpp
448d1958574303f0b55505c4fe0211762b01002b
[lyx.git] / src / BufferView.cpp
1 /**
2  * \file BufferView.cpp
3  * This file is part of LyX, the document processor.
4  * Licence details can be found in the file COPYING.
5  *
6  * \author Alfredo Braunstein
7  * \author Lars Gullik Bjønnes
8  * \author John Levon
9  * \author André Pönitz
10  * \author Jürgen Vigna
11  *
12  * Full author contact details are available in file CREDITS.
13  */
14
15 #include <config.h>
16
17 #include "BufferView.h"
18
19 #include "Buffer.h"
20 #include "buffer_funcs.h"
21 #include "BufferList.h"
22 #include "BufferParams.h"
23 #include "CoordCache.h"
24 #include "Cursor.h"
25 #include "CutAndPaste.h"
26 #include "DispatchResult.h"
27 #include "EmbeddedFiles.h"
28 #include "ErrorList.h"
29 #include "factory.h"
30 #include "FloatList.h"
31 #include "FuncRequest.h"
32 #include "FuncStatus.h"
33 #include "Intl.h"
34 #include "InsetIterator.h"
35 #include "Language.h"
36 #include "LaTeXFeatures.h"
37 #include "LyX.h"
38 #include "lyxfind.h"
39 #include "LyXFunc.h"
40 #include "Layout.h"
41 #include "LyXRC.h"
42 #include "MetricsInfo.h"
43 #include "Paragraph.h"
44 #include "paragraph_funcs.h"
45 #include "ParagraphParameters.h"
46 #include "ParIterator.h"
47 #include "Session.h"
48 #include "Text.h"
49 #include "TextClass.h"
50 #include "TextMetrics.h"
51 #include "TexRow.h"
52 #include "VSpace.h"
53 #include "WordLangTuple.h"
54
55 #include "insets/InsetBibtex.h"
56 #include "insets/InsetCommand.h" // ChangeRefs
57 #include "insets/InsetRef.h"
58 #include "insets/InsetText.h"
59
60 #include "frontends/alert.h"
61 #include "frontends/Application.h"
62 #include "frontends/Delegates.h"
63 #include "frontends/FontMetrics.h"
64 #include "frontends/Painter.h"
65 #include "frontends/Selection.h"
66
67 #include "graphics/Previews.h"
68
69 #include "support/convert.h"
70 #include "support/debug.h"
71 #include "support/ExceptionMessage.h"
72 #include "support/filetools.h"
73 #include "support/gettext.h"
74 #include "support/lstrings.h"
75 #include "support/Package.h"
76 #include "support/types.h"
77
78 #include <cerrno>
79 #include <fstream>
80 #include <functional>
81 #include <iterator>
82 #include <vector>
83
84 using namespace std;
85 using namespace lyx::support;
86
87 namespace lyx {
88
89 namespace Alert = frontend::Alert;
90
91 namespace {
92
93 /// Return an inset of this class if it exists at the current cursor position
94 template <class T>
95 T * getInsetByCode(Cursor const & cur, InsetCode code)
96 {
97         DocIterator it = cur;
98         Inset * inset = it.nextInset();
99         if (inset && inset->lyxCode() == code)
100                 return static_cast<T*>(inset);
101         return 0;
102 }
103
104
105 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
106         bool same_content);
107
108 bool findNextInset(DocIterator & dit, vector<InsetCode> const & codes,
109         docstring const & contents)
110 {
111         DocIterator tmpdit = dit;
112
113         while (tmpdit) {
114                 Inset const * inset = tmpdit.nextInset();
115                 if (inset
116                     && std::find(codes.begin(), codes.end(), inset->lyxCode()) != codes.end()
117                     && (contents.empty() ||
118                     static_cast<InsetCommand const *>(inset)->getFirstNonOptParam() == contents)) {
119                         dit = tmpdit;
120                         return true;
121                 }
122                 tmpdit.forwardInset();
123         }
124
125         return false;
126 }
127
128
129 /// Looks for next inset with one of the given codes.
130 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
131         bool same_content)
132 {
133         docstring contents;
134         DocIterator tmpdit = dit;
135         tmpdit.forwardInset();
136         if (!tmpdit)
137                 return false;
138
139         if (same_content) {
140                 Inset const * inset = tmpdit.nextInset();
141                 if (inset
142                     && std::find(codes.begin(), codes.end(), inset->lyxCode()) != codes.end()) {
143                         contents = static_cast<InsetCommand const *>(inset)->getFirstNonOptParam();
144                 }
145         }
146
147         if (!findNextInset(tmpdit, codes, contents)) {
148                 if (dit.depth() != 1 || dit.pit() != 0 || dit.pos() != 0) {
149                         tmpdit  = doc_iterator_begin(tmpdit.bottom().inset());
150                         if (!findNextInset(tmpdit, codes, contents))
151                                 return false;
152                 } else
153                         return false;
154         }
155
156         dit = tmpdit;
157         return true;
158 }
159
160
161 /// Looks for next inset with the given code
162 void findInset(DocIterator & dit, InsetCode code, bool same_content)
163 {
164         findInset(dit, vector<InsetCode>(1, code), same_content);
165 }
166
167
168 /// Moves cursor to the next inset with one of the given codes.
169 void gotoInset(BufferView * bv, vector<InsetCode> const & codes,
170                bool same_content)
171 {
172         Cursor tmpcur = bv->cursor();
173         if (!findInset(tmpcur, codes, same_content)) {
174                 bv->cursor().message(_("No more insets"));
175                 return;
176         }
177
178         tmpcur.clearSelection();
179         bv->setCursor(tmpcur);
180         bv->showCursor();
181 }
182
183
184 /// Moves cursor to the next inset with given code.
185 void gotoInset(BufferView * bv, InsetCode code, bool same_content)
186 {
187         gotoInset(bv, vector<InsetCode>(1, code), same_content);
188 }
189
190
191 /// A map from a Text to the associated text metrics
192 typedef map<Text const *, TextMetrics> TextMetricsCache;
193
194 enum ScreenUpdateStrategy {
195         NoScreenUpdate,
196         SingleParUpdate,
197         FullScreenUpdate,
198         DecorationUpdate
199 };
200
201 } // anon namespace
202
203
204 /////////////////////////////////////////////////////////////////////
205 //
206 // BufferView
207 //
208 /////////////////////////////////////////////////////////////////////
209
210 struct BufferView::Private
211 {
212         Private(BufferView & bv): wh_(0), cursor_(bv),
213                 anchor_pit_(0), anchor_ypos_(0),
214                 last_inset_(0), gui_(0)
215         {}
216
217         ///
218         ScrollbarParameters scrollbarParameters_;
219         ///
220         ScreenUpdateStrategy update_strategy_;
221         ///
222         CoordCache coord_cache_;
223
224         /// Estimated average par height for scrollbar.
225         int wh_;
226         /// this is used to handle XSelection events in the right manner.
227         struct {
228                 CursorSlice cursor;
229                 CursorSlice anchor;
230                 bool set;
231         } xsel_cache_;
232         ///
233         Cursor cursor_;
234         ///
235         pit_type anchor_pit_;
236         ///
237         int anchor_ypos_;
238         ///
239         vector<int> par_height_;
240
241         ///
242         DocIterator inlineCompletionPos;
243         ///
244         docstring inlineCompletion;
245         ///
246         size_t inlineCompletionUniqueChars;
247
248         /// keyboard mapping object.
249         Intl intl_;
250
251         /// last visited inset.
252         /** kept to send setMouseHover(false).
253           * Not owned, so don't delete.
254           */
255         Inset * last_inset_;
256
257         mutable TextMetricsCache text_metrics_;
258
259         /// Whom to notify.
260         /** Not owned, so don't delete.
261           */
262         frontend::GuiBufferViewDelegate * gui_;
263 };
264
265
266 BufferView::BufferView(Buffer & buf)
267         : width_(0), height_(0), full_screen_(false), buffer_(buf), d(new Private(*this))
268 {
269         d->xsel_cache_.set = false;
270         d->intl_.initKeyMapper(lyxrc.use_kbmap);
271
272         d->cursor_.push(buffer_.inset());
273         d->cursor_.resetAnchor();
274         d->cursor_.setCurrentFont();
275
276         if (graphics::Previews::status() != LyXRC::PREVIEW_OFF)
277                 graphics::Previews::get().generateBufferPreviews(buffer_);
278 }
279
280
281 BufferView::~BufferView()
282 {
283         // current buffer is going to be switched-off, save cursor pos
284         // Ideally, the whole cursor stack should be saved, but session
285         // currently can only handle bottom (whole document) level pit and pos.
286         // That is to say, if a cursor is in a nested inset, it will be
287         // restore to the left of the top level inset.
288         LastFilePosSection::FilePos fp;
289         fp.pit = d->cursor_.bottom().pit();
290         fp.pos = d->cursor_.bottom().pos();
291         LyX::ref().session().lastFilePos().save(buffer_.fileName(), fp);
292
293         delete d;
294 }
295
296
297 int BufferView::rightMargin() const
298 {
299         // The additional test for the case the outliner is opened.
300         if (!full_screen_ ||
301                 !lyxrc.full_screen_limit ||
302                 width_ < lyxrc.full_screen_width + 20)
303                         return 10;
304
305         return (width_ - lyxrc.full_screen_width) / 2;
306 }
307
308
309 int BufferView::leftMargin() const
310 {
311         return rightMargin();
312 }
313
314
315 bool BufferView::isTopScreen() const
316 {
317         return d->scrollbarParameters_.position == d->scrollbarParameters_.min;
318 }
319
320
321 bool BufferView::isBottomScreen() const
322 {
323         return d->scrollbarParameters_.position == d->scrollbarParameters_.max;
324 }
325
326
327 Intl & BufferView::getIntl()
328 {
329         return d->intl_;
330 }
331
332
333 Intl const & BufferView::getIntl() const
334 {
335         return d->intl_;
336 }
337
338
339 CoordCache & BufferView::coordCache()
340 {
341         return d->coord_cache_;
342 }
343
344
345 CoordCache const & BufferView::coordCache() const
346 {
347         return d->coord_cache_;
348 }
349
350
351 Buffer & BufferView::buffer()
352 {
353         return buffer_;
354 }
355
356
357 Buffer const & BufferView::buffer() const
358 {
359         return buffer_;
360 }
361
362
363 bool BufferView::fitCursor()
364 {
365         if (cursorStatus(d->cursor_) == CUR_INSIDE) {
366                 frontend::FontMetrics const & fm =
367                         theFontMetrics(d->cursor_.getFont().fontInfo());
368                 int const asc = fm.maxAscent();
369                 int const des = fm.maxDescent();
370                 Point const p = getPos(d->cursor_, d->cursor_.boundary());
371                 if (p.y_ - asc >= 0 && p.y_ + des < height_)
372                         return false;
373         }
374         return true;
375 }
376
377
378 void BufferView::processUpdateFlags(Update::flags flags)
379 {
380         // last_inset_ points to the last visited inset. This pointer may become
381         // invalid because of keyboard editing. Since all such operations
382         // causes screen update(), I reset last_inset_ to avoid such a problem.
383         d->last_inset_ = 0;
384         // This is close to a hot-path.
385         LYXERR(Debug::DEBUG, "BufferView::processUpdateFlags()"
386                 << "[fitcursor = " << (flags & Update::FitCursor)
387                 << ", forceupdate = " << (flags & Update::Force)
388                 << ", singlepar = " << (flags & Update::SinglePar)
389                 << "]  buffer: " << &buffer_);
390
391         buffer_.updateMacros();
392
393         // Now do the first drawing step if needed. This consists on updating
394         // the CoordCache in updateMetrics().
395         // The second drawing step is done in WorkArea::redraw() if needed.
396
397         // Case when no explicit update is requested.
398         if (!flags) {
399                 // no need to redraw anything.
400                 d->update_strategy_ = NoScreenUpdate;
401                 return;
402         }
403
404         if (flags == Update::Decoration) {
405                 d->update_strategy_ = DecorationUpdate;
406                 buffer_.changed();
407                 return;
408         }
409
410         if (flags == Update::FitCursor
411                 || flags == (Update::Decoration | Update::FitCursor)) {
412                 // tell the frontend to update the screen if needed.
413                 if (fitCursor()) {
414                         showCursor();
415                         return;
416                 }
417                 if (flags & Update::Decoration) {
418                         d->update_strategy_ = DecorationUpdate;
419                         buffer_.changed();
420                         return;
421                 }
422                 // no screen update is needed.
423                 d->update_strategy_ = NoScreenUpdate;
424                 return;
425         }
426
427         bool const full_metrics = flags & Update::Force || !singleParUpdate();
428
429         if (full_metrics)
430                 // We have to update the full screen metrics.
431                 updateMetrics();
432
433         if (!(flags & Update::FitCursor)) {
434                 // Nothing to do anymore. Trigger a redraw and return
435                 buffer_.changed();
436                 return;
437         }
438
439         // updateMetrics() does not update paragraph position
440         // This is done at draw() time. So we need a redraw!
441         buffer_.changed();
442
443         if (fitCursor()) {
444                 // The cursor is off screen so ensure it is visible.
445                 // refresh it:
446                 showCursor();
447         }
448 }
449
450
451 void BufferView::updateScrollbar()
452 {
453         if (height_ == 0)
454                 return;
455
456         // We prefer fixed size line scrolling.
457         d->scrollbarParameters_.single_step = defaultRowHeight();
458         // We prefer full screen page scrolling.
459         d->scrollbarParameters_.page_step = height_;
460
461         Text & t = buffer_.text();
462         TextMetrics & tm = d->text_metrics_[&t];                
463
464         LYXERR(Debug::GUI, " Updating scrollbar: height: "
465                 << t.paragraphs().size()
466                 << " curr par: " << d->cursor_.bottom().pit()
467                 << " default height " << defaultRowHeight());
468
469         size_t const parsize = t.paragraphs().size();
470         if (d->par_height_.size() != parsize) {
471                 d->par_height_.clear();
472                 // FIXME: We assume a default paragraph height of 2 rows. This
473                 // should probably be pondered with the screen width.
474                 d->par_height_.resize(parsize, defaultRowHeight() * 2);
475         }
476
477         // Look at paragraph heights on-screen
478         pair<pit_type, ParagraphMetrics const *> first = tm.first();
479         pair<pit_type, ParagraphMetrics const *> last = tm.last();
480         for (pit_type pit = first.first; pit <= last.first; ++pit) {
481                 d->par_height_[pit] = tm.parMetrics(pit).height();
482                 LYXERR(Debug::SCROLLING, "storing height for pit " << pit << " : "
483                         << d->par_height_[pit]);
484         }
485
486         int top_pos = first.second->position() - first.second->ascent();
487         int bottom_pos = last.second->position() + last.second->descent();
488         bool first_visible = first.first == 0 && top_pos >= 0;
489         bool last_visible = last.first + 1 == int(parsize) && bottom_pos <= height_;
490         if (first_visible && last_visible) {
491                 d->scrollbarParameters_.min = 0;
492                 d->scrollbarParameters_.max = 0;
493                 return;
494         }
495
496         d->scrollbarParameters_.min = top_pos;
497         for (size_t i = 0; i != size_t(first.first); ++i)
498                 d->scrollbarParameters_.min -= d->par_height_[i];
499         d->scrollbarParameters_.max = bottom_pos;
500         for (size_t i = last.first + 1; i != parsize; ++i)
501                 d->scrollbarParameters_.max += d->par_height_[i];
502
503         d->scrollbarParameters_.position = 0;
504         // The reference is the top position so we remove one page.
505         d->scrollbarParameters_.max -= d->scrollbarParameters_.page_step;
506 }
507
508
509 ScrollbarParameters const & BufferView::scrollbarParameters() const
510 {
511         return d->scrollbarParameters_;
512 }
513
514
515 docstring BufferView::toolTip(int x, int y) const
516 {
517         // Get inset under mouse, if there is one.
518         Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
519         if (!covering_inset)
520                 // No inset, no tooltip...
521                 return docstring();
522         return covering_inset->toolTip(*this, x, y);
523 }
524
525
526 docstring BufferView::contextMenu(int x, int y) const
527 {
528         // Get inset under mouse, if there is one.
529         Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
530         if (covering_inset)
531                 return covering_inset->contextMenu(*this, x, y);
532
533         // FIXME: Do something more elaborate here.
534         return from_ascii("edit");
535 }
536
537
538 void BufferView::scrollDocView(int value)
539 {
540         int const offset = value - d->scrollbarParameters_.position;
541         // If the offset is less than 2 screen height, prefer to scroll instead.
542         if (abs(offset) <= 2 * height_) {
543                 scroll(offset);
544                 return;
545         }
546
547         // cut off at the top
548         if (value <= d->scrollbarParameters_.min) {
549                 DocIterator dit = doc_iterator_begin(buffer_.inset());
550                 showCursor(dit);
551                 LYXERR(Debug::SCROLLING, "scroll to top");
552                 return;
553         }
554
555         // cut off at the bottom
556         if (value >= d->scrollbarParameters_.max) {
557                 DocIterator dit = doc_iterator_end(buffer_.inset());
558                 dit.backwardPos();
559                 showCursor(dit);
560                 LYXERR(Debug::SCROLLING, "scroll to bottom");
561                 return;
562         }
563
564         // find paragraph at target position
565         int par_pos = d->scrollbarParameters_.min;
566         pit_type i = 0;
567         for (; i != int(d->par_height_.size()); ++i) {
568                 par_pos += d->par_height_[i];
569                 if (par_pos >= value)
570                         break;
571         }
572
573         if (par_pos < value) {
574                 // It seems we didn't find the correct pit so stay on the safe side and
575                 // scroll to bottom.
576                 LYXERR0("scrolling position not found!");
577                 scrollDocView(d->scrollbarParameters_.max);
578                 return;
579         }
580
581         DocIterator dit = doc_iterator_begin(buffer_.inset());
582         dit.pit() = i;
583         LYXERR(Debug::SCROLLING, "value = " << value << " -> scroll to pit " << i);
584         showCursor(dit);
585 }
586
587
588 // FIXME: this method is not working well.
589 void BufferView::setCursorFromScrollbar()
590 {
591         TextMetrics & tm = d->text_metrics_[&buffer_.text()];
592
593         int const height = 2 * defaultRowHeight();
594         int const first = height;
595         int const last = height_ - height;
596         Cursor & cur = d->cursor_;
597
598         switch (cursorStatus(cur)) {
599         case CUR_ABOVE:
600                 // We reset the cursor because cursorStatus() does not
601                 // work when the cursor is within mathed.
602                 cur.reset(buffer_.inset());
603                 tm.setCursorFromCoordinates(cur, 0, first);
604                 cur.clearSelection();
605                 break;
606         case CUR_BELOW:
607                 // We reset the cursor because cursorStatus() does not
608                 // work when the cursor is within mathed.
609                 cur.reset(buffer_.inset());
610                 tm.setCursorFromCoordinates(cur, 0, last);
611                 cur.clearSelection();
612                 break;
613         case CUR_INSIDE:
614                 int const y = getPos(cur, cur.boundary()).y_;
615                 int const newy = min(last, max(y, first));
616                 if (y != newy) {
617                         cur.reset(buffer_.inset());
618                         tm.setCursorFromCoordinates(cur, 0, newy);
619                 }
620         }
621 }
622
623
624 Change const BufferView::getCurrentChange() const
625 {
626         if (!d->cursor_.selection())
627                 return Change(Change::UNCHANGED);
628
629         DocIterator dit = d->cursor_.selectionBegin();
630         return dit.paragraph().lookupChange(dit.pos());
631 }
632
633
634 // this could be used elsewhere as well?
635 // FIXME: This does not work within mathed!
636 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
637 {
638         Point const p = getPos(dit, dit.boundary());
639         if (p.y_ < 0)
640                 return CUR_ABOVE;
641         if (p.y_ > workHeight())
642                 return CUR_BELOW;
643         return CUR_INSIDE;
644 }
645
646
647 void BufferView::saveBookmark(unsigned int idx)
648 {
649         // tenatively save bookmark, id and pos will be used to
650         // acturately locate a bookmark in a 'live' lyx session.
651         // pit and pos will be updated with bottom level pit/pos
652         // when lyx exits.
653         LyX::ref().session().bookmarks().save(
654                 buffer_.fileName(),
655                 d->cursor_.bottom().pit(),
656                 d->cursor_.bottom().pos(),
657                 d->cursor_.paragraph().id(),
658                 d->cursor_.pos(),
659                 idx
660         );
661         if (idx)
662                 // emit message signal.
663                 message(_("Save bookmark"));
664 }
665
666
667 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
668         int top_id, pos_type top_pos)
669 {
670         bool success = false;
671         DocIterator dit;
672
673         d->cursor_.clearSelection();
674
675         // if a valid par_id is given, try it first
676         // This is the case for a 'live' bookmark when unique paragraph ID
677         // is used to track bookmarks.
678         if (top_id > 0) {
679                 dit = buffer_.getParFromID(top_id);
680                 if (!dit.atEnd()) {
681                         dit.pos() = min(dit.paragraph().size(), top_pos);
682                         // Some slices of the iterator may not be
683                         // reachable (e.g. closed collapsable inset)
684                         // so the dociterator may need to be
685                         // shortened. Otherwise, setCursor may crash
686                         // lyx when the cursor can not be set to these
687                         // insets.
688                         size_t const n = dit.depth();
689                         for (size_t i = 0; i < n; ++i)
690                                 if (dit[i].inset().editable() != Inset::HIGHLY_EDITABLE) {
691                                         dit.resize(i);
692                                         break;
693                                 }
694                         success = true;
695                 }
696         }
697
698         // if top_id == 0, or searching through top_id failed
699         // This is the case for a 'restored' bookmark when only bottom
700         // (document level) pit was saved. Because of this, bookmark
701         // restoration is inaccurate. If a bookmark was within an inset,
702         // it will be restored to the left of the outmost inset that contains
703         // the bookmark.
704         if (bottom_pit < int(buffer_.paragraphs().size())) {
705                 dit = doc_iterator_begin(buffer_.inset());
706                                 
707                 dit.pit() = bottom_pit;
708                 dit.pos() = min(bottom_pos, dit.paragraph().size());
709                 success = true;
710         }
711
712         if (success) {
713                 // Note: only bottom (document) level pit is set.
714                 setCursor(dit);
715                 // set the current font.
716                 d->cursor_.setCurrentFont();
717                 // To center the screen on this new position we need the
718                 // paragraph position which is computed at draw() time.
719                 // So we need a redraw!
720                 buffer_.changed();
721                 if (fitCursor())
722                         showCursor();
723         }
724
725         return success;
726 }
727
728
729 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
730 {
731         if (lyxrc.rtl_support) {
732                 if (d->cursor_.real_current_font.isRightToLeft()) {
733                         if (d->intl_.keymap == Intl::PRIMARY)
734                                 d->intl_.keyMapSec();
735                 } else {
736                         if (d->intl_.keymap == Intl::SECONDARY)
737                                 d->intl_.keyMapPrim();
738                 }
739         }
740
741         d->intl_.getTransManager().translateAndInsert(c, t, cur);
742 }
743
744
745 int BufferView::workWidth() const
746 {
747         return width_;
748 }
749
750
751 void BufferView::showCursor()
752 {
753         showCursor(d->cursor_);
754 }
755
756
757 void BufferView::showCursor(DocIterator const & dit)
758 {
759         // We are not properly started yet, delay until resizing is
760         // done.
761         if (height_ == 0)
762                 return;
763
764         LYXERR(Debug::SCROLLING, "recentering!");
765
766         CursorSlice const & bot = dit.bottom();
767         TextMetrics & tm = d->text_metrics_[bot.text()];
768
769         pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
770         int bot_pit = bot.pit();
771         if (bot_pit > max_pit) {
772                 // FIXME: Why does this happen?
773                 LYXERR0("bottom pit is greater that max pit: "
774                         << bot_pit << " > " << max_pit);
775                 bot_pit = max_pit;
776         }
777
778         if (bot_pit == tm.first().first - 1)
779                 tm.newParMetricsUp();
780         else if (bot_pit == tm.last().first + 1)
781                 tm.newParMetricsDown();
782
783         if (tm.contains(bot_pit)) {
784                 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
785                 BOOST_ASSERT(!pm.rows().empty());
786                 // FIXME: smooth scrolling doesn't work in mathed.
787                 CursorSlice const & cs = dit.innerTextSlice();
788                 int offset = coordOffset(dit, dit.boundary()).y_;
789                 int ypos = pm.position() + offset;
790                 Dimension const & row_dim =
791                         pm.getRow(cs.pos(), dit.boundary()).dimension();
792                 if (ypos - row_dim.ascent() < 0)
793                         scrollUp(- ypos + row_dim.ascent());
794                 else if (ypos + row_dim.descent() > height_)
795                         scrollDown(ypos - height_ + row_dim.descent());
796                 // else, nothing to do, the cursor is already visible so we just return.
797                 return;
798         }
799
800         // fix inline completion position
801         if (d->inlineCompletionPos.fixIfBroken())
802                 d->inlineCompletionPos = DocIterator();
803
804         tm.redoParagraph(bot_pit);
805         ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
806         int offset = coordOffset(dit, dit.boundary()).y_;
807
808         d->anchor_pit_ = bot_pit;
809         CursorSlice const & cs = dit.innerTextSlice();
810         Dimension const & row_dim =
811                 pm.getRow(cs.pos(), dit.boundary()).dimension();
812
813         if (d->anchor_pit_ == 0)
814                 d->anchor_ypos_ = offset + pm.ascent();
815         else if (d->anchor_pit_ == max_pit)
816                 d->anchor_ypos_ = height_ - offset - row_dim.descent();
817         else
818                 d->anchor_ypos_ = defaultRowHeight() * 2 - offset - row_dim.descent();
819
820         updateMetrics();
821         buffer_.changed();
822 }
823
824
825 FuncStatus BufferView::getStatus(FuncRequest const & cmd)
826 {
827         FuncStatus flag;
828
829         Cursor & cur = d->cursor_;
830
831         switch (cmd.action) {
832
833         case LFUN_UNDO:
834                 flag.enabled(buffer_.undo().hasUndoStack());
835                 break;
836         case LFUN_REDO:
837                 flag.enabled(buffer_.undo().hasRedoStack());
838                 break;
839         case LFUN_FILE_INSERT:
840         case LFUN_FILE_INSERT_PLAINTEXT_PARA:
841         case LFUN_FILE_INSERT_PLAINTEXT:
842         case LFUN_BOOKMARK_SAVE:
843                 // FIXME: Actually, these LFUNS should be moved to Text
844                 flag.enabled(cur.inTexted());
845                 break;
846         case LFUN_FONT_STATE:
847         case LFUN_LABEL_INSERT:
848         case LFUN_INFO_INSERT:
849         case LFUN_PARAGRAPH_GOTO:
850         case LFUN_NOTE_NEXT:
851         case LFUN_REFERENCE_NEXT:
852         case LFUN_WORD_FIND:
853         case LFUN_WORD_REPLACE:
854         case LFUN_MARK_OFF:
855         case LFUN_MARK_ON:
856         case LFUN_MARK_TOGGLE:
857         case LFUN_SCREEN_RECENTER:
858         case LFUN_BIBTEX_DATABASE_ADD:
859         case LFUN_BIBTEX_DATABASE_DEL:
860         case LFUN_STATISTICS:
861         case LFUN_NEXT_INSET_TOGGLE:
862                 flag.enabled(true);
863                 break;
864
865         case LFUN_LABEL_GOTO: {
866                 flag.enabled(!cmd.argument().empty()
867                     || getInsetByCode<InsetRef>(cur, REF_CODE));
868                 break;
869         }
870
871         case LFUN_CHANGES_TRACK:
872                 flag.enabled(true);
873                 flag.setOnOff(buffer_.params().trackChanges);
874                 break;
875
876         case LFUN_CHANGES_OUTPUT:
877                 flag.enabled(true);
878                 flag.setOnOff(buffer_.params().outputChanges);
879                 break;
880
881         case LFUN_CHANGES_MERGE:
882         case LFUN_CHANGE_NEXT:
883         case LFUN_ALL_CHANGES_ACCEPT:
884         case LFUN_ALL_CHANGES_REJECT:
885                 // TODO: context-sensitive enabling of LFUNs
886                 // In principle, these command should only be enabled if there
887                 // is a change in the document. However, without proper
888                 // optimizations, this will inevitably result in poor performance.
889                 flag.enabled(true);
890                 break;
891
892         case LFUN_BUFFER_TOGGLE_COMPRESSION: {
893                 flag.setOnOff(buffer_.params().compressed);
894                 break;
895         }
896         
897         case LFUN_BUFFER_TOGGLE_EMBEDDING: {
898                 flag.setOnOff(buffer_.params().embedded);
899                 break;
900         }
901
902         case LFUN_SCREEN_UP:
903         case LFUN_SCREEN_DOWN:
904         case LFUN_SCROLL:
905                 flag.enabled(true);
906                 break;
907
908         // FIXME: LFUN_SCREEN_DOWN_SELECT should be removed from
909         // everywhere else before this can enabled:
910         case LFUN_SCREEN_UP_SELECT:
911         case LFUN_SCREEN_DOWN_SELECT:
912                 flag.enabled(false);
913                 break;
914
915         case LFUN_LAYOUT_TABULAR:
916                 flag.enabled(cur.innerInsetOfType(TABULAR_CODE));
917                 break;
918
919         case LFUN_LAYOUT:
920         case LFUN_LAYOUT_PARAGRAPH:
921                 flag.enabled(cur.inset().allowParagraphCustomization(cur.idx()));
922                 break;
923
924         case LFUN_INSET_SETTINGS: {
925                 InsetCode code = cur.inset().lyxCode();
926                 bool enable = false;
927                 switch (code) {
928                         case TABULAR_CODE:
929                                 enable = cmd.argument() == "tabular";
930                                 break;
931                         case ERT_CODE:
932                                 enable = cmd.argument() == "ert";
933                                 break;
934                         case FLOAT_CODE:
935                                 enable = cmd.argument() == "float";
936                                 break;
937                         case WRAP_CODE:
938                                 enable = cmd.argument() == "wrap";
939                                 break;
940                         case NOTE_CODE:
941                                 enable = cmd.argument() == "note";
942                                 break;
943                         case BRANCH_CODE:
944                                 enable = cmd.argument() == "branch";
945                                 break;
946                         case BOX_CODE:
947                                 enable = cmd.argument() == "box";
948                                 break;
949                         case LISTINGS_CODE:
950                                 enable = cmd.argument() == "listings";
951                                 break;
952                         default:
953                                 break;
954                 }
955                 flag.enabled(enable);
956                 break;
957         }
958
959         case LFUN_DIALOG_SHOW_NEW_INSET:
960                 flag.enabled(cur.inset().lyxCode() != ERT_CODE &&
961                         cur.inset().lyxCode() != LISTINGS_CODE);
962                 if (cur.inset().lyxCode() == CAPTION_CODE) {
963                         FuncStatus flag;
964                         if (cur.inset().getStatus(cur, cmd, flag))
965                                 return flag;
966                 }
967                 break;
968
969         default:
970                 flag.enabled(false);
971         }
972
973         return flag;
974 }
975
976
977 bool BufferView::dispatch(FuncRequest const & cmd)
978 {
979         //lyxerr << [ cmd = " << cmd << "]" << endl;
980
981         // Make sure that the cached BufferView is correct.
982         LYXERR(Debug::ACTION, " action[" << cmd.action << ']'
983                 << " arg[" << to_utf8(cmd.argument()) << ']'
984                 << " x[" << cmd.x << ']'
985                 << " y[" << cmd.y << ']'
986                 << " button[" << cmd.button() << ']');
987
988         Cursor & cur = d->cursor_;
989
990         switch (cmd.action) {
991
992         case LFUN_UNDO:
993                 cur.message(_("Undo"));
994                 cur.clearSelection();
995                 if (!cur.textUndo())
996                         cur.message(_("No further undo information"));
997                 else
998                         processUpdateFlags(Update::Force | Update::FitCursor);
999                 break;
1000
1001         case LFUN_REDO:
1002                 cur.message(_("Redo"));
1003                 cur.clearSelection();
1004                 if (!cur.textRedo())
1005                         cur.message(_("No further redo information"));
1006                 else
1007                         processUpdateFlags(Update::Force | Update::FitCursor);
1008                 break;
1009
1010         case LFUN_FONT_STATE:
1011                 cur.message(cur.currentState());
1012                 break;
1013
1014         case LFUN_BOOKMARK_SAVE:
1015                 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1016                 break;
1017
1018         case LFUN_LABEL_GOTO: {
1019                 docstring label = cmd.argument();
1020                 if (label.empty()) {
1021                         InsetRef * inset =
1022                                 getInsetByCode<InsetRef>(d->cursor_,
1023                                                          REF_CODE);
1024                         if (inset) {
1025                                 label = inset->getParam("reference");
1026                                 // persistent=false: use temp_bookmark
1027                                 saveBookmark(0);
1028                         }
1029                 }
1030
1031                 if (!label.empty())
1032                         gotoLabel(label);
1033                 break;
1034         }
1035
1036         case LFUN_PARAGRAPH_GOTO: {
1037                 int const id = convert<int>(to_utf8(cmd.argument()));
1038                 int i = 0;
1039                 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1040                         b = theBufferList().next(b)) {
1041
1042                         DocIterator dit = b->getParFromID(id);
1043                         if (dit.atEnd()) {
1044                                 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1045                                 ++i;
1046                                 continue;
1047                         }
1048                         LYXERR(Debug::INFO, "Paragraph " << dit.paragraph().id()
1049                                 << " found in buffer `"
1050                                 << b->absFileName() << "'.");
1051
1052                         if (b == &buffer_) {
1053                                 // Set the cursor
1054                                 setCursor(dit);
1055                                 processUpdateFlags(Update::Force | Update::FitCursor);
1056                         } else {
1057                                 // Switch to other buffer view and resend cmd
1058                                 theLyXFunc().dispatch(FuncRequest(
1059                                         LFUN_BUFFER_SWITCH, b->absFileName()));
1060                                 theLyXFunc().dispatch(cmd);
1061                         }
1062                         break;
1063                 }
1064                 break;
1065         }
1066
1067         case LFUN_NOTE_NEXT:
1068                 gotoInset(this, NOTE_CODE, false);
1069                 break;
1070
1071         case LFUN_REFERENCE_NEXT: {
1072                 vector<InsetCode> tmp;
1073                 tmp.push_back(LABEL_CODE);
1074                 tmp.push_back(REF_CODE);
1075                 gotoInset(this, tmp, true);
1076                 break;
1077         }
1078
1079         case LFUN_CHANGES_TRACK:
1080                 buffer_.params().trackChanges = !buffer_.params().trackChanges;
1081                 break;
1082
1083         case LFUN_CHANGES_OUTPUT:
1084                 buffer_.params().outputChanges = !buffer_.params().outputChanges;
1085                 if (buffer_.params().outputChanges) {
1086                         bool dvipost    = LaTeXFeatures::isAvailable("dvipost");
1087                         bool xcolorsoul = LaTeXFeatures::isAvailable("soul") &&
1088                                           LaTeXFeatures::isAvailable("xcolor");
1089
1090                         if (!dvipost && !xcolorsoul) {
1091                                 Alert::warning(_("Changes not shown in LaTeX output"),
1092                                                _("Changes will not be highlighted in LaTeX output, "
1093                                                  "because neither dvipost nor xcolor/soul are installed.\n"
1094                                                  "Please install these packages or redefine "
1095                                                  "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1096                         } else if (!xcolorsoul) {
1097                                 Alert::warning(_("Changes not shown in LaTeX output"),
1098                                                _("Changes will not be highlighted in LaTeX output "
1099                                                  "when using pdflatex, because xcolor and soul are not installed.\n"
1100                                                  "Please install both packages or redefine "
1101                                                  "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1102                         }
1103                 }
1104                 break;
1105
1106         case LFUN_CHANGE_NEXT:
1107                 findNextChange(this);
1108                 break;
1109
1110         case LFUN_CHANGES_MERGE:
1111                 if (findNextChange(this))
1112                         showDialog("changes");
1113                 break;
1114
1115         case LFUN_ALL_CHANGES_ACCEPT:
1116                 // select complete document
1117                 d->cursor_.reset(buffer_.inset());
1118                 d->cursor_.selHandle(true);
1119                 buffer_.text().cursorBottom(d->cursor_);
1120                 // accept everything in a single step to support atomic undo
1121                 buffer_.text().acceptOrRejectChanges(d->cursor_, Text::ACCEPT);
1122                 break;
1123
1124         case LFUN_ALL_CHANGES_REJECT:
1125                 // select complete document
1126                 d->cursor_.reset(buffer_.inset());
1127                 d->cursor_.selHandle(true);
1128                 buffer_.text().cursorBottom(d->cursor_);
1129                 // reject everything in a single step to support atomic undo
1130                 // Note: reject does not work recursively; the user may have to repeat the operation
1131                 buffer_.text().acceptOrRejectChanges(d->cursor_, Text::REJECT);
1132                 break;
1133
1134         case LFUN_WORD_FIND:
1135                 if (find(this, cmd))
1136                         showCursor();
1137                 else
1138                         message(_("String not found!"));
1139                 break;
1140
1141         case LFUN_WORD_REPLACE: {
1142                 bool has_deleted = false;
1143                 if (cur.selection()) {
1144                         DocIterator beg = cur.selectionBegin();
1145                         DocIterator end = cur.selectionEnd();
1146                         if (beg.pit() == end.pit()) {
1147                                 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1148                                         if (cur.paragraph().isDeleted(p))
1149                                                 has_deleted = true;
1150                                 }
1151                         }
1152                 }
1153                 replace(this, cmd, has_deleted);
1154                 break;
1155         }
1156
1157         case LFUN_MARK_OFF:
1158                 cur.clearSelection();
1159                 cur.resetAnchor();
1160                 cur.message(from_utf8(N_("Mark off")));
1161                 break;
1162
1163         case LFUN_MARK_ON:
1164                 cur.clearSelection();
1165                 cur.mark() = true;
1166                 cur.resetAnchor();
1167                 cur.message(from_utf8(N_("Mark on")));
1168                 break;
1169
1170         case LFUN_MARK_TOGGLE:
1171                 cur.clearSelection();
1172                 if (cur.mark()) {
1173                         cur.mark() = false;
1174                         cur.message(from_utf8(N_("Mark removed")));
1175                 } else {
1176                         cur.mark() = true;
1177                         cur.message(from_utf8(N_("Mark set")));
1178                 }
1179                 cur.resetAnchor();
1180                 break;
1181
1182         case LFUN_SCREEN_RECENTER:
1183                 showCursor();
1184                 break;
1185
1186         case LFUN_BIBTEX_DATABASE_ADD: {
1187                 Cursor tmpcur = d->cursor_;
1188                 findInset(tmpcur, BIBTEX_CODE, false);
1189                 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1190                                                 BIBTEX_CODE);
1191                 if (inset) {
1192                         if (inset->addDatabase(to_utf8(cmd.argument())))
1193                                 buffer_.updateBibfilesCache();
1194                 }
1195                 break;
1196         }
1197
1198         case LFUN_BIBTEX_DATABASE_DEL: {
1199                 Cursor tmpcur = d->cursor_;
1200                 findInset(tmpcur, BIBTEX_CODE, false);
1201                 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1202                                                 BIBTEX_CODE);
1203                 if (inset) {
1204                         if (inset->delDatabase(to_utf8(cmd.argument())))
1205                                 buffer_.updateBibfilesCache();
1206                 }
1207                 break;
1208         }
1209
1210         case LFUN_STATISTICS: {
1211                 DocIterator from, to;
1212                 if (cur.selection()) {
1213                         from = cur.selectionBegin();
1214                         to = cur.selectionEnd();
1215                 } else {
1216                         from = doc_iterator_begin(buffer_.inset());
1217                         to = doc_iterator_end(buffer_.inset());
1218                 }
1219                 int const words = countWords(from, to);
1220                 int const chars = countChars(from, to, false);
1221                 int const chars_blanks = countChars(from, to, true);
1222                 docstring message;
1223                 if (cur.selection())
1224                         message = _("Statistics for the selection:");
1225                 else
1226                         message = _("Statistics for the document:");
1227                 message += "\n\n";
1228                 if (words != 1)
1229                         message += bformat(_("%1$d words"), words);
1230                 else
1231                         message += _("One word");
1232                 message += "\n";
1233                 if (chars_blanks != 1)
1234                         message += bformat(_("%1$d characters (including blanks)"),
1235                                           chars_blanks);
1236                 else
1237                         message += _("One character (including blanks)");
1238                 message += "\n";
1239                 if (chars != 1)
1240                         message += bformat(_("%1$d characters (excluding blanks)"),
1241                                           chars);
1242                 else
1243                         message += _("One character (excluding blanks)");
1244
1245                 Alert::information(_("Statistics"), message);
1246         }
1247                 break;
1248
1249         case LFUN_BUFFER_TOGGLE_COMPRESSION:
1250                 // turn compression on/off
1251                 buffer_.params().compressed = !buffer_.params().compressed;
1252                 break;
1253         
1254         case LFUN_BUFFER_TOGGLE_EMBEDDING: {
1255                 // turn embedding on/off
1256                 try {
1257                         buffer_.embeddedFiles().enable(!buffer_.params().embedded, buffer_);
1258                 } catch (ExceptionMessage const & message) {
1259                         Alert::error(message.title_, message.details_);
1260                 }
1261                 break;
1262         }
1263
1264         case LFUN_NEXT_INSET_TOGGLE: {
1265                 // this is the real function we want to invoke
1266                 FuncRequest tmpcmd = FuncRequest(LFUN_INSET_TOGGLE, cmd.origin);
1267                 // if there is an inset at cursor, see whether it
1268                 // wants to toggle.
1269                 Inset * inset = cur.nextInset();
1270                 if (inset) {
1271                         if (inset->isActive()) {
1272                                 Cursor tmpcur = cur;
1273                                 tmpcur.pushBackward(*inset);
1274                                 inset->dispatch(tmpcur, tmpcmd);
1275                                 if (tmpcur.result().dispatched()) {
1276                                         cur.dispatched();
1277                                 }
1278                         } else if (inset->editable() == Inset::IS_EDITABLE) {
1279                                 inset->edit(cur, true);
1280                         }
1281                 }
1282                 // if it did not work, try the underlying inset.
1283                 if (!cur.result().dispatched())
1284                         cur.dispatch(tmpcmd);
1285
1286                 if (!cur.result().dispatched())
1287                         // It did not work too; no action needed.
1288                         break;
1289                 cur.clearSelection();
1290                 processUpdateFlags(Update::SinglePar | Update::FitCursor);
1291                 break;
1292         }
1293
1294         case LFUN_SCREEN_UP:
1295         case LFUN_SCREEN_DOWN: {
1296                 Point p = getPos(cur, cur.boundary());
1297                 if (p.y_ < 0 || p.y_ > height_) {
1298                         // The cursor is off-screen so recenter before proceeding.
1299                         showCursor();
1300                         p = getPos(cur, cur.boundary());
1301                 }
1302                 scroll(cmd.action == LFUN_SCREEN_UP? - height_ : height_);
1303                 cur.reset(buffer_.inset());
1304                 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_);
1305                 //FIXME: what to do with cur.x_target()?
1306                 cur.finishUndo();
1307                 break;
1308         }
1309
1310         case LFUN_SCROLL:
1311                 lfunScroll(cmd);
1312                 break;
1313
1314         case LFUN_SCREEN_UP_SELECT:
1315         case LFUN_SCREEN_DOWN_SELECT: {
1316                 // Those two are not ready yet for consumption.
1317                 return false;
1318
1319                 cur.selHandle(true);
1320                 size_t initial_depth = cur.depth();
1321                 Point const p = getPos(cur, cur.boundary());
1322                 scroll(cmd.action == LFUN_SCREEN_UP_SELECT? - height_ : height_);
1323                 // FIXME: We need to verify if the cursor stayed within an inset...
1324                 //cur.reset(buffer_.inset());
1325                 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_);
1326                 cur.finishUndo();
1327                 while (cur.depth() > initial_depth) {
1328                         cur.forwardInset();
1329                 }
1330                 // FIXME: we need to do a redraw again because of the selection
1331                 // But no screen update is needed.
1332                 d->update_strategy_ = NoScreenUpdate;
1333                 buffer_.changed();
1334                 break;
1335         }
1336
1337         default:
1338                 return false;
1339         }
1340
1341         return true;
1342 }
1343
1344
1345 docstring const BufferView::requestSelection()
1346 {
1347         Cursor & cur = d->cursor_;
1348
1349         if (!cur.selection()) {
1350                 d->xsel_cache_.set = false;
1351                 return docstring();
1352         }
1353
1354         if (!d->xsel_cache_.set ||
1355             cur.top() != d->xsel_cache_.cursor ||
1356             cur.anchor_.top() != d->xsel_cache_.anchor)
1357         {
1358                 d->xsel_cache_.cursor = cur.top();
1359                 d->xsel_cache_.anchor = cur.anchor_.top();
1360                 d->xsel_cache_.set = cur.selection();
1361                 return cur.selectionAsString(false);
1362         }
1363         return docstring();
1364 }
1365
1366
1367 void BufferView::clearSelection()
1368 {
1369         d->cursor_.clearSelection();
1370         // Clear the selection buffer. Otherwise a subsequent
1371         // middle-mouse-button paste would use the selection buffer,
1372         // not the more current external selection.
1373         cap::clearSelection();
1374         d->xsel_cache_.set = false;
1375         // The buffer did not really change, but this causes the
1376         // redraw we need because we cleared the selection above.
1377         buffer_.changed();
1378 }
1379
1380
1381 void BufferView::resize(int width, int height)
1382 {
1383         // Update from work area
1384         width_ = width;
1385         height_ = height;
1386
1387         // Clear the paragraph height cache.
1388         d->par_height_.clear();
1389         // Redo the metrics.
1390         updateMetrics();
1391 }
1392
1393
1394 Inset const * BufferView::getCoveringInset(Text const & text,
1395                 int x, int y) const
1396 {
1397         TextMetrics & tm = d->text_metrics_[&text];
1398         Inset * inset = tm.checkInsetHit(x, y);
1399         if (!inset)
1400                 return 0;
1401
1402         if (!inset->descendable())
1403                 // No need to go further down if the inset is not
1404                 // descendable.
1405                 return inset;
1406
1407         size_t cell_number = inset->nargs();
1408         // Check all the inner cell.
1409         for (size_t i = 0; i != cell_number; ++i) {
1410                 Text const * inner_text = inset->getText(i);
1411                 if (inner_text) {
1412                         // Try deeper.
1413                         Inset const * inset_deeper =
1414                                 getCoveringInset(*inner_text, x, y);
1415                         if (inset_deeper)
1416                                 return inset_deeper;
1417                 }
1418         }
1419
1420         return inset;
1421 }
1422
1423
1424 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
1425 {
1426         //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
1427
1428         // This is only called for mouse related events including
1429         // LFUN_FILE_OPEN generated by drag-and-drop.
1430         FuncRequest cmd = cmd0;
1431
1432         Cursor old = cursor();
1433         Cursor cur(*this);
1434         cur.push(buffer_.inset());
1435         cur.selection() = d->cursor_.selection();
1436
1437         // Either the inset under the cursor or the
1438         // surrounding Text will handle this event.
1439
1440         // make sure we stay within the screen...
1441         cmd.y = min(max(cmd.y, -1), height_);
1442
1443         if (cmd.action == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
1444
1445                 // Get inset under mouse, if there is one.
1446                 Inset const * covering_inset =
1447                         getCoveringInset(buffer_.text(), cmd.x, cmd.y);
1448                 if (covering_inset == d->last_inset_)
1449                         // Same inset, no need to do anything...
1450                         return;
1451
1452                 bool need_redraw = false;
1453                 // const_cast because of setMouseHover().
1454                 Inset * inset = const_cast<Inset *>(covering_inset);
1455                 if (d->last_inset_)
1456                         // Remove the hint on the last hovered inset (if any).
1457                         need_redraw |= d->last_inset_->setMouseHover(false);
1458                 if (inset)
1459                         // Highlighted the newly hovered inset (if any).
1460                         need_redraw |= inset->setMouseHover(true);
1461                 d->last_inset_ = inset;
1462                 if (!need_redraw)
1463                         return;
1464
1465                 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
1466                         << cmd.x << ", " << cmd.y << ")");
1467
1468                 d->update_strategy_ = DecorationUpdate;
1469
1470                 // This event (moving without mouse click) is not passed further.
1471                 // This should be changed if it is further utilized.
1472                 buffer_.changed();
1473                 return;
1474         }
1475
1476         // Build temporary cursor.
1477         Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x, cmd.y);
1478
1479         // Put anchor at the same position.
1480         cur.resetAnchor();
1481
1482         // Try to dispatch to an non-editable inset near this position
1483         // via the temp cursor. If the inset wishes to change the real
1484         // cursor it has to do so explicitly by using
1485         //  cur.bv().cursor() = cur;  (or similar)
1486         if (inset)
1487                 inset->dispatch(cur, cmd);
1488
1489         // Now dispatch to the temporary cursor. If the real cursor should
1490         // be modified, the inset's dispatch has to do so explicitly.
1491         if (!cur.result().dispatched())
1492                 cur.dispatch(cmd);
1493
1494         // Notify left insets
1495         if (cur != old) {
1496                 old.fixIfBroken();
1497                 bool badcursor = notifyCursorLeaves(old, cur);
1498                 if (badcursor)
1499                         cursor().fixIfBroken();
1500         }
1501         
1502         // Do we have a selection?
1503         theSelection().haveSelection(cursor().selection());
1504
1505         // If the command has been dispatched,
1506         if (cur.result().dispatched() || cur.result().update())
1507                 processUpdateFlags(cur.result().update());
1508 }
1509
1510
1511 void BufferView::lfunScroll(FuncRequest const & cmd)
1512 {
1513         string const scroll_type = cmd.getArg(0);
1514         int const scroll_step = 
1515                 (scroll_type == "line")? d->scrollbarParameters_.single_step
1516                 : (scroll_type == "page")? d->scrollbarParameters_.page_step : 0;
1517         if (scroll_step == 0)
1518                 return;
1519         string const scroll_quantity = cmd.getArg(1);
1520         if (scroll_quantity == "up")
1521                 scrollUp(scroll_step);
1522         else if (scroll_quantity == "down")
1523                 scrollDown(scroll_step);
1524         else {
1525                 int const scroll_value = convert<int>(scroll_quantity);
1526                 if (scroll_value)
1527                         scroll(scroll_step * scroll_value);
1528         }
1529 }
1530
1531
1532 void BufferView::scroll(int y)
1533 {
1534         if (y > 0)
1535                 scrollDown(y);
1536         else if (y < 0)
1537                 scrollUp(-y);
1538 }
1539
1540
1541 void BufferView::scrollDown(int offset)
1542 {
1543         Text * text = &buffer_.text();
1544         TextMetrics & tm = d->text_metrics_[text];
1545         int ymax = height_ + offset;
1546         while (true) {
1547                 pair<pit_type, ParagraphMetrics const *> last = tm.last();
1548                 int bottom_pos = last.second->position() + last.second->descent();
1549                 if (last.first + 1 == int(text->paragraphs().size())) {
1550                         if (bottom_pos <= height_)
1551                                 return;
1552                         offset = min(offset, bottom_pos - height_);
1553                         break;
1554                 }
1555                 if (bottom_pos > ymax)
1556                         break;
1557                 tm.newParMetricsDown();
1558         }
1559         d->anchor_ypos_ -= offset;
1560         updateMetrics();
1561         buffer_.changed();
1562 }
1563
1564
1565 void BufferView::scrollUp(int offset)
1566 {
1567         Text * text = &buffer_.text();
1568         TextMetrics & tm = d->text_metrics_[text];
1569         int ymin = - offset;
1570         while (true) {
1571                 pair<pit_type, ParagraphMetrics const *> first = tm.first();
1572                 int top_pos = first.second->position() - first.second->ascent();
1573                 if (first.first == 0) {
1574                         if (top_pos >= 0)
1575                                 return;
1576                         offset = min(offset, - top_pos);
1577                         break;
1578                 }
1579                 if (top_pos < ymin)
1580                         break;
1581                 tm.newParMetricsUp();
1582         }
1583         d->anchor_ypos_ += offset;
1584         updateMetrics();
1585         buffer_.changed();
1586 }
1587
1588
1589 void BufferView::setCursorFromRow(int row)
1590 {
1591         int tmpid = -1;
1592         int tmppos = -1;
1593
1594         buffer_.texrow().getIdFromRow(row, tmpid, tmppos);
1595
1596         d->cursor_.reset(buffer_.inset());
1597         if (tmpid == -1)
1598                 buffer_.text().setCursor(d->cursor_, 0, 0);
1599         else
1600                 buffer_.text().setCursor(d->cursor_, buffer_.getParFromID(tmpid).pit(), tmppos);
1601 }
1602
1603
1604 void BufferView::gotoLabel(docstring const & label)
1605 {
1606         for (InsetIterator it = inset_iterator_begin(buffer_.inset()); it; ++it) {
1607                 vector<docstring> labels;
1608                 it->getLabelList(labels);
1609                 if (std::find(labels.begin(), labels.end(), label) != labels.end()) {
1610                         setCursor(it);
1611                         showCursor();
1612                         return;
1613                 }
1614         }
1615 }
1616
1617
1618 TextMetrics const & BufferView::textMetrics(Text const * t) const
1619 {
1620         return const_cast<BufferView *>(this)->textMetrics(t);
1621 }
1622
1623
1624 TextMetrics & BufferView::textMetrics(Text const * t)
1625 {
1626         TextMetricsCache::iterator tmc_it  = d->text_metrics_.find(t);
1627         if (tmc_it == d->text_metrics_.end()) {
1628                 tmc_it = d->text_metrics_.insert(
1629                         make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
1630         }
1631         return tmc_it->second;
1632 }
1633
1634
1635 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
1636                 pit_type pit) const
1637 {
1638         return textMetrics(t).parMetrics(pit);
1639 }
1640
1641
1642 int BufferView::workHeight() const
1643 {
1644         return height_;
1645 }
1646
1647
1648 void BufferView::setCursor(DocIterator const & dit)
1649 {
1650         size_t const n = dit.depth();
1651         for (size_t i = 0; i < n; ++i)
1652                 dit[i].inset().edit(d->cursor_, true);
1653
1654         d->cursor_.setCursor(dit);
1655         d->cursor_.selection() = false;
1656 }
1657
1658
1659 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
1660 {
1661         // Would be wrong to delete anything if we have a selection.
1662         if (cur.selection())
1663                 return false;
1664
1665         bool need_anchor_change = false;
1666         bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
1667                 need_anchor_change);
1668
1669         if (need_anchor_change)
1670                 cur.resetAnchor();
1671
1672         if (!changed)
1673                 return false;
1674
1675         d->cursor_ = cur;
1676
1677         updateLabels(buffer_);
1678
1679         updateMetrics();
1680         buffer_.changed();
1681         return true;
1682 }
1683
1684
1685 bool BufferView::mouseSetCursor(Cursor & cur, bool select)
1686 {
1687         BOOST_ASSERT(&cur.bv() == this);
1688
1689         if (!select)
1690                 // this event will clear selection so we save selection for
1691                 // persistent selection
1692                 cap::saveSelection(cursor());
1693
1694         // Has the cursor just left the inset?
1695         bool badcursor = false;
1696         bool leftinset = (&d->cursor_.inset() != &cur.inset());
1697         if (leftinset) {
1698                 d->cursor_.fixIfBroken();
1699                 badcursor = notifyCursorLeaves(d->cursor_, cur);
1700                 if (badcursor)
1701                         cur.fixIfBroken();
1702         }
1703
1704         // FIXME: shift-mouse selection doesn't work well across insets.
1705         bool do_selection = select && &d->cursor_.anchor().inset() == &cur.inset();
1706
1707         // do the dEPM magic if needed
1708         // FIXME: (1) move this to InsetText::notifyCursorLeaves?
1709         // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
1710         // the leftinset bool would not be necessary (badcursor instead).
1711         bool update = leftinset;
1712         if (!do_selection && !badcursor && d->cursor_.inTexted())
1713                 update |= checkDepm(cur, d->cursor_);
1714
1715         d->cursor_.setCursor(cur);
1716         d->cursor_.boundary(cur.boundary());
1717         if (do_selection)
1718                 d->cursor_.setSelection();
1719         else
1720                 d->cursor_.clearSelection();
1721
1722         d->cursor_.finishUndo();
1723         d->cursor_.setCurrentFont();
1724         return update;
1725 }
1726
1727
1728 void BufferView::putSelectionAt(DocIterator const & cur,
1729                                 int length, bool backwards)
1730 {
1731         d->cursor_.clearSelection();
1732
1733         setCursor(cur);
1734
1735         if (length) {
1736                 if (backwards) {
1737                         d->cursor_.pos() += length;
1738                         d->cursor_.setSelection(d->cursor_, -length);
1739                 } else
1740                         d->cursor_.setSelection(d->cursor_, length);
1741         }
1742         // Ensure a redraw happens in any case because the new selection could 
1743         // possibly be on the same screen as the previous selection.
1744         processUpdateFlags(Update::Force | Update::FitCursor);
1745 }
1746
1747
1748 Cursor & BufferView::cursor()
1749 {
1750         return d->cursor_;
1751 }
1752
1753
1754 Cursor const & BufferView::cursor() const
1755 {
1756         return d->cursor_;
1757 }
1758
1759
1760 pit_type BufferView::anchor_ref() const
1761 {
1762         return d->anchor_pit_;
1763 }
1764
1765
1766 bool BufferView::singleParUpdate()
1767 {
1768         Text & buftext = buffer_.text();
1769         pit_type const bottom_pit = d->cursor_.bottom().pit();
1770         TextMetrics & tm = textMetrics(&buftext);
1771         int old_height = tm.parMetrics(bottom_pit).height();
1772
1773         // make sure inline completion pointer is ok
1774         if (d->inlineCompletionPos.fixIfBroken())
1775                 d->inlineCompletionPos = DocIterator();
1776
1777         // In Single Paragraph mode, rebreak only
1778         // the (main text, not inset!) paragraph containing the cursor.
1779         // (if this paragraph contains insets etc., rebreaking will
1780         // recursively descend)
1781         tm.redoParagraph(bottom_pit);
1782         ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);                
1783         if (pm.height() != old_height)
1784                 // Paragraph height has changed so we cannot proceed to
1785                 // the singlePar optimisation.
1786                 return false;
1787
1788         d->update_strategy_ = SingleParUpdate;
1789
1790         LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
1791                 << " y2: " << pm.position() + pm.descent()
1792                 << " pit: " << bottom_pit
1793                 << " singlepar: 1");
1794         return true;
1795 }
1796
1797
1798 void BufferView::updateMetrics()
1799 {
1800         Text & buftext = buffer_.text();
1801         pit_type const npit = int(buftext.paragraphs().size());
1802
1803         // Clear out the position cache in case of full screen redraw,
1804         d->coord_cache_.clear();
1805
1806         // Clear out paragraph metrics to avoid having invalid metrics
1807         // in the cache from paragraphs not relayouted below
1808         // The complete text metrics will be redone.
1809         d->text_metrics_.clear();
1810
1811         TextMetrics & tm = textMetrics(&buftext);
1812
1813         // make sure inline completion pointer is ok
1814         if (d->inlineCompletionPos.fixIfBroken())
1815                 d->inlineCompletionPos = DocIterator();
1816         
1817         if (d->anchor_pit_ >= npit)
1818                 // The anchor pit must have been deleted...
1819                 d->anchor_pit_ = npit - 1;
1820
1821         // Rebreak anchor paragraph.
1822         tm.redoParagraph(d->anchor_pit_);
1823         ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
1824         
1825         // position anchor
1826         if (d->anchor_pit_ == 0) {
1827                 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
1828                 
1829                 // Complete buffer visible? Then it's easy.
1830                 if (scrollRange == 0)
1831                         d->anchor_ypos_ = anchor_pm.ascent();
1832         
1833                 // FIXME: Some clever handling needed to show
1834                 // the _first_ paragraph up to the top if the cursor is
1835                 // in the first line.
1836         }               
1837         anchor_pm.setPosition(d->anchor_ypos_);
1838
1839         LYXERR(Debug::PAINTING, "metrics: "
1840                 << " anchor pit = " << d->anchor_pit_
1841                 << " anchor ypos = " << d->anchor_ypos_);
1842
1843         // Redo paragraphs above anchor if necessary.
1844         int y1 = d->anchor_ypos_ - anchor_pm.ascent();
1845         // We are now just above the anchor paragraph.
1846         pit_type pit1 = d->anchor_pit_ - 1;
1847         for (; pit1 >= 0 && y1 >= 0; --pit1) {
1848                 tm.redoParagraph(pit1);
1849                 ParagraphMetrics & pm = tm.par_metrics_[pit1];
1850                 y1 -= pm.descent();
1851                 // Save the paragraph position in the cache.
1852                 pm.setPosition(y1);
1853                 y1 -= pm.ascent();
1854         }
1855
1856         // Redo paragraphs below the anchor if necessary.
1857         int y2 = d->anchor_ypos_ + anchor_pm.descent();
1858         // We are now just below the anchor paragraph.
1859         pit_type pit2 = d->anchor_pit_ + 1;
1860         for (; pit2 < npit && y2 <= height_; ++pit2) {
1861                 tm.redoParagraph(pit2);
1862                 ParagraphMetrics & pm = tm.par_metrics_[pit2];
1863                 y2 += pm.ascent();
1864                 // Save the paragraph position in the cache.
1865                 pm.setPosition(y2);
1866                 y2 += pm.descent();
1867         }
1868
1869         LYXERR(Debug::PAINTING, "Metrics: "
1870                 << " anchor pit = " << d->anchor_pit_
1871                 << " anchor ypos = " << d->anchor_ypos_
1872                 << " y1 = " << y1
1873                 << " y2 = " << y2
1874                 << " pit1 = " << pit1
1875                 << " pit2 = " << pit2);
1876
1877         d->update_strategy_ = FullScreenUpdate;
1878
1879         if (lyxerr.debugging(Debug::WORKAREA)) {
1880                 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
1881                 d->coord_cache_.dump();
1882         }
1883 }
1884
1885
1886 void BufferView::insertLyXFile(FileName const & fname)
1887 {
1888         BOOST_ASSERT(d->cursor_.inTexted());
1889
1890         // Get absolute path of file and add ".lyx"
1891         // to the filename if necessary
1892         FileName filename = fileSearch(string(), fname.absFilename(), "lyx");
1893
1894         docstring const disp_fn = makeDisplayPath(filename.absFilename());
1895         // emit message signal.
1896         message(bformat(_("Inserting document %1$s..."), disp_fn));
1897
1898         docstring res;
1899         Buffer buf("", false);
1900         if (buf.loadLyXFile(filename)) {
1901                 ErrorList & el = buffer_.errorList("Parse");
1902                 // Copy the inserted document error list into the current buffer one.
1903                 el = buf.errorList("Parse");
1904                 buffer_.undo().recordUndo(d->cursor_);
1905                 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
1906                                              buf.params().documentClassPtr(), el);
1907                 res = _("Document %1$s inserted.");
1908         } else {
1909                 res = _("Could not insert document %1$s");
1910         }
1911
1912         updateMetrics();
1913         buffer_.changed();
1914         // emit message signal.
1915         message(bformat(res, disp_fn));
1916         buffer_.errors("Parse");
1917 }
1918
1919
1920 Point BufferView::coordOffset(DocIterator const & dit, bool boundary) const
1921 {
1922         int x = 0;
1923         int y = 0;
1924         int lastw = 0;
1925
1926         // Addup contribution of nested insets, from inside to outside,
1927         // keeping the outer paragraph for a special handling below
1928         for (size_t i = dit.depth() - 1; i >= 1; --i) {
1929                 CursorSlice const & sl = dit[i];
1930                 int xx = 0;
1931                 int yy = 0;
1932                 
1933                 // get relative position inside sl.inset()
1934                 sl.inset().cursorPos(*this, sl, boundary && (i + 1 == dit.depth()), xx, yy);
1935                 
1936                 // Make relative position inside of the edited inset relative to sl.inset()
1937                 x += xx;
1938                 y += yy;
1939                 
1940                 // In case of an RTL inset, the edited inset will be positioned to the left
1941                 // of xx:yy
1942                 if (sl.text()) {
1943                         bool boundary_i = boundary && i + 1 == dit.depth();
1944                         bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
1945                         if (rtl)
1946                                 x -= lastw;
1947                 }
1948
1949                 // remember width for the case that sl.inset() is positioned in an RTL inset
1950                 if (i && dit[i - 1].text()) {
1951                         // If this Inset is inside a Text Inset, retrieve the Dimension
1952                         // from the containing text instead of using Inset::dimension() which
1953                         // might not be implemented.
1954                         // FIXME (Abdel 23/09/2007): this is a bit messy because of the
1955                         // elimination of Inset::dim_ cache. This coordOffset() method needs
1956                         // to be rewritten in light of the new design.
1957                         Dimension const & dim = parMetrics(dit[i - 1].text(),
1958                                 dit[i - 1].pit()).insetDimension(&sl.inset());
1959                         lastw = dim.wid;
1960                 } else {
1961                         Dimension const dim = sl.inset().dimension(*this);
1962                         lastw = dim.wid;
1963                 }
1964                 
1965                 //lyxerr << "Cursor::getPos, i: "
1966                 // << i << " x: " << xx << " y: " << y << endl;
1967         }
1968
1969         // Add contribution of initial rows of outermost paragraph
1970         CursorSlice const & sl = dit[0];
1971         TextMetrics const & tm = textMetrics(sl.text());
1972         ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
1973         BOOST_ASSERT(!pm.rows().empty());
1974         y -= pm.rows()[0].ascent();
1975 #if 1
1976         // FIXME: document this mess
1977         size_t rend;
1978         if (sl.pos() > 0 && dit.depth() == 1) {
1979                 int pos = sl.pos();
1980                 if (pos && boundary)
1981                         --pos;
1982 //              lyxerr << "coordOffset: boundary:" << boundary << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
1983                 rend = pm.pos2row(pos);
1984         } else
1985                 rend = pm.pos2row(sl.pos());
1986 #else
1987         size_t rend = pm.pos2row(sl.pos());
1988 #endif
1989         for (size_t rit = 0; rit != rend; ++rit)
1990                 y += pm.rows()[rit].height();
1991         y += pm.rows()[rend].ascent();
1992         
1993         TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
1994         
1995         // Make relative position from the nested inset now bufferview absolute.
1996         int xx = bottom_tm.cursorX(dit.bottom(), boundary && dit.depth() == 1);
1997         x += xx;
1998         
1999         // In the RTL case place the nested inset at the left of the cursor in 
2000         // the outer paragraph
2001         bool boundary_1 = boundary && 1 == dit.depth();
2002         bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
2003         if (rtl)
2004                 x -= lastw;
2005         
2006         return Point(x, y);
2007 }
2008
2009
2010 Point BufferView::getPos(DocIterator const & dit, bool boundary) const
2011 {
2012         CursorSlice const & bot = dit.bottom();
2013         TextMetrics const & tm = textMetrics(bot.text());
2014         if (!tm.contains(bot.pit()))
2015                 return Point(-1, -1);
2016
2017         Point p = coordOffset(dit, boundary); // offset from outer paragraph
2018         p.y_ += tm.parMetrics(bot.pit()).position();
2019         return p;
2020 }
2021
2022
2023 void BufferView::draw(frontend::Painter & pain)
2024 {
2025         LYXERR(Debug::PAINTING, "\t\t*** START DRAWING ***");
2026         Text & text = buffer_.text();
2027         TextMetrics const & tm = d->text_metrics_[&text];
2028         int const y = tm.first().second->position();
2029         PainterInfo pi(this, pain);
2030
2031         switch (d->update_strategy_) {
2032
2033         case NoScreenUpdate:
2034                 // If no screen painting is actually needed, only some the different
2035                 // coordinates of insets and paragraphs needs to be updated.
2036                 pi.full_repaint = true;
2037                 pi.pain.setDrawingEnabled(false);
2038                 tm.draw(pi, 0, y);
2039                 break;
2040
2041         case SingleParUpdate:
2042                 pi.full_repaint = false;
2043                 // In general, only the current row of the outermost paragraph
2044                 // will be redrawn. Particular cases where selection spans
2045                 // multiple paragraph are correctly detected in TextMetrics.
2046                 tm.draw(pi, 0, y);
2047                 break;
2048
2049         case DecorationUpdate:
2050                 // FIXME: We should also distinguish DecorationUpdate to avoid text
2051                 // drawing if possible. This is not possible to do easily right now
2052                 // because of the single backing pixmap.
2053
2054         case FullScreenUpdate:
2055                 // The whole screen, including insets, will be refreshed.
2056                 pi.full_repaint = true;
2057
2058                 // Clear background.
2059                 pain.fillRectangle(0, 0, width_, height_,
2060                         buffer_.inset().backgroundColor());
2061
2062                 // Draw everything.
2063                 tm.draw(pi, 0, y);
2064
2065                 // and possibly grey out below
2066                 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2067                 int const y2 = lastpm.second->position() + lastpm.second->descent();
2068                 if (y2 < height_)
2069                         pain.fillRectangle(0, y2, width_, height_ - y2, Color_bottomarea);
2070                 break;
2071         }
2072         LYXERR(Debug::PAINTING, "\n\t\t*** END DRAWING  ***");
2073
2074         // The scrollbar needs an update.
2075         updateScrollbar();
2076
2077         // Normalize anchor for next time
2078         pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
2079         pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
2080         for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
2081                 ParagraphMetrics const & pm = tm.parMetrics(pit);
2082                 if (pm.position() + pm.descent() > 0) {
2083                         d->anchor_pit_ = pit;
2084                         d->anchor_ypos_ = pm.position();
2085                         break;
2086                 }
2087         }
2088         LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
2089                 << "  anchor ypos = " << d->anchor_ypos_);
2090 }
2091
2092
2093 void BufferView::message(docstring const & msg)
2094 {
2095         if (d->gui_)
2096                 d->gui_->message(msg);
2097 }
2098
2099
2100 void BufferView::showDialog(string const & name)
2101 {
2102         if (d->gui_)
2103                 d->gui_->showDialog(name, string());
2104 }
2105
2106
2107 void BufferView::showDialog(string const & name,
2108         string const & data, Inset * inset)
2109 {
2110         if (d->gui_)
2111                 d->gui_->showDialog(name, data, inset);
2112 }
2113
2114
2115 void BufferView::updateDialog(string const & name, string const & data)
2116 {
2117         if (d->gui_)
2118                 d->gui_->updateDialog(name, data);
2119 }
2120
2121
2122 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
2123 {
2124         d->gui_ = gui;
2125 }
2126
2127
2128 // FIXME: Move this out of BufferView again
2129 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
2130 {
2131         if (!fname.isReadableFile()) {
2132                 docstring const error = from_ascii(strerror(errno));
2133                 docstring const file = makeDisplayPath(fname.absFilename(), 50);
2134                 docstring const text =
2135                   bformat(_("Could not read the specified document\n"
2136                             "%1$s\ndue to the error: %2$s"), file, error);
2137                 Alert::error(_("Could not read file"), text);
2138                 return docstring();
2139         }
2140
2141         if (!fname.isReadableFile()) {
2142                 docstring const file = makeDisplayPath(fname.absFilename(), 50);
2143                 docstring const text =
2144                   bformat(_("%1$s\n is not readable."), file);
2145                 Alert::error(_("Could not open file"), text);
2146                 return docstring();
2147         }
2148
2149         // FIXME UNICODE: We don't know the encoding of the file
2150         docstring file_content = fname.fileContents("UTF-8");
2151         if (file_content.empty()) {
2152                 Alert::error(_("Reading not UTF-8 encoded file"),
2153                              _("The file is not UTF-8 encoded.\n"
2154                                "It will be read as local 8Bit-encoded.\n"
2155                                "If this does not give the correct result\n"
2156                                "then please change the encoding of the file\n"
2157                                "to UTF-8 with a program other than LyX.\n"));
2158                 file_content = fname.fileContents("local8bit");
2159         }
2160
2161         return normalize_c(file_content);
2162 }
2163
2164
2165 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
2166 {
2167         docstring const tmpstr = contentsOfPlaintextFile(f);
2168
2169         if (tmpstr.empty())
2170                 return;
2171
2172         Cursor & cur = cursor();
2173         cap::replaceSelection(cur);
2174         buffer_.undo().recordUndo(cur);
2175         if (asParagraph)
2176                 cur.innerText()->insertStringAsParagraphs(cur, tmpstr);
2177         else
2178                 cur.innerText()->insertStringAsLines(cur, tmpstr);
2179
2180         updateMetrics();
2181         buffer_.changed();
2182 }
2183
2184
2185 docstring const & BufferView::inlineCompletion() const
2186 {
2187         return d->inlineCompletion;
2188 }
2189
2190
2191 size_t const & BufferView::inlineCompletionUniqueChars() const
2192 {
2193         return d->inlineCompletionUniqueChars;
2194 }
2195
2196
2197 DocIterator const & BufferView::inlineCompletionPos() const
2198 {
2199         return d->inlineCompletionPos;
2200 }
2201
2202
2203 bool samePar(DocIterator const & a, DocIterator const & b)
2204 {
2205         if (a.empty() && b.empty())
2206                 return true;
2207         if (a.empty() || b.empty())
2208                 return false;
2209         return &a.innerParagraph() == &b.innerParagraph();
2210 }
2211
2212
2213 void BufferView::setInlineCompletion(Cursor & cur, DocIterator const & pos, 
2214         docstring const & completion, size_t uniqueChars)
2215 {
2216         uniqueChars = min(completion.size(), uniqueChars);
2217         bool changed = d->inlineCompletion != completion
2218                 || d->inlineCompletionUniqueChars != uniqueChars;
2219         bool singlePar = true;
2220         d->inlineCompletion = completion;
2221         d->inlineCompletionUniqueChars = min(completion.size(), uniqueChars);
2222         
2223         //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
2224         
2225         // at new position?
2226         DocIterator const & old = d->inlineCompletionPos;
2227         if (old != pos) {
2228                 //lyxerr << "inlineCompletionPos changed" << std::endl;
2229                 // old or pos are in another paragraph?
2230                 if ((!samePar(cur, pos) && !pos.empty())
2231                     || (!samePar(cur, old) && !old.empty())) {
2232                         singlePar = false;
2233                         //lyxerr << "different paragraph" << std::endl;
2234                 }
2235                 d->inlineCompletionPos = pos;
2236         }
2237         
2238         // set update flags
2239         if (changed) {
2240                 if (singlePar && !(cur.disp_.update() & Update::Force))
2241                         cur.updateFlags(cur.disp_.update() | Update::SinglePar);
2242                 else
2243                         cur.updateFlags(cur.disp_.update() | Update::Force);
2244         }
2245 }
2246
2247 } // namespace lyx