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