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 
  38 ifndef _JAVA_COMPILATION_GMK
  39 _JAVA_COMPILATION_GMK := 1
  40 
  41 ifeq (,$(_MAKEBASE_GMK))
  42   $(error You must include MakeBase.gmk prior to including JavaCompilation.gmk)
  43 endif
  44 
  45 # Java compilation needs SetupZipArchive if we're generating a source zip.
  46 include ZipArchive.gmk
  47 
  48 FALSE_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.
  62 define 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)))
  65 endef
  66 
  67 define 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
  80 endef
  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
 102 define 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)))
 105 endef
 106 
 107 define 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   # Here is the rule that creates/updates the jar file.
 274   $$($1_JAR) : $$($1_DEPS)
 275         $(MKDIR) -p $$($1_BIN)
 276         $$($1_GREP_INCLUDE_OUTPUT)
 277         $$($1_GREP_EXCLUDE_OUTPUT)
 278         $$(if $$($1_MANIFEST), \
 279           $(SED) -e "s#@@RELEASE@@#$(RELEASE)#" \
 280               -e "s#@@COMPANY_NAME@@#$(COMPANY_NAME)#" $$($1_MANIFEST) > $$($1_MANIFEST_FILE) \
 281         , \
 282           $(RM) $$($1_MANIFEST_FILE) && $(TOUCH) $$($1_MANIFEST_FILE))
 283         $$(if $$($1_JARMAIN),$(ECHO) "Main-Class: $$(strip $$($1_JARMAIN))" >> $$($1_MANIFEST_FILE))
 284         $$(if $$($1_EXTRA_MANIFEST_ATTR),$(PRINTF) "$$($1_EXTRA_MANIFEST_ATTR)\n" >> $$($1_MANIFEST_FILE))
 285         $$(if $$(wildcard $$@), \
 286           $(ECHO) Modifying $$($1_NAME) $$(NEWLINE) \
 287           $$($1_CAPTURE_CONTENTS) \
 288           $$($1_CAPTURE_METAINF) \
 289           $(RM) $$($1_DELETES_FILE) $$(NEWLINE) \
 290           $$($1_CAPTURE_DELETES) \
 291           $(CAT) $$($1_DELETES_FILE) > $$($1_DELETESS_FILE) $$(NEWLINE) \
 292           if [ -s $$($1_DELETESS_FILE) ]; then \
 293             $(ECHO) "  deleting" `$(WC) -l $$($1_DELETESS_FILE) | $(AWK) '{ print $$$$1 }'` files && \
 294             $(ZIP) -q -d $$@ `$(CAT) $$($1_DELETESS_FILE)` ; \
 295           fi $$(NEWLINE) \
 296           $$($1_UPDATE_CONTENTS) true $$(NEWLINE) \
 297           $$($1_JARINDEX) && true \
 298         , \
 299           $(ECHO) Creating $$($1_NAME) && $(JAR) $$($1_JAR_CREATE_OPTIONS) $$@ $$($1_MANIFEST_FILE) $$(NEWLINE) \
 300           $$($1_SCAPTURE_CONTENTS) \
 301           $$($1_SCAPTURE_METAINF) \
 302           $$($1_SUPDATE_CONTENTS) \
 303           $$($1_JARINDEX) && true )
 304 
 305   # Add jar to target list
 306   $1 += $$($1_JAR)
 307 endef
 308 
 309     $1_SRC_EXCLUDES := $$(foreach i,$$($1_SRC),$$(addprefix $$i/,$$(addsuffix /%,$$($1_EXCLUDES))))
 310   ifneq ($$($1_EXCLUDE_FILES),)
 311     # Cannot precompute ZIP_EXCLUDE_FILES as it is dependent on which src root is being
 312     # zipped at the moment.
 313     $1_SRC_EXCLUDE_FILES := $$(addprefix %, $$($1_EXCLUDE_FILES)) $$($1_EXCLUDE_FILES)
 314     $1_ALL_SRCS := $$(filter-out $$($1_SRC_EXCLUDE_FILES), $$($1_ALL_SRCS))
 315   endif
 316 define add_file_to_copy
 317   # param 1 = BUILD_MYPACKAGE
 318   # parma 2 = The source file to copy.
 319   $2_TARGET:=$2
 320   # Remove the source prefix.
 321   $$(foreach i,$$($1_SRC),$$(eval $$(call remove_string,$$i,$2_TARGET)))
 322   # To allow for automatic overrides, do not create a rule for a target file that
 323   # already has one
 324   ifeq ($$(findstring $$($2_TARGET), $$($1_COPY_LIST)), )
 325     $1_COPY_LIST += $$($2_TARGET)
 326     # Now we can setup the depency that will trigger the copying.
 327     $$($1_BIN)$$($2_TARGET) : $2
 328         $(MKDIR) -p $$(@D)
 329         $(CP) $$< $$@
 330         $(CHMOD) -f ug+w $$@
 331 
 332     # And do not forget this target
 333     $1_ALL_COPY_TARGETS += $$($1_BIN)$$($2_TARGET)
 334   endif
 335 endef
 336 
 337 
 338 # This macro is used only for properties files that are to be
 339 # copied over to the classes directory in cleaned form:
 340 # Previously this was inconsistently done in different repositories.
 341 # This is the new clean standard. Though it is to be superseded by
 342 # a standard annotation processor from with sjavac.
 343 #
 344 # The sed expression does this:
 345 # 1. Add a backslash before any :, = or ! that do not have a backslash already.
 346 # 2. Apply the file unicode2x.sed which does a whole bunch of \u00XX to \xXX
 347 #    conversions.
 348 # 3. Delete all lines starting with #.
 349 # 4. Delete empty lines.
 350 # 5. Append lines ending with \ with the next line.
 351 # 6. Remove leading and trailing white space. Note that tabs must be explicit
 352 #    as sed on macosx does not understand '\t'.
 353 # 7. Replace the first \= with just =.
 354 # 8. Finally it's all sorted to create a stable output.
 355 #
 356 # It is assumed that = is the character used for separating names and values.
 357 define add_file_to_clean
 358   # param 1 = BUILD_MYPACKAGE
 359   # parma 2 = The source file to copy and clean.
 360   $2_TARGET:=$2
 361   # Remove the source prefix.
 362   $$(foreach i,$$($1_SRC),$$(eval $$(call remove_string,$$i,$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         export LC_ALL=C ; $(CAT) $$< \
 367             | $(SED) -e 's/\([^\\]\):/\1\\:/g' -e 's/\([^\\]\)=/\1\\=/g' \
 368                 -e 's/\([^\\]\)!/\1\\!/g' -e 's/#.*/#/g' \
 369             | $(SED) -f "$(SRC_ROOT)/make/common/support/unicode2x.sed" \
 370             | $(SED) -e '/^#/d' -e '/^$$$$/d' \
 371                 -e :a -e '/\\$$$$/N; s/\\\n//; ta' \
 372                 -e 's/^[        ]*//;s/[        ]*$$$$//' \
 373                 -e 's/\\=/=/' \
 374             | $(SORT) > $$@
 375         $(CHMOD) -f ug+w $$@
 376 
 377   # And do not forget this target
 378   $1_ALL_COPY_CLEAN_TARGETS += $$($1_BIN)$$($2_TARGET)
 379 endef
 380 
 381 define remove_string
 382   $2 := $$(subst $1,,$$($2))
 383 endef
 384 
 385 define replace_space_with_pathsep
 386   $1:=$(subst $(SPACE),$(PATH_SEP),$(strip $(patsubst %,%,$2)))
 387 endef
 388 
 389 # Setup make rules for compiling Java source code to class files and/or a
 390 # resulting jar file.
 391 #
 392 # Parameter 1 is the name of the rule. This name is used as variable prefix,
 393 # and the targets generated are listed in a variable by that name.
 394 #
 395 # Remaining parameters are named arguments. These include:
 396 #   SETUP:=must point to a previously setup java compiler, for example: SETUP:=BOOTJAVAC
 397 #   JVM:=path to ..bin/java
 398 #   ADD_JAVAC_FLAGS:=javac flags to append to the default ones.
 399 #   SRC:=one or more directories to search for sources
 400 #   BIN:=store classes here
 401 #   INCLUDES:=myapp.foo means will only compile java files in myapp.foo or any of its sub-packages.
 402 #   EXCLUDES:=myapp.foo means will do not compile java files in myapp.foo or any of its sub-packages.
 403 #   COPY:=.prp means copy all prp files to the corresponding package in BIN.
 404 #   COPY_FILES:=myapp/foo/setting.txt means copy this file over to the package myapp/foo
 405 #   CLEAN:=.properties means copy and clean all properties file to the corresponding package in BIN.
 406 #   CLEAN_FILES:=myapp/foo/setting.txt means clean this file over to the package myapp/foo
 407 #   SRCZIP:=Create a src.zip based on the found sources and copied files.
 408 #   INCLUDE_FILES:="com/sun/SolarisFoobar.java" means only compile this file!
 409 #   EXCLUDE_FILES:="com/sun/SolarisFoobar.java" means do not compile this particular file!
 410 #       "SolarisFoobar.java" means do not compile SolarisFoobar, wherever it is found.
 411 #   JAVAC_SOURCE_PATH_OVERRIDE:=This forces an explicit -sourcepath to javac instead of the complete
 412 #       source roots from SRC. This is sometimes needed when compiling specific subsets of the source.
 413 #   HEADERS:=path to directory where all generated c-headers are written.
 414 #   DEPENDS:=Extra dependecy
 415 #   DISABLE_SJAVAC:=Explicitly disable the use of sjavac for this compilation unit.
 416 define SetupJavaCompilation
 417   $(if $(16),$(error Internal makefile error: Too many arguments to SetupJavaCompilation, please update JavaCompilation.gmk))
 418   $(call EvalDebugWrapper,$(strip $1),$(call SetupJavaCompilationInner,$(strip $1),$2,$3,$4,$5,$6,$7,$8,$9,$(10),$(11),$(12),$(13),$(14),$(15)))
 419 endef
 420 
 421 define SetupJavaCompilationInner
 422   $(foreach i,2 3 4 5 6 7 8 9 10 11 12 13 14 15, $(if $($i),$1_$(strip $($i)))$(NEWLINE))
 423   $(call LogSetupMacroEntry,SetupJavaCompilation($1),$2,$3,$4,$5,$6,$7,$8,$9,$(10),$(11),$(12),$(13),$(14),$(15))
 424   $(if $(16),$(error Internal makefile error: Too many arguments to SetupJavaCompilation, please update JavaCompilation.gmk))
 425 
 426   # Extract the info from the java compiler setup.
 427   $1_JVM := $$($$($1_SETUP)_JVM)
 428   $1_JAVAC := $$($$($1_SETUP)_JAVAC)
 429   $1_FLAGS := $$($$($1_SETUP)_FLAGS) $(JAVAC_FLAGS) $$($1_ADD_JAVAC_FLAGS)
 430   ifeq ($$($1_JAVAC),)
 431     $$(error The Java compilation $1 refers to a non-existant java compiler setup $$($1_SETUP))
 432   endif
 433   $1_SJAVAC_PORTFILE := $$($$($1_SETUP)_SJAVAC_PORTFILE)
 434   $1_SERVER_JVM := $$($$($1_SETUP)_SERVER_JVM)
 435 
 436   # Handle addons and overrides.
 437   $1_SRC:=$$(call ADD_SRCS,$$($1_SRC))
 438   # Make sure the dirs exist.
 439   $$(foreach d,$$($1_SRC), $$(if $$(wildcard $$d),,$$(error SRC specified to SetupJavaCompilation $1 contains missing directory $$d)))
 440   $$(eval $$(call MakeDir,$$($1_BIN)))
 441   # Add all source roots to the find cache since we are likely going to run find
 442   # on these more than once. The cache will only be updated if necessary.
 443   $$(eval $$(call FillCacheFind,$$($1_SRC)))
 444   # Find all files in the source trees. Preserve order of source roots for overrides to
 445   # work correctly. CacheFind does not preserve order so need to call it for each root.
 446   $1_ALL_SRCS += $$(filter-out $(OVR_SRCS),$$(foreach s,$$($1_SRC),$$(call CacheFind,$$(s))))
 447   # Extract the java files.
 448   ifneq ($$($1_EXCLUDE_FILES),)
 449     $1_EXCLUDE_FILES_PATTERN:=$$(addprefix %,$$($1_EXCLUDE_FILES))
 450   endif
 451   $1_SRCS := $$(filter-out $$($1_EXCLUDE_FILES_PATTERN),$$(filter %.java,$$($1_ALL_SRCS)))
 452   ifneq ($$($1_INCLUDE_FILES),)
 453     $1_INCLUDE_FILES:=$$(foreach i,$$($1_SRC),$$(addprefix $$i/,$$($1_INCLUDE_FILES)))
 454     $1_SRCS := $$(filter $$($1_INCLUDE_FILES), $$($1_SRCS))
 455   endif
 456 
 457   # Now we have a list of all java files to compile: $$($1_SRCS)
 458 
 459   # Create the corresponding smart javac wrapper command line.
 460   $1_SJAVAC_ARGS:=$$(addprefix -x ,$$(addsuffix /*,$$($1_EXCLUDES))) \
 461       $$(addprefix -i ,$$(addsuffix /*,$$($1_INCLUDES))) \
 462       $$(addprefix -xf *,$$(strip $$($1_EXCLUDE_FILES))) \
 463       $$(addprefix -if *,$$(strip $$($1_INCLUDE_FILES))) \
 464       -src "$$(subst $$(SPACE),$$(PATH_SEP),$$(strip $$($1_SRC)))"
 465 
 466   # Prepend the source/bin path to the filter expressions.
 467   ifneq ($$($1_INCLUDES),)
 468     $1_SRC_INCLUDES := $$(foreach i,$$($1_SRC),$$(addprefix $$i/,$$(addsuffix /%,$$($1_INCLUDES))))
 469     $1_SRCS := $$(filter $$($1_SRC_INCLUDES),$$($1_SRCS))
 470   endif
 471   ifneq ($$($1_EXCLUDES),)
 472     $1_SRC_EXCLUDES := $$(foreach i,$$($1_SRC),$$(addprefix $$i/,$$(addsuffix /%,$$($1_EXCLUDES))))
 473     $1_SRCS := $$(filter-out $$($1_SRC_EXCLUDES),$$($1_SRCS))
 474   endif
 475 
 476   # All files below META-INF are always copied.
 477   $1_ALL_COPIES := $$(filter $$(addsuffix /META-INF%,$$($1_SRC)),$$($1_ALL_SRCS))
 478   # Find all files to be copied from source to bin.
 479   ifneq (,$$($1_COPY)$$($1_COPY_FILES))
 480     # Search for all files to be copied.
 481     $1_ALL_COPIES += $$(filter $$(addprefix %,$$($1_COPY)),$$($1_ALL_SRCS))
 482     # Copy these explicitly
 483     $1_ALL_COPIES += $$($1_COPY_FILES)
 484     # Copy must also respect filters.
 485     ifneq (,$$($1_INCLUDES))
 486       $1_ALL_COPIES := $$(filter $$($1_SRC_INCLUDES),$$($1_ALL_COPIES))
 487     endif
 488     ifneq (,$$($1_EXCLUDES))
 489       $1_ALL_COPIES := $$(filter-out $$($1_SRC_EXCLUDES),$$($1_ALL_COPIES))
 490     endif
 491     ifneq (,$$($1_EXCLUDE_FILES))
 492       $1_ALL_COPIES := $$(filter-out $$($1_EXCLUDE_FILES_PATTERN),$$($1_ALL_COPIES))
 493     endif
 494   endif
 495     ifneq (,$$($1_ALL_COPIES))
 496       # Yep, there are files to be copied!
 497       $1_ALL_COPY_TARGETS:=
 498           $$(foreach i,$$($1_ALL_COPIES),$$(eval $$(call add_file_to_copy,$1,$$i)))
 499       # Now we can depend on $$($1_ALL_COPY_TARGETS) to copy all files!
 500     endif
 501 
 502   # Find all property files to be copied and cleaned from source to bin.
 503   ifneq (,$$($1_CLEAN)$$($1_CLEAN_FILES))
 504     # Search for all files to be copied.
 505     $1_ALL_CLEANS := $$(filter $$(addprefix %,$$($1_CLEAN)),$$($1_ALL_SRCS))
 506     # Clean these explicitly
 507     $1_ALL_CLEANS += $$($1_CLEAN_FILES)
 508     # Copy and clean must also respect filters.
 509     ifneq (,$$($1_INCLUDES))
 510       $1_ALL_CLEANS := $$(filter $$($1_SRC_INCLUDES),$$($1_ALL_CLEANS))
 511     endif
 512     ifneq (,$$($1_EXCLUDES))
 513       $1_ALL_CLEANS := $$(filter-out $$($1_SRC_EXCLUDES),$$($1_ALL_CLEANS))
 514     endif
 515     ifneq (,$$($1_EXCLUDE_FILES))
 516       $1_ALL_CLEANS := $$(filter-out $$($1_EXCLUDE_FILES_PATTERN),$$($1_ALL_CLEANS))
 517     endif
 518     ifneq (,$$($1_ALL_CLEANS))
 519       # Yep, there are files to be copied and cleaned!
 520       $1_ALL_COPY_CLEAN_TARGETS:=
 521           $$(foreach i,$$($1_ALL_CLEANS),$$(eval $$(call add_file_to_clean,$1,$$i)))
 522       # Now we can depend on $$($1_ALL_COPY_CLEAN_TARGETS) to copy all files!
 523     endif
 524   endif
 525 
 526   # Prep the source paths.
 527   ifneq ($$($1_JAVAC_SOURCE_PATH_OVERRIDE),)
 528     $$(eval $$(call replace_space_with_pathsep,$1_SRCROOTSC,$$($1_JAVAC_SOURCE_PATH_OVERRIDE)))
 529   else
 530     $$(eval $$(call replace_space_with_pathsep,$1_SRCROOTSC,$$($1_SRC)))
 531   endif
 532 
 533   # Create a sed expression to remove the source roots and to replace / with .
 534   # and remove .java at the end.
 535   $1_REWRITE_INTO_CLASSES:=$$(foreach i,$$($1_SRC),-e 's|$$i/||g') -e 's|/|.|g' -e 's|.java$$$$||g'
 536 
 537   ifeq ($$($1_DISABLE_SJAVAC)x$$(ENABLE_SJAVAC),xyes)
 538     ifneq (,$$($1_HEADERS))
 539       $1_HEADERS_ARG := -h $$($1_HEADERS)
 540     endif
 541 
 542     # Using sjavac to compile.
 543     $1_COMPILE_TARGETS := $$($1_BIN)/_the.$1_batch
 544 
 545     # Create SJAVAC variable form JAVAC variable. Expects $1_JAVAC to be
 546     # "bootclasspathprepend -cp .../javac.jar com.sun.tools.javac.Main"
 547     # and javac is simply replaced with sjavac.
 548     $1_SJAVAC:=$$(subst com.sun.tools.javac.Main,com.sun.tools.sjavac.Main,$$($1_JAVAC))
 549 
 550     # Set the $1_REMOTE to spawn a background javac server.
 551     $1_REMOTE:=--server:portfile=$$($1_SJAVAC_PORTFILE),id=$1,sjavac=$$(subst $$(SPACE),%20,$$(subst $$(COMMA),%2C,$$(strip $$($1_SERVER_JVM) $$($1_SJAVAC))))
 552 
 553     $$($1_BIN)/_the.$1_batch: $$($1_SRCS) $$($1_DEPENDS)
 554         $(MKDIR) -p $$(@D)
 555         # As a workaround for sjavac not tracking api changed from the classpath, force full
 556         # recompile if an external dependency, which is something other than a source
 557         # change, triggered this compilation.
 558         $$(if $$(filter-out $$($1_SRCS), $$?), $(FIND) $$(@D) -name "*.class" $(FIND_DELETE))
 559         $$(call ListPathsSafely,$1_SRCS,\n, >> $$($1_BIN)/_the.$1_batch.tmp)
 560         $(ECHO) Compiling $1
 561         ($$($1_JVM) $$($1_SJAVAC) \
 562             $$($1_REMOTE) \
 563             -j 1 \
 564             --permit-unidentified-artifacts \
 565             --permit-sources-without-package \
 566             --compare-found-sources $$($1_BIN)/_the.$1_batch.tmp \
 567             --log=$(LOG_LEVEL) \
 568             $$($1_SJAVAC_ARGS) \
 569             $$($1_FLAGS) \
 570             $$($1_HEADERS_ARG) \
 571             -d $$($1_BIN) && \
 572         $(MV) $$($1_BIN)/_the.$1_batch.tmp $$($1_BIN)/_the.$1_batch)
 573         # Create a pubapi file that only changes when the pubapi changes. Dependent
 574         # compilations can use this file to only get recompiled when pubapi has changed.
 575         # Grep returns 1 if no matching lines are found. Do not fail for this.
 576         $(GREP) -e "^I" $$($1_BIN)/javac_state > $$($1_BIN)/_the.$1_pubapi.tmp \
 577             || test "$$$$?" = "1"
 578         if [ ! -f $$($1_BIN)/_the.$1_pubapi ] \
 579             || [ "`$(DIFF) $$($1_BIN)/_the.$1_pubapi $$($1_BIN)/_the.$1_pubapi.tmp`" != "" ]; then \
 580           $(MV) $$($1_BIN)/_the.$1_pubapi.tmp $$($1_BIN)/_the.$1_pubapi; \
 581         fi
 582 
 583   else
 584     # Using plain javac to batch compile everything.
 585     $1_COMPILE_TARGETS := $$($1_BIN)/_the.$1_batch
 586 
 587     # When building in batch, put headers in a temp dir to filter out those that actually
 588     # changed before copying them to the real header dir.
 589     ifneq (,$$($1_HEADERS))
 590       $1_HEADERS_ARG := -h $$($1_HEADERS).$1.tmp
 591 
 592       $$($1_HEADERS)/_the.$1_headers: $$($1_BIN)/_the.$1_batch
 593                 $(MKDIR) -p $$(@D)
 594                 if [ -d "$$($1_HEADERS).$1.tmp" ]; then \
 595                   for f in `ls $$($1_HEADERS).$1.tmp`; do \
 596                     if [ ! -f "$$($1_HEADERS)/$$$$f" ] \
 597                         || [ "`$(DIFF) $$($1_HEADERS)/$$$$f $$($1_HEADERS).$1.tmp/$$$$f`" != "" ]; then \
 598                     $(CP) -f $$($1_HEADERS).$1.tmp/$$$$f $$($1_HEADERS)/$$$$f; \
 599                   fi; \
 600                   done; \
 601                 fi
 602                 $(RM) -r $$($1_HEADERS).$1.tmp
 603                 $(TOUCH) $$@
 604 
 605       $1_HEADER_TARGETS := $$($1_HEADERS)/_the.$1_headers
 606     endif
 607 
 608     # When not using sjavac, pass along all sources to javac using an @file.
 609     $$($1_BIN)/_the.$1_batch: $$($1_SRCS) $$($1_DEPENDS)
 610         $(MKDIR) -p $$(@D)
 611         $(RM) $$($1_BIN)/_the.$1_batch $$($1_BIN)/_the.$1_batch.tmp
 612         $$(call ListPathsSafely,$1_SRCS,\n, >> $$($1_BIN)/_the.$1_batch.tmp)
 613         $(ECHO) Compiling `$(WC) $$($1_BIN)/_the.$1_batch.tmp | $(TR) -s ' ' | $(CUT) -f 2 -d ' '` files for $1
 614         ($$($1_JVM) $$($1_JAVAC) $$($1_FLAGS) \
 615             -implicit:none -sourcepath "$$($1_SRCROOTSC)" \
 616             -d $$($1_BIN) $$($1_HEADERS_ARG) @$$($1_BIN)/_the.$1_batch.tmp && \
 617         $(MV) $$($1_BIN)/_the.$1_batch.tmp $$($1_BIN)/_the.$1_batch)
 618 
 619   endif
 620 
 621   # Add all targets to main variable
 622   $1 := $$($1_ALL_COPY_TARGETS) $$($1_ALL_COPY_CLEAN_TARGETS) $$($1_COMPILE_TARGETS) \
 623       $$($1_HEADER_TARGETS)
 624 
 625   # Check if a jar file was specified, then setup the rules for the jar.
 626   ifneq (,$$($1_JAR))
 627     # If no suffixes was explicitly set for this jar file.
 628     # Use class and the cleaned/copied properties file suffixes as the default
 629     # for the types of files to be put into the jar.
 630     ifeq (,$$($1_SUFFIXES))
 631       $1_SUFFIXES:=.class $$($1_CLEAN) $$($1_COPY)
 632     endif
 633 
 634     $$(eval $$(call SetupArchive,ARCHIVE_$1,$$($1), \
 635         SRCS:=$$($1_BIN), \
 636         SUFFIXES:=$$($1_SUFFIXES), \
 637         EXCLUDE:=$$($1_EXCLUDES), \
 638         INCLUDES:=$$($1_INCLUDES), \
 639         EXTRA_FILES:=$$($1_ALL_COPY_TARGETS) $$($1_ALL_COPY_CLEAN_TARGETS), \
 640         JAR:=$$($1_JAR), \
 641         JARMAIN:=$$($1_JARMAIN), \
 642         MANIFEST:=$$($1_MANIFEST), \
 643         EXTRA_MANIFEST_ATTR:=$$($1_EXTRA_MANIFEST_ATTR), \
 644         JARINDEX:=$$($1_JARINDEX), \
 645         HEADERS:=$$($1_HEADERS), \
 646         SETUP:=$$($1_SETUP)))
 647 
 648     # Add jar to target list
 649     $1 += $$($1_JAR)
 650   endif
 651 
 652   # Check if a srczip was specified, then setup the rules for the srczip.
 653   ifneq (,$$($1_SRCZIP))
 654     $$(eval $$(call SetupZipArchive,ARCHIVE_$1, \
 655         SRC:=$$($1_SRC), \
 656         ZIP:=$$($1_SRCZIP), \
 657         INCLUDES:=$$($1_INCLUDES), \
 658         EXCLUDES:=$$($1_EXCLUDES), \
 659         EXCLUDE_FILES:=$$($1_EXCLUDE_FILES)))
 660 
 661     # Add zip to target list
 662     $1 += $$($1_SRCZIP)
 663   endif
 664 endef
 665 
 666 # Use this macro to find the correct target to depend on when the original
 667 # SetupJavaCompilation is declared in a different makefile, to avoid having
 668 # to declare and evaluate it again.
 669 # param 1 is for example BUILD_MYPACKAGE
 670 # param 2 is the output directory (BIN)
 671 define SetupJavaCompilationCompileTarget
 672   $(if $(findstring yes, $(ENABLE_SJAVAC)), $(strip $2)/_the.$(strip $1)_pubapi, \
 673       $(strip $2)/_the.$(strip $1)_batch)
 674 endef
 675 endif