1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
|
/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (info@qt.nokia.com)
**
**
** GNU Lesser General Public License Usage
**
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this file.
** Please review the following information to ensure the GNU Lesser General
** Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** Other Usage
**
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
** If you have questions regarding the use of this file, please contact
** Nokia at info@qt.nokia.com.
**
**************************************************************************/
#include "genericproposalwidget.h"
#include "iassistprovider.h"
#include "igenericproposalmodel.h"
#include "iassistproposalitem.h"
#include "genericproposal.h"
#include "codeassistant.h"
#include <texteditor/texteditorsettings.h>
#include <texteditor/completionsettings.h>
#include <utils/faketooltip.h>
#include <QtCore/QRect>
#include <QtCore/QLatin1String>
#include <QtCore/QAbstractListModel>
#include <QtCore/QPointer>
#include <QtCore/QDebug>
#include <QtCore/QTimer>
#include <QtGui/QApplication>
#include <QtGui/QVBoxLayout>
#include <QtGui/QListView>
#include <QtGui/QAbstractItemView>
#include <QtGui/QScrollBar>
#include <QtGui/QKeyEvent>
#include <QtGui/QDesktopWidget>
#include <QtGui/QLabel>
namespace TextEditor {
namespace {
QString cleanText(const QString &original)
{
QString clean = original;
int ignore = 0;
for (int i = clean.length() - 1; i >= 0; --i, ++ignore) {
const QChar &c = clean.at(i);
if (c.isLetterOrNumber() || c == QLatin1Char('_'))
break;
}
if (ignore)
clean.chop(ignore);
return clean;
}
bool isPerfectMatch(const QString &prefix, const IGenericProposalModel *model)
{
if (prefix.isEmpty())
return false;
for (int i = 0; i < model->size(); ++i) {
const QString ¤t = cleanText(model->text(i));
if (!current.isEmpty()) {
TextEditor::CaseSensitivity cs =
TextEditor::TextEditorSettings::instance()->completionSettings().m_caseSensitivity;
if (cs == TextEditor::CaseSensitive) {
if (prefix == current)
return true;
} else if (cs == TextEditor::CaseInsensitive) {
if (prefix.compare(current, Qt::CaseInsensitive) == 0)
return true;
} else if (cs == TextEditor::FirstLetterCaseSensitive) {
if (prefix.at(0) == current.at(0)
&& prefix.midRef(1).compare(current.midRef(1), Qt::CaseInsensitive) == 0)
return true;
}
}
}
return false;
}
}
// ------------
// ModelAdapter
// ------------
class ModelAdapter : public QAbstractListModel
{
Q_OBJECT
public:
ModelAdapter(IGenericProposalModel *completionModel, QWidget *parent);
virtual int rowCount(const QModelIndex &) const;
virtual QVariant data(const QModelIndex &index, int role) const;
private:
IGenericProposalModel *m_completionModel;
};
ModelAdapter::ModelAdapter(IGenericProposalModel *completionModel, QWidget *parent)
: QAbstractListModel(parent)
, m_completionModel(completionModel)
{}
int ModelAdapter::rowCount(const QModelIndex &) const
{
return m_completionModel->size();
}
QVariant ModelAdapter::data(const QModelIndex &index, int role) const
{
if (index.row() >= m_completionModel->size())
return QVariant();
if (role == Qt::DisplayRole) {
return m_completionModel->text(index.row());
} else if (role == Qt::DecorationRole) {
return m_completionModel->icon(index.row());
} else if (role == Qt::WhatsThisRole) {
return m_completionModel->detail(index.row());
}
return QVariant();
}
// ------------------------
// GenericProposalInfoFrame
// ------------------------
class GenericProposalInfoFrame : public Utils::FakeToolTip
{
public:
GenericProposalInfoFrame(QWidget *parent = 0)
: Utils::FakeToolTip(parent), m_label(new QLabel(this))
{
QVBoxLayout *layout = new QVBoxLayout(this);
layout->setMargin(0);
layout->setSpacing(0);
layout->addWidget(m_label);
m_label->setForegroundRole(QPalette::ToolTipText);
m_label->setBackgroundRole(QPalette::ToolTipBase);
}
void setText(const QString &text)
{
m_label->setText(text);
}
private:
QLabel *m_label;
};
// -----------------------
// GenericProposalListView
// -----------------------
class GenericProposalListView : public QListView
{
public:
GenericProposalListView(QWidget *parent) : QListView(parent) {}
QSize calculateSize() const;
QPoint infoFramePos() const;
int rowSelected() const { return currentIndex().row(); }
bool isFirstRowSelected() const { return rowSelected() == 0; }
bool isLastRowSelected() const { return rowSelected() == model()->rowCount() - 1; }
void selectRow(int row) { setCurrentIndex(model()->index(row, 0)); }
void selectFirstRow() { selectRow(0); }
void selectLastRow() { selectRow(model()->rowCount() - 1); }
};
QSize GenericProposalListView::calculateSize() const
{
static const int maxVisibleItems = 10;
// Determine size by calculating the space of the visible items
int visibleItems = model()->rowCount();
if (visibleItems > maxVisibleItems)
visibleItems = maxVisibleItems;
const QStyleOptionViewItem &option = viewOptions();
QSize shint;
for (int i = 0; i < visibleItems; ++i) {
QSize tmp = itemDelegate()->sizeHint(option, model()->index(i, 0));
if (shint.width() < tmp.width())
shint = tmp;
}
shint.rheight() *= visibleItems;
return shint;
}
QPoint GenericProposalListView::infoFramePos() const
{
const QRect &r = rectForIndex(currentIndex());
QPoint p((parentWidget()->mapToGlobal(
parentWidget()->rect().topRight())).x() + 3,
mapToGlobal(r.topRight()).y() - verticalOffset()
);
return p;
}
// ----------------------------
// GenericProposalWidgetPrivate
// ----------------------------
class GenericProposalWidgetPrivate : public QObject
{
Q_OBJECT
public:
GenericProposalWidgetPrivate(QWidget *completionWidget);
const QWidget *m_underlyingWidget;
GenericProposalListView *m_completionListView;
IGenericProposalModel *m_model;
QRect m_displayRect;
bool m_isSynchronized;
bool m_explicitlySelected;
AssistReason m_reason;
AssistKind m_kind;
bool m_justInvoked;
QPointer<GenericProposalInfoFrame> m_infoFrame;
QTimer m_infoTimer;
CodeAssistant *m_assistant;
public slots:
void handleActivation(const QModelIndex &modelIndex);
void maybeShowInfoTip();
};
GenericProposalWidgetPrivate::GenericProposalWidgetPrivate(QWidget *completionWidget)
: m_underlyingWidget(0)
, m_completionListView(new GenericProposalListView(completionWidget))
, m_model(0)
, m_isSynchronized(true)
, m_explicitlySelected(false)
, m_justInvoked(false)
, m_assistant(0)
{
connect(m_completionListView, SIGNAL(activated(QModelIndex)),
this, SLOT(handleActivation(QModelIndex)));
m_infoTimer.setInterval(1000);
m_infoTimer.setSingleShot(true);
connect(&m_infoTimer, SIGNAL(timeout()), SLOT(maybeShowInfoTip()));
}
void GenericProposalWidgetPrivate::handleActivation(const QModelIndex &modelIndex)
{
static_cast<GenericProposalWidget *>
(m_completionListView->parent())->notifyActivation(modelIndex.row());
}
void GenericProposalWidgetPrivate::maybeShowInfoTip()
{
const QModelIndex ¤t = m_completionListView->currentIndex();
if (!current.isValid())
return;
const QString &infoTip = current.data(Qt::WhatsThisRole).toString();
if (infoTip.isEmpty()) {
delete m_infoFrame.data();
m_infoTimer.setInterval(200);
return;
}
if (m_infoFrame.isNull())
m_infoFrame = new GenericProposalInfoFrame(m_completionListView);
m_infoFrame->move(m_completionListView->infoFramePos());
m_infoFrame->setText(infoTip);
m_infoFrame->adjustSize();
m_infoFrame->show();
m_infoFrame->raise();
m_infoTimer.setInterval(0);
}
// ------------------------
// GenericProposalWidget
// ------------------------
GenericProposalWidget::GenericProposalWidget()
: d(new GenericProposalWidgetPrivate(this))
{
#ifdef Q_WS_MAC
if (d->m_completionListView->horizontalScrollBar())
d->m_completionListView->horizontalScrollBar()->setAttribute(Qt::WA_MacMiniSize);
if (d->m_completionListView->verticalScrollBar())
d->m_completionListView->verticalScrollBar()->setAttribute(Qt::WA_MacMiniSize);
#else
// This improves the look with QGTKStyle.
setFrameStyle(d->m_completionListView->frameStyle());
#endif
d->m_completionListView->setFrameStyle(QFrame::NoFrame);
d->m_completionListView->setAttribute(Qt::WA_MacShowFocusRect, false);
d->m_completionListView->setUniformItemSizes(true);
d->m_completionListView->setSelectionBehavior(QAbstractItemView::SelectItems);
d->m_completionListView->setSelectionMode(QAbstractItemView::SingleSelection);
d->m_completionListView->setHorizontalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
d->m_completionListView->setMinimumSize(1, 1);
QVBoxLayout *layout = new QVBoxLayout(this);
layout->setMargin(0);
layout->addWidget(d->m_completionListView);
d->m_completionListView->installEventFilter(this);
setObjectName(QLatin1String("m_popupFrame"));
setMinimumSize(1, 1);
}
GenericProposalWidget::~GenericProposalWidget()
{
delete d->m_model;
delete d;
}
void GenericProposalWidget::setAssistant(CodeAssistant *assistant)
{
d->m_assistant = assistant;
}
void GenericProposalWidget::setReason(AssistReason reason)
{
d->m_reason = reason;
if (d->m_reason == ExplicitlyInvoked)
d->m_justInvoked = true;
}
void GenericProposalWidget::setKind(AssistKind kind)
{
d->m_kind = kind;
}
void GenericProposalWidget::setUnderlyingWidget(const QWidget *underlyingWidget)
{
setFont(underlyingWidget->font());
d->m_underlyingWidget = underlyingWidget;
}
void GenericProposalWidget::setModel(IAssistProposalModel *model)
{
delete d->m_model;
d->m_model = static_cast<IGenericProposalModel *>(model);
d->m_completionListView->setModel(new ModelAdapter(d->m_model, d->m_completionListView));
connect(d->m_completionListView->selectionModel(),
SIGNAL(currentChanged(QModelIndex,QModelIndex)),
&d->m_infoTimer,
SLOT(start()));
}
void GenericProposalWidget::setDisplayRect(const QRect &rect)
{
d->m_displayRect = rect;
}
void GenericProposalWidget::setIsSynchronized(bool isSync)
{
d->m_isSynchronized = isSync;
}
void GenericProposalWidget::showProposal(const QString &prefix)
{
ensurePolished();
d->m_model->removeDuplicates();
if (!updateAndCheck(prefix))
return;
show();
d->m_completionListView->setFocus();
}
void GenericProposalWidget::updateProposal(const QString &prefix)
{
if (!isVisible())
return;
updateAndCheck(prefix);
}
void GenericProposalWidget::closeProposal()
{
abort();
}
void GenericProposalWidget::notifyActivation(int index)
{
abort();
emit proposalItemActivated(d->m_model->proposalItem(index));
}
void GenericProposalWidget::abort()
{
if (isVisible())
close();
deleteLater();
}
bool GenericProposalWidget::updateAndCheck(const QString &prefix)
{
// Keep track in the case there has been an explicit selection.
int preferredItemId = -1;
if (d->m_explicitlySelected)
preferredItemId =
d->m_model->persistentId(d->m_completionListView->currentIndex().row());
// Filter, sort, etc.
d->m_model->reset();
if (!prefix.isEmpty())
d->m_model->filter(prefix);
if (d->m_model->size() == 0
|| (!d->m_model->keepPerfectMatch(d->m_reason)
&& isPerfectMatch(prefix, d->m_model))) {
abort();
return false;
}
if (d->m_model->isSortable())
d->m_model->sort();
d->m_completionListView->reset();
// Try to find the previosly explicit selection (if any). If we can find the item set it
// as the current. Otherwise (it might have been filtered out) select the first row.
if (d->m_explicitlySelected) {
Q_ASSERT(preferredItemId != -1);
for (int i = 0; i < d->m_model->size(); ++i) {
if (d->m_model->persistentId(i) == preferredItemId) {
d->m_completionListView->selectRow(i);
break;
}
}
}
if (!d->m_completionListView->currentIndex().isValid()) {
d->m_completionListView->selectFirstRow();
if (d->m_explicitlySelected)
d->m_explicitlySelected = false;
}
if (TextEditorSettings::instance()->completionSettings().m_partiallyComplete
&& d->m_kind == Completion
&& d->m_justInvoked
&& d->m_isSynchronized) {
if (d->m_model->size() == 1) {
IAssistProposalItem *item = d->m_model->proposalItem(0);
if (item->implicitlyApplies()) {
abort();
emit proposalItemActivated(item);
return false;
}
}
if (d->m_model->supportsPrefixExpansion()) {
const QString &proposalPrefix = d->m_model->proposalPrefix();
if (proposalPrefix.length() > prefix.length())
emit prefixExpanded(proposalPrefix);
}
}
if (d->m_justInvoked)
d->m_justInvoked = false;
updatePositionAndSize();
return true;
}
void GenericProposalWidget::updatePositionAndSize()
{
const QSize &shint = d->m_completionListView->calculateSize();
const int fw = frameWidth();
const int width = shint.width() + fw * 2 + 30;
const int height = shint.height() + fw * 2;
// Determine the position, keeping the popup on the screen
const QDesktopWidget *desktop = QApplication::desktop();
#ifdef Q_WS_MAC
const QRect screen = desktop->availableGeometry(desktop->screenNumber(d->m_underlyingWidget));
#else
const QRect screen = desktop->screenGeometry(desktop->screenNumber(d->m_underlyingWidget));
#endif
QPoint pos = d->m_displayRect.bottomLeft();
pos.rx() -= 16 + fw; // Space for the icons
if (pos.y() + height > screen.bottom())
pos.setY(d->m_displayRect.top() - height);
if (pos.x() + width > screen.right())
pos.setX(screen.right() - width);
setGeometry(pos.x(), pos.y(), width, height);
}
bool GenericProposalWidget::eventFilter(QObject *o, QEvent *e)
{
if (e->type() == QEvent::FocusOut) {
abort();
#if defined(Q_OS_DARWIN) && ! defined(QT_MAC_USE_COCOA)
QFocusEvent *fe = static_cast<QFocusEvent *>(e);
if (fe->reason() == Qt::OtherFocusReason) {
// Qt/carbon workaround
// focus out is received before the key press event.
if (d->m_completionListView->currentIndex().isValid())
emit proposalItemActivated(d->m_model->proposalItem(
d->m_completionListView->currentIndex().row()));
}
#endif
if (d->m_infoFrame)
d->m_infoFrame->close();
return true;
} else if (e->type() == QEvent::ShortcutOverride) {
QKeyEvent *ke = static_cast<QKeyEvent *>(e);
switch (ke->key()) {
case Qt::Key_N:
case Qt::Key_P:
if (ke->modifiers() == Qt::ControlModifier) {
e->accept();
return true;
}
}
} else if (e->type() == QEvent::KeyPress) {
QKeyEvent *ke = static_cast<QKeyEvent *>(e);
switch (ke->key()) {
case Qt::Key_Escape:
abort();
return true;
case Qt::Key_N:
case Qt::Key_P:
// select next/previous completion
d->m_explicitlySelected = true;
if (ke->modifiers() == Qt::ControlModifier) {
int change = (ke->key() == Qt::Key_N) ? 1 : -1;
int nrows = d->m_model->size();
int row = d->m_completionListView->currentIndex().row();
int newRow = (row + change + nrows) % nrows;
if (newRow == row + change || !ke->isAutoRepeat())
d->m_completionListView->selectRow(newRow);
return true;
}
break;
case Qt::Key_Tab:
case Qt::Key_Return:
#if defined(QT_MAC_USE_COCOA) || !defined(Q_OS_DARWIN)
abort();
if (d->m_completionListView->currentIndex().isValid())
emit proposalItemActivated(d->m_model->proposalItem(
d->m_completionListView->currentIndex().row()));
#endif
return true;
case Qt::Key_Up:
d->m_explicitlySelected = true;
if (!ke->isAutoRepeat() && d->m_completionListView->isFirstRowSelected()) {
d->m_completionListView->selectLastRow();
return true;
}
return false;
case Qt::Key_Down:
d->m_explicitlySelected = true;
if (!ke->isAutoRepeat() && d->m_completionListView->isLastRowSelected()) {
d->m_completionListView->selectFirstRow();
return true;
}
return false;
case Qt::Key_Enter:
case Qt::Key_PageDown:
case Qt::Key_PageUp:
return false;
case Qt::Key_Right:
case Qt::Key_Left:
case Qt::Key_Home:
case Qt::Key_End:
case Qt::Key_Backspace:
// We want these navigation keys to work in the editor.
break;
default:
// Only forward keys that insert text and refine the completion.
if (ke->text().isEmpty())
return true;
break;
}
if (ke->text().length() == 1
&& d->m_completionListView->currentIndex().isValid()
&& qApp->focusWidget() == o) {
const QChar &typedChar = ke->text().at(0);
IAssistProposalItem *item =
d->m_model->proposalItem(d->m_completionListView->currentIndex().row());
if (item->prematurelyApplies(typedChar)
&& (d->m_reason == ExplicitlyInvoked || item->text().endsWith(typedChar))) {
abort();
emit proposalItemActivated(item);
return true;
}
}
QApplication::sendEvent(const_cast<QWidget *>(d->m_underlyingWidget), e);
if (isVisible())
d->m_assistant->notifyChange();
return true;
}
return false;
}
#include "genericproposalwidget.moc"
} // TextEditor
|