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
|
use hir::PerNs;
use ra_text_edit::{
AtomTextEdit,
TextEdit,
};
use crate::completion::completion_context::CompletionContext;
/// `CompletionItem` describes a single completion variant in the editor pop-up.
/// It is basically a POD with various properties. To construct a
/// `CompletionItem`, use `new` method and the `Builder` struct.
#[derive(Debug)]
pub struct CompletionItem {
/// Used only internally in tests, to check only specific kind of
/// completion.
completion_kind: CompletionKind,
label: String,
kind: Option<CompletionItemKind>,
detail: Option<String>,
lookup: Option<String>,
/// The format of the insert text. The format applies to both the `insert_text` property
/// and the `insert` property of a provided `text_edit`.
insert_text_format: InsertTextFormat,
/// An edit which is applied to a document when selecting this completion. When an edit is
/// provided the value of `insert_text` is ignored.
///
/// *Note:* The range of the edit must be a single line range and it must contain the position
/// at which completion has been requested.
///
/// *Note:* If sending a range that overlaps a string, the string should match the relevant
/// part of the replacement text, or be filtered out.
text_edit: Option<AtomTextEdit>,
/// An optional array of additional text edits that are applied when
/// selecting this completion. Edits must not overlap (including the same insert position)
/// with the main edit nor with themselves.
///
/// Additional text edits should be used to change text unrelated to the current cursor position
/// (for example adding an import statement at the top of the file if the completion item will
/// insert an unqualified type).
additional_text_edits: Option<TextEdit>,
}
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum CompletionItemKind {
Snippet,
Keyword,
Module,
Function,
Struct,
Enum,
EnumVariant,
Binding,
Field,
Static,
Const,
Trait,
TypeAlias,
Method,
}
#[derive(Debug, PartialEq, Eq, Copy, Clone)]
pub(crate) enum CompletionKind {
/// Parser-based keyword completion.
Keyword,
/// Your usual "complete all valid identifiers".
Reference,
/// "Secret sauce" completions.
Magic,
Snippet,
}
#[derive(Debug, PartialEq, Eq, Copy, Clone)]
pub enum InsertTextFormat {
PlainText,
Snippet,
}
impl CompletionItem {
pub(crate) fn new<'a>(
completion_kind: CompletionKind,
ctx: &'a CompletionContext,
label: impl Into<String>,
) -> Builder<'a> {
let label = label.into();
Builder {
ctx,
completion_kind,
label,
insert_text: None,
insert_text_format: InsertTextFormat::PlainText,
detail: None,
lookup: None,
kind: None,
text_edit: None,
additional_text_edits: None,
}
}
/// What user sees in pop-up in the UI.
pub fn label(&self) -> &str {
&self.label
}
/// Short one-line additional information, like a type
pub fn detail(&self) -> Option<&str> {
self.detail.as_ref().map(|it| it.as_str())
}
/// What string is used for filtering.
pub fn lookup(&self) -> &str {
self.lookup
.as_ref()
.map(|it| it.as_str())
.unwrap_or(self.label())
}
pub fn insert_text_format(&self) -> InsertTextFormat {
self.insert_text_format.clone()
}
pub fn kind(&self) -> Option<CompletionItemKind> {
self.kind
}
pub fn text_edit(&mut self) -> Option<&AtomTextEdit> {
self.text_edit.as_ref()
}
pub fn take_additional_text_edits(&mut self) -> Option<TextEdit> {
self.additional_text_edits.take()
}
}
/// A helper to make `CompletionItem`s.
#[must_use]
pub(crate) struct Builder<'a> {
ctx: &'a CompletionContext<'a>,
completion_kind: CompletionKind,
label: String,
insert_text: Option<String>,
insert_text_format: InsertTextFormat,
detail: Option<String>,
lookup: Option<String>,
kind: Option<CompletionItemKind>,
text_edit: Option<AtomTextEdit>,
additional_text_edits: Option<TextEdit>,
}
impl<'a> Builder<'a> {
pub(crate) fn add_to(self, acc: &mut Completions) {
acc.add(self.build())
}
pub(crate) fn build(self) -> CompletionItem {
let self_text_edit = self.text_edit;
let self_insert_text = self.insert_text;
let text_edit = match (self_text_edit, self_insert_text) {
(Some(text_edit), ..) => Some(text_edit),
(None, Some(insert_text)) => {
Some(AtomTextEdit::replace(self.ctx.leaf_range(), insert_text))
}
_ => None,
};
CompletionItem {
label: self.label,
detail: self.detail,
insert_text_format: self.insert_text_format,
lookup: self.lookup,
kind: self.kind,
completion_kind: self.completion_kind,
text_edit,
additional_text_edits: self.additional_text_edits,
}
}
pub(crate) fn lookup_by(mut self, lookup: impl Into<String>) -> Builder<'a> {
self.lookup = Some(lookup.into());
self
}
pub(crate) fn insert_text(mut self, insert_text: impl Into<String>) -> Builder<'a> {
self.insert_text = Some(insert_text.into());
self
}
pub(crate) fn insert_text_format(
mut self,
insert_text_format: InsertTextFormat,
) -> Builder<'a> {
self.insert_text_format = insert_text_format;
self
}
pub(crate) fn snippet(mut self, snippet: impl Into<String>) -> Builder<'a> {
self.insert_text_format = InsertTextFormat::Snippet;
self.insert_text(snippet)
}
pub(crate) fn kind(mut self, kind: CompletionItemKind) -> Builder<'a> {
self.kind = Some(kind);
self
}
pub(crate) fn text_edit(mut self, text_edit: AtomTextEdit) -> Builder<'a> {
self.text_edit = Some(text_edit);
self
}
pub(crate) fn additional_text_edits(mut self, additional_text_edits: TextEdit) -> Builder<'a> {
self.additional_text_edits = Some(additional_text_edits);
self
}
#[allow(unused)]
pub(crate) fn detail(self, detail: impl Into<String>) -> Builder<'a> {
self.set_detail(Some(detail))
}
pub(crate) fn set_detail(mut self, detail: Option<impl Into<String>>) -> Builder<'a> {
self.detail = detail.map(Into::into);
self
}
pub(super) fn from_resolution(
mut self,
ctx: &CompletionContext,
resolution: &hir::Resolution,
) -> Builder<'a> {
let resolved = resolution.def_id.map(|d| d.resolve(ctx.db));
let kind = match resolved {
PerNs {
types: Some(hir::Def::Module(..)),
..
} => CompletionItemKind::Module,
PerNs {
types: Some(hir::Def::Struct(..)),
..
} => CompletionItemKind::Struct,
PerNs {
types: Some(hir::Def::Enum(..)),
..
} => CompletionItemKind::Enum,
PerNs {
types: Some(hir::Def::Trait(..)),
..
} => CompletionItemKind::Trait,
PerNs {
types: Some(hir::Def::Type(..)),
..
} => CompletionItemKind::TypeAlias,
PerNs {
values: Some(hir::Def::Const(..)),
..
} => CompletionItemKind::Const,
PerNs {
values: Some(hir::Def::Static(..)),
..
} => CompletionItemKind::Static,
PerNs {
values: Some(hir::Def::Function(function)),
..
} => return self.from_function(ctx, function),
_ => return self,
};
self.kind = Some(kind);
self
}
pub(super) fn from_function(
mut self,
ctx: &CompletionContext,
function: hir::Function,
) -> Builder<'a> {
// If not an import, add parenthesis automatically.
if ctx.use_item_syntax.is_none() && !ctx.is_call {
if function.signature(ctx.db).params().is_empty() {
self.insert_text = Some(format!("{}()$0", self.label));
} else {
self.insert_text = Some(format!("{}($0)", self.label));
}
self.insert_text_format = InsertTextFormat::Snippet;
}
self.kind = Some(CompletionItemKind::Function);
self
}
}
impl<'a> Into<CompletionItem> for Builder<'a> {
fn into(self) -> CompletionItem {
self.build()
}
}
/// Represents an in-progress set of completions being built.
#[derive(Debug, Default)]
pub(crate) struct Completions {
buf: Vec<CompletionItem>,
}
impl Completions {
pub(crate) fn add(&mut self, item: impl Into<CompletionItem>) {
self.buf.push(item.into())
}
pub(crate) fn add_all<I>(&mut self, items: I)
where
I: IntoIterator,
I::Item: Into<CompletionItem>,
{
items.into_iter().for_each(|item| self.add(item.into()))
}
}
impl Into<Vec<CompletionItem>> for Completions {
fn into(self) -> Vec<CompletionItem> {
self.buf
}
}
#[cfg(test)]
pub(crate) fn check_completion(test_name: &str, code: &str, kind: CompletionKind) {
use crate::mock_analysis::{single_file_with_position, analysis_and_position};
use crate::completion::completions;
use insta::assert_debug_snapshot_matches;
let (analysis, position) = if code.contains("//-") {
analysis_and_position(code)
} else {
single_file_with_position(code)
};
let completions = completions(&analysis.db, position).unwrap();
let completion_items: Vec<CompletionItem> = completions.into();
let kind_completions: Vec<CompletionItem> = completion_items
.into_iter()
.filter(|c| c.completion_kind == kind)
.collect();
assert_debug_snapshot_matches!(test_name, kind_completions);
}
|