| // 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.starlarkbuildapi.java; |
| |
| import com.google.devtools.build.docgen.annot.DocCategory; |
| import com.google.devtools.build.docgen.annot.StarlarkConstructor; |
| import com.google.devtools.build.lib.cmdline.Label; |
| import com.google.devtools.build.lib.collect.nestedset.Depset; |
| import com.google.devtools.build.lib.starlarkbuildapi.FileApi; |
| import com.google.devtools.build.lib.starlarkbuildapi.core.ProviderApi; |
| import com.google.devtools.build.lib.starlarkbuildapi.core.StructApi; |
| import net.starlark.java.annot.Param; |
| import net.starlark.java.annot.ParamType; |
| import net.starlark.java.annot.StarlarkBuiltin; |
| import net.starlark.java.annot.StarlarkMethod; |
| import net.starlark.java.eval.EvalException; |
| |
| /** Provides information about generated proto extensions. */ |
| @StarlarkBuiltin( |
| name = "GeneratedExtensionRegistryProvider", |
| doc = "Information about generated proto extensions.", |
| category = DocCategory.PROVIDER) |
| public interface GeneratedExtensionRegistryProviderApi<FileT extends FileApi> extends StructApi { |
| |
| /** The name of the provider for this info object. */ |
| String NAME = "GeneratedExtensionRegistryProvider"; |
| |
| @StarlarkMethod(name = "rule_label", structField = true, doc = "", documented = false) |
| Label getGeneratingRuleLabel(); |
| |
| @StarlarkMethod(name = "lite", structField = true, doc = "", documented = false) |
| boolean isLite(); |
| |
| @StarlarkMethod(name = "class_jar", structField = true, doc = "", documented = false) |
| FileT getClassJar(); |
| |
| @StarlarkMethod(name = "src_jar", structField = true, doc = "", documented = false) |
| FileT getSrcJar(); |
| |
| @StarlarkMethod(name = "inputs", structField = true, doc = "", documented = false) |
| Depset /*<FileT>*/ getInputsForStarlark(); |
| |
| /** The provider implementing this can construct the GeneratedExtensionRegistryProvider. */ |
| @StarlarkBuiltin(name = "Provider", doc = "", documented = false) |
| interface Provider<FileT extends FileApi> extends ProviderApi { |
| |
| @StarlarkMethod( |
| name = NAME, |
| doc = "The <code>GeneratedExtensionRegistryProvider</code> constructor.", |
| parameters = { |
| @Param( |
| name = "generatingRuleLabel", |
| doc = "Rule label for which this registry was built", |
| positional = true, |
| named = false), |
| @Param( |
| name = "isLite", |
| doc = "If this registry was generated for lite or full runtime", |
| positional = true, |
| named = false), |
| @Param( |
| name = "classJar", |
| doc = "Class jar generated by the registry", |
| positional = true, |
| named = false), |
| @Param( |
| name = "srcJar", |
| doc = "Source jar generated by the registry", |
| positional = true, |
| named = false), |
| @Param( |
| name = "inputs", |
| doc = "Proto jars used to generate the registry", |
| positional = true, |
| named = false, |
| allowedTypes = {@ParamType(type = Depset.class, generic1 = FileApi.class)}), |
| }, |
| selfCall = true) |
| @StarlarkConstructor |
| GeneratedExtensionRegistryProviderApi<FileT> create( |
| Label generatingRuleLabel, boolean isLite, FileT classJar, FileT srcJar, Depset inputs) |
| throws EvalException; |
| } |
| } |