package.mk revision c61d5932d3b1014352dd5cbcb2684a95b3e172a3 
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
64ifneq ($(strip $(LOCAL_MODULE_CLASS)),)
65$(error $(LOCAL_PATH): Package modules may not set LOCAL_MODULE_CLASS)
66endif
67LOCAL_MODULE_CLASS := APPS
68
69# Package LOCAL_MODULE_TAGS default to optional
70LOCAL_MODULE_TAGS := $(strip $(LOCAL_MODULE_TAGS))
71ifeq ($(LOCAL_MODULE_TAGS),)
72LOCAL_MODULE_TAGS := optional
73endif
74
75#$(warning $(LOCAL_PATH) $(LOCAL_PACKAGE_NAME) $(sort $(LOCAL_MODULE_TAGS)))
76
77ifeq ($(filter tests, $(LOCAL_MODULE_TAGS)),)
78# Force localization check if it's not tagged as tests.
79LOCAL_AAPT_FLAGS := $(LOCAL_AAPT_FLAGS) -z
80endif
81
82ifeq (,$(LOCAL_ASSET_DIR))
83LOCAL_ASSET_DIR := $(LOCAL_PATH)/assets
84endif
85
86ifeq (,$(LOCAL_RESOURCE_DIR))
87  LOCAL_RESOURCE_DIR := $(LOCAL_PATH)/res
88endif
89LOCAL_RESOURCE_DIR := \
90  $(wildcard $(foreach dir, $(PRODUCT_PACKAGE_OVERLAYS), \
91    $(addprefix $(dir)/, $(LOCAL_RESOURCE_DIR)))) \
92  $(wildcard $(foreach dir, $(DEVICE_PACKAGE_OVERLAYS), \
93    $(addprefix $(dir)/, $(LOCAL_RESOURCE_DIR)))) \
94  $(LOCAL_RESOURCE_DIR)
95
96# this is an app, so add the system libraries to the search path
97LOCAL_AIDL_INCLUDES += $(FRAMEWORKS_BASE_JAVA_SRC_DIRS)
98
99#$(warning Finding assets for $(LOCAL_ASSET_DIR))
100
101all_assets := $(call find-subdir-assets,$(LOCAL_ASSET_DIR))
102all_assets := $(addprefix $(LOCAL_ASSET_DIR)/,$(patsubst assets/%,%,$(all_assets)))
103
104all_resources := $(strip \
105    $(foreach dir, $(LOCAL_RESOURCE_DIR), \
106      $(addprefix $(dir)/, \
107        $(patsubst res/%,%, \
108          $(call find-subdir-assets,$(dir)) \
109         ) \
110       ) \
111     ))
112
113all_res_assets := $(strip $(all_assets) $(all_resources))
114
115package_expected_intermediates_COMMON := $(call local-intermediates-dir,COMMON)
116# If no assets or resources were found, clear the directory variables so
117# we don't try to build them.
118ifeq (,$(all_assets))
119LOCAL_ASSET_DIR:=
120endif
121ifeq (,$(all_resources))
122LOCAL_RESOURCE_DIR:=
123R_file_stamp :=
124else
125# Make sure that R_file_stamp inherits the proper PRIVATE vars.
126# If R.stamp moves, be sure to update the framework makefile,
127# which has intimate knowledge of its location.
128R_file_stamp := $(package_expected_intermediates_COMMON)/src/R.stamp
129LOCAL_INTERMEDIATE_TARGETS += $(R_file_stamp)
130endif
131
132LOCAL_BUILT_MODULE_STEM := package.apk
133
134LOCAL_PROGUARD_ENABLED:=$(strip $(LOCAL_PROGUARD_ENABLED))
135ifndef LOCAL_PROGUARD_ENABLED
136ifneq ($(filter user userdebug, $(TARGET_BUILD_VARIANT)),)
137    # turn on Proguard by default for user & userdebug build
138    LOCAL_PROGUARD_ENABLED :=full
139endif
140endif
141ifeq ($(LOCAL_PROGUARD_ENABLED),disabled)
142    # the package explicitly request to disable proguard.
143    LOCAL_PROGUARD_ENABLED :=
144endif
145proguard_options_file :=
146ifneq ($(LOCAL_PROGUARD_ENABLED),custom)
147ifneq ($(all_resources),)
148    proguard_options_file := $(package_expected_intermediates_COMMON)/proguard_options
149endif # all_resources
150endif # !custom
151LOCAL_PROGUARD_FLAGS := $(addprefix -include ,$(proguard_options_file)) $(LOCAL_PROGUARD_FLAGS)
152
153# The dex files go in the package, so we don't
154# want to install them separately for this module.
155old_DONT_INSTALL_DEX_FILES := $(DONT_INSTALL_DEX_FILES)
156DONT_INSTALL_DEX_FILES := true
157#################################
158include $(BUILD_SYSTEM)/java.mk
159#################################
160DONT_INSTALL_DEX_FILES := $(old_DONT_INSTALL_DEX_FILES)
161old_DONT_INSTALL_DEX_FILES =
162
163full_android_manifest := $(LOCAL_PATH)/AndroidManifest.xml
164$(LOCAL_INTERMEDIATE_TARGETS): \
165	PRIVATE_ANDROID_MANIFEST := $(full_android_manifest)
166
167ifneq ($(all_resources),)
168
169# Since we don't know where the real R.java file is going to end up,
170# we need to use another file to stand in its place.  We'll just
171# copy the generated file to src/R.stamp, which means it will
172# have the same contents and timestamp as the actual file.
173#
174# At the same time, this will copy the R.java file to a central
175# 'R' directory to make it easier to add the files to an IDE.
176#
177#TODO: use PRIVATE_SOURCE_INTERMEDIATES_DIR instead of
178#      $(intermediates.COMMON)/src
179ifneq ($(package_expected_intermediates_COMMON),$(intermediates.COMMON))
180  $(error $(LOCAL_MODULE): internal error: expected intermediates.COMMON "$(package_expected_intermediates_COMMON)" != intermediates.COMMON "$(intermediates.COMMON)")
181endif
182
183$(R_file_stamp): PRIVATE_RESOURCE_PUBLICS_OUTPUT := \
184			$(intermediates.COMMON)/public_resources.xml
185$(R_file_stamp): PRIVATE_PROGUARD_OPTIONS_FILE := $(proguard_options_file)
186$(R_file_stamp): $(all_res_assets) $(full_android_manifest) $(AAPT) | $(ACP)
187	@echo "target R.java/Manifest.java: $(PRIVATE_MODULE) ($@)"
188	@rm -f $@
189	$(create-resource-java-files)
190	$(hide) for GENERATED_MANIFEST_FILE in `find $(PRIVATE_SOURCE_INTERMEDIATES_DIR) \
191					-name Manifest.java 2> /dev/null`; do \
192		dir=`grep package $$GENERATED_MANIFEST_FILE | head -n1 | \
193			awk '{print $$2}' | tr -d ";" | tr . /`; \
194		mkdir -p $(TARGET_COMMON_OUT_ROOT)/R/$$dir; \
195		$(ACP) -fpt $$GENERATED_MANIFEST_FILE $(TARGET_COMMON_OUT_ROOT)/R/$$dir; \
196	done;
197	$(hide) for GENERATED_R_FILE in `find $(PRIVATE_SOURCE_INTERMEDIATES_DIR) \
198					-name R.java 2> /dev/null`; do \
199		dir=`grep package $$GENERATED_R_FILE | head -n1 | \
200			awk '{print $$2}' | tr -d ";" | tr . /`; \
201		mkdir -p $(TARGET_COMMON_OUT_ROOT)/R/$$dir; \
202		$(ACP) -fpt $$GENERATED_R_FILE $(TARGET_COMMON_OUT_ROOT)/R/$$dir \
203			|| exit 31; \
204		$(ACP) -fpt $$GENERATED_R_FILE $@ || exit 32; \
205	done; \
206
207$(proguard_options_file): $(R_file_stamp)
208
209ifdef LOCAL_EXPORT_PACKAGE_RESOURCES
210# Put this module's resources into a PRODUCT-agnositc package that
211# other packages can use to build their own PRODUCT-agnostic R.java (etc.)
212# files.
213resource_export_package := $(intermediates.COMMON)/package-export.apk
214$(R_file_stamp): $(resource_export_package)
215
216# add-assets-to-package looks at PRODUCT_AAPT_CONFIG, but this target
217# can't know anything about PRODUCT.  Clear it out just for this target.
218$(resource_export_package): PRODUCT_AAPT_CONFIG :=
219$(resource_export_package): $(all_res_assets) $(full_android_manifest) $(AAPT)
220	@echo "target Export Resources: $(PRIVATE_MODULE) ($@)"
221	$(create-empty-package)
222	$(add-assets-to-package)
223endif
224
225# Other modules should depend on the BUILT module if
226# they want to use this module's R.java file.
227$(LOCAL_BUILT_MODULE): $(R_file_stamp)
228
229ifneq ($(full_classes_jar),)
230# If full_classes_jar is non-empty, we're building sources.
231# If we're building sources, the initial javac step (which
232# produces full_classes_compiled_jar) needs to ensure the
233# R.java and Manifest.java files have been generated first.
234$(full_classes_compiled_jar): $(R_file_stamp)
235endif
236
237endif	# all_resources
238
239ifeq ($(LOCAL_NO_STANDARD_LIBRARIES),true)
240# We need to explicitly clear this var so that we don't
241# inherit the value from whomever caused us to be built.
242$(LOCAL_INTERMEDIATE_TARGETS): PRIVATE_AAPT_INCLUDES :=
243else
244# Most packages should link against the resources defined by framework-res.
245# Even if they don't have their own resources, they may use framework
246# resources.
247framework_res_package_export := \
248	$(call intermediates-dir-for,APPS,framework-res,,COMMON)/package-export.apk
249$(LOCAL_INTERMEDIATE_TARGETS): \
250	PRIVATE_AAPT_INCLUDES := $(framework_res_package_export)
251# We can't depend directly on the export.apk file; it won't get its
252# PRIVATE_ vars set up correctly if we do.  Instead, depend on the
253# corresponding R.stamp file, which lists the export.apk as a dependency.
254framework_res_package_export_deps := \
255	$(dir $(framework_res_package_export))src/R.stamp
256$(R_file_stamp): $(framework_res_package_export_deps)
257endif
258
259ifneq ($(full_classes_jar),)
260$(LOCAL_BUILT_MODULE): PRIVATE_DEX_FILE := $(built_dex)
261$(LOCAL_BUILT_MODULE): $(built_dex)
262endif # full_classes_jar
263
264
265# Get the list of jni libraries to be included in the apk file.
266
267so_suffix := $($(my_prefix)SHLIB_SUFFIX)
268
269jni_shared_libraries := \
270    $(addprefix $($(my_prefix)OUT_INTERMEDIATE_LIBRARIES)/, \
271      $(addsuffix $(so_suffix), \
272        $(LOCAL_JNI_SHARED_LIBRARIES)))
273
274# Pick a key to sign the package with.  If this package hasn't specified
275# an explicit certificate, use the default.
276# Secure release builds will have their packages signed after the fact,
277# so it's ok for these private keys to be in the clear.
278ifeq ($(LOCAL_CERTIFICATE),)
279    LOCAL_CERTIFICATE := testkey
280endif
281
282ifeq ($(LOCAL_CERTIFICATE),EXTERNAL)
283  # The special value "EXTERNAL" means that we will sign it with the
284  # default testkey, apply predexopt, but then expect the final .apk
285  # (after dexopting) to be signed by an outside tool.
286  LOCAL_CERTIFICATE := testkey
287  PACKAGES.$(LOCAL_PACKAGE_NAME).EXTERNAL_KEY := 1
288endif
289
290# If this is not an absolute certificate, assign it to a generic one.
291ifeq ($(dir $(strip $(LOCAL_CERTIFICATE))),./)
292    LOCAL_CERTIFICATE := $(SRC_TARGET_DIR)/product/security/$(LOCAL_CERTIFICATE)
293endif
294private_key := $(LOCAL_CERTIFICATE).pk8
295certificate := $(LOCAL_CERTIFICATE).x509.pem
296
297$(LOCAL_BUILT_MODULE): $(private_key) $(certificate) $(SIGNAPK_JAR)
298$(LOCAL_BUILT_MODULE): PRIVATE_PRIVATE_KEY := $(private_key)
299$(LOCAL_BUILT_MODULE): PRIVATE_CERTIFICATE := $(certificate)
300
301PACKAGES.$(LOCAL_PACKAGE_NAME).PRIVATE_KEY := $(private_key)
302PACKAGES.$(LOCAL_PACKAGE_NAME).CERTIFICATE := $(certificate)
303
304# Define the rule to build the actual package.
305$(LOCAL_BUILT_MODULE): $(AAPT) | $(ZIPALIGN)
306$(LOCAL_BUILT_MODULE): PRIVATE_JNI_SHARED_LIBRARIES := $(jni_shared_libraries)
307$(LOCAL_BUILT_MODULE): $(all_res_assets) $(jni_shared_libraries) $(full_android_manifest)
308	@echo "target Package: $(PRIVATE_MODULE) ($@)"
309	$(create-empty-package)
310	$(add-assets-to-package)
311ifneq ($(jni_shared_libraries),)
312	$(add-jni-shared-libs-to-package)
313endif
314ifneq ($(full_classes_jar),)
315	$(add-dex-to-package)
316endif
317	$(sign-package)
318	@# Alignment must happen after all other zip operations.
319	$(align-package)
320
321# Save information about this package
322PACKAGES.$(LOCAL_PACKAGE_NAME).OVERRIDES := $(strip $(LOCAL_OVERRIDES_PACKAGES))
323PACKAGES.$(LOCAL_PACKAGE_NAME).RESOURCE_FILES := $(all_resources)
324
325PACKAGES := $(PACKAGES) $(LOCAL_PACKAGE_NAME)
326
327endif # skip_definition
328