type Editor … type CallCounts … type buffer … func (b buffer) text() string { … } type EditorConfig … // NewEditor creates a new Editor. func NewEditor(sandbox *Sandbox, config EditorConfig) *Editor { … } // Connect configures the editor to communicate with an LSP server on conn. It // is not concurrency safe, and should be called at most once, before using the // editor. // // It returns the editor, so that it may be called as follows: // // editor, err := NewEditor(s).Connect(ctx, conn, hooks) func (e *Editor) Connect(ctx context.Context, connector servertest.Connector, hooks ClientHooks) (*Editor, error) { … } // DelayedHandler waits [0, maxDelay) before handling each message. func DelayedHandler(maxDelay time.Duration, handler jsonrpc2.Handler) jsonrpc2.Handler { … } func (e *Editor) Stats() CallCounts { … } // Shutdown issues the 'shutdown' LSP notification. func (e *Editor) Shutdown(ctx context.Context) error { … } // Exit issues the 'exit' LSP notification. func (e *Editor) Exit(ctx context.Context) error { … } // Close disconnects the LSP client session. // TODO(rfindley): rename to 'Disconnect'. func (e *Editor) Close(ctx context.Context) error { … } // Client returns the LSP client for this editor. func (e *Editor) Client() *Client { … } // makeSettings builds the settings map for use in LSP settings RPCs. func makeSettings(sandbox *Sandbox, config EditorConfig, scopeURI *protocol.URI) map[string]any { … } func (e *Editor) initialize(ctx context.Context) error { … } func clientCapabilities(cfg EditorConfig) (protocol.ClientCapabilities, error) { … } // Returns the connected LSP server's capabilities. // Only populated after a call to [Editor.Connect]. func (e *Editor) ServerCapabilities() protocol.ServerCapabilities { … } // marshalUnmarshal is a helper to json Marshal and then Unmarshal as a // different type. Used to work around cases where our protocol types are not // specific. func marshalUnmarshal[T any](v any) (T, error) { … } // HasCommand reports whether the connected server supports the command with the given ID. func (e *Editor) HasCommand(cmd command.Command) bool { … } var uriRE … // makeWorkspaceFolders creates a slice of workspace folders to use for // this editing session, based on the editor configuration. func makeWorkspaceFolders(sandbox *Sandbox, paths []string) (folders []protocol.WorkspaceFolder) { … } // onFileChanges is registered to be called by the Workdir on any writes that // go through the Workdir API. It is called synchronously by the Workdir. func (e *Editor) onFileChanges(ctx context.Context, evts []protocol.FileEvent) { … } // OpenFile creates a buffer for the given workdir-relative file. // // If the file is already open, it is a no-op. func (e *Editor) OpenFile(ctx context.Context, path string) error { … } // toWindowsLineEndings checks whether content has windows line endings. // // If so, it returns content unmodified. If not, it returns a new byte slice modified to use CRLF line endings. func toWindowsLineEndings(content []byte) []byte { … } // CreateBuffer creates a new unsaved buffer corresponding to the workdir path, // containing the given textual content. func (e *Editor) CreateBuffer(ctx context.Context, path, content string) error { … } func (e *Editor) createBuffer(ctx context.Context, path string, dirty bool, content []byte) error { … } // textDocumentItem builds a protocol.TextDocumentItem for the given buffer. // // Precondition: e.mu must be held. func (e *Editor) textDocumentItem(buf buffer) protocol.TextDocumentItem { … } func (e *Editor) sendDidOpen(ctx context.Context, item protocol.TextDocumentItem) error { … } var defaultFileAssociations … // languageID returns the language identifier for the path p given the user // configured fileAssociations. func languageID(p string, fileAssociations map[string]string) protocol.LanguageKind { … } // CloseBuffer removes the current buffer (regardless of whether it is saved). // CloseBuffer returns an error if the buffer is not open. func (e *Editor) CloseBuffer(ctx context.Context, path string) error { … } func (e *Editor) sendDidClose(ctx context.Context, doc protocol.TextDocumentIdentifier) error { … } func (e *Editor) DocumentURI(path string) protocol.DocumentURI { … } func (e *Editor) TextDocumentIdentifier(path string) protocol.TextDocumentIdentifier { … } // SaveBuffer writes the content of the buffer specified by the given path to // the filesystem. func (e *Editor) SaveBuffer(ctx context.Context, path string) error { … } func (e *Editor) SaveBufferWithoutActions(ctx context.Context, path string) error { … } var ErrNoMatch … var ErrUnknownBuffer … // regexpLocation returns the location of the first occurrence of either re // or its singular subgroup. It returns ErrNoMatch if the regexp doesn't match. func regexpLocation(mapper *protocol.Mapper, re string) (protocol.Location, error) { … } // RegexpSearch returns the Location of the first match for re in the buffer // bufName. For convenience, RegexpSearch supports the following two modes: // 1. If re has no subgroups, return the position of the match for re itself. // 2. If re has one subgroup, return the position of the first subgroup. // // It returns an error re is invalid, has more than one subgroup, or doesn't // match the buffer. func (e *Editor) RegexpSearch(bufName, re string) (protocol.Location, error) { … } // RegexpReplace edits the buffer corresponding to path by replacing the first // instance of re, or its first subgroup, with the replace text. See // RegexpSearch for more explanation of these two modes. // It returns an error if re is invalid, has more than one subgroup, or doesn't // match the buffer. func (e *Editor) RegexpReplace(ctx context.Context, path, re, replace string) error { … } // EditBuffer applies the given test edits to the buffer identified by path. func (e *Editor) EditBuffer(ctx context.Context, path string, edits []protocol.TextEdit) error { … } func (e *Editor) SetBufferContent(ctx context.Context, path, content string) error { … } // HasBuffer reports whether the file name is open in the editor. func (e *Editor) HasBuffer(name string) bool { … } // BufferText returns the content of the buffer with the given name, or "" if // the file at that path is not open. The second return value reports whether // the file is open. func (e *Editor) BufferText(name string) (string, bool) { … } // Mapper returns the protocol.Mapper for the given buffer name, if it is open. func (e *Editor) Mapper(name string) (*protocol.Mapper, error) { … } // BufferVersion returns the current version of the buffer corresponding to // name (or 0 if it is not being edited). func (e *Editor) BufferVersion(name string) int { … } func (e *Editor) editBufferLocked(ctx context.Context, path string, edits []protocol.TextEdit) error { … } func (e *Editor) setBufferContentLocked(ctx context.Context, path string, dirty bool, content []byte, fromEdits []protocol.TextEdit) error { … } // GoToDefinition jumps to the definition of the symbol at the given position // in an open buffer. It returns the location of the resulting jump. func (e *Editor) Definition(ctx context.Context, loc protocol.Location) (protocol.Location, error) { … } // TypeDefinition jumps to the type definition of the symbol at the given // location in an open buffer. func (e *Editor) TypeDefinition(ctx context.Context, loc protocol.Location) (protocol.Location, error) { … } // extractFirstLocation returns the first location. // It opens the file if needed. func (e *Editor) extractFirstLocation(ctx context.Context, locs []protocol.Location) (protocol.Location, error) { … } // Symbol performs a workspace symbol search using query func (e *Editor) Symbol(ctx context.Context, query string) ([]protocol.SymbolInformation, error) { … } // OrganizeImports requests and performs the source.organizeImports codeAction. func (e *Editor) OrganizeImports(ctx context.Context, path string) error { … } // RefactorRewrite requests and performs the source.refactorRewrite codeAction. func (e *Editor) RefactorRewrite(ctx context.Context, loc protocol.Location) error { … } // ApplyQuickFixes requests and performs the quickfix codeAction. func (e *Editor) ApplyQuickFixes(ctx context.Context, loc protocol.Location, diagnostics []protocol.Diagnostic) error { … } // ApplyCodeAction applies the given code action. func (e *Editor) ApplyCodeAction(ctx context.Context, action protocol.CodeAction) error { … } func (e *Editor) Diagnostics(ctx context.Context, path string) ([]protocol.Diagnostic, error) { … } // GetQuickFixes returns the available quick fix code actions. func (e *Editor) GetQuickFixes(ctx context.Context, loc protocol.Location, diagnostics []protocol.Diagnostic) ([]protocol.CodeAction, error) { … } func (e *Editor) applyCodeActions(ctx context.Context, loc protocol.Location, diagnostics []protocol.Diagnostic, only ...protocol.CodeActionKind) (int, error) { … } func (e *Editor) CodeActions(ctx context.Context, loc protocol.Location, diagnostics []protocol.Diagnostic, only ...protocol.CodeActionKind) ([]protocol.CodeAction, error) { … } func (e *Editor) ExecuteCodeLensCommand(ctx context.Context, path string, cmd command.Command, result any) error { … } // ExecuteCommand makes a workspace/executeCommand request to the connected LSP // server, if any. // // Result contains a pointer to a variable to be populated by json.Unmarshal. func (e *Editor) ExecuteCommand(ctx context.Context, params *protocol.ExecuteCommandParams, result any) error { … } // FormatBuffer gofmts a Go file. func (e *Editor) FormatBuffer(ctx context.Context, path string) error { … } func (e *Editor) checkBufferLocation(loc protocol.Location) error { … } // RunGenerate runs `go generate` non-recursively in the workdir-relative dir // path. It does not report any resulting file changes as a watched file // change, so must be followed by a call to Workdir.CheckForFileChanges once // the generate command has completed. // TODO(rFindley): this shouldn't be necessary anymore. Delete it. func (e *Editor) RunGenerate(ctx context.Context, dir string) error { … } // CodeLens executes a codelens request on the server. func (e *Editor) CodeLens(ctx context.Context, path string) ([]protocol.CodeLens, error) { … } // Completion executes a completion request on the server. func (e *Editor) Completion(ctx context.Context, loc protocol.Location) (*protocol.CompletionList, error) { … } func (e *Editor) SetSuggestionInsertReplaceMode(_ context.Context, useReplaceMode bool) { … } // AcceptCompletion accepts a completion for the given item // at the given position based on the editor's suggestion insert mode. // The server provides separate insert/replace ranges only if the // Editor declares `InsertReplaceSupport` capability during initialization. // Otherwise, it returns a single range and the insert/replace mode is ignored. func (e *Editor) AcceptCompletion(ctx context.Context, loc protocol.Location, item protocol.CompletionItem) error { … } // Symbols executes a workspace/symbols request on the server. func (e *Editor) Symbols(ctx context.Context, sym string) ([]protocol.SymbolInformation, error) { … } // CodeLens executes a codelens request on the server. func (e *Editor) InlayHint(ctx context.Context, path string) ([]protocol.InlayHint, error) { … } // References returns references to the object at loc, as returned by // the connected LSP server. If no server is connected, it returns (nil, nil). func (e *Editor) References(ctx context.Context, loc protocol.Location) ([]protocol.Location, error) { … } // Rename performs a rename of the object at loc to newName, using the // connected LSP server. If no server is connected, it returns nil. func (e *Editor) Rename(ctx context.Context, loc protocol.Location, newName string) error { … } // Implementations returns implementations for the object at loc, as // returned by the connected LSP server. If no server is connected, it returns // (nil, nil). func (e *Editor) Implementations(ctx context.Context, loc protocol.Location) ([]protocol.Location, error) { … } func (e *Editor) SignatureHelp(ctx context.Context, loc protocol.Location) (*protocol.SignatureHelp, error) { … } func (e *Editor) RenameFile(ctx context.Context, oldPath, newPath string) error { … } // renameBuffers renames in-memory buffers affected by the renaming of // oldPath->newPath, returning the resulting text documents that must be closed // and opened over the LSP. func (e *Editor) renameBuffers(oldPath, newPath string) (closed []protocol.TextDocumentIdentifier, opened []protocol.TextDocumentItem, _ error) { … } // applyWorkspaceEdit applies the sequence of document changes in // wsedit to the Editor. // // See also: // - changedFiles in ../../marker/marker_test.go for the // handler used by the marker test to intercept edits. // - cmdClient.applyWorkspaceEdit in ../../../cmd/cmd.go for the // CLI variant. func (e *Editor) applyWorkspaceEdit(ctx context.Context, wsedit *protocol.WorkspaceEdit) error { … } func (e *Editor) applyTextDocumentEdit(ctx context.Context, change protocol.TextDocumentEdit) error { … } // Config returns the current editor configuration. func (e *Editor) Config() EditorConfig { … } func (e *Editor) SetConfig(cfg EditorConfig) { … } // ChangeConfiguration sets the new editor configuration, and if applicable // sends a didChangeConfiguration notification. // // An error is returned if the change notification failed to send. func (e *Editor) ChangeConfiguration(ctx context.Context, newConfig EditorConfig) error { … } // ChangeWorkspaceFolders sets the new workspace folders, and sends a // didChangeWorkspaceFolders notification to the server. // // The given folders must all be unique. func (e *Editor) ChangeWorkspaceFolders(ctx context.Context, folders []string) error { … } // CodeAction executes a codeAction request on the server. // If loc.Range is zero, the whole file is implied. // To reduce distraction, the trigger action (unknown, automatic, invoked) // may affect what actions are offered. func (e *Editor) CodeAction(ctx context.Context, loc protocol.Location, diagnostics []protocol.Diagnostic, trigger protocol.CodeActionTriggerKind) ([]protocol.CodeAction, error) { … } func (e *Editor) EditResolveSupport() (bool, error) { … } // Hover triggers a hover at the given position in an open buffer. // It may return (nil, zero) if no symbol was selected. func (e *Editor) Hover(ctx context.Context, loc protocol.Location) (*protocol.MarkupContent, protocol.Location, error) { … } func (e *Editor) DocumentLink(ctx context.Context, path string) ([]protocol.DocumentLink, error) { … } func (e *Editor) DocumentHighlight(ctx context.Context, loc protocol.Location) ([]protocol.DocumentHighlight, error) { … } // SemanticTokensFull invokes textDocument/semanticTokens/full, and interprets // its result. func (e *Editor) SemanticTokensFull(ctx context.Context, path string) ([]SemanticToken, error) { … } // SemanticTokensRange invokes textDocument/semanticTokens/range, and // interprets its result. func (e *Editor) SemanticTokensRange(ctx context.Context, loc protocol.Location) ([]SemanticToken, error) { … } type SemanticToken … // Note: previously this function elided comment, string, and number tokens. // Instead, filtering of token types should be done by the caller. func (e *Editor) interpretTokens(x []uint32, contents string) []SemanticToken { … }
Codebase Browser
gotools