/[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.166 - (hide annotations) (download)
Wed Jul 22 09:20:07 2015 UTC (3 years, 8 months ago) by monsieurp
Branch: MAIN
Changes since 1.165: +47 -1 lines
Introduce java-pkg_rm_files as a helper function along with JAVA_RM_FILES array to readily get rid of useless files. Derived from perl_rm_files by Kent Fredric.

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