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