// Copyright 2019 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 lsp import ( "bytes" "context" "fmt" "os" "path" "golang.org/x/tools/internal/jsonrpc2" "golang.org/x/tools/internal/lsp/debug" "golang.org/x/tools/internal/lsp/protocol" "golang.org/x/tools/internal/lsp/source" "golang.org/x/tools/internal/span" "golang.org/x/tools/internal/telemetry/log" errors "golang.org/x/xerrors" ) func (s *Server) initialize(ctx context.Context, params *protocol.ParamInitialize) (*protocol.InitializeResult, error) { s.stateMu.Lock() state := s.state s.stateMu.Unlock() if state >= serverInitializing { return nil, jsonrpc2.NewErrorf(jsonrpc2.CodeInvalidRequest, "server already initialized") } s.stateMu.Lock() s.state = serverInitializing s.stateMu.Unlock() options := s.session.Options() defer func() { s.session.SetOptions(options) }() // TODO: Handle results here. source.SetOptions(&options, params.InitializationOptions) options.ForClientCapabilities(params.Capabilities) s.pendingFolders = params.WorkspaceFolders if len(s.pendingFolders) == 0 { if params.RootURI != "" { s.pendingFolders = []protocol.WorkspaceFolder{{ URI: params.RootURI, Name: path.Base(params.RootURI), }} } else { // No folders and no root--we are in single file mode. // TODO: https://golang.org/issue/34160. return nil, errors.Errorf("gopls does not yet support editing a single file. Please open a directory.") } } var codeActionProvider interface{} if ca := params.Capabilities.TextDocument.CodeAction; len(ca.CodeActionLiteralSupport.CodeActionKind.ValueSet) > 0 { // If the client has specified CodeActionLiteralSupport, // send the code actions we support. // // Using CodeActionOptions is only valid if codeActionLiteralSupport is set. codeActionProvider = &protocol.CodeActionOptions{ CodeActionKinds: s.getSupportedCodeActions(), } } else { codeActionProvider = true } // This used to be interface{}, when r could be nil var renameOpts protocol.RenameOptions r := params.Capabilities.TextDocument.Rename renameOpts = protocol.RenameOptions{ PrepareProvider: r.PrepareSupport, } return &protocol.InitializeResult{ Capabilities: protocol.ServerCapabilities{ CodeActionProvider: codeActionProvider, CompletionProvider: protocol.CompletionOptions{ TriggerCharacters: []string{"."}, }, DefinitionProvider: true, TypeDefinitionProvider: true, ImplementationProvider: true, DocumentFormattingProvider: true, DocumentSymbolProvider: true, ExecuteCommandProvider: protocol.ExecuteCommandOptions{ Commands: options.SupportedCommands, }, FoldingRangeProvider: true, HoverProvider: true, DocumentHighlightProvider: true, DocumentLinkProvider: protocol.DocumentLinkOptions{}, ReferencesProvider: true, RenameProvider: renameOpts, SignatureHelpProvider: protocol.SignatureHelpOptions{ TriggerCharacters: []string{"(", ","}, }, TextDocumentSync: &protocol.TextDocumentSyncOptions{ Change: options.TextDocumentSyncKind, OpenClose: true, Save: protocol.SaveOptions{ IncludeText: false, }, }, Workspace: protocol.WorkspaceGn{ WorkspaceFolders: protocol.WorkspaceFoldersGn{ Supported: true, ChangeNotifications: "workspace/didChangeWorkspaceFolders", }, }, }, }, nil } func (s *Server) initialized(ctx context.Context, params *protocol.InitializedParams) error { s.stateMu.Lock() s.state = serverInitialized s.stateMu.Unlock() options := s.session.Options() defer func() { s.session.SetOptions(options) }() var registrations []protocol.Registration if options.ConfigurationSupported && options.DynamicConfigurationSupported { registrations = append(registrations, protocol.Registration{ ID: "workspace/didChangeConfiguration", Method: "workspace/didChangeConfiguration", }, protocol.Registration{ ID: "workspace/didChangeWorkspaceFolders", Method: "workspace/didChangeWorkspaceFolders", }, ) } if options.WatchFileChanges && options.DynamicWatchedFilesSupported { registrations = append(registrations, protocol.Registration{ ID: "workspace/didChangeWatchedFiles", Method: "workspace/didChangeWatchedFiles", RegisterOptions: protocol.DidChangeWatchedFilesRegistrationOptions{ Watchers: []protocol.FileSystemWatcher{{ GlobPattern: "**/*.go", Kind: float64(protocol.WatchChange + protocol.WatchDelete + protocol.WatchCreate), }}, }, }) } if len(registrations) > 0 { s.client.RegisterCapability(ctx, &protocol.RegistrationParams{ Registrations: registrations, }) } buf := &bytes.Buffer{} debug.PrintVersionInfo(buf, true, debug.PlainText) log.Print(ctx, buf.String()) viewErrors := make(map[span.URI]error) for _, folder := range s.pendingFolders { uri := span.NewURI(folder.URI) view, workspacePackages, err := s.addView(ctx, folder.Name, span.NewURI(folder.URI)) if err != nil { viewErrors[uri] = err continue } s.diagnoseSnapshot(view.Snapshot(), workspacePackages) } if len(viewErrors) > 0 { errMsg := fmt.Sprintf("Error loading workspace folders (expected %v, got %v)\n", len(s.pendingFolders), len(s.session.Views())) for uri, err := range viewErrors { errMsg += fmt.Sprintf("failed to load view for %s: %v\n", uri, err) } s.client.ShowMessage(ctx, &protocol.ShowMessageParams{ Type: protocol.Error, Message: errMsg, }) } s.pendingFolders = nil return nil } func (s *Server) fetchConfig(ctx context.Context, name string, folder span.URI, o *source.Options) error { if !s.session.Options().ConfigurationSupported { return nil } v := protocol.ParamConfiguration{ ConfigurationParams: protocol.ConfigurationParams{ Items: []protocol.ConfigurationItem{{ ScopeURI: protocol.NewURI(folder), Section: "gopls", }, { ScopeURI: protocol.NewURI(folder), Section: fmt.Sprintf("gopls-%s", name), }}, }, } configs, err := s.client.Configuration(ctx, &v) if err != nil { return err } for _, config := range configs { results := source.SetOptions(o, config) for _, result := range results { if result.Error != nil { s.client.ShowMessage(ctx, &protocol.ShowMessageParams{ Type: protocol.Error, Message: result.Error.Error(), }) } switch result.State { case source.OptionUnexpected: s.client.ShowMessage(ctx, &protocol.ShowMessageParams{ Type: protocol.Error, Message: fmt.Sprintf("unexpected config %s", result.Name), }) case source.OptionDeprecated: msg := fmt.Sprintf("config %s is deprecated", result.Name) if result.Replacement != "" { msg = fmt.Sprintf("%s, use %s instead", msg, result.Replacement) } s.client.ShowMessage(ctx, &protocol.ShowMessageParams{ Type: protocol.Warning, Message: msg, }) } } } return nil } func (s *Server) shutdown(ctx context.Context) error { s.stateMu.Lock() defer s.stateMu.Unlock() if s.state < serverInitialized { return jsonrpc2.NewErrorf(jsonrpc2.CodeInvalidRequest, "server not initialized") } // drop all the active views s.session.Shutdown(ctx) s.state = serverShutDown return nil } func (s *Server) exit(ctx context.Context) error { s.stateMu.Lock() defer s.stateMu.Unlock() if s.state != serverShutDown { os.Exit(1) } os.Exit(0) return nil } func setBool(b *bool, m map[string]interface{}, name string) { if v, ok := m[name].(bool); ok { *b = v } } func setNotBool(b *bool, m map[string]interface{}, name string) { if v, ok := m[name].(bool); ok { *b = !v } }