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

Legend:
Removed from v.1.116  
changed lines
  Added in v.1.157

  ViewVC Help
Powered by ViewVC 1.1.20