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"
27 #include "support/lassert.h"
28 #include "support/debug.h"
30 #include <QApplication>
31 #include <QHeaderView>
34 #include <QPixmapCache>
36 #include <QItemDelegate>
41 using namespace lyx::support;
46 class CompleterItemDelegate : public QItemDelegate
49 explicit CompleterItemDelegate(QObject * parent)
50 : QItemDelegate(parent)
53 ~CompleterItemDelegate()
57 void paint(QPainter *painter, const QStyleOptionViewItem &option,
58 const QModelIndex &index) const
60 if (index.column() == 0) {
61 QItemDelegate::paint(painter, option, index);
64 QStyleOptionViewItem opt = setOptions(index, option);
65 QVariant value = index.data(Qt::DisplayRole);
66 QPixmap pixmap = qvariant_cast<QPixmap>(value);
70 drawBackground(painter, opt, index);
71 if (!pixmap.isNull()) {
72 const QSize size = pixmap.size();
73 painter->drawPixmap(option.rect.left() + (16 - size.width()) / 2,
74 option.rect.top() + (option.rect.height() - size.height()) / 2,
77 drawFocus(painter, opt, option.rect);
82 class GuiCompletionModel : public QAbstractListModel
86 GuiCompletionModel(QObject * parent, CompletionList const * l)
87 : QAbstractListModel(parent), list_(l)
90 ~GuiCompletionModel() { delete list_; }
92 void setList(CompletionList const * l) {
102 return list_->sorted();
106 int columnCount(const QModelIndex & /*parent*/ = QModelIndex()) const
111 int rowCount(const QModelIndex & /*parent*/ = QModelIndex()) const
115 return list_->size();
119 QVariant data(const QModelIndex & index, int role) const
124 if (index.row() < 0 || index.row() >= rowCount())
127 if (role != Qt::DisplayRole && role != Qt::EditRole)
130 if (index.column() == 0)
131 return toqstr(list_->data(index.row()));
133 if (index.column() != 1)
136 // get icon from cache
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);
143 // scale it to 16x16 or smaller
144 scaled = p.scaled(min(16, p.width()), min(16, p.height()),
145 Qt::KeepAspectRatio, Qt::SmoothTransformation);
147 QPixmapCache::insert("completion" + name, scaled);
154 CompletionList const * list_;
158 GuiCompleter::GuiCompleter(GuiWorkArea * gui, QObject * parent)
159 : QCompleter(parent), gui_(gui), old_cursor_(0), updateLock_(0),
160 inlineVisible_(false), popupVisible_(false),
163 // Setup the completion popup
164 model_ = new GuiCompletionModel(this, 0);
166 setCompletionMode(QCompleter::PopupCompletion);
167 setCaseSensitivity(Qt::CaseSensitive);
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);
181 itemDelegate_ = new CompleterItemDelegate(this);
182 popup()->setItemDelegate(itemDelegate_);
184 // create timeout timers
185 popup_timer_.setSingleShot(true);
186 inline_timer_.setSingleShot(true);
187 connect(this, SIGNAL(highlighted(const QString &)),
188 this, SLOT(popupHighlighted(const QString &)));
189 connect(this, SIGNAL(activated(const QString &)),
190 this, SLOT(popupActivated(const QString &)));
191 connect(&popup_timer_, SIGNAL(timeout()),
192 this, SLOT(showPopup()));
193 connect(&inline_timer_, SIGNAL(timeout()),
194 this, SLOT(showInline()));
198 GuiCompleter::~GuiCompleter()
204 bool GuiCompleter::eventFilter(QObject * watched, QEvent * e)
206 // hijack back the tab key from the popup
207 // (which stole it from the workspace before)
208 if (e->type() == QEvent::KeyPress && popupVisible()) {
209 QKeyEvent *ke = static_cast<QKeyEvent *>(e);
219 return QCompleter::eventFilter(watched, e);
223 bool GuiCompleter::popupPossible(Cursor const & cur) const
225 return QApplication::activeWindow()
227 && cur.inset().completionSupported(cur);
231 bool GuiCompleter::inlinePossible(Cursor const & cur) const
233 return cur.inset().inlineCompletionSupported(cur);
237 bool GuiCompleter::uniqueCompletionAvailable() const
242 size_t n = popup()->model()->rowCount();
246 // if there is exactly one, we have to check whether it is a
247 // real completion, i.e. longer than the current prefix.
248 if (completionPrefix() == currentCompletion())
255 bool GuiCompleter::completionAvailable() const
260 size_t n = popup()->model()->rowCount();
262 // if there is exactly one, we have to check whether it is a
263 // real completion, i.e. longer than the current prefix.
264 if (n == 1 && completionPrefix() == currentCompletion())
271 bool GuiCompleter::popupVisible() const
273 return popupVisible_;
277 bool GuiCompleter::inlineVisible() const
279 // In fact using BufferView::inlineCompletionPos.empty() should be
280 // here. But unfortunately this information is not good enough
281 // because destructive operations like backspace might invalidate
282 // inlineCompletionPos. But then the completion should stay visible
283 // (i.e. reshown on the next update). Hence be keep this information
284 // in the inlineVisible_ variable.
285 return inlineVisible_;
289 void GuiCompleter::updateVisibility(Cursor & cur, bool start, bool keep)
291 // parameters which affect the completion
292 bool moved = cur != old_cursor_;
296 bool const possiblePopupState = popupPossible(cur);
297 bool const possibleInlineState = inlinePossible(cur);
299 // we moved or popup state is not ok for popup?
300 if ((moved && !keep) || !possiblePopupState)
303 // we moved or inline state is not ok for inline completion?
304 if ((moved && !keep) || !possibleInlineState)
307 // we inserted something and are in a possible popup state?
308 if (!popupVisible() && possiblePopupState && start
309 && cur.inset().automaticPopupCompletion())
310 popup_timer_.start(int(lyxrc.completion_popup_delay * 1000));
312 // we inserted something and are in a possible inline completion state?
313 if (!inlineVisible() && possibleInlineState && start
314 && cur.inset().automaticInlineCompletion())
315 inline_timer_.start(int(lyxrc.completion_inline_delay * 1000));
316 else if (cur.inMathed() && !lyxrc.completion_inline_math) {
317 // no inline completion, hence a metrics update is needed
318 if (!(cur.result().screenUpdate() & Update::Force))
319 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
322 // update prefix if any completion is possible
323 bool modelActive = modelActive_ && model()->rowCount() > 0;
324 if (possiblePopupState || possibleInlineState) {
328 updateAvailability();
333 void GuiCompleter::updateVisibility(bool start, bool keep)
335 Cursor cur = gui_->bufferView().cursor();
336 cur.screenUpdateFlags(Update::None);
338 updateVisibility(cur, start, keep);
340 if (cur.result().screenUpdate())
341 gui_->bufferView().processUpdateFlags(cur.result().screenUpdate());
345 void GuiCompleter::updatePrefix(Cursor const & cur)
347 // get new prefix. Do nothing if unchanged
348 QString newPrefix = toqstr(cur.inset().completionPrefix(cur));
349 if (newPrefix == completionPrefix())
352 // value which should be kept selected
353 QString old = currentCompletion();
354 if (old.length() == 0)
355 old = last_selection_;
357 // update completer to new prefix
358 setCompletionPrefix(newPrefix);
360 // update popup because its size might have changed
364 // restore old selection
365 setCurrentCompletion(old);
367 // if popup is not empty, the new selection will
368 // be our last valid one
369 QString const & s = currentCompletion();
370 if (popupVisible() || inlineVisible()) {
374 last_selection_ = old;
377 // update inline completion because the default
378 // completion string might have changed
380 updateInline(cur, s);
384 void GuiCompleter::updateInline(Cursor const & cur, QString const & completion)
386 if (!cur.inset().inlineCompletionSupported(cur))
390 docstring prefix = cur.inset().completionPrefix(cur);
391 docstring postfix = qstring_to_ucs4(completion.mid(prefix.length()));
393 // shorten it if necessary
394 if (lyxrc.completion_inline_dots != -1
395 && postfix.size() > unsigned(lyxrc.completion_inline_dots))
396 postfix = postfix.substr(0, lyxrc.completion_inline_dots - 1) + "...";
398 // set inline completion at cursor position
399 size_t uniqueTo = max(longestUniqueCompletion().size(), prefix.size());
400 gui_->bufferView().setInlineCompletion(cur, cur, postfix, uniqueTo - prefix.size());
401 inlineVisible_ = true;
405 void GuiCompleter::updatePopup(Cursor const & cur)
407 if (!cur.inset().completionSupported(cur))
410 popupVisible_ = true;
412 if (completionCount() == 0) {
413 QTimer::singleShot(0, popup(), SLOT(hide()));
417 QTimer::singleShot(0, this, SLOT(asyncUpdatePopup()));
421 void GuiCompleter::asyncUpdatePopup()
423 Cursor cur = gui_->bufferView().cursor();
424 if (!cur.inset().completionSupported(cur)
425 || !cur.bv().paragraphVisible(cur)) {
426 popupVisible_ = false;
430 // get dimensions of completion prefix
434 cur.inset().completionPosAndDim(cur, x, y, dim);
436 // and calculate the rect of the popup
438 if (popup()->layoutDirection() == Qt::RightToLeft)
439 rect = QRect(x + dim.width() - 200, y - dim.ascent() - 3, 200, dim.height() + 6);
441 rect = QRect(x, y - dim.ascent() - 3, 200, dim.height() + 6);
443 // Resize the columns in the popup.
444 // This should really be in the constructor. But somehow the treeview
445 // has a bad memory about it and we have to tell him again and again.
446 QTreeView * listView = static_cast<QTreeView *>(popup());
447 listView->header()->setStretchLastSection(false);
448 setSectionResizeMode(listView->header(), 0, QHeaderView::Stretch);
449 setSectionResizeMode(listView->header(), 1, QHeaderView::Fixed);
450 listView->header()->resizeSection(1, 22);
457 void GuiCompleter::updateAvailability()
459 // this should really only be of interest if no completion is
460 // visible yet, i.e. especially if automatic completion is disabled.
461 if (inlineVisible() || popupVisible())
463 Cursor const & cur = gui_->bufferView().cursor();
464 if (!popupPossible(cur) && !inlinePossible(cur))
467 updateModel(cur, false, false);
471 void GuiCompleter::updateModel(Cursor const & cur, bool popupUpdate, bool inlineUpdate)
473 // value which should be kept selected
474 QString old = currentCompletion();
475 if (old.length() == 0)
476 old = last_selection_;
480 if (cur.inTexted()) {
481 Paragraph const & par = cur.paragraph();
483 par.getFontSettings(cur.bv().buffer().params(), cur.pos());
484 rtl = font.isVisibleRightToLeft();
486 popup()->setLayoutDirection(rtl ? Qt::RightToLeft : Qt::LeftToRight);
489 CompletionList const * list = cur.inset().createCompletionList(cur);
490 model_->setList(list);
493 setModelSorting(QCompleter::CaseSensitivelySortedModel);
495 setModelSorting(QCompleter::UnsortedModel);
498 QString newPrefix = toqstr(cur.inset().completionPrefix(cur));
499 if (newPrefix != completionPrefix())
500 setCompletionPrefix(newPrefix);
506 // restore old selection
507 setCurrentCompletion(old);
509 // if popup is not empty, the new selection will
510 // be our last valid one
511 if (popupVisible() || inlineVisible()) {
512 QString const & s = currentCompletion();
516 last_selection_ = old;
519 // show inline completion
521 updateInline(cur, currentCompletion());
525 void GuiCompleter::showPopup(Cursor const & cur)
527 if (!popupPossible(cur))
530 updateModel(cur, true, inlineVisible());
534 void GuiCompleter::asyncHidePopup()
537 if (!inlineVisible())
542 void GuiCompleter::showInline(Cursor const & cur)
544 if (!inlinePossible(cur))
547 updateModel(cur, popupVisible(), true);
551 void GuiCompleter::hideInline(Cursor const & cur)
553 gui_->bufferView().setInlineCompletion(cur, DocIterator(cur.buffer()), docstring());
554 inlineVisible_ = false;
556 if (inline_timer_.isActive())
557 inline_timer_.stop();
559 // Trigger asynchronous part of hideInline. We might be
560 // in a dispatcher here and the setModel call might
561 // trigger focus events which is are not healthy here.
562 QTimer::singleShot(0, this, SLOT(asyncHideInline()));
564 // mark that the asynchronous part will reset the model
566 modelActive_ = false;
570 void GuiCompleter::asyncHideInline()
577 void GuiCompleter::showPopup()
579 Cursor cur = gui_->bufferView().cursor();
580 cur.screenUpdateFlags(Update::None);
585 if (cur.result().screenUpdate())
586 gui_->bufferView().processUpdateFlags(cur.result().screenUpdate());
590 void GuiCompleter::showInline()
592 Cursor cur = gui_->bufferView().cursor();
593 cur.screenUpdateFlags(Update::None);
598 if (cur.result().screenUpdate())
599 gui_->bufferView().processUpdateFlags(cur.result().screenUpdate());
603 void GuiCompleter::hidePopup()
605 popupVisible_ = false;
607 if (popup_timer_.isActive())
610 // hide popup asynchronously because we might be here inside of
611 // LFUN dispatchers. Hiding a popup can trigger a focus event on the
612 // workarea which then redisplays the cursor. But the metrics are not
613 // yet up to date such that the coord cache has not all insets yet. The
614 // cursorPos methods would triggers asserts in the coord cache then.
615 QTimer::singleShot(0, this, SLOT(asyncHidePopup()));
617 // mark that the asynchronous part will reset the model
618 if (!inlineVisible())
619 modelActive_ = false;
623 void GuiCompleter::hideInline()
625 Cursor cur = gui_->bufferView().cursor();
626 cur.screenUpdateFlags(Update::None);
631 if (cur.result().screenUpdate())
632 gui_->bufferView().processUpdateFlags(cur.result().screenUpdate());
636 void GuiCompleter::activate()
638 if (!popupVisible() && !inlineVisible())
641 popupActivated(currentCompletion());
645 void GuiCompleter::tab()
647 BufferView * bv = &gui_->bufferView();
648 Cursor cur = bv->cursor();
649 cur.screenUpdateFlags(Update::None);
651 // check that inline completion is active
652 if (!inlineVisible() && !uniqueCompletionAvailable()) {
653 // try to activate the inline completion
654 if (cur.inset().inlineCompletionSupported(cur)) {
657 // show popup without delay because the completion was not unique
658 if (lyxrc.completion_popup_after_complete
660 && popup()->model()->rowCount() > 1)
661 popup_timer_.start(0);
666 if (!popupVisible() && cur.inset().completionSupported(cur)) {
674 // Make undo possible
675 cur.beginUndoGroup();
678 // If completion is active, at least complete by one character
679 docstring prefix = cur.inset().completionPrefix(cur);
680 docstring completion = qstring_to_ucs4(currentCompletion());
681 if (completion.size() <= prefix.size()) {
682 // finalize completion
683 cur.inset().insertCompletion(cur, docstring(), true);
685 // hide popup and inline completion
688 updateVisibility(false, false);
692 docstring nextchar = completion.substr(prefix.size(), 1);
693 if (!cur.inset().insertCompletion(cur, nextchar, false)) {
699 // try to complete as far as it is unique
700 docstring longestCompletion = longestUniqueCompletion();
701 prefix = cur.inset().completionPrefix(cur);
702 docstring postfix = longestCompletion.substr(min(longestCompletion.size(), prefix.size()));
703 cur.inset().insertCompletion(cur, postfix, false);
704 old_cursor_ = bv->cursor();
707 // show popup without delay because the completion was not unique
708 if (lyxrc.completion_popup_after_complete
710 && popup()->model()->rowCount() > 1)
711 popup_timer_.start(0);
714 if (cur.result().screenUpdate())
715 gui_->bufferView().processUpdateFlags(cur.result().screenUpdate());
720 QString GuiCompleter::currentCompletion() const
722 if (!popup()->selectionModel()->hasSelection())
725 // Not sure if this is bug in Qt: currentIndex() always
726 // return the first element in the list.
727 QModelIndex idx = popup()->currentIndex();
728 return popup()->model()->data(idx, Qt::EditRole).toString();
732 void GuiCompleter::setCurrentCompletion(QString const & s)
734 QAbstractItemModel const & model = *popup()->model();
735 size_t n = model.rowCount();
739 // select the first if s is empty
740 if (s.length() == 0) {
742 popup()->setCurrentIndex(model.index(0, 0));
747 // find old selection in model
749 if (modelSorting() == QCompleter::UnsortedModel) {
750 // In unsorted models, iterate through list until the s is found
751 for (i = 0; i < n; ++i) {
753 = model.data(model.index(i, 0), Qt::EditRole).toString();
758 // In sorted models, do binary search for s.
761 while (r >= l && l < int(n)) {
762 size_t mid = (r + l) / 2;
764 = model.data(model.index(mid, 0),
765 Qt::EditRole).toString();
768 // FIXME: is this really the same order that the docstring
769 // from the CompletionList has?
770 int c = s.compare(mids, Qt::CaseSensitive);
778 // middle is not far enough
785 // loop was left without finding anything
790 // we can try to recover
791 LASSERT(i <= n, i = 0);
794 // select the first if none was found
799 popup()->setCurrentIndex(model.index(i, 0));
804 size_t commonPrefix(QString const & s1, QString const & s2)
806 // find common prefix
808 size_t n1 = s1.length();
809 size_t n2 = s2.length();
810 for (j = 0; j < n1 && j < n2; ++j) {
811 if (s1.at(j) != s2.at(j))
818 docstring GuiCompleter::longestUniqueCompletion() const
820 QAbstractItemModel const & model = *popup()->model();
821 size_t n = model.rowCount();
824 QString s = model.data(model.index(0, 0), Qt::EditRole).toString();
826 if (modelSorting() == QCompleter::UnsortedModel) {
827 // For unsorted model we cannot do more than iteration.
828 // Iterate through the completions and cut off where s differs
829 for (size_t i = 0; i < n && s.length() > 0; ++i) {
831 = model.data(model.index(i, 0), Qt::EditRole).toString();
833 s = s.left(commonPrefix(is, s));
836 // For sorted models we can do binary search multiple times,
837 // each time to find the first string which has s not as prefix.
839 while (i < n && s.length() > 0) {
840 // find first string that does not have s as prefix
841 // via binary search in [i,n-1]
844 // get common prefix with the middle string
845 size_t mid = (r + i) / 2;
847 = model.data(model.index(mid, 0),
848 Qt::EditRole).toString();
849 size_t oldLen = s.length();
850 size_t len = commonPrefix(mids, s);
855 // middle is not far enough
858 // middle is maybe too far
861 } while (r - i > 0 && i < n);
865 return qstring_to_ucs4(s);
869 void GuiCompleter::popupActivated(const QString & completion)
871 Cursor cur = gui_->bufferView().cursor();
872 cur.screenUpdateFlags(Update::None);
874 cur.beginUndoGroup();
877 docstring prefix = cur.inset().completionPrefix(cur);
878 docstring postfix = qstring_to_ucs4(completion.mid(prefix.length()));
879 cur.inset().insertCompletion(cur, postfix, true);
883 if (cur.result().screenUpdate())
884 gui_->bufferView().processUpdateFlags(cur.result().screenUpdate());
889 void GuiCompleter::popupHighlighted(const QString & completion)
894 Cursor cur = gui_->bufferView().cursor();
895 cur.screenUpdateFlags(Update::None);
898 updateInline(cur, completion);
900 if (cur.result().screenUpdate())
901 gui_->bufferView().processUpdateFlags(cur.result().screenUpdate());
904 } // namespace frontend
907 #include "moc_GuiCompleter.cpp"