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

Legend:
Removed from v.1.90  
changed lines
  Added in v.1.160

  ViewVC Help
Powered by ViewVC 1.1.20