Add support for iOS Frameworks with header maps.

pylib/gyp/mac_tool.py

 #!/usr/bin/env python
 # Copyright (c) 2012 Google Inc. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 """Utility functions to perform Xcode-style build steps.
 
 These functions are executed via gyp-mac-tool when using the Makefile generator.
 """
 
 import fcntl
 import fnmatch
 import glob
 import json
 import os
 import plistlib
 import re
 import shutil
 import string
+import struct
 import subprocess
 import sys
 import tempfile
 
 
 def main(args):
   executor = MacTool()
   exit_code = executor.Dispatch(args)
   if exit_code is not None:
     sys.exit(exit_code)
@@ skipping 235 matching lines @@
         print >>sys.stderr, line
     # Unconditionally touch the output .a file on the command line if present
     # and the command succeeded. A bit hacky.
     if not libtoolout.returncode:
       for i in range(len(cmd_list) - 1):
         if cmd_list[i] == "-o" and cmd_list[i+1].endswith('.a'):
           os.utime(cmd_list[i+1], None)
           break
     return libtoolout.returncode
 
+  def ExecPackageIosFramework(self, framework):
+    # Find the name of the binary based on the part before the ".framework".
+    binary = os.path.basename(framework).split('.')[0]
+    module_path = os.path.join(framework, 'Modules');
+    if not os.path.exists(module_path):
+      os.mkdir(module_path)
+    module_template = 'framework module %s {\n' \
+                      '  umbrella header "%s.h"\n' \
+                      '\n' \
+                      '  export *\n' \
+                      '  module * { export * }\n' \
+                      '}\n' % (binary, binary)
+
+    module_file = open(os.path.join(module_path, 'module.modulemap'), "w")
+    module_file.write(module_template)
+    module_file.close()
+
+
   def ExecPackageFramework(self, framework, version):
     """Takes a path to Something.framework and the Current version of that and
     sets up all the symlinks."""
     # Find the name of the binary based on the part before the ".framework".
     binary = os.path.basename(framework).split('.')[0]
 
     CURRENT = 'Current'
     RESOURCES = 'Resources'
     VERSIONS = 'Versions'
 
@@ skipping 16 matching lines @@
     # Back to where we were before!
     os.chdir(pwd)
 
   def _Relink(self, dest, link):
     """Creates a symlink to |dest| named |link|. If |link| already exists,
     it is overwritten."""
     if os.path.lexists(link):
       os.remove(link)
     os.symlink(dest, link)
 
+  def ExecCompileIosFrameworkHeaderMap(self, out, framework, *all_headers):
+    framework_name = os.path.basename(framework).split('.')[0]
+    all_headers = map(os.path.abspath, all_headers)
+    filelist = {}
+    for header in all_headers:
+      filename = os.path.basename(header)
+      filelist[filename] = header
+      filelist[os.path.join(framework_name, filename)] = header
+    self._writeHmap(out, filelist)
+
+  def ExecCopyIosFrameworkHeaders(self, framework, *copy_headers):
+    header_path = os.path.join(framework, 'Headers');
+    if not os.path.exists(header_path):
+      os.makedirs(header_path)
+    for header in copy_headers:
+      shutil.copy2(header, os.path.join(header_path, os.path.basename(header)))
+
   def ExecCompileXcassets(self, keys, *inputs):
     """Compiles multiple .xcassets files into a single .car file.
 
     This invokes 'actool' to compile all the inputs .xcassets files. The
     |keys| arguments is a json-encoded dictionary of extra arguments to
     pass to 'actool' when the asset catalogs contains an application icon
     or a launch image.
 
     Note that 'actool' does not create the Assets.car file if the asset
     catalogs does not contains imageset.
@@ skipping 273 matching lines @@
     if isinstance(data, str):
       for key, value in substitutions.iteritems():
         data = data.replace('$(%s)' % key, value)
       return data
     if isinstance(data, list):
       return [self._ExpandVariables(v, substitutions) for v in data]
     if isinstance(data, dict):
       return {k: self._ExpandVariables(data[k], substitutions) for k in data}
     return data
 
+  def _next_greater_power_of_2(self, x):

[sdefresne, 2016/03/15 14:14:33]

This does not need to be an instance method, can be a free function. Please
rename to NextGreaterPowerOf2 to respect naming convention (Google != Python).

[justincohen, 2016/03/17 02:49:05]

Done.

+    return 2**(x-1).bit_length()
+
+  def _writeHmap(self, output_name, filelist):

[sdefresne, 2016/03/15 14:14:33]

This does not need to be an instance method, can be a free function. Please
rename to WriteHmap to respect naming convention (Google != Python). Please add
docstring to explain what this does (and how you found how to implement, you can
say this is based on inspecting the output of xcodebuild version x.y.z).

[justincohen, 2016/03/17 02:49:05]

Done.

+    magic = 1751998832
+    version = 1
+    _reserved = 0
+    count = len(filelist)
+    capacity = self._next_greater_power_of_2(count)
+    strings_offset = 24 + (12 * capacity)
+    max_value_length = len(max(filelist.items(), key=lambda (k,v):len(v))[1])
+
+    out = open(output_name, "wb")
+    out.write(struct.pack('<LHHLLLL', magic, version, _reserved, strings_offset,
+                          count, capacity, max_value_length))
+
+    # Create empty hashmap buckets.
+    buckets = [None] * capacity
+    for file, path in filelist.items():
+      key = 0
+      for c in file:
+        key += ord(c.lower()) * 13
+
+      # Fill next empty bucket.
+      while buckets[key & capacity - 1] is not None:
+        key = key + 1
+      buckets[key & capacity - 1] = (file, path)
+
+    next_offset = 1
+    for bucket in buckets:
+      if bucket is None:
+        out.write(struct.pack('<LLL', 0, 0, 0))
+      else:
+        (file, path) = bucket
+        key_offset = next_offset
+        prefix_offset = key_offset + len(file) + 1
+        suffix_offset = prefix_offset + len(os.path.dirname(path) + os.sep) + 1
+        next_offset = suffix_offset + len(os.path.basename(path)) + 1
+        out.write(struct.pack('<LLL', key_offset, prefix_offset, suffix_offset))
+
+    # Pad byte since next offset starts at 1.
+    out.write(struct.pack('<x'))
+
+    for bucket in buckets:
+      if bucket is not None:
+        (file, path) = bucket
+        out.write(struct.pack('<%ds' % len(file), file))
+        out.write(struct.pack('<s', '\0'))
+        base = os.path.dirname(path) + os.sep
+        out.write(struct.pack('<%ds' % len(base), base))
+        out.write(struct.pack('<s', '\0'))
+        path = os.path.basename(path)
+        out.write(struct.pack('<%ds' % len(path), path))
+        out.write(struct.pack('<s', '\0'))
+
 if __name__ == '__main__':
   sys.exit(main(sys.argv[1:]))