Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 64d85d0d authored by Joe Onorato's avatar Joe Onorato Committed by The Android Open Source Project
Browse files

AI 145618: am: CL 145333 Cloned from CL 144759 by 'g4 patch'. 

  Original change by joeo@abreu on 2009/04/06 19:54:13.
  Implement SDK add-ons in the build system.
  - Add an option to use the standard javadoc doclet instead
  of droiddoc, since droiddocs non-sdk templates aren't
  ready for prime time.
  - Add the notion of a stubs for a library.  It's only
  implemented for java libraries, but when we do native
  libraries in the NDK or sdk-addons, it will work there too.
  Original author: joeo
  Merged from: //branches/cupcake/...

Automated import of CL 145618
parent 3b06a03e

core/Makefile

+11 −5
Original line number Diff line number Diff line
@@ -15,9 +15,9 @@ endif 
# <dest file> is relative to $(PRODUCT_OUT), so it should look like,

# e.g., "system/etc/file.xml".

$(foreach cf,$(PRODUCT_COPY_FILES), \

  $(eval _w := $(subst :,$(space),$(cf))) \

  $(eval _src := $(word 1,$(_w))) \

  $(eval _dest := $(subst //,/,$(PRODUCT_OUT)/$(word 2,$(_w)))) \

  $(eval _src := $(call word-colon,1,$(cf))) \

  $(eval _dest := $(call \

          append-path,$(PRODUCT_OUT),$(call word-colon,2,$(cf)))) \

  $(eval $(call copy-one-file,$(_src),$(_dest))) \

  $(eval ALL_DEFAULT_INSTALLED_MODULES += $(_dest)) \

 )
@@ -243,7 +243,10 @@ INTERNAL_RAMDISK_FILES := $(filter $(TARGET_ROOT_OUT)/%, \ 
	$(ALL_GENERATED_SOURCES) \

	$(ALL_DEFAULT_INSTALLED_MODULES))



INSTALLED_RAMDISK_TARGET := $(PRODUCT_OUT)/ramdisk.img

BUILT_RAMDISK_TARGET := $(PRODUCT_OUT)/ramdisk.img



# We just build this directly to the install location.

INSTALLED_RAMDISK_TARGET := $(BUILT_RAMDISK_TARGET)

$(INSTALLED_RAMDISK_TARGET): $(MKBOOTFS) $(INTERNAL_RAMDISK_FILES)

	$(call pretty,"Target ram disk: $@")

	$(hide) $(MKBOOTFS) $(TARGET_ROOT_OUT) | gzip > $@
@@ -575,7 +578,10 @@ define build-userdataimage-target 
endef

endif # TARGET_USERIMAGES_USE_EXT2



INSTALLED_USERDATAIMAGE_TARGET := $(PRODUCT_OUT)/userdata.img

BUILT_USERDATAIMAGE_TARGET := $(PRODUCT_OUT)/userdata.img



# We just build this directly to the install location.

INSTALLED_USERDATAIMAGE_TARGET := $(BUILT_USERDATAIMAGE_TARGET)

$(INSTALLED_USERDATAIMAGE_TARGET): $(INTERNAL_MKUSERFS) \

                                   $(INTERNAL_USERDATAIMAGE_FILES)

	$(build-userdataimage-target)

core/clear_vars.mk

+1 −0
Original line number Diff line number Diff line
@@ -49,6 +49,7 @@ LOCAL_INTERMEDIATE_SOURCES:= 
LOCAL_JAVA_LIBRARIES:=

LOCAL_NO_STANDARD_LIBRARIES:=

LOCAL_CLASSPATH:=

LOCAL_DROIDDOC_USE_STANDARD_DOCLET:=

LOCAL_DROIDDOC_SOURCE_PATH:=

LOCAL_DROIDDOC_TEMPLATE_DIR:=

LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=

core/definitions.mk

+74 −11
Original line number Diff line number Diff line
@@ -95,6 +95,17 @@ $(foreach var,$(1), \ 
 )

endef



###########################################################

## Evaluates to true if the string contains the word true,

## and empty otherwise

## $(1): a var to test

###########################################################



define true-or-empty

$(filter true, $(1))

endef





###########################################################

## Retrieve the directory of the current makefile

###########################################################
@@ -405,6 +416,31 @@ define module-installed-files 
$(foreach module,$(1),$(ALL_MODULES.$(module).INSTALLED))

endef



###########################################################

## Convert a list of short modules names (e.g., "framework", "Browser")

## into the list of files that should be used when linking

## against that module as a public API.

## TODO: Allow this for more than JAVA_LIBRARIES modules

## NOTE: this won't return reliable results until after all

## sub-makefiles have been included.

## $(1): target list

###########################################################



define module-stubs-files

$(foreach module,$(1),$(ALL_MODULES.$(module).STUBS))

endef



###########################################################

## Evaluates to the timestamp file for a doc module, which

## is the dependency that should be used.

## $(1): doc module

###########################################################



define doc-timestamp-for

$(OUT_DOCS)/$(strip $(1))-timestamp

endef





###########################################################

## Convert "framework framework-res ext" to "out/.../javalib.jar ..."

## This lets us treat framework-res as a normal library.
@@ -464,6 +500,21 @@ define normalize-path-list 
$(subst $(space),:,$(strip $(1)))

endef



###########################################################

## Read the word out of a colon-separated list of words.

## This has the same behavior as the built-in function

## $(word n,str).

##

## The individual words may not contain spaces.

##

## $(1): 1 based index

## $(2): value of the form a:b:c...

###########################################################



define word-colon

$(word $(1),$(subst :,$(space),$(2)))

endef



###########################################################

## Convert "a=b c= d e = f" into "a=b c=d e=f"

##
@@ -478,7 +529,6 @@ $(subst $(space)$(_cpSEP)$(space),$(_cpSEP),$(strip \ 
    $(subst $(_cpSEP), $(_cpSEP) ,$(1))))

endef





###########################################################

## MODULE_TAG set operations

###########################################################
@@ -510,6 +560,18 @@ $(filter-out \ 
	    $(call modules-for-tag-list,$(1)))

endef



###########################################################

## Append a leaf to a base path.  Properly deals with

## base paths ending in /.

##

## $(1): base path

## $(2): leaf path

###########################################################



define append-path

$(subst //,/,$(1)/$(2))

endef





###########################################################

## Package filtering
@@ -1117,17 +1179,18 @@ define unzip-jar-files 
  done

endef



# below we write the list of java files to java-source-list to avoid argument list length problems with Cygwin

# we filter out duplicate java file names because eclipse's compiler doesn't like them.

# below we write the list of java files to java-source-list to avoid argument

# list length problems with Cygwin we filter out duplicate java file names

# because eclipse's compiler doesn't like them.

define transform-java-to-classes.jar

@echo "target Java: $(PRIVATE_MODULE) ($(PRIVATE_CLASS_INTERMEDIATES_DIR))"

@rm -f $@

@rm -rf $(PRIVATE_CLASS_INTERMEDIATES_DIR)

@mkdir -p $(PRIVATE_CLASS_INTERMEDIATES_DIR)

$(hide) rm -f $@

$(hide) rm -rf $(PRIVATE_CLASS_INTERMEDIATES_DIR)

$(hide) mkdir -p $(PRIVATE_CLASS_INTERMEDIATES_DIR)

$(call unzip-jar-files,$(PRIVATE_STATIC_JAVA_LIBRARIES), \

    $(PRIVATE_CLASS_INTERMEDIATES_DIR))

$(call dump-words-to-file,$(PRIVATE_JAVA_SOURCES),$(PRIVATE_CLASS_INTERMEDIATES_DIR)/java-source-list)

@if [ -d "$(PRIVATE_SOURCE_INTERMEDIATES_DIR)" ]; then \

$(hide) if [ -d "$(PRIVATE_SOURCE_INTERMEDIATES_DIR)" ]; then \

	    find $(PRIVATE_SOURCE_INTERMEDIATES_DIR) -name '*.java' >> $(PRIVATE_CLASS_INTERMEDIATES_DIR)/java-source-list; \

fi

$(hide) tr ' ' '\n' < $(PRIVATE_CLASS_INTERMEDIATES_DIR)/java-source-list \
@@ -1139,12 +1202,12 @@ $(hide) $(TARGET_JAVAC) -encoding ascii $(PRIVATE_BOOTCLASSPATH) \ 
    -extdirs "" -d $(PRIVATE_CLASS_INTERMEDIATES_DIR) \

    \@$(PRIVATE_CLASS_INTERMEDIATES_DIR)/java-source-list-uniq \

    || ( rm -rf $(PRIVATE_CLASS_INTERMEDIATES_DIR) ; exit 41 )

@ rm -f $(PRIVATE_CLASS_INTERMEDIATES_DIR)/java-source-list

@ rm -f $(PRIVATE_CLASS_INTERMEDIATES_DIR)/java-source-list-uniq

@mkdir -p $(dir $@)

$(hide) rm -f $(PRIVATE_CLASS_INTERMEDIATES_DIR)/java-source-list

$(hide) rm -f $(PRIVATE_CLASS_INTERMEDIATES_DIR)/java-source-list-uniq

$(hide) mkdir -p $(dir $@)

$(hide) jar $(if $(strip $(PRIVATE_JAR_MANIFEST)),-cfm,-cf) \

    $@ $(PRIVATE_JAR_MANIFEST) -C $(PRIVATE_CLASS_INTERMEDIATES_DIR) .

@rm -rf $(PRIVATE_CLASS_INTERMEDIATES_DIR)

$(hide) rm -rf $(PRIVATE_CLASS_INTERMEDIATES_DIR)

endef



define transform-classes.jar-to-emma

core/droiddoc.mk

+117 −43
Original line number Diff line number Diff line 
###########################################################

## Standard rules for building documentation

###########################################################



LOCAL_IS_HOST_MODULE := $(strip $(LOCAL_IS_HOST_MODULE))

ifdef LOCAL_IS_HOST_MODULE

#

# Copyright (C) 2008 The Android Open Source Project

#

# Licensed under the Apache License, Version 2.0 (the "License");

# you may not use this file except in compliance with the License.

# You may obtain a copy of the License at

#

#      http://www.apache.org/licenses/LICENSE-2.0

#

# Unless required by applicable law or agreed to in writing, software

# distributed under the License is distributed on an "AS IS" BASIS,

# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

# See the License for the specific language governing permissions and

# limitations under the License.

#



##

##

## Common to both droiddoc and javadoc

##

##



LOCAL_IS_HOST_MODULE := $(call true-or-empty,$(LOCAL_IS_HOST_MODULE))

ifeq ($(LOCAL_IS_HOST_MODULE),true)

my_prefix:=HOST_

else

my_prefix:=TARGET_
@@ -16,7 +34,7 @@ endif 


full_src_files := $(patsubst %,$(LOCAL_PATH)/%,$(LOCAL_SRC_FILES))

out_dir := $(OUT_DOCS)/$(LOCAL_MODULE)

full_target := $(OUT_DOCS)/$(LOCAL_MODULE)-timestamp

full_target := $(call doc-timestamp-for,$(LOCAL_MODULE))



ifeq ($(LOCAL_DROIDDOC_SOURCE_PATH),)

LOCAL_DROIDDOC_SOURCE_PATH := $(LOCAL_PATH)
@@ -36,22 +54,10 @@ ifeq ($(LOCAL_DROIDDOC_CUSTOM_ASSET_DIR),) 
LOCAL_DROIDDOC_CUSTOM_ASSET_DIR := assets

endif



droiddoc_templates := \

    $(shell find $(LOCAL_DROIDDOC_TEMPLATE_DIR) -type f) \

    $(shell find $(LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR) -type f)



droiddoc := \

	$(HOST_JDK_TOOLS_JAR) \

	$(HOST_OUT_JAVA_LIBRARIES)/droiddoc$(COMMON_JAVA_PACKAGE_SUFFIX) \

	$(HOST_OUT_JAVA_LIBRARIES)/clearsilver$(COMMON_JAVA_PACKAGE_SUFFIX) \

	$(HOST_OUT_SHARED_LIBRARIES)/libclearsilver-jni$(HOST_JNILIB_SUFFIX)



intermediates := $(call local-intermediates-dir)



$(full_target): PRIVATE_CLASSPATH:=$(LOCAL_CLASSPATH)

full_java_lib_deps :=



ifndef LOCAL_IS_HOST_MODULE

ifneq ($(LOCAL_IS_HOST_MODULE),true)



ifeq ($(LOCAL_JAVA_LIBRARIES),)

LOCAL_JAVA_LIBRARIES := core ext framework
@@ -72,13 +78,59 @@ $(full_target): PRIVATE_CLASSPATH := $(subst $(space),:,$(full_java_libs)) 


endif # !LOCAL_IS_HOST_MODULE



$(full_target): PRIVATE_DOCLETPATH := $(HOST_OUT_JAVA_LIBRARIES)/clearsilver$(COMMON_JAVA_PACKAGE_SUFFIX):$(HOST_OUT_JAVA_LIBRARIES)/droiddoc$(COMMON_JAVA_PACKAGE_SUFFIX)

intermediates := $(call local-intermediates-dir)



$(full_target): PRIVATE_SOURCE_PATH := $(call normalize-path-list,$(LOCAL_DROIDDOC_SOURCE_PATH))

$(full_target): PRIVATE_JAVA_FILES := $(filter %.java,$(full_src_files))

$(full_target): PRIVATE_JAVA_FILES += $(addprefix $($(my_prefix)OUT_COMMON_INTERMEDIATES)/, $(filter %.java,$(LOCAL_INTERMEDIATE_SOURCES)))

$(full_target): PRIVATE_CURRENT_BUILD := -hdf page.build $(BUILD_ID)-$(BUILD_NUMBER)

$(full_target): PRIVATE_CURRENT_TIME :=  -hdf page.now "$(shell date "+%d %b %Y %k:%M")"

$(full_target): PRIVATE_SOURCE_INTERMEDIATES_DIR := $(intermediates)/src

$(full_target): PRIVATE_SRC_LIST_FILE := $(intermediates)/droiddoc-src-list



ifneq ($(strip $(LOCAL_ADDITIONAL_JAVA_DIR)),)

$(full_target): PRIVATE_ADDITIONAL_JAVA_DIR := $(LOCAL_ADDITIONAL_JAVA_DIR)

endif



$(full_target): PRIVATE_OUT_DIR := $(out_dir)

$(full_target): PRIVATE_DROIDDOC_OPTIONS := $(LOCAL_DROIDDOC_OPTIONS)



# Lists the input files for the doc build into a text file

# suitable for the @ syntax of javadoc.

# $(1): the file to create

# $(2): files to include

# $(3): list of directories to search for java files in

define prepare-doc-source-list

$(hide) mkdir -p $(dir $(1))

$(hide) echo $(2)

$(call dump-words-to-file, $(2), $(1))

$(hide) for d in $(3) ; do find $$d -name '*.java' >> $(1) 2> /dev/null ; done ; true

endef



ifeq (a,b)

$(full_target): PRIVATE_PROFILING_OPTIONS := \

    -J-agentlib:jprofilerti=port=8849 -J-Xbootclasspath/a:/Applications/jprofiler5/bin/agent.jar

endif





ifneq ($(strip $(LOCAL_DROIDDOC_USE_STANDARD_DOCLET)),true)

##

##

## droiddoc only

##

##



droiddoc_templates := \

    $(shell find $(LOCAL_DROIDDOC_TEMPLATE_DIR) -type f) \

    $(shell find $(LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR) -type f)



droiddoc := \

	$(HOST_JDK_TOOLS_JAR) \

	$(HOST_OUT_JAVA_LIBRARIES)/droiddoc$(COMMON_JAVA_PACKAGE_SUFFIX) \

	$(HOST_OUT_JAVA_LIBRARIES)/clearsilver$(COMMON_JAVA_PACKAGE_SUFFIX) \

	$(HOST_OUT_SHARED_LIBRARIES)/libclearsilver-jni$(HOST_JNILIB_SUFFIX)



$(full_target): PRIVATE_DOCLETPATH := $(HOST_OUT_JAVA_LIBRARIES)/clearsilver$(COMMON_JAVA_PACKAGE_SUFFIX):$(HOST_OUT_JAVA_LIBRARIES)/droiddoc$(COMMON_JAVA_PACKAGE_SUFFIX)

$(full_target): PRIVATE_CURRENT_BUILD := -hdf page.build $(BUILD_ID)-$(BUILD_NUMBER)

$(full_target): PRIVATE_CURRENT_TIME :=  -hdf page.now "$(shell date "+%d %b %Y %k:%M")"

$(full_target): PRIVATE_TEMPLATE_DIR := $(LOCAL_DROIDDOC_TEMPLATE_DIR)

$(full_target): PRIVATE_CUSTOM_TEMPLATE_DIR := $(LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR)

$(full_target): PRIVATE_IN_ASSET_DIR := $(LOCAL_DROIDDOC_TEMPLATE_DIR)/$(LOCAL_DROIDDOC_ASSET_DIR)
@@ -90,31 +142,18 @@ $(full_target): PRIVATE_DROIDDOC_HTML_DIR := -htmldir $(LOCAL_PATH)/$(LOCAL_DROI 
else

$(full_target): PRIVATE_DROIDDOC_HTML_DIR := 

endif

$(full_target): PRIVATE_LOCAL_PATH := $(LOCAL_PATH)

$(full_target): PRIVATE_SOURCE_PATH := $(call normalize-path-list,$(LOCAL_DROIDDOC_SOURCE_PATH))

$(full_target): PRIVATE_SOURCE_INTERMEDIATES_DIR := $(intermediates)/src

$(full_target): PRIVATE_SRC_LIST_FILE := $(intermediates)/droiddoc-src-list



ifneq ($(strip $(LOCAL_ADDITIONAL_JAVA_DIR)),)

$(full_target): PRIVATE_ADDITIONAL_JAVA_DIR := $(LOCAL_ADDITIONAL_JAVA_DIR)

endif

# TODO: not clear if this is used any more

$(full_target): PRIVATE_LOCAL_PATH := $(LOCAL_PATH)



html_dir_files := $(shell find $(LOCAL_PATH)/$(LOCAL_DROIDDOC_HTML_DIR) -type f)



ifeq (a,b)

$(full_target): PRIVATE_PROFILING_OPTIONS := \

    -J-agentlib:jprofilerti=port=8849 -J-Xbootclasspath/a:/Applications/jprofiler5/bin/agent.jar

endif



$(full_target): $(full_src_files) $(droiddoc_templates) $(droiddoc) $(html_dir_files) $(full_java_lib_deps)

	@echo Docs droiddoc: $(PRIVATE_OUT_DIR)

	@mkdir -p $(dir $(full_target))

	@mkdir -p $(dir $(PRIVATE_SRC_LIST_FILE))

	$(call dump-words-to-file, $(PRIVATE_JAVA_FILES), $(PRIVATE_SRC_LIST_FILE))

	$(hide) find $(PRIVATE_SOURCE_INTERMEDIATES_DIR) -name '*.java' >> $(PRIVATE_SRC_LIST_FILE) 2> /dev/null || true

	$(hide) if [ "$(PRIVATE_ADDITIONAL_JAVA_DIR)" != "" ] ; then ( find $(PRIVATE_ADDITIONAL_JAVA_DIR) -name '*.java' >> $(PRIVATE_SRC_LIST_FILE) 2> /dev/null || true ) fi

	$(hide) mkdir -p $(dir $(full_target))

	$(call prepare-doc-source-list,$(PRIVATE_SRC_LIST_FILE),$(PRIVATE_JAVA_FILES), \

			$(PRIVATE_SOURCE_INTERMEDIATES_DIR) $(PRIVATE_ADDITIONAL_JAVA_DIR))

	$(hide) ( \

        \

		LD_LIBRARY_PATH=$(HOST_OUT_SHARED_LIBRARIES) \

		javadoc \

                \@$(PRIVATE_SRC_LIST_FILE) \
@@ -141,6 +180,41 @@ $(full_target): $(full_src_files) $(droiddoc_templates) $(droiddoc) $(html_dir_f 
        && touch -f $@ \

    ) || (rm -rf $(PRIVATE_OUT_DIR) $(PRIVATE_SRC_LIST_FILE); exit 45)







else

##

##

## standard doclet only

##

##

$(full_target): $(full_src_files) $(full_java_lib_deps)

	@echo Docs javadoc: $(PRIVATE_OUT_DIR)

	@mkdir -p $(dir $(full_target))

	$(call prepare-doc-source-list,$(PRIVATE_SRC_LIST_FILE),$(PRIVATE_JAVA_FILES), \

			$(PRIVATE_SOURCE_INTERMEDIATES_DIR) $(PRIVATE_ADDITIONAL_JAVA_DIR))

	$(hide) ( \

		javadoc \

                $(PRIVATE_DROIDDOC_OPTIONS) \

                \@$(PRIVATE_SRC_LIST_FILE) \

                -J-Xmx768m \

                $(PRIVATE_PROFILING_OPTIONS) \

                $(addprefix -classpath ,$(PRIVATE_CLASSPATH)) \

                -sourcepath $(PRIVATE_SOURCE_PATH)$(addprefix :,$(PRIVATE_CLASSPATH)) \

                -d $(PRIVATE_OUT_DIR) \

                -quiet \

        && touch -f $@ \

    ) || (rm -rf $(PRIVATE_OUT_DIR) $(PRIVATE_SRC_LIST_FILE); exit 45)





endif

##

##

## Common to both droiddoc and javadoc

##

##





ALL_DOCS += $(full_target)



.PHONY: $(LOCAL_MODULE)-docs

core/envsetup.mk

+1 −0
Original line number Diff line number Diff line
@@ -185,6 +185,7 @@ OUT_DOCS := $(TARGET_COMMON_OUT_ROOT)/docs 
HOST_OUT_EXECUTABLES:= $(HOST_OUT)/bin

HOST_OUT_SHARED_LIBRARIES:= $(HOST_OUT)/lib

HOST_OUT_JAVA_LIBRARIES:= $(HOST_OUT)/framework

HOST_OUT_SDK_ADDON := $(HOST_OUT)/sdk_addon



HOST_OUT_INTERMEDIATES := $(HOST_OUT)/obj

HOST_OUT_HEADERS:= $(HOST_OUT_INTERMEDIATES)/include