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
|
// Copyright 2014 The Bazel Authors. 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.rules.java;
import static com.google.devtools.build.lib.packages.Attribute.ConfigurationTransition.HOST;
import static com.google.devtools.build.lib.packages.Attribute.attr;
import static com.google.devtools.build.lib.packages.BuildType.LABEL;
import static com.google.devtools.build.lib.packages.BuildType.LABEL_LIST;
import static com.google.devtools.build.lib.packages.BuildType.LICENSE;
import static com.google.devtools.build.lib.syntax.Type.BOOLEAN;
import static com.google.devtools.build.lib.syntax.Type.STRING;
import static com.google.devtools.build.lib.syntax.Type.STRING_LIST;
import static com.google.devtools.build.lib.syntax.Type.STRING_LIST_DICT;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.devtools.build.lib.analysis.BaseRuleClasses;
import com.google.devtools.build.lib.analysis.RuleDefinition;
import com.google.devtools.build.lib.analysis.RuleDefinitionEnvironment;
import com.google.devtools.build.lib.packages.RuleClass;
import com.google.devtools.build.lib.packages.RuleClass.Builder;
import com.google.devtools.build.lib.util.FileTypeSet;
import java.util.List;
/**
* Rule definition for {@code java_toolchain}
*/
public final class JavaToolchainRule implements RuleDefinition {
@Override
public RuleClass build(Builder builder, RuleDefinitionEnvironment env) {
return builder
.requiresConfigurationFragments(JavaConfiguration.class)
/* <!-- #BLAZE_RULE(java_plugin).ATTRIBUTE(output_licenses) -->
See <a href="${link common-definitions#binary.output_licenses}"><code>common attributes
</code></a>
<!-- #END_BLAZE_RULE.ATTRIBUTE --> */
.add(attr("output_licenses", LICENSE))
/* <!-- #BLAZE_RULE(java_toolchain).ATTRIBUTE(source_version) -->
The Java source version (e.g., '6' or '7'). It specifies which set of code structures
are allowed in the Java source code.
<!-- #END_BLAZE_RULE.ATTRIBUTE --> */
.add(attr("source_version", STRING).mandatory()) // javac -source flag value.
/* <!-- #BLAZE_RULE(java_toolchain).ATTRIBUTE(target_version) -->
The Java target version (e.g., '6' or '7'). It specifies for which Java runtime the class
should be build.
<!-- #END_BLAZE_RULE.ATTRIBUTE --> */
.add(attr("target_version", STRING).mandatory()) // javac -target flag value.
/* <!-- #BLAZE_RULE(java_toolchain).ATTRIBUTE(bootclasspath) -->
The Java target bootclasspath entries. Corresponds to javac's -bootclasspath flag.
<!-- #END_BLAZE_RULE.ATTRIBUTE --> */
.add(
attr("bootclasspath", LABEL_LIST)
.mandatory()
.cfg(HOST)
.allowedFileTypes(FileTypeSet.ANY_FILE))
/* <!-- #BLAZE_RULE(java_toolchain).ATTRIBUTE(extclasspath) -->
The Java target extdir entries. Corresponds to javac's -extdir flag.
<!-- #END_BLAZE_RULE.ATTRIBUTE --> */
.add(
attr("extclasspath", LABEL_LIST)
.mandatory()
.cfg(HOST)
.allowedFileTypes(FileTypeSet.ANY_FILE))
/* <!-- #BLAZE_RULE(java_toolchain).ATTRIBUTE(encoding) -->
The encoding of the java files (e.g., 'UTF-8').
<!-- #END_BLAZE_RULE.ATTRIBUTE --> */
.add(attr("encoding", STRING).mandatory()) // javac -encoding flag value.
/* <!-- #BLAZE_RULE(java_toolchain).ATTRIBUTE(xlint) -->
The list of warning to add or removes from default list. Precedes it with a dash to
removes it. Please see the Javac documentation on the -Xlint options for more information.
<!-- #END_BLAZE_RULE.ATTRIBUTE --> */
.add(attr("xlint", STRING_LIST).value(ImmutableList.<String>of()))
/* <!-- #BLAZE_RULE(java_toolchain).ATTRIBUTE(misc) -->
The list of extra arguments for the Java compiler. Please refer to the Java compiler
documentation for the extensive list of possible Java compiler flags.
<!-- #END_BLAZE_RULE.ATTRIBUTE --> */
.add(attr("misc", STRING_LIST).value(ImmutableList.<String>of()))
/* <!-- #BLAZE_RULE(java_toolchain).ATTRIBUTE(jvm_opts) -->
The list of arguments for the JVM when invoking the Java compiler. Please refer to the Java
virtual machine documentation for the extensive list of possible flags for this option.
<!-- #END_BLAZE_RULE.ATTRIBUTE --> */
.add(attr("jvm_opts", STRING_LIST).value(ImmutableList.<String>of()))
/* <!-- #BLAZE_RULE(java_toolchain).ATTRIBUTE(javac_supports_workers) -->
True if JavaBuilder supports running as a persistent worker, false if it doesn't.
<!-- #END_BLAZE_RULE.ATTRIBUTE --> */
.add(attr("javac_supports_workers", BOOLEAN).value(true))
/* <!-- #BLAZE_RULE(java_toolchain).ATTRIBUTE(javac) -->
Label of the javac jar.
<!-- #END_BLAZE_RULE.ATTRIBUTE --> */
.add(
attr("javac", LABEL_LIST)
.mandatory()
.cfg(HOST)
.singleArtifact()
.allowedFileTypes(FileTypeSet.ANY_FILE))
/* <!-- #BLAZE_RULE(java_toolchain).ATTRIBUTE(tools) -->
Labels of tools available for label-expansion in jvm_opts.
<!-- #END_BLAZE_RULE.ATTRIBUTE --> */
.add(attr("tools", LABEL_LIST).cfg(HOST).allowedFileTypes(FileTypeSet.ANY_FILE))
/* <!-- #BLAZE_RULE(java_toolchain).ATTRIBUTE(javabuilder) -->
Label of the JavaBuilder deploy jar.
<!-- #END_BLAZE_RULE.ATTRIBUTE --> */
.add(
attr("javabuilder", LABEL_LIST)
.mandatory()
.cfg(HOST)
.allowedFileTypes(FileTypeSet.ANY_FILE)
.exec())
/* <!-- #BLAZE_RULE(java_toolchain).ATTRIBUTE(singlejar) -->
Label of the SingleJar deploy jar.
<!-- #END_BLAZE_RULE.ATTRIBUTE --> */
.add(
attr("singlejar", LABEL_LIST)
.mandatory()
.cfg(HOST)
.singleArtifact()
.allowedFileTypes(FileTypeSet.ANY_FILE)
.exec())
/* <!-- #BLAZE_RULE(java_toolchain).ATTRIBUTE(genclass) -->
Label of the GenClass deploy jar.
<!-- #END_BLAZE_RULE.ATTRIBUTE --> */
.add(
attr("genclass", LABEL_LIST)
.mandatory()
.singleArtifact()
.cfg(HOST)
.allowedFileTypes(FileTypeSet.ANY_FILE)
.exec())
/* <!-- #BLAZE_RULE(java_toolchain).ATTRIBUTE(resourcejar) -->
Label of the resource jar builder executable.
<!-- #END_BLAZE_RULE.ATTRIBUTE --> */
.add(
attr("resourcejar", LABEL_LIST)
.cfg(HOST)
.singleArtifact()
.allowedFileTypes(FileTypeSet.ANY_FILE)
.exec())
/* <!-- #BLAZE_RULE(java_toolchain).ATTRIBUTE(timezone_data) -->
Label of a resource jar containing timezone data. If set, the timezone data is added as an
implicitly runtime dependency of all java_binary rules.
<!-- #END_BLAZE_RULE.ATTRIBUTE --> */
.add(
attr("timezone_data", LABEL)
.cfg(HOST)
.singleArtifact()
.allowedFileTypes(FileTypeSet.ANY_FILE)
.exec())
/* <!-- #BLAZE_RULE(java_toolchain).ATTRIBUTE(ijar) -->
Label of the ijar executable.
<!-- #END_BLAZE_RULE.ATTRIBUTE --> */
.add(
attr("ijar", LABEL_LIST)
.mandatory()
.cfg(HOST)
.allowedFileTypes(FileTypeSet.ANY_FILE)
.exec())
/* <!-- #BLAZE_RULE(java_toolchain).ATTRIBUTE(header_compiler) -->
Label of the header compiler. Required if --java_header_compilation is enabled.
<!-- #END_BLAZE_RULE.ATTRIBUTE --> */
.add(
attr("header_compiler", LABEL_LIST)
.cfg(HOST)
.singleArtifact()
.allowedFileTypes(FileTypeSet.ANY_FILE)
.exec())
/* <!-- #BLAZE_RULE(java_toolchain).ATTRIBUTE(oneversion) -->
Label of the one-version enforcement binary.
<!-- #END_BLAZE_RULE.ATTRIBUTE --> */
.add(
attr("oneversion", LABEL)
.cfg(HOST)
.singleArtifact()
.allowedFileTypes(FileTypeSet.ANY_FILE)
.exec())
/* <!-- #BLAZE_RULE(java_toolchain).ATTRIBUTE(oneversion_whitelist) -->
Label of the one-version whitelist.
<!-- #END_BLAZE_RULE.ATTRIBUTE --> */
.add(
attr("oneversion_whitelist", LABEL)
.cfg(HOST)
.singleArtifact()
.allowedFileTypes(FileTypeSet.ANY_FILE)
.exec())
/* <!-- #BLAZE_RULE(java_toolchain).ATTRIBUTE(forcibly_disable_header_compilation) -->
Overrides --java_header_compilation to disable header compilation on platforms that do not
support it, e.g. JDK 7 Bazel.
<!-- #END_BLAZE_RULE.ATTRIBUTE --> */
.add(attr("forcibly_disable_header_compilation", BOOLEAN).value(false))
.add(
attr("compatible_javacopts", STRING_LIST_DICT)
.undocumented("internal")
.value(ImmutableMap.<String, List<String>>of()))
/* <!-- #BLAZE_RULE(java_toolchain).ATTRIBUTE(plugin_configuration) -->
Java plugins that should be enabled for the specified package groups.
<!-- #END_BLAZE_RULE.ATTRIBUTE --> */
.add(
attr("plugin_configuration", LABEL_LIST)
.cfg(HOST)
.allowedFileTypes()
.mandatoryNativeProviders(ImmutableList.of(JavaPluginConfigurationProvider.class)))
.build();
}
@Override
public Metadata getMetadata() {
return RuleDefinition.Metadata.builder()
.name("java_toolchain")
.ancestors(BaseRuleClasses.BaseRule.class)
.factoryClass(JavaToolchain.class)
.build();
}
}
/*<!-- #BLAZE_RULE (NAME = java_toolchain, TYPE = OTHER, FAMILY = Java) -->
<p>
Specifies the configuration for the Java compiler. Which toolchain to be used can be changed through
the --java_toolchain argument. Normally you should not write those kind of rules unless you want to
tune your Java compiler.
</p>
<h4 id="java_binary_examples">Examples</h4>
<p>A simple example would be:
</p>
<pre class="code">
java_toolchain(
name = "toolchain",
source_version = "7",
target_version = "7",
bootclasspath = ["//tools/jdk:bootclasspath"],
encoding = "UTF-8",
xlint = [ "classfile", "divzero", "empty", "options", "path" ],
misc = [ "-g" ],
javabuilder = ":JavaBuilder_deploy.jar",
)
</pre>
<!-- #END_BLAZE_RULE -->*/
|
