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

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

  ViewVC Help
Powered by ViewVC 1.1.20