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