/[gentoo-x86]/eclass/java-utils-2.eclass
Gentoo

Contents of /eclass/java-utils-2.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.162 - (hide annotations) (download)
Sun May 24 22:44:37 2015 UTC (3 years, 9 months ago) by chewi
Branch: MAIN
Changes since 1.161: +1 -13 lines
The depend-java-query wrapper is raising readonly variable warnings
for USE in Portage 2.2.20. As best I can tell, this wrapper just isn't
needed any more because USE is already exported. I guess it wasn't
back in 2006?

1 nichoj 1.1 # Base eclass for Java packages
2     #
3     # Copyright (c) 2004-2005, Thomas Matthijs <axxo@gentoo.org>
4     # Copyright (c) 2004, Karl Trygve Kalleberg <karltk@gentoo.org>
5 chewi 1.158 # Copyright (c) 2004-2015, Gentoo Foundation
6 nichoj 1.1 #
7     # Licensed under the GNU General Public License, v2
8     #
9 chewi 1.162 # $Header: /var/cvsroot/gentoo-x86/eclass/java-utils-2.eclass,v 1.161 2015/05/09 22:20:44 chewi Exp $
10 nichoj 1.1
11 caster 1.155 # @ECLASS: java-utils-2.eclass
12     # @MAINTAINER:
13     # java@gentoo.org
14     # @AUTHOR:
15     # Thomas Matthijs <axxo@gentoo.org>, Karl Trygve Kalleberg <karltk@gentoo.org>
16     # @BLURB: Base eclass for Java packages
17     # @DESCRIPTION:
18     # This eclass provides functionality which is used by java-pkg-2.eclass,
19     # java-pkg-opt-2.eclass and java-ant-2 eclass, as well as from ebuilds.
20     #
21     # This eclass should not be inherited this directly from an ebuild. Instead,
22     # you should inherit java-pkg-2 for Java packages or java-pkg-opt-2 for packages
23     # that have optional Java support. In addition you can inherit java-ant-2 for
24 chewi 1.157 # Ant-based packages.
25 nichoj 1.1 inherit eutils versionator multilib
26    
27 flameeyes 1.33 IUSE="elibc_FreeBSD"
28    
29 nichoj 1.1 # Make sure we use java-config-2
30     export WANT_JAVA_CONFIG="2"
31    
32 caster 1.155 # @VARIABLE: JAVA_PKG_PORTAGE_DEP
33     # @INTERNAL
34     # @DESCRIPTION:
35 betelgeuse 1.92 # The version of portage we need to function properly. Previously it was
36     # portage with phase hooks support but now we use a version with proper env
37 betelgeuse 1.121 # saving. For EAPI 2 we have new enough stuff so let's have cleaner deps.
38 ssuominen 1.141 has "${EAPI}" 0 1 && JAVA_PKG_PORTAGE_DEP=">=sys-apps/portage-2.1.2.7"
39 nichoj 1.7
40 caster 1.155 # @VARIABLE: JAVA_PKG_E_DEPEND
41     # @INTERNAL
42     # @DESCRIPTION:
43 nichoj 1.1 # This is a convience variable to be used from the other java eclasses. This is
44 betelgeuse 1.91 # the version of java-config we want to use. Usually the latest stable version
45     # so that ebuilds can use new features without depending on specific versions.
46 chewi 1.161 JAVA_PKG_E_DEPEND=">=dev-java/java-config-2.2.0 ${JAVA_PKG_PORTAGE_DEP}"
47 ssuominen 1.141 has source ${JAVA_PKG_IUSE} && JAVA_PKG_E_DEPEND="${JAVA_PKG_E_DEPEND} source? ( app-arch/zip )"
48 nichoj 1.1
49 caster 1.155 # @ECLASS-VARIABLE: JAVA_PKG_WANT_BOOTCLASSPATH
50     # @DEFAULT_UNSET
51     # @DESCRIPTION:
52 caster 1.130 # The version of bootclasspath the package needs to work. Translates to a proper
53 caster 1.155 # dependency. The bootclasspath can then be obtained by java-ant_rewrite-bootclasspath
54 caster 1.130 if [[ -n "${JAVA_PKG_WANT_BOOTCLASSPATH}" ]]; then
55     if [[ "${JAVA_PKG_WANT_BOOTCLASSPATH}" == "1.5" ]]; then
56     JAVA_PKG_E_DEPEND="${JAVA_PKG_E_DEPEND} >=dev-java/gnu-classpath-0.98-r1:0.98"
57     else
58     eerror "Unknown value of JAVA_PKG_WANT_BOOTCLASSPATH"
59     # since die in global scope doesn't work, this will make repoman fail
60     JAVA_PKG_E_DEPEND="${JAVA_PKG_E_DEPEND} BAD_JAVA_PKG_WANT_BOOTCLASSPATH"
61     fi
62     fi
63    
64 caster 1.155 # @ECLASS-VARIABLE: JAVA_PKG_ALLOW_VM_CHANGE
65     # @DESCRIPTION:
66     # Allow this eclass to change the active VM?
67     # If your system VM isn't sufficient for the package, the build will fail
68     # instead of trying to switch to another VM.
69 nichoj 1.1 #
70 caster 1.155 # Overriding the default can be useful for testing specific VMs locally, but
71     # should not be used in the final ebuild.
72 nichoj 1.1 JAVA_PKG_ALLOW_VM_CHANGE=${JAVA_PKG_ALLOW_VM_CHANGE:="yes"}
73    
74 caster 1.155 # @ECLASS-VARIABLE: JAVA_PKG_FORCE_VM
75     # @DEFAULT_UNSET
76     # @DESCRIPTION:
77 nichoj 1.1 # Explicitly set a particular VM to use. If its not valid, it'll fall back to
78     # whatever /etc/java-config-2/build/jdk.conf would elect to use.
79     #
80     # Should only be used for testing and debugging.
81     #
82 caster 1.155 # Example: use sun-jdk-1.5 to emerge foo:
83     # @CODE
84 nichoj 1.1 # JAVA_PKG_FORCE_VM=sun-jdk-1.5 emerge foo
85 caster 1.155 # @CODE
86 nichoj 1.1
87 caster 1.155 # @ECLASS-VARIABLE: JAVA_PKG_WANT_BUILD_VM
88     # @DEFAULT_UNSET
89     # @DESCRIPTION:
90 sera 1.150 # A list of VM handles to choose a build VM from. If the list contains the
91     # currently active VM use that one, otherwise step through the list till a
92     # usable/installed VM is found.
93     #
94     # This allows to use an explicit list of JDKs in DEPEND instead of a virtual.
95     # Users of this variable must make sure at least one of the listed handles is
96     # covered by DEPEND.
97 caster 1.155 # Requires JAVA_PKG_WANT_SOURCE and JAVA_PKG_WANT_TARGET to be set as well.
98 sera 1.150
99 caster 1.155 # @ECLASS-VARIABLE: JAVA_PKG_WANT_SOURCE
100     # @DEFAULT_UNSET
101     # @DESCRIPTION:
102     # Specify a non-standard Java source version for compilation (via javac -source
103     # parameter or Ant equivalent via build.xml rewriting done by java-ant-2 eclass).
104     # Normally this is determined from the jdk version specified in DEPEND.
105 nichoj 1.1 # See java-pkg_get-source function below.
106     #
107 caster 1.155 # Should generally only be used for testing and debugging.
108 nichoj 1.1 #
109 caster 1.155 # Use 1.4 source to emerge baz
110     # @CODE
111 nichoj 1.1 # JAVA_PKG_WANT_SOURCE=1.4 emerge baz
112 caster 1.155 # @CODE
113 nichoj 1.1
114 caster 1.155 # @ECLASS-VARIABLE: JAVA_PKG_WANT_TARGET
115     # @DEFAULT_UNSET
116     # @DESCRIPTION:
117     # Same as JAVA_PKG_WANT_SOURCE (see above) but for javac -target parameter,
118     # which affects the version of generated bytecode.
119     # Normally this is determined from the jre/jdk version specified in RDEPEND.
120 nichoj 1.1 # See java-pkg_get-target function below.
121     #
122 caster 1.155 # Should generallyonly be used for testing and debugging.
123 nichoj 1.1 #
124 caster 1.155 # emerge bar to be compatible with 1.3
125     # @CODE
126 nichoj 1.1 # JAVA_PKG_WANT_TARGET=1.3 emerge bar
127 caster 1.155 # @CODE
128 nichoj 1.1
129 caster 1.155 # @VARIABLE: JAVA_PKG_COMPILER_DIR
130     # @INTERNAL
131     # @DESCRIPTION:
132 nichoj 1.1 # Directory where compiler settings are saved, without trailing slash.
133 caster 1.155 # You probably shouldn't touch this variable except local testing.
134 nichoj 1.1 JAVA_PKG_COMPILER_DIR=${JAVA_PKG_COMPILER_DIR:="/usr/share/java-config-2/compiler"}
135    
136 caster 1.155 # @VARIABLE: JAVA_PKG_COMPILERS_CONF
137     # @INTERNAL
138     # @DESCRIPTION:
139 nichoj 1.1 # Path to file containing information about which compiler to use.
140 caster 1.155 # Can be overloaded, but it should be overloaded only for local testing.
141 nichoj 1.1 JAVA_PKG_COMPILERS_CONF=${JAVA_PKG_COMPILERS_CONF:="/etc/java-config-2/build/compilers.conf"}
142    
143 caster 1.155 # @ECLASS-VARIABLE: JAVA_PKG_FORCE_COMPILER
144     # @INTERNAL
145     # @DEFAULT_UNSET
146     # @DESCRIPTION:
147     # Explicitly set a list of compilers to choose from. This is normally read from
148     # JAVA_PKG_COMPILERS_CONF.
149 nichoj 1.1 #
150 caster 1.155 # Useful for local testing.
151 nichoj 1.1 #
152 caster 1.155 # Use jikes and javac, in that order
153     # @CODE
154 nichoj 1.1 # JAVA_PKG_FORCE_COMPILER="jikes javac"
155 caster 1.155 # @CODE
156 nichoj 1.1
157 caster 1.155 # @ECLASS-VARIABLE: JAVA_PKG_FORCE_ANT_TASKS
158     # @DEFAULT_UNSET
159     # @DESCRIPTION:
160 caster 1.46 # An $IFS separated list of ant tasks. Can be set in environment before calling
161     # emerge/ebuild to override variables set in ebuild, mainly for testing before
162     # putting the resulting (WANT_)ANT_TASKS into ebuild. Affects only ANT_TASKS in
163     # eant() call, not the dependencies specified in WANT_ANT_TASKS.
164     #
165 caster 1.155 # @CODE
166     # JAVA_PKG_FORCE_ANT_TASKS="ant-junit ant-trax" \
167 caster 1.46 # ebuild foo.ebuild compile
168 caster 1.155 # @CODE
169 caster 1.46
170 nichoj 1.1 # TODO document me
171     JAVA_PKG_QA_VIOLATIONS=0
172    
173 caster 1.155 # @FUNCTION: java-pkg_doexamples
174     # @USAGE: [--subdir <subdir>] <file1/dir1> [<file2> ...]
175     # @DESCRIPTION:
176 betelgeuse 1.63 # Installs given arguments to /usr/share/doc/${PF}/examples
177     # If you give it only one parameter and it is a directory it will install
178     # everything in that directory to the examples directory.
179     #
180 caster 1.155 # @CODE
181     # Parameters:
182     # --subdir - If the examples need a certain directory structure
183     # $* - list of files to install
184     #
185     # Examples:
186 betelgeuse 1.63 # java-pkg_doexamples demo
187     # java-pkg_doexamples demo/* examples/*
188 caster 1.155 # @CODE
189 betelgeuse 1.63 java-pkg_doexamples() {
190     debug-print-function ${FUNCNAME} $*
191    
192     [[ ${#} -lt 1 ]] && die "At least one argument needed"
193    
194     java-pkg_check-phase install
195 radhermit 1.156 java-pkg_init_paths_
196 betelgeuse 1.63
197     local dest=/usr/share/doc/${PF}/examples
198 betelgeuse 1.93 if [[ ${1} == --subdir ]]; then
199     local dest=${dest}/${2}
200     dodir ${dest}
201     shift 2
202     fi
203    
204 betelgeuse 1.63 if [[ ${#} = 1 && -d ${1} ]]; then
205 vapier 1.69 ( # dont want to pollute calling env
206     insinto "${dest}"
207     doins -r ${1}/*
208     ) || die "Installing examples failed"
209 betelgeuse 1.63 else
210 vapier 1.69 ( # dont want to pollute calling env
211     insinto "${dest}"
212     doins -r "$@"
213     ) || die "Installing examples failed"
214 betelgeuse 1.63 fi
215 serkan 1.138
216     # Let's make a symlink to the directory we have everything else under
217     dosym "${dest}" "${JAVA_PKG_SHAREPATH}/examples" || die
218 betelgeuse 1.63 }
219 nichoj 1.1
220 caster 1.155 # @FUNCTION: java-pkg_dojar
221     # @USAGE: <jar1> [<jar2> ...]
222     # @DESCRIPTION:
223 nichoj 1.1 # Installs any number of jars.
224     # Jar's will be installed into /usr/share/${PN}(-${SLOT})/lib/ by default.
225     # You can use java-pkg_jarinto to change this path.
226 betelgeuse 1.19 # You should never install a jar with a package version in the filename.
227 nichoj 1.1 # Instead, use java-pkg_newjar defined below.
228     #
229 caster 1.155 # @CODE
230 nichoj 1.1 # java-pkg_dojar dist/${PN}.jar dist/${PN}-core.jar
231 caster 1.155 # @CODE
232 nichoj 1.1 #
233     # @param $* - list of jars to install
234     java-pkg_dojar() {
235     debug-print-function ${FUNCNAME} $*
236    
237     [[ ${#} -lt 1 ]] && die "At least one argument needed"
238    
239     java-pkg_check-phase install
240     java-pkg_init_paths_
241    
242     # Create JARDEST if it doesn't exist
243     dodir ${JAVA_PKG_JARDEST}
244    
245     local jar
246     # for each jar
247 caster 1.50 for jar in "${@}"; do
248 nichoj 1.1 local jar_basename=$(basename "${jar}")
249    
250     java-pkg_check-versioned-jar ${jar_basename}
251    
252     # check if it exists
253     if [[ -e "${jar}" ]] ; then
254 betelgeuse 1.43 # Don't overwrite if jar has already been installed with the same
255     # name
256     local dest="${D}${JAVA_PKG_JARDEST}/${jar_basename}"
257     if [[ -e "${dest}" ]]; then
258     ewarn "Overwriting ${dest}"
259     fi
260    
261 nichoj 1.1 # install it into JARDEST if it's a non-symlink
262     if [[ ! -L "${jar}" ]] ; then
263 betelgeuse 1.55 #but first check class version when in strict mode.
264     is-java-strict && java-pkg_verify-classes "${jar}"
265    
266 nichoj 1.1 INSDESTTREE="${JAVA_PKG_JARDEST}" \
267     doins "${jar}" || die "failed to install ${jar}"
268     java-pkg_append_ JAVA_PKG_CLASSPATH "${JAVA_PKG_JARDEST}/${jar_basename}"
269     debug-print "installed ${jar} to ${D}${JAVA_PKG_JARDEST}"
270     # make a symlink to the original jar if it's symlink
271     else
272     # TODO use dosym, once we find something that could use it
273     # -nichoj
274     ln -s "$(readlink "${jar}")" "${D}${JAVA_PKG_JARDEST}/${jar_basename}"
275     debug-print "${jar} is a symlink, linking accordingly"
276     fi
277     else
278     die "${jar} does not exist"
279     fi
280     done
281    
282     java-pkg_do_write_
283     }
284    
285 caster 1.155 # @FUNCTION: java-pkg_regjar
286     # @USAGE: </path/to/installed/jar>
287     # @DESCRIPTION:
288     # Records an already installed (in ${D}) jar in the package.env
289 nichoj 1.1 # This would mostly be used if the package has make or a custom script to
290     # install things.
291     #
292 nelchael 1.5 # WARNING:
293 caster 1.155 # if you want to use shell expansion, you have to use ${D}/... as the for in
294     # this function will not be able to expand the path, here's an example:
295 nelchael 1.5 #
296 caster 1.155 # @CODE
297 nelchael 1.5 # java-pkg_regjar ${D}/opt/my-java/lib/*.jar
298 caster 1.155 # @CODE
299 nichoj 1.1 #
300 caster 1.155
301 nichoj 1.10 # TODO should we be making sure the jar is present on ${D} or wherever?
302 nichoj 1.1 java-pkg_regjar() {
303     debug-print-function ${FUNCNAME} $*
304    
305     java-pkg_check-phase install
306    
307     [[ ${#} -lt 1 ]] && die "at least one argument needed"
308    
309     java-pkg_init_paths_
310    
311     local jar jar_dir jar_file
312 caster 1.50 for jar in "${@}"; do
313 nichoj 1.1 # TODO use java-pkg_check-versioned-jar
314 betelgeuse 1.38 if [[ -e "${jar}" || -e "${D}${jar}" ]]; then
315     [[ -d "${jar}" || -d "${D}${jar}" ]] \
316     && die "Called ${FUNCNAME} on a directory $*"
317 betelgeuse 1.55
318     #check that class version correct when in strict mode
319     is-java-strict && java-pkg_verify-classes "${jar}"
320    
321 nelchael 1.5 # nelchael: we should strip ${D} in this case too, here's why:
322     # imagine such call:
323     # java-pkg_regjar ${D}/opt/java/*.jar
324     # such call will fall into this case (-e ${jar}) and will
325     # record paths with ${D} in package.env
326     java-pkg_append_ JAVA_PKG_CLASSPATH "${jar#${D}}"
327 nichoj 1.1 else
328 betelgeuse 1.68 if [[ ${jar} = *\** ]]; then
329     eerror "The argument ${jar} to ${FUNCNAME}"
330     eerror "has * in it. If you want it to glob in"
331     eerror '${D} add ${D} to the argument.'
332     fi
333 betelgeuse 1.126 debug-print "${jar} or ${D}${jar} not found"
334 nichoj 1.1 die "${jar} does not exist"
335     fi
336     done
337    
338     java-pkg_do_write_
339     }
340    
341 caster 1.155 # @FUNCTION: java-pkg_newjar
342     # @USAGE: <path/to/oldname.jar> [<newname.jar>]
343     # @DESCRIPTION:
344     # Installs a jar with a new name (defaults to $PN.jar)
345 nichoj 1.1 #
346 caster 1.155 # For example, installs a versioned jar without the version
347 nichoj 1.1 java-pkg_newjar() {
348     debug-print-function ${FUNCNAME} $*
349    
350     local original_jar="${1}"
351     local new_jar="${2:-${PN}.jar}"
352     local new_jar_dest="${T}/${new_jar}"
353    
354     [[ -z ${original_jar} ]] && die "Must specify a jar to install"
355 betelgeuse 1.44 [[ ! -f ${original_jar} ]] \
356     && die "${original_jar} does not exist or is not a file!"
357 nichoj 1.1
358     rm -f "${new_jar_dest}" || die "Failed to remove ${new_jar_dest}"
359     cp "${original_jar}" "${new_jar_dest}" \
360     || die "Failed to copy ${original_jar} to ${new_jar_dest}"
361     java-pkg_dojar "${new_jar_dest}"
362     }
363    
364 caster 1.155 # @FUNCTION: java-pkg_addcp
365     # @USAGE: <classpath>
366     # @DESCRIPTION:
367 nichoj 1.1 # Add something to the package's classpath. For jars, you should use dojar,
368     # newjar, or regjar. This is typically used to add directories to the classpath.
369 caster 1.155 # The parameters of this function are appended to JAVA_PKG_CLASSPATH
370 nichoj 1.1 java-pkg_addcp() {
371     java-pkg_append_ JAVA_PKG_CLASSPATH "${@}"
372     java-pkg_do_write_
373     }
374    
375 caster 1.155 # @FUNCTION: java-pkg_doso
376     # @USAGE: <path/to/file1.so> [...]
377     # @DESCRIPTION:
378 nichoj 1.1 # Installs any number of JNI libraries
379     # They will be installed into /usr/lib by default, but java-pkg_sointo
380     # can be used change this path
381     #
382 caster 1.155 # @CODE
383 nichoj 1.1 # Example:
384     # java-pkg_doso *.so
385 caster 1.155 # @CODE
386 nichoj 1.1 java-pkg_doso() {
387     debug-print-function ${FUNCNAME} $*
388    
389     java-pkg_check-phase install
390    
391 caster 1.127 [[ ${#} -lt 1 ]] && die "${FUNCNAME} requires at least one argument"
392 nichoj 1.1
393     java-pkg_init_paths_
394    
395     local lib
396     # for each lib
397     for lib in "$@" ; do
398     # if the lib exists...
399     if [[ -e "${lib}" ]] ; then
400     # install if it isn't a symlink
401     if [[ ! -L "${lib}" ]] ; then
402     INSDESTTREE="${JAVA_PKG_LIBDEST}" \
403 chewi 1.160 INSOPTIONS="-m0755" \
404 tove 1.111 doins "${lib}" || die "failed to install ${lib}"
405 nichoj 1.1 java-pkg_append_ JAVA_PKG_LIBRARY "${JAVA_PKG_LIBDEST}"
406     debug-print "Installing ${lib} to ${JAVA_PKG_LIBDEST}"
407     # otherwise make a symlink to the symlink's origin
408     else
409 caster 1.127 dosym "$(readlink "${lib}")" "${JAVA_PKG_LIBDEST}/${lib##*/}"
410     debug-print "${lib} is a symlink, linking accordantly"
411 nichoj 1.1 fi
412     # otherwise die
413     else
414     die "${lib} does not exist"
415     fi
416     done
417    
418     java-pkg_do_write_
419     }
420    
421 caster 1.155 # @FUNCTION: java-pkg_regso
422     # @USAGE: <file1.so> [...]
423     # @DESCRIPTION:
424     # Registers an already installed JNI library in package.env.
425     #
426     # @CODE
427     # Parameters:
428     # $@ - JNI libraries to register
429 nichoj 1.1 #
430     # Example:
431     # java-pkg_regso *.so /path/*.so
432 caster 1.155 # @CODE
433 nichoj 1.1 java-pkg_regso() {
434     debug-print-function ${FUNCNAME} $*
435    
436     java-pkg_check-phase install
437    
438 caster 1.127 [[ ${#} -lt 1 ]] && die "${FUNCNAME} requires at least one argument"
439 nichoj 1.1
440     java-pkg_init_paths_
441 betelgeuse 1.19
442 nichoj 1.1 local lib target_dir
443     for lib in "$@" ; do
444     # Check the absolute path of the lib
445     if [[ -e "${lib}" ]] ; then
446     target_dir="$(java-pkg_expand_dir_ ${lib})"
447     java-pkg_append_ JAVA_PKG_LIBRARY "/${target_dir#${D}}"
448     # Check the path of the lib relative to ${D}
449     elif [[ -e "${D}${lib}" ]]; then
450     target_dir="$(java-pkg_expand_dir_ ${D}${lib})"
451     java-pkg_append_ JAVA_PKG_LIBRARY "${target_dir}"
452     else
453     die "${lib} does not exist"
454     fi
455     done
456    
457     java-pkg_do_write_
458     }
459    
460 caster 1.155 # @FUNCTION: java-pkg_jarinto
461     # @USAGE: </path/to/install/jars/into>
462     # @DESCRIPTION:
463     # Changes the path jars are installed into via subsequent java-pkg_dojar calls.
464 nichoj 1.1 java-pkg_jarinto() {
465     debug-print-function ${FUNCNAME} $*
466    
467     JAVA_PKG_JARDEST="${1}"
468     }
469    
470 caster 1.155 # @FUNCTION: java-pkg_sointo
471     # @USAGE: </path/to/install/sofiles/into>
472     # @DESCRIPTION:
473     # Changes the path that JNI libraries are installed into via subsequent
474     # java-pkg_doso calls.
475 nichoj 1.1 java-pkg_sointo() {
476     debug-print-function ${FUNCNAME} $*
477    
478     JAVA_PKG_LIBDEST="${1}"
479     }
480    
481 caster 1.155 # @FUNCTION: java-pkg_dohtml
482     # @USAGE: <path/to/javadoc/documentation> [...]
483     # @DESCRIPTION:
484     # Install Javadoc HTML documentation. Usage of java-pkg_dojavadoc is preferred.
485 nichoj 1.1 #
486 caster 1.155 # @CODE
487 nichoj 1.1 # java-pkg_dohtml dist/docs/
488 caster 1.155 # @CODE
489 nichoj 1.1 java-pkg_dohtml() {
490     debug-print-function ${FUNCNAME} $*
491    
492     [[ ${#} -lt 1 ]] && die "At least one argument required for ${FUNCNAME}"
493 betelgeuse 1.27
494 betelgeuse 1.31 # from /usr/lib/portage/bin/dohtml -h
495     # -f Set list of allowed extensionless file names.
496 nichoj 1.1 dohtml -f package-list "$@"
497 betelgeuse 1.31
498 nichoj 1.1 # this probably shouldn't be here but it provides
499     # a reasonable way to catch # docs for all of the
500     # old ebuilds.
501     java-pkg_recordjavadoc
502     }
503    
504 caster 1.155 # @FUNCTION: java-pkg_dojavadoc
505     # @USAGE: [--symlink destination] <path/to/javadocs/root>
506     # @DESCRIPTION:
507 betelgeuse 1.30 # Installs javadoc documentation. This should be controlled by the doc use flag.
508     #
509 caster 1.155 # @CODE
510     # Parameters:
511     # $1: optional --symlink creates to symlink like this for html
512 betelgeuse 1.99 # documentation bundles.
513 caster 1.155 # $2: - The javadoc root directory.
514 betelgeuse 1.30 #
515 caster 1.155 # Examples:
516 betelgeuse 1.30 # java-pkg_dojavadoc docs/api
517 caster 1.155 # java-pkg_dojavadoc --symlink apidocs docs/api
518     # @CODE
519 nichoj 1.1 java-pkg_dojavadoc() {
520 betelgeuse 1.74 debug-print-function ${FUNCNAME} $*
521 betelgeuse 1.99
522     # For html documentation bundles that link to Javadoc
523     local symlink
524     if [[ ${1} = --symlink ]]; then
525     symlink=${2}
526     shift 2
527     fi
528    
529 nichoj 1.1 local dir="$1"
530 betelgeuse 1.99 local dest=/usr/share/doc/${PF}/html
531 nichoj 1.1
532 betelgeuse 1.74 # QA checks
533    
534 nichoj 1.1 java-pkg_check-phase install
535 radhermit 1.156 java-pkg_init_paths_
536 nichoj 1.1
537     [[ -z "${dir}" ]] && die "Must specify a directory!"
538     [[ ! -d "${dir}" ]] && die "${dir} does not exist, or isn't a directory!"
539 betelgeuse 1.74 if [[ ! -e "${dir}/index.html" ]]; then
540     local msg="No index.html in javadoc directory"
541     ewarn "${msg}"
542     is-java-strict && die "${msg}"
543     fi
544    
545 betelgeuse 1.99 if [[ -e ${D}/${dest}/api ]]; then
546     eerror "${dest} already exists. Will not overwrite."
547     die "${dest}"
548     fi
549    
550 betelgeuse 1.74 # Renaming to match our directory layout
551 nichoj 1.1
552     local dir_to_install="${dir}"
553     if [[ "$(basename "${dir}")" != "api" ]]; then
554     dir_to_install="${T}/api"
555     # TODO use doins
556     cp -r "${dir}" "${dir_to_install}" || die "cp failed"
557     fi
558    
559 betelgeuse 1.74 # Actual installation
560    
561 betelgeuse 1.99 java-pkg_dohtml -r "${dir_to_install}"
562    
563     # Let's make a symlink to the directory we have everything else under
564 betelgeuse 1.100 dosym ${dest}/api "${JAVA_PKG_SHAREPATH}/api" || die
565 betelgeuse 1.99
566     if [[ ${symlink} ]]; then
567 betelgeuse 1.106 debug-print "symlinking ${dest}/{api,${symlink}}"
568 betelgeuse 1.99 dosym ${dest}/{api,${symlink}} || die
569     fi
570 nichoj 1.1 }
571    
572 caster 1.155 # @FUNCTION: java-pkg_dosrc
573     # @USAGE: <path/to/sources> [...]
574     # @DESCRIPTION:
575 betelgeuse 1.19 # Installs a zip containing the source for a package, so it can used in
576 nichoj 1.1 # from IDEs like eclipse and netbeans.
577 caster 1.155 # Ebuild needs to DEPEND on app-arch/zip to use this. It also should be controlled by USE=source.
578 nichoj 1.1 #
579 caster 1.155 # @CODE
580     # Example:
581     # java-pkg_dosrc src/*
582     # @CODE
583    
584     # TODO change so it the arguments it takes are the base directories containing
585     # source -nichoj
586 nichoj 1.1 #
587 caster 1.155 # TODO should we be able to handle multiple calls to dosrc? -nichoj
588 nichoj 1.1 #
589 caster 1.155 # TODO maybe we can take an existing zip/jar? -nichoj
590 nichoj 1.1 #
591     # FIXME apparently this fails if you give it an empty directories
592     java-pkg_dosrc() {
593     debug-print-function ${FUNCNAME} $*
594    
595 betelgeuse 1.19 [ ${#} -lt 1 ] && die "At least one argument needed"
596 nichoj 1.1
597     java-pkg_check-phase install
598    
599 betelgeuse 1.19 [[ ${#} -lt 1 ]] && die "At least one argument needed"
600 nichoj 1.1
601 betelgeuse 1.66 if ! [[ ${DEPEND} = *app-arch/zip* ]]; then
602     local msg="${FUNCNAME} called without app-arch/zip in DEPEND"
603 betelgeuse 1.104 java-pkg_announce-qa-violation ${msg}
604 betelgeuse 1.66 fi
605    
606 nichoj 1.1 java-pkg_init_paths_
607    
608     local zip_name="${PN}-src.zip"
609     local zip_path="${T}/${zip_name}"
610     local dir
611 caster 1.50 for dir in "${@}"; do
612 nichoj 1.1 local dir_parent=$(dirname "${dir}")
613     local dir_name=$(basename "${dir}")
614     pushd ${dir_parent} > /dev/null || die "problem entering ${dir_parent}"
615     zip -q -r ${zip_path} ${dir_name} -i '*.java'
616     local result=$?
617     # 12 means zip has nothing to do
618     if [[ ${result} != 12 && ${result} != 0 ]]; then
619     die "failed to zip ${dir_name}"
620     fi
621     popd >/dev/null
622     done
623    
624     # Install the zip
625     INSDESTTREE=${JAVA_PKG_SOURCESPATH} \
626     doins ${zip_path} || die "Failed to install source"
627    
628     JAVA_SOURCES="${JAVA_PKG_SOURCESPATH}/${zip_name}"
629     java-pkg_do_write_
630     }
631    
632 caster 1.155 # @FUNCTION: java-pkg_dolauncher
633     # @USAGE: <filename> [options]
634     # @DESCRIPTION:
635 nichoj 1.1 # Make a wrapper script to lauch/start this package
636     # If necessary, the wrapper will switch to the appropriate VM.
637     #
638 betelgeuse 1.25 # Can be called without parameters if the package installs only one jar
639     # that has the Main-class attribute set. The wrapper will be named ${PN}.
640     #
641 caster 1.155 # @CODE
642     # Parameters:
643     # $1 - filename of launcher to create
644     # $2 - options, as follows:
645     # --main the.main.class.to.start
646 betelgeuse 1.25 # --jar /the/jar/too/launch.jar or just <name>.jar
647 betelgeuse 1.20 # --java_args 'Extra arguments to pass to java'
648 caster 1.42 # --pkg_args 'Extra arguments to pass to the package'
649     # --pwd Directory the launcher changes to before executing java
650     # -into Directory to install the launcher to, instead of /usr/bin
651     # -pre Prepend contents of this file to the launcher
652 caster 1.155 # @CODE
653 nichoj 1.1 java-pkg_dolauncher() {
654     debug-print-function ${FUNCNAME} $*
655    
656     java-pkg_check-phase install
657 betelgeuse 1.25 java-pkg_init_paths_
658 nichoj 1.1
659 betelgeuse 1.25 if [[ ${#} = 0 ]]; then
660     local name="${PN}"
661     else
662     local name="${1}"
663     shift
664     fi
665 nichoj 1.1
666     # TODO rename to launcher
667     local target="${T}/${name}"
668 betelgeuse 1.20 local var_tmp="${T}/launcher_variables_tmp"
669 nichoj 1.1 local target_dir pre
670    
671 betelgeuse 1.20 # Process the other the rest of the arguments
672 nichoj 1.1 while [[ -n "${1}" && -n "${2}" ]]; do
673 betelgeuse 1.38 local var="${1}" value="${2}"
674 betelgeuse 1.19 if [[ "${var:0:2}" == "--" ]]; then
675 betelgeuse 1.25 local var=${var:2}
676     echo "gjl_${var}=\"${value}\"" >> "${var_tmp}"
677 betelgeuse 1.26 local gjl_${var}="${value}"
678 nichoj 1.1 elif [[ "${var}" == "-into" ]]; then
679     target_dir="${value}"
680     elif [[ "${var}" == "-pre" ]]; then
681     pre="${value}"
682     fi
683     shift 2
684     done
685 betelgeuse 1.20
686 betelgeuse 1.25 # Test if no --jar and --main arguments were given and
687     # in that case check if the package only installs one jar
688     # and use that jar.
689     if [[ -z "${gjl_jar}" && -z "${gjl_main}" ]]; then
690     local cp="${JAVA_PKG_CLASSPATH}"
691     if [[ "${cp/:}" = "${cp}" && "${cp%.jar}" != "${cp}" ]]; then
692     echo "gjl_jar=\"${JAVA_PKG_CLASSPATH}\"" >> "${var_tmp}"
693     else
694     local msg="Not enough information to create a launcher given."
695     msg="${msg} Please give --jar or --main argument to ${FUNCNAME}."
696     die "${msg}"
697     fi
698     fi
699    
700 betelgeuse 1.20 # Write the actual script
701     echo "#!/bin/bash" > "${target}"
702 caster 1.42 if [[ -n "${pre}" ]]; then
703     if [[ -f "${pre}" ]]; then
704     cat "${pre}" >> "${target}"
705     else
706     die "-pre specified file '${pre}' does not exist"
707     fi
708     fi
709 nichoj 1.1 echo "gjl_package=${JAVA_PKG_NAME}" >> "${target}"
710 betelgeuse 1.20 cat "${var_tmp}" >> "${target}"
711 caster 1.21 rm -f "${var_tmp}"
712 nichoj 1.1 echo "source /usr/share/java-config-2/launcher/launcher.bash" >> "${target}"
713 betelgeuse 1.19
714 nichoj 1.17 if [[ -n "${target_dir}" ]]; then
715 nichoj 1.1 DESTTREE="${target_dir}" dobin "${target}"
716     local ret=$?
717     return ${ret}
718     else
719     dobin "${target}"
720     fi
721     }
722    
723 caster 1.155 # @FUNCTION: java-pkg_dowar
724     # @DESCRIPTION:
725 nichoj 1.1 # Install war files.
726     # TODO document
727     java-pkg_dowar() {
728     debug-print-function ${FUNCNAME} $*
729    
730     # Check for arguments
731     [[ ${#} -lt 1 ]] && die "At least one argument needed"
732     java-pkg_check-phase install
733    
734     java-pkg_init_paths_
735    
736     local war
737     for war in $* ; do
738     local warpath
739     # TODO evaluate if we want to handle symlinks differently -nichoj
740     # Check for symlink
741     if [[ -L "${war}" ]] ; then
742     cp "${war}" "${T}"
743     warpath="${T}$(basename "${war}")"
744     # Check for directory
745     # TODO evaluate if we want to handle directories differently -nichoj
746     elif [[ -d "${war}" ]] ; then
747     echo "dowar: warning, skipping directory ${war}"
748     continue
749     else
750     warpath="${war}"
751     fi
752 betelgeuse 1.18
753 nichoj 1.1 # Install those files like you mean it
754     INSOPTIONS="-m 0644" \
755     INSDESTTREE=${JAVA_PKG_WARDEST} \
756     doins ${warpath}
757     done
758     }
759    
760 caster 1.155 # @FUNCTION: java-pkg_recordjavadoc
761     # @INTERNAL
762     # @DESCRIPTION:
763 nichoj 1.1 # Scan for JavaDocs, and record their existence in the package.env file
764 caster 1.155
765 nichoj 1.1 # TODO make sure this in the proper section
766     java-pkg_recordjavadoc()
767     {
768     debug-print-function ${FUNCNAME} $*
769     # the find statement is important
770     # as some packages include multiple trees of javadoc
771     JAVADOC_PATH="$(find ${D}/usr/share/doc/ -name allclasses-frame.html -printf '%h:')"
772     # remove $D - TODO: check this is ok with all cases of the above
773     JAVADOC_PATH="${JAVADOC_PATH//${D}}"
774     if [[ -n "${JAVADOC_PATH}" ]] ; then
775     debug-print "javadocs found in ${JAVADOC_PATH%:}"
776     java-pkg_do_write_
777     else
778     debug-print "No javadocs found"
779     fi
780     }
781    
782    
783 caster 1.155 # @FUNCTION: java-pkg_jar-from
784     # @USAGE: [--build-only] [--with-dependencies] [--virtual] [--into dir] <package> [<package.jar>] [<destination.jar>]
785     # @DESCRIPTION:
786 nichoj 1.1 # Makes a symlink to a jar from a certain package
787     # A lot of java packages include dependencies in a lib/ directory
788     # You can use this function to replace these bundled dependencies.
789 nichoj 1.16 # The dependency is recorded into package.env DEPEND line, unless "--build-only"
790     # is passed as the very first argument, for jars that have to be present only
791     # at build time and are not needed on runtime (junit testing etc).
792 nichoj 1.1 #
793 caster 1.155 # @CODE
794 nichoj 1.1 # Example: get all jars from xerces slot 2
795     # java-pkg_jar-from xerces-2
796 caster 1.155 #
797 nichoj 1.1 # Example: get a specific jar from xerces slot 2
798     # java-pkg_jar-from xerces-2 xml-apis.jar
799 caster 1.155 #
800 nichoj 1.16 # Example: get a specific jar from xerces slot 2, and name it diffrently
801 nichoj 1.1 # java-pkg_jar-from xerces-2 xml-apis.jar xml.jar
802 caster 1.155 #
803 nichoj 1.16 # Example: get junit.jar which is needed only for building
804     # java-pkg_jar-from --build-only junit junit.jar
805 caster 1.155 # @CODE
806 nichoj 1.1 #
807 caster 1.155 # @CODE
808     # Parameters
809 caster 1.49 # --build-only - makes the jar(s) not added into package.env DEPEND line.
810     # (assumed automatically when called inside src_test)
811     # --with-dependencies - get jars also from requested package's dependencies
812     # transitively.
813 ali_bush 1.94 # --virtual - Packages passed to this function are to be handled as virtuals
814     # and will not have individual jar dependencies recorded.
815 caster 1.49 # --into $dir - symlink jar(s) into $dir (must exist) instead of .
816 caster 1.155 # $1 - Package to get jars from, or comma-separated list of packages in
817 caster 1.79 # case other parameters are not used.
818 caster 1.155 # $2 - jar from package. If not specified, all jars will be used.
819     # $3 - When a single jar is specified, destination filename of the
820 nichoj 1.1 # symlink. Defaults to the name of the jar.
821 caster 1.155 # @CODE
822    
823 nichoj 1.1 # TODO could probably be cleaned up a little
824     java-pkg_jar-from() {
825     debug-print-function ${FUNCNAME} $*
826    
827 nichoj 1.16 local build_only=""
828 caster 1.49 local destdir="."
829     local deep=""
830 ali_bush 1.94 local virtual=""
831 ali_bush 1.129 local record_jar=""
832 betelgeuse 1.59
833 caster 1.78 [[ "${EBUILD_PHASE}" == "test" ]] && build_only="build"
834 nichoj 1.16
835 caster 1.49 while [[ "${1}" == --* ]]; do
836     if [[ "${1}" = "--build-only" ]]; then
837 caster 1.77 build_only="build"
838 caster 1.49 elif [[ "${1}" = "--with-dependencies" ]]; then
839     deep="--with-dependencies"
840 ali_bush 1.94 elif [[ "${1}" = "--virtual" ]]; then
841     virtual="true"
842 caster 1.49 elif [[ "${1}" = "--into" ]]; then
843     destdir="${2}"
844     shift
845     else
846     die "java-pkg_jar-from called with unknown parameter: ${1}"
847     fi
848 nichoj 1.16 shift
849 caster 1.49 done
850 betelgeuse 1.43
851 betelgeuse 1.18 local target_pkg="${1}" target_jar="${2}" destjar="${3}"
852    
853 nichoj 1.1 [[ -z ${target_pkg} ]] && die "Must specify a package"
854    
855 ali_bush 1.105 if [[ "${EAPI}" == "1" ]]; then
856     target_pkg="${target_pkg//:/-}"
857     fi
858    
859 nichoj 1.1 # default destjar to the target jar
860     [[ -z "${destjar}" ]] && destjar="${target_jar}"
861    
862 betelgeuse 1.18 local error_msg="There was a problem getting the classpath for ${target_pkg}."
863     local classpath
864 betelgeuse 1.43 classpath="$(java-config ${deep} --classpath=${target_pkg})"
865 betelgeuse 1.18 [[ $? != 0 ]] && die ${error_msg}
866 nichoj 1.1
867 betelgeuse 1.60 # When we have commas this functions is called to bring jars from multiple
868 caster 1.79 # packages. This affects recording of dependencencies performed later
869     # which expects one package only, so we do it here.
870 betelgeuse 1.60 if [[ ${target_pkg} = *,* ]]; then
871 caster 1.79 for pkg in ${target_pkg//,/ }; do
872     java-pkg_ensure-dep "${build_only}" "${pkg}"
873     [[ -z "${build_only}" ]] && java-pkg_record-jar_ "${pkg}"
874     done
875     # setting this disables further record-jar_ calls later
876 ali_bush 1.129 record_jar="true"
877 caster 1.79 else
878     java-pkg_ensure-dep "${build_only}" "${target_pkg}"
879 betelgeuse 1.60 fi
880    
881 ali_bush 1.94 # Record the entire virtual as a dependency so that
882     # no jars are missed.
883     if [[ -z "${build_only}" && -n "${virtual}" ]]; then
884     java-pkg_record-jar_ "${target_pkg}"
885     # setting this disables further record-jars_ calls later
886 ali_bush 1.129 record_jar="true"
887 ali_bush 1.94 fi
888    
889 caster 1.79 pushd ${destdir} > /dev/null \
890     || die "failed to change directory to ${destdir}"
891    
892 nichoj 1.1 local jar
893     for jar in ${classpath//:/ }; do
894     local jar_name=$(basename "${jar}")
895     if [[ ! -f "${jar}" ]] ; then
896     debug-print "${jar} from ${target_pkg} does not exist"
897     die "Installation problems with jars in ${target_pkg} - is it installed?"
898     fi
899     # If no specific target jar was indicated, link it
900     if [[ -z "${target_jar}" ]] ; then
901     [[ -f "${target_jar}" ]] && rm "${target_jar}"
902     ln -snf "${jar}" \
903     || die "Failed to make symlink from ${jar} to ${jar_name}"
904 ali_bush 1.129 if [[ -z "${record_jar}" ]]; then
905     if [[ -z "${build_only}" ]]; then
906     java-pkg_record-jar_ "${target_pkg}" "${jar}"
907     else
908     java-pkg_record-jar_ --build-only "${target_pkg}" "${jar}"
909     fi
910     fi
911 chewi 1.159 # otherwise, if the current jar is the target jar, link it
912 nichoj 1.1 elif [[ "${jar_name}" == "${target_jar}" ]] ; then
913     [[ -f "${destjar}" ]] && rm "${destjar}"
914     ln -snf "${jar}" "${destjar}" \
915     || die "Failed to make symlink from ${jar} to ${destjar}"
916 ali_bush 1.129 if [[ -z "${record_jar}" ]]; then
917     if [[ -z "${build_only}" ]]; then
918     java-pkg_record-jar_ "${target_pkg}" "${jar}"
919     else
920 chewi 1.159 java-pkg_record-jar_ --build-only "${target_pkg}" "${jar}"
921 ali_bush 1.129 fi
922     fi
923 betelgeuse 1.54 popd > /dev/null
924 nichoj 1.1 return 0
925     fi
926     done
927 caster 1.49 popd > /dev/null
928 nichoj 1.1 # if no target was specified, we're ok
929     if [[ -z "${target_jar}" ]] ; then
930     return 0
931     # otherwise, die bitterly
932     else
933     die "Failed to find ${target_jar:-jar} in ${target_pkg}"
934     fi
935     }
936    
937 caster 1.155 # @FUNCTION: java-pkg_jarfrom
938     # @DESCRIPTION:
939 nichoj 1.1 # See java-pkg_jar-from
940     java-pkg_jarfrom() {
941     java-pkg_jar-from "$@"
942     }
943    
944 caster 1.155 # @FUNCTION: java-pkg_getjars
945     # @USAGE: [--build-only] [--with-dependencies] <package1>[,<package2>...]
946     # @DESCRIPTION:
947 nichoj 1.1 # Get the classpath provided by any number of packages
948     # Among other things, this can be passed to 'javac -classpath' or 'ant -lib'.
949 nichoj 1.16 # The providing packages are recorded as dependencies into package.env DEPEND
950     # line, unless "--build-only" is passed as the very first argument, for jars
951     # that have to be present only at build time and are not needed on runtime
952     # (junit testing etc).
953 betelgeuse 1.19 #
954 caster 1.155 # @CODE
955 betelgeuse 1.30 # Example: Get the classpath for xerces-2 and xalan,
956     # java-pkg_getjars xerces-2,xalan
957 caster 1.155 #
958 nichoj 1.1 # Example Return:
959     # /usr/share/xerces-2/lib/xml-apis.jar:/usr/share/xerces-2/lib/xmlParserAPIs.jar:/usr/share/xalan/lib/xalan.jar
960 betelgeuse 1.19 #
961 caster 1.155 #
962     # Parameters:
963 caster 1.49 # --build-only - makes the jar(s) not added into package.env DEPEND line.
964     # (assumed automatically when called inside src_test)
965     # --with-dependencies - get jars also from requested package's dependencies
966     # transitively.
967 caster 1.155 # $1 - list of packages to get jars from
968 betelgeuse 1.30 # (passed to java-config --classpath)
969 caster 1.155 # @CODE
970 nichoj 1.1 java-pkg_getjars() {
971     debug-print-function ${FUNCNAME} $*
972    
973 caster 1.49 local build_only=""
974     local deep=""
975 betelgeuse 1.59
976 caster 1.78 [[ "${EBUILD_PHASE}" == "test" ]] && build_only="build"
977 nichoj 1.16
978 caster 1.49 while [[ "${1}" == --* ]]; do
979     if [[ "${1}" = "--build-only" ]]; then
980 caster 1.77 build_only="build"
981 caster 1.49 elif [[ "${1}" = "--with-dependencies" ]]; then
982     deep="--with-dependencies"
983     else
984     die "java-pkg_jar-from called with unknown parameter: ${1}"
985     fi
986 betelgeuse 1.43 shift
987 caster 1.49 done
988 betelgeuse 1.43
989 caster 1.49 [[ ${#} -ne 1 ]] && die "${FUNCNAME} takes only one argument besides --*"
990 betelgeuse 1.38
991 ali_bush 1.70
992 betelgeuse 1.106 local pkgs="${1}"
993 ali_bush 1.105
994     if [[ "${EAPI}" == "1" ]]; then
995     pkgs="${pkgs//:/-}"
996     fi
997    
998 betelgeuse 1.43 jars="$(java-config ${deep} --classpath=${pkgs})"
999 betelgeuse 1.106 [[ $? != 0 ]] && die "java-config --classpath=${pkgs} failed"
1000 betelgeuse 1.30 debug-print "${pkgs}:${jars}"
1001    
1002 betelgeuse 1.73 for pkg in ${pkgs//,/ }; do
1003 ali_bush 1.70 java-pkg_ensure-dep "${build_only}" "${pkg}"
1004     done
1005    
1006 ali_bush 1.129 for pkg in ${pkgs//,/ }; do
1007     if [[ -z "${build_only}" ]]; then
1008 betelgeuse 1.30 java-pkg_record-jar_ "${pkg}"
1009 ali_bush 1.129 else
1010     java-pkg_record-jar_ --build-only "${pkg}"
1011     fi
1012     done
1013 betelgeuse 1.18
1014 betelgeuse 1.106 echo "${jars}"
1015 nichoj 1.1 }
1016    
1017 caster 1.155 # @FUNCTION: java-pkg_getjar
1018     # @USAGE: [--build-only] [--virtual] <package> <jarfile>
1019     # @DESCRIPTION:
1020     # Get the complete path of a single jar from a package
1021 nichoj 1.16 # The providing package is recorded as runtime dependency into package.env
1022     # DEPEND line, unless "--build-only" is passed as the very first argument, for
1023     # jars that have to be present only at build time and are not needed on runtime
1024     # (junit testing etc).
1025 nichoj 1.1 #
1026 caster 1.155 # @CODE
1027     # Example:
1028 nichoj 1.1 # java-pkg_getjar xerces-2 xml-apis.jar
1029 caster 1.155 # returns
1030 nichoj 1.1 # /usr/share/xerces-2/lib/xml-apis.jar
1031 betelgeuse 1.19 #
1032 caster 1.155 # Parameters:
1033 caster 1.49 # --build-only - makes the jar not added into package.env DEPEND line.
1034 ali_bush 1.94 # --virtual - Packages passed to this function are to be handled as virtuals
1035     # and will not have individual jar dependencies recorded.
1036 caster 1.155 # $1 - package to use
1037     # $2 - jar to get
1038     # @CODE
1039 nichoj 1.1 java-pkg_getjar() {
1040     debug-print-function ${FUNCNAME} $*
1041    
1042 nichoj 1.16 local build_only=""
1043 ali_bush 1.94 local virtual=""
1044 ali_bush 1.129 local record_jar=""
1045 betelgeuse 1.59
1046 caster 1.78 [[ "${EBUILD_PHASE}" == "test" ]] && build_only="build"
1047 nichoj 1.16
1048 caster 1.49 while [[ "${1}" == --* ]]; do
1049     if [[ "${1}" = "--build-only" ]]; then
1050 caster 1.77 build_only="build"
1051 caster 1.101 elif [[ "${1}" == "--virtual" ]]; then
1052 ali_bush 1.94 virtual="true"
1053 caster 1.49 else
1054 caster 1.102 die "java-pkg_getjar called with unknown parameter: ${1}"
1055 caster 1.49 fi
1056 nichoj 1.16 shift
1057 caster 1.49 done
1058    
1059     [[ ${#} -ne 2 ]] && die "${FUNCNAME} takes only two arguments besides --*"
1060 nichoj 1.16
1061 nichoj 1.1 local pkg="${1}" target_jar="${2}" jar
1062 ali_bush 1.105
1063     if [[ "${EAPI}" == "1" ]]; then
1064     pkg="${pkg//:/-}"
1065     fi
1066    
1067 nichoj 1.1 [[ -z ${pkg} ]] && die "Must specify package to get a jar from"
1068     [[ -z ${target_jar} ]] && die "Must specify jar to get"
1069    
1070 betelgeuse 1.18 local error_msg="Could not find classpath for ${pkg}. Are you sure its installed?"
1071     local classpath
1072     classpath=$(java-config --classpath=${pkg})
1073     [[ $? != 0 ]] && die ${error_msg}
1074    
1075 ali_bush 1.70 java-pkg_ensure-dep "${build_only}" "${pkg}"
1076    
1077 ali_bush 1.94 # Record the package(Virtual) as a dependency and then set build_only
1078     # So that individual jars are not recorded.
1079     if [[ -n "${virtual}" ]]; then
1080 ali_bush 1.129 if [[ -z "${build_only}" ]]; then
1081     java-pkg_record-jar_ "${pkg}"
1082     else
1083     java-pkg_record-jar_ --build-only "${pkg}"
1084     fi
1085     record_jar="true"
1086 ali_bush 1.94 fi
1087    
1088 nichoj 1.1 for jar in ${classpath//:/ }; do
1089     if [[ ! -f "${jar}" ]] ; then
1090 nichoj 1.16 die "Installation problem with jar ${jar} in ${pkg} - is it installed?"
1091 nichoj 1.1 fi
1092    
1093     if [[ "$(basename ${jar})" == "${target_jar}" ]] ; then
1094 nichoj 1.16 # Only record jars that aren't build-only
1095 ali_bush 1.129 if [[ -z "${record_jar}" ]]; then
1096     if [[ -z "${build_only}" ]]; then
1097     java-pkg_record-jar_ "${pkg}" "${jar}"
1098     else
1099     java-pkg_record-jar_ --build-only "${pkg}" "${jar}"
1100     fi
1101     fi
1102 nichoj 1.1 echo "${jar}"
1103     return 0
1104     fi
1105     done
1106 betelgeuse 1.19
1107 nichoj 1.1 die "Could not find ${target_jar} in ${pkg}"
1108     return 1
1109     }
1110    
1111 caster 1.155 # @FUNCTION: java-pkg_register-dependency
1112     # @USAGE: <package>[,<package2>...] [<jarfile>]
1113     # @DESCRIPTION:
1114 caster 1.77 # Registers runtime dependency on a package, list of packages, or a single jar
1115     # from a package, into package.env DEPEND line. Can only be called in
1116     # src_install phase.
1117     # Intended for binary packages where you don't need to symlink the jars or get
1118     # their classpath during build. As such, the dependencies only need to be
1119     # specified in ebuild's RDEPEND, and should be omitted in DEPEND.
1120     #
1121 caster 1.155 # @CODE
1122     # Parameters:
1123     # $1 - comma-separated list of packages, or a single package
1124     # $2 - if param $1 is a single package, optionally specify the jar
1125 caster 1.77 # to depend on
1126     #
1127 caster 1.155 # Examples:
1128     # Record the dependency on whole xerces-2 and xalan,
1129 caster 1.77 # java-pkg_register-dependency xerces-2,xalan
1130 caster 1.155 #
1131     # Record the dependency on ant.jar from ant-core
1132 caster 1.77 # java-pkg_register-dependency ant-core ant.jar
1133 caster 1.155 # @CODE
1134 caster 1.77 #
1135     # Note: Passing both list of packages as the first parameter AND specifying the
1136     # jar as the second is not allowed and will cause the function to die. We assume
1137     # that there's more chance one passes such combination as a mistake, than that
1138     # there are more packages providing identically named jar without class
1139     # collisions.
1140     java-pkg_register-dependency() {
1141     debug-print-function ${FUNCNAME} $*
1142    
1143     java-pkg_check-phase install
1144    
1145     [[ ${#} -gt 2 ]] && die "${FUNCNAME} takes at most two arguments"
1146    
1147     local pkgs="${1}"
1148     local jar="${2}"
1149    
1150     [[ -z "${pkgs}" ]] && die "${FUNCNAME} called with no package(s) specified"
1151    
1152 ali_bush 1.105 if [[ "${EAPI}" == "1" ]]; then
1153     pkgs="${pkgs//:/-}"
1154     fi
1155    
1156 caster 1.77 if [[ -z "${jar}" ]]; then
1157     for pkg in ${pkgs//,/ }; do
1158     java-pkg_ensure-dep runtime "${pkg}"
1159     java-pkg_record-jar_ "${pkg}"
1160     done
1161     else
1162     [[ ${pkgs} == *,* ]] && \
1163     die "${FUNCNAME} called with both package list and jar name"
1164     java-pkg_ensure-dep runtime "${pkgs}"
1165     java-pkg_record-jar_ "${pkgs}" "${jar}"
1166     fi
1167    
1168 caster 1.85 java-pkg_do_write_
1169     }
1170    
1171 caster 1.155 # @FUNCTION: java-pkg_register-optional-dependency
1172     # @USAGE: <package>[,<package2>...] [<jarfile>]
1173     # @DESCRIPTION:
1174 caster 1.88 # Registers optional runtime dependency on a package, list of packages, or a
1175     # single jar from a package, into package.env OPTIONAL_DEPEND line. Can only be
1176     # called in src_install phase.
1177     # Intended for packages that can use other packages when those are in classpath.
1178     # Will be put on classpath by launcher if they are installed. Typical case is
1179     # JDBC implementations for various databases. It's better than having USE flag
1180     # for each implementation triggering hard dependency.
1181     #
1182 caster 1.155 # @CODE
1183     # Parameters:
1184     # $1 - comma-separated list of packages, or a single package
1185     # $2 - if param $1 is a single package, optionally specify the jar to depend on
1186 caster 1.88 #
1187 caster 1.155 # Example:
1188     # Record the optional dependency on some jdbc providers
1189 caster 1.88 # java-pkg_register-optional-dependency jdbc-jaybird,jtds-1.2,jdbc-mysql
1190 caster 1.155 # @CODE
1191 caster 1.88 #
1192     # Note: Passing both list of packages as the first parameter AND specifying the
1193     # jar as the second is not allowed and will cause the function to die. We assume
1194     # that there's more chance one passes such combination as a mistake, than that
1195     # there are more packages providing identically named jar without class
1196     # collisions.
1197     java-pkg_register-optional-dependency() {
1198     debug-print-function ${FUNCNAME} $*
1199    
1200     java-pkg_check-phase install
1201    
1202     [[ ${#} -gt 2 ]] && die "${FUNCNAME} takes at most two arguments"
1203    
1204     local pkgs="${1}"
1205     local jar="${2}"
1206    
1207     [[ -z "${pkgs}" ]] && die "${FUNCNAME} called with no package(s) specified"
1208    
1209 ali_bush 1.105 if [[ "${EAPI}" == "1" ]]; then
1210     pkgs="${pkgs//:/-}"
1211     fi
1212    
1213 caster 1.88 if [[ -z "${jar}" ]]; then
1214     for pkg in ${pkgs//,/ }; do
1215     java-pkg_record-jar_ --optional "${pkg}"
1216     done
1217     else
1218     [[ ${pkgs} == *,* ]] && \
1219     die "${FUNCNAME} called with both package list and jar name"
1220     java-pkg_record-jar_ --optional "${pkgs}" "${jar}"
1221     fi
1222    
1223     java-pkg_do_write_
1224     }
1225    
1226 caster 1.155 # @FUNCTION: java-pkg_register-environment-variable
1227     # @USAGE: <name> <value>
1228     # @DESCRIPTION:
1229 caster 1.85 # Register an arbitrary environment variable into package.env. The gjl launcher
1230     # for this package or any package depending on this will export it into
1231     # environement before executing java command.
1232     # Must only be called in src_install phase.
1233     JAVA_PKG_EXTRA_ENV="${T}/java-pkg-extra-env"
1234     JAVA_PKG_EXTRA_ENV_VARS=""
1235     java-pkg_register-environment-variable() {
1236     debug-print-function ${FUNCNAME} $*
1237    
1238     java-pkg_check-phase install
1239    
1240     [[ ${#} != 2 ]] && die "${FUNCNAME} takes two arguments"
1241    
1242     echo "${1}=\"${2}\"" >> ${JAVA_PKG_EXTRA_ENV}
1243     JAVA_PKG_EXTRA_ENV_VARS="${JAVA_PKG_EXTRA_ENV_VARS} ${1}"
1244    
1245     java-pkg_do_write_
1246 caster 1.77 }
1247    
1248 caster 1.155 # @FUNCTION: java-pkg_get-bootclasspath
1249     # @USAGE: <version>
1250     # @DESCRIPTION:
1251 caster 1.132 # Returns classpath of a given bootclasspath-providing package version.
1252     #
1253     # @param $1 - the version of bootclasspath (e.g. 1.5), 'auto' for bootclasspath
1254     # of the current JDK
1255     java-pkg_get-bootclasspath() {
1256     local version="${1}"
1257    
1258     local bcp
1259 vapier 1.142 case "${version}" in
1260 caster 1.132 auto)
1261     bcp="$(java-config -g BOOTCLASSPATH)"
1262     ;;
1263     1.5)
1264     bcp="$(java-pkg_getjars --build-only gnu-classpath-0.98)"
1265     ;;
1266     *)
1267     eerror "unknown parameter of java-pkg_get-bootclasspath"
1268     die "unknown parameter of java-pkg_get-bootclasspath"
1269     ;;
1270     esac
1271    
1272     echo "${bcp}"
1273     }
1274    
1275    
1276 nichoj 1.1 # This function reads stdin, and based on that input, figures out how to
1277     # populate jars from the filesystem.
1278     # Need to figure out a good way of making use of this, ie be able to use a
1279     # string that was built instead of stdin
1280     # NOTE: this isn't quite ready for primetime.
1281     #java-pkg_populate-jars() {
1282     # local line
1283     #
1284     # read line
1285     # while [[ -n "${line}" ]]; do
1286     # # Ignore comments
1287     # [[ ${line%%#*} == "" ]] && continue
1288     #
1289     # # get rid of any spaces
1290     # line="${line// /}"
1291     #
1292     # # format: path=jarinfo
1293     # local path=${line%%=*}
1294     # local jarinfo=${line##*=}
1295 betelgeuse 1.19 #
1296 nichoj 1.1 # # format: jar@package
1297     # local jar=${jarinfo%%@*}.jar
1298     # local package=${jarinfo##*@}
1299     # if [[ -n ${replace_only} ]]; then
1300     # [[ ! -f $path ]] && die "No jar exists at ${path}"
1301     # fi
1302     # if [[ -n ${create_parent} ]]; then
1303     # local parent=$(dirname ${path})
1304     # mkdir -p "${parent}"
1305     # fi
1306     # java-pkg_jar-from "${package}" "${jar}" "${path}"
1307     #
1308     # read line
1309     # done
1310     #}
1311    
1312 caster 1.155 # @FUNCTION: java-pkg_find-normal-jars
1313     # @USAGE: [<path/to/directory>]
1314     # @DESCRIPTION:
1315     # Find the files with suffix .jar file in the given directory (default: $WORKDIR)
1316 betelgeuse 1.40 java-pkg_find-normal-jars() {
1317     local dir=$1
1318     [[ "${dir}" ]] || dir="${WORKDIR}"
1319     local found
1320     for jar in $(find "${dir}" -name "*.jar" -type f); do
1321     echo "${jar}"
1322     found="true"
1323     done
1324     [[ "${found}" ]]
1325     return $?
1326     }
1327    
1328 caster 1.155 # @FUNCTION: java-pkg_ensure-no-bundled-jars
1329     # @DESCRIPTION:
1330 betelgeuse 1.40 # Try to locate bundled jar files in ${WORKDIR} and die if found.
1331     # This function should be called after WORKDIR has been populated with symlink
1332     # to system jar files or bundled jars removed.
1333 nichoj 1.1 java-pkg_ensure-no-bundled-jars() {
1334     debug-print-function ${FUNCNAME} $*
1335    
1336 betelgeuse 1.40 local bundled_jars=$(java-pkg_find-normal-jars)
1337 nichoj 1.1 if [[ -n ${bundled_jars} ]]; then
1338     echo "Bundled jars found:"
1339     local jar
1340     for jar in ${bundled_jars}; do
1341     echo $(pwd)${jar/./}
1342     done
1343     die "Bundled jars found!"
1344     fi
1345     }
1346    
1347 caster 1.155 # @FUNCTION: java-pkg_ensure-vm-version-sufficient
1348     # @INTERNAL
1349     # @DESCRIPTION:
1350 nichoj 1.1 # Checks if we have a sufficient VM and dies if we don't.
1351     java-pkg_ensure-vm-version-sufficient() {
1352     debug-print-function ${FUNCNAME} $*
1353    
1354     if ! java-pkg_is-vm-version-sufficient; then
1355     debug-print "VM is not suffient"
1356     eerror "Current Java VM cannot build this package"
1357     einfo "Please use java-config -S to set the correct one"
1358     die "Active Java VM cannot build this package"
1359     fi
1360     }
1361    
1362 caster 1.155 # @FUNCTION: java-pkg_is-vm-version-sufficient
1363     # @INTERNAL
1364     # @DESCRIPTION:
1365     # @RETURN: zero - VM is sufficient; non-zero - VM is not sufficient
1366 nichoj 1.1 java-pkg_is-vm-version-sufficient() {
1367     debug-print-function ${FUNCNAME} $*
1368    
1369     depend-java-query --is-sufficient "${DEPEND}" > /dev/null
1370     return $?
1371     }
1372    
1373 caster 1.155 # @FUNCTION: java-pkg_ensure-vm-version-eq
1374     # @INTERNAL
1375     # @DESCRIPTION:
1376 nichoj 1.1 # Die if the current VM is not equal to the argument passed.
1377     #
1378     # @param $@ - Desired VM version to ensure
1379     java-pkg_ensure-vm-version-eq() {
1380     debug-print-function ${FUNCNAME} $*
1381    
1382     if ! java-pkg_is-vm-version-eq $@ ; then
1383     debug-print "VM is not suffient"
1384     eerror "This package requires a Java VM version = $@"
1385     einfo "Please use java-config -S to set the correct one"
1386     die "Active Java VM too old"
1387     fi
1388     }
1389    
1390 caster 1.155 # @FUNCTION: java-pkg_is-vm-version-eq
1391     # @USAGE: <version>
1392     # @INTERNAL
1393     # @RETURN: zero - VM versions are equal; non-zero - VM version are not equal
1394 nichoj 1.1 java-pkg_is-vm-version-eq() {
1395     debug-print-function ${FUNCNAME} $*
1396    
1397     local needed_version="$@"
1398    
1399     [[ -z "${needed_version}" ]] && die "need an argument"
1400    
1401     local vm_version="$(java-pkg_get-vm-version)"
1402    
1403     vm_version="$(get_version_component_range 1-2 "${vm_version}")"
1404     needed_version="$(get_version_component_range 1-2 "${needed_version}")"
1405    
1406     if [[ -z "${vm_version}" ]]; then
1407     debug-print "Could not get JDK version from DEPEND"
1408     return 1
1409     else
1410     if [[ "${vm_version}" == "${needed_version}" ]]; then
1411     debug-print "Detected a JDK(${vm_version}) = ${needed_version}"
1412     return 0
1413     else
1414     debug-print "Detected a JDK(${vm_version}) != ${needed_version}"
1415     return 1
1416     fi
1417     fi
1418     }
1419    
1420 caster 1.155 # @FUNCTION: java-pkg_ensure-vm-version-ge
1421     # @INTERNAL
1422     # @DESCRIPTION:
1423 nichoj 1.1 # Die if the current VM is not greater than the desired version
1424     #
1425     # @param $@ - VM version to compare current to
1426     java-pkg_ensure-vm-version-ge() {
1427     debug-print-function ${FUNCNAME} $*
1428 betelgeuse 1.19
1429 nichoj 1.1 if ! java-pkg_is-vm-version-ge "$@" ; then
1430     debug-print "vm is not suffient"
1431     eerror "This package requires a Java VM version >= $@"
1432     einfo "Please use java-config -S to set the correct one"
1433     die "Active Java VM too old"
1434     fi
1435     }
1436    
1437 caster 1.155 # @FUNCTION: java-pkg_is-vm-version-ge
1438     # @INTERNAL
1439     # @DESCRIPTION:
1440     # @CODE
1441     # Parameters:
1442     # $@ - VM version to compare current VM to
1443     # @CODE
1444     # @RETURN: zero - current VM version is greater than checked version;
1445     # non-zero - current VM version is not greater than checked version
1446 nichoj 1.1 java-pkg_is-vm-version-ge() {
1447     debug-print-function ${FUNCNAME} $*
1448    
1449     local needed_version=$@
1450     local vm_version=$(java-pkg_get-vm-version)
1451     if [[ -z "${vm_version}" ]]; then
1452     debug-print "Could not get JDK version from DEPEND"
1453     return 1
1454     else
1455     if version_is_at_least "${needed_version}" "${vm_version}"; then
1456     debug-print "Detected a JDK(${vm_version}) >= ${needed_version}"
1457     return 0
1458     else
1459     debug-print "Detected a JDK(${vm_version}) < ${needed_version}"
1460     return 1
1461     fi
1462     fi
1463     }
1464    
1465 nichoj 1.12 java-pkg_set-current-vm() {
1466     export GENTOO_VM=${1}
1467     }
1468    
1469     java-pkg_get-current-vm() {
1470     echo ${GENTOO_VM}
1471     }
1472    
1473     java-pkg_current-vm-matches() {
1474 ssuominen 1.141 has $(java-pkg_get-current-vm) ${@}
1475 nichoj 1.12 return $?
1476     }
1477    
1478 caster 1.155 # @FUNCTION: java-pkg_get-source
1479     # @DESCRIPTION:
1480 nichoj 1.1 # Determines what source version should be used, for passing to -source.
1481     # Unless you want to break things you probably shouldn't set _WANT_SOURCE
1482     #
1483 caster 1.155 # @RETURN: string - Either the lowest possible source, or JAVA_PKG_WANT_SOURCE
1484 nichoj 1.1 java-pkg_get-source() {
1485     echo ${JAVA_PKG_WANT_SOURCE:-$(depend-java-query --get-lowest "${DEPEND} ${RDEPEND}")}
1486     }
1487    
1488 caster 1.155 # @FUNCTION: java-pkg_get-target
1489     # @DESCRIPTION:
1490 nichoj 1.1 # Determines what target version should be used, for passing to -target.
1491     # If you don't care about lower versions, you can set _WANT_TARGET to the
1492 betelgeuse 1.19 # version of your JDK.
1493 nichoj 1.1 #
1494 caster 1.155 # @RETURN: string - Either the lowest possible target, or JAVA_PKG_WANT_TARGET
1495 nichoj 1.1 java-pkg_get-target() {
1496 caster 1.37 echo ${JAVA_PKG_WANT_TARGET:-$(depend-java-query --get-lowest "${DEPEND} ${RDEPEND}")}
1497 nichoj 1.1 }
1498    
1499 caster 1.155 # @FUNCTION: java-pkg_get-javac
1500     # @DESCRIPTION:
1501     # Returns the compiler executable
1502 nichoj 1.1 java-pkg_get-javac() {
1503     debug-print-function ${FUNCNAME} $*
1504    
1505 caster 1.24
1506 nichoj 1.1 local compiler="${GENTOO_COMPILER}"
1507    
1508     local compiler_executable
1509     if [[ "${compiler}" = "javac" ]]; then
1510     # nothing fancy needs to be done for javac
1511     compiler_executable="javac"
1512     else
1513     # for everything else, try to determine from an env file
1514    
1515     local compiler_env="/usr/share/java-config-2/compiler/${compiler}"
1516     if [[ -f ${compiler_env} ]]; then
1517     local old_javac=${JAVAC}
1518     unset JAVAC
1519     # try to get value of JAVAC
1520     compiler_executable="$(source ${compiler_env} 1>/dev/null 2>&1; echo ${JAVAC})"
1521     export JAVAC=${old_javac}
1522    
1523 caster 1.24 if [[ -z ${compiler_executable} ]]; then
1524     echo "JAVAC is empty or undefined in ${compiler_env}"
1525     return 1
1526     fi
1527 betelgeuse 1.19
1528 nichoj 1.1 # check that it's executable
1529     if [[ ! -x ${compiler_executable} ]]; then
1530 caster 1.24 echo "${compiler_executable} doesn't exist, or isn't executable"
1531     return 1
1532 nichoj 1.1 fi
1533     else
1534 caster 1.24 echo "Could not find environment file for ${compiler}"
1535     return 1
1536 nichoj 1.1 fi
1537     fi
1538     echo ${compiler_executable}
1539     }
1540    
1541 caster 1.155 # @FUNCTION: java-pkg_javac-args
1542     # @DESCRIPTION:
1543 nichoj 1.1 # If an ebuild uses javac directly, instead of using ejavac, it should call this
1544     # to know what -source/-target to use.
1545     #
1546 caster 1.155 # @RETURN: string - arguments to pass to javac, complete with -target and -source
1547 nichoj 1.1 java-pkg_javac-args() {
1548     debug-print-function ${FUNCNAME} $*
1549    
1550     local want_source="$(java-pkg_get-source)"
1551     local want_target="$(java-pkg_get-target)"
1552    
1553 betelgeuse 1.19 local source_str="-source ${want_source}"
1554 nichoj 1.1 local target_str="-target ${want_target}"
1555    
1556     debug-print "want source: ${want_source}"
1557     debug-print "want target: ${want_target}"
1558    
1559     if [[ -z "${want_source}" || -z "${want_target}" ]]; then
1560 caster 1.24 debug-print "could not find valid -source/-target values for javac"
1561     echo "Could not find valid -source/-target values for javac"
1562     return 1
1563 nichoj 1.1 else
1564     if java-pkg_is-vm-version-ge "1.4"; then
1565     echo "${source_str} ${target_str}"
1566     else
1567     echo "${target_str}"
1568     fi
1569     fi
1570     }
1571    
1572 caster 1.155 # @FUNCTION: java-pkg_get-jni-cflags
1573     # @DESCRIPTION:
1574     # Echos the CFLAGS for JNI compilations
1575 nichoj 1.1 java-pkg_get-jni-cflags() {
1576     local flags="-I${JAVA_HOME}/include"
1577    
1578 flameeyes 1.33 local platform="linux"
1579     use elibc_FreeBSD && platform="freebsd"
1580    
1581 nichoj 1.10 # TODO do a check that the directories are valid
1582 flameeyes 1.33 flags="${flags} -I${JAVA_HOME}/include/${platform}"
1583 nichoj 1.1
1584     echo ${flags}
1585     }
1586    
1587 nichoj 1.10 java-pkg_ensure-gcj() {
1588 sera 1.151 # was enforcing sys-devel/gcc[gcj]
1589     die "${FUNCNAME} was removed. Use use-deps available as of EAPI 2 instead. #261562"
1590 nichoj 1.10 }
1591    
1592 nichoj 1.13 java-pkg_ensure-test() {
1593 sera 1.151 # was enforcing USE=test if FEATURES=test
1594     die "${FUNCNAME} was removed. Package mangers handle this already. #278965"
1595 nichoj 1.13 }
1596    
1597 caster 1.155 # @FUNCTION: java-pkg_register-ant-task
1598     # @USAGE: [--version x.y] [<name>]
1599     # @DESCRIPTION:
1600 caster 1.46 # Register this package as ant task, so that ant will load it when no specific
1601     # ANT_TASKS are specified. Note that even without this registering, all packages
1602     # specified in ANT_TASKS will be loaded. Mostly used by the actual ant tasks
1603     # packages, but can be also used by other ebuilds that used to symlink their
1604     # .jar into /usr/share/ant-core/lib to get autoloaded, for backwards
1605     # compatibility.
1606     #
1607 caster 1.155 # @CODE
1608     # Parameters
1609     # --version x.y Register only for ant version x.y (otherwise for any ant
1610 caster 1.46 # version). Used by the ant-* packages to prevent loading of mismatched
1611     # ant-core ant tasks after core was updated, before the tasks are updated,
1612     # without a need for blockers.
1613 caster 1.155 # $1 Name to register as. Defaults to JAVA_PKG_NAME ($PN[-$SLOT])
1614     # @CODE
1615 caster 1.46 java-pkg_register-ant-task() {
1616     local TASKS_DIR="tasks"
1617    
1618     # check for --version x.y parameters
1619     while [[ -n "${1}" && -n "${2}" ]]; do
1620     local var="${1#--}"
1621     local val="${2}"
1622     if [[ "${var}" == "version" ]]; then
1623     TASKS_DIR="tasks-${val}"
1624     else
1625     die "Unknown parameter passed to java-pkg_register-ant-tasks: ${1} ${2}"
1626     fi
1627     shift 2
1628     done
1629    
1630     local TASK_NAME="${1:-${JAVA_PKG_NAME}}"
1631    
1632     dodir /usr/share/ant/${TASKS_DIR}
1633     touch "${D}/usr/share/ant/${TASKS_DIR}/${TASK_NAME}"
1634     }
1635    
1636 caster 1.155 # @FUNCTION: java-pkg_ant-tasks-depend
1637     # @INTERNAL
1638     # @DESCRIPTION:
1639 caster 1.46 # Translates the WANT_ANT_TASKS variable into valid dependencies.
1640     java-pkg_ant-tasks-depend() {
1641     debug-print-function ${FUNCNAME} ${WANT_ANT_TASKS}
1642    
1643     if [[ -n "${WANT_ANT_TASKS}" ]]; then
1644     local DEP=""
1645     for i in ${WANT_ANT_TASKS}
1646     do
1647 betelgeuse 1.110 if [[ ${i} = ant-* ]]; then
1648     DEP="${DEP}dev-java/${i} "
1649     elif [[ ${i} = */*:* ]]; then
1650     DEP="${DEP}${i} "
1651     else
1652 caster 1.46 echo "Invalid atom in WANT_ANT_TASKS: ${i}"
1653     return 1
1654     fi
1655     done
1656     echo ${DEP}
1657     return 0
1658     else
1659     return 0
1660     fi
1661     }
1662    
1663 serkan 1.136
1664 caster 1.155 # @FUNCTION: ejunit_
1665     # @INTERNAL
1666     # @DESCRIPTION:
1667 serkan 1.136 # Internal Junit wrapper function. Makes it easier to run the tests and checks for
1668 betelgeuse 1.84 # dev-java/junit in DEPEND. Launches the tests using junit.textui.TestRunner.
1669 caster 1.155 # @CODE
1670     # Parameters:
1671     # $1 - junit package (junit or junit-4)
1672     # $2 - -cp or -classpath
1673     # $3 - classpath; junit and recorded dependencies get appended
1674     # $@ - the rest of the parameters are passed to java
1675     # @CODE
1676 serkan 1.136 ejunit_() {
1677 betelgeuse 1.84 debug-print-function ${FUNCNAME} $*
1678    
1679 betelgeuse 1.87 local pkgs
1680 betelgeuse 1.106 if [[ -f ${JAVA_PKG_DEPEND_FILE} ]]; then
1681     for atom in $(cat ${JAVA_PKG_DEPEND_FILE} | tr : ' '); do
1682     pkgs=${pkgs},$(echo ${atom} | sed -re "s/^.*@//")
1683     done
1684     fi
1685 betelgeuse 1.87
1686 serkan 1.136 local junit=${1}
1687     shift 1
1688    
1689     local cp=$(java-pkg_getjars --with-dependencies ${junit}${pkgs})
1690 betelgeuse 1.84 if [[ ${1} = -cp || ${1} = -classpath ]]; then
1691 betelgeuse 1.87 cp="${2}:${cp}"
1692 betelgeuse 1.84 shift 2
1693     else
1694 betelgeuse 1.87 cp=".:${cp}"
1695 betelgeuse 1.84 fi
1696    
1697     local runner=junit.textui.TestRunner
1698 serkan 1.138 if [[ "${junit}" == "junit-4" ]] ; then
1699     runner=org.junit.runner.JUnitCore
1700     fi
1701 betelgeuse 1.84 debug-print "Calling: java -cp \"${cp}\" -Djava.awt.headless=true ${runner} ${@}"
1702     java -cp "${cp}" -Djava.awt.headless=true ${runner} "${@}" || die "Running junit failed"
1703     }
1704    
1705 caster 1.155 # @FUNCTION: ejunit
1706     # @DESCRIPTION:
1707 serkan 1.136 # Junit wrapper function. Makes it easier to run the tests and checks for
1708 serkan 1.139 # dev-java/junit in DEPEND. Launches the tests using org.junit.runner.JUnitCore.
1709 serkan 1.136 #
1710 caster 1.155 # @CODE
1711     # Parameters:
1712     # $1 - -cp or -classpath
1713     # $2 - classpath; junit and recorded dependencies get appended
1714     # $@ - the rest of the parameters are passed to java
1715     #
1716 serkan 1.136 # Examples:
1717     # ejunit -cp build/classes org.blinkenlights.jid3.test.AllTests
1718     # ejunit org.blinkenlights.jid3.test.AllTests
1719 caster 1.155 # ejunit org.blinkenlights.jid3.test.FirstTest org.blinkenlights.jid3.test.SecondTest
1720     # @CODE
1721 serkan 1.136 ejunit() {
1722     debug-print-function ${FUNCNAME} $*
1723    
1724     ejunit_ "junit" "${@}"
1725     }
1726    
1727 caster 1.155 # @FUNCTION: ejunit4
1728     # @DESCRIPTION:
1729 serkan 1.136 # Junit4 wrapper function. Makes it easier to run the tests and checks for
1730     # dev-java/junit:4 in DEPEND. Launches the tests using junit.textui.TestRunner.
1731     #
1732 caster 1.155 # @CODE
1733     # Parameters:
1734     # $1 - -cp or -classpath
1735     # $2 - classpath; junit and recorded dependencies get appended
1736     # $@ - the rest of the parameters are passed to java
1737     #
1738 serkan 1.136 # Examples:
1739 serkan 1.137 # ejunit4 -cp build/classes org.blinkenlights.jid3.test.AllTests
1740     # ejunit4 org.blinkenlights.jid3.test.AllTests
1741 serkan 1.138 # ejunit4 org.blinkenlights.jid3.test.FirstTest \
1742     # org.blinkenlights.jid3.test.SecondTest
1743 caster 1.155 # @CODE
1744 serkan 1.136 ejunit4() {
1745     debug-print-function ${FUNCNAME} $*
1746    
1747     ejunit_ "junit-4" "${@}"
1748     }
1749    
1750 caster 1.155 # @FUNCTION: java-utils-2_src_prepare
1751     # @DESCRIPTION:
1752 betelgeuse 1.113 # src_prepare Searches for bundled jars
1753 caster 1.117 # Don't call directly, but via java-pkg-2_src_prepare!
1754 betelgeuse 1.113 java-utils-2_src_prepare() {
1755 betelgeuse 1.125 [[ ${EBUILD_PHASE} == prepare ]] &&
1756     java-pkg_func-exists java_prepare && java_prepare
1757    
1758 betelgeuse 1.113 # Remember that eant will call this unless called via Portage
1759     if [[ ! -e "${T}/java-utils-2_src_prepare-run" ]] && is-java-strict; then
1760     echo "Searching for bundled jars:"
1761     java-pkg_find-normal-jars || echo "None found."
1762     echo "Searching for bundled classes (no output if none found):"
1763     find "${WORKDIR}" -name "*.class"
1764     echo "Search done."
1765     fi
1766     touch "${T}/java-utils-2_src_prepare-run"
1767     }
1768    
1769 caster 1.155 # @FUNCTION: java-utils-2_pkg_preinst
1770     # @DESCRIPTION:
1771 serkan 1.122 # pkg_preinst Searches for missing and unneeded dependencies
1772     # Don't call directly, but via java-pkg-2_pkg_preinst!
1773     java-utils-2_pkg_preinst() {
1774     if is-java-strict; then
1775 chewi 1.159 if [[ ! -e "${JAVA_PKG_ENV}" ]] || has ant-tasks ${INHERITED}; then
1776     return
1777     fi
1778    
1779 serkan 1.122 if has_version dev-java/java-dep-check; then
1780     local output=$(GENTOO_VM= java-dep-check --image "${D}" "${JAVA_PKG_ENV}")
1781 chewi 1.159 [[ ${output} ]] && ewarn "${output}"
1782 serkan 1.122 else
1783     eerror "Install dev-java/java-dep-check for dependency checking"
1784     fi
1785     fi
1786     }
1787    
1788 caster 1.155 # @FUNCTION: eant
1789     # @USAGE: <ant_build_target(s)>
1790     # @DESCRIPTION:
1791 nichoj 1.1 # Ant wrapper function. Will use the appropriate compiler, based on user-defined
1792 caster 1.46 # compiler. Will also set proper ANT_TASKS from the variable ANT_TASKS,
1793 betelgeuse 1.41 # variables:
1794 chewi 1.157 #
1795 caster 1.155 # @CODE
1796     # Variables:
1797 betelgeuse 1.41 # EANT_GENTOO_CLASSPATH - calls java-pkg_getjars for the value and adds to the
1798 caster 1.155 # gentoo.classpath property. Be sure to call java-ant_rewrite-classpath in src_unpack.
1799 caster 1.120 # EANT_NEEDS_TOOLS - add tools.jar to the gentoo.classpath. Should only be used
1800 caster 1.155 # for build-time purposes, the dependency is not recorded to
1801     # package.env!
1802     # ANT_TASKS - used to determine ANT_TASKS before calling Ant.
1803     # @CODE
1804 nichoj 1.1 eant() {
1805     debug-print-function ${FUNCNAME} $*
1806    
1807 betelgeuse 1.92 if [[ ${EBUILD_PHASE} = compile ]]; then
1808 betelgeuse 1.113 java-ant-2_src_configure
1809     java-utils-2_src_prepare
1810 betelgeuse 1.92 fi
1811    
1812 ssuominen 1.141 if ! has java-ant-2 ${INHERITED}; then
1813 betelgeuse 1.52 local msg="You should inherit java-ant-2 when using eant"
1814 caster 1.82 java-pkg_announce-qa-violation "${msg}"
1815 betelgeuse 1.51 fi
1816    
1817 caster 1.96 local antflags="-Dnoget=true -Dmaven.mode.offline=true -Dbuild.sysclasspath=ignore"
1818 betelgeuse 1.57
1819 nichoj 1.1 java-pkg_init-compiler_
1820     local compiler="${GENTOO_COMPILER}"
1821    
1822     local compiler_env="${JAVA_PKG_COMPILER_DIR}/${compiler}"
1823     local build_compiler="$(source ${compiler_env} 1>/dev/null 2>&1; echo ${ANT_BUILD_COMPILER})"
1824     if [[ "${compiler}" != "javac" && -z "${build_compiler}" ]]; then
1825     die "ANT_BUILD_COMPILER undefined in ${compiler_env}"
1826     fi
1827    
1828     if [[ ${compiler} != "javac" ]]; then
1829 caster 1.36 antflags="${antflags} -Dbuild.compiler=${build_compiler}"
1830 nichoj 1.1 # Figure out any extra stuff to put on the classpath for compilers aside
1831     # from javac
1832     # ANT_BUILD_COMPILER_DEPS should be something that could be passed to
1833     # java-config -p
1834     local build_compiler_deps="$(source ${JAVA_PKG_COMPILER_DIR}/${compiler} 1>/dev/null 2>&1; echo ${ANT_BUILD_COMPILER_DEPS})"
1835     if [[ -n ${build_compiler_deps} ]]; then
1836     antflags="${antflags} -lib $(java-config -p ${build_compiler_deps})"
1837     fi
1838     fi
1839 nichoj 1.9
1840 betelgeuse 1.52 for arg in "${@}"; do
1841     if [[ ${arg} = -lib ]]; then
1842     if is-java-strict; then
1843     eerror "You should not use the -lib argument to eant because it will fail"
1844 betelgeuse 1.53 eerror "with JAVA_PKG_STRICT. Please use for example java-pkg_jar-from"
1845 betelgeuse 1.52 eerror "or ant properties to make dependencies available."
1846     eerror "For ant tasks use WANT_ANT_TASKS or ANT_TASKS from."
1847     eerror "split ant (>=dev-java/ant-core-1.7)."
1848     die "eant -lib is deprecated/forbidden"
1849     else
1850     echo "eant -lib is deprecated. Turn JAVA_PKG_STRICT on for"
1851     echo "more info."
1852     fi
1853     fi
1854     done
1855    
1856 betelgeuse 1.110 # parse WANT_ANT_TASKS for atoms
1857     local want_ant_tasks
1858     for i in ${WANT_ANT_TASKS}; do
1859     if [[ ${i} = */*:* ]]; then
1860     i=${i#*/}
1861     i=${i%:0}
1862     want_ant_tasks+="${i/:/-} "
1863     else
1864     want_ant_tasks+="${i} "
1865     fi
1866     done
1867 caster 1.103 # default ANT_TASKS to WANT_ANT_TASKS, if ANT_TASKS is not set explicitly
1868 betelgeuse 1.110 ANT_TASKS="${ANT_TASKS:-${want_ant_tasks% }}"
1869 caster 1.46
1870 caster 1.103 # override ANT_TASKS with JAVA_PKG_FORCE_ANT_TASKS if it's set
1871     ANT_TASKS="${JAVA_PKG_FORCE_ANT_TASKS:-${ANT_TASKS}}"
1872 caster 1.46
1873 caster 1.103 # if ant-tasks is not set by ebuild or forced, use none
1874     ANT_TASKS="${ANT_TASKS:-none}"
1875 betelgeuse 1.52
1876 caster 1.103 # at this point, ANT_TASKS should be "all", "none" or explicit list
1877     if [[ "${ANT_TASKS}" == "all" ]]; then
1878     einfo "Using all available ANT_TASKS"
1879     elif [[ "${ANT_TASKS}" == "none" ]]; then
1880     einfo "Disabling all optional ANT_TASKS"
1881     else
1882     einfo "Using following ANT_TASKS: ${ANT_TASKS}"
1883 caster 1.46 fi
1884    
1885 caster 1.103 export ANT_TASKS
1886    
1887 caster 1.46 [[ -n ${JAVA_PKG_DEBUG} ]] && antflags="${antflags} --execdebug -debug"
1888 betelgeuse 1.45 [[ -n ${PORTAGE_QUIET} ]] && antflags="${antflags} -q"
1889 betelgeuse 1.19
1890 betelgeuse 1.41 local gcp="${EANT_GENTOO_CLASSPATH}"
1891 caster 1.76 local getjarsarg=""
1892 betelgeuse 1.41
1893 betelgeuse 1.57 if [[ ${EBUILD_PHASE} = "test" ]]; then
1894     antflags="${antflags} -DJunit.present=true"
1895 caster 1.76 getjarsarg="--with-dependencies"
1896 chewi 1.159
1897     local re="\bant-junit4?([-:]\S+)?\b"
1898     [[ ${ANT_TASKS} =~ ${re} ]] && gcp+=" ${BASH_REMATCH[0]}"
1899 caster 1.147 else
1900     antflags="${antflags} -Dmaven.test.skip=true"
1901 betelgeuse 1.57 fi
1902    
1903     local cp
1904    
1905     for atom in ${gcp}; do
1906 betelgeuse 1.75 cp="${cp}:$(java-pkg_getjars ${getjarsarg} ${atom})"
1907 betelgeuse 1.57 done
1908    
1909 caster 1.120 [[ -n "${EANT_NEEDS_TOOLS}" ]] && cp="${cp}:$(java-config --tools)"
1910    
1911 betelgeuse 1.57 if [[ ${cp} ]]; then
1912 betelgeuse 1.41 # It seems ant does not like single quotes around ${cp}
1913 betelgeuse 1.112 cp=${cp#:}
1914     [[ ${EANT_GENTOO_CLASSPATH_EXTRA} ]] && \
1915     cp="${cp}:${EANT_GENTOO_CLASSPATH_EXTRA}"
1916     antflags="${antflags} -Dgentoo.classpath=\"${cp}\""
1917 betelgeuse 1.41 fi
1918    
1919 nichoj 1.1 [[ -n ${JAVA_PKG_DEBUG} ]] && echo ant ${antflags} "${@}"
1920 betelgeuse 1.75 debug-print "Calling ant (GENTOO_VM: ${GENTOO_VM}): ${antflags} ${@}"
1921 nichoj 1.1 ant ${antflags} "${@}" || die "eant failed"
1922     }
1923    
1924 caster 1.155 # @FUNCTION: ejavac
1925     # @USAGE: <javac_arguments>
1926     # @DESCRIPTION:
1927 betelgeuse 1.19 # Javac wrapper function. Will use the appropriate compiler, based on
1928 nichoj 1.1 # /etc/java-config/compilers.conf
1929     ejavac() {
1930     debug-print-function ${FUNCNAME} $*
1931    
1932 caster 1.24 java-pkg_init-compiler_
1933 nichoj 1.1
1934 caster 1.24 local compiler_executable
1935     compiler_executable=$(java-pkg_get-javac)
1936     if [[ ${?} != 0 ]]; then
1937     eerror "There was a problem determining compiler: ${compiler_executable}"
1938     die "get-javac failed"
1939     fi
1940    
1941     local javac_args
1942     javac_args="$(java-pkg_javac-args)"
1943     if [[ ${?} != 0 ]]; then
1944     eerror "There was a problem determining JAVACFLAGS: ${javac_args}"
1945     die "java-pkg_javac-args failed"
1946     fi
1947    
1948     [[ -n ${JAVA_PKG_DEBUG} ]] && echo ${compiler_executable} ${javac_args} "${@}"
1949     ${compiler_executable} ${javac_args} "${@}" || die "ejavac failed"
1950 nichoj 1.1 }
1951    
1952 chewi 1.157 # @FUNCTION: ejavadoc
1953     # @USAGE: <javadoc_arguments>
1954     # @DESCRIPTION:
1955     # javadoc wrapper function. Will set some flags based on the VM version
1956     # due to strict javadoc rules in 1.8.
1957     ejavadoc() {
1958     debug-print-function ${FUNCNAME} $*
1959    
1960     local javadoc_args=""
1961    
1962     if java-pkg_is-vm-version-ge "1.8" ; then
1963     javadoc_args="-Xdoclint:none"
1964     fi
1965    
1966     javadoc ${javadoc_args} "${@}" || die "ejavadoc failed"
1967     }
1968    
1969 caster 1.155 # @FUNCTION: java-pkg_filter-compiler
1970     # @USAGE: <compiler(s)_to_filter>
1971     # @DESCRIPTION:
1972 nichoj 1.1 # Used to prevent the use of some compilers. Should be used in src_compile.
1973     # Basically, it just appends onto JAVA_PKG_FILTER_COMPILER
1974     java-pkg_filter-compiler() {
1975     JAVA_PKG_FILTER_COMPILER="${JAVA_PKG_FILTER_COMPILER} $@"
1976     }
1977    
1978 caster 1.155 # @FUNCTION: java-pkg_force-compiler
1979     # @USAGE: <compiler(s)_to_force>
1980     # @DESCRIPTION:
1981 nichoj 1.8 # Used to force the use of particular compilers. Should be used in src_compile.
1982     # A common use of this would be to force ecj-3.1 to be used on amd64, to avoid
1983     # OutOfMemoryErrors that may come up.
1984     java-pkg_force-compiler() {
1985     JAVA_PKG_FORCE_COMPILER="$@"
1986     }
1987    
1988 caster 1.155 # @FUNCTION: use_doc
1989     # @DESCRIPTION:
1990 nichoj 1.1 #
1991     # Helper function for getting ant to build javadocs. If the user has USE=doc,
1992     # then 'javadoc' or the argument are returned. Otherwise, there is no return.
1993 betelgeuse 1.19 #
1994 nichoj 1.1 # The output of this should be passed to ant.
1995 caster 1.155 # @CODE
1996     # Parameters:
1997     # $@ - Option value to return. Defaults to 'javadoc'
1998 nichoj 1.1 #
1999 caster 1.155 # Examples:
2000     # build javadocs by calling 'javadoc' target
2001 nichoj 1.1 # eant $(use_doc)
2002 caster 1.155 #
2003     # build javadocs by calling 'apidoc' target
2004 nichoj 1.1 # eant $(use_doc apidoc)
2005 caster 1.155 # @CODE
2006     # @RETURN string - Name of the target to create javadocs
2007 nichoj 1.1 use_doc() {
2008     use doc && echo ${@:-javadoc}
2009     }
2010    
2011 betelgeuse 1.38
2012 caster 1.155 # @FUNCTION: java-pkg_init
2013     # @INTERNAL
2014     # @DESCRIPTION:
2015 nichoj 1.1 # The purpose of this function, as the name might imply, is to initialize the
2016     # Java environment. It ensures that that there aren't any environment variables
2017     # that'll muss things up. It initializes some variables, which are used
2018     # internally. And most importantly, it'll switch the VM if necessary.
2019     #
2020     # This shouldn't be used directly. Instead, java-pkg and java-pkg-opt will
2021     # call it during each of the phases of the merge process.
2022     java-pkg_init() {
2023 betelgeuse 1.97 debug-print-function ${FUNCNAME} $*
2024 sera 1.148
2025     # Don't set up build environment if installing from binary. #206024 #258423
2026     [[ "${MERGE_TYPE}" == "binary" ]] && return
2027     # Also try Portage's nonstandard EMERGE_FROM for old EAPIs, if it doesn't
2028     # work nothing is lost.
2029     has ${EAPI:-0} 0 1 2 3 && [[ "${EMERGE_FROM}" == "binary" ]] && return
2030    
2031 nichoj 1.1 unset JAVAC
2032     unset JAVA_HOME
2033 betelgeuse 1.64
2034 betelgeuse 1.116 java-config --help >/dev/null || {
2035     eerror ""
2036     eerror "Can't run java-config --help"
2037     eerror "Have you upgraded python recently but haven't"
2038     eerror "run python-updater yet?"
2039     die "Can't run java-config --help"
2040     }
2041    
2042 betelgeuse 1.64 # People do all kinds of weird things.
2043     # http://forums.gentoo.org/viewtopic-p-3943166.html
2044 betelgeuse 1.65 local silence="${SILENCE_JAVA_OPTIONS_WARNING}"
2045 betelgeuse 1.64 local accept="${I_WANT_GLOBAL_JAVA_OPTIONS}"
2046 betelgeuse 1.65 if [[ -n ${_JAVA_OPTIONS} && -z ${accept} && -z ${silence} ]]; then
2047 betelgeuse 1.64 ewarn "_JAVA_OPTIONS changes what java -version outputs at least for"
2048     ewarn "sun-jdk vms and and as such break configure scripts that"
2049     ewarn "use it (for example app-office/openoffice) so we filter it out."
2050     ewarn "Use SILENCE_JAVA_OPTIONS_WARNING=true in the environment (use"
2051     ewarn "make.conf for example) to silence this warning or"
2052     ewarn "I_WANT_GLOBAL_JAVA_OPTIONS to not filter it."
2053     fi
2054    
2055     if [[ -z ${accept} ]]; then
2056 betelgeuse 1.98 # export _JAVA_OPTIONS= doesn't work because it will show up in java
2057     # -version output
2058     unset _JAVA_OPTIONS
2059 betelgeuse 1.64 # phase hooks make this run many times without this
2060     I_WANT_GLOBAL_JAVA_OPTIONS="true"
2061     fi
2062    
2063 betelgeuse 1.92 if java-pkg_func-exists ant_src_unpack; then
2064     java-pkg_announce-qa-violation "Using old ant_src_unpack. Should be src_unpack"
2065     fi
2066    
2067 nichoj 1.1 java-pkg_switch-vm
2068     PATH=${JAVA_HOME}/bin:${PATH}
2069    
2070     # TODO we will probably want to set JAVAC and JAVACFLAGS
2071    
2072     # Do some QA checks
2073     java-pkg_check-jikes
2074    
2075 betelgeuse 1.97 # Can't use unset here because Portage does not save the unset
2076     # see https://bugs.gentoo.org/show_bug.cgi?id=189417#c11
2077    
2078 betelgeuse 1.19 # When users have crazy classpaths some packages can fail to compile.
2079 nichoj 1.1 # and everything should work with empty CLASSPATH.
2080     # This also helps prevent unexpected dependencies on random things
2081     # from the CLASSPATH.
2082 betelgeuse 1.97 export CLASSPATH=
2083 betelgeuse 1.59
2084 caster 1.46 # Unset external ANT_ stuff
2085 betelgeuse 1.97 export ANT_TASKS=
2086     export ANT_OPTS=
2087 caster 1.118 export ANT_RESPECT_JAVA_HOME=
2088 nichoj 1.1 }
2089    
2090 caster 1.155 # @FUNCTION: java-pkg-init-compiler_
2091     # @INTERNAL
2092     # @DESCRIPTION:
2093 nichoj 1.1 # This function attempts to figure out what compiler should be used. It does
2094 betelgeuse 1.19 # this by reading the file at JAVA_PKG_COMPILERS_CONF, and checking the
2095 nichoj 1.1 # COMPILERS variable defined there.
2096     # This can be overridden by a list in JAVA_PKG_FORCE_COMPILER
2097 betelgeuse 1.19 #
2098 nichoj 1.1 # It will go through the list of compilers, and verify that it supports the
2099     # target and source that are needed. If it is not suitable, then the next
2100     # compiler is checked. When JAVA_PKG_FORCE_COMPILER is defined, this checking
2101     # isn't done.
2102     #
2103     # Once the which compiler to use has been figured out, it is set to
2104     # GENTOO_COMPILER.
2105     #
2106     # If you hadn't guessed, JAVA_PKG_FORCE_COMPILER is for testing only.
2107     #
2108     # If the user doesn't defined anything in JAVA_PKG_COMPILERS_CONF, or no
2109     # suitable compiler was found there, then the default is to use javac provided
2110     # by the current VM.
2111     #
2112     #
2113 caster 1.155 # @RETURN name of the compiler to use
2114 nichoj 1.1 java-pkg_init-compiler_() {
2115     debug-print-function ${FUNCNAME} $*
2116    
2117     if [[ -n ${GENTOO_COMPILER} ]]; then
2118     debug-print "GENTOO_COMPILER already set"
2119     return
2120     fi
2121    
2122 nichoj 1.3 local compilers;
2123     if [[ -z ${JAVA_PKG_FORCE_COMPILER} ]]; then
2124     compilers="$(source ${JAVA_PKG_COMPILERS_CONF} 1>/dev/null 2>&1; echo ${COMPILERS})"
2125     else
2126     compilers=${JAVA_PKG_FORCE_COMPILER}
2127     fi
2128 betelgeuse 1.19
2129 nichoj 1.1 debug-print "Read \"${compilers}\" from ${JAVA_PKG_COMPILERS_CONF}"
2130    
2131     # Figure out if we should announce what compiler we're using
2132     local compiler
2133     for compiler in ${compilers}; do
2134     debug-print "Checking ${compiler}..."
2135     # javac should always be alright
2136     if [[ ${compiler} = "javac" ]]; then
2137     debug-print "Found javac... breaking"
2138     export GENTOO_COMPILER="javac"
2139     break
2140     fi
2141 betelgeuse 1.19
2142 nichoj 1.1 if has ${compiler} ${JAVA_PKG_FILTER_COMPILER}; then
2143     if [[ -z ${JAVA_PKG_FORCE_COMPILER} ]]; then
2144     einfo "Filtering ${compiler}"
2145     continue
2146     fi
2147     fi
2148 betelgeuse 1.19
2149 nichoj 1.1 # for non-javac, we need to make sure it supports the right target and
2150     # source
2151     local compiler_env="${JAVA_PKG_COMPILER_DIR}/${compiler}"
2152     if [[ -f ${compiler_env} ]]; then
2153     local desired_target="$(java-pkg_get-target)"
2154     local desired_source="$(java-pkg_get-source)"
2155    
2156    
2157     # Verify that the compiler supports target
2158     local supported_target=$(source ${compiler_env} 1>/dev/null 2>&1; echo ${SUPPORTED_TARGET})
2159     if ! has ${desired_target} ${supported_target}; then
2160     ewarn "${compiler} does not support -target ${desired_target}, skipping"
2161     continue
2162     fi
2163    
2164     # -source was introduced in 1.3, so only check 1.3 and on
2165     if version_is_at_least "${desired_soure}" "1.3"; then
2166     # Verify that the compiler supports source
2167     local supported_source=$(source ${compiler_env} 1>/dev/null 2>&1; echo ${SUPPORTED_SOURCE})
2168     if ! has ${desired_source} ${supported_source}; then
2169     ewarn "${compiler} does not support -source ${desired_source}, skipping"
2170     continue
2171     fi
2172     fi
2173    
2174     # if you get here, then the compiler should be good to go
2175     export GENTOO_COMPILER="${compiler}"
2176     break
2177     else
2178     ewarn "Could not find configuration for ${compiler}, skipping"
2179     ewarn "Perhaps it is not installed?"
2180     continue
2181     fi
2182     done
2183    
2184     # If it hasn't been defined already, default to javac
2185     if [[ -z ${GENTOO_COMPILER} ]]; then
2186     if [[ -n ${compilers} ]]; then
2187 betelgeuse 1.104 einfo "No suitable compiler found: defaulting to JDK default for compilation"
2188 nichoj 1.1 else
2189     # probably don't need to notify users about the default.
2190     :;#einfo "Defaulting to javac for compilation"
2191     fi
2192 betelgeuse 1.104 if java-config -g GENTOO_COMPILER 2> /dev/null; then
2193     export GENTOO_COMPILER=$(java-config -g GENTOO_COMPILER)
2194     else
2195     export GENTOO_COMPILER=javac
2196     fi
2197 nichoj 1.1 else
2198     einfo "Using ${GENTOO_COMPILER} for compilation"
2199     fi
2200    
2201     }
2202    
2203 caster 1.155 # @FUNCTION: init_paths_
2204     # @INTERNAL
2205     # @DESCRIPTION:
2206 nichoj 1.1 # Initializes some variables that will be used. These variables are mostly used
2207     # to determine where things will eventually get installed.
2208     java-pkg_init_paths_() {
2209     debug-print-function ${FUNCNAME} $*
2210    
2211     local pkg_name
2212 radhermit 1.154 if [[ "${SLOT%/*}" == "0" ]] ; then
2213 nichoj 1.1 JAVA_PKG_NAME="${PN}"
2214     else
2215 radhermit 1.154 JAVA_PKG_NAME="${PN}-${SLOT%/*}"
2216 nichoj 1.1 fi
2217    
2218     JAVA_PKG_SHAREPATH="${DESTTREE}/share/${JAVA_PKG_NAME}"
2219     JAVA_PKG_SOURCESPATH="${JAVA_PKG_SHAREPATH}/sources/"
2220     JAVA_PKG_ENV="${D}${JAVA_PKG_SHAREPATH}/package.env"
2221 ali_bush 1.94 JAVA_PKG_VIRTUALS_PATH="${DESTTREE}/share/java-config-2/virtuals"
2222     JAVA_PKG_VIRTUAL_PROVIDER="${D}/${JAVA_PKG_VIRTUALS_PATH}/${JAVA_PKG_NAME}"
2223 nichoj 1.1
2224     [[ -z "${JAVA_PKG_JARDEST}" ]] && JAVA_PKG_JARDEST="${JAVA_PKG_SHAREPATH}/lib"
2225     [[ -z "${JAVA_PKG_LIBDEST}" ]] && JAVA_PKG_LIBDEST="${DESTTREE}/$(get_libdir)/${JAVA_PKG_NAME}"
2226     [[ -z "${JAVA_PKG_WARDEST}" ]] && JAVA_PKG_WARDEST="${JAVA_PKG_SHAREPATH}/webapps"
2227    
2228     # TODO maybe only print once?
2229     debug-print "JAVA_PKG_SHAREPATH: ${JAVA_PKG_SHAREPATH}"
2230     debug-print "JAVA_PKG_ENV: ${JAVA_PKG_ENV}"
2231     debug-print "JAVA_PKG_JARDEST: ${JAVA_PKG_JARDEST}"
2232     debug-print "JAVA_PKG_LIBDEST: ${JAVA_PKG_LIBDEST}"
2233     debug-print "JAVA_PKG_WARDEST: ${JAVA_PKG_WARDEST}"
2234     }
2235    
2236 caster 1.155 # @FUNCTION: java-pkg_do_write_
2237     # @INTERNAL
2238     # @DESCRIPTION:
2239 nichoj 1.1 # Writes the package.env out to disk.
2240     #
2241     # TODO change to do-write, to match everything else
2242     java-pkg_do_write_() {
2243 betelgeuse 1.87 debug-print-function ${FUNCNAME} $*
2244 betelgeuse 1.28 java-pkg_init_paths_
2245 nichoj 1.1 # Create directory for package.env
2246     dodir "${JAVA_PKG_SHAREPATH}"
2247 betelgeuse 1.87 if [[ -n "${JAVA_PKG_CLASSPATH}" || -n "${JAVA_PKG_LIBRARY}" || -f \
2248 caster 1.88 "${JAVA_PKG_DEPEND_FILE}" || -f \
2249     "${JAVA_PKG_OPTIONAL_DEPEND_FILE}" ]]; then
2250 nichoj 1.1 # Create package.env
2251     (
2252     echo "DESCRIPTION=\"${DESCRIPTION}\""
2253     echo "GENERATION=\"2\""
2254 betelgeuse 1.104 echo "SLOT=\"${SLOT}\""
2255 ali_bush 1.129 echo "CATEGORY=\"${CATEGORY}\""
2256     echo "PVR=\"${PVR}\""
2257 nichoj 1.1
2258     [[ -n "${JAVA_PKG_CLASSPATH}" ]] && echo "CLASSPATH=\"${JAVA_PKG_CLASSPATH}\""
2259     [[ -n "${JAVA_PKG_LIBRARY}" ]] && echo "LIBRARY_PATH=\"${JAVA_PKG_LIBRARY}\""
2260     [[ -n "${JAVA_PROVIDE}" ]] && echo "PROVIDES=\"${JAVA_PROVIDE}\""
2261 betelgeuse 1.87 [[ -f "${JAVA_PKG_DEPEND_FILE}" ]] \
2262 betelgeuse 1.133 && echo "DEPEND=\"$(sort -u "${JAVA_PKG_DEPEND_FILE}" | tr '\n' ':')\""
2263 caster 1.88 [[ -f "${JAVA_PKG_OPTIONAL_DEPEND_FILE}" ]] \
2264 betelgeuse 1.133 && echo "OPTIONAL_DEPEND=\"$(sort -u "${JAVA_PKG_OPTIONAL_DEPEND_FILE}" | tr '\n' ':')\""
2265 nichoj 1.1 echo "VM=\"$(echo ${RDEPEND} ${DEPEND} | sed -e 's/ /\n/g' | sed -n -e '/virtual\/\(jre\|jdk\)/ { p;q }')\"" # TODO cleanup !
2266 ali_bush 1.129 [[ -f "${JAVA_PKG_BUILD_DEPEND_FILE}" ]] \
2267 betelgeuse 1.133 && echo "BUILD_DEPEND=\"$(sort -u "${JAVA_PKG_BUILD_DEPEND_FILE}" | tr '\n' ':')\""
2268 nichoj 1.1 ) > "${JAVA_PKG_ENV}"
2269 betelgeuse 1.19
2270 nichoj 1.1 # register target/source
2271     local target="$(java-pkg_get-target)"
2272     local source="$(java-pkg_get-source)"
2273     [[ -n ${target} ]] && echo "TARGET=\"${target}\"" >> "${JAVA_PKG_ENV}"
2274     [[ -n ${source} ]] && echo "SOURCE=\"${source}\"" >> "${JAVA_PKG_ENV}"
2275    
2276     # register javadoc info
2277     [[ -n ${JAVADOC_PATH} ]] && echo "JAVADOC_PATH=\"${JAVADOC_PATH}\"" \
2278     >> ${JAVA_PKG_ENV}
2279     # register source archives
2280     [[ -n ${JAVA_SOURCES} ]] && echo "JAVA_SOURCES=\"${JAVA_SOURCES}\"" \
2281     >> ${JAVA_PKG_ENV}
2282    
2283    
2284     echo "MERGE_VM=\"${GENTOO_VM}\"" >> "${JAVA_PKG_ENV}"
2285     [[ -n ${GENTOO_COMPILER} ]] && echo "MERGE_COMPILER=\"${GENTOO_COMPILER}\"" >> "${JAVA_PKG_ENV}"
2286    
2287 caster 1.85 # extra env variables
2288     if [[ -n "${JAVA_PKG_EXTRA_ENV_VARS}" ]]; then
2289     cat "${JAVA_PKG_EXTRA_ENV}" >> "${JAVA_PKG_ENV}" || die
2290     # nested echo to remove leading/trailing spaces
2291     echo "ENV_VARS=\"$(echo ${JAVA_PKG_EXTRA_ENV_VARS})\"" \
2292     >> "${JAVA_PKG_ENV}" || die
2293     fi
2294    
2295 nichoj 1.1 # Strip unnecessary leading and trailing colons
2296     # TODO try to cleanup if possible
2297     sed -e "s/=\":/=\"/" -e "s/:\"$/\"/" -i "${JAVA_PKG_ENV}" || die "Did you forget to call java_init ?"
2298 betelgeuse 1.87 else
2299 caster 1.88 debug-print "JAVA_PKG_CLASSPATH, JAVA_PKG_LIBRARY, JAVA_PKG_DEPEND_FILE"
2300     debug-print "or JAVA_PKG_OPTIONAL_DEPEND_FILE not defined so can't"
2301 betelgeuse 1.87 debug-print "write package.env."
2302 nichoj 1.1 fi
2303     }
2304    
2305 caster 1.155 # @FUNCTION: java-pkg_record-jar_
2306     # @INTERNAL
2307     # @DESCRIPTION:
2308 caster 1.88 # Record an (optional) dependency to the package.env
2309 caster 1.155 # @CODE
2310     # Parameters:
2311     # --optional - record dependency as optional
2312     # --build - record dependency as build_only
2313     # $1 - package to record
2314     # $2 - (optional) jar of package to record
2315     # @CODE
2316 betelgeuse 1.87 JAVA_PKG_DEPEND_FILE="${T}/java-pkg-depend"
2317 caster 1.88 JAVA_PKG_OPTIONAL_DEPEND_FILE="${T}/java-pkg-optional-depend"
2318 ali_bush 1.129 JAVA_PKG_BUILD_DEPEND_FILE="${T}/java-pkg-build-depend"
2319 nichoj 1.1
2320     java-pkg_record-jar_() {
2321     debug-print-function ${FUNCNAME} $*
2322    
2323 caster 1.88 local depend_file="${JAVA_PKG_DEPEND_FILE}"
2324 ali_bush 1.129 case "${1}" in
2325     "--optional") depend_file="${JAVA_PKG_OPTIONAL_DEPEND_FILE}"; shift;;
2326     "--build-only") depend_file="${JAVA_PKG_BUILD_DEPEND_FILE}"; shift;;
2327     esac
2328 caster 1.88
2329 nichoj 1.1 local pkg=${1} jar=${2} append
2330     if [[ -z "${jar}" ]]; then
2331     append="${pkg}"
2332     else
2333     append="$(basename ${jar})@${pkg}"
2334     fi
2335    
2336 caster 1.88 echo "${append}" >> "${depend_file}"
2337 nichoj 1.1 }
2338    
2339 caster 1.155 # @FUNCTION: java-pkg_append_
2340     # @INTERNAL
2341     # @DESCRIPTION:
2342     # Appends a value to a variable
2343 nichoj 1.1 #
2344 caster 1.155 # @CODE
2345     # Parameters:
2346     # $1 variable name to modify
2347     # $2 value to append
2348 nichoj 1.1 #
2349 caster 1.155 # Examples:
2350     # java-pkg_append_ CLASSPATH foo.jar
2351     # @CODE
2352 nichoj 1.1 java-pkg_append_() {
2353     debug-print-function ${FUNCNAME} $*
2354    
2355     local var="${1}" value="${2}"
2356     if [[ -z "${!var}" ]] ; then
2357     export ${var}="${value}"
2358     else
2359     local oldIFS=${IFS} cur haveit
2360     IFS=':'
2361     for cur in ${!var}; do
2362     if [[ ${cur} == ${value} ]]; then
2363     haveit="yes"
2364     break
2365     fi
2366     done
2367     [[ -z ${haveit} ]] && export ${var}="${!var}:${value}"
2368     IFS=${oldIFS}
2369     fi
2370     }
2371    
2372 caster 1.155 # @FUNCTION: java-pkg_expand_dir_
2373     # @INTERNAL
2374     # @DESCRIPTION:
2375 nichoj 1.1 # Gets the full path of the file/directory's parent.
2376 caster 1.155 # @CODE
2377     # Parameters:
2378     # $1 - file/directory to find parent directory for
2379     # @CODE
2380     # @RETURN: path to $1's parent directory
2381 nichoj 1.1 java-pkg_expand_dir_() {
2382     pushd "$(dirname "${1}")" >/dev/null 2>&1
2383     pwd
2384     popd >/dev/null 2>&1
2385     }
2386    
2387 caster 1.155 # @FUNCTION: java-pkg_func-exists
2388     # @INTERNAL
2389     # @DESCRIPTION:
2390 nichoj 1.1 # Does the indicated function exist?
2391 caster 1.155 # @RETURN: 0 - function is declared, 1 - function is undeclared
2392 nichoj 1.1 java-pkg_func-exists() {
2393 betelgeuse 1.126 declare -F ${1} > /dev/null
2394 nichoj 1.1 }
2395    
2396 caster 1.155 # @FUNCTION: java-pkg_setup-vm
2397     # @INTERNAL
2398     # @DESCRIPTION:
2399 nichoj 1.1 # Sets up the environment for a specific VM
2400     java-pkg_setup-vm() {
2401     debug-print-function ${FUNCNAME} $*
2402    
2403     local vendor="$(java-pkg_get-vm-vendor)"
2404 caster 1.23 if [[ "${vendor}" == "sun" ]] && java-pkg_is-vm-version-ge "1.5" ; then
2405 nichoj 1.1 addpredict "/dev/random"
2406     elif [[ "${vendor}" == "ibm" ]]; then
2407     addpredict "/proc/self/maps"
2408     addpredict "/proc/cpuinfo"
2409 serkan 1.143 addpredict "/proc/self/coredump_filter"
2410     elif [[ "${vendor}" == "oracle" ]]; then
2411     addpredict "/dev/random"
2412     addpredict "/proc/self/coredump_filter"
2413 serkan 1.145 elif [[ "${vendor}" == icedtea* ]] && java-pkg_is-vm-version-ge "1.7" ; then
2414 serkan 1.144 addpredict "/dev/random"
2415     addpredict "/proc/self/coredump_filter"
2416 nichoj 1.1 elif [[ "${vendor}" == "jrockit" ]]; then
2417     addpredict "/proc/cpuinfo"
2418     fi
2419     }
2420    
2421 caster 1.155 # @FUNCTION: java-pkg_needs-vm
2422     # @INTERNAL
2423     # @DESCRIPTION:
2424 sera 1.150 # Does the current package depend on virtual/jdk or does it set
2425     # JAVA_PKG_WANT_BUILD_VM?
2426 nichoj 1.1 #
2427 caster 1.155 # @RETURN: 0 - Package depends on virtual/jdk; 1 - Package does not depend on virtual/jdk
2428 nichoj 1.1 java-pkg_needs-vm() {
2429     debug-print-function ${FUNCNAME} $*
2430    
2431 caster 1.134 if [[ -n "$(echo ${JAVA_PKG_NV_DEPEND:-${DEPEND}} | sed -e '\:virtual/jdk:!d')" ]]; then
2432 nichoj 1.1 return 0
2433     fi
2434    
2435 sera 1.150 [[ -n "${JAVA_PKG_WANT_BUILD_VM}" ]] && return 0
2436    
2437 nichoj 1.1 return 1
2438     }
2439    
2440 caster 1.155 # @FUNCTION: java-pkg_get-current-vm
2441     # @INTERNAL
2442     # @RETURN - The current VM being used
2443 nichoj 1.1 java-pkg_get-current-vm() {
2444     java-config -f
2445     }
2446    
2447 caster 1.155 # @FUNCTION: java-pkg_get-vm-vendor
2448     # @INTERNAL
2449     # @RETURN - The vendor of the current VM
2450 nichoj 1.1 java-pkg_get-vm-vendor() {
2451     debug-print-function ${FUNCNAME} $*
2452    
2453     local vm="$(java-pkg_get-current-vm)"
2454     vm="${vm/-*/}"
2455     echo "${vm}"
2456     }
2457    
2458 caster 1.155 # @FUNCTION: java-pkg_get-vm-version
2459     # @INTERNAL
2460     # @RETURN - The version of the current VM
2461 nichoj 1.1 java-pkg_get-vm-version() {
2462     debug-print-function ${FUNCNAME} $*
2463    
2464 caster 1.22 java-config -g PROVIDES_VERSION
2465 nichoj 1.1 }
2466    
2467 caster 1.155 # @FUNCTION: java-pkg_build-vm-from-handle
2468     # @INTERNAL
2469     # @DESCRIPTION:
2470 sera 1.150 # Selects a build vm from a list of vm handles. First checks for the system-vm
2471     # beeing usable, then steps through the listed handles till a suitable vm is
2472     # found.
2473     #
2474 caster 1.155 # @RETURN - VM handle of an available JDK
2475 sera 1.150 java-pkg_build-vm-from-handle() {
2476     debug-print-function ${FUNCNAME} "$*"
2477    
2478     local vm
2479 sera 1.152 vm=$(java-pkg_get-current-vm 2>/dev/null)
2480     if [[ $? -eq 0 ]]; then
2481     if has ${vm} ${JAVA_PKG_WANT_BUILD_VM}; then
2482     echo ${vm}
2483     return 0
2484     fi
2485 sera 1.150 fi
2486    
2487     for vm in ${JAVA_PKG_WANT_BUILD_VM}; do
2488     if java-config-2 --select-vm=${vm} 2>/dev/null; then
2489     echo ${vm}
2490     return 0
2491     fi
2492     done
2493    
2494     eerror "${FUNCNAME}: No vm found for handles: ${JAVA_PKG_WANT_BUILD_VM}"
2495     return 1
2496     }
2497    
2498 caster 1.155 # @FUNCTION: java-pkg_switch-vm
2499     # @INTERNAL
2500     # @DESCRIPTION:
2501 betelgeuse 1.19 # Switch VM if we're allowed to (controlled by JAVA_PKG_ALLOW_VM_CHANGE), and
2502 nichoj 1.1 # verify that the current VM is sufficient.
2503     # Setup the environment for the VM being used.
2504     java-pkg_switch-vm() {
2505 betelgeuse 1.38 debug-print-function ${FUNCNAME} $*
2506    
2507 nichoj 1.1 if java-pkg_needs-vm; then
2508     # Use the VM specified by JAVA_PKG_FORCE_VM
2509 betelgeuse 1.38 if [[ -n "${JAVA_PKG_FORCE_VM}" ]]; then
2510 nichoj 1.1 # If you're forcing the VM, I hope you know what your doing...
2511 betelgeuse 1.38 debug-print "JAVA_PKG_FORCE_VM used: ${JAVA_PKG_FORCE_VM}"
2512 nichoj 1.1 export GENTOO_VM="${JAVA_PKG_FORCE_VM}"
2513     # if we're allowed to switch the vm...
2514     elif [[ "${JAVA_PKG_ALLOW_VM_CHANGE}" == "yes" ]]; then
2515 sera 1.150 # if there is an explicit list of handles to choose from
2516     if [[ -n "${JAVA_PKG_WANT_BUILD_VM}" ]]; then
2517     debug-print "JAVA_PKG_WANT_BUILD_VM used: ${JAVA_PKG_WANT_BUILD_VM}"
2518     GENTOO_VM=$(java-pkg_build-vm-from-handle)
2519     if [[ $? != 0 ]]; then
2520     eerror "${FUNCNAME}: No VM found for handles: ${JAVA_PKG_WANT_BUILD_VM}"
2521     die "${FUNCNAME}: Failed to determine VM for building"
2522     fi
2523     # JAVA_PKG_WANT_SOURCE and JAVA_PKG_WANT_TARGET are required as
2524     # they can't be deduced from handles.
2525     if [[ -z "${JAVA_PKG_WANT_SOURCE}" ]]; then
2526     eerror "JAVA_PKG_WANT_BUILD_VM specified but not JAVA_PKG_WANT_SOURCE"
2527     die "Specify JAVA_PKG_WANT_SOURCE"
2528     fi
2529     if [[ -z "${JAVA_PKG_WANT_TARGET}" ]]; then
2530     eerror "JAVA_PKG_WANT_BUILD_VM specified but not JAVA_PKG_WANT_TARGET"
2531     die "Specify JAVA_PKG_WANT_TARGET"
2532     fi
2533     # otherwise determine a vm from dep string
2534 caster 1.24 else
2535 sera 1.150 debug-print "depend-java-query: NV_DEPEND: ${JAVA_PKG_NV_DEPEND:-${DEPEND}}"
2536     GENTOO_VM="$(depend-java-query --get-vm "${JAVA_PKG_NV_DEPEND:-${DEPEND}}")"
2537     if [[ -z "${GENTOO_VM}" || "${GENTOO_VM}" == "None" ]]; then
2538     eerror "Unable to determine VM for building from dependencies:"
2539     echo "NV_DEPEND: ${JAVA_PKG_NV_DEPEND:-${DEPEND}}"
2540     die "Failed to determine VM for building."
2541     fi
2542 nichoj 1.1 fi
2543 sera 1.150 export GENTOO_VM
2544 nichoj 1.1 # otherwise just make sure the current VM is sufficient
2545     else
2546     java-pkg_ensure-vm-version-sufficient
2547     fi
2548     debug-print "Using: $(java-config -f)"
2549 betelgeuse 1.19
2550 nichoj 1.1 java-pkg_setup-vm
2551    
2552 nichoj 1.4 export JAVA=$(java-config --java)
2553     export JAVAC=$(java-config --javac)
2554 caster 1.24 JAVACFLAGS="$(java-pkg_javac-args)"
2555     if [[ ${?} != 0 ]]; then
2556     eerror "There was a problem determining JAVACFLAGS: ${JAVACFLAGS}"
2557     die "java-pkg_javac-args failed"
2558     fi
2559     [[ -n ${JAVACFLAGS_EXTRA} ]] && JAVACFLAGS="${JAVACFLAGS_EXTRA} ${JAVACFLAGS}"
2560     export JAVACFLAGS
2561 nichoj 1.1
2562     export JAVA_HOME="$(java-config -g JAVA_HOME)"
2563     export JDK_HOME=${JAVA_HOME}
2564    
2565     #TODO If you know a better solution let us know.
2566     java-pkg_append_ LD_LIBRARY_PATH "$(java-config -g LDPATH)"
2567 betelgeuse 1.19
2568 nichoj 1.1 local tann="${T}/announced-vm"
2569 betelgeuse 1.92 # With the hooks we should only get here once from pkg_setup but better safe than sorry
2570     # if people have for example modified eclasses some where
2571 nichoj 1.1 if [[ -n "${JAVA_PKG_DEBUG}" ]] || [[ ! -f "${tann}" ]] ; then
2572 betelgeuse 1.92 einfo "Using: $(java-config -f)"
2573     [[ ! -f "${tann}" ]] && touch "${tann}"
2574 nichoj 1.1 fi
2575    
2576     else
2577     [[ -n "${JAVA_PKG_DEBUG}" ]] && ewarn "!!! This package inherits java-pkg but doesn't depend on a JDK. -bin or broken dependency!!!"
2578     fi
2579     }
2580    
2581 caster 1.155 # @FUNCTION: java-pkg_die
2582     # @INTERNAL
2583     # @DESCRIPTION:
2584 nichoj 1.1 # Enhanced die for Java packages, which displays some information that may be
2585     # useful for debugging bugs on bugzilla.
2586     #register_die_hook java-pkg_die
2587 ssuominen 1.141 if ! has java-pkg_die ${EBUILD_DEATH_HOOKS}; then
2588 nichoj 1.1 EBUILD_DEATH_HOOKS="${EBUILD_DEATH_HOOKS} java-pkg_die"
2589     fi
2590    
2591     java-pkg_die() {
2592     echo "!!! When you file a bug report, please include the following information:" >&2
2593     echo "GENTOO_VM=${GENTOO_VM} CLASSPATH=\"${CLASSPATH}\" JAVA_HOME=\"${JAVA_HOME}\"" >&2
2594     echo "JAVACFLAGS=\"${JAVACFLAGS}\" COMPILER=\"${GENTOO_COMPILER}\"" >&2
2595 sera 1.153 echo "and of course, the output of emerge --info =${P}" >&2
2596 nichoj 1.1 }
2597    
2598 nichoj 1.7
2599     # TODO document
2600     # List jars in the source directory, ${S}
2601     java-pkg_jar-list() {
2602     if [[ -n "${JAVA_PKG_DEBUG}" ]]; then
2603     einfo "Linked Jars"
2604     find "${S}" -type l -name '*.jar' -print0 | xargs -0 -r -n 500 ls -ald | sed -e "s,${WORKDIR},\${WORKDIR},"
2605     einfo "Jars"
2606     find "${S}" -type f -name '*.jar' -print0 | xargs -0 -r -n 500 ls -ald | sed -e "s,${WORKDIR},\${WORKDIR},"
2607     einfo "Classes"
2608     find "${S}" -type f -name '*.class' -print0 | xargs -0 -r -n 500 ls -ald | sed -e "s,${WORKDIR},\${WORKDIR},"
2609     fi
2610     }
2611    
2612 caster 1.155 # @FUNCTION: java-pkg_verify-classes
2613     # @INTERNAL
2614     # @DESCRIPTION:
2615 caster 1.56 # Verify that the classes were compiled for the right source / target. Dies if
2616     # not.
2617 caster 1.155 # @CODE
2618     # $1 (optional) - the file to check, otherwise checks whole ${D}
2619     # @CODE
2620 nichoj 1.7 java-pkg_verify-classes() {
2621     #$(find ${D} -type f -name '*.jar' -o -name '*.class')
2622 ali_bush 1.108
2623     local version_verify="/usr/bin/class-version-verify.py"
2624    
2625     if [[ ! -x "${version_verify}" ]]; then
2626     version_verify="/usr/$(get_libdir)/javatoolkit/bin/class-version-verify.py"
2627     fi
2628    
2629     if [[ ! -x "${version_verify}" ]]; then
2630     ewarn "Unable to perform class version checks as"
2631     ewarn "class-version-verify.py is unavailable"
2632     ewarn "Please install dev-java/javatoolkit."
2633     return
2634     fi
2635    
2636 betelgeuse 1.55 local target=$(java-pkg_get-target)
2637 caster 1.56 local result
2638     local log="${T}/class-version-verify.log"
2639 betelgeuse 1.55 if [[ -n "${1}" ]]; then
2640 ali_bush 1.108 ${version_verify} -v -t ${target} "${1}" > "${log}"
2641 caster 1.56 result=$?
2642 betelgeuse 1.55 else
2643 caster 1.56 ebegin "Verifying java class versions (target: ${target})"
2644 ali_bush 1.108 ${version_verify} -v -t ${target} -r "${D}" > "${log}"
2645 caster 1.56 result=$?
2646     eend ${result}
2647 betelgeuse 1.55 fi
2648 caster 1.56 [[ -n ${JAVA_PKG_DEBUG} ]] && cat "${log}"
2649 betelgeuse 1.55 if [[ ${result} != 0 ]]; then
2650 caster 1.56 eerror "Incorrect bytecode version found"
2651     [[ -n "${1}" ]] && eerror "in file: ${1}"
2652     eerror "See ${log} for more details."
2653     die "Incorrect bytecode found"
2654 nichoj 1.7 fi
2655     }
2656    
2657 caster 1.155 # @FUNCTION: java-pkg_ensure-dep
2658     # @INTERNAL
2659     # @DESCRIPTION:
2660 ali_bush 1.70 # Check that a package being used in jarfrom, getjars and getjar is contained
2661 chewi 1.159 # within DEPEND or RDEPEND with the correct SLOT. See this mail for details:
2662     # https://archives.gentoo.org/gentoo-dev/message/dcb644f89520f4bbb61cc7bbe45fdf6e
2663 caster 1.155 # @CODE
2664     # Parameters:
2665     # $1 - empty - check both vars; "runtime" or "build" - check only
2666 caster 1.77 # RDEPEND, resp. DEPEND
2667 caster 1.155 # $2 - Package name and slot.
2668     # @CODE
2669 ali_bush 1.70 java-pkg_ensure-dep() {
2670     debug-print-function ${FUNCNAME} $*
2671    
2672 caster 1.77 local limit_to="${1}"
2673 ali_bush 1.70 local target_pkg="${2}"
2674     local dev_error=""
2675    
2676 chewi 1.158 # Transform into a regular expression to look for a matching package
2677     # and SLOT. SLOTs don't have to be numeric so foo-bar could either
2678     # mean foo-bar:0 or foo:bar. So you want to get your head around the
2679     # line below?
2680     #
2681     # * The target package first has any dots escaped, e.g. foo-1.2
2682     # becomes foo-1\.2.
2683     #
2684 chewi 1.159 # * sed then looks at the component following the last - or :
2685     # character, or the whole string if there is no - or :
2686     # character. It uses this to build a new regexp with two
2687     # significant branches.
2688 chewi 1.158 #
2689     # * The first checks for the whole target package string, optionally
2690     # followed by a version number, and then :0.
2691     #
2692     # * The second checks for the first part of the target package
2693     # string, optionally followed by a version number, followed by the
2694     # aforementioned component, treating that as a SLOT.
2695     #
2696 chewi 1.159 local stripped_pkg=/$(sed -r 's/[-:]?([^-:]+)$/(\0(-[^:]+)?:0|(-[^:]+)?:\1)/' <<< "${target_pkg//./\\.}")\\b
2697 ali_bush 1.70
2698 betelgeuse 1.87 debug-print "Matching against: ${stripped_pkg}"
2699    
2700 chewi 1.159 # Uncomment the lines below once we've dealt with more of these
2701     # otherwise we'll be tempted to turn JAVA_PKG_STRICT off while
2702     # getting hit with a wave of bug reports. :(
2703    
2704 chewi 1.158 if [[ ${limit_to} != runtime && ! ( "${DEPEND}" =~ $stripped_pkg ) ]]; then
2705     dev_error="The ebuild is attempting to use ${target_pkg}, which is not "
2706     dev_error+="declared with a SLOT in DEPEND."
2707 chewi 1.159 # if is-java-strict; then
2708     # die "${dev_error}"
2709     # else
2710     eqawarn "java-pkg_ensure-dep: ${dev_error}"
2711 chewi 1.158 # eerror "Because you have ${target_pkg} installed,"
2712     # eerror "the package will build without problems, but please"
2713     # eerror "report this to http://bugs.gentoo.org."
2714 chewi 1.159 # fi
2715 chewi 1.158 elif [[ ${limit_to} != build && ! ( "${RDEPEND}${PDEPEND}" =~ ${stripped_pkg} ) ]]; then
2716     dev_error="The ebuild is attempting to use ${target_pkg}, which is not "
2717     dev_error+="declared with a SLOT in [RP]DEPEND and --build-only wasn't given."
2718 chewi 1.159 # if is-java-strict; then
2719     # die "${dev_error}"
2720     # else
2721     eqawarn "java-pkg_ensure-dep: ${dev_error}"
2722 chewi 1.158 # eerror "The package will build without problems, but may fail to run"
2723     # eerror "if you don't have ${target_pkg} installed,"
2724     # eerror "so please report this to http://bugs.gentoo.org."
2725 chewi 1.159 # fi
2726 ali_bush 1.70 fi
2727     }
2728    
2729 nichoj 1.1 java-pkg_check-phase() {
2730     local phase=${1}
2731 caster 1.82 local funcname=${FUNCNAME[1]}
2732     if [[ ${EBUILD_PHASE} != ${phase} ]]; then
2733     local msg="${funcname} used outside of src_${phase}"
2734     java-pkg_announce-qa-violation "${msg}"
2735 nichoj 1.1 fi
2736     }
2737    
2738     java-pkg_check-versioned-jar() {
2739     local jar=${1}
2740    
2741     if [[ ${jar} =~ ${PV} ]]; then
2742     java-pkg_announce-qa-violation "installing versioned jar '${jar}'"
2743     fi
2744     }
2745    
2746     java-pkg_check-jikes() {
2747 ssuominen 1.141 if has jikes ${IUSE}; then
2748 nichoj 1.1 java-pkg_announce-qa-violation "deprecated USE flag 'jikes' in IUSE"
2749     fi
2750     }
2751    
2752     java-pkg_announce-qa-violation() {
2753 caster 1.82 local nodie
2754     if [[ ${1} == "--nodie" ]]; then
2755     nodie="true"
2756     shift
2757 nichoj 1.1 fi
2758 caster 1.82 echo "Java QA Notice: $@" >&2
2759     increment-qa-violations
2760     [[ -z "${nodie}" ]] && is-java-strict && die "${@}"
2761 nichoj 1.1 }
2762    
2763     increment-qa-violations() {
2764     let "JAVA_PKG_QA_VIOLATIONS+=1"
2765     export JAVA_PKG_QA_VIOLATIONS
2766     }
2767    
2768 nichoj 1.9 is-java-strict() {
2769 nichoj 1.14 [[ -n ${JAVA_PKG_STRICT} ]]
2770 nichoj 1.9 return $?
2771     }

  ViewVC Help
Powered by ViewVC 1.1.20