Make xcodebodge even more friendly by making list_native_targets

tools/xcodebodge/xcodebodge.py

 #!/usr/bin/python
 # Copyright (c) 2008 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 """
 Commandline modification of Xcode project files
 """
 
 import sys
 import os
@@ skipping 155 matching lines @@
       # Read in the section, using custom classes where we need them
       section_end_match = self.__class__.SECTION_END_RE.match(
                                self._raw_content[parse_line_no])
       while not section_end_match:
         # Unhandled lines
         content = self._raw_content[parse_line_no]
         # Sections we can parse line-by-line
         if section in ('PBXBuildFile', 'PBXFileReference'):
           content = eval('%s.FromContent(content)' % section)
         # Multiline sections
-        elif section in ('PBXGroup', 'PBXVariantGroup', 'PBXProject', 
+        elif section in ('PBXGroup', 'PBXVariantGroup', 'PBXProject',
                          'PBXNativeTarget', 'PBXSourcesBuildPhase'):
           # Accumulate lines
           content_lines = []
           while 1:
             content_lines.append(content)
             if content == '\t\t};\n': break
             parse_line_no += 1
             content = self._raw_content[parse_line_no]
           content = eval('%s.FromContent(content_lines)' % section)
 
@@ skipping 80 matching lines @@
           if not found_uuid:
             raise RuntimeError('XcodeProject group descent failed to find %s' %
                                 child_uuid)
     self._root_group = None
     for group in self._sections['PBXGroup']:
       if group.uuid == self._root_group_uuid:
         self._root_group = group
         GroupPathRecurse(group, self.source_root_path)
     if not self._root_group:
       raise RuntimeError('XcodeProject failed to find root group by UUID')
-      
+
   def FileContent(self):
     """Generate and return the project file content as a list of lines"""
     content = []
     content.extend(self._header[:-1])
     for section in self._section_order:
       content.append('\n/* Begin %s section */\n' % section)
       for section_content in self._sections[section]:
         content.append(str(section_content))
       content.append('/* End %s section */\n' % section)
     content.extend(self._tail)
@@ skipping 98 matching lines @@
     Returns:
       PBXFileReference instance
     """
     for file_ref in self._sections['PBXFileReference']:
       if file_ref.uuid == uuid:
         return file_ref
     raise RuntimeError('Missing PBXFileReference for UUID "%s"' % uuid)
 
   def RemoveSourceFileReference(self, file_ref):
     """Remove a source file's PBXFileReference from the project, cleaning up all
-    PBXGroup and PBXBuildFile references to that PBXFileReference and 
+    PBXGroup and PBXBuildFile references to that PBXFileReference and
     furthermore, removing any PBXBuildFiles from all PBXNativeTarget source
     lists.
 
     Args:
       file_ref: PBXFileReference instance
 
     Raises:
       RuntimeError if |file_ref| is not a source file reference in PBXBuildFile
     """
     self._sections['PBXFileReference'].remove(file_ref)
@@ skipping 63 matching lines @@
     """Convert a path to a group-relative path if possible
 
     Args:
       abs_path: Absolute path to convert
 
     Returns:
       Parent PBXGroup instance if possible or None
     """
     needed_path = os.path.dirname(abs_path)
     possible_groups = [ g for g in self._sections['PBXGroup']
-                        if g.abs_path == needed_path and 
+                        if g.abs_path == needed_path and
                            not g.name in NON_SOURCE_GROUP_NAMES ]
     if len(possible_groups) < 1:
       return None
     elif len(possible_groups) == 1:
       return possible_groups[0]
     # Multiple groups match, try to find the best using some simple
     # heuristics. Does only one group contain source?
     groups_with_source = []
     for group in possible_groups:
       for child_uuid in group.child_uuids:
@@ skipping 11 matching lines @@
                         if g is not self._root_group ]
     if len(non_root_groups) == 1:
       return non_root_groups[0]
     # Best guess
     if len(non_root_groups):
       return non_root_groups[0]
     elif len(groups_with_source):
       return groups_with_source[0]
     else:
       return possible_groups[0]
-      
+
   def AddSourceFile(self, path):
     """Add a source file to the project, attempting to position it
     in the GUI group heirarchy reasonably.
 
     NOTE: Adding a source file does not add it to any targets
 
     Args:
       path: Absolute path to the file to add
 
     Returns:
@@ skipping 153 matching lines @@
 
   @classmethod
   def FromContent(klass, content_line):
     parsed = klass.PBXBUILDFILE_LINE_RE.match(content_line)
     if not parsed:
       raise RuntimeError('PBXBuildFile unable to parse content:\n%s'
                           % content_line)
     if parsed.group(2) !=  parsed.group(5):
       raise RuntimeError('PBXBuildFile name mismatch "%s" vs "%s"' %
                          (parsed.group(2), parsed.group(5)))
-    if not parsed.group(3) in ('Sources', 'Frameworks', 
+    if not parsed.group(3) in ('Sources', 'Frameworks',
                                'Resources', 'CopyFiles',
                                'Headers', 'Copy Into Framework',
                                'Rez', 'Copy Generated Headers'):
       raise RuntimeError('PBXBuildFile unknown type "%s"' % parsed.group(3))
     return klass(parsed.group(1), parsed.group(2), parsed.group(3),
                  parsed.group(4), parsed.group(6))
 
   def __init__(self, uuid, name, type, file_ref_uuid, raw_extras):
     self.uuid = uuid
     self.name = name
@@ skipping 48 matching lines @@
                           % content_line)
     tree_parsed = klass.PBXFILEREFERENCE_SOURCETREE_RE.search(content_line)
     if not tree_parsed:
       raise RuntimeError(
               'PBXFileReference unable to parse source tree content:\n%s'
               % content_line)
     return klass(header_parsed.group(1), header_parsed.group(2),
                  last_known_type, explicit_type, path_parsed.group(1),
                  tree_parsed.group(1), content_line)
 
-  def __init__(self, uuid, name, last_known_file_type, explicit_file_type, 
+  def __init__(self, uuid, name, last_known_file_type, explicit_file_type,
                path, source_tree, raw_line):
     self.uuid = uuid
     self.name = name
     self._last_known_file_type = last_known_file_type
     self._explicit_file_type = explicit_file_type
     if explicit_file_type:
       self.file_type = explicit_file_type
     else:
       self.file_type = last_known_file_type
     self.path = path
@@ skipping 113 matching lines @@
 
   def __init__(self, uuid, name, path, source_tree, child_uuids, child_names,
                tab_width, uses_tabs, indent_width):
     self.uuid = uuid
     self.name = name
     self.path = path
     self.source_tree = source_tree
     self.child_uuids = child_uuids
     self.child_names = child_names
     self.abs_path = None
-    # Semantically I'm not sure these aren't an error, but they 
+    # Semantically I'm not sure these aren't an error, but they
     # appear in some projects
     self._tab_width = tab_width
     self._uses_tabs = uses_tabs
     self._indent_width = indent_width
 
   def __str__(self):
     if self.name:
       header_comment = '/* %s */ ' % self.name
     elif self.path:
       header_comment = '/* %s */ ' % self.path
@@ skipping 32 matching lines @@
            '\t\t\tchildren = (\n' \
            '%s' \
            '\t\t\t);\n' \
            '%s' \
            '%s' \
            '%s' \
            '\t\t\tsourceTree = %s;\n' \
            '%s' \
            '%s' \
            '\t\t};\n' % (
-            self.uuid, header_comment, 
+            self.uuid, header_comment,
             self.__class__.__name__,
-            children, 
+            children,
             indent_width_attribute,
             name_attribute,
             path_attribute, self.source_tree,
             tab_width_attribute, uses_tabs_attribute)
-            
-            
+
+
 class PBXVariantGroup(PBXGroup):
   pass
 
 
 class PBXNativeTarget(object):
   """Class for PBXNativeTarget data from an Xcode project file.
 
   Attributes:
     name: Target name
     build_phase_uuids: Ordered list of build phase UUIDs
@@ skipping 191 matching lines @@
     project_path = os.path.join(project_path, 'project.pbxproj')
   if not project_path.endswith(os.sep + 'project.pbxproj'):
     option_parser.error('Invalid Xcode project file path \"%s\"' % project_path)
   if not os.path.exists(project_path):
     option_parser.error('Missing Xcode project file \"%s\"' % project_path)
 
   # Construct project object
   project = XcodeProject(project_path)
 
   # Switch on command
-  if len(args) < 1:
-    Usage(option_parser)
 
-  # List native target names
-  elif args[0] == 'list_native_targets':
-    # List targets
-    if len(args) != 1:
-      option_parser.error('list_native_targets takes no arguments')
+  # List native target names (default command)
+  if len(args) < 1 or args[0] == 'list_native_targets':
     # Ape xcodebuild output
     target_names = []
     for target in project.NativeTargets():
       target_names.append(target.name)
     print 'Information about project "%s"\n    Native Targets:\n        %s' % (
           project.name,
           '\n        '.join(target_names))
 
+    if len(args) < 1:
+      # Be friendly and print some hints for further actions.
+      print
+      print 'To add or remove files from given target, run:'
+      print '\txcodebodge.py -p <project> -t <target> add_source <file_name>'
+      print '\txcodebodge.py -p <project> -t <target> remove_source <file_name>'
+
   # List files in a native target
   elif args[0] == 'list_target_sources':
     if len(args) != 1:
       option_parser.error('list_target_sources takes no arguments')
     if not options.target:
       option_parser.error('list_target_sources requires a target')
     # Validate target and get list of files
     target = project.NativeTargetForName(options.target)
     if not target:
       option_parser.error('No native target named "%s"' % options.target)
@@ skipping 62 matching lines @@
               project.RelativeSourceRootPath(file_ref.abs_path) == source_path))):
           source_ref = file_ref
           break
       if not source_ref:
         # Create a new source file ref
         source_ref = project.AddSourceFile(os.path.abspath(source_path))
       # Add the new source file reference to the target if its a safe type
       if source_ref.file_type in SOURCES_XCODE_FILETYPES:
         project.AddSourceFileToSourcesBuildPhase(source_ref, sources_phase)
     project.Update()
-    
+
   # Private sanity check. On an unmodified project make sure our output is
   # the same as the input
   elif args[0] == 'parse_sanity':
     if ''.join(project.FileContent()) != ''.join(project._raw_content):
       option_parser.error('Project rewrite sanity fail "%s"' % project.path)
-    
+
   else:
     Usage(option_parser)
 
 
 if __name__ == '__main__':
   Main()