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.
5 # This file is meant to be included into a target to provide a rule
6 # to build Android APKs in a consistent manner.
8 # To use this, create a gyp target with the following form:
10 # 'target_name': 'my_package_apk',
13 # 'apk_name': 'MyPackage',
14 # 'java_in_dir': 'path/to/package/root',
15 # 'resource_dir': 'path/to/package/root/res',
17 # 'includes': ['path/to/this/gypi/file'],
21 # apk_name - The final apk will be named <apk_name>.apk
22 # java_in_dir - The top-level java directory. The src should be in
24 # Optional/automatic variables:
25 # additional_input_paths - These paths will be included in the 'inputs' list to
26 # ensure that this target is rebuilt when one of these paths changes.
27 # additional_res_dirs - Additional directories containing Android resources.
28 # additional_res_packages - Package names of the R.java files corresponding to
29 # each directory in additional_res_dirs.
30 # additional_src_dirs - Additional directories with .java files to be compiled
31 # and included in the output of this target.
32 # asset_location - The directory where assets are located.
33 # generated_src_dirs - Same as additional_src_dirs except used for .java files
34 # that are generated at build time. This should be set automatically by a
35 # target's dependencies. The .java files in these directories are not
36 # included in the 'inputs' list (unlike additional_src_dirs).
37 # input_jars_paths - The path to jars to be included in the classpath. This
38 # should be filled automatically by depending on the appropriate targets.
39 # is_test_apk - Set to 1 if building a test apk. This prevents resources from
40 # dependencies from being re-included.
41 # native_lib_target - The target_name of the target which generates the final
42 # shared library to be included in this apk. A stripped copy of the
43 # library will be included in the apk.
44 # resource_dir - The directory for resources.
45 # R_package - A custom Java package to generate the resource file R.java in.
46 # By default, the package given in AndroidManifest.xml will be used.
47 # java_strings_grd - The name of the grd file from which to generate localized
48 # strings.xml files, if any.
49 # library_manifest_paths'- Paths to additional AndroidManifest.xml files from
54 'additional_input_paths': [],
55 'input_jars_paths': [],
56 'library_dexed_jars_paths': [],
57 'additional_src_dirs': [],
58 'generated_src_dirs': [],
59 'app_manifest_version_name%': '<(android_app_version_name)',
60 'app_manifest_version_code%': '<(android_app_version_code)',
61 'proguard_enabled%': 'false',
62 'proguard_flags_paths%': ['<(DEPTH)/build/android/empty_proguard.flags'],
63 'native_lib_target%': '',
64 'jar_name': 'chromium_apk_<(_target_name).jar',
65 'resource_dir%':'<(DEPTH)/build/android/ant/empty/res',
67 'additional_R_text_files': [],
68 'additional_res_dirs': [],
69 'additional_res_packages': [],
71 'java_strings_grd%': '',
72 'library_manifest_paths' : [],
73 'resource_input_paths': [],
74 'intermediate_dir': '<(PRODUCT_DIR)/<(_target_name)',
75 'asset_location%': '<(intermediate_dir)/assets',
76 'codegen_stamp': '<(intermediate_dir)/codegen.stamp',
77 'compile_input_paths': [],
78 'package_input_paths': [],
79 'ordered_libraries_file': '<(intermediate_dir)/native_libraries.json',
80 # TODO(cjhopman): build/ shouldn't refer to content/. The libraryloader and
81 # nativelibraries template should be moved out of content/ (to base/?).
82 # http://crbug.com/225101
83 'native_libraries_template': '<(DEPTH)/content/public/android/java/templates/NativeLibraries.template',
84 'native_libraries_java_dir': '<(intermediate_dir)/native_libraries_java/',
85 'native_libraries_java_file': '<(native_libraries_java_dir)/NativeLibraries.java',
86 'native_libraries_java_stamp': '<(intermediate_dir)/native_libraries_java.stamp',
87 'native_libraries_template_data_dir': '<(intermediate_dir)/native_libraries/',
88 'native_libraries_template_data_file': '<(native_libraries_template_data_dir)/native_libraries_array.h',
89 'native_libraries_template_data_stamp': '<(intermediate_dir)/native_libraries_template_data.stamp',
90 'compile_stamp': '<(intermediate_dir)/compile.stamp',
91 'jar_stamp': '<(intermediate_dir)/jar.stamp',
92 'obfuscate_stamp': '<(intermediate_dir)/obfuscate.stamp',
93 'strip_stamp': '<(intermediate_dir)/strip.stamp',
94 'classes_dir': '<(intermediate_dir)/classes',
96 'jar_excluded_classes': [],
97 'jar_path': '<(PRODUCT_DIR)/lib.java/<(jar_name)',
98 'obfuscated_jar_path': '<(intermediate_dir)/obfuscated.jar',
99 'dex_path': '<(intermediate_dir)/classes.dex',
100 'android_manifest_path%': '<(java_in_dir)/AndroidManifest.xml',
101 'push_stamp': '<(intermediate_dir)/push.stamp',
102 'link_stamp': '<(intermediate_dir)/link.stamp',
103 'package_resources_stamp': '<(intermediate_dir)/package_resources.stamp',
104 'codegen_input_paths': [],
105 'keystore_path': '<(DEPTH)/build/android/ant/chromium-debug.keystore',
106 'unsigned_apk_path': '<(intermediate_dir)/<(apk_name)-unsigned.apk',
107 'final_apk_path%': '<(PRODUCT_DIR)/apks/<(apk_name).apk',
108 'source_dir': '<(java_in_dir)/src',
109 'apk_install_record': '<(intermediate_dir)/apk_install.record.stamp',
110 'apk_package_native_libs_dir': '<(intermediate_dir)/libs',
111 'device_intermediate_dir': '/data/local/tmp/chromium/<(_target_name)/<(CONFIGURATION_NAME)',
112 'symlink_script_host_path': '<(intermediate_dir)/create_symlinks.sh',
113 'symlink_script_device_path': '<(device_intermediate_dir)/create_symlinks.sh',
115 # Pass the jar path to the apk's "fake" jar target. This would be better as
116 # direct_dependent_settings, but a variable set by a direct_dependent_settings
117 # cannot be lifted in a dependent to all_dependent_settings.
118 'all_dependent_settings': {
120 'apk_output_jar_path': '<(PRODUCT_DIR)/lib.java/<(jar_name)',
124 ['resource_dir!=""', {
126 'resource_input_paths': [ '<!@(find <(resource_dir) -name "*")' ]
129 ['R_package != ""', {
131 # We generate R.java in package R_package (in addition to the package
132 # listed in the AndroidManifest.xml, which is unavoidable).
133 'additional_res_dirs': ['<(DEPTH)/build/android/ant/empty/res'],
134 'additional_res_packages': ['<(R_package)'],
135 'additional_R_text_files': ['<(PRODUCT_DIR)/<(package_name)/R.txt'],
138 ['native_lib_target != "" and component == "shared_library"', {
140 '<(DEPTH)/build/android/setup.gyp:copy_system_libraries',
143 ['native_lib_target != ""', {
145 'compile_input_paths': [ '<(native_libraries_java_stamp)' ],
146 'generated_src_dirs': [ '<(native_libraries_java_dir)' ],
147 'native_libs_paths': ['<(SHARED_LIB_DIR)/<(native_lib_target).>(android_product_extension)'],
152 'input_libraries': ['<@(native_libs_paths)'],
154 'includes': ['../build/android/write_ordered_libraries.gypi'],
157 'action_name': 'native_libraries_template_data_<(_target_name)',
158 'message': 'Creating native_libraries_list.h for <(_target_name).',
160 '<(DEPTH)/build/android/gyp/util/build_utils.py',
161 '<(DEPTH)/build/android/gyp/create_native_libraries_header.py',
162 '<(ordered_libraries_file)',
165 '<(native_libraries_template_data_stamp)',
168 'python', '<(DEPTH)/build/android/gyp/create_native_libraries_header.py',
169 '--ordered-libraries=<(ordered_libraries_file)',
170 '--output=<(native_libraries_template_data_file)',
171 '--stamp=<(native_libraries_template_data_stamp)',
175 'action_name': 'native_libraries_<(_target_name)',
176 'message': 'Creating NativeLibraries.java for <(_target_name).',
178 '<(DEPTH)/build/android/gyp/util/build_utils.py',
179 '<(DEPTH)/build/android/gyp/gcc_preprocess.py',
180 '<(native_libraries_template_data_stamp)',
181 '<(native_libraries_template)',
184 '<(native_libraries_java_stamp)',
187 'python', '<(DEPTH)/build/android/gyp/gcc_preprocess.py',
188 '--include-path=<(native_libraries_template_data_dir)',
189 '--output=<(native_libraries_java_file)',
190 '--template=<(native_libraries_template)',
191 '--stamp=<(native_libraries_java_stamp)',
196 'stripped_libraries_dir': '<(libraries_source_dir)',
197 'input_paths': ['<@(native_libs_paths)'],
199 'includes': ['../build/android/strip_native_libraries.gypi'],
203 ['gyp_managed_install == 1', {
205 'libraries_source_dir': '<(intermediate_dir)/lib.stripped/<(android_app_abi)',
206 'apk_package_native_libs_dir': '<(intermediate_dir)/libs.managed',
207 'device_library_dir': '<(device_intermediate_dir)/lib.stripped',
210 '<(DEPTH)/tools/android/md5sum/md5sum.gyp:md5sum',
214 'includes': ['../build/android/push_libraries.gypi'],
217 'action_name': 'create device library symlinks',
218 'message': 'Creating links on device for <(_target_name).',
220 '<(DEPTH)/build/android/gyp/util/build_utils.py',
221 '<(DEPTH)/build/android/gyp/create_device_library_links.py',
222 '<(apk_install_record)',
223 '<(ordered_libraries_file)',
229 'python', '<(DEPTH)/build/android/gyp/create_device_library_links.py',
230 '--libraries-json=<(ordered_libraries_file)',
231 '--script-host-path=<(symlink_script_host_path)',
232 '--script-device-path=<(symlink_script_device_path)',
233 '--target-dir=<(device_library_dir)',
234 '--apk=<(final_apk_path)',
235 '--stamp=<(link_stamp)',
240 # gyp_managed_install != 1
242 'libraries_source_dir': '<(apk_package_native_libs_dir)/<(android_app_abi)',
243 'package_input_paths': [ '<(strip_stamp)' ],
247 }], # native_lib_target != ''
248 ['java_strings_grd != ""', {
250 'res_grit_dir': '<(SHARED_INTERMEDIATE_DIR)/<(package_name)_apk/res_grit',
251 'additional_res_dirs': ['<(res_grit_dir)'],
252 # grit_grd_file is used by grit_action.gypi, included below.
253 'grit_grd_file': '<(java_in_dir)/strings/<(java_strings_grd)',
254 'resource_input_paths': [
255 '<!@pymod_do_main(grit_info <@(grit_defines) --outputs "<(res_grit_dir)" <(grit_grd_file))'
260 'action_name': 'generate_localized_strings_xml',
262 'grit_additional_defines': ['-E', 'ANDROID_JAVA_TAGGED_ONLY=false'],
263 'grit_out_dir': '<(res_grit_dir)',
264 # resource_ids is unneeded since we don't generate .h headers.
265 'grit_resource_ids': '',
267 'includes': ['../build/grit_action.gypi'],
271 ['gyp_managed_install == 1', {
274 'action_name': 'apk_install_<(_target_name)',
275 'message': 'Installing <(apk_name).apk',
277 '<(DEPTH)/build/android/gyp/util/build_utils.py',
278 '<(DEPTH)/build/android/gyp/apk_install.py',
282 '<(apk_install_record)',
283 # If a user switches the connected device, the APK may need to be
284 # installed even if there have been no changes. To ensure that the
285 # APK on the device is always up-to-date, this step should always
287 '<(apk_install_record).fake',
290 'python', '<(DEPTH)/build/android/gyp/apk_install.py',
291 '--android-sdk-tools=<(android_sdk_tools)',
292 '--apk-path=<(final_apk_path)',
293 '--install-record=<(apk_install_record)'
301 'action_name': 'ant_codegen_<(_target_name)',
302 'message': 'Generating R.java for <(_target_name)',
304 ['is_test_apk == 1', {
306 'additional_res_dirs=': [],
307 'additional_res_packages=': [],
312 '<(DEPTH)/build/android/ant/apk-codegen.xml',
313 '<(DEPTH)/build/android/gyp/util/build_utils.py',
314 '<(DEPTH)/build/android/gyp/ant.py',
315 '<(android_manifest_path)',
316 '>@(additional_input_paths)',
317 '>@(codegen_input_paths)',
318 '>@(library_manifest_paths)',
319 '>@(resource_input_paths)',
325 'python', '<(DEPTH)/build/android/gyp/ant.py',
327 '-DADDITIONAL_RES_DIRS=>(additional_res_dirs)',
328 '-DADDITIONAL_RES_PACKAGES=>(additional_res_packages)',
329 '-DADDITIONAL_R_TEXT_FILES=>(additional_R_text_files)',
330 '-DANDROID_MANIFEST=<(android_manifest_path)',
331 '-DANDROID_SDK_JAR=<(android_sdk_jar)',
332 '-DANDROID_SDK_ROOT=<(android_sdk_root)',
333 '-DANDROID_SDK_VERSION=<(android_sdk_version)',
334 '-DLIBRARY_MANIFEST_PATHS=>(library_manifest_paths)',
335 '-DOUT_DIR=<(intermediate_dir)',
336 '-DRESOURCE_DIR=<(resource_dir)',
338 '-DSTAMP=<(codegen_stamp)',
341 '<(DEPTH)/build/android/ant/apk-codegen.xml',
343 # Add list of inputs to the command line, so if inputs change
344 # (e.g. if a Java file is removed), the command will be re-run.
345 # TODO(newt): remove this once crbug.com/177552 is fixed in ninja.
346 '-DTHIS_IS_IGNORED=>!(echo \'>(_inputs)\' | md5sum)',
350 'action_name': 'javac_<(_target_name)',
351 'message': 'Compiling java for <(_target_name)',
354 '<(java_in_dir)/src',
355 '<(intermediate_dir)/gen',
356 '>@(additional_src_dirs)',
357 '>@(generated_src_dirs)',
361 '<(DEPTH)/build/android/gyp/util/build_utils.py',
362 '<(DEPTH)/build/android/gyp/javac.py',
363 # If there is a separate find for additional_src_dirs, it will find the
364 # wrong .java files when additional_src_dirs is empty.
365 '>!@(find >(java_in_dir) >(additional_src_dirs) -name "*.java")',
366 '>@(input_jars_paths)',
368 '>@(compile_input_paths)',
374 'python', '<(DEPTH)/build/android/gyp/javac.py',
375 '--output-dir=<(classes_dir)',
376 '--classpath=>(input_jars_paths) <(android_sdk_jar)',
377 '--src-dirs=>(all_src_dirs)',
378 '--javac-includes=<(javac_includes)',
379 '--chromium-code=<(chromium_code)',
380 '--stamp=<(compile_stamp)',
382 # TODO(newt): remove this once http://crbug.com/177552 is fixed in ninja.
383 '--ignore=>!(echo \'>(_inputs)\' | md5sum)',
387 'action_name': 'jar_<(_target_name)',
388 'message': 'Creating <(_target_name) jar',
390 '<(DEPTH)/build/android/gyp/util/build_utils.py',
391 '<(DEPTH)/build/android/gyp/util/md5_check.py',
392 '<(DEPTH)/build/android/gyp/jar.py',
399 'python', '<(DEPTH)/build/android/gyp/jar.py',
400 '--classes-dir=<(classes_dir)',
401 '--jar-path=<(jar_path)',
402 '--excluded-classes=<(jar_excluded_classes)',
403 '--stamp=<(jar_stamp)',
405 # TODO(newt): remove this once http://crbug.com/177552 is fixed in ninja.
406 '--ignore=>!(echo \'>(_inputs)\' | md5sum)',
410 'action_name': 'ant_obfuscate_<(_target_name)',
411 'message': 'Obfuscating <(_target_name)',
413 '<(DEPTH)/build/android/ant/apk-obfuscate.xml',
414 '<(DEPTH)/build/android/ant/create-test-jar.js',
415 '<(DEPTH)/build/android/gyp/util/build_utils.py',
416 '<(DEPTH)/build/android/gyp/ant.py',
418 '>@(proguard_flags_paths)',
421 '<(obfuscate_stamp)',
424 'python', '<(DEPTH)/build/android/gyp/ant.py',
426 '-DADDITIONAL_SRC_DIRS=>(additional_src_dirs)',
427 '-DANDROID_SDK_JAR=<(android_sdk_jar)',
428 '-DANDROID_SDK_ROOT=<(android_sdk_root)',
429 '-DANDROID_SDK_VERSION=<(android_sdk_version)',
430 '-DAPK_NAME=<(apk_name)',
431 '-DCREATE_TEST_JAR_PATH=<(DEPTH)/build/android/ant/create-test-jar.js',
432 '-DCONFIGURATION_NAME=<(CONFIGURATION_NAME)',
433 '-DGENERATED_SRC_DIRS=>(generated_src_dirs)',
434 '-DINPUT_JARS_PATHS=>(input_jars_paths)',
435 '-DIS_TEST_APK=<(is_test_apk)',
436 '-DJAR_PATH=<(PRODUCT_DIR)/lib.java/<(jar_name)',
437 '-DOBFUSCATED_JAR_PATH=<(obfuscated_jar_path)',
438 '-DOUT_DIR=<(intermediate_dir)',
439 '-DPROGUARD_ENABLED=<(proguard_enabled)',
440 '-DPROGUARD_FLAGS=<(proguard_flags_paths)',
441 '-DTEST_JAR_PATH=<(PRODUCT_DIR)/test.lib.java/<(apk_name).jar',
443 '-DSTAMP=<(obfuscate_stamp)',
446 '<(DEPTH)/build/android/ant/apk-obfuscate.xml',
448 # Add list of inputs to the command line, so if inputs change
449 # (e.g. if a Java file is removed), the command will be re-run.
450 # TODO(newt): remove this once crbug.com/177552 is fixed in ninja.
451 '-DTHIS_IS_IGNORED=>!(echo \'>(_inputs)\' | md5sum)',
455 'action_name': 'dex_<(_target_name)',
456 'message': 'Dexing <(_target_name) jar',
459 ['proguard_enabled=="true" and CONFIGURATION_NAME=="Release"', {
460 'dex_inputs': [ '<(obfuscated_jar_path)' ],
461 'dex_generated_inputs': [],
464 '>@(library_dexed_jars_paths)',
466 'dex_generated_inputs': [
473 '<(DEPTH)/build/android/gyp/util/build_utils.py',
474 '<(DEPTH)/build/android/gyp/util/md5_check.py',
475 '<(DEPTH)/build/android/gyp/dex.py',
483 'python', '<(DEPTH)/build/android/gyp/dex.py',
484 '--dex-path=<(dex_path)',
485 '--android-sdk-root=<(android_sdk_root)',
487 # TODO(newt): remove this once http://crbug.com/177552 is fixed in ninja.
488 '--ignore=>!(echo \'>(_inputs)\' | md5sum)',
491 '>@(dex_generated_inputs)',
495 'action_name': 'ant package resources',
496 'message': 'Packaging resources for <(_target_name) APK.',
498 '<(DEPTH)/build/android/ant/apk-package-resources.xml',
499 '<(DEPTH)/build/android/gyp/util/build_utils.py',
500 '<(DEPTH)/build/android/gyp/ant.py',
501 '<(android_manifest_path)',
504 '>@(library_manifest_paths)',
505 '>@(additional_input_paths)',
508 ['is_test_apk == 1', {
510 'additional_res_dirs=': [],
511 'additional_res_packages=': [],
516 '<(package_resources_stamp)',
519 'python', '<(DEPTH)/build/android/gyp/ant.py',
521 '-DADDITIONAL_RES_DIRS=>(additional_res_dirs)',
522 '-DADDITIONAL_RES_PACKAGES=>(additional_res_packages)',
523 '-DADDITIONAL_R_TEXT_FILES=>(additional_R_text_files)',
524 '-DANDROID_SDK_JAR=<(android_sdk_jar)',
525 '-DANDROID_SDK_ROOT=<(android_sdk_root)',
526 '-DAPK_NAME=<(apk_name)',
527 '-DAPP_MANIFEST_VERSION_CODE=<(app_manifest_version_code)',
528 '-DAPP_MANIFEST_VERSION_NAME=<(app_manifest_version_name)',
529 '-DASSET_DIR=<(asset_location)',
530 '-DCONFIGURATION_NAME=<(CONFIGURATION_NAME)',
531 '-DOUT_DIR=<(intermediate_dir)',
532 '-DRESOURCE_DIR=<(resource_dir)',
534 '-DSTAMP=<(package_resources_stamp)',
538 '<(DEPTH)/build/android/ant/apk-package-resources.xml',
540 # Add list of inputs to the command line, so if inputs change
541 # (e.g. if a Java file is removed), the command will be re-run.
542 # TODO(newt): remove this once crbug.com/177552 is fixed in ninja.
543 '-DTHIS_IS_IGNORED=>!(echo \'>(_inputs)\' | md5sum)',
547 'action_name': 'ant_package_<(_target_name)',
548 'message': 'Packaging <(_target_name).',
550 '<(DEPTH)/build/android/ant/apk-package.xml',
551 '<(DEPTH)/build/android/gyp/util/build_utils.py',
552 '<(DEPTH)/build/android/gyp/ant.py',
555 '<(obfuscate_stamp)',
556 '<(package_resources_stamp)',
557 '>@(package_input_paths)',
560 '<(unsigned_apk_path)',
563 'python', '<(DEPTH)/build/android/gyp/ant.py',
565 '-DANDROID_SDK_ROOT=<(android_sdk_root)',
566 '-DAPK_NAME=<(apk_name)',
567 '-DCONFIGURATION_NAME=<(CONFIGURATION_NAME)',
568 '-DNATIVE_LIBS_DIR=<(apk_package_native_libs_dir)',
569 '-DOUT_DIR=<(intermediate_dir)',
570 '-DSOURCE_DIR=<(source_dir)',
571 '-DUNSIGNED_APK_PATH=<(unsigned_apk_path)',
575 '<(DEPTH)/build/android/ant/apk-package.xml',
577 # Add list of inputs to the command line, so if inputs change
578 # (e.g. if a Java file is removed), the command will be re-run.
579 # TODO(newt): remove this once crbug.com/177552 is fixed in ninja.
580 '-DTHIS_IS_IGNORED=>!(echo \'>(_inputs)\' | md5sum)',
584 'action_name': 'finalize_apk',
585 'message': 'Signing/aligning <(_target_name) APK.',
587 '<(DEPTH)/build/android/gyp/util/build_utils.py',
588 '<(DEPTH)/build/android/gyp/finalize_apk.py',
589 '<(unsigned_apk_path)',
595 'python', '<(DEPTH)/build/android/gyp/finalize_apk.py',
596 '--android-sdk-root=<(android_sdk_root)',
597 '--unsigned-apk-path=<(unsigned_apk_path)',
598 '--final-apk-path=<(final_apk_path)',
599 '--keystore-path=<(keystore_path)',
601 # TODO(newt): remove this once crbug.com/177552 is fixed in ninja.
602 '--ignore=>!(echo \'>(_inputs)\' | md5sum)',