1# 2# Copyright (C) 2008 The Android Open Source Project 3# 4# Licensed under the Apache License, Version 2.0 (the "License"); 5# you may not use this file except in compliance with the License. 6# You may obtain a copy of the License at 7# 8# http://www.apache.org/licenses/LICENSE-2.0 9# 10# Unless required by applicable law or agreed to in writing, software 11# distributed under the License is distributed on an "AS IS" BASIS, 12# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13# See the License for the specific language governing permissions and 14# limitations under the License. 15# 16 17########################################################### 18## Standard rules for building an application package. 19## 20## Additional inputs from base_rules.make: 21## LOCAL_PACKAGE_NAME: The name of the package; the directory 22## will be called this. 23## 24## MODULE, MODULE_PATH, and MODULE_SUFFIX will 25## be set for you. 26########################################################### 27 28 29# If this makefile is being read from within an inheritance, 30# use the new values. 31skip_definition:= 32ifdef LOCAL_PACKAGE_OVERRIDES 33 package_overridden := $(call set-inherited-package-variables) 34 ifeq ($(strip $(package_overridden)),) 35 skip_definition := true 36 endif 37endif 38 39ifndef skip_definition 40 41LOCAL_PACKAGE_NAME := $(strip $(LOCAL_PACKAGE_NAME)) 42ifeq ($(LOCAL_PACKAGE_NAME),) 43$(error $(LOCAL_PATH): Package modules must define LOCAL_PACKAGE_NAME) 44endif 45 46ifneq ($(strip $(LOCAL_MODULE_SUFFIX)),) 47$(error $(LOCAL_PATH): Package modules may not define LOCAL_MODULE_SUFFIX) 48endif 49LOCAL_MODULE_SUFFIX := $(COMMON_ANDROID_PACKAGE_SUFFIX) 50 51ifneq ($(strip $(LOCAL_MODULE)),) 52$(error $(LOCAL_PATH): Package modules may not define LOCAL_MODULE) 53endif 54LOCAL_MODULE := $(LOCAL_PACKAGE_NAME) 55 56# Android packages should use Android resources or assets. 57ifneq (,$(LOCAL_JAVA_RESOURCE_DIRS)) 58$(error $(LOCAL_PATH): Package modules may not set LOCAL_JAVA_RESOURCE_DIRS) 59endif 60ifneq (,$(LOCAL_JAVA_RESOURCE_FILES)) 61$(error $(LOCAL_PATH): Package modules may not set LOCAL_JAVA_RESOURCE_FILES) 62endif 63 64ifeq ($(strip $(LOCAL_MANIFEST_FILE)),) 65LOCAL_MANIFEST_FILE := AndroidManifest.xml 66endif 67 68ifneq ($(strip $(LOCAL_MODULE_CLASS)),) 69$(error $(LOCAL_PATH): Package modules may not set LOCAL_MODULE_CLASS) 70endif 71LOCAL_MODULE_CLASS := APPS 72 73# Package LOCAL_MODULE_TAGS default to optional 74LOCAL_MODULE_TAGS := $(strip $(LOCAL_MODULE_TAGS)) 75ifeq ($(LOCAL_MODULE_TAGS),) 76LOCAL_MODULE_TAGS := optional 77endif 78 79#$(warning $(LOCAL_PATH) $(LOCAL_PACKAGE_NAME) $(sort $(LOCAL_MODULE_TAGS))) 80 81ifeq ($(filter tests, $(LOCAL_MODULE_TAGS)),) 82# Force localization check if it's not tagged as tests. 83LOCAL_AAPT_FLAGS := $(LOCAL_AAPT_FLAGS) -z 84endif 85 86ifeq (,$(LOCAL_ASSET_DIR)) 87LOCAL_ASSET_DIR := $(LOCAL_PATH)/assets 88endif 89 90ifeq (,$(LOCAL_RESOURCE_DIR)) 91 LOCAL_RESOURCE_DIR := $(LOCAL_PATH)/res 92endif 93LOCAL_RESOURCE_DIR := \ 94 $(wildcard $(foreach dir, $(PRODUCT_PACKAGE_OVERLAYS), \ 95 $(addprefix $(dir)/, $(LOCAL_RESOURCE_DIR)))) \ 96 $(wildcard $(foreach dir, $(DEVICE_PACKAGE_OVERLAYS), \ 97 $(addprefix $(dir)/, $(LOCAL_RESOURCE_DIR)))) \ 98 $(LOCAL_RESOURCE_DIR) 99 100# this is an app, so add the system libraries to the search path 101LOCAL_AIDL_INCLUDES += $(FRAMEWORKS_BASE_JAVA_SRC_DIRS) 102 103#$(warning Finding assets for $(LOCAL_ASSET_DIR)) 104 105all_assets := $(call find-subdir-assets,$(LOCAL_ASSET_DIR)) 106all_assets := $(addprefix $(LOCAL_ASSET_DIR)/,$(patsubst assets/%,%,$(all_assets))) 107 108all_resources := $(strip \ 109 $(foreach dir, $(LOCAL_RESOURCE_DIR), \ 110 $(addprefix $(dir)/, \ 111 $(patsubst res/%,%, \ 112 $(call find-subdir-assets,$(dir)) \ 113 ) \ 114 ) \ 115 )) 116 117all_res_assets := $(strip $(all_assets) $(all_resources)) 118 119package_expected_intermediates_COMMON := $(call local-intermediates-dir,COMMON) 120# If no assets or resources were found, clear the directory variables so 121# we don't try to build them. 122ifeq (,$(all_assets)) 123LOCAL_ASSET_DIR:= 124endif 125ifeq (,$(all_resources)) 126LOCAL_RESOURCE_DIR:= 127R_file_stamp := 128else 129# Make sure that R_file_stamp inherits the proper PRIVATE vars. 130# If R.stamp moves, be sure to update the framework makefile, 131# which has intimate knowledge of its location. 132R_file_stamp := $(package_expected_intermediates_COMMON)/src/R.stamp 133LOCAL_INTERMEDIATE_TARGETS += $(R_file_stamp) 134endif 135 136LOCAL_BUILT_MODULE_STEM := package.apk 137 138LOCAL_PROGUARD_ENABLED:=$(strip $(LOCAL_PROGUARD_ENABLED)) 139ifndef LOCAL_PROGUARD_ENABLED 140ifneq ($(filter user userdebug, $(TARGET_BUILD_VARIANT)),) 141 # turn on Proguard by default for user & userdebug build 142 LOCAL_PROGUARD_ENABLED :=full 143endif 144endif 145ifeq ($(LOCAL_PROGUARD_ENABLED),disabled) 146 # the package explicitly request to disable proguard. 147 LOCAL_PROGUARD_ENABLED := 148endif 149proguard_options_file := 150ifneq ($(LOCAL_PROGUARD_ENABLED),custom) 151ifneq ($(all_resources),) 152 proguard_options_file := $(package_expected_intermediates_COMMON)/proguard_options 153endif # all_resources 154endif # !custom 155LOCAL_PROGUARD_FLAGS := $(addprefix -include ,$(proguard_options_file)) $(LOCAL_PROGUARD_FLAGS) 156 157ifeq (true,$(WITH_DEXPREOPT)) 158ifeq (,$(TARGET_BUILD_APPS)) 159ifneq (,$(LOCAL_SRC_FILES)) 160ifndef LOCAL_DEX_PREOPT 161LOCAL_DEX_PREOPT := true 162endif 163endif 164endif 165endif 166 167# The dex files go in the package, so we don't 168# want to install them separately for this module. 169old_DONT_INSTALL_DEX_FILES := $(DONT_INSTALL_DEX_FILES) 170DONT_INSTALL_DEX_FILES := true 171################################# 172include $(BUILD_SYSTEM)/java.mk 173################################# 174DONT_INSTALL_DEX_FILES := $(old_DONT_INSTALL_DEX_FILES) 175old_DONT_INSTALL_DEX_FILES = 176 177full_android_manifest := $(LOCAL_PATH)/$(LOCAL_MANIFEST_FILE) 178$(LOCAL_INTERMEDIATE_TARGETS): \ 179 PRIVATE_ANDROID_MANIFEST := $(full_android_manifest) 180 181ifneq ($(all_resources),) 182 183# Since we don't know where the real R.java file is going to end up, 184# we need to use another file to stand in its place. We'll just 185# copy the generated file to src/R.stamp, which means it will 186# have the same contents and timestamp as the actual file. 187# 188# At the same time, this will copy the R.java file to a central 189# 'R' directory to make it easier to add the files to an IDE. 190# 191#TODO: use PRIVATE_SOURCE_INTERMEDIATES_DIR instead of 192# $(intermediates.COMMON)/src 193ifneq ($(package_expected_intermediates_COMMON),$(intermediates.COMMON)) 194 $(error $(LOCAL_MODULE): internal error: expected intermediates.COMMON "$(package_expected_intermediates_COMMON)" != intermediates.COMMON "$(intermediates.COMMON)") 195endif 196 197$(R_file_stamp): PRIVATE_RESOURCE_PUBLICS_OUTPUT := \ 198 $(intermediates.COMMON)/public_resources.xml 199$(R_file_stamp): PRIVATE_PROGUARD_OPTIONS_FILE := $(proguard_options_file) 200$(R_file_stamp): $(all_res_assets) $(full_android_manifest) $(AAPT) | $(ACP) 201 @echo "target R.java/Manifest.java: $(PRIVATE_MODULE) ($@)" 202 @rm -f $@ 203 $(create-resource-java-files) 204 $(hide) for GENERATED_MANIFEST_FILE in `find $(PRIVATE_SOURCE_INTERMEDIATES_DIR) \ 205 -name Manifest.java 2> /dev/null`; do \ 206 dir=`grep package $$GENERATED_MANIFEST_FILE | head -n1 | \ 207 awk '{print $$2}' | tr -d ";" | tr . /`; \ 208 mkdir -p $(TARGET_COMMON_OUT_ROOT)/R/$$dir; \ 209 $(ACP) -fpt $$GENERATED_MANIFEST_FILE $(TARGET_COMMON_OUT_ROOT)/R/$$dir; \ 210 done; 211 $(hide) for GENERATED_R_FILE in `find $(PRIVATE_SOURCE_INTERMEDIATES_DIR) \ 212 -name R.java 2> /dev/null`; do \ 213 dir=`grep package $$GENERATED_R_FILE | head -n1 | \ 214 awk '{print $$2}' | tr -d ";" | tr . /`; \ 215 mkdir -p $(TARGET_COMMON_OUT_ROOT)/R/$$dir; \ 216 $(ACP) -fpt $$GENERATED_R_FILE $(TARGET_COMMON_OUT_ROOT)/R/$$dir \ 217 || exit 31; \ 218 $(ACP) -fpt $$GENERATED_R_FILE $@ || exit 32; \ 219 done; \ 220 221$(proguard_options_file): $(R_file_stamp) 222 223ifdef LOCAL_EXPORT_PACKAGE_RESOURCES 224# Put this module's resources into a PRODUCT-agnositc package that 225# other packages can use to build their own PRODUCT-agnostic R.java (etc.) 226# files. 227resource_export_package := $(intermediates.COMMON)/package-export.apk 228$(R_file_stamp): $(resource_export_package) 229 230# add-assets-to-package looks at PRODUCT_AAPT_CONFIG, but this target 231# can't know anything about PRODUCT. Clear it out just for this target. 232$(resource_export_package): PRODUCT_AAPT_CONFIG := 233$(resource_export_package): $(all_res_assets) $(full_android_manifest) $(AAPT) 234 @echo "target Export Resources: $(PRIVATE_MODULE) ($@)" 235 $(create-empty-package) 236 $(add-assets-to-package) 237endif 238 239# Other modules should depend on the BUILT module if 240# they want to use this module's R.java file. 241$(LOCAL_BUILT_MODULE): $(R_file_stamp) 242 243ifneq ($(full_classes_jar),) 244# If full_classes_jar is non-empty, we're building sources. 245# If we're building sources, the initial javac step (which 246# produces full_classes_compiled_jar) needs to ensure the 247# R.java and Manifest.java files have been generated first. 248$(full_classes_compiled_jar): $(R_file_stamp) 249endif 250 251endif # all_resources 252 253ifeq ($(LOCAL_NO_STANDARD_LIBRARIES),true) 254# We need to explicitly clear this var so that we don't 255# inherit the value from whomever caused us to be built. 256$(LOCAL_INTERMEDIATE_TARGETS): PRIVATE_AAPT_INCLUDES := 257else 258# Most packages should link against the resources defined by framework-res. 259# Even if they don't have their own resources, they may use framework 260# resources. 261ifneq ($(filter-out current,$(LOCAL_SDK_VERSION)),) 262# for released sdk versions, the platform resources were built into android.jar. 263framework_res_package_export := \ 264 $(HISTORICAL_SDK_VERSIONS_ROOT)/$(LOCAL_SDK_VERSION)/android.jar 265framework_res_package_export_deps := $(framework_res_package_export) 266else # LOCAL_SDK_VERSION 267framework_res_package_export := \ 268 $(call intermediates-dir-for,APPS,framework-res,,COMMON)/package-export.apk 269# We can't depend directly on the export.apk file; it won't get its 270# PRIVATE_ vars set up correctly if we do. Instead, depend on the 271# corresponding R.stamp file, which lists the export.apk as a dependency. 272framework_res_package_export_deps := \ 273 $(dir $(framework_res_package_export))src/R.stamp 274endif # LOCAL_SDK_VERSION 275$(R_file_stamp): $(framework_res_package_export_deps) 276$(LOCAL_INTERMEDIATE_TARGETS): \ 277 PRIVATE_AAPT_INCLUDES := $(framework_res_package_export) 278endif # LOCAL_NO_STANDARD_LIBRARIES 279 280ifneq ($(full_classes_jar),) 281$(LOCAL_BUILT_MODULE): PRIVATE_DEX_FILE := $(built_dex) 282$(LOCAL_BUILT_MODULE): $(built_dex) 283endif # full_classes_jar 284 285 286# Get the list of jni libraries to be included in the apk file. 287 288so_suffix := $($(my_prefix)SHLIB_SUFFIX) 289 290jni_shared_libraries := \ 291 $(addprefix $($(my_prefix)OUT_INTERMEDIATE_LIBRARIES)/, \ 292 $(addsuffix $(so_suffix), \ 293 $(LOCAL_JNI_SHARED_LIBRARIES))) 294 295# Pick a key to sign the package with. If this package hasn't specified 296# an explicit certificate, use the default. 297# Secure release builds will have their packages signed after the fact, 298# so it's ok for these private keys to be in the clear. 299ifeq ($(LOCAL_CERTIFICATE),) 300 LOCAL_CERTIFICATE := testkey 301endif 302 303ifeq ($(LOCAL_CERTIFICATE),EXTERNAL) 304 # The special value "EXTERNAL" means that we will sign it with the 305 # default testkey, apply predexopt, but then expect the final .apk 306 # (after dexopting) to be signed by an outside tool. 307 LOCAL_CERTIFICATE := testkey 308 PACKAGES.$(LOCAL_PACKAGE_NAME).EXTERNAL_KEY := 1 309endif 310 311# If this is not an absolute certificate, assign it to a generic one. 312ifeq ($(dir $(strip $(LOCAL_CERTIFICATE))),./) 313 LOCAL_CERTIFICATE := $(SRC_TARGET_DIR)/product/security/$(LOCAL_CERTIFICATE) 314endif 315private_key := $(LOCAL_CERTIFICATE).pk8 316certificate := $(LOCAL_CERTIFICATE).x509.pem 317 318$(LOCAL_BUILT_MODULE): $(private_key) $(certificate) $(SIGNAPK_JAR) 319$(LOCAL_BUILT_MODULE): PRIVATE_PRIVATE_KEY := $(private_key) 320$(LOCAL_BUILT_MODULE): PRIVATE_CERTIFICATE := $(certificate) 321 322PACKAGES.$(LOCAL_PACKAGE_NAME).PRIVATE_KEY := $(private_key) 323PACKAGES.$(LOCAL_PACKAGE_NAME).CERTIFICATE := $(certificate) 324 325# Define the rule to build the actual package. 326$(LOCAL_BUILT_MODULE): $(AAPT) | $(ZIPALIGN) 327ifeq ($(LOCAL_DEX_PREOPT),true) 328# Make sure the boot jars get dexpreopt-ed first 329$(LOCAL_BUILT_MODULE): $(DEXPREOPT_BOOT_ODEXS) | $(DEXPREOPT) $(DEXOPT) 330endif 331$(LOCAL_BUILT_MODULE): PRIVATE_JNI_SHARED_LIBRARIES := $(jni_shared_libraries) 332ifneq ($(TARGET_BUILD_APPS),) 333 # Include all resources for unbundled apps. 334 $(LOCAL_BUILT_MODULE): PRODUCT_AAPT_CONFIG := 335endif 336$(LOCAL_BUILT_MODULE): $(all_res_assets) $(jni_shared_libraries) $(full_android_manifest) 337 @echo "target Package: $(PRIVATE_MODULE) ($@)" 338 $(create-empty-package) 339 $(add-assets-to-package) 340ifneq ($(jni_shared_libraries),) 341 $(add-jni-shared-libs-to-package) 342endif 343ifneq ($(full_classes_jar),) 344 $(add-dex-to-package) 345endif 346 $(sign-package) 347 @# Alignment must happen after all other zip operations. 348 $(align-package) 349ifeq ($(LOCAL_DEX_PREOPT),true) 350 $(hide) rm -f $(patsubst %.apk,%.odex,$@) 351 $(call dexpreopt-one-file,$@,$(patsubst %.apk,%.odex,$@)) 352 $(call dexpreopt-remove-classes.dex,$@) 353 354built_odex := $(basename $(LOCAL_BUILT_MODULE)).odex 355$(built_odex): $(LOCAL_BUILT_MODULE) 356endif 357 358# Save information about this package 359PACKAGES.$(LOCAL_PACKAGE_NAME).OVERRIDES := $(strip $(LOCAL_OVERRIDES_PACKAGES)) 360PACKAGES.$(LOCAL_PACKAGE_NAME).RESOURCE_FILES := $(all_resources) 361 362PACKAGES := $(PACKAGES) $(LOCAL_PACKAGE_NAME) 363 364endif # skip_definition 365