JavaCompilation.gmk revision 996:abbef24e40d7
1#
2# Copyright (c) 2011, 2013, Oracle and/or its affiliates. All rights reserved.
3# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4#
5# This code is free software; you can redistribute it and/or modify it
6# under the terms of the GNU General Public License version 2 only, as
7# published by the Free Software Foundation.  Oracle designates this
8# particular file as subject to the "Classpath" exception as provided
9# by Oracle in the LICENSE file that accompanied this code.
10#
11# This code is distributed in the hope that it will be useful, but WITHOUT
12# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14# version 2 for more details (a copy is included in the LICENSE file that
15# accompanied this code).
16#
17# You should have received a copy of the GNU General Public License version
18# 2 along with this work; if not, write to the Free Software Foundation,
19# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20#
21# Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22# or visit www.oracle.com if you need additional information or have any
23# questions.
24#
25
26# This makefile is much simpler now that it can use the smart javac wrapper
27# for dependency tracking between java packages and incremental compiles.
28# It could be even more simple if we added support for incremental jar updates
29# directly from the smart javac wrapper.
30
31# Cleaning/copying properties here is not a good solution. The properties
32# should be cleaned/copied by a annotation processor in sjavac.
33
34# When you read this source. Remember that $(sort ...) has the side effect
35# of removing duplicates. It is actually this side effect that is
36# desired whenever sort is used below!
37
38ifeq (,$(_MAKEBASE_GMK))
39  $(error You must include MakeBase.gmk prior to including JavaCompilation.gmk)
40endif
41
42FALSE_FIND_PATTERN:=-name FILE_NAME_THAT_DOESNT_EXIST
43
44define 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))
56
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
65endef
66
67define 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
85
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),trace), $(info *[2] <dependencies> = $(strip $2)))
90  $(if $(16),$(error Internal makefile error: Too many arguments to SetupArchive, please update JavaCompilation.gmk))
91
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))
98
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 $$(NEWLINE) \
115          $$(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 $$(NEWLINE) \
128          $$(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
133
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
161  # The dependency list should never be empty
162  ifeq ($$(strip $$($1_DEPS)), )
163    $$(warning No dependencies found for $1)
164  endif
165
166  # Utility macros, to make the shell script receipt somewhat easier to decipher.
167
168  # The capture contents macro finds all files (matching the patterns, typically
169  # .class and .prp) that are newer than the jar-file, ie the new content to be put into the jar.
170  # NOTICE: please leave the parentheses space separated otherwise the AIX build will break!
171  $1_CAPTURE_CONTENTS=$$(foreach src,$$($1_SRCS), \
172      ( ( $(FIND) $$(src) -type f -a \( $$($1_FIND_PATTERNS) \) -a -newer $$@ $$($1_GREP_INCLUDES) \
173          $$($1_GREP_EXCLUDES) | $(SED) 's|$$(src)/||g' && \
174      $(ECHO) $$(subst $$(src)/,,$$($1_EXTRA_FILES) ) ) > \
175      $$(src)/_the.$$($1_JARNAME)_contents) $$(NEWLINE) )
176  # The capture metainf macro finds all files below the META-INF directory that are newer than the jar-file.
177  ifeq (,$$($1_SKIP_METAINF))
178    $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))
179  endif
180  # The capture deletes macro finds all deleted files and concatenates them. The resulting file
181  # tells us what to remove from the jar-file.
182  $1_CAPTURE_DELETES=$$(foreach src,$$($1_SRCS),($(FIND) $$(src) -name _the.package.deleted -newer $$@ -exec $(SED) 's|$$(src)||g' \{\} >> $$($1_DELETES_FILE) \;) $$(NEWLINE))
183  # The update contents macro updates the jar file with the previously capture contents.
184  # Use 'wc -w' to see if the contents file is empty.
185  $1_UPDATE_CONTENTS=$$(foreach src,$$($1_SRCS), \
186      (cd $$(src) && \
187       if [ "`$(WC) -w _the.$$($1_JARNAME)_contents | $(AWK) '{ print $$$$1 }'`" -gt "0" ]; then \
188         $(ECHO) "  updating" `$(WC) -l _the.$$($1_JARNAME)_contents | $(AWK) '{ print $$$$1 }'` files && \
189         $(JAR) $$($1_JAR_UPDATE_OPTIONS) $$@ @_the.$$($1_JARNAME)_contents; \
190       fi) $$(NEWLINE))
191  # The s-variants of the above macros are used when the jar is created from scratch.
192  # NOTICE: please leave the parentheses space separated otherwise the AIX build will break!
193  $1_SCAPTURE_CONTENTS=$$(foreach src,$$($1_SRCS), \
194      ( ( $(FIND) $$(src) -type f -a \( $$($1_FIND_PATTERNS) \) $$($1_GREP_INCLUDES) \
195          $$($1_GREP_EXCLUDES) | $(SED) 's|$$(src)/||g' && \
196      $$(subst $$(src)/,,$(ECHO) $$($1_EXTRA_FILES) ) ) > \
197      $$(src)/_the.$$($1_JARNAME)_contents) $$(NEWLINE) )
198
199  ifeq (,$$($1_SKIP_METAINF))
200    $1_SCAPTURE_METAINF=$$(foreach src,$$($1_SRCS), \
201        ($(FIND) $$(src)/META-INF -type f 2> /dev/null | $(SED) 's|$$(src)/||g' >> \
202        $$(src)/_the.$$($1_JARNAME)_contents) $$(NEWLINE))
203  endif
204  $1_SUPDATE_CONTENTS=$$(foreach src,$$($1_SRCS), \
205      (cd $$(src) && $(JAR) $$($1_JAR_UPDATE_OPTIONS) $$@ @$$(src)/_the.$$($1_JARNAME)_contents) $$(NEWLINE))
206
207  # Use a slightly shorter name for logging, but with enough path to identify this jar.
208  $1_NAME:=$$(subst $$(OUTPUT_ROOT)/,,$$($1_JAR))
209
210  ifneq (,$$($1_CHECK_COMPRESS_JAR))
211    $1_JAR_CREATE_OPTIONS := c0fm
212    $1_JAR_UPDATE_OPTIONS := u0f
213    ifeq ($(COMPRESS_JARS), true)
214      $1_JAR_CREATE_OPTIONS := cfm
215      $1_JAR_UPDATE_OPTIONS := uf
216    endif
217  else
218    $1_JAR_CREATE_OPTIONS := cfm
219    $1_JAR_UPDATE_OPTIONS := uf
220  endif
221
222  # Here is the rule that creates/updates the jar file.
223  $$($1_JAR) : $$($1_DEPS)
224	$(MKDIR) -p $$($1_BIN)
225	$$($1_GREP_INCLUDE_OUTPUT)
226	$$($1_GREP_EXCLUDE_OUTPUT)
227	$$(if $$($1_MANIFEST), \
228	  $(SED) -e "s#@@RELEASE@@#$(RELEASE)#" \
229	      -e "s#@@COMPANY_NAME@@#$(COMPANY_NAME)#" $$($1_MANIFEST) > $$($1_MANIFEST_FILE) \
230	, \
231	  $(RM) $$($1_MANIFEST_FILE) && $(TOUCH) $$($1_MANIFEST_FILE))
232	$$(if $$($1_JARMAIN),$(ECHO) "Main-Class: $$(strip $$($1_JARMAIN))" >> $$($1_MANIFEST_FILE))
233	$$(if $$($1_EXTRA_MANIFEST_ATTR),$(PRINTF) "$$($1_EXTRA_MANIFEST_ATTR)\n" >> $$($1_MANIFEST_FILE))
234	$$(if $$(wildcard $$@), \
235	  $(ECHO) Modifying $$($1_NAME) $$(NEWLINE) \
236	  $$($1_CAPTURE_CONTENTS) \
237	  $$($1_CAPTURE_METAINF) \
238	  $(RM) $$($1_DELETES_FILE) $$(NEWLINE) \
239	  $$($1_CAPTURE_DELETES) \
240	  $(CAT) $$($1_DELETES_FILE) > $$($1_DELETESS_FILE) $$(NEWLINE) \
241	  if [ -s $$($1_DELETESS_FILE) ]; then \
242	    $(ECHO) "  deleting" `$(WC) -l $$($1_DELETESS_FILE) | $(AWK) '{ print $$$$1 }'` files && \
243	    $(ZIP) -q -d $$@ `$(CAT) $$($1_DELETESS_FILE)` ; \
244	  fi $$(NEWLINE) \
245	  $$($1_UPDATE_CONTENTS) true $$(NEWLINE) \
246	  $$($1_JARINDEX) && true \
247	, \
248	  $(ECHO) Creating $$($1_NAME) && $(JAR) $$($1_JAR_CREATE_OPTIONS) $$@ $$($1_MANIFEST_FILE) $$(NEWLINE) \
249	  $$($1_SCAPTURE_CONTENTS) \
250	  $$($1_SCAPTURE_METAINF) \
251	  $$($1_SUPDATE_CONTENTS) \
252	  $$($1_JARINDEX) && true )
253
254  # Add jar to target list
255  $1 += $$($1_JAR)
256endef
257
258define SetupZipArchive
259  # param 1 is for example ZIP_MYSOURCE
260  # param 2,3,4,5,6,7,8,9 are named args.
261  #   SRC,ZIP,INCLUDES,INCLUDE_FILES,EXCLUDES,EXCLUDE_FILES,SUFFIXES,EXTRA_DEPS
262  $(foreach i,2 3 4 5 6 7 8 9 10 11 12 13 14 15, $(if $($i),$1_$(strip $($i)))$(NEWLINE))
263  $(call LogSetupMacroEntry,SetupZipArchive($1),$2,$3,$4,$5,$6,$7,$8,$9,$(10),$(11),$(12),$(13),$(14),$(15))
264  $(if $(16),$(error Internal makefile error: Too many arguments to SetupZipArchive, please update JavaCompilation.gmk))
265
266  # To avoid running find over too large sets of files, which causes make to crash
267  # on some configurations (cygwin), use INCLUDES and INCLUDE_FILES to build a set
268  # of directories to run find in, if available.
269  ifneq ($$($1_INCLUDES)$$($1_INCLUDE_FILES),)
270    $1_FIND_LIST := $$(wildcard $$(foreach i,$$($1_SRC), \
271        $$(addprefix $$i/,$$($1_INCLUDES) $$($1_INCLUDE_FILES))))
272  else
273    $1_FIND_LIST := $$($1_SRC)
274  endif
275
276  # Find all files in the source tree.
277  $1_ALL_SRCS := $$(call not-containing,_the.,$$(call CacheFind,$$($1_FIND_LIST)))
278
279  # Filter on suffixes if set
280  ifneq ($$($1_SUFFIXES),)
281    $1_ALL_SRCS := $$(filter $$(addprefix %, $$($1_SUFFIXES)), $$($1_ALL_SRCS))
282  endif
283
284  ifneq ($$($1_INCLUDES),)
285    ifneq ($$($1_SUFFIXES),)
286      $1_ZIP_INCLUDES := $$(foreach s,$$($1_SUFFIXES), \
287          $$(addprefix -i$(SPACE)$(DQUOTE),$$(addsuffix /*$$s$(DQUOTE),$$($1_INCLUDES))))
288    else
289      $1_ZIP_INCLUDES := $$(addprefix -i$(SPACE)$(DQUOTE),$$(addsuffix /*$(DQUOTE),$$($1_INCLUDES)))
290    endif
291  endif
292  ifneq ($$($1_INCLUDE_FILES),)
293    $1_ZIP_INCLUDES += $$(addprefix -i$(SPACE),$$($1_INCLUDE_FILES))
294  endif
295  ifneq ($$($1_EXCLUDES),)
296    $1_SRC_EXCLUDES := $$(foreach i,$$($1_SRC),$$(addprefix $$i/,$$(addsuffix /%,$$($1_EXCLUDES))))
297    $1_ZIP_EXCLUDES := $$(addprefix -x$(SPACE)$(DQUOTE),$$(addsuffix /*$(DQUOTE),$$($1_EXCLUDES)))
298    $1_ALL_SRCS := $$(filter-out $$($1_SRC_EXCLUDES),$$($1_ALL_SRCS))
299  endif
300
301  # Use a slightly shorter name for logging, but with enough path to identify this zip.
302  $1_NAME:=$$(subst $$(OUTPUT_ROOT)/,,$$($1_ZIP))
303
304  # Now $1_ALL_SRCS should contain all sources that are going to be put into the zip.
305  # I.e. the zip -i and -x options should match the filtering done in the makefile.
306  # Explicitly excluded files can be given with absolute path. The patsubst solution
307  # isn't perfect but the likelyhood of an absolute path to match something in a src
308  # dir is very small.
309  # If zip has nothing to do, it returns 12 and would fail the build. Check for 12
310  # and only fail if it's not.
311  $$($1_ZIP) : $$($1_ALL_SRCS) $$($1_EXTRA_DEPS)
312	$(MKDIR) -p $$(@D)
313	$(ECHO) Updating $$($1_NAME)
314	$$(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
315	$(TOUCH) $$@
316
317  # Add zip to target list
318  $1 += $$($1_ZIP)
319endef
320
321define add_file_to_copy
322  # param 1 = BUILD_MYPACKAGE
323  # parma 2 = The source file to copy.
324  $2_TARGET:=$2
325  # Remove the source prefix.
326  $$(foreach i,$$($1_SRC),$$(eval $$(call remove_string,$$i,$2_TARGET)))
327  # Now we can setup the depency that will trigger the copying.
328  $$($1_BIN)$$($2_TARGET) : $2
329	$(MKDIR) -p $$(@D)
330	$(CP) $$< $$@
331	$(CHMOD) -f ug+w $$@
332
333  # And do not forget this target
334  $1_ALL_COPY_TARGETS += $$($1_BIN)$$($2_TARGET)
335endef
336
337
338# This macro is used only for properties files that are to be
339# copied over to the classes directory in cleaned form:
340# Previously this was inconsistently done in different repositories.
341# This is the new clean standard. Though it is to be superseded by
342# a standard annotation processor from with sjavac.
343#
344# The sed expression does this:
345# 1. Add a backslash before any :, = or ! that do not have a backslash already.
346# 2. Apply the file unicode2x.sed which does a whole bunch of \u00XX to \xXX 
347#    conversions.
348# 3. Delete all lines starting with #.
349# 4. Delete empty lines.
350# 5. Append lines ending with \ with the next line.
351# 6. Remove leading and trailing white space.
352# 7. Replace the first \= with just =.
353# 8. Finally it's all sorted to create a stable output.
354# 
355# It is assumed that = is the character used for separating names and values.
356define add_file_to_clean
357  # param 1 = BUILD_MYPACKAGE
358  # parma 2 = The source file to copy and clean.
359  $2_TARGET:=$2
360  # Remove the source prefix.
361  $$(foreach i,$$($1_SRC),$$(eval $$(call remove_string,$$i,$2_TARGET)))
362  # Now we can setup the depency that will trigger the copying.
363  $$($1_BIN)$$($2_TARGET) : $2
364	$(MKDIR) -p $$(@D)
365	$(CAT) $$< | $(SED) -e 's/\([^\\]\):/\1\\:/g' -e 's/\([^\\]\)=/\1\\=/g' \
366	        -e 's/\([^\\]\)!/\1\\!/g' -e 's/#.*/#/g' \
367	    | $(SED) -f "$(SRC_ROOT)/make/common/support/unicode2x.sed" \
368	    | $(SED) -e '/^#/d' -e '/^$$$$/d' \
369	        -e :a -e '/\\$$$$/N; s/\\\n//; ta' \
370	        -e 's/^[ \t]*//;s/[ \t]*$$$$//' \
371	        -e 's/\\=/=/' | LC_ALL=C $(SORT) > $$@
372	$(CHMOD) -f ug+w $$@
373
374  # And do not forget this target
375  $1_ALL_COPY_CLEAN_TARGETS += $$($1_BIN)$$($2_TARGET)
376endef
377
378define remove_string
379  $2 := $$(subst $1,,$$($2))
380endef
381
382define replace_space_with_pathsep
383  $1:=$(subst $(SPACE),$(PATH_SEP),$(strip $(patsubst %,%,$2)))
384endef
385
386define SetupJavaCompilation
387  # param 1 is for example BUILD_MYPACKAGE
388  # param 2,3,4,5,6,7,8 are named args.
389  #   SETUP:=must point to a previously setup java compiler, for example: SETUP:=BOOTJAVAC
390  #   JVM:=path to ..bin/java
391  #   ADD_JAVAC_FLAGS:=javac flags to append to the default ones.
392  #   SRC:=one or more directories to search for sources
393  #   BIN:=store classes here
394  #   INCLUDES:=myapp.foo means will only compile java files in myapp.foo or any of its sub-packages.
395  #   EXCLUDES:=myapp.foo means will do not compile java files in myapp.foo or any of its sub-packages.
396  #   COPY:=.prp means copy all prp files to the corresponding package in BIN.
397  #   COPY_FILES:=myapp/foo/setting.txt means copy this file over to the package myapp/foo
398  #   CLEAN:=.properties means copy and clean all properties file to the corresponding package in BIN.
399  #   CLEAN_FILES:=myapp/foo/setting.txt means clean this file over to the package myapp/foo
400  #   SRCZIP:=Create a src.zip based on the found sources and copied files.
401  #   INCLUDE_FILES:="com/sun/SolarisFoobar.java" means only compile this file!
402  #   EXCLUDE_FILES:="com/sun/SolarisFoobar.java" means do not compile this particular file!
403  #       "SolarisFoobar.java" means do not compile SolarisFoobar, wherever it is found.
404  #   JAVAC_SOURCE_PATH_OVERRIDE:=This forces an explicit -sourcepath to javac instead of the complete
405  #       source roots from SRC. This is sometimes needed when compiling specific subsets of the source.
406  #   HEADERS:=path to directory where all generated c-headers are written.
407  #   DEPENDS:=Extra dependecy
408  $(foreach i,2 3 4 5 6 7 8 9 10 11 12 13 14 15, $(if $($i),$1_$(strip $($i)))$(NEWLINE))
409  $(call LogSetupMacroEntry,SetupJavaCompilation($1),$2,$3,$4,$5,$6,$7,$8,$9,$(10),$(11),$(12),$(13),$(14),$(15))
410  $(if $(16),$(error Internal makefile error: Too many arguments to SetupJavaCompilation, please update JavaCompilation.gmk))
411
412  # Extract the info from the java compiler setup.
413  $1_JVM := $$($$($1_SETUP)_JVM)
414  $1_JAVAC := $$($$($1_SETUP)_JAVAC)
415  $1_FLAGS := $$($$($1_SETUP)_FLAGS) $(JAVAC_FLAGS) $$($1_ADD_JAVAC_FLAGS)
416  ifeq ($$($1_JAVAC),)
417    $$(error The Java compilation $1 refers to a non-existant java compiler setup $$($1_SETUP))
418  endif
419  $1_SJAVAC_PORTFILE := $$($$($1_SETUP)_SJAVAC_PORTFILE)
420  $1_SERVER_JVM := $$($$($1_SETUP)_SERVER_JVM)
421
422  # Handle addons and overrides.
423  $1_SRC:=$$(call ADD_SRCS,$$($1_SRC))
424  # Make sure the dirs exist.
425  $$(foreach d,$$($1_SRC), $$(if $$(wildcard $$d),,$$(error SRC specified to SetupJavaCompilation $1 contains missing directory $$d)))
426  $$(eval $$(call MakeDir,$$($1_BIN)))
427  # Find all files in the source trees.
428  $1_ALL_SRCS += $$(filter-out $(OVR_SRCS),$$(call CacheFind,$$($1_SRC)))
429  # Extract the java files.
430  ifneq ($$($1_EXCLUDE_FILES),)
431    $1_EXCLUDE_FILES_PATTERN:=$$(addprefix %,$$($1_EXCLUDE_FILES))
432  endif
433  $1_SRCS := $$(filter-out $$($1_EXCLUDE_FILES_PATTERN),$$(filter %.java,$$($1_ALL_SRCS)))
434  ifneq ($$($1_INCLUDE_FILES),)
435    $1_INCLUDE_FILES:=$$(foreach i,$$($1_SRC),$$(addprefix $$i/,$$($1_INCLUDE_FILES)))
436    $1_SRCS := $$(filter $$($1_INCLUDE_FILES), $$($1_SRCS))
437  endif
438
439  # Now we have a list of all java files to compile: $$($1_SRCS)
440
441  # Create the corresponding smart javac wrapper command line.
442  $1_SJAVAC_ARGS:=$$(addprefix -x ,$$(addsuffix .*,$$(subst /,.,$$($1_EXCLUDES)))) \
443      $$(addprefix -i ,$$(addsuffix .*,$$(subst /,.,$$($1_INCLUDES)))) \
444      $$(addprefix -xf *,$$(strip $$($1_EXCLUDE_FILES))) \
445      $$(addprefix -if *,$$(strip $$($1_INCLUDE_FILES))) \
446      -src "$$(subst $$(SPACE),$$(PATH_SEP),$$(strip $$($1_SRC)))"
447
448  # Prepend the source/bin path to the filter expressions.
449  ifneq ($$($1_INCLUDES),)
450    $1_SRC_INCLUDES := $$(foreach i,$$($1_SRC),$$(addprefix $$i/,$$(addsuffix /%,$$($1_INCLUDES))))
451    $1_SRCS := $$(filter $$($1_SRC_INCLUDES),$$($1_SRCS))
452  endif
453  ifneq ($$($1_EXCLUDES),)
454    $1_SRC_EXCLUDES := $$(foreach i,$$($1_SRC),$$(addprefix $$i/,$$(addsuffix /%,$$($1_EXCLUDES))))
455    $1_SRCS := $$(filter-out $$($1_SRC_EXCLUDES),$$($1_SRCS))
456  endif
457
458  # Find all files to be copied from source to bin.
459  ifneq (,$$($1_COPY)$$($1_COPY_FILES))
460    # Search for all files to be copied.
461    $1_ALL_COPIES := $$(filter $$(addprefix %,$$($1_COPY)),$$($1_ALL_SRCS))
462    # Copy these explicitly
463    $1_ALL_COPIES += $$($1_COPY_FILES)
464    # Copy must also respect filters.
465    ifneq (,$$($1_INCLUDES))
466      $1_ALL_COPIES := $$(filter $$($1_SRC_INCLUDES),$$($1_ALL_COPIES))
467    endif
468    ifneq (,$$($1_EXCLUDES))
469      $1_ALL_COPIES := $$(filter-out $$($1_SRC_EXCLUDES),$$($1_ALL_COPIES))
470    endif
471    ifneq (,$$($1_EXCLUDE_FILES))
472      $1_ALL_COPIES := $$(filter-out $$($1_EXCLUDE_FILES_PATTERN),$$($1_ALL_COPIES))
473    endif
474  endif
475  # All files below META-INF are always copied.
476  $1_ALL_COPIES += $$(filter $$(addsuffix /META-INF%,$$($1_SRC)),$$($1_ALL_SRCS))
477  ifneq (,$$($1_ALL_COPIES))
478    # Yep, there are files to be copied!
479    $1_ALL_COPY_TARGETS:=
480        $$(foreach i,$$($1_ALL_COPIES),$$(eval $$(call add_file_to_copy,$1,$$i)))
481    # Now we can depend on $$($1_ALL_COPY_TARGETS) to copy all files!
482  endif
483
484  # Find all property files to be copied and cleaned from source to bin.
485  ifneq (,$$($1_CLEAN)$$($1_CLEAN_FILES))
486    # Search for all files to be copied.
487    $1_ALL_CLEANS := $$(filter $$(addprefix %,$$($1_CLEAN)),$$($1_ALL_SRCS))
488    # Clean these explicitly
489    $1_ALL_CLEANS += $$($1_CLEAN_FILES)
490    # Copy and clean must also respect filters.
491    ifneq (,$$($1_INCLUDES))
492      $1_ALL_CLEANS := $$(filter $$($1_SRC_INCLUDES),$$($1_ALL_CLEANS))
493    endif
494    ifneq (,$$($1_EXCLUDES))
495      $1_ALL_CLEANS := $$(filter-out $$($1_SRC_EXCLUDES),$$($1_ALL_CLEANS))
496    endif
497    ifneq (,$$($1_EXCLUDE_FILES))
498      $1_ALL_CLEANS := $$(filter-out $$($1_EXCLUDE_FILES_PATTERN),$$($1_ALL_CLEANS))
499    endif
500    ifneq (,$$($1_ALL_CLEANS))
501      # Yep, there are files to be copied and cleaned!
502      $1_ALL_COPY_CLEAN_TARGETS:=
503          $$(foreach i,$$($1_ALL_CLEANS),$$(eval $$(call add_file_to_clean,$1,$$i)))
504      # Now we can depend on $$($1_ALL_COPY_CLEAN_TARGETS) to copy all files!
505    endif
506  endif
507
508  # Prep the source paths.
509  ifneq ($$($1_JAVAC_SOURCE_PATH_OVERRIDE),)
510    $$(eval $$(call replace_space_with_pathsep,$1_SRCROOTSC,$$($1_JAVAC_SOURCE_PATH_OVERRIDE)))
511  else
512    $$(eval $$(call replace_space_with_pathsep,$1_SRCROOTSC,$$($1_SRC)))
513  endif
514
515  # Create a sed expression to remove the source roots and to replace / with .
516  # and remove .java at the end.
517  $1_REWRITE_INTO_CLASSES:=$$(foreach i,$$($1_SRC),-e 's|$$i/||g') -e 's|/|.|g' -e 's|.java$$$$||g'
518
519  ifeq ($$($1_DISABLE_SJAVAC)x$$(ENABLE_SJAVAC),xyes)
520    ifneq (,$$($1_HEADERS))
521      $1_HEADERS_ARG := -h $$($1_HEADERS)
522    endif
523
524    # Using sjavac to compile.
525    $1 := $$($1_ALL_COPY_TARGETS) $$($1_ALL_COPY_CLEAN_TARGETS) $$($1_BIN)/javac_state
526
527    # Create SJAVAC variable form JAVAC variable. Expects $1_JAVAC to be
528    # "bootclasspathprepend -cp .../javac.jar com.sun.tools.javac.Main"
529    # and javac is simply replaced with sjavac.
530    $1_SJAVAC:=$$(subst com.sun.tools.javac.Main,com.sun.tools.sjavac.Main,$$($1_JAVAC))
531
532    # Set the $1_REMOTE to spawn a background javac server.
533    $1_REMOTE:=--server:portfile=$$($1_SJAVAC_PORTFILE),id=$1,sjavac=$$(subst $$(SPACE),%20,$$(subst $$(COMMA),%2C,$$(strip $$($1_SERVER_JVM) $$($1_SJAVAC))))
534
535    $$($1_BIN)/javac_state: $$($1_SRCS) $$($1_DEPENDS)
536	$(MKDIR) -p $$(@D)
537	$$(call ListPathsSafely,$1_SRCS,\n, >> $$($1_BIN)/_the.$1_batch.tmp)
538	$(ECHO) Compiling $1
539	($$($1_JVM) $$($1_SJAVAC) \
540	    $$($1_REMOTE) \
541	    -j $(JOBS) \
542	    --permit-unidentified-artifacts \
543	    --permit-sources-without-package \
544	    --compare-found-sources $$($1_BIN)/_the.$1_batch.tmp \
545	    --log=$(LOG_LEVEL) \
546	    $$($1_SJAVAC_ARGS) \
547	    $$($1_FLAGS) \
548	    $$($1_HEADERS_ARG) \
549	    -d $$($1_BIN) && \
550	$(MV) $$($1_BIN)/_the.$1_batch.tmp $$($1_BIN)/_the.$1_batch)
551  else
552    # Using plain javac to batch compile everything.
553    $1 := $$($1_ALL_COPY_TARGETS) $$($1_ALL_COPY_CLEAN_TARGETS) $$($1_BIN)/_the.$1_batch
554
555    # When building in batch, put headers in a temp dir to filter out those that actually
556    # changed before copying them to the real header dir.
557    ifneq (,$$($1_HEADERS))
558      $1_HEADERS_ARG := -h $$($1_HEADERS).$1.tmp
559
560      $$($1_HEADERS)/_the.$1_headers: $$($1_BIN)/_the.$1_batch
561		$(MKDIR) -p $$(@D)
562		for f in `ls $$($1_HEADERS).$1.tmp`; do \
563		  if [ ! -f "$$($1_HEADERS)/$$$$f" ] || [ "`$(DIFF) $$($1_HEADERS)/$$$$f $$($1_HEADERS).$1.tmp/$$$$f`" != "" ]; then \
564		    $(CP) -f $$($1_HEADERS).$1.tmp/$$$$f $$($1_HEADERS)/$$$$f; \
565		  fi; \
566		done
567		$(RM) -r $$($1_HEADERS).$1.tmp
568		$(TOUCH) $$@
569
570      $1 += $$($1_HEADERS)/_the.$1_headers
571    endif
572
573    # When not using sjavac, pass along all sources to javac using an @file.
574    $$($1_BIN)/_the.$1_batch: $$($1_SRCS) $$($1_DEPENDS)
575	$(MKDIR) -p $$(@D)
576	$(RM) $$($1_BIN)/_the.$1_batch $$($1_BIN)/_the.$1_batch.tmp
577	$$(call ListPathsSafely,$1_SRCS,\n, >> $$($1_BIN)/_the.$1_batch.tmp)
578	$(ECHO) Compiling `$(WC) $$($1_BIN)/_the.$1_batch.tmp | $(TR) -s ' ' | $(CUT) -f 2 -d ' '` files for $1
579	($$($1_JVM) $$($1_JAVAC) $$($1_FLAGS) \
580	    -implicit:none -sourcepath "$$($1_SRCROOTSC)" \
581	    -d $$($1_BIN) $$($1_HEADERS_ARG) @$$($1_BIN)/_the.$1_batch.tmp && \
582	$(MV) $$($1_BIN)/_the.$1_batch.tmp $$($1_BIN)/_the.$1_batch)
583
584  endif
585
586  # Check if a jar file was specified, then setup the rules for the jar.
587  ifneq (,$$($1_JAR))
588    # If no suffixes was explicitly set for this jar file.
589    # Use class and the cleaned/copied properties file suffixes as the default
590    # for the types of files to be put into the jar.
591    ifeq (,$$($1_SUFFIXES))
592      $1_SUFFIXES:=.class $$($1_CLEAN) $$($1_COPY)
593    endif
594
595    $$(eval $$(call SetupArchive,ARCHIVE_$1,$$($1), \
596        SRCS:=$$($1_BIN), \
597        SUFFIXES:=$$($1_SUFFIXES), \
598        EXCLUDE:=$$($1_EXCLUDES), \
599        INCLUDES:=$$($1_INCLUDES), \
600        EXTRA_FILES:=$$($1_ALL_COPY_TARGETS) $$($1_ALL_COPY_CLEAN_TARGETS), \
601        JAR:=$$($1_JAR), \
602        JARMAIN:=$$($1_JARMAIN), \
603        MANIFEST:=$$($1_MANIFEST), \
604        EXTRA_MANIFEST_ATTR:=$$($1_EXTRA_MANIFEST_ATTR), \
605        JARINDEX:=$$($1_JARINDEX), \
606        HEADERS:=$$($1_HEADERS), \
607        SETUP:=$$($1_SETUP)))
608
609    # Add jar to target list
610    $1 += $$($1_JAR)
611  endif
612
613  # Check if a srczip was specified, then setup the rules for the srczip.
614  ifneq (,$$($1_SRCZIP))
615    $$(eval $$(call SetupZipArchive,ARCHIVE_$1, \
616        SRC:=$$($1_SRC), \
617        ZIP:=$$($1_SRCZIP), \
618        INCLUDES:=$$($1_INCLUDES), \
619        EXCLUDES:=$$($1_EXCLUDES), \
620        EXCLUDE_FILES:=$$($1_EXCLUDE_FILES)))
621
622    # Add zip to target list
623    $1 += $$($1_SRCZIP)
624  endif
625endef
626