/[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.62 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.62 2007/03/03 16:51:09 betelgeuse 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# ----------------------------------------------------------------------------- 32# @VARIABLE: JAVA_PKG_PORTAGE_DEP
42# @variable-external WANT_ANT_TASKS 33# @INTERNAL
43# @variable-default "" 34# @DESCRIPTION:
44#
45# An $IFS separated list of ant tasks.
46# Ebuild can specify this variable before inheriting java-ant-2 eclass to
47# determine ANT_TASKS it needs. They will be automatically translated to
48# DEPEND variable and ANT_TASKS variable. JAVA_PKG_FORCE_ANT_TASKS can override
49# ANT_TASKS set by WANT_ANT_TASKS, but not the DEPEND due to caching.
50# Ebuilds that need to depend conditionally on certain tasks and specify them
51# differently for different eant calls can't use this simplified approach.
52# You also cannot specify version or anything else than ant-*.
53#
54# @example WANT_ANT_TASKS="ant-junit ant-trax"
55#
56# @seealso JAVA_PKG_FORCE_ANT_TASKS
57# -----------------------------------------------------------------------------
58#WANT_ANT_TASKS
59
60# @variable-internal JAVA_PKG_PORTAGE_DEP
61#
62# The version of portage we need to function properly. At this moment it's 35# The version of portage we need to function properly. Previously it was
63# portage with phase hooks support. 36# portage with phase hooks support but now we use a version with proper env
64# ----------------------------------------------------------------------------- 37# saving. For EAPI 2 we have new enough stuff so let's have cleaner deps.
65JAVA_PKG_PORTAGE_DEP=">=sys-apps/portage-2.1_pre1" 38has "${EAPI}" 0 1 && JAVA_PKG_PORTAGE_DEP=">=sys-apps/portage-2.1.2.7"
66 39
67# ----------------------------------------------------------------------------- 40# @VARIABLE: JAVA_PKG_E_DEPEND
68# @variable-internal JAVA_PKG_E_DEPEND 41# @INTERNAL
69# 42# @DESCRIPTION:
70# This is a convience variable to be used from the other java eclasses. This is 43# This is a convience variable to be used from the other java eclasses. This is
71# the version of java-config we want to use. We also need a recent version 44# the version of java-config we want to use. Usually the latest stable version
72# portage, that includes phase hooks. 45# so that ebuilds can use new features without depending on specific versions.
73# -----------------------------------------------------------------------------
74JAVA_PKG_E_DEPEND=">=dev-java/java-config-2.0.31 ${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 )"
75 48
76# ----------------------------------------------------------------------------- 49# @ECLASS-VARIABLE: JAVA_PKG_WANT_BOOTCLASSPATH
77# @variable-external JAVA_PKG_ALLOW_VM_CHANGE 50# @DEFAULT_UNSET
78# @variable-default yes 51# @DESCRIPTION:
79# 52# The version of bootclasspath the package needs to work. Translates to a proper
53# dependency. The bootclasspath can then be obtained by java-ant_rewrite-bootclasspath
54if [[ -n "${JAVA_PKG_WANT_BOOTCLASSPATH}" ]]; then
55 if [[ "${JAVA_PKG_WANT_BOOTCLASSPATH}" == "1.5" ]]; then
56 JAVA_PKG_E_DEPEND="${JAVA_PKG_E_DEPEND} >=dev-java/gnu-classpath-0.98-r1:0.98"
57 else
58 eerror "Unknown value of JAVA_PKG_WANT_BOOTCLASSPATH"
59 # since die in global scope doesn't work, this will make repoman fail
60 JAVA_PKG_E_DEPEND="${JAVA_PKG_E_DEPEND} BAD_JAVA_PKG_WANT_BOOTCLASSPATH"
61 fi
62fi
63
64# @ECLASS-VARIABLE: JAVA_PKG_ALLOW_VM_CHANGE
65# @DESCRIPTION:
80# Allow this eclass to change the active VM? 66# Allow this eclass to change the active VM?
81# If your system VM isn't sufficient for the package, the build will fail. 67# If your system VM isn't sufficient for the package, the build will fail
82# @note This is useful for testing specific VMs. 68# instead of trying to switch to another VM.
83# ----------------------------------------------------------------------------- 69#
70# Overriding the default can be useful for testing specific VMs locally, but
71# should not be used in the final ebuild.
84JAVA_PKG_ALLOW_VM_CHANGE=${JAVA_PKG_ALLOW_VM_CHANGE:="yes"} 72JAVA_PKG_ALLOW_VM_CHANGE=${JAVA_PKG_ALLOW_VM_CHANGE:="yes"}
85 73
86# ----------------------------------------------------------------------------- 74# @ECLASS-VARIABLE: JAVA_PKG_FORCE_VM
87# @variable-external JAVA_PKG_FORCE_VM 75# @DEFAULT_UNSET
88# 76# @DESCRIPTION:
89# Explicitly set a particular VM to use. If its not valid, it'll fall back to 77# Explicitly set a particular VM to use. If its not valid, it'll fall back to
90# whatever /etc/java-config-2/build/jdk.conf would elect to use. 78# whatever /etc/java-config-2/build/jdk.conf would elect to use.
91# 79#
92# Should only be used for testing and debugging. 80# Should only be used for testing and debugging.
93# 81#
94# @example Use sun-jdk-1.5 to emerge foo 82# Example: use sun-jdk-1.5 to emerge foo:
83# @CODE
95# JAVA_PKG_FORCE_VM=sun-jdk-1.5 emerge foo 84# JAVA_PKG_FORCE_VM=sun-jdk-1.5 emerge foo
96# 85# @CODE
97# -----------------------------------------------------------------------------
98 86
99# ----------------------------------------------------------------------------- 87# @ECLASS-VARIABLE: JAVA_PKG_WANT_BUILD_VM
100# @variable-external JAVA_PKG_WANT_SOURCE 88# @DEFAULT_UNSET
89# @DESCRIPTION:
90# A list of VM handles to choose a build VM from. If the list contains the
91# currently active VM use that one, otherwise step through the list till a
92# usable/installed VM is found.
101# 93#
102# Specify a specific VM version to compile for to use for -source. 94# This allows to use an explicit list of JDKs in DEPEND instead of a virtual.
103# Normally this is determined from DEPEND. 95# Users of this variable must make sure at least one of the listed handles is
96# covered by DEPEND.
97# Requires JAVA_PKG_WANT_SOURCE and JAVA_PKG_WANT_TARGET to be set as well.
98
99# @ECLASS-VARIABLE: JAVA_PKG_WANT_SOURCE
100# @DEFAULT_UNSET
101# @DESCRIPTION:
102# Specify a non-standard Java source version for compilation (via javac -source
103# parameter or Ant equivalent via build.xml rewriting done by java-ant-2 eclass).
104# Normally this is determined from the jdk version specified in DEPEND.
104# See java-pkg_get-source function below. 105# See java-pkg_get-source function below.
105# 106#
106# Should only be used for testing and debugging. 107# Should generally only be used for testing and debugging.
107# 108#
108# @seealso java-pkg_get-source
109#
110# @example Use 1.4 source to emerge baz 109# Use 1.4 source to emerge baz
110# @CODE
111# JAVA_PKG_WANT_SOURCE=1.4 emerge baz 111# JAVA_PKG_WANT_SOURCE=1.4 emerge baz
112# ----------------------------------------------------------------------------- 112# @CODE
113 113
114# ----------------------------------------------------------------------------- 114# @ECLASS-VARIABLE: JAVA_PKG_WANT_TARGET
115# @variable-external JAVA_PKG_WANT_TARGET 115# @DEFAULT_UNSET
116# 116# @DESCRIPTION:
117# Same as JAVA_PKG_WANT_SOURCE above but for -target. 117# Same as JAVA_PKG_WANT_SOURCE (see above) but for javac -target parameter,
118# which affects the version of generated bytecode.
119# Normally this is determined from the jre/jdk version specified in RDEPEND.
118# See java-pkg_get-target function below. 120# See java-pkg_get-target function below.
119# 121#
120# Should only be used for testing and debugging. 122# Should generallyonly be used for testing and debugging.
121# 123#
122# @seealso java-pkg_get-target
123#
124# @example emerge bar to be compatible with 1.3 124# emerge bar to be compatible with 1.3
125# @CODE
125# JAVA_PKG_WANT_TARGET=1.3 emerge bar 126# JAVA_PKG_WANT_TARGET=1.3 emerge bar
126# ----------------------------------------------------------------------------- 127# @CODE
127 128
128# ----------------------------------------------------------------------------- 129# @ECLASS-VARIABLE: JAVA_RM_FILES
129# @variable-internal JAVA_PKG_COMPILER_DIR 130# @DEFAULT_UNSET
130# @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.
131# 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:
132# Directory where compiler settings are saved, without trailing slash. 146# Directory where compiler settings are saved, without trailing slash.
133# Probably shouldn't touch this variable. 147# You probably shouldn't touch this variable except local testing.
134# -----------------------------------------------------------------------------
135JAVA_PKG_COMPILER_DIR=${JAVA_PKG_COMPILER_DIR:="/usr/share/java-config-2/compiler"} 148JAVA_PKG_COMPILER_DIR=${JAVA_PKG_COMPILER_DIR:="/usr/share/java-config-2/compiler"}
136 149
137 150# @VARIABLE: JAVA_PKG_COMPILERS_CONF
138# ----------------------------------------------------------------------------- 151# @INTERNAL
139# @variable-internal JAVA_PKG_COMPILERS_CONF 152# @DESCRIPTION:
140# @variable-default /etc/java-config-2/build/compilers.conf
141#
142# Path to file containing information about which compiler to use. 153# Path to file containing information about which compiler to use.
143# Can be overloaded, but it should be overloaded for testing. 154# Can be overloaded, but it should be overloaded only for local testing.
144# -----------------------------------------------------------------------------
145JAVA_PKG_COMPILERS_CONF=${JAVA_PKG_COMPILERS_CONF:="/etc/java-config-2/build/compilers.conf"} 155JAVA_PKG_COMPILERS_CONF=${JAVA_PKG_COMPILERS_CONF:="/etc/java-config-2/build/compilers.conf"}
146 156
147# ----------------------------------------------------------------------------- 157# @ECLASS-VARIABLE: JAVA_PKG_FORCE_COMPILER
148# @variable-external JAVA_PKG_FORCE_COMPILER 158# @INTERNAL
149# 159# @DEFAULT_UNSET
160# @DESCRIPTION:
150# 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
151# JAVA_PKG_COMPILERS_CONF. 162# JAVA_PKG_COMPILERS_CONF.
152# 163#
153# @note This should only be used internally or for testing. 164# Useful for local testing.
165#
154# @example Use jikes and javac, in that order 166# Use jikes and javac, in that order
167# @CODE
155# JAVA_PKG_FORCE_COMPILER="jikes javac" 168# JAVA_PKG_FORCE_COMPILER="jikes javac"
156# ----------------------------------------------------------------------------- 169# @CODE
157 170
158# ----------------------------------------------------------------------------- 171# @ECLASS-VARIABLE: JAVA_PKG_FORCE_ANT_TASKS
159# @variable-external JAVA_PKG_FORCE_ANT_TASKS 172# @DEFAULT_UNSET
160# 173# @DESCRIPTION:
161# An $IFS separated list of ant tasks. Can be set in environment before calling 174# An $IFS separated list of ant tasks. Can be set in environment before calling
162# emerge/ebuild to override variables set in ebuild, mainly for testing before 175# emerge/ebuild to override variables set in ebuild, mainly for testing before
163# putting the resulting (WANT_)ANT_TASKS into ebuild. Affects only ANT_TASKS in 176# putting the resulting (WANT_)ANT_TASKS into ebuild. Affects only ANT_TASKS in
164# eant() call, not the dependencies specified in WANT_ANT_TASKS. 177# eant() call, not the dependencies specified in WANT_ANT_TASKS.
165# 178#
179# @CODE
166# @example JAVA_PKG_FORCE_ANT_TASKS="ant-junit ant-trax" \ 180# JAVA_PKG_FORCE_ANT_TASKS="ant-junit ant-trax" \
167# ebuild foo.ebuild compile 181# ebuild foo.ebuild compile
168# 182# @CODE
169# @seealso WANT_ANT_TASKS
170# -----------------------------------------------------------------------------
171 183
172# TODO document me 184# TODO document me
173JAVA_PKG_QA_VIOLATIONS=0 185JAVA_PKG_QA_VIOLATIONS=0
174 186
175# ----------------------------------------------------------------------------- 187# @FUNCTION: java-pkg_doexamples
176# @section-end variables 188# @USAGE: [--subdir <subdir>] <file1/dir1> [<file2> ...]
177# ----------------------------------------------------------------------------- 189# @DESCRIPTION:
178 190# Installs given arguments to /usr/share/doc/${PF}/examples
179 191# If you give it only one parameter and it is a directory it will install
180# ----------------------------------------------------------------------------- 192# everything in that directory to the examples directory.
181# @section-begin install
182# @section-summary Install functions
183# 193#
184# These are used to install Java-related things, such as jars, Javadocs, JNI 194# @CODE
185# libraries, etc. 195# Parameters:
186# ----------------------------------------------------------------------------- 196# --subdir - If the examples need a certain directory structure
187 197# $* - list of files to install
188
189# -----------------------------------------------------------------------------
190# @ebuild-function java-pkg_dojar
191# 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:
192# Installs any number of jars. 304# Installs any number of jars.
193# 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.
194# You can use java-pkg_jarinto to change this path. 306# You can use java-pkg_jarinto to change this path.
195# 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.
196# Instead, use java-pkg_newjar defined below. 308# Instead, use java-pkg_newjar defined below.
197# 309#
198# @example 310# @CODE
199# java-pkg_dojar dist/${PN}.jar dist/${PN}-core.jar 311# java-pkg_dojar dist/${PN}.jar dist/${PN}-core.jar
312# @CODE
200# 313#
201# @param $* - list of jars to install 314# @param $* - list of jars to install
202# ------------------------------------------------------------------------------
203java-pkg_dojar() { 315java-pkg_dojar() {
204 debug-print-function ${FUNCNAME} $* 316 debug-print-function ${FUNCNAME} $*
205 317
206 [[ ${#} -lt 1 ]] && die "At least one argument needed" 318 [[ ${#} -lt 1 ]] && die "At least one argument needed"
207 319
249 done 361 done
250 362
251 java-pkg_do_write_ 363 java-pkg_do_write_
252} 364}
253 365
254 366# @FUNCTION: java-pkg_regjar
255# ------------------------------------------------------------------------------ 367# @USAGE: </path/to/installed/jar>
256# @internal-function depend-java-query 368# @DESCRIPTION:
257#
258# Wrapper for the depend-java-query binary to enable passing USE in env.
259# Using env variables keeps this eclass working with java-config versions that
260# do not handle use flags.
261# ------------------------------------------------------------------------------
262
263depend-java-query() {
264 # Used to have a which call here but it caused endless loops for some people
265 # that had some weird bashrc voodoo for which.
266 USE="${USE}" /usr/bin/depend-java-query "${@}"
267}
268
269# ------------------------------------------------------------------------------
270# @ebuild-function java-pkg_regjar
271#
272# Records an already installed jar in the package.env 369# Records an already installed (in ${D}) jar in the package.env
273# 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
274# install things. 371# install things.
275# 372#
276# Example:
277# java-pkg_regjar ${D}/opt/foo/lib/foo.jar
278#
279# WARNING: 373# WARNING:
280# 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
281# 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:
282# 376#
283# java-pkg_regjar /opt/my-java/lib/*.jar 377# @CODE
284#
285# will not work, because:
286# * the `for jar in "$@"` can't expand the path to jar file names, as they
287# don't exist yet
288# * all `if ...` inside for will fail - the file '/opt/my-java/lib/*.jar'
289# doesn't exist
290#
291# you have to use it as:
292#
293# java-pkg_regjar ${D}/opt/my-java/lib/*.jar 378# java-pkg_regjar ${D}/opt/my-java/lib/*.jar
379# @CODE
294# 380#
295# @param $@ - jars to record 381
296# ------------------------------------------------------------------------------
297# 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?
298java-pkg_regjar() { 383java-pkg_regjar() {
299 debug-print-function ${FUNCNAME} $* 384 debug-print-function ${FUNCNAME} $*
300 385
301 java-pkg_check-phase install 386 java-pkg_check-phase install
319 # java-pkg_regjar ${D}/opt/java/*.jar 404 # java-pkg_regjar ${D}/opt/java/*.jar
320 # such call will fall into this case (-e ${jar}) and will 405 # such call will fall into this case (-e ${jar}) and will
321 # record paths with ${D} in package.env 406 # record paths with ${D} in package.env
322 java-pkg_append_ JAVA_PKG_CLASSPATH "${jar#${D}}" 407 java-pkg_append_ JAVA_PKG_CLASSPATH "${jar#${D}}"
323 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"
324 die "${jar} does not exist" 415 die "${jar} does not exist"
325 fi 416 fi
326 done 417 done
327 418
328 java-pkg_do_write_ 419 java-pkg_do_write_
329} 420}
330 421
331# ------------------------------------------------------------------------------ 422# @FUNCTION: java-pkg_newjar
332# @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)
333# 426#
334# Installs a jar with a new name
335#
336# @example: install a versioned jar without the version 427# For example, installs a versioned jar without the version
337# java-pkg_newjar dist/${P}.jar ${PN}.jar
338#
339# @param $1 - jar to install
340# @param $2 - new name for jar - defaults to ${PN}.jar if not specified
341# ------------------------------------------------------------------------------
342java-pkg_newjar() { 428java-pkg_newjar() {
343 debug-print-function ${FUNCNAME} $* 429 debug-print-function ${FUNCNAME} $*
344 430
345 local original_jar="${1}" 431 local original_jar="${1}"
346 local new_jar="${2:-${PN}.jar}" 432 local new_jar="${2:-${PN}.jar}"
354 cp "${original_jar}" "${new_jar_dest}" \ 440 cp "${original_jar}" "${new_jar_dest}" \
355 || die "Failed to copy ${original_jar} to ${new_jar_dest}" 441 || die "Failed to copy ${original_jar} to ${new_jar_dest}"
356 java-pkg_dojar "${new_jar_dest}" 442 java-pkg_dojar "${new_jar_dest}"
357} 443}
358 444
359# ------------------------------------------------------------------------------ 445# @FUNCTION: java-pkg_addcp
360# @ebuild-function java-pkg_addcp 446# @USAGE: <classpath>
361# 447# @DESCRIPTION:
362# 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,
363# 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.
364# 450# The parameters of this function are appended to JAVA_PKG_CLASSPATH
365# TODO add example
366# @param $@ - value to append to JAVA_PKG_CLASSPATH
367# ------------------------------------------------------------------------------
368java-pkg_addcp() { 451java-pkg_addcp() {
369 java-pkg_append_ JAVA_PKG_CLASSPATH "${@}" 452 java-pkg_append_ JAVA_PKG_CLASSPATH "${@}"
370 java-pkg_do_write_ 453 java-pkg_do_write_
371} 454}
372 455
373# ------------------------------------------------------------------------------ 456# @FUNCTION: java-pkg_doso
374# @ebuild-function java-pkg_doso 457# @USAGE: <path/to/file1.so> [...]
375# 458# @DESCRIPTION:
376# Installs any number of JNI libraries 459# Installs any number of JNI libraries
377# 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
378# can be used change this path 461# can be used change this path
379# 462#
463# @CODE
380# Example: 464# Example:
381# java-pkg_doso *.so 465# java-pkg_doso *.so
382# 466# @CODE
383# @param $@ - JNI libraries to install
384# ------------------------------------------------------------------------------
385java-pkg_doso() { 467java-pkg_doso() {
386 debug-print-function ${FUNCNAME} $* 468 debug-print-function ${FUNCNAME} $*
387 469
388 [[ ${#} -lt 1 ]] && "At least one argument required for ${FUNCNAME}"
389 java-pkg_check-phase install 470 java-pkg_check-phase install
390 471
391 [[ ${#} -lt 1 ]] && die "At least one argument required for ${FUNCNAME}" 472 [[ ${#} -lt 1 ]] && die "${FUNCNAME} requires at least one argument"
392 473
393 java-pkg_init_paths_ 474 java-pkg_init_paths_
394 475
395 local lib 476 local lib
396 # for each lib 477 # for each lib
398 # if the lib exists... 479 # if the lib exists...
399 if [[ -e "${lib}" ]] ; then 480 if [[ -e "${lib}" ]] ; then
400 # install if it isn't a symlink 481 # install if it isn't a symlink
401 if [[ ! -L "${lib}" ]] ; then 482 if [[ ! -L "${lib}" ]] ; then
402 INSDESTTREE="${JAVA_PKG_LIBDEST}" \ 483 INSDESTTREE="${JAVA_PKG_LIBDEST}" \
403 INSOPTIONS="${LIBOPTIONS}" \ 484 INSOPTIONS="-m0755" \
404 doins "${lib}" || "failed to install ${lib}" 485 doins "${lib}" || die "failed to install ${lib}"
405 java-pkg_append_ JAVA_PKG_LIBRARY "${JAVA_PKG_LIBDEST}" 486 java-pkg_append_ JAVA_PKG_LIBRARY "${JAVA_PKG_LIBDEST}"
406 debug-print "Installing ${lib} to ${JAVA_PKG_LIBDEST}" 487 debug-print "Installing ${lib} to ${JAVA_PKG_LIBDEST}"
407 # otherwise make a symlink to the symlink's origin 488 # otherwise make a symlink to the symlink's origin
408 else 489 else
409 # TODO use dosym 490 dosym "$(readlink "${lib}")" "${JAVA_PKG_LIBDEST}/${lib##*/}"
410 ln -s "$(readlink "${lib}")" \
411 "${D}${JAVA_PKG_LIBDEST}/$(basename "${lib}")"
412 debug-print "${lib} is a symlink, linking accordanly" 491 debug-print "${lib} is a symlink, linking accordantly"
413 fi 492 fi
414 # otherwise die 493 # otherwise die
415 else 494 else
416 die "${lib} does not exist" 495 die "${lib} does not exist"
417 fi 496 fi
418 done 497 done
419 498
420 java-pkg_do_write_ 499 java-pkg_do_write_
421} 500}
422 501
423# ------------------------------------------------------------------------------ 502# @FUNCTION: java-pkg_regso
424# @ebuild-function java-pkg_regso 503# @USAGE: <file1.so> [...]
425# 504# @DESCRIPTION:
426# 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
427# 510#
428# Example: 511# Example:
429# java-pkg_regso *.so /path/*.so 512# java-pkg_regso *.so /path/*.so
430# 513# @CODE
431# @param $@ - JNI libraries to register
432# ------------------------------------------------------------------------------
433java-pkg_regso() { 514java-pkg_regso() {
434 debug-print-function ${FUNCNAME} $* 515 debug-print-function ${FUNCNAME} $*
435 516
436 java-pkg_check-phase install 517 java-pkg_check-phase install
437 518
438 [[ ${#} -lt 1 ]] && "at least one argument needed" 519 [[ ${#} -lt 1 ]] && die "${FUNCNAME} requires at least one argument"
439 520
440 java-pkg_init_paths_ 521 java-pkg_init_paths_
441 522
442 local lib target_dir 523 local lib target_dir
443 for lib in "$@" ; do 524 for lib in "$@" ; do
455 done 536 done
456 537
457 java-pkg_do_write_ 538 java-pkg_do_write_
458} 539}
459 540
460# ------------------------------------------------------------------------------ 541# @FUNCTION: java-pkg_jarinto
461# @ebuild-function java-pkg_jarinto 542# @USAGE: </path/to/install/jars/into>
462# 543# @DESCRIPTION:
463# Changes the path jars are installed into 544# Changes the path jars are installed into via subsequent java-pkg_dojar calls.
464#
465# @param $1 - new location to install jars into.
466# -----------------------------------------------------------------------------
467java-pkg_jarinto() { 545java-pkg_jarinto() {
468 debug-print-function ${FUNCNAME} $* 546 debug-print-function ${FUNCNAME} $*
469 547
470 JAVA_PKG_JARDEST="${1}" 548 JAVA_PKG_JARDEST="${1}"
471} 549}
472 550
473# ------------------------------------------------------------------------------ 551# @FUNCTION: java-pkg_sointo
474# @ebuild-function java-pkg_sointo 552# @USAGE: </path/to/install/sofiles/into>
475# 553# @DESCRIPTION:
476# Changes the path that JNI libraries are installed into. 554# Changes the path that JNI libraries are installed into via subsequent
477# 555# java-pkg_doso calls.
478# @param $1 - new location to install JNI libraries into.
479# ------------------------------------------------------------------------------
480java-pkg_sointo() { 556java-pkg_sointo() {
481 debug-print-function ${FUNCNAME} $* 557 debug-print-function ${FUNCNAME} $*
482 558
483 JAVA_PKG_LIBDEST="${1}" 559 JAVA_PKG_LIBDEST="${1}"
484} 560}
485 561
486# ------------------------------------------------------------------------------ 562# @FUNCTION: java-pkg_dohtml
487# @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.
488# 566#
489# Install Javadoc HTML documentation 567# @CODE
490#
491# @example
492# java-pkg_dohtml dist/docs/ 568# java-pkg_dohtml dist/docs/
493# 569# @CODE
494# ------------------------------------------------------------------------------
495java-pkg_dohtml() { 570java-pkg_dohtml() {
496 debug-print-function ${FUNCNAME} $* 571 debug-print-function ${FUNCNAME} $*
497 572
498 [[ ${#} -lt 1 ]] && die "At least one argument required for ${FUNCNAME}" 573 [[ ${#} -lt 1 ]] && die "At least one argument required for ${FUNCNAME}"
499 574
505 # a reasonable way to catch # docs for all of the 580 # a reasonable way to catch # docs for all of the
506 # old ebuilds. 581 # old ebuilds.
507 java-pkg_recordjavadoc 582 java-pkg_recordjavadoc
508} 583}
509 584
510# ------------------------------------------------------------------------------ 585# @FUNCTION: java-pkg_dojavadoc
511# @ebuild-function java-pkg_dojavadoc 586# @USAGE: [--symlink destination] <path/to/javadocs/root>
512# 587# @DESCRIPTION:
513# 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.
514# 589#
590# @CODE
591# Parameters:
592# $1: optional --symlink creates to symlink like this for html
593# documentation bundles.
515# @param $1: - The javadoc root directory. 594# $2: - The javadoc root directory.
516# 595#
517# @example: 596# Examples:
518# java-pkg_dojavadoc docs/api 597# java-pkg_dojavadoc docs/api
519# 598# java-pkg_dojavadoc --symlink apidocs docs/api
520# ------------------------------------------------------------------------------ 599# @CODE
521java-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
522 local dir="$1" 610 local dir="$1"
611 local dest=/usr/share/doc/${PF}/html
612
613 # QA checks
523 614
524 java-pkg_check-phase install 615 java-pkg_check-phase install
616 java-pkg_init_paths_
525 617
526 [[ -z "${dir}" ]] && die "Must specify a directory!" 618 [[ -z "${dir}" ]] && die "Must specify a directory!"
527 [[ ! -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
528 632
529 local dir_to_install="${dir}" 633 local dir_to_install="${dir}"
530 if [[ "$(basename "${dir}")" != "api" ]]; then 634 if [[ "$(basename "${dir}")" != "api" ]]; then
531 dir_to_install="${T}/api" 635 dir_to_install="${T}/api"
532 # TODO use doins 636 # TODO use doins
533 cp -r "${dir}" "${dir_to_install}" || die "cp failed" 637 cp -r "${dir}" "${dir_to_install}" || die "cp failed"
534 fi 638 fi
535 639
640 # Actual installation
641
536 java-pkg_dohtml -r ${dir_to_install} 642 java-pkg_dohtml -r "${dir_to_install}"
537}
538 643
539# ------------------------------------------------------------------------------ 644 # Let's make a symlink to the directory we have everything else under
540# @ebuild-function java-pkg_dosrc 645 dosym ${dest}/api "${JAVA_PKG_SHAREPATH}/api" || die
541# 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:
542# 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
543# 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.
544# 659#
545# Ebuild needs to DEPEND on app-arch/zip to use this. 660# @CODE
546#
547# It also should be controlled by USE=source.
548#
549# @example: 661# Example:
550# java-pkg_dosrc src/* 662# java-pkg_dosrc src/*
551# 663# @CODE
552# ------------------------------------------------------------------------------ 664
553# 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
554# source -nichoj 666# source -nichoj
667#
555# 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#
556# TODO maybe we can take an existing zip/jar? -nichoj 670# TODO maybe we can take an existing zip/jar? -nichoj
671#
557# FIXME apparently this fails if you give it an empty directories 672# FIXME apparently this fails if you give it an empty directories
558java-pkg_dosrc() { 673java-pkg_dosrc() {
559 debug-print-function ${FUNCNAME} $* 674 debug-print-function ${FUNCNAME} $*
560 675
561 [ ${#} -lt 1 ] && die "At least one argument needed" 676 [ ${#} -lt 1 ] && die "At least one argument needed"
562 if ! hasq source ${IUSE}; then
563 echo "Java QA Notice: ${FUNCNAME} called without source in IUSE"
564 fi
565 677
566 java-pkg_check-phase install 678 java-pkg_check-phase install
567 679
568 [[ ${#} -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
569 686
570 java-pkg_init_paths_ 687 java-pkg_init_paths_
571 688
572 local zip_name="${PN}-src.zip" 689 local zip_name="${PN}-src.zip"
573 local zip_path="${T}/${zip_name}" 690 local zip_path="${T}/${zip_name}"
591 708
592 JAVA_SOURCES="${JAVA_PKG_SOURCESPATH}/${zip_name}" 709 JAVA_SOURCES="${JAVA_PKG_SOURCESPATH}/${zip_name}"
593 java-pkg_do_write_ 710 java-pkg_do_write_
594} 711}
595 712
596# ------------------------------------------------------------------------------ 713# @FUNCTION: java-pkg_dolauncher
597# @ebuild-function java-pkg_dolauncher 714# @USAGE: <filename> [options]
598# 715# @DESCRIPTION:
599# Make a wrapper script to lauch/start this package 716# Make a wrapper script to lauch/start this package
600# If necessary, the wrapper will switch to the appropriate VM. 717# If necessary, the wrapper will switch to the appropriate VM.
601# 718#
602# 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
603# 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}.
604# 721#
722# @CODE
723# Parameters:
605# @param $1 - filename of launcher to create 724# $1 - filename of launcher to create
606# @param $2 - options, as follows: 725# $2 - options, as follows:
607# --main the.main.class.too.start 726# --main the.main.class.to.start
608# --jar /the/jar/too/launch.jar or just <name>.jar 727# --jar /the/jar/too/launch.jar or just <name>.jar
609# --java_args 'Extra arguments to pass to java' 728# --java_args 'Extra arguments to pass to java'
610# --pkg_args 'Extra arguments to pass to the package' 729# --pkg_args 'Extra arguments to pass to the package'
611# --pwd Directory the launcher changes to before executing java 730# --pwd Directory the launcher changes to before executing java
612# -into Directory to install the launcher to, instead of /usr/bin 731# -into Directory to install the launcher to, instead of /usr/bin
613# -pre Prepend contents of this file to the launcher 732# -pre Prepend contents of this file to the launcher
614# ------------------------------------------------------------------------------ 733# @CODE
615java-pkg_dolauncher() { 734java-pkg_dolauncher() {
616 debug-print-function ${FUNCNAME} $* 735 debug-print-function ${FUNCNAME} $*
617 736
618 java-pkg_check-phase install 737 java-pkg_check-phase install
619 java-pkg_init_paths_ 738 java-pkg_init_paths_
680 else 799 else
681 dobin "${target}" 800 dobin "${target}"
682 fi 801 fi
683} 802}
684 803
685# ------------------------------------------------------------------------------ 804# @FUNCTION: java-pkg_dowar
805# @DESCRIPTION:
686# Install war files. 806# Install war files.
687# TODO document 807# TODO document
688# ------------------------------------------------------------------------------
689java-pkg_dowar() { 808java-pkg_dowar() {
690 debug-print-function ${FUNCNAME} $* 809 debug-print-function ${FUNCNAME} $*
691 810
692 # Check for arguments 811 # Check for arguments
693 [[ ${#} -lt 1 ]] && die "At least one argument needed" 812 [[ ${#} -lt 1 ]] && die "At least one argument needed"
717 INSDESTTREE=${JAVA_PKG_WARDEST} \ 836 INSDESTTREE=${JAVA_PKG_WARDEST} \
718 doins ${warpath} 837 doins ${warpath}
719 done 838 done
720} 839}
721 840
722# ------------------------------------------------------------------------------ 841# @FUNCTION: java-pkg_recordjavadoc
723# @internal-function java-pkg_recordjavadoc 842# @INTERNAL
843# @DESCRIPTION:
724# 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
725# 845
726# TODO make sure this in the proper section 846# TODO make sure this in the proper section
727# ------------------------------------------------------------------------------
728java-pkg_recordjavadoc() 847java-pkg_recordjavadoc()
729{ 848{
730 debug-print-function ${FUNCNAME} $* 849 debug-print-function ${FUNCNAME} $*
731 # the find statement is important 850 # the find statement is important
732 # as some packages include multiple trees of javadoc 851 # as some packages include multiple trees of javadoc
739 else 858 else
740 debug-print "No javadocs found" 859 debug-print "No javadocs found"
741 fi 860 fi
742} 861}
743 862
744# ------------------------------------------------------------------------------
745# @section-end install
746# ------------------------------------------------------------------------------
747 863
748# ------------------------------------------------------------------------------ 864# @FUNCTION: java-pkg_jar-from
749# @begin-section query 865# @USAGE: [--build-only] [--with-dependencies] [--virtual] [--into dir] <package> [<package.jar>] [<destination.jar>]
750# Use these to build the classpath for building a package. 866# @DESCRIPTION:
751# ------------------------------------------------------------------------------
752
753# ------------------------------------------------------------------------------
754# @ebuild-function java-pkg_jar-from
755#
756# Makes a symlink to a jar from a certain package 867# Makes a symlink to a jar from a certain package
757# A lot of java packages include dependencies in a lib/ directory 868# A lot of java packages include dependencies in a lib/ directory
758# You can use this function to replace these bundled dependencies. 869# You can use this function to replace these bundled dependencies.
759# 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"
760# 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
761# 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).
762# 873#
874# @CODE
763# Example: get all jars from xerces slot 2 875# Example: get all jars from xerces slot 2
764# java-pkg_jar-from xerces-2 876# java-pkg_jar-from xerces-2
877#
765# Example: get a specific jar from xerces slot 2 878# Example: get a specific jar from xerces slot 2
766# java-pkg_jar-from xerces-2 xml-apis.jar 879# java-pkg_jar-from xerces-2 xml-apis.jar
880#
767# 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
768# java-pkg_jar-from xerces-2 xml-apis.jar xml.jar 882# java-pkg_jar-from xerces-2 xml-apis.jar xml.jar
883#
769# Example: get junit.jar which is needed only for building 884# Example: get junit.jar which is needed only for building
770# java-pkg_jar-from --build-only junit junit.jar 885# java-pkg_jar-from --build-only junit junit.jar
886# @CODE
771# 887#
772# @param $opt 888# @CODE
889# Parameters
773# --build-only - makes the jar(s) not added into package.env DEPEND line. 890# --build-only - makes the jar(s) not added into package.env DEPEND line.
774# (assumed automatically when called inside src_test) 891# (assumed automatically when called inside src_test)
775# --with-dependencies - get jars also from requested package's dependencies 892# --with-dependencies - get jars also from requested package's dependencies
776# transitively. 893# transitively.
894# --virtual - Packages passed to this function are to be handled as virtuals
895# and will not have individual jar dependencies recorded.
777# --into $dir - symlink jar(s) into $dir (must exist) instead of . 896# --into $dir - symlink jar(s) into $dir (must exist) instead of .
778# @param $1 - Package to get jars from. 897# $1 - Package to get jars from, or comma-separated list of packages in
898# case other parameters are not used.
779# @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.
780# @param $3 - When a single jar is specified, destination filename of the 900# $3 - When a single jar is specified, destination filename of the
781# symlink. Defaults to the name of the jar. 901# symlink. Defaults to the name of the jar.
782# ------------------------------------------------------------------------------ 902# @CODE
903
783# TODO could probably be cleaned up a little 904# TODO could probably be cleaned up a little
784java-pkg_jar-from() { 905java-pkg_jar-from() {
785 debug-print-function ${FUNCNAME} $* 906 debug-print-function ${FUNCNAME} $*
786 907
787 local build_only="" 908 local build_only=""
788 local destdir="." 909 local destdir="."
789 local deep="" 910 local deep=""
911 local virtual=""
912 local record_jar=""
790 913
791 [[ "${EBUILD_PHASE}" == "test" ]] && build_only="true" 914 [[ "${EBUILD_PHASE}" == "test" ]] && build_only="build"
792 915
793 while [[ "${1}" == --* ]]; do 916 while [[ "${1}" == --* ]]; do
794 if [[ "${1}" = "--build-only" ]]; then 917 if [[ "${1}" = "--build-only" ]]; then
795 build_only="true" 918 build_only="build"
796 elif [[ "${1}" = "--with-dependencies" ]]; then 919 elif [[ "${1}" = "--with-dependencies" ]]; then
797 deep="--with-dependencies" 920 deep="--with-dependencies"
921 elif [[ "${1}" = "--virtual" ]]; then
922 virtual="true"
798 elif [[ "${1}" = "--into" ]]; then 923 elif [[ "${1}" = "--into" ]]; then
799 destdir="${2}" 924 destdir="${2}"
800 shift 925 shift
801 else 926 else
802 die "java-pkg_jar-from called with unknown parameter: ${1}" 927 die "java-pkg_jar-from called with unknown parameter: ${1}"
806 931
807 local target_pkg="${1}" target_jar="${2}" destjar="${3}" 932 local target_pkg="${1}" target_jar="${2}" destjar="${3}"
808 933
809 [[ -z ${target_pkg} ]] && die "Must specify a package" 934 [[ -z ${target_pkg} ]] && die "Must specify a package"
810 935
936 if [[ "${EAPI}" == "1" ]]; then
937 target_pkg="${target_pkg//:/-}"
938 fi
939
811 # default destjar to the target jar 940 # default destjar to the target jar
812 [[ -z "${destjar}" ]] && destjar="${target_jar}" 941 [[ -z "${destjar}" ]] && destjar="${target_jar}"
813 942
814 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}."
815 local classpath 944 local classpath
816 classpath="$(java-config ${deep} --classpath=${target_pkg})" 945 classpath="$(java-config ${deep} --classpath=${target_pkg})"
817 [[ $? != 0 ]] && die ${error_msg} 946 [[ $? != 0 ]] && die ${error_msg}
818 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
819 pushd ${destdir} > /dev/null \ 970 pushd ${destdir} > /dev/null \
820 || die "failed to change directory to ${destdir}" 971 || die "failed to change directory to ${destdir}"
821
822 # When we have commas this functions is called to bring jars from multiple
823 # packages. This affects recording of dependencencies because that syntax uses :
824 # if we don't change them to : gjl and java-config -d -p break
825 if [[ ${target_pkg} = *,* ]]; then
826 build_only="true"
827 java-pkg_record-jar_ ${target_pkg//,/:}
828 fi
829 972
830 local jar 973 local jar
831 for jar in ${classpath//:/ }; do 974 for jar in ${classpath//:/ }; do
832 local jar_name=$(basename "${jar}") 975 local jar_name=$(basename "${jar}")
833 if [[ ! -f "${jar}" ]] ; then 976 if [[ ! -f "${jar}" ]] ; then
837 # If no specific target jar was indicated, link it 980 # If no specific target jar was indicated, link it
838 if [[ -z "${target_jar}" ]] ; then 981 if [[ -z "${target_jar}" ]] ; then
839 [[ -f "${target_jar}" ]] && rm "${target_jar}" 982 [[ -f "${target_jar}" ]] && rm "${target_jar}"
840 ln -snf "${jar}" \ 983 ln -snf "${jar}" \
841 || 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
842 [[ -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
843 # otherwise, if the current jar is the target jar, link it 992 # otherwise, if the current jar is the target jar, link it
844 elif [[ "${jar_name}" == "${target_jar}" ]] ; then 993 elif [[ "${jar_name}" == "${target_jar}" ]] ; then
845 [[ -f "${destjar}" ]] && rm "${destjar}" 994 [[ -f "${destjar}" ]] && rm "${destjar}"
846 ln -snf "${jar}" "${destjar}" \ 995 ln -snf "${jar}" "${destjar}" \
847 || 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
848 [[ -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
849 popd > /dev/null 1004 popd > /dev/null
850 return 0 1005 return 0
851 fi 1006 fi
852 done 1007 done
853 popd > /dev/null 1008 popd > /dev/null
858 else 1013 else
859 die "Failed to find ${target_jar:-jar} in ${target_pkg}" 1014 die "Failed to find ${target_jar:-jar} in ${target_pkg}"
860 fi 1015 fi
861} 1016}
862 1017
863# ------------------------------------------------------------------------------ 1018# @FUNCTION: java-pkg_jarfrom
864# @ebuild-function java-pkg_jarfrom 1019# @DESCRIPTION:
865#
866# See java-pkg_jar-from 1020# See java-pkg_jar-from
867# ------------------------------------------------------------------------------
868java-pkg_jarfrom() { 1021java-pkg_jarfrom() {
869 java-pkg_jar-from "$@" 1022 java-pkg_jar-from "$@"
870} 1023}
871 1024
872# ------------------------------------------------------------------------------ 1025# @FUNCTION: java-pkg_getjars
873# @ebuild-function java-pkg_getjars 1026# @USAGE: [--build-only] [--with-dependencies] <package1>[,<package2>...]
874# 1027# @DESCRIPTION:
875# Get the classpath provided by any number of packages 1028# Get the classpath provided by any number of packages
876# 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'.
877# The providing packages are recorded as dependencies into package.env DEPEND 1030# The providing packages are recorded as dependencies into package.env DEPEND
878# 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
879# 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
880# (junit testing etc). 1033# (junit testing etc).
881# 1034#
1035# @CODE
882# Example: Get the classpath for xerces-2 and xalan, 1036# Example: Get the classpath for xerces-2 and xalan,
883# java-pkg_getjars xerces-2,xalan 1037# java-pkg_getjars xerces-2,xalan
1038#
884# Example Return: 1039# Example Return:
885# /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
886# 1041#
887# @param $opt 1042#
1043# Parameters:
888# --build-only - makes the jar(s) not added into package.env DEPEND line. 1044# --build-only - makes the jar(s) not added into package.env DEPEND line.
889# (assumed automatically when called inside src_test) 1045# (assumed automatically when called inside src_test)
890# --with-dependencies - get jars also from requested package's dependencies 1046# --with-dependencies - get jars also from requested package's dependencies
891# transitively. 1047# transitively.
892# @param $1 - list of packages to get jars from 1048# $1 - list of packages to get jars from
893# (passed to java-config --classpath) 1049# (passed to java-config --classpath)
894# ------------------------------------------------------------------------------ 1050# @CODE
895java-pkg_getjars() { 1051java-pkg_getjars() {
896 debug-print-function ${FUNCNAME} $* 1052 debug-print-function ${FUNCNAME} $*
897 1053
898 local build_only="" 1054 local build_only=""
899 local deep="" 1055 local deep=""
900 1056
901 [[ "${EBUILD_PHASE}" == "test" ]] && build_only="true" 1057 [[ "${EBUILD_PHASE}" == "test" ]] && build_only="build"
902 1058
903 while [[ "${1}" == --* ]]; do 1059 while [[ "${1}" == --* ]]; do
904 if [[ "${1}" = "--build-only" ]]; then 1060 if [[ "${1}" = "--build-only" ]]; then
905 build_only="true" 1061 build_only="build"
906 elif [[ "${1}" = "--with-dependencies" ]]; then 1062 elif [[ "${1}" = "--with-dependencies" ]]; then
907 deep="--with-dependencies" 1063 deep="--with-dependencies"
908 else 1064 else
909 die "java-pkg_jar-from called with unknown parameter: ${1}" 1065 die "java-pkg_jar-from called with unknown parameter: ${1}"
910 fi 1066 fi
911 shift 1067 shift
912 done 1068 done
913 1069
914 [[ ${#} -ne 1 ]] && die "${FUNCNAME} takes only one argument besides --*" 1070 [[ ${#} -ne 1 ]] && die "${FUNCNAME} takes only one argument besides --*"
915 1071
1072
916 local classpath pkgs="${1}" 1073 local pkgs="${1}"
1074
1075 if [[ "${EAPI}" == "1" ]]; then
1076 pkgs="${pkgs//:/-}"
1077 fi
1078
917 jars="$(java-config ${deep} --classpath=${pkgs})" 1079 jars="$(java-config ${deep} --classpath=${pkgs})"
918 [[ -z "${jars}" ]] && die "java-config --classpath=${pkgs} failed" 1080 [[ $? != 0 ]] && die "java-config --classpath=${pkgs} failed"
919 debug-print "${pkgs}:${jars}" 1081 debug-print "${pkgs}:${jars}"
920 1082
921 if [[ -z "${classpath}" ]]; then 1083 for pkg in ${pkgs//,/ }; do
922 classpath="${jars}" 1084 java-pkg_ensure-dep "${build_only}" "${pkg}"
923 else 1085 done
924 classpath="${classpath}:${jars}"
925 fi
926 1086
927 # Only record jars that aren't build-only 1087 for pkg in ${pkgs//,/ }; do
928 if [[ -z "${build_only}" ]]; then 1088 if [[ -z "${build_only}" ]]; then
929 oldifs="${IFS}"
930 IFS=","
931 for pkg in ${pkgs}; do
932 java-pkg_record-jar_ "${pkg}" 1089 java-pkg_record-jar_ "${pkg}"
1090 else
1091 java-pkg_record-jar_ --build-only "${pkg}"
1092 fi
933 done 1093 done
934 IFS="${oldifs}"
935 fi
936 1094
937 echo "${classpath}" 1095 echo "${jars}"
938} 1096}
939 1097
940# ------------------------------------------------------------------------------ 1098# @FUNCTION: java-pkg_getjar
941# @ebuild-function java-pkg_getjar 1099# @USAGE: [--build-only] [--virtual] <package> <jarfile>
942# 1100# @DESCRIPTION:
943# Get the filename of a single jar from a package 1101# Get the complete path of a single jar from a package
944# The providing package is recorded as runtime dependency into package.env 1102# The providing package is recorded as runtime dependency into package.env
945# 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
946# 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
947# (junit testing etc). 1105# (junit testing etc).
948# 1106#
1107# @CODE
949# @example 1108# Example:
950# java-pkg_getjar xerces-2 xml-apis.jar 1109# java-pkg_getjar xerces-2 xml-apis.jar
951# @example-return 1110# returns
952# /usr/share/xerces-2/lib/xml-apis.jar 1111# /usr/share/xerces-2/lib/xml-apis.jar
953# 1112#
954# @param $opt 1113# Parameters:
955# --build-only - makes the jar not added into 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.
956# @param $1 - package to use 1117# $1 - package to use
957# @param $2 - jar to get 1118# $2 - jar to get
958# ------------------------------------------------------------------------------ 1119# @CODE
959java-pkg_getjar() { 1120java-pkg_getjar() {
960 debug-print-function ${FUNCNAME} $* 1121 debug-print-function ${FUNCNAME} $*
961 1122
962 local build_only="" 1123 local build_only=""
1124 local virtual=""
1125 local record_jar=""
963 1126
964 [[ "${EBUILD_PHASE}" == "test" ]] && build_only="true" 1127 [[ "${EBUILD_PHASE}" == "test" ]] && build_only="build"
965 1128
966 while [[ "${1}" == --* ]]; do 1129 while [[ "${1}" == --* ]]; do
967 if [[ "${1}" = "--build-only" ]]; then 1130 if [[ "${1}" = "--build-only" ]]; then
968 build_only="true" 1131 build_only="build"
1132 elif [[ "${1}" == "--virtual" ]]; then
1133 virtual="true"
969 else 1134 else
970 die "java-pkg_jar-from called with unknown parameter: ${1}" 1135 die "java-pkg_getjar called with unknown parameter: ${1}"
971 fi 1136 fi
972 shift 1137 shift
973 done 1138 done
974 1139
975 [[ ${#} -ne 2 ]] && die "${FUNCNAME} takes only two arguments besides --*" 1140 [[ ${#} -ne 2 ]] && die "${FUNCNAME} takes only two arguments besides --*"
976 1141
977 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
978 [[ -z ${pkg} ]] && die "Must specify package to get a jar from" 1148 [[ -z ${pkg} ]] && die "Must specify package to get a jar from"
979 [[ -z ${target_jar} ]] && die "Must specify jar to get" 1149 [[ -z ${target_jar} ]] && die "Must specify jar to get"
980 1150
981 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?"
982 local classpath 1152 local classpath
983 classpath=$(java-config --classpath=${pkg}) 1153 classpath=$(java-config --classpath=${pkg})
984 [[ $? != 0 ]] && die ${error_msg} 1154 [[ $? != 0 ]] && die ${error_msg}
985 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
986 for jar in ${classpath//:/ }; do 1169 for jar in ${classpath//:/ }; do
987 if [[ ! -f "${jar}" ]] ; then 1170 if [[ ! -f "${jar}" ]] ; then
988 die "Installation problem with jar ${jar} in ${pkg} - is it installed?" 1171 die "Installation problem with jar ${jar} in ${pkg} - is it installed?"
989 fi 1172 fi
990 1173
991 if [[ "$(basename ${jar})" == "${target_jar}" ]] ; then 1174 if [[ "$(basename ${jar})" == "${target_jar}" ]] ; then
992 # Only record jars that aren't build-only 1175 # Only record jars that aren't build-only
993 [[ -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
994 echo "${jar}" 1183 echo "${jar}"
995 return 0 1184 return 0
996 fi 1185 fi
997 done 1186 done
998 1187
999 die "Could not find ${target_jar} in ${pkg}" 1188 die "Could not find ${target_jar} in ${pkg}"
1000 return 1 1189 return 1
1001} 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
1002 1356
1003# 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
1004# populate jars from the filesystem. 1358# populate jars from the filesystem.
1005# 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
1006# string that was built instead of stdin 1360# string that was built instead of stdin
1034# 1388#
1035# read line 1389# read line
1036# done 1390# done
1037#} 1391#}
1038 1392
1039# ------------------------------------------------------------------------------ 1393# @FUNCTION: java-pkg_find-normal-jars
1040# @section-end query 1394# @USAGE: [<path/to/directory>]
1041# ------------------------------------------------------------------------------ 1395# @DESCRIPTION:
1042
1043# ------------------------------------------------------------------------------
1044# @section-begin helper
1045# @section-summary Helper functions
1046#
1047# Various other functions to use from an ebuild
1048# ------------------------------------------------------------------------------
1049
1050# ------------------------------------------------------------------------------
1051# @ebuild-function java-pkg_need
1052#
1053# Adds virtual dependencies, which can optionally be controlled by a USE flag.
1054# Currently supported virtuals are:
1055# javamail
1056# jdbc-stdext
1057# jaf
1058# jdbc-rowset
1059# jms
1060#
1061# @param $1 - Optionally indicate that the dependencies are controlled by
1062# a use flag by specifying '--use' Requires $2.
1063# @param $2 - USE flag which will enable the dependencies.
1064# @param $@ - virtual packages to add depenedencies for
1065# ------------------------------------------------------------------------------
1066# TODO rewrite to parse a line based declaration file instead -- karltk
1067#java-pkg_need() {
1068# debug-print-function ${FUNCNAME} $*
1069# local useflag
1070# if [[ ${1} == "--use" ]]; then
1071# useflag="${2}"
1072# shift 2
1073# fi
1074#
1075# if [[ -z ${1} ]]; then
1076# die "Must specify at least one virtual package."
1077# fi
1078#
1079# local depstr newdepstr
1080#
1081# for virtual in ${@}; do
1082# if has ${virtual} ${JAVA_PKG_VNEED}; then
1083# debug-print "Already registered virtual ${virtual}"
1084# continue
1085# fi
1086# case ${virtual} in
1087# javamail)
1088# debug-print "java-pkg_need: adding javamail dependencies"
1089# newdepstr="|| ( dev-java/gnu-javamail dev-java/sun-javamail-bin )"
1090# ;;
1091# jdbc-stdext)
1092# debug-print "java-pkg_need: adding jdbc-stdext dependencies"
1093# newdepstr="|| ( >=virtual/jdk-1.4 dev-java/jdbc2-stdext )"
1094# ;;
1095# jaf)
1096# debug-print "java-pkg_need: adding jaf dependencies"
1097# newdepstr="|| ( dev-java/gnu-jaf dev-java/sun-jaf-bin )"
1098# ;;
1099# jdbc-rowset)
1100# debug-print "java-pkg_need: adding jdbc-rowset dependencies"
1101# newdepstr="|| ( >=virtual/jdk-1.5 dev-java/sun-jdbc-rowset )"
1102# ;;
1103# jms)
1104# debug-print "java-pkg_need: adding jms dependencies"
1105# newdepstr="|| ( dev-java/sun-jms dev-java/openjms )"
1106# ;;
1107# *)
1108# die "Invalid virtual: ${virtual}"
1109# esac
1110#
1111# export JAVA_PKG_VNEED="${JAVA_PKG_VNEED} ${virtual}"
1112#
1113# if [[ -n ${useflag} ]]; then
1114# depstr="${depstr} ${useflag}? ( ${newdepstr} )"
1115# else
1116# depstr="${depstr} ${newdepstr}"
1117# fi
1118# done
1119#
1120# [[ -z ${JAVA_PKG_NV_DEPEND} ]] && export JAVA_PKG_NV_DEPEND="${DEPEND}"
1121# [[ -z ${JAVA_PKG_NV_RDEPEND} ]] && export JAVA_PKG_NV_RDEPEND="${RDEPEND}"
1122#
1123# export DEPEND="${DEPEND} ${depstr}"
1124# export RDEPEND="${RDEPEND} ${depstr}"
1125#}
1126
1127# ------------------------------------------------------------------------------
1128# @ebuild-function java-pkg_find-normal-jars
1129#
1130# Find the files with suffix .jar file in the given directory or $WORKDIR 1396# Find the files with suffix .jar file in the given directory (default: $WORKDIR)
1131#
1132# @param $1 - The directory to search for jar files (default: ${WORKDIR})
1133# ------------------------------------------------------------------------------
1134java-pkg_find-normal-jars() { 1397java-pkg_find-normal-jars() {
1135 local dir=$1 1398 local dir=$1
1136 [[ "${dir}" ]] || dir="${WORKDIR}" 1399 [[ "${dir}" ]] || dir="${WORKDIR}"
1137 local found 1400 local found
1138 for jar in $(find "${dir}" -name "*.jar" -type f); do 1401 for jar in $(find "${dir}" -name "*.jar" -type f); do
1141 done 1404 done
1142 [[ "${found}" ]] 1405 [[ "${found}" ]]
1143 return $? 1406 return $?
1144} 1407}
1145 1408
1146# ------------------------------------------------------------------------------ 1409# @FUNCTION: java-pkg_ensure-no-bundled-jars
1147# @ebuild-function java-pkg_ensure-no-bundled-jars 1410# @DESCRIPTION:
1148#
1149# Try to locate bundled jar files in ${WORKDIR} and die if found. 1411# Try to locate bundled jar files in ${WORKDIR} and die if found.
1150# This function should be called after WORKDIR has been populated with symlink 1412# This function should be called after WORKDIR has been populated with symlink
1151# to system jar files or bundled jars removed. 1413# to system jar files or bundled jars removed.
1152# ------------------------------------------------------------------------------
1153java-pkg_ensure-no-bundled-jars() { 1414java-pkg_ensure-no-bundled-jars() {
1154 debug-print-function ${FUNCNAME} $* 1415 debug-print-function ${FUNCNAME} $*
1155 1416
1156 local bundled_jars=$(java-pkg_find-normal-jars) 1417 local bundled_jars=$(java-pkg_find-normal-jars)
1157 if [[ -n ${bundled_jars} ]]; then 1418 if [[ -n ${bundled_jars} ]]; then
1162 done 1423 done
1163 die "Bundled jars found!" 1424 die "Bundled jars found!"
1164 fi 1425 fi
1165} 1426}
1166 1427
1167# ------------------------------------------------------------------------------
1168# @internal-function java-pkg_ensure-vm-version-sufficient 1428# @FUNCTION: java-pkg_ensure-vm-version-sufficient
1169# 1429# @INTERNAL
1430# @DESCRIPTION:
1170# 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.
1171#
1172# ------------------------------------------------------------------------------
1173java-pkg_ensure-vm-version-sufficient() { 1432java-pkg_ensure-vm-version-sufficient() {
1174 debug-print-function ${FUNCNAME} $* 1433 debug-print-function ${FUNCNAME} $*
1175 1434
1176 if ! java-pkg_is-vm-version-sufficient; then 1435 if ! java-pkg_is-vm-version-sufficient; then
1177 debug-print "VM is not suffient" 1436 debug-print "VM is not suffient"
1179 einfo "Please use java-config -S to set the correct one" 1438 einfo "Please use java-config -S to set the correct one"
1180 die "Active Java VM cannot build this package" 1439 die "Active Java VM cannot build this package"
1181 fi 1440 fi
1182} 1441}
1183 1442
1184# ------------------------------------------------------------------------------ 1443# @FUNCTION: java-pkg_is-vm-version-sufficient
1185# @internal-function java-pkg_is-vm-version-sufficient 1444# @INTERNAL
1186# 1445# @DESCRIPTION:
1187# @return zero - VM is sufficient 1446# @RETURN: zero - VM is sufficient; non-zero - VM is not sufficient
1188# @return non-zero - VM is not sufficient
1189# ------------------------------------------------------------------------------
1190java-pkg_is-vm-version-sufficient() { 1447java-pkg_is-vm-version-sufficient() {
1191 debug-print-function ${FUNCNAME} $* 1448 debug-print-function ${FUNCNAME} $*
1192 1449
1193 depend-java-query --is-sufficient "${DEPEND}" > /dev/null 1450 depend-java-query --is-sufficient "${DEPEND}" > /dev/null
1194 return $? 1451 return $?
1195} 1452}
1196 1453
1197# ------------------------------------------------------------------------------ 1454# @FUNCTION: java-pkg_ensure-vm-version-eq
1198# @internal-function java-pkg_ensure-vm-version-eq 1455# @INTERNAL
1199# 1456# @DESCRIPTION:
1200# 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.
1201# 1458#
1202# @param $@ - Desired VM version to ensure 1459# @param $@ - Desired VM version to ensure
1203# ------------------------------------------------------------------------------
1204java-pkg_ensure-vm-version-eq() { 1460java-pkg_ensure-vm-version-eq() {
1205 debug-print-function ${FUNCNAME} $* 1461 debug-print-function ${FUNCNAME} $*
1206 1462
1207 if ! java-pkg_is-vm-version-eq $@ ; then 1463 if ! java-pkg_is-vm-version-eq $@ ; then
1208 debug-print "VM is not suffient" 1464 debug-print "VM is not suffient"
1210 einfo "Please use java-config -S to set the correct one" 1466 einfo "Please use java-config -S to set the correct one"
1211 die "Active Java VM too old" 1467 die "Active Java VM too old"
1212 fi 1468 fi
1213} 1469}
1214 1470
1215# ------------------------------------------------------------------------------ 1471# @FUNCTION: java-pkg_is-vm-version-eq
1216# @internal-function java-pkg_is-vm-version-eq 1472# @USAGE: <version>
1217# 1473# @INTERNAL
1218# @param $@ - VM version to compare current VM to 1474# @RETURN: zero - VM versions are equal; non-zero - VM version are not equal
1219# @return zero - VM versions are equal
1220# @return non-zero - VM version are not equal
1221# ------------------------------------------------------------------------------
1222java-pkg_is-vm-version-eq() { 1475java-pkg_is-vm-version-eq() {
1223 debug-print-function ${FUNCNAME} $* 1476 debug-print-function ${FUNCNAME} $*
1224 1477
1225 local needed_version="$@" 1478 local needed_version="$@"
1226 1479
1243 return 1 1496 return 1
1244 fi 1497 fi
1245 fi 1498 fi
1246} 1499}
1247 1500
1248# ------------------------------------------------------------------------------ 1501# @FUNCTION: java-pkg_ensure-vm-version-ge
1249# @internal-function java-pkg_ensure-vm-version-ge 1502# @INTERNAL
1250# 1503# @DESCRIPTION:
1251# 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
1252# 1505#
1253# @param $@ - VM version to compare current to 1506# @param $@ - VM version to compare current to
1254# ------------------------------------------------------------------------------
1255java-pkg_ensure-vm-version-ge() { 1507java-pkg_ensure-vm-version-ge() {
1256 debug-print-function ${FUNCNAME} $* 1508 debug-print-function ${FUNCNAME} $*
1257 1509
1258 if ! java-pkg_is-vm-version-ge "$@" ; then 1510 if ! java-pkg_is-vm-version-ge "$@" ; then
1259 debug-print "vm is not suffient" 1511 debug-print "vm is not suffient"
1261 einfo "Please use java-config -S to set the correct one" 1513 einfo "Please use java-config -S to set the correct one"
1262 die "Active Java VM too old" 1514 die "Active Java VM too old"
1263 fi 1515 fi
1264} 1516}
1265 1517
1266# ------------------------------------------------------------------------------ 1518# @FUNCTION: java-pkg_is-vm-version-ge
1267# @internal-function java-pkg_is-vm-version-ge 1519# @INTERNAL
1268# 1520# @DESCRIPTION:
1521# @CODE
1522# Parameters:
1269# @param $@ - VM version to compare current VM to 1523# $@ - VM version to compare current VM to
1524# @CODE
1270# @return zero - current VM version is greater than checked version 1525# @RETURN: zero - current VM version is greater than checked version;
1271# @return non-zero - current VM version is not greater than checked version 1526# non-zero - current VM version is not greater than checked version
1272# ------------------------------------------------------------------------------
1273java-pkg_is-vm-version-ge() { 1527java-pkg_is-vm-version-ge() {
1274 debug-print-function ${FUNCNAME} $* 1528 debug-print-function ${FUNCNAME} $*
1275 1529
1276 local needed_version=$@ 1530 local needed_version=$@
1277 local vm_version=$(java-pkg_get-vm-version) 1531 local vm_version=$(java-pkg_get-vm-version)
1296java-pkg_get-current-vm() { 1550java-pkg_get-current-vm() {
1297 echo ${GENTOO_VM} 1551 echo ${GENTOO_VM}
1298} 1552}
1299 1553
1300java-pkg_current-vm-matches() { 1554java-pkg_current-vm-matches() {
1301 hasq $(java-pkg_get-current-vm) ${@} 1555 has $(java-pkg_get-current-vm) ${@}
1302 return $? 1556 return $?
1303} 1557}
1304 1558
1305# ------------------------------------------------------------------------------ 1559# @FUNCTION: java-pkg_get-source
1306# @ebuild-function java-pkg_get-source 1560# @DESCRIPTION:
1307#
1308# Determines what source version should be used, for passing to -source. 1561# Determines what source version should be used, for passing to -source.
1309# 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
1310# 1563#
1311# @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
1312# ------------------------------------------------------------------------------
1313java-pkg_get-source() { 1565java-pkg_get-source() {
1314 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}")}
1315} 1567}
1316 1568
1317# ------------------------------------------------------------------------------ 1569# @FUNCTION: java-pkg_get-target
1318# @ebuild-function java-pkg_get-target 1570# @DESCRIPTION:
1319#
1320# Determines what target version should be used, for passing to -target. 1571# Determines what target version should be used, for passing to -target.
1321# 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
1322# version of your JDK. 1573# version of your JDK.
1323# 1574#
1324# @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
1325# ------------------------------------------------------------------------------
1326java-pkg_get-target() { 1576java-pkg_get-target() {
1327 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}")}
1328} 1578}
1329 1579
1580# @FUNCTION: java-pkg_get-javac
1581# @DESCRIPTION:
1582# Returns the compiler executable
1330java-pkg_get-javac() { 1583java-pkg_get-javac() {
1331 debug-print-function ${FUNCNAME} $* 1584 debug-print-function ${FUNCNAME} $*
1332 1585
1333 1586
1334 local compiler="${GENTOO_COMPILER}" 1587 local compiler="${GENTOO_COMPILER}"
1364 fi 1617 fi
1365 fi 1618 fi
1366 echo ${compiler_executable} 1619 echo ${compiler_executable}
1367} 1620}
1368 1621
1369# ------------------------------------------------------------------------------ 1622# @FUNCTION: java-pkg_javac-args
1370# @ebuild-function java-pkg_javac-args 1623# @DESCRIPTION:
1371#
1372# 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
1373# to know what -source/-target to use. 1625# to know what -source/-target to use.
1374# 1626#
1375# @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
1376# ------------------------------------------------------------------------------
1377java-pkg_javac-args() { 1628java-pkg_javac-args() {
1378 debug-print-function ${FUNCNAME} $* 1629 debug-print-function ${FUNCNAME} $*
1379 1630
1380 local want_source="$(java-pkg_get-source)" 1631 local want_source="$(java-pkg_get-source)"
1381 local want_target="$(java-pkg_get-target)" 1632 local want_target="$(java-pkg_get-target)"
1389 if [[ -z "${want_source}" || -z "${want_target}" ]]; then 1640 if [[ -z "${want_source}" || -z "${want_target}" ]]; then
1390 debug-print "could not find valid -source/-target values for javac" 1641 debug-print "could not find valid -source/-target values for javac"
1391 echo "Could not find valid -source/-target values for javac" 1642 echo "Could not find valid -source/-target values for javac"
1392 return 1 1643 return 1
1393 else 1644 else
1394 if java-pkg_is-vm-version-ge "1.4"; then
1395 echo "${source_str} ${target_str}" 1645 echo "${source_str} ${target_str}"
1396 else
1397 echo "${target_str}"
1398 fi 1646 fi
1399 fi
1400} 1647}
1401 1648
1402# TODO document 1649# @FUNCTION: java-pkg_get-jni-cflags
1650# @DESCRIPTION:
1651# Echos the CFLAGS for JNI compilations
1403java-pkg_get-jni-cflags() { 1652java-pkg_get-jni-cflags() {
1404 local flags="-I${JAVA_HOME}/include" 1653 local flags="-I${JAVA_HOME}/include"
1405 1654
1406 local platform="linux" 1655 local platform="linux"
1407 use elibc_FreeBSD && platform="freebsd" 1656 use elibc_FreeBSD && platform="freebsd"
1411 1660
1412 echo ${flags} 1661 echo ${flags}
1413} 1662}
1414 1663
1415java-pkg_ensure-gcj() { 1664java-pkg_ensure-gcj() {
1416 if ! built_with_use sys-devel/gcc gcj ; then 1665 # was enforcing sys-devel/gcc[gcj]
1417 ewarn 1666 die "${FUNCNAME} was removed. Use use-deps available as of EAPI 2 instead. #261562"
1418 ewarn "You must build gcc with the gcj support to build with gcj"
1419 ewarn
1420 ebeep 5
1421 die "No GCJ support found!"
1422 fi
1423} 1667}
1424 1668
1425java-pkg_ensure-test() { 1669java-pkg_ensure-test() {
1426 if hasq test ${FEATURES} && ! hasq -test ${FEATURES} \ 1670 # was enforcing USE=test if FEATURES=test
1427 && hasq test ${IUSE} && ! use test; 1671 die "${FUNCNAME} was removed. Package mangers handle this already. #278965"
1428 then
1429 eerror "You specified FEATURES=test, but USE=test is needed"
1430 eerror "to pull in the additional dependencies for testing"
1431 die "Need USE=test enabled"
1432 fi
1433} 1672}
1434 1673
1435# ------------------------------------------------------------------------------ 1674# @FUNCTION: java-pkg_register-ant-task
1436# @ebuild-function java-pkg_register-ant-task 1675# @USAGE: [--version x.y] [<name>]
1437# 1676# @DESCRIPTION:
1438# Register this package as ant task, so that ant will load it when no specific 1677# Register this package as ant task, so that ant will load it when no specific
1439# ANT_TASKS are specified. Note that even without this registering, all packages 1678# ANT_TASKS are specified. Note that even without this registering, all packages
1440# specified in ANT_TASKS will be loaded. Mostly used by the actual ant tasks 1679# specified in ANT_TASKS will be loaded. Mostly used by the actual ant tasks
1441# packages, but can be also used by other ebuilds that used to symlink their 1680# packages, but can be also used by other ebuilds that used to symlink their
1442# .jar into /usr/share/ant-core/lib to get autoloaded, for backwards 1681# .jar into /usr/share/ant-core/lib to get autoloaded, for backwards
1443# compatibility. 1682# compatibility.
1444# 1683#
1684# @CODE
1685# Parameters
1445# @param --version x.y Register only for ant version x.y (otherwise for any ant 1686# --version x.y Register only for ant version x.y (otherwise for any ant
1446# version). Used by the ant-* packages to prevent loading of mismatched 1687# version). Used by the ant-* packages to prevent loading of mismatched
1447# ant-core ant tasks after core was updated, before the tasks are updated, 1688# ant-core ant tasks after core was updated, before the tasks are updated,
1448# without a need for blockers. 1689# without a need for blockers.
1449# @param $1 Name to register as. Defaults to JAVA_PKG_NAME ($PN[-$SLOT]) 1690# $1 Name to register as. Defaults to JAVA_PKG_NAME ($PN[-$SLOT])
1450# ------------------------------------------------------------------------------ 1691# @CODE
1451java-pkg_register-ant-task() { 1692java-pkg_register-ant-task() {
1452 local TASKS_DIR="tasks" 1693 local TASKS_DIR="tasks"
1453 1694
1454 # check for --version x.y parameters 1695 # check for --version x.y parameters
1455 while [[ -n "${1}" && -n "${2}" ]]; do 1696 while [[ -n "${1}" && -n "${2}" ]]; do
1467 1708
1468 dodir /usr/share/ant/${TASKS_DIR} 1709 dodir /usr/share/ant/${TASKS_DIR}
1469 touch "${D}/usr/share/ant/${TASKS_DIR}/${TASK_NAME}" 1710 touch "${D}/usr/share/ant/${TASKS_DIR}/${TASK_NAME}"
1470} 1711}
1471 1712
1472# ------------------------------------------------------------------------------ 1713# @FUNCTION: java-pkg_ant-tasks-depend
1473# @internal-function java-pkg_ant-tasks-from-deps 1714# @INTERNAL
1474# 1715# @DESCRIPTION:
1475# Function to determine ANT_TASKS from DEPEND variable for backwards
1476# compatibility with ebuilds that don't set ANT_TASKS before calling eant() or
1477# WANT_ANT_TASKS before inheriting java-pkg-2. If the DEPEND string contains
1478# "dev-java/ant" or "dev-java/ant-tasks", then it returns "all", otherwise
1479# "none". It's not smart enough to cope with USE flag depends but that shouldn't
1480# be a problem, the worst it can do is activace all tasks when not needed.
1481# Note that this is called only with JAVA_PKG_STRICT=1, to find ebuilds with
1482# insufficient dependencies, otherwise all available tasks are used for
1483# backwards compatilbility.
1484#
1485# @return "all" or "none"
1486# ------------------------------------------------------------------------------
1487java-pkg_ant-tasks-from-deps() {
1488 local found_ant found_ant_tasks
1489
1490 for dep in ${DEPEND}
1491 do
1492 local ant="$(awk '/(dev-java\/ant)/ { if (match($1, "(dev-java/ant)((-[0-9])+|$)", m)) print m[1] }' <<< ${dep})"
1493 [[ "${ant}" == "dev-java/ant" ]] && found_ant=true
1494 [[ "${dep}" == *"ant-tasks"* ]] && found_ant_tasks=true
1495 done
1496
1497 if [[ -n "${found_ant}" || -n "${found_ant_tasks}" ]]; then
1498 java-pkg_announce-qa-violation "The ebuild DEPENDS on deprecated ant or ant-tasks"
1499 echo "all"
1500 else
1501 # ebuild doesn't set ANT_TASKS and doesn't depend on ant-tasks or ant
1502 # so we deactivate all tasks that may be installed
1503 echo "none"
1504 fi
1505}
1506
1507# ------------------------------------------------------------------------------
1508# @internal-function java-pkg_ant-tasks-depend
1509#
1510# Translates the WANT_ANT_TASKS variable into valid dependencies. 1716# Translates the WANT_ANT_TASKS variable into valid dependencies.
1511# ------------------------------------------------------------------------------
1512java-pkg_ant-tasks-depend() { 1717java-pkg_ant-tasks-depend() {
1513 debug-print-function ${FUNCNAME} ${WANT_ANT_TASKS} 1718 debug-print-function ${FUNCNAME} ${WANT_ANT_TASKS}
1514 1719
1515 if [[ -n "${WANT_ANT_TASKS}" ]]; then 1720 if [[ -n "${WANT_ANT_TASKS}" ]]; then
1516 local DEP="" 1721 local DEP=""
1517 for i in ${WANT_ANT_TASKS} 1722 for i in ${WANT_ANT_TASKS}
1518 do 1723 do
1519 if [[ ${i} != ant-* ]]; then 1724 if [[ ${i} = ant-* ]]; then
1725 DEP="${DEP}dev-java/${i} "
1726 elif [[ ${i} = */*:* ]]; then
1727 DEP="${DEP}${i} "
1728 else
1520 echo "Invalid atom in WANT_ANT_TASKS: ${i}" 1729 echo "Invalid atom in WANT_ANT_TASKS: ${i}"
1521 return 1 1730 return 1
1522 fi 1731 fi
1523 DEP="${DEP}dev-java/${i} "
1524 done 1732 done
1525 echo ${DEP} 1733 echo ${DEP}
1526 return 0 1734 return 0
1527 else 1735 else
1528 return 0 1736 return 0
1529 fi 1737 fi
1530} 1738}
1531 1739
1532# ------------------------------------------------------------------------------
1533# @section-end helper
1534# ------------------------------------------------------------------------------
1535 1740
1536# ------------------------------------------------------------------------------ 1741# @FUNCTION: ejunit_
1537# @section-begin build 1742# @INTERNAL
1538# @section-summary Build functions 1743# @DESCRIPTION:
1539# 1744# Internal Junit wrapper function. Makes it easier to run the tests and checks for
1540# These are some functions for building a package. In particular, it consists of 1745# dev-java/junit in DEPEND. Launches the tests using junit.textui.TestRunner.
1541# wrappers for javac and ant. 1746# @CODE
1542# ------------------------------------------------------------------------------ 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} $*
1543 1755
1544# ------------------------------------------------------------------------------ 1756 local pkgs
1545# @ebuild-function eant 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.
1546# 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:
1547# 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
1548# compiler. Will also set proper ANT_TASKS from the variable ANT_TASKS, 1872# compiler. Will also set proper ANT_TASKS from the variable ANT_TASKS,
1549# variables: 1873# variables:
1874#
1875# @CODE
1876# Variables:
1550# EANT_GENTOO_CLASSPATH - calls java-pkg_getjars for the value and adds to the 1877# EANT_GENTOO_CLASSPATH - calls java-pkg_getjars for the value and adds to the
1551# gentoo.classpath property. Be sure to call 1878# gentoo.classpath property. Be sure to call java-ant_rewrite-classpath in src_unpack.
1552# 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!
1553# *ANT_TASKS - used to determine ANT_TASKS before calling Ant. 1882# ANT_TASKS - used to determine ANT_TASKS before calling Ant.
1554# ------------------------------------------------------------------------------ 1883# @CODE
1555eant() { 1884eant() {
1556 debug-print-function ${FUNCNAME} $* 1885 debug-print-function ${FUNCNAME} $*
1557 1886
1558 # FIXME get this working 1887 if [[ ${EBUILD_PHASE} = compile ]]; then
1559# if is-java-strict && [[ ! ${DEPEND} =~ "dev-java/ant" ]]; then 1888 java-ant-2_src_configure
1560# java-pkg_announce-qa-violation \
1561# "Using eant, but not depending on dev-java/ant or dev-java/ant-core"
1562# fi 1889 fi
1563 1890
1564 if ! hasq java-ant-2 ${INHERITED} && is-java-strict; then 1891 if ! has java-ant-2 ${INHERITED}; then
1565 local msg="You should inherit java-ant-2 when using eant" 1892 local msg="You should inherit java-ant-2 when using eant"
1566 java-pkg_announce-qa-violation ${msg} 1893 java-pkg_announce-qa-violation "${msg}"
1567 die ${msg}
1568 fi 1894 fi
1569 1895
1570 local antflags="-Dnoget=true -Dmaven.mode.offline=true" 1896 local antflags="-Dnoget=true -Dmaven.mode.offline=true -Dbuild.sysclasspath=ignore"
1571 1897
1572 java-pkg_init-compiler_ 1898 java-pkg_init-compiler_
1573 local compiler="${GENTOO_COMPILER}" 1899 local compiler="${GENTOO_COMPILER}"
1574 1900
1575 local compiler_env="${JAVA_PKG_COMPILER_DIR}/${compiler}" 1901 local compiler_env="${JAVA_PKG_COMPILER_DIR}/${compiler}"
1576
1577 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})"
1578 if [[ "${compiler}" != "javac" && -z "${build_compiler}" ]]; then 1903 if [[ "${compiler}" != "javac" && -z "${build_compiler}" ]]; then
1579 die "ANT_BUILD_COMPILER undefined in ${compiler_env}" 1904 die "ANT_BUILD_COMPILER undefined in ${compiler_env}"
1580 fi 1905 fi
1581 1906
1587 # java-config -p 1912 # java-config -p
1588 local build_compiler_deps="$(source ${JAVA_PKG_COMPILER_DIR}/${compiler} 1>/dev/null 2>&1; echo ${ANT_BUILD_COMPILER_DEPS})" 1913 local build_compiler_deps="$(source ${JAVA_PKG_COMPILER_DIR}/${compiler} 1>/dev/null 2>&1; echo ${ANT_BUILD_COMPILER_DEPS})"
1589 if [[ -n ${build_compiler_deps} ]]; then 1914 if [[ -n ${build_compiler_deps} ]]; then
1590 antflags="${antflags} -lib $(java-config -p ${build_compiler_deps})" 1915 antflags="${antflags} -lib $(java-config -p ${build_compiler_deps})"
1591 fi 1916 fi
1592 fi
1593
1594 if is-java-strict; then
1595 einfo "Disabling system classpath for ant"
1596 antflags="${antflags} -Dbuild.sysclasspath=ignore"
1597 fi 1917 fi
1598 1918
1599 for arg in "${@}"; do 1919 for arg in "${@}"; do
1600 if [[ ${arg} = -lib ]]; then 1920 if [[ ${arg} = -lib ]]; then
1601 if is-java-strict; then 1921 if is-java-strict; then
1610 echo "more info." 1930 echo "more info."
1611 fi 1931 fi
1612 fi 1932 fi
1613 done 1933 done
1614 1934
1615 if has_version ">=dev-java/ant-core-1.7.0"; then 1935 # parse WANT_ANT_TASKS for atoms
1616 # default ANT_TASKS to WANT_ANT_TASKS, if ANT_TASKS is not set explicitly 1936 local want_ant_tasks
1617 ANT_TASKS="${ANT_TASKS:-${WANT_ANT_TASKS}}" 1937 for i in ${WANT_ANT_TASKS}; do
1618 1938 if [[ ${i} = */*:* ]]; then
1619 # override ANT_TASKS with JAVA_PKG_FORCE_ANT_TASKS if it's set 1939 i=${i#*/}
1620 ANT_TASKS="${JAVA_PKG_FORCE_ANT_TASKS:-${ANT_TASKS}}" 1940 i=${i%:0}
1621 1941 want_ant_tasks+="${i/:/-} "
1622 if is-java-strict; then
1623 # if ant-tasks were not set by ebuild or forced, try to determine them from depends
1624 if [[ -z "${ANT_TASKS}" ]]; then
1625 ANT_TASKS="$(java-pkg_ant-tasks-from-deps)"
1626 fi
1627 else 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
1628 # if ant-tasks is not set by ebuild or forced, activate all of them 1952 # if ant-tasks is not set by ebuild or forced, use none
1629 ANT_TASKS="${ANT_TASKS:-all}" 1953 ANT_TASKS="${ANT_TASKS:-none}"
1630 fi
1631 1954
1632 # at this point, ANT_TASKS should be "all", "none" or explicit list 1955 # at this point, ANT_TASKS should be "all", "none" or explicit list
1633 if [[ "${ANT_TASKS}" == "all" ]]; then 1956 if [[ "${ANT_TASKS}" == "all" ]]; then
1634 einfo "Using all available ANT_TASKS" 1957 einfo "Using all available ANT_TASKS"
1635 elif [[ "${ANT_TASKS}" == "none" ]]; then 1958 elif [[ "${ANT_TASKS}" == "none" ]]; then
1636 einfo "Disabling all optional ANT_TASKS" 1959 einfo "Disabling all optional ANT_TASKS"
1637 else 1960 else
1638 einfo "Using following ANT_TASKS: ${ANT_TASKS}" 1961 einfo "Using following ANT_TASKS: ${ANT_TASKS}"
1639 fi 1962 fi
1640 1963
1641 export ANT_TASKS 1964 export ANT_TASKS
1642 fi
1643 1965
1644 [[ -n ${JAVA_PKG_DEBUG} ]] && antflags="${antflags} --execdebug -debug" 1966 [[ -n ${JAVA_PKG_DEBUG} ]] && antflags="${antflags} --execdebug -debug"
1645 [[ -n ${PORTAGE_QUIET} ]] && antflags="${antflags} -q" 1967 [[ -n ${PORTAGE_QUIET} ]] && antflags="${antflags} -q"
1646 1968
1647 local gcp="${EANT_GENTOO_CLASSPATH}" 1969 local gcp="${EANT_GENTOO_CLASSPATH}"
1970 local getjarsarg=""
1648 1971
1649 if [[ ${EBUILD_PHASE} = "test" ]]; then 1972 if [[ ${EBUILD_PHASE} = "test" ]]; then
1650 antflags="${antflags} -DJunit.present=true" 1973 antflags="${antflags} -DJunit.present=true"
1651 [[ ${gcp} && ${ANT_TASKS} = *ant-junit* ]] && gcp="${gcp} junit" 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"
1652 fi 1980 fi
1653 1981
1654 local cp 1982 local cp
1655 1983
1656 for atom in ${gcp}; do 1984 for atom in ${gcp}; do
1657 cp="${cp}:$(java-pkg_getjars ${atom})" 1985 cp+=":$(java-pkg_getjars ${getjarsarg} ${atom})"
1658 done 1986 done
1659 1987
1988 [[ ${EANT_NEEDS_TOOLS} ]] && cp+=":$(java-config --tools)"
1989 [[ ${EANT_GENTOO_CLASSPATH_EXTRA} ]] && cp+=":${EANT_GENTOO_CLASSPATH_EXTRA}"
1990
1660 if [[ ${cp} ]]; then 1991 if [[ ${cp#:} ]]; then
1661 # It seems ant does not like single quotes around ${cp} 1992 # It seems ant does not like single quotes around ${cp}
1662 antflags="${antflags} -Dgentoo.classpath=\"${cp#:}\"" 1993 antflags="${antflags} -Dgentoo.classpath=\"${cp#:}\""
1663 fi 1994 fi
1664 1995
1665 [[ -n ${JAVA_PKG_DEBUG} ]] && echo ant ${antflags} "${@}" 1996 [[ -n ${JAVA_PKG_DEBUG} ]] && echo ant ${antflags} "${@}"
1666 debug-print "Calling ant: ${antflags} ${@}" 1997 debug-print "Calling ant (GENTOO_VM: ${GENTOO_VM}): ${antflags} ${@}"
1667 ant ${antflags} "${@}" || die "eant failed" 1998 ant ${antflags} "${@}" || die "eant failed"
1668
1669} 1999}
1670 2000
1671# ------------------------------------------------------------------------------ 2001# @FUNCTION: ejavac
1672# @ebuild-function ejavac 2002# @USAGE: <javac_arguments>
1673# 2003# @DESCRIPTION:
1674# Javac wrapper function. Will use the appropriate compiler, based on 2004# Javac wrapper function. Will use the appropriate compiler, based on
1675# /etc/java-config/compilers.conf 2005# /etc/java-config/compilers.conf
1676#
1677# @param $@ - Arguments to be passed to the compiler
1678# ------------------------------------------------------------------------------
1679ejavac() { 2006ejavac() {
1680 debug-print-function ${FUNCNAME} $* 2007 debug-print-function ${FUNCNAME} $*
1681 2008
1682 java-pkg_init-compiler_ 2009 java-pkg_init-compiler_
1683 2010
1697 2024
1698 [[ -n ${JAVA_PKG_DEBUG} ]] && echo ${compiler_executable} ${javac_args} "${@}" 2025 [[ -n ${JAVA_PKG_DEBUG} ]] && echo ${compiler_executable} ${javac_args} "${@}"
1699 ${compiler_executable} ${javac_args} "${@}" || die "ejavac failed" 2026 ${compiler_executable} ${javac_args} "${@}" || die "ejavac failed"
1700} 2027}
1701 2028
1702# ------------------------------------------------------------------------------ 2029# @FUNCTION: ejavadoc
1703# @ebuild-function java-pkg_filter-compiler 2030# @USAGE: <javadoc_arguments>
1704# 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:
1705# 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.
1706# Basically, it just appends onto JAVA_PKG_FILTER_COMPILER 2050# Basically, it just appends onto JAVA_PKG_FILTER_COMPILER
1707#
1708# @param $@ - compilers to filter
1709# ------------------------------------------------------------------------------
1710java-pkg_filter-compiler() { 2051java-pkg_filter-compiler() {
1711 JAVA_PKG_FILTER_COMPILER="${JAVA_PKG_FILTER_COMPILER} $@" 2052 JAVA_PKG_FILTER_COMPILER="${JAVA_PKG_FILTER_COMPILER} $@"
1712} 2053}
1713 2054
1714# ------------------------------------------------------------------------------ 2055# @FUNCTION: java-pkg_force-compiler
1715# @ebuild-function java-pkg_force-compiler 2056# @USAGE: <compiler(s)_to_force>
1716# 2057# @DESCRIPTION:
1717# 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.
1718# 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
1719# OutOfMemoryErrors that may come up. 2060# OutOfMemoryErrors that may come up.
1720#
1721# @param $@ - compilers to force
1722# ------------------------------------------------------------------------------
1723java-pkg_force-compiler() { 2061java-pkg_force-compiler() {
1724 JAVA_PKG_FORCE_COMPILER="$@" 2062 JAVA_PKG_FORCE_COMPILER="$@"
1725} 2063}
1726 2064
1727# ------------------------------------------------------------------------------ 2065# @FUNCTION: use_doc
1728# @ebuild-function use_doc 2066# @DESCRIPTION:
1729# 2067#
1730# 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,
1731# 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.
1732# 2070#
1733# 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'
1734# 2075#
2076# Examples:
1735# Example: build javadocs by calling 'javadoc' target 2077# build javadocs by calling 'javadoc' target
1736# eant $(use_doc) 2078# eant $(use_doc)
2079#
1737# Example: build javadocs by calling 'apidoc' target 2080# build javadocs by calling 'apidoc' target
1738# eant $(use_doc apidoc) 2081# eant $(use_doc apidoc)
1739# 2082# @CODE
1740# @param $@ - Option value to return. Defaults to 'javadoc'
1741# @return string - Name of the target to create javadocs 2083# @RETURN string - Name of the target to create javadocs
1742# ------------------------------------------------------------------------------
1743use_doc() { 2084use_doc() {
1744 use doc && echo ${@:-javadoc} 2085 use doc && echo ${@:-javadoc}
1745} 2086}
1746 2087
1747 2088
1748# ------------------------------------------------------------------------------ 2089# @FUNCTION: java-pkg_init
1749# @section-end build 2090# @INTERNAL
1750# ------------------------------------------------------------------------------ 2091# @DESCRIPTION:
1751
1752# ------------------------------------------------------------------------------
1753# @section-begin internal
1754# @section-summary Internal functions
1755#
1756# Do __NOT__ use any of these from an ebuild! These are only to be used from
1757# within the java eclasses.
1758# ------------------------------------------------------------------------------
1759
1760# -----------------------------------------------------------------------------
1761# @function-internal java-pkg_init
1762#
1763# 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
1764# 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
1765# 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
1766# internally. And most importantly, it'll switch the VM if necessary. 2095# internally. And most importantly, it'll switch the VM if necessary.
1767# 2096#
1768# 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
1769# call it during each of the phases of the merge process. 2098# call it during each of the phases of the merge process.
1770#
1771# -----------------------------------------------------------------------------
1772java-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
1773 unset JAVAC 2108 unset JAVAC
1774 unset JAVA_HOME 2109 unset JAVA_HOME
1775 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
1776 java-pkg_switch-vm 2144 java-pkg_switch-vm
1777 PATH=${JAVA_HOME}/bin:${PATH} 2145 PATH=${JAVA_HOME}/bin:${PATH}
1778 2146
1779 # TODO we will probably want to set JAVAC and JAVACFLAGS 2147 # TODO we will probably want to set JAVAC and JAVACFLAGS
1780 2148
1781 # Do some QA checks 2149 # Do some QA checks
1782 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
1783 2154
1784 # When users have crazy classpaths some packages can fail to compile. 2155 # When users have crazy classpaths some packages can fail to compile.
1785 # and everything should work with empty CLASSPATH. 2156 # and everything should work with empty CLASSPATH.
1786 # This also helps prevent unexpected dependencies on random things 2157 # This also helps prevent unexpected dependencies on random things
1787 # from the CLASSPATH. 2158 # from the CLASSPATH.
1788 unset CLASSPATH 2159 export CLASSPATH=
1789 2160
1790 # Unset external ANT_ stuff 2161 # Unset external ANT_ stuff
1791 unset ANT_TASKS 2162 export ANT_TASKS=
1792 unset ANT_OPTS 2163 export ANT_OPTS=
2164 export ANT_RESPECT_JAVA_HOME=
1793} 2165}
1794 2166
1795# ------------------------------------------------------------------------------ 2167# @FUNCTION: java-pkg-init-compiler_
1796# @function-internal java-pkg-init-compiler_ 2168# @INTERNAL
1797# 2169# @DESCRIPTION:
1798# 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
1799# 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
1800# COMPILERS variable defined there. 2172# COMPILERS variable defined there.
1801# 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
1802# 2174#
1813# 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
1814# 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
1815# by the current VM. 2187# by the current VM.
1816# 2188#
1817# 2189#
1818# @return name of the compiler to use 2190# @RETURN name of the compiler to use
1819# ------------------------------------------------------------------------------
1820java-pkg_init-compiler_() { 2191java-pkg_init-compiler_() {
1821 debug-print-function ${FUNCNAME} $* 2192 debug-print-function ${FUNCNAME} $*
1822 2193
1823 if [[ -n ${GENTOO_COMPILER} ]]; then 2194 if [[ -n ${GENTOO_COMPILER} ]]; then
1824 debug-print "GENTOO_COMPILER already set" 2195 debug-print "GENTOO_COMPILER already set"
1865 if ! has ${desired_target} ${supported_target}; then 2236 if ! has ${desired_target} ${supported_target}; then
1866 ewarn "${compiler} does not support -target ${desired_target}, skipping" 2237 ewarn "${compiler} does not support -target ${desired_target}, skipping"
1867 continue 2238 continue
1868 fi 2239 fi
1869 2240
1870 # -source was introduced in 1.3, so only check 1.3 and on
1871 if version_is_at_least "${desired_soure}" "1.3"; then
1872 # Verify that the compiler supports source 2241 # Verify that the compiler supports source
1873 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})
1874 if ! has ${desired_source} ${supported_source}; then 2243 if ! has ${desired_source} ${supported_source}; then
1875 ewarn "${compiler} does not support -source ${desired_source}, skipping" 2244 ewarn "${compiler} does not support -source ${desired_source}, skipping"
1876 continue 2245 continue
1877 fi
1878 fi 2246 fi
1879 2247
1880 # 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
1881 export GENTOO_COMPILER="${compiler}" 2249 export GENTOO_COMPILER="${compiler}"
1882 break 2250 break
1888 done 2256 done
1889 2257
1890 # If it hasn't been defined already, default to javac 2258 # If it hasn't been defined already, default to javac
1891 if [[ -z ${GENTOO_COMPILER} ]]; then 2259 if [[ -z ${GENTOO_COMPILER} ]]; then
1892 if [[ -n ${compilers} ]]; then 2260 if [[ -n ${compilers} ]]; then
1893 einfo "No suitable compiler found: defaulting javac for compilation" 2261 einfo "No suitable compiler found: defaulting to JDK default for compilation"
1894 else 2262 else
1895 # probably don't need to notify users about the default. 2263 # probably don't need to notify users about the default.
1896 :;#einfo "Defaulting to javac for compilation" 2264 :;#einfo "Defaulting to javac for compilation"
1897 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
1898 export GENTOO_COMPILER=javac 2269 export GENTOO_COMPILER=javac
2270 fi
1899 else 2271 else
1900 einfo "Using ${GENTOO_COMPILER} for compilation" 2272 einfo "Using ${GENTOO_COMPILER} for compilation"
1901 fi 2273 fi
1902 2274
1903} 2275}
1904 2276
1905# ------------------------------------------------------------------------------ 2277# @FUNCTION: init_paths_
1906# @internal-function init_paths_ 2278# @INTERNAL
1907# 2279# @DESCRIPTION:
1908# 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
1909# to determine where things will eventually get installed. 2281# to determine where things will eventually get installed.
1910# ------------------------------------------------------------------------------
1911java-pkg_init_paths_() { 2282java-pkg_init_paths_() {
1912 debug-print-function ${FUNCNAME} $* 2283 debug-print-function ${FUNCNAME} $*
1913 2284
1914 local pkg_name 2285 local pkg_name
1915 if [[ "$SLOT" == "0" ]] ; then 2286 if [[ "${SLOT%/*}" == "0" ]] ; then
1916 JAVA_PKG_NAME="${PN}" 2287 JAVA_PKG_NAME="${PN}"
1917 else 2288 else
1918 JAVA_PKG_NAME="${PN}-${SLOT}" 2289 JAVA_PKG_NAME="${PN}-${SLOT%/*}"
1919 fi 2290 fi
1920 2291
1921 JAVA_PKG_SHAREPATH="${DESTTREE}/share/${JAVA_PKG_NAME}" 2292 JAVA_PKG_SHAREPATH="${DESTTREE}/share/${JAVA_PKG_NAME}"
1922 JAVA_PKG_SOURCESPATH="${JAVA_PKG_SHAREPATH}/sources/" 2293 JAVA_PKG_SOURCESPATH="${JAVA_PKG_SHAREPATH}/sources/"
1923 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}"
1924 2297
1925 [[ -z "${JAVA_PKG_JARDEST}" ]] && JAVA_PKG_JARDEST="${JAVA_PKG_SHAREPATH}/lib" 2298 [[ -z "${JAVA_PKG_JARDEST}" ]] && JAVA_PKG_JARDEST="${JAVA_PKG_SHAREPATH}/lib"
1926 [[ -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}"
1927 [[ -z "${JAVA_PKG_WARDEST}" ]] && JAVA_PKG_WARDEST="${JAVA_PKG_SHAREPATH}/webapps" 2300 [[ -z "${JAVA_PKG_WARDEST}" ]] && JAVA_PKG_WARDEST="${JAVA_PKG_SHAREPATH}/webapps"
1928
1929 2301
1930 # TODO maybe only print once? 2302 # TODO maybe only print once?
1931 debug-print "JAVA_PKG_SHAREPATH: ${JAVA_PKG_SHAREPATH}" 2303 debug-print "JAVA_PKG_SHAREPATH: ${JAVA_PKG_SHAREPATH}"
1932 debug-print "JAVA_PKG_ENV: ${JAVA_PKG_ENV}" 2304 debug-print "JAVA_PKG_ENV: ${JAVA_PKG_ENV}"
1933 debug-print "JAVA_PKG_JARDEST: ${JAVA_PKG_JARDEST}" 2305 debug-print "JAVA_PKG_JARDEST: ${JAVA_PKG_JARDEST}"
1934 debug-print "JAVA_PKG_LIBDEST: ${JAVA_PKG_LIBDEST}" 2306 debug-print "JAVA_PKG_LIBDEST: ${JAVA_PKG_LIBDEST}"
1935 debug-print "JAVA_PKG_WARDEST: ${JAVA_PKG_WARDEST}" 2307 debug-print "JAVA_PKG_WARDEST: ${JAVA_PKG_WARDEST}"
1936} 2308}
1937 2309
1938# ------------------------------------------------------------------------------ 2310# @FUNCTION: java-pkg_do_write_
1939# @internal-function java-pkg_do_write_ 2311# @INTERNAL
1940# 2312# @DESCRIPTION:
1941# Writes the package.env out to disk. 2313# Writes the package.env out to disk.
1942# 2314#
1943# ------------------------------------------------------------------------------
1944# TODO change to do-write, to match everything else 2315# TODO change to do-write, to match everything else
1945java-pkg_do_write_() { 2316java-pkg_do_write_() {
2317 debug-print-function ${FUNCNAME} $*
1946 java-pkg_init_paths_ 2318 java-pkg_init_paths_
1947 # Create directory for package.env 2319 # Create directory for package.env
1948 dodir "${JAVA_PKG_SHAREPATH}" 2320 dodir "${JAVA_PKG_SHAREPATH}"
1949 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
1950 # Create package.env 2324 # Create package.env
1951 ( 2325 (
1952 echo "DESCRIPTION=\"${DESCRIPTION}\"" 2326 echo "DESCRIPTION=\"${DESCRIPTION}\""
1953 echo "GENERATION=\"2\"" 2327 echo "GENERATION=\"2\""
2328 echo "SLOT=\"${SLOT}\""
2329 echo "CATEGORY=\"${CATEGORY}\""
2330 echo "PVR=\"${PVR}\""
1954 2331
1955 [[ -n "${JAVA_PKG_CLASSPATH}" ]] && echo "CLASSPATH=\"${JAVA_PKG_CLASSPATH}\"" 2332 [[ -n "${JAVA_PKG_CLASSPATH}" ]] && echo "CLASSPATH=\"${JAVA_PKG_CLASSPATH}\""
1956 [[ -n "${JAVA_PKG_LIBRARY}" ]] && echo "LIBRARY_PATH=\"${JAVA_PKG_LIBRARY}\"" 2333 [[ -n "${JAVA_PKG_LIBRARY}" ]] && echo "LIBRARY_PATH=\"${JAVA_PKG_LIBRARY}\""
1957 [[ -n "${JAVA_PROVIDE}" ]] && echo "PROVIDES=\"${JAVA_PROVIDE}\"" 2334 [[ -n "${JAVA_PROVIDE}" ]] && echo "PROVIDES=\"${JAVA_PROVIDE}\""
1958 [[ -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' ':')\""
1959 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' ':')\""
1960 ) > "${JAVA_PKG_ENV}" 2342 ) > "${JAVA_PKG_ENV}"
1961 2343
1962 # register target/source 2344 # register target/source
1963 local target="$(java-pkg_get-target)" 2345 local target="$(java-pkg_get-target)"
1964 local source="$(java-pkg_get-source)" 2346 local source="$(java-pkg_get-source)"
1974 2356
1975 2357
1976 echo "MERGE_VM=\"${GENTOO_VM}\"" >> "${JAVA_PKG_ENV}" 2358 echo "MERGE_VM=\"${GENTOO_VM}\"" >> "${JAVA_PKG_ENV}"
1977 [[ -n ${GENTOO_COMPILER} ]] && echo "MERGE_COMPILER=\"${GENTOO_COMPILER}\"" >> "${JAVA_PKG_ENV}" 2359 [[ -n ${GENTOO_COMPILER} ]] && echo "MERGE_COMPILER=\"${GENTOO_COMPILER}\"" >> "${JAVA_PKG_ENV}"
1978 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
1979 # Strip unnecessary leading and trailing colons 2369 # Strip unnecessary leading and trailing colons
1980 # TODO try to cleanup if possible 2370 # TODO try to cleanup if possible
1981 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."
1982 fi 2376 fi
1983} 2377}
1984 2378
1985# ------------------------------------------------------------------------------ 2379# @FUNCTION: java-pkg_record-jar_
1986# @internal-function java-pkg_record-jar_ 2380# @INTERNAL
1987# 2381# @DESCRIPTION:
1988# Record a dependency to the package.env 2382# Record an (optional) dependency to the package.env
1989# 2383# @CODE
1990# ------------------------------------------------------------------------------ 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
1991JAVA_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"
1992 2393
1993java-pkg_record-jar_() { 2394java-pkg_record-jar_() {
1994 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
1995 2402
1996 local pkg=${1} jar=${2} append 2403 local pkg=${1} jar=${2} append
1997 if [[ -z "${jar}" ]]; then 2404 if [[ -z "${jar}" ]]; then
1998 append="${pkg}" 2405 append="${pkg}"
1999 else 2406 else
2000 append="$(basename ${jar})@${pkg}" 2407 append="$(basename ${jar})@${pkg}"
2001 fi 2408 fi
2002 2409
2003 echo ${append} >> ${JAVA_PKG_DEPEND} 2410 echo "${append}" >> "${depend_file}"
2004} 2411}
2005 2412
2006# ------------------------------------------------------------------------------ 2413# @FUNCTION: java-pkg_append_
2007# @internal-function java-pkg_append_ 2414# @INTERNAL
2008# 2415# @DESCRIPTION:
2009# Appends a value to a variable 2416# Appends a value to a variable
2010# 2417#
2011# Example: java-pkg_append_ CLASSPATH foo.jar 2418# @CODE
2419# Parameters:
2012# @param $1 variable name to modify 2420# $1 variable name to modify
2013# @param $2 value to append 2421# $2 value to append
2014# ------------------------------------------------------------------------------ 2422#
2423# Examples:
2424# java-pkg_append_ CLASSPATH foo.jar
2425# @CODE
2015java-pkg_append_() { 2426java-pkg_append_() {
2016 debug-print-function ${FUNCNAME} $* 2427 debug-print-function ${FUNCNAME} $*
2017 2428
2018 local var="${1}" value="${2}" 2429 local var="${1}" value="${2}"
2019 if [[ -z "${!var}" ]] ; then 2430 if [[ -z "${!var}" ]] ; then
2030 [[ -z ${haveit} ]] && export ${var}="${!var}:${value}" 2441 [[ -z ${haveit} ]] && export ${var}="${!var}:${value}"
2031 IFS=${oldIFS} 2442 IFS=${oldIFS}
2032 fi 2443 fi
2033} 2444}
2034 2445
2035# ------------------------------------------------------------------------------ 2446# @FUNCTION: java-pkg_expand_dir_
2036# @internal-function java-pkg_expand_dir_ 2447# @INTERNAL
2037# 2448# @DESCRIPTION:
2038# 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:
2039# @param $1 - file/directory to find parent directory for 2452# $1 - file/directory to find parent directory for
2453# @CODE
2040# @return - path to $1's parent directory 2454# @RETURN: path to $1's parent directory
2041# ------------------------------------------------------------------------------
2042java-pkg_expand_dir_() { 2455java-pkg_expand_dir_() {
2043 pushd "$(dirname "${1}")" >/dev/null 2>&1 2456 pushd "$(dirname "${1}")" >/dev/null 2>&1
2044 pwd 2457 pwd
2045 popd >/dev/null 2>&1 2458 popd >/dev/null 2>&1
2046} 2459}
2047 2460
2048# ------------------------------------------------------------------------------ 2461# @FUNCTION: java-pkg_func-exists
2049# @internal-function java-pkg_func-exists 2462# @INTERNAL
2050# 2463# @DESCRIPTION:
2051# Does the indicated function exist? 2464# Does the indicated function exist?
2052# 2465# @RETURN: 0 - function is declared, 1 - function is undeclared
2053# @return 0 - function is declared
2054# @return 1 - function is undeclared
2055# ------------------------------------------------------------------------------
2056java-pkg_func-exists() { 2466java-pkg_func-exists() {
2057 if [[ -n "$(declare -f ${1})" ]]; then 2467 declare -F ${1} > /dev/null
2058 return 0
2059 else
2060 return 1
2061 fi
2062} 2468}
2063 2469
2064# ------------------------------------------------------------------------------ 2470# @FUNCTION: java-pkg_setup-vm
2065# @internal-function java-pkg_setup-vm 2471# @INTERNAL
2066# 2472# @DESCRIPTION:
2067# Sets up the environment for a specific VM 2473# Sets up the environment for a specific VM
2068#
2069# ------------------------------------------------------------------------------
2070java-pkg_setup-vm() { 2474java-pkg_setup-vm() {
2071 debug-print-function ${FUNCNAME} $* 2475 debug-print-function ${FUNCNAME} $*
2072 2476
2073 local vendor="$(java-pkg_get-vm-vendor)" 2477 local vendor="$(java-pkg_get-vm-vendor)"
2074 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
2075 addpredict "/dev/random" 2479 addpredict "/dev/random"
2076 elif [[ "${vendor}" == "ibm" ]]; then 2480 elif [[ "${vendor}" == "ibm" ]]; then
2077 addpredict "/proc/self/maps" 2481 addpredict "/proc/self/maps"
2078 addpredict "/proc/cpuinfo" 2482 addpredict "/proc/cpuinfo"
2079 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"
2080 elif [[ "${vendor}" == "jrockit" ]]; then 2490 elif [[ "${vendor}" == "jrockit" ]]; then
2081 addpredict "/proc/cpuinfo" 2491 addpredict "/proc/cpuinfo"
2082 fi 2492 fi
2083} 2493}
2084 2494
2085# ------------------------------------------------------------------------------ 2495# @FUNCTION: java-pkg_needs-vm
2086# @internal-function java-pkg_needs-vm 2496# @INTERNAL
2087# 2497# @DESCRIPTION:
2088# 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?
2089# 2500#
2090# @return 0 - Package depends on virtual/jdk 2501# @RETURN: 0 - Package depends on virtual/jdk; 1 - Package does not depend on virtual/jdk
2091# @return 1 - Package does not depend on virtual/jdk
2092# ------------------------------------------------------------------------------
2093java-pkg_needs-vm() { 2502java-pkg_needs-vm() {
2094 debug-print-function ${FUNCNAME} $* 2503 debug-print-function ${FUNCNAME} $*
2095 2504
2096 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
2097 return 0 2506 return 0
2098 fi 2507 fi
2099 2508
2509 [[ -n "${JAVA_PKG_WANT_BUILD_VM}" ]] && return 0
2510
2100 return 1 2511 return 1
2101} 2512}
2102 2513
2103# ------------------------------------------------------------------------------ 2514# @FUNCTION: java-pkg_get-current-vm
2104# @internal-function java-pkg_get-current-vm 2515# @INTERNAL
2105#
2106# @return - The current VM being used 2516# @RETURN - The current VM being used
2107# ------------------------------------------------------------------------------
2108java-pkg_get-current-vm() { 2517java-pkg_get-current-vm() {
2109 java-config -f 2518 java-config -f
2110} 2519}
2111 2520
2112# ------------------------------------------------------------------------------ 2521# @FUNCTION: java-pkg_get-vm-vendor
2113# @internal-function java-pkg_get-vm-vendor 2522# @INTERNAL
2114#
2115# @return - The vendor of the current VM 2523# @RETURN - The vendor of the current VM
2116# ------------------------------------------------------------------------------
2117java-pkg_get-vm-vendor() { 2524java-pkg_get-vm-vendor() {
2118 debug-print-function ${FUNCNAME} $* 2525 debug-print-function ${FUNCNAME} $*
2119 2526
2120 local vm="$(java-pkg_get-current-vm)" 2527 local vm="$(java-pkg_get-current-vm)"
2121 vm="${vm/-*/}" 2528 vm="${vm/-*/}"
2122 echo "${vm}" 2529 echo "${vm}"
2123} 2530}
2124 2531
2125# ------------------------------------------------------------------------------ 2532# @FUNCTION: java-pkg_get-vm-version
2126# @internal-function java-pkg_get-vm-version 2533# @INTERNAL
2127#
2128# @return - The version of the current VM 2534# @RETURN - The version of the current VM
2129# ------------------------------------------------------------------------------
2130java-pkg_get-vm-version() { 2535java-pkg_get-vm-version() {
2131 debug-print-function ${FUNCNAME} $* 2536 debug-print-function ${FUNCNAME} $*
2132 2537
2133 java-config -g PROVIDES_VERSION 2538 java-config -g PROVIDES_VERSION
2134} 2539}
2135 2540
2136# ------------------------------------------------------------------------------ 2541# @FUNCTION: java-pkg_build-vm-from-handle
2137# @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.
2138# 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:
2139# 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
2140# verify that the current VM is sufficient. 2576# verify that the current VM is sufficient.
2141# Setup the environment for the VM being used. 2577# Setup the environment for the VM being used.
2142# ------------------------------------------------------------------------------
2143java-pkg_switch-vm() { 2578java-pkg_switch-vm() {
2144 debug-print-function ${FUNCNAME} $* 2579 debug-print-function ${FUNCNAME} $*
2145 2580
2146 if java-pkg_needs-vm; then 2581 if java-pkg_needs-vm; then
2147 # Use the VM specified by JAVA_PKG_FORCE_VM 2582 # Use the VM specified by JAVA_PKG_FORCE_VM
2149 # 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...
2150 debug-print "JAVA_PKG_FORCE_VM used: ${JAVA_PKG_FORCE_VM}" 2585 debug-print "JAVA_PKG_FORCE_VM used: ${JAVA_PKG_FORCE_VM}"
2151 export GENTOO_VM="${JAVA_PKG_FORCE_VM}" 2586 export GENTOO_VM="${JAVA_PKG_FORCE_VM}"
2152 # if we're allowed to switch the vm... 2587 # if we're allowed to switch the vm...
2153 elif [[ "${JAVA_PKG_ALLOW_VM_CHANGE}" == "yes" ]]; then 2588 elif [[ "${JAVA_PKG_ALLOW_VM_CHANGE}" == "yes" ]]; then
2154 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
2155 if [[ -n ${JAVA_PKG_VNEED} ]]; then 2590 if [[ -n "${JAVA_PKG_WANT_BUILD_VM}" ]]; then
2156 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
2157 else 2608 else
2609 debug-print "depend-java-query: NV_DEPEND: ${JAVA_PKG_NV_DEPEND:-${DEPEND}}"
2158 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
2159 fi 2616 fi
2160 if [[ -z "${GENTOO_VM}" || "${GENTOO_VM}" == "None" ]]; then
2161 eerror "Unable to determine VM for building from dependencies:"
2162 echo "NV_DEPEND: ${JAVA_PKG_NV_DEPEND:-${DEPEND}}"
2163 echo "VNEED: ${JAVA_PKG_VNEED}"
2164 die "Failed to determine VM for building."
2165 else
2166 export GENTOO_VM 2617 export GENTOO_VM
2167 fi
2168 # otherwise just make sure the current VM is sufficient 2618 # otherwise just make sure the current VM is sufficient
2169 else 2619 else
2170 java-pkg_ensure-vm-version-sufficient 2620 java-pkg_ensure-vm-version-sufficient
2171 fi 2621 fi
2172 debug-print "Using: $(java-config -f)" 2622 debug-print "Using: $(java-config -f)"
2188 2638
2189 #TODO If you know a better solution let us know. 2639 #TODO If you know a better solution let us know.
2190 java-pkg_append_ LD_LIBRARY_PATH "$(java-config -g LDPATH)" 2640 java-pkg_append_ LD_LIBRARY_PATH "$(java-config -g LDPATH)"
2191 2641
2192 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
2193 if [[ -n "${JAVA_PKG_DEBUG}" ]] || [[ ! -f "${tann}" ]] ; then 2645 if [[ -n "${JAVA_PKG_DEBUG}" ]] || [[ ! -f "${tann}" ]] ; then
2194 # Add a check for setup/preinst phase... to avoid duplicate outputs
2195 # for when FEATURES=buildpkg
2196 if [[ ${EBUILD_PHASE} != "setup" && ${EBUILD_PHASE} != "preinst" && ${EBUILD_PHASE} != "postinst" ]];
2197 then
2198 einfo "Using: $(java-config -f)" 2646 einfo "Using: $(java-config -f)"
2199 [[ ! -f "${tann}" ]] && touch "${tann}" 2647 [[ ! -f "${tann}" ]] && touch "${tann}"
2200 fi
2201 fi 2648 fi
2202 2649
2203 else 2650 else
2204 [[ -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!!!"
2205 fi 2652 fi
2206} 2653}
2207 2654
2208# ------------------------------------------------------------------------------ 2655# @FUNCTION: java-pkg_die
2209# @internal-function java-pkg_die 2656# @INTERNAL
2210# 2657# @DESCRIPTION:
2211# 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
2212# useful for debugging bugs on bugzilla. 2659# useful for debugging bugs on bugzilla.
2213# ------------------------------------------------------------------------------
2214#register_die_hook java-pkg_die 2660#register_die_hook java-pkg_die
2215if ! hasq java-pkg_die ${EBUILD_DEATH_HOOKS}; then 2661if ! has java-pkg_die ${EBUILD_DEATH_HOOKS}; then
2216 EBUILD_DEATH_HOOKS="${EBUILD_DEATH_HOOKS} java-pkg_die" 2662 EBUILD_DEATH_HOOKS="${EBUILD_DEATH_HOOKS} java-pkg_die"
2217fi 2663fi
2218 2664
2219java-pkg_die() { 2665java-pkg_die() {
2220 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
2221 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
2222 echo "JAVACFLAGS=\"${JAVACFLAGS}\" COMPILER=\"${GENTOO_COMPILER}\"" >&2 2668 echo "JAVACFLAGS=\"${JAVACFLAGS}\" COMPILER=\"${GENTOO_COMPILER}\"" >&2
2223 echo "and of course, the output of emerge --info" >&2 2669 echo "and of course, the output of emerge --info =${P}" >&2
2224} 2670}
2225 2671
2226 2672
2227# TODO document 2673# TODO document
2228# List jars in the source directory, ${S} 2674# List jars in the source directory, ${S}
2235 einfo "Classes" 2681 einfo "Classes"
2236 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},"
2237 fi 2683 fi
2238} 2684}
2239 2685
2240# ------------------------------------------------------------------------------ 2686# @FUNCTION: java-pkg_verify-classes
2241# @internal-function java-pkg_verify-classes 2687# @INTERNAL
2242# 2688# @DESCRIPTION:
2243# Verify that the classes were compiled for the right source / target. Dies if 2689# Verify that the classes were compiled for the right source / target. Dies if
2244# not. 2690# not.
2691# @CODE
2245# @param $1 (optional) - the file to check, otherwise checks whole ${D} 2692# $1 (optional) - the file to check, otherwise checks whole ${D}
2246# ------------------------------------------------------------------------------ 2693# @CODE
2247java-pkg_verify-classes() { 2694java-pkg_verify-classes() {
2248 #$(find ${D} -type f -name '*.jar' -o -name '*.class') 2695 #$(find ${D} -type f -name '*.jar' -o -name '*.class')
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
2249 local target=$(java-pkg_get-target) 2710 local target=$(java-pkg_get-target)
2250 local result 2711 local result
2251 local log="${T}/class-version-verify.log" 2712 local log="${T}/class-version-verify.log"
2252 if [[ -n "${1}" ]]; then 2713 if [[ -n "${1}" ]]; then
2253 class-version-verify.py -v -t ${target} "${1}" > "${log}" 2714 ${version_verify} -v -t ${target} "${1}" > "${log}"
2254 result=$? 2715 result=$?
2255 else 2716 else
2256 ebegin "Verifying java class versions (target: ${target})" 2717 ebegin "Verifying java class versions (target: ${target})"
2257 class-version-verify.py -v -t ${target} -r "${D}" > "${log}" 2718 ${version_verify} -v -t ${target} -r "${D}" > "${log}"
2258 result=$? 2719 result=$?
2259 eend ${result} 2720 eend ${result}
2260 fi 2721 fi
2261 [[ -n ${JAVA_PKG_DEBUG} ]] && cat "${log}" 2722 [[ -n ${JAVA_PKG_DEBUG} ]] && cat "${log}"
2262 if [[ ${result} != 0 ]]; then 2723 if [[ ${result} != 0 ]]; then
2265 eerror "See ${log} for more details." 2726 eerror "See ${log} for more details."
2266 die "Incorrect bytecode found" 2727 die "Incorrect bytecode found"
2267 fi 2728 fi
2268} 2729}
2269 2730
2270# ------------------------------------------------------------------------------ 2731# @FUNCTION: java-pkg_ensure-dep
2271# @section-end internal 2732# @INTERNAL
2272# ------------------------------------------------------------------------------ 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."
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
2801}
2273 2802
2274java-pkg_check-phase() { 2803java-pkg_check-phase() {
2275 local phase=${1} 2804 local phase=${1}
2276 local funcname=${2} 2805 local funcname=${FUNCNAME[1]}
2277 if is-java-strict && [[ ${EBUILD_PHASE} != ${phase} ]]; then 2806 if [[ ${EBUILD_PHASE} != ${phase} ]]; then
2278 java-pkg_announce-qa-violation \
2279 "${funcname} used outside of src_${phase}" 2807 local msg="${funcname} used outside of src_${phase}"
2808 java-pkg_announce-qa-violation "${msg}"
2280 fi 2809 fi
2281} 2810}
2282 2811
2283java-pkg_check-versioned-jar() { 2812java-pkg_check-versioned-jar() {
2284 local jar=${1} 2813 local jar=${1}
2287 java-pkg_announce-qa-violation "installing versioned jar '${jar}'" 2816 java-pkg_announce-qa-violation "installing versioned jar '${jar}'"
2288 fi 2817 fi
2289} 2818}
2290 2819
2291java-pkg_check-jikes() { 2820java-pkg_check-jikes() {
2292 if hasq jikes ${IUSE}; then 2821 if has jikes ${IUSE}; then
2293 java-pkg_announce-qa-violation "deprecated USE flag 'jikes' in IUSE" 2822 java-pkg_announce-qa-violation "deprecated USE flag 'jikes' in IUSE"
2294 fi 2823 fi
2295} 2824}
2296 2825
2297java-pkg_announce-qa-violation() { 2826java-pkg_announce-qa-violation() {
2298 if is-java-strict; then 2827 local nodie
2828 if [[ ${1} == "--nodie" ]]; then
2829 nodie="true"
2830 shift
2831 fi
2299 echo "Java QA Notice: $@" >&2 2832 echo "Java QA Notice: $@" >&2
2300 increment-qa-violations 2833 increment-qa-violations
2301 fi 2834 [[ -z "${nodie}" ]] && is-java-strict && die "${@}"
2302} 2835}
2303 2836
2304increment-qa-violations() { 2837increment-qa-violations() {
2305 let "JAVA_PKG_QA_VIOLATIONS+=1" 2838 let "JAVA_PKG_QA_VIOLATIONS+=1"
2306 export JAVA_PKG_QA_VIOLATIONS 2839 export JAVA_PKG_QA_VIOLATIONS
2308 2841
2309is-java-strict() { 2842is-java-strict() {
2310 [[ -n ${JAVA_PKG_STRICT} ]] 2843 [[ -n ${JAVA_PKG_STRICT} ]]
2311 return $? 2844 return $?
2312} 2845}
2313
2314# ------------------------------------------------------------------------------
2315# @eclass-end
2316# ------------------------------------------------------------------------------

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

  ViewVC Help
Powered by ViewVC 1.1.20