1 #
   2 # Copyright (c) 2011, 2015, Oracle and/or its affiliates. All rights reserved.
   3 # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4 #
   5 # This code is free software; you can redistribute it and/or modify it
   6 # under the terms of the GNU General Public License version 2 only, as
   7 # published by the Free Software Foundation.  Oracle designates this
   8 # particular file as subject to the "Classpath" exception as provided
   9 # by Oracle in the LICENSE file that accompanied this code.
  10 #
  11 # This code is distributed in the hope that it will be useful, but WITHOUT
  12 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13 # FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14 # version 2 for more details (a copy is included in the LICENSE file that
  15 # accompanied this code).
  16 #
  17 # You should have received a copy of the GNU General Public License version
  18 # 2 along with this work; if not, write to the Free Software Foundation,
  19 # Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20 #
  21 # Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22 # or visit www.oracle.com if you need additional information or have any
  23 # questions.
  24 #
  25 
  26 # This makefile is much simpler now that it can use the smart javac wrapper
  27 # for dependency tracking between java packages and incremental compiles.
  28 # It could be even more simple if we added support for incremental jar updates
  29 # directly from the smart javac wrapper.
  30 
  31 # Cleaning/copying properties here is not a good solution. The properties
  32 # should be cleaned/copied by a annotation processor in sjavac.
  33 
  34 # When you read this source. Remember that $(sort ...) has the side effect
  35 # of removing duplicates. It is actually this side effect that is
  36 # desired whenever sort is used below!
  37 
  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 SetupJavaCompiler = $(NamedParamsMacroTemplate)
  63 define SetupJavaCompilerBody
  64   # The port file contains the tcp/ip on which the server listens
  65   # and the cookie necessary to talk to the server.
  66   $1_SJAVAC_PORTFILE:=$$($1_SERVER_DIR)/server.port
  67   # You can use a different JVM to run the background javac server.
  68   ifeq ($$($1_SERVER_JVM),)
  69     # It defaults to the same JVM that is used to start the javac command.
  70     $1_SERVER_JVM:=$$($1_JVM)
  71   endif
  72 endef
  73 
  74 # Setup make rules for creating a jar archive.
  75 #
  76 # Parameter 1 is the name of the rule. This name is used as variable prefix,
  77 # and the targets generated are listed in a variable by that name.
  78 #
  79 # Remaining parameters are named arguments. These include:
  80 #   DEPENDENCIES:=List of dependencies for the jar target. If left empty,
  81 #       dependencies are calculated automatically from the source files found.
  82 #       For this to work, the source files must exist when the makefile is
  83 #       parsed.
  84 #   SRCS:=List of directories in where to find files to add to archive
  85 #   SUFFIXES:=File suffixes to include in jar
  86 #   INCLUDES:=List of directories/packages in SRCS that should be included
  87 #   EXCLUDES:=List of directories/packages in SRCS that should be excluded
  88 #   EXCLUDE_FILES:=List of files in SRCS that should be excluded
  89 #   EXTRA_FILES:=List of files in SRCS that should be included regardless of suffix match.
  90 #   JAR:=Jar file to create
  91 #   MANIFEST:=Optional manifest file template.
  92 #   JARMAIN:=Optional main class to add to manifest
  93 #   JARINDEX:=true means generate the index in the jar file.
  94 #   SKIP_METAINF:=Set to prevent contents of an META-INF directory to be automatically
  95 #       added to the archive.
  96 #   EXTRA_MANIFEST_ATTR:=Extra attribute to add to manifest.
  97 #   CHECK_COMPRESS_JAR Check the COMPRESS_JAR variable
  98 SetupArchive = $(NamedParamsMacroTemplate)
  99 define SetupArchiveBody
 100 
 101   $1_JARMAIN:=$(strip $$($1_JARMAIN))
 102   $1_JARNAME:=$$(notdir $$($1_JAR))
 103   $1_MANIFEST_FILE:=$$(dir $$($1_JAR))_the.$$($1_JARNAME)_manifest
 104   $1_DELETESS_FILE:=$$(dir $$($1_JAR))_the.$$($1_JARNAME)_deletess
 105   $1_DELETES_FILE:=$$(dir $$($1_JAR))_the.$$($1_JARNAME)_deletes
 106   $1_BIN:=$$(dir $$($1_JAR))
 107 
 108   ifeq (,$$($1_SUFFIXES))
 109     # No suffix was set, default to classes.
 110     $1_SUFFIXES:=.class
 111   endif
 112   # Convert suffixes to a find expression
 113   $1_FIND_PATTERNS:=$(FALSE_FIND_PATTERN) $$(patsubst %,$(SPACE)-o$(SPACE)-name$(SPACE)$(DQUOTE)*%$(DQUOTE),$$($1_SUFFIXES))
 114   # On windows, a lot of includes/excludes risk making the command line too long, so
 115   # writing the grep patterns to files.
 116   # Grep returns 1 if nothing is matched. Do not fail the build for this.
 117   ifneq (,$$($1_INCLUDES))
 118     $1_GREP_INCLUDE_PATTERNS:=$$(call EscapeDollar, \
 119         $$(foreach src,$$($1_SRCS), $$(addprefix $$(src)/,$$($1_INCLUDES))))
 120     # If there are a lot of include patterns, output to file to shorten command lines
 121     ifeq ($$(word 20,$$($1_GREP_INCLUDE_PATTERNS)),)
 122       $1_GREP_INCLUDES:=| ( $(GREP) $$(patsubst %,$(SPACE)-e$(SPACE)$(DQUOTE)%$(DQUOTE),$$($1_GREP_INCLUDE_PATTERNS)) \
 123           || test "$$$$?" = "1" )
 124     else
 125       $1_GREP_INCLUDE_OUTPUT:=$(RM) $$($1_BIN)/_the.$$($1_JARNAME)_include $$(NEWLINE) \
 126           $$(call ListPathsSafely,$1_GREP_INCLUDE_PATTERNS,\n, \
 127           >> $$($1_BIN)/_the.$$($1_JARNAME)_include)
 128       $1_GREP_INCLUDES:=| ( $(GREP) -f $$($1_BIN)/_the.$$($1_JARNAME)_include \
 129           || test "$$$$?" = "1" )
 130     endif
 131   endif
 132   ifneq (,$$($1_EXCLUDES)$$($1_EXCLUDE_FILES))
 133     $1_GREP_EXCLUDE_PATTERNS:=$$(call EscapeDollar, \
 134         $$(foreach src,$$($1_SRCS),$$(addprefix $$(src)/, \
 135         $$($1_EXCLUDES) $$($1_EXCLUDE_FILES))))
 136     # If there are a lot of include patterns, output to file to shorten command lines
 137     ifeq ($$(word 20,$$($1_GREP_EXCLUDE_PATTERNS)),)
 138       $1_GREP_EXCLUDES:=| ( $(GREP) -v $$(patsubst %,$(SPACE)-e$(SPACE)$(DQUOTE)%$(DQUOTE),$$($1_GREP_EXCLUDE_PATTERNS)) \
 139           || test "$$$$?" = "1" )
 140     else
 141       $1_GREP_EXCLUDE_OUTPUT=$(RM) $$($1_BIN)/_the.$$($1_JARNAME)_exclude $$(NEWLINE) \
 142           $$(call ListPathsSafely,$1_GREP_EXCLUDE_PATTERNS,\n, \
 143           >> $$($1_BIN)/_the.$$($1_JARNAME)_exclude)
 144       $1_GREP_EXCLUDES:=| ( $(GREP) -v -f $$($1_BIN)/_the.$$($1_JARNAME)_exclude \
 145           || test "$$$$?" = "1" )
 146     endif
 147   endif
 148 
 149   # Check if this jar needs to have its index generated.
 150   ifneq (,$$($1_JARINDEX))
 151     $1_JARINDEX = (cd $$(dir $$@) && $(JAR) -i $$(notdir $$@))
 152   else
 153     $1_JARINDEX = true
 154   endif
 155   # When this macro is run in the same makefile as the java compilation, dependencies are
 156   # transfered in make variables. When the macro is run in a different makefile than the
 157   # java compilation, the dependencies need to be found in the filesystem.
 158   ifeq ($$($1_DEPENDENCIES), )
 159     # Add all source roots to the find cache since we are likely going to run find
 160     # on these more than once. The cache will only be updated if necessary.
 161     $$(eval $$(call FillCacheFind, $$($1_FIND_LIST)))
 162     $1_DEPENDENCIES:=$$(filter $$(addprefix %,$$($1_SUFFIXES)), \
 163         $$(call CacheFind,$$($1_SRCS)))
 164     ifneq (,$$($1_GREP_INCLUDE_PATTERNS))
 165       $1_DEPENDENCIES:=$$(filter $$(addsuffix %,$$($1_GREP_INCLUDE_PATTERNS)),$$($1_DEPENDENCIES))
 166     endif
 167     ifneq (,$$($1_GREP_EXCLUDE_PATTERNS))
 168       $1_DEPENDENCIES:=$$(filter-out $$(addsuffix %,$$($1_GREP_EXCLUDE_PATTERNS)),$$($1_DEPENDENCIES))
 169     endif
 170     # Look for EXTRA_FILES in all SRCS dirs and as absolute paths.
 171     $1_DEPENDENCIES+=$$(wildcard $$(foreach src, $$($1_SRCS), \
 172         $$(addprefix $$(src)/, $$($1_EXTRA_FILES))) $$($1_EXTRA_FILES))
 173     ifeq (,$$($1_SKIP_METAINF))
 174       $1_DEPENDENCIES+=$$(call CacheFind,$$(wildcard $$(addsuffix /META-INF,$$($1_SRCS))))
 175     endif
 176   endif
 177   # The dependency list should never be empty
 178   ifeq ($$(strip $$($1_DEPENDENCIES)), )
 179     $$(warning No dependencies found for $1)
 180   endif
 181 
 182   # Utility macros, to make the shell script receipt somewhat easier to decipher.
 183 
 184   # Capture extra files is the same for both CAPTURE_CONTENTS and SCAPTURE_CONTENTS so
 185   # only define it once to avoid duplication.
 186   # The list of extra files might be long, so need to use ListPathsSafely to print
 187   # them out to a separte file. Then process the contents of that file to rewrite
 188   # into -C <dir> <file> lines.
 189   # The EXTRA_FILES_RESOLVED varible must be set in the macro so that it's evaluated
 190   # in the recipe when the files are guaranteed to exist.
 191   $1_CAPTURE_EXTRA_FILES=\
 192       $(RM) $$($1_BIN)/_the.$$($1_JARNAME)_contents.extra $$(NEWLINE) \
 193       $$(eval $1_EXTRA_FILES_RESOLVED:=$$(call DoubleDollar, $$(call DoubleDollar, \
 194           $$(wildcard $$(foreach src, $$($1_SRCS), \
 195           $$(addprefix $$(src)/, $$($1_EXTRA_FILES))) $$($1_EXTRA_FILES))))) \
 196       $$(if $$($1_EXTRA_FILES_RESOLVED), \
 197         $$(call ListPathsSafely,$1_EXTRA_FILES_RESOLVED,\n, \
 198             >> $$($1_BIN)/_the.$$($1_JARNAME)_contents.extra) $$(NEWLINE) \
 199         $(SED) $$(foreach src,$$($1_SRCS), -e 's|$$(src)/|-C $$(src) |g') \
 200             $$($1_BIN)/_the.$$($1_JARNAME)_contents.extra \
 201             >> $$($1_BIN)/_the.$$($1_JARNAME)_contents $$(NEWLINE))
 202 
 203   # The capture contents macro finds all files (matching the patterns, typically
 204   # .class and .prp) that are newer than the jar-file, ie the new content to be put into the jar.
 205   # NOTICE: please leave the parentheses space separated otherwise the AIX build will break!
 206   $1_CAPTURE_CONTENTS=\
 207       $(RM) $$($1_BIN)/_the.$$($1_JARNAME)_contents $$(NEWLINE) \
 208       $$(foreach src,$$($1_SRCS), \
 209         $(FIND) $$(src) -type f -a \( $$($1_FIND_PATTERNS) \) -a -newer $$@ $$($1_GREP_INCLUDES) \
 210           $$($1_GREP_EXCLUDES) | $(SED) 's|$$(src)/|-C $$(src) |g' \
 211         >> $$($1_BIN)/_the.$$($1_JARNAME)_contents $$(NEWLINE)) \
 212       $$($1_CAPTURE_EXTRA_FILES)
 213 
 214   # The capture metainf macro finds all files below the META-INF directory that are newer than the jar-file.
 215   # Find returns non zero if the META-INF dir does not exist, ignore this.
 216   ifeq (,$$($1_SKIP_METAINF))
 217     $1_CAPTURE_METAINF =$$(foreach src,$$($1_SRCS), \
 218         ( ( $(FIND) $$(src)/META-INF -type f -a -newer $$@ 2> /dev/null || true ) \
 219             | $(SED) 's|$$(src)/|-C $$(src) |g' >> \
 220         $$($1_BIN)/_the.$$($1_JARNAME)_contents ) $$(NEWLINE) )
 221   endif
 222   # The capture deletes macro finds all deleted files and concatenates them. The resulting file
 223   # tells us what to remove from the jar-file.
 224   $1_CAPTURE_DELETES=$$(foreach src,$$($1_SRCS),($(FIND) $$(src) -name _the.package.deleted -newer $$@ \
 225       -exec $(SED) 's|$$(src)||g' \{\} >> $$($1_DELETES_FILE) \;) $$(NEWLINE))
 226   # The update contents macro updates the jar file with the previously capture contents.
 227   # Use 'wc -w' to see if the contents file is empty.
 228   $1_UPDATE_CONTENTS=\
 229       if [ "`$(WC) -l $$($1_BIN)/_the.$$($1_JARNAME)_contents | $(AWK) '{ print $$$$1 }'`" -gt "0" ]; then \
 230         $(ECHO) "  updating" `$(WC) -l $$($1_BIN)/_the.$$($1_JARNAME)_contents | $(AWK) '{ print $$$$1 }'` files && \
 231         $(JAR) $$($1_JAR_UPDATE_OPTIONS) $$@ @$$($1_BIN)/_the.$$($1_JARNAME)_contents; \
 232       fi $$(NEWLINE)
 233   # The s-variants of the above macros are used when the jar is created from scratch.
 234   # NOTICE: please leave the parentheses space separated otherwise the AIX build will break!
 235   $1_SCAPTURE_CONTENTS=\
 236       $(RM) $$($1_BIN)/_the.$$($1_JARNAME)_contents $$(NEWLINE) \
 237       $$(foreach src,$$($1_SRCS), \
 238         $(FIND) $$(src) -type f -a \( $$($1_FIND_PATTERNS) \) $$($1_GREP_INCLUDES) \
 239             $$($1_GREP_EXCLUDES) | $(SED) 's|$$(src)/|-C $$(src) |g' \
 240             >> $$($1_BIN)/_the.$$($1_JARNAME)_contents $$(NEWLINE)) \
 241       $$($1_CAPTURE_EXTRA_FILES)
 242 
 243   # Find returns non zero if the META-INF dir does not exist, ignore this.
 244   ifeq (,$$($1_SKIP_METAINF))
 245     $1_SCAPTURE_METAINF=$$(foreach src,$$($1_SRCS), \
 246         ( ( $(FIND) $$(src)/META-INF -type f 2> /dev/null || true ) \
 247             | $(SED) 's|$$(src)/|-C $$(src) |g' >> \
 248         $$($1_BIN)/_the.$$($1_JARNAME)_contents) $$(NEWLINE) )
 249   endif
 250   $1_SUPDATE_CONTENTS=$(JAR) $$($1_JAR_UPDATE_OPTIONS) $$@ @$$($1_BIN)/_the.$$($1_JARNAME)_contents $$(NEWLINE)
 251 
 252   # Use a slightly shorter name for logging, but with enough path to identify this jar.
 253   $1_NAME:=$$(subst $$(OUTPUT_ROOT)/,,$$($1_JAR))
 254 
 255   ifneq (,$$($1_CHECK_COMPRESS_JAR))
 256     $1_JAR_CREATE_OPTIONS := c0fm
 257     $1_JAR_UPDATE_OPTIONS := u0f
 258     ifeq ($(COMPRESS_JARS), true)
 259       $1_JAR_CREATE_OPTIONS := cfm
 260       $1_JAR_UPDATE_OPTIONS := uf
 261     endif
 262   else
 263     $1_JAR_CREATE_OPTIONS := cfm
 264     $1_JAR_UPDATE_OPTIONS := uf
 265   endif
 266 
 267   # Include all variables of significance in the vardeps file
 268   $1_VARDEPS := $(JAR) $$($1_JAR_CREATE_OPTIONS) $$($1_MANIFEST) \
 269       $$($1_JARMAIN) $$($1_EXTRA_MANIFEST_ATTR)
 270   $1_VARDEPS_FILE := $$(call DependOnVariable, $1_VARDEPS, $$(dir $$($1_JAR))_the.$$($1_JARNAME).vardeps)
 271 
 272   # Here is the rule that creates/updates the jar file.
 273   $$($1_JAR) : $$($1_DEPENDENCIES) $$($1_MANIFEST) $$($1_VARDEPS_FILE)
 274         $(MKDIR) -p $$($1_BIN)
 275         $$($1_GREP_INCLUDE_OUTPUT)
 276         $$($1_GREP_EXCLUDE_OUTPUT)
 277         # If the vardeps file is part of the newer prereq list, it means that
 278         # either the jar file does not exist, or we need to recreate it from
 279         # from scratch anyway since a simple update will not catch all the
 280         # potential changes.
 281         $$(if $$(filter $$($1_VARDEPS_FILE) $$($1_MANIFEST), $$?), \
 282           $$(if $$($1_MANIFEST), \
 283             $(CP) $$($1_MANIFEST) $$($1_MANIFEST_FILE) $$(NEWLINE) \

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