JavaCompilation.gmk 27.9 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
#
# Copyright (c) 2011, 2012, Oracle and/or its affiliates. All rights reserved.
# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
#
# This code is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License version 2 only, as
# published by the Free Software Foundation.  Oracle designates this
# particular file as subject to the "Classpath" exception as provided
# by Oracle in the LICENSE file that accompanied this code.
#
# This code is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
# version 2 for more details (a copy is included in the LICENSE file that
# accompanied this code).
#
# You should have received a copy of the GNU General Public License version
# 2 along with this work; if not, write to the Free Software Foundation,
# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
#
# Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
# or visit www.oracle.com if you need additional information or have any
# questions.
#

26 27 28 29 30 31 32 33
# This makefile is much simpler now that it can use the smart javac wrapper
# for dependency tracking between java packages and incremental compiles.
# It could be even more simple if we added support for incremental jar updates
# directly from the smart javac wrapper.

# Cleaning/copying properties here is not a good solution. The properties
# should be cleaned/copied by a annotation processor in sjavac.

34 35 36 37 38 39 40 41 42 43 44
# When you read this source. Remember that $(sort ...) has the side effect
# of removing duplicates. It is actually this side effect that is
# desired whenever sort is used below!

ifeq  (,$(_MAKEBASE_GMK))
    $(error You must include MakeBase.gmk prior to including JavaCompilation.gmk)
endif

FALSE_FIND_PATTERN:=-name FILE_NAME_THAT_DOESNT_EXIST

define SetupJavaCompiler
45 46
    # param 1 is for example GENERATE_OLD_BYTECODE or GENERATE_NEW_JDKBYTECODE
    # This is the name of the compiler setup.
47 48 49 50 51 52
    # param 2-9 are named args.
    #   JVM:=The jvm used to run the javac/javah command
    #   JAVAC:=The javac jar and bootstrap classpath changes, or just bin/javac if JVM is left out
    #   FLAGS:=Flags to be supplied to javac
    #   SERVER_DIR:=Use a javac server (-XDserver) and store the server related files here
    #   SERVER_JVM:=Use this JVM for the server. Defaults to the JVM above.
O
ohair 已提交
53 54 55 56 57 58 59 60 61 62 63
    $(foreach i,2 3 4 5 6 7 8 9 10 11 12 13 14 15, $(if $($i),$1_$(strip $($i)))$(NEWLINE))
    $(call LogSetupMacroEntry,SetupJavaCompiler($1),$2,$3,$4,$5,$6,$7,$8,$9,$(10),$(11),$(12),$(13),$(14),$(15))
    $(if $(16),$(error Internal makefile error: Too many arguments to SetupJavaCompiler, please update JavaCompilation.gmk))

    # The port file contains the tcp/ip on which the server listens
    # and the cookie necessary to talk to the server.
    $1_SJAVAC_PORTFILE:=$$($1_SERVER_DIR)/server.port
    # You can use a different JVM to run the background javac server.
    ifeq ($$($1_SERVER_JVM),)
        # It defaults to the same JVM that is used to start the javac command.
        $1_SERVER_JVM:=$$($1_JVM)
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
    endif
endef

define SetupArchive
    # param 1 is for example ARCHIVE_MYPACKAGE
    # param 2 are the dependecies
    # param 3,4,5,6,7,8,9 are named args.
    #    SRCS:=List of directories in where to find files to add to archive
    #    SUFFIXES:=File suffixes to include in jar
    #    INCLUDES:=List of directories/packages in SRCS that should be included
    #    EXCLUDES:=List of directories/packages in SRCS that should be excluded
    #    EXCLUDE_FILES:=List of files in SRCS that should be excluded
    #    EXTRA_FILES:=List of files in SRCS that should be included regardless of suffix match.
    #    JAR:=Jar file to create
    #    MANIFEST:=Optional manifest file template.
    #    JARMAIN:=Optional main class to add to manifest
80
    #    JARINDEX:=true means generate the index in the jar file.
81 82 83
    #    SKIP_METAINF:=Set to prevent contents of an META-INF directory to be automatically 
    #                  added to the archive.
    #    EXTRA_MANIFEST_ATTR:=Extra attribute to add to manifest.
84
    #    CHECK_COMPRESS_JAR Check the COMPRESS_JAR variable
O
ohair 已提交
85 86 87 88 89

    # NOTE: $2 is dependencies, not a named argument!
    $(foreach i,3 4 5 6 7 8 9 10 11 12 13 14 15, $(if $($i),$1_$(strip $($i)))$(NEWLINE))
    $(call LogSetupMacroEntry,SetupArchive($1),<dependencies>,$3,$4,$5,$6,$7,$8,$9,$(10),$(11),$(12),$(13),$(14),$(15))
    $(if $(findstring $(LOG),debug trace), $(info *[2] <dependencies> = $(strip $2)))
90
    $(if $(16),$(error Internal makefile error: Too many arguments to SetupArchive, please update JavaCompilation.gmk))
91 92 93 94 95 96 97

    $1_JARMAIN:=$(strip $$($1_JARMAIN))
    $1_JARNAME:=$$(notdir $$($1_JAR))
    $1_MANIFEST_FILE:=$$(dir $$($1_JAR))_the.$$($1_JARNAME)_manifest
    $1_DELETESS_FILE:=$$(dir $$($1_JAR))_the.$$($1_JARNAME)_deletess
    $1_DELETES_FILE:=$$(dir $$($1_JAR))_the.$$($1_JARNAME)_deletes
    $1_BIN:=$$(dir $$($1_JAR))
98

99 100 101 102 103 104
    ifeq (,$$($1_SUFFIXES))
        # No suffix was set, default to classes.
        $1_SUFFIXES:=.class
    endif
    # Convert suffixes to a find expression
    $1_FIND_PATTERNS:=$(FALSE_FIND_PATTERN) $$(patsubst %,$(SPACE)-o$(SPACE)-name$(SPACE)$(DQUOTE)*%$(DQUOTE),$$($1_SUFFIXES))
105 106
    # On windows, a lot of includes/excludes risk making the command line too long, so 
    # writing the grep patterns to files.
107
    ifneq (,$$($1_INCLUDES))
108 109
        $1_GREP_INCLUDE_PATTERNS:=$$(foreach src,$$($1_SRCS),\
					$$(addprefix $$(src)/,$$($1_INCLUDES)))
O
ohair 已提交
110 111 112 113
        # If there are a lot of include patterns, output to file to shorten command lines
        ifeq ($$(word 20,$$($1_GREP_INCLUDE_PATTERNS)),)
            $1_GREP_INCLUDES:=| $(GREP) $$(patsubst %,$(SPACE)-e$(SPACE)$(DQUOTE)%$(DQUOTE),$$($1_GREP_INCLUDE_PATTERNS))
        else
114 115 116
            $1_GREP_INCLUDE_OUTPUT:=$(RM) $$($1_BIN)/_the.$$($1_JARNAME)_include && \
                                    $$(strip $$(call ListPathsSafely,$1_GREP_INCLUDE_PATTERNS,\n, \
                                        >> $$($1_BIN)/_the.$$($1_JARNAME)_include))
O
ohair 已提交
117 118
            $1_GREP_INCLUDES:=| $(GREP) -f $$($1_BIN)/_the.$$($1_JARNAME)_include
        endif
119 120
    endif
    ifneq (,$$($1_EXCLUDES)$$($1_EXCLUDE_FILES))
121 122
        $1_GREP_EXCLUDE_PATTERNS:=$$(foreach src,$$($1_SRCS),$$(addprefix $$(src)/,\
		$$($1_EXCLUDES) $$($1_EXCLUDE_FILES)))
O
ohair 已提交
123 124 125 126
        # If there are a lot of include patterns, output to file to shorten command lines
        ifeq ($$(word 20,$$($1_GREP_EXCLUDE_PATTERNS)),)
            $1_GREP_EXCLUDES:=| $(GREP) -v $$(patsubst %,$(SPACE)-e$(SPACE)$(DQUOTE)%$(DQUOTE),$$($1_GREP_EXCLUDE_PATTERNS))
        else
127 128 129
            $1_GREP_EXCLUDE_OUTPUT=$(RM) $$($1_BIN)/_the.$$($1_JARNAME)_exclude && \
                                    $$(strip $$(call ListPathsSafely,$1_GREP_EXCLUDE_PATTERNS,\n, \
                                        >> $$($1_BIN)/_the.$$($1_JARNAME)_exclude))
O
ohair 已提交
130 131
            $1_GREP_EXCLUDES:=| $(GREP) -v -f $$($1_BIN)/_the.$$($1_JARNAME)_exclude
        endif
132 133
    endif

134
    # Check if this jar needs to have its index generated.
135 136 137 138 139
    ifneq (,$$($1_JARINDEX))
      $1_JARINDEX = (cd $$(dir $$@) && $(JAR) -i $$(notdir $$@))
    else
      $1_JARINDEX = true
    endif
140 141 142
    # When this macro is run in the same makefile as the java compilation, dependencies are 
    # transfered in make variables. When the macro is run in a different makefile than the 
    # java compilation, the dependencies need to be found in the filesystem.
143 144 145
    ifneq (,$2)
        $1_DEPS:=$2
    else
146 147
        $1_DEPS:=$$(filter $$(addprefix %,$$($1_SUFFIXES)),\
                    $$(call CacheFind,$$($1_SRCS)))
148 149 150 151 152 153
        ifneq (,$$($1_GREP_INCLUDE_PATTERNS))
            $1_DEPS:=$$(filter $$(addsuffix %,$$($1_GREP_INCLUDE_PATTERNS)),$$($1_DEPS))
        endif
        ifneq (,$$($1_GREP_EXCLUDE_PATTERNS))
            $1_DEPS:=$$(filter-out $$(addsuffix %,$$($1_GREP_EXCLUDE_PATTERNS)),$$($1_DEPS))
        endif
O
ohair 已提交
154 155
        # The subst of \ is needed because $ has to be escaped with \ in EXTRA_FILES for the command 
        # 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 161
    endif

162 163 164 165
    # Utility macros, to make the shell script receipt somewhat easier to dechipher.

    # The capture contents macro finds all files (matching the patterns, typically
    # .class and .prp) that are newer than the jar-file, ie the new content to be put into the jar.
O
ohair 已提交
166 167 168 169 170
    $1_CAPTURE_CONTENTS=$$(foreach src,$$($1_SRCS),\
                   (($(FIND) $$(src) -type f -a \( $$($1_FIND_PATTERNS) \) -a -newer $$@ $$($1_GREP_INCLUDES) \
                       $$($1_GREP_EXCLUDES) | $(SED) 's|$$(src)/||g' &&\
                       $(ECHO) $$(subst $$(src)/,,$$($1_EXTRA_FILES))) > \
                       $$(src)/_the.$$($1_JARNAME)_contents) $$(NEWLINE))
171 172
    # The capture metainf macro finds all files below the META-INF directory that are newer than the jar-file.
    ifeq (,$$($1_SKIP_METAINF))
O
ohair 已提交
173
        $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))
174 175 176
    endif
    # The capture deletes macro finds all deleted files and concatenates them. The resulting file
    # tells us what to remove from the jar-file.
O
ohair 已提交
177
    $1_CAPTURE_DELETES=$$(foreach src,$$($1_SRCS),($(FIND) $$(src) -name _the.package.deleted -newer $$@ -exec $(SED) 's|$$(src)||g' \{\} >> $$($1_DELETES_FILE) \;) $$(NEWLINE))
178
    # The update contents macro updates the jar file with the previously capture contents.
179
    # xargs is used to trim the whitespace from the contents file, to see if it is empty.
180 181
    $1_UPDATE_CONTENTS=$$(foreach src,$$($1_SRCS),\
                    (cd $$(src) && \
182
                     if [ -n "`$(CAT) _the.$$($1_JARNAME)_contents | $(XARGS)`" ]; then \
183
                         $(ECHO) "  updating" `$(WC) -l _the.$$($1_JARNAME)_contents | $(AWK) '{ print $$$$1 }'` files && \
184
                         $(JAR) $$($1_JAR_UPDATE_OPTIONS) $$@ @_the.$$($1_JARNAME)_contents; \
O
ohair 已提交
185
                     fi) $$(NEWLINE))
186 187
    # The s-variants of the above macros are used when the jar is created from scratch.
    $1_SCAPTURE_CONTENTS=$$(foreach src,$$($1_SRCS),\
188
                    (($(FIND) $$(src) -type f -a \( $$($1_FIND_PATTERNS) \) $$($1_GREP_INCLUDES) \
O
ohair 已提交
189 190 191
			$$($1_GREP_EXCLUDES) | $(SED) 's|$$(src)/||g' &&\
			$$(subst $$(src)/,,$(ECHO) $$($1_EXTRA_FILES))) > \
			$$(src)/_the.$$($1_JARNAME)_contents) $$(NEWLINE))
192

193 194
    ifeq (,$$($1_SKIP_METAINF))
        $1_SCAPTURE_METAINF=$$(foreach src,$$($1_SRCS),\
195
                    ($(FIND) $$(src)/META-INF -type f 2> /dev/null | $(SED) 's|$$(src)/||g' >> \
O
ohair 已提交
196
			$$(src)/_the.$$($1_JARNAME)_contents) $$(NEWLINE))
197 198
    endif
    $1_SUPDATE_CONTENTS=$$(foreach src,$$($1_SRCS),\
O
ohair 已提交
199
                    (cd $$(src) && $(JAR) $$($1_JAR_UPDATE_OPTIONS) $$@ @$$(src)/_the.$$($1_JARNAME)_contents) $$(NEWLINE))
200

201 202
    # Use a slightly shorter name for logging, but with enough path to identify this jar.
    $1_NAME:=$$(subst $$(OUTPUT_ROOT)/,,$$($1_JAR))
203 204 205

    ifneq (,$$($1_CHECK_COMPRESS_JAR))
        $1_JAR_CREATE_OPTIONS := c0fm
206
        $1_JAR_UPDATE_OPTIONS := u0f
207 208
        ifeq ($(COMPRESS_JARS), true)
            $1_JAR_CREATE_OPTIONS := cfm
209
            $1_JAR_UPDATE_OPTIONS := uf
210 211 212
        endif
    else
        $1_JAR_CREATE_OPTIONS := cfm
213
        $1_JAR_UPDATE_OPTIONS := uf
214 215
    endif

216
    # Here is the rule that creates/updates the jar file.
217
    $$($1_JAR) : $$($1_DEPS)
218
	$(MKDIR) -p $$($1_BIN)
219 220
	$$($1_GREP_INCLUDE_OUTPUT)
	$$($1_GREP_EXCLUDE_OUTPUT)
O
ohair 已提交
221
	$$(if $$($1_MANIFEST),\
222
		$(SED) -e "s#@@RELEASE@@#$(RELEASE)#"           \
O
ohair 已提交
223 224 225 226 227 228 229
		       -e "s#@@COMPANY_NAME@@#$(COMPANY_NAME)#" $$($1_MANIFEST) > $$($1_MANIFEST_FILE) \
	,\
		$(RM) $$($1_MANIFEST_FILE) && $(TOUCH) $$($1_MANIFEST_FILE))
	$$(if $$($1_JARMAIN),$(ECHO) "Main-Class: $$(strip $$($1_JARMAIN))" >> $$($1_MANIFEST_FILE))
	$$(if $$($1_EXTRA_MANIFEST_ATTR),$(PRINTF) "$$($1_EXTRA_MANIFEST_ATTR)\n" >> $$($1_MANIFEST_FILE))
	$$(if $$(wildcard $$@),\
		$(ECHO) Modifying $$($1_NAME) $$(NEWLINE)\
230 231
		$$($1_CAPTURE_CONTENTS) \
		$$($1_CAPTURE_METAINF) \
O
ohair 已提交
232
		$(RM) $$($1_DELETES_FILE) $$(NEWLINE)\
233
		$$($1_CAPTURE_DELETES) \
O
ohair 已提交
234
		$(CAT) $$($1_DELETES_FILE) > $$($1_DELETESS_FILE) $$(NEWLINE)\
235 236 237
		if [ -s $$($1_DELETESS_FILE) ]; then \
			$(ECHO) "  deleting" `$(WC) -l $$($1_DELETESS_FILE) | $(AWK) '{ print $$$$1 }'` files && \
	                       $(ZIP) -q -d $$@ `$(CAT) $$($1_DELETESS_FILE)` ; \
O
ohair 已提交
238 239 240 241 242
		fi $$(NEWLINE) \
		$$($1_UPDATE_CONTENTS) true $$(NEWLINE) \
		$$($1_JARINDEX) && true \
	,\
		$(ECHO) Creating $$($1_NAME) && $(JAR) $$($1_JAR_CREATE_OPTIONS) $$@ $$($1_MANIFEST_FILE) $$(NEWLINE) \
243 244 245
	        $$($1_SCAPTURE_CONTENTS) \
		$$($1_SCAPTURE_METAINF) \
		$$($1_SUPDATE_CONTENTS) \
O
ohair 已提交
246
		$$($1_JARINDEX) && true ) 
247 248 249 250 251 252

endef

define SetupZipArchive
    # param 1 is for example ZIP_MYSOURCE
    # param 2,3,4,5,6,7,8,9 are named args.
E
erikj 已提交
253
    #    SRC,ZIP,INCLUDES,INCLUDE_FILES,EXCLUDES,EXCLUDE_FILES,SUFFIXES,EXTRA_DEPS
O
ohair 已提交
254 255 256
    $(foreach i,2 3 4 5 6 7 8 9 10 11 12 13 14 15, $(if $($i),$1_$(strip $($i)))$(NEWLINE))
    $(call LogSetupMacroEntry,SetupZipArchive($1),$2,$3,$4,$5,$6,$7,$8,$9,$(10),$(11),$(12),$(13),$(14),$(15))
    $(if $(16),$(error Internal makefile error: Too many arguments to SetupZipArchive, please update JavaCompilation.gmk))
257 258

    # Find all files in the source tree.
259 260
    $1_ALL_SRCS := $$(call not-containing,_the.,\
            $$(filter $$(addprefix %,$$($1_SUFFIXES)),$$(call CacheFind $$($1_SRC))))
261 262 263

    ifneq ($$($1_INCLUDES),)
        $1_SRC_INCLUDES := $$(foreach i,$$($1_SRC),$$(addprefix $$i/,$$(addsuffix /%,$$($1_INCLUDES))))
264 265 266 267 268 269
        ifneq ($$($1_SUFFIXES),)
            $1_ZIP_INCLUDES := $$(foreach s,$$($1_SUFFIXES),\
		$$(addprefix -i$(SPACE)$(DQUOTE),$$(addsuffix /*$$s$(DQUOTE),$$($1_INCLUDES))))
        else
            $1_ZIP_INCLUDES := $$(addprefix -i$(SPACE)$(DQUOTE),$$(addsuffix /*$(DQUOTE),$$($1_INCLUDES)))
        endif
E
erikj 已提交
270 271 272 273 274 275
    endif
    ifneq ($$($1_INCLUDE_FILES),)
        $1_SRC_INCLUDES += $$(foreach i,$$($1_SRC),$$(addprefix $$i/,$$($1_INCLUDE_FILES)))
        $1_ZIP_INCLUDES += $$(addprefix -i$(SPACE),$$($1_INCLUDE_FILES))
    endif
    ifneq ($$($1_SRC_INCLUDES),)
276 277 278 279 280
        $1_ALL_SRCS     := $$(filter $$($1_SRC_INCLUDES),$$($1_ALL_SRCS))
    endif
    ifneq ($$($1_EXCLUDES),)
        $1_SRC_EXCLUDES := $$(foreach i,$$($1_SRC),$$(addprefix $$i/,$$(addsuffix /%,$$($1_EXCLUDES))))
        $1_ZIP_EXCLUDES := $$(addprefix -x$(SPACE)$(DQUOTE),$$(addsuffix /*$(DQUOTE),$$($1_EXCLUDES)))
O
ohair 已提交
281
        $1_ALL_SRCS     := $$(filter-out $$($1_SRC_EXCLUDES),$$($1_ALL_SRCS))
282 283 284 285 286 287 288 289 290 291
    endif

    # Use a slightly shorter name for logging, but with enough path to identify this zip.
    $1_NAME:=$$(subst $$(OUTPUT_ROOT)/,,$$($1_ZIP))

    # Now $1_ALL_SRCS should contain all sources that are going to be put into the zip.
    # I.e. the zip -i and -x options should match the filtering done in the makefile.
    # Explicitly excluded files can be given with absolute path. The patsubst solution
    # isn't perfect but the likelyhood of an absolute path to match something in a src
    # dir is very small.
292 293
    # If zip has nothing to do, it returns 12 and would fail the build. Check for 12
    # and only fail if it's not.
294
    $$($1_ZIP) : $$($1_ALL_SRCS) $$($1_EXTRA_DEPS)
295 296
		$(MKDIR) -p $$(@D)
		$(ECHO) Updating $$($1_NAME)
297
		$$(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
298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320
		$(TOUCH) $$@
endef

define add_file_to_copy
    # param 1 = BUILD_MYPACKAGE
    # parma 2 = The source file to copy.
    $2_TARGET:=$2
    # Remove the source prefix. 
    $$(foreach i,$$($1_SRC),$$(eval $$(call remove_string,$$i,$2_TARGET)))
    # Now we can setup the depency that will trigger the copying.
    $$($1_BIN)$$($2_TARGET) : $2
	$(MKDIR) -p $$(@D)
	$(CP) $$< $$@
	$(CHMOD) -f ug+w $$@

    # And do not forget this target
    $1_ALL_COPY_TARGETS += $$($1_BIN)$$($2_TARGET)
endef


# This macro is used only for properties files that are to be
# copied over to the classes directory in cleaned form:
# Previously this was inconsistently done in different repositories.
321 322
# This is the new clean standard. Though it is to be superseded by
# a standard annotation processor from with sjavac.
323 324 325 326 327 328 329 330 331 332
define add_file_to_copy_and_clean
    # param 1 = BUILD_MYPACKAGE
    # parma 2 = The source file to copy and clean.
    $2_TARGET:=$2
    # Remove the source prefix. 
    $$(foreach i,$$($1_SRC),$$(eval $$(call remove_string,$$i,$2_TARGET)))
    # Now we can setup the depency that will trigger the copying.
    $$($1_BIN)$$($2_TARGET) : $2
	$(MKDIR) -p $$(@D)
	$(CAT) $$< | $(SED) -e 's/\([^\\]\):/\1\\:/g' -e  's/\([^\\]\)=/\1\\=/g' -e 's/#.*/#/g' \
O
ohair 已提交
333
                   | $(SED) -f "$(SRC_ROOT)/common/makefiles/support/unicode2x.sed" \
334 335 336
		   | $(SED) -e '/^#/d' -e '/^$$$$/d' \
		            -e :a -e '/\\$$$$/N; s/\\\n//; ta' \
			    -e 's/^[ \t]*//;s/[ \t]*$$$$//' \
337
			    -e 's/\\=/=/' | LANG=C $(SORT) > $$@
338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371
	$(CHMOD) -f ug+w $$@

    # And do not forget this target
    $1_ALL_COPY_CLEAN_TARGETS += $$($1_BIN)$$($2_TARGET)
endef

define remove_string
    $2 := $$(subst $1,,$$($2))
endef

define replace_space_with_pathsep
    $1:=$(subst $(SPACE),$(PATH_SEP),$(strip $(patsubst %,%,$2)))
endef

define SetupJavaCompilation
    # param 1 is for example BUILD_MYPACKAGE
    # param 2,3,4,5,6,7,8 are named args.
    #    SETUP:=must point to a previously setup java compiler, for example: SETUP:=BOOTJAVAC
    #    JVM:=path to ..bin/java
    #    ADD_JAVAC_FLAGS:=javac flags to append to the default ones.
    #    SRC:=one or more directories to search for sources
    #    BIN:=store classes here
    #    INCLUDES:=myapp.foo means will only compile java files in myapp.foo or any of its sub-packages.
    #    EXCLUDES:=myapp.foo means will do not compile java files in myapp.foo or any of its sub-packages.
    #    COPY:=.prp means copy all prp files to the corresponding package in BIN.
    #    CLEAN:=.properties means copy and clean all properties file to the corresponding package in BIN.
    #    COPY_FILES:=myapp/foo/setting.txt means copy this file over to the package myapp/foo
    #    SRCZIP:=Create a src.zip based on the found sources and copied files.
    #    INCLUDE_FILES:="com/sun/SolarisFoobar.java" means only compile this file!
    #    EXCLUDE_FILES:="com/sun/SolarisFoobar.java" means do not compile this particular file!
    #                   "SolarisFoobar.java" means do not compile SolarisFoobar, wherever it is found.
    #    JAVAC_SOURCE_PATH_UGLY_OVERRIDE:=Don't use this. This forces an explicit -sourcepath to javac.
    #                                     Its only here until we cleanup some nasty source code pasta in the jdk.
    #    HEADERS:=path to directory where all generated c-headers are written.
372
    #    DEPENDS:=Extra dependecy
O
ohair 已提交
373 374 375
    $(foreach i,2 3 4 5 6 7 8 9 10 11 12 13 14 15, $(if $($i),$1_$(strip $($i)))$(NEWLINE))
    $(call LogSetupMacroEntry,SetupJavaCompilation($1),$2,$3,$4,$5,$6,$7,$8,$9,$(10),$(11),$(12),$(13),$(14),$(15))
    $(if $(16),$(error Internal makefile error: Too many arguments to SetupJavaCompilation, please update JavaCompilation.gmk))
376

377 378 379 380 381
    # Extract the info from the java compiler setup.
    $1_JVM   := $$($$($1_SETUP)_JVM)
    $1_JAVAC := $$($$($1_SETUP)_JAVAC)
    $1_FLAGS := $$($$($1_SETUP)_FLAGS) $(JAVAC_FLAGS) $$($1_ADD_JAVAC_FLAGS)
    ifeq ($$($1_JAVAC),)
382 383
        $$(error The Java compilation $1 refers to a non-existant java compiler setup $$($1_SETUP))
    endif
O
ohair 已提交
384 385
    $1_SJAVAC_PORTFILE := $$($$($1_SETUP)_SJAVAC_PORTFILE)
    $1_SERVER_JVM := $$($$($1_SETUP)_SERVER_JVM)
386

387 388 389
    # Handle addons and overrides.
    $1_SRC:=$$(call ADD_SRCS,$$($1_SRC))
    # Make sure the dirs exist.
O
ohair 已提交
390 391
    $$(foreach d,$$($1_SRC), $$(if $$(wildcard $$d),,$$(error SRC specified to SetupJavaCompilation $1 contains missing directory $$d)))
    $$(eval $$(call MakeDir,$$($1_BIN)))
392
    # Find all files in the source trees.
393
    $1_ALL_SRCS += $$(filter-out $(OVR_SRCS),$$(call CacheFind,$$($1_SRC)))
394 395 396
    # Extract the java files.
    ifneq ($$($1_EXCLUDE_FILES),)
        $1_EXCLUDE_FILES_PATTERN:=$$(addprefix %,$$($1_EXCLUDE_FILES))
397
    endif
398 399 400 401
    $1_SRCS     := $$(filter-out $$($1_EXCLUDE_FILES_PATTERN),$$(filter %.java,$$($1_ALL_SRCS)))
    ifneq ($$($1_INCLUDE_FILES),)
        $1_INCLUDE_FILES:=$$(foreach i,$$($1_SRC),$$(addprefix $$i/,$$($1_INCLUDE_FILES)))
        $1_SRCS := $$(filter $$($1_INCLUDE_FILES), $$($1_SRCS))
402 403
    endif

404 405 406 407 408 409 410 411 412 413 414 415 416
    # Now we have a list of all java files to compile: $$($1_SRCS)

    # Create the corresponding smart javac wrapper command line.
    $1_SJAVAC_ARGS:=$$(addprefix -x ,$$(addsuffix .*,$$(subst /,.,$$($1_EXCLUDES)))) \
		$$(addprefix -i ,$$(addsuffix .*,$$(subst /,.,$$($1_INCLUDES)))) \
		$$(addprefix -xf *,$$(strip $$($1_EXCLUDE_FILES))) \
		$$(addprefix -if *,$$(strip $$($1_INCLUDE_FILES))) \
		-src "$$(subst $$(SPACE),$$(PATH_SEP),$$(strip $$($1_SRC)))"

    # Prepend the source/bin path to the filter expressions.
    ifneq ($$($1_INCLUDES),)
        $1_SRC_INCLUDES := $$(foreach i,$$($1_SRC),$$(addprefix $$i/,$$(addsuffix /%,$$($1_INCLUDES))))
        $1_SRCS     := $$(filter $$($1_SRC_INCLUDES),$$($1_SRCS))
417
    endif
418 419 420
    ifneq ($$($1_EXCLUDES),)
        $1_SRC_EXCLUDES := $$(foreach i,$$($1_SRC),$$(addprefix $$i/,$$(addsuffix /%,$$($1_EXCLUDES))))
        $1_SRCS     := $$(filter-out $$($1_SRC_EXCLUDES),$$($1_SRCS))
421
    endif
422 423 424 425

    # Find all files to be copied from source to bin.
    ifneq (,$$($1_COPY))
        # Search for all files to be copied.
O
ohair 已提交
426
        $1_ALL_COPIES := $$(filter $$(addprefix %,$$($1_COPY)),$$($1_ALL_SRCS))
427 428 429 430 431 432 433 434 435 436 437 438 439
        # Copy these explicitly
        $1_ALL_COPIES += $$($1_COPY_FILES)
        # Copy must also respect filters.
        ifneq (,$$($1_INCLUDES))
            $1_ALL_COPIES := $$(filter $$($1_SRC_INCLUDES),$$($1_ALL_COPIES))
        endif
        ifneq (,$$($1_EXCLUDES))
            $1_ALL_COPIES := $$(filter-out $$($1_SRC_EXCLUDES),$$($1_ALL_COPIES))
        endif
        ifneq (,$$($1_EXCLUDE_FILES))
            $1_ALL_COPIES := $$(filter-out $$($1_EXCLUDE_FILES_PATTERN),$$($1_ALL_COPIES))
        endif
        # All files below META-INF are always copied.
O
ohair 已提交
440
        $1_ALL_COPIES += $$(filter $$(addsuffix /META-INF%,$$($1_SRC)),$$($1_ALL_SRCS))
441 442 443 444 445 446
        ifneq (,$$($1_ALL_COPIES))
            # Yep, there are files to be copied!
            $1_ALL_COPY_TARGETS:=
            $$(foreach i,$$($1_ALL_COPIES),$$(eval $$(call add_file_to_copy,$1,$$i)))
            # Now we can depend on $$($1_ALL_COPY_TARGETS) to copy all files!
        endif
447 448
    endif

449 450 451
    # Find all property files to be copied and cleaned from source to bin.
    ifneq (,$$($1_CLEAN))
        # Search for all files to be copied.
O
ohair 已提交
452
        $1_ALL_CLEANS := $$(filter $$(addprefix %,$$($1_CLEAN)),$$($1_ALL_SRCS))
453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469
        # Copy and clean must also respect filters.
        ifneq (,$$($1_INCLUDES))
            $1_ALL_CLEANS := $$(filter $$($1_SRC_INCLUDES),$$($1_ALL_CLEANS))
        endif
        ifneq (,$$($1_EXCLUDES))
            $1_ALL_CLEANS := $$(filter-out $$($1_SRC_EXCLUDES),$$($1_ALL_CLEANS))
        endif
        ifneq (,$$($1_EXCLUDE_FILES))
            $1_ALL_CLEANS := $$(filter-out $$($1_EXCLUDE_FILES_PATTERN),$$($1_ALL_CLEANS))
        endif
        ifneq (,$$($1_ALL_CLEANS))
            # Yep, there are files to be copied and cleaned!
            $1_ALL_COPY_CLEAN_TARGETS:=
            $$(foreach i,$$($1_ALL_CLEANS),$$(eval $$(call add_file_to_copy_and_clean,$1,$$i)))
            # Now we can depend on $$($1_ALL_COPY_CLEAN_TARGETS) to copy all files!
        endif
    endif
470 471 472 473 474 475 476 477 478 479 480 481

    # Prep the source paths.
    ifneq ($$($1_JAVAC_SOURCE_PATH_UGLY_OVERRIDE),)
      $$(eval $$(call replace_space_with_pathsep,$1_SRCROOTSC,$$($1_JAVAC_SOURCE_PATH_UGLY_OVERRIDE)))
    else
      $$(eval $$(call replace_space_with_pathsep,$1_SRCROOTSC,$$($1_SRC)))
    endif

    # Create a sed expression to remove the source roots and to replace / with .
    # and remove .java at the end. 
    $1_REWRITE_INTO_CLASSES:=$$(foreach i,$$($1_SRC),-e 's|$$i/||g') -e 's|/|.|g' -e 's|.java$$$$||g'

482
    ifeq ($$($1_DISABLE_SJAVAC)x$$(ENABLE_SJAVAC),xyes)
O
ohair 已提交
483 484 485 486
        ifneq (,$$($1_HEADERS))
            $1_HEADERS_ARG := -h $$($1_HEADERS)
        endif

487 488
        # Using sjavac to compile. 
        $1 := $$($1_ALL_COPY_TARGETS) $$($1_ALL_COPY_CLEAN_TARGETS) $$($1_BIN)/javac_state
489

490 491 492 493
        # Create SJAVAC variable form JAVAC variable. Expects $1_JAVAC to be 
        # "bootclasspathprepend -cp .../javac.jar com.sun.tools.javac.Main"
        # and javac is simply replaced with sjavac.
        $1_SJAVAC:=$$(subst com.sun.tools.javac.Main,com.sun.tools.sjavac.Main,$$($1_JAVAC))
O
ohair 已提交
494 495

        # Set the $1_REMOTE to spawn a background javac server.
496
        $1_REMOTE:=--server:portfile=$$($1_SJAVAC_PORTFILE),id=$1,sjavac=$$(subst $$(SPACE),%20,$$(subst $$(COMMA),%2C,$$(strip $$($1_SERVER_JVM) $$($1_SJAVAC))))
O
ohair 已提交
497

498 499 500 501
        $$($1_BIN)/javac_state: $$($1_SRCS) $$($1_DEPENDS)
		$(MKDIR) -p $$(@D)
		$$(call ListPathsSafely,$1_SRCS,\n, >> $$($1_BIN)/_the.batch.tmp)
		$(ECHO) Compiling $1
502 503 504
		($$($1_JVM) $$($1_SJAVAC) \
			$$($1_REMOTE) \
			-j $(NUM_CORES) \
O
ohair 已提交
505 506 507
			--permit-unidentified-artifacts \
			--permit-sources-without-package \
			--compare-found-sources $$($1_BIN)/_the.batch.tmp \
508 509
			--log=$(LOG) \
			$$($1_SJAVAC_ARGS) \
510
			$$($1_FLAGS) \
511 512 513
			$$($1_HEADERS_ARG) \
			-d $$($1_BIN) && \
			$(MV) $$($1_BIN)/_the.batch.tmp $$($1_BIN)/_the.batch)
514 515 516
    else
        # Using plain javac to batch compile everything.
        $1 := $$($1_ALL_COPY_TARGETS) $$($1_ALL_COPY_CLEAN_TARGETS) $$($1_BIN)/_the.batch
517

O
ohair 已提交
518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535
        # When buliding in batch, put headers in a temp dir to filter out those that actually
        # changed before copying them to the real header dir.
        ifneq (,$$($1_HEADERS))
            $1_HEADERS_ARG := -h $$($1_HEADERS).tmp

            $$($1_HEADERS)/_the.headers: $$($1_BIN)/_the.batch
		$(MKDIR) -p $$(@D)
		for f in `ls $$($1_HEADERS).tmp`; do \
		  if [ ! -f "$$($1_HEADERS)/$$$$f" ] || [ "`$(DIFF) $$($1_HEADERS)/$$$$f $$($1_HEADERS).tmp/$$$$f`" != "" ]; then \
		    $(CP) -f $$($1_HEADERS).tmp/$$$$f $$($1_HEADERS)/$$$$f; \
		  fi; \
		done
		$(RM) -r $$($1_HEADERS).tmp
		$(TOUCH) $$@

            $1 += $$($1_HEADERS)/_the.headers
        endif

536 537 538 539 540 541 542 543 544 545
        # When not using sjavac, pass along all sources to javac using an @file.
        $$($1_BIN)/_the.batch: $$($1_SRCS) $$($1_DEPENDS)
		$(MKDIR) -p $$(@D)
		$(RM) $$($1_BIN)/_the.batch $$($1_BIN)/_the.batch.tmp
		$$(call ListPathsSafely,$1_SRCS,\n, >> $$($1_BIN)/_the.batch.tmp)
		$(ECHO) Compiling `$(WC) $$($1_BIN)/_the.batch.tmp | $(TR) -s ' ' | $(CUT) -f 2 -d ' '` files for $1
		($$($1_JVM) $$($1_JAVAC) $$($1_FLAGS) \
			-implicit:none -sourcepath "$$($1_SRCROOTSC)" \
			-d $$($1_BIN) $$($1_HEADERS_ARG) @$$($1_BIN)/_the.batch.tmp && \
			$(MV) $$($1_BIN)/_the.batch.tmp $$($1_BIN)/_the.batch)
O
ohair 已提交
546

547 548
    endif

549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571
    # Check if a jar file was specified, then setup the rules for the jar.
    ifneq (,$$($1_JAR))
        # If no suffixes was explicitly set for this jar file.
        # Use class and the cleaned/copied properties file suffixes as the default
        # for the types of files to be put into the jar.
        ifeq (,$$($1_SUFFIXES))
            $1_SUFFIXES:=.class $$($1_CLEAN) $$($1_COPY)
        endif

        $$(eval $$(call SetupArchive,ARCHIVE_$1,$$($1),\
		SRCS:=$$($1_BIN),\
		SUFFIXES:=$$($1_SUFFIXES),\
		EXCLUDE:=$$($1_EXCLUDES),\
		INCLUDES:=$$($1_INCLUDES),\
		EXTRA_FILES:=$$($1_ALL_COPY_TARGETS) $$($1_ALL_COPY_CLEAN_TARGETS),\
		JAR:=$$($1_JAR),\
		JARMAIN:=$$($1_JARMAIN),\
		MANIFEST:=$$($1_MANIFEST),\
		EXTRA_MANIFEST_ATTR:=$$($1_EXTRA_MANIFEST_ATTR),\
		JARINDEX:=$$($1_JARINDEX),\
		HEADERS:=$$($1_HEADERS),\
		SETUP:=$$($1_SETUP)))
    endif
572

573 574 575
    # Check if a srczip was specified, then setup the rules for the srczip.
    ifneq (,$$($1_SRCZIP))
        $$(eval $$(call SetupZipArchive,ARCHIVE_$1,\
576 577 578 579 580
		SRC:=$$($1_SRC),\
		ZIP:=$$($1_SRCZIP),\
		INCLUDES:=$$($1_INCLUDES),\
		EXCLUDES:=$$($1_EXCLUDES),\
		EXCLUDE_FILES:=$$($1_EXCLUDE_FILES)))
581
    endif
582 583

endef