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 return toqstr(list_->data(index.row()));
135 else if (index.column() == 1) {
136 // get icon from cache
138 QString const name = ":" + toqstr(list_->icon(index.row()));
139 if (!QPixmapCache::find("completion" + name, scaled)) {
140 // load icon from disk
141 QPixmap p = QPixmap(name);
143 // scale it to 16x16 or smaller
144 scaled = p.scaled(min(16, p.width()), min(16, p.height()),
145 Qt::KeepAspectRatio, Qt::SmoothTransformation);
148 QPixmapCache::insert("completion" + name, scaled);
157 Inset::CompletionList const * list_;
161 GuiCompleter::GuiCompleter(GuiWorkArea * gui, QObject * parent)
162 : QCompleter(parent), gui_(gui), updateLock_(0),
163 inlineVisible_(false)
165 // Setup the completion popup
166 setModel(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);
180 popup()->setItemDelegateForColumn(1, new PixmapItemDelegate(this));
181 rtlItemDelegate_ = new RtlItemDelegate(this);
183 // create timeout timers
184 popup_timer_.setSingleShot(true);
185 inline_timer_.setSingleShot(true);
186 connect(this, SIGNAL(highlighted(const QString &)),
187 this, SLOT(popupHighlighted(const QString &)));
188 connect(this, SIGNAL(activated(const QString &)),
189 this, SLOT(popupActivated(const QString &)));
190 connect(&popup_timer_, SIGNAL(timeout()),
191 this, SLOT(showPopup()));
192 connect(&inline_timer_, SIGNAL(timeout()),
193 this, SLOT(showInline()));
197 GuiCompleter::~GuiCompleter()
203 bool GuiCompleter::eventFilter(QObject * watched, QEvent * e)
205 // hijack back the tab key from the popup
206 // (which stole it from the workspace before)
207 if (e->type() == QEvent::KeyPress && popupVisible()) {
208 QKeyEvent *ke = static_cast<QKeyEvent *>(e);
218 return QCompleter::eventFilter(watched, e);
222 bool GuiCompleter::popupPossible(Cursor const & cur) const
224 return QApplication::activeWindow()
226 && cur.inset().completionSupported(cur);
230 bool GuiCompleter::inlinePossible(Cursor const & cur) const
232 return cur.inset().inlineCompletionSupported(cur);
236 bool GuiCompleter::popupVisible() const
238 return popup()->isVisible();
242 bool GuiCompleter::inlineVisible() const
244 // In fact using BufferView::inlineCompletionPos.empty() should be
245 // here. But unfortunately this information is not good enough
246 // because destructive operations like backspace might invalidate
247 // inlineCompletionPos. But then the completion should stay visible
248 // (i.e. reshown on the next update). Hence be keep this information
249 // in the inlineVisible_ variable.
250 return inlineVisible_;
254 void GuiCompleter::updateVisibility(Cursor & cur, bool start, bool keep, bool cursorInView)
256 // parameters which affect the completion
257 bool moved = cur != old_cursor_;
261 bool possiblePopupState = popupPossible(cur) && cursorInView;
262 bool possibleInlineState = inlinePossible(cur) && cursorInView;
264 // we moved or popup state is not ok for popup?
265 if ((moved && !keep) || !possiblePopupState) {
266 // stop an old completion timer
267 if (popup_timer_.isActive())
275 // we moved or inline state is not ok for inline completion?
276 if ((moved && !keep) || !possibleInlineState) {
277 // stop an old completion timer
278 if (inline_timer_.isActive())
279 inline_timer_.stop();
281 // hide old inline completion
282 if (inlineVisible()) {
283 gui_->bufferView().setInlineCompletion(cur, DocIterator(), docstring());
284 inlineVisible_ = false;
288 // we inserted something and are in a possible popup state?
289 if (!popupVisible() && possiblePopupState && start
290 && cur.inset().automaticPopupCompletion())
291 popup_timer_.start(int(lyxrc.completion_popup_delay * 1000));
293 // we inserted something and are in a possible inline completion state?
294 if (!inlineVisible() && possibleInlineState && start
295 && cur.inset().automaticInlineCompletion())
296 inline_timer_.start(int(lyxrc.completion_inline_delay * 1000));
298 // update prefix if popup is visible or if it will be visible soon
299 if (popupVisible() || inlineVisible()
300 || popup_timer_.isActive() || inline_timer_.isActive())
305 void GuiCompleter::updateVisibility(bool start, bool keep)
307 Cursor cur = gui_->bufferView().cursor();
308 cur.updateFlags(Update::None);
310 updateVisibility(cur, start, keep);
312 if (cur.disp_.update())
313 gui_->bufferView().processUpdateFlags(cur.disp_.update());
317 void GuiCompleter::updatePrefix(Cursor & cur)
319 // get new prefix. Do nothing if unchanged
320 QString newPrefix = toqstr(cur.inset().completionPrefix(cur));
321 if (newPrefix == completionPrefix())
324 // value which should be kept selected
325 QString old = currentCompletion();
326 if (old.length() == 0)
327 old = last_selection_;
329 // update completer to new prefix
330 setCompletionPrefix(newPrefix);
332 // update popup because its size might have changed
336 // restore old selection
337 setCurrentCompletion(old);
339 // if popup is not empty, the new selection will
340 // be our last valid one
341 QString const & s = currentCompletion();
345 last_selection_ = old;
347 // update inline completion because the default
348 // completion string might have changed
350 updateInline(cur, s);
354 void GuiCompleter::updateInline(Cursor & cur, QString const & completion)
356 if (!cur.inset().inlineCompletionSupported(cur))
360 docstring prefix = cur.inset().completionPrefix(cur);
361 docstring postfix = from_utf8(fromqstr(completion.mid(prefix.length())));
363 // shorten it if necessary
364 if (lyxrc.completion_inline_dots != -1
365 && postfix.size() > unsigned(lyxrc.completion_inline_dots))
366 postfix = postfix.substr(0, lyxrc.completion_inline_dots - 1) + "...";
368 // set inline completion at cursor position
369 size_t uniqueTo = max(longestUniqueCompletion().size(), prefix.size());
370 gui_->bufferView().setInlineCompletion(cur, cur, postfix, uniqueTo - prefix.size());
371 inlineVisible_ = true;
375 void GuiCompleter::updatePopup(Cursor & cur)
377 if (!cur.inset().completionSupported(cur))
380 if (completionCount() == 0)
383 // get dimensions of completion prefix
387 cur.inset().completionPosAndDim(cur, x, y, dim);
389 // and calculate the rect of the popup
391 if (popup()->layoutDirection() == Qt::RightToLeft)
392 rect = QRect(x + dim.width() - 200, y - dim.ascent() - 3, 200, dim.height() + 6);
394 rect = QRect(x, y - dim.ascent() - 3, 200, dim.height() + 6);
398 QTreeView * p = static_cast<QTreeView *>(popup());
399 p->setColumnWidth(0, popup()->width() - 22 - p->verticalScrollBar()->width());
403 void GuiCompleter::updateModel(Cursor & cur, bool popupUpdate, bool inlineUpdate)
405 // value which should be kept selected
406 QString old = currentCompletion();
407 if (old.length() == 0)
408 old = last_selection_;
412 if (cur.inTexted()) {
413 Paragraph const & par = cur.paragraph();
415 par.getFontSettings(cur.bv().buffer().params(), cur.pos());
416 rtl = font.isVisibleRightToLeft();
418 popup()->setLayoutDirection(rtl ? Qt::RightToLeft : Qt::LeftToRight);
420 // turn the direction of the strings in the popup.
421 // Qt does not do that itself.
422 popup()->setItemDelegateForColumn(0, rtl ? rtlItemDelegate_ : 0);
425 Inset::CompletionList const * list = cur.inset().createCompletionList(cur);
426 setModel(new GuiCompletionModel(this, list));
428 setModelSorting(QCompleter::CaseSensitivelySortedModel);
430 setModelSorting(QCompleter::UnsortedModel);
433 QString newPrefix = toqstr(cur.inset().completionPrefix(cur));
434 if (newPrefix != completionPrefix())
435 setCompletionPrefix(newPrefix);
441 // restore old selection
442 setCurrentCompletion(old);
444 // if popup is not empty, the new selection will
445 // be our last valid one
446 QString const & s = currentCompletion();
450 last_selection_ = old;
452 // show inline completion
454 updateInline(cur, currentCompletion());
458 void GuiCompleter::showPopup(Cursor & cur)
460 if (!popupPossible(cur))
463 updateModel(cur, true, inlineVisible());
467 void GuiCompleter::showInline(Cursor & cur)
469 if (!inlinePossible(cur))
472 updateModel(cur, popupVisible(), true);
476 void GuiCompleter::showPopup()
478 Cursor cur = gui_->bufferView().cursor();
479 cur.updateFlags(Update::None);
484 if (cur.disp_.update())
485 gui_->bufferView().processUpdateFlags(cur.disp_.update());
489 void GuiCompleter::showInline()
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::activate()
504 if (!popupVisible() && !inlineVisible())
507 // Complete with current selection in the popup.
508 QString s = currentCompletion();
514 void GuiCompleter::tab()
516 BufferView * bv = &gui_->bufferView();
517 Cursor cur = bv->cursor();
518 cur.updateFlags(Update::None);
520 // check that inline completion is active
521 if (!inlineVisible()) {
522 // try to activate the inline completion
523 if (cur.inset().inlineCompletionSupported(cur)) {
526 // show popup without delay because the completion was not unique
527 if (lyxrc.completion_popup_after_complete
529 && popup()->model()->rowCount() > 1)
530 popup_timer_.start(0);
535 if (!popupVisible() && cur.inset().completionSupported(cur)) {
543 // If completion is active, at least complete by one character
544 docstring prefix = cur.inset().completionPrefix(cur);
545 docstring completion = from_utf8(fromqstr(currentCompletion()));
546 if (completion.size() <= prefix.size()) {
547 // finalize completion
548 cur.inset().insertCompletion(cur, docstring(), true);
550 // hide popup and inline completion
552 gui_->bufferView().setInlineCompletion(cur, DocIterator(), docstring());
553 inlineVisible_ = false;
554 updateVisibility(false, false);
557 docstring nextchar = completion.substr(prefix.size(), 1);
558 if (!cur.inset().insertCompletion(cur, nextchar, false))
562 // try to complete as far as it is unique
563 docstring longestCompletion = longestUniqueCompletion();
564 prefix = cur.inset().completionPrefix(cur);
565 docstring postfix = longestCompletion.substr(min(longestCompletion.size(), prefix.size()));
566 cur.inset().insertCompletion(cur, postfix, false);
567 old_cursor_ = bv->cursor();
570 // show popup without delay because the completion was not unique
571 if (lyxrc.completion_popup_after_complete
573 && popup()->model()->rowCount() > 1)
574 popup_timer_.start(0);
577 if (cur.disp_.update())
578 gui_->bufferView().processUpdateFlags(cur.disp_.update());
582 QString GuiCompleter::currentCompletion() const
584 if (!popup()->selectionModel()->hasSelection())
587 // Not sure if this is bug in Qt: currentIndex() always
588 // return the first element in the list.
589 QModelIndex idx = popup()->currentIndex();
590 return popup()->model()->data(idx, Qt::EditRole).toString();
594 void GuiCompleter::setCurrentCompletion(QString const & s)
596 QAbstractItemModel const & model = *popup()->model();
597 size_t n = model.rowCount();
601 // select the first if s is empty
602 if (s.length() == 0) {
604 popup()->setCurrentIndex(model.index(0, 0));
609 // find old selection in model
611 if (modelSorting() == QCompleter::UnsortedModel) {
612 // In unsorted models, iterate through list until the s is found
613 for (i = 0; i < n; ++i) {
615 = model.data(model.index(i, 0), Qt::EditRole).toString();
620 // In sorted models, do binary search for s.
623 while (r >= i && i < n) {
624 size_t mid = (r + i) / 2;
626 = model.data(model.index(mid, 0),
627 Qt::EditRole).toString();
630 // FIXME: is this really the same order that the docstring
631 // from the CompletionList has?
632 int c = s.compare(mids, Qt::CaseSensitive);
640 // middle is not far enough
647 // loop was left without finding anything
652 // select the first if none was found
657 popup()->setCurrentIndex(model.index(i, 0));
662 size_t commonPrefix(QString const & s1, QString const & s2)
664 // find common prefix
666 size_t n1 = s1.length();
667 size_t n2 = s2.length();
668 for (j = 0; j < n1 && j < n2; ++j) {
669 if (s1.at(j) != s2.at(j))
676 docstring GuiCompleter::longestUniqueCompletion() const
678 QAbstractItemModel const & model = *popup()->model();
679 QString s = currentCompletion();
680 size_t n = model.rowCount();
682 if (modelSorting() == QCompleter::UnsortedModel) {
683 // For unsorted model we cannot do more than iteration.
684 // Iterate through the completions and cut off where s differs
685 for (size_t i = 0; i < n && s.length() > 0; ++i) {
687 = model.data(model.index(i, 0), Qt::EditRole).toString();
689 s = s.left(commonPrefix(is, s));
692 // For sorted models we can do binary search multiple times,
693 // each time to find the first string which has s not as prefix.
695 while (i < n && s.length() > 0) {
696 // find first string that does not have s as prefix
697 // via binary search in [i,n-1]
700 // get common prefix with the middle string
701 size_t mid = (r + i) / 2;
703 = model.data(model.index(mid, 0),
704 Qt::EditRole).toString();
705 size_t oldLen = s.length();
706 size_t len = commonPrefix(mids, s);
711 // middle is not far enough
714 // middle is maybe too far
717 } while (r - i > 0 && i < n);
721 return from_utf8(fromqstr(s));
725 void GuiCompleter::popupActivated(const QString & completion)
727 Cursor cur = gui_->bufferView().cursor();
728 cur.updateFlags(Update::None);
730 docstring prefix = cur.inset().completionPrefix(cur);
731 docstring postfix = from_utf8(fromqstr(completion.mid(prefix.length())));
732 cur.inset().insertCompletion(cur, postfix, true);
733 updateVisibility(cur, false);
735 if (cur.disp_.update())
736 gui_->bufferView().processUpdateFlags(cur.disp_.update());
740 void GuiCompleter::popupHighlighted(const QString & completion)
745 Cursor cur = gui_->bufferView().cursor();
746 cur.updateFlags(Update::None);
749 updateInline(cur, completion);
751 if (cur.disp_.update())
752 gui_->bufferView().processUpdateFlags(cur.disp_.update());
755 } // namespace frontend
758 #include "GuiCompleter_moc.cpp"