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
|
// Copyright 2018 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
package server
import (
"context"
"fmt"
"strings"
"golang.org/x/tools/gopls/internal/file"
"golang.org/x/tools/gopls/internal/golang"
"golang.org/x/tools/gopls/internal/golang/completion"
"golang.org/x/tools/gopls/internal/label"
"golang.org/x/tools/gopls/internal/protocol"
"golang.org/x/tools/gopls/internal/settings"
"golang.org/x/tools/gopls/internal/telemetry"
"golang.org/x/tools/gopls/internal/template"
"golang.org/x/tools/gopls/internal/work"
"golang.org/x/tools/internal/event"
)
func (s *server) Completion(ctx context.Context, params *protocol.CompletionParams) (_ *protocol.CompletionList, rerr error) {
recordLatency := telemetry.StartLatencyTimer("completion")
defer func() {
recordLatency(ctx, rerr)
}()
ctx, done := event.Start(ctx, "lsp.Server.completion", label.URI.Of(params.TextDocument.URI))
defer done()
fh, snapshot, release, err := s.fileOf(ctx, params.TextDocument.URI)
if err != nil {
return nil, err
}
defer release()
var candidates []completion.CompletionItem
var surrounding *completion.Selection
switch snapshot.FileKind(fh) {
case file.Go:
candidates, surrounding, err = completion.Completion(ctx, snapshot, fh, params.Position, params.Context)
case file.Mod:
candidates, surrounding = nil, nil
case file.Work:
cl, err := work.Completion(ctx, snapshot, fh, params.Position)
if err != nil {
break
}
return cl, nil
case file.Tmpl:
var cl *protocol.CompletionList
cl, err = template.Completion(ctx, snapshot, fh, params.Position, params.Context)
if err != nil {
break // use common error handling, candidates==nil
}
return cl, nil
}
if err != nil {
event.Error(ctx, "no completions found", err, label.Position.Of(params.Position))
}
if candidates == nil || surrounding == nil {
complEmpty.Inc()
return &protocol.CompletionList{
IsIncomplete: true,
Items: []protocol.CompletionItem{},
}, nil
}
// When using deep completions/fuzzy matching, report results as incomplete so
// client fetches updated completions after every key stroke.
options := snapshot.Options()
incompleteResults := options.DeepCompletion || options.Matcher == settings.Fuzzy
items, err := toProtocolCompletionItems(candidates, surrounding, options)
if err != nil {
return nil, err
}
if snapshot.FileKind(fh) == file.Go {
s.saveLastCompletion(fh.URI(), fh.Version(), items, params.Position)
}
if len(items) > 10 {
// TODO(pjw): long completions are ok for field lists
complLong.Inc()
} else {
complShort.Inc()
}
return &protocol.CompletionList{
IsIncomplete: incompleteResults,
Items: items,
}, nil
}
func (s *server) saveLastCompletion(uri protocol.DocumentURI, version int32, items []protocol.CompletionItem, pos protocol.Position) {
s.efficacyMu.Lock()
defer s.efficacyMu.Unlock()
s.efficacyVersion = version
s.efficacyURI = uri
s.efficacyPos = pos
s.efficacyItems = items
}
func toProtocolCompletionItems(candidates []completion.CompletionItem, surrounding *completion.Selection, options *settings.Options) ([]protocol.CompletionItem, error) {
replaceRng, err := surrounding.Range()
if err != nil {
return nil, err
}
insertRng0, err := surrounding.PrefixRange()
if err != nil {
return nil, err
}
suffix := surrounding.Suffix()
var (
items = make([]protocol.CompletionItem, 0, len(candidates))
numDeepCompletionsSeen int
)
for i, candidate := range candidates {
// Limit the number of deep completions to not overwhelm the user in cases
// with dozens of deep completion matches.
if candidate.Depth > 0 {
if !options.DeepCompletion {
continue
}
if numDeepCompletionsSeen >= completion.MaxDeepCompletions {
continue
}
numDeepCompletionsSeen++
}
insertText := candidate.InsertText
if options.InsertTextFormat == protocol.SnippetTextFormat {
insertText = candidate.Snippet()
}
// This can happen if the client has snippets disabled but the
// candidate only supports snippet insertion.
if insertText == "" {
continue
}
doc := &protocol.Or_CompletionItem_documentation{
Value: protocol.MarkupContent{
Kind: protocol.Markdown,
Value: golang.CommentToMarkdown(candidate.Documentation, options),
},
}
if options.PreferredContentFormat != protocol.Markdown {
doc.Value = candidate.Documentation
}
var edits *protocol.Or_CompletionItem_textEdit
if options.InsertReplaceSupported {
insertRng := insertRng0
if suffix == "" || strings.Contains(insertText, suffix) {
insertRng = replaceRng
}
// Insert and Replace ranges share the same start position and
// the same text edit but the end position may differ.
// See the comment for the CompletionItem's TextEdit field.
// https://pkg.go.dev/golang.org/x/tools/gopls/internal/protocol#CompletionItem
edits = &protocol.Or_CompletionItem_textEdit{
Value: protocol.InsertReplaceEdit{
NewText: insertText,
Insert: insertRng, // replace up to the cursor position.
Replace: replaceRng,
},
}
} else {
edits = &protocol.Or_CompletionItem_textEdit{
Value: protocol.TextEdit{
NewText: insertText,
Range: replaceRng,
},
}
}
item := protocol.CompletionItem{
Label: candidate.Label,
Detail: candidate.Detail,
Kind: candidate.Kind,
TextEdit: edits,
InsertTextFormat: &options.InsertTextFormat,
AdditionalTextEdits: candidate.AdditionalTextEdits,
// This is a hack so that the client sorts completion results in the order
// according to their score. This can be removed upon the resolution of
// https://github.com/Microsoft/language-server-protocol/issues/348.
SortText: fmt.Sprintf("%05d", i),
// Trim operators (VSCode doesn't like weird characters in
// filterText).
FilterText: strings.TrimLeft(candidate.InsertText, "&*"),
Preselect: i == 0,
Documentation: doc,
Tags: protocol.NonNilSlice(candidate.Tags),
Deprecated: candidate.Deprecated,
}
items = append(items, item)
}
return items, nil
}
|
