| // Copyright 2018 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.android; |
| |
| import com.google.common.collect.ImmutableList; |
| import com.google.devtools.build.lib.skylarkbuildapi.FileApi; |
| import com.google.devtools.build.lib.skylarkbuildapi.core.ProviderApi; |
| import com.google.devtools.build.lib.skylarkbuildapi.core.StructApi; |
| import com.google.devtools.build.lib.skylarkinterface.Param; |
| import com.google.devtools.build.lib.skylarkinterface.SkylarkCallable; |
| import com.google.devtools.build.lib.skylarkinterface.SkylarkConstructor; |
| import com.google.devtools.build.lib.skylarkinterface.SkylarkModule; |
| import com.google.devtools.build.lib.syntax.Depset; |
| import com.google.devtools.build.lib.syntax.EvalException; |
| import com.google.devtools.build.lib.syntax.Sequence; |
| import com.google.devtools.build.lib.syntax.SkylarkType; |
| import com.google.devtools.build.lib.syntax.StarlarkValue; |
| import javax.annotation.Nullable; |
| |
| /** |
| * An interface for a provider that exposes the use of <a |
| * href="https://developer.android.com/topic/libraries/data-binding/index.html">data binding</a>. |
| */ |
| @SkylarkModule( |
| name = "DataBindingV2Info", |
| doc = |
| "Do not use this module. It is intended for migration purposes only. If you depend on it, " |
| + "you will be broken when it is removed.", |
| documented = false) |
| public interface DataBindingV2ProviderApi<T extends FileApi> extends StructApi { |
| |
| /** |
| * A pair of label as a string and the Java package for that label as determined by the Android |
| * rules. This is for reporting a useful error message if multiple android_library rules with the |
| * same Java package end up in the same android_binary. |
| */ |
| @SkylarkModule( |
| name = "LabelJavaPackagePair", |
| doc = |
| "Do not use this module. It is intended for migration purposes only. If you depend on " |
| + "it, you will be broken when it is removed.", |
| documented = false) |
| final class LabelJavaPackagePair implements StarlarkValue { |
| |
| public static final SkylarkType TYPE = SkylarkType.of(LabelJavaPackagePair.class); |
| |
| private final String label; |
| private final String javaPackage; |
| |
| public LabelJavaPackagePair(String label, String javaPackage) { |
| this.label = label; |
| this.javaPackage = javaPackage; |
| } |
| |
| @SkylarkCallable(name = "label", structField = true, doc = "", documented = false) |
| public String getLabel() { |
| return label; |
| } |
| |
| @SkylarkCallable(name = "java_package", structField = true, doc = "", documented = false) |
| public String getJavaPackage() { |
| return javaPackage; |
| } |
| } |
| |
| /** Name of this info object. */ |
| String NAME = "DataBindingV2Info"; |
| |
| /** |
| * Returns the setter store files from this rule. This is a list to support multiple |
| * android_libraries in the exports attribute, where the providers from exports are merged into a |
| * single provider. In a rule without exports, this will be at most 1 file. |
| */ |
| @SkylarkCallable(name = "setter_stores", structField = true, doc = "", documented = false) |
| ImmutableList<T> getSetterStores(); |
| |
| /** |
| * Returns the class info files from this rule. This is a list to support multiple |
| * android_libraries in the exports attribute, where the providers from exports are merged into a |
| * single provider. In a rule without exports, this will be at most 1 file. |
| */ |
| @SkylarkCallable(name = "class_infos", structField = true, doc = "", documented = false) |
| ImmutableList<T> getClassInfos(); |
| |
| /** Returns the BR files from this rule and its dependencies. */ |
| @SkylarkCallable(name = "transitive_br_files", structField = true, doc = "", documented = false) |
| Depset /*<T>*/ getTransitiveBRFilesForStarlark(); |
| |
| /** |
| * Returns a NestedSet containing the label and java package for this rule and its transitive |
| * dependencies. |
| */ |
| @SkylarkCallable( |
| name = "transitive_label_and_java_packages", |
| structField = true, |
| doc = "", |
| documented = false) |
| Depset /*<LabelJavaPackagePair>*/ getTransitiveLabelAndJavaPackagesForStarlark(); |
| |
| /** |
| * Returns the label and java package for this rule and any rules that this rule exports. |
| */ |
| @SkylarkCallable( |
| name = "label_and_java_packages", |
| structField = true, |
| doc = "", |
| documented = false) |
| @Nullable |
| ImmutableList<LabelJavaPackagePair> getLabelAndJavaPackages(); |
| |
| /** The provider implementing this can construct the DataBindingV2Info provider. */ |
| @SkylarkModule( |
| name = "Provider", |
| doc = |
| "Do not use this module. It is intended for migration purposes only. If you depend on " |
| + "it, you will be broken when it is removed.", |
| documented = false) |
| interface Provider<FileT extends FileApi> extends ProviderApi { |
| |
| @SkylarkCallable( |
| name = NAME, |
| doc = "The <code>DataBindingV2Info</code> constructor.", |
| documented = false, |
| parameters = { |
| @Param( |
| name = "setter_store_file", |
| doc = "The setter_stores.bin files .", |
| positional = false, |
| named = true, |
| noneable = true, |
| defaultValue = "None", |
| type = FileApi.class), |
| @Param( |
| name = "class_info_file", |
| doc = "The class_info files for this rule.", |
| positional = false, |
| named = true, |
| noneable = true, |
| defaultValue = "None", |
| type = FileApi.class), |
| @Param( |
| name = "br_file", |
| doc = "The br file for this rule.", |
| positional = false, |
| named = true, |
| noneable = true, |
| defaultValue = "None", |
| type = FileApi.class), |
| @Param( |
| name = "label", |
| doc = "The label of the current rule.", |
| positional = false, |
| named = true, |
| noneable = true, |
| defaultValue = "None", |
| type = String.class), |
| @Param( |
| name = "java_package", |
| doc = "The java package of the current rule.", |
| positional = false, |
| named = true, |
| noneable = true, |
| defaultValue = "None", |
| type = String.class), |
| @Param( |
| name = "databinding_v2_providers_in_deps", |
| doc = "The DatabindingV2Provider instances from dependencies.", |
| positional = false, |
| named = true, |
| defaultValue = "[]", |
| type = Sequence.class, |
| generic1 = DataBindingV2ProviderApi.class), |
| @Param( |
| name = "databinding_v2_providers_in_exports", |
| doc = "The DatabindingV2Provider instances from exports.", |
| positional = false, |
| named = true, |
| defaultValue = "[]", |
| type = Sequence.class, |
| generic1 = DataBindingV2ProviderApi.class), |
| }, |
| selfCall = true) |
| @SkylarkConstructor(objectType = DataBindingV2ProviderApi.class) |
| DataBindingV2ProviderApi<FileT> createInfo( |
| Object setterStoreFile, |
| Object classInfoFile, |
| Object brFile, |
| Object label, |
| Object javaPackage, |
| Sequence<?> databindingV2ProvidersInDeps, // <DataBindingV2ProviderApi<FileT>> |
| Sequence<?> databindingV2ProvidersInExports /* <DataBindingV2ProviderApi<FileT>> */) |
| throws EvalException; |
| } |
| } |