2 * \file GuiCompleter.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Stefan Schimanski
8 * Full author contact details are available in file CREDITS.
13 #include "GuiCompleter.h"
16 #include "BufferView.h"
17 #include "CompletionList.h"
19 #include "Dimension.h"
20 #include "GuiWorkArea.h"
24 #include "Paragraph.h"
25 #include "qt_helpers.h"
28 #include "support/lassert.h"
29 #include "support/debug.h"
31 #include <QApplication>
32 #include <QHeaderView>
35 #include <QPixmapCache>
37 #include <QItemDelegate>
42 using namespace lyx::support;
47 class CompleterItemDelegate : public QItemDelegate
50 explicit CompleterItemDelegate(QObject * parent)
51 : QItemDelegate(parent)
54 ~CompleterItemDelegate()
58 void paint(QPainter *painter, const QStyleOptionViewItem &option,
59 const QModelIndex &index) const
61 if (index.column() == 0) {
62 QItemDelegate::paint(painter, option, index);
65 QStyleOptionViewItem opt = setOptions(index, option);
66 QVariant value = index.data(Qt::DisplayRole);
67 QPixmap pixmap = qvariant_cast<QPixmap>(value);
71 drawBackground(painter, opt, index);
72 if (!pixmap.isNull()) {
73 const QSize size = pixmap.size();
74 painter->drawPixmap(option.rect.left() + (16 - size.width()) / 2,
75 option.rect.top() + (option.rect.height() - size.height()) / 2,
78 drawFocus(painter, opt, option.rect);
83 class GuiCompletionModel : public QAbstractListModel
87 GuiCompletionModel(QObject * parent, CompletionList const * l)
88 : QAbstractListModel(parent), list_(l)
91 ~GuiCompletionModel() { delete list_; }
93 void setList(CompletionList const * l) {
103 return list_->sorted();
107 int columnCount(const QModelIndex & /*parent*/ = QModelIndex()) const
112 int rowCount(const QModelIndex & /*parent*/ = QModelIndex()) const
116 return list_->size();
120 QVariant data(const QModelIndex & index, int role) const
125 if (index.row() < 0 || index.row() >= rowCount())
128 if (role != Qt::DisplayRole && role != Qt::EditRole)
131 if (index.column() == 0)
132 return toqstr(list_->data(index.row()));
134 if (index.column() != 1)
137 // get icon from cache
139 QString const name = ":" + toqstr(list_->icon(index.row()));
140 if (!QPixmapCache::find("completion" + name, scaled)) {
141 // load icon from disk
142 QPixmap p = QPixmap(name);
144 // scale it to 16x16 or smaller
145 scaled = p.scaled(min(16, p.width()), min(16, p.height()),
146 Qt::KeepAspectRatio, Qt::SmoothTransformation);
148 QPixmapCache::insert("completion" + name, scaled);
155 CompletionList const * list_;
159 GuiCompleter::GuiCompleter(GuiWorkArea * gui, QObject * parent)
160 : QCompleter(parent), gui_(gui), old_cursor_(0), updateLock_(0),
161 inlineVisible_(false), popupVisible_(false),
164 // Setup the completion popup
165 model_ = new GuiCompletionModel(this, 0);
167 setCompletionMode(QCompleter::PopupCompletion);
168 setCaseSensitivity(Qt::CaseSensitive);
172 QTreeView *listView = new QTreeView;
173 listView->setEditTriggers(QAbstractItemView::NoEditTriggers);
174 listView->setHorizontalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
175 listView->setSelectionBehavior(QAbstractItemView::SelectRows);
176 listView->setSelectionMode(QAbstractItemView::SingleSelection);
177 listView->header()->hide();
178 listView->setIndentation(0);
179 listView->setUniformRowHeights(true);
182 itemDelegate_ = new CompleterItemDelegate(this);
183 popup()->setItemDelegate(itemDelegate_);
185 // create timeout timers
186 popup_timer_.setSingleShot(true);
187 inline_timer_.setSingleShot(true);
188 connect(this, SIGNAL(highlighted(const QString &)),
189 this, SLOT(popupHighlighted(const QString &)));
190 connect(this, SIGNAL(activated(const QString &)),
191 this, SLOT(popupActivated(const QString &)));
192 connect(&popup_timer_, SIGNAL(timeout()),
193 this, SLOT(showPopup()));
194 connect(&inline_timer_, SIGNAL(timeout()),
195 this, SLOT(showInline()));
199 GuiCompleter::~GuiCompleter()
205 bool GuiCompleter::eventFilter(QObject * watched, QEvent * e)
207 // hijack back the tab key from the popup
208 // (which stole it from the workspace before)
209 if (e->type() == QEvent::KeyPress && popupVisible()) {
210 QKeyEvent *ke = static_cast<QKeyEvent *>(e);
220 return QCompleter::eventFilter(watched, e);
224 bool GuiCompleter::popupPossible(Cursor const & cur) const
226 return QApplication::activeWindow()
228 && cur.inset().completionSupported(cur);
232 bool GuiCompleter::inlinePossible(Cursor const & cur) const
234 return cur.inset().inlineCompletionSupported(cur);
238 bool GuiCompleter::uniqueCompletionAvailable() const
243 size_t n = popup()->model()->rowCount();
247 // if there is exactly one, we have to check whether it is a
248 // real completion, i.e. longer than the current prefix.
249 if (completionPrefix() == currentCompletion())
256 bool GuiCompleter::completionAvailable() const
261 size_t n = popup()->model()->rowCount();
263 // if there is exactly one, we have to check whether it is a
264 // real completion, i.e. longer than the current prefix.
265 if (n == 1 && completionPrefix() == currentCompletion())
272 bool GuiCompleter::popupVisible() const
274 return popupVisible_;
278 bool GuiCompleter::inlineVisible() const
280 // In fact using BufferView::inlineCompletionPos.empty() should be
281 // here. But unfortunately this information is not good enough
282 // because destructive operations like backspace might invalidate
283 // inlineCompletionPos. But then the completion should stay visible
284 // (i.e. reshown on the next update). Hence be keep this information
285 // in the inlineVisible_ variable.
286 return inlineVisible_;
290 void GuiCompleter::updateVisibility(Cursor & cur, bool start, bool keep)
292 // parameters which affect the completion
293 bool moved = cur != old_cursor_;
297 bool const possiblePopupState = popupPossible(cur);
298 bool const possibleInlineState = inlinePossible(cur);
300 // we moved or popup state is not ok for popup?
301 if ((moved && !keep) || !possiblePopupState)
304 // we moved or inline state is not ok for inline completion?
305 if ((moved && !keep) || !possibleInlineState)
308 // we inserted something and are in a possible popup state?
309 if (!popupVisible() && possiblePopupState && start
310 && cur.inset().automaticPopupCompletion())
311 popup_timer_.start(int(lyxrc.completion_popup_delay * 1000));
313 // we inserted something and are in a possible inline completion state?
314 if (!inlineVisible() && possibleInlineState && start
315 && cur.inset().automaticInlineCompletion())
316 inline_timer_.start(int(lyxrc.completion_inline_delay * 1000));
317 else if (cur.inMathed() && !lyxrc.completion_inline_math) {
318 // no inline completion, hence a metrics update is needed
319 if (!(cur.result().screenUpdate() & Update::Force))
320 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
323 // update prefix if any completion is possible
324 bool modelActive = modelActive_ && model()->rowCount() > 0;
325 if (possiblePopupState || possibleInlineState) {
329 updateAvailability();
334 void GuiCompleter::updateVisibility(bool start, bool keep)
336 Cursor cur = gui_->bufferView().cursor();
337 cur.screenUpdateFlags(Update::None);
339 updateVisibility(cur, start, keep);
341 if (cur.result().screenUpdate())
342 gui_->bufferView().processUpdateFlags(cur.result().screenUpdate());
346 void GuiCompleter::updatePrefix(Cursor const & cur)
348 // get new prefix. Do nothing if unchanged
349 QString newPrefix = toqstr(cur.inset().completionPrefix(cur));
350 if (newPrefix == completionPrefix())
353 // value which should be kept selected
354 QString old = currentCompletion();
355 if (old.length() == 0)
356 old = last_selection_;
358 // update completer to new prefix
359 setCompletionPrefix(newPrefix);
361 // update popup because its size might have changed
365 // restore old selection
366 setCurrentCompletion(old);
368 // if popup is not empty, the new selection will
369 // be our last valid one
370 QString const & s = currentCompletion();
371 if (popupVisible() || inlineVisible()) {
375 last_selection_ = old;
378 // update inline completion because the default
379 // completion string might have changed
381 updateInline(cur, s);
385 void GuiCompleter::updateInline(Cursor const & cur, QString const & completion)
387 if (!cur.inset().inlineCompletionSupported(cur))
391 docstring prefix = cur.inset().completionPrefix(cur);
392 docstring postfix = qstring_to_ucs4(completion.mid(prefix.length()));
394 // shorten it if necessary
395 if (lyxrc.completion_inline_dots != -1
396 && postfix.size() > unsigned(lyxrc.completion_inline_dots))
397 postfix = postfix.substr(0, lyxrc.completion_inline_dots - 1) + "...";
399 // set inline completion at cursor position
400 size_t uniqueTo = max(longestUniqueCompletion().size(), prefix.size());
401 gui_->bufferView().setInlineCompletion(cur, cur, postfix, uniqueTo - prefix.size());
402 inlineVisible_ = true;
406 void GuiCompleter::updatePopup(Cursor const & cur)
408 if (!cur.inset().completionSupported(cur))
411 popupVisible_ = true;
413 if (completionCount() == 0) {
414 QTimer::singleShot(0, popup(), SLOT(hide()));
418 QTimer::singleShot(0, this, SLOT(asyncUpdatePopup()));
422 void GuiCompleter::asyncUpdatePopup()
424 Cursor cur = gui_->bufferView().cursor();
425 if (!cur.inset().completionSupported(cur)
426 || !cur.bv().paragraphVisible(cur)) {
427 popupVisible_ = false;
431 // get dimensions of completion prefix
435 cur.inset().completionPosAndDim(cur, x, y, dim);
437 // and calculate the rect of the popup
439 if (popup()->layoutDirection() == Qt::RightToLeft)
440 rect = QRect(x + dim.width() - 200, y - dim.ascent() - 3, 200, dim.height() + 6);
442 rect = QRect(x, y - dim.ascent() - 3, 200, dim.height() + 6);
444 // Resize the columns in the popup.
445 // This should really be in the constructor. But somehow the treeview
446 // has a bad memory about it and we have to tell him again and again.
447 QTreeView * listView = static_cast<QTreeView *>(popup());
448 listView->header()->setStretchLastSection(false);
449 setSectionResizeMode(listView->header(), 0, QHeaderView::Stretch);
450 setSectionResizeMode(listView->header(), 1, QHeaderView::Fixed);
451 listView->header()->resizeSection(1, 22);
458 void GuiCompleter::updateAvailability()
460 // this should really only be of interest if no completion is
461 // visible yet, i.e. especially if automatic completion is disabled.
462 if (inlineVisible() || popupVisible())
464 Cursor const & cur = gui_->bufferView().cursor();
465 if (!popupPossible(cur) && !inlinePossible(cur))
468 updateModel(cur, false, false);
472 void GuiCompleter::updateModel(Cursor const & cur, bool popupUpdate, bool inlineUpdate)
474 // value which should be kept selected
475 QString old = currentCompletion();
476 if (old.length() == 0)
477 old = last_selection_;
481 if (cur.inTexted()) {
482 Paragraph const & par = cur.paragraph();
484 par.getFontSettings(cur.bv().buffer().params(), cur.pos());
485 rtl = font.isVisibleRightToLeft();
487 popup()->setLayoutDirection(rtl ? Qt::RightToLeft : Qt::LeftToRight);
490 CompletionList const * list = cur.inset().createCompletionList(cur);
491 model_->setList(list);
494 setModelSorting(QCompleter::CaseSensitivelySortedModel);
496 setModelSorting(QCompleter::UnsortedModel);
499 QString newPrefix = toqstr(cur.inset().completionPrefix(cur));
500 if (newPrefix != completionPrefix())
501 setCompletionPrefix(newPrefix);
507 // restore old selection
508 setCurrentCompletion(old);
510 // if popup is not empty, the new selection will
511 // be our last valid one
512 if (popupVisible() || inlineVisible()) {
513 QString const & s = currentCompletion();
517 last_selection_ = old;
520 // show inline completion
522 updateInline(cur, currentCompletion());
526 void GuiCompleter::showPopup(Cursor const & cur)
528 if (!popupPossible(cur))
531 updateModel(cur, true, inlineVisible());
535 void GuiCompleter::asyncHidePopup()
538 if (!inlineVisible())
543 void GuiCompleter::showInline(Cursor const & cur)
545 if (!inlinePossible(cur))
548 updateModel(cur, popupVisible(), true);
552 void GuiCompleter::hideInline(Cursor const & cur)
554 gui_->bufferView().setInlineCompletion(cur, DocIterator(cur.buffer()), docstring());
555 inlineVisible_ = false;
557 if (inline_timer_.isActive())
558 inline_timer_.stop();
560 // Trigger asynchronous part of hideInline. We might be
561 // in a dispatcher here and the setModel call might
562 // trigger focus events which is are not healthy here.
563 QTimer::singleShot(0, this, SLOT(asyncHideInline()));
565 // mark that the asynchronous part will reset the model
567 modelActive_ = false;
571 void GuiCompleter::asyncHideInline()
578 void GuiCompleter::showPopup()
580 Cursor cur = gui_->bufferView().cursor();
581 cur.screenUpdateFlags(Update::None);
586 if (cur.result().screenUpdate())
587 gui_->bufferView().processUpdateFlags(cur.result().screenUpdate());
591 void GuiCompleter::showInline()
593 Cursor cur = gui_->bufferView().cursor();
594 cur.screenUpdateFlags(Update::None);
599 if (cur.result().screenUpdate())
600 gui_->bufferView().processUpdateFlags(cur.result().screenUpdate());
604 void GuiCompleter::hidePopup()
606 popupVisible_ = false;
608 if (popup_timer_.isActive())
611 // hide popup asynchronously because we might be here inside of
612 // LFUN dispatchers. Hiding a popup can trigger a focus event on the
613 // workarea which then redisplays the cursor. But the metrics are not
614 // yet up to date such that the coord cache has not all insets yet. The
615 // cursorPos methods would triggers asserts in the coord cache then.
616 QTimer::singleShot(0, this, SLOT(asyncHidePopup()));
618 // mark that the asynchronous part will reset the model
619 if (!inlineVisible())
620 modelActive_ = false;
624 void GuiCompleter::hideInline()
626 Cursor cur = gui_->bufferView().cursor();
627 cur.screenUpdateFlags(Update::None);
632 if (cur.result().screenUpdate())
633 gui_->bufferView().processUpdateFlags(cur.result().screenUpdate());
637 void GuiCompleter::activate()
639 if (!popupVisible() && !inlineVisible())
642 popupActivated(currentCompletion());
646 void GuiCompleter::tab()
648 BufferView * bv = &gui_->bufferView();
649 Cursor cur = bv->cursor();
650 cur.screenUpdateFlags(Update::None);
652 // check that inline completion is active
653 if (!inlineVisible() && !uniqueCompletionAvailable()) {
654 // try to activate the inline completion
655 if (cur.inset().inlineCompletionSupported(cur)) {
658 // show popup without delay because the completion was not unique
659 if (lyxrc.completion_popup_after_complete
661 && popup()->model()->rowCount() > 1)
662 popup_timer_.start(0);
667 if (!popupVisible() && cur.inset().completionSupported(cur)) {
675 // Make undo possible
676 cur.beginUndoGroup();
679 // If completion is active, at least complete by one character
680 docstring prefix = cur.inset().completionPrefix(cur);
681 docstring completion = qstring_to_ucs4(currentCompletion());
682 if (completion.size() <= prefix.size()) {
683 // finalize completion
684 cur.inset().insertCompletion(cur, docstring(), true);
686 // hide popup and inline completion
689 updateVisibility(false, false);
693 docstring nextchar = completion.substr(prefix.size(), 1);
694 if (!cur.inset().insertCompletion(cur, nextchar, false)) {
700 // try to complete as far as it is unique
701 docstring longestCompletion = longestUniqueCompletion();
702 prefix = cur.inset().completionPrefix(cur);
703 docstring postfix = longestCompletion.substr(min(longestCompletion.size(), prefix.size()));
704 cur.inset().insertCompletion(cur, postfix, false);
705 old_cursor_ = bv->cursor();
708 // show popup without delay because the completion was not unique
709 if (lyxrc.completion_popup_after_complete
711 && popup()->model()->rowCount() > 1)
712 popup_timer_.start(0);
715 if (cur.result().screenUpdate())
716 gui_->bufferView().processUpdateFlags(cur.result().screenUpdate());
721 QString GuiCompleter::currentCompletion() const
723 if (!popup()->selectionModel()->hasSelection())
726 // Not sure if this is bug in Qt: currentIndex() always
727 // return the first element in the list.
728 QModelIndex idx = popup()->currentIndex();
729 return popup()->model()->data(idx, Qt::EditRole).toString();
733 void GuiCompleter::setCurrentCompletion(QString const & s)
735 QAbstractItemModel const & model = *popup()->model();
736 size_t n = model.rowCount();
740 // select the first if s is empty
741 if (s.length() == 0) {
743 popup()->setCurrentIndex(model.index(0, 0));
748 // find old selection in model
750 if (modelSorting() == QCompleter::UnsortedModel) {
751 // In unsorted models, iterate through list until the s is found
752 for (i = 0; i < n; ++i) {
754 = model.data(model.index(i, 0), Qt::EditRole).toString();
759 // In sorted models, do binary search for s.
762 while (r >= l && l < int(n)) {
763 size_t mid = (r + l) / 2;
765 = model.data(model.index(mid, 0),
766 Qt::EditRole).toString();
769 // FIXME: is this really the same order that the docstring
770 // from the CompletionList has?
771 int c = s.compare(mids, Qt::CaseSensitive);
779 // middle is not far enough
786 // loop was left without finding anything
791 // we can try to recover
792 LASSERT(i <= n, i = 0);
795 // select the first if none was found
800 popup()->setCurrentIndex(model.index(i, 0));
805 size_t commonPrefix(QString const & s1, QString const & s2)
807 // find common prefix
809 size_t n1 = s1.length();
810 size_t n2 = s2.length();
811 for (j = 0; j < n1 && j < n2; ++j) {
812 if (s1.at(j) != s2.at(j))
819 docstring GuiCompleter::longestUniqueCompletion() const
821 QAbstractItemModel const & model = *popup()->model();
822 size_t n = model.rowCount();
825 QString s = model.data(model.index(0, 0), Qt::EditRole).toString();
827 if (modelSorting() == QCompleter::UnsortedModel) {
828 // For unsorted model we cannot do more than iteration.
829 // Iterate through the completions and cut off where s differs
830 for (size_t i = 0; i < n && s.length() > 0; ++i) {
832 = model.data(model.index(i, 0), Qt::EditRole).toString();
834 s = s.left(commonPrefix(is, s));
837 // For sorted models we can do binary search multiple times,
838 // each time to find the first string which has s not as prefix.
840 while (i < n && s.length() > 0) {
841 // find first string that does not have s as prefix
842 // via binary search in [i,n-1]
845 // get common prefix with the middle string
846 size_t mid = (r + i) / 2;
848 = model.data(model.index(mid, 0),
849 Qt::EditRole).toString();
850 size_t oldLen = s.length();
851 size_t len = commonPrefix(mids, s);
856 // middle is not far enough
859 // middle is maybe too far
862 } while (r - i > 0 && i < n);
866 return qstring_to_ucs4(s);
870 void GuiCompleter::popupActivated(const QString & completion)
872 Cursor cur = gui_->bufferView().cursor();
873 cur.screenUpdateFlags(Update::None);
875 cur.beginUndoGroup();
878 docstring prefix = cur.inset().completionPrefix(cur);
879 docstring postfix = qstring_to_ucs4(completion.mid(prefix.length()));
880 cur.inset().insertCompletion(cur, postfix, true);
884 if (cur.result().screenUpdate())
885 gui_->bufferView().processUpdateFlags(cur.result().screenUpdate());
890 void GuiCompleter::popupHighlighted(const QString & completion)
895 Cursor cur = gui_->bufferView().cursor();
896 cur.screenUpdateFlags(Update::None);
899 updateInline(cur, completion);
901 if (cur.result().screenUpdate())
902 gui_->bufferView().processUpdateFlags(cur.result().screenUpdate());
905 } // namespace frontend
908 #include "moc_GuiCompleter.cpp"