]> git.lyx.org Git - lyx.git/blob - src/frontends/qt4/GuiCompleter.cpp
* set the column with in the popup before showing it. Then it even works.
[lyx.git] / src / frontends / qt4 / GuiCompleter.cpp
1 /**
2  * \file GuiCompleter.cpp
3  * This file is part of LyX, the document processor.
4  * Licence details can be found in the file COPYING.
5  *
6  * \author Stefan Schimanski
7  *
8  * Full author contact details are available in file CREDITS.
9  */
10
11 #include <config.h>
12
13 #include "GuiWorkArea.h"
14
15 #include "Buffer.h"
16 #include "BufferView.h"
17 #include "Cursor.h"
18 #include "Dimension.h"
19 #include "FuncRequest.h"
20 #include "GuiView.h"
21 #include "LyXFunc.h"
22 #include "LyXRC.h"
23 #include "Paragraph.h"
24 #include "version.h"
25
26 #include "support/debug.h"
27
28 #include <QApplication>
29 #include <QAbstractListModel>
30 #include <QHeaderView>
31 #include <QPainter>
32 #include <QPixmapCache>
33 #include <QScrollBar>
34 #include <QItemDelegate>
35 #include <QTreeView>
36 #include <QTimer>
37
38 using namespace std;
39 using namespace lyx::support;
40
41 namespace lyx {
42 namespace frontend {
43
44 class RtlItemDelegate : public QItemDelegate {
45 public:
46         explicit RtlItemDelegate(QObject * parent = 0)
47                 : QItemDelegate(parent) {}
48
49 protected:
50         virtual void drawDisplay(QPainter * painter,
51                 QStyleOptionViewItem const & option,
52                 QRect const & rect, QString const & text) const
53         {
54                 // FIXME: do this more elegantly
55                 docstring stltext = qstring_to_ucs4(text);
56                 reverse(stltext.begin(), stltext.end());
57                 QItemDelegate::drawDisplay(painter, option, rect, toqstr(stltext));
58         }
59 };
60
61
62 class PixmapItemDelegate : public QItemDelegate {
63 public:
64         explicit PixmapItemDelegate(QObject *parent = 0)
65         : QItemDelegate(parent) {}
66
67 protected:
68         void paint(QPainter *painter, const QStyleOptionViewItem &option,
69                    const QModelIndex &index) const
70         {
71                 QStyleOptionViewItem opt = setOptions(index, option);
72                 QVariant value = index.data(Qt::DisplayRole);
73                 QPixmap pixmap = qvariant_cast<QPixmap>(value);
74                 
75                 // draw
76                 painter->save();
77                 drawBackground(painter, opt, index);
78                 if (!pixmap.isNull()) {
79                         const QSize size = pixmap.size();
80                         painter->drawPixmap(option.rect.left() + (16 - size.width()) / 2,
81                                 option.rect.top() + (option.rect.height() - size.height()) / 2,
82                                 pixmap);
83                 }
84                 drawFocus(painter, opt, option.rect);
85                 painter->restore();
86         }
87 };
88
89
90 class GuiCompletionModel : public QAbstractListModel {
91 public:
92         ///
93         GuiCompletionModel(QObject * parent,
94                 Inset::CompletionList const * l)
95                 : QAbstractListModel(parent), list_(l) {}
96         ///
97         ~GuiCompletionModel()
98                 { delete list_; }
99         ///
100         bool sorted() const
101         {
102                 if (list_)
103                         return list_->sorted();
104                 else
105                         return false;
106         }
107         ///
108         int columnCount(const QModelIndex & /*parent*/ = QModelIndex()) const
109         {
110                 return 2;
111         }
112         ///
113         int rowCount(const QModelIndex & /*parent*/ = QModelIndex()) const
114         {
115                 if (list_ == 0)
116                         return 0;
117                 else
118                         return list_->size();
119         }
120
121         ///
122         QVariant data(const QModelIndex & index, int role) const
123         {
124                 if (list_ == 0)
125                         return QVariant();
126
127                 if (index.row() < 0 || index.row() >= rowCount())
128                         return QVariant();
129
130                 if (role != Qt::DisplayRole && role != Qt::EditRole)
131                     return QVariant();
132                     
133                 if (index.column() == 0)
134                         return toqstr(list_->data(index.row()));
135                 else if (index.column() == 1) {
136                         // get icon from cache
137                         QPixmap scaled;
138                         QString const name = ":" + toqstr(list_->icon(index.row()));
139                         if (!QPixmapCache::find("completion" + name, scaled)) {
140                                 // load icon from disk
141                                 QPixmap p = QPixmap(name);
142                                 if (!p.isNull()) {
143                                         // scale it to 16x16 or smaller
144                                         scaled = p.scaled(min(16, p.width()), min(16, p.height()), 
145                                                 Qt::KeepAspectRatio, Qt::SmoothTransformation);
146                                 }
147
148                                 QPixmapCache::insert("completion" + name, scaled);
149                         }
150                         return scaled;
151                 }
152                 return QVariant();
153         }
154
155 private:
156         ///
157         Inset::CompletionList const * list_;
158 };
159
160
161 GuiCompleter::GuiCompleter(GuiWorkArea * gui, QObject * parent)
162         : QCompleter(parent), gui_(gui), updateLock_(0),
163           inlineVisible_(false)
164 {
165         // Setup the completion popup
166         setModel(new GuiCompletionModel(this, 0));
167         setCompletionMode(QCompleter::PopupCompletion);
168         setWidget(gui_);
169         
170         // create the popup
171         QTreeView *listView = new QTreeView;
172         listView->setEditTriggers(QAbstractItemView::NoEditTriggers);
173         listView->setHorizontalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
174         listView->setSelectionBehavior(QAbstractItemView::SelectRows);
175         listView->setSelectionMode(QAbstractItemView::SingleSelection);
176         listView->header()->hide();
177         listView->setIndentation(0);
178         listView->setUniformRowHeights(true);
179         setPopup(listView);
180         popup()->setItemDelegateForColumn(1, new PixmapItemDelegate(this));
181         rtlItemDelegate_ = new RtlItemDelegate(this);
182         
183         // create timeout timers
184         popup_timer_.setSingleShot(true);
185         inline_timer_.setSingleShot(true);
186         connect(this, SIGNAL(highlighted(const QString &)),
187                 this, SLOT(popupHighlighted(const QString &)));
188         connect(this, SIGNAL(activated(const QString &)),
189                 this, SLOT(popupActivated(const QString &)));
190         connect(&popup_timer_, SIGNAL(timeout()),
191                 this, SLOT(showPopup()));
192         connect(&inline_timer_, SIGNAL(timeout()),
193                 this, SLOT(showInline()));
194 }
195
196
197 GuiCompleter::~GuiCompleter()
198 {
199         popup()->hide();
200 }
201
202
203 bool GuiCompleter::eventFilter(QObject * watched, QEvent * e)
204 {
205         // hijack back the tab key from the popup
206         // (which stole it from the workspace before)
207         if (e->type() == QEvent::KeyPress && popupVisible()) {
208                 QKeyEvent *ke = static_cast<QKeyEvent *>(e);
209                 switch (ke->key()) {
210                 case Qt::Key_Tab:
211                         tab();
212                         ke->accept();
213                         return true;
214                 default: break;
215                 }
216         }
217         
218         return QCompleter::eventFilter(watched, e);
219 }
220
221
222 bool GuiCompleter::popupPossible(Cursor const & cur) const
223 {
224         return QApplication::activeWindow()
225                 && gui_->hasFocus()
226                 && cur.inset().completionSupported(cur);
227 }
228
229
230 bool GuiCompleter::inlinePossible(Cursor const & cur) const
231 {
232         return cur.inset().inlineCompletionSupported(cur);
233 }
234
235
236 bool GuiCompleter::popupVisible() const
237 {
238         return popup()->isVisible();
239 }
240
241
242 bool GuiCompleter::inlineVisible() const
243 {
244         // In fact using BufferView::inlineCompletionPos.empty() should be
245         // here. But unfortunately this information is not good enough
246         // because destructive operations like backspace might invalidate
247         // inlineCompletionPos. But then the completion should stay visible
248         // (i.e. reshown on the next update). Hence be keep this information
249         // in the inlineVisible_ variable.
250         return inlineVisible_;
251 }
252
253
254 void GuiCompleter::updateVisibility(Cursor & cur, bool start, bool keep, bool cursorInView)
255 {
256         // parameters which affect the completion
257         bool moved = cur != old_cursor_;
258         if (moved)
259                 old_cursor_ = cur;
260
261         bool possiblePopupState = popupPossible(cur) && cursorInView;
262         bool possibleInlineState = inlinePossible(cur) && cursorInView;
263
264         // we moved or popup state is not ok for popup?
265         if ((moved && !keep) || !possiblePopupState)
266                 hidePopup(cur);
267
268         // we moved or inline state is not ok for inline completion?
269         if ((moved && !keep) || !possibleInlineState)
270                 hideInline(cur);
271
272         // we inserted something and are in a possible popup state?
273         if (!popupVisible() && possiblePopupState && start
274                 && cur.inset().automaticPopupCompletion())
275                 popup_timer_.start(int(lyxrc.completion_popup_delay * 1000));
276
277         // we inserted something and are in a possible inline completion state?
278         if (!inlineVisible() && possibleInlineState && start
279                 && cur.inset().automaticInlineCompletion())
280                 inline_timer_.start(int(lyxrc.completion_inline_delay * 1000));
281
282         // update prefix if popup is visible or if it will be visible soon
283         if (popupVisible() || inlineVisible()
284             || popup_timer_.isActive() || inline_timer_.isActive())
285                 updatePrefix(cur);
286 }
287
288
289 void GuiCompleter::updateVisibility(bool start, bool keep)
290 {
291         Cursor cur = gui_->bufferView().cursor();
292         cur.updateFlags(Update::None);
293         
294         updateVisibility(cur, start, keep);
295         
296         if (cur.disp_.update())
297                 gui_->bufferView().processUpdateFlags(cur.disp_.update());
298 }
299
300
301 void GuiCompleter::updatePrefix(Cursor & cur)
302 {
303         // get new prefix. Do nothing if unchanged
304         QString newPrefix = toqstr(cur.inset().completionPrefix(cur));
305         if (newPrefix == completionPrefix())
306                 return;
307         
308         // value which should be kept selected
309         QString old = currentCompletion();
310         if (old.length() == 0)
311                 old = last_selection_;
312         
313         // update completer to new prefix
314         setCompletionPrefix(newPrefix);
315
316         // update popup because its size might have changed
317         if (popupVisible())
318                 updatePopup(cur);
319
320         // restore old selection
321         setCurrentCompletion(old);
322         
323         // if popup is not empty, the new selection will
324         // be our last valid one
325         QString const & s = currentCompletion();
326         if (s.length() > 0)
327                 last_selection_ = s;
328         else
329                 last_selection_ = old;
330         
331         // update inline completion because the default
332         // completion string might have changed
333         if (inlineVisible())
334                 updateInline(cur, s);
335 }
336
337
338 void GuiCompleter::updateInline(Cursor & cur, QString const & completion)
339 {
340         if (!cur.inset().inlineCompletionSupported(cur))
341                 return;
342         
343         // compute postfix
344         docstring prefix = cur.inset().completionPrefix(cur);
345         docstring postfix = from_utf8(fromqstr(completion.mid(prefix.length())));
346         
347         // shorten it if necessary
348         if (lyxrc.completion_inline_dots != -1
349             && postfix.size() > unsigned(lyxrc.completion_inline_dots))
350                 postfix = postfix.substr(0, lyxrc.completion_inline_dots - 1) + "...";
351
352         // set inline completion at cursor position
353         size_t uniqueTo = max(longestUniqueCompletion().size(), prefix.size());
354         gui_->bufferView().setInlineCompletion(cur, cur, postfix, uniqueTo - prefix.size());
355         inlineVisible_ = true;
356 }
357
358
359 void GuiCompleter::updatePopup(Cursor & cur)
360 {
361         if (!cur.inset().completionSupported(cur))
362                 return;
363         
364         if (completionCount() == 0)
365                 return;
366         
367         // get dimensions of completion prefix
368         Dimension dim;
369         int x;
370         int y;
371         cur.inset().completionPosAndDim(cur, x, y, dim);
372         
373         // and calculate the rect of the popup
374         QRect rect;
375         if (popup()->layoutDirection() == Qt::RightToLeft)
376                 rect = QRect(x + dim.width() - 200, y - dim.ascent() - 3, 200, dim.height() + 6);
377         else
378                 rect = QRect(x, y - dim.ascent() - 3, 200, dim.height() + 6);
379         
380         // show/update popup
381         QTreeView * p = static_cast<QTreeView *>(popup());
382         p->setColumnWidth(0, popup()->width() - 22 - p->verticalScrollBar()->width());
383
384         complete(rect);
385 }
386
387
388 void GuiCompleter::updateModel(Cursor & cur, bool popupUpdate, bool inlineUpdate)
389 {
390         // value which should be kept selected
391         QString old = currentCompletion();
392         if (old.length() == 0)
393                 old = last_selection_;
394
395         // set whether rtl
396         bool rtl = false;
397         if (cur.inTexted()) {
398                 Paragraph const & par = cur.paragraph();
399                 Font const font =
400                 par.getFontSettings(cur.bv().buffer().params(), cur.pos());
401                 rtl = font.isVisibleRightToLeft();
402         }
403         popup()->setLayoutDirection(rtl ? Qt::RightToLeft : Qt::LeftToRight);
404
405         // turn the direction of the strings in the popup.
406         // Qt does not do that itself.
407         popup()->setItemDelegateForColumn(0, rtl ? rtlItemDelegate_ : 0);
408
409         // set new model
410         Inset::CompletionList const * list = cur.inset().createCompletionList(cur);
411         setModel(new GuiCompletionModel(this, list));
412         if (list->sorted())
413                 setModelSorting(QCompleter::CaseSensitivelySortedModel);
414         else
415                 setModelSorting(QCompleter::UnsortedModel);
416
417         // set prefix
418         QString newPrefix = toqstr(cur.inset().completionPrefix(cur));
419         if (newPrefix != completionPrefix())
420                 setCompletionPrefix(newPrefix);
421
422         // show popup
423         if (popupUpdate)
424                 updatePopup(cur);
425
426         // restore old selection
427         setCurrentCompletion(old);
428         
429         // if popup is not empty, the new selection will
430         // be our last valid one
431         QString const & s = currentCompletion();
432         if (s.length() > 0)
433                 last_selection_ = s;
434         else
435                 last_selection_ = old;
436
437         // show inline completion
438         if (inlineUpdate)
439                 updateInline(cur, currentCompletion());
440 }
441
442
443 void GuiCompleter::showPopup(Cursor & cur)
444 {
445         if (!popupPossible(cur))
446                 return;
447         
448         updateModel(cur, true, inlineVisible());
449 }
450
451
452 void GuiCompleter::hidePopup(Cursor & cur)
453 {
454         popup()->hide();
455         if (popup_timer_.isActive())
456                 popup_timer_.stop();
457 }
458
459
460 void GuiCompleter::showInline(Cursor & cur)
461 {
462         if (!inlinePossible(cur))
463                 return;
464         
465         updateModel(cur, popupVisible(), true);
466 }
467
468
469 void GuiCompleter::hideInline(Cursor & cur)
470 {
471         gui_->bufferView().setInlineCompletion(cur, DocIterator(), docstring());
472         inlineVisible_ = false;
473 }
474
475
476 void GuiCompleter::showPopup()
477 {
478         Cursor cur = gui_->bufferView().cursor();
479         cur.updateFlags(Update::None);
480         
481         showPopup(cur);
482
483         // redraw if needed
484         if (cur.disp_.update())
485                 gui_->bufferView().processUpdateFlags(cur.disp_.update());
486 }
487
488
489 void GuiCompleter::showInline()
490 {
491         Cursor cur = gui_->bufferView().cursor();
492         cur.updateFlags(Update::None);
493         
494         showInline(cur);
495
496         // redraw if needed
497         if (cur.disp_.update())
498                 gui_->bufferView().processUpdateFlags(cur.disp_.update());
499 }
500
501
502 void GuiCompleter::hidePopup()
503 {
504         Cursor cur = gui_->bufferView().cursor();
505         cur.updateFlags(Update::None);
506         
507         hidePopup(cur);
508         
509         // redraw if needed
510         if (cur.disp_.update())
511                 gui_->bufferView().processUpdateFlags(cur.disp_.update());
512 }
513
514
515 void GuiCompleter::hideInline()
516 {
517         Cursor cur = gui_->bufferView().cursor();
518         cur.updateFlags(Update::None);
519         
520         hideInline(cur);
521         
522         // redraw if needed
523         if (cur.disp_.update())
524                 gui_->bufferView().processUpdateFlags(cur.disp_.update());
525 }
526
527
528 void GuiCompleter::activate()
529 {
530         if (!popupVisible() && !inlineVisible())
531                 return;
532
533         popupActivated(currentCompletion());
534 }
535
536
537 void GuiCompleter::tab()
538 {
539         BufferView * bv = &gui_->bufferView();
540         Cursor cur = bv->cursor();
541         cur.updateFlags(Update::None);
542         
543         // check that inline completion is active
544         if (!inlineVisible()) {
545                 // try to activate the inline completion
546                 if (cur.inset().inlineCompletionSupported(cur)) {
547                         showInline();
548                         
549                         // show popup without delay because the completion was not unique
550                         if (lyxrc.completion_popup_after_complete
551                             && !popupVisible()
552                             && popup()->model()->rowCount() > 1)
553                                 popup_timer_.start(0);
554
555                         return;
556                 }
557                 // or try popup
558                 if (!popupVisible() && cur.inset().completionSupported(cur)) {
559                         showPopup();
560                         return;
561                 }
562                 
563                 return;
564         }
565         
566         // If completion is active, at least complete by one character
567         docstring prefix = cur.inset().completionPrefix(cur);
568         docstring completion = from_utf8(fromqstr(currentCompletion()));
569         if (completion.size() <= prefix.size()) {
570                 // finalize completion
571                 cur.inset().insertCompletion(cur, docstring(), true);
572                 
573                 // hide popup and inline completion
574                 hidePopup(cur);
575                 hideInline(cur);
576                 updateVisibility(false, false);
577                 return;
578         }
579         docstring nextchar = completion.substr(prefix.size(), 1);
580         if (!cur.inset().insertCompletion(cur, nextchar, false))
581                 return;
582         updatePrefix(cur);
583
584         // try to complete as far as it is unique
585         docstring longestCompletion = longestUniqueCompletion();
586         prefix = cur.inset().completionPrefix(cur);
587         docstring postfix = longestCompletion.substr(min(longestCompletion.size(), prefix.size()));
588         cur.inset().insertCompletion(cur, postfix, false);
589         old_cursor_ = bv->cursor();
590         updatePrefix(cur);
591
592         // show popup without delay because the completion was not unique
593         if (lyxrc.completion_popup_after_complete
594             && !popupVisible()
595             && popup()->model()->rowCount() > 1)
596                 popup_timer_.start(0);
597
598         // redraw if needed
599         if (cur.disp_.update())
600                 gui_->bufferView().processUpdateFlags(cur.disp_.update());
601 }
602
603
604 QString GuiCompleter::currentCompletion() const
605 {
606         if (!popup()->selectionModel()->hasSelection())
607                 return QString();
608
609         // Not sure if this is bug in Qt: currentIndex() always 
610         // return the first element in the list.
611         QModelIndex idx = popup()->currentIndex();
612         return popup()->model()->data(idx, Qt::EditRole).toString();
613 }
614
615
616 void GuiCompleter::setCurrentCompletion(QString const & s)
617 {       
618         QAbstractItemModel const & model = *popup()->model();
619         size_t n = model.rowCount();
620         if (n == 0)
621                 return;
622
623         // select the first if s is empty
624         if (s.length() == 0) {
625                 updateLock_++;
626                 popup()->setCurrentIndex(model.index(0, 0));
627                 updateLock_--;
628                 return;
629         }
630
631         // find old selection in model
632         size_t i;
633         if (modelSorting() == QCompleter::UnsortedModel) {
634                 // In unsorted models, iterate through list until the s is found
635                 for (i = 0; i < n; ++i) {
636                         QString const & is
637                         = model.data(model.index(i, 0), Qt::EditRole).toString();
638                         if (is == s)
639                                 break;
640                 }
641         } else {
642                 // In sorted models, do binary search for s.
643                 int l = 0;
644                 int r = n - 1;
645                 while (r >= l && l < int(n)) {
646                         size_t mid = (r + l) / 2;
647                         QString const & mids
648                         = model.data(model.index(mid, 0),
649                                      Qt::EditRole).toString();
650
651                         // left or right?
652                         // FIXME: is this really the same order that the docstring
653                         // from the CompletionList has?
654                         int c = s.compare(mids, Qt::CaseSensitive);
655                         if (c == 0) {
656                                 l = mid;
657                                 break;
658                         } else if (l == r) {
659                                 l = n;
660                                 break;
661                         } else if (c > 0)
662                                 // middle is not far enough
663                                 l = mid + 1;
664                         else
665                                 // middle is too far
666                                 r = mid - 1;
667                 }
668
669                 // loop was left without finding anything
670                 if (r < l)
671                         i = n;
672                 else
673                         i = l;
674                 BOOST_ASSERT(0 <= i && i <= n);
675         }
676
677         // select the first if none was found
678         if (i == n)
679                 i = 0;
680
681         updateLock_++;
682         popup()->setCurrentIndex(model.index(i, 0));
683         updateLock_--;
684 }
685
686
687 size_t commonPrefix(QString const & s1, QString const & s2)
688 {
689         // find common prefix
690         size_t j;
691         size_t n1 = s1.length();
692         size_t n2 = s2.length();
693         for (j = 0; j < n1 && j < n2; ++j) {
694                 if (s1.at(j) != s2.at(j))
695                         break;
696         }
697         return j;
698 }
699
700
701 docstring GuiCompleter::longestUniqueCompletion() const
702 {
703         QAbstractItemModel const & model = *popup()->model();
704         QString s = currentCompletion();
705         size_t n = model.rowCount();
706
707         if (modelSorting() == QCompleter::UnsortedModel) {
708                 // For unsorted model we cannot do more than iteration.
709                 // Iterate through the completions and cut off where s differs
710                 for (size_t i = 0; i < n && s.length() > 0; ++i) {
711                         QString const & is
712                         = model.data(model.index(i, 0), Qt::EditRole).toString();
713
714                         s = s.left(commonPrefix(is, s));
715                 }
716         } else {
717                 // For sorted models we can do binary search multiple times,
718                 // each time to find the first string which has s not as prefix.
719                 size_t i = 0;
720                 while (i < n && s.length() > 0) {
721                         // find first string that does not have s as prefix
722                         // via binary search in [i,n-1]
723                         size_t r = n - 1;
724                         do {
725                                 // get common prefix with the middle string
726                                 size_t mid = (r + i) / 2;
727                                 QString const & mids
728                                 = model.data(model.index(mid, 0), 
729                                         Qt::EditRole).toString();
730                                 size_t oldLen = s.length();
731                                 size_t len = commonPrefix(mids, s);
732                                 s = s.left(len);
733
734                                 // left or right?
735                                 if (oldLen == len) {
736                                         // middle is not far enough
737                                         i = mid + 1;
738                                 } else {
739                                         // middle is maybe too far
740                                         r = mid;
741                                 }
742                         } while (r - i > 0 && i < n);
743                 }
744         }
745
746         return from_utf8(fromqstr(s));
747 }
748
749
750 void GuiCompleter::popupActivated(const QString & completion)
751 {
752         Cursor cur = gui_->bufferView().cursor();
753         cur.updateFlags(Update::None);
754         
755         docstring prefix = cur.inset().completionPrefix(cur);
756         docstring postfix = from_utf8(fromqstr(completion.mid(prefix.length())));
757         cur.inset().insertCompletion(cur, postfix, true);
758         hidePopup(cur);
759         hideInline(cur);
760         
761         if (cur.disp_.update())
762                 gui_->bufferView().processUpdateFlags(cur.disp_.update());
763 }
764
765
766 void GuiCompleter::popupHighlighted(const QString & completion)
767 {
768         if (updateLock_ > 0)
769                 return;
770
771         Cursor cur = gui_->bufferView().cursor();
772         cur.updateFlags(Update::None);
773         
774         if (inlineVisible())
775                 updateInline(cur, completion);
776         
777         if (cur.disp_.update())
778                 gui_->bufferView().processUpdateFlags(cur.disp_.update());
779 }
780
781 } // namespace frontend
782 } // namespace lyx
783
784 #include "GuiCompleter_moc.cpp"