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);
168 setCaseSensitivity(Qt::CaseInsensitive);
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, bool cursorInView)
292 // parameters which affect the completion
293 bool moved = cur != old_cursor_;
297 bool possiblePopupState = popupPossible(cur) && cursorInView;
298 bool possibleInlineState = inlinePossible(cur) && cursorInView;
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));
318 // no inline completion, hence a metrics update is needed
319 if (!(cur.disp_.update() & Update::Force))
320 cur.updateFlags(cur.disp_.update() | 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.updateFlags(Update::None);
339 updateVisibility(cur, start, keep);
341 if (cur.disp_.update())
342 gui_->bufferView().processUpdateFlags(cur.disp_.update());
346 void GuiCompleter::updatePrefix(Cursor & 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 & 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 & 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 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 listView->header()->setResizeMode(0, QHeaderView::Stretch);
449 listView->header()->setResizeMode(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 & cur = gui_->bufferView().cursor();
464 if (!popupPossible(cur) && !inlinePossible(cur))
467 updateModel(cur, false, false);
471 void GuiCompleter::updateModel(Cursor & 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 & cur)
527 if (!popupPossible(cur))
530 updateModel(cur, true, inlineVisible());
534 void GuiCompleter::hidePopup(Cursor &)
536 popupVisible_ = false;
538 if (popup_timer_.isActive())
541 // hide popup asynchronously because we might be here inside of
542 // LFUN dispatchers. Hiding a popup can trigger a focus event on the
543 // workarea which then redisplays the cursor. But the metrics are not
544 // yet up to date such that the coord cache has not all insets yet. The
545 // cursorPos methods would triggers asserts in the coord cache then.
546 QTimer::singleShot(0, this, SLOT(asyncHidePopup()));
548 // mark that the asynchronous part will reset the model
549 if (!inlineVisible())
550 modelActive_ = false;
554 void GuiCompleter::asyncHidePopup()
557 if (!inlineVisible())
562 void GuiCompleter::showInline(Cursor & cur)
564 if (!inlinePossible(cur))
567 updateModel(cur, popupVisible(), true);
571 void GuiCompleter::hideInline(Cursor & cur)
573 gui_->bufferView().setInlineCompletion(cur, DocIterator(cur.buffer()), docstring());
574 inlineVisible_ = false;
576 if (inline_timer_.isActive())
577 inline_timer_.stop();
579 // Trigger asynchronous part of hideInline. We might be
580 // in a dispatcher here and the setModel call might
581 // trigger focus events which is are not healthy here.
582 QTimer::singleShot(0, this, SLOT(asyncHideInline()));
584 // mark that the asynchronous part will reset the model
586 modelActive_ = false;
590 void GuiCompleter::asyncHideInline()
597 void GuiCompleter::showPopup()
599 Cursor cur = gui_->bufferView().cursor();
600 cur.updateFlags(Update::None);
605 if (cur.disp_.update())
606 gui_->bufferView().processUpdateFlags(cur.disp_.update());
610 void GuiCompleter::showInline()
612 Cursor cur = gui_->bufferView().cursor();
613 cur.updateFlags(Update::None);
618 if (cur.disp_.update())
619 gui_->bufferView().processUpdateFlags(cur.disp_.update());
623 void GuiCompleter::hidePopup()
625 Cursor cur = gui_->bufferView().cursor();
626 cur.updateFlags(Update::None);
631 if (cur.disp_.update())
632 gui_->bufferView().processUpdateFlags(cur.disp_.update());
636 void GuiCompleter::hideInline()
638 Cursor cur = gui_->bufferView().cursor();
639 cur.updateFlags(Update::None);
644 if (cur.disp_.update())
645 gui_->bufferView().processUpdateFlags(cur.disp_.update());
649 void GuiCompleter::activate()
651 if (!popupVisible() && !inlineVisible())
654 popupActivated(currentCompletion());
658 void GuiCompleter::tab()
660 BufferView * bv = &gui_->bufferView();
661 Cursor cur = bv->cursor();
662 cur.updateFlags(Update::None);
664 // check that inline completion is active
665 if (!inlineVisible() && !uniqueCompletionAvailable()) {
666 // try to activate the inline completion
667 if (cur.inset().inlineCompletionSupported(cur)) {
670 // show popup without delay because the completion was not unique
671 if (lyxrc.completion_popup_after_complete
673 && popup()->model()->rowCount() > 1)
674 popup_timer_.start(0);
679 if (!popupVisible() && cur.inset().completionSupported(cur)) {
687 // Make undo possible
690 // If completion is active, at least complete by one character
691 docstring prefix = cur.inset().completionPrefix(cur);
692 docstring completion = qstring_to_ucs4(currentCompletion());
693 if (completion.size() <= prefix.size()) {
694 // finalize completion
695 cur.inset().insertCompletion(cur, docstring(), true);
697 // hide popup and inline completion
700 updateVisibility(false, false);
703 docstring nextchar = completion.substr(prefix.size(), 1);
704 if (!cur.inset().insertCompletion(cur, nextchar, false))
708 // try to complete as far as it is unique
709 docstring longestCompletion = longestUniqueCompletion();
710 prefix = cur.inset().completionPrefix(cur);
711 docstring postfix = longestCompletion.substr(min(longestCompletion.size(), prefix.size()));
712 cur.inset().insertCompletion(cur, postfix, false);
713 old_cursor_ = bv->cursor();
716 // show popup without delay because the completion was not unique
717 if (lyxrc.completion_popup_after_complete
719 && popup()->model()->rowCount() > 1)
720 popup_timer_.start(0);
723 if (cur.disp_.update())
724 gui_->bufferView().processUpdateFlags(cur.disp_.update());
728 QString GuiCompleter::currentCompletion() const
730 if (!popup()->selectionModel()->hasSelection())
733 // Not sure if this is bug in Qt: currentIndex() always
734 // return the first element in the list.
735 QModelIndex idx = popup()->currentIndex();
736 return popup()->model()->data(idx, Qt::EditRole).toString();
740 void GuiCompleter::setCurrentCompletion(QString const & s)
742 QAbstractItemModel const & model = *popup()->model();
743 size_t n = model.rowCount();
747 // select the first if s is empty
748 if (s.length() == 0) {
750 popup()->setCurrentIndex(model.index(0, 0));
755 // find old selection in model
757 if (modelSorting() == QCompleter::UnsortedModel) {
758 // In unsorted models, iterate through list until the s is found
759 for (i = 0; i < n; ++i) {
761 = model.data(model.index(i, 0), Qt::EditRole).toString();
766 // In sorted models, do binary search for s.
769 while (r >= l && l < int(n)) {
770 size_t mid = (r + l) / 2;
772 = model.data(model.index(mid, 0),
773 Qt::EditRole).toString();
776 // FIXME: is this really the same order that the docstring
777 // from the CompletionList has?
778 int c = s.compare(mids, Qt::CaseSensitive);
786 // middle is not far enough
793 // loop was left without finding anything
798 LASSERT(i <= n, /**/);
801 // select the first if none was found
806 popup()->setCurrentIndex(model.index(i, 0));
811 size_t commonPrefix(QString const & s1, QString const & s2)
813 // find common prefix
815 size_t n1 = s1.length();
816 size_t n2 = s2.length();
817 for (j = 0; j < n1 && j < n2; ++j) {
818 if (s1.at(j) != s2.at(j))
825 docstring GuiCompleter::longestUniqueCompletion() const
827 QAbstractItemModel const & model = *popup()->model();
828 size_t n = model.rowCount();
831 QString s = model.data(model.index(0, 0), Qt::EditRole).toString();
833 if (modelSorting() == QCompleter::UnsortedModel) {
834 // For unsorted model we cannot do more than iteration.
835 // Iterate through the completions and cut off where s differs
836 for (size_t i = 0; i < n && s.length() > 0; ++i) {
838 = model.data(model.index(i, 0), Qt::EditRole).toString();
840 s = s.left(commonPrefix(is, s));
843 // For sorted models we can do binary search multiple times,
844 // each time to find the first string which has s not as prefix.
846 while (i < n && s.length() > 0) {
847 // find first string that does not have s as prefix
848 // via binary search in [i,n-1]
851 // get common prefix with the middle string
852 size_t mid = (r + i) / 2;
854 = model.data(model.index(mid, 0),
855 Qt::EditRole).toString();
856 size_t oldLen = s.length();
857 size_t len = commonPrefix(mids, s);
862 // middle is not far enough
865 // middle is maybe too far
868 } while (r - i > 0 && i < n);
872 return qstring_to_ucs4(s);
876 void GuiCompleter::popupActivated(const QString & completion)
878 Cursor cur = gui_->bufferView().cursor();
879 cur.updateFlags(Update::None);
883 docstring prefix = cur.inset().completionPrefix(cur);
884 docstring postfix = qstring_to_ucs4(completion.mid(prefix.length()));
885 cur.inset().insertCompletion(cur, postfix, true);
889 if (cur.disp_.update())
890 gui_->bufferView().processUpdateFlags(cur.disp_.update());
894 void GuiCompleter::popupHighlighted(const QString & completion)
899 Cursor cur = gui_->bufferView().cursor();
900 cur.updateFlags(Update::None);
903 updateInline(cur, completion);
905 if (cur.disp_.update())
906 gui_->bufferView().processUpdateFlags(cur.disp_.update());
909 } // namespace frontend
912 #include "moc_GuiCompleter.cpp"