Initial sketches for copy/paste action provider

mjbvz · mjbvz · commit 7806751f1d34 · 2020-09-23T12:16:35.000-07:00
For #30066
diff --git a/extensions/markdown-language-features/src/extension.ts b/extensions/markdown-language-features/src/extension.ts
@@ -20,6 +20,8 @@ import { githubSlugifier } from './slugify';
 import { loadDefaultTelemetryReporter, TelemetryReporter } from './telemetryReporter';
 
 
+type ClipboardData = { count: number };
+
 export function activate(context: vscode.ExtensionContext) {
 	const telemetryReporter = loadDefaultTelemetryReporter();
 	context.subscriptions.push(telemetryReporter);
@@ -43,6 +45,37 @@ export function activate(context: vscode.ExtensionContext) {
 		logger.updateConfiguration();
 		previewManager.updateConfiguration();
 	}));
+
+	// Example copy paste provider that includes the number of times
+	// you've copied something in the pasted text.
+
+	let copyCount = 0;
+
+	vscode.languages.registerCopyPasteActionProvider({ language: 'markdown', }, new class implements vscode.CopyPasteActionProvider<ClipboardData> {
+
+		async onDidCopy(
+			_document: vscode.TextDocument,
+			_selection: vscode.Selection,
+			_clipboard: { readonly text: string },
+		): Promise<ClipboardData | undefined> {
+			return { count: copyCount++ };
+		}
+
+		async onWillPaste(
+			document: vscode.TextDocument,
+			selection: vscode.Selection,
+			clipboard: { readonly text: string; readonly data?: ClipboardData; }
+		): Promise<vscode.WorkspaceEdit | undefined> {
+			const edit = new vscode.WorkspaceEdit();
+
+			const newText = `(copy #${clipboard.data?.count}) ${clipboard.text}`;
+			edit.replace(document.uri, selection, newText);
+
+			return edit;
+		}
+	}, {
+		kind: vscode.CodeActionKind.Empty
+	});
 }
 
 function registerMarkdownLanguageFeatures(
diff --git a/src/vs/editor/browser/widget/codeEditorWidget.ts b/src/vs/editor/browser/widget/codeEditorWidget.ts
@@ -1850,6 +1850,7 @@ export class EditorModeContext extends Disposable {
 		// update when registries change
 		this._register(modes.CompletionProviderRegistry.onDidChange(update));
 		this._register(modes.CodeActionProviderRegistry.onDidChange(update));
+		this._register(modes.CopyPasteActionProviderRegistry.onDidChange(update));
 		this._register(modes.CodeLensProviderRegistry.onDidChange(update));
 		this._register(modes.DefinitionProviderRegistry.onDidChange(update));
 		this._register(modes.DeclarationProviderRegistry.onDidChange(update));
diff --git a/src/vs/editor/common/modes.ts b/src/vs/editor/common/modes.ts
@@ -672,6 +672,26 @@ export interface CodeActionProvider {
 	_getAdditionalMenuItems?(context: CodeActionContext, actions: readonly CodeAction[]): Command[];
 }
 
+export interface CopyPasteActionProvider {
+	id: string;
+
+	onDidCopy?(
+		model: model.ITextModel,
+		selection: Selection,
+		clipboard: { readonly text: string },
+		token: CancellationToken,
+	): Promise<unknown | undefined>;
+
+	onWillPaste(
+		model: model.ITextModel,
+		selection: Selection,
+		clipboard: {
+			readonly text: string;
+			readonly data?: unknown;
+		},
+	): Promise<WorkspaceEdit | undefined>;
+}
+
 /**
  * Represents a parameter of a callable-signature. A parameter can
  * have a label and a doc-comment.
@@ -1732,6 +1752,11 @@ export const CodeLensProviderRegistry = new LanguageFeatureRegistry<CodeLensProv
  */
 export const CodeActionProviderRegistry = new LanguageFeatureRegistry<CodeActionProvider>();
 
+/**
+ * @internal
+ */
+export const CopyPasteActionProviderRegistry = new LanguageFeatureRegistry<CopyPasteActionProvider>();
+
 /**
  * @internal
  */
diff --git a/src/vs/editor/contrib/copyPasteAction/copyPasteActionContribution.ts b/src/vs/editor/contrib/copyPasteAction/copyPasteActionContribution.ts
@@ -0,0 +1,10 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { registerEditorContribution } from 'vs/editor/browser/editorExtensions';
+import { CopyPasteActionController } from 'vs/editor/contrib/copyPasteAction/copyPasteActionController';
+
+
+registerEditorContribution(CopyPasteActionController.ID, CopyPasteActionController);
diff --git a/src/vs/editor/contrib/copyPasteAction/copyPasteActionController.ts b/src/vs/editor/contrib/copyPasteAction/copyPasteActionController.ts
@@ -0,0 +1,118 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { addDisposableListener } from 'vs/base/browser/dom';
+import { CancelablePromise, createCancelablePromise } from 'vs/base/common/async';
+import { Disposable } from 'vs/base/common/lifecycle';
+import { generateUuid } from 'vs/base/common/uuid';
+import { ICodeEditor } from 'vs/editor/browser/editorBrowser';
+import { IBulkEditService, ResourceEdit } from 'vs/editor/browser/services/bulkEditService';
+import { IEditorContribution } from 'vs/editor/common/editorCommon';
+import { CopyPasteActionProvider, CopyPasteActionProviderRegistry } from 'vs/editor/common/modes';
+
+let clipboardItem: undefined | {
+	readonly handle: string;
+	readonly results: CancelablePromise<Map<CopyPasteActionProvider, unknown | undefined>>;
+};
+
+const vscodeClipboardFormat = 'x-vscode/id';
+
+export class CopyPasteActionController extends Disposable implements IEditorContribution {
+
+	public static readonly ID = 'editor.contrib.copyPasteActionController';
+
+	public static get(editor: ICodeEditor): CopyPasteActionController {
+		return editor.getContribution<CopyPasteActionController>(CopyPasteActionController.ID);
+	}
+
+	private readonly _editor: ICodeEditor;
+
+	constructor(
+		editor: ICodeEditor,
+		@IBulkEditService private readonly _bulkEditService: IBulkEditService,
+	) {
+		super();
+
+		this._editor = editor;
+
+		this._register(addDisposableListener(document, 'copy', (e: ClipboardEvent) => {
+			if (!e.clipboardData) {
+				return;
+			}
+
+			const model = editor.getModel();
+			const selection = this._editor.getSelection();
+			if (!model || !selection) {
+				return;
+			}
+
+			const providers = CopyPasteActionProviderRegistry.all(model).filter(x => !!x.onDidCopy);
+			if (!providers.length) {
+				return;
+			}
+
+			// Call prevent default to prevent our new clipboard data from being overwritten (is this really required?)
+			e.preventDefault();
+
+			// And then fill in raw text again since we prevented default
+			const clipboardText = model.getValueInRange(selection);
+			e.clipboardData.setData('text/plain', clipboardText);
+
+			// Save off a handle pointing to data that VS Code maintains.
+			const handle = generateUuid();
+			e.clipboardData.setData(vscodeClipboardFormat, handle);
+
+			const promise = createCancelablePromise(async token => {
+				const results = await Promise.all(providers.map(async provider => {
+					const result = await provider.onDidCopy!(model, selection, { text: clipboardText }, token);
+					return { provider, result };
+				}));
+
+				const map = new Map<CopyPasteActionProvider, unknown | undefined>();
+				for (const { provider, result } of results) {
+					map.set(provider, result);
+				}
+
+				return map;
+			});
+
+			clipboardItem = { handle: handle, results: promise };
+		}));
+
+		this._register(addDisposableListener(document, 'paste', async (e: ClipboardEvent) => {
+			const model = editor.getModel();
+			const selection = this._editor.getSelection();
+			if (!model || !selection) {
+				return;
+			}
+
+			const providers = CopyPasteActionProviderRegistry.all(model).filter(x => !!x.onDidCopy);
+			if (!providers.length) {
+				return;
+			}
+
+			const handle = e.clipboardData?.getData(vscodeClipboardFormat);
+			const clipboardText = e.clipboardData?.getData('text/plain') ?? '';
+
+			e.preventDefault();
+			e.stopImmediatePropagation();
+
+			let results: Map<CopyPasteActionProvider, unknown | undefined> | undefined;
+			if (handle && clipboardItem && clipboardItem?.handle === handle) {
+				results = await clipboardItem.results;
+			}
+
+			for (const provider of providers) {
+				const data = results?.get(provider);
+				const edit = await provider.onWillPaste(model, selection, { text: clipboardText, data });
+				if (!edit) {
+					continue;
+				}
+
+				await this._bulkEditService.apply(ResourceEdit.convert(edit), { editor });
+			}
+		}, true));
+	}
+}
diff --git a/src/vs/editor/editor.all.ts b/src/vs/editor/editor.all.ts
@@ -15,6 +15,7 @@ import 'vs/editor/contrib/clipboard/clipboard';
 import 'vs/editor/contrib/codeAction/codeActionContributions';
 import 'vs/editor/contrib/codelens/codelensController';
 import 'vs/editor/contrib/colorPicker/colorDetector';
+import 'vs/editor/contrib/copyPasteAction/copyPasteActionContribution';
 import 'vs/editor/contrib/comment/comment';
 import 'vs/editor/contrib/contextmenu/contextmenu';
 import 'vs/editor/contrib/cursorUndo/cursorUndo';
diff --git a/src/vs/monaco.d.ts b/src/vs/monaco.d.ts
@@ -5655,6 +5655,17 @@ declare namespace monaco.languages {
 		readonly actions: ReadonlyArray<CodeAction>;
 	}
 
+	export interface CopyPasteActionProvider {
+		id: string;
+		onDidCopy?(model: editor.ITextModel, selection: Selection, clipboard: {
+			readonly text: string;
+		}, token: CancellationToken): Promise<unknown | undefined>;
+		onWillPaste(model: editor.ITextModel, selection: Selection, clipboard: {
+			readonly text: string;
+			readonly data?: unknown;
+		}): Promise<WorkspaceEdit | undefined>;
+	}
+
 	/**
 	 * Represents a parameter of a callable-signature. A parameter can
 	 * have a label and a doc-comment.
diff --git a/src/vs/vscode.proposed.d.ts b/src/vs/vscode.proposed.d.ts
@@ -2171,4 +2171,86 @@ declare module 'vscode' {
 		with(color: ThemeColor): ThemeIcon2;
 	}
 	//#endregion
+
+	//#region https://github.com/microsoft/vscode/issues/30066
+
+	/**
+	 * TODOs:
+	 * - Multiple providers?
+	 * - Is the document already edited in onWillPaste?
+	 * - Does `onWillPaste` need to re-implement basic paste
+	 *
+	 * - Figure out CopyPasteActionProviderMetadata
+	 */
+
+	/**
+	 * Provider invoked when the user copies and pastes code.
+	 *
+	 * This gives extensions a chance to hook into pasting and change the text
+	 * that is pasted.
+	 */
+	interface CopyPasteActionProvider<T = unknown> {
+
+		/**
+		 * Optional method invoked after the user copies text in a file.
+		 *
+		 * During `onDidCopy`, an extension can compute metadata that is attached to
+		 * the clipboard and is passed back to the provider in `onWillPaste`.
+		 *
+		 * @param document Document where the copy took place.
+		 * @param selection Selection being copied in the `document`.
+		 * @param clipboard Information about the clipboard state after the copy.
+		 *
+		 * @return Optional metadata passed to `onWillPaste`.
+		 */
+		onDidCopy?(
+			document: TextDocument,
+			selection: Selection,
+			clipboard: { readonly text: string },
+		): ProviderResult<T>;
+
+		/**
+		 * Invoked before the user pastes into a document.
+		 *
+		 * In this method, extensions can return a workspace edit that replaces the standard pasting behavior.
+		 *
+		 * @param document Document being pasted into
+		 * @param selection Current selection in the document.
+		 * @param clipboard Information about the clipboard state. This may contain the metadata from `onDidCopy`.
+		 *
+		 * @return Optional workspace edit that applies the paste. Return undefined to use standard pasting
+		 */
+		onWillPaste(
+			document: TextDocument,
+			selection: Selection,
+			clipboard: {
+				readonly text: string;
+				readonly data?: T;
+			},
+		): ProviderResult<WorkspaceEdit>;
+	}
+
+	/**
+	 *
+	 */
+	interface CopyPasteActionProviderMetadata {
+		/**
+		 * Identifies the type of code action
+		 */
+		readonly kind: CodeActionKind;
+	}
+
+	namespace languages {
+		/**
+		 *
+		 */
+		export function registerCopyPasteActionProvider(
+			selector: DocumentSelector,
+			provider: CopyPasteActionProvider,
+			metadata: CopyPasteActionProviderMetadata
+		): Disposable;
+	}
+
+	//#endregion
+
 }
diff --git a/src/vs/workbench/api/browser/mainThreadLanguageFeatures.ts b/src/vs/workbench/api/browser/mainThreadLanguageFeatures.ts
@@ -324,6 +324,26 @@ export class MainThreadLanguageFeatures implements MainThreadLanguageFeaturesSha
 		this._registrations.set(handle, modes.CodeActionProviderRegistry.register(selector, provider));
 	}
 
+	// --- copy paste action provider
+
+	$registerCopyPasteActionProvider(handle: number, selector: IDocumentFilterDto[], id: string, supportsCopy: boolean): void {
+		const provider: modes.CopyPasteActionProvider = {
+			id,
+			onDidCopy: supportsCopy
+				? (model: ITextModel, selection: Selection, clipboard: { readonly text: string }): Promise<string | undefined> => {
+					return this._proxy.$onDidCopy(handle, model.uri, selection, clipboard);
+				}
+				: undefined,
+
+			onWillPaste: async (model: ITextModel, selection: Selection, clipboard: { text: string, data?: string }) => {
+				const result = await this._proxy.$onWillPaste(handle, model.uri, selection, { text: clipboard.text, handle: clipboard.data });
+				return result && reviveWorkspaceEditDto(result);
+			}
+		};
+
+		this._registrations.set(handle, modes.CopyPasteActionProviderRegistry.register(selector, provider));
+	}
+
 	// --- formatting
 
 	$registerDocumentFormattingSupport(handle: number, selector: IDocumentFilterDto[], extensionId: ExtensionIdentifier, displayName: string): void {
diff --git a/src/vs/workbench/api/common/extHost.api.impl.ts b/src/vs/workbench/api/common/extHost.api.impl.ts
@@ -361,6 +361,9 @@ export function createApiFactoryAndRegisterActors(accessor: ServicesAccessor): I
 			registerCodeActionsProvider(selector: vscode.DocumentSelector, provider: vscode.CodeActionProvider, metadata?: vscode.CodeActionProviderMetadata): vscode.Disposable {
 				return extHostLanguageFeatures.registerCodeActionProvider(extension, checkSelector(selector), provider, metadata);
 			},
+			registerCopyPasteActionProvider(selector: vscode.DocumentSelector, provider: vscode.CopyPasteActionProvider, metadata: vscode.CopyPasteActionProviderMetadata): vscode.Disposable {
+				return extHostLanguageFeatures.registerCopyPasteActionProvider(extension, checkSelector(selector), provider, metadata);
+			},
 			registerCodeLensProvider(selector: vscode.DocumentSelector, provider: vscode.CodeLensProvider): vscode.Disposable {
 				return extHostLanguageFeatures.registerCodeLensProvider(extension, checkSelector(selector), provider);
 			},
diff --git a/src/vs/workbench/api/common/extHost.protocol.ts b/src/vs/workbench/api/common/extHost.protocol.ts
@@ -381,6 +381,7 @@ export interface MainThreadLanguageFeaturesShape extends IDisposable {
 	$registerOnTypeRenameProvider(handle: number, selector: IDocumentFilterDto[], stopPattern: IRegExpDto | undefined): void;
 	$registerReferenceSupport(handle: number, selector: IDocumentFilterDto[]): void;
 	$registerQuickFixSupport(handle: number, selector: IDocumentFilterDto[], metadata: ICodeActionProviderMetadataDto, displayName: string, supportsResolve: boolean): void;
+	$registerCopyPasteActionProvider(handle: number, selector: IDocumentFilterDto[], id: string, supportsCopy: boolean): void;
 	$registerDocumentFormattingSupport(handle: number, selector: IDocumentFilterDto[], extensionId: ExtensionIdentifier, displayName: string): void;
 	$registerRangeFormattingSupport(handle: number, selector: IDocumentFilterDto[], extensionId: ExtensionIdentifier, displayName: string): void;
 	$registerOnTypeFormattingSupport(handle: number, selector: IDocumentFilterDto[], autoFormatTriggerCharacters: string[], extensionId: ExtensionIdentifier): void;
@@ -1398,6 +1399,8 @@ export interface ExtHostLanguageFeaturesShape {
 	$provideCodeActions(handle: number, resource: UriComponents, rangeOrSelection: IRange | ISelection, context: modes.CodeActionContext, token: CancellationToken): Promise<ICodeActionListDto | undefined>;
 	$resolveCodeAction(handle: number, id: ChainedCacheId, token: CancellationToken): Promise<IWorkspaceEditDto | undefined>;
 	$releaseCodeActions(handle: number, cacheId: number): void;
+	$onDidCopy(handle: number, uri: UriComponents, selection: ISelection, clipboard: { readonly text: string; }): Promise<string | undefined>;
+	$onWillPaste(handle: number, uri: UriComponents, selection: ISelection, clipboard: { text: string; handle?: string | undefined; }): Promise<IWorkspaceEditDto | undefined>;
 	$provideDocumentFormattingEdits(handle: number, resource: UriComponents, options: modes.FormattingOptions, token: CancellationToken): Promise<ISingleEditOperation[] | undefined>;
 	$provideDocumentRangeFormattingEdits(handle: number, resource: UriComponents, range: IRange, options: modes.FormattingOptions, token: CancellationToken): Promise<ISingleEditOperation[] | undefined>;
 	$provideOnTypeFormattingEdits(handle: number, resource: UriComponents, position: IPosition, ch: string, options: modes.FormattingOptions, token: CancellationToken): Promise<ISingleEditOperation[] | undefined>;
diff --git a/src/vs/workbench/api/common/extHostLanguageFeatures.ts b/src/vs/workbench/api/common/extHostLanguageFeatures.ts
diff --git a/src/vs/workbench/contrib/webview/electron-sandbox/iframeWebviewElement.ts b/src/vs/workbench/contrib/webview/electron-sandbox/iframeWebviewElement.ts
