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
|
// Copyright 2014 Google Inc. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.google.devtools.build.lib.analysis;
import com.google.common.collect.ImmutableList;
import com.google.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.actions.EmptyRunfilesSupplier;
import com.google.devtools.build.lib.actions.RunfilesSupplier;
import com.google.devtools.build.lib.cmdline.Label;
import com.google.devtools.build.lib.concurrent.ThreadSafety.Immutable;
import com.google.devtools.build.lib.syntax.SkylarkCallable;
import com.google.devtools.build.lib.syntax.SkylarkModule;
import javax.annotation.Nullable;
/**
* Returns information about executables produced by a target and the files needed to run it.
*/
@Immutable
@SkylarkModule(name = "FilesToRunProvider", doc = "")
public final class FilesToRunProvider implements TransitiveInfoProvider {
/** The name of the field in Skylark used to access this class. */
public static final String SKYLARK_NAME = "files_to_run";
private final Label label;
private final ImmutableList<Artifact> filesToRun;
@Nullable private final RunfilesSupport runfilesSupport;
@Nullable private final Artifact executable;
public FilesToRunProvider(Label label, ImmutableList<Artifact> filesToRun,
@Nullable RunfilesSupport runfilesSupport, @Nullable Artifact executable) {
this.label = label;
this.filesToRun = filesToRun;
this.runfilesSupport = runfilesSupport;
this.executable = executable;
}
/**
* Creates an instance that contains one single executable and no other files.
*/
public static FilesToRunProvider fromSingleArtifact(Label label, Artifact artifact) {
return new FilesToRunProvider(label, ImmutableList.of(artifact), null, artifact);
}
/**
* Returns the label that is associated with this piece of information.
*
* <p>This is usually the label of the target that provides the information.
*/
public Label getLabel() {
return label;
}
/**
* Returns artifacts needed to run the executable for this target.
*/
public ImmutableList<Artifact> getFilesToRun() {
return filesToRun;
}
/**
* Returns the {@RunfilesSupport} object associated with the target or null if it does not exist.
*/
@Nullable public RunfilesSupport getRunfilesSupport() {
return runfilesSupport;
}
/**
* Returns the Executable or null if it does not exist.
*/
@SkylarkCallable(
name = "executable",
doc = "The main executable or None if it does not exist",
structField = true,
allowReturnNones = true
)
@Nullable
public Artifact getExecutable() {
return executable;
}
/**
* Returns the RunfilesManifest or null if it does not exist. It is a shortcut to
* getRunfilesSupport().getRunfilesManifest().
*/
@SkylarkCallable(
name = "runfiles_manifest",
doc = "The runfiles manifest or None if it does not exist",
structField = true,
allowReturnNones = true
)
@Nullable
public Artifact getRunfilesManifest() {
return runfilesSupport != null ? runfilesSupport.getRunfilesManifest() : null;
}
/** Return a {@link RunfilesSupplier} encapsulating runfiles for this tool. */
public RunfilesSupplier getRunfilesSupplier() {
if (executable != null && runfilesSupport != null) {
return new RunfilesSupplierImpl(executable, runfilesSupport.getRunfiles());
} else {
return EmptyRunfilesSupplier.INSTANCE;
}
}
}
|
