1 # Copyright 2014 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 import("//build/config/android/config.gni")
10 rebased_android_sdk = rebase_path(android_sdk, root_build_dir)
11 rebased_android_sdk_root = rebase_path(android_sdk_root, root_build_dir)
12 rebased_android_sdk_build_tools = rebase_path(android_sdk_build_tools, root_build_dir)
14 android_sdk_jar = "$android_sdk/android.jar"
15 rebased_android_sdk_jar = rebase_path(android_sdk_jar, root_build_dir)
17 template("android_lint") {
18 if (defined(invoker.testonly)) { testonly = invoker.testonly }
20 jar_path = invoker.jar_path
21 android_manifest = invoker.android_manifest
22 java_files = invoker.java_files
23 base_path = "$target_gen_dir/$target_name"
26 script = "//build/android/gyp/lint.py"
27 result_path = base_path + "/result.xml"
28 config_path = base_path + "/config.xml"
29 suppressions_file = "//build/android/lint/suppressions.xml"
41 rebased_java_files = rebase_path(java_files, root_build_dir)
44 "--lint-path=$rebased_android_sdk_root/tools/lint",
45 "--config-path", rebase_path(suppressions_file, root_build_dir),
46 "--manifest-path", rebase_path(android_manifest, root_build_dir),
48 "--jar-path", rebase_path(jar_path, root_build_dir),
49 "--processed-config-path", rebase_path(config_path, root_build_dir),
50 "--result-path", rebase_path(result_path, root_build_dir),
51 "--java-files=$rebased_java_files",
58 # Write the target's .build_config file. This is a json file that contains a
59 # dictionary of information about how to build this target (things that
60 # require knowledge about this target's dependencies and cannot be calculated
61 # at gn-time). There is a special syntax to add a value in that dictionary to
62 # an action/action_foreachs args:
63 # --python-arg=@FileArg($rebased_build_config_path:key0:key1)
64 # At runtime, such an arg will be replaced by the value in the build_config.
65 # See build/android/gyp/write_build_config.py and
66 # build/android/gyp/util/build_utils.py:ExpandFileArgs
67 template("write_build_config") {
68 if (defined(invoker.testonly)) { testonly = invoker.testonly }
70 assert(defined(invoker.type))
71 assert(defined(invoker.build_config))
74 build_config = invoker.build_config
76 assert(type == "android_apk" || type == "android_library" || type == "android_resources")
79 script = "//build/android/gyp/write_build_config.py"
80 depfile = "$target_gen_dir/$target_name.d"
84 if (defined(invoker.deps)) {
88 possible_deps_configs = []
90 dep_gen_dir = get_label_info(d, "target_gen_dir")
91 dep_name = get_label_info(d, "name")
92 possible_deps_configs += [ "$dep_gen_dir/$dep_name.build_config" ]
94 rebase_possible_deps_configs = rebase_path(possible_deps_configs)
103 "--depfile", rebase_path(depfile, root_build_dir),
104 "--possible-deps-configs=$rebase_possible_deps_configs",
105 "--build-config", rebase_path(build_config, root_build_dir),
108 if (type == "android_library" || type == "android_apk") {
110 "--jar-path", rebase_path(invoker.jar_path, root_build_dir),
111 "--dex-path", rebase_path(invoker.dex_path, root_build_dir),
115 if (type == "android_resources" || type == "android_apk") {
116 assert(defined(invoker.resources_zip))
118 "--resources-zip", rebase_path(invoker.resources_zip, root_build_dir),
120 if (defined(invoker.android_manifest)) {
122 invoker.android_manifest
125 "--android-manifest", rebase_path(invoker.android_manifest, root_build_dir),
128 if (defined(invoker.custom_package)) {
130 "--package-name", invoker.custom_package
135 if (type == "android_apk") {
136 if (defined(invoker.native_libs)) {
137 rebased_native_libs = rebase_path(invoker.native_libs, root_build_dir)
138 rebased_android_readelf = rebase_path(android_readelf, root_build_dir)
140 "--native-libs=$rebased_native_libs",
141 "--readelf-path=$rebased_android_readelf",
146 if (defined(invoker.srcjar)) {
148 "--srcjar", rebase_path(invoker.srcjar, root_build_dir)
155 # Creates a zip archive of the inputs.
156 # If base_dir is provided, the archive paths will be relative to it.
158 if (defined(invoker.testonly)) { testonly = invoker.testonly }
160 assert(defined(invoker.inputs))
161 assert(defined(invoker.output))
163 rebase_inputs = rebase_path(invoker.inputs, root_build_dir)
164 rebase_output = rebase_path(invoker.output, root_build_dir)
165 action(target_name) {
166 script = "//build/android/gn/zip.py"
167 depfile = "$target_gen_dir/$target_name.d"
168 inputs = invoker.inputs
174 "--depfile", rebase_path(depfile, root_build_dir),
175 "--inputs=$rebase_inputs",
176 "--output=$rebase_output",
178 if (defined(invoker.base_dir)) {
180 "--base-dir", rebase_path(invoker.base_dir, root_build_dir)
187 if (defined(invoker.testonly)) { testonly = invoker.testonly }
189 assert(defined(invoker.sources))
190 assert(defined(invoker.output))
191 action(target_name) {
192 script = "//build/android/gyp/dex.py"
193 depfile = "$target_gen_dir/$target_name.d"
194 sources = invoker.sources
195 outputs = [depfile, invoker.output]
196 if (defined(invoker.inputs)) {
197 inputs = invoker.inputs
200 if (defined(invoker.deps)) {
204 rebased_output = rebase_path(invoker.output, root_build_dir)
207 "--depfile", rebase_path(depfile, root_build_dir),
208 "--android-sdk-tools", rebased_android_sdk_build_tools,
209 "--dex-path", rebased_output,
212 if (defined(invoker.no_locals) && invoker.no_locals) {
218 if (defined(invoker.args)) {
222 args += rebase_path(invoker.sources, root_build_dir)
226 # Packages resources, assets, dex, and native libraries into an apk. Signs and
228 template("create_apk") {
229 if (defined(invoker.testonly)) { testonly = invoker.testonly }
231 _android_manifest = invoker.android_manifest
232 _base_path = invoker.base_path
233 _final_apk_path = invoker.apk_path
234 _resources_zip = invoker.resources_zip
235 _dex_path = invoker.dex_path
236 _keystore_path = invoker.keystore_path
237 _keystore_name = invoker.keystore_name
238 _keystore_password = invoker.keystore_password
239 _load_library_from_apk = invoker.load_library_from_apk
242 if (defined(invoker.deps)) {
246 _native_libs_dir = "//build/android/empty/res"
247 if (defined(invoker.native_libs_dir)) {
248 _native_libs_dir = invoker.native_libs_dir
251 _asset_location = "//build/android/empty/res"
252 if (defined(invoker.asset_location)) {
253 _asset_location = invoker.asset_location
256 _version_code = invoker.version_code
257 _version_name = invoker.version_name
259 _base_apk_path = _base_path + ".apk_intermediates"
261 _resource_packaged_apk_path = _base_apk_path + ".ap_"
262 _packaged_apk_path = _base_apk_path + ".unfinished.apk"
265 _configuration_name = "Release"
267 _configuration_name = "Debug"
270 action("${target_name}__package_resources") {
273 script = "//build/android/gyp/package_resources.py"
274 depfile = "${target_gen_dir}/${target_name}.d"
279 outputs = [depfile, _resource_packaged_apk_path]
281 _rebased_resources_zips = [rebase_path(_resources_zip, root_build_dir)]
283 "--depfile", rebase_path(depfile, root_build_dir),
284 "--android-sdk", rebased_android_sdk,
285 "--android-sdk-tools", rebased_android_sdk_build_tools,
287 "--configuration-name=$_configuration_name",
289 "--android-manifest", rebase_path(_android_manifest, root_build_dir),
290 "--version-code", _version_code,
291 "--version-name", _version_name,
293 "--asset-dir", rebase_path(_asset_location, root_build_dir),
294 "--resource-zips=$_rebased_resources_zips",
296 "--apk-path", rebase_path(_resource_packaged_apk_path, root_build_dir),
300 action("${target_name}__package") {
301 script = "//build/android/gyp/ant.py"
302 _ant_script = "//build/android/ant/apk-package.xml"
304 depfile = "$target_gen_dir/$target_name.d"
308 _resource_packaged_apk_path,
317 _rebased_emma_jar = ""
318 _rebased_resource_packaged_apk_path = rebase_path(
319 _resource_packaged_apk_path, root_build_dir)
320 _rebased_packaged_apk_path = rebase_path(_packaged_apk_path, root_build_dir)
321 _rebased_native_libs_dir = rebase_path(_native_libs_dir, root_build_dir)
322 _rebased_dex_path = rebase_path(_dex_path, root_build_dir)
324 "--depfile", rebase_path(depfile, root_build_dir),
327 "-DANDROID_SDK_ROOT=$rebased_android_sdk_root",
328 "-DANDROID_SDK_TOOLS=$rebased_android_sdk_build_tools",
329 "-DRESOURCE_PACKAGED_APK_NAME=$_rebased_resource_packaged_apk_path",
330 "-DCONFIGURATION_NAME=$_configuration_name",
331 "-DNATIVE_LIBS_DIR=$_rebased_native_libs_dir",
333 "-DUNSIGNED_APK_PATH=$_rebased_packaged_apk_path",
334 "-DEMMA_INSTRUMENT=0",
335 "-DEMMA_DEVICE_JAR=$_rebased_emma_jar",
336 "-DDEX_FILE_PATH=$_rebased_dex_path",
339 "-buildfile", rebase_path(_ant_script, root_build_dir)
343 action("${target_name}__finalize") {
344 script = "//build/android/gyp/finalize_apk.py"
345 depfile = "$target_gen_dir/$target_name.d"
347 sources = [_packaged_apk_path]
348 inputs = [_keystore_path]
349 outputs = [depfile, _final_apk_path]
352 "--depfile", rebase_path(depfile, root_build_dir),
353 "--zipalign-path", rebase_path(zipalign_path, root_build_dir),
354 "--unsigned-apk-path", rebase_path(_packaged_apk_path, root_build_dir),
355 "--final-apk-path", rebase_path(_final_apk_path, root_build_dir),
356 "--key-path", rebase_path(_keystore_path, root_build_dir),
357 "--key-name", _keystore_name,
358 "--key-passwd", _keystore_password,
360 if (_load_library_from_apk) {
361 _rezip_jar_path = "$root_build_dir/lib.java/rezip_apk.jar"
366 "--load-library-from-zip-file=1",
367 "--rezip-apk-jar-path", rebase_path(_rezip_jar_path, root_build_dir)
373 deps = [":${target_name}__finalize"]
377 template("java_prebuilt") {
378 if (defined(invoker.testonly)) { testonly = invoker.testonly }
380 _input_jar_path = invoker.input_jar_path
381 _output_jar_path = invoker.output_jar_path
382 _jar_toc_path = _output_jar_path + ".TOC"
384 assert(invoker.build_config != "")
386 if (defined(invoker.proguard_preprocess) && invoker.proguard_preprocess) {
387 _proguard_jar_path = "$android_sdk_root/tools/proguard/lib/proguard.jar"
388 _proguard_config_path = invoker.proguard_config
389 _build_config = invoker.build_config
390 _rebased_build_config = rebase_path(_build_config, root_build_dir)
391 action("${target_name}__proguard_process") {
392 script = "//build/android/gyp/proguard.py"
398 _proguard_config_path,
400 depfile = "${target_gen_dir}/${target_name}.d"
406 "--depfile", rebase_path(depfile, root_build_dir),
407 "--proguard-path", rebase_path(_proguard_jar_path, root_build_dir),
408 "--input-path", rebase_path(_input_jar_path, root_build_dir),
409 "--output-path", rebase_path(_output_jar_path, root_build_dir),
410 "--proguard-config", rebase_path(_proguard_config_path, root_build_dir),
411 "--classpath", rebased_android_sdk_jar,
412 "--classpath=@FileArg($_rebased_build_config:javac:classpath)",
416 copy("${target_name}__copy_jar") {
417 sources = [_input_jar_path]
418 outputs = [_output_jar_path]
422 action("${target_name}__jar_toc") {
423 script = "//build/android/gyp/jar_toc.py"
424 depfile = "$target_gen_dir/$target_name.d"
428 _jar_toc_path + ".md5.stamp"
430 inputs = [ _output_jar_path ]
432 "--depfile", rebase_path(depfile, root_build_dir),
433 "--jar-path", rebase_path(_output_jar_path, root_build_dir),
434 "--toc-path", rebase_path(_jar_toc_path, root_build_dir),
440 ":${target_name}__jar_toc"
445 # Compiles and jars a set of java files.
452 # java_files: List of .java files to compile.
453 # java_deps: List of java dependencies. These should all have a .jar output
454 # at "${target_gen_dir}/${target_name}.jar.
455 # chromium_code: If true, enable extra warnings.
456 # srcjar_deps: List of srcjar dependencies. The .java files contained in the
457 # dependencies srcjar outputs will be compiled and added to the output jar.
458 # jar_path: Use this to explicitly set the output jar path. Defaults to
459 # "${target_gen_dir}/${target_name}.jar.
460 template("compile_java") {
461 if (defined(invoker.testonly)) { testonly = invoker.testonly }
463 assert(defined(invoker.java_files))
464 assert(defined(invoker.build_config))
465 assert(defined(invoker.jar_path))
467 _java_files = invoker.java_files
468 _final_jar_path = invoker.jar_path
469 _intermediate_jar_path = "$target_gen_dir/$target_name.initial.jar"
471 _build_config = invoker.build_config
473 _jar_excluded_patterns = []
474 if (defined(invoker.jar_excluded_patterns)) {
475 _jar_excluded_patterns += invoker.jar_excluded_patterns
478 _chromium_code = false
479 if (defined(invoker.chromium_code)) {
480 _chromium_code = invoker.chromium_code
484 if (defined(invoker.srcjar_deps)) {
485 _srcjar_deps += invoker.srcjar_deps
489 if (defined(invoker.srcjars)) {
490 _java_srcjars = invoker.srcjars
492 foreach(dep, _srcjar_deps) {
493 _dep_gen_dir = get_label_info(dep, "target_gen_dir")
494 _dep_name = get_label_info(dep, "name")
495 _java_srcjars += [ "$_dep_gen_dir/$_dep_name.srcjar" ]
497 # Mark srcjar_deps as used.
498 assert(_srcjar_deps == [] || true)
500 _system_jars = [ android_sdk_jar ]
501 action("${target_name}__javac") {
502 script = "//build/android/gyp/javac.py"
503 depfile = "$target_gen_dir/$target_name.d"
506 _intermediate_jar_path,
507 _intermediate_jar_path + ".md5.stamp"
509 sources = _java_files + _java_srcjars
510 inputs = _system_jars + [ _build_config ]
512 _rebased_system_jars = rebase_path(_system_jars, root_build_dir)
513 _rebased_java_srcjars = rebase_path(_java_srcjars, root_build_dir)
514 _rebased_build_config = rebase_path(_build_config, root_build_dir)
515 _rebased_depfile = rebase_path(depfile, root_build_dir)
516 _rebased_jar_path = rebase_path(_intermediate_jar_path, root_build_dir)
518 "--depfile=$_rebased_depfile",
519 "--classpath=$_rebased_system_jars",
520 "--classpath=@FileArg($_rebased_build_config:javac:classpath)",
521 "--jar-path=$_rebased_jar_path",
522 "--java-srcjars=$_rebased_java_srcjars",
523 "--java-srcjars=@FileArg($_rebased_build_config:javac:srcjars)",
524 "--jar-excluded-classes=$_jar_excluded_patterns",
526 if (_chromium_code) {
527 args += [ "--chromium-code" ]
530 args += rebase_path(_java_files, root_build_dir)
533 java_prebuilt("${target_name}__finish") {
534 build_config = _build_config
535 input_jar_path = _intermediate_jar_path
536 output_jar_path = _final_jar_path
537 if (defined(invoker.proguard_preprocess) && invoker.proguard_preprocess) {
538 proguard_preprocess = invoker.proguard_preprocess
539 proguard_config = invoker.proguard_config
545 ":${target_name}__javac",
546 ":${target_name}__finish",
552 # This adds Android-specific parts to the java_library template.
554 # Runs Android lint against the compiled java files.
555 # Dexes the output jar for inclusion in an APK.
556 template("android_java_library") {
557 if (defined(invoker.testonly)) { testonly = invoker.testonly }
559 assert(defined(invoker.java_files) || defined(invoker.DEPRECATED_java_in_dir)
560 || defined(invoker.srcjars) || defined(invoker.srcjar_deps))
561 assert(defined(invoker.build_config))
562 assert(defined(invoker.jar_path))
563 assert(defined(invoker.dex_path))
566 if (defined(invoker.srcjar_deps)) {
567 _srcjar_deps = invoker.srcjar_deps
571 if (defined(invoker.srcjars)) {
572 _srcjars = invoker.srcjars
576 if (defined(invoker.java_files)) {
577 _java_files = invoker.java_files
578 } else if (defined(invoker.DEPRECATED_java_in_dir)) {
579 _src_dir = invoker.DEPRECATED_java_in_dir + "/src"
580 _src_dir_exists = exec_script("//build/dir_exists.py",
581 [ rebase_path(_src_dir, root_build_dir) ],
583 assert(_src_dir_exists == "False",
584 "In GN, java_in_dir should be the fully specified java directory " +
585 "(i.e. including the trailing \"/src\")")
587 _java_files_build_rel = exec_script(
588 "//build/android/gyp/find.py",
592 rebase_path(invoker.DEPRECATED_java_in_dir, root_build_dir)
596 _java_files = rebase_path(_java_files_build_rel, ".", root_build_dir)
598 assert(_java_files != [] || _srcjar_deps != [] || _srcjars != [])
600 _jar_path = invoker.jar_path
601 _dex_path = invoker.dex_path
603 _android_manifest = "//build/android/AndroidManifest.xml"
604 if (defined(invoker.android_manifest)) {
605 _android_manifest = invoker.android_manifest
607 assert(_android_manifest != "")
612 compile_java("${target_name}__compile_java") {
614 if (defined(invoker.jar_excluded_patterns)) {
615 jar_excluded_patterns = invoker.jar_excluded_patterns
617 build_config = invoker.build_config
618 java_files = _java_files
619 srcjar_deps = _srcjar_deps
622 if (defined(invoker.proguard_preprocess) && invoker.proguard_preprocess) {
623 proguard_preprocess = invoker.proguard_preprocess
624 proguard_config = invoker.proguard_config
627 if (defined(invoker.dist_jar_path)) {
628 dist_jar_path = invoker.dist_jar_path
632 if (defined(invoker.chromium_code) && invoker.chromium_code) {
633 _final_datadeps += [ ":${target_name}__lint" ]
634 android_lint("${target_name}__lint") {
635 android_manifest = _android_manifest
637 java_files = _java_files
641 dex("${target_name}__dex") {
642 sources = [_jar_path]
648 ":${target_name}__compile_java",
649 ":${target_name}__dex",
650 ] + _final_deps + _final_datadeps
654 # Runs process_resources.py
655 template("process_resources") {
656 if (defined(invoker.testonly)) { testonly = invoker.testonly }
658 zip_path = invoker.zip_path
659 srcjar_path = invoker.srcjar_path
660 build_config = invoker.build_config
661 resource_dirs = invoker.resource_dirs
662 android_manifest = invoker.android_manifest
664 non_constant_id = true
665 if (defined(invoker.generate_constant_ids) && invoker.generate_constant_ids) {
666 non_constant_id = false
669 action(target_name) {
670 script = "//build/android/gyp/process_resources.py"
672 depfile = "$target_gen_dir/$target_name.d"
679 sources_build_rel = exec_script(
680 "//build/android/gyp/find.py",
681 rebase_path(resource_dirs, root_build_dir),
684 sources = rebase_path(sources_build_rel, ".", root_build_dir)
691 rebase_resource_dirs = rebase_path(resource_dirs, root_build_dir)
692 rebase_build_config = rebase_path(build_config, root_build_dir)
694 "--depfile", rebase_path(depfile, root_build_dir),
695 "--android-sdk", rebase_path(android_sdk, root_build_dir),
696 "--android-sdk-tools", rebase_path(android_sdk_build_tools, root_build_dir),
697 "--android-manifest", rebase_path(android_manifest, root_build_dir),
699 "--resource-dirs=$rebase_resource_dirs",
700 "--srcjar-out", rebase_path(srcjar_path, root_build_dir),
701 "--resource-zip-out", rebase_path(zip_path, root_build_dir),
703 "--dependencies-res-zips=@FileArg($rebase_build_config:resources:dependency_zips)",
704 "--extra-res-packages=@FileArg($rebase_build_config:resources:extra_package_names)",
707 if (non_constant_id) {
708 args += [ "--non-constant-id" ]
711 if (defined(invoker.custom_package)) {
713 "--custom-package", invoker.custom_package,
717 if (defined(invoker.v14_verify_only) && invoker.v14_verify_only) {
718 args += ["--v14-verify-only"]
721 if (defined(invoker.all_resources_zip_path)) {
722 all_resources_zip = invoker.all_resources_zip_path
723 outputs += [ all_resources_zip ]
725 "--all-resources-zip-out", rebase_path(all_resources_zip, root_build_dir)
729 if (defined(invoker.args)) {
735 template("copy_ex") {
736 if (defined(invoker.testonly)) { testonly = invoker.testonly }
738 action(target_name) {
739 script = "//build/android/gyp/copy_ex.py"
741 if (defined(invoker.deps)) { deps = invoker.deps }
744 if (defined(invoker.sources)) {
745 sources += invoker.sources
749 if (defined(invoker.inputs)) {
750 inputs += invoker.inputs
753 depfile = "$target_gen_dir/$target_name.d"
759 "--depfile", rebase_path(depfile, root_build_dir),
760 "--dest", rebase_path(invoker.dest, root_build_dir),
762 rebased_sources = rebase_path(sources, root_build_dir)
763 args += [ "--files=$rebased_sources" ]
765 if (defined(invoker.clear_dir) && invoker.clear_dir) {
769 if (defined(invoker.args)) {