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