diff options
| -rw-r--r-- | src/main/java/com/google/devtools/build/lib/analysis/FileProvider.java | 13 | ||||
| -rw-r--r-- | src/main/java/com/google/devtools/build/lib/skylarkbuildapi/FileProviderApi.java | 46 |
2 files changed, 49 insertions, 10 deletions
diff --git a/src/main/java/com/google/devtools/build/lib/analysis/FileProvider.java b/src/main/java/com/google/devtools/build/lib/analysis/FileProvider.java index 9821a836d3..b94ef101d2 100644 --- a/src/main/java/com/google/devtools/build/lib/analysis/FileProvider.java +++ b/src/main/java/com/google/devtools/build/lib/analysis/FileProvider.java @@ -20,9 +20,7 @@ import com.google.devtools.build.lib.collect.nestedset.NestedSetBuilder; import com.google.devtools.build.lib.collect.nestedset.Order; import com.google.devtools.build.lib.concurrent.ThreadSafety.Immutable; import com.google.devtools.build.lib.skyframe.serialization.autocodec.AutoCodec; -import com.google.devtools.build.lib.skylarkinterface.SkylarkCallable; -import com.google.devtools.build.lib.skylarkinterface.SkylarkModule; -import com.google.devtools.build.lib.skylarkinterface.SkylarkModuleCategory; +import com.google.devtools.build.lib.skylarkbuildapi.FileProviderApi; /** * A representation of the concept "this transitive info provider builds these files". @@ -30,13 +28,8 @@ import com.google.devtools.build.lib.skylarkinterface.SkylarkModuleCategory; * <p>Every transitive info collection contains at least this provider. */ @Immutable -@SkylarkModule( - name = "file_provider", - doc = "An interface for rules that provide files.", - category = SkylarkModuleCategory.PROVIDER -) @AutoCodec -public final class FileProvider implements TransitiveInfoProvider { +public final class FileProvider implements TransitiveInfoProvider, FileProviderApi { public static final FileProvider EMPTY = new FileProvider(NestedSetBuilder.<Artifact>emptySet(Order.STABLE_ORDER)); @@ -62,7 +55,7 @@ public final class FileProvider implements TransitiveInfoProvider { * <p>Also, some rules may generate artifacts that are not listed here by way of defining other * implicit targets, for example, deploy jars. */ - @SkylarkCallable(name = "files_to_build", documented = false, structField = true) + @Override public NestedSet<Artifact> getFilesToBuild() { return filesToBuild; } diff --git a/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/FileProviderApi.java b/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/FileProviderApi.java new file mode 100644 index 0000000000..da524123b2 --- /dev/null +++ b/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/FileProviderApi.java @@ -0,0 +1,46 @@ +// 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.skylarkbuildapi; + +import com.google.devtools.build.lib.collect.nestedset.NestedSet; +import com.google.devtools.build.lib.skylarkinterface.SkylarkCallable; +import com.google.devtools.build.lib.skylarkinterface.SkylarkModule; +import com.google.devtools.build.lib.skylarkinterface.SkylarkModuleCategory; + +/** A representation of the concept "this builds these files". */ +@SkylarkModule( + name = "file_provider", + doc = "An interface for rules that provide files.", + category = SkylarkModuleCategory.PROVIDER) +public interface FileProviderApi { + + /** + * Returns the set of files that are the "output" of this rule. + * + * <p>The term "output" is somewhat hazily defined; it is vaguely the set of files that are passed + * on to dependent rules that list the rule in their {@code srcs} attribute and the set of files + * that are built when a rule is mentioned on the command line. It does <b>not</b> include the + * runfiles. + * + * <p>Note that the above definition is somewhat imprecise; in particular, when a rule is + * mentioned on the command line, some other files are also built and dependent rules are free to + * filter this set of files e.g. based on their extension. + * + * <p>Also, some rules may generate files that are not listed here by way of defining other + * implicit targets, for example, deploy jars. + */ + @SkylarkCallable(name = "files_to_build", documented = false, structField = true) + NestedSet<? extends FileApi> getFilesToBuild(); +} |