Copy plot to clipboard (#2640)

Implement write image in clipboard service
Support dynamic plots
Only show copy action for supported plots
Add toast notification
Catch error writing plot to clipboard

src/vs/platform/clipboard/browser/clipboardService.ts

@@ -189,6 +189,17 @@ export class BrowserClipboardService extends Disposable implements IClipboardSer
 		return this.resources;
 	}
 
+	// --- Start Positron ---
+	async writeImage(data: string): Promise<void> {
+		const blob = new Blob([data], { type: 'image/png' });
+		navigator.clipboard.write([
+			new ClipboardItem({
+				[blob.type]: blob
+			}
+			)]);
+	}
+	// --- End Positron ---
+
 	private async computeResourcesStateHash(): Promise<number | undefined> {
 		if (this.resources.length === 0) {
 			return undefined; // no resources, no hash needed

src/vs/platform/clipboard/common/clipboardService.ts

@@ -37,6 +37,10 @@ export interface IClipboardService {
 	 */
 	writeResources(resources: URI[]): Promise<void>;
 
+	// --- Start Positron ---
+	writeImage(data: string): Promise<void>;
+	// --- End Positron ---
+
 	/**
 	 * Reads resources from the system clipboard.
 	 */

src/vs/platform/clipboard/test/common/testClipboardService.ts

@@ -36,6 +36,12 @@ export class TestClipboardService implements IClipboardService {
 		this.resources = resources;
 	}
 
+	// --- Start Positron ---
+	async writeImage(data: string): Promise<void> {
+		// no-op
+	}
+	// --- End Positron ---
+
 	async readResources(): Promise<URI[]> {
 		return this.resources ?? [];
 	}

src/vs/platform/native/common/native.ts

@@ -152,6 +152,10 @@ export interface ICommonNativeHostService {
 	readClipboardBuffer(format: string): Promise<VSBuffer>;
 	hasClipboard(format: string, type?: 'selection' | 'clipboard'): Promise<boolean>;
 
+	// --- Start Positron ---
+	writeClipboardImage(dataUri: string): Promise<void>;
+	// --- End Positron ---
+
 	// macOS Touchbar
 	newWindowTab(): Promise<void>;
 	showPreviousWindowTab(): Promise<void>;

src/vs/platform/native/electron-main/nativeHostMainService.ts

@@ -44,6 +44,11 @@ import { IAuxiliaryWindowsMainService } from 'vs/platform/auxiliaryWindow/electr
 import { IAuxiliaryWindow } from 'vs/platform/auxiliaryWindow/electron-main/auxiliaryWindow';
 import { CancellationError } from 'vs/base/common/errors';
 
+// --- Start Positron ---
+// eslint-disable-next-line no-duplicate-imports
+import { nativeImage } from 'electron';
+// --- End Positron ---
+
 export interface INativeHostMainService extends AddFirstParameterToFunctions<ICommonNativeHostService, Promise<unknown> /* only methods, not events */, number | undefined /* window ID */> { }
 
 export const INativeHostMainService = createDecorator<INativeHostMainService>('nativeHostMainService');
@@ -647,6 +652,12 @@ export class NativeHostMainService extends Disposable implements INativeHostMain
 		return clipboard.has(format, type);
 	}
 
+	// --- Start Positron ---
+	async writeClipboardImage(windowId: number | undefined, dataUri: string): Promise<void> {
+		return clipboard.writeImage(nativeImage.createFromDataURL(dataUri));
+	}
+	// --- End Positron ---
+
 	//#endregion
 
 

src/vs/workbench/contrib/positronPlots/browser/components/actionBars.tsx

@@ -72,6 +72,12 @@ export const ActionBars = (props: PropsWithChildren<ActionBarsProps>) => {
 		&& (selectedPlot instanceof PlotClientInstance
 			|| selectedPlot instanceof StaticPlotClient);
 
+	const enableCopyPlot = hasPlots &&
+		(positronPlotsContext.positronPlotInstances[positronPlotsContext.selectedInstanceIndex]
+			instanceof StaticPlotClient
+			|| positronPlotsContext.positronPlotInstances[positronPlotsContext.selectedInstanceIndex]
+			instanceof PlotClientInstance);
+
 	useEffect(() => {
 		// Empty for now.
 	});
@@ -104,6 +110,17 @@ export const ActionBars = (props: PropsWithChildren<ActionBarsProps>) => {
 		positronPlotsContext.positronPlotsService.savePlot();
 	};
 
+	const copyPlotHandler = () => {
+		positronPlotsContext.positronPlotsService.copyPlotToClipboard()
+			.then(() => {
+				positronPlotsContext.notificationService.info(localize('positronPlotsServiceCopyToClipboard', 'Plot copied to clipboard'));
+			})
+			.catch((error) => {
+				positronPlotsContext.notificationService.error(localize('positronPlotsServiceCopyToClipboardError', 'Failed to copy plot to clipboard: {0}', error.message));
+			});
+
+	};
+
 	// Render.
 	return (
 		<PositronActionBarContextProvider {...props}>
@@ -118,6 +135,8 @@ export const ActionBars = (props: PropsWithChildren<ActionBarsProps>) => {
 						{(enableSizingPolicy || enableSavingPlots || enableZoomPlot) && <ActionBarSeparator />}
 						{enableSavingPlots && <ActionBarButton iconId='positron-save' tooltip={localize('positronSavePlot', "Save plot")}
 							ariaLabel={localize('positronSavePlot', "Save plot")} onPressed={savePlotHandler} />}
+						{enableCopyPlot && <ActionBarButton iconId='copy' disabled={!hasPlots} tooltip={localize('positron-copy-plot', "Copy plot to clipboard")} ariaLabel={localize('positron-copy-plot', "Copy plot to clipboard")}
+							onPressed={copyPlotHandler} />}
 						{enableZoomPlot && <ZoomPlotMenuButton actionHandler={zoomPlotHandler} zoomLevel={props.zoomLevel} />}
 						{enableSizingPolicy &&
 							<SizingPolicyMenuButton

src/vs/workbench/contrib/positronPlots/browser/positronPlotsService.ts

@@ -31,6 +31,7 @@ import { IWorkbenchLayoutService } from 'vs/workbench/services/layout/browser/la
 import { URI } from 'vs/base/common/uri';
 import { IWorkspaceContextService } from 'vs/platform/workspace/common/workspace';
 import { IKeybindingService } from 'vs/platform/keybinding/common/keybinding';
+import { IClipboardService } from 'vs/platform/clipboard/common/clipboardService';
 
 /** The maximum number of recent executions to store. */
 const MaxRecentExecutions = 10;
@@ -107,7 +108,8 @@ export class PositronPlotsService extends Disposable implements IPositronPlotsSe
 		@IFileDialogService private readonly _fileDialogService: IFileDialogService,
 		@IWorkspaceContextService private readonly _workspaceContextService: IWorkspaceContextService,
 		@IWorkbenchLayoutService private readonly _layoutService: IWorkbenchLayoutService,
-		@IKeybindingService private readonly _keybindingService: IKeybindingService) {
+		@IKeybindingService private readonly _keybindingService: IKeybindingService,
+		@IClipboardService private _clipboardService: IClipboardService) {
 		super();
 
 		// Register for language runtime service startups
@@ -745,6 +747,25 @@ export class PositronPlotsService extends Disposable implements IPositronPlotsSe
 		});
 	}
 
+	async copyPlotToClipboard(): Promise<void> {
+		const plot = this._plots.find(plot => plot.id === this.selectedPlotId);
+		if (plot instanceof StaticPlotClient) {
+			try {
+				await this._clipboardService.writeImage(plot.uri);
+			} catch (error) {
+				throw new Error(error.message);
+			}
+		} else if (plot instanceof PlotClientInstance) {
+			if (plot.lastRender?.uri) {
+				try {
+					await this._clipboardService.writeImage(plot.lastRender.uri);
+				} catch (error) {
+					throw new Error(error.message);
+				}
+			}
+		}
+	}
+
 	/**
 	 * Generates a storage key for a plot.
 	 *

src/vs/workbench/services/clipboard/electron-sandbox/clipboardService.ts

@@ -48,6 +48,12 @@ export class NativeClipboardService implements IClipboardService {
 		}
 	}
 
+	// --- Start Positron ---
+	async writeImage(data: string): Promise<void> {
+		return this.nativeHostService.writeClipboardImage(data);
+	}
+	// --- End Positron ---
+
 	async readResources(): Promise<URI[]> {
 		return this.bufferToResources(await this.nativeHostService.readClipboardBuffer(NativeClipboardService.FILE_FORMAT));
 	}

src/vs/workbench/services/positronPlots/common/positronPlots.ts

@@ -150,6 +150,13 @@ export interface IPositronPlotsService {
 	 */
 	selectHistoryPolicy(policy: HistoryPolicy): void;
 
+	/**
+	 * Copies the selected plot to the clipboard.
+	 *
+	 * @throws An error if the plot cannot be copied.
+	 */
+	copyPlotToClipboard(): Promise<void>;
+
 	/**
 	 * Saves the plot.
 	 */

src/vs/workbench/test/electron-sandbox/workbenchTestServices.ts

@@ -153,6 +153,10 @@ export class TestNativeHostService implements INativeHostService {
 	async hasClipboard(format: string, type?: 'selection' | 'clipboard' | undefined): Promise<boolean> { return false; }
 	async windowsGetStringRegKey(hive: 'HKEY_CURRENT_USER' | 'HKEY_LOCAL_MACHINE' | 'HKEY_CLASSES_ROOT' | 'HKEY_USERS' | 'HKEY_CURRENT_CONFIG', path: string, name: string): Promise<string | undefined> { return undefined; }
 	async profileRenderer(): Promise<any> { throw new Error(); }
+
+	// --- Start Positron ---
+	async writeClipboardImage(dataUri: string): Promise<void> { }
+	// --- End Positron ---
 }
 
 export class TestExtensionTipsService extends AbstractNativeExtensionTipsService {