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

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

  ViewVC Help
Powered by ViewVC 1.1.20