-
Notifications
You must be signed in to change notification settings - Fork 187
/
CBuildConfiguration.java
1160 lines (1042 loc) · 36.8 KB
/
CBuildConfiguration.java
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
/*******************************************************************************
* Copyright (c) 2015, 2022 QNX Software Systems and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*******************************************************************************/
package org.eclipse.cdt.core.build;
import java.io.File;
import java.io.FileReader;
import java.io.FileWriter;
import java.io.IOException;
import java.net.URI;
import java.nio.file.Files;
import java.nio.file.InvalidPathException;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Properties;
import java.util.Set;
import java.util.stream.Collectors;
import org.eclipse.cdt.core.CCorePlugin;
import org.eclipse.cdt.core.CommandLauncherManager;
import org.eclipse.cdt.core.ICommandLauncher;
import org.eclipse.cdt.core.IConsoleParser;
import org.eclipse.cdt.core.IConsoleParser2;
import org.eclipse.cdt.core.IMarkerGenerator;
import org.eclipse.cdt.core.ProblemMarkerInfo;
import org.eclipse.cdt.core.envvar.IEnvironmentVariable;
import org.eclipse.cdt.core.model.CoreModel;
import org.eclipse.cdt.core.model.ElementChangedEvent;
import org.eclipse.cdt.core.model.IBinary;
import org.eclipse.cdt.core.model.IBinaryContainer;
import org.eclipse.cdt.core.model.ICElement;
import org.eclipse.cdt.core.model.ICElementDelta;
import org.eclipse.cdt.core.model.ICModelMarker;
import org.eclipse.cdt.core.model.ICProject;
import org.eclipse.cdt.core.model.IElementChangedListener;
import org.eclipse.cdt.core.model.IIncludeEntry;
import org.eclipse.cdt.core.model.IIncludeFileEntry;
import org.eclipse.cdt.core.model.IMacroEntry;
import org.eclipse.cdt.core.model.IMacroFileEntry;
import org.eclipse.cdt.core.model.ITranslationUnit;
import org.eclipse.cdt.core.parser.ExtendedScannerInfo;
import org.eclipse.cdt.core.parser.IExtendedScannerInfo;
import org.eclipse.cdt.core.parser.IScannerInfo;
import org.eclipse.cdt.core.parser.IScannerInfoChangeListener;
import org.eclipse.cdt.core.resources.IConsole;
import org.eclipse.cdt.internal.core.BuildRunnerHelper;
import org.eclipse.cdt.internal.core.ConsoleOutputSniffer;
import org.eclipse.cdt.internal.core.build.CBuildConfigurationManager;
import org.eclipse.cdt.internal.core.build.Messages;
import org.eclipse.cdt.internal.core.model.BinaryRunner;
import org.eclipse.cdt.internal.core.model.CModelManager;
import org.eclipse.cdt.internal.core.scannerinfo.ExtendedScannerInfoSerializer;
import org.eclipse.cdt.internal.core.scannerinfo.IExtendedScannerInfoDeserializer;
import org.eclipse.cdt.utils.CommandLineUtil;
import org.eclipse.cdt.utils.spawner.EnvironmentReader;
import org.eclipse.core.filesystem.URIUtil;
import org.eclipse.core.resources.IBuildConfiguration;
import org.eclipse.core.resources.IContainer;
import org.eclipse.core.resources.IFolder;
import org.eclipse.core.resources.IMarker;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.resources.IProjectDescription;
import org.eclipse.core.resources.IResource;
import org.eclipse.core.runtime.Assert;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.NullProgressMonitor;
import org.eclipse.core.runtime.Platform;
import org.eclipse.core.runtime.PlatformObject;
import org.eclipse.core.runtime.Status;
import org.eclipse.core.runtime.jobs.Job;
import org.eclipse.core.runtime.preferences.InstanceScope;
import org.osgi.service.prefs.BackingStoreException;
import org.osgi.service.prefs.Preferences;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
/**
* Root class for CDT build configurations. Provides access to the build
* settings for subclasses.
*
* Each Eclipse project has one or more build configurations ({@link IBuildConfiguration}).
* A CDT Core Build project pairs each build configuration with a Core Build configuration
* ({@link ICBuildConfiguration}). A Core Build configuration has variable config pointing to
* the IBuildConfiguration. The link from IBuildConfiguration to ICBuildConfiguration
* goes via getAdapter(ICBuildConfiguration.class) which gets the ICBuildConfiguration
* from Map configs in the {@link CBuildConfigurationManager}.
*
* In a new project the initial Core Build configurations creation is triggered by the
* {@link CoreBuildLaunchBarTracker}. The initial configuration for Debug will only be
* created if the user selects the Debug launch mode. Restoration of Core Build configurations,
* after an Eclipse restart or close and open of the project, uses the settings which are
* persistently stored in the backing store. @see org.osgi.service.prefs.Preferences
*
* @since 6.0
*/
public abstract class CBuildConfiguration extends PlatformObject implements ICBuildConfiguration, ICBuildConfiguration2,
IMarkerGenerator, IConsoleParser2, IElementChangedListener {
private static final String LAUNCH_MODE = "cdt.launchMode"; //$NON-NLS-1$
private static final String NEED_REFRESH = "cdt.needScannerRefresh"; //$NON-NLS-1$
private static final List<String> DEFAULT_COMMAND = new ArrayList<>(0);
private final Map<IResource, IToolChain> tcMap = new HashMap<>();
private final String name;
private final IBuildConfiguration config;
private final IToolChain toolChain;
private String launchMode;
private Object scannerInfoLock = new Object();
private final Map<IResource, List<IScannerInfoChangeListener>> scannerInfoListeners = new HashMap<>();
private ScannerInfoCache scannerInfoCache;
private ICommandLauncher launcher;
protected CBuildConfiguration(IBuildConfiguration config, String name) throws CoreException {
this.config = config;
this.name = name;
Preferences settings = getSettings();
String typeId = settings.get(TOOLCHAIN_TYPE, ""); //$NON-NLS-1$
String id = settings.get(TOOLCHAIN_ID, ""); //$NON-NLS-1$
IToolChainManager toolChainManager = CCorePlugin.getService(IToolChainManager.class);
IToolChain tc = toolChainManager.getToolChain(typeId, id);
if (tc == null) {
// check for other versions
tc = toolChainManager.getToolChain(typeId, id);
if (tc == null) {
throw new CoreException(
new Status(IStatus.ERROR, CCorePlugin.PLUGIN_ID, CCorePlugin.STATUS_BUILD_CONFIG_NOT_VALID,
String.format(Messages.CBuildConfiguration_ToolchainMissing, config.getName()), null));
}
}
this.toolChain = tc;
this.launchMode = settings.get(LAUNCH_MODE, "run"); //$NON-NLS-1$
CoreModel.getDefault().addElementChangedListener(this);
}
protected CBuildConfiguration(IBuildConfiguration config, String name, IToolChain toolChain) {
this(config, name, toolChain, "run"); //$NON-NLS-1$
}
/**
* @since 6.2
*/
protected CBuildConfiguration(IBuildConfiguration config, String name, IToolChain toolChain, String launchMode) {
this.config = config;
this.name = name;
this.toolChain = toolChain;
this.launchMode = launchMode;
Preferences settings = getSettings();
settings.put(TOOLCHAIN_TYPE, toolChain.getTypeId());
settings.put(TOOLCHAIN_ID, toolChain.getId());
if (launchMode != null) {
settings.put(LAUNCH_MODE, launchMode);
}
try {
settings.flush();
} catch (BackingStoreException e) {
CCorePlugin.log(e);
}
CoreModel.getDefault().addElementChangedListener(this);
}
protected CBuildConfiguration(IBuildConfiguration config, IToolChain toolChain) {
this(config, DEFAULT_NAME, toolChain);
}
@Override
public IBuildConfiguration getBuildConfiguration() {
return config;
}
public String getName() {
return name;
}
/**
* @since 6.2
*/
@Override
public String getLaunchMode() {
return launchMode;
}
/**
* @since 6.2
*/
protected void setLaunchMode(String launchMode) {
this.launchMode = launchMode;
Preferences settings = getSettings();
settings.put(LAUNCH_MODE, launchMode);
try {
settings.flush();
} catch (BackingStoreException e) {
CCorePlugin.log(e);
}
}
public IProject getProject() {
return config.getProject();
}
@Override
public List<String> getBinaryParserIds() throws CoreException {
return toolChain != null ? toolChain.getBinaryParserIds() : List.of(CCorePlugin.DEFAULT_BINARY_PARSER_UNIQ_ID);
}
public IContainer getBuildContainer() throws CoreException {
// TODO make the name of this folder a project property
IProject project = getProject();
IFolder buildRootFolder = project.getFolder("build"); //$NON-NLS-1$
IFolder buildFolder = buildRootFolder.getFolder(name);
IProgressMonitor monitor = new NullProgressMonitor();
if (!buildRootFolder.exists()) {
buildRootFolder.create(IResource.FORCE | IResource.DERIVED, true, monitor);
}
if (!buildFolder.exists()) {
buildFolder.create(IResource.FORCE | IResource.DERIVED, true, monitor);
}
return buildFolder;
}
@Override
public URI getBuildDirectoryURI() throws CoreException {
return getBuildContainer().getLocationURI();
}
public Path getBuildDirectory() throws CoreException {
return Paths.get(getBuildDirectoryURI());
}
@Override
public void setBuildEnvironment(Map<String, String> env) {
CCorePlugin.getDefault().getBuildEnvironmentManager().setEnvironment(env, config, true);
}
/**
* @since 6.1
*/
@Override
public IBinary[] getBuildOutput() throws CoreException {
ICProject cproject = CoreModel.getDefault().create(config.getProject());
IBinaryContainer binaries = cproject.getBinaryContainer();
IPath outputPath = getBuildContainer().getFullPath();
final IBinary[] outputs = getBuildOutput(binaries, outputPath);
if (outputs.length > 0) {
return outputs;
}
// Give the binary runner a kick and try again.
BinaryRunner runner = CModelManager.getDefault().getBinaryRunner(cproject);
runner.start();
runner.waitIfRunning();
return getBuildOutput(binaries, outputPath);
}
private IBinary[] getBuildOutput(final IBinaryContainer binaries, final IPath outputPath) throws CoreException {
return Arrays.stream(binaries.getBinaries()).filter(b -> b.isExecutable() && outputPath.isPrefixOf(b.getPath()))
.toArray(IBinary[]::new);
}
public void setActive(IProgressMonitor monitor) throws CoreException {
IProject project = config.getProject();
if (config.equals(project.getActiveBuildConfig())) {
// already set
return;
}
CoreModel m = CoreModel.getDefault();
synchronized (m) {
IProjectDescription projectDesc = project.getDescription();
IBuildConfiguration[] bconfigs = project.getBuildConfigs();
Set<String> names = new LinkedHashSet<>();
for (IBuildConfiguration bconfig : bconfigs) {
names.add(bconfig.getName());
}
// must add default config name as it may not be in build config list
names.add(IBuildConfiguration.DEFAULT_CONFIG_NAME);
// ensure active config is last in list so clean build will clean
// active config last and this will be left in build console for user to see
names.remove(config.getName());
names.add(config.getName());
projectDesc.setBuildConfigs(names.toArray(new String[0]));
projectDesc.setActiveBuildConfig(config.getName());
project.setDescription(projectDesc, monitor);
}
}
protected Preferences getSettings() {
return InstanceScope.INSTANCE.getNode(CCorePlugin.PLUGIN_ID).node("config") //$NON-NLS-1$
.node(getProject().getName()).node(config.getName());
}
@Override
public IToolChain getToolChain() throws CoreException {
return toolChain;
}
/**
* Get the toolchain based on the compiler found in the command line.
* Sub-classes can override this method to set their own method for
* getting the toolchain.
* @since 8.0
*
*/
protected IToolChain getToolChain(List<String> command) throws CoreException {
return getToolChain();
}
/**
* Get the toolchain that was used to compile this resource.
*
* @param resource
* @return
* @throws CoreException
*/
private IToolChain getToolChain(IResource resource) throws CoreException {
IToolChain tc = tcMap.get(resource);
if (tc == null)
return getToolChain();
else
return tc;
}
@Override
public IEnvironmentVariable getVariable(String name) {
IEnvironmentVariable[] vars = getVariables();
if (vars != null) {
for (IEnvironmentVariable var : vars) {
if (var.getName().equals(name)) {
return var;
}
}
}
return null;
}
@Override
public IEnvironmentVariable[] getVariables() {
// by default, none
return null;
}
@Override
public void addMarker(IResource file, int lineNumber, String errorDesc, int severity, String errorVar) {
addMarker(new ProblemMarkerInfo(file, lineNumber, errorDesc, severity, errorVar, null));
}
@Override
public void addMarker(ProblemMarkerInfo problemMarkerInfo) {
try {
IProject project = config.getProject();
IResource markerResource = problemMarkerInfo.file;
if (markerResource == null) {
markerResource = project;
}
String externalLocation = null;
if (problemMarkerInfo.externalPath != null && !problemMarkerInfo.externalPath.isEmpty()) {
externalLocation = problemMarkerInfo.externalPath.toOSString();
}
// Try to find matching markers and don't put in duplicates
IMarker[] markers = markerResource.findMarkers(ICModelMarker.C_MODEL_PROBLEM_MARKER, true,
IResource.DEPTH_ONE);
for (IMarker m : markers) {
int line = m.getAttribute(IMarker.LINE_NUMBER, -1);
int sev = m.getAttribute(IMarker.SEVERITY, -1);
String msg = (String) m.getAttribute(IMarker.MESSAGE);
if (line == problemMarkerInfo.lineNumber && sev == mapMarkerSeverity(problemMarkerInfo.severity)
&& msg.equals(problemMarkerInfo.description)) {
String extloc = (String) m.getAttribute(ICModelMarker.C_MODEL_MARKER_EXTERNAL_LOCATION);
if (extloc == externalLocation || (extloc != null && extloc.equals(externalLocation))) {
if (project == null || project.equals(markerResource.getProject())) {
return;
}
String source = (String) m.getAttribute(IMarker.SOURCE_ID);
if (project.getName().equals(source)) {
return;
}
}
}
}
String type = problemMarkerInfo.getType();
if (type == null) {
type = ICModelMarker.C_MODEL_PROBLEM_MARKER;
}
IMarker marker = markerResource.createMarker(type);
marker.setAttribute(IMarker.MESSAGE, problemMarkerInfo.description);
marker.setAttribute(IMarker.SEVERITY, mapMarkerSeverity(problemMarkerInfo.severity));
marker.setAttribute(IMarker.LINE_NUMBER, problemMarkerInfo.lineNumber);
marker.setAttribute(IMarker.CHAR_START, problemMarkerInfo.startChar);
marker.setAttribute(IMarker.CHAR_END, problemMarkerInfo.endChar);
if (problemMarkerInfo.variableName != null) {
marker.setAttribute(ICModelMarker.C_MODEL_MARKER_VARIABLE, problemMarkerInfo.variableName);
}
if (externalLocation != null) {
URI uri = URIUtil.toURI(externalLocation);
if (uri.getScheme() != null) {
marker.setAttribute(ICModelMarker.C_MODEL_MARKER_EXTERNAL_LOCATION, externalLocation);
String locationText = String.format(Messages.CBuildConfiguration_Location,
problemMarkerInfo.lineNumber, externalLocation);
marker.setAttribute(IMarker.LOCATION, locationText);
}
} else if (problemMarkerInfo.lineNumber == 0) {
marker.setAttribute(IMarker.LOCATION, " "); //$NON-NLS-1$
}
// Set source attribute only if the marker is being set to a file
// from different project
if (project != null && !project.equals(markerResource.getProject())) {
marker.setAttribute(IMarker.SOURCE_ID, project.getName());
}
// Add all other client defined attributes.
Map<String, String> attributes = problemMarkerInfo.getAttributes();
if (attributes != null) {
for (Entry<String, String> entry : attributes.entrySet()) {
marker.setAttribute(entry.getKey(), entry.getValue());
}
}
} catch (CoreException e) {
CCorePlugin.log(e.getStatus());
}
}
private int mapMarkerSeverity(int severity) {
switch (severity) {
case SEVERITY_ERROR_BUILD:
case SEVERITY_ERROR_RESOURCE:
return IMarker.SEVERITY_ERROR;
case SEVERITY_INFO:
return IMarker.SEVERITY_INFO;
case SEVERITY_WARNING:
return IMarker.SEVERITY_WARNING;
}
return IMarker.SEVERITY_ERROR;
}
protected Path findCommand(String command) {
try {
Path cmdPath = Paths.get(command);
if (cmdPath.isAbsolute()) {
return cmdPath;
}
Properties environmentVariables = EnvironmentReader.getEnvVars();
Map<String, String> env = new HashMap<>();
for (String key : environmentVariables.stringPropertyNames()) {
String value = environmentVariables.getProperty(key);
env.put(key, value);
}
setBuildEnvironment(env);
String pathStr = env.get("PATH"); //$NON-NLS-1$
if (pathStr == null) {
return null; // no idea
}
String[] path = pathStr.split(File.pathSeparator);
for (String dir : path) {
Path commandPath = Paths.get(dir, command);
if (Files.exists(commandPath) && Files.isRegularFile(commandPath)) {
return commandPath;
} else {
if (Platform.getOS().equals(Platform.OS_WIN32)
&& !(command.endsWith(".exe") || command.endsWith(".bat"))) { //$NON-NLS-1$ //$NON-NLS-2$
commandPath = Paths.get(dir, command + ".exe"); //$NON-NLS-1$
if (Files.exists(commandPath)) {
return commandPath;
}
}
}
}
IToolChain tc = getToolChain();
if (tc instanceof IToolChain2) {
// we may have a Container build...default to Path based on command
return Paths.get(command);
}
} catch (InvalidPathException e) {
// ignore
} catch (CoreException e) {
// ignore
}
return null;
}
/**
* @since 6.5
*/
public Process startBuildProcess(List<String> commands, IEnvironmentVariable[] envVars, IPath buildDirectory,
IConsole console, IProgressMonitor monitor) throws IOException, CoreException {
Process process = null;
IToolChain tc = getToolChain();
if (tc instanceof IToolChain2) {
process = ((IToolChain2) tc).startBuildProcess(this, commands, buildDirectory.toString(), envVars, console,
monitor);
} else {
// verify command can be found locally on path
Path commandPath = findCommand(commands.get(0));
if (commandPath == null) {
console.getErrorStream()
.write(String.format(Messages.CBuildConfiguration_CommandNotFound, commands.get(0)));
return null;
}
IPath cmd = new org.eclipse.core.runtime.Path(commandPath.toString());
List<String> args = commands.subList(1, commands.size());
// check if includes have been removed/refreshed and scanner info refresh is needed
boolean needRefresh = CommandLauncherManager.getInstance().checkIfIncludesChanged(this);
IToolChain t = getToolChain();
if (t != null) {
t.setProperty(NEED_REFRESH, Boolean.valueOf(needRefresh).toString());
}
// Generate environment block before launching process
launcher = CommandLauncherManager.getInstance().getCommandLauncher(this);
Properties envProps = launcher.getEnvironment();
HashMap<String, String> environment = envProps.entrySet().stream()
.collect(Collectors.toMap(e -> String.valueOf(e.getKey()), e -> String.valueOf(e.getValue()),
(prev, next) -> next, HashMap::new));
for (IEnvironmentVariable envVar : envVars) {
environment.put(envVar.getName(), envVar.getValue());
}
setBuildEnvironment(environment);
launcher.setProject(getProject());
process = launcher.execute(cmd, args.toArray(new String[0]), BuildRunnerHelper.envMapToEnvp(environment),
buildDirectory, monitor);
}
return process;
}
/**
* @return The exit code of the build process.
* @since 8.0
*/
protected int watchProcess(IConsole console, IProgressMonitor monitor) throws CoreException {
assertLauncherNotNull(launcher);
return launcher.waitAndRead(console.getInfoStream(), console.getErrorStream(), monitor);
}
/**
* @return The exit code of the build process.
* @since 8.0
*/
protected int watchProcess(IConsoleParser[] consoleParsers, IProgressMonitor monitor) throws CoreException {
assertLauncherNotNull(launcher);
ConsoleOutputSniffer sniffer = new ConsoleOutputSniffer(consoleParsers);
return launcher.waitAndRead(sniffer.getOutputStream(), sniffer.getErrorStream(), monitor);
}
private void assertLauncherNotNull(ICommandLauncher launcher) {
Assert.isNotNull(launcher, "Only processes launched with startBuildProcess can be watched."); //$NON-NLS-1$
}
private File getScannerInfoCacheFile() {
return CCorePlugin.getDefault().getStateLocation().append("infoCache") //$NON-NLS-1$
.append(getProject().getName()).append(name + ".json").toFile(); //$NON-NLS-1$
}
/**
* @since 6.1
*/
protected void loadScannerInfoCache() {
synchronized (scannerInfoLock) {
if (scannerInfoCache == null) {
File cacheFile = getScannerInfoCacheFile();
if (cacheFile.exists()) {
try (FileReader reader = new FileReader(cacheFile)) {
Gson gson = createGson();
scannerInfoCache = gson.fromJson(reader, ScannerInfoCache.class);
} catch (IOException e) {
CCorePlugin.log(e);
}
}
if (scannerInfoCache == null) {
scannerInfoCache = new ScannerInfoCache();
}
scannerInfoCache.initCache();
}
}
}
private Gson createGson() {
GsonBuilder gsonBuilder = new GsonBuilder();
gsonBuilder.registerTypeAdapter(IExtendedScannerInfo.class, new IExtendedScannerInfoDeserializer());
gsonBuilder.registerTypeAdapter(ExtendedScannerInfo.class, new ExtendedScannerInfoSerializer());
Gson gson = gsonBuilder.create();
return gson;
}
/**
* @since 6.1
*/
protected synchronized void saveScannerInfoCache() {
File cacheFile = getScannerInfoCacheFile();
if (!cacheFile.getParentFile().exists()) {
try {
Files.createDirectories(cacheFile.getParentFile().toPath());
} catch (IOException e) {
CCorePlugin.log(e);
return;
}
}
try (FileWriter writer = new FileWriter(getScannerInfoCacheFile())) {
Gson gson = createGson();
synchronized (scannerInfoLock) {
gson.toJson(scannerInfoCache, writer);
}
} catch (IOException e) {
CCorePlugin.log(e);
}
}
/**
* @since 6.1
*/
protected ScannerInfoCache getScannerInfoCache() {
return scannerInfoCache;
}
private IExtendedScannerInfo getBaseScannerInfo(IResource resource) throws CoreException {
IPath resPath = resource.getFullPath();
IIncludeEntry[] includeEntries = CoreModel.getIncludeEntries(resPath);
String[] includes = new String[includeEntries.length];
for (int i = 0; i < includeEntries.length; ++i) {
includes[i] = includeEntries[i].getFullIncludePath().toOSString();
}
IIncludeFileEntry[] includeFileEntries = CoreModel.getIncludeFileEntries(resPath);
String[] includeFiles = new String[includeFileEntries.length];
for (int i = 0; i < includeFiles.length; ++i) {
includeFiles[i] = includeFileEntries[i].getFullIncludeFilePath().toOSString();
}
IMacroEntry[] macros = CoreModel.getMacroEntries(resPath);
Map<String, String> symbolMap = new HashMap<>();
for (int i = 0; i < macros.length; ++i) {
symbolMap.put(macros[i].getMacroName(), macros[i].getMacroValue());
}
IMacroFileEntry[] macroFileEntries = CoreModel.getMacroFileEntries(resPath);
String[] macroFiles = new String[macroFileEntries.length];
for (int i = 0; i < macroFiles.length; ++i) {
macroFiles[i] = macroFileEntries[i].getFullMacroFilePath().toOSString();
}
return new ExtendedScannerInfo(symbolMap, includes, includeFiles, macroFiles);
}
@Override
public IScannerInfo getScannerInformation(IResource resource) {
loadScannerInfoCache();
IExtendedScannerInfo info = null;
synchronized (scannerInfoLock) {
info = scannerInfoCache.getScannerInfo(resource);
}
// Following is a kludge to fix Bug 579668 whereby sometimes a timing
// bug occurs and scanner info for a project that specifies a container target
// has not initialized the include paths correctly to point to copied includes
// from the image target. We check to see if org.eclipse.cdt.docker.launcher is
// found in the include paths which is the .plugin directory where we copy headers
// to in the .metadata folder.
boolean needsFixing = false;
if (info != null && info.getIncludePaths().length > 0 && toolChain != null
&& toolChain.getId().startsWith("gcc-img-sha")) { //$NON-NLS-1$
needsFixing = true;
for (String includePath : info.getIncludePaths()) {
if (includePath.contains("org.eclipse.cdt.docker.launcher")) { //$NON-NLS-1$
needsFixing = false;
break;
}
}
}
if (info == null || info.getIncludePaths().length == 0 || needsFixing) {
ICElement celement = CCorePlugin.getDefault().getCoreModel().create(resource);
if (celement instanceof ITranslationUnit) {
try {
ITranslationUnit tu = (ITranslationUnit) celement;
IToolChain tc = getToolChain(resource);
info = tc.getDefaultScannerInfo(getBuildConfiguration(), getBaseScannerInfo(resource),
tu.getLanguage(), getBuildDirectoryURI());
synchronized (scannerInfoLock) {
scannerInfoCache.addScannerInfo(DEFAULT_COMMAND, info, resource);
}
saveScannerInfoCache();
} catch (CoreException e) {
CCorePlugin.log(e.getStatus());
}
}
}
return info;
}
@Override
public void elementChanged(ElementChangedEvent event) {
// check if the path entries changed in the project and clear the cache if so
processElementDelta(event.getDelta());
}
private void processElementDelta(ICElementDelta delta) {
if (delta == null) {
return;
}
int flags = delta.getFlags();
int kind = delta.getKind();
if (kind == ICElementDelta.CHANGED) {
if ((flags
& (ICElementDelta.F_CHANGED_PATHENTRY_INCLUDE | ICElementDelta.F_CHANGED_PATHENTRY_MACRO)) != 0) {
IResource resource = delta.getElement().getResource();
if (resource.getProject().equals(getProject())) {
loadScannerInfoCache();
synchronized (scannerInfoLock) {
if (scannerInfoCache.hasResource(DEFAULT_COMMAND, resource)) {
scannerInfoCache.removeResource(resource);
} else {
// Clear the whole command and exit the delta
scannerInfoCache.removeCommand(DEFAULT_COMMAND);
return;
}
}
}
}
}
ICElementDelta[] affectedChildren = delta.getAffectedChildren();
for (int i = 0; i < affectedChildren.length; i++) {
processElementDelta(affectedChildren[i]);
}
}
/**
* Parse a string containing compile options into individual argument strings.
*
* @param argString - String to parse
* @return List of arg Strings
*/
private List<String> stripArgs(String argString) {
String[] args = CommandLineUtil.argumentsToArray(argString);
return new ArrayList<>(Arrays.asList(args));
}
private boolean infoChanged = false;
@Override
public boolean processLine(String line) {
// Split line into args, taking into account quotes
List<String> command = stripArgs(line);
// Make sure it's a compile command
String[] compileCommands;
IToolChain tc;
try {
tc = getToolChain(command);
compileCommands = tc.getCompileCommands();
} catch (CoreException e) {
CCorePlugin.log(e);
return false;
}
boolean found = false;
loop: for (String arg : command) {
// TODO we should really ask the toolchain, not all args start with '-'
if (arg.startsWith("-")) { //$NON-NLS-1$
// option found, missed our command
return false;
}
for (String cc : compileCommands) {
if (arg.endsWith(cc) && (arg.equals(cc) || arg.endsWith("/" + cc) || arg.endsWith("\\" + cc))) { //$NON-NLS-1$ //$NON-NLS-2$
found = true;
break loop;
}
}
if (Platform.getOS().equals(Platform.OS_WIN32) && !arg.endsWith(".exe")) { //$NON-NLS-1$
// Try with exe
arg = arg + ".exe"; //$NON-NLS-1$
for (String cc : compileCommands) {
if (arg.endsWith(cc) && (arg.equals(cc) || arg.endsWith("/" + cc) || arg.endsWith("\\" + cc))) { //$NON-NLS-1$ //$NON-NLS-2$
found = true;
break loop;
}
}
}
}
if (!found) {
return false;
}
try {
IResource[] resources = tc.getResourcesFromCommand(command, getBuildDirectoryURI());
if (resources != null && resources.length > 0) {
List<String> commandStrings = tc.stripCommand(command, resources);
boolean needScannerRefresh = false;
String needRefresh = tc.getProperty(NEED_REFRESH);
if ("true".equals(needRefresh)) { //$NON-NLS-1$
needScannerRefresh = true;
}
for (IResource resource : resources) {
tcMap.put(resource, tc);
loadScannerInfoCache();
boolean hasCommand = true;
synchronized (scannerInfoLock) {
if (scannerInfoCache.hasCommand(commandStrings)) {
IExtendedScannerInfo info = scannerInfoCache.getScannerInfo(commandStrings);
if (info.getIncludePaths().length == 0) {
needScannerRefresh = true;
}
if (!scannerInfoCache.hasResource(commandStrings, resource)) {
scannerInfoCache.addResource(commandStrings, resource);
infoChanged = true;
}
} else {
hasCommand = false;
}
}
if (!hasCommand || needScannerRefresh) {
Path commandPath = findCommand(command.get(0));
if (commandPath != null) {
command.set(0, commandPath.toString());
IExtendedScannerInfo info = tc.getScannerInfo(getBuildConfiguration(), command, null,
resource, getBuildDirectoryURI());
synchronized (scannerInfoLock) {
scannerInfoCache.addScannerInfo(commandStrings, info, resource);
infoChanged = true;
}
}
}
}
return true;
} else {
return false;
}
} catch (CoreException e) {
CCorePlugin.log(e);
return false;
}
}
private class ScannerInfoJob extends Job {
private IToolChain toolchain;
private List<String> command;
private List<String> commandStrings;
private IResource resource;
private URI buildDirectoryURI;
public ScannerInfoJob(String msg, IToolChain toolchain, List<String> command, IResource resource,
URI buildDirectoryURI, List<String> commandStrings) {
super(msg);
this.toolchain = toolchain;
this.command = command;
this.commandStrings = commandStrings;
this.resource = resource;
this.buildDirectoryURI = buildDirectoryURI;
}
@Override
protected IStatus run(IProgressMonitor monitor) {
IExtendedScannerInfo info = toolchain.getScannerInfo(getBuildConfiguration(), command, null, resource,
buildDirectoryURI);
synchronized (scannerInfoLock) {
scannerInfoCache.addScannerInfo(commandStrings, info, resource);
infoChanged = true;
}
return Status.OK_STATUS;
}
}
/**
* Process a compile line for Scanner info in a separate job
*
* @param line - line to process
* @param jobsArray - array of Jobs to keep track of open scanner info jobs
* @return - true if line processed, false otherwise
*
* @since 6.5
*/
@Override
public boolean processLine(String line, List<Job> jobsArray) {
// Split line into args, taking into account quotes
List<String> command = stripArgs(line);
// Make sure it's a compile command
String[] compileCommands;
IToolChain tc;
try {
tc = getToolChain(command);
compileCommands = tc.getCompileCommands();
} catch (CoreException e) {
CCorePlugin.log(e);
return false;
}
boolean found = false;
loop: for (String arg : command) {
// TODO we should really ask the toolchain, not all args start with '-'
if (arg.startsWith("-")) { //$NON-NLS-1$
// option found, missed our command
return false;
}
for (String cc : compileCommands) {
if (arg.endsWith(cc) && (arg.equals(cc) || arg.endsWith("/" + cc) || arg.endsWith("\\" + cc))) { //$NON-NLS-1$ //$NON-NLS-2$
found = true;
break loop;
}
}
if (Platform.getOS().equals(Platform.OS_WIN32) && !arg.endsWith(".exe")) { //$NON-NLS-1$
// Try with exe
arg = arg + ".exe"; //$NON-NLS-1$
for (String cc : compileCommands) {
if (arg.endsWith(cc) && (arg.equals(cc) || arg.endsWith("/" + cc) || arg.endsWith("\\" + cc))) { //$NON-NLS-1$ //$NON-NLS-2$
found = true;
break loop;
}
}
}
}
if (!found) {
return false;
}
try {
IResource[] resources = tc.getResourcesFromCommand(command, getBuildDirectoryURI());
if (resources != null && resources.length > 0) {
List<String> commandStrings = tc.stripCommand(command, resources);
boolean needScannerRefresh = false;
String needRefresh = tc.getProperty(NEED_REFRESH);
if ("true".equals(needRefresh)) { //$NON-NLS-1$
needScannerRefresh = true;
}
for (IResource resource : resources) {
tcMap.put(resource, tc);
loadScannerInfoCache();
boolean hasCommand = true;
synchronized (scannerInfoLock) {
if (scannerInfoCache.hasCommand(commandStrings)) {
IExtendedScannerInfo info = scannerInfoCache.getScannerInfo(commandStrings);
if (info.getIncludePaths().length == 0) {
needScannerRefresh = true;
}
if (!scannerInfoCache.hasResource(commandStrings, resource)) {
scannerInfoCache.addResource(commandStrings, resource);
infoChanged = true;
}
} else {
hasCommand = false;
}
}
if (!hasCommand || needScannerRefresh) {
Path commandPath = findCommand(command.get(0));
if (commandPath != null) {
command.set(0, commandPath.toString());
Job job = new ScannerInfoJob(
String.format(Messages.CBuildConfiguration_RunningScannerInfo, resource), tc,
command, resource, getBuildDirectoryURI(), commandStrings);
job.schedule();
jobsArray.add(job);
}
}
}