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) {}
50 virtual void drawDisplay(QPainter * painter,
51 QStyleOptionViewItem const & option,
52 QRect const & rect, QString const & text) const
54 // FIXME: do this more elegantly
55 docstring stltext = qstring_to_ucs4(text);
56 reverse(stltext.begin(), stltext.end());
57 QItemDelegate::drawDisplay(painter, option, rect, toqstr(stltext));
62 class PixmapItemDelegate : public QItemDelegate {
64 explicit PixmapItemDelegate(QObject *parent = 0)
65 : QItemDelegate(parent) {}
68 void paint(QPainter *painter, const QStyleOptionViewItem &option,
69 const QModelIndex &index) const
71 QStyleOptionViewItem opt = setOptions(index, option);
72 QVariant value = index.data(Qt::DisplayRole);
73 QPixmap pixmap = qvariant_cast<QPixmap>(value);
77 drawBackground(painter, opt, index);
78 if (!pixmap.isNull()) {
79 const QSize size = pixmap.size();
80 painter->drawPixmap(option.rect.left() + (16 - size.width()) / 2,
81 option.rect.top() + (option.rect.height() - size.height()) / 2,
84 drawFocus(painter, opt, option.rect);
90 class GuiCompletionModel : public QAbstractListModel {
93 GuiCompletionModel(QObject * parent,
94 Inset::CompletionList const * l)
95 : QAbstractListModel(parent), list_(l) {}
103 return list_->sorted();
108 int columnCount(const QModelIndex & /*parent*/ = QModelIndex()) const
113 int rowCount(const QModelIndex & /*parent*/ = QModelIndex()) const
118 return list_->size();
122 QVariant data(const QModelIndex & index, int role) const
127 if (index.row() < 0 || index.row() >= rowCount())
130 if (role != Qt::DisplayRole && role != Qt::EditRole)
133 if (index.column() == 0) {
134 docstring const word = list_->data(index.row());
136 } else if (index.column() == 1) {
137 // get icon from cache
139 QString const name = ":" + toqstr(list_->icon(index.row()));
140 if (!QPixmapCache::find("completion" + name, scaled)) {
141 // load icon from disk
142 QPixmap p = QPixmap(name);
144 // scale it to 16x16 or smaller
145 scaled = p.scaled(min(16, p.width()), min(16, p.height()),
146 Qt::KeepAspectRatio, Qt::SmoothTransformation);
149 QPixmapCache::insert("completion" + name, scaled);
158 Inset::CompletionList const * list_;
162 GuiCompleter::GuiCompleter(GuiWorkArea * gui, QObject * parent)
163 : QCompleter(parent), gui_(gui), updateLock_(0),
164 inlineVisible_(false)
166 // Setup the completion popup
167 setModel(new GuiCompletionModel(this, 0));
168 setCompletionMode(QCompleter::PopupCompletion);
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);
181 popup()->setItemDelegateForColumn(1, new PixmapItemDelegate(this));
182 rtlItemDelegate_ = new RtlItemDelegate(this);
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::popupVisible() const
239 return popup()->isVisible();
243 bool GuiCompleter::inlineVisible() const
245 // In fact using BufferView::inlineCompletionPos.empty() should be
246 // here. But unfortunately this information is not good enough
247 // because destructive operations like backspace might invalidate
248 // inlineCompletionPos. But then the completion should stay visible
249 // (i.e. reshown on the next update). Hence be keep this information
250 // in the inlineVisible_ variable.
251 return inlineVisible_;
255 void GuiCompleter::updateVisibility(Cursor & cur, bool start, bool keep, bool cursorInView)
257 // parameters which affect the completion
258 bool moved = cur != old_cursor_;
262 bool possiblePopupState = popupPossible(cur) && cursorInView;
263 bool possibleInlineState = inlinePossible(cur) && cursorInView;
265 // we moved or popup state is not ok for popup?
266 if ((moved && !keep) || !possiblePopupState)
269 // we moved or inline state is not ok for inline completion?
270 if ((moved && !keep) || !possibleInlineState)
273 // we inserted something and are in a possible popup state?
274 if (!popupVisible() && possiblePopupState && start
275 && cur.inset().automaticPopupCompletion())
276 popup_timer_.start(int(lyxrc.completion_popup_delay * 1000));
278 // we inserted something and are in a possible inline completion state?
279 if (!inlineVisible() && possibleInlineState && start
280 && cur.inset().automaticInlineCompletion())
281 inline_timer_.start(int(lyxrc.completion_inline_delay * 1000));
283 // update prefix if popup is visible or if it will be visible soon
284 if (popupVisible() || inlineVisible()
285 || popup_timer_.isActive() || inline_timer_.isActive())
290 void GuiCompleter::updateVisibility(bool start, bool keep)
292 Cursor cur = gui_->bufferView().cursor();
293 cur.updateFlags(Update::None);
295 updateVisibility(cur, start, keep);
297 if (cur.disp_.update())
298 gui_->bufferView().processUpdateFlags(cur.disp_.update());
302 void GuiCompleter::updatePrefix(Cursor & cur)
304 // get new prefix. Do nothing if unchanged
305 QString newPrefix = toqstr(cur.inset().completionPrefix(cur));
306 if (newPrefix == completionPrefix())
309 // value which should be kept selected
310 QString old = currentCompletion();
311 if (old.length() == 0)
312 old = last_selection_;
314 // update completer to new prefix
315 setCompletionPrefix(newPrefix);
317 // update popup because its size might have changed
321 // restore old selection
322 setCurrentCompletion(old);
324 // if popup is not empty, the new selection will
325 // be our last valid one
326 QString const & s = currentCompletion();
330 last_selection_ = old;
332 // update inline completion because the default
333 // completion string might have changed
335 updateInline(cur, s);
339 void GuiCompleter::updateInline(Cursor & cur, QString const & completion)
341 if (!cur.inset().inlineCompletionSupported(cur))
345 docstring prefix = cur.inset().completionPrefix(cur);
346 docstring postfix = from_utf8(fromqstr(completion.mid(prefix.length())));
348 // shorten it if necessary
349 if (lyxrc.completion_inline_dots != -1
350 && postfix.size() > unsigned(lyxrc.completion_inline_dots))
351 postfix = postfix.substr(0, lyxrc.completion_inline_dots - 1) + "...";
353 // set inline completion at cursor position
354 size_t uniqueTo = max(longestUniqueCompletion().size(), prefix.size());
355 gui_->bufferView().setInlineCompletion(cur, cur, postfix, uniqueTo - prefix.size());
356 inlineVisible_ = true;
360 void GuiCompleter::updatePopup(Cursor & cur)
362 if (!cur.inset().completionSupported(cur))
365 if (completionCount() == 0)
368 // get dimensions of completion prefix
372 cur.inset().completionPosAndDim(cur, x, y, dim);
374 // and calculate the rect of the popup
376 if (popup()->layoutDirection() == Qt::RightToLeft)
377 rect = QRect(x + dim.width() - 200, y - dim.ascent() - 3, 200, dim.height() + 6);
379 rect = QRect(x, y - dim.ascent() - 3, 200, dim.height() + 6);
382 QTreeView * p = static_cast<QTreeView *>(popup());
383 p->setColumnWidth(0, popup()->width() - 22 - p->verticalScrollBar()->width());
389 void GuiCompleter::updateModel(Cursor & cur, bool popupUpdate, bool inlineUpdate)
391 // value which should be kept selected
392 QString old = currentCompletion();
393 if (old.length() == 0)
394 old = last_selection_;
398 if (cur.inTexted()) {
399 Paragraph const & par = cur.paragraph();
401 par.getFontSettings(cur.bv().buffer().params(), cur.pos());
402 rtl = font.isVisibleRightToLeft();
404 popup()->setLayoutDirection(rtl ? Qt::RightToLeft : Qt::LeftToRight);
406 // turn the direction of the strings in the popup.
407 // Qt does not do that itself.
408 popup()->setItemDelegateForColumn(0, rtl ? rtlItemDelegate_ : 0);
411 Inset::CompletionList const * list = cur.inset().createCompletionList(cur);
412 setModel(new GuiCompletionModel(this, list));
414 setModelSorting(QCompleter::CaseSensitivelySortedModel);
416 setModelSorting(QCompleter::UnsortedModel);
419 QString newPrefix = toqstr(cur.inset().completionPrefix(cur));
420 if (newPrefix != completionPrefix())
421 setCompletionPrefix(newPrefix);
427 // restore old selection
428 setCurrentCompletion(old);
430 // if popup is not empty, the new selection will
431 // be our last valid one
432 QString const & s = currentCompletion();
436 last_selection_ = old;
438 // show inline completion
440 updateInline(cur, currentCompletion());
444 void GuiCompleter::showPopup(Cursor & cur)
446 if (!popupPossible(cur))
449 updateModel(cur, true, inlineVisible());
453 void GuiCompleter::hidePopup(Cursor & cur)
456 if (popup_timer_.isActive())
461 void GuiCompleter::showInline(Cursor & cur)
463 if (!inlinePossible(cur))
466 updateModel(cur, popupVisible(), true);
470 void GuiCompleter::hideInline(Cursor & cur)
472 gui_->bufferView().setInlineCompletion(cur, DocIterator(), docstring());
473 inlineVisible_ = false;
477 void GuiCompleter::showPopup()
479 Cursor cur = gui_->bufferView().cursor();
480 cur.updateFlags(Update::None);
485 if (cur.disp_.update())
486 gui_->bufferView().processUpdateFlags(cur.disp_.update());
490 void GuiCompleter::showInline()
492 Cursor cur = gui_->bufferView().cursor();
493 cur.updateFlags(Update::None);
498 if (cur.disp_.update())
499 gui_->bufferView().processUpdateFlags(cur.disp_.update());
503 void GuiCompleter::hidePopup()
505 Cursor cur = gui_->bufferView().cursor();
506 cur.updateFlags(Update::None);
511 if (cur.disp_.update())
512 gui_->bufferView().processUpdateFlags(cur.disp_.update());
516 void GuiCompleter::hideInline()
518 Cursor cur = gui_->bufferView().cursor();
519 cur.updateFlags(Update::None);
524 if (cur.disp_.update())
525 gui_->bufferView().processUpdateFlags(cur.disp_.update());
529 void GuiCompleter::activate()
531 if (!popupVisible() && !inlineVisible())
534 popupActivated(currentCompletion());
538 void GuiCompleter::tab()
540 BufferView * bv = &gui_->bufferView();
541 Cursor cur = bv->cursor();
542 cur.updateFlags(Update::None);
544 // check that inline completion is active
545 if (!inlineVisible()) {
546 // try to activate the inline completion
547 if (cur.inset().inlineCompletionSupported(cur)) {
550 // show popup without delay because the completion was not unique
551 if (lyxrc.completion_popup_after_complete
553 && popup()->model()->rowCount() > 1)
554 popup_timer_.start(0);
559 if (!popupVisible() && cur.inset().completionSupported(cur)) {
567 // If completion is active, at least complete by one character
568 docstring prefix = cur.inset().completionPrefix(cur);
569 docstring completion = from_utf8(fromqstr(currentCompletion()));
570 if (completion.size() <= prefix.size()) {
571 // finalize completion
572 cur.inset().insertCompletion(cur, docstring(), true);
574 // hide popup and inline completion
577 updateVisibility(false, false);
580 docstring nextchar = completion.substr(prefix.size(), 1);
581 if (!cur.inset().insertCompletion(cur, nextchar, false))
585 // try to complete as far as it is unique
586 docstring longestCompletion = longestUniqueCompletion();
587 prefix = cur.inset().completionPrefix(cur);
588 docstring postfix = longestCompletion.substr(min(longestCompletion.size(), prefix.size()));
589 cur.inset().insertCompletion(cur, postfix, false);
590 old_cursor_ = bv->cursor();
593 // show popup without delay because the completion was not unique
594 if (lyxrc.completion_popup_after_complete
596 && popup()->model()->rowCount() > 1)
597 popup_timer_.start(0);
600 if (cur.disp_.update())
601 gui_->bufferView().processUpdateFlags(cur.disp_.update());
605 QString GuiCompleter::currentCompletion() const
607 if (!popup()->selectionModel()->hasSelection())
610 // Not sure if this is bug in Qt: currentIndex() always
611 // return the first element in the list.
612 QModelIndex idx = popup()->currentIndex();
613 return popup()->model()->data(idx, Qt::EditRole).toString();
617 void GuiCompleter::setCurrentCompletion(QString const & s)
619 QAbstractItemModel const & model = *popup()->model();
620 size_t n = model.rowCount();
624 // select the first if s is empty
625 if (s.length() == 0) {
627 popup()->setCurrentIndex(model.index(0, 0));
632 // find old selection in model
634 if (modelSorting() == QCompleter::UnsortedModel) {
635 // In unsorted models, iterate through list until the s is found
636 for (i = 0; i < n; ++i) {
638 = model.data(model.index(i, 0), Qt::EditRole).toString();
643 // In sorted models, do binary search for s.
646 while (r >= l && l < int(n)) {
647 size_t mid = (r + l) / 2;
649 = model.data(model.index(mid, 0),
650 Qt::EditRole).toString();
653 // FIXME: is this really the same order that the docstring
654 // from the CompletionList has?
655 int c = s.compare(mids, Qt::CaseSensitive);
663 // middle is not far enough
670 // loop was left without finding anything
675 BOOST_ASSERT(0 <= i && i <= n);
678 // select the first if none was found
683 popup()->setCurrentIndex(model.index(i, 0));
688 size_t commonPrefix(QString const & s1, QString const & s2)
690 // find common prefix
692 size_t n1 = s1.length();
693 size_t n2 = s2.length();
694 for (j = 0; j < n1 && j < n2; ++j) {
695 if (s1.at(j) != s2.at(j))
702 docstring GuiCompleter::longestUniqueCompletion() const
704 QAbstractItemModel const & model = *popup()->model();
705 QString s = currentCompletion();
706 size_t n = model.rowCount();
708 if (modelSorting() == QCompleter::UnsortedModel) {
709 // For unsorted model we cannot do more than iteration.
710 // Iterate through the completions and cut off where s differs
711 for (size_t i = 0; i < n && s.length() > 0; ++i) {
713 = model.data(model.index(i, 0), Qt::EditRole).toString();
715 s = s.left(commonPrefix(is, s));
718 // For sorted models we can do binary search multiple times,
719 // each time to find the first string which has s not as prefix.
721 while (i < n && s.length() > 0) {
722 // find first string that does not have s as prefix
723 // via binary search in [i,n-1]
726 // get common prefix with the middle string
727 size_t mid = (r + i) / 2;
729 = model.data(model.index(mid, 0),
730 Qt::EditRole).toString();
731 size_t oldLen = s.length();
732 size_t len = commonPrefix(mids, s);
737 // middle is not far enough
740 // middle is maybe too far
743 } while (r - i > 0 && i < n);
747 return from_utf8(fromqstr(s));
751 void GuiCompleter::popupActivated(const QString & completion)
753 Cursor cur = gui_->bufferView().cursor();
754 cur.updateFlags(Update::None);
756 docstring prefix = cur.inset().completionPrefix(cur);
757 docstring postfix = from_utf8(fromqstr(completion.mid(prefix.length())));
758 cur.inset().insertCompletion(cur, postfix, true);
762 if (cur.disp_.update())
763 gui_->bufferView().processUpdateFlags(cur.disp_.update());
767 void GuiCompleter::popupHighlighted(const QString & completion)
772 Cursor cur = gui_->bufferView().cursor();
773 cur.updateFlags(Update::None);
776 updateInline(cur, completion);
778 if (cur.disp_.update())
779 gui_->bufferView().processUpdateFlags(cur.disp_.update());
782 } // namespace frontend
785 #include "GuiCompleter_moc.cpp"