JavaCompilation.gmk revision 1656:f2b50d16adc9
1# 2# Copyright (c) 2011, 2015, 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# 25 26# This makefile is much simpler now that it can use the smart javac wrapper 27# for dependency tracking between java packages and incremental compiles. 28# It could be even more simple if we added support for incremental jar updates 29# directly from the smart javac wrapper. 30 31# Cleaning/copying properties here is not a good solution. The properties 32# should be cleaned/copied by a annotation processor in sjavac. 33 34# When you read this source. Remember that $(sort ...) has the side effect 35# of removing duplicates. It is actually this side effect that is 36# desired whenever sort is used below! 37 38ifndef _JAVA_COMPILATION_GMK 39_JAVA_COMPILATION_GMK := 1 40 41ifeq (,$(_MAKEBASE_GMK)) 42 $(error You must include MakeBase.gmk prior to including JavaCompilation.gmk) 43endif 44 45# Java compilation needs SetupZipArchive if we're generating a source zip. 46include ZipArchive.gmk 47 48FALSE_FIND_PATTERN:=-name FILE_NAME_THAT_DOESNT_EXIST 49 50# Setup make rules for defining a Java compiler, which is needed to compile 51# Java code. This rule generates no output. 52# 53# Parameter 1 is the name of the compiler definition. This name needs to be 54# passed to SetupJavaCompilation. This name is used as variable prefix. 55# 56# Remaining parameters are named arguments. These include: 57# JVM:=The jvm used to run the javac/javah command 58# JAVAC:=The javac jar and bootstrap classpath changes, or just bin/javac if JVM is left out 59# FLAGS:=Flags to be supplied to javac 60# SERVER_DIR:=Use a javac server (-XDserver) and store the server related files here 61# SERVER_JVM:=Use this JVM for the server. Defaults to the JVM above. 62SetupJavaCompiler = $(NamedParamsMacroTemplate) 63define SetupJavaCompilerBody 64 # The port file contains the tcp/ip on which the server listens 65 # and the cookie necessary to talk to the server. 66 $1_SJAVAC_PORTFILE:=$$($1_SERVER_DIR)/server.port 67 # You can use a different JVM to run the background javac server. 68 ifeq ($$($1_SERVER_JVM),) 69 # It defaults to the same JVM that is used to start the javac command. 70 $1_SERVER_JVM:=$$($1_JVM) 71 endif 72endef 73 74# Setup make rules for creating a jar archive. 75# 76# Parameter 1 is the name of the rule. This name is used as variable prefix, 77# and the targets generated are listed in a variable by that name. 78# 79# Remaining parameters are named arguments. These include: 80# DEPENDENCIES:=List of dependencies for the jar target. If left empty, 81# dependencies are calculated automatically from the source files found. 82# For this to work, the source files must exist when the makefile is 83# parsed. 84# SRCS:=List of directories in where to find files to add to archive 85# SUFFIXES:=File suffixes to include in jar 86# INCLUDES:=List of directories/packages in SRCS that should be included 87# EXCLUDES:=List of directories/packages in SRCS that should be excluded 88# EXCLUDE_FILES:=List of files in SRCS that should be excluded 89# EXTRA_FILES:=List of files in SRCS that should be included regardless of suffix match. 90# JAR:=Jar file to create 91# MANIFEST:=Optional manifest file template. 92# JARMAIN:=Optional main class to add to manifest 93# JARINDEX:=true means generate the index in the jar file. 94# SKIP_METAINF:=Set to prevent contents of an META-INF directory to be automatically 95# added to the archive. 96# EXTRA_MANIFEST_ATTR:=Extra attribute to add to manifest. 97# CHECK_COMPRESS_JAR Check the COMPRESS_JAR variable 98SetupArchive = $(NamedParamsMacroTemplate) 99define SetupArchiveBody 100 101 $1_JARMAIN:=$(strip $$($1_JARMAIN)) 102 $1_JARNAME:=$$(notdir $$($1_JAR)) 103 $1_MANIFEST_FILE:=$$(dir $$($1_JAR))_the.$$($1_JARNAME)_manifest 104 $1_DELETESS_FILE:=$$(dir $$($1_JAR))_the.$$($1_JARNAME)_deletess 105 $1_DELETES_FILE:=$$(dir $$($1_JAR))_the.$$($1_JARNAME)_deletes 106 $1_BIN:=$$(dir $$($1_JAR)) 107 108 ifeq (,$$($1_SUFFIXES)) 109 # No suffix was set, default to classes. 110 $1_SUFFIXES:=.class 111 endif 112 # Convert suffixes to a find expression 113 $1_FIND_PATTERNS:=$(FALSE_FIND_PATTERN) $$(patsubst %,$(SPACE)-o$(SPACE)-name$(SPACE)$(DQUOTE)*%$(DQUOTE),$$($1_SUFFIXES)) 114 # On windows, a lot of includes/excludes risk making the command line too long, so 115 # writing the grep patterns to files. 116 # Grep returns 1 if nothing is matched. Do not fail the build for this. 117 ifneq (,$$($1_INCLUDES)) 118 $1_GREP_INCLUDE_PATTERNS:=$$(call EscapeDollar, \ 119 $$(foreach src,$$($1_SRCS), $$(addprefix $$(src)/,$$($1_INCLUDES)))) 120 # If there are a lot of include patterns, output to file to shorten command lines 121 ifeq ($$(word 20,$$($1_GREP_INCLUDE_PATTERNS)),) 122 $1_GREP_INCLUDES:=| ( $(GREP) $$(patsubst %,$(SPACE)-e$(SPACE)$(DQUOTE)%$(DQUOTE),$$($1_GREP_INCLUDE_PATTERNS)) \ 123 || test "$$$$?" = "1" ) 124 else 125 $1_GREP_INCLUDE_OUTPUT:=$(RM) $$($1_BIN)/_the.$$($1_JARNAME)_include $$(NEWLINE) \ 126 $$(call ListPathsSafely,$1_GREP_INCLUDE_PATTERNS,\n, \ 127 >> $$($1_BIN)/_the.$$($1_JARNAME)_include) 128 $1_GREP_INCLUDES:=| ( $(GREP) -f $$($1_BIN)/_the.$$($1_JARNAME)_include \ 129 || test "$$$$?" = "1" ) 130 endif 131 endif 132 ifneq (,$$($1_EXCLUDES)$$($1_EXCLUDE_FILES)) 133 $1_GREP_EXCLUDE_PATTERNS:=$$(call EscapeDollar, \ 134 $$(foreach src,$$($1_SRCS),$$(addprefix $$(src)/, \ 135 $$($1_EXCLUDES) $$($1_EXCLUDE_FILES)))) 136 # If there are a lot of include patterns, output to file to shorten command lines 137 ifeq ($$(word 20,$$($1_GREP_EXCLUDE_PATTERNS)),) 138 $1_GREP_EXCLUDES:=| ( $(GREP) -v $$(patsubst %,$(SPACE)-e$(SPACE)$(DQUOTE)%$(DQUOTE),$$($1_GREP_EXCLUDE_PATTERNS)) \ 139 || test "$$$$?" = "1" ) 140 else 141 $1_GREP_EXCLUDE_OUTPUT=$(RM) $$($1_BIN)/_the.$$($1_JARNAME)_exclude $$(NEWLINE) \ 142 $$(call ListPathsSafely,$1_GREP_EXCLUDE_PATTERNS,\n, \ 143 >> $$($1_BIN)/_the.$$($1_JARNAME)_exclude) 144 $1_GREP_EXCLUDES:=| ( $(GREP) -v -f $$($1_BIN)/_the.$$($1_JARNAME)_exclude \ 145 || test "$$$$?" = "1" ) 146 endif 147 endif 148 149 # Check if this jar needs to have its index generated. 150 ifneq (,$$($1_JARINDEX)) 151 $1_JARINDEX = (cd $$(dir $$@) && $(JAR) -i $$(notdir $$@)) 152 else 153 $1_JARINDEX = true 154 endif 155 # When this macro is run in the same makefile as the java compilation, dependencies are 156 # transfered in make variables. When the macro is run in a different makefile than the 157 # java compilation, the dependencies need to be found in the filesystem. 158 $1_ORIG_DEPS := $$($1_DEPENDENCIES) 159 ifeq ($$($1_DEPENDENCIES), ) 160 # Add all source roots to the find cache since we are likely going to run find 161 # on these more than once. The cache will only be updated if necessary. 162 $$(eval $$(call FillCacheFind, $$($1_FIND_LIST))) 163 $1_DEPENDENCIES:=$$(filter $$(addprefix %,$$($1_SUFFIXES)), \ 164 $$(call CacheFind,$$($1_SRCS))) 165 ifneq (,$$($1_GREP_INCLUDE_PATTERNS)) 166 $1_DEPENDENCIES:=$$(filter $$(addsuffix %,$$($1_GREP_INCLUDE_PATTERNS)),$$($1_DEPENDENCIES)) 167 endif 168 ifneq (,$$($1_GREP_EXCLUDE_PATTERNS)) 169 $1_DEPENDENCIES:=$$(filter-out $$(addsuffix %,$$($1_GREP_EXCLUDE_PATTERNS)),$$($1_DEPENDENCIES)) 170 endif 171 # Look for EXTRA_FILES in all SRCS dirs and as absolute paths. 172 $1_DEPENDENCIES+=$$(wildcard $$(foreach src, $$($1_SRCS), \ 173 $$(addprefix $$(src)/, $$($1_EXTRA_FILES))) $$($1_EXTRA_FILES)) 174 ifeq (,$$($1_SKIP_METAINF)) 175 $1_DEPENDENCIES+=$$(call CacheFind,$$(wildcard $$(addsuffix /META-INF,$$($1_SRCS)))) 176 endif 177 endif 178 # The dependency list should never be empty 179 ifeq ($$(strip $$($1_DEPENDENCIES)), ) 180 $$(warning No dependencies found for $1) 181 endif 182 183 # Utility macros, to make the shell script receipt somewhat easier to decipher. 184 185 # Capture extra files is the same for both CAPTURE_CONTENTS and SCAPTURE_CONTENTS so 186 # only define it once to avoid duplication. 187 # The list of extra files might be long, so need to use ListPathsSafely to print 188 # them out to a separte file. Then process the contents of that file to rewrite 189 # into -C <dir> <file> lines. 190 # The EXTRA_FILES_RESOLVED varible must be set in the macro so that it's evaluated 191 # in the recipe when the files are guaranteed to exist. 192 $1_CAPTURE_EXTRA_FILES=\ 193 $(RM) $$($1_BIN)/_the.$$($1_JARNAME)_contents.extra $$(NEWLINE) \ 194 $$(eval $1_EXTRA_FILES_RESOLVED:=$$(call DoubleDollar, $$(call DoubleDollar, \ 195 $$(wildcard $$(foreach src, $$($1_SRCS), \ 196 $$(addprefix $$(src)/, $$($1_EXTRA_FILES))) $$($1_EXTRA_FILES))))) \ 197 $$(if $$($1_EXTRA_FILES_RESOLVED), \ 198 $$(call ListPathsSafely,$1_EXTRA_FILES_RESOLVED,\n, \ 199 >> $$($1_BIN)/_the.$$($1_JARNAME)_contents.extra) $$(NEWLINE) \ 200 $(SED) $$(foreach src,$$($1_SRCS), -e 's|$$(src)/|-C $$(src) |g') \ 201 $$($1_BIN)/_the.$$($1_JARNAME)_contents.extra \ 202 >> $$($1_BIN)/_the.$$($1_JARNAME)_contents $$(NEWLINE)) 203 204 # The capture contents macro finds all files (matching the patterns, typically 205 # .class and .prp) that are newer than the jar-file, ie the new content to be put into the jar. 206 # NOTICE: please leave the parentheses space separated otherwise the AIX build will break! 207 $1_CAPTURE_CONTENTS=\ 208 $(RM) $$($1_BIN)/_the.$$($1_JARNAME)_contents $$(NEWLINE) \ 209 $$(foreach src,$$($1_SRCS), \ 210 $(FIND) $$(src) -type f -a \( $$($1_FIND_PATTERNS) \) -a -newer $$@ $$($1_GREP_INCLUDES) \ 211 $$($1_GREP_EXCLUDES) | $(SED) 's|$$(src)/|-C $$(src) |g' \ 212 >> $$($1_BIN)/_the.$$($1_JARNAME)_contents $$(NEWLINE)) \ 213 $$($1_CAPTURE_EXTRA_FILES) 214 215 # The capture metainf macro finds all files below the META-INF directory that are newer than the jar-file. 216 # Find returns non zero if the META-INF dir does not exist, ignore this. 217 ifeq (,$$($1_SKIP_METAINF)) 218 $1_CAPTURE_METAINF =$$(foreach src,$$($1_SRCS), \ 219 ( ( $(FIND) $$(src)/META-INF -type f -a -newer $$@ 2> /dev/null || true ) \ 220 | $(SED) 's|$$(src)/|-C $$(src) |g' >> \ 221 $$($1_BIN)/_the.$$($1_JARNAME)_contents ) $$(NEWLINE) ) 222 endif 223 # The capture deletes macro finds all deleted files and concatenates them. The resulting file 224 # tells us what to remove from the jar-file. 225 $1_CAPTURE_DELETES=$$(foreach src,$$($1_SRCS),($(FIND) $$(src) -name _the.package.deleted -newer $$@ \ 226 -exec $(SED) 's|$$(src)||g' \{\} >> $$($1_DELETES_FILE) \;) $$(NEWLINE)) 227 # The update contents macro updates the jar file with the previously capture contents. 228 # Use 'wc -w' to see if the contents file is empty. 229 $1_UPDATE_CONTENTS=\ 230 if [ "`$(WC) -l $$($1_BIN)/_the.$$($1_JARNAME)_contents | $(AWK) '{ print $$$$1 }'`" -gt "0" ]; then \ 231 $(ECHO) " updating" `$(WC) -l $$($1_BIN)/_the.$$($1_JARNAME)_contents | $(AWK) '{ print $$$$1 }'` files && \ 232 $(JAR) $$($1_JAR_UPDATE_OPTIONS) $$@ @$$($1_BIN)/_the.$$($1_JARNAME)_contents; \ 233 fi $$(NEWLINE) 234 # The s-variants of the above macros are used when the jar is created from scratch. 235 # NOTICE: please leave the parentheses space separated otherwise the AIX build will break! 236 $1_SCAPTURE_CONTENTS=\ 237 $(RM) $$($1_BIN)/_the.$$($1_JARNAME)_contents $$(NEWLINE) \ 238 $$(foreach src,$$($1_SRCS), \ 239 $(FIND) $$(src) -type f -a \( $$($1_FIND_PATTERNS) \) $$($1_GREP_INCLUDES) \ 240 $$($1_GREP_EXCLUDES) | $(SED) 's|$$(src)/|-C $$(src) |g' \ 241 >> $$($1_BIN)/_the.$$($1_JARNAME)_contents $$(NEWLINE)) \ 242 $$($1_CAPTURE_EXTRA_FILES) 243 244 # Find returns non zero if the META-INF dir does not exist, ignore this. 245 ifeq (,$$($1_SKIP_METAINF)) 246 $1_SCAPTURE_METAINF=$$(foreach src,$$($1_SRCS), \ 247 ( ( $(FIND) $$(src)/META-INF -type f 2> /dev/null || true ) \ 248 | $(SED) 's|$$(src)/|-C $$(src) |g' >> \ 249 $$($1_BIN)/_the.$$($1_JARNAME)_contents) $$(NEWLINE) ) 250 endif 251 $1_SUPDATE_CONTENTS=$(JAR) $$($1_JAR_UPDATE_OPTIONS) $$@ @$$($1_BIN)/_the.$$($1_JARNAME)_contents $$(NEWLINE) 252 253 # Use a slightly shorter name for logging, but with enough path to identify this jar. 254 $1_NAME:=$$(subst $$(OUTPUT_ROOT)/,,$$($1_JAR)) 255 256 ifneq (,$$($1_CHECK_COMPRESS_JAR)) 257 $1_JAR_CREATE_OPTIONS := c0fm 258 $1_JAR_UPDATE_OPTIONS := u0f 259 ifeq ($(COMPRESS_JARS), true) 260 $1_JAR_CREATE_OPTIONS := cfm 261 $1_JAR_UPDATE_OPTIONS := uf 262 endif 263 else 264 $1_JAR_CREATE_OPTIONS := cfm 265 $1_JAR_UPDATE_OPTIONS := uf 266 endif 267 268 # Include all variables of significance in the vardeps file 269 $1_VARDEPS := $(JAR) $$($1_JAR_CREATE_OPTIONS) $$($1_MANIFEST) \ 270 $$($1_JARMAIN) $$($1_EXTRA_MANIFEST_ATTR) $$($1_ORIG_DEPS) $$($1_SRCS) \ 271 $$($1_INCLUDES) $$($1_EXCLUDES) $$($1_EXCLUDE_FILES) $$($1_EXTRA_FILES) 272 $1_VARDEPS_FILE := $$(call DependOnVariable, $1_VARDEPS, $$(dir $$($1_JAR))_the.$$($1_JARNAME).vardeps) 273 274 # Here is the rule that creates/updates the jar file. 275 $$($1_JAR) : $$($1_DEPENDENCIES) $$($1_MANIFEST) $$($1_VARDEPS_FILE) 276 $(MKDIR) -p $$($1_BIN) 277 $$($1_GREP_INCLUDE_OUTPUT) 278 $$($1_GREP_EXCLUDE_OUTPUT) 279 # If the vardeps file is part of the newer prereq list, it means that 280 # either the jar file does not exist, or we need to recreate it from 281 # from scratch anyway since a simple update will not catch all the 282 # potential changes. 283 $$(if $$(filter $$($1_VARDEPS_FILE) $$($1_MANIFEST), $$?), \ 284 $$(if $$($1_MANIFEST), \ 285 $(SED) -e '$(DOLLAR)$(DOLLAR)a\' $$($1_MANIFEST) > $$($1_MANIFEST_FILE) $$(NEWLINE) \ 286 , \ 287 $(RM) $$($1_MANIFEST_FILE) && $(TOUCH) $$($1_MANIFEST_FILE) $$(NEWLINE)) \ 288 $$(if $$($1_JARMAIN), \ 289 $(ECHO) "Main-Class: $$(strip $$($1_JARMAIN))" >> $$($1_MANIFEST_FILE) $$(NEWLINE)) \ 290 $$(if $$($1_EXTRA_MANIFEST_ATTR), \ 291 $(PRINTF) "$$($1_EXTRA_MANIFEST_ATTR)\n" >> $$($1_MANIFEST_FILE) $$(NEWLINE)) \ 292 $(ECHO) Creating $$($1_NAME) $$(NEWLINE) \ 293 $(JAR) $$($1_JAR_CREATE_OPTIONS) $$@ $$($1_MANIFEST_FILE) $$(NEWLINE) \ 294 $$($1_SCAPTURE_CONTENTS) \ 295 $$($1_SCAPTURE_METAINF) \ 296 $$($1_SUPDATE_CONTENTS) \ 297 $$($1_JARINDEX) && true \ 298 , \ 299 $(ECHO) Modifying $$($1_NAME) $$(NEWLINE) \ 300 $$($1_CAPTURE_CONTENTS) \ 301 $$($1_CAPTURE_METAINF) \ 302 $(RM) $$($1_DELETES_FILE) $$(NEWLINE) \ 303 $$($1_CAPTURE_DELETES) \ 304 $(CAT) $$($1_DELETES_FILE) > $$($1_DELETESS_FILE) $$(NEWLINE) \ 305 if [ -s $$($1_DELETESS_FILE) ]; then \ 306 $(ECHO) " deleting" `$(WC) -l $$($1_DELETESS_FILE) | $(AWK) '{ print $$$$1 }'` files && \ 307 $(ZIP) -q -d $$@ `$(CAT) $$($1_DELETESS_FILE)` ; \ 308 fi $$(NEWLINE) \ 309 $$($1_UPDATE_CONTENTS) true $$(NEWLINE) \ 310 $$($1_JARINDEX) && true ) 311 312 # Add jar to target list 313 $1 += $$($1_JAR) 314endef 315 316 317define add_file_to_copy 318 # param 1 = BUILD_MYPACKAGE 319 # parma 2 = The source file to copy. 320 $2_TARGET:=$2 321 # Remove the source prefix. 322 $$(foreach i,$$($1_SRC),$$(eval $$(call remove_string,$$i,$2_TARGET))) 323 # To allow for automatic overrides, do not create a rule for a target file that 324 # already has one 325 ifneq ($$($1_COPY_$$($2_TARGET)), 1) 326 $1_COPY_$$($2_TARGET) := 1 327 # Now we can setup the depency that will trigger the copying. 328 $$($1_BIN)$$($2_TARGET) : $2 329 $(MKDIR) -p $$(@D) 330 $(CP) $$< $$@ 331 $(CHMOD) -f ug+w $$@ 332 333 # And do not forget this target 334 $1_ALL_COPY_TARGETS += $$($1_BIN)$$($2_TARGET) 335 endif 336endef 337 338 339# This macro is used only for properties files that are to be 340# copied over to the classes directory in cleaned form: 341# Previously this was inconsistently done in different repositories. 342# This is the new clean standard. Though it is to be superseded by 343# a standard annotation processor from with sjavac. 344# 345# An empty echo ensures that the input to sed always ends with a newline. 346# Certain implementations (e.g. Solaris) will skip the last line without 347# it. 348# 349# The sed expression does this: 350# 1. Add a backslash before any :, = or ! that do not have a backslash already. 351# 2. Apply the file unicode2x.sed which does a whole bunch of \u00XX to \xXX 352# conversions. 353# 3. Delete all lines starting with #. 354# 4. Delete empty lines. 355# 5. Append lines ending with \ with the next line. 356# 6. Remove leading and trailing white space. Note that tabs must be explicit 357# as sed on macosx does not understand '\t'. 358# 7. Replace the first \= with just =. 359# 8. Finally it's all sorted to create a stable output. 360# 361# It is assumed that = is the character used for separating names and values. 362define add_file_to_clean 363 # param 1 = BUILD_MYPACKAGE 364 # parma 2 = The source file to copy and clean. 365 $2_TARGET:=$2 366 # Remove the source prefix. 367 $$(foreach i,$$($1_SRC),$$(eval $$(call remove_string,$$i,$2_TARGET))) 368 # Now we can setup the depency that will trigger the copying. 369 # To allow for automatic overrides, do not create a rule for a target file that 370 # already has one 371 ifneq ($$($1_CLEAN_$$($2_TARGET)), 1) 372 $1_CLEAN_$$($2_TARGET) := 1 373 $$($1_BIN)$$($1_MODULE_SUBDIR)$$($2_TARGET) : $2 374 $(MKDIR) -p $$(@D) 375 export LC_ALL=C ; ( $(CAT) $$< && $(ECHO) "" ) \ 376 | $(SED) -e 's/\([^\\]\):/\1\\:/g' -e 's/\([^\\]\)=/\1\\=/g' \ 377 -e 's/\([^\\]\)!/\1\\!/g' -e 's/^[ ]*#.*/#/g' \ 378 | $(SED) -f "$(SRC_ROOT)/make/common/support/unicode2x.sed" \ 379 | $(SED) -e '/^#/d' -e '/^$$$$/d' \ 380 -e :a -e '/\\$$$$/N; s/\\\n//; ta' \ 381 -e 's/^[ ]*//;s/[ ]*$$$$//' \ 382 -e 's/\\=/=/' \ 383 | $(SORT) > $$@ 384 $(CHMOD) -f ug+w $$@ 385 386 # And do not forget this target 387 $1_ALL_COPY_CLEAN_TARGETS += $$($1_BIN)$$($2_TARGET) 388 endif 389endef 390 391define remove_string 392 $2 := $$(subst $1,,$$($2)) 393endef 394 395# Setup make rules for compiling Java source code to class files and/or a 396# resulting jar file. 397# 398# Parameter 1 is the name of the rule. This name is used as variable prefix, 399# and the targets generated are listed in a variable by that name. 400# 401# Remaining parameters are named arguments. These include: 402# SETUP:=must point to a previously setup java compiler, for example: SETUP:=BOOTJAVAC 403# JVM:=path to ..bin/java 404# ADD_JAVAC_FLAGS:=javac flags to append to the default ones. 405# SRC:=one or more directories to search for sources. The order of the source roots 406# is significant. The first found file of a certain name has priority. 407# BIN:=store classes here 408# CLASSPATH:=a list of additional entries to set as classpath to javac 409# INCLUDES:=myapp.foo means will only compile java files in myapp.foo or any of its sub-packages. 410# EXCLUDES:=myapp.foo means will do not compile java files in myapp.foo or any of its sub-packages. 411# COPY:=.prp means copy all prp files to the corresponding package in BIN. 412# COPY_FILES:=myapp/foo/setting.txt means copy this file over to the package myapp/foo 413# CLEAN:=.properties means copy and clean all properties file to the corresponding package in BIN. 414# CLEAN_FILES:=myapp/foo/setting.txt means clean this file over to the package myapp/foo 415# SRCZIP:=Create a src.zip based on the found sources and copied files. 416# INCLUDE_FILES:="com/sun/SolarisFoobar.java" means only compile this file! 417# EXCLUDE_FILES:="com/sun/SolarisFoobar.java" means do not compile this particular file! 418# "SolarisFoobar.java" means do not compile SolarisFoobar, wherever it is found. 419# HEADERS:=path to directory where all generated c-headers are written. 420# DEPENDS:=Extra dependecy 421# DISABLE_SJAVAC:=Explicitly disable the use of sjavac for this compilation unit. 422# KEEP_DUPS:=Do not remove duplicate file names from different source roots. 423SetupJavaCompilation = $(NamedParamsMacroTemplate) 424define SetupJavaCompilationBody 425 426 # Verify arguments 427 ifeq ($$($1_BIN),) 428 $$(error Must specify BIN (in $1)) 429 endif 430 431 # Extract the info from the java compiler setup. 432 $1_JVM := $$($$($1_SETUP)_JVM) 433 $1_JAVAC := $$($$($1_SETUP)_JAVAC) 434 $1_FLAGS := $$($$($1_SETUP)_FLAGS) $(JAVAC_FLAGS) $$($1_ADD_JAVAC_FLAGS) 435 ifneq ($$($1_CLASSPATH), ) 436 $1_FLAGS += -cp $$(call PathList, $$($1_CLASSPATH)) 437 endif 438 ifeq ($$($1_JAVAC),) 439 $$(error The Java compilation $1 refers to a non-existant java compiler setup $$($1_SETUP)) 440 endif 441 $1_SJAVAC_PORTFILE := $$($$($1_SETUP)_SJAVAC_PORTFILE) 442 $1_SERVER_JVM := $$($$($1_SETUP)_SERVER_JVM) 443 444 # Handle addons and overrides. 445 $1_SRC:=$$(call ADD_SRCS,$$($1_SRC)) 446 # Make sure the dirs exist. 447 $$(foreach d,$$($1_SRC), $$(if $$(wildcard $$d),,$$(error SRC specified to SetupJavaCompilation $1 contains missing directory >$$d<))) 448 $$(call MakeDir,$$($1_BIN)) 449 # Add all source roots to the find cache since we are likely going to run find 450 # on these more than once. The cache will only be updated if necessary. 451 $$(eval $$(call FillCacheFind,$$($1_SRC))) 452 # Find all files in the source trees. Preserve order of source roots for overrides to 453 # work correctly. CacheFind does not preserve order so need to call it for each root. 454 $1_ALL_SRCS += $$(filter-out $(OVR_SRCS),$$(foreach s,$$($1_SRC),$$(call CacheFind,$$(s)))) 455 # Extract the java files. 456 ifneq ($$($1_EXCLUDE_FILES),) 457 $1_EXCLUDE_FILES_PATTERN:=$$(addprefix %,$$($1_EXCLUDE_FILES)) 458 endif 459 $1_SRCS := $$(filter-out $$($1_EXCLUDE_FILES_PATTERN),$$(filter %.java,$$($1_ALL_SRCS))) 460 ifneq ($$($1_INCLUDE_FILES),) 461 $1_INCLUDE_FILES:=$$(foreach i,$$($1_SRC),$$(addprefix $$i/,$$($1_INCLUDE_FILES))) 462 $1_SRCS := $$(filter $$($1_INCLUDE_FILES), $$($1_SRCS)) 463 endif 464 465 # Prepend the source/bin path to the filter expressions. 466 ifneq ($$($1_INCLUDES),) 467 $1_SRC_INCLUDES := $$(foreach i,$$($1_SRC),$$(addprefix $$i/,$$(addsuffix /%,$$($1_INCLUDES)))) 468 $1_SRCS := $$(filter $$($1_SRC_INCLUDES),$$($1_SRCS)) 469 endif 470 ifneq ($$($1_EXCLUDES),) 471 $1_SRC_EXCLUDES := $$(foreach i,$$($1_SRC),$$(addprefix $$i/,$$(addsuffix /%,$$($1_EXCLUDES)))) 472 $1_SRCS := $$(filter-out $$($1_SRC_EXCLUDES),$$($1_SRCS)) 473 endif 474 475 ifneq ($$($1_KEEP_DUPS), true) 476 # Remove duplicate source files by keeping the first found of each duplicate. 477 # This allows for automatic overrides with custom or platform specific versions 478 # source files. 479 # 480 # For the smart javac wrapper case, add each removed file to an extra exclude 481 # file list to prevent sjavac from finding duplicate sources. 482 $1_SRCS := $$(strip $$(foreach s, $$($1_SRCS), \ 483 $$(eval relative_src := $$(call remove-prefixes, $$($1_SRC), $$(s))) \ 484 $$(if $$($1_$$(relative_src)), \ 485 $$(eval $1_SJAVAC_EXCLUDE_FILES += $$(s)), \ 486 $$(eval $1_$$(relative_src) := 1) $$(s)))) 487 endif 488 489 ifeq ($$(strip $$($1_SRCS)), ) 490 $$(error No source files found for $1) 491 endif 492 493 $1_SAFE_NAME := $$(strip $$(subst /,_, $1)) 494 495 # Create the corresponding smart javac wrapper command line. 496 $1_SJAVAC_ARGS:=$$(addprefix -x ,$$(addsuffix /*,$$($1_EXCLUDES))) \ 497 $$(addprefix -i ,$$(addsuffix /*,$$($1_INCLUDES))) \ 498 $$(addprefix -xf *,$$(strip $$($1_EXCLUDE_FILES) $$($1_SJAVAC_EXCLUDE_FILES))) \ 499 $$(addprefix -if *,$$(strip $$($1_INCLUDE_FILES))) \ 500 -src $$(call PathList, $$($1_SRC)) 501 502 # All files below META-INF are always copied. 503 $1_ALL_COPIES := $$(filter $$(addsuffix /META-INF%,$$($1_SRC)),$$($1_ALL_SRCS)) 504 # Find all files to be copied from source to bin. 505 ifneq (,$$($1_COPY)$$($1_COPY_FILES)) 506 # Search for all files to be copied. 507 $1_ALL_COPIES += $$(filter $$(addprefix %,$$($1_COPY)),$$($1_ALL_SRCS)) 508 # Copy these explicitly 509 $1_ALL_COPIES += $$($1_COPY_FILES) 510 endif 511 # Copy must also respect filters. 512 ifneq (,$$($1_INCLUDES)) 513 $1_ALL_COPIES := $$(filter $$($1_SRC_INCLUDES),$$($1_ALL_COPIES)) 514 endif 515 ifneq (,$$($1_EXCLUDES)) 516 $1_ALL_COPIES := $$(filter-out $$($1_SRC_EXCLUDES),$$($1_ALL_COPIES)) 517 endif 518 ifneq (,$$($1_EXCLUDE_FILES)) 519 $1_ALL_COPIES := $$(filter-out $$($1_EXCLUDE_FILES_PATTERN),$$($1_ALL_COPIES)) 520 endif 521 ifneq (,$$($1_ALL_COPIES)) 522 # Yep, there are files to be copied! 523 $1_ALL_COPY_TARGETS:= 524 $$(foreach i,$$($1_ALL_COPIES),$$(eval $$(call add_file_to_copy,$1,$$i))) 525 # Now we can depend on $$($1_ALL_COPY_TARGETS) to copy all files! 526 endif 527 528 # Find all property files to be copied and cleaned from source to bin. 529 ifneq (,$$($1_CLEAN)$$($1_CLEAN_FILES)) 530 # Search for all files to be copied. 531 $1_ALL_CLEANS := $$(filter $$(addprefix %,$$($1_CLEAN)),$$($1_ALL_SRCS)) 532 # Clean these explicitly 533 $1_ALL_CLEANS += $$($1_CLEAN_FILES) 534 # Copy and clean must also respect filters. 535 ifneq (,$$($1_INCLUDES)) 536 $1_ALL_CLEANS := $$(filter $$($1_SRC_INCLUDES),$$($1_ALL_CLEANS)) 537 endif 538 ifneq (,$$($1_EXCLUDES)) 539 $1_ALL_CLEANS := $$(filter-out $$($1_SRC_EXCLUDES),$$($1_ALL_CLEANS)) 540 endif 541 ifneq (,$$($1_EXCLUDE_FILES)) 542 $1_ALL_CLEANS := $$(filter-out $$($1_EXCLUDE_FILES_PATTERN),$$($1_ALL_CLEANS)) 543 endif 544 ifneq (,$$($1_ALL_CLEANS)) 545 # Yep, there are files to be copied and cleaned! 546 $1_ALL_COPY_CLEAN_TARGETS:= 547 $$(foreach i,$$($1_ALL_CLEANS),$$(eval $$(call add_file_to_clean,$1,$$i))) 548 # Now we can depend on $$($1_ALL_COPY_CLEAN_TARGETS) to copy all files! 549 endif 550 endif 551 552 # Create a sed expression to remove the source roots and to replace / with . 553 # and remove .java at the end. 554 $1_REWRITE_INTO_CLASSES:=$$(foreach i,$$($1_SRC),-e 's|$$i/||g') -e 's|/|.|g' -e 's|.java$$$$||g' 555 556 ifeq ($$($1_DISABLE_SJAVAC)x$$(ENABLE_SJAVAC),xyes) 557 ifneq (,$$($1_HEADERS)) 558 $1_HEADERS_ARG := -h $$($1_HEADERS) 559 endif 560 561 # Using sjavac to compile. 562 $1_COMPILE_TARGETS := $$($1_BIN)/_the.$1_batch 563 564 # Create SJAVAC variable form JAVAC variable. Expects $1_JAVAC to be 565 # "bootclasspathprepend -cp .../javac.jar com.sun.tools.javac.Main" 566 # and javac is simply replaced with sjavac. 567 $1_SJAVAC:=$$(subst com.sun.tools.javac.Main,com.sun.tools.sjavac.Main,$$($1_JAVAC)) 568 569 # Set the $1_REMOTE to spawn a background javac server. 570 $1_REMOTE:=--server:portfile=$$($1_SJAVAC_PORTFILE),id=$1,sjavac=$$(subst \ 571 $$(SPACE),%20,$$(subst $$(COMMA),%2C,$$(strip $$($1_SERVER_JVM) $$($1_SJAVAC)))) 572 573 $1_VARDEPS := $$($1_JVM) $$($1_SJAVAC) $$($1_SJAVAC_ARGS) $$($1_FLAGS) \ 574 $$($1_HEADERS_ARG) $$($1_BIN) $$($1_EXCLUDES) $$($1_INCLUDES) \ 575 $$($1_EXCLUDE_FILES) $$($1_INCLUDE_FILES) 576 $1_VARDEPS_FILE := $$(call DependOnVariable, $1_VARDEPS, $$($1_BIN)/_the.$1.vardeps) 577 578 $$($1_BIN)/_the.$1_batch: $$($1_SRCS) $$($1_DEPENDS) $$($1_VARDEPS_FILE) 579 $(MKDIR) -p $$(@D) $$(dir $$($1_SJAVAC_PORTFILE)) 580 $$(call ListPathsSafely,$1_SRCS,\n, >> $$($1_BIN)/_the.$1_batch.tmp) 581 $(ECHO) Compiling $1 582 $(call LogFailures, $$($1_BIN)/_the.$$($1_SAFE_NAME)_batch.log, $$($1_SAFE_NAME), \ 583 $$($1_JVM) $$($1_SJAVAC) \ 584 $$($1_REMOTE) \ 585 -j 1 \ 586 --permit-unidentified-artifacts \ 587 --permit-sources-without-package \ 588 --compare-found-sources $$($1_BIN)/_the.$1_batch.tmp \ 589 --log=$(LOG_LEVEL) \ 590 --state-dir=$$($1_BIN) \ 591 $$($1_SJAVAC_ARGS) \ 592 $$($1_FLAGS) \ 593 $$($1_HEADERS_ARG) \ 594 -d $$($1_BIN)) && \ 595 $(MV) $$($1_BIN)/_the.$1_batch.tmp $$($1_BIN)/_the.$1_batch 596 # Create a pubapi file that only changes when the pubapi changes. Dependent 597 # compilations can use this file to only get recompiled when pubapi has changed. 598 # Grep returns 1 if no matching lines are found. Do not fail for this. 599 $(GREP) -e "^I" $$($1_BIN)/javac_state > $$($1_BIN)/_the.$1_pubapi.tmp \ 600 || test "$$$$?" = "1" 601 if [ ! -f $$($1_BIN)/_the.$1_pubapi ] \ 602 || [ "`$(DIFF) $$($1_BIN)/_the.$1_pubapi $$($1_BIN)/_the.$1_pubapi.tmp`" != "" ]; then \ 603 $(MV) $$($1_BIN)/_the.$1_pubapi.tmp $$($1_BIN)/_the.$1_pubapi; \ 604 fi 605 606 else 607 # Using plain javac to batch compile everything. 608 $1_COMPILE_TARGETS := $$($1_BIN)/_the.$1_batch 609 610 # When building in batch, put headers in a temp dir to filter out those that actually 611 # changed before copying them to the real header dir. 612 ifneq (,$$($1_HEADERS)) 613 $1_HEADERS_ARG := -h $$($1_HEADERS).$1.tmp 614 615 $$($1_HEADERS)/_the.$1_headers: $$($1_BIN)/_the.$1_batch 616 $(MKDIR) -p $$(@D) 617 if [ -d "$$($1_HEADERS).$1.tmp" ]; then \ 618 for f in `ls $$($1_HEADERS).$1.tmp`; do \ 619 if [ ! -f "$$($1_HEADERS)/$$$$f" ] \ 620 || [ "`$(DIFF) $$($1_HEADERS)/$$$$f $$($1_HEADERS).$1.tmp/$$$$f`" != "" ]; then \ 621 $(CP) -f $$($1_HEADERS).$1.tmp/$$$$f $$($1_HEADERS)/$$$$f; \ 622 fi; \ 623 done; \ 624 fi 625 $(RM) -r $$($1_HEADERS).$1.tmp 626 $(TOUCH) $$@ 627 628 $1_HEADER_TARGETS := $$($1_HEADERS)/_the.$1_headers 629 endif 630 631 $1_VARDEPS := $$($1_JVM) $$($1_JAVAC) $$($1_FLAGS) $$($1_BIN) \ 632 $$($1_HEADERS_ARG) $$($1_EXCLUDES) $$($1_INCLUDES) \ 633 $$($1_EXCLUDE_FILES) $$($1_INCLUDE_FILES) 634 $1_VARDEPS_FILE := $$(call DependOnVariable, $1_VARDEPS, $$($1_BIN)/_the.$1.vardeps) 635 636 # When not using sjavac, pass along all sources to javac using an @file. 637 $$($1_BIN)/_the.$1_batch: $$($1_SRCS) $$($1_DEPENDS) $$($1_VARDEPS_FILE) 638 $(MKDIR) -p $$(@D) 639 $(RM) $$($1_BIN)/_the.$1_batch $$($1_BIN)/_the.$1_batch.tmp 640 $$(call ListPathsSafely,$1_SRCS,\n, >> $$($1_BIN)/_the.$1_batch.tmp) 641 $(ECHO) Compiling `$(WC) $$($1_BIN)/_the.$1_batch.tmp | $(TR) -s ' ' | $(CUT) -f 2 -d ' '` files for $1 642 $(call LogFailures, $$($1_BIN)/_the.$$($1_SAFE_NAME)_batch.log, $$($1_SAFE_NAME), \ 643 $$($1_JVM) $$($1_JAVAC) $$($1_FLAGS) \ 644 -implicit:none \ 645 -d $$($1_BIN) $$($1_HEADERS_ARG) @$$($1_BIN)/_the.$1_batch.tmp) && \ 646 $(MV) $$($1_BIN)/_the.$1_batch.tmp $$($1_BIN)/_the.$1_batch 647 endif 648 649 # Add all targets to main variable 650 $1 := $$($1_ALL_COPY_TARGETS) $$($1_ALL_COPY_CLEAN_TARGETS) $$($1_COMPILE_TARGETS) \ 651 $$($1_HEADER_TARGETS) 652 653 # Check if a jar file was specified, then setup the rules for the jar. 654 ifneq (,$$($1_JAR)) 655 # If no suffixes was explicitly set for this jar file. 656 # Use class and the cleaned/copied properties file suffixes as the default 657 # for the types of files to be put into the jar. 658 ifeq (,$$($1_SUFFIXES)) 659 $1_SUFFIXES:=.class $$($1_CLEAN) $$($1_COPY) 660 endif 661 662 $$(eval $$(call SetupArchive,ARCHIVE_$1, \ 663 DEPENDENCIES:=$$($1), \ 664 SRCS:=$$($1_BIN), \ 665 SUFFIXES:=$$($1_SUFFIXES), \ 666 EXCLUDE:=$$($1_EXCLUDES), \ 667 INCLUDES:=$$($1_INCLUDES), \ 668 EXTRA_FILES:=$$($1_ALL_COPY_TARGETS) $$($1_ALL_COPY_CLEAN_TARGETS), \ 669 JAR:=$$($1_JAR), \ 670 JARMAIN:=$$($1_JARMAIN), \ 671 MANIFEST:=$$($1_MANIFEST), \ 672 EXTRA_MANIFEST_ATTR:=$$($1_EXTRA_MANIFEST_ATTR), \ 673 JARINDEX:=$$($1_JARINDEX), \ 674 HEADERS:=$$($1_HEADERS), \ 675 SETUP:=$$($1_SETUP))) 676 677 # Add jar to target list 678 $1 += $$($1_JAR) 679 endif 680 681 # Check if a srczip was specified, then setup the rules for the srczip. 682 ifneq (,$$($1_SRCZIP)) 683 $$(eval $$(call SetupZipArchive,ARCHIVE_$1, \ 684 SRC:=$$($1_SRC), \ 685 ZIP:=$$($1_SRCZIP), \ 686 INCLUDES:=$$($1_INCLUDES), \ 687 EXCLUDES:=$$($1_EXCLUDES), \ 688 EXCLUDE_FILES:=$$($1_EXCLUDE_FILES))) 689 690 # Add zip to target list 691 $1 += $$($1_SRCZIP) 692 endif 693endef 694 695# Use this macro to find the correct target to depend on when the original 696# SetupJavaCompilation is declared in a different makefile, to avoid having 697# to declare and evaluate it again. 698# param 1 is for example BUILD_MYPACKAGE 699# param 2 is the output directory (BIN) 700define SetupJavaCompilationCompileTarget 701 $(if $(findstring yes, $(ENABLE_SJAVAC)), $(strip $2)/_the.$(strip $1)_pubapi, \ 702 $(strip $2)/_the.$(strip $1)_batch) 703endef 704 705endif # _JAVA_COMPILATION_GMK 706