2 # Copyright (C) 2008 The Android Open Source Project
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
8 # http://www.apache.org/licenses/LICENSE-2.0
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.
17 ###########################################################
18 ## Standard rules for building an application package.
20 ## Additional inputs from base_rules.make:
21 ## LOCAL_PACKAGE_NAME: The name of the package; the directory
22 ## will be called this.
24 ## MODULE, MODULE_PATH, and MODULE_SUFFIX will
26 ###########################################################
29 # If this makefile is being read from within an inheritance,
32 ifdef LOCAL_PACKAGE_OVERRIDES
33 package_overridden := $(call set-inherited-package-variables)
34 ifeq ($(strip $(package_overridden)),)
35 skip_definition := true
39 ifndef skip_definition
41 LOCAL_PACKAGE_NAME := $(strip $(LOCAL_PACKAGE_NAME))
42 ifeq ($(LOCAL_PACKAGE_NAME),)
43 $(error $(LOCAL_PATH): Package modules must define LOCAL_PACKAGE_NAME)
46 ifneq ($(strip $(LOCAL_MODULE_SUFFIX)),)
47 $(error $(LOCAL_PATH): Package modules may not define LOCAL_MODULE_SUFFIX)
49 LOCAL_MODULE_SUFFIX := $(COMMON_ANDROID_PACKAGE_SUFFIX)
51 ifneq ($(strip $(LOCAL_MODULE)),)
52 $(error $(LOCAL_PATH): Package modules may not define LOCAL_MODULE)
54 LOCAL_MODULE := $(LOCAL_PACKAGE_NAME)
56 ifeq ($(strip $(LOCAL_MANIFEST_FILE)),)
57 LOCAL_MANIFEST_FILE := AndroidManifest.xml
60 # If you need to put the MANIFEST_FILE outside of LOCAL_PATH
61 # you can use FULL_MANIFEST_FILE
62 ifeq ($(strip $(LOCAL_FULL_MANIFEST_FILE)),)
63 LOCAL_FULL_MANIFEST_FILE := $(LOCAL_PATH)/$(LOCAL_MANIFEST_FILE)
66 ifneq ($(strip $(LOCAL_MODULE_CLASS)),)
67 $(error $(LOCAL_PATH): Package modules may not set LOCAL_MODULE_CLASS)
69 LOCAL_MODULE_CLASS := APPS
71 # Package LOCAL_MODULE_TAGS default to optional
72 LOCAL_MODULE_TAGS := $(strip $(LOCAL_MODULE_TAGS))
73 ifeq ($(LOCAL_MODULE_TAGS),)
74 LOCAL_MODULE_TAGS := optional
77 ifeq ($(filter tests, $(LOCAL_MODULE_TAGS)),)
78 # Force localization check if it's not tagged as tests.
79 LOCAL_AAPT_FLAGS := $(LOCAL_AAPT_FLAGS) -z
82 ifeq (,$(LOCAL_ASSET_DIR))
83 LOCAL_ASSET_DIR := $(LOCAL_PATH)/assets
86 ifeq (,$(LOCAL_RESOURCE_DIR))
87 LOCAL_RESOURCE_DIR := $(LOCAL_PATH)/res
90 package_resource_overlays := $(strip \
91 $(wildcard $(foreach dir, $(PRODUCT_PACKAGE_OVERLAYS), \
92 $(addprefix $(dir)/, $(LOCAL_RESOURCE_DIR)))) \
93 $(wildcard $(foreach dir, $(DEVICE_PACKAGE_OVERLAYS), \
94 $(addprefix $(dir)/, $(LOCAL_RESOURCE_DIR)))))
96 LOCAL_RESOURCE_DIR := $(package_resource_overlays) $(LOCAL_RESOURCE_DIR)
98 all_assets := $(call find-subdir-assets,$(LOCAL_ASSET_DIR))
99 all_assets := $(addprefix $(LOCAL_ASSET_DIR)/,$(patsubst assets/%,%,$(all_assets)))
101 all_resources := $(strip \
102 $(foreach dir, $(LOCAL_RESOURCE_DIR), \
103 $(addprefix $(dir)/, \
104 $(patsubst res/%,%, \
105 $(call find-subdir-assets,$(dir)) \
110 all_res_assets := $(strip $(all_assets) $(all_resources))
112 package_expected_intermediates_COMMON := $(call local-intermediates-dir,COMMON)
113 # If no assets or resources were found, clear the directory variables so
114 # we don't try to build them.
115 ifeq (,$(all_assets))
118 ifeq (,$(all_resources))
122 # Make sure that R_file_stamp inherits the proper PRIVATE vars.
123 # If R.stamp moves, be sure to update the framework makefile,
124 # which has intimate knowledge of its location.
125 R_file_stamp := $(package_expected_intermediates_COMMON)/src/R.stamp
126 LOCAL_INTERMEDIATE_TARGETS += $(R_file_stamp)
129 LOCAL_BUILT_MODULE_STEM := package.apk
131 LOCAL_PROGUARD_ENABLED:=$(strip $(LOCAL_PROGUARD_ENABLED))
132 ifndef LOCAL_PROGUARD_ENABLED
133 ifneq ($(filter user userdebug, $(TARGET_BUILD_VARIANT)),)
134 # turn on Proguard by default for user & userdebug build
135 LOCAL_PROGUARD_ENABLED :=full
138 ifeq ($(LOCAL_PROGUARD_ENABLED),disabled)
139 # the package explicitly request to disable proguard.
140 LOCAL_PROGUARD_ENABLED :=
142 proguard_options_file :=
143 ifneq ($(LOCAL_PROGUARD_ENABLED),custom)
144 ifneq ($(all_resources),)
145 proguard_options_file := $(package_expected_intermediates_COMMON)/proguard_options
146 endif # all_resources
148 LOCAL_PROGUARD_FLAGS := $(addprefix -include ,$(proguard_options_file)) $(LOCAL_PROGUARD_FLAGS)
150 ifneq (true,$(WITH_DEXPREOPT))
153 ifeq (,$(TARGET_BUILD_APPS))
154 ifeq (,$(LOCAL_APK_LIBRARIES))
155 ifneq (,$(LOCAL_SRC_FILES))
156 ifndef LOCAL_DEX_PREOPT
157 LOCAL_DEX_PREOPT := true
163 ifeq (false,$(LOCAL_DEX_PREOPT))
167 ifeq (true,$(EMMA_INSTRUMENT))
168 ifndef LOCAL_EMMA_INSTRUMENT
169 # No emma for test apks.
170 ifeq (,$(filer tests,$(LOCAL_MODULE_TAGS))$(LOCAL_INSTRUMENTATION_FOR))
171 LOCAL_EMMA_INSTRUMENT := true
173 endif # LOCAL_EMMA_INSTRUMENT is not set
175 LOCAL_EMMA_INSTRUMENT := false
176 endif # EMMA_INSTRUMENT is true
178 ifeq (true,$(LOCAL_EMMA_INSTRUMENT))
179 ifeq (true,$(EMMA_INSTRUMENT_STATIC))
180 LOCAL_STATIC_JAVA_LIBRARIES += emma
182 ifdef LOCAL_SDK_VERSION
183 ifdef TARGET_BUILD_APPS
184 # In unbundled build merge the emma library into the apk.
185 LOCAL_STATIC_JAVA_LIBRARIES += emma
187 # If build against the SDK in full build, core.jar is not used,
188 # we have to use prebiult emma.jar to make Proguard happy;
189 # Otherwise emma classes are included in core.jar.
190 LOCAL_PROGUARD_FLAGS += -libraryjars $(EMMA_JAR)
192 endif # LOCAL_SDK_VERSION
193 endif # EMMA_INSTRUMENT_STATIC
194 endif # LOCAL_EMMA_INSTRUMENT
196 rs_compatibility_jni_libs :=
198 #################################
199 include $(BUILD_SYSTEM)/java.mk
200 #################################
202 LOCAL_SDK_RES_VERSION:=$(strip $(LOCAL_SDK_RES_VERSION))
203 ifeq ($(LOCAL_SDK_RES_VERSION),)
204 LOCAL_SDK_RES_VERSION:=$(LOCAL_SDK_VERSION)
207 full_android_manifest := $(LOCAL_FULL_MANIFEST_FILE)
208 $(LOCAL_INTERMEDIATE_TARGETS): \
209 PRIVATE_ANDROID_MANIFEST := $(full_android_manifest)
210 ifneq (,$(filter-out current, $(LOCAL_SDK_VERSION)))
211 $(LOCAL_INTERMEDIATE_TARGETS): \
212 PRIVATE_DEFAULT_APP_TARGET_SDK := $(LOCAL_SDK_VERSION)
214 $(LOCAL_INTERMEDIATE_TARGETS): \
215 PRIVATE_DEFAULT_APP_TARGET_SDK := $(DEFAULT_APP_TARGET_SDK)
218 ifneq ($(all_resources),)
220 # Since we don't know where the real R.java file is going to end up,
221 # we need to use another file to stand in its place. We'll just
222 # copy the generated file to src/R.stamp, which means it will
223 # have the same contents and timestamp as the actual file.
225 # At the same time, this will copy the R.java file to a central
226 # 'R' directory to make it easier to add the files to an IDE.
228 #TODO: use PRIVATE_SOURCE_INTERMEDIATES_DIR instead of
229 # $(intermediates.COMMON)/src
230 ifneq ($(package_expected_intermediates_COMMON),$(intermediates.COMMON))
231 $(error $(LOCAL_MODULE): internal error: expected intermediates.COMMON "$(package_expected_intermediates_COMMON)" != intermediates.COMMON "$(intermediates.COMMON)")
234 $(R_file_stamp): PRIVATE_RESOURCE_PUBLICS_OUTPUT := \
235 $(intermediates.COMMON)/public_resources.xml
236 $(R_file_stamp): PRIVATE_PROGUARD_OPTIONS_FILE := $(proguard_options_file)
237 $(R_file_stamp): $(all_res_assets) $(full_android_manifest) $(RenderScript_file_stamp) $(AAPT) | $(ACP)
238 @echo "target R.java/Manifest.java: $(PRIVATE_MODULE) ($@)"
240 $(create-resource-java-files)
241 $(hide) for GENERATED_MANIFEST_FILE in `find $(PRIVATE_SOURCE_INTERMEDIATES_DIR) \
242 -name Manifest.java 2> /dev/null`; do \
243 dir=`awk '/package/{gsub(/\./,"/",$$2);gsub(/;/,"",$$2);print $$2;exit}' $$GENERATED_MANIFEST_FILE`; \
244 mkdir -p $(TARGET_COMMON_OUT_ROOT)/R/$$dir; \
245 $(ACP) -fp $$GENERATED_MANIFEST_FILE $(TARGET_COMMON_OUT_ROOT)/R/$$dir; \
247 $(hide) for GENERATED_R_FILE in `find $(PRIVATE_SOURCE_INTERMEDIATES_DIR) \
248 -name R.java 2> /dev/null`; do \
249 dir=`awk '/package/{gsub(/\./,"/",$$2);gsub(/;/,"",$$2);print $$2;exit}' $$GENERATED_R_FILE`; \
250 mkdir -p $(TARGET_COMMON_OUT_ROOT)/R/$$dir; \
251 $(ACP) -fp $$GENERATED_R_FILE $(TARGET_COMMON_OUT_ROOT)/R/$$dir \
253 $(ACP) -fp $$GENERATED_R_FILE $@ || exit 32; \
256 $(proguard_options_file): $(R_file_stamp)
258 ifdef LOCAL_EXPORT_PACKAGE_RESOURCES
259 # Put this module's resources into a PRODUCT-agnositc package that
260 # other packages can use to build their own PRODUCT-agnostic R.java (etc.)
262 resource_export_package := $(intermediates.COMMON)/package-export.apk
263 $(R_file_stamp): $(resource_export_package)
265 # add-assets-to-package looks at PRODUCT_AAPT_CONFIG, but this target
266 # can't know anything about PRODUCT. Clear it out just for this target.
267 $(resource_export_package): PRIVATE_PRODUCT_AAPT_CONFIG :=
268 $(resource_export_package): PRIVATE_PRODUCT_AAPT_PREF_CONFIG :=
269 $(resource_export_package): $(all_res_assets) $(full_android_manifest) $(RenderScript_file_stamp) $(AAPT)
270 @echo "target Export Resources: $(PRIVATE_MODULE) ($@)"
271 $(create-empty-package)
272 $(add-assets-to-package)
275 # Other modules should depend on the BUILT module if
276 # they want to use this module's R.java file.
277 $(LOCAL_BUILT_MODULE): $(R_file_stamp)
279 ifneq ($(full_classes_jar),)
280 # If full_classes_jar is non-empty, we're building sources.
281 # If we're building sources, the initial javac step (which
282 # produces full_classes_compiled_jar) needs to ensure the
283 # R.java and Manifest.java files have been generated first.
284 $(full_classes_compiled_jar): $(R_file_stamp)
287 endif # all_resources
289 ifeq ($(LOCAL_NO_STANDARD_LIBRARIES),true)
290 # We need to explicitly clear this var so that we don't
291 # inherit the value from whomever caused us to be built.
292 $(LOCAL_INTERMEDIATE_TARGETS): PRIVATE_AAPT_INCLUDES :=
294 # Most packages should link against the resources defined by framework-res.
295 # Even if they don't have their own resources, they may use framework
297 ifneq ($(filter-out current,$(LOCAL_SDK_RES_VERSION))$(if $(TARGET_BUILD_APPS),$(filter current,$(LOCAL_SDK_RES_VERSION))),)
298 # for released sdk versions, the platform resources were built into android.jar.
299 framework_res_package_export := \
300 $(HISTORICAL_SDK_VERSIONS_ROOT)/$(LOCAL_SDK_RES_VERSION)/android.jar
301 framework_res_package_export_deps := $(framework_res_package_export)
302 else # LOCAL_SDK_RES_VERSION
303 framework_res_package_export := \
304 $(call intermediates-dir-for,APPS,framework-res,,COMMON)/package-export.apk
305 # We can't depend directly on the export.apk file; it won't get its
306 # PRIVATE_ vars set up correctly if we do. Instead, depend on the
307 # corresponding R.stamp file, which lists the export.apk as a dependency.
308 framework_res_package_export_deps := \
309 $(dir $(framework_res_package_export))src/R.stamp
310 endif # LOCAL_SDK_RES_VERSION
311 $(R_file_stamp): $(framework_res_package_export_deps)
312 $(LOCAL_INTERMEDIATE_TARGETS): \
313 PRIVATE_AAPT_INCLUDES := $(framework_res_package_export)
314 endif # LOCAL_NO_STANDARD_LIBRARIES
316 ifneq ($(full_classes_jar),)
317 $(LOCAL_BUILT_MODULE): PRIVATE_DEX_FILE := $(built_dex)
318 $(LOCAL_BUILT_MODULE): $(built_dex)
319 endif # full_classes_jar
322 # Get the list of jni libraries to be included in the apk file.
324 so_suffix := $($(my_prefix)SHLIB_SUFFIX)
326 jni_shared_libraries := \
327 $(addprefix $($(my_prefix)OUT_INTERMEDIATE_LIBRARIES)/, \
328 $(addsuffix $(so_suffix), \
329 $(LOCAL_JNI_SHARED_LIBRARIES)))
331 # Include RS dynamically-generated libraries as well
332 # Keep this ifneq, as the += otherwise adds spaces that need to be stripped.
333 ifneq ($(rs_compatibility_jni_libs),)
334 jni_shared_libraries += $(rs_compatibility_jni_libs)
337 # App explicitly requires the prebuilt NDK libstlport_shared.so.
338 # libstlport_shared.so should never go to the system image.
339 # Instead it should be packaged into the apk.
340 ifeq (stlport_shared,$(LOCAL_NDK_STL_VARIANT))
341 ifndef LOCAL_SDK_VERSION
342 $(error LOCAL_SDK_VERSION has to be defined together with LOCAL_NDK_STL_VARIANT, \
343 LOCAL_PACKAGE_NAME=$(LOCAL_PACKAGE_NAME))
345 jni_shared_libraries += \
346 $(HISTORICAL_NDK_VERSIONS_ROOT)/current/sources/cxx-stl/stlport/libs/$(TARGET_CPU_ABI)/libstlport_shared.so
349 # Set the abi directory used by the local JNI shared libraries.
350 # (Doesn't change how the local shared libraries are compiled, just
351 # sets where they are stored in the apk.)
353 ifeq ($(LOCAL_JNI_SHARED_LIBRARIES_ABI),)
354 jni_shared_libraries_abi := $(TARGET_CPU_ABI)
356 jni_shared_libraries_abi := $(LOCAL_JNI_SHARED_LIBRARIES_ABI)
359 # Pick a key to sign the package with. If this package hasn't specified
360 # an explicit certificate, use the default.
361 # Secure release builds will have their packages signed after the fact,
362 # so it's ok for these private keys to be in the clear.
363 ifeq ($(LOCAL_CERTIFICATE),)
364 LOCAL_CERTIFICATE := $(DEFAULT_SYSTEM_DEV_CERTIFICATE)
367 ifeq ($(LOCAL_CERTIFICATE),EXTERNAL)
368 # The special value "EXTERNAL" means that we will sign it with the
369 # default devkey, apply predexopt, but then expect the final .apk
370 # (after dexopting) to be signed by an outside tool.
371 LOCAL_CERTIFICATE := $(DEFAULT_SYSTEM_DEV_CERTIFICATE)
372 PACKAGES.$(LOCAL_PACKAGE_NAME).EXTERNAL_KEY := 1
375 # If this is not an absolute certificate, assign it to a generic one.
376 ifeq ($(dir $(strip $(LOCAL_CERTIFICATE))),./)
377 LOCAL_CERTIFICATE := $(dir $(DEFAULT_SYSTEM_DEV_CERTIFICATE))$(LOCAL_CERTIFICATE)
379 private_key := $(LOCAL_CERTIFICATE).pk8
380 certificate := $(LOCAL_CERTIFICATE).x509.pem
382 $(LOCAL_BUILT_MODULE): $(private_key) $(certificate) $(SIGNAPK_JAR)
383 $(LOCAL_BUILT_MODULE): PRIVATE_PRIVATE_KEY := $(private_key)
384 $(LOCAL_BUILT_MODULE): PRIVATE_CERTIFICATE := $(certificate)
386 PACKAGES.$(LOCAL_PACKAGE_NAME).PRIVATE_KEY := $(private_key)
387 PACKAGES.$(LOCAL_PACKAGE_NAME).CERTIFICATE := $(certificate)
389 $(LOCAL_BUILT_MODULE): PRIVATE_ADDITIONAL_CERTIFICATES := $(foreach c,\
390 $(LOCAL_ADDITIONAL_CERTIFICATES), $(c).x509.pem $(c).pk8)
392 # Define the rule to build the actual package.
393 $(LOCAL_BUILT_MODULE): $(AAPT) | $(ZIPALIGN)
394 ifdef LOCAL_DEX_PREOPT
395 # Make sure the boot jars get dexpreopt-ed first
396 $(LOCAL_BUILT_MODULE): $(DEXPREOPT_BOOT_ODEXS) | $(DEXPREOPT) $(DEXOPT)
398 $(LOCAL_BUILT_MODULE): PRIVATE_JNI_SHARED_LIBRARIES := $(jni_shared_libraries)
399 $(LOCAL_BUILT_MODULE): PRIVATE_JNI_SHARED_LIBRARIES_ABI := $(jni_shared_libraries_abi)
400 ifneq ($(TARGET_BUILD_APPS),)
401 # Include all resources for unbundled apps.
402 LOCAL_AAPT_INCLUDE_ALL_RESOURCES := true
404 ifeq ($(LOCAL_AAPT_INCLUDE_ALL_RESOURCES),true)
405 $(LOCAL_BUILT_MODULE): PRIVATE_PRODUCT_AAPT_CONFIG :=
406 $(LOCAL_BUILT_MODULE): PRIVATE_PRODUCT_AAPT_PREF_CONFIG :=
408 $(LOCAL_BUILT_MODULE): PRIVATE_PRODUCT_AAPT_CONFIG := $(PRODUCT_AAPT_CONFIG)
409 $(LOCAL_BUILT_MODULE): PRIVATE_PRODUCT_AAPT_PREF_CONFIG := $(PRODUCT_AAPT_PREF_CONFIG)
411 $(LOCAL_BUILT_MODULE): $(all_res_assets) $(jni_shared_libraries) $(full_android_manifest)
412 @echo "target Package: $(PRIVATE_MODULE) ($@)"
413 $(create-empty-package)
414 $(add-assets-to-package)
415 ifneq ($(jni_shared_libraries),)
416 $(add-jni-shared-libs-to-package)
418 ifneq ($(full_classes_jar),)
419 $(add-dex-to-package)
421 $(add-carried-java-resources)
422 ifneq ($(extra_jar_args),)
423 $(add-java-resources-to-package)
426 ifdef LOCAL_DEX_PREOPT
427 $(hide) rm -f $(patsubst %.apk,%.odex,$@)
428 $(call dexpreopt-one-file,$@,$(patsubst %.apk,%.odex,$@))
429 ifneq (nostripping,$(LOCAL_DEX_PREOPT))
430 $(call dexpreopt-remove-classes.dex,$@)
433 @# Alignment must happen after all other zip operations.
436 ifdef LOCAL_DEX_PREOPT
437 built_odex := $(basename $(LOCAL_BUILT_MODULE)).odex
438 $(built_odex): $(LOCAL_BUILT_MODULE)
441 # Save information about this package
442 PACKAGES.$(LOCAL_PACKAGE_NAME).OVERRIDES := $(strip $(LOCAL_OVERRIDES_PACKAGES))
443 PACKAGES.$(LOCAL_PACKAGE_NAME).RESOURCE_FILES := $(all_resources)
444 ifdef package_resource_overlays
445 PACKAGES.$(LOCAL_PACKAGE_NAME).RESOURCE_OVERLAYS := $(package_resource_overlays)
448 PACKAGES := $(PACKAGES) $(LOCAL_PACKAGE_NAME)
451 .PHONY: lint-$(LOCAL_PACKAGE_NAME)
452 lint-$(LOCAL_PACKAGE_NAME): PRIVATE_PATH := $(LOCAL_PATH)
453 lint-$(LOCAL_PACKAGE_NAME): PRIVATE_LINT_FLAGS := $(LOCAL_LINT_FLAGS)
454 lint-$(LOCAL_PACKAGE_NAME) :
455 @echo lint $(PRIVATE_PATH)
456 $(LINT) $(PRIVATE_LINT_FLAGS) $(PRIVATE_PATH)
458 lintall : lint-$(LOCAL_PACKAGE_NAME)
460 endif # skip_definition