support processing string catalogs (xcstrings) (#2645)

Author: aaronsky

apple/internal/BUILD

@@ -493,6 +493,7 @@ bzl_library(
         "//apple/internal/resource_actions:plist",
         "//apple/internal/resource_actions:png",
         "//apple/internal/resource_actions:texture_atlas",
+        "//apple/internal/resource_actions:xcstrings",
     ],
 )
 

apple/internal/aspects/resource_aspect.bzl

@@ -305,7 +305,7 @@ def _apple_resource_aspect_impl(target, ctx):
             # Avoid processing PNG files that are referenced through the structured_resources
             # attribute. This is mostly for legacy reasons and should get cleaned up in the future.
             bucketized_owners, unowned_resources, buckets = resources.bucketize_data(
-                allowed_buckets = ["strings", "plists"],
+                allowed_buckets = ["strings", "plists", "xcstrings"],
                 owner = owner,
                 parent_dir_param = structured_parent_dir_param,
                 resources = structured_files,

apple/internal/partials/support/resources_support.bzl

@@ -774,6 +774,43 @@ def _xibs(
         processed_origins = processed_origins,
     )
 
+def _xcstrings(
+        *,
+        actions,
+        apple_mac_toolchain_info,
+        files,
+        output_discriminator,
+        parent_dir,
+        platform_prerequisites,
+        rule_label,
+        **_kwargs):
+    """Process xcstrings files."""
+    lproj_files = []
+    processed_origins = {}
+    for file in files.to_list():
+        basename = paths.replace_extension(file.basename, "")
+        out_path = paths.join("xcstrings", parent_dir or "", basename)
+        out_dir = intermediates.directory(
+            actions = actions,
+            target_name = rule_label.name,
+            output_discriminator = output_discriminator,
+            dir_name = out_path,
+        )
+        processed_origins[out_dir.short_path] = [file.short_path]
+        resource_actions.compile_xcstrings(
+            actions = actions,
+            input_file = file,
+            output_dir = out_dir,
+            platform_prerequisites = platform_prerequisites,
+            xctoolrunner = apple_mac_toolchain_info.xctoolrunner,
+        )
+        lproj_files.append(out_dir)
+
+    return struct(
+        files = [(processor.location.resource, parent_dir, depset(lproj_files))],
+        processed_origins = processed_origins,
+    )
+
 def _noop(
         *,
         parent_dir,
@@ -834,5 +871,6 @@ PROVIDER_TO_FIELD_ACTION = {
     "strings": (_plists_and_strings, False),
     "texture_atlases": (_texture_atlases, False),
     "unprocessed": (_noop, False),
+    "xcstrings": (_xcstrings, False),
     "xibs": (_xibs, True),
 }

apple/internal/providers.bzl

@@ -441,6 +441,7 @@ Xcode 26+.""",
         "strings": "Localization strings files.",
         "texture_atlases": "Texture atlas files.",
         "unprocessed": "Generic resources not mapped to the other types.",
+        "xcstrings": "String catalog files.",
         "xibs": "XIB Interface files.",
         "owners": """`depset` of (resource, owner) pairs.""",
         "processed_origins": """`depset` of (processed resource, resource list) pairs.""",

apple/internal/resource_actions.bzl

@@ -58,6 +58,10 @@ load(
     "//apple/internal/resource_actions:texture_atlas.bzl",
     _compile_texture_atlas = "compile_texture_atlas",
 )
+load(
+    "//apple/internal/resource_actions:xcstrings.bzl",
+    _compile_xcstrings = "compile_xcstrings",
+)
 
 resource_actions = struct(
     compile_asset_catalog = _compile_asset_catalog,
@@ -68,6 +72,7 @@ resource_actions = struct(
     compile_plist = _compile_plist,
     compile_storyboard = _compile_storyboard,
     compile_texture_atlas = _compile_texture_atlas,
+    compile_xcstrings = _compile_xcstrings,
     compile_xib = _compile_xib,
     copy_png = _copy_png,
     generate_datamodels = _generate_datamodels,

apple/internal/resource_actions/BUILD

@@ -135,6 +135,18 @@ bzl_library(
     ],
 )
 
+bzl_library(
+    name = "xcstrings",
+    srcs = ["xcstrings.bzl"],
+    visibility = [
+        "//apple/internal:__pkg__",
+    ],
+    deps = [
+        "//apple/internal/utils:xctoolrunner",
+        "@build_bazel_apple_support//lib:apple_support",
+    ],
+)
+
 # Consumed by bazel tests.
 filegroup(
     name = "for_bazel_tests",

apple/internal/resource_actions/xcstrings.bzl

@@ -0,0 +1,36 @@
+"""xcstrings related actions."""
+
+load(
+    "@build_bazel_apple_support//lib:apple_support.bzl",
+    "apple_support",
+)
+load(
+    "//apple/internal/utils:xctoolrunner.bzl",
+    xctoolrunner_support = "xctoolrunner",
+)
+
+def compile_xcstrings(
+        *,
+        actions,
+        input_file,
+        output_dir,
+        platform_prerequisites,
+        xctoolrunner):
+    args = [
+        "xcstringstool",
+        "compile",
+        "--output-directory",
+        xctoolrunner_support.prefixed_path(output_dir.path),
+        xctoolrunner_support.prefixed_path(input_file.path),
+    ]
+
+    apple_support.run(
+        actions = actions,
+        apple_fragment = platform_prerequisites.apple_fragment,
+        arguments = args,
+        executable = xctoolrunner,
+        inputs = [input_file],
+        mnemonic = "CompileXCStrings",
+        outputs = [output_dir],
+        xcode_config = platform_prerequisites.xcode_version_config,
+    )

apple/internal/resource_rules/apple_precompiled_resource_bundle.bzl

@@ -169,6 +169,7 @@ def _apple_precompiled_resource_bundle_impl(ctx):
                     "storyboards",
                     "strings",
                     "texture_atlases",
+                    "xcstrings",
                     "xibs",
                 ],
                 unowned_resources = unowned_resources,

apple/internal/resources.bzl

@@ -250,6 +250,8 @@ def _bucketize_data(
                 bucket_name = "framework"
             elif resource_short_path.endswith(".strings") or resource_short_path.endswith(".stringsdict"):
                 bucket_name = "strings"
+            elif resource_short_path.endswith(".xcstrings"):
+                bucket_name = "xcstrings"
             elif resource_short_path.endswith(".storyboard"):
                 bucket_name = "storyboards"
                 resource_swift_module = swift_module

doc/providers.md

@@ -500,6 +500,7 @@ Provider that propagates buckets of resources that are differentiated by type.
 | <a id="AppleResourceInfo-strings"></a>strings |  Localization strings files.    |
 | <a id="AppleResourceInfo-texture_atlases"></a>texture_atlases |  Texture atlas files.    |
 | <a id="AppleResourceInfo-unprocessed"></a>unprocessed |  Generic resources not mapped to the other types.    |
+| <a id="AppleResourceInfo-xcstrings"></a>xcstrings |  String catalog files.    |
 | <a id="AppleResourceInfo-xibs"></a>xibs |  XIB Interface files.    |
 | <a id="AppleResourceInfo-owners"></a>owners |  `depset` of (resource, owner) pairs.    |
 | <a id="AppleResourceInfo-processed_origins"></a>processed_origins |  `depset` of (processed resource, resource list) pairs.    |