-
Notifications
You must be signed in to change notification settings - Fork 276
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add
apple_precompiled_resource_bundle (#2504)
Fixes #319 --------- Co-authored-by: Brentley Jones <[email protected]>
- Loading branch information
1 parent
ab29ef8
commit 0309ba6
Showing
12 changed files
with
765 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd"> | ||
| <plist version="1.0"> | ||
| <dict> | ||
| <key>CFBundleName</key> | ||
| <string>$(BUNDLE_NAME)</string> | ||
| <key>CFBundleVersion</key> | ||
| <string>1</string> | ||
| <key>CFBundleShortVersionString</key> | ||
| <string>1.0</string> | ||
| <key>CFBundleIdentifier</key> | ||
| <string>$(PRODUCT_BUNDLE_IDENTIFIER)</string> | ||
| <key>CFBundlePackageType</key> | ||
| <string>BNDL</string> | ||
| </dict> | ||
| </plist> |
273 changes: 273 additions & 0 deletions
273
apple/internal/resource_rules/apple_precompiled_resource_bundle.bzl
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,273 @@ | ||
| # Copyright 2024 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. | ||
|
|
||
| """Implementation of apple_precompiled_resource_bundle rule.""" | ||
|
|
||
| load( | ||
| "@bazel_skylib//lib:dicts.bzl", | ||
| "dicts", | ||
| ) | ||
| load( | ||
| "@bazel_skylib//lib:partial.bzl", | ||
| "partial", | ||
| ) | ||
| load( | ||
| "@build_bazel_rules_apple//apple/internal:apple_toolchains.bzl", | ||
| "AppleMacToolsToolchainInfo", | ||
| "AppleXPlatToolsToolchainInfo", | ||
| ) | ||
| load( | ||
| "@build_bazel_rules_apple//apple/internal:features_support.bzl", | ||
| "features_support", | ||
| ) | ||
| load( | ||
| "@build_bazel_rules_apple//apple/internal:platform_support.bzl", | ||
| "platform_support", | ||
| ) | ||
| load( | ||
| "@build_bazel_rules_apple//apple/internal:resources.bzl", | ||
| "resources", | ||
| ) | ||
| load( | ||
| "@build_bazel_rules_apple//apple/internal:rule_attrs.bzl", | ||
| "rule_attrs", | ||
| ) | ||
| load( | ||
| "@build_bazel_rules_apple//apple/internal:rule_support.bzl", | ||
| "rule_support", | ||
| ) | ||
| load( | ||
| "//apple/internal:apple_product_type.bzl", | ||
| "apple_product_type", | ||
| ) | ||
|
|
||
| def _apple_precompiled_resource_bundle_impl(ctx): | ||
| # Owner to attach to the resources as they're being bucketed. | ||
| owner = str(ctx.label) | ||
| bucketize_args = {} | ||
|
|
||
| rule_descriptor = rule_support.rule_descriptor( | ||
| platform_type = str(ctx.fragments.apple.single_arch_platform.platform_type), | ||
| product_type = apple_product_type.application, | ||
| ) | ||
|
|
||
| features = features_support.compute_enabled_features( | ||
| requested_features = ctx.features, | ||
| unsupported_features = ctx.disabled_features, | ||
| ) | ||
|
|
||
| apple_xplat_toolchain_info = ctx.attr._xplat_toolchain[AppleXPlatToolsToolchainInfo] | ||
|
|
||
| platform_prerequisites = platform_support.platform_prerequisites( | ||
| apple_fragment = ctx.fragments.apple, | ||
| build_settings = apple_xplat_toolchain_info.build_settings, | ||
| config_vars = ctx.var, | ||
| cpp_fragment = ctx.fragments.cpp, | ||
| device_families = rule_descriptor.allowed_device_families, | ||
| explicit_minimum_deployment_os = None, | ||
| explicit_minimum_os = None, | ||
| features = features, | ||
| objc_fragment = ctx.fragments.objc, | ||
| platform_type_string = str(ctx.fragments.apple.single_arch_platform.platform_type), | ||
| uses_swift = False, | ||
| xcode_version_config = ctx.attr._xcode_config[apple_common.XcodeVersionConfig], | ||
| ) | ||
|
|
||
| bundle_name = "{}.bundle".format(ctx.attr.bundle_name or ctx.label.name) | ||
| bundle_id = ctx.attr.bundle_id or "com.bazel.apple_precompiled_resource_bundle_".format(ctx.attr.bundle_name or ctx.label.name) | ||
|
|
||
| apple_resource_infos = [] | ||
| process_args = { | ||
| "actions": ctx.actions, | ||
| "apple_mac_toolchain_info": ctx.attr._mac_toolchain[AppleMacToolsToolchainInfo], | ||
| "bundle_id": bundle_id, | ||
| "product_type": rule_descriptor.product_type, | ||
| "rule_label": ctx.label, | ||
| } | ||
|
|
||
| resource_files = resources.collect( | ||
| attr = ctx.attr, | ||
| res_attrs = ["resources"], | ||
| ) | ||
|
|
||
| if resource_files: | ||
| bucketized_owners, unowned_resources, buckets = resources.bucketize_data( | ||
| resources = resource_files, | ||
| owner = owner, | ||
| parent_dir_param = bundle_name, | ||
| **bucketize_args | ||
| ) | ||
| apple_resource_infos.append( | ||
| resources.process_bucketized_data( | ||
| bucketized_owners = bucketized_owners, | ||
| buckets = buckets, | ||
| platform_prerequisites = platform_prerequisites, | ||
| processing_owner = owner, | ||
| unowned_resources = unowned_resources, | ||
| **process_args | ||
| ), | ||
| ) | ||
|
|
||
| structured_files = resources.collect( | ||
| attr = ctx.attr, | ||
| res_attrs = ["structured_resources"], | ||
| ) | ||
| if structured_files: | ||
| if bundle_name: | ||
| structured_parent_dir_param = partial.make( | ||
| resources.structured_resources_parent_dir, | ||
| parent_dir = bundle_name, | ||
| ) | ||
| else: | ||
| structured_parent_dir_param = partial.make( | ||
| resources.structured_resources_parent_dir, | ||
| ) | ||
|
|
||
| # 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"], | ||
| owner = owner, | ||
| parent_dir_param = structured_parent_dir_param, | ||
| resources = structured_files, | ||
| **bucketize_args | ||
| ) | ||
| apple_resource_infos.append( | ||
| resources.process_bucketized_data( | ||
| bucketized_owners = bucketized_owners, | ||
| buckets = buckets, | ||
| platform_prerequisites = platform_prerequisites, | ||
| processing_owner = owner, | ||
| unowned_resources = unowned_resources, | ||
| **process_args | ||
| ), | ||
| ) | ||
|
|
||
| infoplists = resources.collect( | ||
| attr = ctx.attr, | ||
| res_attrs = ["infoplists", "_fallback_infoplist"], | ||
| ) | ||
|
|
||
| if infoplists and apple_resource_infos: | ||
| bucketized_owners, unowned_resources, buckets = resources.bucketize_typed_data( | ||
| bucket_type = "infoplists", | ||
| owner = owner, | ||
| parent_dir_param = bundle_name, | ||
| resources = infoplists, | ||
| **bucketize_args | ||
| ) | ||
| apple_resource_infos.append( | ||
| resources.process_bucketized_data( | ||
| bucketized_owners = bucketized_owners, | ||
| buckets = buckets, | ||
| platform_prerequisites = platform_prerequisites, | ||
| processing_owner = owner, | ||
| unowned_resources = unowned_resources, | ||
| **process_args | ||
| ), | ||
| ) | ||
|
|
||
| providers = [] | ||
| if apple_resource_infos: | ||
| # If any providers were collected, merge them. | ||
| providers.append( | ||
| resources.merge_providers( | ||
| default_owner = owner, | ||
| providers = apple_resource_infos, | ||
| ), | ||
| ) | ||
|
|
||
| return providers | ||
|
|
||
| apple_precompiled_resource_bundle = rule( | ||
| implementation = _apple_precompiled_resource_bundle_impl, | ||
| fragments = ["apple", "cpp", "objc"], | ||
| attrs = dicts.add( | ||
| { | ||
| "bundle_id": attr.string( | ||
| doc = """ | ||
| The bundle ID for this target. It will replace `$(PRODUCT_BUNDLE_IDENTIFIER)` found in the files | ||
| from defined in the `infoplists` paramter. | ||
| """, | ||
| ), | ||
| "bundle_name": attr.string( | ||
| doc = """ | ||
| The desired name of the bundle (without the `.bundle` extension). If this attribute is not set, | ||
| then the `name` of the target will be used instead. | ||
| """, | ||
| ), | ||
| "infoplists": attr.label_list( | ||
| allow_empty = True, | ||
| allow_files = True, | ||
| doc = """ | ||
| A list of `.plist` files that will be merged to form the `Info.plist` that represents the extension. | ||
| At least one file must be specified. | ||
| Please see [Info.plist Handling](/doc/common_info.md#infoplist-handling") for what is supported. | ||
| Duplicate keys between infoplist files | ||
| will cause an error if and only if the values conflict. | ||
| Bazel will perform variable substitution on the Info.plist file for the following values (if they | ||
| are strings in the top-level dict of the plist): | ||
| ${BUNDLE_NAME}: This target's name and bundle suffix (.bundle or .app) in the form name.suffix. | ||
| ${PRODUCT_NAME}: This target's name. | ||
| ${TARGET_NAME}: This target's name. | ||
| The key in ${} may be suffixed with :rfc1034identifier (for example | ||
| ${PRODUCT_NAME::rfc1034identifier}) in which case Bazel will replicate Xcode's behavior and replace | ||
| non-RFC1034-compliant characters with -. | ||
| """, | ||
| ), | ||
| "resources": attr.label_list( | ||
| allow_empty = True, | ||
| allow_files = True, | ||
| doc = """ | ||
| Files to include in the resource bundle. Files that are processable resources, like .xib, | ||
| .storyboard, .strings, .png, and others, will be processed by the Apple bundling rules that have | ||
| those files as dependencies. Other file types that are not processed will be copied verbatim. These | ||
| files are placed in the root of the resource bundle (e.g. `Payload/foo.app/bar.bundle/...`) in most | ||
| cases. However, if they appear to be localized (i.e. are contained in a directory called *.lproj), | ||
| they will be placed in a directory of the same name in the app bundle. | ||
| You can also add other `apple_precompiled_resource_bundle` and `apple_bundle_import` targets into `resources`, | ||
| and the resource bundle structures will be propagated into the final bundle. | ||
| """, | ||
| ), | ||
| "structured_resources": attr.label_list( | ||
| allow_empty = True, | ||
| allow_files = True, | ||
| doc = """ | ||
| Files to include in the final resource bundle. They are not processed or compiled in any way | ||
| besides the processing done by the rules that actually generate them. These files are placed in the | ||
| bundle root in the same structure passed to this argument, so `["res/foo.png"]` will end up in | ||
| `res/foo.png` inside the bundle. | ||
| """, | ||
| ), | ||
| "_environment_plist": attr.label( | ||
| allow_single_file = True, | ||
| default = "@build_bazel_rules_apple//apple/internal:environment_plist_ios", | ||
| ), | ||
| "_fallback_infoplist": attr.label( | ||
| allow_single_file = True, | ||
| default = "@build_bazel_rules_apple//apple/internal/resource_rules:Info.plist", | ||
| ), | ||
| }, | ||
| rule_attrs.common_tool_attrs(), | ||
| ), | ||
| doc = """ | ||
| This rule encapsulates a target which is provided to dependers as a bundle. An | ||
| `apple_precompiled_resource_bundle`'s resources are put in a resource bundle in the top | ||
| level Apple bundle dependent. `apple_precompiled_resource_bundle` targets need to be added to | ||
| library targets through the `data` attribute. | ||
| """, | ||
| ) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.