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

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

mercurial