common/makefiles/JavaCompilation.gmk

Thu, 10 Jan 2013 19:36:13 -0800

author
jjg
date
Thu, 10 Jan 2013 19:36:13 -0800
changeset 592
1129fb75f611
parent 531
6b96b7744913
child 557
d2c1f80118de
permissions
-rw-r--r--

8004834: Add doclint support into javadoc
Reviewed-by: erikj, tbell

     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 BOOT_JAVAC or NEW_JAVAC
    46     # This is the name later used to decide which java compiler to use.
    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),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             $$(shell $(MKDIR) -p $$($1_BIN) && $(RM) $$($1_BIN)/_the.$$($1_JARNAME)_include)
   115             $$(eval $$(call ListPathsSafelyNow,$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             $$(shell $(MKDIR) -p $$($1_BIN) && $(RM) $$($1_BIN)/_the.$$($1_JARNAME)_exclude)
   128             $$(eval $$(call ListPathsSafelyNow,$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 transfered
   141     # in make variables. When the macro is run in a different makefile than the java compilation, the 
   142     # dependencies need to be found in the filesystem.
   143     ifneq (,$2)
   144         $1_DEPS:=$2
   145     else
   146         # The subst of \ is needed because $ has to be escaped with \ in EXTRA_FILES for the command 
   147         # lines, but not here for use in make dependencies.
   148         $1_DEPS:=$$(shell $(FIND) $$($1_SRCS) -type f -a \( $$($1_FIND_PATTERNS) \) \
   149 			  $$($1_GREP_INCLUDES) $$($1_GREP_EXCLUDES)) \
   150 		 $$(subst \,,$$(foreach src,$$($1_SRCS),$$(addprefix $$(src)/,$$($1_EXTRA_FILES))))
   151         ifeq (,$$($1_SKIP_METAINF))
   152             $1_DEPS+=$$(shell $(FIND) $$(addsuffix /META-INF,$$($1_SRCS)) -type f 2> /dev/null)
   153         endif
   154     endif
   156     # Utility macros, to make the shell script receipt somewhat easier to dechipher.
   158     # The capture contents macro finds all files (matching the patterns, typically
   159     # .class and .prp) that are newer than the jar-file, ie the new content to be put into the jar.
   160     $1_CAPTURE_CONTENTS=$$(foreach src,$$($1_SRCS),\
   161                    (($(FIND) $$(src) -type f -a \( $$($1_FIND_PATTERNS) \) -a -newer $$@ $$($1_GREP_INCLUDES) \
   162                        $$($1_GREP_EXCLUDES) | $(SED) 's|$$(src)/||g' &&\
   163                        $(ECHO) $$(subst $$(src)/,,$$($1_EXTRA_FILES))) > \
   164                        $$(src)/_the.$$($1_JARNAME)_contents) $$(NEWLINE))
   165     # The capture metainf macro finds all files below the META-INF directory that are newer than the jar-file.
   166     ifeq (,$$($1_SKIP_METAINF))
   167         $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))
   168     endif
   169     # The capture deletes macro finds all deleted files and concatenates them. The resulting file
   170     # tells us what to remove from the jar-file.
   171     $1_CAPTURE_DELETES=$$(foreach src,$$($1_SRCS),($(FIND) $$(src) -name _the.package.deleted -newer $$@ -exec $(SED) 's|$$(src)||g' \{\} >> $$($1_DELETES_FILE) \;) $$(NEWLINE))
   172     # The update contents macro updates the jar file with the previously capture contents.
   173     # xargs is used to trim the whitespace from the contents file, to see if it is empty.
   174     $1_UPDATE_CONTENTS=$$(foreach src,$$($1_SRCS),\
   175                     (cd $$(src) && \
   176                      if [ -n "`$(CAT) _the.$$($1_JARNAME)_contents | $(XARGS)`" ]; then \
   177                          $(ECHO) "  updating" `$(WC) -l _the.$$($1_JARNAME)_contents | $(AWK) '{ print $$$$1 }'` files && \
   178                          $(JAR) $$($1_JAR_UPDATE_OPTIONS) $$@ @_the.$$($1_JARNAME)_contents; \
   179                      fi) $$(NEWLINE))
   180     # The s-variants of the above macros are used when the jar is created from scratch.
   181     $1_SCAPTURE_CONTENTS=$$(foreach src,$$($1_SRCS),\
   182                     (($(FIND) $$(src) -type f -a \( $$($1_FIND_PATTERNS) \) $$($1_GREP_INCLUDES) \
   183 			$$($1_GREP_EXCLUDES) | $(SED) 's|$$(src)/||g' &&\
   184 			$$(subst $$(src)/,,$(ECHO) $$($1_EXTRA_FILES))) > \
   185 			$$(src)/_the.$$($1_JARNAME)_contents) $$(NEWLINE))
   187     ifeq (,$$($1_SKIP_METAINF))
   188         $1_SCAPTURE_METAINF=$$(foreach src,$$($1_SRCS),\
   189                     ($(FIND) $$(src)/META-INF -type f 2> /dev/null | $(SED) 's|$$(src)/||g' >> \
   190 			$$(src)/_the.$$($1_JARNAME)_contents) $$(NEWLINE))
   191     endif
   192     $1_SUPDATE_CONTENTS=$$(foreach src,$$($1_SRCS),\
   193                     (cd $$(src) && $(JAR) $$($1_JAR_UPDATE_OPTIONS) $$@ @$$(src)/_the.$$($1_JARNAME)_contents) $$(NEWLINE))
   195     # Use a slightly shorter name for logging, but with enough path to identify this jar.
   196     $1_NAME:=$$(subst $$(OUTPUT_ROOT)/,,$$($1_JAR))
   198     ifneq (,$$($1_CHECK_COMPRESS_JAR))
   199         $1_JAR_CREATE_OPTIONS := c0fm
   200         $1_JAR_UPDATE_OPTIONS := u0f
   201         ifeq ($(COMPRESS_JARS), true)
   202             $1_JAR_CREATE_OPTIONS := cfm
   203             $1_JAR_UPDATE_OPTIONS := uf
   204         endif
   205     else
   206         $1_JAR_CREATE_OPTIONS := cfm
   207         $1_JAR_UPDATE_OPTIONS := uf
   208     endif
   210     # Here is the rule that creates/updates the jar file.
   211     $$($1_JAR) : $$($1_DEPS)
   212 	$(MKDIR) -p $$($1_BIN)
   213 	$$(if $$($1_MANIFEST),\
   214 		$(SED) -e "s#@@RELEASE@@#$(RELEASE)#"           \
   215 		       -e "s#@@COMPANY_NAME@@#$(COMPANY_NAME)#" $$($1_MANIFEST) > $$($1_MANIFEST_FILE) \
   216 	,\
   217 		$(RM) $$($1_MANIFEST_FILE) && $(TOUCH) $$($1_MANIFEST_FILE))
   218 	$$(if $$($1_JARMAIN),$(ECHO) "Main-Class: $$(strip $$($1_JARMAIN))" >> $$($1_MANIFEST_FILE))
   219 	$$(if $$($1_EXTRA_MANIFEST_ATTR),$(PRINTF) "$$($1_EXTRA_MANIFEST_ATTR)\n" >> $$($1_MANIFEST_FILE))
   220 	$$(if $$(wildcard $$@),\
   221 		$(ECHO) Modifying $$($1_NAME) $$(NEWLINE)\
   222 		$$($1_CAPTURE_CONTENTS) \
   223 		$$($1_CAPTURE_METAINF) \
   224 		$(RM) $$($1_DELETES_FILE) $$(NEWLINE)\
   225 		$$($1_CAPTURE_DELETES) \
   226 		$(CAT) $$($1_DELETES_FILE) > $$($1_DELETESS_FILE) $$(NEWLINE)\
   227 		if [ -s $$($1_DELETESS_FILE) ]; then \
   228 			$(ECHO) "  deleting" `$(WC) -l $$($1_DELETESS_FILE) | $(AWK) '{ print $$$$1 }'` files && \
   229 	                       $(ZIP) -q -d $$@ `$(CAT) $$($1_DELETESS_FILE)` ; \
   230 		fi $$(NEWLINE) \
   231 		$$($1_UPDATE_CONTENTS) true $$(NEWLINE) \
   232 		$$($1_JARINDEX) && true \
   233 	,\
   234 		$(ECHO) Creating $$($1_NAME) && $(JAR) $$($1_JAR_CREATE_OPTIONS) $$@ $$($1_MANIFEST_FILE) $$(NEWLINE) \
   235 	        $$($1_SCAPTURE_CONTENTS) \
   236 		$$($1_SCAPTURE_METAINF) \
   237 		$$($1_SUPDATE_CONTENTS) \
   238 		$$($1_JARINDEX) && true ) 
   240 endef
   242 define SetupZipArchive
   243     # param 1 is for example ZIP_MYSOURCE
   244     # param 2,3,4,5,6,7,8,9 are named args.
   245     #    SRC,ZIP,INCLUDES,EXCLUDES,EXCLUDE_FILES,SUFFIXES,EXTRA_DEPS
   246     $(foreach i,2 3 4 5 6 7 8 9 10 11 12 13 14 15, $(if $($i),$1_$(strip $($i)))$(NEWLINE))
   247     $(call LogSetupMacroEntry,SetupZipArchive($1),$2,$3,$4,$5,$6,$7,$8,$9,$(10),$(11),$(12),$(13),$(14),$(15))
   248     $(if $(16),$(error Internal makefile error: Too many arguments to SetupZipArchive, please update JavaCompilation.gmk))
   250     # Find all files in the source tree.
   251     $1_SUFFIX_FILTER := $$(patsubst %,-o -name $(DQUOTE)*%$(DQUOTE),$$($1_SUFFIXES))
   252     $1_ALL_SRCS := $$(foreach i,$$($1_SRC), $$(shell $(FIND) $$i -type f -a ! -name "_the.*" \( -name FALSE_DUMMY  $$($1_SUFFIX_FILTER) \) ))
   254     ifneq ($$($1_INCLUDES),)
   255         $1_SRC_INCLUDES := $$(foreach i,$$($1_SRC),$$(addprefix $$i/,$$(addsuffix /%,$$($1_INCLUDES))))
   256         ifneq ($$($1_SUFFIXES),)
   257             $1_ZIP_INCLUDES := $$(foreach s,$$($1_SUFFIXES),\
   258 		$$(addprefix -i$(SPACE)$(DQUOTE),$$(addsuffix /*$$s$(DQUOTE),$$($1_INCLUDES))))
   259         else
   260             $1_ZIP_INCLUDES := $$(addprefix -i$(SPACE)$(DQUOTE),$$(addsuffix /*$(DQUOTE),$$($1_INCLUDES)))
   261         endif
   262         $1_ALL_SRCS     := $$(filter $$($1_SRC_INCLUDES),$$($1_ALL_SRCS))
   263     endif
   264     ifneq ($$($1_EXCLUDES),)
   265         $1_SRC_EXCLUDES := $$(foreach i,$$($1_SRC),$$(addprefix $$i/,$$(addsuffix /%,$$($1_EXCLUDES))))
   266         $1_ZIP_EXCLUDES := $$(addprefix -x$(SPACE)$(DQUOTE),$$(addsuffix /*$(DQUOTE),$$($1_EXCLUDES)))
   267         $1_ALL_SRCS     := $$(filter-out $$($1_SRC_EXCLUDES),$$($1_ALL_SRCS))
   268     endif
   270     # Use a slightly shorter name for logging, but with enough path to identify this zip.
   271     $1_NAME:=$$(subst $$(OUTPUT_ROOT)/,,$$($1_ZIP))
   273     # Now $1_ALL_SRCS should contain all sources that are going to be put into the zip.
   274     # I.e. the zip -i and -x options should match the filtering done in the makefile.
   275     # Explicitly excluded files can be given with absolute path. The patsubst solution
   276     # isn't perfect but the likelyhood of an absolute path to match something in a src
   277     # dir is very small.
   278     # If zip has nothing to do, it returns 12 and would fail the build. Check for 12
   279     # and only fail if it's not.
   280     $$($1_ZIP) : $$($1_ALL_SRCS) $$($1_EXTRA_DEPS)
   281 		$(MKDIR) -p $$(@D)
   282 		$(ECHO) Updating $$($1_NAME)
   283 		$$(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
   284 		$(TOUCH) $$@
   285 endef
   287 define add_file_to_copy
   288     # param 1 = BUILD_MYPACKAGE
   289     # parma 2 = The source file to copy.
   290     $2_TARGET:=$2
   291     # Remove the source prefix. 
   292     $$(foreach i,$$($1_SRC),$$(eval $$(call remove_string,$$i,$2_TARGET)))
   293     # Now we can setup the depency that will trigger the copying.
   294     $$($1_BIN)$$($2_TARGET) : $2
   295 	$(MKDIR) -p $$(@D)
   296 	$(CP) $$< $$@
   297 	$(CHMOD) -f ug+w $$@
   299     # And do not forget this target
   300     $1_ALL_COPY_TARGETS += $$($1_BIN)$$($2_TARGET)
   301 endef
   304 # This macro is used only for properties files that are to be
   305 # copied over to the classes directory in cleaned form:
   306 # Previously this was inconsistently done in different repositories.
   307 # This is the new clean standard. Though it is to be superseded by
   308 # a standard annotation processor from with sjavac.
   309 define add_file_to_copy_and_clean
   310     # param 1 = BUILD_MYPACKAGE
   311     # parma 2 = The source file to copy and clean.
   312     $2_TARGET:=$2
   313     # Remove the source prefix. 
   314     $$(foreach i,$$($1_SRC),$$(eval $$(call remove_string,$$i,$2_TARGET)))
   315     # Now we can setup the depency that will trigger the copying.
   316     $$($1_BIN)$$($2_TARGET) : $2
   317 	$(MKDIR) -p $$(@D)
   318 	$(CAT) $$< | $(SED) -e 's/\([^\\]\):/\1\\:/g' -e  's/\([^\\]\)=/\1\\=/g' -e 's/#.*/#/g' \
   319                    | $(SED) -f "$(SRC_ROOT)/common/makefiles/support/unicode2x.sed" \
   320 		   | $(SED) -e '/^#/d' -e '/^$$$$/d' \
   321 		            -e :a -e '/\\$$$$/N; s/\\\n//; ta' \
   322 			    -e 's/^[ \t]*//;s/[ \t]*$$$$//' \
   323 			    -e 's/\\=/=/' | LANG=C $(SORT) > $$@
   324 	$(CHMOD) -f ug+w $$@
   326     # And do not forget this target
   327     $1_ALL_COPY_CLEAN_TARGETS += $$($1_BIN)$$($2_TARGET)
   328 endef
   330 define remove_string
   331     $2 := $$(subst $1,,$$($2))
   332 endef
   334 define replace_space_with_pathsep
   335     $1:=$(subst $(SPACE),$(PATH_SEP),$(strip $(patsubst %,%,$2)))
   336 endef
   338 define SetupJavaCompilation
   339     # param 1 is for example BUILD_MYPACKAGE
   340     # param 2,3,4,5,6,7,8 are named args.
   341     #    SETUP:=must point to a previously setup java compiler, for example: SETUP:=BOOTJAVAC
   342     #    JVM:=path to ..bin/java
   343     #    ADD_JAVAC_FLAGS:=javac flags to append to the default ones.
   344     #    SRC:=one or more directories to search for sources
   345     #    BIN:=store classes here
   346     #    INCLUDES:=myapp.foo means will only compile java files in myapp.foo or any of its sub-packages.
   347     #    EXCLUDES:=myapp.foo means will do not compile java files in myapp.foo or any of its sub-packages.
   348     #    COPY:=.prp means copy all prp files to the corresponding package in BIN.
   349     #    CLEAN:=.properties means copy and clean all properties file to the corresponding package in BIN.
   350     #    COPY_FILES:=myapp/foo/setting.txt means copy this file over to the package myapp/foo
   351     #    SRCZIP:=Create a src.zip based on the found sources and copied files.
   352     #    INCLUDE_FILES:="com/sun/SolarisFoobar.java" means only compile this file!
   353     #    EXCLUDE_FILES:="com/sun/SolarisFoobar.java" means do not compile this particular file!
   354     #                   "SolarisFoobar.java" means do not compile SolarisFoobar, wherever it is found.
   355     #    JAVAC_SOURCE_PATH_UGLY_OVERRIDE:=Don't use this. This forces an explicit -sourcepath to javac.
   356     #                                     Its only here until we cleanup some nasty source code pasta in the jdk.
   357     #    HEADERS:=path to directory where all generated c-headers are written.
   358     #    DEPENDS:=Extra dependecy
   359     $(foreach i,2 3 4 5 6 7 8 9 10 11 12 13 14 15, $(if $($i),$1_$(strip $($i)))$(NEWLINE))
   360     $(call LogSetupMacroEntry,SetupJavaCompilation($1),$2,$3,$4,$5,$6,$7,$8,$9,$(10),$(11),$(12),$(13),$(14),$(15))
   361     $(if $(16),$(error Internal makefile error: Too many arguments to SetupJavaCompilation, please update JavaCompilation.gmk))
   363     # Extract the info from the java compiler setup.
   364     $1_JVM   := $$($$($1_SETUP)_JVM)
   365     $1_JAVAC := $$($$($1_SETUP)_JAVAC)
   366     $1_FLAGS := $$($$($1_SETUP)_FLAGS) $(JAVAC_FLAGS) $$($1_ADD_JAVAC_FLAGS)
   367     ifeq ($$($1_JAVAC),)
   368         $$(error The Java compilation $1 refers to a non-existant java compiler setup $$($1_SETUP))
   369     endif
   370     $1_SJAVAC_PORTFILE := $$($$($1_SETUP)_SJAVAC_PORTFILE)
   371     $1_SERVER_JVM := $$($$($1_SETUP)_SERVER_JVM)
   373     # Handle addons and overrides.
   374     $1_SRC:=$$(call ADD_SRCS,$$($1_SRC))
   375     # Make sure the dirs exist.
   376     $$(foreach d,$$($1_SRC), $$(if $$(wildcard $$d),,$$(error SRC specified to SetupJavaCompilation $1 contains missing directory $$d)))
   377     $$(eval $$(call MakeDir,$$($1_BIN)))
   378     # Find all files in the source trees.
   379     $1_ALL_SRCS := $$(filter-out $(OVR_SRCS),$$(shell $(FIND) $$($1_SRC) -type f))
   380     # Extract the java files.
   381     ifneq ($$($1_EXCLUDE_FILES),)
   382         $1_EXCLUDE_FILES_PATTERN:=$$(addprefix %,$$($1_EXCLUDE_FILES))
   383     endif
   384     $1_SRCS     := $$(filter-out $$($1_EXCLUDE_FILES_PATTERN),$$(filter %.java,$$($1_ALL_SRCS)))
   385     ifneq ($$($1_INCLUDE_FILES),)
   386         $1_INCLUDE_FILES:=$$(foreach i,$$($1_SRC),$$(addprefix $$i/,$$($1_INCLUDE_FILES)))
   387         $1_SRCS := $$(filter $$($1_INCLUDE_FILES), $$($1_SRCS))
   388     endif
   390     # Now we have a list of all java files to compile: $$($1_SRCS)
   392     # Create the corresponding smart javac wrapper command line.
   393     $1_SJAVAC_ARGS:=$$(addprefix -x ,$$(addsuffix .*,$$(subst /,.,$$($1_EXCLUDES)))) \
   394 		$$(addprefix -i ,$$(addsuffix .*,$$(subst /,.,$$($1_INCLUDES)))) \
   395 		$$(addprefix -xf *,$$(strip $$($1_EXCLUDE_FILES))) \
   396 		$$(addprefix -if *,$$(strip $$($1_INCLUDE_FILES))) \
   397 		-src "$$(subst $$(SPACE),$$(PATH_SEP),$$(strip $$($1_SRC)))"
   399     # Prepend the source/bin path to the filter expressions.
   400     ifneq ($$($1_INCLUDES),)
   401         $1_SRC_INCLUDES := $$(foreach i,$$($1_SRC),$$(addprefix $$i/,$$(addsuffix /%,$$($1_INCLUDES))))
   402         $1_SRCS     := $$(filter $$($1_SRC_INCLUDES),$$($1_SRCS))
   403     endif
   404     ifneq ($$($1_EXCLUDES),)
   405         $1_SRC_EXCLUDES := $$(foreach i,$$($1_SRC),$$(addprefix $$i/,$$(addsuffix /%,$$($1_EXCLUDES))))
   406         $1_SRCS     := $$(filter-out $$($1_SRC_EXCLUDES),$$($1_SRCS))
   407     endif
   409     # Find all files to be copied from source to bin.
   410     ifneq (,$$($1_COPY))
   411         # Rewrite list of patterns into a find statement.
   412         $1_COPY_PATTERN:=$(FALSE_FIND_PATTERN) $$(patsubst %,$(SPACE)-o$(SPACE)-name$(SPACE)$(DQUOTE)*%$(DQUOTE),$$($1_COPY))
   413         # Search for all files to be copied.
   414         $1_ALL_COPIES := $$(filter $$(addprefix %,$$($1_COPY)),$$($1_ALL_SRCS))
   415         # Copy these explicitly
   416         $1_ALL_COPIES += $$($1_COPY_FILES)
   417         # Copy must also respect filters.
   418         ifneq (,$$($1_INCLUDES))
   419             $1_ALL_COPIES := $$(filter $$($1_SRC_INCLUDES),$$($1_ALL_COPIES))
   420         endif
   421         ifneq (,$$($1_EXCLUDES))
   422             $1_ALL_COPIES := $$(filter-out $$($1_SRC_EXCLUDES),$$($1_ALL_COPIES))
   423         endif
   424         ifneq (,$$($1_EXCLUDE_FILES))
   425             $1_ALL_COPIES := $$(filter-out $$($1_EXCLUDE_FILES_PATTERN),$$($1_ALL_COPIES))
   426         endif
   427         # All files below META-INF are always copied.
   428         $1_ALL_COPIES += $$(filter $$(addsuffix /META-INF%,$$($1_SRC)),$$($1_ALL_SRCS))
   429         ifneq (,$$($1_ALL_COPIES))
   430             # Yep, there are files to be copied!
   431             $1_ALL_COPY_TARGETS:=
   432             $$(foreach i,$$($1_ALL_COPIES),$$(eval $$(call add_file_to_copy,$1,$$i)))
   433             # Now we can depend on $$($1_ALL_COPY_TARGETS) to copy all files!
   434         endif
   435     endif
   437     # Find all property files to be copied and cleaned from source to bin.
   438     ifneq (,$$($1_CLEAN))
   439         # Rewrite list of patterns into a find statement.
   440         $1_CLEAN_PATTERN:=$(FALSE_FIND_PATTERN) $$(patsubst %,$(SPACE)-o$(SPACE)-name$(SPACE)$(DQUOTE)*%$(DQUOTE),$$($1_CLEAN))
   441         # Search for all files to be copied.
   442         $1_ALL_CLEANS := $$(filter $$(addprefix %,$$($1_CLEAN)),$$($1_ALL_SRCS))
   443         # Copy and clean must also respect filters.
   444         ifneq (,$$($1_INCLUDES))
   445             $1_ALL_CLEANS := $$(filter $$($1_SRC_INCLUDES),$$($1_ALL_CLEANS))
   446         endif
   447         ifneq (,$$($1_EXCLUDES))
   448             $1_ALL_CLEANS := $$(filter-out $$($1_SRC_EXCLUDES),$$($1_ALL_CLEANS))
   449         endif
   450         ifneq (,$$($1_EXCLUDE_FILES))
   451             $1_ALL_CLEANS := $$(filter-out $$($1_EXCLUDE_FILES_PATTERN),$$($1_ALL_CLEANS))
   452         endif
   453         ifneq (,$$($1_ALL_CLEANS))
   454             # Yep, there are files to be copied and cleaned!
   455             $1_ALL_COPY_CLEAN_TARGETS:=
   456             $$(foreach i,$$($1_ALL_CLEANS),$$(eval $$(call add_file_to_copy_and_clean,$1,$$i)))
   457             # Now we can depend on $$($1_ALL_COPY_CLEAN_TARGETS) to copy all files!
   458         endif
   459     endif
   461     # Prep the source paths.
   462     ifneq ($$($1_JAVAC_SOURCE_PATH_UGLY_OVERRIDE),)
   463       $$(eval $$(call replace_space_with_pathsep,$1_SRCROOTSC,$$($1_JAVAC_SOURCE_PATH_UGLY_OVERRIDE)))
   464     else
   465       $$(eval $$(call replace_space_with_pathsep,$1_SRCROOTSC,$$($1_SRC)))
   466     endif
   468     # Create a sed expression to remove the source roots and to replace / with .
   469     # and remove .java at the end. 
   470     $1_REWRITE_INTO_CLASSES:=$$(foreach i,$$($1_SRC),-e 's|$$i/||g') -e 's|/|.|g' -e 's|.java$$$$||g'
   472     ifeq ($$($1_DISABLE_SJAVAC)x$$(ENABLE_SJAVAC),xyes)
   473         ifneq (,$$($1_HEADERS))
   474             $1_HEADERS_ARG := -h $$($1_HEADERS)
   475         endif
   477         # Using sjavac to compile. 
   478         $1 := $$($1_ALL_COPY_TARGETS) $$($1_ALL_COPY_CLEAN_TARGETS) $$($1_BIN)/javac_state
   480         # Create SJAVAC variable,
   481         # expects $1_JAVAC to be "bootclasspathprepend -jar ...javac.jar"
   482         # and it is rewritten into "bootclasspathprepend com.sun.tools.sjavac.Main"
   483         $1_SJAVAC:=$$(word 1,$$($1_JAVAC)) -cp $$(word 3,$$($1_JAVAC)) com.sun.tools.sjavac.Main
   485         # Set the $1_REMOTE to spawn a background javac server.
   486         $1_REMOTE:=--server:portfile=$$($1_SJAVAC_PORTFILE),id=$1,sjavac=$$(subst $$(SPACE),%20,$$(subst $$(COMMA),%2C,$$(strip $$($1_SERVER_JVM) $$($1_SJAVAC))))
   488         $$($1_BIN)/javac_state: $$($1_SRCS) $$($1_DEPENDS)
   489 		$(MKDIR) -p $$(@D)
   490 		$$(call ListPathsSafely,$1_SRCS,\n, >> $$($1_BIN)/_the.batch.tmp)
   491 		$(ECHO) Compiling $1
   492 		($$($1_JVM) $$($1_SJAVAC) \
   493 			$$($1_REMOTE) \
   494 			-j $(NUM_CORES) \
   495 			--permit-unidentified-artifacts \
   496 			--permit-sources-without-package \
   497 			--compare-found-sources $$($1_BIN)/_the.batch.tmp \
   498 			--log=$(LOG) \
   499 			$$($1_SJAVAC_ARGS) \
   500 			$$($1_FLAGS) \
   501 			$$($1_HEADERS_ARG) \
   502 			-d $$($1_BIN) && \
   503 			$(MV) $$($1_BIN)/_the.batch.tmp $$($1_BIN)/_the.batch)
   504     else
   505         # Using plain javac to batch compile everything.
   506         $1 := $$($1_ALL_COPY_TARGETS) $$($1_ALL_COPY_CLEAN_TARGETS) $$($1_BIN)/_the.batch
   508         # When buliding in batch, put headers in a temp dir to filter out those that actually
   509         # changed before copying them to the real header dir.
   510         ifneq (,$$($1_HEADERS))
   511             $1_HEADERS_ARG := -h $$($1_HEADERS).tmp
   513             $$($1_HEADERS)/_the.headers: $$($1_BIN)/_the.batch
   514 		$(MKDIR) -p $$(@D)
   515 		for f in `ls $$($1_HEADERS).tmp`; do \
   516 		  if [ ! -f "$$($1_HEADERS)/$$$$f" ] || [ "`$(DIFF) $$($1_HEADERS)/$$$$f $$($1_HEADERS).tmp/$$$$f`" != "" ]; then \
   517 		    $(CP) -f $$($1_HEADERS).tmp/$$$$f $$($1_HEADERS)/$$$$f; \
   518 		  fi; \
   519 		done
   520 		$(RM) -r $$($1_HEADERS).tmp
   521 		$(TOUCH) $$@
   523             $1 += $$($1_HEADERS)/_the.headers
   524         endif
   526         # When not using sjavac, pass along all sources to javac using an @file.
   527         $$($1_BIN)/_the.batch: $$($1_SRCS) $$($1_DEPENDS)
   528 		$(MKDIR) -p $$(@D)
   529 		$(RM) $$($1_BIN)/_the.batch $$($1_BIN)/_the.batch.tmp
   530 		$$(call ListPathsSafely,$1_SRCS,\n, >> $$($1_BIN)/_the.batch.tmp)
   531 		$(ECHO) Compiling `$(WC) $$($1_BIN)/_the.batch.tmp | $(TR) -s ' ' | $(CUT) -f 2 -d ' '` files for $1
   532 		($$($1_JVM) $$($1_JAVAC) $$($1_FLAGS) \
   533 			-implicit:none -sourcepath "$$($1_SRCROOTSC)" \
   534 			-d $$($1_BIN) $$($1_HEADERS_ARG) @$$($1_BIN)/_the.batch.tmp && \
   535 			$(MV) $$($1_BIN)/_the.batch.tmp $$($1_BIN)/_the.batch)
   537     endif
   539     # Check if a jar file was specified, then setup the rules for the jar.
   540     ifneq (,$$($1_JAR))
   541         # If no suffixes was explicitly set for this jar file.
   542         # Use class and the cleaned/copied properties file suffixes as the default
   543         # for the types of files to be put into the jar.
   544         ifeq (,$$($1_SUFFIXES))
   545             $1_SUFFIXES:=.class $$($1_CLEAN) $$($1_COPY)
   546         endif
   548         $$(eval $$(call SetupArchive,ARCHIVE_$1,$$($1),\
   549 		SRCS:=$$($1_BIN),\
   550 		SUFFIXES:=$$($1_SUFFIXES),\
   551 		EXCLUDE:=$$($1_EXCLUDES),\
   552 		INCLUDES:=$$($1_INCLUDES),\
   553 		EXTRA_FILES:=$$($1_ALL_COPY_TARGETS) $$($1_ALL_COPY_CLEAN_TARGETS),\
   554 		JAR:=$$($1_JAR),\
   555 		JARMAIN:=$$($1_JARMAIN),\
   556 		MANIFEST:=$$($1_MANIFEST),\
   557 		EXTRA_MANIFEST_ATTR:=$$($1_EXTRA_MANIFEST_ATTR),\
   558 		JARINDEX:=$$($1_JARINDEX),\
   559 		HEADERS:=$$($1_HEADERS),\
   560 		SETUP:=$$($1_SETUP)))
   561     endif
   563     # Check if a srczip was specified, then setup the rules for the srczip.
   564     ifneq (,$$($1_SRCZIP))
   565         $$(eval $$(call SetupZipArchive,ARCHIVE_$1,\
   566 		SRC:=$$($1_SRC),\
   567 		ZIP:=$$($1_SRCZIP),\
   568 		INCLUDES:=$$($1_INCLUDES),\
   569 		EXCLUDES:=$$($1_EXCLUDES),\
   570 		EXCLUDE_FILES:=$$($1_EXCLUDE_FILES)))
   571     endif
   573 endef

mercurial