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

Legend:
Removed from v.1.72  
changed lines
  Added in v.1.166

  ViewVC Help
Powered by ViewVC 1.1.20