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

Legend:
Removed from v.1.39  
changed lines
  Added in v.1.168

  ViewVC Help
Powered by ViewVC 1.1.20