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 #  res_extra_dirs - A list of extra directories containing Android resources.
  43 #    These directories may be generated at build time.
  44 #  res_extra_files - A list of the files in res_extra_dirs.
  45 #  never_lint - Set to 1 to not run lint on this target.
  46
  47 {
  48   'dependencies': [
  49     '<(DEPTH)/build/android/setup.gyp:build_output_dirs'
  50   ],
  51   'variables': {
  52     'android_jar': '<(android_sdk)/android.jar',
  53     'input_jars_paths': [ '<(android_jar)' ],
  54     'additional_src_dirs': [],
  55     'javac_includes': [],
  56     'jar_name': '<(_target_name).jar',
  57     'jar_dir': '<(PRODUCT_DIR)/lib.java',
  58     'jar_path': '<(intermediate_dir)/<(jar_name)',
  59     'jar_final_path': '<(jar_dir)/<(jar_name)',
  60     'jar_excluded_classes': [ '*/R.class', '*/R##*.class' ],
  61     'instr_stamp': '<(intermediate_dir)/instr.stamp',
  62     'additional_input_paths': [],
  63     'dex_path': '<(PRODUCT_DIR)/lib.java/<(_target_name).dex.jar',
  64     'generated_src_dirs': ['>@(generated_R_dirs)'],
  65     'generated_R_dirs': [],
  66     'has_java_resources%': 0,
  67     'res_extra_dirs': [],
  68     'res_extra_files': [],
  69     'res_v14_verify_only%': 0,
  70     'resource_input_paths': ['>@(res_extra_files)'],
  71     'intermediate_dir': '<(SHARED_INTERMEDIATE_DIR)/<(_target_name)',
  72     'classes_dir': '<(intermediate_dir)/classes',
  73     'compile_stamp': '<(intermediate_dir)/compile.stamp',
  74     'lint_stamp': '<(intermediate_dir)/lint.stamp',
  75     'lint_result': '<(intermediate_dir)/lint_result.xml',
  76     'lint_config': '<(intermediate_dir)/lint_config.xml',
  77     'never_lint%': 0,
  78     'proguard_config%': '',
  79     'proguard_preprocess%': '0',
  80     'variables': {
  81       'variables': {
  82         'proguard_preprocess%': 0,
  83         'emma_never_instrument%': 0,
  84       },
  85       'conditions': [
  86         ['proguard_preprocess == 1', {
  87           'javac_jar_path': '<(intermediate_dir)/<(_target_name).pre.jar'
  88         }, {
  89           'javac_jar_path': '<(jar_path)'
  90         }],
  91         ['chromium_code != 0 and emma_coverage != 0 and emma_never_instrument == 0', {
  92           'emma_instrument': 1,
  93         }, {
  94           'emma_instrument': 0,
  95         }],
  96       ],
  97     },
  98     'emma_instrument': '<(emma_instrument)',
  99     'javac_jar_path': '<(javac_jar_path)',
 100   },
 101   # This all_dependent_settings is used for java targets only. This will add the
 102   # jar path to the classpath of dependent java targets.
 103   'all_dependent_settings': {
 104     'variables': {
 105       'input_jars_paths': ['<(jar_final_path)'],
 106       'library_dexed_jars_paths': ['<(dex_path)'],
 107     },
 108   },
 109   'conditions': [
 110     ['has_java_resources == 1', {
 111       'variables': {
 112         'res_dir': '<(java_in_dir)/res',
 113         'res_crunched_dir': '<(intermediate_dir)/res_crunched',
 114         'res_v14_compatibility_stamp': '<(intermediate_dir)/res_v14_compatibility.stamp',
 115         'res_v14_compatibility_dir': '<(intermediate_dir)/res_v14_compatibility',
 116         'res_input_dirs': ['<(res_dir)', '<@(res_extra_dirs)'],
 117         'resource_input_paths': ['<!@(find <(res_dir) -type f)'],
 118         'R_dir': '<(intermediate_dir)/java_R',
 119         'R_text_file': '<(R_dir)/R.txt',
 120         'R_stamp': '<(intermediate_dir)/resources.stamp',
 121         'generated_src_dirs': ['<(R_dir)'],
 122         'additional_input_paths': ['<(R_stamp)',
 123                                    '<(res_v14_compatibility_stamp)',],
 124         'additional_res_dirs': [],
 125         'dependencies_res_input_dirs': [],
 126         'dependencies_res_files': [],
 127       },
 128       'all_dependent_settings': {
 129         'variables': {
 130           # Dependent jars include this target's R.java file via
 131           # generated_R_dirs and include its resources via
 132           # dependencies_res_files.
 133           'generated_R_dirs': ['<(R_dir)'],
 134           'additional_input_paths': ['<(R_stamp)',
 135                                      '<(res_v14_compatibility_stamp)',],
 136           'dependencies_res_files': ['<@(resource_input_paths)'],
 137
 138           'dependencies_res_input_dirs': ['<@(res_input_dirs)'],
 139
 140           # Dependent APKs include this target's resources via
 141           # additional_res_dirs, additional_res_packages, and
 142           # additional_R_text_files.
 143           'additional_res_dirs': ['<(res_crunched_dir)',
 144                                   '<(res_v14_compatibility_dir)',
 145                                   '<@(res_input_dirs)'],
 146           'additional_res_packages': ['<(R_package)'],
 147           'additional_R_text_files': ['<(R_text_file)'],
 148         },
 149       },
 150       'actions': [
 151         # Generate R.java and crunch image resources.
 152         {
 153           'action_name': 'process_resources',
 154           'message': 'processing resources for <(_target_name)',
 155           'variables': {
 156             'android_manifest': '<(DEPTH)/build/android/AndroidManifest.xml',
 157             # Include the dependencies' res dirs so that references to
 158             # resources in dependencies can be resolved.
 159             'all_res_dirs': ['<@(res_input_dirs)',
 160                              '>@(dependencies_res_input_dirs)',],
 161             # Write the inputs list to a file, so that its mtime is updated when
 162             # the list of inputs changes.
 163             'inputs_list_file': '>|(java_resources.<(_target_name).gypcmd >@(resource_input_paths) >@(dependencies_res_files))'
 164           },
 165           'inputs': [
 166             '<(DEPTH)/build/android/gyp/util/build_utils.py',
 167             '<(DEPTH)/build/android/gyp/process_resources.py',
 168             '>@(resource_input_paths)',
 169             '>@(dependencies_res_files)',
 170             '>(inputs_list_file)',
 171           ],
 172           'outputs': [
 173             '<(R_stamp)',
 174           ],
 175           'action': [
 176             'python', '<(DEPTH)/build/android/gyp/process_resources.py',
 177             '--android-sdk', '<(android_sdk)',
 178             '--android-sdk-tools', '<(android_sdk_tools)',
 179             '--R-dir', '<(R_dir)',
 180             '--res-dirs', '>(all_res_dirs)',
 181             '--crunch-input-dir', '>(res_dir)',
 182             '--crunch-output-dir', '<(res_crunched_dir)',
 183             '--android-manifest', '<(android_manifest)',
 184             '--non-constant-id',
 185             '--custom-package', '<(R_package)',
 186             '--stamp', '<(R_stamp)',
 187           ],
 188         },
 189         # Generate API 14 resources.
 190         {
 191           'action_name': 'generate_api_14_resources_<(_target_name)',
 192           'message': 'Generating Android API 14 resources <(_target_name)',
 193           'variables' : {
 194             'res_v14_additional_options': [],
 195           },
 196           'conditions': [
 197             ['res_v14_verify_only == 1', {
 198               'variables': {
 199                 'res_v14_additional_options': ['--verify-only']
 200               },
 201             }],
 202           ],
 203           'inputs': [
 204             '<(DEPTH)/build/android/gyp/util/build_utils.py',
 205             '<(DEPTH)/build/android/gyp/generate_v14_compatible_resources.py',
 206             '>@(resource_input_paths)',
 207           ],
 208           'outputs': [
 209             '<(res_v14_compatibility_stamp)',
 210           ],
 211           'action': [
 212             'python', '<(DEPTH)/build/android/gyp/generate_v14_compatible_resources.py',
 213             '--res-dir=<(res_dir)',
 214             '--res-v14-compatibility-dir=<(res_v14_compatibility_dir)',
 215             '--stamp', '<(res_v14_compatibility_stamp)',
 216             '<@(res_v14_additional_options)',
 217           ]
 218         },
 219       ],
 220     }],
 221     ['proguard_preprocess == 1', {
 222       'actions': [
 223         {
 224           'action_name': 'proguard_<(_target_name)',
 225           'message': 'Proguard preprocessing <(_target_name) jar',
 226           'inputs': [
 227             '<(android_sdk_root)/tools/proguard/bin/proguard.sh',
 228             '<(DEPTH)/build/android/gyp/util/build_utils.py',
 229             '<(DEPTH)/build/android/gyp/proguard.py',
 230             '<(javac_jar_path)',
 231             '<(proguard_config)',
 232           ],
 233           'outputs': [
 234             '<(jar_path)',
 235           ],
 236           'action': [
 237             'python', '<(DEPTH)/build/android/gyp/proguard.py',
 238             '--proguard-path=<(android_sdk_root)/tools/proguard/bin/proguard.sh',
 239             '--input-path=<(javac_jar_path)',
 240             '--output-path=<(jar_path)',
 241             '--proguard-config=<(proguard_config)',
 242             '--classpath=<(android_sdk_jar) >(input_jars_paths)',
 243           ]
 244         },
 245       ],
 246     }],
 247   ],
 248   'actions': [
 249     {
 250       'action_name': 'javac_<(_target_name)',
 251       'message': 'Compiling <(_target_name) java sources',
 252       'variables': {
 253         'java_sources': ['>!@(find >(java_in_dir)/src >(additional_src_dirs) -name "*.java")'],
 254       },
 255       'inputs': [
 256         '<(DEPTH)/build/android/gyp/util/build_utils.py',
 257         '<(DEPTH)/build/android/gyp/javac.py',
 258         '>@(java_sources)',
 259         '>@(input_jars_paths)',
 260         '>@(additional_input_paths)',
 261       ],
 262       'outputs': [
 263         '<(compile_stamp)',
 264       ],
 265       'action': [
 266         'python', '<(DEPTH)/build/android/gyp/javac.py',
 267         '--output-dir=<(classes_dir)',
 268         '--classpath=>(input_jars_paths)',
 269         '--src-gendirs=>(generated_src_dirs)',
 270         '--javac-includes=<(javac_includes)',
 271         '--chromium-code=<(chromium_code)',
 272         '--stamp=<(compile_stamp)',
 273         '>@(java_sources)',
 274       ]
 275     },
 276     {
 277       'variables': {
 278         'src_dirs': [
 279           '<(java_in_dir)/src',
 280           '>@(additional_src_dirs)',
 281         ],
 282         'stamp_path': '<(lint_stamp)',
 283         'result_path': '<(lint_result)',
 284         'config_path': '<(lint_config)',
 285       },
 286       'inputs': [
 287         '<(compile_stamp)',
 288       ],
 289       'outputs': [
 290         '<(lint_stamp)',
 291       ],
 292       'includes': [ 'android/lint_action.gypi' ],
 293     },
 294     {
 295       'action_name': 'jar_<(_target_name)',
 296       'message': 'Creating <(_target_name) jar',
 297       'inputs': [
 298         '<(DEPTH)/build/android/gyp/util/build_utils.py',
 299         '<(DEPTH)/build/android/gyp/util/md5_check.py',
 300         '<(DEPTH)/build/android/gyp/jar.py',
 301         '<(compile_stamp)',
 302       ],
 303       'outputs': [
 304         '<(javac_jar_path)',
 305       ],
 306       'action': [
 307         'python', '<(DEPTH)/build/android/gyp/jar.py',
 308         '--classes-dir=<(classes_dir)',
 309         '--jar-path=<(javac_jar_path)',
 310         '--excluded-classes=<(jar_excluded_classes)',
 311       ]
 312     },
 313     {
 314       'action_name': 'instr_jar_<(_target_name)',
 315       'message': 'Instrumenting <(_target_name) jar',
 316       'variables': {
 317         'input_path': '<(jar_path)',
 318         'output_path': '<(jar_final_path)',
 319         'stamp_path': '<(instr_stamp)',
 320         'instr_type': 'jar',
 321       },
 322       'outputs': [
 323         '<(jar_final_path)',
 324       ],
 325       'inputs': [
 326         '<(jar_path)',
 327       ],
 328       'includes': [ 'android/instr_action.gypi' ],
 329     },
 330     {
 331       'action_name': 'jar_toc_<(_target_name)',
 332       'message': 'Creating <(_target_name) jar.TOC',
 333       'inputs': [
 334         '<(DEPTH)/build/android/gyp/util/build_utils.py',
 335         '<(DEPTH)/build/android/gyp/util/md5_check.py',
 336         '<(DEPTH)/build/android/gyp/jar_toc.py',
 337         '<(jar_final_path)',
 338       ],
 339       'outputs': [
 340         '<(jar_final_path).TOC',
 341       ],
 342       'action': [
 343         'python', '<(DEPTH)/build/android/gyp/jar_toc.py',
 344         '--jar-path=<(jar_final_path)',
 345         '--toc-path=<(jar_final_path).TOC',
 346       ]
 347     },
 348     {
 349       'action_name': 'dex_<(_target_name)',
 350       'variables': {
 351         'conditions': [
 352           ['emma_instrument != 0', {
 353             'dex_no_locals': 1,
 354           }],
 355         ],
 356         'dex_input_paths': [ '<(jar_final_path)' ],
 357         'output_path': '<(dex_path)',
 358       },
 359       'includes': [ 'android/dex_action.gypi' ],
 360     },
 361   ],
 362 }