#

# Copyright (c) 2011, 2012, Oracle and/or its affiliates. All rights reserved.

# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

#

# This code is free software; you can redistribute it and/or modify it

# under the terms of the GNU General Public License version 2 only, as

# published by the Free Software Foundation.  Oracle designates this

# particular file as subject to the "Classpath" exception as provided

# by Oracle in the LICENSE file that accompanied this code.

#

# This code is distributed in the hope that it will be useful, but WITHOUT

# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

# version 2 for more details (a copy is included in the LICENSE file that

# accompanied this code).

#

# You should have received a copy of the GNU General Public License version

# 2 along with this work; if not, write to the Free Software Foundation,

# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

#

# Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

# or visit www.oracle.com if you need additional information or have any

# questions.

#

# The complexity of this makefile is not the fault of make, but the fault

# of javac and javah. The basic problems are:

#

#    1) Compiling a single Java source file unpredictably generates anything

#       between zero (0!) and an infinite number of .class files!

#    2) There is no hint, for which classes javah needs to be run,

#       and it happily generates .h files for classes with no native methods.

#    3) javac and javah do not cleanup anything, for example if an internal

#       class (potentially with native methods) is removed from a Java source file.

#

# This makefile is a tribute to GNU make. And yes, it was harder to write than it is

# to read. The include/excludes of directories and files are only a temporary measure

# to work around the messy jdk sources that put platform specific code in src/share/classes.

#

# We should move most of the functionality of this makefile into a

# smart javac/javah/javadoc/jar combo tool. sjavac ?

#

# I.e. 1) It always generates a single output, a zip-file from a number of source roots.

#         The zip file contains information that enable incremental builds with full 

#         dependency tracking between packages.

#      2) It automatically generates the right .h files.

#      3) It keeps its house clean.

#      *) Generates intermediate files to be used for javadoc generation later.

#      and does all the other useful things that this makefile does, such as:

#          use all cores for compilation, reuse the running JVM for all compilations,

#          and has pubapi dependency tracking to minimize the number of files

#          that need to be recompiled during an incremental build.

# 

# A zip file, or several zip files combined, can then be converted to a .jar file, or to a .jmod file.

#

# This would make this makefile much much simpler. I.e. make can be used

# for its real purpose, track dependencies and trigger a recompile if a

# dependency has changed.

#

# When you read this source. Remember that $(sort ...) has the side effect

# of removing duplicates. It is actually this side effect that is

# desired whenever sort is used below!

ifeq  (,$(_MAKEBASE_GMK))

    $(error You must include MakeBase.gmk prior to including JavaCompilation.gmk)

endif

FALSE_FIND_PATTERN:=-name FILE_NAME_THAT_DOESNT_EXIST

# If compilation of java package fails, then the public api file for that

# package will not be genereated. We add this fallback rule to generate

# an empty pubapi file. 

%.api:

	if test ! -f $@; then $(MKDIR) -p $(@D); $(TOUCH) $@; fi

define SetupJavaCompiler

    # param 1 is for example BOOT_JAVAC or NEW_JAVAC

    # This is the name later used to decide which java compiler to use.

    # param 2-9 are named args.

    #   JVM:=The jvm used to run the javac/javah command

    #   JAVAC:=The javac jar and bootstrap classpath changes, or just bin/javac if JVM is left out

    #   JAVAH:=The javah jar and bootstrap classpath changes, or just bin/javah if JVM is left out

    #   FLAGS:=Flags to be supplied to javac

    #   MODE:=SINGLE_THREADED_BATCH (primarily for old javac) or MULTI_CORE_CONCURRENT

    #      only for MULTI_CORE_CONCURRENT are the options below relevant:

    #   SERVER_DIR:=Use a javac server (-XDserver) and store the server related files here

    #   SERVER_JVM:=Use this JVM for the server. Defaults to the JVM above.

    #   USE_DEPS:=true means use -XDdeps,-XDpubapi and -XDnativeapi to track java dependencies

    $(if $2,$1_$(strip $2))

    $(if $3,$1_$(strip $3))

    $(if $4,$1_$(strip $4))

    $(if $5,$1_$(strip $5))

    $(if $6,$1_$(strip $6))

    $(if $7,$1_$(strip $7))

    $(if $8,$1_$(strip $8))

    $(if $9,$1_$(strip $9))

    ifeq ($$($1_MODE),MULTI_CORE_CONCURRENT)

	ifneq (,$$($1_SERVER_DIR))

            # A javac server has been requested.

            # The port file contains the tcp/ip on which the server listens

            # and the cookie necessary to talk to the server.

            $1_JAVAC_PORTFILE:=$$($1_SERVER_DIR)/$1.port

            ifeq ($$($1_SERVER_JVM),)

                # You can use a different JVM to run the background javac server.

                # But if not set, it defaults to the same JVM that is used to start

                # the javac command.

                $1_SERVER_JVM:=$$($1_JVM)

            endif

            # Set the $1_REMOTE to spawn a background javac server.

	    $1_REMOTE:=-XDserver:portfile=$$($1_JAVAC_PORTFILE),poolsize=$(JAVAC_SERVER_CORES),javac=$$(subst $$(SPACE),%20,$$(subst $$(COMMA),%2C,$$(strip $$($1_SERVER_JVM) $$($1_JAVAC))))

        endif

    endif

endef

define SetupArchive

    # param 1 is for example ARCHIVE_MYPACKAGE

    # param 2 are the dependecies

    # param 3,4,5,6,7,8,9 are named args.

    #    SRCS:=List of directories in where to find files to add to archive

    #    SUFFIXES:=File suffixes to include in jar

    #    INCLUDES:=List of directories/packages in SRCS that should be included

    #    EXCLUDES:=List of directories/packages in SRCS that should be excluded

    #    EXCLUDE_FILES:=List of files in SRCS that should be excluded

    #    EXTRA_FILES:=List of files in SRCS that should be included regardless of suffix match.

    #    JAR:=Jar file to create

    #    MANIFEST:=Optional manifest file template.

    #    JARMAIN:=Optional main class to add to manifest

    #    SKIP_METAINF:=Set to prevent contents of an META-INF directory to be automatically 

    #                  added to the archive.

    #    EXTRA_MANIFEST_ATTR:=Extra attribute to add to manifest.

    $(if $3,$1_$(strip $3))

    $(if $4,$1_$(strip $4))

    $(if $5,$1_$(strip $5))

    $(if $6,$1_$(strip $6))

    $(if $7,$1_$(strip $7))

    $(if $8,$1_$(strip $8))

    $(if $9,$1_$(strip $9))

    $(if $(10),$1_$(strip $(10)))

    $(if $(11),$1_$(strip $(11)))

    $(if $(12),$1_$(strip $(12)))

    $(if $(13),$1_$(strip $(13)))

    $(if $(14),$1_$(strip $(14)))

    $1_JARMAIN:=$(strip $$($1_JARMAIN))

    $1_JARNAME:=$$(notdir $$($1_JAR))

    $1_MANIFEST_FILE:=$$(dir $$($1_JAR))_the.$$($1_JARNAME)_manifest

    $1_DELETESS_FILE:=$$(dir $$($1_JAR))_the.$$($1_JARNAME)_deletess

    $1_DELETES_FILE:=$$(dir $$($1_JAR))_the.$$($1_JARNAME)_deletes

    $1_PUBAPI_NOTIFICATIONS_FILE:=$$(dir $$($1_JAR))_the.$$($1_JARNAME)_pubapi_notifications

    $1_NATIVEAPI_NOTIFICATIONS_FILE:=$$(dir $$($1_JAR))_the.$$($1_JARNAME)_native_notifications

    $1_NATIVEAPI_FILE:=$$(dir $$($1_JAR))_the.$$($1_JARNAME)_native

    $1_BIN:=$$(dir $$($1_JAR))

    ifeq (,$$($1_SUFFIXES))

        # No suffix was set, default to classes.

        $1_SUFFIXES:=.class

    endif

    # Convert suffixes to a find expression

    $1_FIND_PATTERNS:=$(FALSE_FIND_PATTERN) $$(patsubst %,$(SPACE)-o$(SPACE)-name$(SPACE)$(DQUOTE)*%$(DQUOTE),$$($1_SUFFIXES))

    ifneq (,$$($1_INCLUDES))

    endif

    ifneq (,$$($1_EXCLUDES)$$($1_EXCLUDE_FILES))

    endif

    # Utility macros, to make the shell script receipt somewhat easier to dechipher.

    # The capture contents macro finds all files (matching the patterns, typically

    # .class and .prp) that are newer than the jar-file, ie the new content to be put into the jar.

    $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) && )

    # The capture metainf macro finds all files below the META-INF directory that are newer than the jar-file.

    ifeq (,$$($1_SKIP_METAINF))

        $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 ) && )

    endif

    # The capture deletes macro finds all deleted files and concatenates them. The resulting file

    # tells us what to remove from the jar-file.

    $1_CAPTURE_DELETES=$$(foreach src,$$($1_SRCS),($(FIND) $$(src) -name _the.package.deleted -newer $$@ -exec $(SED) 's|$$(src)||g' \{\} >> $$($1_DELETES_FILE) \;) &&)

    # The capture pubapi notifications scans for pubapi change notifications. If such notifications are

    # found, then we will build the classes leading up to the jar again, to take into account the new timestamps

    # on the changed pubapi files.

    $1_CAPTURE_PUBAPI_NOTIFICATIONS=$$(foreach src,$$($1_SRCS),\

                    (cd $$(src) && \

                    $(FIND) . -name _the.package.api.notify -exec dirname \{\} \; >> $$($1_PUBAPI_NOTIFICATIONS_FILE) ; \

                    true) &&)

    # The update contents macro updates the jar file with the previously capture contents.

    $1_UPDATE_CONTENTS=$$(foreach src,$$($1_SRCS),\

                    (cd $$(src) && \

                     if [ -s _the.$$($1_JARNAME)_contents ]; then \

                         $(ECHO) "  updating" `$(WC) -l _the.$$($1_JARNAME)_contents | $(AWK) '{ print $$$$1 }'` files && \

                         $(JAR) uf $$@ @_the.$$($1_JARNAME)_contents; \

                     fi) &&)

    # The s-variants of the above macros are used when the jar is created from scratch.

    $1_SCAPTURE_CONTENTS=$$(foreach src,$$($1_SRCS),\

    ifeq (,$$($1_SKIP_METAINF))

        $1_SCAPTURE_METAINF=$$(foreach src,$$($1_SRCS),\

    endif

    $1_SUPDATE_CONTENTS=$$(foreach src,$$($1_SRCS),\

                    (cd $$(src) && $(JAR) uf $$@ @$$(src)/_the.$$($1_JARNAME)_contents) &&)

    # The TOUCH macro is used to make sure all timestamps are identical for package files and the pubapi files.

    # If we do not do this, we get random recompilations, the next time we run make, since the order of package building is random,

    # ie independent of package --dependes on-> public api of another package. This is of course

    # due to the fact that Java source often (always?) has circular dependencies. (Thus there is no correct order

    # to compile packages, and we can just as well do them in a random order. Which we do.)

    $1_TOUCH_API_FILES=$$(foreach src,$$($1_SRCS),\

                    ($(FIND) $$(src) -name _the.package.api -exec $(TOUCH) -r $$($1_JAR) \{\} \; ; true) && \

                    ($(FIND) $$(src) -name _the.package -exec $(TOUCH) -r $$($1_JAR) \{\} \; ; true) &&)

    # Use a slightly shorter name for logging, but with enough path to identify this jar.

    $1_NAME:=$$(subst $$(OUTPUT_ROOT)/,,$$($1_JAR))

    # Here is the rule that creates/updates the jar file.

	$(MKDIR) -p $$($1_BIN)

	if [ -n "$$($1_MANIFEST)" ]; then \

		$(SED) -e "s#@@RELEASE@@#$(RELEASE)#"           \

		       -e "s#@@COMPANY_NAME@@#$(COMPANY_NAME)#" $$($1_MANIFEST) > $$($1_MANIFEST_FILE); \

	else \

		$(RM) $$($1_MANIFEST_FILE) && $(TOUCH) $$($1_MANIFEST_FILE); \

	fi

	if [ -n "$$($1_EXTRA_MANIFEST_ATTR)" ]; then \

	fi

	+if [ -s $$@ ]; then \

		$(RM) -r $$($1_PUBAPI_NOTIFICATIONS_FILE) && \

		$$($1_CAPTURE_PUBAPI_NOTIFICATIONS) \

		if [ -s $$($1_PUBAPI_NOTIFICATIONS_FILE) ]; then \

			$(ECHO) Public api change detected in: && \

			$(CAT) $$($1_PUBAPI_NOTIFICATIONS_FILE) | $(TR) '/' '.' | $(SED) 's|^..||g' | $(SED) 's|\.$$$$||g' | $(AWK) '{print "  "$$$$1}' && \

			$$(foreach src,$$($1_SRCS),($(FIND) $$(src) -name _the.package.api.notify $(FIND_DELETE); true) &&) \

			$(MAKE) -f $(word 1,$(MAKEFILE_LIST)) $$($1_JAR) ; \

		else \

			$(ECHO) Modifying $$($1_NAME) && \

			$$($1_CAPTURE_CONTENTS) \

			$$($1_CAPTURE_METAINF) \

			$(RM) $$($1_DELETES_FILE) && \

			$$($1_CAPTURE_DELETES) \

			$(CAT) $$($1_DELETES_FILE) > $$($1_DELETESS_FILE) && \

			if [ -s $$($1_DELETESS_FILE) ]; then \

				$(ECHO) "  deleting" `$(WC) -l $$($1_DELETESS_FILE) | $(AWK) '{ print $$$$1 }'` files && \

	                        $(ZIP) -q -d $$@ `$(CAT) $$($1_DELETESS_FILE)` ; \

			fi && \

			$$($1_UPDATE_CONTENTS) true && \

			$$($1_TOUCH_API_FILES) true && \

			$$(foreach src,$$($1_SRCS),($(FIND) $$(src) -name _the.package.api.notify $(FIND_DELETE); true) &&) true ; \

		fi ; \

	else \

		$(ECHO) Creating $$($1_NAME) && $(JAR) cfm $$@ $$($1_MANIFEST_FILE) && \

	        $$($1_SCAPTURE_CONTENTS) \

		$$($1_SCAPTURE_METAINF) \

		$$($1_SUPDATE_CONTENTS) \

		$$($1_TOUCH_API_FILES) true && \

		$(RM) -r $$($1_NATIVEAPI_NOTIFICATIONS_FILE) $$($1_NATIVEAPI_FILE) && \

		$$(foreach src,$$($1_SRCS),($(FIND) $$(src) -name "*.notify" $(FIND_DELETE); true) &&) true ; \

	fi; 

endef

define append_to

    $(ECHO) "$1" >> $2

endef

define SetupZipArchive

    # param 1 is for example ZIP_MYSOURCE

    # param 2,3,4,5,6,7,8,9 are named args.

    $(if $2,$1_$(strip $2))

    $(if $3,$1_$(strip $3))

    $(if $4,$1_$(strip $4))

    $(if $5,$1_$(strip $5))

    $(if $6,$1_$(strip $6))

    $(if $7,$1_$(strip $7))

    $(if $8,$1_$(strip $8))

    $(if $9,$1_$(strip $9))

    # Find all files in the source tree.

    ifneq ($$($1_INCLUDES),)

        $1_SRC_INCLUDES := $$(foreach i,$$($1_SRC),$$(addprefix $$i/,$$(addsuffix /%,$$($1_INCLUDES))))

        $1_ALL_SRCS     := $$(filter $$($1_SRC_INCLUDES),$$($1_ALL_SRCS))

    endif

    ifneq ($$($1_EXCLUDES),)

        $1_SRC_EXCLUDES := $$(foreach i,$$($1_SRC),$$(addprefix $$i/,$$(addsuffix /%,$$($1_EXCLUDES))))

        $1_ZIP_EXCLUDES := $$(addprefix -x$(SPACE)$(DQUOTE),$$(addsuffix /*$(DQUOTE),$$($1_EXCLUDES)))

        $1_ALL_SRCS     := $$(filter-out $$($1_SRC_EXCLUDES),$$($1_SRCS))

    endif

    # Use a slightly shorter name for logging, but with enough path to identify this zip.

    $1_NAME:=$$(subst $$(OUTPUT_ROOT)/,,$$($1_ZIP))

    # Now $1_ALL_SRCS should contain all sources that are going to be put into the zip.

    # I.e. the zip -i and -x options should match the filtering done in the makefile.

    # Explicitly excluded files can be given with absolute path. The patsubst solution

    # isn't perfect but the likelyhood of an absolute path to match something in a src

    # dir is very small.

		$(MKDIR) -p $$(@D)

		$(ECHO) Updating $$($1_NAME)

		$$(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

		$(TOUCH) $$@

endef

define add_file_to_copy

    # param 1 = BUILD_MYPACKAGE

    # parma 2 = The source file to copy.

    $2_TARGET:=$2

    # Remove the source prefix. 

    $$(foreach i,$$($1_SRC),$$(eval $$(call remove_string,$$i,$2_TARGET)))

    # Now we can setup the depency that will trigger the copying.

    $$($1_BIN)$$($2_TARGET) : $2

	$(MKDIR) -p $$(@D)

	$(CP) $$< $$@

	$(CHMOD) -f ug+w $$@

    # And do not forget this target

    $1_ALL_COPY_TARGETS += $$($1_BIN)$$($2_TARGET)

endef

# This macro is used only for properties files that are to be

# copied over to the classes directory in cleaned form:

# Previously this was inconsistently done in different repositories.

# This is the new clean standard.

define add_file_to_copy_and_clean

    # param 1 = BUILD_MYPACKAGE

    # parma 2 = The source file to copy and clean.

    $2_TARGET:=$2

    # Remove the source prefix. 

    $$(foreach i,$$($1_SRC),$$(eval $$(call remove_string,$$i,$2_TARGET)))

    # Now we can setup the depency that will trigger the copying.

    $$($1_BIN)$$($2_TARGET) : $2

	$(MKDIR) -p $$(@D)

	$(ECHO) Cleaning $$($2_TARGET)

	$(CAT) $$< | $(SED) -e 's/\([^\\]\):/\1\\:/g' -e  's/\([^\\]\)=/\1\\=/g' -e 's/#.*/#/g' \

                   | $(SED) \

-e 's/\\u0020/\x20/g' \

-e 's/\\u003A/\x3A/g' \

-e 's/\\u006B/\x6B/g' \

-e 's/\\u0075/\x75/g' \

-e 's/\\u00A0/\xA0/g' \

-e 's/\\u00A3/\xA3/g' \

-e 's/\\u00B0/\xB0/g' \

-e 's/\\u00B7/\xB7/g' \

-e 's/\\u00BA/\xBA/g' \

-e 's/\\u00BF/\xBF/g' \

-e 's/\\u00C0/\xC0/g' \

-e 's/\\u00C1/\xC1/g' \

-e 's/\\u00C2/\xC2/g' \

-e 's/\\u00C4/\xC4/g' \

-e 's/\\u00C5/\xC5/g' \

-e 's/\\u00C8/\xC8/g' \

-e 's/\\u00C9/\xC9/g' \

-e 's/\\u00CA/\xCA/g' \

-e 's/\\u00CD/\xCD/g' \

-e 's/\\u00CE/\xCE/g' \

-e 's/\\u00D3/\xD3/g' \

-e 's/\\u00D4/\xD4/g' \

-e 's/\\u00D6/\xD6/g' \

-e 's/\\u00DA/\xDA/g' \

-e 's/\\u00DC/\xDC/g' \

-e 's/\\u00DD/\xDD/g' \

-e 's/\\u00DF/\xDF/g' \

-e 's/\\u00E0/\xE0/g' \

-e 's/\\u00E1/\xE1/g' \

-e 's/\\u00E2/\xE2/g' \

-e 's/\\u00E3/\xE3/g' \

-e 's/\\u00E4/\xE4/g' \

-e 's/\\u00E5/\xE5/g' \

-e 's/\\u00E6/\xE6/g' \

-e 's/\\u00E7/\xE7/g' \

-e 's/\\u00E8/\xE8/g' \

-e 's/\\u00E9/\xE9/g' \

-e 's/\\u00EA/\xEA/g' \

-e 's/\\u00EB/\xEB/g' \

-e 's/\\u00EC/\xEC/g' \

-e 's/\\u00ED/\xED/g' \

-e 's/\\u00EE/\xEE/g' \

-e 's/\\u00EF/\xEF/g' \

-e 's/\\u00F1/\xF1/g' \

-e 's/\\u00F2/\xF2/g' \

-e 's/\\u00F3/\xF3/g' \

-e 's/\\u00F4/\xF4/g' \

-e 's/\\u00F5/\xF5/g' \

-e 's/\\u00F6/\xF6/g' \

-e 's/\\u00F9/\xF9/g' \

-e 's/\\u00FA/\xFA/g' \

-e 's/\\u00FC/\xFC/g' \

-e 's/\\u0020/\x20/g' \

-e 's/\\u003f/\x3f/g' \

-e 's/\\u006f/\x6f/g' \

-e 's/\\u0075/\x75/g' \

-e 's/\\u00a0/\xa0/g' \

-e 's/\\u00a3/\xa3/g' \

-e 's/\\u00b0/\xb0/g' \

-e 's/\\u00ba/\xba/g' \

-e 's/\\u00bf/\xbf/g' \

-e 's/\\u00c1/\xc1/g' \

-e 's/\\u00c4/\xc4/g' \

-e 's/\\u00c5/\xc5/g' \

-e 's/\\u00c8/\xc8/g' \

-e 's/\\u00c9/\xc9/g' \

-e 's/\\u00ca/\xca/g' \

-e 's/\\u00cd/\xcd/g' \

-e 's/\\u00d6/\xd6/g' \

-e 's/\\u00dc/\xdc/g' \

-e 's/\\u00dd/\xdd/g' \

-e 's/\\u00df/\xdf/g' \

-e 's/\\u00e0/\xe0/g' \

-e 's/\\u00e1/\xe1/g' \

-e 's/\\u00e2/\xe2/g' \

-e 's/\\u00e3/\xe3/g' \

-e 's/\\u00e4/\xe4/g' \

-e 's/\\u00e5/\xe5/g' \

-e 's/\\u00e7/\xe7/g' \

-e 's/\\u00e8/\xe8/g' \

-e 's/\\u00e9/\xe9/g' \

-e 's/\\u00ea/\xea/g' \

-e 's/\\u00eb/\xeb/g' \

-e 's/\\u00ec/\xec/g' \

-e 's/\\u00ed/\xed/g' \

-e 's/\\u00ee/\xee/g' \

-e 's/\\u00ef/\xef/g' \

-e 's/\\u00f0/\xf0/g' \

-e 's/\\u00f1/\xf1/g' \

-e 's/\\u00f2/\xf2/g' \

-e 's/\\u00f3/\xf3/g' \

-e 's/\\u00f4/\xf4/g' \

-e 's/\\u00f5/\xf5/g' \

-e 's/\\u00f6/\xf6/g' \

-e 's/\\u00f7/\xf7/g' \

-e 's/\\u00f8/\xf8/g' \

-e 's/\\u00f9/\xf9/g' \

-e 's/\\u00fa/\xfa/g' \

-e 's/\\u00fc/\xfc/g' \

-e 's/\\u00ff/\xff/g' \

		   | $(SED) -e '/^#/d' -e '/^$$$$/d' \

		            -e :a -e '/\\$$$$/N; s/\\\n//; ta' \

			    -e 's/^[ \t]*//;s/[ \t]*$$$$//' \

	$(CHMOD) -f ug+w $$@

    # And do not forget this target

    $1_ALL_COPY_CLEAN_TARGETS += $$($1_BIN)$$($2_TARGET)

endef

define add_java_package

    # param 1 = BUILD_MYPACKAGE

    # param 2 = the package target file (_the.package)

    # param 3 = src roots, all of them, separated with space

    # param 4 = bin root

    # param 5 = include these dependecies

    # param 6 = not used

    # param 7 = if non-empty, then use -Xdeps and -Xpubapi

    # param 8 = xremote configuration, or empty.

    # param 9 = javac command

    # param 10 = javac flags

    # param 11 = exclude these files!

    # param 12 = only include these files!

    # param 13 = javah command

    # param 14 = override src roots to be passed into -sourcepath, ugly ugly ugly, do not use this!

    #            it is only here to workaround ugly things in the source code in the jdk that ought

    #            to be fixed instead!

    ifdef $2_USED_BY

        $$(error Attempting to add the package $2 from $3 which is already added with sources from $$($2_USED_BY))

    endif

    $2_USED_BY:=$3

    # Remove the _the.package file to get the target bin dir for the classes in this package.

    $2_PACKAGE_BDIR:=$(dir $2)

    # The source roots separated with a path separator (: or ; depending on os)

    # (The patsubst is necessary to trim away unnecessary spaces.)

    ifneq ($(14),)

      $2_SRCROOTSC:=$(subst $(SPACE),$(PATH_SEP),$(strip $(patsubst %,%,$(14))))

    else

      $2_SRCROOTSC:=$(subst $(SPACE),$(PATH_SEP),$(strip $(patsubst %,%,$3)))

    endif