rules/attrs.bzl - platform/external/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.

 """Common attributes for Android rules."""

 load(":utils.bzl", "log")

 def _add(attrs, *others):
     new = {}
     new.update(attrs)
     for o in others:
         for name in o.keys():
             if name in new:
                 log.error("Attr '%s' is defined twice." % name)
             new[name] = o[name]
     return new

 def _replace(attrs, **kwargs):
     # Verify that new values are replacing existing ones, not adding.
     for name in kwargs.keys():
         if name not in attrs:
             log.error("Attr '%s' is not defined, replacement failed." % name)
     new = dict()
     new.update(attrs)
     new.update(kwargs)
     return new

 def _make_tristate_attr(default, doc = "", mandatory = False):
     return attr.int(
         default = default,
         doc = doc,
         mandatory = mandatory,
         values = [-1, 0, 1],
     )

 def _normalize_tristate(attr_value):
     """Normalizes the tristate value going into a rule.

     This is required because "tristate" is not officially supported as an
     attribute type. An equivalent attribute type is an in with a constrained
     set of values, namely [-1, 0, 1]. Unfortunately, tristate accepts
     multiple types, integers, booleans and strings ("auto"). As a result, this
     method normalizes the inputs to an integer.

     This method needs to be applied to attributes that were formally tristate
     to normalize the inputs.
     """
     if type(attr_value) == "int":
         return attr_value

     if type(attr_value) == "string":
         if attr_value.lower() == "auto":
             return -1

     if type(attr_value) == "bool":
         return int(attr_value)

     return attr_value  # Return unknown type, let the rule fail.

 _tristate = struct(
     create = _make_tristate_attr,
     normalize = _normalize_tristate,
     yes = 1,
     no = 0,
     auto = -1,
 )

 _JAVA_RUNTIME = dict(
     _host_javabase = attr.label(
         cfg = "host",
         default = Label("@rules_android//tools/jdk:current_java_runtime"),
     ),
 )


 # Android SDK attribute.
 _ANDROID_SDK = dict(
     _android_sdk = attr.label(
         allow_rules = ["android_sdk"],
         default = configuration_field(
             fragment = "android",
             name = "android_sdk_label",
         ),
         providers = [AndroidSdkInfo],
     ),
 )

 # Compilation attributes for Android rules.
 _COMPILATION = _add(
     dict(
         assets = attr.label_list(
             allow_files = True,
             cfg = "target",
             doc = ("The list of assets to be packaged. This is typically a glob of " +
                    "all files under the assets directory. You can also reference " +
                    "other rules (any rule that produces files) or exported files in " +
                    "the other packages, as long as all those files are under the " +
                    "assets_dir directory in the corresponding package."),
         ),
         assets_dir = attr.string(
             doc = ("The string giving the path to the files in assets. " +
                    "The pair assets and assets_dir describe packaged assets and either both " +
                    "attributes should be provided or none of them."),
         ),
         custom_package = attr.string(
             doc = ("Java package for which java sources will be generated. " +
                    "By default the package is inferred from the directory where the BUILD file " +
                    "containing the rule is. You can specify a different package but this is " +
                    "highly discouraged since it can introduce classpath conflicts with other " +
                    "libraries that will only be detected at runtime."),
         ),
         manifest = attr.label(
             allow_single_file = [".xml"],
             doc = ("The name of the Android manifest file, normally " +
                    "AndroidManifest.xml. Must be defined if resource_files or assets are defined."),
         ),
         resource_files = attr.label_list(
             allow_files = True,
             doc = ("The list of resources to be packaged. This " +
                    "is typically a glob of all files under the res directory. Generated files " +
                    "(from genrules) can be referenced by Label here as well. The only " +
                    "restriction is that the generated outputs must be under the same \"res\" " +
                    "directory as any other resource files that are included."),
         ),
         data = attr.label_list(
             allow_files = True,
         ),
         plugins = attr.label_list(
             providers = [JavaPluginInfo],
             cfg = "host",
         ),
         javacopts = attr.string_list(),
         # TODO: Expose getPlugins() in JavaConfiguration.java
         #       com/google/devtools/build/lib/rules/java/JavaConfiguration.java
         #       com/google/devtools/build/lib/rules/java/JavaOptions.java
         #
         # _java_plugins = attr.label(
         #     allow_rules = ["java_plugin"],
         #     default = configuration_field(
         #         fragment = "java",
         #         name = "plugin",
         #     ),
         # ),
     ),
     _JAVA_RUNTIME,
 )

 # Attributes for rules that use the AndroidDataContext android_data.make_context
 _DATA_CONTEXT = _add(
     dict(
         # Additional attrs needed for AndroidDataContext
         _add_g3itr_xslt = attr.label(
             cfg = "host",
             default = Label("//tools/android/xslt:add_g3itr.xslt"),
             allow_single_file = True,
         ),
         _android_manifest_merge_tool = attr.label(
             cfg = "host",
             default = Label("//tools/android:merge_manifests"),
             executable = True,
         ),
         # TODO(b/145617058) Switching back to head RPBB until the Android rules release process is improved
         _android_resources_busybox = attr.label(
             cfg = "host",
             default = Label("@rules_android//rules:ResourceProcessorBusyBox"),
             executable = True,
         ),
         _xsltproc_tool = attr.label(
             cfg = "host",
             default = Label("//tools/android/xslt:xslt"),
             allow_files = True,
         ),
     ),
     _ANDROID_SDK,
 )


 ANDROID_SDK_ATTRS = dict(
     aapt = attr.label(
         allow_single_file = True,
         cfg = "host",
         executable = True,
         mandatory = True,
     ),
     aapt2 = attr.label(
         allow_single_file = True,
         cfg = "host",
         executable = True,
     ),
     aidl = attr.label(
         allow_files = True,
         cfg = "host",
         executable = True,
         mandatory = True,
     ),
     aidl_lib = attr.label(
         allow_files = [".jar"],
     ),
     android_jar = attr.label(
         allow_single_file = [".jar"],
         cfg = "host",
         mandatory = True,
     ),
     annotations_jar = attr.label(
         allow_single_file = [".jar"],
         cfg = "host",
     ),
     apkbuilder = attr.label(
         allow_files = True,
         cfg = "host",
         executable = True,
     ),
     apksigner = attr.label(
         allow_files = True,
         cfg = "host",
         executable = True,
         mandatory = True,
     ),
     adb = attr.label(
         allow_single_file = True,
         cfg = "host",
         executable = True,
         mandatory = True,
     ),
     build_tools_version = attr.string(),
     dx = attr.label(
         allow_files = True,
         cfg = "host",
         executable = True,
         mandatory = True,
     ),
     framework_aidl = attr.label(
         allow_single_file = True,
         cfg = "host",
         mandatory = True,
     ),
     legacy_main_dex_list_generator = attr.label(
         allow_files = True,
         cfg = "host",
         executable = True,
     ),
     main_dex_classes = attr.label(
         allow_single_file = True,
         cfg = "host",
         mandatory = True,
     ),
     main_dex_list_creator = attr.label(
         allow_files = True,
         cfg = "host",
         executable = True,
         mandatory = True,
     ),
     proguard = attr.label(
         allow_files = True,
         cfg = "host",
         executable = True,
         mandatory = True,
     ),
     shrinked_android_jar = attr.label(
         allow_single_file = True,
         cfg = "host",
     ),
     source_properties = attr.label(
         allow_single_file = True,
         cfg = "host",
     ),
     zipalign = attr.label(
         allow_single_file = True,
         cfg = "host",
         executable = True,
         mandatory = True,
     ),
     _proguard = attr.label(
         cfg = "host",
         default = configuration_field(
             fragment = "java",
             name = "proguard_top",
         ),
     ),
     _system = attr.label(
         default = Label("//tools/android:bootclasspath_android_only"),
     ),
 )

 ANDROID_TOOLS_DEFAULTS_JAR_ATTRS = _add(_ANDROID_SDK)

 attrs = struct(
     ANDROID_SDK = _ANDROID_SDK,
     COMPILATION = _COMPILATION,
     DATA_CONTEXT = _DATA_CONTEXT,
     JAVA_RUNTIME = _JAVA_RUNTIME,
     tristate = _tristate,
     add = _add,
     replace = _replace,
 )
	# 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.

	"""Common attributes for Android rules."""

	load(":utils.bzl", "log")

	def _add(attrs, *others):
	new = {}
	new.update(attrs)
	for o in others:
	for name in o.keys():
	if name in new:
	log.error("Attr '%s' is defined twice." % name)
	new[name] = o[name]
	return new

	def _replace(attrs, **kwargs):
	# Verify that new values are replacing existing ones, not adding.
	for name in kwargs.keys():
	if name not in attrs:
	log.error("Attr '%s' is not defined, replacement failed." % name)
	new = dict()
	new.update(attrs)
	new.update(kwargs)
	return new

	def _make_tristate_attr(default, doc = "", mandatory = False):
	return attr.int(
	default = default,
	doc = doc,
	mandatory = mandatory,
	values = [-1, 0, 1],
	)

	def _normalize_tristate(attr_value):
	"""Normalizes the tristate value going into a rule.

	This is required because "tristate" is not officially supported as an
	attribute type. An equivalent attribute type is an in with a constrained
	set of values, namely [-1, 0, 1]. Unfortunately, tristate accepts
	multiple types, integers, booleans and strings ("auto"). As a result, this
	method normalizes the inputs to an integer.

	This method needs to be applied to attributes that were formally tristate
	to normalize the inputs.
	"""
	if type(attr_value) == "int":
	return attr_value

	if type(attr_value) == "string":
	if attr_value.lower() == "auto":
	return -1

	if type(attr_value) == "bool":
	return int(attr_value)

	return attr_value # Return unknown type, let the rule fail.

	_tristate = struct(
	create = _make_tristate_attr,
	normalize = _normalize_tristate,
	yes = 1,
	no = 0,
	auto = -1,
	)

	_JAVA_RUNTIME = dict(
	_host_javabase = attr.label(
	cfg = "host",
	default = Label("@rules_android//tools/jdk:current_java_runtime"),
	),
	)


	# Android SDK attribute.
	_ANDROID_SDK = dict(
	_android_sdk = attr.label(
	allow_rules = ["android_sdk"],
	default = configuration_field(
	fragment = "android",
	name = "android_sdk_label",
	),
	providers = [AndroidSdkInfo],
	),
	)

	# Compilation attributes for Android rules.
	_COMPILATION = _add(
	dict(
	assets = attr.label_list(
	allow_files = True,
	cfg = "target",
	doc = ("The list of assets to be packaged. This is typically a glob of " +
	"all files under the assets directory. You can also reference " +
	"other rules (any rule that produces files) or exported files in " +
	"the other packages, as long as all those files are under the " +
	"assets_dir directory in the corresponding package."),
	),
	assets_dir = attr.string(
	doc = ("The string giving the path to the files in assets. " +
	"The pair assets and assets_dir describe packaged assets and either both " +
	"attributes should be provided or none of them."),
	),
	custom_package = attr.string(
	doc = ("Java package for which java sources will be generated. " +
	"By default the package is inferred from the directory where the BUILD file " +
	"containing the rule is. You can specify a different package but this is " +
	"highly discouraged since it can introduce classpath conflicts with other " +
	"libraries that will only be detected at runtime."),
	),
	manifest = attr.label(
	allow_single_file = [".xml"],
	doc = ("The name of the Android manifest file, normally " +
	"AndroidManifest.xml. Must be defined if resource_files or assets are defined."),
	),
	resource_files = attr.label_list(
	allow_files = True,
	doc = ("The list of resources to be packaged. This " +
	"is typically a glob of all files under the res directory. Generated files " +
	"(from genrules) can be referenced by Label here as well. The only " +
	"restriction is that the generated outputs must be under the same \"res\" " +
	"directory as any other resource files that are included."),
	),
	data = attr.label_list(
	allow_files = True,
	),
	plugins = attr.label_list(
	providers = [JavaPluginInfo],
	cfg = "host",
	),
	javacopts = attr.string_list(),
	# TODO: Expose getPlugins() in JavaConfiguration.java
	# com/google/devtools/build/lib/rules/java/JavaConfiguration.java
	# com/google/devtools/build/lib/rules/java/JavaOptions.java
	#
	# _java_plugins = attr.label(
	# allow_rules = ["java_plugin"],
	# default = configuration_field(
	# fragment = "java",
	# name = "plugin",
	# ),
	# ),
	),
	_JAVA_RUNTIME,
	)

	# Attributes for rules that use the AndroidDataContext android_data.make_context
	_DATA_CONTEXT = _add(
	dict(
	# Additional attrs needed for AndroidDataContext
	_add_g3itr_xslt = attr.label(
	cfg = "host",
	default = Label("//tools/android/xslt:add_g3itr.xslt"),
	allow_single_file = True,
	),
	_android_manifest_merge_tool = attr.label(
	cfg = "host",
	default = Label("//tools/android:merge_manifests"),
	executable = True,
	),
	# TODO(b/145617058) Switching back to head RPBB until the Android rules release process is improved
	_android_resources_busybox = attr.label(
	cfg = "host",
	default = Label("@rules_android//rules:ResourceProcessorBusyBox"),
	executable = True,
	),
	_xsltproc_tool = attr.label(
	cfg = "host",
	default = Label("//tools/android/xslt:xslt"),
	allow_files = True,
	),
	),
	_ANDROID_SDK,
	)







	ANDROID_SDK_ATTRS = dict(
	aapt = attr.label(
	allow_single_file = True,
	cfg = "host",
	executable = True,
	mandatory = True,
	),
	aapt2 = attr.label(
	allow_single_file = True,
	cfg = "host",
	executable = True,
	),
	aidl = attr.label(
	allow_files = True,
	cfg = "host",
	executable = True,
	mandatory = True,
	),
	aidl_lib = attr.label(
	allow_files = [".jar"],
	),
	android_jar = attr.label(
	allow_single_file = [".jar"],
	cfg = "host",
	mandatory = True,
	),
	annotations_jar = attr.label(
	allow_single_file = [".jar"],
	cfg = "host",
	),
	apkbuilder = attr.label(
	allow_files = True,
	cfg = "host",
	executable = True,
	),
	apksigner = attr.label(
	allow_files = True,
	cfg = "host",
	executable = True,
	mandatory = True,
	),
	adb = attr.label(
	allow_single_file = True,
	cfg = "host",
	executable = True,
	mandatory = True,
	),
	build_tools_version = attr.string(),
	dx = attr.label(
	allow_files = True,
	cfg = "host",
	executable = True,
	mandatory = True,
	),
	framework_aidl = attr.label(
	allow_single_file = True,
	cfg = "host",
	mandatory = True,
	),
	legacy_main_dex_list_generator = attr.label(
	allow_files = True,
	cfg = "host",
	executable = True,
	),
	main_dex_classes = attr.label(
	allow_single_file = True,
	cfg = "host",
	mandatory = True,
	),
	main_dex_list_creator = attr.label(
	allow_files = True,
	cfg = "host",
	executable = True,
	mandatory = True,
	),
	proguard = attr.label(
	allow_files = True,
	cfg = "host",
	executable = True,
	mandatory = True,
	),
	shrinked_android_jar = attr.label(
	allow_single_file = True,
	cfg = "host",
	),
	source_properties = attr.label(
	allow_single_file = True,
	cfg = "host",
	),
	zipalign = attr.label(
	allow_single_file = True,
	cfg = "host",
	executable = True,
	mandatory = True,
	),
	_proguard = attr.label(
	cfg = "host",
	default = configuration_field(
	fragment = "java",
	name = "proguard_top",
	),
	),
	_system = attr.label(
	default = Label("//tools/android:bootclasspath_android_only"),
	),
	)

	ANDROID_TOOLS_DEFAULTS_JAR_ATTRS = _add(_ANDROID_SDK)

	attrs = struct(
	ANDROID_SDK = _ANDROID_SDK,
	COMPILATION = _COMPILATION,
	DATA_CONTEXT = _DATA_CONTEXT,
	JAVA_RUNTIME = _JAVA_RUNTIME,
	tristate = _tristate,
	add = _add,
	replace = _replace,
	)