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

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

  ViewVC Help
Powered by ViewVC 1.1.20