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

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

  ViewVC Help
Powered by ViewVC 1.1.20