blob: 1a7467d95271d95de5925770aaf2f26ae1a7bee1 [file] [log] [blame]
Alan Viverette62105362017-07-13 17:10:15 -04001#
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)
Alan Viverette9c3125e2017-08-17 16:40:07 -040050 # 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)
Alan Viverette62105362017-07-13 17:10:15 -040053 else ifeq ($(LOCAL_SDK_VERSION)$(TARGET_BUILD_APPS),system_current)
Alan Viverette9c3125e2017-08-17 16:40:07 -040054 LOCAL_JAVA_LIBRARIES := android_system_stubs_current $(LOCAL_JAVA_LIBRARIES)
55 $(full_target): PRIVATE_BOOTCLASSPATH := $(call java-lib-files, android_system_stubs_current)
Alan Viverette62105362017-07-13 17:10:15 -040056 else ifeq ($(LOCAL_SDK_VERSION)$(TARGET_BUILD_APPS),test_current)
Alan Viverette9c3125e2017-08-17 16:40:07 -040057 LOCAL_JAVA_LIBRARIES := android_test_stubs_current $(LOCAL_JAVA_LIBRARIES)
58 $(full_target): PRIVATE_BOOTCLASSPATH := $(call java-lib-files, android_test_stubs_current)
Alan Viverette62105362017-07-13 17:10:15 -040059 else
Alan Viverette9c3125e2017-08-17 16:40:07 -040060 LOCAL_JAVA_LIBRARIES := sdk_v$(LOCAL_SDK_VERSION) $(LOCAL_JAVA_LIBRARIES)
61 $(full_target): PRIVATE_BOOTCLASSPATH := $(call java-lib-files, sdk_v$(LOCAL_SDK_VERSION))
Alan Viverette62105362017-07-13 17:10:15 -040062 endif
63else
64 LOCAL_JAVA_LIBRARIES := core-oj core-libart ext framework $(LOCAL_JAVA_LIBRARIES)
65 $(full_target): PRIVATE_BOOTCLASSPATH := $(call java-lib-files, core-oj):$(call java-lib-files, core-libart)
66endif # LOCAL_SDK_VERSION
67LOCAL_JAVA_LIBRARIES := $(sort $(LOCAL_JAVA_LIBRARIES))
68
69full_java_libs := $(call java-lib-files,$(LOCAL_JAVA_LIBRARIES)) $(LOCAL_CLASSPATH)
70full_java_lib_deps := $(call java-lib-deps,$(LOCAL_JAVA_LIBRARIES)) $(LOCAL_CLASSPATH)
71endif # !LOCAL_IS_HOST_MODULE
72
73$(full_target): PRIVATE_CLASSPATH := $(subst $(space),:,$(full_java_libs))
74$(full_target): PRIVATE_DOCLAVA_CLASSPATH := $(HOST_OUT_JAVA_LIBRARIES)/jsilver$(COMMON_JAVA_PACKAGE_SUFFIX):$(HOST_OUT_JAVA_LIBRARIES)/doclava$(COMMON_JAVA_PACKAGE_SUFFIX)
75
76intermediates.COMMON := $(call local-intermediates-dir,COMMON)
77
78$(full_target): PRIVATE_SOURCE_PATH := $(call normalize-path-list,$(LOCAL_DROIDDOC_SOURCE_PATH))
79$(full_target): PRIVATE_JAVA_FILES := $(filter %.java,$(full_src_files))
80$(full_target): PRIVATE_JAVA_FILES += $(addprefix $($(my_prefix)OUT_COMMON_INTERMEDIATES)/, $(filter %.java,$(LOCAL_INTERMEDIATE_SOURCES)))
81$(full_target): PRIVATE_SOURCE_INTERMEDIATES_DIR := $(intermediates.COMMON)/src
82$(full_target): PRIVATE_SRC_LIST_FILE := $(intermediates.COMMON)/droiddoc-src-list
83
84ifneq ($(strip $(LOCAL_ADDITIONAL_JAVA_DIR)),)
85$(full_target): PRIVATE_ADDITIONAL_JAVA_DIR := $(LOCAL_ADDITIONAL_JAVA_DIR)
86endif
87
88# Lists the input files for the doc build into a text file
89# suitable for the @ syntax of javadoc.
90# $(1): the file to create
91# $(2): files to include
92# $(3): list of directories to search for java files in
93define prepare-doc-source-list
94$(hide) mkdir -p $(dir $(1))
95$(call dump-words-to-file, $(2), $(1))
96$(hide) for d in $(3) ; do find $$d -name '*.java' -and -not -name '.*' >> $(1) 2> /dev/null ; done ; true
97endef
98
99##
100##
101## jdiff only
102##
103##
104
105jdiff := \
106 $(HOST_JDK_TOOLS_JAR) \
107 $(HOST_OUT_JAVA_LIBRARIES)/jdiff$(COMMON_JAVA_PACKAGE_SUFFIX)
108
109doclava := \
110 $(HOST_JDK_TOOLS_JAR) \
111 $(HOST_OUT_JAVA_LIBRARIES)/doclava$(COMMON_JAVA_PACKAGE_SUFFIX)
112
113$(full_target): PRIVATE_NEWAPI := $(LOCAL_APIDIFF_NEWAPI)
114$(full_target): PRIVATE_OLDAPI := $(LOCAL_APIDIFF_OLDAPI)
115$(full_target): PRIVATE_OUT_DIR := $(out_dir)
116$(full_target): PRIVATE_OUT_NEWAPI := $(out_dir)/current.xml
117$(full_target): PRIVATE_OUT_OLDAPI := $(out_dir)/$(notdir $(basename $(LOCAL_APIDIFF_OLDAPI))).xml
118$(full_target): PRIVATE_DOCLETPATH := $(HOST_OUT_JAVA_LIBRARIES)/jdiff$(COMMON_JAVA_PACKAGE_SUFFIX)
119$(full_target): \
120 $(full_src_files) \
121 $(full_java_lib_deps) \
122 $(jdiff) \
123 $(doclava) \
124 $(LOCAL_MODULE)-docs \
125 $(LOCAL_ADDITIONAL_DEPENDENCIES)
126 @echo Generating API diff: $(PRIVATE_OUT_DIR)
127 @echo Old API: $(PRIVATE_OLDAPI)
128 @echo New API: $(PRIVATE_NEWAPI)
129 @echo Old XML: $(PRIVATE_OUT_OLDAPI)
130 @echo New XML: $(PRIVATE_OUT_NEWAPI)
131 $(hide) mkdir -p $(dir $@)
132 @echo Converting API files to XML...
133 $(hide) mkdir -p $(PRIVATE_OUT_DIR)
134 $(hide) ( \
135 $(JAVA) \
136 $(addprefix -classpath ,$(PRIVATE_CLASSPATH):$(PRIVATE_DOCLAVA_CLASSPATH):$(PRIVATE_BOOTCLASSPATH):$(HOST_JDK_TOOLS_JAR)) \
137 com.google.doclava.apicheck.ApiCheck \
138 -convert2xml \
139 $(basename $(PRIVATE_NEWAPI)).txt \
140 $(basename $(PRIVATE_OUT_NEWAPI)).xml \
141 ) || (rm -rf $(PRIVATE_OUT_DIR) $(PRIVATE_SRC_LIST_FILE); exit 45)
142 $(hide) ( \
143 $(JAVA) \
144 $(addprefix -classpath ,$(PRIVATE_CLASSPATH):$(PRIVATE_DOCLAVA_CLASSPATH):$(PRIVATE_BOOTCLASSPATH):$(HOST_JDK_TOOLS_JAR)) \
145 com.google.doclava.apicheck.ApiCheck \
146 -convert2xml \
147 $(basename $(PRIVATE_OLDAPI)).txt \
148 $(basename $(PRIVATE_OUT_OLDAPI)).xml \
149 ) || (rm -rf $(PRIVATE_OUT_DIR) $(PRIVATE_SRC_LIST_FILE); exit 45)
150 @echo Running JDiff...
151 $(call prepare-doc-source-list,$(PRIVATE_SRC_LIST_FILE),$(PRIVATE_JAVA_FILES), \
152 $(PRIVATE_SOURCE_INTERMEDIATES_DIR) $(PRIVATE_ADDITIONAL_JAVA_DIR))
153 $(hide) ( \
154 $(JAVADOC) \
155 -encoding UTF-8 \
156 \@$(PRIVATE_SRC_LIST_FILE) \
157 -J-Xmx1600m \
158 -XDignore.symbol.file \
159 -quiet \
160 -doclet jdiff.JDiff \
161 -docletpath $(PRIVATE_DOCLETPATH) \
162 $(addprefix -bootclasspath ,$(PRIVATE_BOOTCLASSPATH)) \
163 $(addprefix -classpath ,$(PRIVATE_CLASSPATH)) \
164 -sourcepath $(PRIVATE_SOURCE_PATH)$(addprefix :,$(PRIVATE_CLASSPATH)) \
165 -d $(PRIVATE_OUT_DIR) \
166 -newapi $(notdir $(basename $(PRIVATE_OUT_NEWAPI))) \
167 -newapidir $(dir $(PRIVATE_OUT_NEWAPI)) \
168 -oldapi $(notdir $(basename $(PRIVATE_OUT_OLDAPI))) \
169 -oldapidir $(dir $(PRIVATE_OUT_OLDAPI)) \
170 -javadocnew ../../../reference/ \
171 && touch -f $@ \
172 ) || (rm -rf $(PRIVATE_OUT_DIR) $(PRIVATE_SRC_LIST_FILE); exit 45)
173
174ALL_DOCS += $(full_target)
175
176.PHONY: $(LOCAL_MODULE)-diff
177$(LOCAL_MODULE)-diff : $(full_target)