package.mk revision 81f0fd6cdbf42d1034bf9e9f36991a131eca3f4f 
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
68# If you need to put the MANIFEST_FILE outside of LOCAL_PATH
69# you can use FULL_MANIFEST_FILE
70ifeq ($(strip $(LOCAL_FULL_MANIFEST_FILE)),)
71LOCAL_FULL_MANIFEST_FILE := $(LOCAL_PATH)/$(LOCAL_MANIFEST_FILE)
72endif
73
74ifneq ($(strip $(LOCAL_MODULE_CLASS)),)
75$(error $(LOCAL_PATH): Package modules may not set LOCAL_MODULE_CLASS)
76endif
77LOCAL_MODULE_CLASS := APPS
78
79# Package LOCAL_MODULE_TAGS default to optional
80LOCAL_MODULE_TAGS := $(strip $(LOCAL_MODULE_TAGS))
81ifeq ($(LOCAL_MODULE_TAGS),)
82LOCAL_MODULE_TAGS := optional
83endif
84
85ifeq ($(filter tests, $(LOCAL_MODULE_TAGS)),)
86# Force localization check if it's not tagged as tests.
87LOCAL_AAPT_FLAGS := $(LOCAL_AAPT_FLAGS) -z
88endif
89
90# Convert LOCAL_JNI_SHARED_LIBRARIES to LOCAL_REQUIRED_MODULES in full build,
91# for preloaded apks don't like embedded jni libraries.
92ifndef TARGET_BUILD_APPS
93ifdef LOCAL_JNI_SHARED_LIBRARIES
94LOCAL_REQUIRED_MODULES += $(LOCAL_JNI_SHARED_LIBRARIES)
95LOCAL_JNI_SHARED_LIBRARIES :=
96endif
97endif
98
99ifeq (,$(LOCAL_ASSET_DIR))
100LOCAL_ASSET_DIR := $(LOCAL_PATH)/assets
101endif
102
103ifeq (,$(LOCAL_RESOURCE_DIR))
104  LOCAL_RESOURCE_DIR := $(LOCAL_PATH)/res
105endif
106
107package_resource_overlays := $(strip \
108    $(wildcard $(foreach dir, $(PRODUCT_PACKAGE_OVERLAYS), \
109      $(addprefix $(dir)/, $(LOCAL_RESOURCE_DIR)))) \
110    $(wildcard $(foreach dir, $(DEVICE_PACKAGE_OVERLAYS), \
111      $(addprefix $(dir)/, $(LOCAL_RESOURCE_DIR)))))
112
113LOCAL_RESOURCE_DIR := $(package_resource_overlays) $(LOCAL_RESOURCE_DIR)
114
115all_assets := $(call find-subdir-assets,$(LOCAL_ASSET_DIR))
116all_assets := $(addprefix $(LOCAL_ASSET_DIR)/,$(patsubst assets/%,%,$(all_assets)))
117
118all_resources := $(strip \
119    $(foreach dir, $(LOCAL_RESOURCE_DIR), \
120      $(addprefix $(dir)/, \
121        $(patsubst res/%,%, \
122          $(call find-subdir-assets,$(dir)) \
123         ) \
124       ) \
125     ))
126
127all_res_assets := $(strip $(all_assets) $(all_resources))
128
129package_expected_intermediates_COMMON := $(call local-intermediates-dir,COMMON)
130# If no assets or resources were found, clear the directory variables so
131# we don't try to build them.
132ifeq (,$(all_assets))
133LOCAL_ASSET_DIR:=
134endif
135ifeq (,$(all_resources))
136LOCAL_RESOURCE_DIR:=
137R_file_stamp :=
138else
139# Make sure that R_file_stamp inherits the proper PRIVATE vars.
140# If R.stamp moves, be sure to update the framework makefile,
141# which has intimate knowledge of its location.
142R_file_stamp := $(package_expected_intermediates_COMMON)/src/R.stamp
143LOCAL_INTERMEDIATE_TARGETS += $(R_file_stamp)
144endif
145
146LOCAL_BUILT_MODULE_STEM := package.apk
147
148LOCAL_PROGUARD_ENABLED:=$(strip $(LOCAL_PROGUARD_ENABLED))
149ifndef LOCAL_PROGUARD_ENABLED
150ifneq ($(filter user userdebug, $(TARGET_BUILD_VARIANT)),)
151    # turn on Proguard by default for user & userdebug build
152    LOCAL_PROGUARD_ENABLED :=full
153endif
154endif
155ifeq ($(LOCAL_PROGUARD_ENABLED),disabled)
156    # the package explicitly request to disable proguard.
157    LOCAL_PROGUARD_ENABLED :=
158endif
159proguard_options_file :=
160ifneq ($(LOCAL_PROGUARD_ENABLED),custom)
161ifneq ($(all_resources),)
162    proguard_options_file := $(package_expected_intermediates_COMMON)/proguard_options
163endif # all_resources
164endif # !custom
165LOCAL_PROGUARD_FLAGS := $(addprefix -include ,$(proguard_options_file)) $(LOCAL_PROGUARD_FLAGS)
166
167ifneq (true,$(WITH_DEXPREOPT))
168LOCAL_DEX_PREOPT :=
169else
170ifeq (,$(TARGET_BUILD_APPS))
171ifneq (,$(LOCAL_SRC_FILES))
172ifndef LOCAL_DEX_PREOPT
173LOCAL_DEX_PREOPT := true
174endif
175endif
176endif
177endif
178ifeq (false,$(LOCAL_DEX_PREOPT))
179LOCAL_DEX_PREOPT :=
180endif
181
182#################################
183include $(BUILD_SYSTEM)/java.mk
184#################################
185
186LOCAL_SDK_RES_VERSION:=$(strip $(LOCAL_SDK_RES_VERSION))
187ifeq ($(LOCAL_SDK_RES_VERSION),)
188  LOCAL_SDK_RES_VERSION:=$(LOCAL_SDK_VERSION)
189endif
190
191full_android_manifest := $(LOCAL_FULL_MANIFEST_FILE)
192$(LOCAL_INTERMEDIATE_TARGETS): \
193    PRIVATE_ANDROID_MANIFEST := $(full_android_manifest)
194ifneq (,$(filter-out current, $(LOCAL_SDK_VERSION)))
195$(LOCAL_INTERMEDIATE_TARGETS): \
196    PRIVATE_DEFAULT_APP_TARGET_SDK := $(LOCAL_SDK_VERSION)
197else
198$(LOCAL_INTERMEDIATE_TARGETS): \
199    PRIVATE_DEFAULT_APP_TARGET_SDK := $(DEFAULT_APP_TARGET_SDK)
200endif
201
202ifneq ($(all_resources),)
203
204# Since we don't know where the real R.java file is going to end up,
205# we need to use another file to stand in its place.  We'll just
206# copy the generated file to src/R.stamp, which means it will
207# have the same contents and timestamp as the actual file.
208#
209# At the same time, this will copy the R.java file to a central
210# 'R' directory to make it easier to add the files to an IDE.
211#
212#TODO: use PRIVATE_SOURCE_INTERMEDIATES_DIR instead of
213#      $(intermediates.COMMON)/src
214ifneq ($(package_expected_intermediates_COMMON),$(intermediates.COMMON))
215  $(error $(LOCAL_MODULE): internal error: expected intermediates.COMMON "$(package_expected_intermediates_COMMON)" != intermediates.COMMON "$(intermediates.COMMON)")
216endif
217
218$(R_file_stamp): PRIVATE_RESOURCE_PUBLICS_OUTPUT := \
219			$(intermediates.COMMON)/public_resources.xml
220$(R_file_stamp): PRIVATE_PROGUARD_OPTIONS_FILE := $(proguard_options_file)
221$(R_file_stamp): $(all_res_assets) $(full_android_manifest) $(RenderScript_file_stamp) $(AAPT) | $(ACP)
222	@echo "target R.java/Manifest.java: $(PRIVATE_MODULE) ($@)"
223	@rm -f $@
224	$(create-resource-java-files)
225	$(hide) for GENERATED_MANIFEST_FILE in `find $(PRIVATE_SOURCE_INTERMEDIATES_DIR) \
226					-name Manifest.java 2> /dev/null`; do \
227		dir=`awk '/package/{gsub(/\./,"/",$$2);gsub(/;/,"",$$2);print $$2;exit}' $$GENERATED_MANIFEST_FILE`; \
228		mkdir -p $(TARGET_COMMON_OUT_ROOT)/R/$$dir; \
229		$(ACP) -fp $$GENERATED_MANIFEST_FILE $(TARGET_COMMON_OUT_ROOT)/R/$$dir; \
230	done;
231	$(hide) for GENERATED_R_FILE in `find $(PRIVATE_SOURCE_INTERMEDIATES_DIR) \
232					-name R.java 2> /dev/null`; do \
233		dir=`awk '/package/{gsub(/\./,"/",$$2);gsub(/;/,"",$$2);print $$2;exit}' $$GENERATED_R_FILE`; \
234		mkdir -p $(TARGET_COMMON_OUT_ROOT)/R/$$dir; \
235		$(ACP) -fp $$GENERATED_R_FILE $(TARGET_COMMON_OUT_ROOT)/R/$$dir \
236			|| exit 31; \
237		$(ACP) -fp $$GENERATED_R_FILE $@ || exit 32; \
238	done; \
239
240$(proguard_options_file): $(R_file_stamp)
241
242ifdef LOCAL_EXPORT_PACKAGE_RESOURCES
243# Put this module's resources into a PRODUCT-agnositc package that
244# other packages can use to build their own PRODUCT-agnostic R.java (etc.)
245# files.
246resource_export_package := $(intermediates.COMMON)/package-export.apk
247$(R_file_stamp): $(resource_export_package)
248
249# add-assets-to-package looks at PRODUCT_AAPT_CONFIG, but this target
250# can't know anything about PRODUCT.  Clear it out just for this target.
251$(resource_export_package): PRIVATE_PRODUCT_AAPT_CONFIG :=
252$(resource_export_package): PRIVATE_PRODUCT_AAPT_PREF_CONFIG :=
253$(resource_export_package): $(all_res_assets) $(full_android_manifest) $(RenderScript_file_stamp) $(AAPT)
254	@echo "target Export Resources: $(PRIVATE_MODULE) ($@)"
255	$(create-empty-package)
256	$(add-assets-to-package)
257endif
258
259# Other modules should depend on the BUILT module if
260# they want to use this module's R.java file.
261$(LOCAL_BUILT_MODULE): $(R_file_stamp)
262
263ifneq ($(full_classes_jar),)
264# If full_classes_jar is non-empty, we're building sources.
265# If we're building sources, the initial javac step (which
266# produces full_classes_compiled_jar) needs to ensure the
267# R.java and Manifest.java files have been generated first.
268$(full_classes_compiled_jar): $(R_file_stamp)
269endif
270
271endif  # all_resources
272
273ifeq ($(LOCAL_NO_STANDARD_LIBRARIES),true)
274# We need to explicitly clear this var so that we don't
275# inherit the value from whomever caused us to be built.
276$(LOCAL_INTERMEDIATE_TARGETS): PRIVATE_AAPT_INCLUDES :=
277else
278# Most packages should link against the resources defined by framework-res.
279# Even if they don't have their own resources, they may use framework
280# resources.
281ifneq ($(filter-out current,$(LOCAL_SDK_RES_VERSION))$(if $(TARGET_BUILD_APPS),$(filter current,$(LOCAL_SDK_RES_VERSION))),)
282# for released sdk versions, the platform resources were built into android.jar.
283framework_res_package_export := \
284    $(HISTORICAL_SDK_VERSIONS_ROOT)/$(LOCAL_SDK_RES_VERSION)/android.jar
285framework_res_package_export_deps := $(framework_res_package_export)
286else # LOCAL_SDK_RES_VERSION
287framework_res_package_export := \
288    $(call intermediates-dir-for,APPS,framework-res,,COMMON)/package-export.apk
289# We can't depend directly on the export.apk file; it won't get its
290# PRIVATE_ vars set up correctly if we do.  Instead, depend on the
291# corresponding R.stamp file, which lists the export.apk as a dependency.
292framework_res_package_export_deps := \
293    $(dir $(framework_res_package_export))src/R.stamp
294endif # LOCAL_SDK_RES_VERSION
295$(R_file_stamp): $(framework_res_package_export_deps)
296$(LOCAL_INTERMEDIATE_TARGETS): \
297    PRIVATE_AAPT_INCLUDES := $(framework_res_package_export)
298endif # LOCAL_NO_STANDARD_LIBRARIES
299
300ifneq ($(full_classes_jar),)
301$(LOCAL_BUILT_MODULE): PRIVATE_DEX_FILE := $(built_dex)
302$(LOCAL_BUILT_MODULE): $(built_dex)
303endif # full_classes_jar
304
305
306# Get the list of jni libraries to be included in the apk file.
307
308so_suffix := $($(my_prefix)SHLIB_SUFFIX)
309
310jni_shared_libraries := \
311    $(addprefix $($(my_prefix)OUT_INTERMEDIATE_LIBRARIES)/, \
312      $(addsuffix $(so_suffix), \
313        $(LOCAL_JNI_SHARED_LIBRARIES)))
314
315# App explicitly requires the prebuilt NDK libstlport_shared.so.
316# libstlport_shared.so should never go to the system image.
317# Instead it should be packaged into the apk.
318ifeq (stlport_shared,$(LOCAL_NDK_STL_VARIANT))
319ifndef LOCAL_NDK_VERSION
320$(error LOCAL_NDK_VERSION has to be defined together with LOCAL_NDK_STL_VARIANT, \
321    LOCAL_PACKAGE_NAME=$(LOCAL_PACKAGE_NAME))
322endif
323jni_shared_libraries += \
324    $(HISTORICAL_NDK_VERSIONS_ROOT)/android-ndk-r$(LOCAL_NDK_VERSION)/sources/cxx-stl/stlport/libs/$(TARGET_CPU_ABI)/libstlport_shared.so
325endif
326
327# Set the abi directory used by the local JNI shared libraries.
328# (Doesn't change how the local shared libraries are compiled, just
329# sets where they are stored in the apk.)
330
331ifeq ($(LOCAL_JNI_SHARED_LIBRARIES_ABI),)
332    jni_shared_libraries_abi := $(TARGET_CPU_ABI)
333else
334    jni_shared_libraries_abi := $(LOCAL_JNI_SHARED_LIBRARIES_ABI)
335endif
336
337# Pick a key to sign the package with.  If this package hasn't specified
338# an explicit certificate, use the default.
339# Secure release builds will have their packages signed after the fact,
340# so it's ok for these private keys to be in the clear.
341ifeq ($(LOCAL_CERTIFICATE),)
342    LOCAL_CERTIFICATE := $(DEFAULT_SYSTEM_DEV_CERTIFICATE)
343endif
344
345ifeq ($(LOCAL_CERTIFICATE),EXTERNAL)
346  # The special value "EXTERNAL" means that we will sign it with the
347  # default devkey, apply predexopt, but then expect the final .apk
348  # (after dexopting) to be signed by an outside tool.
349  LOCAL_CERTIFICATE := $(DEFAULT_SYSTEM_DEV_CERTIFICATE)
350  PACKAGES.$(LOCAL_PACKAGE_NAME).EXTERNAL_KEY := 1
351endif
352
353# If this is not an absolute certificate, assign it to a generic one.
354ifeq ($(dir $(strip $(LOCAL_CERTIFICATE))),./)
355    LOCAL_CERTIFICATE := $(dir $(DEFAULT_SYSTEM_DEV_CERTIFICATE))$(LOCAL_CERTIFICATE)
356endif
357private_key := $(LOCAL_CERTIFICATE).pk8
358certificate := $(LOCAL_CERTIFICATE).x509.pem
359
360$(LOCAL_BUILT_MODULE): $(private_key) $(certificate) $(SIGNAPK_JAR)
361$(LOCAL_BUILT_MODULE): PRIVATE_PRIVATE_KEY := $(private_key)
362$(LOCAL_BUILT_MODULE): PRIVATE_CERTIFICATE := $(certificate)
363
364PACKAGES.$(LOCAL_PACKAGE_NAME).PRIVATE_KEY := $(private_key)
365PACKAGES.$(LOCAL_PACKAGE_NAME).CERTIFICATE := $(certificate)
366
367# Define the rule to build the actual package.
368$(LOCAL_BUILT_MODULE): $(AAPT) | $(ZIPALIGN)
369ifdef LOCAL_DEX_PREOPT
370# Make sure the boot jars get dexpreopt-ed first
371$(LOCAL_BUILT_MODULE): $(DEXPREOPT_BOOT_ODEXS) | $(DEXPREOPT) $(DEXOPT)
372endif
373$(LOCAL_BUILT_MODULE): PRIVATE_JNI_SHARED_LIBRARIES := $(jni_shared_libraries)
374$(LOCAL_BUILT_MODULE): PRIVATE_JNI_SHARED_LIBRARIES_ABI := $(jni_shared_libraries_abi)
375ifneq ($(TARGET_BUILD_APPS),)
376    # Include all resources for unbundled apps.
377    LOCAL_AAPT_INCLUDE_ALL_RESOURCES := true
378endif
379ifeq ($(LOCAL_AAPT_INCLUDE_ALL_RESOURCES),true)
380    $(LOCAL_BUILT_MODULE): PRIVATE_PRODUCT_AAPT_CONFIG :=
381    $(LOCAL_BUILT_MODULE): PRIVATE_PRODUCT_AAPT_PREF_CONFIG :=
382else
383    $(LOCAL_BUILT_MODULE): PRIVATE_PRODUCT_AAPT_CONFIG := $(PRODUCT_AAPT_CONFIG)
384    $(LOCAL_BUILT_MODULE): PRIVATE_PRODUCT_AAPT_PREF_CONFIG := $(PRODUCT_AAPT_PREF_CONFIG)
385endif
386$(LOCAL_BUILT_MODULE): $(all_res_assets) $(jni_shared_libraries) $(full_android_manifest)
387	@echo "target Package: $(PRIVATE_MODULE) ($@)"
388	$(create-empty-package)
389	$(add-assets-to-package)
390ifneq ($(jni_shared_libraries),)
391	$(add-jni-shared-libs-to-package)
392endif
393ifneq ($(full_classes_jar),)
394	$(add-dex-to-package)
395endif
396	$(sign-package)
397	@# Alignment must happen after all other zip operations.
398	$(align-package)
399ifdef LOCAL_DEX_PREOPT
400	$(hide) rm -f $(patsubst %.apk,%.odex,$@)
401	$(call dexpreopt-one-file,$@,$(patsubst %.apk,%.odex,$@))
402ifneq (nostripping,$(LOCAL_DEX_PREOPT))
403	$(call dexpreopt-remove-classes.dex,$@)
404endif
405
406built_odex := $(basename $(LOCAL_BUILT_MODULE)).odex
407$(built_odex): $(LOCAL_BUILT_MODULE)
408endif
409
410# Save information about this package
411PACKAGES.$(LOCAL_PACKAGE_NAME).OVERRIDES := $(strip $(LOCAL_OVERRIDES_PACKAGES))
412PACKAGES.$(LOCAL_PACKAGE_NAME).RESOURCE_FILES := $(all_resources)
413ifdef package_resource_overlays
414PACKAGES.$(LOCAL_PACKAGE_NAME).RESOURCE_OVERLAYS := $(package_resource_overlays)
415endif
416
417PACKAGES := $(PACKAGES) $(LOCAL_PACKAGE_NAME)
418
419endif # skip_definition
420