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
|
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import { EditorInput } from 'vs/workbench/common/editor/editorInput';
import { EditorModel } from 'vs/workbench/common/editor/editorModel';
import { URI } from 'vs/base/common/uri';
import { DisposableStore, IReference } from 'vs/base/common/lifecycle';
import { ITextEditorModel, ITextModelService } from 'vs/editor/common/services/resolverService';
import { marked } from 'vs/base/common/marked/marked';
import { Schemas } from 'vs/base/common/network';
import { isEqual } from 'vs/base/common/resources';
import { requireToContent } from 'vs/workbench/contrib/welcomeWalkthrough/common/walkThroughContentProvider';
import { Dimension } from 'vs/base/browser/dom';
import { EditorInputCapabilities, IUntypedEditorInput } from 'vs/workbench/common/editor';
import { IInstantiationService } from 'vs/platform/instantiation/common/instantiation';
class WalkThroughModel extends EditorModel {
constructor(
private mainRef: string,
private snippetRefs: IReference<ITextEditorModel>[]
) {
super();
}
get main() {
return this.mainRef;
}
get snippets() {
return this.snippetRefs.map(snippet => snippet.object);
}
override dispose() {
this.snippetRefs.forEach(ref => ref.dispose());
super.dispose();
}
}
export interface WalkThroughInputOptions {
readonly typeId: string;
readonly name: string;
readonly description?: string;
readonly resource: URI;
readonly telemetryFrom: string;
readonly onReady?: (container: HTMLElement, contentDisposables: DisposableStore) => void;
readonly layout?: (dimension: Dimension) => void;
}
export class WalkThroughInput extends EditorInput {
override get capabilities(): EditorInputCapabilities {
return EditorInputCapabilities.Singleton | super.capabilities;
}
private promise: Promise<WalkThroughModel> | null = null;
private maxTopScroll = 0;
private maxBottomScroll = 0;
get resource() { return this.options.resource; }
constructor(
private readonly options: WalkThroughInputOptions,
@IInstantiationService private readonly instantiationService: IInstantiationService,
@ITextModelService private readonly textModelResolverService: ITextModelService
) {
super();
}
override get typeId(): string {
return this.options.typeId;
}
override getName(): string {
return this.options.name;
}
override getDescription(): string {
return this.options.description || '';
}
getTelemetryFrom(): string {
return this.options.telemetryFrom;
}
override getTelemetryDescriptor(): { [key: string]: unknown } {
const descriptor = super.getTelemetryDescriptor();
descriptor['target'] = this.getTelemetryFrom();
/* __GDPR__FRAGMENT__
"EditorTelemetryDescriptor" : {
"target" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }
}
*/
return descriptor;
}
get onReady() {
return this.options.onReady;
}
get layout() {
return this.options.layout;
}
override resolve(): Promise<WalkThroughModel> {
if (!this.promise) {
this.promise = requireToContent(this.instantiationService, this.options.resource)
.then(content => {
if (this.resource.path.endsWith('.html')) {
return new WalkThroughModel(content, []);
}
const snippets: Promise<IReference<ITextEditorModel>>[] = [];
let i = 0;
const renderer = new marked.Renderer();
renderer.code = (code, lang) => {
i++;
const resource = this.options.resource.with({ scheme: Schemas.walkThroughSnippet, fragment: `${i}.${lang}` });
snippets.push(this.textModelResolverService.createModelReference(resource));
return `<div id="snippet-${resource.fragment}" class="walkThroughEditorContainer" ></div>`;
};
content = marked(content, { renderer });
return Promise.all(snippets)
.then(refs => new WalkThroughModel(content, refs));
});
}
return this.promise;
}
override matches(otherInput: EditorInput | IUntypedEditorInput): boolean {
if (super.matches(otherInput)) {
return true;
}
if (otherInput instanceof WalkThroughInput) {
return isEqual(otherInput.options.resource, this.options.resource);
}
return false;
}
override dispose(): void {
if (this.promise) {
this.promise.then(model => model.dispose());
this.promise = null;
}
super.dispose();
}
public relativeScrollPosition(topScroll: number, bottomScroll: number) {
this.maxTopScroll = Math.max(this.maxTopScroll, topScroll);
this.maxBottomScroll = Math.max(this.maxBottomScroll, bottomScroll);
}
}
|
