build/android/gyp/process_resources.py

   1 #!/usr/bin/env python
   2 #
   3 # Copyright (c) 2012 The Chromium Authors. All rights reserved.
   4 # Use of this source code is governed by a BSD-style license that can be
   5 # found in the LICENSE file.
   6
   7 """Process Android resources to generate R.java, and prepare for packaging.
   8
   9 This will crunch images and generate v14 compatible resources
  10 (see generate_v14_compatible_resources.py).
  11 """
  12
  13 import codecs
  14 import optparse
  15 import os
  16 import re
  17 import shutil
  18 import sys
  19 import zipfile
  20
  21 import generate_v14_compatible_resources
  22
  23 from util import build_utils
  24
  25 # Import jinja2 from third_party/jinja2
  26 sys.path.append(os.path.join(os.path.dirname(__file__), '../../../third_party'))
  27 from jinja2 import Template # pylint: disable=F0401
  28
  29
  30 def ParseArgs(args):
  31   """Parses command line options.
  32
  33   Returns:
  34     An options object as from optparse.OptionsParser.parse_args()
  35   """
  36   parser = optparse.OptionParser()
  37   build_utils.AddDepfileOption(parser)
  38
  39   parser.add_option('--android-sdk', help='path to the Android SDK folder')
  40   parser.add_option('--android-sdk-tools',
  41                     help='path to the Android SDK build tools folder')
  42   parser.add_option('--non-constant-id', action='store_true')
  43
  44   parser.add_option('--android-manifest', help='AndroidManifest.xml path')
  45   parser.add_option('--custom-package', help='Java package for R.java')
  46   parser.add_option(
  47       '--shared-resources',
  48       action='store_true',
  49       help='Make a resource package that can be loaded by a different'
  50       'application at runtime to access the package\'s resources.')
  51
  52   parser.add_option('--resource-dirs',
  53                     help='Directories containing resources of this target.')
  54   parser.add_option('--dependencies-res-zips',
  55                     help='Resources from dependents.')
  56
  57   parser.add_option('--resource-zip-out',
  58                     help='Path for output zipped resources.')
  59
  60   parser.add_option('--R-dir',
  61                     help='directory to hold generated R.java.')
  62   parser.add_option('--srcjar-out',
  63                     help='Path to srcjar to contain generated R.java.')
  64   parser.add_option('--r-text-out',
  65                     help='Path to store the R.txt file generated by appt.')
  66
  67   parser.add_option('--proguard-file',
  68                     help='Path to proguard.txt generated file')
  69
  70   parser.add_option(
  71       '--v14-verify-only',
  72       action='store_true',
  73       help='Do not generate v14 resources. Instead, just verify that the '
  74       'resources are already compatible with v14, i.e. they don\'t use '
  75       'attributes that cause crashes on certain devices.')
  76
  77   parser.add_option(
  78       '--extra-res-packages',
  79       help='Additional package names to generate R.java files for')
  80   parser.add_option(
  81       '--extra-r-text-files',
  82       help='For each additional package, the R.txt file should contain a '
  83       'list of resources to be included in the R.java file in the format '
  84       'generated by aapt')
  85   parser.add_option(
  86       '--include-all-resources',
  87       action='store_true',
  88       help='Include every resource ID in every generated R.java file '
  89       '(ignoring R.txt).')
  90
  91   parser.add_option(
  92       '--all-resources-zip-out',
  93       help='Path for output of all resources. This includes resources in '
  94       'dependencies.')
  95
  96   parser.add_option('--stamp', help='File to touch on success')
  97
  98   (options, args) = parser.parse_args(args)
  99
 100   if args:
 101     parser.error('No positional arguments should be given.')
 102
 103   # Check that required options have been provided.
 104   required_options = (
 105       'android_sdk',
 106       'android_sdk_tools',
 107       'android_manifest',
 108       'dependencies_res_zips',
 109       'resource_dirs',
 110       'resource_zip_out',
 111       )
 112   build_utils.CheckOptions(options, parser, required=required_options)
 113
 114   if (options.R_dir is None) == (options.srcjar_out is None):
 115     raise Exception('Exactly one of --R-dir or --srcjar-out must be specified.')
 116
 117   return options
 118
 119
 120 def CreateExtraRJavaFiles(
 121       r_dir, extra_packages, extra_r_text_files, shared_resources, include_all):
 122   if include_all:
 123     java_files = build_utils.FindInDirectory(r_dir, "R.java")
 124     if len(java_files) != 1:
 125       return
 126     r_java_file = java_files[0]
 127     r_java_contents = codecs.open(r_java_file, encoding='utf-8').read()
 128
 129     for package in extra_packages:
 130       package_r_java_dir = os.path.join(r_dir, *package.split('.'))
 131       build_utils.MakeDirectory(package_r_java_dir)
 132       package_r_java_path = os.path.join(package_r_java_dir, 'R.java')
 133       new_r_java = re.sub(r'package [.\w]*;', u'package %s;' % package,
 134                           r_java_contents)
 135       codecs.open(package_r_java_path, 'w', encoding='utf-8').write(new_r_java)
 136   else:
 137     if len(extra_packages) != len(extra_r_text_files):
 138       raise Exception('Need one R.txt file per extra package')
 139
 140     all_resources = {}
 141     r_txt_file = os.path.join(r_dir, 'R.txt')
 142     if not os.path.exists(r_txt_file):
 143       return
 144     with open(r_txt_file) as f:
 145       for line in f:
 146         m = re.match(r'(int(?:\[\])?) (\w+) (\w+) (.+)$', line)
 147         if not m:
 148           raise Exception('Unexpected line in R.txt: %s' % line)
 149         java_type, resource_type, name, value = m.groups()
 150         all_resources[(resource_type, name)] = (java_type, value)
 151
 152     for package, r_text_file in zip(extra_packages, extra_r_text_files):
 153       if os.path.exists(r_text_file):
 154         package_r_java_dir = os.path.join(r_dir, *package.split('.'))
 155         build_utils.MakeDirectory(package_r_java_dir)
 156         package_r_java_path = os.path.join(package_r_java_dir, 'R.java')
 157         CreateExtraRJavaFile(
 158             package, package_r_java_path, r_text_file, all_resources,
 159             shared_resources)
 160
 161
 162 def CreateExtraRJavaFile(
 163       package, r_java_path, r_text_file, all_resources, shared_resources):
 164   resources = {}
 165   with open(r_text_file) as f:
 166     for line in f:
 167       m = re.match(r'int(?:\[\])? (\w+) (\w+) ', line)
 168       if not m:
 169         raise Exception('Unexpected line in R.txt: %s' % line)
 170       resource_type, name = m.groups()
 171       java_type, value = all_resources[(resource_type, name)]
 172       if resource_type not in resources:
 173         resources[resource_type] = []
 174       resources[resource_type].append((name, java_type, value))
 175
 176   template = Template("""/* AUTO-GENERATED FILE.  DO NOT MODIFY. */
 177
 178 package {{ package }};
 179
 180 public final class R {
 181     {% for resource_type in resources %}
 182     public static final class {{ resource_type }} {
 183         {% for name, java_type, value in resources[resource_type] %}
 184         {% if shared_resources %}
 185         public static {{ java_type }} {{ name }} = {{ value }};
 186         {% else %}
 187         public static final {{ java_type }} {{ name }} = {{ value }};
 188         {% endif %}
 189         {% endfor %}
 190     }
 191     {% endfor %}
 192     {% if shared_resources %}
 193     public static void onResourcesLoaded(int packageId) {
 194         {% for resource_type in resources %}
 195         {% for name, java_type, value in resources[resource_type] %}
 196         {% if java_type == 'int[]' %}
 197         for(int i = 0; i < {{ resource_type }}.{{ name }}.length; ++i) {
 198             {{ resource_type }}.{{ name }}[i] =
 199                     ({{ resource_type }}.{{ name }}[i] & 0x00ffffff)
 200                     | (packageId << 24);
 201         }
 202         {% else %}
 203         {{ resource_type }}.{{ name }} =
 204                 ({{ resource_type }}.{{ name }} & 0x00ffffff)
 205                 | (packageId << 24);
 206         {% endif %}
 207         {% endfor %}
 208         {% endfor %}
 209     }
 210     {% endif %}
 211 }
 212 """, trim_blocks=True, lstrip_blocks=True)
 213
 214   output = template.render(package=package, resources=resources,
 215                            shared_resources=shared_resources)
 216   with open(r_java_path, 'w') as f:
 217     f.write(output)
 218
 219
 220 def CrunchDirectory(aapt, input_dir, output_dir):
 221   """Crunches the images in input_dir and its subdirectories into output_dir.
 222
 223   If an image is already optimized, crunching often increases image size. In
 224   this case, the crunched image is overwritten with the original image.
 225   """
 226   aapt_cmd = [aapt,
 227               'crunch',
 228               '-C', output_dir,
 229               '-S', input_dir,
 230               '--ignore-assets', build_utils.AAPT_IGNORE_PATTERN]
 231   build_utils.CheckOutput(aapt_cmd, stderr_filter=FilterCrunchStderr,
 232                           fail_func=DidCrunchFail)
 233
 234   # Check for images whose size increased during crunching and replace them
 235   # with their originals (except for 9-patches, which must be crunched).
 236   for dir_, _, files in os.walk(output_dir):
 237     for crunched in files:
 238       if crunched.endswith('.9.png'):
 239         continue
 240       if not crunched.endswith('.png'):
 241         raise Exception('Unexpected file in crunched dir: ' + crunched)
 242       crunched = os.path.join(dir_, crunched)
 243       original = os.path.join(input_dir, os.path.relpath(crunched, output_dir))
 244       original_size = os.path.getsize(original)
 245       crunched_size = os.path.getsize(crunched)
 246       if original_size < crunched_size:
 247         shutil.copyfile(original, crunched)
 248
 249
 250 def FilterCrunchStderr(stderr):
 251   """Filters out lines from aapt crunch's stderr that can safely be ignored."""
 252   filtered_lines = []
 253   for line in stderr.splitlines(True):
 254     # Ignore this libpng warning, which is a known non-error condition.
 255     # http://crbug.com/364355
 256     if ('libpng warning: iCCP: Not recognizing known sRGB profile that has '
 257         + 'been edited' in line):
 258       continue
 259     filtered_lines.append(line)
 260   return ''.join(filtered_lines)
 261
 262
 263 def DidCrunchFail(returncode, stderr):
 264   """Determines whether aapt crunch failed from its return code and output.
 265
 266   Because aapt's return code cannot be trusted, any output to stderr is
 267   an indication that aapt has failed (http://crbug.com/314885).
 268   """
 269   return returncode != 0 or stderr
 270
 271
 272 def ZipResources(resource_dirs, zip_path):
 273   # Python zipfile does not provide a way to replace a file (it just writes
 274   # another file with the same name). So, first collect all the files to put
 275   # in the zip (with proper overriding), and then zip them.
 276   files_to_zip = dict()
 277   for d in resource_dirs:
 278     for root, _, files in os.walk(d):
 279       for f in files:
 280         archive_path = os.path.join(os.path.relpath(root, d), f)
 281         path = os.path.join(root, f)
 282         files_to_zip[archive_path] = path
 283   with zipfile.ZipFile(zip_path, 'w') as outzip:
 284     for archive_path, path in files_to_zip.iteritems():
 285       outzip.write(path, archive_path)
 286
 287
 288 def CombineZips(zip_files, output_path):
 289   # When packaging resources, if the top-level directories in the zip file are
 290   # of the form 0, 1, ..., then each subdirectory will be passed to aapt as a
 291   # resources directory. While some resources just clobber others (image files,
 292   # etc), other resources (particularly .xml files) need to be more
 293   # intelligently merged. That merging is left up to aapt.
 294   with zipfile.ZipFile(output_path, 'w') as outzip:
 295     for i, z in enumerate(zip_files):
 296       with zipfile.ZipFile(z, 'r') as inzip:
 297         for name in inzip.namelist():
 298           new_name = '%d/%s' % (i, name)
 299           outzip.writestr(new_name, inzip.read(name))
 300
 301
 302 def main():
 303   args = build_utils.ExpandFileArgs(sys.argv[1:])
 304
 305   options = ParseArgs(args)
 306   android_jar = os.path.join(options.android_sdk, 'android.jar')
 307   aapt = os.path.join(options.android_sdk_tools, 'aapt')
 308
 309   input_files = []
 310
 311   with build_utils.TempDir() as temp_dir:
 312     deps_dir = os.path.join(temp_dir, 'deps')
 313     build_utils.MakeDirectory(deps_dir)
 314     v14_dir = os.path.join(temp_dir, 'v14')
 315     build_utils.MakeDirectory(v14_dir)
 316
 317     gen_dir = os.path.join(temp_dir, 'gen')
 318     build_utils.MakeDirectory(gen_dir)
 319
 320     input_resource_dirs = build_utils.ParseGypList(options.resource_dirs)
 321
 322     for resource_dir in input_resource_dirs:
 323       generate_v14_compatible_resources.GenerateV14Resources(
 324           resource_dir,
 325           v14_dir,
 326           options.v14_verify_only)
 327
 328     dep_zips = build_utils.ParseGypList(options.dependencies_res_zips)
 329     input_files += dep_zips
 330     dep_subdirs = []
 331     for z in dep_zips:
 332       subdir = os.path.join(deps_dir, os.path.basename(z))
 333       if os.path.exists(subdir):
 334         raise Exception('Resource zip name conflict: ' + os.path.basename(z))
 335       build_utils.ExtractAll(z, path=subdir)
 336       dep_subdirs.append(subdir)
 337
 338     # Generate R.java. This R.java contains non-final constants and is used only
 339     # while compiling the library jar (e.g. chromium_content.jar). When building
 340     # an apk, a new R.java file with the correct resource -> ID mappings will be
 341     # generated by merging the resources from all libraries and the main apk
 342     # project.
 343     package_command = [aapt,
 344                        'package',
 345                        '-m',
 346                        '-M', options.android_manifest,
 347                        '--auto-add-overlay',
 348                        '-I', android_jar,
 349                        '--output-text-symbols', gen_dir,
 350                        '-J', gen_dir,
 351                        '--ignore-assets', build_utils.AAPT_IGNORE_PATTERN]
 352
 353     for d in input_resource_dirs:
 354       package_command += ['-S', d]
 355
 356     for d in dep_subdirs:
 357       package_command += ['-S', d]
 358
 359     if options.non_constant_id:
 360       package_command.append('--non-constant-id')
 361     if options.custom_package:
 362       package_command += ['--custom-package', options.custom_package]
 363     if options.proguard_file:
 364       package_command += ['-G', options.proguard_file]
 365     if options.shared_resources:
 366       package_command.append('--shared-lib')
 367     build_utils.CheckOutput(package_command, print_stderr=False)
 368
 369     if options.extra_res_packages:
 370       CreateExtraRJavaFiles(
 371           gen_dir,
 372           build_utils.ParseGypList(options.extra_res_packages),
 373           build_utils.ParseGypList(options.extra_r_text_files),
 374           options.shared_resources,
 375           options.include_all_resources)
 376
 377     # This is the list of directories with resources to put in the final .zip
 378     # file. The order of these is important so that crunched/v14 resources
 379     # override the normal ones.
 380     zip_resource_dirs = input_resource_dirs + [v14_dir]
 381
 382     base_crunch_dir = os.path.join(temp_dir, 'crunch')
 383
 384     # Crunch image resources. This shrinks png files and is necessary for
 385     # 9-patch images to display correctly. 'aapt crunch' accepts only a single
 386     # directory at a time and deletes everything in the output directory.
 387     for idx, input_dir in enumerate(input_resource_dirs):
 388       crunch_dir = os.path.join(base_crunch_dir, str(idx))
 389       build_utils.MakeDirectory(crunch_dir)
 390       zip_resource_dirs.append(crunch_dir)
 391       CrunchDirectory(aapt, input_dir, crunch_dir)
 392
 393     ZipResources(zip_resource_dirs, options.resource_zip_out)
 394
 395     if options.all_resources_zip_out:
 396       CombineZips([options.resource_zip_out] + dep_zips,
 397                   options.all_resources_zip_out)
 398
 399     if options.R_dir:
 400       build_utils.DeleteDirectory(options.R_dir)
 401       shutil.copytree(gen_dir, options.R_dir)
 402     else:
 403       build_utils.ZipDir(options.srcjar_out, gen_dir)
 404
 405     if options.r_text_out:
 406       r_text_path = os.path.join(gen_dir, 'R.txt')
 407       if os.path.exists(r_text_path):
 408         shutil.copyfile(r_text_path, options.r_text_out)
 409       else:
 410         open(options.r_text_out, 'w').close()
 411
 412   if options.depfile:
 413     input_files += build_utils.GetPythonDependencies()
 414     build_utils.WriteDepfile(options.depfile, input_files)
 415
 416   if options.stamp:
 417     build_utils.Touch(options.stamp)
 418
 419
 420 if __name__ == '__main__':
 421   main()