/
copyPasteController.ts
283 lines (235 loc) · 9.97 KB
/
copyPasteController.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import { DataTransfers } from 'vs/base/browser/dnd';
import { addDisposableListener } from 'vs/base/browser/dom';
import { CancelablePromise, createCancelablePromise, raceCancellation } from 'vs/base/common/async';
import { CancellationToken } from 'vs/base/common/cancellation';
import { createStringDataTransferItem, UriList, VSDataTransfer } from 'vs/base/common/dataTransfer';
import { Disposable } from 'vs/base/common/lifecycle';
import { Mimes } from 'vs/base/common/mime';
import { Schemas } from 'vs/base/common/network';
import { generateUuid } from 'vs/base/common/uuid';
import { toVSDataTransfer } from 'vs/editor/browser/dnd';
import { ICodeEditor } from 'vs/editor/browser/editorBrowser';
import { IBulkEditService, ResourceTextEdit } from 'vs/editor/browser/services/bulkEditService';
import { EditorOption } from 'vs/editor/common/config/editorOptions';
import { IRange, Range } from 'vs/editor/common/core/range';
import { Selection } from 'vs/editor/common/core/selection';
import { Handler, IEditorContribution, PastePayload } from 'vs/editor/common/editorCommon';
import { DocumentPasteEdit, DocumentPasteEditProvider, WorkspaceEdit } from 'vs/editor/common/languages';
import { ITextModel } from 'vs/editor/common/model';
import { ILanguageFeaturesService } from 'vs/editor/common/services/languageFeatures';
import { CodeEditorStateFlag, EditorStateCancellationTokenSource } from 'vs/editor/contrib/editorState/browser/editorState';
import { SnippetParser } from 'vs/editor/contrib/snippet/browser/snippetParser';
import { localize } from 'vs/nls';
import { IClipboardService } from 'vs/platform/clipboard/common/clipboardService';
import { IConfigurationService } from 'vs/platform/configuration/common/configuration';
import { IProgressService, ProgressLocation } from 'vs/platform/progress/common/progress';
const vscodeClipboardMime = 'application/vnd.code.copyMetadata';
interface CopyMetadata {
readonly id?: string;
readonly wasFromEmptySelection: boolean;
}
export class CopyPasteController extends Disposable implements IEditorContribution {
public static readonly ID = 'editor.contrib.copyPasteActionController';
public static get(editor: ICodeEditor): CopyPasteController {
return editor.getContribution<CopyPasteController>(CopyPasteController.ID)!;
}
private readonly _editor: ICodeEditor;
private _currentClipboardItem?: {
readonly handle: string;
readonly dataTransferPromise: CancelablePromise<VSDataTransfer>;
};
constructor(
editor: ICodeEditor,
@IBulkEditService private readonly _bulkEditService: IBulkEditService,
@IClipboardService private readonly _clipboardService: IClipboardService,
@IConfigurationService private readonly _configurationService: IConfigurationService,
@ILanguageFeaturesService private readonly _languageFeaturesService: ILanguageFeaturesService,
@IProgressService private readonly _progressService: IProgressService,
) {
super();
this._editor = editor;
const container = editor.getContainerDomNode();
this._register(addDisposableListener(container, 'copy', e => this.handleCopy(e)));
this._register(addDisposableListener(container, 'cut', e => this.handleCopy(e)));
this._register(addDisposableListener(container, 'paste', e => this.handlePaste(e), true));
}
private arePasteActionsEnabled(model: ITextModel): boolean {
if (this._configurationService.getValue('editor.experimental.pasteActions.enabled', { resource: model.uri })) {
return true;
}
// TODO: This check is only here to support enabling `ipynb.pasteImagesAsAttachments.enabled` by default
return model.uri.scheme === Schemas.vscodeNotebookCell;
}
private handleCopy(e: ClipboardEvent) {
if (!e.clipboardData || !this._editor.hasTextFocus()) {
return;
}
const model = this._editor.getModel();
const selections = this._editor.getSelections();
if (!model || !selections?.length) {
return;
}
if (!this.arePasteActionsEnabled(model)) {
return;
}
const ranges: IRange[] = [...selections];
const primarySelection = selections[0];
const wasFromEmptySelection = primarySelection.isEmpty();
if (wasFromEmptySelection) {
if (!this._editor.getOption(EditorOption.emptySelectionClipboard)) {
return;
}
ranges[0] = new Range(primarySelection.startLineNumber, 0, primarySelection.startLineNumber, model.getLineLength(primarySelection.startLineNumber));
}
const providers = this._languageFeaturesService.documentPasteEditProvider.ordered(model).filter(x => !!x.prepareDocumentPaste);
if (!providers.length) {
this.setCopyMetadata(e.clipboardData, { wasFromEmptySelection });
return;
}
const dataTransfer = toVSDataTransfer(e.clipboardData);
// Save off a handle pointing to data that VS Code maintains.
const handle = generateUuid();
this.setCopyMetadata(e.clipboardData, {
id: handle,
wasFromEmptySelection,
});
const promise = createCancelablePromise(async token => {
const results = await Promise.all(providers.map(provider => {
return provider.prepareDocumentPaste!(model, ranges, dataTransfer, token);
}));
for (const result of results) {
result?.forEach((value, key) => {
dataTransfer.replace(key, value);
});
}
return dataTransfer;
});
this._currentClipboardItem?.dataTransferPromise.cancel();
this._currentClipboardItem = { handle: handle, dataTransferPromise: promise };
}
private setCopyMetadata(dataTransfer: DataTransfer, metadata: CopyMetadata) {
dataTransfer.setData(vscodeClipboardMime, JSON.stringify(metadata));
}
private async handlePaste(e: ClipboardEvent) {
if (!e.clipboardData || !this._editor.hasTextFocus()) {
return;
}
const selections = this._editor.getSelections();
if (!selections?.length || !this._editor.hasModel()) {
return;
}
const model = this._editor.getModel();
if (!this.arePasteActionsEnabled(model)) {
return;
}
let metadata: CopyMetadata | undefined;
const rawMetadata = e.clipboardData?.getData(vscodeClipboardMime);
if (rawMetadata && typeof rawMetadata === 'string') {
metadata = JSON.parse(rawMetadata);
}
const providers = this._languageFeaturesService.documentPasteEditProvider.ordered(model);
if (!providers.length) {
return;
}
e.preventDefault();
e.stopImmediatePropagation();
const tokenSource = new EditorStateCancellationTokenSource(this._editor, CodeEditorStateFlag.Value | CodeEditorStateFlag.Selection);
try {
const dataTransfer = toVSDataTransfer(e.clipboardData);
if (metadata?.id && this._currentClipboardItem?.handle === metadata.id) {
const toMergeDataTransfer = await this._currentClipboardItem.dataTransferPromise;
if (tokenSource.token.isCancellationRequested) {
return;
}
toMergeDataTransfer.forEach((value, key) => {
dataTransfer.replace(key, value);
});
}
if (!dataTransfer.has(Mimes.uriList)) {
const resources = await this._clipboardService.readResources();
if (tokenSource.token.isCancellationRequested) {
return;
}
if (resources.length) {
dataTransfer.append(Mimes.uriList, createStringDataTransferItem(UriList.create(resources)));
}
}
dataTransfer.delete(vscodeClipboardMime);
const providerEdit = await this._progressService.withProgress({
location: ProgressLocation.Notification,
delay: 750,
title: localize('pasteProgressTitle', "Running paste handlers..."),
cancellable: true,
}, () => {
return this.getProviderPasteEdit(providers, dataTransfer, model, selections, tokenSource.token);
}, () => {
return tokenSource.cancel();
});
if (tokenSource.token.isCancellationRequested) {
return;
}
if (providerEdit) {
const snippet = typeof providerEdit.insertText === 'string' ? SnippetParser.escape(providerEdit.insertText) : providerEdit.insertText.snippet;
const combinedWorkspaceEdit: WorkspaceEdit = {
edits: [
new ResourceTextEdit(model.uri, {
range: Selection.liftSelection(this._editor.getSelection()),
text: snippet,
insertAsSnippet: true,
}),
...(providerEdit.additionalEdit?.edits ?? [])
]
};
await this._bulkEditService.apply(combinedWorkspaceEdit, { editor: this._editor });
return;
}
await this.applyDefaultPasteHandler(dataTransfer, metadata, tokenSource.token);
} finally {
tokenSource.dispose();
}
}
private getProviderPasteEdit(providers: DocumentPasteEditProvider[], dataTransfer: VSDataTransfer, model: ITextModel, selections: Selection[], token: CancellationToken): Promise<DocumentPasteEdit | undefined> {
return raceCancellation((async () => {
for (const provider of providers) {
if (token.isCancellationRequested) {
return;
}
if (!isSupportedProvider(provider, dataTransfer)) {
continue;
}
const edit = await provider.provideDocumentPasteEdits(model, selections, dataTransfer, token);
if (edit) {
return edit;
}
}
return undefined;
})(), token);
}
private async applyDefaultPasteHandler(dataTransfer: VSDataTransfer, metadata: CopyMetadata | undefined, token: CancellationToken) {
const textDataTransfer = dataTransfer.get(Mimes.text) ?? dataTransfer.get('text');
if (!textDataTransfer) {
return;
}
const text = await textDataTransfer.asString();
if (token.isCancellationRequested) {
return;
}
this._editor.trigger('keyboard', Handler.Paste, <PastePayload>{
text: text,
pasteOnNewLine: metadata?.wasFromEmptySelection,
multicursorText: null
});
}
}
function isSupportedProvider(provider: DocumentPasteEditProvider, dataTransfer: VSDataTransfer): boolean {
return provider.pasteMimeTypes.some(type => {
if (type.toLowerCase() === DataTransfers.FILES.toLowerCase()) {
return [...dataTransfer.values()].some(item => item.asFile());
}
return dataTransfer.has(type);
});
}