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 "GuiWorkArea.h"
16 #include "BufferView.h"
18 #include "Dimension.h"
19 #include "FuncRequest.h"
23 #include "Paragraph.h"
26 #include "support/debug.h"
28 #include <QApplication>
29 #include <QAbstractListModel>
30 #include <QHeaderView>
32 #include <QPixmapCache>
34 #include <QItemDelegate>
39 using namespace lyx::support;
44 class RtlItemDelegate : public QItemDelegate {
46 explicit RtlItemDelegate(QObject * parent = 0)
47 : QItemDelegate(parent) {}
49 void setEnabled(bool enabled = true)
55 virtual void drawDisplay(QPainter * painter,
56 QStyleOptionViewItem const & option,
57 QRect const & rect, QString const & text) const
60 return QItemDelegate::drawDisplay(painter, option, rect, text);
62 // FIXME: do this more elegantly
63 docstring stltext = qstring_to_ucs4(text);
64 reverse(stltext.begin(), stltext.end());
65 QItemDelegate::drawDisplay(painter, option, rect, toqstr(stltext));
73 class PixmapItemDelegate : public QItemDelegate {
75 explicit PixmapItemDelegate(QObject *parent = 0)
76 : QItemDelegate(parent) {}
79 void paint(QPainter *painter, const QStyleOptionViewItem &option,
80 const QModelIndex &index) const
82 QStyleOptionViewItem opt = setOptions(index, option);
83 QVariant value = index.data(Qt::DisplayRole);
84 QPixmap pixmap = qvariant_cast<QPixmap>(value);
88 drawBackground(painter, opt, index);
89 if (!pixmap.isNull()) {
90 const QSize size = pixmap.size();
91 painter->drawPixmap(option.rect.left() + (16 - size.width()) / 2,
92 option.rect.top() + (option.rect.height() - size.height()) / 2,
95 drawFocus(painter, opt, option.rect);
101 class GuiCompletionModel : public QAbstractListModel {
104 GuiCompletionModel(QObject * parent,
105 Inset::CompletionList const * l)
106 : QAbstractListModel(parent), list_(l) {}
108 ~GuiCompletionModel()
114 return list_->sorted();
119 int columnCount(const QModelIndex & /*parent*/ = QModelIndex()) const
124 int rowCount(const QModelIndex & /*parent*/ = QModelIndex()) const
129 return list_->size();
133 QVariant data(const QModelIndex & index, int role) const
138 if (index.row() < 0 || index.row() >= rowCount())
141 if (role != Qt::DisplayRole && role != Qt::EditRole)
144 if (index.column() == 0)
145 return toqstr(list_->data(index.row()));
146 else if (index.column() == 1) {
147 // get icon from cache
149 QString const name = ":" + toqstr(list_->icon(index.row()));
150 if (!QPixmapCache::find("completion" + name, scaled)) {
151 // load icon from disk
152 QPixmap p = QPixmap(name);
154 // scale it to 16x16 or smaller
155 scaled = p.scaled(min(16, p.width()), min(16, p.height()),
156 Qt::KeepAspectRatio, Qt::SmoothTransformation);
159 QPixmapCache::insert("completion" + name, scaled);
168 Inset::CompletionList const * list_;
172 GuiCompleter::GuiCompleter(GuiWorkArea * gui, QObject * parent)
173 : QCompleter(parent), gui_(gui), updateLock_(0),
174 inlineVisible_(false), popupVisible_(false)
176 // Setup the completion popup
177 setModel(new GuiCompletionModel(this, 0));
178 setCompletionMode(QCompleter::PopupCompletion);
182 QTreeView *listView = new QTreeView;
183 listView->setEditTriggers(QAbstractItemView::NoEditTriggers);
184 listView->setHorizontalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
185 listView->setSelectionBehavior(QAbstractItemView::SelectRows);
186 listView->setSelectionMode(QAbstractItemView::SingleSelection);
187 listView->header()->hide();
188 listView->setIndentation(0);
189 listView->setUniformRowHeights(true);
191 popup()->setItemDelegateForColumn(1, new PixmapItemDelegate(this));
192 rtlItemDelegate_ = new RtlItemDelegate(this);
193 popup()->setItemDelegateForColumn(0, rtlItemDelegate_);
195 // create timeout timers
196 popup_timer_.setSingleShot(true);
197 inline_timer_.setSingleShot(true);
198 connect(this, SIGNAL(highlighted(const QString &)),
199 this, SLOT(popupHighlighted(const QString &)));
200 connect(this, SIGNAL(activated(const QString &)),
201 this, SLOT(popupActivated(const QString &)));
202 connect(&popup_timer_, SIGNAL(timeout()),
203 this, SLOT(showPopup()));
204 connect(&inline_timer_, SIGNAL(timeout()),
205 this, SLOT(showInline()));
209 GuiCompleter::~GuiCompleter()
215 bool GuiCompleter::eventFilter(QObject * watched, QEvent * e)
217 // hijack back the tab key from the popup
218 // (which stole it from the workspace before)
219 if (e->type() == QEvent::KeyPress && popupVisible()) {
220 QKeyEvent *ke = static_cast<QKeyEvent *>(e);
230 return QCompleter::eventFilter(watched, e);
234 bool GuiCompleter::popupPossible(Cursor const & cur) const
236 return QApplication::activeWindow()
238 && cur.inset().completionSupported(cur);
242 bool GuiCompleter::inlinePossible(Cursor const & cur) const
244 return cur.inset().inlineCompletionSupported(cur);
248 bool GuiCompleter::completionAvailable() const
250 size_t n = popup()->model()->rowCount();
252 // if there is exactly one, we have to check whether it is a
253 // real completion, i.e. longer than the current prefix.
254 if (n == 1 && completionPrefix() == currentCompletion())
261 bool GuiCompleter::popupVisible() const
263 return popupVisible_;
267 bool GuiCompleter::inlineVisible() const
269 // In fact using BufferView::inlineCompletionPos.empty() should be
270 // here. But unfortunately this information is not good enough
271 // because destructive operations like backspace might invalidate
272 // inlineCompletionPos. But then the completion should stay visible
273 // (i.e. reshown on the next update). Hence be keep this information
274 // in the inlineVisible_ variable.
275 return inlineVisible_;
279 void GuiCompleter::updateVisibility(Cursor & cur, bool start, bool keep, bool cursorInView)
281 // parameters which affect the completion
282 bool moved = cur != old_cursor_;
286 bool possiblePopupState = popupPossible(cur) && cursorInView;
287 bool possibleInlineState = inlinePossible(cur) && cursorInView;
289 // we moved or popup state is not ok for popup?
290 if ((moved && !keep) || !possiblePopupState)
293 // we moved or inline state is not ok for inline completion?
294 if ((moved && !keep) || !possibleInlineState)
297 // we inserted something and are in a possible popup state?
298 if (!popupVisible() && possiblePopupState && start
299 && cur.inset().automaticPopupCompletion())
300 popup_timer_.start(int(lyxrc.completion_popup_delay * 1000));
302 // we inserted something and are in a possible inline completion state?
303 if (!inlineVisible() && possibleInlineState && start
304 && cur.inset().automaticInlineCompletion())
305 inline_timer_.start(int(lyxrc.completion_inline_delay * 1000));
307 // update prefix if any completion is possible
308 bool modelActive = model()->rowCount() > 0;
309 if (possiblePopupState || possibleInlineState) {
313 updateAvailability();
318 void GuiCompleter::updateVisibility(bool start, bool keep)
320 Cursor cur = gui_->bufferView().cursor();
321 cur.updateFlags(Update::None);
323 updateVisibility(cur, start, keep);
325 if (cur.disp_.update())
326 gui_->bufferView().processUpdateFlags(cur.disp_.update());
330 void GuiCompleter::updatePrefix(Cursor & cur)
332 // get new prefix. Do nothing if unchanged
333 QString newPrefix = toqstr(cur.inset().completionPrefix(cur));
334 if (newPrefix == completionPrefix())
337 // value which should be kept selected
338 QString old = currentCompletion();
339 if (old.length() == 0)
340 old = last_selection_;
342 // update completer to new prefix
343 setCompletionPrefix(newPrefix);
345 // update popup because its size might have changed
349 // restore old selection
350 setCurrentCompletion(old);
352 // if popup is not empty, the new selection will
353 // be our last valid one
354 QString const & s = currentCompletion();
355 if (popupVisible() || inlineVisible()) {
359 last_selection_ = old;
362 // update inline completion because the default
363 // completion string might have changed
365 updateInline(cur, s);
369 void GuiCompleter::updateInline(Cursor & cur, QString const & completion)
371 if (!cur.inset().inlineCompletionSupported(cur))
375 docstring prefix = cur.inset().completionPrefix(cur);
376 docstring postfix = from_utf8(fromqstr(completion.mid(prefix.length())));
378 // shorten it if necessary
379 if (lyxrc.completion_inline_dots != -1
380 && postfix.size() > unsigned(lyxrc.completion_inline_dots))
381 postfix = postfix.substr(0, lyxrc.completion_inline_dots - 1) + "...";
383 // set inline completion at cursor position
384 size_t uniqueTo = max(longestUniqueCompletion().size(), prefix.size());
385 gui_->bufferView().setInlineCompletion(cur, cur, postfix, uniqueTo - prefix.size());
386 inlineVisible_ = true;
390 void GuiCompleter::updatePopup(Cursor & cur)
392 if (!cur.inset().completionSupported(cur))
395 popupVisible_ = true;
397 if (completionCount() == 0) {
398 QTimer::singleShot(0, popup(), SLOT(hide()));
402 // show asynchronously to avoid lookups before the metrics
403 // have been computed. This can happen because we might be in
404 // the middle of a dispatch.
405 QTimer::singleShot(0, this, SLOT(asyncCompletePopup()));
409 void GuiCompleter::asyncCompletePopup()
411 Cursor cur = gui_->bufferView().cursor();
412 if (!cur.inset().completionSupported(cur)) {
413 popupVisible_ = false;
417 // get dimensions of completion prefix
421 cur.inset().completionPosAndDim(cur, x, y, dim);
423 // and calculate the rect of the popup
425 if (popup()->layoutDirection() == Qt::RightToLeft)
426 rect = QRect(x + dim.width() - 200, y - dim.ascent() - 3, 200, dim.height() + 6);
428 rect = QRect(x, y - dim.ascent() - 3, 200, dim.height() + 6);
430 // Resize the columns in the popup.
431 // This should really be in the constructor. But somehow the treeview
432 // has a bad memory about it and we have to tell him again and again.
433 QTreeView * listView = static_cast<QTreeView *>(popup());
434 listView->header()->setStretchLastSection(false);
435 listView->header()->setResizeMode(0, QHeaderView::Stretch);
436 listView->header()->setResizeMode(1, QHeaderView::Fixed);
437 listView->header()->resizeSection(1, 22);
444 void GuiCompleter::updateAvailability()
446 // this should really only be of interest if no completion is
447 // visible yet, i.e. especially if automatic completion is disabled.
448 if (inlineVisible() || popupVisible())
450 Cursor & cur = gui_->bufferView().cursor();
451 if (!popupPossible(cur) && !inlinePossible(cur))
454 updateModel(cur, false, false);
458 void GuiCompleter::updateModel(Cursor & cur, bool popupUpdate, bool inlineUpdate)
460 // value which should be kept selected
461 QString old = currentCompletion();
462 if (old.length() == 0)
463 old = last_selection_;
467 if (cur.inTexted()) {
468 Paragraph const & par = cur.paragraph();
470 par.getFontSettings(cur.bv().buffer().params(), cur.pos());
471 rtl = font.isVisibleRightToLeft();
473 popup()->setLayoutDirection(rtl ? Qt::RightToLeft : Qt::LeftToRight);
475 // turn the direction of the strings in the popup.
476 // Qt does not do that itself.
477 rtlItemDelegate_->setEnabled(rtl);
480 Inset::CompletionList const * list = cur.inset().createCompletionList(cur);
481 setModel(new GuiCompletionModel(this, list));
483 setModelSorting(QCompleter::CaseSensitivelySortedModel);
485 setModelSorting(QCompleter::UnsortedModel);
488 QString newPrefix = toqstr(cur.inset().completionPrefix(cur));
489 if (newPrefix != completionPrefix())
490 setCompletionPrefix(newPrefix);
496 // restore old selection
497 setCurrentCompletion(old);
499 // if popup is not empty, the new selection will
500 // be our last valid one
501 if (popupVisible() || inlineVisible()) {
502 QString const & s = currentCompletion();
506 last_selection_ = old;
509 // show inline completion
511 updateInline(cur, currentCompletion());
515 void GuiCompleter::showPopup(Cursor & cur)
517 if (!popupPossible(cur))
520 updateModel(cur, true, inlineVisible());
524 void GuiCompleter::hidePopup(Cursor & cur)
526 popupVisible_ = false;
528 // hide popup asynchronously because we might be here inside of
529 // LFUN dispatchers. Hiding a popup can trigger a focus event on the
530 // workarea which then redisplays the cursor. But the metrics are not
531 // yet up to date such that the coord cache has not all insets yet. The
532 // cursorPos methods would triggers asserts in the coord cache then.
533 QTimer::singleShot(0, popup(), SLOT(hide()));
535 if (popup_timer_.isActive())
538 if (!inlineVisible())
539 setModel(new GuiCompletionModel(this, 0));
543 void GuiCompleter::showInline(Cursor & cur)
545 if (!inlinePossible(cur))
548 updateModel(cur, popupVisible(), true);
552 void GuiCompleter::hideInline(Cursor & cur)
554 gui_->bufferView().setInlineCompletion(cur, DocIterator(), docstring());
555 inlineVisible_ = false;
557 if (inline_timer_.isActive())
558 inline_timer_.stop();
561 setModel(new GuiCompletionModel(this, 0));
565 void GuiCompleter::showPopup()
567 Cursor cur = gui_->bufferView().cursor();
568 cur.updateFlags(Update::None);
573 if (cur.disp_.update())
574 gui_->bufferView().processUpdateFlags(cur.disp_.update());
578 void GuiCompleter::showInline()
580 Cursor cur = gui_->bufferView().cursor();
581 cur.updateFlags(Update::None);
586 if (cur.disp_.update())
587 gui_->bufferView().processUpdateFlags(cur.disp_.update());
591 void GuiCompleter::hidePopup()
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::hideInline()
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::activate()
619 if (!popupVisible() && !inlineVisible())
622 popupActivated(currentCompletion());
626 void GuiCompleter::tab()
628 BufferView * bv = &gui_->bufferView();
629 Cursor cur = bv->cursor();
630 cur.updateFlags(Update::None);
632 // check that inline completion is active
633 if (!inlineVisible()) {
634 // try to activate the inline completion
635 if (cur.inset().inlineCompletionSupported(cur)) {
638 // show popup without delay because the completion was not unique
639 if (lyxrc.completion_popup_after_complete
641 && popup()->model()->rowCount() > 1)
642 popup_timer_.start(0);
647 if (!popupVisible() && cur.inset().completionSupported(cur)) {
655 // If completion is active, at least complete by one character
656 docstring prefix = cur.inset().completionPrefix(cur);
657 docstring completion = from_utf8(fromqstr(currentCompletion()));
658 if (completion.size() <= prefix.size()) {
659 // finalize completion
660 cur.inset().insertCompletion(cur, docstring(), true);
662 // hide popup and inline completion
665 updateVisibility(false, false);
668 docstring nextchar = completion.substr(prefix.size(), 1);
669 if (!cur.inset().insertCompletion(cur, nextchar, false))
673 // try to complete as far as it is unique
674 docstring longestCompletion = longestUniqueCompletion();
675 prefix = cur.inset().completionPrefix(cur);
676 docstring postfix = longestCompletion.substr(min(longestCompletion.size(), prefix.size()));
677 cur.inset().insertCompletion(cur, postfix, false);
678 old_cursor_ = bv->cursor();
681 // show popup without delay because the completion was not unique
682 if (lyxrc.completion_popup_after_complete
684 && popup()->model()->rowCount() > 1)
685 popup_timer_.start(0);
688 if (cur.disp_.update())
689 gui_->bufferView().processUpdateFlags(cur.disp_.update());
693 QString GuiCompleter::currentCompletion() const
695 if (!popup()->selectionModel()->hasSelection())
698 // Not sure if this is bug in Qt: currentIndex() always
699 // return the first element in the list.
700 QModelIndex idx = popup()->currentIndex();
701 return popup()->model()->data(idx, Qt::EditRole).toString();
705 void GuiCompleter::setCurrentCompletion(QString const & s)
707 QAbstractItemModel const & model = *popup()->model();
708 size_t n = model.rowCount();
712 // select the first if s is empty
713 if (s.length() == 0) {
715 popup()->setCurrentIndex(model.index(0, 0));
720 // find old selection in model
722 if (modelSorting() == QCompleter::UnsortedModel) {
723 // In unsorted models, iterate through list until the s is found
724 for (i = 0; i < n; ++i) {
726 = model.data(model.index(i, 0), Qt::EditRole).toString();
731 // In sorted models, do binary search for s.
734 while (r >= l && l < int(n)) {
735 size_t mid = (r + l) / 2;
737 = model.data(model.index(mid, 0),
738 Qt::EditRole).toString();
741 // FIXME: is this really the same order that the docstring
742 // from the CompletionList has?
743 int c = s.compare(mids, Qt::CaseSensitive);
751 // middle is not far enough
758 // loop was left without finding anything
763 BOOST_ASSERT(0 <= i && i <= n);
766 // select the first if none was found
771 popup()->setCurrentIndex(model.index(i, 0));
776 size_t commonPrefix(QString const & s1, QString const & s2)
778 // find common prefix
780 size_t n1 = s1.length();
781 size_t n2 = s2.length();
782 for (j = 0; j < n1 && j < n2; ++j) {
783 if (s1.at(j) != s2.at(j))
790 docstring GuiCompleter::longestUniqueCompletion() const
792 QAbstractItemModel const & model = *popup()->model();
793 size_t n = model.rowCount();
796 QString s = model.data(model.index(0, 0), Qt::EditRole).toString();
798 if (modelSorting() == QCompleter::UnsortedModel) {
799 // For unsorted model we cannot do more than iteration.
800 // Iterate through the completions and cut off where s differs
801 for (size_t i = 0; i < n && s.length() > 0; ++i) {
803 = model.data(model.index(i, 0), Qt::EditRole).toString();
805 s = s.left(commonPrefix(is, s));
808 // For sorted models we can do binary search multiple times,
809 // each time to find the first string which has s not as prefix.
811 while (i < n && s.length() > 0) {
812 // find first string that does not have s as prefix
813 // via binary search in [i,n-1]
816 // get common prefix with the middle string
817 size_t mid = (r + i) / 2;
819 = model.data(model.index(mid, 0),
820 Qt::EditRole).toString();
821 size_t oldLen = s.length();
822 size_t len = commonPrefix(mids, s);
827 // middle is not far enough
830 // middle is maybe too far
833 } while (r - i > 0 && i < n);
837 return from_utf8(fromqstr(s));
841 void GuiCompleter::popupActivated(const QString & completion)
843 Cursor cur = gui_->bufferView().cursor();
844 cur.updateFlags(Update::None);
846 docstring prefix = cur.inset().completionPrefix(cur);
847 docstring postfix = from_utf8(fromqstr(completion.mid(prefix.length())));
848 cur.inset().insertCompletion(cur, postfix, true);
852 if (cur.disp_.update())
853 gui_->bufferView().processUpdateFlags(cur.disp_.update());
857 void GuiCompleter::popupHighlighted(const QString & completion)
862 Cursor cur = gui_->bufferView().cursor();
863 cur.updateFlags(Update::None);
866 updateInline(cur, completion);
868 if (cur.disp_.update())
869 gui_->bufferView().processUpdateFlags(cur.disp_.update());
872 } // namespace frontend
875 #include "GuiCompleter_moc.cpp"