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