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