1 // Copyright 2019 The Go Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style
3 // license that can be found in the LICENSE file.
14 "golang.org/x/tools/internal/jsonrpc2"
15 "golang.org/x/tools/internal/lsp/protocol"
16 "golang.org/x/tools/internal/lsp/source"
17 "golang.org/x/tools/internal/span"
18 errors "golang.org/x/xerrors"
21 // ModificationSource identifies the originating cause of a file modification.
22 type ModificationSource int
25 // FromDidOpen is a file modification caused by opening a file.
26 FromDidOpen = ModificationSource(iota)
28 // FromDidChange is a file modification caused by changing a file.
31 // FromDidChangeWatchedFiles is a file modification caused by a change to a
33 FromDidChangeWatchedFiles
35 // FromDidSave is a file modification caused by a file save.
38 // FromDidClose is a file modification caused by closing a file.
41 // FromRegenerateCgo refers to file modifications caused by regenerating
42 // the cgo sources for the workspace.
45 // FromInitialWorkspaceLoad refers to the loading of all packages in the
46 // workspace when the view is first created.
47 FromInitialWorkspaceLoad
50 func (m ModificationSource) String() string {
55 return "changed files"
56 case FromDidChangeWatchedFiles:
57 return "files changed on disk"
62 case FromRegenerateCgo:
63 return "regenerate cgo"
64 case FromInitialWorkspaceLoad:
65 return "initial workspace load"
67 return "unknown file modification"
71 func (s *Server) didOpen(ctx context.Context, params *protocol.DidOpenTextDocumentParams) error {
72 uri := params.TextDocument.URI.SpanURI()
76 // There may not be any matching view in the current session. If that's
77 // the case, try creating a new view based on the opened file path.
79 // TODO(rstambler): This seems like it would continuously add new
80 // views, but it won't because ViewOf only returns an error when there
81 // are no views in the session. I don't know if that logic should go
82 // here, or if we can continue to rely on that implementation detail.
83 if _, err := s.session.ViewOf(uri); err != nil {
84 dir := filepath.Dir(uri.Filename())
85 if err := s.addFolders(ctx, []protocol.WorkspaceFolder{{
86 URI: string(protocol.URIFromPath(dir)),
87 Name: filepath.Base(dir),
92 return s.didModifyFiles(ctx, []source.FileModification{{
95 Version: params.TextDocument.Version,
96 Text: []byte(params.TextDocument.Text),
97 LanguageID: params.TextDocument.LanguageID,
101 func (s *Server) didChange(ctx context.Context, params *protocol.DidChangeTextDocumentParams) error {
102 uri := params.TextDocument.URI.SpanURI()
107 text, err := s.changedText(ctx, uri, params.ContentChanges)
111 c := source.FileModification{
113 Action: source.Change,
114 Version: params.TextDocument.Version,
117 if err := s.didModifyFiles(ctx, []source.FileModification{c}, FromDidChange); err != nil {
120 return s.warnAboutModifyingGeneratedFiles(ctx, uri)
123 // warnAboutModifyingGeneratedFiles shows a warning if a user tries to edit a
124 // generated file for the first time.
125 func (s *Server) warnAboutModifyingGeneratedFiles(ctx context.Context, uri span.URI) error {
126 s.changedFilesMu.Lock()
127 _, ok := s.changedFiles[uri]
129 s.changedFiles[uri] = struct{}{}
131 s.changedFilesMu.Unlock()
133 // This file has already been edited before.
138 // Ideally, we should be able to specify that a generated file should
139 // be opened as read-only. Tell the user that they should not be
140 // editing a generated file.
141 view, err := s.session.ViewOf(uri)
145 snapshot, release := view.Snapshot(ctx)
146 isGenerated := source.IsGenerated(ctx, snapshot, uri)
152 return s.client.ShowMessage(ctx, &protocol.ShowMessageParams{
153 Message: fmt.Sprintf("Do not edit this file! %s is a generated file.", uri.Filename()),
154 Type: protocol.Warning,
158 func (s *Server) didChangeWatchedFiles(ctx context.Context, params *protocol.DidChangeWatchedFilesParams) error {
159 var modifications []source.FileModification
160 for _, change := range params.Changes {
161 uri := change.URI.SpanURI()
165 action := changeTypeToFileAction(change.Type)
166 modifications = append(modifications, source.FileModification{
172 return s.didModifyFiles(ctx, modifications, FromDidChangeWatchedFiles)
175 func (s *Server) didSave(ctx context.Context, params *protocol.DidSaveTextDocumentParams) error {
176 uri := params.TextDocument.URI.SpanURI()
180 c := source.FileModification{
184 if params.Text != nil {
185 c.Text = []byte(*params.Text)
187 return s.didModifyFiles(ctx, []source.FileModification{c}, FromDidSave)
190 func (s *Server) didClose(ctx context.Context, params *protocol.DidCloseTextDocumentParams) error {
191 uri := params.TextDocument.URI.SpanURI()
195 return s.didModifyFiles(ctx, []source.FileModification{
198 Action: source.Close,
205 func (s *Server) didModifyFiles(ctx context.Context, modifications []source.FileModification, cause ModificationSource) error {
206 // diagnosticWG tracks outstanding diagnostic work as a result of this file
208 var diagnosticWG sync.WaitGroup
209 if s.session.Options().VerboseWorkDoneProgress {
210 work := s.progress.start(ctx, DiagnosticWorkTitle(cause), "Calculating file diagnostics...", nil, nil)
219 // If the set of changes included directories, expand those directories
221 modifications = s.session.ExpandModificationsToDirectories(ctx, modifications)
223 snapshots, releases, err := s.session.DidModifyFiles(ctx, modifications)
228 for snapshot, uris := range snapshots {
230 go func(snapshot source.Snapshot, uris []span.URI) {
231 defer diagnosticWG.Done()
232 s.diagnoseSnapshot(snapshot, uris, cause == FromDidChangeWatchedFiles)
238 for _, release := range releases {
243 // After any file modifications, we need to update our watched files,
244 // in case something changed. Compute the new set of directories to watch,
245 // and if it differs from the current set, send updated registrations.
246 return s.updateWatchedDirectories(ctx)
249 // DiagnosticWorkTitle returns the title of the diagnostic work resulting from a
250 // file change originating from the given cause.
251 func DiagnosticWorkTitle(cause ModificationSource) string {
252 return fmt.Sprintf("diagnosing %v", cause)
255 func (s *Server) changedText(ctx context.Context, uri span.URI, changes []protocol.TextDocumentContentChangeEvent) ([]byte, error) {
256 if len(changes) == 0 {
257 return nil, errors.Errorf("%w: no content changes provided", jsonrpc2.ErrInternal)
260 // Check if the client sent the full content of the file.
261 // We accept a full content change even if the server expected incremental changes.
262 if len(changes) == 1 && changes[0].Range == nil && changes[0].RangeLength == 0 {
263 return []byte(changes[0].Text), nil
265 return s.applyIncrementalChanges(ctx, uri, changes)
268 func (s *Server) applyIncrementalChanges(ctx context.Context, uri span.URI, changes []protocol.TextDocumentContentChangeEvent) ([]byte, error) {
269 fh, err := s.session.GetFile(ctx, uri)
273 content, err := fh.Read()
275 return nil, errors.Errorf("%w: file not found (%v)", jsonrpc2.ErrInternal, err)
277 for _, change := range changes {
278 // Make sure to update column mapper along with the content.
279 converter := span.NewContentConverter(uri.Filename(), content)
280 m := &protocol.ColumnMapper{
282 Converter: converter,
285 if change.Range == nil {
286 return nil, errors.Errorf("%w: unexpected nil range for change", jsonrpc2.ErrInternal)
288 spn, err := m.RangeSpan(*change.Range)
292 if !spn.HasOffset() {
293 return nil, errors.Errorf("%w: invalid range for content change", jsonrpc2.ErrInternal)
295 start, end := spn.Start().Offset(), spn.End().Offset()
297 return nil, errors.Errorf("%w: invalid range for content change", jsonrpc2.ErrInternal)
300 buf.Write(content[:start])
301 buf.WriteString(change.Text)
302 buf.Write(content[end:])
303 content = buf.Bytes()
308 func changeTypeToFileAction(ct protocol.FileChangeType) source.FileAction {
310 case protocol.Changed:
312 case protocol.Created:
314 case protocol.Deleted:
317 return source.UnknownFileAction