xcode emulation for make: Adjust .a and .dylib entries in 'libraries'.

pylib/gyp/xcode_emulation.py

 # 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.
 
 """
 This module contains classes that help to emulate xcodebuild behavior on top of
 other build systems, such as make and ninja.
 """
 
 import os.path
@@ skipping 11 matching lines @@
     # for that config -- the per-target settings as well. Settings that are
     # the same for all configs are implicitly per-target settings.
     self.xcode_settings = {}
     configs = spec['configurations']
     for configname, config in configs.iteritems():
       self.xcode_settings[configname] = config.get('xcode_settings', {})
 
     # This is only non-None temporarily during the execution of some methods.
     self.configname = None
 
+    # Used by _AdjustLibrary to match .a and .dylib entries in libraries.
+    self.library_re = re.compile(r'^lib([^/]+)\.(a|dylib)$')
+
   def _Settings(self):
     assert self.configname
     return self.xcode_settings[self.configname]
 
   def _Test(self, test_key, cond_key, default):
     return self._Settings().get(test_key, default) == cond_key
 
   def _Appendf(self, lst, test_key, format_str, default=None):
     if test_key in self._Settings():
       lst.append(format_str % str(self._Settings()[test_key]))
@@ skipping 331 matching lines @@
     self._Appendf(
         ldflags, 'DYLIB_COMPATIBILITY_VERSION', '-compatibility_version %s')
     self._Appendf(
         ldflags, 'DYLIB_CURRENT_VERSION', '-current_version %s')
     self._Appendf(
         ldflags, 'MACOSX_DEPLOYMENT_TARGET', '-mmacosx-version-min=%s')
     if 'SDKROOT' in self._Settings():
       ldflags.append('-isysroot ' + self._SdkPath())
 
     for library_path in self._Settings().get('LIBRARY_SEARCH_PATHS', []):
-      ldflags.append('-L' + library_path)
+      ldflags.append('-L' + gyp_to_build_path(library_path))

[Nico, 2012/01/20 17:44:07]

Can you add a test for this, too? (That's not a question.)

[viettrungluu, 2012/01/21 00:15:20]

I added a test for LIBRARY_SEARCH_PATHS, but it doesn't actually manage to
verify that the path is properly transformed.

Where do you suggest that I copy a library to in order to check that
gyp_to_build_path() is properly called?

postbuilds/actions support is pretty broken, btw, with lots of variables that
xcodebuild exports not being exported. This isn't making my life any easier.

[Nico, 2012/01/21 00:18:15]

Add a 'static_library' target, then from the test build this, and move it to a
subdirectory of product_dir (from the test code) before building the target that
uses LIBRARY_SEARCH_PATHS.
See the "as needed" comment at the top of GetXcodeEnv() :-)

 
     if 'ORDER_FILE' in self._Settings():
       ldflags.append('-Wl,-order_file ' +
                      '-Wl,' + gyp_to_build_path(
                                   self._Settings()['ORDER_FILE']))
 
     # TODO: Do not hardcode arch. Supporting fat binaries will be annoying.
     ldflags.append('-arch i386')
 
     # Xcode adds the product directory by default.
@@ skipping 130 matching lines @@
     self.configname = None
     return result
 
   def GetTargetPostbuilds(self, configname, output, output_binary):
     """Returns a list of shell commands that contain the shell commands
     to run as postbuilds for this target, before the actual postbuilds."""
     # dSYMs need to build before stripping happens.
     return (self._GetDebugPostbuilds(configname, output, output_binary) +
             self._GetStripPostbuilds(configname, output_binary))
 
-  def AdjustFrameworkLibraries(self, libraries):
+  def _AdjustLibrary(self, library):
+    if library.endswith('.framework'):
+      l = '-framework ' + os.path.splitext(os.path.basename(library))[0]
+    else:
+      m = self.library_re.match(library)
+      if m:
+        l = '-l' + m.group(1)
+      else:
+        l = library
+    return l.replace('$(SDKROOT)', self._SdkPath())
+
+  def AdjustLibraries(self, libraries):
     """Transforms entries like 'Cocoa.framework' in libraries into entries like
-    '-framework Cocoa'.
+    '-framework Cocoa', 'libcrypto.dylib' into '-lcrypto', etc.
     """
-    libraries = [
-        '-framework ' + os.path.splitext(os.path.basename(library))[0]
-        if library.endswith('.framework') else library
-        for library in libraries]
-    libraries = [library.replace('$(SDKROOT)', self._SdkPath())
-        for library in libraries]
+    libraries = [ self._AdjustLibrary(library) for library in libraries]

[Nico, 2012/01/20 17:44:07]

I like this, but linux doesn't do it. Should we be doing this on linux too?
(cc'd gyp-developer list, any opinion?)

("this" being the translation of libfoo.a to -lfoo)

[viettrungluu, 2012/01/21 00:15:20]

No .gyp file for Linux currently relies on this. Though it'd be more consistent
with the other generators/platforms.

     return libraries
 
 
 class MacPrefixHeader(object):
   """A class that helps with emulating Xcode's GCC_PREFIX_HEADER feature.
 
   This feature consists of several pieces:
   * If GCC_PREFIX_HEADER is present, all compilations in that project get an
     additional |-include path_to_prefix_header| cflag.
   * If GCC_PRECOMPILE_PREFIX_HEADER is present too, then the prefix header is
@@ skipping 356 matching lines @@
 
   # Any remaining edges indicate a cycle.
   if len(edges):
     raise Exception('Xcode environment variables are cyclically dependent: ' +
         str(edges))
 
   # Append the "nodes" not in the graph to those that were just sorted.
   sorted_nodes.extend(key_list)
 
   return sorted_nodes