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