/[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.79 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.79 2007/04/26 14:50:00 caster 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() {
561 debug-print-function ${FUNCNAME} $* 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
562 local dir="$1" 600 local dir="$1"
601 local dest=/usr/share/doc/${PF}/html
563 602
564 # QA checks 603 # QA checks
565 604
566 java-pkg_check-phase install 605 java-pkg_check-phase install
606 java-pkg_init_paths_
567 607
568 [[ -z "${dir}" ]] && die "Must specify a directory!" 608 [[ -z "${dir}" ]] && die "Must specify a directory!"
569 [[ ! -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!"
570 if [[ ! -e "${dir}/index.html" ]]; then 610 if [[ ! -e "${dir}/index.html" ]]; then
571 local msg="No index.html in javadoc directory" 611 local msg="No index.html in javadoc directory"
572 ewarn "${msg}" 612 ewarn "${msg}"
573 is-java-strict && die "${msg}" 613 is-java-strict && die "${msg}"
574 fi 614 fi
575 615
616 if [[ -e ${D}/${dest}/api ]]; then
617 eerror "${dest} already exists. Will not overwrite."
618 die "${dest}"
619 fi
620
576 # Renaming to match our directory layout 621 # Renaming to match our directory layout
577 622
578 local dir_to_install="${dir}" 623 local dir_to_install="${dir}"
579 if [[ "$(basename "${dir}")" != "api" ]]; then 624 if [[ "$(basename "${dir}")" != "api" ]]; then
580 dir_to_install="${T}/api" 625 dir_to_install="${T}/api"
582 cp -r "${dir}" "${dir_to_install}" || die "cp failed" 627 cp -r "${dir}" "${dir_to_install}" || die "cp failed"
583 fi 628 fi
584 629
585 # Actual installation 630 # Actual installation
586 631
587 java-pkg_dohtml -r ${dir_to_install} 632 java-pkg_dohtml -r "${dir_to_install}"
588}
589 633
590# ------------------------------------------------------------------------------ 634 # Let's make a symlink to the directory we have everything else under
591# @ebuild-function java-pkg_dosrc 635 dosym ${dest}/api "${JAVA_PKG_SHAREPATH}/api" || die
592# 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:
593# 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
594# 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.
595# 649#
596# Ebuild needs to DEPEND on app-arch/zip to use this. 650# @CODE
597#
598# It also should be controlled by USE=source.
599#
600# @example: 651# Example:
601# java-pkg_dosrc src/* 652# java-pkg_dosrc src/*
602# 653# @CODE
603# ------------------------------------------------------------------------------ 654
604# 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
605# source -nichoj 656# source -nichoj
657#
606# 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#
607# TODO maybe we can take an existing zip/jar? -nichoj 660# TODO maybe we can take an existing zip/jar? -nichoj
661#
608# FIXME apparently this fails if you give it an empty directories 662# FIXME apparently this fails if you give it an empty directories
609java-pkg_dosrc() { 663java-pkg_dosrc() {
610 debug-print-function ${FUNCNAME} $* 664 debug-print-function ${FUNCNAME} $*
611 665
612 [ ${#} -lt 1 ] && die "At least one argument needed" 666 [ ${#} -lt 1 ] && die "At least one argument needed"
615 669
616 [[ ${#} -lt 1 ]] && die "At least one argument needed" 670 [[ ${#} -lt 1 ]] && die "At least one argument needed"
617 671
618 if ! [[ ${DEPEND} = *app-arch/zip* ]]; then 672 if ! [[ ${DEPEND} = *app-arch/zip* ]]; then
619 local msg="${FUNCNAME} called without app-arch/zip in DEPEND" 673 local msg="${FUNCNAME} called without app-arch/zip in DEPEND"
620 if is-java-strict; then 674 java-pkg_announce-qa-violation ${msg}
621 eerror "${msg}"
622 die "${msg}"
623 else
624 echo "${msg}"
625 echo "Please report this to http://bugs.gentoo.org."
626 fi
627 fi 675 fi
628 676
629 java-pkg_init_paths_ 677 java-pkg_init_paths_
630 678
631 local zip_name="${PN}-src.zip" 679 local zip_name="${PN}-src.zip"
650 698
651 JAVA_SOURCES="${JAVA_PKG_SOURCESPATH}/${zip_name}" 699 JAVA_SOURCES="${JAVA_PKG_SOURCESPATH}/${zip_name}"
652 java-pkg_do_write_ 700 java-pkg_do_write_
653} 701}
654 702
655# ------------------------------------------------------------------------------ 703# @FUNCTION: java-pkg_dolauncher
656# @ebuild-function java-pkg_dolauncher 704# @USAGE: <filename> [options]
657# 705# @DESCRIPTION:
658# Make a wrapper script to lauch/start this package 706# Make a wrapper script to lauch/start this package
659# If necessary, the wrapper will switch to the appropriate VM. 707# If necessary, the wrapper will switch to the appropriate VM.
660# 708#
661# 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
662# 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}.
663# 711#
712# @CODE
713# Parameters:
664# @param $1 - filename of launcher to create 714# $1 - filename of launcher to create
665# @param $2 - options, as follows: 715# $2 - options, as follows:
666# --main the.main.class.too.start 716# --main the.main.class.to.start
667# --jar /the/jar/too/launch.jar or just <name>.jar 717# --jar /the/jar/too/launch.jar or just <name>.jar
668# --java_args 'Extra arguments to pass to java' 718# --java_args 'Extra arguments to pass to java'
669# --pkg_args 'Extra arguments to pass to the package' 719# --pkg_args 'Extra arguments to pass to the package'
670# --pwd Directory the launcher changes to before executing java 720# --pwd Directory the launcher changes to before executing java
671# -into Directory to install the launcher to, instead of /usr/bin 721# -into Directory to install the launcher to, instead of /usr/bin
672# -pre Prepend contents of this file to the launcher 722# -pre Prepend contents of this file to the launcher
673# ------------------------------------------------------------------------------ 723# @CODE
674java-pkg_dolauncher() { 724java-pkg_dolauncher() {
675 debug-print-function ${FUNCNAME} $* 725 debug-print-function ${FUNCNAME} $*
676 726
677 java-pkg_check-phase install 727 java-pkg_check-phase install
678 java-pkg_init_paths_ 728 java-pkg_init_paths_
739 else 789 else
740 dobin "${target}" 790 dobin "${target}"
741 fi 791 fi
742} 792}
743 793
744# ------------------------------------------------------------------------------ 794# @FUNCTION: java-pkg_dowar
795# @DESCRIPTION:
745# Install war files. 796# Install war files.
746# TODO document 797# TODO document
747# ------------------------------------------------------------------------------
748java-pkg_dowar() { 798java-pkg_dowar() {
749 debug-print-function ${FUNCNAME} $* 799 debug-print-function ${FUNCNAME} $*
750 800
751 # Check for arguments 801 # Check for arguments
752 [[ ${#} -lt 1 ]] && die "At least one argument needed" 802 [[ ${#} -lt 1 ]] && die "At least one argument needed"
776 INSDESTTREE=${JAVA_PKG_WARDEST} \ 826 INSDESTTREE=${JAVA_PKG_WARDEST} \
777 doins ${warpath} 827 doins ${warpath}
778 done 828 done
779} 829}
780 830
781# ------------------------------------------------------------------------------ 831# @FUNCTION: java-pkg_recordjavadoc
782# @internal-function java-pkg_recordjavadoc 832# @INTERNAL
833# @DESCRIPTION:
783# 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
784# 835
785# TODO make sure this in the proper section 836# TODO make sure this in the proper section
786# ------------------------------------------------------------------------------
787java-pkg_recordjavadoc() 837java-pkg_recordjavadoc()
788{ 838{
789 debug-print-function ${FUNCNAME} $* 839 debug-print-function ${FUNCNAME} $*
790 # the find statement is important 840 # the find statement is important
791 # as some packages include multiple trees of javadoc 841 # as some packages include multiple trees of javadoc
798 else 848 else
799 debug-print "No javadocs found" 849 debug-print "No javadocs found"
800 fi 850 fi
801} 851}
802 852
803# ------------------------------------------------------------------------------
804# @section-end install
805# ------------------------------------------------------------------------------
806 853
807# ------------------------------------------------------------------------------ 854# @FUNCTION: java-pkg_jar-from
808# @begin-section query 855# @USAGE: [--build-only] [--with-dependencies] [--virtual] [--into dir] <package> [<package.jar>] [<destination.jar>]
809# Use these to build the classpath for building a package. 856# @DESCRIPTION:
810# ------------------------------------------------------------------------------
811
812# ------------------------------------------------------------------------------
813# @ebuild-function java-pkg_jar-from
814#
815# Makes a symlink to a jar from a certain package 857# Makes a symlink to a jar from a certain package
816# A lot of java packages include dependencies in a lib/ directory 858# A lot of java packages include dependencies in a lib/ directory
817# You can use this function to replace these bundled dependencies. 859# You can use this function to replace these bundled dependencies.
818# 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"
819# 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
820# 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).
821# 863#
864# @CODE
822# Example: get all jars from xerces slot 2 865# Example: get all jars from xerces slot 2
823# java-pkg_jar-from xerces-2 866# java-pkg_jar-from xerces-2
867#
824# Example: get a specific jar from xerces slot 2 868# Example: get a specific jar from xerces slot 2
825# java-pkg_jar-from xerces-2 xml-apis.jar 869# java-pkg_jar-from xerces-2 xml-apis.jar
870#
826# 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
827# java-pkg_jar-from xerces-2 xml-apis.jar xml.jar 872# java-pkg_jar-from xerces-2 xml-apis.jar xml.jar
873#
828# Example: get junit.jar which is needed only for building 874# Example: get junit.jar which is needed only for building
829# java-pkg_jar-from --build-only junit junit.jar 875# java-pkg_jar-from --build-only junit junit.jar
876# @CODE
830# 877#
831# @param $opt 878# @CODE
879# Parameters
832# --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.
833# (assumed automatically when called inside src_test) 881# (assumed automatically when called inside src_test)
834# --with-dependencies - get jars also from requested package's dependencies 882# --with-dependencies - get jars also from requested package's dependencies
835# 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.
836# --into $dir - symlink jar(s) into $dir (must exist) instead of . 886# --into $dir - symlink jar(s) into $dir (must exist) instead of .
837# @param $1 - Package to get jars from, or comma-separated list of packages in 887# $1 - Package to get jars from, or comma-separated list of packages in
838# case other parameters are not used. 888# case other parameters are not used.
839# @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.
840# @param $3 - When a single jar is specified, destination filename of the 890# $3 - When a single jar is specified, destination filename of the
841# symlink. Defaults to the name of the jar. 891# symlink. Defaults to the name of the jar.
842# ------------------------------------------------------------------------------ 892# @CODE
893
843# TODO could probably be cleaned up a little 894# TODO could probably be cleaned up a little
844java-pkg_jar-from() { 895java-pkg_jar-from() {
845 debug-print-function ${FUNCNAME} $* 896 debug-print-function ${FUNCNAME} $*
846 897
847 local build_only="" 898 local build_only=""
848 local destdir="." 899 local destdir="."
849 local deep="" 900 local deep=""
901 local virtual=""
902 local record_jar=""
850 903
851 [[ "${EBUILD_PHASE}" == "test" ]] && build_only="build" 904 [[ "${EBUILD_PHASE}" == "test" ]] && build_only="build"
852 905
853 while [[ "${1}" == --* ]]; do 906 while [[ "${1}" == --* ]]; do
854 if [[ "${1}" = "--build-only" ]]; then 907 if [[ "${1}" = "--build-only" ]]; then
855 build_only="build" 908 build_only="build"
856 elif [[ "${1}" = "--with-dependencies" ]]; then 909 elif [[ "${1}" = "--with-dependencies" ]]; then
857 deep="--with-dependencies" 910 deep="--with-dependencies"
911 elif [[ "${1}" = "--virtual" ]]; then
912 virtual="true"
858 elif [[ "${1}" = "--into" ]]; then 913 elif [[ "${1}" = "--into" ]]; then
859 destdir="${2}" 914 destdir="${2}"
860 shift 915 shift
861 else 916 else
862 die "java-pkg_jar-from called with unknown parameter: ${1}" 917 die "java-pkg_jar-from called with unknown parameter: ${1}"
865 done 920 done
866 921
867 local target_pkg="${1}" target_jar="${2}" destjar="${3}" 922 local target_pkg="${1}" target_jar="${2}" destjar="${3}"
868 923
869 [[ -z ${target_pkg} ]] && die "Must specify a package" 924 [[ -z ${target_pkg} ]] && die "Must specify a package"
925
926 if [[ "${EAPI}" == "1" ]]; then
927 target_pkg="${target_pkg//:/-}"
928 fi
870 929
871 # default destjar to the target jar 930 # default destjar to the target jar
872 [[ -z "${destjar}" ]] && destjar="${target_jar}" 931 [[ -z "${destjar}" ]] && destjar="${target_jar}"
873 932
874 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}."
883 for pkg in ${target_pkg//,/ }; do 942 for pkg in ${target_pkg//,/ }; do
884 java-pkg_ensure-dep "${build_only}" "${pkg}" 943 java-pkg_ensure-dep "${build_only}" "${pkg}"
885 [[ -z "${build_only}" ]] && java-pkg_record-jar_ "${pkg}" 944 [[ -z "${build_only}" ]] && java-pkg_record-jar_ "${pkg}"
886 done 945 done
887 # setting this disables further record-jar_ calls later 946 # setting this disables further record-jar_ calls later
888 build_only="build" 947 record_jar="true"
889 else 948 else
890 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"
891 fi 958 fi
892 959
893 pushd ${destdir} > /dev/null \ 960 pushd ${destdir} > /dev/null \
894 || die "failed to change directory to ${destdir}" 961 || die "failed to change directory to ${destdir}"
895 962
903 # If no specific target jar was indicated, link it 970 # If no specific target jar was indicated, link it
904 if [[ -z "${target_jar}" ]] ; then 971 if [[ -z "${target_jar}" ]] ; then
905 [[ -f "${target_jar}" ]] && rm "${target_jar}" 972 [[ -f "${target_jar}" ]] && rm "${target_jar}"
906 ln -snf "${jar}" \ 973 ln -snf "${jar}" \
907 || 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
908 [[ -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
909 # otherwise, if the current jar is the target jar, link it 982 # otherwise, if the current jar is the target jar, link it
910 elif [[ "${jar_name}" == "${target_jar}" ]] ; then 983 elif [[ "${jar_name}" == "${target_jar}" ]] ; then
911 [[ -f "${destjar}" ]] && rm "${destjar}" 984 [[ -f "${destjar}" ]] && rm "${destjar}"
912 ln -snf "${jar}" "${destjar}" \ 985 ln -snf "${jar}" "${destjar}" \
913 || 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
914 [[ -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
915 popd > /dev/null 994 popd > /dev/null
916 return 0 995 return 0
917 fi 996 fi
918 done 997 done
919 popd > /dev/null 998 popd > /dev/null
924 else 1003 else
925 die "Failed to find ${target_jar:-jar} in ${target_pkg}" 1004 die "Failed to find ${target_jar:-jar} in ${target_pkg}"
926 fi 1005 fi
927} 1006}
928 1007
929# ------------------------------------------------------------------------------ 1008# @FUNCTION: java-pkg_jarfrom
930# @ebuild-function java-pkg_jarfrom 1009# @DESCRIPTION:
931#
932# See java-pkg_jar-from 1010# See java-pkg_jar-from
933# ------------------------------------------------------------------------------
934java-pkg_jarfrom() { 1011java-pkg_jarfrom() {
935 java-pkg_jar-from "$@" 1012 java-pkg_jar-from "$@"
936} 1013}
937 1014
938# ------------------------------------------------------------------------------ 1015# @FUNCTION: java-pkg_getjars
939# @ebuild-function java-pkg_getjars 1016# @USAGE: [--build-only] [--with-dependencies] <package1>[,<package2>...]
940# 1017# @DESCRIPTION:
941# Get the classpath provided by any number of packages 1018# Get the classpath provided by any number of packages
942# 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'.
943# The providing packages are recorded as dependencies into package.env DEPEND 1020# The providing packages are recorded as dependencies into package.env DEPEND
944# line, unless "--build-only" is passed as the very first argument, for jars 1021# line, unless "--build-only" is passed as the very first argument, for jars
945# that have to be present only at build time and are not needed on runtime 1022# that have to be present only at build time and are not needed on runtime
946# (junit testing etc). 1023# (junit testing etc).
947# 1024#
1025# @CODE
948# Example: Get the classpath for xerces-2 and xalan, 1026# Example: Get the classpath for xerces-2 and xalan,
949# java-pkg_getjars xerces-2,xalan 1027# java-pkg_getjars xerces-2,xalan
1028#
950# Example Return: 1029# Example Return:
951# /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
952# 1031#
953# @param $opt 1032#
1033# Parameters:
954# --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.
955# (assumed automatically when called inside src_test) 1035# (assumed automatically when called inside src_test)
956# --with-dependencies - get jars also from requested package's dependencies 1036# --with-dependencies - get jars also from requested package's dependencies
957# transitively. 1037# transitively.
958# @param $1 - list of packages to get jars from 1038# $1 - list of packages to get jars from
959# (passed to java-config --classpath) 1039# (passed to java-config --classpath)
960# ------------------------------------------------------------------------------ 1040# @CODE
961java-pkg_getjars() { 1041java-pkg_getjars() {
962 debug-print-function ${FUNCNAME} $* 1042 debug-print-function ${FUNCNAME} $*
963 1043
964 local build_only="" 1044 local build_only=""
965 local deep="" 1045 local deep=""
978 done 1058 done
979 1059
980 [[ ${#} -ne 1 ]] && die "${FUNCNAME} takes only one argument besides --*" 1060 [[ ${#} -ne 1 ]] && die "${FUNCNAME} takes only one argument besides --*"
981 1061
982 1062
983 local classpath pkgs="${1}" 1063 local pkgs="${1}"
1064
1065 if [[ "${EAPI}" == "1" ]]; then
1066 pkgs="${pkgs//:/-}"
1067 fi
1068
984 jars="$(java-config ${deep} --classpath=${pkgs})" 1069 jars="$(java-config ${deep} --classpath=${pkgs})"
985 [[ $? != 0 || -z "${jars}" ]] && die "java-config --classpath=${pkgs} failed" 1070 [[ $? != 0 ]] && die "java-config --classpath=${pkgs} failed"
986 debug-print "${pkgs}:${jars}" 1071 debug-print "${pkgs}:${jars}"
987 1072
988 for pkg in ${pkgs//,/ }; do 1073 for pkg in ${pkgs//,/ }; do
989 java-pkg_ensure-dep "${build_only}" "${pkg}" 1074 java-pkg_ensure-dep "${build_only}" "${pkg}"
990 done 1075 done
991 1076
992 if [[ -z "${classpath}" ]]; then 1077 for pkg in ${pkgs//,/ }; do
993 classpath="${jars}"
994 else
995 classpath="${classpath}:${jars}"
996 fi
997
998 # Only record jars that aren't build-only
999 if [[ -z "${build_only}" ]]; then 1078 if [[ -z "${build_only}" ]]; then
1000 oldifs="${IFS}"
1001 IFS=","
1002 for pkg in ${pkgs}; do
1003 java-pkg_record-jar_ "${pkg}" 1079 java-pkg_record-jar_ "${pkg}"
1080 else
1081 java-pkg_record-jar_ --build-only "${pkg}"
1082 fi
1004 done 1083 done
1005 IFS="${oldifs}"
1006 fi
1007 1084
1008 echo "${classpath}" 1085 echo "${jars}"
1009} 1086}
1010 1087
1011# ------------------------------------------------------------------------------ 1088# @FUNCTION: java-pkg_getjar
1012# @ebuild-function java-pkg_getjar 1089# @USAGE: [--build-only] [--virtual] <package> <jarfile>
1013# 1090# @DESCRIPTION:
1014# Get the filename of a single jar from a package 1091# Get the complete path of a single jar from a package
1015# The providing package is recorded as runtime dependency into package.env 1092# The providing package is recorded as runtime dependency into package.env
1016# 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
1017# 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
1018# (junit testing etc). 1095# (junit testing etc).
1019# 1096#
1097# @CODE
1020# @example 1098# Example:
1021# java-pkg_getjar xerces-2 xml-apis.jar 1099# java-pkg_getjar xerces-2 xml-apis.jar
1022# @example-return 1100# returns
1023# /usr/share/xerces-2/lib/xml-apis.jar 1101# /usr/share/xerces-2/lib/xml-apis.jar
1024# 1102#
1025# @param $opt 1103# Parameters:
1026# --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.
1027# @param $1 - package to use 1107# $1 - package to use
1028# @param $2 - jar to get 1108# $2 - jar to get
1029# ------------------------------------------------------------------------------ 1109# @CODE
1030java-pkg_getjar() { 1110java-pkg_getjar() {
1031 debug-print-function ${FUNCNAME} $* 1111 debug-print-function ${FUNCNAME} $*
1032 1112
1033 local build_only="" 1113 local build_only=""
1114 local virtual=""
1115 local record_jar=""
1034 1116
1035 [[ "${EBUILD_PHASE}" == "test" ]] && build_only="build" 1117 [[ "${EBUILD_PHASE}" == "test" ]] && build_only="build"
1036 1118
1037 while [[ "${1}" == --* ]]; do 1119 while [[ "${1}" == --* ]]; do
1038 if [[ "${1}" = "--build-only" ]]; then 1120 if [[ "${1}" = "--build-only" ]]; then
1039 build_only="build" 1121 build_only="build"
1122 elif [[ "${1}" == "--virtual" ]]; then
1123 virtual="true"
1040 else 1124 else
1041 die "java-pkg_jar-from called with unknown parameter: ${1}" 1125 die "java-pkg_getjar called with unknown parameter: ${1}"
1042 fi 1126 fi
1043 shift 1127 shift
1044 done 1128 done
1045 1129
1046 [[ ${#} -ne 2 ]] && die "${FUNCNAME} takes only two arguments besides --*" 1130 [[ ${#} -ne 2 ]] && die "${FUNCNAME} takes only two arguments besides --*"
1047 1131
1048 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
1049 [[ -z ${pkg} ]] && die "Must specify package to get a jar from" 1138 [[ -z ${pkg} ]] && die "Must specify package to get a jar from"
1050 [[ -z ${target_jar} ]] && die "Must specify jar to get" 1139 [[ -z ${target_jar} ]] && die "Must specify jar to get"
1051 1140
1052 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?"
1053 local classpath 1142 local classpath
1054 classpath=$(java-config --classpath=${pkg}) 1143 classpath=$(java-config --classpath=${pkg})
1055 [[ $? != 0 ]] && die ${error_msg} 1144 [[ $? != 0 ]] && die ${error_msg}
1056 1145
1057 java-pkg_ensure-dep "${build_only}" "${pkg}" 1146 java-pkg_ensure-dep "${build_only}" "${pkg}"
1058 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
1059 for jar in ${classpath//:/ }; do 1159 for jar in ${classpath//:/ }; do
1060 if [[ ! -f "${jar}" ]] ; then 1160 if [[ ! -f "${jar}" ]] ; then
1061 die "Installation problem with jar ${jar} in ${pkg} - is it installed?" 1161 die "Installation problem with jar ${jar} in ${pkg} - is it installed?"
1062 fi 1162 fi
1063 1163
1064 if [[ "$(basename ${jar})" == "${target_jar}" ]] ; then 1164 if [[ "$(basename ${jar})" == "${target_jar}" ]] ; then
1065 # Only record jars that aren't build-only 1165 # Only record jars that aren't build-only
1066 [[ -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
1067 echo "${jar}" 1173 echo "${jar}"
1068 return 0 1174 return 0
1069 fi 1175 fi
1070 done 1176 done
1071 1177
1072 die "Could not find ${target_jar} in ${pkg}" 1178 die "Could not find ${target_jar} in ${pkg}"
1073 return 1 1179 return 1
1074} 1180}
1075 1181
1076# ------------------------------------------------------------------------------ 1182# @FUNCTION: java-pkg_register-dependency
1077# @ebuild-function java-pkg_register-dependency 1183# @USAGE: <package>[,<package2>...] [<jarfile>]
1078# 1184# @DESCRIPTION:
1079# Registers runtime dependency on a package, list of packages, or a single jar 1185# Registers runtime dependency on a package, list of packages, or a single jar
1080# from a package, into package.env DEPEND line. Can only be called in 1186# from a package, into package.env DEPEND line. Can only be called in
1081# src_install phase. 1187# src_install phase.
1082# Intended for binary packages where you don't need to symlink the jars or get 1188# Intended for binary packages where you don't need to symlink the jars or get
1083# their classpath during build. As such, the dependencies only need to be 1189# their classpath during build. As such, the dependencies only need to be
1084# specified in ebuild's RDEPEND, and should be omitted in DEPEND. 1190# specified in ebuild's RDEPEND, and should be omitted in DEPEND.
1085# Get the classpath provided by any number of packages.
1086# 1191#
1192# @CODE
1193# Parameters:
1087# @param $1 - comma-separated list of packages, or a single package 1194# $1 - comma-separated list of packages, or a single package
1088# @param $2 - if param $1 is a single package, optionally specify the jar 1195# $2 - if param $1 is a single package, optionally specify the jar
1089# to depend on 1196# to depend on
1090# 1197#
1198# Examples:
1091# Example: Record the dependency on whole xerces-2 and xalan, 1199# Record the dependency on whole xerces-2 and xalan,
1092# java-pkg_register-dependency xerces-2,xalan 1200# java-pkg_register-dependency xerces-2,xalan
1201#
1093# Example: Record the dependency on ant.jar from ant-core 1202# Record the dependency on ant.jar from ant-core
1094# java-pkg_register-dependency ant-core ant.jar 1203# java-pkg_register-dependency ant-core ant.jar
1204# @CODE
1095# 1205#
1096# Note: Passing both list of packages as the first parameter AND specifying the 1206# Note: Passing both list of packages as the first parameter AND specifying the
1097# jar as the second is not allowed and will cause the function to die. We assume 1207# jar as the second is not allowed and will cause the function to die. We assume
1098# that there's more chance one passes such combination as a mistake, than that 1208# that there's more chance one passes such combination as a mistake, than that
1099# there are more packages providing identically named jar without class 1209# there are more packages providing identically named jar without class
1100# collisions. 1210# collisions.
1101# ------------------------------------------------------------------------------
1102java-pkg_register-dependency() { 1211java-pkg_register-dependency() {
1103 debug-print-function ${FUNCNAME} $* 1212 debug-print-function ${FUNCNAME} $*
1104 1213
1105 java-pkg_check-phase install 1214 java-pkg_check-phase install
1106 1215
1108 1217
1109 local pkgs="${1}" 1218 local pkgs="${1}"
1110 local jar="${2}" 1219 local jar="${2}"
1111 1220
1112 [[ -z "${pkgs}" ]] && die "${FUNCNAME} called with no package(s) specified" 1221 [[ -z "${pkgs}" ]] && die "${FUNCNAME} called with no package(s) specified"
1222
1223 if [[ "${EAPI}" == "1" ]]; then
1224 pkgs="${pkgs//:/-}"
1225 fi
1113 1226
1114 if [[ -z "${jar}" ]]; then 1227 if [[ -z "${jar}" ]]; then
1115 for pkg in ${pkgs//,/ }; do 1228 for pkg in ${pkgs//,/ }; do
1116 java-pkg_ensure-dep runtime "${pkg}" 1229 java-pkg_ensure-dep runtime "${pkg}"
1117 java-pkg_record-jar_ "${pkg}" 1230 java-pkg_record-jar_ "${pkg}"
1121 die "${FUNCNAME} called with both package list and jar name" 1234 die "${FUNCNAME} called with both package list and jar name"
1122 java-pkg_ensure-dep runtime "${pkgs}" 1235 java-pkg_ensure-dep runtime "${pkgs}"
1123 java-pkg_record-jar_ "${pkgs}" "${jar}" 1236 java-pkg_record-jar_ "${pkgs}" "${jar}"
1124 fi 1237 fi
1125 1238
1126 java-pkg_do_write_ 1239 java-pkg_do_write_
1127} 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
1128 1346
1129# 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
1130# populate jars from the filesystem. 1348# populate jars from the filesystem.
1131# 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
1132# string that was built instead of stdin 1350# string that was built instead of stdin
1160# 1378#
1161# read line 1379# read line
1162# done 1380# done
1163#} 1381#}
1164 1382
1165# ------------------------------------------------------------------------------ 1383# @FUNCTION: java-pkg_find-normal-jars
1166# @section-end query 1384# @USAGE: [<path/to/directory>]
1167# ------------------------------------------------------------------------------ 1385# @DESCRIPTION:
1168
1169# ------------------------------------------------------------------------------
1170# @section-begin helper
1171# @section-summary Helper functions
1172#
1173# Various other functions to use from an ebuild
1174# ------------------------------------------------------------------------------
1175
1176# ------------------------------------------------------------------------------
1177# @ebuild-function java-pkg_need
1178#
1179# Adds virtual dependencies, which can optionally be controlled by a USE flag.
1180# Currently supported virtuals are:
1181# javamail
1182# jdbc-stdext
1183# jaf
1184# jdbc-rowset
1185# jms
1186#
1187# @param $1 - Optionally indicate that the dependencies are controlled by
1188# a use flag by specifying '--use' Requires $2.
1189# @param $2 - USE flag which will enable the dependencies.
1190# @param $@ - virtual packages to add depenedencies for
1191# ------------------------------------------------------------------------------
1192# TODO rewrite to parse a line based declaration file instead -- karltk
1193#java-pkg_need() {
1194# debug-print-function ${FUNCNAME} $*
1195# local useflag
1196# if [[ ${1} == "--use" ]]; then
1197# useflag="${2}"
1198# shift 2
1199# fi
1200#
1201# if [[ -z ${1} ]]; then
1202# die "Must specify at least one virtual package."
1203# fi
1204#
1205# local depstr newdepstr
1206#
1207# for virtual in ${@}; do
1208# if has ${virtual} ${JAVA_PKG_VNEED}; then
1209# debug-print "Already registered virtual ${virtual}"
1210# continue
1211# fi
1212# case ${virtual} in
1213# javamail)
1214# debug-print "java-pkg_need: adding javamail dependencies"
1215# newdepstr="|| ( dev-java/gnu-javamail dev-java/sun-javamail-bin )"
1216# ;;
1217# jdbc-stdext)
1218# debug-print "java-pkg_need: adding jdbc-stdext dependencies"
1219# newdepstr="|| ( >=virtual/jdk-1.4 dev-java/jdbc2-stdext )"
1220# ;;
1221# jaf)
1222# debug-print "java-pkg_need: adding jaf dependencies"
1223# newdepstr="|| ( dev-java/gnu-jaf dev-java/sun-jaf-bin )"
1224# ;;
1225# jdbc-rowset)
1226# debug-print "java-pkg_need: adding jdbc-rowset dependencies"
1227# newdepstr="|| ( >=virtual/jdk-1.5 dev-java/sun-jdbc-rowset )"
1228# ;;
1229# jms)
1230# debug-print "java-pkg_need: adding jms dependencies"
1231# newdepstr="|| ( dev-java/sun-jms dev-java/openjms )"
1232# ;;
1233# *)
1234# die "Invalid virtual: ${virtual}"
1235# esac
1236#
1237# export JAVA_PKG_VNEED="${JAVA_PKG_VNEED} ${virtual}"
1238#
1239# if [[ -n ${useflag} ]]; then
1240# depstr="${depstr} ${useflag}? ( ${newdepstr} )"
1241# else
1242# depstr="${depstr} ${newdepstr}"
1243# fi
1244# done
1245#
1246# [[ -z ${JAVA_PKG_NV_DEPEND} ]] && export JAVA_PKG_NV_DEPEND="${DEPEND}"
1247# [[ -z ${JAVA_PKG_NV_RDEPEND} ]] && export JAVA_PKG_NV_RDEPEND="${RDEPEND}"
1248#
1249# export DEPEND="${DEPEND} ${depstr}"
1250# export RDEPEND="${RDEPEND} ${depstr}"
1251#}
1252
1253# ------------------------------------------------------------------------------
1254# @ebuild-function java-pkg_find-normal-jars
1255#
1256# 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)
1257#
1258# @param $1 - The directory to search for jar files (default: ${WORKDIR})
1259# ------------------------------------------------------------------------------
1260java-pkg_find-normal-jars() { 1387java-pkg_find-normal-jars() {
1261 local dir=$1 1388 local dir=$1
1262 [[ "${dir}" ]] || dir="${WORKDIR}" 1389 [[ "${dir}" ]] || dir="${WORKDIR}"
1263 local found 1390 local found
1264 for jar in $(find "${dir}" -name "*.jar" -type f); do 1391 for jar in $(find "${dir}" -name "*.jar" -type f); do
1267 done 1394 done
1268 [[ "${found}" ]] 1395 [[ "${found}" ]]
1269 return $? 1396 return $?
1270} 1397}
1271 1398
1272# ------------------------------------------------------------------------------ 1399# @FUNCTION: java-pkg_ensure-no-bundled-jars
1273# @ebuild-function java-pkg_ensure-no-bundled-jars 1400# @DESCRIPTION:
1274#
1275# 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.
1276# 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
1277# to system jar files or bundled jars removed. 1403# to system jar files or bundled jars removed.
1278# ------------------------------------------------------------------------------
1279java-pkg_ensure-no-bundled-jars() { 1404java-pkg_ensure-no-bundled-jars() {
1280 debug-print-function ${FUNCNAME} $* 1405 debug-print-function ${FUNCNAME} $*
1281 1406
1282 local bundled_jars=$(java-pkg_find-normal-jars) 1407 local bundled_jars=$(java-pkg_find-normal-jars)
1283 if [[ -n ${bundled_jars} ]]; then 1408 if [[ -n ${bundled_jars} ]]; then
1288 done 1413 done
1289 die "Bundled jars found!" 1414 die "Bundled jars found!"
1290 fi 1415 fi
1291} 1416}
1292 1417
1293# ------------------------------------------------------------------------------
1294# @internal-function java-pkg_ensure-vm-version-sufficient 1418# @FUNCTION: java-pkg_ensure-vm-version-sufficient
1295# 1419# @INTERNAL
1420# @DESCRIPTION:
1296# 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.
1297#
1298# ------------------------------------------------------------------------------
1299java-pkg_ensure-vm-version-sufficient() { 1422java-pkg_ensure-vm-version-sufficient() {
1300 debug-print-function ${FUNCNAME} $* 1423 debug-print-function ${FUNCNAME} $*
1301 1424
1302 if ! java-pkg_is-vm-version-sufficient; then 1425 if ! java-pkg_is-vm-version-sufficient; then
1303 debug-print "VM is not suffient" 1426 debug-print "VM is not suffient"
1305 einfo "Please use java-config -S to set the correct one" 1428 einfo "Please use java-config -S to set the correct one"
1306 die "Active Java VM cannot build this package" 1429 die "Active Java VM cannot build this package"
1307 fi 1430 fi
1308} 1431}
1309 1432
1310# ------------------------------------------------------------------------------ 1433# @FUNCTION: java-pkg_is-vm-version-sufficient
1311# @internal-function java-pkg_is-vm-version-sufficient 1434# @INTERNAL
1312# 1435# @DESCRIPTION:
1313# @return zero - VM is sufficient 1436# @RETURN: zero - VM is sufficient; non-zero - VM is not sufficient
1314# @return non-zero - VM is not sufficient
1315# ------------------------------------------------------------------------------
1316java-pkg_is-vm-version-sufficient() { 1437java-pkg_is-vm-version-sufficient() {
1317 debug-print-function ${FUNCNAME} $* 1438 debug-print-function ${FUNCNAME} $*
1318 1439
1319 depend-java-query --is-sufficient "${DEPEND}" > /dev/null 1440 depend-java-query --is-sufficient "${DEPEND}" > /dev/null
1320 return $? 1441 return $?
1321} 1442}
1322 1443
1323# ------------------------------------------------------------------------------ 1444# @FUNCTION: java-pkg_ensure-vm-version-eq
1324# @internal-function java-pkg_ensure-vm-version-eq 1445# @INTERNAL
1325# 1446# @DESCRIPTION:
1326# 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.
1327# 1448#
1328# @param $@ - Desired VM version to ensure 1449# @param $@ - Desired VM version to ensure
1329# ------------------------------------------------------------------------------
1330java-pkg_ensure-vm-version-eq() { 1450java-pkg_ensure-vm-version-eq() {
1331 debug-print-function ${FUNCNAME} $* 1451 debug-print-function ${FUNCNAME} $*
1332 1452
1333 if ! java-pkg_is-vm-version-eq $@ ; then 1453 if ! java-pkg_is-vm-version-eq $@ ; then
1334 debug-print "VM is not suffient" 1454 debug-print "VM is not suffient"
1336 einfo "Please use java-config -S to set the correct one" 1456 einfo "Please use java-config -S to set the correct one"
1337 die "Active Java VM too old" 1457 die "Active Java VM too old"
1338 fi 1458 fi
1339} 1459}
1340 1460
1341# ------------------------------------------------------------------------------ 1461# @FUNCTION: java-pkg_is-vm-version-eq
1342# @internal-function java-pkg_is-vm-version-eq 1462# @USAGE: <version>
1343# 1463# @INTERNAL
1344# @param $@ - VM version to compare current VM to 1464# @RETURN: zero - VM versions are equal; non-zero - VM version are not equal
1345# @return zero - VM versions are equal
1346# @return non-zero - VM version are not equal
1347# ------------------------------------------------------------------------------
1348java-pkg_is-vm-version-eq() { 1465java-pkg_is-vm-version-eq() {
1349 debug-print-function ${FUNCNAME} $* 1466 debug-print-function ${FUNCNAME} $*
1350 1467
1351 local needed_version="$@" 1468 local needed_version="$@"
1352 1469
1369 return 1 1486 return 1
1370 fi 1487 fi
1371 fi 1488 fi
1372} 1489}
1373 1490
1374# ------------------------------------------------------------------------------ 1491# @FUNCTION: java-pkg_ensure-vm-version-ge
1375# @internal-function java-pkg_ensure-vm-version-ge 1492# @INTERNAL
1376# 1493# @DESCRIPTION:
1377# 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
1378# 1495#
1379# @param $@ - VM version to compare current to 1496# @param $@ - VM version to compare current to
1380# ------------------------------------------------------------------------------
1381java-pkg_ensure-vm-version-ge() { 1497java-pkg_ensure-vm-version-ge() {
1382 debug-print-function ${FUNCNAME} $* 1498 debug-print-function ${FUNCNAME} $*
1383 1499
1384 if ! java-pkg_is-vm-version-ge "$@" ; then 1500 if ! java-pkg_is-vm-version-ge "$@" ; then
1385 debug-print "vm is not suffient" 1501 debug-print "vm is not suffient"
1387 einfo "Please use java-config -S to set the correct one" 1503 einfo "Please use java-config -S to set the correct one"
1388 die "Active Java VM too old" 1504 die "Active Java VM too old"
1389 fi 1505 fi
1390} 1506}
1391 1507
1392# ------------------------------------------------------------------------------ 1508# @FUNCTION: java-pkg_is-vm-version-ge
1393# @internal-function java-pkg_is-vm-version-ge 1509# @INTERNAL
1394# 1510# @DESCRIPTION:
1511# @CODE
1512# Parameters:
1395# @param $@ - VM version to compare current VM to 1513# $@ - VM version to compare current VM to
1514# @CODE
1396# @return zero - current VM version is greater than checked version 1515# @RETURN: zero - current VM version is greater than checked version;
1397# @return non-zero - current VM version is not greater than checked version 1516# non-zero - current VM version is not greater than checked version
1398# ------------------------------------------------------------------------------
1399java-pkg_is-vm-version-ge() { 1517java-pkg_is-vm-version-ge() {
1400 debug-print-function ${FUNCNAME} $* 1518 debug-print-function ${FUNCNAME} $*
1401 1519
1402 local needed_version=$@ 1520 local needed_version=$@
1403 local vm_version=$(java-pkg_get-vm-version) 1521 local vm_version=$(java-pkg_get-vm-version)
1422java-pkg_get-current-vm() { 1540java-pkg_get-current-vm() {
1423 echo ${GENTOO_VM} 1541 echo ${GENTOO_VM}
1424} 1542}
1425 1543
1426java-pkg_current-vm-matches() { 1544java-pkg_current-vm-matches() {
1427 hasq $(java-pkg_get-current-vm) ${@} 1545 has $(java-pkg_get-current-vm) ${@}
1428 return $? 1546 return $?
1429} 1547}
1430 1548
1431# ------------------------------------------------------------------------------ 1549# @FUNCTION: java-pkg_get-source
1432# @ebuild-function java-pkg_get-source 1550# @DESCRIPTION:
1433#
1434# Determines what source version should be used, for passing to -source. 1551# Determines what source version should be used, for passing to -source.
1435# 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
1436# 1553#
1437# @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
1438# ------------------------------------------------------------------------------
1439java-pkg_get-source() { 1555java-pkg_get-source() {
1440 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}")}
1441} 1557}
1442 1558
1443# ------------------------------------------------------------------------------ 1559# @FUNCTION: java-pkg_get-target
1444# @ebuild-function java-pkg_get-target 1560# @DESCRIPTION:
1445#
1446# Determines what target version should be used, for passing to -target. 1561# Determines what target version should be used, for passing to -target.
1447# 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
1448# version of your JDK. 1563# version of your JDK.
1449# 1564#
1450# @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
1451# ------------------------------------------------------------------------------
1452java-pkg_get-target() { 1566java-pkg_get-target() {
1453 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}")}
1454} 1568}
1455 1569
1570# @FUNCTION: java-pkg_get-javac
1571# @DESCRIPTION:
1572# Returns the compiler executable
1456java-pkg_get-javac() { 1573java-pkg_get-javac() {
1457 debug-print-function ${FUNCNAME} $* 1574 debug-print-function ${FUNCNAME} $*
1458 1575
1459 1576
1460 local compiler="${GENTOO_COMPILER}" 1577 local compiler="${GENTOO_COMPILER}"
1490 fi 1607 fi
1491 fi 1608 fi
1492 echo ${compiler_executable} 1609 echo ${compiler_executable}
1493} 1610}
1494 1611
1495# ------------------------------------------------------------------------------ 1612# @FUNCTION: java-pkg_javac-args
1496# @ebuild-function java-pkg_javac-args 1613# @DESCRIPTION:
1497#
1498# 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
1499# to know what -source/-target to use. 1615# to know what -source/-target to use.
1500# 1616#
1501# @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
1502# ------------------------------------------------------------------------------
1503java-pkg_javac-args() { 1618java-pkg_javac-args() {
1504 debug-print-function ${FUNCNAME} $* 1619 debug-print-function ${FUNCNAME} $*
1505 1620
1506 local want_source="$(java-pkg_get-source)" 1621 local want_source="$(java-pkg_get-source)"
1507 local want_target="$(java-pkg_get-target)" 1622 local want_target="$(java-pkg_get-target)"
1515 if [[ -z "${want_source}" || -z "${want_target}" ]]; then 1630 if [[ -z "${want_source}" || -z "${want_target}" ]]; then
1516 debug-print "could not find valid -source/-target values for javac" 1631 debug-print "could not find valid -source/-target values for javac"
1517 echo "Could not find valid -source/-target values for javac" 1632 echo "Could not find valid -source/-target values for javac"
1518 return 1 1633 return 1
1519 else 1634 else
1520 if java-pkg_is-vm-version-ge "1.4"; then
1521 echo "${source_str} ${target_str}" 1635 echo "${source_str} ${target_str}"
1522 else
1523 echo "${target_str}"
1524 fi 1636 fi
1525 fi
1526} 1637}
1527 1638
1528# TODO document 1639# @FUNCTION: java-pkg_get-jni-cflags
1640# @DESCRIPTION:
1641# Echos the CFLAGS for JNI compilations
1529java-pkg_get-jni-cflags() { 1642java-pkg_get-jni-cflags() {
1530 local flags="-I${JAVA_HOME}/include" 1643 local flags="-I${JAVA_HOME}/include"
1531 1644
1532 local platform="linux" 1645 local platform="linux"
1533 use elibc_FreeBSD && platform="freebsd" 1646 use elibc_FreeBSD && platform="freebsd"
1537 1650
1538 echo ${flags} 1651 echo ${flags}
1539} 1652}
1540 1653
1541java-pkg_ensure-gcj() { 1654java-pkg_ensure-gcj() {
1542 if ! built_with_use sys-devel/gcc gcj ; then 1655 # was enforcing sys-devel/gcc[gcj]
1543 ewarn 1656 die "${FUNCNAME} was removed. Use use-deps available as of EAPI 2 instead. #261562"
1544 ewarn "You must build gcc with the gcj support to build with gcj"
1545 ewarn
1546 ebeep 5
1547 die "No GCJ support found!"
1548 fi
1549} 1657}
1550 1658
1551java-pkg_ensure-test() { 1659java-pkg_ensure-test() {
1552 if hasq test ${FEATURES} && ! hasq -test ${FEATURES} \ 1660 # was enforcing USE=test if FEATURES=test
1553 && hasq test ${IUSE} && ! use test; 1661 die "${FUNCNAME} was removed. Package mangers handle this already. #278965"
1554 then
1555 eerror "You specified FEATURES=test, but USE=test is needed"
1556 eerror "to pull in the additional dependencies for testing"
1557 die "Need USE=test enabled"
1558 fi
1559} 1662}
1560 1663
1561# ------------------------------------------------------------------------------ 1664# @FUNCTION: java-pkg_register-ant-task
1562# @ebuild-function java-pkg_register-ant-task 1665# @USAGE: [--version x.y] [<name>]
1563# 1666# @DESCRIPTION:
1564# 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
1565# 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
1566# 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
1567# 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
1568# .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
1569# compatibility. 1672# compatibility.
1570# 1673#
1674# @CODE
1675# Parameters
1571# @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
1572# version). Used by the ant-* packages to prevent loading of mismatched 1677# version). Used by the ant-* packages to prevent loading of mismatched
1573# 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,
1574# without a need for blockers. 1679# without a need for blockers.
1575# @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])
1576# ------------------------------------------------------------------------------ 1681# @CODE
1577java-pkg_register-ant-task() { 1682java-pkg_register-ant-task() {
1578 local TASKS_DIR="tasks" 1683 local TASKS_DIR="tasks"
1579 1684
1580 # check for --version x.y parameters 1685 # check for --version x.y parameters
1581 while [[ -n "${1}" && -n "${2}" ]]; do 1686 while [[ -n "${1}" && -n "${2}" ]]; do
1593 1698
1594 dodir /usr/share/ant/${TASKS_DIR} 1699 dodir /usr/share/ant/${TASKS_DIR}
1595 touch "${D}/usr/share/ant/${TASKS_DIR}/${TASK_NAME}" 1700 touch "${D}/usr/share/ant/${TASKS_DIR}/${TASK_NAME}"
1596} 1701}
1597 1702
1598# ------------------------------------------------------------------------------ 1703# @FUNCTION: java-pkg_ant-tasks-depend
1599# @internal-function java-pkg_ant-tasks-from-deps 1704# @INTERNAL
1600# 1705# @DESCRIPTION:
1601# Function to determine ANT_TASKS from DEPEND variable for backwards
1602# compatibility with ebuilds that don't set ANT_TASKS before calling eant() or
1603# WANT_ANT_TASKS before inheriting java-pkg-2. If the DEPEND string contains
1604# "dev-java/ant" or "dev-java/ant-tasks", then it returns "all", otherwise
1605# "none". It's not smart enough to cope with USE flag depends but that shouldn't
1606# be a problem, the worst it can do is activace all tasks when not needed.
1607# Note that this is called only with JAVA_PKG_STRICT=1, to find ebuilds with
1608# insufficient dependencies, otherwise all available tasks are used for
1609# backwards compatilbility.
1610#
1611# @return "all" or "none"
1612# ------------------------------------------------------------------------------
1613java-pkg_ant-tasks-from-deps() {
1614 local found_ant found_ant_tasks
1615
1616 for dep in ${DEPEND}
1617 do
1618 local ant="$(awk '/(dev-java\/ant)/ { if (match($1, "(dev-java/ant)((-[0-9])+|$)", m)) print m[1] }' <<< ${dep})"
1619 [[ "${ant}" == "dev-java/ant" ]] && found_ant=true
1620 [[ "${dep}" == *"ant-tasks"* ]] && found_ant_tasks=true
1621 done
1622
1623 if [[ -n "${found_ant}" || -n "${found_ant_tasks}" ]]; then
1624 java-pkg_announce-qa-violation "The ebuild DEPENDS on deprecated ant or ant-tasks"
1625 echo "all"
1626 else
1627 # ebuild doesn't set ANT_TASKS and doesn't depend on ant-tasks or ant
1628 # so we deactivate all tasks that may be installed
1629 echo "none"
1630 fi
1631}
1632
1633# ------------------------------------------------------------------------------
1634# @internal-function java-pkg_ant-tasks-depend
1635#
1636# Translates the WANT_ANT_TASKS variable into valid dependencies. 1706# Translates the WANT_ANT_TASKS variable into valid dependencies.
1637# ------------------------------------------------------------------------------
1638java-pkg_ant-tasks-depend() { 1707java-pkg_ant-tasks-depend() {
1639 debug-print-function ${FUNCNAME} ${WANT_ANT_TASKS} 1708 debug-print-function ${FUNCNAME} ${WANT_ANT_TASKS}
1640 1709
1641 if [[ -n "${WANT_ANT_TASKS}" ]]; then 1710 if [[ -n "${WANT_ANT_TASKS}" ]]; then
1642 local DEP="" 1711 local DEP=""
1643 for i in ${WANT_ANT_TASKS} 1712 for i in ${WANT_ANT_TASKS}
1644 do 1713 do
1645 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
1646 echo "Invalid atom in WANT_ANT_TASKS: ${i}" 1719 echo "Invalid atom in WANT_ANT_TASKS: ${i}"
1647 return 1 1720 return 1
1648 fi 1721 fi
1649 DEP="${DEP}dev-java/${i} "
1650 done 1722 done
1651 echo ${DEP} 1723 echo ${DEP}
1652 return 0 1724 return 0
1653 else 1725 else
1654 return 0 1726 return 0
1655 fi 1727 fi
1656} 1728}
1657 1729
1658# ------------------------------------------------------------------------------
1659# @section-end helper
1660# ------------------------------------------------------------------------------
1661 1730
1662# ------------------------------------------------------------------------------ 1731# @FUNCTION: ejunit_
1663# @section-begin build 1732# @INTERNAL
1664# @section-summary Build functions 1733# @DESCRIPTION:
1665# 1734# Internal Junit wrapper function. Makes it easier to run the tests and checks for
1666# 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.
1667# wrappers for javac and ant. 1736# @CODE
1668# ------------------------------------------------------------------------------ 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} $*
1669 1745
1670# ------------------------------------------------------------------------------ 1746 local pkgs
1671# @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.
1672# 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:
1673# 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
1674# 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,
1675# variables: 1866# variables:
1867#
1868# @CODE
1869# Variables:
1676# 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
1677# gentoo.classpath property. Be sure to call 1871# gentoo.classpath property. Be sure to call java-ant_rewrite-classpath in src_unpack.
1678# 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!
1679# *ANT_TASKS - used to determine ANT_TASKS before calling Ant. 1875# ANT_TASKS - used to determine ANT_TASKS before calling Ant.
1680# ------------------------------------------------------------------------------ 1876# @CODE
1681eant() { 1877eant() {
1682 debug-print-function ${FUNCNAME} $* 1878 debug-print-function ${FUNCNAME} $*
1683 1879
1684 # FIXME get this working 1880 if [[ ${EBUILD_PHASE} = compile ]]; then
1685# if is-java-strict && [[ ! ${DEPEND} =~ "dev-java/ant" ]]; then 1881 java-ant-2_src_configure
1686# java-pkg_announce-qa-violation \ 1882 java-utils-2_src_prepare
1687# "Using eant, but not depending on dev-java/ant or dev-java/ant-core"
1688# fi 1883 fi
1689 1884
1690 if ! hasq java-ant-2 ${INHERITED} && is-java-strict; then 1885 if ! has java-ant-2 ${INHERITED}; then
1691 local msg="You should inherit java-ant-2 when using eant" 1886 local msg="You should inherit java-ant-2 when using eant"
1692 java-pkg_announce-qa-violation ${msg} 1887 java-pkg_announce-qa-violation "${msg}"
1693 die ${msg}
1694 fi 1888 fi
1695 1889
1696 local antflags="-Dnoget=true -Dmaven.mode.offline=true" 1890 local antflags="-Dnoget=true -Dmaven.mode.offline=true -Dbuild.sysclasspath=ignore"
1697 1891
1698 java-pkg_init-compiler_ 1892 java-pkg_init-compiler_
1699 local compiler="${GENTOO_COMPILER}" 1893 local compiler="${GENTOO_COMPILER}"
1700 1894
1701 local compiler_env="${JAVA_PKG_COMPILER_DIR}/${compiler}" 1895 local compiler_env="${JAVA_PKG_COMPILER_DIR}/${compiler}"
1702
1703 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})"
1704 if [[ "${compiler}" != "javac" && -z "${build_compiler}" ]]; then 1897 if [[ "${compiler}" != "javac" && -z "${build_compiler}" ]]; then
1705 die "ANT_BUILD_COMPILER undefined in ${compiler_env}" 1898 die "ANT_BUILD_COMPILER undefined in ${compiler_env}"
1706 fi 1899 fi
1707 1900
1713 # java-config -p 1906 # java-config -p
1714 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})"
1715 if [[ -n ${build_compiler_deps} ]]; then 1908 if [[ -n ${build_compiler_deps} ]]; then
1716 antflags="${antflags} -lib $(java-config -p ${build_compiler_deps})" 1909 antflags="${antflags} -lib $(java-config -p ${build_compiler_deps})"
1717 fi 1910 fi
1718 fi
1719
1720 if is-java-strict; then
1721 einfo "Disabling system classpath for ant"
1722 antflags="${antflags} -Dbuild.sysclasspath=ignore"
1723 fi 1911 fi
1724 1912
1725 for arg in "${@}"; do 1913 for arg in "${@}"; do
1726 if [[ ${arg} = -lib ]]; then 1914 if [[ ${arg} = -lib ]]; then
1727 if is-java-strict; then 1915 if is-java-strict; then
1736 echo "more info." 1924 echo "more info."
1737 fi 1925 fi
1738 fi 1926 fi
1739 done 1927 done
1740 1928
1741 if has_version ">=dev-java/ant-core-1.7.0"; then 1929 # parse WANT_ANT_TASKS for atoms
1742 # default ANT_TASKS to WANT_ANT_TASKS, if ANT_TASKS is not set explicitly 1930 local want_ant_tasks
1743 ANT_TASKS="${ANT_TASKS:-${WANT_ANT_TASKS}}" 1931 for i in ${WANT_ANT_TASKS}; do
1744 1932 if [[ ${i} = */*:* ]]; then
1745 # override ANT_TASKS with JAVA_PKG_FORCE_ANT_TASKS if it's set 1933 i=${i#*/}
1746 ANT_TASKS="${JAVA_PKG_FORCE_ANT_TASKS:-${ANT_TASKS}}" 1934 i=${i%:0}
1747 1935 want_ant_tasks+="${i/:/-} "
1748 if is-java-strict; then
1749 # if ant-tasks were not set by ebuild or forced, try to determine them from depends
1750 if [[ -z "${ANT_TASKS}" ]]; then
1751 ANT_TASKS="$(java-pkg_ant-tasks-from-deps)"
1752 fi
1753 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
1754 # 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
1755 ANT_TASKS="${ANT_TASKS:-all}" 1947 ANT_TASKS="${ANT_TASKS:-none}"
1756 fi
1757 1948
1758 # 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
1759 if [[ "${ANT_TASKS}" == "all" ]]; then 1950 if [[ "${ANT_TASKS}" == "all" ]]; then
1760 einfo "Using all available ANT_TASKS" 1951 einfo "Using all available ANT_TASKS"
1761 elif [[ "${ANT_TASKS}" == "none" ]]; then 1952 elif [[ "${ANT_TASKS}" == "none" ]]; then
1762 einfo "Disabling all optional ANT_TASKS" 1953 einfo "Disabling all optional ANT_TASKS"
1763 else 1954 else
1764 einfo "Using following ANT_TASKS: ${ANT_TASKS}" 1955 einfo "Using following ANT_TASKS: ${ANT_TASKS}"
1765 fi 1956 fi
1766 1957
1767 export ANT_TASKS 1958 export ANT_TASKS
1768 fi
1769 1959
1770 [[ -n ${JAVA_PKG_DEBUG} ]] && antflags="${antflags} --execdebug -debug" 1960 [[ -n ${JAVA_PKG_DEBUG} ]] && antflags="${antflags} --execdebug -debug"
1771 [[ -n ${PORTAGE_QUIET} ]] && antflags="${antflags} -q" 1961 [[ -n ${PORTAGE_QUIET} ]] && antflags="${antflags} -q"
1772 1962
1773 local gcp="${EANT_GENTOO_CLASSPATH}" 1963 local gcp="${EANT_GENTOO_CLASSPATH}"
1774 local getjarsarg="" 1964 local getjarsarg=""
1775 1965
1776 if [[ ${EBUILD_PHASE} = "test" ]]; then 1966 if [[ ${EBUILD_PHASE} = "test" ]]; then
1777 antflags="${antflags} -DJunit.present=true" 1967 antflags="${antflags} -DJunit.present=true"
1778 [[ ${gcp} && ${ANT_TASKS} = *ant-junit* ]] && gcp="${gcp} junit"
1779 getjarsarg="--with-dependencies" 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"
1780 fi 1974 fi
1781 1975
1782 local cp 1976 local cp
1783 1977
1784 for atom in ${gcp}; do 1978 for atom in ${gcp}; do
1785 cp="${cp}:$(java-pkg_getjars ${getjarsarg} ${atom})" 1979 cp+=":$(java-pkg_getjars ${getjarsarg} ${atom})"
1786 done 1980 done
1787 1981
1982 [[ ${EANT_NEEDS_TOOLS} ]] && cp+=":$(java-config --tools)"
1983 [[ ${EANT_GENTOO_CLASSPATH_EXTRA} ]] && cp+=":${EANT_GENTOO_CLASSPATH_EXTRA}"
1984
1788 if [[ ${cp} ]]; then 1985 if [[ ${cp#:} ]]; then
1789 # It seems ant does not like single quotes around ${cp} 1986 # It seems ant does not like single quotes around ${cp}
1790 antflags="${antflags} -Dgentoo.classpath=\"${cp#:}\"" 1987 antflags="${antflags} -Dgentoo.classpath=\"${cp#:}\""
1791 fi 1988 fi
1792 1989
1793 [[ -n ${JAVA_PKG_DEBUG} ]] && echo ant ${antflags} "${@}" 1990 [[ -n ${JAVA_PKG_DEBUG} ]] && echo ant ${antflags} "${@}"
1794 debug-print "Calling ant (GENTOO_VM: ${GENTOO_VM}): ${antflags} ${@}" 1991 debug-print "Calling ant (GENTOO_VM: ${GENTOO_VM}): ${antflags} ${@}"
1795 ant ${antflags} "${@}" || die "eant failed" 1992 ant ${antflags} "${@}" || die "eant failed"
1796} 1993}
1797 1994
1798# ------------------------------------------------------------------------------ 1995# @FUNCTION: ejavac
1799# @ebuild-function ejavac 1996# @USAGE: <javac_arguments>
1800# 1997# @DESCRIPTION:
1801# Javac wrapper function. Will use the appropriate compiler, based on 1998# Javac wrapper function. Will use the appropriate compiler, based on
1802# /etc/java-config/compilers.conf 1999# /etc/java-config/compilers.conf
1803#
1804# @param $@ - Arguments to be passed to the compiler
1805# ------------------------------------------------------------------------------
1806ejavac() { 2000ejavac() {
1807 debug-print-function ${FUNCNAME} $* 2001 debug-print-function ${FUNCNAME} $*
1808 2002
1809 java-pkg_init-compiler_ 2003 java-pkg_init-compiler_
1810 2004
1824 2018
1825 [[ -n ${JAVA_PKG_DEBUG} ]] && echo ${compiler_executable} ${javac_args} "${@}" 2019 [[ -n ${JAVA_PKG_DEBUG} ]] && echo ${compiler_executable} ${javac_args} "${@}"
1826 ${compiler_executable} ${javac_args} "${@}" || die "ejavac failed" 2020 ${compiler_executable} ${javac_args} "${@}" || die "ejavac failed"
1827} 2021}
1828 2022
1829# ------------------------------------------------------------------------------ 2023# @FUNCTION: ejavadoc
1830# @ebuild-function java-pkg_filter-compiler 2024# @USAGE: <javadoc_arguments>
1831# 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:
1832# 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.
1833# Basically, it just appends onto JAVA_PKG_FILTER_COMPILER 2044# Basically, it just appends onto JAVA_PKG_FILTER_COMPILER
1834#
1835# @param $@ - compilers to filter
1836# ------------------------------------------------------------------------------
1837java-pkg_filter-compiler() { 2045java-pkg_filter-compiler() {
1838 JAVA_PKG_FILTER_COMPILER="${JAVA_PKG_FILTER_COMPILER} $@" 2046 JAVA_PKG_FILTER_COMPILER="${JAVA_PKG_FILTER_COMPILER} $@"
1839} 2047}
1840 2048
1841# ------------------------------------------------------------------------------ 2049# @FUNCTION: java-pkg_force-compiler
1842# @ebuild-function java-pkg_force-compiler 2050# @USAGE: <compiler(s)_to_force>
1843# 2051# @DESCRIPTION:
1844# 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.
1845# 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
1846# OutOfMemoryErrors that may come up. 2054# OutOfMemoryErrors that may come up.
1847#
1848# @param $@ - compilers to force
1849# ------------------------------------------------------------------------------
1850java-pkg_force-compiler() { 2055java-pkg_force-compiler() {
1851 JAVA_PKG_FORCE_COMPILER="$@" 2056 JAVA_PKG_FORCE_COMPILER="$@"
1852} 2057}
1853 2058
1854# ------------------------------------------------------------------------------ 2059# @FUNCTION: use_doc
1855# @ebuild-function use_doc 2060# @DESCRIPTION:
1856# 2061#
1857# 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,
1858# 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.
1859# 2064#
1860# 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'
1861# 2069#
2070# Examples:
1862# Example: build javadocs by calling 'javadoc' target 2071# build javadocs by calling 'javadoc' target
1863# eant $(use_doc) 2072# eant $(use_doc)
2073#
1864# Example: build javadocs by calling 'apidoc' target 2074# build javadocs by calling 'apidoc' target
1865# eant $(use_doc apidoc) 2075# eant $(use_doc apidoc)
1866# 2076# @CODE
1867# @param $@ - Option value to return. Defaults to 'javadoc'
1868# @return string - Name of the target to create javadocs 2077# @RETURN string - Name of the target to create javadocs
1869# ------------------------------------------------------------------------------
1870use_doc() { 2078use_doc() {
1871 use doc && echo ${@:-javadoc} 2079 use doc && echo ${@:-javadoc}
1872} 2080}
1873 2081
1874 2082
1875# ------------------------------------------------------------------------------ 2083# @FUNCTION: java-pkg_init
1876# @section-end build 2084# @INTERNAL
1877# ------------------------------------------------------------------------------ 2085# @DESCRIPTION:
1878
1879# ------------------------------------------------------------------------------
1880# @section-begin internal
1881# @section-summary Internal functions
1882#
1883# Do __NOT__ use any of these from an ebuild! These are only to be used from
1884# within the java eclasses.
1885# ------------------------------------------------------------------------------
1886
1887# -----------------------------------------------------------------------------
1888# @function-internal java-pkg_init
1889#
1890# 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
1891# 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
1892# 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
1893# internally. And most importantly, it'll switch the VM if necessary. 2089# internally. And most importantly, it'll switch the VM if necessary.
1894# 2090#
1895# 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
1896# call it during each of the phases of the merge process. 2092# call it during each of the phases of the merge process.
1897#
1898# -----------------------------------------------------------------------------
1899java-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
1900 unset JAVAC 2102 unset JAVAC
1901 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 }
1902 2112
1903 # People do all kinds of weird things. 2113 # People do all kinds of weird things.
1904 # http://forums.gentoo.org/viewtopic-p-3943166.html 2114 # http://forums.gentoo.org/viewtopic-p-3943166.html
1905 local silence="${SILENCE_JAVA_OPTIONS_WARNING}" 2115 local silence="${SILENCE_JAVA_OPTIONS_WARNING}"
1906 local accept="${I_WANT_GLOBAL_JAVA_OPTIONS}" 2116 local accept="${I_WANT_GLOBAL_JAVA_OPTIONS}"
1912 ewarn "make.conf for example) to silence this warning or" 2122 ewarn "make.conf for example) to silence this warning or"
1913 ewarn "I_WANT_GLOBAL_JAVA_OPTIONS to not filter it." 2123 ewarn "I_WANT_GLOBAL_JAVA_OPTIONS to not filter it."
1914 fi 2124 fi
1915 2125
1916 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
1917 unset _JAVA_OPTIONS 2129 unset _JAVA_OPTIONS
1918 # phase hooks make this run many times without this 2130 # phase hooks make this run many times without this
1919 I_WANT_GLOBAL_JAVA_OPTIONS="true" 2131 I_WANT_GLOBAL_JAVA_OPTIONS="true"
1920 fi 2132 fi
1921 2133
1922 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
1923 java-pkg_switch-vm 2138 java-pkg_switch-vm
1924 PATH=${JAVA_HOME}/bin:${PATH} 2139 PATH=${JAVA_HOME}/bin:${PATH}
1925 2140
1926 # TODO we will probably want to set JAVAC and JAVACFLAGS 2141 # TODO we will probably want to set JAVAC and JAVACFLAGS
1927 2142
1928 # Do some QA checks 2143 # Do some QA checks
1929 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
1930 2148
1931 # When users have crazy classpaths some packages can fail to compile. 2149 # When users have crazy classpaths some packages can fail to compile.
1932 # and everything should work with empty CLASSPATH. 2150 # and everything should work with empty CLASSPATH.
1933 # This also helps prevent unexpected dependencies on random things 2151 # This also helps prevent unexpected dependencies on random things
1934 # from the CLASSPATH. 2152 # from the CLASSPATH.
1935 unset CLASSPATH 2153 export CLASSPATH=
1936 2154
1937 # Unset external ANT_ stuff 2155 # Unset external ANT_ stuff
1938 unset ANT_TASKS 2156 export ANT_TASKS=
1939 unset ANT_OPTS 2157 export ANT_OPTS=
2158 export ANT_RESPECT_JAVA_HOME=
1940} 2159}
1941 2160
1942# ------------------------------------------------------------------------------ 2161# @FUNCTION: java-pkg-init-compiler_
1943# @function-internal java-pkg-init-compiler_ 2162# @INTERNAL
1944# 2163# @DESCRIPTION:
1945# 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
1946# 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
1947# COMPILERS variable defined there. 2166# COMPILERS variable defined there.
1948# 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
1949# 2168#
1960# 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
1961# 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
1962# by the current VM. 2181# by the current VM.
1963# 2182#
1964# 2183#
1965# @return name of the compiler to use 2184# @RETURN name of the compiler to use
1966# ------------------------------------------------------------------------------
1967java-pkg_init-compiler_() { 2185java-pkg_init-compiler_() {
1968 debug-print-function ${FUNCNAME} $* 2186 debug-print-function ${FUNCNAME} $*
1969 2187
1970 if [[ -n ${GENTOO_COMPILER} ]]; then 2188 if [[ -n ${GENTOO_COMPILER} ]]; then
1971 debug-print "GENTOO_COMPILER already set" 2189 debug-print "GENTOO_COMPILER already set"
2012 if ! has ${desired_target} ${supported_target}; then 2230 if ! has ${desired_target} ${supported_target}; then
2013 ewarn "${compiler} does not support -target ${desired_target}, skipping" 2231 ewarn "${compiler} does not support -target ${desired_target}, skipping"
2014 continue 2232 continue
2015 fi 2233 fi
2016 2234
2017 # -source was introduced in 1.3, so only check 1.3 and on
2018 if version_is_at_least "${desired_soure}" "1.3"; then
2019 # Verify that the compiler supports source 2235 # Verify that the compiler supports source
2020 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})
2021 if ! has ${desired_source} ${supported_source}; then 2237 if ! has ${desired_source} ${supported_source}; then
2022 ewarn "${compiler} does not support -source ${desired_source}, skipping" 2238 ewarn "${compiler} does not support -source ${desired_source}, skipping"
2023 continue 2239 continue
2024 fi
2025 fi 2240 fi
2026 2241
2027 # 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
2028 export GENTOO_COMPILER="${compiler}" 2243 export GENTOO_COMPILER="${compiler}"
2029 break 2244 break
2035 done 2250 done
2036 2251
2037 # If it hasn't been defined already, default to javac 2252 # If it hasn't been defined already, default to javac
2038 if [[ -z ${GENTOO_COMPILER} ]]; then 2253 if [[ -z ${GENTOO_COMPILER} ]]; then
2039 if [[ -n ${compilers} ]]; then 2254 if [[ -n ${compilers} ]]; then
2040 einfo "No suitable compiler found: defaulting javac for compilation" 2255 einfo "No suitable compiler found: defaulting to JDK default for compilation"
2041 else 2256 else
2042 # probably don't need to notify users about the default. 2257 # probably don't need to notify users about the default.
2043 :;#einfo "Defaulting to javac for compilation" 2258 :;#einfo "Defaulting to javac for compilation"
2044 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
2045 export GENTOO_COMPILER=javac 2263 export GENTOO_COMPILER=javac
2264 fi
2046 else 2265 else
2047 einfo "Using ${GENTOO_COMPILER} for compilation" 2266 einfo "Using ${GENTOO_COMPILER} for compilation"
2048 fi 2267 fi
2049 2268
2050} 2269}
2051 2270
2052# ------------------------------------------------------------------------------ 2271# @FUNCTION: init_paths_
2053# @internal-function init_paths_ 2272# @INTERNAL
2054# 2273# @DESCRIPTION:
2055# 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
2056# to determine where things will eventually get installed. 2275# to determine where things will eventually get installed.
2057# ------------------------------------------------------------------------------
2058java-pkg_init_paths_() { 2276java-pkg_init_paths_() {
2059 debug-print-function ${FUNCNAME} $* 2277 debug-print-function ${FUNCNAME} $*
2060 2278
2061 local pkg_name 2279 local pkg_name
2062 if [[ "$SLOT" == "0" ]] ; then 2280 if [[ "${SLOT%/*}" == "0" ]] ; then
2063 JAVA_PKG_NAME="${PN}" 2281 JAVA_PKG_NAME="${PN}"
2064 else 2282 else
2065 JAVA_PKG_NAME="${PN}-${SLOT}" 2283 JAVA_PKG_NAME="${PN}-${SLOT%/*}"
2066 fi 2284 fi
2067 2285
2068 JAVA_PKG_SHAREPATH="${DESTTREE}/share/${JAVA_PKG_NAME}" 2286 JAVA_PKG_SHAREPATH="${DESTTREE}/share/${JAVA_PKG_NAME}"
2069 JAVA_PKG_SOURCESPATH="${JAVA_PKG_SHAREPATH}/sources/" 2287 JAVA_PKG_SOURCESPATH="${JAVA_PKG_SHAREPATH}/sources/"
2070 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}"
2071 2291
2072 [[ -z "${JAVA_PKG_JARDEST}" ]] && JAVA_PKG_JARDEST="${JAVA_PKG_SHAREPATH}/lib" 2292 [[ -z "${JAVA_PKG_JARDEST}" ]] && JAVA_PKG_JARDEST="${JAVA_PKG_SHAREPATH}/lib"
2073 [[ -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}"
2074 [[ -z "${JAVA_PKG_WARDEST}" ]] && JAVA_PKG_WARDEST="${JAVA_PKG_SHAREPATH}/webapps" 2294 [[ -z "${JAVA_PKG_WARDEST}" ]] && JAVA_PKG_WARDEST="${JAVA_PKG_SHAREPATH}/webapps"
2075
2076 2295
2077 # TODO maybe only print once? 2296 # TODO maybe only print once?
2078 debug-print "JAVA_PKG_SHAREPATH: ${JAVA_PKG_SHAREPATH}" 2297 debug-print "JAVA_PKG_SHAREPATH: ${JAVA_PKG_SHAREPATH}"
2079 debug-print "JAVA_PKG_ENV: ${JAVA_PKG_ENV}" 2298 debug-print "JAVA_PKG_ENV: ${JAVA_PKG_ENV}"
2080 debug-print "JAVA_PKG_JARDEST: ${JAVA_PKG_JARDEST}" 2299 debug-print "JAVA_PKG_JARDEST: ${JAVA_PKG_JARDEST}"
2081 debug-print "JAVA_PKG_LIBDEST: ${JAVA_PKG_LIBDEST}" 2300 debug-print "JAVA_PKG_LIBDEST: ${JAVA_PKG_LIBDEST}"
2082 debug-print "JAVA_PKG_WARDEST: ${JAVA_PKG_WARDEST}" 2301 debug-print "JAVA_PKG_WARDEST: ${JAVA_PKG_WARDEST}"
2083} 2302}
2084 2303
2085# ------------------------------------------------------------------------------ 2304# @FUNCTION: java-pkg_do_write_
2086# @internal-function java-pkg_do_write_ 2305# @INTERNAL
2087# 2306# @DESCRIPTION:
2088# Writes the package.env out to disk. 2307# Writes the package.env out to disk.
2089# 2308#
2090# ------------------------------------------------------------------------------
2091# TODO change to do-write, to match everything else 2309# TODO change to do-write, to match everything else
2092java-pkg_do_write_() { 2310java-pkg_do_write_() {
2311 debug-print-function ${FUNCNAME} $*
2093 java-pkg_init_paths_ 2312 java-pkg_init_paths_
2094 # Create directory for package.env 2313 # Create directory for package.env
2095 dodir "${JAVA_PKG_SHAREPATH}" 2314 dodir "${JAVA_PKG_SHAREPATH}"
2096 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
2097 # Create package.env 2318 # Create package.env
2098 ( 2319 (
2099 echo "DESCRIPTION=\"${DESCRIPTION}\"" 2320 echo "DESCRIPTION=\"${DESCRIPTION}\""
2100 echo "GENERATION=\"2\"" 2321 echo "GENERATION=\"2\""
2322 echo "SLOT=\"${SLOT}\""
2323 echo "CATEGORY=\"${CATEGORY}\""
2324 echo "PVR=\"${PVR}\""
2101 2325
2102 [[ -n "${JAVA_PKG_CLASSPATH}" ]] && echo "CLASSPATH=\"${JAVA_PKG_CLASSPATH}\"" 2326 [[ -n "${JAVA_PKG_CLASSPATH}" ]] && echo "CLASSPATH=\"${JAVA_PKG_CLASSPATH}\""
2103 [[ -n "${JAVA_PKG_LIBRARY}" ]] && echo "LIBRARY_PATH=\"${JAVA_PKG_LIBRARY}\"" 2327 [[ -n "${JAVA_PKG_LIBRARY}" ]] && echo "LIBRARY_PATH=\"${JAVA_PKG_LIBRARY}\""
2104 [[ -n "${JAVA_PROVIDE}" ]] && echo "PROVIDES=\"${JAVA_PROVIDE}\"" 2328 [[ -n "${JAVA_PROVIDE}" ]] && echo "PROVIDES=\"${JAVA_PROVIDE}\""
2105 [[ -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' ':')\""
2106 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' ':')\""
2107 ) > "${JAVA_PKG_ENV}" 2336 ) > "${JAVA_PKG_ENV}"
2108 2337
2109 # register target/source 2338 # register target/source
2110 local target="$(java-pkg_get-target)" 2339 local target="$(java-pkg_get-target)"
2111 local source="$(java-pkg_get-source)" 2340 local source="$(java-pkg_get-source)"
2121 2350
2122 2351
2123 echo "MERGE_VM=\"${GENTOO_VM}\"" >> "${JAVA_PKG_ENV}" 2352 echo "MERGE_VM=\"${GENTOO_VM}\"" >> "${JAVA_PKG_ENV}"
2124 [[ -n ${GENTOO_COMPILER} ]] && echo "MERGE_COMPILER=\"${GENTOO_COMPILER}\"" >> "${JAVA_PKG_ENV}" 2353 [[ -n ${GENTOO_COMPILER} ]] && echo "MERGE_COMPILER=\"${GENTOO_COMPILER}\"" >> "${JAVA_PKG_ENV}"
2125 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
2126 # Strip unnecessary leading and trailing colons 2363 # Strip unnecessary leading and trailing colons
2127 # TODO try to cleanup if possible 2364 # TODO try to cleanup if possible
2128 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."
2129 fi 2370 fi
2130} 2371}
2131 2372
2132# ------------------------------------------------------------------------------ 2373# @FUNCTION: java-pkg_record-jar_
2133# @internal-function java-pkg_record-jar_ 2374# @INTERNAL
2134# 2375# @DESCRIPTION:
2135# Record a dependency to the package.env 2376# Record an (optional) dependency to the package.env
2136# 2377# @CODE
2137# ------------------------------------------------------------------------------ 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
2138JAVA_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"
2139 2387
2140java-pkg_record-jar_() { 2388java-pkg_record-jar_() {
2141 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
2142 2396
2143 local pkg=${1} jar=${2} append 2397 local pkg=${1} jar=${2} append
2144 if [[ -z "${jar}" ]]; then 2398 if [[ -z "${jar}" ]]; then
2145 append="${pkg}" 2399 append="${pkg}"
2146 else 2400 else
2147 append="$(basename ${jar})@${pkg}" 2401 append="$(basename ${jar})@${pkg}"
2148 fi 2402 fi
2149 2403
2150 echo ${append} >> ${JAVA_PKG_DEPEND} 2404 echo "${append}" >> "${depend_file}"
2151} 2405}
2152 2406
2153# ------------------------------------------------------------------------------ 2407# @FUNCTION: java-pkg_append_
2154# @internal-function java-pkg_append_ 2408# @INTERNAL
2155# 2409# @DESCRIPTION:
2156# Appends a value to a variable 2410# Appends a value to a variable
2157# 2411#
2158# Example: java-pkg_append_ CLASSPATH foo.jar 2412# @CODE
2413# Parameters:
2159# @param $1 variable name to modify 2414# $1 variable name to modify
2160# @param $2 value to append 2415# $2 value to append
2161# ------------------------------------------------------------------------------ 2416#
2417# Examples:
2418# java-pkg_append_ CLASSPATH foo.jar
2419# @CODE
2162java-pkg_append_() { 2420java-pkg_append_() {
2163 debug-print-function ${FUNCNAME} $* 2421 debug-print-function ${FUNCNAME} $*
2164 2422
2165 local var="${1}" value="${2}" 2423 local var="${1}" value="${2}"
2166 if [[ -z "${!var}" ]] ; then 2424 if [[ -z "${!var}" ]] ; then
2177 [[ -z ${haveit} ]] && export ${var}="${!var}:${value}" 2435 [[ -z ${haveit} ]] && export ${var}="${!var}:${value}"
2178 IFS=${oldIFS} 2436 IFS=${oldIFS}
2179 fi 2437 fi
2180} 2438}
2181 2439
2182# ------------------------------------------------------------------------------ 2440# @FUNCTION: java-pkg_expand_dir_
2183# @internal-function java-pkg_expand_dir_ 2441# @INTERNAL
2184# 2442# @DESCRIPTION:
2185# 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:
2186# @param $1 - file/directory to find parent directory for 2446# $1 - file/directory to find parent directory for
2447# @CODE
2187# @return - path to $1's parent directory 2448# @RETURN: path to $1's parent directory
2188# ------------------------------------------------------------------------------
2189java-pkg_expand_dir_() { 2449java-pkg_expand_dir_() {
2190 pushd "$(dirname "${1}")" >/dev/null 2>&1 2450 pushd "$(dirname "${1}")" >/dev/null 2>&1
2191 pwd 2451 pwd
2192 popd >/dev/null 2>&1 2452 popd >/dev/null 2>&1
2193} 2453}
2194 2454
2195# ------------------------------------------------------------------------------ 2455# @FUNCTION: java-pkg_func-exists
2196# @internal-function java-pkg_func-exists 2456# @INTERNAL
2197# 2457# @DESCRIPTION:
2198# Does the indicated function exist? 2458# Does the indicated function exist?
2199# 2459# @RETURN: 0 - function is declared, 1 - function is undeclared
2200# @return 0 - function is declared
2201# @return 1 - function is undeclared
2202# ------------------------------------------------------------------------------
2203java-pkg_func-exists() { 2460java-pkg_func-exists() {
2204 if [[ -n "$(declare -f ${1})" ]]; then 2461 declare -F ${1} > /dev/null
2205 return 0
2206 else
2207 return 1
2208 fi
2209} 2462}
2210 2463
2211# ------------------------------------------------------------------------------ 2464# @FUNCTION: java-pkg_setup-vm
2212# @internal-function java-pkg_setup-vm 2465# @INTERNAL
2213# 2466# @DESCRIPTION:
2214# Sets up the environment for a specific VM 2467# Sets up the environment for a specific VM
2215#
2216# ------------------------------------------------------------------------------
2217java-pkg_setup-vm() { 2468java-pkg_setup-vm() {
2218 debug-print-function ${FUNCNAME} $* 2469 debug-print-function ${FUNCNAME} $*
2219 2470
2220 local vendor="$(java-pkg_get-vm-vendor)" 2471 local vendor="$(java-pkg_get-vm-vendor)"
2221 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
2222 addpredict "/dev/random" 2473 addpredict "/dev/random"
2223 elif [[ "${vendor}" == "ibm" ]]; then 2474 elif [[ "${vendor}" == "ibm" ]]; then
2224 addpredict "/proc/self/maps" 2475 addpredict "/proc/self/maps"
2225 addpredict "/proc/cpuinfo" 2476 addpredict "/proc/cpuinfo"
2226 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"
2227 elif [[ "${vendor}" == "jrockit" ]]; then 2484 elif [[ "${vendor}" == "jrockit" ]]; then
2228 addpredict "/proc/cpuinfo" 2485 addpredict "/proc/cpuinfo"
2229 fi 2486 fi
2230} 2487}
2231 2488
2232# ------------------------------------------------------------------------------ 2489# @FUNCTION: java-pkg_needs-vm
2233# @internal-function java-pkg_needs-vm 2490# @INTERNAL
2234# 2491# @DESCRIPTION:
2235# 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?
2236# 2494#
2237# @return 0 - Package depends on virtual/jdk 2495# @RETURN: 0 - Package depends on virtual/jdk; 1 - Package does not depend on virtual/jdk
2238# @return 1 - Package does not depend on virtual/jdk
2239# ------------------------------------------------------------------------------
2240java-pkg_needs-vm() { 2496java-pkg_needs-vm() {
2241 debug-print-function ${FUNCNAME} $* 2497 debug-print-function ${FUNCNAME} $*
2242 2498
2243 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
2244 return 0 2500 return 0
2245 fi 2501 fi
2246 2502
2503 [[ -n "${JAVA_PKG_WANT_BUILD_VM}" ]] && return 0
2504
2247 return 1 2505 return 1
2248} 2506}
2249 2507
2250# ------------------------------------------------------------------------------ 2508# @FUNCTION: java-pkg_get-current-vm
2251# @internal-function java-pkg_get-current-vm 2509# @INTERNAL
2252#
2253# @return - The current VM being used 2510# @RETURN - The current VM being used
2254# ------------------------------------------------------------------------------
2255java-pkg_get-current-vm() { 2511java-pkg_get-current-vm() {
2256 java-config -f 2512 java-config -f
2257} 2513}
2258 2514
2259# ------------------------------------------------------------------------------ 2515# @FUNCTION: java-pkg_get-vm-vendor
2260# @internal-function java-pkg_get-vm-vendor 2516# @INTERNAL
2261#
2262# @return - The vendor of the current VM 2517# @RETURN - The vendor of the current VM
2263# ------------------------------------------------------------------------------
2264java-pkg_get-vm-vendor() { 2518java-pkg_get-vm-vendor() {
2265 debug-print-function ${FUNCNAME} $* 2519 debug-print-function ${FUNCNAME} $*
2266 2520
2267 local vm="$(java-pkg_get-current-vm)" 2521 local vm="$(java-pkg_get-current-vm)"
2268 vm="${vm/-*/}" 2522 vm="${vm/-*/}"
2269 echo "${vm}" 2523 echo "${vm}"
2270} 2524}
2271 2525
2272# ------------------------------------------------------------------------------ 2526# @FUNCTION: java-pkg_get-vm-version
2273# @internal-function java-pkg_get-vm-version 2527# @INTERNAL
2274#
2275# @return - The version of the current VM 2528# @RETURN - The version of the current VM
2276# ------------------------------------------------------------------------------
2277java-pkg_get-vm-version() { 2529java-pkg_get-vm-version() {
2278 debug-print-function ${FUNCNAME} $* 2530 debug-print-function ${FUNCNAME} $*
2279 2531
2280 java-config -g PROVIDES_VERSION 2532 java-config -g PROVIDES_VERSION
2281} 2533}
2282 2534
2283# ------------------------------------------------------------------------------ 2535# @FUNCTION: java-pkg_build-vm-from-handle
2284# @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.
2285# 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:
2286# 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
2287# verify that the current VM is sufficient. 2570# verify that the current VM is sufficient.
2288# Setup the environment for the VM being used. 2571# Setup the environment for the VM being used.
2289# ------------------------------------------------------------------------------
2290java-pkg_switch-vm() { 2572java-pkg_switch-vm() {
2291 debug-print-function ${FUNCNAME} $* 2573 debug-print-function ${FUNCNAME} $*
2292 2574
2293 if java-pkg_needs-vm; then 2575 if java-pkg_needs-vm; then
2294 # Use the VM specified by JAVA_PKG_FORCE_VM 2576 # Use the VM specified by JAVA_PKG_FORCE_VM
2296 # 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...
2297 debug-print "JAVA_PKG_FORCE_VM used: ${JAVA_PKG_FORCE_VM}" 2579 debug-print "JAVA_PKG_FORCE_VM used: ${JAVA_PKG_FORCE_VM}"
2298 export GENTOO_VM="${JAVA_PKG_FORCE_VM}" 2580 export GENTOO_VM="${JAVA_PKG_FORCE_VM}"
2299 # if we're allowed to switch the vm... 2581 # if we're allowed to switch the vm...
2300 elif [[ "${JAVA_PKG_ALLOW_VM_CHANGE}" == "yes" ]]; then 2582 elif [[ "${JAVA_PKG_ALLOW_VM_CHANGE}" == "yes" ]]; then
2301 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
2302 if [[ -n ${JAVA_PKG_VNEED} ]]; then 2584 if [[ -n "${JAVA_PKG_WANT_BUILD_VM}" ]]; then
2303 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
2304 else 2602 else
2603 debug-print "depend-java-query: NV_DEPEND: ${JAVA_PKG_NV_DEPEND:-${DEPEND}}"
2305 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
2306 fi 2610 fi
2307 if [[ -z "${GENTOO_VM}" || "${GENTOO_VM}" == "None" ]]; then
2308 eerror "Unable to determine VM for building from dependencies:"
2309 echo "NV_DEPEND: ${JAVA_PKG_NV_DEPEND:-${DEPEND}}"
2310 echo "VNEED: ${JAVA_PKG_VNEED}"
2311 die "Failed to determine VM for building."
2312 else
2313 export GENTOO_VM 2611 export GENTOO_VM
2314 fi
2315 # otherwise just make sure the current VM is sufficient 2612 # otherwise just make sure the current VM is sufficient
2316 else 2613 else
2317 java-pkg_ensure-vm-version-sufficient 2614 java-pkg_ensure-vm-version-sufficient
2318 fi 2615 fi
2319 debug-print "Using: $(java-config -f)" 2616 debug-print "Using: $(java-config -f)"
2335 2632
2336 #TODO If you know a better solution let us know. 2633 #TODO If you know a better solution let us know.
2337 java-pkg_append_ LD_LIBRARY_PATH "$(java-config -g LDPATH)" 2634 java-pkg_append_ LD_LIBRARY_PATH "$(java-config -g LDPATH)"
2338 2635
2339 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
2340 if [[ -n "${JAVA_PKG_DEBUG}" ]] || [[ ! -f "${tann}" ]] ; then 2639 if [[ -n "${JAVA_PKG_DEBUG}" ]] || [[ ! -f "${tann}" ]] ; then
2341 # Add a check for setup/preinst phase... to avoid duplicate outputs
2342 # for when FEATURES=buildpkg
2343 if [[ ${EBUILD_PHASE} != "setup" && ${EBUILD_PHASE} != "preinst" && ${EBUILD_PHASE} != "postinst" ]];
2344 then
2345 einfo "Using: $(java-config -f)" 2640 einfo "Using: $(java-config -f)"
2346 [[ ! -f "${tann}" ]] && touch "${tann}" 2641 [[ ! -f "${tann}" ]] && touch "${tann}"
2347 fi
2348 fi 2642 fi
2349 2643
2350 else 2644 else
2351 [[ -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!!!"
2352 fi 2646 fi
2353} 2647}
2354 2648
2355# ------------------------------------------------------------------------------ 2649# @FUNCTION: java-pkg_die
2356# @internal-function java-pkg_die 2650# @INTERNAL
2357# 2651# @DESCRIPTION:
2358# 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
2359# useful for debugging bugs on bugzilla. 2653# useful for debugging bugs on bugzilla.
2360# ------------------------------------------------------------------------------
2361#register_die_hook java-pkg_die 2654#register_die_hook java-pkg_die
2362if ! hasq java-pkg_die ${EBUILD_DEATH_HOOKS}; then 2655if ! has java-pkg_die ${EBUILD_DEATH_HOOKS}; then
2363 EBUILD_DEATH_HOOKS="${EBUILD_DEATH_HOOKS} java-pkg_die" 2656 EBUILD_DEATH_HOOKS="${EBUILD_DEATH_HOOKS} java-pkg_die"
2364fi 2657fi
2365 2658
2366java-pkg_die() { 2659java-pkg_die() {
2367 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
2368 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
2369 echo "JAVACFLAGS=\"${JAVACFLAGS}\" COMPILER=\"${GENTOO_COMPILER}\"" >&2 2662 echo "JAVACFLAGS=\"${JAVACFLAGS}\" COMPILER=\"${GENTOO_COMPILER}\"" >&2
2370 echo "and of course, the output of emerge --info" >&2 2663 echo "and of course, the output of emerge --info =${P}" >&2
2371} 2664}
2372 2665
2373 2666
2374# TODO document 2667# TODO document
2375# List jars in the source directory, ${S} 2668# List jars in the source directory, ${S}
2382 einfo "Classes" 2675 einfo "Classes"
2383 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},"
2384 fi 2677 fi
2385} 2678}
2386 2679
2387# ------------------------------------------------------------------------------ 2680# @FUNCTION: java-pkg_verify-classes
2388# @internal-function java-pkg_verify-classes 2681# @INTERNAL
2389# 2682# @DESCRIPTION:
2390# 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
2391# not. 2684# not.
2685# @CODE
2392# @param $1 (optional) - the file to check, otherwise checks whole ${D} 2686# $1 (optional) - the file to check, otherwise checks whole ${D}
2393# ------------------------------------------------------------------------------ 2687# @CODE
2394java-pkg_verify-classes() { 2688java-pkg_verify-classes() {
2395 #$(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
2396 local target=$(java-pkg_get-target) 2704 local target=$(java-pkg_get-target)
2397 local result 2705 local result
2398 local log="${T}/class-version-verify.log" 2706 local log="${T}/class-version-verify.log"
2399 if [[ -n "${1}" ]]; then 2707 if [[ -n "${1}" ]]; then
2400 class-version-verify.py -v -t ${target} "${1}" > "${log}" 2708 ${version_verify} -v -t ${target} "${1}" > "${log}"
2401 result=$? 2709 result=$?
2402 else 2710 else
2403 ebegin "Verifying java class versions (target: ${target})" 2711 ebegin "Verifying java class versions (target: ${target})"
2404 class-version-verify.py -v -t ${target} -r "${D}" > "${log}" 2712 ${version_verify} -v -t ${target} -r "${D}" > "${log}"
2405 result=$? 2713 result=$?
2406 eend ${result} 2714 eend ${result}
2407 fi 2715 fi
2408 [[ -n ${JAVA_PKG_DEBUG} ]] && cat "${log}" 2716 [[ -n ${JAVA_PKG_DEBUG} ]] && cat "${log}"
2409 if [[ ${result} != 0 ]]; then 2717 if [[ ${result} != 0 ]]; then
2412 eerror "See ${log} for more details." 2720 eerror "See ${log} for more details."
2413 die "Incorrect bytecode found" 2721 die "Incorrect bytecode found"
2414 fi 2722 fi
2415} 2723}
2416 2724
2417# ---------------------------------------------------------------------------- 2725# @FUNCTION: java-pkg_ensure-dep
2418# @internal-function java-pkg_ensure-dep 2726# @INTERNAL
2727# @DESCRIPTION:
2419# 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
2420# within DEPEND or RDEPEND. 2729# within DEPEND or RDEPEND with the correct SLOT. See this mail for details:
2730# https://archives.gentoo.org/gentoo-dev/message/dcb644f89520f4bbb61cc7bbe45fdf6e
2731# @CODE
2732# Parameters:
2421# @param $1 - empty - check both vars; "runtime" or "build" - check only 2733# $1 - empty - check both vars; "runtime" or "build" - check only
2422# RDEPEND, resp. DEPEND 2734# RDEPEND, resp. DEPEND
2423# @param $2 - Package name and slot. 2735# $2 - Package name and slot.
2736# @CODE
2424java-pkg_ensure-dep() { 2737java-pkg_ensure-dep() {
2425 debug-print-function ${FUNCNAME} $* 2738 debug-print-function ${FUNCNAME} $*
2426 2739
2427 local limit_to="${1}" 2740 local limit_to="${1}"
2428 local target_pkg="${2}" 2741 local target_pkg="${2}"
2429 local dev_error="" 2742 local dev_error=""
2430 2743
2431 local stripped_pkg=$(echo "${target_pkg}" | sed \ 2744 # Transform into a regular expression to look for a matching package
2432 '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
2433 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
2434 if [[ ${limit_to} != runtime && ! ( "${DEPEND}" =~ "$stripped_pkg" ) ]]; then 2772 if [[ ${limit_to} != runtime && ! ( "${DEPEND}" =~ $stripped_pkg ) ]]; then
2435 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 "
2436 dev_error="${dev_error} declared in DEPEND." 2774 dev_error+="declared with a SLOT in DEPEND."
2437 if is-java-strict; then 2775# if is-java-strict; then
2438 die "${dev_error}" 2776# die "${dev_error}"
2439 elif [[ ${BASH_SUBSHELL} = 0 ]]; then 2777# else
2440 eerror "${dev_error}" 2778 eqawarn "java-pkg_ensure-dep: ${dev_error}"
2441 elog "Because you have this package installed the package will" 2779# eerror "Because you have ${target_pkg} installed,"
2442 elog "build without problems, but please report this to" 2780# eerror "the package will build without problems, but please"
2443 elog "http://bugs.gentoo.org" 2781# eerror "report this to http://bugs.gentoo.org."
2444 fi 2782# fi
2445 fi
2446
2447 if [[ ${limit_to} != build && ! ( ${RDEPEND} =~ "${stripped_pkg}" ) ]]; then 2783 elif [[ ${limit_to} != build && ! ( "${RDEPEND}${PDEPEND}" =~ ${stripped_pkg} ) ]]; then
2448 dev_error="The ebuild is attempting to use ${target_pkg}," 2784 dev_error="The ebuild is attempting to use ${target_pkg}, which is not "
2449 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."
2450 if is-java-strict; then 2786# if is-java-strict; then
2451 die "${dev_error}" 2787# die "${dev_error}"
2452 elif [[ ${BASH_SUBSHELL} = 0 ]]; then 2788# else
2453 eerror "${dev_error}" 2789 eqawarn "java-pkg_ensure-dep: ${dev_error}"
2454 elog "The package will build without problems, but may fail to run" 2790# eerror "The package will build without problems, but may fail to run"
2455 elog "if you don't have ${target_pkg} installed, so please report" 2791# eerror "if you don't have ${target_pkg} installed,"
2456 elog "this to http://bugs.gentoo.org" 2792# eerror "so please report this to http://bugs.gentoo.org."
2457 fi 2793# fi
2458 fi 2794 fi
2459} 2795}
2460
2461# ------------------------------------------------------------------------------
2462# @section-end internal
2463# ------------------------------------------------------------------------------
2464 2796
2465java-pkg_check-phase() { 2797java-pkg_check-phase() {
2466 local phase=${1} 2798 local phase=${1}
2467 local funcname=${2} 2799 local funcname=${FUNCNAME[1]}
2468 if is-java-strict && [[ ${EBUILD_PHASE} != ${phase} ]]; then 2800 if [[ ${EBUILD_PHASE} != ${phase} ]]; then
2469 java-pkg_announce-qa-violation \
2470 "${funcname} used outside of src_${phase}" 2801 local msg="${funcname} used outside of src_${phase}"
2802 java-pkg_announce-qa-violation "${msg}"
2471 fi 2803 fi
2472} 2804}
2473 2805
2474java-pkg_check-versioned-jar() { 2806java-pkg_check-versioned-jar() {
2475 local jar=${1} 2807 local jar=${1}
2478 java-pkg_announce-qa-violation "installing versioned jar '${jar}'" 2810 java-pkg_announce-qa-violation "installing versioned jar '${jar}'"
2479 fi 2811 fi
2480} 2812}
2481 2813
2482java-pkg_check-jikes() { 2814java-pkg_check-jikes() {
2483 if hasq jikes ${IUSE}; then 2815 if has jikes ${IUSE}; then
2484 java-pkg_announce-qa-violation "deprecated USE flag 'jikes' in IUSE" 2816 java-pkg_announce-qa-violation "deprecated USE flag 'jikes' in IUSE"
2485 fi 2817 fi
2486} 2818}
2487 2819
2488java-pkg_announce-qa-violation() { 2820java-pkg_announce-qa-violation() {
2489 if is-java-strict; then 2821 local nodie
2822 if [[ ${1} == "--nodie" ]]; then
2823 nodie="true"
2824 shift
2825 fi
2490 echo "Java QA Notice: $@" >&2 2826 echo "Java QA Notice: $@" >&2
2491 increment-qa-violations 2827 increment-qa-violations
2492 fi 2828 [[ -z "${nodie}" ]] && is-java-strict && die "${@}"
2493} 2829}
2494 2830
2495increment-qa-violations() { 2831increment-qa-violations() {
2496 let "JAVA_PKG_QA_VIOLATIONS+=1" 2832 let "JAVA_PKG_QA_VIOLATIONS+=1"
2497 export JAVA_PKG_QA_VIOLATIONS 2833 export JAVA_PKG_QA_VIOLATIONS
2499 2835
2500is-java-strict() { 2836is-java-strict() {
2501 [[ -n ${JAVA_PKG_STRICT} ]] 2837 [[ -n ${JAVA_PKG_STRICT} ]]
2502 return $? 2838 return $?
2503} 2839}
2504
2505# ------------------------------------------------------------------------------
2506# @eclass-end
2507# ------------------------------------------------------------------------------

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

  ViewVC Help
Powered by ViewVC 1.1.20