JavaCompilation.gmk revision 1304:668cf43ddeb5
1#
2# Copyright (c) 2011, 2014, Oracle and/or its affiliates. All rights reserved.
3# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4#
5# This code is free software; you can redistribute it and/or modify it
6# under the terms of the GNU General Public License version 2 only, as
7# published by the Free Software Foundation.  Oracle designates this
8# particular file as subject to the "Classpath" exception as provided
9# by Oracle in the LICENSE file that accompanied this code.
10#
11# This code is distributed in the hope that it will be useful, but WITHOUT
12# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14# version 2 for more details (a copy is included in the LICENSE file that
15# accompanied this code).
16#
17# You should have received a copy of the GNU General Public License version
18# 2 along with this work; if not, write to the Free Software Foundation,
19# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20#
21# Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22# or visit www.oracle.com if you need additional information or have any
23# questions.
24#
25
26# This makefile is much simpler now that it can use the smart javac wrapper
27# for dependency tracking between java packages and incremental compiles.
28# It could be even more simple if we added support for incremental jar updates
29# directly from the smart javac wrapper.
30
31# Cleaning/copying properties here is not a good solution. The properties
32# should be cleaned/copied by a annotation processor in sjavac.
33
34# When you read this source. Remember that $(sort ...) has the side effect
35# of removing duplicates. It is actually this side effect that is
36# desired whenever sort is used below!
37
38ifndef _JAVA_COMPILATION_GMK
39_JAVA_COMPILATION_GMK := 1
40
41ifeq (,$(_MAKEBASE_GMK))
42  $(error You must include MakeBase.gmk prior to including JavaCompilation.gmk)
43endif
44
45# Java compilation needs SetupZipArchive if we're generating a source zip.
46include ZipArchive.gmk
47
48FALSE_FIND_PATTERN:=-name FILE_NAME_THAT_DOESNT_EXIST
49
50# Setup make rules for defining a Java compiler, which is needed to compile
51# Java code. This rule generates no output.
52#
53# Parameter 1 is the name of the compiler definition. This name needs to be
54# passed to SetupJavaCompilation. This name is used as variable prefix.
55#
56# Remaining parameters are named arguments. These include:
57#   JVM:=The jvm used to run the javac/javah command
58#   JAVAC:=The javac jar and bootstrap classpath changes, or just bin/javac if JVM is left out
59#   FLAGS:=Flags to be supplied to javac
60#   SERVER_DIR:=Use a javac server (-XDserver) and store the server related files here
61#   SERVER_JVM:=Use this JVM for the server. Defaults to the JVM above.
62define SetupJavaCompiler
63  $(if $(16),$(error Internal makefile error: Too many arguments to SetupJavaCompiler, please update JavaCompilation.gmk))
64  $(call EvalDebugWrapper,$(strip $1),$(call SetupJavaCompilerInner,$(strip $1),$2,$3,$4,$5,$6,$7,$8,$9,$(10),$(11),$(12),$(13),$(14),$(15)))
65endef
66
67define SetupJavaCompilerInner
68  $(foreach i,2 3 4 5 6 7 8 9 10 11 12 13 14 15, $(if $($i),$1_$(strip $($i)))$(NEWLINE))
69  $(call LogSetupMacroEntry,SetupJavaCompiler($1),$2,$3,$4,$5,$6,$7,$8,$9,$(10),$(11),$(12),$(13),$(14),$(15))
70  $(if $(16),$(error Internal makefile error: Too many arguments to SetupJavaCompiler, please update JavaCompilation.gmk))
71
72  # The port file contains the tcp/ip on which the server listens
73  # and the cookie necessary to talk to the server.
74  $1_SJAVAC_PORTFILE:=$$($1_SERVER_DIR)/server.port
75  # You can use a different JVM to run the background javac server.
76  ifeq ($$($1_SERVER_JVM),)
77    # It defaults to the same JVM that is used to start the javac command.
78    $1_SERVER_JVM:=$$($1_JVM)
79  endif
80endef
81
82# Setup make rules for creating a jar archive.
83#
84# Parameter 1 is the name of the rule. This name is used as variable prefix,
85# and the targets generated are listed in a variable by that name.
86#
87# Remaining parameters are named arguments. These include:
88#   SRCS:=List of directories in where to find files to add to archive
89#   SUFFIXES:=File suffixes to include in jar
90#   INCLUDES:=List of directories/packages in SRCS that should be included
91#   EXCLUDES:=List of directories/packages in SRCS that should be excluded
92#   EXCLUDE_FILES:=List of files in SRCS that should be excluded
93#   EXTRA_FILES:=List of files in SRCS that should be included regardless of suffix match.
94#   JAR:=Jar file to create
95#   MANIFEST:=Optional manifest file template.
96#   JARMAIN:=Optional main class to add to manifest
97#   JARINDEX:=true means generate the index in the jar file.
98#   SKIP_METAINF:=Set to prevent contents of an META-INF directory to be automatically
99#       added to the archive.
100#   EXTRA_MANIFEST_ATTR:=Extra attribute to add to manifest.
101#   CHECK_COMPRESS_JAR Check the COMPRESS_JAR variable
102define SetupArchive
103  $(if $(16),$(error Internal makefile error: Too many arguments to SetupArchive, please update JavaCompilation.gmk))
104  $(call EvalDebugWrapper,$(strip $1),$(call SetupArchiveInner,$(strip $1),$2,$3,$4,$5,$6,$7,$8,$9,$(10),$(11),$(12),$(13),$(14),$(15)))
105endef
106
107define SetupArchiveInner
108  # NOTE: $2 is dependencies, not a named argument!
109  $(foreach i,3 4 5 6 7 8 9 10 11 12 13 14 15, $(if $($i),$1_$(strip $($i)))$(NEWLINE))
110  $(call LogSetupMacroEntry,SetupArchive($1),<dependencies>,$3,$4,$5,$6,$7,$8,$9,$(10),$(11),$(12),$(13),$(14),$(15))
111  $(if $(findstring $(LOG_LEVEL),trace), $(info *[2] <dependencies> = $(strip $2)))
112  $(if $(16),$(error Internal makefile error: Too many arguments to SetupArchive, please update JavaCompilation.gmk))
113
114  $1_JARMAIN:=$(strip $$($1_JARMAIN))
115  $1_JARNAME:=$$(notdir $$($1_JAR))
116  $1_MANIFEST_FILE:=$$(dir $$($1_JAR))_the.$$($1_JARNAME)_manifest
117  $1_DELETESS_FILE:=$$(dir $$($1_JAR))_the.$$($1_JARNAME)_deletess
118  $1_DELETES_FILE:=$$(dir $$($1_JAR))_the.$$($1_JARNAME)_deletes
119  $1_BIN:=$$(dir $$($1_JAR))
120
121  ifeq (,$$($1_SUFFIXES))
122    # No suffix was set, default to classes.
123    $1_SUFFIXES:=.class
124  endif
125  # Convert suffixes to a find expression
126  $1_FIND_PATTERNS:=$(FALSE_FIND_PATTERN) $$(patsubst %,$(SPACE)-o$(SPACE)-name$(SPACE)$(DQUOTE)*%$(DQUOTE),$$($1_SUFFIXES))
127  # On windows, a lot of includes/excludes risk making the command line too long, so
128  # writing the grep patterns to files.
129  # Grep returns 1 if nothing is matched. Do not fail the build for this.
130  ifneq (,$$($1_INCLUDES))
131    $1_GREP_INCLUDE_PATTERNS:=$$(call EscapeDollar, \
132        $$(foreach src,$$($1_SRCS), $$(addprefix $$(src)/,$$($1_INCLUDES))))
133    # If there are a lot of include patterns, output to file to shorten command lines
134    ifeq ($$(word 20,$$($1_GREP_INCLUDE_PATTERNS)),)
135      $1_GREP_INCLUDES:=| ( $(GREP) $$(patsubst %,$(SPACE)-e$(SPACE)$(DQUOTE)%$(DQUOTE),$$($1_GREP_INCLUDE_PATTERNS)) \
136          || test "$$$$?" = "1" )
137    else
138      $1_GREP_INCLUDE_OUTPUT:=$(RM) $$($1_BIN)/_the.$$($1_JARNAME)_include $$(NEWLINE) \
139          $$(call ListPathsSafely,$1_GREP_INCLUDE_PATTERNS,\n, \
140          >> $$($1_BIN)/_the.$$($1_JARNAME)_include)
141      $1_GREP_INCLUDES:=| ( $(GREP) -f $$($1_BIN)/_the.$$($1_JARNAME)_include \
142          || test "$$$$?" = "1" )
143    endif
144  endif
145  ifneq (,$$($1_EXCLUDES)$$($1_EXCLUDE_FILES))
146    $1_GREP_EXCLUDE_PATTERNS:=$$(call EscapeDollar, \
147        $$(foreach src,$$($1_SRCS),$$(addprefix $$(src)/, \
148        $$($1_EXCLUDES) $$($1_EXCLUDE_FILES))))
149    # If there are a lot of include patterns, output to file to shorten command lines
150    ifeq ($$(word 20,$$($1_GREP_EXCLUDE_PATTERNS)),)
151      $1_GREP_EXCLUDES:=| ( $(GREP) -v $$(patsubst %,$(SPACE)-e$(SPACE)$(DQUOTE)%$(DQUOTE),$$($1_GREP_EXCLUDE_PATTERNS)) \
152          || test "$$$$?" = "1" )
153    else
154      $1_GREP_EXCLUDE_OUTPUT=$(RM) $$($1_BIN)/_the.$$($1_JARNAME)_exclude $$(NEWLINE) \
155          $$(call ListPathsSafely,$1_GREP_EXCLUDE_PATTERNS,\n, \
156          >> $$($1_BIN)/_the.$$($1_JARNAME)_exclude)
157      $1_GREP_EXCLUDES:=| ( $(GREP) -v -f $$($1_BIN)/_the.$$($1_JARNAME)_exclude \
158          || test "$$$$?" = "1" )
159    endif
160  endif
161
162  # Check if this jar needs to have its index generated.
163  ifneq (,$$($1_JARINDEX))
164    $1_JARINDEX = (cd $$(dir $$@) && $(JAR) -i $$(notdir $$@))
165  else
166    $1_JARINDEX = true
167  endif
168  # When this macro is run in the same makefile as the java compilation, dependencies are
169  # transfered in make variables. When the macro is run in a different makefile than the
170  # java compilation, the dependencies need to be found in the filesystem.
171  ifneq (,$2)
172    $1_DEPS:=$2
173  else
174    # Add all source roots to the find cache since we are likely going to run find
175    # on these more than once. The cache will only be updated if necessary.
176    $$(eval $$(call FillCacheFind, $$($1_FIND_LIST)))
177    $1_DEPS:=$$(filter $$(addprefix %,$$($1_SUFFIXES)), \
178        $$(call CacheFind,$$($1_SRCS)))
179    ifneq (,$$($1_GREP_INCLUDE_PATTERNS))
180      $1_DEPS:=$$(filter $$(addsuffix %,$$($1_GREP_INCLUDE_PATTERNS)),$$($1_DEPS))
181    endif
182    ifneq (,$$($1_GREP_EXCLUDE_PATTERNS))
183      $1_DEPS:=$$(filter-out $$(addsuffix %,$$($1_GREP_EXCLUDE_PATTERNS)),$$($1_DEPS))
184    endif
185    # Look for EXTRA_FILES in all SRCS dirs and as absolute paths.
186    $1_DEPS+=$$(wildcard $$(foreach src, $$($1_SRCS), \
187        $$(addprefix $$(src)/, $$($1_EXTRA_FILES))) $$($1_EXTRA_FILES))
188    ifeq (,$$($1_SKIP_METAINF))
189      $1_DEPS+=$$(call CacheFind,$$(wildcard $$(addsuffix /META-INF,$$($1_SRCS))))
190    endif
191  endif
192  # The dependency list should never be empty
193  ifeq ($$(strip $$($1_DEPS)), )
194    $$(warning No dependencies found for $1)
195  endif
196
197  # Utility macros, to make the shell script receipt somewhat easier to decipher.
198
199  # Capture extra files is the same for both CAPTURE_CONTENTS and SCAPTURE_CONTENTS so
200  # only define it once to avoid duplication.
201  # The list of extra files might be long, so need to use ListPathsSafely to print
202  # them out to a separte file. Then process the contents of that file to rewrite
203  # into -C <dir> <file> lines.
204  # The EXTRA_FILES_RESOLVED varible must be set in the macro so that it's evaluated
205  # in the recipe when the files are guaranteed to exist.
206  $1_CAPTURE_EXTRA_FILES=\
207      $(RM) $$($1_BIN)/_the.$$($1_JARNAME)_contents.extra $$(NEWLINE) \
208      $$(eval $1_EXTRA_FILES_RESOLVED:=$$(call DoubleDollar, $$(call DoubleDollar, \
209          $$(wildcard $$(foreach src, $$($1_SRCS), \
210          $$(addprefix $$(src)/, $$($1_EXTRA_FILES))) $$($1_EXTRA_FILES))))) \
211      $$(if $$($1_EXTRA_FILES_RESOLVED), \
212        $$(call ListPathsSafely,$1_EXTRA_FILES_RESOLVED,\n, \
213            >> $$($1_BIN)/_the.$$($1_JARNAME)_contents.extra) $$(NEWLINE) \
214        $(SED) $$(foreach src,$$($1_SRCS), -e 's|$$(src)/|-C $$(src) |g') \
215            $$($1_BIN)/_the.$$($1_JARNAME)_contents.extra \
216            >> $$($1_BIN)/_the.$$($1_JARNAME)_contents $$(NEWLINE))
217
218  # The capture contents macro finds all files (matching the patterns, typically
219  # .class and .prp) that are newer than the jar-file, ie the new content to be put into the jar.
220  # NOTICE: please leave the parentheses space separated otherwise the AIX build will break!
221  $1_CAPTURE_CONTENTS=\
222      $(RM) $$($1_BIN)/_the.$$($1_JARNAME)_contents $$(NEWLINE) \
223      $$(foreach src,$$($1_SRCS), \
224        $(FIND) $$(src) -type f -a \( $$($1_FIND_PATTERNS) \) -a -newer $$@ $$($1_GREP_INCLUDES) \
225          $$($1_GREP_EXCLUDES) | $(SED) 's|$$(src)/|-C $$(src) |g' \
226        >> $$($1_BIN)/_the.$$($1_JARNAME)_contents $$(NEWLINE)) \
227      $$($1_CAPTURE_EXTRA_FILES)
228
229  # The capture metainf macro finds all files below the META-INF directory that are newer than the jar-file.
230  # Find returns non zero if the META-INF dir does not exist, ignore this.
231  ifeq (,$$($1_SKIP_METAINF))
232    $1_CAPTURE_METAINF =$$(foreach src,$$($1_SRCS), \
233        ( ( $(FIND) $$(src)/META-INF -type f -a -newer $$@ 2> /dev/null || true ) \
234            | $(SED) 's|$$(src)/|-C $$(src) |g' >> \
235        $$($1_BIN)/_the.$$($1_JARNAME)_contents ) $$(NEWLINE) )
236  endif
237  # The capture deletes macro finds all deleted files and concatenates them. The resulting file
238  # tells us what to remove from the jar-file.
239  $1_CAPTURE_DELETES=$$(foreach src,$$($1_SRCS),($(FIND) $$(src) -name _the.package.deleted -newer $$@ \
240      -exec $(SED) 's|$$(src)||g' \{\} >> $$($1_DELETES_FILE) \;) $$(NEWLINE))
241  # The update contents macro updates the jar file with the previously capture contents.
242  # Use 'wc -w' to see if the contents file is empty.
243  $1_UPDATE_CONTENTS=\
244      if [ "`$(WC) -l $$($1_BIN)/_the.$$($1_JARNAME)_contents | $(AWK) '{ print $$$$1 }'`" -gt "0" ]; then \
245        $(ECHO) "  updating" `$(WC) -l $$($1_BIN)/_the.$$($1_JARNAME)_contents | $(AWK) '{ print $$$$1 }'` files && \
246        $(JAR) $$($1_JAR_UPDATE_OPTIONS) $$@ @$$($1_BIN)/_the.$$($1_JARNAME)_contents; \
247      fi $$(NEWLINE)
248  # The s-variants of the above macros are used when the jar is created from scratch.
249  # NOTICE: please leave the parentheses space separated otherwise the AIX build will break!
250  $1_SCAPTURE_CONTENTS=\
251      $(RM) $$($1_BIN)/_the.$$($1_JARNAME)_contents $$(NEWLINE) \
252      $$(foreach src,$$($1_SRCS), \
253        $(FIND) $$(src) -type f -a \( $$($1_FIND_PATTERNS) \) $$($1_GREP_INCLUDES) \
254            $$($1_GREP_EXCLUDES) | $(SED) 's|$$(src)/|-C $$(src) |g' \
255            >> $$($1_BIN)/_the.$$($1_JARNAME)_contents $$(NEWLINE)) \
256      $$($1_CAPTURE_EXTRA_FILES)
257
258  # Find returns non zero if the META-INF dir does not exist, ignore this.
259  ifeq (,$$($1_SKIP_METAINF))
260    $1_SCAPTURE_METAINF=$$(foreach src,$$($1_SRCS), \
261        ( ( $(FIND) $$(src)/META-INF -type f 2> /dev/null || true ) \
262            | $(SED) 's|$$(src)/|-C $$(src) |g' >> \
263        $$($1_BIN)/_the.$$($1_JARNAME)_contents) $$(NEWLINE) )
264  endif
265  $1_SUPDATE_CONTENTS=$(JAR) $$($1_JAR_UPDATE_OPTIONS) $$@ @$$($1_BIN)/_the.$$($1_JARNAME)_contents $$(NEWLINE)
266
267  # Use a slightly shorter name for logging, but with enough path to identify this jar.
268  $1_NAME:=$$(subst $$(OUTPUT_ROOT)/,,$$($1_JAR))
269
270  ifneq (,$$($1_CHECK_COMPRESS_JAR))
271    $1_JAR_CREATE_OPTIONS := c0fm
272    $1_JAR_UPDATE_OPTIONS := u0f
273    ifeq ($(COMPRESS_JARS), true)
274      $1_JAR_CREATE_OPTIONS := cfm
275      $1_JAR_UPDATE_OPTIONS := uf
276    endif
277  else
278    $1_JAR_CREATE_OPTIONS := cfm
279    $1_JAR_UPDATE_OPTIONS := uf
280  endif
281
282  # Here is the rule that creates/updates the jar file.
283  $$($1_JAR) : $$($1_DEPS)
284	$(MKDIR) -p $$($1_BIN)
285	$$($1_GREP_INCLUDE_OUTPUT)
286	$$($1_GREP_EXCLUDE_OUTPUT)
287	$$(if $$($1_MANIFEST), \
288	  $(SED) -e "s#@@RELEASE@@#$(RELEASE)#" \
289	      -e "s#@@COMPANY_NAME@@#$(COMPANY_NAME)#" $$($1_MANIFEST) > $$($1_MANIFEST_FILE) \
290	, \
291	  $(RM) $$($1_MANIFEST_FILE) && $(TOUCH) $$($1_MANIFEST_FILE))
292	$$(if $$($1_JARMAIN),$(ECHO) "Main-Class: $$(strip $$($1_JARMAIN))" >> $$($1_MANIFEST_FILE))
293	$$(if $$($1_EXTRA_MANIFEST_ATTR),$(PRINTF) "$$($1_EXTRA_MANIFEST_ATTR)\n" >> $$($1_MANIFEST_FILE))
294	$$(if $$(wildcard $$@), \
295	  $(ECHO) Modifying $$($1_NAME) $$(NEWLINE) \
296	  $$($1_CAPTURE_CONTENTS) \
297	  $$($1_CAPTURE_METAINF) \
298	  $(RM) $$($1_DELETES_FILE) $$(NEWLINE) \
299	  $$($1_CAPTURE_DELETES) \
300	  $(CAT) $$($1_DELETES_FILE) > $$($1_DELETESS_FILE) $$(NEWLINE) \
301	  if [ -s $$($1_DELETESS_FILE) ]; then \
302	    $(ECHO) "  deleting" `$(WC) -l $$($1_DELETESS_FILE) | $(AWK) '{ print $$$$1 }'` files && \
303	    $(ZIP) -q -d $$@ `$(CAT) $$($1_DELETESS_FILE)` ; \
304	  fi $$(NEWLINE) \
305	  $$($1_UPDATE_CONTENTS) true $$(NEWLINE) \
306	  $$($1_JARINDEX) && true \
307	, \
308	  $(ECHO) Creating $$($1_NAME) && $(JAR) $$($1_JAR_CREATE_OPTIONS) $$@ $$($1_MANIFEST_FILE) $$(NEWLINE) \
309	  $$($1_SCAPTURE_CONTENTS) \
310	  $$($1_SCAPTURE_METAINF) \
311	  $$($1_SUPDATE_CONTENTS) \
312	  $$($1_JARINDEX) && true )
313
314  # Add jar to target list
315  $1 += $$($1_JAR)
316endef
317
318    $1_SRC_EXCLUDES := $$(foreach i,$$($1_SRC),$$(addprefix $$i/,$$(addsuffix /%,$$($1_EXCLUDES))))
319  ifneq ($$($1_EXCLUDE_FILES),)
320    # Cannot precompute ZIP_EXCLUDE_FILES as it is dependent on which src root is being
321    # zipped at the moment.
322    $1_SRC_EXCLUDE_FILES := $$(addprefix %, $$($1_EXCLUDE_FILES)) $$($1_EXCLUDE_FILES)
323    $1_ALL_SRCS := $$(filter-out $$($1_SRC_EXCLUDE_FILES), $$($1_ALL_SRCS))
324  endif
325define add_file_to_copy
326  # param 1 = BUILD_MYPACKAGE
327  # parma 2 = The source file to copy.
328  $2_TARGET:=$2
329  # Remove the source prefix.
330  $$(foreach i,$$($1_SRC),$$(eval $$(call remove_string,$$i,$2_TARGET)))
331  # To allow for automatic overrides, do not create a rule for a target file that
332  # already has one
333  ifeq ($$(findstring $$($2_TARGET), $$($1_COPY_LIST)), )
334    $1_COPY_LIST += $$($2_TARGET)
335    # Now we can setup the depency that will trigger the copying.
336    $$($1_BIN)$$($2_TARGET) : $2
337	$(MKDIR) -p $$(@D)
338	$(CP) $$< $$@
339	$(CHMOD) -f ug+w $$@
340
341    # And do not forget this target
342    $1_ALL_COPY_TARGETS += $$($1_BIN)$$($2_TARGET)
343  endif
344endef
345
346
347# This macro is used only for properties files that are to be
348# copied over to the classes directory in cleaned form:
349# Previously this was inconsistently done in different repositories.
350# This is the new clean standard. Though it is to be superseded by
351# a standard annotation processor from with sjavac.
352#
353# The sed expression does this:
354# 1. Add a backslash before any :, = or ! that do not have a backslash already.
355# 2. Apply the file unicode2x.sed which does a whole bunch of \u00XX to \xXX
356#    conversions.
357# 3. Delete all lines starting with #.
358# 4. Delete empty lines.
359# 5. Append lines ending with \ with the next line.
360# 6. Remove leading and trailing white space. Note that tabs must be explicit
361#    as sed on macosx does not understand '\t'.
362# 7. Replace the first \= with just =.
363# 8. Finally it's all sorted to create a stable output.
364#
365# It is assumed that = is the character used for separating names and values.
366define add_file_to_clean
367  # param 1 = BUILD_MYPACKAGE
368  # parma 2 = The source file to copy and clean.
369  $2_TARGET:=$2
370  # Remove the source prefix.
371  $$(foreach i,$$($1_SRC),$$(eval $$(call remove_string,$$i,$2_TARGET)))
372  # Now we can setup the depency that will trigger the copying.
373  $$($1_BIN)$$($2_TARGET) : $2
374	$(MKDIR) -p $$(@D)
375	export LC_ALL=C ; $(CAT) $$< \
376	    | $(SED) -e 's/\([^\\]\):/\1\\:/g' -e 's/\([^\\]\)=/\1\\=/g' \
377	        -e 's/\([^\\]\)!/\1\\!/g' -e 's/#.*/#/g' \
378	    | $(SED) -f "$(SRC_ROOT)/make/common/support/unicode2x.sed" \
379	    | $(SED) -e '/^#/d' -e '/^$$$$/d' \
380	        -e :a -e '/\\$$$$/N; s/\\\n//; ta' \
381	        -e 's/^[ 	]*//;s/[ 	]*$$$$//' \
382	        -e 's/\\=/=/' \
383	    | $(SORT) > $$@
384	$(CHMOD) -f ug+w $$@
385
386  # And do not forget this target
387  $1_ALL_COPY_CLEAN_TARGETS += $$($1_BIN)$$($2_TARGET)
388endef
389
390define remove_string
391  $2 := $$(subst $1,,$$($2))
392endef
393
394# Setup make rules for compiling Java source code to class files and/or a
395# resulting jar file.
396#
397# Parameter 1 is the name of the rule. This name is used as variable prefix,
398# and the targets generated are listed in a variable by that name.
399#
400# Remaining parameters are named arguments. These include:
401#   SETUP:=must point to a previously setup java compiler, for example: SETUP:=BOOTJAVAC
402#   JVM:=path to ..bin/java
403#   ADD_JAVAC_FLAGS:=javac flags to append to the default ones.
404#   SRC:=one or more directories to search for sources
405#   BIN:=store classes here
406#   INCLUDES:=myapp.foo means will only compile java files in myapp.foo or any of its sub-packages.
407#   EXCLUDES:=myapp.foo means will do not compile java files in myapp.foo or any of its sub-packages.
408#   COPY:=.prp means copy all prp files to the corresponding package in BIN.
409#   COPY_FILES:=myapp/foo/setting.txt means copy this file over to the package myapp/foo
410#   CLEAN:=.properties means copy and clean all properties file to the corresponding package in BIN.
411#   CLEAN_FILES:=myapp/foo/setting.txt means clean this file over to the package myapp/foo
412#   SRCZIP:=Create a src.zip based on the found sources and copied files.
413#   INCLUDE_FILES:="com/sun/SolarisFoobar.java" means only compile this file!
414#   EXCLUDE_FILES:="com/sun/SolarisFoobar.java" means do not compile this particular file!
415#       "SolarisFoobar.java" means do not compile SolarisFoobar, wherever it is found.
416#   HEADERS:=path to directory where all generated c-headers are written.
417#   DEPENDS:=Extra dependecy
418#   DISABLE_SJAVAC:=Explicitly disable the use of sjavac for this compilation unit.
419define SetupJavaCompilation
420  $(if $(16),$(error Internal makefile error: Too many arguments to SetupJavaCompilation, please update JavaCompilation.gmk))
421  $(call EvalDebugWrapper,$(strip $1),$(call SetupJavaCompilationInner,$(strip $1),$2,$3,$4,$5,$6,$7,$8,$9,$(10),$(11),$(12),$(13),$(14),$(15)))
422endef
423
424define SetupJavaCompilationInner
425  $(foreach i,2 3 4 5 6 7 8 9 10 11 12 13 14 15, $(if $($i),$1_$(strip $($i)))$(NEWLINE))
426  $(call LogSetupMacroEntry,SetupJavaCompilation($1),$2,$3,$4,$5,$6,$7,$8,$9,$(10),$(11),$(12),$(13),$(14),$(15))
427  $(if $(16),$(error Internal makefile error: Too many arguments to SetupJavaCompilation, please update JavaCompilation.gmk))
428
429  # Extract the info from the java compiler setup.
430  $1_JVM := $$($$($1_SETUP)_JVM)
431  $1_JAVAC := $$($$($1_SETUP)_JAVAC)
432  $1_FLAGS := $$($$($1_SETUP)_FLAGS) $(JAVAC_FLAGS) $$($1_ADD_JAVAC_FLAGS)
433  ifeq ($$($1_JAVAC),)
434    $$(error The Java compilation $1 refers to a non-existant java compiler setup $$($1_SETUP))
435  endif
436  $1_SJAVAC_PORTFILE := $$($$($1_SETUP)_SJAVAC_PORTFILE)
437  $1_SERVER_JVM := $$($$($1_SETUP)_SERVER_JVM)
438
439  # Handle addons and overrides.
440  $1_SRC:=$$(call ADD_SRCS,$$($1_SRC))
441  # Make sure the dirs exist.
442  $$(foreach d,$$($1_SRC), $$(if $$(wildcard $$d),,$$(error SRC specified to SetupJavaCompilation $1 contains missing directory $$d)))
443  $$(eval $$(call MakeDir,$$($1_BIN)))
444  # Add all source roots to the find cache since we are likely going to run find
445  # on these more than once. The cache will only be updated if necessary.
446  $$(eval $$(call FillCacheFind,$$($1_SRC)))
447  # Find all files in the source trees. Preserve order of source roots for overrides to
448  # work correctly. CacheFind does not preserve order so need to call it for each root.
449  $1_ALL_SRCS += $$(filter-out $(OVR_SRCS),$$(foreach s,$$($1_SRC),$$(call CacheFind,$$(s))))
450  # Extract the java files.
451  ifneq ($$($1_EXCLUDE_FILES),)
452    $1_EXCLUDE_FILES_PATTERN:=$$(addprefix %,$$($1_EXCLUDE_FILES))
453  endif
454  $1_SRCS := $$(filter-out $$($1_EXCLUDE_FILES_PATTERN),$$(filter %.java,$$($1_ALL_SRCS)))
455  ifneq ($$($1_INCLUDE_FILES),)
456    $1_INCLUDE_FILES:=$$(foreach i,$$($1_SRC),$$(addprefix $$i/,$$($1_INCLUDE_FILES)))
457    $1_SRCS := $$(filter $$($1_INCLUDE_FILES), $$($1_SRCS))
458  endif
459
460  # Now we have a list of all java files to compile: $$($1_SRCS)
461
462  # Create the corresponding smart javac wrapper command line.
463  $1_SJAVAC_ARGS:=$$(addprefix -x ,$$(addsuffix /*,$$($1_EXCLUDES))) \
464      $$(addprefix -i ,$$(addsuffix /*,$$($1_INCLUDES))) \
465      $$(addprefix -xf *,$$(strip $$($1_EXCLUDE_FILES))) \
466      $$(addprefix -if *,$$(strip $$($1_INCLUDE_FILES))) \
467      -src "$$(subst $$(SPACE),$$(PATH_SEP),$$(strip $$($1_SRC)))"
468
469  # Prepend the source/bin path to the filter expressions.
470  ifneq ($$($1_INCLUDES),)
471    $1_SRC_INCLUDES := $$(foreach i,$$($1_SRC),$$(addprefix $$i/,$$(addsuffix /%,$$($1_INCLUDES))))
472    $1_SRCS := $$(filter $$($1_SRC_INCLUDES),$$($1_SRCS))
473  endif
474  ifneq ($$($1_EXCLUDES),)
475    $1_SRC_EXCLUDES := $$(foreach i,$$($1_SRC),$$(addprefix $$i/,$$(addsuffix /%,$$($1_EXCLUDES))))
476    $1_SRCS := $$(filter-out $$($1_SRC_EXCLUDES),$$($1_SRCS))
477  endif
478
479  # All files below META-INF are always copied.
480  $1_ALL_COPIES := $$(filter $$(addsuffix /META-INF%,$$($1_SRC)),$$($1_ALL_SRCS))
481  # Find all files to be copied from source to bin.
482  ifneq (,$$($1_COPY)$$($1_COPY_FILES))
483    # Search for all files to be copied.
484    $1_ALL_COPIES += $$(filter $$(addprefix %,$$($1_COPY)),$$($1_ALL_SRCS))
485    # Copy these explicitly
486    $1_ALL_COPIES += $$($1_COPY_FILES)
487    # Copy must also respect filters.
488    ifneq (,$$($1_INCLUDES))
489      $1_ALL_COPIES := $$(filter $$($1_SRC_INCLUDES),$$($1_ALL_COPIES))
490    endif
491    ifneq (,$$($1_EXCLUDES))
492      $1_ALL_COPIES := $$(filter-out $$($1_SRC_EXCLUDES),$$($1_ALL_COPIES))
493    endif
494    ifneq (,$$($1_EXCLUDE_FILES))
495      $1_ALL_COPIES := $$(filter-out $$($1_EXCLUDE_FILES_PATTERN),$$($1_ALL_COPIES))
496    endif
497  endif
498    ifneq (,$$($1_ALL_COPIES))
499      # Yep, there are files to be copied!
500      $1_ALL_COPY_TARGETS:=
501          $$(foreach i,$$($1_ALL_COPIES),$$(eval $$(call add_file_to_copy,$1,$$i)))
502      # Now we can depend on $$($1_ALL_COPY_TARGETS) to copy all files!
503    endif
504
505  # Find all property files to be copied and cleaned from source to bin.
506  ifneq (,$$($1_CLEAN)$$($1_CLEAN_FILES))
507    # Search for all files to be copied.
508    $1_ALL_CLEANS := $$(filter $$(addprefix %,$$($1_CLEAN)),$$($1_ALL_SRCS))
509    # Clean these explicitly
510    $1_ALL_CLEANS += $$($1_CLEAN_FILES)
511    # Copy and clean must also respect filters.
512    ifneq (,$$($1_INCLUDES))
513      $1_ALL_CLEANS := $$(filter $$($1_SRC_INCLUDES),$$($1_ALL_CLEANS))
514    endif
515    ifneq (,$$($1_EXCLUDES))
516      $1_ALL_CLEANS := $$(filter-out $$($1_SRC_EXCLUDES),$$($1_ALL_CLEANS))
517    endif
518    ifneq (,$$($1_EXCLUDE_FILES))
519      $1_ALL_CLEANS := $$(filter-out $$($1_EXCLUDE_FILES_PATTERN),$$($1_ALL_CLEANS))
520    endif
521    ifneq (,$$($1_ALL_CLEANS))
522      # Yep, there are files to be copied and cleaned!
523      $1_ALL_COPY_CLEAN_TARGETS:=
524          $$(foreach i,$$($1_ALL_CLEANS),$$(eval $$(call add_file_to_clean,$1,$$i)))
525      # Now we can depend on $$($1_ALL_COPY_CLEAN_TARGETS) to copy all files!
526    endif
527  endif
528
529  # Create a sed expression to remove the source roots and to replace / with .
530  # and remove .java at the end.
531  $1_REWRITE_INTO_CLASSES:=$$(foreach i,$$($1_SRC),-e 's|$$i/||g') -e 's|/|.|g' -e 's|.java$$$$||g'
532
533  ifeq ($$($1_DISABLE_SJAVAC)x$$(ENABLE_SJAVAC),xyes)
534    ifneq (,$$($1_HEADERS))
535      $1_HEADERS_ARG := -h $$($1_HEADERS)
536    endif
537
538    # Using sjavac to compile.
539    $1_COMPILE_TARGETS := $$($1_BIN)/_the.$1_batch
540
541    # Create SJAVAC variable form JAVAC variable. Expects $1_JAVAC to be
542    # "bootclasspathprepend -cp .../javac.jar com.sun.tools.javac.Main"
543    # and javac is simply replaced with sjavac.
544    $1_SJAVAC:=$$(subst com.sun.tools.javac.Main,com.sun.tools.sjavac.Main,$$($1_JAVAC))
545
546    # Set the $1_REMOTE to spawn a background javac server.
547    $1_REMOTE:=--server:portfile=$$($1_SJAVAC_PORTFILE),id=$1,sjavac=$$(subst $$(SPACE),%20,$$(subst $$(COMMA),%2C,$$(strip $$($1_SERVER_JVM) $$($1_SJAVAC))))
548
549    $$($1_BIN)/_the.$1_batch: $$($1_SRCS) $$($1_DEPENDS)
550	$(MKDIR) -p $$(@D) $$(dir $$($1_SJAVAC_PORTFILE))
551        # As a workaround for sjavac not tracking api changed from the classpath, force full
552        # recompile if an external dependency, which is something other than a source
553        # change, triggered this compilation.
554	$$(if $$(filter-out $$($1_SRCS), $$?), $(FIND) $$(@D) -name "*.class" $(FIND_DELETE))
555	$$(call ListPathsSafely,$1_SRCS,\n, >> $$($1_BIN)/_the.$1_batch.tmp)
556	$(ECHO) Compiling $1
557	($$($1_JVM) $$($1_SJAVAC) \
558	    $$($1_REMOTE) \
559	    -j 1 \
560	    --permit-unidentified-artifacts \
561	    --permit-sources-without-package \
562	    --compare-found-sources $$($1_BIN)/_the.$1_batch.tmp \
563	    --log=$(LOG_LEVEL) \
564	    $$($1_SJAVAC_ARGS) \
565	    $$($1_FLAGS) \
566	    $$($1_HEADERS_ARG) \
567	    -d $$($1_BIN) && \
568	$(MV) $$($1_BIN)/_the.$1_batch.tmp $$($1_BIN)/_the.$1_batch)
569        # Create a pubapi file that only changes when the pubapi changes. Dependent
570        # compilations can use this file to only get recompiled when pubapi has changed.
571        # Grep returns 1 if no matching lines are found. Do not fail for this.
572	$(GREP) -e "^I" $$($1_BIN)/javac_state > $$($1_BIN)/_the.$1_pubapi.tmp \
573	    || test "$$$$?" = "1"
574	if [ ! -f $$($1_BIN)/_the.$1_pubapi ] \
575	    || [ "`$(DIFF) $$($1_BIN)/_the.$1_pubapi $$($1_BIN)/_the.$1_pubapi.tmp`" != "" ]; then \
576	  $(MV) $$($1_BIN)/_the.$1_pubapi.tmp $$($1_BIN)/_the.$1_pubapi; \
577	fi
578
579  else
580    # Using plain javac to batch compile everything.
581    $1_COMPILE_TARGETS := $$($1_BIN)/_the.$1_batch
582
583    # When building in batch, put headers in a temp dir to filter out those that actually
584    # changed before copying them to the real header dir.
585    ifneq (,$$($1_HEADERS))
586      $1_HEADERS_ARG := -h $$($1_HEADERS).$1.tmp
587
588      $$($1_HEADERS)/_the.$1_headers: $$($1_BIN)/_the.$1_batch
589		$(MKDIR) -p $$(@D)
590		if [ -d "$$($1_HEADERS).$1.tmp" ]; then \
591		  for f in `ls $$($1_HEADERS).$1.tmp`; do \
592		    if [ ! -f "$$($1_HEADERS)/$$$$f" ] \
593		        || [ "`$(DIFF) $$($1_HEADERS)/$$$$f $$($1_HEADERS).$1.tmp/$$$$f`" != "" ]; then \
594		    $(CP) -f $$($1_HEADERS).$1.tmp/$$$$f $$($1_HEADERS)/$$$$f; \
595		  fi; \
596		  done; \
597		fi
598		$(RM) -r $$($1_HEADERS).$1.tmp
599		$(TOUCH) $$@
600
601      $1_HEADER_TARGETS := $$($1_HEADERS)/_the.$1_headers
602    endif
603
604    # When not using sjavac, pass along all sources to javac using an @file.
605    $$($1_BIN)/_the.$1_batch: $$($1_SRCS) $$($1_DEPENDS)
606	$(MKDIR) -p $$(@D)
607	$(RM) $$($1_BIN)/_the.$1_batch $$($1_BIN)/_the.$1_batch.tmp
608	$$(call ListPathsSafely,$1_SRCS,\n, >> $$($1_BIN)/_the.$1_batch.tmp)
609	$(ECHO) Compiling `$(WC) $$($1_BIN)/_the.$1_batch.tmp | $(TR) -s ' ' | $(CUT) -f 2 -d ' '` files for $1
610	($$($1_JVM) $$($1_JAVAC) $$($1_FLAGS) \
611	    -implicit:none \
612	    -d $$($1_BIN) $$($1_HEADERS_ARG) @$$($1_BIN)/_the.$1_batch.tmp && \
613	$(MV) $$($1_BIN)/_the.$1_batch.tmp $$($1_BIN)/_the.$1_batch)
614
615  endif
616
617  # Add all targets to main variable
618  $1 := $$($1_ALL_COPY_TARGETS) $$($1_ALL_COPY_CLEAN_TARGETS) $$($1_COMPILE_TARGETS) \
619      $$($1_HEADER_TARGETS)
620
621  # Check if a jar file was specified, then setup the rules for the jar.
622  ifneq (,$$($1_JAR))
623    # If no suffixes was explicitly set for this jar file.
624    # Use class and the cleaned/copied properties file suffixes as the default
625    # for the types of files to be put into the jar.
626    ifeq (,$$($1_SUFFIXES))
627      $1_SUFFIXES:=.class $$($1_CLEAN) $$($1_COPY)
628    endif
629
630    $$(eval $$(call SetupArchive,ARCHIVE_$1,$$($1), \
631        SRCS:=$$($1_BIN), \
632        SUFFIXES:=$$($1_SUFFIXES), \
633        EXCLUDE:=$$($1_EXCLUDES), \
634        INCLUDES:=$$($1_INCLUDES), \
635        EXTRA_FILES:=$$($1_ALL_COPY_TARGETS) $$($1_ALL_COPY_CLEAN_TARGETS), \
636        JAR:=$$($1_JAR), \
637        JARMAIN:=$$($1_JARMAIN), \
638        MANIFEST:=$$($1_MANIFEST), \
639        EXTRA_MANIFEST_ATTR:=$$($1_EXTRA_MANIFEST_ATTR), \
640        JARINDEX:=$$($1_JARINDEX), \
641        HEADERS:=$$($1_HEADERS), \
642        SETUP:=$$($1_SETUP)))
643
644    # Add jar to target list
645    $1 += $$($1_JAR)
646  endif
647
648  # Check if a srczip was specified, then setup the rules for the srczip.
649  ifneq (,$$($1_SRCZIP))
650    $$(eval $$(call SetupZipArchive,ARCHIVE_$1, \
651        SRC:=$$($1_SRC), \
652        ZIP:=$$($1_SRCZIP), \
653        INCLUDES:=$$($1_INCLUDES), \
654        EXCLUDES:=$$($1_EXCLUDES), \
655        EXCLUDE_FILES:=$$($1_EXCLUDE_FILES)))
656
657    # Add zip to target list
658    $1 += $$($1_SRCZIP)
659  endif
660endef
661
662# Use this macro to find the correct target to depend on when the original
663# SetupJavaCompilation is declared in a different makefile, to avoid having
664# to declare and evaluate it again.
665# param 1 is for example BUILD_MYPACKAGE
666# param 2 is the output directory (BIN)
667define SetupJavaCompilationCompileTarget
668  $(if $(findstring yes, $(ENABLE_SJAVAC)), $(strip $2)/_the.$(strip $1)_pubapi, \
669      $(strip $2)/_the.$(strip $1)_batch)
670endef
671endif
672