apidiff.mk revision ef212cbe8d6e628bfc40e2db75522b4f1d794766 
1#
2# Copyright (C) 2017 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##
19## Common to both jdiff and javadoc
20##
21##
22
23LOCAL_IS_HOST_MODULE := $(call true-or-empty,$(LOCAL_IS_HOST_MODULE))
24ifeq ($(LOCAL_IS_HOST_MODULE),true)
25my_prefix := HOST_
26LOCAL_HOST_PREFIX :=
27else
28my_prefix := TARGET_
29endif
30
31LOCAL_MODULE_CLASS := $(strip $(LOCAL_MODULE_CLASS))
32ifndef LOCAL_MODULE_CLASS
33$(error $(LOCAL_PATH): LOCAL_MODULE_CLASS not defined)
34endif
35
36full_src_files := $(patsubst %,$(LOCAL_PATH)/%,$(LOCAL_SRC_FILES))
37out_dir := $(OUT_DOCS)/$(LOCAL_MODULE)/api_diff/current
38full_target := $(call doc-timestamp-for,$(LOCAL_MODULE)-diff)
39
40ifeq ($(LOCAL_IS_HOST_MODULE),true)
41$(full_target): PRIVATE_BOOTCLASSPATH :=
42full_java_libs := $(addprefix $(HOST_OUT_JAVA_LIBRARIES)/,\
43  $(addsuffix $(COMMON_JAVA_PACKAGE_SUFFIX),$(LOCAL_JAVA_LIBRARIES)))
44full_java_lib_deps := $(full_java_libs)
45
46else
47
48ifneq ($(LOCAL_SDK_VERSION),)
49  ifeq ($(LOCAL_SDK_VERSION)$(TARGET_BUILD_APPS),current)
50    # Use android_stubs_current if LOCAL_SDK_VERSION is current and no TARGET_BUILD_APPS.
51    LOCAL_JAVA_LIBRARIES := android_stubs_current $(LOCAL_JAVA_LIBRARIES)
52    $(full_target): PRIVATE_BOOTCLASSPATH := $(call java-lib-files, android_stubs_current)
53  else ifeq ($(LOCAL_SDK_VERSION)$(TARGET_BUILD_APPS),system_current)
54    LOCAL_JAVA_LIBRARIES := android_system_stubs_current $(LOCAL_JAVA_LIBRARIES)
55    $(full_target): PRIVATE_BOOTCLASSPATH := $(call java-lib-files, android_system_stubs_current)
56  else ifeq ($(LOCAL_SDK_VERSION)$(TARGET_BUILD_APPS),test_current)
57    LOCAL_JAVA_LIBRARIES := android_test_stubs_current $(LOCAL_JAVA_LIBRARIES)
58    $(full_target): PRIVATE_BOOTCLASSPATH := $(call java-lib-files, android_test_stubs_current)
59  else
60    ifneq (,$(call has-system-sdk-version,$(LOCAL_SDK_VERSION)))
61      LOCAL_JAVA_LIBRARIES := system_sdk_v$(call get-numeric-sdk-version,$(LOCAL_SDK_VERSION)) $(LOCAL_JAVA_LIBRARIES)
62      $(full_target): PRIVATE_BOOTCLASSPATH := $(call java-lib-files, system_sdk_v$(call get-numeric-sdk-version,$(LOCAL_SDK_VERSION)))
63    else
64      LOCAL_JAVA_LIBRARIES := sdk_v$(LOCAL_SDK_VERSION) $(LOCAL_JAVA_LIBRARIES)
65      $(full_target): PRIVATE_BOOTCLASSPATH := $(call java-lib-files, sdk_v$(LOCAL_SDK_VERSION))
66    endif
67  endif
68else
69  LOCAL_JAVA_LIBRARIES := core-oj core-libart ext framework $(LOCAL_JAVA_LIBRARIES)
70  $(full_target): PRIVATE_BOOTCLASSPATH := $(call java-lib-files, core-oj):$(call java-lib-files, core-libart)
71endif  # LOCAL_SDK_VERSION
72LOCAL_JAVA_LIBRARIES := $(sort $(LOCAL_JAVA_LIBRARIES))
73
74full_java_libs := $(call java-lib-files,$(LOCAL_JAVA_LIBRARIES)) $(LOCAL_CLASSPATH)
75full_java_lib_deps := $(call java-lib-deps,$(LOCAL_JAVA_LIBRARIES)) $(LOCAL_CLASSPATH)
76endif # !LOCAL_IS_HOST_MODULE
77
78$(full_target): PRIVATE_CLASSPATH := $(subst $(space),:,$(full_java_libs))
79$(full_target): PRIVATE_DOCLAVA_CLASSPATH := $(HOST_OUT_JAVA_LIBRARIES)/jsilver$(COMMON_JAVA_PACKAGE_SUFFIX):$(HOST_OUT_JAVA_LIBRARIES)/doclava$(COMMON_JAVA_PACKAGE_SUFFIX)
80
81intermediates.COMMON := $(call local-intermediates-dir,COMMON)
82
83$(full_target): PRIVATE_SOURCE_PATH := $(call normalize-path-list,$(LOCAL_DROIDDOC_SOURCE_PATH))
84$(full_target): PRIVATE_JAVA_FILES := $(filter %.java,$(full_src_files))
85$(full_target): PRIVATE_JAVA_FILES += $(addprefix $($(my_prefix)OUT_COMMON_INTERMEDIATES)/, $(filter %.java,$(LOCAL_INTERMEDIATE_SOURCES)))
86$(full_target): PRIVATE_SOURCE_INTERMEDIATES_DIR := $(intermediates.COMMON)/src
87$(full_target): PRIVATE_SRC_LIST_FILE := $(intermediates.COMMON)/droiddoc-src-list
88
89ifneq ($(strip $(LOCAL_ADDITIONAL_JAVA_DIR)),)
90$(full_target): PRIVATE_ADDITIONAL_JAVA_DIR := $(LOCAL_ADDITIONAL_JAVA_DIR)
91endif
92
93# Lists the input files for the doc build into a text file
94# suitable for the @ syntax of javadoc.
95# $(1): the file to create
96# $(2): files to include
97# $(3): list of directories to search for java files in
98define prepare-doc-source-list
99$(hide) mkdir -p $(dir $(1))
100$(call dump-words-to-file, $(2), $(1))
101$(hide) for d in $(3) ; do find $$d -name '*.java' -and -not -name '.*' >> $(1) 2> /dev/null ; done ; true
102endef
103
104##
105##
106## jdiff only
107##
108##
109
110jdiff := \
111	$(HOST_JDK_TOOLS_JAR) \
112	$(HOST_OUT_JAVA_LIBRARIES)/jdiff$(COMMON_JAVA_PACKAGE_SUFFIX)
113
114doclava := \
115	$(HOST_JDK_TOOLS_JAR) \
116	$(HOST_OUT_JAVA_LIBRARIES)/doclava$(COMMON_JAVA_PACKAGE_SUFFIX)
117
118$(full_target): PRIVATE_NEWAPI := $(LOCAL_APIDIFF_NEWAPI)
119$(full_target): PRIVATE_OLDAPI := $(LOCAL_APIDIFF_OLDAPI)
120$(full_target): PRIVATE_OUT_DIR := $(out_dir)
121$(full_target): PRIVATE_OUT_NEWAPI := $(out_dir)/current.xml
122$(full_target): PRIVATE_OUT_OLDAPI := $(out_dir)/$(notdir $(basename $(LOCAL_APIDIFF_OLDAPI))).xml
123$(full_target): PRIVATE_DOCLETPATH := $(HOST_OUT_JAVA_LIBRARIES)/jdiff$(COMMON_JAVA_PACKAGE_SUFFIX)
124$(full_target): \
125		$(full_src_files) \
126		$(full_java_lib_deps) \
127		$(jdiff) \
128		$(doclava) \
129		$(LOCAL_MODULE)-docs \
130		$(LOCAL_ADDITIONAL_DEPENDENCIES)
131	@echo Generating API diff: $(PRIVATE_OUT_DIR)
132	@echo   Old API: $(PRIVATE_OLDAPI)
133	@echo   New API: $(PRIVATE_NEWAPI)
134	@echo   Old XML: $(PRIVATE_OUT_OLDAPI)
135	@echo   New XML: $(PRIVATE_OUT_NEWAPI)
136	$(hide) mkdir -p $(dir $@)
137	@echo Converting API files to XML...
138	$(hide) mkdir -p $(PRIVATE_OUT_DIR)
139	$(hide) ( \
140		$(JAVA) \
141				$(addprefix -classpath ,$(PRIVATE_CLASSPATH):$(PRIVATE_DOCLAVA_CLASSPATH):$(PRIVATE_BOOTCLASSPATH):$(HOST_JDK_TOOLS_JAR)) \
142				com.google.doclava.apicheck.ApiCheck \
143				-convert2xml \
144					$(basename $(PRIVATE_NEWAPI)).txt \
145					$(basename $(PRIVATE_OUT_NEWAPI)).xml \
146	) || (rm -rf $(PRIVATE_OUT_DIR) $(PRIVATE_SRC_LIST_FILE); exit 45)
147	$(hide) ( \
148		$(JAVA) \
149				$(addprefix -classpath ,$(PRIVATE_CLASSPATH):$(PRIVATE_DOCLAVA_CLASSPATH):$(PRIVATE_BOOTCLASSPATH):$(HOST_JDK_TOOLS_JAR)) \
150				com.google.doclava.apicheck.ApiCheck \
151				-convert2xml \
152					$(basename $(PRIVATE_OLDAPI)).txt \
153					$(basename $(PRIVATE_OUT_OLDAPI)).xml \
154	) || (rm -rf $(PRIVATE_OUT_DIR) $(PRIVATE_SRC_LIST_FILE); exit 45)
155	@echo Running JDiff...
156	$(call prepare-doc-source-list,$(PRIVATE_SRC_LIST_FILE),$(PRIVATE_JAVA_FILES), \
157			$(PRIVATE_SOURCE_INTERMEDIATES_DIR) $(PRIVATE_ADDITIONAL_JAVA_DIR))
158	$(hide) ( \
159		$(JAVADOC) \
160				-encoding UTF-8 \
161				\@$(PRIVATE_SRC_LIST_FILE) \
162				-J-Xmx1600m \
163				-XDignore.symbol.file \
164				-quiet \
165				-doclet jdiff.JDiff \
166				-docletpath $(PRIVATE_DOCLETPATH) \
167				$(addprefix -bootclasspath ,$(PRIVATE_BOOTCLASSPATH)) \
168				$(addprefix -classpath ,$(PRIVATE_CLASSPATH)) \
169				-sourcepath $(PRIVATE_SOURCE_PATH)$(addprefix :,$(PRIVATE_CLASSPATH)) \
170				-d $(PRIVATE_OUT_DIR) \
171				-newapi $(notdir $(basename $(PRIVATE_OUT_NEWAPI))) \
172				-newapidir $(dir $(PRIVATE_OUT_NEWAPI)) \
173				-oldapi $(notdir $(basename $(PRIVATE_OUT_OLDAPI))) \
174				-oldapidir $(dir $(PRIVATE_OUT_OLDAPI)) \
175				-javadocnew ../../../reference/ \
176		&& touch -f $@ \
177	) || (rm -rf $(PRIVATE_OUT_DIR) $(PRIVATE_SRC_LIST_FILE); exit 45)
178
179ALL_DOCS += $(full_target)
180
181.PHONY: $(LOCAL_MODULE)-diff
182$(LOCAL_MODULE)-diff : $(full_target)
183