Add mac_framework_private_headers key to specify which headers should be copi...

pylib/gyp/generator/xcode.py

 #!/usr/bin/python
 
 # Copyright (c) 2010 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.
 
 import filecmp
 import gyp.common
 import gyp.xcodeproj_file
 import errno
@@ skipping 41 matching lines @@
   'RULE_INPUT_NAME': '$(INPUT_FILE_NAME)',
   'RULE_INPUT_PATH': '$(INPUT_FILE_PATH)',
   'SHARED_INTERMEDIATE_DIR': '$(%s)' % _shared_intermediate_var,
   'CONFIGURATION_NAME': '$(CONFIGURATION)',
 }
 
 # The Xcode-specific sections that hold paths.
 generator_additional_path_sections = [
   'mac_bundle_resources',
   'mac_framework_headers',
+  'mac_framework_private_headers',
   # 'mac_framework_dirs', input already handles _dirs endings.
 ]
 
 # The Xcode-specific keys that exist on targets and aren't moved down to
 # configurations.
 generator_additional_non_configuration_keys = [
   'mac_bundle',
   'mac_bundle_resources',
   'mac_framework_headers',
+  'mac_framework_private_headers',
   'xcode_create_dependents_test_runner',
 ]
 
 # We want to let any rules apply to files that are resources also.
 generator_extra_sources_for_rules = [
   'mac_bundle_resources',
   'mac_framework_headers',
+  'mac_framework_private_headers',
 ]
 
 
 def CreateXCConfigurationList(configuration_names):
   xccl = gyp.xcodeproj_file.XCConfigurationList({'buildConfigurations': []})
   if len(configuration_names) == 0:
     configuration_names = ['Default']
   for configuration_name in configuration_names:
     xcbc = gyp.xcodeproj_file.XCBuildConfiguration({
         'name': configuration_name})
@@ skipping 437 matching lines @@
     xct.FrameworksPhase().AddFile(source)
   else:
     # Files that aren't added to a sources or frameworks build phase can still
     # go into the project file, just not as part of a build phase.
     pbxp.AddOrGetFileInRootGroup(source)
 
 
 def AddResourceToTarget(resource, pbxp, xct):
   # TODO(mark): Combine with AddSourceToTarget above?  Or just inline this call
   # where it's used.
-  xct.ResourcesPhase().AddFile(resource)
+  xct.ResourcesPhase().AddFile(resource, settings)

[Mark Mentovai, 2011/03/03 16:29:38]

This is wrong. What’s settings supposed to be here? (Is this even tested?)

[abarth-chromium, 2011/03/03 16:45:40]

This is left-over from a previous approach.  How do I run the tests?

 
 
-def AddHeaderToTarget(header, pbxp, xct):
-  # TODO(mark): Combine with AddSourceToTarget above?  Or just inline this call
-  # where it's used.
-  xct.HeadersPhase().AddFile(header, '{ATTRIBUTES = (Public, ); }')
+def AddHeaderToTarget(header, pbxp, xct, settings):     

[Mark Mentovai, 2011/03/03 16:29:38]

There’s a tab on this line.

[abarth-chromium, 2011/03/03 16:45:40]

Done.

+  # TODO(mark): Combine with AddSourceToTarget above?  Or just inline this call 
+  # where it's used.    

[Mark Mentovai, 2011/03/03 16:29:38]

And this one too.

[abarth-chromium, 2011/03/03 16:45:40]

Done.

+  xct.HeadersPhase().AddFile(header, settings)

[Mark Mentovai, 2011/03/03 16:29:38]

I think the interface would be easier to use if this function accepted either a
str argument containing 'public' or 'private', or a bool argument along the
lines of is_public. Then, this function could put the known string matching the
desired setting into the AddFile call. The problem with the way it’s written now
is that the caller needs to know what the string’s supposed to look like. That’s
not so bad with just one caller for each of public and private, but if we start
wanting to add headers from elsewhere, it will quickly become untenable.

[abarth-chromium, 2011/03/03 16:45:40]

Done.

 
 
 _xcode_variable_re = re.compile('(\$\((.*?)\))')
 def ExpandXcodeVariables(string, expansions):
   """Expands Xcode-style $(VARIABLES) in string per the expansions dict.
 
   In some rare cases, it is appropriate to expand Xcode variables when a
   project file is generated.  For any substring $(VAR) in string, if VAR is a
   key in the expansions dict, $(VAR) will be replaced with expansions[VAR].
   Any $(VAR) substring in string for which VAR is not a key in the expansions
@@ skipping 493 matching lines @@
     # Add "sources".
     for source in spec.get('sources', []):
       (source_root, source_extension) = posixpath.splitext(source)
       if source_extension[1:] not in rules_by_ext:
         # AddSourceToTarget will add the file to a root group if it's not
         # already there.
         AddSourceToTarget(source, pbxp, xct)
       else:
         pbxp.AddOrGetFileInRootGroup(source)
 
-    # Add "mac_bundle_resources" and "mac_framework_headers" if it's a bundle
-    # of any type.
+    # Add "mac_bundle_resources", "mac_framework_headers", and
+    # "mac_framework_private_headers" if it's a bundle of any type.
     if is_bundle:
       for resource in tgt_mac_bundle_resources:
         (resource_root, resource_extension) = posixpath.splitext(resource)
         if resource_extension[1:] not in rules_by_ext:
           AddResourceToTarget(resource, pbxp, xct)
         else:
           pbxp.AddOrGetFileInRootGroup(resource)
 
       for header in spec.get('mac_framework_headers', []):
-        AddHeaderToTarget(header, pbxp, xct)
+        AddHeaderToTarget(header, pbxp, xct, '{ATTRIBUTES = (Public, ); }')
+
+      for header in spec.get('mac_framework_private_headers', []):
+        AddHeaderToTarget(header, pbxp, xct, '{ATTRIBUTES = (Private, ); }')
 
     # Add "copies".
     for copy_group in spec.get('copies', []):
       pbxcp = gyp.xcodeproj_file.PBXCopyFilesBuildPhase({
             'name': 'Copy to ' + copy_group['destination']
           },
           parent=xct)
       dest = copy_group['destination']
       if dest[0] not in ('/', '$'):
         # Relative paths are relative to $(SRCROOT).
         dest = '$(SRCROOT)/' + dest
       pbxcp.SetDestination(dest)
 
       # TODO(mark): The usual comment about this knowing too much about
       # gyp.xcodeproj_file internals applies.
       xct._properties['buildPhases'].insert(prebuild_index, pbxcp)
 
       for file in copy_group['files']:
         pbxcp.AddFile(file)
 
     # Excluded files can also go into the project file.
     if not skip_excluded_files:
-      for key in ['sources', 'mac_bundle_resources', 'mac_framework_headers']:
+      for key in ['sources', 'mac_bundle_resources', 'mac_framework_headers',
+                  'mac_framework_private_headers']:
         excluded_key = key + '_excluded'
         for item in spec.get(excluded_key, []):
           pbxp.AddOrGetFileInRootGroup(item)
 
     # So can "inputs" and "outputs" sections of "actions" groups.
     groups = ['inputs', 'inputs_excluded', 'outputs', 'outputs_excluded']
     if skip_excluded_files:
       groups = [x for x in groups if not x.endswith('_excluded')]
     for action in spec.get('actions', []):
       for group in groups:
@@ skipping 80 matching lines @@
 
   for build_file in build_files:
     xcode_projects[build_file].Finalize1(xcode_targets, serialize_all_tests)
 
   for build_file in build_files:
     xcode_projects[build_file].Finalize2(xcode_targets,
                                          xcode_target_to_target_dict)
 
   for build_file in build_files:
     xcode_projects[build_file].Write()