• file
• revisions
• annotate
• diff
• comparison
• raw

common/makefiles/JavaCompilation.gmk@3156dff953b1 (annotated)

common/makefiles/JavaCompilation.gmk

Thu, 05 Jul 2012 18:27:07 -0700

author

erikj

date

Thu, 05 Jul 2012 18:27:07 -0700

changeset 459

3156dff953b1

parent 458

c8d320b48626

child 478

2ba6f4da4bf3

permissions

-rw-r--r--

7182051: Update of latest build-infra Makefiles (missing files)
Reviewed-by: ohair

ohair@425	1	#
ohair@425	2	# Copyright (c) 2011, 2012, Oracle and/or its affiliates. All rights reserved.
ohair@425	3	# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@425	4	#
ohair@425	5	# This code is free software; you can redistribute it and/or modify it
ohair@425	6	# under the terms of the GNU General Public License version 2 only, as
ohair@425	7	# published by the Free Software Foundation. Oracle designates this
ohair@425	8	# particular file as subject to the "Classpath" exception as provided
ohair@425	9	# by Oracle in the LICENSE file that accompanied this code.
ohair@425	10	#
ohair@425	11	# This code is distributed in the hope that it will be useful, but WITHOUT
ohair@425	12	# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@425	13	# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
ohair@425	14	# version 2 for more details (a copy is included in the LICENSE file that
ohair@425	15	# accompanied this code).
ohair@425	16	#
ohair@425	17	# You should have received a copy of the GNU General Public License version
ohair@425	18	# 2 along with this work; if not, write to the Free Software Foundation,
ohair@425	19	# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@425	20	#
ohair@425	21	# Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@425	22	# or visit www.oracle.com if you need additional information or have any
ohair@425	23	# questions.
ohair@425	24	#
ohair@425	25
ohair@425	26	# The complexity of this makefile is not the fault of make, but the fault
ohair@425	27	# of javac and javah. The basic problems are:
ohair@425	28	#
ohair@425	29	# 1) Compiling a single Java source file unpredictably generates anything
ohair@425	30	# between zero (0!) and an infinite number of .class files!
ohair@425	31	# 2) There is no hint, for which classes javah needs to be run,
ohair@425	32	# and it happily generates .h files for classes with no native methods.
ohair@425	33	# 3) javac and javah do not cleanup anything, for example if an internal
ohair@425	34	# class (potentially with native methods) is removed from a Java source file.
ohair@425	35	#
ohair@425	36	# This makefile is a tribute to GNU make. And yes, it was harder to write than it is
ohair@425	37	# to read. The include/excludes of directories and files are only a temporary measure
ohair@425	38	# to work around the messy jdk sources that put platform specific code in src/share/classes.
ohair@425	39	#
ohair@425	40	# We should move most of the functionality of this makefile into a
ohair@425	41	# smart javac/javah/javadoc/jar combo tool. sjavac ?
ohair@425	42	#
ohair@425	43	# I.e. 1) It always generates a single output, a zip-file from a number of source roots.
ohair@425	44	# The zip file contains information that enable incremental builds with full
ohair@425	45	# dependency tracking between packages.
ohair@425	46	# 2) It automatically generates the right .h files.
ohair@425	47	# 3) It keeps its house clean.
ohair@425	48	# *) Generates intermediate files to be used for javadoc generation later.
ohair@425	49	# and does all the other useful things that this makefile does, such as:
ohair@425	50	# use all cores for compilation, reuse the running JVM for all compilations,
ohair@425	51	# and has pubapi dependency tracking to minimize the number of files
ohair@425	52	# that need to be recompiled during an incremental build.
ohair@425	53	#
ohair@425	54	# A zip file, or several zip files combined, can then be converted to a .jar file, or to a .jmod file.
ohair@425	55	#
ohair@425	56	# This would make this makefile much much simpler. I.e. make can be used
ohair@425	57	# for its real purpose, track dependencies and trigger a recompile if a
ohair@425	58	# dependency has changed.
ohair@425	59	#
ohair@425	60	# When you read this source. Remember that $(sort ...) has the side effect
ohair@425	61	# of removing duplicates. It is actually this side effect that is
ohair@425	62	# desired whenever sort is used below!
ohair@425	63
ohair@425	64	ifeq (,$(_MAKEBASE_GMK))
ohair@425	65	$(error You must include MakeBase.gmk prior to including JavaCompilation.gmk)
ohair@425	66	endif
ohair@425	67
ohair@425	68	FALSE_FIND_PATTERN:=-name FILE_NAME_THAT_DOESNT_EXIST
ohair@425	69
ohair@425	70	# If compilation of java package fails, then the public api file for that
ohair@425	71	# package will not be genereated. We add this fallback rule to generate
ohair@425	72	# an empty pubapi file.
ohair@425	73	%.api:
ohair@425	74	if test ! -f $@; then $(MKDIR) -p $(@D); $(TOUCH) $@; fi
ohair@425	75
ohair@425	76	define SetupJavaCompiler
ohair@425	77	# param 1 is for example BOOT_JAVAC or NEW_JAVAC
ohair@425	78	# This is the name later used to decide which java compiler to use.
ohair@425	79	# param 2-9 are named args.
ohair@425	80	# JVM:=The jvm used to run the javac/javah command
ohair@425	81	# JAVAC:=The javac jar and bootstrap classpath changes, or just bin/javac if JVM is left out
ohair@425	82	# JAVAH:=The javah jar and bootstrap classpath changes, or just bin/javah if JVM is left out
ohair@425	83	# FLAGS:=Flags to be supplied to javac
ohair@425	84	# MODE:=SINGLE_THREADED_BATCH (primarily for old javac) or MULTI_CORE_CONCURRENT
ohair@425	85	# only for MULTI_CORE_CONCURRENT are the options below relevant:
ohair@425	86	# SERVER_DIR:=Use a javac server (-XDserver) and store the server related files here
ohair@425	87	# SERVER_JVM:=Use this JVM for the server. Defaults to the JVM above.
ohair@425	88	# USE_DEPS:=true means use -XDdeps,-XDpubapi and -XDnativeapi to track java dependencies
ohair@425	89	$(if $2,$1_$(strip $2))
ohair@425	90	$(if $3,$1_$(strip $3))
ohair@425	91	$(if $4,$1_$(strip $4))
ohair@425	92	$(if $5,$1_$(strip $5))
ohair@425	93	$(if $6,$1_$(strip $6))
ohair@425	94	$(if $7,$1_$(strip $7))
ohair@425	95	$(if $8,$1_$(strip $8))
ohair@425	96	$(if $9,$1_$(strip $9))
erikj@458	97	$(if $(10),$(error Internal makefile error: Too many arguments to SetupJavaCompiler, please update JavaCompilation.gmk))
ohair@425	98
ohair@425	99	ifeq ($$($1_MODE),MULTI_CORE_CONCURRENT)
ohair@425	100	ifneq (,$$($1_SERVER_DIR))
ohair@425	101	# A javac server has been requested.
ohair@425	102	# The port file contains the tcp/ip on which the server listens
ohair@425	103	# and the cookie necessary to talk to the server.
ohair@425	104	$1_JAVAC_PORTFILE:=$$($1_SERVER_DIR)/$1.port
ohair@425	105	ifeq ($$($1_SERVER_JVM),)
ohair@425	106	# You can use a different JVM to run the background javac server.
ohair@425	107	# But if not set, it defaults to the same JVM that is used to start
ohair@425	108	# the javac command.
ohair@425	109	$1_SERVER_JVM:=$$($1_JVM)
ohair@425	110	endif
ohair@425	111	# Set the $1_REMOTE to spawn a background javac server.
ohair@425	112	$1_REMOTE:=-XDserver:portfile=$$($1_JAVAC_PORTFILE),poolsize=$(JAVAC_SERVER_CORES),javac=$$(subst $$(SPACE),%20,$$(subst $$(COMMA),%2C,$$(strip $$($1_SERVER_JVM) $$($1_JAVAC))))
ohair@425	113	endif
ohair@425	114	endif
ohair@425	115	endef
ohair@425	116
ohair@425	117	define SetupArchive
ohair@425	118	# param 1 is for example ARCHIVE_MYPACKAGE
ohair@425	119	# param 2 are the dependecies
ohair@425	120	# param 3,4,5,6,7,8,9 are named args.
ohair@425	121	# SRCS:=List of directories in where to find files to add to archive
ohair@425	122	# SUFFIXES:=File suffixes to include in jar
ohair@425	123	# INCLUDES:=List of directories/packages in SRCS that should be included
ohair@425	124	# EXCLUDES:=List of directories/packages in SRCS that should be excluded
ohair@425	125	# EXCLUDE_FILES:=List of files in SRCS that should be excluded
ohair@425	126	# EXTRA_FILES:=List of files in SRCS that should be included regardless of suffix match.
ohair@425	127	# JAR:=Jar file to create
ohair@425	128	# MANIFEST:=Optional manifest file template.
ohair@425	129	# JARMAIN:=Optional main class to add to manifest
erikj@445	130	# JARINDEX :=
ohair@425	131	# SKIP_METAINF:=Set to prevent contents of an META-INF directory to be automatically
ohair@425	132	# added to the archive.
ohair@425	133	# EXTRA_MANIFEST_ATTR:=Extra attribute to add to manifest.
erikj@458	134	# CHECK_COMPRESS_JAR Check the COMPRESS_JAR variable
ohair@425	135	$(if $3,$1_$(strip $3))
ohair@425	136	$(if $4,$1_$(strip $4))
ohair@425	137	$(if $5,$1_$(strip $5))
ohair@425	138	$(if $6,$1_$(strip $6))
ohair@425	139	$(if $7,$1_$(strip $7))
ohair@425	140	$(if $8,$1_$(strip $8))
ohair@425	141	$(if $9,$1_$(strip $9))
ohair@425	142	$(if $(10),$1_$(strip $(10)))
ohair@425	143	$(if $(11),$1_$(strip $(11)))
ohair@425	144	$(if $(12),$1_$(strip $(12)))
ohair@425	145	$(if $(13),$1_$(strip $(13)))
ohair@425	146	$(if $(14),$1_$(strip $(14)))
erikj@445	147	$(if $(15),$1_$(strip $(15)))
erikj@458	148	$(if $(16),$(error Internal makefile error: Too many arguments to SetupArchive, please update JavaCompilation.gmk))
ohair@425	149
ohair@425	150	$1_JARMAIN:=$(strip $$($1_JARMAIN))
ohair@425	151	$1_JARNAME:=$$(notdir $$($1_JAR))
ohair@425	152	$1_MANIFEST_FILE:=$$(dir $$($1_JAR))_the.$$($1_JARNAME)_manifest
ohair@425	153	$1_DELETESS_FILE:=$$(dir $$($1_JAR))_the.$$($1_JARNAME)_deletess
ohair@425	154	$1_DELETES_FILE:=$$(dir $$($1_JAR))_the.$$($1_JARNAME)_deletes
ohair@425	155	$1_PUBAPI_NOTIFICATIONS_FILE:=$$(dir $$($1_JAR))_the.$$($1_JARNAME)_pubapi_notifications
ohair@425	156	$1_NATIVEAPI_NOTIFICATIONS_FILE:=$$(dir $$($1_JAR))_the.$$($1_JARNAME)_native_notifications
ohair@425	157	$1_NATIVEAPI_FILE:=$$(dir $$($1_JAR))_the.$$($1_JARNAME)_native
ohair@425	158	$1_BIN:=$$(dir $$($1_JAR))
erikj@445	159
ohair@425	160	ifeq (,$$($1_SUFFIXES))
ohair@425	161	# No suffix was set, default to classes.
ohair@425	162	$1_SUFFIXES:=.class
ohair@425	163	endif
ohair@425	164	# Convert suffixes to a find expression
ohair@425	165	$1_FIND_PATTERNS:=$(FALSE_FIND_PATTERN) $$(patsubst %,$(SPACE)-o$(SPACE)-name$(SPACE)$(DQUOTE)*%$(DQUOTE),$$($1_SUFFIXES))
erikj@445	166	# On windows, a lot of includes/excludes risk making the command line too long, so
erikj@445	167	# writing the grep patterns to files.
ohair@425	168	ifneq (,$$($1_INCLUDES))
erikj@445	169	$1_GREP_INCLUDE_PATTERNS:=$$(foreach src,$$($1_SRCS),\
erikj@445	170	$$(addprefix $$(src)/,$$($1_INCLUDES)))
erikj@445	171	$$(eval $$(call ListPathsSafelyNow,$1_GREP_INCLUDE_PATTERNS,\n, \
erikj@445	172	>> $$($1_BIN)/_the.$$($1_JARNAME)_include))
erikj@445	173	$1_GREP_INCLUDES:=| $(GREP) -f $$($1_BIN)/_the.$$($1_JARNAME)_include
ohair@425	174	endif
ohair@425	175	ifneq (,$$($1_EXCLUDES)$$($1_EXCLUDE_FILES))
erikj@445	176	$1_GREP_EXCLUDE_PATTERNS:=$$(foreach src,$$($1_SRCS),$$(addprefix $$(src)/,\
erikj@445	177	$$($1_EXCLUDES) $$($1_EXCLUDE_FILES)))
erikj@445	178	$$(eval $$(call ListPathsSafelyNow,$1_GREP_EXCLUDE_PATTERNS,\n, \
erikj@445	179	>> $$($1_BIN)/_the.$$($1_JARNAME)_exclude))
erikj@445	180	$1_GREP_EXCLUDES:=| $(GREP) -v -f $$($1_BIN)/_the.$$($1_JARNAME)_exclude
ohair@425	181	endif
ohair@425	182
erikj@445	183	ifneq (,$$($1_JARINDEX))
erikj@445	184	$1_JARINDEX = (cd $$(dir $$@) && $(JAR) -i $$(notdir $$@))
erikj@445	185	else
erikj@445	186	$1_JARINDEX = true
erikj@445	187	endif
erikj@445	188	# When this macro is run in the same makefile as the java compilation, dependencies are transfered
erikj@445	189	# in make variables. When the macro is run in a different makefile than the java compilation, the
erikj@445	190	# dependencies need to be found in the filesystem.
erikj@445	191	$1_ALL_SRCS:=$$(foreach src,$$($1_SRCS),$$(shell ($(FIND) $$(src) -type f \
erikj@445	192	-a \( $$($1_FIND_PATTERNS) \) $$($1_GREP_INCLUDES) \
erikj@445	193	$$($1_GREP_EXCLUDES) && $(ECHO) $$($1_EXTRA_FILES))))
erikj@445	194	ifeq (,$$($1_SKIP_METAINF))
erikj@445	195	$1_ALL_SRCS+=$$(foreach src,$$($1_SRCS),$$(shell $(FIND) $$(src)/META-INF -type f 2> /dev/null))
erikj@445	196	endif
erikj@445	197
erikj@445	198
ohair@425	199	# Utility macros, to make the shell script receipt somewhat easier to dechipher.
ohair@425	200
ohair@425	201	# The capture contents macro finds all files (matching the patterns, typically
ohair@425	202	# .class and .prp) that are newer than the jar-file, ie the new content to be put into the jar.
ohair@425	203	$1_CAPTURE_CONTENTS=$$(foreach src,$$($1_SRCS),(($(FIND) $$(src) -type f -a \( $$($1_FIND_PATTERNS) \) -a -newer $$@ $$($1_GREP_INCLUDES) $$($1_GREP_EXCLUDES) && $(ECHO) $$($1_EXTRA_FILES)) | $(SED) 's|$$(src)/||g' > $$(src)/_the.$$($1_JARNAME)_contents) && )
ohair@425	204	# The capture metainf macro finds all files below the META-INF directory that are newer than the jar-file.
ohair@425	205	ifeq (,$$($1_SKIP_METAINF))
ohair@425	206	$1_CAPTURE_METAINF =$$(foreach src,$$($1_SRCS),($(FIND) $$(src)/META-INF -type f -a -newer $$@ 2> /dev/null | $(SED) 's|$$(src)/||g' >> $$(src)/_the.$$($1_JARNAME)_contents ) && )
ohair@425	207	endif
ohair@425	208	# The capture deletes macro finds all deleted files and concatenates them. The resulting file
ohair@425	209	# tells us what to remove from the jar-file.
ohair@425	210	$1_CAPTURE_DELETES=$$(foreach src,$$($1_SRCS),($(FIND) $$(src) -name _the.package.deleted -newer $$@ -exec $(SED) 's|$$(src)||g' \{\} >> $$($1_DELETES_FILE) \;) &&)
ohair@425	211	# The capture pubapi notifications scans for pubapi change notifications. If such notifications are
ohair@425	212	# found, then we will build the classes leading up to the jar again, to take into account the new timestamps
ohair@425	213	# on the changed pubapi files.
ohair@425	214	$1_CAPTURE_PUBAPI_NOTIFICATIONS=$$(foreach src,$$($1_SRCS),\
ohair@425	215	(cd $$(src) && \
ohair@425	216	$(FIND) . -name _the.package.api.notify -exec dirname \{\} \; >> $$($1_PUBAPI_NOTIFICATIONS_FILE) ; \
ohair@425	217	true) &&)
ohair@425	218	# The update contents macro updates the jar file with the previously capture contents.
ohair@425	219	$1_UPDATE_CONTENTS=$$(foreach src,$$($1_SRCS),\
ohair@425	220	(cd $$(src) && \
ohair@425	221	if [ -s _the.$$($1_JARNAME)_contents ]; then \
ohair@425	222	$(ECHO) " updating" `$(WC) -l _the.$$($1_JARNAME)_contents | $(AWK) '{ print $$$$1 }'` files && \
ohair@425	223	$(JAR) uf $$@ @_the.$$($1_JARNAME)_contents; \
ohair@425	224	fi) &&)
ohair@425	225	# The s-variants of the above macros are used when the jar is created from scratch.
ohair@425	226	$1_SCAPTURE_CONTENTS=$$(foreach src,$$($1_SRCS),\
erikj@445	227	(($(FIND) $$(src) -type f -a \( $$($1_FIND_PATTERNS) \) $$($1_GREP_INCLUDES) \
erikj@445	228	$$($1_GREP_EXCLUDES) && $(ECHO) $$($1_EXTRA_FILES)) | $(SED) 's|$$(src)/||g' > \
erikj@445	229	$$(src)/_the.$$($1_JARNAME)_contents) && )
erikj@445	230
ohair@425	231	ifeq (,$$($1_SKIP_METAINF))
ohair@425	232	$1_SCAPTURE_METAINF=$$(foreach src,$$($1_SRCS),\
erikj@445	233	($(FIND) $$(src)/META-INF -type f 2> /dev/null | $(SED) 's|$$(src)/||g' >> \
erikj@445	234	$$(src)/_the.$$($1_JARNAME)_contents) && )
ohair@425	235	endif
ohair@425	236	$1_SUPDATE_CONTENTS=$$(foreach src,$$($1_SRCS),\
ohair@425	237	(cd $$(src) && $(JAR) uf $$@ @$$(src)/_the.$$($1_JARNAME)_contents) &&)
erikj@445	238
ohair@425	239	# The TOUCH macro is used to make sure all timestamps are identical for package files and the pubapi files.
ohair@425	240	# If we do not do this, we get random recompilations, the next time we run make, since the order of package building is random,
ohair@425	241	# ie independent of package --dependes on-> public api of another package. This is of course
ohair@425	242	# due to the fact that Java source often (always?) has circular dependencies. (Thus there is no correct order
ohair@425	243	# to compile packages, and we can just as well do them in a random order. Which we do.)
ohair@425	244	$1_TOUCH_API_FILES=$$(foreach src,$$($1_SRCS),\
ohair@425	245	($(FIND) $$(src) -name _the.package.api -exec $(TOUCH) -r $$($1_JAR) \{\} \; ; true) && \
ohair@425	246	($(FIND) $$(src) -name _the.package -exec $(TOUCH) -r $$($1_JAR) \{\} \; ; true) &&)
ohair@425	247	# Use a slightly shorter name for logging, but with enough path to identify this jar.
ohair@425	248	$1_NAME:=$$(subst $$(OUTPUT_ROOT)/,,$$($1_JAR))
erikj@458	249
erikj@458	250	ifneq (,$$($1_CHECK_COMPRESS_JAR))
erikj@458	251	$1_JAR_CREATE_OPTIONS := c0fm
erikj@458	252	ifeq ($(COMPRESS_JARS), true)
erikj@458	253	$1_JAR_CREATE_OPTIONS := cfm
erikj@458	254	endif
erikj@458	255	else
erikj@458	256	$1_JAR_CREATE_OPTIONS := cfm
erikj@458	257	endif
erikj@458	258
ohair@425	259	# Here is the rule that creates/updates the jar file.
erikj@445	260	$$($1_JAR) : $2 $$($1_ALL_SRC)
ohair@425	261	$(MKDIR) -p $$($1_BIN)
ohair@425	262	if [ -n "$$($1_MANIFEST)" ]; then \
ohair@425	263	$(SED) -e "s#@@RELEASE@@#$(RELEASE)#" \
ohair@425	264	-e "s#@@COMPANY_NAME@@#$(COMPANY_NAME)#" $$($1_MANIFEST) > $$($1_MANIFEST_FILE); \
ohair@425	265	else \
ohair@425	266	$(RM) $$($1_MANIFEST_FILE) && $(TOUCH) $$($1_MANIFEST_FILE); \
ohair@425	267	fi
erikj@445	268	if [ -n "$$(strip $$($1_JARMAIN))" ]; then \
erikj@445	269	$(ECHO) "Main-Class: $$(strip $$($1_JARMAIN))" >> $$($1_MANIFEST_FILE); \
erikj@445	270	fi
ohair@425	271	if [ -n "$$($1_EXTRA_MANIFEST_ATTR)" ]; then \
erikj@445	272	$(PRINTF) "$$($1_EXTRA_MANIFEST_ATTR)\n" >> $$($1_MANIFEST_FILE); \
ohair@425	273	fi
ohair@425	274	+if [ -s $$@ ]; then \
ohair@425	275	$(RM) -r $$($1_PUBAPI_NOTIFICATIONS_FILE) && \
ohair@425	276	$$($1_CAPTURE_PUBAPI_NOTIFICATIONS) \
ohair@425	277	if [ -s $$($1_PUBAPI_NOTIFICATIONS_FILE) ]; then \
ohair@425	278	$(ECHO) Public api change detected in: && \
ohair@425	279	$(CAT) $$($1_PUBAPI_NOTIFICATIONS_FILE) | $(TR) '/' '.' | $(SED) 's|^..||g' | $(SED) 's|\.$$$$||g' | $(AWK) '{print " "$$$$1}' && \
ohair@425	280	$$(foreach src,$$($1_SRCS),($(FIND) $$(src) -name _the.package.api.notify $(FIND_DELETE); true) &&) \
ohair@425	281	$(MAKE) -f $(word 1,$(MAKEFILE_LIST)) $$($1_JAR) ; \
ohair@425	282	else \
ohair@425	283	$(ECHO) Modifying $$($1_NAME) && \
ohair@425	284	$$($1_CAPTURE_CONTENTS) \
ohair@425	285	$$($1_CAPTURE_METAINF) \
ohair@425	286	$(RM) $$($1_DELETES_FILE) && \
ohair@425	287	$$($1_CAPTURE_DELETES) \
ohair@425	288	$(CAT) $$($1_DELETES_FILE) > $$($1_DELETESS_FILE) && \
ohair@425	289	if [ -s $$($1_DELETESS_FILE) ]; then \
ohair@425	290	$(ECHO) " deleting" `$(WC) -l $$($1_DELETESS_FILE) | $(AWK) '{ print $$$$1 }'` files && \
ohair@425	291	$(ZIP) -q -d $$@ `$(CAT) $$($1_DELETESS_FILE)` ; \
ohair@425	292	fi && \
ohair@425	293	$$($1_UPDATE_CONTENTS) true && \
erikj@445	294	$$($1_JARINDEX) && \
ohair@425	295	$$($1_TOUCH_API_FILES) true && \
ohair@425	296	$$(foreach src,$$($1_SRCS),($(FIND) $$(src) -name _the.package.api.notify $(FIND_DELETE); true) &&) true ; \
ohair@425	297	fi ; \
ohair@425	298	else \
erikj@458	299	$(ECHO) Creating $$($1_NAME) && $(JAR) $$($1_JAR_CREATE_OPTIONS) $$@ $$($1_MANIFEST_FILE) && \
ohair@425	300	$$($1_SCAPTURE_CONTENTS) \
ohair@425	301	$$($1_SCAPTURE_METAINF) \
ohair@425	302	$$($1_SUPDATE_CONTENTS) \
erikj@445	303	$$($1_JARINDEX) && \
ohair@425	304	$$($1_TOUCH_API_FILES) true && \
ohair@425	305	$(RM) -r $$($1_NATIVEAPI_NOTIFICATIONS_FILE) $$($1_NATIVEAPI_FILE) && \
ohair@425	306	$$(foreach src,$$($1_SRCS),($(FIND) $$(src) -name "*.notify" $(FIND_DELETE); true) &&) true ; \
ohair@425	307	fi;
ohair@425	308
ohair@425	309	endef
ohair@425	310
ohair@425	311	define append_to
ohair@425	312	$(ECHO) "$1" >> $2
ohair@425	313	endef
ohair@425	314
ohair@425	315	define SetupZipArchive
ohair@425	316	# param 1 is for example ZIP_MYSOURCE
ohair@425	317	# param 2,3,4,5,6,7,8,9 are named args.
erikj@445	318	# SRC,ZIP,INCLUDES,EXCLUDES,EXCLUDE_FILES,SUFFIXES,EXTRA_DEPS
ohair@425	319	$(if $2,$1_$(strip $2))
ohair@425	320	$(if $3,$1_$(strip $3))
ohair@425	321	$(if $4,$1_$(strip $4))
ohair@425	322	$(if $5,$1_$(strip $5))
ohair@425	323	$(if $6,$1_$(strip $6))
ohair@425	324	$(if $7,$1_$(strip $7))
ohair@425	325	$(if $8,$1_$(strip $8))
ohair@425	326	$(if $9,$1_$(strip $9))
erikj@458	327	$(if $(10),$(error Internal makefile error: Too many arguments to SetupZipArchive, please update JavaCompilation.gmk))
ohair@425	328
ohair@425	329	# Find all files in the source tree.
erikj@445	330	$1_SUFFIX_FILTER := $$(patsubst %,-o -name $(DQUOTE)*%$(DQUOTE),$$($1_SUFFIXES))
erikj@445	331	$1_ALL_SRCS := $$(foreach i,$$($1_SRC), $$(shell $(FIND) $$i -type f -a ! -name "_the.*" \( -name FALSE_DUMMY $$($1_SUFFIX_FILTER) \) ))
ohair@425	332
ohair@425	333	ifneq ($$($1_INCLUDES),)
ohair@425	334	$1_SRC_INCLUDES := $$(foreach i,$$($1_SRC),$$(addprefix $$i/,$$(addsuffix /%,$$($1_INCLUDES))))
erikj@445	335	ifneq ($$($1_SUFFIXES),)
erikj@445	336	$1_ZIP_INCLUDES := $$(foreach s,$$($1_SUFFIXES),\
erikj@445	337	$$(addprefix -i$(SPACE)$(DQUOTE),$$(addsuffix /*$$s$(DQUOTE),$$($1_INCLUDES))))
erikj@445	338	else
erikj@445	339	$1_ZIP_INCLUDES := $$(addprefix -i$(SPACE)$(DQUOTE),$$(addsuffix /*$(DQUOTE),$$($1_INCLUDES)))
erikj@445	340	endif
ohair@425	341	$1_ALL_SRCS := $$(filter $$($1_SRC_INCLUDES),$$($1_ALL_SRCS))
ohair@425	342	endif
ohair@425	343	ifneq ($$($1_EXCLUDES),)
ohair@425	344	$1_SRC_EXCLUDES := $$(foreach i,$$($1_SRC),$$(addprefix $$i/,$$(addsuffix /%,$$($1_EXCLUDES))))
ohair@425	345	$1_ZIP_EXCLUDES := $$(addprefix -x$(SPACE)$(DQUOTE),$$(addsuffix /*$(DQUOTE),$$($1_EXCLUDES)))
ohair@425	346	$1_ALL_SRCS := $$(filter-out $$($1_SRC_EXCLUDES),$$($1_SRCS))
ohair@425	347	endif
ohair@425	348
ohair@425	349	# Use a slightly shorter name for logging, but with enough path to identify this zip.
ohair@425	350	$1_NAME:=$$(subst $$(OUTPUT_ROOT)/,,$$($1_ZIP))
ohair@425	351
ohair@425	352	# Now $1_ALL_SRCS should contain all sources that are going to be put into the zip.
ohair@425	353	# I.e. the zip -i and -x options should match the filtering done in the makefile.
ohair@425	354	# Explicitly excluded files can be given with absolute path. The patsubst solution
ohair@425	355	# isn't perfect but the likelyhood of an absolute path to match something in a src
ohair@425	356	# dir is very small.
erikj@445	357	$$($1_ZIP) : $$($1_ALL_SRCS) $$($1_EXTRA_DEPS)
ohair@425	358	$(MKDIR) -p $$(@D)
ohair@425	359	$(ECHO) Updating $$($1_NAME)
ohair@425	360	$$(foreach i,$$($1_SRC),(cd $$i && $(ZIP) -qru $$@ . $$($1_ZIP_INCLUDES) $$($1_ZIP_EXCLUDES) -x \*_the.\* $$(addprefix -x$(SPACE),$$(patsubst $$i/%,%,$$($1_EXCLUDE_FILES)))) ;) true
ohair@425	361	$(TOUCH) $$@
ohair@425	362	endef
ohair@425	363
ohair@425	364	define add_file_to_copy
ohair@425	365	# param 1 = BUILD_MYPACKAGE
ohair@425	366	# parma 2 = The source file to copy.
ohair@425	367	$2_TARGET:=$2
ohair@425	368	# Remove the source prefix.
ohair@425	369	$$(foreach i,$$($1_SRC),$$(eval $$(call remove_string,$$i,$2_TARGET)))
ohair@425	370	# Now we can setup the depency that will trigger the copying.
ohair@425	371	$$($1_BIN)$$($2_TARGET) : $2
ohair@425	372	$(MKDIR) -p $$(@D)
ohair@425	373	$(CP) $$< $$@
ohair@425	374	$(CHMOD) -f ug+w $$@
ohair@425	375
ohair@425	376	# And do not forget this target
ohair@425	377	$1_ALL_COPY_TARGETS += $$($1_BIN)$$($2_TARGET)
ohair@425	378	endef
ohair@425	379
ohair@425	380
ohair@425	381	# This macro is used only for properties files that are to be
ohair@425	382	# copied over to the classes directory in cleaned form:
ohair@425	383	# Previously this was inconsistently done in different repositories.
ohair@425	384	# This is the new clean standard.
ohair@425	385	define add_file_to_copy_and_clean
ohair@425	386	# param 1 = BUILD_MYPACKAGE
ohair@425	387	# parma 2 = The source file to copy and clean.
ohair@425	388	$2_TARGET:=$2
ohair@425	389	# Remove the source prefix.
ohair@425	390	$$(foreach i,$$($1_SRC),$$(eval $$(call remove_string,$$i,$2_TARGET)))
ohair@425	391	# Now we can setup the depency that will trigger the copying.
ohair@425	392	$$($1_BIN)$$($2_TARGET) : $2
ohair@425	393	$(MKDIR) -p $$(@D)
ohair@425	394	$(ECHO) Cleaning $$($2_TARGET)
ohair@425	395	$(CAT) $$< | $(SED) -e 's/\([^\\]\):/\1\\:/g' -e 's/\([^\\]\)=/\1\\=/g' -e 's/#.*/#/g' \
ohair@425	396	| $(SED) \
ohair@425	397	-e 's/\\u0020/\x20/g' \
ohair@425	398	-e 's/\\u003A/\x3A/g' \
ohair@425	399	-e 's/\\u006B/\x6B/g' \
ohair@425	400	-e 's/\\u0075/\x75/g' \
ohair@425	401	-e 's/\\u00A0/\xA0/g' \
ohair@425	402	-e 's/\\u00A3/\xA3/g' \
ohair@425	403	-e 's/\\u00B0/\xB0/g' \
ohair@425	404	-e 's/\\u00B7/\xB7/g' \
ohair@425	405	-e 's/\\u00BA/\xBA/g' \
ohair@425	406	-e 's/\\u00BF/\xBF/g' \
ohair@425	407	-e 's/\\u00C0/\xC0/g' \
ohair@425	408	-e 's/\\u00C1/\xC1/g' \
ohair@425	409	-e 's/\\u00C2/\xC2/g' \
ohair@425	410	-e 's/\\u00C4/\xC4/g' \
ohair@425	411	-e 's/\\u00C5/\xC5/g' \
ohair@425	412	-e 's/\\u00C8/\xC8/g' \
ohair@425	413	-e 's/\\u00C9/\xC9/g' \
ohair@425	414	-e 's/\\u00CA/\xCA/g' \
ohair@425	415	-e 's/\\u00CD/\xCD/g' \
ohair@425	416	-e 's/\\u00CE/\xCE/g' \
ohair@425	417	-e 's/\\u00D3/\xD3/g' \
ohair@425	418	-e 's/\\u00D4/\xD4/g' \
ohair@425	419	-e 's/\\u00D6/\xD6/g' \
ohair@425	420	-e 's/\\u00DA/\xDA/g' \
ohair@425	421	-e 's/\\u00DC/\xDC/g' \
ohair@425	422	-e 's/\\u00DD/\xDD/g' \
ohair@425	423	-e 's/\\u00DF/\xDF/g' \
ohair@425	424	-e 's/\\u00E0/\xE0/g' \
ohair@425	425	-e 's/\\u00E1/\xE1/g' \
ohair@425	426	-e 's/\\u00E2/\xE2/g' \
ohair@425	427	-e 's/\\u00E3/\xE3/g' \
ohair@425	428	-e 's/\\u00E4/\xE4/g' \
ohair@425	429	-e 's/\\u00E5/\xE5/g' \
ohair@425	430	-e 's/\\u00E6/\xE6/g' \
ohair@425	431	-e 's/\\u00E7/\xE7/g' \
ohair@425	432	-e 's/\\u00E8/\xE8/g' \
ohair@425	433	-e 's/\\u00E9/\xE9/g' \
ohair@425	434	-e 's/\\u00EA/\xEA/g' \
ohair@425	435	-e 's/\\u00EB/\xEB/g' \
ohair@425	436	-e 's/\\u00EC/\xEC/g' \
ohair@425	437	-e 's/\\u00ED/\xED/g' \
ohair@425	438	-e 's/\\u00EE/\xEE/g' \
ohair@425	439	-e 's/\\u00EF/\xEF/g' \
ohair@425	440	-e 's/\\u00F1/\xF1/g' \
ohair@425	441	-e 's/\\u00F2/\xF2/g' \
ohair@425	442	-e 's/\\u00F3/\xF3/g' \
ohair@425	443	-e 's/\\u00F4/\xF4/g' \
ohair@425	444	-e 's/\\u00F5/\xF5/g' \
ohair@425	445	-e 's/\\u00F6/\xF6/g' \
ohair@425	446	-e 's/\\u00F9/\xF9/g' \
ohair@425	447	-e 's/\\u00FA/\xFA/g' \
ohair@425	448	-e 's/\\u00FC/\xFC/g' \
ohair@425	449	-e 's/\\u0020/\x20/g' \
ohair@425	450	-e 's/\\u003f/\x3f/g' \
ohair@425	451	-e 's/\\u006f/\x6f/g' \
ohair@425	452	-e 's/\\u0075/\x75/g' \
ohair@425	453	-e 's/\\u00a0/\xa0/g' \
ohair@425	454	-e 's/\\u00a3/\xa3/g' \
ohair@425	455	-e 's/\\u00b0/\xb0/g' \
ohair@425	456	-e 's/\\u00ba/\xba/g' \
ohair@425	457	-e 's/\\u00bf/\xbf/g' \
ohair@425	458	-e 's/\\u00c1/\xc1/g' \
ohair@425	459	-e 's/\\u00c4/\xc4/g' \
ohair@425	460	-e 's/\\u00c5/\xc5/g' \
ohair@425	461	-e 's/\\u00c8/\xc8/g' \
ohair@425	462	-e 's/\\u00c9/\xc9/g' \
ohair@425	463	-e 's/\\u00ca/\xca/g' \
ohair@425	464	-e 's/\\u00cd/\xcd/g' \
ohair@425	465	-e 's/\\u00d6/\xd6/g' \
ohair@425	466	-e 's/\\u00dc/\xdc/g' \
ohair@425	467	-e 's/\\u00dd/\xdd/g' \
ohair@425	468	-e 's/\\u00df/\xdf/g' \
ohair@425	469	-e 's/\\u00e0/\xe0/g' \
ohair@425	470	-e 's/\\u00e1/\xe1/g' \
ohair@425	471	-e 's/\\u00e2/\xe2/g' \
ohair@425	472	-e 's/\\u00e3/\xe3/g' \
ohair@425	473	-e 's/\\u00e4/\xe4/g' \
ohair@425	474	-e 's/\\u00e5/\xe5/g' \
ohair@425	475	-e 's/\\u00e7/\xe7/g' \
ohair@425	476	-e 's/\\u00e8/\xe8/g' \
ohair@425	477	-e 's/\\u00e9/\xe9/g' \
ohair@425	478	-e 's/\\u00ea/\xea/g' \
ohair@425	479	-e 's/\\u00eb/\xeb/g' \
ohair@425	480	-e 's/\\u00ec/\xec/g' \
ohair@425	481	-e 's/\\u00ed/\xed/g' \
ohair@425	482	-e 's/\\u00ee/\xee/g' \
ohair@425	483	-e 's/\\u00ef/\xef/g' \
ohair@425	484	-e 's/\\u00f0/\xf0/g' \
ohair@425	485	-e 's/\\u00f1/\xf1/g' \
ohair@425	486	-e 's/\\u00f2/\xf2/g' \
ohair@425	487	-e 's/\\u00f3/\xf3/g' \
ohair@425	488	-e 's/\\u00f4/\xf4/g' \
ohair@425	489	-e 's/\\u00f5/\xf5/g' \
ohair@425	490	-e 's/\\u00f6/\xf6/g' \
ohair@425	491	-e 's/\\u00f7/\xf7/g' \
ohair@425	492	-e 's/\\u00f8/\xf8/g' \
ohair@425	493	-e 's/\\u00f9/\xf9/g' \
ohair@425	494	-e 's/\\u00fa/\xfa/g' \
ohair@425	495	-e 's/\\u00fc/\xfc/g' \
ohair@425	496	-e 's/\\u00ff/\xff/g' \
ohair@425	497	| $(SED) -e '/^#/d' -e '/^$$$$/d' \
ohair@425	498	-e :a -e '/\\$$$$/N; s/\\\n//; ta' \
ohair@425	499	-e 's/^[ \t]*//;s/[ \t]*$$$$//' \
erikj@445	500	-e 's/\\=/=/' | LANG=C $(SORT) > $$@
ohair@425	501	$(CHMOD) -f ug+w $$@
ohair@425	502
ohair@425	503	# And do not forget this target
ohair@425	504	$1_ALL_COPY_CLEAN_TARGETS += $$($1_BIN)$$($2_TARGET)
ohair@425	505	endef
ohair@425	506
ohair@425	507	define add_java_package
ohair@425	508	# param 1 = BUILD_MYPACKAGE
ohair@425	509	# param 2 = the package target file (_the.package)
ohair@425	510	# param 3 = src roots, all of them, separated with space
ohair@425	511	# param 4 = bin root
ohair@425	512	# param 5 = include these dependecies
ohair@425	513	# param 6 = not used
ohair@425	514	# param 7 = if non-empty, then use -Xdeps and -Xpubapi
ohair@425	515	# param 8 = xremote configuration, or empty.
ohair@425	516	# param 9 = javac command
ohair@425	517	# param 10 = javac flags
ohair@425	518	# param 11 = exclude these files!
ohair@425	519	# param 12 = only include these files!
ohair@425	520	# param 13 = javah command
ohair@425	521	# param 14 = override src roots to be passed into -sourcepath, ugly ugly ugly, do not use this!
ohair@425	522	# it is only here to workaround ugly things in the source code in the jdk that ought
ohair@425	523	# to be fixed instead!
ohair@425	524	ifdef $2_USED_BY
ohair@425	525	$$(error Attempting to add the package $2 from $3 which is already added with sources from $$($2_USED_BY))
ohair@425	526	endif
ohair@425	527	$2_USED_BY:=$3
ohair@425	528	# Remove the _the.package file to get the target bin dir for the classes in this package.
ohair@425	529	$2_PACKAGE_BDIR:=$(dir $2)
ohair@425	530	# The source roots separated with a path separator (: or ; depending on os)
ohair@425	531	# (The patsubst is necessary to trim away unnecessary spaces.)
ohair@425	532	ifneq ($(14),)
ohair@425	533	$2_SRCROOTSC:=$(subst $(SPACE),$(PATH_SEP),$(strip $(patsubst %,%,$(14))))
ohair@425	534	else
ohair@425	535	$2_SRCROOTSC:=$(subst $(SPACE),$(PATH_SEP),$(strip $(patsubst %,%,$3)))
ohair@425	536	endif
ohair@425	537	# Suffix the package path to the src roots, to get a list of all possible source locations
ohair@425	538	# for this package.
ohair@425	539	$2_PACKAGE_SDIRS:=$$(foreach i,$3,$$(subst $4,$$i,$$($2_PACKAGE_BDIR)))
ohair@425	540	# Use wildcard in all potential source locations to find the actual sources.
ohair@425	541	$2_PACKAGE_SRCS:=$$(filter-out $(11),$$(wildcard $$(addsuffix *.java,$$($2_PACKAGE_SDIRS))))
ohair@425	542	ifneq ($(12),)
ohair@425	543	# Filter on include file filter if set.
ohair@425	544	$2_PACKAGE_SRCS:=$$(filter $(12),$$($2_PACKAGE_SRCS))
ohair@425	545	endif
ohair@425	546	# Generate a proper package name from the file name.
ohair@425	547	$2_PACKAGE:=$(patsubst .%.,%,$(subst /,.,$(subst $4,,$(dir $2))))
ohair@425	548	# Use a javac server for this package?
ohair@425	549	$2_REMOTE:=$8
ohair@425	550
ohair@425	551	# Include previously generated information about what classes are output by this package
ohair@425	552	# and what sources were used for the compile.
ohair@425	553	-include $$($2_PACKAGE_BDIR)_the.package.d
ohair@425	554
ohair@425	555	# Include the notify, file, that exists if the package has been compiled during a previous make round.
ohair@425	556	# I.e. we are now dealing with a compile triggered by a pubapi change.
ohair@425	557	-include $$($2_PACKAGE_BDIR)_the.package.notify
ohair@425	558
ohair@425	559	# If the notify file existed, then $$($2_NOTIFIED) will be equal to true.
ohair@425	560	# Use this information to block dependency tracking for this package.
ohair@425	561	# This is necessary to cut the circular dependency chains that are so common in Java sources.
ohair@425	562
ohair@425	563	ifneq ($$($2_NOTIFIED),true)
ohair@425	564	# No need to block, since this package has not yet been recompiled.
ohair@425	565	# Thus include previously generated dependency information. (if it exists)
ohair@425	566	-include $$($2_PACKAGE_BDIR)_the.package.dddd
ohair@425	567	# else
ohair@425	568	# $$(info WAS NOTIFIED $2)
ohair@425	569	endif
ohair@425	570
ohair@425	571	# Should we create proper dependencies between packages?
ohair@425	572	ifneq ($7,)
ohair@425	573	# The flag: -XDpubapi:file=foo,package=mypack,notify writes a file foo that contains a
ohair@425	574	# database of the public api of the classes supplied on the command line and are
ohair@425	575	# inside the package mypack. If foo already exists, javac will only write to foo,
ohair@425	576	# if there is a change in the pubapi. I.e. we can use the timestamp of this file
ohair@425	577	# for triggering dependencies. "notify" means create a "file" suffixed with notify
ohair@425	578	# if the pubapi really changed.
ohair@425	579	$2_PUBAPI=-XDpubapi=file=$$($2_PACKAGE_BDIR)_the.package.api,notify,package=$$($2_PACKAGE)
ohair@425	580	# The flag: -XDnativeapi:file=foo,package=mypack,notify works similar to pubabi, but
ohair@425	581	# instead tracks native methods. This file can be used to trigger dependencies for
ohair@425	582	# native compilations.
ohair@425	583	$2_NATIVEAPI=-XDnativeapi=file=$$($2_PACKAGE_BDIR)_the.package.native,notify,package=$$($2_PACKAGE)
ohair@425	584	# The flag -XDdeps:file=foo.deps,groupon=package writes a foo.deps file containing packages dependencies:
ohair@425	585	# java.net : java.io java.lang
ohair@425	586	# I.e. the classes in .net depend on the public apis of java.io and java.lang
ohair@425	587	# The dependencies can be grouped on classes instead (groupon=class)
ohair@425	588	# java.net.Bar : java.io.Socket java.lang.String
ohair@425	589	$2_DEPS:=-XDdeps=file=$$($2_PACKAGE_BDIR)_the.package.deps,groupon=package
ohair@425	590	# The next command rewrites the deps output from javac into a proper makefile dependency.
ohair@425	591	# The dependencies are always to an .api file generated by the pubapi option above.
ohair@425	592	# This is necessary since java package dependencies are almost always circular.
ohair@425	593	$2_APPEND_DEPS:=($(CAT) $$($2_PACKAGE_BDIR)_the.package.deps | $(TR) '.' '/' | $(AWK) '{ print "$4/" $$$$3 }' | sort > $$($2_PACKAGE_BDIR)_the.package.ddd && $(GREP) -f $$($2_PACKAGE_BDIR)_the.package.ddd $5 | $(AWK) '{ print "$(dir $2)_the.package : " $$$$1 "_the.package.api" }' > $$($2_PACKAGE_BDIR)_the.package.dddd ; true)
ohair@425	594	else
ohair@425	595	# If not using dependencies, use $2 as fallback to trigger regeneration of javah header files.
ohair@425	596	# This will generate a surplus of header files, but this does not hurt compilation.
ohair@425	597	$2_NATIVEAPICHANGE_TRIGGER:=$2
ohair@425	598	$2_FETCH_NATIVEAPICHANGE_CLASSES:=$(CAT) $$($2_PACKAGE_BDIR)_the.package.now|$(GREP) -v '\$$$$'|$(SED) -e 's|$4/||g'|$(SED) 's|.class||g'| $(TR) '/' '.'
ohair@425	599	endif
ohair@425	600
ohair@425	601	# The _the.package file is dependent on the java files inside the package.
ohair@425	602	# Fill the _the.package file with a list of the java files and compile them
ohair@425	603	# to class files.
ohair@425	604	$2 : $$($2_PACKAGE_SRCS)
ohair@425	605	$(MKDIR) -p $$($2_PACKAGE_BDIR)
ohair@425	606	$(RM) $2.tmp
ohair@425	607	$$(call ListPathsSafely,$2_PACKAGE_SRCS,\n, >> $2.tmp)
ohair@425	608	$(ECHO) $$($2_PACKAGE_BDIR)*.class | $(GREP) -v \*.class | $(TR) ' ' '\n' > $$($2_PACKAGE_BDIR)_the.package.prev
ohair@425	609	$(RM) $$($2_PACKAGE_BDIR)*.class $$($2_PACKAGE_BDIR)*.notify $$($2_PACKAGE_BDIR)*.deleted
ohair@425	610	$(ECHO) Compiling `$(WC) $2.tmp | $(TR) -s ' ' | $(CUT) -f 2 -d ' '` files in package $(patsubst $4/%/,%,$(dir $2.tmp))
ohair@425	611	$9 $$($2_REMOTE) $$($2_DEPS) $$($2_PUBAPI) $$($2_NATIVEAPI) $(10) -implicit:none -sourcepath "$$($2_SRCROOTSC)" -d $4 @$2.tmp
ohair@425	612	$(ECHO) $$($2_PACKAGE_BDIR)*.class | $(GREP) -v \*.class | $(TR) ' ' '\n' > $$($2_PACKAGE_BDIR)_the.package.now
ohair@425	613	($(GREP) -xvf $$($2_PACKAGE_BDIR)_the.package.now $$($2_PACKAGE_BDIR)_the.package.prev > $$($2_PACKAGE_BDIR)_the.package.deleted;true)
ohair@425	614	$(ECHO) $1_CLASSES += `$(CAT) $$($2_PACKAGE_BDIR)_the.package.now` | \
ohair@425	615	$(SED) 's/\$$$$/\$$$$\$$$$/g' > $$($2_PACKAGE_BDIR)_the.package.d
ohair@425	616	$(ECHO) $1_JAVAS += $$($2_PACKAGE_SRCS) >> $$($2_PACKAGE_BDIR)_the.package.d
ohair@425	617	$(ECHO) $2_NOTIFIED:=true > $$($2_PACKAGE_BDIR)_the.package.notify
ohair@425	618	$$($2_APPEND_DEPS)
ohair@425	619	$$($2_COPY_FILES)
ohair@425	620	$(MV) -f $2.tmp $2
ohair@425	621	endef
ohair@425	622
ohair@425	623	define remove_string
ohair@425	624	$2 := $$(subst $1,,$$($2))
ohair@425	625	endef
ohair@425	626
ohair@425	627	define replace_space_with_pathsep
ohair@425	628	$1:=$(subst $(SPACE),$(PATH_SEP),$(strip $(patsubst %,%,$2)))
ohair@425	629	endef
ohair@425	630
ohair@425	631	define SetupJavaCompilation
ohair@425	632	# param 1 is for example BUILD_MYPACKAGE
ohair@425	633	# param 2,3,4,5,6,7,8 are named args.
ohair@425	634	# SETUP:=must point to a previously setup java compiler, for example: SETUP:=BOOTJAVAC
ohair@425	635	# JVM:=path to ..bin/java
ohair@425	636	# ADD_JAVAC_FLAGS:=javac flags to append to the default ones.
ohair@425	637	# SRC:=one or more directories to search for sources
ohair@425	638	# BIN:=store classes here
ohair@425	639	# INCLUDES:=myapp.foo means will only compile java files in myapp.foo or any of its sub-packages.
ohair@425	640	# EXCLUDES:=myapp.foo means will do not compile java files in myapp.foo or any of its sub-packages.
ohair@425	641	# COPY:=.prp means copy all prp files to the corresponding package in BIN.
ohair@425	642	# CLEAN:=.properties means copy and clean all properties file to the corresponding package in BIN.
ohair@425	643	# COPY_FILES:=myapp/foo/setting.txt means copy this file over to the package myapp/foo
ohair@425	644	# SRCZIP:=Create a src.zip based on the found sources and copied files.
ohair@425	645	# INCLUDE_FILES:="com/sun/SolarisFoobar.java" means only compile this file!
ohair@425	646	# EXCLUDE_FILES:="com/sun/SolarisFoobar.java" means do not compile this particular file!
ohair@425	647	# "SolarisFoobar.java" means do not compile SolarisFoobar, wherever it is found.
ohair@425	648	# JAVAC_SOURCE_PATH_UGLY_OVERRIDE:=Don't use this. This forces an explicit -sourcepath to javac.
ohair@425	649	# Its only here until we cleanup some nasty source code pasta in the jdk.
ohair@425	650	# HEADERS:=path to directory where all generated c-headers are written.
erikj@445	651	# DEPENDS:=Extra dependecy
ohair@425	652	$(if $2,$1_$(strip $2))
ohair@425	653	$(if $3,$1_$(strip $3))
ohair@425	654	$(if $4,$1_$(strip $4))
ohair@425	655	$(if $5,$1_$(strip $5))
ohair@425	656	$(if $6,$1_$(strip $6))
ohair@425	657	$(if $7,$1_$(strip $7))
ohair@425	658	$(if $8,$1_$(strip $8))
ohair@425	659	$(if $9,$1_$(strip $9))
ohair@425	660	$(if $(10),$1_$(strip $(10)))
ohair@425	661	$(if $(11),$1_$(strip $(11)))
ohair@425	662	$(if $(12),$1_$(strip $(12)))
ohair@425	663	$(if $(13),$1_$(strip $(13)))
ohair@425	664	$(if $(14),$1_$(strip $(14)))
erikj@458	665	$(if $(15),$(error Internal makefile error: Too many arguments to SetupJavaCompilation, please update JavaCompilation.gmk))
ohair@425	666
ohair@425	667	# Extract the info from the java compiler setup.
ohair@425	668	$1_MODE := $$($$($1_SETUP)_MODE)
ohair@425	669	ifneq (SINGLE_THREADED_BATCH,$$($1_MODE))
ohair@425	670	ifneq (MULTI_CORE_CONCURRENT,$$($1_MODE))
ohair@425	671	$$(error The Java compilation $1 refers to a non-existant java compiler setup $$($1_SETUP))
ohair@425	672	endif
ohair@425	673	endif
ohair@425	674	$1_USE_DEPS := $$($$($1_SETUP)_USE_DEPS)
ohair@425	675	$1_REMOTE := $$($$($1_SETUP)_REMOTE)
ohair@425	676	$1_JVM := $$($$($1_SETUP)_JVM)
ohair@425	677	$1_JAVAC := $$($$($1_SETUP)_JAVAC)
ohair@425	678	$1_JAVAH := $$($$($1_SETUP)_JAVAH)
ohair@425	679	$1_FLAGS := $$($$($1_SETUP)_FLAGS) $(JAVAC_FLAGS) $$($1_ADD_JAVAC_FLAGS)
ohair@425	680
ohair@425	681	# Handle addons and overrides.
ohair@425	682	$1_SRC:=$$(call ADD_SRCS,$$($1_SRC))
ohair@425	683	# Make sure the dirs exist.
ohair@425	684	$$(shell $(MKDIR) -p $$($1_SRC) $$($1_BIN))
ohair@425	685	# Find all files in the source trees.
ohair@425	686	$1_ALL_SRCS := $$(filter-out $(OVR_SRCS),$$(foreach i,$$($1_SRC),$$(shell $(FIND) $$i -type f)))
ohair@425	687	# Extract the java files.
ohair@425	688	ifneq ($$($1_EXCLUDE_FILES),)
ohair@425	689	$1_EXCLUDE_FILES_PATTERN:=$$(addprefix %,$$($1_EXCLUDE_FILES))
ohair@425	690	endif
ohair@425	691	$1_SRCS := $$(filter-out $$($1_EXCLUDE_FILES_PATTERN),$$(filter %.java,$$($1_ALL_SRCS)))
ohair@425	692	ifneq ($$($1_INCLUDE_FILES),)
ohair@425	693	$1_INCLUDE_FILES:=$$(foreach i,$$($1_SRC),$$(addprefix $$i/,$$($1_INCLUDE_FILES)))
ohair@425	694	$1_SRCS := $$(filter $$($1_INCLUDE_FILES), $$($1_SRCS))
ohair@425	695	endif
ohair@425	696	$1_PKGS := $$(sort $$(dir $$($1_SRCS)))
ohair@425	697	# Remove the source root from each found path.
ohair@425	698	$$(foreach i,$$($1_SRC),$$(eval $$(call remove_string,$$i,$1_PKGS)))
ohair@425	699	$1_PKGS := $$(sort $$($1_PKGS))
ohair@425	700	# There can be only a single bin dir root, no need to foreach over the roots.
ohair@425	701	$1_BINS := $$(shell $(FIND) $$($1_BIN) -name "*.class")
ohair@425	702
ohair@425	703	# Now we have a list of all java files to compile: $$($1_SRCS)
ohair@425	704	# and we have a list of all existing class files: $$($1_BINS)
ohair@425	705
erikj@458	706	# Create the corresponding smart javac wrapper command line.
erikj@458	707	$1_SJAVAC_ARGS:=$$(addprefix -x ,$$(addsuffix .*,$$(subst /,.,$$($1_EXCLUDES)))) \
erikj@458	708	$$(addprefix -i ,$$(addsuffix .*,$$(subst /,.,$$($1_INCLUDES)))) \
erikj@458	709	$$(addprefix -xf *,$$(strip $$($1_EXCLUDE_FILES))) \
erikj@458	710	$$(addprefix -if *,$$(strip $$($1_INCLUDE_FILES))) -src $$(subst $$(SPACE),$$(PATH_SEP),$$(strip $$($1_SRC)))
erikj@458	711
ohair@425	712	# Prepend the source/bin path to the filter expressions.
ohair@425	713	ifneq ($$($1_INCLUDES),)
ohair@425	714	$1_SRC_INCLUDES := $$(foreach i,$$($1_SRC),$$(addprefix $$i/,$$(addsuffix /%,$$($1_INCLUDES))))
ohair@425	715	$1_PKG_INCLUDES := $$(addprefix /,$$(addsuffix /%,$$($1_INCLUDES)))
ohair@425	716	$1_BIN_INCLUDES := $$(addprefix $$($1_BIN)/,$$(addsuffix /%,$$($1_INCLUDES)))
ohair@425	717	$1_SRCS := $$(filter $$($1_SRC_INCLUDES),$$($1_SRCS))
ohair@425	718	$1_PKGS := $$(filter $$($1_PKG_INCLUDES),$$($1_PKGS))
ohair@425	719	$1_BINS := $$(filter $$($1_BIN_INCLUDES),$$($1_BINS))
ohair@425	720	endif
ohair@425	721	ifneq ($$($1_EXCLUDES),)
ohair@425	722	$1_SRC_EXCLUDES := $$(foreach i,$$($1_SRC),$$(addprefix $$i/,$$(addsuffix /%,$$($1_EXCLUDES))))
ohair@425	723	$1_PKG_EXCLUDES := $$(addprefix /,$$(addsuffix /%,$$($1_EXCLUDES)))
ohair@425	724	$1_BIN_EXCLUDES := $$(addprefix $$($1_BIN)/,$$(addsuffix /%,$$($1_EXCLUDES)))
ohair@425	725	$1_SRCS := $$(filter-out $$($1_SRC_EXCLUDES),$$($1_SRCS))
ohair@425	726	$1_PKGS := $$(filter-out $$($1_PKG_EXCLUDES),$$($1_PKGS))
ohair@425	727	$1_BINS := $$(filter-out $$($1_BIN_EXCLUDES),$$($1_BINS))
ohair@425	728	endif
ohair@425	729
ohair@425	730	# Find all files to be copied from source to bin.
ohair@425	731	ifneq (,$$($1_COPY))
ohair@425	732	# Rewrite list of patterns into a find statement.
ohair@425	733	$1_COPY_PATTERN:=$(FALSE_FIND_PATTERN) $$(patsubst %,$(SPACE)-o$(SPACE)-name$(SPACE)$(DQUOTE)*%$(DQUOTE),$$($1_COPY))
ohair@425	734	# Search for all files to be copied.
ohair@425	735	$1_ALL_COPIES := $$(foreach i,$$($1_SRC), $$(shell $(FIND) $$i \( $$($1_COPY_PATTERN) \) -a -type f))
ohair@425	736	# Copy these explicitly
ohair@425	737	$1_ALL_COPIES += $$($1_COPY_FILES)
ohair@425	738	# Copy must also respect filters.
ohair@425	739	ifneq (,$$($1_INCLUDES))
ohair@425	740	$1_ALL_COPIES := $$(filter $$($1_SRC_INCLUDES),$$($1_ALL_COPIES))
ohair@425	741	endif
ohair@425	742	ifneq (,$$($1_EXCLUDES))
ohair@425	743	$1_ALL_COPIES := $$(filter-out $$($1_SRC_EXCLUDES),$$($1_ALL_COPIES))
ohair@425	744	endif
ohair@425	745	ifneq (,$$($1_EXCLUDE_FILES))
ohair@425	746	$1_ALL_COPIES := $$(filter-out $$($1_EXCLUDE_FILES_PATTERN),$$($1_ALL_COPIES))
ohair@425	747	endif
ohair@425	748	# All files below META-INF are always copied.
ohair@425	749	$1_ALL_COPIES += $$(foreach i,$$($1_SRC), $$(shell $(FIND) $$i/META-INF -type f 2> /dev/null))
ohair@425	750	ifneq (,$$($1_ALL_COPIES))
ohair@425	751	# Yep, there are files to be copied!
ohair@425	752	$1_ALL_COPY_TARGETS:=
ohair@425	753	$$(foreach i,$$($1_ALL_COPIES),$$(eval $$(call add_file_to_copy,$1,$$i)))
ohair@425	754	# Now we can depend on $$($1_ALL_COPY_TARGETS) to copy all files!
ohair@425	755	endif
ohair@425	756	endif
ohair@425	757
ohair@425	758	# Find all property files to be copied and cleaned from source to bin.
ohair@425	759	ifneq (,$$($1_CLEAN))
ohair@425	760	# Rewrite list of patterns into a find statement.
ohair@425	761	$1_CLEAN_PATTERN:=$(FALSE_FIND_PATTERN) $$(patsubst %,$(SPACE)-o$(SPACE)-name$(SPACE)$(DQUOTE)*%$(DQUOTE),$$($1_CLEAN))
ohair@425	762	# Search for all files to be copied.
ohair@425	763	$1_ALL_CLEANS := $$(foreach i,$$($1_SRC), $$(shell $(FIND) $$i \( $$($1_CLEAN_PATTERN) \) -a -type f))
ohair@425	764	# Copy and clean must also respect filters.
ohair@425	765	ifneq (,$$($1_INCLUDES))
ohair@425	766	$1_ALL_CLEANS := $$(filter $$($1_SRC_INCLUDES),$$($1_ALL_CLEANS))
ohair@425	767	endif
ohair@425	768	ifneq (,$$($1_EXCLUDES))
ohair@425	769	$1_ALL_CLEANS := $$(filter-out $$($1_SRC_EXCLUDES),$$($1_ALL_CLEANS))
ohair@425	770	endif
ohair@425	771	ifneq (,$$($1_EXCLUDE_FILES))
ohair@425	772	$1_ALL_CLEANS := $$(filter-out $$($1_EXCLUDE_FILES_PATTERN),$$($1_ALL_CLEANS))
ohair@425	773	endif
ohair@425	774	ifneq (,$$($1_ALL_CLEANS))
ohair@425	775	# Yep, there are files to be copied and cleaned!
ohair@425	776	$1_ALL_COPY_CLEAN_TARGETS:=
ohair@425	777	$$(foreach i,$$($1_ALL_CLEANS),$$(eval $$(call add_file_to_copy_and_clean,$1,$$i)))
ohair@425	778	# Now we can depend on $$($1_ALL_COPY_CLEAN_TARGETS) to copy all files!
ohair@425	779	endif
ohair@425	780	endif
ohair@425	781
ohair@425	782	# Find all the directories that contain java sources, each directory
ohair@425	783	# corresponds to a package because we expect the source
ohair@425	784	# code to be organized in this standardized way!
ohair@425	785	$1_SDIRS := $$(sort $$(dir $$($1_SRCS)))
ohair@425	786	# Now prefix each package with the bin root.
ohair@425	787	$1_BDIRS := $$(foreach i,$$($1_PKGS),$$(addprefix $$($1_BIN),$$i))
ohair@425	788	# Now create a list of the packages that are about to compile. This list is
ohair@425	789	# later used to filter out dependencies that point outside of this set.
ohair@425	790	$$(shell $(RM) $$($1_BIN)/_the.list_of_packages)
ohair@425	791	$$(eval $$(call ListPathsSafelyNow,$1_BDIRS,\n, >> $$($1_BIN)/_the.list_of_packages))
ohair@425	792
ohair@425	793	ifeq ($$($1_MODE),SINGLE_THREADED_BATCH)
ohair@425	794	# Ok, we will feed all the found java files into a single javac invocation.
ohair@425	795	# There can be no dependency checking, nor incremental builds. It is
ohair@425	796	# the best we can do with the old javac. If the javac supports a javac server
ohair@425	797	# then we can use the javac server.
ohair@425	798
ohair@425	799	# We can depend on this target file to trigger a regeneration of all the sources
ohair@425	800	$1 := $$($1_ALL_COPY_TARGETS) $$($1_ALL_COPY_CLEAN_TARGETS) $$($1_BIN)/_the.batch
ohair@425	801
ohair@425	802	# Prep the source paths.
ohair@425	803	ifneq ($$($1_JAVAC_SOURCE_PATH_UGLY_OVERRIDE),)
ohair@425	804	$$(eval $$(call replace_space_with_pathsep,$1_SRCROOTSC,$$($1_JAVAC_SOURCE_PATH_UGLY_OVERRIDE)))
ohair@425	805	else
ohair@425	806	$$(eval $$(call replace_space_with_pathsep,$1_SRCROOTSC,$$($1_SRC)))
ohair@425	807	endif
ohair@425	808
erikj@445	809	ifneq (,$$($1_HEADERS))
erikj@445	810	$1_HEADERS_ARG := -h $$($1_HEADERS)
erikj@445	811	endif
erikj@445	812
ohair@425	813	# Create a sed expression to remove the source roots and to replace / with .
ohair@425	814	# and remove .java at the end.
ohair@425	815	$1_REWRITE_INTO_CLASSES:=$$(foreach i,$$($1_SRC),-e 's|$$i/||g') -e 's|/|.|g' -e 's|.java$$$$||g'
ohair@425	816
ohair@425	817	# Here is the batch rules that depends on all the sources.
erikj@445	818	$$($1_BIN)/_the.batch: $$($1_SRCS) $$($1_DEPENDS)
ohair@425	819	$(MKDIR) -p $$(@D)
ohair@425	820	$(RM) $$($1_BIN)/_the.batch $$($1_BIN)/_the.batch.tmp
ohair@425	821	$$(call ListPathsSafely,$1_SRCS,\n, >> $$($1_BIN)/_the.batch.tmp)
ohair@425	822	$(ECHO) Compiling `$(WC) $$($1_BIN)/_the.batch.tmp | $(TR) -s ' ' | $(CUT) -f 2 -d ' '` files in batch $1
erikj@458	823	ifeq ($$($1_NOSJAVAC),)
erikj@458	824	ifeq ($$(ENABLE_SJAVAC),yes)
erikj@458	825	mkdir -p $$($1_BIN)_sjavac
erikj@458	826	$$($1_JVM) $$(word 1,$$($1_JAVAC)) com.sun.tools.javac.smart.Main $$($1_SJAVAC_ARGS) -mfl $$($1_BIN)/_the.batch.tmp -d $$($1_BIN)_sjavac
erikj@458	827	endif
erikj@458	828	endif
erikj@445	829	($$($1_JVM) $$($1_JAVAC) $$($1_FLAGS) -implicit:none -sourcepath "$$($1_SRCROOTSC)" -d $$($1_BIN) $$($1_HEADERS_ARG) @$$($1_BIN)/_the.batch.tmp && \
ohair@425	830	$(MV) $$($1_BIN)/_the.batch.tmp $$($1_BIN)/_the.batch)
ohair@425	831	else
ohair@425	832	# Ok, we have a modern javac server running!
ohair@425	833	# Since a single Java file can generate zero to an infinity number of .class files
ohair@425	834	# the exact number and names of the .class files will only be known after the compile.
ohair@425	835	# Thus after the compile, a list of the generated classes will be stored in _the.package.d
ohair@425	836	# which is included by the makefile during the next compile. These .d files will
ohair@425	837	# add the generated class names to the BUILD_MYPACKAGE_CLASSES variable and used java file names
ohair@425	838	# to the BUILD_MYPACKAGE_JAVAS variable.
ohair@425	839	$1_CLASSES :=
ohair@425	840	$1_JAVAS :=
ohair@425	841	# Create a file in each package that represents the package dependency.
ohair@425	842	# This file (_the.package) will also contain a list of the source files
ohair@425	843	# to be compiled for this package.
ohair@425	844	$1 := $$(sort $$(patsubst %,%_the.package,$$($1_BDIRS)))
ohair@425	845	# Now call add_java_package for each package to create the dependencies.
ohair@425	846	$$(foreach p,$$($1),$$(eval $$(call add_java_package,$1,$$p,$$($1_SRC),$$($1_BIN),$$($1_BIN)/_the.list_of_packages,NOTUSED,$$($1_USE_DEPS),$$($1_REMOTE),$$($1_JVM) $$($1_JAVAC),$$($1_FLAGS),$$($1_EXCLUDE_FILES_PATTERN) $(OVR_SRCS),$$($1_INCLUDE_FILES),$$($1_JVM) $$($1_JAVAH),$$($1_JAVAC_SOURCE_PATH_UGLY_OVERRIDE))))
ohair@425	847	# All dependencies are setup, now we only need to depend on $1 (aka $(BUILD_MYPACKAGE))
ohair@425	848	# and they will automatically be built!
ohair@425	849
ohair@425	850	# Now add on any files to copy targets
ohair@425	851	$1 := $$($1_ALL_COPY_TARGETS) $$($1_ALL_COPY_CLEAN_TARGETS) $$($1)
ohair@425	852	# Remove the set of found classes from the set of all previously known classes
ohair@425	853	# and the remainder is the set of missing classes.
ohair@425	854	$1_MISSING_CLASSES:=$$(filter-out $$($1_BINS),$$($1_CLASSES))
ohair@425	855	$1_PKGS_MISSING_CLASSES:=$$(sort $$(dir $$($1_MISSING_CLASSES)))
ohair@425	856	# Remove the set of found java files from the set of all previously known java files
ohair@425	857	# the remainder is Java files that have gone missing.
ohair@425	858	$1_MISSING_JAVAS:=$$(filter-out $$($1_SRCS),$$($1_JAVAS))
ohair@425	859	$1_PKGS_MISSING_JAVAS:=$$(sort $$(dir $$($1_MISSING_JAVAS)))
ohair@425	860	# Remove each source root from the found paths.
ohair@425	861	$$(foreach i,$$($1_SRC),$$(eval $$(call remove_string,$$i,$1_PKGS_MISSING_JAVAS)))
ohair@425	862	# Finally remove duplicates and prefix with the binary path instead.
ohair@425	863	$1_PKGS_MISSING_JAVAS:= $$(addprefix $$($1_BIN),$$(sort $$($1_PKGS_MISSING_JAVAS)))
ohair@425	864
ohair@425	865	# Remove the set of all theoretical classes from the set of found classes.
ohair@425	866	# the remainder is the set of superfluous classes.
ohair@425	867	$1_SUPERFLUOUS_CLASSES:=$$(sort $$(filter-out $$($1_CLASSES),$$($1_BINS)))
ohair@425	868	$1_PKGS_SUPERFLUOUS_CLASSES:=$$(sort $$(dir $$($1_SUPERFLUOUS_CLASSES)))
ohair@425	869
ohair@425	870	# Now delete the _the.package files inside the problematic dirs.
ohair@425	871	# This will force a rebuild of these packages!
ohair@425	872	$1_FOO:=$$(sort $$($1_PKGS_MISSING_CLASSES) \
ohair@425	873	$$($1_PKGS_SUPERFLUOUS_CLASSES) \
ohair@425	874	$$($1_PKGS_MISSING_JAVAS))
ohair@425	875	# ifneq (,$$($1_FOO))
ohair@425	876	# $$(info MESSED UP PACKAGES $$($1_FOO))
ohair@425	877	# endif
ohair@425	878
ohair@425	879	$$(shell $(RM) $$(addsuffix _the.package,$$(sort $$($1_PKGS_MISSING_CLASSES) \
ohair@425	880	$$($1_PKGS_SUPERFLUOUS_CLASSES) \
ohair@425	881	$$($1_PKGS_MISSING_JAVAS))))
ohair@425	882
ohair@425	883	# Normal makefile dependencies based on timestamps will detect the normal use case
ohair@425	884	# when Java files are simply added or modified.
ohair@425	885	endif
ohair@425	886
ohair@425	887	ifneq (,$$($1_JAR))
ohair@425	888
ohair@425	889	ifeq (,$$($1_SUFFIXES))
ohair@425	890	$1_SUFFIXES:=.class $$($1_CLEAN) $$($1_COPY)
ohair@425	891	endif
ohair@425	892
ohair@425	893	# A jar file was specified. Set it up.
ohair@425	894	$$(eval $$(call SetupArchive,ARCHIVE_$1,$$($1),\
ohair@425	895	SRCS:=$$($1_BIN),\
ohair@425	896	SUFFIXES:=$$($1_SUFFIXES),\
ohair@425	897	EXCLUDE:=$$($1_EXCLUDES),\
ohair@425	898	INCLUDES:=$$($1_INCLUDES),\
ohair@425	899	EXTRA_FILES:=$$($1_ALL_COPY_TARGETS) $$($1_ALL_COPY_CLEAN_TARGETS),\
ohair@425	900	JAR:=$$($1_JAR),\
ohair@425	901	JARMAIN:=$$($1_JARMAIN),\
ohair@425	902	MANIFEST:=$$($1_MANIFEST),\
ohair@425	903	EXTRA_MANIFEST_ATTR:=$$($1_EXTRA_MANIFEST_ATTR),\
erikj@445	904	JARINDEX:=$$($1_JARINDEX),\
ohair@425	905	HEADERS:=$$($1_HEADERS),\
ohair@425	906	SETUP:=$$($1_SETUP)))
ohair@425	907	endif
ohair@425	908
ohair@425	909	ifneq (,$$($1_SRCZIP))
ohair@425	910	# A srczip file was specified. Set it up.
ohair@425	911	$$(eval $$(call SetupZipArchive,ARCHIVE_$1,\
ohair@425	912	SRC:=$$($1_SRC),\
ohair@425	913	ZIP:=$$($1_SRCZIP),\
ohair@425	914	INCLUDES:=$$($1_INCLUDES),\
ohair@425	915	EXCLUDES:=$$($1_EXCLUDES),\
ohair@425	916	EXCLUDE_FILES:=$$($1_EXCLUDE_FILES)))
ohair@425	917	endif
ohair@425	918
ohair@425	919	endef