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