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 #  add_to_dependents_classpaths - Set to 0 if the resulting jar file should not
  23 #    be added to its dependents' classpaths.
  24 #  additional_input_paths - These paths will be included in the 'inputs' list to
  25 #    ensure that this target is rebuilt when one of these paths changes.
  26 #  additional_src_dirs - Additional directories with .java files to be compiled
  27 #    and included in the output of this target.
  28 #  generated_src_dirs - Same as additional_src_dirs except used for .java files
  29 #    that are generated at build time. This should be set automatically by a
  30 #    target's dependencies. The .java files in these directories are not
  31 #    included in the 'inputs' list (unlike additional_src_dirs).
  32 #  input_jars_paths - The path to jars to be included in the classpath. This
  33 #    should be filled automatically by depending on the appropriate targets.
  34 #  javac_includes - A list of specific files to include. This is by default
  35 #    empty, which leads to inclusion of all files specified. May include
  36 #    wildcard, and supports '**/' for recursive path wildcards, ie.:
  37 #    '**/MyFileRegardlessOfDirectory.java', '**/IncludedPrefix*.java'.
  38 #  has_java_resources - Set to 1 if the java target contains an
  39 #    Android-compatible resources folder named res.  If 1, R_package and
  40 #    R_package_relpath must also be set.
  41 #  R_package - The java package in which the R class (which maps resources to
  42 #    integer IDs) should be generated, e.g. org.chromium.content.
  43 #  R_package_relpath - Same as R_package, but replace each '.' with '/'.
  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     'add_to_dependents_classpaths%': 1,
  55     'android_jar': '<(android_sdk)/android.jar',
  56     'input_jars_paths': [ '<(android_jar)' ],
  57     'additional_src_dirs': [],
  58     'javac_includes': [],
  59     'jar_name': '<(_target_name).jar',
  60     'jar_dir': '<(PRODUCT_DIR)/lib.java',
  61     'jar_path': '<(intermediate_dir)/<(jar_name)',
  62     'jar_final_path': '<(jar_dir)/<(jar_name)',
  63     'jar_excluded_classes': [ '*/R.class', '*/R##*.class' ],
  64     'instr_stamp': '<(intermediate_dir)/instr.stamp',
  65     'additional_input_paths': [],
  66     'dex_path': '<(PRODUCT_DIR)/lib.java/<(_target_name).dex.jar',
  67     'main_dex_list_path': '<(intermediate_dir)/main_dex_list.txt',
  68     'generated_src_dirs': ['>@(generated_R_dirs)'],
  69     'generated_R_dirs': [],
  70     'has_java_resources%': 0,
  71     'res_extra_dirs': [],
  72     'res_extra_files': [],
  73     'res_v14_skip%': 0,
  74     'resource_input_paths': ['>@(res_extra_files)'],
  75     'intermediate_dir': '<(SHARED_INTERMEDIATE_DIR)/<(_target_name)',
  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     'findbugs_stamp': '<(intermediate_dir)/findbugs.stamp',
  82     'run_findbugs%': 0,
  83     'java_in_dir_suffix%': '/src',
  84     'proguard_config%': '',
  85     'proguard_preprocess%': '0',
  86     'variables': {
  87       'variables': {
  88         'proguard_preprocess%': 0,
  89         'emma_never_instrument%': 0,
  90       },
  91       'conditions': [
  92         ['proguard_preprocess == 1', {
  93           'javac_jar_path': '<(intermediate_dir)/<(_target_name).pre.jar'
  94         }, {
  95           'javac_jar_path': '<(jar_path)'
  96         }],
  97         ['chromium_code != 0 and emma_coverage != 0 and emma_never_instrument == 0', {
  98           'emma_instrument': 1,
  99         }, {
 100           'emma_instrument': 0,
 101         }],
 102       ],
 103     },
 104     'emma_instrument': '<(emma_instrument)',
 105     'javac_jar_path': '<(javac_jar_path)',
 106     'conditions': [
 107       ['chromium_code == 0', {
 108         'enable_errorprone': 0,
 109       }],
 110     ],
 111     'enable_errorprone%': 0,
 112     'errorprone_exe_path': '<(PRODUCT_DIR)/bin.java/chromium_errorprone',
 113   },
 114   'conditions': [
 115     ['add_to_dependents_classpaths == 1', {
 116       # This all_dependent_settings is used for java targets only. This will add the
 117       # jar path to the classpath of dependent java targets.
 118       'all_dependent_settings': {
 119         'variables': {
 120           'input_jars_paths': ['<(jar_final_path)'],
 121           'library_dexed_jars_paths': ['<(dex_path)'],
 122           'main_dex_list_paths': ['<(main_dex_list_path)'],
 123         },
 124       },
 125     }],
 126     ['has_java_resources == 1', {
 127       'variables': {
 128         'resource_dir': '<(java_in_dir)/res',
 129         'res_input_dirs': ['<(resource_dir)', '<@(res_extra_dirs)'],
 130         'resource_input_paths': ['<!@(find <(resource_dir) -type f)'],
 131
 132         'R_dir': '<(intermediate_dir)/java_R',
 133         'R_text_file': '<(R_dir)/R.txt',
 134
 135         'generated_src_dirs': ['<(R_dir)'],
 136         'additional_input_paths': ['<(resource_zip_path)', ],
 137
 138         'dependencies_res_zip_paths': [],
 139         'resource_zip_path': '<(PRODUCT_DIR)/res.java/<(_target_name).zip',
 140       },
 141       'all_dependent_settings': {
 142         'variables': {
 143           # Dependent libraries include this target's R.java file via
 144           # generated_R_dirs.
 145           'generated_R_dirs': ['<(R_dir)'],
 146
 147           # Dependent libraries and apks include this target's resources via
 148           # dependencies_res_zip_paths.
 149           'additional_input_paths': ['<(resource_zip_path)'],
 150           'dependencies_res_zip_paths': ['<(resource_zip_path)'],
 151
 152           # additional_res_packages and additional_R_text_files are used to
 153           # create this packages R.java files when building the APK.
 154           'additional_res_packages': ['<(R_package)'],
 155           'additional_R_text_files': ['<(R_text_file)'],
 156         },
 157       },
 158       'actions': [
 159         # Generate R.java and crunch image resources.
 160         {
 161           'action_name': 'process_resources',
 162           'message': 'processing resources for <(_target_name)',
 163           'variables': {
 164             'android_manifest': '<(DEPTH)/build/android/AndroidManifest.xml',
 165             # Write the inputs list to a file, so that its mtime is updated when
 166             # the list of inputs changes.
 167             'inputs_list_file': '>|(java_resources.<(_target_name).gypcmd >@(resource_input_paths))',
 168             'process_resources_options': [],
 169             'conditions': [
 170               ['res_v14_skip == 1', {
 171                 'process_resources_options': ['--v14-skip']
 172               }],
 173             ],
 174           },
 175           'inputs': [
 176             '<(DEPTH)/build/android/gyp/util/build_utils.py',
 177             '<(DEPTH)/build/android/gyp/process_resources.py',
 178             '<(DEPTH)/build/android/gyp/generate_v14_compatible_resources.py',
 179             '>@(resource_input_paths)',
 180             '>@(dependencies_res_zip_paths)',
 181             '>(inputs_list_file)',
 182           ],
 183           'outputs': [
 184             '<(resource_zip_path)',
 185           ],
 186           'action': [
 187             'python', '<(DEPTH)/build/android/gyp/process_resources.py',
 188             '--android-sdk', '<(android_sdk)',
 189             '--aapt-path', '<(android_aapt_path)',
 190             '--non-constant-id',
 191
 192             '--android-manifest', '<(android_manifest)',
 193             '--custom-package', '<(R_package)',
 194
 195             '--dependencies-res-zips', '>(dependencies_res_zip_paths)',
 196             '--resource-dirs', '<(res_input_dirs)',
 197
 198             '--R-dir', '<(R_dir)',
 199             '--resource-zip-out', '<(resource_zip_path)',
 200
 201             '<@(process_resources_options)',
 202           ],
 203         },
 204       ],
 205     }],
 206     ['proguard_preprocess == 1', {
 207       'actions': [
 208         {
 209           'action_name': 'proguard_<(_target_name)',
 210           'message': 'Proguard preprocessing <(_target_name) jar',
 211           'inputs': [
 212             '<(DEPTH)/third_party/proguard/lib/proguard.jar',
 213             '<(DEPTH)/build/android/gyp/util/build_utils.py',
 214             '<(DEPTH)/build/android/gyp/proguard.py',
 215             '<(javac_jar_path)',
 216             '<(proguard_config)',
 217           ],
 218           'outputs': [
 219             '<(jar_path)',
 220           ],
 221           'action': [
 222             'python', '<(DEPTH)/build/android/gyp/proguard.py',
 223             '--proguard-path=<(DEPTH)/third_party/proguard/lib/proguard.jar',
 224             '--input-path=<(javac_jar_path)',
 225             '--output-path=<(jar_path)',
 226             '--proguard-config=<(proguard_config)',
 227             '--classpath=<(android_sdk_jar) >(input_jars_paths)',
 228           ]
 229         },
 230       ],
 231     }],
 232     ['run_findbugs == 1', {
 233       'actions': [
 234         {
 235           'action_name': 'findbugs_<(_target_name)',
 236           'message': 'Running findbugs on <(_target_name)',
 237           'variables': {
 238             'additional_findbugs_args': [],
 239             'findbugs_verbose%': 0,
 240           },
 241           'conditions': [
 242             ['findbugs_verbose == 1', {
 243               'variables': {
 244                 'additional_findbugs_args+': ['-vv'],
 245               },
 246             }],
 247           ],
 248           'inputs': [
 249             '<(DEPTH)/build/android/findbugs_diff.py',
 250             '<(DEPTH)/build/android/findbugs_filter/findbugs_exclude.xml',
 251             '<(DEPTH)/build/android/pylib/utils/findbugs.py',
 252             '>@(input_jars_paths)',
 253             '<(jar_final_path)',
 254             '<(compile_stamp)',
 255           ],
 256           'outputs': [
 257             '<(findbugs_stamp)',
 258           ],
 259           'action': [
 260             'python', '<(DEPTH)/build/android/findbugs_diff.py',
 261             '--auxclasspath-gyp', '>(input_jars_paths)',
 262             '--stamp', '<(findbugs_stamp)',
 263             '<@(additional_findbugs_args)',
 264             '<(jar_final_path)',
 265           ],
 266         },
 267       ],
 268     }],
 269     ['enable_errorprone == 1', {
 270       'dependencies': [
 271         '<(DEPTH)/third_party/errorprone/errorprone.gyp:require_errorprone',
 272       ],
 273     }],
 274   ],
 275   'actions': [
 276     {
 277       'action_name': 'javac_<(_target_name)',
 278       'message': 'Compiling <(_target_name) java sources',
 279       'variables': {
 280         'extra_args': [],
 281         'extra_inputs': [],
 282         'java_sources': ['>!@(find >(java_in_dir)>(java_in_dir_suffix) >(additional_src_dirs) -name "*.java")'],
 283         'conditions': [
 284           ['enable_errorprone == 1', {
 285             'extra_inputs': [
 286               '<(errorprone_exe_path)',
 287             ],
 288             'extra_args': [ '--use-errorprone-path=<(errorprone_exe_path)' ],
 289           }],
 290         ],
 291       },
 292       'inputs': [
 293         '<(DEPTH)/build/android/gyp/util/build_utils.py',
 294         '<(DEPTH)/build/android/gyp/javac.py',
 295         '>@(java_sources)',
 296         '>@(input_jars_paths)',
 297         '>@(additional_input_paths)',
 298         '<@(extra_inputs)',
 299       ],
 300       'outputs': [
 301         '<(compile_stamp)',
 302         '<(javac_jar_path)',
 303       ],
 304       'action': [
 305         'python', '<(DEPTH)/build/android/gyp/javac.py',
 306         '--bootclasspath=<(android_sdk_jar)',
 307         '--classpath=>(input_jars_paths)',
 308         '--src-gendirs=>(generated_src_dirs)',
 309         '--javac-includes=<(javac_includes)',
 310         '--chromium-code=<(chromium_code)',
 311         '--jar-path=<(javac_jar_path)',
 312         '--jar-excluded-classes=<(jar_excluded_classes)',
 313         '--stamp=<(compile_stamp)',
 314         '>@(java_sources)',
 315         '<@(extra_args)',
 316       ]
 317     },
 318     {
 319       'action_name': 'main_dex_list_for_<(_target_name)',
 320       'variables': {
 321         'jar_path': '<(javac_jar_path)',
 322         'output_path': '<(main_dex_list_path)',
 323       },
 324       'includes': [ 'android/main_dex_action.gypi' ],
 325     },
 326     {
 327       'action_name': 'instr_jar_<(_target_name)',
 328       'message': 'Instrumenting <(_target_name) jar',
 329       'variables': {
 330         'input_path': '<(jar_path)',
 331         'output_path': '<(jar_final_path)',
 332         'stamp_path': '<(instr_stamp)',
 333         'instr_type': 'jar',
 334       },
 335       'outputs': [
 336         '<(jar_final_path)',
 337       ],
 338       'inputs': [
 339         '<(jar_path)',
 340       ],
 341       'includes': [ 'android/instr_action.gypi' ],
 342     },
 343     {
 344       'variables': {
 345         'src_dirs': [
 346           '<(java_in_dir)<(java_in_dir_suffix)',
 347           '>@(additional_src_dirs)',
 348         ],
 349         'stamp_path': '<(lint_stamp)',
 350         'result_path': '<(lint_result)',
 351         'config_path': '<(lint_config)',
 352         'lint_jar_path': '<(jar_final_path)',
 353       },
 354       'inputs': [
 355         '<(jar_final_path)',
 356         '<(compile_stamp)',
 357       ],
 358       'outputs': [
 359         '<(lint_stamp)',
 360       ],
 361       'includes': [ 'android/lint_action.gypi' ],
 362     },
 363     {
 364       'action_name': 'jar_toc_<(_target_name)',
 365       'message': 'Creating <(_target_name) jar.TOC',
 366       'inputs': [
 367         '<(DEPTH)/build/android/gyp/util/build_utils.py',
 368         '<(DEPTH)/build/android/gyp/util/md5_check.py',
 369         '<(DEPTH)/build/android/gyp/jar_toc.py',
 370         '<(jar_final_path)',
 371       ],
 372       'outputs': [
 373         '<(jar_final_path).TOC',
 374       ],
 375       'action': [
 376         'python', '<(DEPTH)/build/android/gyp/jar_toc.py',
 377         '--jar-path=<(jar_final_path)',
 378         '--toc-path=<(jar_final_path).TOC',
 379       ]
 380     },
 381     {
 382       'action_name': 'dex_<(_target_name)',
 383       'variables': {
 384         'conditions': [
 385           ['emma_instrument != 0', {
 386             'dex_no_locals': 1,
 387           }],
 388         ],
 389         'dex_input_paths': [ '<(jar_final_path)' ],
 390         'output_path': '<(dex_path)',
 391       },
 392       'includes': [ 'android/dex_action.gypi' ],
 393     },
 394   ],
 395 }