build/java.gypi

   1 # Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 # Use of this source code is governed by a BSD-style license that can be
   3 # found in the LICENSE file.
   4
   5 # This file is meant to be included into a target to provide a rule
   6 # to build Java in a consistent manner.
   7 #
   8 # To use this, create a gyp target with the following form:
   9 # {
  10 #   'target_name': 'my-package_java',
  11 #   'type': 'none',
  12 #   'variables': {
  13 #     'java_in_dir': 'path/to/package/root',
  14 #   },
  15 #   'includes': ['path/to/this/gypi/file'],
  16 # }
  17 #
  18 # Required variables:
  19 #  java_in_dir - The top-level java directory. The src should be in
  20 #    <java_in_dir>/src.
  21 # Optional/automatic variables:
  22 #  additional_input_paths - These paths will be included in the 'inputs' list to
  23 #    ensure that this target is rebuilt when one of these paths changes.
  24 #  additional_src_dirs - Additional directories with .java files to be compiled
  25 #    and included in the output of this target.
  26 #  generated_src_dirs - Same as additional_src_dirs except used for .java files
  27 #    that are generated at build time. This should be set automatically by a
  28 #    target's dependencies. The .java files in these directories are not
  29 #    included in the 'inputs' list (unlike additional_src_dirs).
  30 #  input_jars_paths - The path to jars to be included in the classpath. This
  31 #    should be filled automatically by depending on the appropriate targets.
  32 #  javac_includes - A list of specific files to include. This is by default
  33 #    empty, which leads to inclusion of all files specified. May include
  34 #    wildcard, and supports '**/' for recursive path wildcards, ie.:
  35 #    '**/MyFileRegardlessOfDirectory.java', '**/IncludedPrefix*.java'.
  36 #  has_java_resources - Set to 1 if the java target contains an
  37 #    Android-compatible resources folder named res.  If 1, R_package and
  38 #    R_package_relpath must also be set.
  39 #  R_package - The java package in which the R class (which maps resources to
  40 #    integer IDs) should be generated, e.g. org.chromium.content.
  41 #  R_package_relpath - Same as R_package, but replace each '.' with '/'.
  42 #  java_strings_grd - The name of the grd file from which to generate localized
  43 #    strings.xml files, if any.
  44 #  res_extra_dirs - A list of extra directories containing Android resources.
  45 #    These directories may be generated at build time.
  46 #  res_extra_files - A list of the files in res_extra_dirs.
  47 #  never_lint - Set to 1 to not run lint on this target.
  48
  49 {
  50   'dependencies': [
  51     '<(DEPTH)/build/android/setup.gyp:build_output_dirs'
  52   ],
  53   'variables': {
  54     'android_jar': '<(android_sdk)/android.jar',
  55     'input_jars_paths': [ '<(android_jar)' ],
  56     'additional_src_dirs': [],
  57     'javac_includes': [],
  58     'jar_name': '<(_target_name).jar',
  59     'jar_dir': '<(PRODUCT_DIR)/lib.java',
  60     'jar_path': '<(intermediate_dir)/<(jar_name)',
  61     'jar_final_path': '<(jar_dir)/<(jar_name)',
  62     'jar_excluded_classes': [ '*/R.class', '*/R##*.class' ],
  63     'instr_stamp': '<(intermediate_dir)/instr.stamp',
  64     'additional_input_paths': [],
  65     'dex_path': '<(PRODUCT_DIR)/lib.java/<(_target_name).dex.jar',
  66     'generated_src_dirs': ['>@(generated_R_dirs)'],
  67     'generated_R_dirs': [],
  68     'has_java_resources%': 0,
  69     'java_strings_grd%': '',
  70     'res_extra_dirs': [],
  71     'res_extra_files': [],
  72     'res_v14_verify_only%': 0,
  73     'resource_input_paths': ['>@(res_extra_files)'],
  74     'intermediate_dir': '<(SHARED_INTERMEDIATE_DIR)/<(_target_name)',
  75     'classes_dir': '<(intermediate_dir)/classes',
  76     'compile_stamp': '<(intermediate_dir)/compile.stamp',
  77     'lint_stamp': '<(intermediate_dir)/lint.stamp',
  78     'lint_result': '<(intermediate_dir)/lint_result.xml',
  79     'lint_config': '<(intermediate_dir)/lint_config.xml',
  80     'never_lint%': 0,
  81     'proguard_config%': '',
  82     'proguard_preprocess%': '0',
  83     'variables': {
  84       'variables': {
  85         'proguard_preprocess%': 0,
  86         'emma_never_instrument%': 0,
  87       },
  88       'conditions': [
  89         ['proguard_preprocess == 1', {
  90           'javac_jar_path': '<(intermediate_dir)/<(_target_name).pre.jar'
  91         }, {
  92           'javac_jar_path': '<(jar_path)'
  93         }],
  94         ['chromium_code != 0 and emma_coverage != 0 and emma_never_instrument == 0', {
  95           'emma_instrument': 1,
  96         }, {
  97           'emma_instrument': 0,
  98         }],
  99       ],
 100     },
 101     'emma_instrument': '<(emma_instrument)',
 102     'javac_jar_path': '<(javac_jar_path)',
 103   },
 104   # This all_dependent_settings is used for java targets only. This will add the
 105   # jar path to the classpath of dependent java targets.
 106   'all_dependent_settings': {
 107     'variables': {
 108       'input_jars_paths': ['<(jar_final_path)'],
 109       'library_dexed_jars_paths': ['<(dex_path)'],
 110     },
 111   },
 112   'conditions': [
 113     ['has_java_resources == 1', {
 114       'variables': {
 115         'res_dir': '<(java_in_dir)/res',
 116         'res_crunched_dir': '<(intermediate_dir)/res_crunched',
 117         'res_v14_compatibility_stamp': '<(intermediate_dir)/res_v14_compatibility.stamp',
 118         'res_v14_compatibility_dir': '<(intermediate_dir)/res_v14_compatibility',
 119         'res_input_dirs': ['<(res_dir)', '<@(res_extra_dirs)'],
 120         'resource_input_paths': ['<!@(find <(res_dir) -type f)'],
 121         'R_dir': '<(intermediate_dir)/java_R',
 122         'R_text_file': '<(R_dir)/R.txt',
 123         'R_stamp': '<(intermediate_dir)/resources.stamp',
 124         'generated_src_dirs': ['<(R_dir)'],
 125         'additional_input_paths': ['<(R_stamp)',
 126                                    '<(res_v14_compatibility_stamp)',],
 127         'additional_res_dirs': [],
 128         'dependencies_res_input_dirs': [],
 129         'dependencies_res_files': [],
 130       },
 131       'all_dependent_settings': {
 132         'variables': {
 133           # Dependent jars include this target's R.java file via
 134           # generated_R_dirs and include its resources via
 135           # dependencies_res_files.
 136           'generated_R_dirs': ['<(R_dir)'],
 137           'additional_input_paths': ['<(R_stamp)',
 138                                      '<(res_v14_compatibility_stamp)',],
 139           'dependencies_res_files': ['<@(resource_input_paths)'],
 140
 141           'dependencies_res_input_dirs': ['<@(res_input_dirs)'],
 142
 143           # Dependent APKs include this target's resources via
 144           # additional_res_dirs, additional_res_packages, and
 145           # additional_R_text_files.
 146           'additional_res_dirs': ['<(res_crunched_dir)',
 147                                   '<(res_v14_compatibility_dir)',
 148                                   '<@(res_input_dirs)'],
 149           'additional_res_packages': ['<(R_package)'],
 150           'additional_R_text_files': ['<(R_text_file)'],
 151         },
 152       },
 153       'conditions': [
 154         ['java_strings_grd != ""', {
 155           'variables': {
 156             'res_grit_dir': '<(intermediate_dir)/res_grit',
 157             'res_input_dirs': ['<(res_grit_dir)'],
 158             'grit_grd_file': '<(java_in_dir)/strings/<(java_strings_grd)',
 159             'resource_input_paths': ['<!@pymod_do_main(grit_info <@(grit_defines) --outputs "<(res_grit_dir)" <(grit_grd_file))'],
 160           },
 161           'actions': [
 162             {
 163               'action_name': 'generate_localized_strings_xml',
 164               'variables': {
 165                 'grit_additional_defines': ['-E', 'ANDROID_JAVA_TAGGED_ONLY=false'],
 166                 'grit_out_dir': '<(res_grit_dir)',
 167                 # resource_ids is unneeded since we don't generate .h headers.
 168                 'grit_resource_ids': '',
 169               },
 170               'includes': ['../build/grit_action.gypi'],
 171             },
 172           ],
 173         }],
 174       ],
 175       'actions': [
 176         # Generate R.java and crunch image resources.
 177         {
 178           'action_name': 'process_resources',
 179           'message': 'processing resources for <(_target_name)',
 180           'variables': {
 181             'android_manifest': '<(DEPTH)/build/android/AndroidManifest.xml',
 182             # Include the dependencies' res dirs so that references to
 183             # resources in dependencies can be resolved.
 184             'all_res_dirs': ['<@(res_input_dirs)',
 185                              '>@(dependencies_res_input_dirs)',],
 186             # Write the inputs list to a file, so that its mtime is updated when
 187             # the list of inputs changes.
 188             'inputs_list_file': '>|(java_resources.<(_target_name).gypcmd >@(resource_input_paths) >@(dependencies_res_files))'
 189           },
 190           'inputs': [
 191             '<(DEPTH)/build/android/gyp/util/build_utils.py',
 192             '<(DEPTH)/build/android/gyp/process_resources.py',
 193             '>@(resource_input_paths)',
 194             '>@(dependencies_res_files)',
 195             '>(inputs_list_file)',
 196           ],
 197           'outputs': [
 198             '<(R_stamp)',
 199           ],
 200           'action': [
 201             'python', '<(DEPTH)/build/android/gyp/process_resources.py',
 202             '--android-sdk', '<(android_sdk)',
 203             '--android-sdk-tools', '<(android_sdk_tools)',
 204             '--R-dir', '<(R_dir)',
 205             '--res-dirs', '>(all_res_dirs)',
 206             '--crunch-input-dir', '>(res_dir)',
 207             '--crunch-output-dir', '<(res_crunched_dir)',
 208             '--android-manifest', '<(android_manifest)',
 209             '--non-constant-id',
 210             '--custom-package', '<(R_package)',
 211             '--stamp', '<(R_stamp)',
 212           ],
 213         },
 214         # Generate API 14 resources.
 215         {
 216           'action_name': 'generate_api_14_resources_<(_target_name)',
 217           'message': 'Generating Android API 14 resources <(_target_name)',
 218           'variables' : {
 219             'res_v14_additional_options': [],
 220           },
 221           'conditions': [
 222             ['res_v14_verify_only == 1', {
 223               'variables': {
 224                 'res_v14_additional_options': ['--verify-only']
 225               },
 226             }],
 227           ],
 228           'inputs': [
 229             '<(DEPTH)/build/android/gyp/util/build_utils.py',
 230             '<(DEPTH)/build/android/gyp/generate_v14_compatible_resources.py',
 231             '>@(resource_input_paths)',
 232           ],
 233           'outputs': [
 234             '<(res_v14_compatibility_stamp)',
 235           ],
 236           'action': [
 237             'python', '<(DEPTH)/build/android/gyp/generate_v14_compatible_resources.py',
 238             '--res-dir=<(res_dir)',
 239             '--res-v14-compatibility-dir=<(res_v14_compatibility_dir)',
 240             '--stamp', '<(res_v14_compatibility_stamp)',
 241             '<@(res_v14_additional_options)',
 242           ]
 243         },
 244       ],
 245     }],
 246     ['proguard_preprocess == 1', {
 247       'actions': [
 248         {
 249           'action_name': 'proguard_<(_target_name)',
 250           'message': 'Proguard preprocessing <(_target_name) jar',
 251           'inputs': [
 252             '<(android_sdk_root)/tools/proguard/bin/proguard.sh',
 253             '<(DEPTH)/build/android/gyp/util/build_utils.py',
 254             '<(DEPTH)/build/android/gyp/proguard.py',
 255             '<(javac_jar_path)',
 256             '<(proguard_config)',
 257           ],
 258           'outputs': [
 259             '<(jar_path)',
 260           ],
 261           'action': [
 262             'python', '<(DEPTH)/build/android/gyp/proguard.py',
 263             '--proguard-path=<(android_sdk_root)/tools/proguard/bin/proguard.sh',
 264             '--input-path=<(javac_jar_path)',
 265             '--output-path=<(jar_path)',
 266             '--proguard-config=<(proguard_config)',
 267             '--classpath=<(android_sdk_jar) >(input_jars_paths)',
 268           ]
 269         },
 270       ],
 271     }],
 272   ],
 273   'actions': [
 274     {
 275       'action_name': 'javac_<(_target_name)',
 276       'message': 'Compiling <(_target_name) java sources',
 277       'variables': {
 278         'java_sources': ['>!@(find >(java_in_dir)/src >(additional_src_dirs) -name "*.java")'],
 279       },
 280       'inputs': [
 281         '<(DEPTH)/build/android/gyp/util/build_utils.py',
 282         '<(DEPTH)/build/android/gyp/javac.py',
 283         '>@(java_sources)',
 284         '>@(input_jars_paths)',
 285         '>@(additional_input_paths)',
 286       ],
 287       'outputs': [
 288         '<(compile_stamp)',
 289       ],
 290       'action': [
 291         'python', '<(DEPTH)/build/android/gyp/javac.py',
 292         '--output-dir=<(classes_dir)',
 293         '--classpath=>(input_jars_paths)',
 294         '--src-gendirs=>(generated_src_dirs)',
 295         '--javac-includes=<(javac_includes)',
 296         '--chromium-code=<(chromium_code)',
 297         '--stamp=<(compile_stamp)',
 298         '>@(java_sources)',
 299       ]
 300     },
 301     {
 302       'variables': {
 303         'src_dirs': [
 304           '<(java_in_dir)/src',
 305           '>@(additional_src_dirs)',
 306         ],
 307         'stamp_path': '<(lint_stamp)',
 308         'result_path': '<(lint_result)',
 309         'config_path': '<(lint_config)',
 310       },
 311       'inputs': [
 312         '<(compile_stamp)',
 313       ],
 314       'outputs': [
 315         '<(lint_stamp)',
 316       ],
 317       'includes': [ 'android/lint_action.gypi' ],
 318     },
 319     {
 320       'action_name': 'jar_<(_target_name)',
 321       'message': 'Creating <(_target_name) jar',
 322       'inputs': [
 323         '<(DEPTH)/build/android/gyp/util/build_utils.py',
 324         '<(DEPTH)/build/android/gyp/util/md5_check.py',
 325         '<(DEPTH)/build/android/gyp/jar.py',
 326         '<(compile_stamp)',
 327       ],
 328       'outputs': [
 329         '<(javac_jar_path)',
 330       ],
 331       'action': [
 332         'python', '<(DEPTH)/build/android/gyp/jar.py',
 333         '--classes-dir=<(classes_dir)',
 334         '--jar-path=<(javac_jar_path)',
 335         '--excluded-classes=<(jar_excluded_classes)',
 336       ]
 337     },
 338     {
 339       'action_name': 'instr_jar_<(_target_name)',
 340       'message': 'Instrumenting <(_target_name) jar',
 341       'variables': {
 342         'input_path': '<(jar_path)',
 343         'output_path': '<(jar_final_path)',
 344         'stamp_path': '<(instr_stamp)',
 345         'instr_type': 'jar',
 346       },
 347       'outputs': [
 348         '<(jar_final_path)',
 349       ],
 350       'inputs': [
 351         '<(jar_path)',
 352       ],
 353       'includes': [ 'android/instr_action.gypi' ],
 354     },
 355     {
 356       'action_name': 'jar_toc_<(_target_name)',
 357       'message': 'Creating <(_target_name) jar.TOC',
 358       'inputs': [
 359         '<(DEPTH)/build/android/gyp/util/build_utils.py',
 360         '<(DEPTH)/build/android/gyp/util/md5_check.py',
 361         '<(DEPTH)/build/android/gyp/jar_toc.py',
 362         '<(jar_final_path)',
 363       ],
 364       'outputs': [
 365         '<(jar_final_path).TOC',
 366       ],
 367       'action': [
 368         'python', '<(DEPTH)/build/android/gyp/jar_toc.py',
 369         '--jar-path=<(jar_final_path)',
 370         '--toc-path=<(jar_final_path).TOC',
 371       ]
 372     },
 373     {
 374       'action_name': 'dex_<(_target_name)',
 375       'variables': {
 376         'conditions': [
 377           ['emma_instrument != 0', {
 378             'dex_no_locals': 1,
 379           }],
 380         ],
 381         'dex_input_paths': [ '<(jar_final_path)' ],
 382         'output_path': '<(dex_path)',
 383       },
 384       'includes': [ 'android/dex_action.gypi' ],
 385     },
 386   ],
 387 }