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
|
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
****************************************************************************/
#include "keywordscompletionassist.h"
#include <texteditor/codeassist/assistinterface.h>
#include <texteditor/codeassist/genericproposal.h>
#include <texteditor/codeassist/functionhintproposal.h>
#include <texteditor/codeassist/genericproposalmodel.h>
#include <texteditor/completionsettings.h>
#include <texteditor/texteditorsettings.h>
#include <texteditor/texteditorconstants.h>
#include <texteditor/texteditor.h>
#include <utils/algorithm.h>
namespace TextEditor {
// --------------------------
// Keywords
// --------------------------
// Note: variables and functions must be sorted
Keywords::Keywords(const QStringList &variables, const QStringList &functions, const QMap<QString, QStringList> &functionArgs)
: m_variables(variables), m_functions(functions), m_functionArgs(functionArgs)
{
Utils::sort(m_variables);
Utils::sort(m_functions);
}
bool Keywords::isVariable(const QString &word) const
{
return std::binary_search(m_variables.constBegin(), m_variables.constEnd(), word);
}
bool Keywords::isFunction(const QString &word) const
{
return std::binary_search(m_functions.constBegin(), m_functions.constEnd(), word);
}
QStringList Keywords::variables() const
{
return m_variables;
}
QStringList Keywords::functions() const
{
return m_functions;
}
QStringList Keywords::argsForFunction(const QString &function) const
{
return m_functionArgs.value(function);
}
// --------------------------
// KeywordsAssistProposalItem
// --------------------------
KeywordsAssistProposalItem::KeywordsAssistProposalItem(bool isFunction)
: m_isFunction(isFunction)
{
}
bool KeywordsAssistProposalItem::prematurelyApplies(const QChar &c) const
{
// only '(' in case of a function
return c == QLatin1Char('(') && m_isFunction;
}
void KeywordsAssistProposalItem::applyContextualContent(TextDocumentManipulatorInterface &manipulator,
int basePosition) const
{
const CompletionSettings &settings = TextEditorSettings::completionSettings();
int replaceLength = manipulator.currentPosition() - basePosition;
QString toInsert = text();
int cursorOffset = 0;
const QChar characterAtCurrentPosition = manipulator.characterAt(manipulator.currentPosition());
bool setAutoCompleteSkipPosition = false;
if (m_isFunction && settings.m_autoInsertBrackets) {
if (settings.m_spaceAfterFunctionName) {
if (manipulator.textAt(manipulator.currentPosition(), 2) == QLatin1String(" (")) {
cursorOffset = 2;
} else if ( characterAtCurrentPosition == QLatin1Char('(')
|| characterAtCurrentPosition == QLatin1Char(' ')) {
replaceLength += 1;
toInsert += QLatin1String(" (");
} else {
toInsert += QLatin1String(" ()");
cursorOffset = -1;
setAutoCompleteSkipPosition = true;
}
} else {
if (characterAtCurrentPosition == QLatin1Char('(')) {
cursorOffset = 1;
} else {
toInsert += QLatin1String("()");
cursorOffset = -1;
setAutoCompleteSkipPosition = true;
}
}
}
manipulator.replace(basePosition, replaceLength, toInsert);
if (cursorOffset)
manipulator.setCursorPosition(manipulator.currentPosition() + cursorOffset);
if (setAutoCompleteSkipPosition)
manipulator.setAutoCompleteSkipPosition(manipulator.currentPosition());
}
// -------------------------
// KeywordsFunctionHintModel
// -------------------------
KeywordsFunctionHintModel::KeywordsFunctionHintModel(const QStringList &functionSymbols)
: m_functionSymbols(functionSymbols)
{}
void KeywordsFunctionHintModel::reset()
{}
int KeywordsFunctionHintModel::size() const
{
return m_functionSymbols.size();
}
QString KeywordsFunctionHintModel::text(int index) const
{
return m_functionSymbols.at(index);
}
int KeywordsFunctionHintModel::activeArgument(const QString &prefix) const
{
Q_UNUSED(prefix);
return 1;
}
// ---------------------------------
// KeywordsCompletionAssistProcessor
// ---------------------------------
KeywordsCompletionAssistProcessor::KeywordsCompletionAssistProcessor(Keywords keywords)
: m_snippetCollector(QString(), QIcon(":/texteditor/images/snippet.png"))
, m_variableIcon(QLatin1String(":/codemodel/images/keyword.png"))
, m_functionIcon(QLatin1String(":/codemodel/images/member.png"))
, m_keywords(keywords)
{}
IAssistProposal *KeywordsCompletionAssistProcessor::perform(const AssistInterface *interface)
{
QScopedPointer<const AssistInterface> assistInterface(interface);
if (isInComment(interface))
return nullptr;
int pos = interface->position();
// Find start position
QChar chr = interface->characterAt(pos - 1);
if (chr == '(')
--pos;
// Skip to the start of a name
do {
chr = interface->characterAt(--pos);
} while (chr.isLetterOrNumber() || chr == '_');
++pos;
int startPosition = pos;
if (interface->reason() == IdleEditor) {
QChar characterUnderCursor = interface->characterAt(interface->position());
if (characterUnderCursor.isLetterOrNumber())
return nullptr;
if (interface->position() - startPosition < 3)
return nullptr;
}
// extract word
QString word;
do {
word += interface->characterAt(pos);
chr = interface->characterAt(++pos);
} while ((chr.isLetterOrNumber() || chr == '_') && chr != '(');
if (m_keywords.isFunction(word) && interface->characterAt(pos) == '(') {
QStringList functionSymbols = m_keywords.argsForFunction(word);
if (functionSymbols.size() == 0)
return nullptr;
FunctionHintProposalModelPtr model(new KeywordsFunctionHintModel(functionSymbols));
return new FunctionHintProposal(startPosition, model);
} else {
QList<AssistProposalItemInterface *> items = m_snippetCollector.collect();
items.append(generateProposalList(m_keywords.variables(), m_variableIcon));
items.append(generateProposalList(m_keywords.functions(), m_functionIcon));
return new GenericProposal(startPosition, items);
}
}
void KeywordsCompletionAssistProcessor::setSnippetGroup(const QString &id)
{
m_snippetCollector.setGroupId(id);
}
void KeywordsCompletionAssistProcessor::setKeywords(Keywords keywords)
{
m_keywords = keywords;
}
bool KeywordsCompletionAssistProcessor::isInComment(const AssistInterface *interface) const
{
QTextCursor tc(interface->textDocument());
tc.setPosition(interface->position());
tc.movePosition(QTextCursor::StartOfLine, QTextCursor::KeepAnchor);
return tc.selectedText().contains('#');
}
QList<AssistProposalItemInterface *>
KeywordsCompletionAssistProcessor::generateProposalList(const QStringList &words, const QIcon &icon)
{
return Utils::transform(words, [this, &icon](const QString &word) -> AssistProposalItemInterface * {
AssistProposalItem *item = new KeywordsAssistProposalItem(m_keywords.isFunction(word));
item->setText(word);
item->setIcon(icon);
return item;
});
}
KeywordsCompletionAssistProvider::KeywordsCompletionAssistProvider(const Keywords &keyWords,
const QString &snippetGroup)
: m_keyWords(keyWords)
, m_snippetGroup(snippetGroup)
{ }
IAssistProvider::RunType KeywordsCompletionAssistProvider::runType() const
{
return Synchronous;
}
IAssistProcessor *KeywordsCompletionAssistProvider::createProcessor() const
{
auto processor = new KeywordsCompletionAssistProcessor(m_keyWords);
processor->setSnippetGroup(m_snippetGroup);
return processor;
}
} // namespace TextEditor
|
