apicheck.mk revision 70748bb17f750a526277486acc4bcfb67589d82e 
1# Copyright (C) 2008 The Android Open Source Project
2#
3# Licensed under the Apache License, Version 2.0 (the "License");
4# you may not use this file except in compliance with the License.
5# You may obtain a copy of the License at
6#
7#      http://www.apache.org/licenses/LICENSE-2.0
8#
9# Unless required by applicable law or agreed to in writing, software
10# distributed under the License is distributed on an "AS IS" BASIS,
11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12# See the License for the specific language governing permissions and
13# limitations under the License.
14
15#
16# Rules for running apicheck to confirm that you haven't broken
17# api compatibility or added apis illegally.
18#
19
20ifneq ($(BUILD_TINY_ANDROID), true)
21
22APICHECK_CLASSPATH := $(HOST_JDK_TOOLS_JAR)
23APICHECK_CLASSPATH := $(APICHECK_CLASSPATH):$(HOST_OUT_JAVA_LIBRARIES)/doclava$(COMMON_JAVA_PACKAGE_SUFFIX)
24APICHECK_CLASSPATH := $(APICHECK_CLASSPATH):$(HOST_OUT_JAVA_LIBRARIES)/jsilver$(COMMON_JAVA_PACKAGE_SUFFIX)
25
26.PHONY: checkapi
27
28# eval this to define a rule that runs apicheck.
29#
30# Args:
31#    $(1)  target
32#    $(2)  stable api xml file
33#    $(3)  api xml file to be tested
34#    $(4)  arguments for apicheck
35#    $(5)  command to run if apicheck failed
36define check-api
37$(TARGET_OUT_COMMON_INTERMEDIATES)/PACKAGING/$(strip $(1))-timestamp: $(2) $(3) $(APICHECK)
38	@echo "Checking API:" $(1)
39	$(hide) ( $(APICHECK) -JXmx1024m -J"classpath $(APICHECK_CLASSPATH)" $(4) $(2) $(3) || ( $(5) ; exit 38 ) )
40	$(hide) mkdir -p $$(dir $$@)
41	$(hide) touch $$@
42checkapi: $(TARGET_OUT_COMMON_INTERMEDIATES)/PACKAGING/$(strip $(1))-timestamp
43endef
44
45# Run the checkapi rules by default.
46droidcore: checkapi
47
48last_released_sdk_version := $(lastword $(call numerically_sort,\
49    $(patsubst $(SRC_API_DIR)/%.xml,%, \
50    $(filter-out $(SRC_API_DIR)/current.xml, \
51    $(wildcard $(SRC_API_DIR)/*.xml)))))
52
53# INTERNAL_PLATFORM_API_FILE is the one build by droiddoc.
54
55# Check that the API we're building hasn't broken the last-released
56# SDK version.
57$(eval $(call check-api, \
58	checkapi-last, \
59	$(SRC_API_DIR)/$(last_released_sdk_version).xml, \
60	$(INTERNAL_PLATFORM_API_FILE), \
61	-hide 2 -hide 3 -hide 4 -hide 5 -hide 6 -hide 24 -hide 25 \
62	-error 7 -error 8 -error 9 -error 10 -error 11 -error 12 -error 13 -error 14 -error 15 \
63	-error 16 -error 17 -error 18 , \
64	cat $(BUILD_SYSTEM)/apicheck_msg_last.txt \
65	))
66
67# Check that the API we're building hasn't changed from the not-yet-released
68# SDK version.
69$(eval $(call check-api, \
70	checkapi-current, \
71	$(SRC_API_DIR)/current.xml, \
72	$(INTERNAL_PLATFORM_API_FILE), \
73	-error 2 -error 3 -error 4 -error 5 -error 6 \
74	-error 7 -error 8 -error 9 -error 10 -error 11 -error 12 -error 13 -error 14 -error 15 \
75	-error 16 -error 17 -error 18 -error 19 -error 20 -error 21 -error 23 -error 24 \
76	-error 25 , \
77	cat $(BUILD_SYSTEM)/apicheck_msg_current.txt \
78	))
79
80.PHONY: update-api
81update-api: $(INTERNAL_PLATFORM_API_FILE) | $(ACP)
82	@echo Copying current.xml
83	$(hide) $(ACP) $(INTERNAL_PLATFORM_API_FILE) $(SRC_API_DIR)/current.xml
84
85endif
86