Home | History | Annotate | Download | only in core 
      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 $(call record-module-type,DROIDDOC)
     18 ##
     19 ##
     20 ## Common to both droiddoc and javadoc
     21 ##
     22 ##
     23 
     24 LOCAL_IS_HOST_MODULE := $(call true-or-empty,$(LOCAL_IS_HOST_MODULE))
     25 ifeq ($(LOCAL_IS_HOST_MODULE),true)
     26 my_prefix := HOST_
     27 LOCAL_HOST_PREFIX :=
     28 else
     29 my_prefix := TARGET_
     30 endif
     31 
     32 LOCAL_MODULE_CLASS := $(strip $(LOCAL_MODULE_CLASS))
     33 ifndef LOCAL_MODULE_CLASS
     34 $(error $(LOCAL_PATH): LOCAL_MODULE_CLASS not defined)
     35 endif
     36 
     37 full_src_files := $(patsubst %,$(LOCAL_PATH)/%,$(LOCAL_SRC_FILES))
     38 out_dir := $(OUT_DOCS)/$(LOCAL_MODULE)
     39 full_target := $(call doc-timestamp-for,$(LOCAL_MODULE))
     40 
     41 ifeq ($(LOCAL_DROIDDOC_SOURCE_PATH),)
     42 LOCAL_DROIDDOC_SOURCE_PATH := $(LOCAL_PATH)
     43 endif
     44 
     45 ifeq ($(LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR),)
     46 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR := $(SRC_DROIDDOC_DIR)/$(LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR)
     47 endif
     48 
     49 ifeq ($(LOCAL_DROIDDOC_ASSET_DIR),)
     50 LOCAL_DROIDDOC_ASSET_DIR := assets
     51 endif
     52 ifeq ($(LOCAL_DROIDDOC_CUSTOM_ASSET_DIR),)
     53 LOCAL_DROIDDOC_CUSTOM_ASSET_DIR := assets
     54 endif
     55 
     56 ifeq ($(LOCAL_IS_HOST_MODULE),true)
     57 $(full_target): PRIVATE_BOOTCLASSPATH :=
     58 full_java_libs := $(addprefix $(HOST_OUT_JAVA_LIBRARIES)/,\
     59   $(addsuffix $(COMMON_JAVA_PACKAGE_SUFFIX),$(LOCAL_JAVA_LIBRARIES)))
     60 full_java_lib_deps := $(full_java_libs)
     61 
     62 else
     63 
     64 ifneq ($(LOCAL_SDK_VERSION),)
     65   ifeq ($(LOCAL_SDK_VERSION)$(TARGET_BUILD_APPS),current)
     66     # Use android_stubs_current if LOCAL_SDK_VERSION is current and no TARGET_BUILD_APPS.
     67     LOCAL_JAVA_LIBRARIES := android_stubs_current $(LOCAL_JAVA_LIBRARIES)
     68     $(full_target): PRIVATE_BOOTCLASSPATH := $(call java-lib-files, android_stubs_current)
     69   else ifeq ($(LOCAL_SDK_VERSION)$(TARGET_BUILD_APPS),system_current)
     70     LOCAL_JAVA_LIBRARIES := android_system_stubs_current $(LOCAL_JAVA_LIBRARIES)
     71     $(full_target): PRIVATE_BOOTCLASSPATH := $(call java-lib-files, android_system_stubs_current)
     72   else ifeq ($(LOCAL_SDK_VERSION)$(TARGET_BUILD_APPS),test_current)
     73     LOCAL_JAVA_LIBRARIES := android_test_stubs_current $(LOCAL_JAVA_LIBRARIES)
     74     $(full_target): PRIVATE_BOOTCLASSPATH := $(call java-lib-files, android_test_stubs_current)
     75   else
     76     LOCAL_JAVA_LIBRARIES := sdk_v$(LOCAL_SDK_VERSION) $(LOCAL_JAVA_LIBRARIES)
     77     $(full_target): PRIVATE_BOOTCLASSPATH := $(call java-lib-files, sdk_v$(LOCAL_SDK_VERSION))
     78   endif
     79 else
     80   LOCAL_JAVA_LIBRARIES := core-oj core-libart ext framework $(LOCAL_JAVA_LIBRARIES)
     81   $(full_target): PRIVATE_BOOTCLASSPATH := $(call java-lib-files, core-oj):$(call java-lib-files, core-libart)
     82 endif  # LOCAL_SDK_VERSION
     83 LOCAL_JAVA_LIBRARIES := $(sort $(LOCAL_JAVA_LIBRARIES))
     84 
     85 full_java_libs := $(call java-lib-files,$(LOCAL_JAVA_LIBRARIES)) $(LOCAL_CLASSPATH)
     86 full_java_lib_deps := $(call java-lib-deps,$(LOCAL_JAVA_LIBRARIES)) $(LOCAL_CLASSPATH)
     87 endif # !LOCAL_IS_HOST_MODULE
     88 
     89 $(full_target): PRIVATE_CLASSPATH := $(subst $(space),:,$(full_java_libs))
     90 
     91 
     92 intermediates.COMMON := $(call local-intermediates-dir,COMMON)
     93 
     94 $(full_target): PRIVATE_SOURCE_PATH := $(call normalize-path-list,$(LOCAL_DROIDDOC_SOURCE_PATH))
     95 $(full_target): PRIVATE_JAVA_FILES := $(filter %.java,$(full_src_files))
     96 $(full_target): PRIVATE_JAVA_FILES += $(addprefix $($(my_prefix)OUT_COMMON_INTERMEDIATES)/, $(filter %.java,$(LOCAL_INTERMEDIATE_SOURCES)))
     97 $(full_target): PRIVATE_SOURCE_INTERMEDIATES_DIR := $(intermediates.COMMON)/src
     98 $(full_target): PRIVATE_SRC_LIST_FILE := $(intermediates.COMMON)/droiddoc-src-list
     99 
    100 ifneq ($(strip $(LOCAL_ADDITIONAL_JAVA_DIR)),)
    101 $(full_target): PRIVATE_ADDITIONAL_JAVA_DIR := $(LOCAL_ADDITIONAL_JAVA_DIR)
    102 endif
    103 
    104 $(full_target): PRIVATE_OUT_DIR := $(out_dir)
    105 $(full_target): PRIVATE_DROIDDOC_OPTIONS := $(LOCAL_DROIDDOC_OPTIONS)
    106 $(full_target): PRIVATE_STUB_OUT_DIR := $(LOCAL_DROIDDOC_STUB_OUT_DIR)
    107 
    108 # Lists the input files for the doc build into a text file
    109 # suitable for the @ syntax of javadoc.
    110 # $(1): the file to create
    111 # $(2): files to include
    112 # $(3): list of directories to search for java files in
    113 define prepare-doc-source-list
    114 $(hide) mkdir -p $(dir $(1))
    115 $(call dump-words-to-file, $(2), $(1))
    116 $(hide) for d in $(3) ; do find $$d -name '*.java' -and -not -name '.*' >> $(1) 2> /dev/null ; done ; true
    117 endef
    118 
    119 ifeq (a,b)
    120 $(full_target): PRIVATE_PROFILING_OPTIONS := \
    121     -J-agentlib:jprofilerti=port=8849 -J-Xbootclasspath/a:/Applications/jprofiler5/bin/agent.jar
    122 endif
    123 
    124 
    125 ifneq ($(strip $(LOCAL_DROIDDOC_USE_STANDARD_DOCLET)),true)
    126 ##
    127 ##
    128 ## droiddoc only
    129 ##
    130 ##
    131 
    132 droiddoc_templates := \
    133     $(sort $(shell find $(LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR) -type f))
    134 
    135 droiddoc := \
    136 	$(HOST_JDK_TOOLS_JAR) \
    137 	$(HOST_OUT_JAVA_LIBRARIES)/doclava$(COMMON_JAVA_PACKAGE_SUFFIX)
    138 
    139 $(full_target): PRIVATE_DOCLETPATH := $(HOST_OUT_JAVA_LIBRARIES)/jsilver$(COMMON_JAVA_PACKAGE_SUFFIX):$(HOST_OUT_JAVA_LIBRARIES)/doclava$(COMMON_JAVA_PACKAGE_SUFFIX)
    140 $(full_target): PRIVATE_CURRENT_BUILD := -hdf page.build $(BUILD_ID)-$(BUILD_NUMBER_FROM_FILE)
    141 $(full_target): PRIVATE_CURRENT_TIME :=  -hdf page.now "$$($(DATE_FROM_FILE) "+%d %b %Y %k:%M")"
    142 $(full_target): PRIVATE_CUSTOM_TEMPLATE_DIR := $(LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR)
    143 $(full_target): PRIVATE_IN_CUSTOM_ASSET_DIR := $(LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR)/$(LOCAL_DROIDDOC_CUSTOM_ASSET_DIR)
    144 $(full_target): PRIVATE_OUT_ASSET_DIR := $(out_dir)/$(LOCAL_DROIDDOC_ASSET_DIR)
    145 $(full_target): PRIVATE_OUT_CUSTOM_ASSET_DIR := $(out_dir)/$(LOCAL_DROIDDOC_CUSTOM_ASSET_DIR)
    146 
    147 html_dir_files :=
    148 ifneq ($(strip $(LOCAL_DROIDDOC_HTML_DIR)),)
    149 $(full_target): PRIVATE_DROIDDOC_HTML_DIR := -htmldir $(LOCAL_PATH)/$(LOCAL_DROIDDOC_HTML_DIR)
    150 html_dir_files := $(sort $(shell find $(LOCAL_PATH)/$(LOCAL_DROIDDOC_HTML_DIR) -type f))
    151 else
    152 $(full_target): PRIVATE_DROIDDOC_HTML_DIR :=
    153 endif
    154 ifneq ($(strip $(LOCAL_ADDITIONAL_HTML_DIR)),)
    155 $(full_target): PRIVATE_ADDITIONAL_HTML_DIR := -htmldir2 $(LOCAL_PATH)/$(LOCAL_ADDITIONAL_HTML_DIR)
    156 else
    157 $(full_target): PRIVATE_ADDITIONAL_HTML_DIR :=
    158 endif
    159 
    160 # TODO: not clear if this is used any more
    161 $(full_target): PRIVATE_LOCAL_PATH := $(LOCAL_PATH)
    162 
    163 $(full_target): \
    164         $(full_src_files) \
    165         $(droiddoc_templates) \
    166         $(droiddoc) \
    167         $(html_dir_files) \
    168         $(full_java_lib_deps) \
    169         $(LOCAL_ADDITIONAL_DEPENDENCIES)
    170 	@echo Docs droiddoc: $(PRIVATE_OUT_DIR)
    171 	$(hide) mkdir -p $(dir $@)
    172 	$(addprefix $(hide) rm -rf ,$(PRIVATE_STUB_OUT_DIR))
    173 	$(call prepare-doc-source-list,$(PRIVATE_SRC_LIST_FILE),$(PRIVATE_JAVA_FILES), \
    174 			$(PRIVATE_SOURCE_INTERMEDIATES_DIR) $(PRIVATE_ADDITIONAL_JAVA_DIR))
    175 	$(hide) ( \
    176 		javadoc \
    177                 -encoding UTF-8 \
    178                 \@$(PRIVATE_SRC_LIST_FILE) \
    179                 -J-Xmx1600m \
    180                 -J-XX:-OmitStackTraceInFastThrow \
    181                 -XDignore.symbol.file \
    182                 $(PRIVATE_PROFILING_OPTIONS) \
    183                 -quiet \
    184                 -doclet com.google.doclava.Doclava \
    185                 -docletpath $(PRIVATE_DOCLETPATH) \
    186                 -templatedir $(PRIVATE_CUSTOM_TEMPLATE_DIR) \
    187                 $(PRIVATE_DROIDDOC_HTML_DIR) \
    188                 $(PRIVATE_ADDITIONAL_HTML_DIR) \
    189                 $(addprefix -bootclasspath ,$(PRIVATE_BOOTCLASSPATH)) \
    190                 $(addprefix -classpath ,$(PRIVATE_CLASSPATH)) \
    191                 -sourcepath $(PRIVATE_SOURCE_PATH)$(addprefix :,$(PRIVATE_CLASSPATH)) \
    192                 -d $(PRIVATE_OUT_DIR) \
    193                 $(PRIVATE_CURRENT_BUILD) $(PRIVATE_CURRENT_TIME) \
    194                 $(PRIVATE_DROIDDOC_OPTIONS) \
    195                 $(addprefix -stubs ,$(PRIVATE_STUB_OUT_DIR)) \
    196         && touch -f $@ \
    197     ) || (rm -rf $(PRIVATE_OUT_DIR) $(PRIVATE_SRC_LIST_FILE); exit 45)
    198 
    199 
    200 
    201 else
    202 ##
    203 ##
    204 ## standard doclet only
    205 ##
    206 ##
    207 $(full_target): $(full_src_files) $(full_java_lib_deps)
    208 	@echo Docs javadoc: $(PRIVATE_OUT_DIR)
    209 	@mkdir -p $(dir $@)
    210 	$(call prepare-doc-source-list,$(PRIVATE_SRC_LIST_FILE),$(PRIVATE_JAVA_FILES), \
    211 			$(PRIVATE_SOURCE_INTERMEDIATES_DIR) $(PRIVATE_ADDITIONAL_JAVA_DIR))
    212 	$(hide) ( \
    213 		javadoc \
    214                 -encoding UTF-8 \
    215                 $(PRIVATE_DROIDDOC_OPTIONS) \
    216                 \@$(PRIVATE_SRC_LIST_FILE) \
    217                 -J-Xmx1024m \
    218                 -XDignore.symbol.file \
    219                 $(if $(LEGACY_USE_JAVA7),,-Xdoclint:none) \
    220                 $(PRIVATE_PROFILING_OPTIONS) \
    221                 $(addprefix -classpath ,$(PRIVATE_CLASSPATH)) \
    222                 $(addprefix -bootclasspath ,$(PRIVATE_BOOTCLASSPATH)) \
    223                 -sourcepath $(PRIVATE_SOURCE_PATH)$(addprefix :,$(PRIVATE_CLASSPATH)) \
    224                 -d $(PRIVATE_OUT_DIR) \
    225                 -quiet \
    226         && touch -f $@ \
    227     ) || (rm -rf $(PRIVATE_OUT_DIR) $(PRIVATE_SRC_LIST_FILE); exit 45)
    228 
    229 
    230 endif
    231 ##
    232 ##
    233 ## Common to both droiddoc and javadoc
    234 ##
    235 ##
    236 
    237 
    238 ALL_DOCS += $(full_target)
    239 
    240 .PHONY: $(LOCAL_MODULE)-docs
    241 $(LOCAL_MODULE)-docs : $(full_target)
    242 
    243 ifeq ($(strip $(LOCAL_UNINSTALLABLE_MODULE)),)
    244 
    245 # Define a rule to create a zip of these docs.
    246 out_zip := $(OUT_DOCS)/$(LOCAL_MODULE)-docs.zip
    247 $(out_zip): PRIVATE_DOCS_DIR := $(out_dir)
    248 $(out_zip): $(full_target)
    249 	@echo Package docs: $@
    250 	@rm -f $@
    251 	@mkdir -p $(dir $@)
    252 	$(hide) ( F=$$(pwd)/$@ ; cd $(PRIVATE_DOCS_DIR) && zip -rqX $$F * )
    253 
    254 $(LOCAL_MODULE)-docs.zip : $(out_zip)
    255 
    256 $(call dist-for-goals,docs,$(out_zip))
    257 
    258 endif
    259