[databinding] Fix databinding templates and resources for AndroidX

This adds a flag for AndroidX and wires it through to the processing
steps. Additionally, the shell command run to fix databinding compiled
resources was not cross-platform:

* BSD `head` won't take a negative int as its argument (GNU does).
    The better way to accomplish this goal here (listing all files in
    the archive) is just to use `zipinfo(1)`. `zipinfo -1` shows in its
    man page to be intended for exactly this purpose.
* BSD `sed` requires passsing an argument to the `-i` flag for a file
    extension to use when writing a back-up. A file without a back-up
    must be explicitly signaled by using an empty argument, i.e.
    `sed -i '' file`. However, a spaced argument to `-i` on GNU sed is
    interpreted as the next positional argument to `sed`, which is an
    error. The only cross-platform way to accomplish this appears to be
    to combine it into one like `-i.bak`. This then needs to be removed.
    (From [StackOverflow](https://stackoverflow.com/a/22084103/1819790))
* Using `sed` to change a string in an otherwise binary file may require
    changing the localization variables. At least, it does on standard
    BSD/macOS: otherwise, `sed` assumes files are encoded as text, and
    the class files contain invalid bytes. `LC_ALL` overrides all
    categories not set.

Author: pswaminathan

.bazelrc

@@ -1 +1,2 @@
-common --java_runtime_version=17
+common --java_runtime_version=remotejdk_17
+common --tool_java_runtime_version=remotejdk_17

rules/BUILD

@@ -3,7 +3,8 @@ load("@bazel_skylib//rules:common_settings.bzl", "int_setting")
 load("@rules_java//java:defs.bzl", "java_library")
 
 exports_files([
-    "data_binding_annotation_template.txt",
+    "data_binding_annotation_template_androidx.txt",
+    "data_binding_annotation_template_support_lib.txt",
     "res_v3_dummy_AndroidManifest.xml",
     "res_v3_dummy_R.txt",
     "robolectric_properties_template.txt",

rules/android_binary/attrs.bzl

@@ -247,6 +247,9 @@ ATTRS = _attrs.replace(
                 Allow for the optimizer to process resources. This is not supported in proguard.
                 """,
             ),
+            _databinding_use_androidx = attr.label(
+                default = "//rules/flags:databinding_use_androidx",
+            ),
         ),
         _attrs.compilation_attributes(apply_android_transition = True),
         _attrs.DATA_CONTEXT,

rules/android_binary/impl.bzl

@@ -188,6 +188,13 @@ def _process_proto(_unused_ctx, **_unused_ctxs):
 def _process_data_binding(ctx, java_package, packaged_resources_ctx, **_unused_ctxs):
     if ctx.attr.enable_data_binding and not acls.in_databinding_allowed(str(ctx.label)):
         fail("This target is not allowed to use databinding and enable_data_binding is True.")
+
+    if ctx.attr._databinding_use_androidx[BuildSettingInfo].value:
+        template = get_android_toolchain(ctx).data_binding_annotation_template_androidx
+    else:
+        template = get_android_toolchain(ctx).data_binding_annotation_template_support_lib
+    data_binding_annotation_template = utils.only(template.files.to_list())
+
     return ProviderInfo(
         name = "db_ctx",
         value = data_binding.process(
@@ -201,8 +208,7 @@ def _process_data_binding(ctx, java_package, packaged_resources_ctx, **_unused_c
             data_binding_exec = get_android_toolchain(ctx).data_binding_exec.files_to_run,
             data_binding_annotation_processor =
                 get_android_toolchain(ctx).data_binding_annotation_processor[JavaPluginInfo],
-            data_binding_annotation_template =
-                utils.only(get_android_toolchain(ctx).data_binding_annotation_template.files.to_list()),
+            data_binding_annotation_template = data_binding_annotation_template,
         ),
     )
 

rules/android_library/attrs.bzl

@@ -243,6 +243,9 @@ ATTRS = _attrs.add(
         _aidl_lib = attr.label(
             default = Label("//rules:aidl_lib"),
         ),
+        _databinding_use_androidx = attr.label(
+            default = "//rules/flags:databinding_use_androidx",
+        ),
     ),
     _attrs.compilation_attributes(),
     _attrs.DATA_CONTEXT,

rules/android_library/impl.bzl

@@ -31,6 +31,7 @@ load("//rules:resources.bzl", _resources = "resources")
 load("//rules:utils.bzl", "get_android_sdk", "get_android_toolchain", "log", "utils")
 load("//rules:visibility.bzl", "PROJECT_VISIBILITY")
 load("//rules/flags:flags.bzl", _flags = "flags")
+load("@bazel_skylib//rules:common_settings.bzl", "BuildSettingInfo")
 load("@rules_java//java/common:java_info.bzl", "JavaInfo")
 load("@rules_java//java/common:java_plugin_info.bzl", "JavaPluginInfo")
 load("@rules_java//java/common:proguard_spec_info.bzl", "ProguardSpecInfo")
@@ -234,6 +235,13 @@ def _process_idl(ctx, **unused_sub_ctxs):
 def _process_data_binding(ctx, java_package, resources_ctx, **unused_sub_ctxs):
     if ctx.attr.enable_data_binding and not acls.in_databinding_allowed(str(ctx.label)):
         fail("This target is not allowed to use databinding and enable_data_binding is True.")
+
+    if ctx.attr._databinding_use_androidx[BuildSettingInfo].value:
+        template = get_android_toolchain(ctx).data_binding_annotation_template_androidx
+    else:
+        template = get_android_toolchain(ctx).data_binding_annotation_template_support_lib
+    data_binding_annotation_template = utils.only(template.files.to_list())
+
     return ProviderInfo(
         name = "db_ctx",
         value = _data_binding.process(
@@ -247,8 +255,7 @@ def _process_data_binding(ctx, java_package, resources_ctx, **unused_sub_ctxs):
             data_binding_exec = get_android_toolchain(ctx).data_binding_exec.files_to_run,
             data_binding_annotation_processor =
                 get_android_toolchain(ctx).data_binding_annotation_processor,
-            data_binding_annotation_template =
-                utils.only(get_android_toolchain(ctx).data_binding_annotation_template.files.to_list()),
+            data_binding_annotation_template = data_binding_annotation_template,
         ),
     )
 

rules/busybox.bzl

@@ -13,6 +13,7 @@
 # limitations under the License.
 """Bazel ResourcesBusyBox Commands."""
 
+load("@bazel_skylib//rules:common_settings.bzl", "BuildSettingInfo")
 load("//rules:visibility.bzl", "PROJECT_VISIBILITY")
 load(":java.bzl", _java = "java")
 
@@ -978,6 +979,7 @@ def _process_databinding(
     args.add_all(res_dirs, before_each = "--resource_root")
     args.add("--dataBindingInfoOut", out_databinding_info)
     args.add("--appId", java_package)
+    args.add("--useDataBindingAndroidX", ctx.attr._databinding_use_androidx[BuildSettingInfo].value)
 
     _set_warning_level(ctx, args)
 

rules/data_binding.bzl

@@ -13,6 +13,7 @@
 # limitations under the License.
 """Bazel Android Data Binding."""
 
+load("@bazel_skylib//rules:common_settings.bzl", "BuildSettingInfo")
 load("//providers:providers.bzl", "DataBindingV2Info")
 load("//rules:visibility.bzl", "PROJECT_VISIBILITY")
 load(":utils.bzl", "ANDROID_TOOLCHAIN_TYPE", _utils = "utils")
@@ -67,7 +68,7 @@ def _gen_sources(ctx, output_dir, java_package, deps, layout_info, data_binding_
     args.add("-classInfoOut", class_info)
     args.add("-sourceOut", srcjar)
     args.add("-zipSourceOutput", "true")
-    args.add("-useAndroidX", "false")
+    args.add("-useAndroidX", ctx.attr._databinding_use_androidx[BuildSettingInfo].value)
 
     if deps:
         if type(deps[0].class_infos) == "depset":
@@ -260,11 +261,11 @@ def _process(
     if defines_resources:
         # Outputs of the Data Binding annotation processor.
         br_out = ctx.actions.declare_file(
-            output_dir + "bin-files/%s-br.bin" % java_package,
+            output_dir + "bin-files/%s--br.bin" % java_package,
         )
         db_info[_JAVA_ANNOTATION_PROCESSOR_ADDITIONAL_OUTPUTS].append(br_out)
         setter_store_out = ctx.actions.declare_file(
-            output_dir + "bin-files/%s-setter_store.json" % java_package,
+            output_dir + "bin-files/%s--setter_store.json" % java_package,
         )
         db_info[_JAVA_ANNOTATION_PROCESSOR_ADDITIONAL_OUTPUTS].append(
             setter_store_out,

rules/data_binding_annotation_template_androidx.txt

@@ -0,0 +1,13 @@
+package android.databinding.layouts;
+
+import androidx.databinding.BindingBuildInfo;
+
+/**
+ * Template for the file that feeds data binding's annotation processor. The
+ * processor reads the values set here to generate .java files that link XML
+ * data binding declarations (from layoutInfoDir) to app code.
+ */
+@BindingBuildInfo
+public class DataBindingInfo {
+  /* This only exists for annotation processing. */
+}