]> git.lyx.org Git - lyx.git/blob - src/frontends/qt4/GuiCompleter.cpp
8aee5c1d47b4ac2015900f243ae6ba731c9272fa
[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                 // stop an old completion timer
267                 if (popup_timer_.isActive())
268                         popup_timer_.stop();
269
270                 // hide old popup
271                 if (popupVisible())
272                         popup()->hide();
273         }
274
275         // we moved or inline state is not ok for inline completion?
276         if ((moved && !keep) || !possibleInlineState) {
277                 // stop an old completion timer
278                 if (inline_timer_.isActive())
279                         inline_timer_.stop();
280
281                 // hide old inline completion
282                 if (inlineVisible()) {
283                         gui_->bufferView().setInlineCompletion(cur, DocIterator(), docstring());
284                         inlineVisible_ = false;
285                 }
286         }
287
288         // we inserted something and are in a possible popup state?
289         if (!popupVisible() && possiblePopupState && start
290                 && cur.inset().automaticPopupCompletion())
291                 popup_timer_.start(int(lyxrc.completion_popup_delay * 1000));
292
293         // we inserted something and are in a possible inline completion state?
294         if (!inlineVisible() && possibleInlineState && start
295                 && cur.inset().automaticInlineCompletion())
296                 inline_timer_.start(int(lyxrc.completion_inline_delay * 1000));
297
298         // update prefix if popup is visible or if it will be visible soon
299         if (popupVisible() || inlineVisible()
300             || popup_timer_.isActive() || inline_timer_.isActive())
301                 updatePrefix(cur);
302 }
303
304
305 void GuiCompleter::updateVisibility(bool start, bool keep)
306 {
307         Cursor cur = gui_->bufferView().cursor();
308         cur.updateFlags(Update::None);
309         
310         updateVisibility(cur, start, keep);
311         
312         if (cur.disp_.update())
313                 gui_->bufferView().processUpdateFlags(cur.disp_.update());
314 }
315
316
317 void GuiCompleter::updatePrefix(Cursor & cur)
318 {
319         // get new prefix. Do nothing if unchanged
320         QString newPrefix = toqstr(cur.inset().completionPrefix(cur));
321         if (newPrefix == completionPrefix())
322                 return;
323         
324         // value which should be kept selected
325         QString old = currentCompletion();
326         if (old.length() == 0)
327                 old = last_selection_;
328         
329         // update completer to new prefix
330         setCompletionPrefix(newPrefix);
331
332         // update popup because its size might have changed
333         if (popupVisible())
334                 updatePopup(cur);
335
336         // restore old selection
337         setCurrentCompletion(old);
338         
339         // if popup is not empty, the new selection will
340         // be our last valid one
341         QString const & s = currentCompletion();
342         if (s.length() > 0)
343                 last_selection_ = s;
344         else
345                 last_selection_ = old;
346         
347         // update inline completion because the default
348         // completion string might have changed
349         if (inlineVisible())
350                 updateInline(cur, s);
351 }
352
353
354 void GuiCompleter::updateInline(Cursor & cur, QString const & completion)
355 {
356         if (!cur.inset().inlineCompletionSupported(cur))
357                 return;
358         
359         // compute postfix
360         docstring prefix = cur.inset().completionPrefix(cur);
361         docstring postfix = from_utf8(fromqstr(completion.mid(prefix.length())));
362         
363         // shorten it if necessary
364         if (lyxrc.completion_inline_dots != -1
365             && postfix.size() > unsigned(lyxrc.completion_inline_dots))
366                 postfix = postfix.substr(0, lyxrc.completion_inline_dots - 1) + "...";
367
368         // set inline completion at cursor position
369         size_t uniqueTo = max(longestUniqueCompletion().size(), prefix.size());
370         gui_->bufferView().setInlineCompletion(cur, cur, postfix, uniqueTo - prefix.size());
371         inlineVisible_ = true;
372 }
373
374
375 void GuiCompleter::updatePopup(Cursor & cur)
376 {
377         if (!cur.inset().completionSupported(cur))
378                 return;
379         
380         if (completionCount() == 0)
381                 return;
382         
383         // get dimensions of completion prefix
384         Dimension dim;
385         int x;
386         int y;
387         cur.inset().completionPosAndDim(cur, x, y, dim);
388         
389         // and calculate the rect of the popup
390         QRect rect;
391         if (popup()->layoutDirection() == Qt::RightToLeft)
392                 rect = QRect(x + dim.width() - 200, y - dim.ascent() - 3, 200, dim.height() + 6);
393         else
394                 rect = QRect(x, y - dim.ascent() - 3, 200, dim.height() + 6);
395         
396         // show/update popup
397         complete(rect);
398         QTreeView * p = static_cast<QTreeView *>(popup());
399         p->setColumnWidth(0, popup()->width() - 22 - p->verticalScrollBar()->width());
400 }
401
402
403 void GuiCompleter::updateModel(Cursor & cur, bool popupUpdate, bool inlineUpdate)
404 {
405         // value which should be kept selected
406         QString old = currentCompletion();
407         if (old.length() == 0)
408                 old = last_selection_;
409
410         // set whether rtl
411         bool rtl = false;
412         if (cur.inTexted()) {
413                 Paragraph const & par = cur.paragraph();
414                 Font const font =
415                 par.getFontSettings(cur.bv().buffer().params(), cur.pos());
416                 rtl = font.isVisibleRightToLeft();
417         }
418         popup()->setLayoutDirection(rtl ? Qt::RightToLeft : Qt::LeftToRight);
419
420         // turn the direction of the strings in the popup.
421         // Qt does not do that itself.
422         popup()->setItemDelegateForColumn(0, rtl ? rtlItemDelegate_ : 0);
423
424         // set new model
425         Inset::CompletionList const * list = cur.inset().createCompletionList(cur);
426         setModel(new GuiCompletionModel(this, list));
427         if (list->sorted())
428                 setModelSorting(QCompleter::CaseSensitivelySortedModel);
429         else
430                 setModelSorting(QCompleter::UnsortedModel);
431
432         // set prefix
433         QString newPrefix = toqstr(cur.inset().completionPrefix(cur));
434         if (newPrefix != completionPrefix())
435                 setCompletionPrefix(newPrefix);
436
437         // show popup
438         if (popupUpdate)
439                 updatePopup(cur);
440
441         // restore old selection
442         setCurrentCompletion(old);
443         
444         // if popup is not empty, the new selection will
445         // be our last valid one
446         QString const & s = currentCompletion();
447         if (s.length() > 0)
448                 last_selection_ = s;
449         else
450                 last_selection_ = old;
451
452         // show inline completion
453         if (inlineUpdate)
454                 updateInline(cur, currentCompletion());
455 }
456
457
458 void GuiCompleter::showPopup(Cursor & cur)
459 {
460         if (!popupPossible(cur))
461                 return;
462         
463         updateModel(cur, true, inlineVisible());
464 }
465
466
467 void GuiCompleter::showInline(Cursor & cur)
468 {
469         if (!inlinePossible(cur))
470                 return;
471         
472         updateModel(cur, popupVisible(), true);
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::activate()
503 {
504         if (!popupVisible() && !inlineVisible())
505                 return;
506
507         // Complete with current selection in the popup.
508         QString s = currentCompletion();
509         popup()->hide();
510         popupActivated(s);
511 }
512
513
514 void GuiCompleter::tab()
515 {
516         BufferView * bv = &gui_->bufferView();
517         Cursor cur = bv->cursor();
518         cur.updateFlags(Update::None);
519         
520         // check that inline completion is active
521         if (!inlineVisible()) {
522                 // try to activate the inline completion
523                 if (cur.inset().inlineCompletionSupported(cur)) {
524                         showInline();
525                         
526                         // show popup without delay because the completion was not unique
527                         if (lyxrc.completion_popup_after_complete
528                             && !popupVisible()
529                             && popup()->model()->rowCount() > 1)
530                                 popup_timer_.start(0);
531
532                         return;
533                 }
534                 // or try popup
535                 if (!popupVisible() && cur.inset().completionSupported(cur)) {
536                         showPopup();
537                         return;
538                 }
539                 
540                 return;
541         }
542         
543         // If completion is active, at least complete by one character
544         docstring prefix = cur.inset().completionPrefix(cur);
545         docstring completion = from_utf8(fromqstr(currentCompletion()));
546         if (completion.size() <= prefix.size()) {
547                 // finalize completion
548                 cur.inset().insertCompletion(cur, docstring(), true);
549                 
550                 // hide popup and inline completion
551                 popup()->hide();
552                 gui_->bufferView().setInlineCompletion(cur, DocIterator(), docstring());
553                 inlineVisible_ = false;
554                 updateVisibility(false, false);
555                 return;
556         }
557         docstring nextchar = completion.substr(prefix.size(), 1);
558         if (!cur.inset().insertCompletion(cur, nextchar, false))
559                 return;
560         updatePrefix(cur);
561
562         // try to complete as far as it is unique
563         docstring longestCompletion = longestUniqueCompletion();
564         prefix = cur.inset().completionPrefix(cur);
565         docstring postfix = longestCompletion.substr(min(longestCompletion.size(), prefix.size()));
566         cur.inset().insertCompletion(cur, postfix, false);
567         old_cursor_ = bv->cursor();
568         updatePrefix(cur);
569
570         // show popup without delay because the completion was not unique
571         if (lyxrc.completion_popup_after_complete
572             && !popupVisible()
573             && popup()->model()->rowCount() > 1)
574                 popup_timer_.start(0);
575
576         // redraw if needed
577         if (cur.disp_.update())
578                 gui_->bufferView().processUpdateFlags(cur.disp_.update());
579 }
580
581
582 QString GuiCompleter::currentCompletion() const
583 {
584         if (!popup()->selectionModel()->hasSelection())
585                 return QString();
586
587         // Not sure if this is bug in Qt: currentIndex() always 
588         // return the first element in the list.
589         QModelIndex idx = popup()->currentIndex();
590         return popup()->model()->data(idx, Qt::EditRole).toString();
591 }
592
593
594 void GuiCompleter::setCurrentCompletion(QString const & s)
595 {       
596         QAbstractItemModel const & model = *popup()->model();
597         size_t n = model.rowCount();
598         if (n == 0)
599                 return;
600
601         // select the first if s is empty
602         if (s.length() == 0) {
603                 updateLock_++;
604                 popup()->setCurrentIndex(model.index(0, 0));
605                 updateLock_--;
606                 return;
607         }
608
609         // find old selection in model
610         size_t i;
611         if (modelSorting() == QCompleter::UnsortedModel) {
612                 // In unsorted models, iterate through list until the s is found
613                 for (i = 0; i < n; ++i) {
614                         QString const & is
615                         = model.data(model.index(i, 0), Qt::EditRole).toString();
616                         if (is == s)
617                                 break;
618                 }
619         } else {
620                 // In sorted models, do binary search for s.
621                 i = 0;
622                 size_t r = n - 1;
623                 while (r >= i && i < n) {
624                         size_t mid = (r + i) / 2;
625                         QString const & mids
626                         = model.data(model.index(mid, 0),
627                                      Qt::EditRole).toString();
628
629                         // left or right?
630                         // FIXME: is this really the same order that the docstring
631                         // from the CompletionList has?
632                         int c = s.compare(mids, Qt::CaseSensitive);
633                         if (c == 0) {
634                                 i = mid;
635                                 break;
636                         } else if (i == r) {
637                                 i = n;
638                                 break;
639                         } else if (c > 0)
640                                 // middle is not far enough
641                                 i = mid + 1;
642                         else
643                                 // middle is too far
644                                 r = mid - 1;
645                 }
646
647                 // loop was left without finding anything
648                 if (r < i)
649                         i = n;
650         }
651
652         // select the first if none was found
653         if (i == n)
654                 i = 0;
655
656         updateLock_++;
657         popup()->setCurrentIndex(model.index(i, 0));
658         updateLock_--;
659 }
660
661
662 size_t commonPrefix(QString const & s1, QString const & s2)
663 {
664         // find common prefix
665         size_t j;
666         size_t n1 = s1.length();
667         size_t n2 = s2.length();
668         for (j = 0; j < n1 && j < n2; ++j) {
669                 if (s1.at(j) != s2.at(j))
670                         break;
671         }
672         return j;
673 }
674
675
676 docstring GuiCompleter::longestUniqueCompletion() const
677 {
678         QAbstractItemModel const & model = *popup()->model();
679         QString s = currentCompletion();
680         size_t n = model.rowCount();
681
682         if (modelSorting() == QCompleter::UnsortedModel) {
683                 // For unsorted model we cannot do more than iteration.
684                 // Iterate through the completions and cut off where s differs
685                 for (size_t i = 0; i < n && s.length() > 0; ++i) {
686                         QString const & is
687                         = model.data(model.index(i, 0), Qt::EditRole).toString();
688
689                         s = s.left(commonPrefix(is, s));
690                 }
691         } else {
692                 // For sorted models we can do binary search multiple times,
693                 // each time to find the first string which has s not as prefix.
694                 size_t i = 0;
695                 while (i < n && s.length() > 0) {
696                         // find first string that does not have s as prefix
697                         // via binary search in [i,n-1]
698                         size_t r = n - 1;
699                         do {
700                                 // get common prefix with the middle string
701                                 size_t mid = (r + i) / 2;
702                                 QString const & mids
703                                 = model.data(model.index(mid, 0), 
704                                         Qt::EditRole).toString();
705                                 size_t oldLen = s.length();
706                                 size_t len = commonPrefix(mids, s);
707                                 s = s.left(len);
708
709                                 // left or right?
710                                 if (oldLen == len) {
711                                         // middle is not far enough
712                                         i = mid + 1;
713                                 } else {
714                                         // middle is maybe too far
715                                         r = mid;
716                                 }
717                         } while (r - i > 0 && i < n);
718                 }
719         }
720
721         return from_utf8(fromqstr(s));
722 }
723
724
725 void GuiCompleter::popupActivated(const QString & completion)
726 {
727         Cursor cur = gui_->bufferView().cursor();
728         cur.updateFlags(Update::None);
729         
730         docstring prefix = cur.inset().completionPrefix(cur);
731         docstring postfix = from_utf8(fromqstr(completion.mid(prefix.length())));
732         cur.inset().insertCompletion(cur, postfix, true);
733         updateVisibility(cur, false);
734         
735         if (cur.disp_.update())
736                 gui_->bufferView().processUpdateFlags(cur.disp_.update());
737 }
738
739
740 void GuiCompleter::popupHighlighted(const QString & completion)
741 {
742         if (updateLock_ > 0)
743                 return;
744
745         Cursor cur = gui_->bufferView().cursor();
746         cur.updateFlags(Update::None);
747         
748         if (inlineVisible())
749                 updateInline(cur, completion);
750         
751         if (cur.disp_.update())
752                 gui_->bufferView().processUpdateFlags(cur.disp_.update());
753 }
754
755 } // namespace frontend
756 } // namespace lyx
757
758 #include "GuiCompleter_moc.cpp"