This repository has been archived by the owner on Mar 22, 2024. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 13
/
editorAppBase.ts
268 lines (230 loc) · 10 KB
/
editorAppBase.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
import { editor, Uri } from 'monaco-editor';
import { createConfiguredEditor, createConfiguredDiffEditor, createModelReference, ITextFileEditorModel } from 'vscode/monaco';
import { IReference } from '@codingame/monaco-vscode-editor-service-override';
import { updateUserConfiguration as vscodeUpdateUserConfiguration } from '@codingame/monaco-vscode-configuration-service-override';
export type ModelUpdate = {
languageId: string;
code?: string;
codeUri?: string;
codeOriginal?: string;
codeOriginalUri?: string;
}
export type EditorAppType = 'extended' | 'classic';
export type EditorAppConfigBase = ModelUpdate & {
$type: EditorAppType;
useDiffEditor: boolean;
domReadOnly?: boolean;
readOnly?: boolean;
awaitExtensionReadiness?: Array<() => Promise<void>>;
overrideAutomaticLayout?: boolean;
editorOptions?: editor.IStandaloneEditorConstructionOptions;
diffEditorOptions?: editor.IStandaloneDiffEditorConstructionOptions;
}
export enum ModelUpdateType {
NONE,
CODE,
MODEL
}
/**
* This is the base class for both Monaco Ediotor Apps:
* - EditorAppClassic
* - EditorAppExtended
*
* It provides the generic functionality for both implementations.
*/
export abstract class EditorAppBase {
private id: string;
private editor: editor.IStandaloneCodeEditor | undefined;
private diffEditor: editor.IStandaloneDiffEditor | undefined;
private modelRef: IReference<ITextFileEditorModel> | undefined;
private modelOriginalRef: IReference<ITextFileEditorModel> | undefined;
constructor(id: string) {
this.id = id;
}
protected buildConfig(userAppConfig: EditorAppConfigBase): EditorAppConfigBase {
const config: EditorAppConfigBase = {
$type: userAppConfig.$type,
languageId: userAppConfig.languageId,
code: userAppConfig.code ?? '',
codeOriginal: userAppConfig.codeOriginal ?? '',
useDiffEditor: userAppConfig.useDiffEditor === true,
codeUri: userAppConfig.codeUri ?? undefined,
codeOriginalUri: userAppConfig.codeOriginalUri ?? undefined,
readOnly: userAppConfig.readOnly ?? false,
domReadOnly: userAppConfig.domReadOnly ?? false,
overrideAutomaticLayout: userAppConfig.overrideAutomaticLayout ?? true,
awaitExtensionReadiness: userAppConfig.awaitExtensionReadiness ?? undefined,
};
config.editorOptions = {
...userAppConfig.editorOptions,
automaticLayout: userAppConfig.overrideAutomaticLayout ?? true
};
config.diffEditorOptions = {
...userAppConfig.diffEditorOptions,
automaticLayout: userAppConfig.overrideAutomaticLayout ?? true
};
return config;
}
haveEditor() {
return this.editor !== undefined || this.diffEditor !== undefined;
}
getEditor(): editor.IStandaloneCodeEditor | undefined {
return this.editor;
}
getDiffEditor(): editor.IStandaloneDiffEditor | undefined {
return this.diffEditor;
}
async createEditors(container: HTMLElement): Promise<void> {
if (this.getConfig().useDiffEditor) {
this.diffEditor = createConfiguredDiffEditor(container, this.getConfig().diffEditorOptions);
await this.updateDiffEditorModel();
} else {
this.editor = createConfiguredEditor(container, this.getConfig().editorOptions);
await this.updateEditorModel();
}
}
protected disposeEditor() {
if (this.editor) {
this.modelRef?.dispose();
this.editor.dispose();
this.editor = undefined;
}
}
protected disposeDiffEditor() {
if (this.diffEditor) {
this.modelRef?.dispose();
this.modelOriginalRef?.dispose();
this.diffEditor.dispose();
this.diffEditor = undefined;
}
}
getModel(original?: boolean): editor.ITextModel | undefined {
if (this.getConfig().useDiffEditor) {
return ((original === true) ? this.modelOriginalRef?.object.textEditorModel : this.modelRef?.object.textEditorModel) ?? undefined;
} else {
return this.modelRef?.object.textEditorModel ?? undefined;
}
}
async updateModel(modelUpdate: ModelUpdate): Promise<void> {
if (!this.editor) {
return Promise.reject(new Error('You cannot update the editor model, because the regular editor is not configured.'));
}
const modelUpdateType = isModelUpdateRequired(this.getConfig(), modelUpdate);
if (modelUpdateType === ModelUpdateType.CODE) {
this.updateAppConfig(modelUpdate);
if (this.getConfig().useDiffEditor) {
this.diffEditor?.getModifiedEditor().setValue(modelUpdate.code ?? '');
this.diffEditor?.getOriginalEditor().setValue(modelUpdate.codeOriginal ?? '');
} else {
this.editor.setValue(modelUpdate.code ?? '');
}
} else if (modelUpdateType === ModelUpdateType.MODEL) {
this.updateAppConfig(modelUpdate);
await this.updateEditorModel();
}
return Promise.resolve();
}
private async updateEditorModel(): Promise<void> {
const config = this.getConfig();
this.modelRef?.dispose();
const uri: Uri = this.getEditorUri('code');
this.modelRef = await createModelReference(uri, config.code) as unknown as IReference<ITextFileEditorModel>;
this.modelRef.object.setLanguageId(config.languageId);
if (this.editor) {
this.editor.setModel(this.modelRef.object.textEditorModel);
}
}
async updateDiffModel(modelUpdate: ModelUpdate): Promise<void> {
if (!this.diffEditor) {
return Promise.reject(new Error('You cannot update the diff editor models, because the diffEditor is not configured.'));
}
if (isModelUpdateRequired(this.getConfig(), modelUpdate)) {
this.updateAppConfig(modelUpdate);
await this.updateDiffEditorModel();
}
return Promise.resolve();
}
private async updateDiffEditorModel(): Promise<void> {
const config = this.getConfig();
this.modelRef?.dispose();
this.modelOriginalRef?.dispose();
const uri: Uri = this.getEditorUri('code');
const uriOriginal: Uri = this.getEditorUri('codeOriginal');
const promises = [];
promises.push(createModelReference(uri, config.code));
promises.push(createModelReference(uriOriginal, config.codeOriginal));
const refs = await Promise.all(promises);
this.modelRef = refs[0] as unknown as IReference<ITextFileEditorModel>;
this.modelRef.object.setLanguageId(config.languageId);
this.modelOriginalRef = refs[1] as unknown as IReference<ITextFileEditorModel>;
this.modelOriginalRef.object.setLanguageId(config.languageId);
if (this.diffEditor && this.modelRef.object.textEditorModel !== null && this.modelOriginalRef.object.textEditorModel !== null) {
this.diffEditor?.setModel({
original: this.modelOriginalRef!.object!.textEditorModel,
modified: this.modelRef!.object!.textEditorModel
});
}
}
private updateAppConfig(modelUpdate: ModelUpdate) {
const config = this.getConfig();
config.languageId = modelUpdate.languageId;
config.code = modelUpdate.code;
config.codeUri = modelUpdate.codeUri;
config.codeOriginal = modelUpdate.codeOriginal;
config.codeOriginalUri = modelUpdate.codeOriginalUri;
}
getEditorUri(uriType: 'code' | 'codeOriginal') {
const config = this.getConfig();
const uri = uriType === 'code' ? config.codeUri : config.codeOriginalUri;
if (uri) {
return Uri.parse(uri);
} else {
return Uri.parse(`/workspace/model${uriType === 'codeOriginal' ? 'Original' : ''}${this.id}.${config.languageId}`);
}
}
updateLayout() {
if (this.getConfig().useDiffEditor) {
this.diffEditor?.layout();
} else {
this.editor?.layout();
}
}
async awaitReadiness(awaitExtensionReadiness?: Array<() => Promise<void>>) {
if (awaitExtensionReadiness) {
const allPromises: Array<Promise<void>> = [];
for (const awaitReadiness of awaitExtensionReadiness) {
allPromises.push(awaitReadiness());
}
return Promise.all(allPromises);
}
return Promise.resolve();
}
updateMonacoEditorOptions(options: editor.IEditorOptions & editor.IGlobalEditorOptions) {
this.getEditor()?.updateOptions(options);
}
async updateUserConfiguration(json?: string) {
if (json) {
return vscodeUpdateUserConfiguration(json);
}
return Promise.resolve();
}
abstract init(): Promise<void>;
abstract specifyServices(): editor.IEditorOverrideServices;
abstract getConfig(): EditorAppConfigBase;
abstract disposeApp(): void;
abstract isAppConfigDifferent(orgConfig: EditorAppConfigBase, config: EditorAppConfigBase, includeModelData: boolean): boolean;
}
export const isCodeUpdateRequired = (config: EditorAppConfigBase, modelUpdate: ModelUpdate) => {
const updateRequired = (modelUpdate.code !== undefined && modelUpdate.code !== config.code) || modelUpdate.codeOriginal !== config.codeOriginal;
return updateRequired ? ModelUpdateType.CODE : ModelUpdateType.NONE;
};
export const isModelUpdateRequired = (config: EditorAppConfigBase, modelUpdate: ModelUpdate): ModelUpdateType => {
const codeUpdate = isCodeUpdateRequired(config, modelUpdate);
type ModelUpdateKeys = keyof typeof modelUpdate;
const propsModelUpdate = ['languageId', 'codeUri', 'codeOriginalUri'];
const propCompare = (name: string) => {
return config[name as ModelUpdateKeys] !== modelUpdate[name as ModelUpdateKeys];
};
const updateRequired = propsModelUpdate.some(propCompare);
return updateRequired ? ModelUpdateType.MODEL : codeUpdate;
};