-
Notifications
You must be signed in to change notification settings - Fork 450
/
kit.ts
1248 lines (1122 loc) · 44.5 KB
/
kit.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
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* Module for controlling and working with Kits.
*/ /** */
import rollbar from '@cmt/rollbar';
import * as util from '@cmt/util';
import * as json5 from 'json5';
import * as path from 'path';
import * as vscode from 'vscode';
import * as kitsController from '@cmt/kitsController';
import CMakeTools from './cmake-tools';
import * as expand from './expand';
import {VSInstallation, vsInstallations} from './installs/visual-studio';
import * as logging from './logging';
import paths from './paths';
import {fs} from './pr';
import * as proc from './proc';
import {loadSchema} from './schema';
import {compare, dropNulls, objectPairs, Ordering, versionLess} from './util';
import * as nls from 'vscode-nls';
nls.config({ messageFormat: nls.MessageFormat.bundle, bundleFormat: nls.BundleFormat.standalone })();
const localize: nls.LocalizeFunc = nls.loadMessageBundle();
const log = logging.createLogger('kit');
/**
* Special kit types and names
*/
export enum SpecialKits {
ScanForKits = '__scanforkits__',
Unspecified = '__unspec__'
}
export const SpecialKitsCount: number = 2;
export type UnspecifiedKit = SpecialKits.Unspecified;
type ProgressReporter = vscode.Progress<{message?: string}>;
/**
* The path to the user-local kits file.
*/
export const USER_KITS_FILEPATH = path.join(paths.dataDir, 'cmake-tools-kits.json');
/**
* The old path where kits were stored. Upgraded in 1.1.3
*/
export const OLD_USER_KITS_FILEPATH
= path.join(process.platform === 'win32' ? paths.roamingDataDir : paths.dataDir, 'cmake-tools.json');
/**
* Representation of a CMake generator, along with a toolset and platform
*/
export interface CMakeGenerator {
name: string;
toolset?: string;
platform?: string;
}
export interface Kit {
/**
* The name of the kit
*/
name: string;
/**
* The preferred CMake generator for this kit
*/
preferredGenerator?: CMakeGenerator;
/**
* Additional settings to pass to CMake
*/
cmakeSettings?: {[key: string]: string};
/**
* Additional environment variables for the kit
*/
environmentVariables?: proc.EnvironmentVariables;
/**
* The language compilers.
*
* The key `lang` is the language, as in `CMAKE_<lang>_COMPILER`.
* The corresponding value is a path to a compiler for that language.
*/
compilers?: {[lang: string]: string};
/**
* The visual studio name. This corresponds to the major.minor version of
* the installation returned by `vswhere`.
*/
visualStudio?: string;
/**
* The architecture for the kit. This is used when asking for the architecture
* from the dev environment batch file.
*/
visualStudioArchitecture?: string;
/**
* Filename of a shell script which sets environment variables for the kit
*/
environmentSetupScript?: string;
/**
* Path to a CMake toolchain file.
*/
toolchainFile?: string;
/**
* If `true`, keep this kit around even if it seems out-of-date
*/
keep?: boolean;
}
interface ClangVersion {
fullVersion: string;
version: string;
target?: string;
threadModel?: string;
installedDir?: string;
}
async function getClangVersion(binPath: string): Promise<ClangVersion|null> {
log.debug(localize('testing.clang.binary', 'Testing Clang binary: {0}', binPath));
const exec = await proc.execute(binPath, ['-v']).result;
if (exec.retc !== 0) {
log.debug(localize('bad.clang.binary', 'Bad Clang binary ("-v" returns non-zero): {0}', binPath));
return null;
}
const lines = exec.stderr.split('\n');
const version_re = /^(?:Apple LLVM|.*clang) version ([^\s-]+)[\s-]/;
let version: string = "";
let fullVersion: string = "";
for (const line of lines) {
const version_match = version_re.exec(line);
if (version_match !== null) {
version = version_match[1];
fullVersion = line;
break;
}
}
if (!version) {
log.debug(localize('bad.clang.binary.output', 'Bad Clang binary {0} -v output: {1}', binPath, exec.stderr));
return null;
}
const target_mat = /Target:\s+(.*)/.exec(exec.stderr);
let target: string|undefined;
if (target_mat) {
target = target_mat[1];
}
const thread_model_mat = /Thread model:\s+(.*)/.exec(exec.stderr);
let threadModel: string|undefined;
if (thread_model_mat) {
threadModel = thread_model_mat[1];
}
const install_dir_mat = /InstalledDir:\s+(.*)/.exec(exec.stderr);
let installedDir: string|undefined;
if (install_dir_mat) {
installedDir = install_dir_mat[1];
}
return {
fullVersion,
version,
target,
threadModel,
installedDir,
};
}
/**
* Convert a binary (by path) to a CompilerKit. This checks if the named binary
* is a GCC or Clang compiler and gets its version. If it is not a compiler,
* returns `null`.
* @param bin Path to a binary
* @returns A CompilerKit, or null if `bin` is not a known compiler
*/
export async function kitIfCompiler(bin: string, pr?: ProgressReporter): Promise<Kit|null> {
const fname = path.basename(bin);
// Check by filename what the compiler might be. This is just heuristic.
const gcc_regex = /^((\w+-)*)gcc(-\d+(\.\d+(\.\d+)?)?)?(\.exe)?$/;
const clang_regex = /^clang(-\d+(\.\d+(\.\d+)?)?)?(\.exe)?$/;
const gcc_res = gcc_regex.exec(fname);
const clang_res = clang_regex.exec(fname);
if (gcc_res) {
log.debug(localize('testing.gcc.binary', 'Testing GCC binary: {0}', bin));
if (pr)
pr.report({message: localize('getting.gcc.version', 'Getting GCC version for {0}', bin)});
const exec = await proc.execute(bin, ['-v']).result;
if (exec.retc !== 0) {
log.debug(localize('bad.gcc.binary', 'Bad GCC binary ("-v" returns non-zero): {0}', bin));
return null;
}
const compiler_version_output = exec.stderr.trim().split('\n');
const version_re = /^gcc version (.*?) .*/;
let version: string = "";
for (const line of compiler_version_output) {
const version_match = version_re.exec(line);
if (version_match !== null) {
version = version_match[1];
break;
}
}
if (!version) {
log.debug(localize('bad.gcc.binary.output', 'Bad GCC binary {0} -v output: {1}', bin, exec.stderr));
return null;
}
const gxx_fname = fname.replace(/gcc/, 'g++');
const gxx_bin = path.join(path.dirname(bin), gxx_fname);
const target_triple_re = /((\w+-)+)gcc.*/;
const target_triple_match = target_triple_re.exec(fname);
let description = '';
if (target_triple_match !== null) {
description += `for ${target_triple_match[1].slice(0, -1)} `;
}
const name = `GCC ${description}${version}`;
log.debug(localize('detected.gcc.compiler', 'Detected GCC compiler: {0}', bin));
let gccKit: Kit = {
name,
compilers: {
C: bin,
}
};
if (await fs.exists(gxx_bin)) {
gccKit = {name, compilers: {C: bin, CXX: gxx_bin}};
}
const isWin32 = process.platform === 'win32';
if (isWin32 && bin.toLowerCase().includes('mingw')) {
const binParentPath = path.dirname(bin);
const mingwMakePath = path.join(binParentPath, 'mingw32-make.exe');
if (await fs.exists(mingwMakePath)) {
// During a scan, binParentPath must be a directory already in the PATH.
// Therefore, we will assume that MinGW will remain in the user's PATH
// and do not need to record the current state of PATH (leave it to the
// user to rescan later or specify an explicit path to MinGW if this
// changes). Additionally, caching the current state of PATH can cause
// complications on later invocation when using the kit environment
// because its PATH will take precedence. If a user makes changes to
// their PATH later without rescanning for kits, then the kit's cached
// PATH will clobber the actual current PATH. We will, however, record
// the MinGW path in case we want to use it later.
const ENV_PATH = `${binParentPath}`;
// Check for working mingw32-make
const execMake = await proc.execute(mingwMakePath, ['-v'], null, {environment: {PATH: ENV_PATH}}).result;
if (execMake.retc !== 0) {
log.debug(localize('bad.mingw32-make.binary', 'Bad mingw32-make binary ("-v" returns non-zero): {0}', bin));
} else {
let make_version_output = execMake.stdout;
if (make_version_output.length === 0)
make_version_output = execMake.stderr;
const output_line_sep = make_version_output.trim().split('\n');
const isMake = output_line_sep[0].includes('Make');
const isMingwTool = output_line_sep[1].includes('mingw32');
if (isMake && isMingwTool) {
gccKit.preferredGenerator = {name: 'MinGW Makefiles'};
// save the ENV_PATH as a benign name unlikely to already exist in
// the user's environment, like CMT_MINGW_PATH
gccKit.environmentVariables = {CMT_MINGW_PATH: ENV_PATH};
}
}
}
}
return gccKit;
} else if (clang_res) {
log.debug(localize('testing.clang.binary', 'Testing Clang binary: {0}', bin));
if (pr)
pr.report({message: localize('getting.clang.version', 'Getting Clang version for {0}', bin)});
const version = await getClangVersion(bin);
if (version === null) {
return null;
}
if (version.target && version.target.includes('msvc') &&
version.installedDir && version.installedDir.includes("Microsoft Visual Studio")) {
// Skip MSVC ABI compatible Clang installations (bundled within VS), which will be handled in 'scanForClangForMSVCKits()' later.
// But still process any Clang installations outside VS (right in Program Files for example), even if their version
// mentions msvc.
return null;
}
const clangxx_fname = fname.replace(/^clang/, 'clang++');
const clangxx_bin = path.join(path.dirname(bin), clangxx_fname);
let name = `Clang ${version.version}`;
// On windows (except MinGW, Cygwin, etc... represented by a non undefined process.env.MSYSTEM),
// make the distinction between [Program Files]/LLVM and [Program Files(x86)]/LLVM in the kit name,
// to be able to represent both in the kits file.
// clang --version returns the same version.version for these 2 different installs,
// but version.target differs and can be used to ensure name uniqueness.
if (process.platform === "win32" && process.env.MSYSTEM === undefined) {
name += ` (${version.target})`;
}
log.debug(localize('detected.clang.compiler', 'Detected Clang compiler: {0}', bin));
if (await fs.exists(clangxx_bin)) {
return {
name,
compilers: {
C: bin,
CXX: clangxx_bin,
},
};
} else {
return {
name,
compilers: {
C: bin,
},
};
}
} else {
return null;
}
}
async function scanDirectory<Ret>(dir: string, mapper: (filePath: string) => Promise<Ret|null>): Promise<Ret[]> {
if (!await fs.exists(dir)) {
log.debug(localize('skipping.scan.of.not.existing.path', 'Skipping scan of not existing path {0}', dir));
return [];
}
log.debug(localize('scanning.directory.for.compilers', 'Scanning directory {0} for compilers', dir));
try {
const stat = await fs.stat(dir);
if (!stat.isDirectory()) {
console.log('Skipping scan of non-directory', dir);
return [];
}
} catch (e) {
log.warning(localize('failed.to.scan', 'Failed to scan {0} by exception: {1}', dir, util.errorToString(e)));
if (e.code == 'ENOENT') {
return [];
}
throw e;
}
// Get files in the directory
let bins: string[];
try {
bins = (await fs.readdir(dir)).map(f => path.join(dir, f));
} catch (e) {
if (e.code == 'EACCESS' || e.code == 'EPERM') {
return [];
}
throw e;
}
const prs = await Promise.all(bins.map(b => mapper(b)));
return dropNulls(prs);
}
/**
* Scans a directory for compiler binaries.
* @param dir Directory containing candidate binaries
* @returns A list of CompilerKits found
*/
export async function scanDirForCompilerKits(dir: string, pr?: ProgressReporter): Promise<Kit[]> {
const kits = await scanDirectory(dir, async bin => {
log.trace(localize('checking.file.for.compiler.features', 'Checking file for compiler features: {0}', bin));
try {
return await kitIfCompiler(bin, pr);
} catch (e) {
log.warning(localize('filed.to.check.binary', 'Failed to check binary {0} by exception: {1}', bin, util.errorToString(e)));
if (e.code == 'EACCES') {
// The binary may not be executable by this user...
return null;
} else if (e.code == 'ENOENT') {
// This will happen on Windows if we try to "execute" a directory
return null;
} else if (e.code == 'UNKNOWN' && process.platform == 'win32') {
// This is when file is not executable (in windows)
return null;
}
const stat = await fs.stat(bin);
log.debug('File infos: ',
'Mode',
stat.mode,
'isFile',
stat.isFile(),
'isDirectory',
stat.isDirectory(),
'isSymbolicLink',
stat.isSymbolicLink());
rollbar.exception(localize('failed.to.scan.kit', 'Failed to scan a kit file'), e, {bin, exception: e.code, stat});
return null;
}
});
log.debug(localize('founds.kits.in.directory', 'Found {0} kits in directory {1}', kits.length, dir));
return kits;
}
/**
* Construct the Kit.visualStudio property (legacy)
*
* @param inst The VSInstallation to use
*/
function legacyKitVSName(inst: VSInstallation): string {
return `VisualStudio.${parseInt(inst.installationVersion)}.0`;
}
/**
* Construct the Kit.visualStudio property.
*
* @param inst The VSInstallation to use
*/
function kitVSName(inst: VSInstallation): string {
return `${inst.instanceId}`;
}
/**
* Construct the Visual Studio version string.
*
* @param inst The VSInstallation to use
*/
export function vsVersionName(inst: VSInstallation): string {
if (!inst.catalog) {
return inst.instanceId;
}
const end = inst.catalog.productDisplayVersion.indexOf('[');
return end < 0 ? inst.catalog.productDisplayVersion : inst.catalog.productDisplayVersion.substring(0, end - 1);
}
/**
* Construct the display name (this will be paired with an
* arch later to construct the Kit.name property).
*
* @param inst The VSInstallation to use
*/
export function vsDisplayName(inst: VSInstallation): string {
if (inst.displayName) {
if (inst.channelId) {
const index = inst.channelId.lastIndexOf('.');
if (index > 0) {
return `${inst.displayName} ${inst.channelId.substr(index + 1)}`;
}
}
return inst.displayName;
}
return inst.instanceId;
}
/**
* Construct the Kit.name property.
*
* @param inst The VSInstallation to use
* @param hostArch The architecture of the toolset host (e.g. x86, x64|amd64)
* @param targetArch The architecture of the toolset target (e.g. win32|x86, x64|amd64, arm, arm64)
*/
function vsKitName(inst: VSInstallation, hostArch: string, targetArch?: string): string {
// We still keep the amd64 alias for x64, only in the name of the detected VS kits,
// for compatibility reasons. Switching to 'x64' means leaving
// orphaned 'amd64' kits around ("Scan for kits" does not delete them yet)
// and also it may require a new kit selection.
// VS toolsets paths on disk, vcvarsall.bat parameters and CMake arguments are all x64 now.
// We can revise later whether to change to 'x64' in the VS kit name as well and how to mitigate it.
return `${vsDisplayName(inst)} - ${kitHostTargetArch(hostArch, targetArch, true)}`;
}
/**
* Create the host-target arch specification of a VS install,
* from the VS kit architecture (host) and generator platform (target).
* @param hostArch The architecture of the host toolset
* @param targetArch The architecture of the target
* @param amd64Alias Whether amd64 is preferred over x64.
*/
function kitHostTargetArch(hostArch: string, targetArch?: string, amd64Alias: boolean = false): string {
// There are cases when we don't want to use the 'x64' alias of the 'amd64' architecture,
// like for older VS installs, for the VS kit names (for compatibility reasons)
// or for arm/arm64 specific vcvars scripts.
if (amd64Alias) {
if (hostArch === "x64") {
hostArch = "amd64";
}
if (targetArch === "x64") {
targetArch = "amd64";
}
}
if (!targetArch) {
targetArch = hostArch;
}
// CMake preferred generator platform requires 'win32', while vcvars are still using 'x86'.
// This function is called only for VS generators, so it is safe to overwrite
// targetArch with the vcvars naming.
// In case of any future new mismatches, use the vsArchFromGeneratorPlatform table
// instead of hard coding for win32 and x86.
// Currently, there is no need of a similar overwrite operation on hostArch,
// because CMake host target does not have the same name mismatch with VS.
targetArch = vsArchFromGeneratorPlatform[targetArch] || targetArch;
return (hostArch === targetArch) ? hostArch : `${hostArch}_${targetArch}`;
}
/**
* List of environment variables required for Visual C++ to run as expected for
* a VS installation.
*/
const MSVC_ENVIRONMENT_VARIABLES = [
'CL',
'_CL_',
'INCLUDE',
'LIBPATH',
'LINK',
'_LINK_',
'LIB',
'PATH',
'TMP',
'FRAMEWORKDIR',
'FRAMEWORKDIR64',
'FRAMEWORKVERSION',
'FRAMEWORKVERSION64',
'UCRTCONTEXTROOT',
'UCRTVERSION',
'UNIVERSALCRTSDKDIR',
'VCINSTALLDIR',
'VCTARGETSPATH',
'WINDOWSLIBPATH',
'WINDOWSSDKDIR',
'WINDOWSSDKLIBVERSION',
'WINDOWSSDKVERSION',
'VISUALSTUDIOVERSION'
];
/**
* Get the environment variables corresponding to a VS dev batch file.
* @param devbat Path to a VS environment batch file
* @param args List of arguments to pass to the batch file
*/
async function collectDevBatVars(devbat: string, args: string[], major_version: number, common_dir: string):
Promise<Map<string, string>|undefined> {
const fname = Math.random().toString() + '.bat';
const batfname = `vs-cmt-${fname}`;
const envfname = batfname + '.env';
const bat = [
`@echo off`,
`cd /d "%~dp0"`,
`set "VS${major_version}0COMNTOOLS=${common_dir}"`,
`set "INCLUDE="`,
`call "${devbat}" ${args.join(' ')}`,
`cd /d "%~dp0"`, /* Switch back to original drive */
];
for (const envvar of MSVC_ENVIRONMENT_VARIABLES) {
bat.push(`echo ${envvar} := %${envvar}% >> ${envfname}`);
}
// writeFile and unlink don't need quotes (they work just fine with an unquoted path with space)
// but they might fail sometimes if quotes are present, so remove for now any surrounding quotes
// that may have been defined by the user (the command prompt experience makes it very likely
// for the user to use quotes when defining an environment variable with a space containing path).
let tmpDir: string = paths.tmpDir;
if (!tmpDir) {
console.log(`TEMP dir is not set. ${devbat} will not run.`);
return;
}
tmpDir = tmpDir.trim();
if (tmpDir.startsWith('"') && tmpDir.endsWith('"')) {
tmpDir = tmpDir.substring(1, tmpDir.length - 1);
}
const batpath = path.join(tmpDir, batfname);
const envpath = path.join(tmpDir, envfname);
try {
await fs.unlink(envpath);
} catch (error) {}
const batContent = bat.join('\r\n');
await fs.writeFile(batpath, batContent);
// Quote the script file path before running it, in case there are spaces.
const res = await proc.execute(`"${batpath}"`, [], null, { shell: true, silent: true }).result;
await fs.unlink(batpath);
const output = (res.stdout) ? res.stdout + (res.stderr || '') : res.stderr;
let env = '';
try {
/* When the bat running failed, envpath would not exist */
env = await fs.readFile(envpath, {encoding: 'utf8'});
await fs.unlink(envpath);
} catch (error) { log.error(error); }
if (!env || env === '') {
log.error(localize('script.run.error',
'Error running:{0} with args:{1}\nOutput are:\n{2}\nBat content are:\n{3}',
devbat, args.join(' '), output, batContent));
return;
}
const vars
= env.split('\n').map(l => l.trim()).filter(l => l.length !== 0).reduce<Map<string, string>>((acc, line) => {
const mat = /(\w+) := ?(.*)/.exec(line);
if (mat) {
acc.set(mat[1], mat[2]);
} else {
log.error(localize('error.parsing.environment', 'Error parsing environment variable: {0}', line));
}
return acc;
}, new Map());
if (vars.get('INCLUDE') === '') {
log.error(localize('script.run.error.check',
'Error running:{0} with args:{1}\nCannot find INCLUDE within:\n{2}\nBat content are:\n{3}',
devbat, args.join(' '), env, batContent));
return;
}
log.debug(localize('ok.running', 'OK running {0} {1}, env vars: {2}', devbat, args.join(' '), JSON.stringify([...vars])));
return vars;
}
/**
* Gets the environment variables set by a shell script.
* @param kit The kit to get the environment variables for
*/
export async function getShellScriptEnvironment(kit: Kit, opts?: expand.ExpansionOptions): Promise<Map<string, string>|undefined> {
console.assert(kit.environmentSetupScript);
const filename = Math.random().toString() + (process.platform == 'win32' ? '.bat' : '.sh');
const script_filename = `vs-cmt-${filename}`;
const environment_filename = script_filename + '.env';
// writeFile and unlink don't need quotes (they work just fine with an unquoted path with space)
// but they might fail sometimes if quotes are present, so remove for now any surrounding quotes
// that may have been defined by the user (the command prompt experience makes it very likely
// for the user to use quotes when defining an environment variable with a space containing path).
let tmpDir: string = paths.tmpDir;
if (!tmpDir) {
console.log(`TEMP dir is not set. Shell script "${script_filename}" will not run.`);
return;
}
tmpDir = tmpDir.trim();
if (tmpDir.startsWith('"') && tmpDir.endsWith('"')) {
tmpDir = tmpDir.substring(1, tmpDir.length - 1);
}
const script_path = path.join(tmpDir, script_filename);
const environment_path = path.join(tmpDir, environment_filename); // path of temp file in which the script writes the env vars to
let script = '';
let run_command = '';
let environmentSetupScript = kit.environmentSetupScript;
if (opts) {
environmentSetupScript = await expand.expandString(environmentSetupScript!, opts);
}
if (process.platform == 'win32') { // windows
script += `call "${environmentSetupScript}"\r\n`; // call the user batch script
script += `set >> "${environment_path}"`; // write env vars to temp file
// Quote the script file path before running it, in case there are spaces.
run_command = `call "${script_path}"`;
} else { // non-windows
script += `source "${environmentSetupScript}"\n`; // run the user shell script
script +=`printenv >> ${environment_path}`; // write env vars to temp file
run_command = `/bin/bash -c "source ${script_path}"`; // run script in bash to enable bash-builtin commands like 'source'
}
try {
await fs.unlink(environment_path); // delete the temp file if it exists
} catch (error) {}
await fs.writeFile(script_path, script); // write batch file
const res = await proc.execute(run_command, [], null, {shell: true, silent: true}).result; // run script
await fs.unlink(script_path); // delete script file
const output = (res.stdout) ? res.stdout + (res.stderr || '') : res.stderr;
let env = '';
try {
/* When the script failed, envpath would not exist */
env = await fs.readFile(environment_path, {encoding: 'utf8'});
await fs.unlink(environment_path);
} catch (error) { log.error(error); }
if (!env || env === '') {
console.log(`Error running ${kit.environmentSetupScript} with:`, output);
return;
}
// split and trim env vars
const vars
= env.split('\n').map(l => l.trim()).filter(l => l.length !== 0).reduce<Map<string, string>>((acc, line) => {
const match = /(\w+)=?(.*)/.exec(line);
if (match) {
acc.set(match[1], match[2]);
} else {
log.error(localize('error.parsing.environment', 'Error parsing environment variable: {0}', line));
}
return acc;
}, new Map());
log.debug(localize('ok.running', 'OK running {0}, env vars: {1}', kit.environmentSetupScript, JSON.stringify([...vars])));
return vars;
}
/**
* Platform arguments for VS Generators
* Currently, there is a mismatch only between x86 and win32.
* For example, VS kits x86 and amd64_x86 will generate -A win32
*/
const generatorPlatformFromVSArch: {[key: string]: string} = {
x86: 'win32'
};
// The reverse of generatorPlatformFromVSArch
const vsArchFromGeneratorPlatform: {[key: string]: string} = {
win32: 'x86'
};
/**
* Preferred CMake VS generators by VS version
*/
const VsGenerators: {[key: string]: string} = {
10: 'Visual Studio 10 2010',
11: 'Visual Studio 11 2012',
VS120COMNTOOLS: 'Visual Studio 12 2013',
12: 'Visual Studio 12 2013',
VS140COMNTOOLS: 'Visual Studio 14 2015',
14: 'Visual Studio 14 2015',
15: 'Visual Studio 15 2017',
16: 'Visual Studio 16 2019'
};
async function varsForVSInstallation(inst: VSInstallation, hostArch: string, targetArch?: string): Promise<Map<string, string>|null> {
console.log(`varsForVSInstallation path:'${inst.installationPath}' version:${inst.installationVersion} host arch:${hostArch} - target arch:${targetArch}`);
const common_dir = path.join(inst.installationPath, 'Common7', 'Tools');
let vcvarsScript: string = 'vcvarsall.bat';
if (targetArch == "arm" || targetArch == "arm64") {
// The arm(64) vcvars filename for x64 hosted toolset is using the 'amd64' alias.
vcvarsScript = `vcvars${kitHostTargetArch(hostArch, targetArch, true)}.bat`;
}
let devbat = path.join(inst.installationPath, 'VC', 'Auxiliary', 'Build', vcvarsScript);
const majorVersion = parseInt(inst.installationVersion);
if (majorVersion < 15) {
devbat = path.join(inst.installationPath, 'VC', vcvarsScript);
}
// The presence of vcvars[hostArch][targetArch].bat indicates whether targetArch is included
// in the given VS installation.
if (!await fs.exists(devbat)) {
return null;
}
const variables = await collectDevBatVars(devbat, [kitHostTargetArch(hostArch, targetArch, majorVersion < 15)], majorVersion, common_dir);
if (!variables) {
return null;
} else {
// This is a very *hacky* and sub-optimal solution, but it
// works for now. This *helps* CMake make the right decision
// when you have the release and pre-release edition of the same
// VS version installed. I don't really know why or what causes
// this issue, but this here seems to work. It basically just sets
// the VS{vs_version_number}COMNTOOLS environment variable to contain
// the path to the Common7 directory.
const vs_version = variables.get('VISUALSTUDIOVERSION');
if (vs_version)
variables.set(`VS${vs_version.replace('.', '')}COMNTOOLS`, common_dir);
// For Ninja and Makefile generators, CMake searches for some compilers
// before it checks for cl.exe. We can force CMake to check cl.exe first by
// setting the CC and CXX environment variables when we want to do a
// configure.
variables.set('CC', 'cl.exe');
variables.set('CXX', 'cl.exe');
if (paths.ninjaPath) {
let envPATH = variables.get('PATH');
if (undefined !== envPATH) {
const env_paths = envPATH.split(';');
const ninja_path = path.dirname(paths.ninjaPath!);
const ninja_base_path = env_paths.find(path_el => path_el === ninja_path);
if (undefined === ninja_base_path) {
envPATH = envPATH.concat(';' + ninja_path);
variables.set('PATH', envPATH);
}
}
}
return variables;
}
}
/**
* Try to get a VSKit from a VS installation and architecture
* @param inst A VS installation from vswhere
* @param hostArch The host architecture
* @param targetArch The target architecture
*/
async function tryCreateNewVCEnvironment(inst: VSInstallation, hostArch: string, targetArch: string, pr?: ProgressReporter): Promise<Kit|null> {
const name = vsKitName(inst, hostArch, targetArch);
log.debug(localize('checking.for.kit', 'Checking for kit: {0}', name));
if (pr) {
pr.report({message: localize('checking', 'Checking {0}', name)});
}
const variables = await varsForVSInstallation(inst, hostArch, targetArch);
if (!variables) {
return null;
}
const kit: Kit = {
name,
visualStudio: kitVSName(inst),
visualStudioArchitecture: hostArch
};
const version = /^(\d+)+./.exec(inst.installationVersion);
log.debug(localize('detected.kit.for.version', 'Detected VsKit for version'));
log.debug(` DisplayName: ${name}`);
log.debug(` InstanceId: ${inst.instanceId}`);
log.debug(` InstallVersion: ${inst.installationVersion}`);
const majorVersion = parseInt(inst.installationVersion);
if (version) {
const generatorName: string|undefined = VsGenerators[version[1]];
if (generatorName) {
log.debug(` ${localize('generator.present', 'Generator Present: {0}', generatorName)}`);
kit.preferredGenerator = {
name: generatorName,
platform: generatorPlatformFromVSArch[targetArch] as string || targetArch,
// CMake generator toolsets support also different versions (via -T version=).
toolset: majorVersion < 15 ? undefined : "host=" + hostArch
};
}
log.debug(` ${localize('selected.preferred.generator.name', 'Selected Preferred Generator Name: {0} {1}', generatorName, JSON.stringify(kit.preferredGenerator))}`);
}
return kit;
}
/**
* Scans the system for Visual C++ installations using vswhere
*/
export async function scanForVSKits(pr?: ProgressReporter): Promise<Kit[]> {
const installs = await vsInstallations();
const prs = installs.map(async(inst): Promise<Kit[]> => {
const ret = [] as Kit[];
const hostArches: string[] = ['x86', 'x64'];
const targetArches: string[] = ['x86', 'x64', 'arm', 'arm64'];
const sub_prs: Promise<Kit | null>[] = [];
hostArches.forEach(hostArch => {
targetArches.forEach(targetArch => {
const kit: Promise<Kit | null> = tryCreateNewVCEnvironment(inst, hostArch, targetArch, pr);
if (kit) {
sub_prs.push(kit);
}
});
});
const maybe_kits = await Promise.all(sub_prs);
maybe_kits.map(k => k ? ret.push(k) : null);
return ret;
});
const vs_kits = await Promise.all(prs);
return ([] as Kit[]).concat(...vs_kits);
}
async function scanDirForClangForMSVCKits(dir: string, vsInstalls: VSInstallation[], cmakeTools: CMakeTools | undefined): Promise<Kit[]> {
const kits = await scanDirectory(dir, async(binPath): Promise<Kit[]|null> => {
const isClangGNUCLI = (path.basename(binPath, '.exe') === 'clang');
const isClangCL = (path.basename(binPath, '.exe') === 'clang-cl');
if (!isClangGNUCLI && !isClangCL) {
return null;
}
const version = await getClangVersion(binPath);
if (version === null) {
return null;
}
let clang_cli = '(MSVC CLI)';
// Clang for MSVC ABI with GNU CLI (command line interface) is supported in CMake 3.15.0+
if (isClangGNUCLI) {
if (undefined === cmakeTools) {
log.error("failed.to.scan.for.kits", "Failed to scan for kits:", "cmakeTools is undefined");
return null;
} else {
const cmake_executable = await cmakeTools?.getCMakeExecutable();
if (undefined === cmake_executable.version) {
return null;
} else {
if (versionLess(cmake_executable.version, '3.15.0')) {
// Could not find a supported CMake version
return null;
}
}
}
// Found a supported CMake version
clang_cli = '(GNU CLI)';
}
const clangKits: Kit[] = [];
vsInstalls.forEach(vs => {
const install_name = vsDisplayName(vs);
const vs_arch = (version.target && version.target.includes('i686-pc')) ? 'x86' : 'amd64';
const clangArch = (vs_arch === "amd64") ? "x64\\" : "";
if (binPath.startsWith(`${vs.installationPath}\\VC\\Tools\\Llvm\\${clangArch}bin`) &&
util.checkFileExists(util.lightNormalizePath(binPath))) {
clangKits.push({
name: localize({key: 'clang.for.vsmsvc',
comment: ["Clang should stay at the beginning of the string as it is used in UI sorting"]},
'Clang {0} {1} with {2} ({3})', version.version, clang_cli, install_name, vs_arch),
visualStudio: kitVSName(vs),
visualStudioArchitecture: vs_arch,
compilers: {
C: binPath,
CXX: binPath,
}
});
}
});
return clangKits;
});
return ([] as Kit[]).concat(...kits);
}
export async function scanForClangForMSVCKits(searchPaths: string[], cmakeTools: CMakeTools | undefined): Promise<Promise<Kit[]>[]> {
const vs_installs = await vsInstallations();
const results = searchPaths.map(p => scanDirForClangForMSVCKits(p, vs_installs, cmakeTools));
return results;
}
async function getVSInstallForKit(kit: Kit): Promise<VSInstallation|undefined> {
if (process.platform !== "win32") {
return undefined;
}
console.assert(kit.visualStudio);
console.assert(kit.visualStudioArchitecture);
const installs = await vsInstallations();
const match = (inst: VSInstallation) =>
// old Kit format
(legacyKitVSName(inst) == kit.visualStudio) ||
// new Kit format
(kitVSName(inst) === kit.visualStudio) ||
// Clang for VS kit format
(!!kit.compilers && kit.name.indexOf("Clang") >= 0 && kit.name.indexOf(vsDisplayName(inst)) >= 0);
return installs.find(inst => match(inst));
}
export async function getVSKitEnvironment(kit: Kit): Promise<Map<string, string>|null> {
const requested = await getVSInstallForKit(kit);
if (!requested) {
return null;
}
return varsForVSInstallation(requested, kit.visualStudioArchitecture!, kit.preferredGenerator?.platform);
}
export async function effectiveKitEnvironment(kit: Kit, opts?: expand.ExpansionOptions): Promise<Map<string, string>> {
let host_env;
const kit_env = objectPairs(kit.environmentVariables || {});
if (opts) {
for (const env_var of kit_env) {
env_var[1] = await expand.expandString(env_var[1], opts);
}
}
if (kit.environmentSetupScript) {
const shell_vars = await getShellScriptEnvironment(kit, opts);
if (shell_vars) {
host_env = util.map(shell_vars, ([k, v]): [string, string] => [k.toLocaleUpperCase(), v]) as [string, string][];
}
}
if (host_env === undefined) {
// get host_env from process if it was not set by shell script before
host_env = objectPairs(process.env) as [string, string][];
}
if (kit.visualStudio && kit.visualStudioArchitecture) {
const vs_vars = await getVSKitEnvironment(kit);
if (vs_vars) {
return new Map(
util.map(util.chain(host_env, kit_env, vs_vars), ([k, v]): [string, string] => [k.toLocaleUpperCase(), v]));
}
}
const env = new Map(util.chain(host_env, kit_env));
if (env.has("CMT_MINGW_PATH")) {
if (env.has("PATH")) {
env.set("PATH", env.get("PATH")!.concat(`;${env.get("CMT_MINGW_PATH")}`));
} else if (env.has("Path")) {
env.set("Path", env.get("Path")!.concat(`;${env.get("CMT_MINGW_PATH")}`));
}
}
return env;
}
export async function findCLCompilerPath(env: Map<string, string>): Promise<string|null> {
const path_var = util.find(env.entries(), ([key, _val]) => key.toLocaleLowerCase() === 'path');
if (!path_var) {
return null;
}
const path_ext_var = util.find(env.entries(), ([key, _val]) => key.toLocaleLowerCase() === 'pathext');
if (!path_ext_var) {