xcframework_converter 0.4.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ed138cd025eb265a64d714f9342520dd10ca44c9d78120a20eb6695623f1e86
-  data.tar.gz: 870d95ae53553761641a9572a6e08f58103435f4312035749794353c2d34979c
+  metadata.gz: 7a1169fa0a3c860b9ddffd50b22592d95ba42d5f32a1f97dbc7507827491ac47
+  data.tar.gz: 05b3b160406d9b1db0db39cc0c999e4c5370d08be44e5dbd5f069089751ab890
 SHA512:
-  metadata.gz: f5f9e9d85f7385b2a1f7406b5942741c7060c9263e751a9e59bdeb13c234e117c0ba1f58a3f3f2c0f509d797b76c9b51afbb12131fde7bdfefe9940a29e4ac4d
-  data.tar.gz: a2201235913e84433ee593288511da552b23cdf9e0e09ca0efdcc525f82ebd2e884d9d134b71f7323ed07a7b1ea88d70d49406492c51e2834afa3af02c1071e9
+  metadata.gz: 4356364e00c34af6f9a817d9a3bea2411f46ab0fee145586bbb48d9f1ffa23335a1728970535ea2e8e94559eae15cb3de4abecce8c983fa1b9b653235878a50e
+  data.tar.gz: a29311d0abee698408d037bbca8ebba0a9603e2eb9c4851c4b74c2581688a324fe529f26a374c04ea29405a45174931eff113362e99edf460b953dfb66364f8a

data/bin/xcfconvert

@@ -5,8 +5,10 @@ require 'bundler/setup'
 require 'xcframework_converter'
 
 if ARGV.empty?
-  warn 'Usage: xcfconvert <path/to/Framework.framework>'
+  warn 'Usage: xcfconvert <path/to/Framework.framework> [ios|tvos|watchos]'
   exit 1
 end
 
-XCFrameworkConverter.convert_framework_to_xcframework(Pathname.new(ARGV[0]).realpath)
+path = Pathname.new(ARGV.shift).realpath
+platform = ARGV.shift&.to_sym || :ios
+XCFrameworkConverter.convert_framework_to_xcframework(path, platform)

data/lib/arm64-to-sim/Sources/Arm64ToSimLib/Transmogrifier.swift

@@ -104,7 +104,7 @@ public enum Transmogrifier {
         return datas.merge()
     }
 
-    private static func updateVersionMin(_ data: Data, _ offset: UInt32, minos: UInt32, sdk: UInt32) -> Data {
+    private static func createLcBuildVersion(minos: UInt32, sdk: UInt32) -> Data {
         var command = build_version_command(cmd: UInt32(LC_BUILD_VERSION),
                                             cmdsize: UInt32(MemoryLayout<build_version_command>.stride),
                                             platform: UInt32(PLATFORM_IOSSIMULATOR),
@@ -115,6 +115,15 @@ public enum Transmogrifier {
         return Data(bytes: &command, count: MemoryLayout<build_version_command>.stride)
     }
 
+    private static func updateLcBuildVersion(_ data: Data, minos: UInt32, sdk: UInt32) -> Data {
+        var command: build_version_command = data.asStruct()
+        command.platform = UInt32(PLATFORM_IOSSIMULATOR)
+        command.minos = minos << 16 | 0 << 8 | 0
+        command.sdk = sdk << 16 | 0 << 8 | 0
+
+        return Data(bytes: &command, count: data.count)
+    }
+
     private static func updateDataInCode(_ data: Data, _ offset: UInt32) -> Data {
         var command: linkedit_data_command = data.asStruct()
         command.dataoff += offset
@@ -154,8 +163,6 @@ public enum Transmogrifier {
     }
 
     if contains_LC_VERSION_MIN_IPHONEOS {
-      // `offset` is kind of a magic number here, since we know that's the only meaningful change to binary size
-      // having a dynamic `offset` requires two passes over the load commands and is left as an exercise to the reader
       return updatePreiOS12ObjectFile
     } else {
       return updatePostiOS12ObjectFile
@@ -167,7 +174,7 @@ public enum Transmogrifier {
       let cmd = Int32(bitPattern: lc.loadCommand)
       switch cmd {
       case LC_BUILD_VERSION:
-          return updateVersionMin(lc, 0, minos: minos, sdk: sdk)
+          return updateLcBuildVersion(lc, minos: minos, sdk: sdk)
       default:
           return lc
       }
@@ -182,28 +189,25 @@ public enum Transmogrifier {
           case LC_SEGMENT_64:
               return updateSegment64(lc, offset)
           case LC_VERSION_MIN_IPHONEOS:
-              return updateVersionMin(lc, offset, minos: minos, sdk: sdk)
+              return createLcBuildVersion(minos: minos, sdk: sdk)
           case LC_DATA_IN_CODE, LC_LINKER_OPTIMIZATION_HINT:
               return updateDataInCode(lc, offset)
           case LC_SYMTAB:
               return updateSymTab(lc, offset)
           case LC_BUILD_VERSION:
-              return updateVersionMin(lc, offset, minos: minos, sdk: sdk)
+              fatalError("pre-12 object file shold not contain LC_BUILD_VERSION!")
           default:
               return lc
       }
   }
 
   static func updateDylibFile(lc: Data, minos: UInt32, sdk: UInt32) -> Data {
-    // `offset` is kind of a magic number here, since we know that's the only meaningful change to binary size
-    // having a dynamic `offset` requires two passes over the load commands and is left as an exercise to the reader
-    let offset = UInt32(abs(MemoryLayout<build_version_command>.stride - MemoryLayout<version_min_command>.stride))
     let cmd = Int32(bitPattern: lc.loadCommand)
     guard cmd != LC_BUILD_VERSION else {
         fatalError("This arm64 binary already contains an LC_BUILD_VERSION load command!")
     }
     if cmd == LC_VERSION_MIN_IPHONEOS {
-        return updateVersionMin(lc, offset, minos: minos, sdk: sdk)
+        return createLcBuildVersion(minos: minos, sdk: sdk)
     }
     return lc
   }

data/lib/xcframework_converter/arm_patcher.rb

@@ -2,10 +2,12 @@
 
 require 'cocoapods'
 require 'cocoapods/xcode/xcframework'
+require 'digest/md5'
 require 'fileutils'
+require 'shellwords'
 require 'xcodeproj'
 
-# rubocop:disable Metrics/AbcSize
+# rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
 
 module XCFrameworkConverter
   # Patches a binary (static or dynamic), turning an arm64-device into an arm64-simualtor.
@@ -35,9 +37,8 @@ module XCFrameworkConverter
         extracted_path = slice.path.join('arm64.dylib')
         `xcrun lipo \"#{slice.binary_path}\" -thin arm64 -output \"#{extracted_path}\"`
 
-        file = MachO::MachOFile.new(extracted_path)
-        sdk_version = file[:LC_VERSION_MIN_IPHONEOS].first.version_string
-        `xcrun vtool -arch arm64 -set-build-version 7 #{sdk_version} #{sdk_version} -replace -output \"#{extracted_path}\" \"#{extracted_path}\"`
+        minos_version, sdk_version = version_strings(extracted_path).map(&:to_i)
+        `xcrun vtool -arch arm64 -set-build-version 7 #{minos_version} #{sdk_version} -replace -output \"#{extracted_path}\" \"#{extracted_path}\"`
         `xcrun lipo \"#{slice.binary_path}\" -replace arm64 \"#{extracted_path}\" -output \"#{slice.binary_path}\"`
         extracted_path.rmtree
       end
@@ -61,21 +62,61 @@ module XCFrameworkConverter
         `xcrun lipo \"#{slice.binary_path}\" -thin arm64 -output \"#{extracted_path}\"`
         extracted_path_dir = slice.path.join('arm64-objects')
         extracted_path_dir.mkdir
-        `cd \"#{extracted_path_dir}\" ; ar x \"#{extracted_path}\"`
-        Dir[extracted_path_dir.join('*.o')].each do |object_file|
-          file = MachO::MachOFile.new(object_file)
-          sdk_version = file[:LC_VERSION_MIN_IPHONEOS].first.version_string.to_i
-          `\"#{arm2sim_path}\" \"#{object_file}\" \"#{sdk_version}\" \"#{sdk_version}\"`
-          $stderr.printf '.'
+        if macho_file_type(extracted_path) == :object
+          patch_object_file(extracted_path)
+        else
+          object_files = `ar t \"#{extracted_path}\"`.split("\n").map(&:chomp).sort
+                                                     .select { |o| o.end_with?('.o') }
+                                                     .group_by(&:itself).transform_values(&:count)
+          processed_files = []
+          index = 0
+          while object_files.any?
+            object_files.keys.each do |object_file|
+              file_shard = Digest::MD5.hexdigest(object_file).to_s[0..2]
+              file_dir = extracted_path_dir.join("#{index}-#{file_shard}")
+              file_path = file_dir.join(object_file)
+              file_dir.mkdir unless file_dir.exist?
+              `ar p \"#{extracted_path}\" \"#{object_file}\" > \"#{file_path}\"`
+              patch_object_file(file_path)
+              $stderr.printf '.'
+              processed_files << file_path
+            end
+            `ar d \"#{extracted_path}\" #{object_files.keys.map(&:shellescape).join(' ')}`
+            $stderr.printf '#'
+            object_files.reject! { |_, count| count <= index + 1 }
+            index += 1
+          end
+          $stderr.puts
+          `cd \"#{extracted_path_dir}\" ; ar cqv \"#{extracted_path}\" #{processed_files.map(&:shellescape).join(' ')}`
         end
-        $stderr.puts
-        `cd \"#{extracted_path_dir}\" ; ar crv \"#{extracted_path}\" *.o`
-
         `xcrun lipo \"#{slice.binary_path}\" -replace arm64 \"#{extracted_path}\" -output \"#{slice.binary_path}\"`
         extracted_path_dir.rmtree
         extracted_path.rmtree
       end
 
+      def macho_file_type(file_path)
+        MachO.open(file_path).filetype
+      rescue MachO::MagicError
+        nil
+      end
+
+      def patch_object_file(file_path)
+        minos_version, sdk_version = version_strings(file_path).map(&:to_i)
+        `\"#{arm2sim_path}\" \"#{file_path}\" \"#{minos_version}\" \"#{sdk_version}\"`
+      end
+
+      def version_strings(file_path)
+        macho_file = MachO::MachOFile.new(file_path)
+        if (version_min_command = macho_file.load_commands.find { |c| c.is_a?(MachO::LoadCommands::VersionMinCommand) })
+          return [version_min_command.version_string, version_min_command.sdk_string]
+        end
+        if (build_version_command = macho_file.load_commands.find { |c| c.is_a?(MachO::LoadCommands::BuildVersionCommand) })
+          return [build_version_command.minos_string, build_version_command.sdk_string]
+        end
+
+        raise "Could not find version strings in #{file_path}"
+      end
+
       public
 
       def cleanup_unused_archs(slice)

data/lib/xcframework_converter/creation.rb

@@ -20,21 +20,24 @@ module XCFrameworkConverter
       Pathname.new(__FILE__).dirname.join('../xcframework_template.plist')
     end
 
-    def convert_framework_to_xcframework(path)
+    def convert_framework_to_xcframework(path, platform)
       plist = Xcodeproj::Plist.read_from_path(plist_template_path)
       xcframework_path = Pathname.new(path).sub_ext('.xcframework')
       xcframework_path.mkdir
       plist['AvailableLibraries'].each do |slice|
-        slice_path = xcframework_path.join(slice['LibraryIdentifier'])
+        slice_library_identifier = slice['LibraryIdentifier'].sub('platform', platform.to_s)
+        slice_path = xcframework_path.join(slice_library_identifier)
         slice_path.mkdir
         slice['LibraryPath'] = File.basename(path)
+        slice['SupportedPlatform'] = platform.to_s
+        slice['LibraryIdentifier'] = slice_library_identifier
         FileUtils.cp_r(path, slice_path)
       end
       Xcodeproj::Plist.write_to_path(plist, xcframework_path.join('Info.plist'))
       FileUtils.rm_rf(path)
       final_framework = Pod::Xcode::XCFramework.open_xcframework(xcframework_path)
       final_framework.slices.each do |slice|
-        ArmPatcher.patch_arm_binary(slice) if slice.platform == :ios && slice.platform_variant == :simulator
+        ArmPatcher.patch_arm_binary(slice) if slice.platform == platform && slice.platform_variant == :simulator
         ArmPatcher.cleanup_unused_archs(slice)
       end
     end

data/lib/xcframework_converter/patching.rb

@@ -18,18 +18,33 @@ module XCFrameworkConverter
   class << self
     def patch_xcframework(xcframework_path)
       xcframework = Pod::Xcode::XCFramework.open_xcframework(xcframework_path)
+      slices_to_convert = xcframework.slices.select do |slice|
+        slice.platform != :osx &&
+          slice.platform_variant != :simulator &&
+          slice.supported_archs.include?('arm64')
+      end
+
+      slices_to_convert.each do |slice|
+        patch_xcframework_impl(xcframework_path, slice.platform.name)
+      end
+    end
+
+    private
+
+    def patch_xcframework_impl(xcframework_path, platform)
+      xcframework = Pod::Xcode::XCFramework.open_xcframework(xcframework_path)
 
       return nil if xcframework.slices.any? do |slice|
-        slice.platform == :ios &&
+        slice.platform == platform &&
         slice.platform_variant == :simulator &&
         slice.supported_archs.include?('arm64')
       end
 
       original_arm_slice_identifier = xcframework.slices.find do |slice|
-        slice.platform == :ios && slice.supported_archs.include?('arm64')
+        slice.platform == platform && slice.supported_archs.include?('arm64')
       end.identifier
 
-      patched_arm_slice_identifier = 'ios-arm64-simulator'
+      patched_arm_slice_identifier = "#{platform}-arm64-simulator"
 
       warn "Will patch #{xcframework_path}: #{original_arm_slice_identifier} -> #{patched_arm_slice_identifier}"
 

data/lib/xcframework_converter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module XCFrameworkConverter
-  VERSION = '0.4.0'
+  VERSION = '0.7.0'
 end

data/lib/xcframework_converter.rb

@@ -39,8 +39,8 @@ module XCFrameworkConverter
           after_rename = before_rename.map { |f| Pathname.new(f).sub_ext('.xcframework').to_s }
           proxy = Pod::Specification::DSL::PlatformProxy.new(spec, platform.symbolic_name)
           proxy.vendored_frameworks = consumer.vendored_frameworks - before_rename + after_rename
-          before_rename.map { |f| pod_path.join(f) }
-        end.flatten.uniq
+          before_rename.map { |f| [pod_path.join(f), platform.symbolic_name] }
+        end.flatten(1).uniq
 
         convert_xcframeworks_if_present(frameworks_to_convert)
 
@@ -53,8 +53,8 @@ module XCFrameworkConverter
     end
 
     def convert_xcframeworks_if_present(frameworks_to_convert)
-      frameworks_to_convert.each do |path|
-        convert_framework_to_xcframework(path) if Dir.exist?(path)
+      frameworks_to_convert.each do |path, platform|
+        convert_framework_to_xcframework(path, platform) if Dir.exist?(path)
       end
     end
 
@@ -65,21 +65,31 @@ module XCFrameworkConverter
     end
 
     def remove_troublesome_xcconfig_items(spec)
+      # some pods put these as a way to NOT support arm64 sim
+      # may stop working if a pod decides to put these in a platform proxy
+
       xcconfigs = %w[
         pod_target_xcconfig
         user_target_xcconfig
       ].map { |key| spec.attributes_hash[key] }.compact
 
-      xcconfigs.each do |xcconfig|
-        # some pods put these as a way to NOT support arm64 sim
-        # may stop working if a pod decides to put these in a platform proxy
-        excluded_arm = xcconfig['EXCLUDED_ARCHS[sdk=iphonesimulator*]']&.include?('arm64')
-        not_inlcuded_arm = xcconfig['VALID_ARCHS[sdk=iphonesimulator*]'] && !xcconfig['VALID_ARCHS[sdk=iphonesimulator*]'].include?('arm64')
+      platforms = %w[
+        iphonesimulator
+        appletvsimulator
+        watchsimulator
+      ]
+
+      (xcconfigs.product platforms).each do |xcconfig, platform|
+        excluded_archs_key = "EXCLUDED_ARCHS[sdk=#{platform}*]"
+        inlcuded_arch_key = "VALID_ARCHS[sdk=#{platform}*]"
+
+        excluded_arm = xcconfig[excluded_archs_key]&.include?('arm64')
+        not_inlcuded_arm = xcconfig[inlcuded_arch_key] && !xcconfig[inlcuded_arch_key].include?('arm64')
 
         remember_spec_as_patched(spec) if excluded_arm || not_inlcuded_arm
 
-        xcconfig.delete('EXCLUDED_ARCHS[sdk=iphonesimulator*]')
-        xcconfig.delete('VALID_ARCHS[sdk=iphonesimulator*]')
+        xcconfig.delete(excluded_archs_key)
+        xcconfig.delete(inlcuded_arch_key)
       end
     end
 

data/lib/xcframework_template.plist

@@ -6,7 +6,7 @@
 	<array>
 		<dict>
 			<key>LibraryIdentifier</key>
-			<string>ios-arm64_x86_64-simulator</string>
+			<string>platform-arm64_x86_64-simulator</string>
 			<key>LibraryPath</key>
 			<string>Placeholder.framework</string>
 			<key>SupportedArchitectures</key>
@@ -21,7 +21,7 @@
 		</dict>
 		<dict>
 			<key>LibraryIdentifier</key>
-			<string>ios-arm64_armv7</string>
+			<string>platform-arm64_armv7</string>
 			<key>LibraryPath</key>
 			<string>Placeholder.framework</string>
 			<key>SupportedArchitectures</key>
@@ -30,7 +30,7 @@
 				<string>armv7</string>
 			</array>
 			<key>SupportedPlatform</key>
-			<string>ios</string>
+			<string>platform</string>
 		</dict>
 	</array>
 	<key>CFBundlePackageType</key>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xcframework_converter
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Igor Makarov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-06 00:00:00.000000000 Z
+date: 2022-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocoapods