[Android][gn] Add android resources templates

build/android/gyp/write_build_config.py

 #!/usr/bin/env python
 #
 # Copyright 2014 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.
 
 """Writes a build_config file.
 
 The build_config file for a target is a json file containing information about
 how to build that target based on the target's dependencies. This includes
 things like: the javac classpath, the list of android resources dependencies,
 etc. It also includes the information needed to create the build_config for
 other target's that depend on that one.

[newt (away), 2014/07/07 21:47:12]

s/target's/targets

[cjhopman, 2014/07/08 00:16:27]

Done.

 
 There are several different types of build_configs:
   android_library: An android library containing java code.

[newt (away), 2014/07/07 21:47:12]

mention new types here

[cjhopman, 2014/07/08 00:16:27]

Done.

 
 Android build scripts should not refer to the build_config directly, and the
 build specification should instead pass information in using the special
 file-arg syntax (see build_utils.py:ExpandFileArgs). That syntax allows passing
 of values in a json dict in a file and looks like this:
   --python-arg=@(build_config_path):javac:classpath

[newt (away), 2014/07/07 21:47:12]

Is this syntax correct? Also, if usage of this is rare, could we instead use
some alphabetic syntax (easier to interpret and to grep) rather than symbols?
e.g. "@BuildConfigVar(build_config_path:javac:classpath)"

[cjhopman, 2014/07/08 00:16:27]

No, it wasn't. Now it is.
That's a really good idea. I'll do that in a quick followup.

 
 Note: If paths to input files are passed in this way, it is important that:
   1. inputs/deps of the action ensure that the files are available the first
   time the action runs.
   2. Either (a) or (b)
     a. inputs/deps ensure that the action runs whenever one of the files changes
     b. the files are added to the action's depfile
 """
 
 import optparse
 import os
 import sys
 
 from util import build_utils
 
+dep_config_cache = {}
+def GetDepConfig(path):
+  if not path in dep_config_cache:
+    dep_config_cache[path] = build_utils.ReadJson(path)['deps_info']
+  return dep_config_cache[path]
+
+
+def DepsOfType(wanted_type, configs):
+  return [c for c in configs if c['type'] == wanted_type]
+
+
+def GetAllDepsConfigsInOrder(deps_config_paths):
+  def Deps(path):
+    return set(GetDepConfig(path)['deps_configs'])
+  return build_utils.GetSortedTransitiveDependencies(deps_config_paths, Deps)
+
+
 def main(argv):
   parser = optparse.OptionParser()
   build_utils.AddDepfileOption(parser)
   parser.add_option('--build-config', help='Path to build_config output.')
   parser.add_option('--type', help='Type of this target.')

[newt (away), 2014/07/07 21:47:11]

"e.g. android_library"

[cjhopman, 2014/07/08 00:16:27]

Done.

   parser.add_option(
       '--possible-deps-configs',
       help='List of paths for dependency\'s build_config files. Some '
       'dependencies may not write build_config files. Missing build_config '
       'files are handled differently based on the type of this target.')
 
+  # android_resources options
+  parser.add_option('--srcjar', help='Path to target\'s resources srcjar.')
+  parser.add_option('--resources-zip', help='Path to target\'s resources zip.')
+
   # android_library options
   parser.add_option('--jar-path', help='Path to target\'s jar output.')
 
   options, args = parser.parse_args(argv)
 
   if args:
     parser.error('No positional arguments should be given.')
 
   required_options = ('build_config', 'type')
   build_utils.CheckOptions(options, parser, required_options)
 
+  if not options.type in [
+      'android_library', 'android_resources']:
+    raise Exception('Unknown type: <%s>' % options.type)
+
   if options.type == 'android_library':
     required_options = ('jar_path',)
     build_utils.CheckOptions(options, parser, required_options)
 
-  deps_configs = build_utils.ParseGypList(options.possible_deps_configs)
-  for c in deps_configs:
+  possible_deps_configs = build_utils.ParseGypList(
+      options.possible_deps_configs)
+  for c in possible_deps_configs:
     if not os.path.exists(c):
       # Currently we only allow deps to things that write build_config files.
       raise Exception('Unknown dep type: ' + c)
 
-  deps_configs = [build_utils.ReadJson(c) for c in deps_configs]
+  direct_deps_config_paths = possible_deps_configs
+  all_deps_config_paths = GetAllDepsConfigsInOrder(direct_deps_config_paths)
+
+  direct_deps_configs = [GetDepConfig(p) for p in direct_deps_config_paths]
+  all_deps_configs = [GetDepConfig(p) for p in all_deps_config_paths]
+
+  direct_library_deps = DepsOfType('android_library', direct_deps_configs)
+  all_resources_deps = DepsOfType('android_resources', all_deps_configs)

[newt (away), 2014/07/07 21:47:12]

all_resources_deps contains only android_resources configs, yet it's used below
when setting srcjars for an android_library config. Is this correct?

[cjhopman, 2014/07/08 00:16:27]

It is. I added a comment below about it.

+
+  # Initialize some common config.
+  config = {
+    'deps_info': {
+      'path': options.build_config,
+      'type': options.type,
+      'deps_configs': direct_deps_config_paths,
+    }
+  }
+  deps_info = config['deps_info']
 
   if options.type == 'android_library':
-    javac_classpath = [c['outputs']['jar_path'] for c in deps_configs]
-    config = {
-      'outputs': {
-        'jar_path': options.jar_path
-      },
-      'javac': {
-        'classpath': javac_classpath
-      }
+    javac_classpath = [c['jar_path'] for c in direct_library_deps]
+    deps_info['jar_path'] = options.jar_path
+    config['javac'] = {
+      'classpath': javac_classpath,
+      'srcjars': [c['srcjar'] for c in all_resources_deps if 'srcjar' in c],
     }
-  else:
-    raise Exception('Unknown type: ' + options.type)
 
-  build_utils.WriteJson(config, options.build_config)
+  if options.type == 'android_resources':
+    deps_info['resources_zip'] = options.resources_zip
+    if options.srcjar:
+      deps_info['srcjar'] = options.srcjar
+    config['resources'] = {}
+    config['resources']['dependency_zips'] = [
+        c['resources_zip'] for c in all_resources_deps]
+
+  build_utils.WriteJson(config, options.build_config, only_if_changed=True)
 
   if options.depfile:
     build_utils.WriteDepfile(
         options.depfile,
-        build_utils.GetPythonDependencies())
+        all_deps_config_paths + build_utils.GetPythonDependencies())
 
 
 if __name__ == '__main__':
   sys.exit(main(sys.argv[1:]))