add SnippetTextEdit, allow drop-handler to return them

Author: jrieken

src/vs/editor/common/languages.ts

@@ -1293,6 +1293,11 @@ export interface DocumentSymbolProvider {
 
 export type TextEdit = { range: IRange; text: string; eol?: model.EndOfLineSequence };
 
+export interface SnippetTextEdit {
+	range: IRange;
+	snippet: string;
+}
+
 /**
  * Interface used to format a model
  */

src/vs/editor/contrib/snippet/browser/snippetController2.ts

@@ -11,7 +11,7 @@ import { Position } from 'vs/editor/common/core/position';
 import { Range } from 'vs/editor/common/core/range';
 import { IEditorContribution } from 'vs/editor/common/editorCommon';
 import { EditorContextKeys } from 'vs/editor/common/editorContextKeys';
-import { CompletionItem, CompletionItemKind, CompletionItemProvider } from 'vs/editor/common/languages';
+import { CompletionItem, CompletionItemKind, CompletionItemProvider, SnippetTextEdit } from 'vs/editor/common/languages';
 import { ITextModel } from 'vs/editor/common/model';
 import { ILanguageFeaturesService } from 'vs/editor/common/services/languageFeatures';
 import { Choice } from 'vs/editor/contrib/snippet/browser/snippetParser';
@@ -329,3 +329,16 @@ registerEditorCommand(new CommandCtor({
 	// 	primary: KeyCode.Enter,
 	// }
 }));
+
+
+// ---
+
+export function performSnippetEdit(editor: ICodeEditor, edit: SnippetTextEdit) {
+	const controller = SnippetController2.get(editor);
+	if (!controller) {
+		return false;
+	}
+	editor.setSelection(edit.range);
+	controller.insert(edit.snippet);
+	return controller.isInSnippet();
+}

src/vs/monaco.d.ts

@@ -6688,6 +6688,11 @@ declare namespace monaco.languages {
 		eol?: editor.EndOfLineSequence;
 	};
 
+	export interface SnippetTextEdit {
+		range: IRange;
+		snippet: string;
+	}
+
 	/**
 	 * Interface used to format a model
 	 */

src/vs/workbench/api/browser/mainThreadEditors.ts

@@ -37,6 +37,7 @@ import { IDataTransfer, IDataTransferItem } from 'vs/workbench/common/dnd';
 import { extractEditorsDropData } from 'vs/workbench/browser/dnd';
 import { Mimes } from 'vs/base/common/mime';
 import { distinct } from 'vs/base/common/arrays';
+import { performSnippetEdit } from 'vs/editor/contrib/snippet/browser/snippetController2';
 
 export function reviveWorkspaceEditDto2(data: IWorkspaceEditDto | undefined): ResourceEdit[] {
 	if (!data?.edits) {
@@ -111,7 +112,7 @@ export class MainThreadTextEditors implements MainThreadTextEditorsShape {
 		this._registeredDecorationTypes = Object.create(null);
 	}
 
-	public dispose(): void {
+	dispose(): void {
 		Object.keys(this._textEditorsListenersMap).forEach((editorId) => {
 			dispose(this._textEditorsListenersMap[editorId]);
 		});
@@ -196,10 +197,18 @@ export class MainThreadTextEditors implements MainThreadTextEditorsShape {
 			}
 		}
 
-		if (textEditorDataTransfer.size > 0) {
-			const dataTransferDto = await DataTransferConverter.toDataTransferDTO(textEditorDataTransfer);
-			return this._proxy.$textEditorHandleDrop(id, position, dataTransferDto);
+		if (textEditorDataTransfer.size === 0) {
+			return;
 		}
+
+		const dataTransferDto = await DataTransferConverter.toDataTransferDTO(textEditorDataTransfer);
+		const edits = await this._proxy.$textEditorHandleDrop(id, position, dataTransferDto);
+		if (edits.length === 0) {
+			return;
+		}
+
+		const [first] = edits; // TODO define how to pick the "one snippet edit";
+		performSnippetEdit(editor, first);
 	}
 
 	// --- from extension host process

src/vs/workbench/api/common/extHost.api.impl.ts

@@ -1243,6 +1243,7 @@ export function createApiFactoryAndRegisterActors(accessor: ServicesAccessor): I
 			SignatureHelpTriggerKind: extHostTypes.SignatureHelpTriggerKind,
 			SignatureInformation: extHostTypes.SignatureInformation,
 			SnippetString: extHostTypes.SnippetString,
+			SnippetTextEdit: extHostTypes.SnippetTextEdit,
 			SourceBreakpoint: extHostTypes.SourceBreakpoint,
 			StandardTokenType: extHostTypes.StandardTokenType,
 			StatusBarAlignment: extHostTypes.StatusBarAlignment,

src/vs/workbench/api/common/extHost.protocol.ts

@@ -1324,7 +1324,7 @@ export interface ISelectionChangeEvent {
 export interface ExtHostEditorsShape {
 	$acceptEditorPropertiesChanged(id: string, props: IEditorPropertiesChangeData): void;
 	$acceptEditorPositionData(data: ITextEditorPositionData): void;
-	$textEditorHandleDrop(id: string, position: IPosition, dataTransferDto: DataTransferDTO): Promise<void>;
+	$textEditorHandleDrop(id: string, position: IPosition, dataTransferDto: DataTransferDTO): Promise<Dto<languages.SnippetTextEdit[]>>;
 }
 
 export interface IDocumentsAndEditorsDelta {

src/vs/workbench/api/common/extHostTextEditors.ts

@@ -9,12 +9,14 @@ import { ExtHostEditorsShape, IEditorPropertiesChangeData, IMainContext, ITextDo
 import { ExtHostDocumentsAndEditors } from 'vs/workbench/api/common/extHostDocumentsAndEditors';
 import { ExtHostTextEditor, TextEditorDecorationType } from 'vs/workbench/api/common/extHostTextEditor';
 import * as TypeConverters from 'vs/workbench/api/common/extHostTypeConverters';
-import { TextEditorSelectionChangeKind } from 'vs/workbench/api/common/extHostTypes';
+import { SnippetTextEdit, TextEditorSelectionChangeKind } from 'vs/workbench/api/common/extHostTypes';
 import * as vscode from 'vscode';
 import { IExtensionDescription } from 'vs/platform/extensions/common/extensions';
 import { DataTransferConverter, DataTransferDTO } from 'vs/workbench/api/common/shared/dataTransfer';
 import { IPosition } from 'vs/editor/common/core/position';
 import { CancellationToken } from 'vs/base/common/cancellation';
+import { Dto } from 'vs/workbench/services/extensions/common/proxyIdentifier';
+import * as languages from 'vs/editor/common/languages';
 
 export class ExtHostEditors implements ExtHostEditorsShape {
 
@@ -167,7 +169,7 @@ export class ExtHostEditors implements ExtHostEditorsShape {
 
 	// --- Text editor drag and drop
 
-	async $textEditorHandleDrop(id: string, position: IPosition, dataTransferDto: DataTransferDTO): Promise<void> {
+	async $textEditorHandleDrop(id: string, position: IPosition, dataTransferDto: DataTransferDTO): Promise<Dto<languages.SnippetTextEdit[]>> {
 		const textEditor = this._extHostDocumentsAndEditors.getEditor(id);
 		if (!textEditor) {
 			throw new Error('Unknown text editor');
@@ -182,6 +184,15 @@ export class ExtHostEditors implements ExtHostEditorsShape {
 			dataTransfer: dataTransfer
 		});
 
-		await this._onWillDropOnTextEditor.fireAsync(event, CancellationToken.None);
+		const edits: SnippetTextEdit[] = [];
+
+		await this._onWillDropOnTextEditor.fireAsync(event, CancellationToken.None, async p => {
+			const value = await p;
+			if (value instanceof SnippetTextEdit) {
+				edits.push(value);
+			}
+		});
+
+		return edits.map(TypeConverters.SnippetTextEdit.from);
 	}
 }

src/vs/workbench/api/common/extHostTypeConverters.ts

@@ -557,6 +557,15 @@ export namespace TextEdit {
 	}
 }
 
+export namespace SnippetTextEdit {
+	export function from(edit: vscode.SnippetTextEdit): languages.SnippetTextEdit {
+		return {
+			range: Range.from(edit.range),
+			snippet: edit.snippet.value
+		};
+	}
+}
+
 export namespace WorkspaceEdit {
 
 	export interface IVersionInformationProvider {

src/vs/workbench/api/common/extHostTypes.ts

@@ -598,6 +598,17 @@ export class TextEdit {
 	}
 }
 
+export class SnippetTextEdit implements vscode.SnippetTextEdit {
+
+	range: vscode.Range;
+	snippet: vscode.SnippetString;
+
+	constructor(range: Range, snippet: SnippetString) {
+		this.range = range;
+		this.snippet = snippet;
+	}
+}
+
 export interface IFileOperationOptions {
 	overwrite?: boolean;
 	ignoreIfExists?: boolean;

src/vscode-dts/vscode.proposed.textEditorDrop.d.ts

@@ -7,6 +7,13 @@ declare module 'vscode' {
 
 	// https://github.com/microsoft/vscode/issues/142990
 
+	export class SnippetTextEdit {
+		snippet: SnippetString;
+		range: Range;
+		constructor(range: Range, snippet: SnippetString);
+	}
+
+
 	export interface TextEditorDropEvent {
 		/**
 		 * The {@link TextEditor} the resource was dropped onto.
@@ -43,6 +50,9 @@ declare module 'vscode' {
 		 */
 		waitUntil(thenable: Thenable<any>): void;
 
+		//
+		waitUntil(thenable: Thenable<SnippetTextEdit>): void;
+
 		token: CancellationToken;
 	}