-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Support for copilot-generated summaries in quick info. (On-the-fly do…
…cs) (#12552) Off by default, can be explicitly disabled in the setting. Co-authored-by: Ben McMorran <[email protected]> --------- Co-authored-by: Ben McMorran <[email protected]>
- Loading branch information
1 parent
ee71e1f
commit fa80d44
Showing
10 changed files
with
383 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
149 changes: 149 additions & 0 deletions
149
Extension/src/LanguageServer/Providers/CopilotHoverProvider.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,149 @@ | ||
| /* -------------------------------------------------------------------------------------------- | ||
| * Copyright (c) Microsoft Corporation. All Rights Reserved. | ||
| * See 'LICENSE' in the project root for license information. | ||
| * ------------------------------------------------------------------------------------------ */ | ||
| import * as vscode from 'vscode'; | ||
| import { Position, ResponseError } from 'vscode-languageclient'; | ||
| import * as nls from 'vscode-nls'; | ||
| import { DefaultClient, GetCopilotHoverInfoParams, GetCopilotHoverInfoRequest } from '../client'; | ||
| import { RequestCancelled, ServerCancelled } from '../protocolFilter'; | ||
| import { CppSettings } from '../settings'; | ||
|
|
||
| nls.config({ messageFormat: nls.MessageFormat.bundle, bundleFormat: nls.BundleFormat.standalone })(); | ||
| const localize: nls.LocalizeFunc = nls.loadMessageBundle(); | ||
|
|
||
| export class CopilotHoverProvider implements vscode.HoverProvider { | ||
| private client: DefaultClient; | ||
| private currentDocument: vscode.TextDocument | undefined; | ||
| private currentPosition: vscode.Position | undefined; | ||
| private currentCancellationToken: vscode.CancellationToken | undefined; | ||
| private waiting: boolean = false; | ||
| private ready: boolean = false; | ||
| private cancelled: boolean = false; | ||
| private cancelledDocument: vscode.TextDocument | undefined; | ||
| private cancelledPosition: vscode.Position | undefined; | ||
| private content: string | undefined; | ||
| constructor(client: DefaultClient) { | ||
| this.client = client; | ||
| } | ||
|
|
||
| public async provideHover(document: vscode.TextDocument, position: vscode.Position, token: vscode.CancellationToken): Promise<vscode.Hover | undefined> { | ||
| await this.client.ready; | ||
|
|
||
| const settings: CppSettings = new CppSettings(vscode.workspace.getWorkspaceFolder(document.uri)?.uri); | ||
| if (settings.hover === "disabled") { | ||
| return undefined; | ||
| } | ||
|
|
||
| const newHover = this.isNewHover(document, position); | ||
| if (newHover) { | ||
| this.reset(); | ||
| } | ||
|
|
||
| // Wait for the main hover provider to finish and confirm it has content. | ||
| const hoverProvider = this.client.getHoverProvider(); | ||
| if (!await hoverProvider?.contentReady) { | ||
| return undefined; | ||
| } | ||
|
|
||
| if (token.isCancellationRequested) { | ||
| throw new vscode.CancellationError(); | ||
| } | ||
| this.currentCancellationToken = token; | ||
|
|
||
| if (!newHover) { | ||
| if (this.ready) { | ||
| const contentMarkdown = new vscode.MarkdownString(`$(sparkle) Copilot\n\n${this.content}`, true); | ||
| return new vscode.Hover(contentMarkdown); | ||
| } | ||
| if (this.waiting) { | ||
| const loadingMarkdown = new vscode.MarkdownString("$(sparkle) $(loading~spin)", true); | ||
| return new vscode.Hover(loadingMarkdown); | ||
| } | ||
| } | ||
|
|
||
| this.currentDocument = document; | ||
| this.currentPosition = position; | ||
| const commandString = "$(sparkle) [" + localize("generate.copilot.description", "Generate Copilot summary") + "](command:C_Cpp.ShowCopilotHover \"" + localize("copilot.disclaimer", "AI-generated content may be incorrect.") + "\")"; | ||
| const commandMarkdown = new vscode.MarkdownString(commandString); | ||
| commandMarkdown.supportThemeIcons = true; | ||
| commandMarkdown.isTrusted = { enabledCommands: ["C_Cpp.ShowCopilotHover"] }; | ||
| return new vscode.Hover(commandMarkdown); | ||
| } | ||
|
|
||
| public showWaiting(): void { | ||
| this.waiting = true; | ||
| } | ||
|
|
||
| public showContent(content: string): void { | ||
| this.ready = true; | ||
| this.content = content; | ||
| } | ||
|
|
||
| public getCurrentHoverDocument(): vscode.TextDocument | undefined { | ||
| return this.currentDocument; | ||
| } | ||
|
|
||
| public getCurrentHoverPosition(): vscode.Position | undefined { | ||
| return this.currentPosition; | ||
| } | ||
|
|
||
| public getCurrentHoverCancellationToken(): vscode.CancellationToken | undefined { | ||
| return this.currentCancellationToken; | ||
| } | ||
|
|
||
| public async getRequestInfo(document: vscode.TextDocument, position: vscode.Position): Promise<string> { | ||
| let requestInfo = ""; | ||
| const params: GetCopilotHoverInfoParams = { | ||
| textDocument: { uri: document.uri.toString() }, | ||
| position: Position.create(position.line, position.character) | ||
| }; | ||
|
|
||
| await this.client.ready; | ||
| if (this.currentCancellationToken?.isCancellationRequested) { | ||
| throw new vscode.CancellationError(); | ||
| } | ||
|
|
||
| try { | ||
| const response = await this.client.languageClient.sendRequest(GetCopilotHoverInfoRequest, params, this.currentCancellationToken); | ||
| requestInfo = response.content; | ||
| } catch (e: any) { | ||
| if (e instanceof ResponseError && (e.code === RequestCancelled || e.code === ServerCancelled)) { | ||
| throw new vscode.CancellationError(); | ||
| } | ||
| throw e; | ||
| } | ||
|
|
||
| return requestInfo; | ||
| } | ||
|
|
||
| public isCancelled(document: vscode.TextDocument, position: vscode.Position): boolean { | ||
| if (this.cancelled && this.cancelledDocument === document && this.cancelledPosition === position) { | ||
| // Cancellation is being acknowledged. | ||
| this.cancelled = false; | ||
| this.cancelledDocument = undefined; | ||
| this.cancelledPosition = undefined; | ||
| return true; | ||
| } | ||
| return false; | ||
| } | ||
|
|
||
| public reset(): void { | ||
| // If there was a previous call, cancel it. | ||
| if (this.waiting) { | ||
| this.cancelled = true; | ||
| this.cancelledDocument = this.currentDocument; | ||
| this.cancelledPosition = this.currentPosition; | ||
| } | ||
| this.waiting = false; | ||
| this.ready = false; | ||
| this.content = undefined; | ||
| this.currentDocument = undefined; | ||
| this.currentPosition = undefined; | ||
| this.currentCancellationToken = undefined; | ||
| } | ||
|
|
||
| public isNewHover(document: vscode.TextDocument, position: vscode.Position): boolean { | ||
| return !(this.currentDocument === document && this.currentPosition?.line === position.line && (this.currentPosition?.character === position.character || this.currentPosition?.character === position.character - 1)); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.