src/vs/base/common/platform.ts
281 LOC · 206 covered · 75 uncovered · 14 ranges · 20961 concepts · 3 introducers · 12741 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
>
/*---------------------------------------------------------------------------------------------
map.ts ×97
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 * as nls from '../../nls.js';
7
>
8
>
export const LANGUAGE_DEFAULT = 'en';
9
>
10
>
let _isWindows = false;
11
>
let _isMacintosh = false;
12
>
let _isLinux = false;
13
>
let _isLinuxSnap = false;
14
>
let _isNative = false;
15
>
let _isWeb = false;
16
>
let _isElectron = false;
17
>
let _isIOS = false;
18
>
let _isCI = false;
19
>
let _isMobile = false;
20
>
let _locale: string | undefined = undefined;
21
>
let _language: string = LANGUAGE_DEFAULT;
22
>
let _platformLocale: string = LANGUAGE_DEFAULT;
23
>
let _translationsConfigFile: string | undefined = undefined;
24
>
let _userAgent: string | undefined = undefined;
25
>
26
>
export interface IProcessEnvironment {
27
>
[key: string]: string | undefined;
28
>
}
29
>
30
>
/**
31
>
* This interface is intentionally not identical to node.js
32
>
* process because it also works in sandboxed environments
33
>
* where the process object is implemented differently. We
34
>
* define the properties here that we need for `platform`
35
>
* to work and nothing else.
36
>
*/
37
>
export interface INodeProcess {
38
>
platform: string;
39
>
arch: string;
40
>
env: IProcessEnvironment;
41
>
versions?: {
42
>
node?: string;
43
>
electron?: string;
44
>
chrome?: string;
45
>
};
46
>
type?: string;
47
>
cwd: () => string;
48
>
}
49
>
50
>
declare const process: INodeProcess;
51
>
52
>
const $globalThis: any = globalThis;
53
>
54
>
let nodeProcess: INodeProcess | undefined = undefined;
55
>
if (typeof $globalThis.vscode !== 'undefined' && typeof $globalThis.vscode.process !== 'undefined') {
56
// Native environment (sandboxed)
57
nodeProcess = $globalThis.vscode.process;
58
>
} else if (typeof process !== 'undefined' && typeof process?.versions?.node === 'string') {
map.ts ×97
59
>
// Native environment (non-sandboxed)
60
>
nodeProcess = process;
61
>
}
62
>
63
>
const isElectronProcess = typeof nodeProcess?.versions?.electron === 'string';
64
>
const isElectronRenderer = isElectronProcess && nodeProcess?.type === 'renderer';
65
>
66
>
interface INavigator {
67
>
userAgent: string;
68
>
maxTouchPoints?: number;
69
>
language: string;
70
>
}
71
>
declare const navigator: INavigator;
72
>
73
>
// Native environment
74
>
if (typeof nodeProcess === 'object') {
75
>
_isWindows = (nodeProcess.platform === 'win32');
76
>
_isMacintosh = (nodeProcess.platform === 'darwin');
77
>
_isLinux = (nodeProcess.platform === 'linux');
78
>
_isLinuxSnap = _isLinux && !!nodeProcess.env['SNAP'] && !!nodeProcess.env['SNAP_REVISION'];
79
>
_isElectron = isElectronProcess;
80
>
_isCI = !!nodeProcess.env['CI'] || !!nodeProcess.env['BUILD_ARTIFACTSTAGINGDIRECTORY'] || !!nodeProcess.env['GITHUB_WORKSPACE'];
81
>
_locale = LANGUAGE_DEFAULT;
82
>
_language = LANGUAGE_DEFAULT;
83
>
const rawNlsConfig = nodeProcess.env['VSCODE_NLS_CONFIG'];
84
>
if (rawNlsConfig) {
85
try {
86
const nlsConfig: nls.INLSConfiguration = JSON.parse(rawNlsConfig);
87
_locale = nlsConfig.userLocale;
88
_platformLocale = nlsConfig.osLocale;
89
_language = nlsConfig.resolvedLanguage || LANGUAGE_DEFAULT;
90
_translationsConfigFile = nlsConfig.languagePack?.translationsConfigFile;
91
} catch (e) {
92
}
93
}
95
}
96
97
// Web environment
98
else if (typeof navigator === 'object' && !isElectronRenderer) {
99
_userAgent = navigator.userAgent;
100
_isWindows = _userAgent.indexOf('Windows') >= 0;
101
_isMacintosh = _userAgent.indexOf('Macintosh') >= 0;
102
_isIOS = (_userAgent.indexOf('Macintosh') >= 0 || _userAgent.indexOf('iPad') >= 0 || _userAgent.indexOf('iPhone') >= 0) && !!navigator.maxTouchPoints && navigator.maxTouchPoints > 0;
103
_isLinux = _userAgent.indexOf('Linux') >= 0;
104
_isMobile = _userAgent?.indexOf('Mobi') >= 0;
105
_isWeb = true;
106
_language = nls.getNLSLanguage() || LANGUAGE_DEFAULT;
107
_locale = navigator.language.toLowerCase();
108
_platformLocale = _locale;
109
}
110
111
// Unknown environment
112
else {
113
console.error('Unable to resolve platform.');
114
}
116
>
export const enum Platform {
117
>
Web,
118
>
Mac,
119
>
Linux,
120
>
Windows
121
>
}
122
>
export type PlatformName = 'Web' | 'Windows' | 'Mac' | 'Linux';
123
>
124
>
export function PlatformToString(platform: Platform): PlatformName {
126
>
case Platform.Web: return 'Web';
127
>
case Platform.Mac: return 'Mac';
128
>
case Platform.Linux: return 'Linux';
129
>
case Platform.Windows: return 'Windows';
130
>
}
131
>
}
133
>
let _platform: Platform = Platform.Web;
134
>
if (_isMacintosh) {
135
_platform = Platform.Mac;
137
_platform = Platform.Windows;
139
>
_platform = Platform.Linux;
140
>
}
141
>
142
>
export const isWindows = _isWindows;
143
>
export const isMacintosh = _isMacintosh;
144
>
export const isLinux = _isLinux;
145
>
export const isLinuxSnap = _isLinuxSnap;
146
>
export const isNative = _isNative;
147
>
export const isElectron = _isElectron;
148
>
export const isWeb = _isWeb;
149
>
export const isWebWorker = (_isWeb && typeof $globalThis.importScripts === 'function');
150
>
export const webWorkerOrigin = isWebWorker ? $globalThis.origin : undefined;
151
>
export const isIOS = _isIOS;
152
>
export const isMobile = _isMobile;
153
>
/**
154
>
* Whether we run inside a CI environment, such as
155
>
* GH actions or Azure Pipelines.
156
>
*/
157
>
export const isCI = _isCI;
158
>
export const platform = _platform;
159
>
export const userAgent = _userAgent;
160
>
161
>
/**
162
>
* The language used for the user interface. The format of
163
>
* the string is all lower case (e.g. zh-tw for Traditional
164
>
* Chinese or de for German)
165
>
*/
166
>
export const language = _language;
167
>
168
>
export namespace Language {
169
>
170
>
export function value(): string {
171
return language;
172
}
174
>
export function isDefaultVariant(): boolean {
175
if (language.length === 2) {
176
return language === 'en';
177
} else if (language.length >= 3) {
178
return language[0] === 'e' && language[1] === 'n' && language[2] === '-';
179
} else {
180
return false;
181
}
182
}
184
>
export function isDefault(): boolean {
185
return language === 'en';
186
}
188
>
189
>
/**
190
>
* Desktop: The OS locale or the locale specified by --locale or `argv.json`.
191
>
* Web: matches `platformLocale`.
192
>
*
193
>
* The UI is not necessarily shown in the provided locale.
194
>
*/
195
>
export const locale = _locale;
196
>
197
>
/**
198
>
* This will always be set to the OS/browser's locale regardless of
199
>
* what was specified otherwise. The format of the string is all
200
>
* lower case (e.g. zh-tw for Traditional Chinese). The UI is not
201
>
* necessarily shown in the provided locale.
202
>
*/
203
>
export const platformLocale = _platformLocale;
204
>
205
>
/**
206
>
* The translations that are available through language packs.
207
>
*/
208
>
export const translationsConfigFile = _translationsConfigFile;
209
>
210
>
export const setTimeout0IsFaster = (typeof $globalThis.postMessage === 'function' && !$globalThis.importScripts);
211
>
212
>
/**
213
>
* See https://html.spec.whatwg.org/multipage/timers-and-user-prompts.html#:~:text=than%204%2C%20then-,set%20timeout%20to%204,-.
214
>
*
215
>
* Works similarly to `setTimeout(0)` but doesn't suffer from the 4ms artificial delay
216
>
* that browsers set when the nesting level is > 5.
217
>
*/
218
>
export const setTimeout0 = (() => {
219
>
if (setTimeout0IsFaster) {
220
interface IQueueElement {
221
id: number;
222
callback: () => void;
223
}
224
const pending: IQueueElement[] = [];
225
226
$globalThis.addEventListener('message', (e: any) => {
227
if (e.data && e.data.vscodeScheduleAsyncWork) {
228
for (let i = 0, len = pending.length; i < len; i++) {
229
const candidate = pending[i];
230
if (candidate.id === e.data.vscodeScheduleAsyncWork) {
231
pending.splice(i, 1);
232
candidate.callback();
233
return;
234
}
235
}
236
}
237
});
238
let lastId = 0;
239
return (callback: () => void) => {
240
const myId = ++lastId;
241
pending.push({
242
id: myId,
243
callback: callback
244
});
245
$globalThis.postMessage({ vscodeScheduleAsyncWork: myId }, '*');
246
};
247
}
249
>
})();
250
>
251
>
export const enum OperatingSystem {
252
>
Windows = 1,
253
>
Macintosh = 2,
254
>
Linux = 3
255
>
}
256
>
export const OS = (_isMacintosh || _isIOS ? OperatingSystem.Macintosh : (_isWindows ? OperatingSystem.Windows : OperatingSystem.Linux));
257
>
258
>
let _isLittleEndian = true;
259
>
let _isLittleEndianComputed = false;
260
>
export function isLittleEndian(): boolean {
262
>
_isLittleEndianComputed = true;
263
>
const test = new Uint8Array(2);
264
>
test[0] = 1;
265
>
test[1] = 2;
266
>
const view = new Uint16Array(test.buffer);
267
>
_isLittleEndian = (view[0] === (2 << 8) + 1);
268
>
}
269
>
return _isLittleEndian;
270
>
}
272
>
export const isChrome = !!(userAgent && userAgent.indexOf('Chrome') >= 0);
273
>
export const isFirefox = !!(userAgent && userAgent.indexOf('Firefox') >= 0);
274
>
export const isSafari = !!(!isChrome && (userAgent && userAgent.indexOf('Safari') >= 0));
275
>
export const isEdge = !!(userAgent && userAgent.indexOf('Edg/') >= 0);
276
>
export const isAndroid = !!(userAgent && userAgent.indexOf('Android') >= 0);
277
>
export const hasElectronUserAgent = !!(userAgent && userAgent.indexOf('Electron') >= 0);
278
>
279
>
export function isTahoeOrNewer(osVersion: string): boolean {
280
return parseFloat(osVersion) >= 25;
281
}