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 // no inline completion, hence a metrics update is needed
318 if (!(cur.disp_.update() & Update::Force))
319 cur.updateFlags(cur.disp_.update() | 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.updateFlags(Update::None);
338 updateVisibility(cur, start, keep);
340 if (cur.disp_.update())
341 gui_->bufferView().processUpdateFlags(cur.disp_.update());
345 void GuiCompleter::updatePrefix(Cursor & 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 & 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 & 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 popupVisible_ = false;
429 // get dimensions of completion prefix
433 cur.inset().completionPosAndDim(cur, x, y, dim);
435 // and calculate the rect of the popup
437 if (popup()->layoutDirection() == Qt::RightToLeft)
438 rect = QRect(x + dim.width() - 200, y - dim.ascent() - 3, 200, dim.height() + 6);
440 rect = QRect(x, y - dim.ascent() - 3, 200, dim.height() + 6);
442 // Resize the columns in the popup.
443 // This should really be in the constructor. But somehow the treeview
444 // has a bad memory about it and we have to tell him again and again.
445 QTreeView * listView = static_cast<QTreeView *>(popup());
446 listView->header()->setStretchLastSection(false);
447 listView->header()->setResizeMode(0, QHeaderView::Stretch);
448 listView->header()->setResizeMode(1, QHeaderView::Fixed);
449 listView->header()->resizeSection(1, 22);
456 void GuiCompleter::updateAvailability()
458 // this should really only be of interest if no completion is
459 // visible yet, i.e. especially if automatic completion is disabled.
460 if (inlineVisible() || popupVisible())
462 Cursor & cur = gui_->bufferView().cursor();
463 if (!popupPossible(cur) && !inlinePossible(cur))
466 updateModel(cur, false, false);
470 void GuiCompleter::updateModel(Cursor & cur, bool popupUpdate, bool inlineUpdate)
472 // value which should be kept selected
473 QString old = currentCompletion();
474 if (old.length() == 0)
475 old = last_selection_;
479 if (cur.inTexted()) {
480 Paragraph const & par = cur.paragraph();
482 par.getFontSettings(cur.bv().buffer().params(), cur.pos());
483 rtl = font.isVisibleRightToLeft();
485 popup()->setLayoutDirection(rtl ? Qt::RightToLeft : Qt::LeftToRight);
488 CompletionList const * list = cur.inset().createCompletionList(cur);
489 model_->setList(list);
492 setModelSorting(QCompleter::CaseSensitivelySortedModel);
494 setModelSorting(QCompleter::UnsortedModel);
497 QString newPrefix = toqstr(cur.inset().completionPrefix(cur));
498 if (newPrefix != completionPrefix())
499 setCompletionPrefix(newPrefix);
505 // restore old selection
506 setCurrentCompletion(old);
508 // if popup is not empty, the new selection will
509 // be our last valid one
510 if (popupVisible() || inlineVisible()) {
511 QString const & s = currentCompletion();
515 last_selection_ = old;
518 // show inline completion
520 updateInline(cur, currentCompletion());
524 void GuiCompleter::showPopup(Cursor & cur)
526 if (!popupPossible(cur))
529 updateModel(cur, true, inlineVisible());
533 void GuiCompleter::hidePopup(Cursor &)
535 popupVisible_ = false;
537 if (popup_timer_.isActive())
540 // hide popup asynchronously because we might be here inside of
541 // LFUN dispatchers. Hiding a popup can trigger a focus event on the
542 // workarea which then redisplays the cursor. But the metrics are not
543 // yet up to date such that the coord cache has not all insets yet. The
544 // cursorPos methods would triggers asserts in the coord cache then.
545 QTimer::singleShot(0, this, SLOT(asyncHidePopup()));
547 // mark that the asynchronous part will reset the model
548 if (!inlineVisible())
549 modelActive_ = false;
553 void GuiCompleter::asyncHidePopup()
556 if (!inlineVisible())
561 void GuiCompleter::showInline(Cursor & cur)
563 if (!inlinePossible(cur))
566 updateModel(cur, popupVisible(), true);
570 void GuiCompleter::hideInline(Cursor & cur)
572 gui_->bufferView().setInlineCompletion(cur, DocIterator(cur.buffer()), docstring());
573 inlineVisible_ = false;
575 if (inline_timer_.isActive())
576 inline_timer_.stop();
578 // Trigger asynchronous part of hideInline. We might be
579 // in a dispatcher here and the setModel call might
580 // trigger focus events which is are not healthy here.
581 QTimer::singleShot(0, this, SLOT(asyncHideInline()));
583 // mark that the asynchronous part will reset the model
585 modelActive_ = false;
589 void GuiCompleter::asyncHideInline()
596 void GuiCompleter::showPopup()
598 Cursor cur = gui_->bufferView().cursor();
599 cur.updateFlags(Update::None);
604 if (cur.disp_.update())
605 gui_->bufferView().processUpdateFlags(cur.disp_.update());
609 void GuiCompleter::showInline()
611 Cursor cur = gui_->bufferView().cursor();
612 cur.updateFlags(Update::None);
617 if (cur.disp_.update())
618 gui_->bufferView().processUpdateFlags(cur.disp_.update());
622 void GuiCompleter::hidePopup()
624 Cursor cur = gui_->bufferView().cursor();
625 cur.updateFlags(Update::None);
630 if (cur.disp_.update())
631 gui_->bufferView().processUpdateFlags(cur.disp_.update());
635 void GuiCompleter::hideInline()
637 Cursor cur = gui_->bufferView().cursor();
638 cur.updateFlags(Update::None);
643 if (cur.disp_.update())
644 gui_->bufferView().processUpdateFlags(cur.disp_.update());
648 void GuiCompleter::activate()
650 if (!popupVisible() && !inlineVisible())
653 popupActivated(currentCompletion());
657 void GuiCompleter::tab()
659 BufferView * bv = &gui_->bufferView();
660 Cursor cur = bv->cursor();
661 cur.updateFlags(Update::None);
663 // check that inline completion is active
664 if (!inlineVisible() && !uniqueCompletionAvailable()) {
665 // try to activate the inline completion
666 if (cur.inset().inlineCompletionSupported(cur)) {
669 // show popup without delay because the completion was not unique
670 if (lyxrc.completion_popup_after_complete
672 && popup()->model()->rowCount() > 1)
673 popup_timer_.start(0);
678 if (!popupVisible() && cur.inset().completionSupported(cur)) {
686 // Make undo possible
689 // If completion is active, at least complete by one character
690 docstring prefix = cur.inset().completionPrefix(cur);
691 docstring completion = qstring_to_ucs4(currentCompletion());
692 if (completion.size() <= prefix.size()) {
693 // finalize completion
694 cur.inset().insertCompletion(cur, docstring(), true);
696 // hide popup and inline completion
699 updateVisibility(false, false);
702 docstring nextchar = completion.substr(prefix.size(), 1);
703 if (!cur.inset().insertCompletion(cur, nextchar, false))
707 // try to complete as far as it is unique
708 docstring longestCompletion = longestUniqueCompletion();
709 prefix = cur.inset().completionPrefix(cur);
710 docstring postfix = longestCompletion.substr(min(longestCompletion.size(), prefix.size()));
711 cur.inset().insertCompletion(cur, postfix, false);
712 old_cursor_ = bv->cursor();
715 // show popup without delay because the completion was not unique
716 if (lyxrc.completion_popup_after_complete
718 && popup()->model()->rowCount() > 1)
719 popup_timer_.start(0);
722 if (cur.disp_.update())
723 gui_->bufferView().processUpdateFlags(cur.disp_.update());
727 QString GuiCompleter::currentCompletion() const
729 if (!popup()->selectionModel()->hasSelection())
732 // Not sure if this is bug in Qt: currentIndex() always
733 // return the first element in the list.
734 QModelIndex idx = popup()->currentIndex();
735 return popup()->model()->data(idx, Qt::EditRole).toString();
739 void GuiCompleter::setCurrentCompletion(QString const & s)
741 QAbstractItemModel const & model = *popup()->model();
742 size_t n = model.rowCount();
746 // select the first if s is empty
747 if (s.length() == 0) {
749 popup()->setCurrentIndex(model.index(0, 0));
754 // find old selection in model
756 if (modelSorting() == QCompleter::UnsortedModel) {
757 // In unsorted models, iterate through list until the s is found
758 for (i = 0; i < n; ++i) {
760 = model.data(model.index(i, 0), Qt::EditRole).toString();
765 // In sorted models, do binary search for s.
768 while (r >= l && l < int(n)) {
769 size_t mid = (r + l) / 2;
771 = model.data(model.index(mid, 0),
772 Qt::EditRole).toString();
775 // FIXME: is this really the same order that the docstring
776 // from the CompletionList has?
777 int c = s.compare(mids, Qt::CaseSensitive);
785 // middle is not far enough
792 // loop was left without finding anything
797 LASSERT(i <= n, /**/);
800 // select the first if none was found
805 popup()->setCurrentIndex(model.index(i, 0));
810 size_t commonPrefix(QString const & s1, QString const & s2)
812 // find common prefix
814 size_t n1 = s1.length();
815 size_t n2 = s2.length();
816 for (j = 0; j < n1 && j < n2; ++j) {
817 if (s1.at(j) != s2.at(j))
824 docstring GuiCompleter::longestUniqueCompletion() const
826 QAbstractItemModel const & model = *popup()->model();
827 size_t n = model.rowCount();
830 QString s = model.data(model.index(0, 0), Qt::EditRole).toString();
832 if (modelSorting() == QCompleter::UnsortedModel) {
833 // For unsorted model we cannot do more than iteration.
834 // Iterate through the completions and cut off where s differs
835 for (size_t i = 0; i < n && s.length() > 0; ++i) {
837 = model.data(model.index(i, 0), Qt::EditRole).toString();
839 s = s.left(commonPrefix(is, s));
842 // For sorted models we can do binary search multiple times,
843 // each time to find the first string which has s not as prefix.
845 while (i < n && s.length() > 0) {
846 // find first string that does not have s as prefix
847 // via binary search in [i,n-1]
850 // get common prefix with the middle string
851 size_t mid = (r + i) / 2;
853 = model.data(model.index(mid, 0),
854 Qt::EditRole).toString();
855 size_t oldLen = s.length();
856 size_t len = commonPrefix(mids, s);
861 // middle is not far enough
864 // middle is maybe too far
867 } while (r - i > 0 && i < n);
871 return qstring_to_ucs4(s);
875 void GuiCompleter::popupActivated(const QString & completion)
877 Cursor cur = gui_->bufferView().cursor();
878 cur.updateFlags(Update::None);
882 docstring prefix = cur.inset().completionPrefix(cur);
883 docstring postfix = qstring_to_ucs4(completion.mid(prefix.length()));
884 cur.inset().insertCompletion(cur, postfix, true);
888 if (cur.disp_.update())
889 gui_->bufferView().processUpdateFlags(cur.disp_.update());
893 void GuiCompleter::popupHighlighted(const QString & completion)
898 Cursor cur = gui_->bufferView().cursor();
899 cur.updateFlags(Update::None);
902 updateInline(cur, completion);
904 if (cur.disp_.update())
905 gui_->bufferView().processUpdateFlags(cur.disp_.update());
908 } // namespace frontend
911 #include "moc_GuiCompleter.cpp"