Microsoft/vscode
1
0
Fork 0
mirror of https://github.com/microsoft/vscode.git synced 2026-04-24 02:28:34 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add extension information to comment widget model

Browse Source
This commit is contained in:
rebornix
2019-01-09 11:42:12 -08:00
parent 8c2cef95b3
commit fe5f523735
5 changed files with 74 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

87
src/vs/workbench/api/node/extHostComments.ts
View File

@@ -15,13 +15,19 @@ import { IRange } from 'vs/editor/common/core/range';
import { CancellationToken } from 'vs/base/common/cancellation';
import { ExtensionIdentifier } from 'vs/platform/extensions/common/extensions';
interface HandlerData<T> {
extensionId: ExtensionIdentifier;
provider: T;
}
export class ExtHostComments implements ExtHostCommentsShape {
private static handlePool = 0;
private _proxy: MainThreadCommentsShape;
private _documentProviders = new Map<number, vscode.DocumentCommentProvider>();
private _workspaceProviders = new Map<number, vscode.WorkspaceCommentProvider>();
private _documentProviders = new Map<number, HandlerData<vscode.DocumentCommentProvider>>();
private _workspaceProviders = new Map<number, HandlerData<vscode.WorkspaceCommentProvider>>();
constructor(
mainContext: IMainContext,
@@ -36,9 +42,12 @@ export class ExtHostComments implements ExtHostCommentsShape {
provider: vscode.WorkspaceCommentProvider
): vscode.Disposable {
const handle = ExtHostComments.handlePool++;
this._workspaceProviders.set(handle, provider);
this._workspaceProviders.set(handle, {
extensionId,
provider
});
this._proxy.$registerWorkspaceCommentProvider(handle, extensionId);
this.registerListeners(handle, provider);
this.registerListeners(handle, extensionId, provider);
return {
dispose: () => {
@@ -49,16 +58,20 @@ export class ExtHostComments implements ExtHostCommentsShape {
}
registerDocumentCommentProvider(
extensionId: ExtensionIdentifier,
provider: vscode.DocumentCommentProvider
): vscode.Disposable {
const handle = ExtHostComments.handlePool++;
this._documentProviders.set(handle, provider);
this._documentProviders.set(handle, {
extensionId,
provider
});
this._proxy.$registerDocumentCommentProvider(handle, {
startDraftLabel: provider.startDraftLabel,
deleteDraftLabel: provider.deleteDraftLabel,
finishDraftLabel: provider.finishDraftLabel
});
this.registerListeners(handle, provider);
this.registerListeners(handle, extensionId, provider);
return {
dispose: () => {
@@ -76,10 +89,10 @@ export class ExtHostComments implements ExtHostCommentsShape {
return Promise.resolve(null);
}
const provider = this._documentProviders.get(handle);
const handlerData = this._documentProviders.get(handle);
return asPromise(() => {
return provider.createNewCommentThread(data.document, ran, text, CancellationToken.None);
}).then(commentThread => commentThread ? convertToCommentThread(provider, commentThread, this._commandsConverter) : null);
return handlerData.provider.createNewCommentThread(data.document, ran, text, CancellationToken.None);
}).then(commentThread => commentThread ? convertToCommentThread(handlerData.extensionId, handlerData.provider, commentThread, this._commandsConverter) : null);
}
$replyToCommentThread(handle: number, uri: UriComponents, range: IRange, thread: modes.CommentThread, text: string): Promise<modes.CommentThread | null> {
@@ -90,10 +103,10 @@ export class ExtHostComments implements ExtHostCommentsShape {
return Promise.resolve(null);
}
const provider = this._documentProviders.get(handle);
const handlerData = this._documentProviders.get(handle);
return asPromise(() => {
return provider.replyToCommentThread(data.document, ran, convertFromCommentThread(thread), text, CancellationToken.None);
}).then(commentThread => commentThread ? convertToCommentThread(provider, commentThread, this._commandsConverter) : null);
return handlerData.provider.replyToCommentThread(data.document, ran, convertFromCommentThread(thread), text, CancellationToken.None);
}).then(commentThread => commentThread ? convertToCommentThread(handlerData.extensionId, handlerData.provider, commentThread, this._commandsConverter) : null);
}
$editComment(handle: number, uri: UriComponents, comment: modes.Comment, text: string): Promise<void> {
@@ -103,9 +116,9 @@ export class ExtHostComments implements ExtHostCommentsShape {
throw new Error('Unable to retrieve document from URI');
}
const provider = this._documentProviders.get(handle);
const handlerData = this._documentProviders.get(handle);
return asPromise(() => {
return provider.editComment(data.document, convertFromComment(comment), text, CancellationToken.None);
return handlerData.provider.editComment(data.document, convertFromComment(comment), text, CancellationToken.None);
});
}
@@ -116,9 +129,9 @@ export class ExtHostComments implements ExtHostCommentsShape {
throw new Error('Unable to retrieve document from URI');
}
const provider = this._documentProviders.get(handle);
const handlerData = this._documentProviders.get(handle);
return asPromise(() => {
return provider.deleteComment(data.document, convertFromComment(comment), CancellationToken.None);
return handlerData.provider.deleteComment(data.document, convertFromComment(comment), CancellationToken.None);
});
}
@@ -129,9 +142,9 @@ export class ExtHostComments implements ExtHostCommentsShape {
throw new Error('Unable to retrieve document from URI');
}
const provider = this._documentProviders.get(handle);
const handlerData = this._documentProviders.get(handle);
return asPromise(() => {
return provider.startDraft(data.document, CancellationToken.None);
return handlerData.provider.startDraft(data.document, CancellationToken.None);
});
}
@@ -142,9 +155,9 @@ export class ExtHostComments implements ExtHostCommentsShape {
throw new Error('Unable to retrieve document from URI');
}
const provider = this._documentProviders.get(handle);
const handlerData = this._documentProviders.get(handle);
return asPromise(() => {
return provider.deleteDraft(data.document, CancellationToken.None);
return handlerData.provider.deleteDraft(data.document, CancellationToken.None);
});
}
@@ -155,9 +168,9 @@ export class ExtHostComments implements ExtHostCommentsShape {
throw new Error('Unable to retrieve document from URI');
}
const provider = this._documentProviders.get(handle);
const handlerData = this._documentProviders.get(handle);
return asPromise(() => {
return provider.finishDraft(data.document, CancellationToken.None);
return handlerData.provider.finishDraft(data.document, CancellationToken.None);
});
}
@@ -167,48 +180,50 @@ export class ExtHostComments implements ExtHostCommentsShape {
return Promise.resolve(null);
}
const provider = this._documentProviders.get(handle);
const handlerData = this._documentProviders.get(handle);
return asPromise(() => {
return provider.provideDocumentComments(data.document, CancellationToken.None);
}).then(commentInfo => commentInfo ? convertCommentInfo(handle, provider, commentInfo, this._commandsConverter) : null);
return handlerData.provider.provideDocumentComments(data.document, CancellationToken.None);
}).then(commentInfo => commentInfo ? convertCommentInfo(handle, handlerData.extensionId, handlerData.provider, commentInfo, this._commandsConverter) : null);
}
$provideWorkspaceComments(handle: number): Promise<modes.CommentThread[] | null> {
const provider = this._workspaceProviders.get(handle);
if (!provider) {
const handlerData = this._workspaceProviders.get(handle);
if (!handlerData) {
return Promise.resolve(null);
}
return asPromise(() => {
return provider.provideWorkspaceComments(CancellationToken.None);
return handlerData.provider.provideWorkspaceComments(CancellationToken.None);
}).then(comments =>
comments.map(comment => convertToCommentThread(provider, comment, this._commandsConverter)
comments.map(comment => convertToCommentThread(handlerData.extensionId, handlerData.provider, comment, this._commandsConverter)
));
}
private registerListeners(handle: number, provider: vscode.DocumentCommentProvider | vscode.WorkspaceCommentProvider) {
private registerListeners(handle: number, extensionId: ExtensionIdentifier, provider: vscode.DocumentCommentProvider | vscode.WorkspaceCommentProvider) {
provider.onDidChangeCommentThreads(event => {
this._proxy.$onDidCommentThreadsChange(handle, {
changed: event.changed.map(thread => convertToCommentThread(provider, thread, this._commandsConverter)),
added: event.added.map(thread => convertToCommentThread(provider, thread, this._commandsConverter)),
removed: event.removed.map(thread => convertToCommentThread(provider, thread, this._commandsConverter)),
changed: event.changed.map(thread => convertToCommentThread(extensionId, provider, thread, this._commandsConverter)),
added: event.added.map(thread => convertToCommentThread(extensionId, provider, thread, this._commandsConverter)),
removed: event.removed.map(thread => convertToCommentThread(extensionId, provider, thread, this._commandsConverter)),
draftMode: !!(provider as vscode.DocumentCommentProvider).startDraft && !!(provider as vscode.DocumentCommentProvider).finishDraft ? (event.inDraftMode ? modes.DraftMode.InDraft : modes.DraftMode.NotInDraft) : modes.DraftMode.NotSupported
});
});
}
}
function convertCommentInfo(owner: number, provider: vscode.DocumentCommentProvider, vscodeCommentInfo: vscode.CommentInfo, commandsConverter: CommandsConverter): modes.CommentInfo {
function convertCommentInfo(owner: number, extensionId: ExtensionIdentifier, provider: vscode.DocumentCommentProvider, vscodeCommentInfo: vscode.CommentInfo, commandsConverter: CommandsConverter): modes.CommentInfo {
return {
threads: vscodeCommentInfo.threads.map(x => convertToCommentThread(provider, x, commandsConverter)),
extensionId: extensionId.value,
threads: vscodeCommentInfo.threads.map(x => convertToCommentThread(extensionId, provider, x, commandsConverter)),
commentingRanges: vscodeCommentInfo.commentingRanges ? vscodeCommentInfo.commentingRanges.map(range => extHostTypeConverter.Range.from(range)) : [],
draftMode: provider.startDraft && provider.finishDraft ? (vscodeCommentInfo.inDraftMode ? modes.DraftMode.InDraft : modes.DraftMode.NotInDraft) : modes.DraftMode.NotSupported
};
}
function convertToCommentThread(provider: vscode.DocumentCommentProvider | vscode.WorkspaceCommentProvider, vscodeCommentThread: vscode.CommentThread, commandsConverter: CommandsConverter): modes.CommentThread {
function convertToCommentThread(extensionId: ExtensionIdentifier, provider: vscode.DocumentCommentProvider | vscode.WorkspaceCommentProvider, vscodeCommentThread: vscode.CommentThread, commandsConverter: CommandsConverter): modes.CommentThread {
return {
extensionId: extensionId.value,
threadId: vscodeCommentThread.threadId,
resource: vscodeCommentThread.resource.toString(),
range: extHostTypeConverter.Range.from(vscodeCommentThread.range),