Add support for XCFrameworks #9334
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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,244 @@ | ||
| require 'cocoapods/xcode' | ||
|
|
||
| module Pod | ||
| module Generator | ||
| class PrepareArtifactsScript | ||
| # @return [Hash{String => Array<Pod::Xcode::XCFramework>}] Multiple lists of xcframeworks per | ||
| # configuration. | ||
| # | ||
| attr_reader :xcframeworks_by_config | ||
|
|
||
| # @return [Pathname] the root directory of the sandbox | ||
| # | ||
| attr_reader :sandbox_root | ||
|
|
||
| # @return [Platform] the platform of the target for which this script will run | ||
| # | ||
| attr_reader :platform | ||
|
|
||
| # @param [Hash{String => Array<Pod::Xcode::XCFramework>] xcframeworks_by_config | ||
| # @see #xcframeworks_by_config | ||
| # | ||
| # @param [Pathname] sandbox_root | ||
| # the sandbox root of the installation | ||
| # | ||
| # @param [Platform] platform | ||
| # the platform of the target for which this script will run | ||
| # | ||
| def initialize(xcframeworks_by_config, sandbox_root, platform) | ||
| @xcframeworks_by_config = xcframeworks_by_config | ||
|
There was a problem hiding this comment. the class name is There was a problem hiding this comment. I initially named it something like that but renamed it since this could be used to copy any artifact that needs to be in the build folder before the |
||
| @sandbox_root = sandbox_root | ||
| @platform = platform | ||
| end | ||
|
|
||
| # Saves the resource script to the given pathname. | ||
| # | ||
| # @param [Pathname] pathname | ||
| # The path where the embed frameworks script should be saved. | ||
| # | ||
| # @return [void] | ||
| # | ||
| def save_as(pathname) | ||
| pathname.open('w') do |file| | ||
| file.puts(script) | ||
| end | ||
| File.chmod(0o755, pathname.to_s) | ||
| end | ||
|
|
||
| # @return [String] The contents of the embed frameworks script. | ||
| # | ||
| def generate | ||
| script | ||
| end | ||
|
|
||
| private | ||
|
|
||
| # @!group Private Helpers | ||
|
|
||
| # @return [String] The contents of the prepare artifacts script. | ||
| # | ||
| def script | ||
| script = <<-SH.strip_heredoc | ||
| #!/bin/sh | ||
| set -e | ||
| set -u | ||
| set -o pipefail | ||
|
|
||
| function on_error { | ||
| echo "$(realpath -mq "${0}"):$1: error: Unexpected failure" | ||
| } | ||
| trap 'on_error $LINENO' ERR | ||
|
|
||
| if [ -z ${FRAMEWORKS_FOLDER_PATH+x} ]; then | ||
| # If FRAMEWORKS_FOLDER_PATH is not set, then there's nowhere for us to copy | ||
| # frameworks to, so exit 0 (signalling the script phase was successful). | ||
| exit 0 | ||
| fi | ||
|
|
||
| # This protects against multiple targets copying the same framework dependency at the same time. The solution | ||
| # was originally proposed here: https://lists.samba.org/archive/rsync/2008-February/020158.html | ||
| RSYNC_PROTECT_TMP_FILES=(--filter "P .*.??????") | ||
|
|
||
| ARTIFACT_LIST_FILE="${BUILT_PRODUCTS_DIR}/cocoapods-artifacts-${CONFIGURATION}.txt" | ||
| cat > $ARTIFACT_LIST_FILE | ||
|
|
||
| BCSYMBOLMAP_DIR="BCSymbolMaps" | ||
|
|
||
| record_artifact() | ||
| { | ||
| echo "$1" >> $ARTIFACT_LIST_FILE | ||
| } | ||
|
|
||
| install_artifact() | ||
| { | ||
| local source="$1" | ||
| local destination="$2" | ||
| local record=${3:-false} | ||
|
|
||
| # Use filter instead of exclude so missing patterns don't throw errors. | ||
| echo "rsync --delete -av "${RSYNC_PROTECT_TMP_FILES[@]}" --links --filter \\"- CVS/\\" --filter \\"- .svn/\\" --filter \\"- .git/\\" --filter \\"- .hg/\\" \\"${source}\\" \\"${destination}\\"" | ||
| rsync --delete -av "${RSYNC_PROTECT_TMP_FILES[@]}" --links --filter "- CVS/" --filter "- .svn/" --filter "- .git/" --filter "- .hg/" "${source}" "${destination}" | ||
|
|
||
| if [[ "$record" == "true" ]]; then | ||
| artifact="${destination}/$(basename "$source")" | ||
| record_artifact "$artifact" | ||
| fi | ||
| } | ||
|
|
||
| # Copies a framework to derived data for use in later build phases | ||
| install_framework() | ||
| { | ||
| if [ -r "${BUILT_PRODUCTS_DIR}/$1" ]; then | ||
| local source="${BUILT_PRODUCTS_DIR}/$1" | ||
| elif [ -r "${BUILT_PRODUCTS_DIR}/$(basename "$1")" ]; then | ||
| local source="${BUILT_PRODUCTS_DIR}/$(basename "$1")" | ||
| elif [ -r "$1" ]; then | ||
| local source="$1" | ||
| fi | ||
|
|
||
| local record_artifact=${2:-true} | ||
| local destination="${TARGET_BUILD_DIR}" | ||
|
|
||
| if [ -L "${source}" ]; then | ||
| echo "Symlinked..." | ||
| source="$(readlink "${source}")" | ||
| fi | ||
|
|
||
| install_artifact "$source" "$destination" "$record_artifact" | ||
|
|
||
| if [ -d "${source}/${BCSYMBOLMAP_DIR}" ]; then | ||
| # Locate and install any .bcsymbolmaps if present | ||
| find "${source}/${BCSYMBOLMAP_DIR}/" -name "*.bcsymbolmap"|while read f; do | ||
| install_artifact "$f" "$destination" "true" | ||
| done | ||
| fi | ||
| } | ||
|
|
||
| install_xcframework() { | ||
| local basepath="$1" | ||
| local embed="$2" | ||
| shift | ||
| local paths=("$@") | ||
|
|
||
| # Locate the correct slice of the .xcframework for the current architectures | ||
| local target_path="" | ||
| local target_arch="$ARCHS" | ||
| local target_variant="" | ||
| if [[ "$PLATFORM_NAME" == *"simulator" ]]; then | ||
| target_variant="simulator" | ||
| fi | ||
| if [[ "$EFFECTIVE_PLATFORM_NAME" == *"maccatalyst" ]]; then | ||
| target_variant="maccatalyst" | ||
| fi | ||
| for i in ${!paths[@]}; do | ||
| if [[ "${paths[$i]}" == *"$target_arch"* ]] && [[ "${paths[$i]}" == *"$target_variant"* ]]; then | ||
| # Found a matching slice | ||
| echo "Selected xcframework slice ${paths[$i]}" | ||
| target_path=${paths[$i]} | ||
| break; | ||
| fi | ||
| done | ||
|
|
||
| if [[ -z "$target_path" ]]; then | ||
| echo "warning: [CP] Unable to find matching .xcframework slice in '${paths[@]}' for the current build architectures ($ARCHS)." | ||
| return | ||
| fi | ||
|
|
||
| install_framework "$basepath/$target_path" "$embed" | ||
| } | ||
|
|
||
| SH | ||
| contents_by_config = Hash.new do |hash, key| | ||
| hash[key] = '' | ||
| end | ||
| xcframeworks_by_config.each do |config, xcframeworks| | ||
| next if xcframeworks.empty? | ||
| xcframeworks.each do |xcframework| | ||
| slices = xcframework.slices.select { |f| f.platform.symbolic_name == platform.symbolic_name } | ||
| dynamic_slices, static_slices = slices.partition { |slice| Xcode::LinkageAnalyzer.dynamic_binary?(slice.binary_path) } | ||
| next if dynamic_slices.empty? && static_slices.empty? | ||
| unless dynamic_slices.empty? | ||
| args = install_xcframework_args(xcframework.path, dynamic_slices, false) | ||
| contents_by_config[config] << %( install_xcframework #{args}\n) | ||
| end | ||
|
|
||
| unless static_slices.empty? | ||
| args = install_xcframework_args(xcframework.path, static_slices, true) | ||
| contents_by_config[config] << %( install_xcframework #{args}\n) | ||
| end | ||
|
|
||
| dsyms = PrepareArtifactsScript.dsym_paths(xcframework.path) | ||
| dsyms.each do |path| | ||
| source = shell_escape("${PODS_ROOT}/#{path.relative_path_from(sandbox_root)}") | ||
| contents_by_config[config] << %( install_artifact #{source} "${TARGET_BUILD_DIR}" "true"\n) | ||
| end | ||
| end | ||
| end | ||
|
|
||
| script << "\n" unless contents_by_config.empty? | ||
| contents_by_config.keys.sort.each do |config| | ||
| contents = contents_by_config[config] | ||
| next if contents.empty? | ||
| script << %(if [[ "$CONFIGURATION" == "#{config}" ]]; then\n) | ||
| script << contents | ||
| script << "fi\n" | ||
| end | ||
|
|
||
| script << "\necho \"Artifact list stored at $ARTIFACT_LIST_FILE\"\n" | ||
| script << "\ncat \"$ARTIFACT_LIST_FILE\"\n" | ||
| script | ||
| end | ||
|
|
||
| def shell_escape(value) | ||
| "\"#{value}\"" | ||
|
There was a problem hiding this comment. thank you, I knew there must be a better way |
||
| end | ||
|
|
||
| def install_xcframework_args(root, slices, static) | ||
| args = [shell_escape("${PODS_ROOT}/#{root.relative_path_from(sandbox_root)}")] | ||
| embed = static ? 'false' : 'true' | ||
| args << shell_escape(embed) | ||
| slices.each do |slice| | ||
| args << shell_escape(slice.path.relative_path_from(root)) | ||
| end | ||
| args.join(' ') | ||
| end | ||
|
|
||
| class << self | ||
| # @param [Pathname] xcframework_path | ||
| # the base path of the .xcframework bundle | ||
| # | ||
| # @return [Array<Pathname>] all found .dSYM paths | ||
| # | ||
| def dsym_paths(xcframework_path) | ||
| basename = File.basename(xcframework_path, '.xcframework') | ||
| dsym_basename = basename + '.dSYMs' | ||
| path = xcframework_path.dirname + dsym_basename | ||
| return [] unless File.directory?(path) | ||
|
|
||
| pattern = path + '*.dSYM' | ||
| Dir.glob(pattern).map { |s| Pathname.new(s) } | ||
| end | ||
| end | ||
| end | ||
| end | ||
| end | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nice