src/vs/platform/opener/common/opener.ts
154 LOC · 154 covered · 0 uncovered · 4 ranges · 2331 concepts · 3 introducers · 1341 tests
File neighbourhood
The centred file is linked to every concept that introduces one of its ranges, every test that runs code from the file, and the gray connector concepts standing between those tests and the file's own introducer concepts. Undirected links join concepts to every file where they introduce source and concepts to the tests they introduce; arrows show specialization between the displayed concepts and bridge only concepts omitted from this view. Concept colors match the source ranges below; connector concepts have no source color and are shown in gray.
Focused file, its introducer and connector concepts, their introduced files, and tests that run code from the file
In the embedded map, ordinary wheel input scrolls the page; use the visible controls to zoom and drag to pan. Open the full-screen map for canvas navigation: wheel pans, Ctrl/Command plus wheel zooms, and arrow keys pan when this region is focused. On touch screens, open the full-screen map to pan or pinch. If JavaScript or WebGL is unavailable, use the related-file, concept, and source links on this page.
Graph controls are ready.
Interactive rendering requires JavaScript and WebGL. Use the related-file, concept, and source links on this page while the interactive map is unavailable.
1
>
/*---------------------------------------------------------------------------------------------
opener.ts ×2
2
>
* Copyright (c) Microsoft Corporation. All rights reserved.
3
>
* Licensed under the MIT License. See License.txt in the project root for license information.
4
>
*--------------------------------------------------------------------------------------------*/
5
>
6
>
import { CancellationToken } from '../../../base/common/cancellation.js';
7
>
import { IDisposable } from '../../../base/common/lifecycle.js';
8
>
import { URI } from '../../../base/common/uri.js';
9
>
import { IEditorOptions, ITextEditorSelection } from '../../editor/common/editor.js';
10
>
import { createDecorator } from '../../instantiation/common/instantiation.js';
11
>
12
>
export const IOpenerService = createDecorator<IOpenerService>('openerService');
13
>
14
>
export type OpenInternalOptions = {
15
>
16
>
/**
17
>
* Signals that the intent is to open an editor to the side
18
>
* of the currently active editor.
19
>
*/
20
>
readonly openToSide?: boolean;
21
>
22
>
/**
23
>
* Extra editor options to apply in case an editor is used to open.
24
>
*/
25
>
readonly editorOptions?: IEditorOptions;
26
>
27
>
/**
28
>
* Signals that the editor to open was triggered through a user
29
>
* action, such as keyboard or mouse usage.
30
>
*/
31
>
readonly fromUserGesture?: boolean;
32
>
33
>
/**
34
>
* Allow command links to be handled.
35
>
*
36
>
* If this is an array, then only the commands included in the array can be run.
37
>
*/
38
>
readonly allowCommands?: boolean | readonly string[];
39
>
};
40
>
41
>
export type OpenExternalOptions = {
42
>
readonly openExternal?: boolean;
43
>
readonly allowTunneling?: boolean;
44
>
readonly allowContributedOpeners?: boolean | string;
45
>
readonly fromWorkspace?: boolean;
46
>
readonly skipValidation?: boolean;
47
>
};
48
>
49
>
export type OpenOptions = OpenInternalOptions & OpenExternalOptions;
50
>
51
>
export type ResolveExternalUriOptions = { readonly allowTunneling?: boolean };
52
>
53
>
export interface IResolvedExternalUri extends IDisposable {
54
>
resolved: URI;
55
>
}
56
>
57
>
export interface IOpener {
58
>
open(resource: URI | string, options?: OpenInternalOptions | OpenExternalOptions): Promise<boolean>;
59
>
}
60
>
61
>
export interface IExternalOpener {
62
>
openExternal(href: string, ctx: { sourceUri: URI; preferredOpenerId?: string }, token: CancellationToken): Promise<boolean>;
63
>
dispose?(): void;
64
>
}
65
>
66
>
export interface IValidator {
67
>
shouldOpen(resource: URI | string, openOptions?: OpenOptions): Promise<boolean>;
68
>
}
69
>
70
>
export interface IExternalUriResolver {
71
>
resolveExternalUri(resource: URI, options?: OpenOptions): Promise<{ resolved: URI; dispose(): void } | undefined>;
72
>
}
73
>
74
>
export interface IOpenerService {
75
>
76
>
readonly _serviceBrand: undefined;
77
>
78
>
/**
79
>
* Register a participant that can handle the open() call.
80
>
*/
81
>
registerOpener(opener: IOpener): IDisposable;
82
>
83
>
/**
84
>
* Register a participant that can validate if the URI resource be opened.
85
>
* Validators are run before openers.
86
>
*/
87
>
registerValidator(validator: IValidator): IDisposable;
88
>
89
>
/**
90
>
* Register a participant that can resolve an external URI resource to be opened.
91
>
*/
92
>
registerExternalUriResolver(resolver: IExternalUriResolver): IDisposable;
93
>
94
>
/**
95
>
* Sets the handler for opening externally. If not provided,
96
>
* a default handler will be used.
97
>
*/
98
>
setDefaultExternalOpener(opener: IExternalOpener): void;
99
>
100
>
/**
101
>
* Registers a new opener external resources openers.
102
>
*/
103
>
registerExternalOpener(opener: IExternalOpener): IDisposable;
104
>
105
>
/**
106
>
* Opens a resource, like a webaddress, a document uri, or executes command.
107
>
*
108
>
* @param resource A resource
109
>
* @return A promise that resolves when the opening is done.
110
>
*/
111
>
open(resource: URI | string, options?: OpenInternalOptions | OpenExternalOptions): Promise<boolean>;
112
>
113
>
/**
114
>
* Resolve a resource to its external form.
115
>
* @throws whenever resolvers couldn't resolve this resource externally.
116
>
*/
117
>
resolveExternalUri(resource: URI, options?: ResolveExternalUriOptions): Promise<IResolvedExternalUri>;
118
>
}
119
>
120
>
/**
121
>
* Encodes selection into the `URI`.
122
>
*
123
>
* IMPORTANT: you MUST use `extractSelection` to separate the selection
124
>
* again from the original `URI` before passing the `URI` into any
125
>
* component that is not aware of selections.
126
>
*/
127
>
export function withSelection(uri: URI, selection: ITextEditorSelection): URI {
128
>
return uri.with({ fragment: `${selection.startLineNumber},${selection.startColumn}${selection.endLineNumber ? `-${selection.endLineNumber}${selection.endColumn ? `,${selection.endColumn}` : ''}` : ''}` });
opener.ts ×1
129
>
}
131
>
/**
132
>
* file:///some/file.js#73
133
>
* file:///some/file.js#L73
134
>
* file:///some/file.js#73,84
135
>
* file:///some/file.js#L73,84
136
>
* file:///some/file.js#73-83
137
>
* file:///some/file.js#L73-L83
138
>
* file:///some/file.js#73,84-83,52
139
>
* file:///some/file.js#L73,84-L83,52
140
>
*/
141
>
export function extractSelection(uri: URI): { selection: ITextEditorSelection | undefined; uri: URI } {
143
>
const match = /^L?(\d+)(?:,(\d+))?(-L?(\d+)(?:,(\d+))?)?/.exec(uri.fragment);
144
>
if (match) {
145
>
selection = {
146
>
startLineNumber: parseInt(match[1]),
147
>
startColumn: match[2] ? parseInt(match[2]) : 1,
148
>
endLineNumber: match[4] ? parseInt(match[4]) : undefined,
149
>
endColumn: match[4] ? (match[5] ? parseInt(match[5]) : 1) : undefined
150
>
};
151
>
uri = uri.with({ fragment: '' });
152
>
}
153
>
return { selection, uri };
154
>
}