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
|
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import { URI, UriComponents } from 'vs/base/common/uri';
import { ExtensionIdentifier } from 'vs/platform/extensions/common/extensions';
import { IInstantiationService } from 'vs/platform/instantiation/common/instantiation';
import { IEditorSerializer } from 'vs/workbench/common/editor';
import { WebviewContentOptions, WebviewExtensionDescription, WebviewOptions } from 'vs/workbench/contrib/webview/browser/webview';
import { WebviewIcons } from 'vs/workbench/contrib/webviewPanel/browser/webviewIconManager';
import { WebviewInput } from './webviewEditorInput';
import { IWebviewWorkbenchService } from './webviewWorkbenchService';
export type SerializedWebviewOptions = WebviewOptions & WebviewContentOptions;
interface SerializedIconPath {
light: string | UriComponents;
dark: string | UriComponents;
}
export interface SerializedWebview {
readonly id: string;
readonly origin: string | undefined;
readonly viewType: string;
readonly providedId: string | undefined;
readonly title: string;
readonly options: SerializedWebviewOptions;
readonly extensionLocation: UriComponents | undefined;
readonly extensionId: string | undefined;
readonly state: any;
readonly iconPath: SerializedIconPath | undefined;
readonly group?: number;
}
export interface DeserializedWebview {
readonly id: string;
readonly origin: string | undefined;
readonly viewType: string;
readonly providedId: string | undefined;
readonly title: string;
readonly webviewOptions: WebviewOptions;
readonly contentOptions: WebviewContentOptions;
readonly extension: WebviewExtensionDescription | undefined;
readonly state: any;
readonly iconPath: WebviewIcons | undefined;
readonly group?: number;
}
export class WebviewEditorInputSerializer implements IEditorSerializer {
public static readonly ID = WebviewInput.typeId;
public constructor(
@IWebviewWorkbenchService private readonly _webviewWorkbenchService: IWebviewWorkbenchService
) { }
public canSerialize(input: WebviewInput): boolean {
return this._webviewWorkbenchService.shouldPersist(input);
}
public serialize(input: WebviewInput): string | undefined {
if (!this._webviewWorkbenchService.shouldPersist(input)) {
return undefined;
}
const data = this.toJson(input);
try {
return JSON.stringify(data);
} catch {
return undefined;
}
}
public deserialize(
_instantiationService: IInstantiationService,
serializedEditorInput: string
): WebviewInput {
const data = this.fromJson(JSON.parse(serializedEditorInput));
return this._webviewWorkbenchService.reviveWebview({
webviewInitInfo: {
id: data.id,
providedId: data.providedId,
origin: data.origin,
options: data.webviewOptions,
contentOptions: data.contentOptions,
extension: data.extension,
},
viewType: data.viewType,
title: data.title,
iconPath: data.iconPath,
state: data.state,
group: data.group
});
}
protected fromJson(data: SerializedWebview): DeserializedWebview {
return {
...data,
extension: reviveWebviewExtensionDescription(data.extensionId, data.extensionLocation),
iconPath: reviveIconPath(data.iconPath),
state: reviveState(data.state),
webviewOptions: restoreWebviewOptions(data.options),
contentOptions: restoreWebviewContentOptions(data.options),
};
}
protected toJson(input: WebviewInput): SerializedWebview {
return {
id: input.id,
origin: input.webview.origin,
viewType: input.viewType,
providedId: input.providedId,
title: input.getName(),
options: { ...input.webview.options, ...input.webview.contentOptions },
extensionLocation: input.extension ? input.extension.location : undefined,
extensionId: input.extension && input.extension.id ? input.extension.id.value : undefined,
state: input.webview.state,
iconPath: input.iconPath ? { light: input.iconPath.light, dark: input.iconPath.dark, } : undefined,
group: input.group
};
}
}
export function reviveWebviewExtensionDescription(
extensionId: string | undefined,
extensionLocation: UriComponents | undefined,
): WebviewExtensionDescription | undefined {
if (!extensionId) {
return undefined;
}
const location = reviveUri(extensionLocation);
if (!location) {
return undefined;
}
return {
id: new ExtensionIdentifier(extensionId),
location,
};
}
function reviveIconPath(data: SerializedIconPath | undefined) {
if (!data) {
return undefined;
}
const light = reviveUri(data.light);
const dark = reviveUri(data.dark);
return light && dark ? { light, dark } : undefined;
}
function reviveUri(data: string | UriComponents): URI;
function reviveUri(data: string | UriComponents | undefined): URI | undefined;
function reviveUri(data: string | UriComponents | undefined): URI | undefined {
if (!data) {
return undefined;
}
try {
if (typeof data === 'string') {
return URI.parse(data);
}
return URI.from(data);
} catch {
return undefined;
}
}
function reviveState(state: unknown | undefined): undefined | string {
return typeof state === 'string' ? state : undefined;
}
export function restoreWebviewOptions(options: SerializedWebviewOptions): WebviewOptions {
return options;
}
export function restoreWebviewContentOptions(options: SerializedWebviewOptions): WebviewContentOptions {
return {
...options,
localResourceRoots: options.localResourceRoots?.map(uri => reviveUri(uri)),
};
}
|
