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

Legend:
Removed from v.1.80  
changed lines
  Added in v.1.163

  ViewVC Help
Powered by ViewVC 1.1.20