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

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

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

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

Legend:
Removed from v.1.101  
changed lines
  Added in v.1.162

  ViewVC Help
Powered by ViewVC 1.1.20