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
|
// Copyright 2015 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.proto;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableSet;
import com.google.devtools.build.lib.analysis.config.BuildConfiguration;
import com.google.devtools.build.lib.analysis.config.BuildConfiguration.Fragment;
import com.google.devtools.build.lib.analysis.config.BuildOptions;
import com.google.devtools.build.lib.analysis.config.ConfigurationEnvironment;
import com.google.devtools.build.lib.analysis.config.ConfigurationFragmentFactory;
import com.google.devtools.build.lib.analysis.config.FragmentOptions;
import com.google.devtools.build.lib.analysis.config.InvalidConfigurationException;
import com.google.devtools.build.lib.cmdline.Label;
import com.google.devtools.build.lib.concurrent.ThreadSafety.Immutable;
import com.google.devtools.common.options.Option;
import java.util.List;
/**
* Configuration for Protocol Buffer Libraries.
*/
@Immutable
public class ProtoConfiguration extends Fragment {
/**
* Command line options.
*/
public static class Options extends FragmentOptions {
@Option(name = "protocopt",
allowMultiple = true,
defaultValue = "",
category = "flags",
help = "Additional options to pass to the protobuf compiler.")
public List<String> protocOpts;
@Option(
name = "experimental_proto_extra_actions",
defaultValue = "false",
category = "experimental",
help = "Run extra actions for alternative Java api versions in a proto_library."
)
public boolean experimentalProtoExtraActions;
@Option(
name = "proto_compiler",
defaultValue = "null",
category = "version",
converter = BuildConfiguration.LabelConverter.class,
help = "The label of the proto-compiler."
)
public Label protoCompiler;
// TODO(b/31775048): Replace with a toolchain
/** This is experimental, and is subject to change without warning. */
@Option(
name = "proto_compiler_java_flags",
defaultValue = "--java_out=shared,immutable:%s",
category = "experimental",
help = "The flags to pass to proto-compiler when generating Java protos."
)
public String protoCompilerJavaFlags;
// TODO(b/31775048): Replace with a toolchain
/** This is experimental, and is subject to change without warning. */
@Option(
name = "proto_compiler_java_blacklisted_protos",
defaultValue = "",
category = "experimental",
converter = BuildConfiguration.LabelListConverter.class,
help = "A label of a filegroup of .proto files that we shouldn't generate sources for."
)
public List<Label> protoCompilerJavaBlacklistedProtos;
// TODO(b/31775048): Replace with a toolchain
/** This is experimental, and is subject to change without warning. */
@Option(
name = "proto_compiler_javalite_flags",
defaultValue = "--javalite_out=%s",
category = "experimental",
help = "The flags to pass to proto-compiler when generating JavaLite protos."
)
public String protoCompilerJavaLiteFlags;
// TODO(b/31775048): Replace with a toolchain
/** This is experimental, and is subject to change without warning. */
@Option(
name = "proto_compiler_javalite_plugin",
defaultValue = "",
category = "experimental",
converter = BuildConfiguration.EmptyToNullLabelConverter.class,
help = "A label for the javalite proto-compiler plugin, if needed."
)
public Label protoCompilerJavaLitePlugin;
@Option(
name = "proto_toolchain_for_javalite",
defaultValue = "//tools/proto/toolchains:javalite",
category = "flags",
converter = BuildConfiguration.EmptyToNullLabelConverter.class,
help = "Label of proto_lang_toolchain() which describes how to compile JavaLite protos"
)
public Label protoToolchainForJavaLite;
@Override
public FragmentOptions getHost(boolean fallback) {
Options host = (Options) super.getHost(fallback);
host.protoCompiler = protoCompiler;
host.protocOpts = protocOpts;
host.experimentalProtoExtraActions = experimentalProtoExtraActions;
host.protoCompiler = protoCompiler;
host.protoCompilerJavaFlags = protoCompilerJavaFlags;
host.protoCompilerJavaBlacklistedProtos = protoCompilerJavaBlacklistedProtos;
host.protoCompilerJavaLiteFlags = protoCompilerJavaLiteFlags;
host.protoCompilerJavaLitePlugin = protoCompilerJavaLitePlugin;
host.protoToolchainForJavaLite = protoToolchainForJavaLite;
return host;
}
}
/**
* Loader class for proto.
*/
public static class Loader implements ConfigurationFragmentFactory {
@Override
public Fragment create(ConfigurationEnvironment env, BuildOptions buildOptions)
throws InvalidConfigurationException {
return new ProtoConfiguration(buildOptions.get(Options.class));
}
@Override
public Class<? extends Fragment> creates() {
return ProtoConfiguration.class;
}
@Override
public ImmutableSet<Class<? extends FragmentOptions>> requiredOptions() {
return ImmutableSet.<Class<? extends FragmentOptions>>of(Options.class);
}
}
private final boolean experimentalProtoExtraActions;
private final ImmutableList<String> protocOpts;
private final Label protoCompiler;
private final String protoCompilerJavaFlags;
private final List<Label> protoCompilerJavaBlacklistedProtos;
private final String protoCompilerJavaLiteFlags;
private final Label protoCompilerJavaLitePlugin;
private final Label protoToolchainForJavaLite;
public ProtoConfiguration(Options options) {
this.experimentalProtoExtraActions = options.experimentalProtoExtraActions;
this.protocOpts = ImmutableList.copyOf(options.protocOpts);
this.protoCompiler = options.protoCompiler;
this.protoCompilerJavaFlags = options.protoCompilerJavaFlags;
this.protoCompilerJavaLiteFlags = options.protoCompilerJavaLiteFlags;
this.protoCompilerJavaLitePlugin = options.protoCompilerJavaLitePlugin;
this.protoCompilerJavaBlacklistedProtos = options.protoCompilerJavaBlacklistedProtos;
this.protoToolchainForJavaLite = options.protoToolchainForJavaLite;
}
public ImmutableList<String> protocOpts() {
return protocOpts;
}
/**
* Returns true if we will run extra actions for actions that are not run by default. If this
* is enabled, e.g. all extra_actions for alternative api-versions or language-flavours of a
* proto_library target are run.
*/
public boolean runExperimentalProtoExtraActions() {
return experimentalProtoExtraActions;
}
public Label protoCompiler() {
return protoCompiler;
}
public String protoCompilerJavaFlags() {
return protoCompilerJavaFlags;
}
public String protoCompilerJavaLiteFlags() {
return protoCompilerJavaLiteFlags;
}
public Label protoCompilerJavaLitePlugin() {
return protoCompilerJavaLitePlugin;
}
public List<Label> protoCompilerJavaBlacklistedProtos() {
return protoCompilerJavaBlacklistedProtos;
}
public Label protoToolchainForJavaLite() {
return protoToolchainForJavaLite;
}
}
|
