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::completionAvailable() const
239 return popup()->model()->rowCount() > 0;
243 bool GuiCompleter::popupVisible() const
245 return popup()->isVisible();
249 bool GuiCompleter::inlineVisible() const
251 // In fact using BufferView::inlineCompletionPos.empty() should be
252 // here. But unfortunately this information is not good enough
253 // because destructive operations like backspace might invalidate
254 // inlineCompletionPos. But then the completion should stay visible
255 // (i.e. reshown on the next update). Hence be keep this information
256 // in the inlineVisible_ variable.
257 return inlineVisible_;
261 void GuiCompleter::updateVisibility(Cursor & cur, bool start, bool keep, bool cursorInView)
263 // parameters which affect the completion
264 bool moved = cur != old_cursor_;
268 bool possiblePopupState = popupPossible(cur) && cursorInView;
269 bool possibleInlineState = inlinePossible(cur) && cursorInView;
271 // we moved or popup state is not ok for popup?
272 if ((moved && !keep) || !possiblePopupState)
275 // we moved or inline state is not ok for inline completion?
276 if ((moved && !keep) || !possibleInlineState)
279 // we inserted something and are in a possible popup state?
280 if (!popupVisible() && possiblePopupState && start
281 && cur.inset().automaticPopupCompletion())
282 popup_timer_.start(int(lyxrc.completion_popup_delay * 1000));
284 // we inserted something and are in a possible inline completion state?
285 if (!inlineVisible() && possibleInlineState && start
286 && cur.inset().automaticInlineCompletion())
287 inline_timer_.start(int(lyxrc.completion_inline_delay * 1000));
289 // update prefix if popup is visible or if it will be visible soon
290 if (popupVisible() || inlineVisible()
291 || popup_timer_.isActive() || inline_timer_.isActive())
296 void GuiCompleter::updateVisibility(bool start, bool keep)
298 Cursor cur = gui_->bufferView().cursor();
299 cur.updateFlags(Update::None);
301 updateVisibility(cur, start, keep);
303 if (cur.disp_.update())
304 gui_->bufferView().processUpdateFlags(cur.disp_.update());
308 void GuiCompleter::updatePrefix(Cursor & cur)
310 // get new prefix. Do nothing if unchanged
311 QString newPrefix = toqstr(cur.inset().completionPrefix(cur));
312 if (newPrefix == completionPrefix())
315 // value which should be kept selected
316 QString old = currentCompletion();
317 if (old.length() == 0)
318 old = last_selection_;
320 // update completer to new prefix
321 setCompletionPrefix(newPrefix);
323 // update popup because its size might have changed
327 // restore old selection
328 setCurrentCompletion(old);
330 // if popup is not empty, the new selection will
331 // be our last valid one
332 QString const & s = currentCompletion();
336 last_selection_ = old;
338 // update inline completion because the default
339 // completion string might have changed
341 updateInline(cur, s);
345 void GuiCompleter::updateInline(Cursor & cur, QString const & completion)
347 if (!cur.inset().inlineCompletionSupported(cur))
351 docstring prefix = cur.inset().completionPrefix(cur);
352 docstring postfix = from_utf8(fromqstr(completion.mid(prefix.length())));
354 // shorten it if necessary
355 if (lyxrc.completion_inline_dots != -1
356 && postfix.size() > unsigned(lyxrc.completion_inline_dots))
357 postfix = postfix.substr(0, lyxrc.completion_inline_dots - 1) + "...";
359 // set inline completion at cursor position
360 size_t uniqueTo = max(longestUniqueCompletion().size(), prefix.size());
361 gui_->bufferView().setInlineCompletion(cur, cur, postfix, uniqueTo - prefix.size());
362 inlineVisible_ = true;
366 void GuiCompleter::updatePopup(Cursor & cur)
368 if (!cur.inset().completionSupported(cur))
371 if (completionCount() == 0)
374 // get dimensions of completion prefix
378 cur.inset().completionPosAndDim(cur, x, y, dim);
380 // and calculate the rect of the popup
382 if (popup()->layoutDirection() == Qt::RightToLeft)
383 rect = QRect(x + dim.width() - 200, y - dim.ascent() - 3, 200, dim.height() + 6);
385 rect = QRect(x, y - dim.ascent() - 3, 200, dim.height() + 6);
388 QTreeView * p = static_cast<QTreeView *>(popup());
389 p->setColumnWidth(0, popup()->width() - 22 - p->verticalScrollBar()->width());
395 void GuiCompleter::updateModel(Cursor & cur, bool popupUpdate, bool inlineUpdate)
397 // value which should be kept selected
398 QString old = currentCompletion();
399 if (old.length() == 0)
400 old = last_selection_;
404 if (cur.inTexted()) {
405 Paragraph const & par = cur.paragraph();
407 par.getFontSettings(cur.bv().buffer().params(), cur.pos());
408 rtl = font.isVisibleRightToLeft();
410 popup()->setLayoutDirection(rtl ? Qt::RightToLeft : Qt::LeftToRight);
412 // turn the direction of the strings in the popup.
413 // Qt does not do that itself.
414 popup()->setItemDelegateForColumn(0, rtl ? rtlItemDelegate_ : 0);
417 Inset::CompletionList const * list = cur.inset().createCompletionList(cur);
418 setModel(new GuiCompletionModel(this, list));
420 setModelSorting(QCompleter::CaseSensitivelySortedModel);
422 setModelSorting(QCompleter::UnsortedModel);
425 QString newPrefix = toqstr(cur.inset().completionPrefix(cur));
426 if (newPrefix != completionPrefix())
427 setCompletionPrefix(newPrefix);
433 // restore old selection
434 setCurrentCompletion(old);
436 // if popup is not empty, the new selection will
437 // be our last valid one
438 QString const & s = currentCompletion();
442 last_selection_ = old;
444 // show inline completion
446 updateInline(cur, currentCompletion());
450 void GuiCompleter::showPopup(Cursor & cur)
452 if (!popupPossible(cur))
455 updateModel(cur, true, inlineVisible());
459 void GuiCompleter::hidePopup(Cursor & cur)
462 if (popup_timer_.isActive())
465 if (!inlineVisible())
466 setModel(new GuiCompletionModel(this, 0));
470 void GuiCompleter::showInline(Cursor & cur)
472 if (!inlinePossible(cur))
475 updateModel(cur, popupVisible(), true);
479 void GuiCompleter::hideInline(Cursor & cur)
481 gui_->bufferView().setInlineCompletion(cur, DocIterator(), docstring());
482 inlineVisible_ = false;
485 setModel(new GuiCompletionModel(this, 0));
489 void GuiCompleter::showPopup()
491 Cursor cur = gui_->bufferView().cursor();
492 cur.updateFlags(Update::None);
497 if (cur.disp_.update())
498 gui_->bufferView().processUpdateFlags(cur.disp_.update());
502 void GuiCompleter::showInline()
504 Cursor cur = gui_->bufferView().cursor();
505 cur.updateFlags(Update::None);
510 if (cur.disp_.update())
511 gui_->bufferView().processUpdateFlags(cur.disp_.update());
515 void GuiCompleter::hidePopup()
517 Cursor cur = gui_->bufferView().cursor();
518 cur.updateFlags(Update::None);
523 if (cur.disp_.update())
524 gui_->bufferView().processUpdateFlags(cur.disp_.update());
528 void GuiCompleter::hideInline()
530 Cursor cur = gui_->bufferView().cursor();
531 cur.updateFlags(Update::None);
536 if (cur.disp_.update())
537 gui_->bufferView().processUpdateFlags(cur.disp_.update());
541 void GuiCompleter::activate()
543 if (!popupVisible() && !inlineVisible())
546 popupActivated(currentCompletion());
550 void GuiCompleter::tab()
552 BufferView * bv = &gui_->bufferView();
553 Cursor cur = bv->cursor();
554 cur.updateFlags(Update::None);
556 // check that inline completion is active
557 if (!inlineVisible()) {
558 // try to activate the inline completion
559 if (cur.inset().inlineCompletionSupported(cur)) {
562 // show popup without delay because the completion was not unique
563 if (lyxrc.completion_popup_after_complete
565 && popup()->model()->rowCount() > 1)
566 popup_timer_.start(0);
571 if (!popupVisible() && cur.inset().completionSupported(cur)) {
579 // If completion is active, at least complete by one character
580 docstring prefix = cur.inset().completionPrefix(cur);
581 docstring completion = from_utf8(fromqstr(currentCompletion()));
582 if (completion.size() <= prefix.size()) {
583 // finalize completion
584 cur.inset().insertCompletion(cur, docstring(), true);
586 // hide popup and inline completion
589 updateVisibility(false, false);
592 docstring nextchar = completion.substr(prefix.size(), 1);
593 if (!cur.inset().insertCompletion(cur, nextchar, false))
597 // try to complete as far as it is unique
598 docstring longestCompletion = longestUniqueCompletion();
599 prefix = cur.inset().completionPrefix(cur);
600 docstring postfix = longestCompletion.substr(min(longestCompletion.size(), prefix.size()));
601 cur.inset().insertCompletion(cur, postfix, false);
602 old_cursor_ = bv->cursor();
605 // show popup without delay because the completion was not unique
606 if (lyxrc.completion_popup_after_complete
608 && popup()->model()->rowCount() > 1)
609 popup_timer_.start(0);
612 if (cur.disp_.update())
613 gui_->bufferView().processUpdateFlags(cur.disp_.update());
617 QString GuiCompleter::currentCompletion() const
619 if (!popup()->selectionModel()->hasSelection())
622 // Not sure if this is bug in Qt: currentIndex() always
623 // return the first element in the list.
624 QModelIndex idx = popup()->currentIndex();
625 return popup()->model()->data(idx, Qt::EditRole).toString();
629 void GuiCompleter::setCurrentCompletion(QString const & s)
631 QAbstractItemModel const & model = *popup()->model();
632 size_t n = model.rowCount();
636 // select the first if s is empty
637 if (s.length() == 0) {
639 popup()->setCurrentIndex(model.index(0, 0));
644 // find old selection in model
646 if (modelSorting() == QCompleter::UnsortedModel) {
647 // In unsorted models, iterate through list until the s is found
648 for (i = 0; i < n; ++i) {
650 = model.data(model.index(i, 0), Qt::EditRole).toString();
655 // In sorted models, do binary search for s.
658 while (r >= l && l < int(n)) {
659 size_t mid = (r + l) / 2;
661 = model.data(model.index(mid, 0),
662 Qt::EditRole).toString();
665 // FIXME: is this really the same order that the docstring
666 // from the CompletionList has?
667 int c = s.compare(mids, Qt::CaseSensitive);
675 // middle is not far enough
682 // loop was left without finding anything
687 BOOST_ASSERT(0 <= i && i <= n);
690 // select the first if none was found
695 popup()->setCurrentIndex(model.index(i, 0));
700 size_t commonPrefix(QString const & s1, QString const & s2)
702 // find common prefix
704 size_t n1 = s1.length();
705 size_t n2 = s2.length();
706 for (j = 0; j < n1 && j < n2; ++j) {
707 if (s1.at(j) != s2.at(j))
714 docstring GuiCompleter::longestUniqueCompletion() const
716 QAbstractItemModel const & model = *popup()->model();
717 QString s = currentCompletion();
718 size_t n = model.rowCount();
720 if (modelSorting() == QCompleter::UnsortedModel) {
721 // For unsorted model we cannot do more than iteration.
722 // Iterate through the completions and cut off where s differs
723 for (size_t i = 0; i < n && s.length() > 0; ++i) {
725 = model.data(model.index(i, 0), Qt::EditRole).toString();
727 s = s.left(commonPrefix(is, s));
730 // For sorted models we can do binary search multiple times,
731 // each time to find the first string which has s not as prefix.
733 while (i < n && s.length() > 0) {
734 // find first string that does not have s as prefix
735 // via binary search in [i,n-1]
738 // get common prefix with the middle string
739 size_t mid = (r + i) / 2;
741 = model.data(model.index(mid, 0),
742 Qt::EditRole).toString();
743 size_t oldLen = s.length();
744 size_t len = commonPrefix(mids, s);
749 // middle is not far enough
752 // middle is maybe too far
755 } while (r - i > 0 && i < n);
759 return from_utf8(fromqstr(s));
763 void GuiCompleter::popupActivated(const QString & completion)
765 Cursor cur = gui_->bufferView().cursor();
766 cur.updateFlags(Update::None);
768 docstring prefix = cur.inset().completionPrefix(cur);
769 docstring postfix = from_utf8(fromqstr(completion.mid(prefix.length())));
770 cur.inset().insertCompletion(cur, postfix, true);
774 if (cur.disp_.update())
775 gui_->bufferView().processUpdateFlags(cur.disp_.update());
779 void GuiCompleter::popupHighlighted(const QString & completion)
784 Cursor cur = gui_->bufferView().cursor();
785 cur.updateFlags(Update::None);
788 updateInline(cur, completion);
790 if (cur.disp_.update())
791 gui_->bufferView().processUpdateFlags(cur.disp_.update());
794 } // namespace frontend
797 #include "GuiCompleter_moc.cpp"