common/makefiles/JavaCompilation.gmk

Thu, 03 Oct 2013 11:26:11 +0200

author
ihse
date
Thu, 03 Oct 2013 11:26:11 +0200
changeset 811
feb4f2d97042
parent 751
e5cf1735638c
child 839
174a54ce39c4
child 850
af81988013b5
permissions
-rw-r--r--

8008944: Correct typos
Reviewed-by: tbell, erikj

     1 #
     2 # Copyright (c) 2011, 2012, 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 #
    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.
    31 # Cleaning/copying properties here is not a good solution. The properties
    32 # should be cleaned/copied by a annotation processor in sjavac.
    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!
    38 ifeq  (,$(_MAKEBASE_GMK))
    39     $(error You must include MakeBase.gmk prior to including JavaCompilation.gmk)
    40 endif
    42 FALSE_FIND_PATTERN:=-name FILE_NAME_THAT_DOESNT_EXIST
    44 define SetupJavaCompiler
    45     # param 1 is for example GENERATE_OLD_BYTECODE or GENERATE_NEW_JDKBYTECODE
    46     # This is the name of the compiler setup.
    47     # param 2-9 are named args.
    48     #   JVM:=The jvm used to run the javac/javah command
    49     #   JAVAC:=The javac jar and bootstrap classpath changes, or just bin/javac if JVM is left out
    50     #   FLAGS:=Flags to be supplied to javac
    51     #   SERVER_DIR:=Use a javac server (-XDserver) and store the server related files here
    52     #   SERVER_JVM:=Use this JVM for the server. Defaults to the JVM above.
    53     $(foreach i,2 3 4 5 6 7 8 9 10 11 12 13 14 15, $(if $($i),$1_$(strip $($i)))$(NEWLINE))
    54     $(call LogSetupMacroEntry,SetupJavaCompiler($1),$2,$3,$4,$5,$6,$7,$8,$9,$(10),$(11),$(12),$(13),$(14),$(15))
    55     $(if $(16),$(error Internal makefile error: Too many arguments to SetupJavaCompiler, please update JavaCompilation.gmk))
    57     # The port file contains the tcp/ip on which the server listens
    58     # and the cookie necessary to talk to the server.
    59     $1_SJAVAC_PORTFILE:=$$($1_SERVER_DIR)/server.port
    60     # You can use a different JVM to run the background javac server.
    61     ifeq ($$($1_SERVER_JVM),)
    62         # It defaults to the same JVM that is used to start the javac command.
    63         $1_SERVER_JVM:=$$($1_JVM)
    64     endif
    65 endef
    67 define SetupArchive
    68     # param 1 is for example ARCHIVE_MYPACKAGE
    69     # param 2 are the dependecies
    70     # param 3,4,5,6,7,8,9 are named args.
    71     #    SRCS:=List of directories in where to find files to add to archive
    72     #    SUFFIXES:=File suffixes to include in jar
    73     #    INCLUDES:=List of directories/packages in SRCS that should be included
    74     #    EXCLUDES:=List of directories/packages in SRCS that should be excluded
    75     #    EXCLUDE_FILES:=List of files in SRCS that should be excluded
    76     #    EXTRA_FILES:=List of files in SRCS that should be included regardless of suffix match.
    77     #    JAR:=Jar file to create
    78     #    MANIFEST:=Optional manifest file template.
    79     #    JARMAIN:=Optional main class to add to manifest
    80     #    JARINDEX:=true means generate the index in the jar file.
    81     #    SKIP_METAINF:=Set to prevent contents of an META-INF directory to be automatically 
    82     #                  added to the archive.
    83     #    EXTRA_MANIFEST_ATTR:=Extra attribute to add to manifest.
    84     #    CHECK_COMPRESS_JAR Check the COMPRESS_JAR variable
    86     # NOTE: $2 is dependencies, not a named argument!
    87     $(foreach i,3 4 5 6 7 8 9 10 11 12 13 14 15, $(if $($i),$1_$(strip $($i)))$(NEWLINE))
    88     $(call LogSetupMacroEntry,SetupArchive($1),<dependencies>,$3,$4,$5,$6,$7,$8,$9,$(10),$(11),$(12),$(13),$(14),$(15))
    89     $(if $(findstring $(LOG_LEVEL),debug trace), $(info *[2] <dependencies> = $(strip $2)))
    90     $(if $(16),$(error Internal makefile error: Too many arguments to SetupArchive, please update JavaCompilation.gmk))
    92     $1_JARMAIN:=$(strip $$($1_JARMAIN))
    93     $1_JARNAME:=$$(notdir $$($1_JAR))
    94     $1_MANIFEST_FILE:=$$(dir $$($1_JAR))_the.$$($1_JARNAME)_manifest
    95     $1_DELETESS_FILE:=$$(dir $$($1_JAR))_the.$$($1_JARNAME)_deletess
    96     $1_DELETES_FILE:=$$(dir $$($1_JAR))_the.$$($1_JARNAME)_deletes
    97     $1_BIN:=$$(dir $$($1_JAR))
    99     ifeq (,$$($1_SUFFIXES))
   100         # No suffix was set, default to classes.
   101         $1_SUFFIXES:=.class
   102     endif
   103     # Convert suffixes to a find expression
   104     $1_FIND_PATTERNS:=$(FALSE_FIND_PATTERN) $$(patsubst %,$(SPACE)-o$(SPACE)-name$(SPACE)$(DQUOTE)*%$(DQUOTE),$$($1_SUFFIXES))
   105     # On windows, a lot of includes/excludes risk making the command line too long, so 
   106     # writing the grep patterns to files.
   107     ifneq (,$$($1_INCLUDES))
   108         $1_GREP_INCLUDE_PATTERNS:=$$(foreach src,$$($1_SRCS),\
   109 					$$(addprefix $$(src)/,$$($1_INCLUDES)))
   110         # If there are a lot of include patterns, output to file to shorten command lines
   111         ifeq ($$(word 20,$$($1_GREP_INCLUDE_PATTERNS)),)
   112             $1_GREP_INCLUDES:=| $(GREP) $$(patsubst %,$(SPACE)-e$(SPACE)$(DQUOTE)%$(DQUOTE),$$($1_GREP_INCLUDE_PATTERNS))
   113         else
   114             $1_GREP_INCLUDE_OUTPUT:=$(RM) $$($1_BIN)/_the.$$($1_JARNAME)_include && \
   115                                     $$(strip $$(call ListPathsSafely,$1_GREP_INCLUDE_PATTERNS,\n, \
   116                                         >> $$($1_BIN)/_the.$$($1_JARNAME)_include))
   117             $1_GREP_INCLUDES:=| $(GREP) -f $$($1_BIN)/_the.$$($1_JARNAME)_include
   118         endif
   119     endif
   120     ifneq (,$$($1_EXCLUDES)$$($1_EXCLUDE_FILES))
   121         $1_GREP_EXCLUDE_PATTERNS:=$$(foreach src,$$($1_SRCS),$$(addprefix $$(src)/,\
   122 		$$($1_EXCLUDES) $$($1_EXCLUDE_FILES)))
   123         # If there are a lot of include patterns, output to file to shorten command lines
   124         ifeq ($$(word 20,$$($1_GREP_EXCLUDE_PATTERNS)),)
   125             $1_GREP_EXCLUDES:=| $(GREP) -v $$(patsubst %,$(SPACE)-e$(SPACE)$(DQUOTE)%$(DQUOTE),$$($1_GREP_EXCLUDE_PATTERNS))
   126         else
   127             $1_GREP_EXCLUDE_OUTPUT=$(RM) $$($1_BIN)/_the.$$($1_JARNAME)_exclude && \
   128                                     $$(strip $$(call ListPathsSafely,$1_GREP_EXCLUDE_PATTERNS,\n, \
   129                                         >> $$($1_BIN)/_the.$$($1_JARNAME)_exclude))
   130             $1_GREP_EXCLUDES:=| $(GREP) -v -f $$($1_BIN)/_the.$$($1_JARNAME)_exclude
   131         endif
   132     endif
   134     # Check if this jar needs to have its index generated.
   135     ifneq (,$$($1_JARINDEX))
   136       $1_JARINDEX = (cd $$(dir $$@) && $(JAR) -i $$(notdir $$@))
   137     else
   138       $1_JARINDEX = true
   139     endif
   140     # When this macro is run in the same makefile as the java compilation, dependencies are 
   141     # transfered in make variables. When the macro is run in a different makefile than the 
   142     # java compilation, the dependencies need to be found in the filesystem.
   143     ifneq (,$2)
   144         $1_DEPS:=$2
   145     else
   146         $1_DEPS:=$$(filter $$(addprefix %,$$($1_SUFFIXES)),\
   147                     $$(call CacheFind,$$($1_SRCS)))
   148         ifneq (,$$($1_GREP_INCLUDE_PATTERNS))
   149             $1_DEPS:=$$(filter $$(addsuffix %,$$($1_GREP_INCLUDE_PATTERNS)),$$($1_DEPS))
   150         endif
   151         ifneq (,$$($1_GREP_EXCLUDE_PATTERNS))
   152             $1_DEPS:=$$(filter-out $$(addsuffix %,$$($1_GREP_EXCLUDE_PATTERNS)),$$($1_DEPS))
   153         endif
   154         # The subst of \ is needed because $ has to be escaped with \ in EXTRA_FILES for the command 
   155         # lines, but not here for use in make dependencies.
   156         $1_DEPS+=$$(subst \,,$$(foreach src,$$($1_SRCS),$$(addprefix $$(src)/,$$($1_EXTRA_FILES))))
   157         ifeq (,$$($1_SKIP_METAINF))
   158             $1_DEPS+=$$(call CacheFind,$$(wildcard $$(addsuffix /META-INF,$$($1_SRCS))))
   159         endif
   160     endif
   162     # Utility macros, to make the shell script receipt somewhat easier to decipher.
   164     # The capture contents macro finds all files (matching the patterns, typically
   165     # .class and .prp) that are newer than the jar-file, ie the new content to be put into the jar.
   166     $1_CAPTURE_CONTENTS=$$(foreach src,$$($1_SRCS),\
   167                    (($(FIND) $$(src) -type f -a \( $$($1_FIND_PATTERNS) \) -a -newer $$@ $$($1_GREP_INCLUDES) \
   168                        $$($1_GREP_EXCLUDES) | $(SED) 's|$$(src)/||g' &&\
   169                        $(ECHO) $$(subst $$(src)/,,$$($1_EXTRA_FILES))) > \
   170                        $$(src)/_the.$$($1_JARNAME)_contents) $$(NEWLINE))
   171     # The capture metainf macro finds all files below the META-INF directory that are newer than the jar-file.
   172     ifeq (,$$($1_SKIP_METAINF))
   173         $1_CAPTURE_METAINF =$$(foreach src,$$($1_SRCS),($(FIND) $$(src)/META-INF -type f -a -newer $$@ 2> /dev/null | $(SED) 's|$$(src)/||g' >> $$(src)/_the.$$($1_JARNAME)_contents ) $$(NEWLINE))
   174     endif
   175     # The capture deletes macro finds all deleted files and concatenates them. The resulting file
   176     # tells us what to remove from the jar-file.
   177     $1_CAPTURE_DELETES=$$(foreach src,$$($1_SRCS),($(FIND) $$(src) -name _the.package.deleted -newer $$@ -exec $(SED) 's|$$(src)||g' \{\} >> $$($1_DELETES_FILE) \;) $$(NEWLINE))
   178     # The update contents macro updates the jar file with the previously capture contents.
   179     # xargs is used to trim the whitespace from the contents file, to see if it is empty.
   180     $1_UPDATE_CONTENTS=$$(foreach src,$$($1_SRCS),\
   181                     (cd $$(src) && \
   182                      if [ -n "`$(CAT) _the.$$($1_JARNAME)_contents | $(XARGS)`" ]; then \
   183                          $(ECHO) "  updating" `$(WC) -l _the.$$($1_JARNAME)_contents | $(AWK) '{ print $$$$1 }'` files && \
   184                          $(JAR) $$($1_JAR_UPDATE_OPTIONS) $$@ @_the.$$($1_JARNAME)_contents; \
   185                      fi) $$(NEWLINE))
   186     # The s-variants of the above macros are used when the jar is created from scratch.
   187     $1_SCAPTURE_CONTENTS=$$(foreach src,$$($1_SRCS),\
   188                     (($(FIND) $$(src) -type f -a \( $$($1_FIND_PATTERNS) \) $$($1_GREP_INCLUDES) \
   189 			$$($1_GREP_EXCLUDES) | $(SED) 's|$$(src)/||g' &&\
   190 			$$(subst $$(src)/,,$(ECHO) $$($1_EXTRA_FILES))) > \
   191 			$$(src)/_the.$$($1_JARNAME)_contents) $$(NEWLINE))
   193     ifeq (,$$($1_SKIP_METAINF))
   194         $1_SCAPTURE_METAINF=$$(foreach src,$$($1_SRCS),\
   195                     ($(FIND) $$(src)/META-INF -type f 2> /dev/null | $(SED) 's|$$(src)/||g' >> \
   196 			$$(src)/_the.$$($1_JARNAME)_contents) $$(NEWLINE))
   197     endif
   198     $1_SUPDATE_CONTENTS=$$(foreach src,$$($1_SRCS),\
   199                     (cd $$(src) && $(JAR) $$($1_JAR_UPDATE_OPTIONS) $$@ @$$(src)/_the.$$($1_JARNAME)_contents) $$(NEWLINE))
   201     # Use a slightly shorter name for logging, but with enough path to identify this jar.
   202     $1_NAME:=$$(subst $$(OUTPUT_ROOT)/,,$$($1_JAR))
   204     ifneq (,$$($1_CHECK_COMPRESS_JAR))
   205         $1_JAR_CREATE_OPTIONS := c0fm
   206         $1_JAR_UPDATE_OPTIONS := u0f
   207         ifeq ($(COMPRESS_JARS), true)
   208             $1_JAR_CREATE_OPTIONS := cfm
   209             $1_JAR_UPDATE_OPTIONS := uf
   210         endif
   211     else
   212         $1_JAR_CREATE_OPTIONS := cfm
   213         $1_JAR_UPDATE_OPTIONS := uf
   214     endif
   216     # Here is the rule that creates/updates the jar file.
   217     $$($1_JAR) : $$($1_DEPS)
   218 	$(MKDIR) -p $$($1_BIN)
   219 	$$($1_GREP_INCLUDE_OUTPUT)
   220 	$$($1_GREP_EXCLUDE_OUTPUT)
   221 	$$(if $$($1_MANIFEST),\
   222 		$(SED) -e "s#@@RELEASE@@#$(RELEASE)#"           \
   223 		       -e "s#@@COMPANY_NAME@@#$(COMPANY_NAME)#" $$($1_MANIFEST) > $$($1_MANIFEST_FILE) \
   224 	,\
   225 		$(RM) $$($1_MANIFEST_FILE) && $(TOUCH) $$($1_MANIFEST_FILE))
   226 	$$(if $$($1_JARMAIN),$(ECHO) "Main-Class: $$(strip $$($1_JARMAIN))" >> $$($1_MANIFEST_FILE))
   227 	$$(if $$($1_EXTRA_MANIFEST_ATTR),$(PRINTF) "$$($1_EXTRA_MANIFEST_ATTR)\n" >> $$($1_MANIFEST_FILE))
   228 	$$(if $$(wildcard $$@),\
   229 		$(ECHO) Modifying $$($1_NAME) $$(NEWLINE)\
   230 		$$($1_CAPTURE_CONTENTS) \
   231 		$$($1_CAPTURE_METAINF) \
   232 		$(RM) $$($1_DELETES_FILE) $$(NEWLINE)\
   233 		$$($1_CAPTURE_DELETES) \
   234 		$(CAT) $$($1_DELETES_FILE) > $$($1_DELETESS_FILE) $$(NEWLINE)\
   235 		if [ -s $$($1_DELETESS_FILE) ]; then \
   236 			$(ECHO) "  deleting" `$(WC) -l $$($1_DELETESS_FILE) | $(AWK) '{ print $$$$1 }'` files && \
   237 	                       $(ZIP) -q -d $$@ `$(CAT) $$($1_DELETESS_FILE)` ; \
   238 		fi $$(NEWLINE) \
   239 		$$($1_UPDATE_CONTENTS) true $$(NEWLINE) \
   240 		$$($1_JARINDEX) && true \
   241 	,\
   242 		$(ECHO) Creating $$($1_NAME) && $(JAR) $$($1_JAR_CREATE_OPTIONS) $$@ $$($1_MANIFEST_FILE) $$(NEWLINE) \
   243 	        $$($1_SCAPTURE_CONTENTS) \
   244 		$$($1_SCAPTURE_METAINF) \
   245 		$$($1_SUPDATE_CONTENTS) \
   246 		$$($1_JARINDEX) && true ) 
   248 endef
   250 define SetupZipArchive
   251     # param 1 is for example ZIP_MYSOURCE
   252     # param 2,3,4,5,6,7,8,9 are named args.
   253     #    SRC,ZIP,INCLUDES,INCLUDE_FILES,EXCLUDES,EXCLUDE_FILES,SUFFIXES,EXTRA_DEPS
   254     $(foreach i,2 3 4 5 6 7 8 9 10 11 12 13 14 15, $(if $($i),$1_$(strip $($i)))$(NEWLINE))
   255     $(call LogSetupMacroEntry,SetupZipArchive($1),$2,$3,$4,$5,$6,$7,$8,$9,$(10),$(11),$(12),$(13),$(14),$(15))
   256     $(if $(16),$(error Internal makefile error: Too many arguments to SetupZipArchive, please update JavaCompilation.gmk))
   258     # To avoid running find over too large sets of files, which causes make to crash
   259     # on some configurations (cygwin), use INCLUDES and INCLUDE_FILES to build a set
   260     # of directories to run find in, if available.
   261     ifneq ($$($1_INCLUDES)$$($1_INCLUDE_FILES),)
   262 	$1_FIND_LIST := $$(wildcard $$(foreach i,$$($1_SRC),\
   263 		$$(addprefix $$i/,$$($1_INCLUDES) $$($1_INCLUDE_FILES))))
   264     else
   265         $1_FIND_LIST := $$($1_SRC)
   266     endif
   268     # Find all files in the source tree.
   269     $1_ALL_SRCS := $$(call not-containing,_the.,\
   270             $$(filter $$(addprefix %,$$($1_SUFFIXES)),$$(call CacheFind,$$($1_FIND_LIST))))
   272     ifneq ($$($1_INCLUDES),)
   273         ifneq ($$($1_SUFFIXES),)
   274             $1_ZIP_INCLUDES := $$(foreach s,$$($1_SUFFIXES),\
   275 		$$(addprefix -i$(SPACE)$(DQUOTE),$$(addsuffix /*$$s$(DQUOTE),$$($1_INCLUDES))))
   276         else
   277             $1_ZIP_INCLUDES := $$(addprefix -i$(SPACE)$(DQUOTE),$$(addsuffix /*$(DQUOTE),$$($1_INCLUDES)))
   278         endif
   279     endif
   280     ifneq ($$($1_INCLUDE_FILES),)
   281         $1_ZIP_INCLUDES += $$(addprefix -i$(SPACE),$$($1_INCLUDE_FILES))
   282     endif
   283     ifneq ($$($1_EXCLUDES),)
   284         $1_SRC_EXCLUDES := $$(foreach i,$$($1_SRC),$$(addprefix $$i/,$$(addsuffix /%,$$($1_EXCLUDES))))
   285         $1_ZIP_EXCLUDES := $$(addprefix -x$(SPACE)$(DQUOTE),$$(addsuffix /*$(DQUOTE),$$($1_EXCLUDES)))
   286         $1_ALL_SRCS     := $$(filter-out $$($1_SRC_EXCLUDES),$$($1_ALL_SRCS))
   287     endif
   289     # Use a slightly shorter name for logging, but with enough path to identify this zip.
   290     $1_NAME:=$$(subst $$(OUTPUT_ROOT)/,,$$($1_ZIP))
   292     # Now $1_ALL_SRCS should contain all sources that are going to be put into the zip.
   293     # I.e. the zip -i and -x options should match the filtering done in the makefile.
   294     # Explicitly excluded files can be given with absolute path. The patsubst solution
   295     # isn't perfect but the likelyhood of an absolute path to match something in a src
   296     # dir is very small.
   297     # If zip has nothing to do, it returns 12 and would fail the build. Check for 12
   298     # and only fail if it's not.
   299     $$($1_ZIP) : $$($1_ALL_SRCS) $$($1_EXTRA_DEPS)
   300 		$(MKDIR) -p $$(@D)
   301 		$(ECHO) Updating $$($1_NAME)
   302 		$$(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
   303 		$(TOUCH) $$@
   304 endef
   306 define add_file_to_copy
   307     # param 1 = BUILD_MYPACKAGE
   308     # parma 2 = The source file to copy.
   309     $2_TARGET:=$2
   310     # Remove the source prefix. 
   311     $$(foreach i,$$($1_SRC),$$(eval $$(call remove_string,$$i,$2_TARGET)))
   312     # Now we can setup the depency that will trigger the copying.
   313     $$($1_BIN)$$($2_TARGET) : $2
   314 	$(MKDIR) -p $$(@D)
   315 	$(CP) $$< $$@
   316 	$(CHMOD) -f ug+w $$@
   318     # And do not forget this target
   319     $1_ALL_COPY_TARGETS += $$($1_BIN)$$($2_TARGET)
   320 endef
   323 # This macro is used only for properties files that are to be
   324 # copied over to the classes directory in cleaned form:
   325 # Previously this was inconsistently done in different repositories.
   326 # This is the new clean standard. Though it is to be superseded by
   327 # a standard annotation processor from with sjavac.
   328 define add_file_to_copy_and_clean
   329     # param 1 = BUILD_MYPACKAGE
   330     # parma 2 = The source file to copy and clean.
   331     $2_TARGET:=$2
   332     # Remove the source prefix. 
   333     $$(foreach i,$$($1_SRC),$$(eval $$(call remove_string,$$i,$2_TARGET)))
   334     # Now we can setup the depency that will trigger the copying.
   335     $$($1_BIN)$$($2_TARGET) : $2
   336 	$(MKDIR) -p $$(@D)
   337 	$(CAT) $$< | $(SED) -e 's/\([^\\]\):/\1\\:/g' -e  's/\([^\\]\)=/\1\\=/g' -e 's/#.*/#/g' \
   338                    | $(SED) -f "$(SRC_ROOT)/common/makefiles/support/unicode2x.sed" \
   339 		   | $(SED) -e '/^#/d' -e '/^$$$$/d' \
   340 		            -e :a -e '/\\$$$$/N; s/\\\n//; ta' \
   341 			    -e 's/^[ \t]*//;s/[ \t]*$$$$//' \
   342 			    -e 's/\\=/=/' | LANG=C $(SORT) > $$@
   343 	$(CHMOD) -f ug+w $$@
   345     # And do not forget this target
   346     $1_ALL_COPY_CLEAN_TARGETS += $$($1_BIN)$$($2_TARGET)
   347 endef
   349 define remove_string
   350     $2 := $$(subst $1,,$$($2))
   351 endef
   353 define replace_space_with_pathsep
   354     $1:=$(subst $(SPACE),$(PATH_SEP),$(strip $(patsubst %,%,$2)))
   355 endef
   357 define SetupJavaCompilation
   358     # param 1 is for example BUILD_MYPACKAGE
   359     # param 2,3,4,5,6,7,8 are named args.
   360     #    SETUP:=must point to a previously setup java compiler, for example: SETUP:=BOOTJAVAC
   361     #    JVM:=path to ..bin/java
   362     #    ADD_JAVAC_FLAGS:=javac flags to append to the default ones.
   363     #    SRC:=one or more directories to search for sources
   364     #    BIN:=store classes here
   365     #    INCLUDES:=myapp.foo means will only compile java files in myapp.foo or any of its sub-packages.
   366     #    EXCLUDES:=myapp.foo means will do not compile java files in myapp.foo or any of its sub-packages.
   367     #    COPY:=.prp means copy all prp files to the corresponding package in BIN.
   368     #    CLEAN:=.properties means copy and clean all properties file to the corresponding package in BIN.
   369     #    COPY_FILES:=myapp/foo/setting.txt means copy this file over to the package myapp/foo
   370     #    SRCZIP:=Create a src.zip based on the found sources and copied files.
   371     #    INCLUDE_FILES:="com/sun/SolarisFoobar.java" means only compile this file!
   372     #    EXCLUDE_FILES:="com/sun/SolarisFoobar.java" means do not compile this particular file!
   373     #                   "SolarisFoobar.java" means do not compile SolarisFoobar, wherever it is found.
   374     #    JAVAC_SOURCE_PATH_UGLY_OVERRIDE:=Don't use this. This forces an explicit -sourcepath to javac.
   375     #                                     Its only here until we cleanup some nasty source code pasta in the jdk.
   376     #    HEADERS:=path to directory where all generated c-headers are written.
   377     #    DEPENDS:=Extra dependecy
   378     $(foreach i,2 3 4 5 6 7 8 9 10 11 12 13 14 15, $(if $($i),$1_$(strip $($i)))$(NEWLINE))
   379     $(call LogSetupMacroEntry,SetupJavaCompilation($1),$2,$3,$4,$5,$6,$7,$8,$9,$(10),$(11),$(12),$(13),$(14),$(15))
   380     $(if $(16),$(error Internal makefile error: Too many arguments to SetupJavaCompilation, please update JavaCompilation.gmk))
   382     # Extract the info from the java compiler setup.
   383     $1_JVM   := $$($$($1_SETUP)_JVM)
   384     $1_JAVAC := $$($$($1_SETUP)_JAVAC)
   385     $1_FLAGS := $$($$($1_SETUP)_FLAGS) $(JAVAC_FLAGS) $$($1_ADD_JAVAC_FLAGS)
   386     ifeq ($$($1_JAVAC),)
   387         $$(error The Java compilation $1 refers to a non-existant java compiler setup $$($1_SETUP))
   388     endif
   389     $1_SJAVAC_PORTFILE := $$($$($1_SETUP)_SJAVAC_PORTFILE)
   390     $1_SERVER_JVM := $$($$($1_SETUP)_SERVER_JVM)
   392     # Handle addons and overrides.
   393     $1_SRC:=$$(call ADD_SRCS,$$($1_SRC))
   394     # Make sure the dirs exist.
   395     $$(foreach d,$$($1_SRC), $$(if $$(wildcard $$d),,$$(error SRC specified to SetupJavaCompilation $1 contains missing directory $$d)))
   396     $$(eval $$(call MakeDir,$$($1_BIN)))
   397     # Find all files in the source trees.
   398     $1_ALL_SRCS += $$(filter-out $(OVR_SRCS),$$(call CacheFind,$$($1_SRC)))
   399     # Extract the java files.
   400     ifneq ($$($1_EXCLUDE_FILES),)
   401         $1_EXCLUDE_FILES_PATTERN:=$$(addprefix %,$$($1_EXCLUDE_FILES))
   402     endif
   403     $1_SRCS     := $$(filter-out $$($1_EXCLUDE_FILES_PATTERN),$$(filter %.java,$$($1_ALL_SRCS)))
   404     ifneq ($$($1_INCLUDE_FILES),)
   405         $1_INCLUDE_FILES:=$$(foreach i,$$($1_SRC),$$(addprefix $$i/,$$($1_INCLUDE_FILES)))
   406         $1_SRCS := $$(filter $$($1_INCLUDE_FILES), $$($1_SRCS))
   407     endif
   409     # Now we have a list of all java files to compile: $$($1_SRCS)
   411     # Create the corresponding smart javac wrapper command line.
   412     $1_SJAVAC_ARGS:=$$(addprefix -x ,$$(addsuffix .*,$$(subst /,.,$$($1_EXCLUDES)))) \
   413 		$$(addprefix -i ,$$(addsuffix .*,$$(subst /,.,$$($1_INCLUDES)))) \
   414 		$$(addprefix -xf *,$$(strip $$($1_EXCLUDE_FILES))) \
   415 		$$(addprefix -if *,$$(strip $$($1_INCLUDE_FILES))) \
   416 		-src "$$(subst $$(SPACE),$$(PATH_SEP),$$(strip $$($1_SRC)))"
   418     # Prepend the source/bin path to the filter expressions.
   419     ifneq ($$($1_INCLUDES),)
   420         $1_SRC_INCLUDES := $$(foreach i,$$($1_SRC),$$(addprefix $$i/,$$(addsuffix /%,$$($1_INCLUDES))))
   421         $1_SRCS     := $$(filter $$($1_SRC_INCLUDES),$$($1_SRCS))
   422     endif
   423     ifneq ($$($1_EXCLUDES),)
   424         $1_SRC_EXCLUDES := $$(foreach i,$$($1_SRC),$$(addprefix $$i/,$$(addsuffix /%,$$($1_EXCLUDES))))
   425         $1_SRCS     := $$(filter-out $$($1_SRC_EXCLUDES),$$($1_SRCS))
   426     endif
   428     # Find all files to be copied from source to bin.
   429     ifneq (,$$($1_COPY))
   430         # Search for all files to be copied.
   431         $1_ALL_COPIES := $$(filter $$(addprefix %,$$($1_COPY)),$$($1_ALL_SRCS))
   432         # Copy these explicitly
   433         $1_ALL_COPIES += $$($1_COPY_FILES)
   434         # Copy must also respect filters.
   435         ifneq (,$$($1_INCLUDES))
   436             $1_ALL_COPIES := $$(filter $$($1_SRC_INCLUDES),$$($1_ALL_COPIES))
   437         endif
   438         ifneq (,$$($1_EXCLUDES))
   439             $1_ALL_COPIES := $$(filter-out $$($1_SRC_EXCLUDES),$$($1_ALL_COPIES))
   440         endif
   441         ifneq (,$$($1_EXCLUDE_FILES))
   442             $1_ALL_COPIES := $$(filter-out $$($1_EXCLUDE_FILES_PATTERN),$$($1_ALL_COPIES))
   443         endif
   444         # All files below META-INF are always copied.
   445         $1_ALL_COPIES += $$(filter $$(addsuffix /META-INF%,$$($1_SRC)),$$($1_ALL_SRCS))
   446         ifneq (,$$($1_ALL_COPIES))
   447             # Yep, there are files to be copied!
   448             $1_ALL_COPY_TARGETS:=
   449             $$(foreach i,$$($1_ALL_COPIES),$$(eval $$(call add_file_to_copy,$1,$$i)))
   450             # Now we can depend on $$($1_ALL_COPY_TARGETS) to copy all files!
   451         endif
   452     endif
   454     # Find all property files to be copied and cleaned from source to bin.
   455     ifneq (,$$($1_CLEAN))
   456         # Search for all files to be copied.
   457         $1_ALL_CLEANS := $$(filter $$(addprefix %,$$($1_CLEAN)),$$($1_ALL_SRCS))
   458         # Copy and clean must also respect filters.
   459         ifneq (,$$($1_INCLUDES))
   460             $1_ALL_CLEANS := $$(filter $$($1_SRC_INCLUDES),$$($1_ALL_CLEANS))
   461         endif
   462         ifneq (,$$($1_EXCLUDES))
   463             $1_ALL_CLEANS := $$(filter-out $$($1_SRC_EXCLUDES),$$($1_ALL_CLEANS))
   464         endif
   465         ifneq (,$$($1_EXCLUDE_FILES))
   466             $1_ALL_CLEANS := $$(filter-out $$($1_EXCLUDE_FILES_PATTERN),$$($1_ALL_CLEANS))
   467         endif
   468         ifneq (,$$($1_ALL_CLEANS))
   469             # Yep, there are files to be copied and cleaned!
   470             $1_ALL_COPY_CLEAN_TARGETS:=
   471             $$(foreach i,$$($1_ALL_CLEANS),$$(eval $$(call add_file_to_copy_and_clean,$1,$$i)))
   472             # Now we can depend on $$($1_ALL_COPY_CLEAN_TARGETS) to copy all files!
   473         endif
   474     endif
   476     # Prep the source paths.
   477     ifneq ($$($1_JAVAC_SOURCE_PATH_UGLY_OVERRIDE),)
   478       $$(eval $$(call replace_space_with_pathsep,$1_SRCROOTSC,$$($1_JAVAC_SOURCE_PATH_UGLY_OVERRIDE)))
   479     else
   480       $$(eval $$(call replace_space_with_pathsep,$1_SRCROOTSC,$$($1_SRC)))
   481     endif
   483     # Create a sed expression to remove the source roots and to replace / with .
   484     # and remove .java at the end. 
   485     $1_REWRITE_INTO_CLASSES:=$$(foreach i,$$($1_SRC),-e 's|$$i/||g') -e 's|/|.|g' -e 's|.java$$$$||g'
   487     ifeq ($$($1_DISABLE_SJAVAC)x$$(ENABLE_SJAVAC),xyes)
   488         ifneq (,$$($1_HEADERS))
   489             $1_HEADERS_ARG := -h $$($1_HEADERS)
   490         endif
   492         # Using sjavac to compile. 
   493         $1 := $$($1_ALL_COPY_TARGETS) $$($1_ALL_COPY_CLEAN_TARGETS) $$($1_BIN)/javac_state
   495         # Create SJAVAC variable form JAVAC variable. Expects $1_JAVAC to be 
   496         # "bootclasspathprepend -cp .../javac.jar com.sun.tools.javac.Main"
   497         # and javac is simply replaced with sjavac.
   498         $1_SJAVAC:=$$(subst com.sun.tools.javac.Main,com.sun.tools.sjavac.Main,$$($1_JAVAC))
   500         # Set the $1_REMOTE to spawn a background javac server.
   501         $1_REMOTE:=--server:portfile=$$($1_SJAVAC_PORTFILE),id=$1,sjavac=$$(subst $$(SPACE),%20,$$(subst $$(COMMA),%2C,$$(strip $$($1_SERVER_JVM) $$($1_SJAVAC))))
   503         $$($1_BIN)/javac_state: $$($1_SRCS) $$($1_DEPENDS)
   504 		$(MKDIR) -p $$(@D)
   505 		$$(call ListPathsSafely,$1_SRCS,\n, >> $$($1_BIN)/_the.batch.tmp)
   506 		$(ECHO) Compiling $1
   507 		($$($1_JVM) $$($1_SJAVAC) \
   508 			$$($1_REMOTE) \
   509 			-j $(JOBS) \
   510 			--permit-unidentified-artifacts \
   511 			--permit-sources-without-package \
   512 			--compare-found-sources $$($1_BIN)/_the.batch.tmp \
   513 			--log=$(LOG_LEVEL) \
   514 			$$($1_SJAVAC_ARGS) \
   515 			$$($1_FLAGS) \
   516 			$$($1_HEADERS_ARG) \
   517 			-d $$($1_BIN) && \
   518 			$(MV) $$($1_BIN)/_the.batch.tmp $$($1_BIN)/_the.batch)
   519     else
   520         # Using plain javac to batch compile everything.
   521         $1 := $$($1_ALL_COPY_TARGETS) $$($1_ALL_COPY_CLEAN_TARGETS) $$($1_BIN)/_the.batch
   523         # When building in batch, put headers in a temp dir to filter out those that actually
   524         # changed before copying them to the real header dir.
   525         ifneq (,$$($1_HEADERS))
   526             $1_HEADERS_ARG := -h $$($1_HEADERS).tmp
   528             $$($1_HEADERS)/_the.headers: $$($1_BIN)/_the.batch
   529 		$(MKDIR) -p $$(@D)
   530 		for f in `ls $$($1_HEADERS).tmp`; do \
   531 		  if [ ! -f "$$($1_HEADERS)/$$$$f" ] || [ "`$(DIFF) $$($1_HEADERS)/$$$$f $$($1_HEADERS).tmp/$$$$f`" != "" ]; then \
   532 		    $(CP) -f $$($1_HEADERS).tmp/$$$$f $$($1_HEADERS)/$$$$f; \
   533 		  fi; \
   534 		done
   535 		$(RM) -r $$($1_HEADERS).tmp
   536 		$(TOUCH) $$@
   538             $1 += $$($1_HEADERS)/_the.headers
   539         endif
   541         # When not using sjavac, pass along all sources to javac using an @file.
   542         $$($1_BIN)/_the.batch: $$($1_SRCS) $$($1_DEPENDS)
   543 		$(MKDIR) -p $$(@D)
   544 		$(RM) $$($1_BIN)/_the.batch $$($1_BIN)/_the.batch.tmp
   545 		$$(call ListPathsSafely,$1_SRCS,\n, >> $$($1_BIN)/_the.batch.tmp)
   546 		$(ECHO) Compiling `$(WC) $$($1_BIN)/_the.batch.tmp | $(TR) -s ' ' | $(CUT) -f 2 -d ' '` files for $1
   547 		($$($1_JVM) $$($1_JAVAC) $$($1_FLAGS) \
   548 			-implicit:none -sourcepath "$$($1_SRCROOTSC)" \
   549 			-d $$($1_BIN) $$($1_HEADERS_ARG) @$$($1_BIN)/_the.batch.tmp && \
   550 			$(MV) $$($1_BIN)/_the.batch.tmp $$($1_BIN)/_the.batch)
   552     endif
   554     # Check if a jar file was specified, then setup the rules for the jar.
   555     ifneq (,$$($1_JAR))
   556         # If no suffixes was explicitly set for this jar file.
   557         # Use class and the cleaned/copied properties file suffixes as the default
   558         # for the types of files to be put into the jar.
   559         ifeq (,$$($1_SUFFIXES))
   560             $1_SUFFIXES:=.class $$($1_CLEAN) $$($1_COPY)
   561         endif
   563         $$(eval $$(call SetupArchive,ARCHIVE_$1,$$($1),\
   564 		SRCS:=$$($1_BIN),\
   565 		SUFFIXES:=$$($1_SUFFIXES),\
   566 		EXCLUDE:=$$($1_EXCLUDES),\
   567 		INCLUDES:=$$($1_INCLUDES),\
   568 		EXTRA_FILES:=$$($1_ALL_COPY_TARGETS) $$($1_ALL_COPY_CLEAN_TARGETS),\
   569 		JAR:=$$($1_JAR),\
   570 		JARMAIN:=$$($1_JARMAIN),\
   571 		MANIFEST:=$$($1_MANIFEST),\
   572 		EXTRA_MANIFEST_ATTR:=$$($1_EXTRA_MANIFEST_ATTR),\
   573 		JARINDEX:=$$($1_JARINDEX),\
   574 		HEADERS:=$$($1_HEADERS),\
   575 		SETUP:=$$($1_SETUP)))
   576     endif
   578     # Check if a srczip was specified, then setup the rules for the srczip.
   579     ifneq (,$$($1_SRCZIP))
   580         $$(eval $$(call SetupZipArchive,ARCHIVE_$1,\
   581 		SRC:=$$($1_SRC),\
   582 		ZIP:=$$($1_SRCZIP),\
   583 		INCLUDES:=$$($1_INCLUDES),\
   584 		EXCLUDES:=$$($1_EXCLUDES),\
   585 		EXCLUDE_FILES:=$$($1_EXCLUDE_FILES)))
   586     endif
   588 endef

mercurial