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 "FuncRequest.h"
21 #include "GuiWorkArea.h"
25 #include "Paragraph.h"
28 #include "support/lassert.h"
29 #include "support/debug.h"
31 #include <QApplication>
32 #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) {
101 return list_->sorted();
105 int columnCount(const QModelIndex & /*parent*/ = QModelIndex()) const
110 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) {
134 // get icon from cache
136 QString const name = ":" + toqstr(list_->icon(index.row()));
137 if (!QPixmapCache::find("completion" + name, scaled)) {
138 // load icon from disk
139 QPixmap p = QPixmap(name);
141 // scale it to 16x16 or smaller
142 scaled = p.scaled(min(16, p.width()), min(16, p.height()),
143 Qt::KeepAspectRatio, Qt::SmoothTransformation);
146 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);
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, bool cursorInView)
291 // parameters which affect the completion
292 bool moved = cur != old_cursor_;
296 bool possiblePopupState = popupPossible(cur) && cursorInView;
297 bool possibleInlineState = inlinePossible(cur) && cursorInView;
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));
317 // update prefix if any completion is possible
318 bool modelActive = modelActive_ && model()->rowCount() > 0;
319 if (possiblePopupState || possibleInlineState) {
323 updateAvailability();
328 void GuiCompleter::updateVisibility(bool start, bool keep)
330 Cursor cur = gui_->bufferView().cursor();
331 cur.updateFlags(Update::None);
333 updateVisibility(cur, start, keep);
335 if (cur.disp_.update())
336 gui_->bufferView().processUpdateFlags(cur.disp_.update());
340 void GuiCompleter::updatePrefix(Cursor & cur)
342 // get new prefix. Do nothing if unchanged
343 QString newPrefix = toqstr(cur.inset().completionPrefix(cur));
344 if (newPrefix == completionPrefix())
347 // value which should be kept selected
348 QString old = currentCompletion();
349 if (old.length() == 0)
350 old = last_selection_;
352 // update completer to new prefix
353 setCompletionPrefix(newPrefix);
355 // update popup because its size might have changed
359 // restore old selection
360 setCurrentCompletion(old);
362 // if popup is not empty, the new selection will
363 // be our last valid one
364 QString const & s = currentCompletion();
365 if (popupVisible() || inlineVisible()) {
369 last_selection_ = old;
372 // update inline completion because the default
373 // completion string might have changed
375 updateInline(cur, s);
379 void GuiCompleter::updateInline(Cursor & cur, QString const & completion)
381 if (!cur.inset().inlineCompletionSupported(cur))
385 docstring prefix = cur.inset().completionPrefix(cur);
386 docstring postfix = qstring_to_ucs4(completion.mid(prefix.length()));
388 // shorten it if necessary
389 if (lyxrc.completion_inline_dots != -1
390 && postfix.size() > unsigned(lyxrc.completion_inline_dots))
391 postfix = postfix.substr(0, lyxrc.completion_inline_dots - 1) + "...";
393 // set inline completion at cursor position
394 size_t uniqueTo = max(longestUniqueCompletion().size(), prefix.size());
395 gui_->bufferView().setInlineCompletion(cur, cur, postfix, uniqueTo - prefix.size());
396 inlineVisible_ = true;
400 void GuiCompleter::updatePopup(Cursor & cur)
402 if (!cur.inset().completionSupported(cur))
405 popupVisible_ = true;
407 if (completionCount() == 0) {
408 QTimer::singleShot(0, popup(), SLOT(hide()));
412 QTimer::singleShot(0, this, SLOT(asyncUpdatePopup()));
416 void GuiCompleter::asyncUpdatePopup()
418 Cursor cur = gui_->bufferView().cursor();
419 if (!cur.inset().completionSupported(cur)) {
420 popupVisible_ = false;
424 // get dimensions of completion prefix
428 cur.inset().completionPosAndDim(cur, x, y, dim);
430 // and calculate the rect of the popup
432 if (popup()->layoutDirection() == Qt::RightToLeft)
433 rect = QRect(x + dim.width() - 200, y - dim.ascent() - 3, 200, dim.height() + 6);
435 rect = QRect(x, y - dim.ascent() - 3, 200, dim.height() + 6);
437 // Resize the columns in the popup.
438 // This should really be in the constructor. But somehow the treeview
439 // has a bad memory about it and we have to tell him again and again.
440 QTreeView * listView = static_cast<QTreeView *>(popup());
441 listView->header()->setStretchLastSection(false);
442 listView->header()->setResizeMode(0, QHeaderView::Stretch);
443 listView->header()->setResizeMode(1, QHeaderView::Fixed);
444 listView->header()->resizeSection(1, 22);
451 void GuiCompleter::updateAvailability()
453 // this should really only be of interest if no completion is
454 // visible yet, i.e. especially if automatic completion is disabled.
455 if (inlineVisible() || popupVisible())
457 Cursor & cur = gui_->bufferView().cursor();
458 if (!popupPossible(cur) && !inlinePossible(cur))
461 updateModel(cur, false, false);
465 void GuiCompleter::updateModel(Cursor & cur, bool popupUpdate, bool inlineUpdate)
467 // value which should be kept selected
468 QString old = currentCompletion();
469 if (old.length() == 0)
470 old = last_selection_;
474 if (cur.inTexted()) {
475 Paragraph const & par = cur.paragraph();
477 par.getFontSettings(cur.bv().buffer().params(), cur.pos());
478 rtl = font.isVisibleRightToLeft();
480 popup()->setLayoutDirection(rtl ? Qt::RightToLeft : Qt::LeftToRight);
483 CompletionList const * list = cur.inset().createCompletionList(cur);
484 model_->setList(list);
487 setModelSorting(QCompleter::CaseSensitivelySortedModel);
489 setModelSorting(QCompleter::UnsortedModel);
492 QString newPrefix = toqstr(cur.inset().completionPrefix(cur));
493 if (newPrefix != completionPrefix())
494 setCompletionPrefix(newPrefix);
500 // restore old selection
501 setCurrentCompletion(old);
503 // if popup is not empty, the new selection will
504 // be our last valid one
505 if (popupVisible() || inlineVisible()) {
506 QString const & s = currentCompletion();
510 last_selection_ = old;
513 // show inline completion
515 updateInline(cur, currentCompletion());
519 void GuiCompleter::showPopup(Cursor & cur)
521 if (!popupPossible(cur))
524 updateModel(cur, true, inlineVisible());
528 void GuiCompleter::hidePopup(Cursor &)
530 popupVisible_ = false;
532 if (popup_timer_.isActive())
535 // hide popup asynchronously because we might be here inside of
536 // LFUN dispatchers. Hiding a popup can trigger a focus event on the
537 // workarea which then redisplays the cursor. But the metrics are not
538 // yet up to date such that the coord cache has not all insets yet. The
539 // cursorPos methods would triggers asserts in the coord cache then.
540 QTimer::singleShot(0, this, SLOT(asyncHidePopup()));
542 // mark that the asynchronous part will reset the model
543 if (!inlineVisible())
544 modelActive_ = false;
548 void GuiCompleter::asyncHidePopup()
551 if (!inlineVisible())
556 void GuiCompleter::showInline(Cursor & cur)
558 if (!inlinePossible(cur))
561 updateModel(cur, popupVisible(), true);
565 void GuiCompleter::hideInline(Cursor & cur)
567 gui_->bufferView().setInlineCompletion(cur, DocIterator(cur.buffer()), docstring());
568 inlineVisible_ = false;
570 if (inline_timer_.isActive())
571 inline_timer_.stop();
573 // Trigger asynchronous part of hideInline. We might be
574 // in a dispatcher here and the setModel call might
575 // trigger focus events which is are not healthy here.
576 QTimer::singleShot(0, this, SLOT(asyncHideInline()));
578 // mark that the asynchronous part will reset the model
580 modelActive_ = false;
584 void GuiCompleter::asyncHideInline()
591 void GuiCompleter::showPopup()
593 Cursor cur = gui_->bufferView().cursor();
594 cur.updateFlags(Update::None);
599 if (cur.disp_.update())
600 gui_->bufferView().processUpdateFlags(cur.disp_.update());
604 void GuiCompleter::showInline()
606 Cursor cur = gui_->bufferView().cursor();
607 cur.updateFlags(Update::None);
612 if (cur.disp_.update())
613 gui_->bufferView().processUpdateFlags(cur.disp_.update());
617 void GuiCompleter::hidePopup()
619 Cursor cur = gui_->bufferView().cursor();
620 cur.updateFlags(Update::None);
625 if (cur.disp_.update())
626 gui_->bufferView().processUpdateFlags(cur.disp_.update());
630 void GuiCompleter::hideInline()
632 Cursor cur = gui_->bufferView().cursor();
633 cur.updateFlags(Update::None);
638 if (cur.disp_.update())
639 gui_->bufferView().processUpdateFlags(cur.disp_.update());
643 void GuiCompleter::activate()
645 if (!popupVisible() && !inlineVisible())
648 popupActivated(currentCompletion());
652 void GuiCompleter::tab()
654 BufferView * bv = &gui_->bufferView();
655 Cursor cur = bv->cursor();
656 cur.updateFlags(Update::None);
658 // check that inline completion is active
659 if (!inlineVisible() && !uniqueCompletionAvailable()) {
660 // try to activate the inline completion
661 if (cur.inset().inlineCompletionSupported(cur)) {
664 // show popup without delay because the completion was not unique
665 if (lyxrc.completion_popup_after_complete
667 && popup()->model()->rowCount() > 1)
668 popup_timer_.start(0);
673 if (!popupVisible() && cur.inset().completionSupported(cur)) {
681 // Make undo possible
684 // If completion is active, at least complete by one character
685 docstring prefix = cur.inset().completionPrefix(cur);
686 docstring completion = qstring_to_ucs4(currentCompletion());
687 if (completion.size() <= prefix.size()) {
688 // finalize completion
689 cur.inset().insertCompletion(cur, docstring(), true);
691 // hide popup and inline completion
694 updateVisibility(false, false);
697 docstring nextchar = completion.substr(prefix.size(), 1);
698 if (!cur.inset().insertCompletion(cur, nextchar, false))
702 // try to complete as far as it is unique
703 docstring longestCompletion = longestUniqueCompletion();
704 prefix = cur.inset().completionPrefix(cur);
705 docstring postfix = longestCompletion.substr(min(longestCompletion.size(), prefix.size()));
706 cur.inset().insertCompletion(cur, postfix, false);
707 old_cursor_ = bv->cursor();
710 // show popup without delay because the completion was not unique
711 if (lyxrc.completion_popup_after_complete
713 && popup()->model()->rowCount() > 1)
714 popup_timer_.start(0);
717 if (cur.disp_.update())
718 gui_->bufferView().processUpdateFlags(cur.disp_.update());
722 QString GuiCompleter::currentCompletion() const
724 if (!popup()->selectionModel()->hasSelection())
727 // Not sure if this is bug in Qt: currentIndex() always
728 // return the first element in the list.
729 QModelIndex idx = popup()->currentIndex();
730 return popup()->model()->data(idx, Qt::EditRole).toString();
734 void GuiCompleter::setCurrentCompletion(QString const & s)
736 QAbstractItemModel const & model = *popup()->model();
737 size_t n = model.rowCount();
741 // select the first if s is empty
742 if (s.length() == 0) {
744 popup()->setCurrentIndex(model.index(0, 0));
749 // find old selection in model
751 if (modelSorting() == QCompleter::UnsortedModel) {
752 // In unsorted models, iterate through list until the s is found
753 for (i = 0; i < n; ++i) {
755 = model.data(model.index(i, 0), Qt::EditRole).toString();
760 // In sorted models, do binary search for s.
763 while (r >= l && l < int(n)) {
764 size_t mid = (r + l) / 2;
766 = model.data(model.index(mid, 0),
767 Qt::EditRole).toString();
770 // FIXME: is this really the same order that the docstring
771 // from the CompletionList has?
772 int c = s.compare(mids, Qt::CaseSensitive);
780 // middle is not far enough
787 // loop was left without finding anything
792 LASSERT(i <= n, /**/);
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.updateFlags(Update::None);
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.disp_.update())
884 gui_->bufferView().processUpdateFlags(cur.disp_.update());
888 void GuiCompleter::popupHighlighted(const QString & completion)
893 Cursor cur = gui_->bufferView().cursor();
894 cur.updateFlags(Update::None);
897 updateInline(cur, completion);
899 if (cur.disp_.update())
900 gui_->bufferView().processUpdateFlags(cur.disp_.update());
903 } // namespace frontend
906 #include "moc_GuiCompleter.cpp"