-
Notifications
You must be signed in to change notification settings - Fork 4.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
ProtoConfiguration: Expose some fields to Starlark #12484
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
62 changes: 62 additions & 0 deletions
62
src/main/java/com/google/devtools/build/lib/rules/proto/ProtoToolchainInfo.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
// Copyright 2021 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.auto.value.AutoValue; | ||
import com.google.common.collect.ImmutableList; | ||
import com.google.devtools.build.lib.analysis.FilesToRunProvider; | ||
import com.google.devtools.build.lib.analysis.platform.ToolchainInfo; | ||
import com.google.devtools.build.lib.concurrent.ThreadSafety.Immutable; | ||
import net.starlark.java.eval.EvalException; | ||
import net.starlark.java.eval.Sequence; | ||
import net.starlark.java.eval.Starlark; | ||
|
||
/** Information about the tools used by the {@code proto_*} and {@code LANG_proto_*} rules. */ | ||
@Immutable | ||
@AutoValue | ||
public abstract class ProtoToolchainInfo { | ||
private static final String PROTOC_ATTR_NAME = "protoc"; | ||
private static final String PROTOC_OPTIONS_ATTR_NAME = "protoc_options"; | ||
|
||
/** The {@code protoc} binary to use for proto actions. */ | ||
public abstract FilesToRunProvider getProtoc(); | ||
|
||
/** Additional options to pass to {@code protoc}. */ | ||
public abstract ImmutableList<String> getProtocOptions(); | ||
|
||
/** | ||
* Constructs a {@link ProtoToolchainInfo} from {@link ToolchainInfo} (i.e. as returned by {@code | ||
* proto_toolchain} from {@code @rules_proto}). | ||
*/ | ||
public static ProtoToolchainInfo fromToolchainInfo(ToolchainInfo toolchain) throws EvalException { | ||
FilesToRunProvider protoc = getValue(toolchain, PROTOC_ATTR_NAME, FilesToRunProvider.class); | ||
ImmutableList<String> protocOptions = | ||
Sequence.cast( | ||
getValue(toolchain, PROTOC_OPTIONS_ATTR_NAME, Object.class), | ||
String.class, | ||
PROTOC_OPTIONS_ATTR_NAME) | ||
.getImmutableList(); | ||
return new AutoValue_ProtoToolchainInfo(protoc, protocOptions); | ||
} | ||
|
||
private static <T> T getValue(ToolchainInfo toolchain, String name, Class<T> clazz) | ||
throws EvalException { | ||
T value = toolchain.getValue(name, clazz); | ||
if (value == null) { | ||
throw Starlark.errorf("Proto toolchain does not have mandatory field '%s'", name); | ||
} | ||
return value; | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please see my comments in bazelbuild/rules_proto#82