Merge pull request #21 from intercom/james/swift-support

Prevent mangling of Swift symbols

Author: jtreanor

Gemfile

@@ -4,5 +4,7 @@ gemspec
 
 group :development do
   gem 'rspec'
+  gem 'pry'
+  gem 'pry-remote'
   gem 'rspec_junit_formatter'
 end

Gemfile.lock

@@ -55,6 +55,7 @@ GEM
       nap (>= 0.8, < 2.0)
       netrc (~> 0.11)
     cocoapods-try (1.2.0)
+    coderay (1.1.3)
     colored2 (3.1.2)
     concurrent-ruby (1.1.7)
     diff-lcs (1.4.4)
@@ -69,11 +70,18 @@ GEM
     i18n (0.9.5)
       concurrent-ruby (~> 1.0)
     json (2.3.1)
+    method_source (1.0.0)
     minitest (5.14.2)
     molinillo (0.6.6)
     nanaimo (0.3.0)
     nap (1.1.0)
     netrc (0.11.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-remote (0.1.8)
+      pry (~> 0.9)
+      slop (~> 3.0)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -90,6 +98,7 @@ GEM
     rspec_junit_formatter (0.4.1)
       rspec-core (>= 2, < 4, != 2.12.0)
     ruby-macho (1.4.0)
+    slop (3.6.0)
     thread_safe (0.3.6)
     typhoeus (1.4.0)
       ethon (>= 0.9.0)
@@ -107,6 +116,8 @@ PLATFORMS
 
 DEPENDENCIES
   cocoapods-mangle!
+  pry
+  pry-remote
   rspec
   rspec_junit_formatter
 

lib/cocoapods_mangle/defines.rb

@@ -23,6 +23,8 @@ def self.mangling_defines(prefix, binaries_to_mangle)
     # @return [Array<String>] The classes defined in the binaries
     def self.classes(binaries)
       all_symbols = run_nm(binaries, '-gU')
+      all_symbols = all_symbols.reject { |symbol| swift_symbol?(symbol) }
+
       class_symbols = all_symbols.select do |symbol|
         symbol[/OBJC_CLASS_\$_/]
       end
@@ -36,6 +38,8 @@ def self.classes(binaries)
     # @return [Array<String>] The constants defined in the binaries
     def self.constants(binaries)
       all_symbols = run_nm(binaries, '-gU')
+      all_symbols = all_symbols.reject { |symbol| swift_symbol?(symbol) }
+
       consts = all_symbols.select { |const| const[/ S /] }
       consts = consts.reject { |const| const[/_OBJC_/] }
       consts = consts.reject { |const| const[/__block_descriptor.*/] }
@@ -110,6 +114,31 @@ def self.prefix_selectors(prefix, selectors)
       defines
     end
 
+    # Is symbol a Swift symbol? This is used to avoid mangling Swift.
+    # @param [String] symbol
+    #        The symbol to check
+    # @return [Boolean] true if it is a Swift symbol, false otherwise
+    def self.swift_symbol?(symbol)
+      # Swift binaries have many symbols starting with $s_ that should be excluded
+      # e.g. '0000000000000258 S _$s9ManglePod9SomeClassCMF'
+      symbol[/ _\$s/] ||
+        # Internal Swift symbols starting with __swift or ___swift such as should not be mangled
+        # e.g. '00000000000050ac S ___swift_reflection_version' 
+        symbol[/ __(_)?swift/] ||
+        # Swift symbols starting with _symbolic should be ignored
+        # e.g. '0000000000000248 S _symbolic _____ 9ManglePod9SomeClassC'
+        symbol[/ _symbolic/] ||
+        # Swift symbol references to Objective-C symbols should not be mangled
+        # e.g. '00000000000108ca S _associated conformance So26SCNetworkReachabilityFlagsVs10SetAlgebraSCSQ'
+        symbol[/associated conformance/] ||
+        # _globalinit symbols should be skipped
+        # e.g. 0000000000000000 T _globalinit_33_A313450CFC1FC3D0CBEF4411412DB9E8_func0
+        symbol[/ _globalinit/] ||
+        # Swift classes inheriting from Objective-C classes should not be mangled
+        # e.g. '0000000000000290 S _OBJC_CLASS_$__TtC9ManglePod19SomeFoundationClass'
+        symbol[/_OBJC_CLASS_\$__/]
+    end
+
     def self.run_nm(binaries, flags)
       `nm #{flags} #{binaries.join(' ')}`.split("\n")
     end