rules/providers.bzl - third_party/github/bazelbuild/rules_android - Git at Google

 # 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.
 """Bazel providers for Android rules."""

 load("//rules:reexport_providers.bzl", "providers")
 load("//rules:visibility.bzl", "PROJECT_VISIBILITY")

 visibility(PROJECT_VISIBILITY)


 AndroidAppsInfo = provider(
     doc = "Provides information about app to install.",
     fields = dict(
         apps = "List of app provider artifacts.",
     ),
 )


 AndroidJavaInfo = provider(
     doc = "Provides outputs for the Android Java Compilation",
     fields = dict(
         aidl = "AndroidIdlInfo",
         aide = "AndroidIdeInfo",
         java = "JavaInfo",
     ),
 )

 AndroidFilteredJdepsInfo = provider(
     doc = "Provides a filtered jdeps proto.",
     fields = dict(
         jdeps = "Filtered jdeps",
     ),
 )

 StarlarkApkInfo = provider(
     doc = "Provides APK outputs of a rule.",
     fields = dict(
         keystore = "Keystore used to sign the APK. Deprecated, prefer signing_keys.",
         signing_keys = "List of keys used to sign the APK",
         signing_lineage = "Optional sigining lineage file",
         signed_apk = "Signed APK",
         unsigned_apk = "Unsigned APK",
     ),
 )

 ResourcesNodeInfo = provider(
     doc = "Provides information for building ResourceProcessorBusyBox flags",
     fields = dict(
         label = "A label, the target's label",

         # Assets related fields
         assets = "A depset of files, assets files of the target",
         assets_dir = "A string, the name of the assets directory",
         assets_symbols = "A file, the merged assets",
         compiled_assets = "A file, the compiled assets",

         # Dynamic resources field
         resource_apks = "A depset of resource only apk files",

         # Resource related fields
         resource_files = "A depset of files, resource files of the target",
         compiled_resources = "A file, the compiled resources",
         r_txt = "A file, the R.txt file",
         manifest = "A file, the AndroidManifest.xml",
         # TODO(ostonge): Add the manifest if it's exported, otherwise leave empty
         exports_manifest = "Boolean, whether the manifest is exported",
     ),
 )

 StarlarkAndroidResourcesInfo = provider(
     doc = "Provides information about direct and transitive resources",
     fields = dict(
         direct_resources_nodes = "Depset of ResourcesNodeInfo providers, can contain multiple providers due to exports",
         transitive_resources_nodes = "Depset of transitive ResourcesNodeInfo providers, not including directs",
         transitive_assets = "Depset of transitive assets files",
         transitive_assets_symbols = "Depset of transitive merged assets",
         transitive_compiled_assets = "Depset of transitive compiled assets",
         direct_compiled_resources = "Depset of direct compiled_resources, can contain multiple files due to exports",
         transitive_compiled_resources = "Depset of transitive compiled resources",
         transitive_manifests = "Depset of transitive manifests",
         transitive_r_txts = "Depset of transitive R.txt files",
         transitive_resource_files = "Depset of transitive resource files",
         packages_to_r_txts = "Map of packages to depset of r_txt files",
         transitive_resource_apks = "Depset of transitive resource only apk files",
     ),
 )

 AndroidLintRulesInfo = provider(
     doc = "Provides extra lint rules to use with AndroidLint.",
     fields = dict(
         lint_jars = "A depset of lint rule jars found in AARs and exported by a target.",
     ),
 )

 AndroidFeatureModuleInfo = provider(
     doc = "Contains data required to build an Android feature split.",
     fields = dict(
         binary = "String, target of the underlying split android_binary target",
         feature_name = "String, the name of the feature module. If unspecified, the target name will be used.",
         fused = "Boolean, whether the split is \"fused\" for the system image and for pre-L devices.",
         library = "String, target of the underlying split android_library target",
         manifest = "Optional AndroidManifest.xml file to use for this feature.",
         min_sdk_version = "String, the min SDK version for this feature.",
         title_id = "String, resource identifier for the split title.",
         title_lib = "String, target of the split title android_library.",
         is_asset_pack = "Boolean, whether this feature module is an asset pack. AI packs are a type of asset pack.",
     ),
 )


 Dex2OatApkInfo = provider(
     doc = "Contains data about artifacts generated through host dex2oat.",
     fields = dict(
         signed_apk = "Signed APK",
         oat_file = "Oat file generated through dex2oat.",
         vdex_file = "Vdex file generated through dex2oat.",
         art_file = "ART file generated through dex2oat.",
     ),
 )

 InstrumentedAppInfo = provider(
     doc = "Contains data about an android_binary's instrumented android_binary.",
     fields = dict(
         android_ide_info = "AndroidIdeInfo provider from the instrumented android_binary.",
     ),
 )

 FailureInfo = provider(
     fields = dict(
         error = "Error message",
     ),
 )

 AndroidBundleInfo = provider(
     doc = "Provides .aab outputs from a rule.",
     fields = dict(
         unsigned_aab = "File, the unsigned .aab",
     ),
 )

 StarlarkAndroidDexInfo = provider(
     doc = "Internal provider used to collect transitive dex info.",
     fields = dict(
         dex_archives_dict = (
             "A dictionary of all the transitive dex archives for all dexopts."
         ),
     ),
 )

 # TODO(b/325299751): The provider is only used for testing purposes now. Change the name to
 # AndroidIdeInfo when it's fully Starlarkified in all Android rules.
 # buildifier: disable=name-conventions
 StarlarkAndroidIdeInfoForTesting = provider(
     doc = "Provides Android-specific information for IDEs",
     fields = dict(
         java_package = "A string of the Java package.",
         manifest = "A file of the Android manifest.",
         generated_manifest = "A file of the generated Android manifest.",
         idl_import_root = "A string of the idl import root.",
         idl_srcs = "A list of files of the idl generated java files.",
         idl_generated_java_files = "A list of files of the idl generated java files.",
         idl_source_jar = "A file of the source Jar with the idl generated java files.",
         idl_class_jar = "A file of the class Jar with the compiled idl generated java files.",
         defines_android_resources = "A boolean if target specifies Android resources.",
         resource_jar = "A struct of type JavaOutput containing Android resources JavaInfo outputs.",
         resource_apk = "A file of the Apk containing Android resources.",
         signed_apk = "A file of the signed Apk.",
         aar = "A file of the Android archive.",
         apks_under_test = "A list of files of the apks under test",
         native_libs = "A dictionary of string to a list of files mapping architectures to" +
                       "native libs.",
     ),
 )

 # Native defined providers which will be gradually migrated to Starlark.
 # We re-export these here so that all our providers can be loaded from this file.
 ApkInfo = providers.ApkInfo
 AndroidInstrumentationInfo = providers.AndroidInstrumentationInfo
 AndroidResourcesInfo = providers.AndroidResourcesInfo
 AndroidNativeLibsInfo = providers.AndroidNativeLibsInfo
 AndroidApplicationResourceInfo = providers.AndroidApplicationResourceInfo
 AndroidBinaryNativeLibsInfo = providers.AndroidBinaryNativeLibsInfo
 AndroidSdkInfo = providers.AndroidSdkInfo
 AndroidManifestInfo = providers.AndroidManifestInfo
 AndroidAssetsInfo = providers.AndroidAssetsInfo
 AndroidLibraryAarInfo = providers.AndroidLibraryAarInfo
 AndroidProguardInfo = providers.AndroidProguardInfo
 AndroidIdlInfo = providers.AndroidIdlInfo
 AndroidIdeInfo = providers.AndroidIdeInfo
 AndroidPreDexJarInfo = providers.AndroidPreDexJarInfo
 AndroidCcLinkParamsInfo = providers.AndroidCcLinkParamsInfo
 DataBindingV2Info = providers.DataBindingV2Info
 AndroidLibraryResourceClassJarProvider = providers.AndroidLibraryResourceClassJarProvider  # buildifier: disable=name-conventions
 AndroidFeatureFlagSet = providers.AndroidFeatureFlagSet  # buildifier: disable=name-conventions
 ProguardMappingInfo = providers.ProguardMappingInfo
 AndroidBinaryData = providers.AndroidBinaryData  # buildifier: disable=name-conventions
 BaselineProfileProvider = providers.BaselineProfileProvider  # buildifier: disable=name-conventions
 AndroidNeverLinkLibrariesProvider = providers.AndroidNeverLinkLibrariesProvider  # buildifier: disable=name-conventions
 AndroidOptimizedJarInfo = providers.AndroidOptimizedJarInfo
 AndroidDexInfo = providers.AndroidDexInfo
 AndroidOptimizationInfo = providers.AndroidOptimizationInfo
	# 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.
	"""Bazel providers for Android rules."""

	load("//rules:reexport_providers.bzl", "providers")
	load("//rules:visibility.bzl", "PROJECT_VISIBILITY")

	visibility(PROJECT_VISIBILITY)



	AndroidAppsInfo = provider(
	doc = "Provides information about app to install.",
	fields = dict(
	apps = "List of app provider artifacts.",
	),
	)






	AndroidJavaInfo = provider(
	doc = "Provides outputs for the Android Java Compilation",
	fields = dict(
	aidl = "AndroidIdlInfo",
	aide = "AndroidIdeInfo",
	java = "JavaInfo",
	),
	)

	AndroidFilteredJdepsInfo = provider(
	doc = "Provides a filtered jdeps proto.",
	fields = dict(
	jdeps = "Filtered jdeps",
	),
	)

	StarlarkApkInfo = provider(
	doc = "Provides APK outputs of a rule.",
	fields = dict(
	keystore = "Keystore used to sign the APK. Deprecated, prefer signing_keys.",
	signing_keys = "List of keys used to sign the APK",
	signing_lineage = "Optional sigining lineage file",
	signed_apk = "Signed APK",
	unsigned_apk = "Unsigned APK",
	),
	)

	ResourcesNodeInfo = provider(
	doc = "Provides information for building ResourceProcessorBusyBox flags",
	fields = dict(
	label = "A label, the target's label",

	# Assets related fields
	assets = "A depset of files, assets files of the target",
	assets_dir = "A string, the name of the assets directory",
	assets_symbols = "A file, the merged assets",
	compiled_assets = "A file, the compiled assets",

	# Dynamic resources field
	resource_apks = "A depset of resource only apk files",

	# Resource related fields
	resource_files = "A depset of files, resource files of the target",
	compiled_resources = "A file, the compiled resources",
	r_txt = "A file, the R.txt file",
	manifest = "A file, the AndroidManifest.xml",
	# TODO(ostonge): Add the manifest if it's exported, otherwise leave empty
	exports_manifest = "Boolean, whether the manifest is exported",
	),
	)

	StarlarkAndroidResourcesInfo = provider(
	doc = "Provides information about direct and transitive resources",
	fields = dict(
	direct_resources_nodes = "Depset of ResourcesNodeInfo providers, can contain multiple providers due to exports",
	transitive_resources_nodes = "Depset of transitive ResourcesNodeInfo providers, not including directs",
	transitive_assets = "Depset of transitive assets files",
	transitive_assets_symbols = "Depset of transitive merged assets",
	transitive_compiled_assets = "Depset of transitive compiled assets",
	direct_compiled_resources = "Depset of direct compiled_resources, can contain multiple files due to exports",
	transitive_compiled_resources = "Depset of transitive compiled resources",
	transitive_manifests = "Depset of transitive manifests",
	transitive_r_txts = "Depset of transitive R.txt files",
	transitive_resource_files = "Depset of transitive resource files",
	packages_to_r_txts = "Map of packages to depset of r_txt files",
	transitive_resource_apks = "Depset of transitive resource only apk files",
	),
	)

	AndroidLintRulesInfo = provider(
	doc = "Provides extra lint rules to use with AndroidLint.",
	fields = dict(
	lint_jars = "A depset of lint rule jars found in AARs and exported by a target.",
	),
	)

	AndroidFeatureModuleInfo = provider(
	doc = "Contains data required to build an Android feature split.",
	fields = dict(
	binary = "String, target of the underlying split android_binary target",
	feature_name = "String, the name of the feature module. If unspecified, the target name will be used.",
	fused = "Boolean, whether the split is \"fused\" for the system image and for pre-L devices.",
	library = "String, target of the underlying split android_library target",
	manifest = "Optional AndroidManifest.xml file to use for this feature.",
	min_sdk_version = "String, the min SDK version for this feature.",
	title_id = "String, resource identifier for the split title.",
	title_lib = "String, target of the split title android_library.",
	is_asset_pack = "Boolean, whether this feature module is an asset pack. AI packs are a type of asset pack.",
	),
	)


	Dex2OatApkInfo = provider(
	doc = "Contains data about artifacts generated through host dex2oat.",
	fields = dict(
	signed_apk = "Signed APK",
	oat_file = "Oat file generated through dex2oat.",
	vdex_file = "Vdex file generated through dex2oat.",
	art_file = "ART file generated through dex2oat.",
	),
	)

	InstrumentedAppInfo = provider(
	doc = "Contains data about an android_binary's instrumented android_binary.",
	fields = dict(
	android_ide_info = "AndroidIdeInfo provider from the instrumented android_binary.",
	),
	)

	FailureInfo = provider(
	fields = dict(
	error = "Error message",
	),
	)

	AndroidBundleInfo = provider(
	doc = "Provides .aab outputs from a rule.",
	fields = dict(
	unsigned_aab = "File, the unsigned .aab",
	),
	)

	StarlarkAndroidDexInfo = provider(
	doc = "Internal provider used to collect transitive dex info.",
	fields = dict(
	dex_archives_dict = (
	"A dictionary of all the transitive dex archives for all dexopts."
	),
	),
	)

	# TODO(b/325299751): The provider is only used for testing purposes now. Change the name to
	# AndroidIdeInfo when it's fully Starlarkified in all Android rules.
	# buildifier: disable=name-conventions
	StarlarkAndroidIdeInfoForTesting = provider(
	doc = "Provides Android-specific information for IDEs",
	fields = dict(
	java_package = "A string of the Java package.",
	manifest = "A file of the Android manifest.",
	generated_manifest = "A file of the generated Android manifest.",
	idl_import_root = "A string of the idl import root.",
	idl_srcs = "A list of files of the idl generated java files.",
	idl_generated_java_files = "A list of files of the idl generated java files.",
	idl_source_jar = "A file of the source Jar with the idl generated java files.",
	idl_class_jar = "A file of the class Jar with the compiled idl generated java files.",
	defines_android_resources = "A boolean if target specifies Android resources.",
	resource_jar = "A struct of type JavaOutput containing Android resources JavaInfo outputs.",
	resource_apk = "A file of the Apk containing Android resources.",
	signed_apk = "A file of the signed Apk.",
	aar = "A file of the Android archive.",
	apks_under_test = "A list of files of the apks under test",
	native_libs = "A dictionary of string to a list of files mapping architectures to" +
	"native libs.",
	),
	)

	# Native defined providers which will be gradually migrated to Starlark.
	# We re-export these here so that all our providers can be loaded from this file.
	ApkInfo = providers.ApkInfo
	AndroidInstrumentationInfo = providers.AndroidInstrumentationInfo
	AndroidResourcesInfo = providers.AndroidResourcesInfo
	AndroidNativeLibsInfo = providers.AndroidNativeLibsInfo
	AndroidApplicationResourceInfo = providers.AndroidApplicationResourceInfo
	AndroidBinaryNativeLibsInfo = providers.AndroidBinaryNativeLibsInfo
	AndroidSdkInfo = providers.AndroidSdkInfo
	AndroidManifestInfo = providers.AndroidManifestInfo
	AndroidAssetsInfo = providers.AndroidAssetsInfo
	AndroidLibraryAarInfo = providers.AndroidLibraryAarInfo
	AndroidProguardInfo = providers.AndroidProguardInfo
	AndroidIdlInfo = providers.AndroidIdlInfo
	AndroidIdeInfo = providers.AndroidIdeInfo
	AndroidPreDexJarInfo = providers.AndroidPreDexJarInfo
	AndroidCcLinkParamsInfo = providers.AndroidCcLinkParamsInfo
	DataBindingV2Info = providers.DataBindingV2Info
	AndroidLibraryResourceClassJarProvider = providers.AndroidLibraryResourceClassJarProvider # buildifier: disable=name-conventions
	AndroidFeatureFlagSet = providers.AndroidFeatureFlagSet # buildifier: disable=name-conventions
	ProguardMappingInfo = providers.ProguardMappingInfo
	AndroidBinaryData = providers.AndroidBinaryData # buildifier: disable=name-conventions
	BaselineProfileProvider = providers.BaselineProfileProvider # buildifier: disable=name-conventions
	AndroidNeverLinkLibrariesProvider = providers.AndroidNeverLinkLibrariesProvider # buildifier: disable=name-conventions
	AndroidOptimizedJarInfo = providers.AndroidOptimizedJarInfo
	AndroidDexInfo = providers.AndroidDexInfo
	AndroidOptimizationInfo = providers.AndroidOptimizationInfo