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
|
/**************************************************************************
**
** 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 qt-info@nokia.com.
**
**************************************************************************/
#ifndef COMPLETIONCOLLECTORINTERFACE_H
#define COMPLETIONCOLLECTORINTERFACE_H
#include "texteditor_global.h"
#include <QtCore/QObject>
#include <QtCore/QVariant>
#include <QtGui/QIcon>
namespace TextEditor {
namespace Internal {
class ICompletionCollectorPrivate;
}
class ICompletionCollector;
class ITextEditor;
class CompletionSettings;
enum CompletionPolicy
{
QuickFixCompletion, // Used for "Quick Fix" operation.
TextCompletion, // Plain word completion.
SemanticCompletion // Completion using code models.
};
class CompletionItem
{
public:
CompletionItem(ICompletionCollector *collector = 0)
: duplicateCount(0),
order(0),
originalIndex(0),
collector(collector),
isSnippet(false)
{ }
bool isValid() const
{ return collector != 0; }
QString text;
QString details;
QIcon icon;
QVariant data;
int duplicateCount;
int order;
int originalIndex;
ICompletionCollector *collector;
bool isSnippet;
};
/* Defines the interface to completion collectors. A completion collector tells
* the completion support code when a completion is triggered and provides the
* list of possible completions. It keeps an internal state so that it can be
* polled for the list of completions, which is reset with a call to reset.
*/
class TEXTEDITOR_EXPORT ICompletionCollector : public QObject
{
Q_OBJECT
public:
ICompletionCollector(QObject *parent = 0);
virtual ~ICompletionCollector();
const CompletionSettings &completionSettings() const;
virtual QList<CompletionItem> getCompletions();
virtual bool shouldRestartCompletion();
/* Returns the current active ITextEditor */
virtual ITextEditor *editor() const = 0;
virtual int startPosition() const = 0;
/*
* Returns true if this completion collector can be used with the given editor.
*/
virtual bool supportsEditor(ITextEditor *editor) const = 0;
/*
* Returns true if this completion collector supports the given completion policy.
*/
virtual bool supportsPolicy(CompletionPolicy policy) const = 0;
/* This method should return whether the cursor is at a position which could
* trigger an autocomplete. It will be called each time a character is typed in
* the text editor.
*/
virtual bool triggersCompletion(ITextEditor *editor) = 0;
// returns starting position
virtual int startCompletion(ITextEditor *editor) = 0;
/* This method should add all the completions it wants to show into the list,
* based on the given cursor position.
*/
virtual void completions(QList<CompletionItem> *completions) = 0;
/**
* This method should return true when the given typed character should cause
* the selected completion item to be completed.
*/
virtual bool typedCharCompletes(const CompletionItem &item, QChar typedChar) = 0;
/**
* This method should complete the given completion item.
*
* \param typedChar Non-null when completion was triggered by typing a
* character. Possible values depend on typedCharCompletes()
*/
virtual void complete(const CompletionItem &item, QChar typedChar) = 0;
/* This method gives the completion collector a chance to partially complete
* based on a set of items. The general use case is to complete the common
* prefix shared by all possible completion items.
*
* Returns whether the completion popup should be closed.
*/
virtual bool partiallyComplete(const QList<TextEditor::CompletionItem> &completionItems);
virtual void sortCompletion(QList<TextEditor::CompletionItem> &completionItems);
/* Called when it's safe to clean up the completion items.
*/
virtual void cleanup() = 0;
// helpers
void filter(const QList<TextEditor::CompletionItem> &items,
QList<TextEditor::CompletionItem> *filteredItems,
const QString &key);
public slots:
void setCompletionSettings(const TextEditor::CompletionSettings &);
protected:
static bool compareChar(const QChar &item, const QChar &other);
static bool lessThan(const QString &item, const QString &other);
static bool completionItemLessThan(const CompletionItem &item, const CompletionItem &other);
private:
Internal::ICompletionCollectorPrivate *m_d;
};
class TEXTEDITOR_EXPORT IQuickFixCollector : public ICompletionCollector
{
Q_OBJECT
public:
IQuickFixCollector(QObject *parent = 0) : ICompletionCollector(parent) {}
virtual ~IQuickFixCollector() {}
virtual bool typedCharCompletes(const CompletionItem &, QChar)
{ return false; }
virtual void fix(const TextEditor::CompletionItem &item) = 0;
virtual void complete(const CompletionItem &item, QChar typedChar)
{
Q_UNUSED(typedChar)
fix(item);
}
virtual bool triggersCompletion(TextEditor::ITextEditor *)
{ return false; }
virtual bool partiallyComplete(const QList<TextEditor::CompletionItem> &)
{ return false; }
};
} // namespace TextEditor
#endif // COMPLETIONCOLLECTORINTERFACE_H
|
